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(ST->elements()), 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()), Params(FT->params()),
153 isVarArg(FT->isVarArg()) {}
154 bool operator==(const KeyTy& that) const {
155 if (ReturnType != that.ReturnType)
157 if (isVarArg != that.isVarArg)
159 if (Params != that.Params)
163 bool operator!=(const KeyTy& that) const {
164 return !this->operator==(that);
167 static inline FunctionType* getEmptyKey() {
168 return DenseMapInfo<FunctionType*>::getEmptyKey();
170 static inline FunctionType* getTombstoneKey() {
171 return DenseMapInfo<FunctionType*>::getTombstoneKey();
173 static unsigned getHashValue(const KeyTy& Key) {
174 return hash_combine(Key.ReturnType,
175 hash_combine_range(Key.Params.begin(),
179 static unsigned getHashValue(const FunctionType *FT) {
180 return getHashValue(KeyTy(FT));
182 static bool isEqual(const KeyTy& LHS, const FunctionType *RHS) {
183 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
185 return LHS == KeyTy(RHS);
187 static bool isEqual(const FunctionType *LHS, const FunctionType *RHS) {
192 /// \brief DenseMapInfo for GenericMDNode.
194 /// Note that we don't need the is-function-local bit, since that's implicit in
196 struct GenericMDNodeInfo {
198 ArrayRef<Value *> Ops;
201 KeyTy(ArrayRef<Value *> Ops)
202 : Ops(Ops), Hash(hash_combine_range(Ops.begin(), Ops.end())) {}
204 KeyTy(GenericMDNode *N, SmallVectorImpl<Value *> &Storage) {
205 Storage.resize(N->getNumOperands());
206 for (unsigned I = 0, E = N->getNumOperands(); I != E; ++I)
207 Storage[I] = N->getOperand(I);
209 Hash = hash_combine_range(Ops.begin(), Ops.end());
212 bool operator==(const GenericMDNode *RHS) const {
213 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
215 if (Hash != RHS->getHash() || Ops.size() != RHS->getNumOperands())
217 for (unsigned I = 0, E = Ops.size(); I != E; ++I)
218 if (Ops[I] != RHS->getOperand(I))
223 static inline GenericMDNode *getEmptyKey() {
224 return DenseMapInfo<GenericMDNode *>::getEmptyKey();
226 static inline GenericMDNode *getTombstoneKey() {
227 return DenseMapInfo<GenericMDNode *>::getTombstoneKey();
229 static unsigned getHashValue(const KeyTy &Key) { return Key.Hash; }
230 static unsigned getHashValue(const GenericMDNode *U) {
233 static bool isEqual(const KeyTy &LHS, const GenericMDNode *RHS) {
236 static bool isEqual(const GenericMDNode *LHS, const GenericMDNode *RHS) {
241 /// DebugRecVH - This is a CallbackVH used to keep the Scope -> index maps
242 /// up to date as MDNodes mutate. This class is implemented in DebugLoc.cpp.
243 class DebugRecVH : public CallbackVH {
244 /// Ctx - This is the LLVM Context being referenced.
245 LLVMContextImpl *Ctx;
247 /// Idx - The index into either ScopeRecordIdx or ScopeInlinedAtRecords that
248 /// this reference lives in. If this is zero, then it represents a
249 /// non-canonical entry that has no DenseMap value. This can happen due to
253 DebugRecVH(MDNode *n, LLVMContextImpl *ctx, int idx)
254 : CallbackVH(n), Ctx(ctx), Idx(idx) {}
256 MDNode *get() const {
257 return cast_or_null<MDNode>(getValPtr());
260 void deleted() override;
261 void allUsesReplacedWith(Value *VNew) override;
264 class LLVMContextImpl {
266 /// OwnedModules - The set of modules instantiated in this context, and which
267 /// will be automatically deleted if this context is deleted.
268 SmallPtrSet<Module*, 4> OwnedModules;
270 LLVMContext::InlineAsmDiagHandlerTy InlineAsmDiagHandler;
271 void *InlineAsmDiagContext;
273 LLVMContext::DiagnosticHandlerTy DiagnosticHandler;
274 void *DiagnosticContext;
275 bool RespectDiagnosticFilters;
277 LLVMContext::YieldCallbackTy YieldCallback;
278 void *YieldOpaqueHandle;
280 typedef DenseMap<DenseMapAPIntKeyInfo::KeyTy, ConstantInt *,
281 DenseMapAPIntKeyInfo> IntMapTy;
282 IntMapTy IntConstants;
284 typedef DenseMap<DenseMapAPFloatKeyInfo::KeyTy, ConstantFP*,
285 DenseMapAPFloatKeyInfo> FPMapTy;
288 FoldingSet<AttributeImpl> AttrsSet;
289 FoldingSet<AttributeSetImpl> AttrsLists;
290 FoldingSet<AttributeSetNode> AttrsSetNodes;
292 StringMap<MDString> MDStringCache;
294 DenseSet<GenericMDNode *, GenericMDNodeInfo> MDNodeSet;
296 // MDNodes may be uniqued or not uniqued. When they're not uniqued, they
297 // aren't in the MDNodeSet, but they're still shared between objects, so no
298 // one object can destroy them. This set allows us to at least destroy them
299 // on Context destruction.
300 SmallPtrSet<GenericMDNode *, 1> NonUniquedMDNodes;
302 DenseMap<Type*, ConstantAggregateZero*> CAZConstants;
304 typedef ConstantUniqueMap<ConstantArray> ArrayConstantsTy;
305 ArrayConstantsTy ArrayConstants;
307 typedef ConstantUniqueMap<ConstantStruct> StructConstantsTy;
308 StructConstantsTy StructConstants;
310 typedef ConstantUniqueMap<ConstantVector> VectorConstantsTy;
311 VectorConstantsTy VectorConstants;
313 DenseMap<PointerType*, ConstantPointerNull*> CPNConstants;
315 DenseMap<Type*, UndefValue*> UVConstants;
317 StringMap<ConstantDataSequential*> CDSConstants;
319 DenseMap<std::pair<const Function *, const BasicBlock *>, BlockAddress *>
321 ConstantUniqueMap<ConstantExpr> ExprConstants;
323 ConstantUniqueMap<InlineAsm> InlineAsms;
325 ConstantInt *TheTrueVal;
326 ConstantInt *TheFalseVal;
328 LeakDetectorImpl<Value> LLVMObjects;
330 // Basic type instances.
331 Type VoidTy, LabelTy, HalfTy, FloatTy, DoubleTy, MetadataTy;
332 Type X86_FP80Ty, FP128Ty, PPC_FP128Ty, X86_MMXTy;
333 IntegerType Int1Ty, Int8Ty, Int16Ty, Int32Ty, Int64Ty;
336 /// TypeAllocator - All dynamically allocated types are allocated from this.
337 /// They live forever until the context is torn down.
338 BumpPtrAllocator TypeAllocator;
340 DenseMap<unsigned, IntegerType*> IntegerTypes;
342 typedef DenseMap<FunctionType*, bool, FunctionTypeKeyInfo> FunctionTypeMap;
343 FunctionTypeMap FunctionTypes;
344 typedef DenseMap<StructType*, bool, AnonStructTypeKeyInfo> StructTypeMap;
345 StructTypeMap AnonStructTypes;
346 StringMap<StructType*> NamedStructTypes;
347 unsigned NamedStructTypesUniqueID;
349 DenseMap<std::pair<Type *, uint64_t>, ArrayType*> ArrayTypes;
350 DenseMap<std::pair<Type *, unsigned>, VectorType*> VectorTypes;
351 DenseMap<Type*, PointerType*> PointerTypes; // Pointers in AddrSpace = 0
352 DenseMap<std::pair<Type*, unsigned>, PointerType*> ASPointerTypes;
355 /// ValueHandles - This map keeps track of all of the value handles that are
356 /// watching a Value*. The Value::HasValueHandle bit is used to know
357 /// whether or not a value has an entry in this map.
358 typedef DenseMap<Value*, ValueHandleBase*> ValueHandlesTy;
359 ValueHandlesTy ValueHandles;
361 /// CustomMDKindNames - Map to hold the metadata string to ID mapping.
362 StringMap<unsigned> CustomMDKindNames;
364 typedef std::pair<unsigned, TrackingVH<MDNode> > MDPairTy;
365 typedef SmallVector<MDPairTy, 2> MDMapTy;
367 /// MetadataStore - Collection of per-instruction metadata used in this
369 DenseMap<const Instruction *, MDMapTy> MetadataStore;
371 /// ScopeRecordIdx - This is the index in ScopeRecords for an MDNode scope
372 /// entry with no "inlined at" element.
373 DenseMap<MDNode*, int> ScopeRecordIdx;
375 /// ScopeRecords - These are the actual mdnodes (in a value handle) for an
376 /// index. The ValueHandle ensures that ScopeRecordIdx stays up to date if
377 /// the MDNode is RAUW'd.
378 std::vector<DebugRecVH> ScopeRecords;
380 /// ScopeInlinedAtIdx - This is the index in ScopeInlinedAtRecords for an
381 /// scope/inlined-at pair.
382 DenseMap<std::pair<MDNode*, MDNode*>, int> ScopeInlinedAtIdx;
384 /// ScopeInlinedAtRecords - These are the actual mdnodes (in value handles)
385 /// for an index. The ValueHandle ensures that ScopeINlinedAtIdx stays up
387 std::vector<std::pair<DebugRecVH, DebugRecVH> > ScopeInlinedAtRecords;
389 /// DiscriminatorTable - This table maps file:line locations to an
390 /// integer representing the next DWARF path discriminator to assign to
391 /// instructions in different blocks at the same location.
392 DenseMap<std::pair<const char *, unsigned>, unsigned> DiscriminatorTable;
394 /// IntrinsicIDCache - Cache of intrinsic name (string) to numeric ID mappings
395 /// requested in this context
396 typedef DenseMap<const Function*, unsigned> IntrinsicIDCacheTy;
397 IntrinsicIDCacheTy IntrinsicIDCache;
399 /// \brief Mapping from a function to its prefix data, which is stored as the
400 /// operand of an unparented ReturnInst so that the prefix data has a Use.
401 typedef DenseMap<const Function *, ReturnInst *> PrefixDataMapTy;
402 PrefixDataMapTy PrefixDataMap;
404 int getOrAddScopeRecordIdxEntry(MDNode *N, int ExistingIdx);
405 int getOrAddScopeInlinedAtIdxEntry(MDNode *Scope, MDNode *IA,int ExistingIdx);
407 LLVMContextImpl(LLVMContext &C);