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 liblldb_StackFrameList_h_ 10 #define liblldb_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 uint32_t GetVisibleStackFrameIndex(uint32_t idx) { 56 if (m_current_inlined_depth < UINT32_MAX) 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. 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 static void Merge(std::unique_ptr<StackFrameList> &curr_up, 93 lldb::StackFrameListSP &prev_sp); 94 95 void GetFramesUpTo(uint32_t end_idx); 96 97 void GetOnlyConcreteFramesUpTo(uint32_t end_idx, Unwind *unwinder); 98 99 void SynthesizeTailCallFrames(StackFrame &next_frame); 100 101 bool GetAllFramesFetched() { return m_concrete_frames_fetched == UINT32_MAX; } 102 103 void SetAllFramesFetched() { m_concrete_frames_fetched = UINT32_MAX; } 104 105 bool DecrementCurrentInlinedDepth(); 106 107 void ResetCurrentInlinedDepth(); 108 109 uint32_t GetCurrentInlinedDepth(); 110 111 void SetCurrentInlinedDepth(uint32_t new_depth); 112 113 typedef std::vector<lldb::StackFrameSP> collection; 114 typedef collection::iterator iterator; 115 typedef collection::const_iterator const_iterator; 116 117 /// The thread this frame list describes. 118 Thread &m_thread; 119 120 /// The old stack frame list. 121 // TODO: The old stack frame list is used to fill in missing frame info 122 // heuristically when it's otherwise unavailable (say, because the unwinder 123 // fails). We should have stronger checks to make sure that this is a valid 124 // source of information. 125 lldb::StackFrameListSP m_prev_frames_sp; 126 127 /// A mutex for this frame list. 128 // TODO: This mutex may not always be held when required. In particular, uses 129 // of the StackFrameList APIs in lldb_private::Thread look suspect. Consider 130 // passing around a lock_guard reference to enforce proper locking. 131 mutable std::recursive_mutex m_mutex; 132 133 /// A cache of frames. This may need to be updated when the program counter 134 /// changes. 135 collection m_frames; 136 137 /// The currently selected frame. 138 uint32_t m_selected_frame_idx; 139 140 /// The number of concrete frames fetched while filling the frame list. This 141 /// is only used when synthetic frames are enabled. 142 uint32_t m_concrete_frames_fetched; 143 144 /// The number of synthetic function activations (invisible frames) expanded 145 /// from the concrete frame #0 activation. 146 // TODO: Use an optional instead of UINT32_MAX to denote invalid values. 147 uint32_t m_current_inlined_depth; 148 149 /// The program counter value at the currently selected synthetic activation. 150 /// This is only valid if m_current_inlined_depth is valid. 151 // TODO: Use an optional instead of UINT32_MAX to denote invalid values. 152 lldb::addr_t m_current_inlined_pc; 153 154 /// Whether or not to show synthetic (inline) frames. Immutable. 155 const bool m_show_inlined_frames; 156 157 private: 158 DISALLOW_COPY_AND_ASSIGN(StackFrameList); 159 }; 160 161 } // namespace lldb_private 162 163 #endif // liblldb_StackFrameList_h_ 164