1 //===- CodeGenSchedule.h - Scheduling Machine Models ------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines structures to encapsulate the machine model as described in
10 // the target description.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_UTILS_TABLEGEN_CODEGENSCHEDULE_H
15 #define LLVM_UTILS_TABLEGEN_CODEGENSCHEDULE_H
16 
17 #include "llvm/ADT/APInt.h"
18 #include "llvm/ADT/DenseMap.h"
19 #include "llvm/ADT/STLExtras.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 = std::string(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   // Load/Store queue descriptors.
250   Record *LoadQueue;
251   Record *StoreQueue;
252 
253   CodeGenProcModel(unsigned Idx, std::string Name, Record *MDef,
254                    Record *IDef) :
255     Index(Idx), ModelName(std::move(Name)), ModelDef(MDef), ItinsDef(IDef),
256     RetireControlUnit(nullptr), LoadQueue(nullptr), StoreQueue(nullptr) {}
257 
258   bool hasItineraries() const {
259     return !ItinsDef->getValueAsListOfDefs("IID").empty();
260   }
261 
262   bool hasInstrSchedModel() const {
263     return !WriteResDefs.empty() || !ItinRWDefs.empty();
264   }
265 
266   bool hasExtraProcessorInfo() const {
267     return RetireControlUnit || LoadQueue || StoreQueue ||
268            !RegisterFiles.empty();
269   }
270 
271   unsigned getProcResourceIdx(Record *PRDef) const;
272 
273   bool isUnsupported(const CodeGenInstruction &Inst) const;
274 
275 #ifndef NDEBUG
276   void dump() const;
277 #endif
278 };
279 
280 /// Used to correlate instructions to MCInstPredicates specified by
281 /// InstructionEquivalentClass tablegen definitions.
282 ///
283 /// Example: a XOR of a register with self, is a known zero-idiom for most
284 /// X86 processors.
285 ///
286 /// Each processor can use a (potentially different) InstructionEquivalenceClass
287 ///  definition to classify zero-idioms. That means, XORrr is likely to appear
288 /// in more than one equivalence class (where each class definition is
289 /// contributed by a different processor).
290 ///
291 /// There is no guarantee that the same MCInstPredicate will be used to describe
292 /// equivalence classes that identify XORrr as a zero-idiom.
293 ///
294 /// To be more specific, the requirements for being a zero-idiom XORrr may be
295 /// different for different processors.
296 ///
297 /// Class PredicateInfo identifies a subset of processors that specify the same
298 /// requirements (i.e. same MCInstPredicate and OperandMask) for an instruction
299 /// opcode.
300 ///
301 /// Back to the example. Field `ProcModelMask` will have one bit set for every
302 /// processor model that sees XORrr as a zero-idiom, and that specifies the same
303 /// set of constraints.
304 ///
305 /// By construction, there can be multiple instances of PredicateInfo associated
306 /// with a same instruction opcode. For example, different processors may define
307 /// different constraints on the same opcode.
308 ///
309 /// Field OperandMask can be used as an extra constraint.
310 /// It may be used to describe conditions that appy only to a subset of the
311 /// operands of a machine instruction, and the operands subset may not be the
312 /// same for all processor models.
313 struct PredicateInfo {
314   llvm::APInt ProcModelMask; // A set of processor model indices.
315   llvm::APInt OperandMask;   // An operand mask.
316   const Record *Predicate;   // MCInstrPredicate definition.
317   PredicateInfo(llvm::APInt CpuMask, llvm::APInt Operands, const Record *Pred)
318       : ProcModelMask(CpuMask), OperandMask(Operands), Predicate(Pred) {}
319 
320   bool operator==(const PredicateInfo &Other) const {
321     return ProcModelMask == Other.ProcModelMask &&
322            OperandMask == Other.OperandMask && Predicate == Other.Predicate;
323   }
324 };
325 
326 /// A collection of PredicateInfo objects.
327 ///
328 /// There is at least one OpcodeInfo object for every opcode specified by a
329 /// TIPredicate definition.
330 class OpcodeInfo {
331   std::vector<PredicateInfo> Predicates;
332 
333   OpcodeInfo(const OpcodeInfo &Other) = delete;
334   OpcodeInfo &operator=(const OpcodeInfo &Other) = delete;
335 
336 public:
337   OpcodeInfo() = default;
338   OpcodeInfo &operator=(OpcodeInfo &&Other) = default;
339   OpcodeInfo(OpcodeInfo &&Other) = default;
340 
341   ArrayRef<PredicateInfo> getPredicates() const { return Predicates; }
342 
343   void addPredicateForProcModel(const llvm::APInt &CpuMask,
344                                 const llvm::APInt &OperandMask,
345                                 const Record *Predicate);
346 };
347 
348 /// Used to group together tablegen instruction definitions that are subject
349 /// to a same set of constraints (identified by an instance of OpcodeInfo).
350 class OpcodeGroup {
351   OpcodeInfo Info;
352   std::vector<const Record *> Opcodes;
353 
354   OpcodeGroup(const OpcodeGroup &Other) = delete;
355   OpcodeGroup &operator=(const OpcodeGroup &Other) = delete;
356 
357 public:
358   OpcodeGroup(OpcodeInfo &&OpInfo) : Info(std::move(OpInfo)) {}
359   OpcodeGroup(OpcodeGroup &&Other) = default;
360 
361   void addOpcode(const Record *Opcode) {
362     assert(!llvm::is_contained(Opcodes, Opcode) && "Opcode already in set!");
363     Opcodes.push_back(Opcode);
364   }
365 
366   ArrayRef<const Record *> getOpcodes() const { return Opcodes; }
367   const OpcodeInfo &getOpcodeInfo() const { return Info; }
368 };
369 
370 /// An STIPredicateFunction descriptor used by tablegen backends to
371 /// auto-generate the body of a predicate function as a member of tablegen'd
372 /// class XXXGenSubtargetInfo.
373 class STIPredicateFunction {
374   const Record *FunctionDeclaration;
375 
376   std::vector<const Record *> Definitions;
377   std::vector<OpcodeGroup> Groups;
378 
379   STIPredicateFunction(const STIPredicateFunction &Other) = delete;
380   STIPredicateFunction &operator=(const STIPredicateFunction &Other) = delete;
381 
382 public:
383   STIPredicateFunction(const Record *Rec) : FunctionDeclaration(Rec) {}
384   STIPredicateFunction(STIPredicateFunction &&Other) = default;
385 
386   bool isCompatibleWith(const STIPredicateFunction &Other) const {
387     return FunctionDeclaration == Other.FunctionDeclaration;
388   }
389 
390   void addDefinition(const Record *Def) { Definitions.push_back(Def); }
391   void addOpcode(const Record *OpcodeRec, OpcodeInfo &&Info) {
392     if (Groups.empty() ||
393         Groups.back().getOpcodeInfo().getPredicates() != Info.getPredicates())
394       Groups.emplace_back(std::move(Info));
395     Groups.back().addOpcode(OpcodeRec);
396   }
397 
398   StringRef getName() const {
399     return FunctionDeclaration->getValueAsString("Name");
400   }
401   const Record *getDefaultReturnPredicate() const {
402     return FunctionDeclaration->getValueAsDef("DefaultReturnValue");
403   }
404 
405   const Record *getDeclaration() const { return FunctionDeclaration; }
406   ArrayRef<const Record *> getDefinitions() const { return Definitions; }
407   ArrayRef<OpcodeGroup> getGroups() const { return Groups; }
408 };
409 
410 /// Top level container for machine model data.
411 class CodeGenSchedModels {
412   RecordKeeper &Records;
413   const CodeGenTarget &Target;
414 
415   // Map dag expressions to Instruction lists.
416   SetTheory Sets;
417 
418   // List of unique processor models.
419   std::vector<CodeGenProcModel> ProcModels;
420 
421   // Map Processor's MachineModel or ProcItin to a CodeGenProcModel index.
422   using ProcModelMapTy = DenseMap<Record*, unsigned>;
423   ProcModelMapTy ProcModelMap;
424 
425   // Per-operand SchedReadWrite types.
426   std::vector<CodeGenSchedRW> SchedWrites;
427   std::vector<CodeGenSchedRW> SchedReads;
428 
429   // List of unique SchedClasses.
430   std::vector<CodeGenSchedClass> SchedClasses;
431 
432   // Any inferred SchedClass has an index greater than NumInstrSchedClassses.
433   unsigned NumInstrSchedClasses;
434 
435   RecVec ProcResourceDefs;
436   RecVec ProcResGroups;
437 
438   // Map each instruction to its unique SchedClass index considering the
439   // combination of it's itinerary class, SchedRW list, and InstRW records.
440   using InstClassMapTy = DenseMap<Record*, unsigned>;
441   InstClassMapTy InstrClassMap;
442 
443   std::vector<STIPredicateFunction> STIPredicates;
444 
445 public:
446   CodeGenSchedModels(RecordKeeper& RK, const CodeGenTarget &TGT);
447 
448   // iterator access to the scheduling classes.
449   using class_iterator = std::vector<CodeGenSchedClass>::iterator;
450   using const_class_iterator = std::vector<CodeGenSchedClass>::const_iterator;
451   class_iterator classes_begin() { return SchedClasses.begin(); }
452   const_class_iterator classes_begin() const { return SchedClasses.begin(); }
453   class_iterator classes_end() { return SchedClasses.end(); }
454   const_class_iterator classes_end() const { return SchedClasses.end(); }
455   iterator_range<class_iterator> classes() {
456    return make_range(classes_begin(), classes_end());
457   }
458   iterator_range<const_class_iterator> classes() const {
459    return make_range(classes_begin(), classes_end());
460   }
461   iterator_range<class_iterator> explicit_classes() {
462     return make_range(classes_begin(), classes_begin() + NumInstrSchedClasses);
463   }
464   iterator_range<const_class_iterator> explicit_classes() const {
465     return make_range(classes_begin(), classes_begin() + NumInstrSchedClasses);
466   }
467 
468   Record *getModelOrItinDef(Record *ProcDef) const {
469     Record *ModelDef = ProcDef->getValueAsDef("SchedModel");
470     Record *ItinsDef = ProcDef->getValueAsDef("ProcItin");
471     if (!ItinsDef->getValueAsListOfDefs("IID").empty()) {
472       assert(ModelDef->getValueAsBit("NoModel")
473              && "Itineraries must be defined within SchedMachineModel");
474       return ItinsDef;
475     }
476     return ModelDef;
477   }
478 
479   const CodeGenProcModel &getModelForProc(Record *ProcDef) const {
480     Record *ModelDef = getModelOrItinDef(ProcDef);
481     ProcModelMapTy::const_iterator I = ProcModelMap.find(ModelDef);
482     assert(I != ProcModelMap.end() && "missing machine model");
483     return ProcModels[I->second];
484   }
485 
486   CodeGenProcModel &getProcModel(Record *ModelDef) {
487     ProcModelMapTy::const_iterator I = ProcModelMap.find(ModelDef);
488     assert(I != ProcModelMap.end() && "missing machine model");
489     return ProcModels[I->second];
490   }
491   const CodeGenProcModel &getProcModel(Record *ModelDef) const {
492     return const_cast<CodeGenSchedModels*>(this)->getProcModel(ModelDef);
493   }
494 
495   // Iterate over the unique processor models.
496   using ProcIter = std::vector<CodeGenProcModel>::const_iterator;
497   ProcIter procModelBegin() const { return ProcModels.begin(); }
498   ProcIter procModelEnd() const { return ProcModels.end(); }
499   ArrayRef<CodeGenProcModel> procModels() const { return ProcModels; }
500 
501   // Return true if any processors have itineraries.
502   bool hasItineraries() const;
503 
504   // Get a SchedWrite from its index.
505   const CodeGenSchedRW &getSchedWrite(unsigned Idx) const {
506     assert(Idx < SchedWrites.size() && "bad SchedWrite index");
507     assert(SchedWrites[Idx].isValid() && "invalid SchedWrite");
508     return SchedWrites[Idx];
509   }
510   // Get a SchedWrite from its index.
511   const CodeGenSchedRW &getSchedRead(unsigned Idx) const {
512     assert(Idx < SchedReads.size() && "bad SchedRead index");
513     assert(SchedReads[Idx].isValid() && "invalid SchedRead");
514     return SchedReads[Idx];
515   }
516 
517   const CodeGenSchedRW &getSchedRW(unsigned Idx, bool IsRead) const {
518     return IsRead ? getSchedRead(Idx) : getSchedWrite(Idx);
519   }
520   CodeGenSchedRW &getSchedRW(Record *Def) {
521     bool IsRead = Def->isSubClassOf("SchedRead");
522     unsigned Idx = getSchedRWIdx(Def, IsRead);
523     return const_cast<CodeGenSchedRW&>(
524       IsRead ? getSchedRead(Idx) : getSchedWrite(Idx));
525   }
526   const CodeGenSchedRW &getSchedRW(Record *Def) const {
527     return const_cast<CodeGenSchedModels&>(*this).getSchedRW(Def);
528   }
529 
530   unsigned getSchedRWIdx(const Record *Def, bool IsRead) const;
531 
532   // Return true if the given write record is referenced by a ReadAdvance.
533   bool hasReadOfWrite(Record *WriteDef) const;
534 
535   // Get a SchedClass from its index.
536   CodeGenSchedClass &getSchedClass(unsigned Idx) {
537     assert(Idx < SchedClasses.size() && "bad SchedClass index");
538     return SchedClasses[Idx];
539   }
540   const CodeGenSchedClass &getSchedClass(unsigned Idx) const {
541     assert(Idx < SchedClasses.size() && "bad SchedClass index");
542     return SchedClasses[Idx];
543   }
544 
545   // Get the SchedClass index for an instruction. Instructions with no
546   // itinerary, no SchedReadWrites, and no InstrReadWrites references return 0
547   // for NoItinerary.
548   unsigned getSchedClassIdx(const CodeGenInstruction &Inst) const;
549 
550   using SchedClassIter = std::vector<CodeGenSchedClass>::const_iterator;
551   SchedClassIter schedClassBegin() const { return SchedClasses.begin(); }
552   SchedClassIter schedClassEnd() const { return SchedClasses.end(); }
553   ArrayRef<CodeGenSchedClass> schedClasses() const { return SchedClasses; }
554 
555   unsigned numInstrSchedClasses() const { return NumInstrSchedClasses; }
556 
557   void findRWs(const RecVec &RWDefs, IdxVec &Writes, IdxVec &Reads) const;
558   void findRWs(const RecVec &RWDefs, IdxVec &RWs, bool IsRead) const;
559   void expandRWSequence(unsigned RWIdx, IdxVec &RWSeq, bool IsRead) const;
560   void expandRWSeqForProc(unsigned RWIdx, IdxVec &RWSeq, bool IsRead,
561                           const CodeGenProcModel &ProcModel) const;
562 
563   unsigned addSchedClass(Record *ItinDef, ArrayRef<unsigned> OperWrites,
564                          ArrayRef<unsigned> OperReads,
565                          ArrayRef<unsigned> ProcIndices);
566 
567   unsigned findOrInsertRW(ArrayRef<unsigned> Seq, bool IsRead);
568 
569   Record *findProcResUnits(Record *ProcResKind, const CodeGenProcModel &PM,
570                            ArrayRef<SMLoc> Loc) const;
571 
572   ArrayRef<STIPredicateFunction> getSTIPredicates() const {
573     return STIPredicates;
574   }
575 private:
576   void collectProcModels();
577 
578   // Initialize a new processor model if it is unique.
579   void addProcModel(Record *ProcDef);
580 
581   void collectSchedRW();
582 
583   std::string genRWName(ArrayRef<unsigned> Seq, bool IsRead);
584   unsigned findRWForSequence(ArrayRef<unsigned> Seq, bool IsRead);
585 
586   void collectSchedClasses();
587 
588   void collectRetireControlUnits();
589 
590   void collectRegisterFiles();
591 
592   void collectOptionalProcessorInfo();
593 
594   std::string createSchedClassName(Record *ItinClassDef,
595                                    ArrayRef<unsigned> OperWrites,
596                                    ArrayRef<unsigned> OperReads);
597   std::string createSchedClassName(const RecVec &InstDefs);
598   void createInstRWClass(Record *InstRWDef);
599 
600   void collectProcItins();
601 
602   void collectProcItinRW();
603 
604   void collectProcUnsupportedFeatures();
605 
606   void inferSchedClasses();
607 
608   void checkMCInstPredicates() const;
609 
610   void checkSTIPredicates() const;
611 
612   void collectSTIPredicates();
613 
614   void collectLoadStoreQueueInfo();
615 
616   void checkCompleteness();
617 
618   void inferFromRW(ArrayRef<unsigned> OperWrites, ArrayRef<unsigned> OperReads,
619                    unsigned FromClassIdx, ArrayRef<unsigned> ProcIndices);
620   void inferFromItinClass(Record *ItinClassDef, unsigned FromClassIdx);
621   void inferFromInstRWs(unsigned SCIdx);
622 
623   bool hasSuperGroup(RecVec &SubUnits, CodeGenProcModel &PM);
624   void verifyProcResourceGroups(CodeGenProcModel &PM);
625 
626   void collectProcResources();
627 
628   void collectItinProcResources(Record *ItinClassDef);
629 
630   void collectRWResources(unsigned RWIdx, bool IsRead,
631                           ArrayRef<unsigned> ProcIndices);
632 
633   void collectRWResources(ArrayRef<unsigned> Writes, ArrayRef<unsigned> Reads,
634                           ArrayRef<unsigned> ProcIndices);
635 
636   void addProcResource(Record *ProcResourceKind, CodeGenProcModel &PM,
637                        ArrayRef<SMLoc> Loc);
638 
639   void addWriteRes(Record *ProcWriteResDef, unsigned PIdx);
640 
641   void addReadAdvance(Record *ProcReadAdvanceDef, unsigned PIdx);
642 };
643 
644 } // namespace llvm
645 
646 #endif
647