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(void *opaque
, const char *name
, const char *value
,
149 Object
*obj
= opaque
;
152 if (strcmp(name
, "driver") == 0)
154 if (strcmp(name
, "bus") == 0)
157 object_property_parse(obj
, value
, name
, &err
);
159 qerror_report_err(err
);
166 static const char *find_typename_by_alias(const char *alias
)
170 for (i
= 0; qdev_alias_table
[i
].alias
; i
++) {
171 if (qdev_alias_table
[i
].arch_mask
&&
172 !(qdev_alias_table
[i
].arch_mask
& arch_type
)) {
176 if (strcmp(qdev_alias_table
[i
].alias
, alias
) == 0) {
177 return qdev_alias_table
[i
].typename
;
184 static DeviceClass
*qdev_get_device_class(const char **driver
, Error
**errp
)
189 oc
= object_class_by_name(*driver
);
191 const char *typename
= find_typename_by_alias(*driver
);
195 oc
= object_class_by_name(*driver
);
199 if (!object_class_dynamic_cast(oc
, TYPE_DEVICE
)) {
200 error_setg(errp
, "'%s' is not a valid device model name", *driver
);
204 if (object_class_is_abstract(oc
)) {
205 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
206 "non-abstract device type");
210 dc
= DEVICE_CLASS(oc
);
211 if (dc
->cannot_instantiate_with_device_add_yet
||
212 (qdev_hotplug
&& !dc
->hotpluggable
)) {
213 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
214 "pluggable device type");
222 int qdev_device_help(QemuOpts
*opts
)
224 Error
*local_err
= NULL
;
226 DevicePropertyInfoList
*prop_list
;
227 DevicePropertyInfoList
*prop
;
229 driver
= qemu_opt_get(opts
, "driver");
230 if (driver
&& is_help_option(driver
)) {
231 qdev_print_devinfos(false);
235 if (!driver
|| !qemu_opt_has_help_opt(opts
)) {
239 qdev_get_device_class(&driver
, &local_err
);
244 prop_list
= qmp_device_list_properties(driver
, &local_err
);
249 for (prop
= prop_list
; prop
; prop
= prop
->next
) {
250 error_printf("%s.%s=%s", driver
,
253 if (prop
->value
->has_description
) {
254 error_printf(" (%s)\n", prop
->value
->description
);
260 qapi_free_DevicePropertyInfoList(prop_list
);
264 error_printf("%s\n", error_get_pretty(local_err
));
265 error_free(local_err
);
269 static Object
*qdev_get_peripheral(void)
274 dev
= container_get(qdev_get_machine(), "/peripheral");
280 static Object
*qdev_get_peripheral_anon(void)
285 dev
= container_get(qdev_get_machine(), "/peripheral-anon");
291 static void qbus_list_bus(DeviceState
*dev
)
294 const char *sep
= " ";
296 error_printf("child busses at \"%s\":",
297 dev
->id
? dev
->id
: object_get_typename(OBJECT(dev
)));
298 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
299 error_printf("%s\"%s\"", sep
, child
->name
);
305 static void qbus_list_dev(BusState
*bus
)
308 const char *sep
= " ";
310 error_printf("devices at \"%s\":", bus
->name
);
311 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
312 DeviceState
*dev
= kid
->child
;
313 error_printf("%s\"%s\"", sep
, object_get_typename(OBJECT(dev
)));
315 error_printf("/\"%s\"", dev
->id
);
321 static BusState
*qbus_find_bus(DeviceState
*dev
, char *elem
)
325 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
326 if (strcmp(child
->name
, elem
) == 0) {
333 static DeviceState
*qbus_find_dev(BusState
*bus
, char *elem
)
338 * try to match in order:
339 * (1) instance id, if present
341 * (3) driver alias, if present
343 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
344 DeviceState
*dev
= kid
->child
;
345 if (dev
->id
&& strcmp(dev
->id
, elem
) == 0) {
349 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
350 DeviceState
*dev
= kid
->child
;
351 if (strcmp(object_get_typename(OBJECT(dev
)), elem
) == 0) {
355 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
356 DeviceState
*dev
= kid
->child
;
357 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
359 if (qdev_class_has_alias(dc
) &&
360 strcmp(qdev_class_get_alias(dc
), elem
) == 0) {
367 static BusState
*qbus_find_recursive(BusState
*bus
, const char *name
,
368 const char *bus_typename
)
370 BusClass
*bus_class
= BUS_GET_CLASS(bus
);
372 BusState
*child
, *ret
;
375 if (name
&& (strcmp(bus
->name
, name
) != 0)) {
377 } else if (bus_typename
&& !object_dynamic_cast(OBJECT(bus
), bus_typename
)) {
379 } else if ((bus_class
->max_dev
!= 0) && (bus_class
->max_dev
<= bus
->max_index
)) {
381 /* bus was explicitly specified: return an error. */
382 qerror_report(ERROR_CLASS_GENERIC_ERROR
, "Bus '%s' is full",
386 /* bus was not specified: try to find another one. */
394 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
395 DeviceState
*dev
= kid
->child
;
396 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
397 ret
= qbus_find_recursive(child
, name
, bus_typename
);
406 static BusState
*qbus_find(const char *path
)
413 /* find start element */
414 if (path
[0] == '/') {
415 bus
= sysbus_get_default();
418 if (sscanf(path
, "%127[^/]%n", elem
, &len
) != 1) {
422 bus
= qbus_find_recursive(sysbus_get_default(), elem
, NULL
);
424 qerror_report(QERR_BUS_NOT_FOUND
, elem
);
431 assert(path
[pos
] == '/' || !path
[pos
]);
432 while (path
[pos
] == '/') {
435 if (path
[pos
] == '\0') {
440 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
441 g_assert_not_reached();
445 dev
= qbus_find_dev(bus
, elem
);
447 qerror_report(QERR_DEVICE_NOT_FOUND
, elem
);
448 if (!monitor_cur_is_qmp()) {
454 assert(path
[pos
] == '/' || !path
[pos
]);
455 while (path
[pos
] == '/') {
458 if (path
[pos
] == '\0') {
459 /* last specified element is a device. If it has exactly
460 * one child bus accept it nevertheless */
461 switch (dev
->num_child_bus
) {
463 qerror_report(ERROR_CLASS_GENERIC_ERROR
,
464 "Device '%s' has no child bus", elem
);
467 return QLIST_FIRST(&dev
->child_bus
);
469 qerror_report(ERROR_CLASS_GENERIC_ERROR
,
470 "Device '%s' has multiple child busses", elem
);
471 if (!monitor_cur_is_qmp()) {
479 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
480 g_assert_not_reached();
484 bus
= qbus_find_bus(dev
, elem
);
486 qerror_report(QERR_BUS_NOT_FOUND
, elem
);
487 if (!monitor_cur_is_qmp()) {
495 DeviceState
*qdev_device_add(QemuOpts
*opts
)
498 const char *driver
, *path
, *id
;
500 BusState
*bus
= NULL
;
503 driver
= qemu_opt_get(opts
, "driver");
505 qerror_report(QERR_MISSING_PARAMETER
, "driver");
510 dc
= qdev_get_device_class(&driver
, &err
);
512 qerror_report_err(err
);
518 path
= qemu_opt_get(opts
, "bus");
520 bus
= qbus_find(path
);
524 if (!object_dynamic_cast(OBJECT(bus
), dc
->bus_type
)) {
525 qerror_report(ERROR_CLASS_GENERIC_ERROR
,
526 "Device '%s' can't go on a %s bus",
527 driver
, object_get_typename(OBJECT(bus
)));
530 } else if (dc
->bus_type
!= NULL
) {
531 bus
= qbus_find_recursive(sysbus_get_default(), NULL
, dc
->bus_type
);
533 qerror_report(ERROR_CLASS_GENERIC_ERROR
,
534 "No '%s' bus found for device '%s'",
535 dc
->bus_type
, driver
);
539 if (qdev_hotplug
&& bus
&& !qbus_is_hotpluggable(bus
)) {
540 qerror_report(QERR_BUS_NO_HOTPLUG
, bus
->name
);
545 dev
= DEVICE(object_new(driver
));
548 qdev_set_parent_bus(dev
, bus
);
551 id
= qemu_opts_id(opts
);
557 object_property_add_child(qdev_get_peripheral(), dev
->id
,
560 static int anon_count
;
561 gchar
*name
= g_strdup_printf("device[%d]", anon_count
++);
562 object_property_add_child(qdev_get_peripheral_anon(), name
,
568 if (qemu_opt_foreach(opts
, set_property
, dev
, NULL
)) {
569 object_unparent(OBJECT(dev
));
570 object_unref(OBJECT(dev
));
575 object_property_set_bool(OBJECT(dev
), true, "realized", &err
);
577 qerror_report_err(err
);
580 object_unparent(OBJECT(dev
));
581 object_unref(OBJECT(dev
));
582 qerror_report(QERR_DEVICE_INIT_FAILED
, driver
);
589 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
590 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
);
592 static void qdev_print_props(Monitor
*mon
, DeviceState
*dev
, Property
*props
,
597 for (; props
->name
; props
++) {
600 char *legacy_name
= g_strdup_printf("legacy-%s", props
->name
);
601 if (object_property_get_type(OBJECT(dev
), legacy_name
, NULL
)) {
602 value
= object_property_get_str(OBJECT(dev
), legacy_name
, &err
);
604 value
= object_property_print(OBJECT(dev
), props
->name
, true, &err
);
612 qdev_printf("%s = %s\n", props
->name
,
613 value
&& *value
? value
: "<null>");
618 static void bus_print_dev(BusState
*bus
, Monitor
*mon
, DeviceState
*dev
, int indent
)
620 BusClass
*bc
= BUS_GET_CLASS(bus
);
623 bc
->print_dev(mon
, dev
, indent
);
627 static void qdev_print(Monitor
*mon
, DeviceState
*dev
, int indent
)
633 qdev_printf("dev: %s, id \"%s\"\n", object_get_typename(OBJECT(dev
)),
634 dev
->id
? dev
->id
: "");
636 QLIST_FOREACH(ngl
, &dev
->gpios
, node
) {
638 qdev_printf("gpio-in \"%s\" %d\n", ngl
->name
? ngl
->name
: "",
642 qdev_printf("gpio-out \"%s\" %d\n", ngl
->name
? ngl
->name
: "",
646 class = object_get_class(OBJECT(dev
));
648 qdev_print_props(mon
, dev
, DEVICE_CLASS(class)->props
, indent
);
649 class = object_class_get_parent(class);
650 } while (class != object_class_by_name(TYPE_DEVICE
));
651 bus_print_dev(dev
->parent_bus
, mon
, dev
, indent
);
652 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
653 qbus_print(mon
, child
, indent
);
657 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
)
661 qdev_printf("bus: %s\n", bus
->name
);
663 qdev_printf("type %s\n", object_get_typename(OBJECT(bus
)));
664 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
665 DeviceState
*dev
= kid
->child
;
666 qdev_print(mon
, dev
, indent
);
671 void hmp_info_qtree(Monitor
*mon
, const QDict
*qdict
)
673 if (sysbus_get_default())
674 qbus_print(mon
, sysbus_get_default(), 0);
677 void hmp_info_qdm(Monitor
*mon
, const QDict
*qdict
)
679 qdev_print_devinfos(true);
682 typedef struct QOMCompositionState
{
685 } QOMCompositionState
;
687 static void print_qom_composition(Monitor
*mon
, Object
*obj
, int indent
);
689 static int print_qom_composition_child(Object
*obj
, void *opaque
)
691 QOMCompositionState
*s
= opaque
;
693 print_qom_composition(s
->mon
, obj
, s
->indent
);
698 static void print_qom_composition(Monitor
*mon
, Object
*obj
, int indent
)
700 QOMCompositionState s
= {
702 .indent
= indent
+ 2,
706 if (obj
== object_get_root()) {
709 name
= object_get_canonical_path_component(obj
);
711 monitor_printf(mon
, "%*s/%s (%s)\n", indent
, "", name
,
712 object_get_typename(obj
));
714 object_child_foreach(obj
, print_qom_composition_child
, &s
);
717 void hmp_info_qom_tree(Monitor
*mon
, const QDict
*dict
)
719 const char *path
= qdict_get_try_str(dict
, "path");
721 bool ambiguous
= false;
724 obj
= object_resolve_path(path
, &ambiguous
);
726 monitor_printf(mon
, "Path '%s' could not be resolved.\n", path
);
730 monitor_printf(mon
, "Warning: Path '%s' is ambiguous.\n", path
);
734 obj
= qdev_get_machine();
736 print_qom_composition(mon
, obj
, 0);
739 int do_device_add(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
741 Error
*local_err
= NULL
;
745 opts
= qemu_opts_from_qdict(qemu_find_opts("device"), qdict
, &local_err
);
747 qerror_report_err(local_err
);
748 error_free(local_err
);
751 if (!monitor_cur_is_qmp() && qdev_device_help(opts
)) {
755 dev
= qdev_device_add(opts
);
760 object_unref(OBJECT(dev
));
764 void qmp_device_del(const char *id
, Error
**errp
)
767 char *root_path
= object_get_canonical_path(qdev_get_peripheral());
768 char *path
= g_strdup_printf("%s/%s", root_path
, id
);
771 obj
= object_resolve_path_type(path
, TYPE_DEVICE
, NULL
);
775 error_set(errp
, QERR_DEVICE_NOT_FOUND
, id
);
779 qdev_unplug(DEVICE(obj
), errp
);
782 void qdev_machine_init(void)
784 qdev_get_peripheral_anon();
785 qdev_get_peripheral();
788 QemuOptsList qemu_device_opts
= {
790 .implied_opt_name
= "driver",
791 .head
= QTAILQ_HEAD_INITIALIZER(qemu_device_opts
.head
),
794 * no elements => accept any
795 * sanity checking will happen later
796 * when setting device properties
798 { /* end of list */ }
802 QemuOptsList qemu_global_opts
= {
804 .head
= QTAILQ_HEAD_INITIALIZER(qemu_global_opts
.head
),
808 .type
= QEMU_OPT_STRING
,
811 .type
= QEMU_OPT_STRING
,
814 .type
= QEMU_OPT_STRING
,
816 { /* end of list */ }
820 int qemu_global_option(const char *str
)
822 char driver
[64], property
[64];
826 rc
= sscanf(str
, "%63[^.=].%63[^=]%n", driver
, property
, &offset
);
827 if (rc
== 2 && str
[offset
] == '=') {
828 opts
= qemu_opts_create(&qemu_global_opts
, NULL
, 0, &error_abort
);
829 qemu_opt_set(opts
, "driver", driver
, &error_abort
);
830 qemu_opt_set(opts
, "property", property
, &error_abort
);
831 qemu_opt_set(opts
, "value", str
+ offset
+ 1, &error_abort
);
835 opts
= qemu_opts_parse(&qemu_global_opts
, str
, false);