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;
73 /// Maps from direct target flag names to the direct target flag values.
74 StringMap<unsigned> Names2DirectTargetFlags;
77 MIParser(SourceMgr &SM, MachineFunction &MF, SMDiagnostic &Error,
78 StringRef Source, const PerFunctionMIParsingState &PFS,
79 const SlotMapping &IRSlots);
83 /// Report an error at the current location with the given message.
85 /// This function always return true.
86 bool error(const Twine &Msg);
88 /// Report an error at the given location with the given message.
90 /// This function always return true.
91 bool error(StringRef::iterator Loc, const Twine &Msg);
93 bool parse(MachineInstr *&MI);
94 bool parseStandaloneMBB(MachineBasicBlock *&MBB);
95 bool parseStandaloneNamedRegister(unsigned &Reg);
96 bool parseStandaloneVirtualRegister(unsigned &Reg);
97 bool parseStandaloneIRBlockReference(const BasicBlock *&BB);
99 bool parseRegister(unsigned &Reg);
100 bool parseRegisterFlag(unsigned &Flags);
101 bool parseSubRegisterIndex(unsigned &SubReg);
102 bool parseRegisterOperand(MachineOperand &Dest, bool IsDef = false);
103 bool parseImmediateOperand(MachineOperand &Dest);
104 bool parseIRConstant(StringRef::iterator Loc, const Constant *&C);
105 bool parseTypedImmediateOperand(MachineOperand &Dest);
106 bool parseFPImmediateOperand(MachineOperand &Dest);
107 bool parseMBBReference(MachineBasicBlock *&MBB);
108 bool parseMBBOperand(MachineOperand &Dest);
109 bool parseStackObjectOperand(MachineOperand &Dest);
110 bool parseFixedStackFrameIndex(int &FI);
111 bool parseFixedStackObjectOperand(MachineOperand &Dest);
112 bool parseGlobalValue(GlobalValue *&GV);
113 bool parseGlobalAddressOperand(MachineOperand &Dest);
114 bool parseConstantPoolIndexOperand(MachineOperand &Dest);
115 bool parseJumpTableIndexOperand(MachineOperand &Dest);
116 bool parseExternalSymbolOperand(MachineOperand &Dest);
117 bool parseMDNode(MDNode *&Node);
118 bool parseMetadataOperand(MachineOperand &Dest);
119 bool parseCFIOffset(int &Offset);
120 bool parseCFIRegister(unsigned &Reg);
121 bool parseCFIOperand(MachineOperand &Dest);
122 bool parseIRBlock(BasicBlock *&BB, const Function &F);
123 bool parseBlockAddressOperand(MachineOperand &Dest);
124 bool parseTargetIndexOperand(MachineOperand &Dest);
125 bool parseLiveoutRegisterMaskOperand(MachineOperand &Dest);
126 bool parseMachineOperand(MachineOperand &Dest);
127 bool parseMachineOperandAndTargetFlags(MachineOperand &Dest);
128 bool parseOffset(int64_t &Offset);
129 bool parseOperandsOffset(MachineOperand &Op);
130 bool parseIRValue(Value *&V);
131 bool parseMemoryOperandFlag(unsigned &Flags);
132 bool parseMemoryPseudoSourceValue(const PseudoSourceValue *&PSV);
133 bool parseMachinePointerInfo(MachinePointerInfo &Dest);
134 bool parseMachineMemoryOperand(MachineMemOperand *&Dest);
137 /// Convert the integer literal in the current token into an unsigned integer.
139 /// Return true if an error occurred.
140 bool getUnsigned(unsigned &Result);
142 /// Convert the integer literal in the current token into an uint64.
144 /// Return true if an error occurred.
145 bool getUint64(uint64_t &Result);
147 /// If the current token is of the given kind, consume it and return false.
148 /// Otherwise report an error and return true.
149 bool expectAndConsume(MIToken::TokenKind TokenKind);
151 void initNames2InstrOpCodes();
153 /// Try to convert an instruction name to an opcode. Return true if the
154 /// instruction name is invalid.
155 bool parseInstrName(StringRef InstrName, unsigned &OpCode);
157 bool parseInstruction(unsigned &OpCode, unsigned &Flags);
159 bool verifyImplicitOperands(ArrayRef<MachineOperandWithLocation> Operands,
160 const MCInstrDesc &MCID);
162 void initNames2Regs();
164 /// Try to convert a register name to a register number. Return true if the
165 /// register name is invalid.
166 bool getRegisterByName(StringRef RegName, unsigned &Reg);
168 void initNames2RegMasks();
170 /// Check if the given identifier is a name of a register mask.
172 /// Return null if the identifier isn't a register mask.
173 const uint32_t *getRegMask(StringRef Identifier);
175 void initNames2SubRegIndices();
177 /// Check if the given identifier is a name of a subregister index.
179 /// Return 0 if the name isn't a subregister index class.
180 unsigned getSubRegIndex(StringRef Name);
182 const BasicBlock *getIRBlock(unsigned Slot);
183 const BasicBlock *getIRBlock(unsigned Slot, const Function &F);
185 void initNames2TargetIndices();
187 /// Try to convert a name of target index to the corresponding target index.
189 /// Return true if the name isn't a name of a target index.
190 bool getTargetIndex(StringRef Name, int &Index);
192 void initNames2DirectTargetFlags();
194 /// Try to convert a name of a direct target flag to the corresponding
197 /// Return true if the name isn't a name of a direct flag.
198 bool getDirectTargetFlag(StringRef Name, unsigned &Flag);
201 } // end anonymous namespace
203 MIParser::MIParser(SourceMgr &SM, MachineFunction &MF, SMDiagnostic &Error,
204 StringRef Source, const PerFunctionMIParsingState &PFS,
205 const SlotMapping &IRSlots)
206 : SM(SM), MF(MF), Error(Error), Source(Source), CurrentSource(Source),
207 PFS(PFS), IRSlots(IRSlots) {}
209 void MIParser::lex() {
210 CurrentSource = lexMIToken(
211 CurrentSource, Token,
212 [this](StringRef::iterator Loc, const Twine &Msg) { error(Loc, Msg); });
215 bool MIParser::error(const Twine &Msg) { return error(Token.location(), Msg); }
217 bool MIParser::error(StringRef::iterator Loc, const Twine &Msg) {
218 assert(Loc >= Source.data() && Loc <= (Source.data() + Source.size()));
219 Error = SMDiagnostic(
221 SM.getMemoryBuffer(SM.getMainFileID())->getBufferIdentifier(), 1,
222 Loc - Source.data(), SourceMgr::DK_Error, Msg.str(), Source, None, None);
226 static const char *toString(MIToken::TokenKind TokenKind) {
232 case MIToken::lparen:
234 case MIToken::rparen:
237 return "<unknown token>";
241 bool MIParser::expectAndConsume(MIToken::TokenKind TokenKind) {
242 if (Token.isNot(TokenKind))
243 return error(Twine("expected ") + toString(TokenKind));
248 bool MIParser::parse(MachineInstr *&MI) {
251 // Parse any register operands before '='
252 MachineOperand MO = MachineOperand::CreateImm(0);
253 SmallVector<MachineOperandWithLocation, 8> Operands;
254 while (Token.isRegister() || Token.isRegisterFlag()) {
255 auto Loc = Token.location();
256 if (parseRegisterOperand(MO, /*IsDef=*/true))
258 Operands.push_back(MachineOperandWithLocation(MO, Loc, Token.location()));
259 if (Token.isNot(MIToken::comma))
263 if (!Operands.empty() && expectAndConsume(MIToken::equal))
266 unsigned OpCode, Flags = 0;
267 if (Token.isError() || parseInstruction(OpCode, Flags))
270 // TODO: Parse the bundle instruction flags.
272 // Parse the remaining machine operands.
273 while (Token.isNot(MIToken::Eof) && Token.isNot(MIToken::kw_debug_location) &&
274 Token.isNot(MIToken::coloncolon)) {
275 auto Loc = Token.location();
276 if (parseMachineOperandAndTargetFlags(MO))
278 Operands.push_back(MachineOperandWithLocation(MO, Loc, Token.location()));
279 if (Token.is(MIToken::Eof) || Token.is(MIToken::coloncolon))
281 if (Token.isNot(MIToken::comma))
282 return error("expected ',' before the next machine operand");
286 DebugLoc DebugLocation;
287 if (Token.is(MIToken::kw_debug_location)) {
289 if (Token.isNot(MIToken::exclaim))
290 return error("expected a metadata node after 'debug-location'");
291 MDNode *Node = nullptr;
292 if (parseMDNode(Node))
294 DebugLocation = DebugLoc(Node);
297 // Parse the machine memory operands.
298 SmallVector<MachineMemOperand *, 2> MemOperands;
299 if (Token.is(MIToken::coloncolon)) {
301 while (Token.isNot(MIToken::Eof)) {
302 MachineMemOperand *MemOp = nullptr;
303 if (parseMachineMemoryOperand(MemOp))
305 MemOperands.push_back(MemOp);
306 if (Token.is(MIToken::Eof))
308 if (Token.isNot(MIToken::comma))
309 return error("expected ',' before the next machine memory operand");
314 const auto &MCID = MF.getSubtarget().getInstrInfo()->get(OpCode);
315 if (!MCID.isVariadic()) {
316 // FIXME: Move the implicit operand verification to the machine verifier.
317 if (verifyImplicitOperands(Operands, MCID))
321 // TODO: Check for extraneous machine operands.
322 MI = MF.CreateMachineInstr(MCID, DebugLocation, /*NoImplicit=*/true);
324 for (const auto &Operand : Operands)
325 MI->addOperand(MF, Operand.Operand);
326 if (MemOperands.empty())
328 MachineInstr::mmo_iterator MemRefs =
329 MF.allocateMemRefsArray(MemOperands.size());
330 std::copy(MemOperands.begin(), MemOperands.end(), MemRefs);
331 MI->setMemRefs(MemRefs, MemRefs + MemOperands.size());
335 bool MIParser::parseStandaloneMBB(MachineBasicBlock *&MBB) {
337 if (Token.isNot(MIToken::MachineBasicBlock))
338 return error("expected a machine basic block reference");
339 if (parseMBBReference(MBB))
342 if (Token.isNot(MIToken::Eof))
344 "expected end of string after the machine basic block reference");
348 bool MIParser::parseStandaloneNamedRegister(unsigned &Reg) {
350 if (Token.isNot(MIToken::NamedRegister))
351 return error("expected a named register");
352 if (parseRegister(Reg))
355 if (Token.isNot(MIToken::Eof))
356 return error("expected end of string after the register reference");
360 bool MIParser::parseStandaloneVirtualRegister(unsigned &Reg) {
362 if (Token.isNot(MIToken::VirtualRegister))
363 return error("expected a virtual register");
364 if (parseRegister(Reg))
367 if (Token.isNot(MIToken::Eof))
368 return error("expected end of string after the register reference");
372 bool MIParser::parseStandaloneIRBlockReference(const BasicBlock *&BB) {
374 if (Token.isNot(MIToken::IRBlock))
375 return error("expected an IR block reference");
376 unsigned SlotNumber = 0;
377 if (getUnsigned(SlotNumber))
379 BB = getIRBlock(SlotNumber);
381 return error(Twine("use of undefined IR block '%ir-block.") +
382 Twine(SlotNumber) + "'");
384 if (Token.isNot(MIToken::Eof))
385 return error("expected end of string after the IR block reference");
389 static const char *printImplicitRegisterFlag(const MachineOperand &MO) {
390 assert(MO.isImplicit());
391 return MO.isDef() ? "implicit-def" : "implicit";
394 static std::string getRegisterName(const TargetRegisterInfo *TRI,
396 assert(TargetRegisterInfo::isPhysicalRegister(Reg) && "expected phys reg");
397 return StringRef(TRI->getName(Reg)).lower();
400 bool MIParser::verifyImplicitOperands(
401 ArrayRef<MachineOperandWithLocation> Operands, const MCInstrDesc &MCID) {
403 // We can't verify call instructions as they can contain arbitrary implicit
404 // register and register mask operands.
407 // Gather all the expected implicit operands.
408 SmallVector<MachineOperand, 4> ImplicitOperands;
409 if (MCID.ImplicitDefs)
410 for (const uint16_t *ImpDefs = MCID.getImplicitDefs(); *ImpDefs; ++ImpDefs)
411 ImplicitOperands.push_back(
412 MachineOperand::CreateReg(*ImpDefs, true, true));
413 if (MCID.ImplicitUses)
414 for (const uint16_t *ImpUses = MCID.getImplicitUses(); *ImpUses; ++ImpUses)
415 ImplicitOperands.push_back(
416 MachineOperand::CreateReg(*ImpUses, false, true));
418 const auto *TRI = MF.getSubtarget().getRegisterInfo();
419 assert(TRI && "Expected target register info");
420 size_t I = ImplicitOperands.size(), J = Operands.size();
425 const auto &ImplicitOperand = ImplicitOperands[I];
426 const auto &Operand = Operands[J].Operand;
427 if (ImplicitOperand.isIdenticalTo(Operand))
429 if (Operand.isReg() && Operand.isImplicit()) {
430 return error(Operands[J].Begin,
431 Twine("expected an implicit register operand '") +
432 printImplicitRegisterFlag(ImplicitOperand) + " %" +
433 getRegisterName(TRI, ImplicitOperand.getReg()) + "'");
436 // TODO: Fix source location when Operands[J].end is right before '=', i.e:
437 // insead of reporting an error at this location:
440 // report the error at the following location:
443 return error(J < Operands.size() ? Operands[J].End : Token.location(),
444 Twine("missing implicit register operand '") +
445 printImplicitRegisterFlag(ImplicitOperands[I]) + " %" +
446 getRegisterName(TRI, ImplicitOperands[I].getReg()) + "'");
451 bool MIParser::parseInstruction(unsigned &OpCode, unsigned &Flags) {
452 if (Token.is(MIToken::kw_frame_setup)) {
453 Flags |= MachineInstr::FrameSetup;
456 if (Token.isNot(MIToken::Identifier))
457 return error("expected a machine instruction");
458 StringRef InstrName = Token.stringValue();
459 if (parseInstrName(InstrName, OpCode))
460 return error(Twine("unknown machine instruction name '") + InstrName + "'");
465 bool MIParser::parseRegister(unsigned &Reg) {
466 switch (Token.kind()) {
467 case MIToken::underscore:
470 case MIToken::NamedRegister: {
471 StringRef Name = Token.stringValue();
472 if (getRegisterByName(Name, Reg))
473 return error(Twine("unknown register name '") + Name + "'");
476 case MIToken::VirtualRegister: {
480 const auto RegInfo = PFS.VirtualRegisterSlots.find(ID);
481 if (RegInfo == PFS.VirtualRegisterSlots.end())
482 return error(Twine("use of undefined virtual register '%") + Twine(ID) +
484 Reg = RegInfo->second;
487 // TODO: Parse other register kinds.
489 llvm_unreachable("The current token should be a register");
494 bool MIParser::parseRegisterFlag(unsigned &Flags) {
495 const unsigned OldFlags = Flags;
496 switch (Token.kind()) {
497 case MIToken::kw_implicit:
498 Flags |= RegState::Implicit;
500 case MIToken::kw_implicit_define:
501 Flags |= RegState::ImplicitDefine;
503 case MIToken::kw_dead:
504 Flags |= RegState::Dead;
506 case MIToken::kw_killed:
507 Flags |= RegState::Kill;
509 case MIToken::kw_undef:
510 Flags |= RegState::Undef;
512 case MIToken::kw_early_clobber:
513 Flags |= RegState::EarlyClobber;
515 case MIToken::kw_debug_use:
516 Flags |= RegState::Debug;
518 // TODO: parse the other register flags.
520 llvm_unreachable("The current token should be a register flag");
522 if (OldFlags == Flags)
523 // We know that the same flag is specified more than once when the flags
525 return error("duplicate '" + Token.stringValue() + "' register flag");
530 bool MIParser::parseSubRegisterIndex(unsigned &SubReg) {
531 assert(Token.is(MIToken::colon));
533 if (Token.isNot(MIToken::Identifier))
534 return error("expected a subregister index after ':'");
535 auto Name = Token.stringValue();
536 SubReg = getSubRegIndex(Name);
538 return error(Twine("use of unknown subregister index '") + Name + "'");
543 bool MIParser::parseRegisterOperand(MachineOperand &Dest, bool IsDef) {
545 unsigned Flags = IsDef ? RegState::Define : 0;
546 while (Token.isRegisterFlag()) {
547 if (parseRegisterFlag(Flags))
550 if (!Token.isRegister())
551 return error("expected a register after register flags");
552 if (parseRegister(Reg))
556 if (Token.is(MIToken::colon)) {
557 if (parseSubRegisterIndex(SubReg))
560 Dest = MachineOperand::CreateReg(
561 Reg, Flags & RegState::Define, Flags & RegState::Implicit,
562 Flags & RegState::Kill, Flags & RegState::Dead, Flags & RegState::Undef,
563 Flags & RegState::EarlyClobber, SubReg, Flags & RegState::Debug);
567 bool MIParser::parseImmediateOperand(MachineOperand &Dest) {
568 assert(Token.is(MIToken::IntegerLiteral));
569 const APSInt &Int = Token.integerValue();
570 if (Int.getMinSignedBits() > 64)
571 return error("integer literal is too large to be an immediate operand");
572 Dest = MachineOperand::CreateImm(Int.getExtValue());
577 bool MIParser::parseIRConstant(StringRef::iterator Loc, const Constant *&C) {
578 auto Source = StringRef(Loc, Token.range().end() - Loc).str();
581 C = parseConstantValue(Source.c_str(), Err, *MF.getFunction()->getParent());
583 return error(Loc + Err.getColumnNo(), Err.getMessage());
587 bool MIParser::parseTypedImmediateOperand(MachineOperand &Dest) {
588 assert(Token.is(MIToken::IntegerType));
589 auto Loc = Token.location();
591 if (Token.isNot(MIToken::IntegerLiteral))
592 return error("expected an integer literal");
593 const Constant *C = nullptr;
594 if (parseIRConstant(Loc, C))
596 Dest = MachineOperand::CreateCImm(cast<ConstantInt>(C));
600 bool MIParser::parseFPImmediateOperand(MachineOperand &Dest) {
601 auto Loc = Token.location();
603 if (Token.isNot(MIToken::FloatingPointLiteral))
604 return error("expected a floating point literal");
605 const Constant *C = nullptr;
606 if (parseIRConstant(Loc, C))
608 Dest = MachineOperand::CreateFPImm(cast<ConstantFP>(C));
612 bool MIParser::getUnsigned(unsigned &Result) {
613 assert(Token.hasIntegerValue() && "Expected a token with an integer value");
614 const uint64_t Limit = uint64_t(std::numeric_limits<unsigned>::max()) + 1;
615 uint64_t Val64 = Token.integerValue().getLimitedValue(Limit);
617 return error("expected 32-bit integer (too large)");
622 bool MIParser::parseMBBReference(MachineBasicBlock *&MBB) {
623 assert(Token.is(MIToken::MachineBasicBlock));
625 if (getUnsigned(Number))
627 auto MBBInfo = PFS.MBBSlots.find(Number);
628 if (MBBInfo == PFS.MBBSlots.end())
629 return error(Twine("use of undefined machine basic block #") +
631 MBB = MBBInfo->second;
632 if (!Token.stringValue().empty() && Token.stringValue() != MBB->getName())
633 return error(Twine("the name of machine basic block #") + Twine(Number) +
634 " isn't '" + Token.stringValue() + "'");
638 bool MIParser::parseMBBOperand(MachineOperand &Dest) {
639 MachineBasicBlock *MBB;
640 if (parseMBBReference(MBB))
642 Dest = MachineOperand::CreateMBB(MBB);
647 bool MIParser::parseStackObjectOperand(MachineOperand &Dest) {
648 assert(Token.is(MIToken::StackObject));
652 auto ObjectInfo = PFS.StackObjectSlots.find(ID);
653 if (ObjectInfo == PFS.StackObjectSlots.end())
654 return error(Twine("use of undefined stack object '%stack.") + Twine(ID) +
657 if (const auto *Alloca =
658 MF.getFrameInfo()->getObjectAllocation(ObjectInfo->second))
659 Name = Alloca->getName();
660 if (!Token.stringValue().empty() && Token.stringValue() != Name)
661 return error(Twine("the name of the stack object '%stack.") + Twine(ID) +
662 "' isn't '" + Token.stringValue() + "'");
664 Dest = MachineOperand::CreateFI(ObjectInfo->second);
668 bool MIParser::parseFixedStackFrameIndex(int &FI) {
669 assert(Token.is(MIToken::FixedStackObject));
673 auto ObjectInfo = PFS.FixedStackObjectSlots.find(ID);
674 if (ObjectInfo == PFS.FixedStackObjectSlots.end())
675 return error(Twine("use of undefined fixed stack object '%fixed-stack.") +
678 FI = ObjectInfo->second;
682 bool MIParser::parseFixedStackObjectOperand(MachineOperand &Dest) {
684 if (parseFixedStackFrameIndex(FI))
686 Dest = MachineOperand::CreateFI(FI);
690 bool MIParser::parseGlobalValue(GlobalValue *&GV) {
691 switch (Token.kind()) {
692 case MIToken::NamedGlobalValue: {
693 const Module *M = MF.getFunction()->getParent();
694 GV = M->getNamedValue(Token.stringValue());
696 return error(Twine("use of undefined global value '") + Token.range() +
700 case MIToken::GlobalValue: {
702 if (getUnsigned(GVIdx))
704 if (GVIdx >= IRSlots.GlobalValues.size())
705 return error(Twine("use of undefined global value '@") + Twine(GVIdx) +
707 GV = IRSlots.GlobalValues[GVIdx];
711 llvm_unreachable("The current token should be a global value");
716 bool MIParser::parseGlobalAddressOperand(MachineOperand &Dest) {
717 GlobalValue *GV = nullptr;
718 if (parseGlobalValue(GV))
721 Dest = MachineOperand::CreateGA(GV, /*Offset=*/0);
722 if (parseOperandsOffset(Dest))
727 bool MIParser::parseConstantPoolIndexOperand(MachineOperand &Dest) {
728 assert(Token.is(MIToken::ConstantPoolItem));
732 auto ConstantInfo = PFS.ConstantPoolSlots.find(ID);
733 if (ConstantInfo == PFS.ConstantPoolSlots.end())
734 return error("use of undefined constant '%const." + Twine(ID) + "'");
736 Dest = MachineOperand::CreateCPI(ID, /*Offset=*/0);
737 if (parseOperandsOffset(Dest))
742 bool MIParser::parseJumpTableIndexOperand(MachineOperand &Dest) {
743 assert(Token.is(MIToken::JumpTableIndex));
747 auto JumpTableEntryInfo = PFS.JumpTableSlots.find(ID);
748 if (JumpTableEntryInfo == PFS.JumpTableSlots.end())
749 return error("use of undefined jump table '%jump-table." + Twine(ID) + "'");
751 Dest = MachineOperand::CreateJTI(JumpTableEntryInfo->second);
755 bool MIParser::parseExternalSymbolOperand(MachineOperand &Dest) {
756 assert(Token.is(MIToken::ExternalSymbol));
757 const char *Symbol = MF.createExternalSymbolName(Token.stringValue());
759 Dest = MachineOperand::CreateES(Symbol);
760 if (parseOperandsOffset(Dest))
765 bool MIParser::parseMDNode(MDNode *&Node) {
766 assert(Token.is(MIToken::exclaim));
767 auto Loc = Token.location();
769 if (Token.isNot(MIToken::IntegerLiteral) || Token.integerValue().isSigned())
770 return error("expected metadata id after '!'");
774 auto NodeInfo = IRSlots.MetadataNodes.find(ID);
775 if (NodeInfo == IRSlots.MetadataNodes.end())
776 return error(Loc, "use of undefined metadata '!" + Twine(ID) + "'");
778 Node = NodeInfo->second.get();
782 bool MIParser::parseMetadataOperand(MachineOperand &Dest) {
783 MDNode *Node = nullptr;
784 if (parseMDNode(Node))
786 Dest = MachineOperand::CreateMetadata(Node);
790 bool MIParser::parseCFIOffset(int &Offset) {
791 if (Token.isNot(MIToken::IntegerLiteral))
792 return error("expected a cfi offset");
793 if (Token.integerValue().getMinSignedBits() > 32)
794 return error("expected a 32 bit integer (the cfi offset is too large)");
795 Offset = (int)Token.integerValue().getExtValue();
800 bool MIParser::parseCFIRegister(unsigned &Reg) {
801 if (Token.isNot(MIToken::NamedRegister))
802 return error("expected a cfi register");
804 if (parseRegister(LLVMReg))
806 const auto *TRI = MF.getSubtarget().getRegisterInfo();
807 assert(TRI && "Expected target register info");
808 int DwarfReg = TRI->getDwarfRegNum(LLVMReg, true);
810 return error("invalid DWARF register");
811 Reg = (unsigned)DwarfReg;
816 bool MIParser::parseCFIOperand(MachineOperand &Dest) {
817 auto Kind = Token.kind();
819 auto &MMI = MF.getMMI();
824 case MIToken::kw_cfi_offset:
825 if (parseCFIRegister(Reg) || expectAndConsume(MIToken::comma) ||
826 parseCFIOffset(Offset))
829 MMI.addFrameInst(MCCFIInstruction::createOffset(nullptr, Reg, Offset));
831 case MIToken::kw_cfi_def_cfa_register:
832 if (parseCFIRegister(Reg))
835 MMI.addFrameInst(MCCFIInstruction::createDefCfaRegister(nullptr, Reg));
837 case MIToken::kw_cfi_def_cfa_offset:
838 if (parseCFIOffset(Offset))
840 // NB: MCCFIInstruction::createDefCfaOffset negates the offset.
841 CFIIndex = MMI.addFrameInst(
842 MCCFIInstruction::createDefCfaOffset(nullptr, -Offset));
844 case MIToken::kw_cfi_def_cfa:
845 if (parseCFIRegister(Reg) || expectAndConsume(MIToken::comma) ||
846 parseCFIOffset(Offset))
848 // NB: MCCFIInstruction::createDefCfa negates the offset.
850 MMI.addFrameInst(MCCFIInstruction::createDefCfa(nullptr, Reg, -Offset));
853 // TODO: Parse the other CFI operands.
854 llvm_unreachable("The current token should be a cfi operand");
856 Dest = MachineOperand::CreateCFIIndex(CFIIndex);
860 bool MIParser::parseIRBlock(BasicBlock *&BB, const Function &F) {
861 switch (Token.kind()) {
862 case MIToken::NamedIRBlock: {
863 BB = dyn_cast_or_null<BasicBlock>(
864 F.getValueSymbolTable().lookup(Token.stringValue()));
866 return error(Twine("use of undefined IR block '") + Token.range() + "'");
869 case MIToken::IRBlock: {
870 unsigned SlotNumber = 0;
871 if (getUnsigned(SlotNumber))
873 BB = const_cast<BasicBlock *>(getIRBlock(SlotNumber, F));
875 return error(Twine("use of undefined IR block '%ir-block.") +
876 Twine(SlotNumber) + "'");
880 llvm_unreachable("The current token should be an IR block reference");
885 bool MIParser::parseBlockAddressOperand(MachineOperand &Dest) {
886 assert(Token.is(MIToken::kw_blockaddress));
888 if (expectAndConsume(MIToken::lparen))
890 if (Token.isNot(MIToken::GlobalValue) &&
891 Token.isNot(MIToken::NamedGlobalValue))
892 return error("expected a global value");
893 GlobalValue *GV = nullptr;
894 if (parseGlobalValue(GV))
896 auto *F = dyn_cast<Function>(GV);
898 return error("expected an IR function reference");
900 if (expectAndConsume(MIToken::comma))
902 BasicBlock *BB = nullptr;
903 if (Token.isNot(MIToken::IRBlock) && Token.isNot(MIToken::NamedIRBlock))
904 return error("expected an IR block reference");
905 if (parseIRBlock(BB, *F))
908 if (expectAndConsume(MIToken::rparen))
910 Dest = MachineOperand::CreateBA(BlockAddress::get(F, BB), /*Offset=*/0);
911 if (parseOperandsOffset(Dest))
916 bool MIParser::parseTargetIndexOperand(MachineOperand &Dest) {
917 assert(Token.is(MIToken::kw_target_index));
919 if (expectAndConsume(MIToken::lparen))
921 if (Token.isNot(MIToken::Identifier))
922 return error("expected the name of the target index");
924 if (getTargetIndex(Token.stringValue(), Index))
925 return error("use of undefined target index '" + Token.stringValue() + "'");
927 if (expectAndConsume(MIToken::rparen))
929 Dest = MachineOperand::CreateTargetIndex(unsigned(Index), /*Offset=*/0);
930 if (parseOperandsOffset(Dest))
935 bool MIParser::parseLiveoutRegisterMaskOperand(MachineOperand &Dest) {
936 assert(Token.is(MIToken::kw_liveout));
937 const auto *TRI = MF.getSubtarget().getRegisterInfo();
938 assert(TRI && "Expected target register info");
939 uint32_t *Mask = MF.allocateRegisterMask(TRI->getNumRegs());
941 if (expectAndConsume(MIToken::lparen))
944 if (Token.isNot(MIToken::NamedRegister))
945 return error("expected a named register");
947 if (parseRegister(Reg))
950 Mask[Reg / 32] |= 1U << (Reg % 32);
951 // TODO: Report an error if the same register is used more than once.
952 if (Token.isNot(MIToken::comma))
956 if (expectAndConsume(MIToken::rparen))
958 Dest = MachineOperand::CreateRegLiveOut(Mask);
962 bool MIParser::parseMachineOperand(MachineOperand &Dest) {
963 switch (Token.kind()) {
964 case MIToken::kw_implicit:
965 case MIToken::kw_implicit_define:
966 case MIToken::kw_dead:
967 case MIToken::kw_killed:
968 case MIToken::kw_undef:
969 case MIToken::kw_early_clobber:
970 case MIToken::kw_debug_use:
971 case MIToken::underscore:
972 case MIToken::NamedRegister:
973 case MIToken::VirtualRegister:
974 return parseRegisterOperand(Dest);
975 case MIToken::IntegerLiteral:
976 return parseImmediateOperand(Dest);
977 case MIToken::IntegerType:
978 return parseTypedImmediateOperand(Dest);
979 case MIToken::kw_half:
980 case MIToken::kw_float:
981 case MIToken::kw_double:
982 case MIToken::kw_x86_fp80:
983 case MIToken::kw_fp128:
984 case MIToken::kw_ppc_fp128:
985 return parseFPImmediateOperand(Dest);
986 case MIToken::MachineBasicBlock:
987 return parseMBBOperand(Dest);
988 case MIToken::StackObject:
989 return parseStackObjectOperand(Dest);
990 case MIToken::FixedStackObject:
991 return parseFixedStackObjectOperand(Dest);
992 case MIToken::GlobalValue:
993 case MIToken::NamedGlobalValue:
994 return parseGlobalAddressOperand(Dest);
995 case MIToken::ConstantPoolItem:
996 return parseConstantPoolIndexOperand(Dest);
997 case MIToken::JumpTableIndex:
998 return parseJumpTableIndexOperand(Dest);
999 case MIToken::ExternalSymbol:
1000 return parseExternalSymbolOperand(Dest);
1001 case MIToken::exclaim:
1002 return parseMetadataOperand(Dest);
1003 case MIToken::kw_cfi_offset:
1004 case MIToken::kw_cfi_def_cfa_register:
1005 case MIToken::kw_cfi_def_cfa_offset:
1006 case MIToken::kw_cfi_def_cfa:
1007 return parseCFIOperand(Dest);
1008 case MIToken::kw_blockaddress:
1009 return parseBlockAddressOperand(Dest);
1010 case MIToken::kw_target_index:
1011 return parseTargetIndexOperand(Dest);
1012 case MIToken::kw_liveout:
1013 return parseLiveoutRegisterMaskOperand(Dest);
1014 case MIToken::Error:
1016 case MIToken::Identifier:
1017 if (const auto *RegMask = getRegMask(Token.stringValue())) {
1018 Dest = MachineOperand::CreateRegMask(RegMask);
1024 // TODO: parse the other machine operands.
1025 return error("expected a machine operand");
1030 bool MIParser::parseMachineOperandAndTargetFlags(MachineOperand &Dest) {
1032 bool HasTargetFlags = false;
1033 if (Token.is(MIToken::kw_target_flags)) {
1034 HasTargetFlags = true;
1036 if (expectAndConsume(MIToken::lparen))
1038 if (Token.isNot(MIToken::Identifier))
1039 return error("expected the name of the target flag");
1040 if (getDirectTargetFlag(Token.stringValue(), TF))
1041 return error("use of undefined target flag '" + Token.stringValue() +
1044 // TODO: Parse target's bit target flags.
1045 if (expectAndConsume(MIToken::rparen))
1048 auto Loc = Token.location();
1049 if (parseMachineOperand(Dest))
1051 if (!HasTargetFlags)
1054 return error(Loc, "register operands can't have target flags");
1055 Dest.setTargetFlags(TF);
1059 bool MIParser::parseOffset(int64_t &Offset) {
1060 if (Token.isNot(MIToken::plus) && Token.isNot(MIToken::minus))
1062 StringRef Sign = Token.range();
1063 bool IsNegative = Token.is(MIToken::minus);
1065 if (Token.isNot(MIToken::IntegerLiteral))
1066 return error("expected an integer literal after '" + Sign + "'");
1067 if (Token.integerValue().getMinSignedBits() > 64)
1068 return error("expected 64-bit integer (too large)");
1069 Offset = Token.integerValue().getExtValue();
1076 bool MIParser::parseOperandsOffset(MachineOperand &Op) {
1078 if (parseOffset(Offset))
1080 Op.setOffset(Offset);
1084 bool MIParser::parseIRValue(Value *&V) {
1085 switch (Token.kind()) {
1086 case MIToken::NamedIRValue: {
1087 V = MF.getFunction()->getValueSymbolTable().lookup(Token.stringValue());
1089 return error(Twine("use of undefined IR value '") + Token.range() + "'");
1092 // TODO: Parse unnamed IR value references.
1094 llvm_unreachable("The current token should be an IR block reference");
1099 bool MIParser::getUint64(uint64_t &Result) {
1100 assert(Token.hasIntegerValue());
1101 if (Token.integerValue().getActiveBits() > 64)
1102 return error("expected 64-bit integer (too large)");
1103 Result = Token.integerValue().getZExtValue();
1107 bool MIParser::parseMemoryOperandFlag(unsigned &Flags) {
1108 const unsigned OldFlags = Flags;
1109 switch (Token.kind()) {
1110 case MIToken::kw_volatile:
1111 Flags |= MachineMemOperand::MOVolatile;
1113 case MIToken::kw_non_temporal:
1114 Flags |= MachineMemOperand::MONonTemporal;
1116 case MIToken::kw_invariant:
1117 Flags |= MachineMemOperand::MOInvariant;
1119 // TODO: parse the target specific memory operand flags.
1121 llvm_unreachable("The current token should be a memory operand flag");
1123 if (OldFlags == Flags)
1124 // We know that the same flag is specified more than once when the flags
1125 // weren't modified.
1126 return error("duplicate '" + Token.stringValue() + "' memory operand flag");
1131 bool MIParser::parseMemoryPseudoSourceValue(const PseudoSourceValue *&PSV) {
1132 switch (Token.kind()) {
1133 case MIToken::kw_stack:
1134 PSV = MF.getPSVManager().getStack();
1136 case MIToken::kw_got:
1137 PSV = MF.getPSVManager().getGOT();
1139 case MIToken::kw_jump_table:
1140 PSV = MF.getPSVManager().getJumpTable();
1142 case MIToken::kw_constant_pool:
1143 PSV = MF.getPSVManager().getConstantPool();
1145 // TODO: Parse the other pseudo source values.
1147 llvm_unreachable("The current token should be pseudo source value");
1153 bool MIParser::parseMachinePointerInfo(MachinePointerInfo &Dest) {
1154 if (Token.is(MIToken::kw_constant_pool) || Token.is(MIToken::kw_stack) ||
1155 Token.is(MIToken::kw_got) || Token.is(MIToken::kw_jump_table)) {
1156 const PseudoSourceValue *PSV = nullptr;
1157 if (parseMemoryPseudoSourceValue(PSV))
1160 if (parseOffset(Offset))
1162 Dest = MachinePointerInfo(PSV, Offset);
1165 if (Token.isNot(MIToken::NamedIRValue))
1166 return error("expected an IR value reference");
1168 if (parseIRValue(V))
1170 if (!V->getType()->isPointerTy())
1171 return error("expected a pointer IR value");
1174 if (parseOffset(Offset))
1176 Dest = MachinePointerInfo(V, Offset);
1180 bool MIParser::parseMachineMemoryOperand(MachineMemOperand *&Dest) {
1181 if (expectAndConsume(MIToken::lparen))
1184 while (Token.isMemoryOperandFlag()) {
1185 if (parseMemoryOperandFlag(Flags))
1188 if (Token.isNot(MIToken::Identifier) ||
1189 (Token.stringValue() != "load" && Token.stringValue() != "store"))
1190 return error("expected 'load' or 'store' memory operation");
1191 if (Token.stringValue() == "load")
1192 Flags |= MachineMemOperand::MOLoad;
1194 Flags |= MachineMemOperand::MOStore;
1197 if (Token.isNot(MIToken::IntegerLiteral))
1198 return error("expected the size integer literal after memory operation");
1200 if (getUint64(Size))
1204 const char *Word = Flags & MachineMemOperand::MOLoad ? "from" : "into";
1205 if (Token.isNot(MIToken::Identifier) || Token.stringValue() != Word)
1206 return error(Twine("expected '") + Word + "'");
1209 MachinePointerInfo Ptr = MachinePointerInfo();
1210 if (parseMachinePointerInfo(Ptr))
1212 unsigned BaseAlignment = Size;
1213 if (Token.is(MIToken::comma)) {
1215 if (Token.isNot(MIToken::kw_align))
1216 return error("expected 'align'");
1218 if (Token.isNot(MIToken::IntegerLiteral))
1219 return error("expected an integer literal after 'align'");
1220 if (getUnsigned(BaseAlignment))
1224 // TODO: Parse the attached metadata nodes.
1225 if (expectAndConsume(MIToken::rparen))
1227 Dest = MF.getMachineMemOperand(Ptr, Flags, Size, BaseAlignment);
1231 void MIParser::initNames2InstrOpCodes() {
1232 if (!Names2InstrOpCodes.empty())
1234 const auto *TII = MF.getSubtarget().getInstrInfo();
1235 assert(TII && "Expected target instruction info");
1236 for (unsigned I = 0, E = TII->getNumOpcodes(); I < E; ++I)
1237 Names2InstrOpCodes.insert(std::make_pair(StringRef(TII->getName(I)), I));
1240 bool MIParser::parseInstrName(StringRef InstrName, unsigned &OpCode) {
1241 initNames2InstrOpCodes();
1242 auto InstrInfo = Names2InstrOpCodes.find(InstrName);
1243 if (InstrInfo == Names2InstrOpCodes.end())
1245 OpCode = InstrInfo->getValue();
1249 void MIParser::initNames2Regs() {
1250 if (!Names2Regs.empty())
1252 // The '%noreg' register is the register 0.
1253 Names2Regs.insert(std::make_pair("noreg", 0));
1254 const auto *TRI = MF.getSubtarget().getRegisterInfo();
1255 assert(TRI && "Expected target register info");
1256 for (unsigned I = 0, E = TRI->getNumRegs(); I < E; ++I) {
1258 Names2Regs.insert(std::make_pair(StringRef(TRI->getName(I)).lower(), I))
1261 assert(WasInserted && "Expected registers to be unique case-insensitively");
1265 bool MIParser::getRegisterByName(StringRef RegName, unsigned &Reg) {
1267 auto RegInfo = Names2Regs.find(RegName);
1268 if (RegInfo == Names2Regs.end())
1270 Reg = RegInfo->getValue();
1274 void MIParser::initNames2RegMasks() {
1275 if (!Names2RegMasks.empty())
1277 const auto *TRI = MF.getSubtarget().getRegisterInfo();
1278 assert(TRI && "Expected target register info");
1279 ArrayRef<const uint32_t *> RegMasks = TRI->getRegMasks();
1280 ArrayRef<const char *> RegMaskNames = TRI->getRegMaskNames();
1281 assert(RegMasks.size() == RegMaskNames.size());
1282 for (size_t I = 0, E = RegMasks.size(); I < E; ++I)
1283 Names2RegMasks.insert(
1284 std::make_pair(StringRef(RegMaskNames[I]).lower(), RegMasks[I]));
1287 const uint32_t *MIParser::getRegMask(StringRef Identifier) {
1288 initNames2RegMasks();
1289 auto RegMaskInfo = Names2RegMasks.find(Identifier);
1290 if (RegMaskInfo == Names2RegMasks.end())
1292 return RegMaskInfo->getValue();
1295 void MIParser::initNames2SubRegIndices() {
1296 if (!Names2SubRegIndices.empty())
1298 const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
1299 for (unsigned I = 1, E = TRI->getNumSubRegIndices(); I < E; ++I)
1300 Names2SubRegIndices.insert(
1301 std::make_pair(StringRef(TRI->getSubRegIndexName(I)).lower(), I));
1304 unsigned MIParser::getSubRegIndex(StringRef Name) {
1305 initNames2SubRegIndices();
1306 auto SubRegInfo = Names2SubRegIndices.find(Name);
1307 if (SubRegInfo == Names2SubRegIndices.end())
1309 return SubRegInfo->getValue();
1312 static void initSlots2BasicBlocks(
1314 DenseMap<unsigned, const BasicBlock *> &Slots2BasicBlocks) {
1315 ModuleSlotTracker MST(F.getParent(), /*ShouldInitializeAllMetadata=*/false);
1316 MST.incorporateFunction(F);
1317 for (auto &BB : F) {
1320 int Slot = MST.getLocalSlot(&BB);
1323 Slots2BasicBlocks.insert(std::make_pair(unsigned(Slot), &BB));
1327 static const BasicBlock *getIRBlockFromSlot(
1329 const DenseMap<unsigned, const BasicBlock *> &Slots2BasicBlocks) {
1330 auto BlockInfo = Slots2BasicBlocks.find(Slot);
1331 if (BlockInfo == Slots2BasicBlocks.end())
1333 return BlockInfo->second;
1336 const BasicBlock *MIParser::getIRBlock(unsigned Slot) {
1337 if (Slots2BasicBlocks.empty())
1338 initSlots2BasicBlocks(*MF.getFunction(), Slots2BasicBlocks);
1339 return getIRBlockFromSlot(Slot, Slots2BasicBlocks);
1342 const BasicBlock *MIParser::getIRBlock(unsigned Slot, const Function &F) {
1343 if (&F == MF.getFunction())
1344 return getIRBlock(Slot);
1345 DenseMap<unsigned, const BasicBlock *> CustomSlots2BasicBlocks;
1346 initSlots2BasicBlocks(F, CustomSlots2BasicBlocks);
1347 return getIRBlockFromSlot(Slot, CustomSlots2BasicBlocks);
1350 void MIParser::initNames2TargetIndices() {
1351 if (!Names2TargetIndices.empty())
1353 const auto *TII = MF.getSubtarget().getInstrInfo();
1354 assert(TII && "Expected target instruction info");
1355 auto Indices = TII->getSerializableTargetIndices();
1356 for (const auto &I : Indices)
1357 Names2TargetIndices.insert(std::make_pair(StringRef(I.second), I.first));
1360 bool MIParser::getTargetIndex(StringRef Name, int &Index) {
1361 initNames2TargetIndices();
1362 auto IndexInfo = Names2TargetIndices.find(Name);
1363 if (IndexInfo == Names2TargetIndices.end())
1365 Index = IndexInfo->second;
1369 void MIParser::initNames2DirectTargetFlags() {
1370 if (!Names2DirectTargetFlags.empty())
1372 const auto *TII = MF.getSubtarget().getInstrInfo();
1373 assert(TII && "Expected target instruction info");
1374 auto Flags = TII->getSerializableDirectMachineOperandTargetFlags();
1375 for (const auto &I : Flags)
1376 Names2DirectTargetFlags.insert(
1377 std::make_pair(StringRef(I.second), I.first));
1380 bool MIParser::getDirectTargetFlag(StringRef Name, unsigned &Flag) {
1381 initNames2DirectTargetFlags();
1382 auto FlagInfo = Names2DirectTargetFlags.find(Name);
1383 if (FlagInfo == Names2DirectTargetFlags.end())
1385 Flag = FlagInfo->second;
1389 bool llvm::parseMachineInstr(MachineInstr *&MI, SourceMgr &SM,
1390 MachineFunction &MF, StringRef Src,
1391 const PerFunctionMIParsingState &PFS,
1392 const SlotMapping &IRSlots, SMDiagnostic &Error) {
1393 return MIParser(SM, MF, Error, Src, PFS, IRSlots).parse(MI);
1396 bool llvm::parseMBBReference(MachineBasicBlock *&MBB, SourceMgr &SM,
1397 MachineFunction &MF, StringRef Src,
1398 const PerFunctionMIParsingState &PFS,
1399 const SlotMapping &IRSlots, SMDiagnostic &Error) {
1400 return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseStandaloneMBB(MBB);
1403 bool llvm::parseNamedRegisterReference(unsigned &Reg, SourceMgr &SM,
1404 MachineFunction &MF, StringRef Src,
1405 const PerFunctionMIParsingState &PFS,
1406 const SlotMapping &IRSlots,
1407 SMDiagnostic &Error) {
1408 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1409 .parseStandaloneNamedRegister(Reg);
1412 bool llvm::parseVirtualRegisterReference(unsigned &Reg, SourceMgr &SM,
1413 MachineFunction &MF, StringRef Src,
1414 const PerFunctionMIParsingState &PFS,
1415 const SlotMapping &IRSlots,
1416 SMDiagnostic &Error) {
1417 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1418 .parseStandaloneVirtualRegister(Reg);
1421 bool llvm::parseIRBlockReference(const BasicBlock *&BB, SourceMgr &SM,
1422 MachineFunction &MF, StringRef Src,
1423 const PerFunctionMIParsingState &PFS,
1424 const SlotMapping &IRSlots,
1425 SMDiagnostic &Error) {
1426 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1427 .parseStandaloneIRBlockReference(BB);