ida_segregs Namespace Reference

Detailed Description

Functions that deal with the segment registers.

If your processor doesn't use segment registers, then these functions are of no use for you. However, you should define two virtual segment registers - CS and DS (for code segment and data segment) and specify their internal numbers in the LPH structure (processor_t::reg_code_sreg and processor_t::reg_data_sreg). 

Classes
class	sreg_range_t

Functions
'sel_t'	get_sreg (ida_idaapi.ea_t ea, int rg)
bool	split_sreg_range (ida_idaapi.ea_t ea, int rg, 'sel_t' v, 'uchar' tag, bool silent=False)
bool	set_default_sreg_value ('segment_t *' sg, int rg, 'sel_t' value)
None	set_sreg_at_next_code (ida_idaapi.ea_t ea1, ida_idaapi.ea_t ea2, int rg, 'sel_t' value)
bool	get_sreg_range ('sreg_range_t' out, ida_idaapi.ea_t ea, int rg)
bool	get_prev_sreg_range ('sreg_range_t' out, ida_idaapi.ea_t ea, int rg)
None	set_default_dataseg ('sel_t' ds_sel)
'size_t'	get_sreg_ranges_qty (int rg)
bool	getn_sreg_range ('sreg_range_t' out, int rg, int n)
int	get_sreg_range_num (ida_idaapi.ea_t ea, int rg)
bool	del_sreg_range (ida_idaapi.ea_t ea, int rg)
None	copy_sreg_ranges (int dst_rg, int src_rg, bool map_selector=False)

Variables
	R_es = _ida_segregs.R_es
	R_cs = _ida_segregs.R_cs
	R_ss = _ida_segregs.R_ss
	R_ds = _ida_segregs.R_ds
	R_fs = _ida_segregs.R_fs
	R_gs = _ida_segregs.R_gs
	SR_inherit = _ida_segregs.SR_inherit
	SR_user = _ida_segregs.SR_user
	SR_auto = _ida_segregs.SR_auto
	SR_autostart = _ida_segregs.SR_autostart

Function Documentation

copy_sreg_ranges()

None copy_sreg_ranges	(	int	dst_rg,
		int	src_rg,
		bool	map_selector = False )

Duplicate segment register ranges. 
    
@param dst_rg: number of destination segment register
@param src_rg: copy ranges from
@param map_selector: map selectors to linear addresses using sel2ea()

del_sreg_range()

bool del_sreg_range	(	ida_idaapi.ea_t	ea,
		int	rg )

Delete segment register range started at ea. When a segment register range is deleted, the previous range is extended to cover the empty space. The segment register range at the beginning of a segment cannot be deleted. 
    
@param ea: start_ea of the deleted range
@param rg: the segment register number
@returns success

get_prev_sreg_range()

bool get_prev_sreg_range	(	'sreg_range_t'	out,
		ida_idaapi.ea_t	ea,
		int	rg )

Get segment register range previous to one with address. 
    
@param out: segment register range
@param ea: any linear address in the program
@param rg: the segment register number
@returns success

get_sreg()

'sel_t' get_sreg	(	ida_idaapi.ea_t	ea,
		int	rg )

Get value of a segment register. This function uses segment register range and default segment register values stored in the segment structure. 
    
@param ea: linear address in the program
@param rg: number of the segment register
@returns value of the segment register, BADSEL if value is unknown or rg is not a segment register.

get_sreg_range()

bool get_sreg_range	(	'sreg_range_t'	out,
		ida_idaapi.ea_t	ea,
		int	rg )

Get segment register range by linear address. 
    
@param out: segment register range
@param ea: any linear address in the program
@param rg: the segment register number
@returns success

get_sreg_range_num()

int get_sreg_range_num	(	ida_idaapi.ea_t	ea,
		int	rg )

Get number of segment register range by address. 
    
@param ea: any address in the range
@param rg: the segment register number
@returns -1 if no range occupies the specified address. otherwise returns number of the specified range (0..get_srranges_qty()-1)

get_sreg_ranges_qty()

'size_t' get_sreg_ranges_qty

(

int

rg

)

Get number of segment register ranges. 
    
@param rg: the segment register number

getn_sreg_range()

bool getn_sreg_range	(	'sreg_range_t'	out,
		int	rg,
		int	n )

Get segment register range by its number. 
    
@param out: segment register range
@param rg: the segment register number
@param n: number of range (0..qty()-1)
@returns success

set_default_dataseg()

None set_default_dataseg

(

'sel_t'

ds_sel

)

Set default value of DS register for all segments.

set_default_sreg_value()

bool set_default_sreg_value	(	'segment_t *'	sg,
		int	rg,
		'sel_t'	value )

Set default value of a segment register for a segment. 
    
@param sg: pointer to segment structure if nullptr, then set the register for all segments
@param rg: number of segment register
@param value: its default value. this value will be used by get_sreg() if value of the register is unknown at the specified address.
@returns success

set_sreg_at_next_code()

None set_sreg_at_next_code	(	ida_idaapi.ea_t	ea1,
		ida_idaapi.ea_t	ea2,
		int	rg,
		'sel_t'	value )

Set the segment register value at the next instruction. This function is designed to be called from idb_event::sgr_changed handler in order to contain the effect of changing a segment register value only until the next instruction.
It is useful, for example, in the ARM module: the modification of the T register does not affect existing instructions later in the code. 
    
@param ea1: address to start to search for an instruction
@param ea2: the maximal address
@param rg: the segment register number
@param value: the segment register value

split_sreg_range()

bool split_sreg_range	(	ida_idaapi.ea_t	ea,
		int	rg,
		'sel_t'	v,
		'uchar'	tag,
		bool	silent = False )

Create a new segment register range. This function is used when the IDP emulator detects that a segment register changes its value. 
    
@param ea: linear address where the segment register will have a new value. if ea==BADADDR, nothing to do.
@param rg: the number of the segment register
@param v: the new value of the segment register. If the value is unknown, you should specify BADSEL.
@param tag: the register info tag. see Segment register range tags
@param silent: if false, display a warning() in the case of failure
@returns success

Variable Documentation

R_cs

R_cs = _ida_segregs.R_cs

R_ds

R_ds = _ida_segregs.R_ds

R_es

R_es = _ida_segregs.R_es

R_fs

R_fs = _ida_segregs.R_fs

R_gs

R_gs = _ida_segregs.R_gs

R_ss

R_ss = _ida_segregs.R_ss

SR_auto

SR_auto = _ida_segregs.SR_auto

SR_autostart

SR_autostart = _ida_segregs.SR_autostart

SR_inherit

SR_inherit = _ida_segregs.SR_inherit

SR_user

SR_user = _ida_segregs.SR_user