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 "qom/object.h" 15 #include "qom/object_interfaces.h" 16 #include "qemu-common.h" 17 #include "qapi/visitor.h" 18 #include "qapi-visit.h" 19 #include "qapi/string-input-visitor.h" 20 #include "qapi/string-output-visitor.h" 21 #include "qapi/qmp/qerror.h" 22 #include "trace.h" 23 24 /* TODO: replace QObject with a simpler visitor to avoid a dependency 25 * of the QOM core on QObject? */ 26 #include "qom/qom-qobject.h" 27 #include "qapi/qmp/qobject.h" 28 #include "qapi/qmp/qbool.h" 29 #include "qapi/qmp/qint.h" 30 #include "qapi/qmp/qstring.h" 31 32 #define MAX_INTERFACES 32 33 34 typedef struct InterfaceImpl InterfaceImpl; 35 typedef struct TypeImpl TypeImpl; 36 37 struct InterfaceImpl 38 { 39 const char *typename; 40 }; 41 42 struct TypeImpl 43 { 44 const char *name; 45 46 size_t class_size; 47 48 size_t instance_size; 49 50 void (*class_init)(ObjectClass *klass, void *data); 51 void (*class_base_init)(ObjectClass *klass, void *data); 52 void (*class_finalize)(ObjectClass *klass, void *data); 53 54 void *class_data; 55 56 void (*instance_init)(Object *obj); 57 void (*instance_post_init)(Object *obj); 58 void (*instance_finalize)(Object *obj); 59 60 bool abstract; 61 62 const char *parent; 63 TypeImpl *parent_type; 64 65 ObjectClass *class; 66 67 int num_interfaces; 68 InterfaceImpl interfaces[MAX_INTERFACES]; 69 }; 70 71 static Type type_interface; 72 73 static GHashTable *type_table_get(void) 74 { 75 static GHashTable *type_table; 76 77 if (type_table == NULL) { 78 type_table = g_hash_table_new(g_str_hash, g_str_equal); 79 } 80 81 return type_table; 82 } 83 84 static bool enumerating_types; 85 86 static void type_table_add(TypeImpl *ti) 87 { 88 assert(!enumerating_types); 89 g_hash_table_insert(type_table_get(), (void *)ti->name, ti); 90 } 91 92 static TypeImpl *type_table_lookup(const char *name) 93 { 94 return g_hash_table_lookup(type_table_get(), name); 95 } 96 97 static TypeImpl *type_new(const TypeInfo *info) 98 { 99 TypeImpl *ti = g_malloc0(sizeof(*ti)); 100 int i; 101 102 g_assert(info->name != NULL); 103 104 if (type_table_lookup(info->name) != NULL) { 105 fprintf(stderr, "Registering `%s' which already exists\n", info->name); 106 abort(); 107 } 108 109 ti->name = g_strdup(info->name); 110 ti->parent = g_strdup(info->parent); 111 112 ti->class_size = info->class_size; 113 ti->instance_size = info->instance_size; 114 115 ti->class_init = info->class_init; 116 ti->class_base_init = info->class_base_init; 117 ti->class_finalize = info->class_finalize; 118 ti->class_data = info->class_data; 119 120 ti->instance_init = info->instance_init; 121 ti->instance_post_init = info->instance_post_init; 122 ti->instance_finalize = info->instance_finalize; 123 124 ti->abstract = info->abstract; 125 126 for (i = 0; info->interfaces && info->interfaces[i].type; i++) { 127 ti->interfaces[i].typename = g_strdup(info->interfaces[i].type); 128 } 129 ti->num_interfaces = i; 130 131 return ti; 132 } 133 134 static TypeImpl *type_register_internal(const TypeInfo *info) 135 { 136 TypeImpl *ti; 137 ti = type_new(info); 138 139 type_table_add(ti); 140 return ti; 141 } 142 143 TypeImpl *type_register(const TypeInfo *info) 144 { 145 assert(info->parent); 146 return type_register_internal(info); 147 } 148 149 TypeImpl *type_register_static(const TypeInfo *info) 150 { 151 return type_register(info); 152 } 153 154 static TypeImpl *type_get_by_name(const char *name) 155 { 156 if (name == NULL) { 157 return NULL; 158 } 159 160 return type_table_lookup(name); 161 } 162 163 static TypeImpl *type_get_parent(TypeImpl *type) 164 { 165 if (!type->parent_type && type->parent) { 166 type->parent_type = type_get_by_name(type->parent); 167 g_assert(type->parent_type != NULL); 168 } 169 170 return type->parent_type; 171 } 172 173 static bool type_has_parent(TypeImpl *type) 174 { 175 return (type->parent != NULL); 176 } 177 178 static size_t type_class_get_size(TypeImpl *ti) 179 { 180 if (ti->class_size) { 181 return ti->class_size; 182 } 183 184 if (type_has_parent(ti)) { 185 return type_class_get_size(type_get_parent(ti)); 186 } 187 188 return sizeof(ObjectClass); 189 } 190 191 static size_t type_object_get_size(TypeImpl *ti) 192 { 193 if (ti->instance_size) { 194 return ti->instance_size; 195 } 196 197 if (type_has_parent(ti)) { 198 return type_object_get_size(type_get_parent(ti)); 199 } 200 201 return 0; 202 } 203 204 static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type) 205 { 206 assert(target_type); 207 208 /* Check if target_type is a direct ancestor of type */ 209 while (type) { 210 if (type == target_type) { 211 return true; 212 } 213 214 type = type_get_parent(type); 215 } 216 217 return false; 218 } 219 220 static void type_initialize(TypeImpl *ti); 221 222 static void type_initialize_interface(TypeImpl *ti, TypeImpl *interface_type, 223 TypeImpl *parent_type) 224 { 225 InterfaceClass *new_iface; 226 TypeInfo info = { }; 227 TypeImpl *iface_impl; 228 229 info.parent = parent_type->name; 230 info.name = g_strdup_printf("%s::%s", ti->name, interface_type->name); 231 info.abstract = true; 232 233 iface_impl = type_new(&info); 234 iface_impl->parent_type = parent_type; 235 type_initialize(iface_impl); 236 g_free((char *)info.name); 237 238 new_iface = (InterfaceClass *)iface_impl->class; 239 new_iface->concrete_class = ti->class; 240 new_iface->interface_type = interface_type; 241 242 ti->class->interfaces = g_slist_append(ti->class->interfaces, 243 iface_impl->class); 244 } 245 246 static void object_property_free(gpointer data) 247 { 248 ObjectProperty *prop = data; 249 250 g_free(prop->name); 251 g_free(prop->type); 252 g_free(prop->description); 253 g_free(prop); 254 } 255 256 static void type_initialize(TypeImpl *ti) 257 { 258 TypeImpl *parent; 259 260 if (ti->class) { 261 return; 262 } 263 264 ti->class_size = type_class_get_size(ti); 265 ti->instance_size = type_object_get_size(ti); 266 267 ti->class = g_malloc0(ti->class_size); 268 269 parent = type_get_parent(ti); 270 if (parent) { 271 type_initialize(parent); 272 GSList *e; 273 int i; 274 275 g_assert_cmpint(parent->class_size, <=, ti->class_size); 276 memcpy(ti->class, parent->class, parent->class_size); 277 ti->class->interfaces = NULL; 278 ti->class->properties = g_hash_table_new_full( 279 g_str_hash, g_str_equal, g_free, object_property_free); 280 281 for (e = parent->class->interfaces; e; e = e->next) { 282 InterfaceClass *iface = e->data; 283 ObjectClass *klass = OBJECT_CLASS(iface); 284 285 type_initialize_interface(ti, iface->interface_type, klass->type); 286 } 287 288 for (i = 0; i < ti->num_interfaces; i++) { 289 TypeImpl *t = type_get_by_name(ti->interfaces[i].typename); 290 for (e = ti->class->interfaces; e; e = e->next) { 291 TypeImpl *target_type = OBJECT_CLASS(e->data)->type; 292 293 if (type_is_ancestor(target_type, t)) { 294 break; 295 } 296 } 297 298 if (e) { 299 continue; 300 } 301 302 type_initialize_interface(ti, t, t); 303 } 304 } else { 305 ti->class->properties = g_hash_table_new_full( 306 g_str_hash, g_str_equal, g_free, object_property_free); 307 } 308 309 ti->class->type = ti; 310 311 while (parent) { 312 if (parent->class_base_init) { 313 parent->class_base_init(ti->class, ti->class_data); 314 } 315 parent = type_get_parent(parent); 316 } 317 318 if (ti->class_init) { 319 ti->class_init(ti->class, ti->class_data); 320 } 321 } 322 323 static void object_init_with_type(Object *obj, TypeImpl *ti) 324 { 325 if (type_has_parent(ti)) { 326 object_init_with_type(obj, type_get_parent(ti)); 327 } 328 329 if (ti->instance_init) { 330 ti->instance_init(obj); 331 } 332 } 333 334 static void object_post_init_with_type(Object *obj, TypeImpl *ti) 335 { 336 if (ti->instance_post_init) { 337 ti->instance_post_init(obj); 338 } 339 340 if (type_has_parent(ti)) { 341 object_post_init_with_type(obj, type_get_parent(ti)); 342 } 343 } 344 345 void object_initialize_with_type(void *data, size_t size, TypeImpl *type) 346 { 347 Object *obj = data; 348 349 g_assert(type != NULL); 350 type_initialize(type); 351 352 g_assert_cmpint(type->instance_size, >=, sizeof(Object)); 353 g_assert(type->abstract == false); 354 g_assert_cmpint(size, >=, type->instance_size); 355 356 memset(obj, 0, type->instance_size); 357 obj->class = type->class; 358 object_ref(obj); 359 obj->properties = g_hash_table_new_full(g_str_hash, g_str_equal, 360 NULL, object_property_free); 361 object_init_with_type(obj, type); 362 object_post_init_with_type(obj, type); 363 } 364 365 void object_initialize(void *data, size_t size, const char *typename) 366 { 367 TypeImpl *type = type_get_by_name(typename); 368 369 object_initialize_with_type(data, size, type); 370 } 371 372 static inline bool object_property_is_child(ObjectProperty *prop) 373 { 374 return strstart(prop->type, "child<", NULL); 375 } 376 377 static void object_property_del_all(Object *obj) 378 { 379 ObjectProperty *prop; 380 GHashTableIter iter; 381 gpointer key, value; 382 bool released; 383 384 do { 385 released = false; 386 g_hash_table_iter_init(&iter, obj->properties); 387 while (g_hash_table_iter_next(&iter, &key, &value)) { 388 prop = value; 389 if (prop->release) { 390 prop->release(obj, prop->name, prop->opaque); 391 prop->release = NULL; 392 released = true; 393 break; 394 } 395 g_hash_table_iter_remove(&iter); 396 } 397 } while (released); 398 399 g_hash_table_unref(obj->properties); 400 } 401 402 static void object_property_del_child(Object *obj, Object *child, Error **errp) 403 { 404 ObjectProperty *prop; 405 GHashTableIter iter; 406 gpointer key, value; 407 408 g_hash_table_iter_init(&iter, obj->properties); 409 while (g_hash_table_iter_next(&iter, &key, &value)) { 410 prop = value; 411 if (object_property_is_child(prop) && prop->opaque == child) { 412 if (prop->release) { 413 prop->release(obj, prop->name, prop->opaque); 414 prop->release = NULL; 415 } 416 break; 417 } 418 } 419 g_hash_table_iter_init(&iter, obj->properties); 420 while (g_hash_table_iter_next(&iter, &key, &value)) { 421 prop = value; 422 if (object_property_is_child(prop) && prop->opaque == child) { 423 g_hash_table_iter_remove(&iter); 424 break; 425 } 426 } 427 } 428 429 void object_unparent(Object *obj) 430 { 431 if (obj->parent) { 432 object_property_del_child(obj->parent, obj, NULL); 433 } 434 } 435 436 static void object_deinit(Object *obj, TypeImpl *type) 437 { 438 if (type->instance_finalize) { 439 type->instance_finalize(obj); 440 } 441 442 if (type_has_parent(type)) { 443 object_deinit(obj, type_get_parent(type)); 444 } 445 } 446 447 static void object_finalize(void *data) 448 { 449 Object *obj = data; 450 TypeImpl *ti = obj->class->type; 451 452 object_property_del_all(obj); 453 object_deinit(obj, ti); 454 455 g_assert_cmpint(obj->ref, ==, 0); 456 if (obj->free) { 457 obj->free(obj); 458 } 459 } 460 461 Object *object_new_with_type(Type type) 462 { 463 Object *obj; 464 465 g_assert(type != NULL); 466 type_initialize(type); 467 468 obj = g_malloc(type->instance_size); 469 object_initialize_with_type(obj, type->instance_size, type); 470 obj->free = g_free; 471 472 return obj; 473 } 474 475 Object *object_new(const char *typename) 476 { 477 TypeImpl *ti = type_get_by_name(typename); 478 479 return object_new_with_type(ti); 480 } 481 482 483 Object *object_new_with_props(const char *typename, 484 Object *parent, 485 const char *id, 486 Error **errp, 487 ...) 488 { 489 va_list vargs; 490 Object *obj; 491 492 va_start(vargs, errp); 493 obj = object_new_with_propv(typename, parent, id, errp, vargs); 494 va_end(vargs); 495 496 return obj; 497 } 498 499 500 Object *object_new_with_propv(const char *typename, 501 Object *parent, 502 const char *id, 503 Error **errp, 504 va_list vargs) 505 { 506 Object *obj; 507 ObjectClass *klass; 508 Error *local_err = NULL; 509 510 klass = object_class_by_name(typename); 511 if (!klass) { 512 error_setg(errp, "invalid object type: %s", typename); 513 return NULL; 514 } 515 516 if (object_class_is_abstract(klass)) { 517 error_setg(errp, "object type '%s' is abstract", typename); 518 return NULL; 519 } 520 obj = object_new(typename); 521 522 if (object_set_propv(obj, &local_err, vargs) < 0) { 523 goto error; 524 } 525 526 object_property_add_child(parent, id, obj, &local_err); 527 if (local_err) { 528 goto error; 529 } 530 531 if (object_dynamic_cast(obj, TYPE_USER_CREATABLE)) { 532 user_creatable_complete(obj, &local_err); 533 if (local_err) { 534 object_unparent(obj); 535 goto error; 536 } 537 } 538 539 object_unref(OBJECT(obj)); 540 return obj; 541 542 error: 543 if (local_err) { 544 error_propagate(errp, local_err); 545 } 546 object_unref(obj); 547 return NULL; 548 } 549 550 551 int object_set_props(Object *obj, 552 Error **errp, 553 ...) 554 { 555 va_list vargs; 556 int ret; 557 558 va_start(vargs, errp); 559 ret = object_set_propv(obj, errp, vargs); 560 va_end(vargs); 561 562 return ret; 563 } 564 565 566 int object_set_propv(Object *obj, 567 Error **errp, 568 va_list vargs) 569 { 570 const char *propname; 571 Error *local_err = NULL; 572 573 propname = va_arg(vargs, char *); 574 while (propname != NULL) { 575 const char *value = va_arg(vargs, char *); 576 577 g_assert(value != NULL); 578 object_property_parse(obj, value, propname, &local_err); 579 if (local_err) { 580 error_propagate(errp, local_err); 581 return -1; 582 } 583 propname = va_arg(vargs, char *); 584 } 585 586 return 0; 587 } 588 589 590 Object *object_dynamic_cast(Object *obj, const char *typename) 591 { 592 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) { 593 return obj; 594 } 595 596 return NULL; 597 } 598 599 Object *object_dynamic_cast_assert(Object *obj, const char *typename, 600 const char *file, int line, const char *func) 601 { 602 trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)", 603 typename, file, line, func); 604 605 #ifdef CONFIG_QOM_CAST_DEBUG 606 int i; 607 Object *inst; 608 609 for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) { 610 if (obj->class->object_cast_cache[i] == typename) { 611 goto out; 612 } 613 } 614 615 inst = object_dynamic_cast(obj, typename); 616 617 if (!inst && obj) { 618 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n", 619 file, line, func, obj, typename); 620 abort(); 621 } 622 623 assert(obj == inst); 624 625 if (obj && obj == inst) { 626 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) { 627 obj->class->object_cast_cache[i - 1] = 628 obj->class->object_cast_cache[i]; 629 } 630 obj->class->object_cast_cache[i - 1] = typename; 631 } 632 633 out: 634 #endif 635 return obj; 636 } 637 638 ObjectClass *object_class_dynamic_cast(ObjectClass *class, 639 const char *typename) 640 { 641 ObjectClass *ret = NULL; 642 TypeImpl *target_type; 643 TypeImpl *type; 644 645 if (!class) { 646 return NULL; 647 } 648 649 /* A simple fast path that can trigger a lot for leaf classes. */ 650 type = class->type; 651 if (type->name == typename) { 652 return class; 653 } 654 655 target_type = type_get_by_name(typename); 656 if (!target_type) { 657 /* target class type unknown, so fail the cast */ 658 return NULL; 659 } 660 661 if (type->class->interfaces && 662 type_is_ancestor(target_type, type_interface)) { 663 int found = 0; 664 GSList *i; 665 666 for (i = class->interfaces; i; i = i->next) { 667 ObjectClass *target_class = i->data; 668 669 if (type_is_ancestor(target_class->type, target_type)) { 670 ret = target_class; 671 found++; 672 } 673 } 674 675 /* The match was ambiguous, don't allow a cast */ 676 if (found > 1) { 677 ret = NULL; 678 } 679 } else if (type_is_ancestor(type, target_type)) { 680 ret = class; 681 } 682 683 return ret; 684 } 685 686 ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class, 687 const char *typename, 688 const char *file, int line, 689 const char *func) 690 { 691 ObjectClass *ret; 692 693 trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)", 694 typename, file, line, func); 695 696 #ifdef CONFIG_QOM_CAST_DEBUG 697 int i; 698 699 for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) { 700 if (class->class_cast_cache[i] == typename) { 701 ret = class; 702 goto out; 703 } 704 } 705 #else 706 if (!class || !class->interfaces) { 707 return class; 708 } 709 #endif 710 711 ret = object_class_dynamic_cast(class, typename); 712 if (!ret && class) { 713 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n", 714 file, line, func, class, typename); 715 abort(); 716 } 717 718 #ifdef CONFIG_QOM_CAST_DEBUG 719 if (class && ret == class) { 720 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) { 721 class->class_cast_cache[i - 1] = class->class_cast_cache[i]; 722 } 723 class->class_cast_cache[i - 1] = typename; 724 } 725 out: 726 #endif 727 return ret; 728 } 729 730 const char *object_get_typename(Object *obj) 731 { 732 return obj->class->type->name; 733 } 734 735 ObjectClass *object_get_class(Object *obj) 736 { 737 return obj->class; 738 } 739 740 bool object_class_is_abstract(ObjectClass *klass) 741 { 742 return klass->type->abstract; 743 } 744 745 const char *object_class_get_name(ObjectClass *klass) 746 { 747 return klass->type->name; 748 } 749 750 ObjectClass *object_class_by_name(const char *typename) 751 { 752 TypeImpl *type = type_get_by_name(typename); 753 754 if (!type) { 755 return NULL; 756 } 757 758 type_initialize(type); 759 760 return type->class; 761 } 762 763 ObjectClass *object_class_get_parent(ObjectClass *class) 764 { 765 TypeImpl *type = type_get_parent(class->type); 766 767 if (!type) { 768 return NULL; 769 } 770 771 type_initialize(type); 772 773 return type->class; 774 } 775 776 typedef struct OCFData 777 { 778 void (*fn)(ObjectClass *klass, void *opaque); 779 const char *implements_type; 780 bool include_abstract; 781 void *opaque; 782 } OCFData; 783 784 static void object_class_foreach_tramp(gpointer key, gpointer value, 785 gpointer opaque) 786 { 787 OCFData *data = opaque; 788 TypeImpl *type = value; 789 ObjectClass *k; 790 791 type_initialize(type); 792 k = type->class; 793 794 if (!data->include_abstract && type->abstract) { 795 return; 796 } 797 798 if (data->implements_type && 799 !object_class_dynamic_cast(k, data->implements_type)) { 800 return; 801 } 802 803 data->fn(k, data->opaque); 804 } 805 806 void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque), 807 const char *implements_type, bool include_abstract, 808 void *opaque) 809 { 810 OCFData data = { fn, implements_type, include_abstract, opaque }; 811 812 enumerating_types = true; 813 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data); 814 enumerating_types = false; 815 } 816 817 static int do_object_child_foreach(Object *obj, 818 int (*fn)(Object *child, void *opaque), 819 void *opaque, bool recurse) 820 { 821 GHashTableIter iter; 822 ObjectProperty *prop; 823 int ret = 0; 824 825 g_hash_table_iter_init(&iter, obj->properties); 826 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) { 827 if (object_property_is_child(prop)) { 828 Object *child = prop->opaque; 829 830 ret = fn(child, opaque); 831 if (ret != 0) { 832 break; 833 } 834 if (recurse) { 835 do_object_child_foreach(child, fn, opaque, true); 836 } 837 } 838 } 839 return ret; 840 } 841 842 int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque), 843 void *opaque) 844 { 845 return do_object_child_foreach(obj, fn, opaque, false); 846 } 847 848 int object_child_foreach_recursive(Object *obj, 849 int (*fn)(Object *child, void *opaque), 850 void *opaque) 851 { 852 return do_object_child_foreach(obj, fn, opaque, true); 853 } 854 855 static void object_class_get_list_tramp(ObjectClass *klass, void *opaque) 856 { 857 GSList **list = opaque; 858 859 *list = g_slist_prepend(*list, klass); 860 } 861 862 GSList *object_class_get_list(const char *implements_type, 863 bool include_abstract) 864 { 865 GSList *list = NULL; 866 867 object_class_foreach(object_class_get_list_tramp, 868 implements_type, include_abstract, &list); 869 return list; 870 } 871 872 void object_ref(Object *obj) 873 { 874 if (!obj) { 875 return; 876 } 877 atomic_inc(&obj->ref); 878 } 879 880 void object_unref(Object *obj) 881 { 882 if (!obj) { 883 return; 884 } 885 g_assert_cmpint(obj->ref, >, 0); 886 887 /* parent always holds a reference to its children */ 888 if (atomic_fetch_dec(&obj->ref) == 1) { 889 object_finalize(obj); 890 } 891 } 892 893 ObjectProperty * 894 object_property_add(Object *obj, const char *name, const char *type, 895 ObjectPropertyAccessor *get, 896 ObjectPropertyAccessor *set, 897 ObjectPropertyRelease *release, 898 void *opaque, Error **errp) 899 { 900 ObjectProperty *prop; 901 size_t name_len = strlen(name); 902 903 if (name_len >= 3 && !memcmp(name + name_len - 3, "[*]", 4)) { 904 int i; 905 ObjectProperty *ret; 906 char *name_no_array = g_strdup(name); 907 908 name_no_array[name_len - 3] = '\0'; 909 for (i = 0; ; ++i) { 910 char *full_name = g_strdup_printf("%s[%d]", name_no_array, i); 911 912 ret = object_property_add(obj, full_name, type, get, set, 913 release, opaque, NULL); 914 g_free(full_name); 915 if (ret) { 916 break; 917 } 918 } 919 g_free(name_no_array); 920 return ret; 921 } 922 923 if (object_property_find(obj, name, NULL) != NULL) { 924 error_setg(errp, "attempt to add duplicate property '%s'" 925 " to object (type '%s')", name, 926 object_get_typename(obj)); 927 return NULL; 928 } 929 930 prop = g_malloc0(sizeof(*prop)); 931 932 prop->name = g_strdup(name); 933 prop->type = g_strdup(type); 934 935 prop->get = get; 936 prop->set = set; 937 prop->release = release; 938 prop->opaque = opaque; 939 940 g_hash_table_insert(obj->properties, prop->name, prop); 941 return prop; 942 } 943 944 ObjectProperty * 945 object_class_property_add(ObjectClass *klass, 946 const char *name, 947 const char *type, 948 ObjectPropertyAccessor *get, 949 ObjectPropertyAccessor *set, 950 ObjectPropertyRelease *release, 951 void *opaque, 952 Error **errp) 953 { 954 ObjectProperty *prop; 955 956 if (object_class_property_find(klass, name, NULL) != NULL) { 957 error_setg(errp, "attempt to add duplicate property '%s'" 958 " to object (type '%s')", name, 959 object_class_get_name(klass)); 960 return NULL; 961 } 962 963 prop = g_malloc0(sizeof(*prop)); 964 965 prop->name = g_strdup(name); 966 prop->type = g_strdup(type); 967 968 prop->get = get; 969 prop->set = set; 970 prop->release = release; 971 prop->opaque = opaque; 972 973 g_hash_table_insert(klass->properties, g_strdup(name), prop); 974 975 return prop; 976 } 977 978 ObjectProperty *object_property_find(Object *obj, const char *name, 979 Error **errp) 980 { 981 ObjectProperty *prop; 982 ObjectClass *klass = object_get_class(obj); 983 984 prop = object_class_property_find(klass, name, NULL); 985 if (prop) { 986 return prop; 987 } 988 989 prop = g_hash_table_lookup(obj->properties, name); 990 if (prop) { 991 return prop; 992 } 993 994 error_setg(errp, "Property '.%s' not found", name); 995 return NULL; 996 } 997 998 void object_property_iter_init(ObjectPropertyIterator *iter, 999 Object *obj) 1000 { 1001 g_hash_table_iter_init(&iter->iter, obj->properties); 1002 iter->nextclass = object_get_class(obj); 1003 } 1004 1005 ObjectProperty *object_property_iter_next(ObjectPropertyIterator *iter) 1006 { 1007 gpointer key, val; 1008 while (!g_hash_table_iter_next(&iter->iter, &key, &val)) { 1009 if (!iter->nextclass) { 1010 return NULL; 1011 } 1012 g_hash_table_iter_init(&iter->iter, iter->nextclass->properties); 1013 iter->nextclass = object_class_get_parent(iter->nextclass); 1014 } 1015 return val; 1016 } 1017 1018 ObjectProperty *object_class_property_find(ObjectClass *klass, const char *name, 1019 Error **errp) 1020 { 1021 ObjectProperty *prop; 1022 ObjectClass *parent_klass; 1023 1024 parent_klass = object_class_get_parent(klass); 1025 if (parent_klass) { 1026 prop = object_class_property_find(parent_klass, name, NULL); 1027 if (prop) { 1028 return prop; 1029 } 1030 } 1031 1032 prop = g_hash_table_lookup(klass->properties, name); 1033 if (!prop) { 1034 error_setg(errp, "Property '.%s' not found", name); 1035 } 1036 return prop; 1037 } 1038 1039 void object_property_del(Object *obj, const char *name, Error **errp) 1040 { 1041 ObjectProperty *prop = g_hash_table_lookup(obj->properties, name); 1042 1043 if (!prop) { 1044 error_setg(errp, "Property '.%s' not found", name); 1045 return; 1046 } 1047 1048 if (prop->release) { 1049 prop->release(obj, name, prop->opaque); 1050 } 1051 g_hash_table_remove(obj->properties, name); 1052 } 1053 1054 void object_property_get(Object *obj, Visitor *v, const char *name, 1055 Error **errp) 1056 { 1057 ObjectProperty *prop = object_property_find(obj, name, errp); 1058 if (prop == NULL) { 1059 return; 1060 } 1061 1062 if (!prop->get) { 1063 error_setg(errp, QERR_PERMISSION_DENIED); 1064 } else { 1065 prop->get(obj, v, prop->opaque, name, errp); 1066 } 1067 } 1068 1069 void object_property_set(Object *obj, Visitor *v, const char *name, 1070 Error **errp) 1071 { 1072 ObjectProperty *prop = object_property_find(obj, name, errp); 1073 if (prop == NULL) { 1074 return; 1075 } 1076 1077 if (!prop->set) { 1078 error_setg(errp, QERR_PERMISSION_DENIED); 1079 } else { 1080 prop->set(obj, v, prop->opaque, name, errp); 1081 } 1082 } 1083 1084 void object_property_set_str(Object *obj, const char *value, 1085 const char *name, Error **errp) 1086 { 1087 QString *qstr = qstring_from_str(value); 1088 object_property_set_qobject(obj, QOBJECT(qstr), name, errp); 1089 1090 QDECREF(qstr); 1091 } 1092 1093 char *object_property_get_str(Object *obj, const char *name, 1094 Error **errp) 1095 { 1096 QObject *ret = object_property_get_qobject(obj, name, errp); 1097 QString *qstring; 1098 char *retval; 1099 1100 if (!ret) { 1101 return NULL; 1102 } 1103 qstring = qobject_to_qstring(ret); 1104 if (!qstring) { 1105 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "string"); 1106 retval = NULL; 1107 } else { 1108 retval = g_strdup(qstring_get_str(qstring)); 1109 } 1110 1111 QDECREF(qstring); 1112 return retval; 1113 } 1114 1115 void object_property_set_link(Object *obj, Object *value, 1116 const char *name, Error **errp) 1117 { 1118 if (value) { 1119 gchar *path = object_get_canonical_path(value); 1120 object_property_set_str(obj, path, name, errp); 1121 g_free(path); 1122 } else { 1123 object_property_set_str(obj, "", name, errp); 1124 } 1125 } 1126 1127 Object *object_property_get_link(Object *obj, const char *name, 1128 Error **errp) 1129 { 1130 char *str = object_property_get_str(obj, name, errp); 1131 Object *target = NULL; 1132 1133 if (str && *str) { 1134 target = object_resolve_path(str, NULL); 1135 if (!target) { 1136 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND, 1137 "Device '%s' not found", str); 1138 } 1139 } 1140 1141 g_free(str); 1142 return target; 1143 } 1144 1145 void object_property_set_bool(Object *obj, bool value, 1146 const char *name, Error **errp) 1147 { 1148 QBool *qbool = qbool_from_bool(value); 1149 object_property_set_qobject(obj, QOBJECT(qbool), name, errp); 1150 1151 QDECREF(qbool); 1152 } 1153 1154 bool object_property_get_bool(Object *obj, const char *name, 1155 Error **errp) 1156 { 1157 QObject *ret = object_property_get_qobject(obj, name, errp); 1158 QBool *qbool; 1159 bool retval; 1160 1161 if (!ret) { 1162 return false; 1163 } 1164 qbool = qobject_to_qbool(ret); 1165 if (!qbool) { 1166 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean"); 1167 retval = false; 1168 } else { 1169 retval = qbool_get_bool(qbool); 1170 } 1171 1172 QDECREF(qbool); 1173 return retval; 1174 } 1175 1176 void object_property_set_int(Object *obj, int64_t value, 1177 const char *name, Error **errp) 1178 { 1179 QInt *qint = qint_from_int(value); 1180 object_property_set_qobject(obj, QOBJECT(qint), name, errp); 1181 1182 QDECREF(qint); 1183 } 1184 1185 int64_t object_property_get_int(Object *obj, const char *name, 1186 Error **errp) 1187 { 1188 QObject *ret = object_property_get_qobject(obj, name, errp); 1189 QInt *qint; 1190 int64_t retval; 1191 1192 if (!ret) { 1193 return -1; 1194 } 1195 qint = qobject_to_qint(ret); 1196 if (!qint) { 1197 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "int"); 1198 retval = -1; 1199 } else { 1200 retval = qint_get_int(qint); 1201 } 1202 1203 QDECREF(qint); 1204 return retval; 1205 } 1206 1207 typedef struct EnumProperty { 1208 const char * const *strings; 1209 int (*get)(Object *, Error **); 1210 void (*set)(Object *, int, Error **); 1211 } EnumProperty; 1212 1213 int object_property_get_enum(Object *obj, const char *name, 1214 const char *typename, Error **errp) 1215 { 1216 Error *err = NULL; 1217 StringOutputVisitor *sov; 1218 StringInputVisitor *siv; 1219 char *str; 1220 int ret; 1221 ObjectProperty *prop = object_property_find(obj, name, errp); 1222 EnumProperty *enumprop; 1223 1224 if (prop == NULL) { 1225 return 0; 1226 } 1227 1228 if (!g_str_equal(prop->type, typename)) { 1229 error_setg(errp, "Property %s on %s is not '%s' enum type", 1230 name, object_class_get_name( 1231 object_get_class(obj)), typename); 1232 return 0; 1233 } 1234 1235 enumprop = prop->opaque; 1236 1237 sov = string_output_visitor_new(false); 1238 object_property_get(obj, string_output_get_visitor(sov), name, &err); 1239 if (err) { 1240 error_propagate(errp, err); 1241 string_output_visitor_cleanup(sov); 1242 return 0; 1243 } 1244 str = string_output_get_string(sov); 1245 siv = string_input_visitor_new(str); 1246 string_output_visitor_cleanup(sov); 1247 visit_type_enum(string_input_get_visitor(siv), 1248 &ret, enumprop->strings, NULL, name, errp); 1249 1250 g_free(str); 1251 string_input_visitor_cleanup(siv); 1252 1253 return ret; 1254 } 1255 1256 void object_property_get_uint16List(Object *obj, const char *name, 1257 uint16List **list, Error **errp) 1258 { 1259 Error *err = NULL; 1260 StringOutputVisitor *ov; 1261 StringInputVisitor *iv; 1262 char *str; 1263 1264 ov = string_output_visitor_new(false); 1265 object_property_get(obj, string_output_get_visitor(ov), 1266 name, &err); 1267 if (err) { 1268 error_propagate(errp, err); 1269 goto out; 1270 } 1271 str = string_output_get_string(ov); 1272 iv = string_input_visitor_new(str); 1273 visit_type_uint16List(string_input_get_visitor(iv), 1274 list, NULL, errp); 1275 1276 g_free(str); 1277 string_input_visitor_cleanup(iv); 1278 out: 1279 string_output_visitor_cleanup(ov); 1280 } 1281 1282 void object_property_parse(Object *obj, const char *string, 1283 const char *name, Error **errp) 1284 { 1285 StringInputVisitor *siv; 1286 siv = string_input_visitor_new(string); 1287 object_property_set(obj, string_input_get_visitor(siv), name, errp); 1288 1289 string_input_visitor_cleanup(siv); 1290 } 1291 1292 char *object_property_print(Object *obj, const char *name, bool human, 1293 Error **errp) 1294 { 1295 StringOutputVisitor *sov; 1296 char *string = NULL; 1297 Error *local_err = NULL; 1298 1299 sov = string_output_visitor_new(human); 1300 object_property_get(obj, string_output_get_visitor(sov), name, &local_err); 1301 if (local_err) { 1302 error_propagate(errp, local_err); 1303 goto out; 1304 } 1305 1306 string = string_output_get_string(sov); 1307 1308 out: 1309 string_output_visitor_cleanup(sov); 1310 return string; 1311 } 1312 1313 const char *object_property_get_type(Object *obj, const char *name, Error **errp) 1314 { 1315 ObjectProperty *prop = object_property_find(obj, name, errp); 1316 if (prop == NULL) { 1317 return NULL; 1318 } 1319 1320 return prop->type; 1321 } 1322 1323 Object *object_get_root(void) 1324 { 1325 static Object *root; 1326 1327 if (!root) { 1328 root = object_new("container"); 1329 } 1330 1331 return root; 1332 } 1333 1334 Object *object_get_objects_root(void) 1335 { 1336 return container_get(object_get_root(), "/objects"); 1337 } 1338 1339 static void object_get_child_property(Object *obj, Visitor *v, void *opaque, 1340 const char *name, Error **errp) 1341 { 1342 Object *child = opaque; 1343 gchar *path; 1344 1345 path = object_get_canonical_path(child); 1346 visit_type_str(v, &path, name, errp); 1347 g_free(path); 1348 } 1349 1350 static Object *object_resolve_child_property(Object *parent, void *opaque, const gchar *part) 1351 { 1352 return opaque; 1353 } 1354 1355 static void object_finalize_child_property(Object *obj, const char *name, 1356 void *opaque) 1357 { 1358 Object *child = opaque; 1359 1360 if (child->class->unparent) { 1361 (child->class->unparent)(child); 1362 } 1363 child->parent = NULL; 1364 object_unref(child); 1365 } 1366 1367 void object_property_add_child(Object *obj, const char *name, 1368 Object *child, Error **errp) 1369 { 1370 Error *local_err = NULL; 1371 gchar *type; 1372 ObjectProperty *op; 1373 1374 if (child->parent != NULL) { 1375 error_setg(errp, "child object is already parented"); 1376 return; 1377 } 1378 1379 type = g_strdup_printf("child<%s>", object_get_typename(OBJECT(child))); 1380 1381 op = object_property_add(obj, name, type, object_get_child_property, NULL, 1382 object_finalize_child_property, child, &local_err); 1383 if (local_err) { 1384 error_propagate(errp, local_err); 1385 goto out; 1386 } 1387 1388 op->resolve = object_resolve_child_property; 1389 object_ref(child); 1390 child->parent = obj; 1391 1392 out: 1393 g_free(type); 1394 } 1395 1396 void object_property_allow_set_link(Object *obj, const char *name, 1397 Object *val, Error **errp) 1398 { 1399 /* Allow the link to be set, always */ 1400 } 1401 1402 typedef struct { 1403 Object **child; 1404 void (*check)(Object *, const char *, Object *, Error **); 1405 ObjectPropertyLinkFlags flags; 1406 } LinkProperty; 1407 1408 static void object_get_link_property(Object *obj, Visitor *v, void *opaque, 1409 const char *name, Error **errp) 1410 { 1411 LinkProperty *lprop = opaque; 1412 Object **child = lprop->child; 1413 gchar *path; 1414 1415 if (*child) { 1416 path = object_get_canonical_path(*child); 1417 visit_type_str(v, &path, name, errp); 1418 g_free(path); 1419 } else { 1420 path = (gchar *)""; 1421 visit_type_str(v, &path, name, errp); 1422 } 1423 } 1424 1425 /* 1426 * object_resolve_link: 1427 * 1428 * Lookup an object and ensure its type matches the link property type. This 1429 * is similar to object_resolve_path() except type verification against the 1430 * link property is performed. 1431 * 1432 * Returns: The matched object or NULL on path lookup failures. 1433 */ 1434 static Object *object_resolve_link(Object *obj, const char *name, 1435 const char *path, Error **errp) 1436 { 1437 const char *type; 1438 gchar *target_type; 1439 bool ambiguous = false; 1440 Object *target; 1441 1442 /* Go from link<FOO> to FOO. */ 1443 type = object_property_get_type(obj, name, NULL); 1444 target_type = g_strndup(&type[5], strlen(type) - 6); 1445 target = object_resolve_path_type(path, target_type, &ambiguous); 1446 1447 if (ambiguous) { 1448 error_setg(errp, "Path '%s' does not uniquely identify an object", 1449 path); 1450 } else if (!target) { 1451 target = object_resolve_path(path, &ambiguous); 1452 if (target || ambiguous) { 1453 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type); 1454 } else { 1455 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND, 1456 "Device '%s' not found", path); 1457 } 1458 target = NULL; 1459 } 1460 g_free(target_type); 1461 1462 return target; 1463 } 1464 1465 static void object_set_link_property(Object *obj, Visitor *v, void *opaque, 1466 const char *name, Error **errp) 1467 { 1468 Error *local_err = NULL; 1469 LinkProperty *prop = opaque; 1470 Object **child = prop->child; 1471 Object *old_target = *child; 1472 Object *new_target = NULL; 1473 char *path = NULL; 1474 1475 visit_type_str(v, &path, name, &local_err); 1476 1477 if (!local_err && strcmp(path, "") != 0) { 1478 new_target = object_resolve_link(obj, name, path, &local_err); 1479 } 1480 1481 g_free(path); 1482 if (local_err) { 1483 error_propagate(errp, local_err); 1484 return; 1485 } 1486 1487 prop->check(obj, name, new_target, &local_err); 1488 if (local_err) { 1489 error_propagate(errp, local_err); 1490 return; 1491 } 1492 1493 object_ref(new_target); 1494 *child = new_target; 1495 object_unref(old_target); 1496 } 1497 1498 static Object *object_resolve_link_property(Object *parent, void *opaque, const gchar *part) 1499 { 1500 LinkProperty *lprop = opaque; 1501 1502 return *lprop->child; 1503 } 1504 1505 static void object_release_link_property(Object *obj, const char *name, 1506 void *opaque) 1507 { 1508 LinkProperty *prop = opaque; 1509 1510 if ((prop->flags & OBJ_PROP_LINK_UNREF_ON_RELEASE) && *prop->child) { 1511 object_unref(*prop->child); 1512 } 1513 g_free(prop); 1514 } 1515 1516 void object_property_add_link(Object *obj, const char *name, 1517 const char *type, Object **child, 1518 void (*check)(Object *, const char *, 1519 Object *, Error **), 1520 ObjectPropertyLinkFlags flags, 1521 Error **errp) 1522 { 1523 Error *local_err = NULL; 1524 LinkProperty *prop = g_malloc(sizeof(*prop)); 1525 gchar *full_type; 1526 ObjectProperty *op; 1527 1528 prop->child = child; 1529 prop->check = check; 1530 prop->flags = flags; 1531 1532 full_type = g_strdup_printf("link<%s>", type); 1533 1534 op = object_property_add(obj, name, full_type, 1535 object_get_link_property, 1536 check ? object_set_link_property : NULL, 1537 object_release_link_property, 1538 prop, 1539 &local_err); 1540 if (local_err) { 1541 error_propagate(errp, local_err); 1542 g_free(prop); 1543 goto out; 1544 } 1545 1546 op->resolve = object_resolve_link_property; 1547 1548 out: 1549 g_free(full_type); 1550 } 1551 1552 void object_property_add_const_link(Object *obj, const char *name, 1553 Object *target, Error **errp) 1554 { 1555 char *link_type; 1556 ObjectProperty *op; 1557 1558 link_type = g_strdup_printf("link<%s>", object_get_typename(target)); 1559 op = object_property_add(obj, name, link_type, 1560 object_get_child_property, NULL, 1561 NULL, target, errp); 1562 if (op != NULL) { 1563 op->resolve = object_resolve_child_property; 1564 } 1565 g_free(link_type); 1566 } 1567 1568 gchar *object_get_canonical_path_component(Object *obj) 1569 { 1570 ObjectProperty *prop = NULL; 1571 GHashTableIter iter; 1572 1573 g_assert(obj); 1574 g_assert(obj->parent != NULL); 1575 1576 g_hash_table_iter_init(&iter, obj->parent->properties); 1577 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) { 1578 if (!object_property_is_child(prop)) { 1579 continue; 1580 } 1581 1582 if (prop->opaque == obj) { 1583 return g_strdup(prop->name); 1584 } 1585 } 1586 1587 /* obj had a parent but was not a child, should never happen */ 1588 g_assert_not_reached(); 1589 return NULL; 1590 } 1591 1592 gchar *object_get_canonical_path(Object *obj) 1593 { 1594 Object *root = object_get_root(); 1595 char *newpath, *path = NULL; 1596 1597 while (obj != root) { 1598 char *component = object_get_canonical_path_component(obj); 1599 1600 if (path) { 1601 newpath = g_strdup_printf("%s/%s", component, path); 1602 g_free(component); 1603 g_free(path); 1604 path = newpath; 1605 } else { 1606 path = component; 1607 } 1608 1609 obj = obj->parent; 1610 } 1611 1612 newpath = g_strdup_printf("/%s", path ? path : ""); 1613 g_free(path); 1614 1615 return newpath; 1616 } 1617 1618 Object *object_resolve_path_component(Object *parent, const gchar *part) 1619 { 1620 ObjectProperty *prop = object_property_find(parent, part, NULL); 1621 if (prop == NULL) { 1622 return NULL; 1623 } 1624 1625 if (prop->resolve) { 1626 return prop->resolve(parent, prop->opaque, part); 1627 } else { 1628 return NULL; 1629 } 1630 } 1631 1632 static Object *object_resolve_abs_path(Object *parent, 1633 gchar **parts, 1634 const char *typename, 1635 int index) 1636 { 1637 Object *child; 1638 1639 if (parts[index] == NULL) { 1640 return object_dynamic_cast(parent, typename); 1641 } 1642 1643 if (strcmp(parts[index], "") == 0) { 1644 return object_resolve_abs_path(parent, parts, typename, index + 1); 1645 } 1646 1647 child = object_resolve_path_component(parent, parts[index]); 1648 if (!child) { 1649 return NULL; 1650 } 1651 1652 return object_resolve_abs_path(child, parts, typename, index + 1); 1653 } 1654 1655 static Object *object_resolve_partial_path(Object *parent, 1656 gchar **parts, 1657 const char *typename, 1658 bool *ambiguous) 1659 { 1660 Object *obj; 1661 GHashTableIter iter; 1662 ObjectProperty *prop; 1663 1664 obj = object_resolve_abs_path(parent, parts, typename, 0); 1665 1666 g_hash_table_iter_init(&iter, parent->properties); 1667 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) { 1668 Object *found; 1669 1670 if (!object_property_is_child(prop)) { 1671 continue; 1672 } 1673 1674 found = object_resolve_partial_path(prop->opaque, parts, 1675 typename, ambiguous); 1676 if (found) { 1677 if (obj) { 1678 if (ambiguous) { 1679 *ambiguous = true; 1680 } 1681 return NULL; 1682 } 1683 obj = found; 1684 } 1685 1686 if (ambiguous && *ambiguous) { 1687 return NULL; 1688 } 1689 } 1690 1691 return obj; 1692 } 1693 1694 Object *object_resolve_path_type(const char *path, const char *typename, 1695 bool *ambiguous) 1696 { 1697 Object *obj; 1698 gchar **parts; 1699 1700 parts = g_strsplit(path, "/", 0); 1701 assert(parts); 1702 1703 if (parts[0] == NULL || strcmp(parts[0], "") != 0) { 1704 if (ambiguous) { 1705 *ambiguous = false; 1706 } 1707 obj = object_resolve_partial_path(object_get_root(), parts, 1708 typename, ambiguous); 1709 } else { 1710 obj = object_resolve_abs_path(object_get_root(), parts, typename, 1); 1711 } 1712 1713 g_strfreev(parts); 1714 1715 return obj; 1716 } 1717 1718 Object *object_resolve_path(const char *path, bool *ambiguous) 1719 { 1720 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous); 1721 } 1722 1723 typedef struct StringProperty 1724 { 1725 char *(*get)(Object *, Error **); 1726 void (*set)(Object *, const char *, Error **); 1727 } StringProperty; 1728 1729 static void property_get_str(Object *obj, Visitor *v, void *opaque, 1730 const char *name, Error **errp) 1731 { 1732 StringProperty *prop = opaque; 1733 char *value; 1734 Error *err = NULL; 1735 1736 value = prop->get(obj, &err); 1737 if (err) { 1738 error_propagate(errp, err); 1739 return; 1740 } 1741 1742 visit_type_str(v, &value, name, errp); 1743 g_free(value); 1744 } 1745 1746 static void property_set_str(Object *obj, Visitor *v, void *opaque, 1747 const char *name, Error **errp) 1748 { 1749 StringProperty *prop = opaque; 1750 char *value; 1751 Error *local_err = NULL; 1752 1753 visit_type_str(v, &value, name, &local_err); 1754 if (local_err) { 1755 error_propagate(errp, local_err); 1756 return; 1757 } 1758 1759 prop->set(obj, value, errp); 1760 g_free(value); 1761 } 1762 1763 static void property_release_str(Object *obj, const char *name, 1764 void *opaque) 1765 { 1766 StringProperty *prop = opaque; 1767 g_free(prop); 1768 } 1769 1770 void object_property_add_str(Object *obj, const char *name, 1771 char *(*get)(Object *, Error **), 1772 void (*set)(Object *, const char *, Error **), 1773 Error **errp) 1774 { 1775 Error *local_err = NULL; 1776 StringProperty *prop = g_malloc0(sizeof(*prop)); 1777 1778 prop->get = get; 1779 prop->set = set; 1780 1781 object_property_add(obj, name, "string", 1782 get ? property_get_str : NULL, 1783 set ? property_set_str : NULL, 1784 property_release_str, 1785 prop, &local_err); 1786 if (local_err) { 1787 error_propagate(errp, local_err); 1788 g_free(prop); 1789 } 1790 } 1791 1792 void object_class_property_add_str(ObjectClass *klass, const char *name, 1793 char *(*get)(Object *, Error **), 1794 void (*set)(Object *, const char *, 1795 Error **), 1796 Error **errp) 1797 { 1798 Error *local_err = NULL; 1799 StringProperty *prop = g_malloc0(sizeof(*prop)); 1800 1801 prop->get = get; 1802 prop->set = set; 1803 1804 object_class_property_add(klass, name, "string", 1805 get ? property_get_str : NULL, 1806 set ? property_set_str : NULL, 1807 property_release_str, 1808 prop, &local_err); 1809 if (local_err) { 1810 error_propagate(errp, local_err); 1811 g_free(prop); 1812 } 1813 } 1814 1815 typedef struct BoolProperty 1816 { 1817 bool (*get)(Object *, Error **); 1818 void (*set)(Object *, bool, Error **); 1819 } BoolProperty; 1820 1821 static void property_get_bool(Object *obj, Visitor *v, void *opaque, 1822 const char *name, Error **errp) 1823 { 1824 BoolProperty *prop = opaque; 1825 bool value; 1826 Error *err = NULL; 1827 1828 value = prop->get(obj, &err); 1829 if (err) { 1830 error_propagate(errp, err); 1831 return; 1832 } 1833 1834 visit_type_bool(v, &value, name, errp); 1835 } 1836 1837 static void property_set_bool(Object *obj, Visitor *v, void *opaque, 1838 const char *name, Error **errp) 1839 { 1840 BoolProperty *prop = opaque; 1841 bool value; 1842 Error *local_err = NULL; 1843 1844 visit_type_bool(v, &value, name, &local_err); 1845 if (local_err) { 1846 error_propagate(errp, local_err); 1847 return; 1848 } 1849 1850 prop->set(obj, value, errp); 1851 } 1852 1853 static void property_release_bool(Object *obj, const char *name, 1854 void *opaque) 1855 { 1856 BoolProperty *prop = opaque; 1857 g_free(prop); 1858 } 1859 1860 void object_property_add_bool(Object *obj, const char *name, 1861 bool (*get)(Object *, Error **), 1862 void (*set)(Object *, bool, Error **), 1863 Error **errp) 1864 { 1865 Error *local_err = NULL; 1866 BoolProperty *prop = g_malloc0(sizeof(*prop)); 1867 1868 prop->get = get; 1869 prop->set = set; 1870 1871 object_property_add(obj, name, "bool", 1872 get ? property_get_bool : NULL, 1873 set ? property_set_bool : NULL, 1874 property_release_bool, 1875 prop, &local_err); 1876 if (local_err) { 1877 error_propagate(errp, local_err); 1878 g_free(prop); 1879 } 1880 } 1881 1882 void object_class_property_add_bool(ObjectClass *klass, const char *name, 1883 bool (*get)(Object *, Error **), 1884 void (*set)(Object *, bool, Error **), 1885 Error **errp) 1886 { 1887 Error *local_err = NULL; 1888 BoolProperty *prop = g_malloc0(sizeof(*prop)); 1889 1890 prop->get = get; 1891 prop->set = set; 1892 1893 object_class_property_add(klass, name, "bool", 1894 get ? property_get_bool : NULL, 1895 set ? property_set_bool : NULL, 1896 property_release_bool, 1897 prop, &local_err); 1898 if (local_err) { 1899 error_propagate(errp, local_err); 1900 g_free(prop); 1901 } 1902 } 1903 1904 static void property_get_enum(Object *obj, Visitor *v, void *opaque, 1905 const char *name, Error **errp) 1906 { 1907 EnumProperty *prop = opaque; 1908 int value; 1909 Error *err = NULL; 1910 1911 value = prop->get(obj, &err); 1912 if (err) { 1913 error_propagate(errp, err); 1914 return; 1915 } 1916 1917 visit_type_enum(v, &value, prop->strings, NULL, name, errp); 1918 } 1919 1920 static void property_set_enum(Object *obj, Visitor *v, void *opaque, 1921 const char *name, Error **errp) 1922 { 1923 EnumProperty *prop = opaque; 1924 int value; 1925 Error *err = NULL; 1926 1927 visit_type_enum(v, &value, prop->strings, NULL, name, &err); 1928 if (err) { 1929 error_propagate(errp, err); 1930 return; 1931 } 1932 prop->set(obj, value, errp); 1933 } 1934 1935 static void property_release_enum(Object *obj, const char *name, 1936 void *opaque) 1937 { 1938 EnumProperty *prop = opaque; 1939 g_free(prop); 1940 } 1941 1942 void object_property_add_enum(Object *obj, const char *name, 1943 const char *typename, 1944 const char * const *strings, 1945 int (*get)(Object *, Error **), 1946 void (*set)(Object *, int, Error **), 1947 Error **errp) 1948 { 1949 Error *local_err = NULL; 1950 EnumProperty *prop = g_malloc(sizeof(*prop)); 1951 1952 prop->strings = strings; 1953 prop->get = get; 1954 prop->set = set; 1955 1956 object_property_add(obj, name, typename, 1957 get ? property_get_enum : NULL, 1958 set ? property_set_enum : NULL, 1959 property_release_enum, 1960 prop, &local_err); 1961 if (local_err) { 1962 error_propagate(errp, local_err); 1963 g_free(prop); 1964 } 1965 } 1966 1967 void object_class_property_add_enum(ObjectClass *klass, const char *name, 1968 const char *typename, 1969 const char * const *strings, 1970 int (*get)(Object *, Error **), 1971 void (*set)(Object *, int, Error **), 1972 Error **errp) 1973 { 1974 Error *local_err = NULL; 1975 EnumProperty *prop = g_malloc(sizeof(*prop)); 1976 1977 prop->strings = strings; 1978 prop->get = get; 1979 prop->set = set; 1980 1981 object_class_property_add(klass, name, typename, 1982 get ? property_get_enum : NULL, 1983 set ? property_set_enum : NULL, 1984 property_release_enum, 1985 prop, &local_err); 1986 if (local_err) { 1987 error_propagate(errp, local_err); 1988 g_free(prop); 1989 } 1990 } 1991 1992 typedef struct TMProperty { 1993 void (*get)(Object *, struct tm *, Error **); 1994 } TMProperty; 1995 1996 static void property_get_tm(Object *obj, Visitor *v, void *opaque, 1997 const char *name, Error **errp) 1998 { 1999 TMProperty *prop = opaque; 2000 Error *err = NULL; 2001 struct tm value; 2002 2003 prop->get(obj, &value, &err); 2004 if (err) { 2005 goto out; 2006 } 2007 2008 visit_start_struct(v, NULL, "struct tm", name, 0, &err); 2009 if (err) { 2010 goto out; 2011 } 2012 visit_type_int32(v, &value.tm_year, "tm_year", &err); 2013 if (err) { 2014 goto out_end; 2015 } 2016 visit_type_int32(v, &value.tm_mon, "tm_mon", &err); 2017 if (err) { 2018 goto out_end; 2019 } 2020 visit_type_int32(v, &value.tm_mday, "tm_mday", &err); 2021 if (err) { 2022 goto out_end; 2023 } 2024 visit_type_int32(v, &value.tm_hour, "tm_hour", &err); 2025 if (err) { 2026 goto out_end; 2027 } 2028 visit_type_int32(v, &value.tm_min, "tm_min", &err); 2029 if (err) { 2030 goto out_end; 2031 } 2032 visit_type_int32(v, &value.tm_sec, "tm_sec", &err); 2033 if (err) { 2034 goto out_end; 2035 } 2036 out_end: 2037 error_propagate(errp, err); 2038 err = NULL; 2039 visit_end_struct(v, errp); 2040 out: 2041 error_propagate(errp, err); 2042 2043 } 2044 2045 static void property_release_tm(Object *obj, const char *name, 2046 void *opaque) 2047 { 2048 TMProperty *prop = opaque; 2049 g_free(prop); 2050 } 2051 2052 void object_property_add_tm(Object *obj, const char *name, 2053 void (*get)(Object *, struct tm *, Error **), 2054 Error **errp) 2055 { 2056 Error *local_err = NULL; 2057 TMProperty *prop = g_malloc0(sizeof(*prop)); 2058 2059 prop->get = get; 2060 2061 object_property_add(obj, name, "struct tm", 2062 get ? property_get_tm : NULL, NULL, 2063 property_release_tm, 2064 prop, &local_err); 2065 if (local_err) { 2066 error_propagate(errp, local_err); 2067 g_free(prop); 2068 } 2069 } 2070 2071 void object_class_property_add_tm(ObjectClass *klass, const char *name, 2072 void (*get)(Object *, struct tm *, Error **), 2073 Error **errp) 2074 { 2075 Error *local_err = NULL; 2076 TMProperty *prop = g_malloc0(sizeof(*prop)); 2077 2078 prop->get = get; 2079 2080 object_class_property_add(klass, name, "struct tm", 2081 get ? property_get_tm : NULL, NULL, 2082 property_release_tm, 2083 prop, &local_err); 2084 if (local_err) { 2085 error_propagate(errp, local_err); 2086 g_free(prop); 2087 } 2088 } 2089 2090 static char *qdev_get_type(Object *obj, Error **errp) 2091 { 2092 return g_strdup(object_get_typename(obj)); 2093 } 2094 2095 static void property_get_uint8_ptr(Object *obj, Visitor *v, 2096 void *opaque, const char *name, 2097 Error **errp) 2098 { 2099 uint8_t value = *(uint8_t *)opaque; 2100 visit_type_uint8(v, &value, name, errp); 2101 } 2102 2103 static void property_get_uint16_ptr(Object *obj, Visitor *v, 2104 void *opaque, const char *name, 2105 Error **errp) 2106 { 2107 uint16_t value = *(uint16_t *)opaque; 2108 visit_type_uint16(v, &value, name, errp); 2109 } 2110 2111 static void property_get_uint32_ptr(Object *obj, Visitor *v, 2112 void *opaque, const char *name, 2113 Error **errp) 2114 { 2115 uint32_t value = *(uint32_t *)opaque; 2116 visit_type_uint32(v, &value, name, errp); 2117 } 2118 2119 static void property_get_uint64_ptr(Object *obj, Visitor *v, 2120 void *opaque, const char *name, 2121 Error **errp) 2122 { 2123 uint64_t value = *(uint64_t *)opaque; 2124 visit_type_uint64(v, &value, name, errp); 2125 } 2126 2127 void object_property_add_uint8_ptr(Object *obj, const char *name, 2128 const uint8_t *v, Error **errp) 2129 { 2130 object_property_add(obj, name, "uint8", property_get_uint8_ptr, 2131 NULL, NULL, (void *)v, errp); 2132 } 2133 2134 void object_class_property_add_uint8_ptr(ObjectClass *klass, const char *name, 2135 const uint8_t *v, Error **errp) 2136 { 2137 object_class_property_add(klass, name, "uint8", property_get_uint8_ptr, 2138 NULL, NULL, (void *)v, errp); 2139 } 2140 2141 void object_property_add_uint16_ptr(Object *obj, const char *name, 2142 const uint16_t *v, Error **errp) 2143 { 2144 object_property_add(obj, name, "uint16", property_get_uint16_ptr, 2145 NULL, NULL, (void *)v, errp); 2146 } 2147 2148 void object_class_property_add_uint16_ptr(ObjectClass *klass, const char *name, 2149 const uint16_t *v, Error **errp) 2150 { 2151 object_class_property_add(klass, name, "uint16", property_get_uint16_ptr, 2152 NULL, NULL, (void *)v, errp); 2153 } 2154 2155 void object_property_add_uint32_ptr(Object *obj, const char *name, 2156 const uint32_t *v, Error **errp) 2157 { 2158 object_property_add(obj, name, "uint32", property_get_uint32_ptr, 2159 NULL, NULL, (void *)v, errp); 2160 } 2161 2162 void object_class_property_add_uint32_ptr(ObjectClass *klass, const char *name, 2163 const uint32_t *v, Error **errp) 2164 { 2165 object_class_property_add(klass, name, "uint32", property_get_uint32_ptr, 2166 NULL, NULL, (void *)v, errp); 2167 } 2168 2169 void object_property_add_uint64_ptr(Object *obj, const char *name, 2170 const uint64_t *v, Error **errp) 2171 { 2172 object_property_add(obj, name, "uint64", property_get_uint64_ptr, 2173 NULL, NULL, (void *)v, errp); 2174 } 2175 2176 void object_class_property_add_uint64_ptr(ObjectClass *klass, const char *name, 2177 const uint64_t *v, Error **errp) 2178 { 2179 object_class_property_add(klass, name, "uint64", property_get_uint64_ptr, 2180 NULL, NULL, (void *)v, errp); 2181 } 2182 2183 typedef struct { 2184 Object *target_obj; 2185 char *target_name; 2186 } AliasProperty; 2187 2188 static void property_get_alias(Object *obj, struct Visitor *v, void *opaque, 2189 const char *name, Error **errp) 2190 { 2191 AliasProperty *prop = opaque; 2192 2193 object_property_get(prop->target_obj, v, prop->target_name, errp); 2194 } 2195 2196 static void property_set_alias(Object *obj, struct Visitor *v, void *opaque, 2197 const char *name, Error **errp) 2198 { 2199 AliasProperty *prop = opaque; 2200 2201 object_property_set(prop->target_obj, v, prop->target_name, errp); 2202 } 2203 2204 static Object *property_resolve_alias(Object *obj, void *opaque, 2205 const gchar *part) 2206 { 2207 AliasProperty *prop = opaque; 2208 2209 return object_resolve_path_component(prop->target_obj, prop->target_name); 2210 } 2211 2212 static void property_release_alias(Object *obj, const char *name, void *opaque) 2213 { 2214 AliasProperty *prop = opaque; 2215 2216 g_free(prop->target_name); 2217 g_free(prop); 2218 } 2219 2220 void object_property_add_alias(Object *obj, const char *name, 2221 Object *target_obj, const char *target_name, 2222 Error **errp) 2223 { 2224 AliasProperty *prop; 2225 ObjectProperty *op; 2226 ObjectProperty *target_prop; 2227 gchar *prop_type; 2228 Error *local_err = NULL; 2229 2230 target_prop = object_property_find(target_obj, target_name, errp); 2231 if (!target_prop) { 2232 return; 2233 } 2234 2235 if (object_property_is_child(target_prop)) { 2236 prop_type = g_strdup_printf("link%s", 2237 target_prop->type + strlen("child")); 2238 } else { 2239 prop_type = g_strdup(target_prop->type); 2240 } 2241 2242 prop = g_malloc(sizeof(*prop)); 2243 prop->target_obj = target_obj; 2244 prop->target_name = g_strdup(target_name); 2245 2246 op = object_property_add(obj, name, prop_type, 2247 property_get_alias, 2248 property_set_alias, 2249 property_release_alias, 2250 prop, &local_err); 2251 if (local_err) { 2252 error_propagate(errp, local_err); 2253 g_free(prop); 2254 goto out; 2255 } 2256 op->resolve = property_resolve_alias; 2257 2258 object_property_set_description(obj, op->name, 2259 target_prop->description, 2260 &error_abort); 2261 2262 out: 2263 g_free(prop_type); 2264 } 2265 2266 void object_property_set_description(Object *obj, const char *name, 2267 const char *description, Error **errp) 2268 { 2269 ObjectProperty *op; 2270 2271 op = object_property_find(obj, name, errp); 2272 if (!op) { 2273 return; 2274 } 2275 2276 g_free(op->description); 2277 op->description = g_strdup(description); 2278 } 2279 2280 void object_class_property_set_description(ObjectClass *klass, 2281 const char *name, 2282 const char *description, 2283 Error **errp) 2284 { 2285 ObjectProperty *op; 2286 2287 op = g_hash_table_lookup(klass->properties, name); 2288 if (!op) { 2289 error_setg(errp, "Property '.%s' not found", name); 2290 return; 2291 } 2292 2293 g_free(op->description); 2294 op->description = g_strdup(description); 2295 } 2296 2297 static void object_instance_init(Object *obj) 2298 { 2299 object_property_add_str(obj, "type", qdev_get_type, NULL, NULL); 2300 } 2301 2302 static void register_types(void) 2303 { 2304 static TypeInfo interface_info = { 2305 .name = TYPE_INTERFACE, 2306 .class_size = sizeof(InterfaceClass), 2307 .abstract = true, 2308 }; 2309 2310 static TypeInfo object_info = { 2311 .name = TYPE_OBJECT, 2312 .instance_size = sizeof(Object), 2313 .instance_init = object_instance_init, 2314 .abstract = true, 2315 }; 2316 2317 type_interface = type_register_internal(&interface_info); 2318 type_register_internal(&object_info); 2319 } 2320 2321 type_init(register_types) 2322