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;
456 if (type->class->interfaces &&
457 type_is_ancestor(target_type, type_interface)) {
461 for (i = class->interfaces; i; i = i->next) {
462 ObjectClass *target_class = i->data;
464 if (type_is_ancestor(target_class->type, target_type)) {
470 /* The match was ambiguous, don't allow a cast */
474 } else if (type_is_ancestor(type, target_type)) {
481 ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
482 const char *typename)
484 ObjectClass *ret = object_class_dynamic_cast(class, typename);
487 fprintf(stderr, "Object %p is not an instance of type %s\n",
495 const char *object_get_typename(Object *obj)
497 return obj->class->type->name;
500 ObjectClass *object_get_class(Object *obj)
505 bool object_class_is_abstract(ObjectClass *klass)
507 return klass->type->abstract;
510 const char *object_class_get_name(ObjectClass *klass)
512 return klass->type->name;
515 ObjectClass *object_class_by_name(const char *typename)
517 TypeImpl *type = type_get_by_name(typename);
523 type_initialize(type);
528 ObjectClass *object_class_get_parent(ObjectClass *class)
530 TypeImpl *type = type_get_parent(class->type);
536 type_initialize(type);
541 typedef struct OCFData
543 void (*fn)(ObjectClass *klass, void *opaque);
544 const char *implements_type;
545 bool include_abstract;
549 static void object_class_foreach_tramp(gpointer key, gpointer value,
552 OCFData *data = opaque;
553 TypeImpl *type = value;
556 type_initialize(type);
559 if (!data->include_abstract && type->abstract) {
563 if (data->implements_type &&
564 !object_class_dynamic_cast(k, data->implements_type)) {
568 data->fn(k, data->opaque);
571 void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
572 const char *implements_type, bool include_abstract,
575 OCFData data = { fn, implements_type, include_abstract, opaque };
577 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
580 int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
583 ObjectProperty *prop;
586 QTAILQ_FOREACH(prop, &obj->properties, node) {
587 if (object_property_is_child(prop)) {
588 ret = fn(prop->opaque, opaque);
597 static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
599 GSList **list = opaque;
601 *list = g_slist_prepend(*list, klass);
604 GSList *object_class_get_list(const char *implements_type,
605 bool include_abstract)
609 object_class_foreach(object_class_get_list_tramp,
610 implements_type, include_abstract, &list);
614 void object_ref(Object *obj)
619 void object_unref(Object *obj)
621 g_assert(obj->ref > 0);
624 /* parent always holds a reference to its children */
626 object_finalize(obj);
630 void object_property_add(Object *obj, const char *name, const char *type,
631 ObjectPropertyAccessor *get,
632 ObjectPropertyAccessor *set,
633 ObjectPropertyRelease *release,
634 void *opaque, Error **errp)
636 ObjectProperty *prop;
638 QTAILQ_FOREACH(prop, &obj->properties, node) {
639 if (strcmp(prop->name, name) == 0) {
640 error_setg(errp, "attempt to add duplicate property '%s'"
641 " to object (type '%s')", name,
642 object_get_typename(obj));
647 prop = g_malloc0(sizeof(*prop));
649 prop->name = g_strdup(name);
650 prop->type = g_strdup(type);
654 prop->release = release;
655 prop->opaque = opaque;
657 QTAILQ_INSERT_TAIL(&obj->properties, prop, node);
660 ObjectProperty *object_property_find(Object *obj, const char *name,
663 ObjectProperty *prop;
665 QTAILQ_FOREACH(prop, &obj->properties, node) {
666 if (strcmp(prop->name, name) == 0) {
671 error_set(errp, QERR_PROPERTY_NOT_FOUND, "", name);
675 void object_property_del(Object *obj, const char *name, Error **errp)
677 ObjectProperty *prop = object_property_find(obj, name, errp);
683 prop->release(obj, name, prop->opaque);
686 QTAILQ_REMOVE(&obj->properties, prop, node);
693 void object_property_get(Object *obj, Visitor *v, const char *name,
696 ObjectProperty *prop = object_property_find(obj, name, errp);
702 error_set(errp, QERR_PERMISSION_DENIED);
704 prop->get(obj, v, prop->opaque, name, errp);
708 void object_property_set(Object *obj, Visitor *v, const char *name,
711 ObjectProperty *prop = object_property_find(obj, name, errp);
717 error_set(errp, QERR_PERMISSION_DENIED);
719 prop->set(obj, v, prop->opaque, name, errp);
723 void object_property_set_str(Object *obj, const char *value,
724 const char *name, Error **errp)
726 QString *qstr = qstring_from_str(value);
727 object_property_set_qobject(obj, QOBJECT(qstr), name, errp);
732 char *object_property_get_str(Object *obj, const char *name,
735 QObject *ret = object_property_get_qobject(obj, name, errp);
742 qstring = qobject_to_qstring(ret);
744 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
747 retval = g_strdup(qstring_get_str(qstring));
754 void object_property_set_link(Object *obj, Object *value,
755 const char *name, Error **errp)
757 object_property_set_str(obj, object_get_canonical_path(value),
761 Object *object_property_get_link(Object *obj, const char *name,
764 char *str = object_property_get_str(obj, name, errp);
765 Object *target = NULL;
768 target = object_resolve_path(str, NULL);
770 error_set(errp, QERR_DEVICE_NOT_FOUND, str);
778 void object_property_set_bool(Object *obj, bool value,
779 const char *name, Error **errp)
781 QBool *qbool = qbool_from_int(value);
782 object_property_set_qobject(obj, QOBJECT(qbool), name, errp);
787 bool object_property_get_bool(Object *obj, const char *name,
790 QObject *ret = object_property_get_qobject(obj, name, errp);
797 qbool = qobject_to_qbool(ret);
799 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
802 retval = qbool_get_int(qbool);
809 void object_property_set_int(Object *obj, int64_t value,
810 const char *name, Error **errp)
812 QInt *qint = qint_from_int(value);
813 object_property_set_qobject(obj, QOBJECT(qint), name, errp);
818 int64_t object_property_get_int(Object *obj, const char *name,
821 QObject *ret = object_property_get_qobject(obj, name, errp);
828 qint = qobject_to_qint(ret);
830 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
833 retval = qint_get_int(qint);
840 void object_property_parse(Object *obj, const char *string,
841 const char *name, Error **errp)
843 StringInputVisitor *mi;
844 mi = string_input_visitor_new(string);
845 object_property_set(obj, string_input_get_visitor(mi), name, errp);
847 string_input_visitor_cleanup(mi);
850 char *object_property_print(Object *obj, const char *name,
853 StringOutputVisitor *mo;
856 mo = string_output_visitor_new();
857 object_property_get(obj, string_output_get_visitor(mo), name, errp);
858 string = string_output_get_string(mo);
859 string_output_visitor_cleanup(mo);
863 const char *object_property_get_type(Object *obj, const char *name, Error **errp)
865 ObjectProperty *prop = object_property_find(obj, name, errp);
873 Object *object_get_root(void)
878 root = object_new("container");
884 static void object_get_child_property(Object *obj, Visitor *v, void *opaque,
885 const char *name, Error **errp)
887 Object *child = opaque;
890 path = object_get_canonical_path(child);
891 visit_type_str(v, &path, name, errp);
895 static void object_finalize_child_property(Object *obj, const char *name,
898 Object *child = opaque;
903 void object_property_add_child(Object *obj, const char *name,
904 Object *child, Error **errp)
908 type = g_strdup_printf("child<%s>", object_get_typename(OBJECT(child)));
910 object_property_add(obj, name, type, object_get_child_property,
911 NULL, object_finalize_child_property, child, errp);
914 g_assert(child->parent == NULL);
920 static void object_get_link_property(Object *obj, Visitor *v, void *opaque,
921 const char *name, Error **errp)
923 Object **child = opaque;
927 path = object_get_canonical_path(*child);
928 visit_type_str(v, &path, name, errp);
932 visit_type_str(v, &path, name, errp);
936 static void object_set_link_property(Object *obj, Visitor *v, void *opaque,
937 const char *name, Error **errp)
939 Object **child = opaque;
941 bool ambiguous = false;
946 type = object_property_get_type(obj, name, NULL);
948 visit_type_str(v, &path, name, errp);
953 if (strcmp(path, "") != 0) {
956 /* Go from link<FOO> to FOO. */
957 target_type = g_strndup(&type[5], strlen(type) - 6);
958 target = object_resolve_path_type(path, target_type, &ambiguous);
961 error_set(errp, QERR_AMBIGUOUS_PATH, path);
966 target = object_resolve_path(path, &ambiguous);
967 if (target || ambiguous) {
968 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
970 error_set(errp, QERR_DEVICE_NOT_FOUND, path);
978 if (old_target != NULL) {
979 object_unref(old_target);
983 void object_property_add_link(Object *obj, const char *name,
984 const char *type, Object **child,
989 full_type = g_strdup_printf("link<%s>", type);
991 object_property_add(obj, name, full_type,
992 object_get_link_property,
993 object_set_link_property,
999 gchar *object_get_canonical_path(Object *obj)
1001 Object *root = object_get_root();
1002 char *newpath = NULL, *path = NULL;
1004 while (obj != root) {
1005 ObjectProperty *prop = NULL;
1007 g_assert(obj->parent != NULL);
1009 QTAILQ_FOREACH(prop, &obj->parent->properties, node) {
1010 if (!object_property_is_child(prop)) {
1014 if (prop->opaque == obj) {
1016 newpath = g_strdup_printf("%s/%s", prop->name, path);
1020 path = g_strdup(prop->name);
1026 g_assert(prop != NULL);
1031 newpath = g_strdup_printf("/%s", path);
1037 Object *object_resolve_path_component(Object *parent, const gchar *part)
1039 ObjectProperty *prop = object_property_find(parent, part, NULL);
1044 if (object_property_is_link(prop)) {
1045 return *(Object **)prop->opaque;
1046 } else if (object_property_is_child(prop)) {
1047 return prop->opaque;
1053 static Object *object_resolve_abs_path(Object *parent,
1055 const char *typename,
1060 if (parts[index] == NULL) {
1061 return object_dynamic_cast(parent, typename);
1064 if (strcmp(parts[index], "") == 0) {
1065 return object_resolve_abs_path(parent, parts, typename, index + 1);
1068 child = object_resolve_path_component(parent, parts[index]);
1073 return object_resolve_abs_path(child, parts, typename, index + 1);
1076 static Object *object_resolve_partial_path(Object *parent,
1078 const char *typename,
1082 ObjectProperty *prop;
1084 obj = object_resolve_abs_path(parent, parts, typename, 0);
1086 QTAILQ_FOREACH(prop, &parent->properties, node) {
1089 if (!object_property_is_child(prop)) {
1093 found = object_resolve_partial_path(prop->opaque, parts,
1094 typename, ambiguous);
1105 if (ambiguous && *ambiguous) {
1113 Object *object_resolve_path_type(const char *path, const char *typename,
1119 parts = g_strsplit(path, "/", 0);
1122 if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
1126 obj = object_resolve_partial_path(object_get_root(), parts,
1127 typename, ambiguous);
1129 obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
1137 Object *object_resolve_path(const char *path, bool *ambiguous)
1139 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
1142 typedef struct StringProperty
1144 char *(*get)(Object *, Error **);
1145 void (*set)(Object *, const char *, Error **);
1148 static void property_get_str(Object *obj, Visitor *v, void *opaque,
1149 const char *name, Error **errp)
1151 StringProperty *prop = opaque;
1154 value = prop->get(obj, errp);
1156 visit_type_str(v, &value, name, errp);
1161 static void property_set_str(Object *obj, Visitor *v, void *opaque,
1162 const char *name, Error **errp)
1164 StringProperty *prop = opaque;
1166 Error *local_err = NULL;
1168 visit_type_str(v, &value, name, &local_err);
1170 error_propagate(errp, local_err);
1174 prop->set(obj, value, errp);
1178 static void property_release_str(Object *obj, const char *name,
1181 StringProperty *prop = opaque;
1185 void object_property_add_str(Object *obj, const char *name,
1186 char *(*get)(Object *, Error **),
1187 void (*set)(Object *, const char *, Error **),
1190 StringProperty *prop = g_malloc0(sizeof(*prop));
1195 object_property_add(obj, name, "string",
1196 get ? property_get_str : NULL,
1197 set ? property_set_str : NULL,
1198 property_release_str,
1202 typedef struct BoolProperty
1204 bool (*get)(Object *, Error **);
1205 void (*set)(Object *, bool, Error **);
1208 static void property_get_bool(Object *obj, Visitor *v, void *opaque,
1209 const char *name, Error **errp)
1211 BoolProperty *prop = opaque;
1214 value = prop->get(obj, errp);
1215 visit_type_bool(v, &value, name, errp);
1218 static void property_set_bool(Object *obj, Visitor *v, void *opaque,
1219 const char *name, Error **errp)
1221 BoolProperty *prop = opaque;
1223 Error *local_err = NULL;
1225 visit_type_bool(v, &value, name, &local_err);
1227 error_propagate(errp, local_err);
1231 prop->set(obj, value, errp);
1234 static void property_release_bool(Object *obj, const char *name,
1237 BoolProperty *prop = opaque;
1241 void object_property_add_bool(Object *obj, const char *name,
1242 bool (*get)(Object *, Error **),
1243 void (*set)(Object *, bool, Error **),
1246 BoolProperty *prop = g_malloc0(sizeof(*prop));
1251 object_property_add(obj, name, "bool",
1252 get ? property_get_bool : NULL,
1253 set ? property_set_bool : NULL,
1254 property_release_bool,
1258 static char *qdev_get_type(Object *obj, Error **errp)
1260 return g_strdup(object_get_typename(obj));
1263 static void object_instance_init(Object *obj)
1265 object_property_add_str(obj, "type", qdev_get_type, NULL, NULL);
1268 static void register_types(void)
1270 static TypeInfo interface_info = {
1271 .name = TYPE_INTERFACE,
1272 .class_size = sizeof(InterfaceClass),
1276 static TypeInfo object_info = {
1277 .name = TYPE_OBJECT,
1278 .instance_size = sizeof(Object),
1279 .instance_init = object_instance_init,
1283 type_interface = type_register_internal(&interface_info);
1284 type_register_internal(&object_info);
1287 type_init(register_types)