More code clean up.
[oota-llvm.git] / lib / Target / ARM / ARMJITInfo.h
1 //===- ARMJITInfo.h - ARM implementation of the JIT interface  --*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains the declaration of the ARMJITInfo class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef ARMJITINFO_H
15 #define ARMJITINFO_H
16
17 #include "llvm/Target/TargetJITInfo.h"
18 #include "llvm/CodeGen/MachineConstantPool.h"
19 #include "llvm/CodeGen/MachineFunction.h"
20 #include "llvm/CodeGen/MachineJumpTableInfo.h"
21 #include "llvm/ADT/DenseMap.h"
22 #include "llvm/ADT/SmallVector.h"
23
24 namespace llvm {
25   class ARMTargetMachine;
26
27   class ARMJITInfo : public TargetJITInfo {
28     ARMTargetMachine &TM;
29
30     // ConstPoolId2AddrMap - A map from constant pool ids to the corresponding
31     // CONSTPOOL_ENTRY addresses.
32     SmallVector<intptr_t, 16> ConstPoolId2AddrMap;
33
34     // JumpTableId2AddrMap - A map from inline jumptable ids to the
35     // corresponding inline jump table bases.
36     SmallVector<intptr_t, 16> JumpTableId2AddrMap;
37
38     // PCLabelMap - A map from PC labels to addresses.
39     DenseMap<unsigned, intptr_t> PCLabelMap;
40
41   public:
42     explicit ARMJITInfo(ARMTargetMachine &tm) : TM(tm) { useGOT = false; }
43
44     /// replaceMachineCodeForFunction - Make it so that calling the function
45     /// whose machine code is at OLD turns into a call to NEW, perhaps by
46     /// overwriting OLD with a branch to NEW.  This is used for self-modifying
47     /// code.
48     ///
49     virtual void replaceMachineCodeForFunction(void *Old, void *New);
50
51     /// emitFunctionStub - Use the specified MachineCodeEmitter object to emit a
52     /// small native function that simply calls the function at the specified
53     /// address.
54     virtual void *emitFunctionStub(const Function* F, void *Fn,
55                                    MachineCodeEmitter &MCE);
56
57     /// getLazyResolverFunction - Expose the lazy resolver to the JIT.
58     virtual LazyResolverFn getLazyResolverFunction(JITCompilerFn);
59
60     /// relocate - Before the JIT can run a block of code that has been emitted,
61     /// it must rewrite the code to contain the actual addresses of any
62     /// referenced global symbols.
63     virtual void relocate(void *Function, MachineRelocation *MR,
64                           unsigned NumRelocs, unsigned char* GOTBase);
65
66     /// hasCustomConstantPool - Allows a target to specify that constant
67     /// pool address resolution is handled by the target.
68     virtual bool hasCustomConstantPool() const { return true; }
69
70     /// hasCustomJumpTables - Allows a target to specify that jumptables
71     /// are emitted by the target.
72     virtual bool hasCustomJumpTables() const { return true; }
73
74     /// allocateSeparateGVMemory - If true, globals should be placed in
75     /// separately allocated heap memory rather than in the same
76     /// code memory allocated by MachineCodeEmitter.
77     virtual bool allocateSeparateGVMemory() const {
78 #ifdef __APPLE__
79       return true;
80 #else
81       return false;
82 #endif
83     }
84
85     /// Initialize - Initialize internal stage. Get the list of constant pool
86     /// Resize constant pool ids to CONSTPOOL_ENTRY addresses map.
87     void Initialize(const MachineFunction &MF) {
88       ConstPoolId2AddrMap.resize(MF.getConstantPool()->getConstants().size());
89       JumpTableId2AddrMap.resize(MF.getJumpTableInfo()->getJumpTables().size());
90     }
91
92     /// getConstantPoolEntryAddr - The ARM target puts all constant
93     /// pool entries into constant islands. This returns the address of the
94     /// constant pool entry of the specified index.
95     intptr_t getConstantPoolEntryAddr(unsigned CPI) const {
96       assert(CPI < ConstPoolId2AddrMap.size());
97       return ConstPoolId2AddrMap[CPI];
98     }
99
100     /// addConstantPoolEntryAddr - Map a Constant Pool Index to the address
101     /// where its associated value is stored. When relocations are processed,
102     /// this value will be used to resolve references to the constant.
103     void addConstantPoolEntryAddr(unsigned CPI, intptr_t Addr) {
104       assert(CPI < ConstPoolId2AddrMap.size());
105       ConstPoolId2AddrMap[CPI] = Addr;
106     }
107
108     /// getJumpTableBaseAddr - The ARM target inline all jump tables within
109     /// text section of the function. This returns the address of the base of
110     /// the jump table of the specified index.
111     intptr_t getJumpTableBaseAddr(unsigned JTI) const {
112       assert(JTI < JumpTableId2AddrMap.size());
113       return JumpTableId2AddrMap[JTI];
114     }
115
116     /// addJumpTableBaseAddr - Map a jump table index to the address where
117     /// the corresponding inline jump table is emitted. When relocations are
118     /// processed, this value will be used to resolve references to the
119     /// jump table.
120     void addJumpTableBaseAddr(unsigned JTI, intptr_t Addr) {
121       assert(JTI < JumpTableId2AddrMap.size());
122       JumpTableId2AddrMap[JTI] = Addr;
123     }
124
125     /// getPCLabelAddr - Retrieve the address of the PC label of the specified id.
126     intptr_t getPCLabelAddr(unsigned Id) const {
127       DenseMap<unsigned, intptr_t>::const_iterator I = PCLabelMap.find(Id);
128       assert(I != PCLabelMap.end());
129       return I->second;
130     }
131
132     /// addPCLabelAddr - Remember the address of the specified PC label.
133     void addPCLabelAddr(unsigned Id, intptr_t Addr) {
134       PCLabelMap.insert(std::make_pair(Id, Addr));
135     }
136
137   private:
138     /// resolveRelocDestAddr - Resolve the resulting address of the relocation
139     /// if it's not already solved. Constantpool entries must be resolved by
140     /// ARM target.
141     intptr_t resolveRelocDestAddr(MachineRelocation *MR) const;
142   };
143 }
144
145 #endif