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
41 /// range and other attributes.
42 struct ParsedMachineOperand {
43 MachineOperand Operand;
44 StringRef::iterator Begin;
45 StringRef::iterator End;
46 Optional<unsigned> TiedDefIdx;
48 ParsedMachineOperand(const MachineOperand &Operand, StringRef::iterator Begin,
49 StringRef::iterator End, Optional<unsigned> &TiedDefIdx)
50 : Operand(Operand), Begin(Begin), End(End), TiedDefIdx(TiedDefIdx) {
52 assert(Operand.isReg() && Operand.isUse() &&
53 "Only used register operands can be tied");
61 StringRef Source, CurrentSource;
63 const PerFunctionMIParsingState &PFS;
64 /// Maps from indices to unnamed global values and metadata nodes.
65 const SlotMapping &IRSlots;
66 /// Maps from instruction names to op codes.
67 StringMap<unsigned> Names2InstrOpCodes;
68 /// Maps from register names to registers.
69 StringMap<unsigned> Names2Regs;
70 /// Maps from register mask names to register masks.
71 StringMap<const uint32_t *> Names2RegMasks;
72 /// Maps from subregister names to subregister indices.
73 StringMap<unsigned> Names2SubRegIndices;
74 /// Maps from slot numbers to function's unnamed basic blocks.
75 DenseMap<unsigned, const BasicBlock *> Slots2BasicBlocks;
76 /// Maps from slot numbers to function's unnamed values.
77 DenseMap<unsigned, const Value *> Slots2Values;
78 /// Maps from target index names to target indices.
79 StringMap<int> Names2TargetIndices;
80 /// Maps from direct target flag names to the direct target flag values.
81 StringMap<unsigned> Names2DirectTargetFlags;
82 /// Maps from direct target flag names to the bitmask target flag values.
83 StringMap<unsigned> Names2BitmaskTargetFlags;
86 MIParser(SourceMgr &SM, MachineFunction &MF, SMDiagnostic &Error,
87 StringRef Source, const PerFunctionMIParsingState &PFS,
88 const SlotMapping &IRSlots);
92 /// Report an error at the current location with the given message.
94 /// This function always return true.
95 bool error(const Twine &Msg);
97 /// Report an error at the given location with the given message.
99 /// This function always return true.
100 bool error(StringRef::iterator Loc, const Twine &Msg);
103 parseBasicBlockDefinitions(DenseMap<unsigned, MachineBasicBlock *> &MBBSlots);
104 bool parseBasicBlocks();
105 bool parse(MachineInstr *&MI);
106 bool parseStandaloneMBB(MachineBasicBlock *&MBB);
107 bool parseStandaloneNamedRegister(unsigned &Reg);
108 bool parseStandaloneVirtualRegister(unsigned &Reg);
109 bool parseStandaloneStackObject(int &FI);
110 bool parseStandaloneMDNode(MDNode *&Node);
113 parseBasicBlockDefinition(DenseMap<unsigned, MachineBasicBlock *> &MBBSlots);
114 bool parseBasicBlock(MachineBasicBlock &MBB);
115 bool parseBasicBlockLiveins(MachineBasicBlock &MBB);
116 bool parseBasicBlockSuccessors(MachineBasicBlock &MBB);
118 bool parseRegister(unsigned &Reg);
119 bool parseRegisterFlag(unsigned &Flags);
120 bool parseSubRegisterIndex(unsigned &SubReg);
121 bool parseRegisterTiedDefIndex(unsigned &TiedDefIdx);
122 bool parseRegisterOperand(MachineOperand &Dest,
123 Optional<unsigned> &TiedDefIdx, bool IsDef = false);
124 bool parseImmediateOperand(MachineOperand &Dest);
125 bool parseIRConstant(StringRef::iterator Loc, StringRef Source,
127 bool parseIRConstant(StringRef::iterator Loc, const Constant *&C);
128 bool parseTypedImmediateOperand(MachineOperand &Dest);
129 bool parseFPImmediateOperand(MachineOperand &Dest);
130 bool parseMBBReference(MachineBasicBlock *&MBB);
131 bool parseMBBOperand(MachineOperand &Dest);
132 bool parseStackFrameIndex(int &FI);
133 bool parseStackObjectOperand(MachineOperand &Dest);
134 bool parseFixedStackFrameIndex(int &FI);
135 bool parseFixedStackObjectOperand(MachineOperand &Dest);
136 bool parseGlobalValue(GlobalValue *&GV);
137 bool parseGlobalAddressOperand(MachineOperand &Dest);
138 bool parseConstantPoolIndexOperand(MachineOperand &Dest);
139 bool parseJumpTableIndexOperand(MachineOperand &Dest);
140 bool parseExternalSymbolOperand(MachineOperand &Dest);
141 bool parseMDNode(MDNode *&Node);
142 bool parseMetadataOperand(MachineOperand &Dest);
143 bool parseCFIOffset(int &Offset);
144 bool parseCFIRegister(unsigned &Reg);
145 bool parseCFIOperand(MachineOperand &Dest);
146 bool parseIRBlock(BasicBlock *&BB, const Function &F);
147 bool parseBlockAddressOperand(MachineOperand &Dest);
148 bool parseTargetIndexOperand(MachineOperand &Dest);
149 bool parseLiveoutRegisterMaskOperand(MachineOperand &Dest);
150 bool parseMachineOperand(MachineOperand &Dest,
151 Optional<unsigned> &TiedDefIdx);
152 bool parseMachineOperandAndTargetFlags(MachineOperand &Dest,
153 Optional<unsigned> &TiedDefIdx);
154 bool parseOffset(int64_t &Offset);
155 bool parseAlignment(unsigned &Alignment);
156 bool parseOperandsOffset(MachineOperand &Op);
157 bool parseIRValue(const Value *&V);
158 bool parseMemoryOperandFlag(unsigned &Flags);
159 bool parseMemoryPseudoSourceValue(const PseudoSourceValue *&PSV);
160 bool parseMachinePointerInfo(MachinePointerInfo &Dest);
161 bool parseMachineMemoryOperand(MachineMemOperand *&Dest);
164 /// Convert the integer literal in the current token into an unsigned integer.
166 /// Return true if an error occurred.
167 bool getUnsigned(unsigned &Result);
169 /// Convert the integer literal in the current token into an uint64.
171 /// Return true if an error occurred.
172 bool getUint64(uint64_t &Result);
174 /// If the current token is of the given kind, consume it and return false.
175 /// Otherwise report an error and return true.
176 bool expectAndConsume(MIToken::TokenKind TokenKind);
178 /// If the current token is of the given kind, consume it and return true.
179 /// Otherwise return false.
180 bool consumeIfPresent(MIToken::TokenKind TokenKind);
182 void initNames2InstrOpCodes();
184 /// Try to convert an instruction name to an opcode. Return true if the
185 /// instruction name is invalid.
186 bool parseInstrName(StringRef InstrName, unsigned &OpCode);
188 bool parseInstruction(unsigned &OpCode, unsigned &Flags);
190 bool assignRegisterTies(MachineInstr &MI,
191 ArrayRef<ParsedMachineOperand> Operands);
193 bool verifyImplicitOperands(ArrayRef<ParsedMachineOperand> Operands,
194 const MCInstrDesc &MCID);
196 void initNames2Regs();
198 /// Try to convert a register name to a register number. Return true if the
199 /// register name is invalid.
200 bool getRegisterByName(StringRef RegName, unsigned &Reg);
202 void initNames2RegMasks();
204 /// Check if the given identifier is a name of a register mask.
206 /// Return null if the identifier isn't a register mask.
207 const uint32_t *getRegMask(StringRef Identifier);
209 void initNames2SubRegIndices();
211 /// Check if the given identifier is a name of a subregister index.
213 /// Return 0 if the name isn't a subregister index class.
214 unsigned getSubRegIndex(StringRef Name);
216 const BasicBlock *getIRBlock(unsigned Slot);
217 const BasicBlock *getIRBlock(unsigned Slot, const Function &F);
219 const Value *getIRValue(unsigned Slot);
221 void initNames2TargetIndices();
223 /// Try to convert a name of target index to the corresponding target index.
225 /// Return true if the name isn't a name of a target index.
226 bool getTargetIndex(StringRef Name, int &Index);
228 void initNames2DirectTargetFlags();
230 /// Try to convert a name of a direct target flag to the corresponding
233 /// Return true if the name isn't a name of a direct flag.
234 bool getDirectTargetFlag(StringRef Name, unsigned &Flag);
236 void initNames2BitmaskTargetFlags();
238 /// Try to convert a name of a bitmask target flag to the corresponding
241 /// Return true if the name isn't a name of a bitmask target flag.
242 bool getBitmaskTargetFlag(StringRef Name, unsigned &Flag);
245 } // end anonymous namespace
247 MIParser::MIParser(SourceMgr &SM, MachineFunction &MF, SMDiagnostic &Error,
248 StringRef Source, const PerFunctionMIParsingState &PFS,
249 const SlotMapping &IRSlots)
250 : SM(SM), MF(MF), Error(Error), Source(Source), CurrentSource(Source),
251 PFS(PFS), IRSlots(IRSlots) {}
253 void MIParser::lex() {
254 CurrentSource = lexMIToken(
255 CurrentSource, Token,
256 [this](StringRef::iterator Loc, const Twine &Msg) { error(Loc, Msg); });
259 bool MIParser::error(const Twine &Msg) { return error(Token.location(), Msg); }
261 bool MIParser::error(StringRef::iterator Loc, const Twine &Msg) {
262 assert(Loc >= Source.data() && Loc <= (Source.data() + Source.size()));
263 const MemoryBuffer &Buffer = *SM.getMemoryBuffer(SM.getMainFileID());
264 if (Loc >= Buffer.getBufferStart() && Loc <= Buffer.getBufferEnd()) {
265 // Create an ordinary diagnostic when the source manager's buffer is the
267 Error = SM.GetMessage(SMLoc::getFromPointer(Loc), SourceMgr::DK_Error, Msg);
270 // Create a diagnostic for a YAML string literal.
271 Error = SMDiagnostic(SM, SMLoc(), Buffer.getBufferIdentifier(), 1,
272 Loc - Source.data(), SourceMgr::DK_Error, Msg.str(),
277 static const char *toString(MIToken::TokenKind TokenKind) {
285 case MIToken::lparen:
287 case MIToken::rparen:
290 return "<unknown token>";
294 bool MIParser::expectAndConsume(MIToken::TokenKind TokenKind) {
295 if (Token.isNot(TokenKind))
296 return error(Twine("expected ") + toString(TokenKind));
301 bool MIParser::consumeIfPresent(MIToken::TokenKind TokenKind) {
302 if (Token.isNot(TokenKind))
308 bool MIParser::parseBasicBlockDefinition(
309 DenseMap<unsigned, MachineBasicBlock *> &MBBSlots) {
310 assert(Token.is(MIToken::MachineBasicBlockLabel));
314 auto Loc = Token.location();
315 auto Name = Token.stringValue();
317 bool HasAddressTaken = false;
318 bool IsLandingPad = false;
319 unsigned Alignment = 0;
320 BasicBlock *BB = nullptr;
321 if (consumeIfPresent(MIToken::lparen)) {
323 // TODO: Report an error when multiple same attributes are specified.
324 switch (Token.kind()) {
325 case MIToken::kw_address_taken:
326 HasAddressTaken = true;
329 case MIToken::kw_landing_pad:
333 case MIToken::kw_align:
334 if (parseAlignment(Alignment))
337 case MIToken::IRBlock:
338 // TODO: Report an error when both name and ir block are specified.
339 if (parseIRBlock(BB, *MF.getFunction()))
346 } while (consumeIfPresent(MIToken::comma));
347 if (expectAndConsume(MIToken::rparen))
350 if (expectAndConsume(MIToken::colon))
354 BB = dyn_cast_or_null<BasicBlock>(
355 MF.getFunction()->getValueSymbolTable().lookup(Name));
357 return error(Loc, Twine("basic block '") + Name +
358 "' is not defined in the function '" +
361 auto *MBB = MF.CreateMachineBasicBlock(BB);
362 MF.insert(MF.end(), MBB);
363 bool WasInserted = MBBSlots.insert(std::make_pair(ID, MBB)).second;
365 return error(Loc, Twine("redefinition of machine basic block with id #") +
368 MBB->setAlignment(Alignment);
370 MBB->setHasAddressTaken();
371 MBB->setIsEHPad(IsLandingPad);
375 bool MIParser::parseBasicBlockDefinitions(
376 DenseMap<unsigned, MachineBasicBlock *> &MBBSlots) {
378 // Skip until the first machine basic block.
379 while (Token.is(MIToken::Newline))
381 if (Token.isErrorOrEOF())
382 return Token.isError();
383 if (Token.isNot(MIToken::MachineBasicBlockLabel))
384 return error("expected a basic block definition before instructions");
385 unsigned BraceDepth = 0;
387 if (parseBasicBlockDefinition(MBBSlots))
389 bool IsAfterNewline = false;
390 // Skip until the next machine basic block.
392 if ((Token.is(MIToken::MachineBasicBlockLabel) && IsAfterNewline) ||
393 Token.isErrorOrEOF())
395 else if (Token.is(MIToken::MachineBasicBlockLabel))
396 return error("basic block definition should be located at the start of "
398 else if (consumeIfPresent(MIToken::Newline)) {
399 IsAfterNewline = true;
402 IsAfterNewline = false;
403 if (Token.is(MIToken::lbrace))
405 if (Token.is(MIToken::rbrace)) {
407 return error("extraneous closing brace ('}')");
412 // Verify that we closed all of the '{' at the end of a file or a block.
413 if (!Token.isError() && BraceDepth)
414 return error("expected '}'"); // FIXME: Report a note that shows '{'.
415 } while (!Token.isErrorOrEOF());
416 return Token.isError();
419 bool MIParser::parseBasicBlockLiveins(MachineBasicBlock &MBB) {
420 assert(Token.is(MIToken::kw_liveins));
422 if (expectAndConsume(MIToken::colon))
424 if (Token.isNewlineOrEOF()) // Allow an empty list of liveins.
427 if (Token.isNot(MIToken::NamedRegister))
428 return error("expected a named register");
430 if (parseRegister(Reg))
434 } while (consumeIfPresent(MIToken::comma));
438 bool MIParser::parseBasicBlockSuccessors(MachineBasicBlock &MBB) {
439 assert(Token.is(MIToken::kw_successors));
441 if (expectAndConsume(MIToken::colon))
443 if (Token.isNewlineOrEOF()) // Allow an empty list of successors.
446 if (Token.isNot(MIToken::MachineBasicBlock))
447 return error("expected a machine basic block reference");
448 MachineBasicBlock *SuccMBB = nullptr;
449 if (parseMBBReference(SuccMBB))
453 if (consumeIfPresent(MIToken::lparen)) {
454 if (Token.isNot(MIToken::IntegerLiteral))
455 return error("expected an integer literal after '('");
456 if (getUnsigned(Weight))
459 if (expectAndConsume(MIToken::rparen))
462 MBB.addSuccessor(SuccMBB, BranchProbability::getRaw(Weight));
463 } while (consumeIfPresent(MIToken::comma));
464 MBB.normalizeSuccProbs();
468 bool MIParser::parseBasicBlock(MachineBasicBlock &MBB) {
469 // Skip the definition.
470 assert(Token.is(MIToken::MachineBasicBlockLabel));
472 if (consumeIfPresent(MIToken::lparen)) {
473 while (Token.isNot(MIToken::rparen) && !Token.isErrorOrEOF())
475 consumeIfPresent(MIToken::rparen);
477 consumeIfPresent(MIToken::colon);
479 // Parse the liveins and successors.
480 // N.B: Multiple lists of successors and liveins are allowed and they're
487 // liveins: %edi, %esi
489 if (Token.is(MIToken::kw_successors)) {
490 if (parseBasicBlockSuccessors(MBB))
492 } else if (Token.is(MIToken::kw_liveins)) {
493 if (parseBasicBlockLiveins(MBB))
495 } else if (consumeIfPresent(MIToken::Newline)) {
499 if (!Token.isNewlineOrEOF())
500 return error("expected line break at the end of a list");
504 // Parse the instructions.
505 bool IsInBundle = false;
506 MachineInstr *PrevMI = nullptr;
508 if (Token.is(MIToken::MachineBasicBlockLabel) || Token.is(MIToken::Eof))
510 else if (consumeIfPresent(MIToken::Newline))
512 if (consumeIfPresent(MIToken::rbrace)) {
513 // The first parsing pass should verify that all closing '}' have an
519 MachineInstr *MI = nullptr;
522 MBB.insert(MBB.end(), MI);
524 PrevMI->setFlag(MachineInstr::BundledSucc);
525 MI->setFlag(MachineInstr::BundledPred);
528 if (Token.is(MIToken::lbrace)) {
530 return error("nested instruction bundles are not allowed");
532 // This instruction is the start of the bundle.
533 MI->setFlag(MachineInstr::BundledSucc);
535 if (!Token.is(MIToken::Newline))
536 // The next instruction can be on the same line.
539 assert(Token.isNewlineOrEOF() && "MI is not fully parsed");
545 bool MIParser::parseBasicBlocks() {
547 // Skip until the first machine basic block.
548 while (Token.is(MIToken::Newline))
550 if (Token.isErrorOrEOF())
551 return Token.isError();
552 // The first parsing pass should have verified that this token is a MBB label
553 // in the 'parseBasicBlockDefinitions' method.
554 assert(Token.is(MIToken::MachineBasicBlockLabel));
556 MachineBasicBlock *MBB = nullptr;
557 if (parseMBBReference(MBB))
559 if (parseBasicBlock(*MBB))
561 // The method 'parseBasicBlock' should parse the whole block until the next
562 // block or the end of file.
563 assert(Token.is(MIToken::MachineBasicBlockLabel) || Token.is(MIToken::Eof));
564 } while (Token.isNot(MIToken::Eof));
568 bool MIParser::parse(MachineInstr *&MI) {
569 // Parse any register operands before '='
570 MachineOperand MO = MachineOperand::CreateImm(0);
571 SmallVector<ParsedMachineOperand, 8> Operands;
572 while (Token.isRegister() || Token.isRegisterFlag()) {
573 auto Loc = Token.location();
574 Optional<unsigned> TiedDefIdx;
575 if (parseRegisterOperand(MO, TiedDefIdx, /*IsDef=*/true))
578 ParsedMachineOperand(MO, Loc, Token.location(), TiedDefIdx));
579 if (Token.isNot(MIToken::comma))
583 if (!Operands.empty() && expectAndConsume(MIToken::equal))
586 unsigned OpCode, Flags = 0;
587 if (Token.isError() || parseInstruction(OpCode, Flags))
590 // Parse the remaining machine operands.
591 while (!Token.isNewlineOrEOF() && Token.isNot(MIToken::kw_debug_location) &&
592 Token.isNot(MIToken::coloncolon) && Token.isNot(MIToken::lbrace)) {
593 auto Loc = Token.location();
594 Optional<unsigned> TiedDefIdx;
595 if (parseMachineOperandAndTargetFlags(MO, TiedDefIdx))
598 ParsedMachineOperand(MO, Loc, Token.location(), TiedDefIdx));
599 if (Token.isNewlineOrEOF() || Token.is(MIToken::coloncolon) ||
600 Token.is(MIToken::lbrace))
602 if (Token.isNot(MIToken::comma))
603 return error("expected ',' before the next machine operand");
607 DebugLoc DebugLocation;
608 if (Token.is(MIToken::kw_debug_location)) {
610 if (Token.isNot(MIToken::exclaim))
611 return error("expected a metadata node after 'debug-location'");
612 MDNode *Node = nullptr;
613 if (parseMDNode(Node))
615 DebugLocation = DebugLoc(Node);
618 // Parse the machine memory operands.
619 SmallVector<MachineMemOperand *, 2> MemOperands;
620 if (Token.is(MIToken::coloncolon)) {
622 while (!Token.isNewlineOrEOF()) {
623 MachineMemOperand *MemOp = nullptr;
624 if (parseMachineMemoryOperand(MemOp))
626 MemOperands.push_back(MemOp);
627 if (Token.isNewlineOrEOF())
629 if (Token.isNot(MIToken::comma))
630 return error("expected ',' before the next machine memory operand");
635 const auto &MCID = MF.getSubtarget().getInstrInfo()->get(OpCode);
636 if (!MCID.isVariadic()) {
637 // FIXME: Move the implicit operand verification to the machine verifier.
638 if (verifyImplicitOperands(Operands, MCID))
642 // TODO: Check for extraneous machine operands.
643 MI = MF.CreateMachineInstr(MCID, DebugLocation, /*NoImplicit=*/true);
645 for (const auto &Operand : Operands)
646 MI->addOperand(MF, Operand.Operand);
647 if (assignRegisterTies(*MI, Operands))
649 if (MemOperands.empty())
651 MachineInstr::mmo_iterator MemRefs =
652 MF.allocateMemRefsArray(MemOperands.size());
653 std::copy(MemOperands.begin(), MemOperands.end(), MemRefs);
654 MI->setMemRefs(MemRefs, MemRefs + MemOperands.size());
658 bool MIParser::parseStandaloneMBB(MachineBasicBlock *&MBB) {
660 if (Token.isNot(MIToken::MachineBasicBlock))
661 return error("expected a machine basic block reference");
662 if (parseMBBReference(MBB))
665 if (Token.isNot(MIToken::Eof))
667 "expected end of string after the machine basic block reference");
671 bool MIParser::parseStandaloneNamedRegister(unsigned &Reg) {
673 if (Token.isNot(MIToken::NamedRegister))
674 return error("expected a named register");
675 if (parseRegister(Reg))
678 if (Token.isNot(MIToken::Eof))
679 return error("expected end of string after the register reference");
683 bool MIParser::parseStandaloneVirtualRegister(unsigned &Reg) {
685 if (Token.isNot(MIToken::VirtualRegister))
686 return error("expected a virtual register");
687 if (parseRegister(Reg))
690 if (Token.isNot(MIToken::Eof))
691 return error("expected end of string after the register reference");
695 bool MIParser::parseStandaloneStackObject(int &FI) {
697 if (Token.isNot(MIToken::StackObject))
698 return error("expected a stack object");
699 if (parseStackFrameIndex(FI))
701 if (Token.isNot(MIToken::Eof))
702 return error("expected end of string after the stack object reference");
706 bool MIParser::parseStandaloneMDNode(MDNode *&Node) {
708 if (Token.isNot(MIToken::exclaim))
709 return error("expected a metadata node");
710 if (parseMDNode(Node))
712 if (Token.isNot(MIToken::Eof))
713 return error("expected end of string after the metadata node");
717 static const char *printImplicitRegisterFlag(const MachineOperand &MO) {
718 assert(MO.isImplicit());
719 return MO.isDef() ? "implicit-def" : "implicit";
722 static std::string getRegisterName(const TargetRegisterInfo *TRI,
724 assert(TargetRegisterInfo::isPhysicalRegister(Reg) && "expected phys reg");
725 return StringRef(TRI->getName(Reg)).lower();
728 /// Return true if the parsed machine operands contain a given machine operand.
729 static bool isImplicitOperandIn(const MachineOperand &ImplicitOperand,
730 ArrayRef<ParsedMachineOperand> Operands) {
731 for (const auto &I : Operands) {
732 if (ImplicitOperand.isIdenticalTo(I.Operand))
738 bool MIParser::verifyImplicitOperands(ArrayRef<ParsedMachineOperand> Operands,
739 const MCInstrDesc &MCID) {
741 // We can't verify call instructions as they can contain arbitrary implicit
742 // register and register mask operands.
745 // Gather all the expected implicit operands.
746 SmallVector<MachineOperand, 4> ImplicitOperands;
747 if (MCID.ImplicitDefs)
748 for (const MCPhysReg *ImpDefs = MCID.getImplicitDefs(); *ImpDefs; ++ImpDefs)
749 ImplicitOperands.push_back(
750 MachineOperand::CreateReg(*ImpDefs, true, true));
751 if (MCID.ImplicitUses)
752 for (const MCPhysReg *ImpUses = MCID.getImplicitUses(); *ImpUses; ++ImpUses)
753 ImplicitOperands.push_back(
754 MachineOperand::CreateReg(*ImpUses, false, true));
756 const auto *TRI = MF.getSubtarget().getRegisterInfo();
757 assert(TRI && "Expected target register info");
758 for (const auto &I : ImplicitOperands) {
759 if (isImplicitOperandIn(I, Operands))
761 return error(Operands.empty() ? Token.location() : Operands.back().End,
762 Twine("missing implicit register operand '") +
763 printImplicitRegisterFlag(I) + " %" +
764 getRegisterName(TRI, I.getReg()) + "'");
769 bool MIParser::parseInstruction(unsigned &OpCode, unsigned &Flags) {
770 if (Token.is(MIToken::kw_frame_setup)) {
771 Flags |= MachineInstr::FrameSetup;
774 if (Token.isNot(MIToken::Identifier))
775 return error("expected a machine instruction");
776 StringRef InstrName = Token.stringValue();
777 if (parseInstrName(InstrName, OpCode))
778 return error(Twine("unknown machine instruction name '") + InstrName + "'");
783 bool MIParser::parseRegister(unsigned &Reg) {
784 switch (Token.kind()) {
785 case MIToken::underscore:
788 case MIToken::NamedRegister: {
789 StringRef Name = Token.stringValue();
790 if (getRegisterByName(Name, Reg))
791 return error(Twine("unknown register name '") + Name + "'");
794 case MIToken::VirtualRegister: {
798 const auto RegInfo = PFS.VirtualRegisterSlots.find(ID);
799 if (RegInfo == PFS.VirtualRegisterSlots.end())
800 return error(Twine("use of undefined virtual register '%") + Twine(ID) +
802 Reg = RegInfo->second;
805 // TODO: Parse other register kinds.
807 llvm_unreachable("The current token should be a register");
812 bool MIParser::parseRegisterFlag(unsigned &Flags) {
813 const unsigned OldFlags = Flags;
814 switch (Token.kind()) {
815 case MIToken::kw_implicit:
816 Flags |= RegState::Implicit;
818 case MIToken::kw_implicit_define:
819 Flags |= RegState::ImplicitDefine;
821 case MIToken::kw_def:
822 Flags |= RegState::Define;
824 case MIToken::kw_dead:
825 Flags |= RegState::Dead;
827 case MIToken::kw_killed:
828 Flags |= RegState::Kill;
830 case MIToken::kw_undef:
831 Flags |= RegState::Undef;
833 case MIToken::kw_internal:
834 Flags |= RegState::InternalRead;
836 case MIToken::kw_early_clobber:
837 Flags |= RegState::EarlyClobber;
839 case MIToken::kw_debug_use:
840 Flags |= RegState::Debug;
843 llvm_unreachable("The current token should be a register flag");
845 if (OldFlags == Flags)
846 // We know that the same flag is specified more than once when the flags
848 return error("duplicate '" + Token.stringValue() + "' register flag");
853 bool MIParser::parseSubRegisterIndex(unsigned &SubReg) {
854 assert(Token.is(MIToken::colon));
856 if (Token.isNot(MIToken::Identifier))
857 return error("expected a subregister index after ':'");
858 auto Name = Token.stringValue();
859 SubReg = getSubRegIndex(Name);
861 return error(Twine("use of unknown subregister index '") + Name + "'");
866 bool MIParser::parseRegisterTiedDefIndex(unsigned &TiedDefIdx) {
867 if (!consumeIfPresent(MIToken::kw_tied_def))
868 return error("expected 'tied-def' after '('");
869 if (Token.isNot(MIToken::IntegerLiteral))
870 return error("expected an integer literal after 'tied-def'");
871 if (getUnsigned(TiedDefIdx))
874 if (expectAndConsume(MIToken::rparen))
879 bool MIParser::assignRegisterTies(MachineInstr &MI,
880 ArrayRef<ParsedMachineOperand> Operands) {
881 SmallVector<std::pair<unsigned, unsigned>, 4> TiedRegisterPairs;
882 for (unsigned I = 0, E = Operands.size(); I != E; ++I) {
883 if (!Operands[I].TiedDefIdx)
885 // The parser ensures that this operand is a register use, so we just have
886 // to check the tied-def operand.
887 unsigned DefIdx = Operands[I].TiedDefIdx.getValue();
889 return error(Operands[I].Begin,
890 Twine("use of invalid tied-def operand index '" +
891 Twine(DefIdx) + "'; instruction has only ") +
892 Twine(E) + " operands");
893 const auto &DefOperand = Operands[DefIdx].Operand;
894 if (!DefOperand.isReg() || !DefOperand.isDef())
895 // FIXME: add note with the def operand.
896 return error(Operands[I].Begin,
897 Twine("use of invalid tied-def operand index '") +
898 Twine(DefIdx) + "'; the operand #" + Twine(DefIdx) +
899 " isn't a defined register");
900 // Check that the tied-def operand wasn't tied elsewhere.
901 for (const auto &TiedPair : TiedRegisterPairs) {
902 if (TiedPair.first == DefIdx)
903 return error(Operands[I].Begin,
904 Twine("the tied-def operand #") + Twine(DefIdx) +
905 " is already tied with another register operand");
907 TiedRegisterPairs.push_back(std::make_pair(DefIdx, I));
909 // FIXME: Verify that for non INLINEASM instructions, the def and use tied
910 // indices must be less than tied max.
911 for (const auto &TiedPair : TiedRegisterPairs)
912 MI.tieOperands(TiedPair.first, TiedPair.second);
916 bool MIParser::parseRegisterOperand(MachineOperand &Dest,
917 Optional<unsigned> &TiedDefIdx,
920 unsigned Flags = IsDef ? RegState::Define : 0;
921 while (Token.isRegisterFlag()) {
922 if (parseRegisterFlag(Flags))
925 if (!Token.isRegister())
926 return error("expected a register after register flags");
927 if (parseRegister(Reg))
931 if (Token.is(MIToken::colon)) {
932 if (parseSubRegisterIndex(SubReg))
935 if ((Flags & RegState::Define) == 0 && consumeIfPresent(MIToken::lparen)) {
937 if (parseRegisterTiedDefIndex(Idx))
941 Dest = MachineOperand::CreateReg(
942 Reg, Flags & RegState::Define, Flags & RegState::Implicit,
943 Flags & RegState::Kill, Flags & RegState::Dead, Flags & RegState::Undef,
944 Flags & RegState::EarlyClobber, SubReg, Flags & RegState::Debug,
945 Flags & RegState::InternalRead);
949 bool MIParser::parseImmediateOperand(MachineOperand &Dest) {
950 assert(Token.is(MIToken::IntegerLiteral));
951 const APSInt &Int = Token.integerValue();
952 if (Int.getMinSignedBits() > 64)
953 return error("integer literal is too large to be an immediate operand");
954 Dest = MachineOperand::CreateImm(Int.getExtValue());
959 bool MIParser::parseIRConstant(StringRef::iterator Loc, StringRef StringValue,
960 const Constant *&C) {
961 auto Source = StringValue.str(); // The source has to be null terminated.
963 C = parseConstantValue(Source.c_str(), Err, *MF.getFunction()->getParent(),
966 return error(Loc + Err.getColumnNo(), Err.getMessage());
970 bool MIParser::parseIRConstant(StringRef::iterator Loc, const Constant *&C) {
971 if (parseIRConstant(Loc, StringRef(Loc, Token.range().end() - Loc), C))
977 bool MIParser::parseTypedImmediateOperand(MachineOperand &Dest) {
978 assert(Token.is(MIToken::IntegerType));
979 auto Loc = Token.location();
981 if (Token.isNot(MIToken::IntegerLiteral))
982 return error("expected an integer literal");
983 const Constant *C = nullptr;
984 if (parseIRConstant(Loc, C))
986 Dest = MachineOperand::CreateCImm(cast<ConstantInt>(C));
990 bool MIParser::parseFPImmediateOperand(MachineOperand &Dest) {
991 auto Loc = Token.location();
993 if (Token.isNot(MIToken::FloatingPointLiteral))
994 return error("expected a floating point literal");
995 const Constant *C = nullptr;
996 if (parseIRConstant(Loc, C))
998 Dest = MachineOperand::CreateFPImm(cast<ConstantFP>(C));
1002 bool MIParser::getUnsigned(unsigned &Result) {
1003 assert(Token.hasIntegerValue() && "Expected a token with an integer value");
1004 const uint64_t Limit = uint64_t(std::numeric_limits<unsigned>::max()) + 1;
1005 uint64_t Val64 = Token.integerValue().getLimitedValue(Limit);
1007 return error("expected 32-bit integer (too large)");
1012 bool MIParser::parseMBBReference(MachineBasicBlock *&MBB) {
1013 assert(Token.is(MIToken::MachineBasicBlock) ||
1014 Token.is(MIToken::MachineBasicBlockLabel));
1016 if (getUnsigned(Number))
1018 auto MBBInfo = PFS.MBBSlots.find(Number);
1019 if (MBBInfo == PFS.MBBSlots.end())
1020 return error(Twine("use of undefined machine basic block #") +
1022 MBB = MBBInfo->second;
1023 if (!Token.stringValue().empty() && Token.stringValue() != MBB->getName())
1024 return error(Twine("the name of machine basic block #") + Twine(Number) +
1025 " isn't '" + Token.stringValue() + "'");
1029 bool MIParser::parseMBBOperand(MachineOperand &Dest) {
1030 MachineBasicBlock *MBB;
1031 if (parseMBBReference(MBB))
1033 Dest = MachineOperand::CreateMBB(MBB);
1038 bool MIParser::parseStackFrameIndex(int &FI) {
1039 assert(Token.is(MIToken::StackObject));
1041 if (getUnsigned(ID))
1043 auto ObjectInfo = PFS.StackObjectSlots.find(ID);
1044 if (ObjectInfo == PFS.StackObjectSlots.end())
1045 return error(Twine("use of undefined stack object '%stack.") + Twine(ID) +
1048 if (const auto *Alloca =
1049 MF.getFrameInfo()->getObjectAllocation(ObjectInfo->second))
1050 Name = Alloca->getName();
1051 if (!Token.stringValue().empty() && Token.stringValue() != Name)
1052 return error(Twine("the name of the stack object '%stack.") + Twine(ID) +
1053 "' isn't '" + Token.stringValue() + "'");
1055 FI = ObjectInfo->second;
1059 bool MIParser::parseStackObjectOperand(MachineOperand &Dest) {
1061 if (parseStackFrameIndex(FI))
1063 Dest = MachineOperand::CreateFI(FI);
1067 bool MIParser::parseFixedStackFrameIndex(int &FI) {
1068 assert(Token.is(MIToken::FixedStackObject));
1070 if (getUnsigned(ID))
1072 auto ObjectInfo = PFS.FixedStackObjectSlots.find(ID);
1073 if (ObjectInfo == PFS.FixedStackObjectSlots.end())
1074 return error(Twine("use of undefined fixed stack object '%fixed-stack.") +
1077 FI = ObjectInfo->second;
1081 bool MIParser::parseFixedStackObjectOperand(MachineOperand &Dest) {
1083 if (parseFixedStackFrameIndex(FI))
1085 Dest = MachineOperand::CreateFI(FI);
1089 bool MIParser::parseGlobalValue(GlobalValue *&GV) {
1090 switch (Token.kind()) {
1091 case MIToken::NamedGlobalValue: {
1092 const Module *M = MF.getFunction()->getParent();
1093 GV = M->getNamedValue(Token.stringValue());
1095 return error(Twine("use of undefined global value '") + Token.range() +
1099 case MIToken::GlobalValue: {
1101 if (getUnsigned(GVIdx))
1103 if (GVIdx >= IRSlots.GlobalValues.size())
1104 return error(Twine("use of undefined global value '@") + Twine(GVIdx) +
1106 GV = IRSlots.GlobalValues[GVIdx];
1110 llvm_unreachable("The current token should be a global value");
1115 bool MIParser::parseGlobalAddressOperand(MachineOperand &Dest) {
1116 GlobalValue *GV = nullptr;
1117 if (parseGlobalValue(GV))
1120 Dest = MachineOperand::CreateGA(GV, /*Offset=*/0);
1121 if (parseOperandsOffset(Dest))
1126 bool MIParser::parseConstantPoolIndexOperand(MachineOperand &Dest) {
1127 assert(Token.is(MIToken::ConstantPoolItem));
1129 if (getUnsigned(ID))
1131 auto ConstantInfo = PFS.ConstantPoolSlots.find(ID);
1132 if (ConstantInfo == PFS.ConstantPoolSlots.end())
1133 return error("use of undefined constant '%const." + Twine(ID) + "'");
1135 Dest = MachineOperand::CreateCPI(ID, /*Offset=*/0);
1136 if (parseOperandsOffset(Dest))
1141 bool MIParser::parseJumpTableIndexOperand(MachineOperand &Dest) {
1142 assert(Token.is(MIToken::JumpTableIndex));
1144 if (getUnsigned(ID))
1146 auto JumpTableEntryInfo = PFS.JumpTableSlots.find(ID);
1147 if (JumpTableEntryInfo == PFS.JumpTableSlots.end())
1148 return error("use of undefined jump table '%jump-table." + Twine(ID) + "'");
1150 Dest = MachineOperand::CreateJTI(JumpTableEntryInfo->second);
1154 bool MIParser::parseExternalSymbolOperand(MachineOperand &Dest) {
1155 assert(Token.is(MIToken::ExternalSymbol));
1156 const char *Symbol = MF.createExternalSymbolName(Token.stringValue());
1158 Dest = MachineOperand::CreateES(Symbol);
1159 if (parseOperandsOffset(Dest))
1164 bool MIParser::parseMDNode(MDNode *&Node) {
1165 assert(Token.is(MIToken::exclaim));
1166 auto Loc = Token.location();
1168 if (Token.isNot(MIToken::IntegerLiteral) || Token.integerValue().isSigned())
1169 return error("expected metadata id after '!'");
1171 if (getUnsigned(ID))
1173 auto NodeInfo = IRSlots.MetadataNodes.find(ID);
1174 if (NodeInfo == IRSlots.MetadataNodes.end())
1175 return error(Loc, "use of undefined metadata '!" + Twine(ID) + "'");
1177 Node = NodeInfo->second.get();
1181 bool MIParser::parseMetadataOperand(MachineOperand &Dest) {
1182 MDNode *Node = nullptr;
1183 if (parseMDNode(Node))
1185 Dest = MachineOperand::CreateMetadata(Node);
1189 bool MIParser::parseCFIOffset(int &Offset) {
1190 if (Token.isNot(MIToken::IntegerLiteral))
1191 return error("expected a cfi offset");
1192 if (Token.integerValue().getMinSignedBits() > 32)
1193 return error("expected a 32 bit integer (the cfi offset is too large)");
1194 Offset = (int)Token.integerValue().getExtValue();
1199 bool MIParser::parseCFIRegister(unsigned &Reg) {
1200 if (Token.isNot(MIToken::NamedRegister))
1201 return error("expected a cfi register");
1203 if (parseRegister(LLVMReg))
1205 const auto *TRI = MF.getSubtarget().getRegisterInfo();
1206 assert(TRI && "Expected target register info");
1207 int DwarfReg = TRI->getDwarfRegNum(LLVMReg, true);
1209 return error("invalid DWARF register");
1210 Reg = (unsigned)DwarfReg;
1215 bool MIParser::parseCFIOperand(MachineOperand &Dest) {
1216 auto Kind = Token.kind();
1218 auto &MMI = MF.getMMI();
1223 case MIToken::kw_cfi_same_value:
1224 if (parseCFIRegister(Reg))
1227 MMI.addFrameInst(MCCFIInstruction::createSameValue(nullptr, Reg));
1229 case MIToken::kw_cfi_offset:
1230 if (parseCFIRegister(Reg) || expectAndConsume(MIToken::comma) ||
1231 parseCFIOffset(Offset))
1234 MMI.addFrameInst(MCCFIInstruction::createOffset(nullptr, Reg, Offset));
1236 case MIToken::kw_cfi_def_cfa_register:
1237 if (parseCFIRegister(Reg))
1240 MMI.addFrameInst(MCCFIInstruction::createDefCfaRegister(nullptr, Reg));
1242 case MIToken::kw_cfi_def_cfa_offset:
1243 if (parseCFIOffset(Offset))
1245 // NB: MCCFIInstruction::createDefCfaOffset negates the offset.
1246 CFIIndex = MMI.addFrameInst(
1247 MCCFIInstruction::createDefCfaOffset(nullptr, -Offset));
1249 case MIToken::kw_cfi_def_cfa:
1250 if (parseCFIRegister(Reg) || expectAndConsume(MIToken::comma) ||
1251 parseCFIOffset(Offset))
1253 // NB: MCCFIInstruction::createDefCfa negates the offset.
1255 MMI.addFrameInst(MCCFIInstruction::createDefCfa(nullptr, Reg, -Offset));
1258 // TODO: Parse the other CFI operands.
1259 llvm_unreachable("The current token should be a cfi operand");
1261 Dest = MachineOperand::CreateCFIIndex(CFIIndex);
1265 bool MIParser::parseIRBlock(BasicBlock *&BB, const Function &F) {
1266 switch (Token.kind()) {
1267 case MIToken::NamedIRBlock: {
1268 BB = dyn_cast_or_null<BasicBlock>(
1269 F.getValueSymbolTable().lookup(Token.stringValue()));
1271 return error(Twine("use of undefined IR block '") + Token.range() + "'");
1274 case MIToken::IRBlock: {
1275 unsigned SlotNumber = 0;
1276 if (getUnsigned(SlotNumber))
1278 BB = const_cast<BasicBlock *>(getIRBlock(SlotNumber, F));
1280 return error(Twine("use of undefined IR block '%ir-block.") +
1281 Twine(SlotNumber) + "'");
1285 llvm_unreachable("The current token should be an IR block reference");
1290 bool MIParser::parseBlockAddressOperand(MachineOperand &Dest) {
1291 assert(Token.is(MIToken::kw_blockaddress));
1293 if (expectAndConsume(MIToken::lparen))
1295 if (Token.isNot(MIToken::GlobalValue) &&
1296 Token.isNot(MIToken::NamedGlobalValue))
1297 return error("expected a global value");
1298 GlobalValue *GV = nullptr;
1299 if (parseGlobalValue(GV))
1301 auto *F = dyn_cast<Function>(GV);
1303 return error("expected an IR function reference");
1305 if (expectAndConsume(MIToken::comma))
1307 BasicBlock *BB = nullptr;
1308 if (Token.isNot(MIToken::IRBlock) && Token.isNot(MIToken::NamedIRBlock))
1309 return error("expected an IR block reference");
1310 if (parseIRBlock(BB, *F))
1313 if (expectAndConsume(MIToken::rparen))
1315 Dest = MachineOperand::CreateBA(BlockAddress::get(F, BB), /*Offset=*/0);
1316 if (parseOperandsOffset(Dest))
1321 bool MIParser::parseTargetIndexOperand(MachineOperand &Dest) {
1322 assert(Token.is(MIToken::kw_target_index));
1324 if (expectAndConsume(MIToken::lparen))
1326 if (Token.isNot(MIToken::Identifier))
1327 return error("expected the name of the target index");
1329 if (getTargetIndex(Token.stringValue(), Index))
1330 return error("use of undefined target index '" + Token.stringValue() + "'");
1332 if (expectAndConsume(MIToken::rparen))
1334 Dest = MachineOperand::CreateTargetIndex(unsigned(Index), /*Offset=*/0);
1335 if (parseOperandsOffset(Dest))
1340 bool MIParser::parseLiveoutRegisterMaskOperand(MachineOperand &Dest) {
1341 assert(Token.is(MIToken::kw_liveout));
1342 const auto *TRI = MF.getSubtarget().getRegisterInfo();
1343 assert(TRI && "Expected target register info");
1344 uint32_t *Mask = MF.allocateRegisterMask(TRI->getNumRegs());
1346 if (expectAndConsume(MIToken::lparen))
1349 if (Token.isNot(MIToken::NamedRegister))
1350 return error("expected a named register");
1352 if (parseRegister(Reg))
1355 Mask[Reg / 32] |= 1U << (Reg % 32);
1356 // TODO: Report an error if the same register is used more than once.
1357 if (Token.isNot(MIToken::comma))
1361 if (expectAndConsume(MIToken::rparen))
1363 Dest = MachineOperand::CreateRegLiveOut(Mask);
1367 bool MIParser::parseMachineOperand(MachineOperand &Dest,
1368 Optional<unsigned> &TiedDefIdx) {
1369 switch (Token.kind()) {
1370 case MIToken::kw_implicit:
1371 case MIToken::kw_implicit_define:
1372 case MIToken::kw_def:
1373 case MIToken::kw_dead:
1374 case MIToken::kw_killed:
1375 case MIToken::kw_undef:
1376 case MIToken::kw_internal:
1377 case MIToken::kw_early_clobber:
1378 case MIToken::kw_debug_use:
1379 case MIToken::underscore:
1380 case MIToken::NamedRegister:
1381 case MIToken::VirtualRegister:
1382 return parseRegisterOperand(Dest, TiedDefIdx);
1383 case MIToken::IntegerLiteral:
1384 return parseImmediateOperand(Dest);
1385 case MIToken::IntegerType:
1386 return parseTypedImmediateOperand(Dest);
1387 case MIToken::kw_half:
1388 case MIToken::kw_float:
1389 case MIToken::kw_double:
1390 case MIToken::kw_x86_fp80:
1391 case MIToken::kw_fp128:
1392 case MIToken::kw_ppc_fp128:
1393 return parseFPImmediateOperand(Dest);
1394 case MIToken::MachineBasicBlock:
1395 return parseMBBOperand(Dest);
1396 case MIToken::StackObject:
1397 return parseStackObjectOperand(Dest);
1398 case MIToken::FixedStackObject:
1399 return parseFixedStackObjectOperand(Dest);
1400 case MIToken::GlobalValue:
1401 case MIToken::NamedGlobalValue:
1402 return parseGlobalAddressOperand(Dest);
1403 case MIToken::ConstantPoolItem:
1404 return parseConstantPoolIndexOperand(Dest);
1405 case MIToken::JumpTableIndex:
1406 return parseJumpTableIndexOperand(Dest);
1407 case MIToken::ExternalSymbol:
1408 return parseExternalSymbolOperand(Dest);
1409 case MIToken::exclaim:
1410 return parseMetadataOperand(Dest);
1411 case MIToken::kw_cfi_same_value:
1412 case MIToken::kw_cfi_offset:
1413 case MIToken::kw_cfi_def_cfa_register:
1414 case MIToken::kw_cfi_def_cfa_offset:
1415 case MIToken::kw_cfi_def_cfa:
1416 return parseCFIOperand(Dest);
1417 case MIToken::kw_blockaddress:
1418 return parseBlockAddressOperand(Dest);
1419 case MIToken::kw_target_index:
1420 return parseTargetIndexOperand(Dest);
1421 case MIToken::kw_liveout:
1422 return parseLiveoutRegisterMaskOperand(Dest);
1423 case MIToken::Error:
1425 case MIToken::Identifier:
1426 if (const auto *RegMask = getRegMask(Token.stringValue())) {
1427 Dest = MachineOperand::CreateRegMask(RegMask);
1433 // FIXME: Parse the MCSymbol machine operand.
1434 return error("expected a machine operand");
1439 bool MIParser::parseMachineOperandAndTargetFlags(
1440 MachineOperand &Dest, Optional<unsigned> &TiedDefIdx) {
1442 bool HasTargetFlags = false;
1443 if (Token.is(MIToken::kw_target_flags)) {
1444 HasTargetFlags = true;
1446 if (expectAndConsume(MIToken::lparen))
1448 if (Token.isNot(MIToken::Identifier))
1449 return error("expected the name of the target flag");
1450 if (getDirectTargetFlag(Token.stringValue(), TF)) {
1451 if (getBitmaskTargetFlag(Token.stringValue(), TF))
1452 return error("use of undefined target flag '" + Token.stringValue() +
1456 while (Token.is(MIToken::comma)) {
1458 if (Token.isNot(MIToken::Identifier))
1459 return error("expected the name of the target flag");
1460 unsigned BitFlag = 0;
1461 if (getBitmaskTargetFlag(Token.stringValue(), BitFlag))
1462 return error("use of undefined target flag '" + Token.stringValue() +
1464 // TODO: Report an error when using a duplicate bit target flag.
1468 if (expectAndConsume(MIToken::rparen))
1471 auto Loc = Token.location();
1472 if (parseMachineOperand(Dest, TiedDefIdx))
1474 if (!HasTargetFlags)
1477 return error(Loc, "register operands can't have target flags");
1478 Dest.setTargetFlags(TF);
1482 bool MIParser::parseOffset(int64_t &Offset) {
1483 if (Token.isNot(MIToken::plus) && Token.isNot(MIToken::minus))
1485 StringRef Sign = Token.range();
1486 bool IsNegative = Token.is(MIToken::minus);
1488 if (Token.isNot(MIToken::IntegerLiteral))
1489 return error("expected an integer literal after '" + Sign + "'");
1490 if (Token.integerValue().getMinSignedBits() > 64)
1491 return error("expected 64-bit integer (too large)");
1492 Offset = Token.integerValue().getExtValue();
1499 bool MIParser::parseAlignment(unsigned &Alignment) {
1500 assert(Token.is(MIToken::kw_align));
1502 if (Token.isNot(MIToken::IntegerLiteral) || Token.integerValue().isSigned())
1503 return error("expected an integer literal after 'align'");
1504 if (getUnsigned(Alignment))
1510 bool MIParser::parseOperandsOffset(MachineOperand &Op) {
1512 if (parseOffset(Offset))
1514 Op.setOffset(Offset);
1518 bool MIParser::parseIRValue(const Value *&V) {
1519 switch (Token.kind()) {
1520 case MIToken::NamedIRValue: {
1521 V = MF.getFunction()->getValueSymbolTable().lookup(Token.stringValue());
1524 case MIToken::IRValue: {
1525 unsigned SlotNumber = 0;
1526 if (getUnsigned(SlotNumber))
1528 V = getIRValue(SlotNumber);
1531 case MIToken::NamedGlobalValue:
1532 case MIToken::GlobalValue: {
1533 GlobalValue *GV = nullptr;
1534 if (parseGlobalValue(GV))
1539 case MIToken::QuotedIRValue: {
1540 const Constant *C = nullptr;
1541 if (parseIRConstant(Token.location(), Token.stringValue(), C))
1547 llvm_unreachable("The current token should be an IR block reference");
1550 return error(Twine("use of undefined IR value '") + Token.range() + "'");
1554 bool MIParser::getUint64(uint64_t &Result) {
1555 assert(Token.hasIntegerValue());
1556 if (Token.integerValue().getActiveBits() > 64)
1557 return error("expected 64-bit integer (too large)");
1558 Result = Token.integerValue().getZExtValue();
1562 bool MIParser::parseMemoryOperandFlag(unsigned &Flags) {
1563 const unsigned OldFlags = Flags;
1564 switch (Token.kind()) {
1565 case MIToken::kw_volatile:
1566 Flags |= MachineMemOperand::MOVolatile;
1568 case MIToken::kw_non_temporal:
1569 Flags |= MachineMemOperand::MONonTemporal;
1571 case MIToken::kw_invariant:
1572 Flags |= MachineMemOperand::MOInvariant;
1574 // TODO: parse the target specific memory operand flags.
1576 llvm_unreachable("The current token should be a memory operand flag");
1578 if (OldFlags == Flags)
1579 // We know that the same flag is specified more than once when the flags
1580 // weren't modified.
1581 return error("duplicate '" + Token.stringValue() + "' memory operand flag");
1586 bool MIParser::parseMemoryPseudoSourceValue(const PseudoSourceValue *&PSV) {
1587 switch (Token.kind()) {
1588 case MIToken::kw_stack:
1589 PSV = MF.getPSVManager().getStack();
1591 case MIToken::kw_got:
1592 PSV = MF.getPSVManager().getGOT();
1594 case MIToken::kw_jump_table:
1595 PSV = MF.getPSVManager().getJumpTable();
1597 case MIToken::kw_constant_pool:
1598 PSV = MF.getPSVManager().getConstantPool();
1600 case MIToken::FixedStackObject: {
1602 if (parseFixedStackFrameIndex(FI))
1604 PSV = MF.getPSVManager().getFixedStack(FI);
1605 // The token was already consumed, so use return here instead of break.
1608 case MIToken::kw_call_entry: {
1610 switch (Token.kind()) {
1611 case MIToken::GlobalValue:
1612 case MIToken::NamedGlobalValue: {
1613 GlobalValue *GV = nullptr;
1614 if (parseGlobalValue(GV))
1616 PSV = MF.getPSVManager().getGlobalValueCallEntry(GV);
1619 case MIToken::ExternalSymbol:
1620 PSV = MF.getPSVManager().getExternalSymbolCallEntry(
1621 MF.createExternalSymbolName(Token.stringValue()));
1625 "expected a global value or an external symbol after 'call-entry'");
1630 llvm_unreachable("The current token should be pseudo source value");
1636 bool MIParser::parseMachinePointerInfo(MachinePointerInfo &Dest) {
1637 if (Token.is(MIToken::kw_constant_pool) || Token.is(MIToken::kw_stack) ||
1638 Token.is(MIToken::kw_got) || Token.is(MIToken::kw_jump_table) ||
1639 Token.is(MIToken::FixedStackObject) || Token.is(MIToken::kw_call_entry)) {
1640 const PseudoSourceValue *PSV = nullptr;
1641 if (parseMemoryPseudoSourceValue(PSV))
1644 if (parseOffset(Offset))
1646 Dest = MachinePointerInfo(PSV, Offset);
1649 if (Token.isNot(MIToken::NamedIRValue) && Token.isNot(MIToken::IRValue) &&
1650 Token.isNot(MIToken::GlobalValue) &&
1651 Token.isNot(MIToken::NamedGlobalValue) &&
1652 Token.isNot(MIToken::QuotedIRValue))
1653 return error("expected an IR value reference");
1654 const Value *V = nullptr;
1655 if (parseIRValue(V))
1657 if (!V->getType()->isPointerTy())
1658 return error("expected a pointer IR value");
1661 if (parseOffset(Offset))
1663 Dest = MachinePointerInfo(V, Offset);
1667 bool MIParser::parseMachineMemoryOperand(MachineMemOperand *&Dest) {
1668 if (expectAndConsume(MIToken::lparen))
1671 while (Token.isMemoryOperandFlag()) {
1672 if (parseMemoryOperandFlag(Flags))
1675 if (Token.isNot(MIToken::Identifier) ||
1676 (Token.stringValue() != "load" && Token.stringValue() != "store"))
1677 return error("expected 'load' or 'store' memory operation");
1678 if (Token.stringValue() == "load")
1679 Flags |= MachineMemOperand::MOLoad;
1681 Flags |= MachineMemOperand::MOStore;
1684 if (Token.isNot(MIToken::IntegerLiteral))
1685 return error("expected the size integer literal after memory operation");
1687 if (getUint64(Size))
1691 const char *Word = Flags & MachineMemOperand::MOLoad ? "from" : "into";
1692 if (Token.isNot(MIToken::Identifier) || Token.stringValue() != Word)
1693 return error(Twine("expected '") + Word + "'");
1696 MachinePointerInfo Ptr = MachinePointerInfo();
1697 if (parseMachinePointerInfo(Ptr))
1699 unsigned BaseAlignment = Size;
1701 MDNode *Range = nullptr;
1702 while (consumeIfPresent(MIToken::comma)) {
1703 switch (Token.kind()) {
1704 case MIToken::kw_align:
1705 if (parseAlignment(BaseAlignment))
1708 case MIToken::md_tbaa:
1710 if (parseMDNode(AAInfo.TBAA))
1713 case MIToken::md_alias_scope:
1715 if (parseMDNode(AAInfo.Scope))
1718 case MIToken::md_noalias:
1720 if (parseMDNode(AAInfo.NoAlias))
1723 case MIToken::md_range:
1725 if (parseMDNode(Range))
1728 // TODO: Report an error on duplicate metadata nodes.
1730 return error("expected 'align' or '!tbaa' or '!alias.scope' or "
1731 "'!noalias' or '!range'");
1734 if (expectAndConsume(MIToken::rparen))
1737 MF.getMachineMemOperand(Ptr, Flags, Size, BaseAlignment, AAInfo, Range);
1741 void MIParser::initNames2InstrOpCodes() {
1742 if (!Names2InstrOpCodes.empty())
1744 const auto *TII = MF.getSubtarget().getInstrInfo();
1745 assert(TII && "Expected target instruction info");
1746 for (unsigned I = 0, E = TII->getNumOpcodes(); I < E; ++I)
1747 Names2InstrOpCodes.insert(std::make_pair(StringRef(TII->getName(I)), I));
1750 bool MIParser::parseInstrName(StringRef InstrName, unsigned &OpCode) {
1751 initNames2InstrOpCodes();
1752 auto InstrInfo = Names2InstrOpCodes.find(InstrName);
1753 if (InstrInfo == Names2InstrOpCodes.end())
1755 OpCode = InstrInfo->getValue();
1759 void MIParser::initNames2Regs() {
1760 if (!Names2Regs.empty())
1762 // The '%noreg' register is the register 0.
1763 Names2Regs.insert(std::make_pair("noreg", 0));
1764 const auto *TRI = MF.getSubtarget().getRegisterInfo();
1765 assert(TRI && "Expected target register info");
1766 for (unsigned I = 0, E = TRI->getNumRegs(); I < E; ++I) {
1768 Names2Regs.insert(std::make_pair(StringRef(TRI->getName(I)).lower(), I))
1771 assert(WasInserted && "Expected registers to be unique case-insensitively");
1775 bool MIParser::getRegisterByName(StringRef RegName, unsigned &Reg) {
1777 auto RegInfo = Names2Regs.find(RegName);
1778 if (RegInfo == Names2Regs.end())
1780 Reg = RegInfo->getValue();
1784 void MIParser::initNames2RegMasks() {
1785 if (!Names2RegMasks.empty())
1787 const auto *TRI = MF.getSubtarget().getRegisterInfo();
1788 assert(TRI && "Expected target register info");
1789 ArrayRef<const uint32_t *> RegMasks = TRI->getRegMasks();
1790 ArrayRef<const char *> RegMaskNames = TRI->getRegMaskNames();
1791 assert(RegMasks.size() == RegMaskNames.size());
1792 for (size_t I = 0, E = RegMasks.size(); I < E; ++I)
1793 Names2RegMasks.insert(
1794 std::make_pair(StringRef(RegMaskNames[I]).lower(), RegMasks[I]));
1797 const uint32_t *MIParser::getRegMask(StringRef Identifier) {
1798 initNames2RegMasks();
1799 auto RegMaskInfo = Names2RegMasks.find(Identifier);
1800 if (RegMaskInfo == Names2RegMasks.end())
1802 return RegMaskInfo->getValue();
1805 void MIParser::initNames2SubRegIndices() {
1806 if (!Names2SubRegIndices.empty())
1808 const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
1809 for (unsigned I = 1, E = TRI->getNumSubRegIndices(); I < E; ++I)
1810 Names2SubRegIndices.insert(
1811 std::make_pair(StringRef(TRI->getSubRegIndexName(I)).lower(), I));
1814 unsigned MIParser::getSubRegIndex(StringRef Name) {
1815 initNames2SubRegIndices();
1816 auto SubRegInfo = Names2SubRegIndices.find(Name);
1817 if (SubRegInfo == Names2SubRegIndices.end())
1819 return SubRegInfo->getValue();
1822 static void initSlots2BasicBlocks(
1824 DenseMap<unsigned, const BasicBlock *> &Slots2BasicBlocks) {
1825 ModuleSlotTracker MST(F.getParent(), /*ShouldInitializeAllMetadata=*/false);
1826 MST.incorporateFunction(F);
1827 for (auto &BB : F) {
1830 int Slot = MST.getLocalSlot(&BB);
1833 Slots2BasicBlocks.insert(std::make_pair(unsigned(Slot), &BB));
1837 static const BasicBlock *getIRBlockFromSlot(
1839 const DenseMap<unsigned, const BasicBlock *> &Slots2BasicBlocks) {
1840 auto BlockInfo = Slots2BasicBlocks.find(Slot);
1841 if (BlockInfo == Slots2BasicBlocks.end())
1843 return BlockInfo->second;
1846 const BasicBlock *MIParser::getIRBlock(unsigned Slot) {
1847 if (Slots2BasicBlocks.empty())
1848 initSlots2BasicBlocks(*MF.getFunction(), Slots2BasicBlocks);
1849 return getIRBlockFromSlot(Slot, Slots2BasicBlocks);
1852 const BasicBlock *MIParser::getIRBlock(unsigned Slot, const Function &F) {
1853 if (&F == MF.getFunction())
1854 return getIRBlock(Slot);
1855 DenseMap<unsigned, const BasicBlock *> CustomSlots2BasicBlocks;
1856 initSlots2BasicBlocks(F, CustomSlots2BasicBlocks);
1857 return getIRBlockFromSlot(Slot, CustomSlots2BasicBlocks);
1860 static void mapValueToSlot(const Value *V, ModuleSlotTracker &MST,
1861 DenseMap<unsigned, const Value *> &Slots2Values) {
1862 int Slot = MST.getLocalSlot(V);
1865 Slots2Values.insert(std::make_pair(unsigned(Slot), V));
1868 /// Creates the mapping from slot numbers to function's unnamed IR values.
1869 static void initSlots2Values(const Function &F,
1870 DenseMap<unsigned, const Value *> &Slots2Values) {
1871 ModuleSlotTracker MST(F.getParent(), /*ShouldInitializeAllMetadata=*/false);
1872 MST.incorporateFunction(F);
1873 for (const auto &Arg : F.args())
1874 mapValueToSlot(&Arg, MST, Slots2Values);
1875 for (const auto &BB : F) {
1876 mapValueToSlot(&BB, MST, Slots2Values);
1877 for (const auto &I : BB)
1878 mapValueToSlot(&I, MST, Slots2Values);
1882 const Value *MIParser::getIRValue(unsigned Slot) {
1883 if (Slots2Values.empty())
1884 initSlots2Values(*MF.getFunction(), Slots2Values);
1885 auto ValueInfo = Slots2Values.find(Slot);
1886 if (ValueInfo == Slots2Values.end())
1888 return ValueInfo->second;
1891 void MIParser::initNames2TargetIndices() {
1892 if (!Names2TargetIndices.empty())
1894 const auto *TII = MF.getSubtarget().getInstrInfo();
1895 assert(TII && "Expected target instruction info");
1896 auto Indices = TII->getSerializableTargetIndices();
1897 for (const auto &I : Indices)
1898 Names2TargetIndices.insert(std::make_pair(StringRef(I.second), I.first));
1901 bool MIParser::getTargetIndex(StringRef Name, int &Index) {
1902 initNames2TargetIndices();
1903 auto IndexInfo = Names2TargetIndices.find(Name);
1904 if (IndexInfo == Names2TargetIndices.end())
1906 Index = IndexInfo->second;
1910 void MIParser::initNames2DirectTargetFlags() {
1911 if (!Names2DirectTargetFlags.empty())
1913 const auto *TII = MF.getSubtarget().getInstrInfo();
1914 assert(TII && "Expected target instruction info");
1915 auto Flags = TII->getSerializableDirectMachineOperandTargetFlags();
1916 for (const auto &I : Flags)
1917 Names2DirectTargetFlags.insert(
1918 std::make_pair(StringRef(I.second), I.first));
1921 bool MIParser::getDirectTargetFlag(StringRef Name, unsigned &Flag) {
1922 initNames2DirectTargetFlags();
1923 auto FlagInfo = Names2DirectTargetFlags.find(Name);
1924 if (FlagInfo == Names2DirectTargetFlags.end())
1926 Flag = FlagInfo->second;
1930 void MIParser::initNames2BitmaskTargetFlags() {
1931 if (!Names2BitmaskTargetFlags.empty())
1933 const auto *TII = MF.getSubtarget().getInstrInfo();
1934 assert(TII && "Expected target instruction info");
1935 auto Flags = TII->getSerializableBitmaskMachineOperandTargetFlags();
1936 for (const auto &I : Flags)
1937 Names2BitmaskTargetFlags.insert(
1938 std::make_pair(StringRef(I.second), I.first));
1941 bool MIParser::getBitmaskTargetFlag(StringRef Name, unsigned &Flag) {
1942 initNames2BitmaskTargetFlags();
1943 auto FlagInfo = Names2BitmaskTargetFlags.find(Name);
1944 if (FlagInfo == Names2BitmaskTargetFlags.end())
1946 Flag = FlagInfo->second;
1950 bool llvm::parseMachineBasicBlockDefinitions(MachineFunction &MF, StringRef Src,
1951 PerFunctionMIParsingState &PFS,
1952 const SlotMapping &IRSlots,
1953 SMDiagnostic &Error) {
1955 SM.AddNewSourceBuffer(
1956 MemoryBuffer::getMemBuffer(Src, "", /*RequiresNullTerminator=*/false),
1958 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1959 .parseBasicBlockDefinitions(PFS.MBBSlots);
1962 bool llvm::parseMachineInstructions(MachineFunction &MF, StringRef Src,
1963 const PerFunctionMIParsingState &PFS,
1964 const SlotMapping &IRSlots,
1965 SMDiagnostic &Error) {
1967 SM.AddNewSourceBuffer(
1968 MemoryBuffer::getMemBuffer(Src, "", /*RequiresNullTerminator=*/false),
1970 return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseBasicBlocks();
1973 bool llvm::parseMBBReference(MachineBasicBlock *&MBB, SourceMgr &SM,
1974 MachineFunction &MF, StringRef Src,
1975 const PerFunctionMIParsingState &PFS,
1976 const SlotMapping &IRSlots, SMDiagnostic &Error) {
1977 return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseStandaloneMBB(MBB);
1980 bool llvm::parseNamedRegisterReference(unsigned &Reg, SourceMgr &SM,
1981 MachineFunction &MF, StringRef Src,
1982 const PerFunctionMIParsingState &PFS,
1983 const SlotMapping &IRSlots,
1984 SMDiagnostic &Error) {
1985 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1986 .parseStandaloneNamedRegister(Reg);
1989 bool llvm::parseVirtualRegisterReference(unsigned &Reg, SourceMgr &SM,
1990 MachineFunction &MF, StringRef Src,
1991 const PerFunctionMIParsingState &PFS,
1992 const SlotMapping &IRSlots,
1993 SMDiagnostic &Error) {
1994 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1995 .parseStandaloneVirtualRegister(Reg);
1998 bool llvm::parseStackObjectReference(int &FI, SourceMgr &SM,
1999 MachineFunction &MF, StringRef Src,
2000 const PerFunctionMIParsingState &PFS,
2001 const SlotMapping &IRSlots,
2002 SMDiagnostic &Error) {
2003 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
2004 .parseStandaloneStackObject(FI);
2007 bool llvm::parseMDNode(MDNode *&Node, SourceMgr &SM, MachineFunction &MF,
2008 StringRef Src, const PerFunctionMIParsingState &PFS,
2009 const SlotMapping &IRSlots, SMDiagnostic &Error) {
2010 return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseStandaloneMDNode(Node);