LLDB  mainline
StackFrameList.h
Go to the documentation of this file.
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 
21 public:
22  // Constructors and Destructors
23  StackFrameList(Thread &thread, const lldb::StackFrameListSP &prev_frames_sp,
24  bool show_inline_frames);
25 
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.
45 
46  /// Get the currently selected frame index.
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.
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.
57  return idx - m_current_inlined_depth;
58  else
59  return idx;
60  }
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.
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.
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
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 
99 
101 
103 
105 
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.
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.
133 
134  /// The currently selected frame.
136 
137  /// The number of concrete frames fetched while filling the frame list. This
138  /// is only used when synthetic frames are enabled.
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.
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.
150 
151  /// Whether or not to show synthetic (inline) frames. Immutable.
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
lldb_private::StackFrameList::SetSelectedFrame
uint32_t SetSelectedFrame(lldb_private::StackFrame *frame)
Mark a stack frame as the currently selected frame and return its index.
Definition: StackFrameList.cpp:779
lldb_private::StackFrameList::Clear
void Clear()
Clear the cache of frames.
Definition: StackFrameList.cpp:823
lldb_private::StackFrameList::GetNumFrames
uint32_t GetNumFrames(bool can_create=true)
Get the number of visible frames.
Definition: StackFrameList.cpp:618
lldb_private::StackFrameList::m_current_inlined_pc
lldb::addr_t m_current_inlined_pc
The program counter value at the currently selected synthetic activation.
Definition: StackFrameList.h:149
lldb_private::StackFrameList::SetCurrentInlinedDepth
void SetCurrentInlinedDepth(uint32_t new_depth)
Definition: StackFrameList.cpp:215
lldb_private::StackFrameList::DecrementCurrentInlinedDepth
bool DecrementCurrentInlinedDepth()
Definition: StackFrameList.cpp:202
lldb_private::StackFrameList::m_thread
Thread & m_thread
The thread this frame list describes.
Definition: StackFrameList.h:115
StackFrame.h
lldb_private::Stream
Definition: Stream.h:28
lldb::addr_t
uint64_t addr_t
Definition: lldb-types.h:83
lldb_private::StackFrameList::GetAllFramesFetched
bool GetAllFramesFetched()
Definition: StackFrameList.h:98
lldb_private::StackFrameList::GetStackFrameSPForStackFramePtr
lldb::StackFrameSP GetStackFrameSPForStackFramePtr(StackFrame *stack_frame_ptr)
If stack_frame_ptr is contained in this StackFrameList, return its wrapping shared pointer.
Definition: StackFrameList.cpp:830
lldb_private::StackFrameList::SetAllFramesFetched
void SetAllFramesFetched()
Definition: StackFrameList.h:100
lldb_private::StackFrameList
Definition: StackFrameList.h:20
lldb_private::StackFrameList::GetStatus
size_t GetStatus(Stream &strm, uint32_t first_frame, uint32_t num_frames, bool show_frame_info, uint32_t num_frames_with_source, bool show_unique=false, const char *frame_marker=nullptr)
Definition: StackFrameList.cpp:845
lldb_private::StackFrameList::StackFrameList
StackFrameList(Thread &thread, const lldb::StackFrameListSP &prev_frames_sp, bool show_inline_frames)
Definition: StackFrameList.cpp:35
lldb_private::Thread
Definition: Thread.h:60
lldb_private::StackFrameList::GetFramesUpTo
void GetFramesUpTo(uint32_t end_idx)
Definition: StackFrameList.cpp:436
lldb_private::StackFrameList::GetVisibleStackFrameIndex
uint32_t GetVisibleStackFrameIndex(uint32_t idx)
If the current inline depth (i.e the number of invisible frames) is valid, subtract it from idx.
Definition: StackFrameList.h:55
lldb_private::StackFrameList::GetSelectedFrameIndex
uint32_t GetSelectedFrameIndex() const
Get the currently selected frame index.
Definition: StackFrameList.cpp:774
lldb_private::StackFrameList::m_current_inlined_depth
uint32_t m_current_inlined_depth
The number of synthetic function activations (invisible frames) expanded from the concrete frame #0 a...
Definition: StackFrameList.h:144
lldb_private::StackFrameList::operator=
const StackFrameList & operator=(const StackFrameList &)=delete
lldb_private::StackFrameList::m_mutex
std::recursive_mutex m_mutex
A mutex for this frame list.
Definition: StackFrameList.h:128
lldb_private::StackFrameList::SetFrameAtIndex
bool SetFrameAtIndex(uint32_t idx, lldb::StackFrameSP &frame_sp)
Definition: StackFrameList.cpp:763
lldb_private::StackFrameList::SynthesizeTailCallFrames
void SynthesizeTailCallFrames(StackFrame &next_frame)
Given that next_frame will be appended to the frame list, synthesize tail call frames between the cur...
Definition: StackFrameList.cpp:365
lldb_private::StackFrameList::GetFrameAtIndex
lldb::StackFrameSP GetFrameAtIndex(uint32_t idx)
Get the frame at index idx. Invisible frames cannot be indexed.
Definition: StackFrameList.cpp:647
lldb_private::StackFrameList::GetFrameWithStackID
lldb::StackFrameSP GetFrameWithStackID(const StackID &stack_id)
Retrieve the stack frame with the given ID stack_id.
Definition: StackFrameList.cpp:736
lldb_private::StackFrameList::ResetCurrentInlinedDepth
void ResetCurrentInlinedDepth()
Definition: StackFrameList.cpp:80
lldb_private::StackFrameList::m_prev_frames_sp
lldb::StackFrameListSP m_prev_frames_sp
The old stack frame list.
Definition: StackFrameList.h:122
uint32_t
lldb_private::StackFrameList::collection
std::vector< lldb::StackFrameSP > collection
Definition: StackFrameList.h:110
lldb_private::StackFrameList::GetOnlyConcreteFramesUpTo
void GetOnlyConcreteFramesUpTo(uint32_t end_idx, Unwind &unwinder)
Definition: StackFrameList.cpp:223
lldb_private::StackFrameList::~StackFrameList
~StackFrameList()
Definition: StackFrameList.cpp:49
UINT32_MAX
#define UINT32_MAX
Definition: lldb-defines.h:31
lldb_private::StackFrameList::const_iterator
collection::const_iterator const_iterator
Definition: StackFrameList.h:112
lldb_private::StackFrameList::m_show_inlined_frames
const bool m_show_inlined_frames
Whether or not to show synthetic (inline) frames. Immutable.
Definition: StackFrameList.h:152
lldb_private::StackFrameList::GetFrameWithConcreteFrameIndex
lldb::StackFrameSP GetFrameWithConcreteFrameIndex(uint32_t unwind_idx)
Get the first concrete frame with index greater than or equal to idx.
Definition: StackFrameList.cpp:714
lldb_private::StackFrameList::iterator
collection::iterator iterator
Definition: StackFrameList.h:111
lldb_private
A class that represents a running process on the host machine.
Definition: SBCommandInterpreterRunOptions.h:16
lldb_private::StackFrameList::m_frames
collection m_frames
A cache of frames.
Definition: StackFrameList.h:132
lldb_private::StackFrameList::GetCurrentInlinedDepth
uint32_t GetCurrentInlinedDepth()
Definition: StackFrameList.cpp:62
lldb_private::StackID
Definition: StackID.h:17
lldb_private::StackFrameList::Dump
void Dump(Stream *s)
Definition: StackFrameList.cpp:627
lldb_private::StackFrame
Definition: StackFrame.h:40
lldb_private::StackFrameList::SetDefaultFileAndLineToSelectedFrame
void SetDefaultFileAndLineToSelectedFrame()
If the currently selected frame comes from the currently selected thread, point the default file and ...
Definition: StackFrameList.cpp:808
lldb_private::Unwind
Definition: Unwind.h:18
lldb_private::StackFrameList::CalculateCurrentInlinedDepth
void CalculateCurrentInlinedDepth()
Calculate and set the current inline depth.
Definition: StackFrameList.cpp:55
lldb_private::StackFrameList::SetSelectedFrameByIndex
bool SetSelectedFrameByIndex(uint32_t idx)
Mark a stack frame as the currently selected frame using the frame index idx.
Definition: StackFrameList.cpp:798
lldb_private::StackFrameList::m_concrete_frames_fetched
uint32_t m_concrete_frames_fetched
The number of concrete frames fetched while filling the frame list.
Definition: StackFrameList.h:139
lldb_private::StackFrameList::m_selected_frame_idx
uint32_t m_selected_frame_idx
The currently selected frame.
Definition: StackFrameList.h:135