Zydis v4.0.0
Loading...
Searching...
No Matches
SharedTypes.h
Go to the documentation of this file.
1/***************************************************************************************************
2
3 Zyan Disassembler Library (Zydis)
4
5 Original Author : Florian Bernd
6
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in all
15 * copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24
25***************************************************************************************************/
26
32#ifndef ZYDIS_SHAREDTYPES_H
33#define ZYDIS_SHAREDTYPES_H
34
35#include <Zycore/Types.h>
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41/* ============================================================================================== */
42/* Macros */
43/* ============================================================================================== */
44
45/* ---------------------------------------------------------------------------------------------- */
46/* Constants */
47/* ---------------------------------------------------------------------------------------------- */
48
49#define ZYDIS_MAX_INSTRUCTION_LENGTH 15
50#define ZYDIS_MAX_OPERAND_COUNT 10 // TODO: Auto generate
51#define ZYDIS_MAX_OPERAND_COUNT_VISIBLE 5 // TODO: Auto generate
52
53/* ---------------------------------------------------------------------------------------------- */
54
55/* ============================================================================================== */
56/* Enums and types */
57/* ============================================================================================== */
58
59/* ---------------------------------------------------------------------------------------------- */
60/* Machine mode */
61/* ---------------------------------------------------------------------------------------------- */
62
67{
92
102
103/* ---------------------------------------------------------------------------------------------- */
104/* Stack width */
105/* ---------------------------------------------------------------------------------------------- */
106
111{
112 ZYDIS_STACK_WIDTH_16,
113 ZYDIS_STACK_WIDTH_32,
114 ZYDIS_STACK_WIDTH_64,
115
119 ZYDIS_STACK_WIDTH_MAX_VALUE = ZYDIS_STACK_WIDTH_64,
125
126/* ---------------------------------------------------------------------------------------------- */
127/* Element type */
128/* ---------------------------------------------------------------------------------------------- */
129
134{
135 ZYDIS_ELEMENT_TYPE_INVALID,
172
182
183/* ---------------------------------------------------------------------------------------------- */
184/* Element size */
185/* ---------------------------------------------------------------------------------------------- */
186
190typedef ZyanU16 ZydisElementSize;
191
192/* ---------------------------------------------------------------------------------------------- */
193/* Operand type */
194/* ---------------------------------------------------------------------------------------------- */
195
200{
221
231
232// If asserts are failing here remember to update encoder table generator before fixing asserts
233ZYAN_STATIC_ASSERT(ZYAN_BITS_TO_REPRESENT(
235
236/* ---------------------------------------------------------------------------------------------- */
237/* Operand encoding */
238/* ---------------------------------------------------------------------------------------------- */
239
244{
245 ZYDIS_OPERAND_ENCODING_NONE,
246 ZYDIS_OPERAND_ENCODING_MODRM_REG,
247 ZYDIS_OPERAND_ENCODING_MODRM_RM,
248 ZYDIS_OPERAND_ENCODING_OPCODE,
249 ZYDIS_OPERAND_ENCODING_NDSNDD,
250 ZYDIS_OPERAND_ENCODING_IS4,
251 ZYDIS_OPERAND_ENCODING_MASK,
252 ZYDIS_OPERAND_ENCODING_DISP8,
253 ZYDIS_OPERAND_ENCODING_DISP16,
254 ZYDIS_OPERAND_ENCODING_DISP32,
255 ZYDIS_OPERAND_ENCODING_DISP64,
256 ZYDIS_OPERAND_ENCODING_DISP16_32_64,
257 ZYDIS_OPERAND_ENCODING_DISP32_32_64,
258 ZYDIS_OPERAND_ENCODING_DISP16_32_32,
259 ZYDIS_OPERAND_ENCODING_UIMM8,
260 ZYDIS_OPERAND_ENCODING_UIMM16,
261 ZYDIS_OPERAND_ENCODING_UIMM32,
262 ZYDIS_OPERAND_ENCODING_UIMM64,
263 ZYDIS_OPERAND_ENCODING_UIMM16_32_64,
264 ZYDIS_OPERAND_ENCODING_UIMM32_32_64,
265 ZYDIS_OPERAND_ENCODING_UIMM16_32_32,
266 ZYDIS_OPERAND_ENCODING_SIMM8,
267 ZYDIS_OPERAND_ENCODING_SIMM16,
268 ZYDIS_OPERAND_ENCODING_SIMM32,
269 ZYDIS_OPERAND_ENCODING_SIMM64,
270 ZYDIS_OPERAND_ENCODING_SIMM16_32_64,
271 ZYDIS_OPERAND_ENCODING_SIMM32_32_64,
272 ZYDIS_OPERAND_ENCODING_SIMM16_32_32,
273 ZYDIS_OPERAND_ENCODING_JIMM8,
274 ZYDIS_OPERAND_ENCODING_JIMM16,
275 ZYDIS_OPERAND_ENCODING_JIMM32,
276 ZYDIS_OPERAND_ENCODING_JIMM64,
277 ZYDIS_OPERAND_ENCODING_JIMM16_32_64,
278 ZYDIS_OPERAND_ENCODING_JIMM32_32_64,
279 ZYDIS_OPERAND_ENCODING_JIMM16_32_32,
280
284 ZYDIS_OPERAND_ENCODING_MAX_VALUE = ZYDIS_OPERAND_ENCODING_JIMM16_32_32,
290
291/* ---------------------------------------------------------------------------------------------- */
292/* Operand visibility */
293/* ---------------------------------------------------------------------------------------------- */
294
299{
300 ZYDIS_OPERAND_VISIBILITY_INVALID,
313
322 ZYAN_BITS_TO_REPRESENT(ZYDIS_OPERAND_VISIBILITY_MAX_VALUE)
324
325/* ---------------------------------------------------------------------------------------------- */
326/* Operand action */
327/* ---------------------------------------------------------------------------------------------- */
328
333{
334 /* ------------------------------------------------------------------------------------------ */
335 /* Elemental actions */
336 /* ------------------------------------------------------------------------------------------ */
337
354
355 /* ------------------------------------------------------------------------------------------ */
356 /* Combined actions */
357 /* ------------------------------------------------------------------------------------------ */
358
381
390
391 /* ------------------------------------------------------------------------------------------ */
392
398
402typedef ZyanU8 ZydisOperandActions;
403
404/* ---------------------------------------------------------------------------------------------- */
405/* Instruction encoding */
406/* ---------------------------------------------------------------------------------------------- */
407
412{
437
446 ZYAN_BITS_TO_REPRESENT(ZYDIS_INSTRUCTION_ENCODING_MAX_VALUE)
448
449/* ---------------------------------------------------------------------------------------------- */
450/* Opcode map */
451/* ---------------------------------------------------------------------------------------------- */
452
456typedef enum ZydisOpcodeMap_
457{
458 ZYDIS_OPCODE_MAP_DEFAULT,
459 ZYDIS_OPCODE_MAP_0F,
460 ZYDIS_OPCODE_MAP_0F38,
461 ZYDIS_OPCODE_MAP_0F3A,
462 ZYDIS_OPCODE_MAP_MAP4, // not used
463 ZYDIS_OPCODE_MAP_MAP5,
464 ZYDIS_OPCODE_MAP_MAP6,
465 ZYDIS_OPCODE_MAP_MAP7, // not used
466 ZYDIS_OPCODE_MAP_0F0F,
467 ZYDIS_OPCODE_MAP_XOP8,
468 ZYDIS_OPCODE_MAP_XOP9,
469 ZYDIS_OPCODE_MAP_XOPA,
470
474 ZYDIS_OPCODE_MAP_MAX_VALUE = ZYDIS_OPCODE_MAP_XOPA,
480
481/* ---------------------------------------------------------------------------------------------- */
482/* Instruction attributes */
483/* ---------------------------------------------------------------------------------------------- */
484
498
502#define ZYDIS_ATTRIB_HAS_MODRM (1ULL << 0)
506#define ZYDIS_ATTRIB_HAS_SIB (1ULL << 1)
510#define ZYDIS_ATTRIB_HAS_REX (1ULL << 2)
514#define ZYDIS_ATTRIB_HAS_XOP (1ULL << 3)
518#define ZYDIS_ATTRIB_HAS_VEX (1ULL << 4)
522#define ZYDIS_ATTRIB_HAS_EVEX (1ULL << 5)
526#define ZYDIS_ATTRIB_HAS_MVEX (1ULL << 6)
530#define ZYDIS_ATTRIB_IS_RELATIVE (1ULL << 7)
536#define ZYDIS_ATTRIB_IS_PRIVILEGED (1ULL << 8)
540#define ZYDIS_ATTRIB_CPUFLAG_ACCESS (1ULL << 9)
544#define ZYDIS_ATTRIB_CPU_STATE_CR (1ULL << 10)
548#define ZYDIS_ATTRIB_CPU_STATE_CW (1ULL << 11)
552#define ZYDIS_ATTRIB_FPU_STATE_CR (1ULL << 12)
556#define ZYDIS_ATTRIB_FPU_STATE_CW (1ULL << 13)
560#define ZYDIS_ATTRIB_XMM_STATE_CR (1ULL << 14)
564#define ZYDIS_ATTRIB_XMM_STATE_CW (1ULL << 15)
568#define ZYDIS_ATTRIB_ACCEPTS_LOCK (1ULL << 16)
572#define ZYDIS_ATTRIB_ACCEPTS_REP (1ULL << 17)
576#define ZYDIS_ATTRIB_ACCEPTS_REPE (1ULL << 18)
580#define ZYDIS_ATTRIB_ACCEPTS_REPZ ZYDIS_ATTRIB_ACCEPTS_REPE
584#define ZYDIS_ATTRIB_ACCEPTS_REPNE (1ULL << 19)
588#define ZYDIS_ATTRIB_ACCEPTS_REPNZ ZYDIS_ATTRIB_ACCEPTS_REPNE
592#define ZYDIS_ATTRIB_ACCEPTS_BND (1ULL << 20)
596#define ZYDIS_ATTRIB_ACCEPTS_XACQUIRE (1ULL << 21)
600#define ZYDIS_ATTRIB_ACCEPTS_XRELEASE (1ULL << 22)
605#define ZYDIS_ATTRIB_ACCEPTS_HLE_WITHOUT_LOCK (1ULL << 23)
609#define ZYDIS_ATTRIB_ACCEPTS_BRANCH_HINTS (1ULL << 24)
613#define ZYDIS_ATTRIB_ACCEPTS_NOTRACK (1ULL << 25)
618#define ZYDIS_ATTRIB_ACCEPTS_SEGMENT (1ULL << 26)
622#define ZYDIS_ATTRIB_HAS_LOCK (1ULL << 27)
626#define ZYDIS_ATTRIB_HAS_REP (1ULL << 28)
630#define ZYDIS_ATTRIB_HAS_REPE (1ULL << 29)
634#define ZYDIS_ATTRIB_HAS_REPZ ZYDIS_ATTRIB_HAS_REPE
638#define ZYDIS_ATTRIB_HAS_REPNE (1ULL << 30)
642#define ZYDIS_ATTRIB_HAS_REPNZ ZYDIS_ATTRIB_HAS_REPNE
646#define ZYDIS_ATTRIB_HAS_BND (1ULL << 31)
650#define ZYDIS_ATTRIB_HAS_XACQUIRE (1ULL << 32)
654#define ZYDIS_ATTRIB_HAS_XRELEASE (1ULL << 33)
658#define ZYDIS_ATTRIB_HAS_BRANCH_NOT_TAKEN (1ULL << 34)
662#define ZYDIS_ATTRIB_HAS_BRANCH_TAKEN (1ULL << 35)
666#define ZYDIS_ATTRIB_HAS_NOTRACK (1ULL << 36)
670#define ZYDIS_ATTRIB_HAS_SEGMENT_CS (1ULL << 37)
674#define ZYDIS_ATTRIB_HAS_SEGMENT_SS (1ULL << 38)
678#define ZYDIS_ATTRIB_HAS_SEGMENT_DS (1ULL << 39)
682#define ZYDIS_ATTRIB_HAS_SEGMENT_ES (1ULL << 40)
686#define ZYDIS_ATTRIB_HAS_SEGMENT_FS (1ULL << 41)
690#define ZYDIS_ATTRIB_HAS_SEGMENT_GS (1ULL << 42)
694#define ZYDIS_ATTRIB_HAS_SEGMENT (ZYDIS_ATTRIB_HAS_SEGMENT_CS | \
695 ZYDIS_ATTRIB_HAS_SEGMENT_SS | \
696 ZYDIS_ATTRIB_HAS_SEGMENT_DS | \
697 ZYDIS_ATTRIB_HAS_SEGMENT_ES | \
698 ZYDIS_ATTRIB_HAS_SEGMENT_FS | \
699 ZYDIS_ATTRIB_HAS_SEGMENT_GS)
703#define ZYDIS_ATTRIB_HAS_OPERANDSIZE (1ULL << 43) // TODO: rename
707#define ZYDIS_ATTRIB_HAS_ADDRESSSIZE (1ULL << 44) // TODO: rename
713#define ZYDIS_ATTRIB_HAS_EVEX_B (1ULL << 45) // TODO: rename
714
719/* ---------------------------------------------------------------------------------------------- */
720
721/* ============================================================================================== */
722
723#ifdef __cplusplus
724}
725#endif
726
727#endif /* ZYDIS_SHAREDTYPES_H */
ZydisElementType_
Defines the ZydisElementType enum.
Definition SharedTypes.h:134
@ ZYDIS_ELEMENT_TYPE_LONGBCD
Binary coded decimal value.
Definition SharedTypes.h:167
@ ZYDIS_ELEMENT_TYPE_REQUIRED_BITS
The minimum number of bits required to represent all values of this enum.
Definition SharedTypes.h:180
@ ZYDIS_ELEMENT_TYPE_UINT
Unsigned integer value.
Definition SharedTypes.h:143
@ ZYDIS_ELEMENT_TYPE_FLOAT64
64-bit floating point value (double).
Definition SharedTypes.h:159
@ ZYDIS_ELEMENT_TYPE_INT
Signed integer value.
Definition SharedTypes.h:147
@ ZYDIS_ELEMENT_TYPE_STRUCT
A struct type.
Definition SharedTypes.h:139
@ ZYDIS_ELEMENT_TYPE_FLOAT16
16-bit floating point value (half).
Definition SharedTypes.h:151
@ ZYDIS_ELEMENT_TYPE_MAX_VALUE
Maximum value of this enum.
Definition SharedTypes.h:176
@ ZYDIS_ELEMENT_TYPE_FLOAT32
32-bit floating point value (single).
Definition SharedTypes.h:155
@ ZYDIS_ELEMENT_TYPE_FLOAT80
80-bit floating point value (extended).
Definition SharedTypes.h:163
@ ZYDIS_ELEMENT_TYPE_CC
A condition code (e.g.
Definition SharedTypes.h:171
enum ZydisOperandEncoding_ ZydisOperandEncoding
Defines the ZydisOperandEncoding enum.
ZydisOperandVisibility_
Defines the ZydisOperandVisibility enum.
Definition SharedTypes.h:299
@ ZYDIS_OPERAND_VISIBILITY_IMPLICIT
The operand is part of the opcode, but listed as an operand.
Definition SharedTypes.h:308
@ ZYDIS_OPERAND_VISIBILITY_EXPLICIT
The operand is explicitly encoded in the instruction.
Definition SharedTypes.h:304
@ ZYDIS_OPERAND_VISIBILITY_REQUIRED_BITS
The minimum number of bits required to represent all values of this enum.
Definition SharedTypes.h:321
@ ZYDIS_OPERAND_VISIBILITY_MAX_VALUE
Maximum value of this enum.
Definition SharedTypes.h:317
@ ZYDIS_OPERAND_VISIBILITY_HIDDEN
The operand is part of the opcode, and not typically listed as an operand.
Definition SharedTypes.h:312
ZydisMachineMode_
Defines the ZydisMachineMode enum.
Definition SharedTypes.h:67
@ ZYDIS_MACHINE_MODE_LONG_COMPAT_16
16 bit protected mode.
Definition SharedTypes.h:79
@ ZYDIS_MACHINE_MODE_LONG_COMPAT_32
32 bit protected mode.
Definition SharedTypes.h:75
@ ZYDIS_MACHINE_MODE_REAL_16
16 bit real mode.
Definition SharedTypes.h:91
@ ZYDIS_MACHINE_MODE_REQUIRED_BITS
The minimum number of bits required to represent all values of this enum.
Definition SharedTypes.h:100
@ ZYDIS_MACHINE_MODE_LEGACY_16
16 bit protected mode.
Definition SharedTypes.h:87
@ ZYDIS_MACHINE_MODE_MAX_VALUE
Maximum value of this enum.
Definition SharedTypes.h:96
@ ZYDIS_MACHINE_MODE_LEGACY_32
32 bit protected mode.
Definition SharedTypes.h:83
@ ZYDIS_MACHINE_MODE_LONG_64
64 bit mode.
Definition SharedTypes.h:71
enum ZydisOperandAction_ ZydisOperandAction
Defines the ZydisOperandAction enum.
enum ZydisInstructionEncoding_ ZydisInstructionEncoding
Defines the ZydisInstructionEncoding enum.
enum ZydisOperandType_ ZydisOperandType
Defines the ZydisOperandType enum.
enum ZydisOperandVisibility_ ZydisOperandVisibility
Defines the ZydisOperandVisibility enum.
ZyanU8 ZydisOperandActions
Defines the ZydisOperandActions data-type.
Definition SharedTypes.h:402
enum ZydisStackWidth_ ZydisStackWidth
Defines the ZydisStackWidth enum.
enum ZydisOpcodeMap_ ZydisOpcodeMap
Defines the ZydisOpcodeMap enum.
ZydisOperandEncoding_
Defines the ZydisOperandEncoding enum.
Definition SharedTypes.h:244
@ ZYDIS_OPERAND_ENCODING_MAX_VALUE
Maximum value of this enum.
Definition SharedTypes.h:284
@ ZYDIS_OPERAND_ENCODING_REQUIRED_BITS
The minimum number of bits required to represent all values of this enum.
Definition SharedTypes.h:288
ZydisInstructionEncoding_
Defines the ZydisInstructionEncoding enum.
Definition SharedTypes.h:412
@ ZYDIS_INSTRUCTION_ENCODING_VEX
The instruction uses the VEX-encoding.
Definition SharedTypes.h:428
@ ZYDIS_INSTRUCTION_ENCODING_3DNOW
The instruction uses the AMD 3DNow-encoding.
Definition SharedTypes.h:420
@ ZYDIS_INSTRUCTION_ENCODING_REQUIRED_BITS
The minimum number of bits required to represent all values of this enum.
Definition SharedTypes.h:445
@ ZYDIS_INSTRUCTION_ENCODING_MVEX
The instruction uses the MVEX-encoding.
Definition SharedTypes.h:436
@ ZYDIS_INSTRUCTION_ENCODING_LEGACY
The instruction uses the legacy encoding.
Definition SharedTypes.h:416
@ ZYDIS_INSTRUCTION_ENCODING_MAX_VALUE
Maximum value of this enum.
Definition SharedTypes.h:441
@ ZYDIS_INSTRUCTION_ENCODING_EVEX
The instruction uses the EVEX-encoding.
Definition SharedTypes.h:432
@ ZYDIS_INSTRUCTION_ENCODING_XOP
The instruction uses the AMD XOP-encoding.
Definition SharedTypes.h:424
ZydisStackWidth_
Defines the ZydisStackWidth enum.
Definition SharedTypes.h:111
@ ZYDIS_STACK_WIDTH_REQUIRED_BITS
The minimum number of bits required to represent all values of this enum.
Definition SharedTypes.h:123
@ ZYDIS_STACK_WIDTH_MAX_VALUE
Maximum value of this enum.
Definition SharedTypes.h:119
ZydisOperandAction_
Defines the ZydisOperandAction enum.
Definition SharedTypes.h:333
@ ZYDIS_OPERAND_ACTION_CONDWRITE
The operand is conditionally written by the instruction (may write).
Definition SharedTypes.h:353
@ ZYDIS_OPERAND_ACTION_READWRITE
The operand is read (must read) and written by the instruction (must write).
Definition SharedTypes.h:362
@ ZYDIS_OPERAND_ACTION_CONDREAD_WRITE
The operand is written (must write) and conditionally read by the instruction (may read).
Definition SharedTypes.h:379
@ ZYDIS_OPERAND_ACTION_CONDREAD
The operand is conditionally read by the instruction.
Definition SharedTypes.h:349
@ ZYDIS_OPERAND_ACTION_WRITE
The operand is written by the instruction (must write).
Definition SharedTypes.h:345
@ ZYDIS_OPERAND_ACTION_MASK_READ
Mask combining all reading access flags.
Definition SharedTypes.h:385
@ ZYDIS_OPERAND_ACTION_REQUIRED_BITS
The minimum number of bits required to represent all values of this bitset.
Definition SharedTypes.h:396
@ ZYDIS_OPERAND_ACTION_CONDREAD_CONDWRITE
The operand is conditionally read (may read) and conditionally written by the instruction (may write)...
Definition SharedTypes.h:367
@ ZYDIS_OPERAND_ACTION_READ
The operand is read by the instruction.
Definition SharedTypes.h:341
@ ZYDIS_OPERAND_ACTION_READ_CONDWRITE
The operand is read (must read) and conditionally written by the instruction (may write).
Definition SharedTypes.h:373
@ ZYDIS_OPERAND_ACTION_MASK_WRITE
Mask combining all writing access flags.
Definition SharedTypes.h:389
ZydisOpcodeMap_
Defines the ZydisOpcodeMap enum.
Definition SharedTypes.h:457
@ ZYDIS_OPCODE_MAP_REQUIRED_BITS
The minimum number of bits required to represent all values of this enum.
Definition SharedTypes.h:478
@ ZYDIS_OPCODE_MAP_MAX_VALUE
Maximum value of this enum.
Definition SharedTypes.h:474
enum ZydisElementType_ ZydisElementType
Defines the ZydisElementType enum.
ZyanU16 ZydisElementSize
Defines the ZydisElementSize datatype.
Definition SharedTypes.h:190
enum ZydisMachineMode_ ZydisMachineMode
Defines the ZydisMachineMode enum.
ZydisOperandType_
Defines the ZydisOperandType enum.
Definition SharedTypes.h:200
@ ZYDIS_OPERAND_TYPE_IMMEDIATE
The operand is an immediate operand.
Definition SharedTypes.h:220
@ ZYDIS_OPERAND_TYPE_REQUIRED_BITS
The minimum number of bits required to represent all values of this enum.
Definition SharedTypes.h:229
@ ZYDIS_OPERAND_TYPE_UNUSED
The operand is not used.
Definition SharedTypes.h:204
@ ZYDIS_OPERAND_TYPE_MAX_VALUE
Maximum value of this enum.
Definition SharedTypes.h:225
@ ZYDIS_OPERAND_TYPE_REGISTER
The operand is a register operand.
Definition SharedTypes.h:208
@ ZYDIS_OPERAND_TYPE_MEMORY
The operand is a memory operand.
Definition SharedTypes.h:212
@ ZYDIS_OPERAND_TYPE_POINTER
The operand is a pointer operand with a segment:offset lvalue.
Definition SharedTypes.h:216
ZyanU64 ZydisInstructionAttributes
Defines the ZydisInstructionAttributes data-type.
Definition SharedTypes.h:497