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/DenseSet.h"
26 #include "llvm/ADT/FoldingSet.h"
27 #include "llvm/ADT/Hashing.h"
28 #include "llvm/ADT/SmallPtrSet.h"
29 #include "llvm/ADT/StringMap.h"
30 #include "llvm/IR/Constants.h"
31 #include "llvm/IR/DerivedTypes.h"
32 #include "llvm/IR/LLVMContext.h"
33 #include "llvm/IR/Metadata.h"
34 #include "llvm/IR/ValueHandle.h"
41 class DiagnosticInfoOptimizationRemark;
42 class DiagnosticInfoOptimizationRemarkMissed;
43 class DiagnosticInfoOptimizationRemarkAnalysis;
48 struct DenseMapAPIntKeyInfo {
52 KeyTy(const APInt& V, Type* Ty) : val(V), type(Ty) {}
53 bool operator==(const KeyTy& that) const {
54 return type == that.type && this->val == that.val;
56 bool operator!=(const KeyTy& that) const {
57 return !this->operator==(that);
59 friend hash_code hash_value(const KeyTy &Key) {
60 return hash_combine(Key.type, Key.val);
63 static inline KeyTy getEmptyKey() { return KeyTy(APInt(1,0), nullptr); }
64 static inline KeyTy getTombstoneKey() { return KeyTy(APInt(1,1), nullptr); }
65 static unsigned getHashValue(const KeyTy &Key) {
66 return static_cast<unsigned>(hash_value(Key));
68 static bool isEqual(const KeyTy &LHS, const KeyTy &RHS) {
73 struct DenseMapAPFloatKeyInfo {
76 KeyTy(const APFloat& V) : val(V){}
77 bool operator==(const KeyTy& that) const {
78 return this->val.bitwiseIsEqual(that.val);
80 bool operator!=(const KeyTy& that) const {
81 return !this->operator==(that);
83 friend hash_code hash_value(const KeyTy &Key) {
84 return hash_combine(Key.val);
87 static inline KeyTy getEmptyKey() {
88 return KeyTy(APFloat(APFloat::Bogus,1));
90 static inline KeyTy getTombstoneKey() {
91 return KeyTy(APFloat(APFloat::Bogus,2));
93 static unsigned getHashValue(const KeyTy &Key) {
94 return static_cast<unsigned>(hash_value(Key));
96 static bool isEqual(const KeyTy &LHS, const KeyTy &RHS) {
101 struct AnonStructTypeKeyInfo {
103 ArrayRef<Type*> ETypes;
105 KeyTy(const ArrayRef<Type*>& E, bool P) :
106 ETypes(E), isPacked(P) {}
107 KeyTy(const StructType* ST) :
108 ETypes(ArrayRef<Type*>(ST->element_begin(), ST->element_end())),
109 isPacked(ST->isPacked()) {}
110 bool operator==(const KeyTy& that) const {
111 if (isPacked != that.isPacked)
113 if (ETypes != that.ETypes)
117 bool operator!=(const KeyTy& that) const {
118 return !this->operator==(that);
121 static inline StructType* getEmptyKey() {
122 return DenseMapInfo<StructType*>::getEmptyKey();
124 static inline StructType* getTombstoneKey() {
125 return DenseMapInfo<StructType*>::getTombstoneKey();
127 static unsigned getHashValue(const KeyTy& Key) {
128 return hash_combine(hash_combine_range(Key.ETypes.begin(),
132 static unsigned getHashValue(const StructType *ST) {
133 return getHashValue(KeyTy(ST));
135 static bool isEqual(const KeyTy& LHS, const StructType *RHS) {
136 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
138 return LHS == KeyTy(RHS);
140 static bool isEqual(const StructType *LHS, const StructType *RHS) {
145 struct FunctionTypeKeyInfo {
147 const Type *ReturnType;
148 ArrayRef<Type*> Params;
150 KeyTy(const Type* R, const ArrayRef<Type*>& P, bool V) :
151 ReturnType(R), Params(P), isVarArg(V) {}
152 KeyTy(const FunctionType* FT) :
153 ReturnType(FT->getReturnType()),
154 Params(makeArrayRef(FT->param_begin(), FT->param_end())),
155 isVarArg(FT->isVarArg()) {}
156 bool operator==(const KeyTy& that) const {
157 if (ReturnType != that.ReturnType)
159 if (isVarArg != that.isVarArg)
161 if (Params != that.Params)
165 bool operator!=(const KeyTy& that) const {
166 return !this->operator==(that);
169 static inline FunctionType* getEmptyKey() {
170 return DenseMapInfo<FunctionType*>::getEmptyKey();
172 static inline FunctionType* getTombstoneKey() {
173 return DenseMapInfo<FunctionType*>::getTombstoneKey();
175 static unsigned getHashValue(const KeyTy& Key) {
176 return hash_combine(Key.ReturnType,
177 hash_combine_range(Key.Params.begin(),
181 static unsigned getHashValue(const FunctionType *FT) {
182 return getHashValue(KeyTy(FT));
184 static bool isEqual(const KeyTy& LHS, const FunctionType *RHS) {
185 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
187 return LHS == KeyTy(RHS);
189 static bool isEqual(const FunctionType *LHS, const FunctionType *RHS) {
194 /// \brief DenseMapInfo for GenericMDNode.
196 /// Note that we don't need the is-function-local bit, since that's implicit in
198 struct GenericMDNodeInfo {
200 ArrayRef<Value *> Ops;
203 KeyTy(ArrayRef<Value *> Ops)
204 : Ops(Ops), Hash(hash_combine_range(Ops.begin(), Ops.end())) {}
206 KeyTy(GenericMDNode *N, SmallVectorImpl<Value *> &Storage) {
207 Storage.resize(N->getNumOperands());
208 for (unsigned I = 0, E = N->getNumOperands(); I != E; ++I)
209 Storage[I] = N->getOperand(I);
211 Hash = hash_combine_range(Ops.begin(), Ops.end());
214 bool operator==(const GenericMDNode *RHS) const {
215 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
217 if (Hash != RHS->getHash() || Ops.size() != RHS->getNumOperands())
219 for (unsigned I = 0, E = Ops.size(); I != E; ++I)
220 if (Ops[I] != RHS->getOperand(I))
225 static inline GenericMDNode *getEmptyKey() {
226 return DenseMapInfo<GenericMDNode *>::getEmptyKey();
228 static inline GenericMDNode *getTombstoneKey() {
229 return DenseMapInfo<GenericMDNode *>::getTombstoneKey();
231 static unsigned getHashValue(const KeyTy &Key) { return Key.Hash; }
232 static unsigned getHashValue(const GenericMDNode *U) {
235 static bool isEqual(const KeyTy &LHS, const GenericMDNode *RHS) {
238 static bool isEqual(const GenericMDNode *LHS, const GenericMDNode *RHS) {
243 /// DebugRecVH - This is a CallbackVH used to keep the Scope -> index maps
244 /// up to date as MDNodes mutate. This class is implemented in DebugLoc.cpp.
245 class DebugRecVH : public CallbackVH {
246 /// Ctx - This is the LLVM Context being referenced.
247 LLVMContextImpl *Ctx;
249 /// Idx - The index into either ScopeRecordIdx or ScopeInlinedAtRecords that
250 /// this reference lives in. If this is zero, then it represents a
251 /// non-canonical entry that has no DenseMap value. This can happen due to
255 DebugRecVH(MDNode *n, LLVMContextImpl *ctx, int idx)
256 : CallbackVH(n), Ctx(ctx), Idx(idx) {}
258 MDNode *get() const {
259 return cast_or_null<MDNode>(getValPtr());
262 void deleted() override;
263 void allUsesReplacedWith(Value *VNew) override;
266 class LLVMContextImpl {
268 /// OwnedModules - The set of modules instantiated in this context, and which
269 /// will be automatically deleted if this context is deleted.
270 SmallPtrSet<Module*, 4> OwnedModules;
272 LLVMContext::InlineAsmDiagHandlerTy InlineAsmDiagHandler;
273 void *InlineAsmDiagContext;
275 LLVMContext::DiagnosticHandlerTy DiagnosticHandler;
276 void *DiagnosticContext;
277 bool RespectDiagnosticFilters;
279 LLVMContext::YieldCallbackTy YieldCallback;
280 void *YieldOpaqueHandle;
282 typedef DenseMap<DenseMapAPIntKeyInfo::KeyTy, ConstantInt *,
283 DenseMapAPIntKeyInfo> IntMapTy;
284 IntMapTy IntConstants;
286 typedef DenseMap<DenseMapAPFloatKeyInfo::KeyTy, ConstantFP*,
287 DenseMapAPFloatKeyInfo> FPMapTy;
290 FoldingSet<AttributeImpl> AttrsSet;
291 FoldingSet<AttributeSetImpl> AttrsLists;
292 FoldingSet<AttributeSetNode> AttrsSetNodes;
294 StringMap<MDString> MDStringCache;
296 DenseSet<GenericMDNode *, GenericMDNodeInfo> MDNodeSet;
298 // MDNodes may be uniqued or not uniqued. When they're not uniqued, they
299 // aren't in the MDNodeSet, but they're still shared between objects, so no
300 // one object can destroy them. This set allows us to at least destroy them
301 // on Context destruction.
302 SmallPtrSet<GenericMDNode *, 1> NonUniquedMDNodes;
304 DenseMap<Type*, ConstantAggregateZero*> CAZConstants;
306 typedef ConstantUniqueMap<ConstantArray> ArrayConstantsTy;
307 ArrayConstantsTy ArrayConstants;
309 typedef ConstantUniqueMap<ConstantStruct> StructConstantsTy;
310 StructConstantsTy StructConstants;
312 typedef ConstantUniqueMap<ConstantVector> VectorConstantsTy;
313 VectorConstantsTy VectorConstants;
315 DenseMap<PointerType*, ConstantPointerNull*> CPNConstants;
317 DenseMap<Type*, UndefValue*> UVConstants;
319 StringMap<ConstantDataSequential*> CDSConstants;
321 DenseMap<std::pair<const Function *, const BasicBlock *>, BlockAddress *>
323 ConstantUniqueMap<ConstantExpr> ExprConstants;
325 ConstantUniqueMap<InlineAsm> InlineAsms;
327 ConstantInt *TheTrueVal;
328 ConstantInt *TheFalseVal;
330 LeakDetectorImpl<Value> LLVMObjects;
332 // Basic type instances.
333 Type VoidTy, LabelTy, HalfTy, FloatTy, DoubleTy, MetadataTy;
334 Type X86_FP80Ty, FP128Ty, PPC_FP128Ty, X86_MMXTy;
335 IntegerType Int1Ty, Int8Ty, Int16Ty, Int32Ty, Int64Ty;
338 /// TypeAllocator - All dynamically allocated types are allocated from this.
339 /// They live forever until the context is torn down.
340 BumpPtrAllocator TypeAllocator;
342 DenseMap<unsigned, IntegerType*> IntegerTypes;
344 typedef DenseMap<FunctionType*, bool, FunctionTypeKeyInfo> FunctionTypeMap;
345 FunctionTypeMap FunctionTypes;
346 typedef DenseMap<StructType*, bool, AnonStructTypeKeyInfo> StructTypeMap;
347 StructTypeMap AnonStructTypes;
348 StringMap<StructType*> NamedStructTypes;
349 unsigned NamedStructTypesUniqueID;
351 DenseMap<std::pair<Type *, uint64_t>, ArrayType*> ArrayTypes;
352 DenseMap<std::pair<Type *, unsigned>, VectorType*> VectorTypes;
353 DenseMap<Type*, PointerType*> PointerTypes; // Pointers in AddrSpace = 0
354 DenseMap<std::pair<Type*, unsigned>, PointerType*> ASPointerTypes;
357 /// ValueHandles - This map keeps track of all of the value handles that are
358 /// watching a Value*. The Value::HasValueHandle bit is used to know
359 /// whether or not a value has an entry in this map.
360 typedef DenseMap<Value*, ValueHandleBase*> ValueHandlesTy;
361 ValueHandlesTy ValueHandles;
363 /// CustomMDKindNames - Map to hold the metadata string to ID mapping.
364 StringMap<unsigned> CustomMDKindNames;
366 typedef std::pair<unsigned, TrackingVH<MDNode> > MDPairTy;
367 typedef SmallVector<MDPairTy, 2> MDMapTy;
369 /// MetadataStore - Collection of per-instruction metadata used in this
371 DenseMap<const Instruction *, MDMapTy> MetadataStore;
373 /// ScopeRecordIdx - This is the index in ScopeRecords for an MDNode scope
374 /// entry with no "inlined at" element.
375 DenseMap<MDNode*, int> ScopeRecordIdx;
377 /// ScopeRecords - These are the actual mdnodes (in a value handle) for an
378 /// index. The ValueHandle ensures that ScopeRecordIdx stays up to date if
379 /// the MDNode is RAUW'd.
380 std::vector<DebugRecVH> ScopeRecords;
382 /// ScopeInlinedAtIdx - This is the index in ScopeInlinedAtRecords for an
383 /// scope/inlined-at pair.
384 DenseMap<std::pair<MDNode*, MDNode*>, int> ScopeInlinedAtIdx;
386 /// ScopeInlinedAtRecords - These are the actual mdnodes (in value handles)
387 /// for an index. The ValueHandle ensures that ScopeINlinedAtIdx stays up
389 std::vector<std::pair<DebugRecVH, DebugRecVH> > ScopeInlinedAtRecords;
391 /// DiscriminatorTable - This table maps file:line locations to an
392 /// integer representing the next DWARF path discriminator to assign to
393 /// instructions in different blocks at the same location.
394 DenseMap<std::pair<const char *, unsigned>, unsigned> DiscriminatorTable;
396 /// IntrinsicIDCache - Cache of intrinsic name (string) to numeric ID mappings
397 /// requested in this context
398 typedef DenseMap<const Function*, unsigned> IntrinsicIDCacheTy;
399 IntrinsicIDCacheTy IntrinsicIDCache;
401 /// \brief Mapping from a function to its prefix data, which is stored as the
402 /// operand of an unparented ReturnInst so that the prefix data has a Use.
403 typedef DenseMap<const Function *, ReturnInst *> PrefixDataMapTy;
404 PrefixDataMapTy PrefixDataMap;
406 int getOrAddScopeRecordIdxEntry(MDNode *N, int ExistingIdx);
407 int getOrAddScopeInlinedAtIdxEntry(MDNode *Scope, MDNode *IA,int ExistingIdx);
409 LLVMContextImpl(LLVMContext &C);