blob: 87a051b0c05ec6cc6bc77540e1820ddc98ce8ef6 [file] [log] [blame]
Andrew Trick2661b412012-07-07 04:00:00 +00001//===- 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//
Alp Tokerae43cab62014-01-24 17:20:08 +000010// This file defines structures to encapsulate the machine model as described in
Andrew Trick2661b412012-07-07 04:00:00 +000011// the target description.
12//
13//===----------------------------------------------------------------------===//
14
Benjamin Kramer00e08fc2014-08-13 16:26:38 +000015#ifndef LLVM_UTILS_TABLEGEN_CODEGENSCHEDULE_H
16#define LLVM_UTILS_TABLEGEN_CODEGENSCHEDULE_H
Andrew Trick2661b412012-07-07 04:00:00 +000017
Andrea Di Biagioa9c15c12018-09-19 15:57:45 +000018#include "llvm/ADT/APInt.h"
Andrew Trick2661b412012-07-07 04:00:00 +000019#include "llvm/ADT/DenseMap.h"
20#include "llvm/ADT/StringMap.h"
Chandler Carruth4ffd89f2012-12-04 10:37:14 +000021#include "llvm/Support/ErrorHandling.h"
22#include "llvm/TableGen/Record.h"
James Molloy3b2a2562014-06-17 13:10:38 +000023#include "llvm/TableGen/SetTheory.h"
Andrew Trick2661b412012-07-07 04:00:00 +000024
25namespace llvm {
26
27class CodeGenTarget;
Andrew Trick48605c32012-09-15 00:19:57 +000028class CodeGenSchedModels;
29class CodeGenInstruction;
Andrea Di Biagioce79db62018-04-03 13:36:24 +000030class CodeGenRegisterClass;
Andrew Trick2661b412012-07-07 04:00:00 +000031
Javed Absar0a82c732017-09-13 10:31:10 +000032using RecVec = std::vector<Record*>;
33using RecIter = std::vector<Record*>::const_iterator;
Andrew Trick48605c32012-09-15 00:19:57 +000034
Javed Absar0a82c732017-09-13 10:31:10 +000035using IdxVec = std::vector<unsigned>;
36using IdxIter = std::vector<unsigned>::const_iterator;
Andrew Trick48605c32012-09-15 00:19:57 +000037
Andrew Trick48605c32012-09-15 00:19:57 +000038/// 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.
45struct CodeGenSchedRW {
Andrew Trick2062b122012-10-03 23:06:28 +000046 unsigned Index;
Andrew Trick48605c32012-09-15 00:19:57 +000047 std::string Name;
48 Record *TheDef;
Andrew Trick2062b122012-10-03 23:06:28 +000049 bool IsRead;
Andrew Trick92649882012-09-22 02:24:21 +000050 bool IsAlias;
Andrew Trick48605c32012-09-15 00:19:57 +000051 bool HasVariants;
52 bool IsVariadic;
53 bool IsSequence;
54 IdxVec Sequence;
Andrew Trick92649882012-09-22 02:24:21 +000055 RecVec Aliases;
Andrew Trick48605c32012-09-15 00:19:57 +000056
Richard Smith8efd0f02012-12-20 01:05:39 +000057 CodeGenSchedRW()
Craig Topper695aa802014-04-16 04:21:27 +000058 : Index(0), TheDef(nullptr), IsRead(false), IsAlias(false),
Richard Smith8efd0f02012-12-20 01:05:39 +000059 HasVariants(false), IsVariadic(false), IsSequence(false) {}
60 CodeGenSchedRW(unsigned Idx, Record *Def)
61 : Index(Idx), TheDef(Def), IsAlias(false), IsVariadic(false) {
Andrew Trick48605c32012-09-15 00:19:57 +000062 Name = Def->getName();
Andrew Trick2062b122012-10-03 23:06:28 +000063 IsRead = Def->isSubClassOf("SchedRead");
Andrew Trick48605c32012-09-15 00:19:57 +000064 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
Benjamin Kramer109f9e62015-10-24 12:46:49 +000074 CodeGenSchedRW(unsigned Idx, bool Read, ArrayRef<unsigned> Seq,
Richard Smith8efd0f02012-12-20 01:05:39 +000075 const std::string &Name)
Benjamin Kramer109f9e62015-10-24 12:46:49 +000076 : Index(Idx), Name(Name), TheDef(nullptr), IsRead(Read), IsAlias(false),
77 HasVariants(false), IsVariadic(false), IsSequence(true), Sequence(Seq) {
Andrew Trick48605c32012-09-15 00:19:57 +000078 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");
Andrew Trick92649882012-09-22 02:24:21 +000086 assert((!IsAlias || Aliases.empty()) && "Alias cannot have aliases");
Andrew Trick48605c32012-09-15 00:19:57 +000087 return TheDef || !Sequence.empty();
88 }
89
90#ifndef NDEBUG
91 void dump() const;
92#endif
93};
94
Andrew Tricke076bb12012-09-18 04:03:30 +000095/// Represent a transition between SchedClasses induced by SchedVariant.
Andrew Trick5e613c22012-09-15 00:19:59 +000096struct CodeGenSchedTransition {
97 unsigned ToClassIdx;
98 IdxVec ProcIndices;
99 RecVec PredTerm;
100};
101
Andrew Trick48605c32012-09-15 00:19:57 +0000102/// 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.
Andrew Trick2661b412012-07-07 04:00:00 +0000126struct CodeGenSchedClass {
Andrew Trick1ab961f2013-03-16 18:58:55 +0000127 unsigned Index;
Andrew Trick2661b412012-07-07 04:00:00 +0000128 std::string Name;
Andrew Trick2661b412012-07-07 04:00:00 +0000129 Record *ItinClassDef;
130
Andrew Trick48605c32012-09-15 00:19:57 +0000131 IdxVec Writes;
132 IdxVec Reads;
133 // Sorted list of ProcIdx, where ProcIdx==0 implies any processor.
134 IdxVec ProcIndices;
135
Andrew Trick5e613c22012-09-15 00:19:59 +0000136 std::vector<CodeGenSchedTransition> Transitions;
137
Andrew Trick92649882012-09-22 02:24:21 +0000138 // 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.
Andrew Trick48605c32012-09-15 00:19:57 +0000142 RecVec InstRWs;
143
Craig Topperd74de622018-03-22 06:15:08 +0000144 CodeGenSchedClass(unsigned Index, std::string Name, Record *ItinClassDef)
145 : Index(Index), Name(std::move(Name)), ItinClassDef(ItinClassDef) {}
Andrew Trick1ab961f2013-03-16 18:58:55 +0000146
Simon Pilgrim6ee668d2018-03-21 17:57:21 +0000147 bool isKeyEqual(Record *IC, ArrayRef<unsigned> W,
148 ArrayRef<unsigned> R) const {
Benjamin Kramer109f9e62015-10-24 12:46:49 +0000149 return ItinClassDef == IC && makeArrayRef(Writes) == W &&
150 makeArrayRef(Reads) == R;
Andrew Trick2661b412012-07-07 04:00:00 +0000151 }
Andrew Trick48605c32012-09-15 00:19:57 +0000152
Andrew Trick1ab961f2013-03-16 18:58:55 +0000153 // 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
Andrew Trick48605c32012-09-15 00:19:57 +0000157#ifndef NDEBUG
158 void dump(const CodeGenSchedModels *SchedModels) const;
159#endif
Andrew Trick2661b412012-07-07 04:00:00 +0000160};
161
Andrea Di Biagioce79db62018-04-03 13:36:24 +0000162/// 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.
167struct CodeGenRegisterCost {
168 Record *RCDef;
169 unsigned Cost;
Andrea Di Biagiof39b0d92018-10-12 11:23:04 +0000170 bool AllowMoveElimination;
171 CodeGenRegisterCost(Record *RC, unsigned RegisterCost, bool AllowMoveElim = false)
172 : RCDef(RC), Cost(RegisterCost), AllowMoveElimination(AllowMoveElim) {}
Andrea Di Biagioce79db62018-04-03 13:36:24 +0000173 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.
182struct CodeGenRegisterFile {
183 std::string Name;
184 Record *RegisterFileDef;
Andrea Di Biagiof39b0d92018-10-12 11:23:04 +0000185 unsigned MaxMovesEliminatedPerCycle;
186 bool AllowZeroMoveEliminationOnly;
Andrea Di Biagioce79db62018-04-03 13:36:24 +0000187
188 unsigned NumPhysRegs;
189 std::vector<CodeGenRegisterCost> Costs;
190
Andrea Di Biagiof39b0d92018-10-12 11:23:04 +0000191 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) {}
Andrea Di Biagioce79db62018-04-03 13:36:24 +0000197
198 bool hasDefaultCosts() const { return Costs.empty(); }
199};
200
Andrew Trick2661b412012-07-07 04:00:00 +0000201// 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
Alp Tokerae43cab62014-01-24 17:20:08 +0000206// an itinerary but no machine model. If the processor defines neither a machine
Andrew Trick2661b412012-07-07 04:00:00 +0000207// 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.
215struct CodeGenProcModel {
Andrew Trick48605c32012-09-15 00:19:57 +0000216 unsigned Index;
Andrew Trick2661b412012-07-07 04:00:00 +0000217 std::string ModelName;
218 Record *ModelDef;
219 Record *ItinsDef;
220
Andrew Trick48605c32012-09-15 00:19:57 +0000221 // Derived members...
Andrew Trick2661b412012-07-07 04:00:00 +0000222
Andrew Trick48605c32012-09-15 00:19:57 +0000223 // 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
Simon Dardis111ec252016-06-24 08:43:27 +0000232 // List of unsupported feature.
233 // This list is empty if the Processor has no UnsupportedFeatures.
234 RecVec UnsupportedFeaturesDefs;
235
Andrew Trick3cbd1782012-09-15 00:20:02 +0000236 // 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
Andrea Di Biagioce79db62018-04-03 13:36:24 +0000243 // List of Register Files.
244 std::vector<CodeGenRegisterFile> RegisterFiles;
245
Andrea Di Biagio8c6c5162018-04-05 15:41:41 +0000246 // Optional Retire Control Unit definition.
247 Record *RetireControlUnit;
248
Andrea Di Biagio51af6fd2018-11-29 12:15:56 +0000249 // Load/Store queue descriptors.
250 Record *LoadQueue;
251 Record *StoreQueue;
252
Craig Topperd74de622018-03-22 06:15:08 +0000253 CodeGenProcModel(unsigned Idx, std::string Name, Record *MDef,
Andrew Trick48605c32012-09-15 00:19:57 +0000254 Record *IDef) :
Andrea Di Biagio8c6c5162018-04-05 15:41:41 +0000255 Index(Idx), ModelName(std::move(Name)), ModelDef(MDef), ItinsDef(IDef),
Andrea Di Biagio51af6fd2018-11-29 12:15:56 +0000256 RetireControlUnit(nullptr), LoadQueue(nullptr), StoreQueue(nullptr) {}
Andrew Trick48605c32012-09-15 00:19:57 +0000257
Andrew Trick1ab961f2013-03-16 18:58:55 +0000258 bool hasItineraries() const {
259 return !ItinsDef->getValueAsListOfDefs("IID").empty();
260 }
261
Andrew Trick3cbd1782012-09-15 00:20:02 +0000262 bool hasInstrSchedModel() const {
263 return !WriteResDefs.empty() || !ItinRWDefs.empty();
264 }
265
Andrea Di Biagioce79db62018-04-03 13:36:24 +0000266 bool hasExtraProcessorInfo() const {
Andrea Di Biagio51af6fd2018-11-29 12:15:56 +0000267 return RetireControlUnit || LoadQueue || StoreQueue ||
268 !RegisterFiles.empty();
Andrea Di Biagioce79db62018-04-03 13:36:24 +0000269 }
270
Andrew Trick3cbd1782012-09-15 00:20:02 +0000271 unsigned getProcResourceIdx(Record *PRDef) const;
272
Simon Dardis111ec252016-06-24 08:43:27 +0000273 bool isUnsupported(const CodeGenInstruction &Inst) const;
274
Andrew Trick48605c32012-09-15 00:19:57 +0000275#ifndef NDEBUG
276 void dump() const;
277#endif
Andrew Trick2661b412012-07-07 04:00:00 +0000278};
279
Andrea Di Biagioa9c15c12018-09-19 15:57:45 +0000280/// 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.
313struct 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.
330class OpcodeInfo {
Andrea Di Biagioeb2ecf32018-09-19 17:54:01 +0000331 std::vector<PredicateInfo> Predicates;
Andrea Di Biagioa9c15c12018-09-19 15:57:45 +0000332
333 OpcodeInfo(const OpcodeInfo &Other) = delete;
334 OpcodeInfo &operator=(const OpcodeInfo &Other) = delete;
335
336public:
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).
350class 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
357public:
358 OpcodeGroup(OpcodeInfo &&OpInfo) : Info(std::move(OpInfo)) {}
359 OpcodeGroup(OpcodeGroup &&Other) = default;
360
361 void addOpcode(const Record *Opcode) {
362 assert(std::find(Opcodes.begin(), Opcodes.end(), Opcode) == Opcodes.end() &&
363 "Opcode already in set!");
364 Opcodes.push_back(Opcode);
365 }
366
367 ArrayRef<const Record *> getOpcodes() const { return Opcodes; }
368 const OpcodeInfo &getOpcodeInfo() const { return Info; }
369};
370
371/// An STIPredicateFunction descriptor used by tablegen backends to
372/// auto-generate the body of a predicate function as a member of tablegen'd
373/// class XXXGenSubtargetInfo.
374class STIPredicateFunction {
375 const Record *FunctionDeclaration;
376
377 std::vector<const Record *> Definitions;
378 std::vector<OpcodeGroup> Groups;
379
380 STIPredicateFunction(const STIPredicateFunction &Other) = delete;
381 STIPredicateFunction &operator=(const STIPredicateFunction &Other) = delete;
382
383public:
384 STIPredicateFunction(const Record *Rec) : FunctionDeclaration(Rec) {}
385 STIPredicateFunction(STIPredicateFunction &&Other) = default;
386
387 bool isCompatibleWith(const STIPredicateFunction &Other) const {
388 return FunctionDeclaration == Other.FunctionDeclaration;
389 }
390
391 void addDefinition(const Record *Def) { Definitions.push_back(Def); }
392 void addOpcode(const Record *OpcodeRec, OpcodeInfo &&Info) {
393 if (Groups.empty() ||
394 Groups.back().getOpcodeInfo().getPredicates() != Info.getPredicates())
395 Groups.emplace_back(std::move(Info));
396 Groups.back().addOpcode(OpcodeRec);
397 }
398
399 StringRef getName() const {
400 return FunctionDeclaration->getValueAsString("Name");
401 }
402 const Record *getDefaultReturnPredicate() const {
403 return FunctionDeclaration->getValueAsDef("DefaultReturnValue");
404 }
405
406 const Record *getDeclaration() const { return FunctionDeclaration; }
407 ArrayRef<const Record *> getDefinitions() const { return Definitions; }
408 ArrayRef<OpcodeGroup> getGroups() const { return Groups; }
409};
410
Andrew Trick48605c32012-09-15 00:19:57 +0000411/// Top level container for machine model data.
Andrew Trick2661b412012-07-07 04:00:00 +0000412class CodeGenSchedModels {
413 RecordKeeper &Records;
414 const CodeGenTarget &Target;
415
Andrew Trick13745262012-10-03 23:06:32 +0000416 // Map dag expressions to Instruction lists.
417 SetTheory Sets;
418
Andrew Trick48605c32012-09-15 00:19:57 +0000419 // List of unique processor models.
420 std::vector<CodeGenProcModel> ProcModels;
421
422 // Map Processor's MachineModel or ProcItin to a CodeGenProcModel index.
Javed Absar0a82c732017-09-13 10:31:10 +0000423 using ProcModelMapTy = DenseMap<Record*, unsigned>;
Andrew Trick48605c32012-09-15 00:19:57 +0000424 ProcModelMapTy ProcModelMap;
425
426 // Per-operand SchedReadWrite types.
427 std::vector<CodeGenSchedRW> SchedWrites;
428 std::vector<CodeGenSchedRW> SchedReads;
429
Andrew Trick2661b412012-07-07 04:00:00 +0000430 // List of unique SchedClasses.
431 std::vector<CodeGenSchedClass> SchedClasses;
432
Andrew Trick48605c32012-09-15 00:19:57 +0000433 // Any inferred SchedClass has an index greater than NumInstrSchedClassses.
434 unsigned NumInstrSchedClasses;
Andrew Trick2661b412012-07-07 04:00:00 +0000435
Matthias Braun4492b0e2016-06-21 03:24:03 +0000436 RecVec ProcResourceDefs;
437 RecVec ProcResGroups;
438
Andrew Trick1ab961f2013-03-16 18:58:55 +0000439 // Map each instruction to its unique SchedClass index considering the
440 // combination of it's itinerary class, SchedRW list, and InstRW records.
Javed Absar0a82c732017-09-13 10:31:10 +0000441 using InstClassMapTy = DenseMap<Record*, unsigned>;
Andrew Trick48605c32012-09-15 00:19:57 +0000442 InstClassMapTy InstrClassMap;
Andrew Trick2661b412012-07-07 04:00:00 +0000443
Andrea Di Biagioa9c15c12018-09-19 15:57:45 +0000444 std::vector<STIPredicateFunction> STIPredicates;
445
Andrew Trick2661b412012-07-07 04:00:00 +0000446public:
447 CodeGenSchedModels(RecordKeeper& RK, const CodeGenTarget &TGT);
448
Jim Grosbachbfe74b92014-04-18 02:09:04 +0000449 // iterator access to the scheduling classes.
Javed Absar0a82c732017-09-13 10:31:10 +0000450 using class_iterator = std::vector<CodeGenSchedClass>::iterator;
451 using const_class_iterator = std::vector<CodeGenSchedClass>::const_iterator;
Jim Grosbachbfe74b92014-04-18 02:09:04 +0000452 class_iterator classes_begin() { return SchedClasses.begin(); }
453 const_class_iterator classes_begin() const { return SchedClasses.begin(); }
454 class_iterator classes_end() { return SchedClasses.end(); }
455 const_class_iterator classes_end() const { return SchedClasses.end(); }
456 iterator_range<class_iterator> classes() {
Craig Toppere6bc7d12015-12-06 05:08:07 +0000457 return make_range(classes_begin(), classes_end());
Jim Grosbachbfe74b92014-04-18 02:09:04 +0000458 }
459 iterator_range<const_class_iterator> classes() const {
Craig Toppere6bc7d12015-12-06 05:08:07 +0000460 return make_range(classes_begin(), classes_end());
Jim Grosbachbfe74b92014-04-18 02:09:04 +0000461 }
462 iterator_range<class_iterator> explicit_classes() {
Craig Toppere6bc7d12015-12-06 05:08:07 +0000463 return make_range(classes_begin(), classes_begin() + NumInstrSchedClasses);
Jim Grosbachbfe74b92014-04-18 02:09:04 +0000464 }
465 iterator_range<const_class_iterator> explicit_classes() const {
Craig Toppere6bc7d12015-12-06 05:08:07 +0000466 return make_range(classes_begin(), classes_begin() + NumInstrSchedClasses);
Jim Grosbachbfe74b92014-04-18 02:09:04 +0000467 }
468
Andrew Trick48605c32012-09-15 00:19:57 +0000469 Record *getModelOrItinDef(Record *ProcDef) const {
470 Record *ModelDef = ProcDef->getValueAsDef("SchedModel");
471 Record *ItinsDef = ProcDef->getValueAsDef("ProcItin");
472 if (!ItinsDef->getValueAsListOfDefs("IID").empty()) {
473 assert(ModelDef->getValueAsBit("NoModel")
474 && "Itineraries must be defined within SchedMachineModel");
475 return ItinsDef;
476 }
477 return ModelDef;
478 }
479
480 const CodeGenProcModel &getModelForProc(Record *ProcDef) const {
481 Record *ModelDef = getModelOrItinDef(ProcDef);
482 ProcModelMapTy::const_iterator I = ProcModelMap.find(ModelDef);
483 assert(I != ProcModelMap.end() && "missing machine model");
484 return ProcModels[I->second];
485 }
486
Andrew Tricka3d82ce2013-06-15 04:50:06 +0000487 CodeGenProcModel &getProcModel(Record *ModelDef) {
Andrew Trick48605c32012-09-15 00:19:57 +0000488 ProcModelMapTy::const_iterator I = ProcModelMap.find(ModelDef);
489 assert(I != ProcModelMap.end() && "missing machine model");
490 return ProcModels[I->second];
491 }
Andrew Tricka3d82ce2013-06-15 04:50:06 +0000492 const CodeGenProcModel &getProcModel(Record *ModelDef) const {
493 return const_cast<CodeGenSchedModels*>(this)->getProcModel(ModelDef);
494 }
Andrew Trick48605c32012-09-15 00:19:57 +0000495
496 // Iterate over the unique processor models.
Javed Absar0a82c732017-09-13 10:31:10 +0000497 using ProcIter = std::vector<CodeGenProcModel>::const_iterator;
Andrew Trick48605c32012-09-15 00:19:57 +0000498 ProcIter procModelBegin() const { return ProcModels.begin(); }
499 ProcIter procModelEnd() const { return ProcModels.end(); }
Craig Topperdcbac182016-02-13 06:03:32 +0000500 ArrayRef<CodeGenProcModel> procModels() const { return ProcModels; }
Andrew Trick48605c32012-09-15 00:19:57 +0000501
Andrew Trick1ab961f2013-03-16 18:58:55 +0000502 // Return true if any processors have itineraries.
503 bool hasItineraries() const;
504
Andrew Trick48605c32012-09-15 00:19:57 +0000505 // Get a SchedWrite from its index.
506 const CodeGenSchedRW &getSchedWrite(unsigned Idx) const {
507 assert(Idx < SchedWrites.size() && "bad SchedWrite index");
508 assert(SchedWrites[Idx].isValid() && "invalid SchedWrite");
509 return SchedWrites[Idx];
510 }
511 // Get a SchedWrite from its index.
512 const CodeGenSchedRW &getSchedRead(unsigned Idx) const {
513 assert(Idx < SchedReads.size() && "bad SchedRead index");
514 assert(SchedReads[Idx].isValid() && "invalid SchedRead");
515 return SchedReads[Idx];
516 }
517
518 const CodeGenSchedRW &getSchedRW(unsigned Idx, bool IsRead) const {
519 return IsRead ? getSchedRead(Idx) : getSchedWrite(Idx);
520 }
Andrew Trick2062b122012-10-03 23:06:28 +0000521 CodeGenSchedRW &getSchedRW(Record *Def) {
Andrew Trick92649882012-09-22 02:24:21 +0000522 bool IsRead = Def->isSubClassOf("SchedRead");
Andrew Trick2062b122012-10-03 23:06:28 +0000523 unsigned Idx = getSchedRWIdx(Def, IsRead);
Andrew Trick92649882012-09-22 02:24:21 +0000524 return const_cast<CodeGenSchedRW&>(
525 IsRead ? getSchedRead(Idx) : getSchedWrite(Idx));
526 }
Andrea Di Biagiobf50bde2018-04-26 12:56:26 +0000527 const CodeGenSchedRW &getSchedRW(Record *Def) const {
Andrew Trick2062b122012-10-03 23:06:28 +0000528 return const_cast<CodeGenSchedModels&>(*this).getSchedRW(Def);
Andrew Trick92649882012-09-22 02:24:21 +0000529 }
Andrew Trick48605c32012-09-15 00:19:57 +0000530
Andrea Di Biagiobf50bde2018-04-26 12:56:26 +0000531 unsigned getSchedRWIdx(const Record *Def, bool IsRead) const;
Andrew Trick48605c32012-09-15 00:19:57 +0000532
Andrew Trick3b8fb642012-09-19 04:43:19 +0000533 // Return true if the given write record is referenced by a ReadAdvance.
534 bool hasReadOfWrite(Record *WriteDef) const;
535
Andrew Trick2661b412012-07-07 04:00:00 +0000536 // Get a SchedClass from its index.
Andrew Trick48605c32012-09-15 00:19:57 +0000537 CodeGenSchedClass &getSchedClass(unsigned Idx) {
538 assert(Idx < SchedClasses.size() && "bad SchedClass index");
539 return SchedClasses[Idx];
540 }
541 const CodeGenSchedClass &getSchedClass(unsigned Idx) const {
Andrew Trick2661b412012-07-07 04:00:00 +0000542 assert(Idx < SchedClasses.size() && "bad SchedClass index");
543 return SchedClasses[Idx];
544 }
545
Andrew Trick48605c32012-09-15 00:19:57 +0000546 // Get the SchedClass index for an instruction. Instructions with no
547 // itinerary, no SchedReadWrites, and no InstrReadWrites references return 0
548 // for NoItinerary.
549 unsigned getSchedClassIdx(const CodeGenInstruction &Inst) const;
550
Javed Absar0a82c732017-09-13 10:31:10 +0000551 using SchedClassIter = std::vector<CodeGenSchedClass>::const_iterator;
Andrew Trick48605c32012-09-15 00:19:57 +0000552 SchedClassIter schedClassBegin() const { return SchedClasses.begin(); }
553 SchedClassIter schedClassEnd() const { return SchedClasses.end(); }
Craig Topperdcbac182016-02-13 06:03:32 +0000554 ArrayRef<CodeGenSchedClass> schedClasses() const { return SchedClasses; }
Andrew Trick2661b412012-07-07 04:00:00 +0000555
Andrew Trick1ab961f2013-03-16 18:58:55 +0000556 unsigned numInstrSchedClasses() const { return NumInstrSchedClasses; }
557
Andrew Trick48605c32012-09-15 00:19:57 +0000558 void findRWs(const RecVec &RWDefs, IdxVec &Writes, IdxVec &Reads) const;
559 void findRWs(const RecVec &RWDefs, IdxVec &RWs, bool IsRead) const;
Andrew Trick5e613c22012-09-15 00:19:59 +0000560 void expandRWSequence(unsigned RWIdx, IdxVec &RWSeq, bool IsRead) const;
Andrew Trick2062b122012-10-03 23:06:28 +0000561 void expandRWSeqForProc(unsigned RWIdx, IdxVec &RWSeq, bool IsRead,
562 const CodeGenProcModel &ProcModel) const;
Andrew Trick48605c32012-09-15 00:19:57 +0000563
Benjamin Kramer109f9e62015-10-24 12:46:49 +0000564 unsigned addSchedClass(Record *ItinDef, ArrayRef<unsigned> OperWrites,
565 ArrayRef<unsigned> OperReads,
566 ArrayRef<unsigned> ProcIndices);
Andrew Trick48605c32012-09-15 00:19:57 +0000567
568 unsigned findOrInsertRW(ArrayRef<unsigned> Seq, bool IsRead);
569
Evandro Menezes8304ff22017-11-21 21:33:52 +0000570 Record *findProcResUnits(Record *ProcResKind, const CodeGenProcModel &PM,
571 ArrayRef<SMLoc> Loc) const;
Andrew Trick3cbd1782012-09-15 00:20:02 +0000572
Andrea Di Biagioa9c15c12018-09-19 15:57:45 +0000573 ArrayRef<STIPredicateFunction> getSTIPredicates() const {
574 return STIPredicates;
575 }
Andrew Trick2661b412012-07-07 04:00:00 +0000576private:
Andrew Trick48605c32012-09-15 00:19:57 +0000577 void collectProcModels();
Andrew Trick2661b412012-07-07 04:00:00 +0000578
579 // Initialize a new processor model if it is unique.
580 void addProcModel(Record *ProcDef);
581
Andrew Trick48605c32012-09-15 00:19:57 +0000582 void collectSchedRW();
583
Benjamin Kramer109f9e62015-10-24 12:46:49 +0000584 std::string genRWName(ArrayRef<unsigned> Seq, bool IsRead);
585 unsigned findRWForSequence(ArrayRef<unsigned> Seq, bool IsRead);
Andrew Trick48605c32012-09-15 00:19:57 +0000586
587 void collectSchedClasses();
588
Andrea Di Biagio8c6c5162018-04-05 15:41:41 +0000589 void collectRetireControlUnits();
590
Andrea Di Biagioce79db62018-04-03 13:36:24 +0000591 void collectRegisterFiles();
592
Andrea Di Biagio8c6c5162018-04-05 15:41:41 +0000593 void collectOptionalProcessorInfo();
594
Andrew Trick1ab961f2013-03-16 18:58:55 +0000595 std::string createSchedClassName(Record *ItinClassDef,
Benjamin Kramer109f9e62015-10-24 12:46:49 +0000596 ArrayRef<unsigned> OperWrites,
597 ArrayRef<unsigned> OperReads);
Andrew Trick48605c32012-09-15 00:19:57 +0000598 std::string createSchedClassName(const RecVec &InstDefs);
599 void createInstRWClass(Record *InstRWDef);
600
601 void collectProcItins();
602
603 void collectProcItinRW();
Andrew Trick5e613c22012-09-15 00:19:59 +0000604
Simon Dardis111ec252016-06-24 08:43:27 +0000605 void collectProcUnsupportedFeatures();
606
Andrew Trick5e613c22012-09-15 00:19:59 +0000607 void inferSchedClasses();
608
Andrea Di Biagioe9759dd2018-08-14 18:36:54 +0000609 void checkMCInstPredicates() const;
Josh Stonec1ddded2018-09-11 17:28:43 +0000610
Andrea Di Biagioa9c15c12018-09-19 15:57:45 +0000611 void checkSTIPredicates() const;
612
613 void collectSTIPredicates();
614
Andrea Di Biagio51af6fd2018-11-29 12:15:56 +0000615 void collectLoadStoreQueueInfo();
616
Matthias Brauneab28692016-03-01 20:03:21 +0000617 void checkCompleteness();
618
Benjamin Kramer109f9e62015-10-24 12:46:49 +0000619 void inferFromRW(ArrayRef<unsigned> OperWrites, ArrayRef<unsigned> OperReads,
620 unsigned FromClassIdx, ArrayRef<unsigned> ProcIndices);
Andrew Trick5e613c22012-09-15 00:19:59 +0000621 void inferFromItinClass(Record *ItinClassDef, unsigned FromClassIdx);
622 void inferFromInstRWs(unsigned SCIdx);
Andrew Trick3cbd1782012-09-15 00:20:02 +0000623
Andrew Tricke30f32a2013-04-23 23:45:14 +0000624 bool hasSuperGroup(RecVec &SubUnits, CodeGenProcModel &PM);
625 void verifyProcResourceGroups(CodeGenProcModel &PM);
626
Andrew Trick3cbd1782012-09-15 00:20:02 +0000627 void collectProcResources();
628
629 void collectItinProcResources(Record *ItinClassDef);
630
Andrew Trickdbe6d432012-10-10 05:43:13 +0000631 void collectRWResources(unsigned RWIdx, bool IsRead,
Benjamin Kramer109f9e62015-10-24 12:46:49 +0000632 ArrayRef<unsigned> ProcIndices);
Andrew Trickdbe6d432012-10-10 05:43:13 +0000633
Benjamin Kramer109f9e62015-10-24 12:46:49 +0000634 void collectRWResources(ArrayRef<unsigned> Writes, ArrayRef<unsigned> Reads,
635 ArrayRef<unsigned> ProcIndices);
Andrew Trick3cbd1782012-09-15 00:20:02 +0000636
Evandro Menezes8304ff22017-11-21 21:33:52 +0000637 void addProcResource(Record *ProcResourceKind, CodeGenProcModel &PM,
638 ArrayRef<SMLoc> Loc);
Andrew Trick3cbd1782012-09-15 00:20:02 +0000639
640 void addWriteRes(Record *ProcWriteResDef, unsigned PIdx);
641
642 void addReadAdvance(Record *ProcReadAdvanceDef, unsigned PIdx);
Andrew Trick2661b412012-07-07 04:00:00 +0000643};
644
645} // namespace llvm
646
647#endif