blob: e89ffbe3d10c1b6815ed4c75bc0544e565f096fb [file] [log] [blame]
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001/*
2 * QEMU Object Model
3 *
4 * Copyright IBM, Corp. 2011
5 *
6 * Authors:
7 * Anthony Liguori <aliguori@us.ibm.com>
8 *
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.
11 */
12
Peter Maydell9bbc8532016-01-29 17:50:02 +000013#include "qemu/osdep.h"
Markus Armbruster13d4ff02019-08-12 07:23:37 +020014#include "hw/qdev-core.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010015#include "qapi/error.h"
Paolo Bonzini14cccb62012-12-17 18:19:50 +010016#include "qom/object.h"
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +010017#include "qom/object_interfaces.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020018#include "qemu/cutils.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010019#include "qapi/visitor.h"
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +010020#include "qapi/string-input-visitor.h"
21#include "qapi/string-output-visitor.h"
Marc-André Lureau0e76ed02020-01-10 19:30:23 +040022#include "qapi/qobject-input-visitor.h"
Markus Armbrustereb815e22018-02-11 10:36:05 +010023#include "qapi/qapi-builtin-visit.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010024#include "qapi/qmp/qerror.h"
Marc-André Lureau0e76ed02020-01-10 19:30:23 +040025#include "qapi/qmp/qjson.h"
Paolo Bonzinifa131d92013-05-10 14:16:39 +020026#include "trace.h"
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060027
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +010028/* TODO: replace QObject with a simpler visitor to avoid a dependency
29 * of the QOM core on QObject? */
Paolo Bonzini14cccb62012-12-17 18:19:50 +010030#include "qom/qom-qobject.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010031#include "qapi/qmp/qbool.h"
Markus Armbruster15280c32018-02-01 12:18:36 +010032#include "qapi/qmp/qnum.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010033#include "qapi/qmp/qstring.h"
Philippe Mathieu-Daudée02bdf12019-04-27 15:56:42 +020034#include "qemu/error-report.h"
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +010035
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060036#define MAX_INTERFACES 32
37
38typedef struct InterfaceImpl InterfaceImpl;
39typedef struct TypeImpl TypeImpl;
40
41struct InterfaceImpl
42{
Anthony Liguori33e95c62012-08-10 13:16:10 +100043 const char *typename;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060044};
45
46struct TypeImpl
47{
48 const char *name;
49
50 size_t class_size;
51
52 size_t instance_size;
53
54 void (*class_init)(ObjectClass *klass, void *data);
Paolo Bonzini3b50e312012-05-02 13:30:55 +020055 void (*class_base_init)(ObjectClass *klass, void *data);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060056
57 void *class_data;
58
59 void (*instance_init)(Object *obj);
Eduardo Habkost8231c2d2013-07-10 17:08:41 -030060 void (*instance_post_init)(Object *obj);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060061 void (*instance_finalize)(Object *obj);
62
63 bool abstract;
64
65 const char *parent;
66 TypeImpl *parent_type;
67
68 ObjectClass *class;
69
70 int num_interfaces;
71 InterfaceImpl interfaces[MAX_INTERFACES];
72};
73
Paolo Bonzini9970bd82012-02-03 11:51:39 +010074static Type type_interface;
75
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060076static GHashTable *type_table_get(void)
77{
78 static GHashTable *type_table;
79
80 if (type_table == NULL) {
81 type_table = g_hash_table_new(g_str_hash, g_str_equal);
82 }
83
84 return type_table;
85}
86
Hervé Poussineauf54c19c2013-12-03 16:42:00 +010087static bool enumerating_types;
88
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060089static void type_table_add(TypeImpl *ti)
90{
Hervé Poussineauf54c19c2013-12-03 16:42:00 +010091 assert(!enumerating_types);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060092 g_hash_table_insert(type_table_get(), (void *)ti->name, ti);
93}
94
95static TypeImpl *type_table_lookup(const char *name)
96{
97 return g_hash_table_lookup(type_table_get(), name);
98}
99
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100100static TypeImpl *type_new(const TypeInfo *info)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600101{
102 TypeImpl *ti = g_malloc0(sizeof(*ti));
Anthony Liguori33e95c62012-08-10 13:16:10 +1000103 int i;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600104
105 g_assert(info->name != NULL);
106
Anthony Liguori73093352012-01-25 13:37:36 -0600107 if (type_table_lookup(info->name) != NULL) {
108 fprintf(stderr, "Registering `%s' which already exists\n", info->name);
109 abort();
110 }
111
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600112 ti->name = g_strdup(info->name);
113 ti->parent = g_strdup(info->parent);
114
115 ti->class_size = info->class_size;
116 ti->instance_size = info->instance_size;
117
118 ti->class_init = info->class_init;
Paolo Bonzini3b50e312012-05-02 13:30:55 +0200119 ti->class_base_init = info->class_base_init;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600120 ti->class_data = info->class_data;
121
122 ti->instance_init = info->instance_init;
Eduardo Habkost8231c2d2013-07-10 17:08:41 -0300123 ti->instance_post_init = info->instance_post_init;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600124 ti->instance_finalize = info->instance_finalize;
125
126 ti->abstract = info->abstract;
127
Anthony Liguori33e95c62012-08-10 13:16:10 +1000128 for (i = 0; info->interfaces && info->interfaces[i].type; i++) {
129 ti->interfaces[i].typename = g_strdup(info->interfaces[i].type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600130 }
Anthony Liguori33e95c62012-08-10 13:16:10 +1000131 ti->num_interfaces = i;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600132
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100133 return ti;
134}
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600135
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100136static TypeImpl *type_register_internal(const TypeInfo *info)
137{
138 TypeImpl *ti;
139 ti = type_new(info);
140
141 type_table_add(ti);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600142 return ti;
143}
144
Paolo Bonzini049cb3c2012-04-04 15:58:40 +0200145TypeImpl *type_register(const TypeInfo *info)
146{
147 assert(info->parent);
148 return type_register_internal(info);
149}
150
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600151TypeImpl *type_register_static(const TypeInfo *info)
152{
153 return type_register(info);
154}
155
Igor Mammedovaa04c9d22017-10-09 21:50:49 +0200156void type_register_static_array(const TypeInfo *infos, int nr_infos)
157{
158 int i;
159
160 for (i = 0; i < nr_infos; i++) {
161 type_register_static(&infos[i]);
162 }
163}
164
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600165static TypeImpl *type_get_by_name(const char *name)
166{
167 if (name == NULL) {
168 return NULL;
169 }
170
171 return type_table_lookup(name);
172}
173
174static TypeImpl *type_get_parent(TypeImpl *type)
175{
176 if (!type->parent_type && type->parent) {
177 type->parent_type = type_get_by_name(type->parent);
Philippe Mathieu-Daudé89d337f2020-01-21 12:03:45 +0100178 if (!type->parent_type) {
179 fprintf(stderr, "Type '%s' is missing its parent '%s'\n",
180 type->name, type->parent);
181 abort();
182 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600183 }
184
185 return type->parent_type;
186}
187
188static bool type_has_parent(TypeImpl *type)
189{
190 return (type->parent != NULL);
191}
192
193static size_t type_class_get_size(TypeImpl *ti)
194{
195 if (ti->class_size) {
196 return ti->class_size;
197 }
198
199 if (type_has_parent(ti)) {
200 return type_class_get_size(type_get_parent(ti));
201 }
202
203 return sizeof(ObjectClass);
204}
205
Igor Mitsyankoaca59af2012-02-28 15:57:10 +0400206static size_t type_object_get_size(TypeImpl *ti)
207{
208 if (ti->instance_size) {
209 return ti->instance_size;
210 }
211
212 if (type_has_parent(ti)) {
213 return type_object_get_size(type_get_parent(ti));
214 }
215
216 return 0;
217}
218
Bharata B Rao3f97b532016-06-10 06:29:00 +0530219size_t object_type_get_instance_size(const char *typename)
220{
221 TypeImpl *type = type_get_by_name(typename);
222
223 g_assert(type != NULL);
224 return type_object_get_size(type);
225}
226
Anthony Liguori33e95c62012-08-10 13:16:10 +1000227static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600228{
Anthony Liguori33e95c62012-08-10 13:16:10 +1000229 assert(target_type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600230
Cao jinb30d8052015-11-03 10:36:42 +0800231 /* Check if target_type is a direct ancestor of type */
Anthony Liguori33e95c62012-08-10 13:16:10 +1000232 while (type) {
233 if (type == target_type) {
234 return true;
235 }
236
237 type = type_get_parent(type);
238 }
239
240 return false;
241}
242
243static void type_initialize(TypeImpl *ti);
244
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100245static void type_initialize_interface(TypeImpl *ti, TypeImpl *interface_type,
246 TypeImpl *parent_type)
Anthony Liguori33e95c62012-08-10 13:16:10 +1000247{
248 InterfaceClass *new_iface;
249 TypeInfo info = { };
250 TypeImpl *iface_impl;
251
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100252 info.parent = parent_type->name;
253 info.name = g_strdup_printf("%s::%s", ti->name, interface_type->name);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000254 info.abstract = true;
255
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100256 iface_impl = type_new(&info);
257 iface_impl->parent_type = parent_type;
Anthony Liguori33e95c62012-08-10 13:16:10 +1000258 type_initialize(iface_impl);
259 g_free((char *)info.name);
260
261 new_iface = (InterfaceClass *)iface_impl->class;
262 new_iface->concrete_class = ti->class;
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100263 new_iface->interface_type = interface_type;
Anthony Liguori33e95c62012-08-10 13:16:10 +1000264
265 ti->class->interfaces = g_slist_append(ti->class->interfaces,
266 iface_impl->class);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600267}
268
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +0100269static void object_property_free(gpointer data)
270{
271 ObjectProperty *prop = data;
272
Marc-André Lureau0e76ed02020-01-10 19:30:23 +0400273 if (prop->defval) {
274 qobject_unref(prop->defval);
275 prop->defval = NULL;
276 }
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +0100277 g_free(prop->name);
278 g_free(prop->type);
279 g_free(prop->description);
280 g_free(prop);
281}
282
Igor Mitsyankoac451032012-02-28 15:57:11 +0400283static void type_initialize(TypeImpl *ti)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600284{
Paolo Bonzini745549c2012-03-31 16:45:54 +0200285 TypeImpl *parent;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600286
287 if (ti->class) {
288 return;
289 }
290
291 ti->class_size = type_class_get_size(ti);
Igor Mitsyankoaca59af2012-02-28 15:57:10 +0400292 ti->instance_size = type_object_get_size(ti);
Eduardo Habkost1c6d75d2016-12-12 16:31:01 -0200293 /* Any type with zero instance_size is implicitly abstract.
294 * This means interface types are all abstract.
295 */
296 if (ti->instance_size == 0) {
297 ti->abstract = true;
298 }
Marc-André Lureau422ca142018-09-12 16:53:03 +0400299 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);
306 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600307 ti->class = g_malloc0(ti->class_size);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600308
Paolo Bonzini745549c2012-03-31 16:45:54 +0200309 parent = type_get_parent(ti);
310 if (parent) {
Igor Mitsyankoac451032012-02-28 15:57:11 +0400311 type_initialize(parent);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000312 GSList *e;
313 int i;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600314
Markus Armbruster719a3072018-06-08 19:02:31 +0200315 g_assert(parent->class_size <= ti->class_size);
Marc-André Lureaud5e633f2020-01-10 19:30:14 +0400316 g_assert(parent->instance_size <= ti->instance_size);
Paolo Bonzini745549c2012-03-31 16:45:54 +0200317 memcpy(ti->class, parent->class, parent->class_size);
Peter Crosthwaite3e407de2013-02-19 14:02:09 +1000318 ti->class->interfaces = NULL;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +0100319 ti->class->properties = g_hash_table_new_full(
Marc-André Lureauba806ff2020-01-10 19:30:18 +0400320 g_str_hash, g_str_equal, NULL, object_property_free);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000321
322 for (e = parent->class->interfaces; e; e = e->next) {
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100323 InterfaceClass *iface = e->data;
324 ObjectClass *klass = OBJECT_CLASS(iface);
325
326 type_initialize_interface(ti, iface->interface_type, klass->type);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000327 }
328
329 for (i = 0; i < ti->num_interfaces; i++) {
330 TypeImpl *t = type_get_by_name(ti->interfaces[i].typename);
Philippe Mathieu-Daudéa9ee3a92020-01-18 17:23:48 +0100331 if (!t) {
332 error_report("missing interface '%s' for object '%s'",
333 ti->interfaces[i].typename, parent->name);
334 abort();
335 }
Anthony Liguori33e95c62012-08-10 13:16:10 +1000336 for (e = ti->class->interfaces; e; e = e->next) {
337 TypeImpl *target_type = OBJECT_CLASS(e->data)->type;
338
339 if (type_is_ancestor(target_type, t)) {
340 break;
341 }
342 }
343
344 if (e) {
345 continue;
346 }
347
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100348 type_initialize_interface(ti, t, t);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000349 }
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +0100350 } else {
351 ti->class->properties = g_hash_table_new_full(
Marc-André Lureauba806ff2020-01-10 19:30:18 +0400352 g_str_hash, g_str_equal, NULL, object_property_free);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600353 }
354
Paolo Bonzini745549c2012-03-31 16:45:54 +0200355 ti->class->type = ti;
356
357 while (parent) {
358 if (parent->class_base_init) {
359 parent->class_base_init(ti->class, ti->class_data);
360 }
361 parent = type_get_parent(parent);
362 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600363
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600364 if (ti->class_init) {
365 ti->class_init(ti->class, ti->class_data);
366 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600367}
368
369static void object_init_with_type(Object *obj, TypeImpl *ti)
370{
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600371 if (type_has_parent(ti)) {
372 object_init_with_type(obj, type_get_parent(ti));
373 }
374
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600375 if (ti->instance_init) {
376 ti->instance_init(obj);
377 }
378}
379
Eduardo Habkost8231c2d2013-07-10 17:08:41 -0300380static void object_post_init_with_type(Object *obj, TypeImpl *ti)
381{
382 if (ti->instance_post_init) {
383 ti->instance_post_init(obj);
384 }
385
386 if (type_has_parent(ti)) {
387 object_post_init_with_type(obj, type_get_parent(ti));
388 }
389}
390
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400391void object_apply_global_props(Object *obj, const GPtrArray *props, Error **errp)
392{
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400393 int i;
394
395 if (!props) {
396 return;
397 }
398
399 for (i = 0; i < props->len; i++) {
400 GlobalProperty *p = g_ptr_array_index(props, i);
Eduardo Habkostd769f0d2019-01-10 00:02:57 -0200401 Error *err = NULL;
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400402
403 if (object_dynamic_cast(obj, p->driver) == NULL) {
404 continue;
405 }
Dr. David Alan Gilbert92fd4532019-07-29 17:29:02 +0100406 if (p->optional && !object_property_find(obj, p->property, NULL)) {
407 continue;
408 }
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400409 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);
Marc-André Lureau50545b22018-11-07 15:35:34 +0400414 /*
415 * If errp != NULL, propagate error and return.
416 * If errp == NULL, report a warning, but keep going
417 * with the remaining globals.
418 */
419 if (errp) {
420 error_propagate(errp, err);
421 return;
422 } else {
423 warn_report_err(err);
424 }
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400425 }
426 }
427}
428
Markus Armbruster617902a2019-03-08 14:14:35 +0100429/*
430 * Global property defaults
431 * Slot 0: accelerator's global property defaults
432 * Slot 1: machine's global property defaults
Paolo Bonzini1fff3c22019-11-13 13:33:44 +0100433 * Slot 2: global properties from legacy command line option
Markus Armbruster617902a2019-03-08 14:14:35 +0100434 * Each is a GPtrArray of of GlobalProperty.
435 * Applied in order, later entries override earlier ones.
436 */
Paolo Bonzini1fff3c22019-11-13 13:33:44 +0100437static GPtrArray *object_compat_props[3];
438
439/*
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.
443 */
444void object_register_sugar_prop(const char *driver, const char *prop, const char *value)
445{
446 GlobalProperty *g;
447 if (!object_compat_props[2]) {
448 object_compat_props[2] = g_ptr_array_new();
449 }
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);
455}
Markus Armbruster617902a2019-03-08 14:14:35 +0100456
457/*
458 * Set machine's global property defaults to @compat_props.
459 * May be called at most once.
460 */
461void object_set_machine_compat_props(GPtrArray *compat_props)
462{
463 assert(!object_compat_props[1]);
464 object_compat_props[1] = compat_props;
465}
466
467/*
468 * Set accelerator's global property defaults to @compat_props.
469 * May be called at most once.
470 */
471void object_set_accelerator_compat_props(GPtrArray *compat_props)
472{
473 assert(!object_compat_props[0]);
474 object_compat_props[0] = compat_props;
475}
476
477void object_apply_compat_props(Object *obj)
478{
479 int i;
480
481 for (i = 0; i < ARRAY_SIZE(object_compat_props); i++) {
482 object_apply_global_props(obj, object_compat_props[i],
Paolo Bonzini1fff3c22019-11-13 13:33:44 +0100483 i == 2 ? &error_fatal : &error_abort);
Markus Armbruster617902a2019-03-08 14:14:35 +0100484 }
485}
486
Marc-André Lureau2a1be4b2020-01-10 19:30:19 +0400487static void object_class_property_init_all(Object *obj)
488{
489 ObjectPropertyIterator iter;
490 ObjectProperty *prop;
491
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);
496 }
497 }
498}
499
Marc-André Lureau63f7b102016-12-12 20:31:51 +0300500static void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600501{
502 Object *obj = data;
503
Igor Mitsyankoac451032012-02-28 15:57:11 +0400504 type_initialize(type);
Igor Mitsyankoaca59af2012-02-28 15:57:10 +0400505
Markus Armbruster719a3072018-06-08 19:02:31 +0200506 g_assert(type->instance_size >= sizeof(Object));
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600507 g_assert(type->abstract == false);
Markus Armbruster719a3072018-06-08 19:02:31 +0200508 g_assert(size >= type->instance_size);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600509
510 memset(obj, 0, type->instance_size);
511 obj->class = type->class;
Paolo Bonzini764b6312012-11-23 09:47:12 +0100512 object_ref(obj);
Marc-André Lureau2a1be4b2020-01-10 19:30:19 +0400513 object_class_property_init_all(obj);
Pavel Fedinb604a852015-10-13 13:37:45 +0100514 obj->properties = g_hash_table_new_full(g_str_hash, g_str_equal,
515 NULL, object_property_free);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600516 object_init_with_type(obj, type);
Eduardo Habkost8231c2d2013-07-10 17:08:41 -0300517 object_post_init_with_type(obj, type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600518}
519
Andreas Färber213f0c42013-08-23 19:37:12 +0200520void object_initialize(void *data, size_t size, const char *typename)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600521{
522 TypeImpl *type = type_get_by_name(typename);
523
Philippe Mathieu-Daudée02bdf12019-04-27 15:56:42 +0200524 if (!type) {
525 error_report("missing object type '%s'", typename);
526 abort();
527 }
528
Andreas Färber5b9237f2013-08-30 18:28:37 +0200529 object_initialize_with_type(data, size, type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600530}
531
Thomas Huth0210b392018-07-16 14:59:18 +0200532void object_initialize_child(Object *parentobj, const char *propname,
533 void *childobj, size_t size, const char *type,
534 Error **errp, ...)
535{
536 va_list vargs;
537
538 va_start(vargs, errp);
539 object_initialize_childv(parentobj, propname, childobj, size, type, errp,
540 vargs);
541 va_end(vargs);
542}
543
544void object_initialize_childv(Object *parentobj, const char *propname,
545 void *childobj, size_t size, const char *type,
546 Error **errp, va_list vargs)
547{
548 Error *local_err = NULL;
549 Object *obj;
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400550 UserCreatable *uc;
Thomas Huth0210b392018-07-16 14:59:18 +0200551
552 object_initialize(childobj, size, type);
553 obj = OBJECT(childobj);
554
555 object_set_propv(obj, &local_err, vargs);
556 if (local_err) {
557 goto out;
558 }
559
Markus Armbrusterd2623122020-05-05 17:29:22 +0200560 object_property_add_child(parentobj, propname, obj);
Thomas Huth0210b392018-07-16 14:59:18 +0200561
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400562 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
563 if (uc) {
564 user_creatable_complete(uc, &local_err);
Thomas Huth0210b392018-07-16 14:59:18 +0200565 if (local_err) {
566 object_unparent(obj);
567 goto out;
568 }
569 }
570
Markus Armbruster975ac452020-05-05 17:29:09 +0200571out:
Thomas Huth0210b392018-07-16 14:59:18 +0200572 /*
Markus Armbruster975ac452020-05-05 17:29:09 +0200573 * We want @obj's reference to be 1 on success, 0 on failure.
574 * On success, it's 2: one taken by object_initialize(), and one
575 * by object_property_add_child().
576 * On failure in object_initialize() or earlier, it's 1.
577 * On failure afterwards, it's also 1: object_unparent() releases
578 * the reference taken by object_property_add_child().
Thomas Huth0210b392018-07-16 14:59:18 +0200579 */
580 object_unref(obj);
581
Markus Armbruster975ac452020-05-05 17:29:09 +0200582 error_propagate(errp, local_err);
Thomas Huth0210b392018-07-16 14:59:18 +0200583}
584
Andreas Färber5d9d3f42012-05-27 00:32:40 +0200585static inline bool object_property_is_child(ObjectProperty *prop)
586{
587 return strstart(prop->type, "child<", NULL);
588}
589
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600590static void object_property_del_all(Object *obj)
591{
Marc-André Lureau9859fac2020-01-10 19:30:30 +0400592 g_autoptr(GHashTable) done = g_hash_table_new(NULL, NULL);
Pavel Fedinb604a852015-10-13 13:37:45 +0100593 ObjectProperty *prop;
Marc-André Lureau9859fac2020-01-10 19:30:30 +0400594 ObjectPropertyIterator iter;
Pavel Fedinb604a852015-10-13 13:37:45 +0100595 bool released;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600596
Pavel Fedinb604a852015-10-13 13:37:45 +0100597 do {
598 released = false;
Marc-André Lureau9859fac2020-01-10 19:30:30 +0400599 object_property_iter_init(&iter, obj);
600 while ((prop = object_property_iter_next(&iter)) != NULL) {
601 if (g_hash_table_add(done, prop)) {
602 if (prop->release) {
603 prop->release(obj, prop->name, prop->opaque);
604 released = true;
605 break;
606 }
Pavel Fedinb604a852015-10-13 13:37:45 +0100607 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600608 }
Pavel Fedinb604a852015-10-13 13:37:45 +0100609 } while (released);
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600610
Pavel Fedinb604a852015-10-13 13:37:45 +0100611 g_hash_table_unref(obj->properties);
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600612}
613
Markus Armbrusterf73a32a2020-05-05 17:29:11 +0200614static void object_property_del_child(Object *obj, Object *child)
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600615{
616 ObjectProperty *prop;
Pavel Fedinb604a852015-10-13 13:37:45 +0100617 GHashTableIter iter;
618 gpointer key, value;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600619
Pavel Fedinb604a852015-10-13 13:37:45 +0100620 g_hash_table_iter_init(&iter, obj->properties);
621 while (g_hash_table_iter_next(&iter, &key, &value)) {
622 prop = value;
Andreas Färber5d9d3f42012-05-27 00:32:40 +0200623 if (object_property_is_child(prop) && prop->opaque == child) {
Pavel Fedinb604a852015-10-13 13:37:45 +0100624 if (prop->release) {
625 prop->release(obj, prop->name, prop->opaque);
626 prop->release = NULL;
627 }
628 break;
629 }
630 }
631 g_hash_table_iter_init(&iter, obj->properties);
632 while (g_hash_table_iter_next(&iter, &key, &value)) {
633 prop = value;
634 if (object_property_is_child(prop) && prop->opaque == child) {
635 g_hash_table_iter_remove(&iter);
Paolo Bonzini6c1fdcf2012-02-28 09:54:15 +0100636 break;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600637 }
638 }
639}
640
641void object_unparent(Object *obj)
642{
Michael S. Tsirkine998fa82013-03-18 21:01:37 +0200643 if (obj->parent) {
Markus Armbrusterf73a32a2020-05-05 17:29:11 +0200644 object_property_del_child(obj->parent, obj);
Michael S. Tsirkine998fa82013-03-18 21:01:37 +0200645 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600646}
647
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600648static void object_deinit(Object *obj, TypeImpl *type)
649{
650 if (type->instance_finalize) {
651 type->instance_finalize(obj);
652 }
653
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600654 if (type_has_parent(type)) {
655 object_deinit(obj, type_get_parent(type));
656 }
657}
658
Paolo Bonzini339c2702012-11-23 09:47:16 +0100659static void object_finalize(void *data)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600660{
661 Object *obj = data;
662 TypeImpl *ti = obj->class->type;
663
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600664 object_property_del_all(obj);
Paolo Bonzini76a6e1c2014-06-11 11:58:30 +0200665 object_deinit(obj, ti);
Anthony Liguoridb85b572011-12-23 08:47:39 -0600666
Markus Armbruster719a3072018-06-08 19:02:31 +0200667 g_assert(obj->ref == 0);
Paolo Bonzinifde9bf42012-11-23 09:47:14 +0100668 if (obj->free) {
669 obj->free(obj);
670 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600671}
672
Marc-André Lureau63f7b102016-12-12 20:31:51 +0300673static Object *object_new_with_type(Type type)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600674{
675 Object *obj;
676
677 g_assert(type != NULL);
Igor Mitsyankoac451032012-02-28 15:57:11 +0400678 type_initialize(type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600679
680 obj = g_malloc(type->instance_size);
Andreas Färber5b9237f2013-08-30 18:28:37 +0200681 object_initialize_with_type(obj, type->instance_size, type);
Paolo Bonzinifde9bf42012-11-23 09:47:14 +0100682 obj->free = g_free;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600683
684 return obj;
685}
686
Paolo Bonzini3c75e122019-11-13 13:57:55 +0100687Object *object_new_with_class(ObjectClass *klass)
688{
689 return object_new_with_type(klass->type);
690}
691
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600692Object *object_new(const char *typename)
693{
694 TypeImpl *ti = type_get_by_name(typename);
695
696 return object_new_with_type(ti);
697}
698
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100699
700Object *object_new_with_props(const char *typename,
701 Object *parent,
702 const char *id,
703 Error **errp,
704 ...)
705{
706 va_list vargs;
707 Object *obj;
708
709 va_start(vargs, errp);
710 obj = object_new_with_propv(typename, parent, id, errp, vargs);
711 va_end(vargs);
712
713 return obj;
714}
715
716
717Object *object_new_with_propv(const char *typename,
718 Object *parent,
719 const char *id,
720 Error **errp,
721 va_list vargs)
722{
723 Object *obj;
724 ObjectClass *klass;
725 Error *local_err = NULL;
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400726 UserCreatable *uc;
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100727
728 klass = object_class_by_name(typename);
729 if (!klass) {
730 error_setg(errp, "invalid object type: %s", typename);
731 return NULL;
732 }
733
734 if (object_class_is_abstract(klass)) {
735 error_setg(errp, "object type '%s' is abstract", typename);
736 return NULL;
737 }
Wei Yang66e11552019-03-11 16:32:34 +0800738 obj = object_new_with_type(klass->type);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100739
740 if (object_set_propv(obj, &local_err, vargs) < 0) {
741 goto error;
742 }
743
Daniel P. Berrangé6134d752018-06-15 16:39:35 +0100744 if (id != NULL) {
Markus Armbrusterd2623122020-05-05 17:29:22 +0200745 object_property_add_child(parent, id, obj);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100746 }
747
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400748 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
749 if (uc) {
750 user_creatable_complete(uc, &local_err);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100751 if (local_err) {
Daniel P. Berrangé6134d752018-06-15 16:39:35 +0100752 if (id != NULL) {
753 object_unparent(obj);
754 }
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100755 goto error;
756 }
757 }
758
759 object_unref(OBJECT(obj));
760 return obj;
761
762 error:
Eduardo Habkost621ff942016-06-13 18:57:56 -0300763 error_propagate(errp, local_err);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100764 object_unref(obj);
765 return NULL;
766}
767
768
769int object_set_props(Object *obj,
770 Error **errp,
771 ...)
772{
773 va_list vargs;
774 int ret;
775
776 va_start(vargs, errp);
777 ret = object_set_propv(obj, errp, vargs);
778 va_end(vargs);
779
780 return ret;
781}
782
783
784int object_set_propv(Object *obj,
785 Error **errp,
786 va_list vargs)
787{
788 const char *propname;
789 Error *local_err = NULL;
790
791 propname = va_arg(vargs, char *);
792 while (propname != NULL) {
793 const char *value = va_arg(vargs, char *);
794
795 g_assert(value != NULL);
796 object_property_parse(obj, value, propname, &local_err);
797 if (local_err) {
798 error_propagate(errp, local_err);
799 return -1;
800 }
801 propname = va_arg(vargs, char *);
802 }
803
804 return 0;
805}
806
807
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600808Object *object_dynamic_cast(Object *obj, const char *typename)
809{
Paolo Bonzinib7f43fe2012-11-23 16:56:17 +0100810 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
Paolo Bonziniacc4af32012-02-03 11:57:23 +0100811 return obj;
812 }
813
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600814 return NULL;
815}
816
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200817Object *object_dynamic_cast_assert(Object *obj, const char *typename,
818 const char *file, int line, const char *func)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600819{
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200820 trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
821 typename, file, line, func);
822
Paolo Bonzini3556c232013-05-10 14:16:40 +0200823#ifdef CONFIG_QOM_CAST_DEBUG
Anthony Liguori03587322013-05-13 15:22:24 -0500824 int i;
825 Object *inst;
826
Peter Crosthwaite95916ab2013-05-22 11:19:16 +1000827 for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100828 if (atomic_read(&obj->class->object_cast_cache[i]) == typename) {
Anthony Liguori03587322013-05-13 15:22:24 -0500829 goto out;
830 }
831 }
832
833 inst = object_dynamic_cast(obj, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600834
Paolo Bonzinib7f43fe2012-11-23 16:56:17 +0100835 if (!inst && obj) {
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200836 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
837 file, line, func, obj, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600838 abort();
839 }
840
Paolo Bonzini3556c232013-05-10 14:16:40 +0200841 assert(obj == inst);
Anthony Liguori03587322013-05-13 15:22:24 -0500842
Peter Crosthwaite95916ab2013-05-22 11:19:16 +1000843 if (obj && obj == inst) {
Anthony Liguori03587322013-05-13 15:22:24 -0500844 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100845 atomic_set(&obj->class->object_cast_cache[i - 1],
846 atomic_read(&obj->class->object_cast_cache[i]));
Anthony Liguori03587322013-05-13 15:22:24 -0500847 }
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100848 atomic_set(&obj->class->object_cast_cache[i - 1], typename);
Anthony Liguori03587322013-05-13 15:22:24 -0500849 }
850
851out:
Paolo Bonzini3556c232013-05-10 14:16:40 +0200852#endif
853 return obj;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600854}
855
856ObjectClass *object_class_dynamic_cast(ObjectClass *class,
857 const char *typename)
858{
Anthony Liguori33e95c62012-08-10 13:16:10 +1000859 ObjectClass *ret = NULL;
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200860 TypeImpl *target_type;
861 TypeImpl *type;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600862
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200863 if (!class) {
864 return NULL;
865 }
866
Paolo Bonzini793c96b2013-05-10 14:16:37 +0200867 /* A simple fast path that can trigger a lot for leaf classes. */
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200868 type = class->type;
Paolo Bonzini793c96b2013-05-10 14:16:37 +0200869 if (type->name == typename) {
870 return class;
871 }
872
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200873 target_type = type_get_by_name(typename);
Alexander Graf9ab880b2013-04-30 15:02:16 +0200874 if (!target_type) {
875 /* target class type unknown, so fail the cast */
876 return NULL;
877 }
878
Peter Crosthwaite00e2cea2013-02-19 14:02:10 +1000879 if (type->class->interfaces &&
880 type_is_ancestor(target_type, type_interface)) {
Anthony Liguori33e95c62012-08-10 13:16:10 +1000881 int found = 0;
882 GSList *i;
883
884 for (i = class->interfaces; i; i = i->next) {
885 ObjectClass *target_class = i->data;
886
887 if (type_is_ancestor(target_class->type, target_type)) {
888 ret = target_class;
889 found++;
890 }
891 }
892
893 /* The match was ambiguous, don't allow a cast */
894 if (found > 1) {
895 ret = NULL;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600896 }
Anthony Liguori33e95c62012-08-10 13:16:10 +1000897 } else if (type_is_ancestor(type, target_type)) {
898 ret = class;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600899 }
900
Anthony Liguori33e95c62012-08-10 13:16:10 +1000901 return ret;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600902}
903
904ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200905 const char *typename,
906 const char *file, int line,
907 const char *func)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600908{
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200909 ObjectClass *ret;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600910
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200911 trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)",
912 typename, file, line, func);
913
Anthony Liguori03587322013-05-13 15:22:24 -0500914#ifdef CONFIG_QOM_CAST_DEBUG
915 int i;
916
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000917 for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100918 if (atomic_read(&class->class_cast_cache[i]) == typename) {
Anthony Liguori03587322013-05-13 15:22:24 -0500919 ret = class;
920 goto out;
921 }
922 }
923#else
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000924 if (!class || !class->interfaces) {
Paolo Bonzini3556c232013-05-10 14:16:40 +0200925 return class;
926 }
927#endif
928
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200929 ret = object_class_dynamic_cast(class, typename);
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200930 if (!ret && class) {
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200931 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
932 file, line, func, class, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600933 abort();
934 }
935
Anthony Liguori03587322013-05-13 15:22:24 -0500936#ifdef CONFIG_QOM_CAST_DEBUG
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000937 if (class && ret == class) {
Anthony Liguori03587322013-05-13 15:22:24 -0500938 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100939 atomic_set(&class->class_cast_cache[i - 1],
940 atomic_read(&class->class_cast_cache[i]));
Anthony Liguori03587322013-05-13 15:22:24 -0500941 }
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100942 atomic_set(&class->class_cast_cache[i - 1], typename);
Anthony Liguori03587322013-05-13 15:22:24 -0500943 }
944out:
945#endif
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600946 return ret;
947}
948
Igor Mammedov8f5d58e2017-07-14 10:14:50 +0800949const char *object_get_typename(const Object *obj)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600950{
951 return obj->class->type->name;
952}
953
954ObjectClass *object_get_class(Object *obj)
955{
956 return obj->class;
957}
958
Andreas Färber17862372013-01-23 12:20:18 +0100959bool object_class_is_abstract(ObjectClass *klass)
960{
961 return klass->type->abstract;
962}
963
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600964const char *object_class_get_name(ObjectClass *klass)
965{
966 return klass->type->name;
967}
968
969ObjectClass *object_class_by_name(const char *typename)
970{
971 TypeImpl *type = type_get_by_name(typename);
972
973 if (!type) {
974 return NULL;
975 }
976
Igor Mitsyankoac451032012-02-28 15:57:11 +0400977 type_initialize(type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600978
979 return type->class;
980}
981
Paolo Bonzinie7cce672012-05-02 13:30:54 +0200982ObjectClass *object_class_get_parent(ObjectClass *class)
983{
984 TypeImpl *type = type_get_parent(class->type);
985
986 if (!type) {
987 return NULL;
988 }
989
990 type_initialize(type);
991
992 return type->class;
993}
994
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600995typedef struct OCFData
996{
997 void (*fn)(ObjectClass *klass, void *opaque);
Anthony Liguori93c511a2011-12-22 14:11:53 -0600998 const char *implements_type;
999 bool include_abstract;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001000 void *opaque;
1001} OCFData;
1002
1003static void object_class_foreach_tramp(gpointer key, gpointer value,
1004 gpointer opaque)
1005{
1006 OCFData *data = opaque;
1007 TypeImpl *type = value;
Anthony Liguori93c511a2011-12-22 14:11:53 -06001008 ObjectClass *k;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001009
Igor Mitsyankoac451032012-02-28 15:57:11 +04001010 type_initialize(type);
Anthony Liguori93c511a2011-12-22 14:11:53 -06001011 k = type->class;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001012
Anthony Liguori93c511a2011-12-22 14:11:53 -06001013 if (!data->include_abstract && type->abstract) {
1014 return;
1015 }
1016
1017 if (data->implements_type &&
1018 !object_class_dynamic_cast(k, data->implements_type)) {
1019 return;
1020 }
1021
1022 data->fn(k, data->opaque);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001023}
1024
1025void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
Anthony Liguori93c511a2011-12-22 14:11:53 -06001026 const char *implements_type, bool include_abstract,
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001027 void *opaque)
1028{
Anthony Liguori93c511a2011-12-22 14:11:53 -06001029 OCFData data = { fn, implements_type, include_abstract, opaque };
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001030
Hervé Poussineauf54c19c2013-12-03 16:42:00 +01001031 enumerating_types = true;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001032 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
Hervé Poussineauf54c19c2013-12-03 16:42:00 +01001033 enumerating_types = false;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001034}
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001035
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001036static int do_object_child_foreach(Object *obj,
1037 int (*fn)(Object *child, void *opaque),
1038 void *opaque, bool recurse)
Paolo Bonzini32efc532012-04-11 23:30:20 +02001039{
Pavel Fedinb604a852015-10-13 13:37:45 +01001040 GHashTableIter iter;
1041 ObjectProperty *prop;
Paolo Bonzini32efc532012-04-11 23:30:20 +02001042 int ret = 0;
1043
Pavel Fedinb604a852015-10-13 13:37:45 +01001044 g_hash_table_iter_init(&iter, obj->properties);
1045 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Paolo Bonzini32efc532012-04-11 23:30:20 +02001046 if (object_property_is_child(prop)) {
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001047 Object *child = prop->opaque;
1048
1049 ret = fn(child, opaque);
Paolo Bonzini32efc532012-04-11 23:30:20 +02001050 if (ret != 0) {
1051 break;
1052 }
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001053 if (recurse) {
1054 do_object_child_foreach(child, fn, opaque, true);
1055 }
Paolo Bonzini32efc532012-04-11 23:30:20 +02001056 }
1057 }
1058 return ret;
1059}
1060
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001061int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
1062 void *opaque)
1063{
1064 return do_object_child_foreach(obj, fn, opaque, false);
1065}
1066
1067int object_child_foreach_recursive(Object *obj,
1068 int (*fn)(Object *child, void *opaque),
1069 void *opaque)
1070{
1071 return do_object_child_foreach(obj, fn, opaque, true);
1072}
1073
Andreas Färber418ba9e2012-02-25 23:07:34 +01001074static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
1075{
1076 GSList **list = opaque;
1077
1078 *list = g_slist_prepend(*list, klass);
1079}
1080
1081GSList *object_class_get_list(const char *implements_type,
1082 bool include_abstract)
1083{
1084 GSList *list = NULL;
1085
1086 object_class_foreach(object_class_get_list_tramp,
1087 implements_type, include_abstract, &list);
1088 return list;
1089}
1090
Paolo Bonzini47c66002018-03-03 08:33:10 +01001091static gint object_class_cmp(gconstpointer a, gconstpointer b)
1092{
1093 return strcasecmp(object_class_get_name((ObjectClass *)a),
1094 object_class_get_name((ObjectClass *)b));
1095}
1096
1097GSList *object_class_get_list_sorted(const char *implements_type,
1098 bool include_abstract)
1099{
1100 return g_slist_sort(object_class_get_list(implements_type, include_abstract),
1101 object_class_cmp);
1102}
1103
Marc-André Lureaub77ade92020-01-10 19:30:31 +04001104Object *object_ref(Object *obj)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001105{
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001106 if (!obj) {
Marc-André Lureaub77ade92020-01-10 19:30:31 +04001107 return NULL;
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001108 }
Andreas Färber8438a132015-11-16 17:49:20 +01001109 atomic_inc(&obj->ref);
Marc-André Lureaub77ade92020-01-10 19:30:31 +04001110 return obj;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001111}
1112
1113void object_unref(Object *obj)
1114{
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001115 if (!obj) {
1116 return;
1117 }
Markus Armbruster719a3072018-06-08 19:02:31 +02001118 g_assert(obj->ref > 0);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001119
1120 /* parent always holds a reference to its children */
Jan Kiszkaf08c03f2013-07-02 11:36:39 +02001121 if (atomic_fetch_dec(&obj->ref) == 1) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001122 object_finalize(obj);
1123 }
1124}
1125
Markus Armbrusterd2623122020-05-05 17:29:22 +02001126static ObjectProperty *
1127object_property_try_add(Object *obj, const char *name, const char *type,
1128 ObjectPropertyAccessor *get,
1129 ObjectPropertyAccessor *set,
1130 ObjectPropertyRelease *release,
1131 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001132{
Peter Maydell54852b02013-03-25 13:15:13 +00001133 ObjectProperty *prop;
Peter Crosthwaite33965902014-08-19 23:55:52 -07001134 size_t name_len = strlen(name);
1135
1136 if (name_len >= 3 && !memcmp(name + name_len - 3, "[*]", 4)) {
1137 int i;
1138 ObjectProperty *ret;
1139 char *name_no_array = g_strdup(name);
1140
1141 name_no_array[name_len - 3] = '\0';
1142 for (i = 0; ; ++i) {
1143 char *full_name = g_strdup_printf("%s[%d]", name_no_array, i);
1144
Markus Armbrusterd2623122020-05-05 17:29:22 +02001145 ret = object_property_try_add(obj, full_name, type, get, set,
1146 release, opaque, NULL);
Peter Crosthwaite33965902014-08-19 23:55:52 -07001147 g_free(full_name);
1148 if (ret) {
1149 break;
1150 }
1151 }
1152 g_free(name_no_array);
1153 return ret;
1154 }
Peter Maydell54852b02013-03-25 13:15:13 +00001155
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001156 if (object_property_find(obj, name, NULL) != NULL) {
Greg Kurzd55e9372019-11-04 14:23:55 +01001157 error_setg(errp, "attempt to add duplicate property '%s' to object (type '%s')",
1158 name, object_get_typename(obj));
Pavel Fedinb604a852015-10-13 13:37:45 +01001159 return NULL;
Peter Maydell54852b02013-03-25 13:15:13 +00001160 }
1161
1162 prop = g_malloc0(sizeof(*prop));
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001163
1164 prop->name = g_strdup(name);
1165 prop->type = g_strdup(type);
1166
1167 prop->get = get;
1168 prop->set = set;
1169 prop->release = release;
1170 prop->opaque = opaque;
1171
Pavel Fedinb604a852015-10-13 13:37:45 +01001172 g_hash_table_insert(obj->properties, prop->name, prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001173 return prop;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001174}
1175
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001176ObjectProperty *
Markus Armbrusterd2623122020-05-05 17:29:22 +02001177object_property_add(Object *obj, const char *name, const char *type,
1178 ObjectPropertyAccessor *get,
1179 ObjectPropertyAccessor *set,
1180 ObjectPropertyRelease *release,
1181 void *opaque)
1182{
1183 return object_property_try_add(obj, name, type, get, set, release,
1184 opaque, &error_abort);
1185}
1186
1187ObjectProperty *
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001188object_class_property_add(ObjectClass *klass,
1189 const char *name,
1190 const char *type,
1191 ObjectPropertyAccessor *get,
1192 ObjectPropertyAccessor *set,
1193 ObjectPropertyRelease *release,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001194 void *opaque)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001195{
1196 ObjectProperty *prop;
1197
Markus Armbrusterd2623122020-05-05 17:29:22 +02001198 assert(!object_class_property_find(klass, name, NULL));
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001199
1200 prop = g_malloc0(sizeof(*prop));
1201
1202 prop->name = g_strdup(name);
1203 prop->type = g_strdup(type);
1204
1205 prop->get = get;
1206 prop->set = set;
1207 prop->release = release;
1208 prop->opaque = opaque;
1209
Marc-André Lureauba806ff2020-01-10 19:30:18 +04001210 g_hash_table_insert(klass->properties, prop->name, prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001211
1212 return prop;
1213}
1214
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001215ObjectProperty *object_property_find(Object *obj, const char *name,
1216 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001217{
1218 ObjectProperty *prop;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001219 ObjectClass *klass = object_get_class(obj);
1220
1221 prop = object_class_property_find(klass, name, NULL);
1222 if (prop) {
1223 return prop;
1224 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001225
Pavel Fedinb604a852015-10-13 13:37:45 +01001226 prop = g_hash_table_lookup(obj->properties, name);
1227 if (prop) {
1228 return prop;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001229 }
1230
Cole Robinsonf231b882014-03-21 19:42:26 -04001231 error_setg(errp, "Property '.%s' not found", name);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001232 return NULL;
1233}
1234
Daniel P. Berrange7746abd2015-12-09 12:34:02 +00001235void object_property_iter_init(ObjectPropertyIterator *iter,
1236 Object *obj)
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001237{
Daniel P. Berrange7746abd2015-12-09 12:34:02 +00001238 g_hash_table_iter_init(&iter->iter, obj->properties);
1239 iter->nextclass = object_get_class(obj);
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001240}
1241
1242ObjectProperty *object_property_iter_next(ObjectPropertyIterator *iter)
1243{
Pavel Fedinb604a852015-10-13 13:37:45 +01001244 gpointer key, val;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001245 while (!g_hash_table_iter_next(&iter->iter, &key, &val)) {
1246 if (!iter->nextclass) {
1247 return NULL;
1248 }
1249 g_hash_table_iter_init(&iter->iter, iter->nextclass->properties);
1250 iter->nextclass = object_class_get_parent(iter->nextclass);
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001251 }
Pavel Fedinb604a852015-10-13 13:37:45 +01001252 return val;
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001253}
1254
Alexey Kardashevskiy961c47b2018-03-02 00:09:39 +11001255void object_class_property_iter_init(ObjectPropertyIterator *iter,
1256 ObjectClass *klass)
1257{
1258 g_hash_table_iter_init(&iter->iter, klass->properties);
Marc-André Lureau684546d2018-09-06 17:37:36 +04001259 iter->nextclass = object_class_get_parent(klass);
Alexey Kardashevskiy961c47b2018-03-02 00:09:39 +11001260}
1261
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001262ObjectProperty *object_class_property_find(ObjectClass *klass, const char *name,
1263 Error **errp)
1264{
1265 ObjectProperty *prop;
1266 ObjectClass *parent_klass;
1267
1268 parent_klass = object_class_get_parent(klass);
1269 if (parent_klass) {
1270 prop = object_class_property_find(parent_klass, name, NULL);
1271 if (prop) {
1272 return prop;
1273 }
1274 }
1275
1276 prop = g_hash_table_lookup(klass->properties, name);
1277 if (!prop) {
1278 error_setg(errp, "Property '.%s' not found", name);
1279 }
1280 return prop;
1281}
1282
Markus Armbrusterdf4fe0b2020-05-05 17:29:26 +02001283void object_property_del(Object *obj, const char *name)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001284{
Pavel Fedinb604a852015-10-13 13:37:45 +01001285 ObjectProperty *prop = g_hash_table_lookup(obj->properties, name);
1286
Anthony Liguori0866aca2011-12-23 15:34:39 -06001287 if (prop->release) {
1288 prop->release(obj, name, prop->opaque);
1289 }
Pavel Fedinb604a852015-10-13 13:37:45 +01001290 g_hash_table_remove(obj->properties, name);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001291}
1292
1293void object_property_get(Object *obj, Visitor *v, const char *name,
1294 Error **errp)
1295{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001296 ObjectProperty *prop = object_property_find(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001297 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001298 return;
1299 }
1300
1301 if (!prop->get) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001302 error_setg(errp, QERR_PERMISSION_DENIED);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001303 } else {
Eric Blaked7bce992016-01-29 06:48:55 -07001304 prop->get(obj, v, name, prop->opaque, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001305 }
1306}
1307
1308void object_property_set(Object *obj, Visitor *v, const char *name,
1309 Error **errp)
1310{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001311 ObjectProperty *prop = object_property_find(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001312 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001313 return;
1314 }
1315
1316 if (!prop->set) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001317 error_setg(errp, QERR_PERMISSION_DENIED);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001318 } else {
Eric Blaked7bce992016-01-29 06:48:55 -07001319 prop->set(obj, v, name, prop->opaque, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001320 }
1321}
1322
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001323void object_property_set_str(Object *obj, const char *value,
1324 const char *name, Error **errp)
1325{
1326 QString *qstr = qstring_from_str(value);
1327 object_property_set_qobject(obj, QOBJECT(qstr), name, errp);
1328
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001329 qobject_unref(qstr);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001330}
1331
1332char *object_property_get_str(Object *obj, const char *name,
1333 Error **errp)
1334{
1335 QObject *ret = object_property_get_qobject(obj, name, errp);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001336 char *retval;
1337
1338 if (!ret) {
1339 return NULL;
1340 }
Peter Xuaafb21a2018-03-09 16:59:47 +08001341
1342 retval = g_strdup(qobject_get_try_str(ret));
1343 if (!retval) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001344 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001345 }
1346
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001347 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001348 return retval;
1349}
1350
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001351void object_property_set_link(Object *obj, Object *value,
1352 const char *name, Error **errp)
1353{
Peter Crosthwaited3c49312014-09-25 22:19:19 -07001354 if (value) {
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001355 char *path = object_get_canonical_path(value);
Peter Crosthwaited3c49312014-09-25 22:19:19 -07001356 object_property_set_str(obj, path, name, errp);
1357 g_free(path);
1358 } else {
1359 object_property_set_str(obj, "", name, errp);
1360 }
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001361}
1362
1363Object *object_property_get_link(Object *obj, const char *name,
1364 Error **errp)
1365{
1366 char *str = object_property_get_str(obj, name, errp);
1367 Object *target = NULL;
1368
1369 if (str && *str) {
1370 target = object_resolve_path(str, NULL);
1371 if (!target) {
Markus Armbruster75158eb2015-03-16 08:57:47 +01001372 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1373 "Device '%s' not found", str);
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001374 }
1375 }
1376
1377 g_free(str);
1378 return target;
1379}
1380
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001381void object_property_set_bool(Object *obj, bool value,
1382 const char *name, Error **errp)
1383{
Eric Blakefc48ffc2015-05-15 16:24:59 -06001384 QBool *qbool = qbool_from_bool(value);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001385 object_property_set_qobject(obj, QOBJECT(qbool), name, errp);
1386
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001387 qobject_unref(qbool);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001388}
1389
1390bool object_property_get_bool(Object *obj, const char *name,
1391 Error **errp)
1392{
1393 QObject *ret = object_property_get_qobject(obj, name, errp);
1394 QBool *qbool;
1395 bool retval;
1396
1397 if (!ret) {
1398 return false;
1399 }
Max Reitz7dc847e2018-02-24 16:40:29 +01001400 qbool = qobject_to(QBool, ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001401 if (!qbool) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001402 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001403 retval = false;
1404 } else {
Eric Blakefc48ffc2015-05-15 16:24:59 -06001405 retval = qbool_get_bool(qbool);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001406 }
1407
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001408 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001409 return retval;
1410}
1411
1412void object_property_set_int(Object *obj, int64_t value,
1413 const char *name, Error **errp)
1414{
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001415 QNum *qnum = qnum_from_int(value);
1416 object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001417
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001418 qobject_unref(qnum);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001419}
1420
1421int64_t object_property_get_int(Object *obj, const char *name,
1422 Error **errp)
1423{
1424 QObject *ret = object_property_get_qobject(obj, name, errp);
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001425 QNum *qnum;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001426 int64_t retval;
1427
1428 if (!ret) {
1429 return -1;
1430 }
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001431
Max Reitz7dc847e2018-02-24 16:40:29 +01001432 qnum = qobject_to(QNum, ret);
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001433 if (!qnum || !qnum_get_try_int(qnum, &retval)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001434 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001435 retval = -1;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001436 }
1437
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001438 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001439 return retval;
1440}
1441
Marc-André Lureau0e76ed02020-01-10 19:30:23 +04001442static void object_property_init_defval(Object *obj, ObjectProperty *prop)
1443{
1444 Visitor *v = qobject_input_visitor_new(prop->defval);
1445
1446 assert(prop->set != NULL);
1447 prop->set(obj, v, prop->name, prop->opaque, &error_abort);
1448
1449 visit_free(v);
1450}
1451
1452static void object_property_set_default(ObjectProperty *prop, QObject *defval)
1453{
1454 assert(!prop->defval);
1455 assert(!prop->init);
1456
1457 prop->defval = defval;
1458 prop->init = object_property_init_defval;
1459}
1460
1461void object_property_set_default_bool(ObjectProperty *prop, bool value)
1462{
1463 object_property_set_default(prop, QOBJECT(qbool_from_bool(value)));
1464}
1465
1466void object_property_set_default_str(ObjectProperty *prop, const char *value)
1467{
1468 object_property_set_default(prop, QOBJECT(qstring_from_str(value)));
1469}
1470
1471void object_property_set_default_int(ObjectProperty *prop, int64_t value)
1472{
1473 object_property_set_default(prop, QOBJECT(qnum_from_int(value)));
1474}
1475
1476void object_property_set_default_uint(ObjectProperty *prop, uint64_t value)
1477{
1478 object_property_set_default(prop, QOBJECT(qnum_from_uint(value)));
1479}
1480
Marc-André Lureau31527792017-06-07 20:36:04 +04001481void object_property_set_uint(Object *obj, uint64_t value,
1482 const char *name, Error **errp)
1483{
1484 QNum *qnum = qnum_from_uint(value);
1485
1486 object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001487 qobject_unref(qnum);
Marc-André Lureau31527792017-06-07 20:36:04 +04001488}
1489
1490uint64_t object_property_get_uint(Object *obj, const char *name,
1491 Error **errp)
1492{
1493 QObject *ret = object_property_get_qobject(obj, name, errp);
1494 QNum *qnum;
1495 uint64_t retval;
1496
1497 if (!ret) {
1498 return 0;
1499 }
Max Reitz7dc847e2018-02-24 16:40:29 +01001500 qnum = qobject_to(QNum, ret);
Marc-André Lureau31527792017-06-07 20:36:04 +04001501 if (!qnum || !qnum_get_try_uint(qnum, &retval)) {
1502 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "uint");
1503 retval = 0;
1504 }
1505
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001506 qobject_unref(ret);
Marc-André Lureau31527792017-06-07 20:36:04 +04001507 return retval;
1508}
1509
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01001510typedef struct EnumProperty {
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02001511 const QEnumLookup *lookup;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01001512 int (*get)(Object *, Error **);
1513 void (*set)(Object *, int, Error **);
1514} EnumProperty;
1515
Hu Tao1f217722014-05-14 17:43:33 +08001516int object_property_get_enum(Object *obj, const char *name,
Daniel P. Berrangea3590da2015-05-27 16:07:56 +01001517 const char *typename, Error **errp)
Hu Tao1f217722014-05-14 17:43:33 +08001518{
Chen Fan976620a2014-08-18 14:46:34 +08001519 char *str;
Hu Tao1f217722014-05-14 17:43:33 +08001520 int ret;
Daniel P. Berrangea3590da2015-05-27 16:07:56 +01001521 ObjectProperty *prop = object_property_find(obj, name, errp);
1522 EnumProperty *enumprop;
1523
1524 if (prop == NULL) {
1525 return 0;
1526 }
1527
1528 if (!g_str_equal(prop->type, typename)) {
1529 error_setg(errp, "Property %s on %s is not '%s' enum type",
1530 name, object_class_get_name(
1531 object_get_class(obj)), typename);
1532 return 0;
1533 }
1534
1535 enumprop = prop->opaque;
Hu Tao1f217722014-05-14 17:43:33 +08001536
Markus Armbrusterb555f892020-05-05 17:29:12 +02001537 str = object_property_get_str(obj, name, errp);
1538 if (!str) {
Markus Armbruster4715d422015-08-25 20:00:45 +02001539 return 0;
1540 }
Chen Fan976620a2014-08-18 14:46:34 +08001541
Markus Armbrusterea097df2020-04-24 10:43:36 +02001542 ret = qapi_enum_parse(enumprop->lookup, str, -1, errp);
Chen Fan976620a2014-08-18 14:46:34 +08001543 g_free(str);
Hu Tao1f217722014-05-14 17:43:33 +08001544
1545 return ret;
1546}
1547
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001548void object_property_parse(Object *obj, const char *string,
1549 const char *name, Error **errp)
1550{
Eric Blake7a0525c2016-06-09 10:48:37 -06001551 Visitor *v = string_input_visitor_new(string);
1552 object_property_set(obj, v, name, errp);
1553 visit_free(v);
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001554}
1555
Paolo Bonzini0b7593e2014-02-08 11:01:50 +01001556char *object_property_print(Object *obj, const char *name, bool human,
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001557 Error **errp)
1558{
Eric Blake3b098d52016-06-09 10:48:43 -06001559 Visitor *v;
Gonglei3a530092014-09-27 13:13:55 +08001560 char *string = NULL;
1561 Error *local_err = NULL;
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001562
Eric Blake3b098d52016-06-09 10:48:43 -06001563 v = string_output_visitor_new(human, &string);
1564 object_property_get(obj, v, name, &local_err);
Gonglei3a530092014-09-27 13:13:55 +08001565 if (local_err) {
1566 error_propagate(errp, local_err);
1567 goto out;
1568 }
1569
Eric Blake3b098d52016-06-09 10:48:43 -06001570 visit_complete(v, &string);
Gonglei3a530092014-09-27 13:13:55 +08001571
1572out:
Eric Blake3b098d52016-06-09 10:48:43 -06001573 visit_free(v);
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001574 return string;
1575}
1576
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001577const char *object_property_get_type(Object *obj, const char *name, Error **errp)
1578{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001579 ObjectProperty *prop = object_property_find(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001580 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001581 return NULL;
1582 }
1583
1584 return prop->type;
1585}
1586
1587Object *object_get_root(void)
1588{
Anthony Liguori8b45d442011-12-23 09:08:05 -06001589 static Object *root;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001590
Anthony Liguori8b45d442011-12-23 09:08:05 -06001591 if (!root) {
1592 root = object_new("container");
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001593 }
1594
Anthony Liguori8b45d442011-12-23 09:08:05 -06001595 return root;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001596}
1597
Daniel P. Berrangebc2256c2015-05-13 17:14:05 +01001598Object *object_get_objects_root(void)
1599{
1600 return container_get(object_get_root(), "/objects");
1601}
1602
Peter Xu7c47c4e2017-09-28 10:59:54 +08001603Object *object_get_internal_root(void)
1604{
1605 static Object *internal_root;
1606
1607 if (!internal_root) {
1608 internal_root = object_new("container");
1609 }
1610
1611 return internal_root;
1612}
1613
Eric Blaked7bce992016-01-29 06:48:55 -07001614static void object_get_child_property(Object *obj, Visitor *v,
1615 const char *name, void *opaque,
1616 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001617{
1618 Object *child = opaque;
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001619 char *path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001620
1621 path = object_get_canonical_path(child);
Eric Blake51e72bc2016-01-29 06:48:54 -07001622 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001623 g_free(path);
1624}
1625
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001626static Object *object_resolve_child_property(Object *parent, void *opaque,
1627 const char *part)
Paolo Bonzini64607d02014-06-05 13:11:51 +02001628{
1629 return opaque;
1630}
1631
Anthony Liguoridb85b572011-12-23 08:47:39 -06001632static void object_finalize_child_property(Object *obj, const char *name,
1633 void *opaque)
1634{
1635 Object *child = opaque;
1636
Paolo Bonzinibffc6872014-06-11 11:57:38 +02001637 if (child->class->unparent) {
1638 (child->class->unparent)(child);
1639 }
1640 child->parent = NULL;
Anthony Liguoridb85b572011-12-23 08:47:39 -06001641 object_unref(child);
1642}
1643
Markus Armbruster70251882020-05-05 17:29:14 +02001644ObjectProperty *
1645object_property_add_child(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001646 Object *child)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001647{
Markus Armbruster70251882020-05-05 17:29:14 +02001648 g_autofree char *type = NULL;
Paolo Bonzini64607d02014-06-05 13:11:51 +02001649 ObjectProperty *op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001650
Markus Armbrusterd2623122020-05-05 17:29:22 +02001651 assert(!child->parent);
Peter Crosthwaite8faa2f82014-09-25 22:19:52 -07001652
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001653 type = g_strdup_printf("child<%s>", object_get_typename(OBJECT(child)));
1654
Paolo Bonzini64607d02014-06-05 13:11:51 +02001655 op = object_property_add(obj, name, type, object_get_child_property, NULL,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001656 object_finalize_child_property, child);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001657 op->resolve = object_resolve_child_property;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001658 object_ref(child);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001659 child->parent = obj;
Markus Armbruster70251882020-05-05 17:29:14 +02001660 return op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001661}
1662
Igor Mammedov8f5d58e2017-07-14 10:14:50 +08001663void object_property_allow_set_link(const Object *obj, const char *name,
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001664 Object *val, Error **errp)
1665{
1666 /* Allow the link to be set, always */
1667}
1668
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001669typedef struct {
Marc-André Lureau9941d372020-01-10 19:30:27 +04001670 union {
1671 Object **targetp;
1672 Object *target; /* if OBJ_PROP_LINK_DIRECT, when holding the pointer */
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001673 ptrdiff_t offset; /* if OBJ_PROP_LINK_CLASS */
Marc-André Lureau9941d372020-01-10 19:30:27 +04001674 };
Igor Mammedov8f5d58e2017-07-14 10:14:50 +08001675 void (*check)(const Object *, const char *, Object *, Error **);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001676 ObjectPropertyLinkFlags flags;
1677} LinkProperty;
1678
Marc-André Lureau9941d372020-01-10 19:30:27 +04001679static Object **
1680object_link_get_targetp(Object *obj, LinkProperty *lprop)
1681{
1682 if (lprop->flags & OBJ_PROP_LINK_DIRECT) {
1683 return &lprop->target;
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001684 } else if (lprop->flags & OBJ_PROP_LINK_CLASS) {
1685 return (void *)obj + lprop->offset;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001686 } else {
1687 return lprop->targetp;
1688 }
1689}
1690
Eric Blaked7bce992016-01-29 06:48:55 -07001691static void object_get_link_property(Object *obj, Visitor *v,
1692 const char *name, void *opaque,
1693 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001694{
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001695 LinkProperty *lprop = opaque;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001696 Object **targetp = object_link_get_targetp(obj, lprop);
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001697 char *path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001698
Marc-André Lureau36854202020-01-10 19:30:26 +04001699 if (*targetp) {
1700 path = object_get_canonical_path(*targetp);
Eric Blake51e72bc2016-01-29 06:48:54 -07001701 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001702 g_free(path);
1703 } else {
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001704 path = (char *)"";
Eric Blake51e72bc2016-01-29 06:48:54 -07001705 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001706 }
1707}
1708
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001709/*
1710 * object_resolve_link:
1711 *
1712 * Lookup an object and ensure its type matches the link property type. This
1713 * is similar to object_resolve_path() except type verification against the
1714 * link property is performed.
1715 *
1716 * Returns: The matched object or NULL on path lookup failures.
1717 */
1718static Object *object_resolve_link(Object *obj, const char *name,
1719 const char *path, Error **errp)
1720{
1721 const char *type;
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001722 char *target_type;
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001723 bool ambiguous = false;
1724 Object *target;
1725
1726 /* Go from link<FOO> to FOO. */
1727 type = object_property_get_type(obj, name, NULL);
1728 target_type = g_strndup(&type[5], strlen(type) - 6);
1729 target = object_resolve_path_type(path, target_type, &ambiguous);
1730
1731 if (ambiguous) {
Eric Blake455b0fd2015-11-10 23:51:20 -07001732 error_setg(errp, "Path '%s' does not uniquely identify an object",
1733 path);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001734 } else if (!target) {
1735 target = object_resolve_path(path, &ambiguous);
1736 if (target || ambiguous) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001737 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001738 } else {
Markus Armbruster75158eb2015-03-16 08:57:47 +01001739 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1740 "Device '%s' not found", path);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001741 }
1742 target = NULL;
1743 }
1744 g_free(target_type);
1745
1746 return target;
1747}
1748
Eric Blaked7bce992016-01-29 06:48:55 -07001749static void object_set_link_property(Object *obj, Visitor *v,
1750 const char *name, void *opaque,
1751 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001752{
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001753 Error *local_err = NULL;
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001754 LinkProperty *prop = opaque;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001755 Object **targetp = object_link_get_targetp(obj, prop);
Marc-André Lureau36854202020-01-10 19:30:26 +04001756 Object *old_target = *targetp;
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001757 Object *new_target = NULL;
1758 char *path = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001759
Eric Blake51e72bc2016-01-29 06:48:54 -07001760 visit_type_str(v, name, &path, &local_err);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001761
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001762 if (!local_err && strcmp(path, "") != 0) {
1763 new_target = object_resolve_link(obj, name, path, &local_err);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001764 }
1765
1766 g_free(path);
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001767 if (local_err) {
1768 error_propagate(errp, local_err);
1769 return;
1770 }
Alexander Barabashf0cdc962012-02-22 19:22:26 +02001771
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001772 prop->check(obj, name, new_target, &local_err);
1773 if (local_err) {
1774 error_propagate(errp, local_err);
1775 return;
1776 }
1777
Marc-André Lureau36854202020-01-10 19:30:26 +04001778 *targetp = new_target;
Marc-André Lureau8770baf2020-01-10 19:30:25 +04001779 if (prop->flags & OBJ_PROP_LINK_STRONG) {
Marc-André Lureau265b5782018-05-31 21:51:17 +02001780 object_ref(new_target);
1781 object_unref(old_target);
1782 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001783}
1784
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001785static Object *object_resolve_link_property(Object *parent, void *opaque,
1786 const char *part)
Paolo Bonzini64607d02014-06-05 13:11:51 +02001787{
1788 LinkProperty *lprop = opaque;
1789
Marc-André Lureau9941d372020-01-10 19:30:27 +04001790 return *object_link_get_targetp(parent, lprop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001791}
1792
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001793static void object_release_link_property(Object *obj, const char *name,
1794 void *opaque)
1795{
1796 LinkProperty *prop = opaque;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001797 Object **targetp = object_link_get_targetp(obj, prop);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001798
Marc-André Lureau9941d372020-01-10 19:30:27 +04001799 if ((prop->flags & OBJ_PROP_LINK_STRONG) && *targetp) {
1800 object_unref(*targetp);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001801 }
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001802 if (!(prop->flags & OBJ_PROP_LINK_CLASS)) {
1803 g_free(prop);
1804 }
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001805}
1806
Markus Armbruster70251882020-05-05 17:29:14 +02001807static ObjectProperty *
1808object_add_link_prop(Object *obj, const char *name,
1809 const char *type, void *ptr,
1810 void (*check)(const Object *, const char *,
1811 Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02001812 ObjectPropertyLinkFlags flags)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001813{
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001814 LinkProperty *prop = g_malloc(sizeof(*prop));
Markus Armbruster70251882020-05-05 17:29:14 +02001815 g_autofree char *full_type = NULL;
Paolo Bonzini64607d02014-06-05 13:11:51 +02001816 ObjectProperty *op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001817
Marc-André Lureau4a8d5792020-01-10 19:30:28 +04001818 if (flags & OBJ_PROP_LINK_DIRECT) {
1819 prop->target = ptr;
1820 } else {
1821 prop->targetp = ptr;
1822 }
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001823 prop->check = check;
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001824 prop->flags = flags;
1825
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001826 full_type = g_strdup_printf("link<%s>", type);
1827
Paolo Bonzini64607d02014-06-05 13:11:51 +02001828 op = object_property_add(obj, name, full_type,
1829 object_get_link_property,
1830 check ? object_set_link_property : NULL,
1831 object_release_link_property,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001832 prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001833 op->resolve = object_resolve_link_property;
Markus Armbruster70251882020-05-05 17:29:14 +02001834 return op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001835}
1836
Markus Armbruster70251882020-05-05 17:29:14 +02001837ObjectProperty *
1838object_property_add_link(Object *obj, const char *name,
1839 const char *type, Object **targetp,
1840 void (*check)(const Object *, const char *,
1841 Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02001842 ObjectPropertyLinkFlags flags)
Marc-André Lureau4a8d5792020-01-10 19:30:28 +04001843{
Markus Armbrusterd2623122020-05-05 17:29:22 +02001844 return object_add_link_prop(obj, name, type, targetp, check, flags);
Marc-André Lureau4a8d5792020-01-10 19:30:28 +04001845}
1846
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001847ObjectProperty *
1848object_class_property_add_link(ObjectClass *oc,
1849 const char *name,
1850 const char *type, ptrdiff_t offset,
1851 void (*check)(const Object *obj, const char *name,
1852 Object *val, Error **errp),
Markus Armbrusterd2623122020-05-05 17:29:22 +02001853 ObjectPropertyLinkFlags flags)
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001854{
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001855 LinkProperty *prop = g_new0(LinkProperty, 1);
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001856 char *full_type;
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001857 ObjectProperty *op;
1858
1859 prop->offset = offset;
1860 prop->check = check;
1861 prop->flags = flags | OBJ_PROP_LINK_CLASS;
1862
1863 full_type = g_strdup_printf("link<%s>", type);
1864
1865 op = object_class_property_add(oc, name, full_type,
1866 object_get_link_property,
1867 check ? object_set_link_property : NULL,
1868 object_release_link_property,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001869 prop);
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001870
1871 op->resolve = object_resolve_link_property;
1872
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001873 g_free(full_type);
1874 return op;
1875}
1876
Markus Armbruster70251882020-05-05 17:29:14 +02001877ObjectProperty *
1878object_property_add_const_link(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001879 Object *target)
Paolo Bonzinifb9e7e32015-05-05 18:29:00 +02001880{
Markus Armbruster70251882020-05-05 17:29:14 +02001881 return object_add_link_prop(obj, name,
1882 object_get_typename(target), target,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001883 NULL, OBJ_PROP_LINK_DIRECT);
Paolo Bonzinifb9e7e32015-05-05 18:29:00 +02001884}
1885
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001886char *object_get_canonical_path_component(Object *obj)
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001887{
1888 ObjectProperty *prop = NULL;
Pavel Fedinb604a852015-10-13 13:37:45 +01001889 GHashTableIter iter;
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001890
Paolo Bonzini770dec22018-04-30 11:44:17 +02001891 if (obj->parent == NULL) {
1892 return NULL;
1893 }
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001894
Pavel Fedinb604a852015-10-13 13:37:45 +01001895 g_hash_table_iter_init(&iter, obj->parent->properties);
1896 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001897 if (!object_property_is_child(prop)) {
1898 continue;
1899 }
1900
1901 if (prop->opaque == obj) {
1902 return g_strdup(prop->name);
1903 }
1904 }
1905
1906 /* obj had a parent but was not a child, should never happen */
1907 g_assert_not_reached();
1908 return NULL;
1909}
1910
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001911char *object_get_canonical_path(Object *obj)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001912{
1913 Object *root = object_get_root();
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001914 char *newpath, *path = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001915
Paolo Bonzinie40077f2018-05-30 18:16:04 +02001916 if (obj == root) {
1917 return g_strdup("/");
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001918 }
1919
Paolo Bonzinie40077f2018-05-30 18:16:04 +02001920 do {
1921 char *component = object_get_canonical_path_component(obj);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001922
Paolo Bonzinie40077f2018-05-30 18:16:04 +02001923 if (!component) {
1924 /* A canonical path must be complete, so discard what was
1925 * collected so far.
1926 */
1927 g_free(path);
1928 return NULL;
1929 }
1930
1931 newpath = g_strdup_printf("/%s%s", component, path ? path : "");
1932 g_free(path);
1933 g_free(component);
1934 path = newpath;
1935 obj = obj->parent;
1936 } while (obj != root);
1937
1938 return path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001939}
1940
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001941Object *object_resolve_path_component(Object *parent, const char *part)
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001942{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001943 ObjectProperty *prop = object_property_find(parent, part, NULL);
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001944 if (prop == NULL) {
1945 return NULL;
1946 }
1947
Paolo Bonzini64607d02014-06-05 13:11:51 +02001948 if (prop->resolve) {
1949 return prop->resolve(parent, prop->opaque, part);
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001950 } else {
1951 return NULL;
1952 }
1953}
1954
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001955static Object *object_resolve_abs_path(Object *parent,
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001956 char **parts,
1957 const char *typename,
1958 int index)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001959{
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001960 Object *child;
1961
1962 if (parts[index] == NULL) {
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001963 return object_dynamic_cast(parent, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001964 }
1965
1966 if (strcmp(parts[index], "") == 0) {
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001967 return object_resolve_abs_path(parent, parts, typename, index + 1);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001968 }
1969
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001970 child = object_resolve_path_component(parent, parts[index]);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001971 if (!child) {
1972 return NULL;
1973 }
1974
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001975 return object_resolve_abs_path(child, parts, typename, index + 1);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001976}
1977
1978static Object *object_resolve_partial_path(Object *parent,
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001979 char **parts,
1980 const char *typename,
1981 bool *ambiguous)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001982{
1983 Object *obj;
Pavel Fedinb604a852015-10-13 13:37:45 +01001984 GHashTableIter iter;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001985 ObjectProperty *prop;
1986
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001987 obj = object_resolve_abs_path(parent, parts, typename, 0);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001988
Pavel Fedinb604a852015-10-13 13:37:45 +01001989 g_hash_table_iter_init(&iter, parent->properties);
1990 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001991 Object *found;
1992
Andreas Färber5d9d3f42012-05-27 00:32:40 +02001993 if (!object_property_is_child(prop)) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001994 continue;
1995 }
1996
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001997 found = object_resolve_partial_path(prop->opaque, parts,
1998 typename, ambiguous);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001999 if (found) {
2000 if (obj) {
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002001 *ambiguous = true;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002002 return NULL;
2003 }
2004 obj = found;
2005 }
2006
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002007 if (*ambiguous) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002008 return NULL;
2009 }
2010 }
2011
2012 return obj;
2013}
2014
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002015Object *object_resolve_path_type(const char *path, const char *typename,
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002016 bool *ambiguousp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002017{
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002018 Object *obj;
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02002019 char **parts;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002020
2021 parts = g_strsplit(path, "/", 0);
Paolo Bonzini2e1103f2013-04-18 18:44:02 +02002022 assert(parts);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002023
Paolo Bonzini2e1103f2013-04-18 18:44:02 +02002024 if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002025 bool ambiguous = false;
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002026 obj = object_resolve_partial_path(object_get_root(), parts,
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002027 typename, &ambiguous);
2028 if (ambiguousp) {
2029 *ambiguousp = ambiguous;
2030 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002031 } else {
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002032 obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002033 }
2034
2035 g_strfreev(parts);
2036
2037 return obj;
2038}
2039
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002040Object *object_resolve_path(const char *path, bool *ambiguous)
2041{
2042 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
2043}
2044
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002045typedef struct StringProperty
2046{
2047 char *(*get)(Object *, Error **);
2048 void (*set)(Object *, const char *, Error **);
2049} StringProperty;
2050
Eric Blaked7bce992016-01-29 06:48:55 -07002051static void property_get_str(Object *obj, Visitor *v, const char *name,
2052 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002053{
2054 StringProperty *prop = opaque;
2055 char *value;
Markus Armbrustere1c82372015-08-25 20:00:46 +02002056 Error *err = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002057
Markus Armbrustere1c82372015-08-25 20:00:46 +02002058 value = prop->get(obj, &err);
2059 if (err) {
2060 error_propagate(errp, err);
2061 return;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002062 }
Markus Armbrustere1c82372015-08-25 20:00:46 +02002063
Eric Blake51e72bc2016-01-29 06:48:54 -07002064 visit_type_str(v, name, &value, errp);
Markus Armbrustere1c82372015-08-25 20:00:46 +02002065 g_free(value);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002066}
2067
Eric Blaked7bce992016-01-29 06:48:55 -07002068static void property_set_str(Object *obj, Visitor *v, const char *name,
2069 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002070{
2071 StringProperty *prop = opaque;
2072 char *value;
2073 Error *local_err = NULL;
2074
Eric Blake51e72bc2016-01-29 06:48:54 -07002075 visit_type_str(v, name, &value, &local_err);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002076 if (local_err) {
2077 error_propagate(errp, local_err);
2078 return;
2079 }
2080
2081 prop->set(obj, value, errp);
2082 g_free(value);
2083}
2084
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01002085static void property_release_str(Object *obj, const char *name,
2086 void *opaque)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002087{
2088 StringProperty *prop = opaque;
2089 g_free(prop);
2090}
2091
Markus Armbruster70251882020-05-05 17:29:14 +02002092ObjectProperty *
2093object_property_add_str(Object *obj, const char *name,
2094 char *(*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002095 void (*set)(Object *, const char *, Error **))
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002096{
2097 StringProperty *prop = g_malloc0(sizeof(*prop));
2098
2099 prop->get = get;
2100 prop->set = set;
2101
Markus Armbrusterd2623122020-05-05 17:29:22 +02002102 return object_property_add(obj, name, "string",
2103 get ? property_get_str : NULL,
2104 set ? property_set_str : NULL,
2105 property_release_str,
2106 prop);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002107}
Paolo Bonzini745549c2012-03-31 16:45:54 +02002108
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002109ObjectProperty *
2110object_class_property_add_str(ObjectClass *klass, const char *name,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002111 char *(*get)(Object *, Error **),
2112 void (*set)(Object *, const char *,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002113 Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002114{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002115 StringProperty *prop = g_malloc0(sizeof(*prop));
2116
2117 prop->get = get;
2118 prop->set = set;
2119
Markus Armbrusterd2623122020-05-05 17:29:22 +02002120 return object_class_property_add(klass, name, "string",
2121 get ? property_get_str : NULL,
2122 set ? property_set_str : NULL,
2123 NULL,
2124 prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002125}
2126
Anthony Liguori0e558842012-06-25 10:32:46 -05002127typedef struct BoolProperty
2128{
2129 bool (*get)(Object *, Error **);
2130 void (*set)(Object *, bool, Error **);
2131} BoolProperty;
2132
Eric Blaked7bce992016-01-29 06:48:55 -07002133static void property_get_bool(Object *obj, Visitor *v, const char *name,
2134 void *opaque, Error **errp)
Anthony Liguori0e558842012-06-25 10:32:46 -05002135{
2136 BoolProperty *prop = opaque;
2137 bool value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002138 Error *err = NULL;
Anthony Liguori0e558842012-06-25 10:32:46 -05002139
Markus Armbruster4715d422015-08-25 20:00:45 +02002140 value = prop->get(obj, &err);
2141 if (err) {
2142 error_propagate(errp, err);
2143 return;
2144 }
2145
Eric Blake51e72bc2016-01-29 06:48:54 -07002146 visit_type_bool(v, name, &value, errp);
Anthony Liguori0e558842012-06-25 10:32:46 -05002147}
2148
Eric Blaked7bce992016-01-29 06:48:55 -07002149static void property_set_bool(Object *obj, Visitor *v, const char *name,
2150 void *opaque, Error **errp)
Anthony Liguori0e558842012-06-25 10:32:46 -05002151{
2152 BoolProperty *prop = opaque;
2153 bool value;
2154 Error *local_err = NULL;
2155
Eric Blake51e72bc2016-01-29 06:48:54 -07002156 visit_type_bool(v, name, &value, &local_err);
Anthony Liguori0e558842012-06-25 10:32:46 -05002157 if (local_err) {
2158 error_propagate(errp, local_err);
2159 return;
2160 }
2161
2162 prop->set(obj, value, errp);
2163}
2164
2165static void property_release_bool(Object *obj, const char *name,
2166 void *opaque)
2167{
2168 BoolProperty *prop = opaque;
2169 g_free(prop);
2170}
2171
Markus Armbruster70251882020-05-05 17:29:14 +02002172ObjectProperty *
2173object_property_add_bool(Object *obj, const char *name,
2174 bool (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002175 void (*set)(Object *, bool, Error **))
Anthony Liguori0e558842012-06-25 10:32:46 -05002176{
2177 BoolProperty *prop = g_malloc0(sizeof(*prop));
2178
2179 prop->get = get;
2180 prop->set = set;
2181
Markus Armbrusterd2623122020-05-05 17:29:22 +02002182 return object_property_add(obj, name, "bool",
2183 get ? property_get_bool : NULL,
2184 set ? property_set_bool : NULL,
2185 property_release_bool,
2186 prop);
Anthony Liguori0e558842012-06-25 10:32:46 -05002187}
2188
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002189ObjectProperty *
2190object_class_property_add_bool(ObjectClass *klass, const char *name,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002191 bool (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002192 void (*set)(Object *, bool, Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002193{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002194 BoolProperty *prop = g_malloc0(sizeof(*prop));
2195
2196 prop->get = get;
2197 prop->set = set;
2198
Markus Armbrusterd2623122020-05-05 17:29:22 +02002199 return object_class_property_add(klass, name, "bool",
2200 get ? property_get_bool : NULL,
2201 set ? property_set_bool : NULL,
2202 NULL,
2203 prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002204}
2205
Eric Blaked7bce992016-01-29 06:48:55 -07002206static void property_get_enum(Object *obj, Visitor *v, const char *name,
2207 void *opaque, Error **errp)
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002208{
2209 EnumProperty *prop = opaque;
2210 int value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002211 Error *err = NULL;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002212
Markus Armbruster4715d422015-08-25 20:00:45 +02002213 value = prop->get(obj, &err);
2214 if (err) {
2215 error_propagate(errp, err);
2216 return;
2217 }
2218
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002219 visit_type_enum(v, name, &value, prop->lookup, errp);
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002220}
2221
Eric Blaked7bce992016-01-29 06:48:55 -07002222static void property_set_enum(Object *obj, Visitor *v, const char *name,
2223 void *opaque, Error **errp)
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002224{
2225 EnumProperty *prop = opaque;
2226 int value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002227 Error *err = NULL;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002228
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002229 visit_type_enum(v, name, &value, prop->lookup, &err);
Markus Armbruster4715d422015-08-25 20:00:45 +02002230 if (err) {
2231 error_propagate(errp, err);
2232 return;
2233 }
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002234 prop->set(obj, value, errp);
2235}
2236
2237static void property_release_enum(Object *obj, const char *name,
2238 void *opaque)
2239{
2240 EnumProperty *prop = opaque;
2241 g_free(prop);
2242}
2243
Markus Armbruster70251882020-05-05 17:29:14 +02002244ObjectProperty *
2245object_property_add_enum(Object *obj, const char *name,
2246 const char *typename,
2247 const QEnumLookup *lookup,
2248 int (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002249 void (*set)(Object *, int, Error **))
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002250{
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002251 EnumProperty *prop = g_malloc(sizeof(*prop));
2252
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002253 prop->lookup = lookup;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002254 prop->get = get;
2255 prop->set = set;
2256
Markus Armbrusterd2623122020-05-05 17:29:22 +02002257 return object_property_add(obj, name, typename,
2258 get ? property_get_enum : NULL,
2259 set ? property_set_enum : NULL,
2260 property_release_enum,
2261 prop);
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002262}
2263
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002264ObjectProperty *
2265object_class_property_add_enum(ObjectClass *klass, const char *name,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002266 const char *typename,
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002267 const QEnumLookup *lookup,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002268 int (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002269 void (*set)(Object *, int, Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002270{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002271 EnumProperty *prop = g_malloc(sizeof(*prop));
2272
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002273 prop->lookup = lookup;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002274 prop->get = get;
2275 prop->set = set;
2276
Markus Armbrusterd2623122020-05-05 17:29:22 +02002277 return object_class_property_add(klass, name, typename,
2278 get ? property_get_enum : NULL,
2279 set ? property_set_enum : NULL,
2280 NULL,
2281 prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002282}
2283
David Gibson8e099d12015-02-06 14:55:45 +11002284typedef struct TMProperty {
2285 void (*get)(Object *, struct tm *, Error **);
2286} TMProperty;
2287
Eric Blaked7bce992016-01-29 06:48:55 -07002288static void property_get_tm(Object *obj, Visitor *v, const char *name,
2289 void *opaque, Error **errp)
David Gibson8e099d12015-02-06 14:55:45 +11002290{
2291 TMProperty *prop = opaque;
2292 Error *err = NULL;
2293 struct tm value;
2294
2295 prop->get(obj, &value, &err);
2296 if (err) {
2297 goto out;
2298 }
2299
Eric Blake337283d2016-01-29 06:48:57 -07002300 visit_start_struct(v, name, NULL, 0, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002301 if (err) {
2302 goto out;
2303 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002304 visit_type_int32(v, "tm_year", &value.tm_year, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002305 if (err) {
2306 goto out_end;
2307 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002308 visit_type_int32(v, "tm_mon", &value.tm_mon, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002309 if (err) {
2310 goto out_end;
2311 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002312 visit_type_int32(v, "tm_mday", &value.tm_mday, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002313 if (err) {
2314 goto out_end;
2315 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002316 visit_type_int32(v, "tm_hour", &value.tm_hour, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002317 if (err) {
2318 goto out_end;
2319 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002320 visit_type_int32(v, "tm_min", &value.tm_min, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002321 if (err) {
2322 goto out_end;
2323 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002324 visit_type_int32(v, "tm_sec", &value.tm_sec, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002325 if (err) {
2326 goto out_end;
2327 }
Eric Blake15c2f662016-04-28 15:45:27 -06002328 visit_check_struct(v, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002329out_end:
Eric Blake1158bb22016-06-09 10:48:34 -06002330 visit_end_struct(v, NULL);
David Gibson8e099d12015-02-06 14:55:45 +11002331out:
2332 error_propagate(errp, err);
2333
2334}
2335
2336static void property_release_tm(Object *obj, const char *name,
2337 void *opaque)
2338{
2339 TMProperty *prop = opaque;
2340 g_free(prop);
2341}
2342
Markus Armbruster70251882020-05-05 17:29:14 +02002343ObjectProperty *
2344object_property_add_tm(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002345 void (*get)(Object *, struct tm *, Error **))
David Gibson8e099d12015-02-06 14:55:45 +11002346{
David Gibson8e099d12015-02-06 14:55:45 +11002347 TMProperty *prop = g_malloc0(sizeof(*prop));
2348
2349 prop->get = get;
2350
Markus Armbrusterd2623122020-05-05 17:29:22 +02002351 return object_property_add(obj, name, "struct tm",
2352 get ? property_get_tm : NULL, NULL,
2353 property_release_tm,
2354 prop);
David Gibson8e099d12015-02-06 14:55:45 +11002355}
2356
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002357ObjectProperty *
2358object_class_property_add_tm(ObjectClass *klass, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002359 void (*get)(Object *, struct tm *, Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002360{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002361 TMProperty *prop = g_malloc0(sizeof(*prop));
2362
2363 prop->get = get;
2364
Markus Armbrusterd2623122020-05-05 17:29:22 +02002365 return object_class_property_add(klass, name, "struct tm",
2366 get ? property_get_tm : NULL,
2367 NULL, NULL, prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002368}
2369
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002370static char *qdev_get_type(Object *obj, Error **errp)
2371{
2372 return g_strdup(object_get_typename(obj));
2373}
2374
Eric Blaked7bce992016-01-29 06:48:55 -07002375static void property_get_uint8_ptr(Object *obj, Visitor *v, const char *name,
2376 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002377{
2378 uint8_t value = *(uint8_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002379 visit_type_uint8(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002380}
2381
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002382static void property_set_uint8_ptr(Object *obj, Visitor *v, const char *name,
2383 void *opaque, Error **errp)
2384{
2385 uint8_t *field = opaque;
2386 uint8_t value;
2387 Error *local_err = NULL;
2388
2389 visit_type_uint8(v, name, &value, &local_err);
2390 if (local_err) {
2391 error_propagate(errp, local_err);
2392 return;
2393 }
2394
2395 *field = value;
2396}
2397
Eric Blaked7bce992016-01-29 06:48:55 -07002398static void property_get_uint16_ptr(Object *obj, Visitor *v, const char *name,
2399 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002400{
2401 uint16_t value = *(uint16_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002402 visit_type_uint16(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002403}
2404
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002405static void property_set_uint16_ptr(Object *obj, Visitor *v, const char *name,
2406 void *opaque, Error **errp)
2407{
2408 uint16_t *field = opaque;
2409 uint16_t value;
2410 Error *local_err = NULL;
2411
2412 visit_type_uint16(v, name, &value, &local_err);
2413 if (local_err) {
2414 error_propagate(errp, local_err);
2415 return;
2416 }
2417
2418 *field = value;
2419}
2420
Eric Blaked7bce992016-01-29 06:48:55 -07002421static void property_get_uint32_ptr(Object *obj, Visitor *v, const char *name,
2422 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002423{
2424 uint32_t value = *(uint32_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002425 visit_type_uint32(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002426}
2427
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002428static void property_set_uint32_ptr(Object *obj, Visitor *v, const char *name,
2429 void *opaque, Error **errp)
2430{
2431 uint32_t *field = opaque;
2432 uint32_t value;
2433 Error *local_err = NULL;
2434
2435 visit_type_uint32(v, name, &value, &local_err);
2436 if (local_err) {
2437 error_propagate(errp, local_err);
2438 return;
2439 }
2440
2441 *field = value;
2442}
2443
Eric Blaked7bce992016-01-29 06:48:55 -07002444static void property_get_uint64_ptr(Object *obj, Visitor *v, const char *name,
2445 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002446{
2447 uint64_t value = *(uint64_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002448 visit_type_uint64(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002449}
2450
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002451static void property_set_uint64_ptr(Object *obj, Visitor *v, const char *name,
2452 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002453{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002454 uint64_t *field = opaque;
2455 uint64_t value;
2456 Error *local_err = NULL;
2457
2458 visit_type_uint64(v, name, &value, &local_err);
2459 if (local_err) {
2460 error_propagate(errp, local_err);
2461 return;
2462 }
2463
2464 *field = value;
2465}
2466
Markus Armbruster70251882020-05-05 17:29:14 +02002467ObjectProperty *
2468object_property_add_uint8_ptr(Object *obj, const char *name,
2469 const uint8_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002470 ObjectPropertyFlags flags)
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002471{
2472 ObjectPropertyAccessor *getter = NULL;
2473 ObjectPropertyAccessor *setter = NULL;
2474
2475 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2476 getter = property_get_uint8_ptr;
2477 }
2478
2479 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2480 setter = property_set_uint8_ptr;
2481 }
2482
Markus Armbruster70251882020-05-05 17:29:14 +02002483 return object_property_add(obj, name, "uint8",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002484 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002485}
2486
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002487ObjectProperty *
2488object_class_property_add_uint8_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002489 const uint8_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002490 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002491{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002492 ObjectPropertyAccessor *getter = NULL;
2493 ObjectPropertyAccessor *setter = NULL;
2494
2495 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2496 getter = property_get_uint8_ptr;
2497 }
2498
2499 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2500 setter = property_set_uint8_ptr;
2501 }
2502
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002503 return object_class_property_add(klass, name, "uint8",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002504 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002505}
2506
Markus Armbruster70251882020-05-05 17:29:14 +02002507ObjectProperty *
2508object_property_add_uint16_ptr(Object *obj, const char *name,
2509 const uint16_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002510 ObjectPropertyFlags flags)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002511{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002512 ObjectPropertyAccessor *getter = NULL;
2513 ObjectPropertyAccessor *setter = NULL;
2514
2515 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2516 getter = property_get_uint16_ptr;
2517 }
2518
2519 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2520 setter = property_set_uint16_ptr;
2521 }
2522
Markus Armbruster70251882020-05-05 17:29:14 +02002523 return object_property_add(obj, name, "uint16",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002524 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002525}
2526
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002527ObjectProperty *
2528object_class_property_add_uint16_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002529 const uint16_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002530 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002531{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002532 ObjectPropertyAccessor *getter = NULL;
2533 ObjectPropertyAccessor *setter = NULL;
2534
2535 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2536 getter = property_get_uint16_ptr;
2537 }
2538
2539 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2540 setter = property_set_uint16_ptr;
2541 }
2542
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002543 return object_class_property_add(klass, name, "uint16",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002544 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002545}
2546
Markus Armbruster70251882020-05-05 17:29:14 +02002547ObjectProperty *
2548object_property_add_uint32_ptr(Object *obj, const char *name,
2549 const uint32_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002550 ObjectPropertyFlags flags)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002551{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002552 ObjectPropertyAccessor *getter = NULL;
2553 ObjectPropertyAccessor *setter = NULL;
2554
2555 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2556 getter = property_get_uint32_ptr;
2557 }
2558
2559 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2560 setter = property_set_uint32_ptr;
2561 }
2562
Markus Armbruster70251882020-05-05 17:29:14 +02002563 return object_property_add(obj, name, "uint32",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002564 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002565}
2566
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002567ObjectProperty *
2568object_class_property_add_uint32_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002569 const uint32_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002570 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002571{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002572 ObjectPropertyAccessor *getter = NULL;
2573 ObjectPropertyAccessor *setter = NULL;
2574
2575 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2576 getter = property_get_uint32_ptr;
2577 }
2578
2579 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2580 setter = property_set_uint32_ptr;
2581 }
2582
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002583 return object_class_property_add(klass, name, "uint32",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002584 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002585}
2586
Markus Armbruster70251882020-05-05 17:29:14 +02002587ObjectProperty *
2588object_property_add_uint64_ptr(Object *obj, const char *name,
2589 const uint64_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002590 ObjectPropertyFlags flags)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002591{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002592 ObjectPropertyAccessor *getter = NULL;
2593 ObjectPropertyAccessor *setter = NULL;
2594
2595 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2596 getter = property_get_uint64_ptr;
2597 }
2598
2599 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2600 setter = property_set_uint64_ptr;
2601 }
2602
Markus Armbruster70251882020-05-05 17:29:14 +02002603 return object_property_add(obj, name, "uint64",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002604 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002605}
2606
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002607ObjectProperty *
2608object_class_property_add_uint64_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002609 const uint64_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002610 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002611{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002612 ObjectPropertyAccessor *getter = NULL;
2613 ObjectPropertyAccessor *setter = NULL;
2614
2615 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2616 getter = property_get_uint64_ptr;
2617 }
2618
2619 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2620 setter = property_set_uint64_ptr;
2621 }
2622
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002623 return object_class_property_add(klass, name, "uint64",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002624 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002625}
2626
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002627typedef struct {
2628 Object *target_obj;
Eduardo Habkost1590d262015-04-09 16:57:29 -03002629 char *target_name;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002630} AliasProperty;
2631
Eric Blaked7bce992016-01-29 06:48:55 -07002632static void property_get_alias(Object *obj, Visitor *v, const char *name,
2633 void *opaque, Error **errp)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002634{
2635 AliasProperty *prop = opaque;
2636
2637 object_property_get(prop->target_obj, v, prop->target_name, errp);
2638}
2639
Eric Blaked7bce992016-01-29 06:48:55 -07002640static void property_set_alias(Object *obj, Visitor *v, const char *name,
2641 void *opaque, Error **errp)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002642{
2643 AliasProperty *prop = opaque;
2644
2645 object_property_set(prop->target_obj, v, prop->target_name, errp);
2646}
2647
Paolo Bonzini64607d02014-06-05 13:11:51 +02002648static Object *property_resolve_alias(Object *obj, void *opaque,
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02002649 const char *part)
Paolo Bonzini64607d02014-06-05 13:11:51 +02002650{
2651 AliasProperty *prop = opaque;
2652
2653 return object_resolve_path_component(prop->target_obj, prop->target_name);
2654}
2655
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002656static void property_release_alias(Object *obj, const char *name, void *opaque)
2657{
2658 AliasProperty *prop = opaque;
2659
Eduardo Habkost1590d262015-04-09 16:57:29 -03002660 g_free(prop->target_name);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002661 g_free(prop);
2662}
2663
Markus Armbruster70251882020-05-05 17:29:14 +02002664ObjectProperty *
2665object_property_add_alias(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002666 Object *target_obj, const char *target_name)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002667{
2668 AliasProperty *prop;
Paolo Bonzini64607d02014-06-05 13:11:51 +02002669 ObjectProperty *op;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002670 ObjectProperty *target_prop;
Markus Armbruster70251882020-05-05 17:29:14 +02002671 g_autofree char *prop_type = NULL;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002672
Markus Armbrusterd2623122020-05-05 17:29:22 +02002673 target_prop = object_property_find(target_obj, target_name,
2674 &error_abort);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002675
Paolo Bonzinid1906982014-06-10 11:17:35 +02002676 if (object_property_is_child(target_prop)) {
2677 prop_type = g_strdup_printf("link%s",
2678 target_prop->type + strlen("child"));
2679 } else {
2680 prop_type = g_strdup(target_prop->type);
2681 }
2682
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002683 prop = g_malloc(sizeof(*prop));
2684 prop->target_obj = target_obj;
Eduardo Habkost1590d262015-04-09 16:57:29 -03002685 prop->target_name = g_strdup(target_name);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002686
Paolo Bonzinid1906982014-06-10 11:17:35 +02002687 op = object_property_add(obj, name, prop_type,
Paolo Bonzini64607d02014-06-05 13:11:51 +02002688 property_get_alias,
2689 property_set_alias,
2690 property_release_alias,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002691 prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02002692 op->resolve = property_resolve_alias;
Marc-André Lureau0e76ed02020-01-10 19:30:23 +04002693 if (target_prop->defval) {
2694 op->defval = qobject_ref(target_prop->defval);
2695 }
Paolo Bonzinid1906982014-06-10 11:17:35 +02002696
Andreas Färbera18bb412015-03-27 17:34:10 +01002697 object_property_set_description(obj, op->name,
Markus Armbruster7eecec72020-05-05 17:29:15 +02002698 target_prop->description);
Markus Armbruster70251882020-05-05 17:29:14 +02002699 return op;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002700}
2701
Gonglei80742642014-10-07 14:33:21 +08002702void object_property_set_description(Object *obj, const char *name,
Markus Armbruster7eecec72020-05-05 17:29:15 +02002703 const char *description)
Gonglei80742642014-10-07 14:33:21 +08002704{
2705 ObjectProperty *op;
2706
Markus Armbruster7eecec72020-05-05 17:29:15 +02002707 op = object_property_find(obj, name, &error_abort);
Gonglei80742642014-10-07 14:33:21 +08002708 g_free(op->description);
2709 op->description = g_strdup(description);
2710}
2711
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002712void object_class_property_set_description(ObjectClass *klass,
2713 const char *name,
Markus Armbruster7eecec72020-05-05 17:29:15 +02002714 const char *description)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002715{
2716 ObjectProperty *op;
2717
2718 op = g_hash_table_lookup(klass->properties, name);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002719 g_free(op->description);
2720 op->description = g_strdup(description);
2721}
2722
Marc-André Lureau7439a032018-09-06 18:09:32 +04002723static void object_class_init(ObjectClass *klass, void *data)
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002724{
Marc-André Lureau7439a032018-09-06 18:09:32 +04002725 object_class_property_add_str(klass, "type", qdev_get_type,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002726 NULL);
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002727}
2728
Paolo Bonzini745549c2012-03-31 16:45:54 +02002729static void register_types(void)
2730{
2731 static TypeInfo interface_info = {
2732 .name = TYPE_INTERFACE,
Anthony Liguori33e95c62012-08-10 13:16:10 +10002733 .class_size = sizeof(InterfaceClass),
Paolo Bonzini745549c2012-03-31 16:45:54 +02002734 .abstract = true,
2735 };
2736
2737 static TypeInfo object_info = {
2738 .name = TYPE_OBJECT,
2739 .instance_size = sizeof(Object),
Marc-André Lureau7439a032018-09-06 18:09:32 +04002740 .class_init = object_class_init,
Paolo Bonzini745549c2012-03-31 16:45:54 +02002741 .abstract = true,
2742 };
2743
Paolo Bonzini049cb3c2012-04-04 15:58:40 +02002744 type_interface = type_register_internal(&interface_info);
2745 type_register_internal(&object_info);
Paolo Bonzini745549c2012-03-31 16:45:54 +02002746}
2747
2748type_init(register_types)