1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
//===-- llvm/CodeGen/MachineCodeEmitter.h - Code emission -------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file was developed by the LLVM research group and is distributed under
// the University of Illinois Open Source License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file defines an abstract interface that is used by the machine code
// emission framework to output the code. This allows machine code emission to
// be separated from concerns such as resolution of call targets, and where the
// machine code will be written (memory or disk, f.e.).
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_CODEGEN_MACHINECODEEMITTER_H
#define LLVM_CODEGEN_MACHINECODEEMITTER_H
#include <string>
#include "llvm/Support/DataTypes.h"
namespace llvm {
class MachineFunction;
class MachineBasicBlock;
class MachineConstantPool;
class Value;
class GlobalValue;
class Function;
struct MachineCodeEmitter {
virtual ~MachineCodeEmitter() {}
/// startFunction - This callback is invoked when the specified function is
/// about to be code generated.
///
virtual void startFunction(MachineFunction &F) {}
/// finishFunction - This callback is invoked when the specified function has
/// finished code generation.
///
virtual void finishFunction(MachineFunction &F) {}
/// emitConstantPool - This callback is invoked to output the constant pool
/// for the function.
virtual void emitConstantPool(MachineConstantPool *MCP) {}
/// startFunctionStub - This callback is invoked when the JIT needs the
/// address of a function that has not been code generated yet. The StubSize
/// specifies the total size required by the stub. Stubs are not allowed to
/// have constant pools, the can only use the other emit* methods.
///
virtual void startFunctionStub(const Function &F, unsigned StubSize) {}
/// finishFunctionStub - This callback is invoked to terminate a function
/// stub.
///
virtual void *finishFunctionStub(const Function &F) { return 0; }
/// emitByte - This callback is invoked when a byte needs to be written to the
/// output stream.
///
virtual void emitByte(unsigned char B) {}
/// emitWordAt - This callback is invoked when a word needs to be written to
/// the output stream at a different position than the current PC (for
/// instance, when performing relocations).
///
virtual void emitWordAt(unsigned W, unsigned *Ptr) {}
/// emitWord - This callback is invoked when a word needs to be written to the
/// output stream.
///
virtual void emitWord(unsigned W) = 0;
/// getGlobalValueAddress - This method is used to get the address of the
/// specified global value. In some cases, however, the address may not yet
/// be known at the point that the method is called (for example, getting the
/// address of a function which has not yet been code generated). If this is
/// the case, the function returns zero, and the callee has to be able to
/// handle the situation.
///
virtual uint64_t getGlobalValueAddress(GlobalValue *V) = 0;
virtual uint64_t getGlobalValueAddress(const std::string &Name) = 0;
// getConstantPoolEntryAddress - Return the address of the 'Index' entry in
// the constant pool that was last emitted with the 'emitConstantPool' method.
//
virtual uint64_t getConstantPoolEntryAddress(unsigned Index) = 0;
// getCurrentPCValue - This returns the address that the next emitted byte
// will be output to.
//
virtual uint64_t getCurrentPCValue() = 0;
// forceCompilationOf - Force the compilation of the specified function, and
// return its address, because we REALLY need the address now.
//
// FIXME: This is JIT specific!
//
virtual uint64_t forceCompilationOf(Function *F) = 0;
/// createDebugEmitter - Return a dynamically allocated machine
/// code emitter, which just prints the opcodes and fields out the cout. This
/// can be used for debugging users of the MachineCodeEmitter interface.
///
static MachineCodeEmitter *createDebugEmitter();
/// createFilePrinterEmitter - Return a dynamically allocated
/// machine code emitter, which prints binary code to a file. This
/// can be used for debugging users of the MachineCodeEmitter interface.
///
static MachineCodeEmitter *createFilePrinterEmitter(MachineCodeEmitter&);
};
} // End llvm namespace
#endif
|
