MachineInstrBuilder.h revision 4fbd796a1251a27e6590765a0a34876f436a0af9 
1//===-- CodeGen/MachineInstBuilder.h - Simplify creation of MIs -*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
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:
12//
13//   M = BuildMI(X86::ADDrr8, 2).addReg(argVal1).addReg(argVal2);
14//
15//===----------------------------------------------------------------------===//
16
17#ifndef LLVM_CODEGEN_MACHINEINSTRBUILDER_H
18#define LLVM_CODEGEN_MACHINEINSTRBUILDER_H
19
20#include "llvm/CodeGen/MachineBasicBlock.h"
21#include "llvm/CodeGen/MachineFunction.h"
22
23namespace llvm {
24
25class TargetInstrDesc;
26
27class MachineInstrBuilder {
28  MachineInstr *MI;
29public:
30  explicit MachineInstrBuilder(MachineInstr *mi) : MI(mi) {}
31
32  /// Allow automatic conversion to the machine instruction we are working on.
33  ///
34  operator MachineInstr*() const { return MI; }
35  operator MachineBasicBlock::iterator() const { return MI; }
36
37  /// addReg - Add a new virtual register operand...
38  ///
39  const
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,
44                                             isDead, SubReg));
45    return *this;
46  }
47
48  /// addImm - Add a new immediate operand.
49  ///
50  const MachineInstrBuilder &addImm(int64_t Val) const {
51    MI->addOperand(MachineOperand::CreateImm(Val));
52    return *this;
53  }
54
55  const MachineInstrBuilder &addFPImm(const ConstantFP *Val) const {
56    MI->addOperand(MachineOperand::CreateFPImm(Val));
57    return *this;
58  }
59
60  const MachineInstrBuilder &addMBB(MachineBasicBlock *MBB) const {
61    MI->addOperand(MachineOperand::CreateMBB(MBB));
62    return *this;
63  }
64
65  const MachineInstrBuilder &addFrameIndex(unsigned Idx) const {
66    MI->addOperand(MachineOperand::CreateFI(Idx));
67    return *this;
68  }
69
70  const MachineInstrBuilder &addConstantPoolIndex(unsigned Idx,
71                                                  int Offset = 0) const {
72    MI->addOperand(MachineOperand::CreateCPI(Idx, Offset));
73    return *this;
74  }
75
76  const MachineInstrBuilder &addJumpTableIndex(unsigned Idx) const {
77    MI->addOperand(MachineOperand::CreateJTI(Idx));
78    return *this;
79  }
80
81  const MachineInstrBuilder &addGlobalAddress(GlobalValue *GV,
82                                              int Offset = 0) const {
83    MI->addOperand(MachineOperand::CreateGA(GV, Offset));
84    return *this;
85  }
86
87  const MachineInstrBuilder &addExternalSymbol(const char *FnName) const{
88    MI->addOperand(MachineOperand::CreateES(FnName, 0));
89    return *this;
90  }
91};
92
93/// BuildMI - Builder interface.  Specify how to create the initial instruction
94/// itself.
95///
96inline MachineInstrBuilder BuildMI(MachineFunction &MF,
97                                   const TargetInstrDesc &TID) {
98  return MachineInstrBuilder(MF.CreateMachineInstr(TID));
99}
100
101/// BuildMI - This version of the builder sets up the first operand as a
102/// destination virtual register.
103///
104inline MachineInstrBuilder  BuildMI(MachineFunction &MF,
105                                    const TargetInstrDesc &TID,
106                                    unsigned DestReg) {
107  return MachineInstrBuilder(MF.CreateMachineInstr(TID)).addReg(DestReg, true);
108}
109
110/// BuildMI - This version of the builder inserts the newly-built
111/// instruction before the given position in the given MachineBasicBlock, and
112/// sets up the first operand as a destination virtual register.
113///
114inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
115                                   MachineBasicBlock::iterator I,
116                                   const TargetInstrDesc &TID,
117                                   unsigned DestReg) {
118  MachineInstr *MI = BB.getParent()->CreateMachineInstr(TID);
119  BB.insert(I, MI);
120  return MachineInstrBuilder(MI).addReg(DestReg, true);
121}
122
123/// BuildMI - This version of the builder inserts the newly-built
124/// instruction before the given position in the given MachineBasicBlock, and
125/// does NOT take a destination register.
126///
127inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
128                                   MachineBasicBlock::iterator I,
129                                   const TargetInstrDesc &TID) {
130  MachineInstr *MI = BB.getParent()->CreateMachineInstr(TID);
131  BB.insert(I, MI);
132  return MachineInstrBuilder(MI);
133}
134
135/// BuildMI - This version of the builder inserts the newly-built
136/// instruction at the end of the given MachineBasicBlock, and does NOT take a
137/// destination register.
138///
139inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
140                                   const TargetInstrDesc &TID) {
141  return BuildMI(*BB, BB->end(), TID);
142}
143
144/// BuildMI - This version of the builder inserts the newly-built
145/// instruction at the end of the given MachineBasicBlock, and sets up the first
146/// operand as a destination virtual register.
147///
148inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
149                                   const TargetInstrDesc &TID,
150                                   unsigned DestReg) {
151  return BuildMI(*BB, BB->end(), TID, DestReg);
152}
153
154} // End llvm namespace
155
156#endif
157