-
Notifications
You must be signed in to change notification settings - Fork 9
/
gen_registers.py
272 lines (238 loc) · 9.75 KB
/
gen_registers.py
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
#!/usr/bin/env python3
# encoding: utf-8
import json
import os
class _JsonRegisterClass():
def __init__(self, name_zydis, name_editor, description, groups):
self.name_zydis = name_zydis
self.name_editor = name_editor
self.description = description
self.groups = list(map(lambda x: _JsonRegisterGroup(**x), groups))
class _JsonRegisterGroup():
def __init__(self, is_encodable, registers, width, width_64):
self.is_encodable = is_encodable
self.registers = registers
self.width = width
self.width_64 = width_64
class _ZydisEnumWriter():
def __init__(self, enum_name, value_prefix, file_name, indent=4):
self.__file_name = file_name
self.__enum_name = 'Zydis{enum_name}'.format(
enum_name = enum_name
)
self.__value_prefix = 'ZYDIS_{prefix}_'.format(
prefix = value_prefix
)
self.__indent = ' ' * indent
self.__last = None
def __enter__(self):
self.__f = open(self.__file_name, 'w')
self.__emit_header()
return self
def __exit__(self, exc_type, exc_value, tb):
if exc_type is not None:
return False
self.__emit_footer()
self.__f.close()
return True
def __emit_header(self):
header = (
'/**\n'
' * Defines the `{enum_name}` enum.\n'
' */\n'
'typedef enum {enum_name}_\n'
'{{\n'
).format(
enum_name = self.__enum_name
)
self.__f.write(header)
def __emit_footer(self):
if not self.__last:
raise RuntimeError("Enum must contain at least one item")
footer = (
'\n'
'{indent}/**\n'
'{indent} * Maximum value of this enum.\n'
'{indent} */\n'
'{indent}{prefix}MAX_VALUE = {prefix}{last},\n'
'{indent}/**\n'
'{indent} * The minimum number of bits required to represent all values of this enum.\n'
'{indent} */\n'
'{indent}{prefix}REQUIRED_BITS = ZYAN_BITS_TO_REPRESENT({prefix}MAX_VALUE)\n'
'}} {enum_name};\n'
).format(
indent = self.__indent,
enum_name = self.__enum_name,
prefix = self.__value_prefix,
last = self.__last
)
self.__f.write(footer)
def emit_value(self, value):
self.__f.write('{indent}{prefix}{value},\n'.format(
indent = self.__indent,
prefix = self.__value_prefix,
value = value.upper()
))
self.__last = value
def emit_comment(self, comment):
self.__f.write('{indent}// {comment}\n'.format(
indent = self.__indent,
comment = comment
))
def emit_newline(self):
self.__f.write('\n')
class _ZydisTableWriter():
def __init__(self, symbol_name, item_type, file_name, is_static=True, is_const=True, indent=4):
self.__file_name = file_name
self.__symbol_name = symbol_name
self.__item_type = item_type
self.__static = 'static ' if is_static else ''
self.__const = 'const ' if is_const else ''
self.__indent = ' ' * indent
self.__expect_delim = False
def __enter__(self):
self.__f = open(self.__file_name, 'w')
self.__emit_header()
return self
def __exit__(self, exc_type, exc_value, tb):
if exc_type is not None:
return False
self.__emit_footer()
self.__f.close()
return True
def __emit_header(self):
header = (
'{static}{const}{item_type} {symbol_name}[] =\n'
'{{\n'
).format(
static = self.__static,
const = self.__const,
item_type = self.__item_type,
symbol_name = self.__symbol_name
)
self.__f.write(header)
def __emit_footer(self):
footer = (
'\n};\n'
)
self.__f.write(footer)
def __emit_delim(self):
if self.__expect_delim:
self.__f.write(',\n')
def emit_value(self, value):
self.__emit_delim()
self.__f.write('{indent}{value}'.format(
indent = self.__indent,
value = value
))
self.__expect_delim = True
def emit_comment(self, comment):
self.__emit_delim()
self.__f.write('{indent}// {comment}\n'.format(
indent = self.__indent,
comment = comment
))
self.__expect_delim = False
def emit_newline(self):
self.__emit_delim()
self.__f.write('\n')
self.__expect_delim = False
class _ZydisStringTableWriter(_ZydisTableWriter):
def __init__(self, symbol_name, make_shortstrings, file_name, indent=4):
item_type = 'ZydisShortString' if make_shortstrings else 'char*'
super().__init__(symbol_name, item_type, file_name, True, True, indent)
self.__make_shortstrings = make_shortstrings
def emit_value(self, value):
value = '"{value}"'.format(
value = value.lower()
)
if self.__make_shortstrings:
value = 'ZYDIS_MAKE_SHORTSTRING({value})'.format(
value = value
)
super().emit_value(value)
class Generator():
def __init__(self, input_file):
with open(input_file) as f:
dic = json.load(f)
self.__registers = list(map(lambda x: _JsonRegisterClass(**x), dic['classes']))
def generate(self, output_dir):
self.__generate_enum(self.__registers, output_dir)
self.__generate_reg_lookup(self.__registers, output_dir)
self.__generate_reg_class_lookup(self.__registers, output_dir)
@staticmethod
def __generate_enum(reg_classes, output_dir):
fn_enum = os.path.join(output_dir, 'include/Zydis/Generated/EnumRegister.h')
fn_enum_strings = os.path.join(output_dir, 'src/Generated/EnumRegister.inc')
with (
_ZydisEnumWriter('Register', 'REGISTER', fn_enum) as w_enum,
_ZydisStringTableWriter('STR_REGISTERS', True, fn_enum_strings) as w_enum_strings
):
w_enum.emit_value('none')
w_enum_strings.emit_value('none')
for reg_class in reg_classes:
if not reg_class.name_zydis:
# This class is only used by the InstructionEditor
continue
if reg_class.description:
w_enum.emit_newline()
w_enum.emit_comment(reg_class.description)
w_enum_strings.emit_comment(reg_class.description)
for group in reg_class.groups:
for reg in group.registers:
w_enum.emit_value(reg)
w_enum_strings.emit_value(reg)
@staticmethod
def __generate_reg_lookup(reg_classes, output_dir):
fn_table = os.path.join(output_dir, 'src/Generated/RegisterLookup.inc')
with _ZydisTableWriter('REG_LOOKUP', 'ZydisRegisterLookupItem', fn_table) as w:
w.emit_value('/* NONE */ { ZYDIS_REGCLASS_INVALID, -1, 0, 0 }') # none
for reg_class in reg_classes:
if not reg_class.name_zydis:
# This class is only used by the InstructionEditor
continue
for reg_group in reg_class.groups:
i = 0
for reg in reg_group.registers:
w.emit_value('/* {reg} */ {{ ZYDIS_REGCLASS_{reg_class}, {id}, {width}, {width_64} }}'.format(
reg = reg.upper().ljust(10),
reg_class = reg_class.name_zydis,
id = i if reg_group.is_encodable else -1,
width = reg_group.width,
width_64 = reg_group.width_64
))
i += 1
@staticmethod
def __generate_reg_class_lookup(reg_classes, output_dir):
fn_table = os.path.join(output_dir, 'src/Generated/RegisterClassLookup.inc')
with _ZydisTableWriter('REG_CLASS_LOOKUP', 'ZydisRegisterClassLookupItem', fn_table) as w:
w.emit_value('/* INVALID */ { ZYDIS_REGISTER_NONE, ZYDIS_REGISTER_NONE, 0, 0 }') # none
for reg_class in reg_classes:
if not reg_class.name_zydis:
# This class is only used by the InstructionEditor
continue
if reg_class.name_zydis == 'INVALID':
# This class contains the assorted registers
continue
lo = 'ZYDIS_REGISTER_NONE'
hi = 'ZYDIS_REGISTER_NONE'
width = 0
width_64 = 0
encodable_groups = list(filter(lambda x : x.is_encodable, reg_class.groups))
if len(encodable_groups) > 0:
if len(encodable_groups) > 1:
raise ValueError("multiple encodable groups in register class")
encodable_group = encodable_groups[0]
lo = 'ZYDIS_REGISTER_' + encodable_group.registers[0]
hi = 'ZYDIS_REGISTER_' + encodable_group.registers[len(encodable_group.registers) - 1]
width = encodable_group.width
width_64 = encodable_group.width_64
w.emit_value('/* {reg_class} */ {{ {lo}, {hi}, {width}, {width_64} }}'.format(
reg_class = reg_class.name_zydis.ljust(7),
lo = lo,
hi = hi,
width = width,
width_64 = width_64
))
generator = Generator('./Data/registers.json')
generator.generate('D:/Development/GitHub/zydis/')