blob: a4094a6bb54b13f474a192fb7329f08345ee5847 [file] [log] [blame]
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001/*
2 * QEMU Object Model
3 *
4 * Copyright IBM, Corp. 2011
5 *
6 * Authors:
7 * Anthony Liguori <aliguori@us.ibm.com>
8 *
9 * This work is licensed under the terms of the GNU GPL, version 2 or later.
10 * See the COPYING file in the top-level directory.
11 */
12
Peter Maydell9bbc8532016-01-29 17:50:02 +000013#include "qemu/osdep.h"
Markus Armbruster13d4ff02019-08-12 07:23:37 +020014#include "hw/qdev-core.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010015#include "qapi/error.h"
Paolo Bonzini14cccb62012-12-17 18:19:50 +010016#include "qom/object.h"
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +010017#include "qom/object_interfaces.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020018#include "qemu/cutils.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010019#include "qapi/visitor.h"
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +010020#include "qapi/string-input-visitor.h"
21#include "qapi/string-output-visitor.h"
Marc-André Lureau0e76ed02020-01-10 19:30:23 +040022#include "qapi/qobject-input-visitor.h"
Markus Armbrustereb815e22018-02-11 10:36:05 +010023#include "qapi/qapi-builtin-visit.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010024#include "qapi/qmp/qerror.h"
Marc-André Lureau0e76ed02020-01-10 19:30:23 +040025#include "qapi/qmp/qjson.h"
Paolo Bonzinifa131d92013-05-10 14:16:39 +020026#include "trace.h"
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060027
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +010028/* TODO: replace QObject with a simpler visitor to avoid a dependency
29 * of the QOM core on QObject? */
Paolo Bonzini14cccb62012-12-17 18:19:50 +010030#include "qom/qom-qobject.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010031#include "qapi/qmp/qbool.h"
Markus Armbruster15280c32018-02-01 12:18:36 +010032#include "qapi/qmp/qnum.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010033#include "qapi/qmp/qstring.h"
Philippe Mathieu-Daudée02bdf12019-04-27 15:56:42 +020034#include "qemu/error-report.h"
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +010035
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060036#define MAX_INTERFACES 32
37
38typedef struct InterfaceImpl InterfaceImpl;
39typedef struct TypeImpl TypeImpl;
40
41struct InterfaceImpl
42{
Anthony Liguori33e95c62012-08-10 13:16:10 +100043 const char *typename;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060044};
45
46struct TypeImpl
47{
48 const char *name;
49
50 size_t class_size;
51
52 size_t instance_size;
53
54 void (*class_init)(ObjectClass *klass, void *data);
Paolo Bonzini3b50e312012-05-02 13:30:55 +020055 void (*class_base_init)(ObjectClass *klass, void *data);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060056
57 void *class_data;
58
59 void (*instance_init)(Object *obj);
Eduardo Habkost8231c2d2013-07-10 17:08:41 -030060 void (*instance_post_init)(Object *obj);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060061 void (*instance_finalize)(Object *obj);
62
63 bool abstract;
64
65 const char *parent;
66 TypeImpl *parent_type;
67
68 ObjectClass *class;
69
70 int num_interfaces;
71 InterfaceImpl interfaces[MAX_INTERFACES];
72};
73
Paolo Bonzini9970bd82012-02-03 11:51:39 +010074static Type type_interface;
75
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060076static GHashTable *type_table_get(void)
77{
78 static GHashTable *type_table;
79
80 if (type_table == NULL) {
81 type_table = g_hash_table_new(g_str_hash, g_str_equal);
82 }
83
84 return type_table;
85}
86
Hervé Poussineauf54c19c2013-12-03 16:42:00 +010087static bool enumerating_types;
88
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060089static void type_table_add(TypeImpl *ti)
90{
Hervé Poussineauf54c19c2013-12-03 16:42:00 +010091 assert(!enumerating_types);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060092 g_hash_table_insert(type_table_get(), (void *)ti->name, ti);
93}
94
95static TypeImpl *type_table_lookup(const char *name)
96{
97 return g_hash_table_lookup(type_table_get(), name);
98}
99
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100100static TypeImpl *type_new(const TypeInfo *info)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600101{
102 TypeImpl *ti = g_malloc0(sizeof(*ti));
Anthony Liguori33e95c62012-08-10 13:16:10 +1000103 int i;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600104
105 g_assert(info->name != NULL);
106
Anthony Liguori73093352012-01-25 13:37:36 -0600107 if (type_table_lookup(info->name) != NULL) {
108 fprintf(stderr, "Registering `%s' which already exists\n", info->name);
109 abort();
110 }
111
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600112 ti->name = g_strdup(info->name);
113 ti->parent = g_strdup(info->parent);
114
115 ti->class_size = info->class_size;
116 ti->instance_size = info->instance_size;
117
118 ti->class_init = info->class_init;
Paolo Bonzini3b50e312012-05-02 13:30:55 +0200119 ti->class_base_init = info->class_base_init;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600120 ti->class_data = info->class_data;
121
122 ti->instance_init = info->instance_init;
Eduardo Habkost8231c2d2013-07-10 17:08:41 -0300123 ti->instance_post_init = info->instance_post_init;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600124 ti->instance_finalize = info->instance_finalize;
125
126 ti->abstract = info->abstract;
127
Anthony Liguori33e95c62012-08-10 13:16:10 +1000128 for (i = 0; info->interfaces && info->interfaces[i].type; i++) {
129 ti->interfaces[i].typename = g_strdup(info->interfaces[i].type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600130 }
Anthony Liguori33e95c62012-08-10 13:16:10 +1000131 ti->num_interfaces = i;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600132
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100133 return ti;
134}
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600135
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100136static TypeImpl *type_register_internal(const TypeInfo *info)
137{
138 TypeImpl *ti;
139 ti = type_new(info);
140
141 type_table_add(ti);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600142 return ti;
143}
144
Paolo Bonzini049cb3c2012-04-04 15:58:40 +0200145TypeImpl *type_register(const TypeInfo *info)
146{
147 assert(info->parent);
148 return type_register_internal(info);
149}
150
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600151TypeImpl *type_register_static(const TypeInfo *info)
152{
153 return type_register(info);
154}
155
Igor Mammedovaa04c9d22017-10-09 21:50:49 +0200156void type_register_static_array(const TypeInfo *infos, int nr_infos)
157{
158 int i;
159
160 for (i = 0; i < nr_infos; i++) {
161 type_register_static(&infos[i]);
162 }
163}
164
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600165static TypeImpl *type_get_by_name(const char *name)
166{
167 if (name == NULL) {
168 return NULL;
169 }
170
171 return type_table_lookup(name);
172}
173
174static TypeImpl *type_get_parent(TypeImpl *type)
175{
176 if (!type->parent_type && type->parent) {
177 type->parent_type = type_get_by_name(type->parent);
Philippe Mathieu-Daudé89d337f2020-01-21 12:03:45 +0100178 if (!type->parent_type) {
179 fprintf(stderr, "Type '%s' is missing its parent '%s'\n",
180 type->name, type->parent);
181 abort();
182 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600183 }
184
185 return type->parent_type;
186}
187
188static bool type_has_parent(TypeImpl *type)
189{
190 return (type->parent != NULL);
191}
192
193static size_t type_class_get_size(TypeImpl *ti)
194{
195 if (ti->class_size) {
196 return ti->class_size;
197 }
198
199 if (type_has_parent(ti)) {
200 return type_class_get_size(type_get_parent(ti));
201 }
202
203 return sizeof(ObjectClass);
204}
205
Igor Mitsyankoaca59af2012-02-28 15:57:10 +0400206static size_t type_object_get_size(TypeImpl *ti)
207{
208 if (ti->instance_size) {
209 return ti->instance_size;
210 }
211
212 if (type_has_parent(ti)) {
213 return type_object_get_size(type_get_parent(ti));
214 }
215
216 return 0;
217}
218
Bharata B Rao3f97b532016-06-10 06:29:00 +0530219size_t object_type_get_instance_size(const char *typename)
220{
221 TypeImpl *type = type_get_by_name(typename);
222
223 g_assert(type != NULL);
224 return type_object_get_size(type);
225}
226
Anthony Liguori33e95c62012-08-10 13:16:10 +1000227static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600228{
Anthony Liguori33e95c62012-08-10 13:16:10 +1000229 assert(target_type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600230
Cao jinb30d8052015-11-03 10:36:42 +0800231 /* Check if target_type is a direct ancestor of type */
Anthony Liguori33e95c62012-08-10 13:16:10 +1000232 while (type) {
233 if (type == target_type) {
234 return true;
235 }
236
237 type = type_get_parent(type);
238 }
239
240 return false;
241}
242
243static void type_initialize(TypeImpl *ti);
244
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100245static void type_initialize_interface(TypeImpl *ti, TypeImpl *interface_type,
246 TypeImpl *parent_type)
Anthony Liguori33e95c62012-08-10 13:16:10 +1000247{
248 InterfaceClass *new_iface;
249 TypeInfo info = { };
250 TypeImpl *iface_impl;
251
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100252 info.parent = parent_type->name;
253 info.name = g_strdup_printf("%s::%s", ti->name, interface_type->name);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000254 info.abstract = true;
255
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100256 iface_impl = type_new(&info);
257 iface_impl->parent_type = parent_type;
Anthony Liguori33e95c62012-08-10 13:16:10 +1000258 type_initialize(iface_impl);
259 g_free((char *)info.name);
260
261 new_iface = (InterfaceClass *)iface_impl->class;
262 new_iface->concrete_class = ti->class;
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100263 new_iface->interface_type = interface_type;
Anthony Liguori33e95c62012-08-10 13:16:10 +1000264
265 ti->class->interfaces = g_slist_append(ti->class->interfaces,
266 iface_impl->class);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600267}
268
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +0100269static void object_property_free(gpointer data)
270{
271 ObjectProperty *prop = data;
272
Marc-André Lureau0e76ed02020-01-10 19:30:23 +0400273 if (prop->defval) {
274 qobject_unref(prop->defval);
275 prop->defval = NULL;
276 }
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +0100277 g_free(prop->name);
278 g_free(prop->type);
279 g_free(prop->description);
280 g_free(prop);
281}
282
Igor Mitsyankoac451032012-02-28 15:57:11 +0400283static void type_initialize(TypeImpl *ti)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600284{
Paolo Bonzini745549c2012-03-31 16:45:54 +0200285 TypeImpl *parent;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600286
287 if (ti->class) {
288 return;
289 }
290
291 ti->class_size = type_class_get_size(ti);
Igor Mitsyankoaca59af2012-02-28 15:57:10 +0400292 ti->instance_size = type_object_get_size(ti);
Eduardo Habkost1c6d75d2016-12-12 16:31:01 -0200293 /* Any type with zero instance_size is implicitly abstract.
294 * This means interface types are all abstract.
295 */
296 if (ti->instance_size == 0) {
297 ti->abstract = true;
298 }
Marc-André Lureau422ca142018-09-12 16:53:03 +0400299 if (type_is_ancestor(ti, type_interface)) {
300 assert(ti->instance_size == 0);
301 assert(ti->abstract);
302 assert(!ti->instance_init);
303 assert(!ti->instance_post_init);
304 assert(!ti->instance_finalize);
305 assert(!ti->num_interfaces);
306 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600307 ti->class = g_malloc0(ti->class_size);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600308
Paolo Bonzini745549c2012-03-31 16:45:54 +0200309 parent = type_get_parent(ti);
310 if (parent) {
Igor Mitsyankoac451032012-02-28 15:57:11 +0400311 type_initialize(parent);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000312 GSList *e;
313 int i;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600314
Markus Armbruster719a3072018-06-08 19:02:31 +0200315 g_assert(parent->class_size <= ti->class_size);
Marc-André Lureaud5e633f2020-01-10 19:30:14 +0400316 g_assert(parent->instance_size <= ti->instance_size);
Paolo Bonzini745549c2012-03-31 16:45:54 +0200317 memcpy(ti->class, parent->class, parent->class_size);
Peter Crosthwaite3e407de2013-02-19 14:02:09 +1000318 ti->class->interfaces = NULL;
Anthony Liguori33e95c62012-08-10 13:16:10 +1000319
320 for (e = parent->class->interfaces; e; e = e->next) {
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100321 InterfaceClass *iface = e->data;
322 ObjectClass *klass = OBJECT_CLASS(iface);
323
324 type_initialize_interface(ti, iface->interface_type, klass->type);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000325 }
326
327 for (i = 0; i < ti->num_interfaces; i++) {
328 TypeImpl *t = type_get_by_name(ti->interfaces[i].typename);
Philippe Mathieu-Daudéa9ee3a92020-01-18 17:23:48 +0100329 if (!t) {
330 error_report("missing interface '%s' for object '%s'",
331 ti->interfaces[i].typename, parent->name);
332 abort();
333 }
Anthony Liguori33e95c62012-08-10 13:16:10 +1000334 for (e = ti->class->interfaces; e; e = e->next) {
335 TypeImpl *target_type = OBJECT_CLASS(e->data)->type;
336
337 if (type_is_ancestor(target_type, t)) {
338 break;
339 }
340 }
341
342 if (e) {
343 continue;
344 }
345
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100346 type_initialize_interface(ti, t, t);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000347 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600348 }
349
Masahiro Yamadae5a0cc52020-05-13 02:26:15 +0900350 ti->class->properties = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
351 object_property_free);
352
Paolo Bonzini745549c2012-03-31 16:45:54 +0200353 ti->class->type = ti;
354
355 while (parent) {
356 if (parent->class_base_init) {
357 parent->class_base_init(ti->class, ti->class_data);
358 }
359 parent = type_get_parent(parent);
360 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600361
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600362 if (ti->class_init) {
363 ti->class_init(ti->class, ti->class_data);
364 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600365}
366
367static void object_init_with_type(Object *obj, TypeImpl *ti)
368{
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600369 if (type_has_parent(ti)) {
370 object_init_with_type(obj, type_get_parent(ti));
371 }
372
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600373 if (ti->instance_init) {
374 ti->instance_init(obj);
375 }
376}
377
Eduardo Habkost8231c2d2013-07-10 17:08:41 -0300378static void object_post_init_with_type(Object *obj, TypeImpl *ti)
379{
380 if (ti->instance_post_init) {
381 ti->instance_post_init(obj);
382 }
383
384 if (type_has_parent(ti)) {
385 object_post_init_with_type(obj, type_get_parent(ti));
386 }
387}
388
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400389void object_apply_global_props(Object *obj, const GPtrArray *props, Error **errp)
390{
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400391 int i;
392
393 if (!props) {
394 return;
395 }
396
397 for (i = 0; i < props->len; i++) {
398 GlobalProperty *p = g_ptr_array_index(props, i);
Eduardo Habkostd769f0d2019-01-10 00:02:57 -0200399 Error *err = NULL;
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400400
401 if (object_dynamic_cast(obj, p->driver) == NULL) {
402 continue;
403 }
Dr. David Alan Gilbert92fd4532019-07-29 17:29:02 +0100404 if (p->optional && !object_property_find(obj, p->property, NULL)) {
405 continue;
406 }
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400407 p->used = true;
408 object_property_parse(obj, p->value, p->property, &err);
409 if (err != NULL) {
410 error_prepend(&err, "can't apply global %s.%s=%s: ",
411 p->driver, p->property, p->value);
Marc-André Lureau50545b22018-11-07 15:35:34 +0400412 /*
413 * If errp != NULL, propagate error and return.
414 * If errp == NULL, report a warning, but keep going
415 * with the remaining globals.
416 */
417 if (errp) {
418 error_propagate(errp, err);
419 return;
420 } else {
421 warn_report_err(err);
422 }
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400423 }
424 }
425}
426
Markus Armbruster617902a2019-03-08 14:14:35 +0100427/*
428 * Global property defaults
429 * Slot 0: accelerator's global property defaults
430 * Slot 1: machine's global property defaults
Paolo Bonzini1fff3c22019-11-13 13:33:44 +0100431 * Slot 2: global properties from legacy command line option
Markus Armbruster617902a2019-03-08 14:14:35 +0100432 * Each is a GPtrArray of of GlobalProperty.
433 * Applied in order, later entries override earlier ones.
434 */
Paolo Bonzini1fff3c22019-11-13 13:33:44 +0100435static GPtrArray *object_compat_props[3];
436
437/*
438 * Retrieve @GPtrArray for global property defined with options
439 * other than "-global". These are generally used for syntactic
440 * sugar and legacy command line options.
441 */
442void object_register_sugar_prop(const char *driver, const char *prop, const char *value)
443{
444 GlobalProperty *g;
445 if (!object_compat_props[2]) {
446 object_compat_props[2] = g_ptr_array_new();
447 }
448 g = g_new0(GlobalProperty, 1);
449 g->driver = g_strdup(driver);
450 g->property = g_strdup(prop);
451 g->value = g_strdup(value);
452 g_ptr_array_add(object_compat_props[2], g);
453}
Markus Armbruster617902a2019-03-08 14:14:35 +0100454
455/*
456 * Set machine's global property defaults to @compat_props.
457 * May be called at most once.
458 */
459void object_set_machine_compat_props(GPtrArray *compat_props)
460{
461 assert(!object_compat_props[1]);
462 object_compat_props[1] = compat_props;
463}
464
465/*
466 * Set accelerator's global property defaults to @compat_props.
467 * May be called at most once.
468 */
469void object_set_accelerator_compat_props(GPtrArray *compat_props)
470{
471 assert(!object_compat_props[0]);
472 object_compat_props[0] = compat_props;
473}
474
475void object_apply_compat_props(Object *obj)
476{
477 int i;
478
479 for (i = 0; i < ARRAY_SIZE(object_compat_props); i++) {
480 object_apply_global_props(obj, object_compat_props[i],
Paolo Bonzini1fff3c22019-11-13 13:33:44 +0100481 i == 2 ? &error_fatal : &error_abort);
Markus Armbruster617902a2019-03-08 14:14:35 +0100482 }
483}
484
Marc-André Lureau2a1be4b2020-01-10 19:30:19 +0400485static void object_class_property_init_all(Object *obj)
486{
487 ObjectPropertyIterator iter;
488 ObjectProperty *prop;
489
490 object_class_property_iter_init(&iter, object_get_class(obj));
491 while ((prop = object_property_iter_next(&iter))) {
492 if (prop->init) {
493 prop->init(obj, prop);
494 }
495 }
496}
497
Marc-André Lureau63f7b102016-12-12 20:31:51 +0300498static void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600499{
500 Object *obj = data;
501
Igor Mitsyankoac451032012-02-28 15:57:11 +0400502 type_initialize(type);
Igor Mitsyankoaca59af2012-02-28 15:57:10 +0400503
Markus Armbruster719a3072018-06-08 19:02:31 +0200504 g_assert(type->instance_size >= sizeof(Object));
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600505 g_assert(type->abstract == false);
Markus Armbruster719a3072018-06-08 19:02:31 +0200506 g_assert(size >= type->instance_size);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600507
508 memset(obj, 0, type->instance_size);
509 obj->class = type->class;
Paolo Bonzini764b6312012-11-23 09:47:12 +0100510 object_ref(obj);
Marc-André Lureau2a1be4b2020-01-10 19:30:19 +0400511 object_class_property_init_all(obj);
Pavel Fedinb604a852015-10-13 13:37:45 +0100512 obj->properties = g_hash_table_new_full(g_str_hash, g_str_equal,
513 NULL, object_property_free);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600514 object_init_with_type(obj, type);
Eduardo Habkost8231c2d2013-07-10 17:08:41 -0300515 object_post_init_with_type(obj, type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600516}
517
Andreas Färber213f0c42013-08-23 19:37:12 +0200518void object_initialize(void *data, size_t size, const char *typename)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600519{
520 TypeImpl *type = type_get_by_name(typename);
521
Philippe Mathieu-Daudée02bdf12019-04-27 15:56:42 +0200522 if (!type) {
523 error_report("missing object type '%s'", typename);
524 abort();
525 }
526
Andreas Färber5b9237f2013-08-30 18:28:37 +0200527 object_initialize_with_type(data, size, type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600528}
529
Thomas Huth0210b392018-07-16 14:59:18 +0200530void object_initialize_child(Object *parentobj, const char *propname,
531 void *childobj, size_t size, const char *type,
532 Error **errp, ...)
533{
534 va_list vargs;
535
536 va_start(vargs, errp);
537 object_initialize_childv(parentobj, propname, childobj, size, type, errp,
538 vargs);
539 va_end(vargs);
540}
541
542void object_initialize_childv(Object *parentobj, const char *propname,
543 void *childobj, size_t size, const char *type,
544 Error **errp, va_list vargs)
545{
546 Error *local_err = NULL;
547 Object *obj;
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400548 UserCreatable *uc;
Thomas Huth0210b392018-07-16 14:59:18 +0200549
550 object_initialize(childobj, size, type);
551 obj = OBJECT(childobj);
552
553 object_set_propv(obj, &local_err, vargs);
554 if (local_err) {
555 goto out;
556 }
557
Markus Armbrusterd2623122020-05-05 17:29:22 +0200558 object_property_add_child(parentobj, propname, obj);
Thomas Huth0210b392018-07-16 14:59:18 +0200559
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400560 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
561 if (uc) {
562 user_creatable_complete(uc, &local_err);
Thomas Huth0210b392018-07-16 14:59:18 +0200563 if (local_err) {
564 object_unparent(obj);
565 goto out;
566 }
567 }
568
Markus Armbruster975ac452020-05-05 17:29:09 +0200569out:
Thomas Huth0210b392018-07-16 14:59:18 +0200570 /*
Markus Armbruster975ac452020-05-05 17:29:09 +0200571 * We want @obj's reference to be 1 on success, 0 on failure.
572 * On success, it's 2: one taken by object_initialize(), and one
573 * by object_property_add_child().
574 * On failure in object_initialize() or earlier, it's 1.
575 * On failure afterwards, it's also 1: object_unparent() releases
576 * the reference taken by object_property_add_child().
Thomas Huth0210b392018-07-16 14:59:18 +0200577 */
578 object_unref(obj);
579
Markus Armbruster975ac452020-05-05 17:29:09 +0200580 error_propagate(errp, local_err);
Thomas Huth0210b392018-07-16 14:59:18 +0200581}
582
Andreas Färber5d9d3f42012-05-27 00:32:40 +0200583static inline bool object_property_is_child(ObjectProperty *prop)
584{
585 return strstart(prop->type, "child<", NULL);
586}
587
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600588static void object_property_del_all(Object *obj)
589{
Marc-André Lureau9859fac2020-01-10 19:30:30 +0400590 g_autoptr(GHashTable) done = g_hash_table_new(NULL, NULL);
Pavel Fedinb604a852015-10-13 13:37:45 +0100591 ObjectProperty *prop;
Marc-André Lureau9859fac2020-01-10 19:30:30 +0400592 ObjectPropertyIterator iter;
Pavel Fedinb604a852015-10-13 13:37:45 +0100593 bool released;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600594
Pavel Fedinb604a852015-10-13 13:37:45 +0100595 do {
596 released = false;
Marc-André Lureau9859fac2020-01-10 19:30:30 +0400597 object_property_iter_init(&iter, obj);
598 while ((prop = object_property_iter_next(&iter)) != NULL) {
599 if (g_hash_table_add(done, prop)) {
600 if (prop->release) {
601 prop->release(obj, prop->name, prop->opaque);
602 released = true;
603 break;
604 }
Pavel Fedinb604a852015-10-13 13:37:45 +0100605 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600606 }
Pavel Fedinb604a852015-10-13 13:37:45 +0100607 } while (released);
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600608
Pavel Fedinb604a852015-10-13 13:37:45 +0100609 g_hash_table_unref(obj->properties);
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600610}
611
Markus Armbrusterf73a32a2020-05-05 17:29:11 +0200612static void object_property_del_child(Object *obj, Object *child)
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600613{
614 ObjectProperty *prop;
Pavel Fedinb604a852015-10-13 13:37:45 +0100615 GHashTableIter iter;
616 gpointer key, value;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600617
Pavel Fedinb604a852015-10-13 13:37:45 +0100618 g_hash_table_iter_init(&iter, obj->properties);
619 while (g_hash_table_iter_next(&iter, &key, &value)) {
620 prop = value;
Andreas Färber5d9d3f42012-05-27 00:32:40 +0200621 if (object_property_is_child(prop) && prop->opaque == child) {
Pavel Fedinb604a852015-10-13 13:37:45 +0100622 if (prop->release) {
623 prop->release(obj, prop->name, prop->opaque);
624 prop->release = NULL;
625 }
626 break;
627 }
628 }
629 g_hash_table_iter_init(&iter, obj->properties);
630 while (g_hash_table_iter_next(&iter, &key, &value)) {
631 prop = value;
632 if (object_property_is_child(prop) && prop->opaque == child) {
633 g_hash_table_iter_remove(&iter);
Paolo Bonzini6c1fdcf2012-02-28 09:54:15 +0100634 break;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600635 }
636 }
637}
638
639void object_unparent(Object *obj)
640{
Michael S. Tsirkine998fa82013-03-18 21:01:37 +0200641 if (obj->parent) {
Markus Armbrusterf73a32a2020-05-05 17:29:11 +0200642 object_property_del_child(obj->parent, obj);
Michael S. Tsirkine998fa82013-03-18 21:01:37 +0200643 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600644}
645
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600646static void object_deinit(Object *obj, TypeImpl *type)
647{
648 if (type->instance_finalize) {
649 type->instance_finalize(obj);
650 }
651
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600652 if (type_has_parent(type)) {
653 object_deinit(obj, type_get_parent(type));
654 }
655}
656
Paolo Bonzini339c2702012-11-23 09:47:16 +0100657static void object_finalize(void *data)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600658{
659 Object *obj = data;
660 TypeImpl *ti = obj->class->type;
661
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600662 object_property_del_all(obj);
Paolo Bonzini76a6e1c2014-06-11 11:58:30 +0200663 object_deinit(obj, ti);
Anthony Liguoridb85b572011-12-23 08:47:39 -0600664
Markus Armbruster719a3072018-06-08 19:02:31 +0200665 g_assert(obj->ref == 0);
Paolo Bonzinifde9bf42012-11-23 09:47:14 +0100666 if (obj->free) {
667 obj->free(obj);
668 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600669}
670
Marc-André Lureau63f7b102016-12-12 20:31:51 +0300671static Object *object_new_with_type(Type type)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600672{
673 Object *obj;
674
675 g_assert(type != NULL);
Igor Mitsyankoac451032012-02-28 15:57:11 +0400676 type_initialize(type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600677
678 obj = g_malloc(type->instance_size);
Andreas Färber5b9237f2013-08-30 18:28:37 +0200679 object_initialize_with_type(obj, type->instance_size, type);
Paolo Bonzinifde9bf42012-11-23 09:47:14 +0100680 obj->free = g_free;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600681
682 return obj;
683}
684
Paolo Bonzini3c75e122019-11-13 13:57:55 +0100685Object *object_new_with_class(ObjectClass *klass)
686{
687 return object_new_with_type(klass->type);
688}
689
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600690Object *object_new(const char *typename)
691{
692 TypeImpl *ti = type_get_by_name(typename);
693
694 return object_new_with_type(ti);
695}
696
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100697
698Object *object_new_with_props(const char *typename,
699 Object *parent,
700 const char *id,
701 Error **errp,
702 ...)
703{
704 va_list vargs;
705 Object *obj;
706
707 va_start(vargs, errp);
708 obj = object_new_with_propv(typename, parent, id, errp, vargs);
709 va_end(vargs);
710
711 return obj;
712}
713
714
715Object *object_new_with_propv(const char *typename,
716 Object *parent,
717 const char *id,
718 Error **errp,
719 va_list vargs)
720{
721 Object *obj;
722 ObjectClass *klass;
723 Error *local_err = NULL;
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400724 UserCreatable *uc;
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100725
726 klass = object_class_by_name(typename);
727 if (!klass) {
728 error_setg(errp, "invalid object type: %s", typename);
729 return NULL;
730 }
731
732 if (object_class_is_abstract(klass)) {
733 error_setg(errp, "object type '%s' is abstract", typename);
734 return NULL;
735 }
Wei Yang66e11552019-03-11 16:32:34 +0800736 obj = object_new_with_type(klass->type);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100737
738 if (object_set_propv(obj, &local_err, vargs) < 0) {
739 goto error;
740 }
741
Daniel P. Berrangé6134d752018-06-15 16:39:35 +0100742 if (id != NULL) {
Markus Armbrusterd2623122020-05-05 17:29:22 +0200743 object_property_add_child(parent, id, obj);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100744 }
745
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400746 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
747 if (uc) {
748 user_creatable_complete(uc, &local_err);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100749 if (local_err) {
Daniel P. Berrangé6134d752018-06-15 16:39:35 +0100750 if (id != NULL) {
751 object_unparent(obj);
752 }
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100753 goto error;
754 }
755 }
756
Philippe Mathieu-Daudé688ffbb2020-05-12 09:00:19 +0200757 object_unref(obj);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100758 return obj;
759
760 error:
Eduardo Habkost621ff942016-06-13 18:57:56 -0300761 error_propagate(errp, local_err);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100762 object_unref(obj);
763 return NULL;
764}
765
766
767int object_set_props(Object *obj,
768 Error **errp,
769 ...)
770{
771 va_list vargs;
772 int ret;
773
774 va_start(vargs, errp);
775 ret = object_set_propv(obj, errp, vargs);
776 va_end(vargs);
777
778 return ret;
779}
780
781
782int object_set_propv(Object *obj,
783 Error **errp,
784 va_list vargs)
785{
786 const char *propname;
787 Error *local_err = NULL;
788
789 propname = va_arg(vargs, char *);
790 while (propname != NULL) {
791 const char *value = va_arg(vargs, char *);
792
793 g_assert(value != NULL);
794 object_property_parse(obj, value, propname, &local_err);
795 if (local_err) {
796 error_propagate(errp, local_err);
797 return -1;
798 }
799 propname = va_arg(vargs, char *);
800 }
801
802 return 0;
803}
804
805
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600806Object *object_dynamic_cast(Object *obj, const char *typename)
807{
Paolo Bonzinib7f43fe2012-11-23 16:56:17 +0100808 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
Paolo Bonziniacc4af32012-02-03 11:57:23 +0100809 return obj;
810 }
811
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600812 return NULL;
813}
814
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200815Object *object_dynamic_cast_assert(Object *obj, const char *typename,
816 const char *file, int line, const char *func)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600817{
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200818 trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
819 typename, file, line, func);
820
Paolo Bonzini3556c232013-05-10 14:16:40 +0200821#ifdef CONFIG_QOM_CAST_DEBUG
Anthony Liguori03587322013-05-13 15:22:24 -0500822 int i;
823 Object *inst;
824
Peter Crosthwaite95916ab2013-05-22 11:19:16 +1000825 for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100826 if (atomic_read(&obj->class->object_cast_cache[i]) == typename) {
Anthony Liguori03587322013-05-13 15:22:24 -0500827 goto out;
828 }
829 }
830
831 inst = object_dynamic_cast(obj, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600832
Paolo Bonzinib7f43fe2012-11-23 16:56:17 +0100833 if (!inst && obj) {
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200834 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
835 file, line, func, obj, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600836 abort();
837 }
838
Paolo Bonzini3556c232013-05-10 14:16:40 +0200839 assert(obj == inst);
Anthony Liguori03587322013-05-13 15:22:24 -0500840
Peter Crosthwaite95916ab2013-05-22 11:19:16 +1000841 if (obj && obj == inst) {
Anthony Liguori03587322013-05-13 15:22:24 -0500842 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100843 atomic_set(&obj->class->object_cast_cache[i - 1],
844 atomic_read(&obj->class->object_cast_cache[i]));
Anthony Liguori03587322013-05-13 15:22:24 -0500845 }
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100846 atomic_set(&obj->class->object_cast_cache[i - 1], typename);
Anthony Liguori03587322013-05-13 15:22:24 -0500847 }
848
849out:
Paolo Bonzini3556c232013-05-10 14:16:40 +0200850#endif
851 return obj;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600852}
853
854ObjectClass *object_class_dynamic_cast(ObjectClass *class,
855 const char *typename)
856{
Anthony Liguori33e95c62012-08-10 13:16:10 +1000857 ObjectClass *ret = NULL;
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200858 TypeImpl *target_type;
859 TypeImpl *type;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600860
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200861 if (!class) {
862 return NULL;
863 }
864
Paolo Bonzini793c96b2013-05-10 14:16:37 +0200865 /* A simple fast path that can trigger a lot for leaf classes. */
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200866 type = class->type;
Paolo Bonzini793c96b2013-05-10 14:16:37 +0200867 if (type->name == typename) {
868 return class;
869 }
870
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200871 target_type = type_get_by_name(typename);
Alexander Graf9ab880b2013-04-30 15:02:16 +0200872 if (!target_type) {
873 /* target class type unknown, so fail the cast */
874 return NULL;
875 }
876
Peter Crosthwaite00e2cea2013-02-19 14:02:10 +1000877 if (type->class->interfaces &&
878 type_is_ancestor(target_type, type_interface)) {
Anthony Liguori33e95c62012-08-10 13:16:10 +1000879 int found = 0;
880 GSList *i;
881
882 for (i = class->interfaces; i; i = i->next) {
883 ObjectClass *target_class = i->data;
884
885 if (type_is_ancestor(target_class->type, target_type)) {
886 ret = target_class;
887 found++;
888 }
889 }
890
891 /* The match was ambiguous, don't allow a cast */
892 if (found > 1) {
893 ret = NULL;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600894 }
Anthony Liguori33e95c62012-08-10 13:16:10 +1000895 } else if (type_is_ancestor(type, target_type)) {
896 ret = class;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600897 }
898
Anthony Liguori33e95c62012-08-10 13:16:10 +1000899 return ret;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600900}
901
902ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200903 const char *typename,
904 const char *file, int line,
905 const char *func)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600906{
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200907 ObjectClass *ret;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600908
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200909 trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)",
910 typename, file, line, func);
911
Anthony Liguori03587322013-05-13 15:22:24 -0500912#ifdef CONFIG_QOM_CAST_DEBUG
913 int i;
914
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000915 for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100916 if (atomic_read(&class->class_cast_cache[i]) == typename) {
Anthony Liguori03587322013-05-13 15:22:24 -0500917 ret = class;
918 goto out;
919 }
920 }
921#else
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000922 if (!class || !class->interfaces) {
Paolo Bonzini3556c232013-05-10 14:16:40 +0200923 return class;
924 }
925#endif
926
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200927 ret = object_class_dynamic_cast(class, typename);
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200928 if (!ret && class) {
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200929 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
930 file, line, func, class, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600931 abort();
932 }
933
Anthony Liguori03587322013-05-13 15:22:24 -0500934#ifdef CONFIG_QOM_CAST_DEBUG
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000935 if (class && ret == class) {
Anthony Liguori03587322013-05-13 15:22:24 -0500936 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100937 atomic_set(&class->class_cast_cache[i - 1],
938 atomic_read(&class->class_cast_cache[i]));
Anthony Liguori03587322013-05-13 15:22:24 -0500939 }
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100940 atomic_set(&class->class_cast_cache[i - 1], typename);
Anthony Liguori03587322013-05-13 15:22:24 -0500941 }
942out:
943#endif
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600944 return ret;
945}
946
Igor Mammedov8f5d58e2017-07-14 10:14:50 +0800947const char *object_get_typename(const Object *obj)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600948{
949 return obj->class->type->name;
950}
951
952ObjectClass *object_get_class(Object *obj)
953{
954 return obj->class;
955}
956
Andreas Färber17862372013-01-23 12:20:18 +0100957bool object_class_is_abstract(ObjectClass *klass)
958{
959 return klass->type->abstract;
960}
961
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600962const char *object_class_get_name(ObjectClass *klass)
963{
964 return klass->type->name;
965}
966
967ObjectClass *object_class_by_name(const char *typename)
968{
969 TypeImpl *type = type_get_by_name(typename);
970
971 if (!type) {
972 return NULL;
973 }
974
Igor Mitsyankoac451032012-02-28 15:57:11 +0400975 type_initialize(type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600976
977 return type->class;
978}
979
Paolo Bonzinie7cce672012-05-02 13:30:54 +0200980ObjectClass *object_class_get_parent(ObjectClass *class)
981{
982 TypeImpl *type = type_get_parent(class->type);
983
984 if (!type) {
985 return NULL;
986 }
987
988 type_initialize(type);
989
990 return type->class;
991}
992
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600993typedef struct OCFData
994{
995 void (*fn)(ObjectClass *klass, void *opaque);
Anthony Liguori93c511a2011-12-22 14:11:53 -0600996 const char *implements_type;
997 bool include_abstract;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600998 void *opaque;
999} OCFData;
1000
1001static void object_class_foreach_tramp(gpointer key, gpointer value,
1002 gpointer opaque)
1003{
1004 OCFData *data = opaque;
1005 TypeImpl *type = value;
Anthony Liguori93c511a2011-12-22 14:11:53 -06001006 ObjectClass *k;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001007
Igor Mitsyankoac451032012-02-28 15:57:11 +04001008 type_initialize(type);
Anthony Liguori93c511a2011-12-22 14:11:53 -06001009 k = type->class;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001010
Anthony Liguori93c511a2011-12-22 14:11:53 -06001011 if (!data->include_abstract && type->abstract) {
1012 return;
1013 }
1014
1015 if (data->implements_type &&
1016 !object_class_dynamic_cast(k, data->implements_type)) {
1017 return;
1018 }
1019
1020 data->fn(k, data->opaque);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001021}
1022
1023void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
Anthony Liguori93c511a2011-12-22 14:11:53 -06001024 const char *implements_type, bool include_abstract,
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001025 void *opaque)
1026{
Anthony Liguori93c511a2011-12-22 14:11:53 -06001027 OCFData data = { fn, implements_type, include_abstract, opaque };
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001028
Hervé Poussineauf54c19c2013-12-03 16:42:00 +01001029 enumerating_types = true;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001030 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
Hervé Poussineauf54c19c2013-12-03 16:42:00 +01001031 enumerating_types = false;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001032}
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001033
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001034static int do_object_child_foreach(Object *obj,
1035 int (*fn)(Object *child, void *opaque),
1036 void *opaque, bool recurse)
Paolo Bonzini32efc532012-04-11 23:30:20 +02001037{
Pavel Fedinb604a852015-10-13 13:37:45 +01001038 GHashTableIter iter;
1039 ObjectProperty *prop;
Paolo Bonzini32efc532012-04-11 23:30:20 +02001040 int ret = 0;
1041
Pavel Fedinb604a852015-10-13 13:37:45 +01001042 g_hash_table_iter_init(&iter, obj->properties);
1043 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Paolo Bonzini32efc532012-04-11 23:30:20 +02001044 if (object_property_is_child(prop)) {
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001045 Object *child = prop->opaque;
1046
1047 ret = fn(child, opaque);
Paolo Bonzini32efc532012-04-11 23:30:20 +02001048 if (ret != 0) {
1049 break;
1050 }
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001051 if (recurse) {
Cédric Le Goater4a391812020-04-04 17:33:40 +02001052 ret = do_object_child_foreach(child, fn, opaque, true);
1053 if (ret != 0) {
1054 break;
1055 }
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001056 }
Paolo Bonzini32efc532012-04-11 23:30:20 +02001057 }
1058 }
1059 return ret;
1060}
1061
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001062int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
1063 void *opaque)
1064{
1065 return do_object_child_foreach(obj, fn, opaque, false);
1066}
1067
1068int object_child_foreach_recursive(Object *obj,
1069 int (*fn)(Object *child, void *opaque),
1070 void *opaque)
1071{
1072 return do_object_child_foreach(obj, fn, opaque, true);
1073}
1074
Andreas Färber418ba9e2012-02-25 23:07:34 +01001075static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
1076{
1077 GSList **list = opaque;
1078
1079 *list = g_slist_prepend(*list, klass);
1080}
1081
1082GSList *object_class_get_list(const char *implements_type,
1083 bool include_abstract)
1084{
1085 GSList *list = NULL;
1086
1087 object_class_foreach(object_class_get_list_tramp,
1088 implements_type, include_abstract, &list);
1089 return list;
1090}
1091
Paolo Bonzini47c66002018-03-03 08:33:10 +01001092static gint object_class_cmp(gconstpointer a, gconstpointer b)
1093{
1094 return strcasecmp(object_class_get_name((ObjectClass *)a),
1095 object_class_get_name((ObjectClass *)b));
1096}
1097
1098GSList *object_class_get_list_sorted(const char *implements_type,
1099 bool include_abstract)
1100{
1101 return g_slist_sort(object_class_get_list(implements_type, include_abstract),
1102 object_class_cmp);
1103}
1104
Marc-André Lureaub77ade92020-01-10 19:30:31 +04001105Object *object_ref(Object *obj)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001106{
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001107 if (!obj) {
Marc-André Lureaub77ade92020-01-10 19:30:31 +04001108 return NULL;
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001109 }
Andreas Färber8438a132015-11-16 17:49:20 +01001110 atomic_inc(&obj->ref);
Marc-André Lureaub77ade92020-01-10 19:30:31 +04001111 return obj;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001112}
1113
1114void object_unref(Object *obj)
1115{
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001116 if (!obj) {
1117 return;
1118 }
Markus Armbruster719a3072018-06-08 19:02:31 +02001119 g_assert(obj->ref > 0);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001120
1121 /* parent always holds a reference to its children */
Jan Kiszkaf08c03f2013-07-02 11:36:39 +02001122 if (atomic_fetch_dec(&obj->ref) == 1) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001123 object_finalize(obj);
1124 }
1125}
1126
Markus Armbrusterd2623122020-05-05 17:29:22 +02001127static ObjectProperty *
1128object_property_try_add(Object *obj, const char *name, const char *type,
1129 ObjectPropertyAccessor *get,
1130 ObjectPropertyAccessor *set,
1131 ObjectPropertyRelease *release,
1132 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001133{
Peter Maydell54852b02013-03-25 13:15:13 +00001134 ObjectProperty *prop;
Peter Crosthwaite33965902014-08-19 23:55:52 -07001135 size_t name_len = strlen(name);
1136
1137 if (name_len >= 3 && !memcmp(name + name_len - 3, "[*]", 4)) {
1138 int i;
1139 ObjectProperty *ret;
1140 char *name_no_array = g_strdup(name);
1141
1142 name_no_array[name_len - 3] = '\0';
1143 for (i = 0; ; ++i) {
1144 char *full_name = g_strdup_printf("%s[%d]", name_no_array, i);
1145
Markus Armbrusterd2623122020-05-05 17:29:22 +02001146 ret = object_property_try_add(obj, full_name, type, get, set,
1147 release, opaque, NULL);
Peter Crosthwaite33965902014-08-19 23:55:52 -07001148 g_free(full_name);
1149 if (ret) {
1150 break;
1151 }
1152 }
1153 g_free(name_no_array);
1154 return ret;
1155 }
Peter Maydell54852b02013-03-25 13:15:13 +00001156
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001157 if (object_property_find(obj, name, NULL) != NULL) {
Greg Kurzd55e9372019-11-04 14:23:55 +01001158 error_setg(errp, "attempt to add duplicate property '%s' to object (type '%s')",
1159 name, object_get_typename(obj));
Pavel Fedinb604a852015-10-13 13:37:45 +01001160 return NULL;
Peter Maydell54852b02013-03-25 13:15:13 +00001161 }
1162
1163 prop = g_malloc0(sizeof(*prop));
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001164
1165 prop->name = g_strdup(name);
1166 prop->type = g_strdup(type);
1167
1168 prop->get = get;
1169 prop->set = set;
1170 prop->release = release;
1171 prop->opaque = opaque;
1172
Pavel Fedinb604a852015-10-13 13:37:45 +01001173 g_hash_table_insert(obj->properties, prop->name, prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001174 return prop;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001175}
1176
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001177ObjectProperty *
Markus Armbrusterd2623122020-05-05 17:29:22 +02001178object_property_add(Object *obj, const char *name, const char *type,
1179 ObjectPropertyAccessor *get,
1180 ObjectPropertyAccessor *set,
1181 ObjectPropertyRelease *release,
1182 void *opaque)
1183{
1184 return object_property_try_add(obj, name, type, get, set, release,
1185 opaque, &error_abort);
1186}
1187
1188ObjectProperty *
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001189object_class_property_add(ObjectClass *klass,
1190 const char *name,
1191 const char *type,
1192 ObjectPropertyAccessor *get,
1193 ObjectPropertyAccessor *set,
1194 ObjectPropertyRelease *release,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001195 void *opaque)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001196{
1197 ObjectProperty *prop;
1198
Markus Armbrusterd2623122020-05-05 17:29:22 +02001199 assert(!object_class_property_find(klass, name, NULL));
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001200
1201 prop = g_malloc0(sizeof(*prop));
1202
1203 prop->name = g_strdup(name);
1204 prop->type = g_strdup(type);
1205
1206 prop->get = get;
1207 prop->set = set;
1208 prop->release = release;
1209 prop->opaque = opaque;
1210
Marc-André Lureauba806ff2020-01-10 19:30:18 +04001211 g_hash_table_insert(klass->properties, prop->name, prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001212
1213 return prop;
1214}
1215
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001216ObjectProperty *object_property_find(Object *obj, const char *name,
1217 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001218{
1219 ObjectProperty *prop;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001220 ObjectClass *klass = object_get_class(obj);
1221
1222 prop = object_class_property_find(klass, name, NULL);
1223 if (prop) {
1224 return prop;
1225 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001226
Pavel Fedinb604a852015-10-13 13:37:45 +01001227 prop = g_hash_table_lookup(obj->properties, name);
1228 if (prop) {
1229 return prop;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001230 }
1231
Cole Robinsonf231b882014-03-21 19:42:26 -04001232 error_setg(errp, "Property '.%s' not found", name);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001233 return NULL;
1234}
1235
Daniel P. Berrange7746abd2015-12-09 12:34:02 +00001236void object_property_iter_init(ObjectPropertyIterator *iter,
1237 Object *obj)
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001238{
Daniel P. Berrange7746abd2015-12-09 12:34:02 +00001239 g_hash_table_iter_init(&iter->iter, obj->properties);
1240 iter->nextclass = object_get_class(obj);
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001241}
1242
1243ObjectProperty *object_property_iter_next(ObjectPropertyIterator *iter)
1244{
Pavel Fedinb604a852015-10-13 13:37:45 +01001245 gpointer key, val;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001246 while (!g_hash_table_iter_next(&iter->iter, &key, &val)) {
1247 if (!iter->nextclass) {
1248 return NULL;
1249 }
1250 g_hash_table_iter_init(&iter->iter, iter->nextclass->properties);
1251 iter->nextclass = object_class_get_parent(iter->nextclass);
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001252 }
Pavel Fedinb604a852015-10-13 13:37:45 +01001253 return val;
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001254}
1255
Alexey Kardashevskiy961c47b2018-03-02 00:09:39 +11001256void object_class_property_iter_init(ObjectPropertyIterator *iter,
1257 ObjectClass *klass)
1258{
1259 g_hash_table_iter_init(&iter->iter, klass->properties);
Marc-André Lureau684546d2018-09-06 17:37:36 +04001260 iter->nextclass = object_class_get_parent(klass);
Alexey Kardashevskiy961c47b2018-03-02 00:09:39 +11001261}
1262
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001263ObjectProperty *object_class_property_find(ObjectClass *klass, const char *name,
1264 Error **errp)
1265{
1266 ObjectProperty *prop;
1267 ObjectClass *parent_klass;
1268
1269 parent_klass = object_class_get_parent(klass);
1270 if (parent_klass) {
1271 prop = object_class_property_find(parent_klass, name, NULL);
1272 if (prop) {
1273 return prop;
1274 }
1275 }
1276
1277 prop = g_hash_table_lookup(klass->properties, name);
1278 if (!prop) {
1279 error_setg(errp, "Property '.%s' not found", name);
1280 }
1281 return prop;
1282}
1283
Markus Armbrusterdf4fe0b2020-05-05 17:29:26 +02001284void object_property_del(Object *obj, const char *name)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001285{
Pavel Fedinb604a852015-10-13 13:37:45 +01001286 ObjectProperty *prop = g_hash_table_lookup(obj->properties, name);
1287
Anthony Liguori0866aca2011-12-23 15:34:39 -06001288 if (prop->release) {
1289 prop->release(obj, name, prop->opaque);
1290 }
Pavel Fedinb604a852015-10-13 13:37:45 +01001291 g_hash_table_remove(obj->properties, name);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001292}
1293
1294void object_property_get(Object *obj, Visitor *v, const char *name,
1295 Error **errp)
1296{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001297 ObjectProperty *prop = object_property_find(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001298 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001299 return;
1300 }
1301
1302 if (!prop->get) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001303 error_setg(errp, QERR_PERMISSION_DENIED);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001304 } else {
Eric Blaked7bce992016-01-29 06:48:55 -07001305 prop->get(obj, v, name, prop->opaque, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001306 }
1307}
1308
1309void object_property_set(Object *obj, Visitor *v, const char *name,
1310 Error **errp)
1311{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001312 ObjectProperty *prop = object_property_find(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001313 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001314 return;
1315 }
1316
1317 if (!prop->set) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001318 error_setg(errp, QERR_PERMISSION_DENIED);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001319 } else {
Eric Blaked7bce992016-01-29 06:48:55 -07001320 prop->set(obj, v, name, prop->opaque, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001321 }
1322}
1323
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001324void object_property_set_str(Object *obj, const char *value,
1325 const char *name, Error **errp)
1326{
1327 QString *qstr = qstring_from_str(value);
1328 object_property_set_qobject(obj, QOBJECT(qstr), name, errp);
1329
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001330 qobject_unref(qstr);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001331}
1332
1333char *object_property_get_str(Object *obj, const char *name,
1334 Error **errp)
1335{
1336 QObject *ret = object_property_get_qobject(obj, name, errp);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001337 char *retval;
1338
1339 if (!ret) {
1340 return NULL;
1341 }
Peter Xuaafb21a2018-03-09 16:59:47 +08001342
1343 retval = g_strdup(qobject_get_try_str(ret));
1344 if (!retval) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001345 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001346 }
1347
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001348 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001349 return retval;
1350}
1351
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001352void object_property_set_link(Object *obj, Object *value,
1353 const char *name, Error **errp)
1354{
Peter Crosthwaited3c49312014-09-25 22:19:19 -07001355 if (value) {
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001356 char *path = object_get_canonical_path(value);
Peter Crosthwaited3c49312014-09-25 22:19:19 -07001357 object_property_set_str(obj, path, name, errp);
1358 g_free(path);
1359 } else {
1360 object_property_set_str(obj, "", name, errp);
1361 }
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001362}
1363
1364Object *object_property_get_link(Object *obj, const char *name,
1365 Error **errp)
1366{
1367 char *str = object_property_get_str(obj, name, errp);
1368 Object *target = NULL;
1369
1370 if (str && *str) {
1371 target = object_resolve_path(str, NULL);
1372 if (!target) {
Markus Armbruster75158eb2015-03-16 08:57:47 +01001373 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1374 "Device '%s' not found", str);
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001375 }
1376 }
1377
1378 g_free(str);
1379 return target;
1380}
1381
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001382void object_property_set_bool(Object *obj, bool value,
1383 const char *name, Error **errp)
1384{
Eric Blakefc48ffc2015-05-15 16:24:59 -06001385 QBool *qbool = qbool_from_bool(value);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001386 object_property_set_qobject(obj, QOBJECT(qbool), name, errp);
1387
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001388 qobject_unref(qbool);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001389}
1390
1391bool object_property_get_bool(Object *obj, const char *name,
1392 Error **errp)
1393{
1394 QObject *ret = object_property_get_qobject(obj, name, errp);
1395 QBool *qbool;
1396 bool retval;
1397
1398 if (!ret) {
1399 return false;
1400 }
Max Reitz7dc847e2018-02-24 16:40:29 +01001401 qbool = qobject_to(QBool, ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001402 if (!qbool) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001403 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001404 retval = false;
1405 } else {
Eric Blakefc48ffc2015-05-15 16:24:59 -06001406 retval = qbool_get_bool(qbool);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001407 }
1408
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001409 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001410 return retval;
1411}
1412
1413void object_property_set_int(Object *obj, int64_t value,
1414 const char *name, Error **errp)
1415{
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001416 QNum *qnum = qnum_from_int(value);
1417 object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001418
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001419 qobject_unref(qnum);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001420}
1421
1422int64_t object_property_get_int(Object *obj, const char *name,
1423 Error **errp)
1424{
1425 QObject *ret = object_property_get_qobject(obj, name, errp);
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001426 QNum *qnum;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001427 int64_t retval;
1428
1429 if (!ret) {
1430 return -1;
1431 }
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001432
Max Reitz7dc847e2018-02-24 16:40:29 +01001433 qnum = qobject_to(QNum, ret);
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001434 if (!qnum || !qnum_get_try_int(qnum, &retval)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001435 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001436 retval = -1;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001437 }
1438
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001439 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001440 return retval;
1441}
1442
Marc-André Lureau0e76ed02020-01-10 19:30:23 +04001443static void object_property_init_defval(Object *obj, ObjectProperty *prop)
1444{
1445 Visitor *v = qobject_input_visitor_new(prop->defval);
1446
1447 assert(prop->set != NULL);
1448 prop->set(obj, v, prop->name, prop->opaque, &error_abort);
1449
1450 visit_free(v);
1451}
1452
1453static void object_property_set_default(ObjectProperty *prop, QObject *defval)
1454{
1455 assert(!prop->defval);
1456 assert(!prop->init);
1457
1458 prop->defval = defval;
1459 prop->init = object_property_init_defval;
1460}
1461
1462void object_property_set_default_bool(ObjectProperty *prop, bool value)
1463{
1464 object_property_set_default(prop, QOBJECT(qbool_from_bool(value)));
1465}
1466
1467void object_property_set_default_str(ObjectProperty *prop, const char *value)
1468{
1469 object_property_set_default(prop, QOBJECT(qstring_from_str(value)));
1470}
1471
1472void object_property_set_default_int(ObjectProperty *prop, int64_t value)
1473{
1474 object_property_set_default(prop, QOBJECT(qnum_from_int(value)));
1475}
1476
1477void object_property_set_default_uint(ObjectProperty *prop, uint64_t value)
1478{
1479 object_property_set_default(prop, QOBJECT(qnum_from_uint(value)));
1480}
1481
Marc-André Lureau31527792017-06-07 20:36:04 +04001482void object_property_set_uint(Object *obj, uint64_t value,
1483 const char *name, Error **errp)
1484{
1485 QNum *qnum = qnum_from_uint(value);
1486
1487 object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001488 qobject_unref(qnum);
Marc-André Lureau31527792017-06-07 20:36:04 +04001489}
1490
1491uint64_t object_property_get_uint(Object *obj, const char *name,
1492 Error **errp)
1493{
1494 QObject *ret = object_property_get_qobject(obj, name, errp);
1495 QNum *qnum;
1496 uint64_t retval;
1497
1498 if (!ret) {
1499 return 0;
1500 }
Max Reitz7dc847e2018-02-24 16:40:29 +01001501 qnum = qobject_to(QNum, ret);
Marc-André Lureau31527792017-06-07 20:36:04 +04001502 if (!qnum || !qnum_get_try_uint(qnum, &retval)) {
1503 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "uint");
1504 retval = 0;
1505 }
1506
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001507 qobject_unref(ret);
Marc-André Lureau31527792017-06-07 20:36:04 +04001508 return retval;
1509}
1510
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01001511typedef struct EnumProperty {
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02001512 const QEnumLookup *lookup;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01001513 int (*get)(Object *, Error **);
1514 void (*set)(Object *, int, Error **);
1515} EnumProperty;
1516
Hu Tao1f217722014-05-14 17:43:33 +08001517int object_property_get_enum(Object *obj, const char *name,
Daniel P. Berrangea3590da2015-05-27 16:07:56 +01001518 const char *typename, Error **errp)
Hu Tao1f217722014-05-14 17:43:33 +08001519{
Chen Fan976620a2014-08-18 14:46:34 +08001520 char *str;
Hu Tao1f217722014-05-14 17:43:33 +08001521 int ret;
Daniel P. Berrangea3590da2015-05-27 16:07:56 +01001522 ObjectProperty *prop = object_property_find(obj, name, errp);
1523 EnumProperty *enumprop;
1524
1525 if (prop == NULL) {
1526 return 0;
1527 }
1528
1529 if (!g_str_equal(prop->type, typename)) {
1530 error_setg(errp, "Property %s on %s is not '%s' enum type",
1531 name, object_class_get_name(
1532 object_get_class(obj)), typename);
1533 return 0;
1534 }
1535
1536 enumprop = prop->opaque;
Hu Tao1f217722014-05-14 17:43:33 +08001537
Markus Armbrusterb555f892020-05-05 17:29:12 +02001538 str = object_property_get_str(obj, name, errp);
1539 if (!str) {
Markus Armbruster4715d422015-08-25 20:00:45 +02001540 return 0;
1541 }
Chen Fan976620a2014-08-18 14:46:34 +08001542
Markus Armbrusterea097df2020-04-24 10:43:36 +02001543 ret = qapi_enum_parse(enumprop->lookup, str, -1, errp);
Chen Fan976620a2014-08-18 14:46:34 +08001544 g_free(str);
Hu Tao1f217722014-05-14 17:43:33 +08001545
1546 return ret;
1547}
1548
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001549void object_property_parse(Object *obj, const char *string,
1550 const char *name, Error **errp)
1551{
Eric Blake7a0525c2016-06-09 10:48:37 -06001552 Visitor *v = string_input_visitor_new(string);
1553 object_property_set(obj, v, name, errp);
1554 visit_free(v);
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001555}
1556
Paolo Bonzini0b7593e2014-02-08 11:01:50 +01001557char *object_property_print(Object *obj, const char *name, bool human,
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001558 Error **errp)
1559{
Eric Blake3b098d52016-06-09 10:48:43 -06001560 Visitor *v;
Gonglei3a530092014-09-27 13:13:55 +08001561 char *string = NULL;
1562 Error *local_err = NULL;
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001563
Eric Blake3b098d52016-06-09 10:48:43 -06001564 v = string_output_visitor_new(human, &string);
1565 object_property_get(obj, v, name, &local_err);
Gonglei3a530092014-09-27 13:13:55 +08001566 if (local_err) {
1567 error_propagate(errp, local_err);
1568 goto out;
1569 }
1570
Eric Blake3b098d52016-06-09 10:48:43 -06001571 visit_complete(v, &string);
Gonglei3a530092014-09-27 13:13:55 +08001572
1573out:
Eric Blake3b098d52016-06-09 10:48:43 -06001574 visit_free(v);
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001575 return string;
1576}
1577
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001578const char *object_property_get_type(Object *obj, const char *name, Error **errp)
1579{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001580 ObjectProperty *prop = object_property_find(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001581 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001582 return NULL;
1583 }
1584
1585 return prop->type;
1586}
1587
1588Object *object_get_root(void)
1589{
Anthony Liguori8b45d442011-12-23 09:08:05 -06001590 static Object *root;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001591
Anthony Liguori8b45d442011-12-23 09:08:05 -06001592 if (!root) {
1593 root = object_new("container");
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001594 }
1595
Anthony Liguori8b45d442011-12-23 09:08:05 -06001596 return root;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001597}
1598
Daniel P. Berrangebc2256c2015-05-13 17:14:05 +01001599Object *object_get_objects_root(void)
1600{
1601 return container_get(object_get_root(), "/objects");
1602}
1603
Peter Xu7c47c4e2017-09-28 10:59:54 +08001604Object *object_get_internal_root(void)
1605{
1606 static Object *internal_root;
1607
1608 if (!internal_root) {
1609 internal_root = object_new("container");
1610 }
1611
1612 return internal_root;
1613}
1614
Eric Blaked7bce992016-01-29 06:48:55 -07001615static void object_get_child_property(Object *obj, Visitor *v,
1616 const char *name, void *opaque,
1617 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001618{
1619 Object *child = opaque;
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001620 char *path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001621
1622 path = object_get_canonical_path(child);
Eric Blake51e72bc2016-01-29 06:48:54 -07001623 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001624 g_free(path);
1625}
1626
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001627static Object *object_resolve_child_property(Object *parent, void *opaque,
1628 const char *part)
Paolo Bonzini64607d02014-06-05 13:11:51 +02001629{
1630 return opaque;
1631}
1632
Anthony Liguoridb85b572011-12-23 08:47:39 -06001633static void object_finalize_child_property(Object *obj, const char *name,
1634 void *opaque)
1635{
1636 Object *child = opaque;
1637
Paolo Bonzinibffc6872014-06-11 11:57:38 +02001638 if (child->class->unparent) {
1639 (child->class->unparent)(child);
1640 }
1641 child->parent = NULL;
Anthony Liguoridb85b572011-12-23 08:47:39 -06001642 object_unref(child);
1643}
1644
Markus Armbruster70251882020-05-05 17:29:14 +02001645ObjectProperty *
1646object_property_add_child(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001647 Object *child)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001648{
Markus Armbruster70251882020-05-05 17:29:14 +02001649 g_autofree char *type = NULL;
Paolo Bonzini64607d02014-06-05 13:11:51 +02001650 ObjectProperty *op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001651
Markus Armbrusterd2623122020-05-05 17:29:22 +02001652 assert(!child->parent);
Peter Crosthwaite8faa2f82014-09-25 22:19:52 -07001653
Philippe Mathieu-Daudé688ffbb2020-05-12 09:00:19 +02001654 type = g_strdup_printf("child<%s>", object_get_typename(child));
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001655
Paolo Bonzini64607d02014-06-05 13:11:51 +02001656 op = object_property_add(obj, name, type, object_get_child_property, NULL,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001657 object_finalize_child_property, child);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001658 op->resolve = object_resolve_child_property;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001659 object_ref(child);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001660 child->parent = obj;
Markus Armbruster70251882020-05-05 17:29:14 +02001661 return op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001662}
1663
Igor Mammedov8f5d58e2017-07-14 10:14:50 +08001664void object_property_allow_set_link(const Object *obj, const char *name,
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001665 Object *val, Error **errp)
1666{
1667 /* Allow the link to be set, always */
1668}
1669
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001670typedef struct {
Marc-André Lureau9941d372020-01-10 19:30:27 +04001671 union {
1672 Object **targetp;
1673 Object *target; /* if OBJ_PROP_LINK_DIRECT, when holding the pointer */
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001674 ptrdiff_t offset; /* if OBJ_PROP_LINK_CLASS */
Marc-André Lureau9941d372020-01-10 19:30:27 +04001675 };
Igor Mammedov8f5d58e2017-07-14 10:14:50 +08001676 void (*check)(const Object *, const char *, Object *, Error **);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001677 ObjectPropertyLinkFlags flags;
1678} LinkProperty;
1679
Marc-André Lureau9941d372020-01-10 19:30:27 +04001680static Object **
1681object_link_get_targetp(Object *obj, LinkProperty *lprop)
1682{
1683 if (lprop->flags & OBJ_PROP_LINK_DIRECT) {
1684 return &lprop->target;
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001685 } else if (lprop->flags & OBJ_PROP_LINK_CLASS) {
1686 return (void *)obj + lprop->offset;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001687 } else {
1688 return lprop->targetp;
1689 }
1690}
1691
Eric Blaked7bce992016-01-29 06:48:55 -07001692static void object_get_link_property(Object *obj, Visitor *v,
1693 const char *name, void *opaque,
1694 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001695{
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001696 LinkProperty *lprop = opaque;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001697 Object **targetp = object_link_get_targetp(obj, lprop);
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001698 char *path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001699
Marc-André Lureau36854202020-01-10 19:30:26 +04001700 if (*targetp) {
1701 path = object_get_canonical_path(*targetp);
Eric Blake51e72bc2016-01-29 06:48:54 -07001702 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001703 g_free(path);
1704 } else {
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001705 path = (char *)"";
Eric Blake51e72bc2016-01-29 06:48:54 -07001706 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001707 }
1708}
1709
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001710/*
1711 * object_resolve_link:
1712 *
1713 * Lookup an object and ensure its type matches the link property type. This
1714 * is similar to object_resolve_path() except type verification against the
1715 * link property is performed.
1716 *
1717 * Returns: The matched object or NULL on path lookup failures.
1718 */
1719static Object *object_resolve_link(Object *obj, const char *name,
1720 const char *path, Error **errp)
1721{
1722 const char *type;
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001723 char *target_type;
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001724 bool ambiguous = false;
1725 Object *target;
1726
1727 /* Go from link<FOO> to FOO. */
1728 type = object_property_get_type(obj, name, NULL);
1729 target_type = g_strndup(&type[5], strlen(type) - 6);
1730 target = object_resolve_path_type(path, target_type, &ambiguous);
1731
1732 if (ambiguous) {
Eric Blake455b0fd2015-11-10 23:51:20 -07001733 error_setg(errp, "Path '%s' does not uniquely identify an object",
1734 path);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001735 } else if (!target) {
1736 target = object_resolve_path(path, &ambiguous);
1737 if (target || ambiguous) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001738 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001739 } else {
Markus Armbruster75158eb2015-03-16 08:57:47 +01001740 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1741 "Device '%s' not found", path);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001742 }
1743 target = NULL;
1744 }
1745 g_free(target_type);
1746
1747 return target;
1748}
1749
Eric Blaked7bce992016-01-29 06:48:55 -07001750static void object_set_link_property(Object *obj, Visitor *v,
1751 const char *name, void *opaque,
1752 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001753{
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001754 Error *local_err = NULL;
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001755 LinkProperty *prop = opaque;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001756 Object **targetp = object_link_get_targetp(obj, prop);
Marc-André Lureau36854202020-01-10 19:30:26 +04001757 Object *old_target = *targetp;
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001758 Object *new_target = NULL;
1759 char *path = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001760
Eric Blake51e72bc2016-01-29 06:48:54 -07001761 visit_type_str(v, name, &path, &local_err);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001762
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001763 if (!local_err && strcmp(path, "") != 0) {
1764 new_target = object_resolve_link(obj, name, path, &local_err);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001765 }
1766
1767 g_free(path);
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001768 if (local_err) {
1769 error_propagate(errp, local_err);
1770 return;
1771 }
Alexander Barabashf0cdc962012-02-22 19:22:26 +02001772
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001773 prop->check(obj, name, new_target, &local_err);
1774 if (local_err) {
1775 error_propagate(errp, local_err);
1776 return;
1777 }
1778
Marc-André Lureau36854202020-01-10 19:30:26 +04001779 *targetp = new_target;
Marc-André Lureau8770baf2020-01-10 19:30:25 +04001780 if (prop->flags & OBJ_PROP_LINK_STRONG) {
Marc-André Lureau265b5782018-05-31 21:51:17 +02001781 object_ref(new_target);
1782 object_unref(old_target);
1783 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001784}
1785
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001786static Object *object_resolve_link_property(Object *parent, void *opaque,
1787 const char *part)
Paolo Bonzini64607d02014-06-05 13:11:51 +02001788{
1789 LinkProperty *lprop = opaque;
1790
Marc-André Lureau9941d372020-01-10 19:30:27 +04001791 return *object_link_get_targetp(parent, lprop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001792}
1793
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001794static void object_release_link_property(Object *obj, const char *name,
1795 void *opaque)
1796{
1797 LinkProperty *prop = opaque;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001798 Object **targetp = object_link_get_targetp(obj, prop);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001799
Marc-André Lureau9941d372020-01-10 19:30:27 +04001800 if ((prop->flags & OBJ_PROP_LINK_STRONG) && *targetp) {
1801 object_unref(*targetp);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001802 }
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001803 if (!(prop->flags & OBJ_PROP_LINK_CLASS)) {
1804 g_free(prop);
1805 }
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001806}
1807
Markus Armbruster70251882020-05-05 17:29:14 +02001808static ObjectProperty *
1809object_add_link_prop(Object *obj, const char *name,
1810 const char *type, void *ptr,
1811 void (*check)(const Object *, const char *,
1812 Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02001813 ObjectPropertyLinkFlags flags)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001814{
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001815 LinkProperty *prop = g_malloc(sizeof(*prop));
Markus Armbruster70251882020-05-05 17:29:14 +02001816 g_autofree char *full_type = NULL;
Paolo Bonzini64607d02014-06-05 13:11:51 +02001817 ObjectProperty *op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001818
Marc-André Lureau4a8d5792020-01-10 19:30:28 +04001819 if (flags & OBJ_PROP_LINK_DIRECT) {
1820 prop->target = ptr;
1821 } else {
1822 prop->targetp = ptr;
1823 }
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001824 prop->check = check;
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001825 prop->flags = flags;
1826
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001827 full_type = g_strdup_printf("link<%s>", type);
1828
Paolo Bonzini64607d02014-06-05 13:11:51 +02001829 op = object_property_add(obj, name, full_type,
1830 object_get_link_property,
1831 check ? object_set_link_property : NULL,
1832 object_release_link_property,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001833 prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001834 op->resolve = object_resolve_link_property;
Markus Armbruster70251882020-05-05 17:29:14 +02001835 return op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001836}
1837
Markus Armbruster70251882020-05-05 17:29:14 +02001838ObjectProperty *
1839object_property_add_link(Object *obj, const char *name,
1840 const char *type, Object **targetp,
1841 void (*check)(const Object *, const char *,
1842 Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02001843 ObjectPropertyLinkFlags flags)
Marc-André Lureau4a8d5792020-01-10 19:30:28 +04001844{
Markus Armbrusterd2623122020-05-05 17:29:22 +02001845 return object_add_link_prop(obj, name, type, targetp, check, flags);
Marc-André Lureau4a8d5792020-01-10 19:30:28 +04001846}
1847
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001848ObjectProperty *
1849object_class_property_add_link(ObjectClass *oc,
1850 const char *name,
1851 const char *type, ptrdiff_t offset,
1852 void (*check)(const Object *obj, const char *name,
1853 Object *val, Error **errp),
Markus Armbrusterd2623122020-05-05 17:29:22 +02001854 ObjectPropertyLinkFlags flags)
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001855{
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001856 LinkProperty *prop = g_new0(LinkProperty, 1);
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001857 char *full_type;
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001858 ObjectProperty *op;
1859
1860 prop->offset = offset;
1861 prop->check = check;
1862 prop->flags = flags | OBJ_PROP_LINK_CLASS;
1863
1864 full_type = g_strdup_printf("link<%s>", type);
1865
1866 op = object_class_property_add(oc, name, full_type,
1867 object_get_link_property,
1868 check ? object_set_link_property : NULL,
1869 object_release_link_property,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001870 prop);
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001871
1872 op->resolve = object_resolve_link_property;
1873
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001874 g_free(full_type);
1875 return op;
1876}
1877
Markus Armbruster70251882020-05-05 17:29:14 +02001878ObjectProperty *
1879object_property_add_const_link(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001880 Object *target)
Paolo Bonzinifb9e7e32015-05-05 18:29:00 +02001881{
Markus Armbruster70251882020-05-05 17:29:14 +02001882 return object_add_link_prop(obj, name,
1883 object_get_typename(target), target,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001884 NULL, OBJ_PROP_LINK_DIRECT);
Paolo Bonzinifb9e7e32015-05-05 18:29:00 +02001885}
1886
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001887char *object_get_canonical_path_component(Object *obj)
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001888{
1889 ObjectProperty *prop = NULL;
Pavel Fedinb604a852015-10-13 13:37:45 +01001890 GHashTableIter iter;
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001891
Paolo Bonzini770dec22018-04-30 11:44:17 +02001892 if (obj->parent == NULL) {
1893 return NULL;
1894 }
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001895
Pavel Fedinb604a852015-10-13 13:37:45 +01001896 g_hash_table_iter_init(&iter, obj->parent->properties);
1897 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001898 if (!object_property_is_child(prop)) {
1899 continue;
1900 }
1901
1902 if (prop->opaque == obj) {
1903 return g_strdup(prop->name);
1904 }
1905 }
1906
1907 /* obj had a parent but was not a child, should never happen */
1908 g_assert_not_reached();
1909 return NULL;
1910}
1911
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001912char *object_get_canonical_path(Object *obj)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001913{
1914 Object *root = object_get_root();
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001915 char *newpath, *path = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001916
Paolo Bonzinie40077f2018-05-30 18:16:04 +02001917 if (obj == root) {
1918 return g_strdup("/");
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001919 }
1920
Paolo Bonzinie40077f2018-05-30 18:16:04 +02001921 do {
1922 char *component = object_get_canonical_path_component(obj);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001923
Paolo Bonzinie40077f2018-05-30 18:16:04 +02001924 if (!component) {
1925 /* A canonical path must be complete, so discard what was
1926 * collected so far.
1927 */
1928 g_free(path);
1929 return NULL;
1930 }
1931
1932 newpath = g_strdup_printf("/%s%s", component, path ? path : "");
1933 g_free(path);
1934 g_free(component);
1935 path = newpath;
1936 obj = obj->parent;
1937 } while (obj != root);
1938
1939 return path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001940}
1941
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001942Object *object_resolve_path_component(Object *parent, const char *part)
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001943{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001944 ObjectProperty *prop = object_property_find(parent, part, NULL);
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001945 if (prop == NULL) {
1946 return NULL;
1947 }
1948
Paolo Bonzini64607d02014-06-05 13:11:51 +02001949 if (prop->resolve) {
1950 return prop->resolve(parent, prop->opaque, part);
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001951 } else {
1952 return NULL;
1953 }
1954}
1955
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001956static Object *object_resolve_abs_path(Object *parent,
Masahiro Yamadaad195c82020-05-10 10:32:35 +09001957 char **parts,
1958 const char *typename)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001959{
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001960 Object *child;
1961
Masahiro Yamadaad195c82020-05-10 10:32:35 +09001962 if (*parts == NULL) {
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001963 return object_dynamic_cast(parent, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001964 }
1965
Masahiro Yamadaad195c82020-05-10 10:32:35 +09001966 if (strcmp(*parts, "") == 0) {
1967 return object_resolve_abs_path(parent, parts + 1, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001968 }
1969
Masahiro Yamadaad195c82020-05-10 10:32:35 +09001970 child = object_resolve_path_component(parent, *parts);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001971 if (!child) {
1972 return NULL;
1973 }
1974
Masahiro Yamadaad195c82020-05-10 10:32:35 +09001975 return object_resolve_abs_path(child, parts + 1, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001976}
1977
1978static Object *object_resolve_partial_path(Object *parent,
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001979 char **parts,
1980 const char *typename,
1981 bool *ambiguous)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001982{
1983 Object *obj;
Pavel Fedinb604a852015-10-13 13:37:45 +01001984 GHashTableIter iter;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001985 ObjectProperty *prop;
1986
Masahiro Yamadaad195c82020-05-10 10:32:35 +09001987 obj = object_resolve_abs_path(parent, parts, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001988
Pavel Fedinb604a852015-10-13 13:37:45 +01001989 g_hash_table_iter_init(&iter, parent->properties);
1990 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001991 Object *found;
1992
Andreas Färber5d9d3f42012-05-27 00:32:40 +02001993 if (!object_property_is_child(prop)) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001994 continue;
1995 }
1996
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001997 found = object_resolve_partial_path(prop->opaque, parts,
1998 typename, ambiguous);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001999 if (found) {
2000 if (obj) {
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002001 *ambiguous = true;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002002 return NULL;
2003 }
2004 obj = found;
2005 }
2006
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002007 if (*ambiguous) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002008 return NULL;
2009 }
2010 }
2011
2012 return obj;
2013}
2014
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002015Object *object_resolve_path_type(const char *path, const char *typename,
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002016 bool *ambiguousp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002017{
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002018 Object *obj;
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02002019 char **parts;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002020
2021 parts = g_strsplit(path, "/", 0);
Paolo Bonzini2e1103f2013-04-18 18:44:02 +02002022 assert(parts);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002023
Paolo Bonzini2e1103f2013-04-18 18:44:02 +02002024 if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002025 bool ambiguous = false;
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002026 obj = object_resolve_partial_path(object_get_root(), parts,
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002027 typename, &ambiguous);
2028 if (ambiguousp) {
2029 *ambiguousp = ambiguous;
2030 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002031 } else {
Masahiro Yamadaad195c82020-05-10 10:32:35 +09002032 obj = object_resolve_abs_path(object_get_root(), parts + 1, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002033 }
2034
2035 g_strfreev(parts);
2036
2037 return obj;
2038}
2039
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002040Object *object_resolve_path(const char *path, bool *ambiguous)
2041{
2042 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
2043}
2044
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002045typedef struct StringProperty
2046{
2047 char *(*get)(Object *, Error **);
2048 void (*set)(Object *, const char *, Error **);
2049} StringProperty;
2050
Eric Blaked7bce992016-01-29 06:48:55 -07002051static void property_get_str(Object *obj, Visitor *v, const char *name,
2052 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002053{
2054 StringProperty *prop = opaque;
2055 char *value;
Markus Armbrustere1c82372015-08-25 20:00:46 +02002056 Error *err = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002057
Markus Armbrustere1c82372015-08-25 20:00:46 +02002058 value = prop->get(obj, &err);
2059 if (err) {
2060 error_propagate(errp, err);
2061 return;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002062 }
Markus Armbrustere1c82372015-08-25 20:00:46 +02002063
Eric Blake51e72bc2016-01-29 06:48:54 -07002064 visit_type_str(v, name, &value, errp);
Markus Armbrustere1c82372015-08-25 20:00:46 +02002065 g_free(value);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002066}
2067
Eric Blaked7bce992016-01-29 06:48:55 -07002068static void property_set_str(Object *obj, Visitor *v, const char *name,
2069 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002070{
2071 StringProperty *prop = opaque;
2072 char *value;
2073 Error *local_err = NULL;
2074
Eric Blake51e72bc2016-01-29 06:48:54 -07002075 visit_type_str(v, name, &value, &local_err);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002076 if (local_err) {
2077 error_propagate(errp, local_err);
2078 return;
2079 }
2080
2081 prop->set(obj, value, errp);
2082 g_free(value);
2083}
2084
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01002085static void property_release_str(Object *obj, const char *name,
2086 void *opaque)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002087{
2088 StringProperty *prop = opaque;
2089 g_free(prop);
2090}
2091
Markus Armbruster70251882020-05-05 17:29:14 +02002092ObjectProperty *
2093object_property_add_str(Object *obj, const char *name,
2094 char *(*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002095 void (*set)(Object *, const char *, Error **))
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002096{
2097 StringProperty *prop = g_malloc0(sizeof(*prop));
2098
2099 prop->get = get;
2100 prop->set = set;
2101
Markus Armbrusterd2623122020-05-05 17:29:22 +02002102 return object_property_add(obj, name, "string",
2103 get ? property_get_str : NULL,
2104 set ? property_set_str : NULL,
2105 property_release_str,
2106 prop);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002107}
Paolo Bonzini745549c2012-03-31 16:45:54 +02002108
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002109ObjectProperty *
2110object_class_property_add_str(ObjectClass *klass, const char *name,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002111 char *(*get)(Object *, Error **),
2112 void (*set)(Object *, const char *,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002113 Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002114{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002115 StringProperty *prop = g_malloc0(sizeof(*prop));
2116
2117 prop->get = get;
2118 prop->set = set;
2119
Markus Armbrusterd2623122020-05-05 17:29:22 +02002120 return object_class_property_add(klass, name, "string",
2121 get ? property_get_str : NULL,
2122 set ? property_set_str : NULL,
2123 NULL,
2124 prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002125}
2126
Anthony Liguori0e558842012-06-25 10:32:46 -05002127typedef struct BoolProperty
2128{
2129 bool (*get)(Object *, Error **);
2130 void (*set)(Object *, bool, Error **);
2131} BoolProperty;
2132
Eric Blaked7bce992016-01-29 06:48:55 -07002133static void property_get_bool(Object *obj, Visitor *v, const char *name,
2134 void *opaque, Error **errp)
Anthony Liguori0e558842012-06-25 10:32:46 -05002135{
2136 BoolProperty *prop = opaque;
2137 bool value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002138 Error *err = NULL;
Anthony Liguori0e558842012-06-25 10:32:46 -05002139
Markus Armbruster4715d422015-08-25 20:00:45 +02002140 value = prop->get(obj, &err);
2141 if (err) {
2142 error_propagate(errp, err);
2143 return;
2144 }
2145
Eric Blake51e72bc2016-01-29 06:48:54 -07002146 visit_type_bool(v, name, &value, errp);
Anthony Liguori0e558842012-06-25 10:32:46 -05002147}
2148
Eric Blaked7bce992016-01-29 06:48:55 -07002149static void property_set_bool(Object *obj, Visitor *v, const char *name,
2150 void *opaque, Error **errp)
Anthony Liguori0e558842012-06-25 10:32:46 -05002151{
2152 BoolProperty *prop = opaque;
2153 bool value;
2154 Error *local_err = NULL;
2155
Eric Blake51e72bc2016-01-29 06:48:54 -07002156 visit_type_bool(v, name, &value, &local_err);
Anthony Liguori0e558842012-06-25 10:32:46 -05002157 if (local_err) {
2158 error_propagate(errp, local_err);
2159 return;
2160 }
2161
2162 prop->set(obj, value, errp);
2163}
2164
2165static void property_release_bool(Object *obj, const char *name,
2166 void *opaque)
2167{
2168 BoolProperty *prop = opaque;
2169 g_free(prop);
2170}
2171
Markus Armbruster70251882020-05-05 17:29:14 +02002172ObjectProperty *
2173object_property_add_bool(Object *obj, const char *name,
2174 bool (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002175 void (*set)(Object *, bool, Error **))
Anthony Liguori0e558842012-06-25 10:32:46 -05002176{
2177 BoolProperty *prop = g_malloc0(sizeof(*prop));
2178
2179 prop->get = get;
2180 prop->set = set;
2181
Markus Armbrusterd2623122020-05-05 17:29:22 +02002182 return object_property_add(obj, name, "bool",
2183 get ? property_get_bool : NULL,
2184 set ? property_set_bool : NULL,
2185 property_release_bool,
2186 prop);
Anthony Liguori0e558842012-06-25 10:32:46 -05002187}
2188
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002189ObjectProperty *
2190object_class_property_add_bool(ObjectClass *klass, const char *name,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002191 bool (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002192 void (*set)(Object *, bool, Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002193{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002194 BoolProperty *prop = g_malloc0(sizeof(*prop));
2195
2196 prop->get = get;
2197 prop->set = set;
2198
Markus Armbrusterd2623122020-05-05 17:29:22 +02002199 return object_class_property_add(klass, name, "bool",
2200 get ? property_get_bool : NULL,
2201 set ? property_set_bool : NULL,
2202 NULL,
2203 prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002204}
2205
Eric Blaked7bce992016-01-29 06:48:55 -07002206static void property_get_enum(Object *obj, Visitor *v, const char *name,
2207 void *opaque, Error **errp)
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002208{
2209 EnumProperty *prop = opaque;
2210 int value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002211 Error *err = NULL;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002212
Markus Armbruster4715d422015-08-25 20:00:45 +02002213 value = prop->get(obj, &err);
2214 if (err) {
2215 error_propagate(errp, err);
2216 return;
2217 }
2218
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002219 visit_type_enum(v, name, &value, prop->lookup, errp);
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002220}
2221
Eric Blaked7bce992016-01-29 06:48:55 -07002222static void property_set_enum(Object *obj, Visitor *v, const char *name,
2223 void *opaque, Error **errp)
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002224{
2225 EnumProperty *prop = opaque;
2226 int value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002227 Error *err = NULL;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002228
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002229 visit_type_enum(v, name, &value, prop->lookup, &err);
Markus Armbruster4715d422015-08-25 20:00:45 +02002230 if (err) {
2231 error_propagate(errp, err);
2232 return;
2233 }
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002234 prop->set(obj, value, errp);
2235}
2236
2237static void property_release_enum(Object *obj, const char *name,
2238 void *opaque)
2239{
2240 EnumProperty *prop = opaque;
2241 g_free(prop);
2242}
2243
Markus Armbruster70251882020-05-05 17:29:14 +02002244ObjectProperty *
2245object_property_add_enum(Object *obj, const char *name,
2246 const char *typename,
2247 const QEnumLookup *lookup,
2248 int (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002249 void (*set)(Object *, int, Error **))
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002250{
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002251 EnumProperty *prop = g_malloc(sizeof(*prop));
2252
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002253 prop->lookup = lookup;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002254 prop->get = get;
2255 prop->set = set;
2256
Markus Armbrusterd2623122020-05-05 17:29:22 +02002257 return object_property_add(obj, name, typename,
2258 get ? property_get_enum : NULL,
2259 set ? property_set_enum : NULL,
2260 property_release_enum,
2261 prop);
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002262}
2263
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002264ObjectProperty *
2265object_class_property_add_enum(ObjectClass *klass, const char *name,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002266 const char *typename,
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002267 const QEnumLookup *lookup,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002268 int (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002269 void (*set)(Object *, int, Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002270{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002271 EnumProperty *prop = g_malloc(sizeof(*prop));
2272
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002273 prop->lookup = lookup;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002274 prop->get = get;
2275 prop->set = set;
2276
Markus Armbrusterd2623122020-05-05 17:29:22 +02002277 return object_class_property_add(klass, name, typename,
2278 get ? property_get_enum : NULL,
2279 set ? property_set_enum : NULL,
2280 NULL,
2281 prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002282}
2283
David Gibson8e099d12015-02-06 14:55:45 +11002284typedef struct TMProperty {
2285 void (*get)(Object *, struct tm *, Error **);
2286} TMProperty;
2287
Eric Blaked7bce992016-01-29 06:48:55 -07002288static void property_get_tm(Object *obj, Visitor *v, const char *name,
2289 void *opaque, Error **errp)
David Gibson8e099d12015-02-06 14:55:45 +11002290{
2291 TMProperty *prop = opaque;
2292 Error *err = NULL;
2293 struct tm value;
2294
2295 prop->get(obj, &value, &err);
2296 if (err) {
2297 goto out;
2298 }
2299
Eric Blake337283d2016-01-29 06:48:57 -07002300 visit_start_struct(v, name, NULL, 0, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002301 if (err) {
2302 goto out;
2303 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002304 visit_type_int32(v, "tm_year", &value.tm_year, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002305 if (err) {
2306 goto out_end;
2307 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002308 visit_type_int32(v, "tm_mon", &value.tm_mon, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002309 if (err) {
2310 goto out_end;
2311 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002312 visit_type_int32(v, "tm_mday", &value.tm_mday, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002313 if (err) {
2314 goto out_end;
2315 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002316 visit_type_int32(v, "tm_hour", &value.tm_hour, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002317 if (err) {
2318 goto out_end;
2319 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002320 visit_type_int32(v, "tm_min", &value.tm_min, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002321 if (err) {
2322 goto out_end;
2323 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002324 visit_type_int32(v, "tm_sec", &value.tm_sec, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002325 if (err) {
2326 goto out_end;
2327 }
Eric Blake15c2f662016-04-28 15:45:27 -06002328 visit_check_struct(v, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002329out_end:
Eric Blake1158bb22016-06-09 10:48:34 -06002330 visit_end_struct(v, NULL);
David Gibson8e099d12015-02-06 14:55:45 +11002331out:
2332 error_propagate(errp, err);
2333
2334}
2335
2336static void property_release_tm(Object *obj, const char *name,
2337 void *opaque)
2338{
2339 TMProperty *prop = opaque;
2340 g_free(prop);
2341}
2342
Markus Armbruster70251882020-05-05 17:29:14 +02002343ObjectProperty *
2344object_property_add_tm(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002345 void (*get)(Object *, struct tm *, Error **))
David Gibson8e099d12015-02-06 14:55:45 +11002346{
David Gibson8e099d12015-02-06 14:55:45 +11002347 TMProperty *prop = g_malloc0(sizeof(*prop));
2348
2349 prop->get = get;
2350
Markus Armbrusterd2623122020-05-05 17:29:22 +02002351 return object_property_add(obj, name, "struct tm",
2352 get ? property_get_tm : NULL, NULL,
2353 property_release_tm,
2354 prop);
David Gibson8e099d12015-02-06 14:55:45 +11002355}
2356
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002357ObjectProperty *
2358object_class_property_add_tm(ObjectClass *klass, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002359 void (*get)(Object *, struct tm *, Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002360{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002361 TMProperty *prop = g_malloc0(sizeof(*prop));
2362
2363 prop->get = get;
2364
Markus Armbrusterd2623122020-05-05 17:29:22 +02002365 return object_class_property_add(klass, name, "struct tm",
2366 get ? property_get_tm : NULL,
2367 NULL, NULL, prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002368}
2369
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002370static char *qdev_get_type(Object *obj, Error **errp)
2371{
2372 return g_strdup(object_get_typename(obj));
2373}
2374
Eric Blaked7bce992016-01-29 06:48:55 -07002375static void property_get_uint8_ptr(Object *obj, Visitor *v, const char *name,
2376 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002377{
2378 uint8_t value = *(uint8_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002379 visit_type_uint8(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002380}
2381
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002382static void property_set_uint8_ptr(Object *obj, Visitor *v, const char *name,
2383 void *opaque, Error **errp)
2384{
2385 uint8_t *field = opaque;
2386 uint8_t value;
2387 Error *local_err = NULL;
2388
2389 visit_type_uint8(v, name, &value, &local_err);
2390 if (local_err) {
2391 error_propagate(errp, local_err);
2392 return;
2393 }
2394
2395 *field = value;
2396}
2397
Eric Blaked7bce992016-01-29 06:48:55 -07002398static void property_get_uint16_ptr(Object *obj, Visitor *v, const char *name,
2399 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002400{
2401 uint16_t value = *(uint16_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002402 visit_type_uint16(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002403}
2404
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002405static void property_set_uint16_ptr(Object *obj, Visitor *v, const char *name,
2406 void *opaque, Error **errp)
2407{
2408 uint16_t *field = opaque;
2409 uint16_t value;
2410 Error *local_err = NULL;
2411
2412 visit_type_uint16(v, name, &value, &local_err);
2413 if (local_err) {
2414 error_propagate(errp, local_err);
2415 return;
2416 }
2417
2418 *field = value;
2419}
2420
Eric Blaked7bce992016-01-29 06:48:55 -07002421static void property_get_uint32_ptr(Object *obj, Visitor *v, const char *name,
2422 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002423{
2424 uint32_t value = *(uint32_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002425 visit_type_uint32(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002426}
2427
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002428static void property_set_uint32_ptr(Object *obj, Visitor *v, const char *name,
2429 void *opaque, Error **errp)
2430{
2431 uint32_t *field = opaque;
2432 uint32_t value;
2433 Error *local_err = NULL;
2434
2435 visit_type_uint32(v, name, &value, &local_err);
2436 if (local_err) {
2437 error_propagate(errp, local_err);
2438 return;
2439 }
2440
2441 *field = value;
2442}
2443
Eric Blaked7bce992016-01-29 06:48:55 -07002444static void property_get_uint64_ptr(Object *obj, Visitor *v, const char *name,
2445 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002446{
2447 uint64_t value = *(uint64_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002448 visit_type_uint64(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002449}
2450
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002451static void property_set_uint64_ptr(Object *obj, Visitor *v, const char *name,
2452 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002453{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002454 uint64_t *field = opaque;
2455 uint64_t value;
2456 Error *local_err = NULL;
2457
2458 visit_type_uint64(v, name, &value, &local_err);
2459 if (local_err) {
2460 error_propagate(errp, local_err);
2461 return;
2462 }
2463
2464 *field = value;
2465}
2466
Markus Armbruster70251882020-05-05 17:29:14 +02002467ObjectProperty *
2468object_property_add_uint8_ptr(Object *obj, const char *name,
2469 const uint8_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002470 ObjectPropertyFlags flags)
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002471{
2472 ObjectPropertyAccessor *getter = NULL;
2473 ObjectPropertyAccessor *setter = NULL;
2474
2475 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2476 getter = property_get_uint8_ptr;
2477 }
2478
2479 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2480 setter = property_set_uint8_ptr;
2481 }
2482
Markus Armbruster70251882020-05-05 17:29:14 +02002483 return object_property_add(obj, name, "uint8",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002484 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002485}
2486
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002487ObjectProperty *
2488object_class_property_add_uint8_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002489 const uint8_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002490 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002491{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002492 ObjectPropertyAccessor *getter = NULL;
2493 ObjectPropertyAccessor *setter = NULL;
2494
2495 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2496 getter = property_get_uint8_ptr;
2497 }
2498
2499 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2500 setter = property_set_uint8_ptr;
2501 }
2502
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002503 return object_class_property_add(klass, name, "uint8",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002504 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002505}
2506
Markus Armbruster70251882020-05-05 17:29:14 +02002507ObjectProperty *
2508object_property_add_uint16_ptr(Object *obj, const char *name,
2509 const uint16_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002510 ObjectPropertyFlags flags)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002511{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002512 ObjectPropertyAccessor *getter = NULL;
2513 ObjectPropertyAccessor *setter = NULL;
2514
2515 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2516 getter = property_get_uint16_ptr;
2517 }
2518
2519 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2520 setter = property_set_uint16_ptr;
2521 }
2522
Markus Armbruster70251882020-05-05 17:29:14 +02002523 return object_property_add(obj, name, "uint16",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002524 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002525}
2526
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002527ObjectProperty *
2528object_class_property_add_uint16_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002529 const uint16_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002530 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002531{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002532 ObjectPropertyAccessor *getter = NULL;
2533 ObjectPropertyAccessor *setter = NULL;
2534
2535 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2536 getter = property_get_uint16_ptr;
2537 }
2538
2539 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2540 setter = property_set_uint16_ptr;
2541 }
2542
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002543 return object_class_property_add(klass, name, "uint16",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002544 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002545}
2546
Markus Armbruster70251882020-05-05 17:29:14 +02002547ObjectProperty *
2548object_property_add_uint32_ptr(Object *obj, const char *name,
2549 const uint32_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002550 ObjectPropertyFlags flags)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002551{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002552 ObjectPropertyAccessor *getter = NULL;
2553 ObjectPropertyAccessor *setter = NULL;
2554
2555 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2556 getter = property_get_uint32_ptr;
2557 }
2558
2559 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2560 setter = property_set_uint32_ptr;
2561 }
2562
Markus Armbruster70251882020-05-05 17:29:14 +02002563 return object_property_add(obj, name, "uint32",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002564 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002565}
2566
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002567ObjectProperty *
2568object_class_property_add_uint32_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002569 const uint32_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002570 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002571{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002572 ObjectPropertyAccessor *getter = NULL;
2573 ObjectPropertyAccessor *setter = NULL;
2574
2575 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2576 getter = property_get_uint32_ptr;
2577 }
2578
2579 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2580 setter = property_set_uint32_ptr;
2581 }
2582
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002583 return object_class_property_add(klass, name, "uint32",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002584 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002585}
2586
Markus Armbruster70251882020-05-05 17:29:14 +02002587ObjectProperty *
2588object_property_add_uint64_ptr(Object *obj, const char *name,
2589 const uint64_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002590 ObjectPropertyFlags flags)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002591{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002592 ObjectPropertyAccessor *getter = NULL;
2593 ObjectPropertyAccessor *setter = NULL;
2594
2595 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2596 getter = property_get_uint64_ptr;
2597 }
2598
2599 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2600 setter = property_set_uint64_ptr;
2601 }
2602
Markus Armbruster70251882020-05-05 17:29:14 +02002603 return object_property_add(obj, name, "uint64",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002604 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002605}
2606
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002607ObjectProperty *
2608object_class_property_add_uint64_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002609 const uint64_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002610 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002611{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002612 ObjectPropertyAccessor *getter = NULL;
2613 ObjectPropertyAccessor *setter = NULL;
2614
2615 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2616 getter = property_get_uint64_ptr;
2617 }
2618
2619 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2620 setter = property_set_uint64_ptr;
2621 }
2622
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002623 return object_class_property_add(klass, name, "uint64",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002624 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002625}
2626
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002627typedef struct {
2628 Object *target_obj;
Eduardo Habkost1590d262015-04-09 16:57:29 -03002629 char *target_name;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002630} AliasProperty;
2631
Eric Blaked7bce992016-01-29 06:48:55 -07002632static void property_get_alias(Object *obj, Visitor *v, const char *name,
2633 void *opaque, Error **errp)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002634{
2635 AliasProperty *prop = opaque;
2636
2637 object_property_get(prop->target_obj, v, prop->target_name, errp);
2638}
2639
Eric Blaked7bce992016-01-29 06:48:55 -07002640static void property_set_alias(Object *obj, Visitor *v, const char *name,
2641 void *opaque, Error **errp)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002642{
2643 AliasProperty *prop = opaque;
2644
2645 object_property_set(prop->target_obj, v, prop->target_name, errp);
2646}
2647
Paolo Bonzini64607d02014-06-05 13:11:51 +02002648static Object *property_resolve_alias(Object *obj, void *opaque,
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02002649 const char *part)
Paolo Bonzini64607d02014-06-05 13:11:51 +02002650{
2651 AliasProperty *prop = opaque;
2652
2653 return object_resolve_path_component(prop->target_obj, prop->target_name);
2654}
2655
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002656static void property_release_alias(Object *obj, const char *name, void *opaque)
2657{
2658 AliasProperty *prop = opaque;
2659
Eduardo Habkost1590d262015-04-09 16:57:29 -03002660 g_free(prop->target_name);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002661 g_free(prop);
2662}
2663
Markus Armbruster70251882020-05-05 17:29:14 +02002664ObjectProperty *
2665object_property_add_alias(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002666 Object *target_obj, const char *target_name)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002667{
2668 AliasProperty *prop;
Paolo Bonzini64607d02014-06-05 13:11:51 +02002669 ObjectProperty *op;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002670 ObjectProperty *target_prop;
Markus Armbruster70251882020-05-05 17:29:14 +02002671 g_autofree char *prop_type = NULL;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002672
Markus Armbrusterd2623122020-05-05 17:29:22 +02002673 target_prop = object_property_find(target_obj, target_name,
2674 &error_abort);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002675
Paolo Bonzinid1906982014-06-10 11:17:35 +02002676 if (object_property_is_child(target_prop)) {
2677 prop_type = g_strdup_printf("link%s",
2678 target_prop->type + strlen("child"));
2679 } else {
2680 prop_type = g_strdup(target_prop->type);
2681 }
2682
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002683 prop = g_malloc(sizeof(*prop));
2684 prop->target_obj = target_obj;
Eduardo Habkost1590d262015-04-09 16:57:29 -03002685 prop->target_name = g_strdup(target_name);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002686
Paolo Bonzinid1906982014-06-10 11:17:35 +02002687 op = object_property_add(obj, name, prop_type,
Paolo Bonzini64607d02014-06-05 13:11:51 +02002688 property_get_alias,
2689 property_set_alias,
2690 property_release_alias,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002691 prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02002692 op->resolve = property_resolve_alias;
Marc-André Lureau0e76ed02020-01-10 19:30:23 +04002693 if (target_prop->defval) {
2694 op->defval = qobject_ref(target_prop->defval);
2695 }
Paolo Bonzinid1906982014-06-10 11:17:35 +02002696
Andreas Färbera18bb412015-03-27 17:34:10 +01002697 object_property_set_description(obj, op->name,
Markus Armbruster7eecec72020-05-05 17:29:15 +02002698 target_prop->description);
Markus Armbruster70251882020-05-05 17:29:14 +02002699 return op;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002700}
2701
Gonglei80742642014-10-07 14:33:21 +08002702void object_property_set_description(Object *obj, const char *name,
Markus Armbruster7eecec72020-05-05 17:29:15 +02002703 const char *description)
Gonglei80742642014-10-07 14:33:21 +08002704{
2705 ObjectProperty *op;
2706
Markus Armbruster7eecec72020-05-05 17:29:15 +02002707 op = object_property_find(obj, name, &error_abort);
Gonglei80742642014-10-07 14:33:21 +08002708 g_free(op->description);
2709 op->description = g_strdup(description);
2710}
2711
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002712void object_class_property_set_description(ObjectClass *klass,
2713 const char *name,
Markus Armbruster7eecec72020-05-05 17:29:15 +02002714 const char *description)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002715{
2716 ObjectProperty *op;
2717
2718 op = g_hash_table_lookup(klass->properties, name);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002719 g_free(op->description);
2720 op->description = g_strdup(description);
2721}
2722
Marc-André Lureau7439a032018-09-06 18:09:32 +04002723static void object_class_init(ObjectClass *klass, void *data)
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002724{
Marc-André Lureau7439a032018-09-06 18:09:32 +04002725 object_class_property_add_str(klass, "type", qdev_get_type,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002726 NULL);
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002727}
2728
Paolo Bonzini745549c2012-03-31 16:45:54 +02002729static void register_types(void)
2730{
2731 static TypeInfo interface_info = {
2732 .name = TYPE_INTERFACE,
Anthony Liguori33e95c62012-08-10 13:16:10 +10002733 .class_size = sizeof(InterfaceClass),
Paolo Bonzini745549c2012-03-31 16:45:54 +02002734 .abstract = true,
2735 };
2736
2737 static TypeInfo object_info = {
2738 .name = TYPE_OBJECT,
2739 .instance_size = sizeof(Object),
Marc-André Lureau7439a032018-09-06 18:09:32 +04002740 .class_init = object_class_init,
Paolo Bonzini745549c2012-03-31 16:45:54 +02002741 .abstract = true,
2742 };
2743
Paolo Bonzini049cb3c2012-04-04 15:58:40 +02002744 type_interface = type_register_internal(&interface_info);
2745 type_register_internal(&object_info);
Paolo Bonzini745549c2012-03-31 16:45:54 +02002746}
2747
2748type_init(register_types)