Skip to contentSkip to conversation

Improve convert and dd commands

PATCH Superseded Daniel P. Berrange 2 participants 8 messages May 15, 2017 – May 16, 2017

v9 of 10 Superseded Latest is v10 →

lore
Share & tools
lore
#0 lore raw

v9 cover Improve convert and dd commands

Update to

v1: https://lists.gnu.org/archive/html/qemu-devel/2017-01/msg05699.html
v2: https://lists.gnu.org/archive/html/qemu-devel/2017-02/msg00728.html
v3: https://lists.gnu.org/archive/html/qemu-devel/2017-02/msg04391.html
v4: https://lists.gnu.org/archive/html/qemu-devel/2017-04/msg02153.html
v5: https://lists.gnu.org/archive/html/qemu-devel/2017-04/msg04109.html
v6: https://lists.gnu.org/archive/html/qemu-devel/2017-05/msg00215.html
v7: https://lists.gnu.org/archive/html/qemu-devel/2017-05/msg00242.html
v8: https://lists.gnu.org/archive/html/qemu-devel/2017-05/msg02028.html

This series is in response to Max pointing out that you cannot use 'convert' for an encrypted target image.

The 'convert' and 'dd' commands need to first create the image and then open it. The bdrv_create() method takes a set of options for creating the image, which let us provide a key-secret for the encryption key. When the commands then open the new image, they don't provide any options, so the image is unable to be opened due to lack of encryption key. It is also not possible to use the --image-opts argument to provide structured options in the target image name - it must be a plain filename to satisfy the bdrv_create() API contract.

This series addresses these problems to some extent

- Adds a new --target-image-opts flag which is used to say that the target filename is using structured options. It is *only* permitted to use this when -n is also set. ie the target image must be pre-created so convert/dd don't need to run bdrv_create().

- When --target-image-opts is not used, add special case code that identifies options passed to bdrv_create() named "*key-secret" and adds them to the options used to open the new image

In future it is desirable to make --target-image-opts work even when -n is *not* given. This requires considerable work to create a new bdrv_create() API impl.

The first patch fixes a bug in the 'dd' command while the second adds support for the missing '--object' arg to 'dd', allowing it to reference secrets when opening files. The last two patches implement the new features described above for the 'convert' command.

Changed in v9:

- Rebased against Kevin's "block" branch with Fam's patch "qemu-img: Fix documentation of convert" applied first

Changed in v8:

- Readd accidentally dropped check for compression (Max)
- Fix indentation of variable declaration (Max)
- Fix goto jump target (Max)

Changed in v7:

- Drop the (accidentally included) revert patch (Eric)

Changed in v6:

- Fix misc typos (Fam)
- Resolve messy conflicts wrt max/block-next (Max)

Changed in v5:

- Fix return value (Max)
- Misc doc changes (Max)
- Use error_abort (Max)

Changed in v4:

- Refactor img_open_new_file in terms of img_open_file (Kevin)

Changed in v3:

- Drop all patches affecting the 'dd' command except for the clear bug fix and the --object support. They can be re-considered once dd is rewritten to run ontop of convert.
- Use consistent return/goto style in dd command (Max)
- Fix error reporting when using compressed image and skip-create (Max)
- Unconditionally create QDict when open files (Max)

Changed in v2:

- Replace dd -n flag with support for conv=nocreat,notrunc
- Misc typos (Eric, Fam)

Daniel P. Berrange (4):
qemu-img: add support for --object with 'dd' command
qemu-img: fix --image-opts usage with dd command
qemu-img: introduce --target-image-opts for 'convert' command
qemu-img: copy *key-secret opts when opening newly created files

 qemu-img-cmds.hx |   4 +-
 qemu-img.c       | 147 +++++++++++++++++++++++++++++++++++++++++++------------
 qemu-img.texi    |  12 ++++-
 3 files changed, 128 insertions(+), 35 deletions(-)
Signature · 1 line
2.9.3
#1 lore raw

PATCH v9 1/4 qemu-img: add support for --object with 'dd' command

The qemu-img dd command added --image-opts support, but missed the corresponding --object support. This prevented passing secrets (eg auth passwords) needed by certain disk images.

---
 qemu-img.c | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
