blob: 5bc32e311d844d8f5e1af4bba039dbec76ffa937 [file] [log] [blame]
Michael Roth0f923be2011-07-19 14:50:39 -05001#
2# QAPI helper library
3#
4# Copyright IBM, Corp. 2011
Eric Blakefe2a9302015-05-04 09:05:02 -06005# Copyright (c) 2013-2015 Red Hat Inc.
Michael Roth0f923be2011-07-19 14:50:39 -05006#
7# Authors:
8# Anthony Liguori <aliguori@us.ibm.com>
Markus Armbrusterc7a3f252013-07-27 17:41:55 +02009# Markus Armbruster <armbru@redhat.com>
Michael Roth0f923be2011-07-19 14:50:39 -050010#
Markus Armbruster678e48a2014-03-01 08:40:34 +010011# This work is licensed under the terms of the GNU GPL, version 2.
12# See the COPYING file in the top-level directory.
Michael Roth0f923be2011-07-19 14:50:39 -050013
Lluís Vilanovaa719a272014-05-07 20:46:15 +020014import re
Michael Roth0f923be2011-07-19 14:50:39 -050015from ordereddict import OrderedDict
Lluís Vilanova33aaad52014-05-02 15:52:35 +020016import os
Markus Armbruster2caba362013-07-27 17:41:56 +020017import sys
Michael Roth0f923be2011-07-19 14:50:39 -050018
Eric Blakeb52c4b92015-05-04 09:05:00 -060019builtin_types = {
Kevin Wolf69dd62d2013-07-08 16:14:21 +020020 'str': 'QTYPE_QSTRING',
21 'int': 'QTYPE_QINT',
22 'number': 'QTYPE_QFLOAT',
23 'bool': 'QTYPE_QBOOL',
24 'int8': 'QTYPE_QINT',
25 'int16': 'QTYPE_QINT',
26 'int32': 'QTYPE_QINT',
27 'int64': 'QTYPE_QINT',
28 'uint8': 'QTYPE_QINT',
29 'uint16': 'QTYPE_QINT',
30 'uint32': 'QTYPE_QINT',
31 'uint64': 'QTYPE_QINT',
Eric Blakecb17f792015-05-04 09:05:01 -060032 'size': 'QTYPE_QINT',
Kevin Wolf69dd62d2013-07-08 16:14:21 +020033}
34
Eric Blake4dc2e692015-05-04 09:05:17 -060035enum_types = []
36struct_types = []
37union_types = []
38events = []
39all_names = {}
40
Lluís Vilanovaa719a272014-05-07 20:46:15 +020041def error_path(parent):
42 res = ""
43 while parent:
44 res = ("In file included from %s:%d:\n" % (parent['file'],
45 parent['line'])) + res
46 parent = parent['parent']
47 return res
48
Markus Armbruster2caba362013-07-27 17:41:56 +020049class QAPISchemaError(Exception):
50 def __init__(self, schema, msg):
Lluís Vilanovaa719a272014-05-07 20:46:15 +020051 self.input_file = schema.input_file
Markus Armbruster2caba362013-07-27 17:41:56 +020052 self.msg = msg
Wenchao Xia515b9432014-03-04 18:44:33 -080053 self.col = 1
54 self.line = schema.line
55 for ch in schema.src[schema.line_pos:schema.pos]:
56 if ch == '\t':
Markus Armbruster2caba362013-07-27 17:41:56 +020057 self.col = (self.col + 7) % 8 + 1
58 else:
59 self.col += 1
Lluís Vilanovaa719a272014-05-07 20:46:15 +020060 self.info = schema.parent_info
Markus Armbruster2caba362013-07-27 17:41:56 +020061
62 def __str__(self):
Lluís Vilanovaa719a272014-05-07 20:46:15 +020063 return error_path(self.info) + \
64 "%s:%d:%d: %s" % (self.input_file, self.line, self.col, self.msg)
Markus Armbruster2caba362013-07-27 17:41:56 +020065
Wenchao Xiab86b05e2014-03-04 18:44:34 -080066class QAPIExprError(Exception):
67 def __init__(self, expr_info, msg):
Lluís Vilanovaa719a272014-05-07 20:46:15 +020068 self.info = expr_info
Wenchao Xiab86b05e2014-03-04 18:44:34 -080069 self.msg = msg
70
71 def __str__(self):
Lluís Vilanovaa719a272014-05-07 20:46:15 +020072 return error_path(self.info['parent']) + \
73 "%s:%d: %s" % (self.info['file'], self.info['line'], self.msg)
Wenchao Xiab86b05e2014-03-04 18:44:34 -080074
Markus Armbrusterc7a3f252013-07-27 17:41:55 +020075class QAPISchema:
Michael Roth0f923be2011-07-19 14:50:39 -050076
Benoît Canet24fd8482014-05-16 12:51:56 +020077 def __init__(self, fp, input_relname=None, include_hist=[],
78 previously_included=[], parent_info=None):
79 """ include_hist is a stack used to detect inclusion cycles
80 previously_included is a global state used to avoid multiple
81 inclusions of the same file"""
Lluís Vilanovaa719a272014-05-07 20:46:15 +020082 input_fname = os.path.abspath(fp.name)
83 if input_relname is None:
84 input_relname = fp.name
85 self.input_dir = os.path.dirname(input_fname)
86 self.input_file = input_relname
87 self.include_hist = include_hist + [(input_relname, input_fname)]
Benoît Canet24fd8482014-05-16 12:51:56 +020088 previously_included.append(input_fname)
Lluís Vilanovaa719a272014-05-07 20:46:15 +020089 self.parent_info = parent_info
Markus Armbrusterc7a3f252013-07-27 17:41:55 +020090 self.src = fp.read()
91 if self.src == '' or self.src[-1] != '\n':
92 self.src += '\n'
93 self.cursor = 0
Wenchao Xia515b9432014-03-04 18:44:33 -080094 self.line = 1
95 self.line_pos = 0
Markus Armbrusterc7a3f252013-07-27 17:41:55 +020096 self.exprs = []
97 self.accept()
Michael Roth0f923be2011-07-19 14:50:39 -050098
Markus Armbrusterc7a3f252013-07-27 17:41:55 +020099 while self.tok != None:
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200100 expr_info = {'file': input_relname, 'line': self.line, 'parent': self.parent_info}
101 expr = self.get_expr(False)
102 if isinstance(expr, dict) and "include" in expr:
103 if len(expr) != 1:
104 raise QAPIExprError(expr_info, "Invalid 'include' directive")
105 include = expr["include"]
106 if not isinstance(include, str):
107 raise QAPIExprError(expr_info,
108 'Expected a file name (string), got: %s'
109 % include)
110 include_path = os.path.join(self.input_dir, include)
Stefan Hajnoczi7ac9a9d2014-08-27 12:08:51 +0100111 for elem in self.include_hist:
112 if include_path == elem[1]:
113 raise QAPIExprError(expr_info, "Inclusion loop for %s"
114 % include)
Benoît Canet24fd8482014-05-16 12:51:56 +0200115 # skip multiple include of the same file
116 if include_path in previously_included:
117 continue
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200118 try:
119 fobj = open(include_path, 'r')
Luiz Capitulino34788812014-05-20 13:50:19 -0400120 except IOError, e:
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200121 raise QAPIExprError(expr_info,
122 '%s: %s' % (e.strerror, include))
Benoît Canet24fd8482014-05-16 12:51:56 +0200123 exprs_include = QAPISchema(fobj, include, self.include_hist,
124 previously_included, expr_info)
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200125 self.exprs.extend(exprs_include.exprs)
126 else:
127 expr_elem = {'expr': expr,
128 'info': expr_info}
129 self.exprs.append(expr_elem)
Michael Roth0f923be2011-07-19 14:50:39 -0500130
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200131 def accept(self):
132 while True:
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200133 self.tok = self.src[self.cursor]
Markus Armbruster2caba362013-07-27 17:41:56 +0200134 self.pos = self.cursor
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200135 self.cursor += 1
136 self.val = None
Michael Roth0f923be2011-07-19 14:50:39 -0500137
Markus Armbrusterf1a145e2013-07-27 17:42:01 +0200138 if self.tok == '#':
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200139 self.cursor = self.src.find('\n', self.cursor)
140 elif self.tok in ['{', '}', ':', ',', '[', ']']:
141 return
142 elif self.tok == "'":
143 string = ''
144 esc = False
145 while True:
146 ch = self.src[self.cursor]
147 self.cursor += 1
148 if ch == '\n':
Markus Armbruster2caba362013-07-27 17:41:56 +0200149 raise QAPISchemaError(self,
150 'Missing terminating "\'"')
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200151 if esc:
152 string += ch
153 esc = False
154 elif ch == "\\":
155 esc = True
156 elif ch == "'":
157 self.val = string
158 return
159 else:
160 string += ch
Fam Zhenge53188a2015-05-04 09:05:18 -0600161 elif self.tok in "tfn":
162 val = self.src[self.cursor - 1:]
163 if val.startswith("true"):
164 self.val = True
165 self.cursor += 3
166 return
167 elif val.startswith("false"):
168 self.val = False
169 self.cursor += 4
170 return
171 elif val.startswith("null"):
172 self.val = None
173 self.cursor += 3
174 return
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200175 elif self.tok == '\n':
176 if self.cursor == len(self.src):
177 self.tok = None
178 return
Wenchao Xia515b9432014-03-04 18:44:33 -0800179 self.line += 1
180 self.line_pos = self.cursor
Markus Armbruster9213aa52013-07-27 17:41:57 +0200181 elif not self.tok.isspace():
182 raise QAPISchemaError(self, 'Stray "%s"' % self.tok)
Michael Roth0f923be2011-07-19 14:50:39 -0500183
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200184 def get_members(self):
185 expr = OrderedDict()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200186 if self.tok == '}':
187 self.accept()
188 return expr
189 if self.tok != "'":
190 raise QAPISchemaError(self, 'Expected string or "}"')
191 while True:
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200192 key = self.val
193 self.accept()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200194 if self.tok != ':':
195 raise QAPISchemaError(self, 'Expected ":"')
196 self.accept()
Wenchao Xia4b359912014-03-04 18:44:32 -0800197 if key in expr:
198 raise QAPISchemaError(self, 'Duplicate key "%s"' % key)
Markus Armbruster5f3cd2b2013-07-27 17:41:59 +0200199 expr[key] = self.get_expr(True)
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200200 if self.tok == '}':
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200201 self.accept()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200202 return expr
203 if self.tok != ',':
204 raise QAPISchemaError(self, 'Expected "," or "}"')
205 self.accept()
206 if self.tok != "'":
207 raise QAPISchemaError(self, 'Expected string')
Michael Roth0f923be2011-07-19 14:50:39 -0500208
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200209 def get_values(self):
210 expr = []
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200211 if self.tok == ']':
212 self.accept()
213 return expr
Fam Zhenge53188a2015-05-04 09:05:18 -0600214 if not self.tok in "{['tfn":
215 raise QAPISchemaError(self, 'Expected "{", "[", "]", string, '
216 'boolean or "null"')
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200217 while True:
Markus Armbruster5f3cd2b2013-07-27 17:41:59 +0200218 expr.append(self.get_expr(True))
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200219 if self.tok == ']':
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200220 self.accept()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200221 return expr
222 if self.tok != ',':
223 raise QAPISchemaError(self, 'Expected "," or "]"')
224 self.accept()
Michael Roth0f923be2011-07-19 14:50:39 -0500225
Markus Armbruster5f3cd2b2013-07-27 17:41:59 +0200226 def get_expr(self, nested):
227 if self.tok != '{' and not nested:
228 raise QAPISchemaError(self, 'Expected "{"')
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200229 if self.tok == '{':
230 self.accept()
231 expr = self.get_members()
232 elif self.tok == '[':
233 self.accept()
234 expr = self.get_values()
Fam Zhenge53188a2015-05-04 09:05:18 -0600235 elif self.tok in "'tfn":
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200236 expr = self.val
237 self.accept()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200238 else:
239 raise QAPISchemaError(self, 'Expected "{", "[" or string')
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200240 return expr
Kevin Wolfbd9927f2013-07-01 16:31:50 +0200241
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800242def find_base_fields(base):
243 base_struct_define = find_struct(base)
244 if not base_struct_define:
245 return None
246 return base_struct_define['data']
247
Eric Blake811d04f2015-05-04 09:05:10 -0600248# Return the qtype of an alternate branch, or None on error.
249def find_alternate_member_qtype(qapi_type):
Eric Blake44bd1272015-05-04 09:05:08 -0600250 if builtin_types.has_key(qapi_type):
251 return builtin_types[qapi_type]
252 elif find_struct(qapi_type):
253 return "QTYPE_QDICT"
254 elif find_enum(qapi_type):
255 return "QTYPE_QSTRING"
Eric Blake811d04f2015-05-04 09:05:10 -0600256 elif find_union(qapi_type):
257 return "QTYPE_QDICT"
Eric Blake44bd1272015-05-04 09:05:08 -0600258 return None
259
Wenchao Xiabceae762014-03-06 17:08:56 -0800260# Return the discriminator enum define if discriminator is specified as an
261# enum type, otherwise return None.
262def discriminator_find_enum_define(expr):
263 base = expr.get('base')
264 discriminator = expr.get('discriminator')
265
266 if not (discriminator and base):
267 return None
268
269 base_fields = find_base_fields(base)
270 if not base_fields:
271 return None
272
273 discriminator_type = base_fields.get(discriminator)
274 if not discriminator_type:
275 return None
276
277 return find_enum(discriminator_type)
278
Eric Blakec9e0a792015-05-04 09:05:22 -0600279valid_name = re.compile('^[a-zA-Z_][a-zA-Z0-9_.-]*$')
280def check_name(expr_info, source, name, allow_optional = False,
281 enum_member = False):
282 global valid_name
283 membername = name
284
285 if not isinstance(name, str):
286 raise QAPIExprError(expr_info,
287 "%s requires a string name" % source)
288 if name.startswith('*'):
289 membername = name[1:]
290 if not allow_optional:
291 raise QAPIExprError(expr_info,
292 "%s does not allow optional name '%s'"
293 % (source, name))
294 # Enum members can start with a digit, because the generated C
295 # code always prefixes it with the enum name
296 if enum_member:
297 membername = '_' + membername
298 if not valid_name.match(membername):
299 raise QAPIExprError(expr_info,
300 "%s uses invalid name '%s'" % (source, name))
301
Eric Blakedd883c62015-05-04 09:05:21 -0600302def check_type(expr_info, source, value, allow_array = False,
Eric Blakec9e0a792015-05-04 09:05:22 -0600303 allow_dict = False, allow_optional = False, allow_metas = []):
Eric Blakedd883c62015-05-04 09:05:21 -0600304 global all_names
305 orig_value = value
306
307 if value is None:
308 return
309
310 if value == '**':
311 return
312
313 # Check if array type for value is okay
314 if isinstance(value, list):
315 if not allow_array:
316 raise QAPIExprError(expr_info,
317 "%s cannot be an array" % source)
318 if len(value) != 1 or not isinstance(value[0], str):
319 raise QAPIExprError(expr_info,
320 "%s: array type must contain single type name"
321 % source)
322 value = value[0]
323 orig_value = "array of %s" %value
324
325 # Check if type name for value is okay
326 if isinstance(value, str):
327 if not value in all_names:
328 raise QAPIExprError(expr_info,
329 "%s uses unknown type '%s'"
330 % (source, orig_value))
331 if not all_names[value] in allow_metas:
332 raise QAPIExprError(expr_info,
333 "%s cannot use %s type '%s'"
334 % (source, all_names[value], orig_value))
335 return
336
337 # value is a dictionary, check that each member is okay
338 if not isinstance(value, OrderedDict):
339 raise QAPIExprError(expr_info,
340 "%s should be a dictionary" % source)
341 if not allow_dict:
342 raise QAPIExprError(expr_info,
343 "%s should be a type name" % source)
344 for (key, arg) in value.items():
Eric Blakec9e0a792015-05-04 09:05:22 -0600345 check_name(expr_info, "Member of %s" % source, key,
346 allow_optional=allow_optional)
Eric Blakedd883c62015-05-04 09:05:21 -0600347 check_type(expr_info, "Member '%s' of %s" % (key, source), arg,
Eric Blakec9e0a792015-05-04 09:05:22 -0600348 allow_array=True, allow_dict=True, allow_optional=True,
Eric Blakedd883c62015-05-04 09:05:21 -0600349 allow_metas=['built-in', 'union', 'alternate', 'struct',
350 'enum'])
351
352def check_command(expr, expr_info):
353 name = expr['command']
354 check_type(expr_info, "'data' for command '%s'" % name,
Eric Blakec9e0a792015-05-04 09:05:22 -0600355 expr.get('data'), allow_dict=True, allow_optional=True,
Eric Blakedd883c62015-05-04 09:05:21 -0600356 allow_metas=['union', 'struct'])
357 check_type(expr_info, "'returns' for command '%s'" % name,
358 expr.get('returns'), allow_array=True, allow_dict=True,
Eric Blakec9e0a792015-05-04 09:05:22 -0600359 allow_optional=True,
Eric Blakedd883c62015-05-04 09:05:21 -0600360 allow_metas=['built-in', 'union', 'alternate', 'struct',
361 'enum'])
362
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200363def check_event(expr, expr_info):
Eric Blake4dc2e692015-05-04 09:05:17 -0600364 global events
365 name = expr['event']
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200366 params = expr.get('data')
Eric Blake4dc2e692015-05-04 09:05:17 -0600367
368 if name.upper() == 'MAX':
369 raise QAPIExprError(expr_info, "Event name 'MAX' cannot be created")
370 events.append(name)
Eric Blakedd883c62015-05-04 09:05:21 -0600371 check_type(expr_info, "'data' for event '%s'" % name,
Eric Blakec9e0a792015-05-04 09:05:22 -0600372 expr.get('data'), allow_dict=True, allow_optional=True,
Eric Blakedd883c62015-05-04 09:05:21 -0600373 allow_metas=['union', 'struct'])
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200374 if params:
375 for argname, argentry, optional, structured in parse_args(params):
376 if structured:
377 raise QAPIExprError(expr_info,
378 "Nested structure define in event is not "
Wenchao Xiad6f9c822014-06-24 16:33:59 -0700379 "supported, event '%s', argname '%s'"
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200380 % (expr['event'], argname))
381
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800382def check_union(expr, expr_info):
383 name = expr['union']
384 base = expr.get('base')
385 discriminator = expr.get('discriminator')
386 members = expr['data']
Eric Blake44bd1272015-05-04 09:05:08 -0600387 values = { 'MAX': '(automatic)' }
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800388
Eric Blakea8d4a2e2015-05-04 09:05:07 -0600389 # If the object has a member 'base', its value must name a complex type,
390 # and there must be a discriminator.
391 if base is not None:
392 if discriminator is None:
393 raise QAPIExprError(expr_info,
394 "Union '%s' requires a discriminator to go "
395 "along with base" %name)
Eric Blake44bd1272015-05-04 09:05:08 -0600396
Eric Blake811d04f2015-05-04 09:05:10 -0600397 # Two types of unions, determined by discriminator.
Eric Blake811d04f2015-05-04 09:05:10 -0600398
399 # With no discriminator it is a simple union.
400 if discriminator is None:
Eric Blake44bd1272015-05-04 09:05:08 -0600401 enum_define = None
Eric Blakedd883c62015-05-04 09:05:21 -0600402 allow_metas=['built-in', 'union', 'alternate', 'struct', 'enum']
Eric Blake44bd1272015-05-04 09:05:08 -0600403 if base is not None:
404 raise QAPIExprError(expr_info,
Eric Blake811d04f2015-05-04 09:05:10 -0600405 "Simple union '%s' must not have a base"
Eric Blake44bd1272015-05-04 09:05:08 -0600406 % name)
407
408 # Else, it's a flat union.
409 else:
410 # The object must have a string member 'base'.
411 if not isinstance(base, str):
412 raise QAPIExprError(expr_info,
413 "Flat union '%s' must have a string base field"
414 % name)
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800415 base_fields = find_base_fields(base)
416 if not base_fields:
417 raise QAPIExprError(expr_info,
418 "Base '%s' is not a valid type"
419 % base)
420
Eric Blakec9e0a792015-05-04 09:05:22 -0600421 # The value of member 'discriminator' must name a non-optional
422 # member of the base type.
423 check_name(expr_info, "Discriminator of flat union '%s'" % name,
424 discriminator)
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800425 discriminator_type = base_fields.get(discriminator)
426 if not discriminator_type:
427 raise QAPIExprError(expr_info,
428 "Discriminator '%s' is not a member of base "
429 "type '%s'"
430 % (discriminator, base))
431 enum_define = find_enum(discriminator_type)
Eric Blakedd883c62015-05-04 09:05:21 -0600432 allow_metas=['struct']
Wenchao Xia52230702014-03-04 18:44:39 -0800433 # Do not allow string discriminator
434 if not enum_define:
435 raise QAPIExprError(expr_info,
436 "Discriminator '%s' must be of enumeration "
437 "type" % discriminator)
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800438
439 # Check every branch
440 for (key, value) in members.items():
Eric Blakec9e0a792015-05-04 09:05:22 -0600441 check_name(expr_info, "Member of union '%s'" % name, key)
442
Eric Blakedd883c62015-05-04 09:05:21 -0600443 # Each value must name a known type; furthermore, in flat unions,
444 # branches must be a struct
445 check_type(expr_info, "Member '%s' of union '%s'" % (key, name),
446 value, allow_array=True, allow_metas=allow_metas)
447
Eric Blake44bd1272015-05-04 09:05:08 -0600448 # If the discriminator names an enum type, then all members
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800449 # of 'data' must also be members of the enum type.
Eric Blake44bd1272015-05-04 09:05:08 -0600450 if enum_define:
451 if not key in enum_define['enum_values']:
452 raise QAPIExprError(expr_info,
453 "Discriminator value '%s' is not found in "
454 "enum '%s'" %
455 (key, enum_define["enum_name"]))
456
457 # Otherwise, check for conflicts in the generated enum
458 else:
459 c_key = _generate_enum_string(key)
460 if c_key in values:
461 raise QAPIExprError(expr_info,
462 "Union '%s' member '%s' clashes with '%s'"
463 % (name, key, values[c_key]))
464 values[c_key] = key
465
Eric Blake811d04f2015-05-04 09:05:10 -0600466def check_alternate(expr, expr_info):
Eric Blakeab916fa2015-05-04 09:05:13 -0600467 name = expr['alternate']
Eric Blake811d04f2015-05-04 09:05:10 -0600468 members = expr['data']
469 values = { 'MAX': '(automatic)' }
470 types_seen = {}
Eric Blake44bd1272015-05-04 09:05:08 -0600471
Eric Blake811d04f2015-05-04 09:05:10 -0600472 # Check every branch
473 for (key, value) in members.items():
Eric Blakec9e0a792015-05-04 09:05:22 -0600474 check_name(expr_info, "Member of alternate '%s'" % name, key)
475
Eric Blake811d04f2015-05-04 09:05:10 -0600476 # Check for conflicts in the generated enum
477 c_key = _generate_enum_string(key)
478 if c_key in values:
479 raise QAPIExprError(expr_info,
Eric Blakeab916fa2015-05-04 09:05:13 -0600480 "Alternate '%s' member '%s' clashes with '%s'"
481 % (name, key, values[c_key]))
Eric Blake811d04f2015-05-04 09:05:10 -0600482 values[c_key] = key
483
484 # Ensure alternates have no type conflicts.
Eric Blakedd883c62015-05-04 09:05:21 -0600485 check_type(expr_info, "Member '%s' of alternate '%s'" % (key, name),
486 value,
487 allow_metas=['built-in', 'union', 'struct', 'enum'])
Eric Blake811d04f2015-05-04 09:05:10 -0600488 qtype = find_alternate_member_qtype(value)
Eric Blakedd883c62015-05-04 09:05:21 -0600489 assert qtype
Eric Blake811d04f2015-05-04 09:05:10 -0600490 if qtype in types_seen:
491 raise QAPIExprError(expr_info,
Eric Blakeab916fa2015-05-04 09:05:13 -0600492 "Alternate '%s' member '%s' can't "
Eric Blake811d04f2015-05-04 09:05:10 -0600493 "be distinguished from member '%s'"
494 % (name, key, types_seen[qtype]))
495 types_seen[qtype] = key
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800496
Eric Blakecf393592015-05-04 09:05:04 -0600497def check_enum(expr, expr_info):
498 name = expr['enum']
499 members = expr.get('data')
500 values = { 'MAX': '(automatic)' }
501
502 if not isinstance(members, list):
503 raise QAPIExprError(expr_info,
504 "Enum '%s' requires an array for 'data'" % name)
505 for member in members:
Eric Blakec9e0a792015-05-04 09:05:22 -0600506 check_name(expr_info, "Member of enum '%s'" %name, member,
507 enum_member=True)
Eric Blakecf393592015-05-04 09:05:04 -0600508 key = _generate_enum_string(member)
509 if key in values:
510 raise QAPIExprError(expr_info,
511 "Enum '%s' member '%s' clashes with '%s'"
512 % (name, member, values[key]))
513 values[key] = member
514
Eric Blakedd883c62015-05-04 09:05:21 -0600515def check_struct(expr, expr_info):
516 name = expr['type']
517 members = expr['data']
518
519 check_type(expr_info, "'data' for type '%s'" % name, members,
Eric Blakec9e0a792015-05-04 09:05:22 -0600520 allow_dict=True, allow_optional=True)
Eric Blakedd883c62015-05-04 09:05:21 -0600521 check_type(expr_info, "'base' for type '%s'" % name, expr.get('base'),
522 allow_metas=['struct'])
523
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800524def check_exprs(schema):
525 for expr_elem in schema.exprs:
526 expr = expr_elem['expr']
Eric Blakecf393592015-05-04 09:05:04 -0600527 info = expr_elem['info']
528
529 if expr.has_key('enum'):
530 check_enum(expr, info)
531 elif expr.has_key('union'):
Eric Blakeab916fa2015-05-04 09:05:13 -0600532 check_union(expr, info)
533 elif expr.has_key('alternate'):
534 check_alternate(expr, info)
Eric Blakedd883c62015-05-04 09:05:21 -0600535 elif expr.has_key('type'):
536 check_struct(expr, info)
537 elif expr.has_key('command'):
538 check_command(expr, info)
Eric Blakecf393592015-05-04 09:05:04 -0600539 elif expr.has_key('event'):
540 check_event(expr, info)
Eric Blakedd883c62015-05-04 09:05:21 -0600541 else:
542 assert False, 'unexpected meta type'
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800543
Eric Blake0545f6b2015-05-04 09:05:15 -0600544def check_keys(expr_elem, meta, required, optional=[]):
545 expr = expr_elem['expr']
546 info = expr_elem['info']
547 name = expr[meta]
548 if not isinstance(name, str):
549 raise QAPIExprError(info,
550 "'%s' key must have a string value" % meta)
551 required = required + [ meta ]
552 for (key, value) in expr.items():
553 if not key in required and not key in optional:
554 raise QAPIExprError(info,
555 "Unknown key '%s' in %s '%s'"
556 % (key, meta, name))
557 for key in required:
558 if not expr.has_key(key):
559 raise QAPIExprError(info,
560 "Key '%s' is missing from %s '%s'"
561 % (key, meta, name))
562
563
Lluís Vilanova33aaad52014-05-02 15:52:35 +0200564def parse_schema(input_file):
Eric Blake4dc2e692015-05-04 09:05:17 -0600565 global all_names
566 exprs = []
567
Eric Blake268a1c52015-05-04 09:05:09 -0600568 # First pass: read entire file into memory
Markus Armbruster2caba362013-07-27 17:41:56 +0200569 try:
Lluís Vilanova33aaad52014-05-02 15:52:35 +0200570 schema = QAPISchema(open(input_file, "r"))
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200571 except (QAPISchemaError, QAPIExprError), e:
Markus Armbruster2caba362013-07-27 17:41:56 +0200572 print >>sys.stderr, e
573 exit(1)
574
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800575 try:
Eric Blake0545f6b2015-05-04 09:05:15 -0600576 # Next pass: learn the types and check for valid expression keys. At
577 # this point, top-level 'include' has already been flattened.
Eric Blake4dc2e692015-05-04 09:05:17 -0600578 for builtin in builtin_types.keys():
579 all_names[builtin] = 'built-in'
Eric Blake268a1c52015-05-04 09:05:09 -0600580 for expr_elem in schema.exprs:
581 expr = expr_elem['expr']
Eric Blake4dc2e692015-05-04 09:05:17 -0600582 info = expr_elem['info']
Eric Blake268a1c52015-05-04 09:05:09 -0600583 if expr.has_key('enum'):
Eric Blake0545f6b2015-05-04 09:05:15 -0600584 check_keys(expr_elem, 'enum', ['data'])
Eric Blake4dc2e692015-05-04 09:05:17 -0600585 add_enum(expr['enum'], info, expr['data'])
Eric Blake268a1c52015-05-04 09:05:09 -0600586 elif expr.has_key('union'):
Eric Blake0545f6b2015-05-04 09:05:15 -0600587 check_keys(expr_elem, 'union', ['data'],
588 ['base', 'discriminator'])
Eric Blake4dc2e692015-05-04 09:05:17 -0600589 add_union(expr, info)
Eric Blake0545f6b2015-05-04 09:05:15 -0600590 elif expr.has_key('alternate'):
591 check_keys(expr_elem, 'alternate', ['data'])
Eric Blake4dc2e692015-05-04 09:05:17 -0600592 add_name(expr['alternate'], info, 'alternate')
Eric Blake268a1c52015-05-04 09:05:09 -0600593 elif expr.has_key('type'):
Eric Blake0545f6b2015-05-04 09:05:15 -0600594 check_keys(expr_elem, 'type', ['data'], ['base'])
Eric Blake4dc2e692015-05-04 09:05:17 -0600595 add_struct(expr, info)
Eric Blake0545f6b2015-05-04 09:05:15 -0600596 elif expr.has_key('command'):
597 check_keys(expr_elem, 'command', [],
598 ['data', 'returns', 'gen', 'success-response'])
Eric Blake4dc2e692015-05-04 09:05:17 -0600599 add_name(expr['command'], info, 'command')
Eric Blake0545f6b2015-05-04 09:05:15 -0600600 elif expr.has_key('event'):
601 check_keys(expr_elem, 'event', [], ['data'])
Eric Blake4dc2e692015-05-04 09:05:17 -0600602 add_name(expr['event'], info, 'event')
Eric Blake0545f6b2015-05-04 09:05:15 -0600603 else:
604 raise QAPIExprError(expr_elem['info'],
605 "Expression is missing metatype")
Eric Blake268a1c52015-05-04 09:05:09 -0600606 exprs.append(expr)
607
608 # Try again for hidden UnionKind enum
609 for expr_elem in schema.exprs:
610 expr = expr_elem['expr']
611 if expr.has_key('union'):
612 if not discriminator_find_enum_define(expr):
Eric Blake4dc2e692015-05-04 09:05:17 -0600613 add_enum('%sKind' % expr['union'], expr_elem['info'],
614 implicit=True)
Eric Blakeab916fa2015-05-04 09:05:13 -0600615 elif expr.has_key('alternate'):
Eric Blake4dc2e692015-05-04 09:05:17 -0600616 add_enum('%sKind' % expr['alternate'], expr_elem['info'],
617 implicit=True)
Eric Blake268a1c52015-05-04 09:05:09 -0600618
619 # Final pass - validate that exprs make sense
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800620 check_exprs(schema)
621 except QAPIExprError, e:
622 print >>sys.stderr, e
623 exit(1)
624
Michael Roth0f923be2011-07-19 14:50:39 -0500625 return exprs
626
627def parse_args(typeinfo):
Eric Blakefe2a9302015-05-04 09:05:02 -0600628 if isinstance(typeinfo, str):
Kevin Wolfb35284e2013-07-01 16:31:51 +0200629 struct = find_struct(typeinfo)
630 assert struct != None
631 typeinfo = struct['data']
632
Michael Roth0f923be2011-07-19 14:50:39 -0500633 for member in typeinfo:
634 argname = member
635 argentry = typeinfo[member]
636 optional = False
637 structured = False
638 if member.startswith('*'):
639 argname = member[1:]
640 optional = True
641 if isinstance(argentry, OrderedDict):
642 structured = True
643 yield (argname, argentry, optional, structured)
644
645def de_camel_case(name):
646 new_name = ''
647 for ch in name:
648 if ch.isupper() and new_name:
649 new_name += '_'
650 if ch == '-':
651 new_name += '_'
652 else:
653 new_name += ch.lower()
654 return new_name
655
656def camel_case(name):
657 new_name = ''
658 first = True
659 for ch in name:
660 if ch in ['_', '-']:
661 first = True
662 elif first:
663 new_name += ch.upper()
664 first = False
665 else:
666 new_name += ch.lower()
667 return new_name
668
Paolo Bonzinieda50a62012-09-19 16:31:06 +0200669def c_var(name, protect=True):
Blue Swirl427a1a22012-07-30 15:46:55 +0000670 # ANSI X3J11/88-090, 3.1.1
671 c89_words = set(['auto', 'break', 'case', 'char', 'const', 'continue',
672 'default', 'do', 'double', 'else', 'enum', 'extern', 'float',
673 'for', 'goto', 'if', 'int', 'long', 'register', 'return',
674 'short', 'signed', 'sizeof', 'static', 'struct', 'switch',
675 'typedef', 'union', 'unsigned', 'void', 'volatile', 'while'])
676 # ISO/IEC 9899:1999, 6.4.1
677 c99_words = set(['inline', 'restrict', '_Bool', '_Complex', '_Imaginary'])
678 # ISO/IEC 9899:2011, 6.4.1
679 c11_words = set(['_Alignas', '_Alignof', '_Atomic', '_Generic', '_Noreturn',
680 '_Static_assert', '_Thread_local'])
681 # GCC http://gcc.gnu.org/onlinedocs/gcc-4.7.1/gcc/C-Extensions.html
682 # excluding _.*
683 gcc_words = set(['asm', 'typeof'])
Tomoki Sekiyama6f880092013-08-07 11:39:43 -0400684 # C++ ISO/IEC 14882:2003 2.11
685 cpp_words = set(['bool', 'catch', 'class', 'const_cast', 'delete',
686 'dynamic_cast', 'explicit', 'false', 'friend', 'mutable',
687 'namespace', 'new', 'operator', 'private', 'protected',
688 'public', 'reinterpret_cast', 'static_cast', 'template',
689 'this', 'throw', 'true', 'try', 'typeid', 'typename',
690 'using', 'virtual', 'wchar_t',
691 # alternative representations
692 'and', 'and_eq', 'bitand', 'bitor', 'compl', 'not',
693 'not_eq', 'or', 'or_eq', 'xor', 'xor_eq'])
Paolo Bonzini10577252012-09-19 16:31:07 +0200694 # namespace pollution:
Max Reitz8592a542013-12-20 19:28:18 +0100695 polluted_words = set(['unix', 'errno'])
Tomoki Sekiyama6f880092013-08-07 11:39:43 -0400696 if protect and (name in c89_words | c99_words | c11_words | gcc_words | cpp_words | polluted_words):
Blue Swirl427a1a22012-07-30 15:46:55 +0000697 return "q_" + name
Federico Simoncellic9da2282012-03-20 13:54:35 +0000698 return name.replace('-', '_').lstrip("*")
699
Paolo Bonzinieda50a62012-09-19 16:31:06 +0200700def c_fun(name, protect=True):
701 return c_var(name, protect).replace('.', '_')
Michael Roth0f923be2011-07-19 14:50:39 -0500702
703def c_list_type(name):
704 return '%sList' % name
705
706def type_name(name):
707 if type(name) == list:
708 return c_list_type(name[0])
709 return name
710
Eric Blakec9e0a792015-05-04 09:05:22 -0600711def add_name(name, info, meta, implicit = False, source = None):
Eric Blake4dc2e692015-05-04 09:05:17 -0600712 global all_names
Eric Blakec9e0a792015-05-04 09:05:22 -0600713 if not source:
714 source = "'%s'" % meta
715 check_name(info, source, name)
Eric Blake4dc2e692015-05-04 09:05:17 -0600716 if name in all_names:
717 raise QAPIExprError(info,
718 "%s '%s' is already defined"
719 % (all_names[name], name))
720 if not implicit and name[-4:] == 'Kind':
721 raise QAPIExprError(info,
722 "%s '%s' should not end in 'Kind'"
723 % (meta, name))
724 all_names[name] = meta
Kevin Wolfb35284e2013-07-01 16:31:51 +0200725
Eric Blake4dc2e692015-05-04 09:05:17 -0600726def add_struct(definition, info):
Kevin Wolfb35284e2013-07-01 16:31:51 +0200727 global struct_types
Eric Blake4dc2e692015-05-04 09:05:17 -0600728 name = definition['type']
Eric Blakec9e0a792015-05-04 09:05:22 -0600729 add_name(name, info, 'struct', source="'type'")
Kevin Wolfb35284e2013-07-01 16:31:51 +0200730 struct_types.append(definition)
731
732def find_struct(name):
733 global struct_types
734 for struct in struct_types:
735 if struct['type'] == name:
736 return struct
737 return None
Michael Roth0f923be2011-07-19 14:50:39 -0500738
Eric Blake4dc2e692015-05-04 09:05:17 -0600739def add_union(definition, info):
Kevin Wolfea66c6d2013-07-16 10:49:41 +0200740 global union_types
Eric Blake4dc2e692015-05-04 09:05:17 -0600741 name = definition['union']
742 add_name(name, info, 'union')
Eric Blakeab916fa2015-05-04 09:05:13 -0600743 union_types.append(definition)
Kevin Wolfea66c6d2013-07-16 10:49:41 +0200744
745def find_union(name):
746 global union_types
747 for union in union_types:
748 if union['union'] == name:
749 return union
750 return None
751
Eric Blake4dc2e692015-05-04 09:05:17 -0600752def add_enum(name, info, enum_values = None, implicit = False):
Michael Roth0f923be2011-07-19 14:50:39 -0500753 global enum_types
Eric Blake4dc2e692015-05-04 09:05:17 -0600754 add_name(name, info, 'enum', implicit)
Wenchao Xiadad1fca2014-03-04 18:44:31 -0800755 enum_types.append({"enum_name": name, "enum_values": enum_values})
756
757def find_enum(name):
758 global enum_types
759 for enum in enum_types:
760 if enum['enum_name'] == name:
761 return enum
762 return None
Michael Roth0f923be2011-07-19 14:50:39 -0500763
764def is_enum(name):
Wenchao Xiadad1fca2014-03-04 18:44:31 -0800765 return find_enum(name) != None
Michael Roth0f923be2011-07-19 14:50:39 -0500766
Amos Kong05dfb262014-06-10 19:25:53 +0800767eatspace = '\033EATSPACE.'
768
769# A special suffix is added in c_type() for pointer types, and it's
770# stripped in mcgen(). So please notice this when you check the return
771# value of c_type() outside mcgen().
Amos Kong0d14eeb2014-06-10 19:25:52 +0800772def c_type(name, is_param=False):
Michael Roth0f923be2011-07-19 14:50:39 -0500773 if name == 'str':
Amos Kong0d14eeb2014-06-10 19:25:52 +0800774 if is_param:
Amos Kong05dfb262014-06-10 19:25:53 +0800775 return 'const char *' + eatspace
776 return 'char *' + eatspace
777
Michael Roth0f923be2011-07-19 14:50:39 -0500778 elif name == 'int':
779 return 'int64_t'
Laszlo Ersekc46f18c2012-07-17 16:17:06 +0200780 elif (name == 'int8' or name == 'int16' or name == 'int32' or
781 name == 'int64' or name == 'uint8' or name == 'uint16' or
782 name == 'uint32' or name == 'uint64'):
783 return name + '_t'
Laszlo Ersek092705d2012-07-17 16:17:07 +0200784 elif name == 'size':
785 return 'uint64_t'
Michael Roth0f923be2011-07-19 14:50:39 -0500786 elif name == 'bool':
787 return 'bool'
788 elif name == 'number':
789 return 'double'
790 elif type(name) == list:
Amos Kong05dfb262014-06-10 19:25:53 +0800791 return '%s *%s' % (c_list_type(name[0]), eatspace)
Michael Roth0f923be2011-07-19 14:50:39 -0500792 elif is_enum(name):
793 return name
794 elif name == None or len(name) == 0:
795 return 'void'
Eric Blake4dc2e692015-05-04 09:05:17 -0600796 elif name in events:
Amos Kong05dfb262014-06-10 19:25:53 +0800797 return '%sEvent *%s' % (camel_case(name), eatspace)
Michael Roth0f923be2011-07-19 14:50:39 -0500798 else:
Amos Kong05dfb262014-06-10 19:25:53 +0800799 return '%s *%s' % (name, eatspace)
800
801def is_c_ptr(name):
802 suffix = "*" + eatspace
803 return c_type(name).endswith(suffix)
Michael Roth0f923be2011-07-19 14:50:39 -0500804
805def genindent(count):
806 ret = ""
807 for i in range(count):
808 ret += " "
809 return ret
810
811indent_level = 0
812
813def push_indent(indent_amount=4):
814 global indent_level
815 indent_level += indent_amount
816
817def pop_indent(indent_amount=4):
818 global indent_level
819 indent_level -= indent_amount
820
821def cgen(code, **kwds):
822 indent = genindent(indent_level)
823 lines = code.split('\n')
824 lines = map(lambda x: indent + x, lines)
825 return '\n'.join(lines) % kwds + '\n'
826
827def mcgen(code, **kwds):
Amos Kong05dfb262014-06-10 19:25:53 +0800828 raw = cgen('\n'.join(code.split('\n')[1:-1]), **kwds)
829 return re.sub(re.escape(eatspace) + ' *', '', raw)
Michael Roth0f923be2011-07-19 14:50:39 -0500830
831def basename(filename):
832 return filename.split("/")[-1]
833
834def guardname(filename):
Michael Rothd8e1f212011-11-29 16:47:48 -0600835 guard = basename(filename).rsplit(".", 1)[0]
836 for substr in [".", " ", "-"]:
837 guard = guard.replace(substr, "_")
838 return guard.upper() + '_H'
Michael Rothc0afa9c2013-05-10 17:46:00 -0500839
840def guardstart(name):
841 return mcgen('''
842
843#ifndef %(name)s
844#define %(name)s
845
846''',
847 name=guardname(name))
848
849def guardend(name):
850 return mcgen('''
851
852#endif /* %(name)s */
853
854''',
855 name=guardname(name))
Wenchao Xia62996592014-03-04 18:44:35 -0800856
Wenchao Xia5d371f42014-03-04 18:44:40 -0800857# ENUMName -> ENUM_NAME, EnumName1 -> ENUM_NAME1
858# ENUM_NAME -> ENUM_NAME, ENUM_NAME1 -> ENUM_NAME1, ENUM_Name2 -> ENUM_NAME2
859# ENUM24_Name -> ENUM24_NAME
860def _generate_enum_string(value):
861 c_fun_str = c_fun(value, False)
Wenchao Xiab0b58192014-03-04 18:44:36 -0800862 if value.isupper():
Wenchao Xia5d371f42014-03-04 18:44:40 -0800863 return c_fun_str
864
Wenchao Xia62996592014-03-04 18:44:35 -0800865 new_name = ''
Wenchao Xia5d371f42014-03-04 18:44:40 -0800866 l = len(c_fun_str)
867 for i in range(l):
868 c = c_fun_str[i]
869 # When c is upper and no "_" appears before, do more checks
870 if c.isupper() and (i > 0) and c_fun_str[i - 1] != "_":
871 # Case 1: next string is lower
872 # Case 2: previous string is digit
873 if (i < (l - 1) and c_fun_str[i + 1].islower()) or \
874 c_fun_str[i - 1].isdigit():
875 new_name += '_'
Wenchao Xia62996592014-03-04 18:44:35 -0800876 new_name += c
877 return new_name.lstrip('_').upper()
Wenchao Xiab0b58192014-03-04 18:44:36 -0800878
879def generate_enum_full_value(enum_name, enum_value):
Wenchao Xia5d371f42014-03-04 18:44:40 -0800880 abbrev_string = _generate_enum_string(enum_name)
881 value_string = _generate_enum_string(enum_value)
Wenchao Xiab0b58192014-03-04 18:44:36 -0800882 return "%s_%s" % (abbrev_string, value_string)