fcml_disassembler.h

Go to the documentation of this file.

/*
 * FCML - Free Code Manipulation Library.
 * Copyright (C) 2010-2020 Slawomir Wojtasiak
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef FCML_DISASSEMBLER_H_
#define FCML_DISASSEMBLER_H_

#include "fcml_lib_export.h"

#include "fcml_instructions.h"
#include "fcml_types.h"
#include "fcml_errors.h"
#include "fcml_common.h"
#include "fcml_dialect.h"

#ifdef __cplusplus
extern "C" {
#endif

#define FCML_DASM_PREFIXES_COUNT    12

#define FCML_DASM_CONDITIONAL_GROUP_1   0x00

#define FCML_DASM_CONDITIONAL_GROUP_2   0x01

typedef struct fcml_st_disassembler fcml_st_disassembler;

typedef struct fcml_st_disassembler_conf {
    fcml_bool increment_ip;
    fcml_bool enable_error_messages;
    fcml_bool carry_flag_conditional_suffix;
    fcml_uint8_t conditional_group;
    fcml_bool short_forms;
    fcml_bool extend_disp_to_asa;
    fcml_bool fail_if_unknown_instruction;
} fcml_st_disassembler_conf;

typedef struct fcml_st_disassembler_context {
    fcml_st_disassembler *disassembler;
    fcml_st_disassembler_conf configuration;
    fcml_st_entry_point entry_point;
    fcml_ptr code;
    fcml_usize code_length;
} fcml_st_disassembler_context;

/* Prefixes */

typedef enum fcml_en_prefix_types {
    FCML_PT_GROUP_UNKNOWN = 0,
    FCML_PT_GROUP_1 = 1,
    FCML_PT_GROUP_2,
    FCML_PT_GROUP_3,
    FCML_PT_GROUP_4,
    FCML_PT_REX,
    FCML_PT_VEX,
    FCML_PT_XOP,
    FCML_PT_EVEX
} fcml_en_prefix_types;

typedef struct fcml_st_instruction_prefix {
    fcml_uint8_t prefix;
    fcml_en_prefix_types prefix_type;
    fcml_bool mandatory_prefix;
    fcml_uint8_t avx_bytes[3];
} fcml_st_instruction_prefix;

typedef struct fcml_st_prefixes_details {
    fcml_st_instruction_prefix prefixes[FCML_DASM_PREFIXES_COUNT];
    fcml_int prefixes_count;
    fcml_int prefixes_bytes_count;
    fcml_bool is_branch;
    fcml_bool is_nobranch;
    fcml_bool is_lock;
    fcml_bool is_rep;
    fcml_bool is_repne;
    fcml_bool is_xrelease;
    fcml_bool is_xacquire;
    fcml_bool is_vex;
    fcml_bool is_evex;
    fcml_bool is_xop;
    fcml_bool is_avx;
    fcml_bool is_rex;
    fcml_uint8_t avx_first_byte;
    fcml_uint8_t R;
    fcml_uint8_t R_prim;
    fcml_uint8_t X;
    fcml_uint8_t B;
    fcml_uint8_t b;
    fcml_uint8_t W;
    fcml_uint8_t L;
    fcml_uint8_t L_prim;
    fcml_uint8_t mmmm;
    fcml_uint8_t vvvv;
    fcml_uint8_t pp;
    fcml_uint8_t z;
    fcml_uint8_t V_prim;
    fcml_uint8_t aaa;
} fcml_st_prefixes_details;

typedef struct fcml_st_operand_details {
    fcml_en_access_mode access_mode;
} fcml_st_operand_details;

typedef struct fcml_st_raw_displacement {
    fcml_st_integer displacement;
    fcml_nuint32_t N;
} fcml_st_raw_displacement;

typedef struct fcml_st_decoded_modrm_details {
    fcml_uint8_t modrm;
    fcml_nuint8_t sib;
    fcml_bool is_rip;
    fcml_bool is_modrm;
    fcml_st_raw_displacement displacement;
} fcml_st_decoded_modrm_details;

typedef struct fcml_st_instruction_details {
    fcml_bool is_shortcut;
    fcml_bool is_pseudo_op;
    fcml_uint8_t instruction_code[FCML_INSTRUCTION_SIZE];
    fcml_usize instruction_size;
    fcml_st_prefixes_details prefixes_details;
    fcml_st_operand_details operand_details[FCML_OPERANDS_COUNT];
    fcml_st_decoded_modrm_details modrm_details;
    fcml_bool opcode_field_s_bit;
    fcml_bool opcode_field_w_bit;
    fcml_en_instruction instruction;
    fcml_en_pseudo_operations pseudo_op;
    fcml_uint16_t addr_mode;
    fcml_uint64_t instruction_group;
    fcml_uint8_t tuple_type;
} fcml_st_instruction_details;

typedef struct fcml_st_disassembler_result {
    fcml_st_ceh_error_container errors;
    fcml_st_instruction_details instruction_details;
    fcml_st_instruction instruction;
} fcml_st_disassembler_result;

LIB_EXPORT fcml_ceh_error LIB_CALL fcml_fn_disassembler_init(
        const fcml_st_dialect *dialect, fcml_st_disassembler **disassembler);

LIB_EXPORT fcml_ceh_error LIB_CALL fcml_fn_disassemble(
        fcml_st_disassembler_context *context,
        fcml_st_disassembler_result *result);

LIB_EXPORT void LIB_CALL fcml_fn_disassembler_result_prepare(
        fcml_st_disassembler_result *result);

LIB_EXPORT void LIB_CALL fcml_fn_disassembler_result_free(
        fcml_st_disassembler_result *result);

LIB_EXPORT void LIB_CALL fcml_fn_disassembler_free(
        fcml_st_disassembler *disassembler);

#ifdef __cplusplus
}
#endif

#endif /* FCML_DISASSEMBLER_H_ */