]> CyberLeo.Net >> Repos - FreeBSD/releng/10.0.git/blob - contrib/llvm/utils/TableGen/CodeGenSchedule.cpp
- Copy stable/10 (r259064) to releng/10.0 as part of the
[FreeBSD/releng/10.0.git] / contrib / llvm / utils / TableGen / CodeGenSchedule.cpp
1 //===- CodeGenSchedule.cpp - Scheduling MachineModels ---------------------===//
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 defines structures to encapsulate the machine model as decribed in
11 // the target description.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #define DEBUG_TYPE "subtarget-emitter"
16
17 #include "CodeGenSchedule.h"
18 #include "CodeGenTarget.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/Support/Debug.h"
21 #include "llvm/Support/Regex.h"
22 #include "llvm/TableGen/Error.h"
23
24 using namespace llvm;
25
26 #ifndef NDEBUG
27 static void dumpIdxVec(const IdxVec &V) {
28   for (unsigned i = 0, e = V.size(); i < e; ++i) {
29     dbgs() << V[i] << ", ";
30   }
31 }
32 static void dumpIdxVec(const SmallVectorImpl<unsigned> &V) {
33   for (unsigned i = 0, e = V.size(); i < e; ++i) {
34     dbgs() << V[i] << ", ";
35   }
36 }
37 #endif
38
39 // (instrs a, b, ...) Evaluate and union all arguments. Identical to AddOp.
40 struct InstrsOp : public SetTheory::Operator {
41   void apply(SetTheory &ST, DagInit *Expr, SetTheory::RecSet &Elts,
42              ArrayRef<SMLoc> Loc) {
43     ST.evaluate(Expr->arg_begin(), Expr->arg_end(), Elts, Loc);
44   }
45 };
46
47 // (instregex "OpcPat",...) Find all instructions matching an opcode pattern.
48 //
49 // TODO: Since this is a prefix match, perform a binary search over the
50 // instruction names using lower_bound. Note that the predefined instrs must be
51 // scanned linearly first. However, this is only safe if the regex pattern has
52 // no top-level bars. The DAG already has a list of patterns, so there's no
53 // reason to use top-level bars, but we need a way to verify they don't exist
54 // before implementing the optimization.
55 struct InstRegexOp : public SetTheory::Operator {
56   const CodeGenTarget &Target;
57   InstRegexOp(const CodeGenTarget &t): Target(t) {}
58
59   void apply(SetTheory &ST, DagInit *Expr, SetTheory::RecSet &Elts,
60              ArrayRef<SMLoc> Loc) {
61     SmallVector<Regex*, 4> RegexList;
62     for (DagInit::const_arg_iterator
63            AI = Expr->arg_begin(), AE = Expr->arg_end(); AI != AE; ++AI) {
64       StringInit *SI = dyn_cast<StringInit>(*AI);
65       if (!SI)
66         PrintFatalError(Loc, "instregex requires pattern string: "
67           + Expr->getAsString());
68       std::string pat = SI->getValue();
69       // Implement a python-style prefix match.
70       if (pat[0] != '^') {
71         pat.insert(0, "^(");
72         pat.insert(pat.end(), ')');
73       }
74       RegexList.push_back(new Regex(pat));
75     }
76     for (CodeGenTarget::inst_iterator I = Target.inst_begin(),
77            E = Target.inst_end(); I != E; ++I) {
78       for (SmallVectorImpl<Regex*>::iterator
79              RI = RegexList.begin(), RE = RegexList.end(); RI != RE; ++RI) {
80         if ((*RI)->match((*I)->TheDef->getName()))
81           Elts.insert((*I)->TheDef);
82       }
83     }
84     DeleteContainerPointers(RegexList);
85   }
86 };
87
88 /// CodeGenModels ctor interprets machine model records and populates maps.
89 CodeGenSchedModels::CodeGenSchedModels(RecordKeeper &RK,
90                                        const CodeGenTarget &TGT):
91   Records(RK), Target(TGT) {
92
93   Sets.addFieldExpander("InstRW", "Instrs");
94
95   // Allow Set evaluation to recognize the dags used in InstRW records:
96   // (instrs Op1, Op1...)
97   Sets.addOperator("instrs", new InstrsOp);
98   Sets.addOperator("instregex", new InstRegexOp(Target));
99
100   // Instantiate a CodeGenProcModel for each SchedMachineModel with the values
101   // that are explicitly referenced in tablegen records. Resources associated
102   // with each processor will be derived later. Populate ProcModelMap with the
103   // CodeGenProcModel instances.
104   collectProcModels();
105
106   // Instantiate a CodeGenSchedRW for each SchedReadWrite record explicitly
107   // defined, and populate SchedReads and SchedWrites vectors. Implicit
108   // SchedReadWrites that represent sequences derived from expanded variant will
109   // be inferred later.
110   collectSchedRW();
111
112   // Instantiate a CodeGenSchedClass for each unique SchedRW signature directly
113   // required by an instruction definition, and populate SchedClassIdxMap. Set
114   // NumItineraryClasses to the number of explicit itinerary classes referenced
115   // by instructions. Set NumInstrSchedClasses to the number of itinerary
116   // classes plus any classes implied by instructions that derive from class
117   // Sched and provide SchedRW list. This does not infer any new classes from
118   // SchedVariant.
119   collectSchedClasses();
120
121   // Find instruction itineraries for each processor. Sort and populate
122   // CodeGenProcModel::ItinDefList. (Cycle-to-cycle itineraries). This requires
123   // all itinerary classes to be discovered.
124   collectProcItins();
125
126   // Find ItinRW records for each processor and itinerary class.
127   // (For per-operand resources mapped to itinerary classes).
128   collectProcItinRW();
129
130   // Infer new SchedClasses from SchedVariant.
131   inferSchedClasses();
132
133   // Populate each CodeGenProcModel's WriteResDefs, ReadAdvanceDefs, and
134   // ProcResourceDefs.
135   collectProcResources();
136 }
137
138 /// Gather all processor models.
139 void CodeGenSchedModels::collectProcModels() {
140   RecVec ProcRecords = Records.getAllDerivedDefinitions("Processor");
141   std::sort(ProcRecords.begin(), ProcRecords.end(), LessRecordFieldName());
142
143   // Reserve space because we can. Reallocation would be ok.
144   ProcModels.reserve(ProcRecords.size()+1);
145
146   // Use idx=0 for NoModel/NoItineraries.
147   Record *NoModelDef = Records.getDef("NoSchedModel");
148   Record *NoItinsDef = Records.getDef("NoItineraries");
149   ProcModels.push_back(CodeGenProcModel(0, "NoSchedModel",
150                                         NoModelDef, NoItinsDef));
151   ProcModelMap[NoModelDef] = 0;
152
153   // For each processor, find a unique machine model.
154   for (unsigned i = 0, N = ProcRecords.size(); i < N; ++i)
155     addProcModel(ProcRecords[i]);
156 }
157
158 /// Get a unique processor model based on the defined MachineModel and
159 /// ProcessorItineraries.
160 void CodeGenSchedModels::addProcModel(Record *ProcDef) {
161   Record *ModelKey = getModelOrItinDef(ProcDef);
162   if (!ProcModelMap.insert(std::make_pair(ModelKey, ProcModels.size())).second)
163     return;
164
165   std::string Name = ModelKey->getName();
166   if (ModelKey->isSubClassOf("SchedMachineModel")) {
167     Record *ItinsDef = ModelKey->getValueAsDef("Itineraries");
168     ProcModels.push_back(
169       CodeGenProcModel(ProcModels.size(), Name, ModelKey, ItinsDef));
170   }
171   else {
172     // An itinerary is defined without a machine model. Infer a new model.
173     if (!ModelKey->getValueAsListOfDefs("IID").empty())
174       Name = Name + "Model";
175     ProcModels.push_back(
176       CodeGenProcModel(ProcModels.size(), Name,
177                        ProcDef->getValueAsDef("SchedModel"), ModelKey));
178   }
179   DEBUG(ProcModels.back().dump());
180 }
181
182 // Recursively find all reachable SchedReadWrite records.
183 static void scanSchedRW(Record *RWDef, RecVec &RWDefs,
184                         SmallPtrSet<Record*, 16> &RWSet) {
185   if (!RWSet.insert(RWDef))
186     return;
187   RWDefs.push_back(RWDef);
188   // Reads don't current have sequence records, but it can be added later.
189   if (RWDef->isSubClassOf("WriteSequence")) {
190     RecVec Seq = RWDef->getValueAsListOfDefs("Writes");
191     for (RecIter I = Seq.begin(), E = Seq.end(); I != E; ++I)
192       scanSchedRW(*I, RWDefs, RWSet);
193   }
194   else if (RWDef->isSubClassOf("SchedVariant")) {
195     // Visit each variant (guarded by a different predicate).
196     RecVec Vars = RWDef->getValueAsListOfDefs("Variants");
197     for (RecIter VI = Vars.begin(), VE = Vars.end(); VI != VE; ++VI) {
198       // Visit each RW in the sequence selected by the current variant.
199       RecVec Selected = (*VI)->getValueAsListOfDefs("Selected");
200       for (RecIter I = Selected.begin(), E = Selected.end(); I != E; ++I)
201         scanSchedRW(*I, RWDefs, RWSet);
202     }
203   }
204 }
205
206 // Collect and sort all SchedReadWrites reachable via tablegen records.
207 // More may be inferred later when inferring new SchedClasses from variants.
208 void CodeGenSchedModels::collectSchedRW() {
209   // Reserve idx=0 for invalid writes/reads.
210   SchedWrites.resize(1);
211   SchedReads.resize(1);
212
213   SmallPtrSet<Record*, 16> RWSet;
214
215   // Find all SchedReadWrites referenced by instruction defs.
216   RecVec SWDefs, SRDefs;
217   for (CodeGenTarget::inst_iterator I = Target.inst_begin(),
218          E = Target.inst_end(); I != E; ++I) {
219     Record *SchedDef = (*I)->TheDef;
220     if (SchedDef->isValueUnset("SchedRW"))
221       continue;
222     RecVec RWs = SchedDef->getValueAsListOfDefs("SchedRW");
223     for (RecIter RWI = RWs.begin(), RWE = RWs.end(); RWI != RWE; ++RWI) {
224       if ((*RWI)->isSubClassOf("SchedWrite"))
225         scanSchedRW(*RWI, SWDefs, RWSet);
226       else {
227         assert((*RWI)->isSubClassOf("SchedRead") && "Unknown SchedReadWrite");
228         scanSchedRW(*RWI, SRDefs, RWSet);
229       }
230     }
231   }
232   // Find all ReadWrites referenced by InstRW.
233   RecVec InstRWDefs = Records.getAllDerivedDefinitions("InstRW");
234   for (RecIter OI = InstRWDefs.begin(), OE = InstRWDefs.end(); OI != OE; ++OI) {
235     // For all OperandReadWrites.
236     RecVec RWDefs = (*OI)->getValueAsListOfDefs("OperandReadWrites");
237     for (RecIter RWI = RWDefs.begin(), RWE = RWDefs.end();
238          RWI != RWE; ++RWI) {
239       if ((*RWI)->isSubClassOf("SchedWrite"))
240         scanSchedRW(*RWI, SWDefs, RWSet);
241       else {
242         assert((*RWI)->isSubClassOf("SchedRead") && "Unknown SchedReadWrite");
243         scanSchedRW(*RWI, SRDefs, RWSet);
244       }
245     }
246   }
247   // Find all ReadWrites referenced by ItinRW.
248   RecVec ItinRWDefs = Records.getAllDerivedDefinitions("ItinRW");
249   for (RecIter II = ItinRWDefs.begin(), IE = ItinRWDefs.end(); II != IE; ++II) {
250     // For all OperandReadWrites.
251     RecVec RWDefs = (*II)->getValueAsListOfDefs("OperandReadWrites");
252     for (RecIter RWI = RWDefs.begin(), RWE = RWDefs.end();
253          RWI != RWE; ++RWI) {
254       if ((*RWI)->isSubClassOf("SchedWrite"))
255         scanSchedRW(*RWI, SWDefs, RWSet);
256       else {
257         assert((*RWI)->isSubClassOf("SchedRead") && "Unknown SchedReadWrite");
258         scanSchedRW(*RWI, SRDefs, RWSet);
259       }
260     }
261   }
262   // Find all ReadWrites referenced by SchedAlias. AliasDefs needs to be sorted
263   // for the loop below that initializes Alias vectors.
264   RecVec AliasDefs = Records.getAllDerivedDefinitions("SchedAlias");
265   std::sort(AliasDefs.begin(), AliasDefs.end(), LessRecord());
266   for (RecIter AI = AliasDefs.begin(), AE = AliasDefs.end(); AI != AE; ++AI) {
267     Record *MatchDef = (*AI)->getValueAsDef("MatchRW");
268     Record *AliasDef = (*AI)->getValueAsDef("AliasRW");
269     if (MatchDef->isSubClassOf("SchedWrite")) {
270       if (!AliasDef->isSubClassOf("SchedWrite"))
271         PrintFatalError((*AI)->getLoc(), "SchedWrite Alias must be SchedWrite");
272       scanSchedRW(AliasDef, SWDefs, RWSet);
273     }
274     else {
275       assert(MatchDef->isSubClassOf("SchedRead") && "Unknown SchedReadWrite");
276       if (!AliasDef->isSubClassOf("SchedRead"))
277         PrintFatalError((*AI)->getLoc(), "SchedRead Alias must be SchedRead");
278       scanSchedRW(AliasDef, SRDefs, RWSet);
279     }
280   }
281   // Sort and add the SchedReadWrites directly referenced by instructions or
282   // itinerary resources. Index reads and writes in separate domains.
283   std::sort(SWDefs.begin(), SWDefs.end(), LessRecord());
284   for (RecIter SWI = SWDefs.begin(), SWE = SWDefs.end(); SWI != SWE; ++SWI) {
285     assert(!getSchedRWIdx(*SWI, /*IsRead=*/false) && "duplicate SchedWrite");
286     SchedWrites.push_back(CodeGenSchedRW(SchedWrites.size(), *SWI));
287   }
288   std::sort(SRDefs.begin(), SRDefs.end(), LessRecord());
289   for (RecIter SRI = SRDefs.begin(), SRE = SRDefs.end(); SRI != SRE; ++SRI) {
290     assert(!getSchedRWIdx(*SRI, /*IsRead-*/true) && "duplicate SchedWrite");
291     SchedReads.push_back(CodeGenSchedRW(SchedReads.size(), *SRI));
292   }
293   // Initialize WriteSequence vectors.
294   for (std::vector<CodeGenSchedRW>::iterator WI = SchedWrites.begin(),
295          WE = SchedWrites.end(); WI != WE; ++WI) {
296     if (!WI->IsSequence)
297       continue;
298     findRWs(WI->TheDef->getValueAsListOfDefs("Writes"), WI->Sequence,
299             /*IsRead=*/false);
300   }
301   // Initialize Aliases vectors.
302   for (RecIter AI = AliasDefs.begin(), AE = AliasDefs.end(); AI != AE; ++AI) {
303     Record *AliasDef = (*AI)->getValueAsDef("AliasRW");
304     getSchedRW(AliasDef).IsAlias = true;
305     Record *MatchDef = (*AI)->getValueAsDef("MatchRW");
306     CodeGenSchedRW &RW = getSchedRW(MatchDef);
307     if (RW.IsAlias)
308       PrintFatalError((*AI)->getLoc(), "Cannot Alias an Alias");
309     RW.Aliases.push_back(*AI);
310   }
311   DEBUG(
312     for (unsigned WIdx = 0, WEnd = SchedWrites.size(); WIdx != WEnd; ++WIdx) {
313       dbgs() << WIdx << ": ";
314       SchedWrites[WIdx].dump();
315       dbgs() << '\n';
316     }
317     for (unsigned RIdx = 0, REnd = SchedReads.size(); RIdx != REnd; ++RIdx) {
318       dbgs() << RIdx << ": ";
319       SchedReads[RIdx].dump();
320       dbgs() << '\n';
321     }
322     RecVec RWDefs = Records.getAllDerivedDefinitions("SchedReadWrite");
323     for (RecIter RI = RWDefs.begin(), RE = RWDefs.end();
324          RI != RE; ++RI) {
325       if (!getSchedRWIdx(*RI, (*RI)->isSubClassOf("SchedRead"))) {
326         const std::string &Name = (*RI)->getName();
327         if (Name != "NoWrite" && Name != "ReadDefault")
328           dbgs() << "Unused SchedReadWrite " << (*RI)->getName() << '\n';
329       }
330     });
331 }
332
333 /// Compute a SchedWrite name from a sequence of writes.
334 std::string CodeGenSchedModels::genRWName(const IdxVec& Seq, bool IsRead) {
335   std::string Name("(");
336   for (IdxIter I = Seq.begin(), E = Seq.end(); I != E; ++I) {
337     if (I != Seq.begin())
338       Name += '_';
339     Name += getSchedRW(*I, IsRead).Name;
340   }
341   Name += ')';
342   return Name;
343 }
344
345 unsigned CodeGenSchedModels::getSchedRWIdx(Record *Def, bool IsRead,
346                                            unsigned After) const {
347   const std::vector<CodeGenSchedRW> &RWVec = IsRead ? SchedReads : SchedWrites;
348   assert(After < RWVec.size() && "start position out of bounds");
349   for (std::vector<CodeGenSchedRW>::const_iterator I = RWVec.begin() + After,
350          E = RWVec.end(); I != E; ++I) {
351     if (I->TheDef == Def)
352       return I - RWVec.begin();
353   }
354   return 0;
355 }
356
357 bool CodeGenSchedModels::hasReadOfWrite(Record *WriteDef) const {
358   for (unsigned i = 0, e = SchedReads.size(); i < e; ++i) {
359     Record *ReadDef = SchedReads[i].TheDef;
360     if (!ReadDef || !ReadDef->isSubClassOf("ProcReadAdvance"))
361       continue;
362
363     RecVec ValidWrites = ReadDef->getValueAsListOfDefs("ValidWrites");
364     if (std::find(ValidWrites.begin(), ValidWrites.end(), WriteDef)
365         != ValidWrites.end()) {
366       return true;
367     }
368   }
369   return false;
370 }
371
372 namespace llvm {
373 void splitSchedReadWrites(const RecVec &RWDefs,
374                           RecVec &WriteDefs, RecVec &ReadDefs) {
375   for (RecIter RWI = RWDefs.begin(), RWE = RWDefs.end(); RWI != RWE; ++RWI) {
376     if ((*RWI)->isSubClassOf("SchedWrite"))
377       WriteDefs.push_back(*RWI);
378     else {
379       assert((*RWI)->isSubClassOf("SchedRead") && "unknown SchedReadWrite");
380       ReadDefs.push_back(*RWI);
381     }
382   }
383 }
384 } // namespace llvm
385
386 // Split the SchedReadWrites defs and call findRWs for each list.
387 void CodeGenSchedModels::findRWs(const RecVec &RWDefs,
388                                  IdxVec &Writes, IdxVec &Reads) const {
389     RecVec WriteDefs;
390     RecVec ReadDefs;
391     splitSchedReadWrites(RWDefs, WriteDefs, ReadDefs);
392     findRWs(WriteDefs, Writes, false);
393     findRWs(ReadDefs, Reads, true);
394 }
395
396 // Call getSchedRWIdx for all elements in a sequence of SchedRW defs.
397 void CodeGenSchedModels::findRWs(const RecVec &RWDefs, IdxVec &RWs,
398                                  bool IsRead) const {
399   for (RecIter RI = RWDefs.begin(), RE = RWDefs.end(); RI != RE; ++RI) {
400     unsigned Idx = getSchedRWIdx(*RI, IsRead);
401     assert(Idx && "failed to collect SchedReadWrite");
402     RWs.push_back(Idx);
403   }
404 }
405
406 void CodeGenSchedModels::expandRWSequence(unsigned RWIdx, IdxVec &RWSeq,
407                                           bool IsRead) const {
408   const CodeGenSchedRW &SchedRW = getSchedRW(RWIdx, IsRead);
409   if (!SchedRW.IsSequence) {
410     RWSeq.push_back(RWIdx);
411     return;
412   }
413   int Repeat =
414     SchedRW.TheDef ? SchedRW.TheDef->getValueAsInt("Repeat") : 1;
415   for (int i = 0; i < Repeat; ++i) {
416     for (IdxIter I = SchedRW.Sequence.begin(), E = SchedRW.Sequence.end();
417          I != E; ++I) {
418       expandRWSequence(*I, RWSeq, IsRead);
419     }
420   }
421 }
422
423 // Expand a SchedWrite as a sequence following any aliases that coincide with
424 // the given processor model.
425 void CodeGenSchedModels::expandRWSeqForProc(
426   unsigned RWIdx, IdxVec &RWSeq, bool IsRead,
427   const CodeGenProcModel &ProcModel) const {
428
429   const CodeGenSchedRW &SchedWrite = getSchedRW(RWIdx, IsRead);
430   Record *AliasDef = 0;
431   for (RecIter AI = SchedWrite.Aliases.begin(), AE = SchedWrite.Aliases.end();
432        AI != AE; ++AI) {
433     const CodeGenSchedRW &AliasRW = getSchedRW((*AI)->getValueAsDef("AliasRW"));
434     if ((*AI)->getValueInit("SchedModel")->isComplete()) {
435       Record *ModelDef = (*AI)->getValueAsDef("SchedModel");
436       if (&getProcModel(ModelDef) != &ProcModel)
437         continue;
438     }
439     if (AliasDef)
440       PrintFatalError(AliasRW.TheDef->getLoc(), "Multiple aliases "
441                       "defined for processor " + ProcModel.ModelName +
442                       " Ensure only one SchedAlias exists per RW.");
443     AliasDef = AliasRW.TheDef;
444   }
445   if (AliasDef) {
446     expandRWSeqForProc(getSchedRWIdx(AliasDef, IsRead),
447                        RWSeq, IsRead,ProcModel);
448     return;
449   }
450   if (!SchedWrite.IsSequence) {
451     RWSeq.push_back(RWIdx);
452     return;
453   }
454   int Repeat =
455     SchedWrite.TheDef ? SchedWrite.TheDef->getValueAsInt("Repeat") : 1;
456   for (int i = 0; i < Repeat; ++i) {
457     for (IdxIter I = SchedWrite.Sequence.begin(), E = SchedWrite.Sequence.end();
458          I != E; ++I) {
459       expandRWSeqForProc(*I, RWSeq, IsRead, ProcModel);
460     }
461   }
462 }
463
464 // Find the existing SchedWrite that models this sequence of writes.
465 unsigned CodeGenSchedModels::findRWForSequence(const IdxVec &Seq,
466                                                bool IsRead) {
467   std::vector<CodeGenSchedRW> &RWVec = IsRead ? SchedReads : SchedWrites;
468
469   for (std::vector<CodeGenSchedRW>::iterator I = RWVec.begin(), E = RWVec.end();
470        I != E; ++I) {
471     if (I->Sequence == Seq)
472       return I - RWVec.begin();
473   }
474   // Index zero reserved for invalid RW.
475   return 0;
476 }
477
478 /// Add this ReadWrite if it doesn't already exist.
479 unsigned CodeGenSchedModels::findOrInsertRW(ArrayRef<unsigned> Seq,
480                                             bool IsRead) {
481   assert(!Seq.empty() && "cannot insert empty sequence");
482   if (Seq.size() == 1)
483     return Seq.back();
484
485   unsigned Idx = findRWForSequence(Seq, IsRead);
486   if (Idx)
487     return Idx;
488
489   unsigned RWIdx = IsRead ? SchedReads.size() : SchedWrites.size();
490   CodeGenSchedRW SchedRW(RWIdx, IsRead, Seq, genRWName(Seq, IsRead));
491   if (IsRead)
492     SchedReads.push_back(SchedRW);
493   else
494     SchedWrites.push_back(SchedRW);
495   return RWIdx;
496 }
497
498 /// Visit all the instruction definitions for this target to gather and
499 /// enumerate the itinerary classes. These are the explicitly specified
500 /// SchedClasses. More SchedClasses may be inferred.
501 void CodeGenSchedModels::collectSchedClasses() {
502
503   // NoItinerary is always the first class at Idx=0
504   SchedClasses.resize(1);
505   SchedClasses.back().Index = 0;
506   SchedClasses.back().Name = "NoInstrModel";
507   SchedClasses.back().ItinClassDef = Records.getDef("NoItinerary");
508   SchedClasses.back().ProcIndices.push_back(0);
509
510   // Create a SchedClass for each unique combination of itinerary class and
511   // SchedRW list.
512   for (CodeGenTarget::inst_iterator I = Target.inst_begin(),
513          E = Target.inst_end(); I != E; ++I) {
514     Record *ItinDef = (*I)->TheDef->getValueAsDef("Itinerary");
515     IdxVec Writes, Reads;
516     if (!(*I)->TheDef->isValueUnset("SchedRW"))
517       findRWs((*I)->TheDef->getValueAsListOfDefs("SchedRW"), Writes, Reads);
518
519     // ProcIdx == 0 indicates the class applies to all processors.
520     IdxVec ProcIndices(1, 0);
521
522     unsigned SCIdx = addSchedClass(ItinDef, Writes, Reads, ProcIndices);
523     InstrClassMap[(*I)->TheDef] = SCIdx;
524   }
525   // Create classes for InstRW defs.
526   RecVec InstRWDefs = Records.getAllDerivedDefinitions("InstRW");
527   std::sort(InstRWDefs.begin(), InstRWDefs.end(), LessRecord());
528   for (RecIter OI = InstRWDefs.begin(), OE = InstRWDefs.end(); OI != OE; ++OI)
529     createInstRWClass(*OI);
530
531   NumInstrSchedClasses = SchedClasses.size();
532
533   bool EnableDump = false;
534   DEBUG(EnableDump = true);
535   if (!EnableDump)
536     return;
537
538   for (CodeGenTarget::inst_iterator I = Target.inst_begin(),
539          E = Target.inst_end(); I != E; ++I) {
540
541     std::string InstName = (*I)->TheDef->getName();
542     unsigned SCIdx = InstrClassMap.lookup((*I)->TheDef);
543     if (!SCIdx) {
544       dbgs() << "No machine model for " << (*I)->TheDef->getName() << '\n';
545       continue;
546     }
547     CodeGenSchedClass &SC = getSchedClass(SCIdx);
548     if (SC.ProcIndices[0] != 0)
549       PrintFatalError((*I)->TheDef->getLoc(), "Instruction's sched class "
550                       "must not be subtarget specific.");
551
552     IdxVec ProcIndices;
553     if (SC.ItinClassDef->getName() != "NoItinerary") {
554       ProcIndices.push_back(0);
555       dbgs() << "Itinerary for " << InstName << ": "
556              << SC.ItinClassDef->getName() << '\n';
557     }
558     if (!SC.Writes.empty()) {
559       ProcIndices.push_back(0);
560       dbgs() << "SchedRW machine model for " << InstName;
561       for (IdxIter WI = SC.Writes.begin(), WE = SC.Writes.end(); WI != WE; ++WI)
562         dbgs() << " " << SchedWrites[*WI].Name;
563       for (IdxIter RI = SC.Reads.begin(), RE = SC.Reads.end(); RI != RE; ++RI)
564         dbgs() << " " << SchedReads[*RI].Name;
565       dbgs() << '\n';
566     }
567     const RecVec &RWDefs = SchedClasses[SCIdx].InstRWs;
568     for (RecIter RWI = RWDefs.begin(), RWE = RWDefs.end();
569          RWI != RWE; ++RWI) {
570       const CodeGenProcModel &ProcModel =
571         getProcModel((*RWI)->getValueAsDef("SchedModel"));
572       ProcIndices.push_back(ProcModel.Index);
573       dbgs() << "InstRW on " << ProcModel.ModelName << " for " << InstName;
574       IdxVec Writes;
575       IdxVec Reads;
576       findRWs((*RWI)->getValueAsListOfDefs("OperandReadWrites"),
577               Writes, Reads);
578       for (IdxIter WI = Writes.begin(), WE = Writes.end(); WI != WE; ++WI)
579         dbgs() << " " << SchedWrites[*WI].Name;
580       for (IdxIter RI = Reads.begin(), RE = Reads.end(); RI != RE; ++RI)
581         dbgs() << " " << SchedReads[*RI].Name;
582       dbgs() << '\n';
583     }
584     for (std::vector<CodeGenProcModel>::iterator PI = ProcModels.begin(),
585            PE = ProcModels.end(); PI != PE; ++PI) {
586       if (!std::count(ProcIndices.begin(), ProcIndices.end(), PI->Index))
587         dbgs() << "No machine model for " << (*I)->TheDef->getName()
588                << " on processor " << PI->ModelName << '\n';
589     }
590   }
591 }
592
593 /// Find an SchedClass that has been inferred from a per-operand list of
594 /// SchedWrites and SchedReads.
595 unsigned CodeGenSchedModels::findSchedClassIdx(Record *ItinClassDef,
596                                                const IdxVec &Writes,
597                                                const IdxVec &Reads) const {
598   for (SchedClassIter I = schedClassBegin(), E = schedClassEnd(); I != E; ++I) {
599     if (I->ItinClassDef == ItinClassDef
600         && I->Writes == Writes && I->Reads == Reads) {
601       return I - schedClassBegin();
602     }
603   }
604   return 0;
605 }
606
607 // Get the SchedClass index for an instruction.
608 unsigned CodeGenSchedModels::getSchedClassIdx(
609   const CodeGenInstruction &Inst) const {
610
611   return InstrClassMap.lookup(Inst.TheDef);
612 }
613
614 std::string CodeGenSchedModels::createSchedClassName(
615   Record *ItinClassDef, const IdxVec &OperWrites, const IdxVec &OperReads) {
616
617   std::string Name;
618   if (ItinClassDef && ItinClassDef->getName() != "NoItinerary")
619     Name = ItinClassDef->getName();
620   for (IdxIter WI = OperWrites.begin(), WE = OperWrites.end(); WI != WE; ++WI) {
621     if (!Name.empty())
622       Name += '_';
623     Name += SchedWrites[*WI].Name;
624   }
625   for (IdxIter RI = OperReads.begin(), RE = OperReads.end(); RI != RE; ++RI) {
626     Name += '_';
627     Name += SchedReads[*RI].Name;
628   }
629   return Name;
630 }
631
632 std::string CodeGenSchedModels::createSchedClassName(const RecVec &InstDefs) {
633
634   std::string Name;
635   for (RecIter I = InstDefs.begin(), E = InstDefs.end(); I != E; ++I) {
636     if (I != InstDefs.begin())
637       Name += '_';
638     Name += (*I)->getName();
639   }
640   return Name;
641 }
642
643 /// Add an inferred sched class from an itinerary class and per-operand list of
644 /// SchedWrites and SchedReads. ProcIndices contains the set of IDs of
645 /// processors that may utilize this class.
646 unsigned CodeGenSchedModels::addSchedClass(Record *ItinClassDef,
647                                            const IdxVec &OperWrites,
648                                            const IdxVec &OperReads,
649                                            const IdxVec &ProcIndices)
650 {
651   assert(!ProcIndices.empty() && "expect at least one ProcIdx");
652
653   unsigned Idx = findSchedClassIdx(ItinClassDef, OperWrites, OperReads);
654   if (Idx || SchedClasses[0].isKeyEqual(ItinClassDef, OperWrites, OperReads)) {
655     IdxVec PI;
656     std::set_union(SchedClasses[Idx].ProcIndices.begin(),
657                    SchedClasses[Idx].ProcIndices.end(),
658                    ProcIndices.begin(), ProcIndices.end(),
659                    std::back_inserter(PI));
660     SchedClasses[Idx].ProcIndices.swap(PI);
661     return Idx;
662   }
663   Idx = SchedClasses.size();
664   SchedClasses.resize(Idx+1);
665   CodeGenSchedClass &SC = SchedClasses.back();
666   SC.Index = Idx;
667   SC.Name = createSchedClassName(ItinClassDef, OperWrites, OperReads);
668   SC.ItinClassDef = ItinClassDef;
669   SC.Writes = OperWrites;
670   SC.Reads = OperReads;
671   SC.ProcIndices = ProcIndices;
672
673   return Idx;
674 }
675
676 // Create classes for each set of opcodes that are in the same InstReadWrite
677 // definition across all processors.
678 void CodeGenSchedModels::createInstRWClass(Record *InstRWDef) {
679   // ClassInstrs will hold an entry for each subset of Instrs in InstRWDef that
680   // intersects with an existing class via a previous InstRWDef. Instrs that do
681   // not intersect with an existing class refer back to their former class as
682   // determined from ItinDef or SchedRW.
683   SmallVector<std::pair<unsigned, SmallVector<Record *, 8> >, 4> ClassInstrs;
684   // Sort Instrs into sets.
685   const RecVec *InstDefs = Sets.expand(InstRWDef);
686   if (InstDefs->empty())
687     PrintFatalError(InstRWDef->getLoc(), "No matching instruction opcodes");
688
689   for (RecIter I = InstDefs->begin(), E = InstDefs->end(); I != E; ++I) {
690     InstClassMapTy::const_iterator Pos = InstrClassMap.find(*I);
691     if (Pos == InstrClassMap.end())
692       PrintFatalError((*I)->getLoc(), "No sched class for instruction.");
693     unsigned SCIdx = Pos->second;
694     unsigned CIdx = 0, CEnd = ClassInstrs.size();
695     for (; CIdx != CEnd; ++CIdx) {
696       if (ClassInstrs[CIdx].first == SCIdx)
697         break;
698     }
699     if (CIdx == CEnd) {
700       ClassInstrs.resize(CEnd + 1);
701       ClassInstrs[CIdx].first = SCIdx;
702     }
703     ClassInstrs[CIdx].second.push_back(*I);
704   }
705   // For each set of Instrs, create a new class if necessary, and map or remap
706   // the Instrs to it.
707   unsigned CIdx = 0, CEnd = ClassInstrs.size();
708   for (; CIdx != CEnd; ++CIdx) {
709     unsigned OldSCIdx = ClassInstrs[CIdx].first;
710     ArrayRef<Record*> InstDefs = ClassInstrs[CIdx].second;
711     // If the all instrs in the current class are accounted for, then leave
712     // them mapped to their old class.
713     if (OldSCIdx && SchedClasses[OldSCIdx].InstRWs.size() == InstDefs.size()) {
714       assert(SchedClasses[OldSCIdx].ProcIndices[0] == 0 &&
715              "expected a generic SchedClass");
716       continue;
717     }
718     unsigned SCIdx = SchedClasses.size();
719     SchedClasses.resize(SCIdx+1);
720     CodeGenSchedClass &SC = SchedClasses.back();
721     SC.Index = SCIdx;
722     SC.Name = createSchedClassName(InstDefs);
723     // Preserve ItinDef and Writes/Reads for processors without an InstRW entry.
724     SC.ItinClassDef = SchedClasses[OldSCIdx].ItinClassDef;
725     SC.Writes = SchedClasses[OldSCIdx].Writes;
726     SC.Reads = SchedClasses[OldSCIdx].Reads;
727     SC.ProcIndices.push_back(0);
728     // Map each Instr to this new class.
729     // Note that InstDefs may be a smaller list than InstRWDef's "Instrs".
730     Record *RWModelDef = InstRWDef->getValueAsDef("SchedModel");
731     SmallSet<unsigned, 4> RemappedClassIDs;
732     for (ArrayRef<Record*>::const_iterator
733            II = InstDefs.begin(), IE = InstDefs.end(); II != IE; ++II) {
734       unsigned OldSCIdx = InstrClassMap[*II];
735       if (OldSCIdx && RemappedClassIDs.insert(OldSCIdx)) {
736         for (RecIter RI = SchedClasses[OldSCIdx].InstRWs.begin(),
737                RE = SchedClasses[OldSCIdx].InstRWs.end(); RI != RE; ++RI) {
738           if ((*RI)->getValueAsDef("SchedModel") == RWModelDef) {
739             PrintFatalError(InstRWDef->getLoc(), "Overlapping InstRW def " +
740                           (*II)->getName() + " also matches " +
741                           (*RI)->getValue("Instrs")->getValue()->getAsString());
742           }
743           assert(*RI != InstRWDef && "SchedClass has duplicate InstRW def");
744           SC.InstRWs.push_back(*RI);
745         }
746       }
747       InstrClassMap[*II] = SCIdx;
748     }
749     SC.InstRWs.push_back(InstRWDef);
750   }
751 }
752
753 // True if collectProcItins found anything.
754 bool CodeGenSchedModels::hasItineraries() const {
755   for (CodeGenSchedModels::ProcIter PI = procModelBegin(), PE = procModelEnd();
756        PI != PE; ++PI) {
757     if (PI->hasItineraries())
758       return true;
759   }
760   return false;
761 }
762
763 // Gather the processor itineraries.
764 void CodeGenSchedModels::collectProcItins() {
765   for (std::vector<CodeGenProcModel>::iterator PI = ProcModels.begin(),
766          PE = ProcModels.end(); PI != PE; ++PI) {
767     CodeGenProcModel &ProcModel = *PI;
768     if (!ProcModel.hasItineraries())
769       continue;
770
771     RecVec ItinRecords = ProcModel.ItinsDef->getValueAsListOfDefs("IID");
772     assert(!ItinRecords.empty() && "ProcModel.hasItineraries is incorrect");
773
774     // Populate ItinDefList with Itinerary records.
775     ProcModel.ItinDefList.resize(NumInstrSchedClasses);
776
777     // Insert each itinerary data record in the correct position within
778     // the processor model's ItinDefList.
779     for (unsigned i = 0, N = ItinRecords.size(); i < N; i++) {
780       Record *ItinData = ItinRecords[i];
781       Record *ItinDef = ItinData->getValueAsDef("TheClass");
782       bool FoundClass = false;
783       for (SchedClassIter SCI = schedClassBegin(), SCE = schedClassEnd();
784            SCI != SCE; ++SCI) {
785         // Multiple SchedClasses may share an itinerary. Update all of them.
786         if (SCI->ItinClassDef == ItinDef) {
787           ProcModel.ItinDefList[SCI->Index] = ItinData;
788           FoundClass = true;
789         }
790       }
791       if (!FoundClass) {
792         DEBUG(dbgs() << ProcModel.ItinsDef->getName()
793               << " missing class for itinerary " << ItinDef->getName() << '\n');
794       }
795     }
796     // Check for missing itinerary entries.
797     assert(!ProcModel.ItinDefList[0] && "NoItinerary class can't have rec");
798     DEBUG(
799       for (unsigned i = 1, N = ProcModel.ItinDefList.size(); i < N; ++i) {
800         if (!ProcModel.ItinDefList[i])
801           dbgs() << ProcModel.ItinsDef->getName()
802                  << " missing itinerary for class "
803                  << SchedClasses[i].Name << '\n';
804       });
805   }
806 }
807
808 // Gather the read/write types for each itinerary class.
809 void CodeGenSchedModels::collectProcItinRW() {
810   RecVec ItinRWDefs = Records.getAllDerivedDefinitions("ItinRW");
811   std::sort(ItinRWDefs.begin(), ItinRWDefs.end(), LessRecord());
812   for (RecIter II = ItinRWDefs.begin(), IE = ItinRWDefs.end(); II != IE; ++II) {
813     if (!(*II)->getValueInit("SchedModel")->isComplete())
814       PrintFatalError((*II)->getLoc(), "SchedModel is undefined");
815     Record *ModelDef = (*II)->getValueAsDef("SchedModel");
816     ProcModelMapTy::const_iterator I = ProcModelMap.find(ModelDef);
817     if (I == ProcModelMap.end()) {
818       PrintFatalError((*II)->getLoc(), "Undefined SchedMachineModel "
819                     + ModelDef->getName());
820     }
821     ProcModels[I->second].ItinRWDefs.push_back(*II);
822   }
823 }
824
825 /// Infer new classes from existing classes. In the process, this may create new
826 /// SchedWrites from sequences of existing SchedWrites.
827 void CodeGenSchedModels::inferSchedClasses() {
828   DEBUG(dbgs() << NumInstrSchedClasses << " instr sched classes.\n");
829
830   // Visit all existing classes and newly created classes.
831   for (unsigned Idx = 0; Idx != SchedClasses.size(); ++Idx) {
832     assert(SchedClasses[Idx].Index == Idx && "bad SCIdx");
833
834     if (SchedClasses[Idx].ItinClassDef)
835       inferFromItinClass(SchedClasses[Idx].ItinClassDef, Idx);
836     if (!SchedClasses[Idx].InstRWs.empty())
837       inferFromInstRWs(Idx);
838     if (!SchedClasses[Idx].Writes.empty()) {
839       inferFromRW(SchedClasses[Idx].Writes, SchedClasses[Idx].Reads,
840                   Idx, SchedClasses[Idx].ProcIndices);
841     }
842     assert(SchedClasses.size() < (NumInstrSchedClasses*6) &&
843            "too many SchedVariants");
844   }
845 }
846
847 /// Infer classes from per-processor itinerary resources.
848 void CodeGenSchedModels::inferFromItinClass(Record *ItinClassDef,
849                                             unsigned FromClassIdx) {
850   for (unsigned PIdx = 0, PEnd = ProcModels.size(); PIdx != PEnd; ++PIdx) {
851     const CodeGenProcModel &PM = ProcModels[PIdx];
852     // For all ItinRW entries.
853     bool HasMatch = false;
854     for (RecIter II = PM.ItinRWDefs.begin(), IE = PM.ItinRWDefs.end();
855          II != IE; ++II) {
856       RecVec Matched = (*II)->getValueAsListOfDefs("MatchedItinClasses");
857       if (!std::count(Matched.begin(), Matched.end(), ItinClassDef))
858         continue;
859       if (HasMatch)
860         PrintFatalError((*II)->getLoc(), "Duplicate itinerary class "
861                       + ItinClassDef->getName()
862                       + " in ItinResources for " + PM.ModelName);
863       HasMatch = true;
864       IdxVec Writes, Reads;
865       findRWs((*II)->getValueAsListOfDefs("OperandReadWrites"), Writes, Reads);
866       IdxVec ProcIndices(1, PIdx);
867       inferFromRW(Writes, Reads, FromClassIdx, ProcIndices);
868     }
869   }
870 }
871
872 /// Infer classes from per-processor InstReadWrite definitions.
873 void CodeGenSchedModels::inferFromInstRWs(unsigned SCIdx) {
874   const RecVec &RWDefs = SchedClasses[SCIdx].InstRWs;
875   for (RecIter RWI = RWDefs.begin(), RWE = RWDefs.end(); RWI != RWE; ++RWI) {
876     const RecVec *InstDefs = Sets.expand(*RWI);
877     RecIter II = InstDefs->begin(), IE = InstDefs->end();
878     for (; II != IE; ++II) {
879       if (InstrClassMap[*II] == SCIdx)
880         break;
881     }
882     // If this class no longer has any instructions mapped to it, it has become
883     // irrelevant.
884     if (II == IE)
885       continue;
886     IdxVec Writes, Reads;
887     findRWs((*RWI)->getValueAsListOfDefs("OperandReadWrites"), Writes, Reads);
888     unsigned PIdx = getProcModel((*RWI)->getValueAsDef("SchedModel")).Index;
889     IdxVec ProcIndices(1, PIdx);
890     inferFromRW(Writes, Reads, SCIdx, ProcIndices);
891   }
892 }
893
894 namespace {
895 // Helper for substituteVariantOperand.
896 struct TransVariant {
897   Record *VarOrSeqDef;  // Variant or sequence.
898   unsigned RWIdx;       // Index of this variant or sequence's matched type.
899   unsigned ProcIdx;     // Processor model index or zero for any.
900   unsigned TransVecIdx; // Index into PredTransitions::TransVec.
901
902   TransVariant(Record *def, unsigned rwi, unsigned pi, unsigned ti):
903     VarOrSeqDef(def), RWIdx(rwi), ProcIdx(pi), TransVecIdx(ti) {}
904 };
905
906 // Associate a predicate with the SchedReadWrite that it guards.
907 // RWIdx is the index of the read/write variant.
908 struct PredCheck {
909   bool IsRead;
910   unsigned RWIdx;
911   Record *Predicate;
912
913   PredCheck(bool r, unsigned w, Record *p): IsRead(r), RWIdx(w), Predicate(p) {}
914 };
915
916 // A Predicate transition is a list of RW sequences guarded by a PredTerm.
917 struct PredTransition {
918   // A predicate term is a conjunction of PredChecks.
919   SmallVector<PredCheck, 4> PredTerm;
920   SmallVector<SmallVector<unsigned,4>, 16> WriteSequences;
921   SmallVector<SmallVector<unsigned,4>, 16> ReadSequences;
922   SmallVector<unsigned, 4> ProcIndices;
923 };
924
925 // Encapsulate a set of partially constructed transitions.
926 // The results are built by repeated calls to substituteVariants.
927 class PredTransitions {
928   CodeGenSchedModels &SchedModels;
929
930 public:
931   std::vector<PredTransition> TransVec;
932
933   PredTransitions(CodeGenSchedModels &sm): SchedModels(sm) {}
934
935   void substituteVariantOperand(const SmallVectorImpl<unsigned> &RWSeq,
936                                 bool IsRead, unsigned StartIdx);
937
938   void substituteVariants(const PredTransition &Trans);
939
940 #ifndef NDEBUG
941   void dump() const;
942 #endif
943
944 private:
945   bool mutuallyExclusive(Record *PredDef, ArrayRef<PredCheck> Term);
946   void getIntersectingVariants(
947     const CodeGenSchedRW &SchedRW, unsigned TransIdx,
948     std::vector<TransVariant> &IntersectingVariants);
949   void pushVariant(const TransVariant &VInfo, bool IsRead);
950 };
951 } // anonymous
952
953 // Return true if this predicate is mutually exclusive with a PredTerm. This
954 // degenerates into checking if the predicate is mutually exclusive with any
955 // predicate in the Term's conjunction.
956 //
957 // All predicates associated with a given SchedRW are considered mutually
958 // exclusive. This should work even if the conditions expressed by the
959 // predicates are not exclusive because the predicates for a given SchedWrite
960 // are always checked in the order they are defined in the .td file. Later
961 // conditions implicitly negate any prior condition.
962 bool PredTransitions::mutuallyExclusive(Record *PredDef,
963                                         ArrayRef<PredCheck> Term) {
964
965   for (ArrayRef<PredCheck>::iterator I = Term.begin(), E = Term.end();
966        I != E; ++I) {
967     if (I->Predicate == PredDef)
968       return false;
969
970     const CodeGenSchedRW &SchedRW = SchedModels.getSchedRW(I->RWIdx, I->IsRead);
971     assert(SchedRW.HasVariants && "PredCheck must refer to a SchedVariant");
972     RecVec Variants = SchedRW.TheDef->getValueAsListOfDefs("Variants");
973     for (RecIter VI = Variants.begin(), VE = Variants.end(); VI != VE; ++VI) {
974       if ((*VI)->getValueAsDef("Predicate") == PredDef)
975         return true;
976     }
977   }
978   return false;
979 }
980
981 static bool hasAliasedVariants(const CodeGenSchedRW &RW,
982                                CodeGenSchedModels &SchedModels) {
983   if (RW.HasVariants)
984     return true;
985
986   for (RecIter I = RW.Aliases.begin(), E = RW.Aliases.end(); I != E; ++I) {
987     const CodeGenSchedRW &AliasRW =
988       SchedModels.getSchedRW((*I)->getValueAsDef("AliasRW"));
989     if (AliasRW.HasVariants)
990       return true;
991     if (AliasRW.IsSequence) {
992       IdxVec ExpandedRWs;
993       SchedModels.expandRWSequence(AliasRW.Index, ExpandedRWs, AliasRW.IsRead);
994       for (IdxIter SI = ExpandedRWs.begin(), SE = ExpandedRWs.end();
995            SI != SE; ++SI) {
996         if (hasAliasedVariants(SchedModels.getSchedRW(*SI, AliasRW.IsRead),
997                                SchedModels)) {
998           return true;
999         }
1000       }
1001     }
1002   }
1003   return false;
1004 }
1005
1006 static bool hasVariant(ArrayRef<PredTransition> Transitions,
1007                        CodeGenSchedModels &SchedModels) {
1008   for (ArrayRef<PredTransition>::iterator
1009          PTI = Transitions.begin(), PTE = Transitions.end();
1010        PTI != PTE; ++PTI) {
1011     for (SmallVectorImpl<SmallVector<unsigned,4> >::const_iterator
1012            WSI = PTI->WriteSequences.begin(), WSE = PTI->WriteSequences.end();
1013          WSI != WSE; ++WSI) {
1014       for (SmallVectorImpl<unsigned>::const_iterator
1015              WI = WSI->begin(), WE = WSI->end(); WI != WE; ++WI) {
1016         if (hasAliasedVariants(SchedModels.getSchedWrite(*WI), SchedModels))
1017           return true;
1018       }
1019     }
1020     for (SmallVectorImpl<SmallVector<unsigned,4> >::const_iterator
1021            RSI = PTI->ReadSequences.begin(), RSE = PTI->ReadSequences.end();
1022          RSI != RSE; ++RSI) {
1023       for (SmallVectorImpl<unsigned>::const_iterator
1024              RI = RSI->begin(), RE = RSI->end(); RI != RE; ++RI) {
1025         if (hasAliasedVariants(SchedModels.getSchedRead(*RI), SchedModels))
1026           return true;
1027       }
1028     }
1029   }
1030   return false;
1031 }
1032
1033 // Populate IntersectingVariants with any variants or aliased sequences of the
1034 // given SchedRW whose processor indices and predicates are not mutually
1035 // exclusive with the given transition.
1036 void PredTransitions::getIntersectingVariants(
1037   const CodeGenSchedRW &SchedRW, unsigned TransIdx,
1038   std::vector<TransVariant> &IntersectingVariants) {
1039
1040   bool GenericRW = false;
1041
1042   std::vector<TransVariant> Variants;
1043   if (SchedRW.HasVariants) {
1044     unsigned VarProcIdx = 0;
1045     if (SchedRW.TheDef->getValueInit("SchedModel")->isComplete()) {
1046       Record *ModelDef = SchedRW.TheDef->getValueAsDef("SchedModel");
1047       VarProcIdx = SchedModels.getProcModel(ModelDef).Index;
1048     }
1049     // Push each variant. Assign TransVecIdx later.
1050     const RecVec VarDefs = SchedRW.TheDef->getValueAsListOfDefs("Variants");
1051     for (RecIter RI = VarDefs.begin(), RE = VarDefs.end(); RI != RE; ++RI)
1052       Variants.push_back(TransVariant(*RI, SchedRW.Index, VarProcIdx, 0));
1053     if (VarProcIdx == 0)
1054       GenericRW = true;
1055   }
1056   for (RecIter AI = SchedRW.Aliases.begin(), AE = SchedRW.Aliases.end();
1057        AI != AE; ++AI) {
1058     // If either the SchedAlias itself or the SchedReadWrite that it aliases
1059     // to is defined within a processor model, constrain all variants to
1060     // that processor.
1061     unsigned AliasProcIdx = 0;
1062     if ((*AI)->getValueInit("SchedModel")->isComplete()) {
1063       Record *ModelDef = (*AI)->getValueAsDef("SchedModel");
1064       AliasProcIdx = SchedModels.getProcModel(ModelDef).Index;
1065     }
1066     const CodeGenSchedRW &AliasRW =
1067       SchedModels.getSchedRW((*AI)->getValueAsDef("AliasRW"));
1068
1069     if (AliasRW.HasVariants) {
1070       const RecVec VarDefs = AliasRW.TheDef->getValueAsListOfDefs("Variants");
1071       for (RecIter RI = VarDefs.begin(), RE = VarDefs.end(); RI != RE; ++RI)
1072         Variants.push_back(TransVariant(*RI, AliasRW.Index, AliasProcIdx, 0));
1073     }
1074     if (AliasRW.IsSequence) {
1075       Variants.push_back(
1076         TransVariant(AliasRW.TheDef, SchedRW.Index, AliasProcIdx, 0));
1077     }
1078     if (AliasProcIdx == 0)
1079       GenericRW = true;
1080   }
1081   for (unsigned VIdx = 0, VEnd = Variants.size(); VIdx != VEnd; ++VIdx) {
1082     TransVariant &Variant = Variants[VIdx];
1083     // Don't expand variants if the processor models don't intersect.
1084     // A zero processor index means any processor.
1085     SmallVector<unsigned, 4> &ProcIndices = TransVec[TransIdx].ProcIndices;
1086     if (ProcIndices[0] && Variants[VIdx].ProcIdx) {
1087       unsigned Cnt = std::count(ProcIndices.begin(), ProcIndices.end(),
1088                                 Variant.ProcIdx);
1089       if (!Cnt)
1090         continue;
1091       if (Cnt > 1) {
1092         const CodeGenProcModel &PM =
1093           *(SchedModels.procModelBegin() + Variant.ProcIdx);
1094         PrintFatalError(Variant.VarOrSeqDef->getLoc(),
1095                         "Multiple variants defined for processor " +
1096                         PM.ModelName +
1097                         " Ensure only one SchedAlias exists per RW.");
1098       }
1099     }
1100     if (Variant.VarOrSeqDef->isSubClassOf("SchedVar")) {
1101       Record *PredDef = Variant.VarOrSeqDef->getValueAsDef("Predicate");
1102       if (mutuallyExclusive(PredDef, TransVec[TransIdx].PredTerm))
1103         continue;
1104     }
1105     if (IntersectingVariants.empty()) {
1106       // The first variant builds on the existing transition.
1107       Variant.TransVecIdx = TransIdx;
1108       IntersectingVariants.push_back(Variant);
1109     }
1110     else {
1111       // Push another copy of the current transition for more variants.
1112       Variant.TransVecIdx = TransVec.size();
1113       IntersectingVariants.push_back(Variant);
1114       TransVec.push_back(TransVec[TransIdx]);
1115     }
1116   }
1117   if (GenericRW && IntersectingVariants.empty()) {
1118     PrintFatalError(SchedRW.TheDef->getLoc(), "No variant of this type has "
1119                     "a matching predicate on any processor");
1120   }
1121 }
1122
1123 // Push the Reads/Writes selected by this variant onto the PredTransition
1124 // specified by VInfo.
1125 void PredTransitions::
1126 pushVariant(const TransVariant &VInfo, bool IsRead) {
1127
1128   PredTransition &Trans = TransVec[VInfo.TransVecIdx];
1129
1130   // If this operand transition is reached through a processor-specific alias,
1131   // then the whole transition is specific to this processor.
1132   if (VInfo.ProcIdx != 0)
1133     Trans.ProcIndices.assign(1, VInfo.ProcIdx);
1134
1135   IdxVec SelectedRWs;
1136   if (VInfo.VarOrSeqDef->isSubClassOf("SchedVar")) {
1137     Record *PredDef = VInfo.VarOrSeqDef->getValueAsDef("Predicate");
1138     Trans.PredTerm.push_back(PredCheck(IsRead, VInfo.RWIdx,PredDef));
1139     RecVec SelectedDefs = VInfo.VarOrSeqDef->getValueAsListOfDefs("Selected");
1140     SchedModels.findRWs(SelectedDefs, SelectedRWs, IsRead);
1141   }
1142   else {
1143     assert(VInfo.VarOrSeqDef->isSubClassOf("WriteSequence") &&
1144            "variant must be a SchedVariant or aliased WriteSequence");
1145     SelectedRWs.push_back(SchedModels.getSchedRWIdx(VInfo.VarOrSeqDef, IsRead));
1146   }
1147
1148   const CodeGenSchedRW &SchedRW = SchedModels.getSchedRW(VInfo.RWIdx, IsRead);
1149
1150   SmallVectorImpl<SmallVector<unsigned,4> > &RWSequences = IsRead
1151     ? Trans.ReadSequences : Trans.WriteSequences;
1152   if (SchedRW.IsVariadic) {
1153     unsigned OperIdx = RWSequences.size()-1;
1154     // Make N-1 copies of this transition's last sequence.
1155     for (unsigned i = 1, e = SelectedRWs.size(); i != e; ++i) {
1156       RWSequences.push_back(RWSequences[OperIdx]);
1157     }
1158     // Push each of the N elements of the SelectedRWs onto a copy of the last
1159     // sequence (split the current operand into N operands).
1160     // Note that write sequences should be expanded within this loop--the entire
1161     // sequence belongs to a single operand.
1162     for (IdxIter RWI = SelectedRWs.begin(), RWE = SelectedRWs.end();
1163          RWI != RWE; ++RWI, ++OperIdx) {
1164       IdxVec ExpandedRWs;
1165       if (IsRead)
1166         ExpandedRWs.push_back(*RWI);
1167       else
1168         SchedModels.expandRWSequence(*RWI, ExpandedRWs, IsRead);
1169       RWSequences[OperIdx].insert(RWSequences[OperIdx].end(),
1170                                   ExpandedRWs.begin(), ExpandedRWs.end());
1171     }
1172     assert(OperIdx == RWSequences.size() && "missed a sequence");
1173   }
1174   else {
1175     // Push this transition's expanded sequence onto this transition's last
1176     // sequence (add to the current operand's sequence).
1177     SmallVectorImpl<unsigned> &Seq = RWSequences.back();
1178     IdxVec ExpandedRWs;
1179     for (IdxIter RWI = SelectedRWs.begin(), RWE = SelectedRWs.end();
1180          RWI != RWE; ++RWI) {
1181       if (IsRead)
1182         ExpandedRWs.push_back(*RWI);
1183       else
1184         SchedModels.expandRWSequence(*RWI, ExpandedRWs, IsRead);
1185     }
1186     Seq.insert(Seq.end(), ExpandedRWs.begin(), ExpandedRWs.end());
1187   }
1188 }
1189
1190 // RWSeq is a sequence of all Reads or all Writes for the next read or write
1191 // operand. StartIdx is an index into TransVec where partial results
1192 // starts. RWSeq must be applied to all transitions between StartIdx and the end
1193 // of TransVec.
1194 void PredTransitions::substituteVariantOperand(
1195   const SmallVectorImpl<unsigned> &RWSeq, bool IsRead, unsigned StartIdx) {
1196
1197   // Visit each original RW within the current sequence.
1198   for (SmallVectorImpl<unsigned>::const_iterator
1199          RWI = RWSeq.begin(), RWE = RWSeq.end(); RWI != RWE; ++RWI) {
1200     const CodeGenSchedRW &SchedRW = SchedModels.getSchedRW(*RWI, IsRead);
1201     // Push this RW on all partial PredTransitions or distribute variants.
1202     // New PredTransitions may be pushed within this loop which should not be
1203     // revisited (TransEnd must be loop invariant).
1204     for (unsigned TransIdx = StartIdx, TransEnd = TransVec.size();
1205          TransIdx != TransEnd; ++TransIdx) {
1206       // In the common case, push RW onto the current operand's sequence.
1207       if (!hasAliasedVariants(SchedRW, SchedModels)) {
1208         if (IsRead)
1209           TransVec[TransIdx].ReadSequences.back().push_back(*RWI);
1210         else
1211           TransVec[TransIdx].WriteSequences.back().push_back(*RWI);
1212         continue;
1213       }
1214       // Distribute this partial PredTransition across intersecting variants.
1215       // This will push a copies of TransVec[TransIdx] on the back of TransVec.
1216       std::vector<TransVariant> IntersectingVariants;
1217       getIntersectingVariants(SchedRW, TransIdx, IntersectingVariants);
1218       // Now expand each variant on top of its copy of the transition.
1219       for (std::vector<TransVariant>::const_iterator
1220              IVI = IntersectingVariants.begin(),
1221              IVE = IntersectingVariants.end();
1222            IVI != IVE; ++IVI) {
1223         pushVariant(*IVI, IsRead);
1224       }
1225     }
1226   }
1227 }
1228
1229 // For each variant of a Read/Write in Trans, substitute the sequence of
1230 // Read/Writes guarded by the variant. This is exponential in the number of
1231 // variant Read/Writes, but in practice detection of mutually exclusive
1232 // predicates should result in linear growth in the total number variants.
1233 //
1234 // This is one step in a breadth-first search of nested variants.
1235 void PredTransitions::substituteVariants(const PredTransition &Trans) {
1236   // Build up a set of partial results starting at the back of
1237   // PredTransitions. Remember the first new transition.
1238   unsigned StartIdx = TransVec.size();
1239   TransVec.resize(TransVec.size() + 1);
1240   TransVec.back().PredTerm = Trans.PredTerm;
1241   TransVec.back().ProcIndices = Trans.ProcIndices;
1242
1243   // Visit each original write sequence.
1244   for (SmallVectorImpl<SmallVector<unsigned,4> >::const_iterator
1245          WSI = Trans.WriteSequences.begin(), WSE = Trans.WriteSequences.end();
1246        WSI != WSE; ++WSI) {
1247     // Push a new (empty) write sequence onto all partial Transitions.
1248     for (std::vector<PredTransition>::iterator I =
1249            TransVec.begin() + StartIdx, E = TransVec.end(); I != E; ++I) {
1250       I->WriteSequences.resize(I->WriteSequences.size() + 1);
1251     }
1252     substituteVariantOperand(*WSI, /*IsRead=*/false, StartIdx);
1253   }
1254   // Visit each original read sequence.
1255   for (SmallVectorImpl<SmallVector<unsigned,4> >::const_iterator
1256          RSI = Trans.ReadSequences.begin(), RSE = Trans.ReadSequences.end();
1257        RSI != RSE; ++RSI) {
1258     // Push a new (empty) read sequence onto all partial Transitions.
1259     for (std::vector<PredTransition>::iterator I =
1260            TransVec.begin() + StartIdx, E = TransVec.end(); I != E; ++I) {
1261       I->ReadSequences.resize(I->ReadSequences.size() + 1);
1262     }
1263     substituteVariantOperand(*RSI, /*IsRead=*/true, StartIdx);
1264   }
1265 }
1266
1267 // Create a new SchedClass for each variant found by inferFromRW. Pass
1268 static void inferFromTransitions(ArrayRef<PredTransition> LastTransitions,
1269                                  unsigned FromClassIdx,
1270                                  CodeGenSchedModels &SchedModels) {
1271   // For each PredTransition, create a new CodeGenSchedTransition, which usually
1272   // requires creating a new SchedClass.
1273   for (ArrayRef<PredTransition>::iterator
1274          I = LastTransitions.begin(), E = LastTransitions.end(); I != E; ++I) {
1275     IdxVec OperWritesVariant;
1276     for (SmallVectorImpl<SmallVector<unsigned,4> >::const_iterator
1277            WSI = I->WriteSequences.begin(), WSE = I->WriteSequences.end();
1278          WSI != WSE; ++WSI) {
1279       // Create a new write representing the expanded sequence.
1280       OperWritesVariant.push_back(
1281         SchedModels.findOrInsertRW(*WSI, /*IsRead=*/false));
1282     }
1283     IdxVec OperReadsVariant;
1284     for (SmallVectorImpl<SmallVector<unsigned,4> >::const_iterator
1285            RSI = I->ReadSequences.begin(), RSE = I->ReadSequences.end();
1286          RSI != RSE; ++RSI) {
1287       // Create a new read representing the expanded sequence.
1288       OperReadsVariant.push_back(
1289         SchedModels.findOrInsertRW(*RSI, /*IsRead=*/true));
1290     }
1291     IdxVec ProcIndices(I->ProcIndices.begin(), I->ProcIndices.end());
1292     CodeGenSchedTransition SCTrans;
1293     SCTrans.ToClassIdx =
1294       SchedModels.addSchedClass(/*ItinClassDef=*/0, OperWritesVariant,
1295                                 OperReadsVariant, ProcIndices);
1296     SCTrans.ProcIndices = ProcIndices;
1297     // The final PredTerm is unique set of predicates guarding the transition.
1298     RecVec Preds;
1299     for (SmallVectorImpl<PredCheck>::const_iterator
1300            PI = I->PredTerm.begin(), PE = I->PredTerm.end(); PI != PE; ++PI) {
1301       Preds.push_back(PI->Predicate);
1302     }
1303     RecIter PredsEnd = std::unique(Preds.begin(), Preds.end());
1304     Preds.resize(PredsEnd - Preds.begin());
1305     SCTrans.PredTerm = Preds;
1306     SchedModels.getSchedClass(FromClassIdx).Transitions.push_back(SCTrans);
1307   }
1308 }
1309
1310 // Create new SchedClasses for the given ReadWrite list. If any of the
1311 // ReadWrites refers to a SchedVariant, create a new SchedClass for each variant
1312 // of the ReadWrite list, following Aliases if necessary.
1313 void CodeGenSchedModels::inferFromRW(const IdxVec &OperWrites,
1314                                      const IdxVec &OperReads,
1315                                      unsigned FromClassIdx,
1316                                      const IdxVec &ProcIndices) {
1317   DEBUG(dbgs() << "INFER RW proc("; dumpIdxVec(ProcIndices); dbgs() << ") ");
1318
1319   // Create a seed transition with an empty PredTerm and the expanded sequences
1320   // of SchedWrites for the current SchedClass.
1321   std::vector<PredTransition> LastTransitions;
1322   LastTransitions.resize(1);
1323   LastTransitions.back().ProcIndices.append(ProcIndices.begin(),
1324                                             ProcIndices.end());
1325
1326   for (IdxIter I = OperWrites.begin(), E = OperWrites.end(); I != E; ++I) {
1327     IdxVec WriteSeq;
1328     expandRWSequence(*I, WriteSeq, /*IsRead=*/false);
1329     unsigned Idx = LastTransitions[0].WriteSequences.size();
1330     LastTransitions[0].WriteSequences.resize(Idx + 1);
1331     SmallVectorImpl<unsigned> &Seq = LastTransitions[0].WriteSequences[Idx];
1332     for (IdxIter WI = WriteSeq.begin(), WE = WriteSeq.end(); WI != WE; ++WI)
1333       Seq.push_back(*WI);
1334     DEBUG(dbgs() << "("; dumpIdxVec(Seq); dbgs() << ") ");
1335   }
1336   DEBUG(dbgs() << " Reads: ");
1337   for (IdxIter I = OperReads.begin(), E = OperReads.end(); I != E; ++I) {
1338     IdxVec ReadSeq;
1339     expandRWSequence(*I, ReadSeq, /*IsRead=*/true);
1340     unsigned Idx = LastTransitions[0].ReadSequences.size();
1341     LastTransitions[0].ReadSequences.resize(Idx + 1);
1342     SmallVectorImpl<unsigned> &Seq = LastTransitions[0].ReadSequences[Idx];
1343     for (IdxIter RI = ReadSeq.begin(), RE = ReadSeq.end(); RI != RE; ++RI)
1344       Seq.push_back(*RI);
1345     DEBUG(dbgs() << "("; dumpIdxVec(Seq); dbgs() << ") ");
1346   }
1347   DEBUG(dbgs() << '\n');
1348
1349   // Collect all PredTransitions for individual operands.
1350   // Iterate until no variant writes remain.
1351   while (hasVariant(LastTransitions, *this)) {
1352     PredTransitions Transitions(*this);
1353     for (std::vector<PredTransition>::const_iterator
1354            I = LastTransitions.begin(), E = LastTransitions.end();
1355          I != E; ++I) {
1356       Transitions.substituteVariants(*I);
1357     }
1358     DEBUG(Transitions.dump());
1359     LastTransitions.swap(Transitions.TransVec);
1360   }
1361   // If the first transition has no variants, nothing to do.
1362   if (LastTransitions[0].PredTerm.empty())
1363     return;
1364
1365   // WARNING: We are about to mutate the SchedClasses vector. Do not refer to
1366   // OperWrites, OperReads, or ProcIndices after calling inferFromTransitions.
1367   inferFromTransitions(LastTransitions, FromClassIdx, *this);
1368 }
1369
1370 // Check if any processor resource group contains all resource records in
1371 // SubUnits.
1372 bool CodeGenSchedModels::hasSuperGroup(RecVec &SubUnits, CodeGenProcModel &PM) {
1373   for (unsigned i = 0, e = PM.ProcResourceDefs.size(); i < e; ++i) {
1374     if (!PM.ProcResourceDefs[i]->isSubClassOf("ProcResGroup"))
1375       continue;
1376     RecVec SuperUnits =
1377       PM.ProcResourceDefs[i]->getValueAsListOfDefs("Resources");
1378     RecIter RI = SubUnits.begin(), RE = SubUnits.end();
1379     for ( ; RI != RE; ++RI) {
1380       if (std::find(SuperUnits.begin(), SuperUnits.end(), *RI)
1381           == SuperUnits.end()) {
1382         break;
1383       }
1384     }
1385     if (RI == RE)
1386       return true;
1387   }
1388   return false;
1389 }
1390
1391 // Verify that overlapping groups have a common supergroup.
1392 void CodeGenSchedModels::verifyProcResourceGroups(CodeGenProcModel &PM) {
1393   for (unsigned i = 0, e = PM.ProcResourceDefs.size(); i < e; ++i) {
1394     if (!PM.ProcResourceDefs[i]->isSubClassOf("ProcResGroup"))
1395       continue;
1396     RecVec CheckUnits =
1397       PM.ProcResourceDefs[i]->getValueAsListOfDefs("Resources");
1398     for (unsigned j = i+1; j < e; ++j) {
1399       if (!PM.ProcResourceDefs[j]->isSubClassOf("ProcResGroup"))
1400         continue;
1401       RecVec OtherUnits =
1402         PM.ProcResourceDefs[j]->getValueAsListOfDefs("Resources");
1403       if (std::find_first_of(CheckUnits.begin(), CheckUnits.end(),
1404                              OtherUnits.begin(), OtherUnits.end())
1405           != CheckUnits.end()) {
1406         // CheckUnits and OtherUnits overlap
1407         OtherUnits.insert(OtherUnits.end(), CheckUnits.begin(),
1408                           CheckUnits.end());
1409         if (!hasSuperGroup(OtherUnits, PM)) {
1410           PrintFatalError((PM.ProcResourceDefs[i])->getLoc(),
1411                           "proc resource group overlaps with "
1412                           + PM.ProcResourceDefs[j]->getName()
1413                           + " but no supergroup contains both.");
1414         }
1415       }
1416     }
1417   }
1418 }
1419
1420 // Collect and sort WriteRes, ReadAdvance, and ProcResources.
1421 void CodeGenSchedModels::collectProcResources() {
1422   // Add any subtarget-specific SchedReadWrites that are directly associated
1423   // with processor resources. Refer to the parent SchedClass's ProcIndices to
1424   // determine which processors they apply to.
1425   for (SchedClassIter SCI = schedClassBegin(), SCE = schedClassEnd();
1426        SCI != SCE; ++SCI) {
1427     if (SCI->ItinClassDef)
1428       collectItinProcResources(SCI->ItinClassDef);
1429     else {
1430       // This class may have a default ReadWrite list which can be overriden by
1431       // InstRW definitions.
1432       if (!SCI->InstRWs.empty()) {
1433         for (RecIter RWI = SCI->InstRWs.begin(), RWE = SCI->InstRWs.end();
1434              RWI != RWE; ++RWI) {
1435           Record *RWModelDef = (*RWI)->getValueAsDef("SchedModel");
1436           IdxVec ProcIndices(1, getProcModel(RWModelDef).Index);
1437           IdxVec Writes, Reads;
1438           findRWs((*RWI)->getValueAsListOfDefs("OperandReadWrites"),
1439                   Writes, Reads);
1440           collectRWResources(Writes, Reads, ProcIndices);
1441         }
1442       }
1443       collectRWResources(SCI->Writes, SCI->Reads, SCI->ProcIndices);
1444     }
1445   }
1446   // Add resources separately defined by each subtarget.
1447   RecVec WRDefs = Records.getAllDerivedDefinitions("WriteRes");
1448   for (RecIter WRI = WRDefs.begin(), WRE = WRDefs.end(); WRI != WRE; ++WRI) {
1449     Record *ModelDef = (*WRI)->getValueAsDef("SchedModel");
1450     addWriteRes(*WRI, getProcModel(ModelDef).Index);
1451   }
1452   RecVec RADefs = Records.getAllDerivedDefinitions("ReadAdvance");
1453   for (RecIter RAI = RADefs.begin(), RAE = RADefs.end(); RAI != RAE; ++RAI) {
1454     Record *ModelDef = (*RAI)->getValueAsDef("SchedModel");
1455     addReadAdvance(*RAI, getProcModel(ModelDef).Index);
1456   }
1457   // Finalize each ProcModel by sorting the record arrays.
1458   for (unsigned PIdx = 0, PEnd = ProcModels.size(); PIdx != PEnd; ++PIdx) {
1459     CodeGenProcModel &PM = ProcModels[PIdx];
1460     std::sort(PM.WriteResDefs.begin(), PM.WriteResDefs.end(),
1461               LessRecord());
1462     std::sort(PM.ReadAdvanceDefs.begin(), PM.ReadAdvanceDefs.end(),
1463               LessRecord());
1464     std::sort(PM.ProcResourceDefs.begin(), PM.ProcResourceDefs.end(),
1465               LessRecord());
1466     DEBUG(
1467       PM.dump();
1468       dbgs() << "WriteResDefs: ";
1469       for (RecIter RI = PM.WriteResDefs.begin(),
1470              RE = PM.WriteResDefs.end(); RI != RE; ++RI) {
1471         if ((*RI)->isSubClassOf("WriteRes"))
1472           dbgs() << (*RI)->getValueAsDef("WriteType")->getName() << " ";
1473         else
1474           dbgs() << (*RI)->getName() << " ";
1475       }
1476       dbgs() << "\nReadAdvanceDefs: ";
1477       for (RecIter RI = PM.ReadAdvanceDefs.begin(),
1478              RE = PM.ReadAdvanceDefs.end(); RI != RE; ++RI) {
1479         if ((*RI)->isSubClassOf("ReadAdvance"))
1480           dbgs() << (*RI)->getValueAsDef("ReadType")->getName() << " ";
1481         else
1482           dbgs() << (*RI)->getName() << " ";
1483       }
1484       dbgs() << "\nProcResourceDefs: ";
1485       for (RecIter RI = PM.ProcResourceDefs.begin(),
1486              RE = PM.ProcResourceDefs.end(); RI != RE; ++RI) {
1487         dbgs() << (*RI)->getName() << " ";
1488       }
1489       dbgs() << '\n');
1490     verifyProcResourceGroups(PM);
1491   }
1492 }
1493
1494 // Collect itinerary class resources for each processor.
1495 void CodeGenSchedModels::collectItinProcResources(Record *ItinClassDef) {
1496   for (unsigned PIdx = 0, PEnd = ProcModels.size(); PIdx != PEnd; ++PIdx) {
1497     const CodeGenProcModel &PM = ProcModels[PIdx];
1498     // For all ItinRW entries.
1499     bool HasMatch = false;
1500     for (RecIter II = PM.ItinRWDefs.begin(), IE = PM.ItinRWDefs.end();
1501          II != IE; ++II) {
1502       RecVec Matched = (*II)->getValueAsListOfDefs("MatchedItinClasses");
1503       if (!std::count(Matched.begin(), Matched.end(), ItinClassDef))
1504         continue;
1505       if (HasMatch)
1506         PrintFatalError((*II)->getLoc(), "Duplicate itinerary class "
1507                         + ItinClassDef->getName()
1508                         + " in ItinResources for " + PM.ModelName);
1509       HasMatch = true;
1510       IdxVec Writes, Reads;
1511       findRWs((*II)->getValueAsListOfDefs("OperandReadWrites"), Writes, Reads);
1512       IdxVec ProcIndices(1, PIdx);
1513       collectRWResources(Writes, Reads, ProcIndices);
1514     }
1515   }
1516 }
1517
1518 void CodeGenSchedModels::collectRWResources(unsigned RWIdx, bool IsRead,
1519                                             const IdxVec &ProcIndices) {
1520   const CodeGenSchedRW &SchedRW = getSchedRW(RWIdx, IsRead);
1521   if (SchedRW.TheDef) {
1522     if (!IsRead && SchedRW.TheDef->isSubClassOf("SchedWriteRes")) {
1523       for (IdxIter PI = ProcIndices.begin(), PE = ProcIndices.end();
1524            PI != PE; ++PI) {
1525         addWriteRes(SchedRW.TheDef, *PI);
1526       }
1527     }
1528     else if (IsRead && SchedRW.TheDef->isSubClassOf("SchedReadAdvance")) {
1529       for (IdxIter PI = ProcIndices.begin(), PE = ProcIndices.end();
1530            PI != PE; ++PI) {
1531         addReadAdvance(SchedRW.TheDef, *PI);
1532       }
1533     }
1534   }
1535   for (RecIter AI = SchedRW.Aliases.begin(), AE = SchedRW.Aliases.end();
1536        AI != AE; ++AI) {
1537     IdxVec AliasProcIndices;
1538     if ((*AI)->getValueInit("SchedModel")->isComplete()) {
1539       AliasProcIndices.push_back(
1540         getProcModel((*AI)->getValueAsDef("SchedModel")).Index);
1541     }
1542     else
1543       AliasProcIndices = ProcIndices;
1544     const CodeGenSchedRW &AliasRW = getSchedRW((*AI)->getValueAsDef("AliasRW"));
1545     assert(AliasRW.IsRead == IsRead && "cannot alias reads to writes");
1546
1547     IdxVec ExpandedRWs;
1548     expandRWSequence(AliasRW.Index, ExpandedRWs, IsRead);
1549     for (IdxIter SI = ExpandedRWs.begin(), SE = ExpandedRWs.end();
1550          SI != SE; ++SI) {
1551       collectRWResources(*SI, IsRead, AliasProcIndices);
1552     }
1553   }
1554 }
1555
1556 // Collect resources for a set of read/write types and processor indices.
1557 void CodeGenSchedModels::collectRWResources(const IdxVec &Writes,
1558                                             const IdxVec &Reads,
1559                                             const IdxVec &ProcIndices) {
1560
1561   for (IdxIter WI = Writes.begin(), WE = Writes.end(); WI != WE; ++WI)
1562     collectRWResources(*WI, /*IsRead=*/false, ProcIndices);
1563
1564   for (IdxIter RI = Reads.begin(), RE = Reads.end(); RI != RE; ++RI)
1565     collectRWResources(*RI, /*IsRead=*/true, ProcIndices);
1566 }
1567
1568
1569 // Find the processor's resource units for this kind of resource.
1570 Record *CodeGenSchedModels::findProcResUnits(Record *ProcResKind,
1571                                              const CodeGenProcModel &PM) const {
1572   if (ProcResKind->isSubClassOf("ProcResourceUnits"))
1573     return ProcResKind;
1574
1575   Record *ProcUnitDef = 0;
1576   RecVec ProcResourceDefs =
1577     Records.getAllDerivedDefinitions("ProcResourceUnits");
1578
1579   for (RecIter RI = ProcResourceDefs.begin(), RE = ProcResourceDefs.end();
1580        RI != RE; ++RI) {
1581
1582     if ((*RI)->getValueAsDef("Kind") == ProcResKind
1583         && (*RI)->getValueAsDef("SchedModel") == PM.ModelDef) {
1584       if (ProcUnitDef) {
1585         PrintFatalError((*RI)->getLoc(),
1586                         "Multiple ProcessorResourceUnits associated with "
1587                         + ProcResKind->getName());
1588       }
1589       ProcUnitDef = *RI;
1590     }
1591   }
1592   RecVec ProcResGroups = Records.getAllDerivedDefinitions("ProcResGroup");
1593   for (RecIter RI = ProcResGroups.begin(), RE = ProcResGroups.end();
1594        RI != RE; ++RI) {
1595
1596     if (*RI == ProcResKind
1597         && (*RI)->getValueAsDef("SchedModel") == PM.ModelDef) {
1598       if (ProcUnitDef) {
1599         PrintFatalError((*RI)->getLoc(),
1600                         "Multiple ProcessorResourceUnits associated with "
1601                         + ProcResKind->getName());
1602       }
1603       ProcUnitDef = *RI;
1604     }
1605   }
1606   if (!ProcUnitDef) {
1607     PrintFatalError(ProcResKind->getLoc(),
1608                     "No ProcessorResources associated with "
1609                     + ProcResKind->getName());
1610   }
1611   return ProcUnitDef;
1612 }
1613
1614 // Iteratively add a resource and its super resources.
1615 void CodeGenSchedModels::addProcResource(Record *ProcResKind,
1616                                          CodeGenProcModel &PM) {
1617   for (;;) {
1618     Record *ProcResUnits = findProcResUnits(ProcResKind, PM);
1619
1620     // See if this ProcResource is already associated with this processor.
1621     RecIter I = std::find(PM.ProcResourceDefs.begin(),
1622                           PM.ProcResourceDefs.end(), ProcResUnits);
1623     if (I != PM.ProcResourceDefs.end())
1624       return;
1625
1626     PM.ProcResourceDefs.push_back(ProcResUnits);
1627     if (ProcResUnits->isSubClassOf("ProcResGroup"))
1628       return;
1629
1630     if (!ProcResUnits->getValueInit("Super")->isComplete())
1631       return;
1632
1633     ProcResKind = ProcResUnits->getValueAsDef("Super");
1634   }
1635 }
1636
1637 // Add resources for a SchedWrite to this processor if they don't exist.
1638 void CodeGenSchedModels::addWriteRes(Record *ProcWriteResDef, unsigned PIdx) {
1639   assert(PIdx && "don't add resources to an invalid Processor model");
1640
1641   RecVec &WRDefs = ProcModels[PIdx].WriteResDefs;
1642   RecIter WRI = std::find(WRDefs.begin(), WRDefs.end(), ProcWriteResDef);
1643   if (WRI != WRDefs.end())
1644     return;
1645   WRDefs.push_back(ProcWriteResDef);
1646
1647   // Visit ProcResourceKinds referenced by the newly discovered WriteRes.
1648   RecVec ProcResDefs = ProcWriteResDef->getValueAsListOfDefs("ProcResources");
1649   for (RecIter WritePRI = ProcResDefs.begin(), WritePRE = ProcResDefs.end();
1650        WritePRI != WritePRE; ++WritePRI) {
1651     addProcResource(*WritePRI, ProcModels[PIdx]);
1652   }
1653 }
1654
1655 // Add resources for a ReadAdvance to this processor if they don't exist.
1656 void CodeGenSchedModels::addReadAdvance(Record *ProcReadAdvanceDef,
1657                                         unsigned PIdx) {
1658   RecVec &RADefs = ProcModels[PIdx].ReadAdvanceDefs;
1659   RecIter I = std::find(RADefs.begin(), RADefs.end(), ProcReadAdvanceDef);
1660   if (I != RADefs.end())
1661     return;
1662   RADefs.push_back(ProcReadAdvanceDef);
1663 }
1664
1665 unsigned CodeGenProcModel::getProcResourceIdx(Record *PRDef) const {
1666   RecIter PRPos = std::find(ProcResourceDefs.begin(), ProcResourceDefs.end(),
1667                             PRDef);
1668   if (PRPos == ProcResourceDefs.end())
1669     PrintFatalError(PRDef->getLoc(), "ProcResource def is not included in "
1670                     "the ProcResources list for " + ModelName);
1671   // Idx=0 is reserved for invalid.
1672   return 1 + (PRPos - ProcResourceDefs.begin());
1673 }
1674
1675 #ifndef NDEBUG
1676 void CodeGenProcModel::dump() const {
1677   dbgs() << Index << ": " << ModelName << " "
1678          << (ModelDef ? ModelDef->getName() : "inferred") << " "
1679          << (ItinsDef ? ItinsDef->getName() : "no itinerary") << '\n';
1680 }
1681
1682 void CodeGenSchedRW::dump() const {
1683   dbgs() << Name << (IsVariadic ? " (V) " : " ");
1684   if (IsSequence) {
1685     dbgs() << "(";
1686     dumpIdxVec(Sequence);
1687     dbgs() << ")";
1688   }
1689 }
1690
1691 void CodeGenSchedClass::dump(const CodeGenSchedModels* SchedModels) const {
1692   dbgs() << "SCHEDCLASS " << Index << ":" << Name << '\n'
1693          << "  Writes: ";
1694   for (unsigned i = 0, N = Writes.size(); i < N; ++i) {
1695     SchedModels->getSchedWrite(Writes[i]).dump();
1696     if (i < N-1) {
1697       dbgs() << '\n';
1698       dbgs().indent(10);
1699     }
1700   }
1701   dbgs() << "\n  Reads: ";
1702   for (unsigned i = 0, N = Reads.size(); i < N; ++i) {
1703     SchedModels->getSchedRead(Reads[i]).dump();
1704     if (i < N-1) {
1705       dbgs() << '\n';
1706       dbgs().indent(10);
1707     }
1708   }
1709   dbgs() << "\n  ProcIdx: "; dumpIdxVec(ProcIndices); dbgs() << '\n';
1710   if (!Transitions.empty()) {
1711     dbgs() << "\n Transitions for Proc ";
1712     for (std::vector<CodeGenSchedTransition>::const_iterator
1713            TI = Transitions.begin(), TE = Transitions.end(); TI != TE; ++TI) {
1714       dumpIdxVec(TI->ProcIndices);
1715     }
1716   }
1717 }
1718
1719 void PredTransitions::dump() const {
1720   dbgs() << "Expanded Variants:\n";
1721   for (std::vector<PredTransition>::const_iterator
1722          TI = TransVec.begin(), TE = TransVec.end(); TI != TE; ++TI) {
1723     dbgs() << "{";
1724     for (SmallVectorImpl<PredCheck>::const_iterator
1725            PCI = TI->PredTerm.begin(), PCE = TI->PredTerm.end();
1726          PCI != PCE; ++PCI) {
1727       if (PCI != TI->PredTerm.begin())
1728         dbgs() << ", ";
1729       dbgs() << SchedModels.getSchedRW(PCI->RWIdx, PCI->IsRead).Name
1730              << ":" << PCI->Predicate->getName();
1731     }
1732     dbgs() << "},\n  => {";
1733     for (SmallVectorImpl<SmallVector<unsigned,4> >::const_iterator
1734            WSI = TI->WriteSequences.begin(), WSE = TI->WriteSequences.end();
1735          WSI != WSE; ++WSI) {
1736       dbgs() << "(";
1737       for (SmallVectorImpl<unsigned>::const_iterator
1738              WI = WSI->begin(), WE = WSI->end(); WI != WE; ++WI) {
1739         if (WI != WSI->begin())
1740           dbgs() << ", ";
1741         dbgs() << SchedModels.getSchedWrite(*WI).Name;
1742       }
1743       dbgs() << "),";
1744     }
1745     dbgs() << "}\n";
1746   }
1747 }
1748 #endif // NDEBUG