idautils

Module idautils

[show private | hide private]

Module idautils

idautils.py - High level utility functions for IDA

Function Summary
	`CodeRefsFrom(ea, flow)` Get a list of code references from 'ea'
	`CodeRefsTo(ea, flow)` Get a list of code references to 'ea'
	`DataRefsFrom(ea)` Get a list of data references from 'ea'
	`DataRefsTo(ea)` Get a list of data references to 'ea'
	`Functions(start, end)` Get a list of functions
	`GetDataList(ea, count, itemsize)` Get data list - INTERNAL USE ONLY
	`Heads(start, end)` Get a list of heads (instructions or data)
	`MapDataList(ea, length, func, wordsize)` Map through a list of data words in the database
	`PutDataList(ea, list, itemsize)` Put data list - INTERNAL USE ONLY
	`refs(ea, funcfirst, funcnext)` Generic reference collector - INTERNAL USE ONLY.
	`Segments()` Get list of segments (sections) in the binary image

Function Details

CodeRefsFrom(ea, flow)

Get a list of code references from 'ea'

Parameters:: ea - Target address; flow - Follow normal code flow or not
(type=Boolean (0/1, False/True))

Returns:

list of references (may be empty list)

Example:

       for ref in CodeRefsFrom(ScreenEA(), 1):
               print ref

CodeRefsTo(ea, flow)

Get a list of code references to 'ea'

Parameters:: ea - Target address; flow - Follow normal code flow or not
(type=Boolean (0/1, False/True))

Returns:

list of references (may be empty list)

Example:

       for ref in CodeRefsTo(ScreenEA(), 1):
               print ref

DataRefsFrom(ea)

Get a list of data references from 'ea'

Parameters:: ea - Target address

Returns:

list of references (may be empty list)

Example:

       for ref in DataRefsFrom(ScreenEA(), 1):
               print ref

DataRefsTo(ea)

Get a list of data references to 'ea'

Parameters:: ea - Target address

Returns:

list of references (may be empty list)

Example:

       for ref in DataRefsTo(ScreenEA(), 1):
               print ref

Functions(start, end)

Get a list of functions

Parameters:: start - start address; end - end address

Returns:: list of heads between start and end

Note: The last function that starts before 'end' is included even if it extends beyond 'end'.

GetDataList(ea, count, itemsize=1)

Get data list - INTERNAL USE ONLY

Heads(start, end)

Get a list of heads (instructions or data)

Parameters:: start - start address (this one is always included); end - end address

Returns:: list of heads between start and end

MapDataList(ea, length, func, wordsize=1)

Map through a list of data words in the database

Parameters:: ea - start address; length - number of words to map; func - mapping function; wordsize - size of words to map [default: 1 byte]

Returns:: None

PutDataList(ea, list, itemsize=1)

Put data list - INTERNAL USE ONLY

refs(ea, funcfirst, funcnext)

Generic reference collector - INTERNAL USE ONLY.

Segments()

Get list of segments (sections) in the binary image

Returns:: List of segment start addresses.

Generated by Epydoc 2.1 on Wed Jan 18 16:10:50 2006

http://epydoc.sf.net