Skip to content
This repository
Fetching contributors…

Cannot retrieve contributors at this time

file 465 lines (352 sloc) 13.871 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
/*
Copyright (c) 2010-2012, Intel Corporation
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

* Neither the name of Intel Corporation nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.


THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

/** @file stmt.h
@brief File with declarations for classes related to statements in the language
*/

#ifndef ISPC_STMT_H
#define ISPC_STMT_H 1

#include "ispc.h"
#include "ast.h"

/** @brief Interface class for statements in the ispc language.

This abstract base-class encapsulates methods that AST nodes for
statements in the language must implement.
*/
class Stmt : public ASTNode {
public:
    Stmt(SourcePos p) : ASTNode(p) { }

    /** Emit LLVM IR for the statement, using the FunctionEmitContext to create the
necessary instructions.
*/
    virtual void EmitCode(FunctionEmitContext *ctx) const = 0;

    /** Print a representation of the statement (and any children AST
nodes) to standard output. This method is used for debuggins. */
    virtual void Print(int indent) const = 0;

    // Redeclare these methods with Stmt * return values, rather than
    // ASTNode *s, as in the original ASTNode declarations of them. We'll
    // also provide a default implementation of Optimize(), since most
    // Stmts don't have anything to do here.
    virtual Stmt *Optimize();
    virtual Stmt *TypeCheck() = 0;
};


/** @brief Statement representing a single expression */
class ExprStmt : public Stmt {
public:
    ExprStmt(Expr *expr, SourcePos pos);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *TypeCheck();
    int EstimateCost() const;

    Expr *expr;
};


struct VariableDeclaration {
    VariableDeclaration(Symbol *s = NULL, Expr *i = NULL) {
        sym = s; init = i;
    }
    Symbol *sym;
    Expr *init;
};

/** @brief Statement representing a single declaration (which in turn may declare
a number of variables. */
class DeclStmt : public Stmt {
public:
    DeclStmt(const std::vector<VariableDeclaration> &v, SourcePos pos);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *Optimize();
    Stmt *TypeCheck();
    int EstimateCost() const;

    std::vector<VariableDeclaration> vars;
};


/** @brief Statement representing a single if statement, possibly with an
else clause. */
class IfStmt : public Stmt {
public:
    IfStmt(Expr *testExpr, Stmt *trueStmts, Stmt *falseStmts,
           bool doAllCheck, SourcePos pos);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *TypeCheck();
    int EstimateCost() const;

    // @todo these are only public for lHasVaryingBreakOrContinue(); would
    // be nice to clean that up...
    /** Expression giving the 'if' test. */
    Expr *test;
    /** Statements to run if the 'if' test returns a true value */
    Stmt *trueStmts;
    /** Statements to run if the 'if' test returns a false value */
    Stmt *falseStmts;

private:
    /** This value records if this was a 'coherent' if statement in the
source and thus, if the emitted code should check to see if all
active program instances want to follow just one of the 'true' or
'false' blocks. */
    const bool doAllCheck;

    void emitMaskedTrueAndFalse(FunctionEmitContext *ctx, llvm::Value *oldMask,
                                llvm::Value *test) const;
    void emitVaryingIf(FunctionEmitContext *ctx, llvm::Value *test) const;
    void emitMaskAllOn(FunctionEmitContext *ctx,
                       llvm::Value *test, llvm::BasicBlock *bDone) const;
    void emitMaskMixed(FunctionEmitContext *ctx, llvm::Value *oldMask,
                       llvm::Value *test, llvm::BasicBlock *bDone) const;
};


/** @brief Statement implementation representing a 'do' statement in the
program.
*/
class DoStmt : public Stmt {
public:
    DoStmt(Expr *testExpr, Stmt *bodyStmts, bool doCoherentCheck,
           SourcePos pos);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *TypeCheck();
    int EstimateCost() const;

    Expr *testExpr;
    Stmt *bodyStmts;
    const bool doCoherentCheck;
};


/** @brief Statement implementation for 'for' loops (as well as for 'while'
loops).
*/
class ForStmt : public Stmt {
public:
    ForStmt(Stmt *initializer, Expr *testExpr, Stmt *stepStatements,
            Stmt *bodyStatements, bool doCoherentCheck, SourcePos pos);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *TypeCheck();
    int EstimateCost() const;

    /** 'for' statment initializer; may be NULL, indicating no intitializer */
    Stmt *init;
    /** expression that returns a value indicating whether the loop should
continue for the next iteration */
    Expr *test;
    /** Statements to run at the end of the loop for the loop step, before
the test expression is evaluated. */
    Stmt *step;
    /** Loop body statements */
    Stmt *stmts;
    const bool doCoherentCheck;
};


/** @brief Statement implementation for a break or 'coherent' break
statement in the program. */
class BreakStmt : public Stmt {
public:
    BreakStmt(bool doCoherenceCheck, SourcePos pos);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *TypeCheck();
    int EstimateCost() const;

private:
    /** This indicates whether the generated code will check to see if no
more program instances are currently running after the break, in
which case the code can have a jump to the end of the current
loop. */
    const bool doCoherenceCheck;
};


