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]
 
__setattr__(self, name, value)
x.__setattr__('name', value) <==> x.name = value		 source code
 
__getattr__(self, name) source code
 
__repr__(self)
repr(x)		 source code
 
__init__(self, *args)
__init__(lldb::SBFrame self) -> SBFrame __init__(lldb::SBFrame self, SBFrame rhs) -> SBFrame		 source code
 
__swig_destroy__(...)
delete_SBFrame(SBFrame self)
 
__del__(self) source code
 
IsEqual(self, *args)
IsEqual(SBFrame self, SBFrame rhs) -> bool		 source code
 
__nonzero__(self) source code
 
IsValid(self)
IsValid(SBFrame self) -> bool		 source code
 
GetFrameID(self)
GetFrameID(SBFrame self) -> uint32_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
 
GetFunctionName(self)
GetFunctionName(SBFrame self) -> str const *		 source code
 
IsInlined(self)
IsInlined(SBFrame self) -> bool		 source code
 
EvaluateExpression(self, *args)
EvaluateExpression(SBFrame self, str const * expr) -> SBValue EvaluateExpression(SBFrame self, str const * expr, lldb::DynamicValueType use_dynamic) -> SBValue EvaluateExpression(SBFrame self, str const * expr, lldb::DynamicValueType use_dynamic, bool unwind_on_error) -> SBValue EvaluateExpression(SBFrame self, str 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) -> str const *		 source code
 
Clear(self)
Clear(SBFrame self)		 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		 source code
 
GetRegisters(self)
GetRegisters(SBFrame self) -> SBValueList		 source code
 
FindVariable(self, *args)
FindVariable(SBFrame self, str const * var_name) -> SBValue FindVariable(SBFrame self, str const * var_name, lldb::DynamicValueType use_dynamic) -> SBValue		 source code
 
GetValueForVariablePath(self, *args)
GetValueForVariablePath(SBFrame self, str const * var_path) -> SBValue GetValueForVariablePath(SBFrame self, str const * var_path, lldb::DynamicValueType use_dynamic) -> SBValue		 source code
 
