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,
78 unsigned char TargetFlags = 0) const {
79 MI->addOperand(MachineOperand::CreateMBB(MBB, TargetFlags));
83 const MachineInstrBuilder &addFrameIndex(unsigned Idx) const {
84 MI->addOperand(MachineOperand::CreateFI(Idx));
88 const MachineInstrBuilder &addConstantPoolIndex(unsigned Idx,
90 unsigned char TargetFlags = 0) const {
91 MI->addOperand(MachineOperand::CreateCPI(Idx, Offset, TargetFlags));
95 const MachineInstrBuilder &addJumpTableIndex(unsigned Idx,
96 unsigned char TargetFlags = 0) const {
97 MI->addOperand(MachineOperand::CreateJTI(Idx, TargetFlags));
101 const MachineInstrBuilder &addGlobalAddress(GlobalValue *GV,
103 unsigned char TargetFlags = 0) const {
104 MI->addOperand(MachineOperand::CreateGA(GV, Offset, TargetFlags));
108 const MachineInstrBuilder &addExternalSymbol(const char *FnName,
110 unsigned char TargetFlags = 0) const {
111 MI->addOperand(MachineOperand::CreateES(FnName, Offset, TargetFlags));
115 const MachineInstrBuilder &addMemOperand(const MachineMemOperand &MMO) const {
116 MI->addMemOperand(*MI->getParent()->getParent(), MMO);
120 const MachineInstrBuilder &addOperand(const MachineOperand &MO) const {
126 /// BuildMI - Builder interface. Specify how to create the initial instruction
129 inline MachineInstrBuilder BuildMI(MachineFunction &MF,
131 const TargetInstrDesc &TID) {
132 return MachineInstrBuilder(MF.CreateMachineInstr(TID, DL));
135 /// BuildMI - This version of the builder sets up the first operand as a
136 /// destination virtual register.
138 inline MachineInstrBuilder BuildMI(MachineFunction &MF,
140 const TargetInstrDesc &TID,
142 return MachineInstrBuilder(MF.CreateMachineInstr(TID, DL))
143 .addReg(DestReg, RegState::Define);
146 /// BuildMI - This version of the builder inserts the newly-built
147 /// instruction before the given position in the given MachineBasicBlock, and
148 /// sets up the first operand as a destination virtual register.
150 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
151 MachineBasicBlock::iterator I,
153 const TargetInstrDesc &TID,
155 MachineInstr *MI = BB.getParent()->CreateMachineInstr(TID, DL);
157 return MachineInstrBuilder(MI).addReg(DestReg, RegState::Define);
160 /// BuildMI - This version of the builder inserts the newly-built
161 /// instruction before the given position in the given MachineBasicBlock, and
162 /// does NOT take a destination register.
164 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
165 MachineBasicBlock::iterator I,
167 const TargetInstrDesc &TID) {
168 MachineInstr *MI = BB.getParent()->CreateMachineInstr(TID, DL);
170 return MachineInstrBuilder(MI);
173 /// BuildMI - This version of the builder inserts the newly-built
174 /// instruction at the end of the given MachineBasicBlock, and does NOT take a
175 /// destination register.
177 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
179 const TargetInstrDesc &TID) {
180 return BuildMI(*BB, BB->end(), DL, TID);
183 /// BuildMI - This version of the builder inserts the newly-built
184 /// instruction at the end of the given MachineBasicBlock, and sets up the first
185 /// operand as a destination virtual register.
187 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
189 const TargetInstrDesc &TID,
191 return BuildMI(*BB, BB->end(), DL, TID, DestReg);
194 inline unsigned getDefRegState(bool B) {
195 return B ? RegState::Define : 0;
197 inline unsigned getImplRegState(bool B) {
198 return B ? RegState::Implicit : 0;
200 inline unsigned getKillRegState(bool B) {
201 return B ? RegState::Kill : 0;
203 inline unsigned getDeadRegState(bool B) {
204 return B ? RegState::Dead : 0;
207 } // End llvm namespace