Module index

# Module `ida_auto`

Functions that work with the autoanalyzer queue.

The autoanalyzer works when IDA is not busy processing the user keystrokes. It has several queues, each queue having its own priority. The analyzer stops when all queues are empty.

A queue contains addresses or address ranges. The addresses are kept sorted by their values. The analyzer will process all addresses from the first queue, then switch to the second queue and so on. There are no limitations on the size of the queues.

This file also contains functions that deal with the IDA status indicator and the autoanalysis indicator. You may use these functions to change the indicator value.

## Global variables

`var AU_CHLB`

  12: load signature file (file name is kept separately)

`var AU_CODE`

  1: convert to instruction

`var AU_FCHUNK`

  5: find func chunks

`var AU_FINAL`

  13: final pass

`var AU_LBF2`

  10: the same, second pass

`var AU_LBF3`

  11: the same, third pass

`var AU_LIBF`

  9: apply signature to address

`var AU_NONE`

  placeholder, not used

`var AU_PROC`

  3: convert to procedure start

`var AU_TAIL`

  4: add a procedure tail

`var AU_TYPE`

  8: apply type information

`var AU_UNK`

  0: convert to unexplored

`var AU_USD2`

  7: reanalyze, second pass

`var AU_USED`

  6: reanalyze

`var AU_WEAK`

  2: convert to instruction (ida decision)

`var st_Ready`

  READY: IDA is doing nothing.

`var st_Think`

  THINKING: Autoanalysis on, the user may press keys.

`var st_Waiting`

  WAITING: Waiting for the user input.

`var st_Work`

  BUSY: IDA is busy.

## Functions

`def auto_apply_tail(tail_ea: ea_t, parent_ea: ea_t)`

  auto_apply_tail(tail_ea, parent_ea) Plan to apply the tail_ea chunk to the parent

  @param tail_ea: (C++: ea_t) linear address of start of tail @param parent_ea: (C++: ea_t) linear address within parent. If BADADDR, automatically try to find parent via xrefs.

`def auto_apply_type(caller: ea_t, callee: ea_t)`

  auto_apply_type(caller, callee) Plan to apply the callee's type to the calling point.

  @param caller: (C++: ea_t) @param callee: (C++: ea_t)

`def auto_cancel(ea1: ea_t, ea2: ea_t)`

  auto_cancel(ea1, ea2) Remove an address range (ea1..ea2) from queues AU_CODE, AU_PROC, AU_USED. To remove an address range from other queues use auto_unmark() function. 'ea1' may be higher than 'ea2', the kernel will swap them in this case. 'ea2' doesn't belong to the range.

  @param ea1: (C++: ea_t) @param ea2: (C++: ea_t)

`def auto_get(type: atype_t *, lowEA: ea_t, highEA: ea_t)`

  auto_get(type, lowEA, highEA) -> ea_t Retrieve an address from queues regarding their priority. Returns BADADDR if no addresses not lower than 'lowEA' and less than 'highEA' are found in the queues. Otherwise *type will have queue type.

  @param type: (C++: atype_t *) @param lowEA: (C++: ea_t) @param highEA: (C++: ea_t)

`def auto_is_ok() ‑> bool`

  auto_is_ok() -> bool Are all queues empty? (i.e. has autoanalysis finished?).

`def auto_make_code(ea: ea_t)`

  auto_make_code(ea) Plan to make code.

  @param ea: (C++: ea_t)

`def auto_make_proc(ea: ea_t)`

  auto_make_proc(ea) Plan to make code&function.

  @param ea: (C++: ea_t)

`def auto_make_step(ea1: ea_t, ea2: ea_t)`

  auto_make_step(ea1, ea2) -> bool Analyze one address in the specified range and return true.

  @param ea1: (C++: ea_t) @param ea2: (C++: ea_t) @return: if processed anything. false means that there is nothing to process in the specified range.

`def auto_mark(ea: ea_t, type: atype_t)`

  auto_mark(ea, type) Put single address into a queue. Queues keep addresses sorted.

  @param ea: (C++: ea_t) @param type: (C++: atype_t)

`def auto_mark_range(start: ea_t, end: ea_t, type: atype_t)`

  auto_mark_range(start, end, type) Put range of addresses into a queue. 'start' may be higher than 'end', the kernel will swap them in this case. 'end' doesn't belong to the range.

  @param start: (C++: ea_t) @param end: (C++: ea_t) @param type: (C++: atype_t)

`def auto_postpone_analysis(ea: ea_t)`

  auto_postpone_analysis(ea) -> bool Plan to reanalyze on the second pass The typical usage of this function in emu.cpp is: if ( !auto_postpone_analysis(ea) ) op_offset(ea, 0, …); (we make an offset only on the second pass)

  @param ea: (C++: ea_t)

`def auto_recreate_insn(ea: ea_t)`

  auto_recreate_insn(ea) -> int Try to create instruction

  @param ea: (C++: ea_t) linear address of callee @return: the length of the instruction or 0

