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