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