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 "qapi/visitor.h"
20 #include "qapi/string-input-visitor.h"
21 #include "qapi/string-output-visitor.h"
22 #include "qapi/qobject-input-visitor.h"
23 #include "qapi/qapi-builtin-visit.h"
24 #include "qapi/qmp/qerror.h"
25 #include "qapi/qmp/qjson.h"
28 /* TODO: replace QObject with a simpler visitor to avoid a dependency
29 * of the QOM core on QObject? */
30 #include "qom/qom-qobject.h"
31 #include "qapi/qmp/qbool.h"
32 #include "qapi/qmp/qnum.h"
33 #include "qapi/qmp/qstring.h"
34 #include "qemu/error-report.h"
36 #define MAX_INTERFACES 32
38 typedef struct InterfaceImpl InterfaceImpl
;
39 typedef struct TypeImpl TypeImpl
;
53 size_t instance_align
;
55 void (*class_init
)(ObjectClass
*klass
, void *data
);
56 void (*class_base_init
)(ObjectClass
*klass
, void *data
);
60 void (*instance_init
)(Object
*obj
);
61 void (*instance_post_init
)(Object
*obj
);
62 void (*instance_finalize
)(Object
*obj
);
67 TypeImpl
*parent_type
;
72 InterfaceImpl interfaces
[MAX_INTERFACES
];
75 static Type type_interface
;
77 static GHashTable
*type_table_get(void)
79 static GHashTable
*type_table
;
81 if (type_table
== NULL
) {
82 type_table
= g_hash_table_new(g_str_hash
, g_str_equal
);
88 static bool enumerating_types
;
90 static void type_table_add(TypeImpl
*ti
)
92 assert(!enumerating_types
);
93 g_hash_table_insert(type_table_get(), (void *)ti
->name
, ti
);
96 static TypeImpl
*type_table_lookup(const char *name
)
98 return g_hash_table_lookup(type_table_get(), name
);
101 static TypeImpl
*type_new(const TypeInfo
*info
)
103 TypeImpl
*ti
= g_malloc0(sizeof(*ti
));
106 g_assert(info
->name
!= NULL
);
108 if (type_table_lookup(info
->name
) != NULL
) {
109 fprintf(stderr
, "Registering `%s' which already exists\n", info
->name
);
113 ti
->name
= g_strdup(info
->name
);
114 ti
->parent
= g_strdup(info
->parent
);
116 ti
->class_size
= info
->class_size
;
117 ti
->instance_size
= info
->instance_size
;
118 ti
->instance_align
= info
->instance_align
;
120 ti
->class_init
= info
->class_init
;
121 ti
->class_base_init
= info
->class_base_init
;
122 ti
->class_data
= info
->class_data
;
124 ti
->instance_init
= info
->instance_init
;
125 ti
->instance_post_init
= info
->instance_post_init
;
126 ti
->instance_finalize
= info
->instance_finalize
;
128 ti
->abstract
= info
->abstract
;
130 for (i
= 0; info
->interfaces
&& info
->interfaces
[i
].type
; i
++) {
131 ti
->interfaces
[i
].typename
= g_strdup(info
->interfaces
[i
].type
);
133 ti
->num_interfaces
= i
;
138 static TypeImpl
*type_register_internal(const TypeInfo
*info
)
147 TypeImpl
*type_register(const TypeInfo
*info
)
149 assert(info
->parent
);
150 return type_register_internal(info
);
153 TypeImpl
*type_register_static(const TypeInfo
*info
)
155 return type_register(info
);
158 void type_register_static_array(const TypeInfo
*infos
, int nr_infos
)
162 for (i
= 0; i
< nr_infos
; i
++) {
163 type_register_static(&infos
[i
]);
167 static TypeImpl
*type_get_by_name(const char *name
)
173 return type_table_lookup(name
);
176 static TypeImpl
*type_get_parent(TypeImpl
*type
)
178 if (!type
->parent_type
&& type
->parent
) {
179 type
->parent_type
= type_get_by_name(type
->parent
);
180 if (!type
->parent_type
) {
181 fprintf(stderr
, "Type '%s' is missing its parent '%s'\n",
182 type
->name
, type
->parent
);
187 return type
->parent_type
;
190 static bool type_has_parent(TypeImpl
*type
)
192 return (type
->parent
!= NULL
);
195 static size_t type_class_get_size(TypeImpl
*ti
)
197 if (ti
->class_size
) {
198 return ti
->class_size
;
201 if (type_has_parent(ti
)) {
202 return type_class_get_size(type_get_parent(ti
));
205 return sizeof(ObjectClass
);
208 static size_t type_object_get_size(TypeImpl
*ti
)
210 if (ti
->instance_size
) {
211 return ti
->instance_size
;
214 if (type_has_parent(ti
)) {
215 return type_object_get_size(type_get_parent(ti
));
221 size_t object_type_get_instance_size(const char *typename
)
223 TypeImpl
*type
= type_get_by_name(typename
);
225 g_assert(type
!= NULL
);
226 return type_object_get_size(type
);
229 static bool type_is_ancestor(TypeImpl
*type
, TypeImpl
*target_type
)
233 /* Check if target_type is a direct ancestor of type */
235 if (type
== target_type
) {
239 type
= type_get_parent(type
);
245 static void type_initialize(TypeImpl
*ti
);
247 static void type_initialize_interface(TypeImpl
*ti
, TypeImpl
*interface_type
,
248 TypeImpl
*parent_type
)
250 InterfaceClass
*new_iface
;
252 TypeImpl
*iface_impl
;
254 info
.parent
= parent_type
->name
;
255 info
.name
= g_strdup_printf("%s::%s", ti
->name
, interface_type
->name
);
256 info
.abstract
= true;
258 iface_impl
= type_new(&info
);
259 iface_impl
->parent_type
= parent_type
;
260 type_initialize(iface_impl
);
261 g_free((char *)info
.name
);
263 new_iface
= (InterfaceClass
*)iface_impl
->class;
264 new_iface
->concrete_class
= ti
->class;
265 new_iface
->interface_type
= interface_type
;
267 ti
->class->interfaces
= g_slist_append(ti
->class->interfaces
, new_iface
);
270 static void object_property_free(gpointer data
)
272 ObjectProperty
*prop
= data
;
275 qobject_unref(prop
->defval
);
280 g_free(prop
->description
);
284 static void type_initialize(TypeImpl
*ti
)
292 ti
->class_size
= type_class_get_size(ti
);
293 ti
->instance_size
= type_object_get_size(ti
);
294 /* Any type with zero instance_size is implicitly abstract.
295 * This means interface types are all abstract.
297 if (ti
->instance_size
== 0) {
300 if (type_is_ancestor(ti
, type_interface
)) {
301 assert(ti
->instance_size
== 0);
302 assert(ti
->abstract
);
303 assert(!ti
->instance_init
);
304 assert(!ti
->instance_post_init
);
305 assert(!ti
->instance_finalize
);
306 assert(!ti
->num_interfaces
);
308 ti
->class = g_malloc0(ti
->class_size
);
310 parent
= type_get_parent(ti
);
312 type_initialize(parent
);
316 g_assert(parent
->class_size
<= ti
->class_size
);
317 g_assert(parent
->instance_size
<= ti
->instance_size
);
318 memcpy(ti
->class, parent
->class, parent
->class_size
);
319 ti
->class->interfaces
= NULL
;
321 for (e
= parent
->class->interfaces
; e
; e
= e
->next
) {
322 InterfaceClass
*iface
= e
->data
;
323 ObjectClass
*klass
= OBJECT_CLASS(iface
);
325 type_initialize_interface(ti
, iface
->interface_type
, klass
->type
);
328 for (i
= 0; i
< ti
->num_interfaces
; i
++) {
329 TypeImpl
*t
= type_get_by_name(ti
->interfaces
[i
].typename
);
331 error_report("missing interface '%s' for object '%s'",
332 ti
->interfaces
[i
].typename
, parent
->name
);
335 for (e
= ti
->class->interfaces
; e
; e
= e
->next
) {
336 TypeImpl
*target_type
= OBJECT_CLASS(e
->data
)->type
;
338 if (type_is_ancestor(target_type
, t
)) {
347 type_initialize_interface(ti
, t
, t
);
351 ti
->class->properties
= g_hash_table_new_full(g_str_hash
, g_str_equal
, NULL
,
352 object_property_free
);
354 ti
->class->type
= ti
;
357 if (parent
->class_base_init
) {
358 parent
->class_base_init(ti
->class, ti
->class_data
);
360 parent
= type_get_parent(parent
);
363 if (ti
->class_init
) {
364 ti
->class_init(ti
->class, ti
->class_data
);
368 static void object_init_with_type(Object
*obj
, TypeImpl
*ti
)
370 if (type_has_parent(ti
)) {
371 object_init_with_type(obj
, type_get_parent(ti
));
374 if (ti
->instance_init
) {
375 ti
->instance_init(obj
);
379 static void object_post_init_with_type(Object
*obj
, TypeImpl
*ti
)
381 if (ti
->instance_post_init
) {
382 ti
->instance_post_init(obj
);
385 if (type_has_parent(ti
)) {
386 object_post_init_with_type(obj
, type_get_parent(ti
));
390 bool object_apply_global_props(Object
*obj
, const GPtrArray
*props
,
399 for (i
= 0; i
< props
->len
; i
++) {
400 GlobalProperty
*p
= g_ptr_array_index(props
, i
);
403 if (object_dynamic_cast(obj
, p
->driver
) == NULL
) {
406 if (p
->optional
&& !object_property_find(obj
, p
->property
)) {
410 if (!object_property_parse(obj
, p
->property
, p
->value
, &err
)) {
411 error_prepend(&err
, "can't apply global %s.%s=%s: ",
412 p
->driver
, p
->property
, p
->value
);
414 * If errp != NULL, propagate error and return.
415 * If errp == NULL, report a warning, but keep going
416 * with the remaining globals.
419 error_propagate(errp
, err
);
422 warn_report_err(err
);
431 * Global property defaults
432 * Slot 0: accelerator's global property defaults
433 * Slot 1: machine's global property defaults
434 * Slot 2: global properties from legacy command line option
435 * Each is a GPtrArray of of GlobalProperty.
436 * Applied in order, later entries override earlier ones.
438 static GPtrArray
*object_compat_props
[3];
441 * Retrieve @GPtrArray for global property defined with options
442 * other than "-global". These are generally used for syntactic
443 * sugar and legacy command line options.
445 void object_register_sugar_prop(const char *driver
, const char *prop
,
446 const char *value
, bool optional
)
449 if (!object_compat_props
[2]) {
450 object_compat_props
[2] = g_ptr_array_new();
452 g
= g_new0(GlobalProperty
, 1);
453 g
->driver
= g_strdup(driver
);
454 g
->property
= g_strdup(prop
);
455 g
->value
= g_strdup(value
);
456 g
->optional
= optional
;
457 g_ptr_array_add(object_compat_props
[2], g
);
461 * Set machine's global property defaults to @compat_props.
462 * May be called at most once.
464 void object_set_machine_compat_props(GPtrArray
*compat_props
)
466 assert(!object_compat_props
[1]);
467 object_compat_props
[1] = compat_props
;
471 * Set accelerator's global property defaults to @compat_props.
472 * May be called at most once.
474 void object_set_accelerator_compat_props(GPtrArray
*compat_props
)
476 assert(!object_compat_props
[0]);
477 object_compat_props
[0] = compat_props
;
480 void object_apply_compat_props(Object
*obj
)
484 for (i
= 0; i
< ARRAY_SIZE(object_compat_props
); i
++) {
485 object_apply_global_props(obj
, object_compat_props
[i
],
486 i
== 2 ? &error_fatal
: &error_abort
);
490 static void object_class_property_init_all(Object
*obj
)
492 ObjectPropertyIterator iter
;
493 ObjectProperty
*prop
;
495 object_class_property_iter_init(&iter
, object_get_class(obj
));
496 while ((prop
= object_property_iter_next(&iter
))) {
498 prop
->init(obj
, prop
);
503 static void object_initialize_with_type(Object
*obj
, size_t size
, TypeImpl
*type
)
505 type_initialize(type
);
507 g_assert(type
->instance_size
>= sizeof(Object
));
508 g_assert(type
->abstract
== false);
509 g_assert(size
>= type
->instance_size
);
511 memset(obj
, 0, type
->instance_size
);
512 obj
->class = type
->class;
514 object_class_property_init_all(obj
);
515 obj
->properties
= g_hash_table_new_full(g_str_hash
, g_str_equal
,
516 NULL
, object_property_free
);
517 object_init_with_type(obj
, type
);
518 object_post_init_with_type(obj
, type
);
521 void object_initialize(void *data
, size_t size
, const char *typename
)
523 TypeImpl
*type
= type_get_by_name(typename
);
525 #ifdef CONFIG_MODULES
527 module_load_qom_one(typename
);
528 type
= type_get_by_name(typename
);
532 error_report("missing object type '%s'", typename
);
536 object_initialize_with_type(data
, size
, type
);
539 bool object_initialize_child_with_props(Object
*parentobj
,
540 const char *propname
,
541 void *childobj
, size_t size
,
548 va_start(vargs
, errp
);
549 ok
= object_initialize_child_with_propsv(parentobj
, propname
,
550 childobj
, size
, type
, errp
,
556 bool object_initialize_child_with_propsv(Object
*parentobj
,
557 const char *propname
,
558 void *childobj
, size_t size
,
560 Error
**errp
, va_list vargs
)
566 object_initialize(childobj
, size
, type
);
567 obj
= OBJECT(childobj
);
569 if (!object_set_propv(obj
, errp
, vargs
)) {
573 object_property_add_child(parentobj
, propname
, obj
);
575 uc
= (UserCreatable
*)object_dynamic_cast(obj
, TYPE_USER_CREATABLE
);
577 if (!user_creatable_complete(uc
, errp
)) {
578 object_unparent(obj
);
587 * We want @obj's reference to be 1 on success, 0 on failure.
588 * On success, it's 2: one taken by object_initialize(), and one
589 * by object_property_add_child().
590 * On failure in object_initialize() or earlier, it's 1.
591 * On failure afterwards, it's also 1: object_unparent() releases
592 * the reference taken by object_property_add_child().
598 void object_initialize_child_internal(Object
*parent
,
599 const char *propname
,
600 void *child
, size_t size
,
603 object_initialize_child_with_props(parent
, propname
, child
, size
, type
,
607 static inline bool object_property_is_child(ObjectProperty
*prop
)
609 return strstart(prop
->type
, "child<", NULL
);
612 static void object_property_del_all(Object
*obj
)
614 g_autoptr(GHashTable
) done
= g_hash_table_new(NULL
, NULL
);
615 ObjectProperty
*prop
;
616 ObjectPropertyIterator iter
;
621 object_property_iter_init(&iter
, obj
);
622 while ((prop
= object_property_iter_next(&iter
)) != NULL
) {
623 if (g_hash_table_add(done
, prop
)) {
625 prop
->release(obj
, prop
->name
, prop
->opaque
);
633 g_hash_table_unref(obj
->properties
);
636 static void object_property_del_child(Object
*obj
, Object
*child
)
638 ObjectProperty
*prop
;
642 g_hash_table_iter_init(&iter
, obj
->properties
);
643 while (g_hash_table_iter_next(&iter
, &key
, &value
)) {
645 if (object_property_is_child(prop
) && prop
->opaque
== child
) {
647 prop
->release(obj
, prop
->name
, prop
->opaque
);
648 prop
->release
= NULL
;
653 g_hash_table_iter_init(&iter
, obj
->properties
);
654 while (g_hash_table_iter_next(&iter
, &key
, &value
)) {
656 if (object_property_is_child(prop
) && prop
->opaque
== child
) {
657 g_hash_table_iter_remove(&iter
);
663 void object_unparent(Object
*obj
)
666 object_property_del_child(obj
->parent
, obj
);
670 static void object_deinit(Object
*obj
, TypeImpl
*type
)
672 if (type
->instance_finalize
) {
673 type
->instance_finalize(obj
);
676 if (type_has_parent(type
)) {
677 object_deinit(obj
, type_get_parent(type
));
681 static void object_finalize(void *data
)
684 TypeImpl
*ti
= obj
->class->type
;
686 object_property_del_all(obj
);
687 object_deinit(obj
, ti
);
689 g_assert(obj
->ref
== 0);
690 g_assert(obj
->parent
== NULL
);
696 /* Find the minimum alignment guaranteed by the system malloc. */
697 #if __STDC_VERSION__ >= 201112L
698 typedef max_align_t qemu_max_align_t
;
708 static Object
*object_new_with_type(Type type
)
712 void (*obj_free
)(void *);
714 g_assert(type
!= NULL
);
715 type_initialize(type
);
717 size
= type
->instance_size
;
718 align
= type
->instance_align
;
721 * Do not use qemu_memalign unless required. Depending on the
722 * implementation, extra alignment implies extra overhead.
724 if (likely(align
<= __alignof__(qemu_max_align_t
))) {
725 obj
= g_malloc(size
);
728 obj
= qemu_memalign(align
, size
);
729 obj_free
= qemu_vfree
;
732 object_initialize_with_type(obj
, size
, type
);
733 obj
->free
= obj_free
;
738 Object
*object_new_with_class(ObjectClass
*klass
)
740 return object_new_with_type(klass
->type
);
743 Object
*object_new(const char *typename
)
745 TypeImpl
*ti
= type_get_by_name(typename
);
747 return object_new_with_type(ti
);
751 Object
*object_new_with_props(const char *typename
,
760 va_start(vargs
, errp
);
761 obj
= object_new_with_propv(typename
, parent
, id
, errp
, vargs
);
768 Object
*object_new_with_propv(const char *typename
,
778 klass
= object_class_by_name(typename
);
780 error_setg(errp
, "invalid object type: %s", typename
);
784 if (object_class_is_abstract(klass
)) {
785 error_setg(errp
, "object type '%s' is abstract", typename
);
788 obj
= object_new_with_type(klass
->type
);
790 if (!object_set_propv(obj
, errp
, vargs
)) {
795 object_property_add_child(parent
, id
, obj
);
798 uc
= (UserCreatable
*)object_dynamic_cast(obj
, TYPE_USER_CREATABLE
);
800 if (!user_creatable_complete(uc
, errp
)) {
802 object_unparent(obj
);
817 bool object_set_props(Object
*obj
,
824 va_start(vargs
, errp
);
825 ret
= object_set_propv(obj
, errp
, vargs
);
832 bool object_set_propv(Object
*obj
,
836 const char *propname
;
838 propname
= va_arg(vargs
, char *);
839 while (propname
!= NULL
) {
840 const char *value
= va_arg(vargs
, char *);
842 g_assert(value
!= NULL
);
843 if (!object_property_parse(obj
, propname
, value
, errp
)) {
846 propname
= va_arg(vargs
, char *);
853 Object
*object_dynamic_cast(Object
*obj
, const char *typename
)
855 if (obj
&& object_class_dynamic_cast(object_get_class(obj
), typename
)) {
862 Object
*object_dynamic_cast_assert(Object
*obj
, const char *typename
,
863 const char *file
, int line
, const char *func
)
865 trace_object_dynamic_cast_assert(obj
? obj
->class->type
->name
: "(null)",
866 typename
, file
, line
, func
);
868 #ifdef CONFIG_QOM_CAST_DEBUG
872 for (i
= 0; obj
&& i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
873 if (qatomic_read(&obj
->class->object_cast_cache
[i
]) == typename
) {
878 inst
= object_dynamic_cast(obj
, typename
);
881 fprintf(stderr
, "%s:%d:%s: Object %p is not an instance of type %s\n",
882 file
, line
, func
, obj
, typename
);
888 if (obj
&& obj
== inst
) {
889 for (i
= 1; i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
890 qatomic_set(&obj
->class->object_cast_cache
[i
- 1],
891 qatomic_read(&obj
->class->object_cast_cache
[i
]));
893 qatomic_set(&obj
->class->object_cast_cache
[i
- 1], typename
);
901 ObjectClass
*object_class_dynamic_cast(ObjectClass
*class,
902 const char *typename
)
904 ObjectClass
*ret
= NULL
;
905 TypeImpl
*target_type
;
912 /* A simple fast path that can trigger a lot for leaf classes. */
914 if (type
->name
== typename
) {
918 target_type
= type_get_by_name(typename
);
920 /* target class type unknown, so fail the cast */
924 if (type
->class->interfaces
&&
925 type_is_ancestor(target_type
, type_interface
)) {
929 for (i
= class->interfaces
; i
; i
= i
->next
) {
930 ObjectClass
*target_class
= i
->data
;
932 if (type_is_ancestor(target_class
->type
, target_type
)) {
938 /* The match was ambiguous, don't allow a cast */
942 } else if (type_is_ancestor(type
, target_type
)) {
949 ObjectClass
*object_class_dynamic_cast_assert(ObjectClass
*class,
950 const char *typename
,
951 const char *file
, int line
,
956 trace_object_class_dynamic_cast_assert(class ? class->type
->name
: "(null)",
957 typename
, file
, line
, func
);
959 #ifdef CONFIG_QOM_CAST_DEBUG
962 for (i
= 0; class && i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
963 if (qatomic_read(&class->class_cast_cache
[i
]) == typename
) {
969 if (!class || !class->interfaces
) {
974 ret
= object_class_dynamic_cast(class, typename
);
976 fprintf(stderr
, "%s:%d:%s: Object %p is not an instance of type %s\n",
977 file
, line
, func
, class, typename
);
981 #ifdef CONFIG_QOM_CAST_DEBUG
982 if (class && ret
== class) {
983 for (i
= 1; i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
984 qatomic_set(&class->class_cast_cache
[i
- 1],
985 qatomic_read(&class->class_cast_cache
[i
]));
987 qatomic_set(&class->class_cast_cache
[i
- 1], typename
);
994 const char *object_get_typename(const Object
*obj
)
996 return obj
->class->type
->name
;
999 ObjectClass
*object_get_class(Object
*obj
)
1004 bool object_class_is_abstract(ObjectClass
*klass
)
1006 return klass
->type
->abstract
;
1009 const char *object_class_get_name(ObjectClass
*klass
)
1011 return klass
->type
->name
;
1014 ObjectClass
*object_class_by_name(const char *typename
)
1016 TypeImpl
*type
= type_get_by_name(typename
);
1022 type_initialize(type
);
1027 ObjectClass
*module_object_class_by_name(const char *typename
)
1031 oc
= object_class_by_name(typename
);
1032 #ifdef CONFIG_MODULES
1034 module_load_qom_one(typename
);
1035 oc
= object_class_by_name(typename
);
1041 ObjectClass
*object_class_get_parent(ObjectClass
*class)
1043 TypeImpl
*type
= type_get_parent(class->type
);
1049 type_initialize(type
);
1054 typedef struct OCFData
1056 void (*fn
)(ObjectClass
*klass
, void *opaque
);
1057 const char *implements_type
;
1058 bool include_abstract
;
1062 static void object_class_foreach_tramp(gpointer key
, gpointer value
,
1065 OCFData
*data
= opaque
;
1066 TypeImpl
*type
= value
;
1069 type_initialize(type
);
1072 if (!data
->include_abstract
&& type
->abstract
) {
1076 if (data
->implements_type
&&
1077 !object_class_dynamic_cast(k
, data
->implements_type
)) {
1081 data
->fn(k
, data
->opaque
);
1084 void object_class_foreach(void (*fn
)(ObjectClass
*klass
, void *opaque
),
1085 const char *implements_type
, bool include_abstract
,
1088 OCFData data
= { fn
, implements_type
, include_abstract
, opaque
};
1090 enumerating_types
= true;
1091 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp
, &data
);
1092 enumerating_types
= false;
1095 static int do_object_child_foreach(Object
*obj
,
1096 int (*fn
)(Object
*child
, void *opaque
),
1097 void *opaque
, bool recurse
)
1099 GHashTableIter iter
;
1100 ObjectProperty
*prop
;
1103 g_hash_table_iter_init(&iter
, obj
->properties
);
1104 while (g_hash_table_iter_next(&iter
, NULL
, (gpointer
*)&prop
)) {
1105 if (object_property_is_child(prop
)) {
1106 Object
*child
= prop
->opaque
;
1108 ret
= fn(child
, opaque
);
1113 ret
= do_object_child_foreach(child
, fn
, opaque
, true);
1123 int object_child_foreach(Object
*obj
, int (*fn
)(Object
*child
, void *opaque
),
1126 return do_object_child_foreach(obj
, fn
, opaque
, false);
1129 int object_child_foreach_recursive(Object
*obj
,
1130 int (*fn
)(Object
*child
, void *opaque
),
1133 return do_object_child_foreach(obj
, fn
, opaque
, true);
1136 static void object_class_get_list_tramp(ObjectClass
*klass
, void *opaque
)
1138 GSList
**list
= opaque
;
1140 *list
= g_slist_prepend(*list
, klass
);
1143 GSList
*object_class_get_list(const char *implements_type
,
1144 bool include_abstract
)
1146 GSList
*list
= NULL
;
1148 object_class_foreach(object_class_get_list_tramp
,
1149 implements_type
, include_abstract
, &list
);
1153 static gint
object_class_cmp(gconstpointer a
, gconstpointer b
)
1155 return strcasecmp(object_class_get_name((ObjectClass
*)a
),
1156 object_class_get_name((ObjectClass
*)b
));
1159 GSList
*object_class_get_list_sorted(const char *implements_type
,
1160 bool include_abstract
)
1162 return g_slist_sort(object_class_get_list(implements_type
, include_abstract
),
1166 Object
*object_ref(void *objptr
)
1168 Object
*obj
= OBJECT(objptr
);
1172 qatomic_inc(&obj
->ref
);
1176 void object_unref(void *objptr
)
1178 Object
*obj
= OBJECT(objptr
);
1182 g_assert(obj
->ref
> 0);
1184 /* parent always holds a reference to its children */
1185 if (qatomic_fetch_dec(&obj
->ref
) == 1) {
1186 object_finalize(obj
);
1191 object_property_try_add(Object
*obj
, const char *name
, const char *type
,
1192 ObjectPropertyAccessor
*get
,
1193 ObjectPropertyAccessor
*set
,
1194 ObjectPropertyRelease
*release
,
1195 void *opaque
, Error
**errp
)
1197 ObjectProperty
*prop
;
1198 size_t name_len
= strlen(name
);
1200 if (name_len
>= 3 && !memcmp(name
+ name_len
- 3, "[*]", 4)) {
1202 ObjectProperty
*ret
= NULL
;
1203 char *name_no_array
= g_strdup(name
);
1205 name_no_array
[name_len
- 3] = '\0';
1206 for (i
= 0; i
< INT16_MAX
; ++i
) {
1207 char *full_name
= g_strdup_printf("%s[%d]", name_no_array
, i
);
1209 ret
= object_property_try_add(obj
, full_name
, type
, get
, set
,
1210 release
, opaque
, NULL
);
1216 g_free(name_no_array
);
1221 if (object_property_find(obj
, name
) != NULL
) {
1222 error_setg(errp
, "attempt to add duplicate property '%s' to object (type '%s')",
1223 name
, object_get_typename(obj
));
1227 prop
= g_malloc0(sizeof(*prop
));
1229 prop
->name
= g_strdup(name
);
1230 prop
->type
= g_strdup(type
);
1234 prop
->release
= release
;
1235 prop
->opaque
= opaque
;
1237 g_hash_table_insert(obj
->properties
, prop
->name
, prop
);
1242 object_property_add(Object
*obj
, const char *name
, const char *type
,
1243 ObjectPropertyAccessor
*get
,
1244 ObjectPropertyAccessor
*set
,
1245 ObjectPropertyRelease
*release
,
1248 return object_property_try_add(obj
, name
, type
, get
, set
, release
,
1249 opaque
, &error_abort
);
1253 object_class_property_add(ObjectClass
*klass
,
1256 ObjectPropertyAccessor
*get
,
1257 ObjectPropertyAccessor
*set
,
1258 ObjectPropertyRelease
*release
,
1261 ObjectProperty
*prop
;
1263 assert(!object_class_property_find(klass
, name
));
1265 prop
= g_malloc0(sizeof(*prop
));
1267 prop
->name
= g_strdup(name
);
1268 prop
->type
= g_strdup(type
);
1272 prop
->release
= release
;
1273 prop
->opaque
= opaque
;
1275 g_hash_table_insert(klass
->properties
, prop
->name
, prop
);
1280 ObjectProperty
*object_property_find(Object
*obj
, const char *name
)
1282 ObjectProperty
*prop
;
1283 ObjectClass
*klass
= object_get_class(obj
);
1285 prop
= object_class_property_find(klass
, name
);
1290 return g_hash_table_lookup(obj
->properties
, name
);
1293 ObjectProperty
*object_property_find_err(Object
*obj
, const char *name
,
1296 ObjectProperty
*prop
= object_property_find(obj
, name
);
1298 error_setg(errp
, "Property '%s.%s' not found",
1299 object_get_typename(obj
), name
);
1304 void object_property_iter_init(ObjectPropertyIterator
*iter
,
1307 g_hash_table_iter_init(&iter
->iter
, obj
->properties
);
1308 iter
->nextclass
= object_get_class(obj
);
1311 ObjectProperty
*object_property_iter_next(ObjectPropertyIterator
*iter
)
1314 while (!g_hash_table_iter_next(&iter
->iter
, &key
, &val
)) {
1315 if (!iter
->nextclass
) {
1318 g_hash_table_iter_init(&iter
->iter
, iter
->nextclass
->properties
);
1319 iter
->nextclass
= object_class_get_parent(iter
->nextclass
);
1324 void object_class_property_iter_init(ObjectPropertyIterator
*iter
,
1327 g_hash_table_iter_init(&iter
->iter
, klass
->properties
);
1328 iter
->nextclass
= object_class_get_parent(klass
);
1331 ObjectProperty
*object_class_property_find(ObjectClass
*klass
, const char *name
)
1333 ObjectClass
*parent_klass
;
1335 parent_klass
= object_class_get_parent(klass
);
1337 ObjectProperty
*prop
=
1338 object_class_property_find(parent_klass
, name
);
1344 return g_hash_table_lookup(klass
->properties
, name
);
1347 ObjectProperty
*object_class_property_find_err(ObjectClass
*klass
,
1351 ObjectProperty
*prop
= object_class_property_find(klass
, name
);
1353 error_setg(errp
, "Property '.%s' not found", name
);
1359 void object_property_del(Object
*obj
, const char *name
)
1361 ObjectProperty
*prop
= g_hash_table_lookup(obj
->properties
, name
);
1363 if (prop
->release
) {
1364 prop
->release(obj
, name
, prop
->opaque
);
1366 g_hash_table_remove(obj
->properties
, name
);
1369 bool object_property_get(Object
*obj
, const char *name
, Visitor
*v
,
1373 ObjectProperty
*prop
= object_property_find_err(obj
, name
, errp
);
1380 error_setg(errp
, QERR_PERMISSION_DENIED
);
1383 prop
->get(obj
, v
, name
, prop
->opaque
, &err
);
1384 error_propagate(errp
, err
);
1388 bool object_property_set(Object
*obj
, const char *name
, Visitor
*v
,
1392 ObjectProperty
*prop
= object_property_find_err(obj
, name
, errp
);
1399 error_setg(errp
, QERR_PERMISSION_DENIED
);
1402 prop
->set(obj
, v
, name
, prop
->opaque
, &err
);
1403 error_propagate(errp
, err
);
1407 bool object_property_set_str(Object
*obj
, const char *name
,
1408 const char *value
, Error
**errp
)
1410 QString
*qstr
= qstring_from_str(value
);
1411 bool ok
= object_property_set_qobject(obj
, name
, QOBJECT(qstr
), errp
);
1413 qobject_unref(qstr
);
1417 char *object_property_get_str(Object
*obj
, const char *name
,
1420 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1427 qstring
= qobject_to(QString
, ret
);
1429 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
, "string");
1432 retval
= g_strdup(qstring_get_str(qstring
));
1439 bool object_property_set_link(Object
*obj
, const char *name
,
1440 Object
*value
, Error
**errp
)
1442 g_autofree
char *path
= NULL
;
1445 path
= object_get_canonical_path(value
);
1447 return object_property_set_str(obj
, name
, path
?: "", errp
);
1450 Object
*object_property_get_link(Object
*obj
, const char *name
,
1453 char *str
= object_property_get_str(obj
, name
, errp
);
1454 Object
*target
= NULL
;
1457 target
= object_resolve_path(str
, NULL
);
1459 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1460 "Device '%s' not found", str
);
1468 bool object_property_set_bool(Object
*obj
, const char *name
,
1469 bool value
, Error
**errp
)
1471 QBool
*qbool
= qbool_from_bool(value
);
1472 bool ok
= object_property_set_qobject(obj
, name
, QOBJECT(qbool
), errp
);
1474 qobject_unref(qbool
);
1478 bool object_property_get_bool(Object
*obj
, const char *name
,
1481 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1488 qbool
= qobject_to(QBool
, ret
);
1490 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
, "boolean");
1493 retval
= qbool_get_bool(qbool
);
1500 bool object_property_set_int(Object
*obj
, const char *name
,
1501 int64_t value
, Error
**errp
)
1503 QNum
*qnum
= qnum_from_int(value
);
1504 bool ok
= object_property_set_qobject(obj
, name
, QOBJECT(qnum
), errp
);
1506 qobject_unref(qnum
);
1510 int64_t object_property_get_int(Object
*obj
, const char *name
,
1513 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1521 qnum
= qobject_to(QNum
, ret
);
1522 if (!qnum
|| !qnum_get_try_int(qnum
, &retval
)) {
1523 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
, "int");
1531 static void object_property_init_defval(Object
*obj
, ObjectProperty
*prop
)
1533 Visitor
*v
= qobject_input_visitor_new(prop
->defval
);
1535 assert(prop
->set
!= NULL
);
1536 prop
->set(obj
, v
, prop
->name
, prop
->opaque
, &error_abort
);
1541 static void object_property_set_default(ObjectProperty
*prop
, QObject
*defval
)
1543 assert(!prop
->defval
);
1544 assert(!prop
->init
);
1546 prop
->defval
= defval
;
1547 prop
->init
= object_property_init_defval
;
1550 void object_property_set_default_bool(ObjectProperty
*prop
, bool value
)
1552 object_property_set_default(prop
, QOBJECT(qbool_from_bool(value
)));
1555 void object_property_set_default_str(ObjectProperty
*prop
, const char *value
)
1557 object_property_set_default(prop
, QOBJECT(qstring_from_str(value
)));
1560 void object_property_set_default_int(ObjectProperty
*prop
, int64_t value
)
1562 object_property_set_default(prop
, QOBJECT(qnum_from_int(value
)));
1565 void object_property_set_default_uint(ObjectProperty
*prop
, uint64_t value
)
1567 object_property_set_default(prop
, QOBJECT(qnum_from_uint(value
)));
1570 bool object_property_set_uint(Object
*obj
, const char *name
,
1571 uint64_t value
, Error
**errp
)
1573 QNum
*qnum
= qnum_from_uint(value
);
1574 bool ok
= object_property_set_qobject(obj
, name
, QOBJECT(qnum
), errp
);
1576 qobject_unref(qnum
);
1580 uint64_t object_property_get_uint(Object
*obj
, const char *name
,
1583 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1590 qnum
= qobject_to(QNum
, ret
);
1591 if (!qnum
|| !qnum_get_try_uint(qnum
, &retval
)) {
1592 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
, "uint");
1600 typedef struct EnumProperty
{
1601 const QEnumLookup
*lookup
;
1602 int (*get
)(Object
*, Error
**);
1603 void (*set
)(Object
*, int, Error
**);
1606 int object_property_get_enum(Object
*obj
, const char *name
,
1607 const char *typename
, Error
**errp
)
1611 ObjectProperty
*prop
= object_property_find_err(obj
, name
, errp
);
1612 EnumProperty
*enumprop
;
1618 if (!g_str_equal(prop
->type
, typename
)) {
1619 error_setg(errp
, "Property %s on %s is not '%s' enum type",
1620 name
, object_class_get_name(
1621 object_get_class(obj
)), typename
);
1625 enumprop
= prop
->opaque
;
1627 str
= object_property_get_str(obj
, name
, errp
);
1632 ret
= qapi_enum_parse(enumprop
->lookup
, str
, -1, errp
);
1638 bool object_property_parse(Object
*obj
, const char *name
,
1639 const char *string
, Error
**errp
)
1641 Visitor
*v
= string_input_visitor_new(string
);
1642 bool ok
= object_property_set(obj
, name
, v
, errp
);
1648 char *object_property_print(Object
*obj
, const char *name
, bool human
,
1652 char *string
= NULL
;
1654 v
= string_output_visitor_new(human
, &string
);
1655 if (!object_property_get(obj
, name
, v
, errp
)) {
1659 visit_complete(v
, &string
);
1666 const char *object_property_get_type(Object
*obj
, const char *name
, Error
**errp
)
1668 ObjectProperty
*prop
= object_property_find_err(obj
, name
, errp
);
1676 Object
*object_get_root(void)
1678 static Object
*root
;
1681 root
= object_new("container");
1687 Object
*object_get_objects_root(void)
1689 return container_get(object_get_root(), "/objects");
1692 Object
*object_get_internal_root(void)
1694 static Object
*internal_root
;
1696 if (!internal_root
) {
1697 internal_root
= object_new("container");
1700 return internal_root
;
1703 static void object_get_child_property(Object
*obj
, Visitor
*v
,
1704 const char *name
, void *opaque
,
1707 Object
*child
= opaque
;
1710 path
= object_get_canonical_path(child
);
1711 visit_type_str(v
, name
, &path
, errp
);
1715 static Object
*object_resolve_child_property(Object
*parent
, void *opaque
,
1721 static void object_finalize_child_property(Object
*obj
, const char *name
,
1724 Object
*child
= opaque
;
1726 if (child
->class->unparent
) {
1727 (child
->class->unparent
)(child
);
1729 child
->parent
= NULL
;
1730 object_unref(child
);
1734 object_property_try_add_child(Object
*obj
, const char *name
,
1735 Object
*child
, Error
**errp
)
1737 g_autofree
char *type
= NULL
;
1740 assert(!child
->parent
);
1742 type
= g_strdup_printf("child<%s>", object_get_typename(child
));
1744 op
= object_property_try_add(obj
, name
, type
, object_get_child_property
,
1745 NULL
, object_finalize_child_property
,
1750 op
->resolve
= object_resolve_child_property
;
1752 child
->parent
= obj
;
1757 object_property_add_child(Object
*obj
, const char *name
,
1760 return object_property_try_add_child(obj
, name
, child
, &error_abort
);
1763 void object_property_allow_set_link(const Object
*obj
, const char *name
,
1764 Object
*val
, Error
**errp
)
1766 /* Allow the link to be set, always */
1772 Object
*target
; /* if OBJ_PROP_LINK_DIRECT, when holding the pointer */
1773 ptrdiff_t offset
; /* if OBJ_PROP_LINK_CLASS */
1775 void (*check
)(const Object
*, const char *, Object
*, Error
**);
1776 ObjectPropertyLinkFlags flags
;
1780 object_link_get_targetp(Object
*obj
, LinkProperty
*lprop
)
1782 if (lprop
->flags
& OBJ_PROP_LINK_DIRECT
) {
1783 return &lprop
->target
;
1784 } else if (lprop
->flags
& OBJ_PROP_LINK_CLASS
) {
1785 return (void *)obj
+ lprop
->offset
;
1787 return lprop
->targetp
;
1791 static void object_get_link_property(Object
*obj
, Visitor
*v
,
1792 const char *name
, void *opaque
,
1795 LinkProperty
*lprop
= opaque
;
1796 Object
**targetp
= object_link_get_targetp(obj
, lprop
);
1800 path
= object_get_canonical_path(*targetp
);
1801 visit_type_str(v
, name
, &path
, errp
);
1805 visit_type_str(v
, name
, &path
, errp
);
1810 * object_resolve_link:
1812 * Lookup an object and ensure its type matches the link property type. This
1813 * is similar to object_resolve_path() except type verification against the
1814 * link property is performed.
1816 * Returns: The matched object or NULL on path lookup failures.
1818 static Object
*object_resolve_link(Object
*obj
, const char *name
,
1819 const char *path
, Error
**errp
)
1823 bool ambiguous
= false;
1826 /* Go from link<FOO> to FOO. */
1827 type
= object_property_get_type(obj
, name
, NULL
);
1828 target_type
= g_strndup(&type
[5], strlen(type
) - 6);
1829 target
= object_resolve_path_type(path
, target_type
, &ambiguous
);
1832 error_setg(errp
, "Path '%s' does not uniquely identify an object",
1834 } else if (!target
) {
1835 target
= object_resolve_path(path
, &ambiguous
);
1836 if (target
|| ambiguous
) {
1837 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
, target_type
);
1839 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1840 "Device '%s' not found", path
);
1844 g_free(target_type
);
1849 static void object_set_link_property(Object
*obj
, Visitor
*v
,
1850 const char *name
, void *opaque
,
1853 Error
*local_err
= NULL
;
1854 LinkProperty
*prop
= opaque
;
1855 Object
**targetp
= object_link_get_targetp(obj
, prop
);
1856 Object
*old_target
= *targetp
;
1860 if (!visit_type_str(v
, name
, &path
, errp
)) {
1865 new_target
= object_resolve_link(obj
, name
, path
, errp
);
1876 prop
->check(obj
, name
, new_target
, &local_err
);
1878 error_propagate(errp
, local_err
);
1882 *targetp
= new_target
;
1883 if (prop
->flags
& OBJ_PROP_LINK_STRONG
) {
1884 object_ref(new_target
);
1885 object_unref(old_target
);
1889 static Object
*object_resolve_link_property(Object
*parent
, void *opaque
,
1892 LinkProperty
*lprop
= opaque
;
1894 return *object_link_get_targetp(parent
, lprop
);
1897 static void object_release_link_property(Object
*obj
, const char *name
,
1900 LinkProperty
*prop
= opaque
;
1901 Object
**targetp
= object_link_get_targetp(obj
, prop
);
1903 if ((prop
->flags
& OBJ_PROP_LINK_STRONG
) && *targetp
) {
1904 object_unref(*targetp
);
1906 if (!(prop
->flags
& OBJ_PROP_LINK_CLASS
)) {
1911 static ObjectProperty
*
1912 object_add_link_prop(Object
*obj
, const char *name
,
1913 const char *type
, void *ptr
,
1914 void (*check
)(const Object
*, const char *,
1915 Object
*, Error
**),
1916 ObjectPropertyLinkFlags flags
)
1918 LinkProperty
*prop
= g_malloc(sizeof(*prop
));
1919 g_autofree
char *full_type
= NULL
;
1922 if (flags
& OBJ_PROP_LINK_DIRECT
) {
1925 prop
->targetp
= ptr
;
1927 prop
->check
= check
;
1928 prop
->flags
= flags
;
1930 full_type
= g_strdup_printf("link<%s>", type
);
1932 op
= object_property_add(obj
, name
, full_type
,
1933 object_get_link_property
,
1934 check
? object_set_link_property
: NULL
,
1935 object_release_link_property
,
1937 op
->resolve
= object_resolve_link_property
;
1942 object_property_add_link(Object
*obj
, const char *name
,
1943 const char *type
, Object
**targetp
,
1944 void (*check
)(const Object
*, const char *,
1945 Object
*, Error
**),
1946 ObjectPropertyLinkFlags flags
)
1948 return object_add_link_prop(obj
, name
, type
, targetp
, check
, flags
);
1952 object_class_property_add_link(ObjectClass
*oc
,
1954 const char *type
, ptrdiff_t offset
,
1955 void (*check
)(const Object
*obj
, const char *name
,
1956 Object
*val
, Error
**errp
),
1957 ObjectPropertyLinkFlags flags
)
1959 LinkProperty
*prop
= g_new0(LinkProperty
, 1);
1963 prop
->offset
= offset
;
1964 prop
->check
= check
;
1965 prop
->flags
= flags
| OBJ_PROP_LINK_CLASS
;
1967 full_type
= g_strdup_printf("link<%s>", type
);
1969 op
= object_class_property_add(oc
, name
, full_type
,
1970 object_get_link_property
,
1971 check
? object_set_link_property
: NULL
,
1972 object_release_link_property
,
1975 op
->resolve
= object_resolve_link_property
;
1982 object_property_add_const_link(Object
*obj
, const char *name
,
1985 return object_add_link_prop(obj
, name
,
1986 object_get_typename(target
), target
,
1987 NULL
, OBJ_PROP_LINK_DIRECT
);
1990 const char *object_get_canonical_path_component(const Object
*obj
)
1992 ObjectProperty
*prop
= NULL
;
1993 GHashTableIter iter
;
1995 if (obj
->parent
== NULL
) {
1999 g_hash_table_iter_init(&iter
, obj
->parent
->properties
);
2000 while (g_hash_table_iter_next(&iter
, NULL
, (gpointer
*)&prop
)) {
2001 if (!object_property_is_child(prop
)) {
2005 if (prop
->opaque
== obj
) {
2010 /* obj had a parent but was not a child, should never happen */
2011 g_assert_not_reached();
2015 char *object_get_canonical_path(const Object
*obj
)
2017 Object
*root
= object_get_root();
2018 char *newpath
, *path
= NULL
;
2021 return g_strdup("/");
2025 const char *component
= object_get_canonical_path_component(obj
);
2028 /* A canonical path must be complete, so discard what was
2035 newpath
= g_strdup_printf("/%s%s", component
, path
? path
: "");
2039 } while (obj
!= root
);
2044 Object
*object_resolve_path_component(Object
*parent
, const char *part
)
2046 ObjectProperty
*prop
= object_property_find(parent
, part
);
2051 if (prop
->resolve
) {
2052 return prop
->resolve(parent
, prop
->opaque
, part
);
2058 static Object
*object_resolve_abs_path(Object
*parent
,
2060 const char *typename
)
2064 if (*parts
== NULL
) {
2065 return object_dynamic_cast(parent
, typename
);
2068 if (strcmp(*parts
, "") == 0) {
2069 return object_resolve_abs_path(parent
, parts
+ 1, typename
);
2072 child
= object_resolve_path_component(parent
, *parts
);
2077 return object_resolve_abs_path(child
, parts
+ 1, typename
);
2080 static Object
*object_resolve_partial_path(Object
*parent
,
2082 const char *typename
,
2086 GHashTableIter iter
;
2087 ObjectProperty
*prop
;
2089 obj
= object_resolve_abs_path(parent
, parts
, typename
);
2091 g_hash_table_iter_init(&iter
, parent
->properties
);
2092 while (g_hash_table_iter_next(&iter
, NULL
, (gpointer
*)&prop
)) {
2095 if (!object_property_is_child(prop
)) {
2099 found
= object_resolve_partial_path(prop
->opaque
, parts
,
2100 typename
, ambiguous
);
2117 Object
*object_resolve_path_type(const char *path
, const char *typename
,
2123 parts
= g_strsplit(path
, "/", 0);
2126 if (parts
[0] == NULL
|| strcmp(parts
[0], "") != 0) {
2127 bool ambiguous
= false;
2128 obj
= object_resolve_partial_path(object_get_root(), parts
,
2129 typename
, &ambiguous
);
2131 *ambiguousp
= ambiguous
;
2134 obj
= object_resolve_abs_path(object_get_root(), parts
+ 1, typename
);
2142 Object
*object_resolve_path(const char *path
, bool *ambiguous
)
2144 return object_resolve_path_type(path
, TYPE_OBJECT
, ambiguous
);
2147 typedef struct StringProperty
2149 char *(*get
)(Object
*, Error
**);
2150 void (*set
)(Object
*, const char *, Error
**);
2153 static void property_get_str(Object
*obj
, Visitor
*v
, const char *name
,
2154 void *opaque
, Error
**errp
)
2156 StringProperty
*prop
= opaque
;
2160 value
= prop
->get(obj
, &err
);
2162 error_propagate(errp
, err
);
2166 visit_type_str(v
, name
, &value
, errp
);
2170 static void property_set_str(Object
*obj
, Visitor
*v
, const char *name
,
2171 void *opaque
, Error
**errp
)
2173 StringProperty
*prop
= opaque
;
2176 if (!visit_type_str(v
, name
, &value
, errp
)) {
2180 prop
->set(obj
, value
, errp
);
2184 static void property_release_data(Object
*obj
, const char *name
,
2191 object_property_add_str(Object
*obj
, const char *name
,
2192 char *(*get
)(Object
*, Error
**),
2193 void (*set
)(Object
*, const char *, Error
**))
2195 StringProperty
*prop
= g_malloc0(sizeof(*prop
));
2200 return object_property_add(obj
, name
, "string",
2201 get
? property_get_str
: NULL
,
2202 set
? property_set_str
: NULL
,
2203 property_release_data
,
2208 object_class_property_add_str(ObjectClass
*klass
, const char *name
,
2209 char *(*get
)(Object
*, Error
**),
2210 void (*set
)(Object
*, const char *,
2213 StringProperty
*prop
= g_malloc0(sizeof(*prop
));
2218 return object_class_property_add(klass
, name
, "string",
2219 get
? property_get_str
: NULL
,
2220 set
? property_set_str
: NULL
,
2225 typedef struct BoolProperty
2227 bool (*get
)(Object
*, Error
**);
2228 void (*set
)(Object
*, bool, Error
**);
2231 static void property_get_bool(Object
*obj
, Visitor
*v
, const char *name
,
2232 void *opaque
, Error
**errp
)
2234 BoolProperty
*prop
= opaque
;
2238 value
= prop
->get(obj
, &err
);
2240 error_propagate(errp
, err
);
2244 visit_type_bool(v
, name
, &value
, errp
);
2247 static void property_set_bool(Object
*obj
, Visitor
*v
, const char *name
,
2248 void *opaque
, Error
**errp
)
2250 BoolProperty
*prop
= opaque
;
2253 if (!visit_type_bool(v
, name
, &value
, errp
)) {
2257 prop
->set(obj
, value
, errp
);
2261 object_property_add_bool(Object
*obj
, const char *name
,
2262 bool (*get
)(Object
*, Error
**),
2263 void (*set
)(Object
*, bool, Error
**))
2265 BoolProperty
*prop
= g_malloc0(sizeof(*prop
));
2270 return object_property_add(obj
, name
, "bool",
2271 get
? property_get_bool
: NULL
,
2272 set
? property_set_bool
: NULL
,
2273 property_release_data
,
2278 object_class_property_add_bool(ObjectClass
*klass
, const char *name
,
2279 bool (*get
)(Object
*, Error
**),
2280 void (*set
)(Object
*, bool, Error
**))
2282 BoolProperty
*prop
= g_malloc0(sizeof(*prop
));
2287 return object_class_property_add(klass
, name
, "bool",
2288 get
? property_get_bool
: NULL
,
2289 set
? property_set_bool
: NULL
,
2294 static void property_get_enum(Object
*obj
, Visitor
*v
, const char *name
,
2295 void *opaque
, Error
**errp
)
2297 EnumProperty
*prop
= opaque
;
2301 value
= prop
->get(obj
, &err
);
2303 error_propagate(errp
, err
);
2307 visit_type_enum(v
, name
, &value
, prop
->lookup
, errp
);
2310 static void property_set_enum(Object
*obj
, Visitor
*v
, const char *name
,
2311 void *opaque
, Error
**errp
)
2313 EnumProperty
*prop
= opaque
;
2316 if (!visit_type_enum(v
, name
, &value
, prop
->lookup
, errp
)) {
2319 prop
->set(obj
, value
, errp
);
2323 object_property_add_enum(Object
*obj
, const char *name
,
2324 const char *typename
,
2325 const QEnumLookup
*lookup
,
2326 int (*get
)(Object
*, Error
**),
2327 void (*set
)(Object
*, int, Error
**))
2329 EnumProperty
*prop
= g_malloc(sizeof(*prop
));
2331 prop
->lookup
= lookup
;
2335 return object_property_add(obj
, name
, typename
,
2336 get
? property_get_enum
: NULL
,
2337 set
? property_set_enum
: NULL
,
2338 property_release_data
,
2343 object_class_property_add_enum(ObjectClass
*klass
, const char *name
,
2344 const char *typename
,
2345 const QEnumLookup
*lookup
,
2346 int (*get
)(Object
*, Error
**),
2347 void (*set
)(Object
*, int, Error
**))
2349 EnumProperty
*prop
= g_malloc(sizeof(*prop
));
2351 prop
->lookup
= lookup
;
2355 return object_class_property_add(klass
, name
, typename
,
2356 get
? property_get_enum
: NULL
,
2357 set
? property_set_enum
: NULL
,
2362 typedef struct TMProperty
{
2363 void (*get
)(Object
*, struct tm
*, Error
**);
2366 static void property_get_tm(Object
*obj
, Visitor
*v
, const char *name
,
2367 void *opaque
, Error
**errp
)
2369 TMProperty
*prop
= opaque
;
2373 prop
->get(obj
, &value
, &err
);
2375 error_propagate(errp
, err
);
2379 if (!visit_start_struct(v
, name
, NULL
, 0, errp
)) {
2382 if (!visit_type_int32(v
, "tm_year", &value
.tm_year
, errp
)) {
2385 if (!visit_type_int32(v
, "tm_mon", &value
.tm_mon
, errp
)) {
2388 if (!visit_type_int32(v
, "tm_mday", &value
.tm_mday
, errp
)) {
2391 if (!visit_type_int32(v
, "tm_hour", &value
.tm_hour
, errp
)) {
2394 if (!visit_type_int32(v
, "tm_min", &value
.tm_min
, errp
)) {
2397 if (!visit_type_int32(v
, "tm_sec", &value
.tm_sec
, errp
)) {
2400 visit_check_struct(v
, errp
);
2402 visit_end_struct(v
, NULL
);
2406 object_property_add_tm(Object
*obj
, const char *name
,
2407 void (*get
)(Object
*, struct tm
*, Error
**))
2409 TMProperty
*prop
= g_malloc0(sizeof(*prop
));
2413 return object_property_add(obj
, name
, "struct tm",
2414 get
? property_get_tm
: NULL
, NULL
,
2415 property_release_data
,
2420 object_class_property_add_tm(ObjectClass
*klass
, const char *name
,
2421 void (*get
)(Object
*, struct tm
*, Error
**))
2423 TMProperty
*prop
= g_malloc0(sizeof(*prop
));
2427 return object_class_property_add(klass
, name
, "struct tm",
2428 get
? property_get_tm
: NULL
,
2432 static char *object_get_type(Object
*obj
, Error
**errp
)
2434 return g_strdup(object_get_typename(obj
));
2437 static void property_get_uint8_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2438 void *opaque
, Error
**errp
)
2440 uint8_t value
= *(uint8_t *)opaque
;
2441 visit_type_uint8(v
, name
, &value
, errp
);
2444 static void property_set_uint8_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2445 void *opaque
, Error
**errp
)
2447 uint8_t *field
= opaque
;
2450 if (!visit_type_uint8(v
, name
, &value
, errp
)) {
2457 static void property_get_uint16_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2458 void *opaque
, Error
**errp
)
2460 uint16_t value
= *(uint16_t *)opaque
;
2461 visit_type_uint16(v
, name
, &value
, errp
);
2464 static void property_set_uint16_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2465 void *opaque
, Error
**errp
)
2467 uint16_t *field
= opaque
;
2470 if (!visit_type_uint16(v
, name
, &value
, errp
)) {
2477 static void property_get_uint32_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2478 void *opaque
, Error
**errp
)
2480 uint32_t value
= *(uint32_t *)opaque
;
2481 visit_type_uint32(v
, name
, &value
, errp
);
2484 static void property_set_uint32_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2485 void *opaque
, Error
**errp
)
2487 uint32_t *field
= opaque
;
2490 if (!visit_type_uint32(v
, name
, &value
, errp
)) {
2497 static void property_get_uint64_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2498 void *opaque
, Error
**errp
)
2500 uint64_t value
= *(uint64_t *)opaque
;
2501 visit_type_uint64(v
, name
, &value
, errp
);
2504 static void property_set_uint64_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2505 void *opaque
, Error
**errp
)
2507 uint64_t *field
= opaque
;
2510 if (!visit_type_uint64(v
, name
, &value
, errp
)) {
2518 object_property_add_uint8_ptr(Object
*obj
, const char *name
,
2520 ObjectPropertyFlags flags
)
2522 ObjectPropertyAccessor
*getter
= NULL
;
2523 ObjectPropertyAccessor
*setter
= NULL
;
2525 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2526 getter
= property_get_uint8_ptr
;
2529 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2530 setter
= property_set_uint8_ptr
;
2533 return object_property_add(obj
, name
, "uint8",
2534 getter
, setter
, NULL
, (void *)v
);
2538 object_class_property_add_uint8_ptr(ObjectClass
*klass
, const char *name
,
2540 ObjectPropertyFlags flags
)
2542 ObjectPropertyAccessor
*getter
= NULL
;
2543 ObjectPropertyAccessor
*setter
= NULL
;
2545 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2546 getter
= property_get_uint8_ptr
;
2549 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2550 setter
= property_set_uint8_ptr
;
2553 return object_class_property_add(klass
, name
, "uint8",
2554 getter
, setter
, NULL
, (void *)v
);
2558 object_property_add_uint16_ptr(Object
*obj
, const char *name
,
2560 ObjectPropertyFlags flags
)
2562 ObjectPropertyAccessor
*getter
= NULL
;
2563 ObjectPropertyAccessor
*setter
= NULL
;
2565 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2566 getter
= property_get_uint16_ptr
;
2569 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2570 setter
= property_set_uint16_ptr
;
2573 return object_property_add(obj
, name
, "uint16",
2574 getter
, setter
, NULL
, (void *)v
);
2578 object_class_property_add_uint16_ptr(ObjectClass
*klass
, const char *name
,
2580 ObjectPropertyFlags flags
)
2582 ObjectPropertyAccessor
*getter
= NULL
;
2583 ObjectPropertyAccessor
*setter
= NULL
;
2585 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2586 getter
= property_get_uint16_ptr
;
2589 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2590 setter
= property_set_uint16_ptr
;
2593 return object_class_property_add(klass
, name
, "uint16",
2594 getter
, setter
, NULL
, (void *)v
);
2598 object_property_add_uint32_ptr(Object
*obj
, const char *name
,
2600 ObjectPropertyFlags flags
)
2602 ObjectPropertyAccessor
*getter
= NULL
;
2603 ObjectPropertyAccessor
*setter
= NULL
;
2605 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2606 getter
= property_get_uint32_ptr
;
2609 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2610 setter
= property_set_uint32_ptr
;
2613 return object_property_add(obj
, name
, "uint32",
2614 getter
, setter
, NULL
, (void *)v
);
2618 object_class_property_add_uint32_ptr(ObjectClass
*klass
, const char *name
,
2620 ObjectPropertyFlags flags
)
2622 ObjectPropertyAccessor
*getter
= NULL
;
2623 ObjectPropertyAccessor
*setter
= NULL
;
2625 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2626 getter
= property_get_uint32_ptr
;
2629 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2630 setter
= property_set_uint32_ptr
;
2633 return object_class_property_add(klass
, name
, "uint32",
2634 getter
, setter
, NULL
, (void *)v
);
2638 object_property_add_uint64_ptr(Object
*obj
, const char *name
,
2640 ObjectPropertyFlags flags
)
2642 ObjectPropertyAccessor
*getter
= NULL
;
2643 ObjectPropertyAccessor
*setter
= NULL
;
2645 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2646 getter
= property_get_uint64_ptr
;
2649 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2650 setter
= property_set_uint64_ptr
;
2653 return object_property_add(obj
, name
, "uint64",
2654 getter
, setter
, NULL
, (void *)v
);
2658 object_class_property_add_uint64_ptr(ObjectClass
*klass
, const char *name
,
2660 ObjectPropertyFlags flags
)
2662 ObjectPropertyAccessor
*getter
= NULL
;
2663 ObjectPropertyAccessor
*setter
= NULL
;
2665 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2666 getter
= property_get_uint64_ptr
;
2669 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2670 setter
= property_set_uint64_ptr
;
2673 return object_class_property_add(klass
, name
, "uint64",
2674 getter
, setter
, NULL
, (void *)v
);
2682 static void property_get_alias(Object
*obj
, Visitor
*v
, const char *name
,
2683 void *opaque
, Error
**errp
)
2685 AliasProperty
*prop
= opaque
;
2687 object_property_get(prop
->target_obj
, prop
->target_name
, v
, errp
);
2690 static void property_set_alias(Object
*obj
, Visitor
*v
, const char *name
,
2691 void *opaque
, Error
**errp
)
2693 AliasProperty
*prop
= opaque
;
2695 object_property_set(prop
->target_obj
, prop
->target_name
, v
, errp
);
2698 static Object
*property_resolve_alias(Object
*obj
, void *opaque
,
2701 AliasProperty
*prop
= opaque
;
2703 return object_resolve_path_component(prop
->target_obj
, prop
->target_name
);
2706 static void property_release_alias(Object
*obj
, const char *name
, void *opaque
)
2708 AliasProperty
*prop
= opaque
;
2710 g_free(prop
->target_name
);
2715 object_property_add_alias(Object
*obj
, const char *name
,
2716 Object
*target_obj
, const char *target_name
)
2718 AliasProperty
*prop
;
2720 ObjectProperty
*target_prop
;
2721 g_autofree
char *prop_type
= NULL
;
2723 target_prop
= object_property_find_err(target_obj
, target_name
,
2726 if (object_property_is_child(target_prop
)) {
2727 prop_type
= g_strdup_printf("link%s",
2728 target_prop
->type
+ strlen("child"));
2730 prop_type
= g_strdup(target_prop
->type
);
2733 prop
= g_malloc(sizeof(*prop
));
2734 prop
->target_obj
= target_obj
;
2735 prop
->target_name
= g_strdup(target_name
);
2737 op
= object_property_add(obj
, name
, prop_type
,
2740 property_release_alias
,
2742 op
->resolve
= property_resolve_alias
;
2743 if (target_prop
->defval
) {
2744 op
->defval
= qobject_ref(target_prop
->defval
);
2747 object_property_set_description(obj
, op
->name
,
2748 target_prop
->description
);
2752 void object_property_set_description(Object
*obj
, const char *name
,
2753 const char *description
)
2757 op
= object_property_find_err(obj
, name
, &error_abort
);
2758 g_free(op
->description
);
2759 op
->description
= g_strdup(description
);
2762 void object_class_property_set_description(ObjectClass
*klass
,
2764 const char *description
)
2768 op
= g_hash_table_lookup(klass
->properties
, name
);
2769 g_free(op
->description
);
2770 op
->description
= g_strdup(description
);
2773 static void object_class_init(ObjectClass
*klass
, void *data
)
2775 object_class_property_add_str(klass
, "type", object_get_type
,
2779 static void register_types(void)
2781 static TypeInfo interface_info
= {
2782 .name
= TYPE_INTERFACE
,
2783 .class_size
= sizeof(InterfaceClass
),
2787 static TypeInfo object_info
= {
2788 .name
= TYPE_OBJECT
,
2789 .instance_size
= sizeof(Object
),
2790 .class_init
= object_class_init
,
2794 type_interface
= type_register_internal(&interface_info
);
2795 type_register_internal(&object_info
);
2798 type_init(register_types
)