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 size_t object_type_get_instance_size(const char *typename)
207 TypeImpl *type = type_get_by_name(typename);
209 g_assert(type != NULL);
210 return type_object_get_size(type);
213 static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
217 /* Check if target_type is a direct ancestor of type */
219 if (type == target_type) {
223 type = type_get_parent(type);
229 static void type_initialize(TypeImpl *ti);
231 static void type_initialize_interface(TypeImpl *ti, TypeImpl *interface_type,
232 TypeImpl *parent_type)
234 InterfaceClass *new_iface;
236 TypeImpl *iface_impl;
238 info.parent = parent_type->name;
239 info.name = g_strdup_printf("%s::%s", ti->name, interface_type->name);
240 info.abstract = true;
242 iface_impl = type_new(&info);
243 iface_impl->parent_type = parent_type;
244 type_initialize(iface_impl);
245 g_free((char *)info.name);
247 new_iface = (InterfaceClass *)iface_impl->class;
248 new_iface->concrete_class = ti->class;
249 new_iface->interface_type = interface_type;
251 ti->class->interfaces = g_slist_append(ti->class->interfaces,
255 static void object_property_free(gpointer data)
257 ObjectProperty *prop = data;
261 g_free(prop->description);
265 static void type_initialize(TypeImpl *ti)
273 ti->class_size = type_class_get_size(ti);
274 ti->instance_size = type_object_get_size(ti);
276 ti->class = g_malloc0(ti->class_size);
278 parent = type_get_parent(ti);
280 type_initialize(parent);
284 g_assert_cmpint(parent->class_size, <=, ti->class_size);
285 memcpy(ti->class, parent->class, parent->class_size);
286 ti->class->interfaces = NULL;
287 ti->class->properties = g_hash_table_new_full(
288 g_str_hash, g_str_equal, g_free, object_property_free);
290 for (e = parent->class->interfaces; e; e = e->next) {
291 InterfaceClass *iface = e->data;
292 ObjectClass *klass = OBJECT_CLASS(iface);
294 type_initialize_interface(ti, iface->interface_type, klass->type);
297 for (i = 0; i < ti->num_interfaces; i++) {
298 TypeImpl *t = type_get_by_name(ti->interfaces[i].typename);
299 for (e = ti->class->interfaces; e; e = e->next) {
300 TypeImpl *target_type = OBJECT_CLASS(e->data)->type;
302 if (type_is_ancestor(target_type, t)) {
311 type_initialize_interface(ti, t, t);
314 ti->class->properties = g_hash_table_new_full(
315 g_str_hash, g_str_equal, g_free, object_property_free);
318 ti->class->type = ti;
321 if (parent->class_base_init) {
322 parent->class_base_init(ti->class, ti->class_data);
324 parent = type_get_parent(parent);
327 if (ti->class_init) {
328 ti->class_init(ti->class, ti->class_data);
332 static void object_init_with_type(Object *obj, TypeImpl *ti)
334 if (type_has_parent(ti)) {
335 object_init_with_type(obj, type_get_parent(ti));
338 if (ti->instance_init) {
339 ti->instance_init(obj);
343 static void object_post_init_with_type(Object *obj, TypeImpl *ti)
345 if (ti->instance_post_init) {
346 ti->instance_post_init(obj);
349 if (type_has_parent(ti)) {
350 object_post_init_with_type(obj, type_get_parent(ti));
354 void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
358 g_assert(type != NULL);
359 type_initialize(type);
361 g_assert_cmpint(type->instance_size, >=, sizeof(Object));
362 g_assert(type->abstract == false);
363 g_assert_cmpint(size, >=, type->instance_size);
365 memset(obj, 0, type->instance_size);
366 obj->class = type->class;
368 obj->properties = g_hash_table_new_full(g_str_hash, g_str_equal,
369 NULL, object_property_free);
370 object_init_with_type(obj, type);
371 object_post_init_with_type(obj, type);
374 void object_initialize(void *data, size_t size, const char *typename)
376 TypeImpl *type = type_get_by_name(typename);
378 object_initialize_with_type(data, size, type);
381 static inline bool object_property_is_child(ObjectProperty *prop)
383 return strstart(prop->type, "child<", NULL);
386 static void object_property_del_all(Object *obj)
388 ObjectProperty *prop;
395 g_hash_table_iter_init(&iter, obj->properties);
396 while (g_hash_table_iter_next(&iter, &key, &value)) {
399 prop->release(obj, prop->name, prop->opaque);
400 prop->release = NULL;
404 g_hash_table_iter_remove(&iter);
408 g_hash_table_unref(obj->properties);
411 static void object_property_del_child(Object *obj, Object *child, Error **errp)
413 ObjectProperty *prop;
417 g_hash_table_iter_init(&iter, obj->properties);
418 while (g_hash_table_iter_next(&iter, &key, &value)) {
420 if (object_property_is_child(prop) && prop->opaque == child) {
422 prop->release(obj, prop->name, prop->opaque);
423 prop->release = NULL;
428 g_hash_table_iter_init(&iter, obj->properties);
429 while (g_hash_table_iter_next(&iter, &key, &value)) {
431 if (object_property_is_child(prop) && prop->opaque == child) {
432 g_hash_table_iter_remove(&iter);
438 void object_unparent(Object *obj)
441 object_property_del_child(obj->parent, obj, NULL);
445 static void object_deinit(Object *obj, TypeImpl *type)
447 if (type->instance_finalize) {
448 type->instance_finalize(obj);
451 if (type_has_parent(type)) {
452 object_deinit(obj, type_get_parent(type));
456 static void object_finalize(void *data)
459 TypeImpl *ti = obj->class->type;
461 object_property_del_all(obj);
462 object_deinit(obj, ti);
464 g_assert_cmpint(obj->ref, ==, 0);
470 Object *object_new_with_type(Type type)
474 g_assert(type != NULL);
475 type_initialize(type);
477 obj = g_malloc(type->instance_size);
478 object_initialize_with_type(obj, type->instance_size, type);
484 Object *object_new(const char *typename)
486 TypeImpl *ti = type_get_by_name(typename);
488 return object_new_with_type(ti);
492 Object *object_new_with_props(const char *typename,
501 va_start(vargs, errp);
502 obj = object_new_with_propv(typename, parent, id, errp, vargs);
509 Object *object_new_with_propv(const char *typename,
517 Error *local_err = NULL;
519 klass = object_class_by_name(typename);
521 error_setg(errp, "invalid object type: %s", typename);
525 if (object_class_is_abstract(klass)) {
526 error_setg(errp, "object type '%s' is abstract", typename);
529 obj = object_new(typename);
531 if (object_set_propv(obj, &local_err, vargs) < 0) {
535 object_property_add_child(parent, id, obj, &local_err);
540 if (object_dynamic_cast(obj, TYPE_USER_CREATABLE)) {
541 user_creatable_complete(obj, &local_err);
543 object_unparent(obj);
548 object_unref(OBJECT(obj));
552 error_propagate(errp, local_err);
558 int object_set_props(Object *obj,
565 va_start(vargs, errp);
566 ret = object_set_propv(obj, errp, vargs);
573 int object_set_propv(Object *obj,
577 const char *propname;
578 Error *local_err = NULL;
580 propname = va_arg(vargs, char *);
581 while (propname != NULL) {
582 const char *value = va_arg(vargs, char *);
584 g_assert(value != NULL);
585 object_property_parse(obj, value, propname, &local_err);
587 error_propagate(errp, local_err);
590 propname = va_arg(vargs, char *);
597 Object *object_dynamic_cast(Object *obj, const char *typename)
599 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
606 Object *object_dynamic_cast_assert(Object *obj, const char *typename,
607 const char *file, int line, const char *func)
609 trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
610 typename, file, line, func);
612 #ifdef CONFIG_QOM_CAST_DEBUG
616 for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
617 if (obj->class->object_cast_cache[i] == typename) {
622 inst = object_dynamic_cast(obj, typename);
625 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
626 file, line, func, obj, typename);
632 if (obj && obj == inst) {
633 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
634 obj->class->object_cast_cache[i - 1] =
635 obj->class->object_cast_cache[i];
637 obj->class->object_cast_cache[i - 1] = typename;
645 ObjectClass *object_class_dynamic_cast(ObjectClass *class,
646 const char *typename)
648 ObjectClass *ret = NULL;
649 TypeImpl *target_type;
656 /* A simple fast path that can trigger a lot for leaf classes. */
658 if (type->name == typename) {
662 target_type = type_get_by_name(typename);
664 /* target class type unknown, so fail the cast */
668 if (type->class->interfaces &&
669 type_is_ancestor(target_type, type_interface)) {
673 for (i = class->interfaces; i; i = i->next) {
674 ObjectClass *target_class = i->data;
676 if (type_is_ancestor(target_class->type, target_type)) {
682 /* The match was ambiguous, don't allow a cast */
686 } else if (type_is_ancestor(type, target_type)) {
693 ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
694 const char *typename,
695 const char *file, int line,
700 trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)",
701 typename, file, line, func);
703 #ifdef CONFIG_QOM_CAST_DEBUG
706 for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
707 if (class->class_cast_cache[i] == typename) {
713 if (!class || !class->interfaces) {
718 ret = object_class_dynamic_cast(class, typename);
720 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
721 file, line, func, class, typename);
725 #ifdef CONFIG_QOM_CAST_DEBUG
726 if (class && ret == class) {
727 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
728 class->class_cast_cache[i - 1] = class->class_cast_cache[i];
730 class->class_cast_cache[i - 1] = typename;
737 const char *object_get_typename(Object *obj)
739 return obj->class->type->name;
742 ObjectClass *object_get_class(Object *obj)
747 bool object_class_is_abstract(ObjectClass *klass)
749 return klass->type->abstract;
752 const char *object_class_get_name(ObjectClass *klass)
754 return klass->type->name;
757 ObjectClass *object_class_by_name(const char *typename)
759 TypeImpl *type = type_get_by_name(typename);
765 type_initialize(type);
770 ObjectClass *object_class_get_parent(ObjectClass *class)
772 TypeImpl *type = type_get_parent(class->type);
778 type_initialize(type);
783 typedef struct OCFData
785 void (*fn)(ObjectClass *klass, void *opaque);
786 const char *implements_type;
787 bool include_abstract;
791 static void object_class_foreach_tramp(gpointer key, gpointer value,
794 OCFData *data = opaque;
795 TypeImpl *type = value;
798 type_initialize(type);
801 if (!data->include_abstract && type->abstract) {
805 if (data->implements_type &&
806 !object_class_dynamic_cast(k, data->implements_type)) {
810 data->fn(k, data->opaque);
813 void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
814 const char *implements_type, bool include_abstract,
817 OCFData data = { fn, implements_type, include_abstract, opaque };
819 enumerating_types = true;
820 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
821 enumerating_types = false;
824 static int do_object_child_foreach(Object *obj,
825 int (*fn)(Object *child, void *opaque),
826 void *opaque, bool recurse)
829 ObjectProperty *prop;
832 g_hash_table_iter_init(&iter, obj->properties);
833 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
834 if (object_property_is_child(prop)) {
835 Object *child = prop->opaque;
837 ret = fn(child, opaque);
842 do_object_child_foreach(child, fn, opaque, true);
849 int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
852 return do_object_child_foreach(obj, fn, opaque, false);
855 int object_child_foreach_recursive(Object *obj,
856 int (*fn)(Object *child, void *opaque),
859 return do_object_child_foreach(obj, fn, opaque, true);
862 static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
864 GSList **list = opaque;
866 *list = g_slist_prepend(*list, klass);
869 GSList *object_class_get_list(const char *implements_type,
870 bool include_abstract)
874 object_class_foreach(object_class_get_list_tramp,
875 implements_type, include_abstract, &list);
879 void object_ref(Object *obj)
884 atomic_inc(&obj->ref);
887 void object_unref(Object *obj)
892 g_assert_cmpint(obj->ref, >, 0);
894 /* parent always holds a reference to its children */
895 if (atomic_fetch_dec(&obj->ref) == 1) {
896 object_finalize(obj);
901 object_property_add(Object *obj, const char *name, const char *type,
902 ObjectPropertyAccessor *get,
903 ObjectPropertyAccessor *set,
904 ObjectPropertyRelease *release,
905 void *opaque, Error **errp)
907 ObjectProperty *prop;
908 size_t name_len = strlen(name);
910 if (name_len >= 3 && !memcmp(name + name_len - 3, "[*]", 4)) {
913 char *name_no_array = g_strdup(name);
915 name_no_array[name_len - 3] = '\0';
917 char *full_name = g_strdup_printf("%s[%d]", name_no_array, i);
919 ret = object_property_add(obj, full_name, type, get, set,
920 release, opaque, NULL);
926 g_free(name_no_array);
930 if (object_property_find(obj, name, NULL) != NULL) {
931 error_setg(errp, "attempt to add duplicate property '%s'"
932 " to object (type '%s')", name,
933 object_get_typename(obj));
937 prop = g_malloc0(sizeof(*prop));
939 prop->name = g_strdup(name);
940 prop->type = g_strdup(type);
944 prop->release = release;
945 prop->opaque = opaque;
947 g_hash_table_insert(obj->properties, prop->name, prop);
952 object_class_property_add(ObjectClass *klass,
955 ObjectPropertyAccessor *get,
956 ObjectPropertyAccessor *set,
957 ObjectPropertyRelease *release,
961 ObjectProperty *prop;
963 if (object_class_property_find(klass, name, NULL) != NULL) {
964 error_setg(errp, "attempt to add duplicate property '%s'"
965 " to object (type '%s')", name,
966 object_class_get_name(klass));
970 prop = g_malloc0(sizeof(*prop));
972 prop->name = g_strdup(name);
973 prop->type = g_strdup(type);
977 prop->release = release;
978 prop->opaque = opaque;
980 g_hash_table_insert(klass->properties, g_strdup(name), prop);
985 ObjectProperty *object_property_find(Object *obj, const char *name,
988 ObjectProperty *prop;
989 ObjectClass *klass = object_get_class(obj);
991 prop = object_class_property_find(klass, name, NULL);
996 prop = g_hash_table_lookup(obj->properties, name);
1001 error_setg(errp, "Property '.%s' not found", name);
1005 void object_property_iter_init(ObjectPropertyIterator *iter,
1008 g_hash_table_iter_init(&iter->iter, obj->properties);
1009 iter->nextclass = object_get_class(obj);
1012 ObjectProperty *object_property_iter_next(ObjectPropertyIterator *iter)
1015 while (!g_hash_table_iter_next(&iter->iter, &key, &val)) {
1016 if (!iter->nextclass) {
1019 g_hash_table_iter_init(&iter->iter, iter->nextclass->properties);
1020 iter->nextclass = object_class_get_parent(iter->nextclass);
1025 ObjectProperty *object_class_property_find(ObjectClass *klass, const char *name,
1028 ObjectProperty *prop;
1029 ObjectClass *parent_klass;
1031 parent_klass = object_class_get_parent(klass);
1033 prop = object_class_property_find(parent_klass, name, NULL);
1039 prop = g_hash_table_lookup(klass->properties, name);
1041 error_setg(errp, "Property '.%s' not found", name);
1046 void object_property_del(Object *obj, const char *name, Error **errp)
1048 ObjectProperty *prop = g_hash_table_lookup(obj->properties, name);
1051 error_setg(errp, "Property '.%s' not found", name);
1055 if (prop->release) {
1056 prop->release(obj, name, prop->opaque);
1058 g_hash_table_remove(obj->properties, name);
1061 void object_property_get(Object *obj, Visitor *v, const char *name,
1064 ObjectProperty *prop = object_property_find(obj, name, errp);
1070 error_setg(errp, QERR_PERMISSION_DENIED);
1072 prop->get(obj, v, name, prop->opaque, errp);
1076 void object_property_set(Object *obj, Visitor *v, const char *name,
1079 ObjectProperty *prop = object_property_find(obj, name, errp);
1085 error_setg(errp, QERR_PERMISSION_DENIED);
1087 prop->set(obj, v, name, prop->opaque, errp);
1091 void object_property_set_str(Object *obj, const char *value,
1092 const char *name, Error **errp)
1094 QString *qstr = qstring_from_str(value);
1095 object_property_set_qobject(obj, QOBJECT(qstr), name, errp);
1100 char *object_property_get_str(Object *obj, const char *name,
1103 QObject *ret = object_property_get_qobject(obj, name, errp);
1110 qstring = qobject_to_qstring(ret);
1112 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
1115 retval = g_strdup(qstring_get_str(qstring));
1122 void object_property_set_link(Object *obj, Object *value,
1123 const char *name, Error **errp)
1126 gchar *path = object_get_canonical_path(value);
1127 object_property_set_str(obj, path, name, errp);
1130 object_property_set_str(obj, "", name, errp);
1134 Object *object_property_get_link(Object *obj, const char *name,
1137 char *str = object_property_get_str(obj, name, errp);
1138 Object *target = NULL;
1141 target = object_resolve_path(str, NULL);
1143 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1144 "Device '%s' not found", str);
1152 void object_property_set_bool(Object *obj, bool value,
1153 const char *name, Error **errp)
1155 QBool *qbool = qbool_from_bool(value);
1156 object_property_set_qobject(obj, QOBJECT(qbool), name, errp);
1161 bool object_property_get_bool(Object *obj, const char *name,
1164 QObject *ret = object_property_get_qobject(obj, name, errp);
1171 qbool = qobject_to_qbool(ret);
1173 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
1176 retval = qbool_get_bool(qbool);
1183 void object_property_set_int(Object *obj, int64_t value,
1184 const char *name, Error **errp)
1186 QInt *qint = qint_from_int(value);
1187 object_property_set_qobject(obj, QOBJECT(qint), name, errp);
1192 int64_t object_property_get_int(Object *obj, const char *name,
1195 QObject *ret = object_property_get_qobject(obj, name, errp);
1202 qint = qobject_to_qint(ret);
1204 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
1207 retval = qint_get_int(qint);
1214 typedef struct EnumProperty {
1215 const char * const *strings;
1216 int (*get)(Object *, Error **);
1217 void (*set)(Object *, int, Error **);
1220 int object_property_get_enum(Object *obj, const char *name,
1221 const char *typename, Error **errp)
1224 StringOutputVisitor *sov;
1228 ObjectProperty *prop = object_property_find(obj, name, errp);
1229 EnumProperty *enumprop;
1235 if (!g_str_equal(prop->type, typename)) {
1236 error_setg(errp, "Property %s on %s is not '%s' enum type",
1237 name, object_class_get_name(
1238 object_get_class(obj)), typename);
1242 enumprop = prop->opaque;
1244 sov = string_output_visitor_new(false);
1245 v = string_output_get_visitor(sov);
1246 object_property_get(obj, v, name, &err);
1248 error_propagate(errp, err);
1252 str = string_output_get_string(sov);
1254 v = string_input_visitor_new(str);
1255 visit_type_enum(v, name, &ret, enumprop->strings, errp);
1263 void object_property_get_uint16List(Object *obj, const char *name,
1264 uint16List **list, Error **errp)
1267 StringOutputVisitor *ov;
1271 ov = string_output_visitor_new(false);
1272 object_property_get(obj, string_output_get_visitor(ov),
1275 error_propagate(errp, err);
1278 str = string_output_get_string(ov);
1279 v = string_input_visitor_new(str);
1280 visit_type_uint16List(v, NULL, list, errp);
1285 visit_free(string_output_get_visitor(ov));
1288 void object_property_parse(Object *obj, const char *string,
1289 const char *name, Error **errp)
1291 Visitor *v = string_input_visitor_new(string);
1292 object_property_set(obj, v, name, errp);
1296 char *object_property_print(Object *obj, const char *name, bool human,
1299 StringOutputVisitor *sov;
1300 char *string = NULL;
1301 Error *local_err = NULL;
1303 sov = string_output_visitor_new(human);
1304 object_property_get(obj, string_output_get_visitor(sov), name, &local_err);
1306 error_propagate(errp, local_err);
1310 string = string_output_get_string(sov);
1313 visit_free(string_output_get_visitor(sov));
1317 const char *object_property_get_type(Object *obj, const char *name, Error **errp)
1319 ObjectProperty *prop = object_property_find(obj, name, errp);
1327 Object *object_get_root(void)
1329 static Object *root;
1332 root = object_new("container");
1338 Object *object_get_objects_root(void)
1340 return container_get(object_get_root(), "/objects");
1343 static void object_get_child_property(Object *obj, Visitor *v,
1344 const char *name, void *opaque,
1347 Object *child = opaque;
1350 path = object_get_canonical_path(child);
1351 visit_type_str(v, name, &path, errp);
1355 static Object *object_resolve_child_property(Object *parent, void *opaque, const gchar *part)
1360 static void object_finalize_child_property(Object *obj, const char *name,
1363 Object *child = opaque;
1365 if (child->class->unparent) {
1366 (child->class->unparent)(child);
1368 child->parent = NULL;
1369 object_unref(child);
1372 void object_property_add_child(Object *obj, const char *name,
1373 Object *child, Error **errp)
1375 Error *local_err = NULL;
1379 if (child->parent != NULL) {
1380 error_setg(errp, "child object is already parented");
1384 type = g_strdup_printf("child<%s>", object_get_typename(OBJECT(child)));
1386 op = object_property_add(obj, name, type, object_get_child_property, NULL,
1387 object_finalize_child_property, child, &local_err);
1389 error_propagate(errp, local_err);
1393 op->resolve = object_resolve_child_property;
1395 child->parent = obj;
1401 void object_property_allow_set_link(Object *obj, const char *name,
1402 Object *val, Error **errp)
1404 /* Allow the link to be set, always */
1409 void (*check)(Object *, const char *, Object *, Error **);
1410 ObjectPropertyLinkFlags flags;
1413 static void object_get_link_property(Object *obj, Visitor *v,
1414 const char *name, void *opaque,
1417 LinkProperty *lprop = opaque;
1418 Object **child = lprop->child;
1422 path = object_get_canonical_path(*child);
1423 visit_type_str(v, name, &path, errp);
1427 visit_type_str(v, name, &path, errp);
1432 * object_resolve_link:
1434 * Lookup an object and ensure its type matches the link property type. This
1435 * is similar to object_resolve_path() except type verification against the
1436 * link property is performed.
1438 * Returns: The matched object or NULL on path lookup failures.
1440 static Object *object_resolve_link(Object *obj, const char *name,
1441 const char *path, Error **errp)
1445 bool ambiguous = false;
1448 /* Go from link<FOO> to FOO. */
1449 type = object_property_get_type(obj, name, NULL);
1450 target_type = g_strndup(&type[5], strlen(type) - 6);
1451 target = object_resolve_path_type(path, target_type, &ambiguous);
1454 error_setg(errp, "Path '%s' does not uniquely identify an object",
1456 } else if (!target) {
1457 target = object_resolve_path(path, &ambiguous);
1458 if (target || ambiguous) {
1459 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
1461 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1462 "Device '%s' not found", path);
1466 g_free(target_type);
1471 static void object_set_link_property(Object *obj, Visitor *v,
1472 const char *name, void *opaque,
1475 Error *local_err = NULL;
1476 LinkProperty *prop = opaque;
1477 Object **child = prop->child;
1478 Object *old_target = *child;
1479 Object *new_target = NULL;
1482 visit_type_str(v, name, &path, &local_err);
1484 if (!local_err && strcmp(path, "") != 0) {
1485 new_target = object_resolve_link(obj, name, path, &local_err);
1490 error_propagate(errp, local_err);
1494 prop->check(obj, name, new_target, &local_err);
1496 error_propagate(errp, local_err);
1500 object_ref(new_target);
1501 *child = new_target;
1502 object_unref(old_target);
1505 static Object *object_resolve_link_property(Object *parent, void *opaque, const gchar *part)
1507 LinkProperty *lprop = opaque;
1509 return *lprop->child;
1512 static void object_release_link_property(Object *obj, const char *name,
1515 LinkProperty *prop = opaque;
1517 if ((prop->flags & OBJ_PROP_LINK_UNREF_ON_RELEASE) && *prop->child) {
1518 object_unref(*prop->child);
1523 void object_property_add_link(Object *obj, const char *name,
1524 const char *type, Object **child,
1525 void (*check)(Object *, const char *,
1526 Object *, Error **),
1527 ObjectPropertyLinkFlags flags,
1530 Error *local_err = NULL;
1531 LinkProperty *prop = g_malloc(sizeof(*prop));
1535 prop->child = child;
1536 prop->check = check;
1537 prop->flags = flags;
1539 full_type = g_strdup_printf("link<%s>", type);
1541 op = object_property_add(obj, name, full_type,
1542 object_get_link_property,
1543 check ? object_set_link_property : NULL,
1544 object_release_link_property,
1548 error_propagate(errp, local_err);
1553 op->resolve = object_resolve_link_property;
1559 void object_property_add_const_link(Object *obj, const char *name,
1560 Object *target, Error **errp)
1565 link_type = g_strdup_printf("link<%s>", object_get_typename(target));
1566 op = object_property_add(obj, name, link_type,
1567 object_get_child_property, NULL,
1568 NULL, target, errp);
1570 op->resolve = object_resolve_child_property;
1575 gchar *object_get_canonical_path_component(Object *obj)
1577 ObjectProperty *prop = NULL;
1578 GHashTableIter iter;
1581 g_assert(obj->parent != NULL);
1583 g_hash_table_iter_init(&iter, obj->parent->properties);
1584 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
1585 if (!object_property_is_child(prop)) {
1589 if (prop->opaque == obj) {
1590 return g_strdup(prop->name);
1594 /* obj had a parent but was not a child, should never happen */
1595 g_assert_not_reached();
1599 gchar *object_get_canonical_path(Object *obj)
1601 Object *root = object_get_root();
1602 char *newpath, *path = NULL;
1604 while (obj != root) {
1605 char *component = object_get_canonical_path_component(obj);
1608 newpath = g_strdup_printf("%s/%s", component, path);
1619 newpath = g_strdup_printf("/%s", path ? path : "");
1625 Object *object_resolve_path_component(Object *parent, const gchar *part)
1627 ObjectProperty *prop = object_property_find(parent, part, NULL);
1632 if (prop->resolve) {
1633 return prop->resolve(parent, prop->opaque, part);
1639 static Object *object_resolve_abs_path(Object *parent,
1641 const char *typename,
1646 if (parts[index] == NULL) {
1647 return object_dynamic_cast(parent, typename);
1650 if (strcmp(parts[index], "") == 0) {
1651 return object_resolve_abs_path(parent, parts, typename, index + 1);
1654 child = object_resolve_path_component(parent, parts[index]);
1659 return object_resolve_abs_path(child, parts, typename, index + 1);
1662 static Object *object_resolve_partial_path(Object *parent,
1664 const char *typename,
1668 GHashTableIter iter;
1669 ObjectProperty *prop;
1671 obj = object_resolve_abs_path(parent, parts, typename, 0);
1673 g_hash_table_iter_init(&iter, parent->properties);
1674 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
1677 if (!object_property_is_child(prop)) {
1681 found = object_resolve_partial_path(prop->opaque, parts,
1682 typename, ambiguous);
1693 if (ambiguous && *ambiguous) {
1701 Object *object_resolve_path_type(const char *path, const char *typename,
1707 parts = g_strsplit(path, "/", 0);
1710 if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
1714 obj = object_resolve_partial_path(object_get_root(), parts,
1715 typename, ambiguous);
1717 obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
1725 Object *object_resolve_path(const char *path, bool *ambiguous)
1727 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
1730 typedef struct StringProperty
1732 char *(*get)(Object *, Error **);
1733 void (*set)(Object *, const char *, Error **);
1736 static void property_get_str(Object *obj, Visitor *v, const char *name,
1737 void *opaque, Error **errp)
1739 StringProperty *prop = opaque;
1743 value = prop->get(obj, &err);
1745 error_propagate(errp, err);
1749 visit_type_str(v, name, &value, errp);
1753 static void property_set_str(Object *obj, Visitor *v, const char *name,
1754 void *opaque, Error **errp)
1756 StringProperty *prop = opaque;
1758 Error *local_err = NULL;
1760 visit_type_str(v, name, &value, &local_err);
1762 error_propagate(errp, local_err);
1766 prop->set(obj, value, errp);
1770 static void property_release_str(Object *obj, const char *name,
1773 StringProperty *prop = opaque;
1777 void object_property_add_str(Object *obj, const char *name,
1778 char *(*get)(Object *, Error **),
1779 void (*set)(Object *, const char *, Error **),
1782 Error *local_err = NULL;
1783 StringProperty *prop = g_malloc0(sizeof(*prop));
1788 object_property_add(obj, name, "string",
1789 get ? property_get_str : NULL,
1790 set ? property_set_str : NULL,
1791 property_release_str,
1794 error_propagate(errp, local_err);
1799 void object_class_property_add_str(ObjectClass *klass, const char *name,
1800 char *(*get)(Object *, Error **),
1801 void (*set)(Object *, const char *,
1805 Error *local_err = NULL;
1806 StringProperty *prop = g_malloc0(sizeof(*prop));
1811 object_class_property_add(klass, name, "string",
1812 get ? property_get_str : NULL,
1813 set ? property_set_str : NULL,
1814 property_release_str,
1817 error_propagate(errp, local_err);
1822 typedef struct BoolProperty
1824 bool (*get)(Object *, Error **);
1825 void (*set)(Object *, bool, Error **);
1828 static void property_get_bool(Object *obj, Visitor *v, const char *name,
1829 void *opaque, Error **errp)
1831 BoolProperty *prop = opaque;
1835 value = prop->get(obj, &err);
1837 error_propagate(errp, err);
1841 visit_type_bool(v, name, &value, errp);
1844 static void property_set_bool(Object *obj, Visitor *v, const char *name,
1845 void *opaque, Error **errp)
1847 BoolProperty *prop = opaque;
1849 Error *local_err = NULL;
1851 visit_type_bool(v, name, &value, &local_err);
1853 error_propagate(errp, local_err);
1857 prop->set(obj, value, errp);
1860 static void property_release_bool(Object *obj, const char *name,
1863 BoolProperty *prop = opaque;
1867 void object_property_add_bool(Object *obj, const char *name,
1868 bool (*get)(Object *, Error **),
1869 void (*set)(Object *, bool, Error **),
1872 Error *local_err = NULL;
1873 BoolProperty *prop = g_malloc0(sizeof(*prop));
1878 object_property_add(obj, name, "bool",
1879 get ? property_get_bool : NULL,
1880 set ? property_set_bool : NULL,
1881 property_release_bool,
1884 error_propagate(errp, local_err);
1889 void object_class_property_add_bool(ObjectClass *klass, const char *name,
1890 bool (*get)(Object *, Error **),
1891 void (*set)(Object *, bool, Error **),
1894 Error *local_err = NULL;
1895 BoolProperty *prop = g_malloc0(sizeof(*prop));
1900 object_class_property_add(klass, name, "bool",
1901 get ? property_get_bool : NULL,
1902 set ? property_set_bool : NULL,
1903 property_release_bool,
1906 error_propagate(errp, local_err);
1911 static void property_get_enum(Object *obj, Visitor *v, const char *name,
1912 void *opaque, Error **errp)
1914 EnumProperty *prop = opaque;
1918 value = prop->get(obj, &err);
1920 error_propagate(errp, err);
1924 visit_type_enum(v, name, &value, prop->strings, errp);
1927 static void property_set_enum(Object *obj, Visitor *v, const char *name,
1928 void *opaque, Error **errp)
1930 EnumProperty *prop = opaque;
1934 visit_type_enum(v, name, &value, prop->strings, &err);
1936 error_propagate(errp, err);
1939 prop->set(obj, value, errp);
1942 static void property_release_enum(Object *obj, const char *name,
1945 EnumProperty *prop = opaque;
1949 void object_property_add_enum(Object *obj, const char *name,
1950 const char *typename,
1951 const char * const *strings,
1952 int (*get)(Object *, Error **),
1953 void (*set)(Object *, int, Error **),
1956 Error *local_err = NULL;
1957 EnumProperty *prop = g_malloc(sizeof(*prop));
1959 prop->strings = strings;
1963 object_property_add(obj, name, typename,
1964 get ? property_get_enum : NULL,
1965 set ? property_set_enum : NULL,
1966 property_release_enum,
1969 error_propagate(errp, local_err);
1974 void object_class_property_add_enum(ObjectClass *klass, const char *name,
1975 const char *typename,
1976 const char * const *strings,
1977 int (*get)(Object *, Error **),
1978 void (*set)(Object *, int, Error **),
1981 Error *local_err = NULL;
1982 EnumProperty *prop = g_malloc(sizeof(*prop));
1984 prop->strings = strings;
1988 object_class_property_add(klass, name, typename,
1989 get ? property_get_enum : NULL,
1990 set ? property_set_enum : NULL,
1991 property_release_enum,
1994 error_propagate(errp, local_err);
1999 typedef struct TMProperty {
2000 void (*get)(Object *, struct tm *, Error **);
2003 static void property_get_tm(Object *obj, Visitor *v, const char *name,
2004 void *opaque, Error **errp)
2006 TMProperty *prop = opaque;
2010 prop->get(obj, &value, &err);
2015 visit_start_struct(v, name, NULL, 0, &err);
2019 visit_type_int32(v, "tm_year", &value.tm_year, &err);
2023 visit_type_int32(v, "tm_mon", &value.tm_mon, &err);
2027 visit_type_int32(v, "tm_mday", &value.tm_mday, &err);
2031 visit_type_int32(v, "tm_hour", &value.tm_hour, &err);
2035 visit_type_int32(v, "tm_min", &value.tm_min, &err);
2039 visit_type_int32(v, "tm_sec", &value.tm_sec, &err);
2043 visit_check_struct(v, &err);
2045 visit_end_struct(v, NULL);
2047 error_propagate(errp, err);
2051 static void property_release_tm(Object *obj, const char *name,
2054 TMProperty *prop = opaque;
2058 void object_property_add_tm(Object *obj, const char *name,
2059 void (*get)(Object *, struct tm *, Error **),
2062 Error *local_err = NULL;
2063 TMProperty *prop = g_malloc0(sizeof(*prop));
2067 object_property_add(obj, name, "struct tm",
2068 get ? property_get_tm : NULL, NULL,
2069 property_release_tm,
2072 error_propagate(errp, local_err);
2077 void object_class_property_add_tm(ObjectClass *klass, const char *name,
2078 void (*get)(Object *, struct tm *, Error **),
2081 Error *local_err = NULL;
2082 TMProperty *prop = g_malloc0(sizeof(*prop));
2086 object_class_property_add(klass, name, "struct tm",
2087 get ? property_get_tm : NULL, NULL,
2088 property_release_tm,
2091 error_propagate(errp, local_err);
2096 static char *qdev_get_type(Object *obj, Error **errp)
2098 return g_strdup(object_get_typename(obj));
2101 static void property_get_uint8_ptr(Object *obj, Visitor *v, const char *name,
2102 void *opaque, Error **errp)
2104 uint8_t value = *(uint8_t *)opaque;
2105 visit_type_uint8(v, name, &value, errp);
2108 static void property_get_uint16_ptr(Object *obj, Visitor *v, const char *name,
2109 void *opaque, Error **errp)
2111 uint16_t value = *(uint16_t *)opaque;
2112 visit_type_uint16(v, name, &value, errp);
2115 static void property_get_uint32_ptr(Object *obj, Visitor *v, const char *name,
2116 void *opaque, Error **errp)
2118 uint32_t value = *(uint32_t *)opaque;
2119 visit_type_uint32(v, name, &value, errp);
2122 static void property_get_uint64_ptr(Object *obj, Visitor *v, const char *name,
2123 void *opaque, Error **errp)
2125 uint64_t value = *(uint64_t *)opaque;
2126 visit_type_uint64(v, name, &value, errp);
2129 void object_property_add_uint8_ptr(Object *obj, const char *name,
2130 const uint8_t *v, Error **errp)
2132 object_property_add(obj, name, "uint8", property_get_uint8_ptr,
2133 NULL, NULL, (void *)v, errp);
2136 void object_class_property_add_uint8_ptr(ObjectClass *klass, const char *name,
2137 const uint8_t *v, Error **errp)
2139 object_class_property_add(klass, name, "uint8", property_get_uint8_ptr,
2140 NULL, NULL, (void *)v, errp);
2143 void object_property_add_uint16_ptr(Object *obj, const char *name,
2144 const uint16_t *v, Error **errp)
2146 object_property_add(obj, name, "uint16", property_get_uint16_ptr,
2147 NULL, NULL, (void *)v, errp);
2150 void object_class_property_add_uint16_ptr(ObjectClass *klass, const char *name,
2151 const uint16_t *v, Error **errp)
2153 object_class_property_add(klass, name, "uint16", property_get_uint16_ptr,
2154 NULL, NULL, (void *)v, errp);
2157 void object_property_add_uint32_ptr(Object *obj, const char *name,
2158 const uint32_t *v, Error **errp)
2160 object_property_add(obj, name, "uint32", property_get_uint32_ptr,
2161 NULL, NULL, (void *)v, errp);
2164 void object_class_property_add_uint32_ptr(ObjectClass *klass, const char *name,
2165 const uint32_t *v, Error **errp)
2167 object_class_property_add(klass, name, "uint32", property_get_uint32_ptr,
2168 NULL, NULL, (void *)v, errp);
2171 void object_property_add_uint64_ptr(Object *obj, const char *name,
2172 const uint64_t *v, Error **errp)
2174 object_property_add(obj, name, "uint64", property_get_uint64_ptr,
2175 NULL, NULL, (void *)v, errp);
2178 void object_class_property_add_uint64_ptr(ObjectClass *klass, const char *name,
2179 const uint64_t *v, Error **errp)
2181 object_class_property_add(klass, name, "uint64", property_get_uint64_ptr,
2182 NULL, NULL, (void *)v, errp);
2190 static void property_get_alias(Object *obj, Visitor *v, const char *name,
2191 void *opaque, Error **errp)
2193 AliasProperty *prop = opaque;
2195 object_property_get(prop->target_obj, v, prop->target_name, errp);
2198 static void property_set_alias(Object *obj, Visitor *v, const char *name,
2199 void *opaque, Error **errp)
2201 AliasProperty *prop = opaque;
2203 object_property_set(prop->target_obj, v, prop->target_name, errp);
2206 static Object *property_resolve_alias(Object *obj, void *opaque,
2209 AliasProperty *prop = opaque;
2211 return object_resolve_path_component(prop->target_obj, prop->target_name);
2214 static void property_release_alias(Object *obj, const char *name, void *opaque)
2216 AliasProperty *prop = opaque;
2218 g_free(prop->target_name);
2222 void object_property_add_alias(Object *obj, const char *name,
2223 Object *target_obj, const char *target_name,
2226 AliasProperty *prop;
2228 ObjectProperty *target_prop;
2230 Error *local_err = NULL;
2232 target_prop = object_property_find(target_obj, target_name, errp);
2237 if (object_property_is_child(target_prop)) {
2238 prop_type = g_strdup_printf("link%s",
2239 target_prop->type + strlen("child"));
2241 prop_type = g_strdup(target_prop->type);
2244 prop = g_malloc(sizeof(*prop));
2245 prop->target_obj = target_obj;
2246 prop->target_name = g_strdup(target_name);
2248 op = object_property_add(obj, name, prop_type,
2251 property_release_alias,
2254 error_propagate(errp, local_err);
2258 op->resolve = property_resolve_alias;
2260 object_property_set_description(obj, op->name,
2261 target_prop->description,
2268 void object_property_set_description(Object *obj, const char *name,
2269 const char *description, Error **errp)
2273 op = object_property_find(obj, name, errp);
2278 g_free(op->description);
2279 op->description = g_strdup(description);
2282 void object_class_property_set_description(ObjectClass *klass,
2284 const char *description,
2289 op = g_hash_table_lookup(klass->properties, name);
2291 error_setg(errp, "Property '.%s' not found", name);
2295 g_free(op->description);
2296 op->description = g_strdup(description);
2299 static void object_instance_init(Object *obj)
2301 object_property_add_str(obj, "type", qdev_get_type, NULL, NULL);
2304 static void register_types(void)
2306 static TypeInfo interface_info = {
2307 .name = TYPE_INTERFACE,
2308 .class_size = sizeof(InterfaceClass),
2312 static TypeInfo object_info = {
2313 .name = TYPE_OBJECT,
2314 .instance_size = sizeof(Object),
2315 .instance_init = object_instance_init,
2319 type_interface = type_register_internal(&interface_info);
2320 type_register_internal(&object_info);
2323 type_init(register_types)