SetTheory.cpp revision 239462
1223013Sdim//===- SetTheory.cpp - Generate ordered sets from DAG expressions ---------===// 2223013Sdim// 3223013Sdim// The LLVM Compiler Infrastructure 4223013Sdim// 5223013Sdim// This file is distributed under the University of Illinois Open Source 6223013Sdim// License. See LICENSE.TXT for details. 7223013Sdim// 8223013Sdim//===----------------------------------------------------------------------===// 9223013Sdim// 10223013Sdim// This file implements the SetTheory class that computes ordered sets of 11223013Sdim// Records from DAG expressions. 12223013Sdim// 13223013Sdim//===----------------------------------------------------------------------===// 14223013Sdim 15223013Sdim#include "SetTheory.h" 16226633Sdim#include "llvm/TableGen/Error.h" 17226633Sdim#include "llvm/TableGen/Record.h" 18223013Sdim#include "llvm/Support/Format.h" 19223013Sdim 20223013Sdimusing namespace llvm; 21223013Sdim 22223013Sdim// Define the standard operators. 23223013Sdimnamespace { 24223013Sdim 25223013Sdimtypedef SetTheory::RecSet RecSet; 26223013Sdimtypedef SetTheory::RecVec RecVec; 27223013Sdim 28223013Sdim// (add a, b, ...) Evaluate and union all arguments. 29223013Sdimstruct AddOp : public SetTheory::Operator { 30223013Sdim void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) { 31223013Sdim ST.evaluate(Expr->arg_begin(), Expr->arg_end(), Elts); 32223013Sdim } 33223013Sdim}; 34223013Sdim 35223013Sdim// (sub Add, Sub, ...) Set difference. 36223013Sdimstruct SubOp : public SetTheory::Operator { 37223013Sdim void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) { 38223013Sdim if (Expr->arg_size() < 2) 39223013Sdim throw "Set difference needs at least two arguments: " + 40223013Sdim Expr->getAsString(); 41223013Sdim RecSet Add, Sub; 42223013Sdim ST.evaluate(*Expr->arg_begin(), Add); 43223013Sdim ST.evaluate(Expr->arg_begin() + 1, Expr->arg_end(), Sub); 44223013Sdim for (RecSet::iterator I = Add.begin(), E = Add.end(); I != E; ++I) 45223013Sdim if (!Sub.count(*I)) 46223013Sdim Elts.insert(*I); 47223013Sdim } 48223013Sdim}; 49223013Sdim 50223013Sdim// (and S1, S2) Set intersection. 51223013Sdimstruct AndOp : public SetTheory::Operator { 52223013Sdim void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) { 53223013Sdim if (Expr->arg_size() != 2) 54223013Sdim throw "Set intersection requires two arguments: " + Expr->getAsString(); 55223013Sdim RecSet S1, S2; 56223013Sdim ST.evaluate(Expr->arg_begin()[0], S1); 57223013Sdim ST.evaluate(Expr->arg_begin()[1], S2); 58223013Sdim for (RecSet::iterator I = S1.begin(), E = S1.end(); I != E; ++I) 59223013Sdim if (S2.count(*I)) 60223013Sdim Elts.insert(*I); 61223013Sdim } 62223013Sdim}; 63223013Sdim 64223013Sdim// SetIntBinOp - Abstract base class for (Op S, N) operators. 65223013Sdimstruct SetIntBinOp : public SetTheory::Operator { 66223013Sdim virtual void apply2(SetTheory &ST, DagInit *Expr, 67223013Sdim RecSet &Set, int64_t N, 68223013Sdim RecSet &Elts) =0; 69223013Sdim 70223013Sdim void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) { 71223013Sdim if (Expr->arg_size() != 2) 72223013Sdim throw "Operator requires (Op Set, Int) arguments: " + Expr->getAsString(); 73223013Sdim RecSet Set; 74223013Sdim ST.evaluate(Expr->arg_begin()[0], Set); 75223013Sdim IntInit *II = dynamic_cast<IntInit*>(Expr->arg_begin()[1]); 76223013Sdim if (!II) 77223013Sdim throw "Second argument must be an integer: " + Expr->getAsString(); 78223013Sdim apply2(ST, Expr, Set, II->getValue(), Elts); 79223013Sdim } 80223013Sdim}; 81223013Sdim 82223013Sdim// (shl S, N) Shift left, remove the first N elements. 83223013Sdimstruct ShlOp : public SetIntBinOp { 84223013Sdim void apply2(SetTheory &ST, DagInit *Expr, 85223013Sdim RecSet &Set, int64_t N, 86223013Sdim RecSet &Elts) { 87223013Sdim if (N < 0) 88223013Sdim throw "Positive shift required: " + Expr->getAsString(); 89223013Sdim if (unsigned(N) < Set.size()) 90223013Sdim Elts.insert(Set.begin() + N, Set.end()); 91223013Sdim } 92223013Sdim}; 93223013Sdim 94223013Sdim// (trunc S, N) Truncate after the first N elements. 95223013Sdimstruct TruncOp : public SetIntBinOp { 96223013Sdim void apply2(SetTheory &ST, DagInit *Expr, 97223013Sdim RecSet &Set, int64_t N, 98223013Sdim RecSet &Elts) { 99223013Sdim if (N < 0) 100223013Sdim throw "Positive length required: " + Expr->getAsString(); 101223013Sdim if (unsigned(N) > Set.size()) 102223013Sdim N = Set.size(); 103223013Sdim Elts.insert(Set.begin(), Set.begin() + N); 104223013Sdim } 105223013Sdim}; 106223013Sdim 107223013Sdim// Left/right rotation. 108223013Sdimstruct RotOp : public SetIntBinOp { 109223013Sdim const bool Reverse; 110223013Sdim 111223013Sdim RotOp(bool Rev) : Reverse(Rev) {} 112223013Sdim 113223013Sdim void apply2(SetTheory &ST, DagInit *Expr, 114223013Sdim RecSet &Set, int64_t N, 115223013Sdim RecSet &Elts) { 116223013Sdim if (Reverse) 117223013Sdim N = -N; 118223013Sdim // N > 0 -> rotate left, N < 0 -> rotate right. 119223013Sdim if (Set.empty()) 120223013Sdim return; 121223013Sdim if (N < 0) 122223013Sdim N = Set.size() - (-N % Set.size()); 123223013Sdim else 124223013Sdim N %= Set.size(); 125223013Sdim Elts.insert(Set.begin() + N, Set.end()); 126223013Sdim Elts.insert(Set.begin(), Set.begin() + N); 127223013Sdim } 128223013Sdim}; 129223013Sdim 130223013Sdim// (decimate S, N) Pick every N'th element of S. 131223013Sdimstruct DecimateOp : public SetIntBinOp { 132223013Sdim void apply2(SetTheory &ST, DagInit *Expr, 133223013Sdim RecSet &Set, int64_t N, 134223013Sdim RecSet &Elts) { 135223013Sdim if (N <= 0) 136223013Sdim throw "Positive stride required: " + Expr->getAsString(); 137223013Sdim for (unsigned I = 0; I < Set.size(); I += N) 138223013Sdim Elts.insert(Set[I]); 139223013Sdim } 140223013Sdim}; 141223013Sdim 142234353Sdim// (interleave S1, S2, ...) Interleave elements of the arguments. 143234353Sdimstruct InterleaveOp : public SetTheory::Operator { 144234353Sdim void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) { 145234353Sdim // Evaluate the arguments individually. 146234353Sdim SmallVector<RecSet, 4> Args(Expr->getNumArgs()); 147234353Sdim unsigned MaxSize = 0; 148234353Sdim for (unsigned i = 0, e = Expr->getNumArgs(); i != e; ++i) { 149234353Sdim ST.evaluate(Expr->getArg(i), Args[i]); 150234353Sdim MaxSize = std::max(MaxSize, unsigned(Args[i].size())); 151234353Sdim } 152234353Sdim // Interleave arguments into Elts. 153234353Sdim for (unsigned n = 0; n != MaxSize; ++n) 154234353Sdim for (unsigned i = 0, e = Expr->getNumArgs(); i != e; ++i) 155234353Sdim if (n < Args[i].size()) 156234353Sdim Elts.insert(Args[i][n]); 157234353Sdim } 158234353Sdim}; 159234353Sdim 160223013Sdim// (sequence "Format", From, To) Generate a sequence of records by name. 161223013Sdimstruct SequenceOp : public SetTheory::Operator { 162223013Sdim void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) { 163239462Sdim int Step = 1; 164239462Sdim if (Expr->arg_size() > 4) 165223013Sdim throw "Bad args to (sequence \"Format\", From, To): " + 166223013Sdim Expr->getAsString(); 167239462Sdim else if (Expr->arg_size() == 4) { 168239462Sdim if (IntInit *II = dynamic_cast<IntInit*>(Expr->arg_begin()[3])) { 169239462Sdim Step = II->getValue(); 170239462Sdim } else 171239462Sdim throw "Stride must be an integer: " + Expr->getAsString(); 172239462Sdim } 173239462Sdim 174223013Sdim std::string Format; 175223013Sdim if (StringInit *SI = dynamic_cast<StringInit*>(Expr->arg_begin()[0])) 176223013Sdim Format = SI->getValue(); 177223013Sdim else 178223013Sdim throw "Format must be a string: " + Expr->getAsString(); 179223013Sdim 180223013Sdim int64_t From, To; 181223013Sdim if (IntInit *II = dynamic_cast<IntInit*>(Expr->arg_begin()[1])) 182223013Sdim From = II->getValue(); 183223013Sdim else 184223013Sdim throw "From must be an integer: " + Expr->getAsString(); 185224145Sdim if (From < 0 || From >= (1 << 30)) 186224145Sdim throw "From out of range"; 187224145Sdim 188223013Sdim if (IntInit *II = dynamic_cast<IntInit*>(Expr->arg_begin()[2])) 189223013Sdim To = II->getValue(); 190223013Sdim else 191223013Sdim throw "From must be an integer: " + Expr->getAsString(); 192224145Sdim if (To < 0 || To >= (1 << 30)) 193224145Sdim throw "To out of range"; 194223013Sdim 195223013Sdim RecordKeeper &Records = 196223013Sdim dynamic_cast<DefInit&>(*Expr->getOperator()).getDef()->getRecords(); 197223013Sdim 198239462Sdim Step *= From <= To ? 1 : -1; 199239462Sdim while (true) { 200239462Sdim if (Step > 0 && From > To) 201239462Sdim break; 202239462Sdim else if (Step < 0 && From < To) 203239462Sdim break; 204223013Sdim std::string Name; 205223013Sdim raw_string_ostream OS(Name); 206224145Sdim OS << format(Format.c_str(), unsigned(From)); 207223013Sdim Record *Rec = Records.getDef(OS.str()); 208223013Sdim if (!Rec) 209223013Sdim throw "No def named '" + Name + "': " + Expr->getAsString(); 210223013Sdim // Try to reevaluate Rec in case it is a set. 211223013Sdim if (const RecVec *Result = ST.expand(Rec)) 212223013Sdim Elts.insert(Result->begin(), Result->end()); 213223013Sdim else 214223013Sdim Elts.insert(Rec); 215239462Sdim 216239462Sdim From += Step; 217223013Sdim } 218223013Sdim } 219223013Sdim}; 220223013Sdim 221223013Sdim// Expand a Def into a set by evaluating one of its fields. 222223013Sdimstruct FieldExpander : public SetTheory::Expander { 223223013Sdim StringRef FieldName; 224223013Sdim 225223013Sdim FieldExpander(StringRef fn) : FieldName(fn) {} 226223013Sdim 227223013Sdim void expand(SetTheory &ST, Record *Def, RecSet &Elts) { 228223013Sdim ST.evaluate(Def->getValueInit(FieldName), Elts); 229223013Sdim } 230223013Sdim}; 231223013Sdim} // end anonymous namespace 232223013Sdim 233234353Sdimvoid SetTheory::Operator::anchor() { } 234234353Sdim 235234353Sdimvoid SetTheory::Expander::anchor() { } 236234353Sdim 237223013SdimSetTheory::SetTheory() { 238223013Sdim addOperator("add", new AddOp); 239223013Sdim addOperator("sub", new SubOp); 240223013Sdim addOperator("and", new AndOp); 241223013Sdim addOperator("shl", new ShlOp); 242223013Sdim addOperator("trunc", new TruncOp); 243223013Sdim addOperator("rotl", new RotOp(false)); 244223013Sdim addOperator("rotr", new RotOp(true)); 245223013Sdim addOperator("decimate", new DecimateOp); 246234353Sdim addOperator("interleave", new InterleaveOp); 247223013Sdim addOperator("sequence", new SequenceOp); 248223013Sdim} 249223013Sdim 250223013Sdimvoid SetTheory::addOperator(StringRef Name, Operator *Op) { 251223013Sdim Operators[Name] = Op; 252223013Sdim} 253223013Sdim 254223013Sdimvoid SetTheory::addExpander(StringRef ClassName, Expander *E) { 255223013Sdim Expanders[ClassName] = E; 256223013Sdim} 257223013Sdim 258223013Sdimvoid SetTheory::addFieldExpander(StringRef ClassName, StringRef FieldName) { 259223013Sdim addExpander(ClassName, new FieldExpander(FieldName)); 260223013Sdim} 261223013Sdim 262223013Sdimvoid SetTheory::evaluate(Init *Expr, RecSet &Elts) { 263223013Sdim // A def in a list can be a just an element, or it may expand. 264223013Sdim if (DefInit *Def = dynamic_cast<DefInit*>(Expr)) { 265223013Sdim if (const RecVec *Result = expand(Def->getDef())) 266223013Sdim return Elts.insert(Result->begin(), Result->end()); 267223013Sdim Elts.insert(Def->getDef()); 268223013Sdim return; 269223013Sdim } 270223013Sdim 271223013Sdim // Lists simply expand. 272223013Sdim if (ListInit *LI = dynamic_cast<ListInit*>(Expr)) 273223013Sdim return evaluate(LI->begin(), LI->end(), Elts); 274223013Sdim 275223013Sdim // Anything else must be a DAG. 276223013Sdim DagInit *DagExpr = dynamic_cast<DagInit*>(Expr); 277223013Sdim if (!DagExpr) 278223013Sdim throw "Invalid set element: " + Expr->getAsString(); 279223013Sdim DefInit *OpInit = dynamic_cast<DefInit*>(DagExpr->getOperator()); 280223013Sdim if (!OpInit) 281223013Sdim throw "Bad set expression: " + Expr->getAsString(); 282223013Sdim Operator *Op = Operators.lookup(OpInit->getDef()->getName()); 283223013Sdim if (!Op) 284223013Sdim throw "Unknown set operator: " + Expr->getAsString(); 285223013Sdim Op->apply(*this, DagExpr, Elts); 286223013Sdim} 287223013Sdim 288223013Sdimconst RecVec *SetTheory::expand(Record *Set) { 289223013Sdim // Check existing entries for Set and return early. 290223013Sdim ExpandMap::iterator I = Expansions.find(Set); 291223013Sdim if (I != Expansions.end()) 292223013Sdim return &I->second; 293223013Sdim 294223013Sdim // This is the first time we see Set. Find a suitable expander. 295223013Sdim try { 296223013Sdim const std::vector<Record*> &SC = Set->getSuperClasses(); 297223013Sdim for (unsigned i = 0, e = SC.size(); i != e; ++i) 298223013Sdim if (Expander *Exp = Expanders.lookup(SC[i]->getName())) { 299223013Sdim // This breaks recursive definitions. 300223013Sdim RecVec &EltVec = Expansions[Set]; 301223013Sdim RecSet Elts; 302223013Sdim Exp->expand(*this, Set, Elts); 303223013Sdim EltVec.assign(Elts.begin(), Elts.end()); 304223013Sdim return &EltVec; 305223013Sdim } 306223013Sdim } catch (const std::string &Error) { 307223013Sdim throw TGError(Set->getLoc(), Error); 308223013Sdim } 309223013Sdim 310223013Sdim // Set is not expandable. 311223013Sdim return 0; 312223013Sdim} 313223013Sdim 314