LLDB mainline
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
lldb_private::StackFrameList Class Reference

#include <StackFrameList.h>

Public Member Functions

 StackFrameList (Thread &thread, const lldb::StackFrameListSP &prev_frames_sp, bool show_inline_frames)
 
 ~StackFrameList ()
 
uint32_t GetNumFrames (bool can_create=true)
 Get the number of visible frames.
 
lldb::StackFrameSP GetFrameAtIndex (uint32_t idx)
 Get the frame at index idx. Invisible frames cannot be indexed.
 
lldb::StackFrameSP GetFrameWithConcreteFrameIndex (uint32_t unwind_idx)
 Get the first concrete frame with index greater than or equal to idx.
 
lldb::StackFrameSP GetFrameWithStackID (const StackID &stack_id)
 Retrieve the stack frame with the given ID stack_id.
 
uint32_t SetSelectedFrame (lldb_private::StackFrame *frame)
 Mark a stack frame as the currently selected frame and return its index.
 
uint32_t GetSelectedFrameIndex (SelectMostRelevant select_most_relevant_frame)
 Get the currently selected frame index.
 
bool SetSelectedFrameByIndex (uint32_t idx)
 Mark a stack frame as the currently selected frame using the frame index idx.
 
uint32_t GetVisibleStackFrameIndex (uint32_t idx)
 If the current inline depth (i.e the number of invisible frames) is valid, subtract it from idx.
 
void CalculateCurrentInlinedDepth ()
 Calculate and set the current inline depth.
 
void SetDefaultFileAndLineToSelectedFrame ()
 If the currently selected frame comes from the currently selected thread, point the default file and line of the thread's target to the location specified by the frame.
 
void Clear ()
 Clear the cache of frames.
 
void Dump (Stream *s)
 
lldb::StackFrameSP GetStackFrameSPForStackFramePtr (StackFrame *stack_frame_ptr)
 If stack_frame_ptr is contained in this StackFrameList, return its wrapping shared pointer.
 
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)
 

Protected Types

typedef std::vector< lldb::StackFrameSPcollection
 
typedef collection::iterator iterator
 
typedef collection::const_iterator const_iterator
 

Protected Member Functions

bool SetFrameAtIndex (uint32_t idx, lldb::StackFrameSP &frame_sp)
 
bool GetFramesUpTo (uint32_t end_idx, InterruptionControl allow_interrupt=AllowInterruption)
 Realizes frames up to (and including) end_idx (which can be greater than
the actual number of frames.)
Returns true if the function was interrupted, false otherwise.
 
void GetOnlyConcreteFramesUpTo (uint32_t end_idx, Unwind &unwinder)
 
void SynthesizeTailCallFrames (StackFrame &next_frame)
 Given that next_frame will be appended to the frame list, synthesize tail call frames between the current end of the list and next_frame.
 
bool GetAllFramesFetched ()
 
void SetAllFramesFetched ()
 
bool DecrementCurrentInlinedDepth ()
 
void ResetCurrentInlinedDepth ()
 
uint32_t GetCurrentInlinedDepth ()
 
void SetCurrentInlinedDepth (uint32_t new_depth)
 
void SelectMostRelevantFrame ()
 

Protected Attributes

Threadm_thread
 The thread this frame list describes.
 
lldb::StackFrameListSP m_prev_frames_sp
 The old stack frame list.
 
std::recursive_mutex m_mutex
 A mutex for this frame list.
 
collection m_frames
 A cache of frames.
 
std::optional< uint32_t > m_selected_frame_idx
 The currently selected frame.
 
uint32_t m_concrete_frames_fetched
 The number of concrete frames fetched while filling the frame list.
 
uint32_t m_current_inlined_depth
 The number of synthetic function activations (invisible frames) expanded from the concrete frame #0 activation.
 
lldb::addr_t m_current_inlined_pc
 The program counter value at the currently selected synthetic activation.
 
const bool m_show_inlined_frames
 Whether or not to show synthetic (inline) frames. Immutable.
 

Private Member Functions

 StackFrameList (const StackFrameList &)=delete
 
const StackFrameListoperator= (const StackFrameList &)=delete
 

Friends

class Thread
 
class ScriptedThread
 

Detailed Description

