target/mips: Add comments for vendor-specific ASEs
[qemu/ar7.git] / qom / object.c
blobb0ed560fd80e7af42533883c98ebc033dcb9c7ba
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, new_iface);
268 static void object_property_free(gpointer data)
270 ObjectProperty *prop = data;
272 if (prop->defval) {
273 qobject_unref(prop->defval);
274 prop->defval = NULL;
276 g_free(prop->name);
277 g_free(prop->type);
278 g_free(prop->description);
279 g_free(prop);
282 static void type_initialize(TypeImpl *ti)
284 TypeImpl *parent;
286 if (ti->class) {
287 return;
290 ti->class_size = type_class_get_size(ti);
291 ti->instance_size = type_object_get_size(ti);
292 /* Any type with zero instance_size is implicitly abstract.
293 * This means interface types are all abstract.
295 if (ti->instance_size == 0) {
296 ti->abstract = true;
298 if (type_is_ancestor(ti, type_interface)) {
299 assert(ti->instance_size == 0);
300 assert(ti->abstract);
301 assert(!ti->instance_init);
302 assert(!ti->instance_post_init);
303 assert(!ti->instance_finalize);
304 assert(!ti->num_interfaces);
306 ti->class = g_malloc0(ti->class_size);
308 parent = type_get_parent(ti);
309 if (parent) {
310 type_initialize(parent);
311 GSList *e;
312 int i;
314 g_assert(parent->class_size <= ti->class_size);
315 g_assert(parent->instance_size <= ti->instance_size);
316 memcpy(ti->class, parent->class, parent->class_size);
317 ti->class->interfaces = NULL;
319 for (e = parent->class->interfaces; e; e = e->next) {
320 InterfaceClass *iface = e->data;
321 ObjectClass *klass = OBJECT_CLASS(iface);
323 type_initialize_interface(ti, iface->interface_type, klass->type);
326 for (i = 0; i < ti->num_interfaces; i++) {
327 TypeImpl *t = type_get_by_name(ti->interfaces[i].typename);
328 if (!t) {
329 error_report("missing interface '%s' for object '%s'",
330 ti->interfaces[i].typename, parent->name);
331 abort();
333 for (e = ti->class->interfaces; e; e = e->next) {
334 TypeImpl *target_type = OBJECT_CLASS(e->data)->type;
336 if (type_is_ancestor(target_type, t)) {
337 break;
341 if (e) {
342 continue;
345 type_initialize_interface(ti, t, t);
349 ti->class->properties = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
350 object_property_free);
352 ti->class->type = ti;
354 while (parent) {
355 if (parent->class_base_init) {
356 parent->class_base_init(ti->class, ti->class_data);
358 parent = type_get_parent(parent);
361 if (ti->class_init) {
362 ti->class_init(ti->class, ti->class_data);
366 static void object_init_with_type(Object *obj, TypeImpl *ti)
368 if (type_has_parent(ti)) {
369 object_init_with_type(obj, type_get_parent(ti));
372 if (ti->instance_init) {
373 ti->instance_init(obj);
377 static void object_post_init_with_type(Object *obj, TypeImpl *ti)
379 if (ti->instance_post_init) {
380 ti->instance_post_init(obj);
383 if (type_has_parent(ti)) {
384 object_post_init_with_type(obj, type_get_parent(ti));
388 void object_apply_global_props(Object *obj, const GPtrArray *props, Error **errp)
390 int i;
392 if (!props) {
393 return;
396 for (i = 0; i < props->len; i++) {
397 GlobalProperty *p = g_ptr_array_index(props, i);
398 Error *err = NULL;
400 if (object_dynamic_cast(obj, p->driver) == NULL) {
401 continue;
403 if (p->optional && !object_property_find(obj, p->property, NULL)) {
404 continue;
406 p->used = true;
407 object_property_parse(obj, p->value, p->property, &err);
408 if (err != NULL) {
409 error_prepend(&err, "can't apply global %s.%s=%s: ",
410 p->driver, p->property, p->value);
412 * If errp != NULL, propagate error and return.
413 * If errp == NULL, report a warning, but keep going
414 * with the remaining globals.
416 if (errp) {
417 error_propagate(errp, err);
418 return;
419 } else {
420 warn_report_err(err);
427 * Global property defaults
428 * Slot 0: accelerator's global property defaults
429 * Slot 1: machine's global property defaults
430 * Slot 2: global properties from legacy command line option
431 * Each is a GPtrArray of of GlobalProperty.
432 * Applied in order, later entries override earlier ones.
434 static GPtrArray *object_compat_props[3];
437 * Retrieve @GPtrArray for global property defined with options
438 * other than "-global". These are generally used for syntactic
439 * sugar and legacy command line options.
441 void object_register_sugar_prop(const char *driver, const char *prop, const char *value)
443 GlobalProperty *g;
444 if (!object_compat_props[2]) {
445 object_compat_props[2] = g_ptr_array_new();
447 g = g_new0(GlobalProperty, 1);
448 g->driver = g_strdup(driver);
449 g->property = g_strdup(prop);
450 g->value = g_strdup(value);
451 g_ptr_array_add(object_compat_props[2], g);
455 * Set machine's global property defaults to @compat_props.
456 * May be called at most once.
458 void object_set_machine_compat_props(GPtrArray *compat_props)
460 assert(!object_compat_props[1]);
461 object_compat_props[1] = compat_props;
465 * Set accelerator's global property defaults to @compat_props.
466 * May be called at most once.
468 void object_set_accelerator_compat_props(GPtrArray *compat_props)
470 assert(!object_compat_props[0]);
471 object_compat_props[0] = compat_props;
474 void object_apply_compat_props(Object *obj)
476 int i;
478 for (i = 0; i < ARRAY_SIZE(object_compat_props); i++) {
479 object_apply_global_props(obj, object_compat_props[i],
480 i == 2 ? &error_fatal : &error_abort);
484 static void object_class_property_init_all(Object *obj)
486 ObjectPropertyIterator iter;
487 ObjectProperty *prop;
489 object_class_property_iter_init(&iter, object_get_class(obj));
490 while ((prop = object_property_iter_next(&iter))) {
491 if (prop->init) {
492 prop->init(obj, prop);
497 static void object_initialize_with_type(Object *obj, size_t size, TypeImpl *type)
499 type_initialize(type);
501 g_assert(type->instance_size >= sizeof(Object));
502 g_assert(type->abstract == false);
503 g_assert(size >= type->instance_size);
505 memset(obj, 0, type->instance_size);
506 obj->class = type->class;
507 object_ref(obj);
508 object_class_property_init_all(obj);
509 obj->properties = g_hash_table_new_full(g_str_hash, g_str_equal,
510 NULL, object_property_free);
511 object_init_with_type(obj, type);
512 object_post_init_with_type(obj, type);
515 void object_initialize(void *data, size_t size, const char *typename)
517 TypeImpl *type = type_get_by_name(typename);
519 if (!type) {
520 error_report("missing object type '%s'", typename);
521 abort();
524 object_initialize_with_type(data, size, type);
527 void object_initialize_child(Object *parentobj, const char *propname,
528 void *childobj, size_t size, const char *type,
529 Error **errp, ...)
531 va_list vargs;
533 va_start(vargs, errp);
534 object_initialize_childv(parentobj, propname, childobj, size, type, errp,
535 vargs);
536 va_end(vargs);
539 void object_initialize_childv(Object *parentobj, const char *propname,
540 void *childobj, size_t size, const char *type,
541 Error **errp, va_list vargs)
543 Error *local_err = NULL;
544 Object *obj;
545 UserCreatable *uc;
547 object_initialize(childobj, size, type);
548 obj = OBJECT(childobj);
550 object_set_propv(obj, &local_err, vargs);
551 if (local_err) {
552 goto out;
555 object_property_add_child(parentobj, propname, obj);
557 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
558 if (uc) {
559 user_creatable_complete(uc, &local_err);
560 if (local_err) {
561 object_unparent(obj);
562 goto out;
566 out:
568 * We want @obj's reference to be 1 on success, 0 on failure.
569 * On success, it's 2: one taken by object_initialize(), and one
570 * by object_property_add_child().
571 * On failure in object_initialize() or earlier, it's 1.
572 * On failure afterwards, it's also 1: object_unparent() releases
573 * the reference taken by object_property_add_child().
575 object_unref(obj);
577 error_propagate(errp, local_err);
580 static inline bool object_property_is_child(ObjectProperty *prop)
582 return strstart(prop->type, "child<", NULL);
585 static void object_property_del_all(Object *obj)
587 g_autoptr(GHashTable) done = g_hash_table_new(NULL, NULL);
588 ObjectProperty *prop;
589 ObjectPropertyIterator iter;
590 bool released;
592 do {
593 released = false;
594 object_property_iter_init(&iter, obj);
595 while ((prop = object_property_iter_next(&iter)) != NULL) {
596 if (g_hash_table_add(done, prop)) {
597 if (prop->release) {
598 prop->release(obj, prop->name, prop->opaque);
599 released = true;
600 break;
604 } while (released);
606 g_hash_table_unref(obj->properties);
609 static void object_property_del_child(Object *obj, Object *child)
611 ObjectProperty *prop;
612 GHashTableIter iter;
613 gpointer key, value;
615 g_hash_table_iter_init(&iter, obj->properties);
616 while (g_hash_table_iter_next(&iter, &key, &value)) {
617 prop = value;
618 if (object_property_is_child(prop) && prop->opaque == child) {
619 if (prop->release) {
620 prop->release(obj, prop->name, prop->opaque);
621 prop->release = NULL;
623 break;
626 g_hash_table_iter_init(&iter, obj->properties);
627 while (g_hash_table_iter_next(&iter, &key, &value)) {
628 prop = value;
629 if (object_property_is_child(prop) && prop->opaque == child) {
630 g_hash_table_iter_remove(&iter);
631 break;
636 void object_unparent(Object *obj)
638 if (obj->parent) {
639 object_property_del_child(obj->parent, obj);
643 static void object_deinit(Object *obj, TypeImpl *type)
645 if (type->instance_finalize) {
646 type->instance_finalize(obj);
649 if (type_has_parent(type)) {
650 object_deinit(obj, type_get_parent(type));
654 static void object_finalize(void *data)
656 Object *obj = data;
657 TypeImpl *ti = obj->class->type;
659 object_property_del_all(obj);
660 object_deinit(obj, ti);
662 g_assert(obj->ref == 0);
663 if (obj->free) {
664 obj->free(obj);
668 static Object *object_new_with_type(Type type)
670 Object *obj;
672 g_assert(type != NULL);
673 type_initialize(type);
675 obj = g_malloc(type->instance_size);
676 object_initialize_with_type(obj, type->instance_size, type);
677 obj->free = g_free;
679 return obj;
682 Object *object_new_with_class(ObjectClass *klass)
684 return object_new_with_type(klass->type);
687 Object *object_new(const char *typename)
689 TypeImpl *ti = type_get_by_name(typename);
691 return object_new_with_type(ti);
695 Object *object_new_with_props(const char *typename,
696 Object *parent,
697 const char *id,
698 Error **errp,
699 ...)
701 va_list vargs;
702 Object *obj;
704 va_start(vargs, errp);
705 obj = object_new_with_propv(typename, parent, id, errp, vargs);
706 va_end(vargs);
708 return obj;
712 Object *object_new_with_propv(const char *typename,
713 Object *parent,
714 const char *id,
715 Error **errp,
716 va_list vargs)
718 Object *obj;
719 ObjectClass *klass;
720 Error *local_err = NULL;
721 UserCreatable *uc;
723 klass = object_class_by_name(typename);
724 if (!klass) {
725 error_setg(errp, "invalid object type: %s", typename);
726 return NULL;
729 if (object_class_is_abstract(klass)) {
730 error_setg(errp, "object type '%s' is abstract", typename);
731 return NULL;
733 obj = object_new_with_type(klass->type);
735 if (object_set_propv(obj, &local_err, vargs) < 0) {
736 goto error;
739 if (id != NULL) {
740 object_property_add_child(parent, id, obj);
743 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
744 if (uc) {
745 user_creatable_complete(uc, &local_err);
746 if (local_err) {
747 if (id != NULL) {
748 object_unparent(obj);
750 goto error;
754 object_unref(obj);
755 return obj;
757 error:
758 error_propagate(errp, local_err);
759 object_unref(obj);
760 return NULL;
764 int object_set_props(Object *obj,
765 Error **errp,
766 ...)
768 va_list vargs;
769 int ret;
771 va_start(vargs, errp);
772 ret = object_set_propv(obj, errp, vargs);
773 va_end(vargs);
775 return ret;
779 int object_set_propv(Object *obj,
780 Error **errp,
781 va_list vargs)
783 const char *propname;
784 Error *local_err = NULL;
786 propname = va_arg(vargs, char *);
787 while (propname != NULL) {
788 const char *value = va_arg(vargs, char *);
790 g_assert(value != NULL);
791 object_property_parse(obj, value, propname, &local_err);
792 if (local_err) {
793 error_propagate(errp, local_err);
794 return -1;
796 propname = va_arg(vargs, char *);
799 return 0;
803 Object *object_dynamic_cast(Object *obj, const char *typename)
805 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
806 return obj;
809 return NULL;
812 Object *object_dynamic_cast_assert(Object *obj, const char *typename,
813 const char *file, int line, const char *func)
815 trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
816 typename, file, line, func);
818 #ifdef CONFIG_QOM_CAST_DEBUG
819 int i;
820 Object *inst;
822 for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
823 if (atomic_read(&obj->class->object_cast_cache[i]) == typename) {
824 goto out;
828 inst = object_dynamic_cast(obj, typename);
830 if (!inst && obj) {
831 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
832 file, line, func, obj, typename);
833 abort();
836 assert(obj == inst);
838 if (obj && obj == inst) {
839 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
840 atomic_set(&obj->class->object_cast_cache[i - 1],
841 atomic_read(&obj->class->object_cast_cache[i]));
843 atomic_set(&obj->class->object_cast_cache[i - 1], typename);
846 out:
847 #endif
848 return obj;
851 ObjectClass *object_class_dynamic_cast(ObjectClass *class,
852 const char *typename)
854 ObjectClass *ret = NULL;
855 TypeImpl *target_type;
856 TypeImpl *type;
858 if (!class) {
859 return NULL;
862 /* A simple fast path that can trigger a lot for leaf classes. */
863 type = class->type;
864 if (type->name == typename) {
865 return class;
868 target_type = type_get_by_name(typename);
869 if (!target_type) {
870 /* target class type unknown, so fail the cast */
871 return NULL;
874 if (type->class->interfaces &&
875 type_is_ancestor(target_type, type_interface)) {
876 int found = 0;
877 GSList *i;
879 for (i = class->interfaces; i; i = i->next) {
880 ObjectClass *target_class = i->data;
882 if (type_is_ancestor(target_class->type, target_type)) {
883 ret = target_class;
884 found++;
888 /* The match was ambiguous, don't allow a cast */
889 if (found > 1) {
890 ret = NULL;
892 } else if (type_is_ancestor(type, target_type)) {
893 ret = class;
896 return ret;
899 ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
900 const char *typename,
901 const char *file, int line,
902 const char *func)
904 ObjectClass *ret;
906 trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)",
907 typename, file, line, func);
909 #ifdef CONFIG_QOM_CAST_DEBUG
910 int i;
912 for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
913 if (atomic_read(&class->class_cast_cache[i]) == typename) {
914 ret = class;
915 goto out;
918 #else
919 if (!class || !class->interfaces) {
920 return class;
922 #endif
924 ret = object_class_dynamic_cast(class, typename);
925 if (!ret && class) {
926 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
927 file, line, func, class, typename);
928 abort();
931 #ifdef CONFIG_QOM_CAST_DEBUG
932 if (class && ret == class) {
933 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
934 atomic_set(&class->class_cast_cache[i - 1],
935 atomic_read(&class->class_cast_cache[i]));
937 atomic_set(&class->class_cast_cache[i - 1], typename);
939 out:
940 #endif
941 return ret;
944 const char *object_get_typename(const Object *obj)
946 return obj->class->type->name;
949 ObjectClass *object_get_class(Object *obj)
951 return obj->class;
954 bool object_class_is_abstract(ObjectClass *klass)
956 return klass->type->abstract;
959 const char *object_class_get_name(ObjectClass *klass)
961 return klass->type->name;
964 ObjectClass *object_class_by_name(const char *typename)
966 TypeImpl *type = type_get_by_name(typename);
968 if (!type) {
969 return NULL;
972 type_initialize(type);
974 return type->class;
977 ObjectClass *object_class_get_parent(ObjectClass *class)
979 TypeImpl *type = type_get_parent(class->type);
981 if (!type) {
982 return NULL;
985 type_initialize(type);
987 return type->class;
990 typedef struct OCFData
992 void (*fn)(ObjectClass *klass, void *opaque);
993 const char *implements_type;
994 bool include_abstract;
995 void *opaque;
996 } OCFData;
998 static void object_class_foreach_tramp(gpointer key, gpointer value,
999 gpointer opaque)
1001 OCFData *data = opaque;
1002 TypeImpl *type = value;
1003 ObjectClass *k;
1005 type_initialize(type);
1006 k = type->class;
1008 if (!data->include_abstract && type->abstract) {
1009 return;
1012 if (data->implements_type &&
1013 !object_class_dynamic_cast(k, data->implements_type)) {
1014 return;
1017 data->fn(k, data->opaque);
1020 void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
1021 const char *implements_type, bool include_abstract,
1022 void *opaque)
1024 OCFData data = { fn, implements_type, include_abstract, opaque };
1026 enumerating_types = true;
1027 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
1028 enumerating_types = false;
1031 static int do_object_child_foreach(Object *obj,
1032 int (*fn)(Object *child, void *opaque),
1033 void *opaque, bool recurse)
1035 GHashTableIter iter;
1036 ObjectProperty *prop;
1037 int ret = 0;
1039 g_hash_table_iter_init(&iter, obj->properties);
1040 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
1041 if (object_property_is_child(prop)) {
1042 Object *child = prop->opaque;
1044 ret = fn(child, opaque);
1045 if (ret != 0) {
1046 break;
1048 if (recurse) {
1049 ret = do_object_child_foreach(child, fn, opaque, true);
1050 if (ret != 0) {
1051 break;
1056 return ret;
1059 int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
1060 void *opaque)
1062 return do_object_child_foreach(obj, fn, opaque, false);
1065 int object_child_foreach_recursive(Object *obj,
1066 int (*fn)(Object *child, void *opaque),
1067 void *opaque)
1069 return do_object_child_foreach(obj, fn, opaque, true);
1072 static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
1074 GSList **list = opaque;
1076 *list = g_slist_prepend(*list, klass);
1079 GSList *object_class_get_list(const char *implements_type,
1080 bool include_abstract)
1082 GSList *list = NULL;
1084 object_class_foreach(object_class_get_list_tramp,
1085 implements_type, include_abstract, &list);
1086 return list;
1089 static gint object_class_cmp(gconstpointer a, gconstpointer b)
1091 return strcasecmp(object_class_get_name((ObjectClass *)a),
1092 object_class_get_name((ObjectClass *)b));
1095 GSList *object_class_get_list_sorted(const char *implements_type,
1096 bool include_abstract)
1098 return g_slist_sort(object_class_get_list(implements_type, include_abstract),
1099 object_class_cmp);
1102 Object *object_ref(Object *obj)
1104 if (!obj) {
1105 return NULL;
1107 atomic_inc(&obj->ref);
1108 return obj;
1111 void object_unref(Object *obj)
1113 if (!obj) {
1114 return;
1116 g_assert(obj->ref > 0);
1118 /* parent always holds a reference to its children */
1119 if (atomic_fetch_dec(&obj->ref) == 1) {
1120 object_finalize(obj);
1124 static ObjectProperty *
1125 object_property_try_add(Object *obj, const char *name, const char *type,
1126 ObjectPropertyAccessor *get,
1127 ObjectPropertyAccessor *set,
1128 ObjectPropertyRelease *release,
1129 void *opaque, Error **errp)
1131 ObjectProperty *prop;
1132 size_t name_len = strlen(name);
1134 if (name_len >= 3 && !memcmp(name + name_len - 3, "[*]", 4)) {
1135 int i;
1136 ObjectProperty *ret;
1137 char *name_no_array = g_strdup(name);
1139 name_no_array[name_len - 3] = '\0';
1140 for (i = 0; ; ++i) {
1141 char *full_name = g_strdup_printf("%s[%d]", name_no_array, i);
1143 ret = object_property_try_add(obj, full_name, type, get, set,
1144 release, opaque, NULL);
1145 g_free(full_name);
1146 if (ret) {
1147 break;
1150 g_free(name_no_array);
1151 return ret;
1154 if (object_property_find(obj, name, NULL) != NULL) {
1155 error_setg(errp, "attempt to add duplicate property '%s' to object (type '%s')",
1156 name, object_get_typename(obj));
1157 return NULL;
1160 prop = g_malloc0(sizeof(*prop));
1162 prop->name = g_strdup(name);
1163 prop->type = g_strdup(type);
1165 prop->get = get;
1166 prop->set = set;
1167 prop->release = release;
1168 prop->opaque = opaque;
1170 g_hash_table_insert(obj->properties, prop->name, prop);
1171 return prop;
1174 ObjectProperty *
1175 object_property_add(Object *obj, const char *name, const char *type,
1176 ObjectPropertyAccessor *get,
1177 ObjectPropertyAccessor *set,
1178 ObjectPropertyRelease *release,
1179 void *opaque)
1181 return object_property_try_add(obj, name, type, get, set, release,
1182 opaque, &error_abort);
1185 ObjectProperty *
1186 object_class_property_add(ObjectClass *klass,
1187 const char *name,
1188 const char *type,
1189 ObjectPropertyAccessor *get,
1190 ObjectPropertyAccessor *set,
1191 ObjectPropertyRelease *release,
1192 void *opaque)
1194 ObjectProperty *prop;
1196 assert(!object_class_property_find(klass, name, NULL));
1198 prop = g_malloc0(sizeof(*prop));
1200 prop->name = g_strdup(name);
1201 prop->type = g_strdup(type);
1203 prop->get = get;
1204 prop->set = set;
1205 prop->release = release;
1206 prop->opaque = opaque;
1208 g_hash_table_insert(klass->properties, prop->name, prop);
1210 return prop;
1213 ObjectProperty *object_property_find(Object *obj, const char *name,
1214 Error **errp)
1216 ObjectProperty *prop;
1217 ObjectClass *klass = object_get_class(obj);
1219 prop = object_class_property_find(klass, name, NULL);
1220 if (prop) {
1221 return prop;
1224 prop = g_hash_table_lookup(obj->properties, name);
1225 if (prop) {
1226 return prop;
1229 error_setg(errp, "Property '.%s' not found", name);
1230 return NULL;
1233 void object_property_iter_init(ObjectPropertyIterator *iter,
1234 Object *obj)
1236 g_hash_table_iter_init(&iter->iter, obj->properties);
1237 iter->nextclass = object_get_class(obj);
1240 ObjectProperty *object_property_iter_next(ObjectPropertyIterator *iter)
1242 gpointer key, val;
1243 while (!g_hash_table_iter_next(&iter->iter, &key, &val)) {
1244 if (!iter->nextclass) {
1245 return NULL;
1247 g_hash_table_iter_init(&iter->iter, iter->nextclass->properties);
1248 iter->nextclass = object_class_get_parent(iter->nextclass);
1250 return val;
1253 void object_class_property_iter_init(ObjectPropertyIterator *iter,
1254 ObjectClass *klass)
1256 g_hash_table_iter_init(&iter->iter, klass->properties);
1257 iter->nextclass = object_class_get_parent(klass);
1260 ObjectProperty *object_class_property_find(ObjectClass *klass, const char *name,
1261 Error **errp)
1263 ObjectProperty *prop;
1264 ObjectClass *parent_klass;
1266 parent_klass = object_class_get_parent(klass);
1267 if (parent_klass) {
1268 prop = object_class_property_find(parent_klass, name, NULL);
1269 if (prop) {
1270 return prop;
1274 prop = g_hash_table_lookup(klass->properties, name);
1275 if (!prop) {
1276 error_setg(errp, "Property '.%s' not found", name);
1278 return prop;
1281 void object_property_del(Object *obj, const char *name)
1283 ObjectProperty *prop = g_hash_table_lookup(obj->properties, name);
1285 if (prop->release) {
1286 prop->release(obj, name, prop->opaque);
1288 g_hash_table_remove(obj->properties, name);
1291 void object_property_get(Object *obj, Visitor *v, const char *name,
1292 Error **errp)
1294 ObjectProperty *prop = object_property_find(obj, name, errp);
1295 if (prop == NULL) {
1296 return;
1299 if (!prop->get) {
1300 error_setg(errp, QERR_PERMISSION_DENIED);
1301 } else {
1302 prop->get(obj, v, name, prop->opaque, errp);
1306 void object_property_set(Object *obj, Visitor *v, const char *name,
1307 Error **errp)
1309 ObjectProperty *prop = object_property_find(obj, name, errp);
1310 if (prop == NULL) {
1311 return;
1314 if (!prop->set) {
1315 error_setg(errp, QERR_PERMISSION_DENIED);
1316 } else {
1317 prop->set(obj, v, name, prop->opaque, errp);
1321 void object_property_set_str(Object *obj, const char *value,
1322 const char *name, Error **errp)
1324 QString *qstr = qstring_from_str(value);
1325 object_property_set_qobject(obj, QOBJECT(qstr), name, errp);
1327 qobject_unref(qstr);
1330 char *object_property_get_str(Object *obj, const char *name,
1331 Error **errp)
1333 QObject *ret = object_property_get_qobject(obj, name, errp);
1334 char *retval;
1336 if (!ret) {
1337 return NULL;
1340 retval = g_strdup(qobject_get_try_str(ret));
1341 if (!retval) {
1342 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
1345 qobject_unref(ret);
1346 return retval;
1349 void object_property_set_link(Object *obj, Object *value,
1350 const char *name, Error **errp)
1352 if (value) {
1353 char *path = object_get_canonical_path(value);
1354 object_property_set_str(obj, path, name, errp);
1355 g_free(path);
1356 } else {
1357 object_property_set_str(obj, "", name, errp);
1361 Object *object_property_get_link(Object *obj, const char *name,
1362 Error **errp)
1364 char *str = object_property_get_str(obj, name, errp);
1365 Object *target = NULL;
1367 if (str && *str) {
1368 target = object_resolve_path(str, NULL);
1369 if (!target) {
1370 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1371 "Device '%s' not found", str);
1375 g_free(str);
1376 return target;
1379 void object_property_set_bool(Object *obj, bool value,
1380 const char *name, Error **errp)
1382 QBool *qbool = qbool_from_bool(value);
1383 object_property_set_qobject(obj, QOBJECT(qbool), name, errp);
1385 qobject_unref(qbool);
1388 bool object_property_get_bool(Object *obj, const char *name,
1389 Error **errp)
1391 QObject *ret = object_property_get_qobject(obj, name, errp);
1392 QBool *qbool;
1393 bool retval;
1395 if (!ret) {
1396 return false;
1398 qbool = qobject_to(QBool, ret);
1399 if (!qbool) {
1400 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
1401 retval = false;
1402 } else {
1403 retval = qbool_get_bool(qbool);
1406 qobject_unref(ret);
1407 return retval;
1410 void object_property_set_int(Object *obj, int64_t value,
1411 const char *name, Error **errp)
1413 QNum *qnum = qnum_from_int(value);
1414 object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
1416 qobject_unref(qnum);
1419 int64_t object_property_get_int(Object *obj, const char *name,
1420 Error **errp)
1422 QObject *ret = object_property_get_qobject(obj, name, errp);
1423 QNum *qnum;
1424 int64_t retval;
1426 if (!ret) {
1427 return -1;
1430 qnum = qobject_to(QNum, ret);
1431 if (!qnum || !qnum_get_try_int(qnum, &retval)) {
1432 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
1433 retval = -1;
1436 qobject_unref(ret);
1437 return retval;
1440 static void object_property_init_defval(Object *obj, ObjectProperty *prop)
1442 Visitor *v = qobject_input_visitor_new(prop->defval);
1444 assert(prop->set != NULL);
1445 prop->set(obj, v, prop->name, prop->opaque, &error_abort);
1447 visit_free(v);
1450 static void object_property_set_default(ObjectProperty *prop, QObject *defval)
1452 assert(!prop->defval);
1453 assert(!prop->init);
1455 prop->defval = defval;
1456 prop->init = object_property_init_defval;
1459 void object_property_set_default_bool(ObjectProperty *prop, bool value)
1461 object_property_set_default(prop, QOBJECT(qbool_from_bool(value)));
1464 void object_property_set_default_str(ObjectProperty *prop, const char *value)
1466 object_property_set_default(prop, QOBJECT(qstring_from_str(value)));
1469 void object_property_set_default_int(ObjectProperty *prop, int64_t value)
1471 object_property_set_default(prop, QOBJECT(qnum_from_int(value)));
1474 void object_property_set_default_uint(ObjectProperty *prop, uint64_t value)
1476 object_property_set_default(prop, QOBJECT(qnum_from_uint(value)));
1479 void object_property_set_uint(Object *obj, uint64_t value,
1480 const char *name, Error **errp)
1482 QNum *qnum = qnum_from_uint(value);
1484 object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
1485 qobject_unref(qnum);
1488 uint64_t object_property_get_uint(Object *obj, const char *name,
1489 Error **errp)
1491 QObject *ret = object_property_get_qobject(obj, name, errp);
1492 QNum *qnum;
1493 uint64_t retval;
1495 if (!ret) {
1496 return 0;
1498 qnum = qobject_to(QNum, ret);
1499 if (!qnum || !qnum_get_try_uint(qnum, &retval)) {
1500 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "uint");
1501 retval = 0;
1504 qobject_unref(ret);
1505 return retval;
1508 typedef struct EnumProperty {
1509 const QEnumLookup *lookup;
1510 int (*get)(Object *, Error **);
1511 void (*set)(Object *, int, Error **);
1512 } EnumProperty;
1514 int object_property_get_enum(Object *obj, const char *name,
1515 const char *typename, Error **errp)
1517 char *str;
1518 int ret;
1519 ObjectProperty *prop = object_property_find(obj, name, errp);
1520 EnumProperty *enumprop;
1522 if (prop == NULL) {
1523 return 0;
1526 if (!g_str_equal(prop->type, typename)) {
1527 error_setg(errp, "Property %s on %s is not '%s' enum type",
1528 name, object_class_get_name(
1529 object_get_class(obj)), typename);
1530 return 0;
1533 enumprop = prop->opaque;
1535 str = object_property_get_str(obj, name, errp);
1536 if (!str) {
1537 return 0;
1540 ret = qapi_enum_parse(enumprop->lookup, str, -1, errp);
1541 g_free(str);
1543 return ret;
1546 void object_property_parse(Object *obj, const char *string,
1547 const char *name, Error **errp)
1549 Visitor *v = string_input_visitor_new(string);
1550 object_property_set(obj, v, name, errp);
1551 visit_free(v);
1554 char *object_property_print(Object *obj, const char *name, bool human,
1555 Error **errp)
1557 Visitor *v;
1558 char *string = NULL;
1559 Error *local_err = NULL;
1561 v = string_output_visitor_new(human, &string);
1562 object_property_get(obj, v, name, &local_err);
1563 if (local_err) {
1564 error_propagate(errp, local_err);
1565 goto out;
1568 visit_complete(v, &string);
1570 out:
1571 visit_free(v);
1572 return string;
1575 const char *object_property_get_type(Object *obj, const char *name, Error **errp)
1577 ObjectProperty *prop = object_property_find(obj, name, errp);
1578 if (prop == NULL) {
1579 return NULL;
1582 return prop->type;
1585 Object *object_get_root(void)
1587 static Object *root;
1589 if (!root) {
1590 root = object_new("container");
1593 return root;
1596 Object *object_get_objects_root(void)
1598 return container_get(object_get_root(), "/objects");
1601 Object *object_get_internal_root(void)
1603 static Object *internal_root;
1605 if (!internal_root) {
1606 internal_root = object_new("container");
1609 return internal_root;
1612 static void object_get_child_property(Object *obj, Visitor *v,
1613 const char *name, void *opaque,
1614 Error **errp)
1616 Object *child = opaque;
1617 char *path;
1619 path = object_get_canonical_path(child);
1620 visit_type_str(v, name, &path, errp);
1621 g_free(path);
1624 static Object *object_resolve_child_property(Object *parent, void *opaque,
1625 const char *part)
1627 return opaque;
1630 static void object_finalize_child_property(Object *obj, const char *name,
1631 void *opaque)
1633 Object *child = opaque;
1635 if (child->class->unparent) {
1636 (child->class->unparent)(child);
1638 child->parent = NULL;
1639 object_unref(child);
1642 ObjectProperty *
1643 object_property_add_child(Object *obj, const char *name,
1644 Object *child)
1646 g_autofree char *type = NULL;
1647 ObjectProperty *op;
1649 assert(!child->parent);
1651 type = g_strdup_printf("child<%s>", object_get_typename(child));
1653 op = object_property_add(obj, name, type, object_get_child_property, NULL,
1654 object_finalize_child_property, child);
1655 op->resolve = object_resolve_child_property;
1656 object_ref(child);
1657 child->parent = obj;
1658 return op;
1661 void object_property_allow_set_link(const Object *obj, const char *name,
1662 Object *val, Error **errp)
1664 /* Allow the link to be set, always */
1667 typedef struct {
1668 union {
1669 Object **targetp;
1670 Object *target; /* if OBJ_PROP_LINK_DIRECT, when holding the pointer */
1671 ptrdiff_t offset; /* if OBJ_PROP_LINK_CLASS */
1673 void (*check)(const Object *, const char *, Object *, Error **);
1674 ObjectPropertyLinkFlags flags;
1675 } LinkProperty;
1677 static Object **
1678 object_link_get_targetp(Object *obj, LinkProperty *lprop)
1680 if (lprop->flags & OBJ_PROP_LINK_DIRECT) {
1681 return &lprop->target;
1682 } else if (lprop->flags & OBJ_PROP_LINK_CLASS) {
1683 return (void *)obj + lprop->offset;
1684 } else {
1685 return lprop->targetp;
1689 static void object_get_link_property(Object *obj, Visitor *v,
1690 const char *name, void *opaque,
1691 Error **errp)
1693 LinkProperty *lprop = opaque;
1694 Object **targetp = object_link_get_targetp(obj, lprop);
1695 char *path;
1697 if (*targetp) {
1698 path = object_get_canonical_path(*targetp);
1699 visit_type_str(v, name, &path, errp);
1700 g_free(path);
1701 } else {
1702 path = (char *)"";
1703 visit_type_str(v, name, &path, errp);
1708 * object_resolve_link:
1710 * Lookup an object and ensure its type matches the link property type. This
1711 * is similar to object_resolve_path() except type verification against the
1712 * link property is performed.
1714 * Returns: The matched object or NULL on path lookup failures.
1716 static Object *object_resolve_link(Object *obj, const char *name,
1717 const char *path, Error **errp)
1719 const char *type;
1720 char *target_type;
1721 bool ambiguous = false;
1722 Object *target;
1724 /* Go from link<FOO> to FOO. */
1725 type = object_property_get_type(obj, name, NULL);
1726 target_type = g_strndup(&type[5], strlen(type) - 6);
1727 target = object_resolve_path_type(path, target_type, &ambiguous);
1729 if (ambiguous) {
1730 error_setg(errp, "Path '%s' does not uniquely identify an object",
1731 path);
1732 } else if (!target) {
1733 target = object_resolve_path(path, &ambiguous);
1734 if (target || ambiguous) {
1735 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
1736 } else {
1737 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1738 "Device '%s' not found", path);
1740 target = NULL;
1742 g_free(target_type);
1744 return target;
1747 static void object_set_link_property(Object *obj, Visitor *v,
1748 const char *name, void *opaque,
1749 Error **errp)
1751 Error *local_err = NULL;
1752 LinkProperty *prop = opaque;
1753 Object **targetp = object_link_get_targetp(obj, prop);
1754 Object *old_target = *targetp;
1755 Object *new_target = NULL;
1756 char *path = NULL;
1758 visit_type_str(v, name, &path, &local_err);
1760 if (!local_err && strcmp(path, "") != 0) {
1761 new_target = object_resolve_link(obj, name, path, &local_err);
1764 g_free(path);
1765 if (local_err) {
1766 error_propagate(errp, local_err);
1767 return;
1770 prop->check(obj, name, new_target, &local_err);
1771 if (local_err) {
1772 error_propagate(errp, local_err);
1773 return;
1776 *targetp = new_target;
1777 if (prop->flags & OBJ_PROP_LINK_STRONG) {
1778 object_ref(new_target);
1779 object_unref(old_target);
1783 static Object *object_resolve_link_property(Object *parent, void *opaque,
1784 const char *part)
1786 LinkProperty *lprop = opaque;
1788 return *object_link_get_targetp(parent, lprop);
1791 static void object_release_link_property(Object *obj, const char *name,
1792 void *opaque)
1794 LinkProperty *prop = opaque;
1795 Object **targetp = object_link_get_targetp(obj, prop);
1797 if ((prop->flags & OBJ_PROP_LINK_STRONG) && *targetp) {
1798 object_unref(*targetp);
1800 if (!(prop->flags & OBJ_PROP_LINK_CLASS)) {
1801 g_free(prop);
1805 static ObjectProperty *
1806 object_add_link_prop(Object *obj, const char *name,
1807 const char *type, void *ptr,
1808 void (*check)(const Object *, const char *,
1809 Object *, Error **),
1810 ObjectPropertyLinkFlags flags)
1812 LinkProperty *prop = g_malloc(sizeof(*prop));
1813 g_autofree char *full_type = NULL;
1814 ObjectProperty *op;
1816 if (flags & OBJ_PROP_LINK_DIRECT) {
1817 prop->target = ptr;
1818 } else {
1819 prop->targetp = ptr;
1821 prop->check = check;
1822 prop->flags = flags;
1824 full_type = g_strdup_printf("link<%s>", type);
1826 op = object_property_add(obj, name, full_type,
1827 object_get_link_property,
1828 check ? object_set_link_property : NULL,
1829 object_release_link_property,
1830 prop);
1831 op->resolve = object_resolve_link_property;
1832 return op;
1835 ObjectProperty *
1836 object_property_add_link(Object *obj, const char *name,
1837 const char *type, Object **targetp,
1838 void (*check)(const Object *, const char *,
1839 Object *, Error **),
1840 ObjectPropertyLinkFlags flags)
1842 return object_add_link_prop(obj, name, type, targetp, check, flags);
1845 ObjectProperty *
1846 object_class_property_add_link(ObjectClass *oc,
1847 const char *name,
1848 const char *type, ptrdiff_t offset,
1849 void (*check)(const Object *obj, const char *name,
1850 Object *val, Error **errp),
1851 ObjectPropertyLinkFlags flags)
1853 LinkProperty *prop = g_new0(LinkProperty, 1);
1854 char *full_type;
1855 ObjectProperty *op;
1857 prop->offset = offset;
1858 prop->check = check;
1859 prop->flags = flags | OBJ_PROP_LINK_CLASS;
1861 full_type = g_strdup_printf("link<%s>", type);
1863 op = object_class_property_add(oc, name, full_type,
1864 object_get_link_property,
1865 check ? object_set_link_property : NULL,
1866 object_release_link_property,
1867 prop);
1869 op->resolve = object_resolve_link_property;
1871 g_free(full_type);
1872 return op;
1875 ObjectProperty *
1876 object_property_add_const_link(Object *obj, const char *name,
1877 Object *target)
1879 return object_add_link_prop(obj, name,
1880 object_get_typename(target), target,
1881 NULL, OBJ_PROP_LINK_DIRECT);
1884 char *object_get_canonical_path_component(Object *obj)
1886 ObjectProperty *prop = NULL;
1887 GHashTableIter iter;
1889 if (obj->parent == NULL) {
1890 return NULL;
1893 g_hash_table_iter_init(&iter, obj->parent->properties);
1894 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
1895 if (!object_property_is_child(prop)) {
1896 continue;
1899 if (prop->opaque == obj) {
1900 return g_strdup(prop->name);
1904 /* obj had a parent but was not a child, should never happen */
1905 g_assert_not_reached();
1906 return NULL;
1909 char *object_get_canonical_path(Object *obj)
1911 Object *root = object_get_root();
1912 char *newpath, *path = NULL;
1914 if (obj == root) {
1915 return g_strdup("/");
1918 do {
1919 char *component = object_get_canonical_path_component(obj);
1921 if (!component) {
1922 /* A canonical path must be complete, so discard what was
1923 * collected so far.
1925 g_free(path);
1926 return NULL;
1929 newpath = g_strdup_printf("/%s%s", component, path ? path : "");
1930 g_free(path);
1931 g_free(component);
1932 path = newpath;
1933 obj = obj->parent;
1934 } while (obj != root);
1936 return path;
1939 Object *object_resolve_path_component(Object *parent, const char *part)
1941 ObjectProperty *prop = object_property_find(parent, part, NULL);
1942 if (prop == NULL) {
1943 return NULL;
1946 if (prop->resolve) {
1947 return prop->resolve(parent, prop->opaque, part);
1948 } else {
1949 return NULL;
1953 static Object *object_resolve_abs_path(Object *parent,
1954 char **parts,
1955 const char *typename)
1957 Object *child;
1959 if (*parts == NULL) {
1960 return object_dynamic_cast(parent, typename);
1963 if (strcmp(*parts, "") == 0) {
1964 return object_resolve_abs_path(parent, parts + 1, typename);
1967 child = object_resolve_path_component(parent, *parts);
1968 if (!child) {
1969 return NULL;
1972 return object_resolve_abs_path(child, parts + 1, typename);
1975 static Object *object_resolve_partial_path(Object *parent,
1976 char **parts,
1977 const char *typename,
1978 bool *ambiguous)
1980 Object *obj;
1981 GHashTableIter iter;
1982 ObjectProperty *prop;
1984 obj = object_resolve_abs_path(parent, parts, typename);
1986 g_hash_table_iter_init(&iter, parent->properties);
1987 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
1988 Object *found;
1990 if (!object_property_is_child(prop)) {
1991 continue;
1994 found = object_resolve_partial_path(prop->opaque, parts,
1995 typename, ambiguous);
1996 if (found) {
1997 if (obj) {
1998 *ambiguous = true;
1999 return NULL;
2001 obj = found;
2004 if (*ambiguous) {
2005 return NULL;
2009 return obj;
2012 Object *object_resolve_path_type(const char *path, const char *typename,
2013 bool *ambiguousp)
2015 Object *obj;
2016 char **parts;
2018 parts = g_strsplit(path, "/", 0);
2019 assert(parts);
2021 if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
2022 bool ambiguous = false;
2023 obj = object_resolve_partial_path(object_get_root(), parts,
2024 typename, &ambiguous);
2025 if (ambiguousp) {
2026 *ambiguousp = ambiguous;
2028 } else {
2029 obj = object_resolve_abs_path(object_get_root(), parts + 1, typename);
2032 g_strfreev(parts);
2034 return obj;
2037 Object *object_resolve_path(const char *path, bool *ambiguous)
2039 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
2042 typedef struct StringProperty
2044 char *(*get)(Object *, Error **);
2045 void (*set)(Object *, const char *, Error **);
2046 } StringProperty;
2048 static void property_get_str(Object *obj, Visitor *v, const char *name,
2049 void *opaque, Error **errp)
2051 StringProperty *prop = opaque;
2052 char *value;
2053 Error *err = NULL;
2055 value = prop->get(obj, &err);
2056 if (err) {
2057 error_propagate(errp, err);
2058 return;
2061 visit_type_str(v, name, &value, errp);
2062 g_free(value);
2065 static void property_set_str(Object *obj, Visitor *v, const char *name,
2066 void *opaque, Error **errp)
2068 StringProperty *prop = opaque;
2069 char *value;
2070 Error *local_err = NULL;
2072 visit_type_str(v, name, &value, &local_err);
2073 if (local_err) {
2074 error_propagate(errp, local_err);
2075 return;
2078 prop->set(obj, value, errp);
2079 g_free(value);
2082 static void property_release_str(Object *obj, const char *name,
2083 void *opaque)
2085 StringProperty *prop = opaque;
2086 g_free(prop);
2089 ObjectProperty *
2090 object_property_add_str(Object *obj, const char *name,
2091 char *(*get)(Object *, Error **),
2092 void (*set)(Object *, const char *, Error **))
2094 StringProperty *prop = g_malloc0(sizeof(*prop));
2096 prop->get = get;
2097 prop->set = set;
2099 return object_property_add(obj, name, "string",
2100 get ? property_get_str : NULL,
2101 set ? property_set_str : NULL,
2102 property_release_str,
2103 prop);
2106 ObjectProperty *
2107 object_class_property_add_str(ObjectClass *klass, const char *name,
2108 char *(*get)(Object *, Error **),
2109 void (*set)(Object *, const char *,
2110 Error **))
2112 StringProperty *prop = g_malloc0(sizeof(*prop));
2114 prop->get = get;
2115 prop->set = set;
2117 return object_class_property_add(klass, name, "string",
2118 get ? property_get_str : NULL,
2119 set ? property_set_str : NULL,
2120 NULL,
2121 prop);
2124 typedef struct BoolProperty
2126 bool (*get)(Object *, Error **);
2127 void (*set)(Object *, bool, Error **);
2128 } BoolProperty;
2130 static void property_get_bool(Object *obj, Visitor *v, const char *name,
2131 void *opaque, Error **errp)
2133 BoolProperty *prop = opaque;
2134 bool value;
2135 Error *err = NULL;
2137 value = prop->get(obj, &err);
2138 if (err) {
2139 error_propagate(errp, err);
2140 return;
2143 visit_type_bool(v, name, &value, errp);
2146 static void property_set_bool(Object *obj, Visitor *v, const char *name,
2147 void *opaque, Error **errp)
2149 BoolProperty *prop = opaque;
2150 bool value;
2151 Error *local_err = NULL;
2153 visit_type_bool(v, name, &value, &local_err);
2154 if (local_err) {
2155 error_propagate(errp, local_err);
2156 return;
2159 prop->set(obj, value, errp);
2162 static void property_release_bool(Object *obj, const char *name,
2163 void *opaque)
2165 BoolProperty *prop = opaque;
2166 g_free(prop);
2169 ObjectProperty *
2170 object_property_add_bool(Object *obj, const char *name,
2171 bool (*get)(Object *, Error **),
2172 void (*set)(Object *, bool, Error **))
2174 BoolProperty *prop = g_malloc0(sizeof(*prop));
2176 prop->get = get;
2177 prop->set = set;
2179 return object_property_add(obj, name, "bool",
2180 get ? property_get_bool : NULL,
2181 set ? property_set_bool : NULL,
2182 property_release_bool,
2183 prop);
2186 ObjectProperty *
2187 object_class_property_add_bool(ObjectClass *klass, const char *name,
2188 bool (*get)(Object *, Error **),
2189 void (*set)(Object *, bool, Error **))
2191 BoolProperty *prop = g_malloc0(sizeof(*prop));
2193 prop->get = get;
2194 prop->set = set;
2196 return object_class_property_add(klass, name, "bool",
2197 get ? property_get_bool : NULL,
2198 set ? property_set_bool : NULL,
2199 NULL,
2200 prop);
2203 static void property_get_enum(Object *obj, Visitor *v, const char *name,
2204 void *opaque, Error **errp)
2206 EnumProperty *prop = opaque;
2207 int value;
2208 Error *err = NULL;
2210 value = prop->get(obj, &err);
2211 if (err) {
2212 error_propagate(errp, err);
2213 return;
2216 visit_type_enum(v, name, &value, prop->lookup, errp);
2219 static void property_set_enum(Object *obj, Visitor *v, const char *name,
2220 void *opaque, Error **errp)
2222 EnumProperty *prop = opaque;
2223 int value;
2224 Error *err = NULL;
2226 visit_type_enum(v, name, &value, prop->lookup, &err);
2227 if (err) {
2228 error_propagate(errp, err);
2229 return;
2231 prop->set(obj, value, errp);
2234 static void property_release_enum(Object *obj, const char *name,
2235 void *opaque)
2237 EnumProperty *prop = opaque;
2238 g_free(prop);
2241 ObjectProperty *
2242 object_property_add_enum(Object *obj, const char *name,
2243 const char *typename,
2244 const QEnumLookup *lookup,
2245 int (*get)(Object *, Error **),
2246 void (*set)(Object *, int, Error **))
2248 EnumProperty *prop = g_malloc(sizeof(*prop));
2250 prop->lookup = lookup;
2251 prop->get = get;
2252 prop->set = set;
2254 return object_property_add(obj, name, typename,
2255 get ? property_get_enum : NULL,
2256 set ? property_set_enum : NULL,
2257 property_release_enum,
2258 prop);
2261 ObjectProperty *
2262 object_class_property_add_enum(ObjectClass *klass, const char *name,
2263 const char *typename,
2264 const QEnumLookup *lookup,
2265 int (*get)(Object *, Error **),
2266 void (*set)(Object *, int, Error **))
2268 EnumProperty *prop = g_malloc(sizeof(*prop));
2270 prop->lookup = lookup;
2271 prop->get = get;
2272 prop->set = set;
2274 return object_class_property_add(klass, name, typename,
2275 get ? property_get_enum : NULL,
2276 set ? property_set_enum : NULL,
2277 NULL,
2278 prop);
2281 typedef struct TMProperty {
2282 void (*get)(Object *, struct tm *, Error **);
2283 } TMProperty;
2285 static void property_get_tm(Object *obj, Visitor *v, const char *name,
2286 void *opaque, Error **errp)
2288 TMProperty *prop = opaque;
2289 Error *err = NULL;
2290 struct tm value;
2292 prop->get(obj, &value, &err);
2293 if (err) {
2294 goto out;
2297 visit_start_struct(v, name, NULL, 0, &err);
2298 if (err) {
2299 goto out;
2301 visit_type_int32(v, "tm_year", &value.tm_year, &err);
2302 if (err) {
2303 goto out_end;
2305 visit_type_int32(v, "tm_mon", &value.tm_mon, &err);
2306 if (err) {
2307 goto out_end;
2309 visit_type_int32(v, "tm_mday", &value.tm_mday, &err);
2310 if (err) {
2311 goto out_end;
2313 visit_type_int32(v, "tm_hour", &value.tm_hour, &err);
2314 if (err) {
2315 goto out_end;
2317 visit_type_int32(v, "tm_min", &value.tm_min, &err);
2318 if (err) {
2319 goto out_end;
2321 visit_type_int32(v, "tm_sec", &value.tm_sec, &err);
2322 if (err) {
2323 goto out_end;
2325 visit_check_struct(v, &err);
2326 out_end:
2327 visit_end_struct(v, NULL);
2328 out:
2329 error_propagate(errp, err);
2333 static void property_release_tm(Object *obj, const char *name,
2334 void *opaque)
2336 TMProperty *prop = opaque;
2337 g_free(prop);
2340 ObjectProperty *
2341 object_property_add_tm(Object *obj, const char *name,
2342 void (*get)(Object *, struct tm *, Error **))
2344 TMProperty *prop = g_malloc0(sizeof(*prop));
2346 prop->get = get;
2348 return object_property_add(obj, name, "struct tm",
2349 get ? property_get_tm : NULL, NULL,
2350 property_release_tm,
2351 prop);
2354 ObjectProperty *
2355 object_class_property_add_tm(ObjectClass *klass, const char *name,
2356 void (*get)(Object *, struct tm *, Error **))
2358 TMProperty *prop = g_malloc0(sizeof(*prop));
2360 prop->get = get;
2362 return object_class_property_add(klass, name, "struct tm",
2363 get ? property_get_tm : NULL,
2364 NULL, NULL, prop);
2367 static char *qdev_get_type(Object *obj, Error **errp)
2369 return g_strdup(object_get_typename(obj));
2372 static void property_get_uint8_ptr(Object *obj, Visitor *v, const char *name,
2373 void *opaque, Error **errp)
2375 uint8_t value = *(uint8_t *)opaque;
2376 visit_type_uint8(v, name, &value, errp);
2379 static void property_set_uint8_ptr(Object *obj, Visitor *v, const char *name,
2380 void *opaque, Error **errp)
2382 uint8_t *field = opaque;
2383 uint8_t value;
2384 Error *local_err = NULL;
2386 visit_type_uint8(v, name, &value, &local_err);
2387 if (local_err) {
2388 error_propagate(errp, local_err);
2389 return;
2392 *field = value;
2395 static void property_get_uint16_ptr(Object *obj, Visitor *v, const char *name,
2396 void *opaque, Error **errp)
2398 uint16_t value = *(uint16_t *)opaque;
2399 visit_type_uint16(v, name, &value, errp);
2402 static void property_set_uint16_ptr(Object *obj, Visitor *v, const char *name,
2403 void *opaque, Error **errp)
2405 uint16_t *field = opaque;
2406 uint16_t value;
2407 Error *local_err = NULL;
2409 visit_type_uint16(v, name, &value, &local_err);
2410 if (local_err) {
2411 error_propagate(errp, local_err);
2412 return;
2415 *field = value;
2418 static void property_get_uint32_ptr(Object *obj, Visitor *v, const char *name,
2419 void *opaque, Error **errp)
2421 uint32_t value = *(uint32_t *)opaque;
2422 visit_type_uint32(v, name, &value, errp);
2425 static void property_set_uint32_ptr(Object *obj, Visitor *v, const char *name,
2426 void *opaque, Error **errp)
2428 uint32_t *field = opaque;
2429 uint32_t value;
2430 Error *local_err = NULL;
2432 visit_type_uint32(v, name, &value, &local_err);
2433 if (local_err) {
2434 error_propagate(errp, local_err);
2435 return;
2438 *field = value;
2441 static void property_get_uint64_ptr(Object *obj, Visitor *v, const char *name,
2442 void *opaque, Error **errp)
2444 uint64_t value = *(uint64_t *)opaque;
2445 visit_type_uint64(v, name, &value, errp);
2448 static void property_set_uint64_ptr(Object *obj, Visitor *v, const char *name,
2449 void *opaque, Error **errp)
2451 uint64_t *field = opaque;
2452 uint64_t value;
2453 Error *local_err = NULL;
2455 visit_type_uint64(v, name, &value, &local_err);
2456 if (local_err) {
2457 error_propagate(errp, local_err);
2458 return;
2461 *field = value;
2464 ObjectProperty *
2465 object_property_add_uint8_ptr(Object *obj, const char *name,
2466 const uint8_t *v,
2467 ObjectPropertyFlags flags)
2469 ObjectPropertyAccessor *getter = NULL;
2470 ObjectPropertyAccessor *setter = NULL;
2472 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2473 getter = property_get_uint8_ptr;
2476 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2477 setter = property_set_uint8_ptr;
2480 return object_property_add(obj, name, "uint8",
2481 getter, setter, NULL, (void *)v);
2484 ObjectProperty *
2485 object_class_property_add_uint8_ptr(ObjectClass *klass, const char *name,
2486 const uint8_t *v,
2487 ObjectPropertyFlags flags)
2489 ObjectPropertyAccessor *getter = NULL;
2490 ObjectPropertyAccessor *setter = NULL;
2492 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2493 getter = property_get_uint8_ptr;
2496 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2497 setter = property_set_uint8_ptr;
2500 return object_class_property_add(klass, name, "uint8",
2501 getter, setter, NULL, (void *)v);
2504 ObjectProperty *
2505 object_property_add_uint16_ptr(Object *obj, const char *name,
2506 const uint16_t *v,
2507 ObjectPropertyFlags flags)
2509 ObjectPropertyAccessor *getter = NULL;
2510 ObjectPropertyAccessor *setter = NULL;
2512 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2513 getter = property_get_uint16_ptr;
2516 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2517 setter = property_set_uint16_ptr;
2520 return object_property_add(obj, name, "uint16",
2521 getter, setter, NULL, (void *)v);
2524 ObjectProperty *
2525 object_class_property_add_uint16_ptr(ObjectClass *klass, const char *name,
2526 const uint16_t *v,
2527 ObjectPropertyFlags flags)
2529 ObjectPropertyAccessor *getter = NULL;
2530 ObjectPropertyAccessor *setter = NULL;
2532 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2533 getter = property_get_uint16_ptr;
2536 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2537 setter = property_set_uint16_ptr;
2540 return object_class_property_add(klass, name, "uint16",
2541 getter, setter, NULL, (void *)v);
2544 ObjectProperty *
2545 object_property_add_uint32_ptr(Object *obj, const char *name,
2546 const uint32_t *v,
2547 ObjectPropertyFlags flags)
2549 ObjectPropertyAccessor *getter = NULL;
2550 ObjectPropertyAccessor *setter = NULL;
2552 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2553 getter = property_get_uint32_ptr;
2556 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2557 setter = property_set_uint32_ptr;
2560 return object_property_add(obj, name, "uint32",
2561 getter, setter, NULL, (void *)v);
2564 ObjectProperty *
2565 object_class_property_add_uint32_ptr(ObjectClass *klass, const char *name,
2566 const uint32_t *v,
2567 ObjectPropertyFlags flags)
2569 ObjectPropertyAccessor *getter = NULL;
2570 ObjectPropertyAccessor *setter = NULL;
2572 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2573 getter = property_get_uint32_ptr;
2576 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2577 setter = property_set_uint32_ptr;
2580 return object_class_property_add(klass, name, "uint32",
2581 getter, setter, NULL, (void *)v);
2584 ObjectProperty *
2585 object_property_add_uint64_ptr(Object *obj, const char *name,
2586 const uint64_t *v,
2587 ObjectPropertyFlags flags)
2589 ObjectPropertyAccessor *getter = NULL;
2590 ObjectPropertyAccessor *setter = NULL;
2592 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2593 getter = property_get_uint64_ptr;
2596 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2597 setter = property_set_uint64_ptr;
2600 return object_property_add(obj, name, "uint64",
2601 getter, setter, NULL, (void *)v);
2604 ObjectProperty *
2605 object_class_property_add_uint64_ptr(ObjectClass *klass, const char *name,
2606 const uint64_t *v,
2607 ObjectPropertyFlags flags)
2609 ObjectPropertyAccessor *getter = NULL;
2610 ObjectPropertyAccessor *setter = NULL;
2612 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2613 getter = property_get_uint64_ptr;
2616 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2617 setter = property_set_uint64_ptr;
2620 return object_class_property_add(klass, name, "uint64",
2621 getter, setter, NULL, (void *)v);
2624 typedef struct {
2625 Object *target_obj;
2626 char *target_name;
2627 } AliasProperty;
2629 static void property_get_alias(Object *obj, Visitor *v, const char *name,
2630 void *opaque, Error **errp)
2632 AliasProperty *prop = opaque;
2634 object_property_get(prop->target_obj, v, prop->target_name, errp);
2637 static void property_set_alias(Object *obj, Visitor *v, const char *name,
2638 void *opaque, Error **errp)
2640 AliasProperty *prop = opaque;
2642 object_property_set(prop->target_obj, v, prop->target_name, errp);
2645 static Object *property_resolve_alias(Object *obj, void *opaque,
2646 const char *part)
2648 AliasProperty *prop = opaque;
2650 return object_resolve_path_component(prop->target_obj, prop->target_name);
2653 static void property_release_alias(Object *obj, const char *name, void *opaque)
2655 AliasProperty *prop = opaque;
2657 g_free(prop->target_name);
2658 g_free(prop);
2661 ObjectProperty *
2662 object_property_add_alias(Object *obj, const char *name,
2663 Object *target_obj, const char *target_name)
2665 AliasProperty *prop;
2666 ObjectProperty *op;
2667 ObjectProperty *target_prop;
2668 g_autofree char *prop_type = NULL;
2670 target_prop = object_property_find(target_obj, target_name,
2671 &error_abort);
2673 if (object_property_is_child(target_prop)) {
2674 prop_type = g_strdup_printf("link%s",
2675 target_prop->type + strlen("child"));
2676 } else {
2677 prop_type = g_strdup(target_prop->type);
2680 prop = g_malloc(sizeof(*prop));
2681 prop->target_obj = target_obj;
2682 prop->target_name = g_strdup(target_name);
2684 op = object_property_add(obj, name, prop_type,
2685 property_get_alias,
2686 property_set_alias,
2687 property_release_alias,
2688 prop);
2689 op->resolve = property_resolve_alias;
2690 if (target_prop->defval) {
2691 op->defval = qobject_ref(target_prop->defval);
2694 object_property_set_description(obj, op->name,
2695 target_prop->description);
2696 return op;
2699 void object_property_set_description(Object *obj, const char *name,
2700 const char *description)
2702 ObjectProperty *op;
2704 op = object_property_find(obj, name, &error_abort);
2705 g_free(op->description);
2706 op->description = g_strdup(description);
2709 void object_class_property_set_description(ObjectClass *klass,
2710 const char *name,
2711 const char *description)
2713 ObjectProperty *op;
2715 op = g_hash_table_lookup(klass->properties, name);
2716 g_free(op->description);
2717 op->description = g_strdup(description);
2720 static void object_class_init(ObjectClass *klass, void *data)
2722 object_class_property_add_str(klass, "type", qdev_get_type,
2723 NULL);
2726 static void register_types(void)
2728 static TypeInfo interface_info = {
2729 .name = TYPE_INTERFACE,
2730 .class_size = sizeof(InterfaceClass),
2731 .abstract = true,
2734 static TypeInfo object_info = {
2735 .name = TYPE_OBJECT,
2736 .instance_size = sizeof(Object),
2737 .class_init = object_class_init,
2738 .abstract = true,
2741 type_interface = type_register_internal(&interface_info);
2742 type_register_internal(&object_info);
2745 type_init(register_types)