diff mbox

[V2,3/8] block/qcow2: parse compress create options

Message ID 1498733831-15254-4-git-send-email-pl@kamp.de
State New
Headers show

Commit Message

Peter Lieven June 29, 2017, 10:57 a.m. UTC 
this adds parsing and validation for the compress create
options. They are only validated but not yet used.

Signed-off-by: Peter Lieven <pl@kamp.de>
---
 block/qcow2.c             | 56 +++++++++++++++++++++++++++++++++++++++++++++--
 block/qcow2.h             |  9 ++++++++
 include/block/block_int.h |  2 ++
 3 files changed, 65 insertions(+), 2 deletions(-)

Comments

Daniel P. Berrangé July 10, 2017, 1:52 p.m. UTC | #1 
On Thu, Jun 29, 2017 at 12:57:06PM +0200, Peter Lieven wrote:
> this adds parsing and validation for the compress create
> options. They are only validated but not yet used.
> 
> Signed-off-by: Peter Lieven <pl@kamp.de>
> ---
>  block/qcow2.c             | 56 +++++++++++++++++++++++++++++++++++++++++++++--
>  block/qcow2.h             |  9 ++++++++
>  include/block/block_int.h |  2 ++
>  3 files changed, 65 insertions(+), 2 deletions(-)
> 
> diff --git a/block/qcow2.c b/block/qcow2.c
> index 2f94f03..308121a 100644
> --- a/block/qcow2.c
> +++ b/block/qcow2.c
> @@ -2144,7 +2144,8 @@ static int qcow2_create2(const char *filename, int64_t total_size,
>                           const char *backing_file, const char *backing_format,
>                           int flags, size_t cluster_size, PreallocMode prealloc,
>                           QemuOpts *opts, int version, int refcount_order,
> -                         Error **errp)
> +                         const char *compress_format_name,
> +                         uint8_t compress_level, Error **errp)
>  {
>      int cluster_bits;
>      QDict *options;
> @@ -2390,11 +2391,24 @@ out:
>      return ret;
>  }
>  
> +static int qcow2_compress_format_from_name(char *fmt)
> +{
> +    if (!fmt || !fmt[0]) {
> +        return QCOW2_COMPRESS_ZLIB_COMPAT;
> +    } else if (g_str_equal(fmt, "zlib")) {
> +        return QCOW2_COMPRESS_ZLIB;
> +    } else {
> +        return -EINVAL;
> +    }
> +}
> +
>  static int qcow2_create(const char *filename, QemuOpts *opts, Error **errp)
>  {
>      char *backing_file = NULL;
>      char *backing_fmt = NULL;
>      char *buf = NULL;
> +    char *compress_format_name = NULL;
> +    uint64_t compress_level = 0;
>      uint64_t size = 0;
>      int flags = 0;
>      size_t cluster_size = DEFAULT_CLUSTER_SIZE;
> @@ -2475,15 +2489,40 @@ static int qcow2_create(const char *filename, QemuOpts *opts, Error **errp)
>  
>      refcount_order = ctz32(refcount_bits);
>  
> +    compress_format_name = qemu_opt_get_del(opts,
> +                                            BLOCK_OPT_COMPRESS_FORMAT);
> +    ret = qcow2_compress_format_from_name(compress_format_name);
> +    if (ret < 0) {
> +        error_setg(errp, "Compress format '%s' is not supported",
> +                   compress_format_name);
> +        goto finish;
> +    }
> +    compress_level = qemu_opt_get_number_del(opts, BLOCK_OPT_COMPRESS_LEVEL,
> +                                             compress_level);
> +    if (ret == QCOW2_COMPRESS_ZLIB_COMPAT && compress_level > 0) {
> +        error_setg(errp, "Compress level can only be defined in conjunction"
> +                   " with compress format");
> +        ret = -EINVAL;
> +        goto finish;
> +    }
> +    if ((ret == QCOW2_COMPRESS_ZLIB && compress_level > 9) ||
> +        compress_level > 0xff) {
> +        error_setg(errp, "Compress level %" PRIu64 " is not supported for"
> +                   " format '%s'", compress_level, compress_format_name);
> +        ret = -EINVAL;
> +        goto finish;
> +    }

This is where the QAPI schema bits would fit in. eg instead of calling the
various qemu_opts_get* functions, do something like this:

    QDict *options, *compressopts = NULL;
    Qcow2Compress *compress = NULL;

    options = qemu_opts_to_qdict(opts, NULL);
    qdict_extract_subqdict(options, &compressopts, "compress.");

    v = qobject_input_visitor_new_keyval(QOBJECT(compressopts));
    
    visit_type_Qcow2Compress(v, &compress, &local_err);
    if (local_err) {
        ret= -EINVAL;
	goto finish;
    }


    ..do whatever you need with the 'compress' object now...

    visit_free(v);
    QDECREF(encryptopts);
    QDECREF(options);


Eventually the entire of the qcow2 create codepath will be qemu opts based,
so all the subdict/visitor steps will be able to go away, leaving you to
just use the Qcow2Compress struct immediately.

Regards,
Daniel
diff mbox

Patch

diff --git a/block/qcow2.c b/block/qcow2.c
index 2f94f03..308121a 100644
--- a/block/qcow2.c
+++ b/block/qcow2.c
@@ -2144,7 +2144,8 @@  static int qcow2_create2(const char *filename, int64_t total_size,
                          const char *backing_file, const char *backing_format,
                          int flags, size_t cluster_size, PreallocMode prealloc,
                          QemuOpts *opts, int version, int refcount_order,
-                         Error **errp)
+                         const char *compress_format_name,
+                         uint8_t compress_level, Error **errp)
 {
     int cluster_bits;
     QDict *options;
@@ -2390,11 +2391,24 @@  out:
     return ret;
 }
 
