1 //===-- DebugLoc.cpp - Implement DebugLoc class ---------------------------===//
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 #include "llvm/IR/DebugLoc.h"
11 #include "LLVMContextImpl.h"
12 #include "llvm/ADT/DenseMapInfo.h"
13 #include "llvm/IR/DebugInfo.h"
16 //===----------------------------------------------------------------------===//
17 // DebugLoc Implementation
18 //===----------------------------------------------------------------------===//
20 MDNode *DebugLoc::getScope(const LLVMContext &Ctx) const {
21 if (ScopeIdx == 0) return nullptr;
24 // Positive ScopeIdx is an index into ScopeRecords, which has no inlined-at
25 // position specified.
26 assert(unsigned(ScopeIdx) <= Ctx.pImpl->ScopeRecords.size() &&
28 return Ctx.pImpl->ScopeRecords[ScopeIdx-1].get();
31 // Otherwise, the index is in the ScopeInlinedAtRecords array.
32 assert(unsigned(-ScopeIdx) <= Ctx.pImpl->ScopeInlinedAtRecords.size() &&
34 return Ctx.pImpl->ScopeInlinedAtRecords[-ScopeIdx-1].first.get();
37 MDNode *DebugLoc::getInlinedAt(const LLVMContext &Ctx) const {
38 // Positive ScopeIdx is an index into ScopeRecords, which has no inlined-at
39 // position specified. Zero is invalid.
40 if (ScopeIdx >= 0) return nullptr;
42 // Otherwise, the index is in the ScopeInlinedAtRecords array.
43 assert(unsigned(-ScopeIdx) <= Ctx.pImpl->ScopeInlinedAtRecords.size() &&
45 return Ctx.pImpl->ScopeInlinedAtRecords[-ScopeIdx-1].second.get();
48 /// Return both the Scope and the InlinedAt values.
49 void DebugLoc::getScopeAndInlinedAt(MDNode *&Scope, MDNode *&IA,
50 const LLVMContext &Ctx) const {
57 // Positive ScopeIdx is an index into ScopeRecords, which has no inlined-at
58 // position specified.
59 assert(unsigned(ScopeIdx) <= Ctx.pImpl->ScopeRecords.size() &&
61 Scope = Ctx.pImpl->ScopeRecords[ScopeIdx-1].get();
66 // Otherwise, the index is in the ScopeInlinedAtRecords array.
67 assert(unsigned(-ScopeIdx) <= Ctx.pImpl->ScopeInlinedAtRecords.size() &&
69 Scope = Ctx.pImpl->ScopeInlinedAtRecords[-ScopeIdx-1].first.get();
70 IA = Ctx.pImpl->ScopeInlinedAtRecords[-ScopeIdx-1].second.get();
73 MDNode *DebugLoc::getScopeNode(const LLVMContext &Ctx) const {
74 if (MDNode *InlinedAt = getInlinedAt(Ctx))
75 return DebugLoc::getFromDILocation(InlinedAt).getScopeNode(Ctx);
79 DebugLoc DebugLoc::getFnDebugLoc(const LLVMContext &Ctx) {
80 const MDNode *Scope = getScopeNode(Ctx);
81 DISubprogram SP = getDISubprogram(Scope);
82 if (SP.isSubprogram()) {
83 // Check for number of operands since the compatibility is
84 // cheap here. FIXME: Name the magic constant.
85 if (SP->getNumOperands() > 19)
86 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
88 return DebugLoc::get(SP.getLineNumber(), 0, SP);
94 DebugLoc DebugLoc::get(unsigned Line, unsigned Col,
95 MDNode *Scope, MDNode *InlinedAt) {
98 // If no scope is available, this is an unknown location.
99 if (!Scope) return Result;
101 // Saturate line and col to "unknown".
102 if (Col > 255) Col = 0;
103 if (Line >= (1 << 24)) Line = 0;
104 Result.LineCol = Line | (Col << 24);
106 LLVMContext &Ctx = Scope->getContext();
108 // If there is no inlined-at location, use the ScopeRecords array.
110 Result.ScopeIdx = Ctx.pImpl->getOrAddScopeRecordIdxEntry(Scope, 0);
112 Result.ScopeIdx = Ctx.pImpl->getOrAddScopeInlinedAtIdxEntry(Scope,
118 /// getAsMDNode - This method converts the compressed DebugLoc node into a
119 /// DILocation-compatible MDNode.
120 MDNode *DebugLoc::getAsMDNode(const LLVMContext &Ctx) const {
121 if (isUnknown()) return nullptr;
124 getScopeAndInlinedAt(Scope, IA, Ctx);
125 assert(Scope && "If scope is null, this should be isUnknown()");
127 LLVMContext &Ctx2 = Scope->getContext();
128 Type *Int32 = Type::getInt32Ty(Ctx2);
130 ConstantInt::get(Int32, getLine()), ConstantInt::get(Int32, getCol()),
133 return MDNode::get(Ctx2, Elts);
136 /// getFromDILocation - Translate the DILocation quad into a DebugLoc.
137 DebugLoc DebugLoc::getFromDILocation(MDNode *N) {
139 MDNode *Scope = Loc.getScope();
140 if (!Scope) return DebugLoc();
141 return get(Loc.getLineNumber(), Loc.getColumnNumber(), Scope,
142 Loc.getOrigLocation());
145 /// getFromDILexicalBlock - Translate the DILexicalBlock into a DebugLoc.
146 DebugLoc DebugLoc::getFromDILexicalBlock(MDNode *N) {
147 DILexicalBlock LexBlock(N);
148 MDNode *Scope = LexBlock.getContext();
149 if (!Scope) return DebugLoc();
150 return get(LexBlock.getLineNumber(), LexBlock.getColumnNumber(), Scope,
154 void DebugLoc::dump(const LLVMContext &Ctx) const {
159 dbgs() << ',' << getCol();
160 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(getInlinedAt(Ctx));
161 if (!InlinedAtDL.isUnknown()) {
163 InlinedAtDL.dump(Ctx);
170 //===----------------------------------------------------------------------===//
171 // DenseMap specialization
172 //===----------------------------------------------------------------------===//
174 unsigned DenseMapInfo<DebugLoc>::getHashValue(const DebugLoc &Key) {
175 return static_cast<unsigned>(hash_combine(Key.LineCol, Key.ScopeIdx));
178 //===----------------------------------------------------------------------===//
179 // LLVMContextImpl Implementation
180 //===----------------------------------------------------------------------===//
182 int LLVMContextImpl::getOrAddScopeRecordIdxEntry(MDNode *Scope,
184 // If we already have an entry for this scope, return it.
185 int &Idx = ScopeRecordIdx[Scope];
188 // If we don't have an entry, but ExistingIdx is specified, use it.
190 return Idx = ExistingIdx;
192 // Otherwise add a new entry.
194 // Start out ScopeRecords with a minimal reasonable size to avoid
195 // excessive reallocation starting out.
196 if (ScopeRecords.empty())
197 ScopeRecords.reserve(128);
199 // Index is biased by 1 for index.
200 Idx = ScopeRecords.size()+1;
201 ScopeRecords.push_back(DebugRecVH(Scope, this, Idx));
205 int LLVMContextImpl::getOrAddScopeInlinedAtIdxEntry(MDNode *Scope, MDNode *IA,
207 // If we already have an entry, return it.
208 int &Idx = ScopeInlinedAtIdx[std::make_pair(Scope, IA)];
211 // If we don't have an entry, but ExistingIdx is specified, use it.
213 return Idx = ExistingIdx;
215 // Start out ScopeInlinedAtRecords with a minimal reasonable size to avoid
216 // excessive reallocation starting out.
217 if (ScopeInlinedAtRecords.empty())
218 ScopeInlinedAtRecords.reserve(128);
220 // Index is biased by 1 and negated.
221 Idx = -ScopeInlinedAtRecords.size()-1;
222 ScopeInlinedAtRecords.push_back(std::make_pair(DebugRecVH(Scope, this, Idx),
223 DebugRecVH(IA, this, Idx)));
228 //===----------------------------------------------------------------------===//
229 // DebugRecVH Implementation
230 //===----------------------------------------------------------------------===//
232 /// deleted - The MDNode this is pointing to got deleted, so this pointer needs
233 /// to drop to null and we need remove our entry from the DenseMap.
234 void DebugRecVH::deleted() {
235 // If this is a non-canonical reference, just drop the value to null, we know
236 // it doesn't have a map entry.
244 // If the index is positive, it is an entry in ScopeRecords.
246 assert(Ctx->ScopeRecordIdx[Cur] == Idx && "Mapping out of date!");
247 Ctx->ScopeRecordIdx.erase(Cur);
248 // Reset this VH to null and we're done.
254 // Otherwise, it is an entry in ScopeInlinedAtRecords, we don't know if it
255 // is the scope or the inlined-at record entry.
256 assert(unsigned(-Idx-1) < Ctx->ScopeInlinedAtRecords.size());
257 std::pair<DebugRecVH, DebugRecVH> &Entry = Ctx->ScopeInlinedAtRecords[-Idx-1];
258 assert((this == &Entry.first || this == &Entry.second) &&
259 "Mapping out of date!");
261 MDNode *OldScope = Entry.first.get();
262 MDNode *OldInlinedAt = Entry.second.get();
263 assert(OldScope && OldInlinedAt &&
264 "Entry should be non-canonical if either val dropped to null");
266 // Otherwise, we do have an entry in it, nuke it and we're done.
267 assert(Ctx->ScopeInlinedAtIdx[std::make_pair(OldScope, OldInlinedAt)] == Idx&&
268 "Mapping out of date");
269 Ctx->ScopeInlinedAtIdx.erase(std::make_pair(OldScope, OldInlinedAt));
271 // Reset this VH to null. Drop both 'Idx' values to null to indicate that
272 // we're in non-canonical form now.
274 Entry.first.Idx = Entry.second.Idx = 0;
277 void DebugRecVH::allUsesReplacedWith(Value *NewVa) {
278 // If being replaced with a non-mdnode value (e.g. undef) handle this as if
279 // the mdnode got deleted.
280 MDNode *NewVal = dyn_cast<MDNode>(NewVa);
281 if (!NewVal) return deleted();
283 // If this is a non-canonical reference, just change it, we know it already
284 // doesn't have a map entry.
290 MDNode *OldVal = get();
291 assert(OldVal != NewVa && "Node replaced with self?");
293 // If the index is positive, it is an entry in ScopeRecords.
295 assert(Ctx->ScopeRecordIdx[OldVal] == Idx && "Mapping out of date!");
296 Ctx->ScopeRecordIdx.erase(OldVal);
299 int NewEntry = Ctx->getOrAddScopeRecordIdxEntry(NewVal, Idx);
301 // If NewVal already has an entry, this becomes a non-canonical reference,
302 // just drop Idx to 0 to signify this.
308 // Otherwise, it is an entry in ScopeInlinedAtRecords, we don't know if it
309 // is the scope or the inlined-at record entry.
310 assert(unsigned(-Idx-1) < Ctx->ScopeInlinedAtRecords.size());
311 std::pair<DebugRecVH, DebugRecVH> &Entry = Ctx->ScopeInlinedAtRecords[-Idx-1];
312 assert((this == &Entry.first || this == &Entry.second) &&
313 "Mapping out of date!");
315 MDNode *OldScope = Entry.first.get();
316 MDNode *OldInlinedAt = Entry.second.get();
317 assert(OldScope && OldInlinedAt &&
318 "Entry should be non-canonical if either val dropped to null");
320 // Otherwise, we do have an entry in it, nuke it and we're done.
321 assert(Ctx->ScopeInlinedAtIdx[std::make_pair(OldScope, OldInlinedAt)] == Idx&&
322 "Mapping out of date");
323 Ctx->ScopeInlinedAtIdx.erase(std::make_pair(OldScope, OldInlinedAt));
325 // Reset this VH to the new value.
328 int NewIdx = Ctx->getOrAddScopeInlinedAtIdxEntry(Entry.first.get(),
329 Entry.second.get(), Idx);
330 // If NewVal already has an entry, this becomes a non-canonical reference,
331 // just drop Idx to 0 to signify this.
333 std::pair<DebugRecVH, DebugRecVH> &Entry=Ctx->ScopeInlinedAtRecords[-Idx-1];
334 Entry.first.Idx = Entry.second.Idx = 0;