MachineInstrBuilder.h revision 36b5c1338a03453ba1c110b120269ca972fb65a3 
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 &addMBB(MachineBasicBlock *MBB) const {
56    MI->addOperand(MachineOperand::CreateMBB(MBB));
57    return *this;
58  }
59
60  const MachineInstrBuilder &addFrameIndex(unsigned Idx) const {
61    MI->addOperand(MachineOperand::CreateFI(Idx));
62    return *this;
63  }
64
65  const MachineInstrBuilder &addConstantPoolIndex(unsigned Idx,
66                                                  int Offset = 0) const {
67    MI->addOperand(MachineOperand::CreateCPI(Idx, Offset));
68    return *this;
69  }
70
71  const MachineInstrBuilder &addJumpTableIndex(unsigned Idx) const {
72    MI->addOperand(MachineOperand::CreateJTI(Idx));
73    return *this;
74  }
75
76  const MachineInstrBuilder &addGlobalAddress(GlobalValue *GV,
77                                              int Offset = 0) const {
78    MI->addOperand(MachineOperand::CreateGA(GV, Offset));
79    return *this;
80  }
81
82  const MachineInstrBuilder &addExternalSymbol(const char *FnName) const{
83    MI->addOperand(MachineOperand::CreateES(FnName, 0));
84    return *this;
85  }
86
87  /// addMemOperand - Add a memory operand to the machine instruction.
88  const MachineInstrBuilder &addMemOperand(const MachineMemOperand &MO) const {
89    MI->addMemOperand(MO);
90    return *this;
91  }
92};
93
94/// BuildMI - Builder interface.  Specify how to create the initial instruction
95/// itself.
96///
97inline MachineInstrBuilder BuildMI(const TargetInstrDesc &TID) {
98  return MachineInstrBuilder(new MachineInstr(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(const TargetInstrDesc &TID,
105                                    unsigned DestReg) {
106  return MachineInstrBuilder(new MachineInstr(TID)).addReg(DestReg, true);
107}
108
109/// BuildMI - This version of the builder inserts the newly-built
110/// instruction before the given position in the given MachineBasicBlock, and
111/// sets up the first operand as a destination virtual register.
112///
113inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
114                                   MachineBasicBlock::iterator I,
115                                   const TargetInstrDesc &TID,
116                                   unsigned DestReg) {
117  MachineInstr *MI = new MachineInstr(TID);
118  BB.insert(I, MI);
119  return MachineInstrBuilder(MI).addReg(DestReg, true);
120}
121
122/// BuildMI - This version of the builder inserts the newly-built
123/// instruction before the given position in the given MachineBasicBlock, and
124/// does NOT take a destination register.
125///
126inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
127                                   MachineBasicBlock::iterator I,
128                                   const TargetInstrDesc &TID) {
129  MachineInstr *MI = new MachineInstr(TID);
130  BB.insert(I, MI);
131  return MachineInstrBuilder(MI);
132}
133
134/// BuildMI - This version of the builder inserts the newly-built
135/// instruction at the end of the given MachineBasicBlock, and does NOT take a
136/// destination register.
137///
138inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
139                                   const TargetInstrDesc &TID) {
140  return BuildMI(*BB, BB->end(), TID);
141}
142
143/// BuildMI - This version of the builder inserts the newly-built
144/// instruction at the end of the given MachineBasicBlock, and sets up the first
145/// operand as a destination virtual register.
146///
147inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
148                                   const TargetInstrDesc &TID,
149                                   unsigned DestReg) {
150  return BuildMI(*BB, BB->end(), TID, DestReg);
151}
152
153} // End llvm namespace
154
155#endif
156