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   /// To reduce the number of unhandled cases, we expand the size from 32-bit
 295   /// to 32+16 = 48-bit.
 296   std::vector<uint64_t> OpcodeInfo;
 297
 298   // Add all strings to the string table upfront so it can generate an optimized
 299   // representation.
 300   for (const CodeGenInstruction *Inst : *NumberedInstructions) {
 301     AsmWriterInst *AWI = CGIAWIMap[Inst];
 302     if (AWI &&
 303         AWI->Operands[0].OperandType ==
 304                  AsmWriterOperand::isLiteralTextOperand &&
 305         !AWI->Operands[0].Str.empty()) {
 306       std::string Str = AWI->Operands[0].Str;
 307       UnescapeString(Str);
 308       StringTable.add(Str);
 309     }
 310   }
 311
 312   StringTable.layout();
 313
 314   unsigned MaxStringIdx = 0;
 315   for (const CodeGenInstruction *Inst : *NumberedInstructions) {
 316     AsmWriterInst *AWI = CGIAWIMap[Inst];
 317     unsigned Idx;
 318     if (!AWI) {
 319       // Something not handled by the asmwriter printer.
 320       Idx = ~0U;
 321     } else if (AWI->Operands[0].OperandType !=
 322                         AsmWriterOperand::isLiteralTextOperand ||
 323                AWI->Operands[0].Str.empty()) {
 324       // Something handled by the asmwriter printer, but with no leading string.
 325       Idx = StringTable.get("");
 326     } else {
 327       std::string Str = AWI->Operands[0].Str;
 328       UnescapeString(Str);
 329       Idx = StringTable.get(Str);
 330       MaxStringIdx = std::max(MaxStringIdx, Idx);
 331
 332       // Nuke the string from the operand list.  It is now handled!
 333       AWI->Operands.erase(AWI->Operands.begin());
 334     }
 335
 336     // Bias offset by one since we want 0 as a sentinel.
 337     OpcodeInfo.push_back(Idx+1);
 338   }
 339
 340   // Figure out how many bits we used for the string index.
 341   unsigned AsmStrBits = Log2_32_Ceil(MaxStringIdx+2);
 342
 343   // To reduce code size, we compactify common instructions into a few bits
 344   // in the opcode-indexed table.
 345   unsigned BitsLeft = 64-AsmStrBits;
 346
 347   std::vector<std::vector<std::string>> TableDrivenOperandPrinters;
 348
 349   while (1) {
 350     std::vector<std::string> UniqueOperandCommands;
 351     std::vector<unsigned> InstIdxs;
 352     std::vector<unsigned> NumInstOpsHandled;
 353     FindUniqueOperandCommands(UniqueOperandCommands, InstIdxs,
 354                               NumInstOpsHandled);
 355
 356     // If we ran out of operands to print, we're done.
 357     if (UniqueOperandCommands.empty()) break;
 358
 359     // Compute the number of bits we need to represent these cases, this is
 360     // ceil(log2(numentries)).
 361     unsigned NumBits = Log2_32_Ceil(UniqueOperandCommands.size());
 362
 363     // If we don't have enough bits for this operand, don't include it.
 364     if (NumBits > BitsLeft) {
 365       DEBUG(errs() << "Not enough bits to densely encode " << NumBits
 366                    << " more bits\n");
 367       break;
 368     }
 369
 370     // Otherwise, we can include this in the initial lookup table.  Add it in.
 371     for (unsigned i = 0, e = InstIdxs.size(); i != e; ++i)
 372       if (InstIdxs[i] != ~0U) {
 373         OpcodeInfo[i] |= (uint64_t)InstIdxs[i] << (64-BitsLeft);
 374       }
 375     BitsLeft -= NumBits;
 376
 377     // Remove the info about this operand.
 378     for (unsigned i = 0, e = NumberedInstructions->size(); i != e; ++i) {
 379       if (AsmWriterInst *Inst = getAsmWriterInstByID(i))
 380         if (!Inst->Operands.empty()) {
 381           unsigned NumOps = NumInstOpsHandled[InstIdxs[i]];
 382           assert(NumOps <= Inst->Operands.size() &&
 383                  "Can't remove this many ops!");
 384           Inst->Operands.erase(Inst->Operands.begin(),
 385                                Inst->Operands.begin()+NumOps);
 386         }
 387     }
 388
 389     // Remember the handlers for this set of operands.
 390     TableDrivenOperandPrinters.push_back(std::move(UniqueOperandCommands));
 391   }
 392
 393
 394   // We always emit at least one 32-bit table. A second table is emitted if
 395   // more bits are needed.
 396   O<<"  static const uint32_t OpInfo[] = {\n";
 397   for (unsigned i = 0, e = NumberedInstructions->size(); i != e; ++i) {
 398     O << "    " << (OpcodeInfo[i] & 0xffffffff) << "U,\t// "
 399       << NumberedInstructions->at(i)->TheDef->getName() << "\n";
 400   }
 401   // Add a dummy entry so the array init doesn't end with a comma.
 402   O << "    0U\n";
 403   O << "  };\n\n";
 404
 405   if (BitsLeft < 32) {
 406     // Add a second OpInfo table only when it is necessary.
 407     // Adjust the type of the second table based on the number of bits needed.
 408     O << "  static const uint"
 409       << ((BitsLeft < 16) ? "32" : (BitsLeft < 24) ? "16" : "8")
 410       << "_t OpInfo2[] = {\n";
 411     for (unsigned i = 0, e = NumberedInstructions->size(); i != e; ++i) {
 412       O << "    " << (OpcodeInfo[i] >> 32) << "U,\t// "
 413         << NumberedInstructions->at(i)->TheDef->getName() << "\n";
 414     }
 415     // Add a dummy entry so the array init doesn't end with a comma.
 416     O << "    0U\n";
 417     O << "  };\n\n";
 418   }
 419
 420   // Emit the string itself.
 421   O << "  static const char AsmStrs[] = {\n";
 422   StringTable.emit(O, printChar);
 423   O << "  };\n\n";
 424
 425   O << "  O << \"\\t\";\n\n";
 426
 427   O << "  // Emit the opcode for the instruction.\n";
 428   if (BitsLeft < 32) {
 429     // If we have two tables then we need to perform two lookups and combine
 430     // the results into a single 64-bit value.
 431     O << "  uint64_t Bits1 = OpInfo[MI->getOpcode()];\n"
 432       << "  uint64_t Bits2 = OpInfo2[MI->getOpcode()];\n"
 433       << "  uint64_t Bits = (Bits2 << 32) | Bits1;\n";
 434   } else {
 435     // If only one table is used we just need to perform a single lookup.
 436     O << "  uint32_t Bits = OpInfo[MI->getOpcode()];\n";
 437   }
 438   O << "  assert(Bits != 0 && \"Cannot print this instruction.\");\n"
 439     << "  O << AsmStrs+(Bits & " << (1 << AsmStrBits)-1 << ")-1;\n\n";
 440
 441   // Output the table driven operand information.
 442   BitsLeft = 64-AsmStrBits;
 443   for (unsigned i = 0, e = TableDrivenOperandPrinters.size(); i != e; ++i) {
 444     std::vector<std::string> &Commands = TableDrivenOperandPrinters[i];
 445
 446     // Compute the number of bits we need to represent these cases, this is
 447     // ceil(log2(numentries)).
 448     unsigned NumBits = Log2_32_Ceil(Commands.size());
 449     assert(NumBits <= BitsLeft && "consistency error");
 450
 451     // Emit code to extract this field from Bits.
 452     O << "\n  // Fragment " << i << " encoded into " << NumBits
 453       << " bits for " << Commands.size() << " unique commands.\n";
 454
 455     if (Commands.size() == 2) {
 456       // Emit two possibilitys with if/else.
 457       O << "  if ((Bits >> "
 458         << (64-BitsLeft) << ") & "
 459         << ((1 << NumBits)-1) << ") {\n"
 460         << Commands[1]
 461         << "  } else {\n"
 462         << Commands[0]
 463         << "  }\n\n";
 464     } else if (Commands.size() == 1) {
 465       // Emit a single possibility.
 466       O << Commands[0] << "\n\n";
 467     } else {
 468       O << "  switch ((Bits >> "
 469         << (64-BitsLeft) << ") & "
 470         << ((1 << NumBits)-1) << ") {\n"
 471         << "  default: llvm_unreachable(\"Invalid command number.\");\n";
 472
 473       // Print out all the cases.
 474       for (unsigned j = 0, e = Commands.size(); j != e; ++j) {
 475         O << "  case " << j << ":\n";
 476         O << Commands[j];
 477         O << "    break;\n";
 478       }
 479       O << "  }\n\n";
 480     }
 481     BitsLeft -= NumBits;
 482   }
 483
 484   // Okay, delete instructions with no operand info left.
 485   for (unsigned i = 0, e = Instructions.size(); i != e; ++i) {
 486     // Entire instruction has been emitted?
 487     AsmWriterInst &Inst = Instructions[i];
 488     if (Inst.Operands.empty()) {
 489       Instructions.erase(Instructions.begin()+i);
 490       --i; --e;
 491     }
 492   }
 493
 494
 495   // Because this is a vector, we want to emit from the end.  Reverse all of the
 496   // elements in the vector.
 497   std::reverse(Instructions.begin(), Instructions.end());
 498
 499
 500   // Now that we've emitted all of the operand info that fit into 32 bits, emit
 501   // information for those instructions that are left.  This is a less dense
 502   // encoding, but we expect the main 32-bit table to handle the majority of
 503   // instructions.
 504   if (!Instructions.empty()) {
 505     // Find the opcode # of inline asm.
 506     O << "  switch (MI->getOpcode()) {\n";
 507     while (!Instructions.empty())
 508       EmitInstructions(Instructions, O);
 509
 510     O << "  }\n";
 511     O << "  return;\n";
 512   }
 513
 514   O << "}\n";
 515 }
 516
 517 static const char *getMinimalTypeForRange(uint64_t Range) {
 518   assert(Range < 0xFFFFFFFFULL && "Enum too large");
 519   if (Range > 0xFFFF)
 520     return "uint32_t";
 521   if (Range > 0xFF)
 522     return "uint16_t";
 523   return "uint8_t";
 524 }
 525
 526 static void
 527 emitRegisterNameString(raw_ostream &O, StringRef AltName,
 528                        const std::deque<CodeGenRegister> &Registers) {
 529   SequenceToOffsetTable<std::string> StringTable;
 530   SmallVector<std::string, 4> AsmNames(Registers.size());
 531   unsigned i = 0;
 532   for (const auto &Reg : Registers) {
 533     std::string &AsmName = AsmNames[i++];
 534
 535     // "NoRegAltName" is special. We don't need to do a lookup for that,
 536     // as it's just a reference to the default register name.
 537     if (AltName == "" || AltName == "NoRegAltName") {
 538       AsmName = Reg.TheDef->getValueAsString("AsmName");
 539       if (AsmName.empty())
 540         AsmName = Reg.getName();
 541     } else {
 542       // Make sure the register has an alternate name for this index.
 543       std::vector<Record*> AltNameList =
 544         Reg.TheDef->getValueAsListOfDefs("RegAltNameIndices");
 545       unsigned Idx = 0, e;
 546       for (e = AltNameList.size();
 547            Idx < e && (AltNameList[Idx]->getName() != AltName);
 548            ++Idx)
 549         ;
 550       // If the register has an alternate name for this index, use it.
 551       // Otherwise, leave it empty as an error flag.
 552       if (Idx < e) {
 553         std::vector<std::string> AltNames =
 554           Reg.TheDef->getValueAsListOfStrings("AltNames");
 555         if (AltNames.size() <= Idx)
 556           PrintFatalError(Reg.TheDef->getLoc(),
 557                           "Register definition missing alt name for '" +
 558                           AltName + "'.");
 559         AsmName = AltNames[Idx];
 560       }
 561     }
 562     StringTable.add(AsmName);
 563   }
 564
 565   StringTable.layout();
 566   O << "  static const char AsmStrs" << AltName << "[] = {\n";
 567   StringTable.emit(O, printChar);
 568   O << "  };\n\n";
 569
 570   O << "  static const " << getMinimalTypeForRange(StringTable.size()-1)
 571     << " RegAsmOffset" << AltName << "[] = {";
 572   for (unsigned i = 0, e = Registers.size(); i != e; ++i) {
 573     if ((i % 14) == 0)
 574       O << "\n    ";
 575     O << StringTable.get(AsmNames[i]) << ", ";
 576   }
 577   O << "\n  };\n"
 578     << "\n";
 579 }
 580
 581 void AsmWriterEmitter::EmitGetRegisterName(raw_ostream &O) {
 582   Record *AsmWriter = Target.getAsmWriter();
 583   std::string ClassName = AsmWriter->getValueAsString("AsmWriterClassName");
 584   const auto &Registers = Target.getRegBank().getRegisters();
 585   std::vector<Record*> AltNameIndices = Target.getRegAltNameIndices();
 586   bool hasAltNames = AltNameIndices.size() > 1;
 587   std::string Namespace =
 588       Registers.front().TheDef->getValueAsString("Namespace");
 589
 590   O <<
 591   "\n\n/// getRegisterName - This method is automatically generated by tblgen\n"
 592   "/// from the register set description.  This returns the assembler name\n"
 593   "/// for the specified register.\n"
 594   "const char *" << Target.getName() << ClassName << "::";
 595   if (hasAltNames)
 596     O << "\ngetRegisterName(unsigned RegNo, unsigned AltIdx) {\n";
 597   else
 598     O << "getRegisterName(unsigned RegNo) {\n";
 599   O << "  assert(RegNo && RegNo < " << (Registers.size()+1)
 600     << " && \"Invalid register number!\");\n"
 601     << "\n";
 602
 603   if (hasAltNames) {
 604     for (const Record *R : AltNameIndices)
 605       emitRegisterNameString(O, R->getName(), Registers);
 606   } else
 607     emitRegisterNameString(O, "", Registers);
 608
 609   if (hasAltNames) {
 610     O << "  switch(AltIdx) {\n"
 611       << "  default: llvm_unreachable(\"Invalid register alt name index!\");\n";
 612     for (const Record *R : AltNameIndices) {
 613       std::string AltName(R->getName());
 614       std::string Prefix = !Namespace.empty() ? Namespace + "::" : "";
 615       O << "  case " << Prefix << AltName << ":\n"
 616         << "    assert(*(AsmStrs" << AltName << "+RegAsmOffset"
 617         << AltName << "[RegNo-1]) &&\n"
 618         << "           \"Invalid alt name index for register!\");\n"
 619         << "    return AsmStrs" << AltName << "+RegAsmOffset"
 620         << AltName << "[RegNo-1];\n";
 621     }
 622     O << "  }\n";
 623   } else {
 624     O << "  assert (*(AsmStrs+RegAsmOffset[RegNo-1]) &&\n"
 625       << "          \"Invalid alt name index for register!\");\n"
 626       << "  return AsmStrs+RegAsmOffset[RegNo-1];\n";
 627   }
 628   O << "}\n";
 629 }
 630
 631 namespace {
 632 // IAPrinter - Holds information about an InstAlias. Two InstAliases match if
 633 // they both have the same conditionals. In which case, we cannot print out the
 634 // alias for that pattern.
 635 class IAPrinter {
 636   std::vector<std::string> Conds;
 637   std::map<StringRef, std::pair<int, int>> OpMap;
 638   SmallVector<Record*, 4> ReqFeatures;
 639
 640   std::string Result;
 641   std::string AsmString;
 642 public:
 643   IAPrinter(std::string R, std::string AS) : Result(R), AsmString(AS) {}
 644
 645   void addCond(const std::string &C) { Conds.push_back(C); }
 646
 647   void addOperand(StringRef Op, int OpIdx, int PrintMethodIdx = -1) {
 648     assert(OpIdx >= 0 && OpIdx < 0xFE && "Idx out of range");
 649     assert(PrintMethodIdx >= -1 && PrintMethodIdx < 0xFF &&
 650            "Idx out of range");
 651     OpMap[Op] = std::make_pair(OpIdx, PrintMethodIdx);
 652   }
 653
 654   bool isOpMapped(StringRef Op) { return OpMap.find(Op) != OpMap.end(); }
 655   int getOpIndex(StringRef Op) { return OpMap[Op].first; }
 656   std::pair<int, int> &getOpData(StringRef Op) { return OpMap[Op]; }
 657
 658   std::pair<StringRef, StringRef::iterator> parseName(StringRef::iterator Start,
 659                                                       StringRef::iterator End) {
 660     StringRef::iterator I = Start;
 661     StringRef::iterator Next;
 662     if (*I == '{') {
 663       // ${some_name}
 664       Start = ++I;
 665       while (I != End && *I != '}')
 666         ++I;
 667       Next = I;
 668       // eat the final '}'
 669       if (Next != End)
 670         ++Next;
 671     } else {
 672       // $name, just eat the usual suspects.
 673       while (I != End &&
 674              ((*I >= 'a' && *I <= 'z') || (*I >= 'A' && *I <= 'Z') ||
 675               (*I >= '0' && *I <= '9') || *I == '_'))
 676         ++I;
 677       Next = I;
 678     }
 679
 680     return std::make_pair(StringRef(Start, I - Start), Next);
 681   }
 682
 683   void print(raw_ostream &O) {
 684     if (Conds.empty() && ReqFeatures.empty()) {
 685       O.indent(6) << "return true;\n";
 686       return;
 687     }
 688
 689     O << "if (";
 690
 691     for (std::vector<std::string>::iterator
 692            I = Conds.begin(), E = Conds.end(); I != E; ++I) {
 693       if (I != Conds.begin()) {
 694         O << " &&\n";
 695         O.indent(8);
 696       }
 697
 698       O << *I;
 699     }
 700
 701     O << ") {\n";
 702     O.indent(6) << "// " << Result << "\n";
 703
 704     // Directly mangle mapped operands into the string. Each operand is
 705     // identified by a '$' sign followed by a byte identifying the number of the
 706     // operand. We add one to the index to avoid zero bytes.
 707     StringRef ASM(AsmString);
 708     SmallString<128> OutString;
 709     raw_svector_ostream OS(OutString);
 710     for (StringRef::iterator I = ASM.begin(), E = ASM.end(); I != E;) {
 711       OS << *I;
 712       if (*I == '$') {
 713         StringRef Name;
 714         std::tie(Name, I) = parseName(++I, E);
 715         assert(isOpMapped(Name) && "Unmapped operand!");
 716
 717         int OpIndex, PrintIndex;
 718         std::tie(OpIndex, PrintIndex) = getOpData(Name);
 719         if (PrintIndex == -1) {
 720           // Can use the default printOperand route.
 721           OS << format("\\x%02X", (unsigned char)OpIndex + 1);
 722         } else
 723           // 3 bytes if a PrintMethod is needed: 0xFF, the MCInst operand
 724           // number, and which of our pre-detected Methods to call.
 725           OS << format("\\xFF\\x%02X\\x%02X", OpIndex + 1, PrintIndex + 1);
 726       } else {
 727         ++I;
 728       }
 729     }
 730
 731     // Emit the string.
 732     O.indent(6) << "AsmString = \"" << OutString << "\";\n";
 733
 734     O.indent(6) << "break;\n";
 735     O.indent(4) << '}';
 736   }
 737
 738   bool operator==(const IAPrinter &RHS) const {
 739     if (Conds.size() != RHS.Conds.size())
 740       return false;
 741
 742     unsigned Idx = 0;
 743     for (const auto &str : Conds)
 744       if (str != RHS.Conds[Idx++])
 745         return false;
 746
 747     return true;
 748   }
 749 };
 750
 751 } // end anonymous namespace
 752
 753 static unsigned CountNumOperands(StringRef AsmString, unsigned Variant) {
 754   std::string FlatAsmString =
 755       CodeGenInstruction::FlattenAsmStringVariants(AsmString, Variant);
 756   AsmString = FlatAsmString;
 757
 758   return AsmString.count(' ') + AsmString.count('\t');
 759 }
 760
 761 namespace {
 762 struct AliasPriorityComparator {
 763   typedef std::pair<CodeGenInstAlias, int> ValueType;
 764   bool operator()(const ValueType &LHS, const ValueType &RHS) {
 765     if (LHS.second ==  RHS.second) {
 766       // We don't actually care about the order, but for consistency it
 767       // shouldn't depend on pointer comparisons.
 768       return LHS.first.TheDef->getName() < RHS.first.TheDef->getName();
 769     }
 770
 771     // Aliases with larger priorities should be considered first.
 772     return LHS.second > RHS.second;
 773   }
 774 };
 775 }
 776
 777
 778 void AsmWriterEmitter::EmitPrintAliasInstruction(raw_ostream &O) {
 779   Record *AsmWriter = Target.getAsmWriter();
 780
 781   O << "\n#ifdef PRINT_ALIAS_INSTR\n";
 782   O << "#undef PRINT_ALIAS_INSTR\n\n";
 783
 784   //////////////////////////////
 785   // Gather information about aliases we need to print
 786   //////////////////////////////
 787
 788   // Emit the method that prints the alias instruction.
 789   std::string ClassName = AsmWriter->getValueAsString("AsmWriterClassName");
 790   unsigned Variant = AsmWriter->getValueAsInt("Variant");
 791   unsigned PassSubtarget = AsmWriter->getValueAsInt("PassSubtarget");
 792
 793   std::vector<Record*> AllInstAliases =
 794     Records.getAllDerivedDefinitions("InstAlias");
 795
 796   // Create a map from the qualified name to a list of potential matches.
 797   typedef std::set<std::pair<CodeGenInstAlias, int>, AliasPriorityComparator>
 798       AliasWithPriority;
 799   std::map<std::string, AliasWithPriority> AliasMap;
 800   for (Record *R : AllInstAliases) {
 801     int Priority = R->getValueAsInt("EmitPriority");
 802     if (Priority < 1)
 803       continue; // Aliases with priority 0 are never emitted.
 804
 805     const DagInit *DI = R->getValueAsDag("ResultInst");
 806     const DefInit *Op = cast<DefInit>(DI->getOperator());
 807     AliasMap[getQualifiedName(Op->getDef())].insert(
 808         std::make_pair(CodeGenInstAlias(R, Variant, Target), Priority));
 809   }
 810
 811   // A map of which conditions need to be met for each instruction operand
 812   // before it can be matched to the mnemonic.
 813   std::map<std::string, std::vector<IAPrinter>> IAPrinterMap;
 814
 815   // A list of MCOperandPredicates for all operands in use, and the reverse map
 816   std::vector<const Record*> MCOpPredicates;
 817   DenseMap<const Record*, unsigned> MCOpPredicateMap;
 818
 819   for (auto &Aliases : AliasMap) {
 820     for (auto &Alias : Aliases.second) {
 821       const CodeGenInstAlias &CGA = Alias.first;
 822       unsigned LastOpNo = CGA.ResultInstOperandIndex.size();
 823       unsigned NumResultOps =
 824           CountNumOperands(CGA.ResultInst->AsmString, Variant);
 825
 826       // Don't emit the alias if it has more operands than what it's aliasing.
 827       if (NumResultOps < CountNumOperands(CGA.AsmString, Variant))
 828         continue;
 829
 830       IAPrinter IAP(CGA.Result->getAsString(), CGA.AsmString);
 831
 832       unsigned NumMIOps = 0;
 833       for (auto &Operand : CGA.ResultOperands)
 834         NumMIOps += Operand.getMINumOperands();
 835
 836       std::string Cond;
 837       Cond = std::string("MI->getNumOperands() == ") + llvm::utostr(NumMIOps);
 838       IAP.addCond(Cond);
 839
 840       bool CantHandle = false;
 841
 842       unsigned MIOpNum = 0;
 843       for (unsigned i = 0, e = LastOpNo; i != e; ++i) {
 844         std::string Op = "MI->getOperand(" + llvm::utostr(MIOpNum) + ")";
 845
 846         const CodeGenInstAlias::ResultOperand &RO = CGA.ResultOperands[i];
 847
 848         switch (RO.Kind) {
 849         case CodeGenInstAlias::ResultOperand::K_Record: {
 850           const Record *Rec = RO.getRecord();
 851           StringRef ROName = RO.getName();
 852           int PrintMethodIdx = -1;
 853
 854           // These two may have a PrintMethod, which we want to record (if it's
 855           // the first time we've seen it) and provide an index for the aliasing
 856           // code to use.
 857           if (Rec->isSubClassOf("RegisterOperand") ||
 858               Rec->isSubClassOf("Operand")) {
 859             std::string PrintMethod = Rec->getValueAsString("PrintMethod");
 860             if (PrintMethod != "" && PrintMethod != "printOperand") {
 861               PrintMethodIdx = std::find(PrintMethods.begin(),
 862                                          PrintMethods.end(), PrintMethod) -
 863                                PrintMethods.begin();
 864               if (static_cast<unsigned>(PrintMethodIdx) == PrintMethods.size())
 865                 PrintMethods.push_back(PrintMethod);
 866             }
 867           }
 868
 869           if (Rec->isSubClassOf("RegisterOperand"))
 870             Rec = Rec->getValueAsDef("RegClass");
 871           if (Rec->isSubClassOf("RegisterClass")) {
 872             IAP.addCond(Op + ".isReg()");
 873
 874             if (!IAP.isOpMapped(ROName)) {
 875               IAP.addOperand(ROName, MIOpNum, PrintMethodIdx);
 876               Record *R = CGA.ResultOperands[i].getRecord();
 877               if (R->isSubClassOf("RegisterOperand"))
 878                 R = R->getValueAsDef("RegClass");
 879               Cond = std::string("MRI.getRegClass(") + Target.getName() + "::" +
 880                      R->getName() + "RegClassID)"
 881                                     ".contains(" + Op + ".getReg())";
 882             } else {
 883               Cond = Op + ".getReg() == MI->getOperand(" +
 884                      llvm::utostr(IAP.getOpIndex(ROName)) + ").getReg()";
 885             }
 886           } else {
 887             // Assume all printable operands are desired for now. This can be
 888             // overridden in the InstAlias instantiation if necessary.
 889             IAP.addOperand(ROName, MIOpNum, PrintMethodIdx);
 890
 891             // There might be an additional predicate on the MCOperand
 892             unsigned Entry = MCOpPredicateMap[Rec];
 893             if (!Entry) {
 894               if (!Rec->isValueUnset("MCOperandPredicate")) {
 895                 MCOpPredicates.push_back(Rec);
 896                 Entry = MCOpPredicates.size();
 897                 MCOpPredicateMap[Rec] = Entry;
 898               } else
 899                 break; // No conditions on this operand at all
 900             }
 901             Cond = Target.getName() + ClassName + "ValidateMCOperand(" +
 902                    Op + ", STI, " + llvm::utostr(Entry) + ")";
 903           }
 904           // for all subcases of ResultOperand::K_Record:
 905           IAP.addCond(Cond);
 906           break;
 907         }
 908         case CodeGenInstAlias::ResultOperand::K_Imm: {
 909           // Just because the alias has an immediate result, doesn't mean the
 910           // MCInst will. An MCExpr could be present, for example.
 911           IAP.addCond(Op + ".isImm()");
 912
 913           Cond = Op + ".getImm() == " +
 914                  llvm::utostr(CGA.ResultOperands[i].getImm());
 915           IAP.addCond(Cond);
 916           break;
 917         }
 918         case CodeGenInstAlias::ResultOperand::K_Reg:
 919           // If this is zero_reg, something's playing tricks we're not
 920           // equipped to handle.
 921           if (!CGA.ResultOperands[i].getRegister()) {
 922             CantHandle = true;
 923             break;
 924           }
 925
 926           Cond = Op + ".getReg() == " + Target.getName() + "::" +
 927                  CGA.ResultOperands[i].getRegister()->getName();
 928           IAP.addCond(Cond);
 929           break;
 930         }
 931
 932         MIOpNum += RO.getMINumOperands();
 933       }
 934
 935       if (CantHandle) continue;
 936       IAPrinterMap[Aliases.first].push_back(std::move(IAP));
 937     }
 938   }
 939
 940   //////////////////////////////
 941   // Write out the printAliasInstr function
 942   //////////////////////////////
 943
 944   std::string Header;
 945   raw_string_ostream HeaderO(Header);
 946
 947   HeaderO << "bool " << Target.getName() << ClassName
 948           << "::printAliasInstr(const MCInst"
 949           << " *MI, " << (PassSubtarget ? "const MCSubtargetInfo &STI, " : "")
 950           << "raw_ostream &OS) {\n";
 951
 952   std::string Cases;
 953   raw_string_ostream CasesO(Cases);
 954
 955   for (auto &Entry : IAPrinterMap) {
 956     std::vector<IAPrinter> &IAPs = Entry.second;
 957     std::vector<IAPrinter*> UniqueIAPs;
 958
 959     for (auto &LHS : IAPs) {
 960       bool IsDup = false;
 961       for (const auto &RHS : IAPs) {
 962         if (&LHS != &RHS && LHS == RHS) {
 963           IsDup = true;
 964           break;
 965         }
 966       }
 967
 968       if (!IsDup)
 969         UniqueIAPs.push_back(&LHS);
 970     }
 971
 972     if (UniqueIAPs.empty()) continue;
 973
 974     CasesO.indent(2) << "case " << Entry.first << ":\n";
 975
 976     for (IAPrinter *IAP : UniqueIAPs) {
 977       CasesO.indent(4);
 978       IAP->print(CasesO);
 979       CasesO << '\n';
 980     }
 981
 982     CasesO.indent(4) << "return false;\n";
 983   }
 984
 985   if (CasesO.str().empty()) {
 986     O << HeaderO.str();
 987     O << "  return false;\n";
 988     O << "}\n\n";
 989     O << "#endif // PRINT_ALIAS_INSTR\n";
 990     return;
 991   }
 992
 993   if (!MCOpPredicates.empty())
 994     O << "static bool " << Target.getName() << ClassName
 995       << "ValidateMCOperand(const MCOperand &MCOp,\n"
 996       << "                  const MCSubtargetInfo &STI,\n"
 997       << "                  unsigned PredicateIndex);\n";
 998
 999   O << HeaderO.str();
1000   O.indent(2) << "const char *AsmString;\n";
1001   O.indent(2) << "switch (MI->getOpcode()) {\n";
1002   O.indent(2) << "default: return false;\n";
1003   O << CasesO.str();
1004   O.indent(2) << "}\n\n";
1005
1006   // Code that prints the alias, replacing the operands with the ones from the
1007   // MCInst.
1008   O << "  unsigned I = 0;\n";
1009   O << "  while (AsmString[I] != ' ' && AsmString[I] != '\t' &&\n";
1010   O << "         AsmString[I] != '\\0')\n";
1011   O << "    ++I;\n";
1012   O << "  OS << '\\t' << StringRef(AsmString, I);\n";
1013
1014   O << "  if (AsmString[I] != '\\0') {\n";
1015   O << "    OS << '\\t';\n";
1016   O << "    do {\n";
1017   O << "      if (AsmString[I] == '$') {\n";
1018   O << "        ++I;\n";
1019   O << "        if (AsmString[I] == (char)0xff) {\n";
1020   O << "          ++I;\n";
1021   O << "          int OpIdx = AsmString[I++] - 1;\n";
1022   O << "          int PrintMethodIdx = AsmString[I++] - 1;\n";
1023   O << "          printCustomAliasOperand(MI, OpIdx, PrintMethodIdx, ";
1024   O << (PassSubtarget ? "STI, " : "");
1025   O << "OS);\n";
1026   O << "        } else\n";
1027   O << "          printOperand(MI, unsigned(AsmString[I++]) - 1, ";
1028   O << (PassSubtarget ? "STI, " : "");
1029   O << "OS);\n";
1030   O << "      } else {\n";
1031   O << "        OS << AsmString[I++];\n";
1032   O << "      }\n";
1033   O << "    } while (AsmString[I] != '\\0');\n";
1034   O << "  }\n\n";
1035
1036   O << "  return true;\n";
1037   O << "}\n\n";
1038
1039   //////////////////////////////
1040   // Write out the printCustomAliasOperand function
1041   //////////////////////////////
1042
1043   O << "void " << Target.getName() << ClassName << "::"
1044     << "printCustomAliasOperand(\n"
1045     << "         const MCInst *MI, unsigned OpIdx,\n"
1046     << "         unsigned PrintMethodIdx,\n"
1047     << (PassSubtarget ? "         const MCSubtargetInfo &STI,\n" : "")
1048     << "         raw_ostream &OS) {\n";
1049   if (PrintMethods.empty())
1050     O << "  llvm_unreachable(\"Unknown PrintMethod kind\");\n";
1051   else {
1052     O << "  switch (PrintMethodIdx) {\n"
1053       << "  default:\n"
1054       << "    llvm_unreachable(\"Unknown PrintMethod kind\");\n"
1055       << "    break;\n";
1056
1057     for (unsigned i = 0; i < PrintMethods.size(); ++i) {
1058       O << "  case " << i << ":\n"
1059         << "    " << PrintMethods[i] << "(MI, OpIdx, "
1060         << (PassSubtarget ? "STI, " : "") << "OS);\n"
1061         << "    break;\n";
1062     }
1063     O << "  }\n";
1064   }
1065   O << "}\n\n";
1066
1067   if (!MCOpPredicates.empty()) {
1068     O << "static bool " << Target.getName() << ClassName
1069       << "ValidateMCOperand(const MCOperand &MCOp,\n"
1070       << "                  const MCSubtargetInfo &STI,\n"
1071       << "                  unsigned PredicateIndex) {\n"
1072       << "  switch (PredicateIndex) {\n"
1073       << "  default:\n"
1074       << "    llvm_unreachable(\"Unknown MCOperandPredicate kind\");\n"
1075       << "    break;\n";
1076
1077     for (unsigned i = 0; i < MCOpPredicates.size(); ++i) {
1078       Init *MCOpPred = MCOpPredicates[i]->getValueInit("MCOperandPredicate");
1079       if (StringInit *SI = dyn_cast<StringInit>(MCOpPred)) {
1080         O << "  case " << i + 1 << ": {\n"
1081           << SI->getValue() << "\n"
1082           << "    }\n";
1083       } else
1084         llvm_unreachable("Unexpected MCOperandPredicate field!");
1085     }
1086     O << "  }\n"
1087       << "}\n\n";
1088   }
1089
1090   O << "#endif // PRINT_ALIAS_INSTR\n";
1091 }
1092
1093 AsmWriterEmitter::AsmWriterEmitter(RecordKeeper &R) : Records(R), Target(R) {
1094   Record *AsmWriter = Target.getAsmWriter();
1095   for (const CodeGenInstruction *I : Target.instructions())
1096     if (!I->AsmString.empty() && I->TheDef->getName() != "PHI")
1097       Instructions.emplace_back(*I, AsmWriter->getValueAsInt("Variant"),
1098                                 AsmWriter->getValueAsInt("PassSubtarget"));
1099
1100   // Get the instruction numbering.
1101   NumberedInstructions = &Target.getInstructionsByEnumValue();
1102
1103   // Compute the CodeGenInstruction -> AsmWriterInst mapping.  Note that not
1104   // all machine instructions are necessarily being printed, so there may be
1105   // target instructions not in this map.
1106   for (AsmWriterInst &AWI : Instructions)
1107     CGIAWIMap.insert(std::make_pair(AWI.CGI, &AWI));
1108 }
1109
1110 void AsmWriterEmitter::run(raw_ostream &O) {
1111   EmitPrintInstruction(O);
1112   EmitGetRegisterName(O);
1113   EmitPrintAliasInstruction(O);
1114 }
1115
1116
1117 namespace llvm {
1118
1119 void EmitAsmWriter(RecordKeeper &RK, raw_ostream &OS) {
1120   emitSourceFileHeader("Assembly Writer Source Fragment", OS);
1121   AsmWriterEmitter(RK).run(OS);
1122 }
1123
1124 } // End llvm namespace