]>
Commit | Line | Data |
---|---|---|
0f923be2 MR |
1 | # |
2 | # QAPI helper library | |
3 | # | |
4 | # Copyright IBM, Corp. 2011 | |
c7a3f252 | 5 | # Copyright (c) 2013 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 MR |
13 | |
14 | from ordereddict import OrderedDict | |
33aaad52 | 15 | import os |
2caba36c | 16 | import sys |
0f923be2 | 17 | |
c0afa9c5 MR |
18 | builtin_types = [ |
19 | 'str', 'int', 'number', 'bool', | |
20 | 'int8', 'int16', 'int32', 'int64', | |
21 | 'uint8', 'uint16', 'uint32', 'uint64' | |
22 | ] | |
23 | ||
69dd62df KW |
24 | builtin_type_qtypes = { |
25 | 'str': 'QTYPE_QSTRING', | |
26 | 'int': 'QTYPE_QINT', | |
27 | 'number': 'QTYPE_QFLOAT', | |
28 | 'bool': 'QTYPE_QBOOL', | |
29 | 'int8': 'QTYPE_QINT', | |
30 | 'int16': 'QTYPE_QINT', | |
31 | 'int32': 'QTYPE_QINT', | |
32 | 'int64': 'QTYPE_QINT', | |
33 | 'uint8': 'QTYPE_QINT', | |
34 | 'uint16': 'QTYPE_QINT', | |
35 | 'uint32': 'QTYPE_QINT', | |
36 | 'uint64': 'QTYPE_QINT', | |
37 | } | |
38 | ||
2caba36c MA |
39 | class QAPISchemaError(Exception): |
40 | def __init__(self, schema, msg): | |
41 | self.fp = schema.fp | |
42 | self.msg = msg | |
515b943a WX |
43 | self.col = 1 |
44 | self.line = schema.line | |
45 | for ch in schema.src[schema.line_pos:schema.pos]: | |
46 | if ch == '\t': | |
2caba36c MA |
47 | self.col = (self.col + 7) % 8 + 1 |
48 | else: | |
49 | self.col += 1 | |
50 | ||
51 | def __str__(self): | |
52 | return "%s:%s:%s: %s" % (self.fp.name, self.line, self.col, self.msg) | |
53 | ||
b86b05ed WX |
54 | class QAPIExprError(Exception): |
55 | def __init__(self, expr_info, msg): | |
56 | self.fp = expr_info['fp'] | |
57 | self.line = expr_info['line'] | |
58 | self.msg = msg | |
59 | ||
60 | def __str__(self): | |
61 | return "%s:%s: %s" % (self.fp.name, self.line, self.msg) | |
62 | ||
c7a3f252 MA |
63 | class QAPISchema: |
64 | ||
65 | def __init__(self, fp): | |
66 | self.fp = fp | |
67 | self.src = fp.read() | |
68 | if self.src == '' or self.src[-1] != '\n': | |
69 | self.src += '\n' | |
70 | self.cursor = 0 | |
515b943a WX |
71 | self.line = 1 |
72 | self.line_pos = 0 | |
c7a3f252 MA |
73 | self.exprs = [] |
74 | self.accept() | |
75 | ||
76 | while self.tok != None: | |
b86b05ed WX |
77 | expr_info = {'fp': fp, 'line': self.line} |
78 | expr_elem = {'expr': self.get_expr(False), | |
79 | 'info': expr_info} | |
80 | self.exprs.append(expr_elem) | |
c7a3f252 MA |
81 | |
82 | def accept(self): | |
83 | while True: | |
c7a3f252 | 84 | self.tok = self.src[self.cursor] |
2caba36c | 85 | self.pos = self.cursor |
c7a3f252 MA |
86 | self.cursor += 1 |
87 | self.val = None | |
88 | ||
f1a145e1 | 89 | if self.tok == '#': |
c7a3f252 MA |
90 | self.cursor = self.src.find('\n', self.cursor) |
91 | elif self.tok in ['{', '}', ':', ',', '[', ']']: | |
92 | return | |
93 | elif self.tok == "'": | |
94 | string = '' | |
95 | esc = False | |
96 | while True: | |
97 | ch = self.src[self.cursor] | |
98 | self.cursor += 1 | |
99 | if ch == '\n': | |
2caba36c MA |
100 | raise QAPISchemaError(self, |
101 | 'Missing terminating "\'"') | |
c7a3f252 MA |
102 | if esc: |
103 | string += ch | |
104 | esc = False | |
105 | elif ch == "\\": | |
106 | esc = True | |
107 | elif ch == "'": | |
108 | self.val = string | |
109 | return | |
110 | else: | |
111 | string += ch | |
112 | elif self.tok == '\n': | |
113 | if self.cursor == len(self.src): | |
114 | self.tok = None | |
115 | return | |
515b943a WX |
116 | self.line += 1 |
117 | self.line_pos = self.cursor | |
9213aa53 MA |
118 | elif not self.tok.isspace(): |
119 | raise QAPISchemaError(self, 'Stray "%s"' % self.tok) | |
c7a3f252 MA |
120 | |
121 | def get_members(self): | |
122 | expr = OrderedDict() | |
6974ccd5 MA |
123 | if self.tok == '}': |
124 | self.accept() | |
125 | return expr | |
126 | if self.tok != "'": | |
127 | raise QAPISchemaError(self, 'Expected string or "}"') | |
128 | while True: | |
c7a3f252 MA |
129 | key = self.val |
130 | self.accept() | |
6974ccd5 MA |
131 | if self.tok != ':': |
132 | raise QAPISchemaError(self, 'Expected ":"') | |
133 | self.accept() | |
4b35991a WX |
134 | if key in expr: |
135 | raise QAPISchemaError(self, 'Duplicate key "%s"' % key) | |
5f3cd2b7 | 136 | expr[key] = self.get_expr(True) |
6974ccd5 | 137 | if self.tok == '}': |
c7a3f252 | 138 | self.accept() |
6974ccd5 MA |
139 | return expr |
140 | if self.tok != ',': | |
141 | raise QAPISchemaError(self, 'Expected "," or "}"') | |
142 | self.accept() | |
143 | if self.tok != "'": | |
144 | raise QAPISchemaError(self, 'Expected string') | |
c7a3f252 MA |
145 | |
146 | def get_values(self): | |
147 | expr = [] | |
6974ccd5 MA |
148 | if self.tok == ']': |
149 | self.accept() | |
150 | return expr | |
151 | if not self.tok in [ '{', '[', "'" ]: | |
152 | raise QAPISchemaError(self, 'Expected "{", "[", "]" or string') | |
153 | while True: | |
5f3cd2b7 | 154 | expr.append(self.get_expr(True)) |
6974ccd5 | 155 | if self.tok == ']': |
c7a3f252 | 156 | self.accept() |
6974ccd5 MA |
157 | return expr |
158 | if self.tok != ',': | |
159 | raise QAPISchemaError(self, 'Expected "," or "]"') | |
160 | self.accept() | |
c7a3f252 | 161 | |
5f3cd2b7 MA |
162 | def get_expr(self, nested): |
163 | if self.tok != '{' and not nested: | |
164 | raise QAPISchemaError(self, 'Expected "{"') | |
c7a3f252 MA |
165 | if self.tok == '{': |
166 | self.accept() | |
167 | expr = self.get_members() | |
168 | elif self.tok == '[': | |
169 | self.accept() | |
170 | expr = self.get_values() | |
6974ccd5 | 171 | elif self.tok == "'": |
c7a3f252 MA |
172 | expr = self.val |
173 | self.accept() | |
6974ccd5 MA |
174 | else: |
175 | raise QAPISchemaError(self, 'Expected "{", "[" or string') | |
c7a3f252 | 176 | return expr |
bd9927fe | 177 | |
b86b05ed WX |
178 | def find_base_fields(base): |
179 | base_struct_define = find_struct(base) | |
180 | if not base_struct_define: | |
181 | return None | |
182 | return base_struct_define['data'] | |
183 | ||
bceae769 WX |
184 | # Return the discriminator enum define if discriminator is specified as an |
185 | # enum type, otherwise return None. | |
186 | def discriminator_find_enum_define(expr): | |
187 | base = expr.get('base') | |
188 | discriminator = expr.get('discriminator') | |
189 | ||
190 | if not (discriminator and base): | |
191 | return None | |
192 | ||
193 | base_fields = find_base_fields(base) | |
194 | if not base_fields: | |
195 | return None | |
196 | ||
197 | discriminator_type = base_fields.get(discriminator) | |
198 | if not discriminator_type: | |
199 | return None | |
200 | ||
201 | return find_enum(discriminator_type) | |
202 | ||
b86b05ed WX |
203 | def check_union(expr, expr_info): |
204 | name = expr['union'] | |
205 | base = expr.get('base') | |
206 | discriminator = expr.get('discriminator') | |
207 | members = expr['data'] | |
208 | ||
209 | # If the object has a member 'base', its value must name a complex type. | |
210 | if base: | |
211 | base_fields = find_base_fields(base) | |
212 | if not base_fields: | |
213 | raise QAPIExprError(expr_info, | |
214 | "Base '%s' is not a valid type" | |
215 | % base) | |
216 | ||
217 | # If the union object has no member 'discriminator', it's an | |
218 | # ordinary union. | |
219 | if not discriminator: | |
220 | enum_define = None | |
221 | ||
222 | # Else if the value of member 'discriminator' is {}, it's an | |
223 | # anonymous union. | |
224 | elif discriminator == {}: | |
225 | enum_define = None | |
226 | ||
227 | # Else, it's a flat union. | |
228 | else: | |
229 | # The object must have a member 'base'. | |
230 | if not base: | |
231 | raise QAPIExprError(expr_info, | |
232 | "Flat union '%s' must have a base field" | |
233 | % name) | |
234 | # The value of member 'discriminator' must name a member of the | |
235 | # base type. | |
236 | discriminator_type = base_fields.get(discriminator) | |
237 | if not discriminator_type: | |
238 | raise QAPIExprError(expr_info, | |
239 | "Discriminator '%s' is not a member of base " | |
240 | "type '%s'" | |
241 | % (discriminator, base)) | |
242 | enum_define = find_enum(discriminator_type) | |
5223070c WX |
243 | # Do not allow string discriminator |
244 | if not enum_define: | |
245 | raise QAPIExprError(expr_info, | |
246 | "Discriminator '%s' must be of enumeration " | |
247 | "type" % discriminator) | |
b86b05ed WX |
248 | |
249 | # Check every branch | |
250 | for (key, value) in members.items(): | |
251 | # If this named member's value names an enum type, then all members | |
252 | # of 'data' must also be members of the enum type. | |
253 | if enum_define and not key in enum_define['enum_values']: | |
254 | raise QAPIExprError(expr_info, | |
255 | "Discriminator value '%s' is not found in " | |
256 | "enum '%s'" % | |
257 | (key, enum_define["enum_name"])) | |
258 | # Todo: add checking for values. Key is checked as above, value can be | |
259 | # also checked here, but we need more functions to handle array case. | |
260 | ||
261 | def check_exprs(schema): | |
262 | for expr_elem in schema.exprs: | |
263 | expr = expr_elem['expr'] | |
264 | if expr.has_key('union'): | |
265 | check_union(expr, expr_elem['info']) | |
266 | ||
33aaad52 | 267 | def parse_schema(input_file): |
2caba36c | 268 | try: |
33aaad52 | 269 | schema = QAPISchema(open(input_file, "r")) |
21e0043b | 270 | except QAPISchemaError, e: |
2caba36c MA |
271 | print >>sys.stderr, e |
272 | exit(1) | |
273 | ||
bd9927fe KW |
274 | exprs = [] |
275 | ||
b86b05ed WX |
276 | for expr_elem in schema.exprs: |
277 | expr = expr_elem['expr'] | |
28b8bd4c | 278 | if expr.has_key('enum'): |
dad1fcab | 279 | add_enum(expr['enum'], expr['data']) |
28b8bd4c MA |
280 | elif expr.has_key('union'): |
281 | add_union(expr) | |
28b8bd4c MA |
282 | elif expr.has_key('type'): |
283 | add_struct(expr) | |
284 | exprs.append(expr) | |
0f923be2 | 285 | |
bceae769 WX |
286 | # Try again for hidden UnionKind enum |
287 | for expr_elem in schema.exprs: | |
288 | expr = expr_elem['expr'] | |
289 | if expr.has_key('union'): | |
290 | if not discriminator_find_enum_define(expr): | |
291 | add_enum('%sKind' % expr['union']) | |
292 | ||
b86b05ed WX |
293 | try: |
294 | check_exprs(schema) | |
295 | except QAPIExprError, e: | |
296 | print >>sys.stderr, e | |
297 | exit(1) | |
298 | ||
0f923be2 MR |
299 | return exprs |
300 | ||
301 | def parse_args(typeinfo): | |
b35284ea KW |
302 | if isinstance(typeinfo, basestring): |
303 | struct = find_struct(typeinfo) | |
304 | assert struct != None | |
305 | typeinfo = struct['data'] | |
306 | ||
0f923be2 MR |
307 | for member in typeinfo: |
308 | argname = member | |
309 | argentry = typeinfo[member] | |
310 | optional = False | |
311 | structured = False | |
312 | if member.startswith('*'): | |
313 | argname = member[1:] | |
314 | optional = True | |
315 | if isinstance(argentry, OrderedDict): | |
316 | structured = True | |
317 | yield (argname, argentry, optional, structured) | |
318 | ||
319 | def de_camel_case(name): | |
320 | new_name = '' | |
321 | for ch in name: | |
322 | if ch.isupper() and new_name: | |
323 | new_name += '_' | |
324 | if ch == '-': | |
325 | new_name += '_' | |
326 | else: | |
327 | new_name += ch.lower() | |
328 | return new_name | |
329 | ||
330 | def camel_case(name): | |
331 | new_name = '' | |
332 | first = True | |
333 | for ch in name: | |
334 | if ch in ['_', '-']: | |
335 | first = True | |
336 | elif first: | |
337 | new_name += ch.upper() | |
338 | first = False | |
339 | else: | |
340 | new_name += ch.lower() | |
341 | return new_name | |
342 | ||
eda50a65 | 343 | def c_var(name, protect=True): |
427a1a2c BS |
344 | # ANSI X3J11/88-090, 3.1.1 |
345 | c89_words = set(['auto', 'break', 'case', 'char', 'const', 'continue', | |
346 | 'default', 'do', 'double', 'else', 'enum', 'extern', 'float', | |
347 | 'for', 'goto', 'if', 'int', 'long', 'register', 'return', | |
348 | 'short', 'signed', 'sizeof', 'static', 'struct', 'switch', | |
349 | 'typedef', 'union', 'unsigned', 'void', 'volatile', 'while']) | |
350 | # ISO/IEC 9899:1999, 6.4.1 | |
351 | c99_words = set(['inline', 'restrict', '_Bool', '_Complex', '_Imaginary']) | |
352 | # ISO/IEC 9899:2011, 6.4.1 | |
353 | c11_words = set(['_Alignas', '_Alignof', '_Atomic', '_Generic', '_Noreturn', | |
354 | '_Static_assert', '_Thread_local']) | |
355 | # GCC http://gcc.gnu.org/onlinedocs/gcc-4.7.1/gcc/C-Extensions.html | |
356 | # excluding _.* | |
357 | gcc_words = set(['asm', 'typeof']) | |
6f88009e TS |
358 | # C++ ISO/IEC 14882:2003 2.11 |
359 | cpp_words = set(['bool', 'catch', 'class', 'const_cast', 'delete', | |
360 | 'dynamic_cast', 'explicit', 'false', 'friend', 'mutable', | |
361 | 'namespace', 'new', 'operator', 'private', 'protected', | |
362 | 'public', 'reinterpret_cast', 'static_cast', 'template', | |
363 | 'this', 'throw', 'true', 'try', 'typeid', 'typename', | |
364 | 'using', 'virtual', 'wchar_t', | |
365 | # alternative representations | |
366 | 'and', 'and_eq', 'bitand', 'bitor', 'compl', 'not', | |
367 | 'not_eq', 'or', 'or_eq', 'xor', 'xor_eq']) | |
1057725f | 368 | # namespace pollution: |
8592a545 | 369 | polluted_words = set(['unix', 'errno']) |
6f88009e | 370 | if protect and (name in c89_words | c99_words | c11_words | gcc_words | cpp_words | polluted_words): |
427a1a2c | 371 | return "q_" + name |
c9da228b FS |
372 | return name.replace('-', '_').lstrip("*") |
373 | ||
eda50a65 PB |
374 | def c_fun(name, protect=True): |
375 | return c_var(name, protect).replace('.', '_') | |
0f923be2 MR |
376 | |
377 | def c_list_type(name): | |
378 | return '%sList' % name | |
379 | ||
380 | def type_name(name): | |
381 | if type(name) == list: | |
382 | return c_list_type(name[0]) | |
383 | return name | |
384 | ||
385 | enum_types = [] | |
b35284ea | 386 | struct_types = [] |
ea66c6d8 | 387 | union_types = [] |
b35284ea KW |
388 | |
389 | def add_struct(definition): | |
390 | global struct_types | |
391 | struct_types.append(definition) | |
392 | ||
393 | def find_struct(name): | |
394 | global struct_types | |
395 | for struct in struct_types: | |
396 | if struct['type'] == name: | |
397 | return struct | |
398 | return None | |
0f923be2 | 399 | |
ea66c6d8 KW |
400 | def add_union(definition): |
401 | global union_types | |
402 | union_types.append(definition) | |
403 | ||
404 | def find_union(name): | |
405 | global union_types | |
406 | for union in union_types: | |
407 | if union['union'] == name: | |
408 | return union | |
409 | return None | |
410 | ||
dad1fcab | 411 | def add_enum(name, enum_values = None): |
0f923be2 | 412 | global enum_types |
dad1fcab | 413 | enum_types.append({"enum_name": name, "enum_values": enum_values}) |
0f923be2 | 414 | |
dad1fcab | 415 | def find_enum(name): |
0f923be2 | 416 | global enum_types |
dad1fcab WX |
417 | for enum in enum_types: |
418 | if enum['enum_name'] == name: | |
419 | return enum | |
420 | return None | |
421 | ||
422 | def is_enum(name): | |
423 | return find_enum(name) != None | |
0f923be2 MR |
424 | |
425 | def c_type(name): | |
426 | if name == 'str': | |
427 | return 'char *' | |
428 | elif name == 'int': | |
429 | return 'int64_t' | |
c46f18ce LE |
430 | elif (name == 'int8' or name == 'int16' or name == 'int32' or |
431 | name == 'int64' or name == 'uint8' or name == 'uint16' or | |
432 | name == 'uint32' or name == 'uint64'): | |
433 | return name + '_t' | |
092705d4 LE |
434 | elif name == 'size': |
435 | return 'uint64_t' | |
0f923be2 MR |
436 | elif name == 'bool': |
437 | return 'bool' | |
438 | elif name == 'number': | |
439 | return 'double' | |
440 | elif type(name) == list: | |
441 | return '%s *' % c_list_type(name[0]) | |
442 | elif is_enum(name): | |
443 | return name | |
444 | elif name == None or len(name) == 0: | |
445 | return 'void' | |
446 | elif name == name.upper(): | |
447 | return '%sEvent *' % camel_case(name) | |
448 | else: | |
449 | return '%s *' % name | |
450 | ||
451 | def genindent(count): | |
452 | ret = "" | |
453 | for i in range(count): | |
454 | ret += " " | |
455 | return ret | |
456 | ||
457 | indent_level = 0 | |
458 | ||
459 | def push_indent(indent_amount=4): | |
460 | global indent_level | |
461 | indent_level += indent_amount | |
462 | ||
463 | def pop_indent(indent_amount=4): | |
464 | global indent_level | |
465 | indent_level -= indent_amount | |
466 | ||
467 | def cgen(code, **kwds): | |
468 | indent = genindent(indent_level) | |
469 | lines = code.split('\n') | |
470 | lines = map(lambda x: indent + x, lines) | |
471 | return '\n'.join(lines) % kwds + '\n' | |
472 | ||
473 | def mcgen(code, **kwds): | |
474 | return cgen('\n'.join(code.split('\n')[1:-1]), **kwds) | |
475 | ||
476 | def basename(filename): | |
477 | return filename.split("/")[-1] | |
478 | ||
479 | def guardname(filename): | |
d8e1f214 MR |
480 | guard = basename(filename).rsplit(".", 1)[0] |
481 | for substr in [".", " ", "-"]: | |
482 | guard = guard.replace(substr, "_") | |
483 | return guard.upper() + '_H' | |
c0afa9c5 MR |
484 | |
485 | def guardstart(name): | |
486 | return mcgen(''' | |
487 | ||
488 | #ifndef %(name)s | |
489 | #define %(name)s | |
490 | ||
491 | ''', | |
492 | name=guardname(name)) | |
493 | ||
494 | def guardend(name): | |
495 | return mcgen(''' | |
496 | ||
497 | #endif /* %(name)s */ | |
498 | ||
499 | ''', | |
500 | name=guardname(name)) | |
6299659f | 501 | |
5d371f41 WX |
502 | # ENUMName -> ENUM_NAME, EnumName1 -> ENUM_NAME1 |
503 | # ENUM_NAME -> ENUM_NAME, ENUM_NAME1 -> ENUM_NAME1, ENUM_Name2 -> ENUM_NAME2 | |
504 | # ENUM24_Name -> ENUM24_NAME | |
505 | def _generate_enum_string(value): | |
506 | c_fun_str = c_fun(value, False) | |
b0b58195 | 507 | if value.isupper(): |
5d371f41 WX |
508 | return c_fun_str |
509 | ||
6299659f | 510 | new_name = '' |
5d371f41 WX |
511 | l = len(c_fun_str) |
512 | for i in range(l): | |
513 | c = c_fun_str[i] | |
514 | # When c is upper and no "_" appears before, do more checks | |
515 | if c.isupper() and (i > 0) and c_fun_str[i - 1] != "_": | |
516 | # Case 1: next string is lower | |
517 | # Case 2: previous string is digit | |
518 | if (i < (l - 1) and c_fun_str[i + 1].islower()) or \ | |
519 | c_fun_str[i - 1].isdigit(): | |
520 | new_name += '_' | |
6299659f WX |
521 | new_name += c |
522 | return new_name.lstrip('_').upper() | |
b0b58195 WX |
523 | |
524 | def generate_enum_full_value(enum_name, enum_value): | |
5d371f41 WX |
525 | abbrev_string = _generate_enum_string(enum_name) |
526 | value_string = _generate_enum_string(enum_value) | |
b0b58195 | 527 | return "%s_%s" % (abbrev_string, value_string) |