fcml_assembler.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_ASSEMBLER_H_
#define FCML_ASSEMBLER_H_

#include "fcml_lib_export.h"

#include "fcml_types.h"
#include "fcml_errors.h"
#include "fcml_common.h"
#include "fcml_dialect.h"
#include "fcml_optimizers.h"
#include "fcml_choosers.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct fcml_st_assembler fcml_st_assembler;

typedef struct fcml_st_assembler_conf {
    fcml_bool increment_ip;
    fcml_bool enable_error_messages;
    fcml_bool choose_sib_encoding;
    fcml_bool choose_abs_encoding;
    fcml_bool force_rex_prefix;
    fcml_bool force_three_byte_VEX;
    fcml_fnp_asm_optimizer optimizer;
    fcml_uint16_t optimizer_flags;
    fcml_fnp_asm_instruction_chooser chooser;
} fcml_st_assembler_conf;

typedef struct fcml_st_assembled_instruction {
    struct fcml_st_assembled_instruction *next;
    fcml_st_ceh_error_container warnings;
    fcml_uint8_t *code;
    fcml_usize code_length;
#ifdef FCML_DEBUG
    fcml_uint8_t __def_index;
#endif
} fcml_st_assembled_instruction;

typedef struct fcml_st_assembler_result {
    fcml_st_ceh_error_container errors;
    fcml_st_assembled_instruction *instructions;
    fcml_st_assembled_instruction *chosen_instruction;
    fcml_usize number_of_instructions;
} fcml_st_assembler_result;

typedef struct fcml_st_assembler_context {
    fcml_st_assembler *assembler;
    fcml_st_assembler_conf configuration;
    fcml_st_entry_point entry_point;
} fcml_st_assembler_context;

LIB_EXPORT fcml_ceh_error LIB_CALL fcml_fn_assembler_init(
        const fcml_st_dialect *dialect, fcml_st_assembler **assembler);

LIB_EXPORT fcml_ceh_error LIB_CALL fcml_fn_assemble(
        fcml_st_assembler_context *context,
        const fcml_st_instruction *instruction,
        fcml_st_assembler_result *result);

LIB_EXPORT void LIB_CALL fcml_fn_assembler_result_prepare(
        fcml_st_assembler_result *result);

LIB_EXPORT void LIB_CALL fcml_fn_assembler_result_free(
        fcml_st_assembler_result *result);

LIB_EXPORT void LIB_CALL fcml_fn_assembler_instruction_free(
        fcml_st_assembled_instruction *instruction);

LIB_EXPORT void LIB_CALL fcml_fn_assembler_instruction_detach(
        fcml_st_assembled_instruction **chain,
        fcml_st_assembled_instruction *instruction);

LIB_EXPORT void LIB_CALL fcml_fn_assembler_free(fcml_st_assembler *assembler);

#ifdef __cplusplus
}
#endif

#endif /* FCML_ASSEMBLER_H_ */