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_LIB_IR_LLVMCONTEXTIMPL_H
16 #define LLVM_LIB_IR_LLVMCONTEXTIMPL_H
18 #include "AttributeImpl.h"
19 #include "ConstantsContext.h"
20 #include "LeaksContext.h"
21 #include "llvm/ADT/APFloat.h"
22 #include "llvm/ADT/APInt.h"
23 #include "llvm/ADT/ArrayRef.h"
24 #include "llvm/ADT/DenseMap.h"
25 #include "llvm/ADT/FoldingSet.h"
26 #include "llvm/ADT/Hashing.h"
27 #include "llvm/ADT/SmallPtrSet.h"
28 #include "llvm/ADT/StringMap.h"
29 #include "llvm/IR/Constants.h"
30 #include "llvm/IR/DerivedTypes.h"
31 #include "llvm/IR/LLVMContext.h"
32 #include "llvm/IR/Metadata.h"
33 #include "llvm/IR/ValueHandle.h"
40 class DiagnosticInfoOptimizationRemark;
41 class DiagnosticInfoOptimizationRemarkMissed;
42 class DiagnosticInfoOptimizationRemarkAnalysis;
47 struct DenseMapAPIntKeyInfo {
51 KeyTy(const APInt& V, Type* Ty) : val(V), type(Ty) {}
52 bool operator==(const KeyTy& that) const {
53 return type == that.type && this->val == that.val;
55 bool operator!=(const KeyTy& that) const {
56 return !this->operator==(that);
58 friend hash_code hash_value(const KeyTy &Key) {
59 return hash_combine(Key.type, Key.val);
62 static inline KeyTy getEmptyKey() { return KeyTy(APInt(1,0), nullptr); }
63 static inline KeyTy getTombstoneKey() { return KeyTy(APInt(1,1), nullptr); }
64 static unsigned getHashValue(const KeyTy &Key) {
65 return static_cast<unsigned>(hash_value(Key));
67 static bool isEqual(const KeyTy &LHS, const KeyTy &RHS) {
72 struct DenseMapAPFloatKeyInfo {
75 KeyTy(const APFloat& V) : val(V){}
76 bool operator==(const KeyTy& that) const {
77 return this->val.bitwiseIsEqual(that.val);
79 bool operator!=(const KeyTy& that) const {
80 return !this->operator==(that);
82 friend hash_code hash_value(const KeyTy &Key) {
83 return hash_combine(Key.val);
86 static inline KeyTy getEmptyKey() {
87 return KeyTy(APFloat(APFloat::Bogus,1));
89 static inline KeyTy getTombstoneKey() {
90 return KeyTy(APFloat(APFloat::Bogus,2));
92 static unsigned getHashValue(const KeyTy &Key) {
93 return static_cast<unsigned>(hash_value(Key));
95 static bool isEqual(const KeyTy &LHS, const KeyTy &RHS) {
100 struct AnonStructTypeKeyInfo {
102 ArrayRef<Type*> ETypes;
104 KeyTy(const ArrayRef<Type*>& E, bool P) :
105 ETypes(E), isPacked(P) {}
106 KeyTy(const StructType* ST) :
107 ETypes(ArrayRef<Type*>(ST->element_begin(), ST->element_end())),
108 isPacked(ST->isPacked()) {}
109 bool operator==(const KeyTy& that) const {
110 if (isPacked != that.isPacked)
112 if (ETypes != that.ETypes)
116 bool operator!=(const KeyTy& that) const {
117 return !this->operator==(that);
120 static inline StructType* getEmptyKey() {
121 return DenseMapInfo<StructType*>::getEmptyKey();
123 static inline StructType* getTombstoneKey() {
124 return DenseMapInfo<StructType*>::getTombstoneKey();
126 static unsigned getHashValue(const KeyTy& Key) {
127 return hash_combine(hash_combine_range(Key.ETypes.begin(),
131 static unsigned getHashValue(const StructType *ST) {
132 return getHashValue(KeyTy(ST));
134 static bool isEqual(const KeyTy& LHS, const StructType *RHS) {
135 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
137 return LHS == KeyTy(RHS);
139 static bool isEqual(const StructType *LHS, const StructType *RHS) {
144 struct FunctionTypeKeyInfo {
146 const Type *ReturnType;
147 ArrayRef<Type*> Params;
149 KeyTy(const Type* R, const ArrayRef<Type*>& P, bool V) :
150 ReturnType(R), Params(P), isVarArg(V) {}
151 KeyTy(const FunctionType* FT) :
152 ReturnType(FT->getReturnType()),
153 Params(makeArrayRef(FT->param_begin(), FT->param_end())),
154 isVarArg(FT->isVarArg()) {}
155 bool operator==(const KeyTy& that) const {
156 if (ReturnType != that.ReturnType)
158 if (isVarArg != that.isVarArg)
160 if (Params != that.Params)
164 bool operator!=(const KeyTy& that) const {
165 return !this->operator==(that);
168 static inline FunctionType* getEmptyKey() {
169 return DenseMapInfo<FunctionType*>::getEmptyKey();
171 static inline FunctionType* getTombstoneKey() {
172 return DenseMapInfo<FunctionType*>::getTombstoneKey();
174 static unsigned getHashValue(const KeyTy& Key) {
175 return hash_combine(Key.ReturnType,
176 hash_combine_range(Key.Params.begin(),
180 static unsigned getHashValue(const FunctionType *FT) {
181 return getHashValue(KeyTy(FT));
183 static bool isEqual(const KeyTy& LHS, const FunctionType *RHS) {
184 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
186 return LHS == KeyTy(RHS);
188 static bool isEqual(const FunctionType *LHS, const FunctionType *RHS) {
193 // Provide a FoldingSetTrait::Equals specialization for MDNode that can use a
194 // shortcut to avoid comparing all operands.
195 template<> struct FoldingSetTrait<MDNode> : DefaultFoldingSetTrait<MDNode> {
196 static bool Equals(const MDNode &X, const FoldingSetNodeID &ID,
197 unsigned IDHash, FoldingSetNodeID &TempID) {
198 assert(!X.isNotUniqued() && "Non-uniqued MDNode in FoldingSet?");
199 // First, check if the cached hashes match. If they don't we can skip the
200 // expensive operand walk.
201 if (X.Hash != IDHash)
204 // If they match we have to compare the operands.
208 static unsigned ComputeHash(const MDNode &X, FoldingSetNodeID &) {
209 return X.Hash; // Return cached hash.
213 /// DebugRecVH - This is a CallbackVH used to keep the Scope -> index maps
214 /// up to date as MDNodes mutate. This class is implemented in DebugLoc.cpp.
215 class DebugRecVH : public CallbackVH {
216 /// Ctx - This is the LLVM Context being referenced.
217 LLVMContextImpl *Ctx;
219 /// Idx - The index into either ScopeRecordIdx or ScopeInlinedAtRecords that
220 /// this reference lives in. If this is zero, then it represents a
221 /// non-canonical entry that has no DenseMap value. This can happen due to
225 DebugRecVH(MDNode *n, LLVMContextImpl *ctx, int idx)
226 : CallbackVH(n), Ctx(ctx), Idx(idx) {}
228 MDNode *get() const {
229 return cast_or_null<MDNode>(getValPtr());
232 void deleted() override;
233 void allUsesReplacedWith(Value *VNew) override;
236 class LLVMContextImpl {
238 /// OwnedModules - The set of modules instantiated in this context, and which
239 /// will be automatically deleted if this context is deleted.
240 SmallPtrSet<Module*, 4> OwnedModules;
242 LLVMContext::InlineAsmDiagHandlerTy InlineAsmDiagHandler;
243 void *InlineAsmDiagContext;
245 LLVMContext::DiagnosticHandlerTy DiagnosticHandler;
246 void *DiagnosticContext;
248 LLVMContext::YieldCallbackTy YieldCallback;
249 void *YieldOpaqueHandle;
251 typedef DenseMap<DenseMapAPIntKeyInfo::KeyTy, ConstantInt *,
252 DenseMapAPIntKeyInfo> IntMapTy;
253 IntMapTy IntConstants;
255 typedef DenseMap<DenseMapAPFloatKeyInfo::KeyTy, ConstantFP*,
256 DenseMapAPFloatKeyInfo> FPMapTy;
259 FoldingSet<AttributeImpl> AttrsSet;
260 FoldingSet<AttributeSetImpl> AttrsLists;
261 FoldingSet<AttributeSetNode> AttrsSetNodes;
263 StringMap<Value*> MDStringCache;
265 FoldingSet<MDNode> MDNodeSet;
267 // MDNodes may be uniqued or not uniqued. When they're not uniqued, they
268 // aren't in the MDNodeSet, but they're still shared between objects, so no
269 // one object can destroy them. This set allows us to at least destroy them
270 // on Context destruction.
271 SmallPtrSet<MDNode*, 1> NonUniquedMDNodes;
273 DenseMap<Type*, ConstantAggregateZero*> CAZConstants;
275 typedef ConstantUniqueMap<ConstantArray> ArrayConstantsTy;
276 ArrayConstantsTy ArrayConstants;
278 typedef ConstantUniqueMap<ConstantStruct> StructConstantsTy;
279 StructConstantsTy StructConstants;
281 typedef ConstantUniqueMap<ConstantVector> VectorConstantsTy;
282 VectorConstantsTy VectorConstants;
284 DenseMap<PointerType*, ConstantPointerNull*> CPNConstants;
286 DenseMap<Type*, UndefValue*> UVConstants;
288 StringMap<ConstantDataSequential*> CDSConstants;
290 DenseMap<std::pair<const Function *, const BasicBlock *>, BlockAddress *>
292 ConstantUniqueMap<ConstantExpr> ExprConstants;
294 ConstantUniqueMap<InlineAsm> InlineAsms;
296 ConstantInt *TheTrueVal;
297 ConstantInt *TheFalseVal;
299 LeakDetectorImpl<Value> LLVMObjects;
301 // Basic type instances.
302 Type VoidTy, LabelTy, HalfTy, FloatTy, DoubleTy, MetadataTy;
303 Type X86_FP80Ty, FP128Ty, PPC_FP128Ty, X86_MMXTy;
304 IntegerType Int1Ty, Int8Ty, Int16Ty, Int32Ty, Int64Ty;
307 /// TypeAllocator - All dynamically allocated types are allocated from this.
308 /// They live forever until the context is torn down.
309 BumpPtrAllocator TypeAllocator;
311 DenseMap<unsigned, IntegerType*> IntegerTypes;
313 typedef DenseMap<FunctionType*, bool, FunctionTypeKeyInfo> FunctionTypeMap;
314 FunctionTypeMap FunctionTypes;
315 typedef DenseMap<StructType*, bool, AnonStructTypeKeyInfo> StructTypeMap;
316 StructTypeMap AnonStructTypes;
317 StringMap<StructType*> NamedStructTypes;
318 unsigned NamedStructTypesUniqueID;
320 DenseMap<std::pair<Type *, uint64_t>, ArrayType*> ArrayTypes;
321 DenseMap<std::pair<Type *, unsigned>, VectorType*> VectorTypes;
322 DenseMap<Type*, PointerType*> PointerTypes; // Pointers in AddrSpace = 0
323 DenseMap<std::pair<Type*, unsigned>, PointerType*> ASPointerTypes;
326 /// ValueHandles - This map keeps track of all of the value handles that are
327 /// watching a Value*. The Value::HasValueHandle bit is used to know
328 /// whether or not a value has an entry in this map.
329 typedef DenseMap<Value*, ValueHandleBase*> ValueHandlesTy;
330 ValueHandlesTy ValueHandles;
332 /// CustomMDKindNames - Map to hold the metadata string to ID mapping.
333 StringMap<unsigned> CustomMDKindNames;
335 typedef std::pair<unsigned, TrackingVH<MDNode> > MDPairTy;
336 typedef SmallVector<MDPairTy, 2> MDMapTy;
338 /// MetadataStore - Collection of per-instruction metadata used in this
340 DenseMap<const Instruction *, MDMapTy> MetadataStore;
342 /// ScopeRecordIdx - This is the index in ScopeRecords for an MDNode scope
343 /// entry with no "inlined at" element.
344 DenseMap<MDNode*, int> ScopeRecordIdx;
346 /// ScopeRecords - These are the actual mdnodes (in a value handle) for an
347 /// index. The ValueHandle ensures that ScopeRecordIdx stays up to date if
348 /// the MDNode is RAUW'd.
349 std::vector<DebugRecVH> ScopeRecords;
351 /// ScopeInlinedAtIdx - This is the index in ScopeInlinedAtRecords for an
352 /// scope/inlined-at pair.
353 DenseMap<std::pair<MDNode*, MDNode*>, int> ScopeInlinedAtIdx;
355 /// ScopeInlinedAtRecords - These are the actual mdnodes (in value handles)
356 /// for an index. The ValueHandle ensures that ScopeINlinedAtIdx stays up
358 std::vector<std::pair<DebugRecVH, DebugRecVH> > ScopeInlinedAtRecords;
360 /// DiscriminatorTable - This table maps file:line locations to an
361 /// integer representing the next DWARF path discriminator to assign to
362 /// instructions in different blocks at the same location.
363 DenseMap<std::pair<const char *, unsigned>, unsigned> DiscriminatorTable;
365 /// IntrinsicIDCache - Cache of intrinsic name (string) to numeric ID mappings
366 /// requested in this context
367 typedef DenseMap<const Function*, unsigned> IntrinsicIDCacheTy;
368 IntrinsicIDCacheTy IntrinsicIDCache;
370 /// \brief Mapping from a function to its prefix data, which is stored as the
371 /// operand of an unparented ReturnInst so that the prefix data has a Use.
372 typedef DenseMap<const Function *, ReturnInst *> PrefixDataMapTy;
373 PrefixDataMapTy PrefixDataMap;
375 int getOrAddScopeRecordIdxEntry(MDNode *N, int ExistingIdx);
376 int getOrAddScopeInlinedAtIdxEntry(MDNode *Scope, MDNode *IA,int ExistingIdx);
378 LLVMContextImpl(LLVMContext &C);