Skip to contentSkip to conversation

block: add 'force' parameter to 'blockdev-change-medium' command

PATCH Superseded Denis V. Lunev 3 participants 3 messages Apr 7, 2022 Block layer

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 block: add 'force' parameter to 'blockdev-change-medium' command

'blockdev-change-medium' is a convinient wrapper for the following sequence of commands:
* blockdev-open-tray
* blockdev-remove-medium
* blockdev-insert-medium
* blockdev-close-tray
and should be used f.e. to change ISO image inside the CD-ROM tray. Though the guest could lock the tray and some linux guests like CentOS 8.5 actually does that. In this case the execution if this command results in the error like the following:
Device 'scsi0-0-1-0' is locked and force was not specified, wait for tray to open and try again.

This situation is could be resolved 'blockdev-open-tray' by passing flag 'force' inside. Thus is seems reasonable to add the same capability for 'blockdev-change-medium' too.

CC Kevin Wolf <[email protected]>
CC Hanna Reitz <[email protected]>
CC "Dr. David Alan Gilbert" <[email protected]>
CC Eric Blake <[email protected]>
CC Markus Armbruster <[email protected]>
---
 block/qapi-sysemu.c | 3 ++-
 monitor/hmp-cmds.c  | 4 +++-
 qapi/block.json     | 6 ++++++
 3 files changed, 11 insertions(+), 2 deletions(-)
block/qapi-sysemu.c +2 -1
index 8498402ad4..5b4fb75787 100644
@@ -318,6 +318,7 @@ void qmp_blockdev_change_medium(bool has_device, const char *device,
                                 bool has_id, const char *id,
                                 const char *filename,
                                 bool has_format, const char *format,
+                                bool has_force, bool force,
                                 bool has_read_only,
                                 BlockdevChangeReadOnlyMode read_only,
                                 Error **errp)
@@ -380,7 +381,7 @@ void qmp_blockdev_change_medium(bool has_device, const char *device,
 
     rc = do_open_tray(has_device ? device : NULL,
                       has_id ? id : NULL,
-                      false, &err);
+                      has_force ? force : false, &err);
     if (rc && rc != -ENOSYS) {
         error_propagate(errp, err);
         goto fail;
monitor/hmp-cmds.c +3 -1
index 634968498b..d8b98bed6c 100644
@@ -1472,6 +1472,7 @@ void hmp_change(Monitor *mon, const QDict *qdict)
     const char *target = qdict_get_str(qdict, "target");
     const char *arg = qdict_get_try_str(qdict, "arg");
     const char *read_only = qdict_get_try_str(qdict, "read-only-mode");
+    bool force = qdict_get_try_bool(qdict, "force", false);
     BlockdevChangeReadOnlyMode read_only_mode = 0;
     Error *err = NULL;
 
@@ -1508,7 +1509,8 @@ void hmp_change(Monitor *mon, const QDict *qdict)
         }
 
         qmp_blockdev_change_medium(true, device, false, NULL, target,
-                                   !!arg, arg, !!read_only, read_only_mode,
+                                   !!arg, arg, true, force,
+                                   !!read_only, read_only_mode,
                                    &err);
     }
 
qapi/block.json +6 -0
index 82fcf2c914..3f100d4887 100644
@@ -326,6 +326,11 @@
 # @read-only-mode: change the read-only mode of the device; defaults
 #                  to 'retain'
 #
+# @force: if false (the default), an eject request through blockdev-open-tray
+#         will be sent to the guest if it has locked the tray (and the tray
+#         will not be opened immediately); if true, the tray will be opened
+#         regardless of whether it is locked. (since 7.1)
+#
 # Features:
 # @deprecated: Member @device is deprecated.  Use @id instead.
 #
@@ -367,6 +372,7 @@
             '*id': 'str',
             'filename': 'str',
             '*format': 'str',
+            '*force': 'bool',
             '*read-only-mode': 'BlockdevChangeReadOnlyMode' } }
 
 
Signature · 1 line
2.32.0
#1 lore raw
Quoted 42 lines · Denis V. Lunev

'blockdev-change-medium' is a convinient wrapper for the following sequence of commands:
* blockdev-open-tray
* blockdev-remove-medium
* blockdev-insert-medium
* blockdev-close-tray
and should be used f.e. to change ISO image inside the CD-ROM tray. Though the guest could lock the tray and some linux guests like CentOS 8.5 actually does that. In this case the execution if this command results in the error like the following:
Device 'scsi0-0-1-0' is locked and force was not specified, wait for tray to open and try again.

