LLVM  4.0.0
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 using namespace llvm;
14 
15 //===----------------------------------------------------------------------===//
16 // DebugLoc Implementation
17 //===----------------------------------------------------------------------===//
18 DebugLoc::DebugLoc(const DILocation *L) : Loc(const_cast<DILocation *>(L)) {}
19 DebugLoc::DebugLoc(const MDNode *L) : Loc(const_cast<MDNode *>(L)) {}
20 
22  return cast_or_null<DILocation>(Loc.get());
23 }
24 
25 unsigned DebugLoc::getLine() const {
26  assert(get() && "Expected valid DebugLoc");
27  return get()->getLine();
28 }
29 
30 unsigned DebugLoc::getCol() const {
31  assert(get() && "Expected valid DebugLoc");
32  return get()->getColumn();
33 }
34 
36  assert(get() && "Expected valid DebugLoc");
37  return get()->getScope();
38 }
39 
41  assert(get() && "Expected valid DebugLoc");
42  return get()->getInlinedAt();
43 }
44 
46  return cast<DILocation>(Loc)->getInlinedAtScope();
47 }
48 
50  // FIXME: Add a method on \a DILocation that does this work.
51  const MDNode *Scope = getInlinedAtScope();
52  if (auto *SP = getDISubprogram(Scope))
53  return DebugLoc::get(SP->getScopeLine(), 0, SP);
54 
55  return DebugLoc();
56 }
57 
58 DebugLoc DebugLoc::get(unsigned Line, unsigned Col, const MDNode *Scope,
59  const MDNode *InlinedAt) {
60  // If no scope is available, this is an unknown location.
61  if (!Scope)
62  return DebugLoc();
63 
64  return DILocation::get(Scope->getContext(), Line, Col,
65  const_cast<MDNode *>(Scope),
66  const_cast<MDNode *>(InlinedAt));
67 }
68 
70 #ifndef NDEBUG
71  if (!Loc)
72  return;
73 
74  dbgs() << getLine();
75  if (getCol() != 0)
76  dbgs() << ',' << getCol();
77  if (DebugLoc InlinedAtDL = DebugLoc(getInlinedAt())) {
78  dbgs() << " @ ";
79  InlinedAtDL.dump();
80  } else
81  dbgs() << "\n";
82 #endif
83 }
84 
85 void DebugLoc::print(raw_ostream &OS) const {
86  if (!Loc)
87  return;
88 
89  // Print source line info.
90  auto *Scope = cast<DIScope>(getScope());
91  OS << Scope->getFilename();
92  OS << ':' << getLine();
93  if (getCol() != 0)
94  OS << ':' << getCol();
95 
96  if (DebugLoc InlinedAtDL = getInlinedAt()) {
97  OS << " @[ ";
98  InlinedAtDL.print(OS);
99  OS << " ]";
100  }
101 }
MachineLoop * L
MDNode * getScope() const
Definition: DebugLoc.cpp:35
#define LLVM_DUMP_METHOD
Mark debug helper function definitions like dump() that should not be stripped from debug builds...
Definition: Compiler.h:450
A debug info location.
Definition: DebugLoc.h:34
Metadata node.
Definition: Metadata.h:830
DebugLoc getFnDebugLoc() const
Find the debug info location for the start of the function.
Definition: DebugLoc.cpp:49
DILocation * get() const
Get the underlying DILocation.
Definition: DebugLoc.cpp:21
DISubprogram * getDISubprogram(const MDNode *Scope)
Find subprogram that is enclosing this scope.
Definition: DebugInfo.cpp:34
void print(raw_ostream &OS) const
prints source location /path/to/file.exe:line:col @[inlined at]
Definition: DebugLoc.cpp:85
Debug location.
unsigned getLine() const
Definition: DebugLoc.cpp:25
MDNode * getInlinedAtScope() const
Get the fully inlined-at scope for a DebugLoc.
Definition: DebugLoc.cpp:45
DILocation * getInlinedAt() const
Definition: DebugLoc.cpp:40
unsigned getCol() const
Definition: DebugLoc.cpp:30
void dump() const
Definition: DebugLoc.cpp:69
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:132
DebugLoc()=default
static MDTuple * get(LLVMContext &Context, ArrayRef< Metadata * > MDs)
Definition: Metadata.h:1132
LLVMContext & getContext() const
Definition: Metadata.h:889
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