1 //===- MIParser.cpp - Machine instructions parser implementation ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the parsing of machine instructions.
12 //===----------------------------------------------------------------------===//
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"
40 /// A wrapper struct around the 'MachineOperand' struct that includes a source
42 struct MachineOperandWithLocation {
43 MachineOperand Operand;
44 StringRef::iterator Begin;
45 StringRef::iterator End;
47 MachineOperandWithLocation(const MachineOperand &Operand,
48 StringRef::iterator Begin, StringRef::iterator End)
49 : Operand(Operand), Begin(Begin), End(End) {}
56 StringRef Source, CurrentSource;
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;
75 MIParser(SourceMgr &SM, MachineFunction &MF, SMDiagnostic &Error,
76 StringRef Source, const PerFunctionMIParsingState &PFS,
77 const SlotMapping &IRSlots);
81 /// Report an error at the current location with the given message.
83 /// This function always return true.
84 bool error(const Twine &Msg);
86 /// Report an error at the given location with the given message.
88 /// This function always return true.
89 bool error(StringRef::iterator Loc, const Twine &Msg);
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);
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);
126 /// Convert the integer literal in the current token into an unsigned integer.
128 /// Return true if an error occurred.
129 bool getUnsigned(unsigned &Result);
131 /// Convert the integer literal in the current token into an uint64.
133 /// Return true if an error occurred.
134 bool getUint64(uint64_t &Result);
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);
140 void initNames2InstrOpCodes();
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);
146 bool parseInstruction(unsigned &OpCode, unsigned &Flags);
148 bool verifyImplicitOperands(ArrayRef<MachineOperandWithLocation> Operands,
149 const MCInstrDesc &MCID);
151 void initNames2Regs();
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);
157 void initNames2RegMasks();
159 /// Check if the given identifier is a name of a register mask.
161 /// Return null if the identifier isn't a register mask.
162 const uint32_t *getRegMask(StringRef Identifier);
164 void initNames2SubRegIndices();
166 /// Check if the given identifier is a name of a subregister index.
168 /// Return 0 if the name isn't a subregister index class.
169 unsigned getSubRegIndex(StringRef Name);
171 void initSlots2BasicBlocks();
173 const BasicBlock *getIRBlock(unsigned Slot);
175 void initNames2TargetIndices();
177 /// Try to convert a name of target index to the corresponding target index.
179 /// Return true if the name isn't a name of a target index.
180 bool getTargetIndex(StringRef Name, int &Index);
183 } // end anonymous namespace
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) {}
191 void MIParser::lex() {
192 CurrentSource = lexMIToken(
193 CurrentSource, Token,
194 [this](StringRef::iterator Loc, const Twine &Msg) { error(Loc, Msg); });
197 bool MIParser::error(const Twine &Msg) { return error(Token.location(), Msg); }
199 bool MIParser::error(StringRef::iterator Loc, const Twine &Msg) {
200 assert(Loc >= Source.data() && Loc <= (Source.data() + Source.size()));
201 Error = SMDiagnostic(
203 SM.getMemoryBuffer(SM.getMainFileID())->getBufferIdentifier(), 1,
204 Loc - Source.data(), SourceMgr::DK_Error, Msg.str(), Source, None, None);
208 static const char *toString(MIToken::TokenKind TokenKind) {
214 case MIToken::lparen:
216 case MIToken::rparen:
219 return "<unknown token>";
223 bool MIParser::expectAndConsume(MIToken::TokenKind TokenKind) {
224 if (Token.isNot(TokenKind))
225 return error(Twine("expected ") + toString(TokenKind));
230 bool MIParser::parse(MachineInstr *&MI) {
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))
240 Operands.push_back(MachineOperandWithLocation(MO, Loc, Token.location()));
241 if (Token.isNot(MIToken::comma))
245 if (!Operands.empty() && expectAndConsume(MIToken::equal))
248 unsigned OpCode, Flags = 0;
249 if (Token.isError() || parseInstruction(OpCode, Flags))
252 // TODO: Parse the bundle instruction flags.
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))
260 Operands.push_back(MachineOperandWithLocation(MO, Loc, Token.location()));
261 if (Token.is(MIToken::Eof) || Token.is(MIToken::coloncolon))
263 if (Token.isNot(MIToken::comma))
264 return error("expected ',' before the next machine operand");
268 DebugLoc DebugLocation;
269 if (Token.is(MIToken::kw_debug_location)) {
271 if (Token.isNot(MIToken::exclaim))
272 return error("expected a metadata node after 'debug-location'");
273 MDNode *Node = nullptr;
274 if (parseMDNode(Node))
276 DebugLocation = DebugLoc(Node);
279 // Parse the machine memory operands.
280 SmallVector<MachineMemOperand *, 2> MemOperands;
281 if (Token.is(MIToken::coloncolon)) {
283 while (Token.isNot(MIToken::Eof)) {
284 MachineMemOperand *MemOp = nullptr;
285 if (parseMachineMemoryOperand(MemOp))
287 MemOperands.push_back(MemOp);
288 if (Token.is(MIToken::Eof))
290 if (Token.isNot(MIToken::comma))
291 return error("expected ',' before the next machine memory operand");
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))
303 // TODO: Check for extraneous machine operands.
304 MI = MF.CreateMachineInstr(MCID, DebugLocation, /*NoImplicit=*/true);
306 for (const auto &Operand : Operands)
307 MI->addOperand(MF, Operand.Operand);
308 if (MemOperands.empty())
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());
317 bool MIParser::parseStandaloneMBB(MachineBasicBlock *&MBB) {
319 if (Token.isNot(MIToken::MachineBasicBlock))
320 return error("expected a machine basic block reference");
321 if (parseMBBReference(MBB))
324 if (Token.isNot(MIToken::Eof))
326 "expected end of string after the machine basic block reference");
330 bool MIParser::parseStandaloneNamedRegister(unsigned &Reg) {
332 if (Token.isNot(MIToken::NamedRegister))
333 return error("expected a named register");
334 if (parseRegister(Reg))
337 if (Token.isNot(MIToken::Eof))
338 return error("expected end of string after the register reference");
342 bool MIParser::parseStandaloneVirtualRegister(unsigned &Reg) {
344 if (Token.isNot(MIToken::VirtualRegister))
345 return error("expected a virtual register");
346 if (parseRegister(Reg))
349 if (Token.isNot(MIToken::Eof))
350 return error("expected end of string after the register reference");
354 bool MIParser::parseStandaloneIRBlockReference(const BasicBlock *&BB) {
356 if (Token.isNot(MIToken::IRBlock))
357 return error("expected an IR block reference");
358 unsigned SlotNumber = 0;
359 if (getUnsigned(SlotNumber))
361 BB = getIRBlock(SlotNumber);
363 return error(Twine("use of undefined IR block '%ir-block.") +
364 Twine(SlotNumber) + "'");
366 if (Token.isNot(MIToken::Eof))
367 return error("expected end of string after the IR block reference");
371 static const char *printImplicitRegisterFlag(const MachineOperand &MO) {
372 assert(MO.isImplicit());
373 return MO.isDef() ? "implicit-def" : "implicit";
376 static std::string getRegisterName(const TargetRegisterInfo *TRI,
378 assert(TargetRegisterInfo::isPhysicalRegister(Reg) && "expected phys reg");
379 return StringRef(TRI->getName(Reg)).lower();
382 bool MIParser::verifyImplicitOperands(
383 ArrayRef<MachineOperandWithLocation> Operands, const MCInstrDesc &MCID) {
385 // We can't verify call instructions as they can contain arbitrary implicit
386 // register and register mask operands.
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));
400 const auto *TRI = MF.getSubtarget().getRegisterInfo();
401 assert(TRI && "Expected target register info");
402 size_t I = ImplicitOperands.size(), J = Operands.size();
407 const auto &ImplicitOperand = ImplicitOperands[I];
408 const auto &Operand = Operands[J].Operand;
409 if (ImplicitOperand.isIdenticalTo(Operand))
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()) + "'");
418 // TODO: Fix source location when Operands[J].end is right before '=', i.e:
419 // insead of reporting an error at this location:
422 // report the error at the following location:
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()) + "'");
433 bool MIParser::parseInstruction(unsigned &OpCode, unsigned &Flags) {
434 if (Token.is(MIToken::kw_frame_setup)) {
435 Flags |= MachineInstr::FrameSetup;
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 + "'");
447 bool MIParser::parseRegister(unsigned &Reg) {
448 switch (Token.kind()) {
449 case MIToken::underscore:
452 case MIToken::NamedRegister: {
453 StringRef Name = Token.stringValue();
454 if (getRegisterByName(Name, Reg))
455 return error(Twine("unknown register name '") + Name + "'");
458 case MIToken::VirtualRegister: {
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) +
466 Reg = RegInfo->second;
469 // TODO: Parse other register kinds.
471 llvm_unreachable("The current token should be a register");
476 bool MIParser::parseRegisterFlag(unsigned &Flags) {
477 switch (Token.kind()) {
478 case MIToken::kw_implicit:
479 Flags |= RegState::Implicit;
481 case MIToken::kw_implicit_define:
482 Flags |= RegState::ImplicitDefine;
484 case MIToken::kw_dead:
485 Flags |= RegState::Dead;
487 case MIToken::kw_killed:
488 Flags |= RegState::Kill;
490 case MIToken::kw_undef:
491 Flags |= RegState::Undef;
493 case MIToken::kw_debug_use:
494 Flags |= RegState::Debug;
496 // TODO: report an error when we specify the same flag more than once.
497 // TODO: parse the other register flags.
499 llvm_unreachable("The current token should be a register flag");
505 bool MIParser::parseSubRegisterIndex(unsigned &SubReg) {
506 assert(Token.is(MIToken::colon));
508 if (Token.isNot(MIToken::Identifier))
509 return error("expected a subregister index after ':'");
510 auto Name = Token.stringValue();
511 SubReg = getSubRegIndex(Name);
513 return error(Twine("use of unknown subregister index '") + Name + "'");
518 bool MIParser::parseRegisterOperand(MachineOperand &Dest, bool IsDef) {
520 unsigned Flags = IsDef ? RegState::Define : 0;
521 while (Token.isRegisterFlag()) {
522 if (parseRegisterFlag(Flags))
525 if (!Token.isRegister())
526 return error("expected a register after register flags");
527 if (parseRegister(Reg))
531 if (Token.is(MIToken::colon)) {
532 if (parseSubRegisterIndex(SubReg))
535 Dest = MachineOperand::CreateReg(
536 Reg, Flags & RegState::Define, Flags & RegState::Implicit,
537 Flags & RegState::Kill, Flags & RegState::Dead, Flags & RegState::Undef,
538 /*isEarlyClobber=*/false, SubReg, Flags & RegState::Debug);
542 bool MIParser::parseImmediateOperand(MachineOperand &Dest) {
543 assert(Token.is(MIToken::IntegerLiteral));
544 const APSInt &Int = Token.integerValue();
545 if (Int.getMinSignedBits() > 64)
546 // TODO: Replace this with an error when we can parse CIMM Machine Operands.
547 llvm_unreachable("Can't parse large integer literals yet!");
548 Dest = MachineOperand::CreateImm(Int.getExtValue());
553 bool MIParser::parseFPImmediateOperand(MachineOperand &Dest) {
554 auto Loc = Token.location();
556 if (Token.isNot(MIToken::FloatingPointLiteral))
557 return error("expected a floating point literal");
558 auto Source = StringRef(Loc, Token.stringValue().end() - Loc).str();
562 parseConstantValue(Source.c_str(), Err, *MF.getFunction()->getParent());
564 return error(Loc + Err.getColumnNo(), Err.getMessage());
565 Dest = MachineOperand::CreateFPImm(cast<ConstantFP>(C));
569 bool MIParser::getUnsigned(unsigned &Result) {
570 assert(Token.hasIntegerValue() && "Expected a token with an integer value");
571 const uint64_t Limit = uint64_t(std::numeric_limits<unsigned>::max()) + 1;
572 uint64_t Val64 = Token.integerValue().getLimitedValue(Limit);
574 return error("expected 32-bit integer (too large)");
579 bool MIParser::parseMBBReference(MachineBasicBlock *&MBB) {
580 assert(Token.is(MIToken::MachineBasicBlock));
582 if (getUnsigned(Number))
584 auto MBBInfo = PFS.MBBSlots.find(Number);
585 if (MBBInfo == PFS.MBBSlots.end())
586 return error(Twine("use of undefined machine basic block #") +
588 MBB = MBBInfo->second;
589 if (!Token.stringValue().empty() && Token.stringValue() != MBB->getName())
590 return error(Twine("the name of machine basic block #") + Twine(Number) +
591 " isn't '" + Token.stringValue() + "'");
595 bool MIParser::parseMBBOperand(MachineOperand &Dest) {
596 MachineBasicBlock *MBB;
597 if (parseMBBReference(MBB))
599 Dest = MachineOperand::CreateMBB(MBB);
604 bool MIParser::parseStackObjectOperand(MachineOperand &Dest) {
605 assert(Token.is(MIToken::StackObject));
609 auto ObjectInfo = PFS.StackObjectSlots.find(ID);
610 if (ObjectInfo == PFS.StackObjectSlots.end())
611 return error(Twine("use of undefined stack object '%stack.") + Twine(ID) +
614 if (const auto *Alloca =
615 MF.getFrameInfo()->getObjectAllocation(ObjectInfo->second))
616 Name = Alloca->getName();
617 if (!Token.stringValue().empty() && Token.stringValue() != Name)
618 return error(Twine("the name of the stack object '%stack.") + Twine(ID) +
619 "' isn't '" + Token.stringValue() + "'");
621 Dest = MachineOperand::CreateFI(ObjectInfo->second);
625 bool MIParser::parseFixedStackObjectOperand(MachineOperand &Dest) {
626 assert(Token.is(MIToken::FixedStackObject));
630 auto ObjectInfo = PFS.FixedStackObjectSlots.find(ID);
631 if (ObjectInfo == PFS.FixedStackObjectSlots.end())
632 return error(Twine("use of undefined fixed stack object '%fixed-stack.") +
635 Dest = MachineOperand::CreateFI(ObjectInfo->second);
639 bool MIParser::parseGlobalValue(GlobalValue *&GV) {
640 switch (Token.kind()) {
641 case MIToken::NamedGlobalValue: {
642 const Module *M = MF.getFunction()->getParent();
643 GV = M->getNamedValue(Token.stringValue());
645 return error(Twine("use of undefined global value '@") +
646 Token.rawStringValue() + "'");
649 case MIToken::GlobalValue: {
651 if (getUnsigned(GVIdx))
653 if (GVIdx >= IRSlots.GlobalValues.size())
654 return error(Twine("use of undefined global value '@") + Twine(GVIdx) +
656 GV = IRSlots.GlobalValues[GVIdx];
660 llvm_unreachable("The current token should be a global value");
665 bool MIParser::parseGlobalAddressOperand(MachineOperand &Dest) {
666 GlobalValue *GV = nullptr;
667 if (parseGlobalValue(GV))
669 Dest = MachineOperand::CreateGA(GV, /*Offset=*/0);
670 // TODO: Parse offset and target flags.
675 bool MIParser::parseConstantPoolIndexOperand(MachineOperand &Dest) {
676 assert(Token.is(MIToken::ConstantPoolItem));
680 auto ConstantInfo = PFS.ConstantPoolSlots.find(ID);
681 if (ConstantInfo == PFS.ConstantPoolSlots.end())
682 return error("use of undefined constant '%const." + Twine(ID) + "'");
684 // TODO: Parse offset and target flags.
685 Dest = MachineOperand::CreateCPI(ID, /*Offset=*/0);
689 bool MIParser::parseJumpTableIndexOperand(MachineOperand &Dest) {
690 assert(Token.is(MIToken::JumpTableIndex));
694 auto JumpTableEntryInfo = PFS.JumpTableSlots.find(ID);
695 if (JumpTableEntryInfo == PFS.JumpTableSlots.end())
696 return error("use of undefined jump table '%jump-table." + Twine(ID) + "'");
698 // TODO: Parse target flags.
699 Dest = MachineOperand::CreateJTI(JumpTableEntryInfo->second);
703 bool MIParser::parseExternalSymbolOperand(MachineOperand &Dest) {
704 assert(Token.is(MIToken::ExternalSymbol));
705 const char *Symbol = MF.createExternalSymbolName(Token.stringValue());
707 // TODO: Parse the target flags.
708 Dest = MachineOperand::CreateES(Symbol);
712 bool MIParser::parseMDNode(MDNode *&Node) {
713 assert(Token.is(MIToken::exclaim));
714 auto Loc = Token.location();
716 if (Token.isNot(MIToken::IntegerLiteral) || Token.integerValue().isSigned())
717 return error("expected metadata id after '!'");
721 auto NodeInfo = IRSlots.MetadataNodes.find(ID);
722 if (NodeInfo == IRSlots.MetadataNodes.end())
723 return error(Loc, "use of undefined metadata '!" + Twine(ID) + "'");
725 Node = NodeInfo->second.get();
729 bool MIParser::parseMetadataOperand(MachineOperand &Dest) {
730 MDNode *Node = nullptr;
731 if (parseMDNode(Node))
733 Dest = MachineOperand::CreateMetadata(Node);
737 bool MIParser::parseCFIOffset(int &Offset) {
738 if (Token.isNot(MIToken::IntegerLiteral))
739 return error("expected a cfi offset");
740 if (Token.integerValue().getMinSignedBits() > 32)
741 return error("expected a 32 bit integer (the cfi offset is too large)");
742 Offset = (int)Token.integerValue().getExtValue();
747 bool MIParser::parseCFIRegister(unsigned &Reg) {
748 if (Token.isNot(MIToken::NamedRegister))
749 return error("expected a cfi register");
751 if (parseRegister(LLVMReg))
753 const auto *TRI = MF.getSubtarget().getRegisterInfo();
754 assert(TRI && "Expected target register info");
755 int DwarfReg = TRI->getDwarfRegNum(LLVMReg, true);
757 return error("invalid DWARF register");
758 Reg = (unsigned)DwarfReg;
763 bool MIParser::parseCFIOperand(MachineOperand &Dest) {
764 auto Kind = Token.kind();
766 auto &MMI = MF.getMMI();
771 case MIToken::kw_cfi_offset:
772 if (parseCFIRegister(Reg) || expectAndConsume(MIToken::comma) ||
773 parseCFIOffset(Offset))
776 MMI.addFrameInst(MCCFIInstruction::createOffset(nullptr, Reg, Offset));
778 case MIToken::kw_cfi_def_cfa_register:
779 if (parseCFIRegister(Reg))
782 MMI.addFrameInst(MCCFIInstruction::createDefCfaRegister(nullptr, Reg));
784 case MIToken::kw_cfi_def_cfa_offset:
785 if (parseCFIOffset(Offset))
787 // NB: MCCFIInstruction::createDefCfaOffset negates the offset.
788 CFIIndex = MMI.addFrameInst(
789 MCCFIInstruction::createDefCfaOffset(nullptr, -Offset));
791 case MIToken::kw_cfi_def_cfa:
792 if (parseCFIRegister(Reg) || expectAndConsume(MIToken::comma) ||
793 parseCFIOffset(Offset))
795 // NB: MCCFIInstruction::createDefCfa negates the offset.
797 MMI.addFrameInst(MCCFIInstruction::createDefCfa(nullptr, Reg, -Offset));
800 // TODO: Parse the other CFI operands.
801 llvm_unreachable("The current token should be a cfi operand");
803 Dest = MachineOperand::CreateCFIIndex(CFIIndex);
807 bool MIParser::parseIRBlock(BasicBlock *&BB, const Function &F) {
808 switch (Token.kind()) {
809 case MIToken::NamedIRBlock: {
810 BB = dyn_cast_or_null<BasicBlock>(
811 F.getValueSymbolTable().lookup(Token.stringValue()));
813 return error(Twine("use of undefined IR block '%ir-block.") +
814 Token.rawStringValue() + "'");
817 case MIToken::IRBlock: {
818 unsigned SlotNumber = 0;
819 if (getUnsigned(SlotNumber))
821 BB = const_cast<BasicBlock *>(getIRBlock(SlotNumber));
823 return error(Twine("use of undefined IR block '%ir-block.") +
824 Twine(SlotNumber) + "'");
828 llvm_unreachable("The current token should be an IR block reference");
833 bool MIParser::parseBlockAddressOperand(MachineOperand &Dest) {
834 assert(Token.is(MIToken::kw_blockaddress));
836 if (expectAndConsume(MIToken::lparen))
838 if (Token.isNot(MIToken::GlobalValue) &&
839 Token.isNot(MIToken::NamedGlobalValue))
840 return error("expected a global value");
841 GlobalValue *GV = nullptr;
842 if (parseGlobalValue(GV))
844 auto *F = dyn_cast<Function>(GV);
846 return error("expected an IR function reference");
848 if (expectAndConsume(MIToken::comma))
850 BasicBlock *BB = nullptr;
851 if (Token.isNot(MIToken::IRBlock) && Token.isNot(MIToken::NamedIRBlock))
852 return error("expected an IR block reference");
853 if (parseIRBlock(BB, *F))
856 if (expectAndConsume(MIToken::rparen))
858 // TODO: parse offset and target flags.
859 Dest = MachineOperand::CreateBA(BlockAddress::get(F, BB), /*Offset=*/0);
863 bool MIParser::parseTargetIndexOperand(MachineOperand &Dest) {
864 assert(Token.is(MIToken::kw_target_index));
866 if (expectAndConsume(MIToken::lparen))
868 if (Token.isNot(MIToken::Identifier))
869 return error("expected the name of the target index");
871 if (getTargetIndex(Token.stringValue(), Index))
872 return error("use of undefined target index '" + Token.stringValue() + "'");
874 if (expectAndConsume(MIToken::rparen))
876 // TODO: Parse the offset and target flags.
877 Dest = MachineOperand::CreateTargetIndex(unsigned(Index), /*Offset=*/0);
881 bool MIParser::parseMachineOperand(MachineOperand &Dest) {
882 switch (Token.kind()) {
883 case MIToken::kw_implicit:
884 case MIToken::kw_implicit_define:
885 case MIToken::kw_dead:
886 case MIToken::kw_killed:
887 case MIToken::kw_undef:
888 case MIToken::kw_debug_use:
889 case MIToken::underscore:
890 case MIToken::NamedRegister:
891 case MIToken::VirtualRegister:
892 return parseRegisterOperand(Dest);
893 case MIToken::IntegerLiteral:
894 return parseImmediateOperand(Dest);
895 case MIToken::kw_half:
896 case MIToken::kw_float:
897 case MIToken::kw_double:
898 case MIToken::kw_x86_fp80:
899 case MIToken::kw_fp128:
900 case MIToken::kw_ppc_fp128:
901 return parseFPImmediateOperand(Dest);
902 case MIToken::MachineBasicBlock:
903 return parseMBBOperand(Dest);
904 case MIToken::StackObject:
905 return parseStackObjectOperand(Dest);
906 case MIToken::FixedStackObject:
907 return parseFixedStackObjectOperand(Dest);
908 case MIToken::GlobalValue:
909 case MIToken::NamedGlobalValue:
910 return parseGlobalAddressOperand(Dest);
911 case MIToken::ConstantPoolItem:
912 return parseConstantPoolIndexOperand(Dest);
913 case MIToken::JumpTableIndex:
914 return parseJumpTableIndexOperand(Dest);
915 case MIToken::ExternalSymbol:
916 return parseExternalSymbolOperand(Dest);
917 case MIToken::exclaim:
918 return parseMetadataOperand(Dest);
919 case MIToken::kw_cfi_offset:
920 case MIToken::kw_cfi_def_cfa_register:
921 case MIToken::kw_cfi_def_cfa_offset:
922 case MIToken::kw_cfi_def_cfa:
923 return parseCFIOperand(Dest);
924 case MIToken::kw_blockaddress:
925 return parseBlockAddressOperand(Dest);
926 case MIToken::kw_target_index:
927 return parseTargetIndexOperand(Dest);
930 case MIToken::Identifier:
931 if (const auto *RegMask = getRegMask(Token.stringValue())) {
932 Dest = MachineOperand::CreateRegMask(RegMask);
938 // TODO: parse the other machine operands.
939 return error("expected a machine operand");
944 bool MIParser::parseIRValue(Value *&V) {
945 switch (Token.kind()) {
946 case MIToken::NamedIRValue: {
947 V = MF.getFunction()->getValueSymbolTable().lookup(Token.stringValue());
949 return error(Twine("use of undefined IR value '%ir.") +
950 Token.rawStringValue() + "'");
953 // TODO: Parse unnamed IR value references.
955 llvm_unreachable("The current token should be an IR block reference");
960 bool MIParser::getUint64(uint64_t &Result) {
961 assert(Token.hasIntegerValue());
962 if (Token.integerValue().getActiveBits() > 64)
963 return error("expected 64-bit integer (too large)");
964 Result = Token.integerValue().getZExtValue();
968 bool MIParser::parseMemoryOperandFlag(unsigned &Flags) {
969 switch (Token.kind()) {
970 case MIToken::kw_volatile:
971 Flags |= MachineMemOperand::MOVolatile;
973 // TODO: report an error when we specify the same flag more than once.
974 // TODO: parse the other memory operand flags.
976 llvm_unreachable("The current token should be a memory operand flag");
982 bool MIParser::parseMachineMemoryOperand(MachineMemOperand *&Dest) {
983 if (expectAndConsume(MIToken::lparen))
986 while (Token.isMemoryOperandFlag()) {
987 if (parseMemoryOperandFlag(Flags))
990 if (Token.isNot(MIToken::Identifier) ||
991 (Token.stringValue() != "load" && Token.stringValue() != "store"))
992 return error("expected 'load' or 'store' memory operation");
993 if (Token.stringValue() == "load")
994 Flags |= MachineMemOperand::MOLoad;
996 Flags |= MachineMemOperand::MOStore;
999 if (Token.isNot(MIToken::IntegerLiteral))
1000 return error("expected the size integer literal after memory operation");
1002 if (getUint64(Size))
1006 const char *Word = Flags & MachineMemOperand::MOLoad ? "from" : "into";
1007 if (Token.isNot(MIToken::Identifier) || Token.stringValue() != Word)
1008 return error(Twine("expected '") + Word + "'");
1011 // TODO: Parse pseudo source values.
1012 if (Token.isNot(MIToken::NamedIRValue))
1013 return error("expected an IR value reference");
1015 if (parseIRValue(V))
1017 if (!V->getType()->isPointerTy())
1018 return error("expected a pointer IR value");
1020 // TODO: Parse the base alignment.
1021 // TODO: Parse the attached metadata nodes.
1022 if (expectAndConsume(MIToken::rparen))
1025 Dest = MF.getMachineMemOperand(MachinePointerInfo(V), Flags, Size, Size);
1029 void MIParser::initNames2InstrOpCodes() {
1030 if (!Names2InstrOpCodes.empty())
1032 const auto *TII = MF.getSubtarget().getInstrInfo();
1033 assert(TII && "Expected target instruction info");
1034 for (unsigned I = 0, E = TII->getNumOpcodes(); I < E; ++I)
1035 Names2InstrOpCodes.insert(std::make_pair(StringRef(TII->getName(I)), I));
1038 bool MIParser::parseInstrName(StringRef InstrName, unsigned &OpCode) {
1039 initNames2InstrOpCodes();
1040 auto InstrInfo = Names2InstrOpCodes.find(InstrName);
1041 if (InstrInfo == Names2InstrOpCodes.end())
1043 OpCode = InstrInfo->getValue();
1047 void MIParser::initNames2Regs() {
1048 if (!Names2Regs.empty())
1050 // The '%noreg' register is the register 0.
1051 Names2Regs.insert(std::make_pair("noreg", 0));
1052 const auto *TRI = MF.getSubtarget().getRegisterInfo();
1053 assert(TRI && "Expected target register info");
1054 for (unsigned I = 0, E = TRI->getNumRegs(); I < E; ++I) {
1056 Names2Regs.insert(std::make_pair(StringRef(TRI->getName(I)).lower(), I))
1059 assert(WasInserted && "Expected registers to be unique case-insensitively");
1063 bool MIParser::getRegisterByName(StringRef RegName, unsigned &Reg) {
1065 auto RegInfo = Names2Regs.find(RegName);
1066 if (RegInfo == Names2Regs.end())
1068 Reg = RegInfo->getValue();
1072 void MIParser::initNames2RegMasks() {
1073 if (!Names2RegMasks.empty())
1075 const auto *TRI = MF.getSubtarget().getRegisterInfo();
1076 assert(TRI && "Expected target register info");
1077 ArrayRef<const uint32_t *> RegMasks = TRI->getRegMasks();
1078 ArrayRef<const char *> RegMaskNames = TRI->getRegMaskNames();
1079 assert(RegMasks.size() == RegMaskNames.size());
1080 for (size_t I = 0, E = RegMasks.size(); I < E; ++I)
1081 Names2RegMasks.insert(
1082 std::make_pair(StringRef(RegMaskNames[I]).lower(), RegMasks[I]));
1085 const uint32_t *MIParser::getRegMask(StringRef Identifier) {
1086 initNames2RegMasks();
1087 auto RegMaskInfo = Names2RegMasks.find(Identifier);
1088 if (RegMaskInfo == Names2RegMasks.end())
1090 return RegMaskInfo->getValue();
1093 void MIParser::initNames2SubRegIndices() {
1094 if (!Names2SubRegIndices.empty())
1096 const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
1097 for (unsigned I = 1, E = TRI->getNumSubRegIndices(); I < E; ++I)
1098 Names2SubRegIndices.insert(
1099 std::make_pair(StringRef(TRI->getSubRegIndexName(I)).lower(), I));
1102 unsigned MIParser::getSubRegIndex(StringRef Name) {
1103 initNames2SubRegIndices();
1104 auto SubRegInfo = Names2SubRegIndices.find(Name);
1105 if (SubRegInfo == Names2SubRegIndices.end())
1107 return SubRegInfo->getValue();
1110 void MIParser::initSlots2BasicBlocks() {
1111 if (!Slots2BasicBlocks.empty())
1113 const auto &F = *MF.getFunction();
1114 ModuleSlotTracker MST(F.getParent());
1115 MST.incorporateFunction(F);
1116 for (auto &BB : F) {
1119 int Slot = MST.getLocalSlot(&BB);
1122 Slots2BasicBlocks.insert(std::make_pair(unsigned(Slot), &BB));
1126 const BasicBlock *MIParser::getIRBlock(unsigned Slot) {
1127 initSlots2BasicBlocks();
1128 auto BlockInfo = Slots2BasicBlocks.find(Slot);
1129 if (BlockInfo == Slots2BasicBlocks.end())
1131 return BlockInfo->second;
1134 void MIParser::initNames2TargetIndices() {
1135 if (!Names2TargetIndices.empty())
1137 const auto *TII = MF.getSubtarget().getInstrInfo();
1138 assert(TII && "Expected target instruction info");
1139 auto Indices = TII->getSerializableTargetIndices();
1140 for (const auto &I : Indices)
1141 Names2TargetIndices.insert(std::make_pair(StringRef(I.second), I.first));
1144 bool MIParser::getTargetIndex(StringRef Name, int &Index) {
1145 initNames2TargetIndices();
1146 auto IndexInfo = Names2TargetIndices.find(Name);
1147 if (IndexInfo == Names2TargetIndices.end())
1149 Index = IndexInfo->second;
1153 bool llvm::parseMachineInstr(MachineInstr *&MI, SourceMgr &SM,
1154 MachineFunction &MF, StringRef Src,
1155 const PerFunctionMIParsingState &PFS,
1156 const SlotMapping &IRSlots, SMDiagnostic &Error) {
1157 return MIParser(SM, MF, Error, Src, PFS, IRSlots).parse(MI);
1160 bool llvm::parseMBBReference(MachineBasicBlock *&MBB, SourceMgr &SM,
1161 MachineFunction &MF, StringRef Src,
1162 const PerFunctionMIParsingState &PFS,
1163 const SlotMapping &IRSlots, SMDiagnostic &Error) {
1164 return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseStandaloneMBB(MBB);
1167 bool llvm::parseNamedRegisterReference(unsigned &Reg, SourceMgr &SM,
1168 MachineFunction &MF, StringRef Src,
1169 const PerFunctionMIParsingState &PFS,
1170 const SlotMapping &IRSlots,
1171 SMDiagnostic &Error) {
1172 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1173 .parseStandaloneNamedRegister(Reg);
1176 bool llvm::parseVirtualRegisterReference(unsigned &Reg, SourceMgr &SM,
1177 MachineFunction &MF, StringRef Src,
1178 const PerFunctionMIParsingState &PFS,
1179 const SlotMapping &IRSlots,
1180 SMDiagnostic &Error) {
1181 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1182 .parseStandaloneVirtualRegister(Reg);
1185 bool llvm::parseIRBlockReference(const BasicBlock *&BB, SourceMgr &SM,
1186 MachineFunction &MF, StringRef Src,
1187 const PerFunctionMIParsingState &PFS,
1188 const SlotMapping &IRSlots,
1189 SMDiagnostic &Error) {
1190 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1191 .parseStandaloneIRBlockReference(BB);