include/llvm/CodeGen/MachineInstrBuilder.h

   1 //===-- CodeGen/MachineInstBuilder.h - Simplify creation of MIs -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   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.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  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:
  12 //
  13 //   M = new MachineInstr(X86::ADDrr8);
  14 //   M->SetMachineOperandVal(0, MachineOperand::MO_VirtualRegister, argVal1);
  15 //   M->SetMachineOperandVal(1, MachineOperand::MO_VirtualRegister, argVal2);
  16 //
  17 // we can now use code like this:
  18 //
  19 //   M = BuildMI(X86::ADDrr8, 2).addReg(argVal1).addReg(argVal2);
  20 //
  21 //===----------------------------------------------------------------------===//
  22
  23 #ifndef LLVM_CODEGEN_MACHINEINSTRBUILDER_H
  24 #define LLVM_CODEGEN_MACHINEINSTRBUILDER_H
  25
  26 #include "llvm/CodeGen/MachineBasicBlock.h"
  27
  28 namespace llvm {
  29
  30 class MachineInstrBuilder {
  31   MachineInstr *MI;
  32 public:
  33   MachineInstrBuilder(MachineInstr *mi) : MI(mi) {}
  34
  35   /// Allow automatic conversion to the machine instruction we are working on.
  36   ///
  37   operator MachineInstr*() const { return MI; }
  38   operator MachineBasicBlock::iterator() const { return MI; }
  39
  40   /// addReg - Add a new virtual register operand...
  41   ///
  42   const MachineInstrBuilder &addReg(
  43     int RegNo,
  44     MachineOperand::UseType Ty = MachineOperand::Use) const {
  45     MI->addRegOperand(RegNo, Ty);
  46     return *this;
  47   }
  48
  49   /// addReg - Add an LLVM value that is to be used as a register...
  50   ///
  51   const MachineInstrBuilder &addReg(
  52     Value *V,
  53     MachineOperand::UseType Ty = MachineOperand::Use) const {
  54     MI->addRegOperand(V, Ty);
  55     return *this;
  56   }
  57
  58   /// addReg - Add an LLVM value that is to be used as a register...
  59   ///
  60   const MachineInstrBuilder &addCCReg(
  61     Value *V,
  62     MachineOperand::UseType Ty = MachineOperand::Use) const {
  63     MI->addCCRegOperand(V, Ty);
  64     return *this;
  65   }
  66
  67   /// addRegDef - Add an LLVM value that is to be defined as a register... this
  68   /// is the same as addReg(V, MachineOperand::Def).
  69   ///
  70   const MachineInstrBuilder &addRegDef(Value *V) const {
  71     return addReg(V, MachineOperand::Def);
  72   }
  73
  74   /// addPCDisp - Add an LLVM value to be treated as a PC relative
  75   /// displacement...
  76   ///
  77   const MachineInstrBuilder &addPCDisp(Value *V) const {
  78     MI->addPCDispOperand(V);
  79     return *this;
  80   }
  81
  82   /// addMReg - Add a machine register operand...
  83   ///
  84   const MachineInstrBuilder &addMReg(int Reg, MachineOperand::UseType Ty
  85                                         = MachineOperand::Use) const {
  86     MI->addMachineRegOperand(Reg, Ty);
  87     return *this;
  88   }
  89
  90   /// addImm - Add a new immediate operand.
  91   ///
  92   const MachineInstrBuilder &addImm(int Val) const {
  93     MI->addZeroExtImmOperand(Val);
  94     return *this;
  95   }
  96
  97   /// addSImm - Add a new sign extended immediate operand...
  98   ///
  99   const MachineInstrBuilder &addSImm(int val) const {
 100     MI->addSignExtImmOperand(val);
 101     return *this;
 102   }
 103
 104   /// addZImm - Add a new zero extended immediate operand...
 105   ///
 106   const MachineInstrBuilder &addZImm(unsigned Val) const {
 107     MI->addZeroExtImmOperand(Val);
 108     return *this;
 109   }
 110
 111   /// addImm64 - Add a new 64-bit immediate operand...
 112   ///
 113   const MachineInstrBuilder &addImm64(uint64_t Val) const {
 114     MI->addZeroExtImm64Operand(Val);
 115     return *this;
 116   }
 117
 118   const MachineInstrBuilder &addMBB(MachineBasicBlock *MBB) const {
 119     MI->addMachineBasicBlockOperand(MBB);
 120     return *this;
 121   }
 122
 123   const MachineInstrBuilder &addFrameIndex(unsigned Idx) const {
 124     MI->addFrameIndexOperand(Idx);
 125     return *this;
 126   }
 127
 128   const MachineInstrBuilder &addConstantPoolIndex(unsigned Idx,
 129                                                   int Offset = 0) const {
 130     MI->addConstantPoolIndexOperand(Idx, Offset);
 131     return *this;
 132   }
 133
 134   const MachineInstrBuilder &addGlobalAddress(GlobalValue *GV,
 135                                               bool isPCRelative = false,
 136                                               int Offset = 0) const {
 137     MI->addGlobalAddressOperand(GV, isPCRelative, Offset);
 138     return *this;
 139   }
 140
 141   const MachineInstrBuilder &addExternalSymbol(const char *FnName,
 142                                                bool isPCRelative = false) const{
 143     MI->addExternalSymbolOperand(FnName, isPCRelative);
 144     return *this;
 145   }
 146 };
 147
 148 /// BuildMI - Builder interface.  Specify how to create the initial instruction
 149 /// itself.  NumOperands is the number of operands to the machine instruction to
 150 /// allow for memory efficient representation of machine instructions.
 151 ///
 152 inline MachineInstrBuilder BuildMI(int Opcode, unsigned NumOperands) {
 153   return MachineInstrBuilder(new MachineInstr(Opcode, NumOperands, true, true));
 154 }
 155
 156 /// BuildMI - This version of the builder sets up the first operand as a
 157 /// destination virtual register.  NumOperands is the number of additional add*
 158 /// calls that are expected, not including the destination register.
 159 ///
 160 inline MachineInstrBuilder BuildMI(
 161   int Opcode, unsigned NumOperands,
 162   unsigned DestReg,
 163   MachineOperand::UseType useType = MachineOperand::Def) {
 164   return MachineInstrBuilder(new MachineInstr(Opcode, NumOperands+1,
 165                                    true, true)).addReg(DestReg, useType);
 166 }
 167
 168 /// BuildMI - This version of the builder inserts the newly-built
 169 /// instruction before the given position in the given MachineBasicBlock, and
 170 /// sets up the first operand as a destination virtual register.
 171 /// NumOperands is the number of additional add* calls that are expected,
 172 /// not including the destination register.
 173 ///
 174 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
 175                                    MachineBasicBlock::iterator I,
 176                                    int Opcode, unsigned NumOperands,
 177                                    unsigned DestReg) {
 178   MachineInstr *MI = new MachineInstr(Opcode, NumOperands+1, true, true);
 179   BB.insert(I, MI);
 180   return MachineInstrBuilder(MI).addReg(DestReg, MachineOperand::Def);
 181 }
 182
 183 /// BuildMI - This version of the builder inserts the newly-built
 184 /// instruction before the given position in the given MachineBasicBlock, and
 185 /// does NOT take a destination register.
 186 ///
 187 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
 188                                    MachineBasicBlock::iterator I,
 189                                    int Opcode, unsigned NumOperands) {
 190   MachineInstr *MI = new MachineInstr(Opcode, NumOperands, true, true);
 191   BB.insert(I, MI);
 192   return MachineInstrBuilder(MI);
 193 }
 194
 195 /// BuildMI - This version of the builder inserts the newly-built
 196 /// instruction at the end of the given MachineBasicBlock, and does NOT take a
 197 /// destination register.
 198 ///
 199 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB, int Opcode,
 200                                    unsigned NumOperands) {
 201   return BuildMI(*BB, BB->end(), Opcode, NumOperands);
 202 }
 203
 204 /// BuildMI - This version of the builder inserts the newly-built
 205 /// instruction at the end of the given MachineBasicBlock, and sets up the first
 206 /// operand as a destination virtual register. NumOperands is the number of
 207 /// additional add* calls that are expected, not including the destination
 208 /// register.
 209 ///
 210 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB, int Opcode,
 211                                    unsigned NumOperands, unsigned DestReg) {
 212   return BuildMI(*BB, BB->end(), Opcode, NumOperands, DestReg);
 213 }
 214
 215 } // End llvm namespace
 216
 217 #endif