Zydis  v2.0.0-alpha2
Zydis.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_H
33 #define ZYDIS_H
34 
35 #include <Zydis/CommonTypes.h>
36 #include <Zydis/Decoder.h>
37 #include <Zydis/DecoderTypes.h>
38 #include <Zydis/Defines.h>
39 #include <Zydis/Formatter.h>
40 #include <Zydis/MetaInfo.h>
41 #include <Zydis/Mnemonic.h>
42 #include <Zydis/Register.h>
43 #include <Zydis/SharedTypes.h>
44 #include <Zydis/Status.h>
45 #include <Zydis/Utils.h>
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 /* ============================================================================================== */
52 /* Macros */
53 /* ============================================================================================== */
54 
55 /* ---------------------------------------------------------------------------------------------- */
56 /* Constants */
57 /* ---------------------------------------------------------------------------------------------- */
58 
62 #define ZYDIS_VERSION (uint64_t)0x0002000000000000
63 
64 /* ---------------------------------------------------------------------------------------------- */
65 /* Helper macros */
66 /* ---------------------------------------------------------------------------------------------- */
67 
73 #define ZYDIS_VERSION_MAJOR(version) (uint16_t)((version & 0xFFFF000000000000) >> 48)
74 
80 #define ZYDIS_VERSION_MINOR(version) (uint16_t)((version & 0x0000FFFF00000000) >> 32)
81 
87 #define ZYDIS_VERSION_PATCH(version) (uint16_t)((version & 0x00000000FFFF0000) >> 16)
88 
94 #define ZYDIS_VERSION_BUILD(version) (uint16_t)(version & 0x000000000000FFFF)
95 
96 /* ---------------------------------------------------------------------------------------------- */
97 
98 /* ============================================================================================== */
99 /* Enums and types */
100 /* ============================================================================================== */
101 
105 typedef uint8_t ZydisFeature;
106 
111 {
116 };
117 
118 /* ============================================================================================== */
119 /* Exported functions */
120 /* ============================================================================================== */
121 
130 ZYDIS_EXPORT uint64_t ZydisGetVersion();
131 
140 
141 /* ============================================================================================== */
142 
143 #ifdef __cplusplus
144 }
145 #endif
146 
147 #endif /* ZYDIS_H */
Includes and defines some default datatypes.
uint8_t ZydisBool
@briefs Defines the ZydisBool datatype.
Definition: CommonTypes.h:92
Defines the basic ZydisDecodedInstruction and ZydisDecodedOperand structs.
Functions for decoding instructions.
General helper and platform detection macros.
Functions for formatting human-readable instructions.
Mnemonic constant definitions and helper functions.
Utility functions and constants for registers.
Defines decoder/encoder-shared macros and types.
Status code definitions and check macros.
Other utility functions.
ZYDIS_EXPORT uint64_t ZydisGetVersion()
Returns the zydis version.
ZydisFeatures
Values that represent zydis features.
Definition: Zydis.h:111
@ ZYDIS_FEATURE_EVEX
Definition: Zydis.h:112
@ ZYDIS_FEATURE_MVEX
Definition: Zydis.h:113
@ ZYDIS_FEATURE_FLAGS
Definition: Zydis.h:114
@ ZYDIS_FEATURE_CPUID
Definition: Zydis.h:115
uint8_t ZydisFeature
Defines the ZydisFeature datatype.
Definition: Zydis.h:105
ZYDIS_EXPORT ZydisBool ZydisIsFeatureEnabled(ZydisFeature feature)
Checks, if the specified feature is enabled in the current zydis library instance.