6 class ParseError (Exception):
10 magic_prefix = "vl_api_"
14 def remove_magic(what):
15 if what.startswith(magic_prefix) and what.endswith(magic_suffix):
16 return what[len(magic_prefix): - len(magic_suffix)]
22 def __init__(self, field_name, field_type, array_len=None,
24 self.name = field_name
25 self.type = field_type
27 self.nelem_field = nelem_field
31 return "Field(name: %s, type: %s)" % (self.name, self.type)
33 return "Field(name: %s, type: %s, length: %s)" % (self.name,
38 "Field(name: %s, type: %s, variable length stored in: %s)" %
39 (self.name, self.type, self.nelem_field))
42 return self.nelem_field is not None
45 return self.is_vla() or self.type.has_vla()
49 def __init__(self, name):
56 class SimpleType (Type):
58 def __init__(self, name):
59 super(SimpleType, self).__init__(name)
68 def get_msg_header_defs(struct_type_class, field_class, json_parser, logger):
70 struct_type_class(['msg_header1_t',
71 ['u16', '_vl_msg_id'],
74 json_parser, field_class, logger
76 struct_type_class(['msg_header2_t',
77 ['u16', '_vl_msg_id'],
78 ['u32', 'client_index'],
81 json_parser, field_class, logger
88 def __init__(self, name, fields):
91 self.field_names = [n.name for n in self.fields]
92 self.depends = [f.type for f in self.fields]
95 return "[%s]" % "], [".join([str(f) for f in self.fields])
104 class Enum(SimpleType):
105 def __init__(self, name, value_pairs, enumtype):
106 super(Enum, self).__init__(name)
108 self.value_pairs = value_pairs
111 return "Enum(%s, [%s])" % (
113 "], [" .join(["%s => %s" % (i, j) for i, j in self.value_pairs])
118 def __init__(self, name, type_pairs, crc):
119 Type.__init__(self, name)
121 self.type_pairs = type_pairs
122 self.depends = [t for t, _ in self.type_pairs]
125 return "Union(%s, [%s])" % (
127 "], [" .join(["%s %s" % (i, j) for i, j in self.type_pairs])
134 class Message(object):
136 def __init__(self, logger, definition, json_parser):
137 struct_type_class = json_parser.struct_type_class
138 field_class = json_parser.field_class
142 logger.debug("Parsing message definition `%s'" % m)
145 logger.debug("Message name is `%s'" % name)
148 self.is_reply = json_parser.is_reply(self.name)
149 self.is_event = json_parser.is_event(self.name)
151 for header in get_msg_header_defs(struct_type_class, field_class,
152 json_parser, logger):
153 logger.debug("Probing header `%s'" % header.name)
154 if header.is_part_of_def(m[1:]):
156 logger.debug("Found header `%s'" % header.name)
157 fields.append(field_class(field_name='header',
158 field_type=self.header))
161 if ignore and not self.is_event and not self.is_reply:
162 raise ParseError("While parsing message `%s': could not find all "
163 "common header fields" % name)
165 if len(field) == 1 and 'crc' in field:
166 self.crc = field['crc']
167 logger.debug("Found CRC `%s'" % self.crc)
170 field_type = json_parser.lookup_type_like_id(field[0])
171 logger.debug("Parsing message field `%s'" % field)
173 if self.header is not None and\
174 self.header.has_field(field[1]):
176 p = field_class(field_name=field[1],
177 field_type=field_type)
178 elif len(field) == 3:
181 "While parsing message `%s': variable length "
182 "array `%s' doesn't have reference to member "
183 "containing the actual length" % (
187 field_type=field_type,
189 elif len(field) == 4:
192 if f.name == field[3]:
194 if nelem_field is None:
196 "While parsing message `%s': couldn't find "
197 "variable length array `%s' member containing "
198 "the actual length `%s'" % (
199 name, field[1], field[3]))
202 field_type=field_type,
204 nelem_field=nelem_field)
206 raise Exception("Don't know how to parse message "
207 "definition for message `%s': `%s'" %
209 logger.debug("Parsed field `%s'" % p)
212 self.depends = [f.type for f in self.fields]
213 logger.debug("Parsed message: %s" % self)
216 return "Message(%s, [%s], {crc: %s}" % \
218 "], [".join([str(f) for f in self.fields]),
222 class StructType (Type, Struct):
224 def __init__(self, definition, json_parser, field_class, logger):
226 logger.debug("Parsing struct definition `%s'" % t)
230 if len(field) == 1 and 'crc' in field:
231 self.crc = field['crc']
233 field_type = json_parser.lookup_type_like_id(field[0])
234 logger.debug("Parsing type field `%s'" % field)
236 p = field_class(field_name=field[1],
237 field_type=field_type)
238 elif len(field) == 3:
240 raise ParseError("While parsing type `%s': array `%s' has "
241 "variable length" % (name, field[1]))
242 p = field_class(field_name=field[1],
243 field_type=field_type,
245 elif len(field) == 4:
248 if f.name == field[3]:
250 if nelem_field is None:
252 "While parsing message `%s': couldn't find "
253 "variable length array `%s' member containing "
254 "the actual length `%s'" % (
255 name, field[1], field[3]))
256 p = field_class(field_name=field[1],
257 field_type=field_type,
259 nelem_field=nelem_field)
262 "Don't know how to parse field `%s' of type definition "
263 "for type `%s'" % (field, t))
265 Type.__init__(self, name)
266 Struct.__init__(self, name, fields)
269 return "StructType(%s, %s)" % (Type.__str__(self),
270 Struct.__str__(self))
272 def has_field(self, name):
273 return name in self.field_names
275 def is_part_of_def(self, definition):
276 for idx in range(len(self.fields)):
277 field = definition[idx]
279 if field[1] != p.name:
281 if field[0] != p.type.name:
283 "Unexpected field type `%s' (should be `%s'), "
284 "while parsing msg/def/field `%s/%s/%s'" %
285 (field[0], p.type, p.name, definition, field))
289 class JsonParser(object):
290 def __init__(self, logger, files, simple_type_class=SimpleType,
291 enum_class=Enum, union_class=Union,
292 struct_type_class=StructType, field_class=Field,
293 message_class=Message):
299 x: simple_type_class(x) for x in [
300 'i8', 'i16', 'i32', 'i64',
301 'u8', 'u16', 'u32', 'u64',
308 self.simple_type_class = simple_type_class
309 self.enum_class = enum_class
310 self.union_class = union_class
311 self.struct_type_class = struct_type_class
312 self.field_class = field_class
313 self.message_class = message_class
317 self.types_by_json = {}
318 self.enums_by_json = {}
319 self.unions_by_json = {}
320 self.messages_by_json = {}
323 self.parse_json_file(f)
324 self.finalize_parsing()
326 def parse_json_file(self, path):
327 self.logger.info("Parsing json api file: `%s'" % path)
328 self.json_files.append(path)
329 self.types_by_json[path] = []
330 self.enums_by_json[path] = []
331 self.unions_by_json[path] = []
332 self.messages_by_json[path] = {}
333 with open(path) as f:
335 for k in j['services']:
336 if k in self.services:
337 raise ParseError("Duplicate service `%s'" % k)
338 self.services[k] = j['services'][k]
339 self.replies.add(self.services[k]["reply"])
340 if "events" in self.services[k]:
341 for x in self.services[k]["events"]:
345 value_pairs = e[1:-1]
346 enumtype = self.types[e[-1]["enumtype"]]
347 enum = self.enum_class(name, value_pairs, enumtype)
348 self.enums[enum.name] = enum
349 self.logger.debug("Parsed enum: %s" % enum)
350 self.enums_by_json[path].append(enum)
355 for u in j['unions']:
357 if name in self.unions:
358 progress = progress + 1
361 type_pairs = [[self.lookup_type_like_id(t), n]
364 union = self.union_class(name, type_pairs, crc)
365 progress = progress + 1
366 except ParseError as e:
369 self.unions[union.name] = union
370 self.logger.debug("Parsed union: %s" % union)
371 self.unions_by_json[path].append(union)
373 if t[0] in self.types:
374 progress = progress + 1
377 type_ = self.struct_type_class(t, self,
380 if type_.name in self.types:
382 "Duplicate type `%s'" % type_.name)
383 progress = progress + 1
384 except ParseError as e:
387 self.types[type_.name] = type_
388 self.types_by_json[path].append(type_)
389 self.logger.debug("Parsed type: %s" % type_)
393 if progress <= last_progress:
394 # cannot make forward progress
395 self.exceptions.extend(exceptions)
397 last_progress = progress
399 prev_length = len(self.messages)
403 for m in j['messages']:
407 msg = self.message_class(self.logger, m, self)
408 if msg.name in self.messages:
410 "Duplicate message `%s'" % msg.name)
411 except ParseError as e:
414 self.messages[msg.name] = msg
415 self.messages_by_json[path][msg.name] = msg
417 if prev_length == len(self.messages):
418 # cannot make forward progress ...
419 self.exceptions.extend(exceptions)
421 prev_length = len(self.messages)
423 def lookup_type_like_id(self, name):
424 mundane_name = remove_magic(name)
425 if name in self.types:
426 return self.types[name]
427 elif name in self.enums:
428 return self.enums[name]
429 elif name in self.unions:
430 return self.unions[name]
431 elif mundane_name in self.types:
432 return self.types[mundane_name]
433 elif mundane_name in self.enums:
434 return self.enums[mundane_name]
435 elif mundane_name in self.unions:
436 return self.unions[mundane_name]
438 "Could not find type, enum or union by magic name `%s' nor by "
439 "mundane name `%s'" % (name, mundane_name))
441 def is_reply(self, message):
442 return message in self.replies
444 def is_event(self, message):
445 return message in self.events
447 def get_reply(self, message):
448 return self.messages[self.services[message]['reply']]
450 def finalize_parsing(self):
451 if len(self.messages) == 0:
452 for e in self.exceptions:
453 self.logger.warning(e)
454 for jn, j in self.messages_by_json.items():
456 for n, m in j.items():
458 if not m.is_reply and not m.is_event:
460 m.reply = self.get_reply(n)
461 if "stream" in self.services[m.name]:
462 m.reply_is_stream = \
463 self.services[m.name]["stream"]
465 m.reply_is_stream = False
469 "Cannot find reply to message `%s'" % n)
470 except ParseError as e:
471 self.exceptions.append(e)
474 self.messages_by_json[jn] = {
475 k: v for k, v in j.items() if k not in remove}