blob: e062ac5c828388af408e0dcfb5d69ae5e3dc921a [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
552 object_set_propv(obj, &local_err, vargs);
553 if (local_err) {
554 goto out;
555 }
556
Markus Armbrusterd2623122020-05-05 17:29:22 +0200557 object_property_add_child(parentobj, propname, obj);
Thomas Huth0210b392018-07-16 14:59:18 +0200558
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400559 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
560 if (uc) {
561 user_creatable_complete(uc, &local_err);
Thomas Huth0210b392018-07-16 14:59:18 +0200562 if (local_err) {
563 object_unparent(obj);
564 goto out;
565 }
566 }
567
Markus Armbruster975ac452020-05-05 17:29:09 +0200568out:
Thomas Huth0210b392018-07-16 14:59:18 +0200569 /*
Markus Armbruster975ac452020-05-05 17:29:09 +0200570 * We want @obj's reference to be 1 on success, 0 on failure.
571 * On success, it's 2: one taken by object_initialize(), and one
572 * by object_property_add_child().
573 * On failure in object_initialize() or earlier, it's 1.
574 * On failure afterwards, it's also 1: object_unparent() releases
575 * the reference taken by object_property_add_child().
Thomas Huth0210b392018-07-16 14:59:18 +0200576 */
577 object_unref(obj);
578
Markus Armbruster975ac452020-05-05 17:29:09 +0200579 error_propagate(errp, local_err);
Thomas Huth0210b392018-07-16 14:59:18 +0200580}
581
Markus Armbruster9fc7fc42020-06-10 07:32:25 +0200582void object_initialize_child_internal(Object *parent,
583 const char *propname,
584 void *child, size_t size,
585 const char *type)
586{
587 object_initialize_child_with_props(parent, propname, child, size, type,
588 &error_abort, NULL);
589}
590
Andreas Färber5d9d3f42012-05-27 00:32:40 +0200591static inline bool object_property_is_child(ObjectProperty *prop)
592{
593 return strstart(prop->type, "child<", NULL);
594}
595
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600596static void object_property_del_all(Object *obj)
597{
Marc-André Lureau9859fac2020-01-10 19:30:30 +0400598 g_autoptr(GHashTable) done = g_hash_table_new(NULL, NULL);
Pavel Fedinb604a852015-10-13 13:37:45 +0100599 ObjectProperty *prop;
Marc-André Lureau9859fac2020-01-10 19:30:30 +0400600 ObjectPropertyIterator iter;
Pavel Fedinb604a852015-10-13 13:37:45 +0100601 bool released;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600602
Pavel Fedinb604a852015-10-13 13:37:45 +0100603 do {
604 released = false;
Marc-André Lureau9859fac2020-01-10 19:30:30 +0400605 object_property_iter_init(&iter, obj);
606 while ((prop = object_property_iter_next(&iter)) != NULL) {
607 if (g_hash_table_add(done, prop)) {
608 if (prop->release) {
609 prop->release(obj, prop->name, prop->opaque);
610 released = true;
611 break;
612 }
Pavel Fedinb604a852015-10-13 13:37:45 +0100613 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600614 }
Pavel Fedinb604a852015-10-13 13:37:45 +0100615 } while (released);
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600616
Pavel Fedinb604a852015-10-13 13:37:45 +0100617 g_hash_table_unref(obj->properties);
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600618}
619
Markus Armbrusterf73a32a2020-05-05 17:29:11 +0200620static void object_property_del_child(Object *obj, Object *child)
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600621{
622 ObjectProperty *prop;
Pavel Fedinb604a852015-10-13 13:37:45 +0100623 GHashTableIter iter;
624 gpointer key, value;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600625
Pavel Fedinb604a852015-10-13 13:37:45 +0100626 g_hash_table_iter_init(&iter, obj->properties);
627 while (g_hash_table_iter_next(&iter, &key, &value)) {
628 prop = value;
Andreas Färber5d9d3f42012-05-27 00:32:40 +0200629 if (object_property_is_child(prop) && prop->opaque == child) {
Pavel Fedinb604a852015-10-13 13:37:45 +0100630 if (prop->release) {
631 prop->release(obj, prop->name, prop->opaque);
632 prop->release = NULL;
633 }
634 break;
635 }
636 }
637 g_hash_table_iter_init(&iter, obj->properties);
638 while (g_hash_table_iter_next(&iter, &key, &value)) {
639 prop = value;
640 if (object_property_is_child(prop) && prop->opaque == child) {
641 g_hash_table_iter_remove(&iter);
Paolo Bonzini6c1fdcf2012-02-28 09:54:15 +0100642 break;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600643 }
644 }
645}
646
647void object_unparent(Object *obj)
648{
Michael S. Tsirkine998fa82013-03-18 21:01:37 +0200649 if (obj->parent) {
Markus Armbrusterf73a32a2020-05-05 17:29:11 +0200650 object_property_del_child(obj->parent, obj);
Michael S. Tsirkine998fa82013-03-18 21:01:37 +0200651 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600652}
653
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600654static void object_deinit(Object *obj, TypeImpl *type)
655{
656 if (type->instance_finalize) {
657 type->instance_finalize(obj);
658 }
659
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600660 if (type_has_parent(type)) {
661 object_deinit(obj, type_get_parent(type));
662 }
663}
664
Paolo Bonzini339c2702012-11-23 09:47:16 +0100665static void object_finalize(void *data)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600666{
667 Object *obj = data;
668 TypeImpl *ti = obj->class->type;
669
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600670 object_property_del_all(obj);
Paolo Bonzini76a6e1c2014-06-11 11:58:30 +0200671 object_deinit(obj, ti);
Anthony Liguoridb85b572011-12-23 08:47:39 -0600672
Markus Armbruster719a3072018-06-08 19:02:31 +0200673 g_assert(obj->ref == 0);
Paolo Bonzinifde9bf42012-11-23 09:47:14 +0100674 if (obj->free) {
675 obj->free(obj);
676 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600677}
678
Marc-André Lureau63f7b102016-12-12 20:31:51 +0300679static Object *object_new_with_type(Type type)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600680{
681 Object *obj;
682
683 g_assert(type != NULL);
Igor Mitsyankoac451032012-02-28 15:57:11 +0400684 type_initialize(type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600685
686 obj = g_malloc(type->instance_size);
Andreas Färber5b9237f2013-08-30 18:28:37 +0200687 object_initialize_with_type(obj, type->instance_size, type);
Paolo Bonzinifde9bf42012-11-23 09:47:14 +0100688 obj->free = g_free;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600689
690 return obj;
691}
692
Paolo Bonzini3c75e122019-11-13 13:57:55 +0100693Object *object_new_with_class(ObjectClass *klass)
694{
695 return object_new_with_type(klass->type);
696}
697
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600698Object *object_new(const char *typename)
699{
700 TypeImpl *ti = type_get_by_name(typename);
701
702 return object_new_with_type(ti);
703}
704
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100705
706Object *object_new_with_props(const char *typename,
707 Object *parent,
708 const char *id,
709 Error **errp,
710 ...)
711{
712 va_list vargs;
713 Object *obj;
714
715 va_start(vargs, errp);
716 obj = object_new_with_propv(typename, parent, id, errp, vargs);
717 va_end(vargs);
718
719 return obj;
720}
721
722
723Object *object_new_with_propv(const char *typename,
724 Object *parent,
725 const char *id,
726 Error **errp,
727 va_list vargs)
728{
729 Object *obj;
730 ObjectClass *klass;
731 Error *local_err = NULL;
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400732 UserCreatable *uc;
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100733
734 klass = object_class_by_name(typename);
735 if (!klass) {
736 error_setg(errp, "invalid object type: %s", typename);
737 return NULL;
738 }
739
740 if (object_class_is_abstract(klass)) {
741 error_setg(errp, "object type '%s' is abstract", typename);
742 return NULL;
743 }
Wei Yang66e11552019-03-11 16:32:34 +0800744 obj = object_new_with_type(klass->type);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100745
746 if (object_set_propv(obj, &local_err, vargs) < 0) {
747 goto error;
748 }
749
Daniel P. Berrangé6134d752018-06-15 16:39:35 +0100750 if (id != NULL) {
Markus Armbrusterd2623122020-05-05 17:29:22 +0200751 object_property_add_child(parent, id, obj);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100752 }
753
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400754 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
755 if (uc) {
756 user_creatable_complete(uc, &local_err);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100757 if (local_err) {
Daniel P. Berrangé6134d752018-06-15 16:39:35 +0100758 if (id != NULL) {
759 object_unparent(obj);
760 }
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100761 goto error;
762 }
763 }
764
Philippe Mathieu-Daudé688ffbb2020-05-12 09:00:19 +0200765 object_unref(obj);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100766 return obj;
767
768 error:
Eduardo Habkost621ff942016-06-13 18:57:56 -0300769 error_propagate(errp, local_err);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100770 object_unref(obj);
771 return NULL;
772}
773
774
775int object_set_props(Object *obj,
776 Error **errp,
777 ...)
778{
779 va_list vargs;
780 int ret;
781
782 va_start(vargs, errp);
783 ret = object_set_propv(obj, errp, vargs);
784 va_end(vargs);
785
786 return ret;
787}
788
789
790int object_set_propv(Object *obj,
791 Error **errp,
792 va_list vargs)
793{
794 const char *propname;
795 Error *local_err = NULL;
796
797 propname = va_arg(vargs, char *);
798 while (propname != NULL) {
799 const char *value = va_arg(vargs, char *);
800
801 g_assert(value != NULL);
802 object_property_parse(obj, value, propname, &local_err);
803 if (local_err) {
804 error_propagate(errp, local_err);
805 return -1;
806 }
807 propname = va_arg(vargs, char *);
808 }
809
810 return 0;
811}
812
813
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600814Object *object_dynamic_cast(Object *obj, const char *typename)
815{
Paolo Bonzinib7f43fe2012-11-23 16:56:17 +0100816 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
Paolo Bonziniacc4af32012-02-03 11:57:23 +0100817 return obj;
818 }
819
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600820 return NULL;
821}
822
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200823Object *object_dynamic_cast_assert(Object *obj, const char *typename,
824 const char *file, int line, const char *func)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600825{
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200826 trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
827 typename, file, line, func);
828
Paolo Bonzini3556c232013-05-10 14:16:40 +0200829#ifdef CONFIG_QOM_CAST_DEBUG
Anthony Liguori03587322013-05-13 15:22:24 -0500830 int i;
831 Object *inst;
832
Peter Crosthwaite95916ab2013-05-22 11:19:16 +1000833 for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100834 if (atomic_read(&obj->class->object_cast_cache[i]) == typename) {
Anthony Liguori03587322013-05-13 15:22:24 -0500835 goto out;
836 }
837 }
838
839 inst = object_dynamic_cast(obj, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600840
Paolo Bonzinib7f43fe2012-11-23 16:56:17 +0100841 if (!inst && obj) {
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200842 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
843 file, line, func, obj, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600844 abort();
845 }
846
Paolo Bonzini3556c232013-05-10 14:16:40 +0200847 assert(obj == inst);
Anthony Liguori03587322013-05-13 15:22:24 -0500848
Peter Crosthwaite95916ab2013-05-22 11:19:16 +1000849 if (obj && obj == inst) {
Anthony Liguori03587322013-05-13 15:22:24 -0500850 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100851 atomic_set(&obj->class->object_cast_cache[i - 1],
852 atomic_read(&obj->class->object_cast_cache[i]));
Anthony Liguori03587322013-05-13 15:22:24 -0500853 }
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100854 atomic_set(&obj->class->object_cast_cache[i - 1], typename);
Anthony Liguori03587322013-05-13 15:22:24 -0500855 }
856
857out:
Paolo Bonzini3556c232013-05-10 14:16:40 +0200858#endif
859 return obj;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600860}
861
862ObjectClass *object_class_dynamic_cast(ObjectClass *class,
863 const char *typename)
864{
Anthony Liguori33e95c62012-08-10 13:16:10 +1000865 ObjectClass *ret = NULL;
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200866 TypeImpl *target_type;
867 TypeImpl *type;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600868
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200869 if (!class) {
870 return NULL;
871 }
872
Paolo Bonzini793c96b2013-05-10 14:16:37 +0200873 /* A simple fast path that can trigger a lot for leaf classes. */
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200874 type = class->type;
Paolo Bonzini793c96b2013-05-10 14:16:37 +0200875 if (type->name == typename) {
876 return class;
877 }
878
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200879 target_type = type_get_by_name(typename);
Alexander Graf9ab880b2013-04-30 15:02:16 +0200880 if (!target_type) {
881 /* target class type unknown, so fail the cast */
882 return NULL;
883 }
884
Peter Crosthwaite00e2cea2013-02-19 14:02:10 +1000885 if (type->class->interfaces &&
886 type_is_ancestor(target_type, type_interface)) {
Anthony Liguori33e95c62012-08-10 13:16:10 +1000887 int found = 0;
888 GSList *i;
889
890 for (i = class->interfaces; i; i = i->next) {
891 ObjectClass *target_class = i->data;
892
893 if (type_is_ancestor(target_class->type, target_type)) {
894 ret = target_class;
895 found++;
896 }
897 }
898
899 /* The match was ambiguous, don't allow a cast */
900 if (found > 1) {
901 ret = NULL;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600902 }
Anthony Liguori33e95c62012-08-10 13:16:10 +1000903 } else if (type_is_ancestor(type, target_type)) {
904 ret = class;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600905 }
906
Anthony Liguori33e95c62012-08-10 13:16:10 +1000907 return ret;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600908}
909
910ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200911 const char *typename,
912 const char *file, int line,
913 const char *func)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600914{
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200915 ObjectClass *ret;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600916
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200917 trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)",
918 typename, file, line, func);
919
Anthony Liguori03587322013-05-13 15:22:24 -0500920#ifdef CONFIG_QOM_CAST_DEBUG
921 int i;
922
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000923 for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100924 if (atomic_read(&class->class_cast_cache[i]) == typename) {
Anthony Liguori03587322013-05-13 15:22:24 -0500925 ret = class;
926 goto out;
927 }
928 }
929#else
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000930 if (!class || !class->interfaces) {
Paolo Bonzini3556c232013-05-10 14:16:40 +0200931 return class;
932 }
933#endif
934
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200935 ret = object_class_dynamic_cast(class, typename);
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200936 if (!ret && class) {
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200937 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
938 file, line, func, class, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600939 abort();
940 }
941
Anthony Liguori03587322013-05-13 15:22:24 -0500942#ifdef CONFIG_QOM_CAST_DEBUG
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000943 if (class && ret == class) {
Anthony Liguori03587322013-05-13 15:22:24 -0500944 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100945 atomic_set(&class->class_cast_cache[i - 1],
946 atomic_read(&class->class_cast_cache[i]));
Anthony Liguori03587322013-05-13 15:22:24 -0500947 }
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100948 atomic_set(&class->class_cast_cache[i - 1], typename);
Anthony Liguori03587322013-05-13 15:22:24 -0500949 }
950out:
951#endif
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600952 return ret;
953}
954
Igor Mammedov8f5d58e2017-07-14 10:14:50 +0800955const char *object_get_typename(const Object *obj)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600956{
957 return obj->class->type->name;
958}
959
960ObjectClass *object_get_class(Object *obj)
961{
962 return obj->class;
963}
964
Andreas Färber17862372013-01-23 12:20:18 +0100965bool object_class_is_abstract(ObjectClass *klass)
966{
967 return klass->type->abstract;
968}
969
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600970const char *object_class_get_name(ObjectClass *klass)
971{
972 return klass->type->name;
973}
974
975ObjectClass *object_class_by_name(const char *typename)
976{
977 TypeImpl *type = type_get_by_name(typename);
978
979 if (!type) {
980 return NULL;
981 }
982
Igor Mitsyankoac451032012-02-28 15:57:11 +0400983 type_initialize(type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600984
985 return type->class;
986}
987
Gerd Hoffmann0f8198f2020-06-24 15:10:37 +0200988ObjectClass *module_object_class_by_name(const char *typename)
989{
990 ObjectClass *oc;
991
992 oc = object_class_by_name(typename);
993#ifdef CONFIG_MODULES
994 if (!oc) {
995 module_load_qom_one(typename);
996 oc = object_class_by_name(typename);
997 }
998#endif
999 return oc;
1000}
1001
Paolo Bonzinie7cce672012-05-02 13:30:54 +02001002ObjectClass *object_class_get_parent(ObjectClass *class)
1003{
1004 TypeImpl *type = type_get_parent(class->type);
1005
1006 if (!type) {
1007 return NULL;
1008 }
1009
1010 type_initialize(type);
1011
1012 return type->class;
1013}
1014
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001015typedef struct OCFData
1016{
1017 void (*fn)(ObjectClass *klass, void *opaque);
Anthony Liguori93c511a2011-12-22 14:11:53 -06001018 const char *implements_type;
1019 bool include_abstract;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001020 void *opaque;
1021} OCFData;
1022
1023static void object_class_foreach_tramp(gpointer key, gpointer value,
1024 gpointer opaque)
1025{
1026 OCFData *data = opaque;
1027 TypeImpl *type = value;
Anthony Liguori93c511a2011-12-22 14:11:53 -06001028 ObjectClass *k;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001029
Igor Mitsyankoac451032012-02-28 15:57:11 +04001030 type_initialize(type);
Anthony Liguori93c511a2011-12-22 14:11:53 -06001031 k = type->class;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001032
Anthony Liguori93c511a2011-12-22 14:11:53 -06001033 if (!data->include_abstract && type->abstract) {
1034 return;
1035 }
1036
1037 if (data->implements_type &&
1038 !object_class_dynamic_cast(k, data->implements_type)) {
1039 return;
1040 }
1041
1042 data->fn(k, data->opaque);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001043}
1044
1045void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
Anthony Liguori93c511a2011-12-22 14:11:53 -06001046 const char *implements_type, bool include_abstract,
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001047 void *opaque)
1048{
Anthony Liguori93c511a2011-12-22 14:11:53 -06001049 OCFData data = { fn, implements_type, include_abstract, opaque };
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001050
Hervé Poussineauf54c19c2013-12-03 16:42:00 +01001051 enumerating_types = true;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001052 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
Hervé Poussineauf54c19c2013-12-03 16:42:00 +01001053 enumerating_types = false;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001054}
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001055
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001056static int do_object_child_foreach(Object *obj,
1057 int (*fn)(Object *child, void *opaque),
1058 void *opaque, bool recurse)
Paolo Bonzini32efc532012-04-11 23:30:20 +02001059{
Pavel Fedinb604a852015-10-13 13:37:45 +01001060 GHashTableIter iter;
1061 ObjectProperty *prop;
Paolo Bonzini32efc532012-04-11 23:30:20 +02001062 int ret = 0;
1063
Pavel Fedinb604a852015-10-13 13:37:45 +01001064 g_hash_table_iter_init(&iter, obj->properties);
1065 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Paolo Bonzini32efc532012-04-11 23:30:20 +02001066 if (object_property_is_child(prop)) {
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001067 Object *child = prop->opaque;
1068
1069 ret = fn(child, opaque);
Paolo Bonzini32efc532012-04-11 23:30:20 +02001070 if (ret != 0) {
1071 break;
1072 }
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001073 if (recurse) {
Cédric Le Goater4a391812020-04-04 17:33:40 +02001074 ret = do_object_child_foreach(child, fn, opaque, true);
1075 if (ret != 0) {
1076 break;
1077 }
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001078 }
Paolo Bonzini32efc532012-04-11 23:30:20 +02001079 }
1080 }
1081 return ret;
1082}
1083
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001084int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
1085 void *opaque)
1086{
1087 return do_object_child_foreach(obj, fn, opaque, false);
1088}
1089
1090int object_child_foreach_recursive(Object *obj,
1091 int (*fn)(Object *child, void *opaque),
1092 void *opaque)
1093{
1094 return do_object_child_foreach(obj, fn, opaque, true);
1095}
1096
Andreas Färber418ba9e2012-02-25 23:07:34 +01001097static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
1098{
1099 GSList **list = opaque;
1100
1101 *list = g_slist_prepend(*list, klass);
1102}
1103
1104GSList *object_class_get_list(const char *implements_type,
1105 bool include_abstract)
1106{
1107 GSList *list = NULL;
1108
1109 object_class_foreach(object_class_get_list_tramp,
1110 implements_type, include_abstract, &list);
1111 return list;
1112}
1113
Paolo Bonzini47c66002018-03-03 08:33:10 +01001114static gint object_class_cmp(gconstpointer a, gconstpointer b)
1115{
1116 return strcasecmp(object_class_get_name((ObjectClass *)a),
1117 object_class_get_name((ObjectClass *)b));
1118}
1119
1120GSList *object_class_get_list_sorted(const char *implements_type,
1121 bool include_abstract)
1122{
1123 return g_slist_sort(object_class_get_list(implements_type, include_abstract),
1124 object_class_cmp);
1125}
1126
Marc-André Lureaub77ade92020-01-10 19:30:31 +04001127Object *object_ref(Object *obj)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001128{
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001129 if (!obj) {
Marc-André Lureaub77ade92020-01-10 19:30:31 +04001130 return NULL;
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001131 }
Andreas Färber8438a132015-11-16 17:49:20 +01001132 atomic_inc(&obj->ref);
Marc-André Lureaub77ade92020-01-10 19:30:31 +04001133 return obj;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001134}
1135
1136void object_unref(Object *obj)
1137{
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001138 if (!obj) {
1139 return;
1140 }
Markus Armbruster719a3072018-06-08 19:02:31 +02001141 g_assert(obj->ref > 0);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001142
1143 /* parent always holds a reference to its children */
Jan Kiszkaf08c03f2013-07-02 11:36:39 +02001144 if (atomic_fetch_dec(&obj->ref) == 1) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001145 object_finalize(obj);
1146 }
1147}
1148
Markus Armbrusterd2623122020-05-05 17:29:22 +02001149static ObjectProperty *
1150object_property_try_add(Object *obj, const char *name, const char *type,
1151 ObjectPropertyAccessor *get,
1152 ObjectPropertyAccessor *set,
1153 ObjectPropertyRelease *release,
1154 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001155{
Peter Maydell54852b02013-03-25 13:15:13 +00001156 ObjectProperty *prop;
Peter Crosthwaite33965902014-08-19 23:55:52 -07001157 size_t name_len = strlen(name);
1158
1159 if (name_len >= 3 && !memcmp(name + name_len - 3, "[*]", 4)) {
1160 int i;
1161 ObjectProperty *ret;
1162 char *name_no_array = g_strdup(name);
1163
1164 name_no_array[name_len - 3] = '\0';
1165 for (i = 0; ; ++i) {
1166 char *full_name = g_strdup_printf("%s[%d]", name_no_array, i);
1167
Markus Armbrusterd2623122020-05-05 17:29:22 +02001168 ret = object_property_try_add(obj, full_name, type, get, set,
1169 release, opaque, NULL);
Peter Crosthwaite33965902014-08-19 23:55:52 -07001170 g_free(full_name);
1171 if (ret) {
1172 break;
1173 }
1174 }
1175 g_free(name_no_array);
1176 return ret;
1177 }
Peter Maydell54852b02013-03-25 13:15:13 +00001178
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001179 if (object_property_find(obj, name, NULL) != NULL) {
Greg Kurzd55e9372019-11-04 14:23:55 +01001180 error_setg(errp, "attempt to add duplicate property '%s' to object (type '%s')",
1181 name, object_get_typename(obj));
Pavel Fedinb604a852015-10-13 13:37:45 +01001182 return NULL;
Peter Maydell54852b02013-03-25 13:15:13 +00001183 }
1184
1185 prop = g_malloc0(sizeof(*prop));
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001186
1187 prop->name = g_strdup(name);
1188 prop->type = g_strdup(type);
1189
1190 prop->get = get;
1191 prop->set = set;
1192 prop->release = release;
1193 prop->opaque = opaque;
1194
Pavel Fedinb604a852015-10-13 13:37:45 +01001195 g_hash_table_insert(obj->properties, prop->name, prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001196 return prop;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001197}
1198
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001199ObjectProperty *
Markus Armbrusterd2623122020-05-05 17:29:22 +02001200object_property_add(Object *obj, const char *name, const char *type,
1201 ObjectPropertyAccessor *get,
1202 ObjectPropertyAccessor *set,
1203 ObjectPropertyRelease *release,
1204 void *opaque)
1205{
1206 return object_property_try_add(obj, name, type, get, set, release,
1207 opaque, &error_abort);
1208}
1209
1210ObjectProperty *
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001211object_class_property_add(ObjectClass *klass,
1212 const char *name,
1213 const char *type,
1214 ObjectPropertyAccessor *get,
1215 ObjectPropertyAccessor *set,
1216 ObjectPropertyRelease *release,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001217 void *opaque)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001218{
1219 ObjectProperty *prop;
1220
Markus Armbrusterd2623122020-05-05 17:29:22 +02001221 assert(!object_class_property_find(klass, name, NULL));
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001222
1223 prop = g_malloc0(sizeof(*prop));
1224
1225 prop->name = g_strdup(name);
1226 prop->type = g_strdup(type);
1227
1228 prop->get = get;
1229 prop->set = set;
1230 prop->release = release;
1231 prop->opaque = opaque;
1232
Marc-André Lureauba806ff2020-01-10 19:30:18 +04001233 g_hash_table_insert(klass->properties, prop->name, prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001234
1235 return prop;
1236}
1237
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001238ObjectProperty *object_property_find(Object *obj, const char *name,
1239 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001240{
1241 ObjectProperty *prop;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001242 ObjectClass *klass = object_get_class(obj);
1243
1244 prop = object_class_property_find(klass, name, NULL);
1245 if (prop) {
1246 return prop;
1247 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001248
Pavel Fedinb604a852015-10-13 13:37:45 +01001249 prop = g_hash_table_lookup(obj->properties, name);
1250 if (prop) {
1251 return prop;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001252 }
1253
Cole Robinsonf231b882014-03-21 19:42:26 -04001254 error_setg(errp, "Property '.%s' not found", name);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001255 return NULL;
1256}
1257
Daniel P. Berrange7746abd2015-12-09 12:34:02 +00001258void object_property_iter_init(ObjectPropertyIterator *iter,
1259 Object *obj)
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001260{
Daniel P. Berrange7746abd2015-12-09 12:34:02 +00001261 g_hash_table_iter_init(&iter->iter, obj->properties);
1262 iter->nextclass = object_get_class(obj);
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001263}
1264
1265ObjectProperty *object_property_iter_next(ObjectPropertyIterator *iter)
1266{
Pavel Fedinb604a852015-10-13 13:37:45 +01001267 gpointer key, val;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001268 while (!g_hash_table_iter_next(&iter->iter, &key, &val)) {
1269 if (!iter->nextclass) {
1270 return NULL;
1271 }
1272 g_hash_table_iter_init(&iter->iter, iter->nextclass->properties);
1273 iter->nextclass = object_class_get_parent(iter->nextclass);
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001274 }
Pavel Fedinb604a852015-10-13 13:37:45 +01001275 return val;
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001276}
1277
Alexey Kardashevskiy961c47b2018-03-02 00:09:39 +11001278void object_class_property_iter_init(ObjectPropertyIterator *iter,
1279 ObjectClass *klass)
1280{
1281 g_hash_table_iter_init(&iter->iter, klass->properties);
Marc-André Lureau684546d2018-09-06 17:37:36 +04001282 iter->nextclass = object_class_get_parent(klass);
Alexey Kardashevskiy961c47b2018-03-02 00:09:39 +11001283}
1284
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001285ObjectProperty *object_class_property_find(ObjectClass *klass, const char *name,
1286 Error **errp)
1287{
1288 ObjectProperty *prop;
1289 ObjectClass *parent_klass;
1290
1291 parent_klass = object_class_get_parent(klass);
1292 if (parent_klass) {
1293 prop = object_class_property_find(parent_klass, name, NULL);
1294 if (prop) {
1295 return prop;
1296 }
1297 }
1298
1299 prop = g_hash_table_lookup(klass->properties, name);
1300 if (!prop) {
1301 error_setg(errp, "Property '.%s' not found", name);
1302 }
1303 return prop;
1304}
1305
Markus Armbrusterdf4fe0b2020-05-05 17:29:26 +02001306void object_property_del(Object *obj, const char *name)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001307{
Pavel Fedinb604a852015-10-13 13:37:45 +01001308 ObjectProperty *prop = g_hash_table_lookup(obj->properties, name);
1309
Anthony Liguori0866aca2011-12-23 15:34:39 -06001310 if (prop->release) {
1311 prop->release(obj, name, prop->opaque);
1312 }
Pavel Fedinb604a852015-10-13 13:37:45 +01001313 g_hash_table_remove(obj->properties, name);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001314}
1315
1316void object_property_get(Object *obj, Visitor *v, const char *name,
1317 Error **errp)
1318{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001319 ObjectProperty *prop = object_property_find(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001320 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001321 return;
1322 }
1323
1324 if (!prop->get) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001325 error_setg(errp, QERR_PERMISSION_DENIED);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001326 } else {
Eric Blaked7bce992016-01-29 06:48:55 -07001327 prop->get(obj, v, name, prop->opaque, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001328 }
1329}
1330
1331void object_property_set(Object *obj, Visitor *v, const char *name,
1332 Error **errp)
1333{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001334 ObjectProperty *prop = object_property_find(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001335 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001336 return;
1337 }
1338
1339 if (!prop->set) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001340 error_setg(errp, QERR_PERMISSION_DENIED);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001341 } else {
Eric Blaked7bce992016-01-29 06:48:55 -07001342 prop->set(obj, v, name, prop->opaque, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001343 }
1344}
1345
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001346void object_property_set_str(Object *obj, const char *value,
1347 const char *name, Error **errp)
1348{
1349 QString *qstr = qstring_from_str(value);
1350 object_property_set_qobject(obj, QOBJECT(qstr), name, errp);
1351
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001352 qobject_unref(qstr);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001353}
1354
1355char *object_property_get_str(Object *obj, const char *name,
1356 Error **errp)
1357{
1358 QObject *ret = object_property_get_qobject(obj, name, errp);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001359 char *retval;
1360
1361 if (!ret) {
1362 return NULL;
1363 }
Peter Xuaafb21a2018-03-09 16:59:47 +08001364
1365 retval = g_strdup(qobject_get_try_str(ret));
1366 if (!retval) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001367 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001368 }
1369
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001370 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001371 return retval;
1372}
1373
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001374void object_property_set_link(Object *obj, Object *value,
1375 const char *name, Error **errp)
1376{
Peter Crosthwaited3c49312014-09-25 22:19:19 -07001377 if (value) {
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001378 char *path = object_get_canonical_path(value);
Peter Crosthwaited3c49312014-09-25 22:19:19 -07001379 object_property_set_str(obj, path, name, errp);
1380 g_free(path);
1381 } else {
1382 object_property_set_str(obj, "", name, errp);
1383 }
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001384}
1385
1386Object *object_property_get_link(Object *obj, const char *name,
1387 Error **errp)
1388{
1389 char *str = object_property_get_str(obj, name, errp);
1390 Object *target = NULL;
1391
1392 if (str && *str) {
1393 target = object_resolve_path(str, NULL);
1394 if (!target) {
Markus Armbruster75158eb2015-03-16 08:57:47 +01001395 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1396 "Device '%s' not found", str);
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001397 }
1398 }
1399
1400 g_free(str);
1401 return target;
1402}
1403
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001404void object_property_set_bool(Object *obj, bool value,
1405 const char *name, Error **errp)
1406{
Eric Blakefc48ffc2015-05-15 16:24:59 -06001407 QBool *qbool = qbool_from_bool(value);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001408 object_property_set_qobject(obj, QOBJECT(qbool), name, errp);
1409
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001410 qobject_unref(qbool);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001411}
1412
1413bool object_property_get_bool(Object *obj, const char *name,
1414 Error **errp)
1415{
1416 QObject *ret = object_property_get_qobject(obj, name, errp);
1417 QBool *qbool;
1418 bool retval;
1419
1420 if (!ret) {
1421 return false;
1422 }
Max Reitz7dc847e2018-02-24 16:40:29 +01001423 qbool = qobject_to(QBool, ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001424 if (!qbool) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001425 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001426 retval = false;
1427 } else {
Eric Blakefc48ffc2015-05-15 16:24:59 -06001428 retval = qbool_get_bool(qbool);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001429 }
1430
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001431 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001432 return retval;
1433}
1434
1435void object_property_set_int(Object *obj, int64_t value,
1436 const char *name, Error **errp)
1437{
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001438 QNum *qnum = qnum_from_int(value);
1439 object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001440
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001441 qobject_unref(qnum);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001442}
1443
1444int64_t object_property_get_int(Object *obj, const char *name,
1445 Error **errp)
1446{
1447 QObject *ret = object_property_get_qobject(obj, name, errp);
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001448 QNum *qnum;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001449 int64_t retval;
1450
1451 if (!ret) {
1452 return -1;
1453 }
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001454
Max Reitz7dc847e2018-02-24 16:40:29 +01001455 qnum = qobject_to(QNum, ret);
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001456 if (!qnum || !qnum_get_try_int(qnum, &retval)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001457 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001458 retval = -1;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001459 }
1460
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001461 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001462 return retval;
1463}
1464
Marc-André Lureau0e76ed02020-01-10 19:30:23 +04001465static void object_property_init_defval(Object *obj, ObjectProperty *prop)
1466{
1467 Visitor *v = qobject_input_visitor_new(prop->defval);
1468
1469 assert(prop->set != NULL);
1470 prop->set(obj, v, prop->name, prop->opaque, &error_abort);
1471
1472 visit_free(v);
1473}
1474
1475static void object_property_set_default(ObjectProperty *prop, QObject *defval)
1476{
1477 assert(!prop->defval);
1478 assert(!prop->init);
1479
1480 prop->defval = defval;
1481 prop->init = object_property_init_defval;
1482}
1483
1484void object_property_set_default_bool(ObjectProperty *prop, bool value)
1485{
1486 object_property_set_default(prop, QOBJECT(qbool_from_bool(value)));
1487}
1488
1489void object_property_set_default_str(ObjectProperty *prop, const char *value)
1490{
1491 object_property_set_default(prop, QOBJECT(qstring_from_str(value)));
1492}
1493
1494void object_property_set_default_int(ObjectProperty *prop, int64_t value)
1495{
1496 object_property_set_default(prop, QOBJECT(qnum_from_int(value)));
1497}
1498
1499void object_property_set_default_uint(ObjectProperty *prop, uint64_t value)
1500{
1501 object_property_set_default(prop, QOBJECT(qnum_from_uint(value)));
1502}
1503
Marc-André Lureau31527792017-06-07 20:36:04 +04001504void object_property_set_uint(Object *obj, uint64_t value,
1505 const char *name, Error **errp)
1506{
1507 QNum *qnum = qnum_from_uint(value);
1508
1509 object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001510 qobject_unref(qnum);
Marc-André Lureau31527792017-06-07 20:36:04 +04001511}
1512
1513uint64_t object_property_get_uint(Object *obj, const char *name,
1514 Error **errp)
1515{
1516 QObject *ret = object_property_get_qobject(obj, name, errp);
1517 QNum *qnum;
1518 uint64_t retval;
1519
1520 if (!ret) {
1521 return 0;
1522 }
Max Reitz7dc847e2018-02-24 16:40:29 +01001523 qnum = qobject_to(QNum, ret);
Marc-André Lureau31527792017-06-07 20:36:04 +04001524 if (!qnum || !qnum_get_try_uint(qnum, &retval)) {
1525 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "uint");
1526 retval = 0;
1527 }
1528
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001529 qobject_unref(ret);
Marc-André Lureau31527792017-06-07 20:36:04 +04001530 return retval;
1531}
1532
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01001533typedef struct EnumProperty {
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02001534 const QEnumLookup *lookup;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01001535 int (*get)(Object *, Error **);
1536 void (*set)(Object *, int, Error **);
1537} EnumProperty;
1538
Hu Tao1f217722014-05-14 17:43:33 +08001539int object_property_get_enum(Object *obj, const char *name,
Daniel P. Berrangea3590da2015-05-27 16:07:56 +01001540 const char *typename, Error **errp)
Hu Tao1f217722014-05-14 17:43:33 +08001541{
Chen Fan976620a2014-08-18 14:46:34 +08001542 char *str;
Hu Tao1f217722014-05-14 17:43:33 +08001543 int ret;
Daniel P. Berrangea3590da2015-05-27 16:07:56 +01001544 ObjectProperty *prop = object_property_find(obj, name, errp);
1545 EnumProperty *enumprop;
1546
1547 if (prop == NULL) {
1548 return 0;
1549 }
1550
1551 if (!g_str_equal(prop->type, typename)) {
1552 error_setg(errp, "Property %s on %s is not '%s' enum type",
1553 name, object_class_get_name(
1554 object_get_class(obj)), typename);
1555 return 0;
1556 }
1557
1558 enumprop = prop->opaque;
Hu Tao1f217722014-05-14 17:43:33 +08001559
Markus Armbrusterb555f892020-05-05 17:29:12 +02001560 str = object_property_get_str(obj, name, errp);
1561 if (!str) {
Markus Armbruster4715d422015-08-25 20:00:45 +02001562 return 0;
1563 }
Chen Fan976620a2014-08-18 14:46:34 +08001564
Markus Armbrusterea097df2020-04-24 10:43:36 +02001565 ret = qapi_enum_parse(enumprop->lookup, str, -1, errp);
Chen Fan976620a2014-08-18 14:46:34 +08001566 g_free(str);
Hu Tao1f217722014-05-14 17:43:33 +08001567
1568 return ret;
1569}
1570
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001571void object_property_parse(Object *obj, const char *string,
1572 const char *name, Error **errp)
1573{
Eric Blake7a0525c2016-06-09 10:48:37 -06001574 Visitor *v = string_input_visitor_new(string);
1575 object_property_set(obj, v, name, errp);
1576 visit_free(v);
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001577}
1578
Paolo Bonzini0b7593e2014-02-08 11:01:50 +01001579char *object_property_print(Object *obj, const char *name, bool human,
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001580 Error **errp)
1581{
Eric Blake3b098d52016-06-09 10:48:43 -06001582 Visitor *v;
Gonglei3a530092014-09-27 13:13:55 +08001583 char *string = NULL;
1584 Error *local_err = NULL;
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001585
Eric Blake3b098d52016-06-09 10:48:43 -06001586 v = string_output_visitor_new(human, &string);
1587 object_property_get(obj, v, name, &local_err);
Gonglei3a530092014-09-27 13:13:55 +08001588 if (local_err) {
1589 error_propagate(errp, local_err);
1590 goto out;
1591 }
1592
Eric Blake3b098d52016-06-09 10:48:43 -06001593 visit_complete(v, &string);
Gonglei3a530092014-09-27 13:13:55 +08001594
1595out:
Eric Blake3b098d52016-06-09 10:48:43 -06001596 visit_free(v);
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001597 return string;
1598}
1599
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001600const char *object_property_get_type(Object *obj, const char *name, Error **errp)
1601{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001602 ObjectProperty *prop = object_property_find(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001603 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001604 return NULL;
1605 }
1606
1607 return prop->type;
1608}
1609
1610Object *object_get_root(void)
1611{
Anthony Liguori8b45d442011-12-23 09:08:05 -06001612 static Object *root;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001613
Anthony Liguori8b45d442011-12-23 09:08:05 -06001614 if (!root) {
1615 root = object_new("container");
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001616 }
1617
Anthony Liguori8b45d442011-12-23 09:08:05 -06001618 return root;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001619}
1620
Daniel P. Berrangebc2256c2015-05-13 17:14:05 +01001621Object *object_get_objects_root(void)
1622{
1623 return container_get(object_get_root(), "/objects");
1624}
1625
Peter Xu7c47c4e2017-09-28 10:59:54 +08001626Object *object_get_internal_root(void)
1627{
1628 static Object *internal_root;
1629
1630 if (!internal_root) {
1631 internal_root = object_new("container");
1632 }
1633
1634 return internal_root;
1635}
1636
Eric Blaked7bce992016-01-29 06:48:55 -07001637static void object_get_child_property(Object *obj, Visitor *v,
1638 const char *name, void *opaque,
1639 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001640{
1641 Object *child = opaque;
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001642 char *path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001643
1644 path = object_get_canonical_path(child);
Eric Blake51e72bc2016-01-29 06:48:54 -07001645 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001646 g_free(path);
1647}
1648
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001649static Object *object_resolve_child_property(Object *parent, void *opaque,
1650 const char *part)
Paolo Bonzini64607d02014-06-05 13:11:51 +02001651{
1652 return opaque;
1653}
1654
Anthony Liguoridb85b572011-12-23 08:47:39 -06001655static void object_finalize_child_property(Object *obj, const char *name,
1656 void *opaque)
1657{
1658 Object *child = opaque;
1659
Paolo Bonzinibffc6872014-06-11 11:57:38 +02001660 if (child->class->unparent) {
1661 (child->class->unparent)(child);
1662 }
1663 child->parent = NULL;
Anthony Liguoridb85b572011-12-23 08:47:39 -06001664 object_unref(child);
1665}
1666
Markus Armbruster70251882020-05-05 17:29:14 +02001667ObjectProperty *
1668object_property_add_child(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001669 Object *child)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001670{
Markus Armbruster70251882020-05-05 17:29:14 +02001671 g_autofree char *type = NULL;
Paolo Bonzini64607d02014-06-05 13:11:51 +02001672 ObjectProperty *op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001673
Markus Armbrusterd2623122020-05-05 17:29:22 +02001674 assert(!child->parent);
Peter Crosthwaite8faa2f82014-09-25 22:19:52 -07001675
Philippe Mathieu-Daudé688ffbb2020-05-12 09:00:19 +02001676 type = g_strdup_printf("child<%s>", object_get_typename(child));
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001677
Paolo Bonzini64607d02014-06-05 13:11:51 +02001678 op = object_property_add(obj, name, type, object_get_child_property, NULL,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001679 object_finalize_child_property, child);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001680 op->resolve = object_resolve_child_property;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001681 object_ref(child);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001682 child->parent = obj;
Markus Armbruster70251882020-05-05 17:29:14 +02001683 return op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001684}
1685
Igor Mammedov8f5d58e2017-07-14 10:14:50 +08001686void object_property_allow_set_link(const Object *obj, const char *name,
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001687 Object *val, Error **errp)
1688{
1689 /* Allow the link to be set, always */
1690}
1691
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001692typedef struct {
Marc-André Lureau9941d372020-01-10 19:30:27 +04001693 union {
1694 Object **targetp;
1695 Object *target; /* if OBJ_PROP_LINK_DIRECT, when holding the pointer */
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001696 ptrdiff_t offset; /* if OBJ_PROP_LINK_CLASS */
Marc-André Lureau9941d372020-01-10 19:30:27 +04001697 };
Igor Mammedov8f5d58e2017-07-14 10:14:50 +08001698 void (*check)(const Object *, const char *, Object *, Error **);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001699 ObjectPropertyLinkFlags flags;
1700} LinkProperty;
1701
Marc-André Lureau9941d372020-01-10 19:30:27 +04001702static Object **
1703object_link_get_targetp(Object *obj, LinkProperty *lprop)
1704{
1705 if (lprop->flags & OBJ_PROP_LINK_DIRECT) {
1706 return &lprop->target;
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001707 } else if (lprop->flags & OBJ_PROP_LINK_CLASS) {
1708 return (void *)obj + lprop->offset;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001709 } else {
1710 return lprop->targetp;
1711 }
1712}
1713
Eric Blaked7bce992016-01-29 06:48:55 -07001714static void object_get_link_property(Object *obj, Visitor *v,
1715 const char *name, void *opaque,
1716 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001717{
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001718 LinkProperty *lprop = opaque;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001719 Object **targetp = object_link_get_targetp(obj, lprop);
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001720 char *path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001721
Marc-André Lureau36854202020-01-10 19:30:26 +04001722 if (*targetp) {
1723 path = object_get_canonical_path(*targetp);
Eric Blake51e72bc2016-01-29 06:48:54 -07001724 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001725 g_free(path);
1726 } else {
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001727 path = (char *)"";
Eric Blake51e72bc2016-01-29 06:48:54 -07001728 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001729 }
1730}
1731
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001732/*
1733 * object_resolve_link:
1734 *
1735 * Lookup an object and ensure its type matches the link property type. This
1736 * is similar to object_resolve_path() except type verification against the
1737 * link property is performed.
1738 *
1739 * Returns: The matched object or NULL on path lookup failures.
1740 */
1741static Object *object_resolve_link(Object *obj, const char *name,
1742 const char *path, Error **errp)
1743{
1744 const char *type;
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001745 char *target_type;
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001746 bool ambiguous = false;
1747 Object *target;
1748
1749 /* Go from link<FOO> to FOO. */
1750 type = object_property_get_type(obj, name, NULL);
1751 target_type = g_strndup(&type[5], strlen(type) - 6);
1752 target = object_resolve_path_type(path, target_type, &ambiguous);
1753
1754 if (ambiguous) {
Eric Blake455b0fd2015-11-10 23:51:20 -07001755 error_setg(errp, "Path '%s' does not uniquely identify an object",
1756 path);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001757 } else if (!target) {
1758 target = object_resolve_path(path, &ambiguous);
1759 if (target || ambiguous) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001760 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001761 } else {
Markus Armbruster75158eb2015-03-16 08:57:47 +01001762 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1763 "Device '%s' not found", path);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001764 }
1765 target = NULL;
1766 }
1767 g_free(target_type);
1768
1769 return target;
1770}
1771
Eric Blaked7bce992016-01-29 06:48:55 -07001772static void object_set_link_property(Object *obj, Visitor *v,
1773 const char *name, void *opaque,
1774 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001775{
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001776 Error *local_err = NULL;
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001777 LinkProperty *prop = opaque;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001778 Object **targetp = object_link_get_targetp(obj, prop);
Marc-André Lureau36854202020-01-10 19:30:26 +04001779 Object *old_target = *targetp;
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001780 Object *new_target = NULL;
1781 char *path = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001782
Eric Blake51e72bc2016-01-29 06:48:54 -07001783 visit_type_str(v, name, &path, &local_err);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001784
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001785 if (!local_err && strcmp(path, "") != 0) {
1786 new_target = object_resolve_link(obj, name, path, &local_err);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001787 }
1788
1789 g_free(path);
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001790 if (local_err) {
1791 error_propagate(errp, local_err);
1792 return;
1793 }
Alexander Barabashf0cdc962012-02-22 19:22:26 +02001794
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001795 prop->check(obj, name, new_target, &local_err);
1796 if (local_err) {
1797 error_propagate(errp, local_err);
1798 return;
1799 }
1800
Marc-André Lureau36854202020-01-10 19:30:26 +04001801 *targetp = new_target;
Marc-André Lureau8770baf2020-01-10 19:30:25 +04001802 if (prop->flags & OBJ_PROP_LINK_STRONG) {
Marc-André Lureau265b5782018-05-31 21:51:17 +02001803 object_ref(new_target);
1804 object_unref(old_target);
1805 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001806}
1807
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001808static Object *object_resolve_link_property(Object *parent, void *opaque,
1809 const char *part)
Paolo Bonzini64607d02014-06-05 13:11:51 +02001810{
1811 LinkProperty *lprop = opaque;
1812
Marc-André Lureau9941d372020-01-10 19:30:27 +04001813 return *object_link_get_targetp(parent, lprop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001814}
1815
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001816static void object_release_link_property(Object *obj, const char *name,
1817 void *opaque)
1818{
1819 LinkProperty *prop = opaque;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001820 Object **targetp = object_link_get_targetp(obj, prop);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001821
Marc-André Lureau9941d372020-01-10 19:30:27 +04001822 if ((prop->flags & OBJ_PROP_LINK_STRONG) && *targetp) {
1823 object_unref(*targetp);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001824 }
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001825 if (!(prop->flags & OBJ_PROP_LINK_CLASS)) {
1826 g_free(prop);
1827 }
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001828}
1829
Markus Armbruster70251882020-05-05 17:29:14 +02001830static ObjectProperty *
1831object_add_link_prop(Object *obj, const char *name,
1832 const char *type, void *ptr,
1833 void (*check)(const Object *, const char *,
1834 Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02001835 ObjectPropertyLinkFlags flags)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001836{
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001837 LinkProperty *prop = g_malloc(sizeof(*prop));
Markus Armbruster70251882020-05-05 17:29:14 +02001838 g_autofree char *full_type = NULL;
Paolo Bonzini64607d02014-06-05 13:11:51 +02001839 ObjectProperty *op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001840
Marc-André Lureau4a8d5792020-01-10 19:30:28 +04001841 if (flags & OBJ_PROP_LINK_DIRECT) {
1842 prop->target = ptr;
1843 } else {
1844 prop->targetp = ptr;
1845 }
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001846 prop->check = check;
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001847 prop->flags = flags;
1848
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001849 full_type = g_strdup_printf("link<%s>", type);
1850
Paolo Bonzini64607d02014-06-05 13:11:51 +02001851 op = object_property_add(obj, name, full_type,
1852 object_get_link_property,
1853 check ? object_set_link_property : NULL,
1854 object_release_link_property,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001855 prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001856 op->resolve = object_resolve_link_property;
Markus Armbruster70251882020-05-05 17:29:14 +02001857 return op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001858}
1859
Markus Armbruster70251882020-05-05 17:29:14 +02001860ObjectProperty *
1861object_property_add_link(Object *obj, const char *name,
1862 const char *type, Object **targetp,
1863 void (*check)(const Object *, const char *,
1864 Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02001865 ObjectPropertyLinkFlags flags)
Marc-André Lureau4a8d5792020-01-10 19:30:28 +04001866{
Markus Armbrusterd2623122020-05-05 17:29:22 +02001867 return object_add_link_prop(obj, name, type, targetp, check, flags);
Marc-André Lureau4a8d5792020-01-10 19:30:28 +04001868}
1869
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001870ObjectProperty *
1871object_class_property_add_link(ObjectClass *oc,
1872 const char *name,
1873 const char *type, ptrdiff_t offset,
1874 void (*check)(const Object *obj, const char *name,
1875 Object *val, Error **errp),
Markus Armbrusterd2623122020-05-05 17:29:22 +02001876 ObjectPropertyLinkFlags flags)
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001877{
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001878 LinkProperty *prop = g_new0(LinkProperty, 1);
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001879 char *full_type;
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001880 ObjectProperty *op;
1881
1882 prop->offset = offset;
1883 prop->check = check;
1884 prop->flags = flags | OBJ_PROP_LINK_CLASS;
1885
1886 full_type = g_strdup_printf("link<%s>", type);
1887
1888 op = object_class_property_add(oc, name, full_type,
1889 object_get_link_property,
1890 check ? object_set_link_property : NULL,
1891 object_release_link_property,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001892 prop);
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001893
1894 op->resolve = object_resolve_link_property;
1895
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001896 g_free(full_type);
1897 return op;
1898}
1899
Markus Armbruster70251882020-05-05 17:29:14 +02001900ObjectProperty *
1901object_property_add_const_link(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001902 Object *target)
Paolo Bonzinifb9e7e32015-05-05 18:29:00 +02001903{
Markus Armbruster70251882020-05-05 17:29:14 +02001904 return object_add_link_prop(obj, name,
1905 object_get_typename(target), target,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001906 NULL, OBJ_PROP_LINK_DIRECT);
Paolo Bonzinifb9e7e32015-05-05 18:29:00 +02001907}
1908
Markus Armbrustere8512df2020-05-27 10:47:53 +02001909char *object_get_canonical_path_component(const Object *obj)
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001910{
1911 ObjectProperty *prop = NULL;
Pavel Fedinb604a852015-10-13 13:37:45 +01001912 GHashTableIter iter;
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001913
Paolo Bonzini770dec22018-04-30 11:44:17 +02001914 if (obj->parent == NULL) {
1915 return NULL;
1916 }
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001917
Pavel Fedinb604a852015-10-13 13:37:45 +01001918 g_hash_table_iter_init(&iter, obj->parent->properties);
1919 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001920 if (!object_property_is_child(prop)) {
1921 continue;
1922 }
1923
1924 if (prop->opaque == obj) {
1925 return g_strdup(prop->name);
1926 }
1927 }
1928
1929 /* obj had a parent but was not a child, should never happen */
1930 g_assert_not_reached();
1931 return NULL;
1932}
1933
Markus Armbrustere8512df2020-05-27 10:47:53 +02001934char *object_get_canonical_path(const Object *obj)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001935{
1936 Object *root = object_get_root();
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001937 char *newpath, *path = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001938
Paolo Bonzinie40077f2018-05-30 18:16:04 +02001939 if (obj == root) {
1940 return g_strdup("/");
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001941 }
1942
Paolo Bonzinie40077f2018-05-30 18:16:04 +02001943 do {
1944 char *component = object_get_canonical_path_component(obj);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001945
Paolo Bonzinie40077f2018-05-30 18:16:04 +02001946 if (!component) {
1947 /* A canonical path must be complete, so discard what was
1948 * collected so far.
1949 */
1950 g_free(path);
1951 return NULL;
1952 }
1953
1954 newpath = g_strdup_printf("/%s%s", component, path ? path : "");
1955 g_free(path);
1956 g_free(component);
1957 path = newpath;
1958 obj = obj->parent;
1959 } while (obj != root);
1960
1961 return path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001962}
1963
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001964Object *object_resolve_path_component(Object *parent, const char *part)
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001965{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001966 ObjectProperty *prop = object_property_find(parent, part, NULL);
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001967 if (prop == NULL) {
1968 return NULL;
1969 }
1970
Paolo Bonzini64607d02014-06-05 13:11:51 +02001971 if (prop->resolve) {
1972 return prop->resolve(parent, prop->opaque, part);
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001973 } else {
1974 return NULL;
1975 }
1976}
1977
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001978static Object *object_resolve_abs_path(Object *parent,
Masahiro Yamadaad195c82020-05-10 10:32:35 +09001979 char **parts,
1980 const char *typename)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001981{
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001982 Object *child;
1983
Masahiro Yamadaad195c82020-05-10 10:32:35 +09001984 if (*parts == NULL) {
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001985 return object_dynamic_cast(parent, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001986 }
1987
Masahiro Yamadaad195c82020-05-10 10:32:35 +09001988 if (strcmp(*parts, "") == 0) {
1989 return object_resolve_abs_path(parent, parts + 1, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001990 }
1991
Masahiro Yamadaad195c82020-05-10 10:32:35 +09001992 child = object_resolve_path_component(parent, *parts);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001993 if (!child) {
1994 return NULL;
1995 }
1996
Masahiro Yamadaad195c82020-05-10 10:32:35 +09001997 return object_resolve_abs_path(child, parts + 1, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001998}
1999
2000static Object *object_resolve_partial_path(Object *parent,
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02002001 char **parts,
2002 const char *typename,
2003 bool *ambiguous)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002004{
2005 Object *obj;
Pavel Fedinb604a852015-10-13 13:37:45 +01002006 GHashTableIter iter;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002007 ObjectProperty *prop;
2008
Masahiro Yamadaad195c82020-05-10 10:32:35 +09002009 obj = object_resolve_abs_path(parent, parts, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002010
Pavel Fedinb604a852015-10-13 13:37:45 +01002011 g_hash_table_iter_init(&iter, parent->properties);
2012 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002013 Object *found;
2014
Andreas Färber5d9d3f42012-05-27 00:32:40 +02002015 if (!object_property_is_child(prop)) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002016 continue;
2017 }
2018
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002019 found = object_resolve_partial_path(prop->opaque, parts,
2020 typename, ambiguous);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002021 if (found) {
2022 if (obj) {
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002023 *ambiguous = true;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002024 return NULL;
2025 }
2026 obj = found;
2027 }
2028
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002029 if (*ambiguous) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002030 return NULL;
2031 }
2032 }
2033
2034 return obj;
2035}
2036
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002037Object *object_resolve_path_type(const char *path, const char *typename,
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002038 bool *ambiguousp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002039{
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002040 Object *obj;
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02002041 char **parts;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002042
2043 parts = g_strsplit(path, "/", 0);
Paolo Bonzini2e1103f2013-04-18 18:44:02 +02002044 assert(parts);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002045
Paolo Bonzini2e1103f2013-04-18 18:44:02 +02002046 if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002047 bool ambiguous = false;
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002048 obj = object_resolve_partial_path(object_get_root(), parts,
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002049 typename, &ambiguous);
2050 if (ambiguousp) {
2051 *ambiguousp = ambiguous;
2052 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002053 } else {
Masahiro Yamadaad195c82020-05-10 10:32:35 +09002054 obj = object_resolve_abs_path(object_get_root(), parts + 1, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002055 }
2056
2057 g_strfreev(parts);
2058
2059 return obj;
2060}
2061
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002062Object *object_resolve_path(const char *path, bool *ambiguous)
2063{
2064 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
2065}
2066
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002067typedef struct StringProperty
2068{
2069 char *(*get)(Object *, Error **);
2070 void (*set)(Object *, const char *, Error **);
2071} StringProperty;
2072
Eric Blaked7bce992016-01-29 06:48:55 -07002073static void property_get_str(Object *obj, Visitor *v, const char *name,
2074 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002075{
2076 StringProperty *prop = opaque;
2077 char *value;
Markus Armbrustere1c82372015-08-25 20:00:46 +02002078 Error *err = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002079
Markus Armbrustere1c82372015-08-25 20:00:46 +02002080 value = prop->get(obj, &err);
2081 if (err) {
2082 error_propagate(errp, err);
2083 return;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002084 }
Markus Armbrustere1c82372015-08-25 20:00:46 +02002085
Eric Blake51e72bc2016-01-29 06:48:54 -07002086 visit_type_str(v, name, &value, errp);
Markus Armbrustere1c82372015-08-25 20:00:46 +02002087 g_free(value);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002088}
2089
Eric Blaked7bce992016-01-29 06:48:55 -07002090static void property_set_str(Object *obj, Visitor *v, const char *name,
2091 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002092{
2093 StringProperty *prop = opaque;
2094 char *value;
2095 Error *local_err = NULL;
2096
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002097 if (!visit_type_str(v, name, &value, &local_err)) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002098 error_propagate(errp, local_err);
2099 return;
2100 }
2101
2102 prop->set(obj, value, errp);
2103 g_free(value);
2104}
2105
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01002106static void property_release_str(Object *obj, const char *name,
2107 void *opaque)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002108{
2109 StringProperty *prop = opaque;
2110 g_free(prop);
2111}
2112
Markus Armbruster70251882020-05-05 17:29:14 +02002113ObjectProperty *
2114object_property_add_str(Object *obj, const char *name,
2115 char *(*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002116 void (*set)(Object *, const char *, Error **))
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002117{
2118 StringProperty *prop = g_malloc0(sizeof(*prop));
2119
2120 prop->get = get;
2121 prop->set = set;
2122
Markus Armbrusterd2623122020-05-05 17:29:22 +02002123 return object_property_add(obj, name, "string",
2124 get ? property_get_str : NULL,
2125 set ? property_set_str : NULL,
2126 property_release_str,
2127 prop);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002128}
Paolo Bonzini745549c2012-03-31 16:45:54 +02002129
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002130ObjectProperty *
2131object_class_property_add_str(ObjectClass *klass, const char *name,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002132 char *(*get)(Object *, Error **),
2133 void (*set)(Object *, const char *,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002134 Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002135{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002136 StringProperty *prop = g_malloc0(sizeof(*prop));
2137
2138 prop->get = get;
2139 prop->set = set;
2140
Markus Armbrusterd2623122020-05-05 17:29:22 +02002141 return object_class_property_add(klass, name, "string",
2142 get ? property_get_str : NULL,
2143 set ? property_set_str : NULL,
2144 NULL,
2145 prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002146}
2147
Anthony Liguori0e558842012-06-25 10:32:46 -05002148typedef struct BoolProperty
2149{
2150 bool (*get)(Object *, Error **);
2151 void (*set)(Object *, bool, Error **);
2152} BoolProperty;
2153
Eric Blaked7bce992016-01-29 06:48:55 -07002154static void property_get_bool(Object *obj, Visitor *v, const char *name,
2155 void *opaque, Error **errp)
Anthony Liguori0e558842012-06-25 10:32:46 -05002156{
2157 BoolProperty *prop = opaque;
2158 bool value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002159 Error *err = NULL;
Anthony Liguori0e558842012-06-25 10:32:46 -05002160
Markus Armbruster4715d422015-08-25 20:00:45 +02002161 value = prop->get(obj, &err);
2162 if (err) {
2163 error_propagate(errp, err);
2164 return;
2165 }
2166
Eric Blake51e72bc2016-01-29 06:48:54 -07002167 visit_type_bool(v, name, &value, errp);
Anthony Liguori0e558842012-06-25 10:32:46 -05002168}
2169
Eric Blaked7bce992016-01-29 06:48:55 -07002170static void property_set_bool(Object *obj, Visitor *v, const char *name,
2171 void *opaque, Error **errp)
Anthony Liguori0e558842012-06-25 10:32:46 -05002172{
2173 BoolProperty *prop = opaque;
2174 bool value;
2175 Error *local_err = NULL;
2176
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002177 if (!visit_type_bool(v, name, &value, &local_err)) {
Anthony Liguori0e558842012-06-25 10:32:46 -05002178 error_propagate(errp, local_err);
2179 return;
2180 }
2181
2182 prop->set(obj, value, errp);
2183}
2184
2185static void property_release_bool(Object *obj, const char *name,
2186 void *opaque)
2187{
2188 BoolProperty *prop = opaque;
2189 g_free(prop);
2190}
2191
Markus Armbruster70251882020-05-05 17:29:14 +02002192ObjectProperty *
2193object_property_add_bool(Object *obj, const char *name,
2194 bool (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002195 void (*set)(Object *, bool, Error **))
Anthony Liguori0e558842012-06-25 10:32:46 -05002196{
2197 BoolProperty *prop = g_malloc0(sizeof(*prop));
2198
2199 prop->get = get;
2200 prop->set = set;
2201
Markus Armbrusterd2623122020-05-05 17:29:22 +02002202 return object_property_add(obj, name, "bool",
2203 get ? property_get_bool : NULL,
2204 set ? property_set_bool : NULL,
2205 property_release_bool,
2206 prop);
Anthony Liguori0e558842012-06-25 10:32:46 -05002207}
2208
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002209ObjectProperty *
2210object_class_property_add_bool(ObjectClass *klass, const char *name,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002211 bool (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002212 void (*set)(Object *, bool, Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002213{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002214 BoolProperty *prop = g_malloc0(sizeof(*prop));
2215
2216 prop->get = get;
2217 prop->set = set;
2218
Markus Armbrusterd2623122020-05-05 17:29:22 +02002219 return object_class_property_add(klass, name, "bool",
2220 get ? property_get_bool : NULL,
2221 set ? property_set_bool : NULL,
2222 NULL,
2223 prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002224}
2225
Eric Blaked7bce992016-01-29 06:48:55 -07002226static void property_get_enum(Object *obj, Visitor *v, const char *name,
2227 void *opaque, Error **errp)
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002228{
2229 EnumProperty *prop = opaque;
2230 int value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002231 Error *err = NULL;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002232
Markus Armbruster4715d422015-08-25 20:00:45 +02002233 value = prop->get(obj, &err);
2234 if (err) {
2235 error_propagate(errp, err);
2236 return;
2237 }
2238
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002239 visit_type_enum(v, name, &value, prop->lookup, errp);
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002240}
2241
Eric Blaked7bce992016-01-29 06:48:55 -07002242static void property_set_enum(Object *obj, Visitor *v, const char *name,
2243 void *opaque, Error **errp)
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002244{
2245 EnumProperty *prop = opaque;
2246 int value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002247 Error *err = NULL;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002248
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002249 if (!visit_type_enum(v, name, &value, prop->lookup, &err)) {
Markus Armbruster4715d422015-08-25 20:00:45 +02002250 error_propagate(errp, err);
2251 return;
2252 }
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002253 prop->set(obj, value, errp);
2254}
2255
2256static void property_release_enum(Object *obj, const char *name,
2257 void *opaque)
2258{
2259 EnumProperty *prop = opaque;
2260 g_free(prop);
2261}
2262
Markus Armbruster70251882020-05-05 17:29:14 +02002263ObjectProperty *
2264object_property_add_enum(Object *obj, const char *name,
2265 const char *typename,
2266 const QEnumLookup *lookup,
2267 int (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002268 void (*set)(Object *, int, Error **))
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002269{
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002270 EnumProperty *prop = g_malloc(sizeof(*prop));
2271
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002272 prop->lookup = lookup;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002273 prop->get = get;
2274 prop->set = set;
2275
Markus Armbrusterd2623122020-05-05 17:29:22 +02002276 return object_property_add(obj, name, typename,
2277 get ? property_get_enum : NULL,
2278 set ? property_set_enum : NULL,
2279 property_release_enum,
2280 prop);
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002281}
2282
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002283ObjectProperty *
2284object_class_property_add_enum(ObjectClass *klass, const char *name,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002285 const char *typename,
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002286 const QEnumLookup *lookup,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002287 int (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002288 void (*set)(Object *, int, Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002289{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002290 EnumProperty *prop = g_malloc(sizeof(*prop));
2291
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002292 prop->lookup = lookup;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002293 prop->get = get;
2294 prop->set = set;
2295
Markus Armbrusterd2623122020-05-05 17:29:22 +02002296 return object_class_property_add(klass, name, typename,
2297 get ? property_get_enum : NULL,
2298 set ? property_set_enum : NULL,
2299 NULL,
2300 prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002301}
2302
David Gibson8e099d12015-02-06 14:55:45 +11002303typedef struct TMProperty {
2304 void (*get)(Object *, struct tm *, Error **);
2305} TMProperty;
2306
Eric Blaked7bce992016-01-29 06:48:55 -07002307static void property_get_tm(Object *obj, Visitor *v, const char *name,
2308 void *opaque, Error **errp)
David Gibson8e099d12015-02-06 14:55:45 +11002309{
2310 TMProperty *prop = opaque;
2311 Error *err = NULL;
2312 struct tm value;
2313
2314 prop->get(obj, &value, &err);
2315 if (err) {
2316 goto out;
2317 }
2318
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002319 if (!visit_start_struct(v, name, NULL, 0, &err)) {
David Gibson8e099d12015-02-06 14:55:45 +11002320 goto out;
2321 }
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002322 if (!visit_type_int32(v, "tm_year", &value.tm_year, &err)) {
David Gibson8e099d12015-02-06 14:55:45 +11002323 goto out_end;
2324 }
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002325 if (!visit_type_int32(v, "tm_mon", &value.tm_mon, &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_mday", &value.tm_mday, &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_hour", &value.tm_hour, &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_min", &value.tm_min, &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_sec", &value.tm_sec, &err)) {
David Gibson8e099d12015-02-06 14:55:45 +11002338 goto out_end;
2339 }
Eric Blake15c2f662016-04-28 15:45:27 -06002340 visit_check_struct(v, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002341out_end:
Eric Blake1158bb22016-06-09 10:48:34 -06002342 visit_end_struct(v, NULL);
David Gibson8e099d12015-02-06 14:55:45 +11002343out:
2344 error_propagate(errp, err);
2345
2346}
2347
2348static void property_release_tm(Object *obj, const char *name,
2349 void *opaque)
2350{
2351 TMProperty *prop = opaque;
2352 g_free(prop);
2353}
2354
Markus Armbruster70251882020-05-05 17:29:14 +02002355ObjectProperty *
2356object_property_add_tm(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002357 void (*get)(Object *, struct tm *, Error **))
David Gibson8e099d12015-02-06 14:55:45 +11002358{
David Gibson8e099d12015-02-06 14:55:45 +11002359 TMProperty *prop = g_malloc0(sizeof(*prop));
2360
2361 prop->get = get;
2362
Markus Armbrusterd2623122020-05-05 17:29:22 +02002363 return object_property_add(obj, name, "struct tm",
2364 get ? property_get_tm : NULL, NULL,
2365 property_release_tm,
2366 prop);
David Gibson8e099d12015-02-06 14:55:45 +11002367}
2368
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002369ObjectProperty *
2370object_class_property_add_tm(ObjectClass *klass, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002371 void (*get)(Object *, struct tm *, Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002372{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002373 TMProperty *prop = g_malloc0(sizeof(*prop));
2374
2375 prop->get = get;
2376
Markus Armbrusterd2623122020-05-05 17:29:22 +02002377 return object_class_property_add(klass, name, "struct tm",
2378 get ? property_get_tm : NULL,
2379 NULL, NULL, prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002380}
2381
Markus Armbruster90c69fb2020-07-07 18:05:50 +02002382static char *object_get_type(Object *obj, Error **errp)
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002383{
2384 return g_strdup(object_get_typename(obj));
2385}
2386
Eric Blaked7bce992016-01-29 06:48:55 -07002387static void property_get_uint8_ptr(Object *obj, Visitor *v, const char *name,
2388 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002389{
2390 uint8_t value = *(uint8_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002391 visit_type_uint8(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002392}
2393
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002394static void property_set_uint8_ptr(Object *obj, Visitor *v, const char *name,
2395 void *opaque, Error **errp)
2396{
2397 uint8_t *field = opaque;
2398 uint8_t value;
2399 Error *local_err = NULL;
2400
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002401 if (!visit_type_uint8(v, name, &value, &local_err)) {
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002402 error_propagate(errp, local_err);
2403 return;
2404 }
2405
2406 *field = value;
2407}
2408
Eric Blaked7bce992016-01-29 06:48:55 -07002409static void property_get_uint16_ptr(Object *obj, Visitor *v, const char *name,
2410 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002411{
2412 uint16_t value = *(uint16_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002413 visit_type_uint16(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002414}
2415
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002416static void property_set_uint16_ptr(Object *obj, Visitor *v, const char *name,
2417 void *opaque, Error **errp)
2418{
2419 uint16_t *field = opaque;
2420 uint16_t value;
2421 Error *local_err = NULL;
2422
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002423 if (!visit_type_uint16(v, name, &value, &local_err)) {
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002424 error_propagate(errp, local_err);
2425 return;
2426 }
2427
2428 *field = value;
2429}
2430
Eric Blaked7bce992016-01-29 06:48:55 -07002431static void property_get_uint32_ptr(Object *obj, Visitor *v, const char *name,
2432 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002433{
2434 uint32_t value = *(uint32_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002435 visit_type_uint32(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002436}
2437
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002438static void property_set_uint32_ptr(Object *obj, Visitor *v, const char *name,
2439 void *opaque, Error **errp)
2440{
2441 uint32_t *field = opaque;
2442 uint32_t value;
2443 Error *local_err = NULL;
2444
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002445 if (!visit_type_uint32(v, name, &value, &local_err)) {
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002446 error_propagate(errp, local_err);
2447 return;
2448 }
2449
2450 *field = value;
2451}
2452
Eric Blaked7bce992016-01-29 06:48:55 -07002453static void property_get_uint64_ptr(Object *obj, Visitor *v, const char *name,
2454 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002455{
2456 uint64_t value = *(uint64_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002457 visit_type_uint64(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002458}
2459
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002460static void property_set_uint64_ptr(Object *obj, Visitor *v, const char *name,
2461 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002462{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002463 uint64_t *field = opaque;
2464 uint64_t value;
2465 Error *local_err = NULL;
2466
Markus Armbruster62a35aa2020-07-07 18:05:46 +02002467 if (!visit_type_uint64(v, name, &value, &local_err)) {
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002468 error_propagate(errp, local_err);
2469 return;
2470 }
2471
2472 *field = value;
2473}
2474
Markus Armbruster70251882020-05-05 17:29:14 +02002475ObjectProperty *
2476object_property_add_uint8_ptr(Object *obj, const char *name,
2477 const uint8_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002478 ObjectPropertyFlags flags)
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002479{
2480 ObjectPropertyAccessor *getter = NULL;
2481 ObjectPropertyAccessor *setter = NULL;
2482
2483 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2484 getter = property_get_uint8_ptr;
2485 }
2486
2487 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2488 setter = property_set_uint8_ptr;
2489 }
2490
Markus Armbruster70251882020-05-05 17:29:14 +02002491 return object_property_add(obj, name, "uint8",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002492 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002493}
2494
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002495ObjectProperty *
2496object_class_property_add_uint8_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002497 const uint8_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002498 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002499{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002500 ObjectPropertyAccessor *getter = NULL;
2501 ObjectPropertyAccessor *setter = NULL;
2502
2503 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2504 getter = property_get_uint8_ptr;
2505 }
2506
2507 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2508 setter = property_set_uint8_ptr;
2509 }
2510
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002511 return object_class_property_add(klass, name, "uint8",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002512 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002513}
2514
Markus Armbruster70251882020-05-05 17:29:14 +02002515ObjectProperty *
2516object_property_add_uint16_ptr(Object *obj, const char *name,
2517 const uint16_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002518 ObjectPropertyFlags flags)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002519{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002520 ObjectPropertyAccessor *getter = NULL;
2521 ObjectPropertyAccessor *setter = NULL;
2522
2523 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2524 getter = property_get_uint16_ptr;
2525 }
2526
2527 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2528 setter = property_set_uint16_ptr;
2529 }
2530
Markus Armbruster70251882020-05-05 17:29:14 +02002531 return object_property_add(obj, name, "uint16",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002532 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002533}
2534
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002535ObjectProperty *
2536object_class_property_add_uint16_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002537 const uint16_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002538 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002539{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002540 ObjectPropertyAccessor *getter = NULL;
2541 ObjectPropertyAccessor *setter = NULL;
2542
2543 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2544 getter = property_get_uint16_ptr;
2545 }
2546
2547 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2548 setter = property_set_uint16_ptr;
2549 }
2550
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002551 return object_class_property_add(klass, name, "uint16",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002552 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002553}
2554
Markus Armbruster70251882020-05-05 17:29:14 +02002555ObjectProperty *
2556object_property_add_uint32_ptr(Object *obj, const char *name,
2557 const uint32_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002558 ObjectPropertyFlags flags)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002559{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002560 ObjectPropertyAccessor *getter = NULL;
2561 ObjectPropertyAccessor *setter = NULL;
2562
2563 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2564 getter = property_get_uint32_ptr;
2565 }
2566
2567 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2568 setter = property_set_uint32_ptr;
2569 }
2570
Markus Armbruster70251882020-05-05 17:29:14 +02002571 return object_property_add(obj, name, "uint32",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002572 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002573}
2574
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002575ObjectProperty *
2576object_class_property_add_uint32_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002577 const uint32_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002578 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002579{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002580 ObjectPropertyAccessor *getter = NULL;
2581 ObjectPropertyAccessor *setter = NULL;
2582
2583 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2584 getter = property_get_uint32_ptr;
2585 }
2586
2587 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2588 setter = property_set_uint32_ptr;
2589 }
2590
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002591 return object_class_property_add(klass, name, "uint32",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002592 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002593}
2594
Markus Armbruster70251882020-05-05 17:29:14 +02002595ObjectProperty *
2596object_property_add_uint64_ptr(Object *obj, const char *name,
2597 const uint64_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002598 ObjectPropertyFlags flags)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002599{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002600 ObjectPropertyAccessor *getter = NULL;
2601 ObjectPropertyAccessor *setter = NULL;
2602
2603 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2604 getter = property_get_uint64_ptr;
2605 }
2606
2607 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2608 setter = property_set_uint64_ptr;
2609 }
2610
Markus Armbruster70251882020-05-05 17:29:14 +02002611 return object_property_add(obj, name, "uint64",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002612 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002613}
2614
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002615ObjectProperty *
2616object_class_property_add_uint64_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002617 const uint64_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002618 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002619{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002620 ObjectPropertyAccessor *getter = NULL;
2621 ObjectPropertyAccessor *setter = NULL;
2622
2623 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2624 getter = property_get_uint64_ptr;
2625 }
2626
2627 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2628 setter = property_set_uint64_ptr;
2629 }
2630
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002631 return object_class_property_add(klass, name, "uint64",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002632 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002633}
2634
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002635typedef struct {
2636 Object *target_obj;
Eduardo Habkost1590d262015-04-09 16:57:29 -03002637 char *target_name;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002638} AliasProperty;
2639
Eric Blaked7bce992016-01-29 06:48:55 -07002640static void property_get_alias(Object *obj, Visitor *v, const char *name,
2641 void *opaque, Error **errp)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002642{
2643 AliasProperty *prop = opaque;
2644
2645 object_property_get(prop->target_obj, v, prop->target_name, errp);
2646}
2647
Eric Blaked7bce992016-01-29 06:48:55 -07002648static void property_set_alias(Object *obj, Visitor *v, const char *name,
2649 void *opaque, Error **errp)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002650{
2651 AliasProperty *prop = opaque;
2652
2653 object_property_set(prop->target_obj, v, prop->target_name, errp);
2654}
2655
Paolo Bonzini64607d02014-06-05 13:11:51 +02002656static Object *property_resolve_alias(Object *obj, void *opaque,
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02002657 const char *part)
Paolo Bonzini64607d02014-06-05 13:11:51 +02002658{
2659 AliasProperty *prop = opaque;
2660
2661 return object_resolve_path_component(prop->target_obj, prop->target_name);
2662}
2663
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002664static void property_release_alias(Object *obj, const char *name, void *opaque)
2665{
2666 AliasProperty *prop = opaque;
2667
Eduardo Habkost1590d262015-04-09 16:57:29 -03002668 g_free(prop->target_name);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002669 g_free(prop);
2670}
2671
Markus Armbruster70251882020-05-05 17:29:14 +02002672ObjectProperty *
2673object_property_add_alias(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002674 Object *target_obj, const char *target_name)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002675{
2676 AliasProperty *prop;
Paolo Bonzini64607d02014-06-05 13:11:51 +02002677 ObjectProperty *op;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002678 ObjectProperty *target_prop;
Markus Armbruster70251882020-05-05 17:29:14 +02002679 g_autofree char *prop_type = NULL;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002680
Markus Armbrusterd2623122020-05-05 17:29:22 +02002681 target_prop = object_property_find(target_obj, target_name,
2682 &error_abort);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002683
Paolo Bonzinid1906982014-06-10 11:17:35 +02002684 if (object_property_is_child(target_prop)) {
2685 prop_type = g_strdup_printf("link%s",
2686 target_prop->type + strlen("child"));
2687 } else {
2688 prop_type = g_strdup(target_prop->type);
2689 }
2690
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002691 prop = g_malloc(sizeof(*prop));
2692 prop->target_obj = target_obj;
Eduardo Habkost1590d262015-04-09 16:57:29 -03002693 prop->target_name = g_strdup(target_name);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002694
Paolo Bonzinid1906982014-06-10 11:17:35 +02002695 op = object_property_add(obj, name, prop_type,
Paolo Bonzini64607d02014-06-05 13:11:51 +02002696 property_get_alias,
2697 property_set_alias,
2698 property_release_alias,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002699 prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02002700 op->resolve = property_resolve_alias;
Marc-André Lureau0e76ed02020-01-10 19:30:23 +04002701 if (target_prop->defval) {
2702 op->defval = qobject_ref(target_prop->defval);
2703 }
Paolo Bonzinid1906982014-06-10 11:17:35 +02002704
Andreas Färbera18bb412015-03-27 17:34:10 +01002705 object_property_set_description(obj, op->name,
Markus Armbruster7eecec72020-05-05 17:29:15 +02002706 target_prop->description);
Markus Armbruster70251882020-05-05 17:29:14 +02002707 return op;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002708}
2709
Gonglei80742642014-10-07 14:33:21 +08002710void object_property_set_description(Object *obj, const char *name,
Markus Armbruster7eecec72020-05-05 17:29:15 +02002711 const char *description)
Gonglei80742642014-10-07 14:33:21 +08002712{
2713 ObjectProperty *op;
2714
Markus Armbruster7eecec72020-05-05 17:29:15 +02002715 op = object_property_find(obj, name, &error_abort);
Gonglei80742642014-10-07 14:33:21 +08002716 g_free(op->description);
2717 op->description = g_strdup(description);
2718}
2719
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002720void object_class_property_set_description(ObjectClass *klass,
2721 const char *name,
Markus Armbruster7eecec72020-05-05 17:29:15 +02002722 const char *description)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002723{
2724 ObjectProperty *op;
2725
2726 op = g_hash_table_lookup(klass->properties, name);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002727 g_free(op->description);
2728 op->description = g_strdup(description);
2729}
2730
Marc-André Lureau7439a032018-09-06 18:09:32 +04002731static void object_class_init(ObjectClass *klass, void *data)
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002732{
Markus Armbruster90c69fb2020-07-07 18:05:50 +02002733 object_class_property_add_str(klass, "type", object_get_type,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002734 NULL);
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002735}
2736
Paolo Bonzini745549c2012-03-31 16:45:54 +02002737static void register_types(void)
2738{
2739 static TypeInfo interface_info = {
2740 .name = TYPE_INTERFACE,
Anthony Liguori33e95c62012-08-10 13:16:10 +10002741 .class_size = sizeof(InterfaceClass),
Paolo Bonzini745549c2012-03-31 16:45:54 +02002742 .abstract = true,
2743 };
2744
2745 static TypeInfo object_info = {
2746 .name = TYPE_OBJECT,
2747 .instance_size = sizeof(Object),
Marc-André Lureau7439a032018-09-06 18:09:32 +04002748 .class_init = object_class_init,
Paolo Bonzini745549c2012-03-31 16:45:54 +02002749 .abstract = true,
2750 };
2751
Paolo Bonzini049cb3c2012-04-04 15:58:40 +02002752 type_interface = type_register_internal(&interface_info);
2753 type_register_internal(&object_info);
Paolo Bonzini745549c2012-03-31 16:45:54 +02002754}
2755
2756type_init(register_types)