Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 1 | // |
| 2 | // Copyright (c) 2002-2014 The ANGLE Project Authors. All rights reserved. |
| 3 | // Use of this source code is governed by a BSD-style license that can be |
| 4 | // found in the LICENSE file. |
| 5 | // |
| 6 | |
| 7 | // |
| 8 | // Definition of the in-memory high-level intermediate representation |
| 9 | // of shaders. This is a tree that parser creates. |
| 10 | // |
| 11 | // Nodes in the tree are defined as a hierarchy of classes derived from |
| 12 | // TIntermNode. Each is a node in a tree. There is no preset branching factor; |
| 13 | // each node can have it's own type of list of children. |
| 14 | // |
| 15 | |
Geoff Lang | 0a73dd8 | 2014-11-19 16:18:08 -0500 | [diff] [blame] | 16 | #ifndef COMPILER_TRANSLATOR_INTERMNODE_H_ |
| 17 | #define COMPILER_TRANSLATOR_INTERMNODE_H_ |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 18 | |
| 19 | #include "GLSLANG/ShaderLang.h" |
| 20 | |
| 21 | #include <algorithm> |
| 22 | #include <queue> |
| 23 | |
Jamie Madill | 80d934b | 2015-02-19 10:16:12 -0500 | [diff] [blame] | 24 | #include "common/angleutils.h" |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 25 | #include "compiler/translator/Common.h" |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 26 | #include "compiler/translator/ConstantUnion.h" |
Olli Etuaho | 1033e1d | 2015-02-12 12:03:13 +0200 | [diff] [blame] | 27 | #include "compiler/translator/Operator.h" |
Jamie Madill | 6ba6ead | 2015-05-04 14:21:21 -0400 | [diff] [blame] | 28 | #include "compiler/translator/Types.h" |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 29 | |
| 30 | class TIntermTraverser; |
| 31 | class TIntermAggregate; |
| 32 | class TIntermBinary; |
| 33 | class TIntermUnary; |
| 34 | class TIntermConstantUnion; |
| 35 | class TIntermSelection; |
Olli Etuaho | a3a3666 | 2015-02-17 13:46:51 +0200 | [diff] [blame] | 36 | class TIntermSwitch; |
| 37 | class TIntermCase; |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 38 | class TIntermTyped; |
| 39 | class TIntermSymbol; |
| 40 | class TIntermLoop; |
| 41 | class TInfoSink; |
Olli Etuaho | a3a5cc6 | 2015-02-13 13:12:22 +0200 | [diff] [blame] | 42 | class TInfoSinkBase; |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 43 | class TIntermRaw; |
| 44 | |
| 45 | // |
| 46 | // Base class for the tree nodes |
| 47 | // |
| 48 | class TIntermNode |
| 49 | { |
| 50 | public: |
| 51 | POOL_ALLOCATOR_NEW_DELETE(); |
| 52 | TIntermNode() |
| 53 | { |
| 54 | // TODO: Move this to TSourceLoc constructor |
| 55 | // after getting rid of TPublicType. |
| 56 | mLine.first_file = mLine.last_file = 0; |
| 57 | mLine.first_line = mLine.last_line = 0; |
| 58 | } |
| 59 | virtual ~TIntermNode() { } |
| 60 | |
| 61 | const TSourceLoc &getLine() const { return mLine; } |
| 62 | void setLine(const TSourceLoc &l) { mLine = l; } |
| 63 | |
| 64 | virtual void traverse(TIntermTraverser *) = 0; |
| 65 | virtual TIntermTyped *getAsTyped() { return 0; } |
| 66 | virtual TIntermConstantUnion *getAsConstantUnion() { return 0; } |
| 67 | virtual TIntermAggregate *getAsAggregate() { return 0; } |
| 68 | virtual TIntermBinary *getAsBinaryNode() { return 0; } |
| 69 | virtual TIntermUnary *getAsUnaryNode() { return 0; } |
| 70 | virtual TIntermSelection *getAsSelectionNode() { return 0; } |
Olli Etuaho | a3a3666 | 2015-02-17 13:46:51 +0200 | [diff] [blame] | 71 | virtual TIntermSwitch *getAsSwitchNode() { return 0; } |
| 72 | virtual TIntermCase *getAsCaseNode() { return 0; } |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 73 | virtual TIntermSymbol *getAsSymbolNode() { return 0; } |
| 74 | virtual TIntermLoop *getAsLoopNode() { return 0; } |
| 75 | virtual TIntermRaw *getAsRawNode() { return 0; } |
| 76 | |
| 77 | // Replace a child node. Return true if |original| is a child |
| 78 | // node and it is replaced; otherwise, return false. |
| 79 | virtual bool replaceChildNode( |
| 80 | TIntermNode *original, TIntermNode *replacement) = 0; |
| 81 | |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 82 | protected: |
| 83 | TSourceLoc mLine; |
| 84 | }; |
| 85 | |
| 86 | // |
| 87 | // This is just to help yacc. |
| 88 | // |
| 89 | struct TIntermNodePair |
| 90 | { |
| 91 | TIntermNode *node1; |
| 92 | TIntermNode *node2; |
| 93 | }; |
| 94 | |
| 95 | // |
| 96 | // Intermediate class for nodes that have a type. |
| 97 | // |
| 98 | class TIntermTyped : public TIntermNode |
| 99 | { |
| 100 | public: |
| 101 | TIntermTyped(const TType &t) : mType(t) { } |
| 102 | virtual TIntermTyped *getAsTyped() { return this; } |
| 103 | |
| 104 | virtual bool hasSideEffects() const = 0; |
| 105 | |
| 106 | void setType(const TType &t) { mType = t; } |
Olli Etuaho | d2a67b9 | 2014-10-21 16:42:57 +0300 | [diff] [blame] | 107 | void setTypePreservePrecision(const TType &t); |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 108 | const TType &getType() const { return mType; } |
| 109 | TType *getTypePointer() { return &mType; } |
| 110 | |
| 111 | TBasicType getBasicType() const { return mType.getBasicType(); } |
| 112 | TQualifier getQualifier() const { return mType.getQualifier(); } |
| 113 | TPrecision getPrecision() const { return mType.getPrecision(); } |
| 114 | int getCols() const { return mType.getCols(); } |
| 115 | int getRows() const { return mType.getRows(); } |
| 116 | int getNominalSize() const { return mType.getNominalSize(); } |
| 117 | int getSecondarySize() const { return mType.getSecondarySize(); } |
| 118 | |
| 119 | bool isInterfaceBlock() const { return mType.isInterfaceBlock(); } |
| 120 | bool isMatrix() const { return mType.isMatrix(); } |
| 121 | bool isArray() const { return mType.isArray(); } |
| 122 | bool isVector() const { return mType.isVector(); } |
| 123 | bool isScalar() const { return mType.isScalar(); } |
| 124 | bool isScalarInt() const { return mType.isScalarInt(); } |
| 125 | const char *getBasicString() const { return mType.getBasicString(); } |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 126 | TString getCompleteString() const { return mType.getCompleteString(); } |
| 127 | |
| 128 | int getArraySize() const { return mType.getArraySize(); } |
| 129 | |
| 130 | protected: |
| 131 | TType mType; |
| 132 | }; |
| 133 | |
| 134 | // |
| 135 | // Handle for, do-while, and while loops. |
| 136 | // |
| 137 | enum TLoopType |
| 138 | { |
| 139 | ELoopFor, |
| 140 | ELoopWhile, |
| 141 | ELoopDoWhile |
| 142 | }; |
| 143 | |
| 144 | class TIntermLoop : public TIntermNode |
| 145 | { |
| 146 | public: |
| 147 | TIntermLoop(TLoopType type, |
| 148 | TIntermNode *init, TIntermTyped *cond, TIntermTyped *expr, |
| 149 | TIntermNode *body) |
| 150 | : mType(type), |
| 151 | mInit(init), |
| 152 | mCond(cond), |
| 153 | mExpr(expr), |
| 154 | mBody(body), |
| 155 | mUnrollFlag(false) { } |
| 156 | |
| 157 | virtual TIntermLoop *getAsLoopNode() { return this; } |
| 158 | virtual void traverse(TIntermTraverser *); |
| 159 | virtual bool replaceChildNode( |
| 160 | TIntermNode *original, TIntermNode *replacement); |
| 161 | |
| 162 | TLoopType getType() const { return mType; } |
| 163 | TIntermNode *getInit() { return mInit; } |
| 164 | TIntermTyped *getCondition() { return mCond; } |
| 165 | TIntermTyped *getExpression() { return mExpr; } |
| 166 | TIntermNode *getBody() { return mBody; } |
| 167 | |
| 168 | void setUnrollFlag(bool flag) { mUnrollFlag = flag; } |
| 169 | bool getUnrollFlag() const { return mUnrollFlag; } |
| 170 | |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 171 | protected: |
| 172 | TLoopType mType; |
| 173 | TIntermNode *mInit; // for-loop initialization |
| 174 | TIntermTyped *mCond; // loop exit condition |
| 175 | TIntermTyped *mExpr; // for-loop expression |
| 176 | TIntermNode *mBody; // loop body |
| 177 | |
| 178 | bool mUnrollFlag; // Whether the loop should be unrolled or not. |
| 179 | }; |
| 180 | |
| 181 | // |
| 182 | // Handle break, continue, return, and kill. |
| 183 | // |
| 184 | class TIntermBranch : public TIntermNode |
| 185 | { |
| 186 | public: |
| 187 | TIntermBranch(TOperator op, TIntermTyped *e) |
| 188 | : mFlowOp(op), |
| 189 | mExpression(e) { } |
| 190 | |
| 191 | virtual void traverse(TIntermTraverser *); |
| 192 | virtual bool replaceChildNode( |
| 193 | TIntermNode *original, TIntermNode *replacement); |
| 194 | |
| 195 | TOperator getFlowOp() { return mFlowOp; } |
| 196 | TIntermTyped* getExpression() { return mExpression; } |
| 197 | |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 198 | protected: |
| 199 | TOperator mFlowOp; |
| 200 | TIntermTyped *mExpression; // non-zero except for "return exp;" statements |
| 201 | }; |
| 202 | |
| 203 | // |
| 204 | // Nodes that correspond to symbols or constants in the source code. |
| 205 | // |
| 206 | class TIntermSymbol : public TIntermTyped |
| 207 | { |
| 208 | public: |
| 209 | // if symbol is initialized as symbol(sym), the memory comes from the poolallocator of sym. |
| 210 | // If sym comes from per process globalpoolallocator, then it causes increased memory usage |
| 211 | // per compile it is essential to use "symbol = sym" to assign to symbol |
| 212 | TIntermSymbol(int id, const TString &symbol, const TType &type) |
| 213 | : TIntermTyped(type), |
Olli Etuaho | 78174db | 2015-04-21 16:14:00 +0300 | [diff] [blame] | 214 | mId(id), |
| 215 | mInternal(false) |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 216 | { |
| 217 | mSymbol = symbol; |
| 218 | } |
| 219 | |
| 220 | virtual bool hasSideEffects() const { return false; } |
| 221 | |
| 222 | int getId() const { return mId; } |
| 223 | const TString &getSymbol() const { return mSymbol; } |
| 224 | |
| 225 | void setId(int newId) { mId = newId; } |
| 226 | |
Olli Etuaho | 78174db | 2015-04-21 16:14:00 +0300 | [diff] [blame] | 227 | bool isInternal() const { return mInternal; } |
| 228 | void setInternal(bool isInternal) { mInternal = isInternal; } |
| 229 | |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 230 | virtual void traverse(TIntermTraverser *); |
| 231 | virtual TIntermSymbol *getAsSymbolNode() { return this; } |
| 232 | virtual bool replaceChildNode(TIntermNode *, TIntermNode *) { return false; } |
| 233 | |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 234 | protected: |
| 235 | int mId; |
Olli Etuaho | 78174db | 2015-04-21 16:14:00 +0300 | [diff] [blame] | 236 | bool mInternal; |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 237 | TString mSymbol; |
| 238 | }; |
| 239 | |
| 240 | // A Raw node stores raw code, that the translator will insert verbatim |
| 241 | // into the output stream. Useful for transformation operations that make |
| 242 | // complex code that might not fit naturally into the GLSL model. |
| 243 | class TIntermRaw : public TIntermTyped |
| 244 | { |
| 245 | public: |
| 246 | TIntermRaw(const TType &type, const TString &rawText) |
| 247 | : TIntermTyped(type), |
| 248 | mRawText(rawText) { } |
| 249 | |
| 250 | virtual bool hasSideEffects() const { return false; } |
| 251 | |
| 252 | TString getRawText() const { return mRawText; } |
| 253 | |
| 254 | virtual void traverse(TIntermTraverser *); |
| 255 | |
| 256 | virtual TIntermRaw *getAsRawNode() { return this; } |
| 257 | virtual bool replaceChildNode(TIntermNode *, TIntermNode *) { return false; } |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 258 | |
| 259 | protected: |
| 260 | TString mRawText; |
| 261 | }; |
| 262 | |
| 263 | class TIntermConstantUnion : public TIntermTyped |
| 264 | { |
| 265 | public: |
Jamie Madill | 6ba6ead | 2015-05-04 14:21:21 -0400 | [diff] [blame] | 266 | TIntermConstantUnion(TConstantUnion *unionPointer, const TType &type) |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 267 | : TIntermTyped(type), |
| 268 | mUnionArrayPointer(unionPointer) { } |
| 269 | |
| 270 | virtual bool hasSideEffects() const { return false; } |
| 271 | |
Jamie Madill | b11e248 | 2015-05-04 14:21:22 -0400 | [diff] [blame] | 272 | const TConstantUnion *getUnionArrayPointer() const { return mUnionArrayPointer; } |
| 273 | TConstantUnion *getUnionArrayPointer() { return mUnionArrayPointer; } |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 274 | |
| 275 | int getIConst(size_t index) const |
| 276 | { |
| 277 | return mUnionArrayPointer ? mUnionArrayPointer[index].getIConst() : 0; |
| 278 | } |
| 279 | unsigned int getUConst(size_t index) const |
| 280 | { |
| 281 | return mUnionArrayPointer ? mUnionArrayPointer[index].getUConst() : 0; |
| 282 | } |
| 283 | float getFConst(size_t index) const |
| 284 | { |
| 285 | return mUnionArrayPointer ? mUnionArrayPointer[index].getFConst() : 0.0f; |
| 286 | } |
| 287 | bool getBConst(size_t index) const |
| 288 | { |
| 289 | return mUnionArrayPointer ? mUnionArrayPointer[index].getBConst() : false; |
| 290 | } |
| 291 | |
Jamie Madill | b11e248 | 2015-05-04 14:21:22 -0400 | [diff] [blame] | 292 | void replaceConstantUnion(TConstantUnion *safeConstantUnion) |
| 293 | { |
| 294 | // Previous union pointer freed on pool deallocation. |
| 295 | mUnionArrayPointer = safeConstantUnion; |
| 296 | } |
| 297 | |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 298 | virtual TIntermConstantUnion *getAsConstantUnion() { return this; } |
| 299 | virtual void traverse(TIntermTraverser *); |
| 300 | virtual bool replaceChildNode(TIntermNode *, TIntermNode *) { return false; } |
| 301 | |
Olli Etuaho | 2cb7b83 | 2015-04-23 20:27:44 +0300 | [diff] [blame] | 302 | TIntermTyped *fold(TOperator op, TIntermConstantUnion *rightNode, TInfoSink &infoSink); |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 303 | |
Arun Patole | bf79042 | 2015-05-18 17:53:04 +0530 | [diff] [blame] | 304 | static TIntermTyped *FoldAggregateBuiltIn(TOperator op, TIntermAggregate *aggregate, TInfoSink &infoSink); |
Arun Patole | 274f070 | 2015-05-05 13:33:30 +0530 | [diff] [blame] | 305 | |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 306 | protected: |
Jamie Madill | 6ba6ead | 2015-05-04 14:21:21 -0400 | [diff] [blame] | 307 | TConstantUnion *mUnionArrayPointer; |
Arun Patole | 9dea48f | 2015-04-02 11:45:09 +0530 | [diff] [blame] | 308 | |
| 309 | private: |
| 310 | typedef float(*FloatTypeUnaryFunc) (float); |
Jamie Madill | 6ba6ead | 2015-05-04 14:21:21 -0400 | [diff] [blame] | 311 | bool foldFloatTypeUnary(const TConstantUnion ¶meter, FloatTypeUnaryFunc builtinFunc, TInfoSink &infoSink, TConstantUnion *result) const; |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 312 | }; |
| 313 | |
| 314 | // |
| 315 | // Intermediate class for node types that hold operators. |
| 316 | // |
| 317 | class TIntermOperator : public TIntermTyped |
| 318 | { |
| 319 | public: |
| 320 | TOperator getOp() const { return mOp; } |
| 321 | void setOp(TOperator op) { mOp = op; } |
| 322 | |
| 323 | bool isAssignment() const; |
| 324 | bool isConstructor() const; |
| 325 | |
| 326 | virtual bool hasSideEffects() const { return isAssignment(); } |
| 327 | |
| 328 | protected: |
| 329 | TIntermOperator(TOperator op) |
| 330 | : TIntermTyped(TType(EbtFloat, EbpUndefined)), |
| 331 | mOp(op) {} |
| 332 | TIntermOperator(TOperator op, const TType &type) |
| 333 | : TIntermTyped(type), |
| 334 | mOp(op) {} |
| 335 | |
| 336 | TOperator mOp; |
| 337 | }; |
| 338 | |
| 339 | // |
| 340 | // Nodes for all the basic binary math operators. |
| 341 | // |
| 342 | class TIntermBinary : public TIntermOperator |
| 343 | { |
| 344 | public: |
| 345 | TIntermBinary(TOperator op) |
| 346 | : TIntermOperator(op), |
| 347 | mAddIndexClamp(false) {} |
| 348 | |
| 349 | virtual TIntermBinary *getAsBinaryNode() { return this; } |
| 350 | virtual void traverse(TIntermTraverser *); |
| 351 | virtual bool replaceChildNode( |
| 352 | TIntermNode *original, TIntermNode *replacement); |
| 353 | |
| 354 | virtual bool hasSideEffects() const |
| 355 | { |
| 356 | return isAssignment() || mLeft->hasSideEffects() || mRight->hasSideEffects(); |
| 357 | } |
| 358 | |
| 359 | void setLeft(TIntermTyped *node) { mLeft = node; } |
| 360 | void setRight(TIntermTyped *node) { mRight = node; } |
| 361 | TIntermTyped *getLeft() const { return mLeft; } |
| 362 | TIntermTyped *getRight() const { return mRight; } |
| 363 | bool promote(TInfoSink &); |
| 364 | |
| 365 | void setAddIndexClamp() { mAddIndexClamp = true; } |
| 366 | bool getAddIndexClamp() { return mAddIndexClamp; } |
| 367 | |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 368 | protected: |
| 369 | TIntermTyped* mLeft; |
| 370 | TIntermTyped* mRight; |
| 371 | |
| 372 | // If set to true, wrap any EOpIndexIndirect with a clamp to bounds. |
| 373 | bool mAddIndexClamp; |
| 374 | }; |
| 375 | |
| 376 | // |
| 377 | // Nodes for unary math operators. |
| 378 | // |
| 379 | class TIntermUnary : public TIntermOperator |
| 380 | { |
| 381 | public: |
| 382 | TIntermUnary(TOperator op, const TType &type) |
| 383 | : TIntermOperator(op, type), |
| 384 | mOperand(NULL), |
| 385 | mUseEmulatedFunction(false) {} |
| 386 | TIntermUnary(TOperator op) |
| 387 | : TIntermOperator(op), |
| 388 | mOperand(NULL), |
| 389 | mUseEmulatedFunction(false) {} |
| 390 | |
| 391 | virtual void traverse(TIntermTraverser *); |
| 392 | virtual TIntermUnary *getAsUnaryNode() { return this; } |
| 393 | virtual bool replaceChildNode( |
| 394 | TIntermNode *original, TIntermNode *replacement); |
| 395 | |
| 396 | virtual bool hasSideEffects() const |
| 397 | { |
| 398 | return isAssignment() || mOperand->hasSideEffects(); |
| 399 | } |
| 400 | |
| 401 | void setOperand(TIntermTyped *operand) { mOperand = operand; } |
| 402 | TIntermTyped *getOperand() { return mOperand; } |
Olli Etuaho | f6c694b | 2015-03-26 14:50:53 +0200 | [diff] [blame] | 403 | void promote(const TType *funcReturnType); |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 404 | |
| 405 | void setUseEmulatedFunction() { mUseEmulatedFunction = true; } |
| 406 | bool getUseEmulatedFunction() { return mUseEmulatedFunction; } |
| 407 | |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 408 | protected: |
| 409 | TIntermTyped *mOperand; |
| 410 | |
| 411 | // If set to true, replace the built-in function call with an emulated one |
| 412 | // to work around driver bugs. |
| 413 | bool mUseEmulatedFunction; |
| 414 | }; |
| 415 | |
| 416 | typedef TVector<TIntermNode *> TIntermSequence; |
| 417 | typedef TVector<int> TQualifierList; |
| 418 | |
| 419 | // |
| 420 | // Nodes that operate on an arbitrary sized set of children. |
| 421 | // |
| 422 | class TIntermAggregate : public TIntermOperator |
| 423 | { |
| 424 | public: |
| 425 | TIntermAggregate() |
| 426 | : TIntermOperator(EOpNull), |
| 427 | mUserDefined(false), |
| 428 | mUseEmulatedFunction(false) { } |
| 429 | TIntermAggregate(TOperator op) |
| 430 | : TIntermOperator(op), |
| 431 | mUseEmulatedFunction(false) { } |
| 432 | ~TIntermAggregate() { } |
| 433 | |
| 434 | virtual TIntermAggregate *getAsAggregate() { return this; } |
| 435 | virtual void traverse(TIntermTraverser *); |
| 436 | virtual bool replaceChildNode( |
| 437 | TIntermNode *original, TIntermNode *replacement); |
Olli Etuaho | fc0e2bc | 2015-04-16 13:39:56 +0300 | [diff] [blame] | 438 | bool replaceChildNodeWithMultiple(TIntermNode *original, TIntermSequence replacements); |
Olli Etuaho | a6f2209 | 2015-05-08 18:31:10 +0300 | [diff] [blame] | 439 | bool insertChildNodes(TIntermSequence::size_type position, TIntermSequence insertions); |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 440 | // Conservatively assume function calls and other aggregate operators have side-effects |
| 441 | virtual bool hasSideEffects() const { return true; } |
| 442 | |
| 443 | TIntermSequence *getSequence() { return &mSequence; } |
| 444 | |
| 445 | void setName(const TString &name) { mName = name; } |
| 446 | const TString &getName() const { return mName; } |
| 447 | |
| 448 | void setUserDefined() { mUserDefined = true; } |
| 449 | bool isUserDefined() const { return mUserDefined; } |
| 450 | |
| 451 | void setOptimize(bool optimize) { mOptimize = optimize; } |
| 452 | bool getOptimize() const { return mOptimize; } |
| 453 | void setDebug(bool debug) { mDebug = debug; } |
| 454 | bool getDebug() const { return mDebug; } |
| 455 | |
Corentin Wallez | 71d147f | 2015-02-11 11:15:24 -0800 | [diff] [blame] | 456 | void setFunctionId(int functionId) { mFunctionId = functionId; } |
| 457 | int getFunctionId() const { return mFunctionId; } |
| 458 | |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 459 | void setUseEmulatedFunction() { mUseEmulatedFunction = true; } |
| 460 | bool getUseEmulatedFunction() { return mUseEmulatedFunction; } |
| 461 | |
Olli Etuaho | d2a67b9 | 2014-10-21 16:42:57 +0300 | [diff] [blame] | 462 | void setPrecisionFromChildren(); |
| 463 | void setBuiltInFunctionPrecision(); |
| 464 | |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 465 | protected: |
| 466 | TIntermAggregate(const TIntermAggregate &); // disallow copy constructor |
| 467 | TIntermAggregate &operator=(const TIntermAggregate &); // disallow assignment operator |
| 468 | TIntermSequence mSequence; |
| 469 | TString mName; |
| 470 | bool mUserDefined; // used for user defined function names |
Corentin Wallez | 71d147f | 2015-02-11 11:15:24 -0800 | [diff] [blame] | 471 | int mFunctionId; |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 472 | |
| 473 | bool mOptimize; |
| 474 | bool mDebug; |
| 475 | |
| 476 | // If set to true, replace the built-in function call with an emulated one |
| 477 | // to work around driver bugs. |
| 478 | bool mUseEmulatedFunction; |
| 479 | }; |
| 480 | |
| 481 | // |
Olli Etuaho | a3a3666 | 2015-02-17 13:46:51 +0200 | [diff] [blame] | 482 | // For if tests. |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 483 | // |
| 484 | class TIntermSelection : public TIntermTyped |
| 485 | { |
| 486 | public: |
| 487 | TIntermSelection(TIntermTyped *cond, TIntermNode *trueB, TIntermNode *falseB) |
| 488 | : TIntermTyped(TType(EbtVoid, EbpUndefined)), |
| 489 | mCondition(cond), |
| 490 | mTrueBlock(trueB), |
| 491 | mFalseBlock(falseB) {} |
| 492 | TIntermSelection(TIntermTyped *cond, TIntermNode *trueB, TIntermNode *falseB, |
| 493 | const TType &type) |
| 494 | : TIntermTyped(type), |
| 495 | mCondition(cond), |
| 496 | mTrueBlock(trueB), |
| 497 | mFalseBlock(falseB) {} |
| 498 | |
| 499 | virtual void traverse(TIntermTraverser *); |
| 500 | virtual bool replaceChildNode( |
| 501 | TIntermNode *original, TIntermNode *replacement); |
| 502 | |
| 503 | // Conservatively assume selections have side-effects |
| 504 | virtual bool hasSideEffects() const { return true; } |
| 505 | |
| 506 | bool usesTernaryOperator() const { return getBasicType() != EbtVoid; } |
| 507 | TIntermNode *getCondition() const { return mCondition; } |
| 508 | TIntermNode *getTrueBlock() const { return mTrueBlock; } |
| 509 | TIntermNode *getFalseBlock() const { return mFalseBlock; } |
| 510 | TIntermSelection *getAsSelectionNode() { return this; } |
| 511 | |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 512 | protected: |
| 513 | TIntermTyped *mCondition; |
| 514 | TIntermNode *mTrueBlock; |
| 515 | TIntermNode *mFalseBlock; |
| 516 | }; |
| 517 | |
Olli Etuaho | a3a3666 | 2015-02-17 13:46:51 +0200 | [diff] [blame] | 518 | // |
| 519 | // Switch statement. |
| 520 | // |
| 521 | class TIntermSwitch : public TIntermNode |
| 522 | { |
| 523 | public: |
| 524 | TIntermSwitch(TIntermTyped *init, TIntermAggregate *statementList) |
| 525 | : TIntermNode(), |
| 526 | mInit(init), |
| 527 | mStatementList(statementList) |
| 528 | { |
| 529 | } |
| 530 | |
| 531 | void traverse(TIntermTraverser *it) override; |
| 532 | bool replaceChildNode( |
| 533 | TIntermNode *original, TIntermNode *replacement) override; |
| 534 | |
| 535 | TIntermSwitch *getAsSwitchNode() override { return this; } |
| 536 | |
Olli Etuaho | 01cd8af | 2015-02-20 10:39:20 +0200 | [diff] [blame] | 537 | TIntermAggregate *getStatementList() { return mStatementList; } |
Olli Etuaho | 2cd7a0e | 2015-02-27 13:57:32 +0200 | [diff] [blame] | 538 | void setStatementList(TIntermAggregate *statementList) { mStatementList = statementList; } |
Olli Etuaho | 01cd8af | 2015-02-20 10:39:20 +0200 | [diff] [blame] | 539 | |
Olli Etuaho | a3a3666 | 2015-02-17 13:46:51 +0200 | [diff] [blame] | 540 | protected: |
| 541 | TIntermTyped *mInit; |
| 542 | TIntermAggregate *mStatementList; |
| 543 | }; |
| 544 | |
| 545 | // |
| 546 | // Case label. |
| 547 | // |
| 548 | class TIntermCase : public TIntermNode |
| 549 | { |
| 550 | public: |
| 551 | TIntermCase(TIntermTyped *condition) |
| 552 | : TIntermNode(), |
| 553 | mCondition(condition) |
| 554 | { |
| 555 | } |
| 556 | |
| 557 | void traverse(TIntermTraverser *it) override; |
| 558 | bool replaceChildNode( |
| 559 | TIntermNode *original, TIntermNode *replacement) override; |
| 560 | |
| 561 | TIntermCase *getAsCaseNode() override { return this; } |
| 562 | |
| 563 | bool hasCondition() const { return mCondition != nullptr; } |
| 564 | TIntermTyped *getCondition() const { return mCondition; } |
| 565 | |
| 566 | protected: |
| 567 | TIntermTyped *mCondition; |
| 568 | }; |
| 569 | |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 570 | enum Visit |
| 571 | { |
| 572 | PreVisit, |
| 573 | InVisit, |
| 574 | PostVisit |
| 575 | }; |
| 576 | |
| 577 | // |
| 578 | // For traversing the tree. User should derive from this, |
| 579 | // put their traversal specific data in it, and then pass |
| 580 | // it to a Traverse method. |
| 581 | // |
| 582 | // When using this, just fill in the methods for nodes you want visited. |
| 583 | // Return false from a pre-visit to skip visiting that node's subtree. |
| 584 | // |
Jamie Madill | f0d10f8 | 2015-03-31 12:56:52 -0400 | [diff] [blame] | 585 | class TIntermTraverser : angle::NonCopyable |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 586 | { |
| 587 | public: |
| 588 | POOL_ALLOCATOR_NEW_DELETE(); |
| 589 | // TODO(zmo): remove default values. |
| 590 | TIntermTraverser(bool preVisit = true, bool inVisit = false, bool postVisit = false, |
| 591 | bool rightToLeft = false) |
| 592 | : preVisit(preVisit), |
| 593 | inVisit(inVisit), |
| 594 | postVisit(postVisit), |
| 595 | rightToLeft(rightToLeft), |
| 596 | mDepth(0), |
Olli Etuaho | d4f303e | 2015-05-20 17:09:06 +0300 | [diff] [blame] | 597 | mMaxDepth(0), |
| 598 | mTemporaryIndex(nullptr) |
| 599 | { |
| 600 | } |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 601 | virtual ~TIntermTraverser() {} |
| 602 | |
| 603 | virtual void visitSymbol(TIntermSymbol *) {} |
| 604 | virtual void visitRaw(TIntermRaw *) {} |
| 605 | virtual void visitConstantUnion(TIntermConstantUnion *) {} |
| 606 | virtual bool visitBinary(Visit, TIntermBinary *) { return true; } |
| 607 | virtual bool visitUnary(Visit, TIntermUnary *) { return true; } |
| 608 | virtual bool visitSelection(Visit, TIntermSelection *) { return true; } |
Olli Etuaho | a3a3666 | 2015-02-17 13:46:51 +0200 | [diff] [blame] | 609 | virtual bool visitSwitch(Visit, TIntermSwitch *) { return true; } |
| 610 | virtual bool visitCase(Visit, TIntermCase *) { return true; } |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 611 | virtual bool visitAggregate(Visit, TIntermAggregate *) { return true; } |
| 612 | virtual bool visitLoop(Visit, TIntermLoop *) { return true; } |
| 613 | virtual bool visitBranch(Visit, TIntermBranch *) { return true; } |
| 614 | |
| 615 | int getMaxDepth() const { return mMaxDepth; } |
| 616 | |
| 617 | void incrementDepth(TIntermNode *current) |
| 618 | { |
| 619 | mDepth++; |
| 620 | mMaxDepth = std::max(mMaxDepth, mDepth); |
| 621 | mPath.push_back(current); |
| 622 | } |
| 623 | |
| 624 | void decrementDepth() |
| 625 | { |
| 626 | mDepth--; |
| 627 | mPath.pop_back(); |
| 628 | } |
| 629 | |
| 630 | TIntermNode *getParentNode() |
| 631 | { |
| 632 | return mPath.size() == 0 ? NULL : mPath.back(); |
| 633 | } |
| 634 | |
Olli Etuaho | 56eea88 | 2015-05-18 12:41:03 +0300 | [diff] [blame] | 635 | void pushParentBlock(TIntermAggregate *node); |
| 636 | void incrementParentBlockPos(); |
| 637 | void popParentBlock(); |
| 638 | |
Olli Etuaho | a5316a1 | 2015-05-15 15:25:16 +0300 | [diff] [blame^] | 639 | bool parentNodeIsBlock() |
| 640 | { |
| 641 | return !mParentBlockStack.empty() && getParentNode() == mParentBlockStack.back().node; |
| 642 | } |
| 643 | |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 644 | // Return the original name if hash function pointer is NULL; |
| 645 | // otherwise return the hashed name. |
| 646 | static TString hash(const TString& name, ShHashFunction64 hashFunction); |
| 647 | |
| 648 | const bool preVisit; |
| 649 | const bool inVisit; |
| 650 | const bool postVisit; |
| 651 | const bool rightToLeft; |
| 652 | |
Olli Etuaho | 853dc1a | 2014-11-06 17:25:48 +0200 | [diff] [blame] | 653 | // If traversers need to replace nodes, they can add the replacements in |
Olli Etuaho | fc0e2bc | 2015-04-16 13:39:56 +0300 | [diff] [blame] | 654 | // mReplacements/mMultiReplacements during traversal and the user of the traverser should call |
Olli Etuaho | 853dc1a | 2014-11-06 17:25:48 +0200 | [diff] [blame] | 655 | // this function after traversal to perform them. |
| 656 | void updateTree(); |
| 657 | |
Olli Etuaho | d4f303e | 2015-05-20 17:09:06 +0300 | [diff] [blame] | 658 | // Start creating temporary symbols from the given temporary symbol index + 1. |
| 659 | void useTemporaryIndex(unsigned int *temporaryIndex); |
| 660 | |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 661 | protected: |
| 662 | int mDepth; |
| 663 | int mMaxDepth; |
| 664 | |
| 665 | // All the nodes from root to the current node's parent during traversing. |
| 666 | TVector<TIntermNode *> mPath; |
Olli Etuaho | 853dc1a | 2014-11-06 17:25:48 +0200 | [diff] [blame] | 667 | |
Olli Etuaho | fc0e2bc | 2015-04-16 13:39:56 +0300 | [diff] [blame] | 668 | // To replace a single node with another on the parent node |
Olli Etuaho | 853dc1a | 2014-11-06 17:25:48 +0200 | [diff] [blame] | 669 | struct NodeUpdateEntry |
| 670 | { |
| 671 | NodeUpdateEntry(TIntermNode *_parent, |
| 672 | TIntermNode *_original, |
| 673 | TIntermNode *_replacement, |
| 674 | bool _originalBecomesChildOfReplacement) |
| 675 | : parent(_parent), |
| 676 | original(_original), |
| 677 | replacement(_replacement), |
| 678 | originalBecomesChildOfReplacement(_originalBecomesChildOfReplacement) {} |
| 679 | |
| 680 | TIntermNode *parent; |
| 681 | TIntermNode *original; |
| 682 | TIntermNode *replacement; |
| 683 | bool originalBecomesChildOfReplacement; |
| 684 | }; |
| 685 | |
Olli Etuaho | fc0e2bc | 2015-04-16 13:39:56 +0300 | [diff] [blame] | 686 | // To replace a single node with multiple nodes on the parent aggregate node |
| 687 | struct NodeReplaceWithMultipleEntry |
| 688 | { |
| 689 | NodeReplaceWithMultipleEntry(TIntermAggregate *_parent, TIntermNode *_original, TIntermSequence _replacements) |
| 690 | : parent(_parent), |
| 691 | original(_original), |
| 692 | replacements(_replacements) |
| 693 | { |
| 694 | } |
| 695 | |
| 696 | TIntermAggregate *parent; |
| 697 | TIntermNode *original; |
| 698 | TIntermSequence replacements; |
| 699 | }; |
| 700 | |
Olli Etuaho | a6f2209 | 2015-05-08 18:31:10 +0300 | [diff] [blame] | 701 | // To insert multiple nodes on the parent aggregate node |
| 702 | struct NodeInsertMultipleEntry |
| 703 | { |
| 704 | NodeInsertMultipleEntry(TIntermAggregate *_parent, TIntermSequence::size_type _position, TIntermSequence _insertions) |
| 705 | : parent(_parent), |
| 706 | position(_position), |
| 707 | insertions(_insertions) |
| 708 | { |
| 709 | } |
| 710 | |
| 711 | TIntermAggregate *parent; |
| 712 | TIntermSequence::size_type position; |
| 713 | TIntermSequence insertions; |
| 714 | }; |
| 715 | |
Olli Etuaho | 853dc1a | 2014-11-06 17:25:48 +0200 | [diff] [blame] | 716 | // During traversing, save all the changes that need to happen into |
Olli Etuaho | fc0e2bc | 2015-04-16 13:39:56 +0300 | [diff] [blame] | 717 | // mReplacements/mMultiReplacements, then do them by calling updateTree(). |
| 718 | // Multi replacements are processed after single replacements. |
Olli Etuaho | 853dc1a | 2014-11-06 17:25:48 +0200 | [diff] [blame] | 719 | std::vector<NodeUpdateEntry> mReplacements; |
Olli Etuaho | fc0e2bc | 2015-04-16 13:39:56 +0300 | [diff] [blame] | 720 | std::vector<NodeReplaceWithMultipleEntry> mMultiReplacements; |
Olli Etuaho | a6f2209 | 2015-05-08 18:31:10 +0300 | [diff] [blame] | 721 | std::vector<NodeInsertMultipleEntry> mInsertions; |
Olli Etuaho | 56eea88 | 2015-05-18 12:41:03 +0300 | [diff] [blame] | 722 | |
| 723 | // Helper to insert statements in the parent block (sequence) of the node currently being traversed. |
| 724 | // The statements will be inserted before the node being traversed once updateTree is called. |
| 725 | // Should only be called during PreVisit or PostVisit from sequence nodes. |
| 726 | // Note that inserting more than one set of nodes to the same parent node on a single updateTree call is not |
| 727 | // supported. |
| 728 | void insertStatementsInParentBlock(const TIntermSequence &insertions); |
| 729 | |
Olli Etuaho | d4f303e | 2015-05-20 17:09:06 +0300 | [diff] [blame] | 730 | // Helper to create a temporary symbol node. |
| 731 | TIntermSymbol *createTempSymbol(const TType &type); |
| 732 | // Create a node that initializes the current temporary symbol with initializer. |
| 733 | TIntermAggregate *createTempInitDeclaration(TIntermTyped *initializer); |
| 734 | // Create a node that assigns rightNode to the current temporary symbol. |
| 735 | TIntermBinary *createTempAssignment(TIntermTyped *rightNode); |
| 736 | // Increment temporary symbol index. |
| 737 | void nextTemporaryIndex(); |
| 738 | |
Olli Etuaho | 56eea88 | 2015-05-18 12:41:03 +0300 | [diff] [blame] | 739 | private: |
| 740 | struct ParentBlock |
| 741 | { |
| 742 | ParentBlock(TIntermAggregate *nodeIn, TIntermSequence::size_type posIn) |
| 743 | : node(nodeIn), |
| 744 | pos(posIn) |
| 745 | { |
| 746 | } |
| 747 | |
| 748 | TIntermAggregate *node; |
| 749 | TIntermSequence::size_type pos; |
| 750 | }; |
| 751 | // All the code blocks from the root to the current node's parent during traversal. |
| 752 | std::vector<ParentBlock> mParentBlockStack; |
Olli Etuaho | d4f303e | 2015-05-20 17:09:06 +0300 | [diff] [blame] | 753 | |
| 754 | unsigned int *mTemporaryIndex; |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 755 | }; |
| 756 | |
| 757 | // |
| 758 | // For traversing the tree, and computing max depth. |
| 759 | // Takes a maximum depth limit to prevent stack overflow. |
| 760 | // |
| 761 | class TMaxDepthTraverser : public TIntermTraverser |
| 762 | { |
| 763 | public: |
| 764 | POOL_ALLOCATOR_NEW_DELETE(); |
| 765 | TMaxDepthTraverser(int depthLimit) |
| 766 | : TIntermTraverser(true, true, false, false), |
| 767 | mDepthLimit(depthLimit) { } |
| 768 | |
| 769 | virtual bool visitBinary(Visit, TIntermBinary *) { return depthCheck(); } |
| 770 | virtual bool visitUnary(Visit, TIntermUnary *) { return depthCheck(); } |
| 771 | virtual bool visitSelection(Visit, TIntermSelection *) { return depthCheck(); } |
| 772 | virtual bool visitAggregate(Visit, TIntermAggregate *) { return depthCheck(); } |
| 773 | virtual bool visitLoop(Visit, TIntermLoop *) { return depthCheck(); } |
| 774 | virtual bool visitBranch(Visit, TIntermBranch *) { return depthCheck(); } |
| 775 | |
Jamie Madill | 80d934b | 2015-02-19 10:16:12 -0500 | [diff] [blame] | 776 | protected: |
Jamie Madill | b1a85f4 | 2014-08-19 15:23:24 -0400 | [diff] [blame] | 777 | bool depthCheck() const { return mMaxDepth < mDepthLimit; } |
| 778 | |
| 779 | int mDepthLimit; |
| 780 | }; |
| 781 | |
Geoff Lang | 0a73dd8 | 2014-11-19 16:18:08 -0500 | [diff] [blame] | 782 | #endif // COMPILER_TRANSLATOR_INTERMNODE_H_ |