blob: e5cef30f6d1a8de85bcbd6c33150b24c634c1c51 [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"
Peter Maydell5df022c2022-02-26 18:07:23 +000019#include "qemu/memalign.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010020#include "qapi/visitor.h"
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +010021#include "qapi/string-input-visitor.h"
22#include "qapi/string-output-visitor.h"
Marc-André Lureau0e76ed02020-01-10 19:30:23 +040023#include "qapi/qobject-input-visitor.h"
Paolo Bonzinicbc94d92021-07-18 08:50:44 +020024#include "qapi/forward-visitor.h"
Markus Armbrustereb815e22018-02-11 10:36:05 +010025#include "qapi/qapi-builtin-visit.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010026#include "qapi/qmp/qerror.h"
Marc-André Lureau0e76ed02020-01-10 19:30:23 +040027#include "qapi/qmp/qjson.h"
Paolo Bonzinifa131d92013-05-10 14:16:39 +020028#include "trace.h"
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060029
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +010030/* TODO: replace QObject with a simpler visitor to avoid a dependency
31 * of the QOM core on QObject? */
Paolo Bonzini14cccb62012-12-17 18:19:50 +010032#include "qom/qom-qobject.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010033#include "qapi/qmp/qbool.h"
Markus Armbruster15280c32018-02-01 12:18:36 +010034#include "qapi/qmp/qnum.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010035#include "qapi/qmp/qstring.h"
Philippe Mathieu-Daudée02bdf12019-04-27 15:56:42 +020036#include "qemu/error-report.h"
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +010037
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060038#define MAX_INTERFACES 32
39
40typedef struct InterfaceImpl InterfaceImpl;
41typedef struct TypeImpl TypeImpl;
42
43struct InterfaceImpl
44{
Anthony Liguori33e95c62012-08-10 13:16:10 +100045 const char *typename;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060046};
47
48struct TypeImpl
49{
50 const char *name;
51
52 size_t class_size;
53
54 size_t instance_size;
Richard Henderson4c880f32020-09-15 17:46:34 -070055 size_t instance_align;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060056
57 void (*class_init)(ObjectClass *klass, void *data);
Paolo Bonzini3b50e312012-05-02 13:30:55 +020058 void (*class_base_init)(ObjectClass *klass, void *data);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060059
60 void *class_data;
61
62 void (*instance_init)(Object *obj);
Eduardo Habkost8231c2d2013-07-10 17:08:41 -030063 void (*instance_post_init)(Object *obj);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060064 void (*instance_finalize)(Object *obj);
65
66 bool abstract;
67
68 const char *parent;
69 TypeImpl *parent_type;
70
71 ObjectClass *class;
72
73 int num_interfaces;
74 InterfaceImpl interfaces[MAX_INTERFACES];
75};
76
Paolo Bonzini9970bd82012-02-03 11:51:39 +010077static Type type_interface;
78
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060079static GHashTable *type_table_get(void)
80{
81 static GHashTable *type_table;
82
83 if (type_table == NULL) {
84 type_table = g_hash_table_new(g_str_hash, g_str_equal);
85 }
86
87 return type_table;
88}
89
Hervé Poussineauf54c19c2013-12-03 16:42:00 +010090static bool enumerating_types;
91
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060092static void type_table_add(TypeImpl *ti)
93{
Hervé Poussineauf54c19c2013-12-03 16:42:00 +010094 assert(!enumerating_types);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060095 g_hash_table_insert(type_table_get(), (void *)ti->name, ti);
96}
97
98static TypeImpl *type_table_lookup(const char *name)
99{
100 return g_hash_table_lookup(type_table_get(), name);
101}
102
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100103static TypeImpl *type_new(const TypeInfo *info)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600104{
105 TypeImpl *ti = g_malloc0(sizeof(*ti));
Anthony Liguori33e95c62012-08-10 13:16:10 +1000106 int i;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600107
108 g_assert(info->name != NULL);
109
Anthony Liguori73093352012-01-25 13:37:36 -0600110 if (type_table_lookup(info->name) != NULL) {
111 fprintf(stderr, "Registering `%s' which already exists\n", info->name);
112 abort();
113 }
114
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600115 ti->name = g_strdup(info->name);
116 ti->parent = g_strdup(info->parent);
117
118 ti->class_size = info->class_size;
119 ti->instance_size = info->instance_size;
Richard Henderson4c880f32020-09-15 17:46:34 -0700120 ti->instance_align = info->instance_align;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600121
122 ti->class_init = info->class_init;
Paolo Bonzini3b50e312012-05-02 13:30:55 +0200123 ti->class_base_init = info->class_base_init;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600124 ti->class_data = info->class_data;
125
126 ti->instance_init = info->instance_init;
Eduardo Habkost8231c2d2013-07-10 17:08:41 -0300127 ti->instance_post_init = info->instance_post_init;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600128 ti->instance_finalize = info->instance_finalize;
129
130 ti->abstract = info->abstract;
131
Anthony Liguori33e95c62012-08-10 13:16:10 +1000132 for (i = 0; info->interfaces && info->interfaces[i].type; i++) {
133 ti->interfaces[i].typename = g_strdup(info->interfaces[i].type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600134 }
Anthony Liguori33e95c62012-08-10 13:16:10 +1000135 ti->num_interfaces = i;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600136
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100137 return ti;
138}
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600139
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100140static TypeImpl *type_register_internal(const TypeInfo *info)
141{
142 TypeImpl *ti;
143 ti = type_new(info);
144
145 type_table_add(ti);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600146 return ti;
147}
148
Paolo Bonzini049cb3c2012-04-04 15:58:40 +0200149TypeImpl *type_register(const TypeInfo *info)
150{
151 assert(info->parent);
152 return type_register_internal(info);
153}
154
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600155TypeImpl *type_register_static(const TypeInfo *info)
156{
157 return type_register(info);
158}
159
Igor Mammedovaa04c9d22017-10-09 21:50:49 +0200160void type_register_static_array(const TypeInfo *infos, int nr_infos)
161{
162 int i;
163
164 for (i = 0; i < nr_infos; i++) {
165 type_register_static(&infos[i]);
166 }
167}
168
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600169static TypeImpl *type_get_by_name(const char *name)
170{
171 if (name == NULL) {
172 return NULL;
173 }
174
175 return type_table_lookup(name);
176}
177
178static TypeImpl *type_get_parent(TypeImpl *type)
179{
180 if (!type->parent_type && type->parent) {
181 type->parent_type = type_get_by_name(type->parent);
Philippe Mathieu-Daudé89d337f2020-01-21 12:03:45 +0100182 if (!type->parent_type) {
183 fprintf(stderr, "Type '%s' is missing its parent '%s'\n",
184 type->name, type->parent);
185 abort();
186 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600187 }
188
189 return type->parent_type;
190}
191
192static bool type_has_parent(TypeImpl *type)
193{
194 return (type->parent != NULL);
195}
196
197static size_t type_class_get_size(TypeImpl *ti)
198{
199 if (ti->class_size) {
200 return ti->class_size;
201 }
202
203 if (type_has_parent(ti)) {
204 return type_class_get_size(type_get_parent(ti));
205 }
206
207 return sizeof(ObjectClass);
208}
209
Igor Mitsyankoaca59af2012-02-28 15:57:10 +0400210static size_t type_object_get_size(TypeImpl *ti)
211{
212 if (ti->instance_size) {
213 return ti->instance_size;
214 }
215
216 if (type_has_parent(ti)) {
217 return type_object_get_size(type_get_parent(ti));
218 }
219
220 return 0;
221}
222
Bharata B Rao3f97b532016-06-10 06:29:00 +0530223size_t object_type_get_instance_size(const char *typename)
224{
225 TypeImpl *type = type_get_by_name(typename);
226
227 g_assert(type != NULL);
228 return type_object_get_size(type);
229}
230
Anthony Liguori33e95c62012-08-10 13:16:10 +1000231static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600232{
Anthony Liguori33e95c62012-08-10 13:16:10 +1000233 assert(target_type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600234
Cao jinb30d8052015-11-03 10:36:42 +0800235 /* Check if target_type is a direct ancestor of type */
Anthony Liguori33e95c62012-08-10 13:16:10 +1000236 while (type) {
237 if (type == target_type) {
238 return true;
239 }
240
241 type = type_get_parent(type);
242 }
243
244 return false;
245}
246
247static void type_initialize(TypeImpl *ti);
248
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100249static void type_initialize_interface(TypeImpl *ti, TypeImpl *interface_type,
250 TypeImpl *parent_type)
Anthony Liguori33e95c62012-08-10 13:16:10 +1000251{
252 InterfaceClass *new_iface;
253 TypeInfo info = { };
254 TypeImpl *iface_impl;
255
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100256 info.parent = parent_type->name;
257 info.name = g_strdup_printf("%s::%s", ti->name, interface_type->name);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000258 info.abstract = true;
259
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100260 iface_impl = type_new(&info);
261 iface_impl->parent_type = parent_type;
Anthony Liguori33e95c62012-08-10 13:16:10 +1000262 type_initialize(iface_impl);
263 g_free((char *)info.name);
264
265 new_iface = (InterfaceClass *)iface_impl->class;
266 new_iface->concrete_class = ti->class;
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100267 new_iface->interface_type = interface_type;
Anthony Liguori33e95c62012-08-10 13:16:10 +1000268
Masahiro Yamada3d912932020-05-13 03:25:01 +0900269 ti->class->interfaces = g_slist_append(ti->class->interfaces, new_iface);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600270}
271
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +0100272static void object_property_free(gpointer data)
273{
274 ObjectProperty *prop = data;
275
Marc-André Lureau0e76ed02020-01-10 19:30:23 +0400276 if (prop->defval) {
277 qobject_unref(prop->defval);
278 prop->defval = NULL;
279 }
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +0100280 g_free(prop->name);
281 g_free(prop->type);
282 g_free(prop->description);
283 g_free(prop);
284}
285
Igor Mitsyankoac451032012-02-28 15:57:11 +0400286static void type_initialize(TypeImpl *ti)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600287{
Paolo Bonzini745549c2012-03-31 16:45:54 +0200288 TypeImpl *parent;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600289
290 if (ti->class) {
291 return;
292 }
293
294 ti->class_size = type_class_get_size(ti);
Igor Mitsyankoaca59af2012-02-28 15:57:10 +0400295 ti->instance_size = type_object_get_size(ti);
Eduardo Habkost1c6d75d2016-12-12 16:31:01 -0200296 /* Any type with zero instance_size is implicitly abstract.
297 * This means interface types are all abstract.
298 */
299 if (ti->instance_size == 0) {
300 ti->abstract = true;
301 }
Marc-André Lureau422ca142018-09-12 16:53:03 +0400302 if (type_is_ancestor(ti, type_interface)) {
303 assert(ti->instance_size == 0);
304 assert(ti->abstract);
305 assert(!ti->instance_init);
306 assert(!ti->instance_post_init);
307 assert(!ti->instance_finalize);
308 assert(!ti->num_interfaces);
309 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600310 ti->class = g_malloc0(ti->class_size);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600311
Paolo Bonzini745549c2012-03-31 16:45:54 +0200312 parent = type_get_parent(ti);
313 if (parent) {
Igor Mitsyankoac451032012-02-28 15:57:11 +0400314 type_initialize(parent);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000315 GSList *e;
316 int i;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600317
Markus Armbruster719a3072018-06-08 19:02:31 +0200318 g_assert(parent->class_size <= ti->class_size);
Marc-André Lureaud5e633f2020-01-10 19:30:14 +0400319 g_assert(parent->instance_size <= ti->instance_size);
Paolo Bonzini745549c2012-03-31 16:45:54 +0200320 memcpy(ti->class, parent->class, parent->class_size);
Peter Crosthwaite3e407de2013-02-19 14:02:09 +1000321 ti->class->interfaces = NULL;
Anthony Liguori33e95c62012-08-10 13:16:10 +1000322
323 for (e = parent->class->interfaces; e; e = e->next) {
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100324 InterfaceClass *iface = e->data;
325 ObjectClass *klass = OBJECT_CLASS(iface);
326
327 type_initialize_interface(ti, iface->interface_type, klass->type);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000328 }
329
330 for (i = 0; i < ti->num_interfaces; i++) {
331 TypeImpl *t = type_get_by_name(ti->interfaces[i].typename);
Philippe Mathieu-Daudéa9ee3a92020-01-18 17:23:48 +0100332 if (!t) {
333 error_report("missing interface '%s' for object '%s'",
334 ti->interfaces[i].typename, parent->name);
335 abort();
336 }
Anthony Liguori33e95c62012-08-10 13:16:10 +1000337 for (e = ti->class->interfaces; e; e = e->next) {
338 TypeImpl *target_type = OBJECT_CLASS(e->data)->type;
339
340 if (type_is_ancestor(target_type, t)) {
341 break;
342 }
343 }
344
345 if (e) {
346 continue;
347 }
348
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100349 type_initialize_interface(ti, t, t);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000350 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600351 }
352
Masahiro Yamadae5a0cc52020-05-13 02:26:15 +0900353 ti->class->properties = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
354 object_property_free);
355
Paolo Bonzini745549c2012-03-31 16:45:54 +0200356 ti->class->type = ti;
357
358 while (parent) {
359 if (parent->class_base_init) {
360 parent->class_base_init(ti->class, ti->class_data);
361 }
362 parent = type_get_parent(parent);
363 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600364
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600365 if (ti->class_init) {
366 ti->class_init(ti->class, ti->class_data);
367 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600368}
369
370static void object_init_with_type(Object *obj, TypeImpl *ti)
371{
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600372 if (type_has_parent(ti)) {
373 object_init_with_type(obj, type_get_parent(ti));
374 }
375
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600376 if (ti->instance_init) {
377 ti->instance_init(obj);
378 }
379}
380
Eduardo Habkost8231c2d2013-07-10 17:08:41 -0300381static void object_post_init_with_type(Object *obj, TypeImpl *ti)
382{
383 if (ti->instance_post_init) {
384 ti->instance_post_init(obj);
385 }
386
387 if (type_has_parent(ti)) {
388 object_post_init_with_type(obj, type_get_parent(ti));
389 }
390}
391
Markus Armbruster6fd5bef2020-07-07 18:05:55 +0200392bool object_apply_global_props(Object *obj, const GPtrArray *props,
393 Error **errp)
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400394{
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400395 int i;
396
397 if (!props) {
Markus Armbruster6fd5bef2020-07-07 18:05:55 +0200398 return true;
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400399 }
400
401 for (i = 0; i < props->len; i++) {
402 GlobalProperty *p = g_ptr_array_index(props, i);
Eduardo Habkostd769f0d2019-01-10 00:02:57 -0200403 Error *err = NULL;
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400404
405 if (object_dynamic_cast(obj, p->driver) == NULL) {
406 continue;
407 }
Daniel P. Berrangéefba1592020-09-14 14:56:17 +0100408 if (p->optional && !object_property_find(obj, p->property)) {
Dr. David Alan Gilbert92fd4532019-07-29 17:29:02 +0100409 continue;
410 }
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400411 p->used = true;
Markus Armbruster778a2dc2020-07-07 18:05:56 +0200412 if (!object_property_parse(obj, p->property, p->value, &err)) {
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400413 error_prepend(&err, "can't apply global %s.%s=%s: ",
414 p->driver, p->property, p->value);
Marc-André Lureau50545b22018-11-07 15:35:34 +0400415 /*
416 * If errp != NULL, propagate error and return.
417 * If errp == NULL, report a warning, but keep going
418 * with the remaining globals.
419 */
420 if (errp) {
421 error_propagate(errp, err);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +0200422 return false;
Marc-André Lureau50545b22018-11-07 15:35:34 +0400423 } else {
424 warn_report_err(err);
425 }
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400426 }
427 }
Markus Armbruster6fd5bef2020-07-07 18:05:55 +0200428
429 return true;
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400430}
431
Markus Armbruster617902a2019-03-08 14:14:35 +0100432/*
433 * Global property defaults
434 * Slot 0: accelerator's global property defaults
435 * Slot 1: machine's global property defaults
Paolo Bonzini1fff3c22019-11-13 13:33:44 +0100436 * Slot 2: global properties from legacy command line option
Markus Armbruster617902a2019-03-08 14:14:35 +0100437 * Each is a GPtrArray of of GlobalProperty.
438 * Applied in order, later entries override earlier ones.
439 */
Paolo Bonzini1fff3c22019-11-13 13:33:44 +0100440static GPtrArray *object_compat_props[3];
441
442/*
443 * Retrieve @GPtrArray for global property defined with options
444 * other than "-global". These are generally used for syntactic
445 * sugar and legacy command line options.
446 */
Greg Kurza8dc82c2020-08-14 09:24:50 +0200447void object_register_sugar_prop(const char *driver, const char *prop,
448 const char *value, bool optional)
Paolo Bonzini1fff3c22019-11-13 13:33:44 +0100449{
450 GlobalProperty *g;
451 if (!object_compat_props[2]) {
452 object_compat_props[2] = g_ptr_array_new();
453 }
454 g = g_new0(GlobalProperty, 1);
455 g->driver = g_strdup(driver);
456 g->property = g_strdup(prop);
457 g->value = g_strdup(value);
Greg Kurza8dc82c2020-08-14 09:24:50 +0200458 g->optional = optional;
Paolo Bonzini1fff3c22019-11-13 13:33:44 +0100459 g_ptr_array_add(object_compat_props[2], g);
460}
Markus Armbruster617902a2019-03-08 14:14:35 +0100461
462/*
463 * Set machine's global property defaults to @compat_props.
464 * May be called at most once.
465 */
466void object_set_machine_compat_props(GPtrArray *compat_props)
467{
468 assert(!object_compat_props[1]);
469 object_compat_props[1] = compat_props;
470}
471
472/*
473 * Set accelerator's global property defaults to @compat_props.
474 * May be called at most once.
475 */
476void object_set_accelerator_compat_props(GPtrArray *compat_props)
477{
478 assert(!object_compat_props[0]);
479 object_compat_props[0] = compat_props;
480}
481
482void object_apply_compat_props(Object *obj)
483{
484 int i;
485
486 for (i = 0; i < ARRAY_SIZE(object_compat_props); i++) {
487 object_apply_global_props(obj, object_compat_props[i],
Paolo Bonzini1fff3c22019-11-13 13:33:44 +0100488 i == 2 ? &error_fatal : &error_abort);
Markus Armbruster617902a2019-03-08 14:14:35 +0100489 }
490}
491
Marc-André Lureau2a1be4b2020-01-10 19:30:19 +0400492static void object_class_property_init_all(Object *obj)
493{
494 ObjectPropertyIterator iter;
495 ObjectProperty *prop;
496
497 object_class_property_iter_init(&iter, object_get_class(obj));
498 while ((prop = object_property_iter_next(&iter))) {
499 if (prop->init) {
500 prop->init(obj, prop);
501 }
502 }
503}
504
Masahiro Yamadae27a9592020-05-13 02:31:04 +0900505static void object_initialize_with_type(Object *obj, size_t size, TypeImpl *type)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600506{
Igor Mitsyankoac451032012-02-28 15:57:11 +0400507 type_initialize(type);
Igor Mitsyankoaca59af2012-02-28 15:57:10 +0400508
Markus Armbruster719a3072018-06-08 19:02:31 +0200509 g_assert(type->instance_size >= sizeof(Object));
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600510 g_assert(type->abstract == false);
Markus Armbruster719a3072018-06-08 19:02:31 +0200511 g_assert(size >= type->instance_size);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600512
513 memset(obj, 0, type->instance_size);
514 obj->class = type->class;
Paolo Bonzini764b6312012-11-23 09:47:12 +0100515 object_ref(obj);
Marc-André Lureau2a1be4b2020-01-10 19:30:19 +0400516 object_class_property_init_all(obj);
Pavel Fedinb604a852015-10-13 13:37:45 +0100517 obj->properties = g_hash_table_new_full(g_str_hash, g_str_equal,
518 NULL, object_property_free);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600519 object_init_with_type(obj, type);
Eduardo Habkost8231c2d2013-07-10 17:08:41 -0300520 object_post_init_with_type(obj, type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600521}
522
Andreas Färber213f0c42013-08-23 19:37:12 +0200523void object_initialize(void *data, size_t size, const char *typename)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600524{
525 TypeImpl *type = type_get_by_name(typename);
526
Gerd Hoffmann64f7aec2020-09-14 15:42:22 +0200527#ifdef CONFIG_MODULES
528 if (!type) {
529 module_load_qom_one(typename);
530 type = type_get_by_name(typename);
531 }
532#endif
Philippe Mathieu-Daudée02bdf12019-04-27 15:56:42 +0200533 if (!type) {
534 error_report("missing object type '%s'", typename);
535 abort();
536 }
537
Andreas Färber5b9237f2013-08-30 18:28:37 +0200538 object_initialize_with_type(data, size, type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600539}
540
Markus Armbruster6fd5bef2020-07-07 18:05:55 +0200541bool object_initialize_child_with_props(Object *parentobj,
542 const char *propname,
543 void *childobj, size_t size,
544 const char *type,
545 Error **errp, ...)
Thomas Huth0210b392018-07-16 14:59:18 +0200546{
547 va_list vargs;
Markus Armbruster6fd5bef2020-07-07 18:05:55 +0200548 bool ok;
Thomas Huth0210b392018-07-16 14:59:18 +0200549
550 va_start(vargs, errp);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +0200551 ok = object_initialize_child_with_propsv(parentobj, propname,
552 childobj, size, type, errp,
553 vargs);
Thomas Huth0210b392018-07-16 14:59:18 +0200554 va_end(vargs);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +0200555 return ok;
Thomas Huth0210b392018-07-16 14:59:18 +0200556}
557
Markus Armbruster6fd5bef2020-07-07 18:05:55 +0200558bool object_initialize_child_with_propsv(Object *parentobj,
559 const char *propname,
560 void *childobj, size_t size,
561 const char *type,
562 Error **errp, va_list vargs)
Thomas Huth0210b392018-07-16 14:59:18 +0200563{
Markus Armbruster6fd5bef2020-07-07 18:05:55 +0200564 bool ok = false;
Thomas Huth0210b392018-07-16 14:59:18 +0200565 Object *obj;
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400566 UserCreatable *uc;
Thomas Huth0210b392018-07-16 14:59:18 +0200567
568 object_initialize(childobj, size, type);
569 obj = OBJECT(childobj);
570
Markus Armbrusterb783f542020-07-07 18:05:58 +0200571 if (!object_set_propv(obj, errp, vargs)) {
Thomas Huth0210b392018-07-16 14:59:18 +0200572 goto out;
573 }
574
Markus Armbrusterd2623122020-05-05 17:29:22 +0200575 object_property_add_child(parentobj, propname, obj);
Thomas Huth0210b392018-07-16 14:59:18 +0200576
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400577 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
578 if (uc) {
Markus Armbruster992861f2020-07-07 18:06:04 +0200579 if (!user_creatable_complete(uc, errp)) {
Thomas Huth0210b392018-07-16 14:59:18 +0200580 object_unparent(obj);
581 goto out;
582 }
583 }
584
Markus Armbruster6fd5bef2020-07-07 18:05:55 +0200585 ok = true;
586
Markus Armbruster975ac452020-05-05 17:29:09 +0200587out:
Thomas Huth0210b392018-07-16 14:59:18 +0200588 /*
Markus Armbruster975ac452020-05-05 17:29:09 +0200589 * We want @obj's reference to be 1 on success, 0 on failure.
590 * On success, it's 2: one taken by object_initialize(), and one
591 * by object_property_add_child().
592 * On failure in object_initialize() or earlier, it's 1.
593 * On failure afterwards, it's also 1: object_unparent() releases
594 * the reference taken by object_property_add_child().
Thomas Huth0210b392018-07-16 14:59:18 +0200595 */
596 object_unref(obj);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +0200597 return ok;
Thomas Huth0210b392018-07-16 14:59:18 +0200598}
599
Markus Armbruster9fc7fc42020-06-10 07:32:25 +0200600void object_initialize_child_internal(Object *parent,
601 const char *propname,
602 void *child, size_t size,
603 const char *type)
604{
605 object_initialize_child_with_props(parent, propname, child, size, type,
606 &error_abort, NULL);
607}
608
Andreas Färber5d9d3f42012-05-27 00:32:40 +0200609static inline bool object_property_is_child(ObjectProperty *prop)
610{
611 return strstart(prop->type, "child<", NULL);
612}
613
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600614static void object_property_del_all(Object *obj)
615{
Marc-André Lureau9859fac2020-01-10 19:30:30 +0400616 g_autoptr(GHashTable) done = g_hash_table_new(NULL, NULL);
Pavel Fedinb604a852015-10-13 13:37:45 +0100617 ObjectProperty *prop;
Marc-André Lureau9859fac2020-01-10 19:30:30 +0400618 ObjectPropertyIterator iter;
Pavel Fedinb604a852015-10-13 13:37:45 +0100619 bool released;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600620
Pavel Fedinb604a852015-10-13 13:37:45 +0100621 do {
622 released = false;
Marc-André Lureau9859fac2020-01-10 19:30:30 +0400623 object_property_iter_init(&iter, obj);
624 while ((prop = object_property_iter_next(&iter)) != NULL) {
625 if (g_hash_table_add(done, prop)) {
626 if (prop->release) {
627 prop->release(obj, prop->name, prop->opaque);
628 released = true;
629 break;
630 }
Pavel Fedinb604a852015-10-13 13:37:45 +0100631 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600632 }
Pavel Fedinb604a852015-10-13 13:37:45 +0100633 } while (released);
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600634
Pavel Fedinb604a852015-10-13 13:37:45 +0100635 g_hash_table_unref(obj->properties);
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600636}
637
Markus Armbrusterf73a32a2020-05-05 17:29:11 +0200638static void object_property_del_child(Object *obj, Object *child)
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600639{
640 ObjectProperty *prop;
Pavel Fedinb604a852015-10-13 13:37:45 +0100641 GHashTableIter iter;
642 gpointer key, value;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600643
Pavel Fedinb604a852015-10-13 13:37:45 +0100644 g_hash_table_iter_init(&iter, obj->properties);
645 while (g_hash_table_iter_next(&iter, &key, &value)) {
646 prop = value;
Andreas Färber5d9d3f42012-05-27 00:32:40 +0200647 if (object_property_is_child(prop) && prop->opaque == child) {
Pavel Fedinb604a852015-10-13 13:37:45 +0100648 if (prop->release) {
649 prop->release(obj, prop->name, prop->opaque);
650 prop->release = NULL;
651 }
652 break;
653 }
654 }
655 g_hash_table_iter_init(&iter, obj->properties);
656 while (g_hash_table_iter_next(&iter, &key, &value)) {
657 prop = value;
658 if (object_property_is_child(prop) && prop->opaque == child) {
659 g_hash_table_iter_remove(&iter);
Paolo Bonzini6c1fdcf2012-02-28 09:54:15 +0100660 break;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600661 }
662 }
663}
664
665void object_unparent(Object *obj)
666{
Michael S. Tsirkine998fa82013-03-18 21:01:37 +0200667 if (obj->parent) {
Markus Armbrusterf73a32a2020-05-05 17:29:11 +0200668 object_property_del_child(obj->parent, obj);
Michael S. Tsirkine998fa82013-03-18 21:01:37 +0200669 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600670}
671
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600672static void object_deinit(Object *obj, TypeImpl *type)
673{
674 if (type->instance_finalize) {
675 type->instance_finalize(obj);
676 }
677
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600678 if (type_has_parent(type)) {
679 object_deinit(obj, type_get_parent(type));
680 }
681}
682
Paolo Bonzini339c2702012-11-23 09:47:16 +0100683static void object_finalize(void *data)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600684{
685 Object *obj = data;
686 TypeImpl *ti = obj->class->type;
687
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600688 object_property_del_all(obj);
Paolo Bonzini76a6e1c2014-06-11 11:58:30 +0200689 object_deinit(obj, ti);
Anthony Liguoridb85b572011-12-23 08:47:39 -0600690
Markus Armbruster719a3072018-06-08 19:02:31 +0200691 g_assert(obj->ref == 0);
Eduardo Habkost63f957a2020-12-15 17:41:33 -0500692 g_assert(obj->parent == NULL);
Paolo Bonzinifde9bf42012-11-23 09:47:14 +0100693 if (obj->free) {
694 obj->free(obj);
695 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600696}
697
Richard Henderson4c880f32020-09-15 17:46:34 -0700698/* Find the minimum alignment guaranteed by the system malloc. */
699#if __STDC_VERSION__ >= 201112L
Doug Evans3a2e9822021-02-12 00:56:30 +0000700typedef max_align_t qemu_max_align_t;
Richard Henderson4c880f32020-09-15 17:46:34 -0700701#else
702typedef union {
703 long l;
704 void *p;
705 double d;
706 long double ld;
707} qemu_max_align_t;
708#endif
709
Marc-André Lureau63f7b102016-12-12 20:31:51 +0300710static Object *object_new_with_type(Type type)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600711{
712 Object *obj;
Richard Henderson4c880f32020-09-15 17:46:34 -0700713 size_t size, align;
714 void (*obj_free)(void *);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600715
716 g_assert(type != NULL);
Igor Mitsyankoac451032012-02-28 15:57:11 +0400717 type_initialize(type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600718
Richard Henderson4c880f32020-09-15 17:46:34 -0700719 size = type->instance_size;
720 align = type->instance_align;
721
722 /*
723 * Do not use qemu_memalign unless required. Depending on the
724 * implementation, extra alignment implies extra overhead.
725 */
726 if (likely(align <= __alignof__(qemu_max_align_t))) {
727 obj = g_malloc(size);
728 obj_free = g_free;
729 } else {
730 obj = qemu_memalign(align, size);
731 obj_free = qemu_vfree;
732 }
733
734 object_initialize_with_type(obj, size, type);
735 obj->free = obj_free;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600736
737 return obj;
738}
739
Paolo Bonzini3c75e122019-11-13 13:57:55 +0100740Object *object_new_with_class(ObjectClass *klass)
741{
742 return object_new_with_type(klass->type);
743}
744
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600745Object *object_new(const char *typename)
746{
747 TypeImpl *ti = type_get_by_name(typename);
748
749 return object_new_with_type(ti);
750}
751
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100752
753Object *object_new_with_props(const char *typename,
754 Object *parent,
755 const char *id,
756 Error **errp,
757 ...)
758{
759 va_list vargs;
760 Object *obj;
761
762 va_start(vargs, errp);
763 obj = object_new_with_propv(typename, parent, id, errp, vargs);
764 va_end(vargs);
765
766 return obj;
767}
768
769
770Object *object_new_with_propv(const char *typename,
771 Object *parent,
772 const char *id,
773 Error **errp,
774 va_list vargs)
775{
776 Object *obj;
777 ObjectClass *klass;
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400778 UserCreatable *uc;
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100779
780 klass = object_class_by_name(typename);
781 if (!klass) {
782 error_setg(errp, "invalid object type: %s", typename);
783 return NULL;
784 }
785
786 if (object_class_is_abstract(klass)) {
787 error_setg(errp, "object type '%s' is abstract", typename);
788 return NULL;
789 }
Wei Yang66e11552019-03-11 16:32:34 +0800790 obj = object_new_with_type(klass->type);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100791
Markus Armbrusterb783f542020-07-07 18:05:58 +0200792 if (!object_set_propv(obj, errp, vargs)) {
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100793 goto error;
794 }
795
Daniel P. Berrangé6134d752018-06-15 16:39:35 +0100796 if (id != NULL) {
Markus Armbrusterd2623122020-05-05 17:29:22 +0200797 object_property_add_child(parent, id, obj);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100798 }
799
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400800 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
801 if (uc) {
Markus Armbruster992861f2020-07-07 18:06:04 +0200802 if (!user_creatable_complete(uc, errp)) {
Daniel P. Berrangé6134d752018-06-15 16:39:35 +0100803 if (id != NULL) {
804 object_unparent(obj);
805 }
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100806 goto error;
807 }
808 }
809
Philippe Mathieu-Daudé688ffbb2020-05-12 09:00:19 +0200810 object_unref(obj);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100811 return obj;
812
813 error:
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100814 object_unref(obj);
815 return NULL;
816}
817
818
Markus Armbrusterb783f542020-07-07 18:05:58 +0200819bool object_set_props(Object *obj,
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100820 Error **errp,
821 ...)
822{
823 va_list vargs;
Markus Armbrusterb783f542020-07-07 18:05:58 +0200824 bool ret;
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100825
826 va_start(vargs, errp);
827 ret = object_set_propv(obj, errp, vargs);
828 va_end(vargs);
829
830 return ret;
831}
832
833
Markus Armbrusterb783f542020-07-07 18:05:58 +0200834bool object_set_propv(Object *obj,
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100835 Error **errp,
836 va_list vargs)
837{
838 const char *propname;
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100839
840 propname = va_arg(vargs, char *);
841 while (propname != NULL) {
842 const char *value = va_arg(vargs, char *);
843
844 g_assert(value != NULL);
Markus Armbruster668f62e2020-07-07 18:06:02 +0200845 if (!object_property_parse(obj, propname, value, errp)) {
Markus Armbrusterb783f542020-07-07 18:05:58 +0200846 return false;
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100847 }
848 propname = va_arg(vargs, char *);
849 }
850
Markus Armbrusterb783f542020-07-07 18:05:58 +0200851 return true;
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100852}
853
854
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600855Object *object_dynamic_cast(Object *obj, const char *typename)
856{
Paolo Bonzinib7f43fe2012-11-23 16:56:17 +0100857 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
Paolo Bonziniacc4af32012-02-03 11:57:23 +0100858 return obj;
859 }
860
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600861 return NULL;
862}
863
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200864Object *object_dynamic_cast_assert(Object *obj, const char *typename,
865 const char *file, int line, const char *func)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600866{
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200867 trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
868 typename, file, line, func);
869
Paolo Bonzini3556c232013-05-10 14:16:40 +0200870#ifdef CONFIG_QOM_CAST_DEBUG
Anthony Liguori03587322013-05-13 15:22:24 -0500871 int i;
872 Object *inst;
873
Peter Crosthwaite95916ab2013-05-22 11:19:16 +1000874 for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
Stefan Hajnoczid73415a2020-09-23 11:56:46 +0100875 if (qatomic_read(&obj->class->object_cast_cache[i]) == typename) {
Anthony Liguori03587322013-05-13 15:22:24 -0500876 goto out;
877 }
878 }
879
880 inst = object_dynamic_cast(obj, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600881
Paolo Bonzinib7f43fe2012-11-23 16:56:17 +0100882 if (!inst && obj) {
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200883 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
884 file, line, func, obj, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600885 abort();
886 }
887
Paolo Bonzini3556c232013-05-10 14:16:40 +0200888 assert(obj == inst);
Anthony Liguori03587322013-05-13 15:22:24 -0500889
Peter Crosthwaite95916ab2013-05-22 11:19:16 +1000890 if (obj && obj == inst) {
Anthony Liguori03587322013-05-13 15:22:24 -0500891 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
Stefan Hajnoczid73415a2020-09-23 11:56:46 +0100892 qatomic_set(&obj->class->object_cast_cache[i - 1],
893 qatomic_read(&obj->class->object_cast_cache[i]));
Anthony Liguori03587322013-05-13 15:22:24 -0500894 }
Stefan Hajnoczid73415a2020-09-23 11:56:46 +0100895 qatomic_set(&obj->class->object_cast_cache[i - 1], typename);
Anthony Liguori03587322013-05-13 15:22:24 -0500896 }
897
898out:
Paolo Bonzini3556c232013-05-10 14:16:40 +0200899#endif
900 return obj;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600901}
902
903ObjectClass *object_class_dynamic_cast(ObjectClass *class,
904 const char *typename)
905{
Anthony Liguori33e95c62012-08-10 13:16:10 +1000906 ObjectClass *ret = NULL;
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200907 TypeImpl *target_type;
908 TypeImpl *type;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600909
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200910 if (!class) {
911 return NULL;
912 }
913
Paolo Bonzini793c96b2013-05-10 14:16:37 +0200914 /* A simple fast path that can trigger a lot for leaf classes. */
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200915 type = class->type;
Paolo Bonzini793c96b2013-05-10 14:16:37 +0200916 if (type->name == typename) {
917 return class;
918 }
919
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200920 target_type = type_get_by_name(typename);
Alexander Graf9ab880b2013-04-30 15:02:16 +0200921 if (!target_type) {
922 /* target class type unknown, so fail the cast */
923 return NULL;
924 }
925
Peter Crosthwaite00e2cea2013-02-19 14:02:10 +1000926 if (type->class->interfaces &&
927 type_is_ancestor(target_type, type_interface)) {
Anthony Liguori33e95c62012-08-10 13:16:10 +1000928 int found = 0;
929 GSList *i;
930
931 for (i = class->interfaces; i; i = i->next) {
932 ObjectClass *target_class = i->data;
933
934 if (type_is_ancestor(target_class->type, target_type)) {
935 ret = target_class;
936 found++;
937 }
938 }
939
940 /* The match was ambiguous, don't allow a cast */
941 if (found > 1) {
942 ret = NULL;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600943 }
Anthony Liguori33e95c62012-08-10 13:16:10 +1000944 } else if (type_is_ancestor(type, target_type)) {
945 ret = class;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600946 }
947
Anthony Liguori33e95c62012-08-10 13:16:10 +1000948 return ret;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600949}
950
951ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200952 const char *typename,
953 const char *file, int line,
954 const char *func)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600955{
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200956 ObjectClass *ret;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600957
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200958 trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)",
959 typename, file, line, func);
960
Anthony Liguori03587322013-05-13 15:22:24 -0500961#ifdef CONFIG_QOM_CAST_DEBUG
962 int i;
963
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000964 for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
Stefan Hajnoczid73415a2020-09-23 11:56:46 +0100965 if (qatomic_read(&class->class_cast_cache[i]) == typename) {
Anthony Liguori03587322013-05-13 15:22:24 -0500966 ret = class;
967 goto out;
968 }
969 }
970#else
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000971 if (!class || !class->interfaces) {
Paolo Bonzini3556c232013-05-10 14:16:40 +0200972 return class;
973 }
974#endif
975
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200976 ret = object_class_dynamic_cast(class, typename);
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200977 if (!ret && class) {
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200978 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
979 file, line, func, class, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600980 abort();
981 }
982
Anthony Liguori03587322013-05-13 15:22:24 -0500983#ifdef CONFIG_QOM_CAST_DEBUG
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000984 if (class && ret == class) {
Anthony Liguori03587322013-05-13 15:22:24 -0500985 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
Stefan Hajnoczid73415a2020-09-23 11:56:46 +0100986 qatomic_set(&class->class_cast_cache[i - 1],
987 qatomic_read(&class->class_cast_cache[i]));
Anthony Liguori03587322013-05-13 15:22:24 -0500988 }
Stefan Hajnoczid73415a2020-09-23 11:56:46 +0100989 qatomic_set(&class->class_cast_cache[i - 1], typename);
Anthony Liguori03587322013-05-13 15:22:24 -0500990 }
991out:
992#endif
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600993 return ret;
994}
995
Igor Mammedov8f5d58e2017-07-14 10:14:50 +0800996const char *object_get_typename(const Object *obj)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600997{
998 return obj->class->type->name;
999}
1000
1001ObjectClass *object_get_class(Object *obj)
1002{
1003 return obj->class;
1004}
1005
Andreas Färber17862372013-01-23 12:20:18 +01001006bool object_class_is_abstract(ObjectClass *klass)
1007{
1008 return klass->type->abstract;
1009}
1010
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001011const char *object_class_get_name(ObjectClass *klass)
1012{
1013 return klass->type->name;
1014}
1015
1016ObjectClass *object_class_by_name(const char *typename)
1017{
1018 TypeImpl *type = type_get_by_name(typename);
1019
1020 if (!type) {
1021 return NULL;
1022 }
1023
Igor Mitsyankoac451032012-02-28 15:57:11 +04001024 type_initialize(type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001025
1026 return type->class;
1027}
1028
Gerd Hoffmann0f8198f2020-06-24 15:10:37 +02001029ObjectClass *module_object_class_by_name(const char *typename)
1030{
1031 ObjectClass *oc;
1032
1033 oc = object_class_by_name(typename);
1034#ifdef CONFIG_MODULES
1035 if (!oc) {
1036 module_load_qom_one(typename);
1037 oc = object_class_by_name(typename);
1038 }
1039#endif
1040 return oc;
1041}
1042
Paolo Bonzinie7cce672012-05-02 13:30:54 +02001043ObjectClass *object_class_get_parent(ObjectClass *class)
1044{
1045 TypeImpl *type = type_get_parent(class->type);
1046
1047 if (!type) {
1048 return NULL;
1049 }
1050
1051 type_initialize(type);
1052
1053 return type->class;
1054}
1055
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001056typedef struct OCFData
1057{
1058 void (*fn)(ObjectClass *klass, void *opaque);
Anthony Liguori93c511a2011-12-22 14:11:53 -06001059 const char *implements_type;
1060 bool include_abstract;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001061 void *opaque;
1062} OCFData;
1063
1064static void object_class_foreach_tramp(gpointer key, gpointer value,
1065 gpointer opaque)
1066{
1067 OCFData *data = opaque;
1068 TypeImpl *type = value;
Anthony Liguori93c511a2011-12-22 14:11:53 -06001069 ObjectClass *k;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001070
Igor Mitsyankoac451032012-02-28 15:57:11 +04001071 type_initialize(type);
Anthony Liguori93c511a2011-12-22 14:11:53 -06001072 k = type->class;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001073
Anthony Liguori93c511a2011-12-22 14:11:53 -06001074 if (!data->include_abstract && type->abstract) {
1075 return;
1076 }
1077
1078 if (data->implements_type &&
1079 !object_class_dynamic_cast(k, data->implements_type)) {
1080 return;
1081 }
1082
1083 data->fn(k, data->opaque);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001084}
1085
1086void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
Anthony Liguori93c511a2011-12-22 14:11:53 -06001087 const char *implements_type, bool include_abstract,
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001088 void *opaque)
1089{
Anthony Liguori93c511a2011-12-22 14:11:53 -06001090 OCFData data = { fn, implements_type, include_abstract, opaque };
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001091
Hervé Poussineauf54c19c2013-12-03 16:42:00 +01001092 enumerating_types = true;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001093 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
Hervé Poussineauf54c19c2013-12-03 16:42:00 +01001094 enumerating_types = false;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -06001095}
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001096
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001097static int do_object_child_foreach(Object *obj,
1098 int (*fn)(Object *child, void *opaque),
1099 void *opaque, bool recurse)
Paolo Bonzini32efc532012-04-11 23:30:20 +02001100{
Pavel Fedinb604a852015-10-13 13:37:45 +01001101 GHashTableIter iter;
1102 ObjectProperty *prop;
Paolo Bonzini32efc532012-04-11 23:30:20 +02001103 int ret = 0;
1104
Pavel Fedinb604a852015-10-13 13:37:45 +01001105 g_hash_table_iter_init(&iter, obj->properties);
1106 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Paolo Bonzini32efc532012-04-11 23:30:20 +02001107 if (object_property_is_child(prop)) {
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001108 Object *child = prop->opaque;
1109
1110 ret = fn(child, opaque);
Paolo Bonzini32efc532012-04-11 23:30:20 +02001111 if (ret != 0) {
1112 break;
1113 }
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001114 if (recurse) {
Cédric Le Goater4a391812020-04-04 17:33:40 +02001115 ret = do_object_child_foreach(child, fn, opaque, true);
1116 if (ret != 0) {
1117 break;
1118 }
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001119 }
Paolo Bonzini32efc532012-04-11 23:30:20 +02001120 }
1121 }
1122 return ret;
1123}
1124
Peter Crosthwaited714b8d2015-09-08 17:38:43 +01001125int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
1126 void *opaque)
1127{
1128 return do_object_child_foreach(obj, fn, opaque, false);
1129}
1130
1131int object_child_foreach_recursive(Object *obj,
1132 int (*fn)(Object *child, void *opaque),
1133 void *opaque)
1134{
1135 return do_object_child_foreach(obj, fn, opaque, true);
1136}
1137
Andreas Färber418ba9e2012-02-25 23:07:34 +01001138static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
1139{
1140 GSList **list = opaque;
1141
1142 *list = g_slist_prepend(*list, klass);
1143}
1144
1145GSList *object_class_get_list(const char *implements_type,
1146 bool include_abstract)
1147{
1148 GSList *list = NULL;
1149
1150 object_class_foreach(object_class_get_list_tramp,
1151 implements_type, include_abstract, &list);
1152 return list;
1153}
1154
Paolo Bonzini47c66002018-03-03 08:33:10 +01001155static gint object_class_cmp(gconstpointer a, gconstpointer b)
1156{
1157 return strcasecmp(object_class_get_name((ObjectClass *)a),
1158 object_class_get_name((ObjectClass *)b));
1159}
1160
1161GSList *object_class_get_list_sorted(const char *implements_type,
1162 bool include_abstract)
1163{
1164 return g_slist_sort(object_class_get_list(implements_type, include_abstract),
1165 object_class_cmp);
1166}
1167
Daniel P. Berrangéc5a61e52020-08-31 17:07:23 -04001168Object *object_ref(void *objptr)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001169{
Daniel P. Berrangéc5a61e52020-08-31 17:07:23 -04001170 Object *obj = OBJECT(objptr);
Michael S. Tsirkine3682872022-02-25 08:40:27 -05001171 uint32_t ref;
1172
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001173 if (!obj) {
Marc-André Lureaub77ade92020-01-10 19:30:31 +04001174 return NULL;
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001175 }
Michael S. Tsirkine3682872022-02-25 08:40:27 -05001176 ref = qatomic_fetch_inc(&obj->ref);
1177 /* Assert waaay before the integer overflows */
1178 g_assert(ref < INT_MAX);
Marc-André Lureaub77ade92020-01-10 19:30:31 +04001179 return obj;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001180}
1181
Daniel P. Berrangéc5a61e52020-08-31 17:07:23 -04001182void object_unref(void *objptr)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001183{
Daniel P. Berrangéc5a61e52020-08-31 17:07:23 -04001184 Object *obj = OBJECT(objptr);
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001185 if (!obj) {
1186 return;
1187 }
Markus Armbruster719a3072018-06-08 19:02:31 +02001188 g_assert(obj->ref > 0);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001189
1190 /* parent always holds a reference to its children */
Stefan Hajnoczid73415a2020-09-23 11:56:46 +01001191 if (qatomic_fetch_dec(&obj->ref) == 1) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001192 object_finalize(obj);
1193 }
1194}
1195
Eric Augerdb57fef2020-06-29 21:34:22 +02001196ObjectProperty *
Markus Armbrusterd2623122020-05-05 17:29:22 +02001197object_property_try_add(Object *obj, const char *name, const char *type,
1198 ObjectPropertyAccessor *get,
1199 ObjectPropertyAccessor *set,
1200 ObjectPropertyRelease *release,
1201 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001202{
Peter Maydell54852b02013-03-25 13:15:13 +00001203 ObjectProperty *prop;
Peter Crosthwaite33965902014-08-19 23:55:52 -07001204 size_t name_len = strlen(name);
1205
1206 if (name_len >= 3 && !memcmp(name + name_len - 3, "[*]", 4)) {
1207 int i;
Ani Sinha1bf8b882020-09-21 15:03:25 +05301208 ObjectProperty *ret = NULL;
Peter Crosthwaite33965902014-08-19 23:55:52 -07001209 char *name_no_array = g_strdup(name);
1210
1211 name_no_array[name_len - 3] = '\0';
Ani Sinha1bf8b882020-09-21 15:03:25 +05301212 for (i = 0; i < INT16_MAX; ++i) {
Peter Crosthwaite33965902014-08-19 23:55:52 -07001213 char *full_name = g_strdup_printf("%s[%d]", name_no_array, i);
1214
Markus Armbrusterd2623122020-05-05 17:29:22 +02001215 ret = object_property_try_add(obj, full_name, type, get, set,
1216 release, opaque, NULL);
Peter Crosthwaite33965902014-08-19 23:55:52 -07001217 g_free(full_name);
1218 if (ret) {
1219 break;
1220 }
1221 }
1222 g_free(name_no_array);
Ani Sinha1bf8b882020-09-21 15:03:25 +05301223 assert(ret);
Peter Crosthwaite33965902014-08-19 23:55:52 -07001224 return ret;
1225 }
Peter Maydell54852b02013-03-25 13:15:13 +00001226
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01001227 if (object_property_find(obj, name) != NULL) {
Greg Kurzd55e9372019-11-04 14:23:55 +01001228 error_setg(errp, "attempt to add duplicate property '%s' to object (type '%s')",
1229 name, object_get_typename(obj));
Pavel Fedinb604a852015-10-13 13:37:45 +01001230 return NULL;
Peter Maydell54852b02013-03-25 13:15:13 +00001231 }
1232
1233 prop = g_malloc0(sizeof(*prop));
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001234
1235 prop->name = g_strdup(name);
1236 prop->type = g_strdup(type);
1237
1238 prop->get = get;
1239 prop->set = set;
1240 prop->release = release;
1241 prop->opaque = opaque;
1242
Pavel Fedinb604a852015-10-13 13:37:45 +01001243 g_hash_table_insert(obj->properties, prop->name, prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001244 return prop;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001245}
1246
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001247ObjectProperty *
Markus Armbrusterd2623122020-05-05 17:29:22 +02001248object_property_add(Object *obj, const char *name, const char *type,
1249 ObjectPropertyAccessor *get,
1250 ObjectPropertyAccessor *set,
1251 ObjectPropertyRelease *release,
1252 void *opaque)
1253{
1254 return object_property_try_add(obj, name, type, get, set, release,
1255 opaque, &error_abort);
1256}
1257
1258ObjectProperty *
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001259object_class_property_add(ObjectClass *klass,
1260 const char *name,
1261 const char *type,
1262 ObjectPropertyAccessor *get,
1263 ObjectPropertyAccessor *set,
1264 ObjectPropertyRelease *release,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001265 void *opaque)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001266{
1267 ObjectProperty *prop;
1268
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01001269 assert(!object_class_property_find(klass, name));
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001270
1271 prop = g_malloc0(sizeof(*prop));
1272
1273 prop->name = g_strdup(name);
1274 prop->type = g_strdup(type);
1275
1276 prop->get = get;
1277 prop->set = set;
1278 prop->release = release;
1279 prop->opaque = opaque;
1280
Marc-André Lureauba806ff2020-01-10 19:30:18 +04001281 g_hash_table_insert(klass->properties, prop->name, prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001282
1283 return prop;
1284}
1285
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01001286ObjectProperty *object_property_find(Object *obj, const char *name)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001287{
1288 ObjectProperty *prop;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001289 ObjectClass *klass = object_get_class(obj);
1290
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01001291 prop = object_class_property_find(klass, name);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001292 if (prop) {
1293 return prop;
1294 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001295
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01001296 return g_hash_table_lookup(obj->properties, name);
1297}
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001298
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01001299ObjectProperty *object_property_find_err(Object *obj, const char *name,
1300 Error **errp)
1301{
1302 ObjectProperty *prop = object_property_find(obj, name);
1303 if (!prop) {
Philippe Mathieu-Daudé4d9c7c82020-09-20 17:53:40 +02001304 error_setg(errp, "Property '%s.%s' not found",
1305 object_get_typename(obj), name);
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01001306 }
1307 return prop;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001308}
1309
Daniel P. Berrange7746abd2015-12-09 12:34:02 +00001310void object_property_iter_init(ObjectPropertyIterator *iter,
1311 Object *obj)
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001312{
Daniel P. Berrange7746abd2015-12-09 12:34:02 +00001313 g_hash_table_iter_init(&iter->iter, obj->properties);
1314 iter->nextclass = object_get_class(obj);
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001315}
1316
1317ObjectProperty *object_property_iter_next(ObjectPropertyIterator *iter)
1318{
Pavel Fedinb604a852015-10-13 13:37:45 +01001319 gpointer key, val;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001320 while (!g_hash_table_iter_next(&iter->iter, &key, &val)) {
1321 if (!iter->nextclass) {
1322 return NULL;
1323 }
1324 g_hash_table_iter_init(&iter->iter, iter->nextclass->properties);
1325 iter->nextclass = object_class_get_parent(iter->nextclass);
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001326 }
Pavel Fedinb604a852015-10-13 13:37:45 +01001327 return val;
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001328}
1329
Alexey Kardashevskiy961c47b2018-03-02 00:09:39 +11001330void object_class_property_iter_init(ObjectPropertyIterator *iter,
1331 ObjectClass *klass)
1332{
1333 g_hash_table_iter_init(&iter->iter, klass->properties);
Marc-André Lureau684546d2018-09-06 17:37:36 +04001334 iter->nextclass = object_class_get_parent(klass);
Alexey Kardashevskiy961c47b2018-03-02 00:09:39 +11001335}
1336
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01001337ObjectProperty *object_class_property_find(ObjectClass *klass, const char *name)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001338{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001339 ObjectClass *parent_klass;
1340
1341 parent_klass = object_class_get_parent(klass);
1342 if (parent_klass) {
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01001343 ObjectProperty *prop =
1344 object_class_property_find(parent_klass, name);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001345 if (prop) {
1346 return prop;
1347 }
1348 }
1349
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01001350 return g_hash_table_lookup(klass->properties, name);
1351}
1352
1353ObjectProperty *object_class_property_find_err(ObjectClass *klass,
1354 const char *name,
1355 Error **errp)
1356{
1357 ObjectProperty *prop = object_class_property_find(klass, name);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001358 if (!prop) {
1359 error_setg(errp, "Property '.%s' not found", name);
1360 }
1361 return prop;
1362}
1363
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01001364
Markus Armbrusterdf4fe0b2020-05-05 17:29:26 +02001365void object_property_del(Object *obj, const char *name)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001366{
Pavel Fedinb604a852015-10-13 13:37:45 +01001367 ObjectProperty *prop = g_hash_table_lookup(obj->properties, name);
1368
Anthony Liguori0866aca2011-12-23 15:34:39 -06001369 if (prop->release) {
1370 prop->release(obj, name, prop->opaque);
1371 }
Pavel Fedinb604a852015-10-13 13:37:45 +01001372 g_hash_table_remove(obj->properties, name);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001373}
1374
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001375bool object_property_get(Object *obj, const char *name, Visitor *v,
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001376 Error **errp)
1377{
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001378 Error *err = NULL;
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01001379 ObjectProperty *prop = object_property_find_err(obj, name, errp);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001380
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001381 if (prop == NULL) {
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001382 return false;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001383 }
1384
1385 if (!prop->get) {
Markus Armbruster3f7febc2022-10-12 17:37:58 +02001386 error_setg(errp, "Property '%s.%s' is not readable",
1387 object_get_typename(obj), name);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001388 return false;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001389 }
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001390 prop->get(obj, v, name, prop->opaque, &err);
1391 error_propagate(errp, err);
1392 return !err;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001393}
1394
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001395bool object_property_set(Object *obj, const char *name, Visitor *v,
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001396 Error **errp)
1397{
Kevin Wolfdbc82212021-10-08 15:34:31 +02001398 ERRP_GUARD();
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01001399 ObjectProperty *prop = object_property_find_err(obj, name, errp);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001400
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001401 if (prop == NULL) {
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001402 return false;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001403 }
1404
1405 if (!prop->set) {
Markus Armbruster3f7febc2022-10-12 17:37:58 +02001406 error_setg(errp, "Property '%s.%s' is not writable",
1407 object_get_typename(obj), name);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001408 return false;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001409 }
Kevin Wolfdbc82212021-10-08 15:34:31 +02001410 prop->set(obj, v, name, prop->opaque, errp);
1411 return !*errp;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001412}
1413
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001414bool object_property_set_str(Object *obj, const char *name,
Markus Armbruster5325cc32020-07-07 18:05:54 +02001415 const char *value, Error **errp)
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001416{
1417 QString *qstr = qstring_from_str(value);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001418 bool ok = object_property_set_qobject(obj, name, QOBJECT(qstr), errp);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001419
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001420 qobject_unref(qstr);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001421 return ok;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001422}
1423
1424char *object_property_get_str(Object *obj, const char *name,
1425 Error **errp)
1426{
1427 QObject *ret = object_property_get_qobject(obj, name, errp);
Markus Armbruster26c52822020-12-11 18:11:43 +01001428 QString *qstring;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001429 char *retval;
1430
1431 if (!ret) {
1432 return NULL;
1433 }
Markus Armbruster26c52822020-12-11 18:11:43 +01001434 qstring = qobject_to(QString, ret);
1435 if (!qstring) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001436 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
Markus Armbruster26c52822020-12-11 18:11:43 +01001437 retval = NULL;
1438 } else {
1439 retval = g_strdup(qstring_get_str(qstring));
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001440 }
1441
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001442 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001443 return retval;
1444}
1445
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001446bool object_property_set_link(Object *obj, const char *name,
Markus Armbruster5325cc32020-07-07 18:05:54 +02001447 Object *value, Error **errp)
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001448{
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001449 g_autofree char *path = NULL;
1450
Peter Crosthwaited3c49312014-09-25 22:19:19 -07001451 if (value) {
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001452 path = object_get_canonical_path(value);
Peter Crosthwaited3c49312014-09-25 22:19:19 -07001453 }
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001454 return object_property_set_str(obj, name, path ?: "", errp);
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001455}
1456
1457Object *object_property_get_link(Object *obj, const char *name,
1458 Error **errp)
1459{
1460 char *str = object_property_get_str(obj, name, errp);
1461 Object *target = NULL;
1462
1463 if (str && *str) {
1464 target = object_resolve_path(str, NULL);
1465 if (!target) {
Markus Armbruster75158eb2015-03-16 08:57:47 +01001466 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1467 "Device '%s' not found", str);
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001468 }
1469 }
1470
1471 g_free(str);
1472 return target;
1473}
1474
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001475bool object_property_set_bool(Object *obj, const char *name,
Markus Armbruster5325cc32020-07-07 18:05:54 +02001476 bool value, Error **errp)
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001477{
Eric Blakefc48ffc2015-05-15 16:24:59 -06001478 QBool *qbool = qbool_from_bool(value);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001479 bool ok = object_property_set_qobject(obj, name, QOBJECT(qbool), errp);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001480
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001481 qobject_unref(qbool);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001482 return ok;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001483}
1484
1485bool object_property_get_bool(Object *obj, const char *name,
1486 Error **errp)
1487{
1488 QObject *ret = object_property_get_qobject(obj, name, errp);
1489 QBool *qbool;
1490 bool retval;
1491
1492 if (!ret) {
1493 return false;
1494 }
Max Reitz7dc847e2018-02-24 16:40:29 +01001495 qbool = qobject_to(QBool, ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001496 if (!qbool) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001497 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001498 retval = false;
1499 } else {
Eric Blakefc48ffc2015-05-15 16:24:59 -06001500 retval = qbool_get_bool(qbool);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001501 }
1502
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001503 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001504 return retval;
1505}
1506
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001507bool object_property_set_int(Object *obj, const char *name,
Markus Armbruster5325cc32020-07-07 18:05:54 +02001508 int64_t value, Error **errp)
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001509{
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001510 QNum *qnum = qnum_from_int(value);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001511 bool ok = object_property_set_qobject(obj, name, QOBJECT(qnum), errp);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001512
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001513 qobject_unref(qnum);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001514 return ok;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001515}
1516
1517int64_t object_property_get_int(Object *obj, const char *name,
1518 Error **errp)
1519{
1520 QObject *ret = object_property_get_qobject(obj, name, errp);
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001521 QNum *qnum;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001522 int64_t retval;
1523
1524 if (!ret) {
1525 return -1;
1526 }
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001527
Max Reitz7dc847e2018-02-24 16:40:29 +01001528 qnum = qobject_to(QNum, ret);
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001529 if (!qnum || !qnum_get_try_int(qnum, &retval)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001530 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001531 retval = -1;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001532 }
1533
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001534 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001535 return retval;
1536}
1537
Marc-André Lureau0e76ed02020-01-10 19:30:23 +04001538static void object_property_init_defval(Object *obj, ObjectProperty *prop)
1539{
1540 Visitor *v = qobject_input_visitor_new(prop->defval);
1541
1542 assert(prop->set != NULL);
1543 prop->set(obj, v, prop->name, prop->opaque, &error_abort);
1544
1545 visit_free(v);
1546}
1547
1548static void object_property_set_default(ObjectProperty *prop, QObject *defval)
1549{
1550 assert(!prop->defval);
1551 assert(!prop->init);
1552
1553 prop->defval = defval;
1554 prop->init = object_property_init_defval;
1555}
1556
1557void object_property_set_default_bool(ObjectProperty *prop, bool value)
1558{
1559 object_property_set_default(prop, QOBJECT(qbool_from_bool(value)));
1560}
1561
1562void object_property_set_default_str(ObjectProperty *prop, const char *value)
1563{
1564 object_property_set_default(prop, QOBJECT(qstring_from_str(value)));
1565}
1566
1567void object_property_set_default_int(ObjectProperty *prop, int64_t value)
1568{
1569 object_property_set_default(prop, QOBJECT(qnum_from_int(value)));
1570}
1571
1572void object_property_set_default_uint(ObjectProperty *prop, uint64_t value)
1573{
1574 object_property_set_default(prop, QOBJECT(qnum_from_uint(value)));
1575}
1576
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001577bool object_property_set_uint(Object *obj, const char *name,
Markus Armbruster5325cc32020-07-07 18:05:54 +02001578 uint64_t value, Error **errp)
Marc-André Lureau31527792017-06-07 20:36:04 +04001579{
1580 QNum *qnum = qnum_from_uint(value);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001581 bool ok = object_property_set_qobject(obj, name, QOBJECT(qnum), errp);
Marc-André Lureau31527792017-06-07 20:36:04 +04001582
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001583 qobject_unref(qnum);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001584 return ok;
Marc-André Lureau31527792017-06-07 20:36:04 +04001585}
1586
1587uint64_t object_property_get_uint(Object *obj, const char *name,
1588 Error **errp)
1589{
1590 QObject *ret = object_property_get_qobject(obj, name, errp);
1591 QNum *qnum;
1592 uint64_t retval;
1593
1594 if (!ret) {
1595 return 0;
1596 }
Max Reitz7dc847e2018-02-24 16:40:29 +01001597 qnum = qobject_to(QNum, ret);
Marc-André Lureau31527792017-06-07 20:36:04 +04001598 if (!qnum || !qnum_get_try_uint(qnum, &retval)) {
1599 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "uint");
1600 retval = 0;
1601 }
1602
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001603 qobject_unref(ret);
Marc-André Lureau31527792017-06-07 20:36:04 +04001604 return retval;
1605}
1606
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01001607typedef struct EnumProperty {
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02001608 const QEnumLookup *lookup;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01001609 int (*get)(Object *, Error **);
1610 void (*set)(Object *, int, Error **);
1611} EnumProperty;
1612
Hu Tao1f217722014-05-14 17:43:33 +08001613int object_property_get_enum(Object *obj, const char *name,
Daniel P. Berrangea3590da2015-05-27 16:07:56 +01001614 const char *typename, Error **errp)
Hu Tao1f217722014-05-14 17:43:33 +08001615{
Chen Fan976620a2014-08-18 14:46:34 +08001616 char *str;
Hu Tao1f217722014-05-14 17:43:33 +08001617 int ret;
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01001618 ObjectProperty *prop = object_property_find_err(obj, name, errp);
Daniel P. Berrangea3590da2015-05-27 16:07:56 +01001619 EnumProperty *enumprop;
1620
1621 if (prop == NULL) {
Markus Armbrusterd20f6162020-09-17 14:55:39 +02001622 return -1;
Daniel P. Berrangea3590da2015-05-27 16:07:56 +01001623 }
1624
1625 if (!g_str_equal(prop->type, typename)) {
1626 error_setg(errp, "Property %s on %s is not '%s' enum type",
1627 name, object_class_get_name(
1628 object_get_class(obj)), typename);
Markus Armbrusterd20f6162020-09-17 14:55:39 +02001629 return -1;
Daniel P. Berrangea3590da2015-05-27 16:07:56 +01001630 }
1631
1632 enumprop = prop->opaque;
Hu Tao1f217722014-05-14 17:43:33 +08001633
Markus Armbrusterb555f892020-05-05 17:29:12 +02001634 str = object_property_get_str(obj, name, errp);
1635 if (!str) {
Markus Armbrusterd20f6162020-09-17 14:55:39 +02001636 return -1;
Markus Armbruster4715d422015-08-25 20:00:45 +02001637 }
Chen Fan976620a2014-08-18 14:46:34 +08001638
Markus Armbrusterea097df2020-04-24 10:43:36 +02001639 ret = qapi_enum_parse(enumprop->lookup, str, -1, errp);
Chen Fan976620a2014-08-18 14:46:34 +08001640 g_free(str);
Hu Tao1f217722014-05-14 17:43:33 +08001641
1642 return ret;
1643}
1644
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001645bool object_property_parse(Object *obj, const char *name,
Markus Armbruster5325cc32020-07-07 18:05:54 +02001646 const char *string, Error **errp)
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001647{
Eric Blake7a0525c2016-06-09 10:48:37 -06001648 Visitor *v = string_input_visitor_new(string);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001649 bool ok = object_property_set(obj, name, v, errp);
1650
Eric Blake7a0525c2016-06-09 10:48:37 -06001651 visit_free(v);
Markus Armbruster6fd5bef2020-07-07 18:05:55 +02001652 return ok;
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001653}
1654
Paolo Bonzini0b7593e2014-02-08 11:01:50 +01001655char *object_property_print(Object *obj, const char *name, bool human,
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001656 Error **errp)
1657{
Eric Blake3b098d52016-06-09 10:48:43 -06001658 Visitor *v;
Gonglei3a530092014-09-27 13:13:55 +08001659 char *string = NULL;
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001660
Eric Blake3b098d52016-06-09 10:48:43 -06001661 v = string_output_visitor_new(human, &string);
Markus Armbrusteraf175e82020-07-07 18:06:03 +02001662 if (!object_property_get(obj, name, v, errp)) {
Gonglei3a530092014-09-27 13:13:55 +08001663 goto out;
1664 }
1665
Eric Blake3b098d52016-06-09 10:48:43 -06001666 visit_complete(v, &string);
Gonglei3a530092014-09-27 13:13:55 +08001667
1668out:
Eric Blake3b098d52016-06-09 10:48:43 -06001669 visit_free(v);
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001670 return string;
1671}
1672
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001673const char *object_property_get_type(Object *obj, const char *name, Error **errp)
1674{
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01001675 ObjectProperty *prop = object_property_find_err(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001676 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001677 return NULL;
1678 }
1679
1680 return prop->type;
1681}
1682
1683Object *object_get_root(void)
1684{
Anthony Liguori8b45d442011-12-23 09:08:05 -06001685 static Object *root;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001686
Anthony Liguori8b45d442011-12-23 09:08:05 -06001687 if (!root) {
1688 root = object_new("container");
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001689 }
1690
Anthony Liguori8b45d442011-12-23 09:08:05 -06001691 return root;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001692}
1693
Daniel P. Berrangebc2256c2015-05-13 17:14:05 +01001694Object *object_get_objects_root(void)
1695{
1696 return container_get(object_get_root(), "/objects");
1697}
1698
Peter Xu7c47c4e2017-09-28 10:59:54 +08001699Object *object_get_internal_root(void)
1700{
1701 static Object *internal_root;
1702
1703 if (!internal_root) {
1704 internal_root = object_new("container");
1705 }
1706
1707 return internal_root;
1708}
1709
Eric Blaked7bce992016-01-29 06:48:55 -07001710static void object_get_child_property(Object *obj, Visitor *v,
1711 const char *name, void *opaque,
1712 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001713{
1714 Object *child = opaque;
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001715 char *path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001716
1717 path = object_get_canonical_path(child);
Eric Blake51e72bc2016-01-29 06:48:54 -07001718 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001719 g_free(path);
1720}
1721
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001722static Object *object_resolve_child_property(Object *parent, void *opaque,
1723 const char *part)
Paolo Bonzini64607d02014-06-05 13:11:51 +02001724{
1725 return opaque;
1726}
1727
Anthony Liguoridb85b572011-12-23 08:47:39 -06001728static void object_finalize_child_property(Object *obj, const char *name,
1729 void *opaque)
1730{
1731 Object *child = opaque;
1732
Paolo Bonzinibffc6872014-06-11 11:57:38 +02001733 if (child->class->unparent) {
1734 (child->class->unparent)(child);
1735 }
1736 child->parent = NULL;
Anthony Liguoridb85b572011-12-23 08:47:39 -06001737 object_unref(child);
1738}
1739
Markus Armbruster70251882020-05-05 17:29:14 +02001740ObjectProperty *
Eric Augerdb57fef2020-06-29 21:34:22 +02001741object_property_try_add_child(Object *obj, const char *name,
1742 Object *child, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001743{
Markus Armbruster70251882020-05-05 17:29:14 +02001744 g_autofree char *type = NULL;
Paolo Bonzini64607d02014-06-05 13:11:51 +02001745 ObjectProperty *op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001746
Markus Armbrusterd2623122020-05-05 17:29:22 +02001747 assert(!child->parent);
Peter Crosthwaite8faa2f82014-09-25 22:19:52 -07001748
Philippe Mathieu-Daudé688ffbb2020-05-12 09:00:19 +02001749 type = g_strdup_printf("child<%s>", object_get_typename(child));
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001750
Eric Augerdb57fef2020-06-29 21:34:22 +02001751 op = object_property_try_add(obj, name, type, object_get_child_property,
1752 NULL, object_finalize_child_property,
1753 child, errp);
1754 if (!op) {
1755 return NULL;
1756 }
Paolo Bonzini64607d02014-06-05 13:11:51 +02001757 op->resolve = object_resolve_child_property;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001758 object_ref(child);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001759 child->parent = obj;
Markus Armbruster70251882020-05-05 17:29:14 +02001760 return op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001761}
1762
Eric Augerdb57fef2020-06-29 21:34:22 +02001763ObjectProperty *
1764object_property_add_child(Object *obj, const char *name,
1765 Object *child)
1766{
1767 return object_property_try_add_child(obj, name, child, &error_abort);
1768}
1769
Igor Mammedov8f5d58e2017-07-14 10:14:50 +08001770void object_property_allow_set_link(const Object *obj, const char *name,
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001771 Object *val, Error **errp)
1772{
1773 /* Allow the link to be set, always */
1774}
1775
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001776typedef struct {
Marc-André Lureau9941d372020-01-10 19:30:27 +04001777 union {
1778 Object **targetp;
1779 Object *target; /* if OBJ_PROP_LINK_DIRECT, when holding the pointer */
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001780 ptrdiff_t offset; /* if OBJ_PROP_LINK_CLASS */
Marc-André Lureau9941d372020-01-10 19:30:27 +04001781 };
Igor Mammedov8f5d58e2017-07-14 10:14:50 +08001782 void (*check)(const Object *, const char *, Object *, Error **);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001783 ObjectPropertyLinkFlags flags;
1784} LinkProperty;
1785
Marc-André Lureau9941d372020-01-10 19:30:27 +04001786static Object **
1787object_link_get_targetp(Object *obj, LinkProperty *lprop)
1788{
1789 if (lprop->flags & OBJ_PROP_LINK_DIRECT) {
1790 return &lprop->target;
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001791 } else if (lprop->flags & OBJ_PROP_LINK_CLASS) {
1792 return (void *)obj + lprop->offset;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001793 } else {
1794 return lprop->targetp;
1795 }
1796}
1797
Eric Blaked7bce992016-01-29 06:48:55 -07001798static void object_get_link_property(Object *obj, Visitor *v,
1799 const char *name, void *opaque,
1800 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001801{
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001802 LinkProperty *lprop = opaque;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001803 Object **targetp = object_link_get_targetp(obj, lprop);
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001804 char *path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001805
Marc-André Lureau36854202020-01-10 19:30:26 +04001806 if (*targetp) {
1807 path = object_get_canonical_path(*targetp);
Eric Blake51e72bc2016-01-29 06:48:54 -07001808 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001809 g_free(path);
1810 } else {
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001811 path = (char *)"";
Eric Blake51e72bc2016-01-29 06:48:54 -07001812 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001813 }
1814}
1815
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001816/*
1817 * object_resolve_link:
1818 *
1819 * Lookup an object and ensure its type matches the link property type. This
1820 * is similar to object_resolve_path() except type verification against the
1821 * link property is performed.
1822 *
1823 * Returns: The matched object or NULL on path lookup failures.
1824 */
1825static Object *object_resolve_link(Object *obj, const char *name,
1826 const char *path, Error **errp)
1827{
1828 const char *type;
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001829 char *target_type;
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001830 bool ambiguous = false;
1831 Object *target;
1832
1833 /* Go from link<FOO> to FOO. */
1834 type = object_property_get_type(obj, name, NULL);
1835 target_type = g_strndup(&type[5], strlen(type) - 6);
1836 target = object_resolve_path_type(path, target_type, &ambiguous);
1837
1838 if (ambiguous) {
Eric Blake455b0fd2015-11-10 23:51:20 -07001839 error_setg(errp, "Path '%s' does not uniquely identify an object",
1840 path);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001841 } else if (!target) {
1842 target = object_resolve_path(path, &ambiguous);
1843 if (target || ambiguous) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001844 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001845 } else {
Markus Armbruster75158eb2015-03-16 08:57:47 +01001846 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1847 "Device '%s' not found", path);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001848 }
1849 target = NULL;
1850 }
1851 g_free(target_type);
1852
1853 return target;
1854}
1855
Eric Blaked7bce992016-01-29 06:48:55 -07001856static void object_set_link_property(Object *obj, Visitor *v,
1857 const char *name, void *opaque,
1858 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001859{
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001860 Error *local_err = NULL;
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001861 LinkProperty *prop = opaque;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001862 Object **targetp = object_link_get_targetp(obj, prop);
Marc-André Lureau36854202020-01-10 19:30:26 +04001863 Object *old_target = *targetp;
Markus Armbruster1c94a352020-07-07 18:05:53 +02001864 Object *new_target;
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001865 char *path = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001866
Markus Armbruster1c94a352020-07-07 18:05:53 +02001867 if (!visit_type_str(v, name, &path, errp)) {
1868 return;
1869 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001870
Markus Armbruster1c94a352020-07-07 18:05:53 +02001871 if (*path) {
1872 new_target = object_resolve_link(obj, name, path, errp);
1873 if (!new_target) {
1874 g_free(path);
1875 return;
1876 }
1877 } else {
1878 new_target = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001879 }
1880
1881 g_free(path);
Alexander Barabashf0cdc962012-02-22 19:22:26 +02001882
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001883 prop->check(obj, name, new_target, &local_err);
1884 if (local_err) {
1885 error_propagate(errp, local_err);
1886 return;
1887 }
1888
Marc-André Lureau36854202020-01-10 19:30:26 +04001889 *targetp = new_target;
Marc-André Lureau8770baf2020-01-10 19:30:25 +04001890 if (prop->flags & OBJ_PROP_LINK_STRONG) {
Marc-André Lureau265b5782018-05-31 21:51:17 +02001891 object_ref(new_target);
1892 object_unref(old_target);
1893 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001894}
1895
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001896static Object *object_resolve_link_property(Object *parent, void *opaque,
1897 const char *part)
Paolo Bonzini64607d02014-06-05 13:11:51 +02001898{
1899 LinkProperty *lprop = opaque;
1900
Marc-André Lureau9941d372020-01-10 19:30:27 +04001901 return *object_link_get_targetp(parent, lprop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001902}
1903
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001904static void object_release_link_property(Object *obj, const char *name,
1905 void *opaque)
1906{
1907 LinkProperty *prop = opaque;
Marc-André Lureau9941d372020-01-10 19:30:27 +04001908 Object **targetp = object_link_get_targetp(obj, prop);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001909
Marc-André Lureau9941d372020-01-10 19:30:27 +04001910 if ((prop->flags & OBJ_PROP_LINK_STRONG) && *targetp) {
1911 object_unref(*targetp);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001912 }
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001913 if (!(prop->flags & OBJ_PROP_LINK_CLASS)) {
1914 g_free(prop);
1915 }
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001916}
1917
Markus Armbruster70251882020-05-05 17:29:14 +02001918static ObjectProperty *
1919object_add_link_prop(Object *obj, const char *name,
1920 const char *type, void *ptr,
1921 void (*check)(const Object *, const char *,
1922 Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02001923 ObjectPropertyLinkFlags flags)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001924{
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001925 LinkProperty *prop = g_malloc(sizeof(*prop));
Markus Armbruster70251882020-05-05 17:29:14 +02001926 g_autofree char *full_type = NULL;
Paolo Bonzini64607d02014-06-05 13:11:51 +02001927 ObjectProperty *op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001928
Marc-André Lureau4a8d5792020-01-10 19:30:28 +04001929 if (flags & OBJ_PROP_LINK_DIRECT) {
1930 prop->target = ptr;
1931 } else {
1932 prop->targetp = ptr;
1933 }
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001934 prop->check = check;
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001935 prop->flags = flags;
1936
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001937 full_type = g_strdup_printf("link<%s>", type);
1938
Paolo Bonzini64607d02014-06-05 13:11:51 +02001939 op = object_property_add(obj, name, full_type,
1940 object_get_link_property,
1941 check ? object_set_link_property : NULL,
1942 object_release_link_property,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001943 prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001944 op->resolve = object_resolve_link_property;
Markus Armbruster70251882020-05-05 17:29:14 +02001945 return op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001946}
1947
Markus Armbruster70251882020-05-05 17:29:14 +02001948ObjectProperty *
1949object_property_add_link(Object *obj, const char *name,
1950 const char *type, Object **targetp,
1951 void (*check)(const Object *, const char *,
1952 Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02001953 ObjectPropertyLinkFlags flags)
Marc-André Lureau4a8d5792020-01-10 19:30:28 +04001954{
Markus Armbrusterd2623122020-05-05 17:29:22 +02001955 return object_add_link_prop(obj, name, type, targetp, check, flags);
Marc-André Lureau4a8d5792020-01-10 19:30:28 +04001956}
1957
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001958ObjectProperty *
1959object_class_property_add_link(ObjectClass *oc,
1960 const char *name,
1961 const char *type, ptrdiff_t offset,
1962 void (*check)(const Object *obj, const char *name,
1963 Object *val, Error **errp),
Markus Armbrusterd2623122020-05-05 17:29:22 +02001964 ObjectPropertyLinkFlags flags)
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001965{
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001966 LinkProperty *prop = g_new0(LinkProperty, 1);
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02001967 char *full_type;
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001968 ObjectProperty *op;
1969
1970 prop->offset = offset;
1971 prop->check = check;
1972 prop->flags = flags | OBJ_PROP_LINK_CLASS;
1973
1974 full_type = g_strdup_printf("link<%s>", type);
1975
1976 op = object_class_property_add(oc, name, full_type,
1977 object_get_link_property,
1978 check ? object_set_link_property : NULL,
1979 object_release_link_property,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001980 prop);
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001981
1982 op->resolve = object_resolve_link_property;
1983
Marc-André Lureau840ecdf2020-01-10 19:30:29 +04001984 g_free(full_type);
1985 return op;
1986}
1987
Markus Armbruster70251882020-05-05 17:29:14 +02001988ObjectProperty *
1989object_property_add_const_link(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001990 Object *target)
Paolo Bonzinifb9e7e32015-05-05 18:29:00 +02001991{
Markus Armbruster70251882020-05-05 17:29:14 +02001992 return object_add_link_prop(obj, name,
1993 object_get_typename(target), target,
Markus Armbrusterd2623122020-05-05 17:29:22 +02001994 NULL, OBJ_PROP_LINK_DIRECT);
Paolo Bonzinifb9e7e32015-05-05 18:29:00 +02001995}
1996
Markus Armbruster7a309cc2020-07-14 18:02:00 +02001997const char *object_get_canonical_path_component(const Object *obj)
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001998{
1999 ObjectProperty *prop = NULL;
Pavel Fedinb604a852015-10-13 13:37:45 +01002000 GHashTableIter iter;
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01002001
Paolo Bonzini770dec22018-04-30 11:44:17 +02002002 if (obj->parent == NULL) {
2003 return NULL;
2004 }
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01002005
Pavel Fedinb604a852015-10-13 13:37:45 +01002006 g_hash_table_iter_init(&iter, obj->parent->properties);
2007 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01002008 if (!object_property_is_child(prop)) {
2009 continue;
2010 }
2011
2012 if (prop->opaque == obj) {
Markus Armbruster7a309cc2020-07-14 18:02:00 +02002013 return prop->name;
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01002014 }
2015 }
2016
2017 /* obj had a parent but was not a child, should never happen */
2018 g_assert_not_reached();
2019 return NULL;
2020}
2021
Markus Armbrustere8512df2020-05-27 10:47:53 +02002022char *object_get_canonical_path(const Object *obj)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002023{
2024 Object *root = object_get_root();
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01002025 char *newpath, *path = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002026
Paolo Bonzinie40077f2018-05-30 18:16:04 +02002027 if (obj == root) {
2028 return g_strdup("/");
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002029 }
2030
Paolo Bonzinie40077f2018-05-30 18:16:04 +02002031 do {
Markus Armbruster7a309cc2020-07-14 18:02:00 +02002032 const char *component = object_get_canonical_path_component(obj);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002033
Paolo Bonzinie40077f2018-05-30 18:16:04 +02002034 if (!component) {
2035 /* A canonical path must be complete, so discard what was
2036 * collected so far.
2037 */
2038 g_free(path);
2039 return NULL;
2040 }
2041
2042 newpath = g_strdup_printf("/%s%s", component, path ? path : "");
2043 g_free(path);
Paolo Bonzinie40077f2018-05-30 18:16:04 +02002044 path = newpath;
2045 obj = obj->parent;
2046 } while (obj != root);
2047
2048 return path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002049}
2050
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02002051Object *object_resolve_path_component(Object *parent, const char *part)
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02002052{
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01002053 ObjectProperty *prop = object_property_find(parent, part);
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02002054 if (prop == NULL) {
2055 return NULL;
2056 }
2057
Paolo Bonzini64607d02014-06-05 13:11:51 +02002058 if (prop->resolve) {
2059 return prop->resolve(parent, prop->opaque, part);
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02002060 } else {
2061 return NULL;
2062 }
2063}
2064
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002065static Object *object_resolve_abs_path(Object *parent,
Masahiro Yamadaad195c82020-05-10 10:32:35 +09002066 char **parts,
2067 const char *typename)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002068{
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002069 Object *child;
2070
Masahiro Yamadaad195c82020-05-10 10:32:35 +09002071 if (*parts == NULL) {
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002072 return object_dynamic_cast(parent, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002073 }
2074
Masahiro Yamadaad195c82020-05-10 10:32:35 +09002075 if (strcmp(*parts, "") == 0) {
2076 return object_resolve_abs_path(parent, parts + 1, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002077 }
2078
Masahiro Yamadaad195c82020-05-10 10:32:35 +09002079 child = object_resolve_path_component(parent, *parts);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002080 if (!child) {
2081 return NULL;
2082 }
2083
Masahiro Yamadaad195c82020-05-10 10:32:35 +09002084 return object_resolve_abs_path(child, parts + 1, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002085}
2086
2087static Object *object_resolve_partial_path(Object *parent,
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02002088 char **parts,
2089 const char *typename,
2090 bool *ambiguous)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002091{
2092 Object *obj;
Pavel Fedinb604a852015-10-13 13:37:45 +01002093 GHashTableIter iter;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002094 ObjectProperty *prop;
2095
Masahiro Yamadaad195c82020-05-10 10:32:35 +09002096 obj = object_resolve_abs_path(parent, parts, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002097
Pavel Fedinb604a852015-10-13 13:37:45 +01002098 g_hash_table_iter_init(&iter, parent->properties);
2099 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002100 Object *found;
2101
Andreas Färber5d9d3f42012-05-27 00:32:40 +02002102 if (!object_property_is_child(prop)) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002103 continue;
2104 }
2105
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002106 found = object_resolve_partial_path(prop->opaque, parts,
2107 typename, ambiguous);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002108 if (found) {
2109 if (obj) {
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002110 *ambiguous = true;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002111 return NULL;
2112 }
2113 obj = found;
2114 }
2115
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002116 if (*ambiguous) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002117 return NULL;
2118 }
2119 }
2120
2121 return obj;
2122}
2123
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002124Object *object_resolve_path_type(const char *path, const char *typename,
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002125 bool *ambiguousp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002126{
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002127 Object *obj;
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02002128 char **parts;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002129
2130 parts = g_strsplit(path, "/", 0);
Paolo Bonzini2e1103f2013-04-18 18:44:02 +02002131 assert(parts);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002132
Paolo Bonzini2e1103f2013-04-18 18:44:02 +02002133 if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002134 bool ambiguous = false;
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002135 obj = object_resolve_partial_path(object_get_root(), parts,
Eduardo Habkostebcc4792017-07-07 18:30:52 -03002136 typename, &ambiguous);
2137 if (ambiguousp) {
2138 *ambiguousp = ambiguous;
2139 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002140 } else {
Masahiro Yamadaad195c82020-05-10 10:32:35 +09002141 obj = object_resolve_abs_path(object_get_root(), parts + 1, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002142 }
2143
2144 g_strfreev(parts);
2145
2146 return obj;
2147}
2148
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01002149Object *object_resolve_path(const char *path, bool *ambiguous)
2150{
2151 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
2152}
2153
Markus Armbruster1bf4d322021-10-19 10:57:11 +02002154Object *object_resolve_path_at(Object *parent, const char *path)
2155{
2156 g_auto(GStrv) parts = g_strsplit(path, "/", 0);
2157
2158 if (*path == '/') {
2159 return object_resolve_abs_path(object_get_root(), parts + 1,
2160 TYPE_OBJECT);
2161 }
2162 return object_resolve_abs_path(parent, parts, TYPE_OBJECT);
2163}
2164
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002165typedef struct StringProperty
2166{
2167 char *(*get)(Object *, Error **);
2168 void (*set)(Object *, const char *, Error **);
2169} StringProperty;
2170
Eric Blaked7bce992016-01-29 06:48:55 -07002171static void property_get_str(Object *obj, Visitor *v, const char *name,
2172 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002173{
2174 StringProperty *prop = opaque;
2175 char *value;
Markus Armbrustere1c82372015-08-25 20:00:46 +02002176 Error *err = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002177
Markus Armbrustere1c82372015-08-25 20:00:46 +02002178 value = prop->get(obj, &err);
2179 if (err) {
2180 error_propagate(errp, err);
2181 return;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002182 }
Markus Armbrustere1c82372015-08-25 20:00:46 +02002183
Eric Blake51e72bc2016-01-29 06:48:54 -07002184 visit_type_str(v, name, &value, errp);
Markus Armbrustere1c82372015-08-25 20:00:46 +02002185 g_free(value);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002186}
2187
Eric Blaked7bce992016-01-29 06:48:55 -07002188static void property_set_str(Object *obj, Visitor *v, const char *name,
2189 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002190{
2191 StringProperty *prop = opaque;
2192 char *value;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002193
Markus Armbruster668f62e2020-07-07 18:06:02 +02002194 if (!visit_type_str(v, name, &value, errp)) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002195 return;
2196 }
2197
2198 prop->set(obj, value, errp);
2199 g_free(value);
2200}
2201
Paolo Bonzini169cbac2020-10-27 12:12:57 -04002202static void property_release_data(Object *obj, const char *name,
2203 void *opaque)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002204{
Paolo Bonzini169cbac2020-10-27 12:12:57 -04002205 g_free(opaque);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002206}
2207
Markus Armbruster70251882020-05-05 17:29:14 +02002208ObjectProperty *
2209object_property_add_str(Object *obj, const char *name,
2210 char *(*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002211 void (*set)(Object *, const char *, Error **))
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002212{
2213 StringProperty *prop = g_malloc0(sizeof(*prop));
2214
2215 prop->get = get;
2216 prop->set = set;
2217
Markus Armbrusterd2623122020-05-05 17:29:22 +02002218 return object_property_add(obj, name, "string",
2219 get ? property_get_str : NULL,
2220 set ? property_set_str : NULL,
Paolo Bonzini169cbac2020-10-27 12:12:57 -04002221 property_release_data,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002222 prop);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06002223}
Paolo Bonzini745549c2012-03-31 16:45:54 +02002224
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002225ObjectProperty *
2226object_class_property_add_str(ObjectClass *klass, const char *name,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002227 char *(*get)(Object *, Error **),
2228 void (*set)(Object *, const char *,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002229 Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002230{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002231 StringProperty *prop = g_malloc0(sizeof(*prop));
2232
2233 prop->get = get;
2234 prop->set = set;
2235
Markus Armbrusterd2623122020-05-05 17:29:22 +02002236 return object_class_property_add(klass, name, "string",
2237 get ? property_get_str : NULL,
2238 set ? property_set_str : NULL,
2239 NULL,
2240 prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002241}
2242
Anthony Liguori0e558842012-06-25 10:32:46 -05002243typedef struct BoolProperty
2244{
2245 bool (*get)(Object *, Error **);
2246 void (*set)(Object *, bool, Error **);
2247} BoolProperty;
2248
Eric Blaked7bce992016-01-29 06:48:55 -07002249static void property_get_bool(Object *obj, Visitor *v, const char *name,
2250 void *opaque, Error **errp)
Anthony Liguori0e558842012-06-25 10:32:46 -05002251{
2252 BoolProperty *prop = opaque;
2253 bool value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002254 Error *err = NULL;
Anthony Liguori0e558842012-06-25 10:32:46 -05002255
Markus Armbruster4715d422015-08-25 20:00:45 +02002256 value = prop->get(obj, &err);
2257 if (err) {
2258 error_propagate(errp, err);
2259 return;
2260 }
2261
Eric Blake51e72bc2016-01-29 06:48:54 -07002262 visit_type_bool(v, name, &value, errp);
Anthony Liguori0e558842012-06-25 10:32:46 -05002263}
2264
Eric Blaked7bce992016-01-29 06:48:55 -07002265static void property_set_bool(Object *obj, Visitor *v, const char *name,
2266 void *opaque, Error **errp)
Anthony Liguori0e558842012-06-25 10:32:46 -05002267{
2268 BoolProperty *prop = opaque;
2269 bool value;
Anthony Liguori0e558842012-06-25 10:32:46 -05002270
Markus Armbruster668f62e2020-07-07 18:06:02 +02002271 if (!visit_type_bool(v, name, &value, errp)) {
Anthony Liguori0e558842012-06-25 10:32:46 -05002272 return;
2273 }
2274
2275 prop->set(obj, value, errp);
2276}
2277
Markus Armbruster70251882020-05-05 17:29:14 +02002278ObjectProperty *
2279object_property_add_bool(Object *obj, const char *name,
2280 bool (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002281 void (*set)(Object *, bool, Error **))
Anthony Liguori0e558842012-06-25 10:32:46 -05002282{
2283 BoolProperty *prop = g_malloc0(sizeof(*prop));
2284
2285 prop->get = get;
2286 prop->set = set;
2287
Markus Armbrusterd2623122020-05-05 17:29:22 +02002288 return object_property_add(obj, name, "bool",
2289 get ? property_get_bool : NULL,
2290 set ? property_set_bool : NULL,
Paolo Bonzini169cbac2020-10-27 12:12:57 -04002291 property_release_data,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002292 prop);
Anthony Liguori0e558842012-06-25 10:32:46 -05002293}
2294
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002295ObjectProperty *
2296object_class_property_add_bool(ObjectClass *klass, const char *name,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002297 bool (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002298 void (*set)(Object *, bool, Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002299{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002300 BoolProperty *prop = g_malloc0(sizeof(*prop));
2301
2302 prop->get = get;
2303 prop->set = set;
2304
Markus Armbrusterd2623122020-05-05 17:29:22 +02002305 return object_class_property_add(klass, name, "bool",
2306 get ? property_get_bool : NULL,
2307 set ? property_set_bool : NULL,
2308 NULL,
2309 prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002310}
2311
Eric Blaked7bce992016-01-29 06:48:55 -07002312static void property_get_enum(Object *obj, Visitor *v, const char *name,
2313 void *opaque, Error **errp)
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002314{
2315 EnumProperty *prop = opaque;
2316 int value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002317 Error *err = NULL;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002318
Markus Armbruster4715d422015-08-25 20:00:45 +02002319 value = prop->get(obj, &err);
2320 if (err) {
2321 error_propagate(errp, err);
2322 return;
2323 }
2324
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002325 visit_type_enum(v, name, &value, prop->lookup, errp);
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002326}
2327
Eric Blaked7bce992016-01-29 06:48:55 -07002328static void property_set_enum(Object *obj, Visitor *v, const char *name,
2329 void *opaque, Error **errp)
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002330{
2331 EnumProperty *prop = opaque;
2332 int value;
2333
Markus Armbruster668f62e2020-07-07 18:06:02 +02002334 if (!visit_type_enum(v, name, &value, prop->lookup, errp)) {
Markus Armbruster4715d422015-08-25 20:00:45 +02002335 return;
2336 }
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002337 prop->set(obj, value, errp);
2338}
2339
Markus Armbruster70251882020-05-05 17:29:14 +02002340ObjectProperty *
2341object_property_add_enum(Object *obj, const char *name,
2342 const char *typename,
2343 const QEnumLookup *lookup,
2344 int (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002345 void (*set)(Object *, int, Error **))
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002346{
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002347 EnumProperty *prop = g_malloc(sizeof(*prop));
2348
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002349 prop->lookup = lookup;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002350 prop->get = get;
2351 prop->set = set;
2352
Markus Armbrusterd2623122020-05-05 17:29:22 +02002353 return object_property_add(obj, name, typename,
2354 get ? property_get_enum : NULL,
2355 set ? property_set_enum : NULL,
Paolo Bonzini169cbac2020-10-27 12:12:57 -04002356 property_release_data,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002357 prop);
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002358}
2359
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002360ObjectProperty *
2361object_class_property_add_enum(ObjectClass *klass, const char *name,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002362 const char *typename,
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002363 const QEnumLookup *lookup,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002364 int (*get)(Object *, Error **),
Markus Armbrusterd2623122020-05-05 17:29:22 +02002365 void (*set)(Object *, int, Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002366{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002367 EnumProperty *prop = g_malloc(sizeof(*prop));
2368
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002369 prop->lookup = lookup;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002370 prop->get = get;
2371 prop->set = set;
2372
Markus Armbrusterd2623122020-05-05 17:29:22 +02002373 return object_class_property_add(klass, name, typename,
2374 get ? property_get_enum : NULL,
2375 set ? property_set_enum : NULL,
2376 NULL,
2377 prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002378}
2379
David Gibson8e099d12015-02-06 14:55:45 +11002380typedef struct TMProperty {
2381 void (*get)(Object *, struct tm *, Error **);
2382} TMProperty;
2383
Eric Blaked7bce992016-01-29 06:48:55 -07002384static void property_get_tm(Object *obj, Visitor *v, const char *name,
2385 void *opaque, Error **errp)
David Gibson8e099d12015-02-06 14:55:45 +11002386{
2387 TMProperty *prop = opaque;
2388 Error *err = NULL;
2389 struct tm value;
2390
2391 prop->get(obj, &value, &err);
2392 if (err) {
Markus Armbruster992861f2020-07-07 18:06:04 +02002393 error_propagate(errp, err);
2394 return;
David Gibson8e099d12015-02-06 14:55:45 +11002395 }
2396
Markus Armbruster992861f2020-07-07 18:06:04 +02002397 if (!visit_start_struct(v, name, NULL, 0, errp)) {
2398 return;
David Gibson8e099d12015-02-06 14:55:45 +11002399 }
Markus Armbruster992861f2020-07-07 18:06:04 +02002400 if (!visit_type_int32(v, "tm_year", &value.tm_year, errp)) {
David Gibson8e099d12015-02-06 14:55:45 +11002401 goto out_end;
2402 }
Markus Armbruster992861f2020-07-07 18:06:04 +02002403 if (!visit_type_int32(v, "tm_mon", &value.tm_mon, errp)) {
David Gibson8e099d12015-02-06 14:55:45 +11002404 goto out_end;
2405 }
Markus Armbruster992861f2020-07-07 18:06:04 +02002406 if (!visit_type_int32(v, "tm_mday", &value.tm_mday, errp)) {
David Gibson8e099d12015-02-06 14:55:45 +11002407 goto out_end;
2408 }
Markus Armbruster992861f2020-07-07 18:06:04 +02002409 if (!visit_type_int32(v, "tm_hour", &value.tm_hour, errp)) {
David Gibson8e099d12015-02-06 14:55:45 +11002410 goto out_end;
2411 }
Markus Armbruster992861f2020-07-07 18:06:04 +02002412 if (!visit_type_int32(v, "tm_min", &value.tm_min, errp)) {
David Gibson8e099d12015-02-06 14:55:45 +11002413 goto out_end;
2414 }
Markus Armbruster992861f2020-07-07 18:06:04 +02002415 if (!visit_type_int32(v, "tm_sec", &value.tm_sec, errp)) {
David Gibson8e099d12015-02-06 14:55:45 +11002416 goto out_end;
2417 }
Markus Armbruster992861f2020-07-07 18:06:04 +02002418 visit_check_struct(v, errp);
David Gibson8e099d12015-02-06 14:55:45 +11002419out_end:
Eric Blake1158bb22016-06-09 10:48:34 -06002420 visit_end_struct(v, NULL);
David Gibson8e099d12015-02-06 14:55:45 +11002421}
2422
Markus Armbruster70251882020-05-05 17:29:14 +02002423ObjectProperty *
2424object_property_add_tm(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002425 void (*get)(Object *, struct tm *, Error **))
David Gibson8e099d12015-02-06 14:55:45 +11002426{
David Gibson8e099d12015-02-06 14:55:45 +11002427 TMProperty *prop = g_malloc0(sizeof(*prop));
2428
2429 prop->get = get;
2430
Markus Armbrusterd2623122020-05-05 17:29:22 +02002431 return object_property_add(obj, name, "struct tm",
2432 get ? property_get_tm : NULL, NULL,
Paolo Bonzini169cbac2020-10-27 12:12:57 -04002433 property_release_data,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002434 prop);
David Gibson8e099d12015-02-06 14:55:45 +11002435}
2436
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002437ObjectProperty *
2438object_class_property_add_tm(ObjectClass *klass, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002439 void (*get)(Object *, struct tm *, Error **))
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002440{
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002441 TMProperty *prop = g_malloc0(sizeof(*prop));
2442
2443 prop->get = get;
2444
Markus Armbrusterd2623122020-05-05 17:29:22 +02002445 return object_class_property_add(klass, name, "struct tm",
2446 get ? property_get_tm : NULL,
2447 NULL, NULL, prop);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002448}
2449
Markus Armbruster90c69fb2020-07-07 18:05:50 +02002450static char *object_get_type(Object *obj, Error **errp)
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002451{
2452 return g_strdup(object_get_typename(obj));
2453}
2454
Eric Blaked7bce992016-01-29 06:48:55 -07002455static void property_get_uint8_ptr(Object *obj, Visitor *v, const char *name,
2456 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002457{
2458 uint8_t value = *(uint8_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002459 visit_type_uint8(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002460}
2461
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002462static void property_set_uint8_ptr(Object *obj, Visitor *v, const char *name,
2463 void *opaque, Error **errp)
2464{
2465 uint8_t *field = opaque;
2466 uint8_t value;
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002467
Markus Armbruster668f62e2020-07-07 18:06:02 +02002468 if (!visit_type_uint8(v, name, &value, errp)) {
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002469 return;
2470 }
2471
2472 *field = value;
2473}
2474
Eric Blaked7bce992016-01-29 06:48:55 -07002475static void property_get_uint16_ptr(Object *obj, Visitor *v, const char *name,
2476 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002477{
2478 uint16_t value = *(uint16_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002479 visit_type_uint16(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002480}
2481
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002482static void property_set_uint16_ptr(Object *obj, Visitor *v, const char *name,
2483 void *opaque, Error **errp)
2484{
2485 uint16_t *field = opaque;
2486 uint16_t value;
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002487
Markus Armbruster668f62e2020-07-07 18:06:02 +02002488 if (!visit_type_uint16(v, name, &value, errp)) {
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002489 return;
2490 }
2491
2492 *field = value;
2493}
2494
Eric Blaked7bce992016-01-29 06:48:55 -07002495static void property_get_uint32_ptr(Object *obj, Visitor *v, const char *name,
2496 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002497{
2498 uint32_t value = *(uint32_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002499 visit_type_uint32(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002500}
2501
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002502static void property_set_uint32_ptr(Object *obj, Visitor *v, const char *name,
2503 void *opaque, Error **errp)
2504{
2505 uint32_t *field = opaque;
2506 uint32_t value;
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002507
Markus Armbruster668f62e2020-07-07 18:06:02 +02002508 if (!visit_type_uint32(v, name, &value, errp)) {
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002509 return;
2510 }
2511
2512 *field = value;
2513}
2514
Eric Blaked7bce992016-01-29 06:48:55 -07002515static void property_get_uint64_ptr(Object *obj, Visitor *v, const char *name,
2516 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002517{
2518 uint64_t value = *(uint64_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002519 visit_type_uint64(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002520}
2521
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002522static void property_set_uint64_ptr(Object *obj, Visitor *v, const char *name,
2523 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002524{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002525 uint64_t *field = opaque;
2526 uint64_t value;
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002527
Markus Armbruster668f62e2020-07-07 18:06:02 +02002528 if (!visit_type_uint64(v, name, &value, errp)) {
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002529 return;
2530 }
2531
2532 *field = value;
2533}
2534
Markus Armbruster70251882020-05-05 17:29:14 +02002535ObjectProperty *
2536object_property_add_uint8_ptr(Object *obj, const char *name,
2537 const uint8_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002538 ObjectPropertyFlags flags)
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002539{
2540 ObjectPropertyAccessor *getter = NULL;
2541 ObjectPropertyAccessor *setter = NULL;
2542
2543 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2544 getter = property_get_uint8_ptr;
2545 }
2546
2547 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2548 setter = property_set_uint8_ptr;
2549 }
2550
Markus Armbruster70251882020-05-05 17:29:14 +02002551 return object_property_add(obj, name, "uint8",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002552 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002553}
2554
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002555ObjectProperty *
2556object_class_property_add_uint8_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002557 const uint8_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002558 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002559{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002560 ObjectPropertyAccessor *getter = NULL;
2561 ObjectPropertyAccessor *setter = NULL;
2562
2563 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2564 getter = property_get_uint8_ptr;
2565 }
2566
2567 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2568 setter = property_set_uint8_ptr;
2569 }
2570
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002571 return object_class_property_add(klass, name, "uint8",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002572 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002573}
2574
Markus Armbruster70251882020-05-05 17:29:14 +02002575ObjectProperty *
2576object_property_add_uint16_ptr(Object *obj, const char *name,
2577 const uint16_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002578 ObjectPropertyFlags flags)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002579{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002580 ObjectPropertyAccessor *getter = NULL;
2581 ObjectPropertyAccessor *setter = NULL;
2582
2583 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2584 getter = property_get_uint16_ptr;
2585 }
2586
2587 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2588 setter = property_set_uint16_ptr;
2589 }
2590
Markus Armbruster70251882020-05-05 17:29:14 +02002591 return object_property_add(obj, name, "uint16",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002592 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002593}
2594
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002595ObjectProperty *
2596object_class_property_add_uint16_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002597 const uint16_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002598 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002599{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002600 ObjectPropertyAccessor *getter = NULL;
2601 ObjectPropertyAccessor *setter = NULL;
2602
2603 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2604 getter = property_get_uint16_ptr;
2605 }
2606
2607 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2608 setter = property_set_uint16_ptr;
2609 }
2610
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002611 return object_class_property_add(klass, name, "uint16",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002612 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002613}
2614
Markus Armbruster70251882020-05-05 17:29:14 +02002615ObjectProperty *
2616object_property_add_uint32_ptr(Object *obj, const char *name,
2617 const uint32_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002618 ObjectPropertyFlags flags)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002619{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002620 ObjectPropertyAccessor *getter = NULL;
2621 ObjectPropertyAccessor *setter = NULL;
2622
2623 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2624 getter = property_get_uint32_ptr;
2625 }
2626
2627 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2628 setter = property_set_uint32_ptr;
2629 }
2630
Markus Armbruster70251882020-05-05 17:29:14 +02002631 return object_property_add(obj, name, "uint32",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002632 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002633}
2634
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002635ObjectProperty *
2636object_class_property_add_uint32_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002637 const uint32_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002638 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002639{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002640 ObjectPropertyAccessor *getter = NULL;
2641 ObjectPropertyAccessor *setter = NULL;
2642
2643 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2644 getter = property_get_uint32_ptr;
2645 }
2646
2647 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2648 setter = property_set_uint32_ptr;
2649 }
2650
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002651 return object_class_property_add(klass, name, "uint32",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002652 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002653}
2654
Markus Armbruster70251882020-05-05 17:29:14 +02002655ObjectProperty *
2656object_property_add_uint64_ptr(Object *obj, const char *name,
2657 const uint64_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002658 ObjectPropertyFlags flags)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002659{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002660 ObjectPropertyAccessor *getter = NULL;
2661 ObjectPropertyAccessor *setter = NULL;
2662
2663 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2664 getter = property_get_uint64_ptr;
2665 }
2666
2667 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2668 setter = property_set_uint64_ptr;
2669 }
2670
Markus Armbruster70251882020-05-05 17:29:14 +02002671 return object_property_add(obj, name, "uint64",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002672 getter, setter, NULL, (void *)v);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002673}
2674
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002675ObjectProperty *
2676object_class_property_add_uint64_ptr(ObjectClass *klass, const char *name,
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002677 const uint64_t *v,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002678 ObjectPropertyFlags flags)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002679{
Felipe Franciosi836e1b32020-02-04 13:15:58 +00002680 ObjectPropertyAccessor *getter = NULL;
2681 ObjectPropertyAccessor *setter = NULL;
2682
2683 if ((flags & OBJ_PROP_FLAG_READ) == OBJ_PROP_FLAG_READ) {
2684 getter = property_get_uint64_ptr;
2685 }
2686
2687 if ((flags & OBJ_PROP_FLAG_WRITE) == OBJ_PROP_FLAG_WRITE) {
2688 setter = property_set_uint64_ptr;
2689 }
2690
Marc-André Lureaua3a16212020-01-10 19:30:21 +04002691 return object_class_property_add(klass, name, "uint64",
Markus Armbrusterd2623122020-05-05 17:29:22 +02002692 getter, setter, NULL, (void *)v);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002693}
2694
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002695typedef struct {
2696 Object *target_obj;
Eduardo Habkost1590d262015-04-09 16:57:29 -03002697 char *target_name;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002698} AliasProperty;
2699
Eric Blaked7bce992016-01-29 06:48:55 -07002700static void property_get_alias(Object *obj, Visitor *v, const char *name,
2701 void *opaque, Error **errp)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002702{
2703 AliasProperty *prop = opaque;
Paolo Bonzinicbc94d92021-07-18 08:50:44 +02002704 Visitor *alias_v = visitor_forward_field(v, prop->target_name, name);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002705
Paolo Bonzinicbc94d92021-07-18 08:50:44 +02002706 object_property_get(prop->target_obj, prop->target_name, alias_v, errp);
2707 visit_free(alias_v);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002708}
2709
Eric Blaked7bce992016-01-29 06:48:55 -07002710static void property_set_alias(Object *obj, Visitor *v, const char *name,
2711 void *opaque, Error **errp)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002712{
2713 AliasProperty *prop = opaque;
Paolo Bonzinicbc94d92021-07-18 08:50:44 +02002714 Visitor *alias_v = visitor_forward_field(v, prop->target_name, name);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002715
Paolo Bonzinicbc94d92021-07-18 08:50:44 +02002716 object_property_set(prop->target_obj, prop->target_name, alias_v, errp);
2717 visit_free(alias_v);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002718}
2719
Paolo Bonzini64607d02014-06-05 13:11:51 +02002720static Object *property_resolve_alias(Object *obj, void *opaque,
Markus Armbrusterddfb0ba2020-05-05 17:29:10 +02002721 const char *part)
Paolo Bonzini64607d02014-06-05 13:11:51 +02002722{
2723 AliasProperty *prop = opaque;
2724
2725 return object_resolve_path_component(prop->target_obj, prop->target_name);
2726}
2727
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002728static void property_release_alias(Object *obj, const char *name, void *opaque)
2729{
2730 AliasProperty *prop = opaque;
2731
Eduardo Habkost1590d262015-04-09 16:57:29 -03002732 g_free(prop->target_name);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002733 g_free(prop);
2734}
2735
Markus Armbruster70251882020-05-05 17:29:14 +02002736ObjectProperty *
2737object_property_add_alias(Object *obj, const char *name,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002738 Object *target_obj, const char *target_name)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002739{
2740 AliasProperty *prop;
Paolo Bonzini64607d02014-06-05 13:11:51 +02002741 ObjectProperty *op;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002742 ObjectProperty *target_prop;
Markus Armbruster70251882020-05-05 17:29:14 +02002743 g_autofree char *prop_type = NULL;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002744
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01002745 target_prop = object_property_find_err(target_obj, target_name,
2746 &error_abort);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002747
Paolo Bonzinid1906982014-06-10 11:17:35 +02002748 if (object_property_is_child(target_prop)) {
2749 prop_type = g_strdup_printf("link%s",
2750 target_prop->type + strlen("child"));
2751 } else {
2752 prop_type = g_strdup(target_prop->type);
2753 }
2754
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002755 prop = g_malloc(sizeof(*prop));
2756 prop->target_obj = target_obj;
Eduardo Habkost1590d262015-04-09 16:57:29 -03002757 prop->target_name = g_strdup(target_name);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002758
Paolo Bonzinid1906982014-06-10 11:17:35 +02002759 op = object_property_add(obj, name, prop_type,
Paolo Bonzini64607d02014-06-05 13:11:51 +02002760 property_get_alias,
2761 property_set_alias,
2762 property_release_alias,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002763 prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02002764 op->resolve = property_resolve_alias;
Marc-André Lureau0e76ed02020-01-10 19:30:23 +04002765 if (target_prop->defval) {
2766 op->defval = qobject_ref(target_prop->defval);
2767 }
Paolo Bonzinid1906982014-06-10 11:17:35 +02002768
Andreas Färbera18bb412015-03-27 17:34:10 +01002769 object_property_set_description(obj, op->name,
Markus Armbruster7eecec72020-05-05 17:29:15 +02002770 target_prop->description);
Markus Armbruster70251882020-05-05 17:29:14 +02002771 return op;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002772}
2773
Gonglei80742642014-10-07 14:33:21 +08002774void object_property_set_description(Object *obj, const char *name,
Markus Armbruster7eecec72020-05-05 17:29:15 +02002775 const char *description)
Gonglei80742642014-10-07 14:33:21 +08002776{
2777 ObjectProperty *op;
2778
Daniel P. Berrangéefba1592020-09-14 14:56:17 +01002779 op = object_property_find_err(obj, name, &error_abort);
Gonglei80742642014-10-07 14:33:21 +08002780 g_free(op->description);
2781 op->description = g_strdup(description);
2782}
2783
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002784void object_class_property_set_description(ObjectClass *klass,
2785 const char *name,
Markus Armbruster7eecec72020-05-05 17:29:15 +02002786 const char *description)
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002787{
2788 ObjectProperty *op;
2789
2790 op = g_hash_table_lookup(klass->properties, name);
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002791 g_free(op->description);
2792 op->description = g_strdup(description);
2793}
2794
Marc-André Lureau7439a032018-09-06 18:09:32 +04002795static void object_class_init(ObjectClass *klass, void *data)
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002796{
Markus Armbruster90c69fb2020-07-07 18:05:50 +02002797 object_class_property_add_str(klass, "type", object_get_type,
Markus Armbrusterd2623122020-05-05 17:29:22 +02002798 NULL);
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002799}
2800
Paolo Bonzini745549c2012-03-31 16:45:54 +02002801static void register_types(void)
2802{
Bernhard Beschow5e78c982022-01-17 15:58:04 +01002803 static const TypeInfo interface_info = {
Paolo Bonzini745549c2012-03-31 16:45:54 +02002804 .name = TYPE_INTERFACE,
Anthony Liguori33e95c62012-08-10 13:16:10 +10002805 .class_size = sizeof(InterfaceClass),
Paolo Bonzini745549c2012-03-31 16:45:54 +02002806 .abstract = true,
2807 };
2808
Bernhard Beschow5e78c982022-01-17 15:58:04 +01002809 static const TypeInfo object_info = {
Paolo Bonzini745549c2012-03-31 16:45:54 +02002810 .name = TYPE_OBJECT,
2811 .instance_size = sizeof(Object),
Marc-André Lureau7439a032018-09-06 18:09:32 +04002812 .class_init = object_class_init,
Paolo Bonzini745549c2012-03-31 16:45:54 +02002813 .abstract = true,
2814 };
2815
Paolo Bonzini049cb3c2012-04-04 15:58:40 +02002816 type_interface = type_register_internal(&interface_info);
2817 type_register_internal(&object_info);
Paolo Bonzini745549c2012-03-31 16:45:54 +02002818}
2819
2820type_init(register_types)