MachineCodeEmitter.h revision d0fde30ce850b78371fd1386338350591f9ff494
1928e23f9bafe41e5cce81bf98817bc9c825d972aChris Lattner//===-- llvm/CodeGen/MachineCodeEmitter.h - Code emission -------*- 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//===----------------------------------------------------------------------===// 9928e23f9bafe41e5cce81bf98817bc9c825d972aChris Lattner// 10928e23f9bafe41e5cce81bf98817bc9c825d972aChris Lattner// This file defines an abstract interface that is used by the machine code 11928e23f9bafe41e5cce81bf98817bc9c825d972aChris Lattner// emission framework to output the code. This allows machine code emission to 12bc0e998c497446f5448425b3cbd7f8f19a458764Misha Brukman// be separated from concerns such as resolution of call targets, and where the 13928e23f9bafe41e5cce81bf98817bc9c825d972aChris Lattner// machine code will be written (memory or disk, f.e.). 14928e23f9bafe41e5cce81bf98817bc9c825d972aChris Lattner// 15928e23f9bafe41e5cce81bf98817bc9c825d972aChris Lattner//===----------------------------------------------------------------------===// 16928e23f9bafe41e5cce81bf98817bc9c825d972aChris Lattner 17661ab811d8bbc6500f8ad3051041fa94951d1480Brian Gaeke#ifndef LLVM_CODEGEN_MACHINECODEEMITTER_H 18661ab811d8bbc6500f8ad3051041fa94951d1480Brian Gaeke#define LLVM_CODEGEN_MACHINECODEEMITTER_H 19928e23f9bafe41e5cce81bf98817bc9c825d972aChris Lattner 2029dd209228125b7ae7431edb9278b6038ef4a87fChris Lattner#include <string> 21f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner#include "Support/DataTypes.h" 22d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 23d0fde30ce850b78371fd1386338350591f9ff494Brian Gaekenamespace llvm { 24d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 25d1c45a6633bb000920373c57b3590191d491036fChris Lattnerclass MachineFunction; 26d1c45a6633bb000920373c57b3590191d491036fChris Lattnerclass MachineBasicBlock; 2729dd209228125b7ae7431edb9278b6038ef4a87fChris Lattnerclass MachineConstantPool; 288562d4ec7ce4719df7e106a3d27e4549e2cc8054Chris Lattnerclass Value; 2964ccc73593370f064081552c73aa814cb2287675Chris Lattnerclass GlobalValue; 30eccf8d05ee2a23a53ff6e892cf1c34fe5da234e0Chris Lattnerclass Function; 31928e23f9bafe41e5cce81bf98817bc9c825d972aChris Lattner 32d1c45a6633bb000920373c57b3590191d491036fChris Lattnerstruct MachineCodeEmitter { 33ffc2d6f48544b24d3ac31f486d20c7073cb0b35fChris Lattner virtual ~MachineCodeEmitter() {} 34928e23f9bafe41e5cce81bf98817bc9c825d972aChris Lattner 35d1c45a6633bb000920373c57b3590191d491036fChris Lattner /// startFunction - This callback is invoked when the specified function is 36d1c45a6633bb000920373c57b3590191d491036fChris Lattner /// about to be code generated. 37d1c45a6633bb000920373c57b3590191d491036fChris Lattner /// 38d1c45a6633bb000920373c57b3590191d491036fChris Lattner virtual void startFunction(MachineFunction &F) {} 39928e23f9bafe41e5cce81bf98817bc9c825d972aChris Lattner 40d1c45a6633bb000920373c57b3590191d491036fChris Lattner /// finishFunction - This callback is invoked when the specified function has 41d1c45a6633bb000920373c57b3590191d491036fChris Lattner /// finished code generation. 42d1c45a6633bb000920373c57b3590191d491036fChris Lattner /// 43d1c45a6633bb000920373c57b3590191d491036fChris Lattner virtual void finishFunction(MachineFunction &F) {} 44d1c45a6633bb000920373c57b3590191d491036fChris Lattner 4529dd209228125b7ae7431edb9278b6038ef4a87fChris Lattner /// emitConstantPool - This callback is invoked to output the constant pool 4629dd209228125b7ae7431edb9278b6038ef4a87fChris Lattner /// for the function. 4729dd209228125b7ae7431edb9278b6038ef4a87fChris Lattner virtual void emitConstantPool(MachineConstantPool *MCP) {} 4829dd209228125b7ae7431edb9278b6038ef4a87fChris Lattner 491f25d8801f43752ee6dea6f2bfdf9430a46d20eeChris Lattner /// startFunctionStub - This callback is invoked when the JIT needs the 501f25d8801f43752ee6dea6f2bfdf9430a46d20eeChris Lattner /// address of a function that has not been code generated yet. The StubSize 511f25d8801f43752ee6dea6f2bfdf9430a46d20eeChris Lattner /// specifies the total size required by the stub. Stubs are not allowed to 521f25d8801f43752ee6dea6f2bfdf9430a46d20eeChris Lattner /// have constant pools, the can only use the other emit* methods. 531f25d8801f43752ee6dea6f2bfdf9430a46d20eeChris Lattner /// 54e0e72177c0ca447d1d2acab798a7ca2786d5618dChris Lattner virtual void startFunctionStub(const Function &F, unsigned StubSize) {} 551f25d8801f43752ee6dea6f2bfdf9430a46d20eeChris Lattner 561f25d8801f43752ee6dea6f2bfdf9430a46d20eeChris Lattner /// finishFunctionStub - This callback is invoked to terminate a function 571f25d8801f43752ee6dea6f2bfdf9430a46d20eeChris Lattner /// stub. 581f25d8801f43752ee6dea6f2bfdf9430a46d20eeChris Lattner /// 59e0e72177c0ca447d1d2acab798a7ca2786d5618dChris Lattner virtual void *finishFunctionStub(const Function &F) { return 0; } 601f25d8801f43752ee6dea6f2bfdf9430a46d20eeChris Lattner 61d1c45a6633bb000920373c57b3590191d491036fChris Lattner /// emitByte - This callback is invoked when a byte needs to be written to the 62d1c45a6633bb000920373c57b3590191d491036fChris Lattner /// output stream. 638562d4ec7ce4719df7e106a3d27e4549e2cc8054Chris Lattner /// 64d1c45a6633bb000920373c57b3590191d491036fChris Lattner virtual void emitByte(unsigned char B) {} 658562d4ec7ce4719df7e106a3d27e4549e2cc8054Chris Lattner 66f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner /// emitWord - This callback is invoked when a word needs to be written to the 67f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner /// output stream. 6864ccc73593370f064081552c73aa814cb2287675Chris Lattner /// 69f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner virtual void emitWord(unsigned W) = 0; 70f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner 71f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner /// getGlobalValueAddress - This method is used to get the address of the 72f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner /// specified global value. In some cases, however, the address may not yet 73f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner /// be known at the point that the method is called (for example, getting the 74f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner /// address of a function which has not yet been code generated). If this is 75f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner /// the case, the function returns zero, and the callee has to be able to 76f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner /// handle the situation. 7729dd209228125b7ae7431edb9278b6038ef4a87fChris Lattner /// 78f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner virtual uint64_t getGlobalValueAddress(GlobalValue *V) = 0; 79f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner virtual uint64_t getGlobalValueAddress(const std::string &Name) = 0; 80f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner 81f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner // getConstantPoolEntryAddress - Return the address of the 'Index' entry in 82f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner // the constant pool that was last emitted with the 'emitConstantPool' method. 83f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner // 84f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner virtual uint64_t getConstantPoolEntryAddress(unsigned Index) = 0; 85f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner 86f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner // getCurrentPCValue - This returns the address that the next emitted byte 87f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner // will be output to. 88f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner // 89f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner virtual uint64_t getCurrentPCValue() = 0; 90f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner 91f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner // forceCompilationOf - Force the compilation of the specified function, and 92f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner // return its address, because we REALLY need the address now. 93f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner // 94f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner // FIXME: This is JIT specific! 95f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner // 96f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner virtual uint64_t forceCompilationOf(Function *F) = 0; 97f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner 98f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner /// createDebugEmitter - Return a dynamically allocated machine 99ffc2d6f48544b24d3ac31f486d20c7073cb0b35fChris Lattner /// code emitter, which just prints the opcodes and fields out the cout. This 100ffc2d6f48544b24d3ac31f486d20c7073cb0b35fChris Lattner /// can be used for debugging users of the MachineCodeEmitter interface. 101ffc2d6f48544b24d3ac31f486d20c7073cb0b35fChris Lattner /// 102f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner static MachineCodeEmitter *createDebugEmitter(); 1036b5e0549ca9cd1c80d726ee1a7ed83035bd93388Misha Brukman 104f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner /// createFilePrinterEmitter - Return a dynamically allocated 1056b5e0549ca9cd1c80d726ee1a7ed83035bd93388Misha Brukman /// machine code emitter, which prints binary code to a file. This 1066b5e0549ca9cd1c80d726ee1a7ed83035bd93388Misha Brukman /// can be used for debugging users of the MachineCodeEmitter interface. 1076b5e0549ca9cd1c80d726ee1a7ed83035bd93388Misha Brukman /// 108f2e364ad3aaca501a30fb463c55366e4a829eccaChris Lattner static MachineCodeEmitter *createFilePrinterEmitter(MachineCodeEmitter&); 109928e23f9bafe41e5cce81bf98817bc9c825d972aChris Lattner}; 110928e23f9bafe41e5cce81bf98817bc9c825d972aChris Lattner 111d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke} // End llvm namespace 112d0fde30ce850b78371fd1386338350591f9ff494Brian Gaeke 113928e23f9bafe41e5cce81bf98817bc9c825d972aChris Lattner#endif 114