4 * Copyright IBM, Corp. 2011
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/object.h"
14 #include "qemu-common.h"
15 #include "qapi/qapi-visit-core.h"
16 #include "qapi/string-input-visitor.h"
17 #include "qapi/string-output-visitor.h"
19 /* TODO: replace QObject with a simpler visitor to avoid a dependency
20 * of the QOM core on QObject? */
21 #include "qemu/qom-qobject.h"
27 #define MAX_INTERFACES 32
29 typedef struct InterfaceImpl InterfaceImpl;
30 typedef struct TypeImpl TypeImpl;
45 void (*class_init)(ObjectClass *klass, void *data);
46 void (*class_base_init)(ObjectClass *klass, void *data);
47 void (*class_finalize)(ObjectClass *klass, void *data);
51 void (*instance_init)(Object *obj);
52 void (*instance_finalize)(Object *obj);
57 TypeImpl *parent_type;
62 InterfaceImpl interfaces[MAX_INTERFACES];
65 static Type type_interface;
67 static GHashTable *type_table_get(void)
69 static GHashTable *type_table;
71 if (type_table == NULL) {
72 type_table = g_hash_table_new(g_str_hash, g_str_equal);
78 static void type_table_add(TypeImpl *ti)
80 g_hash_table_insert(type_table_get(), (void *)ti->name, ti);
83 static TypeImpl *type_table_lookup(const char *name)
85 return g_hash_table_lookup(type_table_get(), name);
88 static TypeImpl *type_register_internal(const TypeInfo *info)
90 TypeImpl *ti = g_malloc0(sizeof(*ti));
93 g_assert(info->name != NULL);
95 if (type_table_lookup(info->name) != NULL) {
96 fprintf(stderr, "Registering `%s' which already exists\n", info->name);
100 ti->name = g_strdup(info->name);
101 ti->parent = g_strdup(info->parent);
103 ti->class_size = info->class_size;
104 ti->instance_size = info->instance_size;
106 ti->class_init = info->class_init;
107 ti->class_base_init = info->class_base_init;
108 ti->class_finalize = info->class_finalize;
109 ti->class_data = info->class_data;
111 ti->instance_init = info->instance_init;
112 ti->instance_finalize = info->instance_finalize;
114 ti->abstract = info->abstract;
116 for (i = 0; info->interfaces && info->interfaces[i].type; i++) {
117 ti->interfaces[i].typename = g_strdup(info->interfaces[i].type);
119 ti->num_interfaces = i;
126 TypeImpl *type_register(const TypeInfo *info)
128 assert(info->parent);
129 return type_register_internal(info);
132 TypeImpl *type_register_static(const TypeInfo *info)
134 return type_register(info);
137 static TypeImpl *type_get_by_name(const char *name)
143 return type_table_lookup(name);
146 static TypeImpl *type_get_parent(TypeImpl *type)
148 if (!type->parent_type && type->parent) {
149 type->parent_type = type_get_by_name(type->parent);
150 g_assert(type->parent_type != NULL);
153 return type->parent_type;
156 static bool type_has_parent(TypeImpl *type)
158 return (type->parent != NULL);
161 static size_t type_class_get_size(TypeImpl *ti)
163 if (ti->class_size) {
164 return ti->class_size;
167 if (type_has_parent(ti)) {
168 return type_class_get_size(type_get_parent(ti));
171 return sizeof(ObjectClass);
174 static size_t type_object_get_size(TypeImpl *ti)
176 if (ti->instance_size) {
177 return ti->instance_size;
180 if (type_has_parent(ti)) {
181 return type_object_get_size(type_get_parent(ti));
187 static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
191 /* Check if typename is a direct ancestor of type */
193 if (type == target_type) {
197 type = type_get_parent(type);
203 static void type_initialize(TypeImpl *ti);
205 static void type_initialize_interface(TypeImpl *ti, const char *parent)
207 InterfaceClass *new_iface;
209 TypeImpl *iface_impl;
211 info.parent = parent;
212 info.name = g_strdup_printf("%s::%s", ti->name, info.parent);
213 info.abstract = true;
215 iface_impl = type_register(&info);
216 type_initialize(iface_impl);
217 g_free((char *)info.name);
219 new_iface = (InterfaceClass *)iface_impl->class;
220 new_iface->concrete_class = ti->class;
222 ti->class->interfaces = g_slist_append(ti->class->interfaces,
226 static void type_initialize(TypeImpl *ti)
234 ti->class_size = type_class_get_size(ti);
235 ti->instance_size = type_object_get_size(ti);
237 ti->class = g_malloc0(ti->class_size);
239 parent = type_get_parent(ti);
241 type_initialize(parent);
245 g_assert(parent->class_size <= ti->class_size);
246 memcpy(ti->class, parent->class, parent->class_size);
248 for (e = parent->class->interfaces; e; e = e->next) {
249 ObjectClass *iface = e->data;
250 type_initialize_interface(ti, object_class_get_name(iface));
253 for (i = 0; i < ti->num_interfaces; i++) {
254 TypeImpl *t = type_get_by_name(ti->interfaces[i].typename);
255 for (e = ti->class->interfaces; e; e = e->next) {
256 TypeImpl *target_type = OBJECT_CLASS(e->data)->type;
258 if (type_is_ancestor(target_type, t)) {
267 type_initialize_interface(ti, ti->interfaces[i].typename);
271 ti->class->type = ti;
274 if (parent->class_base_init) {
275 parent->class_base_init(ti->class, ti->class_data);
277 parent = type_get_parent(parent);
280 if (ti->class_init) {
281 ti->class_init(ti->class, ti->class_data);
287 static void object_init_with_type(Object *obj, TypeImpl *ti)
289 if (type_has_parent(ti)) {
290 object_init_with_type(obj, type_get_parent(ti));
293 if (ti->instance_init) {
294 ti->instance_init(obj);
298 void object_initialize_with_type(void *data, TypeImpl *type)
302 g_assert(type != NULL);
303 type_initialize(type);
305 g_assert(type->instance_size >= sizeof(Object));
306 g_assert(type->abstract == false);
308 memset(obj, 0, type->instance_size);
309 obj->class = type->class;
310 QTAILQ_INIT(&obj->properties);
311 object_init_with_type(obj, type);
314 void object_initialize(void *data, const char *typename)
316 TypeImpl *type = type_get_by_name(typename);
318 object_initialize_with_type(data, type);
321 static inline bool object_property_is_child(ObjectProperty *prop)
323 return strstart(prop->type, "child<", NULL);
326 static inline bool object_property_is_link(ObjectProperty *prop)
328 return strstart(prop->type, "link<", NULL);
331 static void object_property_del_all(Object *obj)
333 while (!QTAILQ_EMPTY(&obj->properties)) {
334 ObjectProperty *prop = QTAILQ_FIRST(&obj->properties);
336 QTAILQ_REMOVE(&obj->properties, prop, node);
339 prop->release(obj, prop->name, prop->opaque);
348 static void object_property_del_child(Object *obj, Object *child, Error **errp)
350 ObjectProperty *prop;
352 QTAILQ_FOREACH(prop, &obj->properties, node) {
353 if (object_property_is_child(prop) && prop->opaque == child) {
354 object_property_del(obj, prop->name, errp);
360 void object_unparent(Object *obj)
363 object_property_del_child(obj->parent, obj, NULL);
367 static void object_deinit(Object *obj, TypeImpl *type)
369 if (type->instance_finalize) {
370 type->instance_finalize(obj);
373 if (type_has_parent(type)) {
374 object_deinit(obj, type_get_parent(type));
377 object_unparent(obj);
380 void object_finalize(void *data)
383 TypeImpl *ti = obj->class->type;
385 object_deinit(obj, ti);
386 object_property_del_all(obj);
388 g_assert(obj->ref == 0);
391 Object *object_new_with_type(Type type)
395 g_assert(type != NULL);
396 type_initialize(type);
398 obj = g_malloc(type->instance_size);
399 object_initialize_with_type(obj, type);
405 Object *object_new(const char *typename)
407 TypeImpl *ti = type_get_by_name(typename);
409 return object_new_with_type(ti);
412 void object_delete(Object *obj)
415 g_assert(obj->ref == 0);
419 Object *object_dynamic_cast(Object *obj, const char *typename)
421 if (object_class_dynamic_cast(object_get_class(obj), typename)) {
428 Object *object_dynamic_cast_assert(Object *obj, const char *typename)
432 inst = object_dynamic_cast(obj, typename);
435 fprintf(stderr, "Object %p is not an instance of type %s\n",
443 ObjectClass *object_class_dynamic_cast(ObjectClass *class,
444 const char *typename)
446 TypeImpl *target_type = type_get_by_name(typename);
447 TypeImpl *type = class->type;
448 ObjectClass *ret = NULL;
450 if (type->num_interfaces && type_is_ancestor(target_type, type_interface)) {
454 for (i = class->interfaces; i; i = i->next) {
455 ObjectClass *target_class = i->data;
457 if (type_is_ancestor(target_class->type, target_type)) {
463 /* The match was ambiguous, don't allow a cast */
467 } else if (type_is_ancestor(type, target_type)) {
474 ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
475 const char *typename)
477 ObjectClass *ret = object_class_dynamic_cast(class, typename);
480 fprintf(stderr, "Object %p is not an instance of type %s\n",
488 const char *object_get_typename(Object *obj)
490 return obj->class->type->name;
493 ObjectClass *object_get_class(Object *obj)
498 const char *object_class_get_name(ObjectClass *klass)
500 return klass->type->name;
503 ObjectClass *object_class_by_name(const char *typename)
505 TypeImpl *type = type_get_by_name(typename);
511 type_initialize(type);
516 ObjectClass *object_class_get_parent(ObjectClass *class)
518 TypeImpl *type = type_get_parent(class->type);
524 type_initialize(type);
529 typedef struct OCFData
531 void (*fn)(ObjectClass *klass, void *opaque);
532 const char *implements_type;
533 bool include_abstract;
537 static void object_class_foreach_tramp(gpointer key, gpointer value,
540 OCFData *data = opaque;
541 TypeImpl *type = value;
544 type_initialize(type);
547 if (!data->include_abstract && type->abstract) {
551 if (data->implements_type &&
552 !object_class_dynamic_cast(k, data->implements_type)) {
556 data->fn(k, data->opaque);
559 void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
560 const char *implements_type, bool include_abstract,
563 OCFData data = { fn, implements_type, include_abstract, opaque };
565 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
568 int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
571 ObjectProperty *prop;
574 QTAILQ_FOREACH(prop, &obj->properties, node) {
575 if (object_property_is_child(prop)) {
576 ret = fn(prop->opaque, opaque);
585 static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
587 GSList **list = opaque;
589 *list = g_slist_prepend(*list, klass);
592 GSList *object_class_get_list(const char *implements_type,
593 bool include_abstract)
597 object_class_foreach(object_class_get_list_tramp,
598 implements_type, include_abstract, &list);
602 void object_ref(Object *obj)
607 void object_unref(Object *obj)
609 g_assert(obj->ref > 0);
612 /* parent always holds a reference to its children */
614 object_finalize(obj);
618 void object_property_add(Object *obj, const char *name, const char *type,
619 ObjectPropertyAccessor *get,
620 ObjectPropertyAccessor *set,
621 ObjectPropertyRelease *release,
622 void *opaque, Error **errp)
624 ObjectProperty *prop = g_malloc0(sizeof(*prop));
626 prop->name = g_strdup(name);
627 prop->type = g_strdup(type);
631 prop->release = release;
632 prop->opaque = opaque;
634 QTAILQ_INSERT_TAIL(&obj->properties, prop, node);
637 ObjectProperty *object_property_find(Object *obj, const char *name,
640 ObjectProperty *prop;
642 QTAILQ_FOREACH(prop, &obj->properties, node) {
643 if (strcmp(prop->name, name) == 0) {
648 error_set(errp, QERR_PROPERTY_NOT_FOUND, "", name);
652 void object_property_del(Object *obj, const char *name, Error **errp)
654 ObjectProperty *prop = object_property_find(obj, name, errp);
660 prop->release(obj, name, prop->opaque);
663 QTAILQ_REMOVE(&obj->properties, prop, node);
670 void object_property_get(Object *obj, Visitor *v, const char *name,
673 ObjectProperty *prop = object_property_find(obj, name, errp);
679 error_set(errp, QERR_PERMISSION_DENIED);
681 prop->get(obj, v, prop->opaque, name, errp);
685 void object_property_set(Object *obj, Visitor *v, const char *name,
688 ObjectProperty *prop = object_property_find(obj, name, errp);
694 error_set(errp, QERR_PERMISSION_DENIED);
696 prop->set(obj, v, prop->opaque, name, errp);
700 void object_property_set_str(Object *obj, const char *value,
701 const char *name, Error **errp)
703 QString *qstr = qstring_from_str(value);
704 object_property_set_qobject(obj, QOBJECT(qstr), name, errp);
709 char *object_property_get_str(Object *obj, const char *name,
712 QObject *ret = object_property_get_qobject(obj, name, errp);
719 qstring = qobject_to_qstring(ret);
721 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
724 retval = g_strdup(qstring_get_str(qstring));
731 void object_property_set_link(Object *obj, Object *value,
732 const char *name, Error **errp)
734 object_property_set_str(obj, object_get_canonical_path(value),
738 Object *object_property_get_link(Object *obj, const char *name,
741 char *str = object_property_get_str(obj, name, errp);
742 Object *target = NULL;
745 target = object_resolve_path(str, NULL);
747 error_set(errp, QERR_DEVICE_NOT_FOUND, str);
755 void object_property_set_bool(Object *obj, bool value,
756 const char *name, Error **errp)
758 QBool *qbool = qbool_from_int(value);
759 object_property_set_qobject(obj, QOBJECT(qbool), name, errp);
764 bool object_property_get_bool(Object *obj, const char *name,
767 QObject *ret = object_property_get_qobject(obj, name, errp);
774 qbool = qobject_to_qbool(ret);
776 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
779 retval = qbool_get_int(qbool);
786 void object_property_set_int(Object *obj, int64_t value,
787 const char *name, Error **errp)
789 QInt *qint = qint_from_int(value);
790 object_property_set_qobject(obj, QOBJECT(qint), name, errp);
795 int64_t object_property_get_int(Object *obj, const char *name,
798 QObject *ret = object_property_get_qobject(obj, name, errp);
805 qint = qobject_to_qint(ret);
807 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
810 retval = qint_get_int(qint);
817 void object_property_parse(Object *obj, const char *string,
818 const char *name, Error **errp)
820 StringInputVisitor *mi;
821 mi = string_input_visitor_new(string);
822 object_property_set(obj, string_input_get_visitor(mi), name, errp);
824 string_input_visitor_cleanup(mi);
827 char *object_property_print(Object *obj, const char *name,
830 StringOutputVisitor *mo;
833 mo = string_output_visitor_new();
834 object_property_get(obj, string_output_get_visitor(mo), name, errp);
835 string = string_output_get_string(mo);
836 string_output_visitor_cleanup(mo);
840 const char *object_property_get_type(Object *obj, const char *name, Error **errp)
842 ObjectProperty *prop = object_property_find(obj, name, errp);
850 Object *object_get_root(void)
855 root = object_new("container");
861 static void object_get_child_property(Object *obj, Visitor *v, void *opaque,
862 const char *name, Error **errp)
864 Object *child = opaque;
867 path = object_get_canonical_path(child);
868 visit_type_str(v, &path, name, errp);
872 static void object_finalize_child_property(Object *obj, const char *name,
875 Object *child = opaque;
880 void object_property_add_child(Object *obj, const char *name,
881 Object *child, Error **errp)
885 type = g_strdup_printf("child<%s>", object_get_typename(OBJECT(child)));
887 object_property_add(obj, name, type, object_get_child_property,
888 NULL, object_finalize_child_property, child, errp);
891 g_assert(child->parent == NULL);
897 static void object_get_link_property(Object *obj, Visitor *v, void *opaque,
898 const char *name, Error **errp)
900 Object **child = opaque;
904 path = object_get_canonical_path(*child);
905 visit_type_str(v, &path, name, errp);
909 visit_type_str(v, &path, name, errp);
913 static void object_set_link_property(Object *obj, Visitor *v, void *opaque,
914 const char *name, Error **errp)
916 Object **child = opaque;
918 bool ambiguous = false;
923 type = object_property_get_type(obj, name, NULL);
925 visit_type_str(v, &path, name, errp);
930 if (strcmp(path, "") != 0) {
933 /* Go from link<FOO> to FOO. */
934 target_type = g_strndup(&type[5], strlen(type) - 6);
935 target = object_resolve_path_type(path, target_type, &ambiguous);
938 error_set(errp, QERR_AMBIGUOUS_PATH, path);
943 target = object_resolve_path(path, &ambiguous);
944 if (target || ambiguous) {
945 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
947 error_set(errp, QERR_DEVICE_NOT_FOUND, path);
955 if (old_target != NULL) {
956 object_unref(old_target);
960 void object_property_add_link(Object *obj, const char *name,
961 const char *type, Object **child,
966 full_type = g_strdup_printf("link<%s>", type);
968 object_property_add(obj, name, full_type,
969 object_get_link_property,
970 object_set_link_property,
976 gchar *object_get_canonical_path(Object *obj)
978 Object *root = object_get_root();
979 char *newpath = NULL, *path = NULL;
981 while (obj != root) {
982 ObjectProperty *prop = NULL;
984 g_assert(obj->parent != NULL);
986 QTAILQ_FOREACH(prop, &obj->parent->properties, node) {
987 if (!object_property_is_child(prop)) {
991 if (prop->opaque == obj) {
993 newpath = g_strdup_printf("%s/%s", prop->name, path);
997 path = g_strdup(prop->name);
1003 g_assert(prop != NULL);
1008 newpath = g_strdup_printf("/%s", path);
1014 Object *object_resolve_path_component(Object *parent, gchar *part)
1016 ObjectProperty *prop = object_property_find(parent, part, NULL);
1021 if (object_property_is_link(prop)) {
1022 return *(Object **)prop->opaque;
1023 } else if (object_property_is_child(prop)) {
1024 return prop->opaque;
1030 static Object *object_resolve_abs_path(Object *parent,
1032 const char *typename,
1037 if (parts[index] == NULL) {
1038 return object_dynamic_cast(parent, typename);
1041 if (strcmp(parts[index], "") == 0) {
1042 return object_resolve_abs_path(parent, parts, typename, index + 1);
1045 child = object_resolve_path_component(parent, parts[index]);
1050 return object_resolve_abs_path(child, parts, typename, index + 1);
1053 static Object *object_resolve_partial_path(Object *parent,
1055 const char *typename,
1059 ObjectProperty *prop;
1061 obj = object_resolve_abs_path(parent, parts, typename, 0);
1063 QTAILQ_FOREACH(prop, &parent->properties, node) {
1066 if (!object_property_is_child(prop)) {
1070 found = object_resolve_partial_path(prop->opaque, parts,
1071 typename, ambiguous);
1082 if (ambiguous && *ambiguous) {
1090 Object *object_resolve_path_type(const char *path, const char *typename,
1093 bool partial_path = true;
1097 parts = g_strsplit(path, "/", 0);
1098 if (parts == NULL || parts[0] == NULL) {
1100 return object_get_root();
1103 if (strcmp(parts[0], "") == 0) {
1104 partial_path = false;
1111 obj = object_resolve_partial_path(object_get_root(), parts,
1112 typename, ambiguous);
1114 obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
1122 Object *object_resolve_path(const char *path, bool *ambiguous)
1124 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
1127 typedef struct StringProperty
1129 char *(*get)(Object *, Error **);
1130 void (*set)(Object *, const char *, Error **);
1133 static void property_get_str(Object *obj, Visitor *v, void *opaque,
1134 const char *name, Error **errp)
1136 StringProperty *prop = opaque;
1139 value = prop->get(obj, errp);
1141 visit_type_str(v, &value, name, errp);
1146 static void property_set_str(Object *obj, Visitor *v, void *opaque,
1147 const char *name, Error **errp)
1149 StringProperty *prop = opaque;
1151 Error *local_err = NULL;
1153 visit_type_str(v, &value, name, &local_err);
1155 error_propagate(errp, local_err);
1159 prop->set(obj, value, errp);
1163 static void property_release_str(Object *obj, const char *name,
1166 StringProperty *prop = opaque;
1170 void object_property_add_str(Object *obj, const char *name,
1171 char *(*get)(Object *, Error **),
1172 void (*set)(Object *, const char *, Error **),
1175 StringProperty *prop = g_malloc0(sizeof(*prop));
1180 object_property_add(obj, name, "string",
1181 get ? property_get_str : NULL,
1182 set ? property_set_str : NULL,
1183 property_release_str,
1187 static char *qdev_get_type(Object *obj, Error **errp)
1189 return g_strdup(object_get_typename(obj));
1192 static void object_instance_init(Object *obj)
1194 object_property_add_str(obj, "type", qdev_get_type, NULL, NULL);
1197 static void register_types(void)
1199 static TypeInfo interface_info = {
1200 .name = TYPE_INTERFACE,
1201 .class_size = sizeof(InterfaceClass),
1205 static TypeInfo object_info = {
1206 .name = TYPE_OBJECT,
1207 .instance_size = sizeof(Object),
1208 .instance_init = object_instance_init,
1212 type_interface = type_register_internal(&interface_info);
1213 type_register_internal(&object_info);
1216 type_init(register_types)