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 "qemu/osdep.h"
22 #include "hw/sysbus.h"
23 #include "monitor/monitor.h"
24 #include "monitor/qdev.h"
25 #include "qmp-commands.h"
26 #include "sysemu/arch_init.h"
27 #include "qapi/qmp/qerror.h"
28 #include "qemu/config-file.h"
29 #include "qemu/error-report.h"
32 * Aliases were a bad idea from the start. Let's keep them
33 * from spreading further.
35 typedef struct QDevAlias
42 static const QDevAlias qdev_alias_table
[] = {
43 { "virtio-blk-pci", "virtio-blk", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
44 { "virtio-net-pci", "virtio-net", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
45 { "virtio-serial-pci", "virtio-serial", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
46 { "virtio-balloon-pci", "virtio-balloon",
47 QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
48 { "virtio-blk-ccw", "virtio-blk", QEMU_ARCH_S390X
},
49 { "virtio-net-ccw", "virtio-net", QEMU_ARCH_S390X
},
50 { "virtio-serial-ccw", "virtio-serial", QEMU_ARCH_S390X
},
51 { "lsi53c895a", "lsi" },
52 { "ich9-ahci", "ahci" },
53 { "kvm-pci-assign", "pci-assign" },
54 { "e1000", "e1000-82540em" },
58 static const char *qdev_class_get_alias(DeviceClass
*dc
)
60 const char *typename
= object_class_get_name(OBJECT_CLASS(dc
));
63 for (i
= 0; qdev_alias_table
[i
].typename
; i
++) {
64 if (qdev_alias_table
[i
].arch_mask
&&
65 !(qdev_alias_table
[i
].arch_mask
& arch_type
)) {
69 if (strcmp(qdev_alias_table
[i
].typename
, typename
) == 0) {
70 return qdev_alias_table
[i
].alias
;
77 static bool qdev_class_has_alias(DeviceClass
*dc
)
79 return (qdev_class_get_alias(dc
) != NULL
);
82 static void qdev_print_devinfo(DeviceClass
*dc
)
84 error_printf("name \"%s\"", object_class_get_name(OBJECT_CLASS(dc
)));
86 error_printf(", bus %s", dc
->bus_type
);
88 if (qdev_class_has_alias(dc
)) {
89 error_printf(", alias \"%s\"", qdev_class_get_alias(dc
));
92 error_printf(", desc \"%s\"", dc
->desc
);
94 if (dc
->cannot_instantiate_with_device_add_yet
) {
95 error_printf(", no-user");
100 static gint
devinfo_cmp(gconstpointer a
, gconstpointer b
)
102 return strcasecmp(object_class_get_name((ObjectClass
*)a
),
103 object_class_get_name((ObjectClass
*)b
));
106 static void qdev_print_devinfos(bool show_no_user
)
108 static const char *cat_name
[DEVICE_CATEGORY_MAX
+ 1] = {
109 [DEVICE_CATEGORY_BRIDGE
] = "Controller/Bridge/Hub",
110 [DEVICE_CATEGORY_USB
] = "USB",
111 [DEVICE_CATEGORY_STORAGE
] = "Storage",
112 [DEVICE_CATEGORY_NETWORK
] = "Network",
113 [DEVICE_CATEGORY_INPUT
] = "Input",
114 [DEVICE_CATEGORY_DISPLAY
] = "Display",
115 [DEVICE_CATEGORY_SOUND
] = "Sound",
116 [DEVICE_CATEGORY_MISC
] = "Misc",
117 [DEVICE_CATEGORY_MAX
] = "Uncategorized",
123 list
= g_slist_sort(object_class_get_list(TYPE_DEVICE
, false),
126 for (i
= 0; i
<= DEVICE_CATEGORY_MAX
; i
++) {
128 for (elt
= list
; elt
; elt
= elt
->next
) {
129 DeviceClass
*dc
= OBJECT_CLASS_CHECK(DeviceClass
, elt
->data
,
131 if ((i
< DEVICE_CATEGORY_MAX
132 ? !test_bit(i
, dc
->categories
)
133 : !bitmap_empty(dc
->categories
, DEVICE_CATEGORY_MAX
))
135 && dc
->cannot_instantiate_with_device_add_yet
)) {
139 error_printf("%s%s devices:\n", i
? "\n" : "",
143 qdev_print_devinfo(dc
);
150 static int set_property(void *opaque
, const char *name
, const char *value
,
153 Object
*obj
= opaque
;
156 if (strcmp(name
, "driver") == 0)
158 if (strcmp(name
, "bus") == 0)
161 object_property_parse(obj
, value
, name
, &err
);
163 error_propagate(errp
, err
);
169 static const char *find_typename_by_alias(const char *alias
)
173 for (i
= 0; qdev_alias_table
[i
].alias
; i
++) {
174 if (qdev_alias_table
[i
].arch_mask
&&
175 !(qdev_alias_table
[i
].arch_mask
& arch_type
)) {
179 if (strcmp(qdev_alias_table
[i
].alias
, alias
) == 0) {
180 return qdev_alias_table
[i
].typename
;
187 static DeviceClass
*qdev_get_device_class(const char **driver
, Error
**errp
)
192 oc
= object_class_by_name(*driver
);
194 const char *typename
= find_typename_by_alias(*driver
);
198 oc
= object_class_by_name(*driver
);
202 if (!object_class_dynamic_cast(oc
, TYPE_DEVICE
)) {
203 error_setg(errp
, "'%s' is not a valid device model name", *driver
);
207 if (object_class_is_abstract(oc
)) {
208 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
209 "non-abstract device type");
213 dc
= DEVICE_CLASS(oc
);
214 if (dc
->cannot_instantiate_with_device_add_yet
||
215 (qdev_hotplug
&& !dc
->hotpluggable
)) {
216 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
217 "pluggable device type");
225 int qdev_device_help(QemuOpts
*opts
)
227 Error
*local_err
= NULL
;
229 DevicePropertyInfoList
*prop_list
;
230 DevicePropertyInfoList
*prop
;
232 driver
= qemu_opt_get(opts
, "driver");
233 if (driver
&& is_help_option(driver
)) {
234 qdev_print_devinfos(false);
238 if (!driver
|| !qemu_opt_has_help_opt(opts
)) {
242 if (!object_class_by_name(driver
)) {
243 const char *typename
= find_typename_by_alias(driver
);
250 prop_list
= qmp_device_list_properties(driver
, &local_err
);
255 for (prop
= prop_list
; prop
; prop
= prop
->next
) {
256 error_printf("%s.%s=%s", driver
,
259 if (prop
->value
->has_description
) {
260 error_printf(" (%s)\n", prop
->value
->description
);
266 qapi_free_DevicePropertyInfoList(prop_list
);
270 error_report_err(local_err
);
274 static Object
*qdev_get_peripheral(void)
279 dev
= container_get(qdev_get_machine(), "/peripheral");
285 static Object
*qdev_get_peripheral_anon(void)
290 dev
= container_get(qdev_get_machine(), "/peripheral-anon");
296 static void qbus_list_bus(DeviceState
*dev
, Error
**errp
)
299 const char *sep
= " ";
301 error_append_hint(errp
, "child buses at \"%s\":",
302 dev
->id
? dev
->id
: object_get_typename(OBJECT(dev
)));
303 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
304 error_append_hint(errp
, "%s\"%s\"", sep
, child
->name
);
307 error_append_hint(errp
, "\n");
310 static void qbus_list_dev(BusState
*bus
, Error
**errp
)
313 const char *sep
= " ";
315 error_append_hint(errp
, "devices at \"%s\":", bus
->name
);
316 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
317 DeviceState
*dev
= kid
->child
;
318 error_append_hint(errp
, "%s\"%s\"", sep
,
319 object_get_typename(OBJECT(dev
)));
321 error_append_hint(errp
, "/\"%s\"", dev
->id
);
325 error_append_hint(errp
, "\n");
328 static BusState
*qbus_find_bus(DeviceState
*dev
, char *elem
)
332 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
333 if (strcmp(child
->name
, elem
) == 0) {
340 static DeviceState
*qbus_find_dev(BusState
*bus
, char *elem
)
345 * try to match in order:
346 * (1) instance id, if present
348 * (3) driver alias, if present
350 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
351 DeviceState
*dev
= kid
->child
;
352 if (dev
->id
&& strcmp(dev
->id
, elem
) == 0) {
356 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
357 DeviceState
*dev
= kid
->child
;
358 if (strcmp(object_get_typename(OBJECT(dev
)), elem
) == 0) {
362 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
363 DeviceState
*dev
= kid
->child
;
364 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
366 if (qdev_class_has_alias(dc
) &&
367 strcmp(qdev_class_get_alias(dc
), elem
) == 0) {
374 static inline bool qbus_is_full(BusState
*bus
)
376 BusClass
*bus_class
= BUS_GET_CLASS(bus
);
377 return bus_class
->max_dev
&& bus
->max_index
>= bus_class
->max_dev
;
381 * Search the tree rooted at @bus for a bus.
382 * If @name, search for a bus with that name. Note that bus names
383 * need not be unique. Yes, that's screwed up.
384 * Else search for a bus that is a subtype of @bus_typename.
385 * If more than one exists, prefer one that can take another device.
386 * Return the bus if found, else %NULL.
388 static BusState
*qbus_find_recursive(BusState
*bus
, const char *name
,
389 const char *bus_typename
)
392 BusState
*pick
, *child
, *ret
;
395 assert(name
|| bus_typename
);
397 match
= !strcmp(bus
->name
, name
);
399 match
= !!object_dynamic_cast(OBJECT(bus
), bus_typename
);
402 if (match
&& !qbus_is_full(bus
)) {
403 return bus
; /* root matches and isn't full */
406 pick
= match
? bus
: NULL
;
408 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
409 DeviceState
*dev
= kid
->child
;
410 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
411 ret
= qbus_find_recursive(child
, name
, bus_typename
);
412 if (ret
&& !qbus_is_full(ret
)) {
413 return ret
; /* a descendant matches and isn't full */
421 /* root or a descendant matches, but is full */
425 static BusState
*qbus_find(const char *path
, Error
**errp
)
432 /* find start element */
433 if (path
[0] == '/') {
434 bus
= sysbus_get_default();
437 if (sscanf(path
, "%127[^/]%n", elem
, &len
) != 1) {
441 bus
= qbus_find_recursive(sysbus_get_default(), elem
, NULL
);
443 error_setg(errp
, "Bus '%s' not found", elem
);
450 assert(path
[pos
] == '/' || !path
[pos
]);
451 while (path
[pos
] == '/') {
454 if (path
[pos
] == '\0') {
459 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
460 g_assert_not_reached();
464 dev
= qbus_find_dev(bus
, elem
);
466 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
467 "Device '%s' not found", elem
);
468 qbus_list_dev(bus
, errp
);
472 assert(path
[pos
] == '/' || !path
[pos
]);
473 while (path
[pos
] == '/') {
476 if (path
[pos
] == '\0') {
477 /* last specified element is a device. If it has exactly
478 * one child bus accept it nevertheless */
479 if (dev
->num_child_bus
== 1) {
480 bus
= QLIST_FIRST(&dev
->child_bus
);
483 if (dev
->num_child_bus
) {
484 error_setg(errp
, "Device '%s' has multiple child buses",
486 qbus_list_bus(dev
, errp
);
488 error_setg(errp
, "Device '%s' has no child bus", elem
);
494 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
495 g_assert_not_reached();
499 bus
= qbus_find_bus(dev
, elem
);
501 error_setg(errp
, "Bus '%s' not found", elem
);
502 qbus_list_bus(dev
, errp
);
507 if (qbus_is_full(bus
)) {
508 error_setg(errp
, "Bus '%s' is full", path
);
514 DeviceState
*qdev_device_add(QemuOpts
*opts
, Error
**errp
)
517 const char *driver
, *path
, *id
;
519 BusState
*bus
= NULL
;
522 driver
= qemu_opt_get(opts
, "driver");
524 error_setg(errp
, QERR_MISSING_PARAMETER
, "driver");
529 dc
= qdev_get_device_class(&driver
, errp
);
535 path
= qemu_opt_get(opts
, "bus");
537 bus
= qbus_find(path
, errp
);
541 if (!object_dynamic_cast(OBJECT(bus
), dc
->bus_type
)) {
542 error_setg(errp
, "Device '%s' can't go on %s bus",
543 driver
, object_get_typename(OBJECT(bus
)));
546 } else if (dc
->bus_type
!= NULL
) {
547 bus
= qbus_find_recursive(sysbus_get_default(), NULL
, dc
->bus_type
);
548 if (!bus
|| qbus_is_full(bus
)) {
549 error_setg(errp
, "No '%s' bus found for device '%s'",
550 dc
->bus_type
, driver
);
554 if (qdev_hotplug
&& bus
&& !qbus_is_hotpluggable(bus
)) {
555 error_setg(errp
, QERR_BUS_NO_HOTPLUG
, bus
->name
);
560 dev
= DEVICE(object_new(driver
));
563 qdev_set_parent_bus(dev
, bus
);
566 id
= qemu_opts_id(opts
);
572 object_property_add_child(qdev_get_peripheral(), dev
->id
,
575 static int anon_count
;
576 gchar
*name
= g_strdup_printf("device[%d]", anon_count
++);
577 object_property_add_child(qdev_get_peripheral_anon(), name
,
583 if (qemu_opt_foreach(opts
, set_property
, dev
, &err
)) {
584 error_propagate(errp
, err
);
585 object_unparent(OBJECT(dev
));
586 object_unref(OBJECT(dev
));
591 object_property_set_bool(OBJECT(dev
), true, "realized", &err
);
593 error_propagate(errp
, err
);
595 object_unparent(OBJECT(dev
));
596 object_unref(OBJECT(dev
));
603 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
604 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
);
606 static void qdev_print_props(Monitor
*mon
, DeviceState
*dev
, Property
*props
,
611 for (; props
->name
; props
++) {
614 char *legacy_name
= g_strdup_printf("legacy-%s", props
->name
);
615 if (object_property_get_type(OBJECT(dev
), legacy_name
, NULL
)) {
616 value
= object_property_get_str(OBJECT(dev
), legacy_name
, &err
);
618 value
= object_property_print(OBJECT(dev
), props
->name
, true, &err
);
626 qdev_printf("%s = %s\n", props
->name
,
627 value
&& *value
? value
: "<null>");
632 static void bus_print_dev(BusState
*bus
, Monitor
*mon
, DeviceState
*dev
, int indent
)
634 BusClass
*bc
= BUS_GET_CLASS(bus
);
637 bc
->print_dev(mon
, dev
, indent
);
641 static void qdev_print(Monitor
*mon
, DeviceState
*dev
, int indent
)
647 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev
)),
648 dev
->id
? dev
->id
: "");
650 QLIST_FOREACH(ngl
, &dev
->gpios
, node
) {
652 qdev_printf("gpio-in \"%s\" %d\n", ngl
->name
? ngl
->name
: "",
656 qdev_printf("gpio-out \"%s\" %d\n", ngl
->name
? ngl
->name
: "",
660 class = object_get_class(OBJECT(dev
));
662 qdev_print_props(mon
, dev
, DEVICE_CLASS(class)->props
, indent
);
663 class = object_class_get_parent(class);
664 } while (class != object_class_by_name(TYPE_DEVICE
));
665 bus_print_dev(dev
->parent_bus
, mon
, dev
, indent
);
666 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
667 qbus_print(mon
, child
, indent
);
671 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
)
675 qdev_printf("bus: %s\n", bus
->name
);
677 qdev_printf("type %s\n", object_get_typename(OBJECT(bus
)));
678 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
679 DeviceState
*dev
= kid
->child
;
680 qdev_print(mon
, dev
, indent
);
685 void hmp_info_qtree(Monitor
*mon
, const QDict
*qdict
)
687 if (sysbus_get_default())
688 qbus_print(mon
, sysbus_get_default(), 0);
691 void hmp_info_qdm(Monitor
*mon
, const QDict
*qdict
)
693 qdev_print_devinfos(true);
696 typedef struct QOMCompositionState
{
699 } QOMCompositionState
;
701 static void print_qom_composition(Monitor
*mon
, Object
*obj
, int indent
);
703 static int print_qom_composition_child(Object
*obj
, void *opaque
)
705 QOMCompositionState
*s
= opaque
;
707 print_qom_composition(s
->mon
, obj
, s
->indent
);
712 static void print_qom_composition(Monitor
*mon
, Object
*obj
, int indent
)
714 QOMCompositionState s
= {
716 .indent
= indent
+ 2,
720 if (obj
== object_get_root()) {
723 name
= object_get_canonical_path_component(obj
);
725 monitor_printf(mon
, "%*s/%s (%s)\n", indent
, "", name
,
726 object_get_typename(obj
));
728 object_child_foreach(obj
, print_qom_composition_child
, &s
);
731 void hmp_info_qom_tree(Monitor
*mon
, const QDict
*dict
)
733 const char *path
= qdict_get_try_str(dict
, "path");
735 bool ambiguous
= false;
738 obj
= object_resolve_path(path
, &ambiguous
);
740 monitor_printf(mon
, "Path '%s' could not be resolved.\n", path
);
744 monitor_printf(mon
, "Warning: Path '%s' is ambiguous.\n", path
);
748 obj
= qdev_get_machine();
750 print_qom_composition(mon
, obj
, 0);
753 void qmp_device_add(QDict
*qdict
, QObject
**ret_data
, Error
**errp
)
755 Error
*local_err
= NULL
;
759 opts
= qemu_opts_from_qdict(qemu_find_opts("device"), qdict
, &local_err
);
761 error_propagate(errp
, local_err
);
764 if (!monitor_cur_is_qmp() && qdev_device_help(opts
)) {
768 dev
= qdev_device_add(opts
, &local_err
);
770 error_propagate(errp
, local_err
);
774 object_unref(OBJECT(dev
));
777 void qmp_device_del(const char *id
, Error
**errp
)
782 obj
= object_resolve_path(id
, NULL
);
784 char *root_path
= object_get_canonical_path(qdev_get_peripheral());
785 char *path
= g_strdup_printf("%s/%s", root_path
, id
);
788 obj
= object_resolve_path_type(path
, TYPE_DEVICE
, NULL
);
793 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
794 "Device '%s' not found", id
);
798 if (!object_dynamic_cast(obj
, TYPE_DEVICE
)) {
799 error_setg(errp
, "%s is not a hotpluggable device", id
);
803 qdev_unplug(DEVICE(obj
), errp
);
806 void qdev_machine_init(void)
808 qdev_get_peripheral_anon();
809 qdev_get_peripheral();
812 QemuOptsList qemu_device_opts
= {
814 .implied_opt_name
= "driver",
815 .head
= QTAILQ_HEAD_INITIALIZER(qemu_device_opts
.head
),
818 * no elements => accept any
819 * sanity checking will happen later
820 * when setting device properties
822 { /* end of list */ }
826 QemuOptsList qemu_global_opts
= {
828 .head
= QTAILQ_HEAD_INITIALIZER(qemu_global_opts
.head
),
832 .type
= QEMU_OPT_STRING
,
835 .type
= QEMU_OPT_STRING
,
838 .type
= QEMU_OPT_STRING
,
840 { /* end of list */ }
844 int qemu_global_option(const char *str
)
846 char driver
[64], property
[64];
850 rc
= sscanf(str
, "%63[^.=].%63[^=]%n", driver
, property
, &offset
);
851 if (rc
== 2 && str
[offset
] == '=') {
852 opts
= qemu_opts_create(&qemu_global_opts
, NULL
, 0, &error_abort
);
853 qemu_opt_set(opts
, "driver", driver
, &error_abort
);
854 qemu_opt_set(opts
, "property", property
, &error_abort
);
855 qemu_opt_set(opts
, "value", str
+ offset
+ 1, &error_abort
);
859 opts
= qemu_opts_parse_noisily(&qemu_global_opts
, str
, false);