ea-based stack variables

Functions
idaman bool ida_export	define_stkvar_ea (ea_t func_ea, const char *name, sval_t off, const tinfo_t &tif, const struct value_repr_t *repr=nullptr)
	Define/redefine a stack variable.
idaman bool ida_export	add_frame_member_ea (ea_t func_ea, const char *name, uval_t offset, const tinfo_t &tif, const struct value_repr_t *repr=nullptr, uint etf_flags=0)
	Add member to the frame type.
idaman bool ida_export	set_frame_member_type_ea (ea_t func_ea, uval_t offset, const tinfo_t &tif, const struct value_repr_t *repr=nullptr, uint etf_flags=0)
	Change type of the frame member.
idaman bool ida_export	delete_frame_members_ea (ea_t func_ea, uval_t start_offset, uval_t end_offset)
	Delete frame members.
idaman ssize_t ida_export	build_stkvar_name_ea (qstring *buf, ea_t func_ea, sval_t v)
	Build automatic stack variable name.
idaman ea_t ida_export	calc_stkvar_struc_offset_ea (ea_t func_ea, const insn_t &insn, int n)
	Calculate offset of stack variable in the frame structure.
idaman sval_t ida_export	calc_frame_offset_ea (ea_t func_ea, sval_t off, const insn_t *insn=nullptr, const op_t *op=nullptr)
	Calculate the offset of stack variable in the frame.
idaman int ida_export	delete_wrong_frame_info_ea (ea_t func_ea, bool idaapi should_reanalyze(const insn_t &insn))
	Find and delete wrong frame info.
idaman void ida_export	build_stkvar_xrefs_ea (xreflist_t *out, ea_t func_ea, uval_t start_offset, uval_t end_offset)
	Fill 'out' with a list of all the xrefs from a function to the specified range of the function's stack frame.

Detailed Description

Function Documentation

define_stkvar_ea()

idaman bool ida_export define_stkvar_ea	(	ea_t	func_ea,
		const char *	name,
		sval_t	off,
		const tinfo_t &	tif,
		const struct value_repr_t *	repr = nullptr )

Define/redefine a stack variable.

Parameters

func_ea	any address of the function
name	variable name, nullptr means autogenerate a name
off	offset of the stack variable in the frame. negative values denote local variables, positive - function arguments.
tif	variable type
repr	variable representation

Returns

success

add_frame_member_ea()

idaman bool ida_export add_frame_member_ea	(	ea_t	func_ea,
		const char *	name,
		uval_t	offset,
		const tinfo_t &	tif,
		const struct value_repr_t *	repr = nullptr,
		uint	etf_flags = 0 )

Add member to the frame type.

Parameters

func_ea	any address of the function
name	variable name, nullptr means autogenerate a name
offset	member offset in the frame structure, in bytes
tif	variable type
repr	variable representation
etf_flags

See also

type changing flags

Returns

success

set_frame_member_type_ea()

idaman bool ida_export set_frame_member_type_ea	(	ea_t	func_ea,
		uval_t	offset,
		const tinfo_t &	tif,
		const struct value_repr_t *	repr = nullptr,
		uint	etf_flags = 0 )

Change type of the frame member.

Parameters

func_ea	any address of the function
offset	member offset in the frame structure, in bytes
tif	variable type
repr	variable representation
etf_flags

See also

type changing flags

Returns

success

delete_frame_members_ea()

idaman bool ida_export delete_frame_members_ea	(	ea_t	func_ea,
		uval_t	start_offset,
		uval_t	end_offset )

Delete frame members.

Parameters

func_ea	any address of the function
start_offset	member offset to start deletion from, in bytes
end_offset	member offset which not included in the deletion, in bytes

Returns

success

build_stkvar_name_ea()

idaman ssize_t ida_export build_stkvar_name_ea	(	qstring *	buf,
		ea_t	func_ea,
		sval_t	v )

Build automatic stack variable name.

Parameters

buf	pointer to buffer
func_ea	any address of the function
v	value of variable offset

Returns

length of stack variable name or -1

calc_stkvar_struc_offset_ea()

idaman ea_t ida_export calc_stkvar_struc_offset_ea	(	ea_t	func_ea,
		const insn_t &	insn,
		int	n )

Calculate offset of stack variable in the frame structure.

Parameters

func_ea	any address of the function
insn	the instruction
n	0..#UA_MAXOP-1 operand number -1 if error, return #BADADDR

Returns

#BADADDR if some error (issue a warning if stack frame is bad)

calc_frame_offset_ea()

idaman sval_t ida_export calc_frame_offset_ea	(	ea_t	func_ea,
		sval_t	off,
		const insn_t *	insn = nullptr,
		const op_t *	op = nullptr )

Calculate the offset of stack variable in the frame.

Parameters

func_ea	any address of the function
off	the offset relative to stack pointer or frame pointer
insn	the instruction
op	the operand

Returns

the offset in the frame

delete_wrong_frame_info_ea()

idaman int ida_export delete_wrong_frame_info_ea	(	ea_t	func_ea,
		bool idaapi	should_reanalyzeconst insn_t &insn )

Find and delete wrong frame info.

Namely, we delete:

• unreferenced stack variable definitions
• references to dead stack variables (i.e. operands displayed in red) these operands will be untyped and most likely displayed in hex.

We also plan to reanalyze instruction with the stack frame references

Parameters

func_ea	any address of the function
should_reanalyze	callback to determine which instructions to reanalyze

Returns

number of deleted definitions or -1 if no function

build_stkvar_xrefs_ea()

idaman void ida_export build_stkvar_xrefs_ea	(	xreflist_t *	out,
		ea_t	func_ea,
		uval_t	start_offset,
		uval_t	end_offset )

Fill 'out' with a list of all the xrefs from a function to the specified range of the function's stack frame.

Parameters

out	the list of xrefs to fill
func_ea	any address of the function
start_offset	start frame structure offset, in bytes
end_offset	end frame structure offset, in bytes