1 //===- RegisterInfoEmitter.cpp - Generate a Register File Desc. -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This tablegen backend is responsible for emitting a description of a target
11 // register file for a code generator. It uses instances of the Register,
12 // RegisterAliases, and RegisterClass classes to gather this information.
14 //===----------------------------------------------------------------------===//
16 #include "RegisterInfoEmitter.h"
17 #include "CodeGenTarget.h"
18 #include "CodeGenRegisters.h"
20 #include "llvm/ADT/StringExtras.h"
21 #include "llvm/ADT/STLExtras.h"
22 #include "llvm/Support/Streams.h"
26 // runEnums - Print out enum values for all of the registers.
27 void RegisterInfoEmitter::runEnums(std::ostream &OS) {
29 const std::vector<CodeGenRegister> &Registers = Target.getRegisters();
31 std::string Namespace = Registers[0].TheDef->getValueAsString("Namespace");
33 EmitSourceFileHeader("Target Register Enum Values", OS);
34 OS << "namespace llvm {\n\n";
36 if (!Namespace.empty())
37 OS << "namespace " << Namespace << " {\n";
38 OS << " enum {\n NoRegister,\n";
40 for (unsigned i = 0, e = Registers.size(); i != e; ++i)
41 OS << " " << Registers[i].getName() << ", \t// " << i+1 << "\n";
42 OS << " NUM_TARGET_REGS \t// " << Registers.size()+1 << "\n";
44 if (!Namespace.empty())
46 OS << "} // End llvm namespace \n";
49 void RegisterInfoEmitter::runHeader(std::ostream &OS) {
50 EmitSourceFileHeader("Register Information Header Fragment", OS);
52 const std::string &TargetName = Target.getName();
53 std::string ClassName = TargetName + "GenRegisterInfo";
55 OS << "#include \"llvm/Target/MRegisterInfo.h\"\n";
56 OS << "#include <string>\n\n";
58 OS << "namespace llvm {\n\n";
60 OS << "struct " << ClassName << " : public MRegisterInfo {\n"
62 << "(int CallFrameSetupOpcode = -1, int CallFrameDestroyOpcode = -1);\n"
63 << " virtual int getDwarfRegNum(unsigned RegNum) const;\n"
64 << " unsigned getSubReg(unsigned RegNo, unsigned Index) const;\n"
67 const std::vector<CodeGenRegisterClass> &RegisterClasses =
68 Target.getRegisterClasses();
70 if (!RegisterClasses.empty()) {
71 OS << "namespace " << RegisterClasses[0].Namespace
72 << " { // Register classes\n";
75 for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
77 OS << " " << RegisterClasses[i].getName() << "RegClassID";
82 for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
83 const std::string &Name = RegisterClasses[i].getName();
85 // Output the register class definition.
86 OS << " struct " << Name << "Class : public TargetRegisterClass {\n"
87 << " " << Name << "Class();\n"
88 << RegisterClasses[i].MethodProtos << " };\n";
90 // Output the extern for the instance.
91 OS << " extern " << Name << "Class\t" << Name << "RegClass;\n";
92 // Output the extern for the pointer to the instance (should remove).
93 OS << " static TargetRegisterClass * const "<< Name <<"RegisterClass = &"
94 << Name << "RegClass;\n";
96 OS << "} // end of namespace " << TargetName << "\n\n";
98 OS << "} // End llvm namespace \n";
101 bool isSubRegisterClass(const CodeGenRegisterClass &RC,
102 std::set<Record*> &RegSet) {
103 for (unsigned i = 0, e = RC.Elements.size(); i != e; ++i) {
104 Record *Reg = RC.Elements[i];
105 if (!RegSet.count(Reg))
111 static void addSuperReg(Record *R, Record *S,
112 std::map<Record*, std::set<Record*> > &SubRegs,
113 std::map<Record*, std::set<Record*> > &SuperRegs,
114 std::map<Record*, std::set<Record*> > &Aliases,
115 RegisterInfoEmitter &RIE) {
117 cerr << "Error: recursive sub-register relationship between"
118 << " register " << RIE.getQualifiedName(R)
119 << " and its sub-registers?\n";
122 if (!SuperRegs[R].insert(S).second)
124 SubRegs[S].insert(R);
125 Aliases[R].insert(S);
126 Aliases[S].insert(R);
127 if (SuperRegs.count(S))
128 for (std::set<Record*>::iterator I = SuperRegs[S].begin(),
129 E = SuperRegs[S].end(); I != E; ++I)
130 addSuperReg(R, *I, SubRegs, SuperRegs, Aliases, RIE);
133 static void addSubSuperReg(Record *R, Record *S,
134 std::map<Record*, std::set<Record*> > &SubRegs,
135 std::map<Record*, std::set<Record*> > &SuperRegs,
136 std::map<Record*, std::set<Record*> > &Aliases,
137 RegisterInfoEmitter &RIE) {
139 cerr << "Error: recursive sub-register relationship between"
140 << " register " << RIE.getQualifiedName(R)
141 << " and its sub-registers?\n";
145 if (!SubRegs[R].insert(S).second)
147 addSuperReg(S, R, SubRegs, SuperRegs, Aliases, RIE);
148 Aliases[R].insert(S);
149 Aliases[S].insert(R);
150 if (SubRegs.count(S))
151 for (std::set<Record*>::iterator I = SubRegs[S].begin(),
152 E = SubRegs[S].end(); I != E; ++I)
153 addSubSuperReg(R, *I, SubRegs, SuperRegs, Aliases, RIE);
156 // RegisterInfoEmitter::run - Main register file description emitter.
158 void RegisterInfoEmitter::run(std::ostream &OS) {
159 CodeGenTarget Target;
160 EmitSourceFileHeader("Register Information Source Fragment", OS);
162 OS << "namespace llvm {\n\n";
164 // Start out by emitting each of the register classes... to do this, we build
165 // a set of registers which belong to a register class, this is to ensure that
166 // each register is only in a single register class.
168 const std::vector<CodeGenRegisterClass> &RegisterClasses =
169 Target.getRegisterClasses();
171 // Loop over all of the register classes... emitting each one.
172 OS << "namespace { // Register classes...\n";
174 // RegClassesBelongedTo - Keep track of which register classes each reg
176 std::multimap<Record*, const CodeGenRegisterClass*> RegClassesBelongedTo;
178 // Emit the register enum value arrays for each RegisterClass
179 for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
180 const CodeGenRegisterClass &RC = RegisterClasses[rc];
182 // Give the register class a legal C name if it's anonymous.
183 std::string Name = RC.TheDef->getName();
185 // Emit the register list now.
186 OS << " // " << Name << " Register Class...\n"
187 << " static const unsigned " << Name
189 for (unsigned i = 0, e = RC.Elements.size(); i != e; ++i) {
190 Record *Reg = RC.Elements[i];
191 OS << getQualifiedName(Reg) << ", ";
193 // Keep track of which regclasses this register is in.
194 RegClassesBelongedTo.insert(std::make_pair(Reg, &RC));
199 // Emit the ValueType arrays for each RegisterClass
200 for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
201 const CodeGenRegisterClass &RC = RegisterClasses[rc];
203 // Give the register class a legal C name if it's anonymous.
204 std::string Name = RC.TheDef->getName() + "VTs";
206 // Emit the register list now.
208 << " Register Class Value Types...\n"
209 << " static const MVT::ValueType " << Name
211 for (unsigned i = 0, e = RC.VTs.size(); i != e; ++i)
212 OS << getEnumName(RC.VTs[i]) << ", ";
213 OS << "MVT::Other\n };\n\n";
215 OS << "} // end anonymous namespace\n\n";
217 // Now that all of the structs have been emitted, emit the instances.
218 if (!RegisterClasses.empty()) {
219 OS << "namespace " << RegisterClasses[0].Namespace
220 << " { // Register class instances\n";
221 for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i)
222 OS << " " << RegisterClasses[i].getName() << "Class\t"
223 << RegisterClasses[i].getName() << "RegClass;\n";
225 std::map<unsigned, std::set<unsigned> > SuperClassMap;
226 std::map<unsigned, std::set<unsigned> > SuperRegClassMap;
229 // Emit the sub-register classes for each RegisterClass
230 for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
231 const CodeGenRegisterClass &RC = RegisterClasses[rc];
233 // Give the register class a legal C name if it's anonymous.
234 std::string Name = RC.TheDef->getName();
237 << " Sub-register Classess...\n"
238 << " static const TargetRegisterClass* const "
239 << Name << "SubRegClasses [] = {\n ";
243 for (unsigned subrc = 0, subrcMax = RC.SubRegClasses.size();
244 subrc != subrcMax; ++subrc) {
245 unsigned rc2 = 0, e2 = RegisterClasses.size();
246 for (; rc2 != e2; ++rc2) {
247 const CodeGenRegisterClass &RC2 = RegisterClasses[rc2];
248 if (RC.SubRegClasses[subrc]->getName() == RC2.getName()) {
251 OS << "&" << getQualifiedName(RC2.TheDef) << "RegClass";
254 std::map<unsigned, std::set<unsigned> >::iterator SCMI =
255 SuperRegClassMap.find(rc2);
256 if (SCMI == SuperRegClassMap.end()) {
257 SuperRegClassMap.insert(std::make_pair(rc2, std::set<unsigned>()));
258 SCMI = SuperRegClassMap.find(rc2);
260 SCMI->second.insert(rc);
265 throw "Register Class member '" +
266 RC.SubRegClasses[subrc]->getName() +
267 "' is not a valid RegisterClass!";
270 OS << (!Empty ? ", " : "") << "NULL";
274 // Emit the super-register classes for each RegisterClass
275 for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
276 const CodeGenRegisterClass &RC = RegisterClasses[rc];
278 // Give the register class a legal C name if it's anonymous.
279 std::string Name = RC.TheDef->getName();
282 << " Super-register Classess...\n"
283 << " static const TargetRegisterClass* const "
284 << Name << "SuperRegClasses [] = {\n ";
287 std::map<unsigned, std::set<unsigned> >::iterator I =
288 SuperRegClassMap.find(rc);
289 if (I != SuperRegClassMap.end()) {
290 for (std::set<unsigned>::iterator II = I->second.begin(),
291 EE = I->second.end(); II != EE; ++II) {
292 const CodeGenRegisterClass &RC2 = RegisterClasses[*II];
295 OS << "&" << getQualifiedName(RC2.TheDef) << "RegClass";
300 OS << (!Empty ? ", " : "") << "NULL";
304 // Emit the sub-classes array for each RegisterClass
305 for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
306 const CodeGenRegisterClass &RC = RegisterClasses[rc];
308 // Give the register class a legal C name if it's anonymous.
309 std::string Name = RC.TheDef->getName();
311 std::set<Record*> RegSet;
312 for (unsigned i = 0, e = RC.Elements.size(); i != e; ++i) {
313 Record *Reg = RC.Elements[i];
318 << " Register Class sub-classes...\n"
319 << " static const TargetRegisterClass* const "
320 << Name << "Subclasses [] = {\n ";
323 for (unsigned rc2 = 0, e2 = RegisterClasses.size(); rc2 != e2; ++rc2) {
324 const CodeGenRegisterClass &RC2 = RegisterClasses[rc2];
325 if (rc == rc2 || RC2.Elements.size() > RC.Elements.size() ||
326 RC.SpillSize != RC2.SpillSize || !isSubRegisterClass(RC2, RegSet))
329 if (!Empty) OS << ", ";
330 OS << "&" << getQualifiedName(RC2.TheDef) << "RegClass";
333 std::map<unsigned, std::set<unsigned> >::iterator SCMI =
334 SuperClassMap.find(rc2);
335 if (SCMI == SuperClassMap.end()) {
336 SuperClassMap.insert(std::make_pair(rc2, std::set<unsigned>()));
337 SCMI = SuperClassMap.find(rc2);
339 SCMI->second.insert(rc);
342 OS << (!Empty ? ", " : "") << "NULL";
346 for (unsigned rc = 0, e = RegisterClasses.size(); rc != e; ++rc) {
347 const CodeGenRegisterClass &RC = RegisterClasses[rc];
349 // Give the register class a legal C name if it's anonymous.
350 std::string Name = RC.TheDef->getName();
353 << " Register Class super-classes...\n"
354 << " static const TargetRegisterClass* const "
355 << Name << "Superclasses [] = {\n ";
358 std::map<unsigned, std::set<unsigned> >::iterator I =
359 SuperClassMap.find(rc);
360 if (I != SuperClassMap.end()) {
361 for (std::set<unsigned>::iterator II = I->second.begin(),
362 EE = I->second.end(); II != EE; ++II) {
363 const CodeGenRegisterClass &RC2 = RegisterClasses[*II];
364 if (!Empty) OS << ", ";
365 OS << "&" << getQualifiedName(RC2.TheDef) << "RegClass";
370 OS << (!Empty ? ", " : "") << "NULL";
375 for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i) {
376 const CodeGenRegisterClass &RC = RegisterClasses[i];
377 OS << RC.MethodBodies << "\n";
378 OS << RC.getName() << "Class::" << RC.getName()
379 << "Class() : TargetRegisterClass("
380 << RC.getName() + "RegClassID" << ", "
381 << RC.getName() + "VTs" << ", "
382 << RC.getName() + "Subclasses" << ", "
383 << RC.getName() + "Superclasses" << ", "
384 << RC.getName() + "SubRegClasses" << ", "
385 << RC.getName() + "SuperRegClasses" << ", "
386 << RC.SpillSize/8 << ", "
387 << RC.SpillAlignment/8 << ", "
388 << RC.CopyCost << ", "
389 << RC.getName() << ", " << RC.getName() << " + " << RC.Elements.size()
396 OS << "\nnamespace {\n";
397 OS << " const TargetRegisterClass* const RegisterClasses[] = {\n";
398 for (unsigned i = 0, e = RegisterClasses.size(); i != e; ++i)
399 OS << " &" << getQualifiedName(RegisterClasses[i].TheDef)
403 // Emit register sub-registers / super-registers, aliases...
404 std::map<Record*, std::set<Record*> > RegisterImmSubRegs;
405 std::map<Record*, std::set<Record*> > RegisterSubRegs;
406 std::map<Record*, std::set<Record*> > RegisterSuperRegs;
407 std::map<Record*, std::set<Record*> > RegisterAliases;
408 std::map<Record*, std::vector<std::pair<int, Record*> > > SubRegVectors;
409 const std::vector<CodeGenRegister> &Regs = Target.getRegisters();
411 for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
412 Record *R = Regs[i].TheDef;
413 std::vector<Record*> LI = Regs[i].TheDef->getValueAsListOfDefs("Aliases");
414 // Add information that R aliases all of the elements in the list... and
415 // that everything in the list aliases R.
416 for (unsigned j = 0, e = LI.size(); j != e; ++j) {
418 if (RegisterAliases[R].count(Reg))
419 cerr << "Warning: register alias between " << getQualifiedName(R)
420 << " and " << getQualifiedName(Reg)
421 << " specified multiple times!\n";
422 RegisterAliases[R].insert(Reg);
424 if (RegisterAliases[Reg].count(R))
425 cerr << "Warning: register alias between " << getQualifiedName(R)
426 << " and " << getQualifiedName(Reg)
427 << " specified multiple times!\n";
428 RegisterAliases[Reg].insert(R);
432 // Process sub-register sets.
433 for (unsigned i = 0, e = Regs.size(); i != e; ++i) {
434 Record *R = Regs[i].TheDef;
435 std::vector<Record*> LI = Regs[i].TheDef->getValueAsListOfDefs("SubRegs");
436 // Process sub-register set and add aliases information.
437 for (unsigned j = 0, e = LI.size(); j != e; ++j) {
438 Record *SubReg = LI[j];
439 if (RegisterSubRegs[R].count(SubReg))
440 cerr << "Warning: register " << getQualifiedName(SubReg)
441 << " specified as a sub-register of " << getQualifiedName(R)
442 << " multiple times!\n";
443 RegisterImmSubRegs[R].insert(SubReg);
444 addSubSuperReg(R, SubReg, RegisterSubRegs, RegisterSuperRegs,
445 RegisterAliases, *this);
449 if (!RegisterAliases.empty())
450 OS << "\n\n // Register Alias Sets...\n";
452 // Emit the empty alias list
453 OS << " const unsigned Empty_AliasSet[] = { 0 };\n";
454 // Loop over all of the registers which have aliases, emitting the alias list
456 for (std::map<Record*, std::set<Record*> >::iterator
457 I = RegisterAliases.begin(), E = RegisterAliases.end(); I != E; ++I) {
458 OS << " const unsigned " << I->first->getName() << "_AliasSet[] = { ";
459 for (std::set<Record*>::iterator ASI = I->second.begin(),
460 E = I->second.end(); ASI != E; ++ASI)
461 OS << getQualifiedName(*ASI) << ", ";
465 if (!RegisterSubRegs.empty())
466 OS << "\n\n // Register Sub-registers Sets...\n";
468 // Emit the empty sub-registers list
469 OS << " const unsigned Empty_SubRegsSet[] = { 0 };\n";
470 // Loop over all of the registers which have sub-registers, emitting the
471 // sub-registers list to memory.
472 for (std::map<Record*, std::set<Record*> >::iterator
473 I = RegisterSubRegs.begin(), E = RegisterSubRegs.end(); I != E; ++I) {
474 OS << " const unsigned " << I->first->getName() << "_SubRegsSet[] = { ";
475 for (std::set<Record*>::iterator ASI = I->second.begin(),
476 E = I->second.end(); ASI != E; ++ASI)
477 OS << getQualifiedName(*ASI) << ", ";
481 if (!RegisterImmSubRegs.empty())
482 OS << "\n\n // Register Immediate Sub-registers Sets...\n";
484 // Loop over all of the registers which have sub-registers, emitting the
485 // sub-registers list to memory.
486 for (std::map<Record*, std::set<Record*> >::iterator
487 I = RegisterImmSubRegs.begin(), E = RegisterImmSubRegs.end();
489 OS << " const unsigned " << I->first->getName() << "_ImmSubRegsSet[] = { ";
490 for (std::set<Record*>::iterator ASI = I->second.begin(),
491 E = I->second.end(); ASI != E; ++ASI)
492 OS << getQualifiedName(*ASI) << ", ";
496 if (!RegisterSuperRegs.empty())
497 OS << "\n\n // Register Super-registers Sets...\n";
499 // Emit the empty super-registers list
500 OS << " const unsigned Empty_SuperRegsSet[] = { 0 };\n";
501 // Loop over all of the registers which have super-registers, emitting the
502 // super-registers list to memory.
503 for (std::map<Record*, std::set<Record*> >::iterator
504 I = RegisterSuperRegs.begin(), E = RegisterSuperRegs.end(); I != E; ++I) {
505 OS << " const unsigned " << I->first->getName() << "_SuperRegsSet[] = { ";
506 for (std::set<Record*>::iterator ASI = I->second.begin(),
507 E = I->second.end(); ASI != E; ++ASI)
508 OS << getQualifiedName(*ASI) << ", ";
512 OS<<"\n const TargetRegisterDesc RegisterDescriptors[] = { // Descriptors\n";
513 OS << " { \"NOREG\",\t0,\t0,\t0,\t0 },\n";
515 // Now that register alias and sub-registers sets have been emitted, emit the
516 // register descriptors now.
517 const std::vector<CodeGenRegister> &Registers = Target.getRegisters();
518 for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
519 const CodeGenRegister &Reg = Registers[i];
521 if (!Reg.TheDef->getValueAsString("Name").empty())
522 OS << Reg.TheDef->getValueAsString("Name");
526 if (RegisterAliases.count(Reg.TheDef))
527 OS << Reg.getName() << "_AliasSet,\t";
529 OS << "Empty_AliasSet,\t";
530 if (RegisterSubRegs.count(Reg.TheDef))
531 OS << Reg.getName() << "_SubRegsSet,\t";
533 OS << "Empty_SubRegsSet,\t";
534 if (RegisterImmSubRegs.count(Reg.TheDef))
535 OS << Reg.getName() << "_ImmSubRegsSet,\t";
537 OS << "Empty_SubRegsSet,\t";
538 if (RegisterSuperRegs.count(Reg.TheDef))
539 OS << Reg.getName() << "_SuperRegsSet },\n";
541 OS << "Empty_SuperRegsSet },\n";
543 OS << " };\n"; // End of register descriptors...
544 OS << "}\n\n"; // End of anonymous namespace...
546 std::string ClassName = Target.getName() + "GenRegisterInfo";
548 // Calculate the mapping of subregister+index pairs to physical registers.
549 std::vector<Record*> SubRegs = Records.getAllDerivedDefinitions("SubRegSet");
550 for (unsigned i = 0, e = SubRegs.size(); i != e; ++i) {
551 int subRegIndex = SubRegs[i]->getValueAsInt("index");
552 std::vector<Record*> From = SubRegs[i]->getValueAsListOfDefs("From");
553 std::vector<Record*> To = SubRegs[i]->getValueAsListOfDefs("To");
555 if (From.size() != To.size()) {
556 cerr << "Error: register list and sub-register list not of equal length"
557 << " in SubRegSet\n";
561 // For each entry in from/to vectors, insert the to register at index
562 for (unsigned ii = 0, ee = From.size(); ii != ee; ++ii)
563 SubRegVectors[From[ii]].push_back(std::make_pair(subRegIndex, To[ii]));
566 // Emit the subregister + index mapping function based on the information
568 OS << "unsigned " << ClassName
569 << "::getSubReg(unsigned RegNo, unsigned Index) const {\n"
570 << " switch (RegNo) {\n"
571 << " default: abort(); break;\n";
572 for (std::map<Record*, std::vector<std::pair<int, Record*> > >::iterator
573 I = SubRegVectors.begin(), E = SubRegVectors.end(); I != E; ++I) {
574 OS << " case " << getQualifiedName(I->first) << ":\n";
575 OS << " switch (Index) {\n";
576 OS << " default: abort(); break;\n";
577 for (unsigned i = 0, e = I->second.size(); i != e; ++i)
578 OS << " case " << (I->second)[i].first << ": return "
579 << getQualifiedName((I->second)[i].second) << ";\n";
580 OS << " }; break;\n";
583 OS << " return 0;\n";
586 // Emit the constructor of the class...
587 OS << ClassName << "::" << ClassName
588 << "(int CallFrameSetupOpcode, int CallFrameDestroyOpcode)\n"
589 << " : MRegisterInfo(RegisterDescriptors, " << Registers.size()+1
590 << ", RegisterClasses, RegisterClasses+" << RegisterClasses.size() <<",\n "
591 << " CallFrameSetupOpcode, CallFrameDestroyOpcode) {}\n\n";
593 // Emit information about the dwarf register numbers.
594 OS << "int " << ClassName << "::getDwarfRegNum(unsigned RegNum) const {\n";
595 OS << " static const int DwarfRegNums[] = { -1, // NoRegister";
596 for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
597 if (!(i % 16)) OS << "\n ";
598 const CodeGenRegister &Reg = Registers[i];
599 int DwarfRegNum = Reg.TheDef->getValueAsInt("DwarfNumber");
601 if ((i + 1) != e) OS << ", ";
604 OS << " assert(RegNum < (sizeof(DwarfRegNums)/sizeof(int)) &&\n";
605 OS << " \"RegNum exceeds number of registers\");\n";
606 OS << " return DwarfRegNums[RegNum];\n";
609 OS << "} // End llvm namespace \n";