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()
53 def __init__(self, name):
60 class SimpleType (Type):
66 def get_msg_header_defs(struct_type_class, field_class, json_parser, logger):
68 struct_type_class(['msg_header1_t',
69 ['u16', '_vl_msg_id'],
72 json_parser, field_class, logger
74 struct_type_class(['msg_header2_t',
75 ['u16', '_vl_msg_id'],
76 ['u32', 'client_index'],
79 json_parser, field_class, logger
86 def __init__(self, name, fields):
89 self.field_names = [n.name for n in self.fields]
90 self.depends = [f.type for f in self.fields]
93 return "[%s]" % "], [".join([str(f) for f in self.fields])
102 class Enum(SimpleType):
103 def __init__(self, name, value_pairs, enumtype):
104 super(Enum, self).__init__(name)
106 self.value_pairs = value_pairs
109 return "Enum(%s, [%s])" % (
111 "], [" .join(["%s => %s" % (i, j) for i, j in self.value_pairs])
116 def __init__(self, name, type_pairs, crc):
117 Type.__init__(self, name)
119 self.type_pairs = type_pairs
120 self.depends = [t for t, _ in self.type_pairs]
123 return "Union(%s, [%s])" % (
125 "], [" .join(["%s %s" % (i, j) for i, j in self.type_pairs])
132 class Message(object):
134 def __init__(self, logger, definition, json_parser):
135 struct_type_class = json_parser.struct_type_class
136 field_class = json_parser.field_class
140 logger.debug("Parsing message definition `%s'" % m)
143 logger.debug("Message name is `%s'" % name)
146 self.is_reply = json_parser.is_reply(self.name)
147 self.is_event = json_parser.is_event(self.name)
149 for header in get_msg_header_defs(struct_type_class, field_class,
150 json_parser, logger):
151 logger.debug("Probing header `%s'" % header.name)
152 if header.is_part_of_def(m[1:]):
154 logger.debug("Found header `%s'" % header.name)
155 fields.append(field_class(field_name='header',
156 field_type=self.header))
159 if ignore and not self.is_event and not self.is_reply:
160 raise ParseError("While parsing message `%s': could not find all "
161 "common header fields" % name)
163 if len(field) == 1 and 'crc' in field:
164 self.crc = field['crc']
165 logger.debug("Found CRC `%s'" % self.crc)
168 field_type = json_parser.lookup_type_like_id(field[0])
169 logger.debug("Parsing message field `%s'" % field)
171 if any(type(n) is dict for n in field):
174 if self.header is not None and\
175 self.header.has_field(field[1]):
177 p = field_class(field_name=field[1],
178 field_type=field_type)
182 "While parsing message `%s': variable length "
183 "array `%s' doesn't have reference to member "
184 "containing the actual length" % (
188 field_type=field_type,
193 if f.name == field[3]:
195 if nelem_field is None:
197 "While parsing message `%s': couldn't find "
198 "variable length array `%s' member containing "
199 "the actual length `%s'" % (
200 name, field[1], field[3]))
203 field_type=field_type,
205 nelem_field=nelem_field)
207 raise Exception("Don't know how to parse message "
208 "definition for message `%s': `%s'" %
210 logger.debug("Parsed field `%s'" % p)
213 self.depends = [f.type for f in self.fields]
214 logger.debug("Parsed message: %s" % self)
217 return "Message(%s, [%s], {crc: %s}" % \
219 "], [".join([str(f) for f in self.fields]),
223 class StructType (Type, Struct):
225 def __init__(self, definition, json_parser, field_class, logger):
227 logger.debug("Parsing struct definition `%s'" % t)
231 if len(field) == 1 and 'crc' in field:
232 self.crc = field['crc']
234 field_type = json_parser.lookup_type_like_id(field[0])
235 logger.debug("Parsing type field `%s'" % field)
237 p = field_class(field_name=field[1],
238 field_type=field_type)
239 elif len(field) == 3:
241 raise ParseError("While parsing type `%s': array `%s' has "
242 "variable length" % (name, field[1]))
243 p = field_class(field_name=field[1],
244 field_type=field_type,
246 elif len(field) == 4:
249 if f.name == field[3]:
251 if nelem_field is None:
253 "While parsing message `%s': couldn't find "
254 "variable length array `%s' member containing "
255 "the actual length `%s'" % (
256 name, field[1], field[3]))
257 p = field_class(field_name=field[1],
258 field_type=field_type,
260 nelem_field=nelem_field)
263 "Don't know how to parse field `%s' of type definition "
264 "for type `%s'" % (field, t))
266 Type.__init__(self, name)
267 Struct.__init__(self, name, fields)
270 return "StructType(%s, %s)" % (Type.__str__(self),
271 Struct.__str__(self))
273 def has_field(self, name):
274 return name in self.field_names
276 def is_part_of_def(self, definition):
277 for idx in range(len(self.fields)):
278 field = definition[idx]
280 if field[1] != p.name:
282 if field[0] != p.type.name:
284 "Unexpected field type `%s' (should be `%s'), "
285 "while parsing msg/def/field `%s/%s/%s'" %
286 (field[0], p.type, p.name, definition, field))
290 class JsonParser(object):
291 def __init__(self, logger, files, simple_type_class=SimpleType,
292 enum_class=Enum, union_class=Union,
293 struct_type_class=StructType, field_class=Field,
294 message_class=Message, alias_class=Alias):
301 x: simple_type_class(x) for x in [
302 'i8', 'i16', 'i32', 'i64',
303 'u8', 'u16', 'u32', 'u64',
308 self.types['string'] = simple_type_class('vl_api_string_t')
311 self.simple_type_class = simple_type_class
312 self.enum_class = enum_class
313 self.union_class = union_class
314 self.struct_type_class = struct_type_class
315 self.field_class = field_class
316 self.alias_class = alias_class
317 self.message_class = message_class
321 self.types_by_json = {}
322 self.enums_by_json = {}
323 self.unions_by_json = {}
324 self.aliases_by_json = {}
325 self.messages_by_json = {}
328 self.parse_json_file(f)
329 self.finalize_parsing()
331 def parse_json_file(self, path):
332 self.logger.info("Parsing json api file: `%s'" % path)
333 self.json_files.append(path)
334 self.types_by_json[path] = []
335 self.enums_by_json[path] = []
336 self.unions_by_json[path] = []
337 self.aliases_by_json[path] = []
338 self.messages_by_json[path] = {}
339 with open(path) as f:
341 for k in j['services']:
342 if k in self.services:
343 raise ParseError("Duplicate service `%s'" % k)
344 self.services[k] = j['services'][k]
345 self.replies.add(self.services[k]["reply"])
346 if "events" in self.services[k]:
347 for x in self.services[k]["events"]:
351 value_pairs = e[1:-1]
352 enumtype = self.types[e[-1]["enumtype"]]
353 enum = self.enum_class(name, value_pairs, enumtype)
354 self.enums[enum.name] = enum
355 self.logger.debug("Parsed enum: %s" % enum)
356 self.enums_by_json[path].append(enum)
361 for u in j['unions']:
363 if name in self.unions:
364 progress = progress + 1
367 type_pairs = [[self.lookup_type_like_id(t), n]
369 union = self.union_class(name, type_pairs, 0)
370 progress = progress + 1
371 except ParseError as e:
374 self.unions[union.name] = union
375 self.logger.debug("Parsed union: %s" % union)
376 self.unions_by_json[path].append(union)
377 for name, body in j['aliases'].iteritems():
378 if name in self.aliases:
379 progress = progress + 1
382 array_len = body['length']
385 t = self.types[body['type']]
386 alias = self.alias_class(name, t, array_len)
387 self.aliases[name] = alias
388 self.logger.debug("Parsed alias: %s" % alias)
389 self.aliases_by_json[path].append(alias)
391 if t[0] in self.types:
392 progress = progress + 1
395 type_ = self.struct_type_class(t, self,
398 if type_.name in self.types:
400 "Duplicate type `%s'" % type_.name)
401 progress = progress + 1
402 except ParseError as e:
405 self.types[type_.name] = type_
406 self.types_by_json[path].append(type_)
407 self.logger.debug("Parsed type: %s" % type_)
411 if progress <= last_progress:
412 # cannot make forward progress
413 self.exceptions.extend(exceptions)
416 last_progress = progress
418 prev_length = len(self.messages)
422 for m in j['messages']:
426 msg = self.message_class(self.logger, m, self)
427 if msg.name in self.messages:
429 "Duplicate message `%s'" % msg.name)
430 except ParseError as e:
433 self.messages[msg.name] = msg
434 self.messages_by_json[path][msg.name] = msg
436 if prev_length == len(self.messages):
437 # cannot make forward progress ...
438 self.exceptions.extend(exceptions)
440 prev_length = len(self.messages)
442 def lookup_type_like_id(self, name):
443 mundane_name = remove_magic(name)
444 if name in self.types:
445 return self.types[name]
446 elif name in self.enums:
447 return self.enums[name]
448 elif name in self.unions:
449 return self.unions[name]
450 elif name in self.aliases:
451 return self.aliases[name]
452 elif mundane_name in self.types:
453 return self.types[mundane_name]
454 elif mundane_name in self.enums:
455 return self.enums[mundane_name]
456 elif mundane_name in self.unions:
457 return self.unions[mundane_name]
458 elif mundane_name in self.aliases:
459 return self.aliases[mundane_name]
461 "Could not find type, enum or union by magic name `%s' nor by "
462 "mundane name `%s'" % (name, mundane_name))
464 def is_reply(self, message):
465 return message in self.replies
467 def is_event(self, message):
468 return message in self.events
470 def get_reply(self, message):
471 return self.messages[self.services[message]['reply']]
473 def finalize_parsing(self):
474 if len(self.messages) == 0:
475 for e in self.exceptions:
476 self.logger.warning(e)
477 for jn, j in self.messages_by_json.items():
479 for n, m in j.items():
481 if not m.is_reply and not m.is_event:
483 m.reply = self.get_reply(n)
484 if "stream" in self.services[m.name]:
485 m.reply_is_stream = \
486 self.services[m.name]["stream"]
488 m.reply_is_stream = False
492 "Cannot find reply to message `%s'" % n)
493 except ParseError as e:
494 self.exceptions.append(e)
497 self.messages_by_json[jn] = {
498 k: v for k, v in j.items() if k not in remove}