4 * Copyright IBM, Corp. 2011
7 * Anthony Liguori <aliguori@us.ibm.com>
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.
13 #include "qemu/osdep.h"
14 #include "hw/qdev-core.h"
15 #include "qapi/error.h"
16 #include "qom/object.h"
17 #include "qom/object_interfaces.h"
18 #include "qemu/cutils.h"
19 #include "qemu/memalign.h"
20 #include "qapi/visitor.h"
21 #include "qapi/string-input-visitor.h"
22 #include "qapi/string-output-visitor.h"
23 #include "qapi/qobject-input-visitor.h"
24 #include "qapi/forward-visitor.h"
25 #include "qapi/qapi-builtin-visit.h"
26 #include "qapi/qmp/qjson.h"
29 /* TODO: replace QObject with a simpler visitor to avoid a dependency
30 * of the QOM core on QObject? */
31 #include "qom/qom-qobject.h"
32 #include "qapi/qmp/qbool.h"
33 #include "qapi/qmp/qlist.h"
34 #include "qapi/qmp/qnum.h"
35 #include "qapi/qmp/qstring.h"
36 #include "qemu/error-report.h"
38 #define MAX_INTERFACES 32
40 typedef struct InterfaceImpl InterfaceImpl
;
41 typedef struct TypeImpl TypeImpl
;
55 size_t instance_align
;
57 void (*class_init
)(ObjectClass
*klass
, void *data
);
58 void (*class_base_init
)(ObjectClass
*klass
, void *data
);
62 void (*instance_init
)(Object
*obj
);
63 void (*instance_post_init
)(Object
*obj
);
64 void (*instance_finalize
)(Object
*obj
);
69 TypeImpl
*parent_type
;
74 InterfaceImpl interfaces
[MAX_INTERFACES
];
77 static Type type_interface
;
79 static GHashTable
*type_table_get(void)
81 static GHashTable
*type_table
;
83 if (type_table
== NULL
) {
84 type_table
= g_hash_table_new(g_str_hash
, g_str_equal
);
90 static bool enumerating_types
;
92 static void type_table_add(TypeImpl
*ti
)
94 assert(!enumerating_types
);
95 g_hash_table_insert(type_table_get(), (void *)ti
->name
, ti
);
98 static TypeImpl
*type_table_lookup(const char *name
)
100 return g_hash_table_lookup(type_table_get(), name
);
103 static TypeImpl
*type_new(const TypeInfo
*info
)
105 TypeImpl
*ti
= g_malloc0(sizeof(*ti
));
108 g_assert(info
->name
!= NULL
);
110 if (type_table_lookup(info
->name
) != NULL
) {
111 fprintf(stderr
, "Registering `%s' which already exists\n", info
->name
);
115 ti
->name
= g_strdup(info
->name
);
116 ti
->parent
= g_strdup(info
->parent
);
118 ti
->class_size
= info
->class_size
;
119 ti
->instance_size
= info
->instance_size
;
120 ti
->instance_align
= info
->instance_align
;
122 ti
->class_init
= info
->class_init
;
123 ti
->class_base_init
= info
->class_base_init
;
124 ti
->class_data
= info
->class_data
;
126 ti
->instance_init
= info
->instance_init
;
127 ti
->instance_post_init
= info
->instance_post_init
;
128 ti
->instance_finalize
= info
->instance_finalize
;
130 ti
->abstract
= info
->abstract
;
132 for (i
= 0; info
->interfaces
&& info
->interfaces
[i
].type
; i
++) {
133 ti
->interfaces
[i
].typename
= g_strdup(info
->interfaces
[i
].type
);
135 ti
->num_interfaces
= i
;
140 static bool type_name_is_valid(const char *name
)
142 const int slen
= strlen(name
);
148 * Ideally, the name should start with a letter - however, we've got
149 * too many names starting with a digit already, so allow digits here,
150 * too (except '0' which is not used yet)
152 if (!g_ascii_isalnum(name
[0]) || name
[0] == '0') {
156 plen
= strspn(name
, "abcdefghijklmnopqrstuvwxyz"
157 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
163 static TypeImpl
*type_register_internal(const TypeInfo
*info
)
167 if (!type_name_is_valid(info
->name
)) {
168 fprintf(stderr
, "Registering '%s' with illegal type name\n", info
->name
);
178 TypeImpl
*type_register_static(const TypeInfo
*info
)
180 assert(info
->parent
);
181 return type_register_internal(info
);
184 void type_register_static_array(const TypeInfo
*infos
, int nr_infos
)
188 for (i
= 0; i
< nr_infos
; i
++) {
189 type_register_static(&infos
[i
]);
193 static TypeImpl
*type_get_by_name_noload(const char *name
)
199 return type_table_lookup(name
);
202 static TypeImpl
*type_get_or_load_by_name(const char *name
, Error
**errp
)
204 TypeImpl
*type
= type_get_by_name_noload(name
);
206 #ifdef CONFIG_MODULES
208 int rv
= module_load_qom(name
, errp
);
210 type
= type_get_by_name_noload(name
);
212 error_prepend(errp
, "could not load a module for type '%s'", name
);
218 error_setg(errp
, "unknown type '%s'", name
);
224 static TypeImpl
*type_get_parent(TypeImpl
*type
)
226 if (!type
->parent_type
&& type
->parent
) {
227 type
->parent_type
= type_get_by_name_noload(type
->parent
);
228 if (!type
->parent_type
) {
229 fprintf(stderr
, "Type '%s' is missing its parent '%s'\n",
230 type
->name
, type
->parent
);
235 return type
->parent_type
;
238 static bool type_has_parent(TypeImpl
*type
)
240 return (type
->parent
!= NULL
);
243 static size_t type_class_get_size(TypeImpl
*ti
)
245 if (ti
->class_size
) {
246 return ti
->class_size
;
249 if (type_has_parent(ti
)) {
250 return type_class_get_size(type_get_parent(ti
));
253 return sizeof(ObjectClass
);
256 static size_t type_object_get_size(TypeImpl
*ti
)
258 if (ti
->instance_size
) {
259 return ti
->instance_size
;
262 if (type_has_parent(ti
)) {
263 return type_object_get_size(type_get_parent(ti
));
269 static size_t type_object_get_align(TypeImpl
*ti
)
271 if (ti
->instance_align
) {
272 return ti
->instance_align
;
275 if (type_has_parent(ti
)) {
276 return type_object_get_align(type_get_parent(ti
));
282 static bool type_is_ancestor(TypeImpl
*type
, TypeImpl
*target_type
)
286 /* Check if target_type is a direct ancestor of type */
288 if (type
== target_type
) {
292 type
= type_get_parent(type
);
298 static void type_initialize(TypeImpl
*ti
);
300 static void type_initialize_interface(TypeImpl
*ti
, TypeImpl
*interface_type
,
301 TypeImpl
*parent_type
)
303 InterfaceClass
*new_iface
;
305 TypeImpl
*iface_impl
;
307 info
.parent
= parent_type
->name
;
308 info
.name
= g_strdup_printf("%s::%s", ti
->name
, interface_type
->name
);
309 info
.abstract
= true;
311 iface_impl
= type_new(&info
);
312 iface_impl
->parent_type
= parent_type
;
313 type_initialize(iface_impl
);
314 g_free((char *)info
.name
);
316 new_iface
= (InterfaceClass
*)iface_impl
->class;
317 new_iface
->interface_type
= interface_type
;
319 ti
->class->interfaces
= g_slist_append(ti
->class->interfaces
, new_iface
);
322 static void object_property_free(gpointer data
)
324 ObjectProperty
*prop
= data
;
327 qobject_unref(prop
->defval
);
332 g_free(prop
->description
);
336 static void type_initialize(TypeImpl
*ti
)
344 ti
->class_size
= type_class_get_size(ti
);
345 ti
->instance_size
= type_object_get_size(ti
);
346 ti
->instance_align
= type_object_get_align(ti
);
347 /* Any type with zero instance_size is implicitly abstract.
348 * This means interface types are all abstract.
350 if (ti
->instance_size
== 0) {
353 if (type_is_ancestor(ti
, type_interface
)) {
354 assert(ti
->instance_size
== 0);
355 assert(ti
->abstract
);
356 assert(!ti
->instance_init
);
357 assert(!ti
->instance_post_init
);
358 assert(!ti
->instance_finalize
);
359 assert(!ti
->num_interfaces
);
361 ti
->class = g_malloc0(ti
->class_size
);
363 parent
= type_get_parent(ti
);
365 type_initialize(parent
);
369 g_assert(parent
->class_size
<= ti
->class_size
);
370 g_assert(parent
->instance_size
<= ti
->instance_size
);
371 memcpy(ti
->class, parent
->class, parent
->class_size
);
372 ti
->class->interfaces
= NULL
;
374 for (e
= parent
->class->interfaces
; e
; e
= e
->next
) {
375 InterfaceClass
*iface
= e
->data
;
376 ObjectClass
*klass
= OBJECT_CLASS(iface
);
378 type_initialize_interface(ti
, iface
->interface_type
, klass
->type
);
381 for (i
= 0; i
< ti
->num_interfaces
; i
++) {
382 TypeImpl
*t
= type_get_by_name_noload(ti
->interfaces
[i
].typename
);
384 error_report("missing interface '%s' for object '%s'",
385 ti
->interfaces
[i
].typename
, parent
->name
);
388 for (e
= ti
->class->interfaces
; e
; e
= e
->next
) {
389 TypeImpl
*target_type
= OBJECT_CLASS(e
->data
)->type
;
391 if (type_is_ancestor(target_type
, t
)) {
400 type_initialize_interface(ti
, t
, t
);
404 ti
->class->properties
= g_hash_table_new_full(g_str_hash
, g_str_equal
, NULL
,
405 object_property_free
);
407 ti
->class->type
= ti
;
410 if (parent
->class_base_init
) {
411 parent
->class_base_init(ti
->class, ti
->class_data
);
413 parent
= type_get_parent(parent
);
416 if (ti
->class_init
) {
417 ti
->class_init(ti
->class, ti
->class_data
);
421 static void object_init_with_type(Object
*obj
, TypeImpl
*ti
)
423 if (type_has_parent(ti
)) {
424 object_init_with_type(obj
, type_get_parent(ti
));
427 if (ti
->instance_init
) {
428 ti
->instance_init(obj
);
432 static void object_post_init_with_type(Object
*obj
, TypeImpl
*ti
)
434 if (ti
->instance_post_init
) {
435 ti
->instance_post_init(obj
);
438 if (type_has_parent(ti
)) {
439 object_post_init_with_type(obj
, type_get_parent(ti
));
443 bool object_apply_global_props(Object
*obj
, const GPtrArray
*props
,
452 for (i
= 0; i
< props
->len
; i
++) {
453 GlobalProperty
*p
= g_ptr_array_index(props
, i
);
456 if (object_dynamic_cast(obj
, p
->driver
) == NULL
) {
459 if (p
->optional
&& !object_property_find(obj
, p
->property
)) {
463 if (!object_property_parse(obj
, p
->property
, p
->value
, &err
)) {
464 error_prepend(&err
, "can't apply global %s.%s=%s: ",
465 p
->driver
, p
->property
, p
->value
);
467 * If errp != NULL, propagate error and return.
468 * If errp == NULL, report a warning, but keep going
469 * with the remaining globals.
472 error_propagate(errp
, err
);
475 warn_report_err(err
);
484 * Global property defaults
485 * Slot 0: accelerator's global property defaults
486 * Slot 1: machine's global property defaults
487 * Slot 2: global properties from legacy command line option
488 * Each is a GPtrArray of of GlobalProperty.
489 * Applied in order, later entries override earlier ones.
491 static GPtrArray
*object_compat_props
[3];
494 * Retrieve @GPtrArray for global property defined with options
495 * other than "-global". These are generally used for syntactic
496 * sugar and legacy command line options.
498 void object_register_sugar_prop(const char *driver
, const char *prop
,
499 const char *value
, bool optional
)
502 if (!object_compat_props
[2]) {
503 object_compat_props
[2] = g_ptr_array_new();
505 g
= g_new0(GlobalProperty
, 1);
506 g
->driver
= g_strdup(driver
);
507 g
->property
= g_strdup(prop
);
508 g
->value
= g_strdup(value
);
509 g
->optional
= optional
;
510 g_ptr_array_add(object_compat_props
[2], g
);
514 * Set machine's global property defaults to @compat_props.
515 * May be called at most once.
517 void object_set_machine_compat_props(GPtrArray
*compat_props
)
519 assert(!object_compat_props
[1]);
520 object_compat_props
[1] = compat_props
;
524 * Set accelerator's global property defaults to @compat_props.
525 * May be called at most once.
527 void object_set_accelerator_compat_props(GPtrArray
*compat_props
)
529 assert(!object_compat_props
[0]);
530 object_compat_props
[0] = compat_props
;
533 void object_apply_compat_props(Object
*obj
)
537 for (i
= 0; i
< ARRAY_SIZE(object_compat_props
); i
++) {
538 object_apply_global_props(obj
, object_compat_props
[i
],
539 i
== 2 ? &error_fatal
: &error_abort
);
543 static void object_class_property_init_all(Object
*obj
)
545 ObjectPropertyIterator iter
;
546 ObjectProperty
*prop
;
548 object_class_property_iter_init(&iter
, object_get_class(obj
));
549 while ((prop
= object_property_iter_next(&iter
))) {
551 prop
->init(obj
, prop
);
556 static void object_initialize_with_type(Object
*obj
, size_t size
, TypeImpl
*type
)
558 type_initialize(type
);
560 g_assert(type
->instance_size
>= sizeof(Object
));
561 g_assert(type
->abstract
== false);
562 g_assert(size
>= type
->instance_size
);
564 memset(obj
, 0, type
->instance_size
);
565 obj
->class = type
->class;
567 object_class_property_init_all(obj
);
568 obj
->properties
= g_hash_table_new_full(g_str_hash
, g_str_equal
,
569 NULL
, object_property_free
);
570 object_init_with_type(obj
, type
);
571 object_post_init_with_type(obj
, type
);
574 void object_initialize(void *data
, size_t size
, const char *typename
)
576 TypeImpl
*type
= type_get_or_load_by_name(typename
, &error_fatal
);
578 object_initialize_with_type(data
, size
, type
);
581 bool object_initialize_child_with_props(Object
*parentobj
,
582 const char *propname
,
583 void *childobj
, size_t size
,
590 va_start(vargs
, errp
);
591 ok
= object_initialize_child_with_propsv(parentobj
, propname
,
592 childobj
, size
, type
, errp
,
598 bool object_initialize_child_with_propsv(Object
*parentobj
,
599 const char *propname
,
600 void *childobj
, size_t size
,
602 Error
**errp
, va_list vargs
)
608 object_initialize(childobj
, size
, type
);
609 obj
= OBJECT(childobj
);
611 if (!object_set_propv(obj
, errp
, vargs
)) {
615 object_property_add_child(parentobj
, propname
, obj
);
617 uc
= (UserCreatable
*)object_dynamic_cast(obj
, TYPE_USER_CREATABLE
);
619 if (!user_creatable_complete(uc
, errp
)) {
620 object_unparent(obj
);
629 * We want @obj's reference to be 1 on success, 0 on failure.
630 * On success, it's 2: one taken by object_initialize(), and one
631 * by object_property_add_child().
632 * On failure in object_initialize() or earlier, it's 1.
633 * On failure afterwards, it's also 1: object_unparent() releases
634 * the reference taken by object_property_add_child().
640 void object_initialize_child_internal(Object
*parent
,
641 const char *propname
,
642 void *child
, size_t size
,
645 object_initialize_child_with_props(parent
, propname
, child
, size
, type
,
649 static inline bool object_property_is_child(ObjectProperty
*prop
)
651 return strstart(prop
->type
, "child<", NULL
);
654 static void object_property_del_all(Object
*obj
)
656 g_autoptr(GHashTable
) done
= g_hash_table_new(NULL
, NULL
);
657 ObjectProperty
*prop
;
658 ObjectPropertyIterator iter
;
663 object_property_iter_init(&iter
, obj
);
664 while ((prop
= object_property_iter_next(&iter
)) != NULL
) {
665 if (g_hash_table_add(done
, prop
)) {
667 prop
->release(obj
, prop
->name
, prop
->opaque
);
675 g_hash_table_unref(obj
->properties
);
678 static void object_property_del_child(Object
*obj
, Object
*child
)
680 ObjectProperty
*prop
;
684 g_hash_table_iter_init(&iter
, obj
->properties
);
685 while (g_hash_table_iter_next(&iter
, &key
, &value
)) {
687 if (object_property_is_child(prop
) && prop
->opaque
== child
) {
689 prop
->release(obj
, prop
->name
, prop
->opaque
);
690 prop
->release
= NULL
;
695 g_hash_table_iter_init(&iter
, obj
->properties
);
696 while (g_hash_table_iter_next(&iter
, &key
, &value
)) {
698 if (object_property_is_child(prop
) && prop
->opaque
== child
) {
699 g_hash_table_iter_remove(&iter
);
705 void object_unparent(Object
*obj
)
708 object_property_del_child(obj
->parent
, obj
);
712 static void object_deinit(Object
*obj
, TypeImpl
*type
)
714 if (type
->instance_finalize
) {
715 type
->instance_finalize(obj
);
718 if (type_has_parent(type
)) {
719 object_deinit(obj
, type_get_parent(type
));
723 static void object_finalize(void *data
)
726 TypeImpl
*ti
= obj
->class->type
;
728 object_property_del_all(obj
);
729 object_deinit(obj
, ti
);
731 g_assert(obj
->ref
== 0);
732 g_assert(obj
->parent
== NULL
);
738 /* Find the minimum alignment guaranteed by the system malloc. */
739 #if __STDC_VERSION__ >= 201112L
740 typedef max_align_t qemu_max_align_t
;
750 static Object
*object_new_with_type(Type type
)
754 void (*obj_free
)(void *);
756 g_assert(type
!= NULL
);
757 type_initialize(type
);
759 size
= type
->instance_size
;
760 align
= type
->instance_align
;
763 * Do not use qemu_memalign unless required. Depending on the
764 * implementation, extra alignment implies extra overhead.
766 if (likely(align
<= __alignof__(qemu_max_align_t
))) {
767 obj
= g_malloc(size
);
770 obj
= qemu_memalign(align
, size
);
771 obj_free
= qemu_vfree
;
774 object_initialize_with_type(obj
, size
, type
);
775 obj
->free
= obj_free
;
780 Object
*object_new_with_class(ObjectClass
*klass
)
782 return object_new_with_type(klass
->type
);
785 Object
*object_new(const char *typename
)
787 TypeImpl
*ti
= type_get_or_load_by_name(typename
, &error_fatal
);
789 return object_new_with_type(ti
);
793 Object
*object_new_with_props(const char *typename
,
802 va_start(vargs
, errp
);
803 obj
= object_new_with_propv(typename
, parent
, id
, errp
, vargs
);
810 Object
*object_new_with_propv(const char *typename
,
820 klass
= object_class_by_name(typename
);
822 error_setg(errp
, "invalid object type: %s", typename
);
826 if (object_class_is_abstract(klass
)) {
827 error_setg(errp
, "object type '%s' is abstract", typename
);
830 obj
= object_new_with_type(klass
->type
);
832 if (!object_set_propv(obj
, errp
, vargs
)) {
837 object_property_add_child(parent
, id
, obj
);
840 uc
= (UserCreatable
*)object_dynamic_cast(obj
, TYPE_USER_CREATABLE
);
842 if (!user_creatable_complete(uc
, errp
)) {
844 object_unparent(obj
);
859 bool object_set_props(Object
*obj
,
866 va_start(vargs
, errp
);
867 ret
= object_set_propv(obj
, errp
, vargs
);
874 bool object_set_propv(Object
*obj
,
878 const char *propname
;
880 propname
= va_arg(vargs
, char *);
881 while (propname
!= NULL
) {
882 const char *value
= va_arg(vargs
, char *);
884 g_assert(value
!= NULL
);
885 if (!object_property_parse(obj
, propname
, value
, errp
)) {
888 propname
= va_arg(vargs
, char *);
895 Object
*object_dynamic_cast(Object
*obj
, const char *typename
)
897 if (obj
&& object_class_dynamic_cast(object_get_class(obj
), typename
)) {
904 Object
*object_dynamic_cast_assert(Object
*obj
, const char *typename
,
905 const char *file
, int line
, const char *func
)
907 trace_object_dynamic_cast_assert(obj
? obj
->class->type
->name
: "(null)",
908 typename
, file
, line
, func
);
910 #ifdef CONFIG_QOM_CAST_DEBUG
914 for (i
= 0; obj
&& i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
915 if (qatomic_read(&obj
->class->object_cast_cache
[i
]) == typename
) {
920 inst
= object_dynamic_cast(obj
, typename
);
923 fprintf(stderr
, "%s:%d:%s: Object %p is not an instance of type %s\n",
924 file
, line
, func
, obj
, typename
);
930 if (obj
&& obj
== inst
) {
931 for (i
= 1; i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
932 qatomic_set(&obj
->class->object_cast_cache
[i
- 1],
933 qatomic_read(&obj
->class->object_cast_cache
[i
]));
935 qatomic_set(&obj
->class->object_cast_cache
[i
- 1], typename
);
943 ObjectClass
*object_class_dynamic_cast(ObjectClass
*class,
944 const char *typename
)
946 ObjectClass
*ret
= NULL
;
947 TypeImpl
*target_type
;
954 /* A simple fast path that can trigger a lot for leaf classes. */
956 if (type
->name
== typename
) {
960 target_type
= type_get_by_name_noload(typename
);
962 /* target class type unknown, so fail the cast */
966 if (type
->class->interfaces
&&
967 type_is_ancestor(target_type
, type_interface
)) {
971 for (i
= class->interfaces
; i
; i
= i
->next
) {
972 ObjectClass
*target_class
= i
->data
;
974 if (type_is_ancestor(target_class
->type
, target_type
)) {
980 /* The match was ambiguous, don't allow a cast */
984 } else if (type_is_ancestor(type
, target_type
)) {
991 ObjectClass
*object_class_dynamic_cast_assert(ObjectClass
*class,
992 const char *typename
,
993 const char *file
, int line
,
998 trace_object_class_dynamic_cast_assert(class ? class->type
->name
: "(null)",
999 typename
, file
, line
, func
);
1001 #ifdef CONFIG_QOM_CAST_DEBUG
1004 for (i
= 0; class && i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
1005 if (qatomic_read(&class->class_cast_cache
[i
]) == typename
) {
1011 if (!class || !class->interfaces
) {
1016 ret
= object_class_dynamic_cast(class, typename
);
1017 if (!ret
&& class) {
1018 fprintf(stderr
, "%s:%d:%s: Object %p is not an instance of type %s\n",
1019 file
, line
, func
, class, typename
);
1023 #ifdef CONFIG_QOM_CAST_DEBUG
1024 if (class && ret
== class) {
1025 for (i
= 1; i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
1026 qatomic_set(&class->class_cast_cache
[i
- 1],
1027 qatomic_read(&class->class_cast_cache
[i
]));
1029 qatomic_set(&class->class_cast_cache
[i
- 1], typename
);
1036 const char *object_get_typename(const Object
*obj
)
1038 return obj
->class->type
->name
;
1041 ObjectClass
*object_get_class(Object
*obj
)
1046 bool object_class_is_abstract(ObjectClass
*klass
)
1048 return klass
->type
->abstract
;
1051 const char *object_class_get_name(ObjectClass
*klass
)
1053 return klass
->type
->name
;
1056 ObjectClass
*object_class_by_name(const char *typename
)
1058 TypeImpl
*type
= type_get_by_name_noload(typename
);
1064 type_initialize(type
);
1069 ObjectClass
*module_object_class_by_name(const char *typename
)
1071 TypeImpl
*type
= type_get_or_load_by_name(typename
, NULL
);
1077 type_initialize(type
);
1082 ObjectClass
*object_class_get_parent(ObjectClass
*class)
1084 TypeImpl
*type
= type_get_parent(class->type
);
1090 type_initialize(type
);
1095 typedef struct OCFData
1097 void (*fn
)(ObjectClass
*klass
, void *opaque
);
1098 const char *implements_type
;
1099 bool include_abstract
;
1103 static void object_class_foreach_tramp(gpointer key
, gpointer value
,
1106 OCFData
*data
= opaque
;
1107 TypeImpl
*type
= value
;
1110 type_initialize(type
);
1113 if (!data
->include_abstract
&& type
->abstract
) {
1117 if (data
->implements_type
&&
1118 !object_class_dynamic_cast(k
, data
->implements_type
)) {
1122 data
->fn(k
, data
->opaque
);
1125 void object_class_foreach(void (*fn
)(ObjectClass
*klass
, void *opaque
),
1126 const char *implements_type
, bool include_abstract
,
1129 OCFData data
= { fn
, implements_type
, include_abstract
, opaque
};
1131 enumerating_types
= true;
1132 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp
, &data
);
1133 enumerating_types
= false;
1136 static int do_object_child_foreach(Object
*obj
,
1137 int (*fn
)(Object
*child
, void *opaque
),
1138 void *opaque
, bool recurse
)
1140 GHashTableIter iter
;
1141 ObjectProperty
*prop
;
1144 g_hash_table_iter_init(&iter
, obj
->properties
);
1145 while (g_hash_table_iter_next(&iter
, NULL
, (gpointer
*)&prop
)) {
1146 if (object_property_is_child(prop
)) {
1147 Object
*child
= prop
->opaque
;
1149 ret
= fn(child
, opaque
);
1154 ret
= do_object_child_foreach(child
, fn
, opaque
, true);
1164 int object_child_foreach(Object
*obj
, int (*fn
)(Object
*child
, void *opaque
),
1167 return do_object_child_foreach(obj
, fn
, opaque
, false);
1170 int object_child_foreach_recursive(Object
*obj
,
1171 int (*fn
)(Object
*child
, void *opaque
),
1174 return do_object_child_foreach(obj
, fn
, opaque
, true);
1177 static void object_class_get_list_tramp(ObjectClass
*klass
, void *opaque
)
1179 GSList
**list
= opaque
;
1181 *list
= g_slist_prepend(*list
, klass
);
1184 GSList
*object_class_get_list(const char *implements_type
,
1185 bool include_abstract
)
1187 GSList
*list
= NULL
;
1189 object_class_foreach(object_class_get_list_tramp
,
1190 implements_type
, include_abstract
, &list
);
1194 static gint
object_class_cmp(gconstpointer a
, gconstpointer b
)
1196 return strcasecmp(object_class_get_name((ObjectClass
*)a
),
1197 object_class_get_name((ObjectClass
*)b
));
1200 GSList
*object_class_get_list_sorted(const char *implements_type
,
1201 bool include_abstract
)
1203 return g_slist_sort(object_class_get_list(implements_type
, include_abstract
),
1207 Object
*object_ref(void *objptr
)
1209 Object
*obj
= OBJECT(objptr
);
1215 ref
= qatomic_fetch_inc(&obj
->ref
);
1216 /* Assert waaay before the integer overflows */
1217 g_assert(ref
< INT_MAX
);
1221 void object_unref(void *objptr
)
1223 Object
*obj
= OBJECT(objptr
);
1227 g_assert(obj
->ref
> 0);
1229 /* parent always holds a reference to its children */
1230 if (qatomic_fetch_dec(&obj
->ref
) == 1) {
1231 object_finalize(obj
);
1236 object_property_try_add(Object
*obj
, const char *name
, const char *type
,
1237 ObjectPropertyAccessor
*get
,
1238 ObjectPropertyAccessor
*set
,
1239 ObjectPropertyRelease
*release
,
1240 void *opaque
, Error
**errp
)
1242 ObjectProperty
*prop
;
1243 size_t name_len
= strlen(name
);
1245 if (name_len
>= 3 && !memcmp(name
+ name_len
- 3, "[*]", 4)) {
1247 ObjectProperty
*ret
= NULL
;
1248 char *name_no_array
= g_strdup(name
);
1250 name_no_array
[name_len
- 3] = '\0';
1251 for (i
= 0; i
< INT16_MAX
; ++i
) {
1252 char *full_name
= g_strdup_printf("%s[%d]", name_no_array
, i
);
1254 ret
= object_property_try_add(obj
, full_name
, type
, get
, set
,
1255 release
, opaque
, NULL
);
1261 g_free(name_no_array
);
1266 if (object_property_find(obj
, name
) != NULL
) {
1267 error_setg(errp
, "attempt to add duplicate property '%s' to object (type '%s')",
1268 name
, object_get_typename(obj
));
1272 prop
= g_malloc0(sizeof(*prop
));
1274 prop
->name
= g_strdup(name
);
1275 prop
->type
= g_strdup(type
);
1279 prop
->release
= release
;
1280 prop
->opaque
= opaque
;
1282 g_hash_table_insert(obj
->properties
, prop
->name
, prop
);
1287 object_property_add(Object
*obj
, const char *name
, const char *type
,
1288 ObjectPropertyAccessor
*get
,
1289 ObjectPropertyAccessor
*set
,
1290 ObjectPropertyRelease
*release
,
1293 return object_property_try_add(obj
, name
, type
, get
, set
, release
,
1294 opaque
, &error_abort
);
1298 object_class_property_add(ObjectClass
*klass
,
1301 ObjectPropertyAccessor
*get
,
1302 ObjectPropertyAccessor
*set
,
1303 ObjectPropertyRelease
*release
,
1306 ObjectProperty
*prop
;
1308 assert(!object_class_property_find(klass
, name
));
1310 prop
= g_malloc0(sizeof(*prop
));
1312 prop
->name
= g_strdup(name
);
1313 prop
->type
= g_strdup(type
);
1317 prop
->release
= release
;
1318 prop
->opaque
= opaque
;
1320 g_hash_table_insert(klass
->properties
, prop
->name
, prop
);
1325 ObjectProperty
*object_property_find(Object
*obj
, const char *name
)
1327 ObjectProperty
*prop
;
1328 ObjectClass
*klass
= object_get_class(obj
);
1330 prop
= object_class_property_find(klass
, name
);
1335 return g_hash_table_lookup(obj
->properties
, name
);
1338 ObjectProperty
*object_property_find_err(Object
*obj
, const char *name
,
1341 ObjectProperty
*prop
= object_property_find(obj
, name
);
1343 error_setg(errp
, "Property '%s.%s' not found",
1344 object_get_typename(obj
), name
);
1349 void object_property_iter_init(ObjectPropertyIterator
*iter
,
1352 g_hash_table_iter_init(&iter
->iter
, obj
->properties
);
1353 iter
->nextclass
= object_get_class(obj
);
1356 ObjectProperty
*object_property_iter_next(ObjectPropertyIterator
*iter
)
1359 while (!g_hash_table_iter_next(&iter
->iter
, &key
, &val
)) {
1360 if (!iter
->nextclass
) {
1363 g_hash_table_iter_init(&iter
->iter
, iter
->nextclass
->properties
);
1364 iter
->nextclass
= object_class_get_parent(iter
->nextclass
);
1369 void object_class_property_iter_init(ObjectPropertyIterator
*iter
,
1372 g_hash_table_iter_init(&iter
->iter
, klass
->properties
);
1373 iter
->nextclass
= object_class_get_parent(klass
);
1376 ObjectProperty
*object_class_property_find(ObjectClass
*klass
, const char *name
)
1378 ObjectClass
*parent_klass
;
1380 parent_klass
= object_class_get_parent(klass
);
1382 ObjectProperty
*prop
=
1383 object_class_property_find(parent_klass
, name
);
1389 return g_hash_table_lookup(klass
->properties
, name
);
1392 ObjectProperty
*object_class_property_find_err(ObjectClass
*klass
,
1396 ObjectProperty
*prop
= object_class_property_find(klass
, name
);
1398 error_setg(errp
, "Property '.%s' not found", name
);
1404 void object_property_del(Object
*obj
, const char *name
)
1406 ObjectProperty
*prop
= g_hash_table_lookup(obj
->properties
, name
);
1408 if (prop
->release
) {
1409 prop
->release(obj
, name
, prop
->opaque
);
1411 g_hash_table_remove(obj
->properties
, name
);
1414 bool object_property_get(Object
*obj
, const char *name
, Visitor
*v
,
1418 ObjectProperty
*prop
= object_property_find_err(obj
, name
, errp
);
1425 error_setg(errp
, "Property '%s.%s' is not readable",
1426 object_get_typename(obj
), name
);
1429 prop
->get(obj
, v
, name
, prop
->opaque
, &err
);
1430 error_propagate(errp
, err
);
1434 bool object_property_set(Object
*obj
, const char *name
, Visitor
*v
,
1438 ObjectProperty
*prop
= object_property_find_err(obj
, name
, errp
);
1445 error_setg(errp
, "Property '%s.%s' is not writable",
1446 object_get_typename(obj
), name
);
1449 prop
->set(obj
, v
, name
, prop
->opaque
, errp
);
1453 bool object_property_set_str(Object
*obj
, const char *name
,
1454 const char *value
, Error
**errp
)
1456 QString
*qstr
= qstring_from_str(value
);
1457 bool ok
= object_property_set_qobject(obj
, name
, QOBJECT(qstr
), errp
);
1459 qobject_unref(qstr
);
1463 char *object_property_get_str(Object
*obj
, const char *name
,
1466 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1473 qstring
= qobject_to(QString
, ret
);
1475 error_setg(errp
, "Invalid parameter type for '%s', expected: string",
1479 retval
= g_strdup(qstring_get_str(qstring
));
1486 bool object_property_set_link(Object
*obj
, const char *name
,
1487 Object
*value
, Error
**errp
)
1489 g_autofree
char *path
= NULL
;
1492 path
= object_get_canonical_path(value
);
1494 return object_property_set_str(obj
, name
, path
?: "", errp
);
1497 Object
*object_property_get_link(Object
*obj
, const char *name
,
1500 char *str
= object_property_get_str(obj
, name
, errp
);
1501 Object
*target
= NULL
;
1504 target
= object_resolve_path(str
, NULL
);
1506 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1507 "Device '%s' not found", str
);
1515 bool object_property_set_bool(Object
*obj
, const char *name
,
1516 bool value
, Error
**errp
)
1518 QBool
*qbool
= qbool_from_bool(value
);
1519 bool ok
= object_property_set_qobject(obj
, name
, QOBJECT(qbool
), errp
);
1521 qobject_unref(qbool
);
1525 bool object_property_get_bool(Object
*obj
, const char *name
,
1528 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1535 qbool
= qobject_to(QBool
, ret
);
1537 error_setg(errp
, "Invalid parameter type for '%s', expected: boolean",
1541 retval
= qbool_get_bool(qbool
);
1548 bool object_property_set_int(Object
*obj
, const char *name
,
1549 int64_t value
, Error
**errp
)
1551 QNum
*qnum
= qnum_from_int(value
);
1552 bool ok
= object_property_set_qobject(obj
, name
, QOBJECT(qnum
), errp
);
1554 qobject_unref(qnum
);
1558 int64_t object_property_get_int(Object
*obj
, const char *name
,
1561 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1569 qnum
= qobject_to(QNum
, ret
);
1570 if (!qnum
|| !qnum_get_try_int(qnum
, &retval
)) {
1571 error_setg(errp
, "Invalid parameter type for '%s', expected: int",
1580 static void object_property_init_defval(Object
*obj
, ObjectProperty
*prop
)
1582 Visitor
*v
= qobject_input_visitor_new(prop
->defval
);
1584 assert(prop
->set
!= NULL
);
1585 prop
->set(obj
, v
, prop
->name
, prop
->opaque
, &error_abort
);
1590 static void object_property_set_default(ObjectProperty
*prop
, QObject
*defval
)
1592 assert(!prop
->defval
);
1593 assert(!prop
->init
);
1595 prop
->defval
= defval
;
1596 prop
->init
= object_property_init_defval
;
1599 void object_property_set_default_bool(ObjectProperty
*prop
, bool value
)
1601 object_property_set_default(prop
, QOBJECT(qbool_from_bool(value
)));
1604 void object_property_set_default_str(ObjectProperty
*prop
, const char *value
)
1606 object_property_set_default(prop
, QOBJECT(qstring_from_str(value
)));
1609 void object_property_set_default_list(ObjectProperty
*prop
)
1611 object_property_set_default(prop
, QOBJECT(qlist_new()));
1614 void object_property_set_default_int(ObjectProperty
*prop
, int64_t value
)
1616 object_property_set_default(prop
, QOBJECT(qnum_from_int(value
)));
1619 void object_property_set_default_uint(ObjectProperty
*prop
, uint64_t value
)
1621 object_property_set_default(prop
, QOBJECT(qnum_from_uint(value
)));
1624 bool object_property_set_uint(Object
*obj
, const char *name
,
1625 uint64_t value
, Error
**errp
)
1627 QNum
*qnum
= qnum_from_uint(value
);
1628 bool ok
= object_property_set_qobject(obj
, name
, QOBJECT(qnum
), errp
);
1630 qobject_unref(qnum
);
1634 uint64_t object_property_get_uint(Object
*obj
, const char *name
,
1637 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1644 qnum
= qobject_to(QNum
, ret
);
1645 if (!qnum
|| !qnum_get_try_uint(qnum
, &retval
)) {
1646 error_setg(errp
, "Invalid parameter type for '%s', expected: uint",
1655 typedef struct EnumProperty
{
1656 const QEnumLookup
*lookup
;
1657 int (*get
)(Object
*, Error
**);
1658 void (*set
)(Object
*, int, Error
**);
1661 int object_property_get_enum(Object
*obj
, const char *name
,
1662 const char *typename
, Error
**errp
)
1666 ObjectProperty
*prop
= object_property_find_err(obj
, name
, errp
);
1667 EnumProperty
*enumprop
;
1673 if (!g_str_equal(prop
->type
, typename
)) {
1674 error_setg(errp
, "Property %s on %s is not '%s' enum type",
1675 name
, object_class_get_name(
1676 object_get_class(obj
)), typename
);
1680 enumprop
= prop
->opaque
;
1682 str
= object_property_get_str(obj
, name
, errp
);
1687 ret
= qapi_enum_parse(enumprop
->lookup
, str
, -1, errp
);
1693 bool object_property_parse(Object
*obj
, const char *name
,
1694 const char *string
, Error
**errp
)
1696 Visitor
*v
= string_input_visitor_new(string
);
1697 bool ok
= object_property_set(obj
, name
, v
, errp
);
1703 char *object_property_print(Object
*obj
, const char *name
, bool human
,
1707 char *string
= NULL
;
1709 v
= string_output_visitor_new(human
, &string
);
1710 if (!object_property_get(obj
, name
, v
, errp
)) {
1714 visit_complete(v
, &string
);
1721 const char *object_property_get_type(Object
*obj
, const char *name
, Error
**errp
)
1723 ObjectProperty
*prop
= object_property_find_err(obj
, name
, errp
);
1731 static const char *const root_containers
[] = {
1737 static Object
*object_root_initialize(void)
1739 Object
*root
= object_new(TYPE_CONTAINER
);
1743 * Create all QEMU system containers. "machine" and its sub-containers
1744 * are only created when machine initializes (qemu_create_machine()).
1746 for (i
= 0; i
< ARRAY_SIZE(root_containers
); i
++) {
1747 object_property_add_new_container(root
, root_containers
[i
]);
1753 Object
*object_get_container(const char *name
)
1757 container
= object_resolve_path_component(object_get_root(), name
);
1758 assert(object_dynamic_cast(container
, TYPE_CONTAINER
));
1763 Object
*object_get_root(void)
1765 static Object
*root
;
1768 root
= object_root_initialize();
1774 Object
*object_get_objects_root(void)
1776 return object_get_container("objects");
1779 Object
*object_get_internal_root(void)
1781 static Object
*internal_root
;
1783 if (!internal_root
) {
1784 internal_root
= object_new(TYPE_CONTAINER
);
1787 return internal_root
;
1790 static void object_get_child_property(Object
*obj
, Visitor
*v
,
1791 const char *name
, void *opaque
,
1794 Object
*child
= opaque
;
1797 path
= object_get_canonical_path(child
);
1798 visit_type_str(v
, name
, &path
, errp
);
1802 static Object
*object_resolve_child_property(Object
*parent
, void *opaque
,
1808 static void object_finalize_child_property(Object
*obj
, const char *name
,
1811 Object
*child
= opaque
;
1813 if (child
->class->unparent
) {
1814 (child
->class->unparent
)(child
);
1816 child
->parent
= NULL
;
1817 object_unref(child
);
1821 object_property_try_add_child(Object
*obj
, const char *name
,
1822 Object
*child
, Error
**errp
)
1824 g_autofree
char *type
= NULL
;
1827 assert(!child
->parent
);
1829 type
= g_strdup_printf("child<%s>", object_get_typename(child
));
1831 op
= object_property_try_add(obj
, name
, type
, object_get_child_property
,
1832 NULL
, object_finalize_child_property
,
1837 op
->resolve
= object_resolve_child_property
;
1839 child
->parent
= obj
;
1844 object_property_add_child(Object
*obj
, const char *name
,
1847 return object_property_try_add_child(obj
, name
, child
, &error_abort
);
1850 void object_property_allow_set_link(const Object
*obj
, const char *name
,
1851 Object
*val
, Error
**errp
)
1853 /* Allow the link to be set, always */
1859 Object
*target
; /* if OBJ_PROP_LINK_DIRECT, when holding the pointer */
1860 ptrdiff_t offset
; /* if OBJ_PROP_LINK_CLASS */
1862 void (*check
)(const Object
*, const char *, Object
*, Error
**);
1863 ObjectPropertyLinkFlags flags
;
1867 object_link_get_targetp(Object
*obj
, LinkProperty
*lprop
)
1869 if (lprop
->flags
& OBJ_PROP_LINK_DIRECT
) {
1870 return &lprop
->target
;
1871 } else if (lprop
->flags
& OBJ_PROP_LINK_CLASS
) {
1872 return (void *)obj
+ lprop
->offset
;
1874 return lprop
->targetp
;
1878 static void object_get_link_property(Object
*obj
, Visitor
*v
,
1879 const char *name
, void *opaque
,
1882 LinkProperty
*lprop
= opaque
;
1883 Object
**targetp
= object_link_get_targetp(obj
, lprop
);
1887 path
= object_get_canonical_path(*targetp
);
1888 visit_type_str(v
, name
, &path
, errp
);
1892 visit_type_str(v
, name
, &path
, errp
);
1897 * object_resolve_link:
1899 * Lookup an object and ensure its type matches the link property type. This
1900 * is similar to object_resolve_path() except type verification against the
1901 * link property is performed.
1903 * Returns: The matched object or NULL on path lookup failures.
1905 static Object
*object_resolve_link(Object
*obj
, const char *name
,
1906 const char *path
, Error
**errp
)
1910 bool ambiguous
= false;
1913 /* Go from link<FOO> to FOO. */
1914 type
= object_property_get_type(obj
, name
, NULL
);
1915 target_type
= g_strndup(&type
[5], strlen(type
) - 6);
1916 target
= object_resolve_path_type(path
, target_type
, &ambiguous
);
1919 error_setg(errp
, "Path '%s' does not uniquely identify an object",
1921 } else if (!target
) {
1922 target
= object_resolve_path(path
, &ambiguous
);
1923 if (target
|| ambiguous
) {
1924 error_setg(errp
, "Invalid parameter type for '%s', expected: %s",
1927 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1928 "Device '%s' not found", path
);
1932 g_free(target_type
);
1937 static void object_set_link_property(Object
*obj
, Visitor
*v
,
1938 const char *name
, void *opaque
,
1941 Error
*local_err
= NULL
;
1942 LinkProperty
*prop
= opaque
;
1943 Object
**targetp
= object_link_get_targetp(obj
, prop
);
1944 Object
*old_target
= *targetp
;
1948 if (!visit_type_str(v
, name
, &path
, errp
)) {
1953 new_target
= object_resolve_link(obj
, name
, path
, errp
);
1964 prop
->check(obj
, name
, new_target
, &local_err
);
1966 error_propagate(errp
, local_err
);
1970 *targetp
= new_target
;
1971 if (prop
->flags
& OBJ_PROP_LINK_STRONG
) {
1972 object_ref(new_target
);
1973 object_unref(old_target
);
1977 static Object
*object_resolve_link_property(Object
*parent
, void *opaque
,
1980 LinkProperty
*lprop
= opaque
;
1982 return *object_link_get_targetp(parent
, lprop
);
1985 static void object_release_link_property(Object
*obj
, const char *name
,
1988 LinkProperty
*prop
= opaque
;
1989 Object
**targetp
= object_link_get_targetp(obj
, prop
);
1991 if ((prop
->flags
& OBJ_PROP_LINK_STRONG
) && *targetp
) {
1992 object_unref(*targetp
);
1994 if (!(prop
->flags
& OBJ_PROP_LINK_CLASS
)) {
1999 static ObjectProperty
*
2000 object_add_link_prop(Object
*obj
, const char *name
,
2001 const char *type
, void *ptr
,
2002 void (*check
)(const Object
*, const char *,
2003 Object
*, Error
**),
2004 ObjectPropertyLinkFlags flags
)
2006 LinkProperty
*prop
= g_malloc(sizeof(*prop
));
2007 g_autofree
char *full_type
= NULL
;
2010 if (flags
& OBJ_PROP_LINK_DIRECT
) {
2013 prop
->targetp
= ptr
;
2015 prop
->check
= check
;
2016 prop
->flags
= flags
;
2018 full_type
= g_strdup_printf("link<%s>", type
);
2020 op
= object_property_add(obj
, name
, full_type
,
2021 object_get_link_property
,
2022 check
? object_set_link_property
: NULL
,
2023 object_release_link_property
,
2025 op
->resolve
= object_resolve_link_property
;
2030 object_property_add_link(Object
*obj
, const char *name
,
2031 const char *type
, Object
**targetp
,
2032 void (*check
)(const Object
*, const char *,
2033 Object
*, Error
**),
2034 ObjectPropertyLinkFlags flags
)
2036 return object_add_link_prop(obj
, name
, type
, targetp
, check
, flags
);
2040 object_class_property_add_link(ObjectClass
*oc
,
2042 const char *type
, ptrdiff_t offset
,
2043 void (*check
)(const Object
*obj
, const char *name
,
2044 Object
*val
, Error
**errp
),
2045 ObjectPropertyLinkFlags flags
)
2047 LinkProperty
*prop
= g_new0(LinkProperty
, 1);
2051 prop
->offset
= offset
;
2052 prop
->check
= check
;
2053 prop
->flags
= flags
| OBJ_PROP_LINK_CLASS
;
2055 full_type
= g_strdup_printf("link<%s>", type
);
2057 op
= object_class_property_add(oc
, name
, full_type
,
2058 object_get_link_property
,
2059 check
? object_set_link_property
: NULL
,
2060 object_release_link_property
,
2063 op
->resolve
= object_resolve_link_property
;
2070 object_property_add_const_link(Object
*obj
, const char *name
,
2073 return object_add_link_prop(obj
, name
,
2074 object_get_typename(target
), target
,
2075 NULL
, OBJ_PROP_LINK_DIRECT
);
2078 const char *object_get_canonical_path_component(const Object
*obj
)
2080 ObjectProperty
*prop
= NULL
;
2081 GHashTableIter iter
;
2083 if (obj
->parent
== NULL
) {
2087 g_hash_table_iter_init(&iter
, obj
->parent
->properties
);
2088 while (g_hash_table_iter_next(&iter
, NULL
, (gpointer
*)&prop
)) {
2089 if (!object_property_is_child(prop
)) {
2093 if (prop
->opaque
== obj
) {
2098 /* obj had a parent but was not a child, should never happen */
2099 g_assert_not_reached();
2102 char *object_get_canonical_path(const Object
*obj
)
2104 Object
*root
= object_get_root();
2105 char *newpath
, *path
= NULL
;
2108 return g_strdup("/");
2112 const char *component
= object_get_canonical_path_component(obj
);
2115 /* A canonical path must be complete, so discard what was
2122 newpath
= g_strdup_printf("/%s%s", component
, path
? path
: "");
2126 } while (obj
!= root
);
2131 Object
*object_resolve_path_component(Object
*parent
, const char *part
)
2133 ObjectProperty
*prop
= object_property_find(parent
, part
);
2138 if (prop
->resolve
) {
2139 return prop
->resolve(parent
, prop
->opaque
, part
);
2145 static Object
*object_resolve_abs_path(Object
*parent
,
2147 const char *typename
)
2151 if (*parts
== NULL
) {
2152 return object_dynamic_cast(parent
, typename
);
2155 if (strcmp(*parts
, "") == 0) {
2156 return object_resolve_abs_path(parent
, parts
+ 1, typename
);
2159 child
= object_resolve_path_component(parent
, *parts
);
2164 return object_resolve_abs_path(child
, parts
+ 1, typename
);
2167 static Object
*object_resolve_partial_path(Object
*parent
,
2169 const char *typename
,
2173 GHashTableIter iter
;
2174 ObjectProperty
*prop
;
2176 obj
= object_resolve_abs_path(parent
, parts
, typename
);
2178 g_hash_table_iter_init(&iter
, parent
->properties
);
2179 while (g_hash_table_iter_next(&iter
, NULL
, (gpointer
*)&prop
)) {
2182 if (!object_property_is_child(prop
)) {
2186 found
= object_resolve_partial_path(prop
->opaque
, parts
,
2187 typename
, ambiguous
);
2204 Object
*object_resolve_path_type(const char *path
, const char *typename
,
2210 parts
= g_strsplit(path
, "/", 0);
2213 if (parts
[0] == NULL
|| strcmp(parts
[0], "") != 0) {
2215 obj
= object_resolve_partial_path(object_get_root(), parts
,
2221 obj
= object_resolve_abs_path(object_get_root(), parts
+ 1, typename
);
2232 Object
*object_resolve_path(const char *path
, bool *ambiguous
)
2234 return object_resolve_path_type(path
, TYPE_OBJECT
, ambiguous
);
2237 Object
*object_resolve_path_at(Object
*parent
, const char *path
)
2239 g_auto(GStrv
) parts
= g_strsplit(path
, "/", 0);
2242 return object_resolve_abs_path(object_get_root(), parts
+ 1,
2245 return object_resolve_abs_path(parent
, parts
, TYPE_OBJECT
);
2248 Object
*object_resolve_type_unambiguous(const char *typename
, Error
**errp
)
2251 Object
*o
= object_resolve_path_type("", typename
, &ambig
);
2254 error_setg(errp
, "More than one object of type %s", typename
);
2258 error_setg(errp
, "No object found of type %s", typename
);
2264 typedef struct StringProperty
2266 char *(*get
)(Object
*, Error
**);
2267 void (*set
)(Object
*, const char *, Error
**);
2270 static void property_get_str(Object
*obj
, Visitor
*v
, const char *name
,
2271 void *opaque
, Error
**errp
)
2273 StringProperty
*prop
= opaque
;
2277 value
= prop
->get(obj
, &err
);
2279 error_propagate(errp
, err
);
2283 visit_type_str(v
, name
, &value
, errp
);
2287 static void property_set_str(Object
*obj
, Visitor
*v
, const char *name
,
2288 void *opaque
, Error
**errp
)
2290 StringProperty
*prop
= opaque
;
2293 if (!visit_type_str(v
, name
, &value
, errp
)) {
2297 prop
->set(obj
, value
, errp
);
2301 static void property_release_data(Object
*obj
, const char *name
,
2308 object_property_add_str(Object
*obj
, const char *name
,
2309 char *(*get
)(Object
*, Error
**),
2310 void (*set
)(Object
*, const char *, Error
**))
2312 StringProperty
*prop
= g_malloc0(sizeof(*prop
));
2317 return object_property_add(obj
, name
, "string",
2318 get
? property_get_str
: NULL
,
2319 set
? property_set_str
: NULL
,
2320 property_release_data
,
2325 object_class_property_add_str(ObjectClass
*klass
, const char *name
,
2326 char *(*get
)(Object
*, Error
**),
2327 void (*set
)(Object
*, const char *,
2330 StringProperty
*prop
= g_malloc0(sizeof(*prop
));
2335 return object_class_property_add(klass
, name
, "string",
2336 get
? property_get_str
: NULL
,
2337 set
? property_set_str
: NULL
,
2342 typedef struct BoolProperty
2344 bool (*get
)(Object
*, Error
**);
2345 void (*set
)(Object
*, bool, Error
**);
2348 static void property_get_bool(Object
*obj
, Visitor
*v
, const char *name
,
2349 void *opaque
, Error
**errp
)
2351 BoolProperty
*prop
= opaque
;
2355 value
= prop
->get(obj
, &err
);
2357 error_propagate(errp
, err
);
2361 visit_type_bool(v
, name
, &value
, errp
);
2364 static void property_set_bool(Object
*obj
, Visitor
*v
, const char *name
,
2365 void *opaque
, Error
**errp
)
2367 BoolProperty
*prop
= opaque
;
2370 if (!visit_type_bool(v
, name
, &value
, errp
)) {
2374 prop
->set(obj
, value
, errp
);
2378 object_property_add_bool(Object
*obj
, const char *name
,
2379 bool (*get
)(Object
*, Error
**),
2380 void (*set
)(Object
*, bool, Error
**))
2382 BoolProperty
*prop
= g_malloc0(sizeof(*prop
));
2387 return object_property_add(obj
, name
, "bool",
2388 get
? property_get_bool
: NULL
,
2389 set
? property_set_bool
: NULL
,
2390 property_release_data
,
2395 object_class_property_add_bool(ObjectClass
*klass
, const char *name
,
2396 bool (*get
)(Object
*, Error
**),
2397 void (*set
)(Object
*, bool, Error
**))
2399 BoolProperty
*prop
= g_malloc0(sizeof(*prop
));
2404 return object_class_property_add(klass
, name
, "bool",
2405 get
? property_get_bool
: NULL
,
2406 set
? property_set_bool
: NULL
,
2411 static void property_get_enum(Object
*obj
, Visitor
*v
, const char *name
,
2412 void *opaque
, Error
**errp
)
2414 EnumProperty
*prop
= opaque
;
2418 value
= prop
->get(obj
, &err
);
2420 error_propagate(errp
, err
);
2424 visit_type_enum(v
, name
, &value
, prop
->lookup
, errp
);
2427 static void property_set_enum(Object
*obj
, Visitor
*v
, const char *name
,
2428 void *opaque
, Error
**errp
)
2430 EnumProperty
*prop
= opaque
;
2433 if (!visit_type_enum(v
, name
, &value
, prop
->lookup
, errp
)) {
2436 prop
->set(obj
, value
, errp
);
2440 object_property_add_enum(Object
*obj
, const char *name
,
2441 const char *typename
,
2442 const QEnumLookup
*lookup
,
2443 int (*get
)(Object
*, Error
**),
2444 void (*set
)(Object
*, int, Error
**))
2446 EnumProperty
*prop
= g_malloc(sizeof(*prop
));
2448 prop
->lookup
= lookup
;
2452 return object_property_add(obj
, name
, typename
,
2453 get
? property_get_enum
: NULL
,
2454 set
? property_set_enum
: NULL
,
2455 property_release_data
,
2460 object_class_property_add_enum(ObjectClass
*klass
, const char *name
,
2461 const char *typename
,
2462 const QEnumLookup
*lookup
,
2463 int (*get
)(Object
*, Error
**),
2464 void (*set
)(Object
*, int, Error
**))
2466 EnumProperty
*prop
= g_malloc(sizeof(*prop
));
2468 prop
->lookup
= lookup
;
2472 return object_class_property_add(klass
, name
, typename
,
2473 get
? property_get_enum
: NULL
,
2474 set
? property_set_enum
: NULL
,
2479 typedef struct TMProperty
{
2480 void (*get
)(Object
*, struct tm
*, Error
**);
2483 static void property_get_tm(Object
*obj
, Visitor
*v
, const char *name
,
2484 void *opaque
, Error
**errp
)
2486 TMProperty
*prop
= opaque
;
2490 prop
->get(obj
, &value
, &err
);
2492 error_propagate(errp
, err
);
2496 if (!visit_start_struct(v
, name
, NULL
, 0, errp
)) {
2499 if (!visit_type_int32(v
, "tm_year", &value
.tm_year
, errp
)) {
2502 if (!visit_type_int32(v
, "tm_mon", &value
.tm_mon
, errp
)) {
2505 if (!visit_type_int32(v
, "tm_mday", &value
.tm_mday
, errp
)) {
2508 if (!visit_type_int32(v
, "tm_hour", &value
.tm_hour
, errp
)) {
2511 if (!visit_type_int32(v
, "tm_min", &value
.tm_min
, errp
)) {
2514 if (!visit_type_int32(v
, "tm_sec", &value
.tm_sec
, errp
)) {
2517 visit_check_struct(v
, errp
);
2519 visit_end_struct(v
, NULL
);
2523 object_property_add_tm(Object
*obj
, const char *name
,
2524 void (*get
)(Object
*, struct tm
*, Error
**))
2526 TMProperty
*prop
= g_malloc0(sizeof(*prop
));
2530 return object_property_add(obj
, name
, "struct tm",
2531 get
? property_get_tm
: NULL
, NULL
,
2532 property_release_data
,
2537 object_class_property_add_tm(ObjectClass
*klass
, const char *name
,
2538 void (*get
)(Object
*, struct tm
*, Error
**))
2540 TMProperty
*prop
= g_malloc0(sizeof(*prop
));
2544 return object_class_property_add(klass
, name
, "struct tm",
2545 get
? property_get_tm
: NULL
,
2549 static char *object_get_type(Object
*obj
, Error
**errp
)
2551 return g_strdup(object_get_typename(obj
));
2554 static void property_get_uint8_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2555 void *opaque
, Error
**errp
)
2557 uint8_t value
= *(uint8_t *)opaque
;
2558 visit_type_uint8(v
, name
, &value
, errp
);
2561 static void property_set_uint8_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2562 void *opaque
, Error
**errp
)
2564 uint8_t *field
= opaque
;
2567 if (!visit_type_uint8(v
, name
, &value
, errp
)) {
2574 static void property_get_uint16_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2575 void *opaque
, Error
**errp
)
2577 uint16_t value
= *(uint16_t *)opaque
;
2578 visit_type_uint16(v
, name
, &value
, errp
);
2581 static void property_set_uint16_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2582 void *opaque
, Error
**errp
)
2584 uint16_t *field
= opaque
;
2587 if (!visit_type_uint16(v
, name
, &value
, errp
)) {
2594 static void property_get_uint32_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2595 void *opaque
, Error
**errp
)
2597 uint32_t value
= *(uint32_t *)opaque
;
2598 visit_type_uint32(v
, name
, &value
, errp
);
2601 static void property_set_uint32_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2602 void *opaque
, Error
**errp
)
2604 uint32_t *field
= opaque
;
2607 if (!visit_type_uint32(v
, name
, &value
, errp
)) {
2614 static void property_get_uint64_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2615 void *opaque
, Error
**errp
)
2617 uint64_t value
= *(uint64_t *)opaque
;
2618 visit_type_uint64(v
, name
, &value
, errp
);
2621 static void property_set_uint64_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2622 void *opaque
, Error
**errp
)
2624 uint64_t *field
= opaque
;
2627 if (!visit_type_uint64(v
, name
, &value
, errp
)) {
2635 object_property_add_uint8_ptr(Object
*obj
, const char *name
,
2637 ObjectPropertyFlags flags
)
2639 ObjectPropertyAccessor
*getter
= NULL
;
2640 ObjectPropertyAccessor
*setter
= NULL
;
2642 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2643 getter
= property_get_uint8_ptr
;
2646 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2647 setter
= property_set_uint8_ptr
;
2650 return object_property_add(obj
, name
, "uint8",
2651 getter
, setter
, NULL
, (void *)v
);
2655 object_class_property_add_uint8_ptr(ObjectClass
*klass
, const char *name
,
2657 ObjectPropertyFlags flags
)
2659 ObjectPropertyAccessor
*getter
= NULL
;
2660 ObjectPropertyAccessor
*setter
= NULL
;
2662 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2663 getter
= property_get_uint8_ptr
;
2666 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2667 setter
= property_set_uint8_ptr
;
2670 return object_class_property_add(klass
, name
, "uint8",
2671 getter
, setter
, NULL
, (void *)v
);
2675 object_property_add_uint16_ptr(Object
*obj
, const char *name
,
2677 ObjectPropertyFlags flags
)
2679 ObjectPropertyAccessor
*getter
= NULL
;
2680 ObjectPropertyAccessor
*setter
= NULL
;
2682 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2683 getter
= property_get_uint16_ptr
;
2686 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2687 setter
= property_set_uint16_ptr
;
2690 return object_property_add(obj
, name
, "uint16",
2691 getter
, setter
, NULL
, (void *)v
);
2695 object_class_property_add_uint16_ptr(ObjectClass
*klass
, const char *name
,
2697 ObjectPropertyFlags flags
)
2699 ObjectPropertyAccessor
*getter
= NULL
;
2700 ObjectPropertyAccessor
*setter
= NULL
;
2702 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2703 getter
= property_get_uint16_ptr
;
2706 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2707 setter
= property_set_uint16_ptr
;
2710 return object_class_property_add(klass
, name
, "uint16",
2711 getter
, setter
, NULL
, (void *)v
);
2715 object_property_add_uint32_ptr(Object
*obj
, const char *name
,
2717 ObjectPropertyFlags flags
)
2719 ObjectPropertyAccessor
*getter
= NULL
;
2720 ObjectPropertyAccessor
*setter
= NULL
;
2722 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2723 getter
= property_get_uint32_ptr
;
2726 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2727 setter
= property_set_uint32_ptr
;
2730 return object_property_add(obj
, name
, "uint32",
2731 getter
, setter
, NULL
, (void *)v
);
2735 object_class_property_add_uint32_ptr(ObjectClass
*klass
, const char *name
,
2737 ObjectPropertyFlags flags
)
2739 ObjectPropertyAccessor
*getter
= NULL
;
2740 ObjectPropertyAccessor
*setter
= NULL
;
2742 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2743 getter
= property_get_uint32_ptr
;
2746 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2747 setter
= property_set_uint32_ptr
;
2750 return object_class_property_add(klass
, name
, "uint32",
2751 getter
, setter
, NULL
, (void *)v
);
2755 object_property_add_uint64_ptr(Object
*obj
, const char *name
,
2757 ObjectPropertyFlags flags
)
2759 ObjectPropertyAccessor
*getter
= NULL
;
2760 ObjectPropertyAccessor
*setter
= NULL
;
2762 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2763 getter
= property_get_uint64_ptr
;
2766 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2767 setter
= property_set_uint64_ptr
;
2770 return object_property_add(obj
, name
, "uint64",
2771 getter
, setter
, NULL
, (void *)v
);
2775 object_class_property_add_uint64_ptr(ObjectClass
*klass
, const char *name
,
2777 ObjectPropertyFlags flags
)
2779 ObjectPropertyAccessor
*getter
= NULL
;
2780 ObjectPropertyAccessor
*setter
= NULL
;
2782 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2783 getter
= property_get_uint64_ptr
;
2786 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2787 setter
= property_set_uint64_ptr
;
2790 return object_class_property_add(klass
, name
, "uint64",
2791 getter
, setter
, NULL
, (void *)v
);
2799 static void property_get_alias(Object
*obj
, Visitor
*v
, const char *name
,
2800 void *opaque
, Error
**errp
)
2802 AliasProperty
*prop
= opaque
;
2803 Visitor
*alias_v
= visitor_forward_field(v
, prop
->target_name
, name
);
2805 object_property_get(prop
->target_obj
, prop
->target_name
, alias_v
, errp
);
2806 visit_free(alias_v
);
2809 static void property_set_alias(Object
*obj
, Visitor
*v
, const char *name
,
2810 void *opaque
, Error
**errp
)
2812 AliasProperty
*prop
= opaque
;
2813 Visitor
*alias_v
= visitor_forward_field(v
, prop
->target_name
, name
);
2815 object_property_set(prop
->target_obj
, prop
->target_name
, alias_v
, errp
);
2816 visit_free(alias_v
);
2819 static Object
*property_resolve_alias(Object
*obj
, void *opaque
,
2822 AliasProperty
*prop
= opaque
;
2824 return object_resolve_path_component(prop
->target_obj
, prop
->target_name
);
2827 static void property_release_alias(Object
*obj
, const char *name
, void *opaque
)
2829 AliasProperty
*prop
= opaque
;
2831 g_free(prop
->target_name
);
2836 object_property_add_alias(Object
*obj
, const char *name
,
2837 Object
*target_obj
, const char *target_name
)
2839 AliasProperty
*prop
;
2841 ObjectProperty
*target_prop
;
2842 g_autofree
char *prop_type
= NULL
;
2844 target_prop
= object_property_find_err(target_obj
, target_name
,
2847 if (object_property_is_child(target_prop
)) {
2848 prop_type
= g_strdup_printf("link%s",
2849 target_prop
->type
+ strlen("child"));
2851 prop_type
= g_strdup(target_prop
->type
);
2854 prop
= g_malloc(sizeof(*prop
));
2855 prop
->target_obj
= target_obj
;
2856 prop
->target_name
= g_strdup(target_name
);
2858 op
= object_property_add(obj
, name
, prop_type
,
2861 property_release_alias
,
2863 op
->resolve
= property_resolve_alias
;
2864 if (target_prop
->defval
) {
2865 op
->defval
= qobject_ref(target_prop
->defval
);
2868 object_property_set_description(obj
, op
->name
,
2869 target_prop
->description
);
2873 void object_property_set_description(Object
*obj
, const char *name
,
2874 const char *description
)
2878 op
= object_property_find_err(obj
, name
, &error_abort
);
2879 g_free(op
->description
);
2880 op
->description
= g_strdup(description
);
2883 void object_class_property_set_description(ObjectClass
*klass
,
2885 const char *description
)
2889 op
= g_hash_table_lookup(klass
->properties
, name
);
2890 g_free(op
->description
);
2891 op
->description
= g_strdup(description
);
2894 static void object_class_init(ObjectClass
*klass
, void *data
)
2896 object_class_property_add_str(klass
, "type", object_get_type
,
2900 static void register_types(void)
2902 static const TypeInfo interface_info
= {
2903 .name
= TYPE_INTERFACE
,
2904 .class_size
= sizeof(InterfaceClass
),
2908 static const TypeInfo object_info
= {
2909 .name
= TYPE_OBJECT
,
2910 .instance_size
= sizeof(Object
),
2911 .class_init
= object_class_init
,
2915 type_interface
= type_register_internal(&interface_info
);
2916 type_register_internal(&object_info
);
2919 type_init(register_types
)