mirror of
https://github.com/mii443/qemu.git
synced 2025-08-22 15:15:46 +00:00
4a1d937796
qdev_set_id() is mostly used when the user adds a device (using -device cli option or device_add qmp command). This commit adds an error parameter to handle the case where the given id is already taken. Also document the function and add a return value in order to be able to capture success/failure: the function now returns the id in case of success, or NULL in case of failure. The commit modifies the 2 calling places (qdev-monitor and xen-legacy-backend) to add the error object parameter. Note that the id is, right now, guaranteed to be unique because all ids came from the "device" QemuOptsList where the id is used as key. This addition is a preparation for a future commit which will relax the uniqueness. Signed-off-by: Damien Hedde <damien.hedde@greensocs.com> Signed-off-by: Kevin Wolf <kwolf@redhat.com> Message-Id: <20211008133442.141332-10-kwolf@redhat.com> Reviewed-by: Michael S. Tsirkin <mst@redhat.com> Tested-by: Peter Krempa <pkrempa@redhat.com> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
38 lines
1.2 KiB
C
38 lines
1.2 KiB
C
#ifndef MONITOR_QDEV_H
|
|
#define MONITOR_QDEV_H
|
|
|
|
/*** monitor commands ***/
|
|
|
|
void hmp_info_qtree(Monitor *mon, const QDict *qdict);
|
|
void hmp_info_qdm(Monitor *mon, const QDict *qdict);
|
|
void qmp_device_add(QDict *qdict, QObject **ret_data, Error **errp);
|
|
|
|
int qdev_device_help(QemuOpts *opts);
|
|
DeviceState *qdev_device_add(QemuOpts *opts, Error **errp);
|
|
|
|
/**
|
|
* qdev_set_id: parent the device and set its id if provided.
|
|
* @dev: device to handle
|
|
* @id: id to be given to the device, or NULL.
|
|
*
|
|
* Returns: the id of the device in case of success; otherwise NULL.
|
|
*
|
|
* @dev must be unrealized, unparented and must not have an id.
|
|
*
|
|
* If @id is non-NULL, this function tries to setup @dev qom path as
|
|
* "/peripheral/id". If @id is already taken, it fails. If it succeeds,
|
|
* the id field of @dev is set to @id (@dev now owns the given @id
|
|
* parameter).
|
|
*
|
|
* If @id is NULL, this function generates a unique name and setups @dev
|
|
* qom path as "/peripheral-anon/name". This name is not set as the id
|
|
* of @dev.
|
|
*
|
|
* Upon success, it returns the id/name (generated or provided). The
|
|
* returned string is owned by the corresponding child property and must
|
|
* not be freed by the caller.
|
|
*/
|
|
const char *qdev_set_id(DeviceState *dev, char *id, Error **errp);
|
|
|
|
#endif
|