Zydis  v3.2.0
Register.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_REGISTER_H
33 #define ZYDIS_REGISTER_H
34 
35 #include <Zycore/Defines.h>
36 #include <Zycore/Types.h>
37 #include <Zydis/SharedTypes.h>
38 #include <Zydis/ShortString.h>
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /* ============================================================================================== */
45 /* Enums and types */
46 /* ============================================================================================== */
47 
48 /* ---------------------------------------------------------------------------------------------- */
49 /* Registers */
50 /* ---------------------------------------------------------------------------------------------- */
51 
52 #include <Zydis/Generated/EnumRegister.h>
53 
54 /* ---------------------------------------------------------------------------------------------- */
55 /* Register classes */
56 /* ---------------------------------------------------------------------------------------------- */
57 
68 typedef enum ZydisRegisterClass_
69 {
70  ZYDIS_REGCLASS_INVALID,
111  /*
112  * Flags registers.
113  */
114  ZYDIS_REGCLASS_FLAGS,
143 
153 
154 /* ---------------------------------------------------------------------------------------------- */
155 /* Register width */
156 /* ---------------------------------------------------------------------------------------------- */
157 
161 typedef ZyanU16 ZydisRegisterWidth;
162 
163 /* ---------------------------------------------------------------------------------------------- */
164 /* Register context */
165 /* ---------------------------------------------------------------------------------------------- */
166 
170 typedef struct ZydisRegisterContext_
171 {
175  ZyanU64 values[ZYDIS_REGISTER_MAX_VALUE + 1];
177 
178 /* ---------------------------------------------------------------------------------------------- */
179 
180 /* ============================================================================================== */
181 /* Exported functions */
182 /* ============================================================================================== */
183 
190 /* ---------------------------------------------------------------------------------------------- */
191 /* Register */
192 /* ---------------------------------------------------------------------------------------------- */
193 
203 ZYDIS_EXPORT ZydisRegister ZydisRegisterEncode(ZydisRegisterClass register_class, ZyanU8 id);
204 
212 ZYDIS_EXPORT ZyanI8 ZydisRegisterGetId(ZydisRegister reg);
213 
221 ZYDIS_EXPORT ZydisRegisterClass ZydisRegisterGetClass(ZydisRegister reg);
222 
232 ZYDIS_EXPORT ZydisRegisterWidth ZydisRegisterGetWidth(ZydisMachineMode mode, ZydisRegister reg);
233 
243 ZYDIS_EXPORT ZydisRegister ZydisRegisterGetLargestEnclosing(ZydisMachineMode mode,
244  ZydisRegister reg);
245 
253 ZYDIS_EXPORT const char* ZydisRegisterGetString(ZydisRegister reg);
254 
264 ZYDIS_EXPORT const ZydisShortString* ZydisRegisterGetStringWrapped(ZydisRegister reg);
265 
266 /* ---------------------------------------------------------------------------------------------- */
267 /* Register class */
268 /* ---------------------------------------------------------------------------------------------- */
269 
279  ZydisRegisterClass register_class);
280 
281 /* ---------------------------------------------------------------------------------------------- */
282 
287 /* ============================================================================================== */
288 
289 #ifdef __cplusplus
290 }
291 #endif
292 
293 #endif /* ZYDIS_REGISTER_H */
ZyanU16 ZydisRegisterWidth
Defines the ZydisRegisterWidth data-type.
Definition: Register.h:161
ZydisRegisterClass_
Defines the ZydisRegisterClass enum.
Definition: Register.h:69
@ ZYDIS_REGCLASS_MMX
Floating point multimedia registers.
Definition: Register.h:94
@ ZYDIS_REGCLASS_IP
Instruction-pointer registers.
Definition: Register.h:118
@ ZYDIS_REGCLASS_CONTROL
Control registers.
Definition: Register.h:130
@ ZYDIS_REGCLASS_GPR8
8-bit general-purpose registers.
Definition: Register.h:74
@ ZYDIS_REGCLASS_SEGMENT
Segment registers.
Definition: Register.h:122
@ ZYDIS_REGCLASS_TEST
Test registers.
Definition: Register.h:126
@ ZYDIS_REGCLASS_REQUIRED_BITS
The minimum number of bits required to represent all values of this enum.
Definition: Register.h:151
@ ZYDIS_REGCLASS_X87
Floating point legacy registers.
Definition: Register.h:90
@ ZYDIS_REGCLASS_MAX_VALUE
Maximum value of this enum.
Definition: Register.h:147
@ ZYDIS_REGCLASS_YMM
256-bit vector registers.
Definition: Register.h:102
@ ZYDIS_REGCLASS_TMM
Matrix registers.
Definition: Register.h:110
@ ZYDIS_REGCLASS_GPR64
64-bit general-purpose registers.
Definition: Register.h:86
@ ZYDIS_REGCLASS_BOUND
Bound registers.
Definition: Register.h:142
@ ZYDIS_REGCLASS_GPR32
32-bit general-purpose registers.
Definition: Register.h:82
@ ZYDIS_REGCLASS_DEBUG
Debug registers.
Definition: Register.h:134
@ ZYDIS_REGCLASS_ZMM
512-bit vector registers.
Definition: Register.h:106
@ ZYDIS_REGCLASS_MASK
Mask registers.
Definition: Register.h:138
@ ZYDIS_REGCLASS_GPR16
16-bit general-purpose registers.
Definition: Register.h:78
@ ZYDIS_REGCLASS_XMM
128-bit vector registers.
Definition: Register.h:98
struct ZydisRegisterContext_ ZydisRegisterContext
Defines the ZydisRegisterContext struct.
enum ZydisRegisterClass_ ZydisRegisterClass
Defines the ZydisRegisterClass enum.
Defines decoder/encoder-shared macros and types.
enum ZydisMachineMode_ ZydisMachineMode
Defines the ZydisMachineMode enum.
Defines the immutable and storage-efficient ZydisShortString struct, which is used to store strings i...
ZYDIS_EXPORT const char * ZydisRegisterGetString(ZydisRegister reg)
Returns the specified register string.
ZYDIS_EXPORT ZydisRegister ZydisRegisterEncode(ZydisRegisterClass register_class, ZyanU8 id)
Returns the register specified by the register_class and id tuple.
ZYDIS_EXPORT ZydisRegister ZydisRegisterGetLargestEnclosing(ZydisMachineMode mode, ZydisRegister reg)
Returns the largest enclosing register of the given register.
ZYDIS_EXPORT ZyanI8 ZydisRegisterGetId(ZydisRegister reg)
Returns the id of the specified register.
ZYDIS_EXPORT const ZydisShortString * ZydisRegisterGetStringWrapped(ZydisRegister reg)
Returns the specified register string as ZydisShortString.
ZYDIS_EXPORT ZydisRegisterWidth ZydisRegisterClassGetWidth(ZydisMachineMode mode, ZydisRegisterClass register_class)
Returns the width of the specified register-class.
ZYDIS_EXPORT ZydisRegisterClass ZydisRegisterGetClass(ZydisRegister reg)
Returns the register-class of the specified register.
ZYDIS_EXPORT ZydisRegisterWidth ZydisRegisterGetWidth(ZydisMachineMode mode, ZydisRegister reg)
Returns the width of the specified register.
Defines the ZydisRegisterContext struct.
Definition: Register.h:171
ZyanU64 values[ZYDIS_REGISTER_MAX_VALUE+1]
The values stored in the register context.
Definition: Register.h:175
Defines the ZydisShortString struct.
Definition: ShortString.h:59