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

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

Progress on multi-target UCD compilation

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