rename TargetInstrDescriptor -> TargetInstrDesc.
[oota-llvm.git] / include / llvm / CodeGen / MachineInstrBuilder.h
index b5d8ba9f182cd81ada159e8560008271a76f72a3..97d6736ac03277edca4c3f158bee8e7f1554bc64 100644 (file)
@@ -1,65 +1,86 @@
 //===-- CodeGen/MachineInstBuilder.h - Simplify creation of MIs -*- C++ -*-===//
 //
-// This file exposes a function named BuildMI, which is useful for dramatically
-// simplifying how MachineInstr's are created.  Instead of using code like this:
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
-//   M = new MachineInstr(X86::ADDrr32);
-//   M->SetMachineOperandVal(0, MachineOperand::MO_VirtualRegister, argVal1);
-//   M->SetMachineOperandVal(1, MachineOperand::MO_VirtualRegister, argVal2);
+//===----------------------------------------------------------------------===//
 //
-// we can now use code like this:
+// This file exposes a function named BuildMI, which is useful for dramatically
+// simplifying how MachineInstr's are created.  It allows use of code like this:
 //
-//   M = BuildMI(X86::ADDrr8).addReg(argVal1).addReg(argVal2);
+//   M = BuildMI(X86::ADDrr8, 2).addReg(argVal1).addReg(argVal2);
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_CODEGEN_MACHINEINSTRBUILDER_H
 #define LLVM_CODEGEN_MACHINEINSTRBUILDER_H
 
-#include "llvm/CodeGen/MachineInstr.h"
+#include "llvm/CodeGen/MachineBasicBlock.h"
+#include "llvm/CodeGen/MachineFunction.h"
 
