DecoderData.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_INTERNAL_DECODERDATA_H
#define ZYDIS_INTERNAL_DECODERDATA_H
 
#include <Zycore/Defines.h>
#include <Zycore/Types.h>
#include <Zydis/Defines.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ============================================================================================== */
/* Enums and types */
/* ============================================================================================== */
 
// MSVC does not like types other than (un-)signed int for bit-fields
#ifdef ZYAN_MSVC
# pragma warning(push)
# pragma warning(disable:4214)
#endif
 
#pragma pack(push, 1)
 
/* ---------------------------------------------------------------------------------------------- */
/* Decoder tree */
/* ---------------------------------------------------------------------------------------------- */
 
typedef ZyanU8 ZydisDecoderTreeNodeType;
 
enum ZydisDecoderTreeNodeTypes
{
 ZYDIS_NODETYPE_INVALID = 0x00,
 ZYDIS_NODETYPE_DEFINITION_MASK = 0x80,
 ZYDIS_NODETYPE_FILTER_XOP = 0x01,
 ZYDIS_NODETYPE_FILTER_VEX = 0x02,
 ZYDIS_NODETYPE_FILTER_EMVEX = 0x03,
 ZYDIS_NODETYPE_FILTER_OPCODE = 0x04,
 ZYDIS_NODETYPE_FILTER_MODE = 0x05,
 ZYDIS_NODETYPE_FILTER_MODE_COMPACT = 0x06,
 ZYDIS_NODETYPE_FILTER_MODRM_MOD = 0x07,
 ZYDIS_NODETYPE_FILTER_MODRM_MOD_COMPACT = 0x08,
 ZYDIS_NODETYPE_FILTER_MODRM_REG = 0x09,
 ZYDIS_NODETYPE_FILTER_MODRM_RM = 0x0A,
 ZYDIS_NODETYPE_FILTER_PREFIX_GROUP1 = 0x0B,
 ZYDIS_NODETYPE_FILTER_MANDATORY_PREFIX = 0x0C,
 ZYDIS_NODETYPE_FILTER_OPERAND_SIZE = 0x0D,
 ZYDIS_NODETYPE_FILTER_ADDRESS_SIZE = 0x0E,
 ZYDIS_NODETYPE_FILTER_VECTOR_LENGTH = 0x0F,
 ZYDIS_NODETYPE_FILTER_REX_W = 0x10,
 ZYDIS_NODETYPE_FILTER_REX_B = 0x11,
 ZYDIS_NODETYPE_FILTER_EVEX_B = 0x12,
 ZYDIS_NODETYPE_FILTER_MVEX_E = 0x13,
 ZYDIS_NODETYPE_FILTER_MODE_AMD = 0x14,
 ZYDIS_NODETYPE_FILTER_MODE_KNC = 0x15,
 ZYDIS_NODETYPE_FILTER_MODE_MPX = 0x16,
 ZYDIS_NODETYPE_FILTER_MODE_CET = 0x17,
 ZYDIS_NODETYPE_FILTER_MODE_LZCNT = 0x18,
 ZYDIS_NODETYPE_FILTER_MODE_TZCNT = 0x19,
 ZYDIS_NODETYPE_FILTER_MODE_WBNOINVD = 0x1A,
 ZYDIS_NODETYPE_FILTER_MODE_CLDEMOTE = 0x1B,
 ZYDIS_NODETYPE_FILTER_MODE_IPREFETCH = 0x1C,
 ZYDIS_NODETYPE_FILTER_MODE_UD0_COMPAT = 0x1D
};
 
/* ---------------------------------------------------------------------------------------------- */
 
typedef ZyanU16 ZydisDecoderTreeNodeValue;
 
/* ---------------------------------------------------------------------------------------------- */
 
typedef struct ZydisDecoderTreeNode_
{
 ZydisDecoderTreeNodeType type;
 ZydisDecoderTreeNodeValue value;
} ZydisDecoderTreeNode;
 
/* ---------------------------------------------------------------------------------------------- */
 
#pragma pack(pop)
 
#ifdef ZYAN_MSVC
# pragma warning(pop)
#endif
 
/* ---------------------------------------------------------------------------------------------- */
/* Physical instruction encoding info */
/* ---------------------------------------------------------------------------------------------- */
 
typedef ZyanU8 ZydisInstructionEncodingFlags;
 
#define ZYDIS_INSTR_ENC_FLAG_HAS_MODRM 0x01
 
#define ZYDIS_INSTR_ENC_FLAG_HAS_DISP 0x02
 
#define ZYDIS_INSTR_ENC_FLAG_HAS_IMM0 0x04
 
#define ZYDIS_INSTR_ENC_FLAG_HAS_IMM1 0x08
 
#define ZYDIS_INSTR_ENC_FLAG_FORCE_REG_FORM 0x10
 
typedef struct ZydisInstructionEncodingInfo_
{
 ZydisInstructionEncodingFlags flags;
 struct
 {
 ZyanU8 size[3];
 } disp;
 struct
 {
 ZyanU8 size[3];
 ZyanBool is_signed;
 ZyanBool is_relative;
 } imm[2];
} ZydisInstructionEncodingInfo;
 
/* ---------------------------------------------------------------------------------------------- */
 
/* ============================================================================================== */
/* Functions */
/* ============================================================================================== */
 
/* ---------------------------------------------------------------------------------------------- */
/* Decoder tree */
/* ---------------------------------------------------------------------------------------------- */
 
extern const ZydisDecoderTreeNode zydis_decoder_tree_root;
 
ZYAN_INLINE const ZydisDecoderTreeNode* ZydisDecoderTreeGetRootNode(void)
{
 return &zydis_decoder_tree_root;
}
 
ZYDIS_NO_EXPORT const ZydisDecoderTreeNode* ZydisDecoderTreeGetChildNode(
 const ZydisDecoderTreeNode* parent, ZyanU16 index);
 
ZYDIS_NO_EXPORT void ZydisGetInstructionEncodingInfo(const ZydisDecoderTreeNode* node,
 const ZydisInstructionEncodingInfo** info);
 
/* ---------------------------------------------------------------------------------------------- */
 
/* ============================================================================================== */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZYDIS_INTERNAL_DECODERDATA_H */