source: icGREP/icgrep-devel/icgrep/pablo/optimizers/pablo_simplifier.cpp @ 4870

Last change on this file since 4870 was 4870, checked in by nmedfort, 4 years ago

Bug fix for Multiplexing. Added ability to set the body of a If/While? node after creation.

File size: 16.5 KB
Line 
1#include <pablo/optimizers/pablo_simplifier.hpp>
2#include <pablo/codegenstate.h>
3#include <pablo/expression_map.hpp>
4#include <pablo/function.h>
5#include <pablo/printer_pablos.h>
6#include <pablo/analysis/pabloverifier.hpp>
7#ifdef USE_BOOST
8#include <boost/container/flat_set.hpp>
9#else
10#include <unordered_set>
11#endif
12#include <iostream>
13
14namespace pablo {
15
16#ifdef USE_BOOST
17template <typename Type>
18using SmallSet = boost::container::flat_set<Type>;
19#else
20template <typename Type>
21using SmallSet = std::unordered_set<Type>;
22#endif
23
24/** ------------------------------------------------------------------------------------------------------------- *
25 * @brief optimize
26 ** ------------------------------------------------------------------------------------------------------------- */
27bool Simplifier::optimize(PabloFunction & function) {
28    eliminateRedundantCode(function.getEntryBlock());
29    deadCodeElimination(function.getEntryBlock());
30    eliminateRedundantEquations(function.getEntryBlock());
31    #ifndef NDEBUG
32    PabloVerifier::verify(function, "post-simplification");
33    #endif
34    return true;
35}
36
37/** ------------------------------------------------------------------------------------------------------------- *
38 * @brief canTriviallyFold
39 ** ------------------------------------------------------------------------------------------------------------- */
40inline static PabloAST * canTriviallyFold(Statement * stmt, PabloBlock * block) {
41    for (unsigned i = 0; i != stmt->getNumOperands(); ++i) {
42        if (LLVM_UNLIKELY(isa<Zeroes>(stmt->getOperand(i)))) {
43            switch (stmt->getClassTypeId()) {
44                case PabloAST::ClassTypeId::And:
45                case PabloAST::ClassTypeId::Advance:
46                    return block->createZeroes();
47                case PabloAST::ClassTypeId::Xor:
48                case PabloAST::ClassTypeId::Or:
49                    return stmt->getOperand(1 - i);
50                case PabloAST::ClassTypeId::Not:
51                    return block->createOnes();
52                case PabloAST::ClassTypeId::Sel:
53                    block->setInsertPoint(stmt->getPrevNode());
54                    switch (i) {
55                        case 0: return stmt->getOperand(2);
56                        case 1: return block->createAnd(block->createNot(stmt->getOperand(0)), stmt->getOperand(2));
57                        case 2: return block->createAnd(stmt->getOperand(0), stmt->getOperand(1));
58                    }
59                case PabloAST::ClassTypeId::ScanThru:
60                case PabloAST::ClassTypeId::MatchStar:
61                    return stmt->getOperand(0);
62                default: break;
63            }
64        } else if (LLVM_UNLIKELY(isa<Ones>(stmt->getOperand(i)))) {
65            block->setInsertPoint(stmt->getPrevNode());
66            switch (stmt->getClassTypeId()) {
67                case PabloAST::ClassTypeId::And:
68                    return stmt->getOperand(1 - i);
69                case PabloAST::ClassTypeId::Or:
70                    return block->createOnes();
71                case PabloAST::ClassTypeId::Xor:
72                    return block->createNot(stmt->getOperand(1 - i));
73                case PabloAST::ClassTypeId::Not:
74                    return block->createZeroes();
75                case PabloAST::ClassTypeId::Sel:
76                    block->setInsertPoint(stmt->getPrevNode());
77                    switch (i) {
78                        case 0: return stmt->getOperand(1);
79                        case 1: return block->createOr(stmt->getOperand(0), stmt->getOperand(2));
80                        case 2: return block->createOr(block->createNot(stmt->getOperand(0)), stmt->getOperand(1));
81                    }
82                case PabloAST::ClassTypeId::ScanThru:
83                    if (i == 1) {
84                        return block->createZeroes();
85                    }
86                    break;
87                case PabloAST::ClassTypeId::MatchStar:
88                    if (i == 0) {
89                        return block->createOnes();
90                    }
91                    break;
92                default: break;
93            }
94        }
95    }
96    return nullptr;
97}
98
99/** ------------------------------------------------------------------------------------------------------------- *
100 * @brief isSuperfluous
101 ** ------------------------------------------------------------------------------------------------------------- */
102inline bool Simplifier::isSuperfluous(const Assign * const assign) {
103    for (const PabloAST * inst : assign->users()) {
104        if (isa<Next>(inst) || isa<PabloFunction>(inst)) {
105            return false;
106        } else if (isa<If>(inst)) {
107            const If * ifNode = cast<If>(inst);
108            if (ifNode->getCondition() == assign) {
109                bool notFound = true;
110                for (Assign * defVar : ifNode->getDefined()) {
111                    if (defVar == assign) {
112                        notFound = false;
113                        break;
114                    }
115                }
116                if (notFound) {
117                    continue;
118                }
119            }
120            return false;
121        }
122    }
123    return true;
124}
125
126/** ------------------------------------------------------------------------------------------------------------- *
127 * @brief demoteDefinedVar
128 ** ------------------------------------------------------------------------------------------------------------- */
129inline bool demoteDefinedVar(const If * ifNode, const Assign * def) {
130    // If this value isn't used outside of this scope then there is no reason to allow it to escape it.
131    if (!escapes(def)) {
132        return true;
133    }
134    // Similarly if the defined variable is equivalent to the condition, an equivalent value is already available.
135    if (ifNode->getCondition() == def->getExpression()) {
136        return true;
137    }
138    // Finally, if the assignment is a constant, it's already known.
139    if (isa<Zeroes>(def->getExpression()) || isa<Ones>(def->getExpression()))  {
140        return true;
141    }
142    return false;
143}
144
145/** ------------------------------------------------------------------------------------------------------------- *
146 * @brief replaceReachableUsersOfWith
147 ** ------------------------------------------------------------------------------------------------------------- */
148inline void replaceReachableUsersOfWith(Statement * stmt, PabloAST * expr) {
149    const PabloBlock * const root = stmt->getParent();
150    SmallSet<const PabloBlock *> forbidden;
151    for (PabloAST * use : stmt->users()) {
152        if (LLVM_UNLIKELY(isa<Next>(use))) {
153            const PabloBlock * parent = cast<Next>(use)->getParent();
154            if (parent != root) {
155                forbidden.insert(parent);
156            }
157        }
158    }
159    for (PabloAST * use : stmt->users()) {
160        if (Statement * user = dyn_cast<Statement>(use)) {
161            const PabloBlock * parent = user->getParent();
162            while (parent && forbidden.count(parent) == 0) {
163                if (LLVM_UNLIKELY(parent == root)) {
164                    user->replaceUsesOfWith(stmt, expr);
165                    break;
166                }
167                parent = parent->getParent();
168            }
169        }
170    }
171}
172
173/** ------------------------------------------------------------------------------------------------------------- *
174 * @brief discardNestedIfBlock
175 *
176 * If this inner block is composed of only Boolean logic and Assign statements and there are fewer than 3
177 * statements, just add the statements in the inner block to the current block->
178 ** ------------------------------------------------------------------------------------------------------------- */
179inline bool discardNestedIfBlock(const PabloBlock * const block) {
180    unsigned computations = 0;
181    for (const Statement * stmt : *block) {
182        switch (stmt->getClassTypeId()) {
183            case PabloAST::ClassTypeId::And:
184            case PabloAST::ClassTypeId::Or:
185            case PabloAST::ClassTypeId::Xor:
186                if (++computations > 3) {
187                    return false;
188                }
189            case PabloAST::ClassTypeId::Not:
190            case PabloAST::ClassTypeId::Assign:
191                break;
192            default:
193                return false;
194        }
195    }
196    return true;
197}
198
199/** ------------------------------------------------------------------------------------------------------------- *
200 * @brief removeIdenticalEscapedValues
201 ** ------------------------------------------------------------------------------------------------------------- */
202template <class ValueList, class ValueType = typename ValueList::value_type>
203inline void removeIdenticalEscapedValues(ValueList & list) {
204    std::vector<ValueType> identicalValues;
205    for (auto i = list.begin(); i != list.end(); ++i) {
206        for (auto j = i + 1; j != list.end(); ++j) {
207            if (LLVM_UNLIKELY(equals(*i, *j))) {
208                identicalValues.push_back(*j);
209            }
210        }
211        for (ValueType identicalValue : identicalValues) {
212            identicalValue->replaceWith(*i);
213        }
214        identicalValues.clear();
215    }
216}
217
218/** ------------------------------------------------------------------------------------------------------------- *
219 * @brief eliminateRedundantCode
220 *
221 * Note: Do not recursively delete statements in this function. The ExpressionTable could use deleted statements
222 * as replacements. Let the DCE remove the unnecessary statements with the finalized Def-Use information.
223 ** ------------------------------------------------------------------------------------------------------------- */
224void Simplifier::eliminateRedundantCode(PabloBlock * const block, ExpressionTable * predecessor) {
225    ExpressionTable encountered(predecessor);
226    Statement * stmt = block->front();
227
228    while (stmt) {
229
230        if (Assign * assign = dyn_cast<Assign>(stmt)) {
231            // If we have an Assign whose users do not contain an If or Next node, we can replace its users with
232            // the Assign's expression directly.
233            if (isSuperfluous(assign)) {
234                stmt = assign->replaceWith(assign->getExpression());
235                continue;
236            }
237            // Force the uses of an Assign node that can reach the original expression to use the expression instead.
238            replaceReachableUsersOfWith(assign, assign->getExpression());
239        } else if (Next * next = dyn_cast<Next>(stmt)) {
240            replaceReachableUsersOfWith(next, next->getExpr());
241        } else if (If * ifNode = dyn_cast<If>(stmt)) {
242            // Check to see if the Cond is Zero and delete the loop.
243            if (LLVM_UNLIKELY(isa<Zeroes>(ifNode->getCondition()))) {
244                stmt = stmt->eraseFromParent();
245                continue;
246            }
247
248            // Test whether all of the defined variables are necessary
249            If::DefinedVars & defs = ifNode->getDefined();
250            for (auto def = defs.begin(); def != defs.end(); ) {
251                if (LLVM_UNLIKELY(demoteDefinedVar(ifNode, *def))) {
252                    (*def)->replaceWith((*def)->getExpression());
253                    def = ifNode->removeDefined(*def);
254                    continue;
255                }
256                ++def;
257            }
258
259            // Process the If body
260            eliminateRedundantCode(cast<If>(stmt)->getBody(), &encountered);
261
262            // If we ended up removing all of the defined variables, delete the If node.
263            if (LLVM_UNLIKELY(defs.empty())) {
264                stmt = stmt->eraseFromParent();
265                continue;
266            }
267
268            // Otherwise check if we any Assign reports the same value as another. If so, replace all uses of the
269            // second with the first. This will simplify future analysis.
270            removeIdenticalEscapedValues(ifNode->getDefined());
271
272            // Finally after we've eliminated everything we can from the If body, check whether testing the If
273            // condition will meet or exceed the cost of executing the body.
274            if (LLVM_UNLIKELY(discardNestedIfBlock(ifNode->getBody()))) {
275                Statement * nested = ifNode->getBody()->front();
276                while (nested) {
277                    Statement * next = nested->removeFromParent();
278                    if (isa<Assign>(nested)) {
279                        ifNode->removeDefined(cast<Assign>(nested));
280                    }
281                    nested->insertAfter(stmt);
282                    stmt = nested;
283                    nested = next;
284                }
285                stmt = ifNode->eraseFromParent();
286                continue;
287            }
288
289        } else if (While * whileNode = dyn_cast<While>(stmt)) {
290            const PabloAST * initial = whileNode->getCondition();
291            if (LLVM_LIKELY(isa<Next>(initial))) {
292                initial = cast<Next>(initial)->getInitial();
293            }
294            if (LLVM_UNLIKELY(isa<Zeroes>(initial))) {
295                stmt = stmt->eraseFromParent();
296                continue;
297            }
298            eliminateRedundantCode(whileNode->getBody(), &encountered);
299            removeIdenticalEscapedValues(whileNode->getVariants());
300        } else if (PabloAST * expr = canTriviallyFold(stmt, block)) {
301            stmt = stmt->replaceWith(expr, true);
302            continue;
303        } else {
304            // When we're creating the Pablo program, it's possible to have multiple instances of an "identical"
305            // statement. By recording which statements have already been seen, we can detect the redundant statements
306            // as any having the same type and operands. If so, we can replace its users with the prior statement.
307            // and erase this statement from the AST
308            const auto f = encountered.findOrAdd(stmt);
309            if (!f.second) {
310                stmt = stmt->replaceWith(f.first, true);
311                continue;
312            }
313        }
314        stmt = stmt->getNextNode();
315    }
316}
317
318/** ------------------------------------------------------------------------------------------------------------- *
319 * @brief deadCodeElimination
320 ** ------------------------------------------------------------------------------------------------------------- */
321void Simplifier::deadCodeElimination(PabloBlock * const block) {
322    Statement * stmt = block->front();
323    while (stmt) {
324        if (isa<If>(stmt)) {
325            deadCodeElimination(cast<If>(stmt)->getBody());
326        } else if (isa<While>(stmt)) {
327            deadCodeElimination(cast<While>(stmt)->getBody());
328        } else if (stmt->getNumUses() == 0){
329            stmt = stmt->eraseFromParent(true);
330            continue;
331        }
332        stmt = stmt->getNextNode();
333    }
334}
335
336/** ------------------------------------------------------------------------------------------------------------- *
337 * @brief eliminateRedundantEquations
338 ** ------------------------------------------------------------------------------------------------------------- */
339void Simplifier::eliminateRedundantEquations(PabloBlock * const block) {
340    Statement * stmt = block->front();
341    while (stmt) {
342        if (isa<If>(stmt)) {
343            eliminateRedundantEquations(cast<If>(stmt)->getBody());
344        } else if (isa<While>(stmt)) {
345            eliminateRedundantEquations(cast<While>(stmt)->getBody());
346        } else if (isa<Advance>(stmt)) {
347            Advance * adv = cast<Advance>(stmt);
348            if (LLVM_UNLIKELY(isa<Advance>(adv->getOperand(0)))) {
349                // Replace an Advance(Advance(x, n), m) with an Advance(x,n + m)
350                Advance * op = cast<Advance>(stmt->getOperand(0));
351                if (LLVM_UNLIKELY(op->getNumUses() == 1)) {
352                    adv->setOperand(0, op->getOperand(0));
353                    adv->setOperand(1, block->getInteger(adv->getAdvanceAmount() + op->getAdvanceAmount()));
354                    op->eraseFromParent(false);
355                }
356            }
357        } else if (LLVM_UNLIKELY(isa<ScanThru>(stmt))) {
358            ScanThru * scanThru = cast<ScanThru>(stmt);
359            if (LLVM_UNLIKELY(isa<Advance>(scanThru->getOperand(0)))) {
360                // Replace a ScanThru(Advance(x,n),y) with an ScanThru(Advance(x, n - 1), Advance(x, n - 1) | y), where Advance(x, 0) = x
361                Advance * op = cast<Advance>(stmt->getOperand(0));
362                if (LLVM_UNLIKELY(op->getNumUses() == 1)) {
363                    block->setInsertPoint(scanThru->getPrevNode());
364                    PabloAST * expr = block->createAdvance(op->getOperand(0), op->getAdvanceAmount() - 1);
365                    scanThru->setOperand(0, expr);
366                    scanThru->setOperand(1, block->createOr(scanThru->getOperand(1), expr));
367                    op->eraseFromParent(false);
368                }
369            }
370        }
371        stmt = stmt->getNextNode();
372    }
373    block->setInsertPoint(block->back());
374}
375
376}
Note: See TracBrowser for help on using the repository browser.