//===- SubtargetEmitter.cpp - Generate subtarget enumerations -------------===// // // The LLVM Compiler Infrastructure // // This file is distributed under the University of Illinois Open Source // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// // // This tablegen backend emits subtarget enumerations. // //===----------------------------------------------------------------------===// #include "SubtargetEmitter.h" #include "CodeGenTarget.h" #include "llvm/TableGen/Record.h" #include "llvm/ADT/StringExtras.h" #include "llvm/Support/Debug.h" #include <algorithm> using namespace llvm; // // Enumeration - Emit the specified class as an enumeration. // void SubtargetEmitter::Enumeration(raw_ostream &OS, const char *ClassName, bool isBits) { // Get all records of class and sort std::vector<Record*> DefList = Records.getAllDerivedDefinitions(ClassName); std::sort(DefList.begin(), DefList.end(), LessRecord()); unsigned N = DefList.size(); if (N == 0) return; if (N > 64) { errs() << "Too many (> 64) subtarget features!\n"; exit(1); } OS << "namespace " << Target << " {\n"; // Open enumeration OS << "enum {\n"; // For each record for (unsigned i = 0; i < N;) { // Next record Record *Def = DefList[i]; // Get and emit name OS << " " << Def->getName(); // If bit flags then emit expression (1 << i) if (isBits) OS << " = " << " 1ULL << " << i; // Depending on 'if more in the list' emit comma if (++i < N) OS << ","; OS << "\n"; } // Close enumeration OS << "};\n"; OS << "}\n"; } // // FeatureKeyValues - Emit data of all the subtarget features. Used by the // command line. // unsigned SubtargetEmitter::FeatureKeyValues(raw_ostream &OS) { // Gather and sort all the features std::vector<Record*> FeatureList = Records.getAllDerivedDefinitions("SubtargetFeature"); if (FeatureList.empty()) return 0; std::sort(FeatureList.begin(), FeatureList.end(), LessRecordFieldName()); // Begin feature table OS << "// Sorted (by key) array of values for CPU features.\n" << "llvm::SubtargetFeatureKV " << Target << "FeatureKV[] = {\n"; // For each feature unsigned NumFeatures = 0; for (unsigned i = 0, N = FeatureList.size(); i < N; ++i) { // Next feature Record *Feature = FeatureList[i]; const std::string &Name = Feature->getName(); const std::string &CommandLineName = Feature->getValueAsString("Name"); const std::string &Desc = Feature->getValueAsString("Desc"); if (CommandLineName.empty()) continue; // Emit as { "feature", "description", featureEnum, i1 | i2 | ... | in } OS << " { " << "\"" << CommandLineName << "\", " << "\"" << Desc << "\", " << Target << "::" << Name << ", "; const std::vector<Record*> &ImpliesList = Feature->getValueAsListOfDefs("Implies"); if (ImpliesList.empty()) { OS << "0ULL"; } else { for (unsigned j = 0, M = ImpliesList.size(); j < M;) { OS << Target << "::" << ImpliesList[j]->getName(); if (++j < M) OS << " | "; } } OS << " }"; ++NumFeatures; // Depending on 'if more in the list' emit comma if ((i + 1) < N) OS << ","; OS << "\n"; } // End feature table OS << "};\n"; return NumFeatures; } // // CPUKeyValues - Emit data of all the subtarget processors. Used by command // line. // unsigned SubtargetEmitter::CPUKeyValues(raw_ostream &OS) { // Gather and sort processor information std::vector<Record*> ProcessorList = Records.getAllDerivedDefinitions("Processor"); std::sort(ProcessorList.begin(), ProcessorList.end(), LessRecordFieldName()); // Begin processor table OS << "// Sorted (by key) array of values for CPU subtype.\n" << "llvm::SubtargetFeatureKV " << Target << "SubTypeKV[] = {\n"; // For each processor for (unsigned i = 0, N = ProcessorList.size(); i < N;) { // Next processor Record *Processor = ProcessorList[i]; const std::string &Name = Processor->getValueAsString("Name"); const std::vector<Record*> &FeatureList = Processor->getValueAsListOfDefs("Features"); // Emit as { "cpu", "description", f1 | f2 | ... fn }, OS << " { " << "\"" << Name << "\", " << "\"Select the " << Name << " processor\", "; if (FeatureList.empty()) { OS << "0ULL"; } else { for (unsigned j = 0, M = FeatureList.size(); j < M;) { OS << Target << "::" << FeatureList[j]->getName(); if (++j < M) OS << " | "; } } // The "0" is for the "implies" section of this data structure. OS << ", 0ULL }"; // Depending on 'if more in the list' emit comma if (++i < N) OS << ","; OS << "\n"; } // End processor table OS << "};\n"; return ProcessorList.size(); } // // CollectAllItinClasses - Gathers and enumerates all the itinerary classes. // Returns itinerary class count. // unsigned SubtargetEmitter:: CollectAllItinClasses(raw_ostream &OS, std::map<std::string, unsigned> &ItinClassesMap, std::vector<Record*> &ItinClassList) { // For each itinerary class unsigned N = ItinClassList.size(); for (unsigned i = 0; i < N; i++) { // Next itinerary class const Record *ItinClass = ItinClassList[i]; // Get name of itinerary class // Assign itinerary class a unique number ItinClassesMap[ItinClass->getName()] = i; } // Return itinerary class count return N; } // // FormItineraryStageString - Compose a string containing the stage // data initialization for the specified itinerary. N is the number // of stages. // void SubtargetEmitter::FormItineraryStageString(const std::string &Name, Record *ItinData, std::string &ItinString, unsigned &NStages) { // Get states list const std::vector<Record*> &StageList = ItinData->getValueAsListOfDefs("Stages"); // For each stage unsigned N = NStages = StageList.size(); for (unsigned i = 0; i < N;) { // Next stage const Record *Stage = StageList[i]; // Form string as ,{ cycles, u1 | u2 | ... | un, timeinc, kind } int Cycles = Stage->getValueAsInt("Cycles"); ItinString += " { " + itostr(Cycles) + ", "; // Get unit list const std::vector<Record*> &UnitList = Stage->getValueAsListOfDefs("Units"); // For each unit for (unsigned j = 0, M = UnitList.size(); j < M;) { // Add name and bitwise or ItinString += Name + "FU::" + UnitList[j]->getName(); if (++j < M) ItinString += " | "; } int TimeInc = Stage->getValueAsInt("TimeInc"); ItinString += ", " + itostr(TimeInc); int Kind = Stage->getValueAsInt("Kind"); ItinString += ", (llvm::InstrStage::ReservationKinds)" + itostr(Kind); // Close off stage ItinString += " }"; if (++i < N) ItinString += ", "; } } // // FormItineraryOperandCycleString - Compose a string containing the // operand cycle initialization for the specified itinerary. N is the // number of operands that has cycles specified. // void SubtargetEmitter::FormItineraryOperandCycleString(Record *ItinData, std::string &ItinString, unsigned &NOperandCycles) { // Get operand cycle list const std::vector<int64_t> &OperandCycleList = ItinData->getValueAsListOfInts("OperandCycles"); // For each operand cycle unsigned N = NOperandCycles = OperandCycleList.size(); for (unsigned i = 0; i < N;) { // Next operand cycle const int OCycle = OperandCycleList[i]; ItinString += " " + itostr(OCycle); if (++i < N) ItinString += ", "; } } void SubtargetEmitter::FormItineraryBypassString(const std::string &Name, Record *ItinData, std::string &ItinString, unsigned NOperandCycles) { const std::vector<Record*> &BypassList = ItinData->getValueAsListOfDefs("Bypasses"); unsigned N = BypassList.size(); unsigned i = 0; for (; i < N;) { ItinString += Name + "Bypass::" + BypassList[i]->getName(); if (++i < NOperandCycles) ItinString += ", "; } for (; i < NOperandCycles;) { ItinString += " 0"; if (++i < NOperandCycles) ItinString += ", "; } } // // EmitStageAndOperandCycleData - Generate unique itinerary stages and // operand cycle tables. Record itineraries for processors. // void SubtargetEmitter::EmitStageAndOperandCycleData(raw_ostream &OS, unsigned NItinClasses, std::map<std::string, unsigned> &ItinClassesMap, std::vector<Record*> &ItinClassList, std::vector<std::vector<InstrItinerary> > &ProcList) { // Gather processor iteraries std::vector<Record*> ProcItinList = Records.getAllDerivedDefinitions("ProcessorItineraries"); // If just no itinerary then don't bother if (ProcItinList.size() < 2) return; // Emit functional units for all the itineraries. for (unsigned i = 0, N = ProcItinList.size(); i < N; ++i) { // Next record Record *Proc = ProcItinList[i]; std::vector<Record*> FUs = Proc->getValueAsListOfDefs("FU"); if (FUs.empty()) continue; const std::string &Name = Proc->getName(); OS << "\n// Functional units for itineraries \"" << Name << "\"\n" << "namespace " << Name << "FU {\n"; for (unsigned j = 0, FUN = FUs.size(); j < FUN; ++j) OS << " const unsigned " << FUs[j]->getName() << " = 1 << " << j << ";\n"; OS << "}\n"; std::vector<Record*> BPs = Proc->getValueAsListOfDefs("BP"); if (BPs.size()) { OS << "\n// Pipeline forwarding pathes for itineraries \"" << Name << "\"\n" << "namespace " << Name << "Bypass {\n"; OS << " unsigned NoBypass = 0;\n"; for (unsigned j = 0, BPN = BPs.size(); j < BPN; ++j) OS << " unsigned " << BPs[j]->getName() << " = 1 << " << j << ";\n"; OS << "}\n"; } } // Begin stages table std::string StageTable = "\nllvm::InstrStage " + Target + "Stages[] = {\n"; StageTable += " { 0, 0, 0, llvm::InstrStage::Required }, // No itinerary\n"; // Begin operand cycle table std::string OperandCycleTable = "unsigned " + Target + "OperandCycles[] = {\n"; OperandCycleTable += " 0, // No itinerary\n"; // Begin pipeline bypass table std::string BypassTable = "unsigned " + Target + "ForwardingPathes[] = {\n"; BypassTable += " 0, // No itinerary\n"; unsigned StageCount = 1, OperandCycleCount = 1; std::map<std::string, unsigned> ItinStageMap, ItinOperandMap; for (unsigned i = 0, N = ProcItinList.size(); i < N; i++) { // Next record Record *Proc = ProcItinList[i]; // Get processor itinerary name const std::string &Name = Proc->getName(); // Skip default if (Name == "NoItineraries") continue; // Create and expand processor itinerary to cover all itinerary classes std::vector<InstrItinerary> ItinList; ItinList.resize(NItinClasses); // Get itinerary data list std::vector<Record*> ItinDataList = Proc->getValueAsListOfDefs("IID"); // For each itinerary data for (unsigned j = 0, M = ItinDataList.size(); j < M; j++) { // Next itinerary data Record *ItinData = ItinDataList[j]; // Get string and stage count std::string ItinStageString; unsigned NStages; FormItineraryStageString(Name, ItinData, ItinStageString, NStages); // Get string and operand cycle count std::string ItinOperandCycleString; unsigned NOperandCycles; FormItineraryOperandCycleString(ItinData, ItinOperandCycleString, NOperandCycles); std::string ItinBypassString; FormItineraryBypassString(Name, ItinData, ItinBypassString, NOperandCycles); // Check to see if stage already exists and create if it doesn't unsigned FindStage = 0; if (NStages > 0) { FindStage = ItinStageMap[ItinStageString]; if (FindStage == 0) { // Emit as { cycles, u1 | u2 | ... | un, timeinc }, // indices StageTable += ItinStageString + ", // " + itostr(StageCount); if (NStages > 1) StageTable += "-" + itostr(StageCount + NStages - 1); StageTable += "\n"; // Record Itin class number. ItinStageMap[ItinStageString] = FindStage = StageCount; StageCount += NStages; } } // Check to see if operand cycle already exists and create if it doesn't unsigned FindOperandCycle = 0; if (NOperandCycles > 0) { std::string ItinOperandString = ItinOperandCycleString+ItinBypassString; FindOperandCycle = ItinOperandMap[ItinOperandString]; if (FindOperandCycle == 0) { // Emit as cycle, // index OperandCycleTable += ItinOperandCycleString + ", // "; std::string OperandIdxComment = itostr(OperandCycleCount); if (NOperandCycles > 1) OperandIdxComment += "-" + itostr(OperandCycleCount + NOperandCycles - 1); OperandCycleTable += OperandIdxComment + "\n"; // Record Itin class number. ItinOperandMap[ItinOperandCycleString] = FindOperandCycle = OperandCycleCount; // Emit as bypass, // index BypassTable += ItinBypassString + ", // " + OperandIdxComment + "\n"; OperandCycleCount += NOperandCycles; } } // Locate where to inject into processor itinerary table const std::string &Name = ItinData->getValueAsDef("TheClass")->getName(); unsigned Find = ItinClassesMap[Name]; // Set up itinerary as location and location + stage count unsigned NumUOps = ItinClassList[Find]->getValueAsInt("NumMicroOps"); InstrItinerary Intinerary = { NumUOps, FindStage, FindStage + NStages, FindOperandCycle, FindOperandCycle + NOperandCycles}; // Inject - empty slots will be 0, 0 ItinList[Find] = Intinerary; } // Add process itinerary to list ProcList.push_back(ItinList); } // Closing stage StageTable += " { 0, 0, 0, llvm::InstrStage::Required } // End itinerary\n"; StageTable += "};\n"; // Closing operand cycles OperandCycleTable += " 0 // End itinerary\n"; OperandCycleTable += "};\n"; BypassTable += " 0 // End itinerary\n"; BypassTable += "};\n"; // Emit tables. OS << StageTable; OS << OperandCycleTable; OS << BypassTable; } // // EmitProcessorData - Generate data for processor itineraries. // void SubtargetEmitter:: EmitProcessorData(raw_ostream &OS, std::vector<Record*> &ItinClassList, std::vector<std::vector<InstrItinerary> > &ProcList) { // Get an iterator for processor itinerary stages std::vector<std::vector<InstrItinerary> >::iterator ProcListIter = ProcList.begin(); // For each processor itinerary std::vector<Record*> Itins = Records.getAllDerivedDefinitions("ProcessorItineraries"); for (unsigned i = 0, N = Itins.size(); i < N; i++) { // Next record Record *Itin = Itins[i]; // Get processor itinerary name const std::string &Name = Itin->getName(); // Skip default if (Name == "NoItineraries") continue; // Begin processor itinerary table OS << "\n"; OS << "llvm::InstrItinerary " << Name << "[] = {\n"; // For each itinerary class std::vector<InstrItinerary> &ItinList = *ProcListIter++; assert(ItinList.size() == ItinClassList.size() && "bad itinerary"); for (unsigned j = 0, M = ItinList.size(); j < M; ++j) { InstrItinerary &Intinerary = ItinList[j]; // Emit in the form of // { firstStage, lastStage, firstCycle, lastCycle } // index if (Intinerary.FirstStage == 0) { OS << " { 1, 0, 0, 0, 0 }"; } else { OS << " { " << Intinerary.NumMicroOps << ", " << Intinerary.FirstStage << ", " << Intinerary.LastStage << ", " << Intinerary.FirstOperandCycle << ", " << Intinerary.LastOperandCycle << " }"; } OS << ", // " << j << " " << ItinClassList[j]->getName() << "\n"; } // End processor itinerary table OS << " { 1, ~0U, ~0U, ~0U, ~0U } // end marker\n"; OS << "};\n"; } } // // EmitProcessorLookup - generate cpu name to itinerary lookup table. // void SubtargetEmitter::EmitProcessorLookup(raw_ostream &OS) { // Gather and sort processor information std::vector<Record*> ProcessorList = Records.getAllDerivedDefinitions("Processor"); std::sort(ProcessorList.begin(), ProcessorList.end(), LessRecordFieldName()); // Begin processor table OS << "\n"; OS << "// Sorted (by key) array of itineraries for CPU subtype.\n" << "llvm::SubtargetInfoKV " << Target << "ProcItinKV[] = {\n"; // For each processor for (unsigned i = 0, N = ProcessorList.size(); i < N;) { // Next processor Record *Processor = ProcessorList[i]; const std::string &Name = Processor->getValueAsString("Name"); const std::string &ProcItin = Processor->getValueAsDef("ProcItin")->getName(); // Emit as { "cpu", procinit }, OS << " { " << "\"" << Name << "\", " << "(void *)&" << ProcItin; OS << " }"; // Depending on ''if more in the list'' emit comma if (++i < N) OS << ","; OS << "\n"; } // End processor table OS << "};\n"; } // // EmitData - Emits all stages and itineries, folding common patterns. // void SubtargetEmitter::EmitData(raw_ostream &OS) { std::map<std::string, unsigned> ItinClassesMap; // Gather and sort all itinerary classes std::vector<Record*> ItinClassList = Records.getAllDerivedDefinitions("InstrItinClass"); std::sort(ItinClassList.begin(), ItinClassList.end(), LessRecord()); // Enumerate all the itinerary classes unsigned NItinClasses = CollectAllItinClasses(OS, ItinClassesMap, ItinClassList); // Make sure the rest is worth the effort HasItineraries = NItinClasses != 1; // Ignore NoItinerary. if (HasItineraries) { std::vector<std::vector<InstrItinerary> > ProcList; // Emit the stage data EmitStageAndOperandCycleData(OS, NItinClasses, ItinClassesMap, ItinClassList, ProcList); // Emit the processor itinerary data EmitProcessorData(OS, ItinClassList, ProcList); // Emit the processor lookup data EmitProcessorLookup(OS); } } // // ParseFeaturesFunction - Produces a subtarget specific function for parsing // the subtarget features string. // void SubtargetEmitter::ParseFeaturesFunction(raw_ostream &OS, unsigned NumFeatures, unsigned NumProcs) { std::vector<Record*> Features = Records.getAllDerivedDefinitions("SubtargetFeature"); std::sort(Features.begin(), Features.end(), LessRecord()); OS << "// ParseSubtargetFeatures - Parses features string setting specified\n" << "// subtarget options.\n" << "void llvm::"; OS << Target; OS << "Subtarget::ParseSubtargetFeatures(StringRef CPU, StringRef FS) {\n" << " DEBUG(dbgs() << \"\\nFeatures:\" << FS);\n" << " DEBUG(dbgs() << \"\\nCPU:\" << CPU);\n"; if (Features.empty()) { OS << "}\n"; return; } OS << " uint64_t Bits = ReInitMCSubtargetInfo(CPU, FS);\n"; for (unsigned i = 0; i < Features.size(); i++) { // Next record Record *R = Features[i]; const std::string &Instance = R->getName(); const std::string &Value = R->getValueAsString("Value"); const std::string &Attribute = R->getValueAsString("Attribute"); if (Value=="true" || Value=="false") OS << " if ((Bits & " << Target << "::" << Instance << ") != 0) " << Attribute << " = " << Value << ";\n"; else OS << " if ((Bits & " << Target << "::" << Instance << ") != 0 && " << Attribute << " < " << Value << ") " << Attribute << " = " << Value << ";\n"; } OS << "}\n"; } // // SubtargetEmitter::run - Main subtarget enumeration emitter. // void SubtargetEmitter::run(raw_ostream &OS) { Target = CodeGenTarget(Records).getName(); EmitSourceFileHeader("Subtarget Enumeration Source Fragment", OS); OS << "\n#ifdef GET_SUBTARGETINFO_ENUM\n"; OS << "#undef GET_SUBTARGETINFO_ENUM\n"; OS << "namespace llvm {\n"; Enumeration(OS, "SubtargetFeature", true); OS << "} // End llvm namespace \n"; OS << "#endif // GET_SUBTARGETINFO_ENUM\n\n"; OS << "\n#ifdef GET_SUBTARGETINFO_MC_DESC\n"; OS << "#undef GET_SUBTARGETINFO_MC_DESC\n"; OS << "namespace llvm {\n"; #if 0 OS << "namespace {\n"; #endif unsigned NumFeatures = FeatureKeyValues(OS); OS << "\n"; unsigned NumProcs = CPUKeyValues(OS); OS << "\n"; EmitData(OS); OS << "\n"; #if 0 OS << "}\n"; #endif // MCInstrInfo initialization routine. OS << "static inline void Init" << Target << "MCSubtargetInfo(MCSubtargetInfo *II, " << "StringRef TT, StringRef CPU, StringRef FS) {\n"; OS << " II->InitMCSubtargetInfo(TT, CPU, FS, "; if (NumFeatures) OS << Target << "FeatureKV, "; else OS << "0, "; if (NumProcs) OS << Target << "SubTypeKV, "; else OS << "0, "; if (HasItineraries) { OS << Target << "ProcItinKV, " << Target << "Stages, " << Target << "OperandCycles, " << Target << "ForwardingPathes, "; } else OS << "0, 0, 0, 0, "; OS << NumFeatures << ", " << NumProcs << ");\n}\n\n"; OS << "} // End llvm namespace \n"; OS << "#endif // GET_SUBTARGETINFO_MC_DESC\n\n"; OS << "\n#ifdef GET_SUBTARGETINFO_TARGET_DESC\n"; OS << "#undef GET_SUBTARGETINFO_TARGET_DESC\n"; OS << "#include \"llvm/Support/Debug.h\"\n"; OS << "#include \"llvm/Support/raw_ostream.h\"\n"; ParseFeaturesFunction(OS, NumFeatures, NumProcs); OS << "#endif // GET_SUBTARGETINFO_TARGET_DESC\n\n"; // Create a TargetSubtargetInfo subclass to hide the MC layer initialization. OS << "\n#ifdef GET_SUBTARGETINFO_HEADER\n"; OS << "#undef GET_SUBTARGETINFO_HEADER\n"; std::string ClassName = Target + "GenSubtargetInfo"; OS << "namespace llvm {\n"; OS << "struct " << ClassName << " : public TargetSubtargetInfo {\n" << " explicit " << ClassName << "(StringRef TT, StringRef CPU, " << "StringRef FS);\n" << "};\n"; OS << "} // End llvm namespace \n"; OS << "#endif // GET_SUBTARGETINFO_HEADER\n\n"; OS << "\n#ifdef GET_SUBTARGETINFO_CTOR\n"; OS << "#undef GET_SUBTARGETINFO_CTOR\n"; OS << "namespace llvm {\n"; OS << "extern llvm::SubtargetFeatureKV " << Target << "FeatureKV[];\n"; OS << "extern llvm::SubtargetFeatureKV " << Target << "SubTypeKV[];\n"; if (HasItineraries) { OS << "extern llvm::SubtargetInfoKV " << Target << "ProcItinKV[];\n"; OS << "extern llvm::InstrStage " << Target << "Stages[];\n"; OS << "extern unsigned " << Target << "OperandCycles[];\n"; OS << "extern unsigned " << Target << "ForwardingPathes[];\n"; } OS << ClassName << "::" << ClassName << "(StringRef TT, StringRef CPU, " << "StringRef FS)\n" << " : TargetSubtargetInfo() {\n" << " InitMCSubtargetInfo(TT, CPU, FS, "; if (NumFeatures) OS << Target << "FeatureKV, "; else OS << "0, "; if (NumProcs) OS << Target << "SubTypeKV, "; else OS << "0, "; if (HasItineraries) { OS << Target << "ProcItinKV, " << Target << "Stages, " << Target << "OperandCycles, " << Target << "ForwardingPathes, "; } else OS << "0, 0, 0, 0, "; OS << NumFeatures << ", " << NumProcs << ");\n}\n\n"; OS << "} // End llvm namespace \n"; OS << "#endif // GET_SUBTARGETINFO_CTOR\n\n"; }