source: icGREP/icgrep-devel/icgrep/pablo/optimizers/pablo_automultiplexing.cpp @ 4659

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

Minor changes to function compilation preceeding any modification of the pablo Call class.

File size: 44.7 KB
Line 
1#include "pablo_automultiplexing.hpp"
2#include <include/simd-lib/builtins.hpp>
3#include <pablo/builder.hpp>
4#include <pablo/function.h>
5#include <pablo/printer_pablos.h>
6#include <boost/container/flat_set.hpp>
7#include <boost/numeric/ublas/matrix.hpp>
8#include <boost/circular_buffer.hpp>
9#include <boost/range/iterator_range.hpp>
10#include <llvm/ADT/BitVector.h>
11#include <cudd.h>
12#include <util.h>
13#include <stack>
14#include <queue>
15#include <unordered_set>
16
17using namespace llvm;
18using namespace boost;
19using namespace boost::container;
20using namespace boost::numeric::ublas;
21
22// #define PRINT_DEBUG_OUTPUT
23
24#if !defined(NDEBUG) && !defined(PRINT_DEBUG_OUTPUT)
25#define PRINT_DEBUG_OUTPUT
26#endif
27
28#ifdef PRINT_DEBUG_OUTPUT
29
30#include <iostream>
31
32using namespace pablo;
33typedef uint64_t timestamp_t;
34
35static inline timestamp_t read_cycle_counter() {
36#ifdef __GNUC__
37timestamp_t ts;
38#ifdef __x86_64__
39  unsigned int eax, edx;
40  asm volatile("rdtsc" : "=a" (eax), "=d" (edx));
41  ts = ((timestamp_t) eax) | (((timestamp_t) edx) << 32);
42#else
43  asm volatile("rdtsc\n" : "=A" (ts));
44#endif
45  return(ts);
46#endif
47#ifdef _MSC_VER
48  return __rdtsc();
49#endif
50}
51
52#define LOG(x) std::cerr << x << std::endl;
53#define RECORD_TIMESTAMP(Name) const timestamp_t Name = read_cycle_counter()
54#define LOG_GRAPH(Name, G) \
55    LOG(Name << " |V|=" << num_vertices(G) << ", |E|="  << num_edges(G) << \
56                " (" << (((double)num_edges(G)) / ((double)(num_vertices(G) * (num_vertices(G) - 1) / 2))) << ')')
57
58unsigned __count_advances(const PabloBlock & entry) {
59
60    std::stack<const Statement *> scope;
61    unsigned advances = 0;
62
63    // Scan through and collect all the advances, calls, scanthrus and matchstars ...
64    for (const Statement * stmt = entry.front(); ; ) {
65        while ( stmt ) {
66            if (isa<Advance>(stmt)) {
67                ++advances;
68            }
69            else if (LLVM_UNLIKELY(isa<If>(stmt) || isa<While>(stmt))) {
70                // Set the next statement to be the first statement of the inner scope and push the
71                // next statement of the current statement into the scope stack.
72                const PabloBlock & nested = isa<If>(stmt) ? cast<If>(stmt)->getBody() : cast<While>(stmt)->getBody();
73                scope.push(stmt->getNextNode());
74                stmt = nested.front();
75                assert (stmt);
76                continue;
77            }
78            stmt = stmt->getNextNode();
79        }
80        if (scope.empty()) {
81            break;
82        }
83        stmt = scope.top();
84        scope.pop();
85    }
86    return advances;
87}
88
89#define LOG_NUMBER_OF_ADVANCES(entry) LOG("|Advances|=" << __count_advances(entry))
90
91#else
92#define LOG(x)
93#define RECORD_TIMESTAMP(Name)
94#define LOG_GRAPH(Name, G)
95#define LOG_NUMBER_OF_ADVANCES(entry)
96#endif
97
98
99namespace pablo {
100
101bool AutoMultiplexing::optimize(PabloFunction & function) {
102
103    std::random_device rd;
104    const auto seed = rd();
105    RNG rng(seed);
106
107    LOG("Seed:                    " << seed);
108
109    AutoMultiplexing am;
110    RECORD_TIMESTAMP(start_initialize);
111    am.initialize(function);
112    RECORD_TIMESTAMP(end_initialize);
113
114    LOG("Initialize:              " << (end_initialize - start_initialize));
115
116    LOG_NUMBER_OF_ADVANCES(function.getEntryBlock());
117
118    RECORD_TIMESTAMP(start_characterize);
119    am.characterize(function.getEntryBlock());
120    RECORD_TIMESTAMP(end_characterize);
121
122    LOG("Characterize:            " << (end_characterize - start_characterize));
123
124    RECORD_TIMESTAMP(start_create_multiplex_graph);
125    const bool multiplex = am.generateCandidateSets(rng);
126    RECORD_TIMESTAMP(end_create_multiplex_graph);
127    LOG("GenerateMultiplexSets:   " << (end_create_multiplex_graph - start_create_multiplex_graph));
128
129    if (multiplex) {
130
131        RECORD_TIMESTAMP(start_select_multiplex_sets);
132        am.selectMultiplexSets(rng);
133        RECORD_TIMESTAMP(end_select_multiplex_sets);
134        LOG("SelectMultiplexSets:     " << (end_select_multiplex_sets - start_select_multiplex_sets));
135
136        RECORD_TIMESTAMP(start_subset_constraints);
137        am.applySubsetConstraints();
138        RECORD_TIMESTAMP(end_subset_constraints);
139        LOG("ApplySubsetConstraints:  " << (end_subset_constraints - start_subset_constraints));
140
141        RECORD_TIMESTAMP(start_select_independent_sets);
142        am.multiplexSelectedIndependentSets();
143        RECORD_TIMESTAMP(end_select_independent_sets);
144        LOG("MultiplexSelectedSets:   " << (end_select_independent_sets - start_select_independent_sets));
145
146        RECORD_TIMESTAMP(start_topological_sort);
147        am.topologicalSort(function.getEntryBlock());
148        RECORD_TIMESTAMP(end_topological_sort);
149        LOG("TopologicalSort:         " << (end_topological_sort - start_topological_sort));
150    }
151
152    RECORD_TIMESTAMP(start_shutdown);
153    am.Shutdown();
154    RECORD_TIMESTAMP(end_shutdown);
155    LOG("Shutdown:                " << (end_shutdown - start_shutdown));
156
157    LOG_NUMBER_OF_ADVANCES(function.getEntryBlock());
158
159    return multiplex;
160}
161
162/** ------------------------------------------------------------------------------------------------------------- *
163 * @brief initialize
164 * @param vars the input vars for this program
165 * @param entry the entry block
166 *
167 * Scan through the program to identify any advances and calls then initialize the BDD engine with
168 * the proper variable ordering.
169 ** ------------------------------------------------------------------------------------------------------------- */
170void AutoMultiplexing::initialize(PabloFunction & function) {
171
172    flat_map<const PabloAST *, unsigned> map;   
173    std::stack<Statement *> scope;
174    unsigned complexStatements = 0; // number of statements that cannot always be categorized without generating a new variable
175
176    // Scan through and collect all the advances, calls, scanthrus and matchstars ...
177    unsigned n = 0, m = 0;
178    for (Statement * stmt = function.getEntryBlock().front(); ; ) {
179        while ( stmt ) {
180            ++n;
181            if (LLVM_UNLIKELY(isa<If>(stmt) || isa<While>(stmt))) {
182                // Set the next statement to be the first statement of the inner scope and push the
183                // next statement of the current statement into the scope stack.
184                const PabloBlock & nested = isa<If>(stmt) ? cast<If>(stmt)->getBody() : cast<While>(stmt)->getBody();
185                scope.push(stmt->getNextNode());
186                stmt = nested.front();
187                assert (stmt);
188                continue;
189            }
190
191            assert ("Run the Simplifer pass prior to this!" && (stmt->getNumUses() > 0));
192
193            switch (stmt->getClassTypeId()) {
194                case PabloAST::ClassTypeId::Advance:
195                    mAdvanceMap.emplace(stmt, m);
196                    map.emplace(stmt, m++);
197                case PabloAST::ClassTypeId::Call:
198                case PabloAST::ClassTypeId::ScanThru:
199                case PabloAST::ClassTypeId::MatchStar:
200                    complexStatements++;
201                    break;
202                default:
203                    break;
204            }
205            stmt = stmt->getNextNode();
206        }
207        if (scope.empty()) {
208            break;
209        }
210        stmt = scope.top();
211        scope.pop();
212    }
213
214    // Create the transitive closure matrix of graph. From this we'll construct
215    // two graphs restricted to the relationships between advances. The first will
216    // be a path graph, which is used to bypass testing for mutual exclusivity of
217    // advances that cannot be multiplexed. The second is a transitive reduction
218    // of that graph, which forms the basis of our constraint graph when deciding
219    // which advances ought to be multiplexed.
220
221    matrix<bool> G(n, m); // Let G be a matrix with n rows of m (Advance) elements
222    G.clear();
223    for (unsigned i = 0; i != m; ++i) {
224        G(i, i) = true;
225    }
226
227    n = m;
228    m = 0;
229
230    const Statement * stmt = function.getEntryBlock().front();
231    for (;;) {
232        while ( stmt ) {
233
234            unsigned u;
235            if (isa<Advance>(stmt)) {
236                assert (mAdvanceMap.count(stmt) && mAdvanceMap[stmt] == m);
237                u = m++;
238            }
239            else {
240                u = n++;
241                map.emplace(stmt, u);
242            }
243
244            for (unsigned i = 0; i != stmt->getNumOperands(); ++i) {
245                const PabloAST * const op = stmt->getOperand(i);
246                if (LLVM_LIKELY(isa<Statement>(op))) {
247                    const unsigned v = map[op];
248                    for (unsigned w = 0; w != m; ++w) {
249                        G(u, w) |= G(v, w);
250                    }
251                }
252            }
253            if (LLVM_UNLIKELY(isa<If>(stmt) || isa<While>(stmt))) {
254                // Set the next statement to be the first statement of the inner scope
255                // and push the next statement of the current statement into the stack.
256                const PabloBlock & nested = isa<If>(stmt) ? cast<If>(stmt)->getBody() : cast<While>(stmt)->getBody();
257                scope.push(stmt->getNextNode());
258                stmt = nested.front();
259                assert (stmt);
260                continue;
261            }
262            stmt = stmt->getNextNode();
263        }
264        if (scope.empty()) {
265            break;
266        }
267        stmt = scope.top();
268        scope.pop();
269    }
270
271    // Record the path / base constraint graph after removing any reflexive-loops.
272    // Since G is a use-def graph and we want our constraint graph to be a def-use graph,
273    // reverse the edges as we're writing them to obtain the transposed graph.
274    mConstraintGraph = ConstraintGraph(m);
275    mSubsetGraph = SubsetGraph(m);
276
277    for (unsigned i = 0; i != m; ++i) {
278        G(i, i) = false;
279        for (unsigned j = 0; j != m; ++j) {
280            if (G(i, j)) {
281                add_edge(j, i, mConstraintGraph);
282            }
283        }       
284    }
285
286    // Initialize the BDD engine ...
287    mManager = Cudd_Init((complexStatements + function.getParameters().size()), 0, CUDD_UNIQUE_SLOTS, CUDD_CACHE_SLOTS, 0);
288    Cudd_AutodynDisable(mManager);
289
290    // Map the predefined 0/1 entries
291    mCharacterizationMap[function.getEntryBlock().createZeroes()] = Zero();
292    mCharacterizationMap[function.getEntryBlock().createOnes()] = One();
293
294    // Order the variables so the input Vars are pushed to the end; they ought to
295    // be the most complex to resolve.
296    unsigned i = complexStatements;
297    for (const Var * var : function.getParameters()) {
298        mCharacterizationMap[var] = Cudd_bddIthVar(mManager, i++);
299    }
300}
301
302/** ------------------------------------------------------------------------------------------------------------- *
303 * @brief characterize
304 * @param vars the input vars for this program
305 *
306 * Scan through the program and iteratively compute the BDDs for each statement.
307 ** ------------------------------------------------------------------------------------------------------------- */
308void AutoMultiplexing::characterize(PabloBlock &block) {
309    for (Statement * stmt : block) {
310        if (LLVM_UNLIKELY(isa<If>(stmt) || isa<While>(stmt))) {
311            const auto start = mRecentCharacterizations.size();
312            characterize(isa<If>(stmt) ? cast<If>(stmt)->getBody() : cast<While>(stmt)->getBody());
313            assert (mRecentCharacterizations.size() >= start);
314            if (isa<If>(stmt)) {
315                const auto & defined = cast<const If>(stmt)->getDefined();
316                for (auto pair = mRecentCharacterizations.begin() + start; pair != mRecentCharacterizations.end(); ++pair) {
317                    const PabloAST * expr = nullptr;
318                    DdNode * bdd = nullptr;
319                    std::tie(expr, bdd) = *pair;
320                    if (LLVM_UNLIKELY(isa<Assign>(expr))) {
321                        if (LLVM_LIKELY(std::find(defined.begin(), defined.end(), expr) != defined.end())) {
322                            continue;
323                        }
324                    }
325                    mCharacterizationMap.erase(mCharacterizationMap.find(expr));
326                    if (LLVM_UNLIKELY(Cudd_IsConstant(bdd))) {
327                        continue;
328                    }
329                    Deref(bdd);
330                }
331            }
332            else { // if isa<While>(stmt)
333                const auto & variants = cast<const While>(stmt)->getVariants();
334                for (auto pair = mRecentCharacterizations.begin() + start; pair != mRecentCharacterizations.end(); ++pair) {
335                    const PabloAST * expr = nullptr;
336                    DdNode * bdd = nullptr;
337                    std::tie(expr, bdd) = *pair;
338                    if (LLVM_UNLIKELY(isa<Next>(expr))) {
339                        if (LLVM_LIKELY(std::find(variants.begin(), variants.end(), expr) != variants.end())) {
340                            DdNode *& next = mCharacterizationMap[expr];
341                            next = Or(next, bdd);
342                            Ref(next);
343                            continue;
344                        }
345                    }
346                    mCharacterizationMap.erase(mCharacterizationMap.find(expr));
347                    if (LLVM_UNLIKELY(Cudd_IsConstant(bdd))) {
348                        continue;
349                    }
350                    Deref(bdd);
351                }
352            }
353
354            assert (Cudd_DebugCheck(mManager) == 0);
355
356            mRecentCharacterizations.erase(mRecentCharacterizations.begin() + start, mRecentCharacterizations.end());
357            continue;
358        }
359
360        DdNode * var = characterize(stmt);
361        mCharacterizationMap[stmt] = var;
362        assert (Cudd_DebugCheck(mManager) == 0);
363    }
364}
365
366/** ------------------------------------------------------------------------------------------------------------- *
367 * @brief characterize
368 ** ------------------------------------------------------------------------------------------------------------- */
369inline DdNode * AutoMultiplexing::characterize(Statement * const stmt) {
370
371    DdNode * bdd = nullptr;
372    // Map our operands to the computed BDDs
373    std::array<DdNode *, 3> input;
374    unsigned count = 0;
375    for (; count != stmt->getNumOperands(); ++count) {
376        PabloAST * const op = stmt->getOperand(count);
377        if (LLVM_UNLIKELY(isa<Integer>(op) || isa<String>(op))) {
378            continue;
379        }
380        auto f = mCharacterizationMap.find(op);
381        if (LLVM_UNLIKELY(f == mCharacterizationMap.end())) {
382            std::string tmp;
383            llvm::raw_string_ostream msg(tmp);
384            msg << "Uncharacterized operand " << std::to_string(count);
385            PabloPrinter::print(stmt, " of ", msg);
386            throw std::runtime_error(msg.str());
387        }
388        input[count] = f->second;
389    }
390
391    switch (stmt->getClassTypeId()) {
392        case PabloAST::ClassTypeId::Assign:
393        case PabloAST::ClassTypeId::Next:
394            bdd = input[0];
395            break;
396        case PabloAST::ClassTypeId::And:
397            bdd = And(input[0], input[1]);
398            break;       
399        case PabloAST::ClassTypeId::Or:
400            bdd = Or(input[0], input[1]);
401            break;
402        case PabloAST::ClassTypeId::Xor:
403            bdd = Xor(input[0], input[1]);
404            break;
405        case PabloAST::ClassTypeId::Not:
406            bdd = Not(input[0]);
407            break;
408        case PabloAST::ClassTypeId::Sel:
409            bdd = Ite(input[0], input[1], input[2]);
410            break;
411        case PabloAST::ClassTypeId::ScanThru:
412            // It may be possible use "Not(input[1])" for ScanThrus if we rule out the possibility
413            // of a contradition being erroneously calculated later. An example of this
414            // would be ¬(ScanThru(c,m) √ m)
415        case PabloAST::ClassTypeId::MatchStar:
416            if (LLVM_UNLIKELY(isZero(input[0]) || isZero(input[1]))) {
417                return Zero();
418            }
419        case PabloAST::ClassTypeId::Call:
420            bdd = NewVar();
421            mRecentCharacterizations.emplace_back(stmt, bdd);
422            return bdd;
423        case PabloAST::ClassTypeId::Advance:
424            // This returns so that it doesn't mistakeningly replace the Advance with 0 or add it
425            // to the list of recent characterizations.
426            return characterize(cast<Advance>(stmt), input[0]);
427        default:
428            throw std::runtime_error("Unexpected statement type " + stmt->getName()->to_string());
429    }
430
431    Ref(bdd);
432
433    if (LLVM_UNLIKELY(NoSatisfyingAssignment(bdd))) {
434        Deref(bdd);
435        // If there is no satisfing assignment for this bdd, the statement will always produce
436        // 0. If this is an Assign or Next node, replace the value with 0. Otherwise replace
437        // the statement with 0.
438        if (LLVM_UNLIKELY(isa<Assign>(stmt) || isa<Next>(stmt))) {
439            stmt->setOperand(0, stmt->getParent()->createZeroes());
440        }
441        else {
442            stmt->replaceWith(stmt->getParent()->createZeroes());
443        }
444        bdd = Zero();
445    }
446
447    mRecentCharacterizations.emplace_back(stmt, bdd);
448    return bdd;
449}
450
451/** ------------------------------------------------------------------------------------------------------------- *
452 * @brief characterize
453 ** ------------------------------------------------------------------------------------------------------------- */
454inline DdNode * AutoMultiplexing::characterize(Advance *adv, DdNode * input) {
455    DdNode * Ik, * Ck, * Nk;
456    if (LLVM_UNLIKELY(isZero(input))) {
457        Ik = Ck = Nk = Zero();
458    }
459    else {
460
461        Ik = input;
462        Ref(input);
463        Ck = NewVar();
464        Nk = Not(Ck);
465
466        assert (mAdvanceMap.count(adv));
467
468        const auto k = mAdvanceMap[adv];
469
470        std::vector<bool> unconstrained(k , false);
471
472        // Can we use a transposed copy of the subset graph to determine an ordering of variables?
473        for (unsigned i = 0; i != k; ++i) {
474            // Have we already proven that these are unconstrained by the subset relationships?
475            if (unconstrained[i]) continue;
476            Advance * tmp = std::get<0>(mAdvance[i]);
477            // If these advances are "shifting" their values by the same amount and aren't transitively dependant ...
478            if ((adv->getOperand(1) == tmp->getOperand(1)) && (notTransitivelyDependant(i, k))) {
479                DdNode * Ii = std::get<1>(mAdvance[i]);
480                DdNode * const IiIk = And(Ik, Ii);
481                Ref(IiIk);
482                // Is there any satisfying truth assignment? If not, these streams are mutually exclusive.
483                if (NoSatisfyingAssignment(IiIk)) {
484                    assert (mCharacterizationMap.count(tmp));
485                    DdNode *& Ci = mCharacterizationMap[tmp];
486                    // Mark the i-th and k-th Advances as being mutually exclusive
487                    DdNode * Ni = std::get<2>(mAdvance[i]);
488                    Ck = And(Ck, Ni); Ref(Ck);
489                    Ci = And(Ci, Nk); Ref(Ci);
490                    // If Ai ∩ Ak = ∅ and Aj ⊂ Ai, Aj ∩ Ak = ∅.
491                    graph_traits<SubsetGraph>::in_edge_iterator ei, ei_end;
492                    for (std::tie(ei, ei_end) = in_edges(i, mSubsetGraph); ei != ei_end; ++ei) {
493                        const auto j = source(*ei, mSubsetGraph);
494                        if (notTransitivelyDependant(k, j)) {
495                            Advance * adv = std::get<0>(mAdvance[j]);
496                            assert (mCharacterizationMap.count(adv));
497                            DdNode *& Cj = mCharacterizationMap[adv];
498                            DdNode * Nj = std::get<2>(mAdvance[j]);
499                            // Mark the i-th and j-th Advances as being mutually exclusive
500                            Ck = And(Ck, Nj); Ref(Ck);
501                            Cj = And(Cj, Nk); Ref(Cj);
502                            unconstrained[j] = true;
503                        }
504                    }
505                    unconstrained[i] = true;
506                }
507                else if (Ik == IiIk) {
508                    // If Ik = Ii ∩ Ik then Ik ⊂ Ii. Record this in the subset graph with the arc (k,i).
509                    // These edges will be moved into the multiplex set graph if Ai and Ak happen to be
510                    // in the same mutually exclusive set.
511                    add_edge(k, i, mSubsetGraph);
512                    // If Ak ⊂ Ai and Ai ⊂ Aj, Ak ⊂ Aj.
513                    graph_traits<SubsetGraph>::out_edge_iterator ei, ei_end;
514                    for (std::tie(ei, ei_end) = out_edges(i, mSubsetGraph); ei != ei_end; ++ei) {
515                        const auto j = target(*ei, mSubsetGraph);
516                        add_edge(k, j, mSubsetGraph);
517                        unconstrained[j] = true;
518                    }
519                    unconstrained[i] = true;
520                }
521                else if (Ii == IiIk) {
522                    // If Ii = Ii ∩ Ik then Ii ⊂ Ik. Record this in the subset graph with the arc (i,k).
523                    add_edge(i, k, mSubsetGraph);
524                    // If Ai ⊂ Ak and Aj ⊂ Ai, Aj ⊂ Ak.
525                    graph_traits<SubsetGraph>::in_edge_iterator ei, ei_end;
526                    for (std::tie(ei, ei_end) = in_edges(i, mSubsetGraph); ei != ei_end; ++ei) {
527                        const auto j = source(*ei, mSubsetGraph);
528                        add_edge(j, k, mSubsetGraph);
529                        unconstrained[j] = true;
530                    }
531                    unconstrained[i] = true;
532                }
533                Deref(IiIk);
534            }
535        }
536
537        for (unsigned i = 0; i != k; ++i) {
538            const Advance * const tmp = std::get<0>(mAdvance[i]);
539            // Even if these Advances are mutually exclusive, they must be in the same scope or they cannot be safely multiplexed.
540            if (!unconstrained[i] || (adv->getParent() != tmp->getParent())) {
541                // We want the constraint graph to be acyclic; since the dependencies are already in topological order,
542                // adding an arc from a lesser to greater numbered vertex won't induce a cycle.
543                add_edge(i, k, mConstraintGraph);
544            }
545        }
546    }
547
548    mAdvance.emplace_back(adv, Ik, Nk);
549    return Ck;
550}
551
552/** ------------------------------------------------------------------------------------------------------------- *
553 * @brief notTransitivelyDependant
554 ** ------------------------------------------------------------------------------------------------------------- */
555inline bool AutoMultiplexing::notTransitivelyDependant(const ConstraintVertex i, const ConstraintVertex j) const {
556    assert (i < num_vertices(mConstraintGraph) && j < num_vertices(mConstraintGraph));
557    return (mConstraintGraph.get_edge(i, j) == 0);
558}
559
560/** ------------------------------------------------------------------------------------------------------------- *
561 * @brief CUDD wrappers
562 ** ------------------------------------------------------------------------------------------------------------- */
563
564inline DdNode * AutoMultiplexing::Zero() const {
565    return Cudd_ReadLogicZero(mManager);
566}
567
568inline DdNode * AutoMultiplexing::One() const {
569    return Cudd_ReadOne(mManager);
570}
571
572inline DdNode * AutoMultiplexing::NewVar() {
573    DdNode * var = Cudd_bddIthVar(mManager, mVariables++);
574    return var;
575}
576
577inline bool AutoMultiplexing::isZero(DdNode * const x) const {
578    return x == Zero();
579}
580
581inline DdNode * AutoMultiplexing::And(DdNode * const x, DdNode * const y) {
582    return Cudd_bddAnd(mManager, x, y);
583}
584
585inline DdNode * AutoMultiplexing::Or(DdNode * const x, DdNode * const y) {
586    return Cudd_bddOr(mManager, x, y);
587}
588
589inline DdNode * AutoMultiplexing::Xor(DdNode * const x, DdNode * const y) {
590    return Cudd_bddXor(mManager, x, y);
591}
592
593inline DdNode * AutoMultiplexing::Not(DdNode * const x) const {
594    return Cudd_Not(x);
595}
596
597inline DdNode * AutoMultiplexing::Ite(DdNode * const x, DdNode * const y, DdNode * const z) {
598    return Cudd_bddIte(mManager, x, y, z);
599}
600
601inline bool AutoMultiplexing::NoSatisfyingAssignment(DdNode * const x) {
602    return Cudd_bddLeq(mManager, x, Zero());
603}
604
605inline void AutoMultiplexing::Ref(DdNode * const x) {
606    assert (x);
607    Cudd_Ref(x);
608}
609
610inline void AutoMultiplexing::Deref(DdNode * const x) {
611    assert (x);
612    Cudd_RecursiveDeref(mManager, x);
613}
614
615inline void AutoMultiplexing::Shutdown() {
616//    #ifdef PRINT_DEBUG_OUTPUT
617//    Cudd_PrintInfo(mManager, stderr);
618//    #endif
619    Cudd_Quit(mManager);
620}
621
622/** ------------------------------------------------------------------------------------------------------------- *
623 * @brief generateMultiplexSets
624 * @param RNG random number generator
625 ** ------------------------------------------------------------------------------------------------------------- */
626bool AutoMultiplexing::generateCandidateSets(RNG & rng) {
627
628    using degree_t = graph_traits<ConstraintGraph>::degree_size_type;
629
630    // What if we generated a "constraint free" graph instead? By taking each connected component of it
631    // and computing the complement of it (with the same lesser to greater index ordering), we should
632    // have the same problem here but decomposed into subgraphs.
633
634    VertexVector S;
635    std::vector<degree_t> D(num_vertices(mConstraintGraph));
636    S.reserve(15);
637
638    mMultiplexSetGraph = MultiplexSetGraph(num_vertices(mConstraintGraph));
639
640    // Push all source nodes into the new independent set N
641    for (auto v : make_iterator_range(vertices(mConstraintGraph))) {
642        const auto d = in_degree(v, mConstraintGraph);
643        D[v] = d;
644        if (d == 0) {
645            S.push_back(v);
646        }
647    }
648
649    auto remainingVerticies = num_vertices(mConstraintGraph) - S.size();
650
651    do {
652
653        addCandidateSet(S);
654
655        bool noNewElements = true;
656        do {
657            // Randomly choose a vertex in S and discard it.
658            const auto i = S.begin() + IntDistribution(0, S.size() - 1)(rng);
659            const ConstraintVertex u = *i;
660            S.erase(i);
661            --remainingVerticies;
662
663            for (auto e : make_iterator_range(out_edges(u, mConstraintGraph))) {
664                const ConstraintVertex v = target(e, mConstraintGraph);
665                if ((--D[v]) == 0) {
666                    S.push_back(v);
667                    noNewElements = false;
668                }
669            }
670        }
671        while (noNewElements && remainingVerticies);
672    }
673    while (remainingVerticies);
674
675    return num_vertices(mMultiplexSetGraph) > num_vertices(mConstraintGraph);
676}
677
678/** ------------------------------------------------------------------------------------------------------------- *
679 * @brief addCandidateSet
680 * @param S an independent set
681 * @param T the trie in which to encode this new set into
682 * @param roots the roots (source nodes) for each tree in T
683 ** ------------------------------------------------------------------------------------------------------------- */
684inline void AutoMultiplexing::addCandidateSet(const VertexVector & S) {
685    if (S.size() >= 3) {
686        const auto u = add_vertex(mMultiplexSetGraph);
687        for (const auto v : S) {
688            add_edge(u, v, mMultiplexSetGraph);
689        }
690    }
691}
692
693/** ------------------------------------------------------------------------------------------------------------- *
694 * @brief is_power_of_2
695 * @param n an integer
696 ** ------------------------------------------------------------------------------------------------------------- */
697static inline bool is_power_of_2(const size_t n) {
698    return ((n & (n - 1)) == 0) ;
699}
700
701/** ------------------------------------------------------------------------------------------------------------- *
702 * @brief log2_plus_one
703 ** ------------------------------------------------------------------------------------------------------------- */
704static inline size_t log2_plus_one(const size_t n) {
705    return std::log2<size_t>(n) + 1; // use a faster builtin function for this?
706}
707
708/** ------------------------------------------------------------------------------------------------------------- *
709 * @brief selectMultiplexSets
710 * @param RNG random number generator
711 *
712 * This algorithm is simply computes a greedy set cover. We want an exact max-weight set cover but can generate new
713 * sets by taking a subset of any existing set. With a few modifications, the greedy approach seems to work well
714 * enough but can be trivially shown to produce a suboptimal solution if there are three (or more) sets in which
715 * two, labelled A and B, are disjoint and the third larger set, C, that consists of elements of A and B.
716 ** ------------------------------------------------------------------------------------------------------------- */
717void AutoMultiplexing::selectMultiplexSets(RNG &) {
718
719
720    using OutEdgeIterator = graph_traits<MultiplexSetGraph>::out_edge_iterator;
721    using InEdgeIterator = graph_traits<MultiplexSetGraph>::in_edge_iterator;
722    using degree_t = MultiplexSetGraph::degree_size_type;
723    using vertex_t = MultiplexSetGraph::vertex_descriptor;
724
725    const size_t m = num_vertices(mConstraintGraph);
726    const size_t n = num_vertices(mMultiplexSetGraph) - m;
727
728    std::vector<degree_t> remaining(n, 0);
729    std::vector<vertex_t> chosen_set(m, 0);
730
731    for (unsigned i = 0; i != n; ++i) {
732        remaining[i] = out_degree(i + m, mMultiplexSetGraph);
733    }
734
735    for (;;) {
736
737        // Choose the set with the greatest number of vertices not already included in some other set.
738        vertex_t k = 0;
739        degree_t w = 0;
740        for (vertex_t i = 0; i != n; ++i) {
741            const degree_t r = remaining[i];
742            if (w < r) {
743                k = i;
744                w = r;
745            }
746        }
747
748        // Multiplexing requires at least 3 elements; if the best set contains fewer than 3, abort.
749        if (w < 3) {
750            break;
751        }
752
753        OutEdgeIterator ei, ei_end;
754        for (std::tie(ei, ei_end) = out_edges(k + m, mMultiplexSetGraph); ei != ei_end; ++ei) {
755            const vertex_t j = target(*ei, mMultiplexSetGraph);
756            if (chosen_set[j] == 0) {
757                chosen_set[j] = (k + m);
758                InEdgeIterator ej, ej_end;
759                for (std::tie(ej, ej_end) = in_edges(j, mMultiplexSetGraph); ej != ej_end; ++ej) {
760                    remaining[source(*ej, mMultiplexSetGraph) - m]--;
761                }
762            }
763        }
764
765        assert (remaining[k] == 0);
766
767        // If this contains 2^n elements for any n, discard the member that is most likely to be added
768        // to some future set.
769        if (is_power_of_2(w)) {
770            vertex_t j = 0;
771            degree_t w = 0;
772            for (vertex_t i = 0; i != m; ++i) {
773                if (chosen_set[i] == (k + m)) {
774                    InEdgeIterator ej, ej_end;
775                    degree_t r = 1;
776                    for (std::tie(ej, ej_end) = in_edges(i, mMultiplexSetGraph); ej != ej_end; ++ej) {
777                        // strongly prefer adding weight to unvisited sets that have more remaining vertices
778                        r += std::pow(remaining[source(*ej, mMultiplexSetGraph) - m], 2);
779                    }
780                    if (w < r) {
781                        j = i;
782                        w = r;
783                    }
784                }
785            }
786            assert (w > 0);
787            chosen_set[j] = 0;
788            InEdgeIterator ej, ej_end;
789            for (std::tie(ej, ej_end) = in_edges(j, mMultiplexSetGraph); ej != ej_end; ++ej) {
790                remaining[source(*ej, mMultiplexSetGraph) - m]++;
791            }
792        }
793    }
794
795    for (unsigned i = 0; i != m; ++i) {
796        InEdgeIterator ei, ei_end;
797        std::tie(ei, ei_end) = in_edges(i, mMultiplexSetGraph);
798        for (auto next = ei; ei != ei_end; ei = next) {
799            ++next;
800            if (source(*ei, mMultiplexSetGraph) != chosen_set[i]) {
801                remove_edge(*ei, mMultiplexSetGraph);
802            }
803        }
804    }
805
806    #ifndef NDEBUG
807    for (unsigned i = 0; i != m; ++i) {
808        assert (in_degree(i, mMultiplexSetGraph) <= 1);
809    }
810    for (unsigned i = m; i != (m + n); ++i) {
811        assert (out_degree(i, mMultiplexSetGraph) == 0 || out_degree(i, mMultiplexSetGraph) >= 3);
812    }
813    #endif
814}
815
816/** ------------------------------------------------------------------------------------------------------------- *
817 * @brief applySubsetConstraints
818 ** ------------------------------------------------------------------------------------------------------------- */
819void AutoMultiplexing::applySubsetConstraints() {
820
821    // When entering thus function, the multiplex set graph M is a bipartite DAG with edges denoting the set
822    // relationships of our independent sets.
823    const unsigned m = num_vertices(mConstraintGraph);
824    const unsigned n = num_vertices(mMultiplexSetGraph);
825
826    // Add in any edges from our subset constraints to M that are within the same set.
827    bool hasSubsetConstraint = false;
828
829    graph_traits<SubsetGraph>::edge_iterator ei, ei_end;
830    for (std::tie(ei, ei_end) = edges(mSubsetGraph); ei != ei_end; ++ei) {
831        const auto u = source(*ei, mSubsetGraph);
832        const auto v = target(*ei, mSubsetGraph);
833        graph_traits<MultiplexSetGraph>::in_edge_iterator ej, ej_end;
834        // If both the source and target of ei are adjacent to the same vertex, that vertex must be the
835        // "set vertex". Add the edge between the vertices.
836        for (std::tie(ej, ej_end) = in_edges(u, mMultiplexSetGraph); ej != ej_end; ++ej) {
837            auto w = target(*ej, mMultiplexSetGraph);
838            // Only check (v, w) if w is a "set vertex".
839            if (w >= (n - m) && edge(v, w, mMultiplexSetGraph).second) {
840                add_edge(u, v, mMultiplexSetGraph);
841                hasSubsetConstraint = true;
842            }
843        }
844    }
845
846    if (LLVM_UNLIKELY(hasSubsetConstraint)) {
847        // At this point, M is still a DAG but no longer bipartite. We're going to scan through the set vertices
848        // in M, and use a DFS to scan through M and eliminate any subset relationships in the AST.
849        // That way, "multiplexSelectedIndependentSets" only needs to consider muxing and demuxing of the streams.
850
851        std::vector<MultiplexSetGraph::vertex_descriptor> V;
852        std::stack<MultiplexSetGraph::vertex_descriptor> S;
853        std::queue<PabloAST *> Q;
854        BitVector D(n - m, 0);
855
856        for (auto i = m; i != n; ++i) {
857            graph_traits<MultiplexSetGraph>::out_edge_iterator ei, ei_end;
858            // For each member of a "set vertex" ...
859            std::tie(ei, ei_end) = out_edges(i, mMultiplexSetGraph);
860            for (; ei != ei_end; ++ei) {
861                const auto s = source(*ei, mMultiplexSetGraph);
862                if (out_degree(s, mMultiplexSetGraph) != 0) {
863                    // First scan through the subgraph of vertices in M dominated by s and build up the set T,
864                    // consisting of all sinks w.r.t. vertex s.
865                    auto u = s;
866                    for (;;) {
867                        graph_traits<MultiplexSetGraph>::out_edge_iterator ej, ej_end;
868                        for (std::tie(ej, ej_end) = out_edges(u, mMultiplexSetGraph); ej != ej_end; ++ej) {
869                            auto v = target(*ej, mMultiplexSetGraph);
870                            if (D.test(v)) {
871                                continue;
872                            }
873                            D.set(v);
874                            if (out_degree(v, mMultiplexSetGraph) == 0) {
875                                V.push_back(v);
876                            }
877                            else {
878                                S.push(v);
879                            }
880                        }
881                        if (S.empty()) {
882                            break;
883                        }
884                        u = S.top();
885                        S.pop();
886                    }
887                    D.clear();
888                    // Now in order for these advances to be mutually exclusive, the input to A_s must be masked
889                    // with the complement of each advance indicated by V.
890
891                    Advance * adv = std::get<0>(mAdvance[s]);
892                    PabloBlock * pb = adv->getParent();
893
894                    for (auto i : V) {
895                        Q.push(std::get<0>(mAdvance[i])->getOperand(0));
896                    }                   
897                    pb->setInsertPoint(adv);
898                    while (Q.size() > 1) {
899                        PabloAST * a1 = Q.front(); Q.pop();
900                        PabloAST * a2 = Q.front(); Q.pop();                       
901                        Q.push(pb->createOr(a1, a2, "subset"));
902                    }
903                    assert (Q.size() == 1);
904
905                    PabloAST * const mask = pb->createNot(Q.front()); Q.pop();
906                    adv->setOperand(0, pb->createAnd(adv->getOperand(0), mask, "subset"));
907
908                    // Similar to the above, we're going to OR together the result of each advance,
909                    // including s. This will restore the advanced variable back to its original state.
910
911                    // Gather the original users to this advance. We'll be manipulating it shortly.
912                    std::vector<PabloAST *> U(adv->users().begin(), adv->users().end());
913
914                    // Add s to V and sort the list; it'll be closer to being in topological order.
915                    V.push_back(s);
916                    std::sort(V.begin(), V.end());
917                    for (auto i : V) {
918                        Q.push(std::get<0>(mAdvance[i]));
919                    }
920                    pb->setInsertPoint(adv);
921                    while (Q.size() > 1) {
922                        PabloAST * a1 = Q.front(); Q.pop();
923                        PabloAST * a2 = Q.front(); Q.pop();                       
924                        Q.push(pb->createOr(a1, a2, "subset"));
925                    }
926                    assert (Q.size() == 1);
927
928                    PabloAST * const input = Q.front(); Q.pop();
929                    for (PabloAST * use : U) {
930                        if (LLVM_LIKELY(isa<Statement>(use))) {
931                            cast<Statement>(use)->replaceUsesOfWith(adv, input);
932                        }
933                    }
934
935                    pb->setInsertPoint(pb->back());
936
937                    V.clear();
938
939                }
940            }
941        }
942    }
943}
944
945/** ------------------------------------------------------------------------------------------------------------- *
946 * @brief multiplexSelectedIndependentSets
947 ** ------------------------------------------------------------------------------------------------------------- */
948void AutoMultiplexing::multiplexSelectedIndependentSets() const {
949
950    const unsigned f = num_vertices(mConstraintGraph);
951    const unsigned l = num_vertices(mMultiplexSetGraph);
952
953    // Preallocate the structures based on the size of the largest multiplex set
954    size_t max_n = 3;
955    for (unsigned s = f; s != l; ++s) {
956        max_n = std::max<unsigned>(max_n, out_degree(s, mMultiplexSetGraph));
957    }
958    const size_t max_m = log2_plus_one(max_n);
959
960    std::vector<MultiplexSetGraph::vertex_descriptor> I(max_n);
961    std::vector<Advance *> input(max_n);
962    std::vector<PabloAST *> muxed(max_m);
963    circular_buffer<PabloAST *> Q(max_n);
964
965    // When entering thus function, the multiplex set graph M is a DAG with edges denoting the set
966    // relationships of our independent sets.
967
968    for (unsigned s = f; s != l; ++s) {
969        const size_t n = out_degree(s, mMultiplexSetGraph);
970        if (n) {
971
972            const size_t m = log2_plus_one(n);
973
974            graph_traits<MultiplexSetGraph>::out_edge_iterator ei, ei_end;
975            std::tie(ei, ei_end) = out_edges(s, mMultiplexSetGraph);
976            for (unsigned i = 0; i != n; ++ei, ++i) {
977                I[i] = target(*ei, mMultiplexSetGraph);
978            }
979            std::sort(I.begin(), I.begin() + n);
980
981            for (unsigned i = 0; i != n; ++i) {
982                input[i] = std::get<0>(mAdvance[I[i]]);
983            }
984
985            PabloBlock * const block = input[0]->getParent();
986            block->setInsertPoint(block->back());
987            PabloBuilder builder(*block);
988            Advance * const adv = input[0];
989
990            /// Perform n-to-m Multiplexing
991            for (size_t j = 0; j != m; ++j) {
992
993                std::ostringstream prefix;
994                prefix << "mux" << n << "to" << m << '_';
995                for (size_t i = 1; i <= n; ++i) {
996                    if ((i & (static_cast<size_t>(1) << j)) != 0) {
997                        Q.push_back(input[i - 1]->getOperand(0));
998                    }
999                }
1000
1001                while (Q.size() > 1) {
1002                    PabloAST * a1 = Q.front(); Q.pop_front(); assert (a1);
1003                    PabloAST * a2 = Q.front(); Q.pop_front(); assert (a2);
1004                    assert (!Q.full());                                       
1005                    Q.push_back(builder.createOr(a2, a1, "muxing"));
1006                }
1007
1008                PabloAST * mux = Q.front(); Q.pop_front(); assert (mux);
1009                muxed[j] = builder.createAdvance(mux, adv->getOperand(1), prefix.str());
1010            }
1011
1012            /// Perform m-to-n Demultiplexing
1013            // Now construct the demuxed values and replaces all the users of the original advances with them.
1014            for (size_t i = 1; i <= n; ++i) {
1015
1016                for (size_t j = 0; j != m; ++j) {
1017                    if ((i & (static_cast<size_t>(1) << j)) == 0) {
1018                        Q.push_back(muxed[j]);
1019                    }
1020                }
1021
1022                if (LLVM_LIKELY(Q.size() > 0)) {
1023                    while (Q.size() > 1) {
1024                        PabloAST * a1 = Q.front(); Q.pop_front(); assert (a1);
1025                        PabloAST * a2 = Q.front(); Q.pop_front(); assert (a2);
1026                        assert (!Q.full());
1027                        Q.push_back(builder.createOr(a2, a1, "demuxing"));
1028                    }
1029                    assert (Q.size() == 1);
1030                    PabloAST * neg = Q.front(); Q.pop_front();
1031                    Q.push_back(builder.createNot(neg, "demuxing")); assert (neg);
1032                }
1033
1034                for (unsigned j = 0; j != m; ++j) {
1035                    if ((i & (static_cast<unsigned>(1) << j)) != 0) {
1036                        assert (!Q.full());
1037                        Q.push_back(muxed[j]);
1038                    }
1039                }
1040
1041                while (Q.size() > 1) {
1042                    PabloAST * a1 = Q.front(); Q.pop_front(); assert (a1);
1043                    PabloAST * a2 = Q.front(); Q.pop_front(); assert (a2);
1044                    assert (!Q.full());
1045                    Q.push_back(builder.createAnd(a1, a2, "demuxing"));
1046                }
1047
1048                PabloAST * demuxed = Q.front(); Q.pop_front(); assert (demuxed);
1049                input[i - 1]->replaceWith(demuxed, true, true);
1050            }
1051        }
1052    }
1053}
1054
1055/** ------------------------------------------------------------------------------------------------------------- *
1056 * @brief topologicalSort
1057 *
1058 * After transforming the IR, we need to run this in order to always have a valid program. Each multiplex set
1059 * contains vertices corresponding to an Advance in the IR. While we know each Advance within a set is independent
1060 * w.r.t. the transitive closure of their dependencies in the IR, the position of each Advance's dependencies and
1061 * users within the IR isn't taken into consideration. Thus while there must be a valid ordering for the program,
1062 * it's not necessarily the original ordering.
1063 ** ------------------------------------------------------------------------------------------------------------- */
1064void AutoMultiplexing::topologicalSort(PabloBlock & entry) const {
1065    // Note: not a real topological sort. I expect the original graph to be close to the resulting one. Thus cost
1066    // of constructing a graph in which to perform the sort takes longer than potentially moving an instruction
1067    // multiple times.
1068    std::unordered_set<const PabloAST *> encountered;
1069    std::stack<Statement *> scope;
1070    for (Statement * stmt = entry.front(); ; ) { restart:
1071        while ( stmt ) {
1072            for (unsigned i = 0; i != stmt->getNumOperands(); ++i) {
1073                PabloAST * const op = stmt->getOperand(i);
1074                if (LLVM_LIKELY(isa<Statement>(op))) {
1075                    if (LLVM_UNLIKELY(encountered.count(op) == 0)) {
1076                        if (LLVM_UNLIKELY(isa<While>(stmt) && isa<Next>(op))) {
1077                            if (encountered.count(cast<Next>(op)->getInitial()) != 0) {
1078                                continue;
1079                            }
1080                        }
1081                        Statement * const next = stmt->getNextNode();
1082                        stmt->insertAfter(cast<Statement>(op));
1083                        stmt = next;
1084                        goto restart;
1085                    }
1086                }
1087            }
1088            if (LLVM_UNLIKELY(isa<If>(stmt) || isa<While>(stmt))) {
1089                // Set the next statement to be the first statement of the inner scope and push the
1090                // next statement of the current statement into the scope stack.
1091                const PabloBlock & nested = isa<If>(stmt) ? cast<If>(stmt)->getBody() : cast<While>(stmt)->getBody();
1092                scope.push(stmt->getNextNode());
1093                stmt = nested.front();
1094                continue;
1095            }
1096            encountered.insert(stmt);
1097            stmt = stmt->getNextNode();
1098        }
1099        if (scope.empty()) {
1100            break;
1101        }
1102        stmt = scope.top();
1103        scope.pop();
1104    }
1105}
1106
1107} // end of namespace pablo
1108
Note: See TracBrowser for help on using the repository browser.