6 def msg_is_reply(name):
7 return name.endswith('_reply') or name.endswith('_details') \
8 or name.endswith('_event') or name.endswith('_counters')
11 class ParseError (Exception):
15 magic_prefix = "vl_api_"
19 def remove_magic(what):
20 if what.startswith(magic_prefix) and what.endswith(magic_suffix):
21 return what[len(magic_prefix): - len(magic_suffix)]
33 self.name = field_name
34 self.type = field_type
36 self.nelem_field = nelem_field
40 return "name: %s, type: %s" % (self.name, self.type)
42 return "name: %s, type: %s, length: %s" % (self.name, self.type,
45 return ("name: %s, type: %s, variable length stored in: %s" %
46 (self.name, self.type, self.nelem_field))
50 def __init__(self, name):
54 class SimpleType (Type):
56 def __init__(self, name):
57 super().__init__(name)
63 def get_msg_header_defs(struct_type_class, field_class, typedict):
65 struct_type_class(['msg_header1_t',
66 ['u16', '_vl_msg_id'],
71 struct_type_class(['msg_header2_t',
72 ['u16', '_vl_msg_id'],
73 ['u32', 'client_index'],
83 def __init__(self, name, fields):
86 self.field_names = [n.name for n in self.fields]
91 def __init__(self, logger, definition, typedict,
92 struct_type_class, simple_type_class, field_class):
95 logger.debug("Parsing message definition `%s'" % m)
98 logger.debug("Message name is `%s'" % name)
102 for header in get_msg_header_defs(struct_type_class, field_class,
104 logger.debug("Probing header `%s'" % header.name)
105 if header.is_part_of_def(m[1:]):
107 logger.debug("Found header `%s'" % header.name)
108 fields.append(field_class(field_name='header',
109 field_type=self.header))
112 if ignore and not msg_is_reply(name):
113 raise ParseError("While parsing message `%s': could not find all "
114 "common header fields" % name)
116 if len(field) == 1 and 'crc' in field:
117 self.crc = field['crc']
118 logger.debug("Found CRC `%s'" % self.crc)
121 field_type = field[0]
122 if field_type in typedict:
123 field_type = typedict[field_type]
125 field_type = typedict[remove_magic(field_type)]
127 if self.header is not None and\
128 self.header.has_field(field[1]):
130 p = field_class(field_name=field[1],
131 field_type=field_type)
132 elif len(field) == 3:
135 "While parsing message `%s': variable length "
136 "array `%s' doesn't have reference to member "
137 "containing the actual length" % (
141 field_type=field_type,
143 elif len(field) == 4:
146 if f.name == field[3]:
148 if nelem_field is None:
150 "While parsing message `%s': couldn't find "
151 "variable length array `%s' member containing "
152 "the actual length `%s'" % (
153 name, field[1], field[3]))
156 field_type=field_type,
158 nelem_field=nelem_field)
160 raise Exception("Don't know how to parse message "
161 "definition for message `%s': `%s'" %
163 logger.debug("Parsed field `%s'" % p)
168 return self.name.endswith('_dump')
171 return msg_is_reply(self.name)
174 class StructType (Type, Struct):
176 def __init__(self, definition, typedict, field_class):
181 if len(field) == 1 and 'crc' in field:
182 self.crc = field['crc']
184 elif len(field) == 2:
185 p = field_class(field_name=field[1],
186 field_type=typedict[field[0]])
187 elif len(field) == 3:
189 raise ParseError("While parsing type `%s': array `%s' has "
190 "variable length" % (name, field[1]))
191 p = field_class(field_name=field[1],
192 field_type=typedict[field[0]],
196 "Don't know how to parse type definition for "
197 "type `%s': `%s'" % (t, t[1:]))
199 Type.__init__(self, name)
200 Struct.__init__(self, name, fields)
202 def has_field(self, name):
203 return name in self.field_names
205 def is_part_of_def(self, definition):
206 for idx in range(len(self.fields)):
207 field = definition[idx]
209 if field[1] != p.name:
211 if field[0] != p.type.name:
213 "Unexpected field type `%s' (should be `%s'), "
214 "while parsing msg/def/field `%s/%s/%s'" %
215 (field[0], p.type, p.name, definition, field))
220 def __init__(self, logger, files, simple_type_class=SimpleType,
221 struct_type_class=StructType, field_class=Field,
222 message_class=Message):
225 x: simple_type_class(x) for x in [
226 'i8', 'i16', 'i32', 'i64',
227 'u8', 'u16', 'u32', 'u64',
232 self.simple_type_class = simple_type_class
233 self.struct_type_class = struct_type_class
234 self.field_class = field_class
235 self.message_class = message_class
239 self.types_by_json = {}
240 self.messages_by_json = {}
243 self.parse_json_file(f)
244 self.finalize_parsing()
246 def parse_json_file(self, path):
247 self.logger.info("Parsing json api file: `%s'" % path)
248 self.json_files.append(path)
249 self.types_by_json[path] = {}
250 self.messages_by_json[path] = {}
251 with open(path) as f:
255 type_ = self.struct_type_class(t, self.types,
257 if type_.name in self.types:
258 raise ParseError("Duplicate type `%s'" % type_.name)
259 except ParseError as e:
260 self.exceptions.append(e)
262 self.types[type_.name] = type_
263 self.types_by_json[path][type_.name] = type_
264 for m in j['messages']:
266 msg = self.message_class(self.logger, m, self.types,
267 self.struct_type_class,
268 self.simple_type_class,
270 if msg.name in self.messages:
271 raise ParseError("Duplicate message `%s'" % msg.name)
272 except ParseError as e:
273 self.exceptions.append(e)
275 self.messages[msg.name] = msg
276 self.messages_by_json[path][msg.name] = msg
278 def get_reply(self, message):
279 if self.messages[message].is_dump():
280 return self.messages["%s_details" % message[:-len("_dump")]]
281 return self.messages["%s_reply" % message]
283 def finalize_parsing(self):
284 if len(self.messages) == 0:
285 for e in self.exceptions:
287 raise Exception("No messages parsed.")
288 for jn, j in self.messages_by_json.items():
290 for n, m in j.items():
294 m.reply = self.get_reply(n)
297 "Cannot find reply to message `%s'" % n)
298 except ParseError as e:
299 self.exceptions.append(e)
302 self.messages_by_json[jn] = {
303 k: v for k, v in j.items() if k not in remove}