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/Constants.h"
  26 #include "llvm/IR/Module.h"
  27 #include "llvm/IR/ModuleSlotTracker.h"
  28 #include "llvm/IR/ValueSymbolTable.h"
  29 #include "llvm/Support/raw_ostream.h"
  30 #include "llvm/Support/SourceMgr.h"
  31 #include "llvm/Target/TargetSubtargetInfo.h"
  32 #include "llvm/Target/TargetInstrInfo.h"
  33
  34 using namespace llvm;
  35
  36 namespace {
  37
  38 struct StringValueUtility {
  39   StringRef String;
  40   std::string UnescapedString;
  41
  42   StringValueUtility(const MIToken &Token) {
  43     if (Token.isStringValueQuoted()) {
  44       Token.unescapeQuotedStringValue(UnescapedString);
  45       String = UnescapedString;
  46       return;
  47     }
  48     String = Token.stringValue();
  49   }
  50
  51   operator StringRef() const { return String; }
  52 };
  53
  54 /// A wrapper struct around the 'MachineOperand' struct that includes a source
  55 /// range.
  56 struct MachineOperandWithLocation {
  57   MachineOperand Operand;
  58   StringRef::iterator Begin;
  59   StringRef::iterator End;
  60
  61   MachineOperandWithLocation(const MachineOperand &Operand,
  62                              StringRef::iterator Begin, StringRef::iterator End)
  63       : Operand(Operand), Begin(Begin), End(End) {}
  64 };
  65
  66 class MIParser {
  67   SourceMgr &SM;
  68   MachineFunction &MF;
  69   SMDiagnostic &Error;
  70   StringRef Source, CurrentSource;
  71   MIToken Token;
  72   const PerFunctionMIParsingState &PFS;
  73   /// Maps from indices to unnamed global values and metadata nodes.
  74   const SlotMapping &IRSlots;
  75   /// Maps from instruction names to op codes.
  76   StringMap<unsigned> Names2InstrOpCodes;
  77   /// Maps from register names to registers.
  78   StringMap<unsigned> Names2Regs;
  79   /// Maps from register mask names to register masks.
  80   StringMap<const uint32_t *> Names2RegMasks;
  81   /// Maps from subregister names to subregister indices.
  82   StringMap<unsigned> Names2SubRegIndices;
  83   /// Maps from slot numbers to function's unnamed basic blocks.
  84   DenseMap<unsigned, const BasicBlock *> Slots2BasicBlocks;
  85
  86 public:
  87   MIParser(SourceMgr &SM, MachineFunction &MF, SMDiagnostic &Error,
  88            StringRef Source, const PerFunctionMIParsingState &PFS,
  89            const SlotMapping &IRSlots);
  90
  91   void lex();
  92
  93   /// Report an error at the current location with the given message.
  94   ///
  95   /// This function always return true.
  96   bool error(const Twine &Msg);
  97
  98   /// Report an error at the given location with the given message.
  99   ///
 100   /// This function always return true.
 101   bool error(StringRef::iterator Loc, const Twine &Msg);
 102
 103   bool parse(MachineInstr *&MI);
 104   bool parseStandaloneMBB(MachineBasicBlock *&MBB);
 105   bool parseStandaloneNamedRegister(unsigned &Reg);
 106   bool parseStandaloneVirtualRegister(unsigned &Reg);
 107   bool parseStandaloneIRBlockReference(const BasicBlock *&BB);
 108
 109   bool parseRegister(unsigned &Reg);
 110   bool parseRegisterFlag(unsigned &Flags);
 111   bool parseSubRegisterIndex(unsigned &SubReg);
 112   bool parseRegisterOperand(MachineOperand &Dest, bool IsDef = false);
 113   bool parseImmediateOperand(MachineOperand &Dest);
 114   bool parseMBBReference(MachineBasicBlock *&MBB);
 115   bool parseMBBOperand(MachineOperand &Dest);
 116   bool parseStackObjectOperand(MachineOperand &Dest);
 117   bool parseFixedStackObjectOperand(MachineOperand &Dest);
 118   bool parseGlobalValue(GlobalValue *&GV);
 119   bool parseGlobalAddressOperand(MachineOperand &Dest);
 120   bool parseConstantPoolIndexOperand(MachineOperand &Dest);
 121   bool parseJumpTableIndexOperand(MachineOperand &Dest);
 122   bool parseExternalSymbolOperand(MachineOperand &Dest);
 123   bool parseMDNode(MDNode *&Node);
 124   bool parseMetadataOperand(MachineOperand &Dest);
 125   bool parseCFIOffset(int &Offset);
 126   bool parseCFIRegister(unsigned &Reg);
 127   bool parseCFIOperand(MachineOperand &Dest);
 128   bool parseIRBlock(BasicBlock *&BB, const Function &F);
 129   bool parseBlockAddressOperand(MachineOperand &Dest);
 130   bool parseMachineOperand(MachineOperand &Dest);
 131
 132 private:
 133   /// Convert the integer literal in the current token into an unsigned integer.
 134   ///
 135   /// Return true if an error occurred.
 136   bool getUnsigned(unsigned &Result);
 137
 138   /// If the current token is of the given kind, consume it and return false.
 139   /// Otherwise report an error and return true.
 140   bool expectAndConsume(MIToken::TokenKind TokenKind);
 141
 142   void initNames2InstrOpCodes();
 143
 144   /// Try to convert an instruction name to an opcode. Return true if the
 145   /// instruction name is invalid.
 146   bool parseInstrName(StringRef InstrName, unsigned &OpCode);
 147
 148   bool parseInstruction(unsigned &OpCode, unsigned &Flags);
 149
 150   bool verifyImplicitOperands(ArrayRef<MachineOperandWithLocation> Operands,
 151                               const MCInstrDesc &MCID);
 152
 153   void initNames2Regs();
 154
 155   /// Try to convert a register name to a register number. Return true if the
 156   /// register name is invalid.
 157   bool getRegisterByName(StringRef RegName, unsigned &Reg);
 158
 159   void initNames2RegMasks();
 160
 161   /// Check if the given identifier is a name of a register mask.
 162   ///
 163   /// Return null if the identifier isn't a register mask.
 164   const uint32_t *getRegMask(StringRef Identifier);
 165
 166   void initNames2SubRegIndices();
 167
 168   /// Check if the given identifier is a name of a subregister index.
 169   ///
 170   /// Return 0 if the name isn't a subregister index class.
 171   unsigned getSubRegIndex(StringRef Name);
 172
 173   void initSlots2BasicBlocks();
 174
 175   const BasicBlock *getIRBlock(unsigned Slot);
 176 };
 177
 178 } // end anonymous namespace
 179
 180 MIParser::MIParser(SourceMgr &SM, MachineFunction &MF, SMDiagnostic &Error,
 181                    StringRef Source, const PerFunctionMIParsingState &PFS,
 182                    const SlotMapping &IRSlots)
 183     : SM(SM), MF(MF), Error(Error), Source(Source), CurrentSource(Source),
 184       Token(MIToken::Error, StringRef()), PFS(PFS), IRSlots(IRSlots) {}
 185
 186 void MIParser::lex() {
 187   CurrentSource = lexMIToken(
 188       CurrentSource, Token,
 189       [this](StringRef::iterator Loc, const Twine &Msg) { error(Loc, Msg); });
 190 }
 191
 192 bool MIParser::error(const Twine &Msg) { return error(Token.location(), Msg); }
 193
 194 bool MIParser::error(StringRef::iterator Loc, const Twine &Msg) {
 195   assert(Loc >= Source.data() && Loc <= (Source.data() + Source.size()));
 196   Error = SMDiagnostic(
 197       SM, SMLoc(),
 198       SM.getMemoryBuffer(SM.getMainFileID())->getBufferIdentifier(), 1,
 199       Loc - Source.data(), SourceMgr::DK_Error, Msg.str(), Source, None, None);
 200   return true;
 201 }
 202
 203 static const char *toString(MIToken::TokenKind TokenKind) {
 204   switch (TokenKind) {
 205   case MIToken::comma:
 206     return "','";
 207   case MIToken::lparen:
 208     return "'('";
 209   case MIToken::rparen:
 210     return "')'";
 211   default:
 212     return "<unknown token>";
 213   }
 214 }
 215
 216 bool MIParser::expectAndConsume(MIToken::TokenKind TokenKind) {
 217   if (Token.isNot(TokenKind))
 218     return error(Twine("expected ") + toString(TokenKind));
 219   lex();
 220   return false;
 221 }
 222
 223 bool MIParser::parse(MachineInstr *&MI) {
 224   lex();
 225
 226   // Parse any register operands before '='
 227   // TODO: Allow parsing of multiple operands before '='
 228   MachineOperand MO = MachineOperand::CreateImm(0);
 229   SmallVector<MachineOperandWithLocation, 8> Operands;
 230   if (Token.isRegister() || Token.isRegisterFlag()) {
 231     auto Loc = Token.location();
 232     if (parseRegisterOperand(MO, /*IsDef=*/true))
 233       return true;
 234     Operands.push_back(MachineOperandWithLocation(MO, Loc, Token.location()));
 235     if (Token.isNot(MIToken::equal))
 236       return error("expected '='");
 237     lex();
 238   }
 239
 240   unsigned OpCode, Flags = 0;
 241   if (Token.isError() || parseInstruction(OpCode, Flags))
 242     return true;
 243
 244   // TODO: Parse the bundle instruction flags and memory operands.
 245
 246   // Parse the remaining machine operands.
 247   while (Token.isNot(MIToken::Eof) && Token.isNot(MIToken::kw_debug_location)) {
 248     auto Loc = Token.location();
 249     if (parseMachineOperand(MO))
 250       return true;
 251     Operands.push_back(MachineOperandWithLocation(MO, Loc, Token.location()));
 252     if (Token.is(MIToken::Eof))
 253       break;
 254     if (Token.isNot(MIToken::comma))
 255       return error("expected ',' before the next machine operand");
 256     lex();
 257   }
 258
 259   DebugLoc DebugLocation;
 260   if (Token.is(MIToken::kw_debug_location)) {
 261     lex();
 262     if (Token.isNot(MIToken::exclaim))
 263       return error("expected a metadata node after 'debug-location'");
 264     MDNode *Node = nullptr;
 265     if (parseMDNode(Node))
 266       return true;
 267     DebugLocation = DebugLoc(Node);
 268   }
 269
 270   const auto &MCID = MF.getSubtarget().getInstrInfo()->get(OpCode);
 271   if (!MCID.isVariadic()) {
 272     // FIXME: Move the implicit operand verification to the machine verifier.
 273     if (verifyImplicitOperands(Operands, MCID))
 274       return true;
 275   }
 276
 277   // TODO: Check for extraneous machine operands.
 278   MI = MF.CreateMachineInstr(MCID, DebugLocation, /*NoImplicit=*/true);
 279   MI->setFlags(Flags);
 280   for (const auto &Operand : Operands)
 281     MI->addOperand(MF, Operand.Operand);
 282   return false;
 283 }
 284
 285 bool MIParser::parseStandaloneMBB(MachineBasicBlock *&MBB) {
 286   lex();
 287   if (Token.isNot(MIToken::MachineBasicBlock))
 288     return error("expected a machine basic block reference");
 289   if (parseMBBReference(MBB))
 290     return true;
 291   lex();
 292   if (Token.isNot(MIToken::Eof))
 293     return error(
 294         "expected end of string after the machine basic block reference");
 295   return false;
 296 }
 297
 298 bool MIParser::parseStandaloneNamedRegister(unsigned &Reg) {
 299   lex();
 300   if (Token.isNot(MIToken::NamedRegister))
 301     return error("expected a named register");
 302   if (parseRegister(Reg))
 303     return 0;
 304   lex();
 305   if (Token.isNot(MIToken::Eof))
 306     return error("expected end of string after the register reference");
 307   return false;
 308 }
 309
 310 bool MIParser::parseStandaloneVirtualRegister(unsigned &Reg) {
 311   lex();
 312   if (Token.isNot(MIToken::VirtualRegister))
 313     return error("expected a virtual register");
 314   if (parseRegister(Reg))
 315     return 0;
 316   lex();
 317   if (Token.isNot(MIToken::Eof))
 318     return error("expected end of string after the register reference");
 319   return false;
 320 }
 321
 322 bool MIParser::parseStandaloneIRBlockReference(const BasicBlock *&BB) {
 323   lex();
 324   if (Token.isNot(MIToken::IRBlock))
 325     return error("expected an IR block reference");
 326   unsigned SlotNumber = 0;
 327   if (getUnsigned(SlotNumber))
 328     return true;
 329   BB = getIRBlock(SlotNumber);
 330   if (!BB)
 331     return error(Twine("use of undefined IR block '%ir-block.") +
 332                  Twine(SlotNumber) + "'");
 333   lex();
 334   if (Token.isNot(MIToken::Eof))
 335     return error("expected end of string after the IR block reference");
 336   return false;
 337 }
 338
 339 static const char *printImplicitRegisterFlag(const MachineOperand &MO) {
 340   assert(MO.isImplicit());
 341   return MO.isDef() ? "implicit-def" : "implicit";
 342 }
 343
 344 static std::string getRegisterName(const TargetRegisterInfo *TRI,
 345                                    unsigned Reg) {
 346   assert(TargetRegisterInfo::isPhysicalRegister(Reg) && "expected phys reg");
 347   return StringRef(TRI->getName(Reg)).lower();
 348 }
 349
 350 bool MIParser::verifyImplicitOperands(
 351     ArrayRef<MachineOperandWithLocation> Operands, const MCInstrDesc &MCID) {
 352   if (MCID.isCall())
 353     // We can't verify call instructions as they can contain arbitrary implicit
 354     // register and register mask operands.
 355     return false;
 356
 357   // Gather all the expected implicit operands.
 358   SmallVector<MachineOperand, 4> ImplicitOperands;
 359   if (MCID.ImplicitDefs)
 360     for (const uint16_t *ImpDefs = MCID.getImplicitDefs(); *ImpDefs; ++ImpDefs)
 361       ImplicitOperands.push_back(
 362           MachineOperand::CreateReg(*ImpDefs, true, true));
 363   if (MCID.ImplicitUses)
 364     for (const uint16_t *ImpUses = MCID.getImplicitUses(); *ImpUses; ++ImpUses)
 365       ImplicitOperands.push_back(
 366           MachineOperand::CreateReg(*ImpUses, false, true));
 367
 368   const auto *TRI = MF.getSubtarget().getRegisterInfo();
 369   assert(TRI && "Expected target register info");
 370   size_t I = ImplicitOperands.size(), J = Operands.size();
 371   while (I) {
 372     --I;
 373     if (J) {
 374       --J;
 375       const auto &ImplicitOperand = ImplicitOperands[I];
 376       const auto &Operand = Operands[J].Operand;
 377       if (ImplicitOperand.isIdenticalTo(Operand))
 378         continue;
 379       if (Operand.isReg() && Operand.isImplicit()) {
 380         return error(Operands[J].Begin,
 381                      Twine("expected an implicit register operand '") +
 382                          printImplicitRegisterFlag(ImplicitOperand) + " %" +
 383                          getRegisterName(TRI, ImplicitOperand.getReg()) + "'");
 384       }
 385     }
 386     // TODO: Fix source location when Operands[J].end is right before '=', i.e:
 387     // insead of reporting an error at this location:
 388     //            %eax = MOV32r0
 389     //                 ^
 390     // report the error at the following location:
 391     //            %eax = MOV32r0
 392     //                          ^
 393     return error(J < Operands.size() ? Operands[J].End : Token.location(),
 394                  Twine("missing implicit register operand '") +
 395                      printImplicitRegisterFlag(ImplicitOperands[I]) + " %" +
 396                      getRegisterName(TRI, ImplicitOperands[I].getReg()) + "'");
 397   }
 398   return false;
 399 }
 400
 401 bool MIParser::parseInstruction(unsigned &OpCode, unsigned &Flags) {
 402   if (Token.is(MIToken::kw_frame_setup)) {
 403     Flags |= MachineInstr::FrameSetup;
 404     lex();
 405   }
 406   if (Token.isNot(MIToken::Identifier))
 407     return error("expected a machine instruction");
 408   StringRef InstrName = Token.stringValue();
 409   if (parseInstrName(InstrName, OpCode))
 410     return error(Twine("unknown machine instruction name '") + InstrName + "'");
 411   lex();
 412   return false;
 413 }
 414
 415 bool MIParser::parseRegister(unsigned &Reg) {
 416   switch (Token.kind()) {
 417   case MIToken::underscore:
 418     Reg = 0;
 419     break;
 420   case MIToken::NamedRegister: {
 421     StringRef Name = Token.stringValue();
 422     if (getRegisterByName(Name, Reg))
 423       return error(Twine("unknown register name '") + Name + "'");
 424     break;
 425   }
 426   case MIToken::VirtualRegister: {
 427     unsigned ID;
 428     if (getUnsigned(ID))
 429       return true;
 430     const auto RegInfo = PFS.VirtualRegisterSlots.find(ID);
 431     if (RegInfo == PFS.VirtualRegisterSlots.end())
 432       return error(Twine("use of undefined virtual register '%") + Twine(ID) +
 433                    "'");
 434     Reg = RegInfo->second;
 435     break;
 436   }
 437   // TODO: Parse other register kinds.
 438   default:
 439     llvm_unreachable("The current token should be a register");
 440   }
 441   return false;
 442 }
 443
 444 bool MIParser::parseRegisterFlag(unsigned &Flags) {
 445   switch (Token.kind()) {
 446   case MIToken::kw_implicit:
 447     Flags |= RegState::Implicit;
 448     break;
 449   case MIToken::kw_implicit_define:
 450     Flags |= RegState::ImplicitDefine;
 451     break;
 452   case MIToken::kw_dead:
 453     Flags |= RegState::Dead;
 454     break;
 455   case MIToken::kw_killed:
 456     Flags |= RegState::Kill;
 457     break;
 458   case MIToken::kw_undef:
 459     Flags |= RegState::Undef;
 460     break;
 461   // TODO: report an error when we specify the same flag more than once.
 462   // TODO: parse the other register flags.
 463   default:
 464     llvm_unreachable("The current token should be a register flag");
 465   }
 466   lex();
 467   return false;
 468 }
 469
 470 bool MIParser::parseSubRegisterIndex(unsigned &SubReg) {
 471   assert(Token.is(MIToken::colon));
 472   lex();
 473   if (Token.isNot(MIToken::Identifier))
 474     return error("expected a subregister index after ':'");
 475   auto Name = Token.stringValue();
 476   SubReg = getSubRegIndex(Name);
 477   if (!SubReg)
 478     return error(Twine("use of unknown subregister index '") + Name + "'");
 479   lex();
 480   return false;
 481 }
 482
 483 bool MIParser::parseRegisterOperand(MachineOperand &Dest, bool IsDef) {
 484   unsigned Reg;
 485   unsigned Flags = IsDef ? RegState::Define : 0;
 486   while (Token.isRegisterFlag()) {
 487     if (parseRegisterFlag(Flags))
 488       return true;
 489   }
 490   if (!Token.isRegister())
 491     return error("expected a register after register flags");
 492   if (parseRegister(Reg))
 493     return true;
 494   lex();
 495   unsigned SubReg = 0;
 496   if (Token.is(MIToken::colon)) {
 497     if (parseSubRegisterIndex(SubReg))
 498       return true;
 499   }
 500   Dest = MachineOperand::CreateReg(
 501       Reg, Flags & RegState::Define, Flags & RegState::Implicit,
 502       Flags & RegState::Kill, Flags & RegState::Dead, Flags & RegState::Undef,
 503       /*isEarlyClobber=*/false, SubReg);
 504   return false;
 505 }
 506
 507 bool MIParser::parseImmediateOperand(MachineOperand &Dest) {
 508   assert(Token.is(MIToken::IntegerLiteral));
 509   const APSInt &Int = Token.integerValue();
 510   if (Int.getMinSignedBits() > 64)
 511     // TODO: Replace this with an error when we can parse CIMM Machine Operands.
 512     llvm_unreachable("Can't parse large integer literals yet!");
 513   Dest = MachineOperand::CreateImm(Int.getExtValue());
 514   lex();
 515   return false;
 516 }
 517
 518 bool MIParser::getUnsigned(unsigned &Result) {
 519   assert(Token.hasIntegerValue() && "Expected a token with an integer value");
 520   const uint64_t Limit = uint64_t(std::numeric_limits<unsigned>::max()) + 1;
 521   uint64_t Val64 = Token.integerValue().getLimitedValue(Limit);
 522   if (Val64 == Limit)
 523     return error("expected 32-bit integer (too large)");
 524   Result = Val64;
 525   return false;
 526 }
 527
 528 bool MIParser::parseMBBReference(MachineBasicBlock *&MBB) {
 529   assert(Token.is(MIToken::MachineBasicBlock));
 530   unsigned Number;
 531   if (getUnsigned(Number))
 532     return true;
 533   auto MBBInfo = PFS.MBBSlots.find(Number);
 534   if (MBBInfo == PFS.MBBSlots.end())
 535     return error(Twine("use of undefined machine basic block #") +
 536                  Twine(Number));
 537   MBB = MBBInfo->second;
 538   if (!Token.stringValue().empty() && Token.stringValue() != MBB->getName())
 539     return error(Twine("the name of machine basic block #") + Twine(Number) +
 540                  " isn't '" + Token.stringValue() + "'");
 541   return false;
 542 }
 543
 544 bool MIParser::parseMBBOperand(MachineOperand &Dest) {
 545   MachineBasicBlock *MBB;
 546   if (parseMBBReference(MBB))
 547     return true;
 548   Dest = MachineOperand::CreateMBB(MBB);
 549   lex();
 550   return false;
 551 }
 552
 553 bool MIParser::parseStackObjectOperand(MachineOperand &Dest) {
 554   assert(Token.is(MIToken::StackObject));
 555   unsigned ID;
 556   if (getUnsigned(ID))
 557     return true;
 558   auto ObjectInfo = PFS.StackObjectSlots.find(ID);
 559   if (ObjectInfo == PFS.StackObjectSlots.end())
 560     return error(Twine("use of undefined stack object '%stack.") + Twine(ID) +
 561                  "'");
 562   StringRef Name;
 563   if (const auto *Alloca =
 564           MF.getFrameInfo()->getObjectAllocation(ObjectInfo->second))
 565     Name = Alloca->getName();
 566   if (!Token.stringValue().empty() && Token.stringValue() != Name)
 567     return error(Twine("the name of the stack object '%stack.") + Twine(ID) +
 568                  "' isn't '" + Token.stringValue() + "'");
 569   lex();
 570   Dest = MachineOperand::CreateFI(ObjectInfo->second);
 571   return false;
 572 }
 573
 574 bool MIParser::parseFixedStackObjectOperand(MachineOperand &Dest) {
 575   assert(Token.is(MIToken::FixedStackObject));
 576   unsigned ID;
 577   if (getUnsigned(ID))
 578     return true;
 579   auto ObjectInfo = PFS.FixedStackObjectSlots.find(ID);
 580   if (ObjectInfo == PFS.FixedStackObjectSlots.end())
 581     return error(Twine("use of undefined fixed stack object '%fixed-stack.") +
 582                  Twine(ID) + "'");
 583   lex();
 584   Dest = MachineOperand::CreateFI(ObjectInfo->second);
 585   return false;
 586 }
 587
 588 bool MIParser::parseGlobalValue(GlobalValue *&GV) {
 589   switch (Token.kind()) {
 590   case MIToken::NamedGlobalValue:
 591   case MIToken::QuotedNamedGlobalValue: {
 592     StringValueUtility Name(Token);
 593     const Module *M = MF.getFunction()->getParent();
 594     GV = M->getNamedValue(Name);
 595     if (!GV)
 596       return error(Twine("use of undefined global value '@") +
 597                    Token.rawStringValue() + "'");
 598     break;
 599   }
 600   case MIToken::GlobalValue: {
 601     unsigned GVIdx;
 602     if (getUnsigned(GVIdx))
 603       return true;
 604     if (GVIdx >= IRSlots.GlobalValues.size())
 605       return error(Twine("use of undefined global value '@") + Twine(GVIdx) +
 606                    "'");
 607     GV = IRSlots.GlobalValues[GVIdx];
 608     break;
 609   }
 610   default:
 611     llvm_unreachable("The current token should be a global value");
 612   }
 613   return false;
 614 }
 615
 616 bool MIParser::parseGlobalAddressOperand(MachineOperand &Dest) {
 617   GlobalValue *GV = nullptr;
 618   if (parseGlobalValue(GV))
 619     return true;
 620   Dest = MachineOperand::CreateGA(GV, /*Offset=*/0);
 621   // TODO: Parse offset and target flags.
 622   lex();
 623   return false;
 624 }
 625
 626 bool MIParser::parseConstantPoolIndexOperand(MachineOperand &Dest) {
 627   assert(Token.is(MIToken::ConstantPoolItem));
 628   unsigned ID;
 629   if (getUnsigned(ID))
 630     return true;
 631   auto ConstantInfo = PFS.ConstantPoolSlots.find(ID);
 632   if (ConstantInfo == PFS.ConstantPoolSlots.end())
 633     return error("use of undefined constant '%const." + Twine(ID) + "'");
 634   lex();
 635   // TODO: Parse offset and target flags.
 636   Dest = MachineOperand::CreateCPI(ID, /*Offset=*/0);
 637   return false;
 638 }
 639
 640 bool MIParser::parseJumpTableIndexOperand(MachineOperand &Dest) {
 641   assert(Token.is(MIToken::JumpTableIndex));
 642   unsigned ID;
 643   if (getUnsigned(ID))
 644     return true;
 645   auto JumpTableEntryInfo = PFS.JumpTableSlots.find(ID);
 646   if (JumpTableEntryInfo == PFS.JumpTableSlots.end())
 647     return error("use of undefined jump table '%jump-table." + Twine(ID) + "'");
 648   lex();
 649   // TODO: Parse target flags.
 650   Dest = MachineOperand::CreateJTI(JumpTableEntryInfo->second);
 651   return false;
 652 }
 653
 654 bool MIParser::parseExternalSymbolOperand(MachineOperand &Dest) {
 655   assert(Token.is(MIToken::ExternalSymbol) ||
 656          Token.is(MIToken::QuotedExternalSymbol));
 657   StringValueUtility Name(Token);
 658   const char *Symbol = MF.createExternalSymbolName(Name);
 659   lex();
 660   // TODO: Parse the target flags.
 661   Dest = MachineOperand::CreateES(Symbol);
 662   return false;
 663 }
 664
 665 bool MIParser::parseMDNode(MDNode *&Node) {
 666   assert(Token.is(MIToken::exclaim));
 667   auto Loc = Token.location();
 668   lex();
 669   if (Token.isNot(MIToken::IntegerLiteral) || Token.integerValue().isSigned())
 670     return error("expected metadata id after '!'");
 671   unsigned ID;
 672   if (getUnsigned(ID))
 673     return true;
 674   auto NodeInfo = IRSlots.MetadataNodes.find(ID);
 675   if (NodeInfo == IRSlots.MetadataNodes.end())
 676     return error(Loc, "use of undefined metadata '!" + Twine(ID) + "'");
 677   lex();
 678   Node = NodeInfo->second.get();
 679   return false;
 680 }
 681
 682 bool MIParser::parseMetadataOperand(MachineOperand &Dest) {
 683   MDNode *Node = nullptr;
 684   if (parseMDNode(Node))
 685     return true;
 686   Dest = MachineOperand::CreateMetadata(Node);
 687   return false;
 688 }
 689
 690 bool MIParser::parseCFIOffset(int &Offset) {
 691   if (Token.isNot(MIToken::IntegerLiteral))
 692     return error("expected a cfi offset");
 693   if (Token.integerValue().getMinSignedBits() > 32)
 694     return error("expected a 32 bit integer (the cfi offset is too large)");
 695   Offset = (int)Token.integerValue().getExtValue();
 696   lex();
 697   return false;
 698 }
 699
 700 bool MIParser::parseCFIRegister(unsigned &Reg) {
 701   if (Token.isNot(MIToken::NamedRegister))
 702     return error("expected a cfi register");
 703   unsigned LLVMReg;
 704   if (parseRegister(LLVMReg))
 705     return true;
 706   const auto *TRI = MF.getSubtarget().getRegisterInfo();
 707   assert(TRI && "Expected target register info");
 708   int DwarfReg = TRI->getDwarfRegNum(LLVMReg, true);
 709   if (DwarfReg < 0)
 710     return error("invalid DWARF register");
 711   Reg = (unsigned)DwarfReg;
 712   lex();
 713   return false;
 714 }
 715
 716 bool MIParser::parseCFIOperand(MachineOperand &Dest) {
 717   auto Kind = Token.kind();
 718   lex();
 719   auto &MMI = MF.getMMI();
 720   int Offset;
 721   unsigned Reg;
 722   unsigned CFIIndex;
 723   switch (Kind) {
 724   case MIToken::kw_cfi_offset:
 725     if (parseCFIRegister(Reg) || expectAndConsume(MIToken::comma) ||
 726         parseCFIOffset(Offset))
 727       return true;
 728     CFIIndex =
 729         MMI.addFrameInst(MCCFIInstruction::createOffset(nullptr, Reg, Offset));
 730     break;
 731   case MIToken::kw_cfi_def_cfa_register:
 732     if (parseCFIRegister(Reg))
 733       return true;
 734     CFIIndex =
 735         MMI.addFrameInst(MCCFIInstruction::createDefCfaRegister(nullptr, Reg));
 736     break;
 737   case MIToken::kw_cfi_def_cfa_offset:
 738     if (parseCFIOffset(Offset))
 739       return true;
 740     // NB: MCCFIInstruction::createDefCfaOffset negates the offset.
 741     CFIIndex = MMI.addFrameInst(
 742         MCCFIInstruction::createDefCfaOffset(nullptr, -Offset));
 743     break;
 744   default:
 745     // TODO: Parse the other CFI operands.
 746     llvm_unreachable("The current token should be a cfi operand");
 747   }
 748   Dest = MachineOperand::CreateCFIIndex(CFIIndex);
 749   return false;
 750 }
 751
 752 bool MIParser::parseIRBlock(BasicBlock *&BB, const Function &F) {
 753   switch (Token.kind()) {
 754   case MIToken::NamedIRBlock:
 755   case MIToken::QuotedNamedIRBlock: {
 756     StringValueUtility Name(Token);
 757     BB = dyn_cast_or_null<BasicBlock>(F.getValueSymbolTable().lookup(Name));
 758     if (!BB)
 759       return error(Twine("use of undefined IR block '%ir-block.") +
 760                    Token.rawStringValue() + "'");
 761     break;
 762   }
 763   case MIToken::IRBlock: {
 764     unsigned SlotNumber = 0;
 765     if (getUnsigned(SlotNumber))
 766       return true;
 767     BB = const_cast<BasicBlock *>(getIRBlock(SlotNumber));
 768     if (!BB)
 769       return error(Twine("use of undefined IR block '%ir-block.") +
 770                    Twine(SlotNumber) + "'");
 771     break;
 772   }
 773   default:
 774     llvm_unreachable("The current token should be an IR block reference");
 775   }
 776   return false;
 777 }
 778
 779 bool MIParser::parseBlockAddressOperand(MachineOperand &Dest) {
 780   assert(Token.is(MIToken::kw_blockaddress));
 781   lex();
 782   if (expectAndConsume(MIToken::lparen))
 783     return true;
 784   if (Token.isNot(MIToken::GlobalValue) &&
 785       Token.isNot(MIToken::NamedGlobalValue) &&
 786       Token.isNot(MIToken::QuotedNamedGlobalValue))
 787     return error("expected a global value");
 788   GlobalValue *GV = nullptr;
 789   if (parseGlobalValue(GV))
 790     return true;
 791   auto *F = dyn_cast<Function>(GV);
 792   if (!F)
 793     return error("expected an IR function reference");
 794   lex();
 795   if (expectAndConsume(MIToken::comma))
 796     return true;
 797   BasicBlock *BB = nullptr;
 798   if (Token.isNot(MIToken::IRBlock) && Token.isNot(MIToken::NamedIRBlock) &&
 799       Token.isNot(MIToken::QuotedNamedIRBlock))
 800     return error("expected an IR block reference");
 801   if (parseIRBlock(BB, *F))
 802     return true;
 803   lex();
 804   if (expectAndConsume(MIToken::rparen))
 805     return true;
 806   // TODO: parse offset and target flags.
 807   Dest = MachineOperand::CreateBA(BlockAddress::get(F, BB), /*Offset=*/0);
 808   return false;
 809 }
 810
 811 bool MIParser::parseMachineOperand(MachineOperand &Dest) {
 812   switch (Token.kind()) {
 813   case MIToken::kw_implicit:
 814   case MIToken::kw_implicit_define:
 815   case MIToken::kw_dead:
 816   case MIToken::kw_killed:
 817   case MIToken::kw_undef:
 818   case MIToken::underscore:
 819   case MIToken::NamedRegister:
 820   case MIToken::VirtualRegister:
 821     return parseRegisterOperand(Dest);
 822   case MIToken::IntegerLiteral:
 823     return parseImmediateOperand(Dest);
 824   case MIToken::MachineBasicBlock:
 825     return parseMBBOperand(Dest);
 826   case MIToken::StackObject:
 827     return parseStackObjectOperand(Dest);
 828   case MIToken::FixedStackObject:
 829     return parseFixedStackObjectOperand(Dest);
 830   case MIToken::GlobalValue:
 831   case MIToken::NamedGlobalValue:
 832   case MIToken::QuotedNamedGlobalValue:
 833     return parseGlobalAddressOperand(Dest);
 834   case MIToken::ConstantPoolItem:
 835     return parseConstantPoolIndexOperand(Dest);
 836   case MIToken::JumpTableIndex:
 837     return parseJumpTableIndexOperand(Dest);
 838   case MIToken::ExternalSymbol:
 839   case MIToken::QuotedExternalSymbol:
 840     return parseExternalSymbolOperand(Dest);
 841   case MIToken::exclaim:
 842     return parseMetadataOperand(Dest);
 843   case MIToken::kw_cfi_offset:
 844   case MIToken::kw_cfi_def_cfa_register:
 845   case MIToken::kw_cfi_def_cfa_offset:
 846     return parseCFIOperand(Dest);
 847   case MIToken::kw_blockaddress:
 848     return parseBlockAddressOperand(Dest);
 849   case MIToken::Error:
 850     return true;
 851   case MIToken::Identifier:
 852     if (const auto *RegMask = getRegMask(Token.stringValue())) {
 853       Dest = MachineOperand::CreateRegMask(RegMask);
 854       lex();
 855       break;
 856     }
 857   // fallthrough
 858   default:
 859     // TODO: parse the other machine operands.
 860     return error("expected a machine operand");
 861   }
 862   return false;
 863 }
 864
 865 void MIParser::initNames2InstrOpCodes() {
 866   if (!Names2InstrOpCodes.empty())
 867     return;
 868   const auto *TII = MF.getSubtarget().getInstrInfo();
 869   assert(TII && "Expected target instruction info");
 870   for (unsigned I = 0, E = TII->getNumOpcodes(); I < E; ++I)
 871     Names2InstrOpCodes.insert(std::make_pair(StringRef(TII->getName(I)), I));
 872 }
 873
 874 bool MIParser::parseInstrName(StringRef InstrName, unsigned &OpCode) {
 875   initNames2InstrOpCodes();
 876   auto InstrInfo = Names2InstrOpCodes.find(InstrName);
 877   if (InstrInfo == Names2InstrOpCodes.end())
 878     return true;
 879   OpCode = InstrInfo->getValue();
 880   return false;
 881 }
 882
 883 void MIParser::initNames2Regs() {
 884   if (!Names2Regs.empty())
 885     return;
 886   // The '%noreg' register is the register 0.
 887   Names2Regs.insert(std::make_pair("noreg", 0));
 888   const auto *TRI = MF.getSubtarget().getRegisterInfo();
 889   assert(TRI && "Expected target register info");
 890   for (unsigned I = 0, E = TRI->getNumRegs(); I < E; ++I) {
 891     bool WasInserted =
 892         Names2Regs.insert(std::make_pair(StringRef(TRI->getName(I)).lower(), I))
 893             .second;
 894     (void)WasInserted;
 895     assert(WasInserted && "Expected registers to be unique case-insensitively");
 896   }
 897 }
 898
 899 bool MIParser::getRegisterByName(StringRef RegName, unsigned &Reg) {
 900   initNames2Regs();
 901   auto RegInfo = Names2Regs.find(RegName);
 902   if (RegInfo == Names2Regs.end())
 903     return true;
 904   Reg = RegInfo->getValue();
 905   return false;
 906 }
 907
 908 void MIParser::initNames2RegMasks() {
 909   if (!Names2RegMasks.empty())
 910     return;
 911   const auto *TRI = MF.getSubtarget().getRegisterInfo();
 912   assert(TRI && "Expected target register info");
 913   ArrayRef<const uint32_t *> RegMasks = TRI->getRegMasks();
 914   ArrayRef<const char *> RegMaskNames = TRI->getRegMaskNames();
 915   assert(RegMasks.size() == RegMaskNames.size());
 916   for (size_t I = 0, E = RegMasks.size(); I < E; ++I)
 917     Names2RegMasks.insert(
 918         std::make_pair(StringRef(RegMaskNames[I]).lower(), RegMasks[I]));
 919 }
 920
 921 const uint32_t *MIParser::getRegMask(StringRef Identifier) {
 922   initNames2RegMasks();
 923   auto RegMaskInfo = Names2RegMasks.find(Identifier);
 924   if (RegMaskInfo == Names2RegMasks.end())
 925     return nullptr;
 926   return RegMaskInfo->getValue();
 927 }
 928
 929 void MIParser::initNames2SubRegIndices() {
 930   if (!Names2SubRegIndices.empty())
 931     return;
 932   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
 933   for (unsigned I = 1, E = TRI->getNumSubRegIndices(); I < E; ++I)
 934     Names2SubRegIndices.insert(
 935         std::make_pair(StringRef(TRI->getSubRegIndexName(I)).lower(), I));
 936 }
 937
 938 unsigned MIParser::getSubRegIndex(StringRef Name) {
 939   initNames2SubRegIndices();
 940   auto SubRegInfo = Names2SubRegIndices.find(Name);
 941   if (SubRegInfo == Names2SubRegIndices.end())
 942     return 0;
 943   return SubRegInfo->getValue();
 944 }
 945
 946 void MIParser::initSlots2BasicBlocks() {
 947   if (!Slots2BasicBlocks.empty())
 948     return;
 949   const auto &F = *MF.getFunction();
 950   ModuleSlotTracker MST(F.getParent());
 951   MST.incorporateFunction(F);
 952   for (auto &BB : F) {
 953     if (BB.hasName())
 954       continue;
 955     int Slot = MST.getLocalSlot(&BB);
 956     if (Slot == -1)
 957       continue;
 958     Slots2BasicBlocks.insert(std::make_pair(unsigned(Slot), &BB));
 959   }
 960 }
 961
 962 const BasicBlock *MIParser::getIRBlock(unsigned Slot) {
 963   initSlots2BasicBlocks();
 964   auto BlockInfo = Slots2BasicBlocks.find(Slot);
 965   if (BlockInfo == Slots2BasicBlocks.end())
 966     return nullptr;
 967   return BlockInfo->second;
 968 }
 969
 970 bool llvm::parseMachineInstr(MachineInstr *&MI, SourceMgr &SM,
 971                              MachineFunction &MF, StringRef Src,
 972                              const PerFunctionMIParsingState &PFS,
 973                              const SlotMapping &IRSlots, SMDiagnostic &Error) {
 974   return MIParser(SM, MF, Error, Src, PFS, IRSlots).parse(MI);
 975 }
 976
 977 bool llvm::parseMBBReference(MachineBasicBlock *&MBB, SourceMgr &SM,
 978                              MachineFunction &MF, StringRef Src,
 979                              const PerFunctionMIParsingState &PFS,
 980                              const SlotMapping &IRSlots, SMDiagnostic &Error) {
 981   return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseStandaloneMBB(MBB);
 982 }
 983
 984 bool llvm::parseNamedRegisterReference(unsigned &Reg, SourceMgr &SM,
 985                                        MachineFunction &MF, StringRef Src,
 986                                        const PerFunctionMIParsingState &PFS,
 987                                        const SlotMapping &IRSlots,
 988                                        SMDiagnostic &Error) {
 989   return MIParser(SM, MF, Error, Src, PFS, IRSlots)
 990       .parseStandaloneNamedRegister(Reg);
 991 }
 992
 993 bool llvm::parseVirtualRegisterReference(unsigned &Reg, SourceMgr &SM,
 994                                          MachineFunction &MF, StringRef Src,
 995                                          const PerFunctionMIParsingState &PFS,
 996                                          const SlotMapping &IRSlots,
 997                                          SMDiagnostic &Error) {
 998   return MIParser(SM, MF, Error, Src, PFS, IRSlots)
 999       .parseStandaloneVirtualRegister(Reg);
1000 }
1001
1002 bool llvm::parseIRBlockReference(const BasicBlock *&BB, SourceMgr &SM,
1003                                  MachineFunction &MF, StringRef Src,
1004                                  const PerFunctionMIParsingState &PFS,
1005                                  const SlotMapping &IRSlots,
1006                                  SMDiagnostic &Error) {
1007   return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1008       .parseStandaloneIRBlockReference(BB);
1009 }