FindValue(self, *args)
FindValue(SBFrame self, str const * name, lldb::ValueType value_type) -> SBValue FindValue(SBFrame self, str 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_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
 
__str__(self)
__str__(SBFrame self) -> PyObject *		 source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __sizeof__, __subclasshook__

Class Variables [hide private]
  __swig_setmethods__ = {}
  __swig_getmethods__ = {}
Properties [hide private]
  addr
A read only property that returns the program counter (PC) as a section offset address (lldb.SBAddress).
  args
A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the argument variables in this stack frame.
  arguments
A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the argument variables in this stack frame.
  block
A read only property that returns an lldb object that represents the block (lldb.SBBlock) for this stack frame.
  compile_unit
A read only property that returns an lldb object that represents the compile unit (lldb.SBCompileUnit) for this stack frame.
  disassembly
A read only property that returns the disassembly for this stack frame as a python string.
  fp
A read only property that returns the frame pointer (FP) as an unsigned integer.
  function
A read only property that returns an lldb object that represents the function (lldb.SBFunction) for this stack frame.
  idx
A read only property that returns the zero based stack frame index.
  is_inlined
A read only property that returns an boolean that indicates if the block frame is an inlined function.
  line_entry
A read only property that returns an lldb object that represents the line table entry (lldb.SBLineEntry) for this stack frame.
  locals
A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the local variables in this stack frame.
  module
A read only property that returns an lldb object that represents the module (lldb.SBModule) for this stack frame.
  name
A read only property that retuns the name for the function that this frame represents.
  pc
GetPC(SBFrame self) -> lldb::addr_t
  registers
A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the CPU registers for this stack frame.
  regs
A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the CPU registers for this stack frame.
  sp
A read only property that returns the stack pointer (SP) as an unsigned integer.
  statics
A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the static variables in this stack frame.
  symbol
A read only property that returns an lldb object that represents the symbol (lldb.SBSymbol) for this stack frame.
  thread
A read only property that returns an lldb object that represents the thread (lldb.SBThread) for this stack frame.
  variables
A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the variables in this stack frame.
  vars
A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the variables in this stack frame.

Inherited from object: __class__

Method Details [hide private]

__setattr__(self, name, value)

source code 

x.__setattr__('name', value) <==> x.name = value

Overrides: object.__setattr__
(inherited documentation)

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

__init__(self, *args)
(Constructor)

source code 

__init__(lldb::SBFrame self) -> SBFrame __init__(lldb::SBFrame self, SBFrame rhs) -> SBFrame

Overrides: object.__init__

GetBlock(self)

source code 

GetBlock(SBFrame self) -> SBBlock

Gets the deepest block that contains the frame PC.

See also GetFrameBlock().

GetFunctionName(self)

source code  

GetFunctionName(SBFrame self) -> str 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 appriopriate 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().

IsInlined(self)

source code 

IsInlined(SBFrame self) -> bool

Return true if this frame represents an inlined function.

See also GetFunctionName().

EvaluateExpression(self, *args)

source code 

EvaluateExpression(SBFrame self, str const * expr) -> SBValue EvaluateExpression(SBFrame self, str const * expr, lldb::DynamicValueType use_dynamic) -> SBValue EvaluateExpression(SBFrame self, str const * expr, lldb::DynamicValueType use_dynamic, bool unwind_on_error) -> SBValue EvaluateExpression(SBFrame self, str 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

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

FindVariable(self, *args)

source code 

FindVariable(SBFrame self, str const * var_name) -> SBValue FindVariable(SBFrame self, str 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, str const * var_path) -> SBValue
GetValueForVariablePath(SBFrame self, str 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, str const * name, lldb::ValueType value_type) -> SBValue FindValue(SBFrame self, str 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.

__str__(self)
(Informal representation operator)

source code 

__str__(SBFrame self) -> PyObject *

Overrides: object.__str__

Property Details [hide private]

addr

A read only property that returns the program counter (PC) as a section offset address (lldb.SBAddress).

Get Method:
GetPCAddress(self) - GetPCAddress(SBFrame self) -> SBAddress

args

A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the argument variables in this stack frame.

Get Method:
get_arguments(self)

arguments

A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the argument variables in this stack frame.

Get Method:
get_arguments(self)

block

A read only property that returns an lldb object that represents the block (lldb.SBBlock) for this stack frame.

Get Method:
GetBlock(self) - GetBlock(SBFrame self) -> SBBlock

compile_unit

A read only property that returns an lldb object that represents the compile unit (lldb.SBCompileUnit) for this stack frame.

Get Method:
GetCompileUnit(self) - GetCompileUnit(SBFrame self) -> SBCompileUnit

disassembly

A read only property that returns the disassembly for this stack frame as a python string.

Get Method:
Disassemble(self) - Disassemble(SBFrame self) -> str const *

fp

A read only property that returns the frame pointer (FP) as an unsigned integer.

Get Method:
GetFP(self) - GetFP(SBFrame self) -> lldb::addr_t

function

A read only property that returns an lldb object that represents the function (lldb.SBFunction) for this stack frame.

Get Method:
GetFunction(self) - GetFunction(SBFrame self) -> SBFunction

idx

A read only property that returns the zero based stack frame index.

Get Method:
GetFrameID(self) - GetFrameID(SBFrame self) -> uint32_t

is_inlined

A read only property that returns an boolean that indicates if the block frame is an inlined function.

Get Method:
IsInlined(self) - IsInlined(SBFrame self) -> bool

line_entry

A read only property that returns an lldb object that represents the line table entry (lldb.SBLineEntry) for this stack frame.

Get Method:
GetLineEntry(self) - GetLineEntry(SBFrame self) -> SBLineEntry

locals

A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the local variables in this stack frame.

Get Method:
get_locals(self)

module

A read only property that returns an lldb object that represents the module (lldb.SBModule) for this stack frame.

Get Method:
GetModule(self) - GetModule(SBFrame self) -> SBModule

name

A read only property that retuns the name for the function that this frame represents. Inlined stack frame might have a concrete function that differs from the name of the inlined function (a named lldb.SBBlock).

Get Method:
GetFunctionName(self) - GetFunctionName(SBFrame self) -> str const *

pc

GetPC(SBFrame self) -> lldb::addr_t

Get Method:
GetPC(self) - GetPC(SBFrame self) -> lldb::addr_t
Set Method:
SetPC(self, *args) - SetPC(SBFrame self, lldb::addr_t new_pc) -> bool

registers

A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the CPU registers for this stack frame.

Get Method:
GetRegisters(self) - GetRegisters(SBFrame self) -> SBValueList

regs

A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the CPU registers for this stack frame.

Get Method:
GetRegisters(self) - GetRegisters(SBFrame self) -> SBValueList

sp

A read only property that returns the stack pointer (SP) as an unsigned integer.

Get Method:
GetSP(self) - GetSP(SBFrame self) -> lldb::addr_t

statics

A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the static variables in this stack frame.

Get Method:
get_statics(self)

symbol

A read only property that returns an lldb object that represents the symbol (lldb.SBSymbol) for this stack frame.

Get Method:
GetSymbol(self) - GetSymbol(SBFrame self) -> SBSymbol

thread

A read only property that returns an lldb object that represents the thread (lldb.SBThread) for this stack frame.

Get Method:
GetThread(self) - GetThread(SBFrame self) -> SBThread

variables

A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the variables in this stack frame.

Get Method:
get_all_variables(self)

vars

A read only property that returns a list() that contains a collection of lldb.SBValue objects that represent the variables in this stack frame.

Get Method:
get_all_variables(self)

   Trees       Indices       Help   
LLDB python API
Generated by Epydoc 3.0.1 on Fri Jul 19 13:22:35 2013 http://epydoc.sourceforge.net