1 //===- CodeGenSchedule.h - Scheduling Machine Models ------------*- C++ -*-===//
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 described in
11 // the target description.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_UTILS_TABLEGEN_CODEGENSCHEDULE_H
16 #define LLVM_UTILS_TABLEGEN_CODEGENSCHEDULE_H
17 
18 #include "llvm/ADT/APInt.h"
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/ADT/StringMap.h"
21 #include "llvm/Support/ErrorHandling.h"
22 #include "llvm/TableGen/Record.h"
23 #include "llvm/TableGen/SetTheory.h"
24 
25 namespace llvm {
26 
27 class CodeGenTarget;
28 class CodeGenSchedModels;
29 class CodeGenInstruction;
30 class CodeGenRegisterClass;
31 
32 using RecVec = std::vector<Record*>;
33 using RecIter = std::vector<Record*>::const_iterator;
34 
35 using IdxVec = std::vector<unsigned>;
36 using IdxIter = std::vector<unsigned>::const_iterator;
37 
38 /// We have two kinds of SchedReadWrites. Explicitly defined and inferred
39 /// sequences.  TheDef is nonnull for explicit SchedWrites, but Sequence may or
40 /// may not be empty. TheDef is null for inferred sequences, and Sequence must
41 /// be nonempty.
42 ///
43 /// IsVariadic controls whether the variants are expanded into multiple operands
44 /// or a sequence of writes on one operand.
45 struct CodeGenSchedRW {
46   unsigned Index;
47   std::string Name;
48   Record *TheDef;
49   bool IsRead;
50   bool IsAlias;
51   bool HasVariants;
52   bool IsVariadic;
53   bool IsSequence;
54   IdxVec Sequence;
55   RecVec Aliases;
56 
57   CodeGenSchedRW()
58     : Index(0), TheDef(nullptr), IsRead(false), IsAlias(false),
59       HasVariants(false), IsVariadic(false), IsSequence(false) {}
60   CodeGenSchedRW(unsigned Idx, Record *Def)
61     : Index(Idx), TheDef(Def), IsAlias(false), IsVariadic(false) {
62     Name = Def->getName();
63     IsRead = Def->isSubClassOf("SchedRead");
64     HasVariants = Def->isSubClassOf("SchedVariant");
65     if (HasVariants)
66       IsVariadic = Def->getValueAsBit("Variadic");
67 
68     // Read records don't currently have sequences, but it can be easily
69     // added. Note that implicit Reads (from ReadVariant) may have a Sequence
70     // (but no record).
71     IsSequence = Def->isSubClassOf("WriteSequence");
72   }
73 
74   CodeGenSchedRW(unsigned Idx, bool Read, ArrayRef<unsigned> Seq,
75                  const std::string &Name)
76       : Index(Idx), Name(Name), TheDef(nullptr), IsRead(Read), IsAlias(false),
77         HasVariants(false), IsVariadic(false), IsSequence(true), Sequence(Seq) {
78     assert(Sequence.size() > 1 && "implied sequence needs >1 RWs");
79   }
80 
81   bool isValid() const {
82     assert((!HasVariants || TheDef) && "Variant write needs record def");
83     assert((!IsVariadic || HasVariants) && "Variadic write needs variants");
84     assert((!IsSequence || !HasVariants) && "Sequence can't have variant");
85     assert((!IsSequence || !Sequence.empty()) && "Sequence should be nonempty");
86     assert((!IsAlias || Aliases.empty()) && "Alias cannot have aliases");
87     return TheDef || !Sequence.empty();
88   }
89 
90 #ifndef NDEBUG
91   void dump() const;
92 #endif
93 };
94 
95 /// Represent a transition between SchedClasses induced by SchedVariant.
96 struct CodeGenSchedTransition {
97   unsigned ToClassIdx;
98   IdxVec ProcIndices;
99   RecVec PredTerm;
100 };
101 
102 /// Scheduling class.
103 ///
104 /// Each instruction description will be mapped to a scheduling class. There are
105 /// four types of classes:
106 ///
107 /// 1) An explicitly defined itinerary class with ItinClassDef set.
108 /// Writes and ReadDefs are empty. ProcIndices contains 0 for any processor.
109 ///
110 /// 2) An implied class with a list of SchedWrites and SchedReads that are
111 /// defined in an instruction definition and which are common across all
112 /// subtargets. ProcIndices contains 0 for any processor.
113 ///
114 /// 3) An implied class with a list of InstRW records that map instructions to
115 /// SchedWrites and SchedReads per-processor. InstrClassMap should map the same
116 /// instructions to this class. ProcIndices contains all the processors that
117 /// provided InstrRW records for this class. ItinClassDef or Writes/Reads may
118 /// still be defined for processors with no InstRW entry.
119 ///
120 /// 4) An inferred class represents a variant of another class that may be
121 /// resolved at runtime. ProcIndices contains the set of processors that may
122 /// require the class. ProcIndices are propagated through SchedClasses as
123 /// variants are expanded. Multiple SchedClasses may be inferred from an
124 /// itinerary class. Each inherits the processor index from the ItinRW record
125 /// that mapped the itinerary class to the variant Writes or Reads.
126 struct CodeGenSchedClass {
127   unsigned Index;
128   std::string Name;
129   Record *ItinClassDef;
130 
131   IdxVec Writes;
132   IdxVec Reads;
133   // Sorted list of ProcIdx, where ProcIdx==0 implies any processor.
134   IdxVec ProcIndices;
135 
136   std::vector<CodeGenSchedTransition> Transitions;
137 
138   // InstRW records associated with this class. These records may refer to an
139   // Instruction no longer mapped to this class by InstrClassMap. These
140   // Instructions should be ignored by this class because they have been split
141   // off to join another inferred class.
142   RecVec InstRWs;
143 
144   CodeGenSchedClass(unsigned Index, std::string Name, Record *ItinClassDef)
145     : Index(Index), Name(std::move(Name)), ItinClassDef(ItinClassDef) {}
146 
147   bool isKeyEqual(Record *IC, ArrayRef<unsigned> W,
148                   ArrayRef<unsigned> R) const {
149     return ItinClassDef == IC && makeArrayRef(Writes) == W &&
150            makeArrayRef(Reads) == R;
151   }
152 
153   // Is this class generated from a variants if existing classes? Instructions
154   // are never mapped directly to inferred scheduling classes.
155   bool isInferred() const { return !ItinClassDef; }
156 
157 #ifndef NDEBUG
158   void dump(const CodeGenSchedModels *SchedModels) const;
159 #endif
160 };
161 
162 /// Represent the cost of allocating a register of register class RCDef.
163 ///
164 /// The cost of allocating a register is equivalent to the number of physical
165 /// registers used by the register renamer. Register costs are defined at
166 /// register class granularity.
167 struct CodeGenRegisterCost {
168   Record *RCDef;
169   unsigned Cost;
170   bool AllowMoveElimination;
171   CodeGenRegisterCost(Record *RC, unsigned RegisterCost, bool AllowMoveElim = false)
172       : RCDef(RC), Cost(RegisterCost), AllowMoveElimination(AllowMoveElim) {}
173   CodeGenRegisterCost(const CodeGenRegisterCost &) = default;
174   CodeGenRegisterCost &operator=(const CodeGenRegisterCost &) = delete;
175 };
176 
177 /// A processor register file.
178 ///
179 /// This class describes a processor register file. Register file information is
180 /// currently consumed by external tools like llvm-mca to predict dispatch
181 /// stalls due to register pressure.
182 struct CodeGenRegisterFile {
183   std::string Name;
184   Record *RegisterFileDef;
185   unsigned MaxMovesEliminatedPerCycle;
186   bool AllowZeroMoveEliminationOnly;
187 
188   unsigned NumPhysRegs;
189   std::vector<CodeGenRegisterCost> Costs;
190 
191   CodeGenRegisterFile(StringRef name, Record *def, unsigned MaxMoveElimPerCy = 0,
192                       bool AllowZeroMoveElimOnly = false)
193       : Name(name), RegisterFileDef(def),
194         MaxMovesEliminatedPerCycle(MaxMoveElimPerCy),
195         AllowZeroMoveEliminationOnly(AllowZeroMoveElimOnly),
196         NumPhysRegs(0) {}
197 
198   bool hasDefaultCosts() const { return Costs.empty(); }
199 };
200 
201 // Processor model.
202 //
203 // ModelName is a unique name used to name an instantiation of MCSchedModel.
204 //
205 // ModelDef is NULL for inferred Models. This happens when a processor defines
206 // an itinerary but no machine model. If the processor defines neither a machine
207 // model nor itinerary, then ModelDef remains pointing to NoModel. NoModel has
208 // the special "NoModel" field set to true.
209 //
210 // ItinsDef always points to a valid record definition, but may point to the
211 // default NoItineraries. NoItineraries has an empty list of InstrItinData
212 // records.
213 //
214 // ItinDefList orders this processor's InstrItinData records by SchedClass idx.
215 struct CodeGenProcModel {
216   unsigned Index;
217   std::string ModelName;
218   Record *ModelDef;
219   Record *ItinsDef;
220 
221   // Derived members...
222 
223   // Array of InstrItinData records indexed by a CodeGenSchedClass index.
224   // This list is empty if the Processor has no value for Itineraries.
225   // Initialized by collectProcItins().
226   RecVec ItinDefList;
227 
228   // Map itinerary classes to per-operand resources.
229   // This list is empty if no ItinRW refers to this Processor.
230   RecVec ItinRWDefs;
231 
232   // List of unsupported feature.
233   // This list is empty if the Processor has no UnsupportedFeatures.
234   RecVec UnsupportedFeaturesDefs;
235 
236   // All read/write resources associated with this processor.
237   RecVec WriteResDefs;
238   RecVec ReadAdvanceDefs;
239 
240   // Per-operand machine model resources associated with this processor.
241   RecVec ProcResourceDefs;
242 
243   // List of Register Files.
244   std::vector<CodeGenRegisterFile> RegisterFiles;
245 
246   // Optional Retire Control Unit definition.
247   Record *RetireControlUnit;
248 
249   // List of PfmCounters.
250   RecVec PfmIssueCounterDefs;
251   Record *PfmCycleCounterDef = nullptr;
252   Record *PfmUopsCounterDef = nullptr;
253 
254   CodeGenProcModel(unsigned Idx, std::string Name, Record *MDef,
255                    Record *IDef) :
256     Index(Idx), ModelName(std::move(Name)), ModelDef(MDef), ItinsDef(IDef),
257     RetireControlUnit(nullptr) {}
258 
259   bool hasItineraries() const {
260     return !ItinsDef->getValueAsListOfDefs("IID").empty();
261   }
262 
263   bool hasInstrSchedModel() const {
264     return !WriteResDefs.empty() || !ItinRWDefs.empty();
265   }
266 
267   bool hasExtraProcessorInfo() const {
268     return RetireControlUnit || !RegisterFiles.empty() ||
269         !PfmIssueCounterDefs.empty() ||
270         PfmCycleCounterDef != nullptr ||
271         PfmUopsCounterDef != nullptr;
272   }
273 
274   unsigned getProcResourceIdx(Record *PRDef) const;
275 
276   bool isUnsupported(const CodeGenInstruction &Inst) const;
277 
278 #ifndef NDEBUG
279   void dump() const;
280 #endif
281 };
282 
283 /// Used to correlate instructions to MCInstPredicates specified by
284 /// InstructionEquivalentClass tablegen definitions.
285 ///
286 /// Example: a XOR of a register with self, is a known zero-idiom for most
287 /// X86 processors.
288 ///
289 /// Each processor can use a (potentially different) InstructionEquivalenceClass
290 ///  definition to classify zero-idioms. That means, XORrr is likely to appear
291 /// in more than one equivalence class (where each class definition is
292 /// contributed by a different processor).
293 ///
294 /// There is no guarantee that the same MCInstPredicate will be used to describe
295 /// equivalence classes that identify XORrr as a zero-idiom.
296 ///
297 /// To be more specific, the requirements for being a zero-idiom XORrr may be
298 /// different for different processors.
299 ///
300 /// Class PredicateInfo identifies a subset of processors that specify the same
301 /// requirements (i.e. same MCInstPredicate and OperandMask) for an instruction
302 /// opcode.
303 ///
304 /// Back to the example. Field `ProcModelMask` will have one bit set for every
305 /// processor model that sees XORrr as a zero-idiom, and that specifies the same
306 /// set of constraints.
307 ///
308 /// By construction, there can be multiple instances of PredicateInfo associated
309 /// with a same instruction opcode. For example, different processors may define
310 /// different constraints on the same opcode.
311 ///
312 /// Field OperandMask can be used as an extra constraint.
313 /// It may be used to describe conditions that appy only to a subset of the
314 /// operands of a machine instruction, and the operands subset may not be the
315 /// same for all processor models.
316 struct PredicateInfo {
317   llvm::APInt ProcModelMask; // A set of processor model indices.
318   llvm::APInt OperandMask;   // An operand mask.
319   const Record *Predicate;   // MCInstrPredicate definition.
320   PredicateInfo(llvm::APInt CpuMask, llvm::APInt Operands, const Record *Pred)
321       : ProcModelMask(CpuMask), OperandMask(Operands), Predicate(Pred) {}
322 
323   bool operator==(const PredicateInfo &Other) const {
324     return ProcModelMask == Other.ProcModelMask &&
325            OperandMask == Other.OperandMask && Predicate == Other.Predicate;
326   }
327 };
328 
329 /// A collection of PredicateInfo objects.
330 ///
331 /// There is at least one OpcodeInfo object for every opcode specified by a
332 /// TIPredicate definition.
333 class OpcodeInfo {
334   std::vector<PredicateInfo> Predicates;
335 
336   OpcodeInfo(const OpcodeInfo &Other) = delete;
337   OpcodeInfo &operator=(const OpcodeInfo &Other) = delete;
338 
339 public:
340   OpcodeInfo() = default;
341   OpcodeInfo &operator=(OpcodeInfo &&Other) = default;
342   OpcodeInfo(OpcodeInfo &&Other) = default;
343 
344   ArrayRef<PredicateInfo> getPredicates() const { return Predicates; }
345 
346   void addPredicateForProcModel(const llvm::APInt &CpuMask,
347                                 const llvm::APInt &OperandMask,
348                                 const Record *Predicate);
349 };
350 
351 /// Used to group together tablegen instruction definitions that are subject
352 /// to a same set of constraints (identified by an instance of OpcodeInfo).
353 class OpcodeGroup {
354   OpcodeInfo Info;
355   std::vector<const Record *> Opcodes;
356 
357   OpcodeGroup(const OpcodeGroup &Other) = delete;
358   OpcodeGroup &operator=(const OpcodeGroup &Other) = delete;
359 
360 public:
361   OpcodeGroup(OpcodeInfo &&OpInfo) : Info(std::move(OpInfo)) {}
362   OpcodeGroup(OpcodeGroup &&Other) = default;
363 
364   void addOpcode(const Record *Opcode) {
365     assert(std::find(Opcodes.begin(), Opcodes.end(), Opcode) == Opcodes.end() &&
366            "Opcode already in set!");
367     Opcodes.push_back(Opcode);
368   }
369 
370   ArrayRef<const Record *> getOpcodes() const { return Opcodes; }
371   const OpcodeInfo &getOpcodeInfo() const { return Info; }
372 };
373 
374 /// An STIPredicateFunction descriptor used by tablegen backends to
375 /// auto-generate the body of a predicate function as a member of tablegen'd
376 /// class XXXGenSubtargetInfo.
377 class STIPredicateFunction {
378   const Record *FunctionDeclaration;
379 
380   std::vector<const Record *> Definitions;
381   std::vector<OpcodeGroup> Groups;
382 
383   STIPredicateFunction(const STIPredicateFunction &Other) = delete;
384   STIPredicateFunction &operator=(const STIPredicateFunction &Other) = delete;
385 
386 public:
387   STIPredicateFunction(const Record *Rec) : FunctionDeclaration(Rec) {}
388   STIPredicateFunction(STIPredicateFunction &&Other) = default;
389 
390   bool isCompatibleWith(const STIPredicateFunction &Other) const {
391     return FunctionDeclaration == Other.FunctionDeclaration;
392   }
393 
394   void addDefinition(const Record *Def) { Definitions.push_back(Def); }
395   void addOpcode(const Record *OpcodeRec, OpcodeInfo &&Info) {
396     if (Groups.empty() ||
397         Groups.back().getOpcodeInfo().getPredicates() != Info.getPredicates())
398       Groups.emplace_back(std::move(Info));
399     Groups.back().addOpcode(OpcodeRec);
400   }
401 
402   StringRef getName() const {
403     return FunctionDeclaration->getValueAsString("Name");
404   }
405   const Record *getDefaultReturnPredicate() const {
406     return FunctionDeclaration->getValueAsDef("DefaultReturnValue");
407   }
408 
409   const Record *getDeclaration() const { return FunctionDeclaration; }
410   ArrayRef<const Record *> getDefinitions() const { return Definitions; }
411   ArrayRef<OpcodeGroup> getGroups() const { return Groups; }
412 };
413 
414 /// Top level container for machine model data.
415 class CodeGenSchedModels {
416   RecordKeeper &Records;
417   const CodeGenTarget &Target;
418 
419   // Map dag expressions to Instruction lists.
420   SetTheory Sets;
421 
422   // List of unique processor models.
423   std::vector<CodeGenProcModel> ProcModels;
424 
425   // Map Processor's MachineModel or ProcItin to a CodeGenProcModel index.
426   using ProcModelMapTy = DenseMap<Record*, unsigned>;
427   ProcModelMapTy ProcModelMap;
428 
429   // Per-operand SchedReadWrite types.
430   std::vector<CodeGenSchedRW> SchedWrites;
431   std::vector<CodeGenSchedRW> SchedReads;
432 
433   // List of unique SchedClasses.
434   std::vector<CodeGenSchedClass> SchedClasses;
435 
436   // Any inferred SchedClass has an index greater than NumInstrSchedClassses.
437   unsigned NumInstrSchedClasses;
438 
439   RecVec ProcResourceDefs;
440   RecVec ProcResGroups;
441 
442   // Map each instruction to its unique SchedClass index considering the
443   // combination of it's itinerary class, SchedRW list, and InstRW records.
444   using InstClassMapTy = DenseMap<Record*, unsigned>;
445   InstClassMapTy InstrClassMap;
446 
447   std::vector<STIPredicateFunction> STIPredicates;
448 
449 public:
450   CodeGenSchedModels(RecordKeeper& RK, const CodeGenTarget &TGT);
451 
452   // iterator access to the scheduling classes.
453   using class_iterator = std::vector<CodeGenSchedClass>::iterator;
454   using const_class_iterator = std::vector<CodeGenSchedClass>::const_iterator;
455   class_iterator classes_begin() { return SchedClasses.begin(); }
456   const_class_iterator classes_begin() const { return SchedClasses.begin(); }
457   class_iterator classes_end() { return SchedClasses.end(); }
458   const_class_iterator classes_end() const { return SchedClasses.end(); }
459   iterator_range<class_iterator> classes() {
460    return make_range(classes_begin(), classes_end());
461   }
462   iterator_range<const_class_iterator> classes() const {
463    return make_range(classes_begin(), classes_end());
464   }
465   iterator_range<class_iterator> explicit_classes() {
466     return make_range(classes_begin(), classes_begin() + NumInstrSchedClasses);
467   }
468   iterator_range<const_class_iterator> explicit_classes() const {
469     return make_range(classes_begin(), classes_begin() + NumInstrSchedClasses);
470   }
471 
472   Record *getModelOrItinDef(Record *ProcDef) const {
473     Record *ModelDef = ProcDef->getValueAsDef("SchedModel");
474     Record *ItinsDef = ProcDef->getValueAsDef("ProcItin");
475     if (!ItinsDef->getValueAsListOfDefs("IID").empty()) {
476       assert(ModelDef->getValueAsBit("NoModel")
477              && "Itineraries must be defined within SchedMachineModel");
478       return ItinsDef;
479     }
480     return ModelDef;
481   }
482 
483   const CodeGenProcModel &getModelForProc(Record *ProcDef) const {
484     Record *ModelDef = getModelOrItinDef(ProcDef);
485     ProcModelMapTy::const_iterator I = ProcModelMap.find(ModelDef);
486     assert(I != ProcModelMap.end() && "missing machine model");
487     return ProcModels[I->second];
488   }
489 
490   CodeGenProcModel &getProcModel(Record *ModelDef) {
491     ProcModelMapTy::const_iterator I = ProcModelMap.find(ModelDef);
492     assert(I != ProcModelMap.end() && "missing machine model");
493     return ProcModels[I->second];
494   }
495   const CodeGenProcModel &getProcModel(Record *ModelDef) const {
496     return const_cast<CodeGenSchedModels*>(this)->getProcModel(ModelDef);
497   }
498 
499   // Iterate over the unique processor models.
500   using ProcIter = std::vector<CodeGenProcModel>::const_iterator;
501   ProcIter procModelBegin() const { return ProcModels.begin(); }
502   ProcIter procModelEnd() const { return ProcModels.end(); }
503   ArrayRef<CodeGenProcModel> procModels() const { return ProcModels; }
504 
505   // Return true if any processors have itineraries.
506   bool hasItineraries() const;
507 
508   // Get a SchedWrite from its index.
509   const CodeGenSchedRW &getSchedWrite(unsigned Idx) const {
510     assert(Idx < SchedWrites.size() && "bad SchedWrite index");
511     assert(SchedWrites[Idx].isValid() && "invalid SchedWrite");
512     return SchedWrites[Idx];
513   }
514   // Get a SchedWrite from its index.
515   const CodeGenSchedRW &getSchedRead(unsigned Idx) const {
516     assert(Idx < SchedReads.size() && "bad SchedRead index");
517     assert(SchedReads[Idx].isValid() && "invalid SchedRead");
518     return SchedReads[Idx];
519   }
520 
521   const CodeGenSchedRW &getSchedRW(unsigned Idx, bool IsRead) const {
522     return IsRead ? getSchedRead(Idx) : getSchedWrite(Idx);
523   }
524   CodeGenSchedRW &getSchedRW(Record *Def) {
525     bool IsRead = Def->isSubClassOf("SchedRead");
526     unsigned Idx = getSchedRWIdx(Def, IsRead);
527     return const_cast<CodeGenSchedRW&>(
528       IsRead ? getSchedRead(Idx) : getSchedWrite(Idx));
529   }
530   const CodeGenSchedRW &getSchedRW(Record *Def) const {
531     return const_cast<CodeGenSchedModels&>(*this).getSchedRW(Def);
532   }
533 
534   unsigned getSchedRWIdx(const Record *Def, bool IsRead) const;
535 
536   // Return true if the given write record is referenced by a ReadAdvance.
537   bool hasReadOfWrite(Record *WriteDef) const;
538 
539   // Get a SchedClass from its index.
540   CodeGenSchedClass &getSchedClass(unsigned Idx) {
541     assert(Idx < SchedClasses.size() && "bad SchedClass index");
542     return SchedClasses[Idx];
543   }
544   const CodeGenSchedClass &getSchedClass(unsigned Idx) const {
545     assert(Idx < SchedClasses.size() && "bad SchedClass index");
546     return SchedClasses[Idx];
547   }
548 
549   // Get the SchedClass index for an instruction. Instructions with no
550   // itinerary, no SchedReadWrites, and no InstrReadWrites references return 0
551   // for NoItinerary.
552   unsigned getSchedClassIdx(const CodeGenInstruction &Inst) const;
553 
554   using SchedClassIter = std::vector<CodeGenSchedClass>::const_iterator;
555   SchedClassIter schedClassBegin() const { return SchedClasses.begin(); }
556   SchedClassIter schedClassEnd() const { return SchedClasses.end(); }
557   ArrayRef<CodeGenSchedClass> schedClasses() const { return SchedClasses; }
558 
559   unsigned numInstrSchedClasses() const { return NumInstrSchedClasses; }
560 
561   void findRWs(const RecVec &RWDefs, IdxVec &Writes, IdxVec &Reads) const;
562   void findRWs(const RecVec &RWDefs, IdxVec &RWs, bool IsRead) const;
563   void expandRWSequence(unsigned RWIdx, IdxVec &RWSeq, bool IsRead) const;
564   void expandRWSeqForProc(unsigned RWIdx, IdxVec &RWSeq, bool IsRead,
565                           const CodeGenProcModel &ProcModel) const;
566 
567   unsigned addSchedClass(Record *ItinDef, ArrayRef<unsigned> OperWrites,
568                          ArrayRef<unsigned> OperReads,
569                          ArrayRef<unsigned> ProcIndices);
570 
571   unsigned findOrInsertRW(ArrayRef<unsigned> Seq, bool IsRead);
572 
573   Record *findProcResUnits(Record *ProcResKind, const CodeGenProcModel &PM,
574                            ArrayRef<SMLoc> Loc) const;
575 
576   ArrayRef<STIPredicateFunction> getSTIPredicates() const {
577     return STIPredicates;
578   }
579 private:
580   void collectProcModels();
581 
582   // Initialize a new processor model if it is unique.
583   void addProcModel(Record *ProcDef);
584 
585   void collectSchedRW();
586 
587   std::string genRWName(ArrayRef<unsigned> Seq, bool IsRead);
588   unsigned findRWForSequence(ArrayRef<unsigned> Seq, bool IsRead);
589 
590   void collectSchedClasses();
591 
592   void collectRetireControlUnits();
593 
594   void collectRegisterFiles();
595 
596   void collectPfmCounters();
597 
598   void collectOptionalProcessorInfo();
599 
600   std::string createSchedClassName(Record *ItinClassDef,
601                                    ArrayRef<unsigned> OperWrites,
602                                    ArrayRef<unsigned> OperReads);
603   std::string createSchedClassName(const RecVec &InstDefs);
604   void createInstRWClass(Record *InstRWDef);
605 
606   void collectProcItins();
607 
608   void collectProcItinRW();
609 
610   void collectProcUnsupportedFeatures();
611 
612   void inferSchedClasses();
613 
614   void checkMCInstPredicates() const;
615 
616   void checkSTIPredicates() const;
617 
618   void collectSTIPredicates();
619 
620   void checkCompleteness();
621 
622   void inferFromRW(ArrayRef<unsigned> OperWrites, ArrayRef<unsigned> OperReads,
623                    unsigned FromClassIdx, ArrayRef<unsigned> ProcIndices);
624   void inferFromItinClass(Record *ItinClassDef, unsigned FromClassIdx);
625   void inferFromInstRWs(unsigned SCIdx);
626 
627   bool hasSuperGroup(RecVec &SubUnits, CodeGenProcModel &PM);
628   void verifyProcResourceGroups(CodeGenProcModel &PM);
629 
630   void collectProcResources();
631 
632   void collectItinProcResources(Record *ItinClassDef);
633 
634   void collectRWResources(unsigned RWIdx, bool IsRead,
635                           ArrayRef<unsigned> ProcIndices);
636 
637   void collectRWResources(ArrayRef<unsigned> Writes, ArrayRef<unsigned> Reads,
638                           ArrayRef<unsigned> ProcIndices);
639 
640   void addProcResource(Record *ProcResourceKind, CodeGenProcModel &PM,
641                        ArrayRef<SMLoc> Loc);
642 
643   void addWriteRes(Record *ProcWriteResDef, unsigned PIdx);
644 
645   void addReadAdvance(Record *ProcReadAdvanceDef, unsigned PIdx);
646 };
647 
648 } // namespace llvm
649 
650 #endif
651