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 "qom/object.h" 14 #include "qemu-common.h" 15 #include "qapi/visitor.h" 16 #include "qapi-visit.h" 17 #include "qapi/string-input-visitor.h" 18 #include "qapi/string-output-visitor.h" 19 #include "qapi/qmp/qerror.h" 20 #include "trace.h" 21 22 /* TODO: replace QObject with a simpler visitor to avoid a dependency 23 * of the QOM core on QObject? */ 24 #include "qom/qom-qobject.h" 25 #include "qapi/qmp/qobject.h" 26 #include "qapi/qmp/qbool.h" 27 #include "qapi/qmp/qint.h" 28 #include "qapi/qmp/qstring.h" 29 30 #define MAX_INTERFACES 32 31 32 typedef struct InterfaceImpl InterfaceImpl; 33 typedef struct TypeImpl TypeImpl; 34 35 struct InterfaceImpl 36 { 37 const char *typename; 38 }; 39 40 struct TypeImpl 41 { 42 const char *name; 43 44 size_t class_size; 45 46 size_t instance_size; 47 48 void (*class_init)(ObjectClass *klass, void *data); 49 void (*class_base_init)(ObjectClass *klass, void *data); 50 void (*class_finalize)(ObjectClass *klass, void *data); 51 52 void *class_data; 53 54 void (*instance_init)(Object *obj); 55 void (*instance_post_init)(Object *obj); 56 void (*instance_finalize)(Object *obj); 57 58 bool abstract; 59 60 const char *parent; 61 TypeImpl *parent_type; 62 63 ObjectClass *class; 64 65 int num_interfaces; 66 InterfaceImpl interfaces[MAX_INTERFACES]; 67 }; 68 69 static Type type_interface; 70 71 static GHashTable *type_table_get(void) 72 { 73 static GHashTable *type_table; 74 75 if (type_table == NULL) { 76 type_table = g_hash_table_new(g_str_hash, g_str_equal); 77 } 78 79 return type_table; 80 } 81 82 static bool enumerating_types; 83 84 static void type_table_add(TypeImpl *ti) 85 { 86 assert(!enumerating_types); 87 g_hash_table_insert(type_table_get(), (void *)ti->name, ti); 88 } 89 90 static TypeImpl *type_table_lookup(const char *name) 91 { 92 return g_hash_table_lookup(type_table_get(), name); 93 } 94 95 static TypeImpl *type_new(const TypeInfo *info) 96 { 97 TypeImpl *ti = g_malloc0(sizeof(*ti)); 98 int i; 99 100 g_assert(info->name != NULL); 101 102 if (type_table_lookup(info->name) != NULL) { 103 fprintf(stderr, "Registering `%s' which already exists\n", info->name); 104 abort(); 105 } 106 107 ti->name = g_strdup(info->name); 108 ti->parent = g_strdup(info->parent); 109 110 ti->class_size = info->class_size; 111 ti->instance_size = info->instance_size; 112 113 ti->class_init = info->class_init; 114 ti->class_base_init = info->class_base_init; 115 ti->class_finalize = info->class_finalize; 116 ti->class_data = info->class_data; 117 118 ti->instance_init = info->instance_init; 119 ti->instance_post_init = info->instance_post_init; 120 ti->instance_finalize = info->instance_finalize; 121 122 ti->abstract = info->abstract; 123 124 for (i = 0; info->interfaces && info->interfaces[i].type; i++) { 125 ti->interfaces[i].typename = g_strdup(info->interfaces[i].type); 126 } 127 ti->num_interfaces = i; 128 129 return ti; 130 } 131 132 static TypeImpl *type_register_internal(const TypeInfo *info) 133 { 134 TypeImpl *ti; 135 ti = type_new(info); 136 137 type_table_add(ti); 138 return ti; 139 } 140 141 TypeImpl *type_register(const TypeInfo *info) 142 { 143 assert(info->parent); 144 return type_register_internal(info); 145 } 146 147 TypeImpl *type_register_static(const TypeInfo *info) 148 { 149 return type_register(info); 150 } 151 152 static TypeImpl *type_get_by_name(const char *name) 153 { 154 if (name == NULL) { 155 return NULL; 156 } 157 158 return type_table_lookup(name); 159 } 160 161 static TypeImpl *type_get_parent(TypeImpl *type) 162 { 163 if (!type->parent_type && type->parent) { 164 type->parent_type = type_get_by_name(type->parent); 165 g_assert(type->parent_type != NULL); 166 } 167 168 return type->parent_type; 169 } 170 171 static bool type_has_parent(TypeImpl *type) 172 { 173 return (type->parent != NULL); 174 } 175 176 static size_t type_class_get_size(TypeImpl *ti) 177 { 178 if (ti->class_size) { 179 return ti->class_size; 180 } 181 182 if (type_has_parent(ti)) { 183 return type_class_get_size(type_get_parent(ti)); 184 } 185 186 return sizeof(ObjectClass); 187 } 188 189 static size_t type_object_get_size(TypeImpl *ti) 190 { 191 if (ti->instance_size) { 192 return ti->instance_size; 193 } 194 195 if (type_has_parent(ti)) { 196 return type_object_get_size(type_get_parent(ti)); 197 } 198 199 return 0; 200 } 201 202 static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type) 203 { 204 assert(target_type); 205 206 /* Check if typename is a direct ancestor of type */ 207 while (type) { 208 if (type == target_type) { 209 return true; 210 } 211 212 type = type_get_parent(type); 213 } 214 215 return false; 216 } 217 218 static void type_initialize(TypeImpl *ti); 219 220 static void type_initialize_interface(TypeImpl *ti, TypeImpl *interface_type, 221 TypeImpl *parent_type) 222 { 223 InterfaceClass *new_iface; 224 TypeInfo info = { }; 225 TypeImpl *iface_impl; 226 227 info.parent = parent_type->name; 228 info.name = g_strdup_printf("%s::%s", ti->name, interface_type->name); 229 info.abstract = true; 230 231 iface_impl = type_new(&info); 232 iface_impl->parent_type = parent_type; 233 type_initialize(iface_impl); 234 g_free((char *)info.name); 235 236 new_iface = (InterfaceClass *)iface_impl->class; 237 new_iface->concrete_class = ti->class; 238 new_iface->interface_type = interface_type; 239 240 ti->class->interfaces = g_slist_append(ti->class->interfaces, 241 iface_impl->class); 242 } 243 244 static void type_initialize(TypeImpl *ti) 245 { 246 TypeImpl *parent; 247 248 if (ti->class) { 249 return; 250 } 251 252 ti->class_size = type_class_get_size(ti); 253 ti->instance_size = type_object_get_size(ti); 254 255 ti->class = g_malloc0(ti->class_size); 256 257 parent = type_get_parent(ti); 258 if (parent) { 259 type_initialize(parent); 260 GSList *e; 261 int i; 262 263 g_assert(parent->class_size <= ti->class_size); 264 memcpy(ti->class, parent->class, parent->class_size); 265 ti->class->interfaces = NULL; 266 267 for (e = parent->class->interfaces; e; e = e->next) { 268 InterfaceClass *iface = e->data; 269 ObjectClass *klass = OBJECT_CLASS(iface); 270 271 type_initialize_interface(ti, iface->interface_type, klass->type); 272 } 273 274 for (i = 0; i < ti->num_interfaces; i++) { 275 TypeImpl *t = type_get_by_name(ti->interfaces[i].typename); 276 for (e = ti->class->interfaces; e; e = e->next) { 277 TypeImpl *target_type = OBJECT_CLASS(e->data)->type; 278 279 if (type_is_ancestor(target_type, t)) { 280 break; 281 } 282 } 283 284 if (e) { 285 continue; 286 } 287 288 type_initialize_interface(ti, t, t); 289 } 290 } 291 292 ti->class->type = ti; 293 294 while (parent) { 295 if (parent->class_base_init) { 296 parent->class_base_init(ti->class, ti->class_data); 297 } 298 parent = type_get_parent(parent); 299 } 300 301 if (ti->class_init) { 302 ti->class_init(ti->class, ti->class_data); 303 } 304 } 305 306 static void object_init_with_type(Object *obj, TypeImpl *ti) 307 { 308 if (type_has_parent(ti)) { 309 object_init_with_type(obj, type_get_parent(ti)); 310 } 311 312 if (ti->instance_init) { 313 ti->instance_init(obj); 314 } 315 } 316 317 static void object_post_init_with_type(Object *obj, TypeImpl *ti) 318 { 319 if (ti->instance_post_init) { 320 ti->instance_post_init(obj); 321 } 322 323 if (type_has_parent(ti)) { 324 object_post_init_with_type(obj, type_get_parent(ti)); 325 } 326 } 327 328 void object_initialize_with_type(void *data, size_t size, TypeImpl *type) 329 { 330 Object *obj = data; 331 332 g_assert(type != NULL); 333 type_initialize(type); 334 335 g_assert(type->instance_size >= sizeof(Object)); 336 g_assert(type->abstract == false); 337 g_assert(size >= type->instance_size); 338 339 memset(obj, 0, type->instance_size); 340 obj->class = type->class; 341 object_ref(obj); 342 QTAILQ_INIT(&obj->properties); 343 object_init_with_type(obj, type); 344 object_post_init_with_type(obj, type); 345 } 346 347 void object_initialize(void *data, size_t size, const char *typename) 348 { 349 TypeImpl *type = type_get_by_name(typename); 350 351 object_initialize_with_type(data, size, type); 352 } 353 354 static inline bool object_property_is_child(ObjectProperty *prop) 355 { 356 return strstart(prop->type, "child<", NULL); 357 } 358 359 static void object_property_del_all(Object *obj) 360 { 361 while (!QTAILQ_EMPTY(&obj->properties)) { 362 ObjectProperty *prop = QTAILQ_FIRST(&obj->properties); 363 364 QTAILQ_REMOVE(&obj->properties, prop, node); 365 366 if (prop->release) { 367 prop->release(obj, prop->name, prop->opaque); 368 } 369 370 g_free(prop->name); 371 g_free(prop->type); 372 g_free(prop); 373 } 374 } 375 376 static void object_property_del_child(Object *obj, Object *child, Error **errp) 377 { 378 ObjectProperty *prop; 379 380 QTAILQ_FOREACH(prop, &obj->properties, node) { 381 if (object_property_is_child(prop) && prop->opaque == child) { 382 object_property_del(obj, prop->name, errp); 383 break; 384 } 385 } 386 } 387 388 void object_unparent(Object *obj) 389 { 390 if (!obj->parent) { 391 return; 392 } 393 394 object_ref(obj); 395 if (obj->class->unparent) { 396 (obj->class->unparent)(obj); 397 } 398 if (obj->parent) { 399 object_property_del_child(obj->parent, obj, NULL); 400 obj->parent = NULL; 401 } 402 object_unref(obj); 403 } 404 405 static void object_deinit(Object *obj, TypeImpl *type) 406 { 407 if (type->instance_finalize) { 408 type->instance_finalize(obj); 409 } 410 411 if (type_has_parent(type)) { 412 object_deinit(obj, type_get_parent(type)); 413 } 414 } 415 416 static void object_finalize(void *data) 417 { 418 Object *obj = data; 419 TypeImpl *ti = obj->class->type; 420 421 object_deinit(obj, ti); 422 object_property_del_all(obj); 423 424 g_assert(obj->ref == 0); 425 if (obj->free) { 426 obj->free(obj); 427 } 428 } 429 430 Object *object_new_with_type(Type type) 431 { 432 Object *obj; 433 434 g_assert(type != NULL); 435 type_initialize(type); 436 437 obj = g_malloc(type->instance_size); 438 object_initialize_with_type(obj, type->instance_size, type); 439 obj->free = g_free; 440 441 return obj; 442 } 443 444 Object *object_new(const char *typename) 445 { 446 TypeImpl *ti = type_get_by_name(typename); 447 448 return object_new_with_type(ti); 449 } 450 451 Object *object_dynamic_cast(Object *obj, const char *typename) 452 { 453 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) { 454 return obj; 455 } 456 457 return NULL; 458 } 459 460 Object *object_dynamic_cast_assert(Object *obj, const char *typename, 461 const char *file, int line, const char *func) 462 { 463 trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)", 464 typename, file, line, func); 465 466 #ifdef CONFIG_QOM_CAST_DEBUG 467 int i; 468 Object *inst; 469 470 for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) { 471 if (obj->class->object_cast_cache[i] == typename) { 472 goto out; 473 } 474 } 475 476 inst = object_dynamic_cast(obj, typename); 477 478 if (!inst && obj) { 479 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n", 480 file, line, func, obj, typename); 481 abort(); 482 } 483 484 assert(obj == inst); 485 486 if (obj && obj == inst) { 487 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) { 488 obj->class->object_cast_cache[i - 1] = 489 obj->class->object_cast_cache[i]; 490 } 491 obj->class->object_cast_cache[i - 1] = typename; 492 } 493 494 out: 495 #endif 496 return obj; 497 } 498 499 ObjectClass *object_class_dynamic_cast(ObjectClass *class, 500 const char *typename) 501 { 502 ObjectClass *ret = NULL; 503 TypeImpl *target_type; 504 TypeImpl *type; 505 506 if (!class) { 507 return NULL; 508 } 509 510 /* A simple fast path that can trigger a lot for leaf classes. */ 511 type = class->type; 512 if (type->name == typename) { 513 return class; 514 } 515 516 target_type = type_get_by_name(typename); 517 if (!target_type) { 518 /* target class type unknown, so fail the cast */ 519 return NULL; 520 } 521 522 if (type->class->interfaces && 523 type_is_ancestor(target_type, type_interface)) { 524 int found = 0; 525 GSList *i; 526 527 for (i = class->interfaces; i; i = i->next) { 528 ObjectClass *target_class = i->data; 529 530 if (type_is_ancestor(target_class->type, target_type)) { 531 ret = target_class; 532 found++; 533 } 534 } 535 536 /* The match was ambiguous, don't allow a cast */ 537 if (found > 1) { 538 ret = NULL; 539 } 540 } else if (type_is_ancestor(type, target_type)) { 541 ret = class; 542 } 543 544 return ret; 545 } 546 547 ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class, 548 const char *typename, 549 const char *file, int line, 550 const char *func) 551 { 552 ObjectClass *ret; 553 554 trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)", 555 typename, file, line, func); 556 557 #ifdef CONFIG_QOM_CAST_DEBUG 558 int i; 559 560 for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) { 561 if (class->class_cast_cache[i] == typename) { 562 ret = class; 563 goto out; 564 } 565 } 566 #else 567 if (!class || !class->interfaces) { 568 return class; 569 } 570 #endif 571 572 ret = object_class_dynamic_cast(class, typename); 573 if (!ret && class) { 574 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n", 575 file, line, func, class, typename); 576 abort(); 577 } 578 579 #ifdef CONFIG_QOM_CAST_DEBUG 580 if (class && ret == class) { 581 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) { 582 class->class_cast_cache[i - 1] = class->class_cast_cache[i]; 583 } 584 class->class_cast_cache[i - 1] = typename; 585 } 586 out: 587 #endif 588 return ret; 589 } 590 591 const char *object_get_typename(Object *obj) 592 { 593 return obj->class->type->name; 594 } 595 596 ObjectClass *object_get_class(Object *obj) 597 { 598 return obj->class; 599 } 600 601 bool object_class_is_abstract(ObjectClass *klass) 602 { 603 return klass->type->abstract; 604 } 605 606 const char *object_class_get_name(ObjectClass *klass) 607 { 608 return klass->type->name; 609 } 610 611 ObjectClass *object_class_by_name(const char *typename) 612 { 613 TypeImpl *type = type_get_by_name(typename); 614 615 if (!type) { 616 return NULL; 617 } 618 619 type_initialize(type); 620 621 return type->class; 622 } 623 624 ObjectClass *object_class_get_parent(ObjectClass *class) 625 { 626 TypeImpl *type = type_get_parent(class->type); 627 628 if (!type) { 629 return NULL; 630 } 631 632 type_initialize(type); 633 634 return type->class; 635 } 636 637 typedef struct OCFData 638 { 639 void (*fn)(ObjectClass *klass, void *opaque); 640 const char *implements_type; 641 bool include_abstract; 642 void *opaque; 643 } OCFData; 644 645 static void object_class_foreach_tramp(gpointer key, gpointer value, 646 gpointer opaque) 647 { 648 OCFData *data = opaque; 649 TypeImpl *type = value; 650 ObjectClass *k; 651 652 type_initialize(type); 653 k = type->class; 654 655 if (!data->include_abstract && type->abstract) { 656 return; 657 } 658 659 if (data->implements_type && 660 !object_class_dynamic_cast(k, data->implements_type)) { 661 return; 662 } 663 664 data->fn(k, data->opaque); 665 } 666 667 void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque), 668 const char *implements_type, bool include_abstract, 669 void *opaque) 670 { 671 OCFData data = { fn, implements_type, include_abstract, opaque }; 672 673 enumerating_types = true; 674 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data); 675 enumerating_types = false; 676 } 677 678 int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque), 679 void *opaque) 680 { 681 ObjectProperty *prop; 682 int ret = 0; 683 684 QTAILQ_FOREACH(prop, &obj->properties, node) { 685 if (object_property_is_child(prop)) { 686 ret = fn(prop->opaque, opaque); 687 if (ret != 0) { 688 break; 689 } 690 } 691 } 692 return ret; 693 } 694 695 static void object_class_get_list_tramp(ObjectClass *klass, void *opaque) 696 { 697 GSList **list = opaque; 698 699 *list = g_slist_prepend(*list, klass); 700 } 701 702 GSList *object_class_get_list(const char *implements_type, 703 bool include_abstract) 704 { 705 GSList *list = NULL; 706 707 object_class_foreach(object_class_get_list_tramp, 708 implements_type, include_abstract, &list); 709 return list; 710 } 711 712 void object_ref(Object *obj) 713 { 714 if (!obj) { 715 return; 716 } 717 atomic_inc(&obj->ref); 718 } 719 720 void object_unref(Object *obj) 721 { 722 if (!obj) { 723 return; 724 } 725 g_assert(obj->ref > 0); 726 727 /* parent always holds a reference to its children */ 728 if (atomic_fetch_dec(&obj->ref) == 1) { 729 object_finalize(obj); 730 } 731 } 732 733 ObjectProperty * 734 object_property_add(Object *obj, const char *name, const char *type, 735 ObjectPropertyAccessor *get, 736 ObjectPropertyAccessor *set, 737 ObjectPropertyRelease *release, 738 void *opaque, Error **errp) 739 { 740 ObjectProperty *prop; 741 742 QTAILQ_FOREACH(prop, &obj->properties, node) { 743 if (strcmp(prop->name, name) == 0) { 744 error_setg(errp, "attempt to add duplicate property '%s'" 745 " to object (type '%s')", name, 746 object_get_typename(obj)); 747 return NULL; 748 } 749 } 750 751 prop = g_malloc0(sizeof(*prop)); 752 753 prop->name = g_strdup(name); 754 prop->type = g_strdup(type); 755 756 prop->get = get; 757 prop->set = set; 758 prop->release = release; 759 prop->opaque = opaque; 760 761 QTAILQ_INSERT_TAIL(&obj->properties, prop, node); 762 return prop; 763 } 764 765 ObjectProperty *object_property_find(Object *obj, const char *name, 766 Error **errp) 767 { 768 ObjectProperty *prop; 769 770 QTAILQ_FOREACH(prop, &obj->properties, node) { 771 if (strcmp(prop->name, name) == 0) { 772 return prop; 773 } 774 } 775 776 error_setg(errp, "Property '.%s' not found", name); 777 return NULL; 778 } 779 780 void object_property_del(Object *obj, const char *name, Error **errp) 781 { 782 ObjectProperty *prop = object_property_find(obj, name, errp); 783 if (prop == NULL) { 784 return; 785 } 786 787 if (prop->release) { 788 prop->release(obj, name, prop->opaque); 789 } 790 791 QTAILQ_REMOVE(&obj->properties, prop, node); 792 793 g_free(prop->name); 794 g_free(prop->type); 795 g_free(prop); 796 } 797 798 void object_property_get(Object *obj, Visitor *v, const char *name, 799 Error **errp) 800 { 801 ObjectProperty *prop = object_property_find(obj, name, errp); 802 if (prop == NULL) { 803 return; 804 } 805 806 if (!prop->get) { 807 error_set(errp, QERR_PERMISSION_DENIED); 808 } else { 809 prop->get(obj, v, prop->opaque, name, errp); 810 } 811 } 812 813 void object_property_set(Object *obj, Visitor *v, const char *name, 814 Error **errp) 815 { 816 ObjectProperty *prop = object_property_find(obj, name, errp); 817 if (prop == NULL) { 818 return; 819 } 820 821 if (!prop->set) { 822 error_set(errp, QERR_PERMISSION_DENIED); 823 } else { 824 prop->set(obj, v, prop->opaque, name, errp); 825 } 826 } 827 828 void object_property_set_str(Object *obj, const char *value, 829 const char *name, Error **errp) 830 { 831 QString *qstr = qstring_from_str(value); 832 object_property_set_qobject(obj, QOBJECT(qstr), name, errp); 833 834 QDECREF(qstr); 835 } 836 837 char *object_property_get_str(Object *obj, const char *name, 838 Error **errp) 839 { 840 QObject *ret = object_property_get_qobject(obj, name, errp); 841 QString *qstring; 842 char *retval; 843 844 if (!ret) { 845 return NULL; 846 } 847 qstring = qobject_to_qstring(ret); 848 if (!qstring) { 849 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "string"); 850 retval = NULL; 851 } else { 852 retval = g_strdup(qstring_get_str(qstring)); 853 } 854 855 QDECREF(qstring); 856 return retval; 857 } 858 859 void object_property_set_link(Object *obj, Object *value, 860 const char *name, Error **errp) 861 { 862 gchar *path = object_get_canonical_path(value); 863 object_property_set_str(obj, path, name, errp); 864 g_free(path); 865 } 866 867 Object *object_property_get_link(Object *obj, const char *name, 868 Error **errp) 869 { 870 char *str = object_property_get_str(obj, name, errp); 871 Object *target = NULL; 872 873 if (str && *str) { 874 target = object_resolve_path(str, NULL); 875 if (!target) { 876 error_set(errp, QERR_DEVICE_NOT_FOUND, str); 877 } 878 } 879 880 g_free(str); 881 return target; 882 } 883 884 void object_property_set_bool(Object *obj, bool value, 885 const char *name, Error **errp) 886 { 887 QBool *qbool = qbool_from_int(value); 888 object_property_set_qobject(obj, QOBJECT(qbool), name, errp); 889 890 QDECREF(qbool); 891 } 892 893 bool object_property_get_bool(Object *obj, const char *name, 894 Error **errp) 895 { 896 QObject *ret = object_property_get_qobject(obj, name, errp); 897 QBool *qbool; 898 bool retval; 899 900 if (!ret) { 901 return false; 902 } 903 qbool = qobject_to_qbool(ret); 904 if (!qbool) { 905 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean"); 906 retval = false; 907 } else { 908 retval = qbool_get_int(qbool); 909 } 910 911 QDECREF(qbool); 912 return retval; 913 } 914 915 void object_property_set_int(Object *obj, int64_t value, 916 const char *name, Error **errp) 917 { 918 QInt *qint = qint_from_int(value); 919 object_property_set_qobject(obj, QOBJECT(qint), name, errp); 920 921 QDECREF(qint); 922 } 923 924 int64_t object_property_get_int(Object *obj, const char *name, 925 Error **errp) 926 { 927 QObject *ret = object_property_get_qobject(obj, name, errp); 928 QInt *qint; 929 int64_t retval; 930 931 if (!ret) { 932 return -1; 933 } 934 qint = qobject_to_qint(ret); 935 if (!qint) { 936 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "int"); 937 retval = -1; 938 } else { 939 retval = qint_get_int(qint); 940 } 941 942 QDECREF(qint); 943 return retval; 944 } 945 946 int object_property_get_enum(Object *obj, const char *name, 947 const char *strings[], Error **errp) 948 { 949 StringOutputVisitor *sov; 950 StringInputVisitor *siv; 951 int ret; 952 953 sov = string_output_visitor_new(false); 954 object_property_get(obj, string_output_get_visitor(sov), name, errp); 955 siv = string_input_visitor_new(string_output_get_string(sov)); 956 string_output_visitor_cleanup(sov); 957 visit_type_enum(string_input_get_visitor(siv), 958 &ret, strings, NULL, name, errp); 959 string_input_visitor_cleanup(siv); 960 961 return ret; 962 } 963 964 void object_property_get_uint16List(Object *obj, const char *name, 965 uint16List **list, Error **errp) 966 { 967 StringOutputVisitor *ov; 968 StringInputVisitor *iv; 969 970 ov = string_output_visitor_new(false); 971 object_property_get(obj, string_output_get_visitor(ov), 972 name, errp); 973 iv = string_input_visitor_new(string_output_get_string(ov)); 974 visit_type_uint16List(string_input_get_visitor(iv), 975 list, NULL, errp); 976 string_output_visitor_cleanup(ov); 977 string_input_visitor_cleanup(iv); 978 } 979 980 void object_property_parse(Object *obj, const char *string, 981 const char *name, Error **errp) 982 { 983 StringInputVisitor *mi; 984 mi = string_input_visitor_new(string); 985 object_property_set(obj, string_input_get_visitor(mi), name, errp); 986 987 string_input_visitor_cleanup(mi); 988 } 989 990 char *object_property_print(Object *obj, const char *name, bool human, 991 Error **errp) 992 { 993 StringOutputVisitor *mo; 994 char *string; 995 996 mo = string_output_visitor_new(human); 997 object_property_get(obj, string_output_get_visitor(mo), name, errp); 998 string = string_output_get_string(mo); 999 string_output_visitor_cleanup(mo); 1000 return string; 1001 } 1002 1003 const char *object_property_get_type(Object *obj, const char *name, Error **errp) 1004 { 1005 ObjectProperty *prop = object_property_find(obj, name, errp); 1006 if (prop == NULL) { 1007 return NULL; 1008 } 1009 1010 return prop->type; 1011 } 1012 1013 Object *object_get_root(void) 1014 { 1015 static Object *root; 1016 1017 if (!root) { 1018 root = object_new("container"); 1019 } 1020 1021 return root; 1022 } 1023 1024 static void object_get_child_property(Object *obj, Visitor *v, void *opaque, 1025 const char *name, Error **errp) 1026 { 1027 Object *child = opaque; 1028 gchar *path; 1029 1030 path = object_get_canonical_path(child); 1031 visit_type_str(v, &path, name, errp); 1032 g_free(path); 1033 } 1034 1035 static Object *object_resolve_child_property(Object *parent, void *opaque, const gchar *part) 1036 { 1037 return opaque; 1038 } 1039 1040 static void object_finalize_child_property(Object *obj, const char *name, 1041 void *opaque) 1042 { 1043 Object *child = opaque; 1044 1045 object_unref(child); 1046 } 1047 1048 void object_property_add_child(Object *obj, const char *name, 1049 Object *child, Error **errp) 1050 { 1051 Error *local_err = NULL; 1052 gchar *type; 1053 ObjectProperty *op; 1054 1055 type = g_strdup_printf("child<%s>", object_get_typename(OBJECT(child))); 1056 1057 op = object_property_add(obj, name, type, object_get_child_property, NULL, 1058 object_finalize_child_property, child, &local_err); 1059 if (local_err) { 1060 error_propagate(errp, local_err); 1061 goto out; 1062 } 1063 1064 op->resolve = object_resolve_child_property; 1065 object_ref(child); 1066 g_assert(child->parent == NULL); 1067 child->parent = obj; 1068 1069 out: 1070 g_free(type); 1071 } 1072 1073 void object_property_allow_set_link(Object *obj, const char *name, 1074 Object *val, Error **errp) 1075 { 1076 /* Allow the link to be set, always */ 1077 } 1078 1079 typedef struct { 1080 Object **child; 1081 void (*check)(Object *, const char *, Object *, Error **); 1082 ObjectPropertyLinkFlags flags; 1083 } LinkProperty; 1084 1085 static void object_get_link_property(Object *obj, Visitor *v, void *opaque, 1086 const char *name, Error **errp) 1087 { 1088 LinkProperty *lprop = opaque; 1089 Object **child = lprop->child; 1090 gchar *path; 1091 1092 if (*child) { 1093 path = object_get_canonical_path(*child); 1094 visit_type_str(v, &path, name, errp); 1095 g_free(path); 1096 } else { 1097 path = (gchar *)""; 1098 visit_type_str(v, &path, name, errp); 1099 } 1100 } 1101 1102 /* 1103 * object_resolve_link: 1104 * 1105 * Lookup an object and ensure its type matches the link property type. This 1106 * is similar to object_resolve_path() except type verification against the 1107 * link property is performed. 1108 * 1109 * Returns: The matched object or NULL on path lookup failures. 1110 */ 1111 static Object *object_resolve_link(Object *obj, const char *name, 1112 const char *path, Error **errp) 1113 { 1114 const char *type; 1115 gchar *target_type; 1116 bool ambiguous = false; 1117 Object *target; 1118 1119 /* Go from link<FOO> to FOO. */ 1120 type = object_property_get_type(obj, name, NULL); 1121 target_type = g_strndup(&type[5], strlen(type) - 6); 1122 target = object_resolve_path_type(path, target_type, &ambiguous); 1123 1124 if (ambiguous) { 1125 error_set(errp, ERROR_CLASS_GENERIC_ERROR, 1126 "Path '%s' does not uniquely identify an object", path); 1127 } else if (!target) { 1128 target = object_resolve_path(path, &ambiguous); 1129 if (target || ambiguous) { 1130 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type); 1131 } else { 1132 error_set(errp, QERR_DEVICE_NOT_FOUND, path); 1133 } 1134 target = NULL; 1135 } 1136 g_free(target_type); 1137 1138 return target; 1139 } 1140 1141 static void object_set_link_property(Object *obj, Visitor *v, void *opaque, 1142 const char *name, Error **errp) 1143 { 1144 Error *local_err = NULL; 1145 LinkProperty *prop = opaque; 1146 Object **child = prop->child; 1147 Object *old_target = *child; 1148 Object *new_target = NULL; 1149 char *path = NULL; 1150 1151 visit_type_str(v, &path, name, &local_err); 1152 1153 if (!local_err && strcmp(path, "") != 0) { 1154 new_target = object_resolve_link(obj, name, path, &local_err); 1155 } 1156 1157 g_free(path); 1158 if (local_err) { 1159 error_propagate(errp, local_err); 1160 return; 1161 } 1162 1163 prop->check(obj, name, new_target, &local_err); 1164 if (local_err) { 1165 error_propagate(errp, local_err); 1166 return; 1167 } 1168 1169 object_ref(new_target); 1170 *child = new_target; 1171 object_unref(old_target); 1172 } 1173 1174 static Object *object_resolve_link_property(Object *parent, void *opaque, const gchar *part) 1175 { 1176 LinkProperty *lprop = opaque; 1177 1178 return *lprop->child; 1179 } 1180 1181 static void object_release_link_property(Object *obj, const char *name, 1182 void *opaque) 1183 { 1184 LinkProperty *prop = opaque; 1185 1186 if ((prop->flags & OBJ_PROP_LINK_UNREF_ON_RELEASE) && *prop->child) { 1187 object_unref(*prop->child); 1188 } 1189 g_free(prop); 1190 } 1191 1192 void object_property_add_link(Object *obj, const char *name, 1193 const char *type, Object **child, 1194 void (*check)(Object *, const char *, 1195 Object *, Error **), 1196 ObjectPropertyLinkFlags flags, 1197 Error **errp) 1198 { 1199 Error *local_err = NULL; 1200 LinkProperty *prop = g_malloc(sizeof(*prop)); 1201 gchar *full_type; 1202 ObjectProperty *op; 1203 1204 prop->child = child; 1205 prop->check = check; 1206 prop->flags = flags; 1207 1208 full_type = g_strdup_printf("link<%s>", type); 1209 1210 op = object_property_add(obj, name, full_type, 1211 object_get_link_property, 1212 check ? object_set_link_property : NULL, 1213 object_release_link_property, 1214 prop, 1215 &local_err); 1216 if (local_err) { 1217 error_propagate(errp, local_err); 1218 g_free(prop); 1219 goto out; 1220 } 1221 1222 op->resolve = object_resolve_link_property; 1223 1224 out: 1225 g_free(full_type); 1226 } 1227 1228 gchar *object_get_canonical_path_component(Object *obj) 1229 { 1230 ObjectProperty *prop = NULL; 1231 1232 g_assert(obj); 1233 g_assert(obj->parent != NULL); 1234 1235 QTAILQ_FOREACH(prop, &obj->parent->properties, node) { 1236 if (!object_property_is_child(prop)) { 1237 continue; 1238 } 1239 1240 if (prop->opaque == obj) { 1241 return g_strdup(prop->name); 1242 } 1243 } 1244 1245 /* obj had a parent but was not a child, should never happen */ 1246 g_assert_not_reached(); 1247 return NULL; 1248 } 1249 1250 gchar *object_get_canonical_path(Object *obj) 1251 { 1252 Object *root = object_get_root(); 1253 char *newpath, *path = NULL; 1254 1255 while (obj != root) { 1256 char *component = object_get_canonical_path_component(obj); 1257 1258 if (path) { 1259 newpath = g_strdup_printf("%s/%s", component, path); 1260 g_free(component); 1261 g_free(path); 1262 path = newpath; 1263 } else { 1264 path = component; 1265 } 1266 1267 obj = obj->parent; 1268 } 1269 1270 newpath = g_strdup_printf("/%s", path ? path : ""); 1271 g_free(path); 1272 1273 return newpath; 1274 } 1275 1276 Object *object_resolve_path_component(Object *parent, const gchar *part) 1277 { 1278 ObjectProperty *prop = object_property_find(parent, part, NULL); 1279 if (prop == NULL) { 1280 return NULL; 1281 } 1282 1283 if (prop->resolve) { 1284 return prop->resolve(parent, prop->opaque, part); 1285 } else { 1286 return NULL; 1287 } 1288 } 1289 1290 static Object *object_resolve_abs_path(Object *parent, 1291 gchar **parts, 1292 const char *typename, 1293 int index) 1294 { 1295 Object *child; 1296 1297 if (parts[index] == NULL) { 1298 return object_dynamic_cast(parent, typename); 1299 } 1300 1301 if (strcmp(parts[index], "") == 0) { 1302 return object_resolve_abs_path(parent, parts, typename, index + 1); 1303 } 1304 1305 child = object_resolve_path_component(parent, parts[index]); 1306 if (!child) { 1307 return NULL; 1308 } 1309 1310 return object_resolve_abs_path(child, parts, typename, index + 1); 1311 } 1312 1313 static Object *object_resolve_partial_path(Object *parent, 1314 gchar **parts, 1315 const char *typename, 1316 bool *ambiguous) 1317 { 1318 Object *obj; 1319 ObjectProperty *prop; 1320 1321 obj = object_resolve_abs_path(parent, parts, typename, 0); 1322 1323 QTAILQ_FOREACH(prop, &parent->properties, node) { 1324 Object *found; 1325 1326 if (!object_property_is_child(prop)) { 1327 continue; 1328 } 1329 1330 found = object_resolve_partial_path(prop->opaque, parts, 1331 typename, ambiguous); 1332 if (found) { 1333 if (obj) { 1334 if (ambiguous) { 1335 *ambiguous = true; 1336 } 1337 return NULL; 1338 } 1339 obj = found; 1340 } 1341 1342 if (ambiguous && *ambiguous) { 1343 return NULL; 1344 } 1345 } 1346 1347 return obj; 1348 } 1349 1350 Object *object_resolve_path_type(const char *path, const char *typename, 1351 bool *ambiguous) 1352 { 1353 Object *obj; 1354 gchar **parts; 1355 1356 parts = g_strsplit(path, "/", 0); 1357 assert(parts); 1358 1359 if (parts[0] == NULL || strcmp(parts[0], "") != 0) { 1360 if (ambiguous) { 1361 *ambiguous = false; 1362 } 1363 obj = object_resolve_partial_path(object_get_root(), parts, 1364 typename, ambiguous); 1365 } else { 1366 obj = object_resolve_abs_path(object_get_root(), parts, typename, 1); 1367 } 1368 1369 g_strfreev(parts); 1370 1371 return obj; 1372 } 1373 1374 Object *object_resolve_path(const char *path, bool *ambiguous) 1375 { 1376 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous); 1377 } 1378 1379 typedef struct StringProperty 1380 { 1381 char *(*get)(Object *, Error **); 1382 void (*set)(Object *, const char *, Error **); 1383 } StringProperty; 1384 1385 static void property_get_str(Object *obj, Visitor *v, void *opaque, 1386 const char *name, Error **errp) 1387 { 1388 StringProperty *prop = opaque; 1389 char *value; 1390 1391 value = prop->get(obj, errp); 1392 if (value) { 1393 visit_type_str(v, &value, name, errp); 1394 g_free(value); 1395 } 1396 } 1397 1398 static void property_set_str(Object *obj, Visitor *v, void *opaque, 1399 const char *name, Error **errp) 1400 { 1401 StringProperty *prop = opaque; 1402 char *value; 1403 Error *local_err = NULL; 1404 1405 visit_type_str(v, &value, name, &local_err); 1406 if (local_err) { 1407 error_propagate(errp, local_err); 1408 return; 1409 } 1410 1411 prop->set(obj, value, errp); 1412 g_free(value); 1413 } 1414 1415 static void property_release_str(Object *obj, const char *name, 1416 void *opaque) 1417 { 1418 StringProperty *prop = opaque; 1419 g_free(prop); 1420 } 1421 1422 void object_property_add_str(Object *obj, const char *name, 1423 char *(*get)(Object *, Error **), 1424 void (*set)(Object *, const char *, Error **), 1425 Error **errp) 1426 { 1427 Error *local_err = NULL; 1428 StringProperty *prop = g_malloc0(sizeof(*prop)); 1429 1430 prop->get = get; 1431 prop->set = set; 1432 1433 object_property_add(obj, name, "string", 1434 get ? property_get_str : NULL, 1435 set ? property_set_str : NULL, 1436 property_release_str, 1437 prop, &local_err); 1438 if (local_err) { 1439 error_propagate(errp, local_err); 1440 g_free(prop); 1441 } 1442 } 1443 1444 typedef struct BoolProperty 1445 { 1446 bool (*get)(Object *, Error **); 1447 void (*set)(Object *, bool, Error **); 1448 } BoolProperty; 1449 1450 static void property_get_bool(Object *obj, Visitor *v, void *opaque, 1451 const char *name, Error **errp) 1452 { 1453 BoolProperty *prop = opaque; 1454 bool value; 1455 1456 value = prop->get(obj, errp); 1457 visit_type_bool(v, &value, name, errp); 1458 } 1459 1460 static void property_set_bool(Object *obj, Visitor *v, void *opaque, 1461 const char *name, Error **errp) 1462 { 1463 BoolProperty *prop = opaque; 1464 bool value; 1465 Error *local_err = NULL; 1466 1467 visit_type_bool(v, &value, name, &local_err); 1468 if (local_err) { 1469 error_propagate(errp, local_err); 1470 return; 1471 } 1472 1473 prop->set(obj, value, errp); 1474 } 1475 1476 static void property_release_bool(Object *obj, const char *name, 1477 void *opaque) 1478 { 1479 BoolProperty *prop = opaque; 1480 g_free(prop); 1481 } 1482 1483 void object_property_add_bool(Object *obj, const char *name, 1484 bool (*get)(Object *, Error **), 1485 void (*set)(Object *, bool, Error **), 1486 Error **errp) 1487 { 1488 Error *local_err = NULL; 1489 BoolProperty *prop = g_malloc0(sizeof(*prop)); 1490 1491 prop->get = get; 1492 prop->set = set; 1493 1494 object_property_add(obj, name, "bool", 1495 get ? property_get_bool : NULL, 1496 set ? property_set_bool : NULL, 1497 property_release_bool, 1498 prop, &local_err); 1499 if (local_err) { 1500 error_propagate(errp, local_err); 1501 g_free(prop); 1502 } 1503 } 1504 1505 static char *qdev_get_type(Object *obj, Error **errp) 1506 { 1507 return g_strdup(object_get_typename(obj)); 1508 } 1509 1510 static void property_get_uint8_ptr(Object *obj, Visitor *v, 1511 void *opaque, const char *name, 1512 Error **errp) 1513 { 1514 uint8_t value = *(uint8_t *)opaque; 1515 visit_type_uint8(v, &value, name, errp); 1516 } 1517 1518 static void property_get_uint16_ptr(Object *obj, Visitor *v, 1519 void *opaque, const char *name, 1520 Error **errp) 1521 { 1522 uint16_t value = *(uint16_t *)opaque; 1523 visit_type_uint16(v, &value, name, errp); 1524 } 1525 1526 static void property_get_uint32_ptr(Object *obj, Visitor *v, 1527 void *opaque, const char *name, 1528 Error **errp) 1529 { 1530 uint32_t value = *(uint32_t *)opaque; 1531 visit_type_uint32(v, &value, name, errp); 1532 } 1533 1534 static void property_get_uint64_ptr(Object *obj, Visitor *v, 1535 void *opaque, const char *name, 1536 Error **errp) 1537 { 1538 uint64_t value = *(uint64_t *)opaque; 1539 visit_type_uint64(v, &value, name, errp); 1540 } 1541 1542 void object_property_add_uint8_ptr(Object *obj, const char *name, 1543 const uint8_t *v, Error **errp) 1544 { 1545 object_property_add(obj, name, "uint8", property_get_uint8_ptr, 1546 NULL, NULL, (void *)v, errp); 1547 } 1548 1549 void object_property_add_uint16_ptr(Object *obj, const char *name, 1550 const uint16_t *v, Error **errp) 1551 { 1552 object_property_add(obj, name, "uint16", property_get_uint16_ptr, 1553 NULL, NULL, (void *)v, errp); 1554 } 1555 1556 void object_property_add_uint32_ptr(Object *obj, const char *name, 1557 const uint32_t *v, Error **errp) 1558 { 1559 object_property_add(obj, name, "uint32", property_get_uint32_ptr, 1560 NULL, NULL, (void *)v, errp); 1561 } 1562 1563 void object_property_add_uint64_ptr(Object *obj, const char *name, 1564 const uint64_t *v, Error **errp) 1565 { 1566 object_property_add(obj, name, "uint64", property_get_uint64_ptr, 1567 NULL, NULL, (void *)v, errp); 1568 } 1569 1570 typedef struct { 1571 Object *target_obj; 1572 const char *target_name; 1573 } AliasProperty; 1574 1575 static void property_get_alias(Object *obj, struct Visitor *v, void *opaque, 1576 const char *name, Error **errp) 1577 { 1578 AliasProperty *prop = opaque; 1579 1580 object_property_get(prop->target_obj, v, prop->target_name, errp); 1581 } 1582 1583 static void property_set_alias(Object *obj, struct Visitor *v, void *opaque, 1584 const char *name, Error **errp) 1585 { 1586 AliasProperty *prop = opaque; 1587 1588 object_property_set(prop->target_obj, v, prop->target_name, errp); 1589 } 1590 1591 static Object *property_resolve_alias(Object *obj, void *opaque, 1592 const gchar *part) 1593 { 1594 AliasProperty *prop = opaque; 1595 1596 return object_resolve_path_component(prop->target_obj, prop->target_name); 1597 } 1598 1599 static void property_release_alias(Object *obj, const char *name, void *opaque) 1600 { 1601 AliasProperty *prop = opaque; 1602 1603 g_free(prop); 1604 } 1605 1606 void object_property_add_alias(Object *obj, const char *name, 1607 Object *target_obj, const char *target_name, 1608 Error **errp) 1609 { 1610 AliasProperty *prop; 1611 ObjectProperty *op; 1612 ObjectProperty *target_prop; 1613 gchar *prop_type; 1614 1615 target_prop = object_property_find(target_obj, target_name, errp); 1616 if (!target_prop) { 1617 return; 1618 } 1619 1620 if (object_property_is_child(target_prop)) { 1621 prop_type = g_strdup_printf("link%s", 1622 target_prop->type + strlen("child")); 1623 } else { 1624 prop_type = g_strdup(target_prop->type); 1625 } 1626 1627 prop = g_malloc(sizeof(*prop)); 1628 prop->target_obj = target_obj; 1629 prop->target_name = target_name; 1630 1631 op = object_property_add(obj, name, prop_type, 1632 property_get_alias, 1633 property_set_alias, 1634 property_release_alias, 1635 prop, errp); 1636 op->resolve = property_resolve_alias; 1637 1638 g_free(prop_type); 1639 } 1640 1641 static void object_instance_init(Object *obj) 1642 { 1643 object_property_add_str(obj, "type", qdev_get_type, NULL, NULL); 1644 } 1645 1646 static void register_types(void) 1647 { 1648 static TypeInfo interface_info = { 1649 .name = TYPE_INTERFACE, 1650 .class_size = sizeof(InterfaceClass), 1651 .abstract = true, 1652 }; 1653 1654 static TypeInfo object_info = { 1655 .name = TYPE_OBJECT, 1656 .instance_size = sizeof(Object), 1657 .instance_init = object_instance_init, 1658 .abstract = true, 1659 }; 1660 1661 type_interface = type_register_internal(&interface_info); 1662 type_register_internal(&object_info); 1663 } 1664 1665 type_init(register_types) 1666