monitor: allow object_del & device_del to accept QOM paths
PATCH v3 1/1 monitor: allow object_del & device_del to accept QOM paths
Currently both object_del and device_del require that the client provide the object/device short ID. While user creatable objects require an ID to be provided at time of creation, qdev devices may be created without giving an ID. The only unique identifier they would then have is the QOM object path.
Allowing device_del to accept an object path ensures all devices are deletable regardless of whether they have an ID.
(qemu) device_add usb-mouse
(qemu) qom-list /machine/peripheral-anon device[0] (child<usb-mouse>)
type (string)
(qemu) device_del /machine/peripheral-anon/device[0]
Although objects require an ID to be provided upfront, there may be cases where the client would prefer to use QOM paths when deleting.
Devices are required to be marked as hotpluggable otherwise an error is raised
(qemu) device_del /machine/unattached/device[4] Device 'PIIX3' does not support hotplugging
Similarly objects are required to implement the user-creatable interface
(qemu) object_del /machine/unattached/device[4] /machine/unattached/device[4] is not a user-creatable object
---
Changed in v3:
- Add type checks to avoid assertion failures if user supplied path is not of type device or user-creatable
hmp-commands.hx | 6 ++++-- qapi-schema.json | 4 ++-- qdev-monitor.c | 19 ++++++++++++++----- qmp-commands.hx | 13 +++++++++++-- qmp.c | 15 ++++++++++++--- 5 files changed, 43 insertions(+), 14 deletions(-)
hmp-commands.hx +4 -2
@@ -675,7 +675,8 @@ ETEXI STEXI @item device_del @var{id} @findex device_del -Remove device @var{id}. +Remove device @var{id}. @var{id} may be a short ID +or a QOM object path. ETEXI {
@@ -1279,7 +1280,8 @@ ETEXI STEXI @item object_del @findex object_del -Destroy QOM object. +Destroy QOM object. @var{id} may be a short ID +or a QOM object path. ETEXI #ifdef CONFIG_SLIRP
qapi-schema.json +2 -2
@@ -1950,7 +1950,7 @@ # # Remove a device from a guest # -# @id: the name of the device +# @id: the name or QOM path of the device # # Returns: Nothing on success # If @id is not a valid device, DeviceNotFound
@@ -2121,7 +2121,7 @@ # # Remove a QOM object. # -# @id: the name of the QOM object to remove +# @id: the name or path of the QOM object to remove # # Returns: Nothing on success # Error if @id is not a valid id for a QOM object
qdev-monitor.c +14 -5
@@ -785,19 +785,28 @@ void qmp_device_add(QDict *qdict, QObject **ret_data, Error **errp)void qmp_device_del (const char *id,Error **errp) {Object *obj; -char *root_path =object_get_canonical_path (qdev_get_peripheral ()); -char *path =g_strdup_printf ("%s/%s" , root_path, id); -g_free (root_path); - obj =object_resolve_path_type (path,TYPE_DEVICE ,NULL ); -g_free (path); +if (id[0 ] =='/' ) { + obj =object_resolve_path (id,NULL ); + }else { +char *root_path =object_get_canonical_path (qdev_get_peripheral ()); +char *path =g_strdup_printf ("%s/%s" , root_path, id); +g_free (root_path); + obj =object_resolve_path_type (path,TYPE_DEVICE ,NULL ); +g_free (path); + }if (!obj) {error_set (errp,ERROR_CLASS_DEVICE_NOT_FOUND ,"Device '%s' not found" , id);return ; } +if (!object_dynamic_cast (obj,TYPE_DEVICE )) { +error_setg (errp,"%s is not a hotpluggable device" , id); +return ; + } +qdev_unplug (DEVICE (obj), errp); }
qmp-commands.hx +11 -2
@@ -321,13 +321,18 @@ Remove a device. Arguments: -- "id": the device's ID (json-string) +- "id": the device's ID or QOM path (json-string) Example: -> { "execute": "device_del", "arguments": { "id": "net1" } } <- { "return": {} } +Example: + +-> { "execute": "device_del", "arguments": { "id": "/machine/peripheral-anon/device[0]" } } +<- { "return": {} } + EQMP {
@@ -965,7 +970,7 @@ Remove QOM object. Arguments: -- "id": the object's ID (json-string) +- "id": the object's ID or QOM path (json-string) Example:
@@ -973,6 +978,10 @@ Example: <- { "return": {} } +-> { "execute": "object-del", "arguments": { "id": "/objects/hostmem1" } } +<- { "return": {} } + + EQMP
qmp.c +12 -3
@@ -678,16 +678,25 @@ void qmp_object_add(QDict *qdict, QObject **ret, Error **errp)void qmp_object_del (const char *id,Error **errp) { -Object *container;Object *obj; - container =object_get_objects_root (); - obj =object_resolve_path_component (container, id); +if (id[0 ] =='/' ) { + obj =object_resolve_path (id,NULL ); + }else { +Object *container; + container =object_get_objects_root (); + obj =object_resolve_path_component (container, id); + }if (!obj) {error_setg (errp,"object id not found" );return ; } +if (!object_dynamic_cast (obj,TYPE_USER_CREATABLE )) { +error_setg (errp,"%s is not a user-creatable object" , id); +return ; + } +if (!user_creatable_can_be_deleted (USER_CREATABLE (obj), errp)) {error_setg (errp,"%s is in use, can not be deleted" , id);return ;
Signature · 1 line
2.4.3
Quoted 41 lines · Daniel P. Berrange
Currently both
object_delanddevice_delrequire that the client provide the object/device short ID. While user creatable objects require an ID to be provided at time of creation, qdev devices may be created without giving an ID. The only unique identifier they would then have is the QOM object path.Allowing
device_delto accept an object path ensures all devices are deletable regardless of whether they have an ID.(qemu)
device_addusb-mouse
(qemu) qom-list /machine/peripheral-anon device[0] (child<usb-mouse>)
type (string)
(qemu)device_del/machine/peripheral-anon/device[0]Although objects require an ID to be provided upfront, there may be cases where the client would prefer to use QOM paths when deleting.
Devices are required to be marked as hotpluggable otherwise an error is raised
(qemu)
device_del/machine/unattached/device[4] Device 'PIIX3' does not support hotpluggingSimilarly objects are required to implement the user-creatable interface
(qemu)
object_del/machine/unattached/device[4] /machine/unattached/device[4] is not a user-creatable objectSigned-off-by Daniel P. Berrange <[email protected]>---
Changed in v3:
- Add type checks to avoid assertion failures if user supplied path is not of type device or user-creatable
Quoted 6 lines
hmp-commands.hx | 6 ++++-- qapi-schema.json | 4 ++-- qdev-monitor.c | 19 ++++++++++++++----- qmp-commands.hx | 13 +++++++++++-- qmp.c | 15 ++++++++++++--- 5 files changed, 43 insertions(+), 14 deletions(-)
Am 01.09.2015 um 11:50 schrieb Daniel P. Berrange:
Quoted 53 lines
Currently both
object_delanddevice_delrequire that the client provide the object/device short ID. While user creatable objects require an ID to be provided at time of creation, qdev devices may be created without giving an ID. The only unique identifier they would then have is the QOM object path.Allowing
device_delto accept an object path ensures all devices are deletable regardless of whether they have an ID.(qemu)
device_addusb-mouse
(qemu) qom-list /machine/peripheral-anon device[0] (child<usb-mouse>)
type (string)
(qemu)device_del/machine/peripheral-anon/device[0]Although objects require an ID to be provided upfront, there may be cases where the client would prefer to use QOM paths when deleting.
Devices are required to be marked as hotpluggable otherwise an error is raised
(qemu)
device_del/machine/unattached/device[4] Device 'PIIX3' does not support hotpluggingSimilarly objects are required to implement the user-creatable interface
(qemu)
object_del/machine/unattached/device[4] /machine/unattached/device[4] is not a user-creatable objectSigned-off-by Daniel P. Berrange <[email protected]>---
Changed in v3:
- Add type checks to avoid assertion failures if user supplied path is not of type device or user-creatable
hmp-commands.hx | 6 ++++-- qapi-schema.json | 4 ++-- qdev-monitor.c | 19 ++++++++++++++----- qmp-commands.hx | 13 +++++++++++-- qmp.c | 15 ++++++++++++--- 5 files changed, 43 insertions(+), 14 deletions(-)hmp-commands.hx +0
-0
hmp-commands.hx ETEXI · line 679
Quoted 6 lines
hmp-commands.hx +2
-1@@ -675,7 +675,8 @@ ETEXI STEXI @item device_del @var{id} @findex device_del -Remove device @var{id}. +Remove device @var{id}. @var{id} may be a short ID +or a QOM object path.
Have you considered using two alternative parameters, id and qom-path? (qom_path was used elsewhere)
Regards,
Andreas
Quoted 13 lines
hmp-commands.hx +2
-1ETEXI {@@ -1279,7 +1280,8 @@ ETEXI STEXI @item object_del @findex object_del -Destroy QOM object. +Destroy QOM object. @var{id} may be a short ID +or a QOM object path. ETEXI #ifdef CONFIG_SLIRP
[snip]
Signature · 2 lines
SUSE Linux GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Felix Imendörffer, Jane Smithard, Graham Norton; HRB 21284 (AG Nürnberg)
Quoted 49 lines · Andreas Färber
Am 01.09.2015 um 11:50 schrieb Daniel P. Berrange:
Quoted 48 lines
Currently both
object_delanddevice_delrequire that the client provide the object/device short ID. While user creatable objects require an ID to be provided at time of creation, qdev devices may be created without giving an ID. The only unique identifier they would then have is the QOM object path.Allowing
device_delto accept an object path ensures all devices are deletable regardless of whether they have an ID.(qemu)
device_addusb-mouse
(qemu) qom-list /machine/peripheral-anon device[0] (child<usb-mouse>)
type (string)
(qemu)device_del/machine/peripheral-anon/device[0]Although objects require an ID to be provided upfront, there may be cases where the client would prefer to use QOM paths when deleting.
Devices are required to be marked as hotpluggable otherwise an error is raised
(qemu)
device_del/machine/unattached/device[4] Device 'PIIX3' does not support hotpluggingSimilarly objects are required to implement the user-creatable interface
(qemu)
object_del/machine/unattached/device[4] /machine/unattached/device[4] is not a user-creatable objectSigned-off-by Daniel P. Berrange <[email protected]>---
Changed in v3:
- Add type checks to avoid assertion failures if user supplied path is not of type device or user-creatable
hmp-commands.hx | 6 ++++-- qapi-schema.json | 4 ++-- qdev-monitor.c | 19 ++++++++++++++----- qmp-commands.hx | 13 +++++++++++-- qmp.c | 15 ++++++++++++--- 5 files changed, 43 insertions(+), 14 deletions(-)
Quoted 14 lines
hmp-commands.hx ETEXI · line 679
Quoted 11 lines
hmp-commands.hx +2
-1@@ -675,7 +675,8 @@ ETEXI STEXI @item device_del @var{id} @findex device_del -Remove device @var{id}. +Remove device @var{id}. @var{id} may be a short ID +or a QOM object path.Have you considered using two alternative parameters, id and qom-path? (
qom_pathwas used elsewhere)
I'm not fussed either way, but I thought it simpler to not try to change the accepted parameters of the existing commands. Looking, the only place I notice that uses a 'qom_path' is the return data in the CpuInfo struct.
Does anyone have strong feelings either way about use of id for both vs qom-path or id ?
Regards,
Daniel
Signature · 4 lines
|: http://berrange.com -o- http://www.flickr.com/photos/dberrange/ :| |: http://libvirt.org -o- http://virt-manager.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: http://entangle-photo.org -o- http://live.gnome.org/gtk-vnc :|
Quoted 6 lines · Daniel P. Berrange
Quoted 5 lines
hmp-commands.hx ETEXI · line 679
Quoted 2 lines
hmp-commands.hx +2
-0+Remove device @var{id}. @var{id} may be a short ID +or a QOM object path.Have you considered using two alternative parameters, id and qom-path? (
qom_pathwas used elsewhere)
Quoted 7 lines
I'm not fussed either way, but I thought it simpler to not try to change the accepted parameters of the existing commands. Looking, the only place I notice that uses a '
qom_path' is the return data in the CpuInfo struct.Does anyone have strong feelings either way about use of id for both vs qom-path or id ?
Reusing 'id':
- Pros
- less complicated interface (don't have to check for mutual exclusion)
- Cons
- not introspectible (can't tell by introspection alone whether id can
take a QOM path)
- confusing name (but not the first time we've had that issue)
Adding 'qom-path':
- Pros
- introspectible
- JSON expresses everything (we don't have to parse the first
character of the string to know which style was meant, as the choice of key already decided it)
- Cons
- Have to implement mutual exclusion ourselves (can't take 'id' and
'qom-path' at the same time, and at least one must be specified), unless we invent a new way for qapi to express mutual exclusion (there are other existing commands that would benefit from such an extension)
How likely is libvirt to need to introspect whether this extension is available? We've already argued that libvirt should already be giving everything an id, and therefore, the existing semantics of 'id' are already sufficient for libvirt's needs, and libvirt will never need to delete by qom-path, and thus does not need to introspect whether qom-path even works.
Therefore, I'm leaning towards simplicity rather than introspection; and the patch is fine as-is from my viewpoint.
Signature · 2 lines
Eric Blake eblake redhat com +1-919-301-3266 Libvirt virtualization library http://libvirt.org
Quoted 24 lines · Eric Blake
Quoted 6 lines · Daniel P. Berrange
Quoted 5 lines
hmp-commands.hx ETEXI · line 679
Quoted 2 lines
hmp-commands.hx +2
-0+Remove device @var{id}. @var{id} may be a short ID +or a QOM object path.Have you considered using two alternative parameters, id and qom-path? (
qom_pathwas used elsewhere)Quoted 7 lines
I'm not fussed either way, but I thought it simpler to not try to change the accepted parameters of the existing commands. Looking, the only place I notice that uses a '
qom_path' is the return data in the CpuInfo struct.Does anyone have strong feelings either way about use of id for both vs qom-path or id ?
Reusing 'id':
- Pros
- less complicated interface (don't have to check for mutual exclusion)
- Cons
- not introspectible (can't tell by introspection alone whether id can
take a QOM path)
- confusing name (but not the first time we've had that issue)
Quoted 11 lines
Adding 'qom-path':
- Pros
- introspectible
- JSON expresses everything (we don't have to parse the first
character of the string to know which style was meant, as the choice of key already decided it)
- Cons
- Have to implement mutual exclusion ourselves (can't take 'id' and
'qom-path' at the same time, and at least one must be specified), unless we invent a new way for qapi to express mutual exclusion (there are other existing commands that would benefit from such an extension)
Don't forget having a really long command to type up just to find out what qom path you need.
Also the qom path itself is very long. A simple ID is much easier to type out.
Quoted 15 lines
How likely is libvirt to need to introspect whether this extension is available? We've already argued that libvirt should already be giving everything an id, and therefore, the existing semantics of 'id' are already sufficient for libvirt's needs, and libvirt will never need to delete by qom-path, and thus does not need to introspect whether qom-path even works.
Therefore, I'm leaning towards simplicity rather than introspection; and the patch is fine as-is from my viewpoint.
Signature · 2 lines
Eric Blake eblake redhat com +1-919-301-3266 Libvirt virtualization library http://libvirt.org
Am 01.09.2015 um 17:58 schrieb Programmingkid:
Quoted 36 lines · Eric Blake
Quoted 23 lines · Daniel P. Berrange
Quoted 6 lines
Quoted 5 lines
hmp-commands.hx ETEXI · line 679
Quoted 2 lines
hmp-commands.hx +2
-0+Remove device @var{id}. @var{id} may be a short ID +or a QOM object path.Have you considered using two alternative parameters, id and qom-path? (
qom_pathwas used elsewhere)Quoted 7 lines
I'm not fussed either way, but I thought it simpler to not try to change the accepted parameters of the existing commands. Looking, the only place I notice that uses a '
qom_path' is the return data in the CpuInfo struct.Does anyone have strong feelings either way about use of id for both vs qom-path or id ?
Reusing 'id':
- Pros
- less complicated interface (don't have to check for mutual exclusion)
- Cons
- not introspectible (can't tell by introspection alone whether id can
take a QOM path)
- confusing name (but not the first time we've had that issue)Quoted 11 lines
Adding 'qom-path':
- Pros
- introspectible
- JSON expresses everything (we don't have to parse the first
character of the string to know which style was meant, as the choice of key already decided it)
- Cons
- Have to implement mutual exclusion ourselves (can't take 'id' and
'qom-path' at the same time, and at least one must be specified), unless we invent a new way for qapi to express mutual exclusion (there are other existing commands that would benefit from such an extension)
Quoted 4 lines
Don't forget having a really long command to type up just to find out what qom path you need.
Also the qom path itself is very long. A simple ID is much easier to type out.
That's besides the point: IDs can already be specified without this patch. This patch is shoehorning QOM paths into an existing ID argument.
Regards,
Andreas
Signature · 2 lines
SUSE Linux GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Felix Imendörffer, Jane Smithard, Graham Norton; HRB 21284 (AG Nürnberg)
Quoted 8 lines · Daniel P. Berrange
Currently both
object_delanddevice_delrequire that the client provide the object/device short ID. While user creatable objects require an ID to be provided at time of creation, qdev devices may be created without giving an ID. The only unique identifier they would then have is the QOM object path.
Quoted 8 lines
Signed-off-by Daniel P. Berrange <[email protected]>---
Changed in v3:
- Add type checks to avoid assertion failures if user supplied path is not of type device or user-creatable
Pre-existing, but may want to fix:
qmp.c void qmp_object_add(QDict *qdict, QObject **ret, Error **errp) · line 687
Quoted 12 lines
+++
b/qmp.cqmp.c +5
-0@@ -678,16 +678,25 @@ void qmp_object_add(QDict *qdict, QObject **ret, Error **errp)void qmp_object_del (const char *id,Error **errp) + if (!object_dynamic_cast(obj, TYPE_USER_CREATABLE)) { +error_setg (errp,"%s is not a user-creatable object" , id); +return ; + } +if (!user_creatable_can_be_deleted (USER_CREATABLE (obj), errp)) {error_setg (errp,"%s is in use, can not be deleted" , id);
s/can not/cannot/
Signature · 2 lines
Eric Blake eblake redhat com +1-919-301-3266 Libvirt virtualization library http://libvirt.org
Quoted 5 lines · Daniel P. Berrange
Similarly objects are required to implement the
user-creatable interface(qemu)
object_del/machine/unattached/device[4] /machine/unattached/device[4] is not a user-creatable object
The question is not whether it's user-creatable, but whether it's user-created. It would probably be bad to delete the iothread that x-data-plane=on creates.
IIRC the id is mandatory for all of object_add (HMP), object-add (QMP) and -object, so I would do without the change to object_del.
Paolo