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;
34 ImplicitDefine = Implicit | Define,
35 ImplicitKill = Implicit | Kill
39 class MachineInstrBuilder {
42 explicit MachineInstrBuilder(MachineInstr *mi) : MI(mi) {}
44 /// Allow automatic conversion to the machine instruction we are working on.
46 operator MachineInstr*() const { return MI; }
47 operator MachineBasicBlock::iterator() const { return MI; }
49 /// addReg - Add a new virtual register operand...
52 MachineInstrBuilder &addReg(unsigned RegNo, unsigned flags = 0,
53 unsigned SubReg = 0) const {
54 assert((flags & 0x1) == 0 &&
55 "Passing in 'true' to addReg is forbidden! Use enums instead.");
56 MI->addOperand(MachineOperand::CreateReg(RegNo,
57 flags & RegState::Define,
58 flags & RegState::Implicit,
59 flags & RegState::Kill,
60 flags & RegState::Dead,
61 flags & RegState::Undef,
62 flags & RegState::EarlyClobber,
67 /// addImm - Add a new immediate operand.
69 const MachineInstrBuilder &addImm(int64_t Val) const {
70 MI->addOperand(MachineOperand::CreateImm(Val));
74 const MachineInstrBuilder &addFPImm(const ConstantFP *Val) const {
75 MI->addOperand(MachineOperand::CreateFPImm(Val));
79 const MachineInstrBuilder &addMBB(MachineBasicBlock *MBB,
80 unsigned char TargetFlags = 0) const {
81 MI->addOperand(MachineOperand::CreateMBB(MBB, TargetFlags));
85 const MachineInstrBuilder &addFrameIndex(unsigned Idx) const {
86 MI->addOperand(MachineOperand::CreateFI(Idx));
90 const MachineInstrBuilder &addConstantPoolIndex(unsigned Idx,
92 unsigned char TargetFlags = 0) const {
93 MI->addOperand(MachineOperand::CreateCPI(Idx, Offset, TargetFlags));
97 const MachineInstrBuilder &addJumpTableIndex(unsigned Idx,
98 unsigned char TargetFlags = 0) const {
99 MI->addOperand(MachineOperand::CreateJTI(Idx, TargetFlags));
103 const MachineInstrBuilder &addGlobalAddress(GlobalValue *GV,
105 unsigned char TargetFlags = 0) const {
106 MI->addOperand(MachineOperand::CreateGA(GV, Offset, TargetFlags));
110 const MachineInstrBuilder &addMetadata(MDNode *N,
112 unsigned char TargetFlags = 0) const {
113 MI->addOperand(MachineOperand::CreateMDNode(N, Offset, TargetFlags));
117 const MachineInstrBuilder &addExternalSymbol(const char *FnName,
119 unsigned char TargetFlags = 0) const {
120 MI->addOperand(MachineOperand::CreateES(FnName, Offset, TargetFlags));
124 const MachineInstrBuilder &addMemOperand(const MachineMemOperand &MMO) const {
125 MI->addMemOperand(*MI->getParent()->getParent(), MMO);
129 const MachineInstrBuilder &addOperand(const MachineOperand &MO) const {
135 /// BuildMI - Builder interface. Specify how to create the initial instruction
138 inline MachineInstrBuilder BuildMI(MachineFunction &MF,
140 const TargetInstrDesc &TID) {
141 return MachineInstrBuilder(MF.CreateMachineInstr(TID, DL));
144 /// BuildMI - This version of the builder sets up the first operand as a
145 /// destination virtual register.
147 inline MachineInstrBuilder BuildMI(MachineFunction &MF,
149 const TargetInstrDesc &TID,
151 return MachineInstrBuilder(MF.CreateMachineInstr(TID, DL))
152 .addReg(DestReg, RegState::Define);
155 /// BuildMI - This version of the builder inserts the newly-built
156 /// instruction before the given position in the given MachineBasicBlock, and
157 /// sets up the first operand as a destination virtual register.
159 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
160 MachineBasicBlock::iterator I,
162 const TargetInstrDesc &TID,
164 MachineInstr *MI = BB.getParent()->CreateMachineInstr(TID, DL);
166 return MachineInstrBuilder(MI).addReg(DestReg, RegState::Define);
169 /// BuildMI - This version of the builder inserts the newly-built
170 /// instruction before the given position in the given MachineBasicBlock, and
171 /// does NOT take a destination register.
173 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
174 MachineBasicBlock::iterator I,
176 const TargetInstrDesc &TID) {
177 MachineInstr *MI = BB.getParent()->CreateMachineInstr(TID, DL);
179 return MachineInstrBuilder(MI);
182 /// BuildMI - This version of the builder inserts the newly-built
183 /// instruction at the end of the given MachineBasicBlock, and does NOT take a
184 /// destination register.
186 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
188 const TargetInstrDesc &TID) {
189 return BuildMI(*BB, BB->end(), DL, TID);
192 /// BuildMI - This version of the builder inserts the newly-built
193 /// instruction at the end of the given MachineBasicBlock, and sets up the first
194 /// operand as a destination virtual register.
196 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
198 const TargetInstrDesc &TID,
200 return BuildMI(*BB, BB->end(), DL, TID, DestReg);
203 inline unsigned getDefRegState(bool B) {
204 return B ? RegState::Define : 0;
206 inline unsigned getImplRegState(bool B) {
207 return B ? RegState::Implicit : 0;
209 inline unsigned getKillRegState(bool B) {
210 return B ? RegState::Kill : 0;
212 inline unsigned getDeadRegState(bool B) {
213 return B ? RegState::Dead : 0;
215 inline unsigned getUndefRegState(bool B) {
216 return B ? RegState::Undef : 0;
219 } // End llvm namespace