Zydis  v3.2.1
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 <Zycore/Defines.h>
36 #include <Zycore/Types.h>
37 
38 #ifndef ZYDIS_DISABLE_DECODER
39 # include <Zydis/Decoder.h>
40 # include <Zydis/DecoderTypes.h>
41 #endif
42 
43 #ifndef ZYDIS_DISABLE_FORMATTER
44 # include <Zydis/Formatter.h>
45 #endif
46 
47 #include <Zydis/MetaInfo.h>
48 #include <Zydis/Mnemonic.h>
49 #include <Zydis/Register.h>
50 #include <Zydis/SharedTypes.h>
51 #include <Zydis/Status.h>
52 #include <Zydis/Utils.h>
53 
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57 
58 /* ============================================================================================== */
59 /* Macros */
60 /* ============================================================================================== */
61 
62 /* ---------------------------------------------------------------------------------------------- */
63 /* Constants */
64 /* ---------------------------------------------------------------------------------------------- */
65 
69 #define ZYDIS_VERSION (ZyanU64)0x0003000200010000
70 
71 /* ---------------------------------------------------------------------------------------------- */
72 /* Helper macros */
73 /* ---------------------------------------------------------------------------------------------- */
74 
80 #define ZYDIS_VERSION_MAJOR(version) (ZyanU16)(((version) & 0xFFFF000000000000) >> 48)
81 
87 #define ZYDIS_VERSION_MINOR(version) (ZyanU16)(((version) & 0x0000FFFF00000000) >> 32)
88 
94 #define ZYDIS_VERSION_PATCH(version) (ZyanU16)(((version) & 0x00000000FFFF0000) >> 16)
95 
101 #define ZYDIS_VERSION_BUILD(version) (ZyanU16)((version) & 0x000000000000FFFF)
102 
103 /* ---------------------------------------------------------------------------------------------- */
104 
105 /* ============================================================================================== */
106 /* Enums and types */
107 /* ============================================================================================== */
108 
112 typedef enum ZydisFeature_
113 {
118 
126  ZYDIS_FEATURE_REQUIRED_BITS = ZYAN_BITS_TO_REPRESENT(ZYDIS_FEATURE_MAX_VALUE)
128 
129 /* ============================================================================================== */
130 /* Exported functions */
131 /* ============================================================================================== */
132 
147 ZYDIS_EXPORT ZyanU64 ZydisGetVersion(void);
148 
157 ZYDIS_EXPORT ZyanStatus ZydisIsFeatureEnabled(ZydisFeature feature);
158 
163 /* ============================================================================================== */
164 
165 #ifdef __cplusplus
166 }
167 #endif
168 
169 #endif /* ZYDIS_H */
Defines the basic ZydisDecodedInstruction and ZydisDecodedOperand structs.
Functions for decoding instructions.
Functions for formatting instructions to human-readable text.
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.
ZydisFeature_
Defines the ZydisFeature enum.
Definition: Zydis.h:113
@ ZYDIS_FEATURE_KNC
Definition: Zydis.h:117
@ ZYDIS_FEATURE_MAX_VALUE
Maximum value of this enum.
Definition: Zydis.h:122
@ ZYDIS_FEATURE_REQUIRED_BITS
The minimum number of bits required to represent all values of this enum.
Definition: Zydis.h:126
@ ZYDIS_FEATURE_DECODER
Definition: Zydis.h:114
@ ZYDIS_FEATURE_FORMATTER
Definition: Zydis.h:115
@ ZYDIS_FEATURE_AVX512
Definition: Zydis.h:116
enum ZydisFeature_ ZydisFeature
Defines the ZydisFeature enum.
ZYDIS_EXPORT ZyanStatus ZydisIsFeatureEnabled(ZydisFeature feature)
Checks, if the specified feature is enabled in the current zydis library instance.
ZYDIS_EXPORT ZyanU64 ZydisGetVersion(void)
Returns the zydis version.