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 /* Please keep this table sorted by typename. */
43 static const QDevAlias qdev_alias_table
[] = {
44 { "e1000", "e1000-82540em" },
45 { "ich9-ahci", "ahci" },
46 { "kvm-pci-assign", "pci-assign" },
47 { "lsi53c895a", "lsi" },
48 { "virtio-balloon-pci", "virtio-balloon",
49 QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
50 { "virtio-blk-ccw", "virtio-blk", QEMU_ARCH_S390X
},
51 { "virtio-blk-pci", "virtio-blk", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
52 { "virtio-net-ccw", "virtio-net", QEMU_ARCH_S390X
},
53 { "virtio-net-pci", "virtio-net", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
54 { "virtio-serial-ccw", "virtio-serial", QEMU_ARCH_S390X
},
55 { "virtio-serial-pci", "virtio-serial", QEMU_ARCH_ALL
& ~QEMU_ARCH_S390X
},
59 static const char *qdev_class_get_alias(DeviceClass
*dc
)
61 const char *typename
= object_class_get_name(OBJECT_CLASS(dc
));
64 for (i
= 0; qdev_alias_table
[i
].typename
; i
++) {
65 if (qdev_alias_table
[i
].arch_mask
&&
66 !(qdev_alias_table
[i
].arch_mask
& arch_type
)) {
70 if (strcmp(qdev_alias_table
[i
].typename
, typename
) == 0) {
71 return qdev_alias_table
[i
].alias
;
78 static bool qdev_class_has_alias(DeviceClass
*dc
)
80 return (qdev_class_get_alias(dc
) != NULL
);
83 static void qdev_print_devinfo(DeviceClass
*dc
)
85 error_printf("name \"%s\"", object_class_get_name(OBJECT_CLASS(dc
)));
87 error_printf(", bus %s", dc
->bus_type
);
89 if (qdev_class_has_alias(dc
)) {
90 error_printf(", alias \"%s\"", qdev_class_get_alias(dc
));
93 error_printf(", desc \"%s\"", dc
->desc
);
95 if (dc
->cannot_instantiate_with_device_add_yet
) {
96 error_printf(", no-user");
101 static gint
devinfo_cmp(gconstpointer a
, gconstpointer b
)
103 return strcasecmp(object_class_get_name((ObjectClass
*)a
),
104 object_class_get_name((ObjectClass
*)b
));
107 static void qdev_print_devinfos(bool show_no_user
)
109 static const char *cat_name
[DEVICE_CATEGORY_MAX
+ 1] = {
110 [DEVICE_CATEGORY_BRIDGE
] = "Controller/Bridge/Hub",
111 [DEVICE_CATEGORY_USB
] = "USB",
112 [DEVICE_CATEGORY_STORAGE
] = "Storage",
113 [DEVICE_CATEGORY_NETWORK
] = "Network",
114 [DEVICE_CATEGORY_INPUT
] = "Input",
115 [DEVICE_CATEGORY_DISPLAY
] = "Display",
116 [DEVICE_CATEGORY_SOUND
] = "Sound",
117 [DEVICE_CATEGORY_MISC
] = "Misc",
118 [DEVICE_CATEGORY_MAX
] = "Uncategorized",
124 list
= g_slist_sort(object_class_get_list(TYPE_DEVICE
, false),
127 for (i
= 0; i
<= DEVICE_CATEGORY_MAX
; i
++) {
129 for (elt
= list
; elt
; elt
= elt
->next
) {
130 DeviceClass
*dc
= OBJECT_CLASS_CHECK(DeviceClass
, elt
->data
,
132 if ((i
< DEVICE_CATEGORY_MAX
133 ? !test_bit(i
, dc
->categories
)
134 : !bitmap_empty(dc
->categories
, DEVICE_CATEGORY_MAX
))
136 && dc
->cannot_instantiate_with_device_add_yet
)) {
140 error_printf("%s%s devices:\n", i
? "\n" : "",
144 qdev_print_devinfo(dc
);
151 static int set_property(void *opaque
, const char *name
, const char *value
,
154 Object
*obj
= opaque
;
157 if (strcmp(name
, "driver") == 0)
159 if (strcmp(name
, "bus") == 0)
162 object_property_parse(obj
, value
, name
, &err
);
164 error_propagate(errp
, err
);
170 static const char *find_typename_by_alias(const char *alias
)
174 for (i
= 0; qdev_alias_table
[i
].alias
; i
++) {
175 if (qdev_alias_table
[i
].arch_mask
&&
176 !(qdev_alias_table
[i
].arch_mask
& arch_type
)) {
180 if (strcmp(qdev_alias_table
[i
].alias
, alias
) == 0) {
181 return qdev_alias_table
[i
].typename
;
188 static DeviceClass
*qdev_get_device_class(const char **driver
, Error
**errp
)
192 const char *original_name
= *driver
;
194 oc
= object_class_by_name(*driver
);
196 const char *typename
= find_typename_by_alias(*driver
);
200 oc
= object_class_by_name(*driver
);
204 if (!object_class_dynamic_cast(oc
, TYPE_DEVICE
)) {
205 if (*driver
!= original_name
) {
206 error_setg(errp
, "'%s' (alias '%s') is not a valid device model"
207 " name", original_name
, *driver
);
209 error_setg(errp
, "'%s' is not a valid device model name", *driver
);
214 if (object_class_is_abstract(oc
)) {
215 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
216 "non-abstract device type");
220 dc
= DEVICE_CLASS(oc
);
221 if (dc
->cannot_instantiate_with_device_add_yet
||
222 (qdev_hotplug
&& !dc
->hotpluggable
)) {
223 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
224 "pluggable device type");
232 int qdev_device_help(QemuOpts
*opts
)
234 Error
*local_err
= NULL
;
236 DevicePropertyInfoList
*prop_list
;
237 DevicePropertyInfoList
*prop
;
239 driver
= qemu_opt_get(opts
, "driver");
240 if (driver
&& is_help_option(driver
)) {
241 qdev_print_devinfos(false);
245 if (!driver
|| !qemu_opt_has_help_opt(opts
)) {
249 if (!object_class_by_name(driver
)) {
250 const char *typename
= find_typename_by_alias(driver
);
257 prop_list
= qmp_device_list_properties(driver
, &local_err
);
262 for (prop
= prop_list
; prop
; prop
= prop
->next
) {
263 error_printf("%s.%s=%s", driver
,
266 if (prop
->value
->has_description
) {
267 error_printf(" (%s)\n", prop
->value
->description
);
273 qapi_free_DevicePropertyInfoList(prop_list
);
277 error_report_err(local_err
);
281 static Object
*qdev_get_peripheral(void)
286 dev
= container_get(qdev_get_machine(), "/peripheral");
292 static Object
*qdev_get_peripheral_anon(void)
297 dev
= container_get(qdev_get_machine(), "/peripheral-anon");
303 static void qbus_list_bus(DeviceState
*dev
, Error
**errp
)
306 const char *sep
= " ";
308 error_append_hint(errp
, "child buses at \"%s\":",
309 dev
->id
? dev
->id
: object_get_typename(OBJECT(dev
)));
310 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
311 error_append_hint(errp
, "%s\"%s\"", sep
, child
->name
);
314 error_append_hint(errp
, "\n");
317 static void qbus_list_dev(BusState
*bus
, Error
**errp
)
320 const char *sep
= " ";
322 error_append_hint(errp
, "devices at \"%s\":", bus
->name
);
323 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
324 DeviceState
*dev
= kid
->child
;
325 error_append_hint(errp
, "%s\"%s\"", sep
,
326 object_get_typename(OBJECT(dev
)));
328 error_append_hint(errp
, "/\"%s\"", dev
->id
);
332 error_append_hint(errp
, "\n");
335 static BusState
*qbus_find_bus(DeviceState
*dev
, char *elem
)
339 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
340 if (strcmp(child
->name
, elem
) == 0) {
347 static DeviceState
*qbus_find_dev(BusState
*bus
, char *elem
)
352 * try to match in order:
353 * (1) instance id, if present
355 * (3) driver alias, if present
357 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
358 DeviceState
*dev
= kid
->child
;
359 if (dev
->id
&& strcmp(dev
->id
, elem
) == 0) {
363 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
364 DeviceState
*dev
= kid
->child
;
365 if (strcmp(object_get_typename(OBJECT(dev
)), elem
) == 0) {
369 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
370 DeviceState
*dev
= kid
->child
;
371 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
373 if (qdev_class_has_alias(dc
) &&
374 strcmp(qdev_class_get_alias(dc
), elem
) == 0) {
381 static inline bool qbus_is_full(BusState
*bus
)
383 BusClass
*bus_class
= BUS_GET_CLASS(bus
);
384 return bus_class
->max_dev
&& bus
->max_index
>= bus_class
->max_dev
;
388 * Search the tree rooted at @bus for a bus.
389 * If @name, search for a bus with that name. Note that bus names
390 * need not be unique. Yes, that's screwed up.
391 * Else search for a bus that is a subtype of @bus_typename.
392 * If more than one exists, prefer one that can take another device.
393 * Return the bus if found, else %NULL.
395 static BusState
*qbus_find_recursive(BusState
*bus
, const char *name
,
396 const char *bus_typename
)
399 BusState
*pick
, *child
, *ret
;
402 assert(name
|| bus_typename
);
404 match
= !strcmp(bus
->name
, name
);
406 match
= !!object_dynamic_cast(OBJECT(bus
), bus_typename
);
409 if (match
&& !qbus_is_full(bus
)) {
410 return bus
; /* root matches and isn't full */
413 pick
= match
? bus
: NULL
;
415 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
416 DeviceState
*dev
= kid
->child
;
417 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
418 ret
= qbus_find_recursive(child
, name
, bus_typename
);
419 if (ret
&& !qbus_is_full(ret
)) {
420 return ret
; /* a descendant matches and isn't full */
428 /* root or a descendant matches, but is full */
432 static BusState
*qbus_find(const char *path
, Error
**errp
)
439 /* find start element */
440 if (path
[0] == '/') {
441 bus
= sysbus_get_default();
444 if (sscanf(path
, "%127[^/]%n", elem
, &len
) != 1) {
448 bus
= qbus_find_recursive(sysbus_get_default(), elem
, NULL
);
450 error_setg(errp
, "Bus '%s' not found", elem
);
457 assert(path
[pos
] == '/' || !path
[pos
]);
458 while (path
[pos
] == '/') {
461 if (path
[pos
] == '\0') {
466 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
467 g_assert_not_reached();
471 dev
= qbus_find_dev(bus
, elem
);
473 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
474 "Device '%s' not found", elem
);
475 qbus_list_dev(bus
, errp
);
479 assert(path
[pos
] == '/' || !path
[pos
]);
480 while (path
[pos
] == '/') {
483 if (path
[pos
] == '\0') {
484 /* last specified element is a device. If it has exactly
485 * one child bus accept it nevertheless */
486 if (dev
->num_child_bus
== 1) {
487 bus
= QLIST_FIRST(&dev
->child_bus
);
490 if (dev
->num_child_bus
) {
491 error_setg(errp
, "Device '%s' has multiple child buses",
493 qbus_list_bus(dev
, errp
);
495 error_setg(errp
, "Device '%s' has no child bus", elem
);
501 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
502 g_assert_not_reached();
506 bus
= qbus_find_bus(dev
, elem
);
508 error_setg(errp
, "Bus '%s' not found", elem
);
509 qbus_list_bus(dev
, errp
);
514 if (qbus_is_full(bus
)) {
515 error_setg(errp
, "Bus '%s' is full", path
);
521 DeviceState
*qdev_device_add(QemuOpts
*opts
, Error
**errp
)
524 const char *driver
, *path
, *id
;
526 BusState
*bus
= NULL
;
529 driver
= qemu_opt_get(opts
, "driver");
531 error_setg(errp
, QERR_MISSING_PARAMETER
, "driver");
536 dc
= qdev_get_device_class(&driver
, errp
);
542 path
= qemu_opt_get(opts
, "bus");
544 bus
= qbus_find(path
, errp
);
548 if (!object_dynamic_cast(OBJECT(bus
), dc
->bus_type
)) {
549 error_setg(errp
, "Device '%s' can't go on %s bus",
550 driver
, object_get_typename(OBJECT(bus
)));
553 } else if (dc
->bus_type
!= NULL
) {
554 bus
= qbus_find_recursive(sysbus_get_default(), NULL
, dc
->bus_type
);
555 if (!bus
|| qbus_is_full(bus
)) {
556 error_setg(errp
, "No '%s' bus found for device '%s'",
557 dc
->bus_type
, driver
);
561 if (qdev_hotplug
&& bus
&& !qbus_is_hotpluggable(bus
)) {
562 error_setg(errp
, QERR_BUS_NO_HOTPLUG
, bus
->name
);
567 dev
= DEVICE(object_new(driver
));
570 qdev_set_parent_bus(dev
, bus
);
573 id
= qemu_opts_id(opts
);
579 object_property_add_child(qdev_get_peripheral(), dev
->id
,
582 static int anon_count
;
583 gchar
*name
= g_strdup_printf("device[%d]", anon_count
++);
584 object_property_add_child(qdev_get_peripheral_anon(), name
,
590 if (qemu_opt_foreach(opts
, set_property
, dev
, &err
)) {
591 error_propagate(errp
, err
);
592 object_unparent(OBJECT(dev
));
593 object_unref(OBJECT(dev
));
598 object_property_set_bool(OBJECT(dev
), true, "realized", &err
);
600 error_propagate(errp
, err
);
602 object_unparent(OBJECT(dev
));
603 object_unref(OBJECT(dev
));
610 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
611 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
);
613 static void qdev_print_props(Monitor
*mon
, DeviceState
*dev
, Property
*props
,
618 for (; props
->name
; props
++) {
621 char *legacy_name
= g_strdup_printf("legacy-%s", props
->name
);
622 if (object_property_get_type(OBJECT(dev
), legacy_name
, NULL
)) {
623 value
= object_property_get_str(OBJECT(dev
), legacy_name
, &err
);
625 value
= object_property_print(OBJECT(dev
), props
->name
, true, &err
);
633 qdev_printf("%s = %s\n", props
->name
,
634 value
&& *value
? value
: "<null>");
639 static void bus_print_dev(BusState
*bus
, Monitor
*mon
, DeviceState
*dev
, int indent
)
641 BusClass
*bc
= BUS_GET_CLASS(bus
);
644 bc
->print_dev(mon
, dev
, indent
);
648 static void qdev_print(Monitor
*mon
, DeviceState
*dev
, int indent
)
654 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev
)),
655 dev
->id
? dev
->id
: "");
657 QLIST_FOREACH(ngl
, &dev
->gpios
, node
) {
659 qdev_printf("gpio-in \"%s\" %d\n", ngl
->name
? ngl
->name
: "",
663 qdev_printf("gpio-out \"%s\" %d\n", ngl
->name
? ngl
->name
: "",
667 class = object_get_class(OBJECT(dev
));
669 qdev_print_props(mon
, dev
, DEVICE_CLASS(class)->props
, indent
);
670 class = object_class_get_parent(class);
671 } while (class != object_class_by_name(TYPE_DEVICE
));
672 bus_print_dev(dev
->parent_bus
, mon
, dev
, indent
);
673 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
674 qbus_print(mon
, child
, indent
);
678 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
)
682 qdev_printf("bus: %s\n", bus
->name
);
684 qdev_printf("type %s\n", object_get_typename(OBJECT(bus
)));
685 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
686 DeviceState
*dev
= kid
->child
;
687 qdev_print(mon
, dev
, indent
);
692 void hmp_info_qtree(Monitor
*mon
, const QDict
*qdict
)
694 if (sysbus_get_default())
695 qbus_print(mon
, sysbus_get_default(), 0);
698 void hmp_info_qdm(Monitor
*mon
, const QDict
*qdict
)
700 qdev_print_devinfos(true);
703 typedef struct QOMCompositionState
{
706 } QOMCompositionState
;
708 static void print_qom_composition(Monitor
*mon
, Object
*obj
, int indent
);
710 static int print_qom_composition_child(Object
*obj
, void *opaque
)
712 QOMCompositionState
*s
= opaque
;
714 print_qom_composition(s
->mon
, obj
, s
->indent
);
719 static void print_qom_composition(Monitor
*mon
, Object
*obj
, int indent
)
721 QOMCompositionState s
= {
723 .indent
= indent
+ 2,
727 if (obj
== object_get_root()) {
730 name
= object_get_canonical_path_component(obj
);
732 monitor_printf(mon
, "%*s/%s (%s)\n", indent
, "", name
,
733 object_get_typename(obj
));
735 object_child_foreach(obj
, print_qom_composition_child
, &s
);
738 void hmp_info_qom_tree(Monitor
*mon
, const QDict
*dict
)
740 const char *path
= qdict_get_try_str(dict
, "path");
742 bool ambiguous
= false;
745 obj
= object_resolve_path(path
, &ambiguous
);
747 monitor_printf(mon
, "Path '%s' could not be resolved.\n", path
);
751 monitor_printf(mon
, "Warning: Path '%s' is ambiguous.\n", path
);
755 obj
= qdev_get_machine();
757 print_qom_composition(mon
, obj
, 0);
760 void qmp_device_add(QDict
*qdict
, QObject
**ret_data
, Error
**errp
)
762 Error
*local_err
= NULL
;
766 opts
= qemu_opts_from_qdict(qemu_find_opts("device"), qdict
, &local_err
);
768 error_propagate(errp
, local_err
);
771 if (!monitor_cur_is_qmp() && qdev_device_help(opts
)) {
775 dev
= qdev_device_add(opts
, &local_err
);
777 error_propagate(errp
, local_err
);
781 object_unref(OBJECT(dev
));
784 void qmp_device_del(const char *id
, Error
**errp
)
789 obj
= object_resolve_path(id
, NULL
);
791 char *root_path
= object_get_canonical_path(qdev_get_peripheral());
792 char *path
= g_strdup_printf("%s/%s", root_path
, id
);
795 obj
= object_resolve_path_type(path
, TYPE_DEVICE
, NULL
);
800 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
801 "Device '%s' not found", id
);
805 if (!object_dynamic_cast(obj
, TYPE_DEVICE
)) {
806 error_setg(errp
, "%s is not a hotpluggable device", id
);
810 qdev_unplug(DEVICE(obj
), errp
);
813 void qdev_machine_init(void)
815 qdev_get_peripheral_anon();
816 qdev_get_peripheral();
819 QemuOptsList qemu_device_opts
= {
821 .implied_opt_name
= "driver",
822 .head
= QTAILQ_HEAD_INITIALIZER(qemu_device_opts
.head
),
825 * no elements => accept any
826 * sanity checking will happen later
827 * when setting device properties
829 { /* end of list */ }
833 QemuOptsList qemu_global_opts
= {
835 .head
= QTAILQ_HEAD_INITIALIZER(qemu_global_opts
.head
),
839 .type
= QEMU_OPT_STRING
,
842 .type
= QEMU_OPT_STRING
,
845 .type
= QEMU_OPT_STRING
,
847 { /* end of list */ }
851 int qemu_global_option(const char *str
)
853 char driver
[64], property
[64];
857 rc
= sscanf(str
, "%63[^.=].%63[^=]%n", driver
, property
, &offset
);
858 if (rc
== 2 && str
[offset
] == '=') {
859 opts
= qemu_opts_create(&qemu_global_opts
, NULL
, 0, &error_abort
);
860 qemu_opt_set(opts
, "driver", driver
, &error_abort
);
861 qemu_opt_set(opts
, "property", property
, &error_abort
);
862 qemu_opt_set(opts
, "value", str
+ offset
+ 1, &error_abort
);
866 opts
= qemu_opts_parse_noisily(&qemu_global_opts
, str
, false);