qemu-img.c +18 -0
index b506839..181f499 100644
@@ -4158,6 +4158,7 @@ static int img_dd(int argc, char **argv)
     };
     const struct option long_options[] = {
         { "help", no_argument, 0, 'h'},
+        { "object", required_argument, 0, OPTION_OBJECT},
         { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
         { "force-share", no_argument, 0, 'U'},
         { 0, 0, 0, 0 }
@@ -4186,6 +4187,15 @@ static int img_dd(int argc, char **argv)
         case 'U':
             force_share = true;
             break;
+        case OPTION_OBJECT: {
+            QemuOpts *opts;
+            opts = qemu_opts_parse_noisily(&qemu_object_opts,
+                                           optarg, true);
+            if (!opts) {
+                ret = -1;
+                goto out;
+            }
+        }   break;
         case OPTION_IMAGE_OPTS:
             image_opts = true;
             break;
@@ -4230,6 +4240,14 @@ static int img_dd(int argc, char **argv)
         ret = -1;
         goto out;
     }
+
+    if (qemu_opts_foreach(&qemu_object_opts,
+                          user_creatable_add_opts_foreach,
+                          NULL, NULL)) {
+        ret = -1;
+        goto out;
+    }
+
     blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
                     force_share);
 
Signature · 1 line
2.9.3
#2 lore raw

PATCH v9 2/4 qemu-img: fix --image-opts usage with dd command

In reply to Daniel P. Berrange

The --image-opts flag can only be used to affect the parsing of the source image. The target image has to be specified in the traditional style regardless, since it needs to be passed to the bdrv_create() API which does not support the new style opts.

---
 qemu-img.c | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)
qemu-img.c +7 -2
index 181f499..4dc1d56 100644
@@ -4316,8 +4316,13 @@ static int img_dd(int argc, char **argv)
         goto out;
     }
 
-    blk2 = img_open(image_opts, out.filename, out_fmt, BDRV_O_RDWR,
-                    false, false, false);
+    /* TODO, we can't honour --image-opts for the target,
+     * since it needs to be given in a format compatible
+     * with the bdrv_create() call above which does not
+     * support image-opts style.
+     */
+    blk2 = img_open_file(out.filename, out_fmt, BDRV_O_RDWR,
+                         false, false, false);
 
     if (!blk2) {
         ret = -1;
Signature · 1 line
2.9.3
#3 lore raw

PATCH v9 3/4 qemu-img: introduce --target-image-opts for 'convert' command

In reply to Daniel P. Berrange

The '--image-opts' flag indicates whether the source filename includes options. The target filename has to remain in the plain filename format though, since it needs to be passed to bdrv_create(). When using --skip-create though, it would be possible to use image-opts syntax. This adds --target-image-opts to indicate that the target filename includes options. Currently this mandates use of the --skip-create flag too.

---
 qemu-img-cmds.hx |  4 +--
 qemu-img.c       | 84 ++++++++++++++++++++++++++++++++++++++------------------
 qemu-img.texi    | 12 ++++++--
 3 files changed, 69 insertions(+), 31 deletions(-)
qemu-img-cmds.hx +2 -2
index 469ec12..c298331 100644
@@ -40,9 +40,9 @@ STEXI
 ETEXI
 
 DEF("convert", img_convert,
-    "convert [--object objectdef] [--image-opts] [-U] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file] [-o options] [-s snapshot_id_or_name] [-l snapshot_param] [-S sparse_size] [-m num_coroutines] [-W] filename [filename2 [...]] output_filename")
+    "convert [--object objectdef] [--image-opts] [--target-image-opts] [-U] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file] [-o options] [-s snapshot_id_or_name] [-l snapshot_param] [-S sparse_size] [-m num_coroutines] [-W] filename [filename2 [...]] output_filename")
 STEXI