This situation is could be resolved 'blockdev-open-tray' by passing flag 'force' inside. Thus is seems reasonable to add the same capability for 'blockdev-change-medium' too.

CC Kevin Wolf <[email protected]>
CC Hanna Reitz <[email protected]>
CC "Dr. David Alan Gilbert" <[email protected]>
CC Eric Blake <[email protected]>
CC Markus Armbruster <[email protected]>
---
  block/qapi-sysemu.c | 3 ++-
  monitor/hmp-cmds.c  | 4 +++-
  qapi/block.json     | 6 ++++++
  3 files changed, 11 insertions(+), 2 deletions(-)
block/qapi-sysemu.c +1 -0
index 8498402ad4..5b4fb75787 100644
@@ -318,6 +318,7 @@ void qmp_blockdev_change_medium(bool has_device, const char *device,
                                  bool has_id, const char *id,
                                  const char *filename,
                                  bool has_format, const char *format,
+                                bool has_force, bool force,
                                  bool has_read_only,
                                  BlockdevChangeReadOnlyMode read_only,
                                  Error **errp)

block/qapi-sysemu.c void qmp_blockdev_change_medium(bool has_device, const char *device, · line 384

Quoted 5 lines
block/qapi-sysemu.c +1 -1
@@ -380,7 +381,7 @@ void qmp_blockdev_change_medium(bool has_device, const char *device,
 
      rc = do_open_tray(has_device ? device : NULL,
                        has_id ? id : NULL,
-                      false, &err);
+                      has_force ? force : false, &err);

It's guaranteed for force to be false when has_force is false (ans similarly for pointers), so that can be written as

  rc = do_open_tray(device, id, force, &err);
Quoted 16 lines
block/qapi-sysemu.c +0 -0
      if (rc && rc != -ENOSYS) {
          error_propagate(errp, err);
          goto fail;
monitor/hmp-cmds.c +1 -0
index 634968498b..d8b98bed6c 100644
@@ -1472,6 +1472,7 @@ void hmp_change(Monitor *mon, const QDict *qdict)
      const char *target = qdict_get_str(qdict, "target");
      const char *arg = qdict_get_try_str(qdict, "arg");
      const char *read_only = qdict_get_try_str(qdict, "read-only-mode");
+    bool force = qdict_get_try_bool(qdict, "force", false);
      BlockdevChangeReadOnlyMode read_only_mode = 0;
      Error *err = NULL;
 

monitor/hmp-cmds.c void hmp_change(Monitor *mon, const QDict *qdict) · line 1516

Quoted 9 lines
monitor/hmp-cmds.c +2 -1
@@ -1508,7 +1509,8 @@ void hmp_change(Monitor *mon, const QDict *qdict)
          }
 
          qmp_blockdev_change_medium(true, device, false, NULL, target,
-                                   !!arg, arg, !!read_only, read_only_mode,
+                                   !!arg, arg, true, force,
+                                   !!read_only, read_only_mode,
                                     &err);
      }
 

Should we also update hmp-commands.hx ? Or you just can pass "false, false" if you don't really need hmp interface for new feature.

Also, I don't know what ui/cocoa.m is, but seems it has call to qmp_blockdev_change_medium(), which most probably should be updated too.

Quoted 24 lines
qapi/block.json +6 -0
index 82fcf2c914..3f100d4887 100644
@@ -326,6 +326,11 @@
  # @read-only-mode: change the read-only mode of the device; defaults
  #                  to 'retain'
  #
+# @force: if false (the default), an eject request through blockdev-open-tray
+#         will be sent to the guest if it has locked the tray (and the tray
+#         will not be opened immediately); if true, the tray will be opened
+#         regardless of whether it is locked. (since 7.1)
+#
  # Features:
  # @deprecated: Member @device is deprecated.  Use @id instead.
  #
@@ -367,6 +372,7 @@
              '*id': 'str',
              'filename': 'str',
              '*format': 'str',
+            '*force': 'bool',
              '*read-only-mode': 'BlockdevChangeReadOnlyMode' } }
 
 
Signature · 2 lines
Best regards,
Vladimir
#2 lore raw
Quoted 52 lines · Vladimir Sementsov-Ogievskiy' via den
Quoted 43 lines · Denis V. Lunev

'blockdev-change-medium' is a convinient wrapper for the following sequence of commands:
  * blockdev-open-tray
  * blockdev-remove-medium
  * blockdev-insert-medium
  * blockdev-close-tray
