MachineInstrBuilder.h revision 6a8a9b4413cd595c8322e7ebb7d42cbb04ca6933
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 26c3c106ca59e44032041414c72ce584451f1d885fChris Lattner#include "llvm/CodeGen/MachineBasicBlock.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 /// 836a8a9b4413cd595c8322e7ebb7d42cbb04ca6933Chris Lattner const MachineInstrBuilder &addMReg(int Reg, MachineOperand::UseType Ty 846a8a9b4413cd595c8322e7ebb7d42cbb04ca6933Chris Lattner = MachineOperand::Use) const { 8532f3d08cdebd8941f2149a8f32acd45bd224ca8dChris Lattner MI->addMachineRegOperand(Reg, Ty); 86f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return *this; 87f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner } 886a8a9b4413cd595c8322e7ebb7d42cbb04ca6933Chris Lattner 896a8a9b4413cd595c8322e7ebb7d42cbb04ca6933Chris Lattner /// addImm - Add a new immediate operand. 906a8a9b4413cd595c8322e7ebb7d42cbb04ca6933Chris Lattner /// 916a8a9b4413cd595c8322e7ebb7d42cbb04ca6933Chris Lattner const MachineInstrBuilder &addImm(int Val) const { 926a8a9b4413cd595c8322e7ebb7d42cbb04ca6933Chris Lattner MI->addZeroExtImmOperand(Val); 936a8a9b4413cd595c8322e7ebb7d42cbb04ca6933Chris Lattner return *this; 946a8a9b4413cd595c8322e7ebb7d42cbb04ca6933Chris Lattner } 95f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 96f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner /// addSImm - Add a new sign extended immediate operand... 97f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner /// 986a8a9b4413cd595c8322e7ebb7d42cbb04ca6933Chris Lattner const MachineInstrBuilder &addSImm(int val) const { 99f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner MI->addSignExtImmOperand(val); 100f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return *this; 101f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner } 102f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 103f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner /// addZImm - Add a new zero extended immediate operand... 104f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner /// 1056a8a9b4413cd595c8322e7ebb7d42cbb04ca6933Chris Lattner const MachineInstrBuilder &addZImm(unsigned Val) const { 106f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner MI->addZeroExtImmOperand(Val); 107f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return *this; 108f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner } 1098cbfc75d17ee1c274116dc1aca3bc8e8ed2326c9Chris Lattner 1108cbfc75d17ee1c274116dc1aca3bc8e8ed2326c9Chris Lattner const MachineInstrBuilder &addMBB(MachineBasicBlock *MBB) const { 1118cbfc75d17ee1c274116dc1aca3bc8e8ed2326c9Chris Lattner MI->addMachineBasicBlockOperand(MBB); 1128cbfc75d17ee1c274116dc1aca3bc8e8ed2326c9Chris Lattner return *this; 1138cbfc75d17ee1c274116dc1aca3bc8e8ed2326c9Chris Lattner } 114aa0e277f310fab67df6a8bd8dfb45b6f2730c17eChris Lattner 115aa0e277f310fab67df6a8bd8dfb45b6f2730c17eChris Lattner const MachineInstrBuilder &addFrameIndex(unsigned Idx) const { 116aa0e277f310fab67df6a8bd8dfb45b6f2730c17eChris Lattner MI->addFrameIndexOperand(Idx); 117aa0e277f310fab67df6a8bd8dfb45b6f2730c17eChris Lattner return *this; 118aa0e277f310fab67df6a8bd8dfb45b6f2730c17eChris Lattner } 1199d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner 1209d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner const MachineInstrBuilder &addConstantPoolIndex(unsigned Idx) const { 1219d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner MI->addConstantPoolIndexOperand(Idx); 1229d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner return *this; 1239d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner } 1249d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner 1259d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner const MachineInstrBuilder &addGlobalAddress(GlobalValue *GV, 1269d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner bool isPCRelative = false) const { 1279d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner MI->addGlobalAddressOperand(GV, isPCRelative); 1289d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner return *this; 1299d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner } 1309d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner 1319d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner const MachineInstrBuilder &addExternalSymbol(const std::string &Name, 1329d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner bool isPCRelative = false) const{ 1339d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner MI->addExternalSymbolOperand(Name, isPCRelative); 1349d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner return *this; 1359d4f9b990222ed46959cd0a1aef07c0923d346e6Chris Lattner } 136f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner}; 137f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 138f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner/// BuildMI - Builder interface. Specify how to create the initial instruction 1399cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// itself. NumOperands is the number of operands to the machine instruction to 1409cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// allow for memory efficient representation of machine instructions. 141f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner/// 1424052cf998f826db723e783bc1550c09e69402b29Chris Lattnerinline MachineInstrBuilder BuildMI(int Opcode, unsigned NumOperands) { 143f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner return MachineInstrBuilder(new MachineInstr(Opcode, NumOperands, true, true)); 144f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner} 145f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner 146367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner/// BuildMI - This version of the builder also sets up the first "operand" as a 147367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner/// destination virtual register. NumOperands is the number of additional add* 148367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner/// calls that are expected, it does not include the destination register. 149367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner/// 150890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenosinline MachineInstrBuilder BuildMI( 151890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos int Opcode, unsigned NumOperands, 152890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos unsigned DestReg, 153890f92328d5478e050d2eba8f4de24737a04a812Alkis Evlogimenos MachineOperand::UseType useType = MachineOperand::Def) { 154367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner return MachineInstrBuilder(new MachineInstr(Opcode, NumOperands+1, 15514be64018fb38d1fa535b9cd12d11371f4eba3b5Alkis Evlogimenos true, true)).addReg(DestReg, useType); 156367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner} 157367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner 158367ccab06e77247eb38b0e666425913e39b82cf0Chris Lattner 159c3c106ca59e44032041414c72ce584451f1d885fChris Lattner/// BuildMI - Insert the instruction before a specified location in the basic 160c3c106ca59e44032041414c72ce584451f1d885fChris Lattner/// block. 161c3c106ca59e44032041414c72ce584451f1d885fChris Lattnerinline MachineInstrBuilder BuildMI(MachineBasicBlock &BB, 162c3c106ca59e44032041414c72ce584451f1d885fChris Lattner MachineBasicBlock::iterator I, 163c3c106ca59e44032041414c72ce584451f1d885fChris Lattner int Opcode, unsigned NumOperands, 164c3c106ca59e44032041414c72ce584451f1d885fChris Lattner unsigned DestReg) { 165c3c106ca59e44032041414c72ce584451f1d885fChris Lattner MachineInstr *MI = new MachineInstr(Opcode, NumOperands+1, true, true); 166c3c106ca59e44032041414c72ce584451f1d885fChris Lattner BB.insert(I, MI); 167c3c106ca59e44032041414c72ce584451f1d885fChris Lattner return MachineInstrBuilder(MI).addReg(DestReg, MachineOperand::Def); 168c3c106ca59e44032041414c72ce584451f1d885fChris Lattner} 169c3c106ca59e44032041414c72ce584451f1d885fChris Lattner 170c3c106ca59e44032041414c72ce584451f1d885fChris Lattner/// BMI - A special BuildMI variant that takes an iterator to insert the 171c3c106ca59e44032041414c72ce584451f1d885fChris Lattner/// instruction at as well as a basic block. 172c3c106ca59e44032041414c72ce584451f1d885fChris Lattnerinline MachineInstrBuilder BuildMI(MachineBasicBlock &BB, 173c3c106ca59e44032041414c72ce584451f1d885fChris Lattner MachineBasicBlock::iterator I, 174c3c106ca59e44032041414c72ce584451f1d885fChris Lattner int Opcode, unsigned NumOperands) { 175c3c106ca59e44032041414c72ce584451f1d885fChris Lattner MachineInstr *MI = new MachineInstr(Opcode, NumOperands, true, true); 176c3c106ca59e44032041414c72ce584451f1d885fChris Lattner BB.insert(I, MI); 177c3c106ca59e44032041414c72ce584451f1d885fChris Lattner return MachineInstrBuilder(MI); 178c3c106ca59e44032041414c72ce584451f1d885fChris Lattner} 179c3c106ca59e44032041414c72ce584451f1d885fChris Lattner 1809cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// BuildMI - This version of the builder inserts the built MachineInstr into 1819cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// the specified MachineBasicBlock. 1829cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// 1834052cf998f826db723e783bc1550c09e69402b29Chris Lattnerinline MachineInstrBuilder BuildMI(MachineBasicBlock *BB, int Opcode, 1847db458fb0768059f050d3a0f1a26818fa8e22712Chris Lattner unsigned NumOperands) { 185c3c106ca59e44032041414c72ce584451f1d885fChris Lattner return BuildMI(*BB, BB->end(), Opcode, NumOperands); 186f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner} 1877db458fb0768059f050d3a0f1a26818fa8e22712Chris Lattner 1889cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// BuildMI - This version of the builder inserts the built MachineInstr into 1899cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// the specified MachineBasicBlock, and also sets up the first "operand" as a 1909cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// destination virtual register. NumOperands is the number of additional add* 1919cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// calls that are expected, it does not include the destination register. 1929cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner/// 1934052cf998f826db723e783bc1550c09e69402b29Chris Lattnerinline MachineInstrBuilder BuildMI(MachineBasicBlock *BB, int Opcode, 1949cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner unsigned NumOperands, unsigned DestReg) { 195c3c106ca59e44032041414c72ce584451f1d885fChris Lattner return BuildMI(*BB, BB->end(), Opcode, NumOperands, DestReg); 1969cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner} 1979cc361579b6a0aad9a71dc617eedd4d909d48acfChris Lattner 198d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke} // End llvm namespace 199d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 200f0136b376e2ff9b816ab4cbd4ac82df87b5c52b4Chris Lattner#endif 201