Zydis  v2.0.0-beta1
Decoder.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_DECODER_H
33 #define ZYDIS_DECODER_H
34 
35 #include <Zydis/CommonTypes.h>
36 #include <Zydis/DecoderTypes.h>
37 #include <Zydis/Defines.h>
38 #include <Zydis/Status.h>
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /* ============================================================================================== */
45 /* Enums and types */
46 /* ============================================================================================== */
47 
48 /* ---------------------------------------------------------------------------------------------- */
49 /* Decoder mode */
50 /* ---------------------------------------------------------------------------------------------- */
51 
56 
61 {
131 };
132 
133 /* ---------------------------------------------------------------------------------------------- */
134 /* Decoder struct */
135 /* ---------------------------------------------------------------------------------------------- */
136 
140 typedef struct ZydisDecoder_
141 {
146 
147 /* ---------------------------------------------------------------------------------------------- */
148 
149 /* ============================================================================================== */
150 /* Exported functions */
151 /* ============================================================================================== */
152 
162 ZYDIS_EXPORT ZydisStatus ZydisDecoderInit(ZydisDecoder* decoder, ZydisMachineMode machineMode,
163  ZydisAddressWidth addressWidth);
164 
175  ZydisBool enabled);
176 
189 ZYDIS_EXPORT ZydisStatus ZydisDecoderDecodeBuffer(const ZydisDecoder* decoder,
190  const void* buffer, ZydisUSize bufferLen, ZydisU64 instructionPointer,
191  ZydisDecodedInstruction* instruction);
192 
193 /* ============================================================================================== */
194 
195 #ifdef __cplusplus
196 }
197 #endif
198 
199 #endif /* ZYDIS_DECODER_H */
Includes and defines some default datatypes.
uint64_t ZydisU64
Definition: CommonTypes.h:48
uint8_t ZydisU8
Definition: CommonTypes.h:45
ZydisU8 ZydisBool
@briefs Defines the ZydisBool datatype.
Definition: CommonTypes.h:133
size_t ZydisUSize
Definition: CommonTypes.h:53
Defines the basic ZydisDecodedInstruction and ZydisDecodedOperand structs.
ZydisU8 ZydisDecoderMode
Defines the ZydisDecoderMode datatype.
Definition: Decoder.h:55
ZYDIS_EXPORT ZydisStatus ZydisDecoderDecodeBuffer(const ZydisDecoder *decoder, const void *buffer, ZydisUSize bufferLen, ZydisU64 instructionPointer, ZydisDecodedInstruction *instruction)
Decodes the instruction in the given input buffer.
ZydisDecoderModes
Values that represent decoder-modes.
Definition: Decoder.h:61
@ ZYDIS_DECODER_MODE_KNC
Enables KNC compatibility-mode.
Definition: Decoder.h:94
@ ZYDIS_DECODER_MODE_LZCNT
Enables the LZCNT mode.
Definition: Decoder.h:118
@ ZYDIS_DECODER_MODE_MINIMAL
Enables minimal instruction decoding without semantic analysis.
Definition: Decoder.h:74
@ ZYDIS_DECODER_MODE_TZCNT
Enables the TZCNT mode.
Definition: Decoder.h:126
@ ZYDIS_DECODER_MODE_MAX_VALUE
Maximum value of this enum.
Definition: Decoder.h:130
@ ZYDIS_DECODER_MODE_AMD_BRANCHES
Enables the AMD-branch mode.
Definition: Decoder.h:85
@ ZYDIS_DECODER_MODE_MPX
Enables the MPX mode.
Definition: Decoder.h:102
@ ZYDIS_DECODER_MODE_CET
Enables the CET mode.
Definition: Decoder.h:110
struct ZydisDecoder_ ZydisDecoder
Defines the ZydisDecoder struct.
ZYDIS_EXPORT ZydisStatus ZydisDecoderEnableMode(ZydisDecoder *decoder, ZydisDecoderMode mode, ZydisBool enabled)
Enables or disables the specified decoder-mode.
ZYDIS_EXPORT ZydisStatus ZydisDecoderInit(ZydisDecoder *decoder, ZydisMachineMode machineMode, ZydisAddressWidth addressWidth)
Initializes the given ZydisDecoder instance.
General helper and platform detection macros.
ZydisU8 ZydisAddressWidth
Defines the ZydisAddressWidth datatype.
Definition: SharedTypes.h:110
ZydisU8 ZydisMachineMode
Defines the ZydisMachineMode datatype.
Definition: SharedTypes.h:65
Status code definitions and check macros.
ZydisU32 ZydisStatus
Defines the ZydisStatus datatype.
Definition: Status.h:48
Defines the ZydisDecodedInstruction struct.
Definition: DecoderTypes.h:778
Defines the ZydisDecoder struct.
Definition: Decoder.h:141
ZydisAddressWidth addressWidth
Definition: Decoder.h:143
ZydisBool decoderMode[ZYDIS_DECODER_MODE_MAX_VALUE+1]
Definition: Decoder.h:144
ZydisMachineMode machineMode
Definition: Decoder.h:142