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) && Token.isNot(MIToken::kw_debug_location)) {
 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   DebugLoc DebugLocation;
 221   if (Token.is(MIToken::kw_debug_location)) {
 222     lex();
 223     if (Token.isNot(MIToken::exclaim))
 224       return error("expected a metadata node after 'debug-location'");
 225     MDNode *Node = nullptr;
 226     if (parseMDNode(Node))
 227       return true;
 228     DebugLocation = DebugLoc(Node);
 229   }
 230
 231   const auto &MCID = MF.getSubtarget().getInstrInfo()->get(OpCode);
 232   if (!MCID.isVariadic()) {
 233     // FIXME: Move the implicit operand verification to the machine verifier.
 234     if (verifyImplicitOperands(Operands, MCID))
 235       return true;
 236   }
 237
 238   // TODO: Check for extraneous machine operands.
 239   MI = MF.CreateMachineInstr(MCID, DebugLocation, /*NoImplicit=*/true);
 240   MI->setFlags(Flags);
 241   for (const auto &Operand : Operands)
 242     MI->addOperand(MF, Operand.Operand);
 243   return false;
 244 }
 245
 246 bool MIParser::parseMBB(MachineBasicBlock *&MBB) {
 247   lex();
 248   if (Token.isNot(MIToken::MachineBasicBlock))
 249     return error("expected a machine basic block reference");
 250   if (parseMBBReference(MBB))
 251     return true;
 252   lex();
 253   if (Token.isNot(MIToken::Eof))
 254     return error(
 255         "expected end of string after the machine basic block reference");
 256   return false;
 257 }
 258
 259 bool MIParser::parseNamedRegister(unsigned &Reg) {
 260   lex();
 261   if (Token.isNot(MIToken::NamedRegister))
 262     return error("expected a named register");
 263   if (parseRegister(Reg))
 264     return 0;
 265   lex();
 266   if (Token.isNot(MIToken::Eof))
 267     return error("expected end of string after the register reference");
 268   return false;
 269 }
 270
 271 static const char *printImplicitRegisterFlag(const MachineOperand &MO) {
 272   assert(MO.isImplicit());
 273   return MO.isDef() ? "implicit-def" : "implicit";
 274 }
 275
 276 static std::string getRegisterName(const TargetRegisterInfo *TRI,
 277                                    unsigned Reg) {
 278   assert(TargetRegisterInfo::isPhysicalRegister(Reg) && "expected phys reg");
 279   return StringRef(TRI->getName(Reg)).lower();
 280 }
 281
 282 bool MIParser::verifyImplicitOperands(
 283     ArrayRef<MachineOperandWithLocation> Operands, const MCInstrDesc &MCID) {
 284   if (MCID.isCall())
 285     // We can't verify call instructions as they can contain arbitrary implicit
 286     // register and register mask operands.
 287     return false;
 288
 289   // Gather all the expected implicit operands.
 290   SmallVector<MachineOperand, 4> ImplicitOperands;
 291   if (MCID.ImplicitDefs)
 292     for (const uint16_t *ImpDefs = MCID.getImplicitDefs(); *ImpDefs; ++ImpDefs)
 293       ImplicitOperands.push_back(
 294           MachineOperand::CreateReg(*ImpDefs, true, true));
 295   if (MCID.ImplicitUses)
 296     for (const uint16_t *ImpUses = MCID.getImplicitUses(); *ImpUses; ++ImpUses)
 297       ImplicitOperands.push_back(
 298           MachineOperand::CreateReg(*ImpUses, false, true));
 299
 300   const auto *TRI = MF.getSubtarget().getRegisterInfo();
 301   assert(TRI && "Expected target register info");
 302   size_t I = ImplicitOperands.size(), J = Operands.size();
 303   while (I) {
 304     --I;
 305     if (J) {
 306       --J;
 307       const auto &ImplicitOperand = ImplicitOperands[I];
 308       const auto &Operand = Operands[J].Operand;
 309       if (ImplicitOperand.isIdenticalTo(Operand))
 310         continue;
 311       if (Operand.isReg() && Operand.isImplicit()) {
 312         return error(Operands[J].Begin,
 313                      Twine("expected an implicit register operand '") +
 314                          printImplicitRegisterFlag(ImplicitOperand) + " %" +
 315                          getRegisterName(TRI, ImplicitOperand.getReg()) + "'");
 316       }
 317     }
 318     // TODO: Fix source location when Operands[J].end is right before '=', i.e:
 319     // insead of reporting an error at this location:
 320     //            %eax = MOV32r0
 321     //                 ^
 322     // report the error at the following location:
 323     //            %eax = MOV32r0
 324     //                          ^
 325     return error(J < Operands.size() ? Operands[J].End : Token.location(),
 326                  Twine("missing implicit register operand '") +
 327                      printImplicitRegisterFlag(ImplicitOperands[I]) + " %" +
 328                      getRegisterName(TRI, ImplicitOperands[I].getReg()) + "'");
 329   }
 330   return false;
 331 }
 332
 333 bool MIParser::parseInstruction(unsigned &OpCode, unsigned &Flags) {
 334   if (Token.is(MIToken::kw_frame_setup)) {
 335     Flags |= MachineInstr::FrameSetup;
 336     lex();
 337   }
 338   if (Token.isNot(MIToken::Identifier))
 339     return error("expected a machine instruction");
 340   StringRef InstrName = Token.stringValue();
 341   if (parseInstrName(InstrName, OpCode))
 342     return error(Twine("unknown machine instruction name '") + InstrName + "'");
 343   lex();
 344   return false;
 345 }
 346
 347 bool MIParser::parseRegister(unsigned &Reg) {
 348   switch (Token.kind()) {
 349   case MIToken::underscore:
 350     Reg = 0;
 351     break;
 352   case MIToken::NamedRegister: {
 353     StringRef Name = Token.stringValue();
 354     if (getRegisterByName(Name, Reg))
 355       return error(Twine("unknown register name '") + Name + "'");
 356     break;
 357   }
 358   case MIToken::VirtualRegister: {
 359     unsigned ID;
 360     if (getUnsigned(ID))
 361       return true;
 362     const auto RegInfo = PFS.VirtualRegisterSlots.find(ID);
 363     if (RegInfo == PFS.VirtualRegisterSlots.end())
 364       return error(Twine("use of undefined virtual register '%") + Twine(ID) +
 365                    "'");
 366     Reg = RegInfo->second;
 367     break;
 368   }
 369   // TODO: Parse other register kinds.
 370   default:
 371     llvm_unreachable("The current token should be a register");
 372   }
 373   return false;
 374 }
 375
 376 bool MIParser::parseRegisterFlag(unsigned &Flags) {
 377   switch (Token.kind()) {
 378   case MIToken::kw_implicit:
 379     Flags |= RegState::Implicit;
 380     break;
 381   case MIToken::kw_implicit_define:
 382     Flags |= RegState::ImplicitDefine;
 383     break;
 384   case MIToken::kw_dead:
 385     Flags |= RegState::Dead;
 386     break;
 387   case MIToken::kw_killed:
 388     Flags |= RegState::Kill;
 389     break;
 390   case MIToken::kw_undef:
 391     Flags |= RegState::Undef;
 392     break;
 393   // TODO: report an error when we specify the same flag more than once.
 394   // TODO: parse the other register flags.
 395   default:
 396     llvm_unreachable("The current token should be a register flag");
 397   }
 398   lex();
 399   return false;
 400 }
 401
 402 bool MIParser::parseSubRegisterIndex(unsigned &SubReg) {
 403   assert(Token.is(MIToken::colon));
 404   lex();
 405   if (Token.isNot(MIToken::Identifier))
 406     return error("expected a subregister index after ':'");
 407   auto Name = Token.stringValue();
 408   SubReg = getSubRegIndex(Name);
 409   if (!SubReg)
 410     return error(Twine("use of unknown subregister index '") + Name + "'");
 411   lex();
 412   return false;
 413 }
 414
 415 bool MIParser::parseRegisterOperand(MachineOperand &Dest, bool IsDef) {
 416   unsigned Reg;
 417   unsigned Flags = IsDef ? RegState::Define : 0;
 418   while (Token.isRegisterFlag()) {
 419     if (parseRegisterFlag(Flags))
 420       return true;
 421   }
 422   if (!Token.isRegister())
 423     return error("expected a register after register flags");
 424   if (parseRegister(Reg))
 425     return true;
 426   lex();
 427   unsigned SubReg = 0;
 428   if (Token.is(MIToken::colon)) {
 429     if (parseSubRegisterIndex(SubReg))
 430       return true;
 431   }
 432   Dest = MachineOperand::CreateReg(
 433       Reg, Flags & RegState::Define, Flags & RegState::Implicit,
 434       Flags & RegState::Kill, Flags & RegState::Dead, Flags & RegState::Undef,
 435       /*isEarlyClobber=*/false, SubReg);
 436   return false;
 437 }
 438
 439 bool MIParser::parseImmediateOperand(MachineOperand &Dest) {
 440   assert(Token.is(MIToken::IntegerLiteral));
 441   const APSInt &Int = Token.integerValue();
 442   if (Int.getMinSignedBits() > 64)
 443     // TODO: Replace this with an error when we can parse CIMM Machine Operands.
 444     llvm_unreachable("Can't parse large integer literals yet!");
 445   Dest = MachineOperand::CreateImm(Int.getExtValue());
 446   lex();
 447   return false;
 448 }
 449
 450 bool MIParser::getUnsigned(unsigned &Result) {
 451   assert(Token.hasIntegerValue() && "Expected a token with an integer value");
 452   const uint64_t Limit = uint64_t(std::numeric_limits<unsigned>::max()) + 1;
 453   uint64_t Val64 = Token.integerValue().getLimitedValue(Limit);
 454   if (Val64 == Limit)
 455     return error("expected 32-bit integer (too large)");
 456   Result = Val64;
 457   return false;
 458 }
 459
 460 bool MIParser::parseMBBReference(MachineBasicBlock *&MBB) {
 461   assert(Token.is(MIToken::MachineBasicBlock));
 462   unsigned Number;
 463   if (getUnsigned(Number))
 464     return true;
 465   auto MBBInfo = PFS.MBBSlots.find(Number);
 466   if (MBBInfo == PFS.MBBSlots.end())
 467     return error(Twine("use of undefined machine basic block #") +
 468                  Twine(Number));
 469   MBB = MBBInfo->second;
 470   if (!Token.stringValue().empty() && Token.stringValue() != MBB->getName())
 471     return error(Twine("the name of machine basic block #") + Twine(Number) +
 472                  " isn't '" + Token.stringValue() + "'");
 473   return false;
 474 }
 475
 476 bool MIParser::parseMBBOperand(MachineOperand &Dest) {
 477   MachineBasicBlock *MBB;
 478   if (parseMBBReference(MBB))
 479     return true;
 480   Dest = MachineOperand::CreateMBB(MBB);
 481   lex();
 482   return false;
 483 }
 484
 485 bool MIParser::parseStackObjectOperand(MachineOperand &Dest) {
 486   assert(Token.is(MIToken::StackObject));
 487   unsigned ID;
 488   if (getUnsigned(ID))
 489     return true;
 490   auto ObjectInfo = PFS.StackObjectSlots.find(ID);
 491   if (ObjectInfo == PFS.StackObjectSlots.end())
 492     return error(Twine("use of undefined stack object '%stack.") + Twine(ID) +
 493                  "'");
 494   StringRef Name;
 495   if (const auto *Alloca =
 496           MF.getFrameInfo()->getObjectAllocation(ObjectInfo->second))
 497     Name = Alloca->getName();
 498   if (!Token.stringValue().empty() && Token.stringValue() != Name)
 499     return error(Twine("the name of the stack object '%stack.") + Twine(ID) +
 500                  "' isn't '" + Token.stringValue() + "'");
 501   lex();
 502   Dest = MachineOperand::CreateFI(ObjectInfo->second);
 503   return false;
 504 }
 505
 506 bool MIParser::parseFixedStackObjectOperand(MachineOperand &Dest) {
 507   assert(Token.is(MIToken::FixedStackObject));
 508   unsigned ID;
 509   if (getUnsigned(ID))
 510     return true;
 511   auto ObjectInfo = PFS.FixedStackObjectSlots.find(ID);
 512   if (ObjectInfo == PFS.FixedStackObjectSlots.end())
 513     return error(Twine("use of undefined fixed stack object '%fixed-stack.") +
 514                  Twine(ID) + "'");
 515   lex();
 516   Dest = MachineOperand::CreateFI(ObjectInfo->second);
 517   return false;
 518 }
 519
 520 bool MIParser::parseGlobalAddressOperand(MachineOperand &Dest) {
 521   switch (Token.kind()) {
 522   case MIToken::NamedGlobalValue:
 523   case MIToken::QuotedNamedGlobalValue: {
 524     StringValueUtility Name(Token);
 525     const Module *M = MF.getFunction()->getParent();
 526     if (const auto *GV = M->getNamedValue(Name)) {
 527       Dest = MachineOperand::CreateGA(GV, /*Offset=*/0);
 528       break;
 529     }
 530     return error(Twine("use of undefined global value '@") +
 531                  Token.rawStringValue() + "'");
 532   }
 533   case MIToken::GlobalValue: {
 534     unsigned GVIdx;
 535     if (getUnsigned(GVIdx))
 536       return true;
 537     if (GVIdx >= IRSlots.GlobalValues.size())
 538       return error(Twine("use of undefined global value '@") + Twine(GVIdx) +
 539                    "'");
 540     Dest = MachineOperand::CreateGA(IRSlots.GlobalValues[GVIdx],
 541                                     /*Offset=*/0);
 542     break;
 543   }
 544   default:
 545     llvm_unreachable("The current token should be a global value");
 546   }
 547   // TODO: Parse offset and target flags.
 548   lex();
 549   return false;
 550 }
 551
 552 bool MIParser::parseConstantPoolIndexOperand(MachineOperand &Dest) {
 553   assert(Token.is(MIToken::ConstantPoolItem));
 554   unsigned ID;
 555   if (getUnsigned(ID))
 556     return true;
 557   auto ConstantInfo = PFS.ConstantPoolSlots.find(ID);
 558   if (ConstantInfo == PFS.ConstantPoolSlots.end())
 559     return error("use of undefined constant '%const." + Twine(ID) + "'");
 560   lex();
 561   // TODO: Parse offset and target flags.
 562   Dest = MachineOperand::CreateCPI(ID, /*Offset=*/0);
 563   return false;
 564 }
 565
 566 bool MIParser::parseJumpTableIndexOperand(MachineOperand &Dest) {
 567   assert(Token.is(MIToken::JumpTableIndex));
 568   unsigned ID;
 569   if (getUnsigned(ID))
 570     return true;
 571   auto JumpTableEntryInfo = PFS.JumpTableSlots.find(ID);
 572   if (JumpTableEntryInfo == PFS.JumpTableSlots.end())
 573     return error("use of undefined jump table '%jump-table." + Twine(ID) + "'");
 574   lex();
 575   // TODO: Parse target flags.
 576   Dest = MachineOperand::CreateJTI(JumpTableEntryInfo->second);
 577   return false;
 578 }
 579
 580 bool MIParser::parseExternalSymbolOperand(MachineOperand &Dest) {
 581   assert(Token.is(MIToken::ExternalSymbol) ||
 582          Token.is(MIToken::QuotedExternalSymbol));
 583   StringValueUtility Name(Token);
 584   const char *Symbol = MF.createExternalSymbolName(Name);
 585   lex();
 586   // TODO: Parse the target flags.
 587   Dest = MachineOperand::CreateES(Symbol);
 588   return false;
 589 }
 590
 591 bool MIParser::parseMDNode(MDNode *&Node) {
 592   assert(Token.is(MIToken::exclaim));
 593   auto Loc = Token.location();
 594   lex();
 595   if (Token.isNot(MIToken::IntegerLiteral) || Token.integerValue().isSigned())
 596     return error("expected metadata id after '!'");
 597   unsigned ID;
 598   if (getUnsigned(ID))
 599     return true;
 600   auto NodeInfo = IRSlots.MetadataNodes.find(ID);
 601   if (NodeInfo == IRSlots.MetadataNodes.end())
 602     return error(Loc, "use of undefined metadata '!" + Twine(ID) + "'");
 603   lex();
 604   Node = NodeInfo->second.get();
 605   return false;
 606 }
 607
 608 bool MIParser::parseMetadataOperand(MachineOperand &Dest) {
 609   MDNode *Node = nullptr;
 610   if (parseMDNode(Node))
 611     return true;
 612   Dest = MachineOperand::CreateMetadata(Node);
 613   return false;
 614 }
 615
 616 bool MIParser::parseCFIOffset(int &Offset) {
 617   if (Token.isNot(MIToken::IntegerLiteral))
 618     return error("expected a cfi offset");
 619   if (Token.integerValue().getMinSignedBits() > 32)
 620     return error("expected a 32 bit integer (the cfi offset is too large)");
 621   Offset = (int)Token.integerValue().getExtValue();
 622   lex();
 623   return false;
 624 }
 625
 626 bool MIParser::parseCFIOperand(MachineOperand &Dest) {
 627   // TODO: Parse the other CFI operands.
 628   assert(Token.is(MIToken::kw_cfi_def_cfa_offset));
 629   lex();
 630   int Offset;
 631   if (parseCFIOffset(Offset))
 632     return true;
 633   // NB: MCCFIInstruction::createDefCfaOffset negates the offset.
 634   Dest = MachineOperand::CreateCFIIndex(MF.getMMI().addFrameInst(
 635       MCCFIInstruction::createDefCfaOffset(nullptr, -Offset)));
 636   return false;
 637 }
 638
 639 bool MIParser::parseMachineOperand(MachineOperand &Dest) {
 640   switch (Token.kind()) {
 641   case MIToken::kw_implicit:
 642   case MIToken::kw_implicit_define:
 643   case MIToken::kw_dead:
 644   case MIToken::kw_killed:
 645   case MIToken::kw_undef:
 646   case MIToken::underscore:
 647   case MIToken::NamedRegister:
 648   case MIToken::VirtualRegister:
 649     return parseRegisterOperand(Dest);
 650   case MIToken::IntegerLiteral:
 651     return parseImmediateOperand(Dest);
 652   case MIToken::MachineBasicBlock:
 653     return parseMBBOperand(Dest);
 654   case MIToken::StackObject:
 655     return parseStackObjectOperand(Dest);
 656   case MIToken::FixedStackObject:
 657     return parseFixedStackObjectOperand(Dest);
 658   case MIToken::GlobalValue:
 659   case MIToken::NamedGlobalValue:
 660   case MIToken::QuotedNamedGlobalValue:
 661     return parseGlobalAddressOperand(Dest);
 662   case MIToken::ConstantPoolItem:
 663     return parseConstantPoolIndexOperand(Dest);
 664   case MIToken::JumpTableIndex:
 665     return parseJumpTableIndexOperand(Dest);
 666   case MIToken::ExternalSymbol:
 667   case MIToken::QuotedExternalSymbol:
 668     return parseExternalSymbolOperand(Dest);
 669   case MIToken::exclaim:
 670     return parseMetadataOperand(Dest);
 671   case MIToken::kw_cfi_def_cfa_offset:
 672     return parseCFIOperand(Dest);
 673   case MIToken::Error:
 674     return true;
 675   case MIToken::Identifier:
 676     if (const auto *RegMask = getRegMask(Token.stringValue())) {
 677       Dest = MachineOperand::CreateRegMask(RegMask);
 678       lex();
 679       break;
 680     }
 681   // fallthrough
 682   default:
 683     // TODO: parse the other machine operands.
 684     return error("expected a machine operand");
 685   }
 686   return false;
 687 }
 688
 689 void MIParser::initNames2InstrOpCodes() {
 690   if (!Names2InstrOpCodes.empty())
 691     return;
 692   const auto *TII = MF.getSubtarget().getInstrInfo();
 693   assert(TII && "Expected target instruction info");
 694   for (unsigned I = 0, E = TII->getNumOpcodes(); I < E; ++I)
 695     Names2InstrOpCodes.insert(std::make_pair(StringRef(TII->getName(I)), I));
 696 }
 697
 698 bool MIParser::parseInstrName(StringRef InstrName, unsigned &OpCode) {
 699   initNames2InstrOpCodes();
 700   auto InstrInfo = Names2InstrOpCodes.find(InstrName);
 701   if (InstrInfo == Names2InstrOpCodes.end())
 702     return true;
 703   OpCode = InstrInfo->getValue();
 704   return false;
 705 }
 706
 707 void MIParser::initNames2Regs() {
 708   if (!Names2Regs.empty())
 709     return;
 710   // The '%noreg' register is the register 0.
 711   Names2Regs.insert(std::make_pair("noreg", 0));
 712   const auto *TRI = MF.getSubtarget().getRegisterInfo();
 713   assert(TRI && "Expected target register info");
 714   for (unsigned I = 0, E = TRI->getNumRegs(); I < E; ++I) {
 715     bool WasInserted =
 716         Names2Regs.insert(std::make_pair(StringRef(TRI->getName(I)).lower(), I))
 717             .second;
 718     (void)WasInserted;
 719     assert(WasInserted && "Expected registers to be unique case-insensitively");
 720   }
 721 }
 722
 723 bool MIParser::getRegisterByName(StringRef RegName, unsigned &Reg) {
 724   initNames2Regs();
 725   auto RegInfo = Names2Regs.find(RegName);
 726   if (RegInfo == Names2Regs.end())
 727     return true;
 728   Reg = RegInfo->getValue();
 729   return false;
 730 }
 731
 732 void MIParser::initNames2RegMasks() {
 733   if (!Names2RegMasks.empty())
 734     return;
 735   const auto *TRI = MF.getSubtarget().getRegisterInfo();
 736   assert(TRI && "Expected target register info");
 737   ArrayRef<const uint32_t *> RegMasks = TRI->getRegMasks();
 738   ArrayRef<const char *> RegMaskNames = TRI->getRegMaskNames();
 739   assert(RegMasks.size() == RegMaskNames.size());
 740   for (size_t I = 0, E = RegMasks.size(); I < E; ++I)
 741     Names2RegMasks.insert(
 742         std::make_pair(StringRef(RegMaskNames[I]).lower(), RegMasks[I]));
 743 }
 744
 745 const uint32_t *MIParser::getRegMask(StringRef Identifier) {
 746   initNames2RegMasks();
 747   auto RegMaskInfo = Names2RegMasks.find(Identifier);
 748   if (RegMaskInfo == Names2RegMasks.end())
 749     return nullptr;
 750   return RegMaskInfo->getValue();
 751 }
 752
 753 void MIParser::initNames2SubRegIndices() {
 754   if (!Names2SubRegIndices.empty())
 755     return;
 756   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
 757   for (unsigned I = 1, E = TRI->getNumSubRegIndices(); I < E; ++I)
 758     Names2SubRegIndices.insert(
 759         std::make_pair(StringRef(TRI->getSubRegIndexName(I)).lower(), I));
 760 }
 761
 762 unsigned MIParser::getSubRegIndex(StringRef Name) {
 763   initNames2SubRegIndices();
 764   auto SubRegInfo = Names2SubRegIndices.find(Name);
 765   if (SubRegInfo == Names2SubRegIndices.end())
 766     return 0;
 767   return SubRegInfo->getValue();
 768 }
 769
 770 bool llvm::parseMachineInstr(MachineInstr *&MI, SourceMgr &SM,
 771                              MachineFunction &MF, StringRef Src,
 772                              const PerFunctionMIParsingState &PFS,
 773                              const SlotMapping &IRSlots, SMDiagnostic &Error) {
 774   return MIParser(SM, MF, Error, Src, PFS, IRSlots).parse(MI);
 775 }
 776
 777 bool llvm::parseMBBReference(MachineBasicBlock *&MBB, SourceMgr &SM,
 778                              MachineFunction &MF, StringRef Src,
 779                              const PerFunctionMIParsingState &PFS,
 780                              const SlotMapping &IRSlots, SMDiagnostic &Error) {
 781   return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseMBB(MBB);
 782 }
 783
 784 bool llvm::parseNamedRegisterReference(unsigned &Reg, SourceMgr &SM,
 785                                        MachineFunction &MF, StringRef Src,
 786                                        const PerFunctionMIParsingState &PFS,
 787                                        const SlotMapping &IRSlots,
 788                                        SMDiagnostic &Error) {
 789   return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseNamedRegister(Reg);
 790 }