rz_il_opcodes.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2021 Florian Märkl <info@florianmaerkl.de>
// SPDX-FileCopyrightText: 2021 heersin <teablearcher@gmail.com>
// SPDX-License-Identifier: LGPL-3.0-only
 
#ifndef RZ_IL_OPCODES_H
#define RZ_IL_OPCODES_H
 
#include <rz_il/definitions/definitions.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct rz_il_op_pure_t RzILOpPure;
 
typedef RzILOpPure RzILOpBool;
typedef RzILOpPure RzILOpBitVector;
 
typedef struct rz_il_op_effect_t RzILOpEffect;
 
typedef struct rz_il_op_args_bv_t {
    RzBitVector *value; 
} RzILOpArgsBv;
 
struct rz_il_op_args_un_bv_b_t {
    RzILOpBitVector *bv;
};
 
typedef struct rz_il_op_args_un_bv_b_t RzILOpArgsMsb;
typedef struct rz_il_op_args_un_bv_b_t RzILOpArgsLsb;
typedef struct rz_il_op_args_un_bv_b_t RzILOpArgsIsZero;
 
struct rz_il_op_args_bv_unop_t {
    RzILOpBitVector *bv; 
};
 
typedef struct rz_il_op_args_bv_unop_t RzILOpArgsLogNot;
typedef struct rz_il_op_args_bv_unop_t RzILOpArgsNeg;
 
struct rz_il_op_args_alg_log_operations_t {
    RzILOpBitVector *x; 
    RzILOpBitVector *y; 
};
 
typedef struct rz_il_op_args_alg_log_operations_t RzILOpArgsAdd;
typedef struct rz_il_op_args_alg_log_operations_t RzILOpArgsSub;
typedef struct rz_il_op_args_alg_log_operations_t RzILOpArgsMul;
typedef struct rz_il_op_args_alg_log_operations_t RzILOpArgsDiv;
typedef struct rz_il_op_args_alg_log_operations_t RzILOpArgsSdiv;
typedef struct rz_il_op_args_alg_log_operations_t RzILOpArgsMod;
typedef struct rz_il_op_args_alg_log_operations_t RzILOpArgsSmod;
typedef struct rz_il_op_args_alg_log_operations_t RzILOpArgsLogand;
typedef struct rz_il_op_args_alg_log_operations_t RzILOpArgsLogor;
typedef struct rz_il_op_args_alg_log_operations_t RzILOpArgsLogxor;
 
struct rz_il_op_args_cmp_t {
    RzILOpBitVector *x; 
    RzILOpBitVector *y; 
};
 
typedef struct rz_il_op_args_cmp_t RzILOpArgsEq;
typedef struct rz_il_op_args_cmp_t RzILOpArgsSle;
typedef struct rz_il_op_args_cmp_t RzILOpArgsUle;
 
typedef struct rz_il_op_args_cast_t {
    ut32 length; 
    RzILOpBool *fill; 
    RzILOpBitVector *val; 
} RzILOpArgsCast;
 
typedef struct rz_il_op_args_append_t {
    RzILOpBitVector *high; 
    RzILOpBitVector *low; 
} RzILOpArgsAppend;
 
struct rz_il_op_args_shift_t {
    RzILOpBool *fill_bit; 
    RzILOpBitVector *x; 
    RzILOpBitVector *y; 
};
 
typedef struct rz_il_op_args_shift_t RzILOpArgsShiftLeft;
typedef struct rz_il_op_args_shift_t RzILOpArgsShiftRight;
 
typedef struct rz_il_op_args_set_t {
    const char *v; 
    bool is_local; 
    RzILOpPure *x; 
} RzILOpArgsSet;
 
typedef struct rz_il_op_args_let_t {
    const char *name; 
    RzILOpPure *exp; 
    RzILOpPure *body; 
} RzILOpArgsLet;
 
typedef struct rz_il_op_args_jmp_t {
    RzILOpBitVector *dst; 
} RzILOpArgsJmp;
 
typedef struct rz_il_op_args_goto_t {
    const char *lbl; 
} RzILOpArgsGoto;
 
typedef struct rz_il_op_args_seq_t {
    RzILOpEffect *x; 
    RzILOpEffect *y; 
} RzILOpArgsSeq;
 
typedef struct rzil_op_blk_t {
    const char *label; 
    RzILOpEffect *data_eff; 
    RzILOpEffect *ctrl_eff; 
} RzILOpArgsBlk;
 
typedef struct rzil_op_repeat_t {
    RzILOpBool *condition; 
    RzILOpEffect *data_eff; 
} RzILOpArgsRepeat;
 
typedef struct rz_il_op_args_branch_t {
    RzILOpBool *condition;
    RZ_NONNULL RzILOpEffect *true_eff; 
    RZ_NONNULL RzILOpEffect *false_eff; 
} RzILOpArgsBranch;
 
