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 "qapi/qmp/qerror.h"
27 #include "qemu/config-file.h"
28 #include "qemu/error-report.h"
31 * Aliases were a bad idea from the start. Let's keep them
32 * from spreading further.
34 typedef struct QDevAlias
41 static const QDevAlias qdev_alias_table
[] = {
42 { "virtio-blk-pci", "virtio-blk", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
43 { "virtio-net-pci", "virtio-net", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
44 { "virtio-serial-pci", "virtio-serial", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
45 { "virtio-balloon-pci", "virtio-balloon",
46 QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
47 { "virtio-blk-ccw", "virtio-blk", QEMU_ARCH_S390X
},
48 { "virtio-net-ccw", "virtio-net", QEMU_ARCH_S390X
},
49 { "virtio-serial-ccw", "virtio-serial", QEMU_ARCH_S390X
},
50 { "lsi53c895a", "lsi" },
51 { "ich9-ahci", "ahci" },
52 { "kvm-pci-assign", "pci-assign" },
56 static const char *qdev_class_get_alias(DeviceClass
*dc
)
58 const char *typename
= object_class_get_name(OBJECT_CLASS(dc
));
61 for (i
= 0; qdev_alias_table
[i
].typename
; i
++) {
62 if (qdev_alias_table
[i
].arch_mask
&&
63 !(qdev_alias_table
[i
].arch_mask
& arch_type
)) {
67 if (strcmp(qdev_alias_table
[i
].typename
, typename
) == 0) {
68 return qdev_alias_table
[i
].alias
;
75 static bool qdev_class_has_alias(DeviceClass
*dc
)
77 return (qdev_class_get_alias(dc
) != NULL
);
80 static void qdev_print_devinfo(DeviceClass
*dc
)
82 error_printf("name \"%s\"", object_class_get_name(OBJECT_CLASS(dc
)));
84 error_printf(", bus %s", dc
->bus_type
);
86 if (qdev_class_has_alias(dc
)) {
87 error_printf(", alias \"%s\"", qdev_class_get_alias(dc
));
90 error_printf(", desc \"%s\"", dc
->desc
);
92 if (dc
->cannot_instantiate_with_device_add_yet
) {
93 error_printf(", no-user");
98 static gint
devinfo_cmp(gconstpointer a
, gconstpointer b
)
100 return strcasecmp(object_class_get_name((ObjectClass
*)a
),
101 object_class_get_name((ObjectClass
*)b
));
104 static void qdev_print_devinfos(bool show_no_user
)
106 static const char *cat_name
[DEVICE_CATEGORY_MAX
+ 1] = {
107 [DEVICE_CATEGORY_BRIDGE
] = "Controller/Bridge/Hub",
108 [DEVICE_CATEGORY_USB
] = "USB",
109 [DEVICE_CATEGORY_STORAGE
] = "Storage",
110 [DEVICE_CATEGORY_NETWORK
] = "Network",
111 [DEVICE_CATEGORY_INPUT
] = "Input",
112 [DEVICE_CATEGORY_DISPLAY
] = "Display",
113 [DEVICE_CATEGORY_SOUND
] = "Sound",
114 [DEVICE_CATEGORY_MISC
] = "Misc",
115 [DEVICE_CATEGORY_MAX
] = "Uncategorized",
121 list
= g_slist_sort(object_class_get_list(TYPE_DEVICE
, false),
124 for (i
= 0; i
<= DEVICE_CATEGORY_MAX
; i
++) {
126 for (elt
= list
; elt
; elt
= elt
->next
) {
127 DeviceClass
*dc
= OBJECT_CLASS_CHECK(DeviceClass
, elt
->data
,
129 if ((i
< DEVICE_CATEGORY_MAX
130 ? !test_bit(i
, dc
->categories
)
131 : !bitmap_empty(dc
->categories
, DEVICE_CATEGORY_MAX
))
133 && dc
->cannot_instantiate_with_device_add_yet
)) {
137 error_printf("%s%s devices:\n", i
? "\n" : "",
141 qdev_print_devinfo(dc
);
148 static int set_property(void *opaque
, const char *name
, const char *value
,
151 Object
*obj
= opaque
;
154 if (strcmp(name
, "driver") == 0)
156 if (strcmp(name
, "bus") == 0)
159 object_property_parse(obj
, value
, name
, &err
);
161 error_propagate(errp
, err
);
167 static const char *find_typename_by_alias(const char *alias
)
171 for (i
= 0; qdev_alias_table
[i
].alias
; i
++) {
172 if (qdev_alias_table
[i
].arch_mask
&&
173 !(qdev_alias_table
[i
].arch_mask
& arch_type
)) {
177 if (strcmp(qdev_alias_table
[i
].alias
, alias
) == 0) {
178 return qdev_alias_table
[i
].typename
;
185 static DeviceClass
*qdev_get_device_class(const char **driver
, Error
**errp
)
190 oc
= object_class_by_name(*driver
);
192 const char *typename
= find_typename_by_alias(*driver
);
196 oc
= object_class_by_name(*driver
);
200 if (!object_class_dynamic_cast(oc
, TYPE_DEVICE
)) {
201 error_setg(errp
, "'%s' is not a valid device model name", *driver
);
205 if (object_class_is_abstract(oc
)) {
206 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
207 "non-abstract device type");
211 dc
= DEVICE_CLASS(oc
);
212 if (dc
->cannot_instantiate_with_device_add_yet
||
213 (qdev_hotplug
&& !dc
->hotpluggable
)) {
214 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
215 "pluggable device type");
223 int qdev_device_help(QemuOpts
*opts
)
225 Error
*local_err
= NULL
;
227 DevicePropertyInfoList
*prop_list
;
228 DevicePropertyInfoList
*prop
;
230 driver
= qemu_opt_get(opts
, "driver");
231 if (driver
&& is_help_option(driver
)) {
232 qdev_print_devinfos(false);
236 if (!driver
|| !qemu_opt_has_help_opt(opts
)) {
240 qdev_get_device_class(&driver
, &local_err
);
245 prop_list
= qmp_device_list_properties(driver
, &local_err
);
250 for (prop
= prop_list
; prop
; prop
= prop
->next
) {
251 error_printf("%s.%s=%s", driver
,
254 if (prop
->value
->has_description
) {
255 error_printf(" (%s)\n", prop
->value
->description
);
261 qapi_free_DevicePropertyInfoList(prop_list
);
265 error_printf("%s\n", error_get_pretty(local_err
));
266 error_free(local_err
);
270 static Object
*qdev_get_peripheral(void)
275 dev
= container_get(qdev_get_machine(), "/peripheral");
281 static Object
*qdev_get_peripheral_anon(void)
286 dev
= container_get(qdev_get_machine(), "/peripheral-anon");
292 static void qbus_list_bus(DeviceState
*dev
, Error
**errp
)
295 const char *sep
= " ";
297 error_append_hint(errp
, "child buses at \"%s\":",
298 dev
->id
? dev
->id
: object_get_typename(OBJECT(dev
)));
299 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
300 error_append_hint(errp
, "%s\"%s\"", sep
, child
->name
);
305 static void qbus_list_dev(BusState
*bus
, Error
**errp
)
308 const char *sep
= " ";
310 error_append_hint(errp
, "devices at \"%s\":", bus
->name
);
311 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
312 DeviceState
*dev
= kid
->child
;
313 error_append_hint(errp
, "%s\"%s\"", sep
,
314 object_get_typename(OBJECT(dev
)));
316 error_append_hint(errp
, "/\"%s\"", dev
->id
);
322 static BusState
*qbus_find_bus(DeviceState
*dev
, char *elem
)
326 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
327 if (strcmp(child
->name
, elem
) == 0) {
334 static DeviceState
*qbus_find_dev(BusState
*bus
, char *elem
)
339 * try to match in order:
340 * (1) instance id, if present
342 * (3) driver alias, if present
344 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
345 DeviceState
*dev
= kid
->child
;
346 if (dev
->id
&& strcmp(dev
->id
, elem
) == 0) {
350 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
351 DeviceState
*dev
= kid
->child
;
352 if (strcmp(object_get_typename(OBJECT(dev
)), elem
) == 0) {
356 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
357 DeviceState
*dev
= kid
->child
;
358 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
360 if (qdev_class_has_alias(dc
) &&
361 strcmp(qdev_class_get_alias(dc
), elem
) == 0) {
368 static inline bool qbus_is_full(BusState
*bus
)
370 BusClass
*bus_class
= BUS_GET_CLASS(bus
);
371 return bus_class
->max_dev
&& bus
->max_index
>= bus_class
->max_dev
;
375 * Search the tree rooted at @bus for a bus.
376 * If @name, search for a bus with that name. Note that bus names
377 * need not be unique. Yes, that's screwed up.
378 * Else search for a bus that is a subtype of @bus_typename.
379 * If more than one exists, prefer one that can take another device.
380 * Return the bus if found, else %NULL.
382 static BusState
*qbus_find_recursive(BusState
*bus
, const char *name
,
383 const char *bus_typename
)
386 BusState
*pick
, *child
, *ret
;
389 assert(name
|| bus_typename
);
391 match
= !strcmp(bus
->name
, name
);
393 match
= !!object_dynamic_cast(OBJECT(bus
), bus_typename
);
396 if (match
&& !qbus_is_full(bus
)) {
397 return bus
; /* root matches and isn't full */
400 pick
= match
? bus
: NULL
;
402 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
403 DeviceState
*dev
= kid
->child
;
404 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
405 ret
= qbus_find_recursive(child
, name
, bus_typename
);
406 if (ret
&& !qbus_is_full(ret
)) {
407 return ret
; /* a descendant matches and isn't full */
415 /* root or a descendant matches, but is full */
419 static BusState
*qbus_find(const char *path
, Error
**errp
)
426 /* find start element */
427 if (path
[0] == '/') {
428 bus
= sysbus_get_default();
431 if (sscanf(path
, "%127[^/]%n", elem
, &len
) != 1) {
435 bus
= qbus_find_recursive(sysbus_get_default(), elem
, NULL
);
437 error_setg(errp
, "Bus '%s' not found", elem
);
444 assert(path
[pos
] == '/' || !path
[pos
]);
445 while (path
[pos
] == '/') {
448 if (path
[pos
] == '\0') {
453 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
454 g_assert_not_reached();
458 dev
= qbus_find_dev(bus
, elem
);
460 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
461 "Device '%s' not found", elem
);
462 qbus_list_dev(bus
, errp
);
466 assert(path
[pos
] == '/' || !path
[pos
]);
467 while (path
[pos
] == '/') {
470 if (path
[pos
] == '\0') {
471 /* last specified element is a device. If it has exactly
472 * one child bus accept it nevertheless */
473 if (dev
->num_child_bus
== 1) {
474 bus
= QLIST_FIRST(&dev
->child_bus
);
477 if (dev
->num_child_bus
) {
478 error_setg(errp
, "Device '%s' has multiple child buses",
480 qbus_list_bus(dev
, errp
);
482 error_setg(errp
, "Device '%s' has no child bus", elem
);
488 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
489 g_assert_not_reached();
493 bus
= qbus_find_bus(dev
, elem
);
495 error_setg(errp
, "Bus '%s' not found", elem
);
496 qbus_list_bus(dev
, errp
);
501 if (qbus_is_full(bus
)) {
502 error_setg(errp
, "Bus '%s' is full", path
);
508 DeviceState
*qdev_device_add(QemuOpts
*opts
, Error
**errp
)
511 const char *driver
, *path
, *id
;
513 BusState
*bus
= NULL
;
516 driver
= qemu_opt_get(opts
, "driver");
518 error_setg(errp
, QERR_MISSING_PARAMETER
, "driver");
523 dc
= qdev_get_device_class(&driver
, errp
);
529 path
= qemu_opt_get(opts
, "bus");
531 bus
= qbus_find(path
, errp
);
535 if (!object_dynamic_cast(OBJECT(bus
), dc
->bus_type
)) {
536 error_setg(errp
, "Device '%s' can't go on %s bus",
537 driver
, object_get_typename(OBJECT(bus
)));
540 } else if (dc
->bus_type
!= NULL
) {
541 bus
= qbus_find_recursive(sysbus_get_default(), NULL
, dc
->bus_type
);
542 if (!bus
|| qbus_is_full(bus
)) {
543 error_setg(errp
, "No '%s' bus found for device '%s'",
544 dc
->bus_type
, driver
);
548 if (qdev_hotplug
&& bus
&& !qbus_is_hotpluggable(bus
)) {
549 error_setg(errp
, QERR_BUS_NO_HOTPLUG
, bus
->name
);
554 dev
= DEVICE(object_new(driver
));
557 qdev_set_parent_bus(dev
, bus
);
560 id
= qemu_opts_id(opts
);
566 object_property_add_child(qdev_get_peripheral(), dev
->id
,
569 static int anon_count
;
570 gchar
*name
= g_strdup_printf("device[%d]", anon_count
++);
571 object_property_add_child(qdev_get_peripheral_anon(), name
,
577 if (qemu_opt_foreach(opts
, set_property
, dev
, &err
)) {
578 error_propagate(errp
, err
);
579 object_unparent(OBJECT(dev
));
580 object_unref(OBJECT(dev
));
585 object_property_set_bool(OBJECT(dev
), true, "realized", &err
);
587 error_propagate(errp
, err
);
589 object_unparent(OBJECT(dev
));
590 object_unref(OBJECT(dev
));
597 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
598 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
);
600 static void qdev_print_props(Monitor
*mon
, DeviceState
*dev
, Property
*props
,
605 for (; props
->name
; props
++) {
608 char *legacy_name
= g_strdup_printf("legacy-%s", props
->name
);
609 if (object_property_get_type(OBJECT(dev
), legacy_name
, NULL
)) {
610 value
= object_property_get_str(OBJECT(dev
), legacy_name
, &err
);
612 value
= object_property_print(OBJECT(dev
), props
->name
, true, &err
);
620 qdev_printf("%s = %s\n", props
->name
,
621 value
&& *value
? value
: "<null>");
626 static void bus_print_dev(BusState
*bus
, Monitor
*mon
, DeviceState
*dev
, int indent
)
628 BusClass
*bc
= BUS_GET_CLASS(bus
);
631 bc
->print_dev(mon
, dev
, indent
);
635 static void qdev_print(Monitor
*mon
, DeviceState
*dev
, int indent
)
641 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev
)),
642 dev
->id
? dev
->id
: "");
644 QLIST_FOREACH(ngl
, &dev
->gpios
, node
) {
646 qdev_printf("gpio-in \"%s\" %d\n", ngl
->name
? ngl
->name
: "",
650 qdev_printf("gpio-out \"%s\" %d\n", ngl
->name
? ngl
->name
: "",
654 class = object_get_class(OBJECT(dev
));
656 qdev_print_props(mon
, dev
, DEVICE_CLASS(class)->props
, indent
);
657 class = object_class_get_parent(class);
658 } while (class != object_class_by_name(TYPE_DEVICE
));
659 bus_print_dev(dev
->parent_bus
, mon
, dev
, indent
);
660 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
661 qbus_print(mon
, child
, indent
);
665 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
)
669 qdev_printf("bus: %s\n", bus
->name
);
671 qdev_printf("type %s\n", object_get_typename(OBJECT(bus
)));
672 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
673 DeviceState
*dev
= kid
->child
;
674 qdev_print(mon
, dev
, indent
);
679 void hmp_info_qtree(Monitor
*mon
, const QDict
*qdict
)
681 if (sysbus_get_default())
682 qbus_print(mon
, sysbus_get_default(), 0);
685 void hmp_info_qdm(Monitor
*mon
, const QDict
*qdict
)
687 qdev_print_devinfos(true);
690 typedef struct QOMCompositionState
{
693 } QOMCompositionState
;
695 static void print_qom_composition(Monitor
*mon
, Object
*obj
, int indent
);
697 static int print_qom_composition_child(Object
*obj
, void *opaque
)
699 QOMCompositionState
*s
= opaque
;
701 print_qom_composition(s
->mon
, obj
, s
->indent
);
706 static void print_qom_composition(Monitor
*mon
, Object
*obj
, int indent
)
708 QOMCompositionState s
= {
710 .indent
= indent
+ 2,
714 if (obj
== object_get_root()) {
717 name
= object_get_canonical_path_component(obj
);
719 monitor_printf(mon
, "%*s/%s (%s)\n", indent
, "", name
,
720 object_get_typename(obj
));
722 object_child_foreach(obj
, print_qom_composition_child
, &s
);
725 void hmp_info_qom_tree(Monitor
*mon
, const QDict
*dict
)
727 const char *path
= qdict_get_try_str(dict
, "path");
729 bool ambiguous
= false;
732 obj
= object_resolve_path(path
, &ambiguous
);
734 monitor_printf(mon
, "Path '%s' could not be resolved.\n", path
);
738 monitor_printf(mon
, "Warning: Path '%s' is ambiguous.\n", path
);
742 obj
= qdev_get_machine();
744 print_qom_composition(mon
, obj
, 0);
747 void qmp_device_add(QDict
*qdict
, QObject
**ret_data
, Error
**errp
)
749 Error
*local_err
= NULL
;
753 opts
= qemu_opts_from_qdict(qemu_find_opts("device"), qdict
, &local_err
);
755 error_propagate(errp
, local_err
);
758 if (!monitor_cur_is_qmp() && qdev_device_help(opts
)) {
762 dev
= qdev_device_add(opts
, &local_err
);
764 error_propagate(errp
, local_err
);
768 object_unref(OBJECT(dev
));
771 void qmp_device_del(const char *id
, Error
**errp
)
776 obj
= object_resolve_path(id
, NULL
);
778 char *root_path
= object_get_canonical_path(qdev_get_peripheral());
779 char *path
= g_strdup_printf("%s/%s", root_path
, id
);
782 obj
= object_resolve_path_type(path
, TYPE_DEVICE
, NULL
);
787 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
788 "Device '%s' not found", id
);
792 if (!object_dynamic_cast(obj
, TYPE_DEVICE
)) {
793 error_setg(errp
, "%s is not a hotpluggable device", id
);
797 qdev_unplug(DEVICE(obj
), errp
);
800 void qdev_machine_init(void)
802 qdev_get_peripheral_anon();
803 qdev_get_peripheral();
806 QemuOptsList qemu_device_opts
= {
808 .implied_opt_name
= "driver",
809 .head
= QTAILQ_HEAD_INITIALIZER(qemu_device_opts
.head
),
812 * no elements => accept any
813 * sanity checking will happen later
814 * when setting device properties
816 { /* end of list */ }
820 QemuOptsList qemu_global_opts
= {
822 .head
= QTAILQ_HEAD_INITIALIZER(qemu_global_opts
.head
),
826 .type
= QEMU_OPT_STRING
,
829 .type
= QEMU_OPT_STRING
,
832 .type
= QEMU_OPT_STRING
,
834 { /* end of list */ }
838 int qemu_global_option(const char *str
)
840 char driver
[64], property
[64];
844 rc
= sscanf(str
, "%63[^.=].%63[^=]%n", driver
, property
, &offset
);
845 if (rc
== 2 && str
[offset
] == '=') {
846 opts
= qemu_opts_create(&qemu_global_opts
, NULL
, 0, &error_abort
);
847 qemu_opt_set(opts
, "driver", driver
, &error_abort
);
848 qemu_opt_set(opts
, "property", property
, &error_abort
);
849 qemu_opt_set(opts
, "value", str
+ offset
+ 1, &error_abort
);
853 opts
= qemu_opts_parse_noisily(&qemu_global_opts
, str
, false);