]>
Commit | Line | Data |
---|---|---|
0f923be2 MR |
1 | # |
2 | # QAPI helper library | |
3 | # | |
4 | # Copyright IBM, Corp. 2011 | |
fe2a9303 | 5 | # Copyright (c) 2013-2015 Red Hat Inc. |
0f923be2 MR |
6 | # |
7 | # Authors: | |
8 | # Anthony Liguori <aliguori@us.ibm.com> | |
c7a3f252 | 9 | # Markus Armbruster <armbru@redhat.com> |
0f923be2 | 10 | # |
678e48a2 MA |
11 | # This work is licensed under the terms of the GNU GPL, version 2. |
12 | # See the COPYING file in the top-level directory. | |
0f923be2 | 13 | |
a719a27c | 14 | import re |
0f923be2 | 15 | from ordereddict import OrderedDict |
33aaad52 | 16 | import os |
2caba36c | 17 | import sys |
47299262 | 18 | import string |
0f923be2 | 19 | |
b52c4b9c | 20 | builtin_types = { |
69dd62df KW |
21 | 'str': 'QTYPE_QSTRING', |
22 | 'int': 'QTYPE_QINT', | |
23 | 'number': 'QTYPE_QFLOAT', | |
24 | 'bool': 'QTYPE_QBOOL', | |
25 | 'int8': 'QTYPE_QINT', | |
26 | 'int16': 'QTYPE_QINT', | |
27 | 'int32': 'QTYPE_QINT', | |
28 | 'int64': 'QTYPE_QINT', | |
29 | 'uint8': 'QTYPE_QINT', | |
30 | 'uint16': 'QTYPE_QINT', | |
31 | 'uint32': 'QTYPE_QINT', | |
32 | 'uint64': 'QTYPE_QINT', | |
cb17f79e | 33 | 'size': 'QTYPE_QINT', |
69dd62df KW |
34 | } |
35 | ||
10d4d997 EB |
36 | # Whitelist of commands allowed to return a non-dictionary |
37 | returns_whitelist = [ | |
38 | # From QMP: | |
39 | 'human-monitor-command', | |
40 | 'query-migrate-cache-size', | |
41 | 'query-tpm-models', | |
42 | 'query-tpm-types', | |
43 | 'ringbuf-read', | |
44 | ||
45 | # From QGA: | |
46 | 'guest-file-open', | |
47 | 'guest-fsfreeze-freeze', | |
48 | 'guest-fsfreeze-freeze-list', | |
49 | 'guest-fsfreeze-status', | |
50 | 'guest-fsfreeze-thaw', | |
51 | 'guest-get-time', | |
52 | 'guest-set-vcpus', | |
53 | 'guest-sync', | |
54 | 'guest-sync-delimited', | |
55 | ||
56 | # From qapi-schema-test: | |
57 | 'user_def_cmd3', | |
58 | ] | |
59 | ||
4dc2e690 EB |
60 | enum_types = [] |
61 | struct_types = [] | |
62 | union_types = [] | |
63 | events = [] | |
64 | all_names = {} | |
65 | ||
a719a27c LV |
66 | def error_path(parent): |
67 | res = "" | |
68 | while parent: | |
69 | res = ("In file included from %s:%d:\n" % (parent['file'], | |
70 | parent['line'])) + res | |
71 | parent = parent['parent'] | |
72 | return res | |
73 | ||
2caba36c MA |
74 | class QAPISchemaError(Exception): |
75 | def __init__(self, schema, msg): | |
a719a27c | 76 | self.input_file = schema.input_file |
2caba36c | 77 | self.msg = msg |
515b943a WX |
78 | self.col = 1 |
79 | self.line = schema.line | |
80 | for ch in schema.src[schema.line_pos:schema.pos]: | |
81 | if ch == '\t': | |
2caba36c MA |
82 | self.col = (self.col + 7) % 8 + 1 |
83 | else: | |
84 | self.col += 1 | |
a719a27c | 85 | self.info = schema.parent_info |
2caba36c MA |
86 | |
87 | def __str__(self): | |
a719a27c LV |
88 | return error_path(self.info) + \ |
89 | "%s:%d:%d: %s" % (self.input_file, self.line, self.col, self.msg) | |
2caba36c | 90 | |
b86b05ed WX |
91 | class QAPIExprError(Exception): |
92 | def __init__(self, expr_info, msg): | |
a719a27c | 93 | self.info = expr_info |
b86b05ed WX |
94 | self.msg = msg |
95 | ||
96 | def __str__(self): | |
a719a27c LV |
97 | return error_path(self.info['parent']) + \ |
98 | "%s:%d: %s" % (self.info['file'], self.info['line'], self.msg) | |
b86b05ed | 99 | |
c7a3f252 MA |
100 | class QAPISchema: |
101 | ||
24fd8489 BC |
102 | def __init__(self, fp, input_relname=None, include_hist=[], |
103 | previously_included=[], parent_info=None): | |
104 | """ include_hist is a stack used to detect inclusion cycles | |
105 | previously_included is a global state used to avoid multiple | |
106 | inclusions of the same file""" | |
a719a27c LV |
107 | input_fname = os.path.abspath(fp.name) |
108 | if input_relname is None: | |
109 | input_relname = fp.name | |
110 | self.input_dir = os.path.dirname(input_fname) | |
111 | self.input_file = input_relname | |
112 | self.include_hist = include_hist + [(input_relname, input_fname)] | |
24fd8489 | 113 | previously_included.append(input_fname) |
a719a27c | 114 | self.parent_info = parent_info |
c7a3f252 MA |
115 | self.src = fp.read() |
116 | if self.src == '' or self.src[-1] != '\n': | |
117 | self.src += '\n' | |
118 | self.cursor = 0 | |
515b943a WX |
119 | self.line = 1 |
120 | self.line_pos = 0 | |
c7a3f252 MA |
121 | self.exprs = [] |
122 | self.accept() | |
123 | ||
124 | while self.tok != None: | |
a719a27c LV |
125 | expr_info = {'file': input_relname, 'line': self.line, 'parent': self.parent_info} |
126 | expr = self.get_expr(False) | |
127 | if isinstance(expr, dict) and "include" in expr: | |
128 | if len(expr) != 1: | |
129 | raise QAPIExprError(expr_info, "Invalid 'include' directive") | |
130 | include = expr["include"] | |
131 | if not isinstance(include, str): | |
132 | raise QAPIExprError(expr_info, | |
133 | 'Expected a file name (string), got: %s' | |
134 | % include) | |
135 | include_path = os.path.join(self.input_dir, include) | |
7ac9a9d6 SH |
136 | for elem in self.include_hist: |
137 | if include_path == elem[1]: | |
138 | raise QAPIExprError(expr_info, "Inclusion loop for %s" | |
139 | % include) | |
24fd8489 BC |
140 | # skip multiple include of the same file |
141 | if include_path in previously_included: | |
142 | continue | |
a719a27c LV |
143 | try: |
144 | fobj = open(include_path, 'r') | |
34788811 | 145 | except IOError, e: |
a719a27c LV |
146 | raise QAPIExprError(expr_info, |
147 | '%s: %s' % (e.strerror, include)) | |
24fd8489 BC |
148 | exprs_include = QAPISchema(fobj, include, self.include_hist, |
149 | previously_included, expr_info) | |
a719a27c LV |
150 | self.exprs.extend(exprs_include.exprs) |
151 | else: | |
152 | expr_elem = {'expr': expr, | |
153 | 'info': expr_info} | |
154 | self.exprs.append(expr_elem) | |
c7a3f252 MA |
155 | |
156 | def accept(self): | |
157 | while True: | |
c7a3f252 | 158 | self.tok = self.src[self.cursor] |
2caba36c | 159 | self.pos = self.cursor |
c7a3f252 MA |
160 | self.cursor += 1 |
161 | self.val = None | |
162 | ||
f1a145e1 | 163 | if self.tok == '#': |
c7a3f252 MA |
164 | self.cursor = self.src.find('\n', self.cursor) |
165 | elif self.tok in ['{', '}', ':', ',', '[', ']']: | |
166 | return | |
167 | elif self.tok == "'": | |
168 | string = '' | |
169 | esc = False | |
170 | while True: | |
171 | ch = self.src[self.cursor] | |
172 | self.cursor += 1 | |
173 | if ch == '\n': | |
2caba36c MA |
174 | raise QAPISchemaError(self, |
175 | 'Missing terminating "\'"') | |
c7a3f252 | 176 | if esc: |
a7f5966b EB |
177 | if ch == 'b': |
178 | string += '\b' | |
179 | elif ch == 'f': | |
180 | string += '\f' | |
181 | elif ch == 'n': | |
182 | string += '\n' | |
183 | elif ch == 'r': | |
184 | string += '\r' | |
185 | elif ch == 't': | |
186 | string += '\t' | |
187 | elif ch == 'u': | |
188 | value = 0 | |
189 | for x in range(0, 4): | |
190 | ch = self.src[self.cursor] | |
191 | self.cursor += 1 | |
192 | if ch not in "0123456789abcdefABCDEF": | |
193 | raise QAPISchemaError(self, | |
194 | '\\u escape needs 4 ' | |
195 | 'hex digits') | |
196 | value = (value << 4) + int(ch, 16) | |
197 | # If Python 2 and 3 didn't disagree so much on | |
198 | # how to handle Unicode, then we could allow | |
199 | # Unicode string defaults. But most of QAPI is | |
200 | # ASCII-only, so we aren't losing much for now. | |
201 | if not value or value > 0x7f: | |
202 | raise QAPISchemaError(self, | |
203 | 'For now, \\u escape ' | |
204 | 'only supports non-zero ' | |
205 | 'values up to \\u007f') | |
206 | string += chr(value) | |
207 | elif ch in "\\/'\"": | |
208 | string += ch | |
209 | else: | |
210 | raise QAPISchemaError(self, | |
211 | "Unknown escape \\%s" %ch) | |
c7a3f252 MA |
212 | esc = False |
213 | elif ch == "\\": | |
214 | esc = True | |
215 | elif ch == "'": | |
216 | self.val = string | |
217 | return | |
218 | else: | |
219 | string += ch | |
e53188ad FZ |
220 | elif self.tok in "tfn": |
221 | val = self.src[self.cursor - 1:] | |
222 | if val.startswith("true"): | |
223 | self.val = True | |
224 | self.cursor += 3 | |
225 | return | |
226 | elif val.startswith("false"): | |
227 | self.val = False | |
228 | self.cursor += 4 | |
229 | return | |
230 | elif val.startswith("null"): | |
231 | self.val = None | |
232 | self.cursor += 3 | |
233 | return | |
c7a3f252 MA |
234 | elif self.tok == '\n': |
235 | if self.cursor == len(self.src): | |
236 | self.tok = None | |
237 | return | |
515b943a WX |
238 | self.line += 1 |
239 | self.line_pos = self.cursor | |
9213aa53 MA |
240 | elif not self.tok.isspace(): |
241 | raise QAPISchemaError(self, 'Stray "%s"' % self.tok) | |
c7a3f252 MA |
242 | |
243 | def get_members(self): | |
244 | expr = OrderedDict() | |
6974ccd5 MA |
245 | if self.tok == '}': |
246 | self.accept() | |
247 | return expr | |
248 | if self.tok != "'": | |
249 | raise QAPISchemaError(self, 'Expected string or "}"') | |
250 | while True: | |
c7a3f252 MA |
251 | key = self.val |
252 | self.accept() | |
6974ccd5 MA |
253 | if self.tok != ':': |
254 | raise QAPISchemaError(self, 'Expected ":"') | |
255 | self.accept() | |
4b35991a WX |
256 | if key in expr: |
257 | raise QAPISchemaError(self, 'Duplicate key "%s"' % key) | |
5f3cd2b7 | 258 | expr[key] = self.get_expr(True) |
6974ccd5 | 259 | if self.tok == '}': |
c7a3f252 | 260 | self.accept() |
6974ccd5 MA |
261 | return expr |
262 | if self.tok != ',': | |
263 | raise QAPISchemaError(self, 'Expected "," or "}"') | |
264 | self.accept() | |
265 | if self.tok != "'": | |
266 | raise QAPISchemaError(self, 'Expected string') | |
c7a3f252 MA |
267 | |
268 | def get_values(self): | |
269 | expr = [] | |
6974ccd5 MA |
270 | if self.tok == ']': |
271 | self.accept() | |
272 | return expr | |
e53188ad FZ |
273 | if not self.tok in "{['tfn": |
274 | raise QAPISchemaError(self, 'Expected "{", "[", "]", string, ' | |
275 | 'boolean or "null"') | |
6974ccd5 | 276 | while True: |
5f3cd2b7 | 277 | expr.append(self.get_expr(True)) |
6974ccd5 | 278 | if self.tok == ']': |
c7a3f252 | 279 | self.accept() |
6974ccd5 MA |
280 | return expr |
281 | if self.tok != ',': | |
282 | raise QAPISchemaError(self, 'Expected "," or "]"') | |
283 | self.accept() | |
c7a3f252 | 284 | |
5f3cd2b7 MA |
285 | def get_expr(self, nested): |
286 | if self.tok != '{' and not nested: | |
287 | raise QAPISchemaError(self, 'Expected "{"') | |
c7a3f252 MA |
288 | if self.tok == '{': |
289 | self.accept() | |
290 | expr = self.get_members() | |
291 | elif self.tok == '[': | |
292 | self.accept() | |
293 | expr = self.get_values() | |
e53188ad | 294 | elif self.tok in "'tfn": |
c7a3f252 MA |
295 | expr = self.val |
296 | self.accept() | |
6974ccd5 MA |
297 | else: |
298 | raise QAPISchemaError(self, 'Expected "{", "[" or string') | |
c7a3f252 | 299 | return expr |
bd9927fe | 300 | |
b86b05ed WX |
301 | def find_base_fields(base): |
302 | base_struct_define = find_struct(base) | |
303 | if not base_struct_define: | |
304 | return None | |
305 | return base_struct_define['data'] | |
306 | ||
811d04fd EB |
307 | # Return the qtype of an alternate branch, or None on error. |
308 | def find_alternate_member_qtype(qapi_type): | |
44bd1276 EB |
309 | if builtin_types.has_key(qapi_type): |
310 | return builtin_types[qapi_type] | |
311 | elif find_struct(qapi_type): | |
312 | return "QTYPE_QDICT" | |
313 | elif find_enum(qapi_type): | |
314 | return "QTYPE_QSTRING" | |
811d04fd EB |
315 | elif find_union(qapi_type): |
316 | return "QTYPE_QDICT" | |
44bd1276 EB |
317 | return None |
318 | ||
bceae769 WX |
319 | # Return the discriminator enum define if discriminator is specified as an |
320 | # enum type, otherwise return None. | |
321 | def discriminator_find_enum_define(expr): | |
322 | base = expr.get('base') | |
323 | discriminator = expr.get('discriminator') | |
324 | ||
325 | if not (discriminator and base): | |
326 | return None | |
327 | ||
328 | base_fields = find_base_fields(base) | |
329 | if not base_fields: | |
330 | return None | |
331 | ||
332 | discriminator_type = base_fields.get(discriminator) | |
333 | if not discriminator_type: | |
334 | return None | |
335 | ||
336 | return find_enum(discriminator_type) | |
337 | ||
c9e0a798 EB |
338 | valid_name = re.compile('^[a-zA-Z_][a-zA-Z0-9_.-]*$') |
339 | def check_name(expr_info, source, name, allow_optional = False, | |
340 | enum_member = False): | |
341 | global valid_name | |
342 | membername = name | |
343 | ||
344 | if not isinstance(name, str): | |
345 | raise QAPIExprError(expr_info, | |
346 | "%s requires a string name" % source) | |
347 | if name.startswith('*'): | |
348 | membername = name[1:] | |
349 | if not allow_optional: | |
350 | raise QAPIExprError(expr_info, | |
351 | "%s does not allow optional name '%s'" | |
352 | % (source, name)) | |
353 | # Enum members can start with a digit, because the generated C | |
354 | # code always prefixes it with the enum name | |
355 | if enum_member: | |
356 | membername = '_' + membername | |
357 | if not valid_name.match(membername): | |
358 | raise QAPIExprError(expr_info, | |
359 | "%s uses invalid name '%s'" % (source, name)) | |
360 | ||
dd883c6f | 361 | def check_type(expr_info, source, value, allow_array = False, |
2cbf0992 EB |
362 | allow_dict = False, allow_optional = False, |
363 | allow_star = False, allow_metas = []): | |
dd883c6f EB |
364 | global all_names |
365 | orig_value = value | |
366 | ||
367 | if value is None: | |
368 | return | |
369 | ||
2cbf0992 | 370 | if allow_star and value == '**': |
dd883c6f EB |
371 | return |
372 | ||
373 | # Check if array type for value is okay | |
374 | if isinstance(value, list): | |
375 | if not allow_array: | |
376 | raise QAPIExprError(expr_info, | |
377 | "%s cannot be an array" % source) | |
378 | if len(value) != 1 or not isinstance(value[0], str): | |
379 | raise QAPIExprError(expr_info, | |
380 | "%s: array type must contain single type name" | |
381 | % source) | |
382 | value = value[0] | |
383 | orig_value = "array of %s" %value | |
384 | ||
385 | # Check if type name for value is okay | |
386 | if isinstance(value, str): | |
2cbf0992 EB |
387 | if value == '**': |
388 | raise QAPIExprError(expr_info, | |
389 | "%s uses '**' but did not request 'gen':false" | |
390 | % source) | |
dd883c6f EB |
391 | if not value in all_names: |
392 | raise QAPIExprError(expr_info, | |
393 | "%s uses unknown type '%s'" | |
394 | % (source, orig_value)) | |
395 | if not all_names[value] in allow_metas: | |
396 | raise QAPIExprError(expr_info, | |
397 | "%s cannot use %s type '%s'" | |
398 | % (source, all_names[value], orig_value)) | |
399 | return | |
400 | ||
401 | # value is a dictionary, check that each member is okay | |
402 | if not isinstance(value, OrderedDict): | |
403 | raise QAPIExprError(expr_info, | |
404 | "%s should be a dictionary" % source) | |
405 | if not allow_dict: | |
406 | raise QAPIExprError(expr_info, | |
407 | "%s should be a type name" % source) | |
408 | for (key, arg) in value.items(): | |
c9e0a798 EB |
409 | check_name(expr_info, "Member of %s" % source, key, |
410 | allow_optional=allow_optional) | |
6b5abc7d EB |
411 | # Todo: allow dictionaries to represent default values of |
412 | # an optional argument. | |
dd883c6f | 413 | check_type(expr_info, "Member '%s' of %s" % (key, source), arg, |
6b5abc7d | 414 | allow_array=True, allow_star=allow_star, |
dd883c6f | 415 | allow_metas=['built-in', 'union', 'alternate', 'struct', |
6b5abc7d | 416 | 'enum']) |
dd883c6f | 417 | |
ff55d72e EB |
418 | def check_member_clash(expr_info, base_name, data, source = ""): |
419 | base = find_struct(base_name) | |
420 | assert base | |
421 | base_members = base['data'] | |
422 | for key in data.keys(): | |
423 | if key.startswith('*'): | |
424 | key = key[1:] | |
425 | if key in base_members or "*" + key in base_members: | |
426 | raise QAPIExprError(expr_info, | |
427 | "Member name '%s'%s clashes with base '%s'" | |
428 | % (key, source, base_name)) | |
429 | if base.get('base'): | |
430 | check_member_clash(expr_info, base['base'], data, source) | |
431 | ||
dd883c6f EB |
432 | def check_command(expr, expr_info): |
433 | name = expr['command'] | |
2cbf0992 EB |
434 | allow_star = expr.has_key('gen') |
435 | ||
dd883c6f | 436 | check_type(expr_info, "'data' for command '%s'" % name, |
c9e0a798 | 437 | expr.get('data'), allow_dict=True, allow_optional=True, |
2cbf0992 | 438 | allow_metas=['union', 'struct'], allow_star=allow_star) |
10d4d997 EB |
439 | returns_meta = ['union', 'struct'] |
440 | if name in returns_whitelist: | |
441 | returns_meta += ['built-in', 'alternate', 'enum'] | |
dd883c6f EB |
442 | check_type(expr_info, "'returns' for command '%s'" % name, |
443 | expr.get('returns'), allow_array=True, allow_dict=True, | |
2cbf0992 EB |
444 | allow_optional=True, allow_metas=returns_meta, |
445 | allow_star=allow_star) | |
dd883c6f | 446 | |
21cd70df | 447 | def check_event(expr, expr_info): |
4dc2e690 EB |
448 | global events |
449 | name = expr['event'] | |
21cd70df | 450 | params = expr.get('data') |
4dc2e690 EB |
451 | |
452 | if name.upper() == 'MAX': | |
453 | raise QAPIExprError(expr_info, "Event name 'MAX' cannot be created") | |
454 | events.append(name) | |
dd883c6f | 455 | check_type(expr_info, "'data' for event '%s'" % name, |
c9e0a798 | 456 | expr.get('data'), allow_dict=True, allow_optional=True, |
dd883c6f | 457 | allow_metas=['union', 'struct']) |
21cd70df | 458 | |
b86b05ed WX |
459 | def check_union(expr, expr_info): |
460 | name = expr['union'] | |
461 | base = expr.get('base') | |
462 | discriminator = expr.get('discriminator') | |
463 | members = expr['data'] | |
44bd1276 | 464 | values = { 'MAX': '(automatic)' } |
b86b05ed | 465 | |
fd41dd4e | 466 | # If the object has a member 'base', its value must name a struct, |
a8d4a2e4 EB |
467 | # and there must be a discriminator. |
468 | if base is not None: | |
469 | if discriminator is None: | |
470 | raise QAPIExprError(expr_info, | |
471 | "Union '%s' requires a discriminator to go " | |
472 | "along with base" %name) | |
b86b05ed | 473 | |
811d04fd | 474 | # Two types of unions, determined by discriminator. |
811d04fd EB |
475 | |
476 | # With no discriminator it is a simple union. | |
477 | if discriminator is None: | |
b86b05ed | 478 | enum_define = None |
dd883c6f | 479 | allow_metas=['built-in', 'union', 'alternate', 'struct', 'enum'] |
44bd1276 EB |
480 | if base is not None: |
481 | raise QAPIExprError(expr_info, | |
811d04fd | 482 | "Simple union '%s' must not have a base" |
44bd1276 | 483 | % name) |
b86b05ed WX |
484 | |
485 | # Else, it's a flat union. | |
486 | else: | |
44bd1276 EB |
487 | # The object must have a string member 'base'. |
488 | if not isinstance(base, str): | |
b86b05ed | 489 | raise QAPIExprError(expr_info, |
44bd1276 | 490 | "Flat union '%s' must have a string base field" |
b86b05ed | 491 | % name) |
44bd1276 EB |
492 | base_fields = find_base_fields(base) |
493 | if not base_fields: | |
494 | raise QAPIExprError(expr_info, | |
fd41dd4e | 495 | "Base '%s' is not a valid struct" |
44bd1276 EB |
496 | % base) |
497 | ||
c9e0a798 | 498 | # The value of member 'discriminator' must name a non-optional |
fd41dd4e | 499 | # member of the base struct. |
c9e0a798 EB |
500 | check_name(expr_info, "Discriminator of flat union '%s'" % name, |
501 | discriminator) | |
b86b05ed WX |
502 | discriminator_type = base_fields.get(discriminator) |
503 | if not discriminator_type: | |
504 | raise QAPIExprError(expr_info, | |
505 | "Discriminator '%s' is not a member of base " | |
fd41dd4e | 506 | "struct '%s'" |
b86b05ed WX |
507 | % (discriminator, base)) |
508 | enum_define = find_enum(discriminator_type) | |
dd883c6f | 509 | allow_metas=['struct'] |
5223070c WX |
510 | # Do not allow string discriminator |
511 | if not enum_define: | |
512 | raise QAPIExprError(expr_info, | |
513 | "Discriminator '%s' must be of enumeration " | |
514 | "type" % discriminator) | |
b86b05ed WX |
515 | |
516 | # Check every branch | |
517 | for (key, value) in members.items(): | |
c9e0a798 EB |
518 | check_name(expr_info, "Member of union '%s'" % name, key) |
519 | ||
dd883c6f | 520 | # Each value must name a known type; furthermore, in flat unions, |
ff55d72e | 521 | # branches must be a struct with no overlapping member names |
dd883c6f EB |
522 | check_type(expr_info, "Member '%s' of union '%s'" % (key, name), |
523 | value, allow_array=True, allow_metas=allow_metas) | |
ff55d72e EB |
524 | if base: |
525 | branch_struct = find_struct(value) | |
526 | assert branch_struct | |
527 | check_member_clash(expr_info, base, branch_struct['data'], | |
528 | " of branch '%s'" % key) | |
dd883c6f | 529 | |
44bd1276 | 530 | # If the discriminator names an enum type, then all members |
b86b05ed | 531 | # of 'data' must also be members of the enum type. |
44bd1276 EB |
532 | if enum_define: |
533 | if not key in enum_define['enum_values']: | |
534 | raise QAPIExprError(expr_info, | |
535 | "Discriminator value '%s' is not found in " | |
536 | "enum '%s'" % | |
537 | (key, enum_define["enum_name"])) | |
538 | ||
539 | # Otherwise, check for conflicts in the generated enum | |
540 | else: | |
fa6068a1 | 541 | c_key = camel_to_upper(key) |
44bd1276 EB |
542 | if c_key in values: |
543 | raise QAPIExprError(expr_info, | |
544 | "Union '%s' member '%s' clashes with '%s'" | |
545 | % (name, key, values[c_key])) | |
546 | values[c_key] = key | |
547 | ||
811d04fd | 548 | def check_alternate(expr, expr_info): |
ab916fad | 549 | name = expr['alternate'] |
811d04fd EB |
550 | members = expr['data'] |
551 | values = { 'MAX': '(automatic)' } | |
552 | types_seen = {} | |
553 | ||
811d04fd EB |
554 | # Check every branch |
555 | for (key, value) in members.items(): | |
c9e0a798 EB |
556 | check_name(expr_info, "Member of alternate '%s'" % name, key) |
557 | ||
811d04fd | 558 | # Check for conflicts in the generated enum |
fa6068a1 | 559 | c_key = camel_to_upper(key) |
811d04fd EB |
560 | if c_key in values: |
561 | raise QAPIExprError(expr_info, | |
ab916fad EB |
562 | "Alternate '%s' member '%s' clashes with '%s'" |
563 | % (name, key, values[c_key])) | |
811d04fd | 564 | values[c_key] = key |
44bd1276 | 565 | |
811d04fd | 566 | # Ensure alternates have no type conflicts. |
dd883c6f EB |
567 | check_type(expr_info, "Member '%s' of alternate '%s'" % (key, name), |
568 | value, | |
569 | allow_metas=['built-in', 'union', 'struct', 'enum']) | |
811d04fd | 570 | qtype = find_alternate_member_qtype(value) |
dd883c6f | 571 | assert qtype |
811d04fd EB |
572 | if qtype in types_seen: |
573 | raise QAPIExprError(expr_info, | |
ab916fad | 574 | "Alternate '%s' member '%s' can't " |
811d04fd EB |
575 | "be distinguished from member '%s'" |
576 | % (name, key, types_seen[qtype])) | |
577 | types_seen[qtype] = key | |
b86b05ed | 578 | |
cf393590 EB |
579 | def check_enum(expr, expr_info): |
580 | name = expr['enum'] | |
581 | members = expr.get('data') | |
582 | values = { 'MAX': '(automatic)' } | |
583 | ||
584 | if not isinstance(members, list): | |
585 | raise QAPIExprError(expr_info, | |
586 | "Enum '%s' requires an array for 'data'" % name) | |
587 | for member in members: | |
c9e0a798 EB |
588 | check_name(expr_info, "Member of enum '%s'" %name, member, |
589 | enum_member=True) | |
fa6068a1 | 590 | key = camel_to_upper(member) |
cf393590 EB |
591 | if key in values: |
592 | raise QAPIExprError(expr_info, | |
593 | "Enum '%s' member '%s' clashes with '%s'" | |
594 | % (name, member, values[key])) | |
595 | values[key] = member | |
596 | ||
dd883c6f | 597 | def check_struct(expr, expr_info): |
fd41dd4e | 598 | name = expr['struct'] |
dd883c6f EB |
599 | members = expr['data'] |
600 | ||
fd41dd4e | 601 | check_type(expr_info, "'data' for struct '%s'" % name, members, |
c9e0a798 | 602 | allow_dict=True, allow_optional=True) |
fd41dd4e | 603 | check_type(expr_info, "'base' for struct '%s'" % name, expr.get('base'), |
dd883c6f | 604 | allow_metas=['struct']) |
ff55d72e EB |
605 | if expr.get('base'): |
606 | check_member_clash(expr_info, expr['base'], expr['data']) | |
dd883c6f | 607 | |
b86b05ed WX |
608 | def check_exprs(schema): |
609 | for expr_elem in schema.exprs: | |
610 | expr = expr_elem['expr'] | |
cf393590 EB |
611 | info = expr_elem['info'] |
612 | ||
613 | if expr.has_key('enum'): | |
614 | check_enum(expr, info) | |
615 | elif expr.has_key('union'): | |
ab916fad EB |
616 | check_union(expr, info) |
617 | elif expr.has_key('alternate'): | |
618 | check_alternate(expr, info) | |
fd41dd4e | 619 | elif expr.has_key('struct'): |
dd883c6f EB |
620 | check_struct(expr, info) |
621 | elif expr.has_key('command'): | |
622 | check_command(expr, info) | |
cf393590 EB |
623 | elif expr.has_key('event'): |
624 | check_event(expr, info) | |
dd883c6f EB |
625 | else: |
626 | assert False, 'unexpected meta type' | |
b86b05ed | 627 | |
0545f6b8 EB |
628 | def check_keys(expr_elem, meta, required, optional=[]): |
629 | expr = expr_elem['expr'] | |
630 | info = expr_elem['info'] | |
631 | name = expr[meta] | |
632 | if not isinstance(name, str): | |
633 | raise QAPIExprError(info, | |
634 | "'%s' key must have a string value" % meta) | |
635 | required = required + [ meta ] | |
636 | for (key, value) in expr.items(): | |
637 | if not key in required and not key in optional: | |
638 | raise QAPIExprError(info, | |
639 | "Unknown key '%s' in %s '%s'" | |
640 | % (key, meta, name)) | |
2cbf0992 EB |
641 | if (key == 'gen' or key == 'success-response') and value != False: |
642 | raise QAPIExprError(info, | |
643 | "'%s' of %s '%s' should only use false value" | |
644 | % (key, meta, name)) | |
0545f6b8 EB |
645 | for key in required: |
646 | if not expr.has_key(key): | |
647 | raise QAPIExprError(info, | |
648 | "Key '%s' is missing from %s '%s'" | |
649 | % (key, meta, name)) | |
650 | ||
651 | ||
33aaad52 | 652 | def parse_schema(input_file): |
4dc2e690 EB |
653 | global all_names |
654 | exprs = [] | |
655 | ||
268a1c5e | 656 | # First pass: read entire file into memory |
2caba36c | 657 | try: |
33aaad52 | 658 | schema = QAPISchema(open(input_file, "r")) |
a719a27c | 659 | except (QAPISchemaError, QAPIExprError), e: |
2caba36c MA |
660 | print >>sys.stderr, e |
661 | exit(1) | |
662 | ||
b86b05ed | 663 | try: |
0545f6b8 EB |
664 | # Next pass: learn the types and check for valid expression keys. At |
665 | # this point, top-level 'include' has already been flattened. | |
4dc2e690 EB |
666 | for builtin in builtin_types.keys(): |
667 | all_names[builtin] = 'built-in' | |
268a1c5e EB |
668 | for expr_elem in schema.exprs: |
669 | expr = expr_elem['expr'] | |
4dc2e690 | 670 | info = expr_elem['info'] |
268a1c5e | 671 | if expr.has_key('enum'): |
0545f6b8 | 672 | check_keys(expr_elem, 'enum', ['data']) |
4dc2e690 | 673 | add_enum(expr['enum'], info, expr['data']) |
268a1c5e | 674 | elif expr.has_key('union'): |
0545f6b8 EB |
675 | check_keys(expr_elem, 'union', ['data'], |
676 | ['base', 'discriminator']) | |
4dc2e690 | 677 | add_union(expr, info) |
0545f6b8 EB |
678 | elif expr.has_key('alternate'): |
679 | check_keys(expr_elem, 'alternate', ['data']) | |
4dc2e690 | 680 | add_name(expr['alternate'], info, 'alternate') |
fd41dd4e EB |
681 | elif expr.has_key('struct'): |
682 | check_keys(expr_elem, 'struct', ['data'], ['base']) | |
4dc2e690 | 683 | add_struct(expr, info) |
0545f6b8 EB |
684 | elif expr.has_key('command'): |
685 | check_keys(expr_elem, 'command', [], | |
686 | ['data', 'returns', 'gen', 'success-response']) | |
4dc2e690 | 687 | add_name(expr['command'], info, 'command') |
0545f6b8 EB |
688 | elif expr.has_key('event'): |
689 | check_keys(expr_elem, 'event', [], ['data']) | |
4dc2e690 | 690 | add_name(expr['event'], info, 'event') |
0545f6b8 EB |
691 | else: |
692 | raise QAPIExprError(expr_elem['info'], | |
693 | "Expression is missing metatype") | |
268a1c5e EB |
694 | exprs.append(expr) |
695 | ||
696 | # Try again for hidden UnionKind enum | |
697 | for expr_elem in schema.exprs: | |
698 | expr = expr_elem['expr'] | |
699 | if expr.has_key('union'): | |
700 | if not discriminator_find_enum_define(expr): | |
4dc2e690 EB |
701 | add_enum('%sKind' % expr['union'], expr_elem['info'], |
702 | implicit=True) | |
ab916fad | 703 | elif expr.has_key('alternate'): |
4dc2e690 EB |
704 | add_enum('%sKind' % expr['alternate'], expr_elem['info'], |
705 | implicit=True) | |
268a1c5e EB |
706 | |
707 | # Final pass - validate that exprs make sense | |
b86b05ed WX |
708 | check_exprs(schema) |
709 | except QAPIExprError, e: | |
710 | print >>sys.stderr, e | |
711 | exit(1) | |
712 | ||
0f923be2 MR |
713 | return exprs |
714 | ||
715 | def parse_args(typeinfo): | |
fe2a9303 | 716 | if isinstance(typeinfo, str): |
b35284ea KW |
717 | struct = find_struct(typeinfo) |
718 | assert struct != None | |
719 | typeinfo = struct['data'] | |
720 | ||
0f923be2 MR |
721 | for member in typeinfo: |
722 | argname = member | |
723 | argentry = typeinfo[member] | |
724 | optional = False | |
0f923be2 MR |
725 | if member.startswith('*'): |
726 | argname = member[1:] | |
727 | optional = True | |
6b5abc7d EB |
728 | # Todo: allow argentry to be OrderedDict, for providing the |
729 | # value of an optional argument. | |
730 | yield (argname, argentry, optional) | |
0f923be2 | 731 | |
0f923be2 MR |
732 | def camel_case(name): |
733 | new_name = '' | |
734 | first = True | |
735 | for ch in name: | |
736 | if ch in ['_', '-']: | |
737 | first = True | |
738 | elif first: | |
739 | new_name += ch.upper() | |
740 | first = False | |
741 | else: | |
742 | new_name += ch.lower() | |
743 | return new_name | |
744 | ||
18df515e | 745 | c_name_trans = string.maketrans('.-', '__') |
47299262 | 746 | |
18df515e | 747 | def c_name(name, protect=True): |
427a1a2c BS |
748 | # ANSI X3J11/88-090, 3.1.1 |
749 | c89_words = set(['auto', 'break', 'case', 'char', 'const', 'continue', | |
750 | 'default', 'do', 'double', 'else', 'enum', 'extern', 'float', | |
751 | 'for', 'goto', 'if', 'int', 'long', 'register', 'return', | |
752 | 'short', 'signed', 'sizeof', 'static', 'struct', 'switch', | |
753 | 'typedef', 'union', 'unsigned', 'void', 'volatile', 'while']) | |
754 | # ISO/IEC 9899:1999, 6.4.1 | |
755 | c99_words = set(['inline', 'restrict', '_Bool', '_Complex', '_Imaginary']) | |
756 | # ISO/IEC 9899:2011, 6.4.1 | |
757 | c11_words = set(['_Alignas', '_Alignof', '_Atomic', '_Generic', '_Noreturn', | |
758 | '_Static_assert', '_Thread_local']) | |
759 | # GCC http://gcc.gnu.org/onlinedocs/gcc-4.7.1/gcc/C-Extensions.html | |
760 | # excluding _.* | |
761 | gcc_words = set(['asm', 'typeof']) | |
6f88009e TS |
762 | # C++ ISO/IEC 14882:2003 2.11 |
763 | cpp_words = set(['bool', 'catch', 'class', 'const_cast', 'delete', | |
764 | 'dynamic_cast', 'explicit', 'false', 'friend', 'mutable', | |
765 | 'namespace', 'new', 'operator', 'private', 'protected', | |
766 | 'public', 'reinterpret_cast', 'static_cast', 'template', | |
767 | 'this', 'throw', 'true', 'try', 'typeid', 'typename', | |
768 | 'using', 'virtual', 'wchar_t', | |
769 | # alternative representations | |
770 | 'and', 'and_eq', 'bitand', 'bitor', 'compl', 'not', | |
771 | 'not_eq', 'or', 'or_eq', 'xor', 'xor_eq']) | |
1057725f | 772 | # namespace pollution: |
8592a545 | 773 | polluted_words = set(['unix', 'errno']) |
6f88009e | 774 | if protect and (name in c89_words | c99_words | c11_words | gcc_words | cpp_words | polluted_words): |
427a1a2c | 775 | return "q_" + name |
18df515e | 776 | return name.translate(c_name_trans) |
0f923be2 MR |
777 | |
778 | def c_list_type(name): | |
779 | return '%sList' % name | |
780 | ||
781 | def type_name(name): | |
782 | if type(name) == list: | |
783 | return c_list_type(name[0]) | |
784 | return name | |
785 | ||
fd41dd4e | 786 | def add_name(name, info, meta, implicit = False): |
4dc2e690 | 787 | global all_names |
fd41dd4e | 788 | check_name(info, "'%s'" % meta, name) |
4dc2e690 EB |
789 | if name in all_names: |
790 | raise QAPIExprError(info, | |
791 | "%s '%s' is already defined" | |
792 | % (all_names[name], name)) | |
793 | if not implicit and name[-4:] == 'Kind': | |
794 | raise QAPIExprError(info, | |
795 | "%s '%s' should not end in 'Kind'" | |
796 | % (meta, name)) | |
797 | all_names[name] = meta | |
b35284ea | 798 | |
4dc2e690 | 799 | def add_struct(definition, info): |
b35284ea | 800 | global struct_types |
fd41dd4e EB |
801 | name = definition['struct'] |
802 | add_name(name, info, 'struct') | |
b35284ea KW |
803 | struct_types.append(definition) |
804 | ||
805 | def find_struct(name): | |
806 | global struct_types | |
807 | for struct in struct_types: | |
fd41dd4e | 808 | if struct['struct'] == name: |
b35284ea KW |
809 | return struct |
810 | return None | |
0f923be2 | 811 | |
4dc2e690 | 812 | def add_union(definition, info): |
ea66c6d8 | 813 | global union_types |
4dc2e690 EB |
814 | name = definition['union'] |
815 | add_name(name, info, 'union') | |
ab916fad | 816 | union_types.append(definition) |
ea66c6d8 KW |
817 | |
818 | def find_union(name): | |
819 | global union_types | |
820 | for union in union_types: | |
821 | if union['union'] == name: | |
822 | return union | |
823 | return None | |
824 | ||
4dc2e690 | 825 | def add_enum(name, info, enum_values = None, implicit = False): |
0f923be2 | 826 | global enum_types |
4dc2e690 | 827 | add_name(name, info, 'enum', implicit) |
dad1fcab | 828 | enum_types.append({"enum_name": name, "enum_values": enum_values}) |
0f923be2 | 829 | |
dad1fcab | 830 | def find_enum(name): |
0f923be2 | 831 | global enum_types |
dad1fcab WX |
832 | for enum in enum_types: |
833 | if enum['enum_name'] == name: | |
834 | return enum | |
835 | return None | |
836 | ||
837 | def is_enum(name): | |
838 | return find_enum(name) != None | |
0f923be2 | 839 | |
05dfb26c AK |
840 | eatspace = '\033EATSPACE.' |
841 | ||
842 | # A special suffix is added in c_type() for pointer types, and it's | |
843 | # stripped in mcgen(). So please notice this when you check the return | |
844 | # value of c_type() outside mcgen(). | |
0d14eeb2 | 845 | def c_type(name, is_param=False): |
0f923be2 | 846 | if name == 'str': |
0d14eeb2 | 847 | if is_param: |
05dfb26c AK |
848 | return 'const char *' + eatspace |
849 | return 'char *' + eatspace | |
850 | ||
0f923be2 MR |
851 | elif name == 'int': |
852 | return 'int64_t' | |
c46f18ce LE |
853 | elif (name == 'int8' or name == 'int16' or name == 'int32' or |
854 | name == 'int64' or name == 'uint8' or name == 'uint16' or | |
855 | name == 'uint32' or name == 'uint64'): | |
856 | return name + '_t' | |
092705d4 LE |
857 | elif name == 'size': |
858 | return 'uint64_t' | |
0f923be2 MR |
859 | elif name == 'bool': |
860 | return 'bool' | |
861 | elif name == 'number': | |
862 | return 'double' | |
863 | elif type(name) == list: | |
05dfb26c | 864 | return '%s *%s' % (c_list_type(name[0]), eatspace) |
0f923be2 MR |
865 | elif is_enum(name): |
866 | return name | |
867 | elif name == None or len(name) == 0: | |
868 | return 'void' | |
4dc2e690 | 869 | elif name in events: |
05dfb26c | 870 | return '%sEvent *%s' % (camel_case(name), eatspace) |
0f923be2 | 871 | else: |
05dfb26c AK |
872 | return '%s *%s' % (name, eatspace) |
873 | ||
874 | def is_c_ptr(name): | |
875 | suffix = "*" + eatspace | |
876 | return c_type(name).endswith(suffix) | |
0f923be2 MR |
877 | |
878 | def genindent(count): | |
879 | ret = "" | |
880 | for i in range(count): | |
881 | ret += " " | |
882 | return ret | |
883 | ||
884 | indent_level = 0 | |
885 | ||
886 | def push_indent(indent_amount=4): | |
887 | global indent_level | |
888 | indent_level += indent_amount | |
889 | ||
890 | def pop_indent(indent_amount=4): | |
891 | global indent_level | |
892 | indent_level -= indent_amount | |
893 | ||
894 | def cgen(code, **kwds): | |
895 | indent = genindent(indent_level) | |
896 | lines = code.split('\n') | |
897 | lines = map(lambda x: indent + x, lines) | |
898 | return '\n'.join(lines) % kwds + '\n' | |
899 | ||
900 | def mcgen(code, **kwds): | |
05dfb26c AK |
901 | raw = cgen('\n'.join(code.split('\n')[1:-1]), **kwds) |
902 | return re.sub(re.escape(eatspace) + ' *', '', raw) | |
0f923be2 MR |
903 | |
904 | def basename(filename): | |
905 | return filename.split("/")[-1] | |
906 | ||
907 | def guardname(filename): | |
d8e1f214 MR |
908 | guard = basename(filename).rsplit(".", 1)[0] |
909 | for substr in [".", " ", "-"]: | |
910 | guard = guard.replace(substr, "_") | |
911 | return guard.upper() + '_H' | |
c0afa9c5 MR |
912 | |
913 | def guardstart(name): | |
914 | return mcgen(''' | |
915 | ||
916 | #ifndef %(name)s | |
917 | #define %(name)s | |
918 | ||
919 | ''', | |
920 | name=guardname(name)) | |
921 | ||
922 | def guardend(name): | |
923 | return mcgen(''' | |
924 | ||
925 | #endif /* %(name)s */ | |
926 | ||
927 | ''', | |
928 | name=guardname(name)) | |
6299659f | 929 | |
5d371f41 WX |
930 | # ENUMName -> ENUM_NAME, EnumName1 -> ENUM_NAME1 |
931 | # ENUM_NAME -> ENUM_NAME, ENUM_NAME1 -> ENUM_NAME1, ENUM_Name2 -> ENUM_NAME2 | |
932 | # ENUM24_Name -> ENUM24_NAME | |
fa6068a1 | 933 | def camel_to_upper(value): |
18df515e | 934 | c_fun_str = c_name(value, False) |
b0b58195 | 935 | if value.isupper(): |
5d371f41 WX |
936 | return c_fun_str |
937 | ||
6299659f | 938 | new_name = '' |
5d371f41 WX |
939 | l = len(c_fun_str) |
940 | for i in range(l): | |
941 | c = c_fun_str[i] | |
942 | # When c is upper and no "_" appears before, do more checks | |
943 | if c.isupper() and (i > 0) and c_fun_str[i - 1] != "_": | |
944 | # Case 1: next string is lower | |
945 | # Case 2: previous string is digit | |
946 | if (i < (l - 1) and c_fun_str[i + 1].islower()) or \ | |
947 | c_fun_str[i - 1].isdigit(): | |
948 | new_name += '_' | |
6299659f WX |
949 | new_name += c |
950 | return new_name.lstrip('_').upper() | |
b0b58195 | 951 | |
7c81c61f | 952 | def c_enum_const(type_name, const_name): |
02e20c7e | 953 | return camel_to_upper(type_name + '_' + const_name) |