Skip to content

Xrefs

xrefs

Classes:

  • CallerInfo –

    Information about a function caller.

  • XrefInfo –

    Enhanced cross-reference information.

  • XrefType –

    Unified cross-reference types (both code and data).

  • Xrefs –

    Provides unified access to cross-reference (xref) analysis in the IDA database.

  • XrefsFlags –

    Flags for xref iteration control.

CallerInfo dataclass 

CallerInfo(
    ea: ea_t,
    name: str,
    xref_type: XrefType,
    function_ea: Optional[ea_t] = None,
)

Information about a function caller.

Attributes:

ea instance-attribute 

ea: ea_t

function_ea class-attribute instance-attribute 

function_ea: Optional[ea_t] = None

name instance-attribute 

name: str

xref_type instance-attribute 

xref_type: XrefType

XrefInfo dataclass 

XrefInfo(
    from_ea: ea_t,
    to_ea: ea_t,
    is_code: bool,
    type: XrefType,
    user: bool,
)

Enhanced cross-reference information.

Attributes:

  • from_ea (ea_t) –
  • is_call (bool) –

    Check if this is a call reference.

  • is_code (bool) –
  • is_flow (bool) –

    Check if this is ordinary flow reference.

  • is_jump (bool) –

    Check if this is a jump reference.

  • is_read (bool) –

    Check if this is a data read reference.

  • is_write (bool) –

    Check if this is a data write reference.

  • to_ea (ea_t) –
  • type (XrefType) –
  • user (bool) –

from_ea instance-attribute 

from_ea: ea_t

is_call property 

is_call: bool

Check if this is a call reference.

is_code instance-attribute 

is_code: bool

is_flow property 

is_flow: bool

Check if this is ordinary flow reference.

is_jump property 

is_jump: bool

Check if this is a jump reference.

is_read property 

is_read: bool

Check if this is a data read reference.

is_write property 

is_write: bool

Check if this is a data write reference.

to_ea instance-attribute 

to_ea: ea_t

type instance-attribute 

type: XrefType

user instance-attribute 

user: bool

XrefType

Bases: IntEnum

Unified cross-reference types (both code and data).

Methods:

Attributes:

CALL_FAR class-attribute instance-attribute 

CALL_FAR = fl_CF

Call Far - creates a function at referenced location

CALL_NEAR class-attribute instance-attribute 

CALL_NEAR = fl_CN

Call Near - creates a function at referenced location

INFORMATIONAL class-attribute instance-attribute 

INFORMATIONAL = dr_I

Informational reference

JUMP_FAR class-attribute instance-attribute 

JUMP_FAR = fl_JF

Jump Far

JUMP_NEAR class-attribute instance-attribute 

JUMP_NEAR = fl_JN

Jump Near

OFFSET class-attribute instance-attribute 

OFFSET = dr_O

Offset reference or OFFSET flag set

ORDINARY_FLOW class-attribute instance-attribute 

ORDINARY_FLOW = fl_F

Ordinary flow to next instruction

READ class-attribute instance-attribute 

READ = dr_R

Read access

SYMBOLIC class-attribute instance-attribute 

SYMBOLIC = dr_S

Reference to enum member (symbolic constant)

TEXT class-attribute instance-attribute 

TEXT = dr_T

Text (for forced operands only)

UNKNOWN class-attribute instance-attribute 

UNKNOWN = 0

Unknown

USER_SPECIFIED class-attribute instance-attribute 

USER_SPECIFIED = fl_USobsolete

User specified (obsolete)

WRITE class-attribute instance-attribute 

WRITE = dr_W

Write access

is_code_ref 

is_code_ref() -> bool

Check if this is a code reference.

is_data_ref 

is_data_ref() -> bool

Check if this is a data reference.

Xrefs 

Xrefs(database: Database)

Bases: DatabaseEntity

Provides unified access to cross-reference (xref) analysis in the IDA database.

This class offers a simplified API for working with both code and data cross-references, with convenient methods for common use cases.

Args: database: Reference to the active IDA database.

Example: 

# Get all references to an address
for xref in db.xrefs.to(ea):
    print(f"{xref.frm:x} -> {xref.to:x} ({xref.type.name})")

# Get only code references
for caller in db.xrefs.code_refs_to(func_ea):
    print(f"Called from: {caller:x}")

# Get data reads
for reader in db.xrefs.reads_of(data_ea):
    print(f"Read by: {reader:x}")

Methods:

Attributes:

database property 

database: Database

Get the database reference, guaranteed to be non-None when called from methods decorated with @check_db_open.

Returns: The active database instance.

Note: This property should only be used in methods decorated with @check_db_open, which ensures m_database is not None.

