Coverage Report

Created: 2022-01-25 06:29

/Users/buildslave/jenkins/workspace/coverage/llvm-project/lldb/include/lldb/Target/StackFrameList.h
Line
Count
Source
1
//===-- StackFrameList.h ----------------------------------------*- C++ -*-===//
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
#ifndef LLDB_TARGET_STACKFRAMELIST_H
10
#define LLDB_TARGET_STACKFRAMELIST_H
11
12
#include <memory>
13
#include <mutex>
14
#include <vector>
15
16
#include "lldb/Target/StackFrame.h"
17
18
namespace lldb_private {
19
20
class StackFrameList {
21
public:
22
  // Constructors and Destructors
23
  StackFrameList(Thread &thread, const lldb::StackFrameListSP &prev_frames_sp,
24
                 bool show_inline_frames);
25
26
  ~StackFrameList();
27
28
  /// Get the number of visible frames. Frames may be created if \p can_create
29
  /// is true. Synthetic (inline) frames expanded from the concrete frame #0
30
  /// (aka invisible frames) are not included in this count.
31
  uint32_t GetNumFrames(bool can_create = true);
32
33
  /// Get the frame at index \p idx. Invisible frames cannot be indexed.
34
  lldb::StackFrameSP GetFrameAtIndex(uint32_t idx);
35
36
  /// Get the first concrete frame with index greater than or equal to \p idx.
37
  /// Unlike \ref GetFrameAtIndex, this cannot return a synthetic frame.
38
  lldb::StackFrameSP GetFrameWithConcreteFrameIndex(uint32_t unwind_idx);
39
40
  /// Retrieve the stack frame with the given ID \p stack_id.
41
  lldb::StackFrameSP GetFrameWithStackID(const StackID &stack_id);
42
43
  /// Mark a stack frame as the currently selected frame and return its index.
44
  uint32_t SetSelectedFrame(lldb_private::StackFrame *frame);
45
46
  /// Get the currently selected frame index.
47
  uint32_t GetSelectedFrameIndex() const;
48
49
  /// Mark a stack frame as the currently selected frame using the frame index
50
  /// \p idx. Like \ref GetFrameAtIndex, invisible frames cannot be selected.
51
  bool SetSelectedFrameByIndex(uint32_t idx);
52
53
  /// If the current inline depth (i.e the number of invisible frames) is valid,
54
  /// subtract it from \p idx. Otherwise simply return \p idx.
55
8.01k
  uint32_t GetVisibleStackFrameIndex(uint32_t idx) {
56
8.01k
    if (m_current_inlined_depth < UINT32_MAX)
57
111
      return idx - m_current_inlined_depth;
58
7.90k
    else
59
7.90k
      return idx;
60
8.01k
  }
61
62
  /// Calculate and set the current inline depth. This may be used to update
63
  /// the StackFrameList's set of inline frames when execution stops, e.g when
64
  /// a breakpoint is hit.
65
  void CalculateCurrentInlinedDepth();
66
67
  /// If the currently selected frame comes from the currently selected thread,
68
  /// point the default file and line of the thread's target to the location
69
  /// specified by the frame.
70
  void SetDefaultFileAndLineToSelectedFrame();
71
72
  /// Clear the cache of frames.
73
  void Clear();
74
75
  void Dump(Stream *s);
76
77
  /// If \p stack_frame_ptr is contained in this StackFrameList, return its
78
  /// wrapping shared pointer.
79
  lldb::StackFrameSP
80
  GetStackFrameSPForStackFramePtr(StackFrame *stack_frame_ptr);
81
82
  size_t GetStatus(Stream &strm, uint32_t first_frame, uint32_t num_frames,
83
                   bool show_frame_info, uint32_t num_frames_with_source,
84
                   bool show_unique = false,
85
                   const char *frame_marker = nullptr);
86
87
protected:
88
  friend class Thread;
89
90
  bool SetFrameAtIndex(uint32_t idx, lldb::StackFrameSP &frame_sp);
91
92
  void GetFramesUpTo(uint32_t end_idx);
93
94
  void GetOnlyConcreteFramesUpTo(uint32_t end_idx, Unwind &unwinder);
95
96
  void SynthesizeTailCallFrames(StackFrame &next_frame);
97
98
85.6k
  bool GetAllFramesFetched() { return m_concrete_frames_fetched == UINT32_MAX; }
99
100
1.41k
  void SetAllFramesFetched() { m_concrete_frames_fetched = UINT32_MAX; }
101
102
  bool DecrementCurrentInlinedDepth();
103
104
  void ResetCurrentInlinedDepth();
105
106
  uint32_t GetCurrentInlinedDepth();
107
108
  void SetCurrentInlinedDepth(uint32_t new_depth);
109
110
  typedef std::vector<lldb::StackFrameSP> collection;
111
  typedef collection::iterator iterator;
112
  typedef collection::const_iterator const_iterator;
113
114
  /// The thread this frame list describes.
115
  Thread &m_thread;
116
117
  /// The old stack frame list.
118
  // TODO: The old stack frame list is used to fill in missing frame info
119
  // heuristically when it's otherwise unavailable (say, because the unwinder
120
  // fails). We should have stronger checks to make sure that this is a valid
121
  // source of information.
122
  lldb::StackFrameListSP m_prev_frames_sp;
123
124
  /// A mutex for this frame list.
125
  // TODO: This mutex may not always be held when required. In particular, uses
126
  // of the StackFrameList APIs in lldb_private::Thread look suspect. Consider
127
  // passing around a lock_guard reference to enforce proper locking.
128
  mutable std::recursive_mutex m_mutex;
129
130
  /// A cache of frames. This may need to be updated when the program counter
131
  /// changes.
132
  collection m_frames;
133
134
  /// The currently selected frame.
135
  uint32_t m_selected_frame_idx;
136
137
  /// The number of concrete frames fetched while filling the frame list. This
138
  /// is only used when synthetic frames are enabled.
139
  uint32_t m_concrete_frames_fetched;
140
141
  /// The number of synthetic function activations (invisible frames) expanded
142
  /// from the concrete frame #0 activation.
143
  // TODO: Use an optional instead of UINT32_MAX to denote invalid values.
144
  uint32_t m_current_inlined_depth;
145
146
  /// The program counter value at the currently selected synthetic activation.
147
  /// This is only valid if m_current_inlined_depth is valid.
148
  // TODO: Use an optional instead of UINT32_MAX to denote invalid values.
149
  lldb::addr_t m_current_inlined_pc;
150
151
  /// Whether or not to show synthetic (inline) frames. Immutable.
152
  const bool m_show_inlined_frames;
153
154
private:
155
  StackFrameList(const StackFrameList &) = delete;
156
  const StackFrameList &operator=(const StackFrameList &) = delete;
157
};
158
159
} // namespace lldb_private
160
161
#endif // LLDB_TARGET_STACKFRAMELIST_H