blob: be8fed66887c5d7a01371684fbda24ed8506b1ce [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
Masahiro Yamada3d912932020-05-13 03:25:01 +0900265 ti->class->interfaces = g_slist_append(ti->class->interfaces, new_iface);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600266}
267
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +0100268static void object_property_free(gpointer data)
269{
270 ObjectProperty *prop = data;
271
Marc-André Lureau0e76ed02020-01-10 19:30:23 +0400272 if (prop->defval) {
273 qobject_unref(prop->defval);
274 prop->defval = NULL;
275 }
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +0100276 g_free(prop->name);
277 g_free(prop->type);
278 g_free(prop->description);
279 g_free(prop);
280}
281
Igor Mitsyankoac451032012-02-28 15:57:11 +0400282static void type_initialize(TypeImpl *ti)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600283{
Paolo Bonzini745549c2012-03-31 16:45:54 +0200284 TypeImpl *parent;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600285
286 if (ti->class) {
287 return;
288 }
289
290 ti->class_size = type_class_get_size(ti);
Igor Mitsyankoaca59af2012-02-28 15:57:10 +0400291 ti->instance_size = type_object_get_size(ti);
Eduardo Habkost1c6d75d2016-12-12 16:31:01 -0200292 /* Any type with zero instance_size is implicitly abstract.
293 * This means interface types are all abstract.
294 */
295 if (ti->instance_size == 0) {
296 ti->abstract = true;
297 }
Marc-André Lureau422ca142018-09-12 16:53:03 +0400298 if (type_is_ancestor(ti, type_interface)) {
299 assert(ti->instance_size == 0);
300 assert(ti->abstract);
301 assert(!ti->instance_init);
302 assert(!ti->instance_post_init);
303 assert(!ti->instance_finalize);
304 assert(!ti->num_interfaces);
305 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600306 ti->class = g_malloc0(ti->class_size);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600307
Paolo Bonzini745549c2012-03-31 16:45:54 +0200308 parent = type_get_parent(ti);
309 if (parent) {
Igor Mitsyankoac451032012-02-28 15:57:11 +0400310 type_initialize(parent);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000311 GSList *e;
312 int i;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600313
Markus Armbruster719a3072018-06-08 19:02:31 +0200314 g_assert(parent->class_size <= ti->class_size);
Marc-André Lureaud5e633f2020-01-10 19:30:14 +0400315 g_assert(parent->instance_size <= ti->instance_size);
Paolo Bonzini745549c2012-03-31 16:45:54 +0200316 memcpy(ti->class, parent->class, parent->class_size);
Peter Crosthwaite3e407de2013-02-19 14:02:09 +1000317 ti->class->interfaces = NULL;
Anthony Liguori33e95c62012-08-10 13:16:10 +1000318
319 for (e = parent->class->interfaces; e; e = e->next) {
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100320 InterfaceClass *iface = e->data;
321 ObjectClass *klass = OBJECT_CLASS(iface);
322
323 type_initialize_interface(ti, iface->interface_type, klass->type);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000324 }
325
326 for (i = 0; i < ti->num_interfaces; i++) {
327 TypeImpl *t = type_get_by_name(ti->interfaces[i].typename);
Philippe Mathieu-Daudéa9ee3a92020-01-18 17:23:48 +0100328 if (!t) {
329 error_report("missing interface '%s' for object '%s'",
330 ti->interfaces[i].typename, parent->name);
331 abort();
332 }
Anthony Liguori33e95c62012-08-10 13:16:10 +1000333 for (e = ti->class->interfaces; e; e = e->next) {
334 TypeImpl *target_type = OBJECT_CLASS(e->data)->type;
335
336 if (type_is_ancestor(target_type, t)) {
337 break;
338 }
339 }
340
341 if (e) {
342 continue;
343 }
344
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100345 type_initialize_interface(ti, t, t);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000346 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600347 }
348
Masahiro Yamadae5a0cc52020-05-13 02:26:15 +0900349 ti->class->properties = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
350 object_property_free);
351
Paolo Bonzini745549c2012-03-31 16:45:54 +0200352 ti->class->type = ti;
353
354 while (parent) {
355 if (parent->class_base_init) {
356 parent->class_base_init(ti->class, ti->class_data);
357 }
358 parent = type_get_parent(parent);
359 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600360
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600361 if (ti->class_init) {
362 ti->class_init(ti->class, ti->class_data);
363 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600364}
365
366static void object_init_with_type(Object *obj, TypeImpl *ti)
367{
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600368 if (type_has_parent(ti)) {
369 object_init_with_type(obj, type_get_parent(ti));
370 }
371
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600372 if (ti->instance_init) {
373 ti->instance_init(obj);
374 }
375}
376
Eduardo Habkost8231c2d2013-07-10 17:08:41 -0300377static void object_post_init_with_type(Object *obj, TypeImpl *ti)
378{
379 if (ti->instance_post_init) {
380 ti->instance_post_init(obj);
381 }
382
383 if (type_has_parent(ti)) {
384 object_post_init_with_type(obj, type_get_parent(ti));
385 }
386}
387
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400388void object_apply_global_props(Object *obj, const GPtrArray *props, Error **errp)
389{
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400390 int i;
391
392 if (!props) {
393 return;
394 }
395
396 for (i = 0; i < props->len; i++) {
397 GlobalProperty *p = g_ptr_array_index(props, i);
Eduardo Habkostd769f0d2019-01-10 00:02:57 -0200398 Error *err = NULL;
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400399
400 if (object_dynamic_cast(obj, p->driver) == NULL) {
401 continue;
402 }
Dr. David Alan Gilbert92fd4532019-07-29 17:29:02 +0100403 if (p->optional && !object_property_find(obj, p->property, NULL)) {
404 continue;
405 }
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400406 p->used = true;
407 object_property_parse(obj, p->value, p->property, &err);
408 if (err != NULL) {
409 error_prepend(&err, "can't apply global %s.%s=%s: ",
410 p->driver, p->property, p->value);
Marc-André Lureau50545b22018-11-07 15:35:34 +0400411 /*
412 * If errp != NULL, propagate error and return.
413 * If errp == NULL, report a warning, but keep going
414 * with the remaining globals.
415 */
416 if (errp) {
417 error_propagate(errp, err);
418 return;
419 } else {
420 warn_report_err(err);
421 }
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400422 }
423 }
424}
425
Markus Armbruster617902a2019-03-08 14:14:35 +0100426/*
427 * Global property defaults
428 * Slot 0: accelerator's global property defaults
429 * Slot 1: machine's global property defaults
Paolo Bonzini1fff3c22019-11-13 13:33:44 +0100430 * Slot 2: global properties from legacy command line option
Markus Armbruster617902a2019-03-08 14:14:35 +0100431 * Each is a GPtrArray of of GlobalProperty.
432 * Applied in order, later entries override earlier ones.
433 */
Paolo Bonzini1fff3c22019-11-13 13:33:44 +0100434static GPtrArray *object_compat_props[3];
435
436/*
437 * Retrieve @GPtrArray for global property defined with options
438 * other than "-global". These are generally used for syntactic
439 * sugar and legacy command line options.
440 */
441void object_register_sugar_prop(const char *driver, const char *prop, const char *value)
442{
443 GlobalProperty *g;
444 if (!object_compat_props[2]) {
445 object_compat_props[2] = g_ptr_array_new();
446 }
447 g = g_new0(GlobalProperty, 1);
448 g->driver = g_strdup(driver);
449 g->property = g_strdup(prop);
450 g->value = g_strdup(value);
451 g_ptr_array_add(object_compat_props[2], g);
452}
Markus Armbruster617902a2019-03-08 14:14:35 +0100453
454/*
455 * Set machine's global property defaults to @compat_props.
456 * May be called at most once.
457 */
458void object_set_machine_compat_props(GPtrArray *compat_props)
459{
460 assert(!object_compat_props[1]);
461 object_compat_props[1] = compat_props;
462}
463
464/*
465 * Set accelerator's global property defaults to @compat_props.
466 * May be called at most once.
467 */
468void object_set_accelerator_compat_props(GPtrArray *compat_props)
469{
470 assert(!object_compat_props[0]);
471 object_compat_props[0] = compat_props;
472}
473
474void object_apply_compat_props(Object *obj)
475{
476 int i;
477
478 for (i = 0; i < ARRAY_SIZE(object_compat_props); i++) {
479 object_apply_global_props(obj, object_compat_props[i],
Paolo Bonzini1fff3c22019-11-13 13:33:44 +0100480 i == 2 ? &error_fatal : &error_abort);
Markus Armbruster617902a2019-03-08 14:14:35 +0100481 }
482}
483
Marc-André Lureau2a1be4b2020-01-10 19:30:19 +0400484static void object_class_property_init_all(Object *obj)
485{
486 ObjectPropertyIterator iter;
487 ObjectProperty *prop;
488
489 object_class_property_iter_init(&iter, object_get_class(obj));
490 while ((prop = object_property_iter_next(&iter))) {
491 if (prop->init) {
492 prop->init(obj, prop);
493 }
494 }
495}
496
Masahiro Yamadae27a9592020-05-13 02:31:04 +0900497static void object_initialize_with_type(Object *obj, size_t size, TypeImpl *type)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600498{
Igor Mitsyankoac451032012-02-28 15:57:11 +0400499 type_initialize(type);
Igor Mitsyankoaca59af2012-02-28 15:57:10 +0400500
Markus Armbruster719a3072018-06-08 19:02:31 +0200501 g_assert(type->instance_size >= sizeof(Object));
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600502 g_assert(type->abstract == false);
Markus Armbruster719a3072018-06-08 19:02:31 +0200503 g_assert(size >= type->instance_size);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600504
505 memset(obj, 0, type->instance_size);
506 obj->class = type->class;
Paolo Bonzini764b6312012-11-23 09:47:12 +0100507 object_ref(obj);
Marc-André Lureau2a1be4b2020-01-10 19:30:19 +0400508 object_class_property_init_all(obj);
Pavel Fedinb604a852015-10-13 13:37:45 +0100509 obj->properties = g_hash_table_new_full(g_str_hash, g_str_equal,
510 NULL, object_property_free);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600511 object_init_with_type(obj, type);
Eduardo Habkost8231c2d2013-07-10 17:08:41 -0300512 object_post_init_with_type(obj, type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600513}
514
Andreas Färber213f0c42013-08-23 19:37:12 +0200515void object_initialize(void *data, size_t size, const char *typename)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600516{
517 TypeImpl *type = type_get_by_name(typename);
518
Philippe Mathieu-Daudée02bdf12019-04-27 15:56:42 +0200519 if (!type) {
520 error_report("missing object type '%s'", typename);
521 abort();
522 }
523
Andreas Färber5b9237f2013-08-30 18:28:37 +0200524 object_initialize_with_type(data, size, type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600525}
526
Markus Armbruster9fc7fc42020-06-10 07:32:25 +0200527void object_initialize_child_with_props(Object *parentobj,
528 const char *propname,
Thomas Huth0210b392018-07-16 14:59:18 +0200529 void *childobj, size_t size, const char *type,
530 Error **errp, ...)
531{
532 va_list vargs;
533
534 va_start(vargs, errp);
Markus Armbruster9fc7fc42020-06-10 07:32:25 +0200535 object_initialize_child_with_propsv(parentobj, propname,
536 childobj, size, type, errp, vargs);
Thomas Huth0210b392018-07-16 14:59:18 +0200537 va_end(vargs);
538}
539
Markus Armbruster9fc7fc42020-06-10 07:32:25 +0200540void object_initialize_child_with_propsv(Object *parentobj,
541 const char *propname,
Thomas Huth0210b392018-07-16 14:59:18 +0200542 void *childobj, size_t size, const char *type,
543 Error **errp, va_list vargs)
544{
545 Error *local_err = NULL;
546 Object *obj;
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400547 UserCreatable *uc;
Thomas Huth0210b392018-07-16 14:59:18 +0200548
549 object_initialize(childobj, size, type);
550 obj = OBJECT(childobj);
551
Markus Armbruster1c94a352020-07-07 18:05:53 +0200552 if (object_set_propv(obj, errp, vargs) < 0) {
Thomas Huth0210b392018-07-16 14:59:18 +0200553 goto out;
554 }
555
Markus Armbrusterd2623122020-05-05 17:29:22 +0200556 object_property_add_child(parentobj, propname, obj);
Thomas Huth0210b392018-07-16 14:59:18 +0200557
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400558 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
559 if (uc) {
560 user_creatable_complete(uc, &local_err);
Thomas Huth0210b392018-07-16 14:59:18 +0200561 if (local_err) {
562 object_unparent(obj);
563 goto out;
564 }
565 }
566
Markus Armbruster975ac452020-05-05 17:29:09 +0200567out:
Thomas Huth0210b392018-07-16 14:59:18 +0200568 /*
Markus Armbruster975ac452020-05-05 17:29:09 +0200569 * We want @obj's reference to be 1 on success, 0 on failure.
570 * On success, it's 2: one taken by object_initialize(), and one
571 * by object_property_add_child().
572 * On failure in object_initialize() or earlier, it's 1.
573 * On failure afterwards, it's also 1: object_unparent() releases
574 * the reference taken by object_property_add_child().
Thomas Huth0210b392018-07-16 14:59:18 +0200575 */
576 object_unref(obj);
577
Markus Armbruster975ac452020-05-05 17:29:09 +0200578 error_propagate(errp, local_err);
Thomas Huth0210b392018-07-16 14:59:18 +0200579}
580
Markus Armbruster9fc7fc42020-06-10 07:32:25 +0200581void object_initialize_child_internal(Object *parent,
582 const char *propname,
583 void *child, size_t size,
584 const char *type)
585{
586 object_initialize_child_with_props(parent, propname, child, size, type,
587 &error_abort, NULL);
588}
589
Andreas Färber5d9d3f42012-05-27 00:32:40 +0200590static inline bool object_property_is_child(ObjectProperty *prop)
591{
592 return strstart(prop->type, "child<", NULL);
593}
594
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600595static void object_property_del_all(Object *obj)
596{
Marc-André Lureau9859fac2020-01-10 19:30:30 +0400597 g_autoptr(GHashTable) done = g_hash_table_new(NULL, NULL);
Pavel Fedinb604a852015-10-13 13:37:45 +0100598 ObjectProperty *prop;
Marc-André Lureau9859fac2020-01-10 19:30:30 +0400599 ObjectPropertyIterator iter;
Pavel Fedinb604a852015-10-13 13:37:45 +0100600 bool released;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600601
Pavel Fedinb604a852015-10-13 13:37:45 +0100602 do {
603 released = false;
Marc-André Lureau9859fac2020-01-10 19:30:30 +0400604 object_property_iter_init(&iter, obj);
605 while ((prop = object_property_iter_next(&iter)) != NULL) {
606 if (g_hash_table_add(done, prop)) {
607 if (prop->release) {
608 prop->release(obj, prop->name, prop->opaque);
609 released = true;
610 break;
611 }
Pavel Fedinb604a852015-10-13 13:37:45 +0100612 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600613 }
Pavel Fedinb604a852015-10-13 13:37:45 +0100614 } while (released);
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600615
Pavel Fedinb604a852015-10-13 13:37:45 +0100616 g_hash_table_unref(obj->properties);
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600617}
618
Markus Armbrusterf73a32a2020-05-05 17:29:11 +0200619static void object_property_del_child(Object *obj, Object *child)
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600620{
621 ObjectProperty *prop;
Pavel Fedinb604a852015-10-13 13:37:45 +0100622 GHashTableIter iter;
623 gpointer key, value;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600624
Pavel Fedinb604a852015-10-13 13:37:45 +0100625 g_hash_table_iter_init(&iter, obj->properties);
626 while (g_hash_table_iter_next(&iter, &key, &value)) {
627 prop = value;
Andreas Färber5d9d3f42012-05-27 00:32:40 +0200628 if (object_property_is_child(prop) && prop->opaque == child) {
Pavel Fedinb604a852015-10-13 13:37:45 +0100629 if (prop->release) {
630 prop->release(obj, prop->name, prop->opaque);
631 prop->release = NULL;
632 }
633 break;
634 }
635 }
636 g_hash_table_iter_init(&iter, obj->properties);
637 while (g_hash_table_iter_next(&iter, &key, &value)) {
638 prop = value;
639 if (object_property_is_child(prop) && prop->opaque == child) {
640 g_hash_table_iter_remove(&iter);
Paolo Bonzini6c1fdcf2012-02-28 09:54:15 +0100641 break;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600642 }
643 }
644}
645
646void object_unparent(Object *obj)
647{
Michael S. Tsirkine998fa82013-03-18 21:01:37 +0200648 if (obj->parent) {
Markus Armbrusterf73a32a2020-05-05 17:29:11 +0200649 object_property_del_child(obj->parent, obj);
Michael S. Tsirkine998fa82013-03-18 21:01:37 +0200650 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600651}
652
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600653static void object_deinit(Object *obj, TypeImpl *type)
654{
655 if (type->instance_finalize) {
656 type->instance_finalize(obj);
657 }
658
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600659 if (type_has_parent(type)) {
660 object_deinit(obj, type_get_parent(type));
661 }
662}
663
Paolo Bonzini339c2702012-11-23 09:47:16 +0100664static void object_finalize(void *data)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600665{
666 Object *obj = data;
667 TypeImpl *ti = obj->class->type;
668
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600669 object_property_del_all(obj);
Paolo Bonzini76a6e1c2014-06-11 11:58:30 +0200670 object_deinit(obj, ti);
Anthony Liguoridb85b572011-12-23 08:47:39 -0600671
Markus Armbruster719a3072018-06-08 19:02:31 +0200672 g_assert(obj->ref == 0);
Paolo Bonzinifde9bf42012-11-23 09:47:14 +0100673 if (obj->free) {
674 obj->free(obj);
675 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600676}
677
Marc-André Lureau63f7b102016-12-12 20:31:51 +0300678static Object *object_new_with_type(Type type)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600679{
680 Object *obj;
681
682 g_assert(type != NULL);
Igor Mitsyankoac451032012-02-28 15:57:11 +0400683 type_initialize(type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600684
685 obj = g_malloc(type->instance_size);
Andreas Färber5b9237f2013-08-30 18:28:37 +0200686 object_initialize_with_type(obj, type->instance_size, type);
Paolo Bonzinifde9bf42012-11-23 09:47:14 +0100687 obj->free = g_free;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600688
689 return obj;
690}
691
Paolo Bonzini3c75e122019-11-13 13:57:55 +0100692Object *object_new_with_class(ObjectClass *klass)
693{
694 return object_new_with_type(klass->type);
695}
696
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600697Object *object_new(const char *typename)
698{
699 TypeImpl *ti = type_get_by_name(typename);
700
701 return object_new_with_type(ti);
702}
703
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100704
705Object *object_new_with_props(const char *typename,
706 Object *parent,
707 const char *id,
708 Error **errp,
709 ...)
710{
711 va_list vargs;
712 Object *obj;
713
714 va_start(vargs, errp);
715 obj = object_new_with_propv(typename, parent, id, errp, vargs);
716 va_end(vargs);
717
718 return obj;
719}
720
721
722Object *object_new_with_propv(const char *typename,
723 Object *parent,
724 const char *id,
725 Error **errp,
726 va_list vargs)
727{
728 Object *obj;
729 ObjectClass *klass;
730 Error *local_err = NULL;
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400731 UserCreatable *uc;
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100732
733 klass = object_class_by_name(typename);
734 if (!klass) {
735 error_setg(errp, "invalid object type: %s", typename);
736 return NULL;
737 }
738
739 if (object_class_is_abstract(klass)) {
740 error_setg(errp, "object type '%s' is abstract", typename);
741 return NULL;
742 }
Wei Yang66e11552019-03-11 16:32:34 +0800743 obj = object_new_with_type(klass->type);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100744
Markus Armbruster1c94a352020-07-07 18:05:53 +0200745 if (object_set_propv(obj, errp, vargs) < 0) {
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100746 goto error;
747 }
748
Daniel P. Berrangé6134d752018-06-15 16:39:35 +0100749 if (id != NULL) {
Markus Armbrusterd2623122020-05-05 17:29:22 +0200750 object_property_add_child(parent, id, obj);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100751 }
752
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400753 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
754 if (uc) {
755 user_creatable_complete(uc, &local_err);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100756 if (local_err) {
Daniel P. Berrangé6134d752018-06-15 16:39:35 +0100757 if (id != NULL) {
758 object_unparent(obj);
759 }
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100760 goto error;
761 }
762 }
763
Philippe Mathieu-Daudé688ffbb2020-05-12 09:00:19 +0200764 object_unref(obj);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100765 return obj;
766
767 error:
Eduardo Habkost621ff942016-06-13 18:57:56 -0300768 error_propagate(errp, local_err);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100769 object_unref(obj);
770 return NULL;
771}
772
773
774int object_set_props(Object *obj,
775 Error **errp,
776 ...)
777{
778 va_list vargs;
779 int ret;
780
781 va_start(vargs, errp);
782 ret = object_set_propv(obj, errp, vargs);
783 va_end(vargs);
784
785 return ret;
786}
787
788
789int object_set_propv(Object *obj,
790 Error **errp,
791 va_list vargs)
792{
793 const char *propname;
794 Error *local_err = NULL;
795
796 propname = va_arg(vargs, char *);
797 while (propname != NULL) {
798 const char *value = va_arg(vargs, char *);
799
800 g_assert(value != NULL);
801 object_property_parse(obj, value, propname, &local_err);
802 if (local_err) {
803 error_propagate(errp, local_err);
804 return -1;
805 }
806 propname = va_arg(vargs, char *);
807 }
808
809 return 0;
810}
811
812
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600813Object *object_dynamic_cast(Object *obj, const char *typename)
814{
Paolo Bonzinib7f43fe2012-11-23 16:56:17 +0100815 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
Paolo Bonziniacc4af32012-02-03 11:57:23 +0100816 return obj;
817 }
818
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600819 return NULL;
820}
821
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200822Object *object_dynamic_cast_assert(Object *obj, const char *typename,
823 const char *file, int line, const char *func)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600824{
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200825 trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
826 typename, file, line, func);
827
Paolo Bonzini3556c232013-05-10 14:16:40 +0200828#ifdef CONFIG_QOM_CAST_DEBUG
Anthony Liguori03587322013-05-13 15:22:24 -0500829 int i;
830 Object *inst;
831
Peter Crosthwaite95916ab2013-05-22 11:19:16 +1000832 for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100833 if (atomic_read(&obj->class->object_cast_cache[i]) == typename) {
Anthony Liguori03587322013-05-13 15:22:24 -0500834 goto out;
835 }
836 }
837
838 inst = object_dynamic_cast(obj, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600839
Paolo Bonzinib7f43fe2012-11-23 16:56:17 +0100840 if (!inst && obj) {
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200841 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
842 file, line, func, obj, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600843 abort();
844 }
845
Paolo Bonzini3556c232013-05-10 14:16:40 +0200846 assert(obj == inst);
Anthony Liguori03587322013-05-13 15:22:24 -0500847
Peter Crosthwaite95916ab2013-05-22 11:19:16 +1000848 if (obj && obj == inst) {
Anthony Liguori03587322013-05-13 15:22:24 -0500849 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100850 atomic_set(&obj->class->object_cast_cache[i - 1],
851 atomic_read(&obj->class->object_cast_cache[i]));
Anthony Liguori03587322013-05-13 15:22:24 -0500852 }
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100853 atomic_set(&obj->class->object_cast_cache[i - 1], typename);
Anthony Liguori03587322013-05-13 15:22:24 -0500854 }
855
856out:
Paolo Bonzini3556c232013-05-10 14:16:40 +0200857#endif
858 return obj;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600859}
860
861ObjectClass *object_class_dynamic_cast(ObjectClass *class,
862 const char *typename)
863{
Anthony Liguori33e95c62012-08-10 13:16:10 +1000864 ObjectClass *ret = NULL;
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200865 TypeImpl *target_type;
866 TypeImpl *type;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600867
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200868 if (!class) {
869 return NULL;
870 }
871
Paolo Bonzini793c96b2013-05-10 14:16:37 +0200872 /* A simple fast path that can trigger a lot for leaf classes. */
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200873 type = class->type;
Paolo Bonzini793c96b2013-05-10 14:16:37 +0200874 if (type->name == typename) {
875 return class;
876 }
877
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200878 target_type = type_get_by_name(typename);
Alexander Graf9ab880b2013-04-30 15:02:16 +0200879 if (!target_type) {
880 /* target class type unknown, so fail the cast */
881 return NULL;
882 }
883
Peter Crosthwaite00e2cea2013-02-19 14:02:10 +1000884 if (type->class->interfaces &&
885 type_is_ancestor(target_type, type_interface)) {
Anthony Liguori33e95c62012-08-10 13:16:10 +1000886 int found = 0;
887 GSList *i;
888
889 for (i = class->interfaces; i; i = i->next) {
890 ObjectClass *target_class = i->data;
891
892 if (type_is_ancestor(target_class->type, target_type)) {
893 ret = target_class;
894 found++;
895 }
896 }
897
898 /* The match was ambiguous, don't allow a cast */
899 if (found > 1) {
900 ret = NULL;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600901 }
Anthony Liguori33e95c62012-08-10 13:16:10 +1000902 } else if (type_is_ancestor(type, target_type)) {
903 ret = class;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600904 }
905
Anthony Liguori33e95c62012-08-10 13:16:10 +1000906 return ret;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600907}
908
909ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200910 const char *typename,
911 const char *file, int line,
912 const char *func)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600913{
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200914 ObjectClass *ret;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600915
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200916 trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)",
917 typename, file, line, func);
918
Anthony Liguori03587322013-05-13 15:22:24 -0500919#ifdef CONFIG_QOM_CAST_DEBUG
920 int i;
921
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000922 for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100923 if (atomic_read(&class->class_cast_cache[i]) == typename) {
Anthony Liguori03587322013-05-13 15:22:24 -0500924 ret = class;
925 goto out;
926 }
927 }
928#else
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000929 if (!class || !class->interfaces) {
Paolo Bonzini3556c232013-05-10 14:16:40 +0200930 return class;
931 }
932#endif
933
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200934 ret = object_class_dynamic_cast(class, typename);
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200935 if (!ret && class) {
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200936 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
937 file, line, func, class, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600938 abort();
939 }
940
Anthony Liguori03587322013-05-13 15:22:24 -0500941#ifdef CONFIG_QOM_CAST_DEBUG
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000942 if (class && ret == class) {
Anthony Liguori03587322013-05-13 15:22:24 -0500943 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100944 atomic_set(&class->class_cast_cache[i - 1],
945 atomic_read(&class->class_cast_cache[i]));
Anthony Liguori03587322013-05-13 15:22:24 -0500946 }
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100947 atomic_set(&class->class_cast_cache[i - 1], typename);
Anthony Liguori03587322013-05-13 15:22:24 -0500948 }
949out:
950#endif
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600951 return ret;
952}
953
Igor Mammedov8f5d58e2017-07-14 10:14:50 +0800954const char *object_get_typename(const Object *obj)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600955{
956 return obj->class->type->name;
957}
958
959ObjectClass *object_get_class(Object *obj)
960{
961 return obj->class;
962}
963
Andreas Färber17862372013-01-23 12:20:18 +0100964bool object_class_is_abstract(ObjectClass *klass)
965{
966 return klass->type->abstract;
967}
968
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600969const char *object_class_get_name(ObjectClass *klass)
970{
971 return klass->type->name;
972}
973
974ObjectClass *object_class_by_name(const char *typename)
975{
976 TypeImpl *type = type_get_by_name(typename);
977
978 if (!type) {
979 return NULL;
980 }
981
Igor Mitsyankoac451032012-02-28 15:57:11 +0400982 type_initialize(type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600983
984 return type->class;
985}
986
Gerd Hoffmann0f8198f2020-06-24 15:10:37 +0200987ObjectClass *module_object_class_by_name(const char *typename)
988{
989 ObjectClass *oc;
990
991 oc = object_class_by_name(typename);
992#ifdef CONFIG_MODULES
993 if (!oc) {
994 module_load_qom_one(typename);
995 oc = object_class_by_name(typename);
996 }
997#endif
998 return oc;
999}
1000
Paolo Bonzinie7cce672012-05-02 13:30:54 +02001001ObjectClass *object_class_get_parent(ObjectClass *class)
1002{
1003 TypeImpl *type = type_get_parent(class->type);
1004
1005 if (!type) {
1006 return NULL;
1007 }
1008
1009 type_initialize(type);
1010
1011 return type->class;
1012}
1013
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001014typedef struct OCFData
1015{
1016 void (*fn)(ObjectClass *klass, void *opaque);
Anthony Liguori93c511a2011-12-22 14:11:53 -06001017 const char *implements_type;
1018 bool include_abstract;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001019 void *opaque;
1020} OCFData;
1021
1022static void object_class_foreach_tramp(gpointer key, gpointer value,
1023 gpointer opaque)
1024{
1025 OCFData *data = opaque;
1026 TypeImpl *type = value;
Anthony Liguori93c511a2011-12-22 14:11:53 -06001027 ObjectClass *k;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001028
Igor Mitsyankoac451032012-02-28 15:57:11 +04001029 type_initialize(type);
Anthony Liguori93c511a2011-12-22 14:11:53 -06001030 k = type->class;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001031
Anthony Liguori93c511a2011-12-22 14:11:53 -06001032 if (!data->include_abstract && type->abstract) {
1033 return;
1034 }
1035
1036 if (data->implements_type &&
1037 !object_class_dynamic_cast(k, data->implements_type)) {
1038 return;
1039 }
1040
1041 data->fn(k, data->opaque);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001042}
1043
1044void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
Anthony Liguori93c511a2011-12-22 14:11:53 -06001045 const char *implements_type, bool include_abstract,
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001046 void *opaque)
1047{
Anthony Liguori93c511a2011-12-22 14:11:53 -06001048 OCFData data = { fn, implements_type, include_abstract, opaque };
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001049
Hervé Poussineauf54c19c2013-12-03 16:42:00 +01001050 enumerating_types = true;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001051 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
Hervé Poussineauf54c19c2013-12-03 16:42:00 +01001052 enumerating_types = false;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001053}
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001054
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001055static int do_object_child_foreach(Object *obj,
1056 int (*fn)(Object *child, void *opaque),
1057 void *opaque, bool recurse)
Paolo Bonzini32efc532012-04-11 23:30:20 +02001058{
Pavel Fedinb604a852015-10-13 13:37:45 +01001059 GHashTableIter iter;
1060 ObjectProperty *prop;
Paolo Bonzini32efc532012-04-11 23:30:20 +02001061 int ret = 0;
1062
Pavel Fedinb604a852015-10-13 13:37:45 +01001063 g_hash_table_iter_init(&iter, obj->properties);
1064 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Paolo Bonzini32efc532012-04-11 23:30:20 +02001065 if (object_property_is_child(prop)) {
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001066 Object *child = prop->opaque;
1067
1068 ret = fn(child, opaque);
Paolo Bonzini32efc532012-04-11 23:30:20 +02001069 if (ret != 0) {
1070 break;
1071 }
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001072 if (recurse) {
Cédric Le Goater4a391812020-04-04 17:33:40 +02001073 ret = do_object_child_foreach(child, fn, opaque, true);
1074 if (ret != 0) {
1075 break;
1076 }
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001077 }
Paolo Bonzini32efc532012-04-11 23:30:20 +02001078 }
1079 }
1080 return ret;
1081}
1082
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001083int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
1084 void *opaque)
1085{
1086 return do_object_child_foreach(obj, fn, opaque, false);
1087}
1088
1089int object_child_foreach_recursive(Object *obj,
1090 int (*fn)(Object *child, void *opaque),
1091 void *opaque)
1092{
1093 return do_object_child_foreach(obj, fn, opaque, true);
1094}
1095
Andreas Färber418ba9e2012-02-25 23:07:34 +01001096static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
1097{
1098 GSList **list = opaque;
1099
1100 *list = g_slist_prepend(*list, klass);
1101}
1102
1103GSList *object_class_get_list(const char *implements_type,
1104 bool include_abstract)
1105{
1106 GSList *list = NULL;
1107
1108 object_class_foreach(object_class_get_list_tramp,
1109 implements_type, include_abstract, &list);
1110 return list;
1111}
1112
Paolo Bonzini47c66002018-03-03 08:33:10 +01001113static gint object_class_cmp(gconstpointer a, gconstpointer b)
1114{
1115 return strcasecmp(object_class_get_name((ObjectClass *)a),
1116 object_class_get_name((ObjectClass *)b));
1117}
1118
1119GSList *object_class_get_list_sorted(const char *implements_type,
1120 bool include_abstract)
1121{
1122 return g_slist_sort(object_class_get_list(implements_type, include_abstract),
1123 object_class_cmp);
1124}
1125
Marc-André Lureaub77ade92020-01-10 19:30:31 +04001126Object *object_ref(Object *obj)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001127{
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001128 if (!obj) {
Marc-André Lureaub77ade92020-01-10 19:30:31 +04001129 return NULL;
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001130 }
Andreas Färber8438a132015-11-16 17:49:20 +01001131 atomic_inc(&obj->ref);
Marc-André Lureaub77ade92020-01-10 19:30:31 +04001132 return obj;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001133}
1134
1135void object_unref(Object *obj)
1136{
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001137 if (!obj) {
1138 return;
1139 }
Markus Armbruster719a3072018-06-08 19:02:31 +02001140 g_assert(obj->ref > 0);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001141
1142 /* parent always holds a reference to its children */
Jan Kiszkaf08c03f2013-07-02 11:36:39 +02001143 if (atomic_fetch_dec(&obj->ref) == 1) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001144 object_finalize(obj);
1145 }
1146}
1147
Markus Armbrusterd2623122020-05-05 17:29:22 +02001148static ObjectProperty *
1149object_property_try_add(Object *obj, const char *name, const char *type,
1150 ObjectPropertyAccessor *get,
1151 ObjectPropertyAccessor *set,
1152 ObjectPropertyRelease *release,
1153 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001154{
Peter Maydell54852b02013-03-25 13:15:13 +00001155 ObjectProperty *prop;
Peter Crosthwaite33965902014-08-19 23:55:52 -07001156 size_t name_len = strlen(name);
1157
1158 if (name_len >= 3 && !memcmp(name + name_len - 3, "[*]", 4)) {
1159 int i;
1160 ObjectProperty *ret;
1161 char *name_no_array = g_strdup(name);
1162
1163 name_no_array[name_len - 3] = '\0';
1164 for (i = 0; ; ++i) {
1165 char *full_name = g_strdup_printf("%s[%d]", name_no_array, i);
1166
Markus Armbrusterd2623122020-05-05 17:29:22 +02001167 ret = object_property_try_add(obj, full_name, type, get, set,
1168 release, opaque, NULL);
Peter Crosthwaite33965902014-08-19 23:55:52 -07001169 g_free(full_name);
1170 if (ret) {
1171 break;
1172 }
1173 }
1174 g_free(name_no_array);
1175 return ret;
1176 }
Peter Maydell54852b02013-03-25 13:15:13 +00001177
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001178 if (object_property_find(obj, name, NULL) != NULL) {
Greg Kurzd55e9372019-11-04 14:23:55 +01001179 error_setg(errp, "attempt to add duplicate property '%s' to object (type '%s')",
1180 name, object_get_typename(obj));
Pavel Fedinb604a852015-10-13 13:37:45 +01001181 return NULL;
Peter Maydell54852b02013-03-25 13:15:13 +00001182 }
1183
1184 prop = g_malloc0(sizeof(*prop));
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001185
1186 prop->name = g_strdup(name);
1187 prop->type = g_strdup(type);
1188
1189 prop->get = get;
1190 prop->set = set;
1191 prop->release = release;
1192 prop->opaque = opaque;
1193
Pavel Fedinb604a852015-10-13 13:37:45 +01001194 g_hash_table_insert(obj->properties, prop->name, prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001195 return prop;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001196}
1197
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001198ObjectProperty *
Markus Armbrusterd2623122020-05-05 17:29:22 +02001199object_property_add(Object *obj, const char *name, const char *type,
1200 ObjectPropertyAccessor *get,
1201 ObjectPropertyAccessor *set,
1202 ObjectPropertyRelease *release,
1203 void *opaque)
1204{
1205 return object_property_try_add(obj, name, type, get, set, release,
1206 opaque, &error_abort);
1207}
1208
1209ObjectProperty *
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001210object_class_property_add(ObjectClass *klass,
1211 const char *name,
1212 const char *type,
1213 ObjectPropertyAccessor *get,
1214 ObjectPropertyAccessor *set,
1215 ObjectPropertyRelease *release,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001216 void *opaque)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001217{
1218 ObjectProperty *prop;
1219
Markus Armbrusterd2623122020-05-05 17:29:22 +02001220 assert(!object_class_property_find(klass, name, NULL));
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001221
1222 prop = g_malloc0(sizeof(*prop));
1223
1224 prop->name = g_strdup(name);
1225 prop->type = g_strdup(type);
1226
1227 prop->get = get;
1228 prop->set = set;
1229 prop->release = release;
1230 prop->opaque = opaque;
1231
Marc-André Lureauba806ff2020-01-10 19:30:18 +04001232 g_hash_table_insert(klass->properties, prop->name, prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001233
1234 return prop;
1235}
1236
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001237ObjectProperty *object_property_find(Object *obj, const char *name,
1238 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001239{
1240 ObjectProperty *prop;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001241 ObjectClass *klass = object_get_class(obj);
1242
1243 prop = object_class_property_find(klass, name, NULL);
1244 if (prop) {
1245 return prop;
1246 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001247
Pavel Fedinb604a852015-10-13 13:37:45 +01001248 prop = g_hash_table_lookup(obj->properties, name);
1249 if (prop) {
1250 return prop;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001251 }
1252
Cole Robinsonf231b882014-03-21 19:42:26 -04001253 error_setg(errp, "Property '.%s' not found", name);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001254 return NULL;
1255}
1256
Daniel P. Berrange7746abd2015-12-09 12:34:02 +00001257void object_property_iter_init(ObjectPropertyIterator *iter,
1258 Object *obj)
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001259{
Daniel P. Berrange7746abd2015-12-09 12:34:02 +00001260 g_hash_table_iter_init(&iter->iter, obj->properties);
1261 iter->nextclass = object_get_class(obj);
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001262}
1263
1264ObjectProperty *object_property_iter_next(ObjectPropertyIterator *iter)
1265{
Pavel Fedinb604a852015-10-13 13:37:45 +01001266 gpointer key, val;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001267 while (!g_hash_table_iter_next(&iter->iter, &key, &val)) {
1268 if (!iter->nextclass) {
1269 return NULL;
1270 }
1271 g_hash_table_iter_init(&iter->iter, iter->nextclass->properties);
1272 iter->nextclass = object_class_get_parent(iter->nextclass);
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001273 }
Pavel Fedinb604a852015-10-13 13:37:45 +01001274 return val;
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001275}
1276
Alexey Kardashevskiy961c47b2018-03-02 00:09:39 +11001277void object_class_property_iter_init(ObjectPropertyIterator *iter,
1278 ObjectClass *klass)
1279{
1280 g_hash_table_iter_init(&iter->iter, klass->properties);
Marc-André Lureau684546d2018-09-06 17:37:36 +04001281 iter->nextclass = object_class_get_parent(klass);
Alexey Kardashevskiy961c47b2018-03-02 00:09:39 +11001282}
1283
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001284ObjectProperty *object_class_property_find(ObjectClass *klass, const char *name,
1285 Error **errp)
1286{
1287 ObjectProperty *prop;
1288 ObjectClass *parent_klass;
1289
1290 parent_klass = object_class_get_parent(klass);
1291 if (parent_klass) {
1292 prop = object_class_property_find(parent_klass, name, NULL);
1293 if (prop) {
1294 return prop;
1295 }
1296 }
1297
1298 prop = g_hash_table_lookup(klass->properties, name);
1299 if (!prop) {
1300 error_setg(errp, "Property '.%s' not found", name);
1301 }
1302 return prop;
1303}
1304
Markus Armbrusterdf4fe0b2020-05-05 17:29:26 +02001305void object_property_del(Object *obj, const char *name)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001306{
Pavel Fedinb604a852015-10-13 13:37:45 +01001307 ObjectProperty *prop = g_hash_table_lookup(obj->properties, name);
1308
Anthony Liguori0866aca2011-12-23 15:34:39 -06001309 if (prop->release) {
1310 prop->release(obj, name, prop->opaque);
1311 }
Pavel Fedinb604a852015-10-13 13:37:45 +01001312 g_hash_table_remove(obj->properties, name);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001313}
1314
1315void object_property_get(Object *obj, Visitor *v, const char *name,
1316 Error **errp)
1317{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001318 ObjectProperty *prop = object_property_find(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001319 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001320 return;
1321 }
1322
1323 if (!prop->get) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001324 error_setg(errp, QERR_PERMISSION_DENIED);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001325 } else {
Eric Blaked7bce992016-01-29 06:48:55 -07001326 prop->get(obj, v, name, prop->opaque, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001327 }
1328}
1329
1330void object_property_set(Object *obj, Visitor *v, const char *name,
1331 Error **errp)
1332{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001333 ObjectProperty *prop = object_property_find(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001334 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001335 return;
1336 }
1337
1338 if (!prop->set) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001339 error_setg(errp, QERR_PERMISSION_DENIED);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001340 } else {
Eric Blaked7bce992016-01-29 06:48:55 -07001341 prop->set(obj, v, name, prop->opaque, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001342 }
1343}
1344
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001345void object_property_set_str(Object *obj, const char *value,
1346 const char *name, Error **errp)
1347{
1348 QString *qstr = qstring_from_str(value);
1349 object_property_set_qobject(obj, QOBJECT(qstr), name, errp);
1350
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001351 qobject_unref(qstr);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001352}
1353
1354char *object_property_get_str(Object *obj, const char *name,
1355 Error **errp)
1356{
1357 QObject *ret = object_property_get_qobject(obj, name, errp);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001358 char *retval;
1359
1360 if (!ret) {
1361 return NULL;
1362 }
Peter Xuaafb21a2018-03-09 16:59:47 +08001363
1364 retval = g_strdup(qobject_get_try_str(ret));
1365 if (!retval) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001366 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001367 }
1368
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001369 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001370 return retval;
1371}
1372
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001373void object_property_set_link(Object *obj, Object *value,
1374 const char *name, Error **errp)
1375{
Peter Crosthwaited3c49312014-09-25 22:19:19 -07001376 if (value) {
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001377 char *path = object_get_canonical_path(value);
Peter Crosthwaited3c49312014-09-25 22:19:19 -07001378 object_property_set_str(obj, path, name, errp);
1379 g_free(path);
1380 } else {
1381 object_property_set_str(obj, "", name, errp);
1382 }
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001383}
1384
1385Object *object_property_get_link(Object *obj, const char *name,
1386 Error **errp)
1387{
1388 char *str = object_property_get_str(obj, name, errp);
1389 Object *target = NULL;
1390
1391 if (str && *str) {
1392 target = object_resolve_path(str, NULL);
1393 if (!target) {
Markus Armbruster75158eb2015-03-16 08:57:47 +01001394 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1395 "Device '%s' not found", str);
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001396 }
1397 }
1398
1399 g_free(str);
1400 return target;
1401}
1402
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001403void object_property_set_bool(Object *obj, bool value,
1404 const char *name, Error **errp)
1405{
Eric Blakefc48ffc2015-05-15 16:24:59 -06001406 QBool *qbool = qbool_from_bool(value);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001407 object_property_set_qobject(obj, QOBJECT(qbool), name, errp);
1408
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001409 qobject_unref(qbool);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001410}
1411
1412bool object_property_get_bool(Object *obj, const char *name,
1413 Error **errp)
1414{
1415 QObject *ret = object_property_get_qobject(obj, name, errp);
1416 QBool *qbool;
1417 bool retval;
1418
1419 if (!ret) {
1420 return false;
1421 }
Max Reitz7dc847e2018-02-24 16:40:29 +01001422 qbool = qobject_to(QBool, ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001423 if (!qbool) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001424 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001425 retval = false;
1426 } else {
Eric Blakefc48ffc2015-05-15 16:24:59 -06001427 retval = qbool_get_bool(qbool);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001428 }
1429
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001430 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001431 return retval;
1432}
1433
1434void object_property_set_int(Object *obj, int64_t value,
1435 const char *name, Error **errp)
1436{
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001437 QNum *qnum = qnum_from_int(value);
1438 object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001439
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001440 qobject_unref(qnum);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001441}
1442
1443int64_t object_property_get_int(Object *obj, const char *name,
1444 Error **errp)
1445{
1446 QObject *ret = object_property_get_qobject(obj, name, errp);
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001447 QNum *qnum;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001448 int64_t retval;
1449
1450 if (!ret) {
1451 return -1;
1452 }
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001453
Max Reitz7dc847e2018-02-24 16:40:29 +01001454 qnum = qobject_to(QNum, ret);
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001455 if (!qnum || !qnum_get_try_int(qnum, &retval)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001456 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001457 retval = -1;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001458 }
1459
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001460 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001461 return retval;
1462}
1463
Marc-André Lureau0e76ed02020-01-10 19:30:23 +04001464static void object_property_init_defval(Object *obj, ObjectProperty *prop)
1465{
1466 Visitor *v = qobject_input_visitor_new(prop->defval);
1467
1468 assert(prop->set != NULL);
1469 prop->set(obj, v, prop->name, prop->opaque, &error_abort);
1470
1471 visit_free(v);
1472}
1473
1474static void object_property_set_default(ObjectProperty *prop, QObject *defval)
1475{
1476 assert(!prop->defval);
1477 assert(!prop->init);
1478
1479 prop->defval = defval;
1480 prop->init = object_property_init_defval;
1481}
1482
1483void object_property_set_default_bool(ObjectProperty *prop, bool value)
1484{
1485 object_property_set_default(prop, QOBJECT(qbool_from_bool(value)));
1486}
1487
1488void object_property_set_default_str(ObjectProperty *prop, const char *value)
1489{
1490 object_property_set_default(prop, QOBJECT(qstring_from_str(value)));
1491}
1492
1493void object_property_set_default_int(ObjectProperty *prop, int64_t value)
1494{
1495 object_property_set_default(prop, QOBJECT(qnum_from_int(value)));
1496}
1497
1498void object_property_set_default_uint(ObjectProperty *prop, uint64_t value)
1499{
1500 object_property_set_default(prop, QOBJECT(qnum_from_uint(value)));
1501}
1502
Marc-André Lureau31527792017-06-07 20:36:04 +04001503void object_property_set_uint(Object *obj, uint64_t value,
1504 const char *name, Error **errp)
1505{
1506 QNum *qnum = qnum_from_uint(value);
1507
1508 object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001509 qobject_unref(qnum);
Marc-André Lureau31527792017-06-07 20:36:04 +04001510}
1511
1512uint64_t object_property_get_uint(Object *obj, const char *name,
1513 Error **errp)
1514{
1515 QObject *ret = object_property_get_qobject(obj, name, errp);
1516 QNum *qnum;
1517 uint64_t retval;
1518
1519 if (!ret) {
1520 return 0;
1521 }
Max Reitz7dc847e2018-02-24 16:40:29 +01001522 qnum = qobject_to(QNum, ret);
Marc-André Lureau31527792017-06-07 20:36:04 +04001523 if (!qnum || !qnum_get_try_uint(qnum, &retval)) {
1524 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "uint");
1525 retval = 0;
1526 }
1527
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001528 qobject_unref(ret);
Marc-André Lureau31527792017-06-07 20:36:04 +04001529 return retval;
1530}
1531
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01001532typedef struct EnumProperty {
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02001533 const QEnumLookup *lookup;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01001534 int (*get)(Object *, Error **);
1535 void (*set)(Object *, int, Error **);
1536} EnumProperty;
1537
Hu Tao1f217722014-05-14 17:43:33 +08001538int object_property_get_enum(Object *obj, const char *name,
Daniel P. Berrangea3590da2015-05-27 16:07:56 +01001539 const char *typename, Error **errp)
Hu Tao1f217722014-05-14 17:43:33 +08001540{
Chen Fan976620a2014-08-18 14:46:34 +08001541 char *str;
Hu Tao1f217722014-05-14 17:43:33 +08001542 int ret;
Daniel P. Berrangea3590da2015-05-27 16:07:56 +01001543 ObjectProperty *prop = object_property_find(obj, name, errp);
1544 EnumProperty *enumprop;
1545
1546 if (prop == NULL) {
1547 return 0;
1548 }
1549
1550 if (!g_str_equal(prop->type, typename)) {
1551 error_setg(errp, "Property %s on %s is not '%s' enum type",
1552 name, object_class_get_name(
1553 object_get_class(obj)), typename);
1554 return 0;
1555 }
1556
1557 enumprop = prop->opaque;
Hu Tao1f217722014-05-14 17:43:33 +08001558
Markus Armbrusterb555f892020-05-05 17:29:12 +02001559 str = object_property_get_str(obj, name, errp);
1560 if (!str) {
Markus Armbruster4715d422015-08-25 20:00:45 +02001561 return 0;
1562 }
Chen Fan976620a2014-08-18 14:46:34 +08001563
Markus Armbrusterea097df2020-04-24 10:43:36 +02001564 ret = qapi_enum_parse(enumprop->lookup, str, -1, errp);
Chen Fan976620a2014-08-18 14:46:34 +08001565 g_free(str);
Hu Tao1f217722014-05-14 17:43:33 +08001566
1567 return ret;
1568}
1569
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001570void object_property_parse(Object *obj, const char *string,
1571 const char *name, Error **errp)
1572{
Eric Blake7a0525c2016-06-09 10:48:37 -06001573 Visitor *v = string_input_visitor_new(string);
1574 object_property_set(obj, v, name, errp);
1575 visit_free(v);
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001576}
1577
Paolo Bonzini0b7593e2014-02-08 11:01:50 +01001578char *object_property_print(Object *obj, const char *name, bool human,
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001579 Error **errp)
1580{
Eric Blake3b098d52016-06-09 10:48:43 -06001581 Visitor *v;
Gonglei3a530092014-09-27 13:13:55 +08001582 char *string = NULL;
1583 Error *local_err = NULL;
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001584
Eric Blake3b098d52016-06-09 10:48:43 -06001585 v = string_output_visitor_new(human, &string);
1586 object_property_get(obj, v, name, &local_err);
Gonglei3a530092014-09-27 13:13:55 +08001587 if (local_err) {
1588 error_propagate(errp, local_err);
1589 goto out;
1590 }
1591
Eric Blake3b098d52016-06-09 10:48:43 -06001592 visit_complete(v, &string);
Gonglei3a530092014-09-27 13:13:55 +08001593
1594out:
Eric Blake3b098d52016-06-09 10:48:43 -06001595 visit_free(v);
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001596 return string;
1597}
1598
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001599const char *object_property_get_type(Object *obj, const char *name, Error **errp)
1600{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001601 ObjectProperty *prop = object_property_find(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001602 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001603 return NULL;
1604 }
1605
1606 return prop->type;
1607}
1608
1609Object *object_get_root(void)
1610{
Anthony Liguori8b45d442011-12-23 09:08:05 -06001611 static Object *root;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001612
Anthony Liguori8b45d442011-12-23 09:08:05 -06001613 if (!root) {
1614 root = object_new("container");
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001615 }
1616
Anthony Liguori8b45d442011-12-23 09:08:05 -06001617 return root;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001618}
1619
Daniel P. Berrangebc2256c2015-05-13 17:14:05 +01001620Object *object_get_objects_root(void)
1621{
1622 return container_get(object_get_root(), "/objects");
1623}
1624
Peter Xu7c47c4e2017-09-28 10:59:54 +08001625Object *object_get_internal_root(void)
1626{
1627 static Object *internal_root;
1628
1629 if (!internal_root) {
1630 internal_root = object_new("container");
1631 }
1632
1633 return internal_root;
1634}
1635
Eric Blaked7bce992016-01-29 06:48:55 -07001636static void object_get_child_property(Object *obj, Visitor *v,
1637 const char *name, void *opaque,
1638 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001639{
1640 Object *child = opaque;
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001641 char *path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001642
1643 path = object_get_canonical_path(child);
Eric Blake51e72bc2016-01-29 06:48:54 -07001644 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001645 g_free(path);
1646}
1647
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001648static Object *object_resolve_child_property(Object *parent, void *opaque,
1649 const char *part)
Paolo Bonzini64607d02014-06-05 13:11:51 +02001650{
1651 return opaque;
1652}
1653
Anthony Liguoridb85b572011-12-23 08:47:39 -06001654static void object_finalize_child_property(Object *obj, const char *name,
1655 void *opaque)
1656{
1657 Object *child = opaque;
1658
Paolo Bonzinibffc6872014-06-11 11:57:38 +02001659 if (child->class->unparent) {
1660 (child->class->unparent)(child);
1661 }
1662 child->parent = NULL;
Anthony Liguoridb85b572011-12-23 08:47:39 -06001663 object_unref(child);
1664}
1665
Markus Armbruster70251882020-05-05 17:29:14 +02001666ObjectProperty *
1667object_property_add_child(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001668 Object *child)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001669{
Markus Armbruster70251882020-05-05 17:29:14 +02001670 g_autofree char *type = NULL;
Paolo Bonzini64607d02014-06-05 13:11:51 +02001671 ObjectProperty *op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001672
Markus Armbrusterd2623122020-05-05 17:29:22 +02001673 assert(!child->parent);
Peter Crosthwaite8faa2f82014-09-25 22:19:52 -07001674
Philippe Mathieu-Daudé688ffbb2020-05-12 09:00:19 +02001675 type = g_strdup_printf("child<%s>", object_get_typename(child));
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001676
Paolo Bonzini64607d02014-06-05 13:11:51 +02001677 op = object_property_add(obj, name, type, object_get_child_property, NULL,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001678 object_finalize_child_property, child);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001679 op->resolve = object_resolve_child_property;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001680 object_ref(child);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001681 child->parent = obj;
Markus Armbruster70251882020-05-05 17:29:14 +02001682 return op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001683}
1684
Igor Mammedov8f5d58e2017-07-14 10:14:50 +08001685void object_property_allow_set_link(const Object *obj, const char *name,
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001686 Object *val, Error **errp)
1687{
1688 /* Allow the link to be set, always */
1689}
1690
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001691typedef struct {
Marc-André Lureau9941d372020-01-10 19:30:27 +04001692 union {
1693 Object **targetp;
1694 Object *target; /* if OBJ_PROP_LINK_DIRECT, when holding the pointer */
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001695 ptrdiff_t offset; /* if OBJ_PROP_LINK_CLASS */
Marc-André Lureau9941d372020-01-10 19:30:27 +04001696 };
Igor Mammedov8f5d58e2017-07-14 10:14:50 +08001697 void (*check)(const Object *, const char *, Object *, Error **);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001698 ObjectPropertyLinkFlags flags;
1699} LinkProperty;
1700
Marc-André Lureau9941d372020-01-10 19:30:27 +04001701static Object **
1702object_link_get_targetp(Object *obj, LinkProperty *lprop)
1703{
1704 if (lprop->flags & OBJ_PROP_LINK_DIRECT) {
1705 return &lprop->target;
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001706 } else if (lprop->flags & OBJ_PROP_LINK_CLASS) {
1707 return (void *)obj + lprop->offset;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001708 } else {
1709 return lprop->targetp;
1710 }
1711}
1712
Eric Blaked7bce992016-01-29 06:48:55 -07001713static void object_get_link_property(Object *obj, Visitor *v,
1714 const char *name, void *opaque,
1715 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001716{
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001717 LinkProperty *lprop = opaque;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001718 Object **targetp = object_link_get_targetp(obj, lprop);
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001719 char *path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001720
Marc-André Lureau36854202020-01-10 19:30:26 +04001721 if (*targetp) {
1722 path = object_get_canonical_path(*targetp);
Eric Blake51e72bc2016-01-29 06:48:54 -07001723 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001724 g_free(path);
1725 } else {
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001726 path = (char *)"";
Eric Blake51e72bc2016-01-29 06:48:54 -07001727 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001728 }
1729}
1730
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001731/*
1732 * object_resolve_link:
1733 *
1734 * Lookup an object and ensure its type matches the link property type. This
1735 * is similar to object_resolve_path() except type verification against the
1736 * link property is performed.
1737 *
1738 * Returns: The matched object or NULL on path lookup failures.
1739 */
1740static Object *object_resolve_link(Object *obj, const char *name,
1741 const char *path, Error **errp)
1742{
1743 const char *type;
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001744 char *target_type;
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001745 bool ambiguous = false;
1746 Object *target;
1747
1748 /* Go from link<FOO> to FOO. */
1749 type = object_property_get_type(obj, name, NULL);
1750 target_type = g_strndup(&type[5], strlen(type) - 6);
1751 target = object_resolve_path_type(path, target_type, &ambiguous);
1752
1753 if (ambiguous) {
Eric Blake455b0fd2015-11-10 23:51:20 -07001754 error_setg(errp, "Path '%s' does not uniquely identify an object",
1755 path);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001756 } else if (!target) {
1757 target = object_resolve_path(path, &ambiguous);
1758 if (target || ambiguous) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001759 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001760 } else {
Markus Armbruster75158eb2015-03-16 08:57:47 +01001761 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1762 "Device '%s' not found", path);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001763 }
1764 target = NULL;
1765 }
1766 g_free(target_type);
1767
1768 return target;
1769}
1770
Eric Blaked7bce992016-01-29 06:48:55 -07001771static void object_set_link_property(Object *obj, Visitor *v,
1772 const char *name, void *opaque,
1773 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001774{
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001775 Error *local_err = NULL;
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001776 LinkProperty *prop = opaque;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001777 Object **targetp = object_link_get_targetp(obj, prop);
Marc-André Lureau36854202020-01-10 19:30:26 +04001778 Object *old_target = *targetp;
Markus Armbruster1c94a352020-07-07 18:05:53 +02001779 Object *new_target;
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001780 char *path = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001781
Markus Armbruster1c94a352020-07-07 18:05:53 +02001782 if (!visit_type_str(v, name, &path, errp)) {
1783 return;
1784 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001785
Markus Armbruster1c94a352020-07-07 18:05:53 +02001786 if (*path) {
1787 new_target = object_resolve_link(obj, name, path, errp);
1788 if (!new_target) {
1789 g_free(path);
1790 return;
1791 }
1792 } else {
1793 new_target = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001794 }
1795
1796 g_free(path);
Alexander Barabashf0cdc962012-02-22 19:22:26 +02001797
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001798 prop->check(obj, name, new_target, &local_err);
1799 if (local_err) {
1800 error_propagate(errp, local_err);
1801 return;
1802 }
1803
Marc-André Lureau36854202020-01-10 19:30:26 +04001804 *targetp = new_target;
Marc-André Lureau8770baf2020-01-10 19:30:25 +04001805 if (prop->flags & OBJ_PROP_LINK_STRONG) {
Marc-André Lureau265b5782018-05-31 21:51:17 +02001806 object_ref(new_target);
1807 object_unref(old_target);
1808 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001809}
1810
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001811static Object *object_resolve_link_property(Object *parent, void *opaque,
1812 const char *part)
Paolo Bonzini64607d02014-06-05 13:11:51 +02001813{
1814 LinkProperty *lprop = opaque;
1815
Marc-André Lureau9941d372020-01-10 19:30:27 +04001816 return *object_link_get_targetp(parent, lprop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001817}
1818
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001819static void object_release_link_property(Object *obj, const char *name,
1820 void *opaque)
1821{
1822 LinkProperty *prop = opaque;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001823 Object **targetp = object_link_get_targetp(obj, prop);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001824
Marc-André Lureau9941d372020-01-10 19:30:27 +04001825 if ((prop->flags & OBJ_PROP_LINK_STRONG) && *targetp) {
1826 object_unref(*targetp);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001827 }
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001828 if (!(prop->flags & OBJ_PROP_LINK_CLASS)) {
1829 g_free(prop);
1830 }
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001831}
1832
Markus Armbruster70251882020-05-05 17:29:14 +02001833static ObjectProperty *
1834object_add_link_prop(Object *obj, const char *name,
1835 const char *type, void *ptr,
1836 void (*check)(const Object *, const char *,
1837 Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02001838 ObjectPropertyLinkFlags flags)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001839{
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001840 LinkProperty *prop = g_malloc(sizeof(*prop));
Markus Armbruster70251882020-05-05 17:29:14 +02001841 g_autofree char *full_type = NULL;
Paolo Bonzini64607d02014-06-05 13:11:51 +02001842 ObjectProperty *op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001843
Marc-André Lureau4a8d5792020-01-10 19:30:28 +04001844 if (flags & OBJ_PROP_LINK_DIRECT) {
1845 prop->target = ptr;
1846 } else {
1847 prop->targetp = ptr;
1848 }
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001849 prop->check = check;
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001850 prop->flags = flags;
1851
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001852 full_type = g_strdup_printf("link<%s>", type);
1853
Paolo Bonzini64607d02014-06-05 13:11:51 +02001854 op = object_property_add(obj, name, full_type,
1855 object_get_link_property,
1856 check ? object_set_link_property : NULL,
1857 object_release_link_property,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001858 prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001859 op->resolve = object_resolve_link_property;
Markus Armbruster70251882020-05-05 17:29:14 +02001860 return op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001861}
1862
Markus Armbruster70251882020-05-05 17:29:14 +02001863ObjectProperty *
1864object_property_add_link(Object *obj, const char *name,
1865 const char *type, Object **targetp,
1866 void (*check)(const Object *, const char *,
1867 Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02001868 ObjectPropertyLinkFlags flags)
Marc-André Lureau4a8d5792020-01-10 19:30:28 +04001869{
Markus Armbrusterd2623122020-05-05 17:29:22 +02001870 return object_add_link_prop(obj, name, type, targetp, check, flags);
Marc-André Lureau4a8d5792020-01-10 19:30:28 +04001871}
1872
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001873ObjectProperty *
1874object_class_property_add_link(ObjectClass *oc,
1875 const char *name,
1876 const char *type, ptrdiff_t offset,
1877 void (*check)(const Object *obj, const char *name,
1878 Object *val, Error **errp),
Markus Armbrusterd2623122020-05-05 17:29:22 +02001879 ObjectPropertyLinkFlags flags)
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001880{
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001881 LinkProperty *prop = g_new0(LinkProperty, 1);
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001882 char *full_type;
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001883 ObjectProperty *op;
1884
1885 prop->offset = offset;
1886 prop->check = check;
1887 prop->flags = flags | OBJ_PROP_LINK_CLASS;
1888
1889 full_type = g_strdup_printf("link<%s>", type);
1890
1891 op = object_class_property_add(oc, name, full_type,
1892 object_get_link_property,
1893 check ? object_set_link_property : NULL,
1894 object_release_link_property,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001895 prop);
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001896
1897 op->resolve = object_resolve_link_property;
1898
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001899 g_free(full_type);
1900 return op;
1901}
1902
Markus Armbruster70251882020-05-05 17:29:14 +02001903ObjectProperty *
1904object_property_add_const_link(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001905 Object *target)
Paolo Bonzinifb9e7e32015-05-05 18:29:00 +02001906{
Markus Armbruster70251882020-05-05 17:29:14 +02001907 return object_add_link_prop(obj, name,
1908 object_get_typename(target), target,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001909 NULL, OBJ_PROP_LINK_DIRECT);
Paolo Bonzinifb9e7e32015-05-05 18:29:00 +02001910}
1911
Markus Armbrustere8512df2020-05-27 10:47:53 +02001912char *object_get_canonical_path_component(const Object *obj)
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001913{
1914 ObjectProperty *prop = NULL;
Pavel Fedinb604a852015-10-13 13:37:45 +01001915 GHashTableIter iter;
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001916
Paolo Bonzini770dec22018-04-30 11:44:17 +02001917 if (obj->parent == NULL) {
1918 return NULL;
1919 }
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001920
Pavel Fedinb604a852015-10-13 13:37:45 +01001921 g_hash_table_iter_init(&iter, obj->parent->properties);
1922 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001923 if (!object_property_is_child(prop)) {
1924 continue;
1925 }
1926
1927 if (prop->opaque == obj) {
1928 return g_strdup(prop->name);
1929 }
1930 }
1931
1932 /* obj had a parent but was not a child, should never happen */
1933 g_assert_not_reached();
1934 return NULL;
1935}
1936
Markus Armbrustere8512df2020-05-27 10:47:53 +02001937char *object_get_canonical_path(const Object *obj)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001938{
1939 Object *root = object_get_root();
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001940 char *newpath, *path = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001941
Paolo Bonzinie40077f2018-05-30 18:16:04 +02001942 if (obj == root) {
1943 return g_strdup("/");
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001944 }
1945
Paolo Bonzinie40077f2018-05-30 18:16:04 +02001946 do {
1947 char *component = object_get_canonical_path_component(obj);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001948
Paolo Bonzinie40077f2018-05-30 18:16:04 +02001949 if (!component) {
1950 /* A canonical path must be complete, so discard what was
1951 * collected so far.
1952 */
1953 g_free(path);
1954 return NULL;
1955 }
1956
1957 newpath = g_strdup_printf("/%s%s", component, path ? path : "");
1958 g_free(path);
1959 g_free(component);
1960 path = newpath;
1961 obj = obj->parent;
1962 } while (obj != root);
1963
1964 return path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001965}
1966
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001967Object *object_resolve_path_component(Object *parent, const char *part)
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001968{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001969 ObjectProperty *prop = object_property_find(parent, part, NULL);
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001970 if (prop == NULL) {
1971 return NULL;
1972 }
1973
Paolo Bonzini64607d02014-06-05 13:11:51 +02001974 if (prop->resolve) {
1975 return prop->resolve(parent, prop->opaque, part);
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001976 } else {
1977 return NULL;
1978 }
1979}
1980
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001981static Object *object_resolve_abs_path(Object *parent,
Masahiro Yamadaad195c82020-05-10 10:32:35 +09001982 char **parts,
1983 const char *typename)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001984{
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001985 Object *child;
1986
Masahiro Yamadaad195c82020-05-10 10:32:35 +09001987 if (*parts == NULL) {
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001988 return object_dynamic_cast(parent, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001989 }
1990
Masahiro Yamadaad195c82020-05-10 10:32:35 +09001991 if (strcmp(*parts, "") == 0) {
1992 return object_resolve_abs_path(parent, parts + 1, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001993 }
1994
Masahiro Yamadaad195c82020-05-10 10:32:35 +09001995 child = object_resolve_path_component(parent, *parts);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001996 if (!child) {
1997 return NULL;
1998 }
1999
Masahiro Yamadaad195c82020-05-10 10:32:35 +09002000 return object_resolve_abs_path(child, parts + 1, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002001}
2002
2003static Object *object_resolve_partial_path(Object *parent,
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02002004 char **parts,
2005 const char *typename,
2006 bool *ambiguous)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002007{
2008 Object *obj;
Pavel Fedinb604a852015-10-13 13:37:45 +01002009 GHashTableIter iter;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002010 ObjectProperty *prop;
2011
Masahiro Yamadaad195c82020-05-10 10:32:35 +09002012 obj = object_resolve_abs_path(parent, parts, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002013
Pavel Fedinb604a852015-10-13 13:37:45 +01002014 g_hash_table_iter_init(&iter, parent->properties);
2015 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002016 Object *found;
2017
Andreas Färber5d9d3f42012-05-27 00:32:40 +02002018 if (!object_property_is_child(prop)) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002019 continue;
2020 }
2021
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002022 found = object_resolve_partial_path(prop->opaque, parts,
2023 typename, ambiguous);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002024 if (found) {
2025 if (obj) {
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002026 *ambiguous = true;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002027 return NULL;
2028 }
2029 obj = found;
2030 }
2031
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002032 if (*ambiguous) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002033 return NULL;
2034 }
2035 }
2036
2037 return obj;
2038}
2039
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002040Object *object_resolve_path_type(const char *path, const char *typename,
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002041 bool *ambiguousp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002042{
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002043 Object *obj;
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02002044 char **parts;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002045
2046 parts = g_strsplit(path, "/", 0);
Paolo Bonzini2e1103f2013-04-18 18:44:02 +02002047 assert(parts);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002048
Paolo Bonzini2e1103f2013-04-18 18:44:02 +02002049 if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002050 bool ambiguous = false;
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002051 obj = object_resolve_partial_path(object_get_root(), parts,
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002052 typename, &ambiguous);
2053 if (ambiguousp) {
2054 *ambiguousp = ambiguous;
2055 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002056 } else {
Masahiro Yamadaad195c82020-05-10 10:32:35 +09002057 obj = object_resolve_abs_path(object_get_root(), parts + 1, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002058 }
2059
2060 g_strfreev(parts);
2061
2062 return obj;
2063}
2064
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002065Object *object_resolve_path(const char *path, bool *ambiguous)
2066{
2067 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
2068}
2069
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002070typedef struct StringProperty
2071{
2072 char *(*get)(Object *, Error **);
2073 void (*set)(Object *, const char *, Error **);
2074} StringProperty;
2075
Eric Blaked7bce992016-01-29 06:48:55 -07002076static void property_get_str(Object *obj, Visitor *v, const char *name,
2077 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002078{
2079 StringProperty *prop = opaque;
2080 char *value;
Markus Armbrustere1c82372015-08-25 20:00:46 +02002081 Error *err = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002082
Markus Armbrustere1c82372015-08-25 20:00:46 +02002083 value = prop->get(obj, &err);
2084 if (err) {
2085 error_propagate(errp, err);
2086 return;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002087 }
Markus Armbrustere1c82372015-08-25 20:00:46 +02002088
Eric Blake51e72bc2016-01-29 06:48:54 -07002089 visit_type_str(v, name, &value, errp);
Markus Armbrustere1c82372015-08-25 20:00:46 +02002090 g_free(value);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002091}
2092
Eric Blaked7bce992016-01-29 06:48:55 -07002093static void property_set_str(Object *obj, Visitor *v, const char *name,
2094 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002095{
2096 StringProperty *prop = opaque;
2097 char *value;
2098 Error *local_err = NULL;
2099
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002100 if (!visit_type_str(v, name, &value, &local_err)) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002101 error_propagate(errp, local_err);
2102 return;
2103 }
2104
2105 prop->set(obj, value, errp);
2106 g_free(value);
2107}
2108
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01002109static void property_release_str(Object *obj, const char *name,
2110 void *opaque)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002111{
2112 StringProperty *prop = opaque;
2113 g_free(prop);
2114}
2115
Markus Armbruster70251882020-05-05 17:29:14 +02002116ObjectProperty *
2117object_property_add_str(Object *obj, const char *name,
2118 char *(*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002119 void (*set)(Object *, const char *, Error **))
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002120{
2121 StringProperty *prop = g_malloc0(sizeof(*prop));
2122
2123 prop->get = get;
2124 prop->set = set;
2125
Markus Armbrusterd2623122020-05-05 17:29:22 +02002126 return object_property_add(obj, name, "string",
2127 get ? property_get_str : NULL,
2128 set ? property_set_str : NULL,
2129 property_release_str,
2130 prop);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002131}
Paolo Bonzini745549c2012-03-31 16:45:54 +02002132
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002133ObjectProperty *
2134object_class_property_add_str(ObjectClass *klass, const char *name,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002135 char *(*get)(Object *, Error **),
2136 void (*set)(Object *, const char *,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002137 Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002138{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002139 StringProperty *prop = g_malloc0(sizeof(*prop));
2140
2141 prop->get = get;
2142 prop->set = set;
2143
Markus Armbrusterd2623122020-05-05 17:29:22 +02002144 return object_class_property_add(klass, name, "string",
2145 get ? property_get_str : NULL,
2146 set ? property_set_str : NULL,
2147 NULL,
2148 prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002149}
2150
Anthony Liguori0e558842012-06-25 10:32:46 -05002151typedef struct BoolProperty
2152{
2153 bool (*get)(Object *, Error **);
2154 void (*set)(Object *, bool, Error **);
2155} BoolProperty;
2156
Eric Blaked7bce992016-01-29 06:48:55 -07002157static void property_get_bool(Object *obj, Visitor *v, const char *name,
2158 void *opaque, Error **errp)
Anthony Liguori0e558842012-06-25 10:32:46 -05002159{
2160 BoolProperty *prop = opaque;
2161 bool value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002162 Error *err = NULL;
Anthony Liguori0e558842012-06-25 10:32:46 -05002163
Markus Armbruster4715d422015-08-25 20:00:45 +02002164 value = prop->get(obj, &err);
2165 if (err) {
2166 error_propagate(errp, err);
2167 return;
2168 }
2169
Eric Blake51e72bc2016-01-29 06:48:54 -07002170 visit_type_bool(v, name, &value, errp);
Anthony Liguori0e558842012-06-25 10:32:46 -05002171}
2172
Eric Blaked7bce992016-01-29 06:48:55 -07002173static void property_set_bool(Object *obj, Visitor *v, const char *name,
2174 void *opaque, Error **errp)
Anthony Liguori0e558842012-06-25 10:32:46 -05002175{
2176 BoolProperty *prop = opaque;
2177 bool value;
2178 Error *local_err = NULL;
2179
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002180 if (!visit_type_bool(v, name, &value, &local_err)) {
Anthony Liguori0e558842012-06-25 10:32:46 -05002181 error_propagate(errp, local_err);
2182 return;
2183 }
2184
2185 prop->set(obj, value, errp);
2186}
2187
2188static void property_release_bool(Object *obj, const char *name,
2189 void *opaque)
2190{
2191 BoolProperty *prop = opaque;
2192 g_free(prop);
2193}
2194
Markus Armbruster70251882020-05-05 17:29:14 +02002195ObjectProperty *
2196object_property_add_bool(Object *obj, const char *name,
2197 bool (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002198 void (*set)(Object *, bool, Error **))
Anthony Liguori0e558842012-06-25 10:32:46 -05002199{
2200 BoolProperty *prop = g_malloc0(sizeof(*prop));
2201
2202 prop->get = get;
2203 prop->set = set;
2204
Markus Armbrusterd2623122020-05-05 17:29:22 +02002205 return object_property_add(obj, name, "bool",
2206 get ? property_get_bool : NULL,
2207 set ? property_set_bool : NULL,
2208 property_release_bool,
2209 prop);
Anthony Liguori0e558842012-06-25 10:32:46 -05002210}
2211
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002212ObjectProperty *
2213object_class_property_add_bool(ObjectClass *klass, const char *name,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002214 bool (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002215 void (*set)(Object *, bool, Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002216{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002217 BoolProperty *prop = g_malloc0(sizeof(*prop));
2218
2219 prop->get = get;
2220 prop->set = set;
2221
Markus Armbrusterd2623122020-05-05 17:29:22 +02002222 return object_class_property_add(klass, name, "bool",
2223 get ? property_get_bool : NULL,
2224 set ? property_set_bool : NULL,
2225 NULL,
2226 prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002227}
2228
Eric Blaked7bce992016-01-29 06:48:55 -07002229static void property_get_enum(Object *obj, Visitor *v, const char *name,
2230 void *opaque, Error **errp)
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002231{
2232 EnumProperty *prop = opaque;
2233 int value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002234 Error *err = NULL;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002235
Markus Armbruster4715d422015-08-25 20:00:45 +02002236 value = prop->get(obj, &err);
2237 if (err) {
2238 error_propagate(errp, err);
2239 return;
2240 }
2241
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002242 visit_type_enum(v, name, &value, prop->lookup, errp);
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002243}
2244
Eric Blaked7bce992016-01-29 06:48:55 -07002245static void property_set_enum(Object *obj, Visitor *v, const char *name,
2246 void *opaque, Error **errp)
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002247{
2248 EnumProperty *prop = opaque;
2249 int value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002250 Error *err = NULL;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002251
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002252 if (!visit_type_enum(v, name, &value, prop->lookup, &err)) {
Markus Armbruster4715d422015-08-25 20:00:45 +02002253 error_propagate(errp, err);
2254 return;
2255 }
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002256 prop->set(obj, value, errp);
2257}
2258
2259static void property_release_enum(Object *obj, const char *name,
2260 void *opaque)
2261{
2262 EnumProperty *prop = opaque;
2263 g_free(prop);
2264}
2265
Markus Armbruster70251882020-05-05 17:29:14 +02002266ObjectProperty *
2267object_property_add_enum(Object *obj, const char *name,
2268 const char *typename,
2269 const QEnumLookup *lookup,
2270 int (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002271 void (*set)(Object *, int, Error **))
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002272{
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002273 EnumProperty *prop = g_malloc(sizeof(*prop));
2274
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002275 prop->lookup = lookup;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002276 prop->get = get;
2277 prop->set = set;
2278
Markus Armbrusterd2623122020-05-05 17:29:22 +02002279 return object_property_add(obj, name, typename,
2280 get ? property_get_enum : NULL,
2281 set ? property_set_enum : NULL,
2282 property_release_enum,
2283 prop);
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002284}
2285
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002286ObjectProperty *
2287object_class_property_add_enum(ObjectClass *klass, const char *name,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002288 const char *typename,
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002289 const QEnumLookup *lookup,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002290 int (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002291 void (*set)(Object *, int, Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002292{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002293 EnumProperty *prop = g_malloc(sizeof(*prop));
2294
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002295 prop->lookup = lookup;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002296 prop->get = get;
2297 prop->set = set;
2298
Markus Armbrusterd2623122020-05-05 17:29:22 +02002299 return object_class_property_add(klass, name, typename,
2300 get ? property_get_enum : NULL,
2301 set ? property_set_enum : NULL,
2302 NULL,
2303 prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002304}
2305
David Gibson8e099d12015-02-06 14:55:45 +11002306typedef struct TMProperty {
2307 void (*get)(Object *, struct tm *, Error **);
2308} TMProperty;
2309
Eric Blaked7bce992016-01-29 06:48:55 -07002310static void property_get_tm(Object *obj, Visitor *v, const char *name,
2311 void *opaque, Error **errp)
David Gibson8e099d12015-02-06 14:55:45 +11002312{
2313 TMProperty *prop = opaque;
2314 Error *err = NULL;
2315 struct tm value;
2316
2317 prop->get(obj, &value, &err);
2318 if (err) {
2319 goto out;
2320 }
2321
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002322 if (!visit_start_struct(v, name, NULL, 0, &err)) {
David Gibson8e099d12015-02-06 14:55:45 +11002323 goto out;
2324 }
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002325 if (!visit_type_int32(v, "tm_year", &value.tm_year, &err)) {
David Gibson8e099d12015-02-06 14:55:45 +11002326 goto out_end;
2327 }
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002328 if (!visit_type_int32(v, "tm_mon", &value.tm_mon, &err)) {
David Gibson8e099d12015-02-06 14:55:45 +11002329 goto out_end;
2330 }
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002331 if (!visit_type_int32(v, "tm_mday", &value.tm_mday, &err)) {
David Gibson8e099d12015-02-06 14:55:45 +11002332 goto out_end;
2333 }
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002334 if (!visit_type_int32(v, "tm_hour", &value.tm_hour, &err)) {
David Gibson8e099d12015-02-06 14:55:45 +11002335 goto out_end;
2336 }
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002337 if (!visit_type_int32(v, "tm_min", &value.tm_min, &err)) {
David Gibson8e099d12015-02-06 14:55:45 +11002338 goto out_end;
2339 }
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002340 if (!visit_type_int32(v, "tm_sec", &value.tm_sec, &err)) {
David Gibson8e099d12015-02-06 14:55:45 +11002341 goto out_end;
2342 }
Eric Blake15c2f662016-04-28 15:45:27 -06002343 visit_check_struct(v, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002344out_end:
Eric Blake1158bb22016-06-09 10:48:34 -06002345 visit_end_struct(v, NULL);
David Gibson8e099d12015-02-06 14:55:45 +11002346out:
2347 error_propagate(errp, err);
2348
2349}
2350
2351static void property_release_tm(Object *obj, const char *name,
2352 void *opaque)
2353{
2354 TMProperty *prop = opaque;
2355 g_free(prop);
2356}
2357
Markus Armbruster70251882020-05-05 17:29:14 +02002358ObjectProperty *
2359object_property_add_tm(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002360 void (*get)(Object *, struct tm *, Error **))
David Gibson8e099d12015-02-06 14:55:45 +11002361{
David Gibson8e099d12015-02-06 14:55:45 +11002362 TMProperty *prop = g_malloc0(sizeof(*prop));
2363
2364 prop->get = get;
2365
Markus Armbrusterd2623122020-05-05 17:29:22 +02002366 return object_property_add(obj, name, "struct tm",
2367 get ? property_get_tm : NULL, NULL,
2368 property_release_tm,
2369 prop);
David Gibson8e099d12015-02-06 14:55:45 +11002370}
2371
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002372ObjectProperty *
2373object_class_property_add_tm(ObjectClass *klass, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002374 void (*get)(Object *, struct tm *, Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002375{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002376 TMProperty *prop = g_malloc0(sizeof(*prop));
2377
2378 prop->get = get;
2379
Markus Armbrusterd2623122020-05-05 17:29:22 +02002380 return object_class_property_add(klass, name, "struct tm",
2381 get ? property_get_tm : NULL,
2382 NULL, NULL, prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002383}
2384
Markus Armbruster90c69fb2020-07-07 18:05:50 +02002385static char *object_get_type(Object *obj, Error **errp)
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002386{
2387 return g_strdup(object_get_typename(obj));
2388}
2389
Eric Blaked7bce992016-01-29 06:48:55 -07002390static void property_get_uint8_ptr(Object *obj, Visitor *v, const char *name,
2391 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002392{
2393 uint8_t value = *(uint8_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002394 visit_type_uint8(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002395}
2396
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002397static void property_set_uint8_ptr(Object *obj, Visitor *v, const char *name,
2398 void *opaque, Error **errp)
2399{
2400 uint8_t *field = opaque;
2401 uint8_t value;
2402 Error *local_err = NULL;
2403
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002404 if (!visit_type_uint8(v, name, &value, &local_err)) {
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002405 error_propagate(errp, local_err);
2406 return;
2407 }
2408
2409 *field = value;
2410}
2411
Eric Blaked7bce992016-01-29 06:48:55 -07002412static void property_get_uint16_ptr(Object *obj, Visitor *v, const char *name,
2413 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002414{
2415 uint16_t value = *(uint16_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002416 visit_type_uint16(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002417}
2418
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002419static void property_set_uint16_ptr(Object *obj, Visitor *v, const char *name,
2420 void *opaque, Error **errp)
2421{
2422 uint16_t *field = opaque;
2423 uint16_t value;
2424 Error *local_err = NULL;
2425
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002426 if (!visit_type_uint16(v, name, &value, &local_err)) {
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002427 error_propagate(errp, local_err);
2428 return;
2429 }
2430
2431 *field = value;
2432}
2433
Eric Blaked7bce992016-01-29 06:48:55 -07002434static void property_get_uint32_ptr(Object *obj, Visitor *v, const char *name,
2435 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002436{
2437 uint32_t value = *(uint32_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002438 visit_type_uint32(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002439}
2440
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002441static void property_set_uint32_ptr(Object *obj, Visitor *v, const char *name,
2442 void *opaque, Error **errp)
2443{
2444 uint32_t *field = opaque;
2445 uint32_t value;
2446 Error *local_err = NULL;
2447
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002448 if (!visit_type_uint32(v, name, &value, &local_err)) {
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002449 error_propagate(errp, local_err);
2450 return;
2451 }
2452
2453 *field = value;
2454}
2455
Eric Blaked7bce992016-01-29 06:48:55 -07002456static void property_get_uint64_ptr(Object *obj, Visitor *v, const char *name,
2457 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002458{
2459 uint64_t value = *(uint64_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002460 visit_type_uint64(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002461}
2462
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002463static void property_set_uint64_ptr(Object *obj, Visitor *v, const char *name,
2464 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002465{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002466 uint64_t *field = opaque;
2467 uint64_t value;
2468 Error *local_err = NULL;
2469
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002470 if (!visit_type_uint64(v, name, &value, &local_err)) {
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002471 error_propagate(errp, local_err);
2472 return;
2473 }
2474
2475 *field = value;
2476}
2477
Markus Armbruster70251882020-05-05 17:29:14 +02002478ObjectProperty *
2479object_property_add_uint8_ptr(Object *obj, const char *name,
2480 const uint8_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002481 ObjectPropertyFlags flags)
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002482{
2483 ObjectPropertyAccessor *getter = NULL;
2484 ObjectPropertyAccessor *setter = NULL;
2485
2486 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2487 getter = property_get_uint8_ptr;
2488 }
2489
2490 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2491 setter = property_set_uint8_ptr;
2492 }
2493
Markus Armbruster70251882020-05-05 17:29:14 +02002494 return object_property_add(obj, name, "uint8",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002495 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002496}
2497
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002498ObjectProperty *
2499object_class_property_add_uint8_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002500 const uint8_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002501 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002502{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002503 ObjectPropertyAccessor *getter = NULL;
2504 ObjectPropertyAccessor *setter = NULL;
2505
2506 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2507 getter = property_get_uint8_ptr;
2508 }
2509
2510 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2511 setter = property_set_uint8_ptr;
2512 }
2513
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002514 return object_class_property_add(klass, name, "uint8",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002515 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002516}
2517
Markus Armbruster70251882020-05-05 17:29:14 +02002518ObjectProperty *
2519object_property_add_uint16_ptr(Object *obj, const char *name,
2520 const uint16_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002521 ObjectPropertyFlags flags)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002522{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002523 ObjectPropertyAccessor *getter = NULL;
2524 ObjectPropertyAccessor *setter = NULL;
2525
2526 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2527 getter = property_get_uint16_ptr;
2528 }
2529
2530 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2531 setter = property_set_uint16_ptr;
2532 }
2533
Markus Armbruster70251882020-05-05 17:29:14 +02002534 return object_property_add(obj, name, "uint16",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002535 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002536}
2537
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002538ObjectProperty *
2539object_class_property_add_uint16_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002540 const uint16_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002541 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002542{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002543 ObjectPropertyAccessor *getter = NULL;
2544 ObjectPropertyAccessor *setter = NULL;
2545
2546 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2547 getter = property_get_uint16_ptr;
2548 }
2549
2550 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2551 setter = property_set_uint16_ptr;
2552 }
2553
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002554 return object_class_property_add(klass, name, "uint16",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002555 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002556}
2557
Markus Armbruster70251882020-05-05 17:29:14 +02002558ObjectProperty *
2559object_property_add_uint32_ptr(Object *obj, const char *name,
2560 const uint32_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002561 ObjectPropertyFlags flags)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002562{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002563 ObjectPropertyAccessor *getter = NULL;
2564 ObjectPropertyAccessor *setter = NULL;
2565
2566 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2567 getter = property_get_uint32_ptr;
2568 }
2569
2570 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2571 setter = property_set_uint32_ptr;
2572 }
2573
Markus Armbruster70251882020-05-05 17:29:14 +02002574 return object_property_add(obj, name, "uint32",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002575 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002576}
2577
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002578ObjectProperty *
2579object_class_property_add_uint32_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002580 const uint32_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002581 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002582{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002583 ObjectPropertyAccessor *getter = NULL;
2584 ObjectPropertyAccessor *setter = NULL;
2585
2586 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2587 getter = property_get_uint32_ptr;
2588 }
2589
2590 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2591 setter = property_set_uint32_ptr;
2592 }
2593
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002594 return object_class_property_add(klass, name, "uint32",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002595 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002596}
2597
Markus Armbruster70251882020-05-05 17:29:14 +02002598ObjectProperty *
2599object_property_add_uint64_ptr(Object *obj, const char *name,
2600 const uint64_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002601 ObjectPropertyFlags flags)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002602{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002603 ObjectPropertyAccessor *getter = NULL;
2604 ObjectPropertyAccessor *setter = NULL;
2605
2606 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2607 getter = property_get_uint64_ptr;
2608 }
2609
2610 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2611 setter = property_set_uint64_ptr;
2612 }
2613
Markus Armbruster70251882020-05-05 17:29:14 +02002614 return object_property_add(obj, name, "uint64",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002615 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002616}
2617
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002618ObjectProperty *
2619object_class_property_add_uint64_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002620 const uint64_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002621 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002622{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002623 ObjectPropertyAccessor *getter = NULL;
2624 ObjectPropertyAccessor *setter = NULL;
2625
2626 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2627 getter = property_get_uint64_ptr;
2628 }
2629
2630 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2631 setter = property_set_uint64_ptr;
2632 }
2633
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002634 return object_class_property_add(klass, name, "uint64",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002635 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002636}
2637
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002638typedef struct {
2639 Object *target_obj;
Eduardo Habkost1590d262015-04-09 16:57:29 -03002640 char *target_name;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002641} AliasProperty;
2642
Eric Blaked7bce992016-01-29 06:48:55 -07002643static void property_get_alias(Object *obj, Visitor *v, const char *name,
2644 void *opaque, Error **errp)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002645{
2646 AliasProperty *prop = opaque;
2647
2648 object_property_get(prop->target_obj, v, prop->target_name, errp);
2649}
2650
Eric Blaked7bce992016-01-29 06:48:55 -07002651static void property_set_alias(Object *obj, Visitor *v, const char *name,
2652 void *opaque, Error **errp)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002653{
2654 AliasProperty *prop = opaque;
2655
2656 object_property_set(prop->target_obj, v, prop->target_name, errp);
2657}
2658
Paolo Bonzini64607d02014-06-05 13:11:51 +02002659static Object *property_resolve_alias(Object *obj, void *opaque,
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02002660 const char *part)
Paolo Bonzini64607d02014-06-05 13:11:51 +02002661{
2662 AliasProperty *prop = opaque;
2663
2664 return object_resolve_path_component(prop->target_obj, prop->target_name);
2665}
2666
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002667static void property_release_alias(Object *obj, const char *name, void *opaque)
2668{
2669 AliasProperty *prop = opaque;
2670
Eduardo Habkost1590d262015-04-09 16:57:29 -03002671 g_free(prop->target_name);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002672 g_free(prop);
2673}
2674
Markus Armbruster70251882020-05-05 17:29:14 +02002675ObjectProperty *
2676object_property_add_alias(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002677 Object *target_obj, const char *target_name)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002678{
2679 AliasProperty *prop;
Paolo Bonzini64607d02014-06-05 13:11:51 +02002680 ObjectProperty *op;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002681 ObjectProperty *target_prop;
Markus Armbruster70251882020-05-05 17:29:14 +02002682 g_autofree char *prop_type = NULL;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002683
Markus Armbrusterd2623122020-05-05 17:29:22 +02002684 target_prop = object_property_find(target_obj, target_name,
2685 &error_abort);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002686
Paolo Bonzinid1906982014-06-10 11:17:35 +02002687 if (object_property_is_child(target_prop)) {
2688 prop_type = g_strdup_printf("link%s",
2689 target_prop->type + strlen("child"));
2690 } else {
2691 prop_type = g_strdup(target_prop->type);
2692 }
2693
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002694 prop = g_malloc(sizeof(*prop));
2695 prop->target_obj = target_obj;
Eduardo Habkost1590d262015-04-09 16:57:29 -03002696 prop->target_name = g_strdup(target_name);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002697
Paolo Bonzinid1906982014-06-10 11:17:35 +02002698 op = object_property_add(obj, name, prop_type,
Paolo Bonzini64607d02014-06-05 13:11:51 +02002699 property_get_alias,
2700 property_set_alias,
2701 property_release_alias,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002702 prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02002703 op->resolve = property_resolve_alias;
Marc-André Lureau0e76ed02020-01-10 19:30:23 +04002704 if (target_prop->defval) {
2705 op->defval = qobject_ref(target_prop->defval);
2706 }
Paolo Bonzinid1906982014-06-10 11:17:35 +02002707
Andreas Färbera18bb412015-03-27 17:34:10 +01002708 object_property_set_description(obj, op->name,
Markus Armbruster7eecec72020-05-05 17:29:15 +02002709 target_prop->description);
Markus Armbruster70251882020-05-05 17:29:14 +02002710 return op;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002711}
2712
Gonglei80742642014-10-07 14:33:21 +08002713void object_property_set_description(Object *obj, const char *name,
Markus Armbruster7eecec72020-05-05 17:29:15 +02002714 const char *description)
Gonglei80742642014-10-07 14:33:21 +08002715{
2716 ObjectProperty *op;
2717
Markus Armbruster7eecec72020-05-05 17:29:15 +02002718 op = object_property_find(obj, name, &error_abort);
Gonglei80742642014-10-07 14:33:21 +08002719 g_free(op->description);
2720 op->description = g_strdup(description);
2721}
2722
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002723void object_class_property_set_description(ObjectClass *klass,
2724 const char *name,
Markus Armbruster7eecec72020-05-05 17:29:15 +02002725 const char *description)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002726{
2727 ObjectProperty *op;
2728
2729 op = g_hash_table_lookup(klass->properties, name);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002730 g_free(op->description);
2731 op->description = g_strdup(description);
2732}
2733
Marc-André Lureau7439a032018-09-06 18:09:32 +04002734static void object_class_init(ObjectClass *klass, void *data)
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002735{
Markus Armbruster90c69fb2020-07-07 18:05:50 +02002736 object_class_property_add_str(klass, "type", object_get_type,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002737 NULL);
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002738}
2739
Paolo Bonzini745549c2012-03-31 16:45:54 +02002740static void register_types(void)
2741{
2742 static TypeInfo interface_info = {
2743 .name = TYPE_INTERFACE,
Anthony Liguori33e95c62012-08-10 13:16:10 +10002744 .class_size = sizeof(InterfaceClass),
Paolo Bonzini745549c2012-03-31 16:45:54 +02002745 .abstract = true,
2746 };
2747
2748 static TypeInfo object_info = {
2749 .name = TYPE_OBJECT,
2750 .instance_size = sizeof(Object),
Marc-André Lureau7439a032018-09-06 18:09:32 +04002751 .class_init = object_class_init,
Paolo Bonzini745549c2012-03-31 16:45:54 +02002752 .abstract = true,
2753 };
2754
Paolo Bonzini049cb3c2012-04-04 15:58:40 +02002755 type_interface = type_register_internal(&interface_info);
2756 type_register_internal(&object_info);
Paolo Bonzini745549c2012-03-31 16:45:54 +02002757}
2758
2759type_init(register_types)