m_database instance-attribute 

m_database = database

calls_from_ea 

calls_from_ea(ea: ea_t) -> Iterator[ea_t]

Get addresses called from this address.

Args: ea: Source address

Yields: Called addresses

Raises: InvalidEAError: If the effective address is invalid

calls_to_ea 

calls_to_ea(ea: ea_t) -> Iterator[ea_t]

Get addresses where calls to this address occur.

Args: ea: Target address

Yields: Addresses containing call instructions

Raises: InvalidEAError: If the effective address is invalid

code_refs_from_ea 

code_refs_from_ea(
    ea: ea_t, flow: bool = True
) -> Iterator[ea_t]

Get code reference addresses from ea.

Args: ea: Source address flow: Include ordinary flow references (default: True)

Yields: Target addresses of code references

Raises: InvalidEAError: If the effective address is invalid

code_refs_to_ea 

code_refs_to_ea(
    ea: ea_t, flow: bool = True
) -> Iterator[ea_t]

Get code reference addresses to ea.

Args: ea: Target address flow: Include ordinary flow references (default: True)

Yields: Source addresses of code references

Raises: InvalidEAError: If the effective address is invalid

data_refs_from_ea 

data_refs_from_ea(ea: ea_t) -> Iterator[ea_t]

Get data reference addresses from ea.

Args: ea: Source address

Yields: Target addresses of data references

Raises: InvalidEAError: If the effective address is invalid

data_refs_to_ea 

data_refs_to_ea(ea: ea_t) -> Iterator[ea_t]

Get data reference addresses to ea.

Args: ea: Target address

Yields: Source addresses of data references

Raises: InvalidEAError: If the effective address is invalid

from_ea 

from_ea(
    ea: ea_t, flags: XrefsFlags = ALL
) -> Iterator[XrefInfo]

Get all cross-references from an address.

Note: Method named 'from_' because 'from' is a Python keyword.

Args: ea: Source effective address flags: Filter flags (default: all xrefs)

Yields: XrefInfo objects with detailed xref information

Raises: InvalidEAError: If the effective address is invalid

get_callers 

get_callers(func_ea: ea_t) -> Iterator[CallerInfo]

Get detailed caller information for a function.

Args: func_ea: Function start address

Yields: CallerInfo objects with caller details

Raises: InvalidEAError: If the effective address is invalid

jumps_from_ea 

jumps_from_ea(ea: ea_t) -> Iterator[ea_t]

Get addresses jumped to from this address.

Args: ea: Source address

Yields: Jump target addresses

Raises: InvalidEAError: If the effective address is invalid

jumps_to_ea 

jumps_to_ea(ea: ea_t) -> Iterator[ea_t]

Get addresses where jumps to this address occur.

Args: ea: Target address

Yields: Addresses containing jump instructions

Raises: InvalidEAError: If the effective address is invalid

reads_of_ea 

reads_of_ea(data_ea: ea_t) -> Iterator[ea_t]

Get addresses that read from this data location.

Args: data_ea: Data address

Yields: Addresses that read the data

Raises: InvalidEAError: If the effective address is invalid

to_ea 

to_ea(
    ea: ea_t, flags: XrefsFlags = ALL
) -> Iterator[XrefInfo]

Get all cross-references to an address.

Args: ea: Target effective address flags: Filter flags (default: all xrefs)

Yields: XrefInfo objects with detailed xref information

Raises: InvalidEAError: If the effective address is invalid

writes_to_ea 

writes_to_ea(data_ea: ea_t) -> Iterator[ea_t]

Get addresses that write to this data location.

Args: data_ea: Data address

Yields: Addresses that write to the data

Raises: InvalidEAError: If the effective address is invalid

XrefsFlags

Bases: IntFlag

Flags for xref iteration control.

Methods:

Attributes:

  • ALL –

    Default - all xrefs

  • CODE –

    Return only code references

  • CODE_NOFLOW –

    Code xrefs without flow

  • DATA –

    Return only data references

  • NOFLOW –

    Skip ordinary flow xrefs

ALL class-attribute instance-attribute 

ALL = 0

Default - all xrefs

CODE class-attribute instance-attribute 

CODE = XREF_CODE

Return only code references

CODE_NOFLOW class-attribute instance-attribute 

CODE_NOFLOW = CODE | NOFLOW

Code xrefs without flow

DATA class-attribute instance-attribute 

DATA = XREF_DATA

Return only data references

NOFLOW class-attribute instance-attribute 

NOFLOW = XREF_NOFLOW

Skip ordinary flow xrefs

to_ida_flags 

to_ida_flags() -> int

Convert to IDA's xref flags.