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/Support/DebugLoc.h"
11 #include "LLVMContextImpl.h"
12 #include "llvm/ADT/DenseMapInfo.h"
13 #include "llvm/DebugInfo.h"
16 //===----------------------------------------------------------------------===//
17 // DebugLoc Implementation
18 //===----------------------------------------------------------------------===//
20 MDNode *DebugLoc::getScope(const LLVMContext &Ctx) const {
21 if (ScopeIdx == 0) return 0;
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 0;
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 == 0) 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 0;
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 == 0) 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 == 0) return DebugLoc();
150 return get(LexBlock.getLineNumber(), LexBlock.getColumnNumber(), Scope, NULL);
153 void DebugLoc::dump(const LLVMContext &Ctx) const {
158 dbgs() << ',' << getCol();
159 DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(getInlinedAt(Ctx));
160 if (!InlinedAtDL.isUnknown()) {
162 InlinedAtDL.dump(Ctx);
169 //===----------------------------------------------------------------------===//
170 // DenseMap specialization
171 //===----------------------------------------------------------------------===//
173 unsigned DenseMapInfo<DebugLoc>::getHashValue(const DebugLoc &Key) {
174 return static_cast<unsigned>(hash_combine(Key.LineCol, Key.ScopeIdx));
177 //===----------------------------------------------------------------------===//
178 // LLVMContextImpl Implementation
179 //===----------------------------------------------------------------------===//
181 int LLVMContextImpl::getOrAddScopeRecordIdxEntry(MDNode *Scope,
183 // If we already have an entry for this scope, return it.
184 int &Idx = ScopeRecordIdx[Scope];
187 // If we don't have an entry, but ExistingIdx is specified, use it.
189 return Idx = ExistingIdx;
191 // Otherwise add a new entry.
193 // Start out ScopeRecords with a minimal reasonable size to avoid
194 // excessive reallocation starting out.
195 if (ScopeRecords.empty())
196 ScopeRecords.reserve(128);
198 // Index is biased by 1 for index.
199 Idx = ScopeRecords.size()+1;
200 ScopeRecords.push_back(DebugRecVH(Scope, this, Idx));
204 int LLVMContextImpl::getOrAddScopeInlinedAtIdxEntry(MDNode *Scope, MDNode *IA,
206 // If we already have an entry, return it.
207 int &Idx = ScopeInlinedAtIdx[std::make_pair(Scope, IA)];
210 // If we don't have an entry, but ExistingIdx is specified, use it.
212 return Idx = ExistingIdx;
214 // Start out ScopeInlinedAtRecords with a minimal reasonable size to avoid
215 // excessive reallocation starting out.
216 if (ScopeInlinedAtRecords.empty())
217 ScopeInlinedAtRecords.reserve(128);
219 // Index is biased by 1 and negated.
220 Idx = -ScopeInlinedAtRecords.size()-1;
221 ScopeInlinedAtRecords.push_back(std::make_pair(DebugRecVH(Scope, this, Idx),
222 DebugRecVH(IA, this, Idx)));
227 //===----------------------------------------------------------------------===//
228 // DebugRecVH Implementation
229 //===----------------------------------------------------------------------===//
231 /// deleted - The MDNode this is pointing to got deleted, so this pointer needs
232 /// to drop to null and we need remove our entry from the DenseMap.
233 void DebugRecVH::deleted() {
234 // If this is a non-canonical reference, just drop the value to null, we know
235 // it doesn't have a map entry.
243 // If the index is positive, it is an entry in ScopeRecords.
245 assert(Ctx->ScopeRecordIdx[Cur] == Idx && "Mapping out of date!");
246 Ctx->ScopeRecordIdx.erase(Cur);
247 // Reset this VH to null and we're done.
253 // Otherwise, it is an entry in ScopeInlinedAtRecords, we don't know if it
254 // is the scope or the inlined-at record entry.
255 assert(unsigned(-Idx-1) < Ctx->ScopeInlinedAtRecords.size());
256 std::pair<DebugRecVH, DebugRecVH> &Entry = Ctx->ScopeInlinedAtRecords[-Idx-1];
257 assert((this == &Entry.first || this == &Entry.second) &&
258 "Mapping out of date!");
260 MDNode *OldScope = Entry.first.get();
261 MDNode *OldInlinedAt = Entry.second.get();
262 assert(OldScope != 0 && OldInlinedAt != 0 &&
263 "Entry should be non-canonical if either val dropped to null");
265 // Otherwise, we do have an entry in it, nuke it and we're done.
266 assert(Ctx->ScopeInlinedAtIdx[std::make_pair(OldScope, OldInlinedAt)] == Idx&&
267 "Mapping out of date");
268 Ctx->ScopeInlinedAtIdx.erase(std::make_pair(OldScope, OldInlinedAt));
270 // Reset this VH to null. Drop both 'Idx' values to null to indicate that
271 // we're in non-canonical form now.
273 Entry.first.Idx = Entry.second.Idx = 0;
276 void DebugRecVH::allUsesReplacedWith(Value *NewVa) {
277 // If being replaced with a non-mdnode value (e.g. undef) handle this as if
278 // the mdnode got deleted.
279 MDNode *NewVal = dyn_cast<MDNode>(NewVa);
280 if (NewVal == 0) return deleted();
282 // If this is a non-canonical reference, just change it, we know it already
283 // doesn't have a map entry.
289 MDNode *OldVal = get();
290 assert(OldVal != NewVa && "Node replaced with self?");
292 // If the index is positive, it is an entry in ScopeRecords.
294 assert(Ctx->ScopeRecordIdx[OldVal] == Idx && "Mapping out of date!");
295 Ctx->ScopeRecordIdx.erase(OldVal);
298 int NewEntry = Ctx->getOrAddScopeRecordIdxEntry(NewVal, Idx);
300 // If NewVal already has an entry, this becomes a non-canonical reference,
301 // just drop Idx to 0 to signify this.
307 // Otherwise, it is an entry in ScopeInlinedAtRecords, we don't know if it
308 // is the scope or the inlined-at record entry.
309 assert(unsigned(-Idx-1) < Ctx->ScopeInlinedAtRecords.size());
310 std::pair<DebugRecVH, DebugRecVH> &Entry = Ctx->ScopeInlinedAtRecords[-Idx-1];
311 assert((this == &Entry.first || this == &Entry.second) &&
312 "Mapping out of date!");
314 MDNode *OldScope = Entry.first.get();
315 MDNode *OldInlinedAt = Entry.second.get();
316 assert(OldScope != 0 && OldInlinedAt != 0 &&
317 "Entry should be non-canonical if either val dropped to null");
319 // Otherwise, we do have an entry in it, nuke it and we're done.
320 assert(Ctx->ScopeInlinedAtIdx[std::make_pair(OldScope, OldInlinedAt)] == Idx&&
321 "Mapping out of date");
322 Ctx->ScopeInlinedAtIdx.erase(std::make_pair(OldScope, OldInlinedAt));
324 // Reset this VH to the new value.
327 int NewIdx = Ctx->getOrAddScopeInlinedAtIdxEntry(Entry.first.get(),
328 Entry.second.get(), Idx);
329 // If NewVal already has an entry, this becomes a non-canonical reference,
330 // just drop Idx to 0 to signify this.
332 std::pair<DebugRecVH, DebugRecVH> &Entry=Ctx->ScopeInlinedAtRecords[-Idx-1];
333 Entry.first.Idx = Entry.second.Idx = 0;