1 /* 2 * QEMU Object Model 3 * 4 * Copyright IBM, Corp. 2011 5 * 6 * Authors: 7 * Anthony Liguori <aliguori@us.ibm.com> 8 * 9 * This work is licensed under the terms of the GNU GPL, version 2 or later. 10 * See the COPYING file in the top-level directory. 11 */ 12 13 #include "qemu/osdep.h" 14 #include "hw/qdev-core.h" 15 #include "qapi/error.h" 16 #include "qom/object.h" 17 #include "qom/object_interfaces.h" 18 #include "qemu/cutils.h" 19 #include "qapi/visitor.h" 20 #include "qapi/string-input-visitor.h" 21 #include "qapi/string-output-visitor.h" 22 #include "qapi/qobject-input-visitor.h" 23 #include "qapi/forward-visitor.h" 24 #include "qapi/qapi-builtin-visit.h" 25 #include "qapi/qmp/qerror.h" 26 #include "qapi/qmp/qjson.h" 27 #include "trace.h" 28 29 /* TODO: replace QObject with a simpler visitor to avoid a dependency 30 * of the QOM core on QObject? */ 31 #include "qom/qom-qobject.h" 32 #include "qapi/qmp/qbool.h" 33 #include "qapi/qmp/qnum.h" 34 #include "qapi/qmp/qstring.h" 35 #include "qemu/error-report.h" 36 37 #define MAX_INTERFACES 32 38 39 typedef struct InterfaceImpl InterfaceImpl; 40 typedef struct TypeImpl TypeImpl; 41 42 struct InterfaceImpl 43 { 44 const char *typename; 45 }; 46 47 struct TypeImpl 48 { 49 const char *name; 50 51 size_t class_size; 52 53 size_t instance_size; 54 size_t instance_align; 55 56 void (*class_init)(ObjectClass *klass, void *data); 57 void (*class_base_init)(ObjectClass *klass, void *data); 58 59 void *class_data; 60 61 void (*instance_init)(Object *obj); 62 void (*instance_post_init)(Object *obj); 63 void (*instance_finalize)(Object *obj); 64 65 bool abstract; 66 67 const char *parent; 68 TypeImpl *parent_type; 69 70 ObjectClass *class; 71 72 int num_interfaces; 73 InterfaceImpl interfaces[MAX_INTERFACES]; 74 }; 75 76 static Type type_interface; 77 78 static GHashTable *type_table_get(void) 79 { 80 static GHashTable *type_table; 81 82 if (type_table == NULL) { 83 type_table = g_hash_table_new(g_str_hash, g_str_equal); 84 } 85 86 return type_table; 87 } 88 89 static bool enumerating_types; 90 91 static void type_table_add(TypeImpl *ti) 92 { 93 assert(!enumerating_types); 94 g_hash_table_insert(type_table_get(), (void *)ti->name, ti); 95 } 96 97 static TypeImpl *type_table_lookup(const char *name) 98 { 99 return g_hash_table_lookup(type_table_get(), name); 100 } 101 102 static TypeImpl *type_new(const TypeInfo *info) 103 { 104 TypeImpl *ti = g_malloc0(sizeof(*ti)); 105 int i; 106 107 g_assert(info->name != NULL); 108 109 if (type_table_lookup(info->name) != NULL) { 110 fprintf(stderr, "Registering `%s' which already exists\n", info->name); 111 abort(); 112 } 113 114 ti->name = g_strdup(info->name); 115 ti->parent = g_strdup(info->parent); 116 117 ti->class_size = info->class_size; 118 ti->instance_size = info->instance_size; 119 ti->instance_align = info->instance_align; 120 121 ti->class_init = info->class_init; 122 ti->class_base_init = info->class_base_init; 123 ti->class_data = info->class_data; 124 125 ti->instance_init = info->instance_init; 126 ti->instance_post_init = info->instance_post_init; 127 ti->instance_finalize = info->instance_finalize; 128 129 ti->abstract = info->abstract; 130 131 for (i = 0; info->interfaces && info->interfaces[i].type; i++) { 132 ti->interfaces[i].typename = g_strdup(info->interfaces[i].type); 133 } 134 ti->num_interfaces = i; 135 136 return ti; 137 } 138 139 static TypeImpl *type_register_internal(const TypeInfo *info) 140 { 141 TypeImpl *ti; 142 ti = type_new(info); 143 144 type_table_add(ti); 145 return ti; 146 } 147 148 TypeImpl *type_register(const TypeInfo *info) 149 { 150 assert(info->parent); 151 return type_register_internal(info); 152 } 153 154 TypeImpl *type_register_static(const TypeInfo *info) 155 { 156 return type_register(info); 157 } 158 159 void type_register_static_array(const TypeInfo *infos, int nr_infos) 160 { 161 int i; 162 163 for (i = 0; i < nr_infos; i++) { 164 type_register_static(&infos[i]); 165 } 166 } 167 168 static TypeImpl *type_get_by_name(const char *name) 169 { 170 if (name == NULL) { 171 return NULL; 172 } 173 174 return type_table_lookup(name); 175 } 176 177 static TypeImpl *type_get_parent(TypeImpl *type) 178 { 179 if (!type->parent_type && type->parent) { 180 type->parent_type = type_get_by_name(type->parent); 181 if (!type->parent_type) { 182 fprintf(stderr, "Type '%s' is missing its parent '%s'\n", 183 type->name, type->parent); 184 abort(); 185 } 186 } 187 188 return type->parent_type; 189 } 190 191 static bool type_has_parent(TypeImpl *type) 192 { 193 return (type->parent != NULL); 194 } 195 196 static size_t type_class_get_size(TypeImpl *ti) 197 { 198 if (ti->class_size) { 199 return ti->class_size; 200 } 201 202 if (type_has_parent(ti)) { 203 return type_class_get_size(type_get_parent(ti)); 204 } 205 206 return sizeof(ObjectClass); 207 } 208 209 static size_t type_object_get_size(TypeImpl *ti) 210 { 211 if (ti->instance_size) { 212 return ti->instance_size; 213 } 214 215 if (type_has_parent(ti)) { 216 return type_object_get_size(type_get_parent(ti)); 217 } 218 219 return 0; 220 } 221 222 size_t object_type_get_instance_size(const char *typename) 223 { 224 TypeImpl *type = type_get_by_name(typename); 225 226 g_assert(type != NULL); 227 return type_object_get_size(type); 228 } 229 230 static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type) 231 { 232 assert(target_type); 233 234 /* Check if target_type is a direct ancestor of type */ 235 while (type) { 236 if (type == target_type) { 237 return true; 238 } 239 240 type = type_get_parent(type); 241 } 242 243 return false; 244 } 245 246 static void type_initialize(TypeImpl *ti); 247 248 static void type_initialize_interface(TypeImpl *ti, TypeImpl *interface_type, 249 TypeImpl *parent_type) 250 { 251 InterfaceClass *new_iface; 252 TypeInfo info = { }; 253 TypeImpl *iface_impl; 254 255 info.parent = parent_type->name; 256 info.name = g_strdup_printf("%s::%s", ti->name, interface_type->name); 257 info.abstract = true; 258 259 iface_impl = type_new(&info); 260 iface_impl->parent_type = parent_type; 261 type_initialize(iface_impl); 262 g_free((char *)info.name); 263 264 new_iface = (InterfaceClass *)iface_impl->class; 265 new_iface->concrete_class = ti->class; 266 new_iface->interface_type = interface_type; 267 268 ti->class->interfaces = g_slist_append(ti->class->interfaces, new_iface); 269 } 270 271 static void object_property_free(gpointer data) 272 { 273 ObjectProperty *prop = data; 274 275 if (prop->defval) { 276 qobject_unref(prop->defval); 277 prop->defval = NULL; 278 } 279 g_free(prop->name); 280 g_free(prop->type); 281 g_free(prop->description); 282 g_free(prop); 283 } 284 285 static void type_initialize(TypeImpl *ti) 286 { 287 TypeImpl *parent; 288 289 if (ti->class) { 290 return; 291 } 292 293 ti->class_size = type_class_get_size(ti); 294 ti->instance_size = type_object_get_size(ti); 295 /* Any type with zero instance_size is implicitly abstract. 296 * This means interface types are all abstract. 297 */ 298 if (ti->instance_size == 0) { 299 ti->abstract = true; 300 } 301 if (type_is_ancestor(ti, type_interface)) { 302 assert(ti->instance_size == 0); 303 assert(ti->abstract); 304 assert(!ti->instance_init); 305 assert(!ti->instance_post_init); 306 assert(!ti->instance_finalize); 307 assert(!ti->num_interfaces); 308 } 309 ti->class = g_malloc0(ti->class_size); 310 311 parent = type_get_parent(ti); 312 if (parent) { 313 type_initialize(parent); 314 GSList *e; 315 int i; 316 317 g_assert(parent->class_size <= ti->class_size); 318 g_assert(parent->instance_size <= ti->instance_size); 319 memcpy(ti->class, parent->class, parent->class_size); 320 ti->class->interfaces = NULL; 321 322 for (e = parent->class->interfaces; e; e = e->next) { 323 InterfaceClass *iface = e->data; 324 ObjectClass *klass = OBJECT_CLASS(iface); 325 326 type_initialize_interface(ti, iface->interface_type, klass->type); 327 } 328 329 for (i = 0; i < ti->num_interfaces; i++) { 330 TypeImpl *t = type_get_by_name(ti->interfaces[i].typename); 331 if (!t) { 332 error_report("missing interface '%s' for object '%s'", 333 ti->interfaces[i].typename, parent->name); 334 abort(); 335 } 336 for (e = ti->class->interfaces; e; e = e->next) { 337 TypeImpl *target_type = OBJECT_CLASS(e->data)->type; 338 339 if (type_is_ancestor(target_type, t)) { 340 break; 341 } 342 } 343 344 if (e) { 345 continue; 346 } 347 348 type_initialize_interface(ti, t, t); 349 } 350 } 351 352 ti->class->properties = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, 353 object_property_free); 354 355 ti->class->type = ti; 356 357 while (parent) { 358 if (parent->class_base_init) { 359 parent->class_base_init(ti->class, ti->class_data); 360 } 361 parent = type_get_parent(parent); 362 } 363 364 if (ti->class_init) { 365 ti->class_init(ti->class, ti->class_data); 366 } 367 } 368 369 static void object_init_with_type(Object *obj, TypeImpl *ti) 370 { 371 if (type_has_parent(ti)) { 372 object_init_with_type(obj, type_get_parent(ti)); 373 } 374 375 if (ti->instance_init) { 376 ti->instance_init(obj); 377 } 378 } 379 380 static void object_post_init_with_type(Object *obj, TypeImpl *ti) 381 { 382 if (ti->instance_post_init) { 383 ti->instance_post_init(obj); 384 } 385 386 if (type_has_parent(ti)) { 387 object_post_init_with_type(obj, type_get_parent(ti)); 388 } 389 } 390 391 bool object_apply_global_props(Object *obj, const GPtrArray *props, 392 Error **errp) 393 { 394 int i; 395 396 if (!props) { 397 return true; 398 } 399 400 for (i = 0; i < props->len; i++) { 401 GlobalProperty *p = g_ptr_array_index(props, i); 402 Error *err = NULL; 403 404 if (object_dynamic_cast(obj, p->driver) == NULL) { 405 continue; 406 } 407 if (p->optional && !object_property_find(obj, p->property)) { 408 continue; 409 } 410 p->used = true; 411 if (!object_property_parse(obj, p->property, p->value, &err)) { 412 error_prepend(&err, "can't apply global %s.%s=%s: ", 413 p->driver, p->property, p->value); 414 /* 415 * If errp != NULL, propagate error and return. 416 * If errp == NULL, report a warning, but keep going 417 * with the remaining globals. 418 */ 419 if (errp) { 420 error_propagate(errp, err); 421 return false; 422 } else { 423 warn_report_err(err); 424 } 425 } 426 } 427 428 return true; 429 } 430 431 /* 432 * Global property defaults 433 * Slot 0: accelerator's global property defaults 434 * Slot 1: machine's global property defaults 435 * Slot 2: global properties from legacy command line option 436 * Each is a GPtrArray of of GlobalProperty. 437 * Applied in order, later entries override earlier ones. 438 */ 439 static GPtrArray *object_compat_props[3]; 440 441 /* 442 * Retrieve @GPtrArray for global property defined with options 443 * other than "-global". These are generally used for syntactic 444 * sugar and legacy command line options. 445 */ 446 void object_register_sugar_prop(const char *driver, const char *prop, 447 const char *value, bool optional) 448 { 449 GlobalProperty *g; 450 if (!object_compat_props[2]) { 451 object_compat_props[2] = g_ptr_array_new(); 452 } 453 g = g_new0(GlobalProperty, 1); 454 g->driver = g_strdup(driver); 455 g->property = g_strdup(prop); 456 g->value = g_strdup(value); 457 g->optional = optional; 458 g_ptr_array_add(object_compat_props[2], g); 459 } 460 461 /* 462 * Set machine's global property defaults to @compat_props. 463 * May be called at most once. 464 */ 465 void object_set_machine_compat_props(GPtrArray *compat_props) 466 { 467 assert(!object_compat_props[1]); 468 object_compat_props[1] = compat_props; 469 } 470 471 /* 472 * Set accelerator's global property defaults to @compat_props. 473 * May be called at most once. 474 */ 475 void object_set_accelerator_compat_props(GPtrArray *compat_props) 476 { 477 assert(!object_compat_props[0]); 478 object_compat_props[0] = compat_props; 479 } 480 481 void object_apply_compat_props(Object *obj) 482 { 483 int i; 484 485 for (i = 0; i < ARRAY_SIZE(object_compat_props); i++) { 486 object_apply_global_props(obj, object_compat_props[i], 487 i == 2 ? &error_fatal : &error_abort); 488 } 489 } 490 491 static void object_class_property_init_all(Object *obj) 492 { 493 ObjectPropertyIterator iter; 494 ObjectProperty *prop; 495 496 object_class_property_iter_init(&iter, object_get_class(obj)); 497 while ((prop = object_property_iter_next(&iter))) { 498 if (prop->init) { 499 prop->init(obj, prop); 500 } 501 } 502 } 503 504 static void object_initialize_with_type(Object *obj, size_t size, TypeImpl *type) 505 { 506 type_initialize(type); 507 508 g_assert(type->instance_size >= sizeof(Object)); 509 g_assert(type->abstract == false); 510 g_assert(size >= type->instance_size); 511 512 memset(obj, 0, type->instance_size); 513 obj->class = type->class; 514 object_ref(obj); 515 object_class_property_init_all(obj); 516 obj->properties = g_hash_table_new_full(g_str_hash, g_str_equal, 517 NULL, object_property_free); 518 object_init_with_type(obj, type); 519 object_post_init_with_type(obj, type); 520 } 521 522 void object_initialize(void *data, size_t size, const char *typename) 523 { 524 TypeImpl *type = type_get_by_name(typename); 525 526 #ifdef CONFIG_MODULES 527 if (!type) { 528 module_load_qom_one(typename); 529 type = type_get_by_name(typename); 530 } 531 #endif 532 if (!type) { 533 error_report("missing object type '%s'", typename); 534 abort(); 535 } 536 537 object_initialize_with_type(data, size, type); 538 } 539 540 bool object_initialize_child_with_props(Object *parentobj, 541 const char *propname, 542 void *childobj, size_t size, 543 const char *type, 544 Error **errp, ...) 545 { 546 va_list vargs; 547 bool ok; 548 549 va_start(vargs, errp); 550 ok = object_initialize_child_with_propsv(parentobj, propname, 551 childobj, size, type, errp, 552 vargs); 553 va_end(vargs); 554 return ok; 555 } 556 557 bool object_initialize_child_with_propsv(Object *parentobj, 558 const char *propname, 559 void *childobj, size_t size, 560 const char *type, 561 Error **errp, va_list vargs) 562 { 563 bool ok = false; 564 Object *obj; 565 UserCreatable *uc; 566 567 object_initialize(childobj, size, type); 568 obj = OBJECT(childobj); 569 570 if (!object_set_propv(obj, errp, vargs)) { 571 goto out; 572 } 573 574 object_property_add_child(parentobj, propname, obj); 575 576 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE); 577 if (uc) { 578 if (!user_creatable_complete(uc, errp)) { 579 object_unparent(obj); 580 goto out; 581 } 582 } 583 584 ok = true; 585 586 out: 587 /* 588 * We want @obj's reference to be 1 on success, 0 on failure. 589 * On success, it's 2: one taken by object_initialize(), and one 590 * by object_property_add_child(). 591 * On failure in object_initialize() or earlier, it's 1. 592 * On failure afterwards, it's also 1: object_unparent() releases 593 * the reference taken by object_property_add_child(). 594 */ 595 object_unref(obj); 596 return ok; 597 } 598 599 void object_initialize_child_internal(Object *parent, 600 const char *propname, 601 void *child, size_t size, 602 const char *type) 603 { 604 object_initialize_child_with_props(parent, propname, child, size, type, 605 &error_abort, NULL); 606 } 607 608 static inline bool object_property_is_child(ObjectProperty *prop) 609 { 610 return strstart(prop->type, "child<", NULL); 611 } 612 613 static void object_property_del_all(Object *obj) 614 { 615 g_autoptr(GHashTable) done = g_hash_table_new(NULL, NULL); 616 ObjectProperty *prop; 617 ObjectPropertyIterator iter; 618 bool released; 619 620 do { 621 released = false; 622 object_property_iter_init(&iter, obj); 623 while ((prop = object_property_iter_next(&iter)) != NULL) { 624 if (g_hash_table_add(done, prop)) { 625 if (prop->release) { 626 prop->release(obj, prop->name, prop->opaque); 627 released = true; 628 break; 629 } 630 } 631 } 632 } while (released); 633 634 g_hash_table_unref(obj->properties); 635 } 636 637 static void object_property_del_child(Object *obj, Object *child) 638 { 639 ObjectProperty *prop; 640 GHashTableIter iter; 641 gpointer key, value; 642 643 g_hash_table_iter_init(&iter, obj->properties); 644 while (g_hash_table_iter_next(&iter, &key, &value)) { 645 prop = value; 646 if (object_property_is_child(prop) && prop->opaque == child) { 647 if (prop->release) { 648 prop->release(obj, prop->name, prop->opaque); 649 prop->release = NULL; 650 } 651 break; 652 } 653 } 654 g_hash_table_iter_init(&iter, obj->properties); 655 while (g_hash_table_iter_next(&iter, &key, &value)) { 656 prop = value; 657 if (object_property_is_child(prop) && prop->opaque == child) { 658 g_hash_table_iter_remove(&iter); 659 break; 660 } 661 } 662 } 663 664 void object_unparent(Object *obj) 665 { 666 if (obj->parent) { 667 object_property_del_child(obj->parent, obj); 668 } 669 } 670 671 static void object_deinit(Object *obj, TypeImpl *type) 672 { 673 if (type->instance_finalize) { 674 type->instance_finalize(obj); 675 } 676 677 if (type_has_parent(type)) { 678 object_deinit(obj, type_get_parent(type)); 679 } 680 } 681 682 static void object_finalize(void *data) 683 { 684 Object *obj = data; 685 TypeImpl *ti = obj->class->type; 686 687 object_property_del_all(obj); 688 object_deinit(obj, ti); 689 690 g_assert(obj->ref == 0); 691 g_assert(obj->parent == NULL); 692 if (obj->free) { 693 obj->free(obj); 694 } 695 } 696 697 /* Find the minimum alignment guaranteed by the system malloc. */ 698 #if __STDC_VERSION__ >= 201112L 699 typedef max_align_t qemu_max_align_t; 700 #else 701 typedef union { 702 long l; 703 void *p; 704 double d; 705 long double ld; 706 } qemu_max_align_t; 707 #endif 708 709 static Object *object_new_with_type(Type type) 710 { 711 Object *obj; 712 size_t size, align; 713 void (*obj_free)(void *); 714 715 g_assert(type != NULL); 716 type_initialize(type); 717 718 size = type->instance_size; 719 align = type->instance_align; 720 721 /* 722 * Do not use qemu_memalign unless required. Depending on the 723 * implementation, extra alignment implies extra overhead. 724 */ 725 if (likely(align <= __alignof__(qemu_max_align_t))) { 726 obj = g_malloc(size); 727 obj_free = g_free; 728 } else { 729 obj = qemu_memalign(align, size); 730 obj_free = qemu_vfree; 731 } 732 733 object_initialize_with_type(obj, size, type); 734 obj->free = obj_free; 735 736 return obj; 737 } 738 739 Object *object_new_with_class(ObjectClass *klass) 740 { 741 return object_new_with_type(klass->type); 742 } 743 744 Object *object_new(const char *typename) 745 { 746 TypeImpl *ti = type_get_by_name(typename); 747 748 return object_new_with_type(ti); 749 } 750 751 752 Object *object_new_with_props(const char *typename, 753 Object *parent, 754 const char *id, 755 Error **errp, 756 ...) 757 { 758 va_list vargs; 759 Object *obj; 760 761 va_start(vargs, errp); 762 obj = object_new_with_propv(typename, parent, id, errp, vargs); 763 va_end(vargs); 764 765 return obj; 766 } 767 768 769 Object *object_new_with_propv(const char *typename, 770 Object *parent, 771 const char *id, 772 Error **errp, 773 va_list vargs) 774 { 775 Object *obj; 776 ObjectClass *klass; 777 UserCreatable *uc; 778 779 klass = object_class_by_name(typename); 780 if (!klass) { 781 error_setg(errp, "invalid object type: %s", typename); 782 return NULL; 783 } 784 785 if (object_class_is_abstract(klass)) { 786 error_setg(errp, "object type '%s' is abstract", typename); 787 return NULL; 788 } 789 obj = object_new_with_type(klass->type); 790 791 if (!object_set_propv(obj, errp, vargs)) { 792 goto error; 793 } 794 795 if (id != NULL) { 796 object_property_add_child(parent, id, obj); 797 } 798 799 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE); 800 if (uc) { 801 if (!user_creatable_complete(uc, errp)) { 802 if (id != NULL) { 803 object_unparent(obj); 804 } 805 goto error; 806 } 807 } 808 809 object_unref(obj); 810 return obj; 811 812 error: 813 object_unref(obj); 814 return NULL; 815 } 816 817 818 bool object_set_props(Object *obj, 819 Error **errp, 820 ...) 821 { 822 va_list vargs; 823 bool ret; 824 825 va_start(vargs, errp); 826 ret = object_set_propv(obj, errp, vargs); 827 va_end(vargs); 828 829 return ret; 830 } 831 832 833 bool object_set_propv(Object *obj, 834 Error **errp, 835 va_list vargs) 836 { 837 const char *propname; 838 839 propname = va_arg(vargs, char *); 840 while (propname != NULL) { 841 const char *value = va_arg(vargs, char *); 842 843 g_assert(value != NULL); 844 if (!object_property_parse(obj, propname, value, errp)) { 845 return false; 846 } 847 propname = va_arg(vargs, char *); 848 } 849 850 return true; 851 } 852 853 854 Object *object_dynamic_cast(Object *obj, const char *typename) 855 { 856 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) { 857 return obj; 858 } 859 860 return NULL; 861 } 862 863 Object *object_dynamic_cast_assert(Object *obj, const char *typename, 864 const char *file, int line, const char *func) 865 { 866 trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)", 867 typename, file, line, func); 868 869 #ifdef CONFIG_QOM_CAST_DEBUG 870 int i; 871 Object *inst; 872 873 for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) { 874 if (qatomic_read(&obj->class->object_cast_cache[i]) == typename) { 875 goto out; 876 } 877 } 878 879 inst = object_dynamic_cast(obj, typename); 880 881 if (!inst && obj) { 882 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n", 883 file, line, func, obj, typename); 884 abort(); 885 } 886 887 assert(obj == inst); 888 889 if (obj && obj == inst) { 890 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) { 891 qatomic_set(&obj->class->object_cast_cache[i - 1], 892 qatomic_read(&obj->class->object_cast_cache[i])); 893 } 894 qatomic_set(&obj->class->object_cast_cache[i - 1], typename); 895 } 896 897 out: 898 #endif 899 return obj; 900 } 901 902 ObjectClass *object_class_dynamic_cast(ObjectClass *class, 903 const char *typename) 904 { 905 ObjectClass *ret = NULL; 906 TypeImpl *target_type; 907 TypeImpl *type; 908 909 if (!class) { 910 return NULL; 911 } 912 913 /* A simple fast path that can trigger a lot for leaf classes. */ 914 type = class->type; 915 if (type->name == typename) { 916 return class; 917 } 918 919 target_type = type_get_by_name(typename); 920 if (!target_type) { 921 /* target class type unknown, so fail the cast */ 922 return NULL; 923 } 924 925 if (type->class->interfaces && 926 type_is_ancestor(target_type, type_interface)) { 927 int found = 0; 928 GSList *i; 929 930 for (i = class->interfaces; i; i = i->next) { 931 ObjectClass *target_class = i->data; 932 933 if (type_is_ancestor(target_class->type, target_type)) { 934 ret = target_class; 935 found++; 936 } 937 } 938 939 /* The match was ambiguous, don't allow a cast */ 940 if (found > 1) { 941 ret = NULL; 942 } 943 } else if (type_is_ancestor(type, target_type)) { 944 ret = class; 945 } 946 947 return ret; 948 } 949 950 ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class, 951 const char *typename, 952 const char *file, int line, 953 const char *func) 954 { 955 ObjectClass *ret; 956 957 trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)", 958 typename, file, line, func); 959 960 #ifdef CONFIG_QOM_CAST_DEBUG 961 int i; 962 963 for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) { 964 if (qatomic_read(&class->class_cast_cache[i]) == typename) { 965 ret = class; 966 goto out; 967 } 968 } 969 #else 970 if (!class || !class->interfaces) { 971 return class; 972 } 973 #endif 974 975 ret = object_class_dynamic_cast(class, typename); 976 if (!ret && class) { 977 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n", 978 file, line, func, class, typename); 979 abort(); 980 } 981 982 #ifdef CONFIG_QOM_CAST_DEBUG 983 if (class && ret == class) { 984 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) { 985 qatomic_set(&class->class_cast_cache[i - 1], 986 qatomic_read(&class->class_cast_cache[i])); 987 } 988 qatomic_set(&class->class_cast_cache[i - 1], typename); 989 } 990 out: 991 #endif 992 return ret; 993 } 994 995 const char *object_get_typename(const Object *obj) 996 { 997 return obj->class->type->name; 998 } 999 1000 ObjectClass *object_get_class(Object *obj) 1001 { 1002 return obj->class; 1003 } 1004 1005 bool object_class_is_abstract(ObjectClass *klass) 1006 { 1007 return klass->type->abstract; 1008 } 1009 1010 const char *object_class_get_name(ObjectClass *klass) 1011 { 1012 return klass->type->name; 1013 } 1014 1015 ObjectClass *object_class_by_name(const char *typename) 1016 { 1017 TypeImpl *type = type_get_by_name(typename); 1018 1019 if (!type) { 1020 return NULL; 1021 } 1022 1023 type_initialize(type); 1024 1025 return type->class; 1026 } 1027 1028 ObjectClass *module_object_class_by_name(const char *typename) 1029 { 1030 ObjectClass *oc; 1031 1032 oc = object_class_by_name(typename); 1033 #ifdef CONFIG_MODULES 1034 if (!oc) { 1035 module_load_qom_one(typename); 1036 oc = object_class_by_name(typename); 1037 } 1038 #endif 1039 return oc; 1040 } 1041 1042 ObjectClass *object_class_get_parent(ObjectClass *class) 1043 { 1044 TypeImpl *type = type_get_parent(class->type); 1045 1046 if (!type) { 1047 return NULL; 1048 } 1049 1050 type_initialize(type); 1051 1052 return type->class; 1053 } 1054 1055 typedef struct OCFData 1056 { 1057 void (*fn)(ObjectClass *klass, void *opaque); 1058 const char *implements_type; 1059 bool include_abstract; 1060 void *opaque; 1061 } OCFData; 1062 1063 static void object_class_foreach_tramp(gpointer key, gpointer value, 1064 gpointer opaque) 1065 { 1066 OCFData *data = opaque; 1067 TypeImpl *type = value; 1068 ObjectClass *k; 1069 1070 type_initialize(type); 1071 k = type->class; 1072 1073 if (!data->include_abstract && type->abstract) { 1074 return; 1075 } 1076 1077 if (data->implements_type && 1078 !object_class_dynamic_cast(k, data->implements_type)) { 1079 return; 1080 } 1081 1082 data->fn(k, data->opaque); 1083 } 1084 1085 void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque), 1086 const char *implements_type, bool include_abstract, 1087 void *opaque) 1088 { 1089 OCFData data = { fn, implements_type, include_abstract, opaque }; 1090 1091 enumerating_types = true; 1092 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data); 1093 enumerating_types = false; 1094 } 1095 1096 static int do_object_child_foreach(Object *obj, 1097 int (*fn)(Object *child, void *opaque), 1098 void *opaque, bool recurse) 1099 { 1100 GHashTableIter iter; 1101 ObjectProperty *prop; 1102 int ret = 0; 1103 1104 g_hash_table_iter_init(&iter, obj->properties); 1105 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) { 1106 if (object_property_is_child(prop)) { 1107 Object *child = prop->opaque; 1108 1109 ret = fn(child, opaque); 1110 if (ret != 0) { 1111 break; 1112 } 1113 if (recurse) { 1114 ret = do_object_child_foreach(child, fn, opaque, true); 1115 if (ret != 0) { 1116 break; 1117 } 1118 } 1119 } 1120 } 1121 return ret; 1122 } 1123 1124 int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque), 1125 void *opaque) 1126 { 1127 return do_object_child_foreach(obj, fn, opaque, false); 1128 } 1129 1130 int object_child_foreach_recursive(Object *obj, 1131 int (*fn)(Object *child, void *opaque), 1132 void *opaque) 1133 { 1134 return do_object_child_foreach(obj, fn, opaque, true); 1135 } 1136 1137 static void object_class_get_list_tramp(ObjectClass *klass, void *opaque) 1138 { 1139 GSList **list = opaque; 1140 1141 *list = g_slist_prepend(*list, klass); 1142 } 1143 1144 GSList *object_class_get_list(const char *implements_type, 1145 bool include_abstract) 1146 { 1147 GSList *list = NULL; 1148 1149 object_class_foreach(object_class_get_list_tramp, 1150 implements_type, include_abstract, &list); 1151 return list; 1152 } 1153 1154 static gint object_class_cmp(gconstpointer a, gconstpointer b) 1155 { 1156 return strcasecmp(object_class_get_name((ObjectClass *)a), 1157 object_class_get_name((ObjectClass *)b)); 1158 } 1159 1160 GSList *object_class_get_list_sorted(const char *implements_type, 1161 bool include_abstract) 1162 { 1163 return g_slist_sort(object_class_get_list(implements_type, include_abstract), 1164 object_class_cmp); 1165 } 1166 1167 Object *object_ref(void *objptr) 1168 { 1169 Object *obj = OBJECT(objptr); 1170 if (!obj) { 1171 return NULL; 1172 } 1173 qatomic_inc(&obj->ref); 1174 return obj; 1175 } 1176 1177 void object_unref(void *objptr) 1178 { 1179 Object *obj = OBJECT(objptr); 1180 if (!obj) { 1181 return; 1182 } 1183 g_assert(obj->ref > 0); 1184 1185 /* parent always holds a reference to its children */ 1186 if (qatomic_fetch_dec(&obj->ref) == 1) { 1187 object_finalize(obj); 1188 } 1189 } 1190 1191 ObjectProperty * 1192 object_property_try_add(Object *obj, const char *name, const char *type, 1193 ObjectPropertyAccessor *get, 1194 ObjectPropertyAccessor *set, 1195 ObjectPropertyRelease *release, 1196 void *opaque, Error **errp) 1197 { 1198 ObjectProperty *prop; 1199 size_t name_len = strlen(name); 1200 1201 if (name_len >= 3 && !memcmp(name + name_len - 3, "[*]", 4)) { 1202 int i; 1203 ObjectProperty *ret = NULL; 1204 char *name_no_array = g_strdup(name); 1205 1206 name_no_array[name_len - 3] = '\0'; 1207 for (i = 0; i < INT16_MAX; ++i) { 1208 char *full_name = g_strdup_printf("%s[%d]", name_no_array, i); 1209 1210 ret = object_property_try_add(obj, full_name, type, get, set, 1211 release, opaque, NULL); 1212 g_free(full_name); 1213 if (ret) { 1214 break; 1215 } 1216 } 1217 g_free(name_no_array); 1218 assert(ret); 1219 return ret; 1220 } 1221 1222 if (object_property_find(obj, name) != NULL) { 1223 error_setg(errp, "attempt to add duplicate property '%s' to object (type '%s')", 1224 name, object_get_typename(obj)); 1225 return NULL; 1226 } 1227 1228 prop = g_malloc0(sizeof(*prop)); 1229 1230 prop->name = g_strdup(name); 1231 prop->type = g_strdup(type); 1232 1233 prop->get = get; 1234 prop->set = set; 1235 prop->release = release; 1236 prop->opaque = opaque; 1237 1238 g_hash_table_insert(obj->properties, prop->name, prop); 1239 return prop; 1240 } 1241 1242 ObjectProperty * 1243 object_property_add(Object *obj, const char *name, const char *type, 1244 ObjectPropertyAccessor *get, 1245 ObjectPropertyAccessor *set, 1246 ObjectPropertyRelease *release, 1247 void *opaque) 1248 { 1249 return object_property_try_add(obj, name, type, get, set, release, 1250 opaque, &error_abort); 1251 } 1252 1253 ObjectProperty * 1254 object_class_property_add(ObjectClass *klass, 1255 const char *name, 1256 const char *type, 1257 ObjectPropertyAccessor *get, 1258 ObjectPropertyAccessor *set, 1259 ObjectPropertyRelease *release, 1260 void *opaque) 1261 { 1262 ObjectProperty *prop; 1263 1264 assert(!object_class_property_find(klass, name)); 1265 1266 prop = g_malloc0(sizeof(*prop)); 1267 1268 prop->name = g_strdup(name); 1269 prop->type = g_strdup(type); 1270 1271 prop->get = get; 1272 prop->set = set; 1273 prop->release = release; 1274 prop->opaque = opaque; 1275 1276 g_hash_table_insert(klass->properties, prop->name, prop); 1277 1278 return prop; 1279 } 1280 1281 ObjectProperty *object_property_find(Object *obj, const char *name) 1282 { 1283 ObjectProperty *prop; 1284 ObjectClass *klass = object_get_class(obj); 1285 1286 prop = object_class_property_find(klass, name); 1287 if (prop) { 1288 return prop; 1289 } 1290 1291 return g_hash_table_lookup(obj->properties, name); 1292 } 1293 1294 ObjectProperty *object_property_find_err(Object *obj, const char *name, 1295 Error **errp) 1296 { 1297 ObjectProperty *prop = object_property_find(obj, name); 1298 if (!prop) { 1299 error_setg(errp, "Property '%s.%s' not found", 1300 object_get_typename(obj), name); 1301 } 1302 return prop; 1303 } 1304 1305 void object_property_iter_init(ObjectPropertyIterator *iter, 1306 Object *obj) 1307 { 1308 g_hash_table_iter_init(&iter->iter, obj->properties); 1309 iter->nextclass = object_get_class(obj); 1310 } 1311 1312 ObjectProperty *object_property_iter_next(ObjectPropertyIterator *iter) 1313 { 1314 gpointer key, val; 1315 while (!g_hash_table_iter_next(&iter->iter, &key, &val)) { 1316 if (!iter->nextclass) { 1317 return NULL; 1318 } 1319 g_hash_table_iter_init(&iter->iter, iter->nextclass->properties); 1320 iter->nextclass = object_class_get_parent(iter->nextclass); 1321 } 1322 return val; 1323 } 1324 1325 void object_class_property_iter_init(ObjectPropertyIterator *iter, 1326 ObjectClass *klass) 1327 { 1328 g_hash_table_iter_init(&iter->iter, klass->properties); 1329 iter->nextclass = object_class_get_parent(klass); 1330 } 1331 1332 ObjectProperty *object_class_property_find(ObjectClass *klass, const char *name) 1333 { 1334 ObjectClass *parent_klass; 1335 1336 parent_klass = object_class_get_parent(klass); 1337 if (parent_klass) { 1338 ObjectProperty *prop = 1339 object_class_property_find(parent_klass, name); 1340 if (prop) { 1341 return prop; 1342 } 1343 } 1344 1345 return g_hash_table_lookup(klass->properties, name); 1346 } 1347 1348 ObjectProperty *object_class_property_find_err(ObjectClass *klass, 1349 const char *name, 1350 Error **errp) 1351 { 1352 ObjectProperty *prop = object_class_property_find(klass, name); 1353 if (!prop) { 1354 error_setg(errp, "Property '.%s' not found", name); 1355 } 1356 return prop; 1357 } 1358 1359 1360 void object_property_del(Object *obj, const char *name) 1361 { 1362 ObjectProperty *prop = g_hash_table_lookup(obj->properties, name); 1363 1364 if (prop->release) { 1365 prop->release(obj, name, prop->opaque); 1366 } 1367 g_hash_table_remove(obj->properties, name); 1368 } 1369 1370 bool object_property_get(Object *obj, const char *name, Visitor *v, 1371 Error **errp) 1372 { 1373 Error *err = NULL; 1374 ObjectProperty *prop = object_property_find_err(obj, name, errp); 1375 1376 if (prop == NULL) { 1377 return false; 1378 } 1379 1380 if (!prop->get) { 1381 error_setg(errp, QERR_PERMISSION_DENIED); 1382 return false; 1383 } 1384 prop->get(obj, v, name, prop->opaque, &err); 1385 error_propagate(errp, err); 1386 return !err; 1387 } 1388 1389 bool object_property_set(Object *obj, const char *name, Visitor *v, 1390 Error **errp) 1391 { 1392 ERRP_GUARD(); 1393 ObjectProperty *prop = object_property_find_err(obj, name, errp); 1394 1395 if (prop == NULL) { 1396 return false; 1397 } 1398 1399 if (!prop->set) { 1400 error_setg(errp, QERR_PERMISSION_DENIED); 1401 return false; 1402 } 1403 prop->set(obj, v, name, prop->opaque, errp); 1404 return !*errp; 1405 } 1406 1407 bool object_property_set_str(Object *obj, const char *name, 1408 const char *value, Error **errp) 1409 { 1410 QString *qstr = qstring_from_str(value); 1411 bool ok = object_property_set_qobject(obj, name, QOBJECT(qstr), errp); 1412 1413 qobject_unref(qstr); 1414 return ok; 1415 } 1416 1417 char *object_property_get_str(Object *obj, const char *name, 1418 Error **errp) 1419 { 1420 QObject *ret = object_property_get_qobject(obj, name, errp); 1421 QString *qstring; 1422 char *retval; 1423 1424 if (!ret) { 1425 return NULL; 1426 } 1427 qstring = qobject_to(QString, ret); 1428 if (!qstring) { 1429 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "string"); 1430 retval = NULL; 1431 } else { 1432 retval = g_strdup(qstring_get_str(qstring)); 1433 } 1434 1435 qobject_unref(ret); 1436 return retval; 1437 } 1438 1439 bool object_property_set_link(Object *obj, const char *name, 1440 Object *value, Error **errp) 1441 { 1442 g_autofree char *path = NULL; 1443 1444 if (value) { 1445 path = object_get_canonical_path(value); 1446 } 1447 return object_property_set_str(obj, name, path ?: "", errp); 1448 } 1449 1450 Object *object_property_get_link(Object *obj, const char *name, 1451 Error **errp) 1452 { 1453 char *str = object_property_get_str(obj, name, errp); 1454 Object *target = NULL; 1455 1456 if (str && *str) { 1457 target = object_resolve_path(str, NULL); 1458 if (!target) { 1459 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND, 1460 "Device '%s' not found", str); 1461 } 1462 } 1463 1464 g_free(str); 1465 return target; 1466 } 1467 1468 bool object_property_set_bool(Object *obj, const char *name, 1469 bool value, Error **errp) 1470 { 1471 QBool *qbool = qbool_from_bool(value); 1472 bool ok = object_property_set_qobject(obj, name, QOBJECT(qbool), errp); 1473 1474 qobject_unref(qbool); 1475 return ok; 1476 } 1477 1478 bool object_property_get_bool(Object *obj, const char *name, 1479 Error **errp) 1480 { 1481 QObject *ret = object_property_get_qobject(obj, name, errp); 1482 QBool *qbool; 1483 bool retval; 1484 1485 if (!ret) { 1486 return false; 1487 } 1488 qbool = qobject_to(QBool, ret); 1489 if (!qbool) { 1490 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean"); 1491 retval = false; 1492 } else { 1493 retval = qbool_get_bool(qbool); 1494 } 1495 1496 qobject_unref(ret); 1497 return retval; 1498 } 1499 1500 bool object_property_set_int(Object *obj, const char *name, 1501 int64_t value, Error **errp) 1502 { 1503 QNum *qnum = qnum_from_int(value); 1504 bool ok = object_property_set_qobject(obj, name, QOBJECT(qnum), errp); 1505 1506 qobject_unref(qnum); 1507 return ok; 1508 } 1509 1510 int64_t object_property_get_int(Object *obj, const char *name, 1511 Error **errp) 1512 { 1513 QObject *ret = object_property_get_qobject(obj, name, errp); 1514 QNum *qnum; 1515 int64_t retval; 1516 1517 if (!ret) { 1518 return -1; 1519 } 1520 1521 qnum = qobject_to(QNum, ret); 1522 if (!qnum || !qnum_get_try_int(qnum, &retval)) { 1523 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "int"); 1524 retval = -1; 1525 } 1526 1527 qobject_unref(ret); 1528 return retval; 1529 } 1530 1531 static void object_property_init_defval(Object *obj, ObjectProperty *prop) 1532 { 1533 Visitor *v = qobject_input_visitor_new(prop->defval); 1534 1535 assert(prop->set != NULL); 1536 prop->set(obj, v, prop->name, prop->opaque, &error_abort); 1537 1538 visit_free(v); 1539 } 1540 1541 static void object_property_set_default(ObjectProperty *prop, QObject *defval) 1542 { 1543 assert(!prop->defval); 1544 assert(!prop->init); 1545 1546 prop->defval = defval; 1547 prop->init = object_property_init_defval; 1548 } 1549 1550 void object_property_set_default_bool(ObjectProperty *prop, bool value) 1551 { 1552 object_property_set_default(prop, QOBJECT(qbool_from_bool(value))); 1553 } 1554 1555 void object_property_set_default_str(ObjectProperty *prop, const char *value) 1556 { 1557 object_property_set_default(prop, QOBJECT(qstring_from_str(value))); 1558 } 1559 1560 void object_property_set_default_int(ObjectProperty *prop, int64_t value) 1561 { 1562 object_property_set_default(prop, QOBJECT(qnum_from_int(value))); 1563 } 1564 1565 void object_property_set_default_uint(ObjectProperty *prop, uint64_t value) 1566 { 1567 object_property_set_default(prop, QOBJECT(qnum_from_uint(value))); 1568 } 1569 1570 bool object_property_set_uint(Object *obj, const char *name, 1571 uint64_t value, Error **errp) 1572 { 1573 QNum *qnum = qnum_from_uint(value); 1574 bool ok = object_property_set_qobject(obj, name, QOBJECT(qnum), errp); 1575 1576 qobject_unref(qnum); 1577 return ok; 1578 } 1579 1580 uint64_t object_property_get_uint(Object *obj, const char *name, 1581 Error **errp) 1582 { 1583 QObject *ret = object_property_get_qobject(obj, name, errp); 1584 QNum *qnum; 1585 uint64_t retval; 1586 1587 if (!ret) { 1588 return 0; 1589 } 1590 qnum = qobject_to(QNum, ret); 1591 if (!qnum || !qnum_get_try_uint(qnum, &retval)) { 1592 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "uint"); 1593 retval = 0; 1594 } 1595 1596 qobject_unref(ret); 1597 return retval; 1598 } 1599 1600 typedef struct EnumProperty { 1601 const QEnumLookup *lookup; 1602 int (*get)(Object *, Error **); 1603 void (*set)(Object *, int, Error **); 1604 } EnumProperty; 1605 1606 int object_property_get_enum(Object *obj, const char *name, 1607 const char *typename, Error **errp) 1608 { 1609 char *str; 1610 int ret; 1611 ObjectProperty *prop = object_property_find_err(obj, name, errp); 1612 EnumProperty *enumprop; 1613 1614 if (prop == NULL) { 1615 return -1; 1616 } 1617 1618 if (!g_str_equal(prop->type, typename)) { 1619 error_setg(errp, "Property %s on %s is not '%s' enum type", 1620 name, object_class_get_name( 1621 object_get_class(obj)), typename); 1622 return -1; 1623 } 1624 1625 enumprop = prop->opaque; 1626 1627 str = object_property_get_str(obj, name, errp); 1628 if (!str) { 1629 return -1; 1630 } 1631 1632 ret = qapi_enum_parse(enumprop->lookup, str, -1, errp); 1633 g_free(str); 1634 1635 return ret; 1636 } 1637 1638 bool object_property_parse(Object *obj, const char *name, 1639 const char *string, Error **errp) 1640 { 1641 Visitor *v = string_input_visitor_new(string); 1642 bool ok = object_property_set(obj, name, v, errp); 1643 1644 visit_free(v); 1645 return ok; 1646 } 1647 1648 char *object_property_print(Object *obj, const char *name, bool human, 1649 Error **errp) 1650 { 1651 Visitor *v; 1652 char *string = NULL; 1653 1654 v = string_output_visitor_new(human, &string); 1655 if (!object_property_get(obj, name, v, errp)) { 1656 goto out; 1657 } 1658 1659 visit_complete(v, &string); 1660 1661 out: 1662 visit_free(v); 1663 return string; 1664 } 1665 1666 const char *object_property_get_type(Object *obj, const char *name, Error **errp) 1667 { 1668 ObjectProperty *prop = object_property_find_err(obj, name, errp); 1669 if (prop == NULL) { 1670 return NULL; 1671 } 1672 1673 return prop->type; 1674 } 1675 1676 Object *object_get_root(void) 1677 { 1678 static Object *root; 1679 1680 if (!root) { 1681 root = object_new("container"); 1682 } 1683 1684 return root; 1685 } 1686 1687 Object *object_get_objects_root(void) 1688 { 1689 return container_get(object_get_root(), "/objects"); 1690 } 1691 1692 Object *object_get_internal_root(void) 1693 { 1694 static Object *internal_root; 1695 1696 if (!internal_root) { 1697 internal_root = object_new("container"); 1698 } 1699 1700 return internal_root; 1701 } 1702 1703 static void object_get_child_property(Object *obj, Visitor *v, 1704 const char *name, void *opaque, 1705 Error **errp) 1706 { 1707 Object *child = opaque; 1708 char *path; 1709 1710 path = object_get_canonical_path(child); 1711 visit_type_str(v, name, &path, errp); 1712 g_free(path); 1713 } 1714 1715 static Object *object_resolve_child_property(Object *parent, void *opaque, 1716 const char *part) 1717 { 1718 return opaque; 1719 } 1720 1721 static void object_finalize_child_property(Object *obj, const char *name, 1722 void *opaque) 1723 { 1724 Object *child = opaque; 1725 1726 if (child->class->unparent) { 1727 (child->class->unparent)(child); 1728 } 1729 child->parent = NULL; 1730 object_unref(child); 1731 } 1732 1733 ObjectProperty * 1734 object_property_try_add_child(Object *obj, const char *name, 1735 Object *child, Error **errp) 1736 { 1737 g_autofree char *type = NULL; 1738 ObjectProperty *op; 1739 1740 assert(!child->parent); 1741 1742 type = g_strdup_printf("child<%s>", object_get_typename(child)); 1743 1744 op = object_property_try_add(obj, name, type, object_get_child_property, 1745 NULL, object_finalize_child_property, 1746 child, errp); 1747 if (!op) { 1748 return NULL; 1749 } 1750 op->resolve = object_resolve_child_property; 1751 object_ref(child); 1752 child->parent = obj; 1753 return op; 1754 } 1755 1756 ObjectProperty * 1757 object_property_add_child(Object *obj, const char *name, 1758 Object *child) 1759 { 1760 return object_property_try_add_child(obj, name, child, &error_abort); 1761 } 1762 1763 void object_property_allow_set_link(const Object *obj, const char *name, 1764 Object *val, Error **errp) 1765 { 1766 /* Allow the link to be set, always */ 1767 } 1768 1769 typedef struct { 1770 union { 1771 Object **targetp; 1772 Object *target; /* if OBJ_PROP_LINK_DIRECT, when holding the pointer */ 1773 ptrdiff_t offset; /* if OBJ_PROP_LINK_CLASS */ 1774 }; 1775 void (*check)(const Object *, const char *, Object *, Error **); 1776 ObjectPropertyLinkFlags flags; 1777 } LinkProperty; 1778 1779 static Object ** 1780 object_link_get_targetp(Object *obj, LinkProperty *lprop) 1781 { 1782 if (lprop->flags & OBJ_PROP_LINK_DIRECT) { 1783 return &lprop->target; 1784 } else if (lprop->flags & OBJ_PROP_LINK_CLASS) { 1785 return (void *)obj + lprop->offset; 1786 } else { 1787 return lprop->targetp; 1788 } 1789 } 1790 1791 static void object_get_link_property(Object *obj, Visitor *v, 1792 const char *name, void *opaque, 1793 Error **errp) 1794 { 1795 LinkProperty *lprop = opaque; 1796 Object **targetp = object_link_get_targetp(obj, lprop); 1797 char *path; 1798 1799 if (*targetp) { 1800 path = object_get_canonical_path(*targetp); 1801 visit_type_str(v, name, &path, errp); 1802 g_free(path); 1803 } else { 1804 path = (char *)""; 1805 visit_type_str(v, name, &path, errp); 1806 } 1807 } 1808 1809 /* 1810 * object_resolve_link: 1811 * 1812 * Lookup an object and ensure its type matches the link property type. This 1813 * is similar to object_resolve_path() except type verification against the 1814 * link property is performed. 1815 * 1816 * Returns: The matched object or NULL on path lookup failures. 1817 */ 1818 static Object *object_resolve_link(Object *obj, const char *name, 1819 const char *path, Error **errp) 1820 { 1821 const char *type; 1822 char *target_type; 1823 bool ambiguous = false; 1824 Object *target; 1825 1826 /* Go from link<FOO> to FOO. */ 1827 type = object_property_get_type(obj, name, NULL); 1828 target_type = g_strndup(&type[5], strlen(type) - 6); 1829 target = object_resolve_path_type(path, target_type, &ambiguous); 1830 1831 if (ambiguous) { 1832 error_setg(errp, "Path '%s' does not uniquely identify an object", 1833 path); 1834 } else if (!target) { 1835 target = object_resolve_path(path, &ambiguous); 1836 if (target || ambiguous) { 1837 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type); 1838 } else { 1839 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND, 1840 "Device '%s' not found", path); 1841 } 1842 target = NULL; 1843 } 1844 g_free(target_type); 1845 1846 return target; 1847 } 1848 1849 static void object_set_link_property(Object *obj, Visitor *v, 1850 const char *name, void *opaque, 1851 Error **errp) 1852 { 1853 Error *local_err = NULL; 1854 LinkProperty *prop = opaque; 1855 Object **targetp = object_link_get_targetp(obj, prop); 1856 Object *old_target = *targetp; 1857 Object *new_target; 1858 char *path = NULL; 1859 1860 if (!visit_type_str(v, name, &path, errp)) { 1861 return; 1862 } 1863 1864 if (*path) { 1865 new_target = object_resolve_link(obj, name, path, errp); 1866 if (!new_target) { 1867 g_free(path); 1868 return; 1869 } 1870 } else { 1871 new_target = NULL; 1872 } 1873 1874 g_free(path); 1875 1876 prop->check(obj, name, new_target, &local_err); 1877 if (local_err) { 1878 error_propagate(errp, local_err); 1879 return; 1880 } 1881 1882 *targetp = new_target; 1883 if (prop->flags & OBJ_PROP_LINK_STRONG) { 1884 object_ref(new_target); 1885 object_unref(old_target); 1886 } 1887 } 1888 1889 static Object *object_resolve_link_property(Object *parent, void *opaque, 1890 const char *part) 1891 { 1892 LinkProperty *lprop = opaque; 1893 1894 return *object_link_get_targetp(parent, lprop); 1895 } 1896 1897 static void object_release_link_property(Object *obj, const char *name, 1898 void *opaque) 1899 { 1900 LinkProperty *prop = opaque; 1901 Object **targetp = object_link_get_targetp(obj, prop); 1902 1903 if ((prop->flags & OBJ_PROP_LINK_STRONG) && *targetp) { 1904 object_unref(*targetp); 1905 } 1906 if (!(prop->flags & OBJ_PROP_LINK_CLASS)) { 1907 g_free(prop); 1908 } 1909 } 1910 1911 static ObjectProperty * 1912 object_add_link_prop(Object *obj, const char *name, 1913 const char *type, void *ptr, 1914 void (*check)(const Object *, const char *, 1915 Object *, Error **), 1916 ObjectPropertyLinkFlags flags) 1917 { 1918 LinkProperty *prop = g_malloc(sizeof(*prop)); 1919 g_autofree char *full_type = NULL; 1920 ObjectProperty *op; 1921 1922 if (flags & OBJ_PROP_LINK_DIRECT) { 1923 prop->target = ptr; 1924 } else { 1925 prop->targetp = ptr; 1926 } 1927 prop->check = check; 1928 prop->flags = flags; 1929 1930 full_type = g_strdup_printf("link<%s>", type); 1931 1932 op = object_property_add(obj, name, full_type, 1933 object_get_link_property, 1934 check ? object_set_link_property : NULL, 1935 object_release_link_property, 1936 prop); 1937 op->resolve = object_resolve_link_property; 1938 return op; 1939 } 1940 1941 ObjectProperty * 1942 object_property_add_link(Object *obj, const char *name, 1943 const char *type, Object **targetp, 1944 void (*check)(const Object *, const char *, 1945 Object *, Error **), 1946 ObjectPropertyLinkFlags flags) 1947 { 1948 return object_add_link_prop(obj, name, type, targetp, check, flags); 1949 } 1950 1951 ObjectProperty * 1952 object_class_property_add_link(ObjectClass *oc, 1953 const char *name, 1954 const char *type, ptrdiff_t offset, 1955 void (*check)(const Object *obj, const char *name, 1956 Object *val, Error **errp), 1957 ObjectPropertyLinkFlags flags) 1958 { 1959 LinkProperty *prop = g_new0(LinkProperty, 1); 1960 char *full_type; 1961 ObjectProperty *op; 1962 1963 prop->offset = offset; 1964 prop->check = check; 1965 prop->flags = flags | OBJ_PROP_LINK_CLASS; 1966 1967 full_type = g_strdup_printf("link<%s>", type); 1968 1969 op = object_class_property_add(oc, name, full_type, 1970 object_get_link_property, 1971 check ? object_set_link_property : NULL, 1972 object_release_link_property, 1973 prop); 1974 1975 op->resolve = object_resolve_link_property; 1976 1977 g_free(full_type); 1978 return op; 1979 } 1980 1981 ObjectProperty * 1982 object_property_add_const_link(Object *obj, const char *name, 1983 Object *target) 1984 { 1985 return object_add_link_prop(obj, name, 1986 object_get_typename(target), target, 1987 NULL, OBJ_PROP_LINK_DIRECT); 1988 } 1989 1990 const char *object_get_canonical_path_component(const Object *obj) 1991 { 1992 ObjectProperty *prop = NULL; 1993 GHashTableIter iter; 1994 1995 if (obj->parent == NULL) { 1996 return NULL; 1997 } 1998 1999 g_hash_table_iter_init(&iter, obj->parent->properties); 2000 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) { 2001 if (!object_property_is_child(prop)) { 2002 continue; 2003 } 2004 2005 if (prop->opaque == obj) { 2006 return prop->name; 2007 } 2008 } 2009 2010 /* obj had a parent but was not a child, should never happen */ 2011 g_assert_not_reached(); 2012 return NULL; 2013 } 2014 2015 char *object_get_canonical_path(const Object *obj) 2016 { 2017 Object *root = object_get_root(); 2018 char *newpath, *path = NULL; 2019 2020 if (obj == root) { 2021 return g_strdup("/"); 2022 } 2023 2024 do { 2025 const char *component = object_get_canonical_path_component(obj); 2026 2027 if (!component) { 2028 /* A canonical path must be complete, so discard what was 2029 * collected so far. 2030 */ 2031 g_free(path); 2032 return NULL; 2033 } 2034 2035 newpath = g_strdup_printf("/%s%s", component, path ? path : ""); 2036 g_free(path); 2037 path = newpath; 2038 obj = obj->parent; 2039 } while (obj != root); 2040 2041 return path; 2042 } 2043 2044 Object *object_resolve_path_component(Object *parent, const char *part) 2045 { 2046 ObjectProperty *prop = object_property_find(parent, part); 2047 if (prop == NULL) { 2048 return NULL; 2049 } 2050 2051 if (prop->resolve) { 2052 return prop->resolve(parent, prop->opaque, part); 2053 } else { 2054 return NULL; 2055 } 2056 } 2057 2058 static Object *object_resolve_abs_path(Object *parent, 2059 char **parts, 2060 const char *typename) 2061 { 2062 Object *child; 2063 2064 if (*parts == NULL) { 2065 return object_dynamic_cast(parent, typename); 2066 } 2067 2068 if (strcmp(*parts, "") == 0) { 2069 return object_resolve_abs_path(parent, parts + 1, typename); 2070 } 2071 2072 child = object_resolve_path_component(parent, *parts); 2073 if (!child) { 2074 return NULL; 2075 } 2076 2077 return object_resolve_abs_path(child, parts + 1, typename); 2078 } 2079 2080 static Object *object_resolve_partial_path(Object *parent, 2081 char **parts, 2082 const char *typename, 2083 bool *ambiguous) 2084 { 2085 Object *obj; 2086 GHashTableIter iter; 2087 ObjectProperty *prop; 2088 2089 obj = object_resolve_abs_path(parent, parts, typename); 2090 2091 g_hash_table_iter_init(&iter, parent->properties); 2092 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) { 2093 Object *found; 2094 2095 if (!object_property_is_child(prop)) { 2096 continue; 2097 } 2098 2099 found = object_resolve_partial_path(prop->opaque, parts, 2100 typename, ambiguous); 2101 if (found) { 2102 if (obj) { 2103 *ambiguous = true; 2104 return NULL; 2105 } 2106 obj = found; 2107 } 2108 2109 if (*ambiguous) { 2110 return NULL; 2111 } 2112 } 2113 2114 return obj; 2115 } 2116 2117 Object *object_resolve_path_type(const char *path, const char *typename, 2118 bool *ambiguousp) 2119 { 2120 Object *obj; 2121 char **parts; 2122 2123 parts = g_strsplit(path, "/", 0); 2124 assert(parts); 2125 2126 if (parts[0] == NULL || strcmp(parts[0], "") != 0) { 2127 bool ambiguous = false; 2128 obj = object_resolve_partial_path(object_get_root(), parts, 2129 typename, &ambiguous); 2130 if (ambiguousp) { 2131 *ambiguousp = ambiguous; 2132 } 2133 } else { 2134 obj = object_resolve_abs_path(object_get_root(), parts + 1, typename); 2135 } 2136 2137 g_strfreev(parts); 2138 2139 return obj; 2140 } 2141 2142 Object *object_resolve_path(const char *path, bool *ambiguous) 2143 { 2144 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous); 2145 } 2146 2147 typedef struct StringProperty 2148 { 2149 char *(*get)(Object *, Error **); 2150 void (*set)(Object *, const char *, Error **); 2151 } StringProperty; 2152 2153 static void property_get_str(Object *obj, Visitor *v, const char *name, 2154 void *opaque, Error **errp) 2155 { 2156 StringProperty *prop = opaque; 2157 char *value; 2158 Error *err = NULL; 2159 2160 value = prop->get(obj, &err); 2161 if (err) { 2162 error_propagate(errp, err); 2163 return; 2164 } 2165 2166 visit_type_str(v, name, &value, errp); 2167 g_free(value); 2168 } 2169 2170 static void property_set_str(Object *obj, Visitor *v, const char *name, 2171 void *opaque, Error **errp) 2172 { 2173 StringProperty *prop = opaque; 2174 char *value; 2175 2176 if (!visit_type_str(v, name, &value, errp)) { 2177 return; 2178 } 2179 2180 prop->set(obj, value, errp); 2181 g_free(value); 2182 } 2183 2184 static void property_release_data(Object *obj, const char *name, 2185 void *opaque) 2186 { 2187 g_free(opaque); 2188 } 2189 2190 ObjectProperty * 2191 object_property_add_str(Object *obj, const char *name, 2192 char *(*get)(Object *, Error **), 2193 void (*set)(Object *, const char *, Error **)) 2194 { 2195 StringProperty *prop = g_malloc0(sizeof(*prop)); 2196 2197 prop->get = get; 2198 prop->set = set; 2199 2200 return object_property_add(obj, name, "string", 2201 get ? property_get_str : NULL, 2202 set ? property_set_str : NULL, 2203 property_release_data, 2204 prop); 2205 } 2206 2207 ObjectProperty * 2208 object_class_property_add_str(ObjectClass *klass, const char *name, 2209 char *(*get)(Object *, Error **), 2210 void (*set)(Object *, const char *, 2211 Error **)) 2212 { 2213 StringProperty *prop = g_malloc0(sizeof(*prop)); 2214 2215 prop->get = get; 2216 prop->set = set; 2217 2218 return object_class_property_add(klass, name, "string", 2219 get ? property_get_str : NULL, 2220 set ? property_set_str : NULL, 2221 NULL, 2222 prop); 2223 } 2224 2225 typedef struct BoolProperty 2226 { 2227 bool (*get)(Object *, Error **); 2228 void (*set)(Object *, bool, Error **); 2229 } BoolProperty; 2230 2231 static void property_get_bool(Object *obj, Visitor *v, const char *name, 2232 void *opaque, Error **errp) 2233 { 2234 BoolProperty *prop = opaque; 2235 bool value; 2236 Error *err = NULL; 2237 2238 value = prop->get(obj, &err); 2239 if (err) { 2240 error_propagate(errp, err); 2241 return; 2242 } 2243 2244 visit_type_bool(v, name, &value, errp); 2245 } 2246 2247 static void property_set_bool(Object *obj, Visitor *v, const char *name, 2248 void *opaque, Error **errp) 2249 { 2250 BoolProperty *prop = opaque; 2251 bool value; 2252 2253 if (!visit_type_bool(v, name, &value, errp)) { 2254 return; 2255 } 2256 2257 prop->set(obj, value, errp); 2258 } 2259 2260 ObjectProperty * 2261 object_property_add_bool(Object *obj, const char *name, 2262 bool (*get)(Object *, Error **), 2263 void (*set)(Object *, bool, Error **)) 2264 { 2265 BoolProperty *prop = g_malloc0(sizeof(*prop)); 2266 2267 prop->get = get; 2268 prop->set = set; 2269 2270 return object_property_add(obj, name, "bool", 2271 get ? property_get_bool : NULL, 2272 set ? property_set_bool : NULL, 2273 property_release_data, 2274 prop); 2275 } 2276 2277 ObjectProperty * 2278 object_class_property_add_bool(ObjectClass *klass, const char *name, 2279 bool (*get)(Object *, Error **), 2280 void (*set)(Object *, bool, Error **)) 2281 { 2282 BoolProperty *prop = g_malloc0(sizeof(*prop)); 2283 2284 prop->get = get; 2285 prop->set = set; 2286 2287 return object_class_property_add(klass, name, "bool", 2288 get ? property_get_bool : NULL, 2289 set ? property_set_bool : NULL, 2290 NULL, 2291 prop); 2292 } 2293 2294 static void property_get_enum(Object *obj, Visitor *v, const char *name, 2295 void *opaque, Error **errp) 2296 { 2297 EnumProperty *prop = opaque; 2298 int value; 2299 Error *err = NULL; 2300 2301 value = prop->get(obj, &err); 2302 if (err) { 2303 error_propagate(errp, err); 2304 return; 2305 } 2306 2307 visit_type_enum(v, name, &value, prop->lookup, errp); 2308 } 2309 2310 static void property_set_enum(Object *obj, Visitor *v, const char *name, 2311 void *opaque, Error **errp) 2312 { 2313 EnumProperty *prop = opaque; 2314 int value; 2315 2316 if (!visit_type_enum(v, name, &value, prop->lookup, errp)) { 2317 return; 2318 } 2319 prop->set(obj, value, errp); 2320 } 2321 2322 ObjectProperty * 2323 object_property_add_enum(Object *obj, const char *name, 2324 const char *typename, 2325 const QEnumLookup *lookup, 2326 int (*get)(Object *, Error **), 2327 void (*set)(Object *, int, Error **)) 2328 { 2329 EnumProperty *prop = g_malloc(sizeof(*prop)); 2330 2331 prop->lookup = lookup; 2332 prop->get = get; 2333 prop->set = set; 2334 2335 return object_property_add(obj, name, typename, 2336 get ? property_get_enum : NULL, 2337 set ? property_set_enum : NULL, 2338 property_release_data, 2339 prop); 2340 } 2341 2342 ObjectProperty * 2343 object_class_property_add_enum(ObjectClass *klass, const char *name, 2344 const char *typename, 2345 const QEnumLookup *lookup, 2346 int (*get)(Object *, Error **), 2347 void (*set)(Object *, int, Error **)) 2348 { 2349 EnumProperty *prop = g_malloc(sizeof(*prop)); 2350 2351 prop->lookup = lookup; 2352 prop->get = get; 2353 prop->set = set; 2354 2355 return object_class_property_add(klass, name, typename, 2356 get ? property_get_enum : NULL, 2357 set ? property_set_enum : NULL, 2358 NULL, 2359 prop); 2360 } 2361 2362 typedef struct TMProperty { 2363 void (*get)(Object *, struct tm *, Error **); 2364 } TMProperty; 2365 2366 static void property_get_tm(Object *obj, Visitor *v, const char *name, 2367 void *opaque, Error **errp) 2368 { 2369 TMProperty *prop = opaque; 2370 Error *err = NULL; 2371 struct tm value; 2372 2373 prop->get(obj, &value, &err); 2374 if (err) { 2375 error_propagate(errp, err); 2376 return; 2377 } 2378 2379 if (!visit_start_struct(v, name, NULL, 0, errp)) { 2380 return; 2381 } 2382 if (!visit_type_int32(v, "tm_year", &value.tm_year, errp)) { 2383 goto out_end; 2384 } 2385 if (!visit_type_int32(v, "tm_mon", &value.tm_mon, errp)) { 2386 goto out_end; 2387 } 2388 if (!visit_type_int32(v, "tm_mday", &value.tm_mday, errp)) { 2389 goto out_end; 2390 } 2391 if (!visit_type_int32(v, "tm_hour", &value.tm_hour, errp)) { 2392 goto out_end; 2393 } 2394 if (!visit_type_int32(v, "tm_min", &value.tm_min, errp)) { 2395 goto out_end; 2396 } 2397 if (!visit_type_int32(v, "tm_sec", &value.tm_sec, errp)) { 2398 goto out_end; 2399 } 2400 visit_check_struct(v, errp); 2401 out_end: 2402 visit_end_struct(v, NULL); 2403 } 2404 2405 ObjectProperty * 2406 object_property_add_tm(Object *obj, const char *name, 2407 void (*get)(Object *, struct tm *, Error **)) 2408 { 2409 TMProperty *prop = g_malloc0(sizeof(*prop)); 2410 2411 prop->get = get; 2412 2413 return object_property_add(obj, name, "struct tm", 2414 get ? property_get_tm : NULL, NULL, 2415 property_release_data, 2416 prop); 2417 } 2418 2419 ObjectProperty * 2420 object_class_property_add_tm(ObjectClass *klass, const char *name, 2421 void (*get)(Object *, struct tm *, Error **)) 2422 { 2423 TMProperty *prop = g_malloc0(sizeof(*prop)); 2424 2425 prop->get = get; 2426 2427 return object_class_property_add(klass, name, "struct tm", 2428 get ? property_get_tm : NULL, 2429 NULL, NULL, prop); 2430 } 2431 2432 static char *object_get_type(Object *obj, Error **errp) 2433 { 2434 return g_strdup(object_get_typename(obj)); 2435 } 2436 2437 static void property_get_uint8_ptr(Object *obj, Visitor *v, const char *name, 2438 void *opaque, Error **errp) 2439 { 2440 uint8_t value = *(uint8_t *)opaque; 2441 visit_type_uint8(v, name, &value, errp); 2442 } 2443 2444 static void property_set_uint8_ptr(Object *obj, Visitor *v, const char *name, 2445 void *opaque, Error **errp) 2446 { 2447 uint8_t *field = opaque; 2448 uint8_t value; 2449 2450 if (!visit_type_uint8(v, name, &value, errp)) { 2451 return; 2452 } 2453 2454 *field = value; 2455 } 2456 2457 static void property_get_uint16_ptr(Object *obj, Visitor *v, const char *name, 2458 void *opaque, Error **errp) 2459 { 2460 uint16_t value = *(uint16_t *)opaque; 2461 visit_type_uint16(v, name, &value, errp); 2462 } 2463 2464 static void property_set_uint16_ptr(Object *obj, Visitor *v, const char *name, 2465 void *opaque, Error **errp) 2466 { 2467 uint16_t *field = opaque; 2468 uint16_t value; 2469 2470 if (!visit_type_uint16(v, name, &value, errp)) { 2471 return; 2472 } 2473 2474 *field = value; 2475 } 2476 2477 static void property_get_uint32_ptr(Object *obj, Visitor *v, const char *name, 2478 void *opaque, Error **errp) 2479 { 2480 uint32_t value = *(uint32_t *)opaque; 2481 visit_type_uint32(v, name, &value, errp); 2482 } 2483 2484 static void property_set_uint32_ptr(Object *obj, Visitor *v, const char *name, 2485 void *opaque, Error **errp) 2486 { 2487 uint32_t *field = opaque; 2488 uint32_t value; 2489 2490 if (!visit_type_uint32(v, name, &value, errp)) { 2491 return; 2492 } 2493 2494 *field = value; 2495 } 2496 2497 static void property_get_uint64_ptr(Object *obj, Visitor *v, const char *name, 2498 void *opaque, Error **errp) 2499 { 2500 uint64_t value = *(uint64_t *)opaque; 2501 visit_type_uint64(v, name, &value, errp); 2502 } 2503 2504 static void property_set_uint64_ptr(Object *obj, Visitor *v, const char *name, 2505 void *opaque, Error **errp) 2506 { 2507 uint64_t *field = opaque; 2508 uint64_t value; 2509 2510 if (!visit_type_uint64(v, name, &value, errp)) { 2511 return; 2512 } 2513 2514 *field = value; 2515 } 2516 2517 ObjectProperty * 2518 object_property_add_uint8_ptr(Object *obj, const char *name, 2519 const uint8_t *v, 2520 ObjectPropertyFlags flags) 2521 { 2522 ObjectPropertyAccessor *getter = NULL; 2523 ObjectPropertyAccessor *setter = NULL; 2524 2525 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) { 2526 getter = property_get_uint8_ptr; 2527 } 2528 2529 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) { 2530 setter = property_set_uint8_ptr; 2531 } 2532 2533 return object_property_add(obj, name, "uint8", 2534 getter, setter, NULL, (void *)v); 2535 } 2536 2537 ObjectProperty * 2538 object_class_property_add_uint8_ptr(ObjectClass *klass, const char *name, 2539 const uint8_t *v, 2540 ObjectPropertyFlags flags) 2541 { 2542 ObjectPropertyAccessor *getter = NULL; 2543 ObjectPropertyAccessor *setter = NULL; 2544 2545 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) { 2546 getter = property_get_uint8_ptr; 2547 } 2548 2549 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) { 2550 setter = property_set_uint8_ptr; 2551 } 2552 2553 return object_class_property_add(klass, name, "uint8", 2554 getter, setter, NULL, (void *)v); 2555 } 2556 2557 ObjectProperty * 2558 object_property_add_uint16_ptr(Object *obj, const char *name, 2559 const uint16_t *v, 2560 ObjectPropertyFlags flags) 2561 { 2562 ObjectPropertyAccessor *getter = NULL; 2563 ObjectPropertyAccessor *setter = NULL; 2564 2565 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) { 2566 getter = property_get_uint16_ptr; 2567 } 2568 2569 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) { 2570 setter = property_set_uint16_ptr; 2571 } 2572 2573 return object_property_add(obj, name, "uint16", 2574 getter, setter, NULL, (void *)v); 2575 } 2576 2577 ObjectProperty * 2578 object_class_property_add_uint16_ptr(ObjectClass *klass, const char *name, 2579 const uint16_t *v, 2580 ObjectPropertyFlags flags) 2581 { 2582 ObjectPropertyAccessor *getter = NULL; 2583 ObjectPropertyAccessor *setter = NULL; 2584 2585 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) { 2586 getter = property_get_uint16_ptr; 2587 } 2588 2589 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) { 2590 setter = property_set_uint16_ptr; 2591 } 2592 2593 return object_class_property_add(klass, name, "uint16", 2594 getter, setter, NULL, (void *)v); 2595 } 2596 2597 ObjectProperty * 2598 object_property_add_uint32_ptr(Object *obj, const char *name, 2599 const uint32_t *v, 2600 ObjectPropertyFlags flags) 2601 { 2602 ObjectPropertyAccessor *getter = NULL; 2603 ObjectPropertyAccessor *setter = NULL; 2604 2605 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) { 2606 getter = property_get_uint32_ptr; 2607 } 2608 2609 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) { 2610 setter = property_set_uint32_ptr; 2611 } 2612 2613 return object_property_add(obj, name, "uint32", 2614 getter, setter, NULL, (void *)v); 2615 } 2616 2617 ObjectProperty * 2618 object_class_property_add_uint32_ptr(ObjectClass *klass, const char *name, 2619 const uint32_t *v, 2620 ObjectPropertyFlags flags) 2621 { 2622 ObjectPropertyAccessor *getter = NULL; 2623 ObjectPropertyAccessor *setter = NULL; 2624 2625 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) { 2626 getter = property_get_uint32_ptr; 2627 } 2628 2629 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) { 2630 setter = property_set_uint32_ptr; 2631 } 2632 2633 return object_class_property_add(klass, name, "uint32", 2634 getter, setter, NULL, (void *)v); 2635 } 2636 2637 ObjectProperty * 2638 object_property_add_uint64_ptr(Object *obj, const char *name, 2639 const uint64_t *v, 2640 ObjectPropertyFlags flags) 2641 { 2642 ObjectPropertyAccessor *getter = NULL; 2643 ObjectPropertyAccessor *setter = NULL; 2644 2645 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) { 2646 getter = property_get_uint64_ptr; 2647 } 2648 2649 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) { 2650 setter = property_set_uint64_ptr; 2651 } 2652 2653 return object_property_add(obj, name, "uint64", 2654 getter, setter, NULL, (void *)v); 2655 } 2656 2657 ObjectProperty * 2658 object_class_property_add_uint64_ptr(ObjectClass *klass, const char *name, 2659 const uint64_t *v, 2660 ObjectPropertyFlags flags) 2661 { 2662 ObjectPropertyAccessor *getter = NULL; 2663 ObjectPropertyAccessor *setter = NULL; 2664 2665 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) { 2666 getter = property_get_uint64_ptr; 2667 } 2668 2669 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) { 2670 setter = property_set_uint64_ptr; 2671 } 2672 2673 return object_class_property_add(klass, name, "uint64", 2674 getter, setter, NULL, (void *)v); 2675 } 2676 2677 typedef struct { 2678 Object *target_obj; 2679 char *target_name; 2680 } AliasProperty; 2681 2682 static void property_get_alias(Object *obj, Visitor *v, const char *name, 2683 void *opaque, Error **errp) 2684 { 2685 AliasProperty *prop = opaque; 2686 Visitor *alias_v = visitor_forward_field(v, prop->target_name, name); 2687 2688 object_property_get(prop->target_obj, prop->target_name, alias_v, errp); 2689 visit_free(alias_v); 2690 } 2691 2692 static void property_set_alias(Object *obj, Visitor *v, const char *name, 2693 void *opaque, Error **errp) 2694 { 2695 AliasProperty *prop = opaque; 2696 Visitor *alias_v = visitor_forward_field(v, prop->target_name, name); 2697 2698 object_property_set(prop->target_obj, prop->target_name, alias_v, errp); 2699 visit_free(alias_v); 2700 } 2701 2702 static Object *property_resolve_alias(Object *obj, void *opaque, 2703 const char *part) 2704 { 2705 AliasProperty *prop = opaque; 2706 2707 return object_resolve_path_component(prop->target_obj, prop->target_name); 2708 } 2709 2710 static void property_release_alias(Object *obj, const char *name, void *opaque) 2711 { 2712 AliasProperty *prop = opaque; 2713 2714 g_free(prop->target_name); 2715 g_free(prop); 2716 } 2717 2718 ObjectProperty * 2719 object_property_add_alias(Object *obj, const char *name, 2720 Object *target_obj, const char *target_name) 2721 { 2722 AliasProperty *prop; 2723 ObjectProperty *op; 2724 ObjectProperty *target_prop; 2725 g_autofree char *prop_type = NULL; 2726 2727 target_prop = object_property_find_err(target_obj, target_name, 2728 &error_abort); 2729 2730 if (object_property_is_child(target_prop)) { 2731 prop_type = g_strdup_printf("link%s", 2732 target_prop->type + strlen("child")); 2733 } else { 2734 prop_type = g_strdup(target_prop->type); 2735 } 2736 2737 prop = g_malloc(sizeof(*prop)); 2738 prop->target_obj = target_obj; 2739 prop->target_name = g_strdup(target_name); 2740 2741 op = object_property_add(obj, name, prop_type, 2742 property_get_alias, 2743 property_set_alias, 2744 property_release_alias, 2745 prop); 2746 op->resolve = property_resolve_alias; 2747 if (target_prop->defval) { 2748 op->defval = qobject_ref(target_prop->defval); 2749 } 2750 2751 object_property_set_description(obj, op->name, 2752 target_prop->description); 2753 return op; 2754 } 2755 2756 void object_property_set_description(Object *obj, const char *name, 2757 const char *description) 2758 { 2759 ObjectProperty *op; 2760 2761 op = object_property_find_err(obj, name, &error_abort); 2762 g_free(op->description); 2763 op->description = g_strdup(description); 2764 } 2765 2766 void object_class_property_set_description(ObjectClass *klass, 2767 const char *name, 2768 const char *description) 2769 { 2770 ObjectProperty *op; 2771 2772 op = g_hash_table_lookup(klass->properties, name); 2773 g_free(op->description); 2774 op->description = g_strdup(description); 2775 } 2776 2777 static void object_class_init(ObjectClass *klass, void *data) 2778 { 2779 object_class_property_add_str(klass, "type", object_get_type, 2780 NULL); 2781 } 2782 2783 static void register_types(void) 2784 { 2785 static TypeInfo interface_info = { 2786 .name = TYPE_INTERFACE, 2787 .class_size = sizeof(InterfaceClass), 2788 .abstract = true, 2789 }; 2790 2791 static TypeInfo object_info = { 2792 .name = TYPE_OBJECT, 2793 .instance_size = sizeof(Object), 2794 .class_init = object_class_init, 2795 .abstract = true, 2796 }; 2797 2798 type_interface = type_register_internal(&interface_info); 2799 type_register_internal(&object_info); 2800 } 2801 2802 type_init(register_types) 2803