utils/TableGen/SetTheory.cpp

   1 //===- SetTheory.cpp - Generate ordered sets from DAG expressions ---------===//
   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 SetTheory class that computes ordered sets of
  11 // Records from DAG expressions.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "SetTheory.h"
  16 #include "Record.h"
  17 #include "llvm/Support/Format.h"
  18
  19 using namespace llvm;
  20
  21 // Define the standard operators.
  22 namespace {
  23
  24 typedef SetTheory::RecSet RecSet;
  25 typedef SetTheory::RecVec RecVec;
  26
  27 // (add a, b, ...) Evaluate and union all arguments.
  28 struct AddOp : public SetTheory::Operator {
  29   void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) {
  30     ST.evaluate(Expr->arg_begin(), Expr->arg_end(), Elts);
  31   }
  32 };
  33
  34 // (sub Add, Sub, ...) Set difference.
  35 struct SubOp : public SetTheory::Operator {
  36   void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) {
  37     if (Expr->arg_size() < 2)
  38       throw "Set difference needs at least two arguments: " +
  39         Expr->getAsString();
  40     RecSet Add, Sub;
  41     ST.evaluate(*Expr->arg_begin(), Add);
  42     ST.evaluate(Expr->arg_begin() + 1, Expr->arg_end(), Sub);
  43     for (RecSet::iterator I = Add.begin(), E = Add.end(); I != E; ++I)
  44       if (!Sub.count(*I))
  45         Elts.insert(*I);
  46   }
  47 };
  48
  49 // (and S1, S2) Set intersection.
  50 struct AndOp : public SetTheory::Operator {
  51   void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) {
  52     if (Expr->arg_size() != 2)
  53       throw "Set intersection requires two arguments: " + Expr->getAsString();
  54     RecSet S1, S2;
  55     ST.evaluate(Expr->arg_begin()[0], S1);
  56     ST.evaluate(Expr->arg_begin()[1], S2);
  57     for (RecSet::iterator I = S1.begin(), E = S1.end(); I != E; ++I)
  58       if (S2.count(*I))
  59         Elts.insert(*I);
  60   }
  61 };
  62
  63 // SetIntBinOp - Abstract base class for (Op S, N) operators.
  64 struct SetIntBinOp : public SetTheory::Operator {
  65   virtual void apply(SetTheory &ST, DagInit *Expr,
  66                      RecSet &Set, int64_t N,
  67                      RecSet &Elts) =0;
  68
  69   void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) {
  70     if (Expr->arg_size() != 2)
  71       throw "Operator requires (Op Set, Int) arguments: " + Expr->getAsString();
  72     RecSet Set;
  73     ST.evaluate(Expr->arg_begin()[0], Set);
  74     IntInit *II = dynamic_cast<IntInit*>(Expr->arg_begin()[1]);
  75     if (!II)
  76       throw "Second argument must be an integer: " + Expr->getAsString();
  77     apply(ST, Expr, Set, II->getValue(), Elts);
  78   }
  79 };
  80
  81 // (shl S, N) Shift left, remove the first N elements.
  82 struct ShlOp : public SetIntBinOp {
  83   void apply(SetTheory &ST, DagInit *Expr,
  84              RecSet &Set, int64_t N,
  85              RecSet &Elts) {
  86     if (N < 0)
  87       throw "Positive shift required: " + Expr->getAsString();
  88     if (unsigned(N) < Set.size())
  89       Elts.insert(Set.begin() + N, Set.end());
  90   }
  91 };
  92
  93 // (trunc S, N) Truncate after the first N elements.
  94 struct TruncOp : public SetIntBinOp {
  95   void apply(SetTheory &ST, DagInit *Expr,
  96              RecSet &Set, int64_t N,
  97              RecSet &Elts) {
  98     if (N < 0)
  99       throw "Positive length required: " + Expr->getAsString();
 100     if (unsigned(N) > Set.size())
 101       N = Set.size();
 102     Elts.insert(Set.begin(), Set.begin() + N);
 103   }
 104 };
 105
 106 // Left/right rotation.
 107 struct RotOp : public SetIntBinOp {
 108   const bool Reverse;
 109
 110   RotOp(bool Rev) : Reverse(Rev) {}
 111
 112   void apply(SetTheory &ST, DagInit *Expr,
 113              RecSet &Set, int64_t N,
 114              RecSet &Elts) {
 115     if (Reverse)
 116       N = -N;
 117     // N > 0 -> rotate left, N < 0 -> rotate right.
 118     if (Set.empty())
 119       return;
 120     if (N < 0)
 121       N = Set.size() - (-N % Set.size());
 122     else
 123       N %= Set.size();
 124     Elts.insert(Set.begin() + N, Set.end());
 125     Elts.insert(Set.begin(), Set.begin() + N);
 126   }
 127 };
 128
 129 // (decimate S, N) Pick every N'th element of S.
 130 struct DecimateOp : public SetIntBinOp {
 131   void apply(SetTheory &ST, DagInit *Expr,
 132              RecSet &Set, int64_t N,
 133              RecSet &Elts) {
 134     if (N <= 0)
 135       throw "Positive stride required: " + Expr->getAsString();
 136     for (unsigned I = 0; I < Set.size(); I += N)
 137       Elts.insert(Set[I]);
 138   }
 139 };
 140
 141 // (sequence "Format", From, To) Generate a sequence of records by name.
 142 struct SequenceOp : public SetTheory::Operator {
 143   RecordKeeper &Records;
 144
 145   SequenceOp(RecordKeeper&R) : Records(R) {}
 146
 147   void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) {
 148     if (Expr->arg_size() != 3)
 149       throw "Bad args to (sequence \"Format\", From, To): " +
 150         Expr->getAsString();
 151     std::string Format;
 152     if (StringInit *SI = dynamic_cast<StringInit*>(Expr->arg_begin()[0]))
 153       Format = SI->getValue();
 154     else
 155       throw "Format must be a string: " + Expr->getAsString();
 156
 157     int64_t From, To;
 158     if (IntInit *II = dynamic_cast<IntInit*>(Expr->arg_begin()[1]))
 159       From = II->getValue();
 160     else
 161       throw "From must be an integer: " + Expr->getAsString();
 162     if (IntInit *II = dynamic_cast<IntInit*>(Expr->arg_begin()[2]))
 163       To = II->getValue();
 164     else
 165       throw "From must be an integer: " + Expr->getAsString();
 166
 167     int Step = From <= To ? 1 : -1;
 168     for (To += Step; From != To; From += Step) {
 169       std::string Name;
 170       raw_string_ostream OS(Name);
 171       OS << format(Format.c_str(), From);
 172       Record *Rec = Records.getDef(OS.str());
 173       if (!Rec)
 174         throw "No def named '" + Name + "': " + Expr->getAsString();
 175       // Try to reevaluate Rec in case it is a set.
 176       if (const RecVec *Result = ST.expand(Rec))
 177         Elts.insert(Result->begin(), Result->end());
 178       else
 179         Elts.insert(Rec);
 180     }
 181   }
 182 };
 183
 184 // Expand a Def into a set by evaluating one of its fields.
 185 struct FieldExpander : public SetTheory::Expander {
 186   StringRef FieldName;
 187
 188   FieldExpander(StringRef fn) : FieldName(fn) {}
 189
 190   void expand(SetTheory &ST, Record *Def, RecSet &Elts) {
 191     ST.evaluate(Def->getValueInit(FieldName), Elts);
 192   }
 193 };
 194 } // end anonymous namespace
 195
 196 SetTheory::SetTheory(RecordKeeper *Records) {
 197   addOperator("add", new AddOp);
 198   addOperator("sub", new SubOp);
 199   addOperator("and", new AndOp);
 200   addOperator("shl", new ShlOp);
 201   addOperator("trunc", new TruncOp);
 202   addOperator("rotl", new RotOp(false));
 203   addOperator("rotr", new RotOp(true));
 204   addOperator("decimate", new DecimateOp);
 205   if (Records)
 206     addOperator("sequence", new SequenceOp(*Records));
 207 }
 208
 209 void SetTheory::addOperator(StringRef Name, Operator *Op) {
 210   Operators[Name] = Op;
 211 }
 212
 213 void SetTheory::addExpander(StringRef ClassName, Expander *E) {
 214   Expanders[ClassName] = E;
 215 }
 216
 217 void SetTheory::addFieldExpander(StringRef ClassName, StringRef FieldName) {
 218   addExpander(ClassName, new FieldExpander(FieldName));
 219 }
 220
 221 void SetTheory::evaluate(Init *Expr, RecSet &Elts) {
 222   // A def in a list can be a just an element, or it may expand.
 223   if (DefInit *Def = dynamic_cast<DefInit*>(Expr)) {
 224     if (const RecVec *Result = expand(Def->getDef()))
 225       return Elts.insert(Result->begin(), Result->end());
 226     Elts.insert(Def->getDef());
 227     return;
 228   }
 229
 230   // Lists simply expand.
 231   if (ListInit *LI = dynamic_cast<ListInit*>(Expr))
 232     return evaluate(LI->begin(), LI->end(), Elts);
 233
 234   // Anything else must be a DAG.
 235   DagInit *DagExpr = dynamic_cast<DagInit*>(Expr);
 236   if (!DagExpr)
 237     throw "Invalid set element: " + Expr->getAsString();
 238   DefInit *OpInit = dynamic_cast<DefInit*>(DagExpr->getOperator());
 239   if (!OpInit)
 240     throw "Bad set expression: " + Expr->getAsString();
 241   Operator *Op = Operators.lookup(OpInit->getDef()->getName());
 242   if (!Op)
 243     throw "Unknown set operator: " + Expr->getAsString();
 244   Op->apply(*this, DagExpr, Elts);
 245 }
 246
 247 const RecVec *SetTheory::expand(Record *Set) {
 248   // Check existing entries for Set and return early.
 249   ExpandMap::iterator I = Expansions.find(Set);
 250   if (I != Expansions.end())
 251     return &I->second;
 252
 253   // This is the first time we see Set. Find a suitable expander.
 254   try {
 255     const std::vector<Record*> &SC = Set->getSuperClasses();
 256     for (unsigned i = 0, e = SC.size(); i != e; ++i)
 257       if (Expander *Exp = Expanders.lookup(SC[i]->getName())) {
 258         // This breaks recursive definitions.
 259         RecVec &EltVec = Expansions[Set];
 260         RecSet Elts;
 261         Exp->expand(*this, Set, Elts);
 262         EltVec.assign(Elts.begin(), Elts.end());
 263         return &EltVec;
 264       }
 265   } catch (const std::string &Error) {
 266     throw TGError(Set->getLoc(), Error);
 267   }
 268
 269   // Set is not expandable.
 270   return 0;
 271 }
 272