typedef struct rz_il_op_args_ite_t {
    RzILOpBool *condition; 
    RzILOpPure *x; 
    RzILOpPure *y; 
} RzILOpArgsIte;
 
typedef struct rz_il_op_args_var_t {
    const char *v; 
    RzILVarKind kind; 
} RzILOpArgsVar;
 
struct rz_il_op_args_bool_operation_t {
    RzILOpBool *x; 
    RzILOpBool *y; 
};
 
typedef struct rz_il_op_args_bool_operation_t RzILOpArgsBoolAnd;
typedef struct rz_il_op_args_bool_operation_t RzILOpArgsBoolOr;
typedef struct rz_il_op_args_bool_operation_t RzILOpArgsBoolXor;
 
struct rz_il_op_args_bool_inv_t {
    RzILOpBool *x; 
};
 
typedef struct rz_il_op_args_bool_inv_t RzILOpArgsBoolInv;
 
typedef struct rz_il_op_args_load_t {
    RzILMemIndex mem; 
    RzILOpBitVector *key; 
} RzILOpArgsLoad;
 
typedef struct rz_il_op_args_store_t {
    RzILMemIndex mem; 
    RzILOpBitVector *key; 
    RzILOpBitVector *value; 
} RzILOpArgsStore;
 
typedef struct rz_il_op_args_loadw_t {
    RzILMemIndex mem; 
    RzILOpBitVector *key; 
    ut32 n_bits; 
} RzILOpArgsLoadW;
 
typedef struct rz_il_op_args_storew_t {
    RzILMemIndex mem; 
    RzILOpBitVector *key; 
    RzILOpBitVector *value; 
} RzILOpArgsStoreW;
 
// Opcodes of type 'a pure //
 
typedef enum {
    // Init
    RZ_IL_OP_VAR,
    RZ_IL_OP_ITE,
    RZ_IL_OP_LET,
 
    // RzILBool
    RZ_IL_OP_B0,
    RZ_IL_OP_B1,
    RZ_IL_OP_INV,
    RZ_IL_OP_AND,
    RZ_IL_OP_OR,
    RZ_IL_OP_XOR,
 
    // RzBitVector
    RZ_IL_OP_BITV,
    RZ_IL_OP_MSB,
    RZ_IL_OP_LSB,
    RZ_IL_OP_IS_ZERO,
    RZ_IL_OP_NEG,
    RZ_IL_OP_LOGNOT,
    RZ_IL_OP_ADD,
    RZ_IL_OP_SUB,
    RZ_IL_OP_MUL,
    RZ_IL_OP_DIV,
    RZ_IL_OP_SDIV,
    RZ_IL_OP_MOD,
    RZ_IL_OP_SMOD,
    RZ_IL_OP_LOGAND,
    RZ_IL_OP_LOGOR,
    RZ_IL_OP_LOGXOR,
    RZ_IL_OP_SHIFTR,
    RZ_IL_OP_SHIFTL,
    RZ_IL_OP_EQ,
    RZ_IL_OP_SLE,
    RZ_IL_OP_ULE,
    RZ_IL_OP_CAST,
    RZ_IL_OP_APPEND,
    // ...
 
    // Memory
    RZ_IL_OP_LOAD,
    RZ_IL_OP_LOADW,
 
    RZ_IL_OP_PURE_MAX
} RzILOpPureCode;
 
struct rz_il_op_pure_t {
    RzILOpPureCode code;
    union {
        RzILOpArgsIte ite;
        RzILOpArgsVar var;
        RzILOpArgsLet let;
 
        RzILOpArgsBoolAnd booland;
        RzILOpArgsBoolOr boolor;
        RzILOpArgsBoolXor boolxor;
        RzILOpArgsBoolInv boolinv;
 
        RzILOpArgsBv bitv;
        RzILOpArgsMsb msb;
        RzILOpArgsLsb lsb;
        RzILOpArgsIsZero is_zero;
        RzILOpArgsEq eq;
        RzILOpArgsUle ule;
        RzILOpArgsSle sle;
        RzILOpArgsCast cast;
        RzILOpArgsNeg neg;
        RzILOpArgsLogNot lognot;
        RzILOpArgsAdd add;
        RzILOpArgsSub sub;
        RzILOpArgsMul mul;
        RzILOpArgsDiv div;
        RzILOpArgsSdiv sdiv;
        RzILOpArgsSmod smod;
        RzILOpArgsMod mod;
        RzILOpArgsLogand logand;
        RzILOpArgsLogor logor;
        RzILOpArgsLogxor logxor;
        RzILOpArgsShiftLeft shiftl;
        RzILOpArgsShiftRight shiftr;
        RzILOpArgsAppend append;
 
