blob: 0ee19b266df9516460e1616ea66282887144debd [file] [log] [blame]
Jamie Madillb1a85f42014-08-19 15:23:24 -04001//
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 Lang0a73dd82014-11-19 16:18:08 -050016#ifndef COMPILER_TRANSLATOR_INTERMNODE_H_
17#define COMPILER_TRANSLATOR_INTERMNODE_H_
Jamie Madillb1a85f42014-08-19 15:23:24 -040018
19#include "GLSLANG/ShaderLang.h"
20
21#include <algorithm>
22#include <queue>
23
Jamie Madill80d934b2015-02-19 10:16:12 -050024#include "common/angleutils.h"
Jamie Madillb1a85f42014-08-19 15:23:24 -040025#include "compiler/translator/Common.h"
Jamie Madillb1a85f42014-08-19 15:23:24 -040026#include "compiler/translator/ConstantUnion.h"
Olli Etuaho1033e1d2015-02-12 12:03:13 +020027#include "compiler/translator/Operator.h"
Jamie Madill6ba6ead2015-05-04 14:21:21 -040028#include "compiler/translator/Types.h"
Jamie Madillb1a85f42014-08-19 15:23:24 -040029
30class TIntermTraverser;
31class TIntermAggregate;
32class TIntermBinary;
33class TIntermUnary;
34class TIntermConstantUnion;
35class TIntermSelection;
Olli Etuahoa3a36662015-02-17 13:46:51 +020036class TIntermSwitch;
37class TIntermCase;
Jamie Madillb1a85f42014-08-19 15:23:24 -040038class TIntermTyped;
39class TIntermSymbol;
40class TIntermLoop;
41class TInfoSink;
Olli Etuahoa3a5cc62015-02-13 13:12:22 +020042class TInfoSinkBase;
Jamie Madillb1a85f42014-08-19 15:23:24 -040043class TIntermRaw;
44
45//
46// Base class for the tree nodes
47//
48class 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 Etuahoa3a36662015-02-17 13:46:51 +020071 virtual TIntermSwitch *getAsSwitchNode() { return 0; }
72 virtual TIntermCase *getAsCaseNode() { return 0; }
Jamie Madillb1a85f42014-08-19 15:23:24 -040073 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 Madillb1a85f42014-08-19 15:23:24 -040082 protected:
83 TSourceLoc mLine;
84};
85
86//
87// This is just to help yacc.
88//
89struct TIntermNodePair
90{
91 TIntermNode *node1;
92 TIntermNode *node2;
93};
94
95//
96// Intermediate class for nodes that have a type.
97//
98class 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 Etuahod2a67b92014-10-21 16:42:57 +0300107 void setTypePreservePrecision(const TType &t);
Jamie Madillb1a85f42014-08-19 15:23:24 -0400108 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 Madillb1a85f42014-08-19 15:23:24 -0400126 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//
137enum TLoopType
138{
139 ELoopFor,
140 ELoopWhile,
141 ELoopDoWhile
142};
143
144class 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 Madillb1a85f42014-08-19 15:23:24 -0400171 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//
184class 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 Madillb1a85f42014-08-19 15:23:24 -0400198protected:
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//
206class 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 Etuaho78174db2015-04-21 16:14:00 +0300214 mId(id),
215 mInternal(false)
Jamie Madillb1a85f42014-08-19 15:23:24 -0400216 {
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 Etuaho78174db2015-04-21 16:14:00 +0300227 bool isInternal() const { return mInternal; }
228 void setInternal(bool isInternal) { mInternal = isInternal; }
229
Jamie Madillb1a85f42014-08-19 15:23:24 -0400230 virtual void traverse(TIntermTraverser *);
231 virtual TIntermSymbol *getAsSymbolNode() { return this; }
232 virtual bool replaceChildNode(TIntermNode *, TIntermNode *) { return false; }
233
Jamie Madillb1a85f42014-08-19 15:23:24 -0400234 protected:
235 int mId;
Olli Etuaho78174db2015-04-21 16:14:00 +0300236 bool mInternal;
Jamie Madillb1a85f42014-08-19 15:23:24 -0400237 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.
243class 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 Madillb1a85f42014-08-19 15:23:24 -0400258
259 protected:
260 TString mRawText;
261};
262
263class TIntermConstantUnion : public TIntermTyped
264{
265 public:
Jamie Madill6ba6ead2015-05-04 14:21:21 -0400266 TIntermConstantUnion(TConstantUnion *unionPointer, const TType &type)
Jamie Madillb1a85f42014-08-19 15:23:24 -0400267 : TIntermTyped(type),
268 mUnionArrayPointer(unionPointer) { }
269
270 virtual bool hasSideEffects() const { return false; }
271
Jamie Madillb11e2482015-05-04 14:21:22 -0400272 const TConstantUnion *getUnionArrayPointer() const { return mUnionArrayPointer; }
273 TConstantUnion *getUnionArrayPointer() { return mUnionArrayPointer; }
Jamie Madillb1a85f42014-08-19 15:23:24 -0400274
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 Madillb11e2482015-05-04 14:21:22 -0400292 void replaceConstantUnion(TConstantUnion *safeConstantUnion)
293 {
294 // Previous union pointer freed on pool deallocation.
295 mUnionArrayPointer = safeConstantUnion;
296 }
297
Jamie Madillb1a85f42014-08-19 15:23:24 -0400298 virtual TIntermConstantUnion *getAsConstantUnion() { return this; }
299 virtual void traverse(TIntermTraverser *);
300 virtual bool replaceChildNode(TIntermNode *, TIntermNode *) { return false; }
301
Olli Etuaho2cb7b832015-04-23 20:27:44 +0300302 TIntermTyped *fold(TOperator op, TIntermConstantUnion *rightNode, TInfoSink &infoSink);
Jamie Madillb1a85f42014-08-19 15:23:24 -0400303
Arun Patolebf790422015-05-18 17:53:04 +0530304 static TIntermTyped *FoldAggregateBuiltIn(TOperator op, TIntermAggregate *aggregate, TInfoSink &infoSink);
Arun Patole274f0702015-05-05 13:33:30 +0530305
Jamie Madillb1a85f42014-08-19 15:23:24 -0400306 protected:
Jamie Madill6ba6ead2015-05-04 14:21:21 -0400307 TConstantUnion *mUnionArrayPointer;
Arun Patole9dea48f2015-04-02 11:45:09 +0530308
309 private:
310 typedef float(*FloatTypeUnaryFunc) (float);
Jamie Madill6ba6ead2015-05-04 14:21:21 -0400311 bool foldFloatTypeUnary(const TConstantUnion &parameter, FloatTypeUnaryFunc builtinFunc, TInfoSink &infoSink, TConstantUnion *result) const;
Jamie Madillb1a85f42014-08-19 15:23:24 -0400312};
313
314//
315// Intermediate class for node types that hold operators.
316//
317class TIntermOperator : public TIntermTyped
318{
319 public:
320 TOperator getOp() const { return mOp; }
321 void setOp(TOperator op) { mOp = op; }
322
323 bool isAssignment() const;
Olli Etuaho8f76bcc2015-06-02 13:54:20 +0300324 bool isMultiplication() const;
Jamie Madillb1a85f42014-08-19 15:23:24 -0400325 bool isConstructor() const;
326
327 virtual bool hasSideEffects() const { return isAssignment(); }
328
329 protected:
330 TIntermOperator(TOperator op)
331 : TIntermTyped(TType(EbtFloat, EbpUndefined)),
332 mOp(op) {}
333 TIntermOperator(TOperator op, const TType &type)
334 : TIntermTyped(type),
335 mOp(op) {}
336
337 TOperator mOp;
338};
339
340//
341// Nodes for all the basic binary math operators.
342//
343class TIntermBinary : public TIntermOperator
344{
345 public:
346 TIntermBinary(TOperator op)
347 : TIntermOperator(op),
348 mAddIndexClamp(false) {}
349
350 virtual TIntermBinary *getAsBinaryNode() { return this; }
351 virtual void traverse(TIntermTraverser *);
352 virtual bool replaceChildNode(
353 TIntermNode *original, TIntermNode *replacement);
354
355 virtual bool hasSideEffects() const
356 {
357 return isAssignment() || mLeft->hasSideEffects() || mRight->hasSideEffects();
358 }
359
360 void setLeft(TIntermTyped *node) { mLeft = node; }
361 void setRight(TIntermTyped *node) { mRight = node; }
362 TIntermTyped *getLeft() const { return mLeft; }
363 TIntermTyped *getRight() const { return mRight; }
364 bool promote(TInfoSink &);
365
366 void setAddIndexClamp() { mAddIndexClamp = true; }
367 bool getAddIndexClamp() { return mAddIndexClamp; }
368
Jamie Madillb1a85f42014-08-19 15:23:24 -0400369 protected:
370 TIntermTyped* mLeft;
371 TIntermTyped* mRight;
372
373 // If set to true, wrap any EOpIndexIndirect with a clamp to bounds.
374 bool mAddIndexClamp;
375};
376
377//
378// Nodes for unary math operators.
379//
380class TIntermUnary : public TIntermOperator
381{
382 public:
383 TIntermUnary(TOperator op, const TType &type)
384 : TIntermOperator(op, type),
385 mOperand(NULL),
386 mUseEmulatedFunction(false) {}
387 TIntermUnary(TOperator op)
388 : TIntermOperator(op),
389 mOperand(NULL),
390 mUseEmulatedFunction(false) {}
391
392 virtual void traverse(TIntermTraverser *);
393 virtual TIntermUnary *getAsUnaryNode() { return this; }
394 virtual bool replaceChildNode(
395 TIntermNode *original, TIntermNode *replacement);
396
397 virtual bool hasSideEffects() const
398 {
399 return isAssignment() || mOperand->hasSideEffects();
400 }
401
402 void setOperand(TIntermTyped *operand) { mOperand = operand; }
403 TIntermTyped *getOperand() { return mOperand; }
Olli Etuahof6c694b2015-03-26 14:50:53 +0200404 void promote(const TType *funcReturnType);
Jamie Madillb1a85f42014-08-19 15:23:24 -0400405
406 void setUseEmulatedFunction() { mUseEmulatedFunction = true; }
407 bool getUseEmulatedFunction() { return mUseEmulatedFunction; }
408
Jamie Madillb1a85f42014-08-19 15:23:24 -0400409 protected:
410 TIntermTyped *mOperand;
411
412 // If set to true, replace the built-in function call with an emulated one
413 // to work around driver bugs.
414 bool mUseEmulatedFunction;
415};
416
417typedef TVector<TIntermNode *> TIntermSequence;
418typedef TVector<int> TQualifierList;
419
420//
421// Nodes that operate on an arbitrary sized set of children.
422//
423class TIntermAggregate : public TIntermOperator
424{
425 public:
426 TIntermAggregate()
427 : TIntermOperator(EOpNull),
428 mUserDefined(false),
429 mUseEmulatedFunction(false) { }
430 TIntermAggregate(TOperator op)
431 : TIntermOperator(op),
432 mUseEmulatedFunction(false) { }
433 ~TIntermAggregate() { }
434
435 virtual TIntermAggregate *getAsAggregate() { return this; }
436 virtual void traverse(TIntermTraverser *);
437 virtual bool replaceChildNode(
438 TIntermNode *original, TIntermNode *replacement);
Olli Etuahofc0e2bc2015-04-16 13:39:56 +0300439 bool replaceChildNodeWithMultiple(TIntermNode *original, TIntermSequence replacements);
Olli Etuahoa6f22092015-05-08 18:31:10 +0300440 bool insertChildNodes(TIntermSequence::size_type position, TIntermSequence insertions);
Jamie Madillb1a85f42014-08-19 15:23:24 -0400441 // Conservatively assume function calls and other aggregate operators have side-effects
442 virtual bool hasSideEffects() const { return true; }
443
444 TIntermSequence *getSequence() { return &mSequence; }
445
446 void setName(const TString &name) { mName = name; }
447 const TString &getName() const { return mName; }
448
449 void setUserDefined() { mUserDefined = true; }
450 bool isUserDefined() const { return mUserDefined; }
451
452 void setOptimize(bool optimize) { mOptimize = optimize; }
453 bool getOptimize() const { return mOptimize; }
454 void setDebug(bool debug) { mDebug = debug; }
455 bool getDebug() const { return mDebug; }
456
Corentin Wallez71d147f2015-02-11 11:15:24 -0800457 void setFunctionId(int functionId) { mFunctionId = functionId; }
458 int getFunctionId() const { return mFunctionId; }
459
Jamie Madillb1a85f42014-08-19 15:23:24 -0400460 void setUseEmulatedFunction() { mUseEmulatedFunction = true; }
461 bool getUseEmulatedFunction() { return mUseEmulatedFunction; }
462
Olli Etuahod2a67b92014-10-21 16:42:57 +0300463 void setPrecisionFromChildren();
464 void setBuiltInFunctionPrecision();
465
Jamie Madillb1a85f42014-08-19 15:23:24 -0400466 protected:
467 TIntermAggregate(const TIntermAggregate &); // disallow copy constructor
468 TIntermAggregate &operator=(const TIntermAggregate &); // disallow assignment operator
469 TIntermSequence mSequence;
470 TString mName;
471 bool mUserDefined; // used for user defined function names
Corentin Wallez71d147f2015-02-11 11:15:24 -0800472 int mFunctionId;
Jamie Madillb1a85f42014-08-19 15:23:24 -0400473
474 bool mOptimize;
475 bool mDebug;
476
477 // If set to true, replace the built-in function call with an emulated one
478 // to work around driver bugs.
479 bool mUseEmulatedFunction;
480};
481
482//
Olli Etuahoa3a36662015-02-17 13:46:51 +0200483// For if tests.
Jamie Madillb1a85f42014-08-19 15:23:24 -0400484//
485class TIntermSelection : public TIntermTyped
486{
487 public:
488 TIntermSelection(TIntermTyped *cond, TIntermNode *trueB, TIntermNode *falseB)
489 : TIntermTyped(TType(EbtVoid, EbpUndefined)),
490 mCondition(cond),
491 mTrueBlock(trueB),
492 mFalseBlock(falseB) {}
493 TIntermSelection(TIntermTyped *cond, TIntermNode *trueB, TIntermNode *falseB,
494 const TType &type)
495 : TIntermTyped(type),
496 mCondition(cond),
497 mTrueBlock(trueB),
498 mFalseBlock(falseB) {}
499
500 virtual void traverse(TIntermTraverser *);
501 virtual bool replaceChildNode(
502 TIntermNode *original, TIntermNode *replacement);
503
504 // Conservatively assume selections have side-effects
505 virtual bool hasSideEffects() const { return true; }
506
507 bool usesTernaryOperator() const { return getBasicType() != EbtVoid; }
508 TIntermNode *getCondition() const { return mCondition; }
509 TIntermNode *getTrueBlock() const { return mTrueBlock; }
510 TIntermNode *getFalseBlock() const { return mFalseBlock; }
511 TIntermSelection *getAsSelectionNode() { return this; }
512
Jamie Madillb1a85f42014-08-19 15:23:24 -0400513protected:
514 TIntermTyped *mCondition;
515 TIntermNode *mTrueBlock;
516 TIntermNode *mFalseBlock;
517};
518
Olli Etuahoa3a36662015-02-17 13:46:51 +0200519//
520// Switch statement.
521//
522class TIntermSwitch : public TIntermNode
523{
524 public:
525 TIntermSwitch(TIntermTyped *init, TIntermAggregate *statementList)
526 : TIntermNode(),
527 mInit(init),
528 mStatementList(statementList)
529 {
530 }
531
532 void traverse(TIntermTraverser *it) override;
533 bool replaceChildNode(
534 TIntermNode *original, TIntermNode *replacement) override;
535
536 TIntermSwitch *getAsSwitchNode() override { return this; }
537
Olli Etuaho01cd8af2015-02-20 10:39:20 +0200538 TIntermAggregate *getStatementList() { return mStatementList; }
Olli Etuaho2cd7a0e2015-02-27 13:57:32 +0200539 void setStatementList(TIntermAggregate *statementList) { mStatementList = statementList; }
Olli Etuaho01cd8af2015-02-20 10:39:20 +0200540
Olli Etuahoa3a36662015-02-17 13:46:51 +0200541 protected:
542 TIntermTyped *mInit;
543 TIntermAggregate *mStatementList;
544};
545
546//
547// Case label.
548//
549class TIntermCase : public TIntermNode
550{
551 public:
552 TIntermCase(TIntermTyped *condition)
553 : TIntermNode(),
554 mCondition(condition)
555 {
556 }
557
558 void traverse(TIntermTraverser *it) override;
559 bool replaceChildNode(
560 TIntermNode *original, TIntermNode *replacement) override;
561
562 TIntermCase *getAsCaseNode() override { return this; }
563
564 bool hasCondition() const { return mCondition != nullptr; }
565 TIntermTyped *getCondition() const { return mCondition; }
566
567 protected:
568 TIntermTyped *mCondition;
569};
570
Jamie Madillb1a85f42014-08-19 15:23:24 -0400571enum Visit
572{
573 PreVisit,
574 InVisit,
575 PostVisit
576};
577
578//
579// For traversing the tree. User should derive from this,
580// put their traversal specific data in it, and then pass
581// it to a Traverse method.
582//
583// When using this, just fill in the methods for nodes you want visited.
584// Return false from a pre-visit to skip visiting that node's subtree.
585//
Jamie Madillf0d10f82015-03-31 12:56:52 -0400586class TIntermTraverser : angle::NonCopyable
Jamie Madillb1a85f42014-08-19 15:23:24 -0400587{
588 public:
589 POOL_ALLOCATOR_NEW_DELETE();
590 // TODO(zmo): remove default values.
591 TIntermTraverser(bool preVisit = true, bool inVisit = false, bool postVisit = false,
592 bool rightToLeft = false)
593 : preVisit(preVisit),
594 inVisit(inVisit),
595 postVisit(postVisit),
596 rightToLeft(rightToLeft),
597 mDepth(0),
Olli Etuahod4f303e2015-05-20 17:09:06 +0300598 mMaxDepth(0),
599 mTemporaryIndex(nullptr)
600 {
601 }
Jamie Madillb1a85f42014-08-19 15:23:24 -0400602 virtual ~TIntermTraverser() {}
603
604 virtual void visitSymbol(TIntermSymbol *) {}
605 virtual void visitRaw(TIntermRaw *) {}
606 virtual void visitConstantUnion(TIntermConstantUnion *) {}
607 virtual bool visitBinary(Visit, TIntermBinary *) { return true; }
608 virtual bool visitUnary(Visit, TIntermUnary *) { return true; }
609 virtual bool visitSelection(Visit, TIntermSelection *) { return true; }
Olli Etuahoa3a36662015-02-17 13:46:51 +0200610 virtual bool visitSwitch(Visit, TIntermSwitch *) { return true; }
611 virtual bool visitCase(Visit, TIntermCase *) { return true; }
Jamie Madillb1a85f42014-08-19 15:23:24 -0400612 virtual bool visitAggregate(Visit, TIntermAggregate *) { return true; }
613 virtual bool visitLoop(Visit, TIntermLoop *) { return true; }
614 virtual bool visitBranch(Visit, TIntermBranch *) { return true; }
615
616 int getMaxDepth() const { return mMaxDepth; }
617
618 void incrementDepth(TIntermNode *current)
619 {
620 mDepth++;
621 mMaxDepth = std::max(mMaxDepth, mDepth);
622 mPath.push_back(current);
623 }
624
625 void decrementDepth()
626 {
627 mDepth--;
628 mPath.pop_back();
629 }
630
631 TIntermNode *getParentNode()
632 {
633 return mPath.size() == 0 ? NULL : mPath.back();
634 }
635
Olli Etuaho56eea882015-05-18 12:41:03 +0300636 void pushParentBlock(TIntermAggregate *node);
637 void incrementParentBlockPos();
638 void popParentBlock();
639
Olli Etuahoa5316a12015-05-15 15:25:16 +0300640 bool parentNodeIsBlock()
641 {
642 return !mParentBlockStack.empty() && getParentNode() == mParentBlockStack.back().node;
643 }
644
Jamie Madillb1a85f42014-08-19 15:23:24 -0400645 // Return the original name if hash function pointer is NULL;
646 // otherwise return the hashed name.
647 static TString hash(const TString& name, ShHashFunction64 hashFunction);
648
649 const bool preVisit;
650 const bool inVisit;
651 const bool postVisit;
652 const bool rightToLeft;
653
Olli Etuaho853dc1a2014-11-06 17:25:48 +0200654 // If traversers need to replace nodes, they can add the replacements in
Olli Etuahofc0e2bc2015-04-16 13:39:56 +0300655 // mReplacements/mMultiReplacements during traversal and the user of the traverser should call
Olli Etuaho853dc1a2014-11-06 17:25:48 +0200656 // this function after traversal to perform them.
657 void updateTree();
658
Olli Etuahod4f303e2015-05-20 17:09:06 +0300659 // Start creating temporary symbols from the given temporary symbol index + 1.
660 void useTemporaryIndex(unsigned int *temporaryIndex);
661
Jamie Madillb1a85f42014-08-19 15:23:24 -0400662 protected:
663 int mDepth;
664 int mMaxDepth;
665
666 // All the nodes from root to the current node's parent during traversing.
667 TVector<TIntermNode *> mPath;
Olli Etuaho853dc1a2014-11-06 17:25:48 +0200668
Olli Etuahofc0e2bc2015-04-16 13:39:56 +0300669 // To replace a single node with another on the parent node
Olli Etuaho853dc1a2014-11-06 17:25:48 +0200670 struct NodeUpdateEntry
671 {
672 NodeUpdateEntry(TIntermNode *_parent,
673 TIntermNode *_original,
674 TIntermNode *_replacement,
675 bool _originalBecomesChildOfReplacement)
676 : parent(_parent),
677 original(_original),
678 replacement(_replacement),
679 originalBecomesChildOfReplacement(_originalBecomesChildOfReplacement) {}
680
681 TIntermNode *parent;
682 TIntermNode *original;
683 TIntermNode *replacement;
684 bool originalBecomesChildOfReplacement;
685 };
686
Olli Etuahofc0e2bc2015-04-16 13:39:56 +0300687 // To replace a single node with multiple nodes on the parent aggregate node
688 struct NodeReplaceWithMultipleEntry
689 {
690 NodeReplaceWithMultipleEntry(TIntermAggregate *_parent, TIntermNode *_original, TIntermSequence _replacements)
691 : parent(_parent),
692 original(_original),
693 replacements(_replacements)
694 {
695 }
696
697 TIntermAggregate *parent;
698 TIntermNode *original;
699 TIntermSequence replacements;
700 };
701
Olli Etuahoa6f22092015-05-08 18:31:10 +0300702 // To insert multiple nodes on the parent aggregate node
703 struct NodeInsertMultipleEntry
704 {
705 NodeInsertMultipleEntry(TIntermAggregate *_parent, TIntermSequence::size_type _position, TIntermSequence _insertions)
706 : parent(_parent),
707 position(_position),
708 insertions(_insertions)
709 {
710 }
711
712 TIntermAggregate *parent;
713 TIntermSequence::size_type position;
714 TIntermSequence insertions;
715 };
716
Olli Etuaho853dc1a2014-11-06 17:25:48 +0200717 // During traversing, save all the changes that need to happen into
Olli Etuahofc0e2bc2015-04-16 13:39:56 +0300718 // mReplacements/mMultiReplacements, then do them by calling updateTree().
719 // Multi replacements are processed after single replacements.
Olli Etuaho853dc1a2014-11-06 17:25:48 +0200720 std::vector<NodeUpdateEntry> mReplacements;
Olli Etuahofc0e2bc2015-04-16 13:39:56 +0300721 std::vector<NodeReplaceWithMultipleEntry> mMultiReplacements;
Olli Etuahoa6f22092015-05-08 18:31:10 +0300722 std::vector<NodeInsertMultipleEntry> mInsertions;
Olli Etuaho56eea882015-05-18 12:41:03 +0300723
724 // Helper to insert statements in the parent block (sequence) of the node currently being traversed.
725 // The statements will be inserted before the node being traversed once updateTree is called.
726 // Should only be called during PreVisit or PostVisit from sequence nodes.
727 // Note that inserting more than one set of nodes to the same parent node on a single updateTree call is not
728 // supported.
729 void insertStatementsInParentBlock(const TIntermSequence &insertions);
730
Olli Etuahod4f303e2015-05-20 17:09:06 +0300731 // Helper to create a temporary symbol node.
732 TIntermSymbol *createTempSymbol(const TType &type);
Olli Etuaho4f1af782015-05-25 11:55:07 +0300733 // Create a node that declares but doesn't initialize a temporary symbol.
734 TIntermAggregate *createTempDeclaration(const TType &type);
Olli Etuahod4f303e2015-05-20 17:09:06 +0300735 // Create a node that initializes the current temporary symbol with initializer.
736 TIntermAggregate *createTempInitDeclaration(TIntermTyped *initializer);
737 // Create a node that assigns rightNode to the current temporary symbol.
738 TIntermBinary *createTempAssignment(TIntermTyped *rightNode);
739 // Increment temporary symbol index.
740 void nextTemporaryIndex();
741
Olli Etuaho56eea882015-05-18 12:41:03 +0300742 private:
743 struct ParentBlock
744 {
745 ParentBlock(TIntermAggregate *nodeIn, TIntermSequence::size_type posIn)
746 : node(nodeIn),
747 pos(posIn)
748 {
749 }
750
751 TIntermAggregate *node;
752 TIntermSequence::size_type pos;
753 };
754 // All the code blocks from the root to the current node's parent during traversal.
755 std::vector<ParentBlock> mParentBlockStack;
Olli Etuahod4f303e2015-05-20 17:09:06 +0300756
757 unsigned int *mTemporaryIndex;
Jamie Madillb1a85f42014-08-19 15:23:24 -0400758};
759
760//
761// For traversing the tree, and computing max depth.
762// Takes a maximum depth limit to prevent stack overflow.
763//
764class TMaxDepthTraverser : public TIntermTraverser
765{
766 public:
767 POOL_ALLOCATOR_NEW_DELETE();
768 TMaxDepthTraverser(int depthLimit)
769 : TIntermTraverser(true, true, false, false),
770 mDepthLimit(depthLimit) { }
771
772 virtual bool visitBinary(Visit, TIntermBinary *) { return depthCheck(); }
773 virtual bool visitUnary(Visit, TIntermUnary *) { return depthCheck(); }
774 virtual bool visitSelection(Visit, TIntermSelection *) { return depthCheck(); }
775 virtual bool visitAggregate(Visit, TIntermAggregate *) { return depthCheck(); }
776 virtual bool visitLoop(Visit, TIntermLoop *) { return depthCheck(); }
777 virtual bool visitBranch(Visit, TIntermBranch *) { return depthCheck(); }
778
Jamie Madill80d934b2015-02-19 10:16:12 -0500779 protected:
Jamie Madillb1a85f42014-08-19 15:23:24 -0400780 bool depthCheck() const { return mMaxDepth < mDepthLimit; }
781
782 int mDepthLimit;
783};
784
Geoff Lang0a73dd82014-11-19 16:18:08 -0500785#endif // COMPILER_TRANSLATOR_INTERMNODE_H_