1# -*- coding: utf-8 -*- 2# 3# QAPI schema internal representation 4# 5# Copyright (c) 2015-2019 Red Hat Inc. 6# 7# Authors: 8# Markus Armbruster <armbru@redhat.com> 9# Eric Blake <eblake@redhat.com> 10# Marc-André Lureau <marcandre.lureau@redhat.com> 11# 12# This work is licensed under the terms of the GNU GPL, version 2. 13# See the COPYING file in the top-level directory. 14 15# TODO catching name collisions in generated code would be nice 16 17import os 18import re 19from collections import OrderedDict 20 21from qapi.common import c_name, pointer_suffix 22from qapi.error import QAPIError, QAPISemError 23from qapi.expr import check_exprs 24from qapi.parser import QAPISchemaParser 25 26 27class QAPISchemaEntity: 28 meta = None 29 30 def __init__(self, name, info, doc, ifcond=None, features=None): 31 assert name is None or isinstance(name, str) 32 for f in features or []: 33 assert isinstance(f, QAPISchemaFeature) 34 f.set_defined_in(name) 35 self.name = name 36 self._module = None 37 # For explicitly defined entities, info points to the (explicit) 38 # definition. For builtins (and their arrays), info is None. 39 # For implicitly defined entities, info points to a place that 40 # triggered the implicit definition (there may be more than one 41 # such place). 42 self.info = info 43 self.doc = doc 44 self._ifcond = ifcond or [] 45 self.features = features or [] 46 self._checked = False 47 48 def c_name(self): 49 return c_name(self.name) 50 51 def check(self, schema): 52 assert not self._checked 53 seen = {} 54 for f in self.features: 55 f.check_clash(self.info, seen) 56 self._checked = True 57 58 def connect_doc(self, doc=None): 59 doc = doc or self.doc 60 if doc: 61 for f in self.features: 62 doc.connect_feature(f) 63 64 def check_doc(self): 65 if self.doc: 66 self.doc.check() 67 68 def _set_module(self, schema, info): 69 assert self._checked 70 self._module = schema.module_by_fname(info and info.fname) 71 self._module.add_entity(self) 72 73 def set_module(self, schema): 74 self._set_module(schema, self.info) 75 76 @property 77 def ifcond(self): 78 assert self._checked 79 return self._ifcond 80 81 def is_implicit(self): 82 return not self.info 83 84 def visit(self, visitor): 85 assert self._checked 86 87 def describe(self): 88 assert self.meta 89 return "%s '%s'" % (self.meta, self.name) 90 91 92class QAPISchemaVisitor: 93 def visit_begin(self, schema): 94 pass 95 96 def visit_end(self): 97 pass 98 99 def visit_module(self, name): 100 pass 101 102 def visit_needed(self, entity): 103 # Default to visiting everything 104 return True 105 106 def visit_include(self, name, info): 107 pass 108 109 def visit_builtin_type(self, name, info, json_type): 110 pass 111 112 def visit_enum_type(self, name, info, ifcond, features, members, prefix): 113 pass 114 115 def visit_array_type(self, name, info, ifcond, element_type): 116 pass 117 118 def visit_object_type(self, name, info, ifcond, features, 119 base, members, variants): 120 pass 121 122 def visit_object_type_flat(self, name, info, ifcond, features, 123 members, variants): 124 pass 125 126 def visit_alternate_type(self, name, info, ifcond, features, variants): 127 pass 128 129 def visit_command(self, name, info, ifcond, features, 130 arg_type, ret_type, gen, success_response, boxed, 131 allow_oob, allow_preconfig): 132 pass 133 134 def visit_event(self, name, info, ifcond, features, arg_type, boxed): 135 pass 136 137 138class QAPISchemaModule: 139 def __init__(self, name): 140 self.name = name 141 self._entity_list = [] 142 143 def add_entity(self, ent): 144 self._entity_list.append(ent) 145 146 def visit(self, visitor): 147 visitor.visit_module(self.name) 148 for entity in self._entity_list: 149 if visitor.visit_needed(entity): 150 entity.visit(visitor) 151 152 153class QAPISchemaInclude(QAPISchemaEntity): 154 def __init__(self, sub_module, info): 155 super().__init__(None, info, None) 156 self._sub_module = sub_module 157 158 def visit(self, visitor): 159 super().visit(visitor) 160 visitor.visit_include(self._sub_module.name, self.info) 161 162 163class QAPISchemaType(QAPISchemaEntity): 164 # Return the C type for common use. 165 # For the types we commonly box, this is a pointer type. 166 def c_type(self): 167 pass 168 169 # Return the C type to be used in a parameter list. 170 def c_param_type(self): 171 return self.c_type() 172 173 # Return the C type to be used where we suppress boxing. 174 def c_unboxed_type(self): 175 return self.c_type() 176 177 def json_type(self): 178 pass 179 180 def alternate_qtype(self): 181 json2qtype = { 182 'null': 'QTYPE_QNULL', 183 'string': 'QTYPE_QSTRING', 184 'number': 'QTYPE_QNUM', 185 'int': 'QTYPE_QNUM', 186 'boolean': 'QTYPE_QBOOL', 187 'object': 'QTYPE_QDICT' 188 } 189 return json2qtype.get(self.json_type()) 190 191 def doc_type(self): 192 if self.is_implicit(): 193 return None 194 return self.name 195 196 def describe(self): 197 assert self.meta 198 return "%s type '%s'" % (self.meta, self.name) 199 200 201class QAPISchemaBuiltinType(QAPISchemaType): 202 meta = 'built-in' 203 204 def __init__(self, name, json_type, c_type): 205 super().__init__(name, None, None) 206 assert not c_type or isinstance(c_type, str) 207 assert json_type in ('string', 'number', 'int', 'boolean', 'null', 208 'value') 209 self._json_type_name = json_type 210 self._c_type_name = c_type 211 212 def c_name(self): 213 return self.name 214 215 def c_type(self): 216 return self._c_type_name 217 218 def c_param_type(self): 219 if self.name == 'str': 220 return 'const ' + self._c_type_name 221 return self._c_type_name 222 223 def json_type(self): 224 return self._json_type_name 225 226 def doc_type(self): 227 return self.json_type() 228 229 def visit(self, visitor): 230 super().visit(visitor) 231 visitor.visit_builtin_type(self.name, self.info, self.json_type()) 232 233 234class QAPISchemaEnumType(QAPISchemaType): 235 meta = 'enum' 236 237 def __init__(self, name, info, doc, ifcond, features, members, prefix): 238 super().__init__(name, info, doc, ifcond, features) 239 for m in members: 240 assert isinstance(m, QAPISchemaEnumMember) 241 m.set_defined_in(name) 242 assert prefix is None or isinstance(prefix, str) 243 self.members = members 244 self.prefix = prefix 245 246 def check(self, schema): 247 super().check(schema) 248 seen = {} 249 for m in self.members: 250 m.check_clash(self.info, seen) 251 252 def connect_doc(self, doc=None): 253 super().connect_doc(doc) 254 doc = doc or self.doc 255 if doc: 256 for m in self.members: 257 doc.connect_member(m) 258 259 def is_implicit(self): 260 # See QAPISchema._make_implicit_enum_type() and ._def_predefineds() 261 return self.name.endswith('Kind') or self.name == 'QType' 262 263 def c_type(self): 264 return c_name(self.name) 265 266 def member_names(self): 267 return [m.name for m in self.members] 268 269 def json_type(self): 270 return 'string' 271 272 def visit(self, visitor): 273 super().visit(visitor) 274 visitor.visit_enum_type( 275 self.name, self.info, self.ifcond, self.features, 276 self.members, self.prefix) 277 278 279class QAPISchemaArrayType(QAPISchemaType): 280 meta = 'array' 281 282 def __init__(self, name, info, element_type): 283 super().__init__(name, info, None) 284 assert isinstance(element_type, str) 285 self._element_type_name = element_type 286 self.element_type = None 287 288 def check(self, schema): 289 super().check(schema) 290 self.element_type = schema.resolve_type( 291 self._element_type_name, self.info, 292 self.info and self.info.defn_meta) 293 assert not isinstance(self.element_type, QAPISchemaArrayType) 294 295 def set_module(self, schema): 296 self._set_module(schema, self.element_type.info) 297 298 @property 299 def ifcond(self): 300 assert self._checked 301 return self.element_type.ifcond 302 303 def is_implicit(self): 304 return True 305 306 def c_type(self): 307 return c_name(self.name) + pointer_suffix 308 309 def json_type(self): 310 return 'array' 311 312 def doc_type(self): 313 elt_doc_type = self.element_type.doc_type() 314 if not elt_doc_type: 315 return None 316 return 'array of ' + elt_doc_type 317 318 def visit(self, visitor): 319 super().visit(visitor) 320 visitor.visit_array_type(self.name, self.info, self.ifcond, 321 self.element_type) 322 323 def describe(self): 324 assert self.meta 325 return "%s type ['%s']" % (self.meta, self._element_type_name) 326 327 328class QAPISchemaObjectType(QAPISchemaType): 329 def __init__(self, name, info, doc, ifcond, features, 330 base, local_members, variants): 331 # struct has local_members, optional base, and no variants 332 # flat union has base, variants, and no local_members 333 # simple union has local_members, variants, and no base 334 super().__init__(name, info, doc, ifcond, features) 335 self.meta = 'union' if variants else 'struct' 336 assert base is None or isinstance(base, str) 337 for m in local_members: 338 assert isinstance(m, QAPISchemaObjectTypeMember) 339 m.set_defined_in(name) 340 if variants is not None: 341 assert isinstance(variants, QAPISchemaObjectTypeVariants) 342 variants.set_defined_in(name) 343 self._base_name = base 344 self.base = None 345 self.local_members = local_members 346 self.variants = variants 347 self.members = None 348 349 def check(self, schema): 350 # This calls another type T's .check() exactly when the C 351 # struct emitted by gen_object() contains that T's C struct 352 # (pointers don't count). 353 if self.members is not None: 354 # A previous .check() completed: nothing to do 355 return 356 if self._checked: 357 # Recursed: C struct contains itself 358 raise QAPISemError(self.info, 359 "object %s contains itself" % self.name) 360 361 super().check(schema) 362 assert self._checked and self.members is None 363 364 seen = OrderedDict() 365 if self._base_name: 366 self.base = schema.resolve_type(self._base_name, self.info, 367 "'base'") 368 if (not isinstance(self.base, QAPISchemaObjectType) 369 or self.base.variants): 370 raise QAPISemError( 371 self.info, 372 "'base' requires a struct type, %s isn't" 373 % self.base.describe()) 374 self.base.check(schema) 375 self.base.check_clash(self.info, seen) 376 for m in self.local_members: 377 m.check(schema) 378 m.check_clash(self.info, seen) 379 members = seen.values() 380 381 if self.variants: 382 self.variants.check(schema, seen) 383 self.variants.check_clash(self.info, seen) 384 385 self.members = members # mark completed 386 387 # Check that the members of this type do not cause duplicate JSON members, 388 # and update seen to track the members seen so far. Report any errors 389 # on behalf of info, which is not necessarily self.info 390 def check_clash(self, info, seen): 391 assert self._checked 392 assert not self.variants # not implemented 393 for m in self.members: 394 m.check_clash(info, seen) 395 396 def connect_doc(self, doc=None): 397 super().connect_doc(doc) 398 doc = doc or self.doc 399 if doc: 400 if self.base and self.base.is_implicit(): 401 self.base.connect_doc(doc) 402 for m in self.local_members: 403 doc.connect_member(m) 404 405 @property 406 def ifcond(self): 407 assert self._checked 408 if isinstance(self._ifcond, QAPISchemaType): 409 # Simple union wrapper type inherits from wrapped type; 410 # see _make_implicit_object_type() 411 return self._ifcond.ifcond 412 return self._ifcond 413 414 def is_implicit(self): 415 # See QAPISchema._make_implicit_object_type(), as well as 416 # _def_predefineds() 417 return self.name.startswith('q_') 418 419 def is_empty(self): 420 assert self.members is not None 421 return not self.members and not self.variants 422 423 def c_name(self): 424 assert self.name != 'q_empty' 425 return super().c_name() 426 427 def c_type(self): 428 assert not self.is_implicit() 429 return c_name(self.name) + pointer_suffix 430 431 def c_unboxed_type(self): 432 return c_name(self.name) 433 434 def json_type(self): 435 return 'object' 436 437 def visit(self, visitor): 438 super().visit(visitor) 439 visitor.visit_object_type( 440 self.name, self.info, self.ifcond, self.features, 441 self.base, self.local_members, self.variants) 442 visitor.visit_object_type_flat( 443 self.name, self.info, self.ifcond, self.features, 444 self.members, self.variants) 445 446 447class QAPISchemaMember: 448 """ Represents object members, enum members and features """ 449 role = 'member' 450 451 def __init__(self, name, info, ifcond=None): 452 assert isinstance(name, str) 453 self.name = name 454 self.info = info 455 self.ifcond = ifcond or [] 456 self.defined_in = None 457 458 def set_defined_in(self, name): 459 assert not self.defined_in 460 self.defined_in = name 461 462 def check_clash(self, info, seen): 463 cname = c_name(self.name) 464 if cname in seen: 465 raise QAPISemError( 466 info, 467 "%s collides with %s" 468 % (self.describe(info), seen[cname].describe(info))) 469 seen[cname] = self 470 471 def describe(self, info): 472 role = self.role 473 defined_in = self.defined_in 474 assert defined_in 475 476 if defined_in.startswith('q_obj_'): 477 # See QAPISchema._make_implicit_object_type() - reverse the 478 # mapping there to create a nice human-readable description 479 defined_in = defined_in[6:] 480 if defined_in.endswith('-arg'): 481 # Implicit type created for a command's dict 'data' 482 assert role == 'member' 483 role = 'parameter' 484 elif defined_in.endswith('-base'): 485 # Implicit type created for a flat union's dict 'base' 486 role = 'base ' + role 487 else: 488 # Implicit type created for a simple union's branch 489 assert defined_in.endswith('-wrapper') 490 # Unreachable and not implemented 491 assert False 492 elif defined_in.endswith('Kind'): 493 # See QAPISchema._make_implicit_enum_type() 494 # Implicit enum created for simple union's branches 495 assert role == 'value' 496 role = 'branch' 497 elif defined_in != info.defn_name: 498 return "%s '%s' of type '%s'" % (role, self.name, defined_in) 499 return "%s '%s'" % (role, self.name) 500 501 502class QAPISchemaEnumMember(QAPISchemaMember): 503 role = 'value' 504 505 506class QAPISchemaFeature(QAPISchemaMember): 507 role = 'feature' 508 509 510class QAPISchemaObjectTypeMember(QAPISchemaMember): 511 def __init__(self, name, info, typ, optional, ifcond=None): 512 super().__init__(name, info, ifcond) 513 assert isinstance(typ, str) 514 assert isinstance(optional, bool) 515 self._type_name = typ 516 self.type = None 517 self.optional = optional 518 519 def check(self, schema): 520 assert self.defined_in 521 self.type = schema.resolve_type(self._type_name, self.info, 522 self.describe) 523 524 525class QAPISchemaObjectTypeVariants: 526 def __init__(self, tag_name, info, tag_member, variants): 527 # Flat unions pass tag_name but not tag_member. 528 # Simple unions and alternates pass tag_member but not tag_name. 529 # After check(), tag_member is always set, and tag_name remains 530 # a reliable witness of being used by a flat union. 531 assert bool(tag_member) != bool(tag_name) 532 assert (isinstance(tag_name, str) or 533 isinstance(tag_member, QAPISchemaObjectTypeMember)) 534 for v in variants: 535 assert isinstance(v, QAPISchemaObjectTypeVariant) 536 self._tag_name = tag_name 537 self.info = info 538 self.tag_member = tag_member 539 self.variants = variants 540 541 def set_defined_in(self, name): 542 for v in self.variants: 543 v.set_defined_in(name) 544 545 def check(self, schema, seen): 546 if not self.tag_member: # flat union 547 self.tag_member = seen.get(c_name(self._tag_name)) 548 base = "'base'" 549 # Pointing to the base type when not implicit would be 550 # nice, but we don't know it here 551 if not self.tag_member or self._tag_name != self.tag_member.name: 552 raise QAPISemError( 553 self.info, 554 "discriminator '%s' is not a member of %s" 555 % (self._tag_name, base)) 556 # Here we do: 557 base_type = schema.lookup_type(self.tag_member.defined_in) 558 assert base_type 559 if not base_type.is_implicit(): 560 base = "base type '%s'" % self.tag_member.defined_in 561 if not isinstance(self.tag_member.type, QAPISchemaEnumType): 562 raise QAPISemError( 563 self.info, 564 "discriminator member '%s' of %s must be of enum type" 565 % (self._tag_name, base)) 566 if self.tag_member.optional: 567 raise QAPISemError( 568 self.info, 569 "discriminator member '%s' of %s must not be optional" 570 % (self._tag_name, base)) 571 if self.tag_member.ifcond: 572 raise QAPISemError( 573 self.info, 574 "discriminator member '%s' of %s must not be conditional" 575 % (self._tag_name, base)) 576 else: # simple union 577 assert isinstance(self.tag_member.type, QAPISchemaEnumType) 578 assert not self.tag_member.optional 579 assert self.tag_member.ifcond == [] 580 if self._tag_name: # flat union 581 # branches that are not explicitly covered get an empty type 582 cases = {v.name for v in self.variants} 583 for m in self.tag_member.type.members: 584 if m.name not in cases: 585 v = QAPISchemaObjectTypeVariant(m.name, self.info, 586 'q_empty', m.ifcond) 587 v.set_defined_in(self.tag_member.defined_in) 588 self.variants.append(v) 589 if not self.variants: 590 raise QAPISemError(self.info, "union has no branches") 591 for v in self.variants: 592 v.check(schema) 593 # Union names must match enum values; alternate names are 594 # checked separately. Use 'seen' to tell the two apart. 595 if seen: 596 if v.name not in self.tag_member.type.member_names(): 597 raise QAPISemError( 598 self.info, 599 "branch '%s' is not a value of %s" 600 % (v.name, self.tag_member.type.describe())) 601 if (not isinstance(v.type, QAPISchemaObjectType) 602 or v.type.variants): 603 raise QAPISemError( 604 self.info, 605 "%s cannot use %s" 606 % (v.describe(self.info), v.type.describe())) 607 v.type.check(schema) 608 609 def check_clash(self, info, seen): 610 for v in self.variants: 611 # Reset seen map for each variant, since qapi names from one 612 # branch do not affect another branch 613 v.type.check_clash(info, dict(seen)) 614 615 616class QAPISchemaObjectTypeVariant(QAPISchemaObjectTypeMember): 617 role = 'branch' 618 619 def __init__(self, name, info, typ, ifcond=None): 620 super().__init__(name, info, typ, False, ifcond) 621 622 623class QAPISchemaAlternateType(QAPISchemaType): 624 meta = 'alternate' 625 626 def __init__(self, name, info, doc, ifcond, features, variants): 627 super().__init__(name, info, doc, ifcond, features) 628 assert isinstance(variants, QAPISchemaObjectTypeVariants) 629 assert variants.tag_member 630 variants.set_defined_in(name) 631 variants.tag_member.set_defined_in(self.name) 632 self.variants = variants 633 634 def check(self, schema): 635 super().check(schema) 636 self.variants.tag_member.check(schema) 637 # Not calling self.variants.check_clash(), because there's nothing 638 # to clash with 639 self.variants.check(schema, {}) 640 # Alternate branch names have no relation to the tag enum values; 641 # so we have to check for potential name collisions ourselves. 642 seen = {} 643 types_seen = {} 644 for v in self.variants.variants: 645 v.check_clash(self.info, seen) 646 qtype = v.type.alternate_qtype() 647 if not qtype: 648 raise QAPISemError( 649 self.info, 650 "%s cannot use %s" 651 % (v.describe(self.info), v.type.describe())) 652 conflicting = set([qtype]) 653 if qtype == 'QTYPE_QSTRING': 654 if isinstance(v.type, QAPISchemaEnumType): 655 for m in v.type.members: 656 if m.name in ['on', 'off']: 657 conflicting.add('QTYPE_QBOOL') 658 if re.match(r'[-+0-9.]', m.name): 659 # lazy, could be tightened 660 conflicting.add('QTYPE_QNUM') 661 else: 662 conflicting.add('QTYPE_QNUM') 663 conflicting.add('QTYPE_QBOOL') 664 for qt in conflicting: 665 if qt in types_seen: 666 raise QAPISemError( 667 self.info, 668 "%s can't be distinguished from '%s'" 669 % (v.describe(self.info), types_seen[qt])) 670 types_seen[qt] = v.name 671 672 def connect_doc(self, doc=None): 673 super().connect_doc(doc) 674 doc = doc or self.doc 675 if doc: 676 for v in self.variants.variants: 677 doc.connect_member(v) 678 679 def c_type(self): 680 return c_name(self.name) + pointer_suffix 681 682 def json_type(self): 683 return 'value' 684 685 def visit(self, visitor): 686 super().visit(visitor) 687 visitor.visit_alternate_type( 688 self.name, self.info, self.ifcond, self.features, self.variants) 689 690 691class QAPISchemaCommand(QAPISchemaEntity): 692 meta = 'command' 693 694 def __init__(self, name, info, doc, ifcond, features, 695 arg_type, ret_type, 696 gen, success_response, boxed, allow_oob, allow_preconfig): 697 super().__init__(name, info, doc, ifcond, features) 698 assert not arg_type or isinstance(arg_type, str) 699 assert not ret_type or isinstance(ret_type, str) 700 self._arg_type_name = arg_type 701 self.arg_type = None 702 self._ret_type_name = ret_type 703 self.ret_type = None 704 self.gen = gen 705 self.success_response = success_response 706 self.boxed = boxed 707 self.allow_oob = allow_oob 708 self.allow_preconfig = allow_preconfig 709 710 def check(self, schema): 711 super().check(schema) 712 if self._arg_type_name: 713 self.arg_type = schema.resolve_type( 714 self._arg_type_name, self.info, "command's 'data'") 715 if not isinstance(self.arg_type, QAPISchemaObjectType): 716 raise QAPISemError( 717 self.info, 718 "command's 'data' cannot take %s" 719 % self.arg_type.describe()) 720 if self.arg_type.variants and not self.boxed: 721 raise QAPISemError( 722 self.info, 723 "command's 'data' can take %s only with 'boxed': true" 724 % self.arg_type.describe()) 725 if self._ret_type_name: 726 self.ret_type = schema.resolve_type( 727 self._ret_type_name, self.info, "command's 'returns'") 728 if self.name not in self.info.pragma.returns_whitelist: 729 typ = self.ret_type 730 if isinstance(typ, QAPISchemaArrayType): 731 typ = self.ret_type.element_type 732 assert typ 733 if not isinstance(typ, QAPISchemaObjectType): 734 raise QAPISemError( 735 self.info, 736 "command's 'returns' cannot take %s" 737 % self.ret_type.describe()) 738 739 def connect_doc(self, doc=None): 740 super().connect_doc(doc) 741 doc = doc or self.doc 742 if doc: 743 if self.arg_type and self.arg_type.is_implicit(): 744 self.arg_type.connect_doc(doc) 745 746 def visit(self, visitor): 747 super().visit(visitor) 748 visitor.visit_command( 749 self.name, self.info, self.ifcond, self.features, 750 self.arg_type, self.ret_type, self.gen, self.success_response, 751 self.boxed, self.allow_oob, self.allow_preconfig) 752 753 754class QAPISchemaEvent(QAPISchemaEntity): 755 meta = 'event' 756 757 def __init__(self, name, info, doc, ifcond, features, arg_type, boxed): 758 super().__init__(name, info, doc, ifcond, features) 759 assert not arg_type or isinstance(arg_type, str) 760 self._arg_type_name = arg_type 761 self.arg_type = None 762 self.boxed = boxed 763 764 def check(self, schema): 765 super().check(schema) 766 if self._arg_type_name: 767 self.arg_type = schema.resolve_type( 768 self._arg_type_name, self.info, "event's 'data'") 769 if not isinstance(self.arg_type, QAPISchemaObjectType): 770 raise QAPISemError( 771 self.info, 772 "event's 'data' cannot take %s" 773 % self.arg_type.describe()) 774 if self.arg_type.variants and not self.boxed: 775 raise QAPISemError( 776 self.info, 777 "event's 'data' can take %s only with 'boxed': true" 778 % self.arg_type.describe()) 779 780 def connect_doc(self, doc=None): 781 super().connect_doc(doc) 782 doc = doc or self.doc 783 if doc: 784 if self.arg_type and self.arg_type.is_implicit(): 785 self.arg_type.connect_doc(doc) 786 787 def visit(self, visitor): 788 super().visit(visitor) 789 visitor.visit_event( 790 self.name, self.info, self.ifcond, self.features, 791 self.arg_type, self.boxed) 792 793 794class QAPISchema: 795 def __init__(self, fname): 796 self.fname = fname 797 parser = QAPISchemaParser(fname) 798 exprs = check_exprs(parser.exprs) 799 self.docs = parser.docs 800 self._entity_list = [] 801 self._entity_dict = {} 802 self._module_dict = OrderedDict() 803 self._schema_dir = os.path.dirname(fname) 804 self._make_module(None) # built-ins 805 self._make_module(fname) 806 self._predefining = True 807 self._def_predefineds() 808 self._predefining = False 809 self._def_exprs(exprs) 810 self.check() 811 812 def _def_entity(self, ent): 813 # Only the predefined types are allowed to not have info 814 assert ent.info or self._predefining 815 self._entity_list.append(ent) 816 if ent.name is None: 817 return 818 # TODO reject names that differ only in '_' vs. '.' vs. '-', 819 # because they're liable to clash in generated C. 820 other_ent = self._entity_dict.get(ent.name) 821 if other_ent: 822 if other_ent.info: 823 where = QAPIError(other_ent.info, None, "previous definition") 824 raise QAPISemError( 825 ent.info, 826 "'%s' is already defined\n%s" % (ent.name, where)) 827 raise QAPISemError( 828 ent.info, "%s is already defined" % other_ent.describe()) 829 self._entity_dict[ent.name] = ent 830 831 def lookup_entity(self, name, typ=None): 832 ent = self._entity_dict.get(name) 833 if typ and not isinstance(ent, typ): 834 return None 835 return ent 836 837 def lookup_type(self, name): 838 return self.lookup_entity(name, QAPISchemaType) 839 840 def resolve_type(self, name, info, what): 841 typ = self.lookup_type(name) 842 if not typ: 843 if callable(what): 844 what = what(info) 845 raise QAPISemError( 846 info, "%s uses unknown type '%s'" % (what, name)) 847 return typ 848 849 def _module_name(self, fname): 850 if fname is None: 851 return None 852 return os.path.relpath(fname, self._schema_dir) 853 854 def _make_module(self, fname): 855 name = self._module_name(fname) 856 if name not in self._module_dict: 857 self._module_dict[name] = QAPISchemaModule(name) 858 return self._module_dict[name] 859 860 def module_by_fname(self, fname): 861 name = self._module_name(fname) 862 assert name in self._module_dict 863 return self._module_dict[name] 864 865 def _def_include(self, expr, info, doc): 866 include = expr['include'] 867 assert doc is None 868 self._def_entity(QAPISchemaInclude(self._make_module(include), info)) 869 870 def _def_builtin_type(self, name, json_type, c_type): 871 self._def_entity(QAPISchemaBuiltinType(name, json_type, c_type)) 872 # Instantiating only the arrays that are actually used would 873 # be nice, but we can't as long as their generated code 874 # (qapi-builtin-types.[ch]) may be shared by some other 875 # schema. 876 self._make_array_type(name, None) 877 878 def _def_predefineds(self): 879 for t in [('str', 'string', 'char' + pointer_suffix), 880 ('number', 'number', 'double'), 881 ('int', 'int', 'int64_t'), 882 ('int8', 'int', 'int8_t'), 883 ('int16', 'int', 'int16_t'), 884 ('int32', 'int', 'int32_t'), 885 ('int64', 'int', 'int64_t'), 886 ('uint8', 'int', 'uint8_t'), 887 ('uint16', 'int', 'uint16_t'), 888 ('uint32', 'int', 'uint32_t'), 889 ('uint64', 'int', 'uint64_t'), 890 ('size', 'int', 'uint64_t'), 891 ('bool', 'boolean', 'bool'), 892 ('any', 'value', 'QObject' + pointer_suffix), 893 ('null', 'null', 'QNull' + pointer_suffix)]: 894 self._def_builtin_type(*t) 895 self.the_empty_object_type = QAPISchemaObjectType( 896 'q_empty', None, None, None, None, None, [], None) 897 self._def_entity(self.the_empty_object_type) 898 899 qtypes = ['none', 'qnull', 'qnum', 'qstring', 'qdict', 'qlist', 900 'qbool'] 901 qtype_values = self._make_enum_members( 902 [{'name': n} for n in qtypes], None) 903 904 self._def_entity(QAPISchemaEnumType('QType', None, None, None, None, 905 qtype_values, 'QTYPE')) 906 907 def _make_features(self, expr, info): 908 features = expr.get('features', []) 909 return [QAPISchemaFeature(f['name'], info, f.get('if')) 910 for f in features] 911 912 def _make_enum_members(self, values, info): 913 return [QAPISchemaEnumMember(v['name'], info, v.get('if')) 914 for v in values] 915 916 def _make_implicit_enum_type(self, name, info, ifcond, values): 917 # See also QAPISchemaObjectTypeMember.describe() 918 name = name + 'Kind' # reserved by check_defn_name_str() 919 self._def_entity(QAPISchemaEnumType( 920 name, info, None, ifcond, None, 921 self._make_enum_members(values, info), 922 None)) 923 return name 924 925 def _make_array_type(self, element_type, info): 926 name = element_type + 'List' # reserved by check_defn_name_str() 927 if not self.lookup_type(name): 928 self._def_entity(QAPISchemaArrayType(name, info, element_type)) 929 return name 930 931 def _make_implicit_object_type(self, name, info, ifcond, role, members): 932 if not members: 933 return None 934 # See also QAPISchemaObjectTypeMember.describe() 935 name = 'q_obj_%s-%s' % (name, role) 936 typ = self.lookup_entity(name, QAPISchemaObjectType) 937 if typ: 938 # The implicit object type has multiple users. This can 939 # happen only for simple unions' implicit wrapper types. 940 # Its ifcond should be the disjunction of its user's 941 # ifconds. Not implemented. Instead, we always pass the 942 # wrapped type's ifcond, which is trivially the same for all 943 # users. It's also necessary for the wrapper to compile. 944 # But it's not tight: the disjunction need not imply it. We 945 # may end up compiling useless wrapper types. 946 # TODO kill simple unions or implement the disjunction 947 assert (ifcond or []) == typ._ifcond # pylint: disable=protected-access 948 else: 949 self._def_entity(QAPISchemaObjectType( 950 name, info, None, ifcond, None, None, members, None)) 951 return name 952 953 def _def_enum_type(self, expr, info, doc): 954 name = expr['enum'] 955 data = expr['data'] 956 prefix = expr.get('prefix') 957 ifcond = expr.get('if') 958 features = self._make_features(expr, info) 959 self._def_entity(QAPISchemaEnumType( 960 name, info, doc, ifcond, features, 961 self._make_enum_members(data, info), prefix)) 962 963 def _make_member(self, name, typ, ifcond, info): 964 optional = False 965 if name.startswith('*'): 966 name = name[1:] 967 optional = True 968 if isinstance(typ, list): 969 assert len(typ) == 1 970 typ = self._make_array_type(typ[0], info) 971 return QAPISchemaObjectTypeMember(name, info, typ, optional, ifcond) 972 973 def _make_members(self, data, info): 974 return [self._make_member(key, value['type'], value.get('if'), info) 975 for (key, value) in data.items()] 976 977 def _def_struct_type(self, expr, info, doc): 978 name = expr['struct'] 979 base = expr.get('base') 980 data = expr['data'] 981 ifcond = expr.get('if') 982 features = self._make_features(expr, info) 983 self._def_entity(QAPISchemaObjectType( 984 name, info, doc, ifcond, features, base, 985 self._make_members(data, info), 986 None)) 987 988 def _make_variant(self, case, typ, ifcond, info): 989 return QAPISchemaObjectTypeVariant(case, info, typ, ifcond) 990 991 def _make_simple_variant(self, case, typ, ifcond, info): 992 if isinstance(typ, list): 993 assert len(typ) == 1 994 typ = self._make_array_type(typ[0], info) 995 typ = self._make_implicit_object_type( 996 typ, info, self.lookup_type(typ), 997 'wrapper', [self._make_member('data', typ, None, info)]) 998 return QAPISchemaObjectTypeVariant(case, info, typ, ifcond) 999 1000 def _def_union_type(self, expr, info, doc): 1001 name = expr['union'] 1002 data = expr['data'] 1003 base = expr.get('base') 1004 ifcond = expr.get('if') 1005 features = self._make_features(expr, info) 1006 tag_name = expr.get('discriminator') 1007 tag_member = None 1008 if isinstance(base, dict): 1009 base = self._make_implicit_object_type( 1010 name, info, ifcond, 1011 'base', self._make_members(base, info)) 1012 if tag_name: 1013 variants = [self._make_variant(key, value['type'], 1014 value.get('if'), info) 1015 for (key, value) in data.items()] 1016 members = [] 1017 else: 1018 variants = [self._make_simple_variant(key, value['type'], 1019 value.get('if'), info) 1020 for (key, value) in data.items()] 1021 enum = [{'name': v.name, 'if': v.ifcond} for v in variants] 1022 typ = self._make_implicit_enum_type(name, info, ifcond, enum) 1023 tag_member = QAPISchemaObjectTypeMember('type', info, typ, False) 1024 members = [tag_member] 1025 self._def_entity( 1026 QAPISchemaObjectType(name, info, doc, ifcond, features, 1027 base, members, 1028 QAPISchemaObjectTypeVariants( 1029 tag_name, info, tag_member, variants))) 1030 1031 def _def_alternate_type(self, expr, info, doc): 1032 name = expr['alternate'] 1033 data = expr['data'] 1034 ifcond = expr.get('if') 1035 features = self._make_features(expr, info) 1036 variants = [self._make_variant(key, value['type'], value.get('if'), 1037 info) 1038 for (key, value) in data.items()] 1039 tag_member = QAPISchemaObjectTypeMember('type', info, 'QType', False) 1040 self._def_entity( 1041 QAPISchemaAlternateType(name, info, doc, ifcond, features, 1042 QAPISchemaObjectTypeVariants( 1043 None, info, tag_member, variants))) 1044 1045 def _def_command(self, expr, info, doc): 1046 name = expr['command'] 1047 data = expr.get('data') 1048 rets = expr.get('returns') 1049 gen = expr.get('gen', True) 1050 success_response = expr.get('success-response', True) 1051 boxed = expr.get('boxed', False) 1052 allow_oob = expr.get('allow-oob', False) 1053 allow_preconfig = expr.get('allow-preconfig', False) 1054 ifcond = expr.get('if') 1055 features = self._make_features(expr, info) 1056 if isinstance(data, OrderedDict): 1057 data = self._make_implicit_object_type( 1058 name, info, ifcond, 1059 'arg', self._make_members(data, info)) 1060 if isinstance(rets, list): 1061 assert len(rets) == 1 1062 rets = self._make_array_type(rets[0], info) 1063 self._def_entity(QAPISchemaCommand(name, info, doc, ifcond, features, 1064 data, rets, 1065 gen, success_response, 1066 boxed, allow_oob, allow_preconfig)) 1067 1068 def _def_event(self, expr, info, doc): 1069 name = expr['event'] 1070 data = expr.get('data') 1071 boxed = expr.get('boxed', False) 1072 ifcond = expr.get('if') 1073 features = self._make_features(expr, info) 1074 if isinstance(data, OrderedDict): 1075 data = self._make_implicit_object_type( 1076 name, info, ifcond, 1077 'arg', self._make_members(data, info)) 1078 self._def_entity(QAPISchemaEvent(name, info, doc, ifcond, features, 1079 data, boxed)) 1080 1081 def _def_exprs(self, exprs): 1082 for expr_elem in exprs: 1083 expr = expr_elem['expr'] 1084 info = expr_elem['info'] 1085 doc = expr_elem.get('doc') 1086 if 'enum' in expr: 1087 self._def_enum_type(expr, info, doc) 1088 elif 'struct' in expr: 1089 self._def_struct_type(expr, info, doc) 1090 elif 'union' in expr: 1091 self._def_union_type(expr, info, doc) 1092 elif 'alternate' in expr: 1093 self._def_alternate_type(expr, info, doc) 1094 elif 'command' in expr: 1095 self._def_command(expr, info, doc) 1096 elif 'event' in expr: 1097 self._def_event(expr, info, doc) 1098 elif 'include' in expr: 1099 self._def_include(expr, info, doc) 1100 else: 1101 assert False 1102 1103 def check(self): 1104 for ent in self._entity_list: 1105 ent.check(self) 1106 ent.connect_doc() 1107 ent.check_doc() 1108 for ent in self._entity_list: 1109 ent.set_module(self) 1110 1111 def visit(self, visitor): 1112 visitor.visit_begin(self) 1113 for mod in self._module_dict.values(): 1114 mod.visit(visitor) 1115 visitor.visit_end() 1116