1 //===-- CodeGen/MachineInstBuilder.h - Simplify creation of MIs -*- C++ -*-===//
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 exposes a function named BuildMI, which is useful for dramatically
11 // simplifying how MachineInstr's are created. It allows use of code like this:
13 // M = BuildMI(X86::ADDrr8, 2).addReg(argVal1).addReg(argVal2);
15 //===----------------------------------------------------------------------===//
17 #ifndef LLVM_CODEGEN_MACHINEINSTRBUILDER_H
18 #define LLVM_CODEGEN_MACHINEINSTRBUILDER_H
20 #include "llvm/CodeGen/MachineFunction.h"
21 #include "llvm/CodeGen/MachineInstrBundle.h"
22 #include "llvm/Support/ErrorHandling.h"
39 DefineNoRead = Define | Undef,
40 ImplicitDefine = Implicit | Define,
41 ImplicitKill = Implicit | Kill
45 class MachineInstrBuilder {
49 MachineInstrBuilder() : MF(nullptr), MI(nullptr) {}
51 /// Create a MachineInstrBuilder for manipulating an existing instruction.
52 /// F must be the machine function that was used to allocate I.
53 MachineInstrBuilder(MachineFunction &F, MachineInstr *I) : MF(&F), MI(I) {}
55 /// Allow automatic conversion to the machine instruction we are working on.
56 operator MachineInstr*() const { return MI; }
57 MachineInstr *operator->() const { return MI; }
58 operator MachineBasicBlock::iterator() const { return MI; }
60 /// If conversion operators fail, use this method to get the MachineInstr
62 MachineInstr *getInstr() const { return MI; }
64 /// Add a new virtual register operand.
65 const MachineInstrBuilder &addReg(unsigned RegNo, unsigned flags = 0,
66 unsigned SubReg = 0) const {
67 assert((flags & 0x1) == 0 &&
68 "Passing in 'true' to addReg is forbidden! Use enums instead.");
69 MI->addOperand(*MF, MachineOperand::CreateReg(RegNo,
70 flags & RegState::Define,
71 flags & RegState::Implicit,
72 flags & RegState::Kill,
73 flags & RegState::Dead,
74 flags & RegState::Undef,
75 flags & RegState::EarlyClobber,
77 flags & RegState::Debug,
78 flags & RegState::InternalRead));
82 /// Add a new immediate operand.
83 const MachineInstrBuilder &addImm(int64_t Val) const {
84 MI->addOperand(*MF, MachineOperand::CreateImm(Val));
88 const MachineInstrBuilder &addCImm(const ConstantInt *Val) const {
89 MI->addOperand(*MF, MachineOperand::CreateCImm(Val));
93 const MachineInstrBuilder &addFPImm(const ConstantFP *Val) const {
94 MI->addOperand(*MF, MachineOperand::CreateFPImm(Val));
98 const MachineInstrBuilder &addMBB(MachineBasicBlock *MBB,
99 unsigned char TargetFlags = 0) const {
100 MI->addOperand(*MF, MachineOperand::CreateMBB(MBB, TargetFlags));
104 const MachineInstrBuilder &addFrameIndex(int Idx) const {
105 MI->addOperand(*MF, MachineOperand::CreateFI(Idx));
109 const MachineInstrBuilder &addConstantPoolIndex(unsigned Idx,
111 unsigned char TargetFlags = 0) const {
112 MI->addOperand(*MF, MachineOperand::CreateCPI(Idx, Offset, TargetFlags));
116 const MachineInstrBuilder &addTargetIndex(unsigned Idx, int64_t Offset = 0,
117 unsigned char TargetFlags = 0) const {
118 MI->addOperand(*MF, MachineOperand::CreateTargetIndex(Idx, Offset,
123 const MachineInstrBuilder &addJumpTableIndex(unsigned Idx,
124 unsigned char TargetFlags = 0) const {
125 MI->addOperand(*MF, MachineOperand::CreateJTI(Idx, TargetFlags));
129 const MachineInstrBuilder &addGlobalAddress(const GlobalValue *GV,
131 unsigned char TargetFlags = 0) const {
132 MI->addOperand(*MF, MachineOperand::CreateGA(GV, Offset, TargetFlags));
136 const MachineInstrBuilder &addExternalSymbol(const char *FnName,
137 unsigned char TargetFlags = 0) const {
138 MI->addOperand(*MF, MachineOperand::CreateES(FnName, TargetFlags));
142 const MachineInstrBuilder &addBlockAddress(const BlockAddress *BA,
144 unsigned char TargetFlags = 0) const {
145 MI->addOperand(*MF, MachineOperand::CreateBA(BA, Offset, TargetFlags));
149 const MachineInstrBuilder &addRegMask(const uint32_t *Mask) const {
150 MI->addOperand(*MF, MachineOperand::CreateRegMask(Mask));
154 const MachineInstrBuilder &addMemOperand(MachineMemOperand *MMO) const {
155 MI->addMemOperand(*MF, MMO);
159 const MachineInstrBuilder &setMemRefs(MachineInstr::mmo_iterator b,
160 MachineInstr::mmo_iterator e) const {
161 MI->setMemRefs(b, e);
166 const MachineInstrBuilder &addOperand(const MachineOperand &MO) const {
167 MI->addOperand(*MF, MO);
171 const MachineInstrBuilder &addMetadata(const MDNode *MD) const {
172 MI->addOperand(*MF, MachineOperand::CreateMetadata(MD));
173 assert((MI->isDebugValue() ? static_cast<bool>(MI->getDebugVariable())
175 "first MDNode argument of a DBG_VALUE not a variable");
179 const MachineInstrBuilder &addCFIIndex(unsigned CFIIndex) const {
180 MI->addOperand(*MF, MachineOperand::CreateCFIIndex(CFIIndex));
184 const MachineInstrBuilder &addSym(MCSymbol *Sym,
185 unsigned char TargetFlags = 0) const {
186 MI->addOperand(*MF, MachineOperand::CreateMCSymbol(Sym, TargetFlags));
190 const MachineInstrBuilder &setMIFlags(unsigned Flags) const {
195 const MachineInstrBuilder &setMIFlag(MachineInstr::MIFlag Flag) const {
200 // Add a displacement from an existing MachineOperand with an added offset.
201 const MachineInstrBuilder &addDisp(const MachineOperand &Disp, int64_t off,
202 unsigned char TargetFlags = 0) const {
203 // If caller specifies new TargetFlags then use it, otherwise the
204 // default behavior is to copy the target flags from the existing
205 // MachineOperand. This means if the caller wants to clear the
206 // target flags it needs to do so explicitly.
207 if (0 == TargetFlags)
208 TargetFlags = Disp.getTargetFlags();
210 switch (Disp.getType()) {
212 llvm_unreachable("Unhandled operand type in addDisp()");
213 case MachineOperand::MO_Immediate:
214 return addImm(Disp.getImm() + off);
215 case MachineOperand::MO_ConstantPoolIndex:
216 return addConstantPoolIndex(Disp.getIndex(), Disp.getOffset() + off,
218 case MachineOperand::MO_GlobalAddress:
219 return addGlobalAddress(Disp.getGlobal(), Disp.getOffset() + off,
224 /// Copy all the implicit operands from OtherMI onto this one.
225 const MachineInstrBuilder ©ImplicitOps(const MachineInstr *OtherMI) {
226 MI->copyImplicitOps(*MF, OtherMI);
231 /// Builder interface. Specify how to create the initial instruction itself.
232 inline MachineInstrBuilder BuildMI(MachineFunction &MF,
234 const MCInstrDesc &MCID) {
235 return MachineInstrBuilder(MF, MF.CreateMachineInstr(MCID, DL));
238 /// This version of the builder sets up the first operand as a
239 /// destination virtual register.
240 inline MachineInstrBuilder BuildMI(MachineFunction &MF,
242 const MCInstrDesc &MCID,
244 return MachineInstrBuilder(MF, MF.CreateMachineInstr(MCID, DL))
245 .addReg(DestReg, RegState::Define);
248 /// This version of the builder inserts the newly-built instruction before
249 /// the given position in the given MachineBasicBlock, and sets up the first
250 /// operand as a destination virtual register.
251 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
252 MachineBasicBlock::iterator I,
254 const MCInstrDesc &MCID,
256 MachineFunction &MF = *BB.getParent();
257 MachineInstr *MI = MF.CreateMachineInstr(MCID, DL);
259 return MachineInstrBuilder(MF, MI).addReg(DestReg, RegState::Define);
262 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
263 MachineBasicBlock::instr_iterator I,
265 const MCInstrDesc &MCID,
267 MachineFunction &MF = *BB.getParent();
268 MachineInstr *MI = MF.CreateMachineInstr(MCID, DL);
270 return MachineInstrBuilder(MF, MI).addReg(DestReg, RegState::Define);
273 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
276 const MCInstrDesc &MCID,
278 if (I->isInsideBundle()) {
279 MachineBasicBlock::instr_iterator MII(I);
280 return BuildMI(BB, MII, DL, MCID, DestReg);
283 MachineBasicBlock::iterator MII = I;
284 return BuildMI(BB, MII, DL, MCID, DestReg);
287 /// This version of the builder inserts the newly-built instruction before the
288 /// given position in the given MachineBasicBlock, and does NOT take a
289 /// destination register.
290 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
291 MachineBasicBlock::iterator I,
293 const MCInstrDesc &MCID) {
294 MachineFunction &MF = *BB.getParent();
295 MachineInstr *MI = MF.CreateMachineInstr(MCID, DL);
297 return MachineInstrBuilder(MF, MI);
300 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
301 MachineBasicBlock::instr_iterator I,
303 const MCInstrDesc &MCID) {
304 MachineFunction &MF = *BB.getParent();
305 MachineInstr *MI = MF.CreateMachineInstr(MCID, DL);
307 return MachineInstrBuilder(MF, MI);
310 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
313 const MCInstrDesc &MCID) {
314 if (I->isInsideBundle()) {
315 MachineBasicBlock::instr_iterator MII(I);
316 return BuildMI(BB, MII, DL, MCID);
319 MachineBasicBlock::iterator MII = I;
320 return BuildMI(BB, MII, DL, MCID);
323 /// This version of the builder inserts the newly-built instruction at the end
324 /// of the given MachineBasicBlock, and does NOT take a destination register.
325 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
327 const MCInstrDesc &MCID) {
328 return BuildMI(*BB, BB->end(), DL, MCID);
331 /// This version of the builder inserts the newly-built instruction at the
332 /// end of the given MachineBasicBlock, and sets up the first operand as a
333 /// destination virtual register.
334 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
336 const MCInstrDesc &MCID,
338 return BuildMI(*BB, BB->end(), DL, MCID, DestReg);
341 /// This version of the builder builds a DBG_VALUE intrinsic
342 /// for either a value in a register or a register-indirect+offset
343 /// address. The convention is that a DBG_VALUE is indirect iff the
344 /// second operand is an immediate.
345 inline MachineInstrBuilder BuildMI(MachineFunction &MF, DebugLoc DL,
346 const MCInstrDesc &MCID, bool IsIndirect,
347 unsigned Reg, unsigned Offset,
348 const MDNode *Variable, const MDNode *Expr) {
349 assert(isa<DILocalVariable>(Variable) && "not a variable");
350 assert(cast<DIExpression>(Expr)->isValid() && "not an expression");
351 assert(cast<DILocalVariable>(Variable)->isValidLocationForIntrinsic(DL) &&
352 "Expected inlined-at fields to agree");
354 return BuildMI(MF, DL, MCID)
355 .addReg(Reg, RegState::Debug)
357 .addMetadata(Variable)
360 assert(Offset == 0 && "A direct address cannot have an offset.");
361 return BuildMI(MF, DL, MCID)
362 .addReg(Reg, RegState::Debug)
363 .addReg(0U, RegState::Debug)
364 .addMetadata(Variable)
369 /// This version of the builder builds a DBG_VALUE intrinsic
370 /// for either a value in a register or a register-indirect+offset
371 /// address and inserts it at position I.
372 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
373 MachineBasicBlock::iterator I, DebugLoc DL,
374 const MCInstrDesc &MCID, bool IsIndirect,
375 unsigned Reg, unsigned Offset,
376 const MDNode *Variable, const MDNode *Expr) {
377 assert(isa<DILocalVariable>(Variable) && "not a variable");
378 assert(cast<DIExpression>(Expr)->isValid() && "not an expression");
379 MachineFunction &MF = *BB.getParent();
381 BuildMI(MF, DL, MCID, IsIndirect, Reg, Offset, Variable, Expr);
383 return MachineInstrBuilder(MF, MI);
387 inline unsigned getDefRegState(bool B) {
388 return B ? RegState::Define : 0;
390 inline unsigned getImplRegState(bool B) {
391 return B ? RegState::Implicit : 0;
393 inline unsigned getKillRegState(bool B) {
394 return B ? RegState::Kill : 0;
396 inline unsigned getDeadRegState(bool B) {
397 return B ? RegState::Dead : 0;
399 inline unsigned getUndefRegState(bool B) {
400 return B ? RegState::Undef : 0;
402 inline unsigned getInternalReadRegState(bool B) {
403 return B ? RegState::InternalRead : 0;
405 inline unsigned getDebugRegState(bool B) {
406 return B ? RegState::Debug : 0;
410 /// Helper class for constructing bundles of MachineInstrs.
412 /// MIBundleBuilder can create a bundle from scratch by inserting new
413 /// MachineInstrs one at a time, or it can create a bundle from a sequence of
414 /// existing MachineInstrs in a basic block.
415 class MIBundleBuilder {
416 MachineBasicBlock &MBB;
417 MachineBasicBlock::instr_iterator Begin;
418 MachineBasicBlock::instr_iterator End;
421 /// Create an MIBundleBuilder that inserts instructions into a new bundle in
422 /// BB above the bundle or instruction at Pos.
423 MIBundleBuilder(MachineBasicBlock &BB,
424 MachineBasicBlock::iterator Pos)
425 : MBB(BB), Begin(Pos.getInstrIterator()), End(Begin) {}
427 /// Create a bundle from the sequence of instructions between B and E.
428 MIBundleBuilder(MachineBasicBlock &BB,
429 MachineBasicBlock::iterator B,
430 MachineBasicBlock::iterator E)
431 : MBB(BB), Begin(B.getInstrIterator()), End(E.getInstrIterator()) {
432 assert(B != E && "No instructions to bundle");
435 MachineInstr *MI = B;
437 MI->bundleWithPred();
441 /// Create an MIBundleBuilder representing an existing instruction or bundle
442 /// that has MI as its head.
443 explicit MIBundleBuilder(MachineInstr *MI)
444 : MBB(*MI->getParent()), Begin(MI), End(getBundleEnd(MI)) {}
446 /// Return a reference to the basic block containing this bundle.
447 MachineBasicBlock &getMBB() const { return MBB; }
449 /// Return true if no instructions have been inserted in this bundle yet.
450 /// Empty bundles aren't representable in a MachineBasicBlock.
451 bool empty() const { return Begin == End; }
453 /// Return an iterator to the first bundled instruction.
454 MachineBasicBlock::instr_iterator begin() const { return Begin; }
456 /// Return an iterator beyond the last bundled instruction.
457 MachineBasicBlock::instr_iterator end() const { return End; }
459 /// Insert MI into this bundle before I which must point to an instruction in
460 /// the bundle, or end().
461 MIBundleBuilder &insert(MachineBasicBlock::instr_iterator I,
466 MI->bundleWithSucc();
467 Begin = MI->getIterator();
471 MI->bundleWithPred();
474 // MI was inserted in the middle of the bundle, so its neighbors' flags are
475 // already fine. Update MI's bundle flags manually.
476 MI->setFlag(MachineInstr::BundledPred);
477 MI->setFlag(MachineInstr::BundledSucc);
481 /// Insert MI into MBB by prepending it to the instructions in the bundle.
482 /// MI will become the first instruction in the bundle.
483 MIBundleBuilder &prepend(MachineInstr *MI) {
484 return insert(begin(), MI);
487 /// Insert MI into MBB by appending it to the instructions in the bundle.
488 /// MI will become the last instruction in the bundle.
489 MIBundleBuilder &append(MachineInstr *MI) {
490 return insert(end(), MI);
494 } // End llvm namespace