Make qemu-img/qemu-nbd/qemu-io CLI more flexible
v7 cover Make qemu-img/qemu-nbd/qemu-io CLI more flexible
This series of patches expands the syntax of the qemu-img, qemu-nbd and qemu-io commands to make them more flexible.
v0: https://lists.gnu.org/archive/html/qemu-devel/2015-10/msg04365.html
v1: https://lists.gnu.org/archive/html/qemu-devel/2015-12/msg04014.html
v2: https://lists.gnu.org/archive/html/qemu-devel/2015-12/msg04354.html
v3: https://lists.gnu.org/archive/html/qemu-devel/2016-01/msg03381.html
v4: https://lists.gnu.org/archive/html/qemu-devel/2016-01/msg04984.html
v5: https://lists.gnu.org/archive/html/qemu-block/2016-02/msg00022.html
v6: https://lists.gnu.org/archive/html/qemu-devel/2016-02/msg03141.html
First all three gain a --object parameter, which allows instantiation of user creatable object types. The immediate use case is to allow for creation of the 'secret' object type to pass passwords for curl, iscsi and rbd drivers. For qemu-nbd this will also be needed to create TLS certificates for encryption support.
Then all three gain a '--image-opts' parameter which causes the positional filenames to be interepreted as option strings rather tha nplain filenames. This avoids the need to use the JSON syntax, or to add custom CLI args for each block backend option that exists. The immediate use case is to allow the user to specify the ID of the 'secret' object they just created.
Finally, there are a few small cleanup patches
NB, this series will conflict with my series adding TLS support to NBD. After one of the series wins the race to merge, I will rebase the other series. I don't mind which merges first really, but the sooner the better considering the forthcoming soft-freeze and that this is a dep for several other patch series.
Changed in v7:
- Rebase to resolve conflicts vs recent NBD patches
Changed in v6:
- Add missing docs of --image-opts for qemu-nbd man page (Eric)
- Remove left over special casing of 'file' in QemuOpts (Kevin)
- Pass NULL to getopt_long when optionindex is not needed (Eric)
- Misc typos in qemu-img docs (Eric)
- Fix qemu-io logic error checking argv/argc opt bounds (Eric)
- Ensure 'id' is passed into blk_open in qemu-img (Kevin)
- Share code for doing block dev passwd prompting
Changed in v5:
- Move more common object creation code into qom/ (Kevin)
- Add missing @var{} syntax in CLI help definition (Kevin)
- Declare QemuOpts closer to time of use (Kevin)
- Directly reference registered opts instead of calling qemu_find_opts (Kevin)
- Use consistent exit/return/goto pattern in qemu-img (Kevin)
- Remove special casing of 'file' in QemuOpts handling for bdrv_open (Kevin)
- Split file file opening code out into separate method (Kevin)
Changed in v4:
- Fix error reporting when object_create fails
Changed in v3:
- Rebase to resolve with conflicts against recently merged code
- Remove use of errx()
Changed in v2:
- Share more common code in qom/object_interfaces.c to avoid duplicating so much of 'object_create' in each command
- Remove previously added '--source optstring' parameter which replaced the positional filenames, in favour of keeping the positional filenames but using a --image-opts boolean arg to change their interpretation
- Added docs for --image-opts to qemu-img man page
- Use printf instead of echo -n in examples
- Line wrap help string based on user terminal width not source code width
- Update qemu-nbd/qemu-io to use constants for options
- Update qemu-nbd to avoid overlapping option values
Daniel P. Berrange (8):
qemu-io: add support for --object command line arg
qemu-img: add support for --object command line arg
qemu-io: allow specifying image as a set of options args
qemu-nbd: allow specifying image as a set of options args
qemu-img: allow specifying image as a set of options args
qemu-nbd: don't overlap long option values with short options
qemu-nbd: use no_argument/required_argument constants
qemu-io: use no_argument/required_argument constants
qemu-img-cmds.hx | 44 +++--- qemu-img.c | 465 +++++++++++++++++++++++++++++++++++++++++++++++++------ qemu-img.texi | 14 ++ qemu-io.c | 115 +++++++++++--- qemu-nbd.c | 104 ++++++++----- qemu-nbd.texi | 7 +- 6 files changed, 627 insertions(+), 122 deletions(-)
Signature · 1 line
2.5.0
PATCH v7 1/8 qemu-io: add support for --object command line arg
Allow creation of user creatable object types with qemu-io via a new --object command line arg. This will be used to supply passwords and/or encryption keys to the various block driver backends via the recently added 'secret' object type.
# printf letmein > mypasswd.txt
# qemu-io --object secret,id=sec0,file=mypasswd.txt \
...other args...--- qemu-io.c | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+)
qemu-io.c +34 -0
@@ -18,6 +18,7 @@#include "qemu/config-file.h" #include "qemu/readline.h" #include "qapi/qmp/qstring.h" +#include "qom/object_interfaces.h" #include "sysemu/block-backend.h" #include "block/block_int.h" #include "trace/control.h"
@@ -200,6 +201,8 @@ static void usage(const char *name)"Usage: %s [-h] [-V] [-rsnm] [-f FMT] [-c STRING] ... [file]\n" "QEMU Disk exerciser\n" "\n" +" --object OBJECTDEF define an object such as 'secret' for\n" +" passwords and/or encryption keys\n" " -c, --cmd STRING execute command with its arguments\n" " from the given string\n" " -f, --format FMT specifies the block driver to use\n"
@@ -361,6 +364,20 @@ static void reenable_tty_echo(void)qemu_set_tty_echo (STDIN_FILENO , true); } +enum { +OPTION_OBJECT =256 , +}; + +static QemuOptsList qemu_object_opts = { + .name ="object" , + .implied_opt_name ="qom-type" , + .head =QTAILQ_HEAD_INITIALIZER (qemu_object_opts.head), + .desc = { + { } + }, +}; + +int main (int argc,char **argv) {int readonly =0 ;
@@ -379,6 +396,7 @@ int main(int argc, char **argv) { "discard", 1, NULL, 'd' }, { "cache", 1, NULL, 't' }, { "trace", 1, NULL, 'T' }, + { "object", 1, NULL, OPTION_OBJECT }, { NULL, 0, NULL, 0 } };int c;
@@ -395,6 +413,7 @@ int main(int argc, char **argv)qemu_init_exec_dir (argv[0 ]);module_call_init (MODULE_INIT_QOM ); +qemu_add_opts (&qemu_object_opts);bdrv_init ();while ((c =getopt_long (argc, argv, sopt, lopt, &opt_index)) !=-1 ) {
@@ -446,6 +465,14 @@ int main(int argc, char **argv)case 'h' :usage (progname);exit (0 ); +case OPTION_OBJECT : { +QemuOpts *qopts =NULL ; + qopts =qemu_opts_parse_noisily (&qemu_object_opts, + optarg, true); +if (!qopts) { +exit (1 ); + } + }break ;default :usage (progname);exit (1 );
@@ -462,6 +489,13 @@ int main(int argc, char **argv)exit (1 ); } +if (qemu_opts_foreach (&qemu_object_opts, + user_creatable_add_opts_foreach, +NULL , &local_error)) { +error_report_err (local_error); +exit (1 ); + } +/* initialize commands */ qemuio_add_command (&quit_cmd);qemuio_add_command (&open_cmd);
Signature · 1 line
2.5.0
PATCH v7 2/8 qemu-img: add support for --object command line arg
In reply to Daniel P. BerrangeAllow creation of user creatable object types with qemu-img via a new --object command line arg. This will be used to supply passwords and/or encryption keys to the various block driver backends via the recently added 'secret' object type.
# printf letmein > mypasswd.txt
# qemu-img info --object secret,id=sec0,file=mypasswd.txt \
...other info args...--- qemu-img-cmds.hx | 44 +++++----- qemu-img.c | 260 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- qemu-img.texi | 8 ++ 3 files changed, 282 insertions(+), 30 deletions(-)
qemu-img-cmds.hx +22 -22
@@ -10,68 +10,68 @@ STEXI ETEXI DEF("check", img_check, - "check [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] filename") + "check [-q] [--object objectdef] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] filename") STEXI -@item check [-q] [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] @var{filename} +@item check [--object @var{objectdef}] [-q] [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] @var{filename} ETEXI DEF("create", img_create, - "create [-q] [-f fmt] [-o options] filename [size]") + "create [-q] [--object objectdef] [-f fmt] [-o options] filename [size]") STEXI -@item create [-q] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}] +@item create [--object @var{objectdef}] [-q] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}] ETEXI DEF("commit", img_commit, - "commit [-q] [-f fmt] [-t cache] [-b base] [-d] [-p] filename") + "commit [-q] [--object objectdef] [-f fmt] [-t cache] [-b base] [-d] [-p] filename") STEXI -@item commit [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename} +@item commit [--object @var{objectdef}] [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename} ETEXI DEF("compare", img_compare, - "compare [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] filename1 filename2") + "compare [--object objectdef] [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] filename1 filename2") STEXI -@item compare [-f @var{fmt}] [-F @var{fmt}] [-T @var{src_cache}] [-p] [-q] [-s] @var{filename1} @var{filename2} +@item compare [--object @var{objectdef}] [-f @var{fmt}] [-F @var{fmt}] [-T @var{src_cache}] [-p] [-q] [-s] @var{filename1} @var{filename2} ETEXI DEF("convert", img_convert, - "convert [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-o options] [-s snapshot_id_or_name] [-l snapshot_param] [-S sparse_size] filename [filename2 [...]] output_filename") + "convert [--object objectdef] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-o options] [-s snapshot_id_or_name] [-l snapshot_param] [-S sparse_size] filename [filename2 [...]] output_filename") STEXI -@item convert [-c] [-p] [-q] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename} +@item convert [--object @var{objectdef}] [-c] [-p] [-q] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename} ETEXI DEF("info", img_info, - "info [-f fmt] [--output=ofmt] [--backing-chain] filename") + "info [--object objectdef] [-f fmt] [--output=ofmt] [--backing-chain] filename") STEXI -@item info [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] @var{filename} +@item info [--object @var{objectdef}] [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] @var{filename} ETEXI DEF("map", img_map, - "map [-f fmt] [--output=ofmt] filename") + "map [--object objectdef] [-f fmt] [--output=ofmt] filename") STEXI -@item map [-f @var{fmt}] [--output=@var{ofmt}] @var{filename} +@item map [--object @var{objectdef}] [-f @var{fmt}] [--output=@var{ofmt}] @var{filename} ETEXI DEF("snapshot", img_snapshot, - "snapshot [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename") + "snapshot [--object objectdef] [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename") STEXI -@item snapshot [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename} +@item snapshot [--object @var{objectdef}] [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename} ETEXI DEF("rebase", img_rebase, - "rebase [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename") + "rebase [--object objectdef] [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename") STEXI -@item rebase [-q] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-p] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename} +@item rebase [--object @var{objectdef}] [-q] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-p] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename} ETEXI DEF("resize", img_resize, - "resize [-q] filename [+ | -]size") + "resize [--object objectdef] [-q] filename [+ | -]size") STEXI -@item resize [-q] @var{filename} [+ | -]@var{size} +@item resize [--object @var{objectdef}] [-q] @var{filename} [+ | -]@var{size} ETEXI DEF("amend", img_amend, - "amend [-p] [-q] [-f fmt] [-t cache] -o options filename") + "amend [--object objectdef] [-p] [-q] [-f fmt] [-t cache] -o options filename") STEXI -@item amend [-p] [-q] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename} +@item amend [--object @var{objectdef}] [-p] [-q] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename} @end table ETEXI
qemu-img.c +252 -8
523 lines not on this page · raw message
qemu-img.texi +8 -0
@@ -24,6 +24,14 @@ Command parameters: @table @var @item filename is a disk image filename + +@item --object @var{objectdef} + +is a QEMU user creatable object definition. See the @code{qemu(1)} manual +page for a description of the object properties. The most common object +type is a @code{secret}, which is used to supply passwords and/or encryption +keys. + @item fmt is the disk image format. It is guessed automatically in most cases. See below for a description of the supported disk formats.
Signature · 1 line
2.5.0
PATCH v7 3/8 qemu-io: allow specifying image as a set of options args
In reply to Daniel P. BerrangeCurrently qemu-io allows an image filename to be passed on the command line, but unless using the JSON format, it does not have a way to set any options except the format eg
qemu-io https://127.0.0.1/images/centos7.iso
qemu-io /home/berrange/demo.qcow2
By contrast when using the interactive shell, it is possible to use --option with the 'open' command, or to omit the filename.
This adds a --image-opts arg that indicates that the positional filename should be interpreted as a full option string, not just a filename.
qemu-io --image-opts driver=https,url=https://127.0.0.1/images,sslverify=off qemu-io --image-opts driver=qcow2,file.filename=/home/berrange/demo.qcow2
This flag is mutually exclusive with the '-f' flag and with the '-o' flag to the 'open' command
--- qemu-io.c | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 51 insertions(+), 6 deletions(-)
qemu-io.c +51 -6
@@ -32,6 +32,7 @@ static BlockBackend *qemuio_blk;/* qemu-io commands passed using -c */ static int ncmdline;static char **cmdline; +static bool imageOpts;static ReadLineState *readline_state;
@@ -151,6 +152,10 @@ static int open_f(BlockBackend *blk, int argc, char **argv) readonly =1 ;break ;case 'o' : +if (imageOpts) { +printf ("--image-opts and 'open -o' are mutually exclusive\n" ); +return 0 ; + }if (!qemu_opts_parse_noisily (&empty_opts, optarg, false)) {qemu_opts_reset (&empty_opts);return 0 ;
@@ -166,6 +171,14 @@ static int open_f(BlockBackend *blk, int argc, char **argv) flags |=BDRV_O_RDWR ; } +if (imageOpts && (optind == argc -1 )) { +if (!qemu_opts_parse_noisily (&empty_opts, argv[optind], false)) { +qemu_opts_reset (&empty_opts); +return 0 ; + } + optind++; + } + qopts =qemu_opts_find (&empty_opts,NULL ); opts = qopts ?qemu_opts_to_qdict (qopts,NULL ) :NULL ;qemu_opts_reset (&empty_opts);
@@ -366,6 +379,7 @@ static void reenable_tty_echo(void)enum {OPTION_OBJECT =256 , +OPTION_IMAGE_OPTS =257 , };static QemuOptsList qemu_object_opts = {
@@ -378,6 +392,16 @@ static QemuOptsList qemu_object_opts = { }; +static QemuOptsList file_opts = { + .name ="file" , + .implied_opt_name ="file" , + .head =QTAILQ_HEAD_INITIALIZER (file_opts.head), + .desc = { +/* no elements => accept any params */ + {/* end of list */ } + }, +}; +int main (int argc,char **argv) {int readonly =0 ;
@@ -397,6 +421,7 @@ int main(int argc, char **argv) { "cache", 1, NULL, 't' }, { "trace", 1, NULL, 'T' }, { "object", 1, NULL, OPTION_OBJECT }, + { "image-opts", 0, NULL, OPTION_IMAGE_OPTS }, { NULL, 0, NULL, 0 } };int c;
@@ -404,6 +429,7 @@ int main(int argc, char **argv)int flags =BDRV_O_UNMAP ;Error *local_error =NULL ;QDict *opts =NULL ; +const char *format =NULL ;#ifdef CONFIG_POSIX signal (SIGPIPE ,SIG_IGN );
@@ -431,10 +457,7 @@ int main(int argc, char **argv) }break ;case 'f' : -if (!opts) { - opts =qdict_new (); - } -qdict_put (opts,"driver" ,qstring_from_str (optarg)); + format = optarg;break ;case 'c' :add_user_command (optarg);
@@ -466,13 +489,16 @@ int main(int argc, char **argv)usage (progname);exit (0 );case OPTION_OBJECT : { -QemuOpts *qopts =NULL ; +QemuOpts *qopts; qopts =qemu_opts_parse_noisily (&qemu_object_opts, optarg, true);if (!qopts) {exit (1 ); } }break ; +case OPTION_IMAGE_OPTS : + imageOpts = true; +break ;default :usage (progname);exit (1 );
@@ -484,6 +510,11 @@ int main(int argc, char **argv)exit (1 ); } +if (format && imageOpts) { +error_report ("--image-opts and -f are mutually exclusive" ); +exit (1 ); + } +if (qemu_init_main_loop (&local_error)) {error_report_err (local_error);exit (1 );
@@ -516,7 +547,21 @@ int main(int argc, char **argv) }if ((argc - optind) ==1 ) { -openfile (argv[optind], flags, opts); +if (imageOpts) { +QemuOpts *qopts =NULL ; + qopts =qemu_opts_parse_noisily (&file_opts, argv[optind], false); +if (!qopts) { +exit (1 ); + } + opts =qemu_opts_to_qdict (qopts,NULL ); +openfile (NULL , flags, opts); + }else { +if (format) { + opts =qdict_new (); +qdict_put (opts,"driver" ,qstring_from_str (format)); + } +openfile (argv[optind], flags, opts); + } }command_loop ();
Signature · 1 line
2.5.0
PATCH v7 4/8 qemu-nbd: allow specifying image as a set of options args
In reply to Daniel P. BerrangeCurrently qemu-nbd allows an image filename to be passed on the command line, but unless using the JSON format, it does not have a way to set any options except the format eg
qemu-nbd https://127.0.0.1/images/centos7.iso
qemu-nbd /home/berrange/demo.qcow2
This adds a --image-opts arg that indicates that the positional filename should be interpreted as a full option string, not just a filename.
qemu-nbd --image-opts driver=https,url=https://127.0.0.1/images,sslverify=off qemu-nbd --image-opts driver=file,filename=/home/berrange/demo.qcow2
This flag is mutually exclusive with the '-f' flag.
--- qemu-nbd.c | 43 ++++++++++++++++++++++++++++++++++++++----- qemu-nbd.texi | 7 ++++++- 2 files changed, 44 insertions(+), 6 deletions(-)
qemu-nbd.c +38 -5
@@ -43,6 +43,7 @@#define QEMU_NBD_OPT_DETECT_ZEROES 4#define QEMU_NBD_OPT_OBJECT 5#define QEMU_NBD_OPT_TLSCREDS 6 +#define QEMU_NBD_OPT_IMAGE_OPTS 7static NBDExport *exp;static bool newproto;
@@ -105,6 +106,7 @@ static void usage(const char *name)" --aio=MODE set AIO mode (native or threads)\n" " --discard=MODE set discard mode (ignore, unmap)\n" " --detect-zeroes=MODE set detect-zeroes mode (off, on, unmap)\n" +" --image-opts treat FILE as a full set of image options\n" "\n" "Report bugs to <[email protected]>\n" , name, NBD_DEFAULT_PORT, "DEVICE");
@@ -394,6 +396,16 @@ static SocketAddress *nbd_build_socket_address(const char *sockpath, } +static QemuOptsList file_opts = { + .name ="file" , + .implied_opt_name ="file" , + .head =QTAILQ_HEAD_INITIALIZER (file_opts.head), + .desc = { +/* no elements => accept any params */ + {/* end of list */ } + }, +}; +static QemuOptsList qemu_object_opts = { .name ="object" , .implied_opt_name ="qom-type" ,
@@ -475,6 +487,7 @@ int main(int argc, char **argv) { "object", 1, NULL, QEMU_NBD_OPT_OBJECT }, { "export-name", 1, NULL, 'x' }, { "tls-creds", 1, NULL, QEMU_NBD_OPT_TLSCREDS }, + { "image-opts", 0, NULL, QEMU_NBD_OPT_IMAGE_OPTS }, { NULL, 0, NULL, 0 } };int ch;
@@ -493,6 +506,7 @@ int main(int argc, char **argv)QDict *options =NULL ;const char *export_name =NULL ;const char *tlscredsid =NULL ; +bool imageOpts = false;/* The client thread uses SIGTERM to interrupt the server. A signal * handler ensures that "qemu-nbd -v -c" exits with a nice status code.
@@ -672,6 +686,9 @@ int main(int argc, char **argv)case QEMU_NBD_OPT_TLSCREDS : tlscredsid = optarg;break ; +case QEMU_NBD_OPT_IMAGE_OPTS : + imageOpts = true; +break ; } }
@@ -800,13 +817,29 @@ int main(int argc, char **argv)bdrv_init ();atexit (bdrv_close_all); -if (fmt) { - options =qdict_new (); -qdict_put (options,"driver" ,qstring_from_str (fmt)); + srcpath = argv[optind]; +if (imageOpts) { +QemuOpts *opts; +if (fmt) { +error_report ("--image-opts and -f are mutually exclusive" ); +exit (EXIT_FAILURE ); + } + opts =qemu_opts_parse_noisily (&file_opts, srcpath, true); +if (!opts) { +qemu_opts_reset (&file_opts); +exit (EXIT_FAILURE ); + } + options =qemu_opts_to_qdict (opts,NULL ); +qemu_opts_reset (&file_opts); + blk =blk_new_open ("hda" ,NULL ,NULL , options, flags, &local_err); + }else { +if (fmt) { + options =qdict_new (); +qdict_put (options,"driver" ,qstring_from_str (fmt)); + } + blk =blk_new_open ("hda" , srcpath,NULL , options, flags, &local_err); } - srcpath = argv[optind]; - blk =blk_new_open ("hda" , srcpath,NULL , options, flags, &local_err);if (!blk) {error_reportf_err (local_err,"Failed to blk_new_open '%s': " , argv[optind]);
qemu-nbd.texi +6 -1
@@ -13,7 +13,8 @@ Export a QEMU disk image using the NBD protocol. @c man end @c man begin OPTIONS -@var{filename} is a disk image filename. +@var{filename} is a disk image filename, or a set of block +driver options if @var{--image-opts} is specified. @var{dev} is an NBD device.
@@ -33,6 +34,10 @@ The offset into the image The interface to bind to (default @samp{0.0.0.0}) @item -k, --socket=@var{path} Use a unix socket with path @var{path} +@item --image-opts +Treat @var{filename} as a set of image options, instead of a plain +filename. If this flag is specified, the @var{-f} flag should +not be used, instead the '@code{format=}' option should be set. @item -f, --format=@var{fmt} Force the use of the block driver for format @var{fmt} instead of auto-detecting
Signature · 1 line
2.5.0
PATCH v7 5/8 qemu-img: allow specifying image as a set of options args
In reply to Daniel P. BerrangeCurrently qemu-img allows an image filename to be passed on the command line, but unless using the JSON format, it does not have a way to set any options except the format eg
qemu-img info https://127.0.0.1/images/centos7.iso
This adds a --image-opts arg that indicates that the positional filename should be interpreted as a full option string, not just a filename.
qemu-img info --image-opts driver=https,url=https://127.0.0.1/images,sslverify=off
This flag is mutually exclusive with the '-f' / '-F' flags.
--- qemu-img-cmds.hx | 44 ++++++------ qemu-img.c | 205 ++++++++++++++++++++++++++++++++++++++++++++----------- qemu-img.texi | 6 ++ 3 files changed, 195 insertions(+), 60 deletions(-)
qemu-img-cmds.hx +22 -22
@@ -10,68 +10,68 @@ STEXI ETEXI DEF("check", img_check, - "check [-q] [--object objectdef] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] filename") + "check [-q] [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] filename") STEXI -@item check [--object @var{objectdef}] [-q] [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] @var{filename} +@item check [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] @var{filename} ETEXI DEF("create", img_create, - "create [-q] [--object objectdef] [-f fmt] [-o options] filename [size]") + "create [-q] [--object objectdef] [--image-opts] [-f fmt] [-o options] filename [size]") STEXI -@item create [--object @var{objectdef}] [-q] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}] +@item create [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}] ETEXI DEF("commit", img_commit, - "commit [-q] [--object objectdef] [-f fmt] [-t cache] [-b base] [-d] [-p] filename") + "commit [-q] [--object objectdef] [--image-opts] [-f fmt] [-t cache] [-b base] [-d] [-p] filename") STEXI -@item commit [--object @var{objectdef}] [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename} +@item commit [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename} ETEXI DEF("compare", img_compare, - "compare [--object objectdef] [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] filename1 filename2") + "compare [--object objectdef] [--image-opts] [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] filename1 filename2") STEXI -@item compare [--object @var{objectdef}] [-f @var{fmt}] [-F @var{fmt}] [-T @var{src_cache}] [-p] [-q] [-s] @var{filename1} @var{filename2} +@item compare [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [-F @var{fmt}] [-T @var{src_cache}] [-p] [-q] [-s] @var{filename1} @var{filename2} ETEXI DEF("convert", img_convert, - "convert [--object objectdef] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-o options] [-s snapshot_id_or_name] [-l snapshot_param] [-S sparse_size] filename [filename2 [...]] output_filename") + "convert [--object objectdef] [--image-opts] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-o options] [-s snapshot_id_or_name] [-l snapshot_param] [-S sparse_size] filename [filename2 [...]] output_filename") STEXI -@item convert [--object @var{objectdef}] [-c] [-p] [-q] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename} +@item convert [--object @var{objectdef}] [--image-opts] [-c] [-p] [-q] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename} ETEXI DEF("info", img_info, - "info [--object objectdef] [-f fmt] [--output=ofmt] [--backing-chain] filename") + "info [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [--backing-chain] filename") STEXI -@item info [--object @var{objectdef}] [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] @var{filename} +@item info [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] @var{filename} ETEXI DEF("map", img_map, - "map [--object objectdef] [-f fmt] [--output=ofmt] filename") + "map [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] filename") STEXI -@item map [--object @var{objectdef}] [-f @var{fmt}] [--output=@var{ofmt}] @var{filename} +@item map [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--output=@var{ofmt}] @var{filename} ETEXI DEF("snapshot", img_snapshot, - "snapshot [--object objectdef] [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename") + "snapshot [--object objectdef] [--image-opts] [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename") STEXI -@item snapshot [--object @var{objectdef}] [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename} +@item snapshot [--object @var{objectdef}] [--image-opts] [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename} ETEXI DEF("rebase", img_rebase, - "rebase [--object objectdef] [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename") + "rebase [--object objectdef] [--image-opts] [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename") STEXI -@item rebase [--object @var{objectdef}] [-q] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-p] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename} +@item rebase [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-p] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename} ETEXI DEF("resize", img_resize, - "resize [--object objectdef] [-q] filename [+ | -]size") + "resize [--object objectdef] [--image-opts] [-q] filename [+ | -]size") STEXI -@item resize [--object @var{objectdef}] [-q] @var{filename} [+ | -]@var{size} +@item resize [--object @var{objectdef}] [--image-opts] [-q] @var{filename} [+ | -]@var{size} ETEXI DEF("amend", img_amend, - "amend [--object objectdef] [-p] [-q] [-f fmt] [-t cache] -o options filename") + "amend [--object objectdef] [--image-opts] [-p] [-q] [-f fmt] [-t cache] -o options filename") STEXI -@item amend [--object @var{objectdef}] [-p] [-q] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename} +@item amend [--object @var{objectdef}] [--image-opts] [-p] [-q] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename} @end table ETEXI
qemu-img.c +167 -38
517 lines not on this page · raw message
qemu-img.texi +6 -0
@@ -32,6 +32,12 @@ page for a description of the object properties. The most common object type is a @code{secret}, which is used to supply passwords and/or encryption keys. +@item --image-opts + +Indicates that the @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. + @item fmt is the disk image format. It is guessed automatically in most cases. See below for a description of the supported disk formats.
Signature · 1 line
2.5.0
PATCH v7 6/8 qemu-nbd: don't overlap long option values with short options
In reply to Daniel P. BerrangeWhen defining values for long options, the normal practice is to start numbering from 256, to avoid overlap with the range of valid values for short options.
--- qemu-nbd.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)
qemu-nbd.c +7 -7
@@ -37,13 +37,13 @@#include <pthread.h> #define SOCKET_PATH "/var/lock/qemu-nbd-%s" -#define QEMU_NBD_OPT_CACHE 1 -#define QEMU_NBD_OPT_AIO 2 -#define QEMU_NBD_OPT_DISCARD 3 -#define QEMU_NBD_OPT_DETECT_ZEROES 4 -#define QEMU_NBD_OPT_OBJECT 5 -#define QEMU_NBD_OPT_TLSCREDS 6 -#define QEMU_NBD_OPT_IMAGE_OPTS 7 +#define QEMU_NBD_OPT_CACHE 256 +#define QEMU_NBD_OPT_AIO 257 +#define QEMU_NBD_OPT_DISCARD 258 +#define QEMU_NBD_OPT_DETECT_ZEROES 259 +#define QEMU_NBD_OPT_OBJECT 260 +#define QEMU_NBD_OPT_TLSCREDS 261 +#define QEMU_NBD_OPT_IMAGE_OPTS 262static NBDExport *exp;static bool newproto;
Signature · 1 line
2.5.0
PATCH v7 7/8 qemu-nbd: use no_argument/required_argument constants
In reply to Daniel P. BerrangeWhen declaring the 'struct option' array, use the standard constants no_argument/required_argument, instead of magic values 0 and 1.
--- qemu-nbd.c | 51 ++++++++++++++++++++++++++------------------------- 1 file changed, 26 insertions(+), 25 deletions(-)
qemu-nbd.c +26 -25
@@ -463,31 +463,32 @@ int main(int argc, char **argv)const char *sn_id_or_name =NULL ;const char *sopt ="hVb:o:p:rsnP:c:dvk:e:f:tl:x:" ;struct option lopt[] = { - {"help" ,0 ,NULL ,'h' }, - {"version" ,0 ,NULL ,'V' }, - {"bind" ,1 ,NULL ,'b' }, - {"port" ,1 ,NULL ,'p' }, - {"socket" ,1 ,NULL ,'k' }, - {"offset" ,1 ,NULL ,'o' }, - {"read-only" ,0 ,NULL ,'r' }, - {"partition" ,1 ,NULL ,'P' }, - {"connect" ,1 ,NULL ,'c' }, - {"disconnect" ,0 ,NULL ,'d' }, - {"snapshot" ,0 ,NULL ,'s' }, - {"load-snapshot" ,1 ,NULL ,'l' }, - {"nocache" ,0 ,NULL ,'n' }, - {"cache" ,1 ,NULL ,QEMU_NBD_OPT_CACHE }, - {"aio" ,1 ,NULL ,QEMU_NBD_OPT_AIO }, - {"discard" ,1 ,NULL ,QEMU_NBD_OPT_DISCARD }, - {"detect-zeroes" ,1 ,NULL ,QEMU_NBD_OPT_DETECT_ZEROES }, - {"shared" ,1 ,NULL ,'e' }, - {"format" ,1 ,NULL ,'f' }, - {"persistent" ,0 ,NULL ,'t' }, - {"verbose" ,0 ,NULL ,'v' }, - {"object" ,1 ,NULL ,QEMU_NBD_OPT_OBJECT }, - {"export-name" ,1 ,NULL ,'x' }, - {"tls-creds" ,1 ,NULL ,QEMU_NBD_OPT_TLSCREDS }, - {"image-opts" ,0 ,NULL ,QEMU_NBD_OPT_IMAGE_OPTS }, + {"help" , no_argument,NULL ,'h' }, + {"version" , no_argument,NULL ,'V' }, + {"bind" , required_argument,NULL ,'b' }, + {"port" , required_argument,NULL ,'p' }, + {"socket" , required_argument,NULL ,'k' }, + {"offset" , required_argument,NULL ,'o' }, + {"read-only" , no_argument,NULL ,'r' }, + {"partition" , required_argument,NULL ,'P' }, + {"connect" , required_argument,NULL ,'c' }, + {"disconnect" , no_argument,NULL ,'d' }, + {"snapshot" , no_argument,NULL ,'s' }, + {"load-snapshot" , required_argument,NULL ,'l' }, + {"nocache" , no_argument,NULL ,'n' }, + {"cache" , required_argument,NULL ,QEMU_NBD_OPT_CACHE }, + {"aio" , required_argument,NULL ,QEMU_NBD_OPT_AIO }, + {"discard" , required_argument,NULL ,QEMU_NBD_OPT_DISCARD }, + {"detect-zeroes" , required_argument,NULL , +QEMU_NBD_OPT_DETECT_ZEROES }, + {"shared" , required_argument,NULL ,'e' }, + {"format" , required_argument,NULL ,'f' }, + {"persistent" , no_argument,NULL ,'t' }, + {"verbose" , no_argument,NULL ,'v' }, + {"object" , required_argument,NULL ,QEMU_NBD_OPT_OBJECT }, + {"export-name" , required_argument,NULL ,'x' }, + {"tls-creds" , required_argument,NULL ,QEMU_NBD_OPT_TLSCREDS }, + {"image-opts" , no_argument,NULL ,QEMU_NBD_OPT_IMAGE_OPTS }, {NULL ,0 ,NULL ,0 } };int ch;
Signature · 1 line
2.5.0
PATCH v7 8/8 qemu-io: use no_argument/required_argument constants
In reply to Daniel P. BerrangeWhen declaring the 'struct option' array, use the standard constants no_argument/required_argument, instead of magic values 0 and 1.
--- qemu-io.c | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-)
qemu-io.c +15 -15
@@ -407,21 +407,21 @@ int main(int argc, char **argv)int readonly =0 ;const char *sopt ="hVc:d:f:rsnmgkt:T:" ;const struct option lopt[] = { - {"help" ,0 ,NULL ,'h' }, - {"version" ,0 ,NULL ,'V' }, - {"offset" ,1 ,NULL ,'o' }, - {"cmd" ,1 ,NULL ,'c' }, - {"format" ,1 ,NULL ,'f' }, - {"read-only" ,0 ,NULL ,'r' }, - {"snapshot" ,0 ,NULL ,'s' }, - {"nocache" ,0 ,NULL ,'n' }, - {"misalign" ,0 ,NULL ,'m' }, - {"native-aio" ,0 ,NULL ,'k' }, - {"discard" ,1 ,NULL ,'d' }, - {"cache" ,1 ,NULL ,'t' }, - {"trace" ,1 ,NULL ,'T' }, - {"object" ,1 ,NULL ,OPTION_OBJECT }, - {"image-opts" ,0 ,NULL ,OPTION_IMAGE_OPTS }, + {"help" , no_argument,NULL ,'h' }, + {"version" , no_argument,NULL ,'V' }, + {"offset" , required_argument,NULL ,'o' }, + {"cmd" , required_argument,NULL ,'c' }, + {"format" , required_argument,NULL ,'f' }, + {"read-only" , no_argument,NULL ,'r' }, + {"snapshot" , no_argument,NULL ,'s' }, + {"nocache" , no_argument,NULL ,'n' }, + {"misalign" , no_argument,NULL ,'m' }, + {"native-aio" , no_argument,NULL ,'k' }, + {"discard" , required_argument,NULL ,'d' }, + {"cache" , required_argument,NULL ,'t' }, + {"trace" , required_argument,NULL ,'T' }, + {"object" , required_argument,NULL ,OPTION_OBJECT }, + {"image-opts" , no_argument,NULL ,OPTION_IMAGE_OPTS }, {NULL ,0 ,NULL ,0 } };int c;
Signature · 1 line
2.5.0
Kevin Wolf
AppliedAm 17.02.2016 um 11:10 hat Daniel P. Berrange geschrieben:
Quoted 18 lines
This series of patches expands the syntax of the qemu-img, qemu-nbd and qemu-io commands to make them more flexible.
v0: https://lists.gnu.org/archive/html/qemu-devel/2015-10/msg04365.html
v1: https://lists.gnu.org/archive/html/qemu-devel/2015-12/msg04014.html
v2: https://lists.gnu.org/archive/html/qemu-devel/2015-12/msg04354.html
v3: https://lists.gnu.org/archive/html/qemu-devel/2016-01/msg03381.html
v4: https://lists.gnu.org/archive/html/qemu-devel/2016-01/msg04984.html
v5: https://lists.gnu.org/archive/html/qemu-block/2016-02/msg00022.html
v6: https://lists.gnu.org/archive/html/qemu-devel/2016-02/msg03141.htmlFirst all three gain a --object parameter, which allows instantiation of user creatable object types. The immediate use case is to allow for creation of the 'secret' object type to pass passwords for curl, iscsi and rbd drivers. For qemu-nbd this will also be needed to create TLS certificates for encryption support.
Quoted 8 lines
Then all three gain a '--image-opts' parameter which causes the positional filenames to be interepreted as option strings rather tha nplain filenames. This avoids the need to use the JSON syntax, or to add custom CLI args for each block backend option that exists. The immediate use case is to allow the user to specify the ID of the 'secret' object they just created.
Finally, there are a few small cleanup patches
Thanks, applied to the block branch.
Kevin