X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvpp-api%2Fvapi%2Fvapi_json_parser.py;h=fda3f75d9c1d50de41c796f358e33838ab917306;hb=dd1e3e780;hp=57a2238322b9e533f8dba307319ff3eb0bdde215;hpb=8f2a4eafeaa439432107563033728e09665c16d9;p=vpp.git diff --git a/src/vpp-api/vapi/vapi_json_parser.py b/src/vpp-api/vapi/vapi_json_parser.py index 57a2238322b..fda3f75d9c1 100644 --- a/src/vpp-api/vapi/vapi_json_parser.py +++ b/src/vpp-api/vapi/vapi_json_parser.py @@ -1,13 +1,8 @@ -#!/usr/bin/env python3 +#!/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 @@ -22,14 +17,10 @@ def remove_magic(what): return what -class Field: +class Field(object): - def __init__( - self, - field_name, - field_type, - array_len=None, - nelem_field=None): + 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 @@ -37,59 +28,113 @@ class Field: def __str__(self): if self.len is None: - return "name: %s, type: %s" % (self.name, self.type) + return "Field(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) + return "Field(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)) + return ( + "Field(name: %s, type: %s, variable length stored in: %s)" % + (self.name, self.type, self.nelem_field)) + def is_vla(self): + return self.nelem_field is not None -class Type: - def __init__(self, name): - self.name = name + def has_vla(self): + return self.is_vla() or self.type.has_vla() -class SimpleType (Type): +class Alias(Field): + pass + +class Type(object): def __init__(self, name): - super().__init__(name) + self.name = name def __str__(self): return self.name -def get_msg_header_defs(struct_type_class, field_class, typedict): +class SimpleType (Type): + + def has_vla(self): + return False + + +def get_msg_header_defs(struct_type_class, field_class, json_parser, logger): return [ struct_type_class(['msg_header1_t', ['u16', '_vl_msg_id'], ['u32', 'context'], ], - typedict, field_class + json_parser, field_class, logger ), struct_type_class(['msg_header2_t', ['u16', '_vl_msg_id'], ['u32', 'client_index'], ['u32', 'context'], ], - typedict, field_class + json_parser, field_class, logger ), ] -class Struct: +class Struct(object): def __init__(self, name, fields): self.name = name self.fields = fields self.field_names = [n.name for n in self.fields] + self.depends = [f.type for f in self.fields] + + def __str__(self): + return "[%s]" % "], [".join([str(f) for f in self.fields]) + + def has_vla(self): + for f in self.fields: + if f.has_vla(): + return True + return False + + +class Enum(SimpleType): + def __init__(self, name, value_pairs, enumtype): + super(Enum, self).__init__(name) + self.type = enumtype + self.value_pairs = value_pairs + + def __str__(self): + return "Enum(%s, [%s])" % ( + self.name, + "], [" .join(["%s => %s" % (i, j) for i, j in self.value_pairs]) + ) + + +class Union(Type): + def __init__(self, name, type_pairs, crc): + Type.__init__(self, name) + self.crc = crc + self.type_pairs = type_pairs + self.depends = [t for t, _ in self.type_pairs] + + def __str__(self): + return "Union(%s, [%s])" % ( + self.name, + "], [" .join(["%s %s" % (i, j) for i, j in self.type_pairs]) + ) + + def has_vla(self): + return False -class Message: +class Message(object): - def __init__(self, logger, definition, typedict, - struct_type_class, simple_type_class, field_class): + def __init__(self, logger, definition, json_parser): + struct_type_class = json_parser.struct_type_class + field_class = json_parser.field_class + self.request = None self.logger = logger m = definition logger.debug("Parsing message definition `%s'" % m) @@ -98,9 +143,11 @@ class Message: logger.debug("Message name is `%s'" % name) ignore = True self.header = None + self.is_reply = json_parser.is_reply(self.name) + self.is_event = json_parser.is_event(self.name) fields = [] for header in get_msg_header_defs(struct_type_class, field_class, - typedict): + json_parser, logger): logger.debug("Probing header `%s'" % header.name) if header.is_part_of_def(m[1:]): self.header = header @@ -109,7 +156,7 @@ class Message: field_type=self.header)) ignore = False break - if ignore and not msg_is_reply(name): + if ignore and not self.is_event and not self.is_reply: raise ParseError("While parsing message `%s': could not find all " "common header fields" % name) for field in m[1:]: @@ -118,11 +165,8 @@ class Message: logger.debug("Found CRC `%s'" % self.crc) continue else: - field_type = field[0] - if field_type in typedict: - field_type = typedict[field_type] - else: - field_type = typedict[remove_magic(field_type)] + field_type = json_parser.lookup_type_like_id(field[0]) + logger.debug("Parsing message field `%s'" % field) if len(field) == 2: if self.header is not None and\ self.header.has_field(field[1]): @@ -163,42 +207,66 @@ class Message: logger.debug("Parsed field `%s'" % p) fields.append(p) self.fields = fields + self.depends = [f.type for f in self.fields] + logger.debug("Parsed message: %s" % self) - def is_dump(self): - return self.name.endswith('_dump') - - def is_reply(self): - return msg_is_reply(self.name) + def __str__(self): + return "Message(%s, [%s], {crc: %s}" % \ + (self.name, + "], [".join([str(f) for f in self.fields]), + self.crc) class StructType (Type, Struct): - def __init__(self, definition, typedict, field_class): + def __init__(self, definition, json_parser, 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 - elif len(field) == 2: + field_type = json_parser.lookup_type_like_id(field[0]) + logger.debug("Parsing type field `%s'" % field) + if len(field) == 2: p = field_class(field_name=field[1], - field_type=typedict[field[0]]) + 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=typedict[field[0]], + 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 type definition for " - "type `%s': `%s'" % (t, t[1:])) + "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 @@ -216,27 +284,41 @@ class StructType (Type, Struct): return True -class JsonParser: +class JsonParser(object): def __init__(self, logger, files, simple_type_class=SimpleType, + enum_class=Enum, union_class=Union, struct_type_class=StructType, field_class=Field, - message_class=Message): + message_class=Message, alias_class=Alias): + self.services = {} self.messages = {} + self.enums = {} + self.unions = {} + self.aliases = {} self.types = { x: simple_type_class(x) for x in [ 'i8', 'i16', 'i32', 'i64', 'u8', 'u16', 'u32', 'u64', - 'f64' + 'f64', 'bool' ] } + self.types['string'] = simple_type_class('vl_api_string_t') + self.replies = set() + self.events = set() self.simple_type_class = simple_type_class + self.enum_class = enum_class + self.union_class = union_class self.struct_type_class = struct_type_class self.field_class = field_class + self.alias_class = alias_class self.message_class = message_class self.exceptions = [] self.json_files = [] self.types_by_json = {} + self.enums_by_json = {} + self.unions_by_json = {} + self.aliases_by_json = {} self.messages_by_json = {} self.logger = logger for f in files: @@ -246,52 +328,163 @@ class JsonParser: 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.types_by_json[path] = [] + self.enums_by_json[path] = [] + self.unions_by_json[path] = [] + self.aliases_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) - 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][type_.name] = type_ - for m in j['messages']: - 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: - self.exceptions.append(e) - continue - self.messages[msg.name] = msg - self.messages_by_json[path][msg.name] = msg + for k in j['services']: + if k in self.services: + raise ParseError("Duplicate service `%s'" % k) + self.services[k] = j['services'][k] + self.replies.add(self.services[k]["reply"]) + if "events" in self.services[k]: + for x in self.services[k]["events"]: + self.events.add(x) + for e in j['enums']: + name = e[0] + value_pairs = e[1:-1] + enumtype = self.types[e[-1]["enumtype"]] + enum = self.enum_class(name, value_pairs, enumtype) + self.enums[enum.name] = enum + self.logger.debug("Parsed enum: %s" % enum) + self.enums_by_json[path].append(enum) + exceptions = [] + progress = 0 + last_progress = 0 + while True: + for u in j['unions']: + name = u[0] + if name in self.unions: + progress = progress + 1 + continue + try: + type_pairs = [[self.lookup_type_like_id(t), n] + for t, n in u[1:-1]] + crc = u[-1]["crc"] + union = self.union_class(name, type_pairs, crc) + progress = progress + 1 + except ParseError as e: + exceptions.append(e) + continue + self.unions[union.name] = union + self.logger.debug("Parsed union: %s" % union) + self.unions_by_json[path].append(union) + for name, body in j['aliases'].iteritems(): + if name in self.aliases: + progress = progress + 1 + continue + if 'length' in body: + array_len = body['length'] + else: + array_len = None + t = self.types[body['type']] + alias = self.alias_class(name, t, array_len) + self.aliases[name] = alias + self.logger.debug("Parsed alias: %s" % alias) + self.aliases_by_json[path].append(alias) + for t in j['types']: + if t[0] in self.types: + progress = progress + 1 + continue + try: + type_ = self.struct_type_class(t, self, + self.field_class, + self.logger) + if type_.name in self.types: + raise ParseError( + "Duplicate type `%s'" % type_.name) + progress = progress + 1 + except ParseError as e: + exceptions.append(e) + continue + self.types[type_.name] = type_ + self.types_by_json[path].append(type_) + self.logger.debug("Parsed type: %s" % type_) + if not exceptions: + # finished parsing + break + if progress <= last_progress: + # cannot make forward progress + self.exceptions.extend(exceptions) + break + exceptions = [] + last_progress = progress + progress = 0 + 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) + 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 lookup_type_like_id(self, name): + mundane_name = remove_magic(name) + if name in self.types: + return self.types[name] + elif name in self.enums: + return self.enums[name] + elif name in self.unions: + return self.unions[name] + elif name in self.aliases: + return self.aliases[name] + elif mundane_name in self.types: + return self.types[mundane_name] + elif mundane_name in self.enums: + return self.enums[mundane_name] + elif mundane_name in self.unions: + return self.unions[mundane_name] + elif mundane_name in self.aliases: + return self.aliases[mundane_name] + raise ParseError( + "Could not find type, enum or union by magic name `%s' nor by " + "mundane name `%s'" % (name, mundane_name)) + + def is_reply(self, message): + return message in self.replies + + def is_event(self, message): + return message in self.events 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] + return self.messages[self.services[message]['reply']] def finalize_parsing(self): if len(self.messages) == 0: for e in self.exceptions: - self.logger.error(e) - raise Exception("No messages parsed.") + self.logger.warning(e) for jn, j in self.messages_by_json.items(): remove = [] for n, m in j.items(): try: - if not m.is_reply(): + if not m.is_reply and not m.is_event: try: m.reply = self.get_reply(n) + if "stream" in self.services[m.name]: + m.reply_is_stream = \ + self.services[m.name]["stream"] + else: + m.reply_is_stream = False + m.reply.request = m except: raise ParseError( "Cannot find reply to message `%s'" % n)