/* Chrysalide - Outil d'analyse de fichiers binaires
 * helpers.h - prototypes pour l'aide à la mise en place des opérandes ARMv7
 *
 * Copyright (C) 2014 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  OpenIDA is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  OpenIDA is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
 */


#ifndef _ARCH_ARM_V7_HELPERS_H
#define _ARCH_ARM_V7_HELPERS_H


#include <libio.h>


#include "pseudo.h"
#include "operands/maccess.h"
#include "operands/offset.h"
#include "operands/reglist.h"
#include "operands/shift.h"
#include "../../operand.h"





#define Imm16(imm16)                                                                    \
    ({                                                                                  \
        GArchOperand *__result;                                                         \
        __result = g_imm_operand_new_from_value(MDS_16_BITS_UNSIGNED, (uint16_t)imm16); \
        __result;                                                                       \
    })

#define ARMExpandImm_C(imm12, c)                                                    \
    ({                                                                              \
        GArchOperand *__result;                                                     \
        uint32_t __val;                                                             \
        if (armv7_arm_expand_imm_c(imm12, (bool []) { c }, &__val))                 \
            __result = g_imm_operand_new_from_value(MDS_32_BITS_UNSIGNED, __val);   \
        else                                                                        \
            __result = NULL;                                                        \
        __result;                                                                   \
    })

#define ARMExpandImm(imm12)                                                         \
    ({                                                                              \
        GArchOperand *__result;                                                     \
        uint32_t __val;                                                             \
        if (armv7_arm_expand_imm(imm12, &__val))                                    \
            __result = g_imm_operand_new_from_value(MDS_32_BITS_UNSIGNED, __val);   \
        else                                                                        \
            __result = NULL;                                                        \
        __result;                                                                   \
    })

#define ThumbExpandImm_C(imm12, c)                                                  \
    ({                                                                              \
        GArchOperand *__result;                                                     \
        uint32_t __val;                                                             \
        if (armv7_thumb_expand_imm_c(imm12, (bool []) { c }, &__val))               \
            __result = g_imm_operand_new_from_value(MDS_32_BITS_UNSIGNED, __val);   \
        else                                                                        \
            __result = NULL;                                                        \
        __result;                                                                   \
    })

#define ThumbExpandImm(imm12)                                                       \
    ({                                                                              \
        GArchOperand *__result;                                                     \
        uint32_t __val;                                                             \
        if (armv7_thumb_expand_imm(imm12, &__val))                                  \
            __result = g_imm_operand_new_from_value(MDS_32_BITS_UNSIGNED, __val);   \
        else                                                                        \
            __result = NULL;                                                        \
        __result;                                                                   \
    })







#define DecodeImmShiftValue(imm5)                                                       \
    ({                                                                                  \
        GArchOperand *__result;                                                         \
        uint32_t __shift_n;                                                             \
        if (!armv7_decode_imm_shift(0, imm5, (SRType []) { 0 }, &__shift_n))            \
            __result = NULL;                                                            \
        else                                                                            \
            __result = g_imm_operand_new_from_value(MDS_32_BITS_UNSIGNED, __shift_n);   \
        __result;                                                                       \
    })

#define DecodeImmShift(type, imm5)                                                  \
    ({                                                                              \
        GArchOperand *__result;                                                     \
        SRType __shift_t;                                                           \
        uint32_t __shift_n;                                                         \
        GArchOperand *__op_n;                                                       \
        if (!armv7_decode_imm_shift(type, imm5, &__shift_t, &__shift_n))            \
            __result = NULL;                                                        \
        else                                                                        \
        {                                                                           \
            __op_n = g_imm_operand_new_from_value(MDS_32_BITS_UNSIGNED, __shift_n); \
            __result = g_armv7_shift_operand_new(__shift_t, __op_n);                \
        }                                                                           \
        __result;                                                                   \
    })



#if 0
// DecodeRegShift()
// ================
SRType DecodeRegShift(bits(2) type)
case type of
when '00' shift_t = SRType_LSL;
when '01' shift_t = SRType_LSR;
when '10' shift_t = SRType_ASR;
when '11' shift_t = SRType_ROR;
return shift_t;
#endif



#define ZeroExtend(x, n, i)                             \
    ({                                                  \
        MemoryDataSize __mds;                           \
        uint ## i ## _t __val;                          \
        __mds = MDS_ ## i ## _BITS_UNSIGNED;            \
        __val = armv7_zero_extend(x, n, i);             \
        g_imm_operand_new_from_value(__mds, __val);     \
    })



#define Zeros(i)                                        \
    ({                                                  \
        MemoryDataSize __mds;                           \
        uint ## i ## _t __val;                          \
        __mds = MDS_ ## i ## _BITS_UNSIGNED;            \
        __val = 0;                                      \
        g_imm_operand_new_from_value(__mds, __val);     \
    })








/**
 * Glue purement interne.
 */


#define MakeAccessOffset(add, off)                                                  \
    g_armv7_offset_operand_new(add, off)


#define MakeShiftedMemoryAccess(base, off, shift, wr)                               \
    g_armv7_maccess_operand_new(base, off, shift, wr)


#define _MakeMemoryAccess(base, off, wr)                                            \
    MakeShiftedMemoryAccess(base, off, NULL, wr)


#define MakeMemoryAccess(base, off, add, wr)                                        \
    ({                                                                              \
        GArchOperand *__off;                                                        \
        __off = MakeAccessOffset(add, off);                                         \
        _MakeMemoryAccess(base, __off, wr);                                         \
    })


#define MakeMemoryNotIndexed(base, wr)                                              \
    _MakeMemoryAccess(base, NULL, wr)



/**
 * Glue purement interne pour les listes de registres.
 */

#define RegistersList(mask)                                                             \
    ({                                                                                  \
        GArchOperand *__result;                                                         \
        __result = g_armv7_reglist_operand_new();                                       \
        if (!g_armv7_reglist_load_registers(G_ARMV7_REGLIST_OPERAND(__result), mask))   \
        {                                                                               \
            g_object_unref(G_OBJECT(__result));                                         \
            __result = NULL;                                                            \
        }                                                                               \
        __result;                                                                       \
    })


#define ListFromRegister(reg)                                                           \
    ({                                                                                  \
        GArchOperand *__result;                                                         \
        __result = g_armv7_reglist_operand_new();                                       \
        g_armv7_reglist_add_register(G_ARMV7_REGLIST_OPERAND(__result), reg);           \
        __result;                                                                       \
    })




/* Effectue une rotation vers la droit d'une valeur. */
GArchOperand *ror_armv7_imm(uint32_t, unsigned int);

/* Crée un opérande de valeur immédiate avec extension de signe. */
GArchOperand *sign_extend_armv7_imm(uint32_t, bool, unsigned int);

/* Etend une valeur immédiate en mode 'Thumb' ARMv7. */
GArchOperand *thumb_expand_armv7_imm(uint32_t);

/* Crée un opérande représentant un registre ARMv7. */
GArchOperand *translate_armv7_register(uint8_t);

/* Réalise un simple transtypage de valeur entière. */
GArchOperand *zero_extend_armv7_imm(uint32_t, unsigned int);



#endif  /* _ARCH_ARM_V7_HELPERS_H */