Definition at line 22 of file StackFrameList.h.

Member Typedef Documentation

◆ collection

Definition at line 127 of file StackFrameList.h.

◆ const_iterator

typedef collection::const_iterator lldb_private::StackFrameList::const_iterator
protected

Definition at line 129 of file StackFrameList.h.

◆ iterator

typedef collection::iterator lldb_private::StackFrameList::iterator
protected

Definition at line 128 of file StackFrameList.h.

Constructor & Destructor Documentation

◆ StackFrameList() [1/2]

StackFrameList::StackFrameList ( Thread thread,
const lldb::StackFrameListSP prev_frames_sp,
bool  show_inline_frames 
)

Definition at line 38 of file StackFrameList.cpp.

References m_current_inlined_depth, and m_current_inlined_pc.

◆ ~StackFrameList()

StackFrameList::~StackFrameList ( )

Definition at line 52 of file StackFrameList.cpp.

References Clear().

◆ StackFrameList() [2/2]

lldb_private::StackFrameList::StackFrameList ( const StackFrameList )
privatedelete

Member Function Documentation

◆ CalculateCurrentInlinedDepth()

void StackFrameList::CalculateCurrentInlinedDepth ( )

Calculate and set the current inline depth.

This may be used to update the StackFrameList's set of inline frames when execution stops, e.g when a breakpoint is hit.

Definition at line 58 of file StackFrameList.cpp.

References GetCurrentInlinedDepth(), ResetCurrentInlinedDepth(), and UINT32_MAX.

◆ Clear()

void StackFrameList::Clear ( )

Clear the cache of frames.

Definition at line 901 of file StackFrameList.cpp.

References m_concrete_frames_fetched, m_frames, m_mutex, and m_selected_frame_idx.

Referenced by ~StackFrameList().

◆ DecrementCurrentInlinedDepth()

bool StackFrameList::DecrementCurrentInlinedDepth ( )
protected

◆ Dump()

void StackFrameList::Dump ( Stream s)

◆ GetAllFramesFetched()

bool lldb_private::StackFrameList::GetAllFramesFetched ( )
inlineprotected

Definition at line 113 of file StackFrameList.h.

References m_concrete_frames_fetched, and UINT32_MAX.

Referenced by GetFramesUpTo().

◆ GetCurrentInlinedDepth()

uint32_t StackFrameList::GetCurrentInlinedDepth ( )
protected

◆ GetFrameAtIndex()

StackFrameSP StackFrameList::GetFrameAtIndex ( uint32_t  idx)

◆ GetFramesUpTo()

bool StackFrameList::GetFramesUpTo ( uint32_t  end_idx,
InterruptionControl  allow_interrupt = AllowInterruption 
)
protected

◆ GetFrameWithConcreteFrameIndex()

StackFrameSP StackFrameList::GetFrameWithConcreteFrameIndex ( uint32_t  unwind_idx)

Get the first concrete frame with index greater than or equal to idx.

Unlike GetFrameAtIndex, this cannot return a synthetic frame.

Definition at line 741 of file StackFrameList.cpp.

References GetFrameAtIndex().

◆ GetFrameWithStackID()

StackFrameSP StackFrameList::GetFrameWithStackID ( const StackID stack_id)

Retrieve the stack frame with the given ID stack_id.

Definition at line 763 of file StackFrameList.cpp.

References CompareStackID(), GetFrameAtIndex(), lldb_private::StackID::IsValid(), m_frames, and m_mutex.

◆ GetNumFrames()

uint32_t StackFrameList::GetNumFrames ( bool  can_create = true)

Get the number of visible frames.

Frames may be created if can_create is true. Synthetic (inline) frames expanded from the concrete frame #0 (aka invisible frames) are not included in this count.

Definition at line 638 of file StackFrameList.cpp.

References DoNotAllowInterruption, GetFramesUpTo(), GetVisibleStackFrameIndex(), m_frames, m_mutex, and UINT32_MAX.

◆ GetOnlyConcreteFramesUpTo()

void StackFrameList::GetOnlyConcreteFramesUpTo ( uint32_t  end_idx,
Unwind unwinder 
)
protected

◆ GetSelectedFrameIndex()

uint32_t StackFrameList::GetSelectedFrameIndex ( SelectMostRelevant  select_most_relevant_frame)

