Coverage Report

Created: 2017-10-03 07:32

/Users/buildslave/jenkins/sharedspace/clang-stage2-coverage-R@2/llvm/include/llvm/IR/DebugLoc.h
Line
Count
Source (jump to first uncovered line)
1
//===- DebugLoc.h - Debug Location Information ------------------*- C++ -*-===//
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
// This file defines a number of light weight data structures used
11
// to describe and track debug location information.
12
//
13
//===----------------------------------------------------------------------===//
14
15
#ifndef LLVM_IR_DEBUGLOC_H
16
#define LLVM_IR_DEBUGLOC_H
17
18
#include "llvm/IR/TrackingMDRef.h"
19
#include "llvm/Support/DataTypes.h"
20
21
namespace llvm {
22
23
  class LLVMContext;
24
  class raw_ostream;
25
  class DILocation;
26
27
  /// \brief A debug info location.
28
  ///
29
  /// This class is a wrapper around a tracking reference to an \a DILocation
30
  /// pointer.
31
  ///
32
  /// To avoid extra includes, \a DebugLoc doubles the \a DILocation API with a
33
  /// one based on relatively opaque \a MDNode pointers.
34
  class DebugLoc {
35
    TrackingMDNodeRef Loc;
36
37
  public:
38
407M
    DebugLoc() = default;
39
40
    /// \brief Construct from an \a DILocation.
41
    DebugLoc(const DILocation *L);
42
43
    /// \brief Construct from an \a MDNode.
44
    ///
45
    /// Note: if \c N is not an \a DILocation, a verifier check will fail, and
46
    /// accessors will crash.  However, construction from other nodes is
47
    /// supported in order to handle forward references when reading textual
48
    /// IR.
49
    explicit DebugLoc(const MDNode *N);
50
51
    /// \brief Get the underlying \a DILocation.
52
    ///
53
    /// \pre !*this or \c isa<DILocation>(getAsMDNode()).
54
    /// @{
55
    DILocation *get() const;
56
28.0M
    operator DILocation *() const { return get(); }
57
310k
    DILocation *operator->() const { return get(); }
58
0
    DILocation &operator*() const { return *get(); }
59
    /// @}
60
61
    /// \brief Check for null.
62
    ///
63
    /// Check for null in a way that is safe with broken debug info.  Unlike
64
    /// the conversion to \c DILocation, this doesn't require that \c Loc is of
65
    /// the right type.  Important for cases like \a llvm::StripDebugInfo() and
66
    /// \a Instruction::hasMetadata().
67
776M
    explicit operator bool() const { return Loc; }
68
69
    /// \brief Check whether this has a trivial destructor.
70
0
    bool hasTrivialDestructor() const { return Loc.hasTrivialDestructor(); }
71
72
    /// \brief Create a new DebugLoc.
73
    ///
74
    /// Create a new DebugLoc at the specified line/col and scope/inline.  This
75
    /// forwards to \a DILocation::get().
76
    ///
77
    /// If \c !Scope, returns a default-constructed \a DebugLoc.
78
    ///
79
    /// FIXME: Remove this.  Users should use DILocation::get().
80
    static DebugLoc get(unsigned Line, unsigned Col, const MDNode *Scope,
81
                        const MDNode *InlinedAt = nullptr);
82
83
    enum { ReplaceLastInlinedAt = true };
84
    /// Rebuild the entire inlined-at chain for this instruction so that the top of
85
    /// the chain now is inlined-at the new call site.
86
    /// \param   InlinedAt    The new outermost inlined-at in the chain.
87
    /// \param   ReplaceLast  Replace the last location in the inlined-at chain.
88
    static DebugLoc appendInlinedAt(DebugLoc DL, DILocation *InlinedAt,
89
                                    LLVMContext &Ctx,
90
                                    DenseMap<const MDNode *, MDNode *> &Cache,
91
                                    bool ReplaceLast = false);
92
93
    unsigned getLine() const;
94
    unsigned getCol() const;
95
    MDNode *getScope() const;
96
    DILocation *getInlinedAt() const;
97
98
    /// \brief Get the fully inlined-at scope for a DebugLoc.
99
    ///
100
    /// Gets the inlined-at scope for a DebugLoc.
101
    MDNode *getInlinedAtScope() const;
102
103
    /// \brief Find the debug info location for the start of the function.
104
    ///
105
    /// Walk up the scope chain of given debug loc and find line number info
106
    /// for the function.
107
    ///
108
    /// FIXME: Remove this.  Users should use DILocation/DILocalScope API to
109
    /// find the subprogram, and then DILocation::get().
110
    DebugLoc getFnDebugLoc() const;
111
112
    /// \brief Return \c this as a bar \a MDNode.
113
4.41M
    MDNode *getAsMDNode() const { return Loc; }
114
115
584k
    bool operator==(const DebugLoc &DL) const { return Loc == DL.Loc; }
116
6.61M
    bool operator!=(const DebugLoc &DL) const { return Loc != DL.Loc; }
117
118
    void dump() const;
119
120
    /// \brief prints source location /path/to/file.exe:line:col @[inlined at]
121
    void print(raw_ostream &OS) const;
122
  };
123
124
} // end namespace llvm
125
126
#endif /* LLVM_SUPPORT_DEBUGLOC_H */