Register.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_REGISTER_H
#define ZYDIS_REGISTER_H
 
#include <Zycore/Defines.h>
#include <Zycore/Types.h>
#include <Zydis/Defines.h>
#include <Zydis/SharedTypes.h>
#include <Zydis/ShortString.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ============================================================================================== */
/* Enums and types */
/* ============================================================================================== */
 
/* ---------------------------------------------------------------------------------------------- */
/* Registers */
/* ---------------------------------------------------------------------------------------------- */
 
#include <Zydis/Generated/EnumRegister.h>
 
/* ---------------------------------------------------------------------------------------------- */
/* Register kinds */
/* ---------------------------------------------------------------------------------------------- */
 
typedef enum ZydisRegisterKind_
{
 ZYDIS_REGKIND_INVALID,
 ZYDIS_REGKIND_GPR,
 ZYDIS_REGKIND_X87,
 ZYDIS_REGKIND_MMX,
 ZYDIS_REGKIND_VR,
 ZYDIS_REGKIND_TMM,
 ZYDIS_REGKIND_SEGMENT,
 ZYDIS_REGKIND_TEST,
 ZYDIS_REGKIND_CONTROL,
 ZYDIS_REGKIND_DEBUG,
 ZYDIS_REGKIND_MASK,
 ZYDIS_REGKIND_BOUND,
 
 ZYDIS_REGKIND_MAX_VALUE = ZYDIS_REGKIND_BOUND,
 ZYDIS_REGKIND_REQUIRED_BITS = ZYAN_BITS_TO_REPRESENT(ZYDIS_REGKIND_MAX_VALUE)
} ZydisRegisterKind;
 
/* ---------------------------------------------------------------------------------------------- */
/* Register classes */
/* ---------------------------------------------------------------------------------------------- */
 
typedef enum ZydisRegisterClass_
{
 ZYDIS_REGCLASS_INVALID,
 ZYDIS_REGCLASS_GPR8,
 ZYDIS_REGCLASS_GPR16,
 ZYDIS_REGCLASS_GPR32,
 ZYDIS_REGCLASS_GPR64,
 ZYDIS_REGCLASS_X87,
 ZYDIS_REGCLASS_MMX,
 ZYDIS_REGCLASS_XMM,
 ZYDIS_REGCLASS_YMM,
 ZYDIS_REGCLASS_ZMM,
 ZYDIS_REGCLASS_TMM,
 /*
 * Flags registers.
 */
 ZYDIS_REGCLASS_FLAGS,
 ZYDIS_REGCLASS_IP,
 ZYDIS_REGCLASS_SEGMENT,
 ZYDIS_REGCLASS_TABLE,
 ZYDIS_REGCLASS_TEST,
 ZYDIS_REGCLASS_CONTROL,
 ZYDIS_REGCLASS_DEBUG,
 ZYDIS_REGCLASS_MASK,
 ZYDIS_REGCLASS_BOUND,
 
 ZYDIS_REGCLASS_MAX_VALUE = ZYDIS_REGCLASS_BOUND,
 ZYDIS_REGCLASS_REQUIRED_BITS = ZYAN_BITS_TO_REPRESENT(ZYDIS_REGCLASS_MAX_VALUE)
} ZydisRegisterClass;
 
/* ---------------------------------------------------------------------------------------------- */
/* Register width */
/* ---------------------------------------------------------------------------------------------- */
 
typedef ZyanU16 ZydisRegisterWidth;
 
/* ---------------------------------------------------------------------------------------------- */
/* Register context */
/* ---------------------------------------------------------------------------------------------- */
 
typedef struct ZydisRegisterContext_
{
 ZyanU64 values[ZYDIS_REGISTER_MAX_VALUE + 1];
} ZydisRegisterContext;
 
/* ---------------------------------------------------------------------------------------------- */
 
/* ============================================================================================== */
/* Exported functions */
/* ============================================================================================== */
 
/* ---------------------------------------------------------------------------------------------- */
/* Register */
/* ---------------------------------------------------------------------------------------------- */
 
ZYDIS_EXPORT ZydisRegister ZydisRegisterEncode(ZydisRegisterClass register_class, ZyanU8 id);
 
ZYDIS_EXPORT ZyanI8 ZydisRegisterGetId(ZydisRegister reg);
 
ZYDIS_EXPORT ZydisRegisterClass ZydisRegisterGetClass(ZydisRegister reg);
 
ZYDIS_EXPORT ZydisRegisterWidth ZydisRegisterGetWidth(ZydisMachineMode mode, ZydisRegister reg);
 
ZYDIS_EXPORT ZydisRegister ZydisRegisterGetLargestEnclosing(ZydisMachineMode mode,
 ZydisRegister reg);
 
ZYDIS_EXPORT const char* ZydisRegisterGetString(ZydisRegister reg);
 
ZYDIS_EXPORT const ZydisShortString* ZydisRegisterGetStringWrapped(ZydisRegister reg);
 
/* ---------------------------------------------------------------------------------------------- */
/* Register class */
/* ---------------------------------------------------------------------------------------------- */
 
ZYDIS_EXPORT ZydisRegisterWidth ZydisRegisterClassGetWidth(ZydisMachineMode mode,
 ZydisRegisterClass register_class);
 
/* ---------------------------------------------------------------------------------------------- */
 
/* ============================================================================================== */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZYDIS_REGISTER_H */