blob: ad04f5956547f7d2944a7ce56eb856e664ad8aaa [file] [log] [blame]
bellardea2384d2004-08-01 21:59:26 +00001/*
bellardfb43f4d2006-08-07 21:34:46 +00002 * QEMU disk image utility
ths5fafdf22007-09-16 21:08:06 +00003 *
bellard68d0f702008-01-06 17:21:48 +00004 * Copyright (c) 2003-2008 Fabrice Bellard
ths5fafdf22007-09-16 21:08:06 +00005 *
bellardea2384d2004-08-01 21:59:26 +00006 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
Markus Armbruster452fcdb2018-02-01 12:18:39 +010024
Peter Maydell80c71a22016-01-18 18:01:42 +000025#include "qemu/osdep.h"
Eric Blakec2a3d7d2017-07-21 08:50:47 -050026#include <getopt.h>
27
Fam Zheng67a1de02016-06-01 17:44:21 +080028#include "qemu-version.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010029#include "qapi/error.h"
Markus Armbruster9af23982018-02-11 10:36:01 +010030#include "qapi/qapi-visit-block-core.h"
Daniel P. Berrangeb3db2112016-09-30 15:45:27 +010031#include "qapi/qobject-output-visitor.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010032#include "qapi/qmp/qjson.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010033#include "qapi/qmp/qdict.h"
Markus Armbrusterfc81fa12018-02-01 12:18:40 +010034#include "qapi/qmp/qstring.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020035#include "qemu/cutils.h"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000036#include "qemu/config-file.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010037#include "qemu/option.h"
38#include "qemu/error-report.h"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +030039#include "qemu/log.h"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000040#include "qom/object_interfaces.h"
Paolo Bonzini9c17d612012-12-17 18:20:04 +010041#include "sysemu/sysemu.h"
Markus Armbruster26f54e92014-10-07 13:59:04 +020042#include "sysemu/block-backend.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010043#include "block/block_int.h"
Max Reitzd4a32382014-10-24 15:57:37 +020044#include "block/blockjob.h"
Wenchao Xiaf364ec62013-05-25 11:09:44 +080045#include "block/qapi.h"
Daniel P. Berrangec2297082016-04-06 12:12:06 +010046#include "crypto/init.h"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +030047#include "trace/control.h"
bellarde8445332006-06-14 15:32:10 +000048
Thomas Huth7e563bf2018-02-15 12:06:47 +010049#define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
Thomas Huth0781dd62016-10-05 11:54:44 +020050 "\n" QEMU_COPYRIGHT "\n"
Jeff Cody5f6979c2014-04-28 14:37:18 -040051
Anthony Liguoric227f092009-10-01 16:12:16 -050052typedef struct img_cmd_t {
Stuart Brady153859b2009-06-07 00:42:17 +010053 const char *name;
54 int (*handler)(int argc, char **argv);
Anthony Liguoric227f092009-10-01 16:12:16 -050055} img_cmd_t;
Stuart Brady153859b2009-06-07 00:42:17 +010056
Federico Simoncelli8599ea42013-01-28 06:59:47 -050057enum {
58 OPTION_OUTPUT = 256,
59 OPTION_BACKING_CHAIN = 257,
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000060 OPTION_OBJECT = 258,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000061 OPTION_IMAGE_OPTS = 259,
Kevin Wolfb6495fa2015-07-10 18:09:18 +020062 OPTION_PATTERN = 260,
Kevin Wolf55d539c2016-06-03 13:59:41 +020063 OPTION_FLUSH_INTERVAL = 261,
64 OPTION_NO_DRAIN = 262,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +010065 OPTION_TARGET_IMAGE_OPTS = 263,
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +010066 OPTION_SIZE = 264,
Max Reitzdc5f6902017-06-13 22:20:55 +020067 OPTION_PREALLOCATION = 265,
Pavel Butsykin4ffca892017-09-18 15:42:27 +030068 OPTION_SHRINK = 266,
Federico Simoncelli8599ea42013-01-28 06:59:47 -050069};
70
71typedef enum OutputFormat {
72 OFORMAT_JSON,
73 OFORMAT_HUMAN,
74} OutputFormat;
75
Kevin Wolfe6996142016-03-15 13:03:11 +010076/* Default to cache=writeback as data integrity is not important for qemu-img */
Federico Simoncelli661a0f72011-06-20 12:48:19 -040077#define BDRV_DEFAULT_CACHE "writeback"
aurel32137519c2008-11-30 19:12:49 +000078
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +010079static void format_print(void *opaque, const char *name)
bellardea2384d2004-08-01 21:59:26 +000080{
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +010081 printf(" %s", name);
bellardea2384d2004-08-01 21:59:26 +000082}
83
Fam Zhengac1307a2014-04-22 13:36:11 +080084static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
85{
86 va_list ap;
87
88 error_printf("qemu-img: ");
89
90 va_start(ap, fmt);
91 error_vprintf(fmt, ap);
92 va_end(ap);
93
94 error_printf("\nTry 'qemu-img --help' for more information\n");
95 exit(EXIT_FAILURE);
96}
97
Stefan Hajnoczic9192972017-03-17 18:45:41 +080098static void QEMU_NORETURN missing_argument(const char *option)
99{
100 error_exit("missing argument for option '%s'", option);
101}
102
103static void QEMU_NORETURN unrecognized_option(const char *option)
104{
105 error_exit("unrecognized option '%s'", option);
106}
107
blueswir1d2c639d2009-01-24 18:19:25 +0000108/* Please keep in synch with qemu-img.texi */
Fam Zhengac1307a2014-04-22 13:36:11 +0800109static void QEMU_NORETURN help(void)
bellardea2384d2004-08-01 21:59:26 +0000110{
Paolo Bonzinie00291c2010-02-04 16:49:56 +0100111 const char *help_msg =
Jeff Cody5f6979c2014-04-28 14:37:18 -0400112 QEMU_IMG_VERSION
Denis V. Lunev10985132016-06-17 17:44:13 +0300113 "usage: qemu-img [standard options] command [command options]\n"
malc3f020d72010-02-08 12:04:56 +0300114 "QEMU disk image utility\n"
115 "\n"
Denis V. Lunev10985132016-06-17 17:44:13 +0300116 " '-h', '--help' display this help and exit\n"
117 " '-V', '--version' output version information and exit\n"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +0300118 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
119 " specify tracing options\n"
Denis V. Lunev10985132016-06-17 17:44:13 +0300120 "\n"
malc3f020d72010-02-08 12:04:56 +0300121 "Command syntax:\n"
Stuart Brady153859b2009-06-07 00:42:17 +0100122#define DEF(option, callback, arg_string) \
123 " " arg_string "\n"
124#include "qemu-img-cmds.h"
125#undef DEF
malc3f020d72010-02-08 12:04:56 +0300126 "\n"
127 "Command parameters:\n"
128 " 'filename' is a disk image filename\n"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000129 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
130 " manual page for a description of the object properties. The most common\n"
131 " object type is a 'secret', which is used to supply passwords and/or\n"
132 " encryption keys.\n"
malc3f020d72010-02-08 12:04:56 +0300133 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400134 " 'cache' is the cache mode used to write the output disk image, the valid\n"
Liu Yuan80ccf932012-04-20 17:10:56 +0800135 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
136 " 'directsync' and 'unsafe' (default for convert)\n"
Stefan Hajnoczibb87fdf2014-09-02 11:01:02 +0100137 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
138 " options are the same as for the 'cache' option\n"
malc3f020d72010-02-08 12:04:56 +0300139 " 'size' is the disk image size in bytes. Optional suffixes\n"
Kevin Wolf5e009842013-06-05 14:19:27 +0200140 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
141 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
142 " supported. 'b' is ignored.\n"
malc3f020d72010-02-08 12:04:56 +0300143 " 'output_filename' is the destination disk image filename\n"
144 " 'output_fmt' is the destination format\n"
145 " 'options' is a comma separated list of format specific options in a\n"
146 " name=value format. Use -o ? for an overview of the options supported by the\n"
147 " used format\n"
Wenchao Xiaef806542013-12-04 17:10:57 +0800148 " 'snapshot_param' is param used for internal snapshot, format\n"
149 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
150 " '[ID_OR_NAME]'\n"
malc3f020d72010-02-08 12:04:56 +0300151 " '-c' indicates that target image must be compressed (qcow format only)\n"
John Snow6e6e55f2017-07-17 20:34:22 -0400152 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
153 " new backing file match exactly. The image doesn't need a working\n"
154 " backing file before rebasing in this case (useful for renaming the\n"
155 " backing file). For image creation, allow creating without attempting\n"
156 " to open the backing file.\n"
malc3f020d72010-02-08 12:04:56 +0300157 " '-h' with or without a command shows this help and lists the supported formats\n"
Jes Sorensen6b837bc2011-03-30 14:16:25 +0200158 " '-p' show progress of command (only certain commands)\n"
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100159 " '-q' use Quiet mode - do not print any output (except errors)\n"
Peter Lieven11b66992013-10-24 12:07:05 +0200160 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
161 " contain only zeros for qemu-img to create a sparse image during\n"
162 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
163 " unallocated or zero sectors, and the destination image will always be\n"
164 " fully allocated\n"
Benoît Canetc054b3f2012-09-05 13:09:02 +0200165 " '--output' takes the format in which the output must be done (human or json)\n"
Alexandre Derumierb2e10492013-09-02 19:07:24 +0100166 " '-n' skips the target volume creation (useful if the volume is created\n"
167 " prior to running qemu-img)\n"
malc3f020d72010-02-08 12:04:56 +0300168 "\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200169 "Parameters to check subcommand:\n"
170 " '-r' tries to repair any inconsistencies that are found during the check.\n"
171 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
172 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
Stefan Weil0546b8c2012-08-10 22:03:25 +0200173 " hiding corruption that has already occurred.\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200174 "\n"
Peter Lieven2d9187b2017-02-28 13:40:07 +0100175 "Parameters to convert subcommand:\n"
176 " '-m' specifies how many coroutines work in parallel during the convert\n"
177 " process (defaults to 8)\n"
178 " '-W' allow to write to the target out of order rather than sequential\n"
179 "\n"
malc3f020d72010-02-08 12:04:56 +0300180 "Parameters to snapshot subcommand:\n"
181 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
182 " '-a' applies a snapshot (revert disk to saved state)\n"
183 " '-c' creates a snapshot\n"
184 " '-d' deletes a snapshot\n"
Miroslav Rezaninad14ed182013-02-13 09:09:41 +0100185 " '-l' lists all snapshots in the given image\n"
186 "\n"
187 "Parameters to compare subcommand:\n"
188 " '-f' first image format\n"
189 " '-F' second image format\n"
Reda Sallahi86ce1f62016-08-10 04:43:12 +0200190 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
191 "\n"
192 "Parameters to dd subcommand:\n"
193 " 'bs=BYTES' read and write up to BYTES bytes at a time "
194 "(default: 512)\n"
195 " 'count=N' copy only N input blocks\n"
196 " 'if=FILE' read from FILE\n"
Reda Sallahif7c15532016-08-10 16:16:09 +0200197 " 'of=FILE' write to FILE\n"
198 " 'skip=N' skip N bs-sized blocks at the start of input\n";
Paolo Bonzinie00291c2010-02-04 16:49:56 +0100199
200 printf("%s\nSupported formats:", help_msg);
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +0100201 bdrv_iterate_format(format_print, NULL);
Eric Blakef5048cb2017-08-03 11:33:53 -0500202 printf("\n\n" QEMU_HELP_BOTTOM "\n");
Fam Zhengac1307a2014-04-22 13:36:11 +0800203 exit(EXIT_SUCCESS);
bellardea2384d2004-08-01 21:59:26 +0000204}
205
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000206static QemuOptsList qemu_object_opts = {
207 .name = "object",
208 .implied_opt_name = "qom-type",
209 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
210 .desc = {
211 { }
212 },
213};
214
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000215static QemuOptsList qemu_source_opts = {
216 .name = "source",
217 .implied_opt_name = "file",
218 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
219 .desc = {
220 { }
221 },
222};
223
Stefan Weil7c30f652013-06-16 17:01:05 +0200224static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100225{
226 int ret = 0;
227 if (!quiet) {
228 va_list args;
229 va_start(args, fmt);
230 ret = vprintf(fmt, args);
231 va_end(args);
232 }
233 return ret;
234}
235
bellardea2384d2004-08-01 21:59:26 +0000236
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100237static int print_block_option_help(const char *filename, const char *fmt)
238{
239 BlockDriver *drv, *proto_drv;
Chunyan Liu83d05212014-06-05 17:20:51 +0800240 QemuOptsList *create_opts = NULL;
Max Reitzb65a5e12015-02-05 13:58:12 -0500241 Error *local_err = NULL;
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100242
243 /* Find driver and parse its options */
244 drv = bdrv_find_format(fmt);
245 if (!drv) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100246 error_report("Unknown file format '%s'", fmt);
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100247 return 1;
248 }
249
Max Reitzd402b6a2018-05-09 23:00:21 +0200250 if (!drv->create_opts) {
251 error_report("Format driver '%s' does not support image creation", fmt);
252 return 1;
253 }
254
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800255 create_opts = qemu_opts_append(create_opts, drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100256 if (filename) {
Max Reitzb65a5e12015-02-05 13:58:12 -0500257 proto_drv = bdrv_find_protocol(filename, true, &local_err);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100258 if (!proto_drv) {
Markus Armbruster2867ce42015-03-12 16:08:02 +0100259 error_report_err(local_err);
Chunyan Liu83d05212014-06-05 17:20:51 +0800260 qemu_opts_free(create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100261 return 1;
262 }
Max Reitzd402b6a2018-05-09 23:00:21 +0200263 if (!proto_drv->create_opts) {
Max Reitzf0998872018-11-19 11:19:20 +0100264 error_report("Protocol driver '%s' does not support image creation",
Max Reitzd402b6a2018-05-09 23:00:21 +0200265 proto_drv->format_name);
Max Reitz3ecd5a42018-11-19 11:19:21 +0100266 qemu_opts_free(create_opts);
Max Reitzd402b6a2018-05-09 23:00:21 +0200267 return 1;
268 }
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800269 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100270 }
271
Max Reitz7f3fb002018-05-09 23:00:19 +0200272 printf("Supported options:\n");
Max Reitz63898712018-10-19 18:49:25 +0200273 qemu_opts_print_help(create_opts, false);
Chunyan Liu83d05212014-06-05 17:20:51 +0800274 qemu_opts_free(create_opts);
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100275 return 0;
276}
277
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000278
Max Reitzefaa7c42016-03-16 19:54:38 +0100279static BlockBackend *img_open_opts(const char *optstr,
Kevin Wolfce099542016-03-15 13:01:04 +0100280 QemuOpts *opts, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800281 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000282{
283 QDict *options;
284 Error *local_err = NULL;
285 BlockBackend *blk;
286 options = qemu_opts_to_qdict(opts, NULL);
Fam Zheng335e9932017-05-03 00:35:39 +0800287 if (force_share) {
288 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
Max Reitz4615f872018-05-02 22:20:50 +0200289 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
Fam Zheng335e9932017-05-03 00:35:39 +0800290 error_report("--force-share/-U conflicts with image options");
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200291 qobject_unref(options);
Fam Zheng335e9932017-05-03 00:35:39 +0800292 return NULL;
293 }
Max Reitz4615f872018-05-02 22:20:50 +0200294 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
Fam Zheng335e9932017-05-03 00:35:39 +0800295 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100296 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000297 if (!blk) {
Daniel P. Berrange143605a2016-04-06 10:16:18 +0100298 error_reportf_err(local_err, "Could not open '%s': ", optstr);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000299 return NULL;
300 }
Kevin Wolfce099542016-03-15 13:01:04 +0100301 blk_set_enable_write_cache(blk, !writethrough);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000302
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000303 return blk;
304}
305
Max Reitzefaa7c42016-03-16 19:54:38 +0100306static BlockBackend *img_open_file(const char *filename,
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100307 QDict *options,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000308 const char *fmt, int flags,
Fam Zheng335e9932017-05-03 00:35:39 +0800309 bool writethrough, bool quiet,
310 bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000311{
312 BlockBackend *blk;
Max Reitz34b5d2c2013-09-05 14:45:29 +0200313 Error *local_err = NULL;
Kevin Wolfad717132010-12-16 15:37:41 +0100314
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100315 if (!options) {
316 options = qdict_new();
317 }
bellard75c23802004-08-27 21:28:58 +0000318 if (fmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -0500319 qdict_put_str(options, "driver", fmt);
bellard75c23802004-08-27 21:28:58 +0000320 }
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100321
Fam Zheng335e9932017-05-03 00:35:39 +0800322 if (force_share) {
Eric Blake579cf1d2017-05-15 14:54:39 -0500323 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Fam Zheng335e9932017-05-03 00:35:39 +0800324 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100325 blk = blk_new_open(filename, NULL, options, flags, &local_err);
Max Reitz5bd31322015-02-05 13:58:16 -0500326 if (!blk) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100327 error_reportf_err(local_err, "Could not open '%s': ", filename);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000328 return NULL;
bellard75c23802004-08-27 21:28:58 +0000329 }
Kevin Wolfce099542016-03-15 13:01:04 +0100330 blk_set_enable_write_cache(blk, !writethrough);
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100331
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200332 return blk;
bellard75c23802004-08-27 21:28:58 +0000333}
334
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000335
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100336static int img_add_key_secrets(void *opaque,
337 const char *name, const char *value,
338 Error **errp)
339{
340 QDict *options = opaque;
341
342 if (g_str_has_suffix(name, "key-secret")) {
Eric Blake187f47e2017-06-24 12:10:07 -0600343 qdict_put_str(options, name, value);
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100344 }
345
346 return 0;
347}
348
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100349
Max Reitzefaa7c42016-03-16 19:54:38 +0100350static BlockBackend *img_open(bool image_opts,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000351 const char *filename,
Kevin Wolfce099542016-03-15 13:01:04 +0100352 const char *fmt, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800353 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000354{
355 BlockBackend *blk;
356 if (image_opts) {
357 QemuOpts *opts;
358 if (fmt) {
359 error_report("--image-opts and --format are mutually exclusive");
360 return NULL;
361 }
362 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
363 filename, true);
364 if (!opts) {
365 return NULL;
366 }
Fam Zheng335e9932017-05-03 00:35:39 +0800367 blk = img_open_opts(filename, opts, flags, writethrough, quiet,
368 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000369 } else {
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100370 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
Fam Zheng335e9932017-05-03 00:35:39 +0800371 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000372 }
373 return blk;
374}
375
376
Chunyan Liu83d05212014-06-05 17:20:51 +0800377static int add_old_style_options(const char *fmt, QemuOpts *opts,
Jes Sorenseneec77d92010-12-07 17:44:34 +0100378 const char *base_filename,
379 const char *base_fmt)
Kevin Wolfefa84d42009-05-18 16:42:12 +0200380{
Markus Armbruster6750e792015-02-12 17:43:08 +0100381 Error *err = NULL;
382
Kevin Wolfefa84d42009-05-18 16:42:12 +0200383 if (base_filename) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100384 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +0100385 if (err) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100386 error_report("Backing file not supported for file format '%s'",
387 fmt);
Markus Armbruster6750e792015-02-12 17:43:08 +0100388 error_free(err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900389 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200390 }
391 }
392 if (base_fmt) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100393 qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +0100394 if (err) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100395 error_report("Backing file format not supported for file "
396 "format '%s'", fmt);
Markus Armbruster6750e792015-02-12 17:43:08 +0100397 error_free(err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900398 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200399 }
400 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900401 return 0;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200402}
403
Markus Armbruster606caa02017-02-21 21:14:04 +0100404static int64_t cvtnum(const char *s)
405{
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100406 int err;
Markus Armbrusterf46bfdb2017-02-21 21:14:07 +0100407 uint64_t value;
Markus Armbruster606caa02017-02-21 21:14:04 +0100408
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100409 err = qemu_strtosz(s, NULL, &value);
410 if (err < 0) {
411 return err;
412 }
Markus Armbrusterf46bfdb2017-02-21 21:14:07 +0100413 if (value > INT64_MAX) {
414 return -ERANGE;
415 }
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100416 return value;
Markus Armbruster606caa02017-02-21 21:14:04 +0100417}
418
bellardea2384d2004-08-01 21:59:26 +0000419static int img_create(int argc, char **argv)
420{
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200421 int c;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100422 uint64_t img_size = -1;
bellardea2384d2004-08-01 21:59:26 +0000423 const char *fmt = "raw";
aliguori9230eaf2009-03-28 17:55:19 +0000424 const char *base_fmt = NULL;
bellardea2384d2004-08-01 21:59:26 +0000425 const char *filename;
426 const char *base_filename = NULL;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200427 char *options = NULL;
Luiz Capitulino9b375252012-11-30 10:52:05 -0200428 Error *local_err = NULL;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100429 bool quiet = false;
John Snow6e6e55f2017-07-17 20:34:22 -0400430 int flags = 0;
ths3b46e622007-09-17 08:09:54 +0000431
bellardea2384d2004-08-01 21:59:26 +0000432 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000433 static const struct option long_options[] = {
434 {"help", no_argument, 0, 'h'},
435 {"object", required_argument, 0, OPTION_OBJECT},
436 {0, 0, 0, 0}
437 };
John Snow6e6e55f2017-07-17 20:34:22 -0400438 c = getopt_long(argc, argv, ":F:b:f:ho:qu",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000439 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100440 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000441 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100442 }
bellardea2384d2004-08-01 21:59:26 +0000443 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800444 case ':':
445 missing_argument(argv[optind - 1]);
446 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100447 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800448 unrecognized_option(argv[optind - 1]);
449 break;
bellardea2384d2004-08-01 21:59:26 +0000450 case 'h':
451 help();
452 break;
aliguori9230eaf2009-03-28 17:55:19 +0000453 case 'F':
454 base_fmt = optarg;
455 break;
bellardea2384d2004-08-01 21:59:26 +0000456 case 'b':
457 base_filename = optarg;
458 break;
459 case 'f':
460 fmt = optarg;
461 break;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200462 case 'o':
Kevin Wolf77386bf2014-02-21 16:24:04 +0100463 if (!is_valid_option_list(optarg)) {
464 error_report("Invalid option list: %s", optarg);
465 goto fail;
466 }
467 if (!options) {
468 options = g_strdup(optarg);
469 } else {
470 char *old_options = options;
471 options = g_strdup_printf("%s,%s", options, optarg);
472 g_free(old_options);
473 }
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200474 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100475 case 'q':
476 quiet = true;
477 break;
John Snow6e6e55f2017-07-17 20:34:22 -0400478 case 'u':
479 flags |= BDRV_O_NO_BACKING;
480 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000481 case OPTION_OBJECT: {
482 QemuOpts *opts;
483 opts = qemu_opts_parse_noisily(&qemu_object_opts,
484 optarg, true);
485 if (!opts) {
486 goto fail;
487 }
488 } break;
bellardea2384d2004-08-01 21:59:26 +0000489 }
490 }
aliguori9230eaf2009-03-28 17:55:19 +0000491
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900492 /* Get the filename */
Kevin Wolfa283cb62014-02-21 16:24:07 +0100493 filename = (optind < argc) ? argv[optind] : NULL;
494 if (options && has_help_option(options)) {
495 g_free(options);
496 return print_block_option_help(filename, fmt);
497 }
498
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100499 if (optind >= argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800500 error_exit("Expecting image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100501 }
Kevin Wolfa283cb62014-02-21 16:24:07 +0100502 optind++;
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900503
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000504 if (qemu_opts_foreach(&qemu_object_opts,
505 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +0200506 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000507 goto fail;
508 }
509
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100510 /* Get image size, if specified */
511 if (optind < argc) {
Jes Sorensen70b4f4b2011-01-05 11:41:02 +0100512 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +0100513
514 sval = cvtnum(argv[optind++]);
515 if (sval < 0) {
liguang79443392012-12-17 09:49:23 +0800516 if (sval == -ERANGE) {
517 error_report("Image size must be less than 8 EiB!");
518 } else {
519 error_report("Invalid image size specified! You may use k, M, "
Kevin Wolf5e009842013-06-05 14:19:27 +0200520 "G, T, P or E suffixes for ");
521 error_report("kilobytes, megabytes, gigabytes, terabytes, "
522 "petabytes and exabytes.");
liguang79443392012-12-17 09:49:23 +0800523 }
Kevin Wolf77386bf2014-02-21 16:24:04 +0100524 goto fail;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100525 }
526 img_size = (uint64_t)sval;
527 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200528 if (optind != argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800529 error_exit("Unexpected argument: %s", argv[optind]);
Kevin Wolffc11eb22013-08-05 10:53:04 +0200530 }
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100531
Luiz Capitulino9b375252012-11-30 10:52:05 -0200532 bdrv_img_create(filename, fmt, base_filename, base_fmt,
John Snow6e6e55f2017-07-17 20:34:22 -0400533 options, img_size, flags, quiet, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100534 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100535 error_reportf_err(local_err, "%s: ", filename);
Kevin Wolf77386bf2014-02-21 16:24:04 +0100536 goto fail;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900537 }
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200538
Kevin Wolf77386bf2014-02-21 16:24:04 +0100539 g_free(options);
bellardea2384d2004-08-01 21:59:26 +0000540 return 0;
Kevin Wolf77386bf2014-02-21 16:24:04 +0100541
542fail:
543 g_free(options);
544 return 1;
bellardea2384d2004-08-01 21:59:26 +0000545}
546
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100547static void dump_json_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500548{
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500549 QString *str;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500550 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +0100551 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600552
553 visit_type_ImageCheck(v, NULL, &check, &error_abort);
554 visit_complete(v, &obj);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500555 str = qobject_to_json_pretty(obj);
556 assert(str != NULL);
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100557 qprintf(quiet, "%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200558 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600559 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200560 qobject_unref(str);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500561}
562
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100563static void dump_human_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500564{
565 if (!(check->corruptions || check->leaks || check->check_errors)) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100566 qprintf(quiet, "No errors were found on the image.\n");
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500567 } else {
568 if (check->corruptions) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100569 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
570 "Data may be corrupted, or further writes to the image "
571 "may corrupt it.\n",
572 check->corruptions);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500573 }
574
575 if (check->leaks) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100576 qprintf(quiet,
577 "\n%" PRId64 " leaked clusters were found on the image.\n"
578 "This means waste of disk space, but no harm to data.\n",
579 check->leaks);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500580 }
581
582 if (check->check_errors) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100583 qprintf(quiet,
584 "\n%" PRId64
585 " internal errors have occurred during the check.\n",
586 check->check_errors);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500587 }
588 }
589
590 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100591 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
592 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
593 check->allocated_clusters, check->total_clusters,
594 check->allocated_clusters * 100.0 / check->total_clusters,
595 check->fragmented_clusters * 100.0 / check->allocated_clusters,
596 check->compressed_clusters * 100.0 /
597 check->allocated_clusters);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500598 }
599
600 if (check->image_end_offset) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100601 qprintf(quiet,
602 "Image end offset: %" PRId64 "\n", check->image_end_offset);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500603 }
604}
605
606static int collect_image_check(BlockDriverState *bs,
607 ImageCheck *check,
608 const char *filename,
609 const char *fmt,
610 int fix)
611{
612 int ret;
613 BdrvCheckResult result;
614
615 ret = bdrv_check(bs, &result, fix);
616 if (ret < 0) {
617 return ret;
618 }
619
620 check->filename = g_strdup(filename);
621 check->format = g_strdup(bdrv_get_format_name(bs));
622 check->check_errors = result.check_errors;
623 check->corruptions = result.corruptions;
624 check->has_corruptions = result.corruptions != 0;
625 check->leaks = result.leaks;
626 check->has_leaks = result.leaks != 0;
627 check->corruptions_fixed = result.corruptions_fixed;
628 check->has_corruptions_fixed = result.corruptions != 0;
629 check->leaks_fixed = result.leaks_fixed;
630 check->has_leaks_fixed = result.leaks != 0;
631 check->image_end_offset = result.image_end_offset;
632 check->has_image_end_offset = result.image_end_offset != 0;
633 check->total_clusters = result.bfi.total_clusters;
634 check->has_total_clusters = result.bfi.total_clusters != 0;
635 check->allocated_clusters = result.bfi.allocated_clusters;
636 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
637 check->fragmented_clusters = result.bfi.fragmented_clusters;
638 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
Stefan Hajnoczie6439d72013-02-07 17:15:04 +0100639 check->compressed_clusters = result.bfi.compressed_clusters;
640 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500641
642 return 0;
643}
644
Kevin Wolfe076f332010-06-29 11:43:13 +0200645/*
646 * Checks an image for consistency. Exit codes:
647 *
Max Reitzd6635c42014-06-02 22:15:21 +0200648 * 0 - Check completed, image is good
649 * 1 - Check not completed because of internal errors
650 * 2 - Check completed, image is corrupted
651 * 3 - Check completed, image has leaked clusters, but is good otherwise
652 * 63 - Checks are not supported by the image format
Kevin Wolfe076f332010-06-29 11:43:13 +0200653 */
aliguori15859692009-04-21 23:11:53 +0000654static int img_check(int argc, char **argv)
655{
656 int c, ret;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500657 OutputFormat output_format = OFORMAT_HUMAN;
Max Reitz40055952014-07-22 22:58:42 +0200658 const char *filename, *fmt, *output, *cache;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200659 BlockBackend *blk;
aliguori15859692009-04-21 23:11:53 +0000660 BlockDriverState *bs;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200661 int fix = 0;
Kevin Wolfce099542016-03-15 13:01:04 +0100662 int flags = BDRV_O_CHECK;
663 bool writethrough;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200664 ImageCheck *check;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100665 bool quiet = false;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000666 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +0800667 bool force_share = false;
aliguori15859692009-04-21 23:11:53 +0000668
669 fmt = NULL;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500670 output = NULL;
Max Reitz40055952014-07-22 22:58:42 +0200671 cache = BDRV_DEFAULT_CACHE;
Kevin Wolfce099542016-03-15 13:01:04 +0100672
aliguori15859692009-04-21 23:11:53 +0000673 for(;;) {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500674 int option_index = 0;
675 static const struct option long_options[] = {
676 {"help", no_argument, 0, 'h'},
677 {"format", required_argument, 0, 'f'},
Prasad Joshi4fd6a982014-03-25 00:08:54 +0530678 {"repair", required_argument, 0, 'r'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500679 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000680 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000681 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +0800682 {"force-share", no_argument, 0, 'U'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500683 {0, 0, 0, 0}
684 };
Fam Zheng335e9932017-05-03 00:35:39 +0800685 c = getopt_long(argc, argv, ":hf:r:T:qU",
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500686 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100687 if (c == -1) {
aliguori15859692009-04-21 23:11:53 +0000688 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100689 }
aliguori15859692009-04-21 23:11:53 +0000690 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800691 case ':':
692 missing_argument(argv[optind - 1]);
693 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100694 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800695 unrecognized_option(argv[optind - 1]);
696 break;
aliguori15859692009-04-21 23:11:53 +0000697 case 'h':
698 help();
699 break;
700 case 'f':
701 fmt = optarg;
702 break;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200703 case 'r':
704 flags |= BDRV_O_RDWR;
705
706 if (!strcmp(optarg, "leaks")) {
707 fix = BDRV_FIX_LEAKS;
708 } else if (!strcmp(optarg, "all")) {
709 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
710 } else {
Fam Zhengac1307a2014-04-22 13:36:11 +0800711 error_exit("Unknown option value for -r "
712 "(expecting 'leaks' or 'all'): %s", optarg);
Kevin Wolf4534ff52012-05-11 16:07:02 +0200713 }
714 break;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500715 case OPTION_OUTPUT:
716 output = optarg;
717 break;
Max Reitz40055952014-07-22 22:58:42 +0200718 case 'T':
719 cache = optarg;
720 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100721 case 'q':
722 quiet = true;
723 break;
Fam Zheng335e9932017-05-03 00:35:39 +0800724 case 'U':
725 force_share = true;
726 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000727 case OPTION_OBJECT: {
728 QemuOpts *opts;
729 opts = qemu_opts_parse_noisily(&qemu_object_opts,
730 optarg, true);
731 if (!opts) {
732 return 1;
733 }
734 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000735 case OPTION_IMAGE_OPTS:
736 image_opts = true;
737 break;
aliguori15859692009-04-21 23:11:53 +0000738 }
739 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200740 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800741 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100742 }
aliguori15859692009-04-21 23:11:53 +0000743 filename = argv[optind++];
744
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500745 if (output && !strcmp(output, "json")) {
746 output_format = OFORMAT_JSON;
747 } else if (output && !strcmp(output, "human")) {
748 output_format = OFORMAT_HUMAN;
749 } else if (output) {
750 error_report("--output must be used with human or json as argument.");
751 return 1;
752 }
753
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000754 if (qemu_opts_foreach(&qemu_object_opts,
755 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +0200756 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000757 return 1;
758 }
759
Kevin Wolfce099542016-03-15 13:01:04 +0100760 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +0200761 if (ret < 0) {
762 error_report("Invalid source cache option: %s", cache);
763 return 1;
764 }
765
Fam Zheng335e9932017-05-03 00:35:39 +0800766 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
767 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200768 if (!blk) {
769 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900770 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200771 bs = blk_bs(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500772
773 check = g_new0(ImageCheck, 1);
774 ret = collect_image_check(bs, check, filename, fmt, fix);
Kevin Wolfe076f332010-06-29 11:43:13 +0200775
776 if (ret == -ENOTSUP) {
Max Reitz55d492d2014-05-31 21:33:30 +0200777 error_report("This image format does not support checks");
Peter Lievenfefddf92013-10-24 08:53:34 +0200778 ret = 63;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500779 goto fail;
Kevin Wolfe076f332010-06-29 11:43:13 +0200780 }
781
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500782 if (check->corruptions_fixed || check->leaks_fixed) {
783 int corruptions_fixed, leaks_fixed;
784
785 leaks_fixed = check->leaks_fixed;
786 corruptions_fixed = check->corruptions_fixed;
787
788 if (output_format == OFORMAT_HUMAN) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100789 qprintf(quiet,
790 "The following inconsistencies were found and repaired:\n\n"
791 " %" PRId64 " leaked clusters\n"
792 " %" PRId64 " corruptions\n\n"
793 "Double checking the fixed image now...\n",
794 check->leaks_fixed,
795 check->corruptions_fixed);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500796 }
797
798 ret = collect_image_check(bs, check, filename, fmt, 0);
799
800 check->leaks_fixed = leaks_fixed;
801 check->corruptions_fixed = corruptions_fixed;
Kevin Wolfccf34712012-05-11 18:16:54 +0200802 }
803
Max Reitz832390a2014-10-23 15:29:12 +0200804 if (!ret) {
805 switch (output_format) {
806 case OFORMAT_HUMAN:
807 dump_human_image_check(check, quiet);
808 break;
809 case OFORMAT_JSON:
810 dump_json_image_check(check, quiet);
811 break;
812 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500813 }
814
815 if (ret || check->check_errors) {
Max Reitz832390a2014-10-23 15:29:12 +0200816 if (ret) {
817 error_report("Check failed: %s", strerror(-ret));
818 } else {
819 error_report("Check failed");
820 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500821 ret = 1;
822 goto fail;
823 }
824
825 if (check->corruptions) {
826 ret = 2;
827 } else if (check->leaks) {
828 ret = 3;
Kevin Wolfe076f332010-06-29 11:43:13 +0200829 } else {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500830 ret = 0;
aliguori15859692009-04-21 23:11:53 +0000831 }
832
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500833fail:
834 qapi_free_ImageCheck(check);
Markus Armbruster26f54e92014-10-07 13:59:04 +0200835 blk_unref(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500836 return ret;
aliguori15859692009-04-21 23:11:53 +0000837}
838
Max Reitzd4a32382014-10-24 15:57:37 +0200839typedef struct CommonBlockJobCBInfo {
840 BlockDriverState *bs;
841 Error **errp;
842} CommonBlockJobCBInfo;
843
844static void common_block_job_cb(void *opaque, int ret)
845{
846 CommonBlockJobCBInfo *cbi = opaque;
847
848 if (ret < 0) {
849 error_setg_errno(cbi->errp, -ret, "Block job failed");
850 }
Max Reitzd4a32382014-10-24 15:57:37 +0200851}
852
853static void run_block_job(BlockJob *job, Error **errp)
854{
Kevin Wolfb75536c2016-04-18 17:30:17 +0200855 AioContext *aio_context = blk_get_aio_context(job->blk);
sochin.jiang4172a002017-06-15 14:47:33 +0800856 int ret = 0;
Max Reitzd4a32382014-10-24 15:57:37 +0200857
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200858 aio_context_acquire(aio_context);
Kevin Wolf80fa2c72018-04-13 18:50:05 +0200859 job_ref(&job->job);
Max Reitzd4a32382014-10-24 15:57:37 +0200860 do {
Kevin Wolf30a5c882018-05-04 12:17:20 +0200861 float progress = 0.0f;
Max Reitzd4a32382014-10-24 15:57:37 +0200862 aio_poll(aio_context, true);
Kevin Wolf30a5c882018-05-04 12:17:20 +0200863 if (job->job.progress_total) {
864 progress = (float)job->job.progress_current /
865 job->job.progress_total * 100.f;
866 }
867 qemu_progress_print(progress, 0);
Kevin Wolfdf956ae2018-04-25 15:09:58 +0200868 } while (!job_is_ready(&job->job) && !job_is_completed(&job->job));
Max Reitzd4a32382014-10-24 15:57:37 +0200869
Kevin Wolfdbe5e6c2018-04-19 13:04:01 +0200870 if (!job_is_completed(&job->job)) {
Kevin Wolf3d70ff52018-04-24 16:13:52 +0200871 ret = job_complete_sync(&job->job, errp);
sochin.jiang4172a002017-06-15 14:47:33 +0800872 } else {
Kevin Wolf4ad35182018-04-19 17:30:16 +0200873 ret = job->job.ret;
sochin.jiang4172a002017-06-15 14:47:33 +0800874 }
Kevin Wolf80fa2c72018-04-13 18:50:05 +0200875 job_unref(&job->job);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200876 aio_context_release(aio_context);
Max Reitz687fa1d2014-10-24 15:57:39 +0200877
sochin.jiang4172a002017-06-15 14:47:33 +0800878 /* publish completion progress only when success */
879 if (!ret) {
880 qemu_progress_print(100.f, 0);
881 }
Max Reitzd4a32382014-10-24 15:57:37 +0200882}
883
bellardea2384d2004-08-01 21:59:26 +0000884static int img_commit(int argc, char **argv)
885{
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400886 int c, ret, flags;
Max Reitz1b22bff2014-10-24 15:57:40 +0200887 const char *filename, *fmt, *cache, *base;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200888 BlockBackend *blk;
Max Reitzd4a32382014-10-24 15:57:37 +0200889 BlockDriverState *bs, *base_bs;
Kevin Wolf4ef85a92017-01-25 19:16:34 +0100890 BlockJob *job;
Max Reitz687fa1d2014-10-24 15:57:39 +0200891 bool progress = false, quiet = false, drop = false;
Kevin Wolfce099542016-03-15 13:01:04 +0100892 bool writethrough;
Max Reitzd4a32382014-10-24 15:57:37 +0200893 Error *local_err = NULL;
894 CommonBlockJobCBInfo cbi;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000895 bool image_opts = false;
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200896 AioContext *aio_context;
bellardea2384d2004-08-01 21:59:26 +0000897
898 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400899 cache = BDRV_DEFAULT_CACHE;
Max Reitz1b22bff2014-10-24 15:57:40 +0200900 base = NULL;
bellardea2384d2004-08-01 21:59:26 +0000901 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000902 static const struct option long_options[] = {
903 {"help", no_argument, 0, 'h'},
904 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000905 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000906 {0, 0, 0, 0}
907 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800908 c = getopt_long(argc, argv, ":f:ht:b:dpq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000909 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100910 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000911 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100912 }
bellardea2384d2004-08-01 21:59:26 +0000913 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800914 case ':':
915 missing_argument(argv[optind - 1]);
916 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100917 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800918 unrecognized_option(argv[optind - 1]);
919 break;
bellardea2384d2004-08-01 21:59:26 +0000920 case 'h':
921 help();
922 break;
923 case 'f':
924 fmt = optarg;
925 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400926 case 't':
927 cache = optarg;
928 break;
Max Reitz1b22bff2014-10-24 15:57:40 +0200929 case 'b':
930 base = optarg;
931 /* -b implies -d */
932 drop = true;
933 break;
Max Reitz9a86fe42014-10-24 15:57:38 +0200934 case 'd':
935 drop = true;
936 break;
Max Reitz687fa1d2014-10-24 15:57:39 +0200937 case 'p':
938 progress = true;
939 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100940 case 'q':
941 quiet = true;
942 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000943 case OPTION_OBJECT: {
944 QemuOpts *opts;
945 opts = qemu_opts_parse_noisily(&qemu_object_opts,
946 optarg, true);
947 if (!opts) {
948 return 1;
949 }
950 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000951 case OPTION_IMAGE_OPTS:
952 image_opts = true;
953 break;
bellardea2384d2004-08-01 21:59:26 +0000954 }
955 }
Max Reitz687fa1d2014-10-24 15:57:39 +0200956
957 /* Progress is not shown in Quiet mode */
958 if (quiet) {
959 progress = false;
960 }
961
Kevin Wolffc11eb22013-08-05 10:53:04 +0200962 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800963 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100964 }
bellardea2384d2004-08-01 21:59:26 +0000965 filename = argv[optind++];
966
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000967 if (qemu_opts_foreach(&qemu_object_opts,
968 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +0200969 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000970 return 1;
971 }
972
Max Reitz9a86fe42014-10-24 15:57:38 +0200973 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
Kevin Wolfce099542016-03-15 13:01:04 +0100974 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400975 if (ret < 0) {
976 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczia3981eb2014-08-26 19:17:54 +0100977 return 1;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400978 }
979
Fam Zheng335e9932017-05-03 00:35:39 +0800980 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
981 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200982 if (!blk) {
983 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900984 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200985 bs = blk_bs(blk);
986
Max Reitz687fa1d2014-10-24 15:57:39 +0200987 qemu_progress_init(progress, 1.f);
988 qemu_progress_print(0.f, 100);
989
Max Reitz1b22bff2014-10-24 15:57:40 +0200990 if (base) {
991 base_bs = bdrv_find_backing_image(bs, base);
992 if (!base_bs) {
Max Reitz6b33f3a2016-12-01 03:05:08 +0100993 error_setg(&local_err,
994 "Did not find '%s' in the backing chain of '%s'",
995 base, filename);
Max Reitz1b22bff2014-10-24 15:57:40 +0200996 goto done;
997 }
998 } else {
999 /* This is different from QMP, which by default uses the deepest file in
1000 * the backing chain (i.e., the very base); however, the traditional
1001 * behavior of qemu-img commit is using the immediate backing file. */
Kevin Wolf760e0062015-06-17 14:55:21 +02001002 base_bs = backing_bs(bs);
Max Reitz1b22bff2014-10-24 15:57:40 +02001003 if (!base_bs) {
1004 error_setg(&local_err, "Image does not have a backing file");
1005 goto done;
1006 }
bellardea2384d2004-08-01 21:59:26 +00001007 }
1008
Max Reitzd4a32382014-10-24 15:57:37 +02001009 cbi = (CommonBlockJobCBInfo){
1010 .errp = &local_err,
1011 .bs = bs,
1012 };
1013
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001014 aio_context = bdrv_get_aio_context(bs);
1015 aio_context_acquire(aio_context);
Kevin Wolfbb02b652018-04-19 17:54:56 +02001016 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, 0,
Kevin Wolf0db832f2017-02-20 18:10:05 +01001017 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
Fam Zheng78bbd912017-04-21 20:27:04 +08001018 &cbi, false, &local_err);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001019 aio_context_release(aio_context);
Max Reitzd4a32382014-10-24 15:57:37 +02001020 if (local_err) {
1021 goto done;
1022 }
1023
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001024 /* When the block job completes, the BlockBackend reference will point to
1025 * the old backing file. In order to avoid that the top image is already
1026 * deleted, so we can still empty it afterwards, increment the reference
1027 * counter here preemptively. */
Max Reitz9a86fe42014-10-24 15:57:38 +02001028 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001029 bdrv_ref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001030 }
1031
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001032 job = block_job_get("commit");
Liam Merwick2e2db262018-11-05 21:38:37 +00001033 assert(job);
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001034 run_block_job(job, &local_err);
Max Reitz9a86fe42014-10-24 15:57:38 +02001035 if (local_err) {
1036 goto unref_backing;
1037 }
1038
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001039 if (!drop && bs->drv->bdrv_make_empty) {
1040 ret = bs->drv->bdrv_make_empty(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001041 if (ret) {
1042 error_setg_errno(&local_err, -ret, "Could not empty %s",
1043 filename);
1044 goto unref_backing;
1045 }
1046 }
1047
1048unref_backing:
1049 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001050 bdrv_unref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001051 }
Max Reitzd4a32382014-10-24 15:57:37 +02001052
1053done:
Max Reitz687fa1d2014-10-24 15:57:39 +02001054 qemu_progress_end();
1055
Markus Armbruster26f54e92014-10-07 13:59:04 +02001056 blk_unref(blk);
Max Reitzd4a32382014-10-24 15:57:37 +02001057
1058 if (local_err) {
Markus Armbruster6936f292015-02-10 15:14:02 +01001059 error_report_err(local_err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001060 return 1;
1061 }
Max Reitzd4a32382014-10-24 15:57:37 +02001062
1063 qprintf(quiet, "Image committed.\n");
bellardea2384d2004-08-01 21:59:26 +00001064 return 0;
1065}
1066
Dmitry Konishchevf6a00aa2011-05-18 15:03:59 +04001067/*
Eric Blakedebb38a2017-10-11 22:47:11 -05001068 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1069 * of the first sector boundary within buf where the sector contains a
1070 * non-zero byte. This function is robust to a buffer that is not
1071 * sector-aligned.
1072 */
1073static int64_t find_nonzero(const uint8_t *buf, int64_t n)
1074{
1075 int64_t i;
1076 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);
1077
1078 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
1079 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
1080 return i;
1081 }
1082 }
1083 if (i < n && !buffer_is_zero(buf + i, n - end)) {
1084 return i;
1085 }
1086 return -1;
1087}
1088
1089/*
thsf58c7b32008-06-05 21:53:49 +00001090 * Returns true iff the first sector pointed to by 'buf' contains at least
1091 * a non-NUL byte.
1092 *
1093 * 'pnum' is set to the number of sectors (including and immediately following
1094 * the first one) that are known to be in the same allocated/unallocated state.
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001095 * The function will try to align the end offset to alignment boundaries so
1096 * that the request will at least end aligned and consequtive requests will
1097 * also start at an aligned offset.
thsf58c7b32008-06-05 21:53:49 +00001098 */
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001099static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
1100 int64_t sector_num, int alignment)
bellardea2384d2004-08-01 21:59:26 +00001101{
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001102 bool is_zero;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001103 int i, tail;
bellardea2384d2004-08-01 21:59:26 +00001104
1105 if (n <= 0) {
1106 *pnum = 0;
1107 return 0;
1108 }
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001109 is_zero = buffer_is_zero(buf, 512);
bellardea2384d2004-08-01 21:59:26 +00001110 for(i = 1; i < n; i++) {
1111 buf += 512;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001112 if (is_zero != buffer_is_zero(buf, 512)) {
bellardea2384d2004-08-01 21:59:26 +00001113 break;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001114 }
bellardea2384d2004-08-01 21:59:26 +00001115 }
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001116
1117 tail = (sector_num + i) & (alignment - 1);
1118 if (tail) {
1119 if (is_zero && i <= tail) {
1120 /* treat unallocated areas which only consist
1121 * of a small tail as allocated. */
1122 is_zero = false;
1123 }
1124 if (!is_zero) {
1125 /* align up end offset of allocated areas. */
1126 i += alignment - tail;
1127 i = MIN(i, n);
1128 } else {
1129 /* align down end offset of zero areas. */
1130 i -= tail;
1131 }
1132 }
bellardea2384d2004-08-01 21:59:26 +00001133 *pnum = i;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001134 return !is_zero;
bellardea2384d2004-08-01 21:59:26 +00001135}
1136
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001137/*
Kevin Wolfa22f1232011-08-26 15:27:13 +02001138 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1139 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1140 * breaking up write requests for only small sparse areas.
1141 */
1142static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001143 int min, int64_t sector_num, int alignment)
Kevin Wolfa22f1232011-08-26 15:27:13 +02001144{
1145 int ret;
1146 int num_checked, num_used;
1147
1148 if (n < min) {
1149 min = n;
1150 }
1151
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001152 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001153 if (!ret) {
1154 return ret;
1155 }
1156
1157 num_used = *pnum;
1158 buf += BDRV_SECTOR_SIZE * *pnum;
1159 n -= *pnum;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001160 sector_num += *pnum;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001161 num_checked = num_used;
1162
1163 while (n > 0) {
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001164 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001165
1166 buf += BDRV_SECTOR_SIZE * *pnum;
1167 n -= *pnum;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001168 sector_num += *pnum;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001169 num_checked += *pnum;
1170 if (ret) {
1171 num_used = num_checked;
1172 } else if (*pnum >= min) {
1173 break;
1174 }
1175 }
1176
1177 *pnum = num_used;
1178 return 1;
1179}
1180
1181/*
Eric Blakedc61cd32017-10-11 22:47:14 -05001182 * Compares two buffers sector by sector. Returns 0 if the first
1183 * sector of each buffer matches, non-zero otherwise.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001184 *
Eric Blakedc61cd32017-10-11 22:47:14 -05001185 * pnum is set to the sector-aligned size of the buffer prefix that
1186 * has the same matching status as the first sector.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001187 */
Eric Blakedc61cd32017-10-11 22:47:14 -05001188static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
1189 int64_t bytes, int64_t *pnum)
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001190{
Radim Krčmář8c1ac472015-02-20 17:06:15 +01001191 bool res;
Eric Blakedc61cd32017-10-11 22:47:14 -05001192 int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001193
Eric Blakedc61cd32017-10-11 22:47:14 -05001194 assert(bytes > 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001195
Eric Blakedc61cd32017-10-11 22:47:14 -05001196 res = !!memcmp(buf1, buf2, i);
1197 while (i < bytes) {
1198 int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001199
Eric Blakedc61cd32017-10-11 22:47:14 -05001200 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001201 break;
1202 }
Eric Blakedc61cd32017-10-11 22:47:14 -05001203 i += len;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001204 }
1205
1206 *pnum = i;
1207 return res;
1208}
1209
Kevin Wolf80ee15a2009-09-15 12:30:43 +02001210#define IO_BUF_SIZE (2 * 1024 * 1024)
bellardea2384d2004-08-01 21:59:26 +00001211
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001212/*
1213 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1214 *
Eric Blake0608e402017-10-11 22:47:12 -05001215 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1216 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1217 * failure), and 4 on error (the exit status for read errors), after emitting
1218 * an error message.
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001219 *
Max Reitzf1d3cd72015-02-05 13:58:18 -05001220 * @param blk: BlockBackend for the image
Eric Blakec41508e2017-10-11 22:47:13 -05001221 * @param offset: Starting offset to check
1222 * @param bytes: Number of bytes to check
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001223 * @param filename: Name of disk file we are checking (logging purpose)
1224 * @param buffer: Allocated buffer for storing read data
1225 * @param quiet: Flag for quiet mode
1226 */
Eric Blakec41508e2017-10-11 22:47:13 -05001227static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1228 int64_t bytes, const char *filename,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001229 uint8_t *buffer, bool quiet)
1230{
Eric Blakedebb38a2017-10-11 22:47:11 -05001231 int ret = 0;
1232 int64_t idx;
1233
Eric Blakec41508e2017-10-11 22:47:13 -05001234 ret = blk_pread(blk, offset, buffer, bytes);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001235 if (ret < 0) {
1236 error_report("Error while reading offset %" PRId64 " of %s: %s",
Eric Blakec41508e2017-10-11 22:47:13 -05001237 offset, filename, strerror(-ret));
Eric Blake0608e402017-10-11 22:47:12 -05001238 return 4;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001239 }
Eric Blakec41508e2017-10-11 22:47:13 -05001240 idx = find_nonzero(buffer, bytes);
Eric Blakedebb38a2017-10-11 22:47:11 -05001241 if (idx >= 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001242 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blakec41508e2017-10-11 22:47:13 -05001243 offset + idx);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001244 return 1;
1245 }
1246
1247 return 0;
1248}
1249
1250/*
1251 * Compares two images. Exit codes:
1252 *
1253 * 0 - Images are identical
1254 * 1 - Images differ
1255 * >1 - Error occurred
1256 */
1257static int img_compare(int argc, char **argv)
1258{
Max Reitz40055952014-07-22 22:58:42 +02001259 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001260 BlockBackend *blk1, *blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001261 BlockDriverState *bs1, *bs2;
Eric Blake033d9fc2017-10-11 22:47:16 -05001262 int64_t total_size1, total_size2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001263 uint8_t *buf1 = NULL, *buf2 = NULL;
Eric Blake31826642017-10-11 22:47:08 -05001264 int64_t pnum1, pnum2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001265 int allocated1, allocated2;
1266 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1267 bool progress = false, quiet = false, strict = false;
Max Reitz40055952014-07-22 22:58:42 +02001268 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01001269 bool writethrough;
Eric Blake033d9fc2017-10-11 22:47:16 -05001270 int64_t total_size;
1271 int64_t offset = 0;
1272 int64_t chunk;
Eric Blakedc61cd32017-10-11 22:47:14 -05001273 int c;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001274 uint64_t progress_base;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001275 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08001276 bool force_share = false;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001277
Max Reitz40055952014-07-22 22:58:42 +02001278 cache = BDRV_DEFAULT_CACHE;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001279 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001280 static const struct option long_options[] = {
1281 {"help", no_argument, 0, 'h'},
1282 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001283 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08001284 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001285 {0, 0, 0, 0}
1286 };
Fam Zheng335e9932017-05-03 00:35:39 +08001287 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001288 long_options, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001289 if (c == -1) {
1290 break;
1291 }
1292 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001293 case ':':
1294 missing_argument(argv[optind - 1]);
1295 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001296 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001297 unrecognized_option(argv[optind - 1]);
1298 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001299 case 'h':
1300 help();
1301 break;
1302 case 'f':
1303 fmt1 = optarg;
1304 break;
1305 case 'F':
1306 fmt2 = optarg;
1307 break;
Max Reitz40055952014-07-22 22:58:42 +02001308 case 'T':
1309 cache = optarg;
1310 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001311 case 'p':
1312 progress = true;
1313 break;
1314 case 'q':
1315 quiet = true;
1316 break;
1317 case 's':
1318 strict = true;
1319 break;
Fam Zheng335e9932017-05-03 00:35:39 +08001320 case 'U':
1321 force_share = true;
1322 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001323 case OPTION_OBJECT: {
1324 QemuOpts *opts;
1325 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1326 optarg, true);
1327 if (!opts) {
1328 ret = 2;
1329 goto out4;
1330 }
1331 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001332 case OPTION_IMAGE_OPTS:
1333 image_opts = true;
1334 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001335 }
1336 }
1337
1338 /* Progress is not shown in Quiet mode */
1339 if (quiet) {
1340 progress = false;
1341 }
1342
1343
Kevin Wolffc11eb22013-08-05 10:53:04 +02001344 if (optind != argc - 2) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001345 error_exit("Expecting two image file names");
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001346 }
1347 filename1 = argv[optind++];
1348 filename2 = argv[optind++];
1349
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001350 if (qemu_opts_foreach(&qemu_object_opts,
1351 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02001352 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001353 ret = 2;
1354 goto out4;
1355 }
1356
Stefan Hajnoczicbda0162014-08-26 19:17:55 +01001357 /* Initialize before goto out */
1358 qemu_progress_init(progress, 2.0);
1359
Kevin Wolfce099542016-03-15 13:01:04 +01001360 flags = 0;
1361 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +02001362 if (ret < 0) {
1363 error_report("Invalid source cache option: %s", cache);
1364 ret = 2;
1365 goto out3;
1366 }
1367
Fam Zheng335e9932017-05-03 00:35:39 +08001368 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1369 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001370 if (!blk1) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001371 ret = 2;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001372 goto out3;
1373 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001374
Fam Zheng335e9932017-05-03 00:35:39 +08001375 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1376 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001377 if (!blk2) {
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001378 ret = 2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001379 goto out2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001380 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001381 bs1 = blk_bs(blk1);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001382 bs2 = blk_bs(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001383
Max Reitzf1d3cd72015-02-05 13:58:18 -05001384 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1385 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
Eric Blake033d9fc2017-10-11 22:47:16 -05001386 total_size1 = blk_getlength(blk1);
1387 if (total_size1 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001388 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001389 filename1, strerror(-total_size1));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001390 ret = 4;
1391 goto out;
1392 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001393 total_size2 = blk_getlength(blk2);
1394 if (total_size2 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001395 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001396 filename2, strerror(-total_size2));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001397 ret = 4;
1398 goto out;
1399 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001400 total_size = MIN(total_size1, total_size2);
1401 progress_base = MAX(total_size1, total_size2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001402
1403 qemu_progress_print(0, 100);
1404
Eric Blake033d9fc2017-10-11 22:47:16 -05001405 if (strict && total_size1 != total_size2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001406 ret = 1;
1407 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1408 goto out;
1409 }
1410
Eric Blake033d9fc2017-10-11 22:47:16 -05001411 while (offset < total_size) {
Eric Blake31826642017-10-11 22:47:08 -05001412 int status1, status2;
Fam Zheng67a0fd22016-01-26 11:58:48 +08001413
Eric Blake033d9fc2017-10-11 22:47:16 -05001414 status1 = bdrv_block_status_above(bs1, NULL, offset,
1415 total_size1 - offset, &pnum1, NULL,
1416 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001417 if (status1 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001418 ret = 3;
1419 error_report("Sector allocation test failed for %s", filename1);
1420 goto out;
1421 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001422 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001423
Eric Blake033d9fc2017-10-11 22:47:16 -05001424 status2 = bdrv_block_status_above(bs2, NULL, offset,
1425 total_size2 - offset, &pnum2, NULL,
1426 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001427 if (status2 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001428 ret = 3;
1429 error_report("Sector allocation test failed for %s", filename2);
1430 goto out;
1431 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001432 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
Eric Blake7daddc62017-10-11 22:47:09 -05001433
1434 assert(pnum1 && pnum2);
Eric Blake033d9fc2017-10-11 22:47:16 -05001435 chunk = MIN(pnum1, pnum2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001436
Fam Zheng25ad8e62016-01-13 16:37:41 +08001437 if (strict) {
Eric Blake31826642017-10-11 22:47:08 -05001438 if (status1 != status2) {
Fam Zheng25ad8e62016-01-13 16:37:41 +08001439 ret = 1;
1440 qprintf(quiet, "Strict mode: Offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001441 " block status mismatch!\n", offset);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001442 goto out;
1443 }
1444 }
1445 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
Eric Blake7daddc62017-10-11 22:47:09 -05001446 /* nothing to do */
Fam Zheng25ad8e62016-01-13 16:37:41 +08001447 } else if (allocated1 == allocated2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001448 if (allocated1) {
Eric Blakedc61cd32017-10-11 22:47:14 -05001449 int64_t pnum;
1450
Eric Blake033d9fc2017-10-11 22:47:16 -05001451 chunk = MIN(chunk, IO_BUF_SIZE);
1452 ret = blk_pread(blk1, offset, buf1, chunk);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001453 if (ret < 0) {
1454 error_report("Error while reading offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001455 " of %s: %s",
1456 offset, filename1, strerror(-ret));
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001457 ret = 4;
1458 goto out;
1459 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001460 ret = blk_pread(blk2, offset, buf2, chunk);
1461 if (ret < 0) {
1462 error_report("Error while reading offset %" PRId64
1463 " of %s: %s",
1464 offset, filename2, strerror(-ret));
1465 ret = 4;
1466 goto out;
1467 }
1468 ret = compare_buffers(buf1, buf2, chunk, &pnum);
1469 if (ret || pnum != chunk) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001470 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blake033d9fc2017-10-11 22:47:16 -05001471 offset + (ret ? 0 : pnum));
Fam Zheng36452f12013-11-13 20:26:49 +08001472 ret = 1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001473 goto out;
1474 }
1475 }
1476 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001477 chunk = MIN(chunk, IO_BUF_SIZE);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001478 if (allocated1) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001479 ret = check_empty_sectors(blk1, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001480 filename1, buf1, quiet);
1481 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001482 ret = check_empty_sectors(blk2, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001483 filename2, buf1, quiet);
1484 }
1485 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001486 goto out;
1487 }
1488 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001489 offset += chunk;
1490 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001491 }
1492
Eric Blake033d9fc2017-10-11 22:47:16 -05001493 if (total_size1 != total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001494 BlockBackend *blk_over;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001495 const char *filename_over;
1496
1497 qprintf(quiet, "Warning: Image size mismatch!\n");
Eric Blake033d9fc2017-10-11 22:47:16 -05001498 if (total_size1 > total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001499 blk_over = blk1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001500 filename_over = filename1;
1501 } else {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001502 blk_over = blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001503 filename_over = filename2;
1504 }
1505
Eric Blake033d9fc2017-10-11 22:47:16 -05001506 while (offset < progress_base) {
1507 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1508 progress_base - offset, &chunk,
1509 NULL, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001510 if (ret < 0) {
1511 ret = 3;
1512 error_report("Sector allocation test failed for %s",
1513 filename_over);
1514 goto out;
1515
1516 }
Eric Blake391cb1a2017-10-11 22:47:10 -05001517 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001518 chunk = MIN(chunk, IO_BUF_SIZE);
1519 ret = check_empty_sectors(blk_over, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001520 filename_over, buf1, quiet);
1521 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001522 goto out;
1523 }
1524 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001525 offset += chunk;
1526 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001527 }
1528 }
1529
1530 qprintf(quiet, "Images are identical.\n");
1531 ret = 0;
1532
1533out:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001534 qemu_vfree(buf1);
1535 qemu_vfree(buf2);
Markus Armbruster26f54e92014-10-07 13:59:04 +02001536 blk_unref(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001537out2:
Markus Armbruster26f54e92014-10-07 13:59:04 +02001538 blk_unref(blk1);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001539out3:
1540 qemu_progress_end();
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001541out4:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001542 return ret;
1543}
1544
Kevin Wolf690c7302015-03-19 13:33:32 +01001545enum ImgConvertBlockStatus {
1546 BLK_DATA,
1547 BLK_ZERO,
1548 BLK_BACKING_FILE,
1549};
1550
Peter Lieven2d9187b2017-02-28 13:40:07 +01001551#define MAX_COROUTINES 16
1552
Kevin Wolf690c7302015-03-19 13:33:32 +01001553typedef struct ImgConvertState {
1554 BlockBackend **src;
1555 int64_t *src_sectors;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001556 int src_num;
Kevin Wolf690c7302015-03-19 13:33:32 +01001557 int64_t total_sectors;
1558 int64_t allocated_sectors;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001559 int64_t allocated_done;
1560 int64_t sector_num;
1561 int64_t wr_offs;
Kevin Wolf690c7302015-03-19 13:33:32 +01001562 enum ImgConvertBlockStatus status;
1563 int64_t sector_next_status;
1564 BlockBackend *target;
1565 bool has_zero_init;
1566 bool compressed;
Max Reitz351c8ef2018-05-01 18:57:49 +02001567 bool unallocated_blocks_are_zero;
Kevin Wolf690c7302015-03-19 13:33:32 +01001568 bool target_has_backing;
Max Reitz351c8ef2018-05-01 18:57:49 +02001569 int64_t target_backing_sectors; /* negative if unknown */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001570 bool wr_in_order;
Fam Zhengee5306d2018-06-01 17:26:48 +08001571 bool copy_range;
Kevin Wolf690c7302015-03-19 13:33:32 +01001572 int min_sparse;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001573 int alignment;
Kevin Wolf690c7302015-03-19 13:33:32 +01001574 size_t cluster_sectors;
1575 size_t buf_sectors;
Peter Lieven9fd77f92017-04-21 11:11:55 +02001576 long num_coroutines;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001577 int running_coroutines;
1578 Coroutine *co[MAX_COROUTINES];
1579 int64_t wait_sector_num[MAX_COROUTINES];
1580 CoMutex lock;
1581 int ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001582} ImgConvertState;
1583
Peter Lieven2d9187b2017-02-28 13:40:07 +01001584static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1585 int *src_cur, int64_t *src_cur_offset)
Kevin Wolf690c7302015-03-19 13:33:32 +01001586{
Peter Lieven2d9187b2017-02-28 13:40:07 +01001587 *src_cur = 0;
1588 *src_cur_offset = 0;
1589 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1590 *src_cur_offset += s->src_sectors[*src_cur];
1591 (*src_cur)++;
1592 assert(*src_cur < s->src_num);
Kevin Wolf690c7302015-03-19 13:33:32 +01001593 }
1594}
1595
1596static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1597{
Eric Blake31826642017-10-11 22:47:08 -05001598 int64_t src_cur_offset;
1599 int ret, n, src_cur;
Max Reitz351c8ef2018-05-01 18:57:49 +02001600 bool post_backing_zero = false;
Kevin Wolf690c7302015-03-19 13:33:32 +01001601
Peter Lieven2d9187b2017-02-28 13:40:07 +01001602 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
Kevin Wolf690c7302015-03-19 13:33:32 +01001603
1604 assert(s->total_sectors > sector_num);
1605 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1606
Max Reitz351c8ef2018-05-01 18:57:49 +02001607 if (s->target_backing_sectors >= 0) {
1608 if (sector_num >= s->target_backing_sectors) {
1609 post_backing_zero = s->unallocated_blocks_are_zero;
1610 } else if (sector_num + n > s->target_backing_sectors) {
1611 /* Split requests around target_backing_sectors (because
1612 * starting from there, zeros are handled differently) */
1613 n = s->target_backing_sectors - sector_num;
1614 }
1615 }
1616
Kevin Wolf690c7302015-03-19 13:33:32 +01001617 if (s->sector_next_status <= sector_num) {
Eric Blake31826642017-10-11 22:47:08 -05001618 int64_t count = n * BDRV_SECTOR_SIZE;
1619
Vladimir Sementsov-Ogievskiy9f1b92a2017-04-07 14:34:04 +03001620 if (s->target_has_backing) {
Eric Blake237d78f2017-10-11 22:47:03 -05001621
1622 ret = bdrv_block_status(blk_bs(s->src[src_cur]),
1623 (sector_num - src_cur_offset) *
1624 BDRV_SECTOR_SIZE,
1625 count, &count, NULL, NULL);
Vladimir Sementsov-Ogievskiy9f1b92a2017-04-07 14:34:04 +03001626 } else {
Eric Blake31826642017-10-11 22:47:08 -05001627 ret = bdrv_block_status_above(blk_bs(s->src[src_cur]), NULL,
1628 (sector_num - src_cur_offset) *
1629 BDRV_SECTOR_SIZE,
1630 count, &count, NULL, NULL);
Vladimir Sementsov-Ogievskiy9f1b92a2017-04-07 14:34:04 +03001631 }
Kevin Wolf690c7302015-03-19 13:33:32 +01001632 if (ret < 0) {
1633 return ret;
1634 }
Eric Blake31826642017-10-11 22:47:08 -05001635 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
Kevin Wolf690c7302015-03-19 13:33:32 +01001636
1637 if (ret & BDRV_BLOCK_ZERO) {
Max Reitz351c8ef2018-05-01 18:57:49 +02001638 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
Kevin Wolf690c7302015-03-19 13:33:32 +01001639 } else if (ret & BDRV_BLOCK_DATA) {
1640 s->status = BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001641 } else {
Vladimir Sementsov-Ogievskiy9f1b92a2017-04-07 14:34:04 +03001642 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001643 }
1644
1645 s->sector_next_status = sector_num + n;
1646 }
1647
1648 n = MIN(n, s->sector_next_status - sector_num);
1649 if (s->status == BLK_DATA) {
1650 n = MIN(n, s->buf_sectors);
1651 }
1652
1653 /* We need to write complete clusters for compressed images, so if an
1654 * unallocated area is shorter than that, we must consider the whole
1655 * cluster allocated. */
1656 if (s->compressed) {
1657 if (n < s->cluster_sectors) {
1658 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1659 s->status = BLK_DATA;
1660 } else {
1661 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1662 }
1663 }
1664
1665 return n;
1666}
1667
Peter Lieven2d9187b2017-02-28 13:40:07 +01001668static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1669 int nb_sectors, uint8_t *buf)
Kevin Wolf690c7302015-03-19 13:33:32 +01001670{
Peter Lieven2d9187b2017-02-28 13:40:07 +01001671 int n, ret;
1672 QEMUIOVector qiov;
1673 struct iovec iov;
Kevin Wolf690c7302015-03-19 13:33:32 +01001674
Kevin Wolf690c7302015-03-19 13:33:32 +01001675 assert(nb_sectors <= s->buf_sectors);
1676 while (nb_sectors > 0) {
1677 BlockBackend *blk;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001678 int src_cur;
1679 int64_t bs_sectors, src_cur_offset;
Kevin Wolf690c7302015-03-19 13:33:32 +01001680
1681 /* In the case of compression with multiple source files, we can get a
1682 * nb_sectors that spreads into the next part. So we must be able to
1683 * read across multiple BDSes for one convert_read() call. */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001684 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1685 blk = s->src[src_cur];
1686 bs_sectors = s->src_sectors[src_cur];
Kevin Wolf690c7302015-03-19 13:33:32 +01001687
Peter Lieven2d9187b2017-02-28 13:40:07 +01001688 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1689 iov.iov_base = buf;
1690 iov.iov_len = n << BDRV_SECTOR_BITS;
1691 qemu_iovec_init_external(&qiov, &iov, 1);
1692
1693 ret = blk_co_preadv(
1694 blk, (sector_num - src_cur_offset) << BDRV_SECTOR_BITS,
1695 n << BDRV_SECTOR_BITS, &qiov, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01001696 if (ret < 0) {
1697 return ret;
1698 }
1699
1700 sector_num += n;
1701 nb_sectors -= n;
1702 buf += n * BDRV_SECTOR_SIZE;
1703 }
1704
1705 return 0;
1706}
1707
Peter Lieven2d9187b2017-02-28 13:40:07 +01001708
1709static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1710 int nb_sectors, uint8_t *buf,
1711 enum ImgConvertBlockStatus status)
Kevin Wolf690c7302015-03-19 13:33:32 +01001712{
1713 int ret;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001714 QEMUIOVector qiov;
1715 struct iovec iov;
Kevin Wolf690c7302015-03-19 13:33:32 +01001716
1717 while (nb_sectors > 0) {
1718 int n = nb_sectors;
Lidong Chendb933fb2017-04-27 10:58:27 +08001719 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1720
Peter Lieven2d9187b2017-02-28 13:40:07 +01001721 switch (status) {
Kevin Wolf690c7302015-03-19 13:33:32 +01001722 case BLK_BACKING_FILE:
1723 /* If we have a backing file, leave clusters unallocated that are
1724 * unallocated in the source image, so that the backing file is
1725 * visible at the respective offset. */
1726 assert(s->target_has_backing);
1727 break;
1728
1729 case BLK_DATA:
Lidong Chendb933fb2017-04-27 10:58:27 +08001730 /* If we're told to keep the target fully allocated (-S 0) or there
1731 * is real non-zero data, we must write it. Otherwise we can treat
1732 * it as zero sectors.
1733 * Compressed clusters need to be written as a whole, so in that
1734 * case we can only save the write if the buffer is completely
1735 * zeroed. */
Kevin Wolf690c7302015-03-19 13:33:32 +01001736 if (!s->min_sparse ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001737 (!s->compressed &&
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001738 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1739 sector_num, s->alignment)) ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001740 (s->compressed &&
1741 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
Kevin Wolf690c7302015-03-19 13:33:32 +01001742 {
Peter Lieven2d9187b2017-02-28 13:40:07 +01001743 iov.iov_base = buf;
1744 iov.iov_len = n << BDRV_SECTOR_BITS;
1745 qemu_iovec_init_external(&qiov, &iov, 1);
1746
1747 ret = blk_co_pwritev(s->target, sector_num << BDRV_SECTOR_BITS,
Lidong Chendb933fb2017-04-27 10:58:27 +08001748 n << BDRV_SECTOR_BITS, &qiov, flags);
Kevin Wolf690c7302015-03-19 13:33:32 +01001749 if (ret < 0) {
1750 return ret;
1751 }
1752 break;
1753 }
1754 /* fall-through */
1755
1756 case BLK_ZERO:
1757 if (s->has_zero_init) {
Lidong Chendb933fb2017-04-27 10:58:27 +08001758 assert(!s->target_has_backing);
Kevin Wolf690c7302015-03-19 13:33:32 +01001759 break;
1760 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01001761 ret = blk_co_pwrite_zeroes(s->target,
1762 sector_num << BDRV_SECTOR_BITS,
1763 n << BDRV_SECTOR_BITS, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01001764 if (ret < 0) {
1765 return ret;
1766 }
1767 break;
1768 }
1769
1770 sector_num += n;
1771 nb_sectors -= n;
1772 buf += n * BDRV_SECTOR_SIZE;
1773 }
1774
1775 return 0;
1776}
1777
Fam Zhengee5306d2018-06-01 17:26:48 +08001778static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1779 int nb_sectors)
1780{
1781 int n, ret;
1782
1783 while (nb_sectors > 0) {
1784 BlockBackend *blk;
1785 int src_cur;
1786 int64_t bs_sectors, src_cur_offset;
1787 int64_t offset;
1788
1789 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1790 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1791 blk = s->src[src_cur];
1792 bs_sectors = s->src_sectors[src_cur];
1793
1794 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1795
1796 ret = blk_co_copy_range(blk, offset, s->target,
1797 sector_num << BDRV_SECTOR_BITS,
Vladimir Sementsov-Ogievskiy67b51fb2018-07-09 19:37:17 +03001798 n << BDRV_SECTOR_BITS, 0, 0);
Fam Zhengee5306d2018-06-01 17:26:48 +08001799 if (ret < 0) {
1800 return ret;
1801 }
1802
1803 sector_num += n;
1804 nb_sectors -= n;
1805 }
1806 return 0;
1807}
1808
Peter Lieven2d9187b2017-02-28 13:40:07 +01001809static void coroutine_fn convert_co_do_copy(void *opaque)
1810{
1811 ImgConvertState *s = opaque;
1812 uint8_t *buf = NULL;
1813 int ret, i;
1814 int index = -1;
1815
1816 for (i = 0; i < s->num_coroutines; i++) {
1817 if (s->co[i] == qemu_coroutine_self()) {
1818 index = i;
1819 break;
1820 }
1821 }
1822 assert(index >= 0);
1823
1824 s->running_coroutines++;
1825 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1826
1827 while (1) {
1828 int n;
1829 int64_t sector_num;
1830 enum ImgConvertBlockStatus status;
Fam Zhengee5306d2018-06-01 17:26:48 +08001831 bool copy_range;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001832
1833 qemu_co_mutex_lock(&s->lock);
1834 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1835 qemu_co_mutex_unlock(&s->lock);
Anton Nefedovb91127e2017-04-26 11:33:15 +03001836 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001837 }
1838 n = convert_iteration_sectors(s, s->sector_num);
1839 if (n < 0) {
1840 qemu_co_mutex_unlock(&s->lock);
1841 s->ret = n;
Anton Nefedovb91127e2017-04-26 11:33:15 +03001842 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001843 }
1844 /* save current sector and allocation status to local variables */
1845 sector_num = s->sector_num;
1846 status = s->status;
1847 if (!s->min_sparse && s->status == BLK_ZERO) {
1848 n = MIN(n, s->buf_sectors);
1849 }
1850 /* increment global sector counter so that other coroutines can
1851 * already continue reading beyond this request */
1852 s->sector_num += n;
1853 qemu_co_mutex_unlock(&s->lock);
1854
1855 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
1856 s->allocated_done += n;
1857 qemu_progress_print(100.0 * s->allocated_done /
1858 s->allocated_sectors, 0);
1859 }
1860
Fam Zhengee5306d2018-06-01 17:26:48 +08001861retry:
1862 copy_range = s->copy_range && s->status == BLK_DATA;
1863 if (status == BLK_DATA && !copy_range) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01001864 ret = convert_co_read(s, sector_num, n, buf);
1865 if (ret < 0) {
1866 error_report("error while reading sector %" PRId64
1867 ": %s", sector_num, strerror(-ret));
1868 s->ret = ret;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001869 }
1870 } else if (!s->min_sparse && status == BLK_ZERO) {
1871 status = BLK_DATA;
1872 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
1873 }
1874
1875 if (s->wr_in_order) {
1876 /* keep writes in order */
Anton Nefedovb91127e2017-04-26 11:33:15 +03001877 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01001878 s->wait_sector_num[index] = sector_num;
1879 qemu_coroutine_yield();
1880 }
1881 s->wait_sector_num[index] = -1;
1882 }
1883
Anton Nefedovb91127e2017-04-26 11:33:15 +03001884 if (s->ret == -EINPROGRESS) {
Fam Zhengee5306d2018-06-01 17:26:48 +08001885 if (copy_range) {
1886 ret = convert_co_copy_range(s, sector_num, n);
1887 if (ret) {
1888 s->copy_range = false;
1889 goto retry;
1890 }
1891 } else {
1892 ret = convert_co_write(s, sector_num, n, buf, status);
1893 }
Anton Nefedovb91127e2017-04-26 11:33:15 +03001894 if (ret < 0) {
1895 error_report("error while writing sector %" PRId64
1896 ": %s", sector_num, strerror(-ret));
1897 s->ret = ret;
1898 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01001899 }
1900
1901 if (s->wr_in_order) {
1902 /* reenter the coroutine that might have waited
1903 * for this write to complete */
1904 s->wr_offs = sector_num + n;
1905 for (i = 0; i < s->num_coroutines; i++) {
1906 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
1907 /*
1908 * A -> B -> A cannot occur because A has
1909 * s->wait_sector_num[i] == -1 during A -> B. Therefore
1910 * B will never enter A during this time window.
1911 */
1912 qemu_coroutine_enter(s->co[i]);
1913 break;
1914 }
1915 }
1916 }
1917 }
1918
Peter Lieven2d9187b2017-02-28 13:40:07 +01001919 qemu_vfree(buf);
1920 s->co[index] = NULL;
1921 s->running_coroutines--;
1922 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
1923 /* the convert job finished successfully */
1924 s->ret = 0;
1925 }
1926}
1927
Kevin Wolf690c7302015-03-19 13:33:32 +01001928static int convert_do_copy(ImgConvertState *s)
1929{
Peter Lieven2d9187b2017-02-28 13:40:07 +01001930 int ret, i, n;
1931 int64_t sector_num = 0;
Kevin Wolf690c7302015-03-19 13:33:32 +01001932
1933 /* Check whether we have zero initialisation or can get it efficiently */
1934 s->has_zero_init = s->min_sparse && !s->target_has_backing
1935 ? bdrv_has_zero_init(blk_bs(s->target))
1936 : false;
1937
1938 if (!s->has_zero_init && !s->target_has_backing &&
1939 bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
1940 {
Kevin Wolf720ff282016-06-16 15:13:15 +02001941 ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP);
Kevin Wolf690c7302015-03-19 13:33:32 +01001942 if (ret == 0) {
1943 s->has_zero_init = true;
1944 }
1945 }
1946
1947 /* Allocate buffer for copied data. For compressed images, only one cluster
1948 * can be copied at a time. */
1949 if (s->compressed) {
1950 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
1951 error_report("invalid cluster size");
Peter Lieven2d9187b2017-02-28 13:40:07 +01001952 return -EINVAL;
Kevin Wolf690c7302015-03-19 13:33:32 +01001953 }
1954 s->buf_sectors = s->cluster_sectors;
1955 }
Kevin Wolf690c7302015-03-19 13:33:32 +01001956
Kevin Wolf690c7302015-03-19 13:33:32 +01001957 while (sector_num < s->total_sectors) {
1958 n = convert_iteration_sectors(s, sector_num);
1959 if (n < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01001960 return n;
Kevin Wolf690c7302015-03-19 13:33:32 +01001961 }
Max Reitzaad15de2016-03-24 23:33:57 +01001962 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1963 {
Kevin Wolf690c7302015-03-19 13:33:32 +01001964 s->allocated_sectors += n;
1965 }
1966 sector_num += n;
1967 }
1968
1969 /* Do the copy */
Kevin Wolf690c7302015-03-19 13:33:32 +01001970 s->sector_next_status = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001971 s->ret = -EINPROGRESS;
Kevin Wolf690c7302015-03-19 13:33:32 +01001972
Peter Lieven2d9187b2017-02-28 13:40:07 +01001973 qemu_co_mutex_init(&s->lock);
1974 for (i = 0; i < s->num_coroutines; i++) {
1975 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
1976 s->wait_sector_num[i] = -1;
1977 qemu_coroutine_enter(s->co[i]);
Kevin Wolf690c7302015-03-19 13:33:32 +01001978 }
1979
Anton Nefedovb91127e2017-04-26 11:33:15 +03001980 while (s->running_coroutines) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01001981 main_loop_wait(false);
1982 }
1983
1984 if (s->compressed && !s->ret) {
Kevin Wolf690c7302015-03-19 13:33:32 +01001985 /* signal EOF to align */
Pavel Butsykinfe5c1352016-07-22 11:17:40 +03001986 ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01001987 if (ret < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01001988 return ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001989 }
1990 }
1991
Peter Lieven2d9187b2017-02-28 13:40:07 +01001992 return s->ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001993}
1994
Peter Lieven6360ab22018-07-13 09:15:39 +02001995#define MAX_BUF_SECTORS 32768
1996
bellardea2384d2004-08-01 21:59:26 +00001997static int img_convert(int argc, char **argv)
1998{
Peter Lieven9fd77f92017-04-21 11:11:55 +02001999 int c, bs_i, flags, src_flags = 0;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002000 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002001 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
2002 *out_filename, *out_baseimg_param, *snapshot_name = NULL;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002003 BlockDriver *drv = NULL, *proto_drv = NULL;
bellardfaea38e2006-08-05 21:31:00 +00002004 BlockDriverInfo bdi;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002005 BlockDriverState *out_bs;
2006 QemuOpts *opts = NULL, *sn_opts = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08002007 QemuOptsList *create_opts = NULL;
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002008 QDict *open_opts = NULL;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002009 char *options = NULL;
Max Reitzcc84d902013-09-06 17:14:26 +02002010 Error *local_err = NULL;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002011 bool writethrough, src_writethrough, quiet = false, image_opts = false,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002012 skip_create = false, progress = false, tgt_image_opts = false;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002013 int64_t ret = -EINVAL;
Fam Zheng335e9932017-05-03 00:35:39 +08002014 bool force_share = false;
Fam Zhenge11ce122018-07-27 11:34:01 +08002015 bool explict_min_sparse = false;
bellardea2384d2004-08-01 21:59:26 +00002016
Peter Lieven9fd77f92017-04-21 11:11:55 +02002017 ImgConvertState s = (ImgConvertState) {
2018 /* Need at least 4k of zeros for sparse detection */
2019 .min_sparse = 8,
Fam Zhenge11ce122018-07-27 11:34:01 +08002020 .copy_range = false,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002021 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2022 .wr_in_order = true,
2023 .num_coroutines = 8,
2024 };
2025
bellardea2384d2004-08-01 21:59:26 +00002026 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002027 static const struct option long_options[] = {
2028 {"help", no_argument, 0, 'h'},
2029 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002030 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002031 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002032 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002033 {0, 0, 0, 0}
2034 };
Fam Zhenge11ce122018-07-27 11:34:01 +08002035 c = getopt_long(argc, argv, ":hf:O:B:Cco:l:S:pt:T:qnm:WU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002036 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002037 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002038 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002039 }
bellardea2384d2004-08-01 21:59:26 +00002040 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002041 case ':':
2042 missing_argument(argv[optind - 1]);
2043 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002044 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002045 unrecognized_option(argv[optind - 1]);
2046 break;
bellardea2384d2004-08-01 21:59:26 +00002047 case 'h':
2048 help();
2049 break;
2050 case 'f':
2051 fmt = optarg;
2052 break;
2053 case 'O':
2054 out_fmt = optarg;
2055 break;
thsf58c7b32008-06-05 21:53:49 +00002056 case 'B':
2057 out_baseimg = optarg;
2058 break;
Fam Zhenge11ce122018-07-27 11:34:01 +08002059 case 'C':
2060 s.copy_range = true;
2061 break;
bellardea2384d2004-08-01 21:59:26 +00002062 case 'c':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002063 s.compressed = true;
bellardea2384d2004-08-01 21:59:26 +00002064 break;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002065 case 'o':
Kevin Wolf2dc83282014-02-21 16:24:05 +01002066 if (!is_valid_option_list(optarg)) {
2067 error_report("Invalid option list: %s", optarg);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002068 goto fail_getopt;
Kevin Wolf2dc83282014-02-21 16:24:05 +01002069 }
2070 if (!options) {
2071 options = g_strdup(optarg);
2072 } else {
2073 char *old_options = options;
2074 options = g_strdup_printf("%s,%s", options, optarg);
2075 g_free(old_options);
2076 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002077 break;
Wenchao Xiaef806542013-12-04 17:10:57 +08002078 case 'l':
2079 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
Markus Armbruster70b94332015-02-13 12:50:26 +01002080 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2081 optarg, false);
Wenchao Xiaef806542013-12-04 17:10:57 +08002082 if (!sn_opts) {
2083 error_report("Failed in parsing snapshot param '%s'",
2084 optarg);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002085 goto fail_getopt;
Wenchao Xiaef806542013-12-04 17:10:57 +08002086 }
2087 } else {
2088 snapshot_name = optarg;
2089 }
2090 break;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002091 case 'S':
2092 {
2093 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +01002094
2095 sval = cvtnum(optarg);
Peter Lieven6360ab22018-07-13 09:15:39 +02002096 if (sval < 0 || sval & (BDRV_SECTOR_SIZE - 1) ||
2097 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2098 error_report("Invalid buffer size for sparse output specified. "
2099 "Valid sizes are multiples of %llu up to %llu. Select "
2100 "0 to disable sparse detection (fully allocates output).",
2101 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002102 goto fail_getopt;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002103 }
2104
Peter Lieven9fd77f92017-04-21 11:11:55 +02002105 s.min_sparse = sval / BDRV_SECTOR_SIZE;
Fam Zhenge11ce122018-07-27 11:34:01 +08002106 explict_min_sparse = true;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002107 break;
2108 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002109 case 'p':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002110 progress = true;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002111 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002112 case 't':
2113 cache = optarg;
2114 break;
Max Reitz40055952014-07-22 22:58:42 +02002115 case 'T':
2116 src_cache = optarg;
2117 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002118 case 'q':
2119 quiet = true;
2120 break;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002121 case 'n':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002122 skip_create = true;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002123 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002124 case 'm':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002125 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2126 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002127 error_report("Invalid number of coroutines. Allowed number of"
2128 " coroutines is between 1 and %d", MAX_COROUTINES);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002129 goto fail_getopt;
2130 }
2131 break;
2132 case 'W':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002133 s.wr_in_order = false;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002134 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002135 case 'U':
2136 force_share = true;
2137 break;
Max Reitz3258b912017-04-26 15:46:47 +02002138 case OPTION_OBJECT: {
2139 QemuOpts *object_opts;
2140 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
2141 optarg, true);
2142 if (!object_opts) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002143 goto fail_getopt;
2144 }
2145 break;
Max Reitz3258b912017-04-26 15:46:47 +02002146 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002147 case OPTION_IMAGE_OPTS:
2148 image_opts = true;
2149 break;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002150 case OPTION_TARGET_IMAGE_OPTS:
2151 tgt_image_opts = true;
2152 break;
bellardea2384d2004-08-01 21:59:26 +00002153 }
2154 }
ths3b46e622007-09-17 08:09:54 +00002155
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002156 if (!out_fmt && !tgt_image_opts) {
2157 out_fmt = "raw";
2158 }
2159
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002160 if (qemu_opts_foreach(&qemu_object_opts,
2161 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02002162 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002163 goto fail_getopt;
2164 }
2165
Fam Zhenge11ce122018-07-27 11:34:01 +08002166 if (s.compressed && s.copy_range) {
2167 error_report("Cannot enable copy offloading when -c is used");
2168 goto fail_getopt;
2169 }
2170
2171 if (explict_min_sparse && s.copy_range) {
2172 error_report("Cannot enable copy offloading when -S is used");
2173 goto fail_getopt;
2174 }
2175
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002176 if (tgt_image_opts && !skip_create) {
2177 error_report("--target-image-opts requires use of -n flag");
2178 goto fail_getopt;
2179 }
2180
Peter Lieven9fd77f92017-04-21 11:11:55 +02002181 s.src_num = argc - optind - 1;
2182 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2183
2184 if (options && has_help_option(options)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002185 if (out_fmt) {
2186 ret = print_block_option_help(out_filename, out_fmt);
2187 goto fail_getopt;
2188 } else {
2189 error_report("Option help requires a format be specified");
2190 goto fail_getopt;
2191 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002192 }
2193
2194 if (s.src_num < 1) {
2195 error_report("Must specify image file name");
2196 goto fail_getopt;
2197 }
2198
2199
Peter Lieven9fd77f92017-04-21 11:11:55 +02002200 /* ret is still -EINVAL until here */
2201 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2202 if (ret < 0) {
2203 error_report("Invalid source cache option: %s", src_cache);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002204 goto fail_getopt;
2205 }
2206
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002207 /* Initialize before goto out */
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002208 if (quiet) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002209 progress = false;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002210 }
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002211 qemu_progress_init(progress, 1.0);
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002212 qemu_progress_print(0, 100);
2213
Peter Lieven9fd77f92017-04-21 11:11:55 +02002214 s.src = g_new0(BlockBackend *, s.src_num);
2215 s.src_sectors = g_new(int64_t, s.src_num);
balrog926c2d22007-10-31 01:11:44 +00002216
Peter Lieven9fd77f92017-04-21 11:11:55 +02002217 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2218 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
Fam Zheng335e9932017-05-03 00:35:39 +08002219 fmt, src_flags, src_writethrough, quiet,
2220 force_share);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002221 if (!s.src[bs_i]) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002222 ret = -1;
2223 goto out;
2224 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002225 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2226 if (s.src_sectors[bs_i] < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002227 error_report("Could not get size of %s: %s",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002228 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002229 ret = -1;
2230 goto out;
2231 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002232 s.total_sectors += s.src_sectors[bs_i];
balrog926c2d22007-10-31 01:11:44 +00002233 }
bellardea2384d2004-08-01 21:59:26 +00002234
Wenchao Xiaef806542013-12-04 17:10:57 +08002235 if (sn_opts) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002236 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
Peter Maydell10d6eda2017-02-10 16:28:24 +00002237 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2238 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2239 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002240 } else if (snapshot_name != NULL) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002241 if (s.src_num > 1) {
Markus Armbruster6daf1942011-06-22 14:03:54 +02002242 error_report("No support for concatenating multiple snapshot");
edison51ef6722010-09-21 19:58:41 -07002243 ret = -1;
2244 goto out;
2245 }
Wenchao Xia7b4c4782013-12-04 17:10:54 +08002246
Peter Lieven9fd77f92017-04-21 11:11:55 +02002247 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2248 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002249 }
Markus Armbruster84d18f02014-01-30 15:07:28 +01002250 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002251 error_reportf_err(local_err, "Failed to load snapshot: ");
Wenchao Xiaef806542013-12-04 17:10:57 +08002252 ret = -1;
2253 goto out;
edison51ef6722010-09-21 19:58:41 -07002254 }
2255
Max Reitz2e024cd2015-02-11 09:58:46 -05002256 if (!skip_create) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002257 /* Find driver and parse its options */
2258 drv = bdrv_find_format(out_fmt);
2259 if (!drv) {
2260 error_report("Unknown file format '%s'", out_fmt);
2261 ret = -1;
2262 goto out;
2263 }
2264
2265 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2266 if (!proto_drv) {
2267 error_report_err(local_err);
2268 ret = -1;
2269 goto out;
2270 }
2271
Max Reitz2e024cd2015-02-11 09:58:46 -05002272 if (!drv->create_opts) {
2273 error_report("Format driver '%s' does not support image creation",
2274 drv->format_name);
2275 ret = -1;
2276 goto out;
2277 }
Max Reitzf75613c2014-12-02 18:32:46 +01002278
Max Reitz2e024cd2015-02-11 09:58:46 -05002279 if (!proto_drv->create_opts) {
2280 error_report("Protocol driver '%s' does not support image creation",
2281 proto_drv->format_name);
2282 ret = -1;
2283 goto out;
2284 }
Max Reitzf75613c2014-12-02 18:32:46 +01002285
Max Reitz2e024cd2015-02-11 09:58:46 -05002286 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2287 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfdb08adf2009-06-04 15:39:38 +02002288
Max Reitz2e024cd2015-02-11 09:58:46 -05002289 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002290 if (options) {
2291 qemu_opts_do_parse(opts, options, NULL, &local_err);
2292 if (local_err) {
Markus Armbruster97a2ca72015-03-14 10:23:15 +01002293 error_report_err(local_err);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002294 ret = -1;
2295 goto out;
2296 }
Max Reitz2e024cd2015-02-11 09:58:46 -05002297 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002298
Peter Lieven9fd77f92017-04-21 11:11:55 +02002299 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
Markus Armbruster39101f22015-02-12 16:46:36 +01002300 &error_abort);
Max Reitz2e024cd2015-02-11 09:58:46 -05002301 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2302 if (ret < 0) {
2303 goto out;
2304 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002305 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002306
Kevin Wolfa18953f2010-10-14 15:46:04 +02002307 /* Get backing file name if -o backing_file was used */
Chunyan Liu83d05212014-06-05 17:20:51 +08002308 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
Kevin Wolfa18953f2010-10-14 15:46:04 +02002309 if (out_baseimg_param) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002310 out_baseimg = out_baseimg_param;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002311 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002312 s.target_has_backing = (bool) out_baseimg;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002313
Max Reitz48758a82017-04-26 15:46:48 +02002314 if (s.src_num > 1 && out_baseimg) {
2315 error_report("Having a backing file for the target makes no sense when "
2316 "concatenating multiple input images");
2317 ret = -1;
2318 goto out;
2319 }
2320
Kevin Wolfefa84d42009-05-18 16:42:12 +02002321 /* Check if compression is supported */
Peter Lieven9fd77f92017-04-21 11:11:55 +02002322 if (s.compressed) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002323 bool encryption =
2324 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002325 const char *encryptfmt =
2326 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
Chunyan Liu83d05212014-06-05 17:20:51 +08002327 const char *preallocation =
2328 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
Kevin Wolfefa84d42009-05-18 16:42:12 +02002329
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002330 if (drv && !drv->bdrv_co_pwritev_compressed) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002331 error_report("Compression not supported for this file format");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002332 ret = -1;
2333 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002334 }
2335
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002336 if (encryption || encryptfmt) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002337 error_report("Compression and encryption not supported at "
2338 "the same time");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002339 ret = -1;
2340 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002341 }
Kevin Wolf41521fa2011-10-18 16:19:42 +02002342
Chunyan Liu83d05212014-06-05 17:20:51 +08002343 if (preallocation
2344 && strcmp(preallocation, "off"))
Kevin Wolf41521fa2011-10-18 16:19:42 +02002345 {
2346 error_report("Compression and preallocation not supported at "
2347 "the same time");
2348 ret = -1;
2349 goto out;
2350 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002351 }
2352
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002353 /*
2354 * The later open call will need any decryption secrets, and
2355 * bdrv_create() will purge "opts", so extract them now before
2356 * they are lost.
2357 */
2358 if (!skip_create) {
2359 open_opts = qdict_new();
2360 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
2361 }
2362
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002363 if (!skip_create) {
2364 /* Create the new image */
Chunyan Liuc282e1f2014-06-05 17:21:11 +08002365 ret = bdrv_create(drv, out_filename, opts, &local_err);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002366 if (ret < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002367 error_reportf_err(local_err, "%s: error while converting %s: ",
2368 out_filename, out_fmt);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002369 goto out;
bellardea2384d2004-08-01 21:59:26 +00002370 }
2371 }
ths3b46e622007-09-17 08:09:54 +00002372
Peter Lieven9fd77f92017-04-21 11:11:55 +02002373 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
Kevin Wolfce099542016-03-15 13:01:04 +01002374 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002375 if (ret < 0) {
2376 error_report("Invalid cache option: %s", cache);
Markus Armbrusterbb9cd2e2014-05-28 11:17:07 +02002377 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002378 }
2379
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002380 if (skip_create) {
2381 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
2382 flags, writethrough, quiet, false);
2383 } else {
2384 /* TODO ultimately we should allow --target-image-opts
2385 * to be used even when -n is not given.
2386 * That has to wait for bdrv_create to be improved
2387 * to allow filenames in option syntax
2388 */
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002389 s.target = img_open_file(out_filename, open_opts, out_fmt,
2390 flags, writethrough, quiet, false);
2391 open_opts = NULL; /* blk_new_open will have freed it */
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002392 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002393 if (!s.target) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002394 ret = -1;
2395 goto out;
2396 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002397 out_bs = blk_bs(s.target);
bellardea2384d2004-08-01 21:59:26 +00002398
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002399 if (s.compressed && !out_bs->drv->bdrv_co_pwritev_compressed) {
2400 error_report("Compression not supported for this file format");
2401 ret = -1;
2402 goto out;
2403 }
2404
Eric Blake5def6b82016-06-23 16:37:19 -06002405 /* increase bufsectors from the default 4096 (2M) if opt_transfer
Peter Lieven6360ab22018-07-13 09:15:39 +02002406 * or discard_alignment of the out_bs is greater. Limit to
2407 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2408 s.buf_sectors = MIN(MAX_BUF_SECTORS,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002409 MAX(s.buf_sectors,
2410 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2411 out_bs->bl.pdiscard_alignment >>
2412 BDRV_SECTOR_BITS)));
Peter Lievenf2521c92013-11-27 11:07:06 +01002413
Peter Lieven8dcd3c92018-07-12 15:00:10 +02002414 /* try to align the write requests to the destination to avoid unnecessary
2415 * RMW cycles. */
2416 s.alignment = MAX(pow2floor(s.min_sparse),
2417 DIV_ROUND_UP(out_bs->bl.request_alignment,
2418 BDRV_SECTOR_SIZE));
2419 assert(is_power_of_2(s.alignment));
2420
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002421 if (skip_create) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002422 int64_t output_sectors = blk_nb_sectors(s.target);
Markus Armbruster43716fa2014-06-26 13:23:21 +02002423 if (output_sectors < 0) {
Gongleieec5eb42015-02-25 12:22:27 +08002424 error_report("unable to get output image length: %s",
Markus Armbruster43716fa2014-06-26 13:23:21 +02002425 strerror(-output_sectors));
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002426 ret = -1;
2427 goto out;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002428 } else if (output_sectors < s.total_sectors) {
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002429 error_report("output file is smaller than input file");
2430 ret = -1;
2431 goto out;
2432 }
2433 }
2434
Max Reitz351c8ef2018-05-01 18:57:49 +02002435 if (s.target_has_backing) {
2436 /* Errors are treated as "backing length unknown" (which means
2437 * s.target_backing_sectors has to be negative, which it will
2438 * be automatically). The backing file length is used only
2439 * for optimizations, so such a case is not fatal. */
2440 s.target_backing_sectors = bdrv_nb_sectors(out_bs->backing->bs);
2441 } else {
2442 s.target_backing_sectors = -1;
2443 }
2444
Peter Lieven24f833c2013-11-27 11:07:07 +01002445 ret = bdrv_get_info(out_bs, &bdi);
2446 if (ret < 0) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002447 if (s.compressed) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002448 error_report("could not get block driver info");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002449 goto out;
2450 }
Peter Lieven24f833c2013-11-27 11:07:07 +01002451 } else {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002452 s.compressed = s.compressed || bdi.needs_compressed_writes;
2453 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
Max Reitz351c8ef2018-05-01 18:57:49 +02002454 s.unallocated_blocks_are_zero = bdi.unallocated_blocks_are_zero;
Peter Lieven24f833c2013-11-27 11:07:07 +01002455 }
2456
Peter Lieven9fd77f92017-04-21 11:11:55 +02002457 ret = convert_do_copy(&s);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002458out:
Peter Lieven13c28af2013-11-27 11:07:01 +01002459 if (!ret) {
2460 qemu_progress_print(100, 0);
2461 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002462 qemu_progress_end();
Chunyan Liu83d05212014-06-05 17:20:51 +08002463 qemu_opts_del(opts);
2464 qemu_opts_free(create_opts);
Markus Armbrusterfbf28a42014-09-29 16:07:55 +02002465 qemu_opts_del(sn_opts);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002466 qobject_unref(open_opts);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002467 blk_unref(s.target);
2468 if (s.src) {
2469 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2470 blk_unref(s.src[bs_i]);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002471 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002472 g_free(s.src);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002473 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002474 g_free(s.src_sectors);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002475fail_getopt:
2476 g_free(options);
2477
Peter Lieven9fd77f92017-04-21 11:11:55 +02002478 return !!ret;
bellardea2384d2004-08-01 21:59:26 +00002479}
2480
bellard57d1a2b2004-08-03 21:15:11 +00002481
bellardfaea38e2006-08-05 21:31:00 +00002482static void dump_snapshots(BlockDriverState *bs)
2483{
2484 QEMUSnapshotInfo *sn_tab, *sn;
2485 int nb_sns, i;
bellardfaea38e2006-08-05 21:31:00 +00002486
2487 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2488 if (nb_sns <= 0)
2489 return;
2490 printf("Snapshot list:\n");
Wenchao Xia5b917042013-05-25 11:09:45 +08002491 bdrv_snapshot_dump(fprintf, stdout, NULL);
2492 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002493 for(i = 0; i < nb_sns; i++) {
2494 sn = &sn_tab[i];
Wenchao Xia5b917042013-05-25 11:09:45 +08002495 bdrv_snapshot_dump(fprintf, stdout, sn);
2496 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002497 }
Anthony Liguori7267c092011-08-20 22:09:37 -05002498 g_free(sn_tab);
bellardfaea38e2006-08-05 21:31:00 +00002499}
2500
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002501static void dump_json_image_info_list(ImageInfoList *list)
2502{
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002503 QString *str;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002504 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002505 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002506
2507 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2508 visit_complete(v, &obj);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002509 str = qobject_to_json_pretty(obj);
2510 assert(str != NULL);
2511 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002512 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002513 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002514 qobject_unref(str);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002515}
2516
Benoît Canetc054b3f2012-09-05 13:09:02 +02002517static void dump_json_image_info(ImageInfo *info)
2518{
Benoît Canetc054b3f2012-09-05 13:09:02 +02002519 QString *str;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002520 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002521 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002522
2523 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2524 visit_complete(v, &obj);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002525 str = qobject_to_json_pretty(obj);
2526 assert(str != NULL);
2527 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002528 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002529 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002530 qobject_unref(str);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002531}
2532
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002533static void dump_human_image_info_list(ImageInfoList *list)
2534{
2535 ImageInfoList *elem;
2536 bool delim = false;
2537
2538 for (elem = list; elem; elem = elem->next) {
2539 if (delim) {
2540 printf("\n");
2541 }
2542 delim = true;
2543
Wenchao Xia5b917042013-05-25 11:09:45 +08002544 bdrv_image_info_dump(fprintf, stdout, elem->value);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002545 }
2546}
2547
2548static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2549{
2550 return strcmp(a, b) == 0;
2551}
2552
2553/**
2554 * Open an image file chain and return an ImageInfoList
2555 *
2556 * @filename: topmost image filename
2557 * @fmt: topmost image format (may be NULL to autodetect)
2558 * @chain: true - enumerate entire backing file chain
2559 * false - only topmost image file
2560 *
2561 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2562 * image file. If there was an error a message will have been printed to
2563 * stderr.
2564 */
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002565static ImageInfoList *collect_image_info_list(bool image_opts,
2566 const char *filename,
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002567 const char *fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002568 bool chain, bool force_share)
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002569{
2570 ImageInfoList *head = NULL;
2571 ImageInfoList **last = &head;
2572 GHashTable *filenames;
Wenchao Xia43526ec2013-06-06 12:27:58 +08002573 Error *err = NULL;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002574
2575 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2576
2577 while (filename) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02002578 BlockBackend *blk;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002579 BlockDriverState *bs;
2580 ImageInfo *info;
2581 ImageInfoList *elem;
2582
2583 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2584 error_report("Backing file '%s' creates an infinite loop.",
2585 filename);
2586 goto err;
2587 }
2588 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2589
Max Reitzefaa7c42016-03-16 19:54:38 +01002590 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002591 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2592 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002593 if (!blk) {
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002594 goto err;
2595 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002596 bs = blk_bs(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002597
Wenchao Xia43526ec2013-06-06 12:27:58 +08002598 bdrv_query_image_info(bs, &info, &err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002599 if (err) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01002600 error_report_err(err);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002601 blk_unref(blk);
Wenchao Xia43526ec2013-06-06 12:27:58 +08002602 goto err;
Wenchao Xiafb0ed452013-06-06 12:27:57 +08002603 }
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002604
2605 elem = g_new0(ImageInfoList, 1);
2606 elem->value = info;
2607 *last = elem;
2608 last = &elem->next;
2609
Markus Armbruster26f54e92014-10-07 13:59:04 +02002610 blk_unref(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002611
2612 filename = fmt = NULL;
2613 if (chain) {
2614 if (info->has_full_backing_filename) {
2615 filename = info->full_backing_filename;
2616 } else if (info->has_backing_filename) {
John Snow92d617a2015-12-14 14:55:15 -05002617 error_report("Could not determine absolute backing filename,"
2618 " but backing filename '%s' present",
2619 info->backing_filename);
2620 goto err;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002621 }
2622 if (info->has_backing_filename_format) {
2623 fmt = info->backing_filename_format;
2624 }
2625 }
2626 }
2627 g_hash_table_destroy(filenames);
2628 return head;
2629
2630err:
2631 qapi_free_ImageInfoList(head);
2632 g_hash_table_destroy(filenames);
2633 return NULL;
2634}
2635
Benoît Canetc054b3f2012-09-05 13:09:02 +02002636static int img_info(int argc, char **argv)
2637{
2638 int c;
2639 OutputFormat output_format = OFORMAT_HUMAN;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002640 bool chain = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002641 const char *filename, *fmt, *output;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002642 ImageInfoList *list;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002643 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08002644 bool force_share = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002645
bellardea2384d2004-08-01 21:59:26 +00002646 fmt = NULL;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002647 output = NULL;
bellardea2384d2004-08-01 21:59:26 +00002648 for(;;) {
Benoît Canetc054b3f2012-09-05 13:09:02 +02002649 int option_index = 0;
2650 static const struct option long_options[] = {
2651 {"help", no_argument, 0, 'h'},
2652 {"format", required_argument, 0, 'f'},
2653 {"output", required_argument, 0, OPTION_OUTPUT},
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002654 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002655 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002656 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002657 {"force-share", no_argument, 0, 'U'},
Benoît Canetc054b3f2012-09-05 13:09:02 +02002658 {0, 0, 0, 0}
2659 };
Fam Zheng335e9932017-05-03 00:35:39 +08002660 c = getopt_long(argc, argv, ":f:hU",
Benoît Canetc054b3f2012-09-05 13:09:02 +02002661 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002662 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002663 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002664 }
bellardea2384d2004-08-01 21:59:26 +00002665 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002666 case ':':
2667 missing_argument(argv[optind - 1]);
2668 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002669 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002670 unrecognized_option(argv[optind - 1]);
2671 break;
bellardea2384d2004-08-01 21:59:26 +00002672 case 'h':
2673 help();
2674 break;
2675 case 'f':
2676 fmt = optarg;
2677 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002678 case 'U':
2679 force_share = true;
2680 break;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002681 case OPTION_OUTPUT:
2682 output = optarg;
2683 break;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002684 case OPTION_BACKING_CHAIN:
2685 chain = true;
2686 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002687 case OPTION_OBJECT: {
2688 QemuOpts *opts;
2689 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2690 optarg, true);
2691 if (!opts) {
2692 return 1;
2693 }
2694 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002695 case OPTION_IMAGE_OPTS:
2696 image_opts = true;
2697 break;
bellardea2384d2004-08-01 21:59:26 +00002698 }
2699 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02002700 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08002701 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002702 }
bellardea2384d2004-08-01 21:59:26 +00002703 filename = argv[optind++];
2704
Benoît Canetc054b3f2012-09-05 13:09:02 +02002705 if (output && !strcmp(output, "json")) {
2706 output_format = OFORMAT_JSON;
2707 } else if (output && !strcmp(output, "human")) {
2708 output_format = OFORMAT_HUMAN;
2709 } else if (output) {
2710 error_report("--output must be used with human or json as argument.");
2711 return 1;
2712 }
2713
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002714 if (qemu_opts_foreach(&qemu_object_opts,
2715 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02002716 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002717 return 1;
2718 }
2719
Fam Zheng335e9932017-05-03 00:35:39 +08002720 list = collect_image_info_list(image_opts, filename, fmt, chain,
2721 force_share);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002722 if (!list) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002723 return 1;
2724 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002725
Benoît Canetc054b3f2012-09-05 13:09:02 +02002726 switch (output_format) {
2727 case OFORMAT_HUMAN:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002728 dump_human_image_info_list(list);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002729 break;
2730 case OFORMAT_JSON:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002731 if (chain) {
2732 dump_json_image_info_list(list);
2733 } else {
2734 dump_json_image_info(list->value);
2735 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002736 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002737 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002738
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002739 qapi_free_ImageInfoList(list);
bellardea2384d2004-08-01 21:59:26 +00002740 return 0;
2741}
2742
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002743static void dump_map_entry(OutputFormat output_format, MapEntry *e,
2744 MapEntry *next)
2745{
2746 switch (output_format) {
2747 case OFORMAT_HUMAN:
Fam Zheng16b0d552016-01-26 11:59:02 +08002748 if (e->data && !e->has_offset) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002749 error_report("File contains external, encrypted or compressed clusters.");
2750 exit(1);
2751 }
Fam Zheng16b0d552016-01-26 11:59:02 +08002752 if (e->data && !e->zero) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002753 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
Fam Zheng16b0d552016-01-26 11:59:02 +08002754 e->start, e->length,
2755 e->has_offset ? e->offset : 0,
2756 e->has_filename ? e->filename : "");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002757 }
2758 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2759 * Modify the flags here to allow more coalescing.
2760 */
Fam Zheng16b0d552016-01-26 11:59:02 +08002761 if (next && (!next->data || next->zero)) {
2762 next->data = false;
2763 next->zero = true;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002764 }
2765 break;
2766 case OFORMAT_JSON:
Fam Zheng16b0d552016-01-26 11:59:02 +08002767 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
2768 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002769 (e->start == 0 ? "[" : ",\n"),
2770 e->start, e->length, e->depth,
Fam Zheng16b0d552016-01-26 11:59:02 +08002771 e->zero ? "true" : "false",
2772 e->data ? "true" : "false");
2773 if (e->has_offset) {
Paolo Bonzinic745bfb2013-09-11 18:47:52 +02002774 printf(", \"offset\": %"PRId64"", e->offset);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002775 }
2776 putchar('}');
2777
2778 if (!next) {
2779 printf("]\n");
2780 }
2781 break;
2782 }
2783}
2784
Eric Blake5e344dd2017-10-11 22:47:02 -05002785static int get_block_status(BlockDriverState *bs, int64_t offset,
2786 int64_t bytes, MapEntry *e)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002787{
Eric Blake237d78f2017-10-11 22:47:03 -05002788 int ret;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002789 int depth;
Fam Zheng67a0fd22016-01-26 11:58:48 +08002790 BlockDriverState *file;
John Snow28756452016-02-05 13:12:33 -05002791 bool has_offset;
Eric Blake237d78f2017-10-11 22:47:03 -05002792 int64_t map;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002793
2794 /* As an optimization, we could cache the current range of unallocated
2795 * clusters in each file of the chain, and avoid querying the same
2796 * range repeatedly.
2797 */
2798
2799 depth = 0;
2800 for (;;) {
Eric Blake237d78f2017-10-11 22:47:03 -05002801 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002802 if (ret < 0) {
2803 return ret;
2804 }
Eric Blake237d78f2017-10-11 22:47:03 -05002805 assert(bytes);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002806 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2807 break;
2808 }
Kevin Wolf760e0062015-06-17 14:55:21 +02002809 bs = backing_bs(bs);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002810 if (bs == NULL) {
2811 ret = 0;
2812 break;
2813 }
2814
2815 depth++;
2816 }
2817
John Snow28756452016-02-05 13:12:33 -05002818 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
2819
2820 *e = (MapEntry) {
Eric Blake5e344dd2017-10-11 22:47:02 -05002821 .start = offset,
Eric Blake237d78f2017-10-11 22:47:03 -05002822 .length = bytes,
John Snow28756452016-02-05 13:12:33 -05002823 .data = !!(ret & BDRV_BLOCK_DATA),
2824 .zero = !!(ret & BDRV_BLOCK_ZERO),
Eric Blake237d78f2017-10-11 22:47:03 -05002825 .offset = map,
John Snow28756452016-02-05 13:12:33 -05002826 .has_offset = has_offset,
2827 .depth = depth,
2828 .has_filename = file && has_offset,
2829 .filename = file && has_offset ? file->filename : NULL,
2830 };
2831
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002832 return 0;
2833}
2834
Fam Zheng16b0d552016-01-26 11:59:02 +08002835static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
2836{
2837 if (curr->length == 0) {
2838 return false;
2839 }
2840 if (curr->zero != next->zero ||
2841 curr->data != next->data ||
2842 curr->depth != next->depth ||
2843 curr->has_filename != next->has_filename ||
2844 curr->has_offset != next->has_offset) {
2845 return false;
2846 }
2847 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
2848 return false;
2849 }
2850 if (curr->has_offset && curr->offset + curr->length != next->offset) {
2851 return false;
2852 }
2853 return true;
2854}
2855
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002856static int img_map(int argc, char **argv)
2857{
2858 int c;
2859 OutputFormat output_format = OFORMAT_HUMAN;
Markus Armbruster26f54e92014-10-07 13:59:04 +02002860 BlockBackend *blk;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002861 BlockDriverState *bs;
2862 const char *filename, *fmt, *output;
2863 int64_t length;
2864 MapEntry curr = { .length = 0 }, next;
2865 int ret = 0;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002866 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08002867 bool force_share = false;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002868
2869 fmt = NULL;
2870 output = NULL;
2871 for (;;) {
2872 int option_index = 0;
2873 static const struct option long_options[] = {
2874 {"help", no_argument, 0, 'h'},
2875 {"format", required_argument, 0, 'f'},
2876 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002877 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002878 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002879 {"force-share", no_argument, 0, 'U'},
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002880 {0, 0, 0, 0}
2881 };
Fam Zheng335e9932017-05-03 00:35:39 +08002882 c = getopt_long(argc, argv, ":f:hU",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002883 long_options, &option_index);
2884 if (c == -1) {
2885 break;
2886 }
2887 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002888 case ':':
2889 missing_argument(argv[optind - 1]);
2890 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002891 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002892 unrecognized_option(argv[optind - 1]);
2893 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002894 case 'h':
2895 help();
2896 break;
2897 case 'f':
2898 fmt = optarg;
2899 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002900 case 'U':
2901 force_share = true;
2902 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002903 case OPTION_OUTPUT:
2904 output = optarg;
2905 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002906 case OPTION_OBJECT: {
2907 QemuOpts *opts;
2908 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2909 optarg, true);
2910 if (!opts) {
2911 return 1;
2912 }
2913 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002914 case OPTION_IMAGE_OPTS:
2915 image_opts = true;
2916 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002917 }
2918 }
Fam Zhengac1307a2014-04-22 13:36:11 +08002919 if (optind != argc - 1) {
2920 error_exit("Expecting one image file name");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002921 }
Fam Zhengac1307a2014-04-22 13:36:11 +08002922 filename = argv[optind];
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002923
2924 if (output && !strcmp(output, "json")) {
2925 output_format = OFORMAT_JSON;
2926 } else if (output && !strcmp(output, "human")) {
2927 output_format = OFORMAT_HUMAN;
2928 } else if (output) {
2929 error_report("--output must be used with human or json as argument.");
2930 return 1;
2931 }
2932
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002933 if (qemu_opts_foreach(&qemu_object_opts,
2934 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02002935 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002936 return 1;
2937 }
2938
Fam Zheng335e9932017-05-03 00:35:39 +08002939 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002940 if (!blk) {
2941 return 1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002942 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002943 bs = blk_bs(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002944
2945 if (output_format == OFORMAT_HUMAN) {
2946 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2947 }
2948
Max Reitzf1d3cd72015-02-05 13:58:18 -05002949 length = blk_getlength(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002950 while (curr.start + curr.length < length) {
Eric Blake5e344dd2017-10-11 22:47:02 -05002951 int64_t offset = curr.start + curr.length;
2952 int64_t n;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002953
2954 /* Probe up to 1 GiB at a time. */
Eric Blakee0b371e2018-06-11 16:39:26 -05002955 n = MIN(1 << 30, length - offset);
Eric Blake5e344dd2017-10-11 22:47:02 -05002956 ret = get_block_status(bs, offset, n, &next);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002957
2958 if (ret < 0) {
2959 error_report("Could not read file metadata: %s", strerror(-ret));
2960 goto out;
2961 }
2962
Fam Zheng16b0d552016-01-26 11:59:02 +08002963 if (entry_mergeable(&curr, &next)) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002964 curr.length += next.length;
2965 continue;
2966 }
2967
2968 if (curr.length > 0) {
2969 dump_map_entry(output_format, &curr, &next);
2970 }
2971 curr = next;
2972 }
2973
2974 dump_map_entry(output_format, &curr, NULL);
2975
2976out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02002977 blk_unref(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002978 return ret < 0;
2979}
2980
aliguorif7b4a942009-01-07 17:40:15 +00002981#define SNAPSHOT_LIST 1
2982#define SNAPSHOT_CREATE 2
2983#define SNAPSHOT_APPLY 3
2984#define SNAPSHOT_DELETE 4
2985
Stuart Brady153859b2009-06-07 00:42:17 +01002986static int img_snapshot(int argc, char **argv)
aliguorif7b4a942009-01-07 17:40:15 +00002987{
Markus Armbruster26f54e92014-10-07 13:59:04 +02002988 BlockBackend *blk;
aliguorif7b4a942009-01-07 17:40:15 +00002989 BlockDriverState *bs;
2990 QEMUSnapshotInfo sn;
2991 char *filename, *snapshot_name = NULL;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002992 int c, ret = 0, bdrv_oflags;
aliguorif7b4a942009-01-07 17:40:15 +00002993 int action = 0;
2994 qemu_timeval tv;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002995 bool quiet = false;
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08002996 Error *err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002997 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08002998 bool force_share = false;
aliguorif7b4a942009-01-07 17:40:15 +00002999
Kevin Wolfce099542016-03-15 13:01:04 +01003000 bdrv_oflags = BDRV_O_RDWR;
aliguorif7b4a942009-01-07 17:40:15 +00003001 /* Parse commandline parameters */
3002 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003003 static const struct option long_options[] = {
3004 {"help", no_argument, 0, 'h'},
3005 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003006 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003007 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003008 {0, 0, 0, 0}
3009 };
Fam Zheng335e9932017-05-03 00:35:39 +08003010 c = getopt_long(argc, argv, ":la:c:d:hqU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003011 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003012 if (c == -1) {
aliguorif7b4a942009-01-07 17:40:15 +00003013 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003014 }
aliguorif7b4a942009-01-07 17:40:15 +00003015 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003016 case ':':
3017 missing_argument(argv[optind - 1]);
3018 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003019 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003020 unrecognized_option(argv[optind - 1]);
3021 break;
aliguorif7b4a942009-01-07 17:40:15 +00003022 case 'h':
3023 help();
Stuart Brady153859b2009-06-07 00:42:17 +01003024 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003025 case 'l':
3026 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003027 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003028 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003029 }
3030 action = SNAPSHOT_LIST;
Naphtali Spreif5edb012010-01-17 16:48:13 +02003031 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
aliguorif7b4a942009-01-07 17:40:15 +00003032 break;
3033 case 'a':
3034 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003035 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003036 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003037 }
3038 action = SNAPSHOT_APPLY;
3039 snapshot_name = optarg;
3040 break;
3041 case 'c':
3042 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003043 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003044 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003045 }
3046 action = SNAPSHOT_CREATE;
3047 snapshot_name = optarg;
3048 break;
3049 case 'd':
3050 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003051 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003052 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003053 }
3054 action = SNAPSHOT_DELETE;
3055 snapshot_name = optarg;
3056 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003057 case 'q':
3058 quiet = true;
3059 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003060 case 'U':
3061 force_share = true;
3062 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003063 case OPTION_OBJECT: {
3064 QemuOpts *opts;
3065 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3066 optarg, true);
3067 if (!opts) {
3068 return 1;
3069 }
3070 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003071 case OPTION_IMAGE_OPTS:
3072 image_opts = true;
3073 break;
aliguorif7b4a942009-01-07 17:40:15 +00003074 }
3075 }
3076
Kevin Wolffc11eb22013-08-05 10:53:04 +02003077 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003078 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003079 }
aliguorif7b4a942009-01-07 17:40:15 +00003080 filename = argv[optind++];
3081
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003082 if (qemu_opts_foreach(&qemu_object_opts,
3083 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02003084 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003085 return 1;
3086 }
3087
aliguorif7b4a942009-01-07 17:40:15 +00003088 /* Open the image */
Fam Zheng335e9932017-05-03 00:35:39 +08003089 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3090 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003091 if (!blk) {
3092 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003093 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003094 bs = blk_bs(blk);
aliguorif7b4a942009-01-07 17:40:15 +00003095
3096 /* Perform the requested action */
3097 switch(action) {
3098 case SNAPSHOT_LIST:
3099 dump_snapshots(bs);
3100 break;
3101
3102 case SNAPSHOT_CREATE:
3103 memset(&sn, 0, sizeof(sn));
3104 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3105
3106 qemu_gettimeofday(&tv);
3107 sn.date_sec = tv.tv_sec;
3108 sn.date_nsec = tv.tv_usec * 1000;
3109
3110 ret = bdrv_snapshot_create(bs, &sn);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003111 if (ret) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003112 error_report("Could not create snapshot '%s': %d (%s)",
aliguorif7b4a942009-01-07 17:40:15 +00003113 snapshot_name, ret, strerror(-ret));
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003114 }
aliguorif7b4a942009-01-07 17:40:15 +00003115 break;
3116
3117 case SNAPSHOT_APPLY:
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003118 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003119 if (ret) {
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003120 error_reportf_err(err, "Could not apply snapshot '%s': ",
3121 snapshot_name);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003122 }
aliguorif7b4a942009-01-07 17:40:15 +00003123 break;
3124
3125 case SNAPSHOT_DELETE:
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003126 bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01003127 if (err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01003128 error_reportf_err(err, "Could not delete snapshot '%s': ",
3129 snapshot_name);
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003130 ret = 1;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003131 }
aliguorif7b4a942009-01-07 17:40:15 +00003132 break;
3133 }
3134
3135 /* Cleanup */
Markus Armbruster26f54e92014-10-07 13:59:04 +02003136 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003137 if (ret) {
3138 return 1;
3139 }
Stuart Brady153859b2009-06-07 00:42:17 +01003140 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003141}
3142
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003143static int img_rebase(int argc, char **argv)
3144{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003145 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
Paolo Bonzini396374c2016-02-25 23:53:54 +01003146 uint8_t *buf_old = NULL;
3147 uint8_t *buf_new = NULL;
Max Reitzf1d3cd72015-02-05 13:58:18 -05003148 BlockDriverState *bs = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003149 char *filename;
Max Reitz40055952014-07-22 22:58:42 +02003150 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3151 int c, flags, src_flags, ret;
Kevin Wolfce099542016-03-15 13:01:04 +01003152 bool writethrough, src_writethrough;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003153 int unsafe = 0;
Fam Zheng335e9932017-05-03 00:35:39 +08003154 bool force_share = false;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003155 int progress = 0;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003156 bool quiet = false;
Max Reitz34b5d2c2013-09-05 14:45:29 +02003157 Error *local_err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003158 bool image_opts = false;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003159
3160 /* Parse commandline parameters */
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003161 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003162 cache = BDRV_DEFAULT_CACHE;
Max Reitz40055952014-07-22 22:58:42 +02003163 src_cache = BDRV_DEFAULT_CACHE;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003164 out_baseimg = NULL;
3165 out_basefmt = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003166 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003167 static const struct option long_options[] = {
3168 {"help", no_argument, 0, 'h'},
3169 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003170 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003171 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003172 {0, 0, 0, 0}
3173 };
Fam Zheng335e9932017-05-03 00:35:39 +08003174 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003175 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003176 if (c == -1) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003177 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003178 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003179 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003180 case ':':
3181 missing_argument(argv[optind - 1]);
3182 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003183 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003184 unrecognized_option(argv[optind - 1]);
3185 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003186 case 'h':
3187 help();
3188 return 0;
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003189 case 'f':
3190 fmt = optarg;
3191 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003192 case 'F':
3193 out_basefmt = optarg;
3194 break;
3195 case 'b':
3196 out_baseimg = optarg;
3197 break;
3198 case 'u':
3199 unsafe = 1;
3200 break;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003201 case 'p':
3202 progress = 1;
3203 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003204 case 't':
3205 cache = optarg;
3206 break;
Max Reitz40055952014-07-22 22:58:42 +02003207 case 'T':
3208 src_cache = optarg;
3209 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003210 case 'q':
3211 quiet = true;
3212 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003213 case OPTION_OBJECT: {
3214 QemuOpts *opts;
3215 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3216 optarg, true);
3217 if (!opts) {
3218 return 1;
3219 }
3220 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003221 case OPTION_IMAGE_OPTS:
3222 image_opts = true;
3223 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003224 case 'U':
3225 force_share = true;
3226 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003227 }
3228 }
3229
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003230 if (quiet) {
3231 progress = 0;
3232 }
3233
Fam Zhengac1307a2014-04-22 13:36:11 +08003234 if (optind != argc - 1) {
3235 error_exit("Expecting one image file name");
3236 }
3237 if (!unsafe && !out_baseimg) {
3238 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003239 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003240 filename = argv[optind++];
3241
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003242 if (qemu_opts_foreach(&qemu_object_opts,
3243 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02003244 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003245 return 1;
3246 }
3247
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003248 qemu_progress_init(progress, 2.0);
3249 qemu_progress_print(0, 100);
3250
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003251 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
Kevin Wolfce099542016-03-15 13:01:04 +01003252 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003253 if (ret < 0) {
3254 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003255 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003256 }
3257
Kevin Wolfce099542016-03-15 13:01:04 +01003258 src_flags = 0;
3259 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
Max Reitz40055952014-07-22 22:58:42 +02003260 if (ret < 0) {
3261 error_report("Invalid source cache option: %s", src_cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003262 goto out;
Max Reitz40055952014-07-22 22:58:42 +02003263 }
3264
Kevin Wolfce099542016-03-15 13:01:04 +01003265 /* The source files are opened read-only, don't care about WCE */
3266 assert((src_flags & BDRV_O_RDWR) == 0);
3267 (void) src_writethrough;
3268
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003269 /*
3270 * Open the images.
3271 *
3272 * Ignore the old backing file for unsafe rebase in case we want to correct
3273 * the reference to a renamed or moved backing file.
3274 */
Fam Zheng335e9932017-05-03 00:35:39 +08003275 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3276 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003277 if (!blk) {
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003278 ret = -1;
3279 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003280 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003281 bs = blk_bs(blk);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003282
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003283 if (out_basefmt != NULL) {
Max Reitz644483d2015-02-05 13:58:17 -05003284 if (bdrv_find_format(out_basefmt) == NULL) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003285 error_report("Invalid format name: '%s'", out_basefmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003286 ret = -1;
3287 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003288 }
3289 }
3290
3291 /* For safe rebasing we need to compare old and new backing file */
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003292 if (!unsafe) {
Jeff Cody9a29e182015-01-22 08:03:30 -05003293 char backing_name[PATH_MAX];
Max Reitz644483d2015-02-05 13:58:17 -05003294 QDict *options = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003295
Max Reitz644483d2015-02-05 13:58:17 -05003296 if (bs->backing_format[0] != '\0') {
3297 options = qdict_new();
Eric Blake46f5ac22017-04-27 16:58:17 -05003298 qdict_put_str(options, "driver", bs->backing_format);
Max Reitz644483d2015-02-05 13:58:17 -05003299 }
3300
Fam Zheng335e9932017-05-03 00:35:39 +08003301 if (force_share) {
3302 if (!options) {
3303 options = qdict_new();
3304 }
Eric Blake579cf1d2017-05-15 14:54:39 -05003305 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Fam Zheng335e9932017-05-03 00:35:39 +08003306 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003307 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
Max Reitzefaa7c42016-03-16 19:54:38 +01003308 blk_old_backing = blk_new_open(backing_name, NULL,
Max Reitz644483d2015-02-05 13:58:17 -05003309 options, src_flags, &local_err);
3310 if (!blk_old_backing) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01003311 error_reportf_err(local_err,
3312 "Could not open old backing file '%s': ",
3313 backing_name);
Xu Tiane84a0dd2016-10-09 17:17:27 +08003314 ret = -1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003315 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003316 }
Max Reitz644483d2015-02-05 13:58:17 -05003317
Alex Bligha6166732012-10-16 13:46:18 +01003318 if (out_baseimg[0]) {
Max Reitzd16699b2018-05-09 20:20:01 +02003319 const char *overlay_filename;
3320 char *out_real_path;
3321
Fam Zheng335e9932017-05-03 00:35:39 +08003322 options = qdict_new();
Max Reitz644483d2015-02-05 13:58:17 -05003323 if (out_basefmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003324 qdict_put_str(options, "driver", out_basefmt);
Fam Zheng335e9932017-05-03 00:35:39 +08003325 }
3326 if (force_share) {
3327 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Max Reitz644483d2015-02-05 13:58:17 -05003328 }
3329
Max Reitzd16699b2018-05-09 20:20:01 +02003330 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3331 : bs->filename;
3332 out_real_path = g_malloc(PATH_MAX);
3333
3334 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3335 out_baseimg,
3336 out_real_path,
3337 PATH_MAX,
3338 &local_err);
3339 if (local_err) {
3340 error_reportf_err(local_err,
3341 "Could not resolve backing filename: ");
3342 ret = -1;
3343 g_free(out_real_path);
3344 goto out;
3345 }
3346
3347 blk_new_backing = blk_new_open(out_real_path, NULL,
Max Reitz644483d2015-02-05 13:58:17 -05003348 options, src_flags, &local_err);
Max Reitzd16699b2018-05-09 20:20:01 +02003349 g_free(out_real_path);
Max Reitz644483d2015-02-05 13:58:17 -05003350 if (!blk_new_backing) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01003351 error_reportf_err(local_err,
3352 "Could not open new backing file '%s': ",
3353 out_baseimg);
Xu Tiane84a0dd2016-10-09 17:17:27 +08003354 ret = -1;
Alex Bligha6166732012-10-16 13:46:18 +01003355 goto out;
3356 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003357 }
3358 }
3359
3360 /*
3361 * Check each unallocated cluster in the COW file. If it is unallocated,
3362 * accesses go to the backing file. We must therefore compare this cluster
3363 * in the old and new backing file, and if they differ we need to copy it
3364 * from the old backing file into the COW file.
3365 *
3366 * If qemu-img crashes during this step, no harm is done. The content of
3367 * the image is the same as the original one at any time.
3368 */
3369 if (!unsafe) {
Eric Blake41536282017-10-11 22:47:15 -05003370 int64_t size;
3371 int64_t old_backing_size;
3372 int64_t new_backing_size = 0;
3373 uint64_t offset;
3374 int64_t n;
Kevin Wolf1f710492012-10-12 14:29:18 +02003375 float local_progress = 0;
TeLeMand6771bf2010-02-08 16:20:00 +08003376
Max Reitzf1d3cd72015-02-05 13:58:18 -05003377 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3378 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003379
Eric Blake41536282017-10-11 22:47:15 -05003380 size = blk_getlength(blk);
3381 if (size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003382 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003383 filename, strerror(-size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003384 ret = -1;
3385 goto out;
3386 }
Eric Blake41536282017-10-11 22:47:15 -05003387 old_backing_size = blk_getlength(blk_old_backing);
3388 if (old_backing_size < 0) {
Jeff Cody9a29e182015-01-22 08:03:30 -05003389 char backing_name[PATH_MAX];
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003390
3391 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3392 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003393 backing_name, strerror(-old_backing_size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003394 ret = -1;
3395 goto out;
3396 }
Max Reitzf1d3cd72015-02-05 13:58:18 -05003397 if (blk_new_backing) {
Eric Blake41536282017-10-11 22:47:15 -05003398 new_backing_size = blk_getlength(blk_new_backing);
3399 if (new_backing_size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003400 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003401 out_baseimg, strerror(-new_backing_size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003402 ret = -1;
3403 goto out;
3404 }
Alex Bligha6166732012-10-16 13:46:18 +01003405 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003406
Eric Blake41536282017-10-11 22:47:15 -05003407 if (size != 0) {
3408 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
Kevin Wolf1f710492012-10-12 14:29:18 +02003409 }
3410
Eric Blake41536282017-10-11 22:47:15 -05003411 for (offset = 0; offset < size; offset += n) {
3412 /* How many bytes can we handle with the next read? */
3413 n = MIN(IO_BUF_SIZE, size - offset);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003414
3415 /* If the cluster is allocated, we don't need to take action */
Eric Blake41536282017-10-11 22:47:15 -05003416 ret = bdrv_is_allocated(bs, offset, n, &n);
Paolo Bonzinid6636402013-09-04 19:00:25 +02003417 if (ret < 0) {
3418 error_report("error while reading image metadata: %s",
3419 strerror(-ret));
3420 goto out;
3421 }
Kevin Wolfcc60e322010-04-29 14:47:48 +02003422 if (ret) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003423 continue;
3424 }
3425
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003426 /*
3427 * Read old and new backing file and take into consideration that
3428 * backing files may be smaller than the COW image.
3429 */
Eric Blake41536282017-10-11 22:47:15 -05003430 if (offset >= old_backing_size) {
3431 memset(buf_old, 0, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003432 } else {
Eric Blake41536282017-10-11 22:47:15 -05003433 if (offset + n > old_backing_size) {
3434 n = old_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003435 }
3436
Eric Blake41536282017-10-11 22:47:15 -05003437 ret = blk_pread(blk_old_backing, offset, buf_old, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003438 if (ret < 0) {
3439 error_report("error while reading from old backing file");
3440 goto out;
3441 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003442 }
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003443
Eric Blake41536282017-10-11 22:47:15 -05003444 if (offset >= new_backing_size || !blk_new_backing) {
3445 memset(buf_new, 0, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003446 } else {
Eric Blake41536282017-10-11 22:47:15 -05003447 if (offset + n > new_backing_size) {
3448 n = new_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003449 }
3450
Eric Blake41536282017-10-11 22:47:15 -05003451 ret = blk_pread(blk_new_backing, offset, buf_new, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003452 if (ret < 0) {
3453 error_report("error while reading from new backing file");
3454 goto out;
3455 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003456 }
3457
3458 /* If they differ, we need to write to the COW file */
3459 uint64_t written = 0;
3460
Eric Blake41536282017-10-11 22:47:15 -05003461 while (written < n) {
Eric Blakedc61cd32017-10-11 22:47:14 -05003462 int64_t pnum;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003463
Eric Blake41536282017-10-11 22:47:15 -05003464 if (compare_buffers(buf_old + written, buf_new + written,
3465 n - written, &pnum))
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003466 {
Eric Blake41536282017-10-11 22:47:15 -05003467 ret = blk_pwrite(blk, offset + written,
Eric Blakedc61cd32017-10-11 22:47:14 -05003468 buf_old + written, pnum, 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003469 if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003470 error_report("Error while writing to COW image: %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003471 strerror(-ret));
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003472 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003473 }
3474 }
3475
3476 written += pnum;
3477 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003478 qemu_progress_print(local_progress, 100);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003479 }
3480 }
3481
3482 /*
3483 * Change the backing file. All clusters that are different from the old
3484 * backing file are overwritten in the COW file now, so the visible content
3485 * doesn't change when we switch the backing file.
3486 */
Alex Bligha6166732012-10-16 13:46:18 +01003487 if (out_baseimg && *out_baseimg) {
3488 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
3489 } else {
3490 ret = bdrv_change_backing_file(bs, NULL, NULL);
3491 }
3492
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003493 if (ret == -ENOSPC) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003494 error_report("Could not change the backing file to '%s': No "
3495 "space left in the file header", out_baseimg);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003496 } else if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003497 error_report("Could not change the backing file to '%s': %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003498 out_baseimg, strerror(-ret));
3499 }
3500
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003501 qemu_progress_print(100, 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003502 /*
3503 * TODO At this point it is possible to check if any clusters that are
3504 * allocated in the COW file are the same in the backing file. If so, they
3505 * could be dropped from the COW file. Don't do this before switching the
3506 * backing file, in case of a crash this would lead to corruption.
3507 */
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003508out:
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003509 qemu_progress_end();
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003510 /* Cleanup */
3511 if (!unsafe) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02003512 blk_unref(blk_old_backing);
Markus Armbruster26f54e92014-10-07 13:59:04 +02003513 blk_unref(blk_new_backing);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003514 }
Paolo Bonzini396374c2016-02-25 23:53:54 +01003515 qemu_vfree(buf_old);
3516 qemu_vfree(buf_new);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003517
Markus Armbruster26f54e92014-10-07 13:59:04 +02003518 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003519 if (ret) {
3520 return 1;
3521 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003522 return 0;
3523}
3524
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003525static int img_resize(int argc, char **argv)
3526{
Markus Armbruster6750e792015-02-12 17:43:08 +01003527 Error *err = NULL;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003528 int c, ret, relative;
3529 const char *filename, *fmt, *size;
Max Reitz5279b302018-04-21 18:39:57 +02003530 int64_t n, total_size, current_size, new_size;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003531 bool quiet = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003532 BlockBackend *blk = NULL;
Max Reitzdc5f6902017-06-13 22:20:55 +02003533 PreallocMode prealloc = PREALLOC_MODE_OFF;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003534 QemuOpts *param;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003535
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003536 static QemuOptsList resize_options = {
3537 .name = "resize_options",
3538 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3539 .desc = {
3540 {
3541 .name = BLOCK_OPT_SIZE,
3542 .type = QEMU_OPT_SIZE,
3543 .help = "Virtual disk size"
3544 }, {
3545 /* end of list */
3546 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003547 },
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003548 };
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003549 bool image_opts = false;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003550 bool shrink = false;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003551
Kevin Wolfe80fec72011-04-29 10:58:12 +02003552 /* Remove size from argv manually so that negative numbers are not treated
3553 * as options by getopt. */
3554 if (argc < 3) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003555 error_exit("Not enough arguments");
Kevin Wolfe80fec72011-04-29 10:58:12 +02003556 return 1;
3557 }
3558
3559 size = argv[--argc];
3560
3561 /* Parse getopt arguments */
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003562 fmt = NULL;
3563 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003564 static const struct option long_options[] = {
3565 {"help", no_argument, 0, 'h'},
3566 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003567 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Max Reitzdc5f6902017-06-13 22:20:55 +02003568 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003569 {"shrink", no_argument, 0, OPTION_SHRINK},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003570 {0, 0, 0, 0}
3571 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003572 c = getopt_long(argc, argv, ":f:hq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003573 long_options, NULL);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003574 if (c == -1) {
3575 break;
3576 }
3577 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003578 case ':':
3579 missing_argument(argv[optind - 1]);
3580 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003581 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003582 unrecognized_option(argv[optind - 1]);
3583 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003584 case 'h':
3585 help();
3586 break;
3587 case 'f':
3588 fmt = optarg;
3589 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003590 case 'q':
3591 quiet = true;
3592 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003593 case OPTION_OBJECT: {
3594 QemuOpts *opts;
3595 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3596 optarg, true);
3597 if (!opts) {
3598 return 1;
3599 }
3600 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003601 case OPTION_IMAGE_OPTS:
3602 image_opts = true;
3603 break;
Max Reitzdc5f6902017-06-13 22:20:55 +02003604 case OPTION_PREALLOCATION:
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02003605 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
Markus Armbruster06c60b62017-08-24 10:45:57 +02003606 PREALLOC_MODE__MAX, NULL);
Max Reitzdc5f6902017-06-13 22:20:55 +02003607 if (prealloc == PREALLOC_MODE__MAX) {
3608 error_report("Invalid preallocation mode '%s'", optarg);
3609 return 1;
3610 }
3611 break;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003612 case OPTION_SHRINK:
3613 shrink = true;
3614 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003615 }
3616 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02003617 if (optind != argc - 1) {
Max Reitzbe8fbd42018-02-05 17:27:45 +01003618 error_exit("Expecting image file name and size");
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003619 }
3620 filename = argv[optind++];
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003621
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003622 if (qemu_opts_foreach(&qemu_object_opts,
3623 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02003624 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003625 return 1;
3626 }
3627
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003628 /* Choose grow, shrink, or absolute resize mode */
3629 switch (size[0]) {
3630 case '+':
3631 relative = 1;
3632 size++;
3633 break;
3634 case '-':
3635 relative = -1;
3636 size++;
3637 break;
3638 default:
3639 relative = 0;
3640 break;
3641 }
3642
3643 /* Parse size */
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -08003644 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
Markus Armbrusterf43e47d2015-02-12 17:52:20 +01003645 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +01003646 if (err) {
3647 error_report_err(err);
Jes Sorensen2a819982010-12-06 17:08:31 +01003648 ret = -1;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003649 qemu_opts_del(param);
Jes Sorensen2a819982010-12-06 17:08:31 +01003650 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003651 }
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003652 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3653 qemu_opts_del(param);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003654
Max Reitzefaa7c42016-03-16 19:54:38 +01003655 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08003656 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
3657 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003658 if (!blk) {
Jes Sorensen2a819982010-12-06 17:08:31 +01003659 ret = -1;
3660 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003661 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003662
Max Reitzdc5f6902017-06-13 22:20:55 +02003663 current_size = blk_getlength(blk);
3664 if (current_size < 0) {
3665 error_report("Failed to inquire current image length: %s",
3666 strerror(-current_size));
3667 ret = -1;
3668 goto out;
3669 }
3670
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003671 if (relative) {
Max Reitzdc5f6902017-06-13 22:20:55 +02003672 total_size = current_size + n * relative;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003673 } else {
3674 total_size = n;
3675 }
3676 if (total_size <= 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003677 error_report("New image size must be positive");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003678 ret = -1;
3679 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003680 }
3681
Max Reitzdc5f6902017-06-13 22:20:55 +02003682 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
3683 error_report("Preallocation can only be used for growing images");
3684 ret = -1;
3685 goto out;
3686 }
3687
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003688 if (total_size < current_size && !shrink) {
3689 warn_report("Shrinking an image will delete all data beyond the "
3690 "shrunken image's end. Before performing such an "
3691 "operation, make sure there is no important data there.");
3692
3693 if (g_strcmp0(bdrv_get_format_name(blk_bs(blk)), "raw") != 0) {
3694 error_report(
3695 "Use the --shrink option to perform a shrink operation.");
3696 ret = -1;
3697 goto out;
3698 } else {
3699 warn_report("Using the --shrink option will suppress this message. "
3700 "Note that future versions of qemu-img may refuse to "
3701 "shrink images without this option.");
3702 }
3703 }
3704
Max Reitzdc5f6902017-06-13 22:20:55 +02003705 ret = blk_truncate(blk, total_size, prealloc, &err);
Max Reitz5279b302018-04-21 18:39:57 +02003706 if (ret < 0) {
Max Reitzed3d2ec2017-03-28 22:51:27 +02003707 error_report_err(err);
Max Reitz5279b302018-04-21 18:39:57 +02003708 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003709 }
Max Reitz5279b302018-04-21 18:39:57 +02003710
3711 new_size = blk_getlength(blk);
3712 if (new_size < 0) {
3713 error_report("Failed to verify truncated image length: %s",
3714 strerror(-new_size));
3715 ret = -1;
3716 goto out;
3717 }
3718
3719 /* Some block drivers implement a truncation method, but only so
3720 * the user can cause qemu to refresh the image's size from disk.
3721 * The idea is that the user resizes the image outside of qemu and
3722 * then invokes block_resize to inform qemu about it.
3723 * (This includes iscsi and file-posix for device files.)
3724 * Of course, that is not the behavior someone invoking
3725 * qemu-img resize would find useful, so we catch that behavior
3726 * here and tell the user. */
3727 if (new_size != total_size && new_size == current_size) {
3728 error_report("Image was not resized; resizing may not be supported "
3729 "for this image");
3730 ret = -1;
3731 goto out;
3732 }
3733
3734 if (new_size != total_size) {
3735 warn_report("Image should have been resized to %" PRIi64
3736 " bytes, but was resized to %" PRIi64 " bytes",
3737 total_size, new_size);
3738 }
3739
3740 qprintf(quiet, "Image resized.\n");
3741
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003742out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003743 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003744 if (ret) {
3745 return 1;
3746 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003747 return 0;
3748}
3749
Max Reitz76a3a342014-10-27 11:12:51 +01003750static void amend_status_cb(BlockDriverState *bs,
Max Reitz8b139762015-07-27 17:51:32 +02003751 int64_t offset, int64_t total_work_size,
3752 void *opaque)
Max Reitz76a3a342014-10-27 11:12:51 +01003753{
3754 qemu_progress_print(100.f * offset / total_work_size, 0);
3755}
3756
Max Reitz51641352018-05-09 23:00:20 +02003757static int print_amend_option_help(const char *format)
3758{
3759 BlockDriver *drv;
3760
3761 /* Find driver and parse its options */
3762 drv = bdrv_find_format(format);
3763 if (!drv) {
3764 error_report("Unknown file format '%s'", format);
3765 return 1;
3766 }
3767
3768 if (!drv->bdrv_amend_options) {
3769 error_report("Format driver '%s' does not support option amendment",
3770 format);
3771 return 1;
3772 }
3773
3774 /* Every driver supporting amendment must have create_opts */
3775 assert(drv->create_opts);
3776
3777 printf("Creation options for '%s':\n", format);
Max Reitz63898712018-10-19 18:49:25 +02003778 qemu_opts_print_help(drv->create_opts, false);
Max Reitz51641352018-05-09 23:00:20 +02003779 printf("\nNote that not all of these options may be amendable.\n");
3780 return 0;
3781}
3782
Max Reitz6f176b42013-09-03 10:09:50 +02003783static int img_amend(int argc, char **argv)
3784{
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01003785 Error *err = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02003786 int c, ret = 0;
3787 char *options = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08003788 QemuOptsList *create_opts = NULL;
3789 QemuOpts *opts = NULL;
Max Reitzbd39e6e2014-07-22 22:58:43 +02003790 const char *fmt = NULL, *filename, *cache;
3791 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01003792 bool writethrough;
Max Reitz76a3a342014-10-27 11:12:51 +01003793 bool quiet = false, progress = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003794 BlockBackend *blk = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02003795 BlockDriverState *bs = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003796 bool image_opts = false;
Max Reitz6f176b42013-09-03 10:09:50 +02003797
Max Reitzbd39e6e2014-07-22 22:58:43 +02003798 cache = BDRV_DEFAULT_CACHE;
Max Reitz6f176b42013-09-03 10:09:50 +02003799 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003800 static const struct option long_options[] = {
3801 {"help", no_argument, 0, 'h'},
3802 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003803 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003804 {0, 0, 0, 0}
3805 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003806 c = getopt_long(argc, argv, ":ho:f:t:pq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003807 long_options, NULL);
Max Reitz6f176b42013-09-03 10:09:50 +02003808 if (c == -1) {
3809 break;
3810 }
3811
3812 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003813 case ':':
3814 missing_argument(argv[optind - 1]);
3815 break;
Stefan Hajnoczif7077622017-03-17 18:45:40 +08003816 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003817 unrecognized_option(argv[optind - 1]);
3818 break;
3819 case 'h':
Stefan Hajnoczif7077622017-03-17 18:45:40 +08003820 help();
3821 break;
3822 case 'o':
3823 if (!is_valid_option_list(optarg)) {
3824 error_report("Invalid option list: %s", optarg);
3825 ret = -1;
3826 goto out_no_progress;
3827 }
3828 if (!options) {
3829 options = g_strdup(optarg);
3830 } else {
3831 char *old_options = options;
3832 options = g_strdup_printf("%s,%s", options, optarg);
3833 g_free(old_options);
3834 }
3835 break;
3836 case 'f':
3837 fmt = optarg;
3838 break;
3839 case 't':
3840 cache = optarg;
3841 break;
3842 case 'p':
3843 progress = true;
3844 break;
3845 case 'q':
3846 quiet = true;
3847 break;
3848 case OPTION_OBJECT:
3849 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3850 optarg, true);
3851 if (!opts) {
3852 ret = -1;
3853 goto out_no_progress;
3854 }
3855 break;
3856 case OPTION_IMAGE_OPTS:
3857 image_opts = true;
3858 break;
Max Reitz6f176b42013-09-03 10:09:50 +02003859 }
3860 }
3861
Max Reitz6f176b42013-09-03 10:09:50 +02003862 if (!options) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003863 error_exit("Must specify options (-o)");
Max Reitz6f176b42013-09-03 10:09:50 +02003864 }
3865
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003866 if (qemu_opts_foreach(&qemu_object_opts,
3867 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02003868 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003869 ret = -1;
3870 goto out_no_progress;
3871 }
3872
Max Reitz76a3a342014-10-27 11:12:51 +01003873 if (quiet) {
3874 progress = false;
3875 }
3876 qemu_progress_init(progress, 1.0);
3877
Kevin Wolfa283cb62014-02-21 16:24:07 +01003878 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
3879 if (fmt && has_help_option(options)) {
3880 /* If a format is explicitly specified (and possibly no filename is
3881 * given), print option help here */
Max Reitz51641352018-05-09 23:00:20 +02003882 ret = print_amend_option_help(fmt);
Kevin Wolfa283cb62014-02-21 16:24:07 +01003883 goto out;
3884 }
3885
3886 if (optind != argc - 1) {
Max Reitzb2f27e42014-10-27 11:12:52 +01003887 error_report("Expecting one image file name");
3888 ret = -1;
3889 goto out;
Kevin Wolfa283cb62014-02-21 16:24:07 +01003890 }
Max Reitz6f176b42013-09-03 10:09:50 +02003891
Kevin Wolfce099542016-03-15 13:01:04 +01003892 flags = BDRV_O_RDWR;
3893 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitzbd39e6e2014-07-22 22:58:43 +02003894 if (ret < 0) {
3895 error_report("Invalid cache option: %s", cache);
3896 goto out;
3897 }
3898
Fam Zheng335e9932017-05-03 00:35:39 +08003899 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3900 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003901 if (!blk) {
Max Reitz6f176b42013-09-03 10:09:50 +02003902 ret = -1;
3903 goto out;
3904 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003905 bs = blk_bs(blk);
Max Reitz6f176b42013-09-03 10:09:50 +02003906
3907 fmt = bs->drv->format_name;
3908
Kevin Wolf626f84f2014-02-21 16:24:06 +01003909 if (has_help_option(options)) {
Kevin Wolfa283cb62014-02-21 16:24:07 +01003910 /* If the format was auto-detected, print option help here */
Max Reitz51641352018-05-09 23:00:20 +02003911 ret = print_amend_option_help(fmt);
Max Reitz6f176b42013-09-03 10:09:50 +02003912 goto out;
3913 }
3914
Max Reitz1f996682018-05-09 23:00:17 +02003915 if (!bs->drv->bdrv_amend_options) {
3916 error_report("Format driver '%s' does not support option amendment",
Max Reitzb2439d22014-12-02 18:32:47 +01003917 fmt);
3918 ret = -1;
3919 goto out;
3920 }
3921
Max Reitz1f996682018-05-09 23:00:17 +02003922 /* Every driver supporting amendment must have create_opts */
3923 assert(bs->drv->create_opts);
3924
Chunyan Liuc282e1f2014-06-05 17:21:11 +08003925 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
Chunyan Liu83d05212014-06-05 17:20:51 +08003926 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Paolo Bonziniece90862017-01-04 15:56:24 +01003927 qemu_opts_do_parse(opts, options, NULL, &err);
3928 if (err) {
3929 error_report_err(err);
3930 ret = -1;
3931 goto out;
Max Reitz6f176b42013-09-03 10:09:50 +02003932 }
3933
Max Reitz76a3a342014-10-27 11:12:51 +01003934 /* In case the driver does not call amend_status_cb() */
3935 qemu_progress_print(0.f, 0);
Max Reitzd1402b52018-05-09 23:00:18 +02003936 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, &err);
Max Reitz76a3a342014-10-27 11:12:51 +01003937 qemu_progress_print(100.f, 0);
Max Reitz6f176b42013-09-03 10:09:50 +02003938 if (ret < 0) {
Max Reitzd1402b52018-05-09 23:00:18 +02003939 error_report_err(err);
Max Reitz6f176b42013-09-03 10:09:50 +02003940 goto out;
3941 }
3942
3943out:
Max Reitz76a3a342014-10-27 11:12:51 +01003944 qemu_progress_end();
3945
Max Reitze814dff2015-08-20 16:00:38 -07003946out_no_progress:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003947 blk_unref(blk);
Chunyan Liu83d05212014-06-05 17:20:51 +08003948 qemu_opts_del(opts);
3949 qemu_opts_free(create_opts);
Kevin Wolf626f84f2014-02-21 16:24:06 +01003950 g_free(options);
3951
Max Reitz6f176b42013-09-03 10:09:50 +02003952 if (ret) {
3953 return 1;
3954 }
3955 return 0;
3956}
3957
Kevin Wolfb6133b82014-08-05 14:17:13 +02003958typedef struct BenchData {
3959 BlockBackend *blk;
3960 uint64_t image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02003961 bool write;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003962 int bufsize;
Kevin Wolf83de9be2015-07-13 13:13:17 +02003963 int step;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003964 int nrreq;
3965 int n;
Kevin Wolf55d539c2016-06-03 13:59:41 +02003966 int flush_interval;
3967 bool drain_on_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003968 uint8_t *buf;
3969 QEMUIOVector *qiov;
3970
3971 int in_flight;
Kevin Wolf55d539c2016-06-03 13:59:41 +02003972 bool in_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003973 uint64_t offset;
3974} BenchData;
3975
Kevin Wolf55d539c2016-06-03 13:59:41 +02003976static void bench_undrained_flush_cb(void *opaque, int ret)
3977{
3978 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02003979 error_report("Failed flush request: %s", strerror(-ret));
Kevin Wolf55d539c2016-06-03 13:59:41 +02003980 exit(EXIT_FAILURE);
3981 }
3982}
3983
Kevin Wolfb6133b82014-08-05 14:17:13 +02003984static void bench_cb(void *opaque, int ret)
3985{
3986 BenchData *b = opaque;
3987 BlockAIOCB *acb;
3988
3989 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02003990 error_report("Failed request: %s", strerror(-ret));
Kevin Wolfb6133b82014-08-05 14:17:13 +02003991 exit(EXIT_FAILURE);
3992 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02003993
3994 if (b->in_flush) {
3995 /* Just finished a flush with drained queue: Start next requests */
3996 assert(b->in_flight == 0);
3997 b->in_flush = false;
3998 } else if (b->in_flight > 0) {
3999 int remaining = b->n - b->in_flight;
4000
Kevin Wolfb6133b82014-08-05 14:17:13 +02004001 b->n--;
4002 b->in_flight--;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004003
4004 /* Time for flush? Drain queue if requested, then flush */
4005 if (b->flush_interval && remaining % b->flush_interval == 0) {
4006 if (!b->in_flight || !b->drain_on_flush) {
4007 BlockCompletionFunc *cb;
4008
4009 if (b->drain_on_flush) {
4010 b->in_flush = true;
4011 cb = bench_cb;
4012 } else {
4013 cb = bench_undrained_flush_cb;
4014 }
4015
4016 acb = blk_aio_flush(b->blk, cb, b);
4017 if (!acb) {
4018 error_report("Failed to issue flush request");
4019 exit(EXIT_FAILURE);
4020 }
4021 }
4022 if (b->drain_on_flush) {
4023 return;
4024 }
4025 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004026 }
4027
4028 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004029 int64_t offset = b->offset;
4030 /* blk_aio_* might look for completed I/Os and kick bench_cb
4031 * again, so make sure this operation is counted by in_flight
4032 * and b->offset is ready for the next submission.
4033 */
4034 b->in_flight++;
4035 b->offset += b->step;
4036 b->offset %= b->image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004037 if (b->write) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004038 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004039 } else {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004040 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004041 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004042 if (!acb) {
4043 error_report("Failed to issue request");
4044 exit(EXIT_FAILURE);
4045 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004046 }
4047}
4048
4049static int img_bench(int argc, char **argv)
4050{
4051 int c, ret = 0;
4052 const char *fmt = NULL, *filename;
4053 bool quiet = false;
4054 bool image_opts = false;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004055 bool is_write = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004056 int count = 75000;
4057 int depth = 64;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004058 int64_t offset = 0;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004059 size_t bufsize = 4096;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004060 int pattern = 0;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004061 size_t step = 0;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004062 int flush_interval = 0;
4063 bool drain_on_flush = true;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004064 int64_t image_size;
4065 BlockBackend *blk = NULL;
4066 BenchData data = {};
4067 int flags = 0;
Kevin Wolf604e8612016-06-14 11:29:32 +02004068 bool writethrough = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004069 struct timeval t1, t2;
4070 int i;
Fam Zheng335e9932017-05-03 00:35:39 +08004071 bool force_share = false;
Fam Zheng79d46582018-01-16 14:08:58 +08004072 size_t buf_size;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004073
4074 for (;;) {
4075 static const struct option long_options[] = {
4076 {"help", no_argument, 0, 'h'},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004077 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004078 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004079 {"pattern", required_argument, 0, OPTION_PATTERN},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004080 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
Fam Zheng335e9932017-05-03 00:35:39 +08004081 {"force-share", no_argument, 0, 'U'},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004082 {0, 0, 0, 0}
4083 };
Fam Zheng335e9932017-05-03 00:35:39 +08004084 c = getopt_long(argc, argv, ":hc:d:f:no:qs:S:t:wU", long_options, NULL);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004085 if (c == -1) {
4086 break;
4087 }
4088
4089 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004090 case ':':
4091 missing_argument(argv[optind - 1]);
4092 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004093 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004094 unrecognized_option(argv[optind - 1]);
4095 break;
4096 case 'h':
Kevin Wolfb6133b82014-08-05 14:17:13 +02004097 help();
4098 break;
4099 case 'c':
4100 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004101 unsigned long res;
4102
4103 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004104 error_report("Invalid request count specified");
4105 return 1;
4106 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004107 count = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004108 break;
4109 }
4110 case 'd':
4111 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004112 unsigned long res;
4113
4114 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004115 error_report("Invalid queue depth specified");
4116 return 1;
4117 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004118 depth = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004119 break;
4120 }
4121 case 'f':
4122 fmt = optarg;
4123 break;
4124 case 'n':
4125 flags |= BDRV_O_NATIVE_AIO;
4126 break;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004127 case 'o':
4128 {
Markus Armbruster606caa02017-02-21 21:14:04 +01004129 offset = cvtnum(optarg);
4130 if (offset < 0) {
Kevin Wolfd3199a32015-07-10 18:09:18 +02004131 error_report("Invalid offset specified");
4132 return 1;
4133 }
4134 break;
4135 }
4136 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004137 case 'q':
4138 quiet = true;
4139 break;
4140 case 's':
4141 {
4142 int64_t sval;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004143
Markus Armbruster606caa02017-02-21 21:14:04 +01004144 sval = cvtnum(optarg);
4145 if (sval < 0 || sval > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004146 error_report("Invalid buffer size specified");
4147 return 1;
4148 }
4149
4150 bufsize = sval;
4151 break;
4152 }
Kevin Wolf83de9be2015-07-13 13:13:17 +02004153 case 'S':
4154 {
4155 int64_t sval;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004156
Markus Armbruster606caa02017-02-21 21:14:04 +01004157 sval = cvtnum(optarg);
4158 if (sval < 0 || sval > INT_MAX) {
Kevin Wolf83de9be2015-07-13 13:13:17 +02004159 error_report("Invalid step size specified");
4160 return 1;
4161 }
4162
4163 step = sval;
4164 break;
4165 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004166 case 't':
4167 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4168 if (ret < 0) {
4169 error_report("Invalid cache mode");
4170 ret = -1;
4171 goto out;
4172 }
4173 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004174 case 'w':
4175 flags |= BDRV_O_RDWR;
4176 is_write = true;
4177 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004178 case 'U':
4179 force_share = true;
4180 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004181 case OPTION_PATTERN:
4182 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004183 unsigned long res;
4184
4185 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004186 error_report("Invalid pattern byte specified");
4187 return 1;
4188 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004189 pattern = res;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004190 break;
4191 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004192 case OPTION_FLUSH_INTERVAL:
4193 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004194 unsigned long res;
4195
4196 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004197 error_report("Invalid flush interval specified");
4198 return 1;
4199 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004200 flush_interval = res;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004201 break;
4202 }
4203 case OPTION_NO_DRAIN:
4204 drain_on_flush = false;
4205 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004206 case OPTION_IMAGE_OPTS:
4207 image_opts = true;
4208 break;
4209 }
4210 }
4211
4212 if (optind != argc - 1) {
4213 error_exit("Expecting one image file name");
4214 }
4215 filename = argv[argc - 1];
4216
Kevin Wolf55d539c2016-06-03 13:59:41 +02004217 if (!is_write && flush_interval) {
4218 error_report("--flush-interval is only available in write tests");
4219 ret = -1;
4220 goto out;
4221 }
4222 if (flush_interval && flush_interval < depth) {
4223 error_report("Flush interval can't be smaller than depth");
4224 ret = -1;
4225 goto out;
4226 }
4227
Fam Zheng335e9932017-05-03 00:35:39 +08004228 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4229 force_share);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004230 if (!blk) {
4231 ret = -1;
4232 goto out;
4233 }
4234
4235 image_size = blk_getlength(blk);
4236 if (image_size < 0) {
4237 ret = image_size;
4238 goto out;
4239 }
4240
4241 data = (BenchData) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004242 .blk = blk,
4243 .image_size = image_size,
4244 .bufsize = bufsize,
4245 .step = step ?: bufsize,
4246 .nrreq = depth,
4247 .n = count,
4248 .offset = offset,
4249 .write = is_write,
4250 .flush_interval = flush_interval,
4251 .drain_on_flush = drain_on_flush,
Kevin Wolfb6133b82014-08-05 14:17:13 +02004252 };
Kevin Wolfd3199a32015-07-10 18:09:18 +02004253 printf("Sending %d %s requests, %d bytes each, %d in parallel "
Kevin Wolf83de9be2015-07-13 13:13:17 +02004254 "(starting at offset %" PRId64 ", step size %d)\n",
Kevin Wolfd3199a32015-07-10 18:09:18 +02004255 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
Kevin Wolf83de9be2015-07-13 13:13:17 +02004256 data.offset, data.step);
Kevin Wolf55d539c2016-06-03 13:59:41 +02004257 if (flush_interval) {
4258 printf("Sending flush every %d requests\n", flush_interval);
4259 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004260
Fam Zheng79d46582018-01-16 14:08:58 +08004261 buf_size = data.nrreq * data.bufsize;
4262 data.buf = blk_blockalign(blk, buf_size);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004263 memset(data.buf, pattern, data.nrreq * data.bufsize);
4264
Fam Zheng79d46582018-01-16 14:08:58 +08004265 blk_register_buf(blk, data.buf, buf_size);
4266
Kevin Wolfb6133b82014-08-05 14:17:13 +02004267 data.qiov = g_new(QEMUIOVector, data.nrreq);
4268 for (i = 0; i < data.nrreq; i++) {
4269 qemu_iovec_init(&data.qiov[i], 1);
4270 qemu_iovec_add(&data.qiov[i],
4271 data.buf + i * data.bufsize, data.bufsize);
4272 }
4273
4274 gettimeofday(&t1, NULL);
4275 bench_cb(&data, 0);
4276
4277 while (data.n > 0) {
4278 main_loop_wait(false);
4279 }
4280 gettimeofday(&t2, NULL);
4281
4282 printf("Run completed in %3.3f seconds.\n",
4283 (t2.tv_sec - t1.tv_sec)
4284 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4285
4286out:
Fam Zheng79d46582018-01-16 14:08:58 +08004287 if (data.buf) {
4288 blk_unregister_buf(blk, data.buf);
4289 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004290 qemu_vfree(data.buf);
4291 blk_unref(blk);
4292
4293 if (ret) {
4294 return 1;
4295 }
4296 return 0;
4297}
4298
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004299#define C_BS 01
4300#define C_COUNT 02
4301#define C_IF 04
4302#define C_OF 010
Reda Sallahif7c15532016-08-10 16:16:09 +02004303#define C_SKIP 020
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004304
4305struct DdInfo {
4306 unsigned int flags;
4307 int64_t count;
4308};
4309
4310struct DdIo {
4311 int bsz; /* Block size */
4312 char *filename;
4313 uint8_t *buf;
Reda Sallahif7c15532016-08-10 16:16:09 +02004314 int64_t offset;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004315};
4316
4317struct DdOpts {
4318 const char *name;
4319 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
4320 unsigned int flag;
4321};
4322
4323static int img_dd_bs(const char *arg,
4324 struct DdIo *in, struct DdIo *out,
4325 struct DdInfo *dd)
4326{
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004327 int64_t res;
4328
Markus Armbruster606caa02017-02-21 21:14:04 +01004329 res = cvtnum(arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004330
Markus Armbruster606caa02017-02-21 21:14:04 +01004331 if (res <= 0 || res > INT_MAX) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004332 error_report("invalid number: '%s'", arg);
4333 return 1;
4334 }
4335 in->bsz = out->bsz = res;
4336
4337 return 0;
4338}
4339
4340static int img_dd_count(const char *arg,
4341 struct DdIo *in, struct DdIo *out,
4342 struct DdInfo *dd)
4343{
Markus Armbruster606caa02017-02-21 21:14:04 +01004344 dd->count = cvtnum(arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004345
Markus Armbruster606caa02017-02-21 21:14:04 +01004346 if (dd->count < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004347 error_report("invalid number: '%s'", arg);
4348 return 1;
4349 }
4350
4351 return 0;
4352}
4353
4354static int img_dd_if(const char *arg,
4355 struct DdIo *in, struct DdIo *out,
4356 struct DdInfo *dd)
4357{
4358 in->filename = g_strdup(arg);
4359
4360 return 0;
4361}
4362
4363static int img_dd_of(const char *arg,
4364 struct DdIo *in, struct DdIo *out,
4365 struct DdInfo *dd)
4366{
4367 out->filename = g_strdup(arg);
4368
4369 return 0;
4370}
4371
Reda Sallahif7c15532016-08-10 16:16:09 +02004372static int img_dd_skip(const char *arg,
4373 struct DdIo *in, struct DdIo *out,
4374 struct DdInfo *dd)
4375{
Markus Armbruster606caa02017-02-21 21:14:04 +01004376 in->offset = cvtnum(arg);
Reda Sallahif7c15532016-08-10 16:16:09 +02004377
Markus Armbruster606caa02017-02-21 21:14:04 +01004378 if (in->offset < 0) {
Reda Sallahif7c15532016-08-10 16:16:09 +02004379 error_report("invalid number: '%s'", arg);
4380 return 1;
4381 }
4382
4383 return 0;
4384}
4385
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004386static int img_dd(int argc, char **argv)
4387{
4388 int ret = 0;
4389 char *arg = NULL;
4390 char *tmp;
4391 BlockDriver *drv = NULL, *proto_drv = NULL;
4392 BlockBackend *blk1 = NULL, *blk2 = NULL;
4393 QemuOpts *opts = NULL;
4394 QemuOptsList *create_opts = NULL;
4395 Error *local_err = NULL;
4396 bool image_opts = false;
4397 int c, i;
4398 const char *out_fmt = "raw";
4399 const char *fmt = NULL;
4400 int64_t size = 0;
4401 int64_t block_count = 0, out_pos, in_pos;
Fam Zheng335e9932017-05-03 00:35:39 +08004402 bool force_share = false;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004403 struct DdInfo dd = {
4404 .flags = 0,
4405 .count = 0,
4406 };
4407 struct DdIo in = {
4408 .bsz = 512, /* Block size is by default 512 bytes */
4409 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004410 .buf = NULL,
4411 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004412 };
4413 struct DdIo out = {
4414 .bsz = 512,
4415 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004416 .buf = NULL,
4417 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004418 };
4419
4420 const struct DdOpts options[] = {
4421 { "bs", img_dd_bs, C_BS },
4422 { "count", img_dd_count, C_COUNT },
4423 { "if", img_dd_if, C_IF },
4424 { "of", img_dd_of, C_OF },
Reda Sallahif7c15532016-08-10 16:16:09 +02004425 { "skip", img_dd_skip, C_SKIP },
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004426 { NULL, NULL, 0 }
4427 };
4428 const struct option long_options[] = {
4429 { "help", no_argument, 0, 'h'},
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004430 { "object", required_argument, 0, OPTION_OBJECT},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004431 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08004432 { "force-share", no_argument, 0, 'U'},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004433 { 0, 0, 0, 0 }
4434 };
4435
Fam Zheng335e9932017-05-03 00:35:39 +08004436 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004437 if (c == EOF) {
4438 break;
4439 }
4440 switch (c) {
4441 case 'O':
4442 out_fmt = optarg;
4443 break;
4444 case 'f':
4445 fmt = optarg;
4446 break;
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004447 case ':':
4448 missing_argument(argv[optind - 1]);
4449 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004450 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004451 unrecognized_option(argv[optind - 1]);
4452 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004453 case 'h':
4454 help();
4455 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004456 case 'U':
4457 force_share = true;
4458 break;
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01004459 case OPTION_OBJECT:
4460 if (!qemu_opts_parse_noisily(&qemu_object_opts, optarg, true)) {
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004461 ret = -1;
4462 goto out;
4463 }
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01004464 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004465 case OPTION_IMAGE_OPTS:
4466 image_opts = true;
4467 break;
4468 }
4469 }
4470
4471 for (i = optind; i < argc; i++) {
4472 int j;
4473 arg = g_strdup(argv[i]);
4474
4475 tmp = strchr(arg, '=');
4476 if (tmp == NULL) {
4477 error_report("unrecognized operand %s", arg);
4478 ret = -1;
4479 goto out;
4480 }
4481
4482 *tmp++ = '\0';
4483
4484 for (j = 0; options[j].name != NULL; j++) {
4485 if (!strcmp(arg, options[j].name)) {
4486 break;
4487 }
4488 }
4489 if (options[j].name == NULL) {
4490 error_report("unrecognized operand %s", arg);
4491 ret = -1;
4492 goto out;
4493 }
4494
4495 if (options[j].f(tmp, &in, &out, &dd) != 0) {
4496 ret = -1;
4497 goto out;
4498 }
4499 dd.flags |= options[j].flag;
4500 g_free(arg);
4501 arg = NULL;
4502 }
4503
4504 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
4505 error_report("Must specify both input and output files");
4506 ret = -1;
4507 goto out;
4508 }
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004509
4510 if (qemu_opts_foreach(&qemu_object_opts,
4511 user_creatable_add_opts_foreach,
4512 NULL, NULL)) {
4513 ret = -1;
4514 goto out;
4515 }
4516
Fam Zheng335e9932017-05-03 00:35:39 +08004517 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
4518 force_share);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004519
4520 if (!blk1) {
4521 ret = -1;
4522 goto out;
4523 }
4524
4525 drv = bdrv_find_format(out_fmt);
4526 if (!drv) {
4527 error_report("Unknown file format");
4528 ret = -1;
4529 goto out;
4530 }
4531 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
4532
4533 if (!proto_drv) {
4534 error_report_err(local_err);
4535 ret = -1;
4536 goto out;
4537 }
4538 if (!drv->create_opts) {
4539 error_report("Format driver '%s' does not support image creation",
4540 drv->format_name);
4541 ret = -1;
4542 goto out;
4543 }
4544 if (!proto_drv->create_opts) {
4545 error_report("Protocol driver '%s' does not support image creation",
4546 proto_drv->format_name);
4547 ret = -1;
4548 goto out;
4549 }
4550 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4551 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
4552
4553 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4554
4555 size = blk_getlength(blk1);
4556 if (size < 0) {
4557 error_report("Failed to get size for '%s'", in.filename);
4558 ret = -1;
4559 goto out;
4560 }
4561
4562 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
4563 dd.count * in.bsz < size) {
4564 size = dd.count * in.bsz;
4565 }
4566
Reda Sallahif7c15532016-08-10 16:16:09 +02004567 /* Overflow means the specified offset is beyond input image's size */
4568 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4569 size < in.bsz * in.offset)) {
4570 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
4571 } else {
4572 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
4573 size - in.bsz * in.offset, &error_abort);
4574 }
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004575
4576 ret = bdrv_create(drv, out.filename, opts, &local_err);
4577 if (ret < 0) {
4578 error_reportf_err(local_err,
4579 "%s: error while creating output image: ",
4580 out.filename);
4581 ret = -1;
4582 goto out;
4583 }
4584
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01004585 /* TODO, we can't honour --image-opts for the target,
4586 * since it needs to be given in a format compatible
4587 * with the bdrv_create() call above which does not
4588 * support image-opts style.
4589 */
Daniel P. Berrange29cf9332017-05-15 17:47:12 +01004590 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01004591 false, false, false);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004592
4593 if (!blk2) {
4594 ret = -1;
4595 goto out;
4596 }
4597
Reda Sallahif7c15532016-08-10 16:16:09 +02004598 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4599 size < in.offset * in.bsz)) {
4600 /* We give a warning if the skip option is bigger than the input
4601 * size and create an empty output disk image (i.e. like dd(1)).
4602 */
4603 error_report("%s: cannot skip to specified offset", in.filename);
4604 in_pos = size;
4605 } else {
4606 in_pos = in.offset * in.bsz;
4607 }
4608
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004609 in.buf = g_new(uint8_t, in.bsz);
4610
Reda Sallahif7c15532016-08-10 16:16:09 +02004611 for (out_pos = 0; in_pos < size; block_count++) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004612 int in_ret, out_ret;
4613
4614 if (in_pos + in.bsz > size) {
4615 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
4616 } else {
4617 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
4618 }
4619 if (in_ret < 0) {
4620 error_report("error while reading from input image file: %s",
4621 strerror(-in_ret));
4622 ret = -1;
4623 goto out;
4624 }
4625 in_pos += in_ret;
4626
4627 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
4628
4629 if (out_ret < 0) {
4630 error_report("error while writing to output image file: %s",
4631 strerror(-out_ret));
4632 ret = -1;
4633 goto out;
4634 }
4635 out_pos += out_ret;
4636 }
4637
4638out:
4639 g_free(arg);
4640 qemu_opts_del(opts);
4641 qemu_opts_free(create_opts);
4642 blk_unref(blk1);
4643 blk_unref(blk2);
4644 g_free(in.filename);
4645 g_free(out.filename);
4646 g_free(in.buf);
4647 g_free(out.buf);
4648
4649 if (ret) {
4650 return 1;
4651 }
4652 return 0;
4653}
4654
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01004655static void dump_json_block_measure_info(BlockMeasureInfo *info)
4656{
4657 QString *str;
4658 QObject *obj;
4659 Visitor *v = qobject_output_visitor_new(&obj);
4660
4661 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
4662 visit_complete(v, &obj);
4663 str = qobject_to_json_pretty(obj);
4664 assert(str != NULL);
4665 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02004666 qobject_unref(obj);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01004667 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02004668 qobject_unref(str);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01004669}
4670
4671static int img_measure(int argc, char **argv)
4672{
4673 static const struct option long_options[] = {
4674 {"help", no_argument, 0, 'h'},
4675 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4676 {"object", required_argument, 0, OPTION_OBJECT},
4677 {"output", required_argument, 0, OPTION_OUTPUT},
4678 {"size", required_argument, 0, OPTION_SIZE},
4679 {"force-share", no_argument, 0, 'U'},
4680 {0, 0, 0, 0}
4681 };
4682 OutputFormat output_format = OFORMAT_HUMAN;
4683 BlockBackend *in_blk = NULL;
4684 BlockDriver *drv;
4685 const char *filename = NULL;
4686 const char *fmt = NULL;
4687 const char *out_fmt = "raw";
4688 char *options = NULL;
4689 char *snapshot_name = NULL;
4690 bool force_share = false;
4691 QemuOpts *opts = NULL;
4692 QemuOpts *object_opts = NULL;
4693 QemuOpts *sn_opts = NULL;
4694 QemuOptsList *create_opts = NULL;
4695 bool image_opts = false;
4696 uint64_t img_size = UINT64_MAX;
4697 BlockMeasureInfo *info = NULL;
4698 Error *local_err = NULL;
4699 int ret = 1;
4700 int c;
4701
4702 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
4703 long_options, NULL)) != -1) {
4704 switch (c) {
4705 case '?':
4706 case 'h':
4707 help();
4708 break;
4709 case 'f':
4710 fmt = optarg;
4711 break;
4712 case 'O':
4713 out_fmt = optarg;
4714 break;
4715 case 'o':
4716 if (!is_valid_option_list(optarg)) {
4717 error_report("Invalid option list: %s", optarg);
4718 goto out;
4719 }
4720 if (!options) {
4721 options = g_strdup(optarg);
4722 } else {
4723 char *old_options = options;
4724 options = g_strdup_printf("%s,%s", options, optarg);
4725 g_free(old_options);
4726 }
4727 break;
4728 case 'l':
4729 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
4730 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
4731 optarg, false);
4732 if (!sn_opts) {
4733 error_report("Failed in parsing snapshot param '%s'",
4734 optarg);
4735 goto out;
4736 }
4737 } else {
4738 snapshot_name = optarg;
4739 }
4740 break;
4741 case 'U':
4742 force_share = true;
4743 break;
4744 case OPTION_OBJECT:
4745 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
4746 optarg, true);
4747 if (!object_opts) {
4748 goto out;
4749 }
4750 break;
4751 case OPTION_IMAGE_OPTS:
4752 image_opts = true;
4753 break;
4754 case OPTION_OUTPUT:
4755 if (!strcmp(optarg, "json")) {
4756 output_format = OFORMAT_JSON;
4757 } else if (!strcmp(optarg, "human")) {
4758 output_format = OFORMAT_HUMAN;
4759 } else {
4760 error_report("--output must be used with human or json "
4761 "as argument.");
4762 goto out;
4763 }
4764 break;
4765 case OPTION_SIZE:
4766 {
4767 int64_t sval;
4768
4769 sval = cvtnum(optarg);
4770 if (sval < 0) {
4771 if (sval == -ERANGE) {
4772 error_report("Image size must be less than 8 EiB!");
4773 } else {
4774 error_report("Invalid image size specified! You may use "
4775 "k, M, G, T, P or E suffixes for ");
4776 error_report("kilobytes, megabytes, gigabytes, terabytes, "
4777 "petabytes and exabytes.");
4778 }
4779 goto out;
4780 }
4781 img_size = (uint64_t)sval;
4782 }
4783 break;
4784 }
4785 }
4786
4787 if (qemu_opts_foreach(&qemu_object_opts,
4788 user_creatable_add_opts_foreach,
4789 NULL, NULL)) {
4790 goto out;
4791 }
4792
4793 if (argc - optind > 1) {
4794 error_report("At most one filename argument is allowed.");
4795 goto out;
4796 } else if (argc - optind == 1) {
4797 filename = argv[optind];
4798 }
4799
4800 if (!filename &&
4801 (object_opts || image_opts || fmt || snapshot_name || sn_opts)) {
4802 error_report("--object, --image-opts, -f, and -l "
4803 "require a filename argument.");
4804 goto out;
4805 }
4806 if (filename && img_size != UINT64_MAX) {
4807 error_report("--size N cannot be used together with a filename.");
4808 goto out;
4809 }
4810 if (!filename && img_size == UINT64_MAX) {
4811 error_report("Either --size N or one filename must be specified.");
4812 goto out;
4813 }
4814
4815 if (filename) {
4816 in_blk = img_open(image_opts, filename, fmt, 0,
4817 false, false, force_share);
4818 if (!in_blk) {
4819 goto out;
4820 }
4821
4822 if (sn_opts) {
4823 bdrv_snapshot_load_tmp(blk_bs(in_blk),
4824 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
4825 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
4826 &local_err);
4827 } else if (snapshot_name != NULL) {
4828 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
4829 snapshot_name, &local_err);
4830 }
4831 if (local_err) {
4832 error_reportf_err(local_err, "Failed to load snapshot: ");
4833 goto out;
4834 }
4835 }
4836
4837 drv = bdrv_find_format(out_fmt);
4838 if (!drv) {
4839 error_report("Unknown file format '%s'", out_fmt);
4840 goto out;
4841 }
4842 if (!drv->create_opts) {
4843 error_report("Format driver '%s' does not support image creation",
4844 drv->format_name);
4845 goto out;
4846 }
4847
4848 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4849 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
4850 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4851 if (options) {
4852 qemu_opts_do_parse(opts, options, NULL, &local_err);
4853 if (local_err) {
4854 error_report_err(local_err);
4855 error_report("Invalid options for file format '%s'", out_fmt);
4856 goto out;
4857 }
4858 }
4859 if (img_size != UINT64_MAX) {
4860 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
4861 }
4862
4863 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
4864 if (local_err) {
4865 error_report_err(local_err);
4866 goto out;
4867 }
4868
4869 if (output_format == OFORMAT_HUMAN) {
4870 printf("required size: %" PRIu64 "\n", info->required);
4871 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
4872 } else {
4873 dump_json_block_measure_info(info);
4874 }
4875
4876 ret = 0;
4877
4878out:
4879 qapi_free_BlockMeasureInfo(info);
4880 qemu_opts_del(object_opts);
4881 qemu_opts_del(opts);
4882 qemu_opts_del(sn_opts);
4883 qemu_opts_free(create_opts);
4884 g_free(options);
4885 blk_unref(in_blk);
4886 return ret;
4887}
Kevin Wolfb6133b82014-08-05 14:17:13 +02004888
Anthony Liguoric227f092009-10-01 16:12:16 -05004889static const img_cmd_t img_cmds[] = {
Stuart Brady153859b2009-06-07 00:42:17 +01004890#define DEF(option, callback, arg_string) \
4891 { option, callback },
4892#include "qemu-img-cmds.h"
4893#undef DEF
Stuart Brady153859b2009-06-07 00:42:17 +01004894 { NULL, NULL, },
4895};
4896
bellardea2384d2004-08-01 21:59:26 +00004897int main(int argc, char **argv)
4898{
Anthony Liguoric227f092009-10-01 16:12:16 -05004899 const img_cmd_t *cmd;
Stuart Brady153859b2009-06-07 00:42:17 +01004900 const char *cmdname;
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03004901 Error *local_error = NULL;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03004902 char *trace_file = NULL;
Jeff Cody7db16892014-04-25 17:02:32 -04004903 int c;
Jeff Cody7db16892014-04-25 17:02:32 -04004904 static const struct option long_options[] = {
4905 {"help", no_argument, 0, 'h'},
Denis V. Lunev10985132016-06-17 17:44:13 +03004906 {"version", no_argument, 0, 'V'},
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03004907 {"trace", required_argument, NULL, 'T'},
Jeff Cody7db16892014-04-25 17:02:32 -04004908 {0, 0, 0, 0}
4909 };
bellardea2384d2004-08-01 21:59:26 +00004910
MORITA Kazutaka526eda12013-07-23 17:30:11 +09004911#ifdef CONFIG_POSIX
4912 signal(SIGPIPE, SIG_IGN);
4913#endif
4914
Daniel P. Berrangefe4db842016-10-04 14:35:52 +01004915 module_call_init(MODULE_INIT_TRACE);
Kevin Wolf53f76e52010-12-16 15:10:32 +01004916 error_set_progname(argv[0]);
Fam Zheng10f5bff2014-02-10 14:48:51 +08004917 qemu_init_exec_dir(argv[0]);
Kevin Wolf53f76e52010-12-16 15:10:32 +01004918
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03004919 if (qemu_init_main_loop(&local_error)) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01004920 error_report_err(local_error);
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03004921 exit(EXIT_FAILURE);
4922 }
4923
Eduardo Habkoste8f2d272016-05-12 11:10:04 -03004924 qcrypto_init(&error_fatal);
Daniel P. Berrangec2297082016-04-06 12:12:06 +01004925
Daniel P. Berrange064097d2016-02-10 18:41:01 +00004926 module_call_init(MODULE_INIT_QOM);
bellardea2384d2004-08-01 21:59:26 +00004927 bdrv_init();
Fam Zhengac1307a2014-04-22 13:36:11 +08004928 if (argc < 2) {
4929 error_exit("Not enough arguments");
4930 }
Stuart Brady153859b2009-06-07 00:42:17 +01004931
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004932 qemu_add_opts(&qemu_object_opts);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004933 qemu_add_opts(&qemu_source_opts);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03004934 qemu_add_opts(&qemu_trace_opts);
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004935
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004936 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
Denis V. Lunev10985132016-06-17 17:44:13 +03004937 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004938 case ':':
4939 missing_argument(argv[optind - 1]);
4940 return 0;
Stefan Hajnoczi4581c162017-03-17 18:45:39 +08004941 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004942 unrecognized_option(argv[optind - 1]);
4943 return 0;
4944 case 'h':
Denis V. Lunev10985132016-06-17 17:44:13 +03004945 help();
4946 return 0;
4947 case 'V':
4948 printf(QEMU_IMG_VERSION);
4949 return 0;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03004950 case 'T':
4951 g_free(trace_file);
4952 trace_file = trace_opt_parse(optarg);
4953 break;
Stuart Brady153859b2009-06-07 00:42:17 +01004954 }
bellardea2384d2004-08-01 21:59:26 +00004955 }
Stuart Brady153859b2009-06-07 00:42:17 +01004956
Denis V. Lunev10985132016-06-17 17:44:13 +03004957 cmdname = argv[optind];
Jeff Cody7db16892014-04-25 17:02:32 -04004958
Denis V. Lunev10985132016-06-17 17:44:13 +03004959 /* reset getopt_long scanning */
4960 argc -= optind;
4961 if (argc < 1) {
Jeff Cody5f6979c2014-04-28 14:37:18 -04004962 return 0;
4963 }
Denis V. Lunev10985132016-06-17 17:44:13 +03004964 argv += optind;
Denis V. Lunevcfef6a42016-07-04 16:16:48 +03004965 optind = 0;
Denis V. Lunev10985132016-06-17 17:44:13 +03004966
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03004967 if (!trace_init_backends()) {
4968 exit(1);
4969 }
4970 trace_init_file(trace_file);
4971 qemu_set_log(LOG_TRACE);
4972
Denis V. Lunev10985132016-06-17 17:44:13 +03004973 /* find the command */
4974 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
4975 if (!strcmp(cmdname, cmd->name)) {
4976 return cmd->handler(argc, argv);
4977 }
4978 }
Jeff Cody7db16892014-04-25 17:02:32 -04004979
Stuart Brady153859b2009-06-07 00:42:17 +01004980 /* not found */
Fam Zhengac1307a2014-04-22 13:36:11 +08004981 error_exit("Command not found: %s", cmdname);
bellardea2384d2004-08-01 21:59:26 +00004982}