darm.py

"""
Copyright (c) 2013, Jurriaan Bremer
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the darm developer(s) nor the names of its
  contributors may be used to endorse or promote products derived from this
  software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
"""
from ctypes import cdll, Structure, byref, POINTER, create_string_buffer
from ctypes import c_uint8, c_uint16, c_int32, c_uint32, c_char_p, c_char
import os.path


class _Base:
    def __init__(self, idx):
        self.idx = idx

    def __int__(self):
        return self.idx

    def __nonzero__(self):
        return self.idx != self._nonzero

    __bool__ = __nonzero__


class Condition(_Base):
    _nonzero = -1

    def __str__(self):
        return _lib.darm_condition_name(self.idx, 0)

    def __repr__(self):
        return 'C_%s' % self.__str__()


class Instruction(_Base):
    _nonzero = 0

    def __str__(self):
        return _lib.darm_mnemonic_name(self.idx)

    def __repr__(self):
        return 'I_%s' % self.__str__()


class Register(_Base):
    _nonzero = -1

    def __str__(self):
        return _lib.darm_register_name(self.idx)

    def __repr__(self):
        return self.__str__()


class Encoding(_Base):
    _nonzero = 0

    def __str__(self):
        return _lib.darm_enctype_name(self.idx)

    def __repr__(self):
        return 'T_%s' % self.__str__()


class Shift:
    def __init__(self, type_, Rs, shift):
        self.type_ = type_
        self.Rs = Rs
        self.shift = shift

    def type_name(self):
        return 'S_' + _lib.darm_shift_type_name(self.type_)

    def __str__(self):
        type_name = self.type_name()
        if self.Rs:
            return '%s %s' % (type_name, self.Rs)
        else:
            return '%s #%d' % (type_name, self.shift)

    def __repr__(self):
        type_name = self.type_name()
        if self.Rs:
            return 'Shift(type_=%s, Rs=%s)' % (type_name, self.Rs)
        else:
            return 'Shift(type_=%s, shift=%d)' % (type_name, self.shift)

    def __nonzero__(self):
        return self.type_ != -1


class RegisterList:
    def __init__(self, reglist):
        self.reglist = reglist

    def __str__(self):
        buf = create_string_buffer(64)
        _lib.darm_reglist(self.reglist, buf)
        return buf.value

    def __nonzero__(self):
        return self.reglist != 0

    __bool__ = __nonzero__


def flag(v):
    """Boolean flag.

    http://thedailywtf.com/Articles/What_Is_Truth_0x3f_.aspx

    """
    return {0: False, 1: True, 2: None}[v]


class _Darm(Structure):
    _fields_ = [
        ('w', c_uint32),
        ('instr', c_uint32),
        ('instr_type', c_uint32),
        ('instr_imm_type', c_uint32),
        ('instr_flag_type', c_uint32),
        ('cond', c_uint32),
        ('B', c_uint32),
        ('S', c_uint32),
        ('E', c_uint32),
        ('M', c_uint32),
        ('N', c_uint32),
        ('option', c_int32),
        ('U', c_uint32),
        ('H', c_uint32),
        ('P', c_uint32),
        ('R', c_uint32),
        ('T', c_uint32),
        ('W', c_uint32),
        ('I', c_uint32),
        ('rotate', c_int32),
        ('Rd', c_int32),
        ('Rn', c_int32),
        ('Rm', c_int32),
        ('Ra', c_int32),
        ('Rt', c_int32),
        ('Rt2', c_int32),
        ('RdHi', c_int32),
        ('RdLo', c_int32),
        ('imm', c_uint32),
        ('sat_imm', c_uint32),
        ('type_', c_int32),
        ('Rs', c_int32),
        ('shift', c_uint32),
        ('lsb', c_uint32),
        ('msb', c_uint32),
        ('width', c_uint32),
        ('reglist', c_uint16),
        ('coproc', c_uint8),
        ('opc1', c_uint8),
        ('opc2', c_uint8),
        ('CRd', c_int32),
        ('CRn', c_int32),
        ('CRm', c_int32),
        ('D', c_int32),
        ('firstcond', c_int32),
        ('mask', c_uint8),
    ]


class _DarmStr(Structure):
    _fields_ = [
        ('mnemonic', c_char * 12),
        ('arg0', c_char * 32),
        ('arg1', c_char * 32),
        ('arg2', c_char * 32),
        ('arg3', c_char * 32),
        ('arg4', c_char * 32),
        ('arg5', c_char * 32),
        ('shift', c_char * 12),
        ('total', c_char * 64),
    ]


