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"
24 class TargetInstrDesc;
33 ImplicitDefine = Implicit | Define,
34 ImplicitKill = Implicit | Kill
38 class MachineInstrBuilder {
41 explicit MachineInstrBuilder(MachineInstr *mi) : MI(mi) {}
43 /// Allow automatic conversion to the machine instruction we are working on.
45 operator MachineInstr*() const { return MI; }
46 operator MachineBasicBlock::iterator() const { return MI; }
48 /// addReg - Add a new virtual register operand...
51 MachineInstrBuilder &addReg(unsigned RegNo, unsigned flags = 0,
52 unsigned SubReg = 0) const {
53 assert((flags & 0x1) == 0 &&
54 "Passing in 'true' to addReg is forbidden! Use enums instead.");
55 MI->addOperand(MachineOperand::CreateReg(RegNo,
56 flags & RegState::Define,
57 flags & RegState::Implicit,
58 flags & RegState::Kill,
59 flags & RegState::Dead,
61 flags & RegState::EarlyClobber));
65 /// addImm - Add a new immediate operand.
67 const MachineInstrBuilder &addImm(int64_t Val) const {
68 MI->addOperand(MachineOperand::CreateImm(Val));
72 const MachineInstrBuilder &addFPImm(const ConstantFP *Val) const {
73 MI->addOperand(MachineOperand::CreateFPImm(Val));
77 const MachineInstrBuilder &addMBB(MachineBasicBlock *MBB) const {
78 MI->addOperand(MachineOperand::CreateMBB(MBB));
82 const MachineInstrBuilder &addFrameIndex(unsigned Idx) const {
83 MI->addOperand(MachineOperand::CreateFI(Idx));
87 const MachineInstrBuilder &addConstantPoolIndex(unsigned Idx,
88 int Offset = 0) const {
89 MI->addOperand(MachineOperand::CreateCPI(Idx, Offset));
93 const MachineInstrBuilder &addJumpTableIndex(unsigned Idx) const {
94 MI->addOperand(MachineOperand::CreateJTI(Idx));
98 const MachineInstrBuilder &addGlobalAddress(GlobalValue *GV,
99 int64_t Offset = 0) const {
100 MI->addOperand(MachineOperand::CreateGA(GV, Offset));
104 const MachineInstrBuilder &addExternalSymbol(const char *FnName,
105 int64_t Offset = 0) const {
106 MI->addOperand(MachineOperand::CreateES(FnName, Offset));
110 const MachineInstrBuilder &addMemOperand(const MachineMemOperand &MMO) const {
111 MI->addMemOperand(*MI->getParent()->getParent(), MMO);
115 const MachineInstrBuilder &addOperand(const MachineOperand &MO) const {
117 return addReg(MO.getReg(),
118 (MO.isDef() ? RegState::Define : 0) |
119 (MO.isImplicit() ? RegState::Implicit : 0) |
120 (MO.isKill() ? RegState::Kill : 0) |
121 (MO.isDead() ? RegState::Dead : 0) |
122 (MO.isEarlyClobber() ? RegState::EarlyClobber : 0),
125 return addImm(MO.getImm());
127 return addFrameIndex(MO.getIndex());
129 return addGlobalAddress(MO.getGlobal(), MO.getOffset());
131 return addConstantPoolIndex(MO.getIndex(), MO.getOffset());
133 return addExternalSymbol(MO.getSymbolName());
135 return addJumpTableIndex(MO.getIndex());
137 assert(0 && "Unknown operand for MachineInstrBuilder::AddOperand!");
142 /// BuildMI - Builder interface. Specify how to create the initial instruction
145 inline MachineInstrBuilder BuildMI(MachineFunction &MF,
147 const TargetInstrDesc &TID) {
148 return MachineInstrBuilder(MF.CreateMachineInstr(TID, DL));
151 /// BuildMI - This version of the builder sets up the first operand as a
152 /// destination virtual register.
154 inline MachineInstrBuilder BuildMI(MachineFunction &MF,
156 const TargetInstrDesc &TID,
158 return MachineInstrBuilder(MF.CreateMachineInstr(TID, DL))
159 .addReg(DestReg, RegState::Define);
162 /// BuildMI - This version of the builder inserts the newly-built
163 /// instruction before the given position in the given MachineBasicBlock, and
164 /// sets up the first operand as a destination virtual register.
166 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
167 MachineBasicBlock::iterator I,
169 const TargetInstrDesc &TID,
171 MachineInstr *MI = BB.getParent()->CreateMachineInstr(TID, DL);
173 return MachineInstrBuilder(MI).addReg(DestReg, RegState::Define);
176 /// BuildMI - This version of the builder inserts the newly-built
177 /// instruction before the given position in the given MachineBasicBlock, and
178 /// does NOT take a destination register.
180 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
181 MachineBasicBlock::iterator I,
183 const TargetInstrDesc &TID) {
184 MachineInstr *MI = BB.getParent()->CreateMachineInstr(TID, DL);
186 return MachineInstrBuilder(MI);
189 /// BuildMI - This version of the builder inserts the newly-built
190 /// instruction at the end of the given MachineBasicBlock, and does NOT take a
191 /// destination register.
193 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
195 const TargetInstrDesc &TID) {
196 return BuildMI(*BB, BB->end(), DL, TID);
199 /// BuildMI - This version of the builder inserts the newly-built
200 /// instruction at the end of the given MachineBasicBlock, and sets up the first
201 /// operand as a destination virtual register.
203 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
205 const TargetInstrDesc &TID,
207 return BuildMI(*BB, BB->end(), DL, TID, DestReg);
210 inline unsigned getDefRegState(bool B) {
211 return B ? RegState::Define : 0;
213 inline unsigned getImplRegState(bool B) {
214 return B ? RegState::Implicit : 0;
216 inline unsigned getKillRegState(bool B) {
217 return B ? RegState::Kill : 0;
219 inline unsigned getDeadRegState(bool B) {
220 return B ? RegState::Dead : 0;
223 } // End llvm namespace