utils/TableGen/DAGISelMatcherOpt.cpp

   1 //===- DAGISelMatcherOpt.cpp - Optimize a DAG Matcher ---------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the DAG Matcher optimizer.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "isel-opt"
  15 #include "DAGISelMatcher.h"
  16 #include "llvm/ADT/DenseMap.h"
  17 #include "llvm/Support/Debug.h"
  18 #include "llvm/Support/raw_ostream.h"
  19 #include <vector>
  20 using namespace llvm;
  21
  22 /// ContractNodes - Turn multiple matcher node patterns like 'MoveChild+Record'
  23 /// into single compound nodes like RecordChild.
  24 static void ContractNodes(OwningPtr<Matcher> &MatcherPtr) {
  25   // If we reached the end of the chain, we're done.
  26   Matcher *N = MatcherPtr.get();
  27   if (N == 0) return;
  28
  29   // If we have a scope node, walk down all of the children.
  30   if (ScopeMatcher *Scope = dyn_cast<ScopeMatcher>(N)) {
  31     for (unsigned i = 0, e = Scope->getNumChildren(); i != e; ++i) {
  32       OwningPtr<Matcher> Child(Scope->takeChild(i));
  33       ContractNodes(Child);
  34       Scope->resetChild(i, Child.take());
  35     }
  36     return;
  37   }
  38
  39   // If we found a movechild node with a node that comes in a 'foochild' form,
  40   // transform it.
  41   if (MoveChildMatcher *MC = dyn_cast<MoveChildMatcher>(N)) {
  42     Matcher *New = 0;
  43     if (RecordMatcher *RM = dyn_cast<RecordMatcher>(MC->getNext()))
  44       New = new RecordChildMatcher(MC->getChildNo(), RM->getWhatFor());
  45
  46     if (CheckTypeMatcher *CT= dyn_cast<CheckTypeMatcher>(MC->getNext()))
  47       New = new CheckChildTypeMatcher(MC->getChildNo(), CT->getType());
  48
  49     if (New) {
  50       // Insert the new node.
  51       New->setNext(MatcherPtr.take());
  52       MatcherPtr.reset(New);
  53       // Remove the old one.
  54       MC->setNext(MC->getNext()->takeNext());
  55       return ContractNodes(MatcherPtr);
  56     }
  57   }
  58
  59   // Zap movechild -> moveparent.
  60   if (MoveChildMatcher *MC = dyn_cast<MoveChildMatcher>(N))
  61     if (MoveParentMatcher *MP =
  62           dyn_cast<MoveParentMatcher>(MC->getNext())) {
  63       MatcherPtr.reset(MP->takeNext());
  64       return ContractNodes(MatcherPtr);
  65     }
  66
  67   // Turn EmitNode->CompleteMatch into SelectNodeTo if we can.
  68   if (EmitNodeMatcher *EN = dyn_cast<EmitNodeMatcher>(N))
  69     if (CompleteMatchMatcher *CM =
  70           dyn_cast<CompleteMatchMatcher>(EN->getNext())) {
  71       (void)CM;
  72     }
  73
  74   ContractNodes(N->getNextPtr());
  75 }
  76
  77 /// SinkPatternPredicates - Pattern predicates can be checked at any level of
  78 /// the matching tree.  The generator dumps them at the top level of the pattern
  79 /// though, which prevents factoring from being able to see past them.  This
  80 /// optimization sinks them as far down into the pattern as possible.
  81 ///
  82 /// Conceptually, we'd like to sink these predicates all the way to the last
  83 /// matcher predicate in the series.  However, it turns out that some
  84 /// ComplexPatterns have side effects on the graph, so we really don't want to
  85 /// run a the complex pattern if the pattern predicate will fail.  For this
  86 /// reason, we refuse to sink the pattern predicate past a ComplexPattern.
  87 ///
  88 static void SinkPatternPredicates(OwningPtr<Matcher> &MatcherPtr) {
  89   // Recursively scan for a PatternPredicate.
  90   // If we reached the end of the chain, we're done.
  91   Matcher *N = MatcherPtr.get();
  92   if (N == 0) return;
  93
  94   // Walk down all members of a scope node.
  95   if (ScopeMatcher *Scope = dyn_cast<ScopeMatcher>(N)) {
  96     for (unsigned i = 0, e = Scope->getNumChildren(); i != e; ++i) {
  97       OwningPtr<Matcher> Child(Scope->takeChild(i));
  98       SinkPatternPredicates(Child);
  99       Scope->resetChild(i, Child.take());
 100     }
 101     return;
 102   }
 103
 104   // If this node isn't a CheckPatternPredicateMatcher we keep scanning until
 105   // we find one.
 106   CheckPatternPredicateMatcher *CPPM =dyn_cast<CheckPatternPredicateMatcher>(N);
 107   if (CPPM == 0)
 108     return SinkPatternPredicates(N->getNextPtr());
 109
 110   // Ok, we found one, lets try to sink it. Check if we can sink it past the
 111   // next node in the chain.  If not, we won't be able to change anything and
 112   // might as well bail.
 113   if (!CPPM->getNext()->isSafeToReorderWithPatternPredicate())
 114     return;
 115
 116   // Okay, we know we can sink it past at least one node.  Unlink it from the
 117   // chain and scan for the new insertion point.
 118   MatcherPtr.take();  // Don't delete CPPM.
 119   MatcherPtr.reset(CPPM->takeNext());
 120
 121   N = MatcherPtr.get();
 122   while (N->getNext()->isSafeToReorderWithPatternPredicate())
 123     N = N->getNext();
 124
 125   // At this point, we want to insert CPPM after N.
 126   CPPM->setNext(N->takeNext());
 127   N->setNext(CPPM);
 128 }
 129
 130 /// FactorNodes - Turn matches like this:
 131 ///   Scope
 132 ///     OPC_CheckType i32
 133 ///       ABC
 134 ///     OPC_CheckType i32
 135 ///       XYZ
 136 /// into:
 137 ///   OPC_CheckType i32
 138 ///     Scope
 139 ///       ABC
 140 ///       XYZ
 141 ///
 142 static void FactorNodes(OwningPtr<Matcher> &MatcherPtr) {
 143   // If we reached the end of the chain, we're done.
 144   Matcher *N = MatcherPtr.get();
 145   if (N == 0) return;
 146
 147   // If this is not a push node, just scan for one.
 148   ScopeMatcher *Scope = dyn_cast<ScopeMatcher>(N);
 149   if (Scope == 0)
 150     return FactorNodes(N->getNextPtr());
 151
 152   // Okay, pull together the children of the scope node into a vector so we can
 153   // inspect it more easily.  While we're at it, bucket them up by the hash
 154   // code of their first predicate.
 155   SmallVector<Matcher*, 32> OptionsToMatch;
 156
 157   for (unsigned i = 0, e = Scope->getNumChildren(); i != e; ++i) {
 158     // Factor the subexpression.
 159     OwningPtr<Matcher> Child(Scope->takeChild(i));
 160     FactorNodes(Child);
 161
 162     if (Matcher *N = Child.take())
 163       OptionsToMatch.push_back(N);
 164   }
 165
 166   SmallVector<Matcher*, 32> NewOptionsToMatch;
 167
 168   // Loop over options to match, merging neighboring patterns with identical
 169   // starting nodes into a shared matcher.
 170   for (unsigned OptionIdx = 0, e = OptionsToMatch.size(); OptionIdx != e;) {
 171     // Find the set of matchers that start with this node.
 172     Matcher *Optn = OptionsToMatch[OptionIdx++];
 173
 174     if (OptionIdx == e) {
 175       NewOptionsToMatch.push_back(Optn);
 176       continue;
 177     }
 178
 179     // See if the next option starts with the same matcher.  If the two
 180     // neighbors *do* start with the same matcher, we can factor the matcher out
 181     // of at least these two patterns.  See what the maximal set we can merge
 182     // together is.
 183     SmallVector<Matcher*, 8> EqualMatchers;
 184     EqualMatchers.push_back(Optn);
 185
 186     // Factor all of the known-equal matchers after this one into the same
 187     // group.
 188     while (OptionIdx != e && OptionsToMatch[OptionIdx]->isEqual(Optn))
 189       EqualMatchers.push_back(OptionsToMatch[OptionIdx++]);
 190
 191     // If we found a non-equal matcher, see if it is contradictory with the
 192     // current node.  If so, we know that the ordering relation between the
 193     // current sets of nodes and this node don't matter.  Look past it to see if
 194     // we can merge anything else into this matching group.
 195     unsigned Scan = OptionIdx;
 196     while (1) {
 197       while (Scan != e && Optn->isContradictory(OptionsToMatch[Scan]))
 198         ++Scan;
 199
 200       // Ok, we found something that isn't known to be contradictory.  If it is
 201       // equal, we can merge it into the set of nodes to factor, if not, we have
 202       // to cease factoring.
 203       if (Scan == e || !Optn->isEqual(OptionsToMatch[Scan])) break;
 204
 205       // If is equal after all, add the option to EqualMatchers and remove it
 206       // from OptionsToMatch.
 207       EqualMatchers.push_back(OptionsToMatch[Scan]);
 208       OptionsToMatch.erase(OptionsToMatch.begin()+Scan);
 209       --e;
 210     }
 211
 212     if (Scan != e &&
 213         // Don't print it's obvious nothing extra could be merged anyway.
 214         Scan+1 != e) {
 215       DEBUG(errs() << "Couldn't merge this:\n";
 216             Optn->print(errs(), 4);
 217             errs() << "into this:\n";
 218             OptionsToMatch[Scan]->print(errs(), 4);
 219             if (Scan+1 != e)
 220               OptionsToMatch[Scan+1]->printOne(errs());
 221             if (Scan+2 < e)
 222               OptionsToMatch[Scan+2]->printOne(errs());
 223             errs() << "\n");
 224     }
 225
 226     // If we only found one option starting with this matcher, no factoring is
 227     // possible.
 228     if (EqualMatchers.size() == 1) {
 229       NewOptionsToMatch.push_back(EqualMatchers[0]);
 230       continue;
 231     }
 232
 233     // Factor these checks by pulling the first node off each entry and
 234     // discarding it.  Take the first one off the first entry to reuse.
 235     Matcher *Shared = Optn;
 236     Optn = Optn->takeNext();
 237     EqualMatchers[0] = Optn;
 238
 239     // Remove and delete the first node from the other matchers we're factoring.
 240     for (unsigned i = 1, e = EqualMatchers.size(); i != e; ++i) {
 241       Matcher *Tmp = EqualMatchers[i]->takeNext();
 242       delete EqualMatchers[i];
 243       EqualMatchers[i] = Tmp;
 244     }
 245
 246     Shared->setNext(new ScopeMatcher(&EqualMatchers[0], EqualMatchers.size()));
 247
 248     // Recursively factor the newly created node.
 249     FactorNodes(Shared->getNextPtr());
 250
 251     NewOptionsToMatch.push_back(Shared);
 252   }
 253
 254   // Reassemble a new Scope node.
 255   assert(!NewOptionsToMatch.empty() && "where'd all our children go?");
 256   if (NewOptionsToMatch.size() == 1)
 257     MatcherPtr.reset(NewOptionsToMatch[0]);
 258   else {
 259     Scope->setNumChildren(NewOptionsToMatch.size());
 260     for (unsigned i = 0, e = NewOptionsToMatch.size(); i != e; ++i)
 261       Scope->resetChild(i, NewOptionsToMatch[i]);
 262   }
 263 }
 264
 265 Matcher *llvm::OptimizeMatcher(Matcher *TheMatcher) {
 266   OwningPtr<Matcher> MatcherPtr(TheMatcher);
 267   ContractNodes(MatcherPtr);
 268   SinkPatternPredicates(MatcherPtr);
 269   FactorNodes(MatcherPtr);
 270   return MatcherPtr.take();
 271 }