1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
|
/***************************************************************************************************
Zyan Disassembler Library (Zydis)
Original Author : Florian Bernd
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
***************************************************************************************************/
/**
* @file
* Utility functions and constants for registers.
*/
#ifndef ZYDIS_REGISTER_H
#define ZYDIS_REGISTER_H
#include "ZycoreDefines.h"
#include "ZycoreTypes.h"
#include "ZydisSharedTypes.h"
#include "ZydisShortString.h"
#ifdef __cplusplus
extern "C" {
#endif
/* ============================================================================================== */
/* Enums and types */
/* ============================================================================================== */
/* ---------------------------------------------------------------------------------------------- */
/* Registers */
/* ---------------------------------------------------------------------------------------------- */
#include "ZydisGeneratedEnumRegister.h"
/* ---------------------------------------------------------------------------------------------- */
/* Register classes */
/* ---------------------------------------------------------------------------------------------- */
/**
* Defines the `ZydisRegisterClass` enum.
*
* Please note that this enum does not contain a matching entry for all values of the
* `ZydisRegister` enum, but only for those registers where it makes sense to logically group them
* for decoding/encoding purposes.
*
* These are mainly the registers that can be identified by an id within their corresponding
* register-class. The `IP` and `FLAGS` values are exceptions to this rule.
*/
typedef enum ZydisRegisterClass_
{
ZYDIS_REGCLASS_INVALID,
/**
* 8-bit general-purpose registers.
*/
ZYDIS_REGCLASS_GPR8,
/**
* 16-bit general-purpose registers.
*/
ZYDIS_REGCLASS_GPR16,
/**
* 32-bit general-purpose registers.
*/
ZYDIS_REGCLASS_GPR32,
/**
* 64-bit general-purpose registers.
*/
ZYDIS_REGCLASS_GPR64,
/**
* Floating point legacy registers.
*/
ZYDIS_REGCLASS_X87,
/**
* Floating point multimedia registers.
*/
ZYDIS_REGCLASS_MMX,
/**
* 128-bit vector registers.
*/
ZYDIS_REGCLASS_XMM,
/**
* 256-bit vector registers.
*/
ZYDIS_REGCLASS_YMM,
/**
* 512-bit vector registers.
*/
ZYDIS_REGCLASS_ZMM,
/**
* Matrix registers.
*/
ZYDIS_REGCLASS_TMM,
/*
* Flags registers.
*/
ZYDIS_REGCLASS_FLAGS,
/**
* Instruction-pointer registers.
*/
ZYDIS_REGCLASS_IP,
/**
* Segment registers.
*/
ZYDIS_REGCLASS_SEGMENT,
/**
* Test registers.
*/
ZYDIS_REGCLASS_TEST,
/**
* Control registers.
*/
ZYDIS_REGCLASS_CONTROL,
/**
* Debug registers.
*/
ZYDIS_REGCLASS_DEBUG,
/**
* Mask registers.
*/
ZYDIS_REGCLASS_MASK,
/**
* Bound registers.
*/
ZYDIS_REGCLASS_BOUND,
/**
* Maximum value of this enum.
*/
ZYDIS_REGCLASS_MAX_VALUE = ZYDIS_REGCLASS_BOUND,
/**
* The minimum number of bits required to represent all values of this enum.
*/
ZYDIS_REGCLASS_REQUIRED_BITS = ZYAN_BITS_TO_REPRESENT(ZYDIS_REGCLASS_MAX_VALUE)
} ZydisRegisterClass;
/* ---------------------------------------------------------------------------------------------- */
/* Register width */
/* ---------------------------------------------------------------------------------------------- */
/**
* Defines the `ZydisRegisterWidth` data-type.
*/
typedef ZyanU16 ZydisRegisterWidth;
/* ---------------------------------------------------------------------------------------------- */
/* Register context */
/* ---------------------------------------------------------------------------------------------- */
/**
* Defines the `ZydisRegisterContext` struct.
*/
typedef struct ZydisRegisterContext_
{
/**
* The values stored in the register context.
*/
ZyanU64 values[ZYDIS_REGISTER_MAX_VALUE + 1];
} ZydisRegisterContext;
/* ---------------------------------------------------------------------------------------------- */
/* ============================================================================================== */
/* Exported functions */
/* ============================================================================================== */
/**
* @addtogroup register Register
* Functions allowing retrieval of information about registers.
* @{
*/
/* ---------------------------------------------------------------------------------------------- */
/* Register */
/* ---------------------------------------------------------------------------------------------- */
/**
* Returns the register specified by the `register_class` and `id` tuple.
*
* @param register_class The register class.
* @param id The register id.
*
* @return The register specified by the `register_class` and `id` tuple or `ZYDIS_REGISTER_NONE`,
* if an invalid parameter was passed.
*/
ZYDIS_EXPORT ZydisRegister ZydisRegisterEncode(ZydisRegisterClass register_class, ZyanU8 id);
/**
* Returns the id of the specified register.
*
* @param reg The register.
*
* @return The id of the specified register, or -1 if an invalid parameter was passed.
*/
ZYDIS_EXPORT ZyanI8 ZydisRegisterGetId(ZydisRegister reg);
/**
* Returns the register-class of the specified register.
*
* @param reg The register.
*
* @return The register-class of the specified register.
*/
ZYDIS_EXPORT ZydisRegisterClass ZydisRegisterGetClass(ZydisRegister reg);
/**
* Returns the width of the specified register.
*
* @param mode The active machine mode.
* @param reg The register.
*
* @return The width of the specified register, or `ZYDIS_REGISTER_NONE` if the register is
* invalid for the active machine-mode.
*/
ZYDIS_EXPORT ZydisRegisterWidth ZydisRegisterGetWidth(ZydisMachineMode mode, ZydisRegister reg);
/**
* Returns the largest enclosing register of the given register.
*
* @param mode The active machine mode.
* @param reg The register.
*
* @return The largest enclosing register of the given register, or `ZYDIS_REGISTER_NONE` if the
* register is invalid for the active machine-mode or does not have an enclosing-register.
*/
ZYDIS_EXPORT ZydisRegister ZydisRegisterGetLargestEnclosing(ZydisMachineMode mode,
ZydisRegister reg);
/**
* Returns the specified register string.
*
* @param reg The register.
*
* @return The register string or `ZYAN_NULL`, if an invalid register was passed.
*/
ZYDIS_EXPORT const char* ZydisRegisterGetString(ZydisRegister reg);
/**
* Returns the specified register string as `ZydisShortString`.
*
* @param reg The register.
*
* @return The register string or `ZYAN_NULL`, if an invalid register was passed.
*
* The `buffer` of the returned struct is guaranteed to be zero-terminated in this special case.
*/
ZYDIS_EXPORT const ZydisShortString* ZydisRegisterGetStringWrapped(ZydisRegister reg);
/* ---------------------------------------------------------------------------------------------- */
/* Register class */
/* ---------------------------------------------------------------------------------------------- */
/**
* Returns the width of the specified register-class.
*
* @param mode The active machine mode.
* @param register_class The register class.
*
* @return The width of the specified register.
*/
ZYDIS_EXPORT ZydisRegisterWidth ZydisRegisterClassGetWidth(ZydisMachineMode mode,
ZydisRegisterClass register_class);
/* ---------------------------------------------------------------------------------------------- */
/**
* @}
*/
/* ============================================================================================== */
#ifdef __cplusplus
}
#endif
#endif /* ZYDIS_REGISTER_H */
|
