Home       Trees       Indices       Help   
LLDB python API
Package lldb :: Class SBFrame
[hide private]
[frames] | no frames]

Class SBFrame

source code


Represents one of the stack frames associated with a thread.
SBThread contains SBFrame(s). For example (from test/lldbutil.py),

def print_stacktrace(thread, string_buffer = False):
    '''Prints a simple stack trace of this thread.'''

    ...

    for i in range(depth):
        frame = thread.GetFrameAtIndex(i)
        function = frame.GetFunction()

        load_addr = addrs[i].GetLoadAddress(target)
        if not function:
            file_addr = addrs[i].GetFileAddress()
            start_addr = frame.GetSymbol().GetStartAddress().GetFileAddress()
            symbol_offset = file_addr - start_addr
            print >> output, '  frame #{num}: {addr:#016x} {mod}`{symbol} + {offset}'.format(
                num=i, addr=load_addr, mod=mods[i], symbol=symbols[i], offset=symbol_offset)
        else:
            print >> output, '  frame #{num}: {addr:#016x} {mod}`{func} at {file}:{line} {args}'.format(
                num=i, addr=load_addr, mod=mods[i],
                func='%s [inlined]' % funcs[i] if frame.IsInlined() else funcs[i],
                file=files[i], line=lines[i],
                args=get_args_as_string(frame, showFuncName=False) if not frame.IsInlined() else '()')

    ...

And,

    for frame in thread:
        print frame

See also SBThread.
Instance Methods [hide private]
 
__repr__(self) source code
 
__init__(self, *args)
__init__(lldb::SBFrame self) -> SBFrame __init__(lldb::SBFrame self, SBFrame rhs) -> SBFrame		 source code
 
IsEqual(self, *args)
IsEqual(SBFrame self, SBFrame rhs) -> bool		 source code
 
IsValid(self)
IsValid(SBFrame self) -> bool		 source code
 
__nonzero__(self) source code
 
__bool__(self) source code
 
GetFrameID(self)
GetFrameID(SBFrame self) -> uint32_t		 source code
 
GetCFA(self)
GetCFA(SBFrame self) -> lldb::addr_t		 source code
 
GetPC(self)
GetPC(SBFrame self) -> lldb::addr_t		 source code
 
SetPC(self, *args)
SetPC(SBFrame self, lldb::addr_t new_pc) -> bool		 source code
 
GetSP(self)
GetSP(SBFrame self) -> lldb::addr_t		 source code
 
GetFP(self)
GetFP(SBFrame self) -> lldb::addr_t		 source code
 
GetPCAddress(self)
GetPCAddress(SBFrame self) -> SBAddress		 source code
 
GetSymbolContext(self, *args)
GetSymbolContext(SBFrame self, uint32_t resolve_scope) -> SBSymbolContext		 source code
 
GetModule(self)
GetModule(SBFrame self) -> SBModule		 source code
 
GetCompileUnit(self)
GetCompileUnit(SBFrame self) -> SBCompileUnit		 source code
 
GetFunction(self)
GetFunction(SBFrame self) -> SBFunction		 source code
 
GetSymbol(self)
GetSymbol(SBFrame self) -> SBSymbol		 source code
 
GetBlock(self)
GetBlock(SBFrame self) -> SBBlock		 source code
 
GetDisplayFunctionName(self)
GetDisplayFunctionName(SBFrame self) -> char const *		 source code
 
GetFunctionName(self, *args)
GetFunctionName(SBFrame self) -> char const GetFunctionName(SBFrame self) -> char const *		 source code
 
GuessLanguage(self)
GuessLanguage(SBFrame self) -> lldb::LanguageType		 source code
 
IsInlined(self, *args)
IsInlined(SBFrame self) -> bool IsInlined(SBFrame self) -> bool		 source code
 
IsArtificial(self, *args)
IsArtificial(SBFrame self) -> bool IsArtificial(SBFrame self) -> bool		 source code
 