-@item convert [--object @var{objectdef}] [--image-opts] [-U] [-c] [-p] [-q] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-B @var{backing_file}][-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-S @var{sparse_size}] [-m @var{num_coroutines}] [-W] @var{filename} [@var{filename2} [...]] @var{output_filename}
+@item convert [--object @var{objectdef}] [--image-opts] [--target-image-opts] [-U] [-c] [-p] [-q] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-B @var{backing_file}][-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-S @var{sparse_size}] [-m @var{num_coroutines}] [-W] @var{filename} [@var{filename2} [...]] @var{output_filename}
 ETEXI
 
 DEF("dd", img_dd,
qemu-img.c +57 -27

155 lines not on this page · raw message

qemu-img.texi +10 -2
index 50a2364..5b925ec 100644
@@ -45,9 +45,17 @@ keys.
 
 @item --image-opts
 
-Indicates that the @var{filename} parameter is to be interpreted as a
+Indicates that the source @var{filename} parameter is to be interpreted as a
 full option string, not a plain filename. This parameter is mutually
-exclusive with the @var{-f} and @var{-F} parameters.
+exclusive with the @var{-f} parameter.
+
+@item --target-image-opts
+
+Indicates that the @var{output_filename} parameter(s) are to be interpreted as
+a full option string, not a plain filename. This parameter is mutually
+exclusive with the @var{-O} parameters. It is currently required to also use
+the @var{-n} parameter to skip image creation. This restriction may be relaxed
+in a future release.
 
 @item fmt
 is the disk image format. It is guessed automatically in most cases. See below
Signature · 1 line
2.9.3
#4 lore raw

PATCH v9 4/4 qemu-img: copy *key-secret opts when opening newly created files

In reply to Daniel P. Berrange

The qemu-img dd/convert commands will create an image file and then try to open it. Historically it has been possible to open new files without passing any options. With encrypted files though, the *key-secret options are mandatory, so we need to provide those options when opening the newly created file.

---
 qemu-img.c | 42 +++++++++++++++++++++++++++++++++++++-----
 1 file changed, 37 insertions(+), 5 deletions(-)
qemu-img.c +37 -5
index e0e3d31..dcddded 100644
@@ -314,15 +314,18 @@ static BlockBackend *img_open_opts(const char *optstr,
 }
 
 static BlockBackend *img_open_file(const char *filename,
+                                   QDict *options,
                                    const char *fmt, int flags,
                                    bool writethrough, bool quiet,
                                    bool force_share)
 {
     BlockBackend *blk;
     Error *local_err = NULL;
-    QDict *options = qdict_new();
 
     if (fmt) {
+        if (!options) {
+            options = qdict_new();
+        }
         qdict_put_str(options, "driver", fmt);
     }
 
@@ -344,6 +347,35 @@ static BlockBackend *img_open_file(const char *filename,
 }
 
 
+static int img_add_key_secrets(void *opaque,
+                               const char *name, const char *value,
+                               Error **errp)
+{
+    QDict *options = opaque;
+
+    if (g_str_has_suffix(name, "key-secret")) {
+        qdict_put(options, name, qstring_from_str(value));
+    }
+
+    return 0;
+}
+
+static BlockBackend *img_open_new_file(const char *filename,
+                                       QemuOpts *create_opts,
+                                       const char *fmt, int flags,
+                                       bool writethrough, bool quiet,
+                                       bool force_share)
+{
+    QDict *options = NULL;
+
+    options = qdict_new();
+    qemu_opt_foreach(create_opts, img_add_key_secrets, options, &error_abort);
+
+    return img_open_file(filename, options, fmt, flags, writethrough, quiet,
+                         force_share);
+}
+
+
 static BlockBackend *img_open(bool image_opts,
                               const char *filename,
                               const char *fmt, int flags, bool writethrough,
@@ -364,7 +396,7 @@ static BlockBackend *img_open(bool image_opts,
         blk = img_open_opts(filename, opts, flags, writethrough, quiet,
                             force_share);
     } else {
-        blk = img_open_file(filename, fmt, flags, writethrough, quiet,
+        blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
                             force_share);
     }
     return blk;
@@ -2286,8 +2318,8 @@ static int img_convert(int argc, char **argv)
          * That has to wait for bdrv_create to be improved
          * to allow filenames in option syntax
          */
-        s.target = img_open_file(out_filename, out_fmt, flags,
-                                 writethrough, quiet, false);
+        s.target = img_open_new_file(out_filename, opts, out_fmt,
+                                     flags, writethrough, quiet, false);
     }
     if (!s.target) {
         ret = -1;
@@ -4351,7 +4383,7 @@ static int img_dd(int argc, char **argv)
      * with the bdrv_create() call above which does not
      * support image-opts style.
      */
-    blk2 = img_open_file(out.filename, out_fmt, BDRV_O_RDWR,
+    blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
                          false, false, false);
 
     if (!blk2) {
Signature · 1 line
2.9.3
#5 lore raw

Re: [Qemu-devel] [PATCH v9 4/4] qemu-img: copy *key-secret opts when opening newly created files

Quoted 25 lines · Daniel P. Berrange

The qemu-img dd/convert commands will create an image file and then try to open it. Historically it has been possible to open new files without passing any options. With encrypted files though, the *key-secret options are mandatory, so we need to provide those options when opening the newly created file.

---
 qemu-img.c | 42 +++++++++++++++++++++++++++++++++++++-----
 1 file changed, 37 insertions(+), 5 deletions(-)
qemu-img.c +1 -0
index e0e3d31..dcddded 100644
@@ -314,15 +314,18 @@ static BlockBackend *img_open_opts(const char *optstr,
 }
 
 static BlockBackend *img_open_file(const char *filename,
+                                   QDict *options,
                                    const char *fmt, int flags,
                                    bool writethrough, bool quiet,

qemu-img.c static BlockBackend *img_open_opts(const char *optstr, · line 328

Quoted 10 lines
qemu-img.c +3 -1
                                    bool force_share)
 {
     BlockBackend *blk;
     Error *local_err = NULL;
-    QDict *options = qdict_new();
 
     if (fmt) {
+        if (!options) {
+            options = qdict_new();
+        }

This is the only place where my attempted rebase and your version differ. I think this has to be done unconditionally, because otherwise:

$ ./qemu-img info -U null-co://
[1]    16327 segmentation fault (core dumped)  ./qemu-img info -U null-co://

Also, I'm not sure the R-bs apply for this patch any longer.

(They do for patch 1 because it's just a contextual difference. For patch 2, it's a borderline case (I would drop it, but I can understand keeping it). For patch 3 it's more than just borderline - I would definitely drop the R-b, but the differences are still rather mechanical, so it is acceptable to keep it.
But I think there are too many changes here in this patch to keep the R-bs. In fact, I'm pretty sure none of Eric, Fam and me have given an R-b to this segfault...)

Max

Quoted 69 lines
qemu-img.c +33 -4
         qdict_put_str(options, "driver", fmt);
     }
 
@@ -344,6 +347,35 @@ static BlockBackend *img_open_file(const char *filename,
 }
 
 
+static int img_add_key_secrets(void *opaque,
+                               const char *name, const char *value,
+                               Error **errp)
+{
+    QDict *options = opaque;
+
+    if (g_str_has_suffix(name, "key-secret")) {
+        qdict_put(options, name, qstring_from_str(value));
+    }
+
+    return 0;
+}
+
+static BlockBackend *img_open_new_file(const char *filename,
+                                       QemuOpts *create_opts,
+                                       const char *fmt, int flags,
+                                       bool writethrough, bool quiet,
+                                       bool force_share)
+{
+    QDict *options = NULL;
+
+    options = qdict_new();
+    qemu_opt_foreach(create_opts, img_add_key_secrets, options, &error_abort);
+
+    return img_open_file(filename, options, fmt, flags, writethrough, quiet,
+                         force_share);
+}
+
+
 static BlockBackend *img_open(bool image_opts,
                               const char *filename,
                               const char *fmt, int flags, bool writethrough,
@@ -364,7 +396,7 @@ static BlockBackend *img_open(bool image_opts,
         blk = img_open_opts(filename, opts, flags, writethrough, quiet,
                             force_share);
     } else {
-        blk = img_open_file(filename, fmt, flags, writethrough, quiet,
+        blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
                             force_share);
     }
     return blk;
@@ -2286,8 +2318,8 @@ static int img_convert(int argc, char **argv)
          * That has to wait for bdrv_create to be improved
          * to allow filenames in option syntax
          */
-        s.target = img_open_file(out_filename, out_fmt, flags,
-                                 writethrough, quiet, false);
+        s.target = img_open_new_file(out_filename, opts, out_fmt,
+                                     flags, writethrough, quiet, false);
     }
     if (!s.target) {
         ret = -1;
@@ -4351,7 +4383,7 @@ static int img_dd(int argc, char **argv)
      * with the bdrv_create() call above which does not
      * support image-opts style.
      */
-    blk2 = img_open_file(out.filename, out_fmt, BDRV_O_RDWR,
+    blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
                          false, false, false);
 
     if (!blk2) {
#6 lore raw

Re: [Qemu-devel] [PATCH v9 4/4] qemu-img: copy *key-secret opts when opening newly created files

Quoted 45 lines · Max Reitz
Quoted 25 lines · Daniel P. Berrange

The qemu-img dd/convert commands will create an image file and then try to open it. Historically it has been possible to open new files without passing any options. With encrypted files though, the *key-secret options are mandatory, so we need to provide those options when opening the newly created file.

---
 qemu-img.c | 42 +++++++++++++++++++++++++++++++++++++-----
 1 file changed, 37 insertions(+), 5 deletions(-)
qemu-img.c +1 -0
index e0e3d31..dcddded 100644
@@ -314,15 +314,18 @@ static BlockBackend *img_open_opts(const char *optstr,
 }
 
 static BlockBackend *img_open_file(const char *filename,
+                                   QDict *options,
                                    const char *fmt, int flags,
                                    bool writethrough, bool quiet,

qemu-img.c static BlockBackend *img_open_opts(const char *optstr, · line 328

Quoted 10 lines
qemu-img.c +3 -1
                                    bool force_share)
 {
     BlockBackend *blk;
     Error *local_err = NULL;
-    QDict *options = qdict_new();
 
     if (fmt) {
+        if (!options) {
+            options = qdict_new();
+        }

This is the only place where my attempted rebase and your version differ. I think this has to be done unconditionally, because otherwise:

$ ./qemu-img info -U null-co://
[1]    16327 segmentation fault (core dumped)  ./qemu-img info -U null-co://

Also, I'm not sure the R-bs apply for this patch any longer.

Quoted 8 lines

(They do for patch 1 because it's just a contextual difference. For patch 2, it's a borderline case (I would drop it, but I can understand keeping it). For patch 3 it's more than just borderline - I would definitely drop the R-b, but the differences are still rather mechanical, so it is acceptable to keep it.
But I think there are too many changes here in this patch to keep the R-bs. In fact, I'm pretty sure none of Eric, Fam and me have given an R-b to this segfault...)

And just saw v10... Maybe I should start working on my inbox back to front...

Max

#7 lore raw

Re: [Qemu-devel] [PATCH v9 4/4] qemu-img: copy *key-secret opts when opening newly created files

In reply to Max Reitz
Quoted 40 lines · Max Reitz
Quoted 25 lines · Daniel P. Berrange

The qemu-img dd/convert commands will create an image file and then try to open it. Historically it has been possible to open new files without passing any options. With encrypted files though, the *key-secret options are mandatory, so we need to provide those options when opening the newly created file.

---
 qemu-img.c | 42 +++++++++++++++++++++++++++++++++++++-----
 1 file changed, 37 insertions(+), 5 deletions(-)
qemu-img.c +1 -0
index e0e3d31..dcddded 100644
@@ -314,15 +314,18 @@ static BlockBackend *img_open_opts(const char *optstr,
 }
 
 static BlockBackend *img_open_file(const char *filename,
+                                   QDict *options,
                                    const char *fmt, int flags,
                                    bool writethrough, bool quiet,

qemu-img.c static BlockBackend *img_open_opts(const char *optstr, · line 328

Quoted 10 lines
qemu-img.c +3 -1
                                    bool force_share)
 {
     BlockBackend *blk;
     Error *local_err = NULL;
-    QDict *options = qdict_new();
 
     if (fmt) {
+        if (!options) {
+            options = qdict_new();
+        }

This is the only place where my attempted rebase and your version differ. I think this has to be done unconditionally, because otherwise:

Quoted 2 lines
$ ./qemu-img info -U null-co://
[1]    16327 segmentation fault (core dumped)  ./qemu-img info -U null-co://

Yep, sorry this was the mistake that made me send v10.

Quoted 10 lines

Also, I'm not sure the R-bs apply for this patch any longer.

(They do for patch 1 because it's just a contextual difference. For patch 2, it's a borderline case (I would drop it, but I can understand keeping it). For patch 3 it's more than just borderline - I would definitely drop the R-b, but the differences are still rather mechanical, so it is acceptable to keep it.
But I think there are too many changes here in this patch to keep the R-bs. In fact, I'm pretty sure none of Eric, Fam and me have given an R-b to this segfault...)

True, I'm never too sure what level of changes is large enough to require dropping the R-b. Normally I just do it if it is feature changes or non-trivial review feedback, where as this was just (supposedly easy) conflict resolution, but it did go wrong this time :-(

Regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|