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 "qapi/error.h"
15 #include "qom/object.h"
16 #include "qom/object_interfaces.h"
17 #include "qemu/cutils.h"
18 #include "qapi/visitor.h"
19 #include "qapi-visit.h"
20 #include "qapi/string-input-visitor.h"
21 #include "qapi/string-output-visitor.h"
22 #include "qapi/qmp/qerror.h"
25 /* TODO: replace QObject with a simpler visitor to avoid a dependency
26 * of the QOM core on QObject? */
27 #include "qom/qom-qobject.h"
28 #include "qapi/qmp/qobject.h"
29 #include "qapi/qmp/qbool.h"
30 #include "qapi/qmp/qint.h"
31 #include "qapi/qmp/qstring.h"
33 #define MAX_INTERFACES 32
35 typedef struct InterfaceImpl InterfaceImpl;
36 typedef struct TypeImpl TypeImpl;
51 void (*class_init)(ObjectClass *klass, void *data);
52 void (*class_base_init)(ObjectClass *klass, void *data);
53 void (*class_finalize)(ObjectClass *klass, void *data);
57 void (*instance_init)(Object *obj);
58 void (*instance_post_init)(Object *obj);
59 void (*instance_finalize)(Object *obj);
64 TypeImpl *parent_type;
69 InterfaceImpl interfaces[MAX_INTERFACES];
72 static Type type_interface;
74 static GHashTable *type_table_get(void)
76 static GHashTable *type_table;
78 if (type_table == NULL) {
79 type_table = g_hash_table_new(g_str_hash, g_str_equal);
85 static bool enumerating_types;
87 static void type_table_add(TypeImpl *ti)
89 assert(!enumerating_types);
90 g_hash_table_insert(type_table_get(), (void *)ti->name, ti);
93 static TypeImpl *type_table_lookup(const char *name)
95 return g_hash_table_lookup(type_table_get(), name);
98 static TypeImpl *type_new(const TypeInfo *info)
100 TypeImpl *ti = g_malloc0(sizeof(*ti));
103 g_assert(info->name != NULL);
105 if (type_table_lookup(info->name) != NULL) {
106 fprintf(stderr, "Registering `%s' which already exists\n", info->name);
110 ti->name = g_strdup(info->name);
111 ti->parent = g_strdup(info->parent);
113 ti->class_size = info->class_size;
114 ti->instance_size = info->instance_size;
116 ti->class_init = info->class_init;
117 ti->class_base_init = info->class_base_init;
118 ti->class_finalize = info->class_finalize;
119 ti->class_data = info->class_data;
121 ti->instance_init = info->instance_init;
122 ti->instance_post_init = info->instance_post_init;
123 ti->instance_finalize = info->instance_finalize;
125 ti->abstract = info->abstract;
127 for (i = 0; info->interfaces && info->interfaces[i].type; i++) {
128 ti->interfaces[i].typename = g_strdup(info->interfaces[i].type);
130 ti->num_interfaces = i;
135 static TypeImpl *type_register_internal(const TypeInfo *info)
144 TypeImpl *type_register(const TypeInfo *info)
146 assert(info->parent);
147 return type_register_internal(info);
150 TypeImpl *type_register_static(const TypeInfo *info)
152 return type_register(info);
155 static TypeImpl *type_get_by_name(const char *name)
161 return type_table_lookup(name);
164 static TypeImpl *type_get_parent(TypeImpl *type)
166 if (!type->parent_type && type->parent) {
167 type->parent_type = type_get_by_name(type->parent);
168 g_assert(type->parent_type != NULL);
171 return type->parent_type;
174 static bool type_has_parent(TypeImpl *type)
176 return (type->parent != NULL);
179 static size_t type_class_get_size(TypeImpl *ti)
181 if (ti->class_size) {
182 return ti->class_size;
185 if (type_has_parent(ti)) {
186 return type_class_get_size(type_get_parent(ti));
189 return sizeof(ObjectClass);
192 static size_t type_object_get_size(TypeImpl *ti)
194 if (ti->instance_size) {
195 return ti->instance_size;
198 if (type_has_parent(ti)) {
199 return type_object_get_size(type_get_parent(ti));
205 static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
209 /* Check if target_type is a direct ancestor of type */
211 if (type == target_type) {
215 type = type_get_parent(type);
221 static void type_initialize(TypeImpl *ti);
223 static void type_initialize_interface(TypeImpl *ti, TypeImpl *interface_type,
224 TypeImpl *parent_type)
226 InterfaceClass *new_iface;
228 TypeImpl *iface_impl;
230 info.parent = parent_type->name;
231 info.name = g_strdup_printf("%s::%s", ti->name, interface_type->name);
232 info.abstract = true;
234 iface_impl = type_new(&info);
235 iface_impl->parent_type = parent_type;
236 type_initialize(iface_impl);
237 g_free((char *)info.name);
239 new_iface = (InterfaceClass *)iface_impl->class;
240 new_iface->concrete_class = ti->class;
241 new_iface->interface_type = interface_type;
243 ti->class->interfaces = g_slist_append(ti->class->interfaces,
247 static void object_property_free(gpointer data)
249 ObjectProperty *prop = data;
253 g_free(prop->description);
257 static void type_initialize(TypeImpl *ti)
265 ti->class_size = type_class_get_size(ti);
266 ti->instance_size = type_object_get_size(ti);
268 ti->class = g_malloc0(ti->class_size);
270 parent = type_get_parent(ti);
272 type_initialize(parent);
276 g_assert_cmpint(parent->class_size, <=, ti->class_size);
277 memcpy(ti->class, parent->class, parent->class_size);
278 ti->class->interfaces = NULL;
279 ti->class->properties = g_hash_table_new_full(
280 g_str_hash, g_str_equal, g_free, object_property_free);
282 for (e = parent->class->interfaces; e; e = e->next) {
283 InterfaceClass *iface = e->data;
284 ObjectClass *klass = OBJECT_CLASS(iface);
286 type_initialize_interface(ti, iface->interface_type, klass->type);
289 for (i = 0; i < ti->num_interfaces; i++) {
290 TypeImpl *t = type_get_by_name(ti->interfaces[i].typename);
291 for (e = ti->class->interfaces; e; e = e->next) {
292 TypeImpl *target_type = OBJECT_CLASS(e->data)->type;
294 if (type_is_ancestor(target_type, t)) {
303 type_initialize_interface(ti, t, t);
306 ti->class->properties = g_hash_table_new_full(
307 g_str_hash, g_str_equal, g_free, object_property_free);
310 ti->class->type = ti;
313 if (parent->class_base_init) {
314 parent->class_base_init(ti->class, ti->class_data);
316 parent = type_get_parent(parent);
319 if (ti->class_init) {
320 ti->class_init(ti->class, ti->class_data);
324 static void object_init_with_type(Object *obj, TypeImpl *ti)
326 if (type_has_parent(ti)) {
327 object_init_with_type(obj, type_get_parent(ti));
330 if (ti->instance_init) {
331 ti->instance_init(obj);
335 static void object_post_init_with_type(Object *obj, TypeImpl *ti)
337 if (ti->instance_post_init) {
338 ti->instance_post_init(obj);
341 if (type_has_parent(ti)) {
342 object_post_init_with_type(obj, type_get_parent(ti));
346 void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
350 g_assert(type != NULL);
351 type_initialize(type);
353 g_assert_cmpint(type->instance_size, >=, sizeof(Object));
354 g_assert(type->abstract == false);
355 g_assert_cmpint(size, >=, type->instance_size);
357 memset(obj, 0, type->instance_size);
358 obj->class = type->class;
360 obj->properties = g_hash_table_new_full(g_str_hash, g_str_equal,
361 NULL, object_property_free);
362 object_init_with_type(obj, type);
363 object_post_init_with_type(obj, type);
366 void object_initialize(void *data, size_t size, const char *typename)
368 TypeImpl *type = type_get_by_name(typename);
370 object_initialize_with_type(data, size, type);
373 static inline bool object_property_is_child(ObjectProperty *prop)
375 return strstart(prop->type, "child<", NULL);
378 static void object_property_del_all(Object *obj)
380 ObjectProperty *prop;
387 g_hash_table_iter_init(&iter, obj->properties);
388 while (g_hash_table_iter_next(&iter, &key, &value)) {
391 prop->release(obj, prop->name, prop->opaque);
392 prop->release = NULL;
396 g_hash_table_iter_remove(&iter);
400 g_hash_table_unref(obj->properties);
403 static void object_property_del_child(Object *obj, Object *child, Error **errp)
405 ObjectProperty *prop;
409 g_hash_table_iter_init(&iter, obj->properties);
410 while (g_hash_table_iter_next(&iter, &key, &value)) {
412 if (object_property_is_child(prop) && prop->opaque == child) {
414 prop->release(obj, prop->name, prop->opaque);
415 prop->release = NULL;
420 g_hash_table_iter_init(&iter, obj->properties);
421 while (g_hash_table_iter_next(&iter, &key, &value)) {
423 if (object_property_is_child(prop) && prop->opaque == child) {
424 g_hash_table_iter_remove(&iter);
430 void object_unparent(Object *obj)
433 object_property_del_child(obj->parent, obj, NULL);
437 static void object_deinit(Object *obj, TypeImpl *type)
439 if (type->instance_finalize) {
440 type->instance_finalize(obj);
443 if (type_has_parent(type)) {
444 object_deinit(obj, type_get_parent(type));
448 static void object_finalize(void *data)
451 TypeImpl *ti = obj->class->type;
453 object_property_del_all(obj);
454 object_deinit(obj, ti);
456 g_assert_cmpint(obj->ref, ==, 0);
462 Object *object_new_with_type(Type type)
466 g_assert(type != NULL);
467 type_initialize(type);
469 obj = g_malloc(type->instance_size);
470 object_initialize_with_type(obj, type->instance_size, type);
476 Object *object_new(const char *typename)
478 TypeImpl *ti = type_get_by_name(typename);
480 return object_new_with_type(ti);
484 Object *object_new_with_props(const char *typename,
493 va_start(vargs, errp);
494 obj = object_new_with_propv(typename, parent, id, errp, vargs);
501 Object *object_new_with_propv(const char *typename,
509 Error *local_err = NULL;
511 klass = object_class_by_name(typename);
513 error_setg(errp, "invalid object type: %s", typename);
517 if (object_class_is_abstract(klass)) {
518 error_setg(errp, "object type '%s' is abstract", typename);
521 obj = object_new(typename);
523 if (object_set_propv(obj, &local_err, vargs) < 0) {
527 object_property_add_child(parent, id, obj, &local_err);
532 if (object_dynamic_cast(obj, TYPE_USER_CREATABLE)) {
533 user_creatable_complete(obj, &local_err);
535 object_unparent(obj);
540 object_unref(OBJECT(obj));
545 error_propagate(errp, local_err);
552 int object_set_props(Object *obj,
559 va_start(vargs, errp);
560 ret = object_set_propv(obj, errp, vargs);
567 int object_set_propv(Object *obj,
571 const char *propname;
572 Error *local_err = NULL;
574 propname = va_arg(vargs, char *);
575 while (propname != NULL) {
576 const char *value = va_arg(vargs, char *);
578 g_assert(value != NULL);
579 object_property_parse(obj, value, propname, &local_err);
581 error_propagate(errp, local_err);
584 propname = va_arg(vargs, char *);
591 Object *object_dynamic_cast(Object *obj, const char *typename)
593 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
600 Object *object_dynamic_cast_assert(Object *obj, const char *typename,
601 const char *file, int line, const char *func)
603 trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
604 typename, file, line, func);
606 #ifdef CONFIG_QOM_CAST_DEBUG
610 for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
611 if (obj->class->object_cast_cache[i] == typename) {
616 inst = object_dynamic_cast(obj, typename);
619 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
620 file, line, func, obj, typename);
626 if (obj && obj == inst) {
627 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
628 obj->class->object_cast_cache[i - 1] =
629 obj->class->object_cast_cache[i];
631 obj->class->object_cast_cache[i - 1] = typename;
639 ObjectClass *object_class_dynamic_cast(ObjectClass *class,
640 const char *typename)
642 ObjectClass *ret = NULL;
643 TypeImpl *target_type;
650 /* A simple fast path that can trigger a lot for leaf classes. */
652 if (type->name == typename) {
656 target_type = type_get_by_name(typename);
658 /* target class type unknown, so fail the cast */
662 if (type->class->interfaces &&
663 type_is_ancestor(target_type, type_interface)) {
667 for (i = class->interfaces; i; i = i->next) {
668 ObjectClass *target_class = i->data;
670 if (type_is_ancestor(target_class->type, target_type)) {
676 /* The match was ambiguous, don't allow a cast */
680 } else if (type_is_ancestor(type, target_type)) {
687 ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
688 const char *typename,
689 const char *file, int line,
694 trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)",
695 typename, file, line, func);
697 #ifdef CONFIG_QOM_CAST_DEBUG
700 for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
701 if (class->class_cast_cache[i] == typename) {
707 if (!class || !class->interfaces) {
712 ret = object_class_dynamic_cast(class, typename);
714 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
715 file, line, func, class, typename);
719 #ifdef CONFIG_QOM_CAST_DEBUG
720 if (class && ret == class) {
721 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
722 class->class_cast_cache[i - 1] = class->class_cast_cache[i];
724 class->class_cast_cache[i - 1] = typename;
731 const char *object_get_typename(Object *obj)
733 return obj->class->type->name;
736 ObjectClass *object_get_class(Object *obj)
741 bool object_class_is_abstract(ObjectClass *klass)
743 return klass->type->abstract;
746 const char *object_class_get_name(ObjectClass *klass)
748 return klass->type->name;
751 ObjectClass *object_class_by_name(const char *typename)
753 TypeImpl *type = type_get_by_name(typename);
759 type_initialize(type);
764 ObjectClass *object_class_get_parent(ObjectClass *class)
766 TypeImpl *type = type_get_parent(class->type);
772 type_initialize(type);
777 typedef struct OCFData
779 void (*fn)(ObjectClass *klass, void *opaque);
780 const char *implements_type;
781 bool include_abstract;
785 static void object_class_foreach_tramp(gpointer key, gpointer value,
788 OCFData *data = opaque;
789 TypeImpl *type = value;
792 type_initialize(type);
795 if (!data->include_abstract && type->abstract) {
799 if (data->implements_type &&
800 !object_class_dynamic_cast(k, data->implements_type)) {
804 data->fn(k, data->opaque);
807 void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
808 const char *implements_type, bool include_abstract,
811 OCFData data = { fn, implements_type, include_abstract, opaque };
813 enumerating_types = true;
814 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
815 enumerating_types = false;
818 static int do_object_child_foreach(Object *obj,
819 int (*fn)(Object *child, void *opaque),
820 void *opaque, bool recurse)
823 ObjectProperty *prop;
826 g_hash_table_iter_init(&iter, obj->properties);
827 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
828 if (object_property_is_child(prop)) {
829 Object *child = prop->opaque;
831 ret = fn(child, opaque);
836 do_object_child_foreach(child, fn, opaque, true);
843 int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
846 return do_object_child_foreach(obj, fn, opaque, false);
849 int object_child_foreach_recursive(Object *obj,
850 int (*fn)(Object *child, void *opaque),
853 return do_object_child_foreach(obj, fn, opaque, true);
856 static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
858 GSList **list = opaque;
860 *list = g_slist_prepend(*list, klass);
863 GSList *object_class_get_list(const char *implements_type,
864 bool include_abstract)
868 object_class_foreach(object_class_get_list_tramp,
869 implements_type, include_abstract, &list);
873 void object_ref(Object *obj)
878 atomic_inc(&obj->ref);
881 void object_unref(Object *obj)
886 g_assert_cmpint(obj->ref, >, 0);
888 /* parent always holds a reference to its children */
889 if (atomic_fetch_dec(&obj->ref) == 1) {
890 object_finalize(obj);
895 object_property_add(Object *obj, const char *name, const char *type,
896 ObjectPropertyAccessor *get,
897 ObjectPropertyAccessor *set,
898 ObjectPropertyRelease *release,
899 void *opaque, Error **errp)
901 ObjectProperty *prop;
902 size_t name_len = strlen(name);
904 if (name_len >= 3 && !memcmp(name + name_len - 3, "[*]", 4)) {
907 char *name_no_array = g_strdup(name);
909 name_no_array[name_len - 3] = '\0';
911 char *full_name = g_strdup_printf("%s[%d]", name_no_array, i);
913 ret = object_property_add(obj, full_name, type, get, set,
914 release, opaque, NULL);
920 g_free(name_no_array);
924 if (object_property_find(obj, name, NULL) != NULL) {
925 error_setg(errp, "attempt to add duplicate property '%s'"
926 " to object (type '%s')", name,
927 object_get_typename(obj));
931 prop = g_malloc0(sizeof(*prop));
933 prop->name = g_strdup(name);
934 prop->type = g_strdup(type);
938 prop->release = release;
939 prop->opaque = opaque;
941 g_hash_table_insert(obj->properties, prop->name, prop);
946 object_class_property_add(ObjectClass *klass,
949 ObjectPropertyAccessor *get,
950 ObjectPropertyAccessor *set,
951 ObjectPropertyRelease *release,
955 ObjectProperty *prop;
957 if (object_class_property_find(klass, name, NULL) != NULL) {
958 error_setg(errp, "attempt to add duplicate property '%s'"
959 " to object (type '%s')", name,
960 object_class_get_name(klass));
964 prop = g_malloc0(sizeof(*prop));
966 prop->name = g_strdup(name);
967 prop->type = g_strdup(type);
971 prop->release = release;
972 prop->opaque = opaque;
974 g_hash_table_insert(klass->properties, g_strdup(name), prop);
979 ObjectProperty *object_property_find(Object *obj, const char *name,
982 ObjectProperty *prop;
983 ObjectClass *klass = object_get_class(obj);
985 prop = object_class_property_find(klass, name, NULL);
990 prop = g_hash_table_lookup(obj->properties, name);
995 error_setg(errp, "Property '.%s' not found", name);
999 void object_property_iter_init(ObjectPropertyIterator *iter,
1002 g_hash_table_iter_init(&iter->iter, obj->properties);
1003 iter->nextclass = object_get_class(obj);
1006 ObjectProperty *object_property_iter_next(ObjectPropertyIterator *iter)
1009 while (!g_hash_table_iter_next(&iter->iter, &key, &val)) {
1010 if (!iter->nextclass) {
1013 g_hash_table_iter_init(&iter->iter, iter->nextclass->properties);
1014 iter->nextclass = object_class_get_parent(iter->nextclass);
1019 ObjectProperty *object_class_property_find(ObjectClass *klass, const char *name,
1022 ObjectProperty *prop;
1023 ObjectClass *parent_klass;
1025 parent_klass = object_class_get_parent(klass);
1027 prop = object_class_property_find(parent_klass, name, NULL);
1033 prop = g_hash_table_lookup(klass->properties, name);
1035 error_setg(errp, "Property '.%s' not found", name);
1040 void object_property_del(Object *obj, const char *name, Error **errp)
1042 ObjectProperty *prop = g_hash_table_lookup(obj->properties, name);
1045 error_setg(errp, "Property '.%s' not found", name);
1049 if (prop->release) {
1050 prop->release(obj, name, prop->opaque);
1052 g_hash_table_remove(obj->properties, name);
1055 void object_property_get(Object *obj, Visitor *v, const char *name,
1058 ObjectProperty *prop = object_property_find(obj, name, errp);
1064 error_setg(errp, QERR_PERMISSION_DENIED);
1066 prop->get(obj, v, name, prop->opaque, errp);
1070 void object_property_set(Object *obj, Visitor *v, const char *name,
1073 ObjectProperty *prop = object_property_find(obj, name, errp);
1079 error_setg(errp, QERR_PERMISSION_DENIED);
1081 prop->set(obj, v, name, prop->opaque, errp);
1085 void object_property_set_str(Object *obj, const char *value,
1086 const char *name, Error **errp)
1088 QString *qstr = qstring_from_str(value);
1089 object_property_set_qobject(obj, QOBJECT(qstr), name, errp);
1094 char *object_property_get_str(Object *obj, const char *name,
1097 QObject *ret = object_property_get_qobject(obj, name, errp);
1104 qstring = qobject_to_qstring(ret);
1106 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
1109 retval = g_strdup(qstring_get_str(qstring));
1116 void object_property_set_link(Object *obj, Object *value,
1117 const char *name, Error **errp)
1120 gchar *path = object_get_canonical_path(value);
1121 object_property_set_str(obj, path, name, errp);
1124 object_property_set_str(obj, "", name, errp);
1128 Object *object_property_get_link(Object *obj, const char *name,
1131 char *str = object_property_get_str(obj, name, errp);
1132 Object *target = NULL;
1135 target = object_resolve_path(str, NULL);
1137 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1138 "Device '%s' not found", str);
1146 void object_property_set_bool(Object *obj, bool value,
1147 const char *name, Error **errp)
1149 QBool *qbool = qbool_from_bool(value);
1150 object_property_set_qobject(obj, QOBJECT(qbool), name, errp);
1155 bool object_property_get_bool(Object *obj, const char *name,
1158 QObject *ret = object_property_get_qobject(obj, name, errp);
1165 qbool = qobject_to_qbool(ret);
1167 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
1170 retval = qbool_get_bool(qbool);
1177 void object_property_set_int(Object *obj, int64_t value,
1178 const char *name, Error **errp)
1180 QInt *qint = qint_from_int(value);
1181 object_property_set_qobject(obj, QOBJECT(qint), name, errp);
1186 int64_t object_property_get_int(Object *obj, const char *name,
1189 QObject *ret = object_property_get_qobject(obj, name, errp);
1196 qint = qobject_to_qint(ret);
1198 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
1201 retval = qint_get_int(qint);
1208 typedef struct EnumProperty {
1209 const char * const *strings;
1210 int (*get)(Object *, Error **);
1211 void (*set)(Object *, int, Error **);
1214 int object_property_get_enum(Object *obj, const char *name,
1215 const char *typename, Error **errp)
1218 StringOutputVisitor *sov;
1219 StringInputVisitor *siv;
1222 ObjectProperty *prop = object_property_find(obj, name, errp);
1223 EnumProperty *enumprop;
1229 if (!g_str_equal(prop->type, typename)) {
1230 error_setg(errp, "Property %s on %s is not '%s' enum type",
1231 name, object_class_get_name(
1232 object_get_class(obj)), typename);
1236 enumprop = prop->opaque;
1238 sov = string_output_visitor_new(false);
1239 object_property_get(obj, string_output_get_visitor(sov), name, &err);
1241 error_propagate(errp, err);
1242 string_output_visitor_cleanup(sov);
1245 str = string_output_get_string(sov);
1246 siv = string_input_visitor_new(str);
1247 string_output_visitor_cleanup(sov);
1248 visit_type_enum(string_input_get_visitor(siv), name, &ret,
1249 enumprop->strings, errp);
1252 string_input_visitor_cleanup(siv);
1257 void object_property_get_uint16List(Object *obj, const char *name,
1258 uint16List **list, Error **errp)
1261 StringOutputVisitor *ov;
1262 StringInputVisitor *iv;
1265 ov = string_output_visitor_new(false);
1266 object_property_get(obj, string_output_get_visitor(ov),
1269 error_propagate(errp, err);
1272 str = string_output_get_string(ov);
1273 iv = string_input_visitor_new(str);
1274 visit_type_uint16List(string_input_get_visitor(iv), NULL, list, errp);
1277 string_input_visitor_cleanup(iv);
1279 string_output_visitor_cleanup(ov);
1282 void object_property_parse(Object *obj, const char *string,
1283 const char *name, Error **errp)
1285 StringInputVisitor *siv;
1286 siv = string_input_visitor_new(string);
1287 object_property_set(obj, string_input_get_visitor(siv), name, errp);
1289 string_input_visitor_cleanup(siv);
1292 char *object_property_print(Object *obj, const char *name, bool human,
1295 StringOutputVisitor *sov;
1296 char *string = NULL;
1297 Error *local_err = NULL;
1299 sov = string_output_visitor_new(human);
1300 object_property_get(obj, string_output_get_visitor(sov), name, &local_err);
1302 error_propagate(errp, local_err);
1306 string = string_output_get_string(sov);
1309 string_output_visitor_cleanup(sov);
1313 const char *object_property_get_type(Object *obj, const char *name, Error **errp)
1315 ObjectProperty *prop = object_property_find(obj, name, errp);
1323 Object *object_get_root(void)
1325 static Object *root;
1328 root = object_new("container");
1334 Object *object_get_objects_root(void)
1336 return container_get(object_get_root(), "/objects");
1339 static void object_get_child_property(Object *obj, Visitor *v,
1340 const char *name, void *opaque,
1343 Object *child = opaque;
1346 path = object_get_canonical_path(child);
1347 visit_type_str(v, name, &path, errp);
1351 static Object *object_resolve_child_property(Object *parent, void *opaque, const gchar *part)
1356 static void object_finalize_child_property(Object *obj, const char *name,
1359 Object *child = opaque;
1361 if (child->class->unparent) {
1362 (child->class->unparent)(child);
1364 child->parent = NULL;
1365 object_unref(child);
1368 void object_property_add_child(Object *obj, const char *name,
1369 Object *child, Error **errp)
1371 Error *local_err = NULL;
1375 if (child->parent != NULL) {
1376 error_setg(errp, "child object is already parented");
1380 type = g_strdup_printf("child<%s>", object_get_typename(OBJECT(child)));
1382 op = object_property_add(obj, name, type, object_get_child_property, NULL,
1383 object_finalize_child_property, child, &local_err);
1385 error_propagate(errp, local_err);
1389 op->resolve = object_resolve_child_property;
1391 child->parent = obj;
1397 void object_property_allow_set_link(Object *obj, const char *name,
1398 Object *val, Error **errp)
1400 /* Allow the link to be set, always */
1405 void (*check)(Object *, const char *, Object *, Error **);
1406 ObjectPropertyLinkFlags flags;
1409 static void object_get_link_property(Object *obj, Visitor *v,
1410 const char *name, void *opaque,
1413 LinkProperty *lprop = opaque;
1414 Object **child = lprop->child;
1418 path = object_get_canonical_path(*child);
1419 visit_type_str(v, name, &path, errp);
1423 visit_type_str(v, name, &path, errp);
1428 * object_resolve_link:
1430 * Lookup an object and ensure its type matches the link property type. This
1431 * is similar to object_resolve_path() except type verification against the
1432 * link property is performed.
1434 * Returns: The matched object or NULL on path lookup failures.
1436 static Object *object_resolve_link(Object *obj, const char *name,
1437 const char *path, Error **errp)
1441 bool ambiguous = false;
1444 /* Go from link<FOO> to FOO. */
1445 type = object_property_get_type(obj, name, NULL);
1446 target_type = g_strndup(&type[5], strlen(type) - 6);
1447 target = object_resolve_path_type(path, target_type, &ambiguous);
1450 error_setg(errp, "Path '%s' does not uniquely identify an object",
1452 } else if (!target) {
1453 target = object_resolve_path(path, &ambiguous);
1454 if (target || ambiguous) {
1455 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
1457 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1458 "Device '%s' not found", path);
1462 g_free(target_type);
1467 static void object_set_link_property(Object *obj, Visitor *v,
1468 const char *name, void *opaque,
1471 Error *local_err = NULL;
1472 LinkProperty *prop = opaque;
1473 Object **child = prop->child;
1474 Object *old_target = *child;
1475 Object *new_target = NULL;
1478 visit_type_str(v, name, &path, &local_err);
1480 if (!local_err && strcmp(path, "") != 0) {
1481 new_target = object_resolve_link(obj, name, path, &local_err);
1486 error_propagate(errp, local_err);
1490 prop->check(obj, name, new_target, &local_err);
1492 error_propagate(errp, local_err);
1496 object_ref(new_target);
1497 *child = new_target;
1498 object_unref(old_target);
1501 static Object *object_resolve_link_property(Object *parent, void *opaque, const gchar *part)
1503 LinkProperty *lprop = opaque;
1505 return *lprop->child;
1508 static void object_release_link_property(Object *obj, const char *name,
1511 LinkProperty *prop = opaque;
1513 if ((prop->flags & OBJ_PROP_LINK_UNREF_ON_RELEASE) && *prop->child) {
1514 object_unref(*prop->child);
1519 void object_property_add_link(Object *obj, const char *name,
1520 const char *type, Object **child,
1521 void (*check)(Object *, const char *,
1522 Object *, Error **),
1523 ObjectPropertyLinkFlags flags,
1526 Error *local_err = NULL;
1527 LinkProperty *prop = g_malloc(sizeof(*prop));
1531 prop->child = child;
1532 prop->check = check;
1533 prop->flags = flags;
1535 full_type = g_strdup_printf("link<%s>", type);
1537 op = object_property_add(obj, name, full_type,
1538 object_get_link_property,
1539 check ? object_set_link_property : NULL,
1540 object_release_link_property,
1544 error_propagate(errp, local_err);
1549 op->resolve = object_resolve_link_property;
1555 void object_property_add_const_link(Object *obj, const char *name,
1556 Object *target, Error **errp)
1561 link_type = g_strdup_printf("link<%s>", object_get_typename(target));
1562 op = object_property_add(obj, name, link_type,
1563 object_get_child_property, NULL,
1564 NULL, target, errp);
1566 op->resolve = object_resolve_child_property;
1571 gchar *object_get_canonical_path_component(Object *obj)
1573 ObjectProperty *prop = NULL;
1574 GHashTableIter iter;
1577 g_assert(obj->parent != NULL);
1579 g_hash_table_iter_init(&iter, obj->parent->properties);
1580 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
1581 if (!object_property_is_child(prop)) {
1585 if (prop->opaque == obj) {
1586 return g_strdup(prop->name);
1590 /* obj had a parent but was not a child, should never happen */
1591 g_assert_not_reached();
1595 gchar *object_get_canonical_path(Object *obj)
1597 Object *root = object_get_root();
1598 char *newpath, *path = NULL;
1600 while (obj != root) {
1601 char *component = object_get_canonical_path_component(obj);
1604 newpath = g_strdup_printf("%s/%s", component, path);
1615 newpath = g_strdup_printf("/%s", path ? path : "");
1621 Object *object_resolve_path_component(Object *parent, const gchar *part)
1623 ObjectProperty *prop = object_property_find(parent, part, NULL);
1628 if (prop->resolve) {
1629 return prop->resolve(parent, prop->opaque, part);
1635 static Object *object_resolve_abs_path(Object *parent,
1637 const char *typename,
1642 if (parts[index] == NULL) {
1643 return object_dynamic_cast(parent, typename);
1646 if (strcmp(parts[index], "") == 0) {
1647 return object_resolve_abs_path(parent, parts, typename, index + 1);
1650 child = object_resolve_path_component(parent, parts[index]);
1655 return object_resolve_abs_path(child, parts, typename, index + 1);
1658 static Object *object_resolve_partial_path(Object *parent,
1660 const char *typename,
1664 GHashTableIter iter;
1665 ObjectProperty *prop;
1667 obj = object_resolve_abs_path(parent, parts, typename, 0);
1669 g_hash_table_iter_init(&iter, parent->properties);
1670 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
1673 if (!object_property_is_child(prop)) {
1677 found = object_resolve_partial_path(prop->opaque, parts,
1678 typename, ambiguous);
1689 if (ambiguous && *ambiguous) {
1697 Object *object_resolve_path_type(const char *path, const char *typename,
1703 parts = g_strsplit(path, "/", 0);
1706 if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
1710 obj = object_resolve_partial_path(object_get_root(), parts,
1711 typename, ambiguous);
1713 obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
1721 Object *object_resolve_path(const char *path, bool *ambiguous)
1723 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
1726 typedef struct StringProperty
1728 char *(*get)(Object *, Error **);
1729 void (*set)(Object *, const char *, Error **);
1732 static void property_get_str(Object *obj, Visitor *v, const char *name,
1733 void *opaque, Error **errp)
1735 StringProperty *prop = opaque;
1739 value = prop->get(obj, &err);
1741 error_propagate(errp, err);
1745 visit_type_str(v, name, &value, errp);
1749 static void property_set_str(Object *obj, Visitor *v, const char *name,
1750 void *opaque, Error **errp)
1752 StringProperty *prop = opaque;
1754 Error *local_err = NULL;
1756 visit_type_str(v, name, &value, &local_err);
1758 error_propagate(errp, local_err);
1762 prop->set(obj, value, errp);
1766 static void property_release_str(Object *obj, const char *name,
1769 StringProperty *prop = opaque;
1773 void object_property_add_str(Object *obj, const char *name,
1774 char *(*get)(Object *, Error **),
1775 void (*set)(Object *, const char *, Error **),
1778 Error *local_err = NULL;
1779 StringProperty *prop = g_malloc0(sizeof(*prop));
1784 object_property_add(obj, name, "string",
1785 get ? property_get_str : NULL,
1786 set ? property_set_str : NULL,
1787 property_release_str,
1790 error_propagate(errp, local_err);
1795 void object_class_property_add_str(ObjectClass *klass, const char *name,
1796 char *(*get)(Object *, Error **),
1797 void (*set)(Object *, const char *,
1801 Error *local_err = NULL;
1802 StringProperty *prop = g_malloc0(sizeof(*prop));
1807 object_class_property_add(klass, name, "string",
1808 get ? property_get_str : NULL,
1809 set ? property_set_str : NULL,
1810 property_release_str,
1813 error_propagate(errp, local_err);
1818 typedef struct BoolProperty
1820 bool (*get)(Object *, Error **);
1821 void (*set)(Object *, bool, Error **);
1824 static void property_get_bool(Object *obj, Visitor *v, const char *name,
1825 void *opaque, Error **errp)
1827 BoolProperty *prop = opaque;
1831 value = prop->get(obj, &err);
1833 error_propagate(errp, err);
1837 visit_type_bool(v, name, &value, errp);
1840 static void property_set_bool(Object *obj, Visitor *v, const char *name,
1841 void *opaque, Error **errp)
1843 BoolProperty *prop = opaque;
1845 Error *local_err = NULL;
1847 visit_type_bool(v, name, &value, &local_err);
1849 error_propagate(errp, local_err);
1853 prop->set(obj, value, errp);
1856 static void property_release_bool(Object *obj, const char *name,
1859 BoolProperty *prop = opaque;
1863 void object_property_add_bool(Object *obj, const char *name,
1864 bool (*get)(Object *, Error **),
1865 void (*set)(Object *, bool, Error **),
1868 Error *local_err = NULL;
1869 BoolProperty *prop = g_malloc0(sizeof(*prop));
1874 object_property_add(obj, name, "bool",
1875 get ? property_get_bool : NULL,
1876 set ? property_set_bool : NULL,
1877 property_release_bool,
1880 error_propagate(errp, local_err);
1885 void object_class_property_add_bool(ObjectClass *klass, const char *name,
1886 bool (*get)(Object *, Error **),
1887 void (*set)(Object *, bool, Error **),
1890 Error *local_err = NULL;
1891 BoolProperty *prop = g_malloc0(sizeof(*prop));
1896 object_class_property_add(klass, name, "bool",
1897 get ? property_get_bool : NULL,
1898 set ? property_set_bool : NULL,
1899 property_release_bool,
1902 error_propagate(errp, local_err);
1907 static void property_get_enum(Object *obj, Visitor *v, const char *name,
1908 void *opaque, Error **errp)
1910 EnumProperty *prop = opaque;
1914 value = prop->get(obj, &err);
1916 error_propagate(errp, err);
1920 visit_type_enum(v, name, &value, prop->strings, errp);
1923 static void property_set_enum(Object *obj, Visitor *v, const char *name,
1924 void *opaque, Error **errp)
1926 EnumProperty *prop = opaque;
1930 visit_type_enum(v, name, &value, prop->strings, &err);
1932 error_propagate(errp, err);
1935 prop->set(obj, value, errp);
1938 static void property_release_enum(Object *obj, const char *name,
1941 EnumProperty *prop = opaque;
1945 void object_property_add_enum(Object *obj, const char *name,
1946 const char *typename,
1947 const char * const *strings,
1948 int (*get)(Object *, Error **),
1949 void (*set)(Object *, int, Error **),
1952 Error *local_err = NULL;
1953 EnumProperty *prop = g_malloc(sizeof(*prop));
1955 prop->strings = strings;
1959 object_property_add(obj, name, typename,
1960 get ? property_get_enum : NULL,
1961 set ? property_set_enum : NULL,
1962 property_release_enum,
1965 error_propagate(errp, local_err);
1970 void object_class_property_add_enum(ObjectClass *klass, const char *name,
1971 const char *typename,
1972 const char * const *strings,
1973 int (*get)(Object *, Error **),
1974 void (*set)(Object *, int, Error **),
1977 Error *local_err = NULL;
1978 EnumProperty *prop = g_malloc(sizeof(*prop));
1980 prop->strings = strings;
1984 object_class_property_add(klass, name, typename,
1985 get ? property_get_enum : NULL,
1986 set ? property_set_enum : NULL,
1987 property_release_enum,
1990 error_propagate(errp, local_err);
1995 typedef struct TMProperty {
1996 void (*get)(Object *, struct tm *, Error **);
1999 static void property_get_tm(Object *obj, Visitor *v, const char *name,
2000 void *opaque, Error **errp)
2002 TMProperty *prop = opaque;
2006 prop->get(obj, &value, &err);
2011 visit_start_struct(v, name, NULL, 0, &err);
2015 visit_type_int32(v, "tm_year", &value.tm_year, &err);
2019 visit_type_int32(v, "tm_mon", &value.tm_mon, &err);
2023 visit_type_int32(v, "tm_mday", &value.tm_mday, &err);
2027 visit_type_int32(v, "tm_hour", &value.tm_hour, &err);
2031 visit_type_int32(v, "tm_min", &value.tm_min, &err);
2035 visit_type_int32(v, "tm_sec", &value.tm_sec, &err);
2039 visit_check_struct(v, &err);
2041 visit_end_struct(v);
2043 error_propagate(errp, err);
2047 static void property_release_tm(Object *obj, const char *name,
2050 TMProperty *prop = opaque;
2054 void object_property_add_tm(Object *obj, const char *name,
2055 void (*get)(Object *, struct tm *, Error **),
2058 Error *local_err = NULL;
2059 TMProperty *prop = g_malloc0(sizeof(*prop));
2063 object_property_add(obj, name, "struct tm",
2064 get ? property_get_tm : NULL, NULL,
2065 property_release_tm,
2068 error_propagate(errp, local_err);
2073 void object_class_property_add_tm(ObjectClass *klass, const char *name,
2074 void (*get)(Object *, struct tm *, Error **),
2077 Error *local_err = NULL;
2078 TMProperty *prop = g_malloc0(sizeof(*prop));
2082 object_class_property_add(klass, name, "struct tm",
2083 get ? property_get_tm : NULL, NULL,
2084 property_release_tm,
2087 error_propagate(errp, local_err);
2092 static char *qdev_get_type(Object *obj, Error **errp)
2094 return g_strdup(object_get_typename(obj));
2097 static void property_get_uint8_ptr(Object *obj, Visitor *v, const char *name,
2098 void *opaque, Error **errp)
2100 uint8_t value = *(uint8_t *)opaque;
2101 visit_type_uint8(v, name, &value, errp);
2104 static void property_get_uint16_ptr(Object *obj, Visitor *v, const char *name,
2105 void *opaque, Error **errp)
2107 uint16_t value = *(uint16_t *)opaque;
2108 visit_type_uint16(v, name, &value, errp);
2111 static void property_get_uint32_ptr(Object *obj, Visitor *v, const char *name,
2112 void *opaque, Error **errp)
2114 uint32_t value = *(uint32_t *)opaque;
2115 visit_type_uint32(v, name, &value, errp);
2118 static void property_get_uint64_ptr(Object *obj, Visitor *v, const char *name,
2119 void *opaque, Error **errp)
2121 uint64_t value = *(uint64_t *)opaque;
2122 visit_type_uint64(v, name, &value, errp);
2125 void object_property_add_uint8_ptr(Object *obj, const char *name,
2126 const uint8_t *v, Error **errp)
2128 object_property_add(obj, name, "uint8", property_get_uint8_ptr,
2129 NULL, NULL, (void *)v, errp);
2132 void object_class_property_add_uint8_ptr(ObjectClass *klass, const char *name,
2133 const uint8_t *v, Error **errp)
2135 object_class_property_add(klass, name, "uint8", property_get_uint8_ptr,
2136 NULL, NULL, (void *)v, errp);
2139 void object_property_add_uint16_ptr(Object *obj, const char *name,
2140 const uint16_t *v, Error **errp)
2142 object_property_add(obj, name, "uint16", property_get_uint16_ptr,
2143 NULL, NULL, (void *)v, errp);
2146 void object_class_property_add_uint16_ptr(ObjectClass *klass, const char *name,
2147 const uint16_t *v, Error **errp)
2149 object_class_property_add(klass, name, "uint16", property_get_uint16_ptr,
2150 NULL, NULL, (void *)v, errp);
2153 void object_property_add_uint32_ptr(Object *obj, const char *name,
2154 const uint32_t *v, Error **errp)
2156 object_property_add(obj, name, "uint32", property_get_uint32_ptr,
2157 NULL, NULL, (void *)v, errp);
2160 void object_class_property_add_uint32_ptr(ObjectClass *klass, const char *name,
2161 const uint32_t *v, Error **errp)
2163 object_class_property_add(klass, name, "uint32", property_get_uint32_ptr,
2164 NULL, NULL, (void *)v, errp);
2167 void object_property_add_uint64_ptr(Object *obj, const char *name,
2168 const uint64_t *v, Error **errp)
2170 object_property_add(obj, name, "uint64", property_get_uint64_ptr,
2171 NULL, NULL, (void *)v, errp);
2174 void object_class_property_add_uint64_ptr(ObjectClass *klass, const char *name,
2175 const uint64_t *v, Error **errp)
2177 object_class_property_add(klass, name, "uint64", property_get_uint64_ptr,
2178 NULL, NULL, (void *)v, errp);
2186 static void property_get_alias(Object *obj, Visitor *v, const char *name,
2187 void *opaque, Error **errp)
2189 AliasProperty *prop = opaque;
2191 object_property_get(prop->target_obj, v, prop->target_name, errp);
2194 static void property_set_alias(Object *obj, Visitor *v, const char *name,
2195 void *opaque, Error **errp)
2197 AliasProperty *prop = opaque;
2199 object_property_set(prop->target_obj, v, prop->target_name, errp);
2202 static Object *property_resolve_alias(Object *obj, void *opaque,
2205 AliasProperty *prop = opaque;
2207 return object_resolve_path_component(prop->target_obj, prop->target_name);
2210 static void property_release_alias(Object *obj, const char *name, void *opaque)
2212 AliasProperty *prop = opaque;
2214 g_free(prop->target_name);
2218 void object_property_add_alias(Object *obj, const char *name,
2219 Object *target_obj, const char *target_name,
2222 AliasProperty *prop;
2224 ObjectProperty *target_prop;
2226 Error *local_err = NULL;
2228 target_prop = object_property_find(target_obj, target_name, errp);
2233 if (object_property_is_child(target_prop)) {
2234 prop_type = g_strdup_printf("link%s",
2235 target_prop->type + strlen("child"));
2237 prop_type = g_strdup(target_prop->type);
2240 prop = g_malloc(sizeof(*prop));
2241 prop->target_obj = target_obj;
2242 prop->target_name = g_strdup(target_name);
2244 op = object_property_add(obj, name, prop_type,
2247 property_release_alias,
2250 error_propagate(errp, local_err);
2254 op->resolve = property_resolve_alias;
2256 object_property_set_description(obj, op->name,
2257 target_prop->description,
2264 void object_property_set_description(Object *obj, const char *name,
2265 const char *description, Error **errp)
2269 op = object_property_find(obj, name, errp);
2274 g_free(op->description);
2275 op->description = g_strdup(description);
2278 void object_class_property_set_description(ObjectClass *klass,
2280 const char *description,
2285 op = g_hash_table_lookup(klass->properties, name);
2287 error_setg(errp, "Property '.%s' not found", name);
2291 g_free(op->description);
2292 op->description = g_strdup(description);
2295 static void object_instance_init(Object *obj)
2297 object_property_add_str(obj, "type", qdev_get_type, NULL, NULL);
2300 static void register_types(void)
2302 static TypeInfo interface_info = {
2303 .name = TYPE_INTERFACE,
2304 .class_size = sizeof(InterfaceClass),
2308 static TypeInfo object_info = {
2309 .name = TYPE_OBJECT,
2310 .instance_size = sizeof(Object),
2311 .instance_init = object_instance_init,
2315 type_interface = type_register_internal(&interface_info);
2316 type_register_internal(&object_info);
2319 type_init(register_types)