/** @brief Statement implementation for a continue or 'coherent' continue
statement in the program. */
class ContinueStmt : public Stmt {
public:
    ContinueStmt(bool doCoherenceCheck, SourcePos pos);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *TypeCheck();
    int EstimateCost() const;

private:
    /** This indicates whether the generated code will check to see if no
more program instances are currently running after the continue, in
which case the code can have a jump to the end of the current
loop. */
    const bool doCoherenceCheck;
};


/** @brief Statement implementation for parallel 'foreach' loops.
*/
class ForeachStmt : public Stmt {
public:
    ForeachStmt(const std::vector<Symbol *> &loopVars,
                const std::vector<Expr *> &startExprs,
                const std::vector<Expr *> &endExprs,
                Stmt *bodyStatements, bool tiled, SourcePos pos);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *TypeCheck();
    int EstimateCost() const;

    std::vector<Symbol *> dimVariables;
    std::vector<Expr *> startExprs;
    std::vector<Expr *> endExprs;
    bool isTiled;
    Stmt *stmts;
};



/** @brief Statement implementation for a 'return' or 'coherent' return
statement in the program. */
class ReturnStmt : public Stmt {
public:
    ReturnStmt(Expr *e, bool cc, SourcePos p);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *TypeCheck();
    int EstimateCost() const;

    Expr *expr;
    /** This indicates whether the generated code will check to see if no
more program instances are currently running after the return, in
which case the code can possibly jump to the end of the current
function. */
    const bool doCoherenceCheck;
};


/** Statement corresponding to a "case" label in the program. In addition
to the value associated with the "case", this statement also stores the
statements following it. */
class CaseStmt : public Stmt {
public:
    CaseStmt(int value, Stmt *stmt, SourcePos pos);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *TypeCheck();
    int EstimateCost() const;

    /** Integer value after the "case" statement */
    const int value;
    Stmt *stmts;
};


/** Statement for a "default" label (as would be found inside a "switch"
statement). */
class DefaultStmt : public Stmt {
public:
    DefaultStmt(Stmt *stmt, SourcePos pos);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *TypeCheck();
    int EstimateCost() const;

    Stmt *stmts;
};


/** A "switch" statement in the program. */
class SwitchStmt : public Stmt {
public:
    SwitchStmt(Expr *expr, Stmt *stmts, SourcePos pos);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *TypeCheck();
    int EstimateCost() const;

    /** Expression that is used to determine which label to jump to. */
    Expr *expr;
    /** Statement block after the "switch" expression. */
    Stmt *stmts;
};


/** A "goto" in an ispc program. */
class GotoStmt : public Stmt {
public:
    GotoStmt(const char *label, SourcePos gotoPos, SourcePos idPos);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *Optimize();
    Stmt *TypeCheck();
    int EstimateCost() const;

    /** Name of the label to jump to when the goto is executed. */
    std::string label;
    SourcePos identifierPos;
};


/** Statement corresponding to a label (as would be used as a goto target)
in the program. */
class LabeledStmt : public Stmt {
public:
    LabeledStmt(const char *label, Stmt *stmt, SourcePos p);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *Optimize();
    Stmt *TypeCheck();
    int EstimateCost() const;

    /** Name of the label. */
    std::string name;
    /** Statements following the label. */
    Stmt *stmt;
};


/** @brief Representation of a list of statements in the program.
*/
class StmtList : public Stmt {
public:
    StmtList(SourcePos p) : Stmt(p) { }

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *TypeCheck();
    int EstimateCost() const;

    void Add(Stmt *s) { if (s) stmts.push_back(s); }

    std::vector<Stmt *> stmts;
};


/** @brief Representation of a print() statement in the program.

It's currently necessary to have a special statement type for print()
since strings aren't supported as first-class types in the language,
but we need to be able to pass a formatting string as the first
argument to print(). We also need this to be a variable argument
function, which also isn't supported. Representing print() as a
statement lets us work around both of those ugly little issues...
*/
class PrintStmt : public Stmt {
public:
    PrintStmt(const std::string &f, Expr *v, SourcePos p);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *TypeCheck();
    int EstimateCost() const;

    /** Format string for the print() statement. */
    const std::string format;
    /** This holds the arguments passed to the print() statement. If more
than one was provided, this will be an ExprList. */
    Expr *values;
};


/** @brief Representation of an assert statement in the program.

Like print() above, since we don't have strings as first-class types in
the language, we need to do some gymnastics to support it. Like
assert() in C, assert() checks the given condition and prints an error
and calls abort if the condition fails. For varying conditions, the
assert triggers if it's true for any of the program instances.
*/
class AssertStmt : public Stmt {
public:
    AssertStmt(const std::string &msg, Expr *e, SourcePos p);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *TypeCheck();
    int EstimateCost() const;

    /** Message to print if the assertion fails. */
    const std::string message;
    /** The expression to be evaluated (that is asserted to be true). */
    Expr *expr;
};


/** Representation of a delete statement in the program.
*/
class DeleteStmt : public Stmt {
public:
    DeleteStmt(Expr *e, SourcePos p);

    void EmitCode(FunctionEmitContext *ctx) const;
    void Print(int indent) const;

    Stmt *TypeCheck();
    int EstimateCost() const;

    /** Expression that gives the pointer value to be deleted. */
    Expr *expr;
};

extern Stmt *CreateForeachActiveStmt(Symbol *iterSym, Stmt *stmts,
                                     SourcePos pos);

#endif // ISPC_STMT_H
Something went wrong with that request. Please try again.