include/llvm/CodeGen/MachineInstrBuilder.h

   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
  23 namespace llvm {
  24
  25 class TargetInstrDesc;
  26
  27 class MachineInstrBuilder {
  28   MachineInstr *MI;
  29 public:
  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
  88 /// BuildMI - Builder interface.  Specify how to create the initial instruction
  89 /// itself.
  90 ///
  91 inline MachineInstrBuilder BuildMI(const TargetInstrDesc &TID) {
  92   return MachineInstrBuilder(new MachineInstr(TID));
  93 }
  94
  95 /// BuildMI - This version of the builder sets up the first operand as a
  96 /// destination virtual register.
  97 ///
  98 inline MachineInstrBuilder  BuildMI(const TargetInstrDesc &TID,
  99                                     unsigned DestReg) {
 100   return MachineInstrBuilder(new MachineInstr(TID)).addReg(DestReg, true);
 101 }
 102
 103 /// BuildMI - This version of the builder inserts the newly-built
 104 /// instruction before the given position in the given MachineBasicBlock, and
 105 /// sets up the first operand as a destination virtual register.
 106 ///
 107 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
 108                                    MachineBasicBlock::iterator I,
 109                                    const TargetInstrDesc &TID,
 110                                    unsigned DestReg) {
 111   MachineInstr *MI = new MachineInstr(TID);
 112   BB.insert(I, MI);
 113   return MachineInstrBuilder(MI).addReg(DestReg, true);
 114 }
 115
 116 /// BuildMI - This version of the builder inserts the newly-built
 117 /// instruction before the given position in the given MachineBasicBlock, and
 118 /// does NOT take a destination register.
 119 ///
 120 inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
 121                                    MachineBasicBlock::iterator I,
 122                                    const TargetInstrDesc &TID) {
 123   MachineInstr *MI = new MachineInstr(TID);
 124   BB.insert(I, MI);
 125   return MachineInstrBuilder(MI);
 126 }
 127
 128 /// BuildMI - This version of the builder inserts the newly-built
 129 /// instruction at the end of the given MachineBasicBlock, and does NOT take a
 130 /// destination register.
 131 ///
 132 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
 133                                    const TargetInstrDesc &TID) {
 134   return BuildMI(*BB, BB->end(), TID);
 135 }
 136
 137 /// BuildMI - This version of the builder inserts the newly-built
 138 /// instruction at the end of the given MachineBasicBlock, and sets up the first
 139 /// operand as a destination virtual register.
 140 ///
 141 inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
 142                                    const TargetInstrDesc &TID,
 143                                    unsigned DestReg) {
 144   return BuildMI(*BB, BB->end(), TID, DestReg);
 145 }
 146
 147 } // End llvm namespace
 148
 149 #endif