-struct MachineInstrBuilder { 
-  MachineInstr *MI;
+namespace llvm {
+
+class TargetInstrDesc;
 
-  MachineInstrBuilder(MachineInstr *mi) : MI(mi) {}
+class MachineInstrBuilder {
+  MachineInstr *MI;
+public:
+  explicit MachineInstrBuilder(MachineInstr *mi) : MI(mi) {}
 
   /// Allow automatic conversion to the machine instruction we are working on.
   ///
   operator MachineInstr*() const { return MI; }
+  operator MachineBasicBlock::iterator() const { return MI; }
+
+  /// addReg - Add a new virtual register operand...
+  ///
+  const
+  MachineInstrBuilder &addReg(unsigned RegNo, bool isDef = false, 
+                              bool isImp = false, bool isKill = false, 
+                              bool isDead = false, unsigned SubReg = 0) const {
+    MI->addOperand(MachineOperand::CreateReg(RegNo, isDef, isImp, isKill,
+                                             isDead, SubReg));
+    return *this;
+  }
 
-  /// addReg - Add a new register operand...
+  /// addImm - Add a new immediate operand.
   ///
-  MachineInstrBuilder &addReg(int RegNo) {
-    MI->addRegOperand(RegNo);
+  const MachineInstrBuilder &addImm(int64_t Val) const {
+    MI->addOperand(MachineOperand::CreateImm(Val));
     return *this;
   }
 
-  MachineInstrBuilder &addReg(Value *V, bool isDef = false, bool isDNU = false){
-    MI->addRegOperand(V, isDef, isDNU);
+  const MachineInstrBuilder &addMBB(MachineBasicBlock *MBB) const {
+    MI->addOperand(MachineOperand::CreateMBB(MBB));
     return *this;
   }
 
-  MachineInstrBuilder &addPCDisp(Value *V) {
-    MI->addPCDispOperand(V);
+  const MachineInstrBuilder &addFrameIndex(unsigned Idx) const {
+    MI->addOperand(MachineOperand::CreateFI(Idx));
     return *this;
   }
 
-  MachineInstrBuilder &addMReg(int Reg, bool isDef=false) {
-    MI->addMachineRegOperand(Reg, isDef);
+  const MachineInstrBuilder &addConstantPoolIndex(unsigned Idx,
+                                                  int Offset = 0) const {
+    MI->addOperand(MachineOperand::CreateCPI(Idx, Offset));
     return *this;
   }
 
-  /// addSImm - Add a new sign extended immediate operand...
-  ///
-  MachineInstrBuilder &addSImm(int64_t val) {
-    MI->addSignExtImmOperand(val);
+  const MachineInstrBuilder &addJumpTableIndex(unsigned Idx) const {
+    MI->addOperand(MachineOperand::CreateJTI(Idx));
     return *this;
   }
 
-  /// addZImm - Add a new zero extended immediate operand...
-  ///
-  MachineInstrBuilder &addZImm(int64_t Val) {
-    MI->addZeroExtImmOperand(Val);
+  const MachineInstrBuilder &addGlobalAddress(GlobalValue *GV,
+                                              int Offset = 0) const {
+    MI->addOperand(MachineOperand::CreateGA(GV, Offset));
+    return *this;
+  }
+
+  const MachineInstrBuilder &addExternalSymbol(const char *FnName) const{
+    MI->addOperand(MachineOperand::CreateES(FnName, 0));
     return *this;
   }
 };
@@ -67,15 +88,62 @@ struct MachineInstrBuilder {
 /// BuildMI - Builder interface.  Specify how to create the initial instruction
 /// itself.
 ///
-inline MachineInstrBuilder BuildMI(MachineOpCode Opcode, unsigned NumOperands) {
-  return MachineInstrBuilder(new MachineInstr(Opcode, NumOperands, true, true));
+inline MachineInstrBuilder BuildMI(const TargetInstrDesc &TID) {
+  return MachineInstrBuilder(new MachineInstr(TID));
 }
 
-#if 0
-inline MachineInstrBuilder BuildMI(MBasicBlock *BB, MachineOpCode Opcode,
-                                   unsigned DestReg = 0) {
-  return MachineInstrBuilder(new MachineInstr(BB, Opcode, DestReg));
+/// BuildMI - This version of the builder sets up the first operand as a
+/// destination virtual register.
+///
+inline MachineInstrBuilder  BuildMI(const TargetInstrDesc &TID,
+                                    unsigned DestReg) {
+  return MachineInstrBuilder(new MachineInstr(TID)).addReg(DestReg, true);
 }
-#endif
-                                
+
+/// BuildMI - This version of the builder inserts the newly-built
+/// instruction before the given position in the given MachineBasicBlock, and
+/// sets up the first operand as a destination virtual register.
+///
+inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
+                                   MachineBasicBlock::iterator I,
+                                   const TargetInstrDesc &TID,
+                                   unsigned DestReg) {
+  MachineInstr *MI = new MachineInstr(TID);
+  BB.insert(I, MI);
+  return MachineInstrBuilder(MI).addReg(DestReg, true);
+}
+
+/// BuildMI - This version of the builder inserts the newly-built
+/// instruction before the given position in the given MachineBasicBlock, and
+/// does NOT take a destination register.
+///
+inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
+                                   MachineBasicBlock::iterator I,
+                                   const TargetInstrDesc &TID) {
+  MachineInstr *MI = new MachineInstr(TID);
+  BB.insert(I, MI);
+  return MachineInstrBuilder(MI);
+}
+
+/// BuildMI - This version of the builder inserts the newly-built
+/// instruction at the end of the given MachineBasicBlock, and does NOT take a
+/// destination register.
+///
+inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
+                                   const TargetInstrDesc &TID) {
+  return BuildMI(*BB, BB->end(), TID);
+}
+
+/// BuildMI - This version of the builder inserts the newly-built
+/// instruction at the end of the given MachineBasicBlock, and sets up the first
+/// operand as a destination virtual register. 
+///
+inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB,
+                                   const TargetInstrDesc &TID,
+                                   unsigned DestReg) {
+  return BuildMI(*BB, BB->end(), TID, DestReg);
+}
+
+} // End llvm namespace
+
 #endif