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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
|
#!/usr/bin/env python2
import json
def msg_is_reply(name):
return name.endswith('_reply') or name.endswith('_details') \
or name.endswith('_event') or name.endswith('_counters')
class ParseError (Exception):
pass
magic_prefix = "vl_api_"
magic_suffix = "_t"
def remove_magic(what):
if what.startswith(magic_prefix) and what.endswith(magic_suffix):
return what[len(magic_prefix): - len(magic_suffix)]
return what
class Field(object):
def __init__(
self,
field_name,
field_type,
array_len=None,
nelem_field=None):
self.name = field_name
self.type = field_type
self.len = array_len
self.nelem_field = nelem_field
def __str__(self):
if self.len is None:
return "name: %s, type: %s" % (self.name, self.type)
elif self.len > 0:
return "name: %s, type: %s, length: %s" % (self.name, self.type,
self.len)
else:
return ("name: %s, type: %s, variable length stored in: %s" %
(self.name, self.type, self.nelem_field))
class Type(object):
def __init__(self, name):
self.name = name
def __str__(self):
return self.name
class SimpleType (Type):
def __init__(self, name):
super(SimpleType, self).__init__(name)
def __str__(self):
return self.name
def get_msg_header_defs(struct_type_class, field_class, typedict, logger):
return [
struct_type_class(['msg_header1_t',
['u16', '_vl_msg_id'],
['u32', 'context'],
],
typedict, field_class, logger
),
struct_type_class(['msg_header2_t',
['u16', '_vl_msg_id'],
['u32', 'client_index'],
['u32', 'context'],
],
typedict, field_class, logger
),
]
class Struct(object):
def __init__(self, name, fields):
self.name = name
self.fields = fields
self.field_names = [n.name for n in self.fields]
def __str__(self):
return "[%s]" % "], [".join([str(f) for f in self.fields])
class Message(object):
def __init__(self, logger, definition, typedict,
struct_type_class, simple_type_class, field_class):
self.request = None
self.logger = logger
m = definition
logger.debug("Parsing message definition `%s'" % m)
name = m[0]
self.name = name
logger.debug("Message name is `%s'" % name)
ignore = True
self.header = None
fields = []
for header in get_msg_header_defs(struct_type_class, field_class,
typedict, logger):
logger.debug("Probing header `%s'" % header.name)
if header.is_part_of_def(m[1:]):
self.header = header
logger.debug("Found header `%s'" % header.name)
fields.append(field_class(field_name='header',
field_type=self.header))
ignore = False
break
if ignore and not msg_is_reply(name):
raise ParseError("While parsing message `%s': could not find all "
"common header fields" % name)
for field in m[1:]:
if len(field) == 1 and 'crc' in field:
self.crc = field['crc']
logger.debug("Found CRC `%s'" % self.crc)
continue
else:
field_type = field[0]
if field_type in typedict:
field_type = typedict[field_type]
else:
mundane_field_type = remove_magic(field_type)
if mundane_field_type in typedict:
field_type = typedict[mundane_field_type]
else:
raise ParseError(
"While parsing message `%s': could not find "
"type by magic name `%s' nor by mundane name "
"`%s'" % (name, field_type, mundane_field_type))
logger.debug("Parsing message field `%s'" % field)
if len(field) == 2:
if self.header is not None and\
self.header.has_field(field[1]):
continue
p = field_class(field_name=field[1],
field_type=field_type)
elif len(field) == 3:
if field[2] == 0:
raise ParseError(
"While parsing message `%s': variable length "
"array `%s' doesn't have reference to member "
"containing the actual length" % (
name, field[1]))
p = field_class(
field_name=field[1],
field_type=field_type,
array_len=field[2])
elif len(field) == 4:
nelem_field = None
for f in fields:
if f.name == field[3]:
nelem_field = f
if nelem_field is None:
raise ParseError(
"While parsing message `%s': couldn't find "
"variable length array `%s' member containing "
"the actual length `%s'" % (
name, field[1], field[3]))
p = field_class(
field_name=field[1],
field_type=field_type,
array_len=field[2],
nelem_field=nelem_field)
else:
raise Exception("Don't know how to parse message "
"definition for message `%s': `%s'" %
(m, m[1:]))
logger.debug("Parsed field `%s'" % p)
fields.append(p)
self.fields = fields
def is_dump(self):
return self.name.endswith('_dump')
def is_reply(self):
return msg_is_reply(self.name)
class StructType (Type, Struct):
def __init__(self, definition, typedict, field_class, logger):
t = definition
logger.debug("Parsing struct definition `%s'" % t)
name = t[0]
fields = []
for field in t[1:]:
if len(field) == 1 and 'crc' in field:
self.crc = field['crc']
continue
field_type = field[0]
if field_type in typedict:
field_type = typedict[field_type]
else:
mundane_field_type = remove_magic(field_type)
if mundane_field_type in typedict:
field_type = typedict[mundane_field_type]
else:
raise ParseError(
"While parsing message `%s': could not find "
"type by magic name `%s' nor by mundane name "
"`%s'" % (name, field_type, mundane_field_type))
logger.debug("Parsing type field `%s'" % field)
if len(field) == 2:
p = field_class(field_name=field[1],
field_type=field_type)
elif len(field) == 3:
if field[2] == 0:
raise ParseError("While parsing type `%s': array `%s' has "
"variable length" % (name, field[1]))
p = field_class(field_name=field[1],
field_type=field_type,
array_len=field[2])
elif len(field) == 4:
nelem_field = None
for f in fields:
if f.name == field[3]:
nelem_field = f
if nelem_field is None:
raise ParseError(
"While parsing message `%s': couldn't find "
"variable length array `%s' member containing "
"the actual length `%s'" % (
name, field[1], field[3]))
p = field_class(field_name=field[1],
field_type=field_type,
array_len=field[2],
nelem_field=nelem_field)
else:
raise ParseError(
"Don't know how to parse field `%s' of type definition "
"for type `%s'" % (field, t))
fields.append(p)
Type.__init__(self, name)
Struct.__init__(self, name, fields)
def __str__(self):
return "StructType(%s, %s)" % (Type.__str__(self),
Struct.__str__(self))
def has_field(self, name):
return name in self.field_names
def is_part_of_def(self, definition):
for idx in range(len(self.fields)):
field = definition[idx]
p = self.fields[idx]
if field[1] != p.name:
return False
if field[0] != p.type.name:
raise ParseError(
"Unexpected field type `%s' (should be `%s'), "
"while parsing msg/def/field `%s/%s/%s'" %
(field[0], p.type, p.name, definition, field))
return True
class JsonParser(object):
def __init__(self, logger, files, simple_type_class=SimpleType,
struct_type_class=StructType, field_class=Field,
message_class=Message):
self.messages = {}
self.types = {
x: simple_type_class(x) for x in [
'i8', 'i16', 'i32', 'i64',
'u8', 'u16', 'u32', 'u64',
'f64'
]
}
self.simple_type_class = simple_type_class
self.struct_type_class = struct_type_class
self.field_class = field_class
self.message_class = message_class
self.exceptions = []
self.json_files = []
self.types_by_json = {}
self.messages_by_json = {}
self.logger = logger
for f in files:
self.parse_json_file(f)
self.finalize_parsing()
def parse_json_file(self, path):
self.logger.info("Parsing json api file: `%s'" % path)
self.json_files.append(path)
self.types_by_json[path] = []
self.messages_by_json[path] = {}
with open(path) as f:
j = json.load(f)
for t in j['types']:
try:
type_ = self.struct_type_class(t, self.types,
self.field_class,
self.logger)
if type_.name in self.types:
raise ParseError("Duplicate type `%s'" % type_.name)
except ParseError as e:
self.exceptions.append(e)
continue
self.types[type_.name] = type_
self.types_by_json[path].append(type_)
self.logger.debug("Parsed type: %s" % type_)
prev_length = len(self.messages)
processed = []
while True:
exceptions = []
for m in j['messages']:
if m in processed:
continue
try:
msg = self.message_class(self.logger, m, self.types,
self.struct_type_class,
self.simple_type_class,
self.field_class)
if msg.name in self.messages:
raise ParseError(
"Duplicate message `%s'" % msg.name)
except ParseError as e:
exceptions.append(e)
continue
self.messages[msg.name] = msg
self.messages_by_json[path][msg.name] = msg
processed.append(m)
if prev_length == len(self.messages):
# cannot make forward progress ...
self.exceptions.extend(exceptions)
break
prev_length = len(self.messages)
def get_reply(self, message):
if self.messages[message].is_dump():
return self.messages["%s_details" % message[:-len("_dump")]]
return self.messages["%s_reply" % message]
def finalize_parsing(self):
if len(self.messages) == 0:
for e in self.exceptions:
self.logger.error(e)
for jn, j in self.messages_by_json.items():
remove = []
for n, m in j.items():
try:
if not m.is_reply():
try:
m.reply = self.get_reply(n)
m.reply.request = m
except:
raise ParseError(
"Cannot find reply to message `%s'" % n)
except ParseError as e:
self.exceptions.append(e)
remove.append(n)
self.messages_by_json[jn] = {
k: v for k, v in j.items() if k not in remove}
|
