Formatter.h

Go to the documentation of this file.

/***************************************************************************************************
 
  Zyan Disassembler Library (Zydis)
 
  Original Author : Florian Bernd
 
 * 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_H
#define ZYDIS_FORMATTER_H
 
#include <Zydis/DecoderTypes.h>
#include <Zydis/Defines.h>
#include <Zydis/Status.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ============================================================================================== */
/* Enums and types                                                                                */
/* ============================================================================================== */
 
typedef uint8_t ZydisFormatterStyle;
 
enum ZydisFormatterStyles
{
    ZYDIS_FORMATTER_STYLE_INTEL,
    ZYDIS_FORMATTER_STYLE_MAX_VALUE = ZYDIS_FORMATTER_STYLE_INTEL
};
 
/* ---------------------------------------------------------------------------------------------- */
 
typedef uint32_t ZydisFormatterFlags;
 
#define ZYDIS_FMTFLAG_UPPERCASE         0x00000001 // (1 << 0)
#define ZYDIS_FMTFLAG_FORCE_SEGMENTS    0x00000002 // (1 << 1)
#define ZYDIS_FMTFLAG_FORCE_OPERANDSIZE 0x00000004 // (1 << 2)
 
/* ---------------------------------------------------------------------------------------------- */
 
typedef uint8_t ZydisFormatterAddressFormat;
 
enum ZydisFormatterAddressFormats
{   
    ZYDIS_FORMATTER_ADDR_DEFAULT,
    ZYDIS_FORMATTER_ADDR_ABSOLUTE,
    ZYDIS_FORMATTER_ADDR_RELATIVE_SIGNED,
    ZYDIS_FORMATTER_ADDR_RELATIVE_UNSIGNED,
    ZYDIS_FORMATTER_ADDR_MAX_VALUE = ZYDIS_FORMATTER_ADDR_RELATIVE_UNSIGNED
};
 
/* ---------------------------------------------------------------------------------------------- */
 
typedef uint8_t ZydisFormatterDisplacementFormat;
 
enum ZydisFormatterDisplacementFormats
{
    ZYDIS_FORMATTER_DISP_DEFAULT,
    ZYDIS_FORMATTER_DISP_HEX_SIGNED,
    ZYDIS_FORMATTER_DISP_HEX_UNSIGNED,
    ZYDIS_FORMATTER_DISP_MAX_VALUE = ZYDIS_FORMATTER_DISP_HEX_UNSIGNED
};
 
/* ---------------------------------------------------------------------------------------------- */
 
typedef uint8_t ZydisFormatterImmediateFormat;
 
enum ZydisFormatterImmediateFormats
{
    ZYDIS_FORMATTER_IMM_DEFAULT,
    ZYDIS_FORMATTER_IMM_HEX_AUTO,
    ZYDIS_FORMATTER_IMM_HEX_SIGNED,
    ZYDIS_FORMATTER_IMM_HEX_UNSIGNED,
    ZYDIS_FORMATTER_IMM_MAX_VALUE = ZYDIS_FORMATTER_IMM_HEX_UNSIGNED
};
 
/* ---------------------------------------------------------------------------------------------- */
 
typedef uint8_t ZydisFormatterHookType;
 
enum ZydisFormatterHookTypes
{
    ZYDIS_FORMATTER_HOOK_PRE,
    ZYDIS_FORMATTER_HOOK_POST,
    ZYDIS_FORMATTER_HOOK_FORMAT_INSTRUCTION,
    ZYDIS_FORMATTER_HOOK_PRINT_PREFIXES,
    ZYDIS_FORMATTER_HOOK_PRINT_MNEMONIC,
    ZYDIS_FORMATTER_HOOK_FORMAT_OPERAND_REG,
    ZYDIS_FORMATTER_HOOK_FORMAT_OPERAND_MEM,
    ZYDIS_FORMATTER_HOOK_FORMAT_OPERAND_PTR,
    ZYDIS_FORMATTER_HOOK_FORMAT_OPERAND_IMM,  
    ZYDIS_FORMATTER_HOOK_PRINT_OPERANDSIZE,
    ZYDIS_FORMATTER_HOOK_PRINT_SEGMENT,
    ZYDIS_FORMATTER_HOOK_PRINT_DECORATOR,
    ZYDIS_FORMATTER_HOOK_PRINT_ADDRESS,
    ZYDIS_FORMATTER_HOOK_PRINT_DISPLACEMENT,
    ZYDIS_FORMATTER_HOOK_PRINT_IMMEDIATE,
    ZYDIS_FORMATTER_HOOK_MAX_VALUE = ZYDIS_FORMATTER_HOOK_PRINT_IMMEDIATE
};
 
/* ---------------------------------------------------------------------------------------------- */
 
typedef uint8_t ZydisDecoratorType;
 
