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/qerror.h"
27 #include "qapi/qmp/qjson.h"
30 /* TODO: replace QObject with a simpler visitor to avoid a dependency
31 * of the QOM core on QObject? */
32 #include "qom/qom-qobject.h"
33 #include "qapi/qmp/qbool.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 TypeImpl
*type_register_internal(const TypeInfo
*info
)
149 TypeImpl
*type_register(const TypeInfo
*info
)
151 assert(info
->parent
);
152 return type_register_internal(info
);
155 TypeImpl
*type_register_static(const TypeInfo
*info
)
157 return type_register(info
);
160 void type_register_static_array(const TypeInfo
*infos
, int nr_infos
)
164 for (i
= 0; i
< nr_infos
; i
++) {
165 type_register_static(&infos
[i
]);
169 static TypeImpl
*type_get_by_name(const char *name
)
175 return type_table_lookup(name
);
178 static TypeImpl
*type_get_parent(TypeImpl
*type
)
180 if (!type
->parent_type
&& type
->parent
) {
181 type
->parent_type
= type_get_by_name(type
->parent
);
182 if (!type
->parent_type
) {
183 fprintf(stderr
, "Type '%s' is missing its parent '%s'\n",
184 type
->name
, type
->parent
);
189 return type
->parent_type
;
192 static bool type_has_parent(TypeImpl
*type
)
194 return (type
->parent
!= NULL
);
197 static size_t type_class_get_size(TypeImpl
*ti
)
199 if (ti
->class_size
) {
200 return ti
->class_size
;
203 if (type_has_parent(ti
)) {
204 return type_class_get_size(type_get_parent(ti
));
207 return sizeof(ObjectClass
);
210 static size_t type_object_get_size(TypeImpl
*ti
)
212 if (ti
->instance_size
) {
213 return ti
->instance_size
;
216 if (type_has_parent(ti
)) {
217 return type_object_get_size(type_get_parent(ti
));
223 size_t object_type_get_instance_size(const char *typename
)
225 TypeImpl
*type
= type_get_by_name(typename
);
227 g_assert(type
!= NULL
);
228 return type_object_get_size(type
);
231 static bool type_is_ancestor(TypeImpl
*type
, TypeImpl
*target_type
)
235 /* Check if target_type is a direct ancestor of type */
237 if (type
== target_type
) {
241 type
= type_get_parent(type
);
247 static void type_initialize(TypeImpl
*ti
);
249 static void type_initialize_interface(TypeImpl
*ti
, TypeImpl
*interface_type
,
250 TypeImpl
*parent_type
)
252 InterfaceClass
*new_iface
;
254 TypeImpl
*iface_impl
;
256 info
.parent
= parent_type
->name
;
257 info
.name
= g_strdup_printf("%s::%s", ti
->name
, interface_type
->name
);
258 info
.abstract
= true;
260 iface_impl
= type_new(&info
);
261 iface_impl
->parent_type
= parent_type
;
262 type_initialize(iface_impl
);
263 g_free((char *)info
.name
);
265 new_iface
= (InterfaceClass
*)iface_impl
->class;
266 new_iface
->concrete_class
= ti
->class;
267 new_iface
->interface_type
= interface_type
;
269 ti
->class->interfaces
= g_slist_append(ti
->class->interfaces
, new_iface
);
272 static void object_property_free(gpointer data
)
274 ObjectProperty
*prop
= data
;
277 qobject_unref(prop
->defval
);
282 g_free(prop
->description
);
286 static void type_initialize(TypeImpl
*ti
)
294 ti
->class_size
= type_class_get_size(ti
);
295 ti
->instance_size
= type_object_get_size(ti
);
296 /* Any type with zero instance_size is implicitly abstract.
297 * This means interface types are all abstract.
299 if (ti
->instance_size
== 0) {
302 if (type_is_ancestor(ti
, type_interface
)) {
303 assert(ti
->instance_size
== 0);
304 assert(ti
->abstract
);
305 assert(!ti
->instance_init
);
306 assert(!ti
->instance_post_init
);
307 assert(!ti
->instance_finalize
);
308 assert(!ti
->num_interfaces
);
310 ti
->class = g_malloc0(ti
->class_size
);
312 parent
= type_get_parent(ti
);
314 type_initialize(parent
);
318 g_assert(parent
->class_size
<= ti
->class_size
);
319 g_assert(parent
->instance_size
<= ti
->instance_size
);
320 memcpy(ti
->class, parent
->class, parent
->class_size
);
321 ti
->class->interfaces
= NULL
;
323 for (e
= parent
->class->interfaces
; e
; e
= e
->next
) {
324 InterfaceClass
*iface
= e
->data
;
325 ObjectClass
*klass
= OBJECT_CLASS(iface
);
327 type_initialize_interface(ti
, iface
->interface_type
, klass
->type
);
330 for (i
= 0; i
< ti
->num_interfaces
; i
++) {
331 TypeImpl
*t
= type_get_by_name(ti
->interfaces
[i
].typename
);
333 error_report("missing interface '%s' for object '%s'",
334 ti
->interfaces
[i
].typename
, parent
->name
);
337 for (e
= ti
->class->interfaces
; e
; e
= e
->next
) {
338 TypeImpl
*target_type
= OBJECT_CLASS(e
->data
)->type
;
340 if (type_is_ancestor(target_type
, t
)) {
349 type_initialize_interface(ti
, t
, t
);
353 ti
->class->properties
= g_hash_table_new_full(g_str_hash
, g_str_equal
, NULL
,
354 object_property_free
);
356 ti
->class->type
= ti
;
359 if (parent
->class_base_init
) {
360 parent
->class_base_init(ti
->class, ti
->class_data
);
362 parent
= type_get_parent(parent
);
365 if (ti
->class_init
) {
366 ti
->class_init(ti
->class, ti
->class_data
);
370 static void object_init_with_type(Object
*obj
, TypeImpl
*ti
)
372 if (type_has_parent(ti
)) {
373 object_init_with_type(obj
, type_get_parent(ti
));
376 if (ti
->instance_init
) {
377 ti
->instance_init(obj
);
381 static void object_post_init_with_type(Object
*obj
, TypeImpl
*ti
)
383 if (ti
->instance_post_init
) {
384 ti
->instance_post_init(obj
);
387 if (type_has_parent(ti
)) {
388 object_post_init_with_type(obj
, type_get_parent(ti
));
392 bool object_apply_global_props(Object
*obj
, const GPtrArray
*props
,
401 for (i
= 0; i
< props
->len
; i
++) {
402 GlobalProperty
*p
= g_ptr_array_index(props
, i
);
405 if (object_dynamic_cast(obj
, p
->driver
) == NULL
) {
408 if (p
->optional
&& !object_property_find(obj
, p
->property
)) {
412 if (!object_property_parse(obj
, p
->property
, p
->value
, &err
)) {
413 error_prepend(&err
, "can't apply global %s.%s=%s: ",
414 p
->driver
, p
->property
, p
->value
);
416 * If errp != NULL, propagate error and return.
417 * If errp == NULL, report a warning, but keep going
418 * with the remaining globals.
421 error_propagate(errp
, err
);
424 warn_report_err(err
);
433 * Global property defaults
434 * Slot 0: accelerator's global property defaults
435 * Slot 1: machine's global property defaults
436 * Slot 2: global properties from legacy command line option
437 * Each is a GPtrArray of of GlobalProperty.
438 * Applied in order, later entries override earlier ones.
440 static GPtrArray
*object_compat_props
[3];
443 * Retrieve @GPtrArray for global property defined with options
444 * other than "-global". These are generally used for syntactic
445 * sugar and legacy command line options.
447 void object_register_sugar_prop(const char *driver
, const char *prop
,
448 const char *value
, bool optional
)
451 if (!object_compat_props
[2]) {
452 object_compat_props
[2] = g_ptr_array_new();
454 g
= g_new0(GlobalProperty
, 1);
455 g
->driver
= g_strdup(driver
);
456 g
->property
= g_strdup(prop
);
457 g
->value
= g_strdup(value
);
458 g
->optional
= optional
;
459 g_ptr_array_add(object_compat_props
[2], g
);
463 * Set machine's global property defaults to @compat_props.
464 * May be called at most once.
466 void object_set_machine_compat_props(GPtrArray
*compat_props
)
468 assert(!object_compat_props
[1]);
469 object_compat_props
[1] = compat_props
;
473 * Set accelerator's global property defaults to @compat_props.
474 * May be called at most once.
476 void object_set_accelerator_compat_props(GPtrArray
*compat_props
)
478 assert(!object_compat_props
[0]);
479 object_compat_props
[0] = compat_props
;
482 void object_apply_compat_props(Object
*obj
)
486 for (i
= 0; i
< ARRAY_SIZE(object_compat_props
); i
++) {
487 object_apply_global_props(obj
, object_compat_props
[i
],
488 i
== 2 ? &error_fatal
: &error_abort
);
492 static void object_class_property_init_all(Object
*obj
)
494 ObjectPropertyIterator iter
;
495 ObjectProperty
*prop
;
497 object_class_property_iter_init(&iter
, object_get_class(obj
));
498 while ((prop
= object_property_iter_next(&iter
))) {
500 prop
->init(obj
, prop
);
505 static void object_initialize_with_type(Object
*obj
, size_t size
, TypeImpl
*type
)
507 type_initialize(type
);
509 g_assert(type
->instance_size
>= sizeof(Object
));
510 g_assert(type
->abstract
== false);
511 g_assert(size
>= type
->instance_size
);
513 memset(obj
, 0, type
->instance_size
);
514 obj
->class = type
->class;
516 object_class_property_init_all(obj
);
517 obj
->properties
= g_hash_table_new_full(g_str_hash
, g_str_equal
,
518 NULL
, object_property_free
);
519 object_init_with_type(obj
, type
);
520 object_post_init_with_type(obj
, type
);
523 void object_initialize(void *data
, size_t size
, const char *typename
)
525 TypeImpl
*type
= type_get_by_name(typename
);
527 #ifdef CONFIG_MODULES
529 module_load_qom_one(typename
);
530 type
= type_get_by_name(typename
);
534 error_report("missing object type '%s'", typename
);
538 object_initialize_with_type(data
, size
, type
);
541 bool object_initialize_child_with_props(Object
*parentobj
,
542 const char *propname
,
543 void *childobj
, size_t size
,
550 va_start(vargs
, errp
);
551 ok
= object_initialize_child_with_propsv(parentobj
, propname
,
552 childobj
, size
, type
, errp
,
558 bool object_initialize_child_with_propsv(Object
*parentobj
,
559 const char *propname
,
560 void *childobj
, size_t size
,
562 Error
**errp
, va_list vargs
)
568 object_initialize(childobj
, size
, type
);
569 obj
= OBJECT(childobj
);
571 if (!object_set_propv(obj
, errp
, vargs
)) {
575 object_property_add_child(parentobj
, propname
, obj
);
577 uc
= (UserCreatable
*)object_dynamic_cast(obj
, TYPE_USER_CREATABLE
);
579 if (!user_creatable_complete(uc
, errp
)) {
580 object_unparent(obj
);
589 * We want @obj's reference to be 1 on success, 0 on failure.
590 * On success, it's 2: one taken by object_initialize(), and one
591 * by object_property_add_child().
592 * On failure in object_initialize() or earlier, it's 1.
593 * On failure afterwards, it's also 1: object_unparent() releases
594 * the reference taken by object_property_add_child().
600 void object_initialize_child_internal(Object
*parent
,
601 const char *propname
,
602 void *child
, size_t size
,
605 object_initialize_child_with_props(parent
, propname
, child
, size
, type
,
609 static inline bool object_property_is_child(ObjectProperty
*prop
)
611 return strstart(prop
->type
, "child<", NULL
);
614 static void object_property_del_all(Object
*obj
)
616 g_autoptr(GHashTable
) done
= g_hash_table_new(NULL
, NULL
);
617 ObjectProperty
*prop
;
618 ObjectPropertyIterator iter
;
623 object_property_iter_init(&iter
, obj
);
624 while ((prop
= object_property_iter_next(&iter
)) != NULL
) {
625 if (g_hash_table_add(done
, prop
)) {
627 prop
->release(obj
, prop
->name
, prop
->opaque
);
635 g_hash_table_unref(obj
->properties
);
638 static void object_property_del_child(Object
*obj
, Object
*child
)
640 ObjectProperty
*prop
;
644 g_hash_table_iter_init(&iter
, obj
->properties
);
645 while (g_hash_table_iter_next(&iter
, &key
, &value
)) {
647 if (object_property_is_child(prop
) && prop
->opaque
== child
) {
649 prop
->release(obj
, prop
->name
, prop
->opaque
);
650 prop
->release
= NULL
;
655 g_hash_table_iter_init(&iter
, obj
->properties
);
656 while (g_hash_table_iter_next(&iter
, &key
, &value
)) {
658 if (object_property_is_child(prop
) && prop
->opaque
== child
) {
659 g_hash_table_iter_remove(&iter
);
665 void object_unparent(Object
*obj
)
668 object_property_del_child(obj
->parent
, obj
);
672 static void object_deinit(Object
*obj
, TypeImpl
*type
)
674 if (type
->instance_finalize
) {
675 type
->instance_finalize(obj
);
678 if (type_has_parent(type
)) {
679 object_deinit(obj
, type_get_parent(type
));
683 static void object_finalize(void *data
)
686 TypeImpl
*ti
= obj
->class->type
;
688 object_property_del_all(obj
);
689 object_deinit(obj
, ti
);
691 g_assert(obj
->ref
== 0);
692 g_assert(obj
->parent
== NULL
);
698 /* Find the minimum alignment guaranteed by the system malloc. */
699 #if __STDC_VERSION__ >= 201112L
700 typedef max_align_t qemu_max_align_t
;
710 static Object
*object_new_with_type(Type type
)
714 void (*obj_free
)(void *);
716 g_assert(type
!= NULL
);
717 type_initialize(type
);
719 size
= type
->instance_size
;
720 align
= type
->instance_align
;
723 * Do not use qemu_memalign unless required. Depending on the
724 * implementation, extra alignment implies extra overhead.
726 if (likely(align
<= __alignof__(qemu_max_align_t
))) {
727 obj
= g_malloc(size
);
730 obj
= qemu_memalign(align
, size
);
731 obj_free
= qemu_vfree
;
734 object_initialize_with_type(obj
, size
, type
);
735 obj
->free
= obj_free
;
740 Object
*object_new_with_class(ObjectClass
*klass
)
742 return object_new_with_type(klass
->type
);
745 Object
*object_new(const char *typename
)
747 TypeImpl
*ti
= type_get_by_name(typename
);
749 return object_new_with_type(ti
);
753 Object
*object_new_with_props(const char *typename
,
762 va_start(vargs
, errp
);
763 obj
= object_new_with_propv(typename
, parent
, id
, errp
, vargs
);
770 Object
*object_new_with_propv(const char *typename
,
780 klass
= object_class_by_name(typename
);
782 error_setg(errp
, "invalid object type: %s", typename
);
786 if (object_class_is_abstract(klass
)) {
787 error_setg(errp
, "object type '%s' is abstract", typename
);
790 obj
= object_new_with_type(klass
->type
);
792 if (!object_set_propv(obj
, errp
, vargs
)) {
797 object_property_add_child(parent
, id
, obj
);
800 uc
= (UserCreatable
*)object_dynamic_cast(obj
, TYPE_USER_CREATABLE
);
802 if (!user_creatable_complete(uc
, errp
)) {
804 object_unparent(obj
);
819 bool object_set_props(Object
*obj
,
826 va_start(vargs
, errp
);
827 ret
= object_set_propv(obj
, errp
, vargs
);
834 bool object_set_propv(Object
*obj
,
838 const char *propname
;
840 propname
= va_arg(vargs
, char *);
841 while (propname
!= NULL
) {
842 const char *value
= va_arg(vargs
, char *);
844 g_assert(value
!= NULL
);
845 if (!object_property_parse(obj
, propname
, value
, errp
)) {
848 propname
= va_arg(vargs
, char *);
855 Object
*object_dynamic_cast(Object
*obj
, const char *typename
)
857 if (obj
&& object_class_dynamic_cast(object_get_class(obj
), typename
)) {
864 Object
*object_dynamic_cast_assert(Object
*obj
, const char *typename
,
865 const char *file
, int line
, const char *func
)
867 trace_object_dynamic_cast_assert(obj
? obj
->class->type
->name
: "(null)",
868 typename
, file
, line
, func
);
870 #ifdef CONFIG_QOM_CAST_DEBUG
874 for (i
= 0; obj
&& i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
875 if (qatomic_read(&obj
->class->object_cast_cache
[i
]) == typename
) {
880 inst
= object_dynamic_cast(obj
, typename
);
883 fprintf(stderr
, "%s:%d:%s: Object %p is not an instance of type %s\n",
884 file
, line
, func
, obj
, typename
);
890 if (obj
&& obj
== inst
) {
891 for (i
= 1; i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
892 qatomic_set(&obj
->class->object_cast_cache
[i
- 1],
893 qatomic_read(&obj
->class->object_cast_cache
[i
]));
895 qatomic_set(&obj
->class->object_cast_cache
[i
- 1], typename
);
903 ObjectClass
*object_class_dynamic_cast(ObjectClass
*class,
904 const char *typename
)
906 ObjectClass
*ret
= NULL
;
907 TypeImpl
*target_type
;
914 /* A simple fast path that can trigger a lot for leaf classes. */
916 if (type
->name
== typename
) {
920 target_type
= type_get_by_name(typename
);
922 /* target class type unknown, so fail the cast */
926 if (type
->class->interfaces
&&
927 type_is_ancestor(target_type
, type_interface
)) {
931 for (i
= class->interfaces
; i
; i
= i
->next
) {
932 ObjectClass
*target_class
= i
->data
;
934 if (type_is_ancestor(target_class
->type
, target_type
)) {
940 /* The match was ambiguous, don't allow a cast */
944 } else if (type_is_ancestor(type
, target_type
)) {
951 ObjectClass
*object_class_dynamic_cast_assert(ObjectClass
*class,
952 const char *typename
,
953 const char *file
, int line
,
958 trace_object_class_dynamic_cast_assert(class ? class->type
->name
: "(null)",
959 typename
, file
, line
, func
);
961 #ifdef CONFIG_QOM_CAST_DEBUG
964 for (i
= 0; class && i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
965 if (qatomic_read(&class->class_cast_cache
[i
]) == typename
) {
971 if (!class || !class->interfaces
) {
976 ret
= object_class_dynamic_cast(class, typename
);
978 fprintf(stderr
, "%s:%d:%s: Object %p is not an instance of type %s\n",
979 file
, line
, func
, class, typename
);
983 #ifdef CONFIG_QOM_CAST_DEBUG
984 if (class && ret
== class) {
985 for (i
= 1; i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
986 qatomic_set(&class->class_cast_cache
[i
- 1],
987 qatomic_read(&class->class_cast_cache
[i
]));
989 qatomic_set(&class->class_cast_cache
[i
- 1], typename
);
996 const char *object_get_typename(const Object
*obj
)
998 return obj
->class->type
->name
;
1001 ObjectClass
*object_get_class(Object
*obj
)
1006 bool object_class_is_abstract(ObjectClass
*klass
)
1008 return klass
->type
->abstract
;
1011 const char *object_class_get_name(ObjectClass
*klass
)
1013 return klass
->type
->name
;
1016 ObjectClass
*object_class_by_name(const char *typename
)
1018 TypeImpl
*type
= type_get_by_name(typename
);
1024 type_initialize(type
);
1029 ObjectClass
*module_object_class_by_name(const char *typename
)
1033 oc
= object_class_by_name(typename
);
1034 #ifdef CONFIG_MODULES
1036 module_load_qom_one(typename
);
1037 oc
= object_class_by_name(typename
);
1043 ObjectClass
*object_class_get_parent(ObjectClass
*class)
1045 TypeImpl
*type
= type_get_parent(class->type
);
1051 type_initialize(type
);
1056 typedef struct OCFData
1058 void (*fn
)(ObjectClass
*klass
, void *opaque
);
1059 const char *implements_type
;
1060 bool include_abstract
;
1064 static void object_class_foreach_tramp(gpointer key
, gpointer value
,
1067 OCFData
*data
= opaque
;
1068 TypeImpl
*type
= value
;
1071 type_initialize(type
);
1074 if (!data
->include_abstract
&& type
->abstract
) {
1078 if (data
->implements_type
&&
1079 !object_class_dynamic_cast(k
, data
->implements_type
)) {
1083 data
->fn(k
, data
->opaque
);
1086 void object_class_foreach(void (*fn
)(ObjectClass
*klass
, void *opaque
),
1087 const char *implements_type
, bool include_abstract
,
1090 OCFData data
= { fn
, implements_type
, include_abstract
, opaque
};
1092 enumerating_types
= true;
1093 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp
, &data
);
1094 enumerating_types
= false;
1097 static int do_object_child_foreach(Object
*obj
,
1098 int (*fn
)(Object
*child
, void *opaque
),
1099 void *opaque
, bool recurse
)
1101 GHashTableIter iter
;
1102 ObjectProperty
*prop
;
1105 g_hash_table_iter_init(&iter
, obj
->properties
);
1106 while (g_hash_table_iter_next(&iter
, NULL
, (gpointer
*)&prop
)) {
1107 if (object_property_is_child(prop
)) {
1108 Object
*child
= prop
->opaque
;
1110 ret
= fn(child
, opaque
);
1115 ret
= do_object_child_foreach(child
, fn
, opaque
, true);
1125 int object_child_foreach(Object
*obj
, int (*fn
)(Object
*child
, void *opaque
),
1128 return do_object_child_foreach(obj
, fn
, opaque
, false);
1131 int object_child_foreach_recursive(Object
*obj
,
1132 int (*fn
)(Object
*child
, void *opaque
),
1135 return do_object_child_foreach(obj
, fn
, opaque
, true);
1138 static void object_class_get_list_tramp(ObjectClass
*klass
, void *opaque
)
1140 GSList
**list
= opaque
;
1142 *list
= g_slist_prepend(*list
, klass
);
1145 GSList
*object_class_get_list(const char *implements_type
,
1146 bool include_abstract
)
1148 GSList
*list
= NULL
;
1150 object_class_foreach(object_class_get_list_tramp
,
1151 implements_type
, include_abstract
, &list
);
1155 static gint
object_class_cmp(gconstpointer a
, gconstpointer b
)
1157 return strcasecmp(object_class_get_name((ObjectClass
*)a
),
1158 object_class_get_name((ObjectClass
*)b
));
1161 GSList
*object_class_get_list_sorted(const char *implements_type
,
1162 bool include_abstract
)
1164 return g_slist_sort(object_class_get_list(implements_type
, include_abstract
),
1168 Object
*object_ref(void *objptr
)
1170 Object
*obj
= OBJECT(objptr
);
1174 qatomic_inc(&obj
->ref
);
1178 void object_unref(void *objptr
)
1180 Object
*obj
= OBJECT(objptr
);
1184 g_assert(obj
->ref
> 0);
1186 /* parent always holds a reference to its children */
1187 if (qatomic_fetch_dec(&obj
->ref
) == 1) {
1188 object_finalize(obj
);
1193 object_property_try_add(Object
*obj
, const char *name
, const char *type
,
1194 ObjectPropertyAccessor
*get
,
1195 ObjectPropertyAccessor
*set
,
1196 ObjectPropertyRelease
*release
,
1197 void *opaque
, Error
**errp
)
1199 ObjectProperty
*prop
;
1200 size_t name_len
= strlen(name
);
1202 if (name_len
>= 3 && !memcmp(name
+ name_len
- 3, "[*]", 4)) {
1204 ObjectProperty
*ret
= NULL
;
1205 char *name_no_array
= g_strdup(name
);
1207 name_no_array
[name_len
- 3] = '\0';
1208 for (i
= 0; i
< INT16_MAX
; ++i
) {
1209 char *full_name
= g_strdup_printf("%s[%d]", name_no_array
, i
);
1211 ret
= object_property_try_add(obj
, full_name
, type
, get
, set
,
1212 release
, opaque
, NULL
);
1218 g_free(name_no_array
);
1223 if (object_property_find(obj
, name
) != NULL
) {
1224 error_setg(errp
, "attempt to add duplicate property '%s' to object (type '%s')",
1225 name
, object_get_typename(obj
));
1229 prop
= g_malloc0(sizeof(*prop
));
1231 prop
->name
= g_strdup(name
);
1232 prop
->type
= g_strdup(type
);
1236 prop
->release
= release
;
1237 prop
->opaque
= opaque
;
1239 g_hash_table_insert(obj
->properties
, prop
->name
, prop
);
1244 object_property_add(Object
*obj
, const char *name
, const char *type
,
1245 ObjectPropertyAccessor
*get
,
1246 ObjectPropertyAccessor
*set
,
1247 ObjectPropertyRelease
*release
,
1250 return object_property_try_add(obj
, name
, type
, get
, set
, release
,
1251 opaque
, &error_abort
);
1255 object_class_property_add(ObjectClass
*klass
,
1258 ObjectPropertyAccessor
*get
,
1259 ObjectPropertyAccessor
*set
,
1260 ObjectPropertyRelease
*release
,
1263 ObjectProperty
*prop
;
1265 assert(!object_class_property_find(klass
, name
));
1267 prop
= g_malloc0(sizeof(*prop
));
1269 prop
->name
= g_strdup(name
);
1270 prop
->type
= g_strdup(type
);
1274 prop
->release
= release
;
1275 prop
->opaque
= opaque
;
1277 g_hash_table_insert(klass
->properties
, prop
->name
, prop
);
1282 ObjectProperty
*object_property_find(Object
*obj
, const char *name
)
1284 ObjectProperty
*prop
;
1285 ObjectClass
*klass
= object_get_class(obj
);
1287 prop
= object_class_property_find(klass
, name
);
1292 return g_hash_table_lookup(obj
->properties
, name
);
1295 ObjectProperty
*object_property_find_err(Object
*obj
, const char *name
,
1298 ObjectProperty
*prop
= object_property_find(obj
, name
);
1300 error_setg(errp
, "Property '%s.%s' not found",
1301 object_get_typename(obj
), name
);
1306 void object_property_iter_init(ObjectPropertyIterator
*iter
,
1309 g_hash_table_iter_init(&iter
->iter
, obj
->properties
);
1310 iter
->nextclass
= object_get_class(obj
);
1313 ObjectProperty
*object_property_iter_next(ObjectPropertyIterator
*iter
)
1316 while (!g_hash_table_iter_next(&iter
->iter
, &key
, &val
)) {
1317 if (!iter
->nextclass
) {
1320 g_hash_table_iter_init(&iter
->iter
, iter
->nextclass
->properties
);
1321 iter
->nextclass
= object_class_get_parent(iter
->nextclass
);
1326 void object_class_property_iter_init(ObjectPropertyIterator
*iter
,
1329 g_hash_table_iter_init(&iter
->iter
, klass
->properties
);
1330 iter
->nextclass
= object_class_get_parent(klass
);
1333 ObjectProperty
*object_class_property_find(ObjectClass
*klass
, const char *name
)
1335 ObjectClass
*parent_klass
;
1337 parent_klass
= object_class_get_parent(klass
);
1339 ObjectProperty
*prop
=
1340 object_class_property_find(parent_klass
, name
);
1346 return g_hash_table_lookup(klass
->properties
, name
);
1349 ObjectProperty
*object_class_property_find_err(ObjectClass
*klass
,
1353 ObjectProperty
*prop
= object_class_property_find(klass
, name
);
1355 error_setg(errp
, "Property '.%s' not found", name
);
1361 void object_property_del(Object
*obj
, const char *name
)
1363 ObjectProperty
*prop
= g_hash_table_lookup(obj
->properties
, name
);
1365 if (prop
->release
) {
1366 prop
->release(obj
, name
, prop
->opaque
);
1368 g_hash_table_remove(obj
->properties
, name
);
1371 bool object_property_get(Object
*obj
, const char *name
, Visitor
*v
,
1375 ObjectProperty
*prop
= object_property_find_err(obj
, name
, errp
);
1382 error_setg(errp
, QERR_PERMISSION_DENIED
);
1385 prop
->get(obj
, v
, name
, prop
->opaque
, &err
);
1386 error_propagate(errp
, err
);
1390 bool object_property_set(Object
*obj
, const char *name
, Visitor
*v
,
1394 ObjectProperty
*prop
= object_property_find_err(obj
, name
, errp
);
1401 error_setg(errp
, QERR_PERMISSION_DENIED
);
1404 prop
->set(obj
, v
, name
, prop
->opaque
, errp
);
1408 bool object_property_set_str(Object
*obj
, const char *name
,
1409 const char *value
, Error
**errp
)
1411 QString
*qstr
= qstring_from_str(value
);
1412 bool ok
= object_property_set_qobject(obj
, name
, QOBJECT(qstr
), errp
);
1414 qobject_unref(qstr
);
1418 char *object_property_get_str(Object
*obj
, const char *name
,
1421 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1428 qstring
= qobject_to(QString
, ret
);
1430 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
, "string");
1433 retval
= g_strdup(qstring_get_str(qstring
));
1440 bool object_property_set_link(Object
*obj
, const char *name
,
1441 Object
*value
, Error
**errp
)
1443 g_autofree
char *path
= NULL
;
1446 path
= object_get_canonical_path(value
);
1448 return object_property_set_str(obj
, name
, path
?: "", errp
);
1451 Object
*object_property_get_link(Object
*obj
, const char *name
,
1454 char *str
= object_property_get_str(obj
, name
, errp
);
1455 Object
*target
= NULL
;
1458 target
= object_resolve_path(str
, NULL
);
1460 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1461 "Device '%s' not found", str
);
1469 bool object_property_set_bool(Object
*obj
, const char *name
,
1470 bool value
, Error
**errp
)
1472 QBool
*qbool
= qbool_from_bool(value
);
1473 bool ok
= object_property_set_qobject(obj
, name
, QOBJECT(qbool
), errp
);
1475 qobject_unref(qbool
);
1479 bool object_property_get_bool(Object
*obj
, const char *name
,
1482 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1489 qbool
= qobject_to(QBool
, ret
);
1491 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
, "boolean");
1494 retval
= qbool_get_bool(qbool
);
1501 bool object_property_set_int(Object
*obj
, const char *name
,
1502 int64_t value
, Error
**errp
)
1504 QNum
*qnum
= qnum_from_int(value
);
1505 bool ok
= object_property_set_qobject(obj
, name
, QOBJECT(qnum
), errp
);
1507 qobject_unref(qnum
);
1511 int64_t object_property_get_int(Object
*obj
, const char *name
,
1514 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1522 qnum
= qobject_to(QNum
, ret
);
1523 if (!qnum
|| !qnum_get_try_int(qnum
, &retval
)) {
1524 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
, "int");
1532 static void object_property_init_defval(Object
*obj
, ObjectProperty
*prop
)
1534 Visitor
*v
= qobject_input_visitor_new(prop
->defval
);
1536 assert(prop
->set
!= NULL
);
1537 prop
->set(obj
, v
, prop
->name
, prop
->opaque
, &error_abort
);
1542 static void object_property_set_default(ObjectProperty
*prop
, QObject
*defval
)
1544 assert(!prop
->defval
);
1545 assert(!prop
->init
);
1547 prop
->defval
= defval
;
1548 prop
->init
= object_property_init_defval
;
1551 void object_property_set_default_bool(ObjectProperty
*prop
, bool value
)
1553 object_property_set_default(prop
, QOBJECT(qbool_from_bool(value
)));
1556 void object_property_set_default_str(ObjectProperty
*prop
, const char *value
)
1558 object_property_set_default(prop
, QOBJECT(qstring_from_str(value
)));
1561 void object_property_set_default_int(ObjectProperty
*prop
, int64_t value
)
1563 object_property_set_default(prop
, QOBJECT(qnum_from_int(value
)));
1566 void object_property_set_default_uint(ObjectProperty
*prop
, uint64_t value
)
1568 object_property_set_default(prop
, QOBJECT(qnum_from_uint(value
)));
1571 bool object_property_set_uint(Object
*obj
, const char *name
,
1572 uint64_t value
, Error
**errp
)
1574 QNum
*qnum
= qnum_from_uint(value
);
1575 bool ok
= object_property_set_qobject(obj
, name
, QOBJECT(qnum
), errp
);
1577 qobject_unref(qnum
);
1581 uint64_t object_property_get_uint(Object
*obj
, const char *name
,
1584 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1591 qnum
= qobject_to(QNum
, ret
);
1592 if (!qnum
|| !qnum_get_try_uint(qnum
, &retval
)) {
1593 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
, "uint");
1601 typedef struct EnumProperty
{
1602 const QEnumLookup
*lookup
;
1603 int (*get
)(Object
*, Error
**);
1604 void (*set
)(Object
*, int, Error
**);
1607 int object_property_get_enum(Object
*obj
, const char *name
,
1608 const char *typename
, Error
**errp
)
1612 ObjectProperty
*prop
= object_property_find_err(obj
, name
, errp
);
1613 EnumProperty
*enumprop
;
1619 if (!g_str_equal(prop
->type
, typename
)) {
1620 error_setg(errp
, "Property %s on %s is not '%s' enum type",
1621 name
, object_class_get_name(
1622 object_get_class(obj
)), typename
);
1626 enumprop
= prop
->opaque
;
1628 str
= object_property_get_str(obj
, name
, errp
);
1633 ret
= qapi_enum_parse(enumprop
->lookup
, str
, -1, errp
);
1639 bool object_property_parse(Object
*obj
, const char *name
,
1640 const char *string
, Error
**errp
)
1642 Visitor
*v
= string_input_visitor_new(string
);
1643 bool ok
= object_property_set(obj
, name
, v
, errp
);
1649 char *object_property_print(Object
*obj
, const char *name
, bool human
,
1653 char *string
= NULL
;
1655 v
= string_output_visitor_new(human
, &string
);
1656 if (!object_property_get(obj
, name
, v
, errp
)) {
1660 visit_complete(v
, &string
);
1667 const char *object_property_get_type(Object
*obj
, const char *name
, Error
**errp
)
1669 ObjectProperty
*prop
= object_property_find_err(obj
, name
, errp
);
1677 Object
*object_get_root(void)
1679 static Object
*root
;
1682 root
= object_new("container");
1688 Object
*object_get_objects_root(void)
1690 return container_get(object_get_root(), "/objects");
1693 Object
*object_get_internal_root(void)
1695 static Object
*internal_root
;
1697 if (!internal_root
) {
1698 internal_root
= object_new("container");
1701 return internal_root
;
1704 static void object_get_child_property(Object
*obj
, Visitor
*v
,
1705 const char *name
, void *opaque
,
1708 Object
*child
= opaque
;
1711 path
= object_get_canonical_path(child
);
1712 visit_type_str(v
, name
, &path
, errp
);
1716 static Object
*object_resolve_child_property(Object
*parent
, void *opaque
,
1722 static void object_finalize_child_property(Object
*obj
, const char *name
,
1725 Object
*child
= opaque
;
1727 if (child
->class->unparent
) {
1728 (child
->class->unparent
)(child
);
1730 child
->parent
= NULL
;
1731 object_unref(child
);
1735 object_property_try_add_child(Object
*obj
, const char *name
,
1736 Object
*child
, Error
**errp
)
1738 g_autofree
char *type
= NULL
;
1741 assert(!child
->parent
);
1743 type
= g_strdup_printf("child<%s>", object_get_typename(child
));
1745 op
= object_property_try_add(obj
, name
, type
, object_get_child_property
,
1746 NULL
, object_finalize_child_property
,
1751 op
->resolve
= object_resolve_child_property
;
1753 child
->parent
= obj
;
1758 object_property_add_child(Object
*obj
, const char *name
,
1761 return object_property_try_add_child(obj
, name
, child
, &error_abort
);
1764 void object_property_allow_set_link(const Object
*obj
, const char *name
,
1765 Object
*val
, Error
**errp
)
1767 /* Allow the link to be set, always */
1773 Object
*target
; /* if OBJ_PROP_LINK_DIRECT, when holding the pointer */
1774 ptrdiff_t offset
; /* if OBJ_PROP_LINK_CLASS */
1776 void (*check
)(const Object
*, const char *, Object
*, Error
**);
1777 ObjectPropertyLinkFlags flags
;
1781 object_link_get_targetp(Object
*obj
, LinkProperty
*lprop
)
1783 if (lprop
->flags
& OBJ_PROP_LINK_DIRECT
) {
1784 return &lprop
->target
;
1785 } else if (lprop
->flags
& OBJ_PROP_LINK_CLASS
) {
1786 return (void *)obj
+ lprop
->offset
;
1788 return lprop
->targetp
;
1792 static void object_get_link_property(Object
*obj
, Visitor
*v
,
1793 const char *name
, void *opaque
,
1796 LinkProperty
*lprop
= opaque
;
1797 Object
**targetp
= object_link_get_targetp(obj
, lprop
);
1801 path
= object_get_canonical_path(*targetp
);
1802 visit_type_str(v
, name
, &path
, errp
);
1806 visit_type_str(v
, name
, &path
, errp
);
1811 * object_resolve_link:
1813 * Lookup an object and ensure its type matches the link property type. This
1814 * is similar to object_resolve_path() except type verification against the
1815 * link property is performed.
1817 * Returns: The matched object or NULL on path lookup failures.
1819 static Object
*object_resolve_link(Object
*obj
, const char *name
,
1820 const char *path
, Error
**errp
)
1824 bool ambiguous
= false;
1827 /* Go from link<FOO> to FOO. */
1828 type
= object_property_get_type(obj
, name
, NULL
);
1829 target_type
= g_strndup(&type
[5], strlen(type
) - 6);
1830 target
= object_resolve_path_type(path
, target_type
, &ambiguous
);
1833 error_setg(errp
, "Path '%s' does not uniquely identify an object",
1835 } else if (!target
) {
1836 target
= object_resolve_path(path
, &ambiguous
);
1837 if (target
|| ambiguous
) {
1838 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
, target_type
);
1840 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1841 "Device '%s' not found", path
);
1845 g_free(target_type
);
1850 static void object_set_link_property(Object
*obj
, Visitor
*v
,
1851 const char *name
, void *opaque
,
1854 Error
*local_err
= NULL
;
1855 LinkProperty
*prop
= opaque
;
1856 Object
**targetp
= object_link_get_targetp(obj
, prop
);
1857 Object
*old_target
= *targetp
;
1861 if (!visit_type_str(v
, name
, &path
, errp
)) {
1866 new_target
= object_resolve_link(obj
, name
, path
, errp
);
1877 prop
->check(obj
, name
, new_target
, &local_err
);
1879 error_propagate(errp
, local_err
);
1883 *targetp
= new_target
;
1884 if (prop
->flags
& OBJ_PROP_LINK_STRONG
) {
1885 object_ref(new_target
);
1886 object_unref(old_target
);
1890 static Object
*object_resolve_link_property(Object
*parent
, void *opaque
,
1893 LinkProperty
*lprop
= opaque
;
1895 return *object_link_get_targetp(parent
, lprop
);
1898 static void object_release_link_property(Object
*obj
, const char *name
,
1901 LinkProperty
*prop
= opaque
;
1902 Object
**targetp
= object_link_get_targetp(obj
, prop
);
1904 if ((prop
->flags
& OBJ_PROP_LINK_STRONG
) && *targetp
) {
1905 object_unref(*targetp
);
1907 if (!(prop
->flags
& OBJ_PROP_LINK_CLASS
)) {
1912 static ObjectProperty
*
1913 object_add_link_prop(Object
*obj
, const char *name
,
1914 const char *type
, void *ptr
,
1915 void (*check
)(const Object
*, const char *,
1916 Object
*, Error
**),
1917 ObjectPropertyLinkFlags flags
)
1919 LinkProperty
*prop
= g_malloc(sizeof(*prop
));
1920 g_autofree
char *full_type
= NULL
;
1923 if (flags
& OBJ_PROP_LINK_DIRECT
) {
1926 prop
->targetp
= ptr
;
1928 prop
->check
= check
;
1929 prop
->flags
= flags
;
1931 full_type
= g_strdup_printf("link<%s>", type
);
1933 op
= object_property_add(obj
, name
, full_type
,
1934 object_get_link_property
,
1935 check
? object_set_link_property
: NULL
,
1936 object_release_link_property
,
1938 op
->resolve
= object_resolve_link_property
;
1943 object_property_add_link(Object
*obj
, const char *name
,
1944 const char *type
, Object
**targetp
,
1945 void (*check
)(const Object
*, const char *,
1946 Object
*, Error
**),
1947 ObjectPropertyLinkFlags flags
)
1949 return object_add_link_prop(obj
, name
, type
, targetp
, check
, flags
);
1953 object_class_property_add_link(ObjectClass
*oc
,
1955 const char *type
, ptrdiff_t offset
,
1956 void (*check
)(const Object
*obj
, const char *name
,
1957 Object
*val
, Error
**errp
),
1958 ObjectPropertyLinkFlags flags
)
1960 LinkProperty
*prop
= g_new0(LinkProperty
, 1);
1964 prop
->offset
= offset
;
1965 prop
->check
= check
;
1966 prop
->flags
= flags
| OBJ_PROP_LINK_CLASS
;
1968 full_type
= g_strdup_printf("link<%s>", type
);
1970 op
= object_class_property_add(oc
, name
, full_type
,
1971 object_get_link_property
,
1972 check
? object_set_link_property
: NULL
,
1973 object_release_link_property
,
1976 op
->resolve
= object_resolve_link_property
;
1983 object_property_add_const_link(Object
*obj
, const char *name
,
1986 return object_add_link_prop(obj
, name
,
1987 object_get_typename(target
), target
,
1988 NULL
, OBJ_PROP_LINK_DIRECT
);
1991 const char *object_get_canonical_path_component(const Object
*obj
)
1993 ObjectProperty
*prop
= NULL
;
1994 GHashTableIter iter
;
1996 if (obj
->parent
== NULL
) {
2000 g_hash_table_iter_init(&iter
, obj
->parent
->properties
);
2001 while (g_hash_table_iter_next(&iter
, NULL
, (gpointer
*)&prop
)) {
2002 if (!object_property_is_child(prop
)) {
2006 if (prop
->opaque
== obj
) {
2011 /* obj had a parent but was not a child, should never happen */
2012 g_assert_not_reached();
2016 char *object_get_canonical_path(const Object
*obj
)
2018 Object
*root
= object_get_root();
2019 char *newpath
, *path
= NULL
;
2022 return g_strdup("/");
2026 const char *component
= object_get_canonical_path_component(obj
);
2029 /* A canonical path must be complete, so discard what was
2036 newpath
= g_strdup_printf("/%s%s", component
, path
? path
: "");
2040 } while (obj
!= root
);
2045 Object
*object_resolve_path_component(Object
*parent
, const char *part
)
2047 ObjectProperty
*prop
= object_property_find(parent
, part
);
2052 if (prop
->resolve
) {
2053 return prop
->resolve(parent
, prop
->opaque
, part
);
2059 static Object
*object_resolve_abs_path(Object
*parent
,
2061 const char *typename
)
2065 if (*parts
== NULL
) {
2066 return object_dynamic_cast(parent
, typename
);
2069 if (strcmp(*parts
, "") == 0) {
2070 return object_resolve_abs_path(parent
, parts
+ 1, typename
);
2073 child
= object_resolve_path_component(parent
, *parts
);
2078 return object_resolve_abs_path(child
, parts
+ 1, typename
);
2081 static Object
*object_resolve_partial_path(Object
*parent
,
2083 const char *typename
,
2087 GHashTableIter iter
;
2088 ObjectProperty
*prop
;
2090 obj
= object_resolve_abs_path(parent
, parts
, typename
);
2092 g_hash_table_iter_init(&iter
, parent
->properties
);
2093 while (g_hash_table_iter_next(&iter
, NULL
, (gpointer
*)&prop
)) {
2096 if (!object_property_is_child(prop
)) {
2100 found
= object_resolve_partial_path(prop
->opaque
, parts
,
2101 typename
, ambiguous
);
2118 Object
*object_resolve_path_type(const char *path
, const char *typename
,
2124 parts
= g_strsplit(path
, "/", 0);
2127 if (parts
[0] == NULL
|| strcmp(parts
[0], "") != 0) {
2128 bool ambiguous
= false;
2129 obj
= object_resolve_partial_path(object_get_root(), parts
,
2130 typename
, &ambiguous
);
2132 *ambiguousp
= ambiguous
;
2135 obj
= object_resolve_abs_path(object_get_root(), parts
+ 1, typename
);
2143 Object
*object_resolve_path(const char *path
, bool *ambiguous
)
2145 return object_resolve_path_type(path
, TYPE_OBJECT
, ambiguous
);
2148 Object
*object_resolve_path_at(Object
*parent
, const char *path
)
2150 g_auto(GStrv
) parts
= g_strsplit(path
, "/", 0);
2153 return object_resolve_abs_path(object_get_root(), parts
+ 1,
2156 return object_resolve_abs_path(parent
, parts
, TYPE_OBJECT
);
2159 typedef struct StringProperty
2161 char *(*get
)(Object
*, Error
**);
2162 void (*set
)(Object
*, const char *, Error
**);
2165 static void property_get_str(Object
*obj
, Visitor
*v
, const char *name
,
2166 void *opaque
, Error
**errp
)
2168 StringProperty
*prop
= opaque
;
2172 value
= prop
->get(obj
, &err
);
2174 error_propagate(errp
, err
);
2178 visit_type_str(v
, name
, &value
, errp
);
2182 static void property_set_str(Object
*obj
, Visitor
*v
, const char *name
,
2183 void *opaque
, Error
**errp
)
2185 StringProperty
*prop
= opaque
;
2188 if (!visit_type_str(v
, name
, &value
, errp
)) {
2192 prop
->set(obj
, value
, errp
);
2196 static void property_release_data(Object
*obj
, const char *name
,
2203 object_property_add_str(Object
*obj
, const char *name
,
2204 char *(*get
)(Object
*, Error
**),
2205 void (*set
)(Object
*, const char *, Error
**))
2207 StringProperty
*prop
= g_malloc0(sizeof(*prop
));
2212 return object_property_add(obj
, name
, "string",
2213 get
? property_get_str
: NULL
,
2214 set
? property_set_str
: NULL
,
2215 property_release_data
,
2220 object_class_property_add_str(ObjectClass
*klass
, const char *name
,
2221 char *(*get
)(Object
*, Error
**),
2222 void (*set
)(Object
*, const char *,
2225 StringProperty
*prop
= g_malloc0(sizeof(*prop
));
2230 return object_class_property_add(klass
, name
, "string",
2231 get
? property_get_str
: NULL
,
2232 set
? property_set_str
: NULL
,
2237 typedef struct BoolProperty
2239 bool (*get
)(Object
*, Error
**);
2240 void (*set
)(Object
*, bool, Error
**);
2243 static void property_get_bool(Object
*obj
, Visitor
*v
, const char *name
,
2244 void *opaque
, Error
**errp
)
2246 BoolProperty
*prop
= opaque
;
2250 value
= prop
->get(obj
, &err
);
2252 error_propagate(errp
, err
);
2256 visit_type_bool(v
, name
, &value
, errp
);
2259 static void property_set_bool(Object
*obj
, Visitor
*v
, const char *name
,
2260 void *opaque
, Error
**errp
)
2262 BoolProperty
*prop
= opaque
;
2265 if (!visit_type_bool(v
, name
, &value
, errp
)) {
2269 prop
->set(obj
, value
, errp
);
2273 object_property_add_bool(Object
*obj
, const char *name
,
2274 bool (*get
)(Object
*, Error
**),
2275 void (*set
)(Object
*, bool, Error
**))
2277 BoolProperty
*prop
= g_malloc0(sizeof(*prop
));
2282 return object_property_add(obj
, name
, "bool",
2283 get
? property_get_bool
: NULL
,
2284 set
? property_set_bool
: NULL
,
2285 property_release_data
,
2290 object_class_property_add_bool(ObjectClass
*klass
, const char *name
,
2291 bool (*get
)(Object
*, Error
**),
2292 void (*set
)(Object
*, bool, Error
**))
2294 BoolProperty
*prop
= g_malloc0(sizeof(*prop
));
2299 return object_class_property_add(klass
, name
, "bool",
2300 get
? property_get_bool
: NULL
,
2301 set
? property_set_bool
: NULL
,
2306 static void property_get_enum(Object
*obj
, Visitor
*v
, const char *name
,
2307 void *opaque
, Error
**errp
)
2309 EnumProperty
*prop
= opaque
;
2313 value
= prop
->get(obj
, &err
);
2315 error_propagate(errp
, err
);
2319 visit_type_enum(v
, name
, &value
, prop
->lookup
, errp
);
2322 static void property_set_enum(Object
*obj
, Visitor
*v
, const char *name
,
2323 void *opaque
, Error
**errp
)
2325 EnumProperty
*prop
= opaque
;
2328 if (!visit_type_enum(v
, name
, &value
, prop
->lookup
, errp
)) {
2331 prop
->set(obj
, value
, errp
);
2335 object_property_add_enum(Object
*obj
, const char *name
,
2336 const char *typename
,
2337 const QEnumLookup
*lookup
,
2338 int (*get
)(Object
*, Error
**),
2339 void (*set
)(Object
*, int, Error
**))
2341 EnumProperty
*prop
= g_malloc(sizeof(*prop
));
2343 prop
->lookup
= lookup
;
2347 return object_property_add(obj
, name
, typename
,
2348 get
? property_get_enum
: NULL
,
2349 set
? property_set_enum
: NULL
,
2350 property_release_data
,
2355 object_class_property_add_enum(ObjectClass
*klass
, const char *name
,
2356 const char *typename
,
2357 const QEnumLookup
*lookup
,
2358 int (*get
)(Object
*, Error
**),
2359 void (*set
)(Object
*, int, Error
**))
2361 EnumProperty
*prop
= g_malloc(sizeof(*prop
));
2363 prop
->lookup
= lookup
;
2367 return object_class_property_add(klass
, name
, typename
,
2368 get
? property_get_enum
: NULL
,
2369 set
? property_set_enum
: NULL
,
2374 typedef struct TMProperty
{
2375 void (*get
)(Object
*, struct tm
*, Error
**);
2378 static void property_get_tm(Object
*obj
, Visitor
*v
, const char *name
,
2379 void *opaque
, Error
**errp
)
2381 TMProperty
*prop
= opaque
;
2385 prop
->get(obj
, &value
, &err
);
2387 error_propagate(errp
, err
);
2391 if (!visit_start_struct(v
, name
, NULL
, 0, errp
)) {
2394 if (!visit_type_int32(v
, "tm_year", &value
.tm_year
, errp
)) {
2397 if (!visit_type_int32(v
, "tm_mon", &value
.tm_mon
, errp
)) {
2400 if (!visit_type_int32(v
, "tm_mday", &value
.tm_mday
, errp
)) {
2403 if (!visit_type_int32(v
, "tm_hour", &value
.tm_hour
, errp
)) {
2406 if (!visit_type_int32(v
, "tm_min", &value
.tm_min
, errp
)) {
2409 if (!visit_type_int32(v
, "tm_sec", &value
.tm_sec
, errp
)) {
2412 visit_check_struct(v
, errp
);
2414 visit_end_struct(v
, NULL
);
2418 object_property_add_tm(Object
*obj
, const char *name
,
2419 void (*get
)(Object
*, struct tm
*, Error
**))
2421 TMProperty
*prop
= g_malloc0(sizeof(*prop
));
2425 return object_property_add(obj
, name
, "struct tm",
2426 get
? property_get_tm
: NULL
, NULL
,
2427 property_release_data
,
2432 object_class_property_add_tm(ObjectClass
*klass
, const char *name
,
2433 void (*get
)(Object
*, struct tm
*, Error
**))
2435 TMProperty
*prop
= g_malloc0(sizeof(*prop
));
2439 return object_class_property_add(klass
, name
, "struct tm",
2440 get
? property_get_tm
: NULL
,
2444 static char *object_get_type(Object
*obj
, Error
**errp
)
2446 return g_strdup(object_get_typename(obj
));
2449 static void property_get_uint8_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2450 void *opaque
, Error
**errp
)
2452 uint8_t value
= *(uint8_t *)opaque
;
2453 visit_type_uint8(v
, name
, &value
, errp
);
2456 static void property_set_uint8_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2457 void *opaque
, Error
**errp
)
2459 uint8_t *field
= opaque
;
2462 if (!visit_type_uint8(v
, name
, &value
, errp
)) {
2469 static void property_get_uint16_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2470 void *opaque
, Error
**errp
)
2472 uint16_t value
= *(uint16_t *)opaque
;
2473 visit_type_uint16(v
, name
, &value
, errp
);
2476 static void property_set_uint16_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2477 void *opaque
, Error
**errp
)
2479 uint16_t *field
= opaque
;
2482 if (!visit_type_uint16(v
, name
, &value
, errp
)) {
2489 static void property_get_uint32_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2490 void *opaque
, Error
**errp
)
2492 uint32_t value
= *(uint32_t *)opaque
;
2493 visit_type_uint32(v
, name
, &value
, errp
);
2496 static void property_set_uint32_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2497 void *opaque
, Error
**errp
)
2499 uint32_t *field
= opaque
;
2502 if (!visit_type_uint32(v
, name
, &value
, errp
)) {
2509 static void property_get_uint64_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2510 void *opaque
, Error
**errp
)
2512 uint64_t value
= *(uint64_t *)opaque
;
2513 visit_type_uint64(v
, name
, &value
, errp
);
2516 static void property_set_uint64_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2517 void *opaque
, Error
**errp
)
2519 uint64_t *field
= opaque
;
2522 if (!visit_type_uint64(v
, name
, &value
, errp
)) {
2530 object_property_add_uint8_ptr(Object
*obj
, const char *name
,
2532 ObjectPropertyFlags flags
)
2534 ObjectPropertyAccessor
*getter
= NULL
;
2535 ObjectPropertyAccessor
*setter
= NULL
;
2537 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2538 getter
= property_get_uint8_ptr
;
2541 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2542 setter
= property_set_uint8_ptr
;
2545 return object_property_add(obj
, name
, "uint8",
2546 getter
, setter
, NULL
, (void *)v
);
2550 object_class_property_add_uint8_ptr(ObjectClass
*klass
, const char *name
,
2552 ObjectPropertyFlags flags
)
2554 ObjectPropertyAccessor
*getter
= NULL
;
2555 ObjectPropertyAccessor
*setter
= NULL
;
2557 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2558 getter
= property_get_uint8_ptr
;
2561 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2562 setter
= property_set_uint8_ptr
;
2565 return object_class_property_add(klass
, name
, "uint8",
2566 getter
, setter
, NULL
, (void *)v
);
2570 object_property_add_uint16_ptr(Object
*obj
, const char *name
,
2572 ObjectPropertyFlags flags
)
2574 ObjectPropertyAccessor
*getter
= NULL
;
2575 ObjectPropertyAccessor
*setter
= NULL
;
2577 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2578 getter
= property_get_uint16_ptr
;
2581 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2582 setter
= property_set_uint16_ptr
;
2585 return object_property_add(obj
, name
, "uint16",
2586 getter
, setter
, NULL
, (void *)v
);
2590 object_class_property_add_uint16_ptr(ObjectClass
*klass
, const char *name
,
2592 ObjectPropertyFlags flags
)
2594 ObjectPropertyAccessor
*getter
= NULL
;
2595 ObjectPropertyAccessor
*setter
= NULL
;
2597 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2598 getter
= property_get_uint16_ptr
;
2601 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2602 setter
= property_set_uint16_ptr
;
2605 return object_class_property_add(klass
, name
, "uint16",
2606 getter
, setter
, NULL
, (void *)v
);
2610 object_property_add_uint32_ptr(Object
*obj
, const char *name
,
2612 ObjectPropertyFlags flags
)
2614 ObjectPropertyAccessor
*getter
= NULL
;
2615 ObjectPropertyAccessor
*setter
= NULL
;
2617 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2618 getter
= property_get_uint32_ptr
;
2621 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2622 setter
= property_set_uint32_ptr
;
2625 return object_property_add(obj
, name
, "uint32",
2626 getter
, setter
, NULL
, (void *)v
);
2630 object_class_property_add_uint32_ptr(ObjectClass
*klass
, const char *name
,
2632 ObjectPropertyFlags flags
)
2634 ObjectPropertyAccessor
*getter
= NULL
;
2635 ObjectPropertyAccessor
*setter
= NULL
;
2637 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2638 getter
= property_get_uint32_ptr
;
2641 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2642 setter
= property_set_uint32_ptr
;
2645 return object_class_property_add(klass
, name
, "uint32",
2646 getter
, setter
, NULL
, (void *)v
);
2650 object_property_add_uint64_ptr(Object
*obj
, const char *name
,
2652 ObjectPropertyFlags flags
)
2654 ObjectPropertyAccessor
*getter
= NULL
;
2655 ObjectPropertyAccessor
*setter
= NULL
;
2657 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2658 getter
= property_get_uint64_ptr
;
2661 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2662 setter
= property_set_uint64_ptr
;
2665 return object_property_add(obj
, name
, "uint64",
2666 getter
, setter
, NULL
, (void *)v
);
2670 object_class_property_add_uint64_ptr(ObjectClass
*klass
, const char *name
,
2672 ObjectPropertyFlags flags
)
2674 ObjectPropertyAccessor
*getter
= NULL
;
2675 ObjectPropertyAccessor
*setter
= NULL
;
2677 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2678 getter
= property_get_uint64_ptr
;
2681 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2682 setter
= property_set_uint64_ptr
;
2685 return object_class_property_add(klass
, name
, "uint64",
2686 getter
, setter
, NULL
, (void *)v
);
2694 static void property_get_alias(Object
*obj
, Visitor
*v
, const char *name
,
2695 void *opaque
, Error
**errp
)
2697 AliasProperty
*prop
= opaque
;
2698 Visitor
*alias_v
= visitor_forward_field(v
, prop
->target_name
, name
);
2700 object_property_get(prop
->target_obj
, prop
->target_name
, alias_v
, errp
);
2701 visit_free(alias_v
);
2704 static void property_set_alias(Object
*obj
, Visitor
*v
, const char *name
,
2705 void *opaque
, Error
**errp
)
2707 AliasProperty
*prop
= opaque
;
2708 Visitor
*alias_v
= visitor_forward_field(v
, prop
->target_name
, name
);
2710 object_property_set(prop
->target_obj
, prop
->target_name
, alias_v
, errp
);
2711 visit_free(alias_v
);
2714 static Object
*property_resolve_alias(Object
*obj
, void *opaque
,
2717 AliasProperty
*prop
= opaque
;
2719 return object_resolve_path_component(prop
->target_obj
, prop
->target_name
);
2722 static void property_release_alias(Object
*obj
, const char *name
, void *opaque
)
2724 AliasProperty
*prop
= opaque
;
2726 g_free(prop
->target_name
);
2731 object_property_add_alias(Object
*obj
, const char *name
,
2732 Object
*target_obj
, const char *target_name
)
2734 AliasProperty
*prop
;
2736 ObjectProperty
*target_prop
;
2737 g_autofree
char *prop_type
= NULL
;
2739 target_prop
= object_property_find_err(target_obj
, target_name
,
2742 if (object_property_is_child(target_prop
)) {
2743 prop_type
= g_strdup_printf("link%s",
2744 target_prop
->type
+ strlen("child"));
2746 prop_type
= g_strdup(target_prop
->type
);
2749 prop
= g_malloc(sizeof(*prop
));
2750 prop
->target_obj
= target_obj
;
2751 prop
->target_name
= g_strdup(target_name
);
2753 op
= object_property_add(obj
, name
, prop_type
,
2756 property_release_alias
,
2758 op
->resolve
= property_resolve_alias
;
2759 if (target_prop
->defval
) {
2760 op
->defval
= qobject_ref(target_prop
->defval
);
2763 object_property_set_description(obj
, op
->name
,
2764 target_prop
->description
);
2768 void object_property_set_description(Object
*obj
, const char *name
,
2769 const char *description
)
2773 op
= object_property_find_err(obj
, name
, &error_abort
);
2774 g_free(op
->description
);
2775 op
->description
= g_strdup(description
);
2778 void object_class_property_set_description(ObjectClass
*klass
,
2780 const char *description
)
2784 op
= g_hash_table_lookup(klass
->properties
, name
);
2785 g_free(op
->description
);
2786 op
->description
= g_strdup(description
);
2789 static void object_class_init(ObjectClass
*klass
, void *data
)
2791 object_class_property_add_str(klass
, "type", object_get_type
,
2795 static void register_types(void)
2797 static const TypeInfo interface_info
= {
2798 .name
= TYPE_INTERFACE
,
2799 .class_size
= sizeof(InterfaceClass
),
2803 static const TypeInfo object_info
= {
2804 .name
= TYPE_OBJECT
,
2805 .instance_size
= sizeof(Object
),
2806 .class_init
= object_class_init
,
2810 type_interface
= type_register_internal(&interface_info
);
2811 type_register_internal(&object_info
);
2814 type_init(register_types
)