EvaluateExpression(self, *args)
EvaluateExpression(SBFrame self, char const * expr) -> SBValue EvaluateExpression(SBFrame self, char const * expr, lldb::DynamicValueType use_dynamic) -> SBValue EvaluateExpression(SBFrame self, char const * expr, lldb::DynamicValueType use_dynamic, bool unwind_on_error) -> SBValue EvaluateExpression(SBFrame self, char const * expr, SBExpressionOptions options) -> SBValue		 source code
 
GetFrameBlock(self)
GetFrameBlock(SBFrame self) -> SBBlock		 source code
 
GetLineEntry(self)
GetLineEntry(SBFrame self) -> SBLineEntry		 source code
 
GetThread(self)
GetThread(SBFrame self) -> SBThread		 source code
 
Disassemble(self)
Disassemble(SBFrame self) -> char const *		 source code
 
Clear(self)
Clear(SBFrame self)		 source code
 
__eq__(self, *args)
__eq__(SBFrame self, SBFrame rhs) -> bool		 source code
 
__ne__(self, *args)
__ne__(SBFrame self, SBFrame rhs) -> bool		 source code
 
GetVariables(self, *args)
GetVariables(SBFrame self, bool arguments, bool locals, bool statics, bool in_scope_only) -> SBValueList GetVariables(SBFrame self, bool arguments, bool locals, bool statics, bool in_scope_only, lldb::DynamicValueType use_dynamic) -> SBValueList GetVariables(SBFrame self, SBVariablesOptions options) -> SBValueList		 source code
 
GetRegisters(self)
GetRegisters(SBFrame self) -> SBValueList		 source code
 
FindVariable(self, *args)
FindVariable(SBFrame self, char const * var_name) -> SBValue FindVariable(SBFrame self, char const * var_name, lldb::DynamicValueType use_dynamic) -> SBValue		 source code
 
FindRegister(self, *args)
FindRegister(SBFrame self, char const * name) -> SBValue		 source code
 
GetValueForVariablePath(self, *args)
GetValueForVariablePath(SBFrame self, char const * var_path) -> SBValue GetValueForVariablePath(SBFrame self, char const * var_path, lldb::DynamicValueType use_dynamic) -> SBValue		 source code
 
FindValue(self, *args)
FindValue(SBFrame self, char const * name, lldb::ValueType value_type) -> SBValue FindValue(SBFrame self, char const * name, lldb::ValueType value_type, lldb::DynamicValueType use_dynamic) -> SBValue		 source code
 
GetDescription(self, *args)
GetDescription(SBFrame self, SBStream description) -> bool		 source code
 
get_all_variables(self) source code
 
get_parent_frame(self) source code
 
get_arguments(self) source code
 
get_locals(self) source code
 
get_statics(self) source code
 
var(self, var_expr_path)
Calls through to lldb.SBFrame.GetValueForVariablePath() and returns a value that represents the variable expression path		 source code
 
get_registers_access(self) source code
 
__str__(self)
__str__(SBFrame self) -> PyObject *		 source code
Class Variables [hide private]
  __swig_setmethods__ = {}
  __setattr__ = lambda self, name, value:
  __swig_getmethods__ = {}
  __getattr__ = lambda self, name:
  __swig_destroy__ = _lldb.delete_SBFrame
  __del__ = lambda self:
Method Details [hide private]

GetCFA(self)

source code 

GetCFA(SBFrame self) -> lldb::addr_t

Get the Canonical Frame Address for this stack frame. This is the DWARF standard's definition of a CFA, a stack address that remains constant throughout the lifetime of the function. Returns an lldb::addr_t stack address, or LLDB_INVALID_ADDRESS if the CFA cannot be determined.

GetBlock(self)

source code 

GetBlock(SBFrame self) -> SBBlock

Gets the deepest block that contains the frame PC.

See also GetFrameBlock().

GetFunctionName(self, *args)

source code  

GetFunctionName(SBFrame self) -> char const
GetFunctionName(SBFrame self) -> char const *

Get the appropriate function name for this frame. Inlined functions in
LLDB are represented by Blocks that have inlined function information, so
just looking at the SBFunction or SBSymbol for a frame isn't enough.
This function will return the appropriate function, symbol or inlined
function name for the frame.

This function returns:
- the name of the inlined function (if there is one)
- the name of the concrete function (if there is one)
- the name of the symbol (if there is one)
- NULL

