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