lib/CodeGen/MIRParser/MIParser.cpp

   1 //===- MIParser.cpp - Machine instructions parser implementation ----------===//
   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 file implements the parsing of machine instructions.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "MIParser.h"
  15 #include "MILexer.h"
  16 #include "llvm/ADT/StringMap.h"
  17 #include "llvm/AsmParser/SlotMapping.h"
  18 #include "llvm/CodeGen/MachineBasicBlock.h"
  19 #include "llvm/CodeGen/MachineFunction.h"
  20 #include "llvm/CodeGen/MachineFrameInfo.h"
  21 #include "llvm/CodeGen/MachineInstr.h"
  22 #include "llvm/CodeGen/MachineInstrBuilder.h"
  23 #include "llvm/CodeGen/MachineModuleInfo.h"
  24 #include "llvm/IR/Instructions.h"
  25 #include "llvm/IR/Module.h"
  26 #include "llvm/Support/raw_ostream.h"
  27 #include "llvm/Support/SourceMgr.h"
  28 #include "llvm/Target/TargetSubtargetInfo.h"
  29 #include "llvm/Target/TargetInstrInfo.h"
  30
  31 using namespace llvm;
  32
  33 namespace {
  34
  35 struct StringValueUtility {
  36   StringRef String;
  37   std::string UnescapedString;
  38
  39   StringValueUtility(const MIToken &Token) {
  40     if (Token.isStringValueQuoted()) {
  41       Token.unescapeQuotedStringValue(UnescapedString);
  42       String = UnescapedString;
  43       return;
  44     }
  45     String = Token.stringValue();
  46   }
  47
  48   operator StringRef() const { return String; }
  49 };
  50
  51 /// A wrapper struct around the 'MachineOperand' struct that includes a source
  52 /// range.
  53 struct MachineOperandWithLocation {
  54   MachineOperand Operand;
  55   StringRef::iterator Begin;
  56   StringRef::iterator End;
  57
  58   MachineOperandWithLocation(const MachineOperand &Operand,
  59                              StringRef::iterator Begin, StringRef::iterator End)
  60       : Operand(Operand), Begin(Begin), End(End) {}
  61 };
  62
  63 class MIParser {
  64   SourceMgr &SM;
  65   MachineFunction &MF;
  66   SMDiagnostic &Error;
  67   StringRef Source, CurrentSource;
  68   MIToken Token;
  69   const PerFunctionMIParsingState &PFS;
  70   /// Maps from indices to unnamed global values and metadata nodes.
  71   const SlotMapping &IRSlots;
  72   /// Maps from instruction names to op codes.
  73   StringMap<unsigned> Names2InstrOpCodes;
  74   /// Maps from register names to registers.
  75   StringMap<unsigned> Names2Regs;
  76   /// Maps from register mask names to register masks.
  77   StringMap<const uint32_t *> Names2RegMasks;
  78   /// Maps from subregister names to subregister indices.
  79   StringMap<unsigned> Names2SubRegIndices;
  80
  81 public:
  82   MIParser(SourceMgr &SM, MachineFunction &MF, SMDiagnostic &Error,
  83            StringRef Source, const PerFunctionMIParsingState &PFS,
  84            const SlotMapping &IRSlots);
  85
  86   void lex();
  87
  88   /// Report an error at the current location with the given message.
  89   ///
  90   /// This function always return true.
  91   bool error(const Twine &Msg);
  92
  93   /// Report an error at the given location with the given message.
  94   ///
  95   /// This function always return true.
  96   bool error(StringRef::iterator Loc, const Twine &Msg);
  97
  98   bool parse(MachineInstr *&MI);
  99   bool parseMBB(MachineBasicBlock *&MBB);
 100   bool parseNamedRegister(unsigned &Reg);
 101
 102   bool parseRegister(unsigned &Reg);
 103   bool parseRegisterFlag(unsigned &Flags);
 104   bool parseSubRegisterIndex(unsigned &SubReg);
 105   bool parseRegisterOperand(MachineOperand &Dest, bool IsDef = false);
 106   bool parseImmediateOperand(MachineOperand &Dest);
 107   bool parseMBBReference(MachineBasicBlock *&MBB);
 108   bool parseMBBOperand(MachineOperand &Dest);
 109   bool parseStackObjectOperand(MachineOperand &Dest);
 110   bool parseFixedStackObjectOperand(MachineOperand &Dest);
 111   bool parseGlobalAddressOperand(MachineOperand &Dest);
 112   bool parseConstantPoolIndexOperand(MachineOperand &Dest);
 113   bool parseJumpTableIndexOperand(MachineOperand &Dest);
 114   bool parseExternalSymbolOperand(MachineOperand &Dest);
 115   bool parseMDNode(MDNode *&Node);
 116   bool parseMetadataOperand(MachineOperand &Dest);
 117   bool parseCFIOffset(int &Offset);
 118   bool parseCFIOperand(MachineOperand &Dest);
 119   bool parseMachineOperand(MachineOperand &Dest);
 120
 121 private:
 122   /// Convert the integer literal in the current token into an unsigned integer.
 123   ///
 124   /// Return true if an error occurred.
 125   bool getUnsigned(unsigned &Result);
 126
 127   void initNames2InstrOpCodes();
 128
 129   /// Try to convert an instruction name to an opcode. Return true if the
 130   /// instruction name is invalid.
 131   bool parseInstrName(StringRef InstrName, unsigned &OpCode);
 132
 133   bool parseInstruction(unsigned &OpCode, unsigned &Flags);
 134
 135   bool verifyImplicitOperands(ArrayRef<MachineOperandWithLocation> Operands,
 136                               const MCInstrDesc &MCID);
 137
 138   void initNames2Regs();
 139
 140   /// Try to convert a register name to a register number. Return true if the
 141   /// register name is invalid.
 142   bool getRegisterByName(StringRef RegName, unsigned &Reg);
 143
 144   void initNames2RegMasks();
 145
 146   /// Check if the given identifier is a name of a register mask.
 147   ///
 148   /// Return null if the identifier isn't a register mask.
 149   const uint32_t *getRegMask(StringRef Identifier);
 150
 151   void initNames2SubRegIndices();
 152
 153   /// Check if the given identifier is a name of a subregister index.
 154   ///
 155   /// Return 0 if the name isn't a subregister index class.
 156   unsigned getSubRegIndex(StringRef Name);
 157 };
 158
 159 } // end anonymous namespace
 160
 161 MIParser::MIParser(SourceMgr &SM, MachineFunction &MF, SMDiagnostic &Error,
 162                    StringRef Source, const PerFunctionMIParsingState &PFS,
 163                    const SlotMapping &IRSlots)
 164     : SM(SM), MF(MF), Error(Error), Source(Source), CurrentSource(Source),
 165       Token(MIToken::Error, StringRef()), PFS(PFS), IRSlots(IRSlots) {}
 166
 167 void MIParser::lex() {
 168   CurrentSource = lexMIToken(
 169       CurrentSource, Token,
 170       [this](StringRef::iterator Loc, const Twine &Msg) { error(Loc, Msg); });
 171 }
 172
 173 bool MIParser::error(const Twine &Msg) { return error(Token.location(), Msg); }
 174
 175 bool MIParser::error(StringRef::iterator Loc, const Twine &Msg) {
 176   assert(Loc >= Source.data() && Loc <= (Source.data() + Source.size()));
 177   Error = SMDiagnostic(
 178       SM, SMLoc(),
 179       SM.getMemoryBuffer(SM.getMainFileID())->getBufferIdentifier(), 1,
 180       Loc - Source.data(), SourceMgr::DK_Error, Msg.str(), Source, None, None);
 181   return true;
 182 }
 183
 184 bool MIParser::parse(MachineInstr *&MI) {
 185   lex();
 186
 187   // Parse any register operands before '='
 188   // TODO: Allow parsing of multiple operands before '='
 189   MachineOperand MO = MachineOperand::CreateImm(0);
 190   SmallVector<MachineOperandWithLocation, 8> Operands;
 191   if (Token.isRegister() || Token.isRegisterFlag()) {
 192     auto Loc = Token.location();
 193     if (parseRegisterOperand(MO, /*IsDef=*/true))
 194       return true;
 195     Operands.push_back(MachineOperandWithLocation(MO, Loc, Token.location()));
 196     if (Token.isNot(MIToken::equal))
 197       return error("expected '='");
 198     lex();
 199   }
 200
 201   unsigned OpCode, Flags = 0;
 202   if (Token.isError() || parseInstruction(OpCode, Flags))
 203     return true;
 204
 205   // TODO: Parse the bundle instruction flags and memory operands.
 206
 207   // Parse the remaining machine operands.
 208   while (Token.isNot(MIToken::Eof)) {
 209     auto Loc = Token.location();
 210     if (parseMachineOperand(MO))
 211       return true;
 212     Operands.push_back(MachineOperandWithLocation(MO, Loc, Token.location()));
 213     if (Token.is(MIToken::Eof))
 214       break;
 215     if (Token.isNot(MIToken::comma))
 216       return error("expected ',' before the next machine operand");
 217     lex();
 218   }
 219
 220   const auto &MCID = MF.getSubtarget().getInstrInfo()->get(OpCode);
 221   if (!MCID.isVariadic()) {
 222     // FIXME: Move the implicit operand verification to the machine verifier.
 223     if (verifyImplicitOperands(Operands, MCID))
 224       return true;
 225   }
 226
 227   // TODO: Check for extraneous machine operands.
 228   MI = MF.CreateMachineInstr(MCID, DebugLoc(), /*NoImplicit=*/true);
 229   MI->setFlags(Flags);
 230   for (const auto &Operand : Operands)
 231     MI->addOperand(MF, Operand.Operand);
 232   return false;
 233 }
 234
 235 bool MIParser::parseMBB(MachineBasicBlock *&MBB) {
 236   lex();
 237   if (Token.isNot(MIToken::MachineBasicBlock))
 238     return error("expected a machine basic block reference");
 239   if (parseMBBReference(MBB))
 240     return true;
 241   lex();
 242   if (Token.isNot(MIToken::Eof))
 243     return error(
 244         "expected end of string after the machine basic block reference");
 245   return false;
 246 }
 247
 248 bool MIParser::parseNamedRegister(unsigned &Reg) {
 249   lex();
 250   if (Token.isNot(MIToken::NamedRegister))
 251     return error("expected a named register");
 252   if (parseRegister(Reg))
 253     return 0;
 254   lex();
 255   if (Token.isNot(MIToken::Eof))
 256     return error("expected end of string after the register reference");
 257   return false;
 258 }
 259
 260 static const char *printImplicitRegisterFlag(const MachineOperand &MO) {
 261   assert(MO.isImplicit());
 262   return MO.isDef() ? "implicit-def" : "implicit";
 263 }
 264
 265 static std::string getRegisterName(const TargetRegisterInfo *TRI,
 266                                    unsigned Reg) {
 267   assert(TargetRegisterInfo::isPhysicalRegister(Reg) && "expected phys reg");
 268   return StringRef(TRI->getName(Reg)).lower();
 269 }
 270
 271 bool MIParser::verifyImplicitOperands(
 272     ArrayRef<MachineOperandWithLocation> Operands, const MCInstrDesc &MCID) {
 273   if (MCID.isCall())
 274     // We can't verify call instructions as they can contain arbitrary implicit
 275     // register and register mask operands.
 276     return false;
 277
 278   // Gather all the expected implicit operands.
 279   SmallVector<MachineOperand, 4> ImplicitOperands;
 280   if (MCID.ImplicitDefs)
 281     for (const uint16_t *ImpDefs = MCID.getImplicitDefs(); *ImpDefs; ++ImpDefs)
 282       ImplicitOperands.push_back(
 283           MachineOperand::CreateReg(*ImpDefs, true, true));
 284   if (MCID.ImplicitUses)
 285     for (const uint16_t *ImpUses = MCID.getImplicitUses(); *ImpUses; ++ImpUses)
 286       ImplicitOperands.push_back(
 287           MachineOperand::CreateReg(*ImpUses, false, true));
 288
 289   const auto *TRI = MF.getSubtarget().getRegisterInfo();
 290   assert(TRI && "Expected target register info");
 291   size_t I = ImplicitOperands.size(), J = Operands.size();
 292   while (I) {
 293     --I;
 294     if (J) {
 295       --J;
 296       const auto &ImplicitOperand = ImplicitOperands[I];
 297       const auto &Operand = Operands[J].Operand;
 298       if (ImplicitOperand.isIdenticalTo(Operand))
 299         continue;
 300       if (Operand.isReg() && Operand.isImplicit()) {
 301         return error(Operands[J].Begin,
 302                      Twine("expected an implicit register operand '") +
 303                          printImplicitRegisterFlag(ImplicitOperand) + " %" +
 304                          getRegisterName(TRI, ImplicitOperand.getReg()) + "'");
 305       }
 306     }
 307     // TODO: Fix source location when Operands[J].end is right before '=', i.e:
 308     // insead of reporting an error at this location:
 309     //            %eax = MOV32r0
 310     //                 ^
 311     // report the error at the following location:
 312     //            %eax = MOV32r0
 313     //                          ^
 314     return error(J < Operands.size() ? Operands[J].End : Token.location(),
 315                  Twine("missing implicit register operand '") +
 316                      printImplicitRegisterFlag(ImplicitOperands[I]) + " %" +
 317                      getRegisterName(TRI, ImplicitOperands[I].getReg()) + "'");
 318   }
 319   return false;
 320 }
 321
 322 bool MIParser::parseInstruction(unsigned &OpCode, unsigned &Flags) {
 323   if (Token.is(MIToken::kw_frame_setup)) {
 324     Flags |= MachineInstr::FrameSetup;
 325     lex();
 326   }
 327   if (Token.isNot(MIToken::Identifier))
 328     return error("expected a machine instruction");
 329   StringRef InstrName = Token.stringValue();
 330   if (parseInstrName(InstrName, OpCode))
 331     return error(Twine("unknown machine instruction name '") + InstrName + "'");
 332   lex();
 333   return false;
 334 }
 335
 336 bool MIParser::parseRegister(unsigned &Reg) {
 337   switch (Token.kind()) {
 338   case MIToken::underscore:
 339     Reg = 0;
 340     break;
 341   case MIToken::NamedRegister: {
 342     StringRef Name = Token.stringValue();
 343     if (getRegisterByName(Name, Reg))
 344       return error(Twine("unknown register name '") + Name + "'");
 345     break;
 346   }
 347   case MIToken::VirtualRegister: {
 348     unsigned ID;
 349     if (getUnsigned(ID))
 350       return true;
 351     const auto RegInfo = PFS.VirtualRegisterSlots.find(ID);
 352     if (RegInfo == PFS.VirtualRegisterSlots.end())
 353       return error(Twine("use of undefined virtual register '%") + Twine(ID) +
 354                    "'");
 355     Reg = RegInfo->second;
 356     break;
 357   }
 358   // TODO: Parse other register kinds.
 359   default:
 360     llvm_unreachable("The current token should be a register");
 361   }
 362   return false;
 363 }
 364
 365 bool MIParser::parseRegisterFlag(unsigned &Flags) {
 366   switch (Token.kind()) {
 367   case MIToken::kw_implicit:
 368     Flags |= RegState::Implicit;
 369     break;
 370   case MIToken::kw_implicit_define:
 371     Flags |= RegState::ImplicitDefine;
 372     break;
 373   case MIToken::kw_dead:
 374     Flags |= RegState::Dead;
 375     break;
 376   case MIToken::kw_killed:
 377     Flags |= RegState::Kill;
 378     break;
 379   case MIToken::kw_undef:
 380     Flags |= RegState::Undef;
 381     break;
 382   // TODO: report an error when we specify the same flag more than once.
 383   // TODO: parse the other register flags.
 384   default:
 385     llvm_unreachable("The current token should be a register flag");
 386   }
 387   lex();
 388   return false;
 389 }
 390
 391 bool MIParser::parseSubRegisterIndex(unsigned &SubReg) {
 392   assert(Token.is(MIToken::colon));
 393   lex();
 394   if (Token.isNot(MIToken::Identifier))
 395     return error("expected a subregister index after ':'");
 396   auto Name = Token.stringValue();
 397   SubReg = getSubRegIndex(Name);
 398   if (!SubReg)
 399     return error(Twine("use of unknown subregister index '") + Name + "'");
 400   lex();
 401   return false;
 402 }
 403
 404 bool MIParser::parseRegisterOperand(MachineOperand &Dest, bool IsDef) {
 405   unsigned Reg;
 406   unsigned Flags = IsDef ? RegState::Define : 0;
 407   while (Token.isRegisterFlag()) {
 408     if (parseRegisterFlag(Flags))
 409       return true;
 410   }
 411   if (!Token.isRegister())
 412     return error("expected a register after register flags");
 413   if (parseRegister(Reg))
 414     return true;
 415   lex();
 416   unsigned SubReg = 0;
 417   if (Token.is(MIToken::colon)) {
 418     if (parseSubRegisterIndex(SubReg))
 419       return true;
 420   }
 421   Dest = MachineOperand::CreateReg(
 422       Reg, Flags & RegState::Define, Flags & RegState::Implicit,
 423       Flags & RegState::Kill, Flags & RegState::Dead, Flags & RegState::Undef,
 424       /*isEarlyClobber=*/false, SubReg);
 425   return false;
 426 }
 427
 428 bool MIParser::parseImmediateOperand(MachineOperand &Dest) {
 429   assert(Token.is(MIToken::IntegerLiteral));
 430   const APSInt &Int = Token.integerValue();
 431   if (Int.getMinSignedBits() > 64)
 432     // TODO: Replace this with an error when we can parse CIMM Machine Operands.
 433     llvm_unreachable("Can't parse large integer literals yet!");
 434   Dest = MachineOperand::CreateImm(Int.getExtValue());
 435   lex();
 436   return false;
 437 }
 438
 439 bool MIParser::getUnsigned(unsigned &Result) {
 440   assert(Token.hasIntegerValue() && "Expected a token with an integer value");
 441   const uint64_t Limit = uint64_t(std::numeric_limits<unsigned>::max()) + 1;
 442   uint64_t Val64 = Token.integerValue().getLimitedValue(Limit);
 443   if (Val64 == Limit)
 444     return error("expected 32-bit integer (too large)");
 445   Result = Val64;
 446   return false;
 447 }
 448
 449 bool MIParser::parseMBBReference(MachineBasicBlock *&MBB) {
 450   assert(Token.is(MIToken::MachineBasicBlock));
 451   unsigned Number;
 452   if (getUnsigned(Number))
 453     return true;
 454   auto MBBInfo = PFS.MBBSlots.find(Number);
 455   if (MBBInfo == PFS.MBBSlots.end())
 456     return error(Twine("use of undefined machine basic block #") +
 457                  Twine(Number));
 458   MBB = MBBInfo->second;
 459   if (!Token.stringValue().empty() && Token.stringValue() != MBB->getName())
 460     return error(Twine("the name of machine basic block #") + Twine(Number) +
 461                  " isn't '" + Token.stringValue() + "'");
 462   return false;
 463 }
 464
 465 bool MIParser::parseMBBOperand(MachineOperand &Dest) {
 466   MachineBasicBlock *MBB;
 467   if (parseMBBReference(MBB))
 468     return true;
 469   Dest = MachineOperand::CreateMBB(MBB);
 470   lex();
 471   return false;
 472 }
 473
 474 bool MIParser::parseStackObjectOperand(MachineOperand &Dest) {
 475   assert(Token.is(MIToken::StackObject));
 476   unsigned ID;
 477   if (getUnsigned(ID))
 478     return true;
 479   auto ObjectInfo = PFS.StackObjectSlots.find(ID);
 480   if (ObjectInfo == PFS.StackObjectSlots.end())
 481     return error(Twine("use of undefined stack object '%stack.") + Twine(ID) +
 482                  "'");
 483   StringRef Name;
 484   if (const auto *Alloca =
 485           MF.getFrameInfo()->getObjectAllocation(ObjectInfo->second))
 486     Name = Alloca->getName();
 487   if (!Token.stringValue().empty() && Token.stringValue() != Name)
 488     return error(Twine("the name of the stack object '%stack.") + Twine(ID) +
 489                  "' isn't '" + Token.stringValue() + "'");
 490   lex();
 491   Dest = MachineOperand::CreateFI(ObjectInfo->second);
 492   return false;
 493 }
 494
 495 bool MIParser::parseFixedStackObjectOperand(MachineOperand &Dest) {
 496   assert(Token.is(MIToken::FixedStackObject));
 497   unsigned ID;
 498   if (getUnsigned(ID))
 499     return true;
 500   auto ObjectInfo = PFS.FixedStackObjectSlots.find(ID);
 501   if (ObjectInfo == PFS.FixedStackObjectSlots.end())
 502     return error(Twine("use of undefined fixed stack object '%fixed-stack.") +
 503                  Twine(ID) + "'");
 504   lex();
 505   Dest = MachineOperand::CreateFI(ObjectInfo->second);
 506   return false;
 507 }
 508
 509 bool MIParser::parseGlobalAddressOperand(MachineOperand &Dest) {
 510   switch (Token.kind()) {
 511   case MIToken::NamedGlobalValue:
 512   case MIToken::QuotedNamedGlobalValue: {
 513     StringValueUtility Name(Token);
 514     const Module *M = MF.getFunction()->getParent();
 515     if (const auto *GV = M->getNamedValue(Name)) {
 516       Dest = MachineOperand::CreateGA(GV, /*Offset=*/0);
 517       break;
 518     }
 519     return error(Twine("use of undefined global value '@") +
 520                  Token.rawStringValue() + "'");
 521   }
 522   case MIToken::GlobalValue: {
 523     unsigned GVIdx;
 524     if (getUnsigned(GVIdx))
 525       return true;
 526     if (GVIdx >= IRSlots.GlobalValues.size())
 527       return error(Twine("use of undefined global value '@") + Twine(GVIdx) +
 528                    "'");
 529     Dest = MachineOperand::CreateGA(IRSlots.GlobalValues[GVIdx],
 530                                     /*Offset=*/0);
 531     break;
 532   }
 533   default:
 534     llvm_unreachable("The current token should be a global value");
 535   }
 536   // TODO: Parse offset and target flags.
 537   lex();
 538   return false;
 539 }
 540
 541 bool MIParser::parseConstantPoolIndexOperand(MachineOperand &Dest) {
 542   assert(Token.is(MIToken::ConstantPoolItem));
 543   unsigned ID;
 544   if (getUnsigned(ID))
 545     return true;
 546   auto ConstantInfo = PFS.ConstantPoolSlots.find(ID);
 547   if (ConstantInfo == PFS.ConstantPoolSlots.end())
 548     return error("use of undefined constant '%const." + Twine(ID) + "'");
 549   lex();
 550   // TODO: Parse offset and target flags.
 551   Dest = MachineOperand::CreateCPI(ID, /*Offset=*/0);
 552   return false;
 553 }
 554
 555 bool MIParser::parseJumpTableIndexOperand(MachineOperand &Dest) {
 556   assert(Token.is(MIToken::JumpTableIndex));
 557   unsigned ID;
 558   if (getUnsigned(ID))
 559     return true;
 560   auto JumpTableEntryInfo = PFS.JumpTableSlots.find(ID);
 561   if (JumpTableEntryInfo == PFS.JumpTableSlots.end())
 562     return error("use of undefined jump table '%jump-table." + Twine(ID) + "'");
 563   lex();
 564   // TODO: Parse target flags.
 565   Dest = MachineOperand::CreateJTI(JumpTableEntryInfo->second);
 566   return false;
 567 }
 568
 569 bool MIParser::parseExternalSymbolOperand(MachineOperand &Dest) {
 570   assert(Token.is(MIToken::ExternalSymbol) ||
 571          Token.is(MIToken::QuotedExternalSymbol));
 572   StringValueUtility Name(Token);
 573   const char *Symbol = MF.createExternalSymbolName(Name);
 574   lex();
 575   // TODO: Parse the target flags.
 576   Dest = MachineOperand::CreateES(Symbol);
 577   return false;
 578 }
 579
 580 bool MIParser::parseMDNode(MDNode *&Node) {
 581   assert(Token.is(MIToken::exclaim));
 582   auto Loc = Token.location();
 583   lex();
 584   if (Token.isNot(MIToken::IntegerLiteral) || Token.integerValue().isSigned())
 585     return error("expected metadata id after '!'");
 586   unsigned ID;
 587   if (getUnsigned(ID))
 588     return true;
 589   auto NodeInfo = IRSlots.MetadataNodes.find(ID);
 590   if (NodeInfo == IRSlots.MetadataNodes.end())
 591     return error(Loc, "use of undefined metadata '!" + Twine(ID) + "'");
 592   lex();
 593   Node = NodeInfo->second.get();
 594   return false;
 595 }
 596
 597 bool MIParser::parseMetadataOperand(MachineOperand &Dest) {
 598   MDNode *Node = nullptr;
 599   if (parseMDNode(Node))
 600     return true;
 601   Dest = MachineOperand::CreateMetadata(Node);
 602   return false;
 603 }
 604
 605 bool MIParser::parseCFIOffset(int &Offset) {
 606   if (Token.isNot(MIToken::IntegerLiteral))
 607     return error("expected a cfi offset");
 608   if (Token.integerValue().getMinSignedBits() > 32)
 609     return error("expected a 32 bit integer (the cfi offset is too large)");
 610   Offset = (int)Token.integerValue().getExtValue();
 611   lex();
 612   return false;
 613 }
 614
 615 bool MIParser::parseCFIOperand(MachineOperand &Dest) {
 616   // TODO: Parse the other CFI operands.
 617   assert(Token.is(MIToken::kw_cfi_def_cfa_offset));
 618   lex();
 619   int Offset;
 620   if (parseCFIOffset(Offset))
 621     return true;
 622   // NB: MCCFIInstruction::createDefCfaOffset negates the offset.
 623   Dest = MachineOperand::CreateCFIIndex(MF.getMMI().addFrameInst(
 624       MCCFIInstruction::createDefCfaOffset(nullptr, -Offset)));
 625   return false;
 626 }
 627
 628 bool MIParser::parseMachineOperand(MachineOperand &Dest) {
 629   switch (Token.kind()) {
 630   case MIToken::kw_implicit:
 631   case MIToken::kw_implicit_define:
 632   case MIToken::kw_dead:
 633   case MIToken::kw_killed:
 634   case MIToken::kw_undef:
 635   case MIToken::underscore:
 636   case MIToken::NamedRegister:
 637   case MIToken::VirtualRegister:
 638     return parseRegisterOperand(Dest);
 639   case MIToken::IntegerLiteral:
 640     return parseImmediateOperand(Dest);
 641   case MIToken::MachineBasicBlock:
 642     return parseMBBOperand(Dest);
 643   case MIToken::StackObject:
 644     return parseStackObjectOperand(Dest);
 645   case MIToken::FixedStackObject:
 646     return parseFixedStackObjectOperand(Dest);
 647   case MIToken::GlobalValue:
 648   case MIToken::NamedGlobalValue:
 649   case MIToken::QuotedNamedGlobalValue:
 650     return parseGlobalAddressOperand(Dest);
 651   case MIToken::ConstantPoolItem:
 652     return parseConstantPoolIndexOperand(Dest);
 653   case MIToken::JumpTableIndex:
 654     return parseJumpTableIndexOperand(Dest);
 655   case MIToken::ExternalSymbol:
 656   case MIToken::QuotedExternalSymbol:
 657     return parseExternalSymbolOperand(Dest);
 658   case MIToken::exclaim:
 659     return parseMetadataOperand(Dest);
 660   case MIToken::kw_cfi_def_cfa_offset:
 661     return parseCFIOperand(Dest);
 662   case MIToken::Error:
 663     return true;
 664   case MIToken::Identifier:
 665     if (const auto *RegMask = getRegMask(Token.stringValue())) {
 666       Dest = MachineOperand::CreateRegMask(RegMask);
 667       lex();
 668       break;
 669     }
 670   // fallthrough
 671   default:
 672     // TODO: parse the other machine operands.
 673     return error("expected a machine operand");
 674   }
 675   return false;
 676 }
 677
 678 void MIParser::initNames2InstrOpCodes() {
 679   if (!Names2InstrOpCodes.empty())
 680     return;
 681   const auto *TII = MF.getSubtarget().getInstrInfo();
 682   assert(TII && "Expected target instruction info");
 683   for (unsigned I = 0, E = TII->getNumOpcodes(); I < E; ++I)
 684     Names2InstrOpCodes.insert(std::make_pair(StringRef(TII->getName(I)), I));
 685 }
 686
 687 bool MIParser::parseInstrName(StringRef InstrName, unsigned &OpCode) {
 688   initNames2InstrOpCodes();
 689   auto InstrInfo = Names2InstrOpCodes.find(InstrName);
 690   if (InstrInfo == Names2InstrOpCodes.end())
 691     return true;
 692   OpCode = InstrInfo->getValue();
 693   return false;
 694 }
 695
 696 void MIParser::initNames2Regs() {
 697   if (!Names2Regs.empty())
 698     return;
 699   // The '%noreg' register is the register 0.
 700   Names2Regs.insert(std::make_pair("noreg", 0));
 701   const auto *TRI = MF.getSubtarget().getRegisterInfo();
 702   assert(TRI && "Expected target register info");
 703   for (unsigned I = 0, E = TRI->getNumRegs(); I < E; ++I) {
 704     bool WasInserted =
 705         Names2Regs.insert(std::make_pair(StringRef(TRI->getName(I)).lower(), I))
 706             .second;
 707     (void)WasInserted;
 708     assert(WasInserted && "Expected registers to be unique case-insensitively");
 709   }
 710 }
 711
 712 bool MIParser::getRegisterByName(StringRef RegName, unsigned &Reg) {
 713   initNames2Regs();
 714   auto RegInfo = Names2Regs.find(RegName);
 715   if (RegInfo == Names2Regs.end())
 716     return true;
 717   Reg = RegInfo->getValue();
 718   return false;
 719 }
 720
 721 void MIParser::initNames2RegMasks() {
 722   if (!Names2RegMasks.empty())
 723     return;
 724   const auto *TRI = MF.getSubtarget().getRegisterInfo();
 725   assert(TRI && "Expected target register info");
 726   ArrayRef<const uint32_t *> RegMasks = TRI->getRegMasks();
 727   ArrayRef<const char *> RegMaskNames = TRI->getRegMaskNames();
 728   assert(RegMasks.size() == RegMaskNames.size());
 729   for (size_t I = 0, E = RegMasks.size(); I < E; ++I)
 730     Names2RegMasks.insert(
 731         std::make_pair(StringRef(RegMaskNames[I]).lower(), RegMasks[I]));
 732 }
 733
 734 const uint32_t *MIParser::getRegMask(StringRef Identifier) {
 735   initNames2RegMasks();
 736   auto RegMaskInfo = Names2RegMasks.find(Identifier);
 737   if (RegMaskInfo == Names2RegMasks.end())
 738     return nullptr;
 739   return RegMaskInfo->getValue();
 740 }
 741
 742 void MIParser::initNames2SubRegIndices() {
 743   if (!Names2SubRegIndices.empty())
 744     return;
 745   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
 746   for (unsigned I = 1, E = TRI->getNumSubRegIndices(); I < E; ++I)
 747     Names2SubRegIndices.insert(
 748         std::make_pair(StringRef(TRI->getSubRegIndexName(I)).lower(), I));
 749 }
 750
 751 unsigned MIParser::getSubRegIndex(StringRef Name) {
 752   initNames2SubRegIndices();
 753   auto SubRegInfo = Names2SubRegIndices.find(Name);
 754   if (SubRegInfo == Names2SubRegIndices.end())
 755     return 0;
 756   return SubRegInfo->getValue();
 757 }
 758
 759 bool llvm::parseMachineInstr(MachineInstr *&MI, SourceMgr &SM,
 760                              MachineFunction &MF, StringRef Src,
 761                              const PerFunctionMIParsingState &PFS,
 762                              const SlotMapping &IRSlots, SMDiagnostic &Error) {
 763   return MIParser(SM, MF, Error, Src, PFS, IRSlots).parse(MI);
 764 }
 765
 766 bool llvm::parseMBBReference(MachineBasicBlock *&MBB, SourceMgr &SM,
 767                              MachineFunction &MF, StringRef Src,
 768                              const PerFunctionMIParsingState &PFS,
 769                              const SlotMapping &IRSlots, SMDiagnostic &Error) {
 770   return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseMBB(MBB);
 771 }
 772
 773 bool llvm::parseNamedRegisterReference(unsigned &Reg, SourceMgr &SM,
 774                                        MachineFunction &MF, StringRef Src,
 775                                        const PerFunctionMIParsingState &PFS,
 776                                        const SlotMapping &IRSlots,
 777                                        SMDiagnostic &Error) {
 778   return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseNamedRegister(Reg);
 779 }