enum ZydisDecoratorTypes
{
    ZYDIS_DECORATOR_TYPE_INVALID,
    ZYDIS_DECORATOR_TYPE_MASK,
    ZYDIS_DECORATOR_TYPE_BROADCAST,
    ZYDIS_DECORATOR_TYPE_ROUNDING_CONTROL,
    ZYDIS_DECORATOR_TYPE_SAE,
    ZYDIS_DECORATOR_TYPE_SWIZZLE,
    ZYDIS_DECORATOR_TYPE_CONVERSION,
    ZYDIS_DECORATOR_TYPE_EVICTION_HINT,
    ZYDIS_DECORATOR_TYPE_MAX_VALUE = ZYDIS_DECORATOR_TYPE_EVICTION_HINT
};
 
typedef struct ZydisFormatter_ ZydisFormatter;
 
typedef ZydisStatus (*ZydisFormatterNotifyFunc)(const ZydisFormatter* formatter, 
    const ZydisDecodedInstruction* instruction, void* userData);
 
typedef ZydisStatus (*ZydisFormatterFormatFunc)(const ZydisFormatter* formatter, 
    char** buffer, size_t bufferLen, const ZydisDecodedInstruction* instruction, void* userData);
 
typedef ZydisStatus (*ZydisFormatterFormatOperandFunc)(const ZydisFormatter* formatter, 
    char** buffer, size_t bufferLen, const ZydisDecodedInstruction* instruction, 
    const ZydisDecodedOperand* operand, void* userData);
 
typedef ZydisStatus (*ZydisFormatterFormatAddressFunc)(const ZydisFormatter* formatter, 
    char** buffer, size_t bufferLen, const ZydisDecodedInstruction* instruction, 
    const ZydisDecodedOperand* operand, uint64_t address, void* userData);
 
typedef ZydisStatus (*ZydisFormatterFormatDecoratorFunc)(const ZydisFormatter* formatter, 
    char** buffer, size_t bufferLen, const ZydisDecodedInstruction* instruction, 
    const ZydisDecodedOperand* operand, ZydisDecoratorType type, void* userData);
 
struct ZydisFormatter_
{
    ZydisFormatterFlags flags;
    ZydisFormatterAddressFormat addressFormat;
    ZydisFormatterDisplacementFormat displacementFormat;
    ZydisFormatterImmediateFormat immediateFormat;
    ZydisFormatterNotifyFunc funcPre;
    ZydisFormatterNotifyFunc funcPost;
    ZydisFormatterFormatFunc funcFormatInstruction;
    ZydisFormatterFormatFunc funcPrintPrefixes;
    ZydisFormatterFormatFunc funcPrintMnemonic;
    ZydisFormatterFormatOperandFunc funcFormatOperandReg;
    ZydisFormatterFormatOperandFunc funcFormatOperandMem;
    ZydisFormatterFormatOperandFunc funcFormatOperandPtr;
    ZydisFormatterFormatOperandFunc funcFormatOperandImm;
    ZydisFormatterFormatOperandFunc funcPrintOperandSize;
    ZydisFormatterFormatOperandFunc funcPrintSegment;
    ZydisFormatterFormatDecoratorFunc funcPrintDecorator;
    ZydisFormatterFormatAddressFunc funcPrintAddress;
    ZydisFormatterFormatOperandFunc funcPrintDisplacement;
    ZydisFormatterFormatOperandFunc funcPrintImmediate; 
};
 
/* ============================================================================================== */
/* Exported functions                                                                             */
/* ============================================================================================== */
 
ZYDIS_EXPORT ZydisStatus ZydisFormatterInit(ZydisFormatter* formatter, ZydisFormatterStyle style);
 
ZYDIS_EXPORT ZydisStatus ZydisFormatterInitEx(ZydisFormatter* formatter, ZydisFormatterStyle style, 
    ZydisFormatterFlags flags, ZydisFormatterAddressFormat addressFormat, 
    ZydisFormatterDisplacementFormat displacementFormat,
    ZydisFormatterImmediateFormat immmediateFormat);
 
ZYDIS_EXPORT ZydisStatus ZydisFormatterSetHook(ZydisFormatter* formatter, 
    ZydisFormatterHookType hook, const void** callback);
 
ZYDIS_EXPORT ZydisStatus ZydisFormatterFormatInstruction(const ZydisFormatter* formatter, 
    ZydisDecodedInstruction* instruction, char* buffer, size_t bufferLen);
 
ZYDIS_EXPORT ZydisStatus ZydisFormatterFormatInstructionEx(const ZydisFormatter* formatter, 
    ZydisDecodedInstruction* instruction, char* buffer, size_t bufferLen, void* userData);
 
/* ============================================================================================== */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZYDIS_FORMATTER_H */