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 target index names to target indices.
77 StringMap<int> Names2TargetIndices;
78 /// Maps from direct target flag names to the direct target flag values.
79 StringMap<unsigned> Names2DirectTargetFlags;
80 /// Maps from direct target flag names to the bitmask target flag values.
81 StringMap<unsigned> Names2BitmaskTargetFlags;
84 MIParser(SourceMgr &SM, MachineFunction &MF, SMDiagnostic &Error,
85 StringRef Source, const PerFunctionMIParsingState &PFS,
86 const SlotMapping &IRSlots);
90 /// Report an error at the current location with the given message.
92 /// This function always return true.
93 bool error(const Twine &Msg);
95 /// Report an error at the given location with the given message.
97 /// This function always return true.
98 bool error(StringRef::iterator Loc, const Twine &Msg);
101 parseBasicBlockDefinitions(DenseMap<unsigned, MachineBasicBlock *> &MBBSlots);
102 bool parseBasicBlocks();
103 bool parse(MachineInstr *&MI);
104 bool parseStandaloneMBB(MachineBasicBlock *&MBB);
105 bool parseStandaloneNamedRegister(unsigned &Reg);
106 bool parseStandaloneVirtualRegister(unsigned &Reg);
107 bool parseStandaloneStackObject(int &FI);
108 bool parseStandaloneMDNode(MDNode *&Node);
111 parseBasicBlockDefinition(DenseMap<unsigned, MachineBasicBlock *> &MBBSlots);
112 bool parseBasicBlock(MachineBasicBlock &MBB);
113 bool parseBasicBlockLiveins(MachineBasicBlock &MBB);
114 bool parseBasicBlockSuccessors(MachineBasicBlock &MBB);
116 bool parseRegister(unsigned &Reg);
117 bool parseRegisterFlag(unsigned &Flags);
118 bool parseSubRegisterIndex(unsigned &SubReg);
119 bool parseRegisterTiedDefIndex(unsigned &TiedDefIdx);
120 bool parseRegisterOperand(MachineOperand &Dest,
121 Optional<unsigned> &TiedDefIdx, bool IsDef = false);
122 bool parseImmediateOperand(MachineOperand &Dest);
123 bool parseIRConstant(StringRef::iterator Loc, const Constant *&C);
124 bool parseTypedImmediateOperand(MachineOperand &Dest);
125 bool parseFPImmediateOperand(MachineOperand &Dest);
126 bool parseMBBReference(MachineBasicBlock *&MBB);
127 bool parseMBBOperand(MachineOperand &Dest);
128 bool parseStackFrameIndex(int &FI);
129 bool parseStackObjectOperand(MachineOperand &Dest);
130 bool parseFixedStackFrameIndex(int &FI);
131 bool parseFixedStackObjectOperand(MachineOperand &Dest);
132 bool parseGlobalValue(GlobalValue *&GV);
133 bool parseGlobalAddressOperand(MachineOperand &Dest);
134 bool parseConstantPoolIndexOperand(MachineOperand &Dest);
135 bool parseJumpTableIndexOperand(MachineOperand &Dest);
136 bool parseExternalSymbolOperand(MachineOperand &Dest);
137 bool parseMDNode(MDNode *&Node);
138 bool parseMetadataOperand(MachineOperand &Dest);
139 bool parseCFIOffset(int &Offset);
140 bool parseCFIRegister(unsigned &Reg);
141 bool parseCFIOperand(MachineOperand &Dest);
142 bool parseIRBlock(BasicBlock *&BB, const Function &F);
143 bool parseBlockAddressOperand(MachineOperand &Dest);
144 bool parseTargetIndexOperand(MachineOperand &Dest);
145 bool parseLiveoutRegisterMaskOperand(MachineOperand &Dest);
146 bool parseMachineOperand(MachineOperand &Dest,
147 Optional<unsigned> &TiedDefIdx);
148 bool parseMachineOperandAndTargetFlags(MachineOperand &Dest,
149 Optional<unsigned> &TiedDefIdx);
150 bool parseOffset(int64_t &Offset);
151 bool parseAlignment(unsigned &Alignment);
152 bool parseOperandsOffset(MachineOperand &Op);
153 bool parseIRValue(Value *&V);
154 bool parseMemoryOperandFlag(unsigned &Flags);
155 bool parseMemoryPseudoSourceValue(const PseudoSourceValue *&PSV);
156 bool parseMachinePointerInfo(MachinePointerInfo &Dest);
157 bool parseMachineMemoryOperand(MachineMemOperand *&Dest);
160 /// Convert the integer literal in the current token into an unsigned integer.
162 /// Return true if an error occurred.
163 bool getUnsigned(unsigned &Result);
165 /// Convert the integer literal in the current token into an uint64.
167 /// Return true if an error occurred.
168 bool getUint64(uint64_t &Result);
170 /// If the current token is of the given kind, consume it and return false.
171 /// Otherwise report an error and return true.
172 bool expectAndConsume(MIToken::TokenKind TokenKind);
174 /// If the current token is of the given kind, consume it and return true.
175 /// Otherwise return false.
176 bool consumeIfPresent(MIToken::TokenKind TokenKind);
178 void initNames2InstrOpCodes();
180 /// Try to convert an instruction name to an opcode. Return true if the
181 /// instruction name is invalid.
182 bool parseInstrName(StringRef InstrName, unsigned &OpCode);
184 bool parseInstruction(unsigned &OpCode, unsigned &Flags);
186 bool assignRegisterTies(MachineInstr &MI,
187 ArrayRef<ParsedMachineOperand> Operands);
189 bool verifyImplicitOperands(ArrayRef<ParsedMachineOperand> Operands,
190 const MCInstrDesc &MCID);
192 void initNames2Regs();
194 /// Try to convert a register name to a register number. Return true if the
195 /// register name is invalid.
196 bool getRegisterByName(StringRef RegName, unsigned &Reg);
198 void initNames2RegMasks();
200 /// Check if the given identifier is a name of a register mask.
202 /// Return null if the identifier isn't a register mask.
203 const uint32_t *getRegMask(StringRef Identifier);
205 void initNames2SubRegIndices();
207 /// Check if the given identifier is a name of a subregister index.
209 /// Return 0 if the name isn't a subregister index class.
210 unsigned getSubRegIndex(StringRef Name);
212 const BasicBlock *getIRBlock(unsigned Slot);
213 const BasicBlock *getIRBlock(unsigned Slot, const Function &F);
215 void initNames2TargetIndices();
217 /// Try to convert a name of target index to the corresponding target index.
219 /// Return true if the name isn't a name of a target index.
220 bool getTargetIndex(StringRef Name, int &Index);
222 void initNames2DirectTargetFlags();
224 /// Try to convert a name of a direct target flag to the corresponding
227 /// Return true if the name isn't a name of a direct flag.
228 bool getDirectTargetFlag(StringRef Name, unsigned &Flag);
230 void initNames2BitmaskTargetFlags();
232 /// Try to convert a name of a bitmask target flag to the corresponding
235 /// Return true if the name isn't a name of a bitmask target flag.
236 bool getBitmaskTargetFlag(StringRef Name, unsigned &Flag);
239 } // end anonymous namespace
241 MIParser::MIParser(SourceMgr &SM, MachineFunction &MF, SMDiagnostic &Error,
242 StringRef Source, const PerFunctionMIParsingState &PFS,
243 const SlotMapping &IRSlots)
244 : SM(SM), MF(MF), Error(Error), Source(Source), CurrentSource(Source),
245 PFS(PFS), IRSlots(IRSlots) {}
247 void MIParser::lex() {
248 CurrentSource = lexMIToken(
249 CurrentSource, Token,
250 [this](StringRef::iterator Loc, const Twine &Msg) { error(Loc, Msg); });
253 bool MIParser::error(const Twine &Msg) { return error(Token.location(), Msg); }
255 bool MIParser::error(StringRef::iterator Loc, const Twine &Msg) {
256 assert(Loc >= Source.data() && Loc <= (Source.data() + Source.size()));
257 const MemoryBuffer &Buffer = *SM.getMemoryBuffer(SM.getMainFileID());
258 if (Loc >= Buffer.getBufferStart() && Loc <= Buffer.getBufferEnd()) {
259 // Create an ordinary diagnostic when the source manager's buffer is the
261 Error = SM.GetMessage(SMLoc::getFromPointer(Loc), SourceMgr::DK_Error, Msg);
264 // Create a diagnostic for a YAML string literal.
265 Error = SMDiagnostic(SM, SMLoc(), Buffer.getBufferIdentifier(), 1,
266 Loc - Source.data(), SourceMgr::DK_Error, Msg.str(),
271 static const char *toString(MIToken::TokenKind TokenKind) {
279 case MIToken::lparen:
281 case MIToken::rparen:
284 return "<unknown token>";
288 bool MIParser::expectAndConsume(MIToken::TokenKind TokenKind) {
289 if (Token.isNot(TokenKind))
290 return error(Twine("expected ") + toString(TokenKind));
295 bool MIParser::consumeIfPresent(MIToken::TokenKind TokenKind) {
296 if (Token.isNot(TokenKind))
302 bool MIParser::parseBasicBlockDefinition(
303 DenseMap<unsigned, MachineBasicBlock *> &MBBSlots) {
304 assert(Token.is(MIToken::MachineBasicBlockLabel));
308 auto Loc = Token.location();
309 auto Name = Token.stringValue();
311 bool HasAddressTaken = false;
312 bool IsLandingPad = false;
313 unsigned Alignment = 0;
314 BasicBlock *BB = nullptr;
315 if (consumeIfPresent(MIToken::lparen)) {
317 // TODO: Report an error when multiple same attributes are specified.
318 switch (Token.kind()) {
319 case MIToken::kw_address_taken:
320 HasAddressTaken = true;
323 case MIToken::kw_landing_pad:
327 case MIToken::kw_align:
328 if (parseAlignment(Alignment))
331 case MIToken::IRBlock:
332 // TODO: Report an error when both name and ir block are specified.
333 if (parseIRBlock(BB, *MF.getFunction()))
340 } while (consumeIfPresent(MIToken::comma));
341 if (expectAndConsume(MIToken::rparen))
344 if (expectAndConsume(MIToken::colon))
348 BB = dyn_cast_or_null<BasicBlock>(
349 MF.getFunction()->getValueSymbolTable().lookup(Name));
351 return error(Loc, Twine("basic block '") + Name +
352 "' is not defined in the function '" +
355 auto *MBB = MF.CreateMachineBasicBlock(BB);
356 MF.insert(MF.end(), MBB);
357 bool WasInserted = MBBSlots.insert(std::make_pair(ID, MBB)).second;
359 return error(Loc, Twine("redefinition of machine basic block with id #") +
362 MBB->setAlignment(Alignment);
364 MBB->setHasAddressTaken();
365 MBB->setIsLandingPad(IsLandingPad);
369 bool MIParser::parseBasicBlockDefinitions(
370 DenseMap<unsigned, MachineBasicBlock *> &MBBSlots) {
372 // Skip until the first machine basic block.
373 while (Token.is(MIToken::Newline))
375 if (Token.isErrorOrEOF())
376 return Token.isError();
377 if (Token.isNot(MIToken::MachineBasicBlockLabel))
378 return error("expected a basic block definition before instructions");
379 unsigned BraceDepth = 0;
381 if (parseBasicBlockDefinition(MBBSlots))
383 bool IsAfterNewline = false;
384 // Skip until the next machine basic block.
386 if ((Token.is(MIToken::MachineBasicBlockLabel) && IsAfterNewline) ||
387 Token.isErrorOrEOF())
389 else if (Token.is(MIToken::MachineBasicBlockLabel))
390 return error("basic block definition should be located at the start of "
392 else if (consumeIfPresent(MIToken::Newline)) {
393 IsAfterNewline = true;
396 IsAfterNewline = false;
397 if (Token.is(MIToken::lbrace))
399 if (Token.is(MIToken::rbrace)) {
401 return error("extraneous closing brace ('}')");
406 // Verify that we closed all of the '{' at the end of a file or a block.
407 if (!Token.isError() && BraceDepth)
408 return error("expected '}'"); // FIXME: Report a note that shows '{'.
409 } while (!Token.isErrorOrEOF());
410 return Token.isError();
413 bool MIParser::parseBasicBlockLiveins(MachineBasicBlock &MBB) {
414 assert(Token.is(MIToken::kw_liveins));
416 if (expectAndConsume(MIToken::colon))
418 if (Token.isNewlineOrEOF()) // Allow an empty list of liveins.
421 if (Token.isNot(MIToken::NamedRegister))
422 return error("expected a named register");
424 if (parseRegister(Reg))
428 } while (consumeIfPresent(MIToken::comma));
432 bool MIParser::parseBasicBlockSuccessors(MachineBasicBlock &MBB) {
433 assert(Token.is(MIToken::kw_successors));
435 if (expectAndConsume(MIToken::colon))
437 if (Token.isNewlineOrEOF()) // Allow an empty list of successors.
440 if (Token.isNot(MIToken::MachineBasicBlock))
441 return error("expected a machine basic block reference");
442 MachineBasicBlock *SuccMBB = nullptr;
443 if (parseMBBReference(SuccMBB))
447 if (consumeIfPresent(MIToken::lparen)) {
448 if (Token.isNot(MIToken::IntegerLiteral))
449 return error("expected an integer literal after '('");
450 if (getUnsigned(Weight))
453 if (expectAndConsume(MIToken::rparen))
456 MBB.addSuccessor(SuccMBB, Weight);
457 } while (consumeIfPresent(MIToken::comma));
461 bool MIParser::parseBasicBlock(MachineBasicBlock &MBB) {
462 // Skip the definition.
463 assert(Token.is(MIToken::MachineBasicBlockLabel));
465 if (consumeIfPresent(MIToken::lparen)) {
466 while (Token.isNot(MIToken::rparen) && !Token.isErrorOrEOF())
468 consumeIfPresent(MIToken::rparen);
470 consumeIfPresent(MIToken::colon);
472 // Parse the liveins and successors.
473 // N.B: Multiple lists of successors and liveins are allowed and they're
480 // liveins: %edi, %esi
482 if (Token.is(MIToken::kw_successors)) {
483 if (parseBasicBlockSuccessors(MBB))
485 } else if (Token.is(MIToken::kw_liveins)) {
486 if (parseBasicBlockLiveins(MBB))
488 } else if (consumeIfPresent(MIToken::Newline)) {
492 if (!Token.isNewlineOrEOF())
493 return error("expected line break at the end of a list");
497 // Parse the instructions.
498 bool IsInBundle = false;
499 MachineInstr *PrevMI = nullptr;
501 if (Token.is(MIToken::MachineBasicBlockLabel) || Token.is(MIToken::Eof))
503 else if (consumeIfPresent(MIToken::Newline))
505 if (consumeIfPresent(MIToken::rbrace)) {
506 // The first parsing pass should verify that all closing '}' have an
512 MachineInstr *MI = nullptr;
515 MBB.insert(MBB.end(), MI);
517 PrevMI->setFlag(MachineInstr::BundledSucc);
518 MI->setFlag(MachineInstr::BundledPred);
521 if (Token.is(MIToken::lbrace)) {
523 return error("nested instruction bundles are not allowed");
525 // This instruction is the start of the bundle.
526 MI->setFlag(MachineInstr::BundledSucc);
528 if (!Token.is(MIToken::Newline))
529 // The next instruction can be on the same line.
532 assert(Token.isNewlineOrEOF() && "MI is not fully parsed");
538 bool MIParser::parseBasicBlocks() {
540 // Skip until the first machine basic block.
541 while (Token.is(MIToken::Newline))
543 if (Token.isErrorOrEOF())
544 return Token.isError();
545 // The first parsing pass should have verified that this token is a MBB label
546 // in the 'parseBasicBlockDefinitions' method.
547 assert(Token.is(MIToken::MachineBasicBlockLabel));
549 MachineBasicBlock *MBB = nullptr;
550 if (parseMBBReference(MBB))
552 if (parseBasicBlock(*MBB))
554 // The method 'parseBasicBlock' should parse the whole block until the next
555 // block or the end of file.
556 assert(Token.is(MIToken::MachineBasicBlockLabel) || Token.is(MIToken::Eof));
557 } while (Token.isNot(MIToken::Eof));
561 bool MIParser::parse(MachineInstr *&MI) {
562 // Parse any register operands before '='
563 MachineOperand MO = MachineOperand::CreateImm(0);
564 SmallVector<ParsedMachineOperand, 8> Operands;
565 while (Token.isRegister() || Token.isRegisterFlag()) {
566 auto Loc = Token.location();
567 Optional<unsigned> TiedDefIdx;
568 if (parseRegisterOperand(MO, TiedDefIdx, /*IsDef=*/true))
571 ParsedMachineOperand(MO, Loc, Token.location(), TiedDefIdx));
572 if (Token.isNot(MIToken::comma))
576 if (!Operands.empty() && expectAndConsume(MIToken::equal))
579 unsigned OpCode, Flags = 0;
580 if (Token.isError() || parseInstruction(OpCode, Flags))
583 // Parse the remaining machine operands.
584 while (!Token.isNewlineOrEOF() && Token.isNot(MIToken::kw_debug_location) &&
585 Token.isNot(MIToken::coloncolon) && Token.isNot(MIToken::lbrace)) {
586 auto Loc = Token.location();
587 Optional<unsigned> TiedDefIdx;
588 if (parseMachineOperandAndTargetFlags(MO, TiedDefIdx))
591 ParsedMachineOperand(MO, Loc, Token.location(), TiedDefIdx));
592 if (Token.isNewlineOrEOF() || Token.is(MIToken::coloncolon) ||
593 Token.is(MIToken::lbrace))
595 if (Token.isNot(MIToken::comma))
596 return error("expected ',' before the next machine operand");
600 DebugLoc DebugLocation;
601 if (Token.is(MIToken::kw_debug_location)) {
603 if (Token.isNot(MIToken::exclaim))
604 return error("expected a metadata node after 'debug-location'");
605 MDNode *Node = nullptr;
606 if (parseMDNode(Node))
608 DebugLocation = DebugLoc(Node);
611 // Parse the machine memory operands.
612 SmallVector<MachineMemOperand *, 2> MemOperands;
613 if (Token.is(MIToken::coloncolon)) {
615 while (!Token.isNewlineOrEOF()) {
616 MachineMemOperand *MemOp = nullptr;
617 if (parseMachineMemoryOperand(MemOp))
619 MemOperands.push_back(MemOp);
620 if (Token.isNewlineOrEOF())
622 if (Token.isNot(MIToken::comma))
623 return error("expected ',' before the next machine memory operand");
628 const auto &MCID = MF.getSubtarget().getInstrInfo()->get(OpCode);
629 if (!MCID.isVariadic()) {
630 // FIXME: Move the implicit operand verification to the machine verifier.
631 if (verifyImplicitOperands(Operands, MCID))
635 // TODO: Check for extraneous machine operands.
636 MI = MF.CreateMachineInstr(MCID, DebugLocation, /*NoImplicit=*/true);
638 for (const auto &Operand : Operands)
639 MI->addOperand(MF, Operand.Operand);
640 if (assignRegisterTies(*MI, Operands))
642 if (MemOperands.empty())
644 MachineInstr::mmo_iterator MemRefs =
645 MF.allocateMemRefsArray(MemOperands.size());
646 std::copy(MemOperands.begin(), MemOperands.end(), MemRefs);
647 MI->setMemRefs(MemRefs, MemRefs + MemOperands.size());
651 bool MIParser::parseStandaloneMBB(MachineBasicBlock *&MBB) {
653 if (Token.isNot(MIToken::MachineBasicBlock))
654 return error("expected a machine basic block reference");
655 if (parseMBBReference(MBB))
658 if (Token.isNot(MIToken::Eof))
660 "expected end of string after the machine basic block reference");
664 bool MIParser::parseStandaloneNamedRegister(unsigned &Reg) {
666 if (Token.isNot(MIToken::NamedRegister))
667 return error("expected a named register");
668 if (parseRegister(Reg))
671 if (Token.isNot(MIToken::Eof))
672 return error("expected end of string after the register reference");
676 bool MIParser::parseStandaloneVirtualRegister(unsigned &Reg) {
678 if (Token.isNot(MIToken::VirtualRegister))
679 return error("expected a virtual register");
680 if (parseRegister(Reg))
683 if (Token.isNot(MIToken::Eof))
684 return error("expected end of string after the register reference");
688 bool MIParser::parseStandaloneStackObject(int &FI) {
690 if (Token.isNot(MIToken::StackObject))
691 return error("expected a stack object");
692 if (parseStackFrameIndex(FI))
694 if (Token.isNot(MIToken::Eof))
695 return error("expected end of string after the stack object reference");
699 bool MIParser::parseStandaloneMDNode(MDNode *&Node) {
701 if (Token.isNot(MIToken::exclaim))
702 return error("expected a metadata node");
703 if (parseMDNode(Node))
705 if (Token.isNot(MIToken::Eof))
706 return error("expected end of string after the metadata node");
710 static const char *printImplicitRegisterFlag(const MachineOperand &MO) {
711 assert(MO.isImplicit());
712 return MO.isDef() ? "implicit-def" : "implicit";
715 static std::string getRegisterName(const TargetRegisterInfo *TRI,
717 assert(TargetRegisterInfo::isPhysicalRegister(Reg) && "expected phys reg");
718 return StringRef(TRI->getName(Reg)).lower();
721 bool MIParser::verifyImplicitOperands(ArrayRef<ParsedMachineOperand> Operands,
722 const MCInstrDesc &MCID) {
724 // We can't verify call instructions as they can contain arbitrary implicit
725 // register and register mask operands.
728 // Gather all the expected implicit operands.
729 SmallVector<MachineOperand, 4> ImplicitOperands;
730 if (MCID.ImplicitDefs)
731 for (const uint16_t *ImpDefs = MCID.getImplicitDefs(); *ImpDefs; ++ImpDefs)
732 ImplicitOperands.push_back(
733 MachineOperand::CreateReg(*ImpDefs, true, true));
734 if (MCID.ImplicitUses)
735 for (const uint16_t *ImpUses = MCID.getImplicitUses(); *ImpUses; ++ImpUses)
736 ImplicitOperands.push_back(
737 MachineOperand::CreateReg(*ImpUses, false, true));
739 const auto *TRI = MF.getSubtarget().getRegisterInfo();
740 assert(TRI && "Expected target register info");
741 size_t I = ImplicitOperands.size(), J = Operands.size();
746 const auto &ImplicitOperand = ImplicitOperands[I];
747 const auto &Operand = Operands[J].Operand;
748 if (ImplicitOperand.isIdenticalTo(Operand))
750 if (Operand.isReg() && Operand.isImplicit()) {
751 // Check if this implicit register is a subregister of an explicit
753 bool IsImplicitSubRegister = false;
754 for (size_t K = 0, E = Operands.size(); K < E; ++K) {
755 const auto &Op = Operands[K].Operand;
756 if (Op.isReg() && !Op.isImplicit() &&
757 TRI->isSubRegister(Op.getReg(), Operand.getReg())) {
758 IsImplicitSubRegister = true;
762 if (IsImplicitSubRegister)
764 return error(Operands[J].Begin,
765 Twine("expected an implicit register operand '") +
766 printImplicitRegisterFlag(ImplicitOperand) + " %" +
767 getRegisterName(TRI, ImplicitOperand.getReg()) + "'");
770 // TODO: Fix source location when Operands[J].end is right before '=', i.e:
771 // insead of reporting an error at this location:
774 // report the error at the following location:
777 return error(J < Operands.size() ? Operands[J].End : Token.location(),
778 Twine("missing implicit register operand '") +
779 printImplicitRegisterFlag(ImplicitOperands[I]) + " %" +
780 getRegisterName(TRI, ImplicitOperands[I].getReg()) + "'");
785 bool MIParser::parseInstruction(unsigned &OpCode, unsigned &Flags) {
786 if (Token.is(MIToken::kw_frame_setup)) {
787 Flags |= MachineInstr::FrameSetup;
790 if (Token.isNot(MIToken::Identifier))
791 return error("expected a machine instruction");
792 StringRef InstrName = Token.stringValue();
793 if (parseInstrName(InstrName, OpCode))
794 return error(Twine("unknown machine instruction name '") + InstrName + "'");
799 bool MIParser::parseRegister(unsigned &Reg) {
800 switch (Token.kind()) {
801 case MIToken::underscore:
804 case MIToken::NamedRegister: {
805 StringRef Name = Token.stringValue();
806 if (getRegisterByName(Name, Reg))
807 return error(Twine("unknown register name '") + Name + "'");
810 case MIToken::VirtualRegister: {
814 const auto RegInfo = PFS.VirtualRegisterSlots.find(ID);
815 if (RegInfo == PFS.VirtualRegisterSlots.end())
816 return error(Twine("use of undefined virtual register '%") + Twine(ID) +
818 Reg = RegInfo->second;
821 // TODO: Parse other register kinds.
823 llvm_unreachable("The current token should be a register");
828 bool MIParser::parseRegisterFlag(unsigned &Flags) {
829 const unsigned OldFlags = Flags;
830 switch (Token.kind()) {
831 case MIToken::kw_implicit:
832 Flags |= RegState::Implicit;
834 case MIToken::kw_implicit_define:
835 Flags |= RegState::ImplicitDefine;
837 case MIToken::kw_def:
838 Flags |= RegState::Define;
840 case MIToken::kw_dead:
841 Flags |= RegState::Dead;
843 case MIToken::kw_killed:
844 Flags |= RegState::Kill;
846 case MIToken::kw_undef:
847 Flags |= RegState::Undef;
849 case MIToken::kw_internal:
850 Flags |= RegState::InternalRead;
852 case MIToken::kw_early_clobber:
853 Flags |= RegState::EarlyClobber;
855 case MIToken::kw_debug_use:
856 Flags |= RegState::Debug;
859 llvm_unreachable("The current token should be a register flag");
861 if (OldFlags == Flags)
862 // We know that the same flag is specified more than once when the flags
864 return error("duplicate '" + Token.stringValue() + "' register flag");
869 bool MIParser::parseSubRegisterIndex(unsigned &SubReg) {
870 assert(Token.is(MIToken::colon));
872 if (Token.isNot(MIToken::Identifier))
873 return error("expected a subregister index after ':'");
874 auto Name = Token.stringValue();
875 SubReg = getSubRegIndex(Name);
877 return error(Twine("use of unknown subregister index '") + Name + "'");
882 bool MIParser::parseRegisterTiedDefIndex(unsigned &TiedDefIdx) {
883 if (!consumeIfPresent(MIToken::kw_tied_def))
884 return error("expected 'tied-def' after '('");
885 if (Token.isNot(MIToken::IntegerLiteral))
886 return error("expected an integer literal after 'tied-def'");
887 if (getUnsigned(TiedDefIdx))
890 if (expectAndConsume(MIToken::rparen))
895 bool MIParser::assignRegisterTies(MachineInstr &MI,
896 ArrayRef<ParsedMachineOperand> Operands) {
897 SmallVector<std::pair<unsigned, unsigned>, 4> TiedRegisterPairs;
898 for (unsigned I = 0, E = Operands.size(); I != E; ++I) {
899 if (!Operands[I].TiedDefIdx)
901 // The parser ensures that this operand is a register use, so we just have
902 // to check the tied-def operand.
903 unsigned DefIdx = Operands[I].TiedDefIdx.getValue();
905 return error(Operands[I].Begin,
906 Twine("use of invalid tied-def operand index '" +
907 Twine(DefIdx) + "'; instruction has only ") +
908 Twine(E) + " operands");
909 const auto &DefOperand = Operands[DefIdx].Operand;
910 if (!DefOperand.isReg() || !DefOperand.isDef())
911 // FIXME: add note with the def operand.
912 return error(Operands[I].Begin,
913 Twine("use of invalid tied-def operand index '") +
914 Twine(DefIdx) + "'; the operand #" + Twine(DefIdx) +
915 " isn't a defined register");
916 // Check that the tied-def operand wasn't tied elsewhere.
917 for (const auto &TiedPair : TiedRegisterPairs) {
918 if (TiedPair.first == DefIdx)
919 return error(Operands[I].Begin,
920 Twine("the tied-def operand #") + Twine(DefIdx) +
921 " is already tied with another register operand");
923 TiedRegisterPairs.push_back(std::make_pair(DefIdx, I));
925 // FIXME: Verify that for non INLINEASM instructions, the def and use tied
926 // indices must be less than tied max.
927 for (const auto &TiedPair : TiedRegisterPairs)
928 MI.tieOperands(TiedPair.first, TiedPair.second);
932 bool MIParser::parseRegisterOperand(MachineOperand &Dest,
933 Optional<unsigned> &TiedDefIdx,
936 unsigned Flags = IsDef ? RegState::Define : 0;
937 while (Token.isRegisterFlag()) {
938 if (parseRegisterFlag(Flags))
941 if (!Token.isRegister())
942 return error("expected a register after register flags");
943 if (parseRegister(Reg))
947 if (Token.is(MIToken::colon)) {
948 if (parseSubRegisterIndex(SubReg))
951 if ((Flags & RegState::Define) == 0 && consumeIfPresent(MIToken::lparen)) {
953 if (parseRegisterTiedDefIndex(Idx))
957 Dest = MachineOperand::CreateReg(
958 Reg, Flags & RegState::Define, Flags & RegState::Implicit,
959 Flags & RegState::Kill, Flags & RegState::Dead, Flags & RegState::Undef,
960 Flags & RegState::EarlyClobber, SubReg, Flags & RegState::Debug,
961 Flags & RegState::InternalRead);
965 bool MIParser::parseImmediateOperand(MachineOperand &Dest) {
966 assert(Token.is(MIToken::IntegerLiteral));
967 const APSInt &Int = Token.integerValue();
968 if (Int.getMinSignedBits() > 64)
969 return error("integer literal is too large to be an immediate operand");
970 Dest = MachineOperand::CreateImm(Int.getExtValue());
975 bool MIParser::parseIRConstant(StringRef::iterator Loc, const Constant *&C) {
976 auto Source = StringRef(Loc, Token.range().end() - Loc).str();
979 C = parseConstantValue(Source.c_str(), Err, *MF.getFunction()->getParent());
981 return error(Loc + Err.getColumnNo(), Err.getMessage());
985 bool MIParser::parseTypedImmediateOperand(MachineOperand &Dest) {
986 assert(Token.is(MIToken::IntegerType));
987 auto Loc = Token.location();
989 if (Token.isNot(MIToken::IntegerLiteral))
990 return error("expected an integer literal");
991 const Constant *C = nullptr;
992 if (parseIRConstant(Loc, C))
994 Dest = MachineOperand::CreateCImm(cast<ConstantInt>(C));
998 bool MIParser::parseFPImmediateOperand(MachineOperand &Dest) {
999 auto Loc = Token.location();
1001 if (Token.isNot(MIToken::FloatingPointLiteral))
1002 return error("expected a floating point literal");
1003 const Constant *C = nullptr;
1004 if (parseIRConstant(Loc, C))
1006 Dest = MachineOperand::CreateFPImm(cast<ConstantFP>(C));
1010 bool MIParser::getUnsigned(unsigned &Result) {
1011 assert(Token.hasIntegerValue() && "Expected a token with an integer value");
1012 const uint64_t Limit = uint64_t(std::numeric_limits<unsigned>::max()) + 1;
1013 uint64_t Val64 = Token.integerValue().getLimitedValue(Limit);
1015 return error("expected 32-bit integer (too large)");
1020 bool MIParser::parseMBBReference(MachineBasicBlock *&MBB) {
1021 assert(Token.is(MIToken::MachineBasicBlock) ||
1022 Token.is(MIToken::MachineBasicBlockLabel));
1024 if (getUnsigned(Number))
1026 auto MBBInfo = PFS.MBBSlots.find(Number);
1027 if (MBBInfo == PFS.MBBSlots.end())
1028 return error(Twine("use of undefined machine basic block #") +
1030 MBB = MBBInfo->second;
1031 if (!Token.stringValue().empty() && Token.stringValue() != MBB->getName())
1032 return error(Twine("the name of machine basic block #") + Twine(Number) +
1033 " isn't '" + Token.stringValue() + "'");
1037 bool MIParser::parseMBBOperand(MachineOperand &Dest) {
1038 MachineBasicBlock *MBB;
1039 if (parseMBBReference(MBB))
1041 Dest = MachineOperand::CreateMBB(MBB);
1046 bool MIParser::parseStackFrameIndex(int &FI) {
1047 assert(Token.is(MIToken::StackObject));
1049 if (getUnsigned(ID))
1051 auto ObjectInfo = PFS.StackObjectSlots.find(ID);
1052 if (ObjectInfo == PFS.StackObjectSlots.end())
1053 return error(Twine("use of undefined stack object '%stack.") + Twine(ID) +
1056 if (const auto *Alloca =
1057 MF.getFrameInfo()->getObjectAllocation(ObjectInfo->second))
1058 Name = Alloca->getName();
1059 if (!Token.stringValue().empty() && Token.stringValue() != Name)
1060 return error(Twine("the name of the stack object '%stack.") + Twine(ID) +
1061 "' isn't '" + Token.stringValue() + "'");
1063 FI = ObjectInfo->second;
1067 bool MIParser::parseStackObjectOperand(MachineOperand &Dest) {
1069 if (parseStackFrameIndex(FI))
1071 Dest = MachineOperand::CreateFI(FI);
1075 bool MIParser::parseFixedStackFrameIndex(int &FI) {
1076 assert(Token.is(MIToken::FixedStackObject));
1078 if (getUnsigned(ID))
1080 auto ObjectInfo = PFS.FixedStackObjectSlots.find(ID);
1081 if (ObjectInfo == PFS.FixedStackObjectSlots.end())
1082 return error(Twine("use of undefined fixed stack object '%fixed-stack.") +
1085 FI = ObjectInfo->second;
1089 bool MIParser::parseFixedStackObjectOperand(MachineOperand &Dest) {
1091 if (parseFixedStackFrameIndex(FI))
1093 Dest = MachineOperand::CreateFI(FI);
1097 bool MIParser::parseGlobalValue(GlobalValue *&GV) {
1098 switch (Token.kind()) {
1099 case MIToken::NamedGlobalValue: {
1100 const Module *M = MF.getFunction()->getParent();
1101 GV = M->getNamedValue(Token.stringValue());
1103 return error(Twine("use of undefined global value '") + Token.range() +
1107 case MIToken::GlobalValue: {
1109 if (getUnsigned(GVIdx))
1111 if (GVIdx >= IRSlots.GlobalValues.size())
1112 return error(Twine("use of undefined global value '@") + Twine(GVIdx) +
1114 GV = IRSlots.GlobalValues[GVIdx];
1118 llvm_unreachable("The current token should be a global value");
1123 bool MIParser::parseGlobalAddressOperand(MachineOperand &Dest) {
1124 GlobalValue *GV = nullptr;
1125 if (parseGlobalValue(GV))
1128 Dest = MachineOperand::CreateGA(GV, /*Offset=*/0);
1129 if (parseOperandsOffset(Dest))
1134 bool MIParser::parseConstantPoolIndexOperand(MachineOperand &Dest) {
1135 assert(Token.is(MIToken::ConstantPoolItem));
1137 if (getUnsigned(ID))
1139 auto ConstantInfo = PFS.ConstantPoolSlots.find(ID);
1140 if (ConstantInfo == PFS.ConstantPoolSlots.end())
1141 return error("use of undefined constant '%const." + Twine(ID) + "'");
1143 Dest = MachineOperand::CreateCPI(ID, /*Offset=*/0);
1144 if (parseOperandsOffset(Dest))
1149 bool MIParser::parseJumpTableIndexOperand(MachineOperand &Dest) {
1150 assert(Token.is(MIToken::JumpTableIndex));
1152 if (getUnsigned(ID))
1154 auto JumpTableEntryInfo = PFS.JumpTableSlots.find(ID);
1155 if (JumpTableEntryInfo == PFS.JumpTableSlots.end())
1156 return error("use of undefined jump table '%jump-table." + Twine(ID) + "'");
1158 Dest = MachineOperand::CreateJTI(JumpTableEntryInfo->second);
1162 bool MIParser::parseExternalSymbolOperand(MachineOperand &Dest) {
1163 assert(Token.is(MIToken::ExternalSymbol));
1164 const char *Symbol = MF.createExternalSymbolName(Token.stringValue());
1166 Dest = MachineOperand::CreateES(Symbol);
1167 if (parseOperandsOffset(Dest))
1172 bool MIParser::parseMDNode(MDNode *&Node) {
1173 assert(Token.is(MIToken::exclaim));
1174 auto Loc = Token.location();
1176 if (Token.isNot(MIToken::IntegerLiteral) || Token.integerValue().isSigned())
1177 return error("expected metadata id after '!'");
1179 if (getUnsigned(ID))
1181 auto NodeInfo = IRSlots.MetadataNodes.find(ID);
1182 if (NodeInfo == IRSlots.MetadataNodes.end())
1183 return error(Loc, "use of undefined metadata '!" + Twine(ID) + "'");
1185 Node = NodeInfo->second.get();
1189 bool MIParser::parseMetadataOperand(MachineOperand &Dest) {
1190 MDNode *Node = nullptr;
1191 if (parseMDNode(Node))
1193 Dest = MachineOperand::CreateMetadata(Node);
1197 bool MIParser::parseCFIOffset(int &Offset) {
1198 if (Token.isNot(MIToken::IntegerLiteral))
1199 return error("expected a cfi offset");
1200 if (Token.integerValue().getMinSignedBits() > 32)
1201 return error("expected a 32 bit integer (the cfi offset is too large)");
1202 Offset = (int)Token.integerValue().getExtValue();
1207 bool MIParser::parseCFIRegister(unsigned &Reg) {
1208 if (Token.isNot(MIToken::NamedRegister))
1209 return error("expected a cfi register");
1211 if (parseRegister(LLVMReg))
1213 const auto *TRI = MF.getSubtarget().getRegisterInfo();
1214 assert(TRI && "Expected target register info");
1215 int DwarfReg = TRI->getDwarfRegNum(LLVMReg, true);
1217 return error("invalid DWARF register");
1218 Reg = (unsigned)DwarfReg;
1223 bool MIParser::parseCFIOperand(MachineOperand &Dest) {
1224 auto Kind = Token.kind();
1226 auto &MMI = MF.getMMI();
1231 case MIToken::kw_cfi_same_value:
1232 if (parseCFIRegister(Reg))
1235 MMI.addFrameInst(MCCFIInstruction::createSameValue(nullptr, Reg));
1237 case MIToken::kw_cfi_offset:
1238 if (parseCFIRegister(Reg) || expectAndConsume(MIToken::comma) ||
1239 parseCFIOffset(Offset))
1242 MMI.addFrameInst(MCCFIInstruction::createOffset(nullptr, Reg, Offset));
1244 case MIToken::kw_cfi_def_cfa_register:
1245 if (parseCFIRegister(Reg))
1248 MMI.addFrameInst(MCCFIInstruction::createDefCfaRegister(nullptr, Reg));
1250 case MIToken::kw_cfi_def_cfa_offset:
1251 if (parseCFIOffset(Offset))
1253 // NB: MCCFIInstruction::createDefCfaOffset negates the offset.
1254 CFIIndex = MMI.addFrameInst(
1255 MCCFIInstruction::createDefCfaOffset(nullptr, -Offset));
1257 case MIToken::kw_cfi_def_cfa:
1258 if (parseCFIRegister(Reg) || expectAndConsume(MIToken::comma) ||
1259 parseCFIOffset(Offset))
1261 // NB: MCCFIInstruction::createDefCfa negates the offset.
1263 MMI.addFrameInst(MCCFIInstruction::createDefCfa(nullptr, Reg, -Offset));
1266 // TODO: Parse the other CFI operands.
1267 llvm_unreachable("The current token should be a cfi operand");
1269 Dest = MachineOperand::CreateCFIIndex(CFIIndex);
1273 bool MIParser::parseIRBlock(BasicBlock *&BB, const Function &F) {
1274 switch (Token.kind()) {
1275 case MIToken::NamedIRBlock: {
1276 BB = dyn_cast_or_null<BasicBlock>(
1277 F.getValueSymbolTable().lookup(Token.stringValue()));
1279 return error(Twine("use of undefined IR block '") + Token.range() + "'");
1282 case MIToken::IRBlock: {
1283 unsigned SlotNumber = 0;
1284 if (getUnsigned(SlotNumber))
1286 BB = const_cast<BasicBlock *>(getIRBlock(SlotNumber, F));
1288 return error(Twine("use of undefined IR block '%ir-block.") +
1289 Twine(SlotNumber) + "'");
1293 llvm_unreachable("The current token should be an IR block reference");
1298 bool MIParser::parseBlockAddressOperand(MachineOperand &Dest) {
1299 assert(Token.is(MIToken::kw_blockaddress));
1301 if (expectAndConsume(MIToken::lparen))
1303 if (Token.isNot(MIToken::GlobalValue) &&
1304 Token.isNot(MIToken::NamedGlobalValue))
1305 return error("expected a global value");
1306 GlobalValue *GV = nullptr;
1307 if (parseGlobalValue(GV))
1309 auto *F = dyn_cast<Function>(GV);
1311 return error("expected an IR function reference");
1313 if (expectAndConsume(MIToken::comma))
1315 BasicBlock *BB = nullptr;
1316 if (Token.isNot(MIToken::IRBlock) && Token.isNot(MIToken::NamedIRBlock))
1317 return error("expected an IR block reference");
1318 if (parseIRBlock(BB, *F))
1321 if (expectAndConsume(MIToken::rparen))
1323 Dest = MachineOperand::CreateBA(BlockAddress::get(F, BB), /*Offset=*/0);
1324 if (parseOperandsOffset(Dest))
1329 bool MIParser::parseTargetIndexOperand(MachineOperand &Dest) {
1330 assert(Token.is(MIToken::kw_target_index));
1332 if (expectAndConsume(MIToken::lparen))
1334 if (Token.isNot(MIToken::Identifier))
1335 return error("expected the name of the target index");
1337 if (getTargetIndex(Token.stringValue(), Index))
1338 return error("use of undefined target index '" + Token.stringValue() + "'");
1340 if (expectAndConsume(MIToken::rparen))
1342 Dest = MachineOperand::CreateTargetIndex(unsigned(Index), /*Offset=*/0);
1343 if (parseOperandsOffset(Dest))
1348 bool MIParser::parseLiveoutRegisterMaskOperand(MachineOperand &Dest) {
1349 assert(Token.is(MIToken::kw_liveout));
1350 const auto *TRI = MF.getSubtarget().getRegisterInfo();
1351 assert(TRI && "Expected target register info");
1352 uint32_t *Mask = MF.allocateRegisterMask(TRI->getNumRegs());
1354 if (expectAndConsume(MIToken::lparen))
1357 if (Token.isNot(MIToken::NamedRegister))
1358 return error("expected a named register");
1360 if (parseRegister(Reg))
1363 Mask[Reg / 32] |= 1U << (Reg % 32);
1364 // TODO: Report an error if the same register is used more than once.
1365 if (Token.isNot(MIToken::comma))
1369 if (expectAndConsume(MIToken::rparen))
1371 Dest = MachineOperand::CreateRegLiveOut(Mask);
1375 bool MIParser::parseMachineOperand(MachineOperand &Dest,
1376 Optional<unsigned> &TiedDefIdx) {
1377 switch (Token.kind()) {
1378 case MIToken::kw_implicit:
1379 case MIToken::kw_implicit_define:
1380 case MIToken::kw_def:
1381 case MIToken::kw_dead:
1382 case MIToken::kw_killed:
1383 case MIToken::kw_undef:
1384 case MIToken::kw_internal:
1385 case MIToken::kw_early_clobber:
1386 case MIToken::kw_debug_use:
1387 case MIToken::underscore:
1388 case MIToken::NamedRegister:
1389 case MIToken::VirtualRegister:
1390 return parseRegisterOperand(Dest, TiedDefIdx);
1391 case MIToken::IntegerLiteral:
1392 return parseImmediateOperand(Dest);
1393 case MIToken::IntegerType:
1394 return parseTypedImmediateOperand(Dest);
1395 case MIToken::kw_half:
1396 case MIToken::kw_float:
1397 case MIToken::kw_double:
1398 case MIToken::kw_x86_fp80:
1399 case MIToken::kw_fp128:
1400 case MIToken::kw_ppc_fp128:
1401 return parseFPImmediateOperand(Dest);
1402 case MIToken::MachineBasicBlock:
1403 return parseMBBOperand(Dest);
1404 case MIToken::StackObject:
1405 return parseStackObjectOperand(Dest);
1406 case MIToken::FixedStackObject:
1407 return parseFixedStackObjectOperand(Dest);
1408 case MIToken::GlobalValue:
1409 case MIToken::NamedGlobalValue:
1410 return parseGlobalAddressOperand(Dest);
1411 case MIToken::ConstantPoolItem:
1412 return parseConstantPoolIndexOperand(Dest);
1413 case MIToken::JumpTableIndex:
1414 return parseJumpTableIndexOperand(Dest);
1415 case MIToken::ExternalSymbol:
1416 return parseExternalSymbolOperand(Dest);
1417 case MIToken::exclaim:
1418 return parseMetadataOperand(Dest);
1419 case MIToken::kw_cfi_same_value:
1420 case MIToken::kw_cfi_offset:
1421 case MIToken::kw_cfi_def_cfa_register:
1422 case MIToken::kw_cfi_def_cfa_offset:
1423 case MIToken::kw_cfi_def_cfa:
1424 return parseCFIOperand(Dest);
1425 case MIToken::kw_blockaddress:
1426 return parseBlockAddressOperand(Dest);
1427 case MIToken::kw_target_index:
1428 return parseTargetIndexOperand(Dest);
1429 case MIToken::kw_liveout:
1430 return parseLiveoutRegisterMaskOperand(Dest);
1431 case MIToken::Error:
1433 case MIToken::Identifier:
1434 if (const auto *RegMask = getRegMask(Token.stringValue())) {
1435 Dest = MachineOperand::CreateRegMask(RegMask);
1441 // TODO: parse the other machine operands.
1442 return error("expected a machine operand");
1447 bool MIParser::parseMachineOperandAndTargetFlags(
1448 MachineOperand &Dest, Optional<unsigned> &TiedDefIdx) {
1450 bool HasTargetFlags = false;
1451 if (Token.is(MIToken::kw_target_flags)) {
1452 HasTargetFlags = true;
1454 if (expectAndConsume(MIToken::lparen))
1456 if (Token.isNot(MIToken::Identifier))
1457 return error("expected the name of the target flag");
1458 if (getDirectTargetFlag(Token.stringValue(), TF)) {
1459 if (getBitmaskTargetFlag(Token.stringValue(), TF))
1460 return error("use of undefined target flag '" + Token.stringValue() +
1464 while (Token.is(MIToken::comma)) {
1466 if (Token.isNot(MIToken::Identifier))
1467 return error("expected the name of the target flag");
1468 unsigned BitFlag = 0;
1469 if (getBitmaskTargetFlag(Token.stringValue(), BitFlag))
1470 return error("use of undefined target flag '" + Token.stringValue() +
1472 // TODO: Report an error when using a duplicate bit target flag.
1476 if (expectAndConsume(MIToken::rparen))
1479 auto Loc = Token.location();
1480 if (parseMachineOperand(Dest, TiedDefIdx))
1482 if (!HasTargetFlags)
1485 return error(Loc, "register operands can't have target flags");
1486 Dest.setTargetFlags(TF);
1490 bool MIParser::parseOffset(int64_t &Offset) {
1491 if (Token.isNot(MIToken::plus) && Token.isNot(MIToken::minus))
1493 StringRef Sign = Token.range();
1494 bool IsNegative = Token.is(MIToken::minus);
1496 if (Token.isNot(MIToken::IntegerLiteral))
1497 return error("expected an integer literal after '" + Sign + "'");
1498 if (Token.integerValue().getMinSignedBits() > 64)
1499 return error("expected 64-bit integer (too large)");
1500 Offset = Token.integerValue().getExtValue();
1507 bool MIParser::parseAlignment(unsigned &Alignment) {
1508 assert(Token.is(MIToken::kw_align));
1510 if (Token.isNot(MIToken::IntegerLiteral) || Token.integerValue().isSigned())
1511 return error("expected an integer literal after 'align'");
1512 if (getUnsigned(Alignment))
1518 bool MIParser::parseOperandsOffset(MachineOperand &Op) {
1520 if (parseOffset(Offset))
1522 Op.setOffset(Offset);
1526 bool MIParser::parseIRValue(Value *&V) {
1527 switch (Token.kind()) {
1528 case MIToken::NamedIRValue: {
1529 V = MF.getFunction()->getValueSymbolTable().lookup(Token.stringValue());
1531 V = MF.getFunction()->getParent()->getValueSymbolTable().lookup(
1532 Token.stringValue());
1534 return error(Twine("use of undefined IR value '") + Token.range() + "'");
1537 // TODO: Parse unnamed IR value references.
1539 llvm_unreachable("The current token should be an IR block reference");
1544 bool MIParser::getUint64(uint64_t &Result) {
1545 assert(Token.hasIntegerValue());
1546 if (Token.integerValue().getActiveBits() > 64)
1547 return error("expected 64-bit integer (too large)");
1548 Result = Token.integerValue().getZExtValue();
1552 bool MIParser::parseMemoryOperandFlag(unsigned &Flags) {
1553 const unsigned OldFlags = Flags;
1554 switch (Token.kind()) {
1555 case MIToken::kw_volatile:
1556 Flags |= MachineMemOperand::MOVolatile;
1558 case MIToken::kw_non_temporal:
1559 Flags |= MachineMemOperand::MONonTemporal;
1561 case MIToken::kw_invariant:
1562 Flags |= MachineMemOperand::MOInvariant;
1564 // TODO: parse the target specific memory operand flags.
1566 llvm_unreachable("The current token should be a memory operand flag");
1568 if (OldFlags == Flags)
1569 // We know that the same flag is specified more than once when the flags
1570 // weren't modified.
1571 return error("duplicate '" + Token.stringValue() + "' memory operand flag");
1576 bool MIParser::parseMemoryPseudoSourceValue(const PseudoSourceValue *&PSV) {
1577 switch (Token.kind()) {
1578 case MIToken::kw_stack:
1579 PSV = MF.getPSVManager().getStack();
1581 case MIToken::kw_got:
1582 PSV = MF.getPSVManager().getGOT();
1584 case MIToken::kw_jump_table:
1585 PSV = MF.getPSVManager().getJumpTable();
1587 case MIToken::kw_constant_pool:
1588 PSV = MF.getPSVManager().getConstantPool();
1590 case MIToken::FixedStackObject: {
1592 if (parseFixedStackFrameIndex(FI))
1594 PSV = MF.getPSVManager().getFixedStack(FI);
1595 // The token was already consumed, so use return here instead of break.
1598 case MIToken::GlobalValue:
1599 case MIToken::NamedGlobalValue: {
1600 GlobalValue *GV = nullptr;
1601 if (parseGlobalValue(GV))
1603 PSV = MF.getPSVManager().getGlobalValueCallEntry(GV);
1606 case MIToken::ExternalSymbol:
1607 PSV = MF.getPSVManager().getExternalSymbolCallEntry(
1608 MF.createExternalSymbolName(Token.stringValue()));
1611 llvm_unreachable("The current token should be pseudo source value");
1617 bool MIParser::parseMachinePointerInfo(MachinePointerInfo &Dest) {
1618 if (Token.is(MIToken::kw_constant_pool) || Token.is(MIToken::kw_stack) ||
1619 Token.is(MIToken::kw_got) || Token.is(MIToken::kw_jump_table) ||
1620 Token.is(MIToken::FixedStackObject) || Token.is(MIToken::GlobalValue) ||
1621 Token.is(MIToken::NamedGlobalValue) ||
1622 Token.is(MIToken::ExternalSymbol)) {
1623 const PseudoSourceValue *PSV = nullptr;
1624 if (parseMemoryPseudoSourceValue(PSV))
1627 if (parseOffset(Offset))
1629 Dest = MachinePointerInfo(PSV, Offset);
1632 if (Token.isNot(MIToken::NamedIRValue))
1633 return error("expected an IR value reference");
1635 if (parseIRValue(V))
1637 if (!V->getType()->isPointerTy())
1638 return error("expected a pointer IR value");
1641 if (parseOffset(Offset))
1643 Dest = MachinePointerInfo(V, Offset);
1647 bool MIParser::parseMachineMemoryOperand(MachineMemOperand *&Dest) {
1648 if (expectAndConsume(MIToken::lparen))
1651 while (Token.isMemoryOperandFlag()) {
1652 if (parseMemoryOperandFlag(Flags))
1655 if (Token.isNot(MIToken::Identifier) ||
1656 (Token.stringValue() != "load" && Token.stringValue() != "store"))
1657 return error("expected 'load' or 'store' memory operation");
1658 if (Token.stringValue() == "load")
1659 Flags |= MachineMemOperand::MOLoad;
1661 Flags |= MachineMemOperand::MOStore;
1664 if (Token.isNot(MIToken::IntegerLiteral))
1665 return error("expected the size integer literal after memory operation");
1667 if (getUint64(Size))
1671 const char *Word = Flags & MachineMemOperand::MOLoad ? "from" : "into";
1672 if (Token.isNot(MIToken::Identifier) || Token.stringValue() != Word)
1673 return error(Twine("expected '") + Word + "'");
1676 MachinePointerInfo Ptr = MachinePointerInfo();
1677 if (parseMachinePointerInfo(Ptr))
1679 unsigned BaseAlignment = Size;
1681 MDNode *Range = nullptr;
1682 while (consumeIfPresent(MIToken::comma)) {
1683 switch (Token.kind()) {
1684 case MIToken::kw_align:
1685 if (parseAlignment(BaseAlignment))
1688 case MIToken::md_tbaa:
1690 if (parseMDNode(AAInfo.TBAA))
1693 case MIToken::md_alias_scope:
1695 if (parseMDNode(AAInfo.Scope))
1698 case MIToken::md_noalias:
1700 if (parseMDNode(AAInfo.NoAlias))
1703 case MIToken::md_range:
1705 if (parseMDNode(Range))
1708 // TODO: Report an error on duplicate metadata nodes.
1710 return error("expected 'align' or '!tbaa' or '!alias.scope' or "
1711 "'!noalias' or '!range'");
1714 if (expectAndConsume(MIToken::rparen))
1717 MF.getMachineMemOperand(Ptr, Flags, Size, BaseAlignment, AAInfo, Range);
1721 void MIParser::initNames2InstrOpCodes() {
1722 if (!Names2InstrOpCodes.empty())
1724 const auto *TII = MF.getSubtarget().getInstrInfo();
1725 assert(TII && "Expected target instruction info");
1726 for (unsigned I = 0, E = TII->getNumOpcodes(); I < E; ++I)
1727 Names2InstrOpCodes.insert(std::make_pair(StringRef(TII->getName(I)), I));
1730 bool MIParser::parseInstrName(StringRef InstrName, unsigned &OpCode) {
1731 initNames2InstrOpCodes();
1732 auto InstrInfo = Names2InstrOpCodes.find(InstrName);
1733 if (InstrInfo == Names2InstrOpCodes.end())
1735 OpCode = InstrInfo->getValue();
1739 void MIParser::initNames2Regs() {
1740 if (!Names2Regs.empty())
1742 // The '%noreg' register is the register 0.
1743 Names2Regs.insert(std::make_pair("noreg", 0));
1744 const auto *TRI = MF.getSubtarget().getRegisterInfo();
1745 assert(TRI && "Expected target register info");
1746 for (unsigned I = 0, E = TRI->getNumRegs(); I < E; ++I) {
1748 Names2Regs.insert(std::make_pair(StringRef(TRI->getName(I)).lower(), I))
1751 assert(WasInserted && "Expected registers to be unique case-insensitively");
1755 bool MIParser::getRegisterByName(StringRef RegName, unsigned &Reg) {
1757 auto RegInfo = Names2Regs.find(RegName);
1758 if (RegInfo == Names2Regs.end())
1760 Reg = RegInfo->getValue();
1764 void MIParser::initNames2RegMasks() {
1765 if (!Names2RegMasks.empty())
1767 const auto *TRI = MF.getSubtarget().getRegisterInfo();
1768 assert(TRI && "Expected target register info");
1769 ArrayRef<const uint32_t *> RegMasks = TRI->getRegMasks();
1770 ArrayRef<const char *> RegMaskNames = TRI->getRegMaskNames();
1771 assert(RegMasks.size() == RegMaskNames.size());
1772 for (size_t I = 0, E = RegMasks.size(); I < E; ++I)
1773 Names2RegMasks.insert(
1774 std::make_pair(StringRef(RegMaskNames[I]).lower(), RegMasks[I]));
1777 const uint32_t *MIParser::getRegMask(StringRef Identifier) {
1778 initNames2RegMasks();
1779 auto RegMaskInfo = Names2RegMasks.find(Identifier);
1780 if (RegMaskInfo == Names2RegMasks.end())
1782 return RegMaskInfo->getValue();
1785 void MIParser::initNames2SubRegIndices() {
1786 if (!Names2SubRegIndices.empty())
1788 const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
1789 for (unsigned I = 1, E = TRI->getNumSubRegIndices(); I < E; ++I)
1790 Names2SubRegIndices.insert(
1791 std::make_pair(StringRef(TRI->getSubRegIndexName(I)).lower(), I));
1794 unsigned MIParser::getSubRegIndex(StringRef Name) {
1795 initNames2SubRegIndices();
1796 auto SubRegInfo = Names2SubRegIndices.find(Name);
1797 if (SubRegInfo == Names2SubRegIndices.end())
1799 return SubRegInfo->getValue();
1802 static void initSlots2BasicBlocks(
1804 DenseMap<unsigned, const BasicBlock *> &Slots2BasicBlocks) {
1805 ModuleSlotTracker MST(F.getParent(), /*ShouldInitializeAllMetadata=*/false);
1806 MST.incorporateFunction(F);
1807 for (auto &BB : F) {
1810 int Slot = MST.getLocalSlot(&BB);
1813 Slots2BasicBlocks.insert(std::make_pair(unsigned(Slot), &BB));
1817 static const BasicBlock *getIRBlockFromSlot(
1819 const DenseMap<unsigned, const BasicBlock *> &Slots2BasicBlocks) {
1820 auto BlockInfo = Slots2BasicBlocks.find(Slot);
1821 if (BlockInfo == Slots2BasicBlocks.end())
1823 return BlockInfo->second;
1826 const BasicBlock *MIParser::getIRBlock(unsigned Slot) {
1827 if (Slots2BasicBlocks.empty())
1828 initSlots2BasicBlocks(*MF.getFunction(), Slots2BasicBlocks);
1829 return getIRBlockFromSlot(Slot, Slots2BasicBlocks);
1832 const BasicBlock *MIParser::getIRBlock(unsigned Slot, const Function &F) {
1833 if (&F == MF.getFunction())
1834 return getIRBlock(Slot);
1835 DenseMap<unsigned, const BasicBlock *> CustomSlots2BasicBlocks;
1836 initSlots2BasicBlocks(F, CustomSlots2BasicBlocks);
1837 return getIRBlockFromSlot(Slot, CustomSlots2BasicBlocks);
1840 void MIParser::initNames2TargetIndices() {
1841 if (!Names2TargetIndices.empty())
1843 const auto *TII = MF.getSubtarget().getInstrInfo();
1844 assert(TII && "Expected target instruction info");
1845 auto Indices = TII->getSerializableTargetIndices();
1846 for (const auto &I : Indices)
1847 Names2TargetIndices.insert(std::make_pair(StringRef(I.second), I.first));
1850 bool MIParser::getTargetIndex(StringRef Name, int &Index) {
1851 initNames2TargetIndices();
1852 auto IndexInfo = Names2TargetIndices.find(Name);
1853 if (IndexInfo == Names2TargetIndices.end())
1855 Index = IndexInfo->second;
1859 void MIParser::initNames2DirectTargetFlags() {
1860 if (!Names2DirectTargetFlags.empty())
1862 const auto *TII = MF.getSubtarget().getInstrInfo();
1863 assert(TII && "Expected target instruction info");
1864 auto Flags = TII->getSerializableDirectMachineOperandTargetFlags();
1865 for (const auto &I : Flags)
1866 Names2DirectTargetFlags.insert(
1867 std::make_pair(StringRef(I.second), I.first));
1870 bool MIParser::getDirectTargetFlag(StringRef Name, unsigned &Flag) {
1871 initNames2DirectTargetFlags();
1872 auto FlagInfo = Names2DirectTargetFlags.find(Name);
1873 if (FlagInfo == Names2DirectTargetFlags.end())
1875 Flag = FlagInfo->second;
1879 void MIParser::initNames2BitmaskTargetFlags() {
1880 if (!Names2BitmaskTargetFlags.empty())
1882 const auto *TII = MF.getSubtarget().getInstrInfo();
1883 assert(TII && "Expected target instruction info");
1884 auto Flags = TII->getSerializableBitmaskMachineOperandTargetFlags();
1885 for (const auto &I : Flags)
1886 Names2BitmaskTargetFlags.insert(
1887 std::make_pair(StringRef(I.second), I.first));
1890 bool MIParser::getBitmaskTargetFlag(StringRef Name, unsigned &Flag) {
1891 initNames2BitmaskTargetFlags();
1892 auto FlagInfo = Names2BitmaskTargetFlags.find(Name);
1893 if (FlagInfo == Names2BitmaskTargetFlags.end())
1895 Flag = FlagInfo->second;
1899 bool llvm::parseMachineBasicBlockDefinitions(MachineFunction &MF, StringRef Src,
1900 PerFunctionMIParsingState &PFS,
1901 const SlotMapping &IRSlots,
1902 SMDiagnostic &Error) {
1904 SM.AddNewSourceBuffer(
1905 MemoryBuffer::getMemBuffer(Src, "", /*RequiresNullTerminator=*/false),
1907 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1908 .parseBasicBlockDefinitions(PFS.MBBSlots);
1911 bool llvm::parseMachineInstructions(MachineFunction &MF, StringRef Src,
1912 const PerFunctionMIParsingState &PFS,
1913 const SlotMapping &IRSlots,
1914 SMDiagnostic &Error) {
1916 SM.AddNewSourceBuffer(
1917 MemoryBuffer::getMemBuffer(Src, "", /*RequiresNullTerminator=*/false),
1919 return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseBasicBlocks();
1922 bool llvm::parseMBBReference(MachineBasicBlock *&MBB, SourceMgr &SM,
1923 MachineFunction &MF, StringRef Src,
1924 const PerFunctionMIParsingState &PFS,
1925 const SlotMapping &IRSlots, SMDiagnostic &Error) {
1926 return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseStandaloneMBB(MBB);
1929 bool llvm::parseNamedRegisterReference(unsigned &Reg, SourceMgr &SM,
1930 MachineFunction &MF, StringRef Src,
1931 const PerFunctionMIParsingState &PFS,
1932 const SlotMapping &IRSlots,
1933 SMDiagnostic &Error) {
1934 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1935 .parseStandaloneNamedRegister(Reg);
1938 bool llvm::parseVirtualRegisterReference(unsigned &Reg, SourceMgr &SM,
1939 MachineFunction &MF, StringRef Src,
1940 const PerFunctionMIParsingState &PFS,
1941 const SlotMapping &IRSlots,
1942 SMDiagnostic &Error) {
1943 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1944 .parseStandaloneVirtualRegister(Reg);
1947 bool llvm::parseStackObjectReference(int &FI, SourceMgr &SM,
1948 MachineFunction &MF, StringRef Src,
1949 const PerFunctionMIParsingState &PFS,
1950 const SlotMapping &IRSlots,
1951 SMDiagnostic &Error) {
1952 return MIParser(SM, MF, Error, Src, PFS, IRSlots)
1953 .parseStandaloneStackObject(FI);
1956 bool llvm::parseMDNode(MDNode *&Node, SourceMgr &SM, MachineFunction &MF,
1957 StringRef Src, const PerFunctionMIParsingState &PFS,
1958 const SlotMapping &IRSlots, SMDiagnostic &Error) {
1959 return MIParser(SM, MF, Error, Src, PFS, IRSlots).parseStandaloneMDNode(Node);