        RzILOpArgsLoad load;
        RzILOpArgsLoadW loadw;
    } op;
};
 
RZ_API void rz_il_op_pure_free(RZ_NULLABLE RzILOpPure *op);
RZ_API RzILOpPure *rz_il_op_pure_dup(RZ_NONNULL RzILOpPure *op);
 
RZ_API RZ_OWN RzILOpPure *rz_il_op_new_ite(RZ_NONNULL RzILOpPure *condition, RZ_NULLABLE RzILOpPure *x, RZ_NULLABLE RzILOpPure *y);
RZ_API RZ_OWN RzILOpPure *rz_il_op_new_var(RZ_NONNULL const char *var, RzILVarKind kind);
RZ_API RZ_OWN RzILOpPure *rz_il_op_new_let(RZ_NONNULL const char *name, RZ_NONNULL RzILOpPure *exp, RZ_NONNULL RzILOpPure *body);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_b0();
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_b1();
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_bool_and(RZ_NONNULL RzILOpBool *x, RZ_NONNULL RzILOpBool *y);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_bool_or(RZ_NONNULL RzILOpBool *x, RZ_NONNULL RzILOpBool *y);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_bool_xor(RZ_NONNULL RzILOpBool *x, RZ_NONNULL RzILOpBool *y);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_bool_inv(RZ_NONNULL RzILOpBool *x);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_bitv(RZ_NONNULL RzBitVector *value);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_bitv_from_ut64(ut32 length, ut64 number);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_bitv_from_st64(ut32 length, st64 number);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_msb(RZ_NONNULL RzILOpPure *val);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_lsb(RZ_NONNULL RzILOpPure *val);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_is_zero(RZ_NONNULL RzILOpPure *bv);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_non_zero(RZ_NONNULL RzILOpPure *bv);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_eq(RZ_NONNULL RzILOpPure *x, RZ_NONNULL RzILOpPure *y);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_ule(RZ_NONNULL RzILOpPure *x, RZ_NONNULL RzILOpPure *y);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_sle(RZ_NONNULL RzILOpPure *x, RZ_NONNULL RzILOpPure *y);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_ult(RZ_NONNULL RzILOpPure *x, RZ_NONNULL RzILOpPure *y);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_slt(RZ_NONNULL RzILOpPure *x, RZ_NONNULL RzILOpPure *y);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_uge(RZ_NONNULL RzILOpPure *x, RZ_NONNULL RzILOpPure *y);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_sge(RZ_NONNULL RzILOpPure *x, RZ_NONNULL RzILOpPure *y);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_ugt(RZ_NONNULL RzILOpPure *x, RZ_NONNULL RzILOpPure *y);
RZ_API RZ_OWN RzILOpBool *rz_il_op_new_sgt(RZ_NONNULL RzILOpPure *x, RZ_NONNULL RzILOpPure *y);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_cast(ut32 length, RZ_NONNULL RzILOpBool *fill, RZ_NONNULL RzILOpBitVector *val);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_unsigned(ut32 length, RZ_NONNULL RzILOpBitVector *val); // "zero extension"
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_signed(ut32 length, RZ_NONNULL RzILOpBitVector *val); // "sign extension"
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_neg(RZ_NONNULL RzILOpBitVector *value);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_log_not(RZ_NONNULL RzILOpBitVector *value);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_add(RZ_NONNULL RzILOpBitVector *x, RZ_NONNULL RzILOpBitVector *y);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_sub(RZ_NONNULL RzILOpBitVector *x, RZ_NONNULL RzILOpBitVector *y);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_mul(RZ_NONNULL RzILOpBitVector *x, RZ_NONNULL RzILOpBitVector *y);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_div(RZ_NONNULL RzILOpBitVector *x, RZ_NONNULL RzILOpBitVector *y);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_sdiv(RZ_NONNULL RzILOpBitVector *x, RZ_NONNULL RzILOpBitVector *y);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_smod(RZ_NONNULL RzILOpBitVector *x, RZ_NONNULL RzILOpBitVector *y);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_mod(RZ_NONNULL RzILOpBitVector *x, RZ_NONNULL RzILOpBitVector *y);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_log_and(RZ_NONNULL RzILOpBitVector *x, RZ_NONNULL RzILOpBitVector *y);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_log_or(RZ_NONNULL RzILOpBitVector *x, RZ_NONNULL RzILOpBitVector *y);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_log_xor(RZ_NONNULL RzILOpBitVector *x, RZ_NONNULL RzILOpBitVector *y);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_shiftl(RZ_NONNULL RzILOpBool *fill_bit, RZ_NONNULL RzILOpBitVector *x, RZ_NONNULL RzILOpBitVector *sh);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_shiftr(RZ_NONNULL RzILOpBool *fill_bit, RZ_NONNULL RzILOpBitVector *x, RZ_NONNULL RzILOpBitVector *sh);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_shiftr_arith(RZ_NONNULL RzILOpBitVector *x, RZ_NONNULL RzILOpBitVector *y);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_append(RZ_NONNULL RzILOpBitVector *high, RZ_NONNULL RzILOpBitVector *low);
 
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_load(RzILMemIndex mem, RZ_NONNULL RzILOpBitVector *key);
RZ_API RZ_OWN RzILOpBitVector *rz_il_op_new_loadw(RzILMemIndex mem, RZ_NONNULL RzILOpBitVector *key, ut32 n_bits);
 
