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/MachineBasicBlock.h"
21 #include "llvm/CodeGen/MachineFunction.h"
25 class TargetInstrDesc;
27 class MachineInstrBuilder {
30 explicit MachineInstrBuilder(MachineInstr *mi) : MI(mi) {}
32 /// Allow automatic conversion to the machine instruction we are working on.
34 operator MachineInstr*() const { return MI; }
35 operator MachineBasicBlock::iterator() const { return MI; }
37 /// addReg - Add a new virtual register operand...
40 MachineInstrBuilder &addReg(unsigned RegNo, bool isDef = false,
41 bool isImp = false, bool isKill = false,
42 bool isDead = false, unsigned SubReg = 0) const {
43 MI->addOperand(MachineOperand::CreateReg(RegNo, isDef, isImp, isKill,
48 /// addImm - Add a new immediate operand.
50 const MachineInstrBuilder &addImm(int64_t Val) const {
51 MI->addOperand(MachineOperand::CreateImm(Val));
55 const MachineInstrBuilder &addFPImm(ConstantFP *Val) const {
56 MI->addOperand(MachineOperand::CreateFPImm(Val));
60 const MachineInstrBuilder &addMBB(MachineBasicBlock *MBB) const {
61 MI->addOperand(MachineOperand::CreateMBB(MBB));
65 const MachineInstrBuilder &addFrameIndex(unsigned Idx) const {
66 MI->addOperand(MachineOperand::CreateFI(Idx));
70 const MachineInstrBuilder &addConstantPoolIndex(unsigned Idx,
71 int Offset = 0) const {
72 MI->addOperand(MachineOperand::CreateCPI(Idx, Offset));
76 const MachineInstrBuilder &addJumpTableIndex(unsigned Idx) const {
77 MI->addOperand(MachineOperand::CreateJTI(Idx));
81 const MachineInstrBuilder &addGlobalAddress(GlobalValue *GV,
82 int Offset = 0) const {
83 MI->addOperand(MachineOperand::CreateGA(GV, Offset));
87 const MachineInstrBuilder &addExternalSymbol(const char *FnName) const{
88 MI->addOperand(MachineOperand::CreateES(FnName, 0));
93 /// BuildMI - Builder interface. Specify how to create the initial instruction
96 inline MachineInstrBuilder BuildMI(MachineFunction &MF,
97 const TargetInstrDesc &TID) {
98 return MachineInstrBuilder(MF.CreateMachineInstr(TID));
101 /// BuildMI - This version of the builder sets up the first operand as a
102 /// destination virtual register.
104 inline MachineInstrBuilder BuildMI(MachineFunction &MF,
105 const TargetInstrDesc &TID,
107 return MachineInstrBuilder(MF.CreateMachineInstr(TID)).addReg(DestReg, true);
110 /// BuildMI - This version of the builder inserts the newly-built
111 /// instruction before the given position in the given MachineBasicBlock, and
112 /// sets up the first operand as a destination virtual register.
114 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
115 MachineBasicBlock::iterator I,
116 const TargetInstrDesc &TID,
118 MachineInstr *MI = BB.getParent()->CreateMachineInstr(TID);
120 return MachineInstrBuilder(MI).addReg(DestReg, true);
123 /// BuildMI - This version of the builder inserts the newly-built
124 /// instruction before the given position in the given MachineBasicBlock, and
125 /// does NOT take a destination register.
127 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
128 MachineBasicBlock::iterator I,
129 const TargetInstrDesc &TID) {
130 MachineInstr *MI = BB.getParent()->CreateMachineInstr(TID);
132 return MachineInstrBuilder(MI);
135 /// BuildMI - This version of the builder inserts the newly-built
136 /// instruction at the end of the given MachineBasicBlock, and does NOT take a
137 /// destination register.
139 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
140 const TargetInstrDesc &TID) {
141 return BuildMI(*BB, BB->end(), TID);
144 /// BuildMI - This version of the builder inserts the newly-built
145 /// instruction at the end of the given MachineBasicBlock, and sets up the first
146 /// operand as a destination virtual register.
148 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
149 const TargetInstrDesc &TID,
151 return BuildMI(*BB, BB->end(), TID, DestReg);
154 } // End llvm namespace