Module index

Module ida_offset

IDA Plugin SDK API wrapper: offset


def add_refinfo_dref(*args) ‑> ea_t
Add xrefs for a reference from the given instruction (\insn_t{ea} ). This function creates a cross references to the target and the base. 'insn_t::add_off_drefs()' calls this function to create xrefs for 'offset' operand.
add_refinfo_dref(insn, _from, ri, opval, type, opoff) -> ea_t
insn: the referencing instruction - an ida_ua.insn_t, or an
address (C++: const insn_t &)
_from: the referencing instruction/data address (C++: ea_t)
ri: reference info block from the database (C++: const
refinfo_t &)
opval: operand value (usually op_t::value or op_t::addr )
(C++: adiff_t)
type: type of xref (C++: dref_t)
opoff: offset of the operand from the start of instruction
(C++: int)
return: the target address of the reference
def calc_basevalue(*args) ‑> ea_t
Calculate the value of the reference base.
calc_basevalue(target, base) -> ea_t
target (C++: ea_t)
base (C++: ea_t)
def calc_offset_base(*args) ‑> ea_t
Try to calculate the offset base This function takes into account the fixup information, current ds and cs values.
calc_offset_base(ea, n) -> ea_t
ea: the referencing instruction/data address (C++: ea_t)
n: operand number 0: first operand 1: other operand (C++:
return: output base address or BADADDR
def calc_probable_base_by_value(*args) ‑> ea_t
Try to calculate the offset base. 2 bases are checked: current ds and cs. If fails, return 'BADADDR'
calc_probable_base_by_value(ea, off) -> ea_t
ea (C++: ea_t)
off (C++: uval_t)
def calc_reference_data(*args) ‑> bool
Calculate the target and base addresses of an offset expression. The calculated target and base addresses are returned in the locations pointed by 'base' and 'target'. In case 'ri.base' is 'BADADDR' , the function calculates the offset base address from the referencing instruction/data address. The target address is copied from If is 'BADADDR' then the target is calculated using the base address and 'opval'. This function also checks if 'opval' matches the full value of the reference and takes in account the memory-mapping.
calc_reference_data(target, base, _from, ri, opval) -> bool
target: output target address (C++: ea_t *)
base: output base address (C++: ea_t *)
_from: the referencing instruction/data address (C++: ea_t)
ri: reference info block from the database (C++: const
refinfo_t &)
opval: operand value (usually op_t::value or op_t::addr )
(C++: adiff_t)
return: success
def calc_target(*args) ‑> ea_t
Calculates the target, using the provided 'refinfo_t' .
calc_target(_from, opval, ri) -> ea_t
_from (C++: ea_t)
opval (C++: adiff_t)
ri (C++: const refinfo_t &)
calc_target(_from, ea, n, opval) -> ea_t
_from (C++: ea_t) ea: ea_t n: int
opval (C++: adiff_t)
def can_be_off32(*args) ‑> ea_t
Does the specified address contain a valid OFF32 value?. For symbols in special segments the displacement is not taken into account. If yes, then the target address of OFF32 will be returned. If not, then 'BADADDR' is returned.
can_be_off32(ea) -> ea_t
ea (C++: ea_t)
def get_default_reftype(*args) ‑> reftype_t
Get default reference type depending on the segment.
get_default_reftype(ea) -> reftype_t
ea (C++: ea_t)
return: one of REF_OFF8 , REF_OFF16 , REF_OFF32
def get_offbase(*args) ‑> ea_t
Get offset base value
get_offbase(ea, n) -> ea_t
ea: linear address (C++: ea_t)
n: number of operand (C++: int)
return: offset base or BADADDR
def get_offset_expr(*args) ‑> qstring *
See 'get_offset_expression()'
get_offset_expr(ea, n, ri, _from, offset, getn_flags=0) -> str
ea (C++: ea_t)
n (C++: int)
ri (C++: const refinfo_t &)
_from (C++: ea_t)
offset (C++: adiff_t)
getn_flags (C++: int)
def get_offset_expression(*args) ‑> qstring *
Get offset expression (in the form "offset name+displ"). This function uses offset translation function (\ph{translate} ) if your IDP module has such a function. Translation function is used to map linear addresses in the program (only for offsets).Example: suppose we have instruction at linear address 0x00011000: \v{mov ax, [bx+7422h]} and at ds:7422h: \v{array dw ...} We want to represent the second operand with an offset expression, so then we call: \v{ get_offset_expresion(0x001100, 1, 0x001102, 0x7422, instruction } and the function will return a colored string: \v{offset array}
get_offset_expression(ea, n, _from, offset, getn_flags=0) -> str
ea: start of instruction or data with the offset expression
(C++: ea_t)
n: number of operand (may be ORed with OPND_OUTER ) 0: first
operand 1: second operand (C++: int)
_from: linear address of instruction operand or data referring
to the name. This address will be used to get fixup information, so it should point to exact position of operand in the instruction. (C++: ea_t)
offset: value of operand or its part. The function will return
text representation of this value as offset expression. (C++: adiff_t)
getn_flags: combination of: GETN_APPZERO : meaningful only if
the name refers to a structure. appends the struct field name if the field offset is zero GETN_NODUMMY : do not generate dummy names for the expression but pretend they already exist (useful to verify that the offset expression can be represented) (C++: int)
retval: 0 - can't convert to offset expression
retval: 1 - ok, a simple offset expression
retval: 2 - ok, a complex offset expression
def op_offset(*args) ‑> bool
See 'op_offset_ex()'
op_offset(ea, n, type_and_flags, target=BADADDR, base=0, tdelta=0) -> bool
ea (C++: ea_t)
n (C++: int)
type_and_flags (C++: uint32)
target (C++: ea_t)
base (C++: ea_t)
tdelta (C++: adiff_t)
def op_offset_ex(*args) ‑> bool
Convert operand to a reference. To delete an offset, use 'clr_op_type()' function.
op_offset_ex(ea, n, ri) -> bool
ea: linear address. if 'ea' has unexplored bytes, try to
convert them to no segment: fail 16bit segment: to 16bit word data 32bit segment: to dword (C++: ea_t)
n: number of operand (may be ORed with OPND_OUTER ) 0: first
1: second 2: third OPND_MASK : all operands (C++: int)
ri: reference information (C++: const refinfo_t *)
return: success
def op_plain_offset(*args) ‑> bool
Convert operand to a reference with the default reference type.
op_plain_offset(ea, n, base) -> bool
ea (C++: ea_t)
n (C++: int)
base (C++: ea_t)