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/>.
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
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" },
54 static const char *qdev_class_get_alias(DeviceClass
*dc
)
56 const char *typename
= object_class_get_name(OBJECT_CLASS(dc
));
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
)) {
65 if (strcmp(qdev_alias_table
[i
].typename
, typename
) == 0) {
66 return qdev_alias_table
[i
].alias
;
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
)));
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
));
88 error_printf(", desc \"%s\"", dc
->desc
);
90 if (dc
->cannot_instantiate_with_device_add_yet
) {
91 error_printf(", no-user");
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",
119 list
= g_slist_sort(object_class_get_list(TYPE_DEVICE
, false),
122 for (i
= 0; i
<= DEVICE_CATEGORY_MAX
; i
++) {
124 for (elt
= list
; elt
; elt
= elt
->next
) {
125 DeviceClass
*dc
= OBJECT_CLASS_CHECK(DeviceClass
, elt
->data
,
127 if ((i
< DEVICE_CATEGORY_MAX
128 ? !test_bit(i
, dc
->categories
)
129 : !bitmap_empty(dc
->categories
, DEVICE_CATEGORY_MAX
))
131 && dc
->cannot_instantiate_with_device_add_yet
)) {
135 error_printf("%s%s devices:\n", i
? "\n" : "",
139 qdev_print_devinfo(dc
);
146 static int set_property(const char *name
, const char *value
, void *opaque
)
148 Object
*obj
= opaque
;
151 if (strcmp(name
, "driver") == 0)
153 if (strcmp(name
, "bus") == 0)
156 object_property_parse(obj
, value
, name
, &err
);
158 qerror_report_err(err
);
165 static const char *find_typename_by_alias(const char *alias
)
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
)) {
175 if (strcmp(qdev_alias_table
[i
].alias
, alias
) == 0) {
176 return qdev_alias_table
[i
].typename
;
183 int qdev_device_help(QemuOpts
*opts
)
189 driver
= qemu_opt_get(opts
, "driver");
190 if (driver
&& is_help_option(driver
)) {
191 qdev_print_devinfos(false);
195 if (!driver
|| !qemu_opt_has_help_opt(opts
)) {
199 klass
= object_class_by_name(driver
);
201 const char *typename
= find_typename_by_alias(driver
);
205 klass
= object_class_by_name(driver
);
209 if (!object_class_dynamic_cast(klass
, TYPE_DEVICE
)) {
213 for (prop
= DEVICE_CLASS(klass
)->props
; prop
&& prop
->name
; prop
++) {
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
220 if (!prop
->info
->set
) {
221 continue; /* no way to set it, don't show */
223 error_printf("%s.%s=%s\n", driver
, prop
->name
,
224 prop
->info
->legacy_name
?: prop
->info
->name
);
226 klass
= object_class_get_parent(klass
);
227 } while (klass
!= object_class_by_name(TYPE_DEVICE
));
231 static Object
*qdev_get_peripheral(void)
236 dev
= container_get(qdev_get_machine(), "/peripheral");
242 static Object
*qdev_get_peripheral_anon(void)
247 dev
= container_get(qdev_get_machine(), "/peripheral-anon");
253 static void qbus_list_bus(DeviceState
*dev
)
256 const char *sep
= " ";
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
);
267 static void qbus_list_dev(BusState
*bus
)
270 const char *sep
= " ";
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
)));
277 error_printf("/\"%s\"", dev
->id
);
283 static BusState
*qbus_find_bus(DeviceState
*dev
, char *elem
)
287 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
288 if (strcmp(child
->name
, elem
) == 0) {
295 static DeviceState
*qbus_find_dev(BusState
*bus
, char *elem
)
300 * try to match in order:
301 * (1) instance id, if present
303 * (3) driver alias, if present
305 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
306 DeviceState
*dev
= kid
->child
;
307 if (dev
->id
&& strcmp(dev
->id
, elem
) == 0) {
311 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
312 DeviceState
*dev
= kid
->child
;
313 if (strcmp(object_get_typename(OBJECT(dev
)), elem
) == 0) {
317 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
318 DeviceState
*dev
= kid
->child
;
319 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
321 if (qdev_class_has_alias(dc
) &&
322 strcmp(qdev_class_get_alias(dc
), elem
) == 0) {
329 static BusState
*qbus_find_recursive(BusState
*bus
, const char *name
,
330 const char *bus_typename
)
332 BusClass
*bus_class
= BUS_GET_CLASS(bus
);
334 BusState
*child
, *ret
;
337 if (name
&& (strcmp(bus
->name
, name
) != 0)) {
339 } else if (bus_typename
&& !object_dynamic_cast(OBJECT(bus
), bus_typename
)) {
341 } else if ((bus_class
->max_dev
!= 0) && (bus_class
->max_dev
<= bus
->max_index
)) {
343 /* bus was explicitly specified: return an error. */
344 qerror_report(ERROR_CLASS_GENERIC_ERROR
, "Bus '%s' is full",
348 /* bus was not specified: try to find another one. */
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
);
368 static BusState
*qbus_find(const char *path
)
375 /* find start element */
376 if (path
[0] == '/') {
377 bus
= sysbus_get_default();
380 if (sscanf(path
, "%127[^/]%n", elem
, &len
) != 1) {
384 bus
= qbus_find_recursive(sysbus_get_default(), elem
, NULL
);
386 qerror_report(QERR_BUS_NOT_FOUND
, elem
);
393 assert(path
[pos
] == '/' || !path
[pos
]);
394 while (path
[pos
] == '/') {
397 if (path
[pos
] == '\0') {
402 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
403 g_assert_not_reached();
407 dev
= qbus_find_dev(bus
, elem
);
409 qerror_report(QERR_DEVICE_NOT_FOUND
, elem
);
410 if (!monitor_cur_is_qmp()) {
416 assert(path
[pos
] == '/' || !path
[pos
]);
417 while (path
[pos
] == '/') {
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
) {
425 qerror_report(ERROR_CLASS_GENERIC_ERROR
,
426 "Device '%s' has no child bus", elem
);
429 return QLIST_FIRST(&dev
->child_bus
);
431 qerror_report(ERROR_CLASS_GENERIC_ERROR
,
432 "Device '%s' has multiple child busses", elem
);
433 if (!monitor_cur_is_qmp()) {
441 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
442 g_assert_not_reached();
446 bus
= qbus_find_bus(dev
, elem
);
448 qerror_report(QERR_BUS_NOT_FOUND
, elem
);
449 if (!monitor_cur_is_qmp()) {
457 DeviceState
*qdev_device_add(QemuOpts
*opts
)
461 const char *driver
, *path
, *id
;
463 BusState
*bus
= NULL
;
466 driver
= qemu_opt_get(opts
, "driver");
468 qerror_report(QERR_MISSING_PARAMETER
, "driver");
473 oc
= object_class_by_name(driver
);
475 const char *typename
= find_typename_by_alias(driver
);
479 oc
= object_class_by_name(driver
);
483 if (!object_class_dynamic_cast(oc
, TYPE_DEVICE
)) {
484 qerror_report(ERROR_CLASS_GENERIC_ERROR
,
485 "'%s' is not a valid device model name", driver
);
489 if (object_class_is_abstract(oc
)) {
490 qerror_report(QERR_INVALID_PARAMETER_VALUE
, "driver",
491 "non-abstract device type");
495 dc
= DEVICE_CLASS(oc
);
496 if (dc
->cannot_instantiate_with_device_add_yet
) {
497 qerror_report(QERR_INVALID_PARAMETER_VALUE
, "driver",
498 "pluggable device type");
503 path
= qemu_opt_get(opts
, "bus");
505 bus
= qbus_find(path
);
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
)));
515 } else if (dc
->bus_type
!= NULL
) {
516 bus
= qbus_find_recursive(sysbus_get_default(), NULL
, dc
->bus_type
);
518 qerror_report(ERROR_CLASS_GENERIC_ERROR
,
519 "No '%s' bus found for device '%s'",
520 dc
->bus_type
, driver
);
524 if (qdev_hotplug
&& bus
&& !bus
->allow_hotplug
) {
525 qerror_report(QERR_BUS_NO_HOTPLUG
, bus
->name
);
530 dev
= DEVICE(object_new(driver
));
533 qdev_set_parent_bus(dev
, bus
);
536 id
= qemu_opts_id(opts
);
542 object_property_add_child(qdev_get_peripheral(), dev
->id
,
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
,
553 if (qemu_opt_foreach(opts
, set_property
, dev
, 1) != 0) {
554 object_unparent(OBJECT(dev
));
555 object_unref(OBJECT(dev
));
560 object_property_set_bool(OBJECT(dev
), true, "realized", &err
);
562 qerror_report_err(err
);
565 object_unparent(OBJECT(dev
));
566 object_unref(OBJECT(dev
));
567 qerror_report(QERR_DEVICE_INIT_FAILED
, driver
);
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
,
582 for (; props
->name
; props
++) {
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
);
589 value
= object_property_print(OBJECT(dev
), props
->name
, true, &err
);
597 qdev_printf("%s = %s\n", props
->name
,
598 value
&& *value
? value
: "<null>");
603 static void bus_print_dev(BusState
*bus
, Monitor
*mon
, DeviceState
*dev
, int indent
)
605 BusClass
*bc
= BUS_GET_CLASS(bus
);
608 bc
->print_dev(mon
, dev
, indent
);
612 static void qdev_print(Monitor
*mon
, DeviceState
*dev
, int indent
)
618 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev
)),
619 dev
->id
? dev
->id
: "");
621 QLIST_FOREACH(ngl
, &dev
->gpios
, node
) {
623 qdev_printf("gpio-in \"%s\" %d\n", ngl
->name
? ngl
->name
: "",
627 qdev_printf("gpio-out \"%s\" %d\n", ngl
->name
? ngl
->name
: "",
631 class = object_get_class(OBJECT(dev
));
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
)
646 qdev_printf("bus: %s\n", bus
->name
);
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
);
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
;
673 opts
= qemu_opts_from_qdict(qemu_find_opts("device"), qdict
, &local_err
);
675 qerror_report_err(local_err
);
676 error_free(local_err
);
679 if (!monitor_cur_is_qmp() && qdev_device_help(opts
)) {
683 dev
= qdev_device_add(opts
);
688 object_unref(OBJECT(dev
));
692 void qmp_device_del(const char *id
, Error
**errp
)
696 dev
= qdev_find_recursive(sysbus_get_default(), id
);
698 error_set(errp
, QERR_DEVICE_NOT_FOUND
, id
);
702 qdev_unplug(dev
, errp
);
705 void qdev_machine_init(void)
707 qdev_get_peripheral_anon();
708 qdev_get_peripheral();
711 QemuOptsList qemu_device_opts
= {
713 .implied_opt_name
= "driver",
714 .head
= QTAILQ_HEAD_INITIALIZER(qemu_device_opts
.head
),
717 * no elements => accept any
718 * sanity checking will happen later
719 * when setting device properties
721 { /* end of list */ }
725 QemuOptsList qemu_global_opts
= {
727 .head
= QTAILQ_HEAD_INITIALIZER(qemu_global_opts
.head
),
731 .type
= QEMU_OPT_STRING
,
734 .type
= QEMU_OPT_STRING
,
737 .type
= QEMU_OPT_STRING
,
739 { /* end of list */ }
743 int qemu_global_option(const char *str
)
745 char driver
[64], property
[64];
749 rc
= sscanf(str
, "%63[^.].%63[^=]%n", driver
, property
, &offset
);
750 if (rc
< 2 || str
[offset
] != '=') {
751 error_report("can't parse: \"%s\"", str
);
755 opts
= qemu_opts_create(&qemu_global_opts
, NULL
, 0, &error_abort
);
756 qemu_opt_set(opts
, "driver", driver
);
757 qemu_opt_set(opts
, "property", property
);
758 qemu_opt_set(opts
, "value", str
+offset
+1);