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
;
54 void (*class_init
)(ObjectClass
*klass
, void *data
);
55 void (*class_base_init
)(ObjectClass
*klass
, void *data
);
59 void (*instance_init
)(Object
*obj
);
60 void (*instance_post_init
)(Object
*obj
);
61 void (*instance_finalize
)(Object
*obj
);
66 TypeImpl
*parent_type
;
71 InterfaceImpl interfaces
[MAX_INTERFACES
];
74 static Type type_interface
;
76 static GHashTable
*type_table_get(void)
78 static GHashTable
*type_table
;
80 if (type_table
== NULL
) {
81 type_table
= g_hash_table_new(g_str_hash
, g_str_equal
);
87 static bool enumerating_types
;
89 static void type_table_add(TypeImpl
*ti
)
91 assert(!enumerating_types
);
92 g_hash_table_insert(type_table_get(), (void *)ti
->name
, ti
);
95 static TypeImpl
*type_table_lookup(const char *name
)
97 return g_hash_table_lookup(type_table_get(), name
);
100 static TypeImpl
*type_new(const TypeInfo
*info
)
102 TypeImpl
*ti
= g_malloc0(sizeof(*ti
));
105 g_assert(info
->name
!= NULL
);
107 if (type_table_lookup(info
->name
) != NULL
) {
108 fprintf(stderr
, "Registering `%s' which already exists\n", info
->name
);
112 ti
->name
= g_strdup(info
->name
);
113 ti
->parent
= g_strdup(info
->parent
);
115 ti
->class_size
= info
->class_size
;
116 ti
->instance_size
= info
->instance_size
;
118 ti
->class_init
= info
->class_init
;
119 ti
->class_base_init
= info
->class_base_init
;
120 ti
->class_data
= info
->class_data
;
122 ti
->instance_init
= info
->instance_init
;
123 ti
->instance_post_init
= info
->instance_post_init
;
124 ti
->instance_finalize
= info
->instance_finalize
;
126 ti
->abstract
= info
->abstract
;
128 for (i
= 0; info
->interfaces
&& info
->interfaces
[i
].type
; i
++) {
129 ti
->interfaces
[i
].typename
= g_strdup(info
->interfaces
[i
].type
);
131 ti
->num_interfaces
= i
;
136 static TypeImpl
*type_register_internal(const TypeInfo
*info
)
145 TypeImpl
*type_register(const TypeInfo
*info
)
147 assert(info
->parent
);
148 return type_register_internal(info
);
151 TypeImpl
*type_register_static(const TypeInfo
*info
)
153 return type_register(info
);
156 void type_register_static_array(const TypeInfo
*infos
, int nr_infos
)
160 for (i
= 0; i
< nr_infos
; i
++) {
161 type_register_static(&infos
[i
]);
165 static TypeImpl
*type_get_by_name(const char *name
)
171 return type_table_lookup(name
);
174 static TypeImpl
*type_get_parent(TypeImpl
*type
)
176 if (!type
->parent_type
&& type
->parent
) {
177 type
->parent_type
= type_get_by_name(type
->parent
);
178 if (!type
->parent_type
) {
179 fprintf(stderr
, "Type '%s' is missing its parent '%s'\n",
180 type
->name
, type
->parent
);
185 return type
->parent_type
;
188 static bool type_has_parent(TypeImpl
*type
)
190 return (type
->parent
!= NULL
);
193 static size_t type_class_get_size(TypeImpl
*ti
)
195 if (ti
->class_size
) {
196 return ti
->class_size
;
199 if (type_has_parent(ti
)) {
200 return type_class_get_size(type_get_parent(ti
));
203 return sizeof(ObjectClass
);
206 static size_t type_object_get_size(TypeImpl
*ti
)
208 if (ti
->instance_size
) {
209 return ti
->instance_size
;
212 if (type_has_parent(ti
)) {
213 return type_object_get_size(type_get_parent(ti
));
219 size_t object_type_get_instance_size(const char *typename
)
221 TypeImpl
*type
= type_get_by_name(typename
);
223 g_assert(type
!= NULL
);
224 return type_object_get_size(type
);
227 static bool type_is_ancestor(TypeImpl
*type
, TypeImpl
*target_type
)
231 /* Check if target_type is a direct ancestor of type */
233 if (type
== target_type
) {
237 type
= type_get_parent(type
);
243 static void type_initialize(TypeImpl
*ti
);
245 static void type_initialize_interface(TypeImpl
*ti
, TypeImpl
*interface_type
,
246 TypeImpl
*parent_type
)
248 InterfaceClass
*new_iface
;
250 TypeImpl
*iface_impl
;
252 info
.parent
= parent_type
->name
;
253 info
.name
= g_strdup_printf("%s::%s", ti
->name
, interface_type
->name
);
254 info
.abstract
= true;
256 iface_impl
= type_new(&info
);
257 iface_impl
->parent_type
= parent_type
;
258 type_initialize(iface_impl
);
259 g_free((char *)info
.name
);
261 new_iface
= (InterfaceClass
*)iface_impl
->class;
262 new_iface
->concrete_class
= ti
->class;
263 new_iface
->interface_type
= interface_type
;
265 ti
->class->interfaces
= g_slist_append(ti
->class->interfaces
, new_iface
);
268 static void object_property_free(gpointer data
)
270 ObjectProperty
*prop
= data
;
273 qobject_unref(prop
->defval
);
278 g_free(prop
->description
);
282 static void type_initialize(TypeImpl
*ti
)
290 ti
->class_size
= type_class_get_size(ti
);
291 ti
->instance_size
= type_object_get_size(ti
);
292 /* Any type with zero instance_size is implicitly abstract.
293 * This means interface types are all abstract.
295 if (ti
->instance_size
== 0) {
298 if (type_is_ancestor(ti
, type_interface
)) {
299 assert(ti
->instance_size
== 0);
300 assert(ti
->abstract
);
301 assert(!ti
->instance_init
);
302 assert(!ti
->instance_post_init
);
303 assert(!ti
->instance_finalize
);
304 assert(!ti
->num_interfaces
);
306 ti
->class = g_malloc0(ti
->class_size
);
308 parent
= type_get_parent(ti
);
310 type_initialize(parent
);
314 g_assert(parent
->class_size
<= ti
->class_size
);
315 g_assert(parent
->instance_size
<= ti
->instance_size
);
316 memcpy(ti
->class, parent
->class, parent
->class_size
);
317 ti
->class->interfaces
= NULL
;
319 for (e
= parent
->class->interfaces
; e
; e
= e
->next
) {
320 InterfaceClass
*iface
= e
->data
;
321 ObjectClass
*klass
= OBJECT_CLASS(iface
);
323 type_initialize_interface(ti
, iface
->interface_type
, klass
->type
);
326 for (i
= 0; i
< ti
->num_interfaces
; i
++) {
327 TypeImpl
*t
= type_get_by_name(ti
->interfaces
[i
].typename
);
329 error_report("missing interface '%s' for object '%s'",
330 ti
->interfaces
[i
].typename
, parent
->name
);
333 for (e
= ti
->class->interfaces
; e
; e
= e
->next
) {
334 TypeImpl
*target_type
= OBJECT_CLASS(e
->data
)->type
;
336 if (type_is_ancestor(target_type
, t
)) {
345 type_initialize_interface(ti
, t
, t
);
349 ti
->class->properties
= g_hash_table_new_full(g_str_hash
, g_str_equal
, NULL
,
350 object_property_free
);
352 ti
->class->type
= ti
;
355 if (parent
->class_base_init
) {
356 parent
->class_base_init(ti
->class, ti
->class_data
);
358 parent
= type_get_parent(parent
);
361 if (ti
->class_init
) {
362 ti
->class_init(ti
->class, ti
->class_data
);
366 static void object_init_with_type(Object
*obj
, TypeImpl
*ti
)
368 if (type_has_parent(ti
)) {
369 object_init_with_type(obj
, type_get_parent(ti
));
372 if (ti
->instance_init
) {
373 ti
->instance_init(obj
);
377 static void object_post_init_with_type(Object
*obj
, TypeImpl
*ti
)
379 if (ti
->instance_post_init
) {
380 ti
->instance_post_init(obj
);
383 if (type_has_parent(ti
)) {
384 object_post_init_with_type(obj
, type_get_parent(ti
));
388 void object_apply_global_props(Object
*obj
, const GPtrArray
*props
, Error
**errp
)
396 for (i
= 0; i
< props
->len
; i
++) {
397 GlobalProperty
*p
= g_ptr_array_index(props
, i
);
400 if (object_dynamic_cast(obj
, p
->driver
) == NULL
) {
403 if (p
->optional
&& !object_property_find(obj
, p
->property
, NULL
)) {
407 object_property_parse(obj
, p
->value
, p
->property
, &err
);
409 error_prepend(&err
, "can't apply global %s.%s=%s: ",
410 p
->driver
, p
->property
, p
->value
);
412 * If errp != NULL, propagate error and return.
413 * If errp == NULL, report a warning, but keep going
414 * with the remaining globals.
417 error_propagate(errp
, err
);
420 warn_report_err(err
);
427 * Global property defaults
428 * Slot 0: accelerator's global property defaults
429 * Slot 1: machine's global property defaults
430 * Slot 2: global properties from legacy command line option
431 * Each is a GPtrArray of of GlobalProperty.
432 * Applied in order, later entries override earlier ones.
434 static GPtrArray
*object_compat_props
[3];
437 * Retrieve @GPtrArray for global property defined with options
438 * other than "-global". These are generally used for syntactic
439 * sugar and legacy command line options.
441 void object_register_sugar_prop(const char *driver
, const char *prop
, const char *value
)
444 if (!object_compat_props
[2]) {
445 object_compat_props
[2] = g_ptr_array_new();
447 g
= g_new0(GlobalProperty
, 1);
448 g
->driver
= g_strdup(driver
);
449 g
->property
= g_strdup(prop
);
450 g
->value
= g_strdup(value
);
451 g_ptr_array_add(object_compat_props
[2], g
);
455 * Set machine's global property defaults to @compat_props.
456 * May be called at most once.
458 void object_set_machine_compat_props(GPtrArray
*compat_props
)
460 assert(!object_compat_props
[1]);
461 object_compat_props
[1] = compat_props
;
465 * Set accelerator's global property defaults to @compat_props.
466 * May be called at most once.
468 void object_set_accelerator_compat_props(GPtrArray
*compat_props
)
470 assert(!object_compat_props
[0]);
471 object_compat_props
[0] = compat_props
;
474 void object_apply_compat_props(Object
*obj
)
478 for (i
= 0; i
< ARRAY_SIZE(object_compat_props
); i
++) {
479 object_apply_global_props(obj
, object_compat_props
[i
],
480 i
== 2 ? &error_fatal
: &error_abort
);
484 static void object_class_property_init_all(Object
*obj
)
486 ObjectPropertyIterator iter
;
487 ObjectProperty
*prop
;
489 object_class_property_iter_init(&iter
, object_get_class(obj
));
490 while ((prop
= object_property_iter_next(&iter
))) {
492 prop
->init(obj
, prop
);
497 static void object_initialize_with_type(Object
*obj
, size_t size
, TypeImpl
*type
)
499 type_initialize(type
);
501 g_assert(type
->instance_size
>= sizeof(Object
));
502 g_assert(type
->abstract
== false);
503 g_assert(size
>= type
->instance_size
);
505 memset(obj
, 0, type
->instance_size
);
506 obj
->class = type
->class;
508 object_class_property_init_all(obj
);
509 obj
->properties
= g_hash_table_new_full(g_str_hash
, g_str_equal
,
510 NULL
, object_property_free
);
511 object_init_with_type(obj
, type
);
512 object_post_init_with_type(obj
, type
);
515 void object_initialize(void *data
, size_t size
, const char *typename
)
517 TypeImpl
*type
= type_get_by_name(typename
);
520 error_report("missing object type '%s'", typename
);
524 object_initialize_with_type(data
, size
, type
);
527 void object_initialize_child_with_props(Object
*parentobj
,
528 const char *propname
,
529 void *childobj
, size_t size
, const char *type
,
534 va_start(vargs
, errp
);
535 object_initialize_child_with_propsv(parentobj
, propname
,
536 childobj
, size
, type
, errp
, vargs
);
540 void object_initialize_child_with_propsv(Object
*parentobj
,
541 const char *propname
,
542 void *childobj
, size_t size
, const char *type
,
543 Error
**errp
, va_list vargs
)
545 Error
*local_err
= NULL
;
549 object_initialize(childobj
, size
, type
);
550 obj
= OBJECT(childobj
);
552 if (object_set_propv(obj
, errp
, vargs
) < 0) {
556 object_property_add_child(parentobj
, propname
, obj
);
558 uc
= (UserCreatable
*)object_dynamic_cast(obj
, TYPE_USER_CREATABLE
);
560 user_creatable_complete(uc
, &local_err
);
562 object_unparent(obj
);
569 * We want @obj's reference to be 1 on success, 0 on failure.
570 * On success, it's 2: one taken by object_initialize(), and one
571 * by object_property_add_child().
572 * On failure in object_initialize() or earlier, it's 1.
573 * On failure afterwards, it's also 1: object_unparent() releases
574 * the reference taken by object_property_add_child().
578 error_propagate(errp
, local_err
);
581 void object_initialize_child_internal(Object
*parent
,
582 const char *propname
,
583 void *child
, size_t size
,
586 object_initialize_child_with_props(parent
, propname
, child
, size
, type
,
590 static inline bool object_property_is_child(ObjectProperty
*prop
)
592 return strstart(prop
->type
, "child<", NULL
);
595 static void object_property_del_all(Object
*obj
)
597 g_autoptr(GHashTable
) done
= g_hash_table_new(NULL
, NULL
);
598 ObjectProperty
*prop
;
599 ObjectPropertyIterator iter
;
604 object_property_iter_init(&iter
, obj
);
605 while ((prop
= object_property_iter_next(&iter
)) != NULL
) {
606 if (g_hash_table_add(done
, prop
)) {
608 prop
->release(obj
, prop
->name
, prop
->opaque
);
616 g_hash_table_unref(obj
->properties
);
619 static void object_property_del_child(Object
*obj
, Object
*child
)
621 ObjectProperty
*prop
;
625 g_hash_table_iter_init(&iter
, obj
->properties
);
626 while (g_hash_table_iter_next(&iter
, &key
, &value
)) {
628 if (object_property_is_child(prop
) && prop
->opaque
== child
) {
630 prop
->release(obj
, prop
->name
, prop
->opaque
);
631 prop
->release
= NULL
;
636 g_hash_table_iter_init(&iter
, obj
->properties
);
637 while (g_hash_table_iter_next(&iter
, &key
, &value
)) {
639 if (object_property_is_child(prop
) && prop
->opaque
== child
) {
640 g_hash_table_iter_remove(&iter
);
646 void object_unparent(Object
*obj
)
649 object_property_del_child(obj
->parent
, obj
);
653 static void object_deinit(Object
*obj
, TypeImpl
*type
)
655 if (type
->instance_finalize
) {
656 type
->instance_finalize(obj
);
659 if (type_has_parent(type
)) {
660 object_deinit(obj
, type_get_parent(type
));
664 static void object_finalize(void *data
)
667 TypeImpl
*ti
= obj
->class->type
;
669 object_property_del_all(obj
);
670 object_deinit(obj
, ti
);
672 g_assert(obj
->ref
== 0);
678 static Object
*object_new_with_type(Type type
)
682 g_assert(type
!= NULL
);
683 type_initialize(type
);
685 obj
= g_malloc(type
->instance_size
);
686 object_initialize_with_type(obj
, type
->instance_size
, type
);
692 Object
*object_new_with_class(ObjectClass
*klass
)
694 return object_new_with_type(klass
->type
);
697 Object
*object_new(const char *typename
)
699 TypeImpl
*ti
= type_get_by_name(typename
);
701 return object_new_with_type(ti
);
705 Object
*object_new_with_props(const char *typename
,
714 va_start(vargs
, errp
);
715 obj
= object_new_with_propv(typename
, parent
, id
, errp
, vargs
);
722 Object
*object_new_with_propv(const char *typename
,
730 Error
*local_err
= NULL
;
733 klass
= object_class_by_name(typename
);
735 error_setg(errp
, "invalid object type: %s", typename
);
739 if (object_class_is_abstract(klass
)) {
740 error_setg(errp
, "object type '%s' is abstract", typename
);
743 obj
= object_new_with_type(klass
->type
);
745 if (object_set_propv(obj
, errp
, vargs
) < 0) {
750 object_property_add_child(parent
, id
, obj
);
753 uc
= (UserCreatable
*)object_dynamic_cast(obj
, TYPE_USER_CREATABLE
);
755 user_creatable_complete(uc
, &local_err
);
758 object_unparent(obj
);
768 error_propagate(errp
, local_err
);
774 int object_set_props(Object
*obj
,
781 va_start(vargs
, errp
);
782 ret
= object_set_propv(obj
, errp
, vargs
);
789 int object_set_propv(Object
*obj
,
793 const char *propname
;
794 Error
*local_err
= NULL
;
796 propname
= va_arg(vargs
, char *);
797 while (propname
!= NULL
) {
798 const char *value
= va_arg(vargs
, char *);
800 g_assert(value
!= NULL
);
801 object_property_parse(obj
, value
, propname
, &local_err
);
803 error_propagate(errp
, local_err
);
806 propname
= va_arg(vargs
, char *);
813 Object
*object_dynamic_cast(Object
*obj
, const char *typename
)
815 if (obj
&& object_class_dynamic_cast(object_get_class(obj
), typename
)) {
822 Object
*object_dynamic_cast_assert(Object
*obj
, const char *typename
,
823 const char *file
, int line
, const char *func
)
825 trace_object_dynamic_cast_assert(obj
? obj
->class->type
->name
: "(null)",
826 typename
, file
, line
, func
);
828 #ifdef CONFIG_QOM_CAST_DEBUG
832 for (i
= 0; obj
&& i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
833 if (atomic_read(&obj
->class->object_cast_cache
[i
]) == typename
) {
838 inst
= object_dynamic_cast(obj
, typename
);
841 fprintf(stderr
, "%s:%d:%s: Object %p is not an instance of type %s\n",
842 file
, line
, func
, obj
, typename
);
848 if (obj
&& obj
== inst
) {
849 for (i
= 1; i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
850 atomic_set(&obj
->class->object_cast_cache
[i
- 1],
851 atomic_read(&obj
->class->object_cast_cache
[i
]));
853 atomic_set(&obj
->class->object_cast_cache
[i
- 1], typename
);
861 ObjectClass
*object_class_dynamic_cast(ObjectClass
*class,
862 const char *typename
)
864 ObjectClass
*ret
= NULL
;
865 TypeImpl
*target_type
;
872 /* A simple fast path that can trigger a lot for leaf classes. */
874 if (type
->name
== typename
) {
878 target_type
= type_get_by_name(typename
);
880 /* target class type unknown, so fail the cast */
884 if (type
->class->interfaces
&&
885 type_is_ancestor(target_type
, type_interface
)) {
889 for (i
= class->interfaces
; i
; i
= i
->next
) {
890 ObjectClass
*target_class
= i
->data
;
892 if (type_is_ancestor(target_class
->type
, target_type
)) {
898 /* The match was ambiguous, don't allow a cast */
902 } else if (type_is_ancestor(type
, target_type
)) {
909 ObjectClass
*object_class_dynamic_cast_assert(ObjectClass
*class,
910 const char *typename
,
911 const char *file
, int line
,
916 trace_object_class_dynamic_cast_assert(class ? class->type
->name
: "(null)",
917 typename
, file
, line
, func
);
919 #ifdef CONFIG_QOM_CAST_DEBUG
922 for (i
= 0; class && i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
923 if (atomic_read(&class->class_cast_cache
[i
]) == typename
) {
929 if (!class || !class->interfaces
) {
934 ret
= object_class_dynamic_cast(class, typename
);
936 fprintf(stderr
, "%s:%d:%s: Object %p is not an instance of type %s\n",
937 file
, line
, func
, class, typename
);
941 #ifdef CONFIG_QOM_CAST_DEBUG
942 if (class && ret
== class) {
943 for (i
= 1; i
< OBJECT_CLASS_CAST_CACHE
; i
++) {
944 atomic_set(&class->class_cast_cache
[i
- 1],
945 atomic_read(&class->class_cast_cache
[i
]));
947 atomic_set(&class->class_cast_cache
[i
- 1], typename
);
954 const char *object_get_typename(const Object
*obj
)
956 return obj
->class->type
->name
;
959 ObjectClass
*object_get_class(Object
*obj
)
964 bool object_class_is_abstract(ObjectClass
*klass
)
966 return klass
->type
->abstract
;
969 const char *object_class_get_name(ObjectClass
*klass
)
971 return klass
->type
->name
;
974 ObjectClass
*object_class_by_name(const char *typename
)
976 TypeImpl
*type
= type_get_by_name(typename
);
982 type_initialize(type
);
987 ObjectClass
*module_object_class_by_name(const char *typename
)
991 oc
= object_class_by_name(typename
);
992 #ifdef CONFIG_MODULES
994 module_load_qom_one(typename
);
995 oc
= object_class_by_name(typename
);
1001 ObjectClass
*object_class_get_parent(ObjectClass
*class)
1003 TypeImpl
*type
= type_get_parent(class->type
);
1009 type_initialize(type
);
1014 typedef struct OCFData
1016 void (*fn
)(ObjectClass
*klass
, void *opaque
);
1017 const char *implements_type
;
1018 bool include_abstract
;
1022 static void object_class_foreach_tramp(gpointer key
, gpointer value
,
1025 OCFData
*data
= opaque
;
1026 TypeImpl
*type
= value
;
1029 type_initialize(type
);
1032 if (!data
->include_abstract
&& type
->abstract
) {
1036 if (data
->implements_type
&&
1037 !object_class_dynamic_cast(k
, data
->implements_type
)) {
1041 data
->fn(k
, data
->opaque
);
1044 void object_class_foreach(void (*fn
)(ObjectClass
*klass
, void *opaque
),
1045 const char *implements_type
, bool include_abstract
,
1048 OCFData data
= { fn
, implements_type
, include_abstract
, opaque
};
1050 enumerating_types
= true;
1051 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp
, &data
);
1052 enumerating_types
= false;
1055 static int do_object_child_foreach(Object
*obj
,
1056 int (*fn
)(Object
*child
, void *opaque
),
1057 void *opaque
, bool recurse
)
1059 GHashTableIter iter
;
1060 ObjectProperty
*prop
;
1063 g_hash_table_iter_init(&iter
, obj
->properties
);
1064 while (g_hash_table_iter_next(&iter
, NULL
, (gpointer
*)&prop
)) {
1065 if (object_property_is_child(prop
)) {
1066 Object
*child
= prop
->opaque
;
1068 ret
= fn(child
, opaque
);
1073 ret
= do_object_child_foreach(child
, fn
, opaque
, true);
1083 int object_child_foreach(Object
*obj
, int (*fn
)(Object
*child
, void *opaque
),
1086 return do_object_child_foreach(obj
, fn
, opaque
, false);
1089 int object_child_foreach_recursive(Object
*obj
,
1090 int (*fn
)(Object
*child
, void *opaque
),
1093 return do_object_child_foreach(obj
, fn
, opaque
, true);
1096 static void object_class_get_list_tramp(ObjectClass
*klass
, void *opaque
)
1098 GSList
**list
= opaque
;
1100 *list
= g_slist_prepend(*list
, klass
);
1103 GSList
*object_class_get_list(const char *implements_type
,
1104 bool include_abstract
)
1106 GSList
*list
= NULL
;
1108 object_class_foreach(object_class_get_list_tramp
,
1109 implements_type
, include_abstract
, &list
);
1113 static gint
object_class_cmp(gconstpointer a
, gconstpointer b
)
1115 return strcasecmp(object_class_get_name((ObjectClass
*)a
),
1116 object_class_get_name((ObjectClass
*)b
));
1119 GSList
*object_class_get_list_sorted(const char *implements_type
,
1120 bool include_abstract
)
1122 return g_slist_sort(object_class_get_list(implements_type
, include_abstract
),
1126 Object
*object_ref(Object
*obj
)
1131 atomic_inc(&obj
->ref
);
1135 void object_unref(Object
*obj
)
1140 g_assert(obj
->ref
> 0);
1142 /* parent always holds a reference to its children */
1143 if (atomic_fetch_dec(&obj
->ref
) == 1) {
1144 object_finalize(obj
);
1148 static ObjectProperty
*
1149 object_property_try_add(Object
*obj
, const char *name
, const char *type
,
1150 ObjectPropertyAccessor
*get
,
1151 ObjectPropertyAccessor
*set
,
1152 ObjectPropertyRelease
*release
,
1153 void *opaque
, Error
**errp
)
1155 ObjectProperty
*prop
;
1156 size_t name_len
= strlen(name
);
1158 if (name_len
>= 3 && !memcmp(name
+ name_len
- 3, "[*]", 4)) {
1160 ObjectProperty
*ret
;
1161 char *name_no_array
= g_strdup(name
);
1163 name_no_array
[name_len
- 3] = '\0';
1164 for (i
= 0; ; ++i
) {
1165 char *full_name
= g_strdup_printf("%s[%d]", name_no_array
, i
);
1167 ret
= object_property_try_add(obj
, full_name
, type
, get
, set
,
1168 release
, opaque
, NULL
);
1174 g_free(name_no_array
);
1178 if (object_property_find(obj
, name
, NULL
) != NULL
) {
1179 error_setg(errp
, "attempt to add duplicate property '%s' to object (type '%s')",
1180 name
, object_get_typename(obj
));
1184 prop
= g_malloc0(sizeof(*prop
));
1186 prop
->name
= g_strdup(name
);
1187 prop
->type
= g_strdup(type
);
1191 prop
->release
= release
;
1192 prop
->opaque
= opaque
;
1194 g_hash_table_insert(obj
->properties
, prop
->name
, prop
);
1199 object_property_add(Object
*obj
, const char *name
, const char *type
,
1200 ObjectPropertyAccessor
*get
,
1201 ObjectPropertyAccessor
*set
,
1202 ObjectPropertyRelease
*release
,
1205 return object_property_try_add(obj
, name
, type
, get
, set
, release
,
1206 opaque
, &error_abort
);
1210 object_class_property_add(ObjectClass
*klass
,
1213 ObjectPropertyAccessor
*get
,
1214 ObjectPropertyAccessor
*set
,
1215 ObjectPropertyRelease
*release
,
1218 ObjectProperty
*prop
;
1220 assert(!object_class_property_find(klass
, name
, NULL
));
1222 prop
= g_malloc0(sizeof(*prop
));
1224 prop
->name
= g_strdup(name
);
1225 prop
->type
= g_strdup(type
);
1229 prop
->release
= release
;
1230 prop
->opaque
= opaque
;
1232 g_hash_table_insert(klass
->properties
, prop
->name
, prop
);
1237 ObjectProperty
*object_property_find(Object
*obj
, const char *name
,
1240 ObjectProperty
*prop
;
1241 ObjectClass
*klass
= object_get_class(obj
);
1243 prop
= object_class_property_find(klass
, name
, NULL
);
1248 prop
= g_hash_table_lookup(obj
->properties
, name
);
1253 error_setg(errp
, "Property '.%s' not found", name
);
1257 void object_property_iter_init(ObjectPropertyIterator
*iter
,
1260 g_hash_table_iter_init(&iter
->iter
, obj
->properties
);
1261 iter
->nextclass
= object_get_class(obj
);
1264 ObjectProperty
*object_property_iter_next(ObjectPropertyIterator
*iter
)
1267 while (!g_hash_table_iter_next(&iter
->iter
, &key
, &val
)) {
1268 if (!iter
->nextclass
) {
1271 g_hash_table_iter_init(&iter
->iter
, iter
->nextclass
->properties
);
1272 iter
->nextclass
= object_class_get_parent(iter
->nextclass
);
1277 void object_class_property_iter_init(ObjectPropertyIterator
*iter
,
1280 g_hash_table_iter_init(&iter
->iter
, klass
->properties
);
1281 iter
->nextclass
= object_class_get_parent(klass
);
1284 ObjectProperty
*object_class_property_find(ObjectClass
*klass
, const char *name
,
1287 ObjectProperty
*prop
;
1288 ObjectClass
*parent_klass
;
1290 parent_klass
= object_class_get_parent(klass
);
1292 prop
= object_class_property_find(parent_klass
, name
, NULL
);
1298 prop
= g_hash_table_lookup(klass
->properties
, name
);
1300 error_setg(errp
, "Property '.%s' not found", name
);
1305 void object_property_del(Object
*obj
, const char *name
)
1307 ObjectProperty
*prop
= g_hash_table_lookup(obj
->properties
, name
);
1309 if (prop
->release
) {
1310 prop
->release(obj
, name
, prop
->opaque
);
1312 g_hash_table_remove(obj
->properties
, name
);
1315 void object_property_get(Object
*obj
, Visitor
*v
, const char *name
,
1318 ObjectProperty
*prop
= object_property_find(obj
, name
, errp
);
1324 error_setg(errp
, QERR_PERMISSION_DENIED
);
1326 prop
->get(obj
, v
, name
, prop
->opaque
, errp
);
1330 void object_property_set(Object
*obj
, Visitor
*v
, const char *name
,
1333 ObjectProperty
*prop
= object_property_find(obj
, name
, errp
);
1339 error_setg(errp
, QERR_PERMISSION_DENIED
);
1341 prop
->set(obj
, v
, name
, prop
->opaque
, errp
);
1345 void object_property_set_str(Object
*obj
, const char *value
,
1346 const char *name
, Error
**errp
)
1348 QString
*qstr
= qstring_from_str(value
);
1349 object_property_set_qobject(obj
, QOBJECT(qstr
), name
, errp
);
1351 qobject_unref(qstr
);
1354 char *object_property_get_str(Object
*obj
, const char *name
,
1357 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1364 retval
= g_strdup(qobject_get_try_str(ret
));
1366 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
, "string");
1373 void object_property_set_link(Object
*obj
, Object
*value
,
1374 const char *name
, Error
**errp
)
1377 char *path
= object_get_canonical_path(value
);
1378 object_property_set_str(obj
, path
, name
, errp
);
1381 object_property_set_str(obj
, "", name
, errp
);
1385 Object
*object_property_get_link(Object
*obj
, const char *name
,
1388 char *str
= object_property_get_str(obj
, name
, errp
);
1389 Object
*target
= NULL
;
1392 target
= object_resolve_path(str
, NULL
);
1394 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1395 "Device '%s' not found", str
);
1403 void object_property_set_bool(Object
*obj
, bool value
,
1404 const char *name
, Error
**errp
)
1406 QBool
*qbool
= qbool_from_bool(value
);
1407 object_property_set_qobject(obj
, QOBJECT(qbool
), name
, errp
);
1409 qobject_unref(qbool
);
1412 bool object_property_get_bool(Object
*obj
, const char *name
,
1415 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1422 qbool
= qobject_to(QBool
, ret
);
1424 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
, "boolean");
1427 retval
= qbool_get_bool(qbool
);
1434 void object_property_set_int(Object
*obj
, int64_t value
,
1435 const char *name
, Error
**errp
)
1437 QNum
*qnum
= qnum_from_int(value
);
1438 object_property_set_qobject(obj
, QOBJECT(qnum
), name
, errp
);
1440 qobject_unref(qnum
);
1443 int64_t object_property_get_int(Object
*obj
, const char *name
,
1446 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1454 qnum
= qobject_to(QNum
, ret
);
1455 if (!qnum
|| !qnum_get_try_int(qnum
, &retval
)) {
1456 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
, "int");
1464 static void object_property_init_defval(Object
*obj
, ObjectProperty
*prop
)
1466 Visitor
*v
= qobject_input_visitor_new(prop
->defval
);
1468 assert(prop
->set
!= NULL
);
1469 prop
->set(obj
, v
, prop
->name
, prop
->opaque
, &error_abort
);
1474 static void object_property_set_default(ObjectProperty
*prop
, QObject
*defval
)
1476 assert(!prop
->defval
);
1477 assert(!prop
->init
);
1479 prop
->defval
= defval
;
1480 prop
->init
= object_property_init_defval
;
1483 void object_property_set_default_bool(ObjectProperty
*prop
, bool value
)
1485 object_property_set_default(prop
, QOBJECT(qbool_from_bool(value
)));
1488 void object_property_set_default_str(ObjectProperty
*prop
, const char *value
)
1490 object_property_set_default(prop
, QOBJECT(qstring_from_str(value
)));
1493 void object_property_set_default_int(ObjectProperty
*prop
, int64_t value
)
1495 object_property_set_default(prop
, QOBJECT(qnum_from_int(value
)));
1498 void object_property_set_default_uint(ObjectProperty
*prop
, uint64_t value
)
1500 object_property_set_default(prop
, QOBJECT(qnum_from_uint(value
)));
1503 void object_property_set_uint(Object
*obj
, uint64_t value
,
1504 const char *name
, Error
**errp
)
1506 QNum
*qnum
= qnum_from_uint(value
);
1508 object_property_set_qobject(obj
, QOBJECT(qnum
), name
, errp
);
1509 qobject_unref(qnum
);
1512 uint64_t object_property_get_uint(Object
*obj
, const char *name
,
1515 QObject
*ret
= object_property_get_qobject(obj
, name
, errp
);
1522 qnum
= qobject_to(QNum
, ret
);
1523 if (!qnum
|| !qnum_get_try_uint(qnum
, &retval
)) {
1524 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
, "uint");
1532 typedef struct EnumProperty
{
1533 const QEnumLookup
*lookup
;
1534 int (*get
)(Object
*, Error
**);
1535 void (*set
)(Object
*, int, Error
**);
1538 int object_property_get_enum(Object
*obj
, const char *name
,
1539 const char *typename
, Error
**errp
)
1543 ObjectProperty
*prop
= object_property_find(obj
, name
, errp
);
1544 EnumProperty
*enumprop
;
1550 if (!g_str_equal(prop
->type
, typename
)) {
1551 error_setg(errp
, "Property %s on %s is not '%s' enum type",
1552 name
, object_class_get_name(
1553 object_get_class(obj
)), typename
);
1557 enumprop
= prop
->opaque
;
1559 str
= object_property_get_str(obj
, name
, errp
);
1564 ret
= qapi_enum_parse(enumprop
->lookup
, str
, -1, errp
);
1570 void object_property_parse(Object
*obj
, const char *string
,
1571 const char *name
, Error
**errp
)
1573 Visitor
*v
= string_input_visitor_new(string
);
1574 object_property_set(obj
, v
, name
, errp
);
1578 char *object_property_print(Object
*obj
, const char *name
, bool human
,
1582 char *string
= NULL
;
1583 Error
*local_err
= NULL
;
1585 v
= string_output_visitor_new(human
, &string
);
1586 object_property_get(obj
, v
, name
, &local_err
);
1588 error_propagate(errp
, local_err
);
1592 visit_complete(v
, &string
);
1599 const char *object_property_get_type(Object
*obj
, const char *name
, Error
**errp
)
1601 ObjectProperty
*prop
= object_property_find(obj
, name
, errp
);
1609 Object
*object_get_root(void)
1611 static Object
*root
;
1614 root
= object_new("container");
1620 Object
*object_get_objects_root(void)
1622 return container_get(object_get_root(), "/objects");
1625 Object
*object_get_internal_root(void)
1627 static Object
*internal_root
;
1629 if (!internal_root
) {
1630 internal_root
= object_new("container");
1633 return internal_root
;
1636 static void object_get_child_property(Object
*obj
, Visitor
*v
,
1637 const char *name
, void *opaque
,
1640 Object
*child
= opaque
;
1643 path
= object_get_canonical_path(child
);
1644 visit_type_str(v
, name
, &path
, errp
);
1648 static Object
*object_resolve_child_property(Object
*parent
, void *opaque
,
1654 static void object_finalize_child_property(Object
*obj
, const char *name
,
1657 Object
*child
= opaque
;
1659 if (child
->class->unparent
) {
1660 (child
->class->unparent
)(child
);
1662 child
->parent
= NULL
;
1663 object_unref(child
);
1667 object_property_add_child(Object
*obj
, const char *name
,
1670 g_autofree
char *type
= NULL
;
1673 assert(!child
->parent
);
1675 type
= g_strdup_printf("child<%s>", object_get_typename(child
));
1677 op
= object_property_add(obj
, name
, type
, object_get_child_property
, NULL
,
1678 object_finalize_child_property
, child
);
1679 op
->resolve
= object_resolve_child_property
;
1681 child
->parent
= obj
;
1685 void object_property_allow_set_link(const Object
*obj
, const char *name
,
1686 Object
*val
, Error
**errp
)
1688 /* Allow the link to be set, always */
1694 Object
*target
; /* if OBJ_PROP_LINK_DIRECT, when holding the pointer */
1695 ptrdiff_t offset
; /* if OBJ_PROP_LINK_CLASS */
1697 void (*check
)(const Object
*, const char *, Object
*, Error
**);
1698 ObjectPropertyLinkFlags flags
;
1702 object_link_get_targetp(Object
*obj
, LinkProperty
*lprop
)
1704 if (lprop
->flags
& OBJ_PROP_LINK_DIRECT
) {
1705 return &lprop
->target
;
1706 } else if (lprop
->flags
& OBJ_PROP_LINK_CLASS
) {
1707 return (void *)obj
+ lprop
->offset
;
1709 return lprop
->targetp
;
1713 static void object_get_link_property(Object
*obj
, Visitor
*v
,
1714 const char *name
, void *opaque
,
1717 LinkProperty
*lprop
= opaque
;
1718 Object
**targetp
= object_link_get_targetp(obj
, lprop
);
1722 path
= object_get_canonical_path(*targetp
);
1723 visit_type_str(v
, name
, &path
, errp
);
1727 visit_type_str(v
, name
, &path
, errp
);
1732 * object_resolve_link:
1734 * Lookup an object and ensure its type matches the link property type. This
1735 * is similar to object_resolve_path() except type verification against the
1736 * link property is performed.
1738 * Returns: The matched object or NULL on path lookup failures.
1740 static Object
*object_resolve_link(Object
*obj
, const char *name
,
1741 const char *path
, Error
**errp
)
1745 bool ambiguous
= false;
1748 /* Go from link<FOO> to FOO. */
1749 type
= object_property_get_type(obj
, name
, NULL
);
1750 target_type
= g_strndup(&type
[5], strlen(type
) - 6);
1751 target
= object_resolve_path_type(path
, target_type
, &ambiguous
);
1754 error_setg(errp
, "Path '%s' does not uniquely identify an object",
1756 } else if (!target
) {
1757 target
= object_resolve_path(path
, &ambiguous
);
1758 if (target
|| ambiguous
) {
1759 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
, target_type
);
1761 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1762 "Device '%s' not found", path
);
1766 g_free(target_type
);
1771 static void object_set_link_property(Object
*obj
, Visitor
*v
,
1772 const char *name
, void *opaque
,
1775 Error
*local_err
= NULL
;
1776 LinkProperty
*prop
= opaque
;
1777 Object
**targetp
= object_link_get_targetp(obj
, prop
);
1778 Object
*old_target
= *targetp
;
1782 if (!visit_type_str(v
, name
, &path
, errp
)) {
1787 new_target
= object_resolve_link(obj
, name
, path
, errp
);
1798 prop
->check(obj
, name
, new_target
, &local_err
);
1800 error_propagate(errp
, local_err
);
1804 *targetp
= new_target
;
1805 if (prop
->flags
& OBJ_PROP_LINK_STRONG
) {
1806 object_ref(new_target
);
1807 object_unref(old_target
);
1811 static Object
*object_resolve_link_property(Object
*parent
, void *opaque
,
1814 LinkProperty
*lprop
= opaque
;
1816 return *object_link_get_targetp(parent
, lprop
);
1819 static void object_release_link_property(Object
*obj
, const char *name
,
1822 LinkProperty
*prop
= opaque
;
1823 Object
**targetp
= object_link_get_targetp(obj
, prop
);
1825 if ((prop
->flags
& OBJ_PROP_LINK_STRONG
) && *targetp
) {
1826 object_unref(*targetp
);
1828 if (!(prop
->flags
& OBJ_PROP_LINK_CLASS
)) {
1833 static ObjectProperty
*
1834 object_add_link_prop(Object
*obj
, const char *name
,
1835 const char *type
, void *ptr
,
1836 void (*check
)(const Object
*, const char *,
1837 Object
*, Error
**),
1838 ObjectPropertyLinkFlags flags
)
1840 LinkProperty
*prop
= g_malloc(sizeof(*prop
));
1841 g_autofree
char *full_type
= NULL
;
1844 if (flags
& OBJ_PROP_LINK_DIRECT
) {
1847 prop
->targetp
= ptr
;
1849 prop
->check
= check
;
1850 prop
->flags
= flags
;
1852 full_type
= g_strdup_printf("link<%s>", type
);
1854 op
= object_property_add(obj
, name
, full_type
,
1855 object_get_link_property
,
1856 check
? object_set_link_property
: NULL
,
1857 object_release_link_property
,
1859 op
->resolve
= object_resolve_link_property
;
1864 object_property_add_link(Object
*obj
, const char *name
,
1865 const char *type
, Object
**targetp
,
1866 void (*check
)(const Object
*, const char *,
1867 Object
*, Error
**),
1868 ObjectPropertyLinkFlags flags
)
1870 return object_add_link_prop(obj
, name
, type
, targetp
, check
, flags
);
1874 object_class_property_add_link(ObjectClass
*oc
,
1876 const char *type
, ptrdiff_t offset
,
1877 void (*check
)(const Object
*obj
, const char *name
,
1878 Object
*val
, Error
**errp
),
1879 ObjectPropertyLinkFlags flags
)
1881 LinkProperty
*prop
= g_new0(LinkProperty
, 1);
1885 prop
->offset
= offset
;
1886 prop
->check
= check
;
1887 prop
->flags
= flags
| OBJ_PROP_LINK_CLASS
;
1889 full_type
= g_strdup_printf("link<%s>", type
);
1891 op
= object_class_property_add(oc
, name
, full_type
,
1892 object_get_link_property
,
1893 check
? object_set_link_property
: NULL
,
1894 object_release_link_property
,
1897 op
->resolve
= object_resolve_link_property
;
1904 object_property_add_const_link(Object
*obj
, const char *name
,
1907 return object_add_link_prop(obj
, name
,
1908 object_get_typename(target
), target
,
1909 NULL
, OBJ_PROP_LINK_DIRECT
);
1912 char *object_get_canonical_path_component(const Object
*obj
)
1914 ObjectProperty
*prop
= NULL
;
1915 GHashTableIter iter
;
1917 if (obj
->parent
== NULL
) {
1921 g_hash_table_iter_init(&iter
, obj
->parent
->properties
);
1922 while (g_hash_table_iter_next(&iter
, NULL
, (gpointer
*)&prop
)) {
1923 if (!object_property_is_child(prop
)) {
1927 if (prop
->opaque
== obj
) {
1928 return g_strdup(prop
->name
);
1932 /* obj had a parent but was not a child, should never happen */
1933 g_assert_not_reached();
1937 char *object_get_canonical_path(const Object
*obj
)
1939 Object
*root
= object_get_root();
1940 char *newpath
, *path
= NULL
;
1943 return g_strdup("/");
1947 char *component
= object_get_canonical_path_component(obj
);
1950 /* A canonical path must be complete, so discard what was
1957 newpath
= g_strdup_printf("/%s%s", component
, path
? path
: "");
1962 } while (obj
!= root
);
1967 Object
*object_resolve_path_component(Object
*parent
, const char *part
)
1969 ObjectProperty
*prop
= object_property_find(parent
, part
, NULL
);
1974 if (prop
->resolve
) {
1975 return prop
->resolve(parent
, prop
->opaque
, part
);
1981 static Object
*object_resolve_abs_path(Object
*parent
,
1983 const char *typename
)
1987 if (*parts
== NULL
) {
1988 return object_dynamic_cast(parent
, typename
);
1991 if (strcmp(*parts
, "") == 0) {
1992 return object_resolve_abs_path(parent
, parts
+ 1, typename
);
1995 child
= object_resolve_path_component(parent
, *parts
);
2000 return object_resolve_abs_path(child
, parts
+ 1, typename
);
2003 static Object
*object_resolve_partial_path(Object
*parent
,
2005 const char *typename
,
2009 GHashTableIter iter
;
2010 ObjectProperty
*prop
;
2012 obj
= object_resolve_abs_path(parent
, parts
, typename
);
2014 g_hash_table_iter_init(&iter
, parent
->properties
);
2015 while (g_hash_table_iter_next(&iter
, NULL
, (gpointer
*)&prop
)) {
2018 if (!object_property_is_child(prop
)) {
2022 found
= object_resolve_partial_path(prop
->opaque
, parts
,
2023 typename
, ambiguous
);
2040 Object
*object_resolve_path_type(const char *path
, const char *typename
,
2046 parts
= g_strsplit(path
, "/", 0);
2049 if (parts
[0] == NULL
|| strcmp(parts
[0], "") != 0) {
2050 bool ambiguous
= false;
2051 obj
= object_resolve_partial_path(object_get_root(), parts
,
2052 typename
, &ambiguous
);
2054 *ambiguousp
= ambiguous
;
2057 obj
= object_resolve_abs_path(object_get_root(), parts
+ 1, typename
);
2065 Object
*object_resolve_path(const char *path
, bool *ambiguous
)
2067 return object_resolve_path_type(path
, TYPE_OBJECT
, ambiguous
);
2070 typedef struct StringProperty
2072 char *(*get
)(Object
*, Error
**);
2073 void (*set
)(Object
*, const char *, Error
**);
2076 static void property_get_str(Object
*obj
, Visitor
*v
, const char *name
,
2077 void *opaque
, Error
**errp
)
2079 StringProperty
*prop
= opaque
;
2083 value
= prop
->get(obj
, &err
);
2085 error_propagate(errp
, err
);
2089 visit_type_str(v
, name
, &value
, errp
);
2093 static void property_set_str(Object
*obj
, Visitor
*v
, const char *name
,
2094 void *opaque
, Error
**errp
)
2096 StringProperty
*prop
= opaque
;
2098 Error
*local_err
= NULL
;
2100 if (!visit_type_str(v
, name
, &value
, &local_err
)) {
2101 error_propagate(errp
, local_err
);
2105 prop
->set(obj
, value
, errp
);
2109 static void property_release_str(Object
*obj
, const char *name
,
2112 StringProperty
*prop
= opaque
;
2117 object_property_add_str(Object
*obj
, const char *name
,
2118 char *(*get
)(Object
*, Error
**),
2119 void (*set
)(Object
*, const char *, Error
**))
2121 StringProperty
*prop
= g_malloc0(sizeof(*prop
));
2126 return object_property_add(obj
, name
, "string",
2127 get
? property_get_str
: NULL
,
2128 set
? property_set_str
: NULL
,
2129 property_release_str
,
2134 object_class_property_add_str(ObjectClass
*klass
, const char *name
,
2135 char *(*get
)(Object
*, Error
**),
2136 void (*set
)(Object
*, const char *,
2139 StringProperty
*prop
= g_malloc0(sizeof(*prop
));
2144 return object_class_property_add(klass
, name
, "string",
2145 get
? property_get_str
: NULL
,
2146 set
? property_set_str
: NULL
,
2151 typedef struct BoolProperty
2153 bool (*get
)(Object
*, Error
**);
2154 void (*set
)(Object
*, bool, Error
**);
2157 static void property_get_bool(Object
*obj
, Visitor
*v
, const char *name
,
2158 void *opaque
, Error
**errp
)
2160 BoolProperty
*prop
= opaque
;
2164 value
= prop
->get(obj
, &err
);
2166 error_propagate(errp
, err
);
2170 visit_type_bool(v
, name
, &value
, errp
);
2173 static void property_set_bool(Object
*obj
, Visitor
*v
, const char *name
,
2174 void *opaque
, Error
**errp
)
2176 BoolProperty
*prop
= opaque
;
2178 Error
*local_err
= NULL
;
2180 if (!visit_type_bool(v
, name
, &value
, &local_err
)) {
2181 error_propagate(errp
, local_err
);
2185 prop
->set(obj
, value
, errp
);
2188 static void property_release_bool(Object
*obj
, const char *name
,
2191 BoolProperty
*prop
= opaque
;
2196 object_property_add_bool(Object
*obj
, const char *name
,
2197 bool (*get
)(Object
*, Error
**),
2198 void (*set
)(Object
*, bool, Error
**))
2200 BoolProperty
*prop
= g_malloc0(sizeof(*prop
));
2205 return object_property_add(obj
, name
, "bool",
2206 get
? property_get_bool
: NULL
,
2207 set
? property_set_bool
: NULL
,
2208 property_release_bool
,
2213 object_class_property_add_bool(ObjectClass
*klass
, const char *name
,
2214 bool (*get
)(Object
*, Error
**),
2215 void (*set
)(Object
*, bool, Error
**))
2217 BoolProperty
*prop
= g_malloc0(sizeof(*prop
));
2222 return object_class_property_add(klass
, name
, "bool",
2223 get
? property_get_bool
: NULL
,
2224 set
? property_set_bool
: NULL
,
2229 static void property_get_enum(Object
*obj
, Visitor
*v
, const char *name
,
2230 void *opaque
, Error
**errp
)
2232 EnumProperty
*prop
= opaque
;
2236 value
= prop
->get(obj
, &err
);
2238 error_propagate(errp
, err
);
2242 visit_type_enum(v
, name
, &value
, prop
->lookup
, errp
);
2245 static void property_set_enum(Object
*obj
, Visitor
*v
, const char *name
,
2246 void *opaque
, Error
**errp
)
2248 EnumProperty
*prop
= opaque
;
2252 if (!visit_type_enum(v
, name
, &value
, prop
->lookup
, &err
)) {
2253 error_propagate(errp
, err
);
2256 prop
->set(obj
, value
, errp
);
2259 static void property_release_enum(Object
*obj
, const char *name
,
2262 EnumProperty
*prop
= opaque
;
2267 object_property_add_enum(Object
*obj
, const char *name
,
2268 const char *typename
,
2269 const QEnumLookup
*lookup
,
2270 int (*get
)(Object
*, Error
**),
2271 void (*set
)(Object
*, int, Error
**))
2273 EnumProperty
*prop
= g_malloc(sizeof(*prop
));
2275 prop
->lookup
= lookup
;
2279 return object_property_add(obj
, name
, typename
,
2280 get
? property_get_enum
: NULL
,
2281 set
? property_set_enum
: NULL
,
2282 property_release_enum
,
2287 object_class_property_add_enum(ObjectClass
*klass
, const char *name
,
2288 const char *typename
,
2289 const QEnumLookup
*lookup
,
2290 int (*get
)(Object
*, Error
**),
2291 void (*set
)(Object
*, int, Error
**))
2293 EnumProperty
*prop
= g_malloc(sizeof(*prop
));
2295 prop
->lookup
= lookup
;
2299 return object_class_property_add(klass
, name
, typename
,
2300 get
? property_get_enum
: NULL
,
2301 set
? property_set_enum
: NULL
,
2306 typedef struct TMProperty
{
2307 void (*get
)(Object
*, struct tm
*, Error
**);
2310 static void property_get_tm(Object
*obj
, Visitor
*v
, const char *name
,
2311 void *opaque
, Error
**errp
)
2313 TMProperty
*prop
= opaque
;
2317 prop
->get(obj
, &value
, &err
);
2322 if (!visit_start_struct(v
, name
, NULL
, 0, &err
)) {
2325 if (!visit_type_int32(v
, "tm_year", &value
.tm_year
, &err
)) {
2328 if (!visit_type_int32(v
, "tm_mon", &value
.tm_mon
, &err
)) {
2331 if (!visit_type_int32(v
, "tm_mday", &value
.tm_mday
, &err
)) {
2334 if (!visit_type_int32(v
, "tm_hour", &value
.tm_hour
, &err
)) {
2337 if (!visit_type_int32(v
, "tm_min", &value
.tm_min
, &err
)) {
2340 if (!visit_type_int32(v
, "tm_sec", &value
.tm_sec
, &err
)) {
2343 visit_check_struct(v
, &err
);
2345 visit_end_struct(v
, NULL
);
2347 error_propagate(errp
, err
);
2351 static void property_release_tm(Object
*obj
, const char *name
,
2354 TMProperty
*prop
= opaque
;
2359 object_property_add_tm(Object
*obj
, const char *name
,
2360 void (*get
)(Object
*, struct tm
*, Error
**))
2362 TMProperty
*prop
= g_malloc0(sizeof(*prop
));
2366 return object_property_add(obj
, name
, "struct tm",
2367 get
? property_get_tm
: NULL
, NULL
,
2368 property_release_tm
,
2373 object_class_property_add_tm(ObjectClass
*klass
, const char *name
,
2374 void (*get
)(Object
*, struct tm
*, Error
**))
2376 TMProperty
*prop
= g_malloc0(sizeof(*prop
));
2380 return object_class_property_add(klass
, name
, "struct tm",
2381 get
? property_get_tm
: NULL
,
2385 static char *object_get_type(Object
*obj
, Error
**errp
)
2387 return g_strdup(object_get_typename(obj
));
2390 static void property_get_uint8_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2391 void *opaque
, Error
**errp
)
2393 uint8_t value
= *(uint8_t *)opaque
;
2394 visit_type_uint8(v
, name
, &value
, errp
);
2397 static void property_set_uint8_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2398 void *opaque
, Error
**errp
)
2400 uint8_t *field
= opaque
;
2402 Error
*local_err
= NULL
;
2404 if (!visit_type_uint8(v
, name
, &value
, &local_err
)) {
2405 error_propagate(errp
, local_err
);
2412 static void property_get_uint16_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2413 void *opaque
, Error
**errp
)
2415 uint16_t value
= *(uint16_t *)opaque
;
2416 visit_type_uint16(v
, name
, &value
, errp
);
2419 static void property_set_uint16_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2420 void *opaque
, Error
**errp
)
2422 uint16_t *field
= opaque
;
2424 Error
*local_err
= NULL
;
2426 if (!visit_type_uint16(v
, name
, &value
, &local_err
)) {
2427 error_propagate(errp
, local_err
);
2434 static void property_get_uint32_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2435 void *opaque
, Error
**errp
)
2437 uint32_t value
= *(uint32_t *)opaque
;
2438 visit_type_uint32(v
, name
, &value
, errp
);
2441 static void property_set_uint32_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2442 void *opaque
, Error
**errp
)
2444 uint32_t *field
= opaque
;
2446 Error
*local_err
= NULL
;
2448 if (!visit_type_uint32(v
, name
, &value
, &local_err
)) {
2449 error_propagate(errp
, local_err
);
2456 static void property_get_uint64_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2457 void *opaque
, Error
**errp
)
2459 uint64_t value
= *(uint64_t *)opaque
;
2460 visit_type_uint64(v
, name
, &value
, errp
);
2463 static void property_set_uint64_ptr(Object
*obj
, Visitor
*v
, const char *name
,
2464 void *opaque
, Error
**errp
)
2466 uint64_t *field
= opaque
;
2468 Error
*local_err
= NULL
;
2470 if (!visit_type_uint64(v
, name
, &value
, &local_err
)) {
2471 error_propagate(errp
, local_err
);
2479 object_property_add_uint8_ptr(Object
*obj
, const char *name
,
2481 ObjectPropertyFlags flags
)
2483 ObjectPropertyAccessor
*getter
= NULL
;
2484 ObjectPropertyAccessor
*setter
= NULL
;
2486 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2487 getter
= property_get_uint8_ptr
;
2490 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2491 setter
= property_set_uint8_ptr
;
2494 return object_property_add(obj
, name
, "uint8",
2495 getter
, setter
, NULL
, (void *)v
);
2499 object_class_property_add_uint8_ptr(ObjectClass
*klass
, const char *name
,
2501 ObjectPropertyFlags flags
)
2503 ObjectPropertyAccessor
*getter
= NULL
;
2504 ObjectPropertyAccessor
*setter
= NULL
;
2506 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2507 getter
= property_get_uint8_ptr
;
2510 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2511 setter
= property_set_uint8_ptr
;
2514 return object_class_property_add(klass
, name
, "uint8",
2515 getter
, setter
, NULL
, (void *)v
);
2519 object_property_add_uint16_ptr(Object
*obj
, const char *name
,
2521 ObjectPropertyFlags flags
)
2523 ObjectPropertyAccessor
*getter
= NULL
;
2524 ObjectPropertyAccessor
*setter
= NULL
;
2526 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2527 getter
= property_get_uint16_ptr
;
2530 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2531 setter
= property_set_uint16_ptr
;
2534 return object_property_add(obj
, name
, "uint16",
2535 getter
, setter
, NULL
, (void *)v
);
2539 object_class_property_add_uint16_ptr(ObjectClass
*klass
, const char *name
,
2541 ObjectPropertyFlags flags
)
2543 ObjectPropertyAccessor
*getter
= NULL
;
2544 ObjectPropertyAccessor
*setter
= NULL
;
2546 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2547 getter
= property_get_uint16_ptr
;
2550 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2551 setter
= property_set_uint16_ptr
;
2554 return object_class_property_add(klass
, name
, "uint16",
2555 getter
, setter
, NULL
, (void *)v
);
2559 object_property_add_uint32_ptr(Object
*obj
, const char *name
,
2561 ObjectPropertyFlags flags
)
2563 ObjectPropertyAccessor
*getter
= NULL
;
2564 ObjectPropertyAccessor
*setter
= NULL
;
2566 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2567 getter
= property_get_uint32_ptr
;
2570 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2571 setter
= property_set_uint32_ptr
;
2574 return object_property_add(obj
, name
, "uint32",
2575 getter
, setter
, NULL
, (void *)v
);
2579 object_class_property_add_uint32_ptr(ObjectClass
*klass
, const char *name
,
2581 ObjectPropertyFlags flags
)
2583 ObjectPropertyAccessor
*getter
= NULL
;
2584 ObjectPropertyAccessor
*setter
= NULL
;
2586 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2587 getter
= property_get_uint32_ptr
;
2590 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2591 setter
= property_set_uint32_ptr
;
2594 return object_class_property_add(klass
, name
, "uint32",
2595 getter
, setter
, NULL
, (void *)v
);
2599 object_property_add_uint64_ptr(Object
*obj
, const char *name
,
2601 ObjectPropertyFlags flags
)
2603 ObjectPropertyAccessor
*getter
= NULL
;
2604 ObjectPropertyAccessor
*setter
= NULL
;
2606 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2607 getter
= property_get_uint64_ptr
;
2610 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2611 setter
= property_set_uint64_ptr
;
2614 return object_property_add(obj
, name
, "uint64",
2615 getter
, setter
, NULL
, (void *)v
);
2619 object_class_property_add_uint64_ptr(ObjectClass
*klass
, const char *name
,
2621 ObjectPropertyFlags flags
)
2623 ObjectPropertyAccessor
*getter
= NULL
;
2624 ObjectPropertyAccessor
*setter
= NULL
;
2626 if ((flags
& OBJ_PROP_FLAG_READ
) == OBJ_PROP_FLAG_READ
) {
2627 getter
= property_get_uint64_ptr
;
2630 if ((flags
& OBJ_PROP_FLAG_WRITE
) == OBJ_PROP_FLAG_WRITE
) {
2631 setter
= property_set_uint64_ptr
;
2634 return object_class_property_add(klass
, name
, "uint64",
2635 getter
, setter
, NULL
, (void *)v
);
2643 static void property_get_alias(Object
*obj
, Visitor
*v
, const char *name
,
2644 void *opaque
, Error
**errp
)
2646 AliasProperty
*prop
= opaque
;
2648 object_property_get(prop
->target_obj
, v
, prop
->target_name
, errp
);
2651 static void property_set_alias(Object
*obj
, Visitor
*v
, const char *name
,
2652 void *opaque
, Error
**errp
)
2654 AliasProperty
*prop
= opaque
;
2656 object_property_set(prop
->target_obj
, v
, prop
->target_name
, errp
);
2659 static Object
*property_resolve_alias(Object
*obj
, void *opaque
,
2662 AliasProperty
*prop
= opaque
;
2664 return object_resolve_path_component(prop
->target_obj
, prop
->target_name
);
2667 static void property_release_alias(Object
*obj
, const char *name
, void *opaque
)
2669 AliasProperty
*prop
= opaque
;
2671 g_free(prop
->target_name
);
2676 object_property_add_alias(Object
*obj
, const char *name
,
2677 Object
*target_obj
, const char *target_name
)
2679 AliasProperty
*prop
;
2681 ObjectProperty
*target_prop
;
2682 g_autofree
char *prop_type
= NULL
;
2684 target_prop
= object_property_find(target_obj
, target_name
,
2687 if (object_property_is_child(target_prop
)) {
2688 prop_type
= g_strdup_printf("link%s",
2689 target_prop
->type
+ strlen("child"));
2691 prop_type
= g_strdup(target_prop
->type
);
2694 prop
= g_malloc(sizeof(*prop
));
2695 prop
->target_obj
= target_obj
;
2696 prop
->target_name
= g_strdup(target_name
);
2698 op
= object_property_add(obj
, name
, prop_type
,
2701 property_release_alias
,
2703 op
->resolve
= property_resolve_alias
;
2704 if (target_prop
->defval
) {
2705 op
->defval
= qobject_ref(target_prop
->defval
);
2708 object_property_set_description(obj
, op
->name
,
2709 target_prop
->description
);
2713 void object_property_set_description(Object
*obj
, const char *name
,
2714 const char *description
)
2718 op
= object_property_find(obj
, name
, &error_abort
);
2719 g_free(op
->description
);
2720 op
->description
= g_strdup(description
);
2723 void object_class_property_set_description(ObjectClass
*klass
,
2725 const char *description
)
2729 op
= g_hash_table_lookup(klass
->properties
, name
);
2730 g_free(op
->description
);
2731 op
->description
= g_strdup(description
);
2734 static void object_class_init(ObjectClass
*klass
, void *data
)
2736 object_class_property_add_str(klass
, "type", object_get_type
,
2740 static void register_types(void)
2742 static TypeInfo interface_info
= {
2743 .name
= TYPE_INTERFACE
,
2744 .class_size
= sizeof(InterfaceClass
),
2748 static TypeInfo object_info
= {
2749 .name
= TYPE_OBJECT
,
2750 .instance_size
= sizeof(Object
),
2751 .class_init
= object_class_init
,
2755 type_interface
= type_register_internal(&interface_info
);
2756 type_register_internal(&object_info
);
2759 type_init(register_types
)