FormatterIntel.h

Go to the documentation of this file.

/***************************************************************************************************
 
 Zyan Disassembler Library (Zydis)
 
 Original Author : Florian Bernd, Joel Hoener
 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 
***************************************************************************************************/
 
#ifndef ZYDIS_FORMATTER_INTEL_H
#define ZYDIS_FORMATTER_INTEL_H
 
#include <Zydis/Formatter.h>
#include <Zydis/Internal/FormatterBase.h>
#include <Zydis/Internal/String.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ============================================================================================== */
/* Formatter functions */
/* ============================================================================================== */
 
/* ---------------------------------------------------------------------------------------------- */
/* Intel */
/* ---------------------------------------------------------------------------------------------- */
 
ZyanStatus ZydisFormatterIntelFormatInstruction(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);
 
ZyanStatus ZydisFormatterIntelFormatOperandMEM(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);
 
ZyanStatus ZydisFormatterIntelPrintMnemonic(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);
 
ZyanStatus ZydisFormatterIntelPrintRegister(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context, ZydisRegister reg);
 
ZyanStatus ZydisFormatterIntelPrintDISP(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);
 
ZyanStatus ZydisFormatterIntelPrintTypecast(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);
 
/* ---------------------------------------------------------------------------------------------- */
/* MASM */
/* ---------------------------------------------------------------------------------------------- */
 
ZyanStatus ZydisFormatterIntelFormatInstructionMASM(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);
 
ZyanStatus ZydisFormatterIntelPrintAddressMASM(const ZydisFormatter* formatter,
 ZydisFormatterBuffer* buffer, ZydisFormatterContext* context);
 
/* ---------------------------------------------------------------------------------------------- */
 
/* ============================================================================================== */
/* Fomatter presets */
/* ============================================================================================== */
 
/* ---------------------------------------------------------------------------------------------- */
/* INTEL */
/* ---------------------------------------------------------------------------------------------- */
 