`def auto_unmark(start: ea_t, end: ea_t, type: atype_t)`

  auto_unmark(start, end, type) Remove range of addresses from a queue. 'start' may be higher than 'end', the kernel will swap them in this case. 'end' doesn't belong to the range.

  @param start: (C++: ea_t) @param end: (C++: ea_t) @param type: (C++: atype_t)

`def auto_wait() ‑> bool`

  auto_wait() -> bool Process everything in the queues and return true.

  @return: false if the user clicked cancel. (the wait box must be displayed by the caller if desired)

`def auto_wait_range(ea1: ea_t, ea2: ea_t)`

  auto_wait_range(ea1, ea2) -> ssize_t Process everything in the specified range and return true.

  @param ea1: (C++: ea_t) @param ea2: (C++: ea_t) @return: number of autoanalysis steps made. -1 if the user clicked cancel. (the wait box must be displayed by the caller if desired)

`def enable_auto(enable: bool) ‑> bool`

  enable_auto(enable) -> bool Temporarily enable/disable autoanalyzer. Not user-facing, but rather because IDA sometimes need to turn AA on/off regardless of inf.s_genflags:INFFL_AUTO

  @param enable: (C++: bool) @return: old state

`def get_auto_display(auto_display: auto_display_t) ‑> bool`

  get_auto_display(auto_display) -> bool Get structure which holds the autoanalysis indicator contents.

  @param auto_display: (C++: auto_display_t *)

`def get_auto_state()`

  get_auto_state() -> atype_t Get current state of autoanalyzer. If auto_state == AU_NONE, IDA is currently not running the analysis (it could be temporarily interrupted to perform the user's requests, for example).

`def is_auto_enabled() ‑> bool`

  is_auto_enabled() -> bool Get autoanalyzer state.

`def may_create_stkvars() ‑> bool`

  may_create_stkvars() -> bool Is it allowed to create stack variables automatically?. This function should be used by IDP modules before creating stack vars.

`def may_trace_sp() ‑> bool`

  may_trace_sp() -> bool Is it allowed to trace stack pointer automatically?. This function should be used by IDP modules before tracing sp.

`def peek_auto_queue(low_ea: ea_t, type: atype_t)`

  peek_auto_queue(low_ea, type) -> ea_t Peek into a queue 'type' for an address not lower than 'low_ea'. Do not remove address from the queue.

  @param low_ea: (C++: ea_t) @param type: (C++: atype_t) @return: the address or BADADDR

`def plan_and_wait(ea1: ea_t, ea2: ea_t, final_pass: bool = True)`

  plan_and_wait(ea1, ea2, final_pass=True) -> int Analyze the specified range. Try to create instructions where possible. Make the final pass over the specified range if specified. This function doesn't return until the range is analyzed. @retval 1: ok @retval 0: Ctrl-Break was pressed

  @param ea1: (C++: ea_t) @param ea2: (C++: ea_t) @param final_pass: (C++: bool)

`def plan_ea(ea: ea_t)`

  plan_ea(ea) Plan to perform reanalysis.

  @param ea: (C++: ea_t)

`def plan_range(sEA: ea_t, eEA: ea_t)`

  plan_range(sEA, eEA) Plan to perform reanalysis.

  @param sEA: (C++: ea_t) @param eEA: (C++: ea_t)

`def reanalyze_callers(ea: ea_t, noret: bool)`

  reanalyze_callers(ea, noret) Plan to reanalyze callers of the specified address. This function will add to AU_USED queue all instructions that call (not jump to) the specified address.

  @param ea: (C++: ea_t) linear address of callee @param noret: (C++: bool) !=0: the callee doesn't return, mark to undefine subsequent instructions in the caller. 0: do nothing.

`def revert_ida_decisions(ea1: ea_t, ea2: ea_t)`

  revert_ida_decisions(ea1, ea2) Delete all analysis info that IDA generated for for the given range.

  @param ea1: (C++: ea_t) @param ea2: (C++: ea_t)

`def set_auto_state(new_state: atype_t)`

  set_auto_state(new_state) -> atype_t Set current state of autoanalyzer.

  @param new_state: (C++: atype_t) new state of autoanalyzer @return: previous state

`def set_ida_state(st: idastate_t)`

  set_ida_state(st) -> idastate_t Change IDA status indicator value

  @param st: (C++: idastate_t) - new indicator status @return: old indicator status

`def show_addr(ea: ea_t)`

  show_addr(ea) Show an address on the autoanalysis indicator. The address is displayed in the form " @:12345678".

  @param ea: (C++: ea_t) - linear address to display

`def show_auto(*args)`

  show_auto(ea, type=AU_NONE) Change autoanalysis indicator value.

  @param ea: (C++: ea_t) linear address being analyzed @param type: (C++: atype_t) autoanalysis type (see Autoanalysis queues)

## Classes

`class auto_display_t`

  Proxy of C++ auto_display_t class.

  init(self) -> auto_display_t

  ### Instance variables

  `var ea : ea_t`

    ea

  `var state : idastate_t`

    state

  `var thisown`

    The membership flag

  `var type : atype_t`

    type