See also IsInlined().

GuessLanguage(self)

source code 

GuessLanguage(SBFrame self) -> lldb::LanguageType

Returns the language of the frame's SBFunction, or if there. is no SBFunction, guess the language from the mangled name. .

IsInlined(self, *args)

source code 

IsInlined(SBFrame self) -> bool IsInlined(SBFrame self) -> bool

Return true if this frame represents an inlined function.

See also GetFunctionName().

IsArtificial(self, *args)

source code 

IsArtificial(SBFrame self) -> bool IsArtificial(SBFrame self) -> bool

Return true if this frame is artificial (e.g a frame synthesized to capture a tail call). Local variables may not be available in an artificial frame.

EvaluateExpression(self, *args)

source code 

EvaluateExpression(SBFrame self, char const * expr) -> SBValue EvaluateExpression(SBFrame self, char const * expr, lldb::DynamicValueType use_dynamic) -> SBValue EvaluateExpression(SBFrame self, char const * expr, lldb::DynamicValueType use_dynamic, bool unwind_on_error) -> SBValue EvaluateExpression(SBFrame self, char const * expr, SBExpressionOptions options) -> SBValue

The version that doesn't supply a 'use_dynamic' value will use the target's default.

GetFrameBlock(self)

source code 

GetFrameBlock(SBFrame self) -> SBBlock

Gets the lexical block that defines the stack frame. Another way to think of this is it will return the block that contains all of the variables for a stack frame. Inlined functions are represented as SBBlock objects that have inlined function information: the name of the inlined function, where it was called from. The block that is returned will be the first block at or above the block for the PC (SBFrame::GetBlock()) that defines the scope of the frame. When a function contains no inlined functions, this will be the top most lexical block that defines the function. When a function has inlined functions and the PC is currently in one of those inlined functions, this method will return the inlined block that defines this frame. If the PC isn't currently in an inlined function, the lexical block that defines the function is returned.

GetVariables(self, *args)

source code 

GetVariables(SBFrame self, bool arguments, bool locals, bool statics, bool in_scope_only) -> SBValueList GetVariables(SBFrame self, bool arguments, bool locals, bool statics, bool in_scope_only, lldb::DynamicValueType use_dynamic) -> SBValueList GetVariables(SBFrame self, SBVariablesOptions options) -> SBValueList

The version that doesn't supply a 'use_dynamic' value will use the target's default.

FindVariable(self, *args)

source code 

FindVariable(SBFrame self, char const * var_name) -> SBValue FindVariable(SBFrame self, char const * var_name, lldb::DynamicValueType use_dynamic) -> SBValue

The version that doesn't supply a 'use_dynamic' value will use the target's default.

GetValueForVariablePath(self, *args)

source code  

GetValueForVariablePath(SBFrame self, char const * var_path) -> SBValue
GetValueForVariablePath(SBFrame self, char const * var_path, lldb::DynamicValueType use_dynamic) -> SBValue

Get a lldb.SBValue for a variable path.

Variable paths can include access to pointer or instance members:
    rect_ptr->origin.y
    pt.x
Pointer dereferences:
    *this->foo_ptr
    **argv
Address of:
    &pt
    &my_array[3].x
Array accesses and treating pointers as arrays:
    int_array[1]
    pt_ptr[22].x

Unlike EvaluateExpression() which returns lldb.SBValue objects
with constant copies of the values at the time of evaluation,
the result of this function is a value that will continue to
track the current value of the value as execution progresses
in the current frame.

FindValue(self, *args)

source code 

FindValue(SBFrame self, char const * name, lldb::ValueType value_type) -> SBValue FindValue(SBFrame self, char const * name, lldb::ValueType value_type, lldb::DynamicValueType use_dynamic) -> SBValue

Find variables, register sets, registers, or persistent variables using the frame as the scope.

The version that doesn't supply a 'use_dynamic' value will use the target's default.


   Home       Trees       Indices       Help   
LLDB python API
Generated by Epydoc 3.0.1 on Mon Nov 4 00:57:41 2019 http://epydoc.sourceforge.net