and should be used f.e. to change ISO image inside the CD-ROM tray. Though the guest could lock the tray and some linux guests like CentOS 8.5 actually does that. In this case the execution if this command results in the error like the following:
   Device 'scsi0-0-1-0' is locked and force was not specified, wait for tray to open and try again.

This situation is could be resolved 'blockdev-open-tray' by passing flag 'force' inside. Thus is seems reasonable to add the same capability for 'blockdev-change-medium' too.

CC Kevin Wolf <[email protected]>
CC Hanna Reitz <[email protected]>
CC "Dr. David Alan Gilbert" <[email protected]>
CC Eric Blake <[email protected]>
CC Markus Armbruster <[email protected]>

---
  block/qapi-sysemu.c | 3 ++-
  monitor/hmp-cmds.c  | 4 +++-
  qapi/block.json     | 6 ++++++

  3 files changed, 11 insertions(+), 2 deletions(-)
block/qapi-sysemu.c +1 -0
index 8498402ad4..5b4fb75787 100644
@@ -318,6 +318,7 @@ void qmp_blockdev_change_medium(bool has_device, 
 const char *device,
                                   bool has_id, const char *id,
                                   const char *filename,
                                   bool has_format, const char *format,
+                                bool has_force, bool force,
                                   bool has_read_only,
                                   BlockdevChangeReadOnlyMode read_only,

                                  Error **errp)

block/qapi-sysemu.c void qmp_blockdev_change_medium(bool has_device, · line 384

Quoted 5 lines
block/qapi-sysemu.c +1 -1
@@ -380,7 +381,7 @@ void qmp_blockdev_change_medium(bool has_device, 
 const char *device,
         rc = do_open_tray(has_device ? device : NULL,
                         has_id ? id : NULL,
-                      false, &err);
+                      has_force ? force : false, &err);

It's guaranteed for force to be false when has_force is false (ans similarly for pointers), so that can be written as

Quoted 1 line

  rc = do_open_tray(device, id, force, &err);

you right :)

Quoted 18 lines
Quoted 18 lines
block/qapi-sysemu.c +0 -0
       if (rc && rc != -ENOSYS) {
           error_propagate(errp, err);
           goto fail;
monitor/hmp-cmds.c +1 -0
index 634968498b..d8b98bed6c 100644
@@ -1472,6 +1472,7 @@ void hmp_change(Monitor *mon, const QDict *qdict)
       const char *target = qdict_get_str(qdict, "target");
       const char *arg = qdict_get_try_str(qdict, "arg");
       const char *read_only = qdict_get_try_str(qdict, "read-only-mode");
+    bool force = qdict_get_try_bool(qdict, "force", false);
       BlockdevChangeReadOnlyMode read_only_mode = 0;
       Error *err = NULL;
   @@ -1508,7 +1509,8 @@ void hmp_change(Monitor *mon, const QDict *qdict)

          }
            qmp_blockdev_change_medium(true, device, false, NULL, target,

Quoted 9 lines
Quoted 6 lines

-                                   !!arg, arg, !!read_only, read_only_mode,
+                                   !!arg, arg, true, force, +                                   !!read_only, read_only_mode, &err);
      }

Should we also update hmp-commands.hx ? Or you just can pass "false, false" if you don't really need hmp interface for new feature.

good point, I have added query for the dictionary thus it would be logical to make an update in .hx file too

Quoted 2 lines

Also, I don't know what ui/cocoa.m is, but seems it has call to qmp_blockdev_change_medium(), which most probably should be updated too.

Objective C file, looking like for MacOS UI

Quoted 27 lines
Quoted 25 lines
qapi/block.json +1 -0
index 82fcf2c914..3f100d4887 100644
@@ -326,6 +326,11 @@
   # @read-only-mode: change the read-only mode of the device; defaults
   #                  to 'retain'
   #
+# @force: if false (the default), an eject request through 

blockdev-open-tray
+#         will be sent to the guest if it has locked the tray (and the tray
+#         will not be opened immediately); if true, the tray will be opened

qapi/block.json +2 -0
+#         regardless of whether it is locked. (since 7.1)
+#

  # Features:
  # @deprecated: Member @device is deprecated.  Use @id instead. #

qapi/block.json +1 -0
@@ -367,6 +372,7 @@
               '*id': 'str',
               'filename': 'str',
               '*format': 'str',
+            '*force': 'bool',
               '*read-only-mode': 'BlockdevChangeReadOnlyMode' } }