// Opcodes of type 'a effect //
 
typedef enum {
    RZ_IL_OP_STORE,
    RZ_IL_OP_STOREW,
 
    RZ_IL_OP_EMPTY,
    RZ_IL_OP_NOP,
    RZ_IL_OP_SET,
    RZ_IL_OP_JMP,
    RZ_IL_OP_GOTO,
    RZ_IL_OP_SEQ,
    RZ_IL_OP_BLK,
    RZ_IL_OP_REPEAT,
    RZ_IL_OP_BRANCH,
 
    RZ_IL_OP_EFFECT_MAX
} RzILOpEffectCode;
 
struct rz_il_op_effect_t {
    RzILOpEffectCode code;
    union {
        RzILOpArgsSet set;
        RzILOpArgsJmp jmp;
        RzILOpArgsGoto goto_;
        RzILOpArgsSeq seq;
        RzILOpArgsBlk blk;
        RzILOpArgsRepeat repeat;
        RzILOpArgsBranch branch;
 
        RzILOpArgsStore store;
        RzILOpArgsStoreW storew;
    } op;
};
 
RZ_API void rz_il_op_effect_free(RZ_NULLABLE RzILOpEffect *op);
 
RZ_API RZ_OWN RzILOpEffect *rz_il_op_new_empty();
RZ_API RZ_OWN RzILOpEffect *rz_il_op_new_nop();
RZ_API RZ_OWN RzILOpEffect *rz_il_op_new_set(RZ_NONNULL const char *v, bool is_local, RZ_NONNULL RzILOpPure *x);
RZ_API RZ_OWN RzILOpEffect *rz_il_op_new_jmp(RZ_NONNULL RzILOpBitVector *dst);
RZ_API RZ_OWN RzILOpEffect *rz_il_op_new_goto(RZ_NONNULL const char *label);
RZ_API RZ_OWN RzILOpEffect *rz_il_op_new_seq(RZ_NONNULL RzILOpEffect *x, RZ_NONNULL RzILOpEffect *y);
RZ_API RZ_OWN RzILOpEffect *rz_il_op_new_seqn(ut32 n, ...);
RZ_API RZ_OWN RzILOpEffect *rz_il_op_new_blk(RZ_NONNULL const char *label, RZ_NONNULL RzILOpEffect *data_effect, RZ_NONNULL RzILOpEffect *ctrl_effect);
RZ_API RZ_OWN RzILOpEffect *rz_il_op_new_repeat(RZ_NONNULL RzILOpBool *condition, RZ_NONNULL RzILOpEffect *data_effect);
RZ_API RZ_OWN RzILOpEffect *rz_il_op_new_branch(RZ_NONNULL RzILOpBool *condition, RZ_NULLABLE RzILOpEffect *true_effect, RZ_NULLABLE RzILOpEffect *false_effect);
 
RZ_API RZ_OWN RzILOpEffect *rz_il_op_new_store(RzILMemIndex mem, RZ_NONNULL RzILOpBitVector *key, RZ_NONNULL RzILOpBitVector *value);
RZ_API RZ_OWN RzILOpEffect *rz_il_op_new_storew(RzILMemIndex mem, RZ_NONNULL RzILOpBitVector *key, RZ_NONNULL RzILOpBitVector *value);
 
// Printing/Export
RZ_API RZ_NONNULL const char *rz_il_op_pure_code_stringify(RzILOpPureCode code);
 
RZ_API void rz_il_op_pure_stringify(RZ_NONNULL RzILOpPure *op, RZ_NONNULL RzStrBuf *sb);
RZ_API void rz_il_op_effect_stringify(RZ_NONNULL RzILOpEffect *op, RZ_NONNULL RzStrBuf *sb);
 
RZ_API void rz_il_op_pure_json(RZ_NONNULL RzILOpPure *op, RZ_NONNULL PJ *pj);
RZ_API void rz_il_op_effect_json(RZ_NONNULL RzILOpEffect *op, RZ_NONNULL PJ *pj);
 
#ifdef __cplusplus
}
#endif
 
#endif // RZ_IL_OPCODES_H