vga.h: remove unused stuff and reformat
[qemu.git] / qom / object.c
blob426194484961eb663d23267fa3832070143bc21d
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 "qemu/object.h"
14 #include "qemu-common.h"
15 #include "qapi/qapi-visit-core.h"
16 #include "hw/qdev.h"
17 // FIXME remove above
19 #define MAX_INTERFACES 32
21 typedef struct InterfaceImpl InterfaceImpl;
22 typedef struct TypeImpl TypeImpl;
24 struct InterfaceImpl
26 const char *parent;
27 void (*interface_initfn)(ObjectClass *class, void *data);
28 TypeImpl *type;
31 struct TypeImpl
33 const char *name;
35 size_t class_size;
37 size_t instance_size;
39 void (*class_init)(ObjectClass *klass, void *data);
40 void (*class_finalize)(ObjectClass *klass, void *data);
42 void *class_data;
44 void (*instance_init)(Object *obj);
45 void (*instance_finalize)(Object *obj);
47 bool abstract;
49 const char *parent;
50 TypeImpl *parent_type;
52 ObjectClass *class;
54 int num_interfaces;
55 InterfaceImpl interfaces[MAX_INTERFACES];
58 typedef struct Interface
60 Object parent;
61 Object *obj;
62 } Interface;
64 #define INTERFACE(obj) OBJECT_CHECK(Interface, obj, TYPE_INTERFACE)
66 static GHashTable *type_table_get(void)
68 static GHashTable *type_table;
70 if (type_table == NULL) {
71 type_table = g_hash_table_new(g_str_hash, g_str_equal);
74 return type_table;
77 static void type_table_add(TypeImpl *ti)
79 g_hash_table_insert(type_table_get(), (void *)ti->name, ti);
82 static TypeImpl *type_table_lookup(const char *name)
84 return g_hash_table_lookup(type_table_get(), name);
87 TypeImpl *type_register(const TypeInfo *info)
89 TypeImpl *ti = g_malloc0(sizeof(*ti));
91 g_assert(info->name != NULL);
93 if (type_table_lookup(info->name) != NULL) {
94 fprintf(stderr, "Registering `%s' which already exists\n", info->name);
95 abort();
98 ti->name = g_strdup(info->name);
99 ti->parent = g_strdup(info->parent);
101 ti->class_size = info->class_size;
102 ti->instance_size = info->instance_size;
104 ti->class_init = info->class_init;
105 ti->class_finalize = info->class_finalize;
106 ti->class_data = info->class_data;
108 ti->instance_init = info->instance_init;
109 ti->instance_finalize = info->instance_finalize;
111 ti->abstract = info->abstract;
113 if (info->interfaces) {
114 int i;
116 for (i = 0; info->interfaces[i].type; i++) {
117 ti->interfaces[i].parent = info->interfaces[i].type;
118 ti->interfaces[i].interface_initfn = info->interfaces[i].interface_initfn;
119 ti->num_interfaces++;
123 type_table_add(ti);
125 return ti;
128 TypeImpl *type_register_static(const TypeInfo *info)
130 return type_register(info);
133 static TypeImpl *type_get_by_name(const char *name)
135 if (name == NULL) {
136 return NULL;
139 return type_table_lookup(name);
142 static TypeImpl *type_get_parent(TypeImpl *type)
144 if (!type->parent_type && type->parent) {
145 type->parent_type = type_get_by_name(type->parent);
146 g_assert(type->parent_type != NULL);
149 return type->parent_type;
152 static bool type_has_parent(TypeImpl *type)
154 return (type->parent != NULL);
157 static size_t type_class_get_size(TypeImpl *ti)
159 if (ti->class_size) {
160 return ti->class_size;
163 if (type_has_parent(ti)) {
164 return type_class_get_size(type_get_parent(ti));
167 return sizeof(ObjectClass);
170 static void type_class_interface_init(TypeImpl *ti, InterfaceImpl *iface)
172 TypeInfo info = {
173 .instance_size = sizeof(Interface),
174 .parent = iface->parent,
175 .class_size = sizeof(InterfaceClass),
176 .class_init = iface->interface_initfn,
177 .abstract = true,
179 char *name = g_strdup_printf("<%s::%s>", ti->name, iface->parent);
181 info.name = name;
182 iface->type = type_register(&info);
183 g_free(name);
186 static void type_class_init(TypeImpl *ti)
188 size_t class_size = sizeof(ObjectClass);
189 int i;
191 if (ti->class) {
192 return;
195 ti->class_size = type_class_get_size(ti);
197 ti->class = g_malloc0(ti->class_size);
198 ti->class->type = ti;
200 if (type_has_parent(ti)) {
201 TypeImpl *parent = type_get_parent(ti);
203 type_class_init(parent);
205 class_size = parent->class_size;
206 g_assert(parent->class_size <= ti->class_size);
208 memcpy((void *)ti->class + sizeof(ObjectClass),
209 (void *)parent->class + sizeof(ObjectClass),
210 parent->class_size - sizeof(ObjectClass));
213 memset((void *)ti->class + class_size, 0, ti->class_size - class_size);
215 for (i = 0; i < ti->num_interfaces; i++) {
216 type_class_interface_init(ti, &ti->interfaces[i]);
219 if (ti->class_init) {
220 ti->class_init(ti->class, ti->class_data);
224 static void object_interface_init(Object *obj, InterfaceImpl *iface)
226 TypeImpl *ti = iface->type;
227 Interface *iface_obj;
229 iface_obj = INTERFACE(object_new(ti->name));
230 iface_obj->obj = obj;
232 obj->interfaces = g_slist_prepend(obj->interfaces, iface_obj);
235 static void object_init_with_type(Object *obj, TypeImpl *ti)
237 int i;
239 if (type_has_parent(ti)) {
240 object_init_with_type(obj, type_get_parent(ti));
243 for (i = 0; i < ti->num_interfaces; i++) {
244 object_interface_init(obj, &ti->interfaces[i]);
247 if (ti->instance_init) {
248 ti->instance_init(obj);
252 void object_initialize_with_type(void *data, TypeImpl *type)
254 Object *obj = data;
256 g_assert(type != NULL);
257 g_assert(type->instance_size >= sizeof(ObjectClass));
259 type_class_init(type);
260 g_assert(type->abstract == false);
262 memset(obj, 0, type->instance_size);
263 obj->class = type->class;
264 QTAILQ_INIT(&obj->properties);
265 object_init_with_type(obj, type);
268 void object_initialize(void *data, const char *typename)
270 TypeImpl *type = type_get_by_name(typename);
272 object_initialize_with_type(data, type);
275 static void object_property_del_all(Object *obj)
277 while (!QTAILQ_EMPTY(&obj->properties)) {
278 ObjectProperty *prop = QTAILQ_FIRST(&obj->properties);
280 QTAILQ_REMOVE(&obj->properties, prop, node);
282 if (prop->release) {
283 prop->release(obj, prop->name, prop->opaque);
286 g_free(prop->name);
287 g_free(prop->type);
288 g_free(prop);
292 static void object_property_del_child(Object *obj, Object *child, Error **errp)
294 ObjectProperty *prop;
296 QTAILQ_FOREACH(prop, &obj->properties, node) {
297 if (!strstart(prop->type, "child<", NULL)) {
298 continue;
301 if (prop->opaque == child) {
302 object_property_del(obj, prop->name, errp);
307 void object_unparent(Object *obj)
309 if (obj->parent) {
310 object_property_del_child(obj->parent, obj, NULL);
314 static void object_deinit(Object *obj, TypeImpl *type)
316 if (type->instance_finalize) {
317 type->instance_finalize(obj);
320 while (obj->interfaces) {
321 Interface *iface_obj = obj->interfaces->data;
322 obj->interfaces = g_slist_delete_link(obj->interfaces, obj->interfaces);
323 object_delete(OBJECT(iface_obj));
326 if (type_has_parent(type)) {
327 object_deinit(obj, type_get_parent(type));
330 object_unparent(obj);
333 void object_finalize(void *data)
335 Object *obj = data;
336 TypeImpl *ti = obj->class->type;
338 object_deinit(obj, ti);
339 object_property_del_all(obj);
341 g_assert(obj->ref == 0);
344 Object *object_new_with_type(Type type)
346 Object *obj;
348 g_assert(type != NULL);
350 obj = g_malloc(type->instance_size);
351 object_initialize_with_type(obj, type);
352 object_ref(obj);
354 return obj;
357 Object *object_new(const char *typename)
359 TypeImpl *ti = type_get_by_name(typename);
361 return object_new_with_type(ti);
364 void object_delete(Object *obj)
366 object_unref(obj);
367 g_assert(obj->ref == 0);
368 g_free(obj);
371 static bool object_is_type(Object *obj, const char *typename)
373 TypeImpl *target_type = type_get_by_name(typename);
374 TypeImpl *type = obj->class->type;
375 GSList *i;
377 /* Check if typename is a direct ancestor of type */
378 while (type) {
379 if (type == target_type) {
380 return true;
383 type = type_get_parent(type);
386 /* Check if obj has an interface of typename */
387 for (i = obj->interfaces; i; i = i->next) {
388 Interface *iface = i->data;
390 if (object_is_type(OBJECT(iface), typename)) {
391 return true;
395 return false;
398 Object *object_dynamic_cast(Object *obj, const char *typename)
400 GSList *i;
402 /* Check if typename is a direct ancestor */
403 if (object_is_type(obj, typename)) {
404 return obj;
407 /* Check if obj has an interface of typename */
408 for (i = obj->interfaces; i; i = i->next) {
409 Interface *iface = i->data;
411 if (object_is_type(OBJECT(iface), typename)) {
412 return OBJECT(iface);
416 /* Check if obj is an interface and its containing object is a direct
417 * ancestor of typename */
418 if (object_is_type(obj, TYPE_INTERFACE)) {
419 Interface *iface = INTERFACE(obj);
421 if (object_is_type(iface->obj, typename)) {
422 return iface->obj;
426 return NULL;
430 static void register_interface(void)
432 static TypeInfo interface_info = {
433 .name = TYPE_INTERFACE,
434 .instance_size = sizeof(Interface),
435 .abstract = true,
438 type_register_static(&interface_info);
441 device_init(register_interface);
443 Object *object_dynamic_cast_assert(Object *obj, const char *typename)
445 Object *inst;
447 inst = object_dynamic_cast(obj, typename);
449 if (!inst) {
450 fprintf(stderr, "Object %p is not an instance of type %s\n",
451 obj, typename);
452 abort();
455 return inst;
458 ObjectClass *object_class_dynamic_cast(ObjectClass *class,
459 const char *typename)
461 TypeImpl *target_type = type_get_by_name(typename);
462 TypeImpl *type = class->type;
464 while (type) {
465 if (type == target_type) {
466 return class;
469 type = type_get_parent(type);
472 return NULL;
475 ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
476 const char *typename)
478 ObjectClass *ret = object_class_dynamic_cast(class, typename);
480 if (!ret) {
481 fprintf(stderr, "Object %p is not an instance of type %s\n",
482 class, typename);
483 abort();
486 return ret;
489 const char *object_get_typename(Object *obj)
491 return obj->class->type->name;
494 ObjectClass *object_get_class(Object *obj)
496 return obj->class;
499 const char *object_class_get_name(ObjectClass *klass)
501 return klass->type->name;
504 ObjectClass *object_class_by_name(const char *typename)
506 TypeImpl *type = type_get_by_name(typename);
508 if (!type) {
509 return NULL;
512 type_class_init(type);
514 return type->class;
517 typedef struct OCFData
519 void (*fn)(ObjectClass *klass, void *opaque);
520 const char *implements_type;
521 bool include_abstract;
522 void *opaque;
523 } OCFData;
525 static void object_class_foreach_tramp(gpointer key, gpointer value,
526 gpointer opaque)
528 OCFData *data = opaque;
529 TypeImpl *type = value;
530 ObjectClass *k;
532 type_class_init(type);
533 k = type->class;
535 if (!data->include_abstract && type->abstract) {
536 return;
539 if (data->implements_type &&
540 !object_class_dynamic_cast(k, data->implements_type)) {
541 return;
544 data->fn(k, data->opaque);
547 void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
548 const char *implements_type, bool include_abstract,
549 void *opaque)
551 OCFData data = { fn, implements_type, include_abstract, opaque };
553 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
556 void object_ref(Object *obj)
558 obj->ref++;
561 void object_unref(Object *obj)
563 g_assert(obj->ref > 0);
564 obj->ref--;
566 /* parent always holds a reference to its children */
567 if (obj->ref == 0) {
568 object_finalize(obj);
572 void object_property_add(Object *obj, const char *name, const char *type,
573 ObjectPropertyAccessor *get,
574 ObjectPropertyAccessor *set,
575 ObjectPropertyRelease *release,
576 void *opaque, Error **errp)
578 ObjectProperty *prop = g_malloc0(sizeof(*prop));
580 prop->name = g_strdup(name);
581 prop->type = g_strdup(type);
583 prop->get = get;
584 prop->set = set;
585 prop->release = release;
586 prop->opaque = opaque;
588 QTAILQ_INSERT_TAIL(&obj->properties, prop, node);
591 static ObjectProperty *object_property_find(Object *obj, const char *name)
593 ObjectProperty *prop;
595 QTAILQ_FOREACH(prop, &obj->properties, node) {
596 if (strcmp(prop->name, name) == 0) {
597 return prop;
601 return NULL;
604 void object_property_del(Object *obj, const char *name, Error **errp)
606 ObjectProperty *prop = object_property_find(obj, name);
608 QTAILQ_REMOVE(&obj->properties, prop, node);
610 prop->release(obj, prop->name, prop->opaque);
612 g_free(prop->name);
613 g_free(prop->type);
614 g_free(prop);
617 void object_property_get(Object *obj, Visitor *v, const char *name,
618 Error **errp)
620 ObjectProperty *prop = object_property_find(obj, name);
622 if (prop == NULL) {
623 error_set(errp, QERR_PROPERTY_NOT_FOUND, "", name);
624 return;
627 if (!prop->get) {
628 error_set(errp, QERR_PERMISSION_DENIED);
629 } else {
630 prop->get(obj, v, prop->opaque, name, errp);
634 void object_property_set(Object *obj, Visitor *v, const char *name,
635 Error **errp)
637 ObjectProperty *prop = object_property_find(obj, name);
639 if (prop == NULL) {
640 error_set(errp, QERR_PROPERTY_NOT_FOUND, "", name);
641 return;
644 if (!prop->set) {
645 error_set(errp, QERR_PERMISSION_DENIED);
646 } else {
647 prop->set(obj, v, prop->opaque, name, errp);
651 const char *object_property_get_type(Object *obj, const char *name, Error **errp)
653 ObjectProperty *prop = object_property_find(obj, name);
655 if (prop == NULL) {
656 error_set(errp, QERR_PROPERTY_NOT_FOUND, "", name);
657 return NULL;
660 return prop->type;
663 Object *object_get_root(void)
665 static Object *root;
667 if (!root) {
668 root = object_new("container");
671 return root;
674 static void object_get_child_property(Object *obj, Visitor *v, void *opaque,
675 const char *name, Error **errp)
677 Object *child = opaque;
678 gchar *path;
680 path = object_get_canonical_path(child);
681 visit_type_str(v, &path, name, errp);
682 g_free(path);
685 static void object_finalize_child_property(Object *obj, const char *name,
686 void *opaque)
688 Object *child = opaque;
690 object_unref(child);
693 void object_property_add_child(Object *obj, const char *name,
694 Object *child, Error **errp)
696 gchar *type;
698 type = g_strdup_printf("child<%s>", object_get_typename(OBJECT(child)));
700 object_property_add(obj, name, type, object_get_child_property,
701 NULL, object_finalize_child_property, child, errp);
703 object_ref(child);
704 g_assert(child->parent == NULL);
705 child->parent = obj;
707 g_free(type);
710 static void object_get_link_property(Object *obj, Visitor *v, void *opaque,
711 const char *name, Error **errp)
713 Object **child = opaque;
714 gchar *path;
716 if (*child) {
717 path = object_get_canonical_path(*child);
718 visit_type_str(v, &path, name, errp);
719 g_free(path);
720 } else {
721 path = (gchar *)"";
722 visit_type_str(v, &path, name, errp);
726 static void object_set_link_property(Object *obj, Visitor *v, void *opaque,
727 const char *name, Error **errp)
729 Object **child = opaque;
730 bool ambiguous = false;
731 const char *type;
732 char *path;
734 type = object_property_get_type(obj, name, NULL);
736 visit_type_str(v, &path, name, errp);
738 if (*child) {
739 object_unref(*child);
742 if (strcmp(path, "") != 0) {
743 Object *target;
745 target = object_resolve_path(path, &ambiguous);
746 if (target) {
747 gchar *target_type;
749 target_type = g_strdup(&type[5]);
750 target_type[strlen(target_type) - 2] = 0;
752 if (object_dynamic_cast(target, target_type)) {
753 object_ref(target);
754 *child = target;
755 } else {
756 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, type);
759 g_free(target_type);
760 } else {
761 error_set(errp, QERR_DEVICE_NOT_FOUND, path);
763 } else {
764 *child = NULL;
767 g_free(path);
770 void object_property_add_link(Object *obj, const char *name,
771 const char *type, Object **child,
772 Error **errp)
774 gchar *full_type;
776 full_type = g_strdup_printf("link<%s>", type);
778 object_property_add(obj, name, full_type,
779 object_get_link_property,
780 object_set_link_property,
781 NULL, child, errp);
783 g_free(full_type);
786 gchar *object_get_canonical_path(Object *obj)
788 Object *root = object_get_root();
789 char *newpath = NULL, *path = NULL;
791 while (obj != root) {
792 ObjectProperty *prop = NULL;
794 g_assert(obj->parent != NULL);
796 QTAILQ_FOREACH(prop, &obj->parent->properties, node) {
797 if (!strstart(prop->type, "child<", NULL)) {
798 continue;
801 if (prop->opaque == obj) {
802 if (path) {
803 newpath = g_strdup_printf("%s/%s", prop->name, path);
804 g_free(path);
805 path = newpath;
806 } else {
807 path = g_strdup(prop->name);
809 break;
813 g_assert(prop != NULL);
815 obj = obj->parent;
818 newpath = g_strdup_printf("/%s", path);
819 g_free(path);
821 return newpath;
824 static Object *object_resolve_abs_path(Object *parent,
825 gchar **parts,
826 int index)
828 ObjectProperty *prop;
829 Object *child;
831 if (parts[index] == NULL) {
832 return parent;
835 if (strcmp(parts[index], "") == 0) {
836 return object_resolve_abs_path(parent, parts, index + 1);
839 prop = object_property_find(parent, parts[index]);
840 if (prop == NULL) {
841 return NULL;
844 child = NULL;
845 if (strstart(prop->type, "link<", NULL)) {
846 Object **pchild = prop->opaque;
847 if (*pchild) {
848 child = *pchild;
850 } else if (strstart(prop->type, "child<", NULL)) {
851 child = prop->opaque;
854 if (!child) {
855 return NULL;
858 return object_resolve_abs_path(child, parts, index + 1);
861 static Object *object_resolve_partial_path(Object *parent,
862 gchar **parts,
863 bool *ambiguous)
865 Object *obj;
866 ObjectProperty *prop;
868 obj = object_resolve_abs_path(parent, parts, 0);
870 QTAILQ_FOREACH(prop, &parent->properties, node) {
871 Object *found;
873 if (!strstart(prop->type, "child<", NULL)) {
874 continue;
877 found = object_resolve_partial_path(prop->opaque, parts, ambiguous);
878 if (found) {
879 if (obj) {
880 if (ambiguous) {
881 *ambiguous = true;
883 return NULL;
885 obj = found;
888 if (ambiguous && *ambiguous) {
889 return NULL;
893 return obj;
896 Object *object_resolve_path(const char *path, bool *ambiguous)
898 bool partial_path = true;
899 Object *obj;
900 gchar **parts;
902 parts = g_strsplit(path, "/", 0);
903 if (parts == NULL || parts[0] == NULL) {
904 g_strfreev(parts);
905 return object_get_root();
908 if (strcmp(parts[0], "") == 0) {
909 partial_path = false;
912 if (partial_path) {
913 if (ambiguous) {
914 *ambiguous = false;
916 obj = object_resolve_partial_path(object_get_root(), parts, ambiguous);
917 } else {
918 obj = object_resolve_abs_path(object_get_root(), parts, 1);
921 g_strfreev(parts);
923 return obj;
926 typedef struct StringProperty
928 char *(*get)(Object *, Error **);
929 void (*set)(Object *, const char *, Error **);
930 } StringProperty;
932 static void object_property_get_str(Object *obj, Visitor *v, void *opaque,
933 const char *name, Error **errp)
935 StringProperty *prop = opaque;
936 char *value;
938 value = prop->get(obj, errp);
939 if (value) {
940 visit_type_str(v, &value, name, errp);
941 g_free(value);
945 static void object_property_set_str(Object *obj, Visitor *v, void *opaque,
946 const char *name, Error **errp)
948 StringProperty *prop = opaque;
949 char *value;
950 Error *local_err = NULL;
952 visit_type_str(v, &value, name, &local_err);
953 if (local_err) {
954 error_propagate(errp, local_err);
955 return;
958 prop->set(obj, value, errp);
959 g_free(value);
962 static void object_property_release_str(Object *obj, const char *name,
963 void *opaque)
965 StringProperty *prop = opaque;
966 g_free(prop);
969 void object_property_add_str(Object *obj, const char *name,
970 char *(*get)(Object *, Error **),
971 void (*set)(Object *, const char *, Error **),
972 Error **errp)
974 StringProperty *prop = g_malloc0(sizeof(*prop));
976 prop->get = get;
977 prop->set = set;
979 object_property_add(obj, name, "string",
980 get ? object_property_get_str : NULL,
981 set ? object_property_set_str : NULL,
982 object_property_release_str,
983 prop, errp);