object: release all props
[qemu/armbru.git] / qom / object.c
blob66c4a5f1cb40d05bc42682d75d37b3c4f836588a
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/osdep.h"
14 #include "hw/qdev-core.h"
15 #include "qapi/error.h"
16 #include "qom/object.h"
17 #include "qom/object_interfaces.h"
18 #include "qemu/cutils.h"
19 #include "qapi/visitor.h"
20 #include "qapi/string-input-visitor.h"
21 #include "qapi/string-output-visitor.h"
22 #include "qapi/qobject-input-visitor.h"
23 #include "qapi/qapi-builtin-visit.h"
24 #include "qapi/qmp/qerror.h"
25 #include "qapi/qmp/qjson.h"
26 #include "trace.h"
28 /* TODO: replace QObject with a simpler visitor to avoid a dependency
29 * of the QOM core on QObject? */
30 #include "qom/qom-qobject.h"
31 #include "qapi/qmp/qbool.h"
32 #include "qapi/qmp/qnum.h"
33 #include "qapi/qmp/qstring.h"
34 #include "qemu/error-report.h"
36 #define MAX_INTERFACES 32
38 typedef struct InterfaceImpl InterfaceImpl;
39 typedef struct TypeImpl TypeImpl;
41 struct InterfaceImpl
43 const char *typename;
46 struct TypeImpl
48 const char *name;
50 size_t class_size;
52 size_t instance_size;
54 void (*class_init)(ObjectClass *klass, void *data);
55 void (*class_base_init)(ObjectClass *klass, void *data);
57 void *class_data;
59 void (*instance_init)(Object *obj);
60 void (*instance_post_init)(Object *obj);
61 void (*instance_finalize)(Object *obj);
63 bool abstract;
65 const char *parent;
66 TypeImpl *parent_type;
68 ObjectClass *class;
70 int num_interfaces;
71 InterfaceImpl interfaces[MAX_INTERFACES];
74 static Type type_interface;
76 static GHashTable *type_table_get(void)
78 static GHashTable *type_table;
80 if (type_table == NULL) {
81 type_table = g_hash_table_new(g_str_hash, g_str_equal);
84 return type_table;
87 static bool enumerating_types;
89 static void type_table_add(TypeImpl *ti)
91 assert(!enumerating_types);
92 g_hash_table_insert(type_table_get(), (void *)ti->name, ti);
95 static TypeImpl *type_table_lookup(const char *name)
97 return g_hash_table_lookup(type_table_get(), name);
100 static TypeImpl *type_new(const TypeInfo *info)
102 TypeImpl *ti = g_malloc0(sizeof(*ti));
103 int i;
105 g_assert(info->name != NULL);
107 if (type_table_lookup(info->name) != NULL) {
108 fprintf(stderr, "Registering `%s' which already exists\n", info->name);
109 abort();
112 ti->name = g_strdup(info->name);
113 ti->parent = g_strdup(info->parent);
115 ti->class_size = info->class_size;
116 ti->instance_size = info->instance_size;
118 ti->class_init = info->class_init;
119 ti->class_base_init = info->class_base_init;
120 ti->class_data = info->class_data;
122 ti->instance_init = info->instance_init;
123 ti->instance_post_init = info->instance_post_init;
124 ti->instance_finalize = info->instance_finalize;
126 ti->abstract = info->abstract;
128 for (i = 0; info->interfaces && info->interfaces[i].type; i++) {
129 ti->interfaces[i].typename = g_strdup(info->interfaces[i].type);
131 ti->num_interfaces = i;
133 return ti;
136 static TypeImpl *type_register_internal(const TypeInfo *info)
138 TypeImpl *ti;
139 ti = type_new(info);
141 type_table_add(ti);
142 return ti;
145 TypeImpl *type_register(const TypeInfo *info)
147 assert(info->parent);
148 return type_register_internal(info);
151 TypeImpl *type_register_static(const TypeInfo *info)
153 return type_register(info);
156 void type_register_static_array(const TypeInfo *infos, int nr_infos)
158 int i;
160 for (i = 0; i < nr_infos; i++) {
161 type_register_static(&infos[i]);
165 static TypeImpl *type_get_by_name(const char *name)
167 if (name == NULL) {
168 return NULL;
171 return type_table_lookup(name);
174 static TypeImpl *type_get_parent(TypeImpl *type)
176 if (!type->parent_type && type->parent) {
177 type->parent_type = type_get_by_name(type->parent);
178 if (!type->parent_type) {
179 fprintf(stderr, "Type '%s' is missing its parent '%s'\n",
180 type->name, type->parent);
181 abort();
185 return type->parent_type;
188 static bool type_has_parent(TypeImpl *type)
190 return (type->parent != NULL);
193 static size_t type_class_get_size(TypeImpl *ti)
195 if (ti->class_size) {
196 return ti->class_size;
199 if (type_has_parent(ti)) {
200 return type_class_get_size(type_get_parent(ti));
203 return sizeof(ObjectClass);
206 static size_t type_object_get_size(TypeImpl *ti)
208 if (ti->instance_size) {
209 return ti->instance_size;
212 if (type_has_parent(ti)) {
213 return type_object_get_size(type_get_parent(ti));
216 return 0;
219 size_t object_type_get_instance_size(const char *typename)
221 TypeImpl *type = type_get_by_name(typename);
223 g_assert(type != NULL);
224 return type_object_get_size(type);
227 static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
229 assert(target_type);
231 /* Check if target_type is a direct ancestor of type */
232 while (type) {
233 if (type == target_type) {
234 return true;
237 type = type_get_parent(type);
240 return false;
243 static void type_initialize(TypeImpl *ti);
245 static void type_initialize_interface(TypeImpl *ti, TypeImpl *interface_type,
246 TypeImpl *parent_type)
248 InterfaceClass *new_iface;
249 TypeInfo info = { };
250 TypeImpl *iface_impl;
252 info.parent = parent_type->name;
253 info.name = g_strdup_printf("%s::%s", ti->name, interface_type->name);
254 info.abstract = true;
256 iface_impl = type_new(&info);
257 iface_impl->parent_type = parent_type;
258 type_initialize(iface_impl);
259 g_free((char *)info.name);
261 new_iface = (InterfaceClass *)iface_impl->class;
262 new_iface->concrete_class = ti->class;
263 new_iface->interface_type = interface_type;
265 ti->class->interfaces = g_slist_append(ti->class->interfaces,
266 iface_impl->class);
269 static void object_property_free(gpointer data)
271 ObjectProperty *prop = data;
273 if (prop->defval) {
274 qobject_unref(prop->defval);
275 prop->defval = NULL;
277 g_free(prop->name);
278 g_free(prop->type);
279 g_free(prop->description);
280 g_free(prop);
283 static void type_initialize(TypeImpl *ti)
285 TypeImpl *parent;
287 if (ti->class) {
288 return;
291 ti->class_size = type_class_get_size(ti);
292 ti->instance_size = type_object_get_size(ti);
293 /* Any type with zero instance_size is implicitly abstract.
294 * This means interface types are all abstract.
296 if (ti->instance_size == 0) {
297 ti->abstract = true;
299 if (type_is_ancestor(ti, type_interface)) {
300 assert(ti->instance_size == 0);
301 assert(ti->abstract);
302 assert(!ti->instance_init);
303 assert(!ti->instance_post_init);
304 assert(!ti->instance_finalize);
305 assert(!ti->num_interfaces);
307 ti->class = g_malloc0(ti->class_size);
309 parent = type_get_parent(ti);
310 if (parent) {
311 type_initialize(parent);
312 GSList *e;
313 int i;
315 g_assert(parent->class_size <= ti->class_size);
316 g_assert(parent->instance_size <= ti->instance_size);
317 memcpy(ti->class, parent->class, parent->class_size);
318 ti->class->interfaces = NULL;
319 ti->class->properties = g_hash_table_new_full(
320 g_str_hash, g_str_equal, NULL, object_property_free);
322 for (e = parent->class->interfaces; e; e = e->next) {
323 InterfaceClass *iface = e->data;
324 ObjectClass *klass = OBJECT_CLASS(iface);
326 type_initialize_interface(ti, iface->interface_type, klass->type);
329 for (i = 0; i < ti->num_interfaces; i++) {
330 TypeImpl *t = type_get_by_name(ti->interfaces[i].typename);
331 if (!t) {
332 error_report("missing interface '%s' for object '%s'",
333 ti->interfaces[i].typename, parent->name);
334 abort();
336 for (e = ti->class->interfaces; e; e = e->next) {
337 TypeImpl *target_type = OBJECT_CLASS(e->data)->type;
339 if (type_is_ancestor(target_type, t)) {
340 break;
344 if (e) {
345 continue;
348 type_initialize_interface(ti, t, t);
350 } else {
351 ti->class->properties = g_hash_table_new_full(
352 g_str_hash, g_str_equal, NULL, object_property_free);
355 ti->class->type = ti;
357 while (parent) {
358 if (parent->class_base_init) {
359 parent->class_base_init(ti->class, ti->class_data);
361 parent = type_get_parent(parent);
364 if (ti->class_init) {
365 ti->class_init(ti->class, ti->class_data);
369 static void object_init_with_type(Object *obj, TypeImpl *ti)
371 if (type_has_parent(ti)) {
372 object_init_with_type(obj, type_get_parent(ti));
375 if (ti->instance_init) {
376 ti->instance_init(obj);
380 static void object_post_init_with_type(Object *obj, TypeImpl *ti)
382 if (ti->instance_post_init) {
383 ti->instance_post_init(obj);
386 if (type_has_parent(ti)) {
387 object_post_init_with_type(obj, type_get_parent(ti));
391 void object_apply_global_props(Object *obj, const GPtrArray *props, Error **errp)
393 int i;
395 if (!props) {
396 return;
399 for (i = 0; i < props->len; i++) {
400 GlobalProperty *p = g_ptr_array_index(props, i);
401 Error *err = NULL;
403 if (object_dynamic_cast(obj, p->driver) == NULL) {
404 continue;
406 if (p->optional && !object_property_find(obj, p->property, NULL)) {
407 continue;
409 p->used = true;
410 object_property_parse(obj, p->value, p->property, &err);
411 if (err != NULL) {
412 error_prepend(&err, "can't apply global %s.%s=%s: ",
413 p->driver, p->property, p->value);
415 * If errp != NULL, propagate error and return.
416 * If errp == NULL, report a warning, but keep going
417 * with the remaining globals.
419 if (errp) {
420 error_propagate(errp, err);
421 return;
422 } else {
423 warn_report_err(err);
430 * Global property defaults
431 * Slot 0: accelerator's global property defaults
432 * Slot 1: machine's global property defaults
433 * Slot 2: global properties from legacy command line option
434 * Each is a GPtrArray of of GlobalProperty.
435 * Applied in order, later entries override earlier ones.
437 static GPtrArray *object_compat_props[3];
440 * Retrieve @GPtrArray for global property defined with options
441 * other than "-global". These are generally used for syntactic
442 * sugar and legacy command line options.
444 void object_register_sugar_prop(const char *driver, const char *prop, const char *value)
446 GlobalProperty *g;
447 if (!object_compat_props[2]) {
448 object_compat_props[2] = g_ptr_array_new();
450 g = g_new0(GlobalProperty, 1);
451 g->driver = g_strdup(driver);
452 g->property = g_strdup(prop);
453 g->value = g_strdup(value);
454 g_ptr_array_add(object_compat_props[2], g);
458 * Set machine's global property defaults to @compat_props.
459 * May be called at most once.
461 void object_set_machine_compat_props(GPtrArray *compat_props)
463 assert(!object_compat_props[1]);
464 object_compat_props[1] = compat_props;
468 * Set accelerator's global property defaults to @compat_props.
469 * May be called at most once.
471 void object_set_accelerator_compat_props(GPtrArray *compat_props)
473 assert(!object_compat_props[0]);
474 object_compat_props[0] = compat_props;
477 void object_apply_compat_props(Object *obj)
479 int i;
481 for (i = 0; i < ARRAY_SIZE(object_compat_props); i++) {
482 object_apply_global_props(obj, object_compat_props[i],
483 i == 2 ? &error_fatal : &error_abort);
487 static void object_class_property_init_all(Object *obj)
489 ObjectPropertyIterator iter;
490 ObjectProperty *prop;
492 object_class_property_iter_init(&iter, object_get_class(obj));
493 while ((prop = object_property_iter_next(&iter))) {
494 if (prop->init) {
495 prop->init(obj, prop);
500 static void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
502 Object *obj = data;
504 type_initialize(type);
506 g_assert(type->instance_size >= sizeof(Object));
507 g_assert(type->abstract == false);
508 g_assert(size >= type->instance_size);
510 memset(obj, 0, type->instance_size);
511 obj->class = type->class;
512 object_ref(obj);
513 object_class_property_init_all(obj);
514 obj->properties = g_hash_table_new_full(g_str_hash, g_str_equal,
515 NULL, object_property_free);
516 object_init_with_type(obj, type);
517 object_post_init_with_type(obj, type);
520 void object_initialize(void *data, size_t size, const char *typename)
522 TypeImpl *type = type_get_by_name(typename);
524 if (!type) {
525 error_report("missing object type '%s'", typename);
526 abort();
529 object_initialize_with_type(data, size, type);
532 void object_initialize_child(Object *parentobj, const char *propname,
533 void *childobj, size_t size, const char *type,
534 Error **errp, ...)
536 va_list vargs;
538 va_start(vargs, errp);
539 object_initialize_childv(parentobj, propname, childobj, size, type, errp,
540 vargs);
541 va_end(vargs);
544 void object_initialize_childv(Object *parentobj, const char *propname,
545 void *childobj, size_t size, const char *type,
546 Error **errp, va_list vargs)
548 Error *local_err = NULL;
549 Object *obj;
550 UserCreatable *uc;
552 object_initialize(childobj, size, type);
553 obj = OBJECT(childobj);
555 object_set_propv(obj, &local_err, vargs);
556 if (local_err) {
557 goto out;
560 object_property_add_child(parentobj, propname, obj, &local_err);
561 if (local_err) {
562 goto out;
565 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
566 if (uc) {
567 user_creatable_complete(uc, &local_err);
568 if (local_err) {
569 object_unparent(obj);
570 goto out;
575 * Since object_property_add_child added a reference to the child object,
576 * we can drop the reference added by object_initialize(), so the child
577 * property will own the only reference to the object.
579 object_unref(obj);
581 out:
582 if (local_err) {
583 error_propagate(errp, local_err);
584 object_unref(obj);
588 static inline bool object_property_is_child(ObjectProperty *prop)
590 return strstart(prop->type, "child<", NULL);
593 static void object_property_del_all(Object *obj)
595 g_autoptr(GHashTable) done = g_hash_table_new(NULL, NULL);
596 ObjectProperty *prop;
597 ObjectPropertyIterator iter;
598 bool released;
600 do {
601 released = false;
602 object_property_iter_init(&iter, obj);
603 while ((prop = object_property_iter_next(&iter)) != NULL) {
604 if (g_hash_table_add(done, prop)) {
605 if (prop->release) {
606 prop->release(obj, prop->name, prop->opaque);
607 released = true;
608 break;
612 } while (released);
614 g_hash_table_unref(obj->properties);
617 static void object_property_del_child(Object *obj, Object *child, Error **errp)
619 ObjectProperty *prop;
620 GHashTableIter iter;
621 gpointer key, value;
623 g_hash_table_iter_init(&iter, obj->properties);
624 while (g_hash_table_iter_next(&iter, &key, &value)) {
625 prop = value;
626 if (object_property_is_child(prop) && prop->opaque == child) {
627 if (prop->release) {
628 prop->release(obj, prop->name, prop->opaque);
629 prop->release = NULL;
631 break;
634 g_hash_table_iter_init(&iter, obj->properties);
635 while (g_hash_table_iter_next(&iter, &key, &value)) {
636 prop = value;
637 if (object_property_is_child(prop) && prop->opaque == child) {
638 g_hash_table_iter_remove(&iter);
639 break;
644 void object_unparent(Object *obj)
646 if (obj->parent) {
647 object_property_del_child(obj->parent, obj, NULL);
651 static void object_deinit(Object *obj, TypeImpl *type)
653 if (type->instance_finalize) {
654 type->instance_finalize(obj);
657 if (type_has_parent(type)) {
658 object_deinit(obj, type_get_parent(type));
662 static void object_finalize(void *data)
664 Object *obj = data;
665 TypeImpl *ti = obj->class->type;
667 object_property_del_all(obj);
668 object_deinit(obj, ti);
670 g_assert(obj->ref == 0);
671 if (obj->free) {
672 obj->free(obj);
676 static Object *object_new_with_type(Type type)
678 Object *obj;
680 g_assert(type != NULL);
681 type_initialize(type);
683 obj = g_malloc(type->instance_size);
684 object_initialize_with_type(obj, type->instance_size, type);
685 obj->free = g_free;
687 return obj;
690 Object *object_new_with_class(ObjectClass *klass)
692 return object_new_with_type(klass->type);
695 Object *object_new(const char *typename)
697 TypeImpl *ti = type_get_by_name(typename);
699 return object_new_with_type(ti);
703 Object *object_new_with_props(const char *typename,
704 Object *parent,
705 const char *id,
706 Error **errp,
707 ...)
709 va_list vargs;
710 Object *obj;
712 va_start(vargs, errp);
713 obj = object_new_with_propv(typename, parent, id, errp, vargs);
714 va_end(vargs);
716 return obj;
720 Object *object_new_with_propv(const char *typename,
721 Object *parent,
722 const char *id,
723 Error **errp,
724 va_list vargs)
726 Object *obj;
727 ObjectClass *klass;
728 Error *local_err = NULL;
729 UserCreatable *uc;
731 klass = object_class_by_name(typename);
732 if (!klass) {
733 error_setg(errp, "invalid object type: %s", typename);
734 return NULL;
737 if (object_class_is_abstract(klass)) {
738 error_setg(errp, "object type '%s' is abstract", typename);
739 return NULL;
741 obj = object_new_with_type(klass->type);
743 if (object_set_propv(obj, &local_err, vargs) < 0) {
744 goto error;
747 if (id != NULL) {
748 object_property_add_child(parent, id, obj, &local_err);
749 if (local_err) {
750 goto error;
754 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
755 if (uc) {
756 user_creatable_complete(uc, &local_err);
757 if (local_err) {
758 if (id != NULL) {
759 object_unparent(obj);
761 goto error;
765 object_unref(OBJECT(obj));
766 return obj;
768 error:
769 error_propagate(errp, local_err);
770 object_unref(obj);
771 return NULL;
775 int object_set_props(Object *obj,
776 Error **errp,
777 ...)
779 va_list vargs;
780 int ret;
782 va_start(vargs, errp);
783 ret = object_set_propv(obj, errp, vargs);
784 va_end(vargs);
786 return ret;
790 int object_set_propv(Object *obj,
791 Error **errp,
792 va_list vargs)
794 const char *propname;
795 Error *local_err = NULL;
797 propname = va_arg(vargs, char *);
798 while (propname != NULL) {
799 const char *value = va_arg(vargs, char *);
801 g_assert(value != NULL);
802 object_property_parse(obj, value, propname, &local_err);
803 if (local_err) {
804 error_propagate(errp, local_err);
805 return -1;
807 propname = va_arg(vargs, char *);
810 return 0;
814 Object *object_dynamic_cast(Object *obj, const char *typename)
816 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
817 return obj;
820 return NULL;
823 Object *object_dynamic_cast_assert(Object *obj, const char *typename,
824 const char *file, int line, const char *func)
826 trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
827 typename, file, line, func);
829 #ifdef CONFIG_QOM_CAST_DEBUG
830 int i;
831 Object *inst;
833 for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
834 if (atomic_read(&obj->class->object_cast_cache[i]) == typename) {
835 goto out;
839 inst = object_dynamic_cast(obj, typename);
841 if (!inst && obj) {
842 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
843 file, line, func, obj, typename);
844 abort();
847 assert(obj == inst);
849 if (obj && obj == inst) {
850 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
851 atomic_set(&obj->class->object_cast_cache[i - 1],
852 atomic_read(&obj->class->object_cast_cache[i]));
854 atomic_set(&obj->class->object_cast_cache[i - 1], typename);
857 out:
858 #endif
859 return obj;
862 ObjectClass *object_class_dynamic_cast(ObjectClass *class,
863 const char *typename)
865 ObjectClass *ret = NULL;
866 TypeImpl *target_type;
867 TypeImpl *type;
869 if (!class) {
870 return NULL;
873 /* A simple fast path that can trigger a lot for leaf classes. */
874 type = class->type;
875 if (type->name == typename) {
876 return class;
879 target_type = type_get_by_name(typename);
880 if (!target_type) {
881 /* target class type unknown, so fail the cast */
882 return NULL;
885 if (type->class->interfaces &&
886 type_is_ancestor(target_type, type_interface)) {
887 int found = 0;
888 GSList *i;
890 for (i = class->interfaces; i; i = i->next) {
891 ObjectClass *target_class = i->data;
893 if (type_is_ancestor(target_class->type, target_type)) {
894 ret = target_class;
895 found++;
899 /* The match was ambiguous, don't allow a cast */
900 if (found > 1) {
901 ret = NULL;
903 } else if (type_is_ancestor(type, target_type)) {
904 ret = class;
907 return ret;
910 ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
911 const char *typename,
912 const char *file, int line,
913 const char *func)
915 ObjectClass *ret;
917 trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)",
918 typename, file, line, func);
920 #ifdef CONFIG_QOM_CAST_DEBUG
921 int i;
923 for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
924 if (atomic_read(&class->class_cast_cache[i]) == typename) {
925 ret = class;
926 goto out;
929 #else
930 if (!class || !class->interfaces) {
931 return class;
933 #endif
935 ret = object_class_dynamic_cast(class, typename);
936 if (!ret && class) {
937 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
938 file, line, func, class, typename);
939 abort();
942 #ifdef CONFIG_QOM_CAST_DEBUG
943 if (class && ret == class) {
944 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
945 atomic_set(&class->class_cast_cache[i - 1],
946 atomic_read(&class->class_cast_cache[i]));
948 atomic_set(&class->class_cast_cache[i - 1], typename);
950 out:
951 #endif
952 return ret;
955 const char *object_get_typename(const Object *obj)
957 return obj->class->type->name;
960 ObjectClass *object_get_class(Object *obj)
962 return obj->class;
965 bool object_class_is_abstract(ObjectClass *klass)
967 return klass->type->abstract;
970 const char *object_class_get_name(ObjectClass *klass)
972 return klass->type->name;
975 ObjectClass *object_class_by_name(const char *typename)
977 TypeImpl *type = type_get_by_name(typename);
979 if (!type) {
980 return NULL;
983 type_initialize(type);
985 return type->class;
988 ObjectClass *object_class_get_parent(ObjectClass *class)
990 TypeImpl *type = type_get_parent(class->type);
992 if (!type) {
993 return NULL;
996 type_initialize(type);
998 return type->class;
1001 typedef struct OCFData
1003 void (*fn)(ObjectClass *klass, void *opaque);
1004 const char *implements_type;
1005 bool include_abstract;
1006 void *opaque;
1007 } OCFData;
1009 static void object_class_foreach_tramp(gpointer key, gpointer value,
1010 gpointer opaque)
1012 OCFData *data = opaque;
1013 TypeImpl *type = value;
1014 ObjectClass *k;
1016 type_initialize(type);
1017 k = type->class;
1019 if (!data->include_abstract && type->abstract) {
1020 return;
1023 if (data->implements_type &&
1024 !object_class_dynamic_cast(k, data->implements_type)) {
1025 return;
1028 data->fn(k, data->opaque);
1031 void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
1032 const char *implements_type, bool include_abstract,
1033 void *opaque)
1035 OCFData data = { fn, implements_type, include_abstract, opaque };
1037 enumerating_types = true;
1038 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
1039 enumerating_types = false;
1042 static int do_object_child_foreach(Object *obj,
1043 int (*fn)(Object *child, void *opaque),
1044 void *opaque, bool recurse)
1046 GHashTableIter iter;
1047 ObjectProperty *prop;
1048 int ret = 0;
1050 g_hash_table_iter_init(&iter, obj->properties);
1051 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
1052 if (object_property_is_child(prop)) {
1053 Object *child = prop->opaque;
1055 ret = fn(child, opaque);
1056 if (ret != 0) {
1057 break;
1059 if (recurse) {
1060 do_object_child_foreach(child, fn, opaque, true);
1064 return ret;
1067 int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
1068 void *opaque)
1070 return do_object_child_foreach(obj, fn, opaque, false);
1073 int object_child_foreach_recursive(Object *obj,
1074 int (*fn)(Object *child, void *opaque),
1075 void *opaque)
1077 return do_object_child_foreach(obj, fn, opaque, true);
1080 static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
1082 GSList **list = opaque;
1084 *list = g_slist_prepend(*list, klass);
1087 GSList *object_class_get_list(const char *implements_type,
1088 bool include_abstract)
1090 GSList *list = NULL;
1092 object_class_foreach(object_class_get_list_tramp,
1093 implements_type, include_abstract, &list);
1094 return list;
1097 static gint object_class_cmp(gconstpointer a, gconstpointer b)
1099 return strcasecmp(object_class_get_name((ObjectClass *)a),
1100 object_class_get_name((ObjectClass *)b));
1103 GSList *object_class_get_list_sorted(const char *implements_type,
1104 bool include_abstract)
1106 return g_slist_sort(object_class_get_list(implements_type, include_abstract),
1107 object_class_cmp);
1110 void object_ref(Object *obj)
1112 if (!obj) {
1113 return;
1115 atomic_inc(&obj->ref);
1118 void object_unref(Object *obj)
1120 if (!obj) {
1121 return;
1123 g_assert(obj->ref > 0);
1125 /* parent always holds a reference to its children */
1126 if (atomic_fetch_dec(&obj->ref) == 1) {
1127 object_finalize(obj);
1131 ObjectProperty *
1132 object_property_add(Object *obj, const char *name, const char *type,
1133 ObjectPropertyAccessor *get,
1134 ObjectPropertyAccessor *set,
1135 ObjectPropertyRelease *release,
1136 void *opaque, Error **errp)
1138 ObjectProperty *prop;
1139 size_t name_len = strlen(name);
1141 if (name_len >= 3 && !memcmp(name + name_len - 3, "[*]", 4)) {
1142 int i;
1143 ObjectProperty *ret;
1144 char *name_no_array = g_strdup(name);
1146 name_no_array[name_len - 3] = '\0';
1147 for (i = 0; ; ++i) {
1148 char *full_name = g_strdup_printf("%s[%d]", name_no_array, i);
1150 ret = object_property_add(obj, full_name, type, get, set,
1151 release, opaque, NULL);
1152 g_free(full_name);
1153 if (ret) {
1154 break;
1157 g_free(name_no_array);
1158 return ret;
1161 if (object_property_find(obj, name, NULL) != NULL) {
1162 error_setg(errp, "attempt to add duplicate property '%s' to object (type '%s')",
1163 name, object_get_typename(obj));
1164 return NULL;
1167 prop = g_malloc0(sizeof(*prop));
1169 prop->name = g_strdup(name);
1170 prop->type = g_strdup(type);
1172 prop->get = get;
1173 prop->set = set;
1174 prop->release = release;
1175 prop->opaque = opaque;
1177 g_hash_table_insert(obj->properties, prop->name, prop);
1178 return prop;
1181 ObjectProperty *
1182 object_class_property_add(ObjectClass *klass,
1183 const char *name,
1184 const char *type,
1185 ObjectPropertyAccessor *get,
1186 ObjectPropertyAccessor *set,
1187 ObjectPropertyRelease *release,
1188 void *opaque,
1189 Error **errp)
1191 ObjectProperty *prop;
1193 if (object_class_property_find(klass, name, NULL) != NULL) {
1194 error_setg(errp, "attempt to add duplicate property '%s' to class (type '%s')",
1195 name, object_class_get_name(klass));
1196 return NULL;
1199 prop = g_malloc0(sizeof(*prop));
1201 prop->name = g_strdup(name);
1202 prop->type = g_strdup(type);
1204 prop->get = get;
1205 prop->set = set;
1206 prop->release = release;
1207 prop->opaque = opaque;
1209 g_hash_table_insert(klass->properties, prop->name, prop);
1211 return prop;
1214 ObjectProperty *object_property_find(Object *obj, const char *name,
1215 Error **errp)
1217 ObjectProperty *prop;
1218 ObjectClass *klass = object_get_class(obj);
1220 prop = object_class_property_find(klass, name, NULL);
1221 if (prop) {
1222 return prop;
1225 prop = g_hash_table_lookup(obj->properties, name);
1226 if (prop) {
1227 return prop;
1230 error_setg(errp, "Property '.%s' not found", name);
1231 return NULL;
1234 void object_property_iter_init(ObjectPropertyIterator *iter,
1235 Object *obj)
1237 g_hash_table_iter_init(&iter->iter, obj->properties);
1238 iter->nextclass = object_get_class(obj);
1241 ObjectProperty *object_property_iter_next(ObjectPropertyIterator *iter)
1243 gpointer key, val;
1244 while (!g_hash_table_iter_next(&iter->iter, &key, &val)) {
1245 if (!iter->nextclass) {
1246 return NULL;
1248 g_hash_table_iter_init(&iter->iter, iter->nextclass->properties);
1249 iter->nextclass = object_class_get_parent(iter->nextclass);
1251 return val;
1254 void object_class_property_iter_init(ObjectPropertyIterator *iter,
1255 ObjectClass *klass)
1257 g_hash_table_iter_init(&iter->iter, klass->properties);
1258 iter->nextclass = object_class_get_parent(klass);
1261 ObjectProperty *object_class_property_find(ObjectClass *klass, const char *name,
1262 Error **errp)
1264 ObjectProperty *prop;
1265 ObjectClass *parent_klass;
1267 parent_klass = object_class_get_parent(klass);
1268 if (parent_klass) {
1269 prop = object_class_property_find(parent_klass, name, NULL);
1270 if (prop) {
1271 return prop;
1275 prop = g_hash_table_lookup(klass->properties, name);
1276 if (!prop) {
1277 error_setg(errp, "Property '.%s' not found", name);
1279 return prop;
1282 void object_property_del(Object *obj, const char *name, Error **errp)
1284 ObjectProperty *prop = g_hash_table_lookup(obj->properties, name);
1286 if (!prop) {
1287 error_setg(errp, "Property '.%s' not found", name);
1288 return;
1291 if (prop->release) {
1292 prop->release(obj, name, prop->opaque);
1294 g_hash_table_remove(obj->properties, name);
1297 void object_property_get(Object *obj, Visitor *v, const char *name,
1298 Error **errp)
1300 ObjectProperty *prop = object_property_find(obj, name, errp);
1301 if (prop == NULL) {
1302 return;
1305 if (!prop->get) {
1306 error_setg(errp, QERR_PERMISSION_DENIED);
1307 } else {
1308 prop->get(obj, v, name, prop->opaque, errp);
1312 void object_property_set(Object *obj, Visitor *v, const char *name,
1313 Error **errp)
1315 ObjectProperty *prop = object_property_find(obj, name, errp);
1316 if (prop == NULL) {
1317 return;
1320 if (!prop->set) {
1321 error_setg(errp, QERR_PERMISSION_DENIED);
1322 } else {
1323 prop->set(obj, v, name, prop->opaque, errp);
1327 void object_property_set_str(Object *obj, const char *value,
1328 const char *name, Error **errp)
1330 QString *qstr = qstring_from_str(value);
1331 object_property_set_qobject(obj, QOBJECT(qstr), name, errp);
1333 qobject_unref(qstr);
1336 char *object_property_get_str(Object *obj, const char *name,
1337 Error **errp)
1339 QObject *ret = object_property_get_qobject(obj, name, errp);
1340 char *retval;
1342 if (!ret) {
1343 return NULL;
1346 retval = g_strdup(qobject_get_try_str(ret));
1347 if (!retval) {
1348 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
1351 qobject_unref(ret);
1352 return retval;
1355 void object_property_set_link(Object *obj, Object *value,
1356 const char *name, Error **errp)
1358 if (value) {
1359 gchar *path = object_get_canonical_path(value);
1360 object_property_set_str(obj, path, name, errp);
1361 g_free(path);
1362 } else {
1363 object_property_set_str(obj, "", name, errp);
1367 Object *object_property_get_link(Object *obj, const char *name,
1368 Error **errp)
1370 char *str = object_property_get_str(obj, name, errp);
1371 Object *target = NULL;
1373 if (str && *str) {
1374 target = object_resolve_path(str, NULL);
1375 if (!target) {
1376 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1377 "Device '%s' not found", str);
1381 g_free(str);
1382 return target;
1385 void object_property_set_bool(Object *obj, bool value,
1386 const char *name, Error **errp)
1388 QBool *qbool = qbool_from_bool(value);
1389 object_property_set_qobject(obj, QOBJECT(qbool), name, errp);
1391 qobject_unref(qbool);
1394 bool object_property_get_bool(Object *obj, const char *name,
1395 Error **errp)
1397 QObject *ret = object_property_get_qobject(obj, name, errp);
1398 QBool *qbool;
1399 bool retval;
1401 if (!ret) {
1402 return false;
1404 qbool = qobject_to(QBool, ret);
1405 if (!qbool) {
1406 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
1407 retval = false;
1408 } else {
1409 retval = qbool_get_bool(qbool);
1412 qobject_unref(ret);
1413 return retval;
1416 void object_property_set_int(Object *obj, int64_t value,
1417 const char *name, Error **errp)
1419 QNum *qnum = qnum_from_int(value);
1420 object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
1422 qobject_unref(qnum);
1425 int64_t object_property_get_int(Object *obj, const char *name,
1426 Error **errp)
1428 QObject *ret = object_property_get_qobject(obj, name, errp);
1429 QNum *qnum;
1430 int64_t retval;
1432 if (!ret) {
1433 return -1;
1436 qnum = qobject_to(QNum, ret);
1437 if (!qnum || !qnum_get_try_int(qnum, &retval)) {
1438 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
1439 retval = -1;
1442 qobject_unref(ret);
1443 return retval;
1446 static void object_property_init_defval(Object *obj, ObjectProperty *prop)
1448 Visitor *v = qobject_input_visitor_new(prop->defval);
1450 assert(prop->set != NULL);
1451 prop->set(obj, v, prop->name, prop->opaque, &error_abort);
1453 visit_free(v);
1456 static void object_property_set_default(ObjectProperty *prop, QObject *defval)
1458 assert(!prop->defval);
1459 assert(!prop->init);
1461 prop->defval = defval;
1462 prop->init = object_property_init_defval;
1465 void object_property_set_default_bool(ObjectProperty *prop, bool value)
1467 object_property_set_default(prop, QOBJECT(qbool_from_bool(value)));
1470 void object_property_set_default_str(ObjectProperty *prop, const char *value)
1472 object_property_set_default(prop, QOBJECT(qstring_from_str(value)));
1475 void object_property_set_default_int(ObjectProperty *prop, int64_t value)
1477 object_property_set_default(prop, QOBJECT(qnum_from_int(value)));
1480 void object_property_set_default_uint(ObjectProperty *prop, uint64_t value)
1482 object_property_set_default(prop, QOBJECT(qnum_from_uint(value)));
1485 void object_property_set_uint(Object *obj, uint64_t value,
1486 const char *name, Error **errp)
1488 QNum *qnum = qnum_from_uint(value);
1490 object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
1491 qobject_unref(qnum);
1494 uint64_t object_property_get_uint(Object *obj, const char *name,
1495 Error **errp)
1497 QObject *ret = object_property_get_qobject(obj, name, errp);
1498 QNum *qnum;
1499 uint64_t retval;
1501 if (!ret) {
1502 return 0;
1504 qnum = qobject_to(QNum, ret);
1505 if (!qnum || !qnum_get_try_uint(qnum, &retval)) {
1506 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "uint");
1507 retval = 0;
1510 qobject_unref(ret);
1511 return retval;
1514 typedef struct EnumProperty {
1515 const QEnumLookup *lookup;
1516 int (*get)(Object *, Error **);
1517 void (*set)(Object *, int, Error **);
1518 } EnumProperty;
1520 int object_property_get_enum(Object *obj, const char *name,
1521 const char *typename, Error **errp)
1523 Error *err = NULL;
1524 Visitor *v;
1525 char *str;
1526 int ret;
1527 ObjectProperty *prop = object_property_find(obj, name, errp);
1528 EnumProperty *enumprop;
1530 if (prop == NULL) {
1531 return 0;
1534 if (!g_str_equal(prop->type, typename)) {
1535 error_setg(errp, "Property %s on %s is not '%s' enum type",
1536 name, object_class_get_name(
1537 object_get_class(obj)), typename);
1538 return 0;
1541 enumprop = prop->opaque;
1543 v = string_output_visitor_new(false, &str);
1544 object_property_get(obj, v, name, &err);
1545 if (err) {
1546 error_propagate(errp, err);
1547 visit_free(v);
1548 return 0;
1550 visit_complete(v, &str);
1551 visit_free(v);
1552 v = string_input_visitor_new(str);
1553 visit_type_enum(v, name, &ret, enumprop->lookup, errp);
1555 g_free(str);
1556 visit_free(v);
1558 return ret;
1561 void object_property_get_uint16List(Object *obj, const char *name,
1562 uint16List **list, Error **errp)
1564 Error *err = NULL;
1565 Visitor *v;
1566 char *str;
1568 v = string_output_visitor_new(false, &str);
1569 object_property_get(obj, v, name, &err);
1570 if (err) {
1571 error_propagate(errp, err);
1572 goto out;
1574 visit_complete(v, &str);
1575 visit_free(v);
1576 v = string_input_visitor_new(str);
1577 visit_type_uint16List(v, NULL, list, errp);
1579 g_free(str);
1580 out:
1581 visit_free(v);
1584 void object_property_parse(Object *obj, const char *string,
1585 const char *name, Error **errp)
1587 Visitor *v = string_input_visitor_new(string);
1588 object_property_set(obj, v, name, errp);
1589 visit_free(v);
1592 char *object_property_print(Object *obj, const char *name, bool human,
1593 Error **errp)
1595 Visitor *v;
1596 char *string = NULL;
1597 Error *local_err = NULL;
1599 v = string_output_visitor_new(human, &string);
1600 object_property_get(obj, v, name, &local_err);
1601 if (local_err) {
1602 error_propagate(errp, local_err);
1603 goto out;
1606 visit_complete(v, &string);
1608 out:
1609 visit_free(v);
1610 return string;
1613 const char *object_property_get_type(Object *obj, const char *name, Error **errp)
1615 ObjectProperty *prop = object_property_find(obj, name, errp);
1616 if (prop == NULL) {
1617 return NULL;
1620 return prop->type;
1623 Object *object_get_root(void)
1625 static Object *root;
1627 if (!root) {
1628 root = object_new("container");
1631 return root;
1634 Object *object_get_objects_root(void)
1636 return container_get(object_get_root(), "/objects");
1639 Object *object_get_internal_root(void)
1641 static Object *internal_root;
1643 if (!internal_root) {
1644 internal_root = object_new("container");
1647 return internal_root;
1650 static void object_get_child_property(Object *obj, Visitor *v,
1651 const char *name, void *opaque,
1652 Error **errp)
1654 Object *child = opaque;
1655 gchar *path;
1657 path = object_get_canonical_path(child);
1658 visit_type_str(v, name, &path, errp);
1659 g_free(path);
1662 static Object *object_resolve_child_property(Object *parent, void *opaque, const gchar *part)
1664 return opaque;
1667 static void object_finalize_child_property(Object *obj, const char *name,
1668 void *opaque)
1670 Object *child = opaque;
1672 if (child->class->unparent) {
1673 (child->class->unparent)(child);
1675 child->parent = NULL;
1676 object_unref(child);
1679 void object_property_add_child(Object *obj, const char *name,
1680 Object *child, Error **errp)
1682 Error *local_err = NULL;
1683 gchar *type;
1684 ObjectProperty *op;
1686 if (child->parent != NULL) {
1687 error_setg(errp, "child object is already parented");
1688 return;
1691 type = g_strdup_printf("child<%s>", object_get_typename(OBJECT(child)));
1693 op = object_property_add(obj, name, type, object_get_child_property, NULL,
1694 object_finalize_child_property, child, &local_err);
1695 if (local_err) {
1696 error_propagate(errp, local_err);
1697 goto out;
1700 op->resolve = object_resolve_child_property;
1701 object_ref(child);
1702 child->parent = obj;
1704 out:
1705 g_free(type);
1708 void object_property_allow_set_link(const Object *obj, const char *name,
1709 Object *val, Error **errp)
1711 /* Allow the link to be set, always */
1714 typedef struct {
1715 union {
1716 Object **targetp;
1717 Object *target; /* if OBJ_PROP_LINK_DIRECT, when holding the pointer */
1718 ptrdiff_t offset; /* if OBJ_PROP_LINK_CLASS */
1720 void (*check)(const Object *, const char *, Object *, Error **);
1721 ObjectPropertyLinkFlags flags;
1722 } LinkProperty;
1724 static Object **
1725 object_link_get_targetp(Object *obj, LinkProperty *lprop)
1727 if (lprop->flags & OBJ_PROP_LINK_DIRECT) {
1728 return &lprop->target;
1729 } else if (lprop->flags & OBJ_PROP_LINK_CLASS) {
1730 return (void *)obj + lprop->offset;
1731 } else {
1732 return lprop->targetp;
1736 static void object_get_link_property(Object *obj, Visitor *v,
1737 const char *name, void *opaque,
1738 Error **errp)
1740 LinkProperty *lprop = opaque;
1741 Object **targetp = object_link_get_targetp(obj, lprop);
1742 gchar *path;
1744 if (*targetp) {
1745 path = object_get_canonical_path(*targetp);
1746 visit_type_str(v, name, &path, errp);
1747 g_free(path);
1748 } else {
1749 path = (gchar *)"";
1750 visit_type_str(v, name, &path, errp);
1755 * object_resolve_link:
1757 * Lookup an object and ensure its type matches the link property type. This
1758 * is similar to object_resolve_path() except type verification against the
1759 * link property is performed.
1761 * Returns: The matched object or NULL on path lookup failures.
1763 static Object *object_resolve_link(Object *obj, const char *name,
1764 const char *path, Error **errp)
1766 const char *type;
1767 gchar *target_type;
1768 bool ambiguous = false;
1769 Object *target;
1771 /* Go from link<FOO> to FOO. */
1772 type = object_property_get_type(obj, name, NULL);
1773 target_type = g_strndup(&type[5], strlen(type) - 6);
1774 target = object_resolve_path_type(path, target_type, &ambiguous);
1776 if (ambiguous) {
1777 error_setg(errp, "Path '%s' does not uniquely identify an object",
1778 path);
1779 } else if (!target) {
1780 target = object_resolve_path(path, &ambiguous);
1781 if (target || ambiguous) {
1782 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
1783 } else {
1784 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1785 "Device '%s' not found", path);
1787 target = NULL;
1789 g_free(target_type);
1791 return target;
1794 static void object_set_link_property(Object *obj, Visitor *v,
1795 const char *name, void *opaque,
1796 Error **errp)
1798 Error *local_err = NULL;
1799 LinkProperty *prop = opaque;
1800 Object **targetp = object_link_get_targetp(obj, prop);
1801 Object *old_target = *targetp;
1802 Object *new_target = NULL;
1803 char *path = NULL;
1805 visit_type_str(v, name, &path, &local_err);
1807 if (!local_err && strcmp(path, "") != 0) {
1808 new_target = object_resolve_link(obj, name, path, &local_err);
1811 g_free(path);
1812 if (local_err) {
1813 error_propagate(errp, local_err);
1814 return;
1817 prop->check(obj, name, new_target, &local_err);
1818 if (local_err) {
1819 error_propagate(errp, local_err);
1820 return;
1823 *targetp = new_target;
1824 if (prop->flags & OBJ_PROP_LINK_STRONG) {
1825 object_ref(new_target);
1826 object_unref(old_target);
1830 static Object *object_resolve_link_property(Object *parent, void *opaque, const gchar *part)
1832 LinkProperty *lprop = opaque;
1834 return *object_link_get_targetp(parent, lprop);
1837 static void object_release_link_property(Object *obj, const char *name,
1838 void *opaque)
1840 LinkProperty *prop = opaque;
1841 Object **targetp = object_link_get_targetp(obj, prop);
1843 if ((prop->flags & OBJ_PROP_LINK_STRONG) && *targetp) {
1844 object_unref(*targetp);
1846 if (!(prop->flags & OBJ_PROP_LINK_CLASS)) {
1847 g_free(prop);
1851 static void object_add_link_prop(Object *obj, const char *name,
1852 const char *type, void *ptr,
1853 void (*check)(const Object *, const char *,
1854 Object *, Error **),
1855 ObjectPropertyLinkFlags flags,
1856 Error **errp)
1858 Error *local_err = NULL;
1859 LinkProperty *prop = g_malloc(sizeof(*prop));
1860 gchar *full_type;
1861 ObjectProperty *op;
1863 if (flags & OBJ_PROP_LINK_DIRECT) {
1864 prop->target = ptr;
1865 } else {
1866 prop->targetp = ptr;
1868 prop->check = check;
1869 prop->flags = flags;
1871 full_type = g_strdup_printf("link<%s>", type);
1873 op = object_property_add(obj, name, full_type,
1874 object_get_link_property,
1875 check ? object_set_link_property : NULL,
1876 object_release_link_property,
1877 prop,
1878 &local_err);
1879 if (local_err) {
1880 error_propagate(errp, local_err);
1881 g_free(prop);
1882 goto out;
1885 op->resolve = object_resolve_link_property;
1887 out:
1888 g_free(full_type);
1891 void object_property_add_link(Object *obj, const char *name,
1892 const char *type, Object **targetp,
1893 void (*check)(const Object *, const char *,
1894 Object *, Error **),
1895 ObjectPropertyLinkFlags flags,
1896 Error **errp)
1898 object_add_link_prop(obj, name, type, targetp, check, flags, errp);
1901 ObjectProperty *
1902 object_class_property_add_link(ObjectClass *oc,
1903 const char *name,
1904 const char *type, ptrdiff_t offset,
1905 void (*check)(const Object *obj, const char *name,
1906 Object *val, Error **errp),
1907 ObjectPropertyLinkFlags flags,
1908 Error **errp)
1910 Error *local_err = NULL;
1911 LinkProperty *prop = g_new0(LinkProperty, 1);
1912 gchar *full_type;
1913 ObjectProperty *op;
1915 prop->offset = offset;
1916 prop->check = check;
1917 prop->flags = flags | OBJ_PROP_LINK_CLASS;
1919 full_type = g_strdup_printf("link<%s>", type);
1921 op = object_class_property_add(oc, name, full_type,
1922 object_get_link_property,
1923 check ? object_set_link_property : NULL,
1924 object_release_link_property,
1925 prop,
1926 &local_err);
1927 if (local_err) {
1928 error_propagate(errp, local_err);
1929 g_free(prop);
1930 goto out;
1933 op->resolve = object_resolve_link_property;
1935 out:
1936 g_free(full_type);
1937 return op;
1940 void object_property_add_const_link(Object *obj, const char *name,
1941 Object *target, Error **errp)
1943 object_add_link_prop(obj, name, object_get_typename(target), target,
1944 NULL, OBJ_PROP_LINK_DIRECT, errp);
1947 gchar *object_get_canonical_path_component(Object *obj)
1949 ObjectProperty *prop = NULL;
1950 GHashTableIter iter;
1952 if (obj->parent == NULL) {
1953 return NULL;
1956 g_hash_table_iter_init(&iter, obj->parent->properties);
1957 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
1958 if (!object_property_is_child(prop)) {
1959 continue;
1962 if (prop->opaque == obj) {
1963 return g_strdup(prop->name);
1967 /* obj had a parent but was not a child, should never happen */
1968 g_assert_not_reached();
1969 return NULL;
1972 gchar *object_get_canonical_path(Object *obj)
1974 Object *root = object_get_root();
1975 char *newpath, *path = NULL;
1977 if (obj == root) {
1978 return g_strdup("/");
1981 do {
1982 char *component = object_get_canonical_path_component(obj);
1984 if (!component) {
1985 /* A canonical path must be complete, so discard what was
1986 * collected so far.
1988 g_free(path);
1989 return NULL;
1992 newpath = g_strdup_printf("/%s%s", component, path ? path : "");
1993 g_free(path);
1994 g_free(component);
1995 path = newpath;
1996 obj = obj->parent;
1997 } while (obj != root);
1999 return path;
2002 Object *object_resolve_path_component(Object *parent, const gchar *part)
2004 ObjectProperty *prop = object_property_find(parent, part, NULL);
2005 if (prop == NULL) {
2006 return NULL;
2009 if (prop->resolve) {
2010 return prop->resolve(parent, prop->opaque, part);
2011 } else {
2012 return NULL;
2016 static Object *object_resolve_abs_path(Object *parent,
2017 gchar **parts,
2018 const char *typename,
2019 int index)
2021 Object *child;
2023 if (parts[index] == NULL) {
2024 return object_dynamic_cast(parent, typename);
2027 if (strcmp(parts[index], "") == 0) {
2028 return object_resolve_abs_path(parent, parts, typename, index + 1);
2031 child = object_resolve_path_component(parent, parts[index]);
2032 if (!child) {
2033 return NULL;
2036 return object_resolve_abs_path(child, parts, typename, index + 1);
2039 static Object *object_resolve_partial_path(Object *parent,
2040 gchar **parts,
2041 const char *typename,
2042 bool *ambiguous)
2044 Object *obj;
2045 GHashTableIter iter;
2046 ObjectProperty *prop;
2048 obj = object_resolve_abs_path(parent, parts, typename, 0);
2050 g_hash_table_iter_init(&iter, parent->properties);
2051 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
2052 Object *found;
2054 if (!object_property_is_child(prop)) {
2055 continue;
2058 found = object_resolve_partial_path(prop->opaque, parts,
2059 typename, ambiguous);
2060 if (found) {
2061 if (obj) {
2062 *ambiguous = true;
2063 return NULL;
2065 obj = found;
2068 if (*ambiguous) {
2069 return NULL;
2073 return obj;
2076 Object *object_resolve_path_type(const char *path, const char *typename,
2077 bool *ambiguousp)
2079 Object *obj;
2080 gchar **parts;
2082 parts = g_strsplit(path, "/", 0);
2083 assert(parts);
2085 if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
2086 bool ambiguous = false;
2087 obj = object_resolve_partial_path(object_get_root(), parts,
2088 typename, &ambiguous);
2089 if (ambiguousp) {
2090 *ambiguousp = ambiguous;
2092 } else {
2093 obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
2096 g_strfreev(parts);
2098 return obj;
2101 Object *object_resolve_path(const char *path, bool *ambiguous)
2103 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
2106 typedef struct StringProperty
2108 char *(*get)(Object *, Error **);
2109 void (*set)(Object *, const char *, Error **);
2110 } StringProperty;
2112 static void property_get_str(Object *obj, Visitor *v, const char *name,
2113 void *opaque, Error **errp)
2115 StringProperty *prop = opaque;
2116 char *value;
2117 Error *err = NULL;
2119 value = prop->get(obj, &err);
2120 if (err) {
2121 error_propagate(errp, err);
2122 return;
2125 visit_type_str(v, name, &value, errp);
2126 g_free(value);
2129 static void property_set_str(Object *obj, Visitor *v, const char *name,
2130 void *opaque, Error **errp)
2132 StringProperty *prop = opaque;
2133 char *value;
2134 Error *local_err = NULL;
2136 visit_type_str(v, name, &value, &local_err);
2137 if (local_err) {
2138 error_propagate(errp, local_err);
2139 return;
2142 prop->set(obj, value, errp);
2143 g_free(value);
2146 static void property_release_str(Object *obj, const char *name,
2147 void *opaque)
2149 StringProperty *prop = opaque;
2150 g_free(prop);
2153 void object_property_add_str(Object *obj, const char *name,
2154 char *(*get)(Object *, Error **),
2155 void (*set)(Object *, const char *, Error **),
2156 Error **errp)
2158 Error *local_err = NULL;
2159 StringProperty *prop = g_malloc0(sizeof(*prop));
2161 prop->get = get;
2162 prop->set = set;
2164 object_property_add(obj, name, "string",
2165 get ? property_get_str : NULL,
2166 set ? property_set_str : NULL,
2167 property_release_str,
2168 prop, &local_err);
2169 if (local_err) {
2170 error_propagate(errp, local_err);
2171 g_free(prop);
2175 ObjectProperty *
2176 object_class_property_add_str(ObjectClass *klass, const char *name,
2177 char *(*get)(Object *, Error **),
2178 void (*set)(Object *, const char *,
2179 Error **),
2180 Error **errp)
2182 Error *local_err = NULL;
2183 StringProperty *prop = g_malloc0(sizeof(*prop));
2184 ObjectProperty *rv;
2186 prop->get = get;
2187 prop->set = set;
2189 rv = object_class_property_add(klass, name, "string",
2190 get ? property_get_str : NULL,
2191 set ? property_set_str : NULL,
2192 NULL,
2193 prop, &local_err);
2194 if (local_err) {
2195 error_propagate(errp, local_err);
2196 g_free(prop);
2199 return rv;
2202 typedef struct BoolProperty
2204 bool (*get)(Object *, Error **);
2205 void (*set)(Object *, bool, Error **);
2206 } BoolProperty;
2208 static void property_get_bool(Object *obj, Visitor *v, const char *name,
2209 void *opaque, Error **errp)
2211 BoolProperty *prop = opaque;
2212 bool value;
2213 Error *err = NULL;
2215 value = prop->get(obj, &err);
2216 if (err) {
2217 error_propagate(errp, err);
2218 return;
2221 visit_type_bool(v, name, &value, errp);
2224 static void property_set_bool(Object *obj, Visitor *v, const char *name,
2225 void *opaque, Error **errp)
2227 BoolProperty *prop = opaque;
2228 bool value;
2229 Error *local_err = NULL;
2231 visit_type_bool(v, name, &value, &local_err);
2232 if (local_err) {
2233 error_propagate(errp, local_err);
2234 return;
2237 prop->set(obj, value, errp);
2240 static void property_release_bool(Object *obj, const char *name,
2241 void *opaque)
2243 BoolProperty *prop = opaque;
2244 g_free(prop);
2247 void object_property_add_bool(Object *obj, const char *name,
2248 bool (*get)(Object *, Error **),
2249 void (*set)(Object *, bool, Error **),
2250 Error **errp)
2252 Error *local_err = NULL;
2253 BoolProperty *prop = g_malloc0(sizeof(*prop));
2255 prop->get = get;
2256 prop->set = set;
2258 object_property_add(obj, name, "bool",
2259 get ? property_get_bool : NULL,
2260 set ? property_set_bool : NULL,
2261 property_release_bool,
2262 prop, &local_err);
2263 if (local_err) {
2264 error_propagate(errp, local_err);
2265 g_free(prop);
2269 ObjectProperty *
2270 object_class_property_add_bool(ObjectClass *klass, const char *name,
2271 bool (*get)(Object *, Error **),
2272 void (*set)(Object *, bool, Error **),
2273 Error **errp)
2275 Error *local_err = NULL;
2276 BoolProperty *prop = g_malloc0(sizeof(*prop));
2277 ObjectProperty *rv;
2279 prop->get = get;
2280 prop->set = set;
2282 rv = object_class_property_add(klass, name, "bool",
2283 get ? property_get_bool : NULL,
2284 set ? property_set_bool : NULL,
2285 NULL,
2286 prop, &local_err);
2287 if (local_err) {
2288 error_propagate(errp, local_err);
2289 g_free(prop);
2292 return rv;
2295 static void property_get_enum(Object *obj, Visitor *v, const char *name,
2296 void *opaque, Error **errp)
2298 EnumProperty *prop = opaque;
2299 int value;
2300 Error *err = NULL;
2302 value = prop->get(obj, &err);
2303 if (err) {
2304 error_propagate(errp, err);
2305 return;
2308 visit_type_enum(v, name, &value, prop->lookup, errp);
2311 static void property_set_enum(Object *obj, Visitor *v, const char *name,
2312 void *opaque, Error **errp)
2314 EnumProperty *prop = opaque;
2315 int value;
2316 Error *err = NULL;
2318 visit_type_enum(v, name, &value, prop->lookup, &err);
2319 if (err) {
2320 error_propagate(errp, err);
2321 return;
2323 prop->set(obj, value, errp);
2326 static void property_release_enum(Object *obj, const char *name,
2327 void *opaque)
2329 EnumProperty *prop = opaque;
2330 g_free(prop);
2333 void object_property_add_enum(Object *obj, const char *name,
2334 const char *typename,
2335 const QEnumLookup *lookup,
2336 int (*get)(Object *, Error **),
2337 void (*set)(Object *, int, Error **),
2338 Error **errp)
2340 Error *local_err = NULL;
2341 EnumProperty *prop = g_malloc(sizeof(*prop));
2343 prop->lookup = lookup;
2344 prop->get = get;
2345 prop->set = set;
2347 object_property_add(obj, name, typename,
2348 get ? property_get_enum : NULL,
2349 set ? property_set_enum : NULL,
2350 property_release_enum,
2351 prop, &local_err);
2352 if (local_err) {
2353 error_propagate(errp, local_err);
2354 g_free(prop);
2358 ObjectProperty *
2359 object_class_property_add_enum(ObjectClass *klass, const char *name,
2360 const char *typename,
2361 const QEnumLookup *lookup,
2362 int (*get)(Object *, Error **),
2363 void (*set)(Object *, int, Error **),
2364 Error **errp)
2366 Error *local_err = NULL;
2367 EnumProperty *prop = g_malloc(sizeof(*prop));
2368 ObjectProperty *rv;
2370 prop->lookup = lookup;
2371 prop->get = get;
2372 prop->set = set;
2374 rv = object_class_property_add(klass, name, typename,
2375 get ? property_get_enum : NULL,
2376 set ? property_set_enum : NULL,
2377 NULL,
2378 prop, &local_err);
2379 if (local_err) {
2380 error_propagate(errp, local_err);
2381 g_free(prop);
2384 return rv;
2387 typedef struct TMProperty {
2388 void (*get)(Object *, struct tm *, Error **);
2389 } TMProperty;
2391 static void property_get_tm(Object *obj, Visitor *v, const char *name,
2392 void *opaque, Error **errp)
2394 TMProperty *prop = opaque;
2395 Error *err = NULL;
2396 struct tm value;
2398 prop->get(obj, &value, &err);
2399 if (err) {
2400 goto out;
2403 visit_start_struct(v, name, NULL, 0, &err);
2404 if (err) {
2405 goto out;
2407 visit_type_int32(v, "tm_year", &value.tm_year, &err);
2408 if (err) {
2409 goto out_end;
2411 visit_type_int32(v, "tm_mon", &value.tm_mon, &err);
2412 if (err) {
2413 goto out_end;
2415 visit_type_int32(v, "tm_mday", &value.tm_mday, &err);
2416 if (err) {
2417 goto out_end;
2419 visit_type_int32(v, "tm_hour", &value.tm_hour, &err);
2420 if (err) {
2421 goto out_end;
2423 visit_type_int32(v, "tm_min", &value.tm_min, &err);
2424 if (err) {
2425 goto out_end;
2427 visit_type_int32(v, "tm_sec", &value.tm_sec, &err);
2428 if (err) {
2429 goto out_end;
2431 visit_check_struct(v, &err);
2432 out_end:
2433 visit_end_struct(v, NULL);
2434 out:
2435 error_propagate(errp, err);
2439 static void property_release_tm(Object *obj, const char *name,
2440 void *opaque)
2442 TMProperty *prop = opaque;
2443 g_free(prop);
2446 void object_property_add_tm(Object *obj, const char *name,
2447 void (*get)(Object *, struct tm *, Error **),
2448 Error **errp)
2450 Error *local_err = NULL;
2451 TMProperty *prop = g_malloc0(sizeof(*prop));
2453 prop->get = get;
2455 object_property_add(obj, name, "struct tm",
2456 get ? property_get_tm : NULL, NULL,
2457 property_release_tm,
2458 prop, &local_err);
2459 if (local_err) {
2460 error_propagate(errp, local_err);
2461 g_free(prop);
2465 ObjectProperty *
2466 object_class_property_add_tm(ObjectClass *klass, const char *name,
2467 void (*get)(Object *, struct tm *, Error **),
2468 Error **errp)
2470 Error *local_err = NULL;
2471 TMProperty *prop = g_malloc0(sizeof(*prop));
2472 ObjectProperty *rv;
2474 prop->get = get;
2476 rv = object_class_property_add(klass, name, "struct tm",
2477 get ? property_get_tm : NULL, NULL,
2478 NULL,
2479 prop, &local_err);
2480 if (local_err) {
2481 error_propagate(errp, local_err);
2482 g_free(prop);
2485 return rv;
2488 static char *qdev_get_type(Object *obj, Error **errp)
2490 return g_strdup(object_get_typename(obj));
2493 static void property_get_uint8_ptr(Object *obj, Visitor *v, const char *name,
2494 void *opaque, Error **errp)
2496 uint8_t value = *(uint8_t *)opaque;
2497 visit_type_uint8(v, name, &value, errp);
2500 static void property_get_uint16_ptr(Object *obj, Visitor *v, const char *name,
2501 void *opaque, Error **errp)
2503 uint16_t value = *(uint16_t *)opaque;
2504 visit_type_uint16(v, name, &value, errp);
2507 static void property_get_uint32_ptr(Object *obj, Visitor *v, const char *name,
2508 void *opaque, Error **errp)
2510 uint32_t value = *(uint32_t *)opaque;
2511 visit_type_uint32(v, name, &value, errp);
2514 static void property_get_uint64_ptr(Object *obj, Visitor *v, const char *name,
2515 void *opaque, Error **errp)
2517 uint64_t value = *(uint64_t *)opaque;
2518 visit_type_uint64(v, name, &value, errp);
2521 void object_property_add_uint8_ptr(Object *obj, const char *name,
2522 const uint8_t *v, Error **errp)
2524 object_property_add(obj, name, "uint8", property_get_uint8_ptr,
2525 NULL, NULL, (void *)v, errp);
2528 ObjectProperty *
2529 object_class_property_add_uint8_ptr(ObjectClass *klass, const char *name,
2530 const uint8_t *v, Error **errp)
2532 return object_class_property_add(klass, name, "uint8",
2533 property_get_uint8_ptr,
2534 NULL, NULL, (void *)v, errp);
2537 void object_property_add_uint16_ptr(Object *obj, const char *name,
2538 const uint16_t *v, Error **errp)
2540 object_property_add(obj, name, "uint16", property_get_uint16_ptr,
2541 NULL, NULL, (void *)v, errp);
2544 ObjectProperty *
2545 object_class_property_add_uint16_ptr(ObjectClass *klass, const char *name,
2546 const uint16_t *v, Error **errp)
2548 return object_class_property_add(klass, name, "uint16",
2549 property_get_uint16_ptr,
2550 NULL, NULL, (void *)v, errp);
2553 void object_property_add_uint32_ptr(Object *obj, const char *name,
2554 const uint32_t *v, Error **errp)
2556 object_property_add(obj, name, "uint32", property_get_uint32_ptr,
2557 NULL, NULL, (void *)v, errp);
2560 ObjectProperty *
2561 object_class_property_add_uint32_ptr(ObjectClass *klass, const char *name,
2562 const uint32_t *v, Error **errp)
2564 return object_class_property_add(klass, name, "uint32",
2565 property_get_uint32_ptr,
2566 NULL, NULL, (void *)v, errp);
2569 void object_property_add_uint64_ptr(Object *obj, const char *name,
2570 const uint64_t *v, Error **errp)
2572 object_property_add(obj, name, "uint64", property_get_uint64_ptr,
2573 NULL, NULL, (void *)v, errp);
2576 ObjectProperty *
2577 object_class_property_add_uint64_ptr(ObjectClass *klass, const char *name,
2578 const uint64_t *v, Error **errp)
2580 return object_class_property_add(klass, name, "uint64",
2581 property_get_uint64_ptr,
2582 NULL, NULL, (void *)v, errp);
2585 typedef struct {
2586 Object *target_obj;
2587 char *target_name;
2588 } AliasProperty;
2590 static void property_get_alias(Object *obj, Visitor *v, const char *name,
2591 void *opaque, Error **errp)
2593 AliasProperty *prop = opaque;
2595 object_property_get(prop->target_obj, v, prop->target_name, errp);
2598 static void property_set_alias(Object *obj, Visitor *v, const char *name,
2599 void *opaque, Error **errp)
2601 AliasProperty *prop = opaque;
2603 object_property_set(prop->target_obj, v, prop->target_name, errp);
2606 static Object *property_resolve_alias(Object *obj, void *opaque,
2607 const gchar *part)
2609 AliasProperty *prop = opaque;
2611 return object_resolve_path_component(prop->target_obj, prop->target_name);
2614 static void property_release_alias(Object *obj, const char *name, void *opaque)
2616 AliasProperty *prop = opaque;
2618 g_free(prop->target_name);
2619 g_free(prop);
2622 void object_property_add_alias(Object *obj, const char *name,
2623 Object *target_obj, const char *target_name,
2624 Error **errp)
2626 AliasProperty *prop;
2627 ObjectProperty *op;
2628 ObjectProperty *target_prop;
2629 gchar *prop_type;
2630 Error *local_err = NULL;
2632 target_prop = object_property_find(target_obj, target_name, errp);
2633 if (!target_prop) {
2634 return;
2637 if (object_property_is_child(target_prop)) {
2638 prop_type = g_strdup_printf("link%s",
2639 target_prop->type + strlen("child"));
2640 } else {
2641 prop_type = g_strdup(target_prop->type);
2644 prop = g_malloc(sizeof(*prop));
2645 prop->target_obj = target_obj;
2646 prop->target_name = g_strdup(target_name);
2648 op = object_property_add(obj, name, prop_type,
2649 property_get_alias,
2650 property_set_alias,
2651 property_release_alias,
2652 prop, &local_err);
2653 if (local_err) {
2654 error_propagate(errp, local_err);
2655 g_free(prop);
2656 goto out;
2658 op->resolve = property_resolve_alias;
2659 if (target_prop->defval) {
2660 op->defval = qobject_ref(target_prop->defval);
2663 object_property_set_description(obj, op->name,
2664 target_prop->description,
2665 &error_abort);
2667 out:
2668 g_free(prop_type);
2671 void object_property_set_description(Object *obj, const char *name,
2672 const char *description, Error **errp)
2674 ObjectProperty *op;
2676 op = object_property_find(obj, name, errp);
2677 if (!op) {
2678 return;
2681 g_free(op->description);
2682 op->description = g_strdup(description);
2685 void object_class_property_set_description(ObjectClass *klass,
2686 const char *name,
2687 const char *description,
2688 Error **errp)
2690 ObjectProperty *op;
2692 op = g_hash_table_lookup(klass->properties, name);
2693 if (!op) {
2694 error_setg(errp, "Property '.%s' not found", name);
2695 return;
2698 g_free(op->description);
2699 op->description = g_strdup(description);
2702 static void object_class_init(ObjectClass *klass, void *data)
2704 object_class_property_add_str(klass, "type", qdev_get_type,
2705 NULL, &error_abort);
2708 static void register_types(void)
2710 static TypeInfo interface_info = {
2711 .name = TYPE_INTERFACE,
2712 .class_size = sizeof(InterfaceClass),
2713 .abstract = true,
2716 static TypeInfo object_info = {
2717 .name = TYPE_OBJECT,
2718 .instance_size = sizeof(Object),
2719 .class_init = object_class_init,
2720 .abstract = true,
2723 type_interface = type_register_internal(&interface_info);
2724 type_register_internal(&object_info);
2727 type_init(register_types)