LLVM  6.0.0svn
DebugLoc.cpp
Go to the documentation of this file.
1 //===-- DebugLoc.cpp - Implement DebugLoc class ---------------------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "llvm/IR/DebugLoc.h"
11 #include "LLVMContextImpl.h"
12 #include "llvm/IR/DebugInfo.h"
13 #include "llvm/IR/IntrinsicInst.h"
14 using namespace llvm;
15 
16 //===----------------------------------------------------------------------===//
17 // DebugLoc Implementation
18 //===----------------------------------------------------------------------===//
19 DebugLoc::DebugLoc(const DILocation *L) : Loc(const_cast<DILocation *>(L)) {}
20 DebugLoc::DebugLoc(const MDNode *L) : Loc(const_cast<MDNode *>(L)) {}
21 
23  return cast_or_null<DILocation>(Loc.get());
24 }
25 
26 unsigned DebugLoc::getLine() const {
27  assert(get() && "Expected valid DebugLoc");
28  return get()->getLine();
29 }
30 
31 unsigned DebugLoc::getCol() const {
32  assert(get() && "Expected valid DebugLoc");
33  return get()->getColumn();
34 }
35 
37  assert(get() && "Expected valid DebugLoc");
38  return get()->getScope();
39 }
40 
42  assert(get() && "Expected valid DebugLoc");
43  return get()->getInlinedAt();
44 }
45 
47  return cast<DILocation>(Loc)->getInlinedAtScope();
48 }
49 
51  // FIXME: Add a method on \a DILocation that does this work.
52  const MDNode *Scope = getInlinedAtScope();
53  if (auto *SP = getDISubprogram(Scope))
54  return DebugLoc::get(SP->getScopeLine(), 0, SP);
55 
56  return DebugLoc();
57 }
58 
59 DebugLoc DebugLoc::get(unsigned Line, unsigned Col, const MDNode *Scope,
60  const MDNode *InlinedAt) {
61  // If no scope is available, this is an unknown location.
62  if (!Scope)
63  return DebugLoc();
64 
65  return DILocation::get(Scope->getContext(), Line, Col,
66  const_cast<MDNode *>(Scope),
67  const_cast<MDNode *>(InlinedAt));
68 }
69 
71  LLVMContext &Ctx,
73  bool ReplaceLast) {
74  SmallVector<DILocation *, 3> InlinedAtLocations;
75  DILocation *Last = InlinedAt;
76  DILocation *CurInlinedAt = DL;
77 
78  // Gather all the inlined-at nodes.
79  while (DILocation *IA = CurInlinedAt->getInlinedAt()) {
80  // Skip any we've already built nodes for.
81  if (auto *Found = Cache[IA]) {
82  Last = cast<DILocation>(Found);
83  break;
84  }
85 
86  if (ReplaceLast && !IA->getInlinedAt())
87  break;
88  InlinedAtLocations.push_back(IA);
89  CurInlinedAt = IA;
90  }
91 
92  // Starting from the top, rebuild the nodes to point to the new inlined-at
93  // location (then rebuilding the rest of the chain behind it) and update the
94  // map of already-constructed inlined-at nodes.
95  for (const DILocation *MD : reverse(InlinedAtLocations))
96  Cache[MD] = Last = DILocation::getDistinct(
97  Ctx, MD->getLine(), MD->getColumn(), MD->getScope(), Last);
98 
99  return Last;
100 }
101 
102 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
104  if (!Loc)
105  return;
106 
107  dbgs() << getLine();
108  if (getCol() != 0)
109  dbgs() << ',' << getCol();
110  if (DebugLoc InlinedAtDL = DebugLoc(getInlinedAt())) {
111  dbgs() << " @ ";
112  InlinedAtDL.dump();
113  } else
114  dbgs() << "\n";
115 }
116 #endif
117 
118 void DebugLoc::print(raw_ostream &OS) const {
119  if (!Loc)
120  return;
121 
122  // Print source line info.
123  auto *Scope = cast<DIScope>(getScope());
124  OS << Scope->getFilename();
125  OS << ':' << getLine();
126  if (getCol() != 0)
127  OS << ':' << getCol();
128 
129  if (DebugLoc InlinedAtDL = getInlinedAt()) {
130  OS << " @[ ";
131  InlinedAtDL.print(OS);
132  OS << " ]";
133  }
134 }
DILocation * get() const
Get the underlying DILocation.
Definition: DebugLoc.cpp:22
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
#define LLVM_DUMP_METHOD
Mark debug helper function definitions like dump() that should not be stripped from debug builds...
Definition: Compiler.h:449
static DebugLoc appendInlinedAt(DebugLoc DL, DILocation *InlinedAt, LLVMContext &Ctx, DenseMap< const MDNode *, MDNode *> &Cache, bool ReplaceLast=false)
Rebuild the entire inlined-at chain for this instruction so that the top of the chain now is inlined-...
Definition: DebugLoc.cpp:70
unsigned getLine() const
Definition: DebugLoc.cpp:26
A debug info location.
Definition: DebugLoc.h:34
Metadata node.
Definition: Metadata.h:862
void print(raw_ostream &OS) const
prints source location /path/to/file.exe:line:col @[inlined at]
Definition: DebugLoc.cpp:118
MDNode * getInlinedAtScope() const
Get the fully inlined-at scope for a DebugLoc.
Definition: DebugLoc.cpp:46
DISubprogram * getDISubprogram(const MDNode *Scope)
Find subprogram that is enclosing this scope.
Definition: DebugInfo.cpp:41
auto reverse(ContainerTy &&C, typename std::enable_if< has_rbegin< ContainerTy >::value >::type *=nullptr) -> decltype(make_range(C.rbegin(), C.rend()))
Definition: STLExtras.h:250
LLVMContext & getContext() const
Definition: Metadata.h:922
Debug location.
static MDTuple * get(LLVMContext &Context, ArrayRef< Metadata *> MDs)
Definition: Metadata.h:1164
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:68
static MDTuple * getDistinct(LLVMContext &Context, ArrayRef< Metadata *> MDs)
Definition: Metadata.h:1172
MDNode * getScope() const
Definition: DebugLoc.cpp:36
DILocation * getInlinedAt() const
Definition: DebugLoc.cpp:41
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:864
DebugLoc getFnDebugLoc() const
Find the debug info location for the start of the function.
Definition: DebugLoc.cpp:50
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:132
DebugLoc()=default
unsigned getCol() const
Definition: DebugLoc.cpp:31
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:44
void dump() const
Definition: DebugLoc.cpp:103