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 "LLVMContextImpl.h"
11#include "llvm/Config/llvm-config.h"
12#include "llvm/IR/DebugInfo.h"
13using namespace llvm;
14
15//===----------------------------------------------------------------------===//
16// DebugLoc Implementation
17//===----------------------------------------------------------------------===//
18DebugLoc::DebugLoc(const DILocation *L) : Loc(const_cast<DILocation *>(L)) {}
19DebugLoc::DebugLoc(const MDNode *L) : Loc(const_cast<MDNode *>(L)) {}
20
21DILocation *DebugLoc::get() const {
22  return cast_or_null<DILocation>(Loc.get());
23}
24
25unsigned DebugLoc::getLine() const {
26  assert(get() && "Expected valid DebugLoc");
27  return get()->getLine();
28}
29
30unsigned DebugLoc::getCol() const {
31  assert(get() && "Expected valid DebugLoc");
32  return get()->getColumn();
33}
34
35MDNode *DebugLoc::getScope() const {
36  assert(get() && "Expected valid DebugLoc");
37  return get()->getScope();
38}
39
40DILocation *DebugLoc::getInlinedAt() const {
41  assert(get() && "Expected valid DebugLoc");
42  return get()->getInlinedAt();
43}
44
45MDNode *DebugLoc::getInlinedAtScope() const {
46  return cast<DILocation>(Loc)->getInlinedAtScope();
47}
48
49DebugLoc DebugLoc::getFnDebugLoc() const {
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
58bool DebugLoc::isImplicitCode() const {
59  if (DILocation *Loc = get()) {
60    return Loc->isImplicitCode();
61  }
62  return true;
63}
64
65void DebugLoc::setImplicitCode(bool ImplicitCode) {
66  if (DILocation *Loc = get()) {
67    Loc->setImplicitCode(ImplicitCode);
68  }
69}
70
71DebugLoc DebugLoc::get(unsigned Line, unsigned Col, const MDNode *Scope,
72                       const MDNode *InlinedAt, bool ImplicitCode) {
73  // If no scope is available, this is an unknown location.
74  if (!Scope)
75    return DebugLoc();
76
77  return DILocation::get(Scope->getContext(), Line, Col,
78                         const_cast<MDNode *>(Scope),
79                         const_cast<MDNode *>(InlinedAt), ImplicitCode);
80}
81
82DebugLoc DebugLoc::appendInlinedAt(DebugLoc DL, DILocation *InlinedAt,
83                                   LLVMContext &Ctx,
84                                   DenseMap<const MDNode *, MDNode *> &Cache,
85                                   bool ReplaceLast) {
86  SmallVector<DILocation *, 3> InlinedAtLocations;
87  DILocation *Last = InlinedAt;
88  DILocation *CurInlinedAt = DL;
89
90  // Gather all the inlined-at nodes.
91  while (DILocation *IA = CurInlinedAt->getInlinedAt()) {
92    // Skip any we've already built nodes for.
93    if (auto *Found = Cache[IA]) {
94      Last = cast<DILocation>(Found);
95      break;
96    }
97
98    if (ReplaceLast && !IA->getInlinedAt())
99      break;
100    InlinedAtLocations.push_back(IA);
101    CurInlinedAt = IA;
102  }
103
104  // Starting from the top, rebuild the nodes to point to the new inlined-at
105  // location (then rebuilding the rest of the chain behind it) and update the
106  // map of already-constructed inlined-at nodes.
107  for (const DILocation *MD : reverse(InlinedAtLocations))
108    Cache[MD] = Last = DILocation::getDistinct(
109        Ctx, MD->getLine(), MD->getColumn(), MD->getScope(), Last);
110
111  return Last;
112}
113
114#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
115LLVM_DUMP_METHOD void DebugLoc::dump() const { print(dbgs()); }
116#endif
117
118void 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}
135