qom: Add helper function for getting user objects root
[qemu/cris-port.git] / qom / object.c
blob69b7077c2b44c7fa4aa7354811d0fcbfd5be6eba
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->description);
373 g_free(prop);
377 static void object_property_del_child(Object *obj, Object *child, Error **errp)
379 ObjectProperty *prop;
381 QTAILQ_FOREACH(prop, &obj->properties, node) {
382 if (object_property_is_child(prop) && prop->opaque == child) {
383 object_property_del(obj, prop->name, errp);
384 break;
389 void object_unparent(Object *obj)
391 if (obj->parent) {
392 object_property_del_child(obj->parent, obj, NULL);
396 static void object_deinit(Object *obj, TypeImpl *type)
398 if (type->instance_finalize) {
399 type->instance_finalize(obj);
402 if (type_has_parent(type)) {
403 object_deinit(obj, type_get_parent(type));
407 static void object_finalize(void *data)
409 Object *obj = data;
410 TypeImpl *ti = obj->class->type;
412 object_property_del_all(obj);
413 object_deinit(obj, ti);
415 g_assert(obj->ref == 0);
416 if (obj->free) {
417 obj->free(obj);
421 Object *object_new_with_type(Type type)
423 Object *obj;
425 g_assert(type != NULL);
426 type_initialize(type);
428 obj = g_malloc(type->instance_size);
429 object_initialize_with_type(obj, type->instance_size, type);
430 obj->free = g_free;
432 return obj;
435 Object *object_new(const char *typename)
437 TypeImpl *ti = type_get_by_name(typename);
439 return object_new_with_type(ti);
442 Object *object_dynamic_cast(Object *obj, const char *typename)
444 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
445 return obj;
448 return NULL;
451 Object *object_dynamic_cast_assert(Object *obj, const char *typename,
452 const char *file, int line, const char *func)
454 trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
455 typename, file, line, func);
457 #ifdef CONFIG_QOM_CAST_DEBUG
458 int i;
459 Object *inst;
461 for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
462 if (obj->class->object_cast_cache[i] == typename) {
463 goto out;
467 inst = object_dynamic_cast(obj, typename);
469 if (!inst && obj) {
470 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
471 file, line, func, obj, typename);
472 abort();
475 assert(obj == inst);
477 if (obj && obj == inst) {
478 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
479 obj->class->object_cast_cache[i - 1] =
480 obj->class->object_cast_cache[i];
482 obj->class->object_cast_cache[i - 1] = typename;
485 out:
486 #endif
487 return obj;
490 ObjectClass *object_class_dynamic_cast(ObjectClass *class,
491 const char *typename)
493 ObjectClass *ret = NULL;
494 TypeImpl *target_type;
495 TypeImpl *type;
497 if (!class) {
498 return NULL;
501 /* A simple fast path that can trigger a lot for leaf classes. */
502 type = class->type;
503 if (type->name == typename) {
504 return class;
507 target_type = type_get_by_name(typename);
508 if (!target_type) {
509 /* target class type unknown, so fail the cast */
510 return NULL;
513 if (type->class->interfaces &&
514 type_is_ancestor(target_type, type_interface)) {
515 int found = 0;
516 GSList *i;
518 for (i = class->interfaces; i; i = i->next) {
519 ObjectClass *target_class = i->data;
521 if (type_is_ancestor(target_class->type, target_type)) {
522 ret = target_class;
523 found++;
527 /* The match was ambiguous, don't allow a cast */
528 if (found > 1) {
529 ret = NULL;
531 } else if (type_is_ancestor(type, target_type)) {
532 ret = class;
535 return ret;
538 ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
539 const char *typename,
540 const char *file, int line,
541 const char *func)
543 ObjectClass *ret;
545 trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)",
546 typename, file, line, func);
548 #ifdef CONFIG_QOM_CAST_DEBUG
549 int i;
551 for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
552 if (class->class_cast_cache[i] == typename) {
553 ret = class;
554 goto out;
557 #else
558 if (!class || !class->interfaces) {
559 return class;
561 #endif
563 ret = object_class_dynamic_cast(class, typename);
564 if (!ret && class) {
565 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
566 file, line, func, class, typename);
567 abort();
570 #ifdef CONFIG_QOM_CAST_DEBUG
571 if (class && ret == class) {
572 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
573 class->class_cast_cache[i - 1] = class->class_cast_cache[i];
575 class->class_cast_cache[i - 1] = typename;
577 out:
578 #endif
579 return ret;
582 const char *object_get_typename(Object *obj)
584 return obj->class->type->name;
587 ObjectClass *object_get_class(Object *obj)
589 return obj->class;
592 bool object_class_is_abstract(ObjectClass *klass)
594 return klass->type->abstract;
597 const char *object_class_get_name(ObjectClass *klass)
599 return klass->type->name;
602 ObjectClass *object_class_by_name(const char *typename)
604 TypeImpl *type = type_get_by_name(typename);
606 if (!type) {
607 return NULL;
610 type_initialize(type);
612 return type->class;
615 ObjectClass *object_class_get_parent(ObjectClass *class)
617 TypeImpl *type = type_get_parent(class->type);
619 if (!type) {
620 return NULL;
623 type_initialize(type);
625 return type->class;
628 typedef struct OCFData
630 void (*fn)(ObjectClass *klass, void *opaque);
631 const char *implements_type;
632 bool include_abstract;
633 void *opaque;
634 } OCFData;
636 static void object_class_foreach_tramp(gpointer key, gpointer value,
637 gpointer opaque)
639 OCFData *data = opaque;
640 TypeImpl *type = value;
641 ObjectClass *k;
643 type_initialize(type);
644 k = type->class;
646 if (!data->include_abstract && type->abstract) {
647 return;
650 if (data->implements_type &&
651 !object_class_dynamic_cast(k, data->implements_type)) {
652 return;
655 data->fn(k, data->opaque);
658 void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
659 const char *implements_type, bool include_abstract,
660 void *opaque)
662 OCFData data = { fn, implements_type, include_abstract, opaque };
664 enumerating_types = true;
665 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
666 enumerating_types = false;
669 int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
670 void *opaque)
672 ObjectProperty *prop, *next;
673 int ret = 0;
675 QTAILQ_FOREACH_SAFE(prop, &obj->properties, node, next) {
676 if (object_property_is_child(prop)) {
677 ret = fn(prop->opaque, opaque);
678 if (ret != 0) {
679 break;
683 return ret;
686 static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
688 GSList **list = opaque;
690 *list = g_slist_prepend(*list, klass);
693 GSList *object_class_get_list(const char *implements_type,
694 bool include_abstract)
696 GSList *list = NULL;
698 object_class_foreach(object_class_get_list_tramp,
699 implements_type, include_abstract, &list);
700 return list;
703 void object_ref(Object *obj)
705 if (!obj) {
706 return;
708 atomic_inc(&obj->ref);
711 void object_unref(Object *obj)
713 if (!obj) {
714 return;
716 g_assert(obj->ref > 0);
718 /* parent always holds a reference to its children */
719 if (atomic_fetch_dec(&obj->ref) == 1) {
720 object_finalize(obj);
724 ObjectProperty *
725 object_property_add(Object *obj, const char *name, const char *type,
726 ObjectPropertyAccessor *get,
727 ObjectPropertyAccessor *set,
728 ObjectPropertyRelease *release,
729 void *opaque, Error **errp)
731 ObjectProperty *prop;
732 size_t name_len = strlen(name);
734 if (name_len >= 3 && !memcmp(name + name_len - 3, "[*]", 4)) {
735 int i;
736 ObjectProperty *ret;
737 char *name_no_array = g_strdup(name);
739 name_no_array[name_len - 3] = '\0';
740 for (i = 0; ; ++i) {
741 char *full_name = g_strdup_printf("%s[%d]", name_no_array, i);
743 ret = object_property_add(obj, full_name, type, get, set,
744 release, opaque, NULL);
745 g_free(full_name);
746 if (ret) {
747 break;
750 g_free(name_no_array);
751 return ret;
754 QTAILQ_FOREACH(prop, &obj->properties, node) {
755 if (strcmp(prop->name, name) == 0) {
756 error_setg(errp, "attempt to add duplicate property '%s'"
757 " to object (type '%s')", name,
758 object_get_typename(obj));
759 return NULL;
763 prop = g_malloc0(sizeof(*prop));
765 prop->name = g_strdup(name);
766 prop->type = g_strdup(type);
768 prop->get = get;
769 prop->set = set;
770 prop->release = release;
771 prop->opaque = opaque;
773 QTAILQ_INSERT_TAIL(&obj->properties, prop, node);
774 return prop;
777 ObjectProperty *object_property_find(Object *obj, const char *name,
778 Error **errp)
780 ObjectProperty *prop;
782 QTAILQ_FOREACH(prop, &obj->properties, node) {
783 if (strcmp(prop->name, name) == 0) {
784 return prop;
788 error_setg(errp, "Property '.%s' not found", name);
789 return NULL;
792 void object_property_del(Object *obj, const char *name, Error **errp)
794 ObjectProperty *prop = object_property_find(obj, name, errp);
795 if (prop == NULL) {
796 return;
799 if (prop->release) {
800 prop->release(obj, name, prop->opaque);
803 QTAILQ_REMOVE(&obj->properties, prop, node);
805 g_free(prop->name);
806 g_free(prop->type);
807 g_free(prop->description);
808 g_free(prop);
811 void object_property_get(Object *obj, Visitor *v, const char *name,
812 Error **errp)
814 ObjectProperty *prop = object_property_find(obj, name, errp);
815 if (prop == NULL) {
816 return;
819 if (!prop->get) {
820 error_set(errp, QERR_PERMISSION_DENIED);
821 } else {
822 prop->get(obj, v, prop->opaque, name, errp);
826 void object_property_set(Object *obj, Visitor *v, const char *name,
827 Error **errp)
829 ObjectProperty *prop = object_property_find(obj, name, errp);
830 if (prop == NULL) {
831 return;
834 if (!prop->set) {
835 error_set(errp, QERR_PERMISSION_DENIED);
836 } else {
837 prop->set(obj, v, prop->opaque, name, errp);
841 void object_property_set_str(Object *obj, const char *value,
842 const char *name, Error **errp)
844 QString *qstr = qstring_from_str(value);
845 object_property_set_qobject(obj, QOBJECT(qstr), name, errp);
847 QDECREF(qstr);
850 char *object_property_get_str(Object *obj, const char *name,
851 Error **errp)
853 QObject *ret = object_property_get_qobject(obj, name, errp);
854 QString *qstring;
855 char *retval;
857 if (!ret) {
858 return NULL;
860 qstring = qobject_to_qstring(ret);
861 if (!qstring) {
862 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
863 retval = NULL;
864 } else {
865 retval = g_strdup(qstring_get_str(qstring));
868 QDECREF(qstring);
869 return retval;
872 void object_property_set_link(Object *obj, Object *value,
873 const char *name, Error **errp)
875 if (value) {
876 gchar *path = object_get_canonical_path(value);
877 object_property_set_str(obj, path, name, errp);
878 g_free(path);
879 } else {
880 object_property_set_str(obj, "", name, errp);
884 Object *object_property_get_link(Object *obj, const char *name,
885 Error **errp)
887 char *str = object_property_get_str(obj, name, errp);
888 Object *target = NULL;
890 if (str && *str) {
891 target = object_resolve_path(str, NULL);
892 if (!target) {
893 error_set(errp, QERR_DEVICE_NOT_FOUND, str);
897 g_free(str);
898 return target;
901 void object_property_set_bool(Object *obj, bool value,
902 const char *name, Error **errp)
904 QBool *qbool = qbool_from_int(value);
905 object_property_set_qobject(obj, QOBJECT(qbool), name, errp);
907 QDECREF(qbool);
910 bool object_property_get_bool(Object *obj, const char *name,
911 Error **errp)
913 QObject *ret = object_property_get_qobject(obj, name, errp);
914 QBool *qbool;
915 bool retval;
917 if (!ret) {
918 return false;
920 qbool = qobject_to_qbool(ret);
921 if (!qbool) {
922 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
923 retval = false;
924 } else {
925 retval = qbool_get_int(qbool);
928 QDECREF(qbool);
929 return retval;
932 void object_property_set_int(Object *obj, int64_t value,
933 const char *name, Error **errp)
935 QInt *qint = qint_from_int(value);
936 object_property_set_qobject(obj, QOBJECT(qint), name, errp);
938 QDECREF(qint);
941 int64_t object_property_get_int(Object *obj, const char *name,
942 Error **errp)
944 QObject *ret = object_property_get_qobject(obj, name, errp);
945 QInt *qint;
946 int64_t retval;
948 if (!ret) {
949 return -1;
951 qint = qobject_to_qint(ret);
952 if (!qint) {
953 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
954 retval = -1;
955 } else {
956 retval = qint_get_int(qint);
959 QDECREF(qint);
960 return retval;
963 int object_property_get_enum(Object *obj, const char *name,
964 const char *strings[], Error **errp)
966 StringOutputVisitor *sov;
967 StringInputVisitor *siv;
968 char *str;
969 int ret;
971 sov = string_output_visitor_new(false);
972 object_property_get(obj, string_output_get_visitor(sov), name, errp);
973 str = string_output_get_string(sov);
974 siv = string_input_visitor_new(str);
975 string_output_visitor_cleanup(sov);
976 visit_type_enum(string_input_get_visitor(siv),
977 &ret, strings, NULL, name, errp);
979 g_free(str);
980 string_input_visitor_cleanup(siv);
982 return ret;
985 void object_property_get_uint16List(Object *obj, const char *name,
986 uint16List **list, Error **errp)
988 StringOutputVisitor *ov;
989 StringInputVisitor *iv;
990 char *str;
992 ov = string_output_visitor_new(false);
993 object_property_get(obj, string_output_get_visitor(ov),
994 name, errp);
995 str = string_output_get_string(ov);
996 iv = string_input_visitor_new(str);
997 visit_type_uint16List(string_input_get_visitor(iv),
998 list, NULL, errp);
1000 g_free(str);
1001 string_output_visitor_cleanup(ov);
1002 string_input_visitor_cleanup(iv);
1005 void object_property_parse(Object *obj, const char *string,
1006 const char *name, Error **errp)
1008 StringInputVisitor *mi;
1009 mi = string_input_visitor_new(string);
1010 object_property_set(obj, string_input_get_visitor(mi), name, errp);
1012 string_input_visitor_cleanup(mi);
1015 char *object_property_print(Object *obj, const char *name, bool human,
1016 Error **errp)
1018 StringOutputVisitor *mo;
1019 char *string = NULL;
1020 Error *local_err = NULL;
1022 mo = string_output_visitor_new(human);
1023 object_property_get(obj, string_output_get_visitor(mo), name, &local_err);
1024 if (local_err) {
1025 error_propagate(errp, local_err);
1026 goto out;
1029 string = string_output_get_string(mo);
1031 out:
1032 string_output_visitor_cleanup(mo);
1033 return string;
1036 const char *object_property_get_type(Object *obj, const char *name, Error **errp)
1038 ObjectProperty *prop = object_property_find(obj, name, errp);
1039 if (prop == NULL) {
1040 return NULL;
1043 return prop->type;
1046 Object *object_get_root(void)
1048 static Object *root;
1050 if (!root) {
1051 root = object_new("container");
1054 return root;
1057 Object *object_get_objects_root(void)
1059 return container_get(object_get_root(), "/objects");
1062 static void object_get_child_property(Object *obj, Visitor *v, void *opaque,
1063 const char *name, Error **errp)
1065 Object *child = opaque;
1066 gchar *path;
1068 path = object_get_canonical_path(child);
1069 visit_type_str(v, &path, name, errp);
1070 g_free(path);
1073 static Object *object_resolve_child_property(Object *parent, void *opaque, const gchar *part)
1075 return opaque;
1078 static void object_finalize_child_property(Object *obj, const char *name,
1079 void *opaque)
1081 Object *child = opaque;
1083 if (child->class->unparent) {
1084 (child->class->unparent)(child);
1086 child->parent = NULL;
1087 object_unref(child);
1090 void object_property_add_child(Object *obj, const char *name,
1091 Object *child, Error **errp)
1093 Error *local_err = NULL;
1094 gchar *type;
1095 ObjectProperty *op;
1097 if (child->parent != NULL) {
1098 error_setg(errp, "child object is already parented");
1099 return;
1102 type = g_strdup_printf("child<%s>", object_get_typename(OBJECT(child)));
1104 op = object_property_add(obj, name, type, object_get_child_property, NULL,
1105 object_finalize_child_property, child, &local_err);
1106 if (local_err) {
1107 error_propagate(errp, local_err);
1108 goto out;
1111 op->resolve = object_resolve_child_property;
1112 object_ref(child);
1113 child->parent = obj;
1115 out:
1116 g_free(type);
1119 void object_property_allow_set_link(Object *obj, const char *name,
1120 Object *val, Error **errp)
1122 /* Allow the link to be set, always */
1125 typedef struct {
1126 Object **child;
1127 void (*check)(Object *, const char *, Object *, Error **);
1128 ObjectPropertyLinkFlags flags;
1129 } LinkProperty;
1131 static void object_get_link_property(Object *obj, Visitor *v, void *opaque,
1132 const char *name, Error **errp)
1134 LinkProperty *lprop = opaque;
1135 Object **child = lprop->child;
1136 gchar *path;
1138 if (*child) {
1139 path = object_get_canonical_path(*child);
1140 visit_type_str(v, &path, name, errp);
1141 g_free(path);
1142 } else {
1143 path = (gchar *)"";
1144 visit_type_str(v, &path, name, errp);
1149 * object_resolve_link:
1151 * Lookup an object and ensure its type matches the link property type. This
1152 * is similar to object_resolve_path() except type verification against the
1153 * link property is performed.
1155 * Returns: The matched object or NULL on path lookup failures.
1157 static Object *object_resolve_link(Object *obj, const char *name,
1158 const char *path, Error **errp)
1160 const char *type;
1161 gchar *target_type;
1162 bool ambiguous = false;
1163 Object *target;
1165 /* Go from link<FOO> to FOO. */
1166 type = object_property_get_type(obj, name, NULL);
1167 target_type = g_strndup(&type[5], strlen(type) - 6);
1168 target = object_resolve_path_type(path, target_type, &ambiguous);
1170 if (ambiguous) {
1171 error_set(errp, ERROR_CLASS_GENERIC_ERROR,
1172 "Path '%s' does not uniquely identify an object", path);
1173 } else if (!target) {
1174 target = object_resolve_path(path, &ambiguous);
1175 if (target || ambiguous) {
1176 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
1177 } else {
1178 error_set(errp, QERR_DEVICE_NOT_FOUND, path);
1180 target = NULL;
1182 g_free(target_type);
1184 return target;
1187 static void object_set_link_property(Object *obj, Visitor *v, void *opaque,
1188 const char *name, Error **errp)
1190 Error *local_err = NULL;
1191 LinkProperty *prop = opaque;
1192 Object **child = prop->child;
1193 Object *old_target = *child;
1194 Object *new_target = NULL;
1195 char *path = NULL;
1197 visit_type_str(v, &path, name, &local_err);
1199 if (!local_err && strcmp(path, "") != 0) {
1200 new_target = object_resolve_link(obj, name, path, &local_err);
1203 g_free(path);
1204 if (local_err) {
1205 error_propagate(errp, local_err);
1206 return;
1209 prop->check(obj, name, new_target, &local_err);
1210 if (local_err) {
1211 error_propagate(errp, local_err);
1212 return;
1215 object_ref(new_target);
1216 *child = new_target;
1217 object_unref(old_target);
1220 static Object *object_resolve_link_property(Object *parent, void *opaque, const gchar *part)
1222 LinkProperty *lprop = opaque;
1224 return *lprop->child;
1227 static void object_release_link_property(Object *obj, const char *name,
1228 void *opaque)
1230 LinkProperty *prop = opaque;
1232 if ((prop->flags & OBJ_PROP_LINK_UNREF_ON_RELEASE) && *prop->child) {
1233 object_unref(*prop->child);
1235 g_free(prop);
1238 void object_property_add_link(Object *obj, const char *name,
1239 const char *type, Object **child,
1240 void (*check)(Object *, const char *,
1241 Object *, Error **),
1242 ObjectPropertyLinkFlags flags,
1243 Error **errp)
1245 Error *local_err = NULL;
1246 LinkProperty *prop = g_malloc(sizeof(*prop));
1247 gchar *full_type;
1248 ObjectProperty *op;
1250 prop->child = child;
1251 prop->check = check;
1252 prop->flags = flags;
1254 full_type = g_strdup_printf("link<%s>", type);
1256 op = object_property_add(obj, name, full_type,
1257 object_get_link_property,
1258 check ? object_set_link_property : NULL,
1259 object_release_link_property,
1260 prop,
1261 &local_err);
1262 if (local_err) {
1263 error_propagate(errp, local_err);
1264 g_free(prop);
1265 goto out;
1268 op->resolve = object_resolve_link_property;
1270 out:
1271 g_free(full_type);
1274 void object_property_add_const_link(Object *obj, const char *name,
1275 Object *target, Error **errp)
1277 char *link_type;
1278 ObjectProperty *op;
1280 link_type = g_strdup_printf("link<%s>", object_get_typename(target));
1281 op = object_property_add(obj, name, link_type,
1282 object_get_child_property, NULL,
1283 NULL, target, errp);
1284 if (op != NULL) {
1285 op->resolve = object_resolve_child_property;
1287 g_free(link_type);
1290 gchar *object_get_canonical_path_component(Object *obj)
1292 ObjectProperty *prop = NULL;
1294 g_assert(obj);
1295 g_assert(obj->parent != NULL);
1297 QTAILQ_FOREACH(prop, &obj->parent->properties, node) {
1298 if (!object_property_is_child(prop)) {
1299 continue;
1302 if (prop->opaque == obj) {
1303 return g_strdup(prop->name);
1307 /* obj had a parent but was not a child, should never happen */
1308 g_assert_not_reached();
1309 return NULL;
1312 gchar *object_get_canonical_path(Object *obj)
1314 Object *root = object_get_root();
1315 char *newpath, *path = NULL;
1317 while (obj != root) {
1318 char *component = object_get_canonical_path_component(obj);
1320 if (path) {
1321 newpath = g_strdup_printf("%s/%s", component, path);
1322 g_free(component);
1323 g_free(path);
1324 path = newpath;
1325 } else {
1326 path = component;
1329 obj = obj->parent;
1332 newpath = g_strdup_printf("/%s", path ? path : "");
1333 g_free(path);
1335 return newpath;
1338 Object *object_resolve_path_component(Object *parent, const gchar *part)
1340 ObjectProperty *prop = object_property_find(parent, part, NULL);
1341 if (prop == NULL) {
1342 return NULL;
1345 if (prop->resolve) {
1346 return prop->resolve(parent, prop->opaque, part);
1347 } else {
1348 return NULL;
1352 static Object *object_resolve_abs_path(Object *parent,
1353 gchar **parts,
1354 const char *typename,
1355 int index)
1357 Object *child;
1359 if (parts[index] == NULL) {
1360 return object_dynamic_cast(parent, typename);
1363 if (strcmp(parts[index], "") == 0) {
1364 return object_resolve_abs_path(parent, parts, typename, index + 1);
1367 child = object_resolve_path_component(parent, parts[index]);
1368 if (!child) {
1369 return NULL;
1372 return object_resolve_abs_path(child, parts, typename, index + 1);
1375 static Object *object_resolve_partial_path(Object *parent,
1376 gchar **parts,
1377 const char *typename,
1378 bool *ambiguous)
1380 Object *obj;
1381 ObjectProperty *prop;
1383 obj = object_resolve_abs_path(parent, parts, typename, 0);
1385 QTAILQ_FOREACH(prop, &parent->properties, node) {
1386 Object *found;
1388 if (!object_property_is_child(prop)) {
1389 continue;
1392 found = object_resolve_partial_path(prop->opaque, parts,
1393 typename, ambiguous);
1394 if (found) {
1395 if (obj) {
1396 if (ambiguous) {
1397 *ambiguous = true;
1399 return NULL;
1401 obj = found;
1404 if (ambiguous && *ambiguous) {
1405 return NULL;
1409 return obj;
1412 Object *object_resolve_path_type(const char *path, const char *typename,
1413 bool *ambiguous)
1415 Object *obj;
1416 gchar **parts;
1418 parts = g_strsplit(path, "/", 0);
1419 assert(parts);
1421 if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
1422 if (ambiguous) {
1423 *ambiguous = false;
1425 obj = object_resolve_partial_path(object_get_root(), parts,
1426 typename, ambiguous);
1427 } else {
1428 obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
1431 g_strfreev(parts);
1433 return obj;
1436 Object *object_resolve_path(const char *path, bool *ambiguous)
1438 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
1441 typedef struct StringProperty
1443 char *(*get)(Object *, Error **);
1444 void (*set)(Object *, const char *, Error **);
1445 } StringProperty;
1447 static void property_get_str(Object *obj, Visitor *v, void *opaque,
1448 const char *name, Error **errp)
1450 StringProperty *prop = opaque;
1451 char *value;
1453 value = prop->get(obj, errp);
1454 if (value) {
1455 visit_type_str(v, &value, name, errp);
1456 g_free(value);
1460 static void property_set_str(Object *obj, Visitor *v, void *opaque,
1461 const char *name, Error **errp)
1463 StringProperty *prop = opaque;
1464 char *value;
1465 Error *local_err = NULL;
1467 visit_type_str(v, &value, name, &local_err);
1468 if (local_err) {
1469 error_propagate(errp, local_err);
1470 return;
1473 prop->set(obj, value, errp);
1474 g_free(value);
1477 static void property_release_str(Object *obj, const char *name,
1478 void *opaque)
1480 StringProperty *prop = opaque;
1481 g_free(prop);
1484 void object_property_add_str(Object *obj, const char *name,
1485 char *(*get)(Object *, Error **),
1486 void (*set)(Object *, const char *, Error **),
1487 Error **errp)
1489 Error *local_err = NULL;
1490 StringProperty *prop = g_malloc0(sizeof(*prop));
1492 prop->get = get;
1493 prop->set = set;
1495 object_property_add(obj, name, "string",
1496 get ? property_get_str : NULL,
1497 set ? property_set_str : NULL,
1498 property_release_str,
1499 prop, &local_err);
1500 if (local_err) {
1501 error_propagate(errp, local_err);
1502 g_free(prop);
1506 typedef struct BoolProperty
1508 bool (*get)(Object *, Error **);
1509 void (*set)(Object *, bool, Error **);
1510 } BoolProperty;
1512 static void property_get_bool(Object *obj, Visitor *v, void *opaque,
1513 const char *name, Error **errp)
1515 BoolProperty *prop = opaque;
1516 bool value;
1518 value = prop->get(obj, errp);
1519 visit_type_bool(v, &value, name, errp);
1522 static void property_set_bool(Object *obj, Visitor *v, void *opaque,
1523 const char *name, Error **errp)
1525 BoolProperty *prop = opaque;
1526 bool value;
1527 Error *local_err = NULL;
1529 visit_type_bool(v, &value, name, &local_err);
1530 if (local_err) {
1531 error_propagate(errp, local_err);
1532 return;
1535 prop->set(obj, value, errp);
1538 static void property_release_bool(Object *obj, const char *name,
1539 void *opaque)
1541 BoolProperty *prop = opaque;
1542 g_free(prop);
1545 void object_property_add_bool(Object *obj, const char *name,
1546 bool (*get)(Object *, Error **),
1547 void (*set)(Object *, bool, Error **),
1548 Error **errp)
1550 Error *local_err = NULL;
1551 BoolProperty *prop = g_malloc0(sizeof(*prop));
1553 prop->get = get;
1554 prop->set = set;
1556 object_property_add(obj, name, "bool",
1557 get ? property_get_bool : NULL,
1558 set ? property_set_bool : NULL,
1559 property_release_bool,
1560 prop, &local_err);
1561 if (local_err) {
1562 error_propagate(errp, local_err);
1563 g_free(prop);
1567 typedef struct TMProperty {
1568 void (*get)(Object *, struct tm *, Error **);
1569 } TMProperty;
1571 static void property_get_tm(Object *obj, Visitor *v, void *opaque,
1572 const char *name, Error **errp)
1574 TMProperty *prop = opaque;
1575 Error *err = NULL;
1576 struct tm value;
1578 prop->get(obj, &value, &err);
1579 if (err) {
1580 goto out;
1583 visit_start_struct(v, NULL, "struct tm", name, 0, &err);
1584 if (err) {
1585 goto out;
1587 visit_type_int32(v, &value.tm_year, "tm_year", &err);
1588 if (err) {
1589 goto out_end;
1591 visit_type_int32(v, &value.tm_mon, "tm_mon", &err);
1592 if (err) {
1593 goto out_end;
1595 visit_type_int32(v, &value.tm_mday, "tm_mday", &err);
1596 if (err) {
1597 goto out_end;
1599 visit_type_int32(v, &value.tm_hour, "tm_hour", &err);
1600 if (err) {
1601 goto out_end;
1603 visit_type_int32(v, &value.tm_min, "tm_min", &err);
1604 if (err) {
1605 goto out_end;
1607 visit_type_int32(v, &value.tm_sec, "tm_sec", &err);
1608 if (err) {
1609 goto out_end;
1611 out_end:
1612 error_propagate(errp, err);
1613 err = NULL;
1614 visit_end_struct(v, errp);
1615 out:
1616 error_propagate(errp, err);
1620 static void property_release_tm(Object *obj, const char *name,
1621 void *opaque)
1623 TMProperty *prop = opaque;
1624 g_free(prop);
1627 void object_property_add_tm(Object *obj, const char *name,
1628 void (*get)(Object *, struct tm *, Error **),
1629 Error **errp)
1631 Error *local_err = NULL;
1632 TMProperty *prop = g_malloc0(sizeof(*prop));
1634 prop->get = get;
1636 object_property_add(obj, name, "struct tm",
1637 get ? property_get_tm : NULL, NULL,
1638 property_release_tm,
1639 prop, &local_err);
1640 if (local_err) {
1641 error_propagate(errp, local_err);
1642 g_free(prop);
1646 static char *qdev_get_type(Object *obj, Error **errp)
1648 return g_strdup(object_get_typename(obj));
1651 static void property_get_uint8_ptr(Object *obj, Visitor *v,
1652 void *opaque, const char *name,
1653 Error **errp)
1655 uint8_t value = *(uint8_t *)opaque;
1656 visit_type_uint8(v, &value, name, errp);
1659 static void property_get_uint16_ptr(Object *obj, Visitor *v,
1660 void *opaque, const char *name,
1661 Error **errp)
1663 uint16_t value = *(uint16_t *)opaque;
1664 visit_type_uint16(v, &value, name, errp);
1667 static void property_get_uint32_ptr(Object *obj, Visitor *v,
1668 void *opaque, const char *name,
1669 Error **errp)
1671 uint32_t value = *(uint32_t *)opaque;
1672 visit_type_uint32(v, &value, name, errp);
1675 static void property_get_uint64_ptr(Object *obj, Visitor *v,
1676 void *opaque, const char *name,
1677 Error **errp)
1679 uint64_t value = *(uint64_t *)opaque;
1680 visit_type_uint64(v, &value, name, errp);
1683 void object_property_add_uint8_ptr(Object *obj, const char *name,
1684 const uint8_t *v, Error **errp)
1686 object_property_add(obj, name, "uint8", property_get_uint8_ptr,
1687 NULL, NULL, (void *)v, errp);
1690 void object_property_add_uint16_ptr(Object *obj, const char *name,
1691 const uint16_t *v, Error **errp)
1693 object_property_add(obj, name, "uint16", property_get_uint16_ptr,
1694 NULL, NULL, (void *)v, errp);
1697 void object_property_add_uint32_ptr(Object *obj, const char *name,
1698 const uint32_t *v, Error **errp)
1700 object_property_add(obj, name, "uint32", property_get_uint32_ptr,
1701 NULL, NULL, (void *)v, errp);
1704 void object_property_add_uint64_ptr(Object *obj, const char *name,
1705 const uint64_t *v, Error **errp)
1707 object_property_add(obj, name, "uint64", property_get_uint64_ptr,
1708 NULL, NULL, (void *)v, errp);
1711 typedef struct {
1712 Object *target_obj;
1713 char *target_name;
1714 } AliasProperty;
1716 static void property_get_alias(Object *obj, struct Visitor *v, void *opaque,
1717 const char *name, Error **errp)
1719 AliasProperty *prop = opaque;
1721 object_property_get(prop->target_obj, v, prop->target_name, errp);
1724 static void property_set_alias(Object *obj, struct Visitor *v, void *opaque,
1725 const char *name, Error **errp)
1727 AliasProperty *prop = opaque;
1729 object_property_set(prop->target_obj, v, prop->target_name, errp);
1732 static Object *property_resolve_alias(Object *obj, void *opaque,
1733 const gchar *part)
1735 AliasProperty *prop = opaque;
1737 return object_resolve_path_component(prop->target_obj, prop->target_name);
1740 static void property_release_alias(Object *obj, const char *name, void *opaque)
1742 AliasProperty *prop = opaque;
1744 g_free(prop->target_name);
1745 g_free(prop);
1748 void object_property_add_alias(Object *obj, const char *name,
1749 Object *target_obj, const char *target_name,
1750 Error **errp)
1752 AliasProperty *prop;
1753 ObjectProperty *op;
1754 ObjectProperty *target_prop;
1755 gchar *prop_type;
1756 Error *local_err = NULL;
1758 target_prop = object_property_find(target_obj, target_name, errp);
1759 if (!target_prop) {
1760 return;
1763 if (object_property_is_child(target_prop)) {
1764 prop_type = g_strdup_printf("link%s",
1765 target_prop->type + strlen("child"));
1766 } else {
1767 prop_type = g_strdup(target_prop->type);
1770 prop = g_malloc(sizeof(*prop));
1771 prop->target_obj = target_obj;
1772 prop->target_name = g_strdup(target_name);
1774 op = object_property_add(obj, name, prop_type,
1775 property_get_alias,
1776 property_set_alias,
1777 property_release_alias,
1778 prop, &local_err);
1779 if (local_err) {
1780 error_propagate(errp, local_err);
1781 g_free(prop);
1782 goto out;
1784 op->resolve = property_resolve_alias;
1786 object_property_set_description(obj, op->name,
1787 target_prop->description,
1788 &error_abort);
1790 out:
1791 g_free(prop_type);
1794 void object_property_set_description(Object *obj, const char *name,
1795 const char *description, Error **errp)
1797 ObjectProperty *op;
1799 op = object_property_find(obj, name, errp);
1800 if (!op) {
1801 return;
1804 g_free(op->description);
1805 op->description = g_strdup(description);
1808 static void object_instance_init(Object *obj)
1810 object_property_add_str(obj, "type", qdev_get_type, NULL, NULL);
1813 static void register_types(void)
1815 static TypeInfo interface_info = {
1816 .name = TYPE_INTERFACE,
1817 .class_size = sizeof(InterfaceClass),
1818 .abstract = true,
1821 static TypeInfo object_info = {
1822 .name = TYPE_OBJECT,
1823 .instance_size = sizeof(Object),
1824 .instance_init = object_instance_init,
1825 .abstract = true,
1828 type_interface = type_register_internal(&interface_info);
1829 type_register_internal(&object_info);
1832 type_init(register_types)