Get the currently selected frame index.

We should only call SelectMostRelevantFrame if (a) the user hasn't already selected a frame, and (b) if this really is a user facing "GetSelectedFrame". SMRF runs the frame recognizers which can do arbitrary work that ends up being dangerous to do internally. Also, for most internal uses we don't actually want the frame changed by the SMRF logic. So unless this is in a command or SB API, you should pass false here.

Definition at line 834 of file StackFrameList.cpp.

References m_mutex, m_selected_frame_idx, and SelectMostRelevantFrame().

Referenced by SetDefaultFileAndLineToSelectedFrame().

◆ GetStackFrameSPForStackFramePtr()

lldb::StackFrameSP StackFrameList::GetStackFrameSPForStackFramePtr ( StackFrame stack_frame_ptr)

If stack_frame_ptr is contained in this StackFrameList, return its wrapping shared pointer.

Definition at line 909 of file StackFrameList.cpp.

References m_frames.

◆ GetStatus()

size_t StackFrameList::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 
)

◆ GetVisibleStackFrameIndex()

uint32_t lldb_private::StackFrameList::GetVisibleStackFrameIndex ( uint32_t  idx)
inline

If the current inline depth (i.e the number of invisible frames) is valid, subtract it from idx.

Otherwise simply return idx.

Definition at line 65 of file StackFrameList.h.

References m_current_inlined_depth, and UINT32_MAX.

Referenced by GetNumFrames().

◆ operator=()

const StackFrameList & lldb_private::StackFrameList::operator= ( const StackFrameList )
privatedelete

◆ ResetCurrentInlinedDepth()

void StackFrameList::ResetCurrentInlinedDepth ( )
protected

◆ SelectMostRelevantFrame()

void StackFrameList::SelectMostRelevantFrame ( )
protected

◆ SetAllFramesFetched()

void lldb_private::StackFrameList::SetAllFramesFetched ( )
inlineprotected

Definition at line 115 of file StackFrameList.h.

References m_concrete_frames_fetched, and UINT32_MAX.

Referenced by GetFramesUpTo().

◆ SetCurrentInlinedDepth()

void StackFrameList::SetCurrentInlinedDepth ( uint32_t  new_depth)
protected

◆ SetDefaultFileAndLineToSelectedFrame()

void StackFrameList::SetDefaultFileAndLineToSelectedFrame ( )

If the currently selected frame comes from the currently selected thread, point the default file and line of the thread's target to the location specified by the frame.

Definition at line 880 of file StackFrameList.cpp.

References lldb_private::Thread::CalculateTarget(), DoNoSelectMostRelevantFrame, lldb_private::LineEntry::GetFile(), GetFrameAtIndex(), lldb_private::UserID::GetID(), lldb_private::Thread::GetProcess(), GetSelectedFrameIndex(), lldb_private::LineEntry::line, lldb_private::SymbolContext::line_entry, and m_thread.

Referenced by SetSelectedFrame().

◆ SetFrameAtIndex()

bool StackFrameList::SetFrameAtIndex ( uint32_t  idx,
lldb::StackFrameSP frame_sp 
)
protected

Definition at line 790 of file StackFrameList.cpp.

References m_frames.

Referenced by GetFrameAtIndex().

◆ SetSelectedFrame()

uint32_t StackFrameList::SetSelectedFrame ( lldb_private::StackFrame frame)

Mark a stack frame as the currently selected frame and return its index.

Definition at line 849 of file StackFrameList.cpp.

References GetCurrentInlinedDepth(), m_frames, m_mutex, m_selected_frame_idx, SetDefaultFileAndLineToSelectedFrame(), and UINT32_MAX.

Referenced by SelectMostRelevantFrame(), and SetSelectedFrameByIndex().

◆ SetSelectedFrameByIndex()

bool StackFrameList::SetSelectedFrameByIndex ( uint32_t  idx)

Mark a stack frame as the currently selected frame using the frame index idx.

Like GetFrameAtIndex, invisible frames cannot be selected.

Definition at line 870 of file StackFrameList.cpp.

References GetFrameAtIndex(), m_mutex, and SetSelectedFrame().

◆ SynthesizeTailCallFrames()

