MachineInstrBuilder.h revision 890f92328d5478e050d2eba8f4de24737a04a812
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 /// 41890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos const MachineInstrBuilder &addReg( 42890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos int RegNo, 43890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos MachineOperand::UseType Ty = MachineOperand::Use) const { 4432f3d08cdebd8941f2149a8f32acd45bd224ca8dChris Lattner MI->addRegOperand(RegNo, Ty); 45f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return *this; 46f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner } 47f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 486559bb96a9901af21c6037675f9508373773bd35Brian Gaeke /// addReg - Add an LLVM value that is to be used as a register... 499ed63ee0fcaa6730eb1df8c1ddbf5f46d8c81329Chris Lattner /// 50890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos const MachineInstrBuilder &addReg( 51890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos Value *V, 52890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos MachineOperand::UseType Ty = MachineOperand::Use) const { 5332f3d08cdebd8941f2149a8f32acd45bd224ca8dChris Lattner MI->addRegOperand(V, Ty); 54f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return *this; 55f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner } 56f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 5783435fbaf98a89cc5d6f13a68bab7e52e8fb6cb3Chris Lattner /// addReg - Add an LLVM value that is to be used as a register... 5883435fbaf98a89cc5d6f13a68bab7e52e8fb6cb3Chris Lattner /// 59890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos const MachineInstrBuilder &addCCReg( 60890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos Value *V, 61890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos MachineOperand::UseType Ty = MachineOperand::Use) const { 6283435fbaf98a89cc5d6f13a68bab7e52e8fb6cb3Chris Lattner MI->addCCRegOperand(V, Ty); 6383435fbaf98a89cc5d6f13a68bab7e52e8fb6cb3Chris Lattner return *this; 6483435fbaf98a89cc5d6f13a68bab7e52e8fb6cb3Chris Lattner } 6583435fbaf98a89cc5d6f13a68bab7e52e8fb6cb3Chris Lattner 66e387de30841a5e106015379b6c47c568cde8b06eChris Lattner /// addRegDef - Add an LLVM value that is to be defined as a register... this 67890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos /// is the same as addReg(V, MachineOperand::Def). 686559bb96a9901af21c6037675f9508373773bd35Brian Gaeke /// 69e387de30841a5e106015379b6c47c568cde8b06eChris Lattner const MachineInstrBuilder &addRegDef(Value *V) const { 70890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos return addReg(V, MachineOperand::Def); 716559bb96a9901af21c6037675f9508373773bd35Brian Gaeke } 726559bb96a9901af21c6037675f9508373773bd35Brian Gaeke 739ed63ee0fcaa6730eb1df8c1ddbf5f46d8c81329Chris Lattner /// addPCDisp - Add an LLVM value to be treated as a PC relative 749ed63ee0fcaa6730eb1df8c1ddbf5f46d8c81329Chris Lattner /// displacement... 759ed63ee0fcaa6730eb1df8c1ddbf5f46d8c81329Chris Lattner /// 765494c7ed9dd8f5a3dbaf42d2b9ddb9cd3a85aa34Chris Lattner const MachineInstrBuilder &addPCDisp(Value *V) const { 77f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner MI->addPCDispOperand(V); 78f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return *this; 79f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner } 80f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 819ed63ee0fcaa6730eb1df8c1ddbf5f46d8c81329Chris Lattner /// addMReg - Add a machine register operand... 829ed63ee0fcaa6730eb1df8c1ddbf5f46d8c81329Chris Lattner /// 83890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos const MachineInstrBuilder &addMReg( 84890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos int Reg, 85890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos MachineOperand::UseType Ty = MachineOperand::Use) const { 8632f3d08cdebd8941f2149a8f32acd45bd224ca8dChris Lattner MI->addMachineRegOperand(Reg, Ty); 87f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return *this; 88f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner } 89f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 90f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner /// addSImm - Add a new sign extended immediate operand... 91f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner /// 925494c7ed9dd8f5a3dbaf42d2b9ddb9cd3a85aa34Chris Lattner const MachineInstrBuilder &addSImm(int64_t val) const { 93f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner MI->addSignExtImmOperand(val); 94f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return *this; 95f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner } 96f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 97f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner /// addZImm - Add a new zero extended immediate operand... 98f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner /// 995494c7ed9dd8f5a3dbaf42d2b9ddb9cd3a85aa34Chris Lattner const MachineInstrBuilder &addZImm(int64_t Val) const { 100f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner MI->addZeroExtImmOperand(Val); 101f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return *this; 102f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner } 1038cbfc75d17ee1c274116dc1aca3bc8e8ed2326c9Chris Lattner 1048cbfc75d17ee1c274116dc1aca3bc8e8ed2326c9Chris Lattner const MachineInstrBuilder &addMBB(MachineBasicBlock *MBB) const { 1058cbfc75d17ee1c274116dc1aca3bc8e8ed2326c9Chris Lattner MI->addMachineBasicBlockOperand(MBB); 1068cbfc75d17ee1c274116dc1aca3bc8e8ed2326c9Chris Lattner return *this; 1078cbfc75d17ee1c274116dc1aca3bc8e8ed2326c9Chris Lattner } 108aa0e277f310fab67df6a8bd8dfb45b6f2730c17eChris Lattner 109aa0e277f310fab67df6a8bd8dfb45b6f2730c17eChris Lattner const MachineInstrBuilder &addFrameIndex(unsigned Idx) const { 110aa0e277f310fab67df6a8bd8dfb45b6f2730c17eChris Lattner MI->addFrameIndexOperand(Idx); 111aa0e277f310fab67df6a8bd8dfb45b6f2730c17eChris Lattner return *this; 112aa0e277f310fab67df6a8bd8dfb45b6f2730c17eChris Lattner } 1139d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner 1149d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner const MachineInstrBuilder &addConstantPoolIndex(unsigned Idx) const { 1159d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner MI->addConstantPoolIndexOperand(Idx); 1169d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner return *this; 1179d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner } 1189d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner 1199d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner const MachineInstrBuilder &addGlobalAddress(GlobalValue *GV, 1209d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner bool isPCRelative = false) const { 1219d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner MI->addGlobalAddressOperand(GV, isPCRelative); 1229d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner return *this; 1239d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner } 1249d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner 1259d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner const MachineInstrBuilder &addExternalSymbol(const std::string &Name, 1269d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner bool isPCRelative = false) const{ 1279d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner MI->addExternalSymbolOperand(Name, isPCRelative); 1289d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner return *this; 1299d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner } 130f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner}; 131f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 132f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner/// BuildMI - Builder interface. Specify how to create the initial instruction 1339cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// itself. NumOperands is the number of operands to the machine instruction to 1349cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// allow for memory efficient representation of machine instructions. 135f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner/// 1364052cf998f826db723e783bc1550c09e69402b29Chris Lattnerinline MachineInstrBuilder BuildMI(int Opcode, unsigned NumOperands) { 137f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return MachineInstrBuilder(new MachineInstr(Opcode, NumOperands, true, true)); 138f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner} 139f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 140367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner/// BuildMI - This version of the builder also sets up the first "operand" as a 141367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner/// destination virtual register. NumOperands is the number of additional add* 142367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner/// calls that are expected, it does not include the destination register. 143367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner/// 144890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenosinline MachineInstrBuilder BuildMI( 145890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos int Opcode, unsigned NumOperands, 146890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos unsigned DestReg, 147890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos MachineOperand::UseType useType = MachineOperand::Def) { 148367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner return MachineInstrBuilder(new MachineInstr(Opcode, NumOperands+1, 14914be64018fb38d1fa535b9cd12d11371f4eba3b5Alkis Evlogimenos true, true)).addReg(DestReg, useType); 150367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner} 151367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner 152367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner 1539cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// BuildMI - This version of the builder inserts the built MachineInstr into 1549cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// the specified MachineBasicBlock. 1559cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// 1564052cf998f826db723e783bc1550c09e69402b29Chris Lattnerinline MachineInstrBuilder BuildMI(MachineBasicBlock *BB, int Opcode, 1577db458fb0768059f050d3a0f1a26818fa8e22712Chris Lattner unsigned NumOperands) { 1587db458fb0768059f050d3a0f1a26818fa8e22712Chris Lattner return MachineInstrBuilder(new MachineInstr(BB, Opcode, NumOperands)); 159f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner} 1607db458fb0768059f050d3a0f1a26818fa8e22712Chris Lattner 1619cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// BuildMI - This version of the builder inserts the built MachineInstr into 1629cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// the specified MachineBasicBlock, and also sets up the first "operand" as a 1639cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// destination virtual register. NumOperands is the number of additional add* 1649cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// calls that are expected, it does not include the destination register. 1659cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// 1664052cf998f826db723e783bc1550c09e69402b29Chris Lattnerinline MachineInstrBuilder BuildMI(MachineBasicBlock *BB, int Opcode, 1679cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner unsigned NumOperands, unsigned DestReg) { 168890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos return MachineInstrBuilder( 169890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos new MachineInstr(BB, Opcode, NumOperands+1)) 170890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos .addReg(DestReg, MachineOperand::Def); 1719cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner} 1729cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner 173d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke} // End llvm namespace 174d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 175f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner#endif 176