1 //===- SetTheory.cpp - Generate ordered sets from DAG expressions ---------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the SetTheory class that computes ordered sets of
11 // Records from DAG expressions.
13 //===----------------------------------------------------------------------===//
15 #include "SetTheory.h"
16 #include "llvm/TableGen/Error.h"
17 #include "llvm/TableGen/Record.h"
18 #include "llvm/Support/Format.h"
22 // Define the standard operators.
25 typedef SetTheory::RecSet RecSet;
26 typedef SetTheory::RecVec RecVec;
28 // (add a, b, ...) Evaluate and union all arguments.
29 struct AddOp : public SetTheory::Operator {
30 void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) {
31 ST.evaluate(Expr->arg_begin(), Expr->arg_end(), Elts);
35 // (sub Add, Sub, ...) Set difference.
36 struct SubOp : public SetTheory::Operator {
37 void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) {
38 if (Expr->arg_size() < 2)
39 throw "Set difference needs at least two arguments: " +
42 ST.evaluate(*Expr->arg_begin(), Add);
43 ST.evaluate(Expr->arg_begin() + 1, Expr->arg_end(), Sub);
44 for (RecSet::iterator I = Add.begin(), E = Add.end(); I != E; ++I)
50 // (and S1, S2) Set intersection.
51 struct AndOp : public SetTheory::Operator {
52 void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) {
53 if (Expr->arg_size() != 2)
54 throw "Set intersection requires two arguments: " + Expr->getAsString();
56 ST.evaluate(Expr->arg_begin()[0], S1);
57 ST.evaluate(Expr->arg_begin()[1], S2);
58 for (RecSet::iterator I = S1.begin(), E = S1.end(); I != E; ++I)
64 // SetIntBinOp - Abstract base class for (Op S, N) operators.
65 struct SetIntBinOp : public SetTheory::Operator {
66 virtual void apply2(SetTheory &ST, DagInit *Expr,
67 RecSet &Set, int64_t N,
70 void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) {
71 if (Expr->arg_size() != 2)
72 throw "Operator requires (Op Set, Int) arguments: " + Expr->getAsString();
74 ST.evaluate(Expr->arg_begin()[0], Set);
75 IntInit *II = dynamic_cast<IntInit*>(Expr->arg_begin()[1]);
77 throw "Second argument must be an integer: " + Expr->getAsString();
78 apply2(ST, Expr, Set, II->getValue(), Elts);
82 // (shl S, N) Shift left, remove the first N elements.
83 struct ShlOp : public SetIntBinOp {
84 void apply2(SetTheory &ST, DagInit *Expr,
85 RecSet &Set, int64_t N,
88 throw "Positive shift required: " + Expr->getAsString();
89 if (unsigned(N) < Set.size())
90 Elts.insert(Set.begin() + N, Set.end());
94 // (trunc S, N) Truncate after the first N elements.
95 struct TruncOp : public SetIntBinOp {
96 void apply2(SetTheory &ST, DagInit *Expr,
97 RecSet &Set, int64_t N,
100 throw "Positive length required: " + Expr->getAsString();
101 if (unsigned(N) > Set.size())
103 Elts.insert(Set.begin(), Set.begin() + N);
107 // Left/right rotation.
108 struct RotOp : public SetIntBinOp {
111 RotOp(bool Rev) : Reverse(Rev) {}
113 void apply2(SetTheory &ST, DagInit *Expr,
114 RecSet &Set, int64_t N,
118 // N > 0 -> rotate left, N < 0 -> rotate right.
122 N = Set.size() - (-N % Set.size());
125 Elts.insert(Set.begin() + N, Set.end());
126 Elts.insert(Set.begin(), Set.begin() + N);
130 // (decimate S, N) Pick every N'th element of S.
131 struct DecimateOp : public SetIntBinOp {
132 void apply2(SetTheory &ST, DagInit *Expr,
133 RecSet &Set, int64_t N,
136 throw "Positive stride required: " + Expr->getAsString();
137 for (unsigned I = 0; I < Set.size(); I += N)
142 // (interleave S1, S2, ...) Interleave elements of the arguments.
143 struct InterleaveOp : public SetTheory::Operator {
144 void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) {
145 // Evaluate the arguments individually.
146 SmallVector<RecSet, 4> Args(Expr->getNumArgs());
147 unsigned MaxSize = 0;
148 for (unsigned i = 0, e = Expr->getNumArgs(); i != e; ++i) {
149 ST.evaluate(Expr->getArg(i), Args[i]);
150 MaxSize = std::max(MaxSize, unsigned(Args[i].size()));
152 // Interleave arguments into Elts.
153 for (unsigned n = 0; n != MaxSize; ++n)
154 for (unsigned i = 0, e = Expr->getNumArgs(); i != e; ++i)
155 if (n < Args[i].size())
156 Elts.insert(Args[i][n]);
160 // (sequence "Format", From, To) Generate a sequence of records by name.
161 struct SequenceOp : public SetTheory::Operator {
162 void apply(SetTheory &ST, DagInit *Expr, RecSet &Elts) {
164 if (Expr->arg_size() > 4)
165 throw "Bad args to (sequence \"Format\", From, To): " +
167 else if (Expr->arg_size() == 4) {
168 if (IntInit *II = dynamic_cast<IntInit*>(Expr->arg_begin()[3])) {
169 Step = II->getValue();
171 throw "Stride must be an integer: " + Expr->getAsString();
175 if (StringInit *SI = dynamic_cast<StringInit*>(Expr->arg_begin()[0]))
176 Format = SI->getValue();
178 throw "Format must be a string: " + Expr->getAsString();
181 if (IntInit *II = dynamic_cast<IntInit*>(Expr->arg_begin()[1]))
182 From = II->getValue();
184 throw "From must be an integer: " + Expr->getAsString();
185 if (From < 0 || From >= (1 << 30))
186 throw "From out of range";
188 if (IntInit *II = dynamic_cast<IntInit*>(Expr->arg_begin()[2]))
191 throw "From must be an integer: " + Expr->getAsString();
192 if (To < 0 || To >= (1 << 30))
193 throw "To out of range";
195 RecordKeeper &Records =
196 dynamic_cast<DefInit&>(*Expr->getOperator()).getDef()->getRecords();
198 Step *= From <= To ? 1 : -1;
200 if (Step > 0 && From > To)
202 else if (Step < 0 && From < To)
205 raw_string_ostream OS(Name);
206 OS << format(Format.c_str(), unsigned(From));
207 Record *Rec = Records.getDef(OS.str());
209 throw "No def named '" + Name + "': " + Expr->getAsString();
210 // Try to reevaluate Rec in case it is a set.
211 if (const RecVec *Result = ST.expand(Rec))
212 Elts.insert(Result->begin(), Result->end());
221 // Expand a Def into a set by evaluating one of its fields.
222 struct FieldExpander : public SetTheory::Expander {
225 FieldExpander(StringRef fn) : FieldName(fn) {}
227 void expand(SetTheory &ST, Record *Def, RecSet &Elts) {
228 ST.evaluate(Def->getValueInit(FieldName), Elts);
231 } // end anonymous namespace
233 void SetTheory::Operator::anchor() { }
235 void SetTheory::Expander::anchor() { }
237 SetTheory::SetTheory() {
238 addOperator("add", new AddOp);
239 addOperator("sub", new SubOp);
240 addOperator("and", new AndOp);
241 addOperator("shl", new ShlOp);
242 addOperator("trunc", new TruncOp);
243 addOperator("rotl", new RotOp(false));
244 addOperator("rotr", new RotOp(true));
245 addOperator("decimate", new DecimateOp);
246 addOperator("interleave", new InterleaveOp);
247 addOperator("sequence", new SequenceOp);
250 void SetTheory::addOperator(StringRef Name, Operator *Op) {
251 Operators[Name] = Op;
254 void SetTheory::addExpander(StringRef ClassName, Expander *E) {
255 Expanders[ClassName] = E;
258 void SetTheory::addFieldExpander(StringRef ClassName, StringRef FieldName) {
259 addExpander(ClassName, new FieldExpander(FieldName));
262 void SetTheory::evaluate(Init *Expr, RecSet &Elts) {
263 // A def in a list can be a just an element, or it may expand.
264 if (DefInit *Def = dynamic_cast<DefInit*>(Expr)) {
265 if (const RecVec *Result = expand(Def->getDef()))
266 return Elts.insert(Result->begin(), Result->end());
267 Elts.insert(Def->getDef());
271 // Lists simply expand.
272 if (ListInit *LI = dynamic_cast<ListInit*>(Expr))
273 return evaluate(LI->begin(), LI->end(), Elts);
275 // Anything else must be a DAG.
276 DagInit *DagExpr = dynamic_cast<DagInit*>(Expr);
278 throw "Invalid set element: " + Expr->getAsString();
279 DefInit *OpInit = dynamic_cast<DefInit*>(DagExpr->getOperator());
281 throw "Bad set expression: " + Expr->getAsString();
282 Operator *Op = Operators.lookup(OpInit->getDef()->getName());
284 throw "Unknown set operator: " + Expr->getAsString();
285 Op->apply(*this, DagExpr, Elts);
288 const RecVec *SetTheory::expand(Record *Set) {
289 // Check existing entries for Set and return early.
290 ExpandMap::iterator I = Expansions.find(Set);
291 if (I != Expansions.end())
294 // This is the first time we see Set. Find a suitable expander.
296 const std::vector<Record*> &SC = Set->getSuperClasses();
297 for (unsigned i = 0, e = SC.size(); i != e; ++i) {
298 // Skip unnamed superclasses.
299 if (!dynamic_cast<const StringInit *>(SC[i]->getNameInit()))
301 if (Expander *Exp = Expanders.lookup(SC[i]->getName())) {
302 // This breaks recursive definitions.
303 RecVec &EltVec = Expansions[Set];
305 Exp->expand(*this, Set, Elts);
306 EltVec.assign(Elts.begin(), Elts.end());
310 } catch (const std::string &Error) {
311 throw TGError(Set->getLoc(), Error);
314 // Set is not expandable.