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 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 parseOperandsOffset(MachineOperand &Op);
124 bool parseIRValue(Value *&V);
125 bool parseMemoryOperandFlag(unsigned &Flags);
126 bool parseMachineMemoryOperand(MachineMemOperand *&Dest);
129 /// Convert the integer literal in the current token into an unsigned integer.
131 /// Return true if an error occurred.
132 bool getUnsigned(unsigned &Result);
134 /// Convert the integer literal in the current token into an uint64.
136 /// Return true if an error occurred.
137 bool getUint64(uint64_t &Result);
139 /// If the current token is of the given kind, consume it and return false.
140 /// Otherwise report an error and return true.
141 bool expectAndConsume(MIToken::TokenKind TokenKind);
143 void initNames2InstrOpCodes();
145 /// Try to convert an instruction name to an opcode. Return true if the
146 /// instruction name is invalid.
147 bool parseInstrName(StringRef InstrName, unsigned &OpCode);
149 bool parseInstruction(unsigned &OpCode, unsigned &Flags);
151 bool verifyImplicitOperands(ArrayRef<MachineOperandWithLocation> Operands,
152 const MCInstrDesc &MCID);
154 void initNames2Regs();
156 /// Try to convert a register name to a register number. Return true if the
157 /// register name is invalid.
158 bool getRegisterByName(StringRef RegName, unsigned &Reg);
160 void initNames2RegMasks();
162 /// Check if the given identifier is a name of a register mask.
164 /// Return null if the identifier isn't a register mask.
165 const uint32_t *getRegMask(StringRef Identifier);
167 void initNames2SubRegIndices();
169 /// Check if the given identifier is a name of a subregister index.
171 /// Return 0 if the name isn't a subregister index class.
172 unsigned getSubRegIndex(StringRef Name);
174 void initSlots2BasicBlocks();
176 const BasicBlock *getIRBlock(unsigned Slot);
178 void initNames2TargetIndices();
180 /// Try to convert a name of target index to the corresponding target index.
182 /// Return true if the name isn't a name of a target index.
183 bool getTargetIndex(StringRef Name, int &Index);
186 } // end anonymous namespace
188 MIParser::MIParser(SourceMgr &SM, MachineFunction &MF, SMDiagnostic &Error,
189 StringRef Source, const PerFunctionMIParsingState &PFS,
190 const SlotMapping &IRSlots)
191 : SM(SM), MF(MF), Error(Error), Source(Source), CurrentSource(Source),
192 Token(MIToken::Error, StringRef()), PFS(PFS), IRSlots(IRSlots) {}
194 void MIParser::lex() {
195 CurrentSource = lexMIToken(
196 CurrentSource, Token,
197 [this](StringRef::iterator Loc, const Twine &Msg) { error(Loc, Msg); });
200 bool MIParser::error(const Twine &Msg) { return error(Token.location(), Msg); }
202 bool MIParser::error(StringRef::iterator Loc, const Twine &Msg) {
203 assert(Loc >= Source.data() && Loc <= (Source.data() + Source.size()));
204 Error = SMDiagnostic(
206 SM.getMemoryBuffer(SM.getMainFileID())->getBufferIdentifier(), 1,
207 Loc - Source.data(), SourceMgr::DK_Error, Msg.str(), Source, None, None);
211 static const char *toString(MIToken::TokenKind TokenKind) {
217 case MIToken::lparen:
219 case MIToken::rparen:
222 return "<unknown token>";
226 bool MIParser::expectAndConsume(MIToken::TokenKind TokenKind) {
227 if (Token.isNot(TokenKind))
228 return error(Twine("expected ") + toString(TokenKind));
233 bool MIParser::parse(MachineInstr *&MI) {
236 // Parse any register operands before '='
237 MachineOperand MO = MachineOperand::CreateImm(0);
238 SmallVector<MachineOperandWithLocation, 8> Operands;
239 while (Token.isRegister() || Token.isRegisterFlag()) {
240 auto Loc = Token.location();
241 if (parseRegisterOperand(MO, /*IsDef=*/true))
243 Operands.push_back(MachineOperandWithLocation(MO, Loc, Token.location()));
244 if (Token.isNot(MIToken::comma))
248 if (!Operands.empty() && expectAndConsume(MIToken::equal))
251 unsigned OpCode, Flags = 0;
252 if (Token.isError() || parseInstruction(OpCode, Flags))
255 // TODO: Parse the bundle instruction flags.
257 // Parse the remaining machine operands.
258 while (Token.isNot(MIToken::Eof) && Token.isNot(MIToken::kw_debug_location) &&
259 Token.isNot(MIToken::coloncolon)) {
260 auto Loc = Token.location();
261 if (parseMachineOperand(MO))
263 Operands.push_back(MachineOperandWithLocation(MO, Loc, Token.location()));
264 if (Token.is(MIToken::Eof) || Token.is(MIToken::coloncolon))
266 if (Token.isNot(MIToken::comma))
267 return error("expected ',' before the next machine operand");
271 DebugLoc DebugLocation;
272 if (Token.is(MIToken::kw_debug_location)) {
274 if (Token.isNot(MIToken::exclaim))
275 return error("expected a metadata node after 'debug-location'");
276 MDNode *Node = nullptr;
277 if (parseMDNode(Node))
279 DebugLocation = DebugLoc(Node);
282 // Parse the machine memory operands.
283 SmallVector<MachineMemOperand *, 2> MemOperands;
284 if (Token.is(MIToken::coloncolon)) {
286 while (Token.isNot(MIToken::Eof)) {
287 MachineMemOperand *MemOp = nullptr;
288 if (parseMachineMemoryOperand(MemOp))
290 MemOperands.push_back(MemOp);
291 if (Token.is(MIToken::Eof))
293 if (Token.isNot(MIToken::comma))
294 return error("expected ',' before the next machine memory operand");
299 const auto &MCID = MF.getSubtarget().getInstrInfo()->get(OpCode);
300 if (!MCID.isVariadic()) {
301 // FIXME: Move the implicit operand verification to the machine verifier.
302 if (verifyImplicitOperands(Operands, MCID))
306 // TODO: Check for extraneous machine operands.
307 MI = MF.CreateMachineInstr(MCID, DebugLocation, /*NoImplicit=*/true);
309 for (const auto &Operand : Operands)
310 MI->addOperand(MF, Operand.Operand);
311 if (MemOperands.empty())
313 MachineInstr::mmo_iterator MemRefs =
314 MF.allocateMemRefsArray(MemOperands.size());
315 std::copy(MemOperands.begin(), MemOperands.end(), MemRefs);
316 MI->setMemRefs(MemRefs, MemRefs + MemOperands.size());
320 bool MIParser::parseStandaloneMBB(MachineBasicBlock *&MBB) {
322 if (Token.isNot(MIToken::MachineBasicBlock))
323 return error("expected a machine basic block reference");
324 if (parseMBBReference(MBB))
327 if (Token.isNot(MIToken::Eof))
329 "expected end of string after the machine basic block reference");
333 bool MIParser::parseStandaloneNamedRegister(unsigned &Reg) {
335 if (Token.isNot(MIToken::NamedRegister))
336 return error("expected a named register");
337 if (parseRegister(Reg))
340 if (Token.isNot(MIToken::Eof))
341 return error("expected end of string after the register reference");
345 bool MIParser::parseStandaloneVirtualRegister(unsigned &Reg) {
347 if (Token.isNot(MIToken::VirtualRegister))
348 return error("expected a virtual register");
349 if (parseRegister(Reg))
352 if (Token.isNot(MIToken::Eof))
353 return error("expected end of string after the register reference");
357 bool MIParser::parseStandaloneIRBlockReference(const BasicBlock *&BB) {
359 if (Token.isNot(MIToken::IRBlock))
360 return error("expected an IR block reference");
361 unsigned SlotNumber = 0;
362 if (getUnsigned(SlotNumber))
364 BB = getIRBlock(SlotNumber);
366 return error(Twine("use of undefined IR block '%ir-block.") +
367 Twine(SlotNumber) + "'");
369 if (Token.isNot(MIToken::Eof))
370 return error("expected end of string after the IR block reference");
374 static const char *printImplicitRegisterFlag(const MachineOperand &MO) {
375 assert(MO.isImplicit());
376 return MO.isDef() ? "implicit-def" : "implicit";
379 static std::string getRegisterName(const TargetRegisterInfo *TRI,
381 assert(TargetRegisterInfo::isPhysicalRegister(Reg) && "expected phys reg");
382 return StringRef(TRI->getName(Reg)).lower();
385 bool MIParser::verifyImplicitOperands(
386 ArrayRef<MachineOperandWithLocation> Operands, const MCInstrDesc &MCID) {
388 // We can't verify call instructions as they can contain arbitrary implicit
389 // register and register mask operands.
392 // Gather all the expected implicit operands.
393 SmallVector<MachineOperand, 4> ImplicitOperands;
394 if (MCID.ImplicitDefs)
395 for (const uint16_t *ImpDefs = MCID.getImplicitDefs(); *ImpDefs; ++ImpDefs)
396 ImplicitOperands.push_back(
397 MachineOperand::CreateReg(*ImpDefs, true, true));
398 if (MCID.ImplicitUses)
399 for (const uint16_t *ImpUses = MCID.getImplicitUses(); *ImpUses; ++ImpUses)
400 ImplicitOperands.push_back(
401 MachineOperand::CreateReg(*ImpUses, false, true));
403 const auto *TRI = MF.getSubtarget().getRegisterInfo();
404 assert(TRI && "Expected target register info");
405 size_t I = ImplicitOperands.size(), J = Operands.size();
410 const auto &ImplicitOperand = ImplicitOperands[I];
411 const auto &Operand = Operands[J].Operand;
412 if (ImplicitOperand.isIdenticalTo(Operand))
414 if (Operand.isReg() && Operand.isImplicit()) {
415 return error(Operands[J].Begin,
416 Twine("expected an implicit register operand '") +
417 printImplicitRegisterFlag(ImplicitOperand) + " %" +
418 getRegisterName(TRI, ImplicitOperand.getReg()) + "'");
421 // TODO: Fix source location when Operands[J].end is right before '=', i.e:
422 // insead of reporting an error at this location:
425 // report the error at the following location:
428 return error(J < Operands.size() ? Operands[J].End : Token.location(),
429 Twine("missing implicit register operand '") +
430 printImplicitRegisterFlag(ImplicitOperands[I]) + " %" +
431 getRegisterName(TRI, ImplicitOperands[I].getReg()) + "'");
436 bool MIParser::parseInstruction(unsigned &OpCode, unsigned &Flags) {
437 if (Token.is(MIToken::kw_frame_setup)) {
438 Flags |= MachineInstr::FrameSetup;
441 if (Token.isNot(MIToken::Identifier))
442 return error("expected a machine instruction");
443 StringRef InstrName = Token.stringValue();
444 if (parseInstrName(InstrName, OpCode))
445 return error(Twine("unknown machine instruction name '") + InstrName + "'");
450 bool MIParser::parseRegister(unsigned &Reg) {
451 switch (Token.kind()) {
452 case MIToken::underscore:
455 case MIToken::NamedRegister: {
456 StringRef Name = Token.stringValue();
457 if (getRegisterByName(Name, Reg))
458 return error(Twine("unknown register name '") + Name + "'");
461 case MIToken::VirtualRegister: {
465 const auto RegInfo = PFS.VirtualRegisterSlots.find(ID);
466 if (RegInfo == PFS.VirtualRegisterSlots.end())
467 return error(Twine("use of undefined virtual register '%") + Twine(ID) +
469 Reg = RegInfo->second;
472 // TODO: Parse other register kinds.
474 llvm_unreachable("The current token should be a register");
479 bool MIParser::parseRegisterFlag(unsigned &Flags) {
480 const unsigned OldFlags = Flags;
481 switch (Token.kind()) {
482 case MIToken::kw_implicit:
483 Flags |= RegState::Implicit;
485 case MIToken::kw_implicit_define:
486 Flags |= RegState::ImplicitDefine;
488 case MIToken::kw_dead:
489 Flags |= RegState::Dead;
491 case MIToken::kw_killed:
492 Flags |= RegState::Kill;
494 case MIToken::kw_undef:
495 Flags |= RegState::Undef;
497 case MIToken::kw_early_clobber:
498 Flags |= RegState::EarlyClobber;
500 case MIToken::kw_debug_use:
501 Flags |= RegState::Debug;
503 // TODO: parse the other register flags.
505 llvm_unreachable("The current token should be a register flag");
507 if (OldFlags == Flags)
508 // We know that the same flag is specified more than once when the flags
510 return error("duplicate '" + Token.stringValue() + "' register flag");
515 bool MIParser::parseSubRegisterIndex(unsigned &SubReg) {
516 assert(Token.is(MIToken::colon));
518 if (Token.isNot(MIToken::Identifier))
519 return error("expected a subregister index after ':'");
520 auto Name = Token.stringValue();
521 SubReg = getSubRegIndex(Name);
523 return error(Twine("use of unknown subregister index '") + Name + "'");
528 bool MIParser::parseRegisterOperand(MachineOperand &Dest, bool IsDef) {
530 unsigned Flags = IsDef ? RegState::Define : 0;
531 while (Token.isRegisterFlag()) {
532 if (parseRegisterFlag(Flags))
535 if (!Token.isRegister())
536 return error("expected a register after register flags");
537 if (parseRegister(Reg))
541 if (Token.is(MIToken::colon)) {
542 if (parseSubRegisterIndex(SubReg))
545 Dest = MachineOperand::CreateReg(
546 Reg, Flags & RegState::Define, Flags & RegState::Implicit,
547 Flags & RegState::Kill, Flags & RegState::Dead, Flags & RegState::Undef,
548 Flags & RegState::EarlyClobber, SubReg, Flags & RegState::Debug);
552 bool MIParser::parseImmediateOperand(MachineOperand &Dest) {
553 assert(Token.is(MIToken::IntegerLiteral));
554 const APSInt &Int = Token.integerValue();
555 if (Int.getMinSignedBits() > 64)
556 return error("integer literal is too large to be an immediate operand");
557 Dest = MachineOperand::CreateImm(Int.getExtValue());
562 bool MIParser::parseIRConstant(StringRef::iterator Loc, const Constant *&C) {
563 auto Source = StringRef(Loc, Token.stringValue().end() - Loc).str();
566 C = parseConstantValue(Source.c_str(), Err, *MF.getFunction()->getParent());
568 return error(Loc + Err.getColumnNo(), Err.getMessage());
572 bool MIParser::parseTypedImmediateOperand(MachineOperand &Dest) {
573 assert(Token.is(MIToken::IntegerType));
574 auto Loc = Token.location();
576 if (Token.isNot(MIToken::IntegerLiteral))
577 return error("expected an integer literal");
578 const Constant *C = nullptr;
579 if (parseIRConstant(Loc, C))
581 Dest = MachineOperand::CreateCImm(cast<ConstantInt>(C));
585 bool MIParser::parseFPImmediateOperand(MachineOperand &Dest) {
586 auto Loc = Token.location();
588 if (Token.isNot(MIToken::FloatingPointLiteral))
589 return error("expected a floating point literal");
590 const Constant *C = nullptr;
591 if (parseIRConstant(Loc, C))
593 Dest = MachineOperand::CreateFPImm(cast<ConstantFP>(C));
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);
602 return error("expected 32-bit integer (too large)");
607 bool MIParser::parseMBBReference(MachineBasicBlock *&MBB) {
608 assert(Token.is(MIToken::MachineBasicBlock));
610 if (getUnsigned(Number))
612 auto MBBInfo = PFS.MBBSlots.find(Number);
613 if (MBBInfo == PFS.MBBSlots.end())
614 return error(Twine("use of undefined machine basic block #") +
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() + "'");
623 bool MIParser::parseMBBOperand(MachineOperand &Dest) {
624 MachineBasicBlock *MBB;
625 if (parseMBBReference(MBB))
627 Dest = MachineOperand::CreateMBB(MBB);
632 bool MIParser::parseStackObjectOperand(MachineOperand &Dest) {
633 assert(Token.is(MIToken::StackObject));
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) +
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() + "'");
649 Dest = MachineOperand::CreateFI(ObjectInfo->second);
653 bool MIParser::parseFixedStackObjectOperand(MachineOperand &Dest) {
654 assert(Token.is(MIToken::FixedStackObject));
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.") +
663 Dest = MachineOperand::CreateFI(ObjectInfo->second);
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());
673 return error(Twine("use of undefined global value '@") +
674 Token.rawStringValue() + "'");
677 case MIToken::GlobalValue: {
679 if (getUnsigned(GVIdx))
681 if (GVIdx >= IRSlots.GlobalValues.size())
682 return error(Twine("use of undefined global value '@") + Twine(GVIdx) +
684 GV = IRSlots.GlobalValues[GVIdx];
688 llvm_unreachable("The current token should be a global value");
693 bool MIParser::parseGlobalAddressOperand(MachineOperand &Dest) {
694 GlobalValue *GV = nullptr;
695 if (parseGlobalValue(GV))
698 Dest = MachineOperand::CreateGA(GV, /*Offset=*/0);
699 // TODO: Parse the target flags.
700 if (parseOperandsOffset(Dest))
705 bool MIParser::parseConstantPoolIndexOperand(MachineOperand &Dest) {
706 assert(Token.is(MIToken::ConstantPoolItem));
710 auto ConstantInfo = PFS.ConstantPoolSlots.find(ID);
711 if (ConstantInfo == PFS.ConstantPoolSlots.end())
712 return error("use of undefined constant '%const." + Twine(ID) + "'");
714 // TODO: Parse the target flags.
715 Dest = MachineOperand::CreateCPI(ID, /*Offset=*/0);
716 if (parseOperandsOffset(Dest))
721 bool MIParser::parseJumpTableIndexOperand(MachineOperand &Dest) {
722 assert(Token.is(MIToken::JumpTableIndex));
726 auto JumpTableEntryInfo = PFS.JumpTableSlots.find(ID);
727 if (JumpTableEntryInfo == PFS.JumpTableSlots.end())
728 return error("use of undefined jump table '%jump-table." + Twine(ID) + "'");
730 // TODO: Parse target flags.
731 Dest = MachineOperand::CreateJTI(JumpTableEntryInfo->second);
735 bool MIParser::parseExternalSymbolOperand(MachineOperand &Dest) {
736 assert(Token.is(MIToken::ExternalSymbol));
737 const char *Symbol = MF.createExternalSymbolName(Token.stringValue());
739 // TODO: Parse the target flags.
740 Dest = MachineOperand::CreateES(Symbol);
741 if (parseOperandsOffset(Dest))
746 bool MIParser::parseMDNode(MDNode *&Node) {
747 assert(Token.is(MIToken::exclaim));
748 auto Loc = Token.location();
750 if (Token.isNot(MIToken::IntegerLiteral) || Token.integerValue().isSigned())
751 return error("expected metadata id after '!'");
755 auto NodeInfo = IRSlots.MetadataNodes.find(ID);
756 if (NodeInfo == IRSlots.MetadataNodes.end())
757 return error(Loc, "use of undefined metadata '!" + Twine(ID) + "'");
759 Node = NodeInfo->second.get();
763 bool MIParser::parseMetadataOperand(MachineOperand &Dest) {
764 MDNode *Node = nullptr;
765 if (parseMDNode(Node))
767 Dest = MachineOperand::CreateMetadata(Node);
771 bool MIParser::parseCFIOffset(int &Offset) {
772 if (Token.isNot(MIToken::IntegerLiteral))
773 return error("expected a cfi offset");
774 if (Token.integerValue().getMinSignedBits() > 32)
775 return error("expected a 32 bit integer (the cfi offset is too large)");
776 Offset = (int)Token.integerValue().getExtValue();
781 bool MIParser::parseCFIRegister(unsigned &Reg) {
782 if (Token.isNot(MIToken::NamedRegister))
783 return error("expected a cfi register");
785 if (parseRegister(LLVMReg))
787 const auto *TRI = MF.getSubtarget().getRegisterInfo();
788 assert(TRI && "Expected target register info");
789 int DwarfReg = TRI->getDwarfRegNum(LLVMReg, true);
791 return error("invalid DWARF register");
792 Reg = (unsigned)DwarfReg;
797 bool MIParser::parseCFIOperand(MachineOperand &Dest) {
798 auto Kind = Token.kind();
800 auto &MMI = MF.getMMI();
805 case MIToken::kw_cfi_offset:
806 if (parseCFIRegister(Reg) || expectAndConsume(MIToken::comma) ||
807 parseCFIOffset(Offset))
810 MMI.addFrameInst(MCCFIInstruction::createOffset(nullptr, Reg, Offset));
812 case MIToken::kw_cfi_def_cfa_register:
813 if (parseCFIRegister(Reg))
816 MMI.addFrameInst(MCCFIInstruction::createDefCfaRegister(nullptr, Reg));
818 case MIToken::kw_cfi_def_cfa_offset:
819 if (parseCFIOffset(Offset))
821 // NB: MCCFIInstruction::createDefCfaOffset negates the offset.
822 CFIIndex = MMI.addFrameInst(
823 MCCFIInstruction::createDefCfaOffset(nullptr, -Offset));
825 case MIToken::kw_cfi_def_cfa:
826 if (parseCFIRegister(Reg) || expectAndConsume(MIToken::comma) ||
827 parseCFIOffset(Offset))
829 // NB: MCCFIInstruction::createDefCfa negates the offset.
831 MMI.addFrameInst(MCCFIInstruction::createDefCfa(nullptr, Reg, -Offset));
834 // TODO: Parse the other CFI operands.
835 llvm_unreachable("The current token should be a cfi operand");
837 Dest = MachineOperand::CreateCFIIndex(CFIIndex);
841 bool MIParser::parseIRBlock(BasicBlock *&BB, const Function &F) {
842 switch (Token.kind()) {
843 case MIToken::NamedIRBlock: {
844 BB = dyn_cast_or_null<BasicBlock>(
845 F.getValueSymbolTable().lookup(Token.stringValue()));
847 return error(Twine("use of undefined IR block '%ir-block.") +
848 Token.rawStringValue() + "'");
851 case MIToken::IRBlock: {
852 unsigned SlotNumber = 0;
853 if (getUnsigned(SlotNumber))
855 BB = const_cast<BasicBlock *>(getIRBlock(SlotNumber));
857 return error(Twine("use of undefined IR block '%ir-block.") +
858 Twine(SlotNumber) + "'");
862 llvm_unreachable("The current token should be an IR block reference");
867 bool MIParser::parseBlockAddressOperand(MachineOperand &Dest) {
868 assert(Token.is(MIToken::kw_blockaddress));
870 if (expectAndConsume(MIToken::lparen))
872 if (Token.isNot(MIToken::GlobalValue) &&
873 Token.isNot(MIToken::NamedGlobalValue))
874 return error("expected a global value");
875 GlobalValue *GV = nullptr;
876 if (parseGlobalValue(GV))
878 auto *F = dyn_cast<Function>(GV);
880 return error("expected an IR function reference");
882 if (expectAndConsume(MIToken::comma))
884 BasicBlock *BB = nullptr;
885 if (Token.isNot(MIToken::IRBlock) && Token.isNot(MIToken::NamedIRBlock))
886 return error("expected an IR block reference");
887 if (parseIRBlock(BB, *F))
890 if (expectAndConsume(MIToken::rparen))
892 // TODO: parse the target flags.
893 Dest = MachineOperand::CreateBA(BlockAddress::get(F, BB), /*Offset=*/0);
894 if (parseOperandsOffset(Dest))
899 bool MIParser::parseTargetIndexOperand(MachineOperand &Dest) {
900 assert(Token.is(MIToken::kw_target_index));
902 if (expectAndConsume(MIToken::lparen))
904 if (Token.isNot(MIToken::Identifier))
905 return error("expected the name of the target index");
907 if (getTargetIndex(Token.stringValue(), Index))
908 return error("use of undefined target index '" + Token.stringValue() + "'");
910 if (expectAndConsume(MIToken::rparen))
912 // TODO: Parse the target flags.
913 Dest = MachineOperand::CreateTargetIndex(unsigned(Index), /*Offset=*/0);
914 if (parseOperandsOffset(Dest))
919 bool MIParser::parseMachineOperand(MachineOperand &Dest) {
920 switch (Token.kind()) {
921 case MIToken::kw_implicit:
922 case MIToken::kw_implicit_define:
923 case MIToken::kw_dead:
924 case MIToken::kw_killed:
925 case MIToken::kw_undef:
926 case MIToken::kw_early_clobber:
927 case MIToken::kw_debug_use:
928 case MIToken::underscore:
929 case MIToken::NamedRegister:
930 case MIToken::VirtualRegister:
931 return parseRegisterOperand(Dest);
932 case MIToken::IntegerLiteral:
933 return parseImmediateOperand(Dest);
934 case MIToken::IntegerType:
935 return parseTypedImmediateOperand(Dest);
936 case MIToken::kw_half:
937 case MIToken::kw_float:
938 case MIToken::kw_double:
939 case MIToken::kw_x86_fp80:
940 case MIToken::kw_fp128:
941 case MIToken::kw_ppc_fp128:
942 return parseFPImmediateOperand(Dest);
943 case MIToken::MachineBasicBlock:
944 return parseMBBOperand(Dest);
945 case MIToken::StackObject:
946 return parseStackObjectOperand(Dest);
947 case MIToken::FixedStackObject:
948 return parseFixedStackObjectOperand(Dest);
949 case MIToken::GlobalValue:
950 case MIToken::NamedGlobalValue:
951 return parseGlobalAddressOperand(Dest);
952 case MIToken::ConstantPoolItem:
953 return parseConstantPoolIndexOperand(Dest);
954 case MIToken::JumpTableIndex:
955 return parseJumpTableIndexOperand(Dest);
956 case MIToken::ExternalSymbol:
957 return parseExternalSymbolOperand(Dest);
958 case MIToken::exclaim:
959 return parseMetadataOperand(Dest);
960 case MIToken::kw_cfi_offset:
961 case MIToken::kw_cfi_def_cfa_register:
962 case MIToken::kw_cfi_def_cfa_offset:
963 case MIToken::kw_cfi_def_cfa:
964 return parseCFIOperand(Dest);
965 case MIToken::kw_blockaddress:
966 return parseBlockAddressOperand(Dest);
967 case MIToken::kw_target_index:
968 return parseTargetIndexOperand(Dest);
971 case MIToken::Identifier:
972 if (const auto *RegMask = getRegMask(Token.stringValue())) {
973 Dest = MachineOperand::CreateRegMask(RegMask);
979 // TODO: parse the other machine operands.
980 return error("expected a machine operand");
985 bool MIParser::parseOperandsOffset(MachineOperand &Op) {
986 if (Token.isNot(MIToken::plus) && Token.isNot(MIToken::minus))
988 StringRef Sign = Token.stringValue();
989 bool IsNegative = Token.is(MIToken::minus);
991 if (Token.isNot(MIToken::IntegerLiteral))
992 return error("expected an integer literal after '" + Sign + "'");
993 if (Token.integerValue().getMinSignedBits() > 64)
994 return error("expected 64-bit integer (too large)");
995 int64_t Offset = Token.integerValue().getExtValue();
999 Op.setOffset(Offset);
1003 bool MIParser::parseIRValue(Value *&V) {
1004 switch (Token.kind()) {
1005 case MIToken::NamedIRValue: {
1006 V = MF.getFunction()->getValueSymbolTable().lookup(Token.stringValue());
1008 return error(Twine("use of undefined IR value '%ir.") +
1009 Token.rawStringValue() + "'");
1012 // TODO: Parse unnamed IR value references.
1014 llvm_unreachable("The current token should be an IR block reference");
1019 bool MIParser::getUint64(uint64_t &Result) {
1020 assert(Token.hasIntegerValue());
1021 if (Token.integerValue().getActiveBits() > 64)
1022 return error("expected 64-bit integer (too large)");
1023 Result = Token.integerValue().getZExtValue();
1027 bool MIParser::parseMemoryOperandFlag(unsigned &Flags) {
1028 switch (Token.kind()) {
1029 case MIToken::kw_volatile:
1030 Flags |= MachineMemOperand::MOVolatile;
1032 // TODO: report an error when we specify the same flag more than once.
1033 // TODO: parse the other memory operand flags.
1035 llvm_unreachable("The current token should be a memory operand flag");
1041 bool MIParser::parseMachineMemoryOperand(MachineMemOperand *&Dest) {
1042 if (expectAndConsume(MIToken::lparen))
1045 while (Token.isMemoryOperandFlag()) {
1046 if (parseMemoryOperandFlag(Flags))
1049 if (Token.isNot(MIToken::Identifier) ||
1050 (Token.stringValue() != "load" && Token.stringValue() != "store"))
1051 return error("expected 'load' or 'store' memory operation");
1052 if (Token.stringValue() == "load")
1053 Flags |= MachineMemOperand::MOLoad;
1055 Flags |= MachineMemOperand::MOStore;
1058 if (Token.isNot(MIToken::IntegerLiteral))
1059 return error("expected the size integer literal after memory operation");
1061 if (getUint64(Size))
1065 const char *Word = Flags & MachineMemOperand::MOLoad ? "from" : "into";
1066 if (Token.isNot(MIToken::Identifier) || Token.stringValue() != Word)
1067 return error(Twine("expected '") + Word + "'");
1070 // TODO: Parse pseudo source values.
1071 if (Token.isNot(MIToken::NamedIRValue))
1072 return error("expected an IR value reference");
1074 if (parseIRValue(V))
1076 if (!V->getType()->isPointerTy())
1077 return error("expected a pointer IR value");
1079 // TODO: Parse the base alignment.
1080 // TODO: Parse the attached metadata nodes.
1081 if (expectAndConsume(MIToken::rparen))
1084 Dest = MF.getMachineMemOperand(MachinePointerInfo(V), Flags, Size, Size);
1088 void MIParser::initNames2InstrOpCodes() {
1089 if (!Names2InstrOpCodes.empty())
1091 const auto *TII = MF.getSubtarget().getInstrInfo();
1092 assert(TII && "Expected target instruction info");
1093 for (unsigned I = 0, E = TII->getNumOpcodes(); I < E; ++I)
1094 Names2InstrOpCodes.insert(std::make_pair(StringRef(TII->getName(I)), I));
1097 bool MIParser::parseInstrName(StringRef InstrName, unsigned &OpCode) {
1098 initNames2InstrOpCodes();
1099 auto InstrInfo = Names2InstrOpCodes.find(InstrName);
1100 if (InstrInfo == Names2InstrOpCodes.end())
1102 OpCode = InstrInfo->getValue();
1106 void MIParser::initNames2Regs() {
1107 if (!Names2Regs.empty())
1109 // The '%noreg' register is the register 0.
1110 Names2Regs.insert(std::make_pair("noreg", 0));
1111 const auto *TRI = MF.getSubtarget().getRegisterInfo();
1112 assert(TRI && "Expected target register info");
1113 for (unsigned I = 0, E = TRI->getNumRegs(); I < E; ++I) {
1115 Names2Regs.insert(std::make_pair(StringRef(TRI->getName(I)).lower(), I))
1118 assert(WasInserted && "Expected registers to be unique case-insensitively");
1122 bool MIParser::getRegisterByName(StringRef RegName, unsigned &Reg) {
1124 auto RegInfo = Names2Regs.find(RegName);
1125 if (RegInfo == Names2Regs.end())
1127 Reg = RegInfo->getValue();
1131 void MIParser::initNames2RegMasks() {
1132 if (!Names2RegMasks.empty())
1134 const auto *TRI = MF.getSubtarget().getRegisterInfo();
1135 assert(TRI && "Expected target register info");
1136 ArrayRef<const uint32_t *> RegMasks = TRI->getRegMasks();
1137 ArrayRef<const char *> RegMaskNames = TRI->getRegMaskNames();
1138 assert(RegMasks.size() == RegMaskNames.size());
1139 for (size_t I = 0, E = RegMasks.size(); I < E; ++I)
1140 Names2RegMasks.insert(
1141 std::make_pair(StringRef(RegMaskNames[I]).lower(), RegMasks[I]));
1144 const uint32_t *MIParser::getRegMask(StringRef Identifier) {
1145 initNames2RegMasks();
1146 auto RegMaskInfo = Names2RegMasks.find(Identifier);
1147 if (RegMaskInfo == Names2RegMasks.end())
1149 return RegMaskInfo->getValue();
1152 void MIParser::initNames2SubRegIndices() {
1153 if (!Names2SubRegIndices.empty())
1155 const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
1156 for (unsigned I = 1, E = TRI->getNumSubRegIndices(); I < E; ++I)
1157 Names2SubRegIndices.insert(
1158 std::make_pair(StringRef(TRI->getSubRegIndexName(I)).lower(), I));
1161 unsigned MIParser::getSubRegIndex(StringRef Name) {
1162 initNames2SubRegIndices();
1163 auto SubRegInfo = Names2SubRegIndices.find(Name);
1164 if (SubRegInfo == Names2SubRegIndices.end())
1166 return SubRegInfo->getValue();
1169 void MIParser::initSlots2BasicBlocks() {
1170 if (!Slots2BasicBlocks.empty())
1172 const auto &F = *MF.getFunction();
1173 ModuleSlotTracker MST(F.getParent());
1174 MST.incorporateFunction(F);
1175 for (auto &BB : F) {
1178 int Slot = MST.getLocalSlot(&BB);
1181 Slots2BasicBlocks.insert(std::make_pair(unsigned(Slot), &BB));
1185 const BasicBlock *MIParser::getIRBlock(unsigned Slot) {
1186 initSlots2BasicBlocks();
1187 auto BlockInfo = Slots2BasicBlocks.find(Slot);
1188 if (BlockInfo == Slots2BasicBlocks.end())
1190 return BlockInfo->second;
1193 void MIParser::initNames2TargetIndices() {
1194 if (!Names2TargetIndices.empty())
1196 const auto *TII = MF.getSubtarget().getInstrInfo();
1197 assert(TII && "Expected target instruction info");
1198 auto Indices = TII->getSerializableTargetIndices();
1199 for (const auto &I : Indices)
1200 Names2TargetIndices.insert(std::make_pair(StringRef(I.second), I.first));
1203 bool MIParser::getTargetIndex(StringRef Name, int &Index) {
1204 initNames2TargetIndices();
1205 auto IndexInfo = Names2TargetIndices.find(Name);
1206 if (IndexInfo == Names2TargetIndices.end())
1208 Index = IndexInfo->second;
1212 bool llvm::parseMachineInstr(MachineInstr *&MI, SourceMgr &SM,
1213 MachineFunction &MF, StringRef Src,
1214 const PerFunctionMIParsingState &PFS,
1215 const SlotMapping &IRSlots, SMDiagnostic &Error) {
1216 return MIParser(SM, MF, Error, Src, PFS, IRSlots).parse(MI);
1219 bool llvm::parseMBBReference(MachineBasicBlock *&MBB, SourceMgr &SM,
1220 MachineFunction &MF, StringRef Src,
1221 const PerFunctionMIParsingState &PFS,
1222 const SlotMapping &IRSlots, SMDiagnostic &Error) {
1223 return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseStandaloneMBB(MBB);
1226 bool llvm::parseNamedRegisterReference(unsigned &Reg, SourceMgr &SM,
1227 MachineFunction &MF, StringRef Src,
1228 const PerFunctionMIParsingState &PFS,
1229 const SlotMapping &IRSlots,
1230 SMDiagnostic &Error) {
1231 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1232 .parseStandaloneNamedRegister(Reg);
1235 bool llvm::parseVirtualRegisterReference(unsigned &Reg, SourceMgr &SM,
1236 MachineFunction &MF, StringRef Src,
1237 const PerFunctionMIParsingState &PFS,
1238 const SlotMapping &IRSlots,
1239 SMDiagnostic &Error) {
1240 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1241 .parseStandaloneVirtualRegister(Reg);
1244 bool llvm::parseIRBlockReference(const BasicBlock *&BB, SourceMgr &SM,
1245 MachineFunction &MF, StringRef Src,
1246 const PerFunctionMIParsingState &PFS,
1247 const SlotMapping &IRSlots,
1248 SMDiagnostic &Error) {
1249 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1250 .parseStandaloneIRBlockReference(BB);