1 //===-- DebugLoc.cpp - Implement DebugLoc class ---------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "llvm/IR/DebugLoc.h"
10 #include "llvm/Config/llvm-config.h"
11 #include "llvm/IR/DebugInfo.h"
12 using namespace llvm;
13 
14 //===----------------------------------------------------------------------===//
15 // DebugLoc Implementation
16 //===----------------------------------------------------------------------===//
17 DebugLoc::DebugLoc(const DILocation *L) : Loc(const_cast<DILocation *>(L)) {}
18 DebugLoc::DebugLoc(const MDNode *L) : Loc(const_cast<MDNode *>(L)) {}
19 
20 DILocation *DebugLoc::get() const {
21   return cast_or_null<DILocation>(Loc.get());
22 }
23 
24 unsigned DebugLoc::getLine() const {
25   assert(get() && "Expected valid DebugLoc");
26   return get()->getLine();
27 }
28 
29 unsigned DebugLoc::getCol() const {
30   assert(get() && "Expected valid DebugLoc");
31   return get()->getColumn();
32 }
33 
34 MDNode *DebugLoc::getScope() const {
35   assert(get() && "Expected valid DebugLoc");
36   return get()->getScope();
37 }
38 
39 DILocation *DebugLoc::getInlinedAt() const {
40   assert(get() && "Expected valid DebugLoc");
41   return get()->getInlinedAt();
42 }
43 
44 MDNode *DebugLoc::getInlinedAtScope() const {
45   return cast<DILocation>(Loc)->getInlinedAtScope();
46 }
47 
48 DebugLoc DebugLoc::getFnDebugLoc() const {
49   // FIXME: Add a method on \a DILocation that does this work.
50   const MDNode *Scope = getInlinedAtScope();
51   if (auto *SP = getDISubprogram(Scope))
52     return DILocation::get(SP->getContext(), SP->getScopeLine(), 0, SP);
53 
54   return DebugLoc();
55 }
56 
57 bool DebugLoc::isImplicitCode() const {
58   if (DILocation *Loc = get()) {
59     return Loc->isImplicitCode();
60   }
61   return true;
62 }
63 
64 void DebugLoc::setImplicitCode(bool ImplicitCode) {
65   if (DILocation *Loc = get()) {
66     Loc->setImplicitCode(ImplicitCode);
67   }
68 }
69 
70 DebugLoc DebugLoc::appendInlinedAt(const DebugLoc &DL, DILocation *InlinedAt,
71                                    LLVMContext &Ctx,
72                                    DenseMap<const MDNode *, MDNode *> &Cache) {
73   SmallVector<DILocation *, 3> InlinedAtLocations;
74   DILocation *Last = InlinedAt;
75   DILocation *CurInlinedAt = DL;
76 
77   // Gather all the inlined-at nodes.
78   while (DILocation *IA = CurInlinedAt->getInlinedAt()) {
79     // Skip any we've already built nodes for.
80     if (auto *Found = Cache[IA]) {
81       Last = cast<DILocation>(Found);
82       break;
83     }
84 
85     InlinedAtLocations.push_back(IA);
86     CurInlinedAt = IA;
87   }
88 
89   // Starting from the top, rebuild the nodes to point to the new inlined-at
90   // location (then rebuilding the rest of the chain behind it) and update the
91   // map of already-constructed inlined-at nodes.
92   for (const DILocation *MD : reverse(InlinedAtLocations))
93     Cache[MD] = Last = DILocation::getDistinct(
94         Ctx, MD->getLine(), MD->getColumn(), MD->getScope(), Last);
95 
96   return Last;
97 }
98 
99 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
100 LLVM_DUMP_METHOD void DebugLoc::dump() const { print(dbgs()); }
101 #endif
102 
103 void DebugLoc::print(raw_ostream &OS) const {
104   if (!Loc)
105     return;
106 
107   // Print source line info.
108   auto *Scope = cast<DIScope>(getScope());
109   OS << Scope->getFilename();
110   OS << ':' << getLine();
111   if (getCol() != 0)
112     OS << ':' << getCol();
113 
114   if (DebugLoc InlinedAtDL = getInlinedAt()) {
115     OS << " @[ ";
116     InlinedAtDL.print(OS);
117     OS << " ]";
118   }
119 }
120