SBAddress

class lldb.SBAddress(*args)

A section + offset based address class.

The SBAddress class allows addresses to be relative to a section that can move during runtime due to images (executables, shared libraries, bundles, frameworks) being loaded at different addresses than the addresses found in the object file that represents them on disk. There are currently two types of addresses for a section:

  • file addresses
  • load addresses

File addresses represents the virtual addresses that are in the ‘on disk’ object files. These virtual addresses are converted to be relative to unique sections scoped to the object file so that when/if the addresses slide when the images are loaded/unloaded in memory, we can easily track these changes without having to update every object (compile unit ranges, line tables, function address ranges, lexical block and inlined subroutine address ranges, global and static variables) each time an image is loaded or unloaded.

Load addresses represents the virtual addresses where each section ends up getting loaded at runtime. Before executing a program, it is common for all of the load addresses to be unresolved. When a DynamicLoader plug-in receives notification that shared libraries have been loaded/unloaded, the load addresses of the main executable and any images (shared libraries) will be resolved/unresolved. When this happens, breakpoints that are in one of these sections can be set/cleared.

See docstring of SBFunction for example usage of SBAddress.

Attributes Summary

block A read only property that returns an lldb object that represents the block (lldb.SBBlock) that this address resides within.
compile_unit A read only property that returns an lldb object that represents the compile unit (lldb.SBCompileUnit) that this address resides within.
file_addr A read only property that returns file address for the section as an integer.
function A read only property that returns an lldb object that represents the function (lldb.SBFunction) that this address resides within.
line_entry A read only property that returns an lldb object that represents the line entry (lldb.SBLineEntry) that this address resides within.
load_addr A read/write property that gets/sets the SBAddress using load address.
module A read only property that returns an lldb object that represents the module (lldb.SBModule) that this address resides within.
offset A read only property that returns the section offset in bytes as an integer.
section A read only property that returns an lldb object that represents the section (lldb.SBSection) that this address resides within.
symbol A read only property that returns an lldb object that represents the symbol (lldb.SBSymbol) that this address resides within.

Methods Summary

Clear(SBAddress self)
GetBlock(SBAddress self)
GetCompileUnit(SBAddress self)
GetDescription(SBAddress self, …)
GetFileAddress(SBAddress self)
GetFunction(SBAddress self)
GetLineEntry(SBAddress self)
GetLoadAddress(SBAddress self, SBTarget target)
GetModule(SBAddress self) GetModule() and the following grab individual objects for a given address and are less efficient if you want more than one symbol related objects.
GetOffset(SBAddress self)
GetSection(SBAddress self)
GetSymbol(SBAddress self)
GetSymbolContext(SBAddress self, …) GetSymbolContext() and the following can lookup symbol information for a given address.
IsValid(SBAddress self)
OffsetAddress(SBAddress self, lldb)
SetAddress(SBAddress self, …)
SetLoadAddress(SBAddress self, lldb, …)

Attributes Documentation

block

A read only property that returns an lldb object that represents the block (lldb.SBBlock) that this address resides within.

compile_unit

A read only property that returns an lldb object that represents the compile unit (lldb.SBCompileUnit) that this address resides within.

file_addr

A read only property that returns file address for the section as an integer. This is the address that represents the address as it is found in the object file that defines it.

function

A read only property that returns an lldb object that represents the function (lldb.SBFunction) that this address resides within.

line_entry

A read only property that returns an lldb object that represents the line entry (lldb.SBLineEntry) that this address resides within.

load_addr

A read/write property that gets/sets the SBAddress using load address. This resolves the SBAddress using the SBTarget from lldb.target so this property can ONLY be used in the interactive script interpreter (i.e. under the lldb script command). For things like Python based commands and breakpoint callbacks use GetLoadAddress instead.

module

A read only property that returns an lldb object that represents the module (lldb.SBModule) that this address resides within.

offset

A read only property that returns the section offset in bytes as an integer.

section

A read only property that returns an lldb object that represents the section (lldb.SBSection) that this address resides within.

symbol

A read only property that returns an lldb object that represents the symbol (lldb.SBSymbol) that this address resides within.

Methods Documentation

Clear(SBAddress self)
GetBlock(SBAddress self) → SBBlock
GetCompileUnit(SBAddress self) → SBCompileUnit
GetDescription(SBAddress self, SBStream description) → bool
GetFileAddress(SBAddress self) → lldb::addr_t
GetFunction(SBAddress self) → SBFunction
GetLineEntry(SBAddress self) → SBLineEntry
GetLoadAddress(SBAddress self, SBTarget target) → lldb::addr_t
GetModule(SBAddress self) → SBModule

GetModule() and the following grab individual objects for a given address and are less efficient if you want more than one symbol related objects. Use SBAddress.GetSymbolContext or SBTarget.ResolveSymbolContextForAddress when you want multiple debug symbol related objects for an address. One or more bits from the SymbolContextItem enumerations can be logically OR’ed together to more efficiently retrieve multiple symbol objects.

GetOffset(SBAddress self) → lldb::addr_t
GetSection(SBAddress self) → SBSection
GetSymbol(SBAddress self) → SBSymbol
GetSymbolContext(SBAddress self, uint32_t resolve_scope) → SBSymbolContext

GetSymbolContext() and the following can lookup symbol information for a given address. An address might refer to code or data from an existing module, or it might refer to something on the stack or heap. The following functions will only return valid values if the address has been resolved to a code or data address using SBAddress.SetLoadAddress' or :py:class:`SBTarget.ResolveLoadAddress.

IsValid(SBAddress self) → bool
OffsetAddress(SBAddress self, lldb::addr_t offset) → bool
SetAddress(SBAddress self, SBSection section, lldb::addr_t offset)
SetLoadAddress(SBAddress self, lldb::addr_t load_addr, SBTarget target)