blob: 05a85670418bee9371270ccac7be32b6a594c71c [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 Armbrusterda34e652016-03-14 09:01:28 +010014#include "qapi/error.h"
Paolo Bonzini14cccb62012-12-17 18:19:50 +010015#include "qom/object.h"
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +010016#include "qom/object_interfaces.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020017#include "qemu/cutils.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010018#include "qapi/visitor.h"
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +010019#include "qapi/string-input-visitor.h"
20#include "qapi/string-output-visitor.h"
Markus Armbrustereb815e22018-02-11 10:36:05 +010021#include "qapi/qapi-builtin-visit.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010022#include "qapi/qmp/qerror.h"
Paolo Bonzinifa131d92013-05-10 14:16:39 +020023#include "trace.h"
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060024
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +010025/* TODO: replace QObject with a simpler visitor to avoid a dependency
26 * of the QOM core on QObject? */
Paolo Bonzini14cccb62012-12-17 18:19:50 +010027#include "qom/qom-qobject.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010028#include "qapi/qmp/qbool.h"
Markus Armbruster15280c32018-02-01 12:18:36 +010029#include "qapi/qmp/qnum.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010030#include "qapi/qmp/qstring.h"
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +010031
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060032#define MAX_INTERFACES 32
33
34typedef struct InterfaceImpl InterfaceImpl;
35typedef struct TypeImpl TypeImpl;
36
37struct InterfaceImpl
38{
Anthony Liguori33e95c62012-08-10 13:16:10 +100039 const char *typename;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060040};
41
42struct TypeImpl
43{
44 const char *name;
45
46 size_t class_size;
47
48 size_t instance_size;
49
50 void (*class_init)(ObjectClass *klass, void *data);
Paolo Bonzini3b50e312012-05-02 13:30:55 +020051 void (*class_base_init)(ObjectClass *klass, void *data);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060052
53 void *class_data;
54
55 void (*instance_init)(Object *obj);
Eduardo Habkost8231c2d2013-07-10 17:08:41 -030056 void (*instance_post_init)(Object *obj);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060057 void (*instance_finalize)(Object *obj);
58
59 bool abstract;
60
61 const char *parent;
62 TypeImpl *parent_type;
63
64 ObjectClass *class;
65
66 int num_interfaces;
67 InterfaceImpl interfaces[MAX_INTERFACES];
68};
69
Paolo Bonzini9970bd82012-02-03 11:51:39 +010070static Type type_interface;
71
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060072static GHashTable *type_table_get(void)
73{
74 static GHashTable *type_table;
75
76 if (type_table == NULL) {
77 type_table = g_hash_table_new(g_str_hash, g_str_equal);
78 }
79
80 return type_table;
81}
82
Hervé Poussineauf54c19c2013-12-03 16:42:00 +010083static bool enumerating_types;
84
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060085static void type_table_add(TypeImpl *ti)
86{
Hervé Poussineauf54c19c2013-12-03 16:42:00 +010087 assert(!enumerating_types);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060088 g_hash_table_insert(type_table_get(), (void *)ti->name, ti);
89}
90
91static TypeImpl *type_table_lookup(const char *name)
92{
93 return g_hash_table_lookup(type_table_get(), name);
94}
95
Paolo Bonzinib061dc42013-12-03 16:41:59 +010096static TypeImpl *type_new(const TypeInfo *info)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -060097{
98 TypeImpl *ti = g_malloc0(sizeof(*ti));
Anthony Liguori33e95c62012-08-10 13:16:10 +100099 int i;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600100
101 g_assert(info->name != NULL);
102
Anthony Liguori73093352012-01-25 13:37:36 -0600103 if (type_table_lookup(info->name) != NULL) {
104 fprintf(stderr, "Registering `%s' which already exists\n", info->name);
105 abort();
106 }
107
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600108 ti->name = g_strdup(info->name);
109 ti->parent = g_strdup(info->parent);
110
111 ti->class_size = info->class_size;
112 ti->instance_size = info->instance_size;
113
114 ti->class_init = info->class_init;
Paolo Bonzini3b50e312012-05-02 13:30:55 +0200115 ti->class_base_init = info->class_base_init;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600116 ti->class_data = info->class_data;
117
118 ti->instance_init = info->instance_init;
Eduardo Habkost8231c2d2013-07-10 17:08:41 -0300119 ti->instance_post_init = info->instance_post_init;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600120 ti->instance_finalize = info->instance_finalize;
121
122 ti->abstract = info->abstract;
123
Anthony Liguori33e95c62012-08-10 13:16:10 +1000124 for (i = 0; info->interfaces && info->interfaces[i].type; i++) {
125 ti->interfaces[i].typename = g_strdup(info->interfaces[i].type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600126 }
Anthony Liguori33e95c62012-08-10 13:16:10 +1000127 ti->num_interfaces = i;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600128
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100129 return ti;
130}
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600131
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100132static TypeImpl *type_register_internal(const TypeInfo *info)
133{
134 TypeImpl *ti;
135 ti = type_new(info);
136
137 type_table_add(ti);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600138 return ti;
139}
140
Paolo Bonzini049cb3c2012-04-04 15:58:40 +0200141TypeImpl *type_register(const TypeInfo *info)
142{
143 assert(info->parent);
144 return type_register_internal(info);
145}
146
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600147TypeImpl *type_register_static(const TypeInfo *info)
148{
149 return type_register(info);
150}
151
Igor Mammedovaa04c9d22017-10-09 21:50:49 +0200152void type_register_static_array(const TypeInfo *infos, int nr_infos)
153{
154 int i;
155
156 for (i = 0; i < nr_infos; i++) {
157 type_register_static(&infos[i]);
158 }
159}
160
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600161static TypeImpl *type_get_by_name(const char *name)
162{
163 if (name == NULL) {
164 return NULL;
165 }
166
167 return type_table_lookup(name);
168}
169
170static TypeImpl *type_get_parent(TypeImpl *type)
171{
172 if (!type->parent_type && type->parent) {
173 type->parent_type = type_get_by_name(type->parent);
174 g_assert(type->parent_type != NULL);
175 }
176
177 return type->parent_type;
178}
179
180static bool type_has_parent(TypeImpl *type)
181{
182 return (type->parent != NULL);
183}
184
185static size_t type_class_get_size(TypeImpl *ti)
186{
187 if (ti->class_size) {
188 return ti->class_size;
189 }
190
191 if (type_has_parent(ti)) {
192 return type_class_get_size(type_get_parent(ti));
193 }
194
195 return sizeof(ObjectClass);
196}
197
Igor Mitsyankoaca59af2012-02-28 15:57:10 +0400198static size_t type_object_get_size(TypeImpl *ti)
199{
200 if (ti->instance_size) {
201 return ti->instance_size;
202 }
203
204 if (type_has_parent(ti)) {
205 return type_object_get_size(type_get_parent(ti));
206 }
207
208 return 0;
209}
210
Bharata B Rao3f97b532016-06-10 06:29:00 +0530211size_t object_type_get_instance_size(const char *typename)
212{
213 TypeImpl *type = type_get_by_name(typename);
214
215 g_assert(type != NULL);
216 return type_object_get_size(type);
217}
218
Anthony Liguori33e95c62012-08-10 13:16:10 +1000219static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600220{
Anthony Liguori33e95c62012-08-10 13:16:10 +1000221 assert(target_type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600222
Cao jinb30d8052015-11-03 10:36:42 +0800223 /* Check if target_type is a direct ancestor of type */
Anthony Liguori33e95c62012-08-10 13:16:10 +1000224 while (type) {
225 if (type == target_type) {
226 return true;
227 }
228
229 type = type_get_parent(type);
230 }
231
232 return false;
233}
234
235static void type_initialize(TypeImpl *ti);
236
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100237static void type_initialize_interface(TypeImpl *ti, TypeImpl *interface_type,
238 TypeImpl *parent_type)
Anthony Liguori33e95c62012-08-10 13:16:10 +1000239{
240 InterfaceClass *new_iface;
241 TypeInfo info = { };
242 TypeImpl *iface_impl;
243
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100244 info.parent = parent_type->name;
245 info.name = g_strdup_printf("%s::%s", ti->name, interface_type->name);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000246 info.abstract = true;
247
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100248 iface_impl = type_new(&info);
249 iface_impl->parent_type = parent_type;
Anthony Liguori33e95c62012-08-10 13:16:10 +1000250 type_initialize(iface_impl);
251 g_free((char *)info.name);
252
253 new_iface = (InterfaceClass *)iface_impl->class;
254 new_iface->concrete_class = ti->class;
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100255 new_iface->interface_type = interface_type;
Anthony Liguori33e95c62012-08-10 13:16:10 +1000256
257 ti->class->interfaces = g_slist_append(ti->class->interfaces,
258 iface_impl->class);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600259}
260
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +0100261static void object_property_free(gpointer data)
262{
263 ObjectProperty *prop = data;
264
265 g_free(prop->name);
266 g_free(prop->type);
267 g_free(prop->description);
268 g_free(prop);
269}
270
Igor Mitsyankoac451032012-02-28 15:57:11 +0400271static void type_initialize(TypeImpl *ti)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600272{
Paolo Bonzini745549c2012-03-31 16:45:54 +0200273 TypeImpl *parent;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600274
275 if (ti->class) {
276 return;
277 }
278
279 ti->class_size = type_class_get_size(ti);
Igor Mitsyankoaca59af2012-02-28 15:57:10 +0400280 ti->instance_size = type_object_get_size(ti);
Eduardo Habkost1c6d75d2016-12-12 16:31:01 -0200281 /* Any type with zero instance_size is implicitly abstract.
282 * This means interface types are all abstract.
283 */
284 if (ti->instance_size == 0) {
285 ti->abstract = true;
286 }
Marc-André Lureau422ca142018-09-12 16:53:03 +0400287 if (type_is_ancestor(ti, type_interface)) {
288 assert(ti->instance_size == 0);
289 assert(ti->abstract);
290 assert(!ti->instance_init);
291 assert(!ti->instance_post_init);
292 assert(!ti->instance_finalize);
293 assert(!ti->num_interfaces);
294 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600295 ti->class = g_malloc0(ti->class_size);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600296
Paolo Bonzini745549c2012-03-31 16:45:54 +0200297 parent = type_get_parent(ti);
298 if (parent) {
Igor Mitsyankoac451032012-02-28 15:57:11 +0400299 type_initialize(parent);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000300 GSList *e;
301 int i;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600302
Markus Armbruster719a3072018-06-08 19:02:31 +0200303 g_assert(parent->class_size <= ti->class_size);
Paolo Bonzini745549c2012-03-31 16:45:54 +0200304 memcpy(ti->class, parent->class, parent->class_size);
Peter Crosthwaite3e407de2013-02-19 14:02:09 +1000305 ti->class->interfaces = NULL;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +0100306 ti->class->properties = g_hash_table_new_full(
307 g_str_hash, g_str_equal, g_free, object_property_free);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000308
309 for (e = parent->class->interfaces; e; e = e->next) {
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100310 InterfaceClass *iface = e->data;
311 ObjectClass *klass = OBJECT_CLASS(iface);
312
313 type_initialize_interface(ti, iface->interface_type, klass->type);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000314 }
315
316 for (i = 0; i < ti->num_interfaces; i++) {
317 TypeImpl *t = type_get_by_name(ti->interfaces[i].typename);
318 for (e = ti->class->interfaces; e; e = e->next) {
319 TypeImpl *target_type = OBJECT_CLASS(e->data)->type;
320
321 if (type_is_ancestor(target_type, t)) {
322 break;
323 }
324 }
325
326 if (e) {
327 continue;
328 }
329
Paolo Bonzinib061dc42013-12-03 16:41:59 +0100330 type_initialize_interface(ti, t, t);
Anthony Liguori33e95c62012-08-10 13:16:10 +1000331 }
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +0100332 } else {
333 ti->class->properties = g_hash_table_new_full(
334 g_str_hash, g_str_equal, g_free, object_property_free);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600335 }
336
Paolo Bonzini745549c2012-03-31 16:45:54 +0200337 ti->class->type = ti;
338
339 while (parent) {
340 if (parent->class_base_init) {
341 parent->class_base_init(ti->class, ti->class_data);
342 }
343 parent = type_get_parent(parent);
344 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600345
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600346 if (ti->class_init) {
347 ti->class_init(ti->class, ti->class_data);
348 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600349}
350
351static void object_init_with_type(Object *obj, TypeImpl *ti)
352{
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600353 if (type_has_parent(ti)) {
354 object_init_with_type(obj, type_get_parent(ti));
355 }
356
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600357 if (ti->instance_init) {
358 ti->instance_init(obj);
359 }
360}
361
Eduardo Habkost8231c2d2013-07-10 17:08:41 -0300362static void object_post_init_with_type(Object *obj, TypeImpl *ti)
363{
364 if (ti->instance_post_init) {
365 ti->instance_post_init(obj);
366 }
367
368 if (type_has_parent(ti)) {
369 object_post_init_with_type(obj, type_get_parent(ti));
370 }
371}
372
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400373void object_apply_global_props(Object *obj, const GPtrArray *props, Error **errp)
374{
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400375 int i;
376
377 if (!props) {
378 return;
379 }
380
381 for (i = 0; i < props->len; i++) {
382 GlobalProperty *p = g_ptr_array_index(props, i);
Eduardo Habkostd769f0d2019-01-10 00:02:57 -0200383 Error *err = NULL;
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400384
385 if (object_dynamic_cast(obj, p->driver) == NULL) {
386 continue;
387 }
Eduardo Habkostd7741742019-01-10 16:04:57 -0200388 if (p->optional && !object_property_find(obj, p->property, NULL)) {
389 continue;
390 }
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400391 p->used = true;
392 object_property_parse(obj, p->value, p->property, &err);
393 if (err != NULL) {
394 error_prepend(&err, "can't apply global %s.%s=%s: ",
395 p->driver, p->property, p->value);
Marc-André Lureau50545b22018-11-07 15:35:34 +0400396 /*
397 * If errp != NULL, propagate error and return.
398 * If errp == NULL, report a warning, but keep going
399 * with the remaining globals.
400 */
401 if (errp) {
402 error_propagate(errp, err);
403 return;
404 } else {
405 warn_report_err(err);
406 }
Marc-André Lureauea9ce892018-11-26 22:04:32 +0400407 }
408 }
409}
410
Marc-André Lureau63f7b102016-12-12 20:31:51 +0300411static void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600412{
413 Object *obj = data;
414
415 g_assert(type != NULL);
Igor Mitsyankoac451032012-02-28 15:57:11 +0400416 type_initialize(type);
Igor Mitsyankoaca59af2012-02-28 15:57:10 +0400417
Markus Armbruster719a3072018-06-08 19:02:31 +0200418 g_assert(type->instance_size >= sizeof(Object));
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600419 g_assert(type->abstract == false);
Markus Armbruster719a3072018-06-08 19:02:31 +0200420 g_assert(size >= type->instance_size);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600421
422 memset(obj, 0, type->instance_size);
423 obj->class = type->class;
Paolo Bonzini764b6312012-11-23 09:47:12 +0100424 object_ref(obj);
Pavel Fedinb604a852015-10-13 13:37:45 +0100425 obj->properties = g_hash_table_new_full(g_str_hash, g_str_equal,
426 NULL, object_property_free);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600427 object_init_with_type(obj, type);
Eduardo Habkost8231c2d2013-07-10 17:08:41 -0300428 object_post_init_with_type(obj, type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600429}
430
Andreas Färber213f0c42013-08-23 19:37:12 +0200431void object_initialize(void *data, size_t size, const char *typename)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600432{
433 TypeImpl *type = type_get_by_name(typename);
434
Andreas Färber5b9237f2013-08-30 18:28:37 +0200435 object_initialize_with_type(data, size, type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600436}
437
Thomas Huth0210b392018-07-16 14:59:18 +0200438void object_initialize_child(Object *parentobj, const char *propname,
439 void *childobj, size_t size, const char *type,
440 Error **errp, ...)
441{
442 va_list vargs;
443
444 va_start(vargs, errp);
445 object_initialize_childv(parentobj, propname, childobj, size, type, errp,
446 vargs);
447 va_end(vargs);
448}
449
450void object_initialize_childv(Object *parentobj, const char *propname,
451 void *childobj, size_t size, const char *type,
452 Error **errp, va_list vargs)
453{
454 Error *local_err = NULL;
455 Object *obj;
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400456 UserCreatable *uc;
Thomas Huth0210b392018-07-16 14:59:18 +0200457
458 object_initialize(childobj, size, type);
459 obj = OBJECT(childobj);
460
461 object_set_propv(obj, &local_err, vargs);
462 if (local_err) {
463 goto out;
464 }
465
466 object_property_add_child(parentobj, propname, obj, &local_err);
467 if (local_err) {
468 goto out;
469 }
470
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400471 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
472 if (uc) {
473 user_creatable_complete(uc, &local_err);
Thomas Huth0210b392018-07-16 14:59:18 +0200474 if (local_err) {
475 object_unparent(obj);
476 goto out;
477 }
478 }
479
480 /*
481 * Since object_property_add_child added a reference to the child object,
482 * we can drop the reference added by object_initialize(), so the child
483 * property will own the only reference to the object.
484 */
485 object_unref(obj);
486
487out:
488 if (local_err) {
489 error_propagate(errp, local_err);
490 object_unref(obj);
491 }
492}
493
Andreas Färber5d9d3f42012-05-27 00:32:40 +0200494static inline bool object_property_is_child(ObjectProperty *prop)
495{
496 return strstart(prop->type, "child<", NULL);
497}
498
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600499static void object_property_del_all(Object *obj)
500{
Pavel Fedinb604a852015-10-13 13:37:45 +0100501 ObjectProperty *prop;
502 GHashTableIter iter;
503 gpointer key, value;
504 bool released;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600505
Pavel Fedinb604a852015-10-13 13:37:45 +0100506 do {
507 released = false;
508 g_hash_table_iter_init(&iter, obj->properties);
509 while (g_hash_table_iter_next(&iter, &key, &value)) {
510 prop = value;
511 if (prop->release) {
512 prop->release(obj, prop->name, prop->opaque);
513 prop->release = NULL;
514 released = true;
515 break;
516 }
517 g_hash_table_iter_remove(&iter);
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600518 }
Pavel Fedinb604a852015-10-13 13:37:45 +0100519 } while (released);
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600520
Pavel Fedinb604a852015-10-13 13:37:45 +0100521 g_hash_table_unref(obj->properties);
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600522}
523
524static void object_property_del_child(Object *obj, Object *child, Error **errp)
525{
526 ObjectProperty *prop;
Pavel Fedinb604a852015-10-13 13:37:45 +0100527 GHashTableIter iter;
528 gpointer key, value;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600529
Pavel Fedinb604a852015-10-13 13:37:45 +0100530 g_hash_table_iter_init(&iter, obj->properties);
531 while (g_hash_table_iter_next(&iter, &key, &value)) {
532 prop = value;
Andreas Färber5d9d3f42012-05-27 00:32:40 +0200533 if (object_property_is_child(prop) && prop->opaque == child) {
Pavel Fedinb604a852015-10-13 13:37:45 +0100534 if (prop->release) {
535 prop->release(obj, prop->name, prop->opaque);
536 prop->release = NULL;
537 }
538 break;
539 }
540 }
541 g_hash_table_iter_init(&iter, obj->properties);
542 while (g_hash_table_iter_next(&iter, &key, &value)) {
543 prop = value;
544 if (object_property_is_child(prop) && prop->opaque == child) {
545 g_hash_table_iter_remove(&iter);
Paolo Bonzini6c1fdcf2012-02-28 09:54:15 +0100546 break;
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600547 }
548 }
549}
550
551void object_unparent(Object *obj)
552{
Michael S. Tsirkine998fa82013-03-18 21:01:37 +0200553 if (obj->parent) {
554 object_property_del_child(obj->parent, obj, NULL);
555 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600556}
557
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600558static void object_deinit(Object *obj, TypeImpl *type)
559{
560 if (type->instance_finalize) {
561 type->instance_finalize(obj);
562 }
563
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600564 if (type_has_parent(type)) {
565 object_deinit(obj, type_get_parent(type));
566 }
567}
568
Paolo Bonzini339c2702012-11-23 09:47:16 +0100569static void object_finalize(void *data)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600570{
571 Object *obj = data;
572 TypeImpl *ti = obj->class->type;
573
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600574 object_property_del_all(obj);
Paolo Bonzini76a6e1c2014-06-11 11:58:30 +0200575 object_deinit(obj, ti);
Anthony Liguoridb85b572011-12-23 08:47:39 -0600576
Markus Armbruster719a3072018-06-08 19:02:31 +0200577 g_assert(obj->ref == 0);
Paolo Bonzinifde9bf42012-11-23 09:47:14 +0100578 if (obj->free) {
579 obj->free(obj);
580 }
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600581}
582
Marc-André Lureau63f7b102016-12-12 20:31:51 +0300583static Object *object_new_with_type(Type type)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600584{
585 Object *obj;
586
587 g_assert(type != NULL);
Igor Mitsyankoac451032012-02-28 15:57:11 +0400588 type_initialize(type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600589
590 obj = g_malloc(type->instance_size);
Andreas Färber5b9237f2013-08-30 18:28:37 +0200591 object_initialize_with_type(obj, type->instance_size, type);
Paolo Bonzinifde9bf42012-11-23 09:47:14 +0100592 obj->free = g_free;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600593
594 return obj;
595}
596
597Object *object_new(const char *typename)
598{
599 TypeImpl *ti = type_get_by_name(typename);
600
601 return object_new_with_type(ti);
602}
603
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100604
605Object *object_new_with_props(const char *typename,
606 Object *parent,
607 const char *id,
608 Error **errp,
609 ...)
610{
611 va_list vargs;
612 Object *obj;
613
614 va_start(vargs, errp);
615 obj = object_new_with_propv(typename, parent, id, errp, vargs);
616 va_end(vargs);
617
618 return obj;
619}
620
621
622Object *object_new_with_propv(const char *typename,
623 Object *parent,
624 const char *id,
625 Error **errp,
626 va_list vargs)
627{
628 Object *obj;
629 ObjectClass *klass;
630 Error *local_err = NULL;
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400631 UserCreatable *uc;
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100632
633 klass = object_class_by_name(typename);
634 if (!klass) {
635 error_setg(errp, "invalid object type: %s", typename);
636 return NULL;
637 }
638
639 if (object_class_is_abstract(klass)) {
640 error_setg(errp, "object type '%s' is abstract", typename);
641 return NULL;
642 }
643 obj = object_new(typename);
644
645 if (object_set_propv(obj, &local_err, vargs) < 0) {
646 goto error;
647 }
648
Daniel P. Berrangé6134d752018-06-15 16:39:35 +0100649 if (id != NULL) {
650 object_property_add_child(parent, id, obj, &local_err);
651 if (local_err) {
652 goto error;
653 }
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100654 }
655
Marc-André Lureau3650b2d2018-12-04 18:20:07 +0400656 uc = (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
657 if (uc) {
658 user_creatable_complete(uc, &local_err);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100659 if (local_err) {
Daniel P. Berrangé6134d752018-06-15 16:39:35 +0100660 if (id != NULL) {
661 object_unparent(obj);
662 }
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100663 goto error;
664 }
665 }
666
667 object_unref(OBJECT(obj));
668 return obj;
669
670 error:
Eduardo Habkost621ff942016-06-13 18:57:56 -0300671 error_propagate(errp, local_err);
Daniel P. Berrangea31bdae2015-05-13 17:14:06 +0100672 object_unref(obj);
673 return NULL;
674}
675
676
677int object_set_props(Object *obj,
678 Error **errp,
679 ...)
680{
681 va_list vargs;
682 int ret;
683
684 va_start(vargs, errp);
685 ret = object_set_propv(obj, errp, vargs);
686 va_end(vargs);
687
688 return ret;
689}
690
691
692int object_set_propv(Object *obj,
693 Error **errp,
694 va_list vargs)
695{
696 const char *propname;
697 Error *local_err = NULL;
698
699 propname = va_arg(vargs, char *);
700 while (propname != NULL) {
701 const char *value = va_arg(vargs, char *);
702
703 g_assert(value != NULL);
704 object_property_parse(obj, value, propname, &local_err);
705 if (local_err) {
706 error_propagate(errp, local_err);
707 return -1;
708 }
709 propname = va_arg(vargs, char *);
710 }
711
712 return 0;
713}
714
715
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600716Object *object_dynamic_cast(Object *obj, const char *typename)
717{
Paolo Bonzinib7f43fe2012-11-23 16:56:17 +0100718 if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
Paolo Bonziniacc4af32012-02-03 11:57:23 +0100719 return obj;
720 }
721
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600722 return NULL;
723}
724
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200725Object *object_dynamic_cast_assert(Object *obj, const char *typename,
726 const char *file, int line, const char *func)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600727{
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200728 trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
729 typename, file, line, func);
730
Paolo Bonzini3556c232013-05-10 14:16:40 +0200731#ifdef CONFIG_QOM_CAST_DEBUG
Anthony Liguori03587322013-05-13 15:22:24 -0500732 int i;
733 Object *inst;
734
Peter Crosthwaite95916ab2013-05-22 11:19:16 +1000735 for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100736 if (atomic_read(&obj->class->object_cast_cache[i]) == typename) {
Anthony Liguori03587322013-05-13 15:22:24 -0500737 goto out;
738 }
739 }
740
741 inst = object_dynamic_cast(obj, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600742
Paolo Bonzinib7f43fe2012-11-23 16:56:17 +0100743 if (!inst && obj) {
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200744 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
745 file, line, func, obj, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600746 abort();
747 }
748
Paolo Bonzini3556c232013-05-10 14:16:40 +0200749 assert(obj == inst);
Anthony Liguori03587322013-05-13 15:22:24 -0500750
Peter Crosthwaite95916ab2013-05-22 11:19:16 +1000751 if (obj && obj == inst) {
Anthony Liguori03587322013-05-13 15:22:24 -0500752 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100753 atomic_set(&obj->class->object_cast_cache[i - 1],
754 atomic_read(&obj->class->object_cast_cache[i]));
Anthony Liguori03587322013-05-13 15:22:24 -0500755 }
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100756 atomic_set(&obj->class->object_cast_cache[i - 1], typename);
Anthony Liguori03587322013-05-13 15:22:24 -0500757 }
758
759out:
Paolo Bonzini3556c232013-05-10 14:16:40 +0200760#endif
761 return obj;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600762}
763
764ObjectClass *object_class_dynamic_cast(ObjectClass *class,
765 const char *typename)
766{
Anthony Liguori33e95c62012-08-10 13:16:10 +1000767 ObjectClass *ret = NULL;
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200768 TypeImpl *target_type;
769 TypeImpl *type;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600770
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200771 if (!class) {
772 return NULL;
773 }
774
Paolo Bonzini793c96b2013-05-10 14:16:37 +0200775 /* A simple fast path that can trigger a lot for leaf classes. */
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200776 type = class->type;
Paolo Bonzini793c96b2013-05-10 14:16:37 +0200777 if (type->name == typename) {
778 return class;
779 }
780
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200781 target_type = type_get_by_name(typename);
Alexander Graf9ab880b2013-04-30 15:02:16 +0200782 if (!target_type) {
783 /* target class type unknown, so fail the cast */
784 return NULL;
785 }
786
Peter Crosthwaite00e2cea2013-02-19 14:02:10 +1000787 if (type->class->interfaces &&
788 type_is_ancestor(target_type, type_interface)) {
Anthony Liguori33e95c62012-08-10 13:16:10 +1000789 int found = 0;
790 GSList *i;
791
792 for (i = class->interfaces; i; i = i->next) {
793 ObjectClass *target_class = i->data;
794
795 if (type_is_ancestor(target_class->type, target_type)) {
796 ret = target_class;
797 found++;
798 }
799 }
800
801 /* The match was ambiguous, don't allow a cast */
802 if (found > 1) {
803 ret = NULL;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600804 }
Anthony Liguori33e95c62012-08-10 13:16:10 +1000805 } else if (type_is_ancestor(type, target_type)) {
806 ret = class;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600807 }
808
Anthony Liguori33e95c62012-08-10 13:16:10 +1000809 return ret;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600810}
811
812ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200813 const char *typename,
814 const char *file, int line,
815 const char *func)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600816{
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200817 ObjectClass *ret;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600818
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200819 trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)",
820 typename, file, line, func);
821
Anthony Liguori03587322013-05-13 15:22:24 -0500822#ifdef CONFIG_QOM_CAST_DEBUG
823 int i;
824
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000825 for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100826 if (atomic_read(&class->class_cast_cache[i]) == typename) {
Anthony Liguori03587322013-05-13 15:22:24 -0500827 ret = class;
828 goto out;
829 }
830 }
831#else
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000832 if (!class || !class->interfaces) {
Paolo Bonzini3556c232013-05-10 14:16:40 +0200833 return class;
834 }
835#endif
836
Paolo Bonzinifa131d92013-05-10 14:16:39 +0200837 ret = object_class_dynamic_cast(class, typename);
Paolo Bonzinibf0fda32013-05-10 14:16:36 +0200838 if (!ret && class) {
Paolo Bonzinibe17f182013-05-10 14:16:38 +0200839 fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
840 file, line, func, class, typename);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600841 abort();
842 }
843
Anthony Liguori03587322013-05-13 15:22:24 -0500844#ifdef CONFIG_QOM_CAST_DEBUG
Peter Crosthwaite9d6a3d52013-06-18 19:18:59 +1000845 if (class && ret == class) {
Anthony Liguori03587322013-05-13 15:22:24 -0500846 for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100847 atomic_set(&class->class_cast_cache[i - 1],
848 atomic_read(&class->class_cast_cache[i]));
Anthony Liguori03587322013-05-13 15:22:24 -0500849 }
Alex Bennéeb6b3ccf2016-09-30 22:30:57 +0100850 atomic_set(&class->class_cast_cache[i - 1], typename);
Anthony Liguori03587322013-05-13 15:22:24 -0500851 }
852out:
853#endif
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600854 return ret;
855}
856
Igor Mammedov8f5d58e2017-07-14 10:14:50 +0800857const char *object_get_typename(const Object *obj)
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600858{
859 return obj->class->type->name;
860}
861
862ObjectClass *object_get_class(Object *obj)
863{
864 return obj->class;
865}
866
Andreas Färber17862372013-01-23 12:20:18 +0100867bool object_class_is_abstract(ObjectClass *klass)
868{
869 return klass->type->abstract;
870}
871
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600872const char *object_class_get_name(ObjectClass *klass)
873{
874 return klass->type->name;
875}
876
877ObjectClass *object_class_by_name(const char *typename)
878{
879 TypeImpl *type = type_get_by_name(typename);
880
881 if (!type) {
882 return NULL;
883 }
884
Igor Mitsyankoac451032012-02-28 15:57:11 +0400885 type_initialize(type);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600886
887 return type->class;
888}
889
Paolo Bonzinie7cce672012-05-02 13:30:54 +0200890ObjectClass *object_class_get_parent(ObjectClass *class)
891{
892 TypeImpl *type = type_get_parent(class->type);
893
894 if (!type) {
895 return NULL;
896 }
897
898 type_initialize(type);
899
900 return type->class;
901}
902
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600903typedef struct OCFData
904{
905 void (*fn)(ObjectClass *klass, void *opaque);
Anthony Liguori93c511a2011-12-22 14:11:53 -0600906 const char *implements_type;
907 bool include_abstract;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600908 void *opaque;
909} OCFData;
910
911static void object_class_foreach_tramp(gpointer key, gpointer value,
912 gpointer opaque)
913{
914 OCFData *data = opaque;
915 TypeImpl *type = value;
Anthony Liguori93c511a2011-12-22 14:11:53 -0600916 ObjectClass *k;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600917
Igor Mitsyankoac451032012-02-28 15:57:11 +0400918 type_initialize(type);
Anthony Liguori93c511a2011-12-22 14:11:53 -0600919 k = type->class;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600920
Anthony Liguori93c511a2011-12-22 14:11:53 -0600921 if (!data->include_abstract && type->abstract) {
922 return;
923 }
924
925 if (data->implements_type &&
926 !object_class_dynamic_cast(k, data->implements_type)) {
927 return;
928 }
929
930 data->fn(k, data->opaque);
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600931}
932
933void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
Anthony Liguori93c511a2011-12-22 14:11:53 -0600934 const char *implements_type, bool include_abstract,
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600935 void *opaque)
936{
Anthony Liguori93c511a2011-12-22 14:11:53 -0600937 OCFData data = { fn, implements_type, include_abstract, opaque };
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600938
Hervé Poussineauf54c19c2013-12-03 16:42:00 +0100939 enumerating_types = true;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600940 g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
Hervé Poussineauf54c19c2013-12-03 16:42:00 +0100941 enumerating_types = false;
Anthony Liguori2f28d2f2011-12-03 17:10:08 -0600942}
Anthony Liguori57c9faf2012-01-30 08:55:55 -0600943
Peter Crosthwaited714b8d2015-09-08 17:38:43 +0100944static int do_object_child_foreach(Object *obj,
945 int (*fn)(Object *child, void *opaque),
946 void *opaque, bool recurse)
Paolo Bonzini32efc532012-04-11 23:30:20 +0200947{
Pavel Fedinb604a852015-10-13 13:37:45 +0100948 GHashTableIter iter;
949 ObjectProperty *prop;
Paolo Bonzini32efc532012-04-11 23:30:20 +0200950 int ret = 0;
951
Pavel Fedinb604a852015-10-13 13:37:45 +0100952 g_hash_table_iter_init(&iter, obj->properties);
953 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Paolo Bonzini32efc532012-04-11 23:30:20 +0200954 if (object_property_is_child(prop)) {
Peter Crosthwaited714b8d2015-09-08 17:38:43 +0100955 Object *child = prop->opaque;
956
957 ret = fn(child, opaque);
Paolo Bonzini32efc532012-04-11 23:30:20 +0200958 if (ret != 0) {
959 break;
960 }
Peter Crosthwaited714b8d2015-09-08 17:38:43 +0100961 if (recurse) {
962 do_object_child_foreach(child, fn, opaque, true);
963 }
Paolo Bonzini32efc532012-04-11 23:30:20 +0200964 }
965 }
966 return ret;
967}
968
Peter Crosthwaited714b8d2015-09-08 17:38:43 +0100969int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
970 void *opaque)
971{
972 return do_object_child_foreach(obj, fn, opaque, false);
973}
974
975int object_child_foreach_recursive(Object *obj,
976 int (*fn)(Object *child, void *opaque),
977 void *opaque)
978{
979 return do_object_child_foreach(obj, fn, opaque, true);
980}
981
Andreas Färber418ba9e2012-02-25 23:07:34 +0100982static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
983{
984 GSList **list = opaque;
985
986 *list = g_slist_prepend(*list, klass);
987}
988
989GSList *object_class_get_list(const char *implements_type,
990 bool include_abstract)
991{
992 GSList *list = NULL;
993
994 object_class_foreach(object_class_get_list_tramp,
995 implements_type, include_abstract, &list);
996 return list;
997}
998
Paolo Bonzini47c66002018-03-03 08:33:10 +0100999static gint object_class_cmp(gconstpointer a, gconstpointer b)
1000{
1001 return strcasecmp(object_class_get_name((ObjectClass *)a),
1002 object_class_get_name((ObjectClass *)b));
1003}
1004
1005GSList *object_class_get_list_sorted(const char *implements_type,
1006 bool include_abstract)
1007{
1008 return g_slist_sort(object_class_get_list(implements_type, include_abstract),
1009 object_class_cmp);
1010}
1011
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001012void object_ref(Object *obj)
1013{
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001014 if (!obj) {
1015 return;
1016 }
Andreas Färber8438a132015-11-16 17:49:20 +01001017 atomic_inc(&obj->ref);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001018}
1019
1020void object_unref(Object *obj)
1021{
Peter Crosthwaite8ffad852014-06-05 23:13:36 -07001022 if (!obj) {
1023 return;
1024 }
Markus Armbruster719a3072018-06-08 19:02:31 +02001025 g_assert(obj->ref > 0);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001026
1027 /* parent always holds a reference to its children */
Jan Kiszkaf08c03f2013-07-02 11:36:39 +02001028 if (atomic_fetch_dec(&obj->ref) == 1) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001029 object_finalize(obj);
1030 }
1031}
1032
Paolo Bonzini64607d02014-06-05 13:11:51 +02001033ObjectProperty *
1034object_property_add(Object *obj, const char *name, const char *type,
1035 ObjectPropertyAccessor *get,
1036 ObjectPropertyAccessor *set,
1037 ObjectPropertyRelease *release,
1038 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001039{
Peter Maydell54852b02013-03-25 13:15:13 +00001040 ObjectProperty *prop;
Peter Crosthwaite33965902014-08-19 23:55:52 -07001041 size_t name_len = strlen(name);
1042
1043 if (name_len >= 3 && !memcmp(name + name_len - 3, "[*]", 4)) {
1044 int i;
1045 ObjectProperty *ret;
1046 char *name_no_array = g_strdup(name);
1047
1048 name_no_array[name_len - 3] = '\0';
1049 for (i = 0; ; ++i) {
1050 char *full_name = g_strdup_printf("%s[%d]", name_no_array, i);
1051
1052 ret = object_property_add(obj, full_name, type, get, set,
1053 release, opaque, NULL);
1054 g_free(full_name);
1055 if (ret) {
1056 break;
1057 }
1058 }
1059 g_free(name_no_array);
1060 return ret;
1061 }
Peter Maydell54852b02013-03-25 13:15:13 +00001062
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001063 if (object_property_find(obj, name, NULL) != NULL) {
Pavel Fedinb604a852015-10-13 13:37:45 +01001064 error_setg(errp, "attempt to add duplicate property '%s'"
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001065 " to object (type '%s')", name,
1066 object_get_typename(obj));
Pavel Fedinb604a852015-10-13 13:37:45 +01001067 return NULL;
Peter Maydell54852b02013-03-25 13:15:13 +00001068 }
1069
1070 prop = g_malloc0(sizeof(*prop));
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001071
1072 prop->name = g_strdup(name);
1073 prop->type = g_strdup(type);
1074
1075 prop->get = get;
1076 prop->set = set;
1077 prop->release = release;
1078 prop->opaque = opaque;
1079
Pavel Fedinb604a852015-10-13 13:37:45 +01001080 g_hash_table_insert(obj->properties, prop->name, prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001081 return prop;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001082}
1083
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001084ObjectProperty *
1085object_class_property_add(ObjectClass *klass,
1086 const char *name,
1087 const char *type,
1088 ObjectPropertyAccessor *get,
1089 ObjectPropertyAccessor *set,
1090 ObjectPropertyRelease *release,
1091 void *opaque,
1092 Error **errp)
1093{
1094 ObjectProperty *prop;
1095
1096 if (object_class_property_find(klass, name, NULL) != NULL) {
1097 error_setg(errp, "attempt to add duplicate property '%s'"
1098 " to object (type '%s')", name,
1099 object_class_get_name(klass));
1100 return NULL;
1101 }
1102
1103 prop = g_malloc0(sizeof(*prop));
1104
1105 prop->name = g_strdup(name);
1106 prop->type = g_strdup(type);
1107
1108 prop->get = get;
1109 prop->set = set;
1110 prop->release = release;
1111 prop->opaque = opaque;
1112
1113 g_hash_table_insert(klass->properties, g_strdup(name), prop);
1114
1115 return prop;
1116}
1117
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001118ObjectProperty *object_property_find(Object *obj, const char *name,
1119 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001120{
1121 ObjectProperty *prop;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001122 ObjectClass *klass = object_get_class(obj);
1123
1124 prop = object_class_property_find(klass, name, NULL);
1125 if (prop) {
1126 return prop;
1127 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001128
Pavel Fedinb604a852015-10-13 13:37:45 +01001129 prop = g_hash_table_lookup(obj->properties, name);
1130 if (prop) {
1131 return prop;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001132 }
1133
Cole Robinsonf231b882014-03-21 19:42:26 -04001134 error_setg(errp, "Property '.%s' not found", name);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001135 return NULL;
1136}
1137
Daniel P. Berrange7746abd2015-12-09 12:34:02 +00001138void object_property_iter_init(ObjectPropertyIterator *iter,
1139 Object *obj)
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001140{
Daniel P. Berrange7746abd2015-12-09 12:34:02 +00001141 g_hash_table_iter_init(&iter->iter, obj->properties);
1142 iter->nextclass = object_get_class(obj);
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001143}
1144
1145ObjectProperty *object_property_iter_next(ObjectPropertyIterator *iter)
1146{
Pavel Fedinb604a852015-10-13 13:37:45 +01001147 gpointer key, val;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001148 while (!g_hash_table_iter_next(&iter->iter, &key, &val)) {
1149 if (!iter->nextclass) {
1150 return NULL;
1151 }
1152 g_hash_table_iter_init(&iter->iter, iter->nextclass->properties);
1153 iter->nextclass = object_class_get_parent(iter->nextclass);
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001154 }
Pavel Fedinb604a852015-10-13 13:37:45 +01001155 return val;
Daniel P. Berrangea00c9482015-10-13 13:37:40 +01001156}
1157
Alexey Kardashevskiy961c47b2018-03-02 00:09:39 +11001158void object_class_property_iter_init(ObjectPropertyIterator *iter,
1159 ObjectClass *klass)
1160{
1161 g_hash_table_iter_init(&iter->iter, klass->properties);
Marc-André Lureau684546d2018-09-06 17:37:36 +04001162 iter->nextclass = object_class_get_parent(klass);
Alexey Kardashevskiy961c47b2018-03-02 00:09:39 +11001163}
1164
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001165ObjectProperty *object_class_property_find(ObjectClass *klass, const char *name,
1166 Error **errp)
1167{
1168 ObjectProperty *prop;
1169 ObjectClass *parent_klass;
1170
1171 parent_klass = object_class_get_parent(klass);
1172 if (parent_klass) {
1173 prop = object_class_property_find(parent_klass, name, NULL);
1174 if (prop) {
1175 return prop;
1176 }
1177 }
1178
1179 prop = g_hash_table_lookup(klass->properties, name);
1180 if (!prop) {
1181 error_setg(errp, "Property '.%s' not found", name);
1182 }
1183 return prop;
1184}
1185
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001186void object_property_del(Object *obj, const char *name, Error **errp)
1187{
Pavel Fedinb604a852015-10-13 13:37:45 +01001188 ObjectProperty *prop = g_hash_table_lookup(obj->properties, name);
1189
1190 if (!prop) {
1191 error_setg(errp, "Property '.%s' not found", name);
Anthony Liguori0866aca2011-12-23 15:34:39 -06001192 return;
1193 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001194
Anthony Liguori0866aca2011-12-23 15:34:39 -06001195 if (prop->release) {
1196 prop->release(obj, name, prop->opaque);
1197 }
Pavel Fedinb604a852015-10-13 13:37:45 +01001198 g_hash_table_remove(obj->properties, name);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001199}
1200
1201void object_property_get(Object *obj, Visitor *v, const char *name,
1202 Error **errp)
1203{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001204 ObjectProperty *prop = object_property_find(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001205 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001206 return;
1207 }
1208
1209 if (!prop->get) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001210 error_setg(errp, QERR_PERMISSION_DENIED);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001211 } else {
Eric Blaked7bce992016-01-29 06:48:55 -07001212 prop->get(obj, v, name, prop->opaque, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001213 }
1214}
1215
1216void object_property_set(Object *obj, Visitor *v, const char *name,
1217 Error **errp)
1218{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001219 ObjectProperty *prop = object_property_find(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001220 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001221 return;
1222 }
1223
1224 if (!prop->set) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001225 error_setg(errp, QERR_PERMISSION_DENIED);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001226 } else {
Eric Blaked7bce992016-01-29 06:48:55 -07001227 prop->set(obj, v, name, prop->opaque, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001228 }
1229}
1230
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001231void object_property_set_str(Object *obj, const char *value,
1232 const char *name, Error **errp)
1233{
1234 QString *qstr = qstring_from_str(value);
1235 object_property_set_qobject(obj, QOBJECT(qstr), name, errp);
1236
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001237 qobject_unref(qstr);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001238}
1239
1240char *object_property_get_str(Object *obj, const char *name,
1241 Error **errp)
1242{
1243 QObject *ret = object_property_get_qobject(obj, name, errp);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001244 char *retval;
1245
1246 if (!ret) {
1247 return NULL;
1248 }
Peter Xuaafb21a2018-03-09 16:59:47 +08001249
1250 retval = g_strdup(qobject_get_try_str(ret));
1251 if (!retval) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001252 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001253 }
1254
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001255 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001256 return retval;
1257}
1258
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001259void object_property_set_link(Object *obj, Object *value,
1260 const char *name, Error **errp)
1261{
Peter Crosthwaited3c49312014-09-25 22:19:19 -07001262 if (value) {
1263 gchar *path = object_get_canonical_path(value);
1264 object_property_set_str(obj, path, name, errp);
1265 g_free(path);
1266 } else {
1267 object_property_set_str(obj, "", name, errp);
1268 }
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001269}
1270
1271Object *object_property_get_link(Object *obj, const char *name,
1272 Error **errp)
1273{
1274 char *str = object_property_get_str(obj, name, errp);
1275 Object *target = NULL;
1276
1277 if (str && *str) {
1278 target = object_resolve_path(str, NULL);
1279 if (!target) {
Markus Armbruster75158eb2015-03-16 08:57:47 +01001280 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1281 "Device '%s' not found", str);
Paolo Bonzini1d9c5a12012-02-02 10:51:57 +01001282 }
1283 }
1284
1285 g_free(str);
1286 return target;
1287}
1288
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001289void object_property_set_bool(Object *obj, bool value,
1290 const char *name, Error **errp)
1291{
Eric Blakefc48ffc2015-05-15 16:24:59 -06001292 QBool *qbool = qbool_from_bool(value);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001293 object_property_set_qobject(obj, QOBJECT(qbool), name, errp);
1294
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001295 qobject_unref(qbool);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001296}
1297
1298bool object_property_get_bool(Object *obj, const char *name,
1299 Error **errp)
1300{
1301 QObject *ret = object_property_get_qobject(obj, name, errp);
1302 QBool *qbool;
1303 bool retval;
1304
1305 if (!ret) {
1306 return false;
1307 }
Max Reitz7dc847e2018-02-24 16:40:29 +01001308 qbool = qobject_to(QBool, ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001309 if (!qbool) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001310 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001311 retval = false;
1312 } else {
Eric Blakefc48ffc2015-05-15 16:24:59 -06001313 retval = qbool_get_bool(qbool);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001314 }
1315
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001316 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001317 return retval;
1318}
1319
1320void object_property_set_int(Object *obj, int64_t value,
1321 const char *name, Error **errp)
1322{
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001323 QNum *qnum = qnum_from_int(value);
1324 object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001325
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001326 qobject_unref(qnum);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001327}
1328
1329int64_t object_property_get_int(Object *obj, const char *name,
1330 Error **errp)
1331{
1332 QObject *ret = object_property_get_qobject(obj, name, errp);
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001333 QNum *qnum;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001334 int64_t retval;
1335
1336 if (!ret) {
1337 return -1;
1338 }
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001339
Max Reitz7dc847e2018-02-24 16:40:29 +01001340 qnum = qobject_to(QNum, ret);
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +04001341 if (!qnum || !qnum_get_try_int(qnum, &retval)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001342 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001343 retval = -1;
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001344 }
1345
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001346 qobject_unref(ret);
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001347 return retval;
1348}
1349
Marc-André Lureau31527792017-06-07 20:36:04 +04001350void object_property_set_uint(Object *obj, uint64_t value,
1351 const char *name, Error **errp)
1352{
1353 QNum *qnum = qnum_from_uint(value);
1354
1355 object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001356 qobject_unref(qnum);
Marc-André Lureau31527792017-06-07 20:36:04 +04001357}
1358
1359uint64_t object_property_get_uint(Object *obj, const char *name,
1360 Error **errp)
1361{
1362 QObject *ret = object_property_get_qobject(obj, name, errp);
1363 QNum *qnum;
1364 uint64_t retval;
1365
1366 if (!ret) {
1367 return 0;
1368 }
Max Reitz7dc847e2018-02-24 16:40:29 +01001369 qnum = qobject_to(QNum, ret);
Marc-André Lureau31527792017-06-07 20:36:04 +04001370 if (!qnum || !qnum_get_try_uint(qnum, &retval)) {
1371 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "uint");
1372 retval = 0;
1373 }
1374
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001375 qobject_unref(ret);
Marc-André Lureau31527792017-06-07 20:36:04 +04001376 return retval;
1377}
1378
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01001379typedef struct EnumProperty {
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02001380 const QEnumLookup *lookup;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01001381 int (*get)(Object *, Error **);
1382 void (*set)(Object *, int, Error **);
1383} EnumProperty;
1384
Hu Tao1f217722014-05-14 17:43:33 +08001385int object_property_get_enum(Object *obj, const char *name,
Daniel P. Berrangea3590da2015-05-27 16:07:56 +01001386 const char *typename, Error **errp)
Hu Tao1f217722014-05-14 17:43:33 +08001387{
Markus Armbruster4715d422015-08-25 20:00:45 +02001388 Error *err = NULL;
Eric Blake7a0525c2016-06-09 10:48:37 -06001389 Visitor *v;
Chen Fan976620a2014-08-18 14:46:34 +08001390 char *str;
Hu Tao1f217722014-05-14 17:43:33 +08001391 int ret;
Daniel P. Berrangea3590da2015-05-27 16:07:56 +01001392 ObjectProperty *prop = object_property_find(obj, name, errp);
1393 EnumProperty *enumprop;
1394
1395 if (prop == NULL) {
1396 return 0;
1397 }
1398
1399 if (!g_str_equal(prop->type, typename)) {
1400 error_setg(errp, "Property %s on %s is not '%s' enum type",
1401 name, object_class_get_name(
1402 object_get_class(obj)), typename);
1403 return 0;
1404 }
1405
1406 enumprop = prop->opaque;
Hu Tao1f217722014-05-14 17:43:33 +08001407
Eric Blake3b098d52016-06-09 10:48:43 -06001408 v = string_output_visitor_new(false, &str);
Eric Blakee7ca5652016-06-09 10:48:39 -06001409 object_property_get(obj, v, name, &err);
Markus Armbruster4715d422015-08-25 20:00:45 +02001410 if (err) {
1411 error_propagate(errp, err);
Eric Blakee7ca5652016-06-09 10:48:39 -06001412 visit_free(v);
Markus Armbruster4715d422015-08-25 20:00:45 +02001413 return 0;
1414 }
Eric Blake3b098d52016-06-09 10:48:43 -06001415 visit_complete(v, &str);
Eric Blakee7ca5652016-06-09 10:48:39 -06001416 visit_free(v);
Eric Blake7a0525c2016-06-09 10:48:37 -06001417 v = string_input_visitor_new(str);
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02001418 visit_type_enum(v, name, &ret, enumprop->lookup, errp);
Chen Fan976620a2014-08-18 14:46:34 +08001419
1420 g_free(str);
Eric Blake7a0525c2016-06-09 10:48:37 -06001421 visit_free(v);
Hu Tao1f217722014-05-14 17:43:33 +08001422
1423 return ret;
1424}
1425
1426void object_property_get_uint16List(Object *obj, const char *name,
1427 uint16List **list, Error **errp)
1428{
Markus Armbruster4715d422015-08-25 20:00:45 +02001429 Error *err = NULL;
Eric Blake7a0525c2016-06-09 10:48:37 -06001430 Visitor *v;
Chen Fan976620a2014-08-18 14:46:34 +08001431 char *str;
Hu Tao1f217722014-05-14 17:43:33 +08001432
Eric Blake3b098d52016-06-09 10:48:43 -06001433 v = string_output_visitor_new(false, &str);
1434 object_property_get(obj, v, name, &err);
Markus Armbruster4715d422015-08-25 20:00:45 +02001435 if (err) {
1436 error_propagate(errp, err);
1437 goto out;
1438 }
Eric Blake3b098d52016-06-09 10:48:43 -06001439 visit_complete(v, &str);
1440 visit_free(v);
Eric Blake7a0525c2016-06-09 10:48:37 -06001441 v = string_input_visitor_new(str);
1442 visit_type_uint16List(v, NULL, list, errp);
Chen Fan976620a2014-08-18 14:46:34 +08001443
1444 g_free(str);
Markus Armbruster4715d422015-08-25 20:00:45 +02001445out:
Eric Blake3b098d52016-06-09 10:48:43 -06001446 visit_free(v);
Hu Tao1f217722014-05-14 17:43:33 +08001447}
1448
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001449void object_property_parse(Object *obj, const char *string,
1450 const char *name, Error **errp)
1451{
Eric Blake7a0525c2016-06-09 10:48:37 -06001452 Visitor *v = string_input_visitor_new(string);
1453 object_property_set(obj, v, name, errp);
1454 visit_free(v);
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001455}
1456
Paolo Bonzini0b7593e2014-02-08 11:01:50 +01001457char *object_property_print(Object *obj, const char *name, bool human,
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001458 Error **errp)
1459{
Eric Blake3b098d52016-06-09 10:48:43 -06001460 Visitor *v;
Gonglei3a530092014-09-27 13:13:55 +08001461 char *string = NULL;
1462 Error *local_err = NULL;
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001463
Eric Blake3b098d52016-06-09 10:48:43 -06001464 v = string_output_visitor_new(human, &string);
1465 object_property_get(obj, v, name, &local_err);
Gonglei3a530092014-09-27 13:13:55 +08001466 if (local_err) {
1467 error_propagate(errp, local_err);
1468 goto out;
1469 }
1470
Eric Blake3b098d52016-06-09 10:48:43 -06001471 visit_complete(v, &string);
Gonglei3a530092014-09-27 13:13:55 +08001472
1473out:
Eric Blake3b098d52016-06-09 10:48:43 -06001474 visit_free(v);
Paolo Bonzinib2cd7de2012-02-09 09:52:59 +01001475 return string;
1476}
1477
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001478const char *object_property_get_type(Object *obj, const char *name, Error **errp)
1479{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001480 ObjectProperty *prop = object_property_find(obj, name, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001481 if (prop == NULL) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001482 return NULL;
1483 }
1484
1485 return prop->type;
1486}
1487
1488Object *object_get_root(void)
1489{
Anthony Liguori8b45d442011-12-23 09:08:05 -06001490 static Object *root;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001491
Anthony Liguori8b45d442011-12-23 09:08:05 -06001492 if (!root) {
1493 root = object_new("container");
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001494 }
1495
Anthony Liguori8b45d442011-12-23 09:08:05 -06001496 return root;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001497}
1498
Daniel P. Berrangebc2256c2015-05-13 17:14:05 +01001499Object *object_get_objects_root(void)
1500{
1501 return container_get(object_get_root(), "/objects");
1502}
1503
Peter Xu7c47c4e2017-09-28 10:59:54 +08001504Object *object_get_internal_root(void)
1505{
1506 static Object *internal_root;
1507
1508 if (!internal_root) {
1509 internal_root = object_new("container");
1510 }
1511
1512 return internal_root;
1513}
1514
Eric Blaked7bce992016-01-29 06:48:55 -07001515static void object_get_child_property(Object *obj, Visitor *v,
1516 const char *name, void *opaque,
1517 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001518{
1519 Object *child = opaque;
1520 gchar *path;
1521
1522 path = object_get_canonical_path(child);
Eric Blake51e72bc2016-01-29 06:48:54 -07001523 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001524 g_free(path);
1525}
1526
Paolo Bonzini64607d02014-06-05 13:11:51 +02001527static Object *object_resolve_child_property(Object *parent, void *opaque, const gchar *part)
1528{
1529 return opaque;
1530}
1531
Anthony Liguoridb85b572011-12-23 08:47:39 -06001532static void object_finalize_child_property(Object *obj, const char *name,
1533 void *opaque)
1534{
1535 Object *child = opaque;
1536
Paolo Bonzinibffc6872014-06-11 11:57:38 +02001537 if (child->class->unparent) {
1538 (child->class->unparent)(child);
1539 }
1540 child->parent = NULL;
Anthony Liguoridb85b572011-12-23 08:47:39 -06001541 object_unref(child);
1542}
1543
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001544void object_property_add_child(Object *obj, const char *name,
1545 Object *child, Error **errp)
1546{
Paolo Bonzinib0ed5e92013-12-20 23:21:08 +01001547 Error *local_err = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001548 gchar *type;
Paolo Bonzini64607d02014-06-05 13:11:51 +02001549 ObjectProperty *op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001550
Peter Crosthwaite8faa2f82014-09-25 22:19:52 -07001551 if (child->parent != NULL) {
1552 error_setg(errp, "child object is already parented");
1553 return;
1554 }
1555
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001556 type = g_strdup_printf("child<%s>", object_get_typename(OBJECT(child)));
1557
Paolo Bonzini64607d02014-06-05 13:11:51 +02001558 op = object_property_add(obj, name, type, object_get_child_property, NULL,
1559 object_finalize_child_property, child, &local_err);
Paolo Bonzinib0ed5e92013-12-20 23:21:08 +01001560 if (local_err) {
1561 error_propagate(errp, local_err);
1562 goto out;
1563 }
Paolo Bonzini64607d02014-06-05 13:11:51 +02001564
1565 op->resolve = object_resolve_child_property;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001566 object_ref(child);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001567 child->parent = obj;
1568
Paolo Bonzinib0ed5e92013-12-20 23:21:08 +01001569out:
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001570 g_free(type);
1571}
1572
Igor Mammedov8f5d58e2017-07-14 10:14:50 +08001573void object_property_allow_set_link(const Object *obj, const char *name,
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001574 Object *val, Error **errp)
1575{
1576 /* Allow the link to be set, always */
1577}
1578
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001579typedef struct {
1580 Object **child;
Igor Mammedov8f5d58e2017-07-14 10:14:50 +08001581 void (*check)(const Object *, const char *, Object *, Error **);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001582 ObjectPropertyLinkFlags flags;
1583} LinkProperty;
1584
Eric Blaked7bce992016-01-29 06:48:55 -07001585static void object_get_link_property(Object *obj, Visitor *v,
1586 const char *name, void *opaque,
1587 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001588{
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001589 LinkProperty *lprop = opaque;
1590 Object **child = lprop->child;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001591 gchar *path;
1592
1593 if (*child) {
1594 path = object_get_canonical_path(*child);
Eric Blake51e72bc2016-01-29 06:48:54 -07001595 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001596 g_free(path);
1597 } else {
1598 path = (gchar *)"";
Eric Blake51e72bc2016-01-29 06:48:54 -07001599 visit_type_str(v, name, &path, errp);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001600 }
1601}
1602
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001603/*
1604 * object_resolve_link:
1605 *
1606 * Lookup an object and ensure its type matches the link property type. This
1607 * is similar to object_resolve_path() except type verification against the
1608 * link property is performed.
1609 *
1610 * Returns: The matched object or NULL on path lookup failures.
1611 */
1612static Object *object_resolve_link(Object *obj, const char *name,
1613 const char *path, Error **errp)
1614{
1615 const char *type;
1616 gchar *target_type;
1617 bool ambiguous = false;
1618 Object *target;
1619
1620 /* Go from link<FOO> to FOO. */
1621 type = object_property_get_type(obj, name, NULL);
1622 target_type = g_strndup(&type[5], strlen(type) - 6);
1623 target = object_resolve_path_type(path, target_type, &ambiguous);
1624
1625 if (ambiguous) {
Eric Blake455b0fd2015-11-10 23:51:20 -07001626 error_setg(errp, "Path '%s' does not uniquely identify an object",
1627 path);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001628 } else if (!target) {
1629 target = object_resolve_path(path, &ambiguous);
1630 if (target || ambiguous) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001631 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001632 } else {
Markus Armbruster75158eb2015-03-16 08:57:47 +01001633 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1634 "Device '%s' not found", path);
Stefan Hajnoczif5ec6702014-03-19 08:58:53 +01001635 }
1636 target = NULL;
1637 }
1638 g_free(target_type);
1639
1640 return target;
1641}
1642
Eric Blaked7bce992016-01-29 06:48:55 -07001643static void object_set_link_property(Object *obj, Visitor *v,
1644 const char *name, void *opaque,
1645 Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001646{
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001647 Error *local_err = NULL;
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001648 LinkProperty *prop = opaque;
1649 Object **child = prop->child;
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001650 Object *old_target = *child;
1651 Object *new_target = NULL;
1652 char *path = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001653
Eric Blake51e72bc2016-01-29 06:48:54 -07001654 visit_type_str(v, name, &path, &local_err);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001655
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001656 if (!local_err && strcmp(path, "") != 0) {
1657 new_target = object_resolve_link(obj, name, path, &local_err);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001658 }
1659
1660 g_free(path);
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001661 if (local_err) {
1662 error_propagate(errp, local_err);
1663 return;
1664 }
Alexander Barabashf0cdc962012-02-22 19:22:26 +02001665
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001666 prop->check(obj, name, new_target, &local_err);
1667 if (local_err) {
1668 error_propagate(errp, local_err);
1669 return;
1670 }
1671
Stefan Hajnoczic6aed982014-03-19 08:58:54 +01001672 *child = new_target;
Marc-André Lureau265b5782018-05-31 21:51:17 +02001673 if (prop->flags == OBJ_PROP_LINK_STRONG) {
1674 object_ref(new_target);
1675 object_unref(old_target);
1676 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001677}
1678
Paolo Bonzini64607d02014-06-05 13:11:51 +02001679static Object *object_resolve_link_property(Object *parent, void *opaque, const gchar *part)
1680{
1681 LinkProperty *lprop = opaque;
1682
1683 return *lprop->child;
1684}
1685
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001686static void object_release_link_property(Object *obj, const char *name,
1687 void *opaque)
1688{
1689 LinkProperty *prop = opaque;
1690
Marc-André Lureau265b5782018-05-31 21:51:17 +02001691 if ((prop->flags & OBJ_PROP_LINK_STRONG) && *prop->child) {
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001692 object_unref(*prop->child);
1693 }
1694 g_free(prop);
1695}
1696
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001697void object_property_add_link(Object *obj, const char *name,
1698 const char *type, Object **child,
Igor Mammedov8f5d58e2017-07-14 10:14:50 +08001699 void (*check)(const Object *, const char *,
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001700 Object *, Error **),
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001701 ObjectPropertyLinkFlags flags,
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001702 Error **errp)
1703{
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001704 Error *local_err = NULL;
1705 LinkProperty *prop = g_malloc(sizeof(*prop));
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001706 gchar *full_type;
Paolo Bonzini64607d02014-06-05 13:11:51 +02001707 ObjectProperty *op;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001708
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001709 prop->child = child;
Stefan Hajnoczi39f72ef2014-03-19 08:58:56 +01001710 prop->check = check;
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001711 prop->flags = flags;
1712
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001713 full_type = g_strdup_printf("link<%s>", type);
1714
Paolo Bonzini64607d02014-06-05 13:11:51 +02001715 op = object_property_add(obj, name, full_type,
1716 object_get_link_property,
1717 check ? object_set_link_property : NULL,
1718 object_release_link_property,
1719 prop,
1720 &local_err);
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001721 if (local_err) {
1722 error_propagate(errp, local_err);
1723 g_free(prop);
Paolo Bonzini64607d02014-06-05 13:11:51 +02001724 goto out;
Stefan Hajnoczi9561fda2014-03-19 08:58:55 +01001725 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001726
Paolo Bonzini64607d02014-06-05 13:11:51 +02001727 op->resolve = object_resolve_link_property;
1728
1729out:
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001730 g_free(full_type);
1731}
1732
Paolo Bonzinifb9e7e32015-05-05 18:29:00 +02001733void object_property_add_const_link(Object *obj, const char *name,
1734 Object *target, Error **errp)
1735{
1736 char *link_type;
1737 ObjectProperty *op;
1738
1739 link_type = g_strdup_printf("link<%s>", object_get_typename(target));
1740 op = object_property_add(obj, name, link_type,
1741 object_get_child_property, NULL,
1742 NULL, target, errp);
1743 if (op != NULL) {
1744 op->resolve = object_resolve_child_property;
1745 }
1746 g_free(link_type);
1747}
1748
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001749gchar *object_get_canonical_path_component(Object *obj)
1750{
1751 ObjectProperty *prop = NULL;
Pavel Fedinb604a852015-10-13 13:37:45 +01001752 GHashTableIter iter;
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001753
Paolo Bonzini770dec22018-04-30 11:44:17 +02001754 if (obj->parent == NULL) {
1755 return NULL;
1756 }
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001757
Pavel Fedinb604a852015-10-13 13:37:45 +01001758 g_hash_table_iter_init(&iter, obj->parent->properties);
1759 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001760 if (!object_property_is_child(prop)) {
1761 continue;
1762 }
1763
1764 if (prop->opaque == obj) {
1765 return g_strdup(prop->name);
1766 }
1767 }
1768
1769 /* obj had a parent but was not a child, should never happen */
1770 g_assert_not_reached();
1771 return NULL;
1772}
1773
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001774gchar *object_get_canonical_path(Object *obj)
1775{
1776 Object *root = object_get_root();
Stefan Hajnoczi11f590b2014-03-03 11:30:02 +01001777 char *newpath, *path = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001778
Paolo Bonzinie40077f2018-05-30 18:16:04 +02001779 if (obj == root) {
1780 return g_strdup("/");
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001781 }
1782
Paolo Bonzinie40077f2018-05-30 18:16:04 +02001783 do {
1784 char *component = object_get_canonical_path_component(obj);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001785
Paolo Bonzinie40077f2018-05-30 18:16:04 +02001786 if (!component) {
1787 /* A canonical path must be complete, so discard what was
1788 * collected so far.
1789 */
1790 g_free(path);
1791 return NULL;
1792 }
1793
1794 newpath = g_strdup_printf("/%s%s", component, path ? path : "");
1795 g_free(path);
1796 g_free(component);
1797 path = newpath;
1798 obj = obj->parent;
1799 } while (obj != root);
1800
1801 return path;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001802}
1803
Andreas Färber3e84b482013-01-15 02:55:10 +01001804Object *object_resolve_path_component(Object *parent, const gchar *part)
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001805{
Paolo Bonzini89bfe002012-04-12 18:00:18 +02001806 ObjectProperty *prop = object_property_find(parent, part, NULL);
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001807 if (prop == NULL) {
1808 return NULL;
1809 }
1810
Paolo Bonzini64607d02014-06-05 13:11:51 +02001811 if (prop->resolve) {
1812 return prop->resolve(parent, prop->opaque, part);
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001813 } else {
1814 return NULL;
1815 }
1816}
1817
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001818static Object *object_resolve_abs_path(Object *parent,
1819 gchar **parts,
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001820 const char *typename,
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001821 int index)
1822{
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001823 Object *child;
1824
1825 if (parts[index] == NULL) {
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001826 return object_dynamic_cast(parent, typename);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001827 }
1828
1829 if (strcmp(parts[index], "") == 0) {
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001830 return object_resolve_abs_path(parent, parts, typename, index + 1);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001831 }
1832
Paolo Bonzinia612b2a2012-03-27 18:38:45 +02001833 child = object_resolve_path_component(parent, parts[index]);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001834 if (!child) {
1835 return NULL;
1836 }
1837
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001838 return object_resolve_abs_path(child, parts, typename, index + 1);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001839}
1840
1841static Object *object_resolve_partial_path(Object *parent,
1842 gchar **parts,
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001843 const char *typename,
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001844 bool *ambiguous)
1845{
1846 Object *obj;
Pavel Fedinb604a852015-10-13 13:37:45 +01001847 GHashTableIter iter;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001848 ObjectProperty *prop;
1849
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001850 obj = object_resolve_abs_path(parent, parts, typename, 0);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001851
Pavel Fedinb604a852015-10-13 13:37:45 +01001852 g_hash_table_iter_init(&iter, parent->properties);
1853 while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001854 Object *found;
1855
Andreas Färber5d9d3f42012-05-27 00:32:40 +02001856 if (!object_property_is_child(prop)) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001857 continue;
1858 }
1859
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001860 found = object_resolve_partial_path(prop->opaque, parts,
1861 typename, ambiguous);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001862 if (found) {
1863 if (obj) {
Eduardo Habkostebcc4792017-07-07 18:30:52 -03001864 *ambiguous = true;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001865 return NULL;
1866 }
1867 obj = found;
1868 }
1869
Eduardo Habkostebcc4792017-07-07 18:30:52 -03001870 if (*ambiguous) {
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001871 return NULL;
1872 }
1873 }
1874
1875 return obj;
1876}
1877
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001878Object *object_resolve_path_type(const char *path, const char *typename,
Eduardo Habkostebcc4792017-07-07 18:30:52 -03001879 bool *ambiguousp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001880{
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001881 Object *obj;
1882 gchar **parts;
1883
1884 parts = g_strsplit(path, "/", 0);
Paolo Bonzini2e1103f2013-04-18 18:44:02 +02001885 assert(parts);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001886
Paolo Bonzini2e1103f2013-04-18 18:44:02 +02001887 if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
Eduardo Habkostebcc4792017-07-07 18:30:52 -03001888 bool ambiguous = false;
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001889 obj = object_resolve_partial_path(object_get_root(), parts,
Eduardo Habkostebcc4792017-07-07 18:30:52 -03001890 typename, &ambiguous);
1891 if (ambiguousp) {
1892 *ambiguousp = ambiguous;
1893 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001894 } else {
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001895 obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001896 }
1897
1898 g_strfreev(parts);
1899
1900 return obj;
1901}
1902
Paolo Bonzini02fe2db2012-02-03 11:21:01 +01001903Object *object_resolve_path(const char *path, bool *ambiguous)
1904{
1905 return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
1906}
1907
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001908typedef struct StringProperty
1909{
1910 char *(*get)(Object *, Error **);
1911 void (*set)(Object *, const char *, Error **);
1912} StringProperty;
1913
Eric Blaked7bce992016-01-29 06:48:55 -07001914static void property_get_str(Object *obj, Visitor *v, const char *name,
1915 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001916{
1917 StringProperty *prop = opaque;
1918 char *value;
Markus Armbrustere1c82372015-08-25 20:00:46 +02001919 Error *err = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001920
Markus Armbrustere1c82372015-08-25 20:00:46 +02001921 value = prop->get(obj, &err);
1922 if (err) {
1923 error_propagate(errp, err);
1924 return;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001925 }
Markus Armbrustere1c82372015-08-25 20:00:46 +02001926
Eric Blake51e72bc2016-01-29 06:48:54 -07001927 visit_type_str(v, name, &value, errp);
Markus Armbrustere1c82372015-08-25 20:00:46 +02001928 g_free(value);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001929}
1930
Eric Blaked7bce992016-01-29 06:48:55 -07001931static void property_set_str(Object *obj, Visitor *v, const char *name,
1932 void *opaque, Error **errp)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001933{
1934 StringProperty *prop = opaque;
1935 char *value;
1936 Error *local_err = NULL;
1937
Eric Blake51e72bc2016-01-29 06:48:54 -07001938 visit_type_str(v, name, &value, &local_err);
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001939 if (local_err) {
1940 error_propagate(errp, local_err);
1941 return;
1942 }
1943
1944 prop->set(obj, value, errp);
1945 g_free(value);
1946}
1947
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001948static void property_release_str(Object *obj, const char *name,
1949 void *opaque)
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001950{
1951 StringProperty *prop = opaque;
1952 g_free(prop);
1953}
1954
1955void object_property_add_str(Object *obj, const char *name,
1956 char *(*get)(Object *, Error **),
1957 void (*set)(Object *, const char *, Error **),
1958 Error **errp)
1959{
Stefan Hajnoczia01aedc2014-03-04 15:28:18 +01001960 Error *local_err = NULL;
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001961 StringProperty *prop = g_malloc0(sizeof(*prop));
1962
1963 prop->get = get;
1964 prop->set = set;
1965
1966 object_property_add(obj, name, "string",
Paolo Bonzini7b7b7d12012-02-01 17:16:22 +01001967 get ? property_get_str : NULL,
1968 set ? property_set_str : NULL,
1969 property_release_str,
Stefan Hajnoczia01aedc2014-03-04 15:28:18 +01001970 prop, &local_err);
1971 if (local_err) {
1972 error_propagate(errp, local_err);
1973 g_free(prop);
1974 }
Anthony Liguori57c9faf2012-01-30 08:55:55 -06001975}
Paolo Bonzini745549c2012-03-31 16:45:54 +02001976
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01001977void object_class_property_add_str(ObjectClass *klass, const char *name,
1978 char *(*get)(Object *, Error **),
1979 void (*set)(Object *, const char *,
1980 Error **),
1981 Error **errp)
1982{
1983 Error *local_err = NULL;
1984 StringProperty *prop = g_malloc0(sizeof(*prop));
1985
1986 prop->get = get;
1987 prop->set = set;
1988
1989 object_class_property_add(klass, name, "string",
1990 get ? property_get_str : NULL,
1991 set ? property_set_str : NULL,
1992 property_release_str,
1993 prop, &local_err);
1994 if (local_err) {
1995 error_propagate(errp, local_err);
1996 g_free(prop);
1997 }
1998}
1999
Anthony Liguori0e558842012-06-25 10:32:46 -05002000typedef struct BoolProperty
2001{
2002 bool (*get)(Object *, Error **);
2003 void (*set)(Object *, bool, Error **);
2004} BoolProperty;
2005
Eric Blaked7bce992016-01-29 06:48:55 -07002006static void property_get_bool(Object *obj, Visitor *v, const char *name,
2007 void *opaque, Error **errp)
Anthony Liguori0e558842012-06-25 10:32:46 -05002008{
2009 BoolProperty *prop = opaque;
2010 bool value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002011 Error *err = NULL;
Anthony Liguori0e558842012-06-25 10:32:46 -05002012
Markus Armbruster4715d422015-08-25 20:00:45 +02002013 value = prop->get(obj, &err);
2014 if (err) {
2015 error_propagate(errp, err);
2016 return;
2017 }
2018
Eric Blake51e72bc2016-01-29 06:48:54 -07002019 visit_type_bool(v, name, &value, errp);
Anthony Liguori0e558842012-06-25 10:32:46 -05002020}
2021
Eric Blaked7bce992016-01-29 06:48:55 -07002022static void property_set_bool(Object *obj, Visitor *v, const char *name,
2023 void *opaque, Error **errp)
Anthony Liguori0e558842012-06-25 10:32:46 -05002024{
2025 BoolProperty *prop = opaque;
2026 bool value;
2027 Error *local_err = NULL;
2028
Eric Blake51e72bc2016-01-29 06:48:54 -07002029 visit_type_bool(v, name, &value, &local_err);
Anthony Liguori0e558842012-06-25 10:32:46 -05002030 if (local_err) {
2031 error_propagate(errp, local_err);
2032 return;
2033 }
2034
2035 prop->set(obj, value, errp);
2036}
2037
2038static void property_release_bool(Object *obj, const char *name,
2039 void *opaque)
2040{
2041 BoolProperty *prop = opaque;
2042 g_free(prop);
2043}
2044
2045void object_property_add_bool(Object *obj, const char *name,
2046 bool (*get)(Object *, Error **),
2047 void (*set)(Object *, bool, Error **),
2048 Error **errp)
2049{
Stefan Hajnoczia01aedc2014-03-04 15:28:18 +01002050 Error *local_err = NULL;
Anthony Liguori0e558842012-06-25 10:32:46 -05002051 BoolProperty *prop = g_malloc0(sizeof(*prop));
2052
2053 prop->get = get;
2054 prop->set = set;
2055
2056 object_property_add(obj, name, "bool",
2057 get ? property_get_bool : NULL,
2058 set ? property_set_bool : NULL,
2059 property_release_bool,
Stefan Hajnoczia01aedc2014-03-04 15:28:18 +01002060 prop, &local_err);
2061 if (local_err) {
2062 error_propagate(errp, local_err);
2063 g_free(prop);
2064 }
Anthony Liguori0e558842012-06-25 10:32:46 -05002065}
2066
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002067void object_class_property_add_bool(ObjectClass *klass, const char *name,
2068 bool (*get)(Object *, Error **),
2069 void (*set)(Object *, bool, Error **),
2070 Error **errp)
2071{
2072 Error *local_err = NULL;
2073 BoolProperty *prop = g_malloc0(sizeof(*prop));
2074
2075 prop->get = get;
2076 prop->set = set;
2077
2078 object_class_property_add(klass, name, "bool",
2079 get ? property_get_bool : NULL,
2080 set ? property_set_bool : NULL,
2081 property_release_bool,
2082 prop, &local_err);
2083 if (local_err) {
2084 error_propagate(errp, local_err);
2085 g_free(prop);
2086 }
2087}
2088
Eric Blaked7bce992016-01-29 06:48:55 -07002089static void property_get_enum(Object *obj, Visitor *v, const char *name,
2090 void *opaque, Error **errp)
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002091{
2092 EnumProperty *prop = opaque;
2093 int value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002094 Error *err = NULL;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002095
Markus Armbruster4715d422015-08-25 20:00:45 +02002096 value = prop->get(obj, &err);
2097 if (err) {
2098 error_propagate(errp, err);
2099 return;
2100 }
2101
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002102 visit_type_enum(v, name, &value, prop->lookup, errp);
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002103}
2104
Eric Blaked7bce992016-01-29 06:48:55 -07002105static void property_set_enum(Object *obj, Visitor *v, const char *name,
2106 void *opaque, Error **errp)
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002107{
2108 EnumProperty *prop = opaque;
2109 int value;
Markus Armbruster4715d422015-08-25 20:00:45 +02002110 Error *err = NULL;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002111
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002112 visit_type_enum(v, name, &value, prop->lookup, &err);
Markus Armbruster4715d422015-08-25 20:00:45 +02002113 if (err) {
2114 error_propagate(errp, err);
2115 return;
2116 }
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002117 prop->set(obj, value, errp);
2118}
2119
2120static void property_release_enum(Object *obj, const char *name,
2121 void *opaque)
2122{
2123 EnumProperty *prop = opaque;
2124 g_free(prop);
2125}
2126
2127void object_property_add_enum(Object *obj, const char *name,
2128 const char *typename,
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002129 const QEnumLookup *lookup,
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002130 int (*get)(Object *, Error **),
2131 void (*set)(Object *, int, Error **),
2132 Error **errp)
2133{
2134 Error *local_err = NULL;
2135 EnumProperty *prop = g_malloc(sizeof(*prop));
2136
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002137 prop->lookup = lookup;
Daniel P. Berrangea8e3fbe2015-05-13 17:14:08 +01002138 prop->get = get;
2139 prop->set = set;
2140
2141 object_property_add(obj, name, typename,
2142 get ? property_get_enum : NULL,
2143 set ? property_set_enum : NULL,
2144 property_release_enum,
2145 prop, &local_err);
2146 if (local_err) {
2147 error_propagate(errp, local_err);
2148 g_free(prop);
2149 }
2150}
2151
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002152void object_class_property_add_enum(ObjectClass *klass, const char *name,
2153 const char *typename,
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002154 const QEnumLookup *lookup,
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002155 int (*get)(Object *, Error **),
2156 void (*set)(Object *, int, Error **),
2157 Error **errp)
2158{
2159 Error *local_err = NULL;
2160 EnumProperty *prop = g_malloc(sizeof(*prop));
2161
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02002162 prop->lookup = lookup;
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002163 prop->get = get;
2164 prop->set = set;
2165
2166 object_class_property_add(klass, name, typename,
2167 get ? property_get_enum : NULL,
2168 set ? property_set_enum : NULL,
2169 property_release_enum,
2170 prop, &local_err);
2171 if (local_err) {
2172 error_propagate(errp, local_err);
2173 g_free(prop);
2174 }
2175}
2176
David Gibson8e099d12015-02-06 14:55:45 +11002177typedef struct TMProperty {
2178 void (*get)(Object *, struct tm *, Error **);
2179} TMProperty;
2180
Eric Blaked7bce992016-01-29 06:48:55 -07002181static void property_get_tm(Object *obj, Visitor *v, const char *name,
2182 void *opaque, Error **errp)
David Gibson8e099d12015-02-06 14:55:45 +11002183{
2184 TMProperty *prop = opaque;
2185 Error *err = NULL;
2186 struct tm value;
2187
2188 prop->get(obj, &value, &err);
2189 if (err) {
2190 goto out;
2191 }
2192
Eric Blake337283d2016-01-29 06:48:57 -07002193 visit_start_struct(v, name, NULL, 0, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002194 if (err) {
2195 goto out;
2196 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002197 visit_type_int32(v, "tm_year", &value.tm_year, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002198 if (err) {
2199 goto out_end;
2200 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002201 visit_type_int32(v, "tm_mon", &value.tm_mon, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002202 if (err) {
2203 goto out_end;
2204 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002205 visit_type_int32(v, "tm_mday", &value.tm_mday, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002206 if (err) {
2207 goto out_end;
2208 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002209 visit_type_int32(v, "tm_hour", &value.tm_hour, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002210 if (err) {
2211 goto out_end;
2212 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002213 visit_type_int32(v, "tm_min", &value.tm_min, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002214 if (err) {
2215 goto out_end;
2216 }
Eric Blake51e72bc2016-01-29 06:48:54 -07002217 visit_type_int32(v, "tm_sec", &value.tm_sec, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002218 if (err) {
2219 goto out_end;
2220 }
Eric Blake15c2f662016-04-28 15:45:27 -06002221 visit_check_struct(v, &err);
David Gibson8e099d12015-02-06 14:55:45 +11002222out_end:
Eric Blake1158bb22016-06-09 10:48:34 -06002223 visit_end_struct(v, NULL);
David Gibson8e099d12015-02-06 14:55:45 +11002224out:
2225 error_propagate(errp, err);
2226
2227}
2228
2229static void property_release_tm(Object *obj, const char *name,
2230 void *opaque)
2231{
2232 TMProperty *prop = opaque;
2233 g_free(prop);
2234}
2235
2236void object_property_add_tm(Object *obj, const char *name,
2237 void (*get)(Object *, struct tm *, Error **),
2238 Error **errp)
2239{
2240 Error *local_err = NULL;
2241 TMProperty *prop = g_malloc0(sizeof(*prop));
2242
2243 prop->get = get;
2244
2245 object_property_add(obj, name, "struct tm",
2246 get ? property_get_tm : NULL, NULL,
2247 property_release_tm,
2248 prop, &local_err);
2249 if (local_err) {
2250 error_propagate(errp, local_err);
2251 g_free(prop);
2252 }
2253}
2254
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002255void object_class_property_add_tm(ObjectClass *klass, const char *name,
2256 void (*get)(Object *, struct tm *, Error **),
2257 Error **errp)
2258{
2259 Error *local_err = NULL;
2260 TMProperty *prop = g_malloc0(sizeof(*prop));
2261
2262 prop->get = get;
2263
2264 object_class_property_add(klass, name, "struct tm",
2265 get ? property_get_tm : NULL, NULL,
2266 property_release_tm,
2267 prop, &local_err);
2268 if (local_err) {
2269 error_propagate(errp, local_err);
2270 g_free(prop);
2271 }
2272}
2273
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002274static char *qdev_get_type(Object *obj, Error **errp)
2275{
2276 return g_strdup(object_get_typename(obj));
2277}
2278
Eric Blaked7bce992016-01-29 06:48:55 -07002279static void property_get_uint8_ptr(Object *obj, Visitor *v, const char *name,
2280 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002281{
2282 uint8_t value = *(uint8_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002283 visit_type_uint8(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002284}
2285
Eric Blaked7bce992016-01-29 06:48:55 -07002286static void property_get_uint16_ptr(Object *obj, Visitor *v, const char *name,
2287 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002288{
2289 uint16_t value = *(uint16_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002290 visit_type_uint16(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002291}
2292
Eric Blaked7bce992016-01-29 06:48:55 -07002293static void property_get_uint32_ptr(Object *obj, Visitor *v, const char *name,
2294 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002295{
2296 uint32_t value = *(uint32_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002297 visit_type_uint32(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002298}
2299
Eric Blaked7bce992016-01-29 06:48:55 -07002300static void property_get_uint64_ptr(Object *obj, Visitor *v, const char *name,
2301 void *opaque, Error **errp)
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002302{
2303 uint64_t value = *(uint64_t *)opaque;
Eric Blake51e72bc2016-01-29 06:48:54 -07002304 visit_type_uint64(v, name, &value, errp);
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002305}
2306
2307void object_property_add_uint8_ptr(Object *obj, const char *name,
2308 const uint8_t *v, Error **errp)
2309{
2310 object_property_add(obj, name, "uint8", property_get_uint8_ptr,
2311 NULL, NULL, (void *)v, errp);
2312}
2313
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002314void object_class_property_add_uint8_ptr(ObjectClass *klass, const char *name,
2315 const uint8_t *v, Error **errp)
2316{
2317 object_class_property_add(klass, name, "uint8", property_get_uint8_ptr,
2318 NULL, NULL, (void *)v, errp);
2319}
2320
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002321void object_property_add_uint16_ptr(Object *obj, const char *name,
2322 const uint16_t *v, Error **errp)
2323{
2324 object_property_add(obj, name, "uint16", property_get_uint16_ptr,
2325 NULL, NULL, (void *)v, errp);
2326}
2327
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002328void object_class_property_add_uint16_ptr(ObjectClass *klass, const char *name,
2329 const uint16_t *v, Error **errp)
2330{
2331 object_class_property_add(klass, name, "uint16", property_get_uint16_ptr,
2332 NULL, NULL, (void *)v, errp);
2333}
2334
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002335void object_property_add_uint32_ptr(Object *obj, const char *name,
2336 const uint32_t *v, Error **errp)
2337{
2338 object_property_add(obj, name, "uint32", property_get_uint32_ptr,
2339 NULL, NULL, (void *)v, errp);
2340}
2341
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002342void object_class_property_add_uint32_ptr(ObjectClass *klass, const char *name,
2343 const uint32_t *v, Error **errp)
2344{
2345 object_class_property_add(klass, name, "uint32", property_get_uint32_ptr,
2346 NULL, NULL, (void *)v, errp);
2347}
2348
Michael S. Tsirkine732ea62013-09-22 10:10:17 +03002349void object_property_add_uint64_ptr(Object *obj, const char *name,
2350 const uint64_t *v, Error **errp)
2351{
2352 object_property_add(obj, name, "uint64", property_get_uint64_ptr,
2353 NULL, NULL, (void *)v, errp);
2354}
2355
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002356void object_class_property_add_uint64_ptr(ObjectClass *klass, const char *name,
2357 const uint64_t *v, Error **errp)
2358{
2359 object_class_property_add(klass, name, "uint64", property_get_uint64_ptr,
2360 NULL, NULL, (void *)v, errp);
2361}
2362
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002363typedef struct {
2364 Object *target_obj;
Eduardo Habkost1590d262015-04-09 16:57:29 -03002365 char *target_name;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002366} AliasProperty;
2367
Eric Blaked7bce992016-01-29 06:48:55 -07002368static void property_get_alias(Object *obj, Visitor *v, const char *name,
2369 void *opaque, Error **errp)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002370{
2371 AliasProperty *prop = opaque;
2372
2373 object_property_get(prop->target_obj, v, prop->target_name, errp);
2374}
2375
Eric Blaked7bce992016-01-29 06:48:55 -07002376static void property_set_alias(Object *obj, Visitor *v, const char *name,
2377 void *opaque, Error **errp)
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002378{
2379 AliasProperty *prop = opaque;
2380
2381 object_property_set(prop->target_obj, v, prop->target_name, errp);
2382}
2383
Paolo Bonzini64607d02014-06-05 13:11:51 +02002384static Object *property_resolve_alias(Object *obj, void *opaque,
2385 const gchar *part)
2386{
2387 AliasProperty *prop = opaque;
2388
2389 return object_resolve_path_component(prop->target_obj, prop->target_name);
2390}
2391
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002392static void property_release_alias(Object *obj, const char *name, void *opaque)
2393{
2394 AliasProperty *prop = opaque;
2395
Eduardo Habkost1590d262015-04-09 16:57:29 -03002396 g_free(prop->target_name);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002397 g_free(prop);
2398}
2399
2400void object_property_add_alias(Object *obj, const char *name,
2401 Object *target_obj, const char *target_name,
2402 Error **errp)
2403{
2404 AliasProperty *prop;
Paolo Bonzini64607d02014-06-05 13:11:51 +02002405 ObjectProperty *op;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002406 ObjectProperty *target_prop;
Paolo Bonzinid1906982014-06-10 11:17:35 +02002407 gchar *prop_type;
Gonglei8ae9a9e2014-09-27 13:13:56 +08002408 Error *local_err = NULL;
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002409
2410 target_prop = object_property_find(target_obj, target_name, errp);
2411 if (!target_prop) {
2412 return;
2413 }
2414
Paolo Bonzinid1906982014-06-10 11:17:35 +02002415 if (object_property_is_child(target_prop)) {
2416 prop_type = g_strdup_printf("link%s",
2417 target_prop->type + strlen("child"));
2418 } else {
2419 prop_type = g_strdup(target_prop->type);
2420 }
2421
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002422 prop = g_malloc(sizeof(*prop));
2423 prop->target_obj = target_obj;
Eduardo Habkost1590d262015-04-09 16:57:29 -03002424 prop->target_name = g_strdup(target_name);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002425
Paolo Bonzinid1906982014-06-10 11:17:35 +02002426 op = object_property_add(obj, name, prop_type,
Paolo Bonzini64607d02014-06-05 13:11:51 +02002427 property_get_alias,
2428 property_set_alias,
2429 property_release_alias,
Gonglei8ae9a9e2014-09-27 13:13:56 +08002430 prop, &local_err);
2431 if (local_err) {
2432 error_propagate(errp, local_err);
2433 g_free(prop);
2434 goto out;
2435 }
Paolo Bonzini64607d02014-06-05 13:11:51 +02002436 op->resolve = property_resolve_alias;
Paolo Bonzinid1906982014-06-10 11:17:35 +02002437
Andreas Färbera18bb412015-03-27 17:34:10 +01002438 object_property_set_description(obj, op->name,
Gonglei80742642014-10-07 14:33:21 +08002439 target_prop->description,
2440 &error_abort);
2441
Gonglei8ae9a9e2014-09-27 13:13:56 +08002442out:
Paolo Bonzinid1906982014-06-10 11:17:35 +02002443 g_free(prop_type);
Stefan Hajnoczief7c7ff2014-06-18 17:58:28 +08002444}
2445
Gonglei80742642014-10-07 14:33:21 +08002446void object_property_set_description(Object *obj, const char *name,
2447 const char *description, Error **errp)
2448{
2449 ObjectProperty *op;
2450
2451 op = object_property_find(obj, name, errp);
2452 if (!op) {
2453 return;
2454 }
2455
2456 g_free(op->description);
2457 op->description = g_strdup(description);
2458}
2459
Daniel P. Berrange16bf7f52015-10-13 13:37:46 +01002460void object_class_property_set_description(ObjectClass *klass,
2461 const char *name,
2462 const char *description,
2463 Error **errp)
2464{
2465 ObjectProperty *op;
2466
2467 op = g_hash_table_lookup(klass->properties, name);
2468 if (!op) {
2469 error_setg(errp, "Property '.%s' not found", name);
2470 return;
2471 }
2472
2473 g_free(op->description);
2474 op->description = g_strdup(description);
2475}
2476
Marc-André Lureau7439a032018-09-06 18:09:32 +04002477static void object_class_init(ObjectClass *klass, void *data)
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002478{
Marc-André Lureau7439a032018-09-06 18:09:32 +04002479 object_class_property_add_str(klass, "type", qdev_get_type,
2480 NULL, &error_abort);
Paolo Bonzini2f262e02012-04-02 17:33:51 +02002481}
2482
Paolo Bonzini745549c2012-03-31 16:45:54 +02002483static void register_types(void)
2484{
2485 static TypeInfo interface_info = {
2486 .name = TYPE_INTERFACE,
Anthony Liguori33e95c62012-08-10 13:16:10 +10002487 .class_size = sizeof(InterfaceClass),
Paolo Bonzini745549c2012-03-31 16:45:54 +02002488 .abstract = true,
2489 };
2490
2491 static TypeInfo object_info = {
2492 .name = TYPE_OBJECT,
2493 .instance_size = sizeof(Object),
Marc-André Lureau7439a032018-09-06 18:09:32 +04002494 .class_init = object_class_init,
Paolo Bonzini745549c2012-03-31 16:45:54 +02002495 .abstract = true,
2496 };
2497
Paolo Bonzini049cb3c2012-04-04 15:58:40 +02002498 type_interface = type_register_internal(&interface_info);
2499 type_register_internal(&object_info);
Paolo Bonzini745549c2012-03-31 16:45:54 +02002500}
2501
2502type_init(register_types)