1 //===-- CodeGen/MachineInstBuilder.h - Simplify creation of MIs -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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. Instead of using code like this:
13 // M = new MachineInstr(X86::ADDrr8);
14 // M->SetMachineOperandVal(0, MachineOperand::MO_VirtualRegister, argVal1);
15 // M->SetMachineOperandVal(1, MachineOperand::MO_VirtualRegister, argVal2);
17 // we can now use code like this:
19 // M = BuildMI(X86::ADDrr8, 2).addReg(argVal1).addReg(argVal2);
21 //===----------------------------------------------------------------------===//
23 #ifndef LLVM_CODEGEN_MACHINEINSTRBUILDER_H
24 #define LLVM_CODEGEN_MACHINEINSTRBUILDER_H
26 #include "llvm/CodeGen/MachineBasicBlock.h"
30 class MachineInstrBuilder {
33 MachineInstrBuilder(MachineInstr *mi) : MI(mi) {}
35 /// Allow automatic conversion to the machine instruction we are working on.
37 operator MachineInstr*() const { return MI; }
38 operator MachineBasicBlock::iterator() const { return MI; }
40 /// addReg - Add a new virtual register operand...
42 const MachineInstrBuilder &addReg(
44 MachineOperand::UseType Ty = MachineOperand::Use) const {
45 MI->addRegOperand(RegNo, Ty);
49 /// addImm - Add a new immediate operand.
51 const MachineInstrBuilder &addImm(int Val) const {
52 MI->addZeroExtImmOperand(Val);
56 /// addSImm - Add a new sign extended immediate operand...
58 const MachineInstrBuilder &addSImm(int val) const {
59 MI->addSignExtImmOperand(val);
63 /// addZImm - Add a new zero extended immediate operand...
65 const MachineInstrBuilder &addZImm(unsigned Val) const {
66 MI->addZeroExtImmOperand(Val);
70 /// addImm64 - Add a new 64-bit immediate operand...
72 const MachineInstrBuilder &addImm64(uint64_t Val) const {
73 MI->addZeroExtImm64Operand(Val);
77 const MachineInstrBuilder &addMBB(MachineBasicBlock *MBB) const {
78 MI->addMachineBasicBlockOperand(MBB);
82 const MachineInstrBuilder &addFrameIndex(unsigned Idx) const {
83 MI->addFrameIndexOperand(Idx);
87 const MachineInstrBuilder &addConstantPoolIndex(unsigned Idx,
88 int Offset = 0) const {
89 MI->addConstantPoolIndexOperand(Idx, Offset);
93 const MachineInstrBuilder &addJumpTableIndex(unsigned Idx) const {
94 MI->addJumpTableIndexOperand(Idx);
98 const MachineInstrBuilder &addGlobalAddress(GlobalValue *GV,
99 int Offset = 0) const {
100 MI->addGlobalAddressOperand(GV, Offset);
104 const MachineInstrBuilder &addExternalSymbol(const char *FnName) const{
105 MI->addExternalSymbolOperand(FnName);
110 /// BuildMI - Builder interface. Specify how to create the initial instruction
111 /// itself. NumOperands is the number of operands to the machine instruction to
112 /// allow for memory efficient representation of machine instructions.
114 inline MachineInstrBuilder BuildMI(int Opcode, unsigned NumOperands) {
115 return MachineInstrBuilder(new MachineInstr(Opcode, NumOperands, true, true));
118 /// BuildMI - This version of the builder sets up the first operand as a
119 /// destination virtual register. NumOperands is the number of additional add*
120 /// calls that are expected, not including the destination register.
122 inline MachineInstrBuilder BuildMI(
123 int Opcode, unsigned NumOperands,
125 MachineOperand::UseType useType = MachineOperand::Def) {
126 return MachineInstrBuilder(new MachineInstr(Opcode, NumOperands+1,
127 true, true)).addReg(DestReg, useType);
130 /// BuildMI - This version of the builder inserts the newly-built
131 /// instruction before the given position in the given MachineBasicBlock, and
132 /// sets up the first operand as a destination virtual register.
133 /// NumOperands is the number of additional add* calls that are expected,
134 /// not including the destination register.
136 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
137 MachineBasicBlock::iterator I,
138 int Opcode, unsigned NumOperands,
140 MachineInstr *MI = new MachineInstr(Opcode, NumOperands+1, true, true);
142 return MachineInstrBuilder(MI).addReg(DestReg, MachineOperand::Def);
145 /// BuildMI - This version of the builder inserts the newly-built
146 /// instruction before the given position in the given MachineBasicBlock, and
147 /// does NOT take a destination register.
149 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
150 MachineBasicBlock::iterator I,
151 int Opcode, unsigned NumOperands) {
152 MachineInstr *MI = new MachineInstr(Opcode, NumOperands, true, true);
154 return MachineInstrBuilder(MI);
157 /// BuildMI - This version of the builder inserts the newly-built
158 /// instruction at the end of the given MachineBasicBlock, and does NOT take a
159 /// destination register.
161 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB, int Opcode,
162 unsigned NumOperands) {
163 return BuildMI(*BB, BB->end(), Opcode, NumOperands);
166 /// BuildMI - This version of the builder inserts the newly-built
167 /// instruction at the end of the given MachineBasicBlock, and sets up the first
168 /// operand as a destination virtual register. NumOperands is the number of
169 /// additional add* calls that are expected, not including the destination
172 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB, int Opcode,
173 unsigned NumOperands, unsigned DestReg) {
174 return BuildMI(*BB, BB->end(), Opcode, NumOperands, DestReg);
177 } // End llvm namespace