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 &addMBB(MachineBasicBlock *MBB) const {
56 MI->addOperand(MachineOperand::CreateMBB(MBB));
60 const MachineInstrBuilder &addFrameIndex(unsigned Idx) const {
61 MI->addOperand(MachineOperand::CreateFI(Idx));
65 const MachineInstrBuilder &addConstantPoolIndex(unsigned Idx,
66 int Offset = 0) const {
67 MI->addOperand(MachineOperand::CreateCPI(Idx, Offset));
71 const MachineInstrBuilder &addJumpTableIndex(unsigned Idx) const {
72 MI->addOperand(MachineOperand::CreateJTI(Idx));
76 const MachineInstrBuilder &addGlobalAddress(GlobalValue *GV,
77 int Offset = 0) const {
78 MI->addOperand(MachineOperand::CreateGA(GV, Offset));
82 const MachineInstrBuilder &addExternalSymbol(const char *FnName) const{
83 MI->addOperand(MachineOperand::CreateES(FnName, 0));
87 const MachineInstrBuilder &addUndef() const {
88 MI->addOperand(MachineOperand::CreateUndef());
92 /// addMemOperand - Add a memory operand to the machine instruction.
93 const MachineInstrBuilder &addMemOperand(const MemOperand &MO) const {
94 MI->addMemOperand(MO);
99 /// BuildMI - Builder interface. Specify how to create the initial instruction
102 inline MachineInstrBuilder BuildMI(const TargetInstrDesc &TID) {
103 return MachineInstrBuilder(new MachineInstr(TID));
106 /// BuildMI - This version of the builder sets up the first operand as a
107 /// destination virtual register.
109 inline MachineInstrBuilder BuildMI(const TargetInstrDesc &TID,
111 return MachineInstrBuilder(new MachineInstr(TID)).addReg(DestReg, true);
114 /// BuildMI - This version of the builder inserts the newly-built
115 /// instruction before the given position in the given MachineBasicBlock, and
116 /// sets up the first operand as a destination virtual register.
118 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
119 MachineBasicBlock::iterator I,
120 const TargetInstrDesc &TID,
122 MachineInstr *MI = new MachineInstr(TID);
124 return MachineInstrBuilder(MI).addReg(DestReg, true);
127 /// BuildMI - This version of the builder inserts the newly-built
128 /// instruction before the given position in the given MachineBasicBlock, and
129 /// does NOT take a destination register.
131 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
132 MachineBasicBlock::iterator I,
133 const TargetInstrDesc &TID) {
134 MachineInstr *MI = new MachineInstr(TID);
136 return MachineInstrBuilder(MI);
139 /// BuildMI - This version of the builder inserts the newly-built
140 /// instruction at the end of the given MachineBasicBlock, and does NOT take a
141 /// destination register.
143 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
144 const TargetInstrDesc &TID) {
145 return BuildMI(*BB, BB->end(), TID);
148 /// BuildMI - This version of the builder inserts the newly-built
149 /// instruction at the end of the given MachineBasicBlock, and sets up the first
150 /// operand as a destination virtual register.
152 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
153 const TargetInstrDesc &TID,
155 return BuildMI(*BB, BB->end(), TID, DestReg);
158 } // End llvm namespace