Hash :
d4b5054d
Author :
Date :
2015-09-28T12:19:26
compiler: Rewrite do-while loops as while loops This works around a Mac driver shader compiler bug that makes many do-while loops cause GPU-hangs when ran. BUG=angleproject:891 Change-Id: I29828d6ea9e887ad0ed0c577f1deb41fb632a900 Reviewed-on: https://chromium-review.googlesource.com/302465 Reviewed-by: Jamie Madill <jmadill@chromium.org> Tested-by: Corentin Wallez <cwallez@chromium.org>
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
//
// Copyright (c) 2015 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// RewriteDoWhile.cpp: rewrites do-while loops using another equivalent
// construct.
#include "compiler/translator/RewriteDoWhile.h"
#include "compiler/translator/IntermNode.h"
namespace
{
// An AST traverser that rewrites loops of the form
// do {
// CODE;
// } while (CONDITION)
//
// to loops of the form
// bool temp = false;
// while (true) {
// if (temp) {
// if (!CONDITION) {
// break;
// }
// }
// temp = true;
// CODE;
// }
//
// The reason we don't use a simpler form, with for example just (temp && !CONDITION) in the
// while condition, is that short-circuit is often badly supported by driver shader compiler.
// The double if has the same effect, but forces shader compilers to behave.
//
// TODO(cwallez) when UnfoldShortCircuitIntoIf handles loops correctly, revisit this as we might
// be able to use while (temp || CONDITION) with temp initially set to true then run
// UnfoldShortCircuitIntoIf
class DoWhileRewriter : public TIntermTraverser
{
public:
DoWhileRewriter() : TIntermTraverser(true, false, false) {}
bool visitAggregate(Visit, TIntermAggregate *node) override
{
// A well-formed AST can only have do-while in EOpSequence which represent lists of
// statements. By doing a prefix traversal we are able to replace the do-while in the
// sequence directly as the content of the do-while will be traversed later.
if (node->getOp() != EOpSequence)
{
return true;
}
TIntermSequence *statements = node->getSequence();
// The statements vector will have new statements inserted when we encounter a do-while,
// which prevents us from using a range-based for loop. Using the usual i++ works, as
// the (two) new statements inserted replace the statement at the current position.
for (size_t i = 0; i < statements->size(); i++)
{
TIntermNode *statement = (*statements)[i];
TIntermLoop *loop = statement->getAsLoopNode();
if (loop == nullptr || loop->getType() != ELoopDoWhile)
{
continue;
}
TType boolType = TType(EbtBool);
// bool temp = false;
TIntermAggregate *tempDeclaration = nullptr;
{
TConstantUnion *falseConstant = new TConstantUnion();
falseConstant->setBConst(false);
TIntermTyped *falseValue = new TIntermConstantUnion(falseConstant, boolType);
tempDeclaration = createTempInitDeclaration(falseValue);
}
// temp = true;
TIntermBinary *assignTrue = nullptr;
{
TConstantUnion *trueConstant = new TConstantUnion();
trueConstant->setBConst(true);
TIntermTyped *trueValue = new TIntermConstantUnion(trueConstant, boolType);
assignTrue = createTempAssignment(trueValue);
}
// if (temp) {
// if (!CONDITION) {
// break;
// }
// }
TIntermSelection *breakIf = nullptr;
{
TIntermBranch *breakStatement = new TIntermBranch(EOpBreak, nullptr);
TIntermAggregate *breakBlock = new TIntermAggregate(EOpSequence);
breakBlock->getSequence()->push_back(breakStatement);
TIntermUnary *negatedCondition = new TIntermUnary(EOpLogicalNot);
negatedCondition->setOperand(loop->getCondition());
TIntermSelection *innerIf =
new TIntermSelection(negatedCondition, breakBlock, nullptr);
TIntermAggregate *innerIfBlock = new TIntermAggregate(EOpSequence);
innerIfBlock->getSequence()->push_back(innerIf);
breakIf = new TIntermSelection(createTempSymbol(boolType), innerIfBlock, nullptr);
}
// Assemble the replacement loops, reusing the do-while loop's body and inserting our
// statements at the front.
TIntermLoop *newLoop = nullptr;
{
TConstantUnion *trueConstant = new TConstantUnion();
trueConstant->setBConst(true);
TIntermTyped *trueValue = new TIntermConstantUnion(trueConstant, boolType);
TIntermAggregate *body = nullptr;
if (loop->getBody() != nullptr)
{
body = loop->getBody()->getAsAggregate();
}
else
{
body = new TIntermAggregate(EOpSequence);
}
auto sequence = body->getSequence();
sequence->insert(sequence->begin(), assignTrue);
sequence->insert(sequence->begin(), breakIf);
newLoop = new TIntermLoop(ELoopWhile, nullptr, trueValue, nullptr, body);
}
TIntermSequence replacement;
replacement.push_back(tempDeclaration);
replacement.push_back(newLoop);
node->replaceChildNodeWithMultiple(loop, replacement);
nextTemporaryIndex();
}
return true;
}
};
} // anonymous namespace
void RewriteDoWhile(TIntermNode *root, unsigned int *temporaryIndex)
{
ASSERT(temporaryIndex != 0);
DoWhileRewriter rewriter;
rewriter.useTemporaryIndex(temporaryIndex);
root->traverse(&rewriter);
}