class Darm:
    _flags = 'B', 'S', 'E', 'M', 'N', 'U', 'H', 'P', 'R', 'T', 'W', 'I'
    _regs = 'Rd', 'Rn', 'Rm', 'Ra', 'Rt', 'Rt2', 'RdHi', 'RdLo'

    def __init__(self, d):
        self.d = d
        self.w = d.w
        self.instr = Instruction(d.instr)
        self.instr_type = Encoding(d.instr_type)
        self.cond = Condition(d.cond)

        for x in self._flags:
            setattr(self, x, flag(getattr(d, x)))

        for x in self._regs:
            r = getattr(d, x)
            setattr(self, x, Register(r) if r >= 0 else None)

        self.rotate = d.rotate
        self.option = d.option
        self.imm = d.imm
        self.shift = Shift(d.type_,
                           Register(d.Rs) if d.Rs >= 0 else None,
                           d.shift)
        self.lsb = d.lsb
        self.width = d.width
        self.reglist = RegisterList(d.reglist)

    def __repr__(self):
        g = lambda x: getattr(self, x)

        args = []

        # registers
        args += ['%s=%s' % (r, g(r)) for r in self._regs if not g(r) is None]

        # flags
        args += ['%s=%s' % (r, g(r)) for r in self._flags if not g(r) is None]

        # other flags
        if self.rotate != -1:
            args.append('rotate=%d' % self.rotate)

        if self.option != -1:
            args.append('option=%s' % bin(self.option))

        if self.imm:
            args.append('imm=%s' % (str(self.imm)
                                    if self.imm < 0x1000 else
                                    hex(self.imm)[2:]))

        if self.shift:
            args.append(repr(self.shift))

        if self.lsb or self.width:
            args += ['lsb=%d' % self.lsb, 'width=%d' % self.width]

        if self.reglist:
            args.append('reglist=%s' % str(self.reglist))

        args = ', ' + ', '.join(args) if args else ''
        return 'Darm(instr=%s, instr_type=%s, cond=%s%s)' % \
            (repr(self.instr), repr(self.instr_type), repr(self.cond), args)

    def __str__(self):
        x = _DarmStr()
        if _lib.darm_str2(self.d, byref(x), True) == 0:
            return x.total.decode('ascii')
        return ''


def disasm_armv7(w):
    d = _Darm()
    ret = _lib.darm_armv7_disasm(byref(d), w)
    return Darm(d) if ret == 0 else None


def disasm_thumb(w):
    d = _Darm()
    ret = _lib.darm_thumb_disasm(byref(d), w)
    return Darm(d) if ret == 0 else None


def disasm_thumb2(w):
    d = _Darm()
    ret = _lib.darm_thumb2_disasm(byref(d), (w >> 16) & 0xffff, w & 0xffff)
    return Darm(d) if ret == 0 else None


def _set_func(name, restype, *argtypes):
    getattr(_lib, name).restype = restype
    getattr(_lib, name).argtypes = argtypes


_darm_dir = os.path.dirname(os.path.abspath(__file__))
if os.path.exists(os.path.join(_darm_dir, 'libdarm.dll')):
    _lib = cdll.LoadLibrary(os.path.join(_darm_dir, 'libdarm.dll'))
elif os.path.exists(os.path.join(_darm_dir, 'libdarm.so')):
    _lib = cdll.LoadLibrary(os.path.join(_darm_dir, 'libdarm.so'))
else:
    raise Exception('libdarm not found!')

_set_func('darm_armv7_disasm', c_int32, POINTER(_Darm), c_uint32)
_set_func('darm_thumb_disasm', c_int32, POINTER(_Darm), c_uint16)
_set_func('darm_thumb2_disasm', c_int32, POINTER(_Darm), c_uint16, c_uint16)
_set_func('darm_mnemonic_name', c_char_p, c_uint32)
_set_func('darm_enctype_name', c_char_p, c_uint32)
_set_func('darm_register_name', c_char_p, c_int32)
_set_func('darm_shift_type_name', c_char_p, c_int32)
_set_func('darm_condition_name', c_char_p, c_int32, c_int32)
_set_func('darm_reglist', c_int32, c_uint16, c_char_p)
_set_func('darm_str', c_int32, POINTER(_Darm), POINTER(_DarmStr))
_set_func('darm_str2', c_int32, POINTER(_Darm), POINTER(_DarmStr), c_int32)