MachineInstrBuilder.h revision d0fde30ce850b78371fd1386338350591f9ff494
1f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner//===-- CodeGen/MachineInstBuilder.h - Simplify creation of MIs -*- C++ -*-===// 26fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// 36fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// The LLVM Compiler Infrastructure 46fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// 56fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// This file was developed by the LLVM research group and is distributed under 66fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// the University of Illinois Open Source License. See LICENSE.TXT for details. 76fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell// 86fbcc26f1460eaee4e0eb8b426fc1ff0c7af11beJohn Criswell//===----------------------------------------------------------------------===// 9f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner// 10f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner// This file exposes a function named BuildMI, which is useful for dramatically 11f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner// simplifying how MachineInstr's are created. Instead of using code like this: 12f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner// 13f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner// M = new MachineInstr(X86::ADDrr32); 14f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner// M->SetMachineOperandVal(0, MachineOperand::MO_VirtualRegister, argVal1); 15f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner// M->SetMachineOperandVal(1, MachineOperand::MO_VirtualRegister, argVal2); 16f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner// 17f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner// we can now use code like this: 18f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner// 199ed63ee0fcaa6730eb1df8c1ddbf5f46d8c81329Chris Lattner// M = BuildMI(X86::ADDrr8, 2).addReg(argVal1).addReg(argVal2); 20f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner// 21f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner//===----------------------------------------------------------------------===// 22f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 23f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner#ifndef LLVM_CODEGEN_MACHINEINSTRBUILDER_H 24f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner#define LLVM_CODEGEN_MACHINEINSTRBUILDER_H 25f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 26f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner#include "llvm/CodeGen/MachineInstr.h" 27f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 28d0fde30ce850b78371fd1386338350591f9ff494Brian Gaekenamespace llvm { 29d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 309d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattnerclass MachineInstrBuilder { 31f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner MachineInstr *MI; 329d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattnerpublic: 33f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner MachineInstrBuilder(MachineInstr *mi) : MI(mi) {} 34f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 35f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner /// Allow automatic conversion to the machine instruction we are working on. 36f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner /// 37f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner operator MachineInstr*() const { return MI; } 38f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 399ed63ee0fcaa6730eb1df8c1ddbf5f46d8c81329Chris Lattner /// addReg - Add a new virtual register operand... 40f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner /// 4132f3d08cdebd8941f2149a8f32acd45bd224ca8dChris Lattner const MachineInstrBuilder &addReg(int RegNo, 4232f3d08cdebd8941f2149a8f32acd45bd224ca8dChris Lattner MOTy::UseType Ty = MOTy::Use) const { 4332f3d08cdebd8941f2149a8f32acd45bd224ca8dChris Lattner MI->addRegOperand(RegNo, Ty); 44f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return *this; 45f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner } 46f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 476559bb96a9901af21c6037675f9508373773bd35Brian Gaeke /// addReg - Add an LLVM value that is to be used as a register... 489ed63ee0fcaa6730eb1df8c1ddbf5f46d8c81329Chris Lattner /// 4932f3d08cdebd8941f2149a8f32acd45bd224ca8dChris Lattner const MachineInstrBuilder &addReg(Value *V, 5032f3d08cdebd8941f2149a8f32acd45bd224ca8dChris Lattner MOTy::UseType Ty = MOTy::Use) const { 5132f3d08cdebd8941f2149a8f32acd45bd224ca8dChris Lattner MI->addRegOperand(V, Ty); 52f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return *this; 53f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner } 54f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 5583435fbaf98a89cc5d6f13a68bab7e52e8fb6cb3Chris Lattner /// addReg - Add an LLVM value that is to be used as a register... 5683435fbaf98a89cc5d6f13a68bab7e52e8fb6cb3Chris Lattner /// 5783435fbaf98a89cc5d6f13a68bab7e52e8fb6cb3Chris Lattner const MachineInstrBuilder &addCCReg(Value *V, 5883435fbaf98a89cc5d6f13a68bab7e52e8fb6cb3Chris Lattner MOTy::UseType Ty = MOTy::Use) const { 5983435fbaf98a89cc5d6f13a68bab7e52e8fb6cb3Chris Lattner MI->addCCRegOperand(V, Ty); 6083435fbaf98a89cc5d6f13a68bab7e52e8fb6cb3Chris Lattner return *this; 6183435fbaf98a89cc5d6f13a68bab7e52e8fb6cb3Chris Lattner } 6283435fbaf98a89cc5d6f13a68bab7e52e8fb6cb3Chris Lattner 63e387de30841a5e106015379b6c47c568cde8b06eChris Lattner /// addRegDef - Add an LLVM value that is to be defined as a register... this 64e387de30841a5e106015379b6c47c568cde8b06eChris Lattner /// is the same as addReg(V, MOTy::Def). 656559bb96a9901af21c6037675f9508373773bd35Brian Gaeke /// 66e387de30841a5e106015379b6c47c568cde8b06eChris Lattner const MachineInstrBuilder &addRegDef(Value *V) const { 67e387de30841a5e106015379b6c47c568cde8b06eChris Lattner return addReg(V, MOTy::Def); 686559bb96a9901af21c6037675f9508373773bd35Brian Gaeke } 696559bb96a9901af21c6037675f9508373773bd35Brian Gaeke 709ed63ee0fcaa6730eb1df8c1ddbf5f46d8c81329Chris Lattner /// addPCDisp - Add an LLVM value to be treated as a PC relative 719ed63ee0fcaa6730eb1df8c1ddbf5f46d8c81329Chris Lattner /// displacement... 729ed63ee0fcaa6730eb1df8c1ddbf5f46d8c81329Chris Lattner /// 735494c7ed9dd8f5a3dbaf42d2b9ddb9cd3a85aa34Chris Lattner const MachineInstrBuilder &addPCDisp(Value *V) const { 74f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner MI->addPCDispOperand(V); 75f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return *this; 76f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner } 77f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 789ed63ee0fcaa6730eb1df8c1ddbf5f46d8c81329Chris Lattner /// addMReg - Add a machine register operand... 799ed63ee0fcaa6730eb1df8c1ddbf5f46d8c81329Chris Lattner /// 8032f3d08cdebd8941f2149a8f32acd45bd224ca8dChris Lattner const MachineInstrBuilder &addMReg(int Reg, 8132f3d08cdebd8941f2149a8f32acd45bd224ca8dChris Lattner MOTy::UseType Ty = MOTy::Use) const { 8232f3d08cdebd8941f2149a8f32acd45bd224ca8dChris Lattner MI->addMachineRegOperand(Reg, Ty); 83f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return *this; 84f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner } 85f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 86f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner /// addSImm - Add a new sign extended immediate operand... 87f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner /// 885494c7ed9dd8f5a3dbaf42d2b9ddb9cd3a85aa34Chris Lattner const MachineInstrBuilder &addSImm(int64_t val) const { 89f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner MI->addSignExtImmOperand(val); 90f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return *this; 91f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner } 92f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 93f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner /// addZImm - Add a new zero extended immediate operand... 94f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner /// 955494c7ed9dd8f5a3dbaf42d2b9ddb9cd3a85aa34Chris Lattner const MachineInstrBuilder &addZImm(int64_t Val) const { 96f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner MI->addZeroExtImmOperand(Val); 97f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return *this; 98f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner } 998cbfc75d17ee1c274116dc1aca3bc8e8ed2326c9Chris Lattner 1008cbfc75d17ee1c274116dc1aca3bc8e8ed2326c9Chris Lattner const MachineInstrBuilder &addMBB(MachineBasicBlock *MBB) const { 1018cbfc75d17ee1c274116dc1aca3bc8e8ed2326c9Chris Lattner MI->addMachineBasicBlockOperand(MBB); 1028cbfc75d17ee1c274116dc1aca3bc8e8ed2326c9Chris Lattner return *this; 1038cbfc75d17ee1c274116dc1aca3bc8e8ed2326c9Chris Lattner } 104aa0e277f310fab67df6a8bd8dfb45b6f2730c17eChris Lattner 105aa0e277f310fab67df6a8bd8dfb45b6f2730c17eChris Lattner const MachineInstrBuilder &addFrameIndex(unsigned Idx) const { 106aa0e277f310fab67df6a8bd8dfb45b6f2730c17eChris Lattner MI->addFrameIndexOperand(Idx); 107aa0e277f310fab67df6a8bd8dfb45b6f2730c17eChris Lattner return *this; 108aa0e277f310fab67df6a8bd8dfb45b6f2730c17eChris Lattner } 1099d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner 1109d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner const MachineInstrBuilder &addConstantPoolIndex(unsigned Idx) const { 1119d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner MI->addConstantPoolIndexOperand(Idx); 1129d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner return *this; 1139d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner } 1149d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner 1159d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner const MachineInstrBuilder &addGlobalAddress(GlobalValue *GV, 1169d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner bool isPCRelative = false) const { 1179d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner MI->addGlobalAddressOperand(GV, isPCRelative); 1189d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner return *this; 1199d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner } 1209d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner 1219d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner const MachineInstrBuilder &addExternalSymbol(const std::string &Name, 1229d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner bool isPCRelative = false) const{ 1239d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner MI->addExternalSymbolOperand(Name, isPCRelative); 1249d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner return *this; 1259d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner } 126f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner}; 127f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 128f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner/// BuildMI - Builder interface. Specify how to create the initial instruction 1299cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// itself. NumOperands is the number of operands to the machine instruction to 1309cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// allow for memory efficient representation of machine instructions. 131f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner/// 1324052cf998f826db723e783bc1550c09e69402b29Chris Lattnerinline MachineInstrBuilder BuildMI(int Opcode, unsigned NumOperands) { 133f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return MachineInstrBuilder(new MachineInstr(Opcode, NumOperands, true, true)); 134f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner} 135f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 136367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner/// BuildMI - This version of the builder also sets up the first "operand" as a 137367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner/// destination virtual register. NumOperands is the number of additional add* 138367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner/// calls that are expected, it does not include the destination register. 139367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner/// 1404052cf998f826db723e783bc1550c09e69402b29Chris Lattnerinline MachineInstrBuilder BuildMI(int Opcode, unsigned NumOperands, 141367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner unsigned DestReg) { 142367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner return MachineInstrBuilder(new MachineInstr(Opcode, NumOperands+1, 143367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner true, true)).addReg(DestReg, MOTy::Def); 144367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner} 145367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner 146367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner 1479cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// BuildMI - This version of the builder inserts the built MachineInstr into 1489cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// the specified MachineBasicBlock. 1499cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// 1504052cf998f826db723e783bc1550c09e69402b29Chris Lattnerinline MachineInstrBuilder BuildMI(MachineBasicBlock *BB, int Opcode, 1517db458fb0768059f050d3a0f1a26818fa8e22712Chris Lattner unsigned NumOperands) { 1527db458fb0768059f050d3a0f1a26818fa8e22712Chris Lattner return MachineInstrBuilder(new MachineInstr(BB, Opcode, NumOperands)); 153f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner} 1547db458fb0768059f050d3a0f1a26818fa8e22712Chris Lattner 1559cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// BuildMI - This version of the builder inserts the built MachineInstr into 1569cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// the specified MachineBasicBlock, and also sets up the first "operand" as a 1579cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// destination virtual register. NumOperands is the number of additional add* 1589cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// calls that are expected, it does not include the destination register. 1599cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// 1604052cf998f826db723e783bc1550c09e69402b29Chris Lattnerinline MachineInstrBuilder BuildMI(MachineBasicBlock *BB, int Opcode, 1619cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner unsigned NumOperands, unsigned DestReg) { 1629cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner return MachineInstrBuilder(new MachineInstr(BB, Opcode, 1639cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner NumOperands+1)).addReg(DestReg, 16432f3d08cdebd8941f2149a8f32acd45bd224ca8dChris Lattner MOTy::Def); 1659cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner} 1669cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner 167d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke} // End llvm namespace 168d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 169f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner#endif 170