qdev-monitor: Set properties after parent is assigned in device_add
[qemu.git] / qdev-monitor.c
1 /*
2 * Dynamic device configuration and creation.
3 *
4 * Copyright (c) 2009 CodeSourcery
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include "hw/qdev.h"
21 #include "hw/sysbus.h"
22 #include "monitor/monitor.h"
23 #include "monitor/qdev.h"
24 #include "qmp-commands.h"
25 #include "sysemu/arch_init.h"
26 #include "qemu/config-file.h"
27
28 /*
29 * Aliases were a bad idea from the start. Let's keep them
30 * from spreading further.
31 */
32 typedef struct QDevAlias
33 {
34 const char *typename;
35 const char *alias;
36 uint32_t arch_mask;
37 } QDevAlias;
38
39 static const QDevAlias qdev_alias_table[] = {
40 { "virtio-blk-pci", "virtio-blk", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
41 { "virtio-net-pci", "virtio-net", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
42 { "virtio-serial-pci", "virtio-serial", QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
43 { "virtio-balloon-pci", "virtio-balloon",
44 QEMU_ARCH_ALL & ~QEMU_ARCH_S390X },
45 { "virtio-blk-s390", "virtio-blk", QEMU_ARCH_S390X },
46 { "virtio-net-s390", "virtio-net", QEMU_ARCH_S390X },
47 { "virtio-serial-s390", "virtio-serial", QEMU_ARCH_S390X },
48 { "lsi53c895a", "lsi" },
49 { "ich9-ahci", "ahci" },
50 { "kvm-pci-assign", "pci-assign" },
51 { }
52 };
53
54 static const char *qdev_class_get_alias(DeviceClass *dc)
55 {
56 const char *typename = object_class_get_name(OBJECT_CLASS(dc));
57 int i;
58
59 for (i = 0; qdev_alias_table[i].typename; i++) {
60 if (qdev_alias_table[i].arch_mask &&
61 !(qdev_alias_table[i].arch_mask & arch_type)) {
62 continue;
63 }
64
65 if (strcmp(qdev_alias_table[i].typename, typename) == 0) {
66 return qdev_alias_table[i].alias;
67 }
68 }
69
70 return NULL;
71 }
72
73 static bool qdev_class_has_alias(DeviceClass *dc)
74 {
75 return (qdev_class_get_alias(dc) != NULL);
76 }
77
78 static void qdev_print_devinfo(DeviceClass *dc)
79 {
80 error_printf("name \"%s\"", object_class_get_name(OBJECT_CLASS(dc)));
81 if (dc->bus_type) {
82 error_printf(", bus %s", dc->bus_type);
83 }
84 if (qdev_class_has_alias(dc)) {
85 error_printf(", alias \"%s\"", qdev_class_get_alias(dc));
86 }
87 if (dc->desc) {
88 error_printf(", desc \"%s\"", dc->desc);
89 }
90 if (dc->cannot_instantiate_with_device_add_yet) {
91 error_printf(", no-user");
92 }
93 error_printf("\n");
94 }
95
96 static gint devinfo_cmp(gconstpointer a, gconstpointer b)
97 {
98 return strcasecmp(object_class_get_name((ObjectClass *)a),
99 object_class_get_name((ObjectClass *)b));
100 }
101
102 static void qdev_print_devinfos(bool show_no_user)
103 {
104 static const char *cat_name[DEVICE_CATEGORY_MAX + 1] = {
105 [DEVICE_CATEGORY_BRIDGE] = "Controller/Bridge/Hub",
106 [DEVICE_CATEGORY_USB] = "USB",
107 [DEVICE_CATEGORY_STORAGE] = "Storage",
108 [DEVICE_CATEGORY_NETWORK] = "Network",
109 [DEVICE_CATEGORY_INPUT] = "Input",
110 [DEVICE_CATEGORY_DISPLAY] = "Display",
111 [DEVICE_CATEGORY_SOUND] = "Sound",
112 [DEVICE_CATEGORY_MISC] = "Misc",
113 [DEVICE_CATEGORY_MAX] = "Uncategorized",
114 };
115 GSList *list, *elt;
116 int i;
117 bool cat_printed;
118
119 list = g_slist_sort(object_class_get_list(TYPE_DEVICE, false),
120 devinfo_cmp);
121
122 for (i = 0; i <= DEVICE_CATEGORY_MAX; i++) {
123 cat_printed = false;
124 for (elt = list; elt; elt = elt->next) {
125 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
126 TYPE_DEVICE);
127 if ((i < DEVICE_CATEGORY_MAX
128 ? !test_bit(i, dc->categories)
129 : !bitmap_empty(dc->categories, DEVICE_CATEGORY_MAX))
130 || (!show_no_user
131 && dc->cannot_instantiate_with_device_add_yet)) {
132 continue;
133 }
134 if (!cat_printed) {
135 error_printf("%s%s devices:\n", i ? "\n" : "",
136 cat_name[i]);
137 cat_printed = true;
138 }
139 qdev_print_devinfo(dc);
140 }
141 }
142
143 g_slist_free(list);
144 }
145
146 static int set_property(const char *name, const char *value, void *opaque)
147 {
148 Object *obj = opaque;
149 Error *err = NULL;
150
151 if (strcmp(name, "driver") == 0)
152 return 0;
153 if (strcmp(name, "bus") == 0)
154 return 0;
155
156 object_property_parse(obj, value, name, &err);
157 if (err != NULL) {
158 qerror_report_err(err);
159 error_free(err);
160 return -1;
161 }
162 return 0;
163 }
164
165 static const char *find_typename_by_alias(const char *alias)
166 {
167 int i;
168
169 for (i = 0; qdev_alias_table[i].alias; i++) {
170 if (qdev_alias_table[i].arch_mask &&
171 !(qdev_alias_table[i].arch_mask & arch_type)) {
172 continue;
173 }
174
175 if (strcmp(qdev_alias_table[i].alias, alias) == 0) {
176 return qdev_alias_table[i].typename;
177 }
178 }
179
180 return NULL;
181 }
182
183 int qdev_device_help(QemuOpts *opts)
184 {
185 const char *driver;
186 Property *prop;
187 ObjectClass *klass;
188
189 driver = qemu_opt_get(opts, "driver");
190 if (driver && is_help_option(driver)) {
191 qdev_print_devinfos(false);
192 return 1;
193 }
194
195 if (!driver || !qemu_opt_has_help_opt(opts)) {
196 return 0;
197 }
198
199 klass = object_class_by_name(driver);
200 if (!klass) {
201 const char *typename = find_typename_by_alias(driver);
202
203 if (typename) {
204 driver = typename;
205 klass = object_class_by_name(driver);
206 }
207 }
208
209 if (!klass) {
210 return 0;
211 }
212 do {
213 for (prop = DEVICE_CLASS(klass)->props; prop && prop->name; prop++) {
214 /*
215 * TODO Properties without a parser are just for dirty hacks.
216 * qdev_prop_ptr is the only such PropertyInfo. It's marked
217 * for removal. This conditional should be removed along with
218 * it.
219 */
220 if (!prop->info->set) {
221 continue; /* no way to set it, don't show */
222 }
223 error_printf("%s.%s=%s\n", driver, prop->name,
224 prop->info->legacy_name ?: prop->info->name);
225 }
226 klass = object_class_get_parent(klass);
227 } while (klass != object_class_by_name(TYPE_DEVICE));
228 return 1;
229 }
230
231 static Object *qdev_get_peripheral(void)
232 {
233 static Object *dev;
234
235 if (dev == NULL) {
236 dev = container_get(qdev_get_machine(), "/peripheral");
237 }
238
239 return dev;
240 }
241
242 static Object *qdev_get_peripheral_anon(void)
243 {
244 static Object *dev;
245
246 if (dev == NULL) {
247 dev = container_get(qdev_get_machine(), "/peripheral-anon");
248 }
249
250 return dev;
251 }
252
253 static void qbus_list_bus(DeviceState *dev)
254 {
255 BusState *child;
256 const char *sep = " ";
257
258 error_printf("child busses at \"%s\":",
259 dev->id ? dev->id : object_get_typename(OBJECT(dev)));
260 QLIST_FOREACH(child, &dev->child_bus, sibling) {
261 error_printf("%s\"%s\"", sep, child->name);
262 sep = ", ";
263 }
264 error_printf("\n");
265 }
266
267 static void qbus_list_dev(BusState *bus)
268 {
269 BusChild *kid;
270 const char *sep = " ";
271
272 error_printf("devices at \"%s\":", bus->name);
273 QTAILQ_FOREACH(kid, &bus->children, sibling) {
274 DeviceState *dev = kid->child;
275 error_printf("%s\"%s\"", sep, object_get_typename(OBJECT(dev)));
276 if (dev->id)
277 error_printf("/\"%s\"", dev->id);
278 sep = ", ";
279 }
280 error_printf("\n");
281 }
282
283 static BusState *qbus_find_bus(DeviceState *dev, char *elem)
284 {
285 BusState *child;
286
287 QLIST_FOREACH(child, &dev->child_bus, sibling) {
288 if (strcmp(child->name, elem) == 0) {
289 return child;
290 }
291 }
292 return NULL;
293 }
294
295 static DeviceState *qbus_find_dev(BusState *bus, char *elem)
296 {
297 BusChild *kid;
298
299 /*
300 * try to match in order:
301 * (1) instance id, if present
302 * (2) driver name
303 * (3) driver alias, if present
304 */
305 QTAILQ_FOREACH(kid, &bus->children, sibling) {
306 DeviceState *dev = kid->child;
307 if (dev->id && strcmp(dev->id, elem) == 0) {
308 return dev;
309 }
310 }
311 QTAILQ_FOREACH(kid, &bus->children, sibling) {
312 DeviceState *dev = kid->child;
313 if (strcmp(object_get_typename(OBJECT(dev)), elem) == 0) {
314 return dev;
315 }
316 }
317 QTAILQ_FOREACH(kid, &bus->children, sibling) {
318 DeviceState *dev = kid->child;
319 DeviceClass *dc = DEVICE_GET_CLASS(dev);
320
321 if (qdev_class_has_alias(dc) &&
322 strcmp(qdev_class_get_alias(dc), elem) == 0) {
323 return dev;
324 }
325 }
326 return NULL;
327 }
328
329 static BusState *qbus_find_recursive(BusState *bus, const char *name,
330 const char *bus_typename)
331 {
332 BusClass *bus_class = BUS_GET_CLASS(bus);
333 BusChild *kid;
334 BusState *child, *ret;
335 int match = 1;
336
337 if (name && (strcmp(bus->name, name) != 0)) {
338 match = 0;
339 } else if (bus_typename && !object_dynamic_cast(OBJECT(bus), bus_typename)) {
340 match = 0;
341 } else if ((bus_class->max_dev != 0) && (bus_class->max_dev <= bus->max_index)) {
342 if (name != NULL) {
343 /* bus was explicitly specified: return an error. */
344 qerror_report(ERROR_CLASS_GENERIC_ERROR, "Bus '%s' is full",
345 bus->name);
346 return NULL;
347 } else {
348 /* bus was not specified: try to find another one. */
349 match = 0;
350 }
351 }
352 if (match) {
353 return bus;
354 }
355
356 QTAILQ_FOREACH(kid, &bus->children, sibling) {
357 DeviceState *dev = kid->child;
358 QLIST_FOREACH(child, &dev->child_bus, sibling) {
359 ret = qbus_find_recursive(child, name, bus_typename);
360 if (ret) {
361 return ret;
362 }
363 }
364 }
365 return NULL;
366 }
367
368 static BusState *qbus_find(const char *path)
369 {
370 DeviceState *dev;
371 BusState *bus;
372 char elem[128];
373 int pos, len;
374
375 /* find start element */
376 if (path[0] == '/') {
377 bus = sysbus_get_default();
378 pos = 0;
379 } else {
380 if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
381 assert(!path[0]);
382 elem[0] = len = 0;
383 }
384 bus = qbus_find_recursive(sysbus_get_default(), elem, NULL);
385 if (!bus) {
386 qerror_report(QERR_BUS_NOT_FOUND, elem);
387 return NULL;
388 }
389 pos = len;
390 }
391
392 for (;;) {
393 assert(path[pos] == '/' || !path[pos]);
394 while (path[pos] == '/') {
395 pos++;
396 }
397 if (path[pos] == '\0') {
398 return bus;
399 }
400
401 /* find device */
402 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
403 g_assert_not_reached();
404 elem[0] = len = 0;
405 }
406 pos += len;
407 dev = qbus_find_dev(bus, elem);
408 if (!dev) {
409 qerror_report(QERR_DEVICE_NOT_FOUND, elem);
410 if (!monitor_cur_is_qmp()) {
411 qbus_list_dev(bus);
412 }
413 return NULL;
414 }
415
416 assert(path[pos] == '/' || !path[pos]);
417 while (path[pos] == '/') {
418 pos++;
419 }
420 if (path[pos] == '\0') {
421 /* last specified element is a device. If it has exactly
422 * one child bus accept it nevertheless */
423 switch (dev->num_child_bus) {
424 case 0:
425 qerror_report(QERR_DEVICE_NO_BUS, elem);
426 return NULL;
427 case 1:
428 return QLIST_FIRST(&dev->child_bus);
429 default:
430 qerror_report(QERR_DEVICE_MULTIPLE_BUSSES, elem);
431 if (!monitor_cur_is_qmp()) {
432 qbus_list_bus(dev);
433 }
434 return NULL;
435 }
436 }
437
438 /* find bus */
439 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
440 g_assert_not_reached();
441 elem[0] = len = 0;
442 }
443 pos += len;
444 bus = qbus_find_bus(dev, elem);
445 if (!bus) {
446 qerror_report(QERR_BUS_NOT_FOUND, elem);
447 if (!monitor_cur_is_qmp()) {
448 qbus_list_bus(dev);
449 }
450 return NULL;
451 }
452 }
453 }
454
455 DeviceState *qdev_device_add(QemuOpts *opts)
456 {
457 ObjectClass *oc;
458 DeviceClass *dc;
459 const char *driver, *path, *id;
460 DeviceState *dev;
461 BusState *bus = NULL;
462 Error *err = NULL;
463
464 driver = qemu_opt_get(opts, "driver");
465 if (!driver) {
466 qerror_report(QERR_MISSING_PARAMETER, "driver");
467 return NULL;
468 }
469
470 /* find driver */
471 oc = object_class_by_name(driver);
472 if (!oc) {
473 const char *typename = find_typename_by_alias(driver);
474
475 if (typename) {
476 driver = typename;
477 oc = object_class_by_name(driver);
478 }
479 }
480
481 if (!object_class_dynamic_cast(oc, TYPE_DEVICE)) {
482 qerror_report(ERROR_CLASS_GENERIC_ERROR,
483 "'%s' is not a valid device model name", driver);
484 return NULL;
485 }
486
487 if (object_class_is_abstract(oc)) {
488 qerror_report(QERR_INVALID_PARAMETER_VALUE, "driver",
489 "non-abstract device type");
490 return NULL;
491 }
492
493 dc = DEVICE_CLASS(oc);
494 if (dc->cannot_instantiate_with_device_add_yet) {
495 qerror_report(QERR_INVALID_PARAMETER_VALUE, "driver",
496 "pluggable device type");
497 return NULL;
498 }
499
500 /* find bus */
501 path = qemu_opt_get(opts, "bus");
502 if (path != NULL) {
503 bus = qbus_find(path);
504 if (!bus) {
505 return NULL;
506 }
507 if (!object_dynamic_cast(OBJECT(bus), dc->bus_type)) {
508 qerror_report(QERR_BAD_BUS_FOR_DEVICE,
509 driver, object_get_typename(OBJECT(bus)));
510 return NULL;
511 }
512 } else if (dc->bus_type != NULL) {
513 bus = qbus_find_recursive(sysbus_get_default(), NULL, dc->bus_type);
514 if (!bus) {
515 qerror_report(QERR_NO_BUS_FOR_DEVICE,
516 dc->bus_type, driver);
517 return NULL;
518 }
519 }
520 if (qdev_hotplug && bus && !bus->allow_hotplug) {
521 qerror_report(QERR_BUS_NO_HOTPLUG, bus->name);
522 return NULL;
523 }
524
525 /* create device */
526 dev = DEVICE(object_new(driver));
527
528 if (bus) {
529 qdev_set_parent_bus(dev, bus);
530 }
531
532 id = qemu_opts_id(opts);
533 if (id) {
534 dev->id = id;
535 }
536
537 if (dev->id) {
538 object_property_add_child(qdev_get_peripheral(), dev->id,
539 OBJECT(dev), NULL);
540 } else {
541 static int anon_count;
542 gchar *name = g_strdup_printf("device[%d]", anon_count++);
543 object_property_add_child(qdev_get_peripheral_anon(), name,
544 OBJECT(dev), NULL);
545 g_free(name);
546 }
547
548 /* set properties */
549 if (qemu_opt_foreach(opts, set_property, dev, 1) != 0) {
550 object_unparent(OBJECT(dev));
551 object_unref(OBJECT(dev));
552 return NULL;
553 }
554
555 dev->opts = opts;
556 object_property_set_bool(OBJECT(dev), true, "realized", &err);
557 if (err != NULL) {
558 qerror_report_err(err);
559 error_free(err);
560 dev->opts = NULL;
561 object_unparent(OBJECT(dev));
562 object_unref(OBJECT(dev));
563 qerror_report(QERR_DEVICE_INIT_FAILED, driver);
564 return NULL;
565 }
566 return dev;
567 }
568
569
570 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
571 static void qbus_print(Monitor *mon, BusState *bus, int indent);
572
573 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
574 int indent)
575 {
576 if (!props)
577 return;
578 for (; props->name; props++) {
579 Error *err = NULL;
580 char *value;
581 char *legacy_name = g_strdup_printf("legacy-%s", props->name);
582 if (object_property_get_type(OBJECT(dev), legacy_name, NULL)) {
583 value = object_property_get_str(OBJECT(dev), legacy_name, &err);
584 } else {
585 value = object_property_print(OBJECT(dev), props->name, true, &err);
586 }
587 g_free(legacy_name);
588
589 if (err) {
590 error_free(err);
591 continue;
592 }
593 qdev_printf("%s = %s\n", props->name,
594 value && *value ? value : "<null>");
595 g_free(value);
596 }
597 }
598
599 static void bus_print_dev(BusState *bus, Monitor *mon, DeviceState *dev, int indent)
600 {
601 BusClass *bc = BUS_GET_CLASS(bus);
602
603 if (bc->print_dev) {
604 bc->print_dev(mon, dev, indent);
605 }
606 }
607
608 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
609 {
610 ObjectClass *class;
611 BusState *child;
612 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev)),
613 dev->id ? dev->id : "");
614 indent += 2;
615 if (dev->num_gpio_in) {
616 qdev_printf("gpio-in %d\n", dev->num_gpio_in);
617 }
618 if (dev->num_gpio_out) {
619 qdev_printf("gpio-out %d\n", dev->num_gpio_out);
620 }
621 class = object_get_class(OBJECT(dev));
622 do {
623 qdev_print_props(mon, dev, DEVICE_CLASS(class)->props, indent);
624 class = object_class_get_parent(class);
625 } while (class != object_class_by_name(TYPE_DEVICE));
626 bus_print_dev(dev->parent_bus, mon, dev, indent);
627 QLIST_FOREACH(child, &dev->child_bus, sibling) {
628 qbus_print(mon, child, indent);
629 }
630 }
631
632 static void qbus_print(Monitor *mon, BusState *bus, int indent)
633 {
634 BusChild *kid;
635
636 qdev_printf("bus: %s\n", bus->name);
637 indent += 2;
638 qdev_printf("type %s\n", object_get_typename(OBJECT(bus)));
639 QTAILQ_FOREACH(kid, &bus->children, sibling) {
640 DeviceState *dev = kid->child;
641 qdev_print(mon, dev, indent);
642 }
643 }
644 #undef qdev_printf
645
646 void do_info_qtree(Monitor *mon, const QDict *qdict)
647 {
648 if (sysbus_get_default())
649 qbus_print(mon, sysbus_get_default(), 0);
650 }
651
652 void do_info_qdm(Monitor *mon, const QDict *qdict)
653 {
654 qdev_print_devinfos(true);
655 }
656
657 int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data)
658 {
659 Error *local_err = NULL;
660 QemuOpts *opts;
661 DeviceState *dev;
662
663 opts = qemu_opts_from_qdict(qemu_find_opts("device"), qdict, &local_err);
664 if (local_err) {
665 qerror_report_err(local_err);
666 error_free(local_err);
667 return -1;
668 }
669 if (!monitor_cur_is_qmp() && qdev_device_help(opts)) {
670 qemu_opts_del(opts);
671 return 0;
672 }
673 dev = qdev_device_add(opts);
674 if (!dev) {
675 qemu_opts_del(opts);
676 return -1;
677 }
678 object_unref(OBJECT(dev));
679 return 0;
680 }
681
682 void qmp_device_del(const char *id, Error **errp)
683 {
684 DeviceState *dev;
685
686 dev = qdev_find_recursive(sysbus_get_default(), id);
687 if (NULL == dev) {
688 error_set(errp, QERR_DEVICE_NOT_FOUND, id);
689 return;
690 }
691
692 qdev_unplug(dev, errp);
693 }
694
695 void qdev_machine_init(void)
696 {
697 qdev_get_peripheral_anon();
698 qdev_get_peripheral();
699 }
700
701 QemuOptsList qemu_device_opts = {
702 .name = "device",
703 .implied_opt_name = "driver",
704 .head = QTAILQ_HEAD_INITIALIZER(qemu_device_opts.head),
705 .desc = {
706 /*
707 * no elements => accept any
708 * sanity checking will happen later
709 * when setting device properties
710 */
711 { /* end of list */ }
712 },
713 };
714
715 QemuOptsList qemu_global_opts = {
716 .name = "global",
717 .head = QTAILQ_HEAD_INITIALIZER(qemu_global_opts.head),
718 .desc = {
719 {
720 .name = "driver",
721 .type = QEMU_OPT_STRING,
722 },{
723 .name = "property",
724 .type = QEMU_OPT_STRING,
725 },{
726 .name = "value",
727 .type = QEMU_OPT_STRING,
728 },
729 { /* end of list */ }
730 },
731 };
732
733 int qemu_global_option(const char *str)
734 {
735 char driver[64], property[64];
736 QemuOpts *opts;
737 int rc, offset;
738
739 rc = sscanf(str, "%63[^.].%63[^=]%n", driver, property, &offset);
740 if (rc < 2 || str[offset] != '=') {
741 error_report("can't parse: \"%s\"", str);
742 return -1;
743 }
744
745 opts = qemu_opts_create(&qemu_global_opts, NULL, 0, &error_abort);
746 qemu_opt_set(opts, "driver", driver);
747 qemu_opt_set(opts, "property", property);
748 qemu_opt_set(opts, "value", str+offset+1);
749 return 0;
750 }