1 //===-- LLVMContextImpl.h - The LLVMContextImpl opaque class ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares LLVMContextImpl, the opaque implementation
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_LLVMCONTEXT_IMPL_H
16 #define LLVM_LLVMCONTEXT_IMPL_H
18 #include "ConstantsContext.h"
19 #include "LeaksContext.h"
20 #include "TypesContext.h"
21 #include "llvm/LLVMContext.h"
22 #include "llvm/Constants.h"
23 #include "llvm/DerivedTypes.h"
24 #include "llvm/Metadata.h"
25 #include "llvm/Support/ValueHandle.h"
26 #include "llvm/ADT/APFloat.h"
27 #include "llvm/ADT/APInt.h"
28 #include "llvm/ADT/DenseMap.h"
29 #include "llvm/ADT/FoldingSet.h"
30 #include "llvm/ADT/SmallPtrSet.h"
31 #include "llvm/ADT/StringMap.h"
42 struct DenseMapAPIntKeyInfo {
46 KeyTy(const APInt& V, const Type* Ty) : val(V), type(Ty) {}
47 KeyTy(const KeyTy& that) : val(that.val), type(that.type) {}
48 bool operator==(const KeyTy& that) const {
49 return type == that.type && this->val == that.val;
51 bool operator!=(const KeyTy& that) const {
52 return !this->operator==(that);
55 static inline KeyTy getEmptyKey() { return KeyTy(APInt(1,0), 0); }
56 static inline KeyTy getTombstoneKey() { return KeyTy(APInt(1,1), 0); }
57 static unsigned getHashValue(const KeyTy &Key) {
58 return DenseMapInfo<void*>::getHashValue(Key.type) ^
59 Key.val.getHashValue();
61 static bool isEqual(const KeyTy &LHS, const KeyTy &RHS) {
66 struct DenseMapAPFloatKeyInfo {
69 KeyTy(const APFloat& V) : val(V){}
70 KeyTy(const KeyTy& that) : val(that.val) {}
71 bool operator==(const KeyTy& that) const {
72 return this->val.bitwiseIsEqual(that.val);
74 bool operator!=(const KeyTy& that) const {
75 return !this->operator==(that);
78 static inline KeyTy getEmptyKey() {
79 return KeyTy(APFloat(APFloat::Bogus,1));
81 static inline KeyTy getTombstoneKey() {
82 return KeyTy(APFloat(APFloat::Bogus,2));
84 static unsigned getHashValue(const KeyTy &Key) {
85 return Key.val.getHashValue();
87 static bool isEqual(const KeyTy &LHS, const KeyTy &RHS) {
92 /// DebugRecVH - This is a CallbackVH used to keep the Scope -> index maps
93 /// up to date as MDNodes mutate. This class is implemented in DebugLoc.cpp.
94 class DebugRecVH : public CallbackVH {
95 /// Ctx - This is the LLVM Context being referenced.
98 /// Idx - The index into either ScopeRecordIdx or ScopeInlinedAtRecords that
99 /// this reference lives in. If this is zero, then it represents a
100 /// non-canonical entry that has no DenseMap value. This can happen due to
104 DebugRecVH(MDNode *n, LLVMContextImpl *ctx, int idx)
105 : CallbackVH(n), Ctx(ctx), Idx(idx) {}
107 MDNode *get() const {
108 return cast_or_null<MDNode>(getValPtr());
111 virtual void deleted();
112 virtual void allUsesReplacedWith(Value *VNew);
115 class LLVMContextImpl {
117 /// OwnedModules - The set of modules instantiated in this context, and which
118 /// will be automatically deleted if this context is deleted.
119 SmallPtrSet<Module*, 4> OwnedModules;
121 LLVMContext::InlineAsmDiagHandlerTy InlineAsmDiagHandler;
122 void *InlineAsmDiagContext;
124 typedef DenseMap<DenseMapAPIntKeyInfo::KeyTy, ConstantInt*,
125 DenseMapAPIntKeyInfo> IntMapTy;
126 IntMapTy IntConstants;
128 typedef DenseMap<DenseMapAPFloatKeyInfo::KeyTy, ConstantFP*,
129 DenseMapAPFloatKeyInfo> FPMapTy;
132 StringMap<MDString*> MDStringCache;
134 FoldingSet<MDNode> MDNodeSet;
135 // MDNodes may be uniqued or not uniqued. When they're not uniqued, they
136 // aren't in the MDNodeSet, but they're still shared between objects, so no
137 // one object can destroy them. This set allows us to at least destroy them
138 // on Context destruction.
139 SmallPtrSet<MDNode*, 1> NonUniquedMDNodes;
141 ConstantUniqueMap<char, Type, ConstantAggregateZero> AggZeroConstants;
143 typedef ConstantUniqueMap<std::vector<Constant*>, ArrayType,
144 ConstantArray, true /*largekey*/> ArrayConstantsTy;
145 ArrayConstantsTy ArrayConstants;
147 typedef ConstantUniqueMap<std::vector<Constant*>, StructType,
148 ConstantStruct, true /*largekey*/> StructConstantsTy;
149 StructConstantsTy StructConstants;
151 typedef ConstantUniqueMap<std::vector<Constant*>, VectorType,
152 ConstantVector> VectorConstantsTy;
153 VectorConstantsTy VectorConstants;
155 ConstantUniqueMap<char, PointerType, ConstantPointerNull> NullPtrConstants;
156 ConstantUniqueMap<char, Type, UndefValue> UndefValueConstants;
158 DenseMap<std::pair<Function*, BasicBlock*> , BlockAddress*> BlockAddresses;
159 ConstantUniqueMap<ExprMapKeyType, Type, ConstantExpr> ExprConstants;
161 ConstantUniqueMap<InlineAsmKeyType, PointerType, InlineAsm> InlineAsms;
163 ConstantInt *TheTrueVal;
164 ConstantInt *TheFalseVal;
166 LeakDetectorImpl<Value> LLVMObjects;
168 // Basic type instances.
173 const Type MetadataTy;
174 const Type X86_FP80Ty;
176 const Type PPC_FP128Ty;
177 const Type X86_MMXTy;
178 const IntegerType Int1Ty;
179 const IntegerType Int8Ty;
180 const IntegerType Int16Ty;
181 const IntegerType Int32Ty;
182 const IntegerType Int64Ty;
184 TypeMap<ArrayValType, ArrayType> ArrayTypes;
185 TypeMap<VectorValType, VectorType> VectorTypes;
186 TypeMap<PointerValType, PointerType> PointerTypes;
187 TypeMap<FunctionValType, FunctionType> FunctionTypes;
188 TypeMap<StructValType, StructType> StructTypes;
189 TypeMap<IntegerValType, IntegerType> IntegerTypes;
191 // Opaque types are not structurally uniqued, so don't use TypeMap.
192 typedef SmallPtrSet<const OpaqueType*, 8> OpaqueTypesTy;
193 OpaqueTypesTy OpaqueTypes;
195 /// Used as an abstract type that will never be resolved.
196 OpaqueType *const AlwaysOpaqueTy;
199 /// ValueHandles - This map keeps track of all of the value handles that are
200 /// watching a Value*. The Value::HasValueHandle bit is used to know
201 // whether or not a value has an entry in this map.
202 typedef DenseMap<Value*, ValueHandleBase*> ValueHandlesTy;
203 ValueHandlesTy ValueHandles;
205 /// CustomMDKindNames - Map to hold the metadata string to ID mapping.
206 StringMap<unsigned> CustomMDKindNames;
208 typedef std::pair<unsigned, TrackingVH<MDNode> > MDPairTy;
209 typedef SmallVector<MDPairTy, 2> MDMapTy;
211 /// MetadataStore - Collection of per-instruction metadata used in this
213 DenseMap<const Instruction *, MDMapTy> MetadataStore;
215 /// ScopeRecordIdx - This is the index in ScopeRecords for an MDNode scope
216 /// entry with no "inlined at" element.
217 DenseMap<MDNode*, int> ScopeRecordIdx;
219 /// ScopeRecords - These are the actual mdnodes (in a value handle) for an
220 /// index. The ValueHandle ensures that ScopeRecordIdx stays up to date if
221 /// the MDNode is RAUW'd.
222 std::vector<DebugRecVH> ScopeRecords;
224 /// ScopeInlinedAtIdx - This is the index in ScopeInlinedAtRecords for an
225 /// scope/inlined-at pair.
226 DenseMap<std::pair<MDNode*, MDNode*>, int> ScopeInlinedAtIdx;
228 /// ScopeInlinedAtRecords - These are the actual mdnodes (in value handles)
229 /// for an index. The ValueHandle ensures that ScopeINlinedAtIdx stays up
231 std::vector<std::pair<DebugRecVH, DebugRecVH> > ScopeInlinedAtRecords;
233 int getOrAddScopeRecordIdxEntry(MDNode *N, int ExistingIdx);
234 int getOrAddScopeInlinedAtIdxEntry(MDNode *Scope, MDNode *IA,int ExistingIdx);
236 LLVMContextImpl(LLVMContext &C);