+static int qcow2_compress_format_from_name(char *fmt)
+{
+    if (!fmt || !fmt[0]) {
+        return QCOW2_COMPRESS_ZLIB_COMPAT;
+    } else if (g_str_equal(fmt, "zlib")) {
+        return QCOW2_COMPRESS_ZLIB;
+    } else {
+        return -EINVAL;
+    }
+}
+
 static int qcow2_create(const char *filename, QemuOpts *opts, Error **errp)
 {
     char *backing_file = NULL;
     char *backing_fmt = NULL;
     char *buf = NULL;
+    char *compress_format_name = NULL;
+    uint64_t compress_level = 0;
     uint64_t size = 0;
     int flags = 0;
     size_t cluster_size = DEFAULT_CLUSTER_SIZE;
@@ -2475,15 +2489,40 @@  static int qcow2_create(const char *filename, QemuOpts *opts, Error **errp)
 
     refcount_order = ctz32(refcount_bits);
 
+    compress_format_name = qemu_opt_get_del(opts,
+                                            BLOCK_OPT_COMPRESS_FORMAT);
+    ret = qcow2_compress_format_from_name(compress_format_name);
+    if (ret < 0) {
+        error_setg(errp, "Compress format '%s' is not supported",
+                   compress_format_name);
+        goto finish;
+    }
+    compress_level = qemu_opt_get_number_del(opts, BLOCK_OPT_COMPRESS_LEVEL,
+                                             compress_level);
+    if (ret == QCOW2_COMPRESS_ZLIB_COMPAT && compress_level > 0) {
+        error_setg(errp, "Compress level can only be defined in conjunction"
+                   " with compress format");
+        ret = -EINVAL;
+        goto finish;
+    }
+    if ((ret == QCOW2_COMPRESS_ZLIB && compress_level > 9) ||
+        compress_level > 0xff) {
+        error_setg(errp, "Compress level %" PRIu64 " is not supported for"
+                   " format '%s'", compress_level, compress_format_name);
+        ret = -EINVAL;
+        goto finish;
+    }
+
     ret = qcow2_create2(filename, size, backing_file, backing_fmt, flags,
                         cluster_size, prealloc, opts, version, refcount_order,
-                        &local_err);
+                        compress_format_name, compress_level, &local_err);
     error_propagate(errp, local_err);
 
 finish:
     g_free(backing_file);
     g_free(backing_fmt);
     g_free(buf);
+    g_free(compress_format_name);
     return ret;
 }
 
@@ -3458,6 +3497,19 @@  static QemuOptsList qcow2_create_opts = {
             .help = "Width of a reference count entry in bits",
             .def_value_str = "16"
         },
+        {
+            .name = BLOCK_OPT_COMPRESS_FORMAT,
+            .type = QEMU_OPT_STRING,
+            .help = "Compress format used for compressed clusters (zlib)",
+            .def_value_str = ""
+        },
+        {
+            .name = BLOCK_OPT_COMPRESS_LEVEL,
+            .type = QEMU_OPT_NUMBER,
+            .help = "Compress level used for compressed clusters (0 = default,"
+                    " 1=fastest, x=best; x varies depending on compress.format)",
+            .def_value_str = "0"
+        },
         { /* end of list */ }
     }
 };
diff --git a/block/qcow2.h b/block/qcow2.h
index 87b15eb..d21da33 100644
--- a/block/qcow2.h
+++ b/block/qcow2.h
@@ -171,6 +171,15 @@  typedef struct Qcow2UnknownHeaderExtension {
 } Qcow2UnknownHeaderExtension;
 
 enum {
+    /* QCOW2_COMPRESS_ZLIB_COMPAT specifies to use the old standard
+     * zlib compression with a smaller window size that is compatible with
+     * old QEMU versions. This compression is used if no compression format
+     * is specified at create time */
+    QCOW2_COMPRESS_ZLIB_COMPAT = 0,
+    QCOW2_COMPRESS_ZLIB        = 1,
+};
+
+enum {
     QCOW2_FEAT_TYPE_INCOMPATIBLE    = 0,
     QCOW2_FEAT_TYPE_COMPATIBLE      = 1,
     QCOW2_FEAT_TYPE_AUTOCLEAR       = 2,
diff --git a/include/block/block_int.h b/include/block/block_int.h
index 15fa602..49811b0 100644
--- a/include/block/block_int.h
+++ b/include/block/block_int.h
@@ -57,6 +57,8 @@ 
 #define BLOCK_OPT_NOCOW             "nocow"
 #define BLOCK_OPT_OBJECT_SIZE       "object_size"
 #define BLOCK_OPT_REFCOUNT_BITS     "refcount_bits"
+#define BLOCK_OPT_COMPRESS_FORMAT   "compress.format"
+#define BLOCK_OPT_COMPRESS_LEVEL    "compress.level"
 
 #define BLOCK_PROBE_BUF_SIZE        512