void StackFrameList::SynthesizeTailCallFrames ( StackFrame next_frame)
protected

Given that next_frame will be appended to the frame list, synthesize tail call frames between the current end of the list and next_frame.

If any frames are added, adjust the frame index of next_frame.


| ... | <- Completed frames.

| prev_frame |

| ... | <- Artificial frames inserted here.

| next_frame |

| ... | <- Not-yet-visited frames.

Definition at line 369 of file StackFrameList.cpp.

References lldb_private::StackFrame::Artificial, lldb_private::Function::CalculateSymbolContext(), lldb_private::StackFrame::CalculateTarget(), lldb_private::CallEdge::Call, FindInterveningFrames(), lldb_private::SymbolContext::function, lldb_private::StackFrame::GetConcreteFrameIndex(), lldb_private::Function::GetDisplayName(), lldb_private::GetLog(), lldb_private::StackFrame::GetRegisterContext(), lldb_private::StackFrame::GetSymbolContext(), LLDB_INVALID_ADDRESS, LLDB_LOG, m_frames, m_thread, pc, lldb_private::StackFrame::SetFrameIndex(), lldb_private::ExecutionContext::SetFramePtr(), and lldb_private::Step.

Referenced by GetFramesUpTo().

Friends And Related Function Documentation

◆ ScriptedThread

friend class ScriptedThread
friend

Definition at line 99 of file StackFrameList.h.

◆ Thread

friend class Thread
friend

Definition at line 98 of file StackFrameList.h.

Member Data Documentation

◆ m_concrete_frames_fetched

uint32_t lldb_private::StackFrameList::m_concrete_frames_fetched
protected

The number of concrete frames fetched while filling the frame list.

This is only used when synthetic frames are enabled.

Definition at line 158 of file StackFrameList.h.

Referenced by Clear(), GetAllFramesFetched(), GetFramesUpTo(), GetOnlyConcreteFramesUpTo(), and SetAllFramesFetched().

◆ m_current_inlined_depth

uint32_t lldb_private::StackFrameList::m_current_inlined_depth
protected

The number of synthetic function activations (invisible frames) expanded from the concrete frame #0 activation.

Definition at line 163 of file StackFrameList.h.

Referenced by DecrementCurrentInlinedDepth(), GetCurrentInlinedDepth(), GetVisibleStackFrameIndex(), ResetCurrentInlinedDepth(), SetCurrentInlinedDepth(), and StackFrameList().

◆ m_current_inlined_pc

lldb::addr_t lldb_private::StackFrameList::m_current_inlined_pc
protected

The program counter value at the currently selected synthetic activation.

This is only valid if m_current_inlined_depth is valid.

Definition at line 168 of file StackFrameList.h.

Referenced by GetCurrentInlinedDepth(), ResetCurrentInlinedDepth(), SetCurrentInlinedDepth(), and StackFrameList().

◆ m_frames

collection lldb_private::StackFrameList::m_frames
protected

◆ m_mutex

std::recursive_mutex lldb_private::StackFrameList::m_mutex
mutableprotected

◆ m_prev_frames_sp

lldb::StackFrameListSP lldb_private::StackFrameList::m_prev_frames_sp
protected

The old stack frame list.

Definition at line 139 of file StackFrameList.h.

Referenced by GetFramesUpTo().

◆ m_selected_frame_idx

std::optional<uint32_t> lldb_private::StackFrameList::m_selected_frame_idx
protected

The currently selected frame.

An optional is used to record whether anyone has set the selected frame on this stack yet. We only let recognizers change the frame if this is the first time GetSelectedFrame is called.

Definition at line 154 of file StackFrameList.h.

Referenced by Clear(), GetSelectedFrameIndex(), and SetSelectedFrame().

◆ m_show_inlined_frames

const bool lldb_private::StackFrameList::m_show_inlined_frames
protected

Whether or not to show synthetic (inline) frames. Immutable.

Definition at line 171 of file StackFrameList.h.

Referenced by DecrementCurrentInlinedDepth(), GetCurrentInlinedDepth(), GetFrameAtIndex(), GetFramesUpTo(), and ResetCurrentInlinedDepth().

◆ m_thread

Thread& lldb_private::StackFrameList::m_thread
protected

The documentation for this class was generated from the following files: