scsi: Rename scsi_*_length() to scsi_*_xfer(), add scsi_cdb_length()
[qemu.git] / qdev-monitor.c
blobfac7d179feda42bf3006b5605bfad29f133bbfd7
1 /*
2 * Dynamic device configuration and creation.
4 * Copyright (c) 2009 CodeSourcery
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.
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.
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/>.
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"
29 * Aliases were a bad idea from the start. Let's keep them
30 * from spreading further.
32 typedef struct QDevAlias
34 const char *typename;
35 const char *alias;
36 uint32_t arch_mask;
37 } QDevAlias;
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 { }
54 static const char *qdev_class_get_alias(DeviceClass *dc)
56 const char *typename = object_class_get_name(OBJECT_CLASS(dc));
57 int i;
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;
65 if (strcmp(qdev_alias_table[i].typename, typename) == 0) {
66 return qdev_alias_table[i].alias;
70 return NULL;
73 static bool qdev_class_has_alias(DeviceClass *dc)
75 return (qdev_class_get_alias(dc) != NULL);
78 static void qdev_print_devinfo(DeviceClass *dc)
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);
84 if (qdev_class_has_alias(dc)) {
85 error_printf(", alias \"%s\"", qdev_class_get_alias(dc));
87 if (dc->desc) {
88 error_printf(", desc \"%s\"", dc->desc);
90 if (dc->cannot_instantiate_with_device_add_yet) {
91 error_printf(", no-user");
93 error_printf("\n");
96 static gint devinfo_cmp(gconstpointer a, gconstpointer b)
98 return strcasecmp(object_class_get_name((ObjectClass *)a),
99 object_class_get_name((ObjectClass *)b));
102 static void qdev_print_devinfos(bool show_no_user)
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",
115 GSList *list, *elt;
116 int i;
117 bool cat_printed;
119 list = g_slist_sort(object_class_get_list(TYPE_DEVICE, false),
120 devinfo_cmp);
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;
134 if (!cat_printed) {
135 error_printf("%s%s devices:\n", i ? "\n" : "",
136 cat_name[i]);
137 cat_printed = true;
139 qdev_print_devinfo(dc);
143 g_slist_free(list);
146 static int set_property(const char *name, const char *value, void *opaque)
148 Object *obj = opaque;
149 Error *err = NULL;
151 if (strcmp(name, "driver") == 0)
152 return 0;
153 if (strcmp(name, "bus") == 0)
154 return 0;
156 object_property_parse(obj, value, name, &err);
157 if (err != NULL) {
158 qerror_report_err(err);
159 error_free(err);
160 return -1;
162 return 0;
165 static const char *find_typename_by_alias(const char *alias)
167 int i;
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;
175 if (strcmp(qdev_alias_table[i].alias, alias) == 0) {
176 return qdev_alias_table[i].typename;
180 return NULL;
183 int qdev_device_help(QemuOpts *opts)
185 Error *local_err = NULL;
186 const char *driver;
187 DevicePropertyInfoList *prop_list;
188 DevicePropertyInfoList *prop;
190 driver = qemu_opt_get(opts, "driver");
191 if (driver && is_help_option(driver)) {
192 qdev_print_devinfos(false);
193 return 1;
196 if (!driver || !qemu_opt_has_help_opt(opts)) {
197 return 0;
200 if (!object_class_by_name(driver)) {
201 const char *typename = find_typename_by_alias(driver);
203 if (typename) {
204 driver = typename;
208 prop_list = qmp_device_list_properties(driver, &local_err);
209 if (local_err) {
210 error_printf("%s\n", error_get_pretty(local_err));
211 error_free(local_err);
212 return 1;
215 for (prop = prop_list; prop; prop = prop->next) {
216 error_printf("%s.%s=%s", driver,
217 prop->value->name,
218 prop->value->type);
219 if (prop->value->has_description) {
220 error_printf(" (%s)\n", prop->value->description);
221 } else {
222 error_printf("\n");
226 qapi_free_DevicePropertyInfoList(prop_list);
227 return 1;
230 static Object *qdev_get_peripheral(void)
232 static Object *dev;
234 if (dev == NULL) {
235 dev = container_get(qdev_get_machine(), "/peripheral");
238 return dev;
241 static Object *qdev_get_peripheral_anon(void)
243 static Object *dev;
245 if (dev == NULL) {
246 dev = container_get(qdev_get_machine(), "/peripheral-anon");
249 return dev;
252 static void qbus_list_bus(DeviceState *dev)
254 BusState *child;
255 const char *sep = " ";
257 error_printf("child busses at \"%s\":",
258 dev->id ? dev->id : object_get_typename(OBJECT(dev)));
259 QLIST_FOREACH(child, &dev->child_bus, sibling) {
260 error_printf("%s\"%s\"", sep, child->name);
261 sep = ", ";
263 error_printf("\n");
266 static void qbus_list_dev(BusState *bus)
268 BusChild *kid;
269 const char *sep = " ";
271 error_printf("devices at \"%s\":", bus->name);
272 QTAILQ_FOREACH(kid, &bus->children, sibling) {
273 DeviceState *dev = kid->child;
274 error_printf("%s\"%s\"", sep, object_get_typename(OBJECT(dev)));
275 if (dev->id)
276 error_printf("/\"%s\"", dev->id);
277 sep = ", ";
279 error_printf("\n");
282 static BusState *qbus_find_bus(DeviceState *dev, char *elem)
284 BusState *child;
286 QLIST_FOREACH(child, &dev->child_bus, sibling) {
287 if (strcmp(child->name, elem) == 0) {
288 return child;
291 return NULL;
294 static DeviceState *qbus_find_dev(BusState *bus, char *elem)
296 BusChild *kid;
299 * try to match in order:
300 * (1) instance id, if present
301 * (2) driver name
302 * (3) driver alias, if present
304 QTAILQ_FOREACH(kid, &bus->children, sibling) {
305 DeviceState *dev = kid->child;
306 if (dev->id && strcmp(dev->id, elem) == 0) {
307 return dev;
310 QTAILQ_FOREACH(kid, &bus->children, sibling) {
311 DeviceState *dev = kid->child;
312 if (strcmp(object_get_typename(OBJECT(dev)), elem) == 0) {
313 return dev;
316 QTAILQ_FOREACH(kid, &bus->children, sibling) {
317 DeviceState *dev = kid->child;
318 DeviceClass *dc = DEVICE_GET_CLASS(dev);
320 if (qdev_class_has_alias(dc) &&
321 strcmp(qdev_class_get_alias(dc), elem) == 0) {
322 return dev;
325 return NULL;
328 static BusState *qbus_find_recursive(BusState *bus, const char *name,
329 const char *bus_typename)
331 BusClass *bus_class = BUS_GET_CLASS(bus);
332 BusChild *kid;
333 BusState *child, *ret;
334 int match = 1;
336 if (name && (strcmp(bus->name, name) != 0)) {
337 match = 0;
338 } else if (bus_typename && !object_dynamic_cast(OBJECT(bus), bus_typename)) {
339 match = 0;
340 } else if ((bus_class->max_dev != 0) && (bus_class->max_dev <= bus->max_index)) {
341 if (name != NULL) {
342 /* bus was explicitly specified: return an error. */
343 qerror_report(ERROR_CLASS_GENERIC_ERROR, "Bus '%s' is full",
344 bus->name);
345 return NULL;
346 } else {
347 /* bus was not specified: try to find another one. */
348 match = 0;
351 if (match) {
352 return bus;
355 QTAILQ_FOREACH(kid, &bus->children, sibling) {
356 DeviceState *dev = kid->child;
357 QLIST_FOREACH(child, &dev->child_bus, sibling) {
358 ret = qbus_find_recursive(child, name, bus_typename);
359 if (ret) {
360 return ret;
364 return NULL;
367 static BusState *qbus_find(const char *path)
369 DeviceState *dev;
370 BusState *bus;
371 char elem[128];
372 int pos, len;
374 /* find start element */
375 if (path[0] == '/') {
376 bus = sysbus_get_default();
377 pos = 0;
378 } else {
379 if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
380 assert(!path[0]);
381 elem[0] = len = 0;
383 bus = qbus_find_recursive(sysbus_get_default(), elem, NULL);
384 if (!bus) {
385 qerror_report(QERR_BUS_NOT_FOUND, elem);
386 return NULL;
388 pos = len;
391 for (;;) {
392 assert(path[pos] == '/' || !path[pos]);
393 while (path[pos] == '/') {
394 pos++;
396 if (path[pos] == '\0') {
397 return bus;
400 /* find device */
401 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
402 g_assert_not_reached();
403 elem[0] = len = 0;
405 pos += len;
406 dev = qbus_find_dev(bus, elem);
407 if (!dev) {
408 qerror_report(QERR_DEVICE_NOT_FOUND, elem);
409 if (!monitor_cur_is_qmp()) {
410 qbus_list_dev(bus);
412 return NULL;
415 assert(path[pos] == '/' || !path[pos]);
416 while (path[pos] == '/') {
417 pos++;
419 if (path[pos] == '\0') {
420 /* last specified element is a device. If it has exactly
421 * one child bus accept it nevertheless */
422 switch (dev->num_child_bus) {
423 case 0:
424 qerror_report(ERROR_CLASS_GENERIC_ERROR,
425 "Device '%s' has no child bus", elem);
426 return NULL;
427 case 1:
428 return QLIST_FIRST(&dev->child_bus);
429 default:
430 qerror_report(ERROR_CLASS_GENERIC_ERROR,
431 "Device '%s' has multiple child busses", elem);
432 if (!monitor_cur_is_qmp()) {
433 qbus_list_bus(dev);
435 return NULL;
439 /* find bus */
440 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
441 g_assert_not_reached();
442 elem[0] = len = 0;
444 pos += len;
445 bus = qbus_find_bus(dev, elem);
446 if (!bus) {
447 qerror_report(QERR_BUS_NOT_FOUND, elem);
448 if (!monitor_cur_is_qmp()) {
449 qbus_list_bus(dev);
451 return NULL;
456 DeviceState *qdev_device_add(QemuOpts *opts)
458 ObjectClass *oc;
459 DeviceClass *dc;
460 const char *driver, *path, *id;
461 DeviceState *dev;
462 BusState *bus = NULL;
463 Error *err = NULL;
465 driver = qemu_opt_get(opts, "driver");
466 if (!driver) {
467 qerror_report(QERR_MISSING_PARAMETER, "driver");
468 return NULL;
471 /* find driver */
472 oc = object_class_by_name(driver);
473 if (!oc) {
474 const char *typename = find_typename_by_alias(driver);
476 if (typename) {
477 driver = typename;
478 oc = object_class_by_name(driver);
482 if (!object_class_dynamic_cast(oc, TYPE_DEVICE)) {
483 qerror_report(ERROR_CLASS_GENERIC_ERROR,
484 "'%s' is not a valid device model name", driver);
485 return NULL;
488 if (object_class_is_abstract(oc)) {
489 qerror_report(QERR_INVALID_PARAMETER_VALUE, "driver",
490 "non-abstract device type");
491 return NULL;
494 dc = DEVICE_CLASS(oc);
495 if (dc->cannot_instantiate_with_device_add_yet ||
496 (qdev_hotplug && !dc->hotpluggable)) {
497 qerror_report(QERR_INVALID_PARAMETER_VALUE, "driver",
498 "pluggable device type");
499 return NULL;
502 /* find bus */
503 path = qemu_opt_get(opts, "bus");
504 if (path != NULL) {
505 bus = qbus_find(path);
506 if (!bus) {
507 return NULL;
509 if (!object_dynamic_cast(OBJECT(bus), dc->bus_type)) {
510 qerror_report(ERROR_CLASS_GENERIC_ERROR,
511 "Device '%s' can't go on a %s bus",
512 driver, object_get_typename(OBJECT(bus)));
513 return NULL;
515 } else if (dc->bus_type != NULL) {
516 bus = qbus_find_recursive(sysbus_get_default(), NULL, dc->bus_type);
517 if (!bus) {
518 qerror_report(ERROR_CLASS_GENERIC_ERROR,
519 "No '%s' bus found for device '%s'",
520 dc->bus_type, driver);
521 return NULL;
524 if (qdev_hotplug && bus && !qbus_is_hotpluggable(bus)) {
525 qerror_report(QERR_BUS_NO_HOTPLUG, bus->name);
526 return NULL;
529 /* create device */
530 dev = DEVICE(object_new(driver));
532 if (bus) {
533 qdev_set_parent_bus(dev, bus);
536 id = qemu_opts_id(opts);
537 if (id) {
538 dev->id = id;
541 if (dev->id) {
542 object_property_add_child(qdev_get_peripheral(), dev->id,
543 OBJECT(dev), NULL);
544 } else {
545 static int anon_count;
546 gchar *name = g_strdup_printf("device[%d]", anon_count++);
547 object_property_add_child(qdev_get_peripheral_anon(), name,
548 OBJECT(dev), NULL);
549 g_free(name);
552 /* set properties */
553 if (qemu_opt_foreach(opts, set_property, dev, 1) != 0) {
554 object_unparent(OBJECT(dev));
555 object_unref(OBJECT(dev));
556 return NULL;
559 dev->opts = opts;
560 object_property_set_bool(OBJECT(dev), true, "realized", &err);
561 if (err != NULL) {
562 qerror_report_err(err);
563 error_free(err);
564 dev->opts = NULL;
565 object_unparent(OBJECT(dev));
566 object_unref(OBJECT(dev));
567 qerror_report(QERR_DEVICE_INIT_FAILED, driver);
568 return NULL;
570 return dev;
574 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
575 static void qbus_print(Monitor *mon, BusState *bus, int indent);
577 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
578 int indent)
580 if (!props)
581 return;
582 for (; props->name; props++) {
583 Error *err = NULL;
584 char *value;
585 char *legacy_name = g_strdup_printf("legacy-%s", props->name);
586 if (object_property_get_type(OBJECT(dev), legacy_name, NULL)) {
587 value = object_property_get_str(OBJECT(dev), legacy_name, &err);
588 } else {
589 value = object_property_print(OBJECT(dev), props->name, true, &err);
591 g_free(legacy_name);
593 if (err) {
594 error_free(err);
595 continue;
597 qdev_printf("%s = %s\n", props->name,
598 value && *value ? value : "<null>");
599 g_free(value);
603 static void bus_print_dev(BusState *bus, Monitor *mon, DeviceState *dev, int indent)
605 BusClass *bc = BUS_GET_CLASS(bus);
607 if (bc->print_dev) {
608 bc->print_dev(mon, dev, indent);
612 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
614 ObjectClass *class;
615 BusState *child;
616 NamedGPIOList *ngl;
618 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev)),
619 dev->id ? dev->id : "");
620 indent += 2;
621 QLIST_FOREACH(ngl, &dev->gpios, node) {
622 if (ngl->num_in) {
623 qdev_printf("gpio-in \"%s\" %d\n", ngl->name ? ngl->name : "",
624 ngl->num_in);
626 if (ngl->num_out) {
627 qdev_printf("gpio-out \"%s\" %d\n", ngl->name ? ngl->name : "",
628 ngl->num_out);
631 class = object_get_class(OBJECT(dev));
632 do {
633 qdev_print_props(mon, dev, DEVICE_CLASS(class)->props, indent);
634 class = object_class_get_parent(class);
635 } while (class != object_class_by_name(TYPE_DEVICE));
636 bus_print_dev(dev->parent_bus, mon, dev, indent);
637 QLIST_FOREACH(child, &dev->child_bus, sibling) {
638 qbus_print(mon, child, indent);
642 static void qbus_print(Monitor *mon, BusState *bus, int indent)
644 BusChild *kid;
646 qdev_printf("bus: %s\n", bus->name);
647 indent += 2;
648 qdev_printf("type %s\n", object_get_typename(OBJECT(bus)));
649 QTAILQ_FOREACH(kid, &bus->children, sibling) {
650 DeviceState *dev = kid->child;
651 qdev_print(mon, dev, indent);
654 #undef qdev_printf
656 void do_info_qtree(Monitor *mon, const QDict *qdict)
658 if (sysbus_get_default())
659 qbus_print(mon, sysbus_get_default(), 0);
662 void do_info_qdm(Monitor *mon, const QDict *qdict)
664 qdev_print_devinfos(true);
667 int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data)
669 Error *local_err = NULL;
670 QemuOpts *opts;
671 DeviceState *dev;
673 opts = qemu_opts_from_qdict(qemu_find_opts("device"), qdict, &local_err);
674 if (local_err) {
675 qerror_report_err(local_err);
676 error_free(local_err);
677 return -1;
679 if (!monitor_cur_is_qmp() && qdev_device_help(opts)) {
680 qemu_opts_del(opts);
681 return 0;
683 dev = qdev_device_add(opts);
684 if (!dev) {
685 qemu_opts_del(opts);
686 return -1;
688 object_unref(OBJECT(dev));
689 return 0;
692 void qmp_device_del(const char *id, Error **errp)
694 Object *obj;
695 char *root_path = object_get_canonical_path(qdev_get_peripheral());
696 char *path = g_strdup_printf("%s/%s", root_path, id);
698 g_free(root_path);
699 obj = object_resolve_path_type(path, TYPE_DEVICE, NULL);
700 g_free(path);
702 if (!obj) {
703 error_set(errp, QERR_DEVICE_NOT_FOUND, id);
704 return;
707 qdev_unplug(DEVICE(obj), errp);
710 void qdev_machine_init(void)
712 qdev_get_peripheral_anon();
713 qdev_get_peripheral();
716 QemuOptsList qemu_device_opts = {
717 .name = "device",
718 .implied_opt_name = "driver",
719 .head = QTAILQ_HEAD_INITIALIZER(qemu_device_opts.head),
720 .desc = {
722 * no elements => accept any
723 * sanity checking will happen later
724 * when setting device properties
726 { /* end of list */ }
730 QemuOptsList qemu_global_opts = {
731 .name = "global",
732 .head = QTAILQ_HEAD_INITIALIZER(qemu_global_opts.head),
733 .desc = {
735 .name = "driver",
736 .type = QEMU_OPT_STRING,
738 .name = "property",
739 .type = QEMU_OPT_STRING,
741 .name = "value",
742 .type = QEMU_OPT_STRING,
744 { /* end of list */ }
748 int qemu_global_option(const char *str)
750 char driver[64], property[64];
751 QemuOpts *opts;
752 int rc, offset;
754 rc = sscanf(str, "%63[^.].%63[^=]%n", driver, property, &offset);
755 if (rc < 2 || str[offset] != '=') {
756 error_report("can't parse: \"%s\"", str);
757 return -1;
760 opts = qemu_opts_create(&qemu_global_opts, NULL, 0, &error_abort);
761 qemu_opt_set(opts, "driver", driver);
762 qemu_opt_set(opts, "property", property);
763 qemu_opt_set(opts, "value", str+offset+1);
764 return 0;