master
c 733 lines 20 KB
Raw
1 /*
2 * Copyright (C) 2015 Red Hat, Inc.
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library. If not, see
16 * <http://www.gnu.org/licenses/>.
17 *
18 * Author: Daniel P. Berrange <berrange@redhat.com>
19 */
20
21 #include "qemu/osdep.h"
22
23 #include "qapi/error.h"
24 #include "qapi/qobject-input-visitor.h"
25 #include "qobject/qdict.h"
26 #include "qobject/qobject.h"
27 #include "qom/object.h"
28 #include "qemu/module.h"
29 #include "qemu/option.h"
30 #include "qemu/keyval.h"
31 #include "qemu/config-file.h"
32 #include "qom/object_interfaces.h"
33
34
35 #define TYPE_DUMMY "qemu-dummy"
36
37 typedef struct DummyObject DummyObject;
38 typedef struct DummyObjectClass DummyObjectClass;
39
40 DECLARE_INSTANCE_CHECKER(DummyObject, DUMMY_OBJECT,
41 TYPE_DUMMY)
42
43 typedef enum DummyAnimal DummyAnimal;
44
45 enum DummyAnimal {
46 DUMMY_FROG,
47 DUMMY_ALLIGATOR,
48 DUMMY_PLATYPUS,
49
50 DUMMY_LAST,
51 };
52
53 const QEnumLookup dummy_animal_map = {
54 .array = (const char *const[]) {
55 [DUMMY_FROG] = "frog",
56 [DUMMY_ALLIGATOR] = "alligator",
57 [DUMMY_PLATYPUS] = "platypus",
58 },
59 .size = DUMMY_LAST
60 };
61
62 struct DummyObject {
63 Object parent_obj;
64
65 bool bv;
66 DummyAnimal av;
67 char *sv;
68 };
69
70 struct DummyObjectClass {
71 ObjectClass parent_class;
72 };
73
74
75 static void dummy_set_bv(Object *obj,
76 bool value,
77 Error **errp)
78 {
79 DummyObject *dobj = DUMMY_OBJECT(obj);
80
81 dobj->bv = value;
82 }
83
84 static bool dummy_get_bv(Object *obj,
85 Error **errp)
86 {
87 DummyObject *dobj = DUMMY_OBJECT(obj);
88
89 return dobj->bv;
90 }
91
92
93 static void dummy_set_av(Object *obj,
94 int value,
95 Error **errp)
96 {
97 DummyObject *dobj = DUMMY_OBJECT(obj);
98
99 dobj->av = value;
100 }
101
102 static int dummy_get_av(Object *obj,
103 Error **errp)
104 {
105 DummyObject *dobj = DUMMY_OBJECT(obj);
106
107 return dobj->av;
108 }
109
110
111 static void dummy_set_sv(Object *obj,
112 const char *value,
113 Error **errp)
114 {
115 DummyObject *dobj = DUMMY_OBJECT(obj);
116
117 g_free(dobj->sv);
118 dobj->sv = g_strdup(value);
119 }
120
121 static char *dummy_get_sv(Object *obj,
122 Error **errp)
123 {
124 DummyObject *dobj = DUMMY_OBJECT(obj);
125
126 return g_strdup(dobj->sv);
127 }
128
129
130 static void dummy_init(Object *obj)
131 {
132 object_property_add_bool(obj, "bv",
133 dummy_get_bv,
134 dummy_set_bv);
135 }
136
137
138 static void dummy_class_init(ObjectClass *cls, const void *data)
139 {
140 object_class_property_add_str(cls, "sv",
141 dummy_get_sv,
142 dummy_set_sv);
143 object_class_property_add_enum(cls, "av",
144 "DummyAnimal",
145 &dummy_animal_map,
146 dummy_get_av,
147 dummy_set_av);
148 }
149
150
151 static void dummy_finalize(Object *obj)
152 {
153 DummyObject *dobj = DUMMY_OBJECT(obj);
154
155 g_free(dobj->sv);
156 }
157
158
159 static const TypeInfo dummy_info = {
160 .name = TYPE_DUMMY,
161 .parent = TYPE_OBJECT,
162 .instance_size = sizeof(DummyObject),
163 .instance_init = dummy_init,
164 .instance_finalize = dummy_finalize,
165 .class_size = sizeof(DummyObjectClass),
166 .class_init = dummy_class_init,
167 .interfaces = (const InterfaceInfo[]) {
168 { TYPE_USER_CREATABLE },
169 { }
170 }
171 };
172
173
174 /*
175 * The following 3 object classes are used to
176 * simulate the kind of relationships seen in
177 * qdev, which result in complex object
178 * property destruction ordering.
179 *
180 * DummyDev has a 'bus' child to a DummyBus
181 * DummyBus has a 'backend' child to a DummyBackend
182 * DummyDev has a 'backend' link to DummyBackend
183 *
184 * When DummyDev is finalized, it unparents the
185 * DummyBackend, which unparents the DummyDev
186 * which deletes the 'backend' link from DummyDev
187 * to DummyBackend. This illustrates that the
188 * object_property_del_all() method needs to
189 * cope with the list of properties being changed
190 * while it iterates over them.
191 */
192 typedef struct DummyDev DummyDev;
193 typedef struct DummyDevClass DummyDevClass;
194 typedef struct DummyBus DummyBus;
195 typedef struct DummyBusClass DummyBusClass;
196 typedef struct DummyBackend DummyBackend;
197 typedef struct DummyBackendClass DummyBackendClass;
198
199 #define TYPE_DUMMY_DEV "qemu-dummy-dev"
200 #define TYPE_DUMMY_BUS "qemu-dummy-bus"
201 #define TYPE_DUMMY_BACKEND "qemu-dummy-backend"
202
203 DECLARE_INSTANCE_CHECKER(DummyDev, DUMMY_DEV,
204 TYPE_DUMMY_DEV)
205 DECLARE_INSTANCE_CHECKER(DummyBus, DUMMY_BUS,
206 TYPE_DUMMY_BUS)
207 DECLARE_INSTANCE_CHECKER(DummyBackend, DUMMY_BACKEND,
208 TYPE_DUMMY_BACKEND)
209
210 struct DummyDev {
211 Object parent_obj;
212
213 DummyBus *bus;
214 };
215
216 struct DummyDevClass {
217 ObjectClass parent_class;
218 };
219
220 struct DummyBus {
221 Object parent_obj;
222
223 DummyBackend *backend;
224 };
225
226 struct DummyBusClass {
227 ObjectClass parent_class;
228 };
229
230 struct DummyBackend {
231 Object parent_obj;
232 };
233
234 struct DummyBackendClass {
235 ObjectClass parent_class;
236 };
237
238
239 static void dummy_dev_finalize(Object *obj)
240 {
241 DummyDev *dev = DUMMY_DEV(obj);
242
243 object_unref(OBJECT(dev->bus));
244 }
245
246 static void dummy_dev_init(Object *obj)
247 {
248 DummyDev *dev = DUMMY_DEV(obj);
249 DummyBus *bus = DUMMY_BUS(object_new(TYPE_DUMMY_BUS));
250 DummyBackend *backend = DUMMY_BACKEND(object_new(TYPE_DUMMY_BACKEND));
251
252 object_property_add_child(obj, "bus", OBJECT(bus));
253 dev->bus = bus;
254 object_property_add_child(OBJECT(bus), "backend", OBJECT(backend));
255 bus->backend = backend;
256
257 object_property_add_link(obj, "backend", TYPE_DUMMY_BACKEND,
258 (Object **)&bus->backend, NULL, 0);
259 }
260
261 static void dummy_dev_unparent(Object *obj)
262 {
263 DummyDev *dev = DUMMY_DEV(obj);
264 object_unparent(OBJECT(dev->bus));
265 }
266
267 static void dummy_dev_class_init(ObjectClass *klass, const void *opaque)
268 {
269 klass->unparent = dummy_dev_unparent;
270 }
271
272
273 static void dummy_bus_finalize(Object *obj)
274 {
275 DummyBus *bus = DUMMY_BUS(obj);
276
277 object_unref(OBJECT(bus->backend));
278 }
279
280 static void dummy_bus_init(Object *obj)
281 {
282 }
283
284 static void dummy_bus_unparent(Object *obj)
285 {
286 DummyBus *bus = DUMMY_BUS(obj);
287 object_property_del(obj->parent, "backend");
288 object_unparent(OBJECT(bus->backend));
289 }
290
291 static void dummy_bus_class_init(ObjectClass *klass, const void *opaque)
292 {
293 klass->unparent = dummy_bus_unparent;
294 }
295
296 static void dummy_backend_init(Object *obj)
297 {
298 }
299
300
301 static const TypeInfo dummy_dev_info = {
302 .name = TYPE_DUMMY_DEV,
303 .parent = TYPE_OBJECT,
304 .instance_size = sizeof(DummyDev),
305 .instance_init = dummy_dev_init,
306 .instance_finalize = dummy_dev_finalize,
307 .class_size = sizeof(DummyDevClass),
308 .class_init = dummy_dev_class_init,
309 };
310
311 static const TypeInfo dummy_bus_info = {
312 .name = TYPE_DUMMY_BUS,
313 .parent = TYPE_OBJECT,
314 .instance_size = sizeof(DummyBus),
315 .instance_init = dummy_bus_init,
316 .instance_finalize = dummy_bus_finalize,
317 .class_size = sizeof(DummyBusClass),
318 .class_init = dummy_bus_class_init,
319 };
320
321 static const TypeInfo dummy_backend_info = {
322 .name = TYPE_DUMMY_BACKEND,
323 .parent = TYPE_OBJECT,
324 .instance_size = sizeof(DummyBackend),
325 .instance_init = dummy_backend_init,
326 .class_size = sizeof(DummyBackendClass),
327 };
328
329 static QemuOptsList qemu_object_opts = {
330 .name = "object",
331 .implied_opt_name = "qom-type",
332 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
333 .desc = {
334 { }
335 },
336 };
337
338
339 static void test_dummy_createv_tree(void)
340 {
341 Error *err = NULL;
342 Object *parent = object_get_objects_root();
343 DummyObject *dobj = DUMMY_OBJECT(
344 object_new_with_props(TYPE_DUMMY,
345 parent,
346 "dummy0",
347 &err,
348 "bv", "yes",
349 "sv", "Hiss hiss hiss",
350 "av", "platypus",
351 NULL));
352
353 g_assert(err == NULL);
354 g_assert_cmpint(dobj->parent_obj.ref, ==, 1);
355 g_assert_cmpstr(dobj->sv, ==, "Hiss hiss hiss");
356 g_assert(dobj->bv == true);
357 g_assert(dobj->av == DUMMY_PLATYPUS);
358
359 g_assert(object_resolve_path_component(parent, "dummy0")
360 == OBJECT(dobj));
361
362 object_unparent(OBJECT(dobj));
363 }
364
365
366 static void test_dummy_createv_parentless(void)
367 {
368 Error *err = NULL;
369 DummyObject *dobj = DUMMY_OBJECT(
370 object_new_with_props_parentless(TYPE_DUMMY,
371 &err,
372 "bv", "yes",
373 "sv", "Hiss hiss hiss",
374 "av", "platypus",
375 NULL));
376
377 g_assert(err == NULL);
378 g_assert_cmpint(dobj->parent_obj.ref, ==, 1);
379 g_assert_cmpstr(dobj->sv, ==, "Hiss hiss hiss");
380 g_assert(dobj->bv == true);
381 g_assert(dobj->av == DUMMY_PLATYPUS);
382
383 object_unref(OBJECT(dobj));
384 }
385
386
387 static Object *new_helper_tree(Error **errp,
388 Object *parent,
389 ...)
390 {
391 va_list vargs;
392 Object *obj;
393
394 va_start(vargs, parent);
395 obj = object_new_with_propv(TYPE_DUMMY,
396 parent,
397 "dummy0",
398 vargs,
399 errp);
400 va_end(vargs);
401 return obj;
402 }
403
404 static void test_dummy_createlist_tree(void)
405 {
406 Error *err = NULL;
407 Object *parent = object_get_objects_root();
408 DummyObject *dobj = DUMMY_OBJECT(
409 new_helper_tree(&err,
410 parent,
411 "bv", "yes",
412 "sv", "Hiss hiss hiss",
413 "av", "platypus",
414 NULL));
415
416 g_assert(err == NULL);
417 g_assert_cmpint(dobj->parent_obj.ref, ==, 1);
418 g_assert_cmpstr(dobj->sv, ==, "Hiss hiss hiss");
419 g_assert(dobj->bv == true);
420 g_assert(dobj->av == DUMMY_PLATYPUS);
421
422 g_assert(object_resolve_path_component(parent, "dummy0")
423 == OBJECT(dobj));
424
425 object_unparent(OBJECT(dobj));
426 }
427
428 static Object *new_helper_parentless(Error **errp,
429 ...)
430 {
431 va_list vargs;
432 Object *obj;
433
434 va_start(vargs, errp);
435 obj = object_new_with_propv_parentless(TYPE_DUMMY,
436 vargs,
437 errp);
438 va_end(vargs);
439 return obj;
440 }
441
442 static void test_dummy_createlist_parentless(void)
443 {
444 Error *err = NULL;
445 DummyObject *dobj = DUMMY_OBJECT(
446 new_helper_parentless(&err,
447 "bv", "yes",
448 "sv", "Hiss hiss hiss",
449 "av", "platypus",
450 NULL));
451
452 g_assert(err == NULL);
453 g_assert_cmpint(dobj->parent_obj.ref, ==, 1);
454 g_assert_cmpstr(dobj->sv, ==, "Hiss hiss hiss");
455 g_assert(dobj->bv == true);
456 g_assert(dobj->av == DUMMY_PLATYPUS);
457
458 object_unref(OBJECT(dobj));
459 }
460
461 static bool test_create_obj(QDict *qdict, Error **errp)
462 {
463 Visitor *v = qobject_input_visitor_new_keyval(QOBJECT(qdict));
464 Object *obj = object_new_with_props_from_qdict(
465 TYPE_DUMMY, object_get_objects_root(), "dev0", qdict, v, errp);
466 visit_free(v);
467 return !!obj;
468 }
469
470 static void test_dummy_createcmdl(void)
471 {
472 QDict *qdict;
473 DummyObject *dobj;
474 Error *err = NULL;
475 bool created, help;
476 const char *params = "bv=yes,sv=Hiss hiss hiss,av=platypus";
477
478 /* Needed for user_creatable_del. */
479 qemu_add_opts(&qemu_object_opts);
480
481 qdict = keyval_parse(params, "qom-type", &help, &err);
482 g_assert(err == NULL);
483 g_assert(qdict);
484 g_assert(!help);
485
486 created = test_create_obj(qdict, &err);
487 g_assert(created);
488 g_assert(err == NULL);
489 qobject_unref(qdict);
490
491 dobj = DUMMY_OBJECT(object_resolve_path_component(object_get_objects_root(),
492 "dev0"));
493 g_assert(dobj);
494 g_assert_cmpstr(dobj->sv, ==, "Hiss hiss hiss");
495 g_assert(dobj->bv == true);
496 g_assert(dobj->av == DUMMY_PLATYPUS);
497
498 qdict = keyval_parse(params, "qom-type", &help, &err);
499 created = test_create_obj(qdict, &err);
500 g_assert(!created);
501 g_assert(err);
502 g_assert(object_resolve_path_component(object_get_objects_root(), "dev0")
503 == OBJECT(dobj));
504 qobject_unref(qdict);
505 error_free(err);
506 err = NULL;
507
508 qdict = keyval_parse(params, "qom-type", &help, &err);
509 user_creatable_del("dev0", &error_abort);
510 g_assert(object_resolve_path_component(object_get_objects_root(), "dev0")
511 == NULL);
512
513 created = test_create_obj(qdict, &err);
514 g_assert(created);
515 g_assert(err == NULL);
516 qobject_unref(qdict);
517
518 dobj = DUMMY_OBJECT(object_resolve_path_component(object_get_objects_root(),
519 "dev0"));
520 g_assert(dobj);
521 g_assert_cmpstr(dobj->sv, ==, "Hiss hiss hiss");
522 g_assert(dobj->bv == true);
523 g_assert(dobj->av == DUMMY_PLATYPUS);
524 g_assert(object_resolve_path_component(object_get_objects_root(), "dev0")
525 == OBJECT(dobj));
526
527 object_unparent(OBJECT(dobj));
528 }
529
530 static void test_dummy_badenum(void)
531 {
532 Error *err = NULL;
533 Object *parent = object_get_objects_root();
534 Object *dobj =
535 object_new_with_props(TYPE_DUMMY,
536 parent,
537 "dummy0",
538 &err,
539 "bv", "yes",
540 "sv", "Hiss hiss hiss",
541 "av", "yeti",
542 NULL);
543
544 g_assert(dobj == NULL);
545 g_assert(err != NULL);
546 g_assert_cmpstr(error_get_pretty(err), ==,
547 "Parameter 'av' does not accept value 'yeti'");
548
549 g_assert(object_resolve_path_component(parent, "dummy0")
550 == NULL);
551
552 error_free(err);
553 }
554
555
556 static void test_dummy_getenum(void)
557 {
558 Error *err = NULL;
559 int val;
560 Object *parent = object_get_objects_root();
561 DummyObject *dobj = DUMMY_OBJECT(
562 object_new_with_props(TYPE_DUMMY,
563 parent,
564 "dummy0",
565 &err,
566 "av", "platypus",
567 NULL));
568
569 g_assert(err == NULL);
570 g_assert(dobj->av == DUMMY_PLATYPUS);
571
572 val = object_property_get_enum(OBJECT(dobj),
573 "av",
574 "DummyAnimal",
575 &error_abort);
576 g_assert(val == DUMMY_PLATYPUS);
577
578 /* A bad enum type name */
579 val = object_property_get_enum(OBJECT(dobj),
580 "av",
581 "BadAnimal",
582 &err);
583 g_assert(val == -1);
584 error_free_or_abort(&err);
585
586 /* A non-enum property name */
587 val = object_property_get_enum(OBJECT(dobj),
588 "iv",
589 "DummyAnimal",
590 &err);
591 g_assert(val == -1);
592 error_free_or_abort(&err);
593
594 object_unparent(OBJECT(dobj));
595 }
596
597
598 static void test_dummy_prop_iterator(ObjectPropertyIterator *iter,
599 const char *expected[], int n)
600 {
601 ObjectProperty *prop;
602 int i;
603
604 while ((prop = object_property_iter_next(iter))) {
605 for (i = 0; i < n; i++) {
606 if (!g_strcmp0(prop->name, expected[i])) {
607 break;
608 }
609 }
610 g_assert(i < n);
611 expected[i] = NULL;
612 }
613
614 for (i = 0; i < n; i++) {
615 g_assert(!expected[i]);
616 }
617 }
618
619 static void test_dummy_iterator(void)
620 {
621 const char *expected[] = {
622 "type", /* inherited from TYPE_OBJECT */
623 "sv", "av", /* class properties */
624 "bv"}; /* instance property */
625 Object *parent = object_get_objects_root();
626 DummyObject *dobj = DUMMY_OBJECT(
627 object_new_with_props(TYPE_DUMMY,
628 parent,
629 "dummy0",
630 &error_abort,
631 "bv", "yes",
632 "sv", "Hiss hiss hiss",
633 "av", "platypus",
634 NULL));
635 ObjectPropertyIterator iter;
636
637 object_property_iter_init(&iter, OBJECT(dobj));
638 test_dummy_prop_iterator(&iter, expected, ARRAY_SIZE(expected));
639 object_unparent(OBJECT(dobj));
640 }
641
642 static void test_dummy_class_iterator(void)
643 {
644 const char *expected[] = { "type", "av", "sv" };
645 ObjectPropertyIterator iter;
646 ObjectClass *klass = object_class_by_name(TYPE_DUMMY);
647
648 object_class_property_iter_init(&iter, klass);
649 test_dummy_prop_iterator(&iter, expected, ARRAY_SIZE(expected));
650 }
651
652 static void test_dummy_delchild(void)
653 {
654 Object *parent = object_get_objects_root();
655 DummyDev *dev = DUMMY_DEV(
656 object_new_with_props(TYPE_DUMMY_DEV,
657 parent,
658 "dev0",
659 &error_abort,
660 NULL));
661
662 object_unparent(OBJECT(dev));
663 }
664
665 static void test_qom_partial_path(void)
666 {
667 Object *root = object_get_objects_root();
668 Object *cont1 = object_property_add_new_container(root, "cont1");
669 Object *obj1 = object_new(TYPE_DUMMY);
670 Object *obj2a = object_new(TYPE_DUMMY);
671 Object *obj2b = object_new(TYPE_DUMMY);
672 bool ambiguous;
673
674 /* Objects created:
675 * /cont1
676 * /cont1/obj1
677 * /cont1/obj2 (obj2a)
678 * /obj2 (obj2b)
679 */
680 object_property_add_child(cont1, "obj1", obj1);
681 object_unref(obj1);
682 object_property_add_child(cont1, "obj2", obj2a);
683 object_unref(obj2a);
684 object_property_add_child(root, "obj2", obj2b);
685 object_unref(obj2b);
686
687 ambiguous = false;
688 g_assert(!object_resolve_path_type("", TYPE_DUMMY, &ambiguous));
689 g_assert(ambiguous);
690 g_assert(!object_resolve_path_type("", TYPE_DUMMY, NULL));
691
692 ambiguous = false;
693 g_assert(!object_resolve_path("obj2", &ambiguous));
694 g_assert(ambiguous);
695 g_assert(!object_resolve_path("obj2", NULL));
696
697 ambiguous = false;
698 g_assert(object_resolve_path("obj1", &ambiguous) == obj1);
699 g_assert(!ambiguous);
700 g_assert(object_resolve_path("obj1", NULL) == obj1);
701
702 object_unparent(obj2b);
703 object_unparent(cont1);
704 }
705
706 int main(int argc, char **argv)
707 {
708 g_test_init(&argc, &argv, NULL);
709
710 module_call_init(MODULE_INIT_QOM);
711 type_register_static(&dummy_info);
712 type_register_static(&dummy_dev_info);
713 type_register_static(&dummy_bus_info);
714 type_register_static(&dummy_backend_info);
715
716 g_test_add_func("/qom/proplist/createlist/tree",
717 test_dummy_createlist_tree);
718 g_test_add_func("/qom/proplist/createlist/parentless",
719 test_dummy_createlist_parentless);
720 g_test_add_func("/qom/proplist/createv/tree",
721 test_dummy_createv_tree);
722 g_test_add_func("/qom/proplist/createv/parentless",
723 test_dummy_createv_parentless);
724 g_test_add_func("/qom/proplist/createcmdline", test_dummy_createcmdl);
725 g_test_add_func("/qom/proplist/badenum", test_dummy_badenum);
726 g_test_add_func("/qom/proplist/getenum", test_dummy_getenum);
727 g_test_add_func("/qom/proplist/iterator", test_dummy_iterator);
728 g_test_add_func("/qom/proplist/class_iterator", test_dummy_class_iterator);
729 g_test_add_func("/qom/proplist/delchild", test_dummy_delchild);
730 g_test_add_func("/qom/resolve/partial", test_qom_partial_path);
731
732 return g_test_run();
733 }