blkdebug: Delete BH in bdrv_aio_cancel
[qemu.git] / qom / object.c
blob1b00831efce662275a583ffbd3aab8c44015c4f3
1 /*
2 * QEMU Object Model
4 * Copyright IBM, Corp. 2011
6 * Authors:
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 "qom/object.h"
14 #include "qemu-common.h"
15 #include "qapi/visitor.h"
16 #include "qapi-visit.h"
17 #include "qapi/string-input-visitor.h"
18 #include "qapi/string-output-visitor.h"
19 #include "qapi/qmp/qerror.h"
20 #include "trace.h"
22 /* TODO: replace QObject with a simpler visitor to avoid a dependency
23 * of the QOM core on QObject? */
24 #include "qom/qom-qobject.h"
25 #include "qapi/qmp/qobject.h"
26 #include "qapi/qmp/qbool.h"
27 #include "qapi/qmp/qint.h"
28 #include "qapi/qmp/qstring.h"
30 #define MAX_INTERFACES 32
32 typedef struct InterfaceImpl InterfaceImpl;
33 typedef struct TypeImpl TypeImpl;
35 struct InterfaceImpl
37 const char *typename;
40 struct TypeImpl
42 const char *name;
44 size_t class_size;
46 size_t instance_size;
48 void (*class_init)(ObjectClass *klass, void *data);
49 void (*class_base_init)(ObjectClass *klass, void *data);
50 void (*class_finalize)(ObjectClass *klass, void *data);
52 void *class_data;
54 void (*instance_init)(Object *obj);
55 void (*instance_post_init)(Object *obj);
56 void (*instance_finalize)(Object *obj);
58 bool abstract;
60 const char *parent;
61 TypeImpl *parent_type;
63 ObjectClass *class;
65 int num_interfaces;
66 InterfaceImpl interfaces[MAX_INTERFACES];
69 static Type type_interface;
71 static GHashTable *type_table_get(void)
73 static GHashTable *type_table;
75 if (type_table == NULL) {
76 type_table = g_hash_table_new(g_str_hash, g_str_equal);
79 return type_table;
82 static bool enumerating_types;
84 static void type_table_add(TypeImpl *ti)
86 assert(!enumerating_types);
87 g_hash_table_insert(type_table_get(), (void *)ti->name, ti);
90 static TypeImpl *type_table_lookup(const char *name)
92 return g_hash_table_lookup(type_table_get(), name);
95 static TypeImpl *type_new(const TypeInfo *info)
97 TypeImpl *ti = g_malloc0(sizeof(*ti));
98 int i;
100 g_assert(info->name != NULL);
102 if (type_table_lookup(info->name) != NULL) {
103 fprintf(stderr, "Registering `%s' which already exists\n", info->name);
104 abort();
107 ti->name = g_strdup(info->name);
108 ti->parent = g_strdup(info->parent);
110 ti->class_size = info->class_size;
111 ti->instance_size = info->instance_size;
113 ti->class_init = info->class_init;
114 ti->class_base_init = info->class_base_init;
115 ti->class_finalize = info->class_finalize;
116 ti->class_data = info->class_data;
118 ti->instance_init = info->instance_init;
119 ti->instance_post_init = info->instance_post_init;
120 ti->instance_finalize = info->instance_finalize;
122 ti->abstract = info->abstract;
124 for (i = 0; info->interfaces && info->interfaces[i].type; i++) {
125 ti->interfaces[i].typename = g_strdup(info->interfaces[i].type);
127 ti->num_interfaces = i;
129 return ti;
132 static TypeImpl *type_register_internal(const TypeInfo *info)
134 TypeImpl *ti;
135 ti = type_new(info);
137 type_table_add(ti);
138 return ti;
141 TypeImpl *type_register(const TypeInfo *info)
143 assert(info->parent);
144 return type_register_internal(info);
147 TypeImpl *type_register_static(const TypeInfo *info)
149 return type_register(info);
152 static TypeImpl *type_get_by_name(const char *name)
154 if (name == NULL) {
155 return NULL;
158 return type_table_lookup(name);
161 static TypeImpl *type_get_parent(TypeImpl *type)
163 if (!type->parent_type && type->parent) {
164 type->parent_type = type_get_by_name(type->parent);
165 g_assert(type->parent_type != NULL);
168 return type->parent_type;
171 static bool type_has_parent(TypeImpl *type)
173 return (type->parent != NULL);
176 static size_t type_class_get_size(TypeImpl *ti)
178 if (ti->class_size) {
179 return ti->class_size;
182 if (type_has_parent(ti)) {
183 return type_class_get_size(type_get_parent(ti));
186 return sizeof(ObjectClass);
189 static size_t type_object_get_size(TypeImpl *ti)
191 if (ti->instance_size) {
192 return ti->instance_size;
195 if (type_has_parent(ti)) {
196 return type_object_get_size(type_get_parent(ti));
199 return 0;
202 static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
204 assert(target_type);
206 /* Check if typename is a direct ancestor of type */
207 while (type) {
208 if (type == target_type) {
209 return true;
212 type = type_get_parent(type);
215 return false;
218 static void type_initialize(TypeImpl *ti);
220 static void type_initialize_interface(TypeImpl *ti, TypeImpl *interface_type,
221 TypeImpl *parent_type)
223 InterfaceClass *new_iface;
224 TypeInfo info = { };
225 TypeImpl *iface_impl;
227 info.parent = parent_type->name;
228 info.name = g_strdup_printf("%s::%s", ti->name, interface_type->name);
229 info.abstract = true;
231 iface_impl = type_new(&info);
232 iface_impl->parent_type = parent_type;
233 type_initialize(iface_impl);
234 g_free((char *)info.name);
236 new_iface = (InterfaceClass *)iface_impl->class;
237 new_iface->concrete_class = ti->class;
238 new_iface->interface_type = interface_type;
240 ti->class->interfaces = g_slist_append(ti->class->interfaces,
241 iface_impl->class);
244 static void type_initialize(TypeImpl *ti)
246 TypeImpl *parent;
248 if (ti->class) {
249 return;
252 ti->class_size = type_class_get_size(ti);
253 ti->instance_size = type_object_get_size(ti);
255 ti->class = g_malloc0(ti->class_size);
257 parent = type_get_parent(ti);
258 if (parent) {
259 type_initialize(parent);
260 GSList *e;
261 int i;
263 g_assert(parent->class_size <= ti->class_size);
264 memcpy(ti->class, parent->class, parent->class_size);
265 ti->class->interfaces = NULL;
267 for (e = parent->class->interfaces; e; e = e->next) {
268 InterfaceClass *iface = e->data;
269 ObjectClass *klass = OBJECT_CLASS(iface);
271 type_initialize_interface(ti, iface->interface_type, klass->type);
274 for (i = 0; i < ti->num_interfaces; i++) {
275 TypeImpl *t = type_get_by_name(ti->interfaces[i].typename);
276 for (e = ti->class->interfaces; e; e = e->next) {
277 TypeImpl *target_type = OBJECT_CLASS(e->data)->type;
279 if (type_is_ancestor(target_type, t)) {
280 break;
284 if (e) {
285 continue;
288 type_initialize_interface(ti, t, t);
292 ti->class->type = ti;
294 while (parent) {
295 if (parent->class_base_init) {
296 parent->class_base_init(ti->class, ti->class_data);
298 parent = type_get_parent(parent);
301 if (ti->class_init) {
302 ti->class_init(ti->class, ti->class_data);
306 static void object_init_with_type(Object *obj, TypeImpl *ti)
308 if (type_has_parent(ti)) {
309 object_init_with_type(obj, type_get_parent(ti));
312 if (ti->instance_init) {
313 ti->instance_init(obj);
317 static void object_post_init_with_type(Object *obj, TypeImpl *ti)
319 if (ti->instance_post_init) {
320 ti->instance_post_init(obj);
323 if (type_has_parent(ti)) {
324 object_post_init_with_type(obj, type_get_parent(ti));
328 void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
330 Object *obj = data;
332 g_assert(type != NULL);
333 type_initialize(type);
335 g_assert(type->instance_size >= sizeof(Object));
336 g_assert(type->abstract == false);
337 g_assert(size >= type->instance_size);
339 memset(obj, 0, type->instance_size);
340 obj->class = type->class;
341 object_ref(obj);
342 QTAILQ_INIT(&obj->properties);
343 object_init_with_type(obj, type);
344 object_post_init_with_type(obj, type);
347 void object_initialize(void *data, size_t size, const char *typename)
349 TypeImpl *type = type_get_by_name(typename);
351 object_initialize_with_type(data, size, type);
354 static inline bool object_property_is_child(ObjectProperty *prop)
356 return strstart(prop->type, "child<", NULL);
359 static void object_property_del_all(Object *obj)
361 while (!QTAILQ_EMPTY(&obj->properties)) {
362 ObjectProperty *prop = QTAILQ_FIRST(&obj->properties);
364 QTAILQ_REMOVE(&obj->properties, prop, node);
366 if (prop->release) {
367 prop->release(obj, prop->name, prop->opaque);
370 g_free(prop->name);
371 g_free(prop->type);
372 g_free(prop);
376 static void object_property_del_child(Object *obj, Object *child, Error **errp)
378 ObjectProperty *prop;
380 QTAILQ_FOREACH(prop, &obj->properties, node) {
381 if (object_property_is_child(prop) && prop->opaque == child) {
382 object_property_del(obj, prop->name, errp);
383 break;
388 void object_unparent(Object *obj)
390 if (obj->parent) {
391 object_property_del_child(obj->parent, obj, NULL);
395 static void object_deinit(Object *obj, TypeImpl *type)
397 if (type->instance_finalize) {
398 type->instance_finalize(obj);
401 if (type_has_parent(type)) {
402 object_deinit(obj, type_get_parent(type));
406 static void object_finalize(void *data)
408 Object *obj = data;
409 TypeImpl *ti = obj->class->type;
411 object_property_del_all(obj);
412 object_deinit(obj, ti);
414 g_assert(obj->ref == 0);
415 if (obj->free) {
416 obj->free(obj);
420 Object *object_new_with_type(Type type)
422 Object *obj;
424 g_assert(type != NULL);
425 type_initialize(type);
427 obj = g_malloc(type->instance_size);
428 object_initialize_with_type(obj, type->instance_size, type);
429 obj->free = g_free;
431 return obj;
434 Object *object_new(const char *typename)
436 TypeImpl *ti = type_get_by_name(typename);
438 return object_new_with_type(ti);
441 Object *object_dynamic_cast(Object *obj, const char *typename)
443 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
444 return obj;
447 return NULL;
450 Object *object_dynamic_cast_assert(Object *obj, const char *typename,
451 const char *file, int line, const char *func)
453 trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
454 typename, file, line, func);
456 #ifdef CONFIG_QOM_CAST_DEBUG
457 int i;
458 Object *inst;
460 for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
461 if (obj->class->object_cast_cache[i] == typename) {
462 goto out;
466 inst = object_dynamic_cast(obj, typename);
468 if (!inst && obj) {
469 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
470 file, line, func, obj, typename);
471 abort();
474 assert(obj == inst);
476 if (obj && obj == inst) {
477 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
478 obj->class->object_cast_cache[i - 1] =
479 obj->class->object_cast_cache[i];
481 obj->class->object_cast_cache[i - 1] = typename;
484 out:
485 #endif
486 return obj;
489 ObjectClass *object_class_dynamic_cast(ObjectClass *class,
490 const char *typename)
492 ObjectClass *ret = NULL;
493 TypeImpl *target_type;
494 TypeImpl *type;
496 if (!class) {
497 return NULL;
500 /* A simple fast path that can trigger a lot for leaf classes. */
501 type = class->type;
502 if (type->name == typename) {
503 return class;
506 target_type = type_get_by_name(typename);
507 if (!target_type) {
508 /* target class type unknown, so fail the cast */
509 return NULL;
512 if (type->class->interfaces &&
513 type_is_ancestor(target_type, type_interface)) {
514 int found = 0;
515 GSList *i;
517 for (i = class->interfaces; i; i = i->next) {
518 ObjectClass *target_class = i->data;
520 if (type_is_ancestor(target_class->type, target_type)) {
521 ret = target_class;
522 found++;
526 /* The match was ambiguous, don't allow a cast */
527 if (found > 1) {
528 ret = NULL;
530 } else if (type_is_ancestor(type, target_type)) {
531 ret = class;
534 return ret;
537 ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
538 const char *typename,
539 const char *file, int line,
540 const char *func)
542 ObjectClass *ret;
544 trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)",
545 typename, file, line, func);
547 #ifdef CONFIG_QOM_CAST_DEBUG
548 int i;
550 for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
551 if (class->class_cast_cache[i] == typename) {
552 ret = class;
553 goto out;
556 #else
557 if (!class || !class->interfaces) {
558 return class;
560 #endif
562 ret = object_class_dynamic_cast(class, typename);
563 if (!ret && class) {
564 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
565 file, line, func, class, typename);
566 abort();
569 #ifdef CONFIG_QOM_CAST_DEBUG
570 if (class && ret == class) {
571 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
572 class->class_cast_cache[i - 1] = class->class_cast_cache[i];
574 class->class_cast_cache[i - 1] = typename;
576 out:
577 #endif
578 return ret;
581 const char *object_get_typename(Object *obj)
583 return obj->class->type->name;
586 ObjectClass *object_get_class(Object *obj)
588 return obj->class;
591 bool object_class_is_abstract(ObjectClass *klass)
593 return klass->type->abstract;
596 const char *object_class_get_name(ObjectClass *klass)
598 return klass->type->name;
601 ObjectClass *object_class_by_name(const char *typename)
603 TypeImpl *type = type_get_by_name(typename);
605 if (!type) {
606 return NULL;
609 type_initialize(type);
611 return type->class;
614 ObjectClass *object_class_get_parent(ObjectClass *class)
616 TypeImpl *type = type_get_parent(class->type);
618 if (!type) {
619 return NULL;
622 type_initialize(type);
624 return type->class;
627 typedef struct OCFData
629 void (*fn)(ObjectClass *klass, void *opaque);
630 const char *implements_type;
631 bool include_abstract;
632 void *opaque;
633 } OCFData;
635 static void object_class_foreach_tramp(gpointer key, gpointer value,
636 gpointer opaque)
638 OCFData *data = opaque;
639 TypeImpl *type = value;
640 ObjectClass *k;
642 type_initialize(type);
643 k = type->class;
645 if (!data->include_abstract && type->abstract) {
646 return;
649 if (data->implements_type &&
650 !object_class_dynamic_cast(k, data->implements_type)) {
651 return;
654 data->fn(k, data->opaque);
657 void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
658 const char *implements_type, bool include_abstract,
659 void *opaque)
661 OCFData data = { fn, implements_type, include_abstract, opaque };
663 enumerating_types = true;
664 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
665 enumerating_types = false;
668 int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
669 void *opaque)
671 ObjectProperty *prop;
672 int ret = 0;
674 QTAILQ_FOREACH(prop, &obj->properties, node) {
675 if (object_property_is_child(prop)) {
676 ret = fn(prop->opaque, opaque);
677 if (ret != 0) {
678 break;
682 return ret;
685 static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
687 GSList **list = opaque;
689 *list = g_slist_prepend(*list, klass);
692 GSList *object_class_get_list(const char *implements_type,
693 bool include_abstract)
695 GSList *list = NULL;
697 object_class_foreach(object_class_get_list_tramp,
698 implements_type, include_abstract, &list);
699 return list;
702 void object_ref(Object *obj)
704 if (!obj) {
705 return;
707 atomic_inc(&obj->ref);
710 void object_unref(Object *obj)
712 if (!obj) {
713 return;
715 g_assert(obj->ref > 0);
717 /* parent always holds a reference to its children */
718 if (atomic_fetch_dec(&obj->ref) == 1) {
719 object_finalize(obj);
723 ObjectProperty *
724 object_property_add(Object *obj, const char *name, const char *type,
725 ObjectPropertyAccessor *get,
726 ObjectPropertyAccessor *set,
727 ObjectPropertyRelease *release,
728 void *opaque, Error **errp)
730 ObjectProperty *prop;
732 QTAILQ_FOREACH(prop, &obj->properties, node) {
733 if (strcmp(prop->name, name) == 0) {
734 error_setg(errp, "attempt to add duplicate property '%s'"
735 " to object (type '%s')", name,
736 object_get_typename(obj));
737 return NULL;
741 prop = g_malloc0(sizeof(*prop));
743 prop->name = g_strdup(name);
744 prop->type = g_strdup(type);
746 prop->get = get;
747 prop->set = set;
748 prop->release = release;
749 prop->opaque = opaque;
751 QTAILQ_INSERT_TAIL(&obj->properties, prop, node);
752 return prop;
755 ObjectProperty *object_property_find(Object *obj, const char *name,
756 Error **errp)
758 ObjectProperty *prop;
760 QTAILQ_FOREACH(prop, &obj->properties, node) {
761 if (strcmp(prop->name, name) == 0) {
762 return prop;
766 error_setg(errp, "Property '.%s' not found", name);
767 return NULL;
770 void object_property_del(Object *obj, const char *name, Error **errp)
772 ObjectProperty *prop = object_property_find(obj, name, errp);
773 if (prop == NULL) {
774 return;
777 if (prop->release) {
778 prop->release(obj, name, prop->opaque);
781 QTAILQ_REMOVE(&obj->properties, prop, node);
783 g_free(prop->name);
784 g_free(prop->type);
785 g_free(prop);
788 void object_property_get(Object *obj, Visitor *v, const char *name,
789 Error **errp)
791 ObjectProperty *prop = object_property_find(obj, name, errp);
792 if (prop == NULL) {
793 return;
796 if (!prop->get) {
797 error_set(errp, QERR_PERMISSION_DENIED);
798 } else {
799 prop->get(obj, v, prop->opaque, name, errp);
803 void object_property_set(Object *obj, Visitor *v, const char *name,
804 Error **errp)
806 ObjectProperty *prop = object_property_find(obj, name, errp);
807 if (prop == NULL) {
808 return;
811 if (!prop->set) {
812 error_set(errp, QERR_PERMISSION_DENIED);
813 } else {
814 prop->set(obj, v, prop->opaque, name, errp);
818 void object_property_set_str(Object *obj, const char *value,
819 const char *name, Error **errp)
821 QString *qstr = qstring_from_str(value);
822 object_property_set_qobject(obj, QOBJECT(qstr), name, errp);
824 QDECREF(qstr);
827 char *object_property_get_str(Object *obj, const char *name,
828 Error **errp)
830 QObject *ret = object_property_get_qobject(obj, name, errp);
831 QString *qstring;
832 char *retval;
834 if (!ret) {
835 return NULL;
837 qstring = qobject_to_qstring(ret);
838 if (!qstring) {
839 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
840 retval = NULL;
841 } else {
842 retval = g_strdup(qstring_get_str(qstring));
845 QDECREF(qstring);
846 return retval;
849 void object_property_set_link(Object *obj, Object *value,
850 const char *name, Error **errp)
852 gchar *path = object_get_canonical_path(value);
853 object_property_set_str(obj, path, name, errp);
854 g_free(path);
857 Object *object_property_get_link(Object *obj, const char *name,
858 Error **errp)
860 char *str = object_property_get_str(obj, name, errp);
861 Object *target = NULL;
863 if (str && *str) {
864 target = object_resolve_path(str, NULL);
865 if (!target) {
866 error_set(errp, QERR_DEVICE_NOT_FOUND, str);
870 g_free(str);
871 return target;
874 void object_property_set_bool(Object *obj, bool value,
875 const char *name, Error **errp)
877 QBool *qbool = qbool_from_int(value);
878 object_property_set_qobject(obj, QOBJECT(qbool), name, errp);
880 QDECREF(qbool);
883 bool object_property_get_bool(Object *obj, const char *name,
884 Error **errp)
886 QObject *ret = object_property_get_qobject(obj, name, errp);
887 QBool *qbool;
888 bool retval;
890 if (!ret) {
891 return false;
893 qbool = qobject_to_qbool(ret);
894 if (!qbool) {
895 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
896 retval = false;
897 } else {
898 retval = qbool_get_int(qbool);
901 QDECREF(qbool);
902 return retval;
905 void object_property_set_int(Object *obj, int64_t value,
906 const char *name, Error **errp)
908 QInt *qint = qint_from_int(value);
909 object_property_set_qobject(obj, QOBJECT(qint), name, errp);
911 QDECREF(qint);
914 int64_t object_property_get_int(Object *obj, const char *name,
915 Error **errp)
917 QObject *ret = object_property_get_qobject(obj, name, errp);
918 QInt *qint;
919 int64_t retval;
921 if (!ret) {
922 return -1;
924 qint = qobject_to_qint(ret);
925 if (!qint) {
926 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
927 retval = -1;
928 } else {
929 retval = qint_get_int(qint);
932 QDECREF(qint);
933 return retval;
936 int object_property_get_enum(Object *obj, const char *name,
937 const char *strings[], Error **errp)
939 StringOutputVisitor *sov;
940 StringInputVisitor *siv;
941 int ret;
943 sov = string_output_visitor_new(false);
944 object_property_get(obj, string_output_get_visitor(sov), name, errp);
945 siv = string_input_visitor_new(string_output_get_string(sov));
946 string_output_visitor_cleanup(sov);
947 visit_type_enum(string_input_get_visitor(siv),
948 &ret, strings, NULL, name, errp);
949 string_input_visitor_cleanup(siv);
951 return ret;
954 void object_property_get_uint16List(Object *obj, const char *name,
955 uint16List **list, Error **errp)
957 StringOutputVisitor *ov;
958 StringInputVisitor *iv;
960 ov = string_output_visitor_new(false);
961 object_property_get(obj, string_output_get_visitor(ov),
962 name, errp);
963 iv = string_input_visitor_new(string_output_get_string(ov));
964 visit_type_uint16List(string_input_get_visitor(iv),
965 list, NULL, errp);
966 string_output_visitor_cleanup(ov);
967 string_input_visitor_cleanup(iv);
970 void object_property_parse(Object *obj, const char *string,
971 const char *name, Error **errp)
973 StringInputVisitor *mi;
974 mi = string_input_visitor_new(string);
975 object_property_set(obj, string_input_get_visitor(mi), name, errp);
977 string_input_visitor_cleanup(mi);
980 char *object_property_print(Object *obj, const char *name, bool human,
981 Error **errp)
983 StringOutputVisitor *mo;
984 char *string;
986 mo = string_output_visitor_new(human);
987 object_property_get(obj, string_output_get_visitor(mo), name, errp);
988 string = string_output_get_string(mo);
989 string_output_visitor_cleanup(mo);
990 return string;
993 const char *object_property_get_type(Object *obj, const char *name, Error **errp)
995 ObjectProperty *prop = object_property_find(obj, name, errp);
996 if (prop == NULL) {
997 return NULL;
1000 return prop->type;
1003 Object *object_get_root(void)
1005 static Object *root;
1007 if (!root) {
1008 root = object_new("container");
1011 return root;
1014 static void object_get_child_property(Object *obj, Visitor *v, void *opaque,
1015 const char *name, Error **errp)
1017 Object *child = opaque;
1018 gchar *path;
1020 path = object_get_canonical_path(child);
1021 visit_type_str(v, &path, name, errp);
1022 g_free(path);
1025 static Object *object_resolve_child_property(Object *parent, void *opaque, const gchar *part)
1027 return opaque;
1030 static void object_finalize_child_property(Object *obj, const char *name,
1031 void *opaque)
1033 Object *child = opaque;
1035 if (child->class->unparent) {
1036 (child->class->unparent)(child);
1038 child->parent = NULL;
1039 object_unref(child);
1042 void object_property_add_child(Object *obj, const char *name,
1043 Object *child, Error **errp)
1045 Error *local_err = NULL;
1046 gchar *type;
1047 ObjectProperty *op;
1049 type = g_strdup_printf("child<%s>", object_get_typename(OBJECT(child)));
1051 op = object_property_add(obj, name, type, object_get_child_property, NULL,
1052 object_finalize_child_property, child, &local_err);
1053 if (local_err) {
1054 error_propagate(errp, local_err);
1055 goto out;
1058 op->resolve = object_resolve_child_property;
1059 object_ref(child);
1060 g_assert(child->parent == NULL);
1061 child->parent = obj;
1063 out:
1064 g_free(type);
1067 void object_property_allow_set_link(Object *obj, const char *name,
1068 Object *val, Error **errp)
1070 /* Allow the link to be set, always */
1073 typedef struct {
1074 Object **child;
1075 void (*check)(Object *, const char *, Object *, Error **);
1076 ObjectPropertyLinkFlags flags;
1077 } LinkProperty;
1079 static void object_get_link_property(Object *obj, Visitor *v, void *opaque,
1080 const char *name, Error **errp)
1082 LinkProperty *lprop = opaque;
1083 Object **child = lprop->child;
1084 gchar *path;
1086 if (*child) {
1087 path = object_get_canonical_path(*child);
1088 visit_type_str(v, &path, name, errp);
1089 g_free(path);
1090 } else {
1091 path = (gchar *)"";
1092 visit_type_str(v, &path, name, errp);
1097 * object_resolve_link:
1099 * Lookup an object and ensure its type matches the link property type. This
1100 * is similar to object_resolve_path() except type verification against the
1101 * link property is performed.
1103 * Returns: The matched object or NULL on path lookup failures.
1105 static Object *object_resolve_link(Object *obj, const char *name,
1106 const char *path, Error **errp)
1108 const char *type;
1109 gchar *target_type;
1110 bool ambiguous = false;
1111 Object *target;
1113 /* Go from link<FOO> to FOO. */
1114 type = object_property_get_type(obj, name, NULL);
1115 target_type = g_strndup(&type[5], strlen(type) - 6);
1116 target = object_resolve_path_type(path, target_type, &ambiguous);
1118 if (ambiguous) {
1119 error_set(errp, ERROR_CLASS_GENERIC_ERROR,
1120 "Path '%s' does not uniquely identify an object", path);
1121 } else if (!target) {
1122 target = object_resolve_path(path, &ambiguous);
1123 if (target || ambiguous) {
1124 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
1125 } else {
1126 error_set(errp, QERR_DEVICE_NOT_FOUND, path);
1128 target = NULL;
1130 g_free(target_type);
1132 return target;
1135 static void object_set_link_property(Object *obj, Visitor *v, void *opaque,
1136 const char *name, Error **errp)
1138 Error *local_err = NULL;
1139 LinkProperty *prop = opaque;
1140 Object **child = prop->child;
1141 Object *old_target = *child;
1142 Object *new_target = NULL;
1143 char *path = NULL;
1145 visit_type_str(v, &path, name, &local_err);
1147 if (!local_err && strcmp(path, "") != 0) {
1148 new_target = object_resolve_link(obj, name, path, &local_err);
1151 g_free(path);
1152 if (local_err) {
1153 error_propagate(errp, local_err);
1154 return;
1157 prop->check(obj, name, new_target, &local_err);
1158 if (local_err) {
1159 error_propagate(errp, local_err);
1160 return;
1163 object_ref(new_target);
1164 *child = new_target;
1165 object_unref(old_target);
1168 static Object *object_resolve_link_property(Object *parent, void *opaque, const gchar *part)
1170 LinkProperty *lprop = opaque;
1172 return *lprop->child;
1175 static void object_release_link_property(Object *obj, const char *name,
1176 void *opaque)
1178 LinkProperty *prop = opaque;
1180 if ((prop->flags & OBJ_PROP_LINK_UNREF_ON_RELEASE) && *prop->child) {
1181 object_unref(*prop->child);
1183 g_free(prop);
1186 void object_property_add_link(Object *obj, const char *name,
1187 const char *type, Object **child,
1188 void (*check)(Object *, const char *,
1189 Object *, Error **),
1190 ObjectPropertyLinkFlags flags,
1191 Error **errp)
1193 Error *local_err = NULL;
1194 LinkProperty *prop = g_malloc(sizeof(*prop));
1195 gchar *full_type;
1196 ObjectProperty *op;
1198 prop->child = child;
1199 prop->check = check;
1200 prop->flags = flags;
1202 full_type = g_strdup_printf("link<%s>", type);
1204 op = object_property_add(obj, name, full_type,
1205 object_get_link_property,
1206 check ? object_set_link_property : NULL,
1207 object_release_link_property,
1208 prop,
1209 &local_err);
1210 if (local_err) {
1211 error_propagate(errp, local_err);
1212 g_free(prop);
1213 goto out;
1216 op->resolve = object_resolve_link_property;
1218 out:
1219 g_free(full_type);
1222 gchar *object_get_canonical_path_component(Object *obj)
1224 ObjectProperty *prop = NULL;
1226 g_assert(obj);
1227 g_assert(obj->parent != NULL);
1229 QTAILQ_FOREACH(prop, &obj->parent->properties, node) {
1230 if (!object_property_is_child(prop)) {
1231 continue;
1234 if (prop->opaque == obj) {
1235 return g_strdup(prop->name);
1239 /* obj had a parent but was not a child, should never happen */
1240 g_assert_not_reached();
1241 return NULL;
1244 gchar *object_get_canonical_path(Object *obj)
1246 Object *root = object_get_root();
1247 char *newpath, *path = NULL;
1249 while (obj != root) {
1250 char *component = object_get_canonical_path_component(obj);
1252 if (path) {
1253 newpath = g_strdup_printf("%s/%s", component, path);
1254 g_free(component);
1255 g_free(path);
1256 path = newpath;
1257 } else {
1258 path = component;
1261 obj = obj->parent;
1264 newpath = g_strdup_printf("/%s", path ? path : "");
1265 g_free(path);
1267 return newpath;
1270 Object *object_resolve_path_component(Object *parent, const gchar *part)
1272 ObjectProperty *prop = object_property_find(parent, part, NULL);
1273 if (prop == NULL) {
1274 return NULL;
1277 if (prop->resolve) {
1278 return prop->resolve(parent, prop->opaque, part);
1279 } else {
1280 return NULL;
1284 static Object *object_resolve_abs_path(Object *parent,
1285 gchar **parts,
1286 const char *typename,
1287 int index)
1289 Object *child;
1291 if (parts[index] == NULL) {
1292 return object_dynamic_cast(parent, typename);
1295 if (strcmp(parts[index], "") == 0) {
1296 return object_resolve_abs_path(parent, parts, typename, index + 1);
1299 child = object_resolve_path_component(parent, parts[index]);
1300 if (!child) {
1301 return NULL;
1304 return object_resolve_abs_path(child, parts, typename, index + 1);
1307 static Object *object_resolve_partial_path(Object *parent,
1308 gchar **parts,
1309 const char *typename,
1310 bool *ambiguous)
1312 Object *obj;
1313 ObjectProperty *prop;
1315 obj = object_resolve_abs_path(parent, parts, typename, 0);
1317 QTAILQ_FOREACH(prop, &parent->properties, node) {
1318 Object *found;
1320 if (!object_property_is_child(prop)) {
1321 continue;
1324 found = object_resolve_partial_path(prop->opaque, parts,
1325 typename, ambiguous);
1326 if (found) {
1327 if (obj) {
1328 if (ambiguous) {
1329 *ambiguous = true;
1331 return NULL;
1333 obj = found;
1336 if (ambiguous && *ambiguous) {
1337 return NULL;
1341 return obj;
1344 Object *object_resolve_path_type(const char *path, const char *typename,
1345 bool *ambiguous)
1347 Object *obj;
1348 gchar **parts;
1350 parts = g_strsplit(path, "/", 0);
1351 assert(parts);
1353 if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
1354 if (ambiguous) {
1355 *ambiguous = false;
1357 obj = object_resolve_partial_path(object_get_root(), parts,
1358 typename, ambiguous);
1359 } else {
1360 obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
1363 g_strfreev(parts);
1365 return obj;
1368 Object *object_resolve_path(const char *path, bool *ambiguous)
1370 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
1373 typedef struct StringProperty
1375 char *(*get)(Object *, Error **);
1376 void (*set)(Object *, const char *, Error **);
1377 } StringProperty;
1379 static void property_get_str(Object *obj, Visitor *v, void *opaque,
1380 const char *name, Error **errp)
1382 StringProperty *prop = opaque;
1383 char *value;
1385 value = prop->get(obj, errp);
1386 if (value) {
1387 visit_type_str(v, &value, name, errp);
1388 g_free(value);
1392 static void property_set_str(Object *obj, Visitor *v, void *opaque,
1393 const char *name, Error **errp)
1395 StringProperty *prop = opaque;
1396 char *value;
1397 Error *local_err = NULL;
1399 visit_type_str(v, &value, name, &local_err);
1400 if (local_err) {
1401 error_propagate(errp, local_err);
1402 return;
1405 prop->set(obj, value, errp);
1406 g_free(value);
1409 static void property_release_str(Object *obj, const char *name,
1410 void *opaque)
1412 StringProperty *prop = opaque;
1413 g_free(prop);
1416 void object_property_add_str(Object *obj, const char *name,
1417 char *(*get)(Object *, Error **),
1418 void (*set)(Object *, const char *, Error **),
1419 Error **errp)
1421 Error *local_err = NULL;
1422 StringProperty *prop = g_malloc0(sizeof(*prop));
1424 prop->get = get;
1425 prop->set = set;
1427 object_property_add(obj, name, "string",
1428 get ? property_get_str : NULL,
1429 set ? property_set_str : NULL,
1430 property_release_str,
1431 prop, &local_err);
1432 if (local_err) {
1433 error_propagate(errp, local_err);
1434 g_free(prop);
1438 typedef struct BoolProperty
1440 bool (*get)(Object *, Error **);
1441 void (*set)(Object *, bool, Error **);
1442 } BoolProperty;
1444 static void property_get_bool(Object *obj, Visitor *v, void *opaque,
1445 const char *name, Error **errp)
1447 BoolProperty *prop = opaque;
1448 bool value;
1450 value = prop->get(obj, errp);
1451 visit_type_bool(v, &value, name, errp);
1454 static void property_set_bool(Object *obj, Visitor *v, void *opaque,
1455 const char *name, Error **errp)
1457 BoolProperty *prop = opaque;
1458 bool value;
1459 Error *local_err = NULL;
1461 visit_type_bool(v, &value, name, &local_err);
1462 if (local_err) {
1463 error_propagate(errp, local_err);
1464 return;
1467 prop->set(obj, value, errp);
1470 static void property_release_bool(Object *obj, const char *name,
1471 void *opaque)
1473 BoolProperty *prop = opaque;
1474 g_free(prop);
1477 void object_property_add_bool(Object *obj, const char *name,
1478 bool (*get)(Object *, Error **),
1479 void (*set)(Object *, bool, Error **),
1480 Error **errp)
1482 Error *local_err = NULL;
1483 BoolProperty *prop = g_malloc0(sizeof(*prop));
1485 prop->get = get;
1486 prop->set = set;
1488 object_property_add(obj, name, "bool",
1489 get ? property_get_bool : NULL,
1490 set ? property_set_bool : NULL,
1491 property_release_bool,
1492 prop, &local_err);
1493 if (local_err) {
1494 error_propagate(errp, local_err);
1495 g_free(prop);
1499 static char *qdev_get_type(Object *obj, Error **errp)
1501 return g_strdup(object_get_typename(obj));
1504 static void property_get_uint8_ptr(Object *obj, Visitor *v,
1505 void *opaque, const char *name,
1506 Error **errp)
1508 uint8_t value = *(uint8_t *)opaque;
1509 visit_type_uint8(v, &value, name, errp);
1512 static void property_get_uint16_ptr(Object *obj, Visitor *v,
1513 void *opaque, const char *name,
1514 Error **errp)
1516 uint16_t value = *(uint16_t *)opaque;
1517 visit_type_uint16(v, &value, name, errp);
1520 static void property_get_uint32_ptr(Object *obj, Visitor *v,
1521 void *opaque, const char *name,
1522 Error **errp)
1524 uint32_t value = *(uint32_t *)opaque;
1525 visit_type_uint32(v, &value, name, errp);
1528 static void property_get_uint64_ptr(Object *obj, Visitor *v,
1529 void *opaque, const char *name,
1530 Error **errp)
1532 uint64_t value = *(uint64_t *)opaque;
1533 visit_type_uint64(v, &value, name, errp);
1536 void object_property_add_uint8_ptr(Object *obj, const char *name,
1537 const uint8_t *v, Error **errp)
1539 object_property_add(obj, name, "uint8", property_get_uint8_ptr,
1540 NULL, NULL, (void *)v, errp);
1543 void object_property_add_uint16_ptr(Object *obj, const char *name,
1544 const uint16_t *v, Error **errp)
1546 object_property_add(obj, name, "uint16", property_get_uint16_ptr,
1547 NULL, NULL, (void *)v, errp);
1550 void object_property_add_uint32_ptr(Object *obj, const char *name,
1551 const uint32_t *v, Error **errp)
1553 object_property_add(obj, name, "uint32", property_get_uint32_ptr,
1554 NULL, NULL, (void *)v, errp);
1557 void object_property_add_uint64_ptr(Object *obj, const char *name,
1558 const uint64_t *v, Error **errp)
1560 object_property_add(obj, name, "uint64", property_get_uint64_ptr,
1561 NULL, NULL, (void *)v, errp);
1564 typedef struct {
1565 Object *target_obj;
1566 const char *target_name;
1567 } AliasProperty;
1569 static void property_get_alias(Object *obj, struct Visitor *v, void *opaque,
1570 const char *name, Error **errp)
1572 AliasProperty *prop = opaque;
1574 object_property_get(prop->target_obj, v, prop->target_name, errp);
1577 static void property_set_alias(Object *obj, struct Visitor *v, void *opaque,
1578 const char *name, Error **errp)
1580 AliasProperty *prop = opaque;
1582 object_property_set(prop->target_obj, v, prop->target_name, errp);
1585 static Object *property_resolve_alias(Object *obj, void *opaque,
1586 const gchar *part)
1588 AliasProperty *prop = opaque;
1590 return object_resolve_path_component(prop->target_obj, prop->target_name);
1593 static void property_release_alias(Object *obj, const char *name, void *opaque)
1595 AliasProperty *prop = opaque;
1597 g_free(prop);
1600 void object_property_add_alias(Object *obj, const char *name,
1601 Object *target_obj, const char *target_name,
1602 Error **errp)
1604 AliasProperty *prop;
1605 ObjectProperty *op;
1606 ObjectProperty *target_prop;
1607 gchar *prop_type;
1609 target_prop = object_property_find(target_obj, target_name, errp);
1610 if (!target_prop) {
1611 return;
1614 if (object_property_is_child(target_prop)) {
1615 prop_type = g_strdup_printf("link%s",
1616 target_prop->type + strlen("child"));
1617 } else {
1618 prop_type = g_strdup(target_prop->type);
1621 prop = g_malloc(sizeof(*prop));
1622 prop->target_obj = target_obj;
1623 prop->target_name = target_name;
1625 op = object_property_add(obj, name, prop_type,
1626 property_get_alias,
1627 property_set_alias,
1628 property_release_alias,
1629 prop, errp);
1630 op->resolve = property_resolve_alias;
1632 g_free(prop_type);
1635 static void object_instance_init(Object *obj)
1637 object_property_add_str(obj, "type", qdev_get_type, NULL, NULL);
1640 static void register_types(void)
1642 static TypeInfo interface_info = {
1643 .name = TYPE_INTERFACE,
1644 .class_size = sizeof(InterfaceClass),
1645 .abstract = true,
1648 static TypeInfo object_info = {
1649 .name = TYPE_OBJECT,
1650 .instance_size = sizeof(Object),
1651 .instance_init = object_instance_init,
1652 .abstract = true,
1655 type_interface = type_register_internal(&interface_info);
1656 type_register_internal(&object_info);
1659 type_init(register_types)