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 "qom/object.h"
14 #include "qemu-common.h"
15 #include "qapi/visitor.h"
16 #include "qapi/string-input-visitor.h"
17 #include "qapi/string-output-visitor.h"
18 #include "qapi/qmp/qerror.h"
20 /* TODO: replace QObject with a simpler visitor to avoid a dependency
21 * of the QOM core on QObject? */
22 #include "qom/qom-qobject.h"
23 #include "qapi/qmp/qobject.h"
24 #include "qapi/qmp/qbool.h"
25 #include "qapi/qmp/qint.h"
26 #include "qapi/qmp/qstring.h"
28 #define MAX_INTERFACES 32
30 typedef struct InterfaceImpl InterfaceImpl;
31 typedef struct TypeImpl TypeImpl;
46 void (*class_init)(ObjectClass *klass, void *data);
47 void (*class_base_init)(ObjectClass *klass, void *data);
48 void (*class_finalize)(ObjectClass *klass, void *data);
52 void (*instance_init)(Object *obj);
53 void (*instance_finalize)(Object *obj);
58 TypeImpl *parent_type;
63 InterfaceImpl interfaces[MAX_INTERFACES];
66 static Type type_interface;
68 static GHashTable *type_table_get(void)
70 static GHashTable *type_table;
72 if (type_table == NULL) {
73 type_table = g_hash_table_new(g_str_hash, g_str_equal);
79 static void type_table_add(TypeImpl *ti)
81 g_hash_table_insert(type_table_get(), (void *)ti->name, ti);
84 static TypeImpl *type_table_lookup(const char *name)
86 return g_hash_table_lookup(type_table_get(), name);
89 static TypeImpl *type_register_internal(const TypeInfo *info)
91 TypeImpl *ti = g_malloc0(sizeof(*ti));
94 g_assert(info->name != NULL);
96 if (type_table_lookup(info->name) != NULL) {
97 fprintf(stderr, "Registering `%s' which already exists\n", info->name);
101 ti->name = g_strdup(info->name);
102 ti->parent = g_strdup(info->parent);
104 ti->class_size = info->class_size;
105 ti->instance_size = info->instance_size;
107 ti->class_init = info->class_init;
108 ti->class_base_init = info->class_base_init;
109 ti->class_finalize = info->class_finalize;
110 ti->class_data = info->class_data;
112 ti->instance_init = info->instance_init;
113 ti->instance_finalize = info->instance_finalize;
115 ti->abstract = info->abstract;
117 for (i = 0; info->interfaces && info->interfaces[i].type; i++) {
118 ti->interfaces[i].typename = g_strdup(info->interfaces[i].type);
120 ti->num_interfaces = i;
127 TypeImpl *type_register(const TypeInfo *info)
129 assert(info->parent);
130 return type_register_internal(info);
133 TypeImpl *type_register_static(const TypeInfo *info)
135 return type_register(info);
138 static TypeImpl *type_get_by_name(const char *name)
144 return type_table_lookup(name);
147 static TypeImpl *type_get_parent(TypeImpl *type)
149 if (!type->parent_type && type->parent) {
150 type->parent_type = type_get_by_name(type->parent);
151 g_assert(type->parent_type != NULL);
154 return type->parent_type;
157 static bool type_has_parent(TypeImpl *type)
159 return (type->parent != NULL);
162 static size_t type_class_get_size(TypeImpl *ti)
164 if (ti->class_size) {
165 return ti->class_size;
168 if (type_has_parent(ti)) {
169 return type_class_get_size(type_get_parent(ti));
172 return sizeof(ObjectClass);
175 static size_t type_object_get_size(TypeImpl *ti)
177 if (ti->instance_size) {
178 return ti->instance_size;
181 if (type_has_parent(ti)) {
182 return type_object_get_size(type_get_parent(ti));
188 static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
192 /* Check if typename is a direct ancestor of type */
194 if (type == target_type) {
198 type = type_get_parent(type);
204 static void type_initialize(TypeImpl *ti);
206 static void type_initialize_interface(TypeImpl *ti, const char *parent)
208 InterfaceClass *new_iface;
210 TypeImpl *iface_impl;
212 info.parent = parent;
213 info.name = g_strdup_printf("%s::%s", ti->name, info.parent);
214 info.abstract = true;
216 iface_impl = type_register(&info);
217 type_initialize(iface_impl);
218 g_free((char *)info.name);
220 new_iface = (InterfaceClass *)iface_impl->class;
221 new_iface->concrete_class = ti->class;
223 ti->class->interfaces = g_slist_append(ti->class->interfaces,
227 static void type_initialize(TypeImpl *ti)
235 ti->class_size = type_class_get_size(ti);
236 ti->instance_size = type_object_get_size(ti);
238 ti->class = g_malloc0(ti->class_size);
240 parent = type_get_parent(ti);
242 type_initialize(parent);
246 g_assert(parent->class_size <= ti->class_size);
247 memcpy(ti->class, parent->class, parent->class_size);
248 ti->class->interfaces = NULL;
250 for (e = parent->class->interfaces; e; e = e->next) {
251 ObjectClass *iface = e->data;
252 type_initialize_interface(ti, object_class_get_name(iface));
255 for (i = 0; i < ti->num_interfaces; i++) {
256 TypeImpl *t = type_get_by_name(ti->interfaces[i].typename);
257 for (e = ti->class->interfaces; e; e = e->next) {
258 TypeImpl *target_type = OBJECT_CLASS(e->data)->type;
260 if (type_is_ancestor(target_type, t)) {
269 type_initialize_interface(ti, ti->interfaces[i].typename);
273 ti->class->type = ti;
276 if (parent->class_base_init) {
277 parent->class_base_init(ti->class, ti->class_data);
279 parent = type_get_parent(parent);
282 if (ti->class_init) {
283 ti->class_init(ti->class, ti->class_data);
289 static void object_init_with_type(Object *obj, TypeImpl *ti)
291 if (type_has_parent(ti)) {
292 object_init_with_type(obj, type_get_parent(ti));
295 if (ti->instance_init) {
296 ti->instance_init(obj);
300 void object_initialize_with_type(void *data, TypeImpl *type)
304 g_assert(type != NULL);
305 type_initialize(type);
307 g_assert(type->instance_size >= sizeof(Object));
308 g_assert(type->abstract == false);
310 memset(obj, 0, type->instance_size);
311 obj->class = type->class;
313 QTAILQ_INIT(&obj->properties);
314 object_init_with_type(obj, type);
317 void object_initialize(void *data, const char *typename)
319 TypeImpl *type = type_get_by_name(typename);
321 object_initialize_with_type(data, type);
324 static inline bool object_property_is_child(ObjectProperty *prop)
326 return strstart(prop->type, "child<", NULL);
329 static inline bool object_property_is_link(ObjectProperty *prop)
331 return strstart(prop->type, "link<", NULL);
334 static void object_property_del_all(Object *obj)
336 while (!QTAILQ_EMPTY(&obj->properties)) {
337 ObjectProperty *prop = QTAILQ_FIRST(&obj->properties);
339 QTAILQ_REMOVE(&obj->properties, prop, node);
342 prop->release(obj, prop->name, prop->opaque);
351 static void object_property_del_child(Object *obj, Object *child, Error **errp)
353 ObjectProperty *prop;
355 QTAILQ_FOREACH(prop, &obj->properties, node) {
356 if (object_property_is_child(prop) && prop->opaque == child) {
357 object_property_del(obj, prop->name, errp);
363 void object_unparent(Object *obj)
370 if (obj->class->unparent) {
371 (obj->class->unparent)(obj);
374 object_property_del_child(obj->parent, obj, NULL);
379 static void object_deinit(Object *obj, TypeImpl *type)
381 if (type->instance_finalize) {
382 type->instance_finalize(obj);
385 if (type_has_parent(type)) {
386 object_deinit(obj, type_get_parent(type));
390 static void object_finalize(void *data)
393 TypeImpl *ti = obj->class->type;
395 object_deinit(obj, ti);
396 object_property_del_all(obj);
398 g_assert(obj->ref == 0);
404 Object *object_new_with_type(Type type)
408 g_assert(type != NULL);
409 type_initialize(type);
411 obj = g_malloc(type->instance_size);
412 object_initialize_with_type(obj, type);
418 Object *object_new(const char *typename)
420 TypeImpl *ti = type_get_by_name(typename);
422 return object_new_with_type(ti);
425 Object *object_dynamic_cast(Object *obj, const char *typename)
427 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
434 Object *object_dynamic_cast_assert(Object *obj, const char *typename)
438 inst = object_dynamic_cast(obj, typename);
441 fprintf(stderr, "Object %p is not an instance of type %s\n",
449 ObjectClass *object_class_dynamic_cast(ObjectClass *class,
450 const char *typename)
452 TypeImpl *target_type = type_get_by_name(typename);
453 TypeImpl *type = class->type;
454 ObjectClass *ret = NULL;
457 /* target class type unknown, so fail the cast */
461 if (type->class->interfaces &&
462 type_is_ancestor(target_type, type_interface)) {
466 for (i = class->interfaces; i; i = i->next) {
467 ObjectClass *target_class = i->data;
469 if (type_is_ancestor(target_class->type, target_type)) {
475 /* The match was ambiguous, don't allow a cast */
479 } else if (type_is_ancestor(type, target_type)) {
486 ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
487 const char *typename)
489 ObjectClass *ret = object_class_dynamic_cast(class, typename);
492 fprintf(stderr, "Object %p is not an instance of type %s\n",
500 const char *object_get_typename(Object *obj)
502 return obj->class->type->name;
505 ObjectClass *object_get_class(Object *obj)
510 bool object_class_is_abstract(ObjectClass *klass)
512 return klass->type->abstract;
515 const char *object_class_get_name(ObjectClass *klass)
517 return klass->type->name;
520 ObjectClass *object_class_by_name(const char *typename)
522 TypeImpl *type = type_get_by_name(typename);
528 type_initialize(type);
533 ObjectClass *object_class_get_parent(ObjectClass *class)
535 TypeImpl *type = type_get_parent(class->type);
541 type_initialize(type);
546 typedef struct OCFData
548 void (*fn)(ObjectClass *klass, void *opaque);
549 const char *implements_type;
550 bool include_abstract;
554 static void object_class_foreach_tramp(gpointer key, gpointer value,
557 OCFData *data = opaque;
558 TypeImpl *type = value;
561 type_initialize(type);
564 if (!data->include_abstract && type->abstract) {
568 if (data->implements_type &&
569 !object_class_dynamic_cast(k, data->implements_type)) {
573 data->fn(k, data->opaque);
576 void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
577 const char *implements_type, bool include_abstract,
580 OCFData data = { fn, implements_type, include_abstract, opaque };
582 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
585 int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
588 ObjectProperty *prop;
591 QTAILQ_FOREACH(prop, &obj->properties, node) {
592 if (object_property_is_child(prop)) {
593 ret = fn(prop->opaque, opaque);
602 static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
604 GSList **list = opaque;
606 *list = g_slist_prepend(*list, klass);
609 GSList *object_class_get_list(const char *implements_type,
610 bool include_abstract)
614 object_class_foreach(object_class_get_list_tramp,
615 implements_type, include_abstract, &list);
619 void object_ref(Object *obj)
624 void object_unref(Object *obj)
626 g_assert(obj->ref > 0);
629 /* parent always holds a reference to its children */
631 object_finalize(obj);
635 void object_property_add(Object *obj, const char *name, const char *type,
636 ObjectPropertyAccessor *get,
637 ObjectPropertyAccessor *set,
638 ObjectPropertyRelease *release,
639 void *opaque, Error **errp)
641 ObjectProperty *prop;
643 QTAILQ_FOREACH(prop, &obj->properties, node) {
644 if (strcmp(prop->name, name) == 0) {
645 error_setg(errp, "attempt to add duplicate property '%s'"
646 " to object (type '%s')", name,
647 object_get_typename(obj));
652 prop = g_malloc0(sizeof(*prop));
654 prop->name = g_strdup(name);
655 prop->type = g_strdup(type);
659 prop->release = release;
660 prop->opaque = opaque;
662 QTAILQ_INSERT_TAIL(&obj->properties, prop, node);
665 ObjectProperty *object_property_find(Object *obj, const char *name,
668 ObjectProperty *prop;
670 QTAILQ_FOREACH(prop, &obj->properties, node) {
671 if (strcmp(prop->name, name) == 0) {
676 error_set(errp, QERR_PROPERTY_NOT_FOUND, "", name);
680 void object_property_del(Object *obj, const char *name, Error **errp)
682 ObjectProperty *prop = object_property_find(obj, name, errp);
688 prop->release(obj, name, prop->opaque);
691 QTAILQ_REMOVE(&obj->properties, prop, node);
698 void object_property_get(Object *obj, Visitor *v, const char *name,
701 ObjectProperty *prop = object_property_find(obj, name, errp);
707 error_set(errp, QERR_PERMISSION_DENIED);
709 prop->get(obj, v, prop->opaque, name, errp);
713 void object_property_set(Object *obj, Visitor *v, const char *name,
716 ObjectProperty *prop = object_property_find(obj, name, errp);
722 error_set(errp, QERR_PERMISSION_DENIED);
724 prop->set(obj, v, prop->opaque, name, errp);
728 void object_property_set_str(Object *obj, const char *value,
729 const char *name, Error **errp)
731 QString *qstr = qstring_from_str(value);
732 object_property_set_qobject(obj, QOBJECT(qstr), name, errp);
737 char *object_property_get_str(Object *obj, const char *name,
740 QObject *ret = object_property_get_qobject(obj, name, errp);
747 qstring = qobject_to_qstring(ret);
749 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
752 retval = g_strdup(qstring_get_str(qstring));
759 void object_property_set_link(Object *obj, Object *value,
760 const char *name, Error **errp)
762 object_property_set_str(obj, object_get_canonical_path(value),
766 Object *object_property_get_link(Object *obj, const char *name,
769 char *str = object_property_get_str(obj, name, errp);
770 Object *target = NULL;
773 target = object_resolve_path(str, NULL);
775 error_set(errp, QERR_DEVICE_NOT_FOUND, str);
783 void object_property_set_bool(Object *obj, bool value,
784 const char *name, Error **errp)
786 QBool *qbool = qbool_from_int(value);
787 object_property_set_qobject(obj, QOBJECT(qbool), name, errp);
792 bool object_property_get_bool(Object *obj, const char *name,
795 QObject *ret = object_property_get_qobject(obj, name, errp);
802 qbool = qobject_to_qbool(ret);
804 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
807 retval = qbool_get_int(qbool);
814 void object_property_set_int(Object *obj, int64_t value,
815 const char *name, Error **errp)
817 QInt *qint = qint_from_int(value);
818 object_property_set_qobject(obj, QOBJECT(qint), name, errp);
823 int64_t object_property_get_int(Object *obj, const char *name,
826 QObject *ret = object_property_get_qobject(obj, name, errp);
833 qint = qobject_to_qint(ret);
835 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
838 retval = qint_get_int(qint);
845 void object_property_parse(Object *obj, const char *string,
846 const char *name, Error **errp)
848 StringInputVisitor *mi;
849 mi = string_input_visitor_new(string);
850 object_property_set(obj, string_input_get_visitor(mi), name, errp);
852 string_input_visitor_cleanup(mi);
855 char *object_property_print(Object *obj, const char *name,
858 StringOutputVisitor *mo;
861 mo = string_output_visitor_new();
862 object_property_get(obj, string_output_get_visitor(mo), name, errp);
863 string = string_output_get_string(mo);
864 string_output_visitor_cleanup(mo);
868 const char *object_property_get_type(Object *obj, const char *name, Error **errp)
870 ObjectProperty *prop = object_property_find(obj, name, errp);
878 Object *object_get_root(void)
883 root = object_new("container");
889 static void object_get_child_property(Object *obj, Visitor *v, void *opaque,
890 const char *name, Error **errp)
892 Object *child = opaque;
895 path = object_get_canonical_path(child);
896 visit_type_str(v, &path, name, errp);
900 static void object_finalize_child_property(Object *obj, const char *name,
903 Object *child = opaque;
908 void object_property_add_child(Object *obj, const char *name,
909 Object *child, Error **errp)
913 type = g_strdup_printf("child<%s>", object_get_typename(OBJECT(child)));
915 object_property_add(obj, name, type, object_get_child_property,
916 NULL, object_finalize_child_property, child, errp);
919 g_assert(child->parent == NULL);
925 static void object_get_link_property(Object *obj, Visitor *v, void *opaque,
926 const char *name, Error **errp)
928 Object **child = opaque;
932 path = object_get_canonical_path(*child);
933 visit_type_str(v, &path, name, errp);
937 visit_type_str(v, &path, name, errp);
941 static void object_set_link_property(Object *obj, Visitor *v, void *opaque,
942 const char *name, Error **errp)
944 Object **child = opaque;
946 bool ambiguous = false;
951 type = object_property_get_type(obj, name, NULL);
953 visit_type_str(v, &path, name, errp);
958 if (strcmp(path, "") != 0) {
961 /* Go from link<FOO> to FOO. */
962 target_type = g_strndup(&type[5], strlen(type) - 6);
963 target = object_resolve_path_type(path, target_type, &ambiguous);
966 error_set(errp, QERR_AMBIGUOUS_PATH, path);
971 target = object_resolve_path(path, &ambiguous);
972 if (target || ambiguous) {
973 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
975 error_set(errp, QERR_DEVICE_NOT_FOUND, path);
983 if (old_target != NULL) {
984 object_unref(old_target);
988 void object_property_add_link(Object *obj, const char *name,
989 const char *type, Object **child,
994 full_type = g_strdup_printf("link<%s>", type);
996 object_property_add(obj, name, full_type,
997 object_get_link_property,
998 object_set_link_property,
1004 gchar *object_get_canonical_path(Object *obj)
1006 Object *root = object_get_root();
1007 char *newpath = NULL, *path = NULL;
1009 while (obj != root) {
1010 ObjectProperty *prop = NULL;
1012 g_assert(obj->parent != NULL);
1014 QTAILQ_FOREACH(prop, &obj->parent->properties, node) {
1015 if (!object_property_is_child(prop)) {
1019 if (prop->opaque == obj) {
1021 newpath = g_strdup_printf("%s/%s", prop->name, path);
1025 path = g_strdup(prop->name);
1031 g_assert(prop != NULL);
1036 newpath = g_strdup_printf("/%s", path);
1042 Object *object_resolve_path_component(Object *parent, const gchar *part)
1044 ObjectProperty *prop = object_property_find(parent, part, NULL);
1049 if (object_property_is_link(prop)) {
1050 return *(Object **)prop->opaque;
1051 } else if (object_property_is_child(prop)) {
1052 return prop->opaque;
1058 static Object *object_resolve_abs_path(Object *parent,
1060 const char *typename,
1065 if (parts[index] == NULL) {
1066 return object_dynamic_cast(parent, typename);
1069 if (strcmp(parts[index], "") == 0) {
1070 return object_resolve_abs_path(parent, parts, typename, index + 1);
1073 child = object_resolve_path_component(parent, parts[index]);
1078 return object_resolve_abs_path(child, parts, typename, index + 1);
1081 static Object *object_resolve_partial_path(Object *parent,
1083 const char *typename,
1087 ObjectProperty *prop;
1089 obj = object_resolve_abs_path(parent, parts, typename, 0);
1091 QTAILQ_FOREACH(prop, &parent->properties, node) {
1094 if (!object_property_is_child(prop)) {
1098 found = object_resolve_partial_path(prop->opaque, parts,
1099 typename, ambiguous);
1110 if (ambiguous && *ambiguous) {
1118 Object *object_resolve_path_type(const char *path, const char *typename,
1124 parts = g_strsplit(path, "/", 0);
1127 if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
1131 obj = object_resolve_partial_path(object_get_root(), parts,
1132 typename, ambiguous);
1134 obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
1142 Object *object_resolve_path(const char *path, bool *ambiguous)
1144 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
1147 typedef struct StringProperty
1149 char *(*get)(Object *, Error **);
1150 void (*set)(Object *, const char *, Error **);
1153 static void property_get_str(Object *obj, Visitor *v, void *opaque,
1154 const char *name, Error **errp)
1156 StringProperty *prop = opaque;
1159 value = prop->get(obj, errp);
1161 visit_type_str(v, &value, name, errp);
1166 static void property_set_str(Object *obj, Visitor *v, void *opaque,
1167 const char *name, Error **errp)
1169 StringProperty *prop = opaque;
1171 Error *local_err = NULL;
1173 visit_type_str(v, &value, name, &local_err);
1175 error_propagate(errp, local_err);
1179 prop->set(obj, value, errp);
1183 static void property_release_str(Object *obj, const char *name,
1186 StringProperty *prop = opaque;
1190 void object_property_add_str(Object *obj, const char *name,
1191 char *(*get)(Object *, Error **),
1192 void (*set)(Object *, const char *, Error **),
1195 StringProperty *prop = g_malloc0(sizeof(*prop));
1200 object_property_add(obj, name, "string",
1201 get ? property_get_str : NULL,
1202 set ? property_set_str : NULL,
1203 property_release_str,
1207 typedef struct BoolProperty
1209 bool (*get)(Object *, Error **);
1210 void (*set)(Object *, bool, Error **);
1213 static void property_get_bool(Object *obj, Visitor *v, void *opaque,
1214 const char *name, Error **errp)
1216 BoolProperty *prop = opaque;
1219 value = prop->get(obj, errp);
1220 visit_type_bool(v, &value, name, errp);
1223 static void property_set_bool(Object *obj, Visitor *v, void *opaque,
1224 const char *name, Error **errp)
1226 BoolProperty *prop = opaque;
1228 Error *local_err = NULL;
1230 visit_type_bool(v, &value, name, &local_err);
1232 error_propagate(errp, local_err);
1236 prop->set(obj, value, errp);
1239 static void property_release_bool(Object *obj, const char *name,
1242 BoolProperty *prop = opaque;
1246 void object_property_add_bool(Object *obj, const char *name,
1247 bool (*get)(Object *, Error **),
1248 void (*set)(Object *, bool, Error **),
1251 BoolProperty *prop = g_malloc0(sizeof(*prop));
1256 object_property_add(obj, name, "bool",
1257 get ? property_get_bool : NULL,
1258 set ? property_set_bool : NULL,
1259 property_release_bool,
1263 static char *qdev_get_type(Object *obj, Error **errp)
1265 return g_strdup(object_get_typename(obj));
1268 static void object_instance_init(Object *obj)
1270 object_property_add_str(obj, "type", qdev_get_type, NULL, NULL);
1273 static void register_types(void)
1275 static TypeInfo interface_info = {
1276 .name = TYPE_INTERFACE,
1277 .class_size = sizeof(InterfaceClass),
1281 static TypeInfo object_info = {
1282 .name = TYPE_OBJECT,
1283 .instance_size = sizeof(Object),
1284 .instance_init = object_instance_init,
1288 type_interface = type_register_internal(&interface_info);
1289 type_register_internal(&object_info);
1292 type_init(register_types)