static const ZydisFormatter FORMATTER_INTEL =
{
 /* style */ ZYDIS_FORMATTER_STYLE_INTEL,
 /* force_memory_size */ ZYAN_FALSE,
 /* force_memory_seg */ ZYAN_FALSE,
 /* force_memory_scale */ ZYAN_TRUE,
 /* force_relative_branches */ ZYAN_FALSE,
 /* force_relative_riprel */ ZYAN_FALSE,
 /* print_branch_size */ ZYAN_FALSE,
 /* detailed_prefixes */ ZYAN_FALSE,
 /* addr_base */ ZYDIS_NUMERIC_BASE_HEX,
 /* addr_signedness */ ZYDIS_SIGNEDNESS_SIGNED,
 /* addr_padding_absolute */ ZYDIS_PADDING_AUTO,
 /* addr_padding_relative */ 2,
 /* disp_base */ ZYDIS_NUMERIC_BASE_HEX,
 /* disp_signedness */ ZYDIS_SIGNEDNESS_SIGNED,
 /* disp_padding */ 2,
 /* imm_base */ ZYDIS_NUMERIC_BASE_HEX,
 /* imm_signedness */ ZYDIS_SIGNEDNESS_UNSIGNED,
 /* imm_padding */ 2,
 /* case_prefixes */ ZYDIS_LETTER_CASE_DEFAULT,
 /* case_mnemonic */ ZYDIS_LETTER_CASE_DEFAULT,
 /* case_registers */ ZYDIS_LETTER_CASE_DEFAULT,
 /* case_typecasts */ ZYDIS_LETTER_CASE_DEFAULT,
 /* case_decorators */ ZYDIS_LETTER_CASE_DEFAULT,
 /* hex_uppercase */ ZYAN_TRUE,
 /* hex_force_leading_number */ ZYAN_FALSE,
 /* number_format */
 {
 // ZYDIS_NUMERIC_BASE_DEC
 {
 // Prefix
 {
 /* string */ ZYAN_NULL,
 /* string_data */ ZYAN_DEFINE_STRING_VIEW(""),
 /* buffer */ { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
 },
 // Suffix
 {
 /* string */ ZYAN_NULL,
 /* string_data */ ZYAN_DEFINE_STRING_VIEW(""),
 /* buffer */ { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
 }
 },
 // ZYDIS_NUMERIC_BASE_HEX
 {
 // Prefix
 {
 /* string */ &FORMATTER_INTEL.number_format[
 ZYDIS_NUMERIC_BASE_HEX][0].string_data,
 /* string_data */ ZYAN_DEFINE_STRING_VIEW("0x"),
 /* buffer */ { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
 },
 // Suffix
 {
 /* string */ ZYAN_NULL,
 /* string_data */ ZYAN_DEFINE_STRING_VIEW(""),
 /* buffer */ { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
 }
 }
 },
 /* func_pre_instruction */ ZYAN_NULL,
 /* func_post_instruction */ ZYAN_NULL,
 /* func_format_instruction */ &ZydisFormatterIntelFormatInstruction,
 /* func_pre_operand */ ZYAN_NULL,
 /* func_post_operand */ ZYAN_NULL,
 /* func_format_operand_reg */ &ZydisFormatterBaseFormatOperandREG,
 /* func_format_operand_mem */ &ZydisFormatterIntelFormatOperandMEM,
 /* func_format_operand_ptr */ &ZydisFormatterBaseFormatOperandPTR,
 /* func_format_operand_imm */ &ZydisFormatterBaseFormatOperandIMM,
 /* func_print_mnemonic */ &ZydisFormatterIntelPrintMnemonic,
 /* func_print_register */ &ZydisFormatterIntelPrintRegister,
 /* func_print_address_abs */ &ZydisFormatterBasePrintAddressABS,
 /* func_print_address_rel */ &ZydisFormatterBasePrintAddressREL,
 /* func_print_disp */ &ZydisFormatterIntelPrintDISP,
 /* func_print_imm */ &ZydisFormatterBasePrintIMM,
 /* func_print_typecast */ &ZydisFormatterIntelPrintTypecast,
 /* func_print_segment */ &ZydisFormatterBasePrintSegment,
 /* func_print_prefixes */ &ZydisFormatterBasePrintPrefixes,
 /* func_print_decorator */ &ZydisFormatterBasePrintDecorator
};
 
/* ---------------------------------------------------------------------------------------------- */
/* MASM */
/* ---------------------------------------------------------------------------------------------- */
 
static const ZydisFormatter FORMATTER_INTEL_MASM =
{
 /* style */ ZYDIS_FORMATTER_STYLE_INTEL_MASM,
 /* force_memory_size */ ZYAN_TRUE,
 /* force_memory_seg */ ZYAN_FALSE,
 /* force_memory_scale */ ZYAN_TRUE,
 /* force_relative_branches */ ZYAN_FALSE,
 /* force_relative_riprel */ ZYAN_FALSE,
 /* print_branch_size */ ZYAN_FALSE,
 /* detailed_prefixes */ ZYAN_FALSE,
 /* addr_base */ ZYDIS_NUMERIC_BASE_HEX,
 /* addr_signedness */ ZYDIS_SIGNEDNESS_SIGNED,
 /* addr_padding_absolute */ ZYDIS_PADDING_DISABLED,
 /* addr_padding_relative */ ZYDIS_PADDING_DISABLED,
 /* disp_base */ ZYDIS_NUMERIC_BASE_HEX,
 /* disp_signedness */ ZYDIS_SIGNEDNESS_SIGNED,
 /* disp_padding */ ZYDIS_PADDING_DISABLED,
 /* imm_base */ ZYDIS_NUMERIC_BASE_HEX,
 /* imm_signedness */ ZYDIS_SIGNEDNESS_AUTO,
 /* imm_padding */ ZYDIS_PADDING_DISABLED,
 /* case_prefixes */ ZYDIS_LETTER_CASE_DEFAULT,
 /* case_mnemonic */ ZYDIS_LETTER_CASE_DEFAULT,
 /* case_registers */ ZYDIS_LETTER_CASE_DEFAULT,
 /* case_typecasts */ ZYDIS_LETTER_CASE_DEFAULT,
 /* case_decorators */ ZYDIS_LETTER_CASE_DEFAULT,
 /* hex_uppercase */ ZYAN_TRUE,
 /* hex_force_leading_number */ ZYAN_TRUE,
 /* number_format */
 {
 // ZYDIS_NUMERIC_BASE_DEC
 {
 // Prefix
 {
 /* string */ ZYAN_NULL,
 /* string_data */ ZYAN_DEFINE_STRING_VIEW(""),
 /* buffer */ { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
 },
 // Suffix
 {
 /* string */ ZYAN_NULL,
 /* string_data */ ZYAN_DEFINE_STRING_VIEW(""),
 /* buffer */ { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
 }
 },
 // ZYDIS_NUMERIC_BASE_HEX
 {
 // Prefix
 {
 /* string */ ZYAN_NULL,
 /* string_data */ ZYAN_DEFINE_STRING_VIEW(""),
 /* buffer */ { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
 },
 // Suffix
 {
 /* string */ &FORMATTER_INTEL_MASM.number_format[
 ZYDIS_NUMERIC_BASE_HEX][1].string_data,
 /* string_data */ ZYAN_DEFINE_STRING_VIEW("h"),
 /* buffer */ { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
 }
 }
 },
 /* func_pre_instruction */ ZYAN_NULL,
 /* func_post_instruction */ ZYAN_NULL,
 /* func_format_instruction */ &ZydisFormatterIntelFormatInstructionMASM,
 /* func_pre_operand */ ZYAN_NULL,
 /* func_post_operand */ ZYAN_NULL,
 /* func_format_operand_reg */ &ZydisFormatterBaseFormatOperandREG,
 /* func_format_operand_mem */ &ZydisFormatterIntelFormatOperandMEM,
 /* func_format_operand_ptr */ &ZydisFormatterBaseFormatOperandPTR,
 /* func_format_operand_imm */ &ZydisFormatterBaseFormatOperandIMM,
 /* func_print_mnemonic */ &ZydisFormatterIntelPrintMnemonic,
 /* func_print_register */ &ZydisFormatterIntelPrintRegister,
 /* func_print_address_abs */ &ZydisFormatterIntelPrintAddressMASM,
 /* func_print_address_rel */ &ZydisFormatterIntelPrintAddressMASM,
 /* func_print_disp */ &ZydisFormatterIntelPrintDISP,
 /* func_print_imm */ &ZydisFormatterBasePrintIMM,
 /* func_print_typecast */ &ZydisFormatterIntelPrintTypecast,
 /* func_print_segment */ &ZydisFormatterBasePrintSegment,
 /* func_print_prefixes */ &ZydisFormatterBasePrintPrefixes,
 /* func_print_decorator */ &ZydisFormatterBasePrintDecorator
};
 
/* ---------------------------------------------------------------------------------------------- */
 
/* ============================================================================================== */
 
#ifdef __cplusplus
}
#endif
 
#endif // ZYDIS_FORMATTER_INTEL_H