Want to Join Us ?

you'll be able to discuss, share and send private messages.

Release IdaRef

Discussion in 'Plugins' started by storm shadow, Aug 29, 2014.

Share This Page

  1. storm shadow

    Techbliss Owner Admin Ida Pro Expert Developer

    IDA Pro Full Instruction Reference Plugin - It's like auto-comments but useful.
    I'm generally pretty good at figuring out what various Intel instructions do. But, once in a while I need to either know some precise detail (i.e. exact side effects of SUB) or come across a rare instruction. Then I break my train of thought and have to dig out the reference manual. Which got me thinking: Why can't IDA just give me the full documentation?
    Enter IdaRef:


    The plugin will monitor the location for your cursor (ScreenEA) and display the full documentation of the instruction. At the moment it only supports x86-64, however adding support for other architectures is relatively easy.
    Simply checkout or download the repository and make sure that the sqlite database file is in the same directory as the 'idaref' python script.
    Execute the python script via File->Script File... or ALT+F7. This will open a new view in your IDA workspace. In this view is where the text will be displayed. Now click on the instruction you're curious about and within a second the documentation will populate the view.
    Once loaded, the plugin can be turned off by closing the tab window. To control the output right-click on the tab window to get a menu:
    Update View - Load documentation for currectly selected instruction.
    Lookup Instruction - Manual load documentation, you'll be prompted for the instruction.
    Toggle Auto-refresh - Turn on/off auto loading of documentation and rely on the first two options.


    Upon loading the script will look for SQlite databases in the same directory as the itself. The naming convention for the database files is [arch name].sqlite. The [arch name] will be presented to the user as choice.
    The database has a table called 'instructions' and two columns called 'mnem' and 'description'. The instructions are looked up case insensitive (upper case) by the mnem value. The text from description is displayed verbatim in the view.
    To add support for more architectures simply create a new database with those columns and place it in the the script directory.

    Code (Text):
    import sqlite3 as sq
    con = sq.connect("asm.sqlite")
    con.text_factory = str
    cur = con.cursor()
    cur.execute("CREATE TABLE IF NOT EXISTS instructions (platform TEXT, mnem TEXT, description TEXT)")
    When working with x86, I noticed that many instructions point to the same documentation. So, the plugin supports single level referencing. Just place '-R:[new instruction]' into description to redirect the loading. 'new instruction' is the target. So, when loading the script will detect the link and load the new target automatically.

    Code (Text):
    cur.execute("INSERT INTO instructions VALUES (?, ?, ?)", ("x86", inst, "-R:%s" % first_inst))

    Skeletons in the closet
    The documentation database was created using a rather hackish screen scraping technique by the x86doc project which I forked. So, there are probably some strange characters or tags in the text. At least, it is a mechanical process so I expect that the information is correct relative to the original Intel PDF.

    computerline and roocoon like this.
  2. storm shadow

    Techbliss Owner Admin Ida Pro Expert Developer


    Rip Cord likes this.