utils/TableGen/AsmWriterEmitter.cpp

   1 //===- AsmWriterEmitter.cpp - Generate an assembly writer -----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This tablegen backend is emits an assembly printer for the current target.
  11 // Note that this is currently fairly skeletal, but will grow over time.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "AsmWriterInst.h"
  16 #include "CodeGenTarget.h"
  17 #include "SequenceToOffsetTable.h"
  18 #include "llvm/ADT/SmallString.h"
  19 #include "llvm/ADT/StringExtras.h"
  20 #include "llvm/ADT/Twine.h"
  21 #include "llvm/Support/Debug.h"
  22 #include "llvm/Support/Format.h"
  23 #include "llvm/Support/MathExtras.h"
  24 #include "llvm/TableGen/Error.h"
  25 #include "llvm/TableGen/Record.h"
  26 #include "llvm/TableGen/TableGenBackend.h"
  27 #include <algorithm>
  28 #include <cassert>
  29 #include <map>
  30 #include <vector>
  31 using namespace llvm;
  32
  33 #define DEBUG_TYPE "asm-writer-emitter"
  34
  35 namespace {
  36 class AsmWriterEmitter {
  37   RecordKeeper &Records;
  38   CodeGenTarget Target;
  39   std::map<const CodeGenInstruction*, AsmWriterInst*> CGIAWIMap;
  40   const std::vector<const CodeGenInstruction*> *NumberedInstructions;
  41   std::vector<AsmWriterInst> Instructions;
  42   std::vector<std::string> PrintMethods;
  43 public:
  44   AsmWriterEmitter(RecordKeeper &R);
  45
  46   void run(raw_ostream &o);
  47
  48 private:
  49   void EmitPrintInstruction(raw_ostream &o);
  50   void EmitGetRegisterName(raw_ostream &o);
  51   void EmitPrintAliasInstruction(raw_ostream &O);
  52
  53   AsmWriterInst *getAsmWriterInstByID(unsigned ID) const {
  54     assert(ID < NumberedInstructions->size());
  55     std::map<const CodeGenInstruction*, AsmWriterInst*>::const_iterator I =
  56       CGIAWIMap.find(NumberedInstructions->at(ID));
  57     assert(I != CGIAWIMap.end() && "Didn't find inst!");
  58     return I->second;
  59   }
  60   void FindUniqueOperandCommands(std::vector<std::string> &UOC,
  61                                  std::vector<unsigned> &InstIdxs,
  62                                  std::vector<unsigned> &InstOpsUsed) const;
  63 };
  64 } // end anonymous namespace
  65
  66 static void PrintCases(std::vector<std::pair<std::string,
  67                        AsmWriterOperand> > &OpsToPrint, raw_ostream &O) {
  68   O << "    case " << OpsToPrint.back().first << ": ";
  69   AsmWriterOperand TheOp = OpsToPrint.back().second;
  70   OpsToPrint.pop_back();
  71
  72   // Check to see if any other operands are identical in this list, and if so,
  73   // emit a case label for them.
  74   for (unsigned i = OpsToPrint.size(); i != 0; --i)
  75     if (OpsToPrint[i-1].second == TheOp) {
  76       O << "\n    case " << OpsToPrint[i-1].first << ": ";
  77       OpsToPrint.erase(OpsToPrint.begin()+i-1);
  78     }
  79
  80   // Finally, emit the code.
  81   O << TheOp.getCode();
  82   O << "break;\n";
  83 }
  84
  85
  86 /// EmitInstructions - Emit the last instruction in the vector and any other
  87 /// instructions that are suitably similar to it.
  88 static void EmitInstructions(std::vector<AsmWriterInst> &Insts,
  89                              raw_ostream &O) {
  90   AsmWriterInst FirstInst = Insts.back();
  91   Insts.pop_back();
  92
  93   std::vector<AsmWriterInst> SimilarInsts;
  94   unsigned DifferingOperand = ~0;
  95   for (unsigned i = Insts.size(); i != 0; --i) {
  96     unsigned DiffOp = Insts[i-1].MatchesAllButOneOp(FirstInst);
  97     if (DiffOp != ~1U) {
  98       if (DifferingOperand == ~0U)  // First match!
  99         DifferingOperand = DiffOp;
 100
 101       // If this differs in the same operand as the rest of the instructions in
 102       // this class, move it to the SimilarInsts list.
 103       if (DifferingOperand == DiffOp || DiffOp == ~0U) {
 104         SimilarInsts.push_back(Insts[i-1]);
 105         Insts.erase(Insts.begin()+i-1);
 106       }
 107     }
 108   }
 109
 110   O << "  case " << FirstInst.CGI->Namespace << "::"
 111     << FirstInst.CGI->TheDef->getName() << ":\n";
 112   for (const AsmWriterInst &AWI : SimilarInsts)
 113     O << "  case " << AWI.CGI->Namespace << "::"
 114       << AWI.CGI->TheDef->getName() << ":\n";
 115   for (unsigned i = 0, e = FirstInst.Operands.size(); i != e; ++i) {
 116     if (i != DifferingOperand) {
 117       // If the operand is the same for all instructions, just print it.
 118       O << "    " << FirstInst.Operands[i].getCode();
 119     } else {
 120       // If this is the operand that varies between all of the instructions,
 121       // emit a switch for just this operand now.
 122       O << "    switch (MI->getOpcode()) {\n";
 123       std::vector<std::pair<std::string, AsmWriterOperand> > OpsToPrint;
 124       OpsToPrint.push_back(std::make_pair(FirstInst.CGI->Namespace + "::" +
 125                                           FirstInst.CGI->TheDef->getName(),
 126                                           FirstInst.Operands[i]));
 127
 128       for (const AsmWriterInst &AWI : SimilarInsts) {
 129         OpsToPrint.push_back(std::make_pair(AWI.CGI->Namespace+"::"+
 130                                             AWI.CGI->TheDef->getName(),
 131                                             AWI.Operands[i]));
 132       }
 133       std::reverse(OpsToPrint.begin(), OpsToPrint.end());
 134       while (!OpsToPrint.empty())
 135         PrintCases(OpsToPrint, O);
 136       O << "    }";
 137     }
 138     O << "\n";
 139   }
 140   O << "    break;\n";
 141 }
 142
 143 void AsmWriterEmitter::
 144 FindUniqueOperandCommands(std::vector<std::string> &UniqueOperandCommands,
 145                           std::vector<unsigned> &InstIdxs,
 146                           std::vector<unsigned> &InstOpsUsed) const {
 147   InstIdxs.assign(NumberedInstructions->size(), ~0U);
 148
 149   // This vector parallels UniqueOperandCommands, keeping track of which
 150   // instructions each case are used for.  It is a comma separated string of
 151   // enums.
 152   std::vector<std::string> InstrsForCase;
 153   InstrsForCase.resize(UniqueOperandCommands.size());
 154   InstOpsUsed.assign(UniqueOperandCommands.size(), 0);
 155
 156   for (unsigned i = 0, e = NumberedInstructions->size(); i != e; ++i) {
 157     const AsmWriterInst *Inst = getAsmWriterInstByID(i);
 158     if (!Inst)
 159       continue; // PHI, INLINEASM, CFI_INSTRUCTION, etc.
 160
 161     if (Inst->Operands.empty())
 162       continue;   // Instruction already done.
 163
 164     std::string Command = "    " + Inst->Operands[0].getCode() + "\n";
 165
 166     // Check to see if we already have 'Command' in UniqueOperandCommands.
 167     // If not, add it.
 168     bool FoundIt = false;
 169     for (unsigned idx = 0, e = UniqueOperandCommands.size(); idx != e; ++idx)
 170       if (UniqueOperandCommands[idx] == Command) {
 171         InstIdxs[i] = idx;
 172         InstrsForCase[idx] += ", ";
 173         InstrsForCase[idx] += Inst->CGI->TheDef->getName();
 174         FoundIt = true;
 175         break;
 176       }
 177     if (!FoundIt) {
 178       InstIdxs[i] = UniqueOperandCommands.size();
 179       UniqueOperandCommands.push_back(std::move(Command));
 180       InstrsForCase.push_back(Inst->CGI->TheDef->getName());
 181
 182       // This command matches one operand so far.
 183       InstOpsUsed.push_back(1);
 184     }
 185   }
 186
 187   // For each entry of UniqueOperandCommands, there is a set of instructions
 188   // that uses it.  If the next command of all instructions in the set are
 189   // identical, fold it into the command.
 190   for (unsigned CommandIdx = 0, e = UniqueOperandCommands.size();
 191        CommandIdx != e; ++CommandIdx) {
 192
 193     for (unsigned Op = 1; ; ++Op) {
 194       // Scan for the first instruction in the set.
 195       std::vector<unsigned>::iterator NIT =
 196         std::find(InstIdxs.begin(), InstIdxs.end(), CommandIdx);
 197       if (NIT == InstIdxs.end()) break;  // No commonality.
 198
 199       // If this instruction has no more operands, we isn't anything to merge
 200       // into this command.
 201       const AsmWriterInst *FirstInst =
 202         getAsmWriterInstByID(NIT-InstIdxs.begin());
 203       if (!FirstInst || FirstInst->Operands.size() == Op)
 204         break;
 205
 206       // Otherwise, scan to see if all of the other instructions in this command
 207       // set share the operand.
 208       bool AllSame = true;
 209
 210       for (NIT = std::find(NIT+1, InstIdxs.end(), CommandIdx);
 211            NIT != InstIdxs.end();
 212            NIT = std::find(NIT+1, InstIdxs.end(), CommandIdx)) {
 213         // Okay, found another instruction in this command set.  If the operand
 214         // matches, we're ok, otherwise bail out.
 215         const AsmWriterInst *OtherInst =
 216           getAsmWriterInstByID(NIT-InstIdxs.begin());
 217
 218         if (!OtherInst || OtherInst->Operands.size() == Op ||
 219             OtherInst->Operands[Op] != FirstInst->Operands[Op]) {
 220           AllSame = false;
 221           break;
 222         }
 223       }
 224       if (!AllSame) break;
 225
 226       // Okay, everything in this command set has the same next operand.  Add it
 227       // to UniqueOperandCommands and remember that it was consumed.
 228       std::string Command = "    " + FirstInst->Operands[Op].getCode() + "\n";
 229
 230       UniqueOperandCommands[CommandIdx] += Command;
 231       InstOpsUsed[CommandIdx]++;
 232     }
 233   }
 234
 235   // Prepend some of the instructions each case is used for onto the case val.
 236   for (unsigned i = 0, e = InstrsForCase.size(); i != e; ++i) {
 237     std::string Instrs = InstrsForCase[i];
 238     if (Instrs.size() > 70) {
 239       Instrs.erase(Instrs.begin()+70, Instrs.end());
 240       Instrs += "...";
 241     }
 242
 243     if (!Instrs.empty())
 244       UniqueOperandCommands[i] = "    // " + Instrs + "\n" +
 245         UniqueOperandCommands[i];
 246   }
 247 }
 248
 249
 250 static void UnescapeString(std::string &Str) {
 251   for (unsigned i = 0; i != Str.size(); ++i) {
 252     if (Str[i] == '\\' && i != Str.size()-1) {
 253       switch (Str[i+1]) {
 254       default: continue;  // Don't execute the code after the switch.
 255       case 'a': Str[i] = '\a'; break;
 256       case 'b': Str[i] = '\b'; break;
 257       case 'e': Str[i] = 27; break;
 258       case 'f': Str[i] = '\f'; break;
 259       case 'n': Str[i] = '\n'; break;
 260       case 'r': Str[i] = '\r'; break;
 261       case 't': Str[i] = '\t'; break;
 262       case 'v': Str[i] = '\v'; break;
 263       case '"': Str[i] = '\"'; break;
 264       case '\'': Str[i] = '\''; break;
 265       case '\\': Str[i] = '\\'; break;
 266       }
 267       // Nuke the second character.
 268       Str.erase(Str.begin()+i+1);
 269     }
 270   }
 271 }
 272
 273 /// EmitPrintInstruction - Generate the code for the "printInstruction" method
 274 /// implementation. Destroys all instances of AsmWriterInst information, by
 275 /// clearing the Instructions vector.
 276 void AsmWriterEmitter::EmitPrintInstruction(raw_ostream &O) {
 277   Record *AsmWriter = Target.getAsmWriter();
 278   std::string ClassName = AsmWriter->getValueAsString("AsmWriterClassName");
 279   unsigned PassSubtarget = AsmWriter->getValueAsInt("PassSubtarget");
 280
 281   O <<
 282   "/// printInstruction - This method is automatically generated by tablegen\n"
 283   "/// from the instruction set description.\n"
 284     "void " << Target.getName() << ClassName
 285             << "::printInstruction(const MCInst *MI, "
 286             << (PassSubtarget ? "const MCSubtargetInfo &STI, " : "")
 287             << "raw_ostream &O) {\n";
 288
 289   // Build an aggregate string, and build a table of offsets into it.
 290   SequenceToOffsetTable<std::string> StringTable;
 291
 292   /// OpcodeInfo - This encodes the index of the string to use for the first
 293   /// chunk of the output as well as indices used for operand printing.
 294   std::vector<uint64_t> OpcodeInfo;
 295
 296   // Add all strings to the string table upfront so it can generate an optimized
 297   // representation.
 298   for (const CodeGenInstruction *Inst : *NumberedInstructions) {
 299     AsmWriterInst *AWI = CGIAWIMap[Inst];
 300     if (AWI &&
 301         AWI->Operands[0].OperandType ==
 302                  AsmWriterOperand::isLiteralTextOperand &&
 303         !AWI->Operands[0].Str.empty()) {
 304       std::string Str = AWI->Operands[0].Str;
 305       UnescapeString(Str);
 306       StringTable.add(Str);
 307     }
 308   }
 309
 310   StringTable.layout();
 311
 312   unsigned MaxStringIdx = 0;
 313   for (const CodeGenInstruction *Inst : *NumberedInstructions) {
 314     AsmWriterInst *AWI = CGIAWIMap[Inst];
 315     unsigned Idx;
 316     if (!AWI) {
 317       // Something not handled by the asmwriter printer.
 318       Idx = ~0U;
 319     } else if (AWI->Operands[0].OperandType !=
 320                         AsmWriterOperand::isLiteralTextOperand ||
 321                AWI->Operands[0].Str.empty()) {
 322       // Something handled by the asmwriter printer, but with no leading string.
 323       Idx = StringTable.get("");
 324     } else {
 325       std::string Str = AWI->Operands[0].Str;
 326       UnescapeString(Str);
 327       Idx = StringTable.get(Str);
 328       MaxStringIdx = std::max(MaxStringIdx, Idx);
 329
 330       // Nuke the string from the operand list.  It is now handled!
 331       AWI->Operands.erase(AWI->Operands.begin());
 332     }
 333
 334     // Bias offset by one since we want 0 as a sentinel.
 335     OpcodeInfo.push_back(Idx+1);
 336   }
 337
 338   // Figure out how many bits we used for the string index.
 339   unsigned AsmStrBits = Log2_32_Ceil(MaxStringIdx+2);
 340
 341   // To reduce code size, we compactify common instructions into a few bits
 342   // in the opcode-indexed table.
 343   unsigned BitsLeft = 64-AsmStrBits;
 344
 345   std::vector<std::vector<std::string>> TableDrivenOperandPrinters;
 346
 347   while (1) {
 348     std::vector<std::string> UniqueOperandCommands;
 349     std::vector<unsigned> InstIdxs;
 350     std::vector<unsigned> NumInstOpsHandled;
 351     FindUniqueOperandCommands(UniqueOperandCommands, InstIdxs,
 352                               NumInstOpsHandled);
 353
 354     // If we ran out of operands to print, we're done.
 355     if (UniqueOperandCommands.empty()) break;
 356
 357     // Compute the number of bits we need to represent these cases, this is
 358     // ceil(log2(numentries)).
 359     unsigned NumBits = Log2_32_Ceil(UniqueOperandCommands.size());
 360
 361     // If we don't have enough bits for this operand, don't include it.
 362     if (NumBits > BitsLeft) {
 363       DEBUG(errs() << "Not enough bits to densely encode " << NumBits
 364                    << " more bits\n");
 365       break;
 366     }
 367
 368     // Otherwise, we can include this in the initial lookup table.  Add it in.
 369     for (unsigned i = 0, e = InstIdxs.size(); i != e; ++i)
 370       if (InstIdxs[i] != ~0U) {
 371         OpcodeInfo[i] |= (uint64_t)InstIdxs[i] << (64-BitsLeft);
 372       }
 373     BitsLeft -= NumBits;
 374
 375     // Remove the info about this operand.
 376     for (unsigned i = 0, e = NumberedInstructions->size(); i != e; ++i) {
 377       if (AsmWriterInst *Inst = getAsmWriterInstByID(i))
 378         if (!Inst->Operands.empty()) {
 379           unsigned NumOps = NumInstOpsHandled[InstIdxs[i]];
 380           assert(NumOps <= Inst->Operands.size() &&
 381                  "Can't remove this many ops!");
 382           Inst->Operands.erase(Inst->Operands.begin(),
 383                                Inst->Operands.begin()+NumOps);
 384         }
 385     }
 386
 387     // Remember the handlers for this set of operands.
 388     TableDrivenOperandPrinters.push_back(std::move(UniqueOperandCommands));
 389   }
 390
 391   // Emit the string table itself.
 392   O << "  static const char AsmStrs[] = {\n";
 393   StringTable.emit(O, printChar);
 394   O << "  };\n\n";
 395
 396   // Emit the lookup tables in pieces to minimize wasted bytes.
 397   unsigned BytesNeeded = ((64 - BitsLeft) + 7) / 8;
 398   unsigned Table = 0, Shift = 0;
 399   SmallString<128> BitsString;
 400   raw_svector_ostream BitsOS(BitsString);
 401   // If the total bits is more than 32-bits we need to use a 64-bit type.
 402   BitsOS << "  uint" << ((BitsLeft < 32) ? 64 : 32) << "_t Bits = 0;\n";
 403   while (BytesNeeded != 0) {
 404     // Figure out how big this table section needs to be, but no bigger than 4.
 405     unsigned TableSize = std::min(1 << Log2_32(BytesNeeded), 4);
 406     BytesNeeded -= TableSize;
 407     TableSize *= 8; // Convert to bits;
 408     uint64_t Mask = (1ULL << TableSize) - 1;
 409     O << "  static const uint" << TableSize << "_t OpInfo" << Table
 410       << "[] = {\n";
 411     for (unsigned i = 0, e = NumberedInstructions->size(); i != e; ++i) {
 412       O << "    " << ((OpcodeInfo[i] >> Shift) & Mask) << "U,\t// "
 413         << NumberedInstructions->at(i)->TheDef->getName() << "\n";
 414     }
 415     O << "  };\n\n";
 416     // Emit string to combine the individual table lookups.
 417     BitsOS << "  Bits |= ";
 418     // If the total bits is more than 32-bits we need to use a 64-bit type.
 419     if (BitsLeft < 32)
 420       BitsOS << "(uint64_t)";
 421     BitsOS << "OpInfo" << Table << "[MI->getOpcode()] << " << Shift << ";\n";
 422     // Prepare the shift for the next iteration and increment the table count.
 423     Shift += TableSize;
 424     ++Table;
 425   }
 426
 427   // Emit the initial tab character.
 428   O << "  O << \"\\t\";\n\n";
 429
 430   O << "  // Emit the opcode for the instruction.\n";
 431   O << BitsString;
 432
 433   // Emit the starting string.
 434   O << "  assert(Bits != 0 && \"Cannot print this instruction.\");\n"
 435     << "  O << AsmStrs+(Bits & " << (1 << AsmStrBits)-1 << ")-1;\n\n";
 436
 437   // Output the table driven operand information.
 438   BitsLeft = 64-AsmStrBits;
 439   for (unsigned i = 0, e = TableDrivenOperandPrinters.size(); i != e; ++i) {
 440     std::vector<std::string> &Commands = TableDrivenOperandPrinters[i];
 441
 442     // Compute the number of bits we need to represent these cases, this is
 443     // ceil(log2(numentries)).
 444     unsigned NumBits = Log2_32_Ceil(Commands.size());
 445     assert(NumBits <= BitsLeft && "consistency error");
 446
 447     // Emit code to extract this field from Bits.
 448     O << "\n  // Fragment " << i << " encoded into " << NumBits
 449       << " bits for " << Commands.size() << " unique commands.\n";
 450
 451     if (Commands.size() == 2) {
 452       // Emit two possibilitys with if/else.
 453       O << "  if ((Bits >> "
 454         << (64-BitsLeft) << ") & "
 455         << ((1 << NumBits)-1) << ") {\n"
 456         << Commands[1]
 457         << "  } else {\n"
 458         << Commands[0]
 459         << "  }\n\n";
 460     } else if (Commands.size() == 1) {
 461       // Emit a single possibility.
 462       O << Commands[0] << "\n\n";
 463     } else {
 464       O << "  switch ((Bits >> "
 465         << (64-BitsLeft) << ") & "
 466         << ((1 << NumBits)-1) << ") {\n"
 467         << "  default: llvm_unreachable(\"Invalid command number.\");\n";
 468
 469       // Print out all the cases.
 470       for (unsigned j = 0, e = Commands.size(); j != e; ++j) {
 471         O << "  case " << j << ":\n";
 472         O << Commands[j];
 473         O << "    break;\n";
 474       }
 475       O << "  }\n\n";
 476     }
 477     BitsLeft -= NumBits;
 478   }
 479
 480   // Okay, delete instructions with no operand info left.
 481   auto I = std::remove_if(Instructions.begin(), Instructions.end(),
 482                           [](AsmWriterInst &Inst) {
 483                             return Inst.Operands.empty();
 484                           });
 485   Instructions.erase(I, Instructions.end());
 486
 487
 488   // Because this is a vector, we want to emit from the end.  Reverse all of the
 489   // elements in the vector.
 490   std::reverse(Instructions.begin(), Instructions.end());
 491
 492
 493   // Now that we've emitted all of the operand info that fit into 64 bits, emit
 494   // information for those instructions that are left.  This is a less dense
 495   // encoding, but we expect the main 64-bit table to handle the majority of
 496   // instructions.
 497   if (!Instructions.empty()) {
 498     // Find the opcode # of inline asm.
 499     O << "  switch (MI->getOpcode()) {\n";
 500     while (!Instructions.empty())
 501       EmitInstructions(Instructions, O);
 502
 503     O << "  }\n";
 504     O << "  return;\n";
 505   }
 506
 507   O << "}\n";
 508 }
 509
 510 static const char *getMinimalTypeForRange(uint64_t Range) {
 511   assert(Range < 0xFFFFFFFFULL && "Enum too large");
 512   if (Range > 0xFFFF)
 513     return "uint32_t";
 514   if (Range > 0xFF)
 515     return "uint16_t";
 516   return "uint8_t";
 517 }
 518
 519 static void
 520 emitRegisterNameString(raw_ostream &O, StringRef AltName,
 521                        const std::deque<CodeGenRegister> &Registers) {
 522   SequenceToOffsetTable<std::string> StringTable;
 523   SmallVector<std::string, 4> AsmNames(Registers.size());
 524   unsigned i = 0;
 525   for (const auto &Reg : Registers) {
 526     std::string &AsmName = AsmNames[i++];
 527
 528     // "NoRegAltName" is special. We don't need to do a lookup for that,
 529     // as it's just a reference to the default register name.
 530     if (AltName == "" || AltName == "NoRegAltName") {
 531       AsmName = Reg.TheDef->getValueAsString("AsmName");
 532       if (AsmName.empty())
 533         AsmName = Reg.getName();
 534     } else {
 535       // Make sure the register has an alternate name for this index.
 536       std::vector<Record*> AltNameList =
 537         Reg.TheDef->getValueAsListOfDefs("RegAltNameIndices");
 538       unsigned Idx = 0, e;
 539       for (e = AltNameList.size();
 540            Idx < e && (AltNameList[Idx]->getName() != AltName);
 541            ++Idx)
 542         ;
 543       // If the register has an alternate name for this index, use it.
 544       // Otherwise, leave it empty as an error flag.
 545       if (Idx < e) {
 546         std::vector<std::string> AltNames =
 547           Reg.TheDef->getValueAsListOfStrings("AltNames");
 548         if (AltNames.size() <= Idx)
 549           PrintFatalError(Reg.TheDef->getLoc(),
 550                           "Register definition missing alt name for '" +
 551                           AltName + "'.");
 552         AsmName = AltNames[Idx];
 553       }
 554     }
 555     StringTable.add(AsmName);
 556   }
 557
 558   StringTable.layout();
 559   O << "  static const char AsmStrs" << AltName << "[] = {\n";
 560   StringTable.emit(O, printChar);
 561   O << "  };\n\n";
 562
 563   O << "  static const " << getMinimalTypeForRange(StringTable.size()-1)
 564     << " RegAsmOffset" << AltName << "[] = {";
 565   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
 566     if ((i % 14) == 0)
 567       O << "\n    ";
 568     O << StringTable.get(AsmNames[i]) << ", ";
 569   }
 570   O << "\n  };\n"
 571     << "\n";
 572 }
 573
 574 void AsmWriterEmitter::EmitGetRegisterName(raw_ostream &O) {
 575   Record *AsmWriter = Target.getAsmWriter();
 576   std::string ClassName = AsmWriter->getValueAsString("AsmWriterClassName");
 577   const auto &Registers = Target.getRegBank().getRegisters();
 578   std::vector<Record*> AltNameIndices = Target.getRegAltNameIndices();
 579   bool hasAltNames = AltNameIndices.size() > 1;
 580   std::string Namespace =
 581       Registers.front().TheDef->getValueAsString("Namespace");
 582
 583   O <<
 584   "\n\n/// getRegisterName - This method is automatically generated by tblgen\n"
 585   "/// from the register set description.  This returns the assembler name\n"
 586   "/// for the specified register.\n"
 587   "const char *" << Target.getName() << ClassName << "::";
 588   if (hasAltNames)
 589     O << "\ngetRegisterName(unsigned RegNo, unsigned AltIdx) {\n";
 590   else
 591     O << "getRegisterName(unsigned RegNo) {\n";
 592   O << "  assert(RegNo && RegNo < " << (Registers.size()+1)
 593     << " && \"Invalid register number!\");\n"
 594     << "\n";
 595
 596   if (hasAltNames) {
 597     for (const Record *R : AltNameIndices)
 598       emitRegisterNameString(O, R->getName(), Registers);
 599   } else
 600     emitRegisterNameString(O, "", Registers);
 601
 602   if (hasAltNames) {
 603     O << "  switch(AltIdx) {\n"
 604       << "  default: llvm_unreachable(\"Invalid register alt name index!\");\n";
 605     for (const Record *R : AltNameIndices) {
 606       std::string AltName(R->getName());
 607       std::string Prefix = !Namespace.empty() ? Namespace + "::" : "";
 608       O << "  case " << Prefix << AltName << ":\n"
 609         << "    assert(*(AsmStrs" << AltName << "+RegAsmOffset"
 610         << AltName << "[RegNo-1]) &&\n"
 611         << "           \"Invalid alt name index for register!\");\n"
 612         << "    return AsmStrs" << AltName << "+RegAsmOffset"
 613         << AltName << "[RegNo-1];\n";
 614     }
 615     O << "  }\n";
 616   } else {
 617     O << "  assert (*(AsmStrs+RegAsmOffset[RegNo-1]) &&\n"
 618       << "          \"Invalid alt name index for register!\");\n"
 619       << "  return AsmStrs+RegAsmOffset[RegNo-1];\n";
 620   }
 621   O << "}\n";
 622 }
 623
 624 namespace {
 625 // IAPrinter - Holds information about an InstAlias. Two InstAliases match if
 626 // they both have the same conditionals. In which case, we cannot print out the
 627 // alias for that pattern.
 628 class IAPrinter {
 629   std::vector<std::string> Conds;
 630   std::map<StringRef, std::pair<int, int>> OpMap;
 631   SmallVector<Record*, 4> ReqFeatures;
 632
 633   std::string Result;
 634   std::string AsmString;
 635 public:
 636   IAPrinter(std::string R, std::string AS) : Result(R), AsmString(AS) {}
 637
 638   void addCond(const std::string &C) { Conds.push_back(C); }
 639
 640   void addOperand(StringRef Op, int OpIdx, int PrintMethodIdx = -1) {
 641     assert(OpIdx >= 0 && OpIdx < 0xFE && "Idx out of range");
 642     assert(PrintMethodIdx >= -1 && PrintMethodIdx < 0xFF &&
 643            "Idx out of range");
 644     OpMap[Op] = std::make_pair(OpIdx, PrintMethodIdx);
 645   }
 646
 647   bool isOpMapped(StringRef Op) { return OpMap.find(Op) != OpMap.end(); }
 648   int getOpIndex(StringRef Op) { return OpMap[Op].first; }
 649   std::pair<int, int> &getOpData(StringRef Op) { return OpMap[Op]; }
 650
 651   std::pair<StringRef, StringRef::iterator> parseName(StringRef::iterator Start,
 652                                                       StringRef::iterator End) {
 653     StringRef::iterator I = Start;
 654     StringRef::iterator Next;
 655     if (*I == '{') {
 656       // ${some_name}
 657       Start = ++I;
 658       while (I != End && *I != '}')
 659         ++I;
 660       Next = I;
 661       // eat the final '}'
 662       if (Next != End)
 663         ++Next;
 664     } else {
 665       // $name, just eat the usual suspects.
 666       while (I != End &&
 667              ((*I >= 'a' && *I <= 'z') || (*I >= 'A' && *I <= 'Z') ||
 668               (*I >= '0' && *I <= '9') || *I == '_'))
 669         ++I;
 670       Next = I;
 671     }
 672
 673     return std::make_pair(StringRef(Start, I - Start), Next);
 674   }
 675
 676   void print(raw_ostream &O) {
 677     if (Conds.empty() && ReqFeatures.empty()) {
 678       O.indent(6) << "return true;\n";
 679       return;
 680     }
 681
 682     O << "if (";
 683
 684     for (std::vector<std::string>::iterator
 685            I = Conds.begin(), E = Conds.end(); I != E; ++I) {
 686       if (I != Conds.begin()) {
 687         O << " &&\n";
 688         O.indent(8);
 689       }
 690
 691       O << *I;
 692     }
 693
 694     O << ") {\n";
 695     O.indent(6) << "// " << Result << "\n";
 696
 697     // Directly mangle mapped operands into the string. Each operand is
 698     // identified by a '$' sign followed by a byte identifying the number of the
 699     // operand. We add one to the index to avoid zero bytes.
 700     StringRef ASM(AsmString);
 701     SmallString<128> OutString;
 702     raw_svector_ostream OS(OutString);
 703     for (StringRef::iterator I = ASM.begin(), E = ASM.end(); I != E;) {
 704       OS << *I;
 705       if (*I == '$') {
 706         StringRef Name;
 707         std::tie(Name, I) = parseName(++I, E);
 708         assert(isOpMapped(Name) && "Unmapped operand!");
 709
 710         int OpIndex, PrintIndex;
 711         std::tie(OpIndex, PrintIndex) = getOpData(Name);
 712         if (PrintIndex == -1) {
 713           // Can use the default printOperand route.
 714           OS << format("\\x%02X", (unsigned char)OpIndex + 1);
 715         } else
 716           // 3 bytes if a PrintMethod is needed: 0xFF, the MCInst operand
 717           // number, and which of our pre-detected Methods to call.
 718           OS << format("\\xFF\\x%02X\\x%02X", OpIndex + 1, PrintIndex + 1);
 719       } else {
 720         ++I;
 721       }
 722     }
 723
 724     // Emit the string.
 725     O.indent(6) << "AsmString = \"" << OutString << "\";\n";
 726
 727     O.indent(6) << "break;\n";
 728     O.indent(4) << '}';
 729   }
 730
 731   bool operator==(const IAPrinter &RHS) const {
 732     if (Conds.size() != RHS.Conds.size())
 733       return false;
 734
 735     unsigned Idx = 0;
 736     for (const auto &str : Conds)
 737       if (str != RHS.Conds[Idx++])
 738         return false;
 739
 740     return true;
 741   }
 742 };
 743
 744 } // end anonymous namespace
 745
 746 static unsigned CountNumOperands(StringRef AsmString, unsigned Variant) {
 747   std::string FlatAsmString =
 748       CodeGenInstruction::FlattenAsmStringVariants(AsmString, Variant);
 749   AsmString = FlatAsmString;
 750
 751   return AsmString.count(' ') + AsmString.count('\t');
 752 }
 753
 754 namespace {
 755 struct AliasPriorityComparator {
 756   typedef std::pair<CodeGenInstAlias, int> ValueType;
 757   bool operator()(const ValueType &LHS, const ValueType &RHS) {
 758     if (LHS.second ==  RHS.second) {
 759       // We don't actually care about the order, but for consistency it
 760       // shouldn't depend on pointer comparisons.
 761       return LHS.first.TheDef->getName() < RHS.first.TheDef->getName();
 762     }
 763
 764     // Aliases with larger priorities should be considered first.
 765     return LHS.second > RHS.second;
 766   }
 767 };
 768 }
 769
 770
 771 void AsmWriterEmitter::EmitPrintAliasInstruction(raw_ostream &O) {
 772   Record *AsmWriter = Target.getAsmWriter();
 773
 774   O << "\n#ifdef PRINT_ALIAS_INSTR\n";
 775   O << "#undef PRINT_ALIAS_INSTR\n\n";
 776
 777   //////////////////////////////
 778   // Gather information about aliases we need to print
 779   //////////////////////////////
 780
 781   // Emit the method that prints the alias instruction.
 782   std::string ClassName = AsmWriter->getValueAsString("AsmWriterClassName");
 783   unsigned Variant = AsmWriter->getValueAsInt("Variant");
 784   unsigned PassSubtarget = AsmWriter->getValueAsInt("PassSubtarget");
 785
 786   std::vector<Record*> AllInstAliases =
 787     Records.getAllDerivedDefinitions("InstAlias");
 788
 789   // Create a map from the qualified name to a list of potential matches.
 790   typedef std::set<std::pair<CodeGenInstAlias, int>, AliasPriorityComparator>
 791       AliasWithPriority;
 792   std::map<std::string, AliasWithPriority> AliasMap;
 793   for (Record *R : AllInstAliases) {
 794     int Priority = R->getValueAsInt("EmitPriority");
 795     if (Priority < 1)
 796       continue; // Aliases with priority 0 are never emitted.
 797
 798     const DagInit *DI = R->getValueAsDag("ResultInst");
 799     const DefInit *Op = cast<DefInit>(DI->getOperator());
 800     AliasMap[getQualifiedName(Op->getDef())].insert(
 801         std::make_pair(CodeGenInstAlias(R, Variant, Target), Priority));
 802   }
 803
 804   // A map of which conditions need to be met for each instruction operand
 805   // before it can be matched to the mnemonic.
 806   std::map<std::string, std::vector<IAPrinter>> IAPrinterMap;
 807
 808   // A list of MCOperandPredicates for all operands in use, and the reverse map
 809   std::vector<const Record*> MCOpPredicates;
 810   DenseMap<const Record*, unsigned> MCOpPredicateMap;
 811
 812   for (auto &Aliases : AliasMap) {
 813     for (auto &Alias : Aliases.second) {
 814       const CodeGenInstAlias &CGA = Alias.first;
 815       unsigned LastOpNo = CGA.ResultInstOperandIndex.size();
 816       unsigned NumResultOps =
 817           CountNumOperands(CGA.ResultInst->AsmString, Variant);
 818
 819       // Don't emit the alias if it has more operands than what it's aliasing.
 820       if (NumResultOps < CountNumOperands(CGA.AsmString, Variant))
 821         continue;
 822
 823       IAPrinter IAP(CGA.Result->getAsString(), CGA.AsmString);
 824
 825       unsigned NumMIOps = 0;
 826       for (auto &Operand : CGA.ResultOperands)
 827         NumMIOps += Operand.getMINumOperands();
 828
 829       std::string Cond;
 830       Cond = std::string("MI->getNumOperands() == ") + llvm::utostr(NumMIOps);
 831       IAP.addCond(Cond);
 832
 833       bool CantHandle = false;
 834
 835       unsigned MIOpNum = 0;
 836       for (unsigned i = 0, e = LastOpNo; i != e; ++i) {
 837         std::string Op = "MI->getOperand(" + llvm::utostr(MIOpNum) + ")";
 838
 839         const CodeGenInstAlias::ResultOperand &RO = CGA.ResultOperands[i];
 840
 841         switch (RO.Kind) {
 842         case CodeGenInstAlias::ResultOperand::K_Record: {
 843           const Record *Rec = RO.getRecord();
 844           StringRef ROName = RO.getName();
 845           int PrintMethodIdx = -1;
 846
 847           // These two may have a PrintMethod, which we want to record (if it's
 848           // the first time we've seen it) and provide an index for the aliasing
 849           // code to use.
 850           if (Rec->isSubClassOf("RegisterOperand") ||
 851               Rec->isSubClassOf("Operand")) {
 852             std::string PrintMethod = Rec->getValueAsString("PrintMethod");
 853             if (PrintMethod != "" && PrintMethod != "printOperand") {
 854               PrintMethodIdx = std::find(PrintMethods.begin(),
 855                                          PrintMethods.end(), PrintMethod) -
 856                                PrintMethods.begin();
 857               if (static_cast<unsigned>(PrintMethodIdx) == PrintMethods.size())
 858                 PrintMethods.push_back(PrintMethod);
 859             }
 860           }
 861
 862           if (Rec->isSubClassOf("RegisterOperand"))
 863             Rec = Rec->getValueAsDef("RegClass");
 864           if (Rec->isSubClassOf("RegisterClass")) {
 865             IAP.addCond(Op + ".isReg()");
 866
 867             if (!IAP.isOpMapped(ROName)) {
 868               IAP.addOperand(ROName, MIOpNum, PrintMethodIdx);
 869               Record *R = CGA.ResultOperands[i].getRecord();
 870               if (R->isSubClassOf("RegisterOperand"))
 871                 R = R->getValueAsDef("RegClass");
 872               Cond = std::string("MRI.getRegClass(") + Target.getName() + "::" +
 873                      R->getName() + "RegClassID)"
 874                                     ".contains(" + Op + ".getReg())";
 875             } else {
 876               Cond = Op + ".getReg() == MI->getOperand(" +
 877                      llvm::utostr(IAP.getOpIndex(ROName)) + ").getReg()";
 878             }
 879           } else {
 880             // Assume all printable operands are desired for now. This can be
 881             // overridden in the InstAlias instantiation if necessary.
 882             IAP.addOperand(ROName, MIOpNum, PrintMethodIdx);
 883
 884             // There might be an additional predicate on the MCOperand
 885             unsigned Entry = MCOpPredicateMap[Rec];
 886             if (!Entry) {
 887               if (!Rec->isValueUnset("MCOperandPredicate")) {
 888                 MCOpPredicates.push_back(Rec);
 889                 Entry = MCOpPredicates.size();
 890                 MCOpPredicateMap[Rec] = Entry;
 891               } else
 892                 break; // No conditions on this operand at all
 893             }
 894             Cond = Target.getName() + ClassName + "ValidateMCOperand(" +
 895                    Op + ", STI, " + llvm::utostr(Entry) + ")";
 896           }
 897           // for all subcases of ResultOperand::K_Record:
 898           IAP.addCond(Cond);
 899           break;
 900         }
 901         case CodeGenInstAlias::ResultOperand::K_Imm: {
 902           // Just because the alias has an immediate result, doesn't mean the
 903           // MCInst will. An MCExpr could be present, for example.
 904           IAP.addCond(Op + ".isImm()");
 905
 906           Cond = Op + ".getImm() == " +
 907                  llvm::utostr(CGA.ResultOperands[i].getImm());
 908           IAP.addCond(Cond);
 909           break;
 910         }
 911         case CodeGenInstAlias::ResultOperand::K_Reg:
 912           // If this is zero_reg, something's playing tricks we're not
 913           // equipped to handle.
 914           if (!CGA.ResultOperands[i].getRegister()) {
 915             CantHandle = true;
 916             break;
 917           }
 918
 919           Cond = Op + ".getReg() == " + Target.getName() + "::" +
 920                  CGA.ResultOperands[i].getRegister()->getName();
 921           IAP.addCond(Cond);
 922           break;
 923         }
 924
 925         MIOpNum += RO.getMINumOperands();
 926       }
 927
 928       if (CantHandle) continue;
 929       IAPrinterMap[Aliases.first].push_back(std::move(IAP));
 930     }
 931   }
 932
 933   //////////////////////////////
 934   // Write out the printAliasInstr function
 935   //////////////////////////////
 936
 937   std::string Header;
 938   raw_string_ostream HeaderO(Header);
 939
 940   HeaderO << "bool " << Target.getName() << ClassName
 941           << "::printAliasInstr(const MCInst"
 942           << " *MI, " << (PassSubtarget ? "const MCSubtargetInfo &STI, " : "")
 943           << "raw_ostream &OS) {\n";
 944
 945   std::string Cases;
 946   raw_string_ostream CasesO(Cases);
 947
 948   for (auto &Entry : IAPrinterMap) {
 949     std::vector<IAPrinter> &IAPs = Entry.second;
 950     std::vector<IAPrinter*> UniqueIAPs;
 951
 952     for (auto &LHS : IAPs) {
 953       bool IsDup = false;
 954       for (const auto &RHS : IAPs) {
 955         if (&LHS != &RHS && LHS == RHS) {
 956           IsDup = true;
 957           break;
 958         }
 959       }
 960
 961       if (!IsDup)
 962         UniqueIAPs.push_back(&LHS);
 963     }
 964
 965     if (UniqueIAPs.empty()) continue;
 966
 967     CasesO.indent(2) << "case " << Entry.first << ":\n";
 968
 969     for (IAPrinter *IAP : UniqueIAPs) {
 970       CasesO.indent(4);
 971       IAP->print(CasesO);
 972       CasesO << '\n';
 973     }
 974
 975     CasesO.indent(4) << "return false;\n";
 976   }
 977
 978   if (CasesO.str().empty()) {
 979     O << HeaderO.str();
 980     O << "  return false;\n";
 981     O << "}\n\n";
 982     O << "#endif // PRINT_ALIAS_INSTR\n";
 983     return;
 984   }
 985
 986   if (!MCOpPredicates.empty())
 987     O << "static bool " << Target.getName() << ClassName
 988       << "ValidateMCOperand(const MCOperand &MCOp,\n"
 989       << "                  const MCSubtargetInfo &STI,\n"
 990       << "                  unsigned PredicateIndex);\n";
 991
 992   O << HeaderO.str();
 993   O.indent(2) << "const char *AsmString;\n";
 994   O.indent(2) << "switch (MI->getOpcode()) {\n";
 995   O.indent(2) << "default: return false;\n";
 996   O << CasesO.str();
 997   O.indent(2) << "}\n\n";
 998
 999   // Code that prints the alias, replacing the operands with the ones from the
1000   // MCInst.
1001   O << "  unsigned I = 0;\n";
1002   O << "  while (AsmString[I] != ' ' && AsmString[I] != '\t' &&\n";
1003   O << "         AsmString[I] != '\\0')\n";
1004   O << "    ++I;\n";
1005   O << "  OS << '\\t' << StringRef(AsmString, I);\n";
1006
1007   O << "  if (AsmString[I] != '\\0') {\n";
1008   O << "    OS << '\\t';\n";
1009   O << "    do {\n";
1010   O << "      if (AsmString[I] == '$') {\n";
1011   O << "        ++I;\n";
1012   O << "        if (AsmString[I] == (char)0xff) {\n";
1013   O << "          ++I;\n";
1014   O << "          int OpIdx = AsmString[I++] - 1;\n";
1015   O << "          int PrintMethodIdx = AsmString[I++] - 1;\n";
1016   O << "          printCustomAliasOperand(MI, OpIdx, PrintMethodIdx, ";
1017   O << (PassSubtarget ? "STI, " : "");
1018   O << "OS);\n";
1019   O << "        } else\n";
1020   O << "          printOperand(MI, unsigned(AsmString[I++]) - 1, ";
1021   O << (PassSubtarget ? "STI, " : "");
1022   O << "OS);\n";
1023   O << "      } else {\n";
1024   O << "        OS << AsmString[I++];\n";
1025   O << "      }\n";
1026   O << "    } while (AsmString[I] != '\\0');\n";
1027   O << "  }\n\n";
1028
1029   O << "  return true;\n";
1030   O << "}\n\n";
1031
1032   //////////////////////////////
1033   // Write out the printCustomAliasOperand function
1034   //////////////////////////////
1035
1036   O << "void " << Target.getName() << ClassName << "::"
1037     << "printCustomAliasOperand(\n"
1038     << "         const MCInst *MI, unsigned OpIdx,\n"
1039     << "         unsigned PrintMethodIdx,\n"
1040     << (PassSubtarget ? "         const MCSubtargetInfo &STI,\n" : "")
1041     << "         raw_ostream &OS) {\n";
1042   if (PrintMethods.empty())
1043     O << "  llvm_unreachable(\"Unknown PrintMethod kind\");\n";
1044   else {
1045     O << "  switch (PrintMethodIdx) {\n"
1046       << "  default:\n"
1047       << "    llvm_unreachable(\"Unknown PrintMethod kind\");\n"
1048       << "    break;\n";
1049
1050     for (unsigned i = 0; i < PrintMethods.size(); ++i) {
1051       O << "  case " << i << ":\n"
1052         << "    " << PrintMethods[i] << "(MI, OpIdx, "
1053         << (PassSubtarget ? "STI, " : "") << "OS);\n"
1054         << "    break;\n";
1055     }
1056     O << "  }\n";
1057   }
1058   O << "}\n\n";
1059
1060   if (!MCOpPredicates.empty()) {
1061     O << "static bool " << Target.getName() << ClassName
1062       << "ValidateMCOperand(const MCOperand &MCOp,\n"
1063       << "                  const MCSubtargetInfo &STI,\n"
1064       << "                  unsigned PredicateIndex) {\n"
1065       << "  switch (PredicateIndex) {\n"
1066       << "  default:\n"
1067       << "    llvm_unreachable(\"Unknown MCOperandPredicate kind\");\n"
1068       << "    break;\n";
1069
1070     for (unsigned i = 0; i < MCOpPredicates.size(); ++i) {
1071       Init *MCOpPred = MCOpPredicates[i]->getValueInit("MCOperandPredicate");
1072       if (StringInit *SI = dyn_cast<StringInit>(MCOpPred)) {
1073         O << "  case " << i + 1 << ": {\n"
1074           << SI->getValue() << "\n"
1075           << "    }\n";
1076       } else
1077         llvm_unreachable("Unexpected MCOperandPredicate field!");
1078     }
1079     O << "  }\n"
1080       << "}\n\n";
1081   }
1082
1083   O << "#endif // PRINT_ALIAS_INSTR\n";
1084 }
1085
1086 AsmWriterEmitter::AsmWriterEmitter(RecordKeeper &R) : Records(R), Target(R) {
1087   Record *AsmWriter = Target.getAsmWriter();
1088   unsigned Variant = AsmWriter->getValueAsInt("Variant");
1089   unsigned PassSubtarget = AsmWriter->getValueAsInt("PassSubtarget");
1090   for (const CodeGenInstruction *I : Target.instructions())
1091     if (!I->AsmString.empty() && I->TheDef->getName() != "PHI")
1092       Instructions.emplace_back(*I, Variant, PassSubtarget);
1093
1094   // Get the instruction numbering.
1095   NumberedInstructions = &Target.getInstructionsByEnumValue();
1096
1097   // Compute the CodeGenInstruction -> AsmWriterInst mapping.  Note that not
1098   // all machine instructions are necessarily being printed, so there may be
1099   // target instructions not in this map.
1100   for (AsmWriterInst &AWI : Instructions)
1101     CGIAWIMap.insert(std::make_pair(AWI.CGI, &AWI));
1102 }
1103
1104 void AsmWriterEmitter::run(raw_ostream &O) {
1105   EmitPrintInstruction(O);
1106   EmitGetRegisterName(O);
1107   EmitPrintAliasInstruction(O);
1108 }
1109
1110
1111 namespace llvm {
1112
1113 void EmitAsmWriter(RecordKeeper &RK, raw_ostream &OS) {
1114   emitSourceFileHeader("Assembly Writer Source Fragment", OS);
1115   AsmWriterEmitter(RK).run(OS);
1116 }
1117
1118 } // End llvm namespace