]> git.proxmox.com Git - mirror_qemu.git/blame - qemu-img.c
block: remove AioContext locking
[mirror_qemu.git] / qemu-img.c
CommitLineData
ea2384d3 1/*
fb43f4dd 2 * QEMU disk image utility
5fafdf24 3 *
68d0f70e 4 * Copyright (c) 2003-2008 Fabrice Bellard
5fafdf24 5 *
ea2384d3
FB
6 * 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 */
452fcdbc 24
80c71a24 25#include "qemu/osdep.h"
c2a3d7da
EB
26#include <getopt.h>
27
49f95221 28#include "qemu/help-texts.h"
16a18f26 29#include "qemu/qemu-progress.h"
67a1de0d 30#include "qemu-version.h"
da34e65c 31#include "qapi/error.h"
3b51ab4b 32#include "qapi/qapi-commands-block-core.h"
9af23989 33#include "qapi/qapi-visit-block-core.h"
b3db211f 34#include "qapi/qobject-output-visitor.h"
7b1b5d19 35#include "qapi/qmp/qjson.h"
452fcdbc 36#include "qapi/qmp/qdict.h"
f348b6d1 37#include "qemu/cutils.h"
3babeb15 38#include "qemu/config-file.h"
1de7afc9
PB
39#include "qemu/option.h"
40#include "qemu/error-report.h"
06a1e0c1 41#include "qemu/log.h"
db725815 42#include "qemu/main-loop.h"
0b8fa32f 43#include "qemu/module.h"
98c5d2e7 44#include "qemu/sockets.h"
97ede57a 45#include "qemu/units.h"
5df022cf 46#include "qemu/memalign.h"
3babeb15 47#include "qom/object_interfaces.h"
26f54e9a 48#include "sysemu/block-backend.h"
737e150e 49#include "block/block_int.h"
d4a3238a 50#include "block/blockjob.h"
e2c1c34f 51#include "block/dirty-bitmap.h"
f364ec65 52#include "block/qapi.h"
c2297088 53#include "crypto/init.h"
06a1e0c1 54#include "trace/control.h"
0c8c4895
ZL
55#include "qemu/throttle.h"
56#include "block/throttle-groups.h"
e8445331 57
7e563bfb 58#define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
0781dd6e 59 "\n" QEMU_COPYRIGHT "\n"
5f6979cb 60
c227f099 61typedef struct img_cmd_t {
153859be
SB
62 const char *name;
63 int (*handler)(int argc, char **argv);
c227f099 64} img_cmd_t;
153859be 65
8599ea4c
FS
66enum {
67 OPTION_OUTPUT = 256,
68 OPTION_BACKING_CHAIN = 257,
3babeb15 69 OPTION_OBJECT = 258,
eb769f74 70 OPTION_IMAGE_OPTS = 259,
b6495fa8 71 OPTION_PATTERN = 260,
55d539c8
KW
72 OPTION_FLUSH_INTERVAL = 261,
73 OPTION_NO_DRAIN = 262,
305b4c60 74 OPTION_TARGET_IMAGE_OPTS = 263,
fd03c2b8 75 OPTION_SIZE = 264,
dc5f690b 76 OPTION_PREALLOCATION = 265,
4ffca890 77 OPTION_SHRINK = 266,
8eaac025 78 OPTION_SALVAGE = 267,
168468fe 79 OPTION_TARGET_IS_ZERO = 268,
3b51ab4b
EB
80 OPTION_ADD = 269,
81 OPTION_REMOVE = 270,
82 OPTION_CLEAR = 271,
83 OPTION_ENABLE = 272,
84 OPTION_DISABLE = 273,
85 OPTION_MERGE = 274,
15e39ad9 86 OPTION_BITMAPS = 275,
a3579bfa 87 OPTION_FORCE = 276,
955171e4 88 OPTION_SKIP_BROKEN = 277,
8599ea4c
FS
89};
90
91typedef enum OutputFormat {
92 OFORMAT_JSON,
93 OFORMAT_HUMAN,
94} OutputFormat;
95
e6996143 96/* Default to cache=writeback as data integrity is not important for qemu-img */
661a0f71 97#define BDRV_DEFAULT_CACHE "writeback"
137519ce 98
00c6d403 99static void format_print(void *opaque, const char *name)
ea2384d3 100{
00c6d403 101 printf(" %s", name);
ea2384d3
FB
102}
103
8905770b
MAL
104static G_NORETURN G_GNUC_PRINTF(1, 2)
105void error_exit(const char *fmt, ...)
ac1307ab
FZ
106{
107 va_list ap;
108
ac1307ab 109 va_start(ap, fmt);
e9e1d92d 110 error_vreport(fmt, ap);
ac1307ab
FZ
111 va_end(ap);
112
e9e1d92d 113 error_printf("Try 'qemu-img --help' for more information\n");
ac1307ab
FZ
114 exit(EXIT_FAILURE);
115}
116
8905770b
MAL
117static G_NORETURN
118void missing_argument(const char *option)
c9192973
SH
119{
120 error_exit("missing argument for option '%s'", option);
121}
122
8905770b
MAL
123static G_NORETURN
124void unrecognized_option(const char *option)
c9192973
SH
125{
126 error_exit("unrecognized option '%s'", option);
127}
128
0562adf5 129/* Please keep in synch with docs/tools/qemu-img.rst */
8905770b
MAL
130static G_NORETURN
131void help(void)
ea2384d3 132{
e00291c0 133 const char *help_msg =
5f6979cb 134 QEMU_IMG_VERSION
10985131 135 "usage: qemu-img [standard options] command [command options]\n"
3f020d70 136 "QEMU disk image utility\n"
137 "\n"
10985131
DL
138 " '-h', '--help' display this help and exit\n"
139 " '-V', '--version' output version information and exit\n"
06a1e0c1
DL
140 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
141 " specify tracing options\n"
10985131 142 "\n"
3f020d70 143 "Command syntax:\n"
153859be
SB
144#define DEF(option, callback, arg_string) \
145 " " arg_string "\n"
146#include "qemu-img-cmds.h"
147#undef DEF
3f020d70 148 "\n"
149 "Command parameters:\n"
150 " 'filename' is a disk image filename\n"
3babeb15
DB
151 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
152 " manual page for a description of the object properties. The most common\n"
153 " object type is a 'secret', which is used to supply passwords and/or\n"
154 " encryption keys.\n"
3f020d70 155 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
661a0f71 156 " 'cache' is the cache mode used to write the output disk image, the valid\n"
80ccf93b
LY
157 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
158 " 'directsync' and 'unsafe' (default for convert)\n"
bb87fdf8
SH
159 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
160 " options are the same as for the 'cache' option\n"
3f020d70 161 " 'size' is the disk image size in bytes. Optional suffixes\n"
5e00984a
KW
162 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
163 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
164 " supported. 'b' is ignored.\n"
3f020d70 165 " 'output_filename' is the destination disk image filename\n"
166 " 'output_fmt' is the destination format\n"
167 " 'options' is a comma separated list of format specific options in a\n"
7f118b43
MA
168 " name=value format. Use -o help for an overview of the options supported by\n"
169 " the used format\n"
ef80654d
WX
170 " 'snapshot_param' is param used for internal snapshot, format\n"
171 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
172 " '[ID_OR_NAME]'\n"
3f020d70 173 " '-c' indicates that target image must be compressed (qcow format only)\n"
6e6e55f5
JS
174 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
175 " new backing file match exactly. The image doesn't need a working\n"
176 " backing file before rebasing in this case (useful for renaming the\n"
177 " backing file). For image creation, allow creating without attempting\n"
178 " to open the backing file.\n"
3f020d70 179 " '-h' with or without a command shows this help and lists the supported formats\n"
6b837bc4 180 " '-p' show progress of command (only certain commands)\n"
f382d43a 181 " '-q' use Quiet mode - do not print any output (except errors)\n"
11b6699a
PL
182 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
183 " contain only zeros for qemu-img to create a sparse image during\n"
184 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
185 " unallocated or zero sectors, and the destination image will always be\n"
186 " fully allocated\n"
c054b3fd 187 " '--output' takes the format in which the output must be done (human or json)\n"
b2e10493
AD
188 " '-n' skips the target volume creation (useful if the volume is created\n"
189 " prior to running qemu-img)\n"
3f020d70 190 "\n"
3b51ab4b
EB
191 "Parameters to bitmap subcommand:\n"
192 " 'bitmap' is the name of the bitmap to manipulate, through one or more\n"
193 " actions from '--add', '--remove', '--clear', '--enable', '--disable',\n"
194 " or '--merge source'\n"
195 " '-g granularity' sets the granularity for '--add' actions\n"
196 " '-b source' and '-F src_fmt' tell '--merge' actions to find the source\n"
197 " bitmaps from an alternative file\n"
198 "\n"
4534ff54
KW
199 "Parameters to check subcommand:\n"
200 " '-r' tries to repair any inconsistencies that are found during the check.\n"
201 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
202 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
0546b8c2 203 " hiding corruption that has already occurred.\n"
4534ff54 204 "\n"
2d9187bc 205 "Parameters to convert subcommand:\n"
15e39ad9 206 " '--bitmaps' copies all top-level persistent bitmaps to destination\n"
2d9187bc
PL
207 " '-m' specifies how many coroutines work in parallel during the convert\n"
208 " process (defaults to 8)\n"
209 " '-W' allow to write to the target out of order rather than sequential\n"
210 "\n"
3f020d70 211 "Parameters to snapshot subcommand:\n"
212 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
213 " '-a' applies a snapshot (revert disk to saved state)\n"
214 " '-c' creates a snapshot\n"
215 " '-d' deletes a snapshot\n"
d14ed18c
MR
216 " '-l' lists all snapshots in the given image\n"
217 "\n"
218 "Parameters to compare subcommand:\n"
219 " '-f' first image format\n"
220 " '-F' second image format\n"
86ce1f6e
RS
221 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
222 "\n"
223 "Parameters to dd subcommand:\n"
224 " 'bs=BYTES' read and write up to BYTES bytes at a time "
225 "(default: 512)\n"
226 " 'count=N' copy only N input blocks\n"
227 " 'if=FILE' read from FILE\n"
f7c15533
RS
228 " 'of=FILE' write to FILE\n"
229 " 'skip=N' skip N bs-sized blocks at the start of input\n";
e00291c0
PB
230
231 printf("%s\nSupported formats:", help_msg);
9ac404c5 232 bdrv_iterate_format(format_print, NULL, false);
f5048cb7 233 printf("\n\n" QEMU_HELP_BOTTOM "\n");
ac1307ab 234 exit(EXIT_SUCCESS);
ea2384d3
FB
235}
236
80c710cb 237/*
46bb944e 238 * Is @list safe for accumulate_options()?
80c710cb 239 * It is when multiple of them can be joined together separated by ','.
46bb944e 240 * To make that work, @list must not start with ',' (or else a
80c710cb
MA
241 * separating ',' preceding it gets escaped), and it must not end with
242 * an odd number of ',' (or else a separating ',' following it gets
f62514b3
MA
243 * escaped), or be empty (or else a separating ',' preceding it can
244 * escape a separating ',' following it).
245 *
80c710cb 246 */
46bb944e 247static bool is_valid_option_list(const char *list)
80c710cb 248{
46bb944e 249 size_t len = strlen(list);
80c710cb
MA
250 size_t i;
251
46bb944e 252 if (!list[0] || list[0] == ',') {
80c710cb
MA
253 return false;
254 }
255
46bb944e 256 for (i = len; i > 0 && list[i - 1] == ','; i--) {
80c710cb
MA
257 }
258 if ((len - i) % 2) {
259 return false;
260 }
261
262 return true;
c6e5cdfd
KW
263}
264
46bb944e 265static int accumulate_options(char **options, char *list)
6d2b5cba
MA
266{
267 char *new_options;
268
46bb944e
PMD
269 if (!is_valid_option_list(list)) {
270 error_report("Invalid option list: %s", list);
6d2b5cba
MA
271 return -1;
272 }
273
274 if (!*options) {
46bb944e 275 *options = g_strdup(list);
6d2b5cba 276 } else {
46bb944e 277 new_options = g_strdup_printf("%s,%s", *options, list);
6d2b5cba
MA
278 g_free(*options);
279 *options = new_options;
280 }
281 return 0;
282}
283
eb769f74
DB
284static QemuOptsList qemu_source_opts = {
285 .name = "source",
286 .implied_opt_name = "file",
287 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
288 .desc = {
289 { }
290 },
291};
292
9edc6313 293static int G_GNUC_PRINTF(2, 3) qprintf(bool quiet, const char *fmt, ...)
f382d43a
MR
294{
295 int ret = 0;
296 if (!quiet) {
297 va_list args;
298 va_start(args, fmt);
299 ret = vprintf(fmt, args);
300 va_end(args);
301 }
302 return ret;
303}
304
ea2384d3 305
4ac8aacd
JS
306static int print_block_option_help(const char *filename, const char *fmt)
307{
308 BlockDriver *drv, *proto_drv;
83d0521a 309 QemuOptsList *create_opts = NULL;
b65a5e12 310 Error *local_err = NULL;
4ac8aacd
JS
311
312 /* Find driver and parse its options */
313 drv = bdrv_find_format(fmt);
314 if (!drv) {
15654a6d 315 error_report("Unknown file format '%s'", fmt);
4ac8aacd
JS
316 return 1;
317 }
318
d402b6a2
HR
319 if (!drv->create_opts) {
320 error_report("Format driver '%s' does not support image creation", fmt);
321 return 1;
322 }
323
c282e1fd 324 create_opts = qemu_opts_append(create_opts, drv->create_opts);
a283cb6e 325 if (filename) {
b65a5e12 326 proto_drv = bdrv_find_protocol(filename, true, &local_err);
a283cb6e 327 if (!proto_drv) {
2867ce4a 328 error_report_err(local_err);
83d0521a 329 qemu_opts_free(create_opts);
a283cb6e
KW
330 return 1;
331 }
d402b6a2 332 if (!proto_drv->create_opts) {
f0998879 333 error_report("Protocol driver '%s' does not support image creation",
d402b6a2 334 proto_drv->format_name);
3ecd5a4f 335 qemu_opts_free(create_opts);
d402b6a2
HR
336 return 1;
337 }
c282e1fd 338 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
a283cb6e
KW
339 }
340
f4619af0
HR
341 if (filename) {
342 printf("Supported options:\n");
343 } else {
344 printf("Supported %s options:\n", fmt);
345 }
63898712 346 qemu_opts_print_help(create_opts, false);
83d0521a 347 qemu_opts_free(create_opts);
f4619af0
HR
348
349 if (!filename) {
350 printf("\n"
351 "The protocol level may support further options.\n"
352 "Specify the target filename to include those options.\n");
353 }
354
4ac8aacd
JS
355 return 0;
356}
357
eb769f74 358
efaa7c4e 359static BlockBackend *img_open_opts(const char *optstr,
ce099547 360 QemuOpts *opts, int flags, bool writethrough,
335e9937 361 bool quiet, bool force_share)
eb769f74
DB
362{
363 QDict *options;
364 Error *local_err = NULL;
365 BlockBackend *blk;
366 options = qemu_opts_to_qdict(opts, NULL);
335e9937
FZ
367 if (force_share) {
368 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
4615f878 369 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
335e9937 370 error_report("--force-share/-U conflicts with image options");
cb3e7f08 371 qobject_unref(options);
335e9937
FZ
372 return NULL;
373 }
4615f878 374 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
335e9937 375 }
efaa7c4e 376 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
eb769f74 377 if (!blk) {
143605a2 378 error_reportf_err(local_err, "Could not open '%s': ", optstr);
eb769f74
DB
379 return NULL;
380 }
ce099547 381 blk_set_enable_write_cache(blk, !writethrough);
eb769f74 382
eb769f74
DB
383 return blk;
384}
385
efaa7c4e 386static BlockBackend *img_open_file(const char *filename,
29cf9336 387 QDict *options,
eb769f74 388 const char *fmt, int flags,
335e9937
FZ
389 bool writethrough, bool quiet,
390 bool force_share)
eb769f74
DB
391{
392 BlockBackend *blk;
34b5d2c6 393 Error *local_err = NULL;
ad717139 394
29cf9336
DB
395 if (!options) {
396 options = qdict_new();
397 }
75c23805 398 if (fmt) {
46f5ac20 399 qdict_put_str(options, "driver", fmt);
75c23805 400 }
b9eaf9ec 401
335e9937 402 if (force_share) {
579cf1d1 403 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
335e9937 404 }
efaa7c4e 405 blk = blk_new_open(filename, NULL, options, flags, &local_err);
5bd31326 406 if (!blk) {
c29b77f9 407 error_reportf_err(local_err, "Could not open '%s': ", filename);
eb769f74 408 return NULL;
75c23805 409 }
ce099547 410 blk_set_enable_write_cache(blk, !writethrough);
b9eaf9ec 411
eb769f74
DB
412 return blk;
413}
414
415
29cf9336
DB
416static int img_add_key_secrets(void *opaque,
417 const char *name, const char *value,
418 Error **errp)
419{
420 QDict *options = opaque;
421
422 if (g_str_has_suffix(name, "key-secret")) {
187f47e9 423 qdict_put_str(options, name, value);
29cf9336
DB
424 }
425
426 return 0;
427}
428
29cf9336 429
efaa7c4e 430static BlockBackend *img_open(bool image_opts,
eb769f74 431 const char *filename,
ce099547 432 const char *fmt, int flags, bool writethrough,
335e9937 433 bool quiet, bool force_share)
eb769f74
DB
434{
435 BlockBackend *blk;
436 if (image_opts) {
437 QemuOpts *opts;
438 if (fmt) {
439 error_report("--image-opts and --format are mutually exclusive");
440 return NULL;
441 }
442 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
443 filename, true);
444 if (!opts) {
445 return NULL;
446 }
335e9937
FZ
447 blk = img_open_opts(filename, opts, flags, writethrough, quiet,
448 force_share);
eb769f74 449 } else {
29cf9336 450 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
335e9937 451 force_share);
75c23805 452 }
44efba2d
KW
453
454 if (blk) {
455 blk_set_force_allow_inactivate(blk);
456 }
457
7e7d56d9 458 return blk;
75c23805
FB
459}
460
eb769f74 461
83d0521a 462static int add_old_style_options(const char *fmt, QemuOpts *opts,
eec77d9e
JS
463 const char *base_filename,
464 const char *base_fmt)
efa84d43 465{
efa84d43 466 if (base_filename) {
235e59cf 467 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename,
9e194e06 468 NULL)) {
15654a6d
JS
469 error_report("Backing file not supported for file format '%s'",
470 fmt);
c2abccec 471 return -1;
efa84d43
KW
472 }
473 }
474 if (base_fmt) {
9e194e06 475 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, NULL)) {
15654a6d
JS
476 error_report("Backing file format not supported for file "
477 "format '%s'", fmt);
c2abccec 478 return -1;
efa84d43
KW
479 }
480 }
c2abccec 481 return 0;
efa84d43
KW
482}
483
43d589b0
EM
484static int64_t cvtnum_full(const char *name, const char *value, int64_t min,
485 int64_t max)
606caa0a 486{
f17fd4fd 487 int err;
43d589b0
EM
488 uint64_t res;
489
490 err = qemu_strtosz(value, NULL, &res);
491 if (err < 0 && err != -ERANGE) {
492 error_report("Invalid %s specified. You may use "
493 "k, M, G, T, P or E suffixes for", name);
494 error_report("kilobytes, megabytes, gigabytes, terabytes, "
495 "petabytes and exabytes.");
f17fd4fd
MA
496 return err;
497 }
43d589b0
EM
498 if (err == -ERANGE || res > max || res < min) {
499 error_report("Invalid %s specified. Must be between %" PRId64
500 " and %" PRId64 ".", name, min, max);
f46bfdbf
MA
501 return -ERANGE;
502 }
43d589b0
EM
503 return res;
504}
505
506static int64_t cvtnum(const char *name, const char *value)
507{
508 return cvtnum_full(name, value, 0, INT64_MAX);
606caa0a
MA
509}
510
ea2384d3
FB
511static int img_create(int argc, char **argv)
512{
a9300911 513 int c;
1da7cfbd 514 uint64_t img_size = -1;
ea2384d3 515 const char *fmt = "raw";
9230eaf6 516 const char *base_fmt = NULL;
ea2384d3
FB
517 const char *filename;
518 const char *base_filename = NULL;
9ea2ea71 519 char *options = NULL;
9b37525a 520 Error *local_err = NULL;
f382d43a 521 bool quiet = false;
6e6e55f5 522 int flags = 0;
3b46e624 523
ea2384d3 524 for(;;) {
3babeb15
DB
525 static const struct option long_options[] = {
526 {"help", no_argument, 0, 'h'},
527 {"object", required_argument, 0, OPTION_OBJECT},
528 {0, 0, 0, 0}
529 };
6e6e55f5 530 c = getopt_long(argc, argv, ":F:b:f:ho:qu",
3babeb15 531 long_options, NULL);
b8fb60da 532 if (c == -1) {
ea2384d3 533 break;
b8fb60da 534 }
ea2384d3 535 switch(c) {
c9192973
SH
536 case ':':
537 missing_argument(argv[optind - 1]);
538 break;
ef87394c 539 case '?':
c9192973
SH
540 unrecognized_option(argv[optind - 1]);
541 break;
ea2384d3
FB
542 case 'h':
543 help();
544 break;
9230eaf6
AL
545 case 'F':
546 base_fmt = optarg;
547 break;
ea2384d3
FB
548 case 'b':
549 base_filename = optarg;
550 break;
551 case 'f':
552 fmt = optarg;
553 break;
9ea2ea71 554 case 'o':
6d2b5cba 555 if (accumulate_options(&options, optarg) < 0) {
77386bf6
KW
556 goto fail;
557 }
9ea2ea71 558 break;
f382d43a
MR
559 case 'q':
560 quiet = true;
561 break;
6e6e55f5
JS
562 case 'u':
563 flags |= BDRV_O_NO_BACKING;
564 break;
99b1e646
KW
565 case OPTION_OBJECT:
566 user_creatable_process_cmdline(optarg);
567 break;
ea2384d3
FB
568 }
569 }
9230eaf6 570
b50cbabc 571 /* Get the filename */
a283cb6e
KW
572 filename = (optind < argc) ? argv[optind] : NULL;
573 if (options && has_help_option(options)) {
574 g_free(options);
575 return print_block_option_help(filename, fmt);
576 }
577
b8fb60da 578 if (optind >= argc) {
ac1307ab 579 error_exit("Expecting image file name");
b8fb60da 580 }
a283cb6e 581 optind++;
b50cbabc 582
1da7cfbd
JS
583 /* Get image size, if specified */
584 if (optind < argc) {
70b4f4bb 585 int64_t sval;
606caa0a 586
43d589b0 587 sval = cvtnum("image size", argv[optind++]);
606caa0a 588 if (sval < 0) {
77386bf6 589 goto fail;
1da7cfbd
JS
590 }
591 img_size = (uint64_t)sval;
592 }
fc11eb26 593 if (optind != argc) {
ac1307ab 594 error_exit("Unexpected argument: %s", argv[optind]);
fc11eb26 595 }
1da7cfbd 596
9b37525a 597 bdrv_img_create(filename, fmt, base_filename, base_fmt,
6e6e55f5 598 options, img_size, flags, quiet, &local_err);
84d18f06 599 if (local_err) {
c29b77f9 600 error_reportf_err(local_err, "%s: ", filename);
77386bf6 601 goto fail;
c2abccec 602 }
a9300911 603
77386bf6 604 g_free(options);
ea2384d3 605 return 0;
77386bf6
KW
606
607fail:
608 g_free(options);
609 return 1;
ea2384d3
FB
610}
611
f382d43a 612static void dump_json_image_check(ImageCheck *check, bool quiet)
8599ea4c 613{
eab3a467 614 GString *str;
8599ea4c 615 QObject *obj;
7d5e199a 616 Visitor *v = qobject_output_visitor_new(&obj);
3b098d56
EB
617
618 visit_type_ImageCheck(v, NULL, &check, &error_abort);
619 visit_complete(v, &obj);
6589f459 620 str = qobject_to_json_pretty(obj, true);
8599ea4c 621 assert(str != NULL);
eab3a467 622 qprintf(quiet, "%s\n", str->str);
cb3e7f08 623 qobject_unref(obj);
3b098d56 624 visit_free(v);
eab3a467 625 g_string_free(str, true);
8599ea4c
FS
626}
627
f382d43a 628static void dump_human_image_check(ImageCheck *check, bool quiet)
8599ea4c
FS
629{
630 if (!(check->corruptions || check->leaks || check->check_errors)) {
f382d43a 631 qprintf(quiet, "No errors were found on the image.\n");
8599ea4c
FS
632 } else {
633 if (check->corruptions) {
f382d43a
MR
634 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
635 "Data may be corrupted, or further writes to the image "
636 "may corrupt it.\n",
637 check->corruptions);
8599ea4c
FS
638 }
639
640 if (check->leaks) {
f382d43a
MR
641 qprintf(quiet,
642 "\n%" PRId64 " leaked clusters were found on the image.\n"
643 "This means waste of disk space, but no harm to data.\n",
644 check->leaks);
8599ea4c
FS
645 }
646
647 if (check->check_errors) {
f382d43a
MR
648 qprintf(quiet,
649 "\n%" PRId64
650 " internal errors have occurred during the check.\n",
651 check->check_errors);
8599ea4c
FS
652 }
653 }
654
655 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
f382d43a
MR
656 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
657 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
658 check->allocated_clusters, check->total_clusters,
659 check->allocated_clusters * 100.0 / check->total_clusters,
660 check->fragmented_clusters * 100.0 / check->allocated_clusters,
661 check->compressed_clusters * 100.0 /
662 check->allocated_clusters);
8599ea4c
FS
663 }
664
665 if (check->image_end_offset) {
f382d43a
MR
666 qprintf(quiet,
667 "Image end offset: %" PRId64 "\n", check->image_end_offset);
8599ea4c
FS
668 }
669}
670
671static int collect_image_check(BlockDriverState *bs,
672 ImageCheck *check,
673 const char *filename,
674 const char *fmt,
675 int fix)
676{
677 int ret;
678 BdrvCheckResult result;
679
680 ret = bdrv_check(bs, &result, fix);
681 if (ret < 0) {
682 return ret;
683 }
684
685 check->filename = g_strdup(filename);
686 check->format = g_strdup(bdrv_get_format_name(bs));
687 check->check_errors = result.check_errors;
688 check->corruptions = result.corruptions;
689 check->has_corruptions = result.corruptions != 0;
690 check->leaks = result.leaks;
691 check->has_leaks = result.leaks != 0;
692 check->corruptions_fixed = result.corruptions_fixed;
1656324e 693 check->has_corruptions_fixed = result.corruptions_fixed != 0;
8599ea4c 694 check->leaks_fixed = result.leaks_fixed;
1656324e 695 check->has_leaks_fixed = result.leaks_fixed != 0;
8599ea4c
FS
696 check->image_end_offset = result.image_end_offset;
697 check->has_image_end_offset = result.image_end_offset != 0;
698 check->total_clusters = result.bfi.total_clusters;
699 check->has_total_clusters = result.bfi.total_clusters != 0;
700 check->allocated_clusters = result.bfi.allocated_clusters;
701 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
702 check->fragmented_clusters = result.bfi.fragmented_clusters;
703 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
e6439d78
SH
704 check->compressed_clusters = result.bfi.compressed_clusters;
705 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
8599ea4c
FS
706
707 return 0;
708}
709
e076f338
KW
710/*
711 * Checks an image for consistency. Exit codes:
712 *
d6635c4d
HR
713 * 0 - Check completed, image is good
714 * 1 - Check not completed because of internal errors
715 * 2 - Check completed, image is corrupted
716 * 3 - Check completed, image has leaked clusters, but is good otherwise
717 * 63 - Checks are not supported by the image format
e076f338 718 */
1585969c
AL
719static int img_check(int argc, char **argv)
720{
721 int c, ret;
8599ea4c 722 OutputFormat output_format = OFORMAT_HUMAN;
40055951 723 const char *filename, *fmt, *output, *cache;
26f54e9a 724 BlockBackend *blk;
1585969c 725 BlockDriverState *bs;
4534ff54 726 int fix = 0;
ce099547
KW
727 int flags = BDRV_O_CHECK;
728 bool writethrough;
7e7d56d9 729 ImageCheck *check;
f382d43a 730 bool quiet = false;
eb769f74 731 bool image_opts = false;
335e9937 732 bool force_share = false;
1585969c
AL
733
734 fmt = NULL;
8599ea4c 735 output = NULL;
40055951 736 cache = BDRV_DEFAULT_CACHE;
ce099547 737
1585969c 738 for(;;) {
8599ea4c
FS
739 int option_index = 0;
740 static const struct option long_options[] = {
741 {"help", no_argument, 0, 'h'},
742 {"format", required_argument, 0, 'f'},
4fd6a984 743 {"repair", required_argument, 0, 'r'},
8599ea4c 744 {"output", required_argument, 0, OPTION_OUTPUT},
3babeb15 745 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 746 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 747 {"force-share", no_argument, 0, 'U'},
8599ea4c
FS
748 {0, 0, 0, 0}
749 };
335e9937 750 c = getopt_long(argc, argv, ":hf:r:T:qU",
8599ea4c 751 long_options, &option_index);
b8fb60da 752 if (c == -1) {
1585969c 753 break;
b8fb60da 754 }
1585969c 755 switch(c) {
c9192973
SH
756 case ':':
757 missing_argument(argv[optind - 1]);
758 break;
ef87394c 759 case '?':
c9192973
SH
760 unrecognized_option(argv[optind - 1]);
761 break;
1585969c
AL
762 case 'h':
763 help();
764 break;
765 case 'f':
766 fmt = optarg;
767 break;
4534ff54
KW
768 case 'r':
769 flags |= BDRV_O_RDWR;
770
771 if (!strcmp(optarg, "leaks")) {
772 fix = BDRV_FIX_LEAKS;
773 } else if (!strcmp(optarg, "all")) {
774 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
775 } else {
ac1307ab
FZ
776 error_exit("Unknown option value for -r "
777 "(expecting 'leaks' or 'all'): %s", optarg);
4534ff54
KW
778 }
779 break;
8599ea4c
FS
780 case OPTION_OUTPUT:
781 output = optarg;
782 break;
40055951
HR
783 case 'T':
784 cache = optarg;
785 break;
f382d43a
MR
786 case 'q':
787 quiet = true;
788 break;
335e9937
FZ
789 case 'U':
790 force_share = true;
791 break;
99b1e646
KW
792 case OPTION_OBJECT:
793 user_creatable_process_cmdline(optarg);
794 break;
eb769f74
DB
795 case OPTION_IMAGE_OPTS:
796 image_opts = true;
797 break;
1585969c
AL
798 }
799 }
fc11eb26 800 if (optind != argc - 1) {
ac1307ab 801 error_exit("Expecting one image file name");
b8fb60da 802 }
1585969c
AL
803 filename = argv[optind++];
804
8599ea4c
FS
805 if (output && !strcmp(output, "json")) {
806 output_format = OFORMAT_JSON;
807 } else if (output && !strcmp(output, "human")) {
808 output_format = OFORMAT_HUMAN;
809 } else if (output) {
810 error_report("--output must be used with human or json as argument.");
811 return 1;
812 }
813
ce099547 814 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
40055951
HR
815 if (ret < 0) {
816 error_report("Invalid source cache option: %s", cache);
817 return 1;
818 }
819
335e9937
FZ
820 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
821 force_share);
7e7d56d9
MA
822 if (!blk) {
823 return 1;
c2abccec 824 }
7e7d56d9 825 bs = blk_bs(blk);
8599ea4c
FS
826
827 check = g_new0(ImageCheck, 1);
828 ret = collect_image_check(bs, check, filename, fmt, fix);
e076f338
KW
829
830 if (ret == -ENOTSUP) {
55d492d7 831 error_report("This image format does not support checks");
fefddf95 832 ret = 63;
8599ea4c 833 goto fail;
e076f338
KW
834 }
835
8599ea4c
FS
836 if (check->corruptions_fixed || check->leaks_fixed) {
837 int corruptions_fixed, leaks_fixed;
1656324e 838 bool has_leaks_fixed, has_corruptions_fixed;
ccf34716 839
8599ea4c 840 leaks_fixed = check->leaks_fixed;
1656324e 841 has_leaks_fixed = check->has_leaks_fixed;
8599ea4c 842 corruptions_fixed = check->corruptions_fixed;
1656324e 843 has_corruptions_fixed = check->has_corruptions_fixed;
e076f338 844
8599ea4c 845 if (output_format == OFORMAT_HUMAN) {
f382d43a
MR
846 qprintf(quiet,
847 "The following inconsistencies were found and repaired:\n\n"
848 " %" PRId64 " leaked clusters\n"
849 " %" PRId64 " corruptions\n\n"
850 "Double checking the fixed image now...\n",
851 check->leaks_fixed,
852 check->corruptions_fixed);
e076f338
KW
853 }
854
fc124ea1
PN
855 qapi_free_ImageCheck(check);
856 check = g_new0(ImageCheck, 1);
8599ea4c 857 ret = collect_image_check(bs, check, filename, fmt, 0);
1585969c 858
8599ea4c 859 check->leaks_fixed = leaks_fixed;
1656324e 860 check->has_leaks_fixed = has_leaks_fixed;
8599ea4c 861 check->corruptions_fixed = corruptions_fixed;
1656324e 862 check->has_corruptions_fixed = has_corruptions_fixed;
f8111c24
DXW
863 }
864
832390a5
HR
865 if (!ret) {
866 switch (output_format) {
867 case OFORMAT_HUMAN:
868 dump_human_image_check(check, quiet);
869 break;
870 case OFORMAT_JSON:
871 dump_json_image_check(check, quiet);
872 break;
873 }
c6bb9ad1
FS
874 }
875
8599ea4c 876 if (ret || check->check_errors) {
832390a5
HR
877 if (ret) {
878 error_report("Check failed: %s", strerror(-ret));
879 } else {
880 error_report("Check failed");
881 }
8599ea4c
FS
882 ret = 1;
883 goto fail;
c2abccec 884 }
e076f338 885
8599ea4c
FS
886 if (check->corruptions) {
887 ret = 2;
888 } else if (check->leaks) {
889 ret = 3;
e076f338 890 } else {
8599ea4c 891 ret = 0;
e076f338 892 }
8599ea4c
FS
893
894fail:
895 qapi_free_ImageCheck(check);
26f54e9a 896 blk_unref(blk);
8599ea4c 897 return ret;
1585969c
AL
898}
899
d4a3238a
HR
900typedef struct CommonBlockJobCBInfo {
901 BlockDriverState *bs;
902 Error **errp;
903} CommonBlockJobCBInfo;
904
905static void common_block_job_cb(void *opaque, int ret)
906{
907 CommonBlockJobCBInfo *cbi = opaque;
908
909 if (ret < 0) {
910 error_setg_errno(cbi->errp, -ret, "Block job failed");
911 }
d4a3238a
HR
912}
913
914static void run_block_job(BlockJob *job, Error **errp)
915{
a7b4f8fc 916 uint64_t progress_current, progress_total;
df9a3165 917 AioContext *aio_context = block_job_get_aio_context(job);
4172a003 918 int ret = 0;
d4a3238a 919
880eeec6
EGE
920 job_lock();
921 job_ref_locked(&job->job);
d4a3238a 922 do {
30a5c887 923 float progress = 0.0f;
880eeec6 924 job_unlock();
d4a3238a 925 aio_poll(aio_context, true);
a7b4f8fc
EGE
926
927 progress_get_snapshot(&job->job.progress, &progress_current,
928 &progress_total);
929 if (progress_total) {
930 progress = (float)progress_current / progress_total * 100.f;
30a5c887
KW
931 }
932 qemu_progress_print(progress, 0);
880eeec6
EGE
933 job_lock();
934 } while (!job_is_ready_locked(&job->job) &&
935 !job_is_completed_locked(&job->job));
d4a3238a 936
880eeec6
EGE
937 if (!job_is_completed_locked(&job->job)) {
938 ret = job_complete_sync_locked(&job->job, errp);
4172a003 939 } else {
4ad35181 940 ret = job->job.ret;
4172a003 941 }
880eeec6
EGE
942 job_unref_locked(&job->job);
943 job_unlock();
687fa1d8 944
4172a003
SJ
945 /* publish completion progress only when success */
946 if (!ret) {
947 qemu_progress_print(100.f, 0);
948 }
d4a3238a
HR
949}
950
ea2384d3
FB
951static int img_commit(int argc, char **argv)
952{
661a0f71 953 int c, ret, flags;
1b22bffd 954 const char *filename, *fmt, *cache, *base;
26f54e9a 955 BlockBackend *blk;
d4a3238a 956 BlockDriverState *bs, *base_bs;
4ef85a9c 957 BlockJob *job;
687fa1d8 958 bool progress = false, quiet = false, drop = false;
ce099547 959 bool writethrough;
d4a3238a
HR
960 Error *local_err = NULL;
961 CommonBlockJobCBInfo cbi;
eb769f74 962 bool image_opts = false;
a0441b66 963 int64_t rate_limit = 0;
ea2384d3
FB
964
965 fmt = NULL;
661a0f71 966 cache = BDRV_DEFAULT_CACHE;
1b22bffd 967 base = NULL;
ea2384d3 968 for(;;) {
3babeb15
DB
969 static const struct option long_options[] = {
970 {"help", no_argument, 0, 'h'},
971 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 972 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
973 {0, 0, 0, 0}
974 };
a0441b66 975 c = getopt_long(argc, argv, ":f:ht:b:dpqr:",
3babeb15 976 long_options, NULL);
b8fb60da 977 if (c == -1) {
ea2384d3 978 break;
b8fb60da 979 }
ea2384d3 980 switch(c) {
c9192973
SH
981 case ':':
982 missing_argument(argv[optind - 1]);
983 break;
ef87394c 984 case '?':
c9192973
SH
985 unrecognized_option(argv[optind - 1]);
986 break;
ea2384d3
FB
987 case 'h':
988 help();
989 break;
990 case 'f':
991 fmt = optarg;
992 break;
661a0f71
FS
993 case 't':
994 cache = optarg;
995 break;
1b22bffd
HR
996 case 'b':
997 base = optarg;
998 /* -b implies -d */
999 drop = true;
1000 break;
9a86fe48
HR
1001 case 'd':
1002 drop = true;
1003 break;
687fa1d8
HR
1004 case 'p':
1005 progress = true;
1006 break;
f382d43a
MR
1007 case 'q':
1008 quiet = true;
1009 break;
a0441b66
ZL
1010 case 'r':
1011 rate_limit = cvtnum("rate limit", optarg);
1012 if (rate_limit < 0) {
1013 return 1;
1014 }
1015 break;
99b1e646
KW
1016 case OPTION_OBJECT:
1017 user_creatable_process_cmdline(optarg);
1018 break;
eb769f74
DB
1019 case OPTION_IMAGE_OPTS:
1020 image_opts = true;
1021 break;
ea2384d3
FB
1022 }
1023 }
687fa1d8
HR
1024
1025 /* Progress is not shown in Quiet mode */
1026 if (quiet) {
1027 progress = false;
1028 }
1029
fc11eb26 1030 if (optind != argc - 1) {
ac1307ab 1031 error_exit("Expecting one image file name");
b8fb60da 1032 }
ea2384d3
FB
1033 filename = argv[optind++];
1034
9a86fe48 1035 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
ce099547 1036 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
661a0f71
FS
1037 if (ret < 0) {
1038 error_report("Invalid cache option: %s", cache);
a3981eb9 1039 return 1;
661a0f71
FS
1040 }
1041
335e9937
FZ
1042 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
1043 false);
7e7d56d9
MA
1044 if (!blk) {
1045 return 1;
c2abccec 1046 }
7e7d56d9
MA
1047 bs = blk_bs(blk);
1048
687fa1d8
HR
1049 qemu_progress_init(progress, 1.f);
1050 qemu_progress_print(0.f, 100);
1051
ad74751f 1052 bdrv_graph_rdlock_main_loop();
1b22bffd
HR
1053 if (base) {
1054 base_bs = bdrv_find_backing_image(bs, base);
1055 if (!base_bs) {
6b33f3ae
HR
1056 error_setg(&local_err,
1057 "Did not find '%s' in the backing chain of '%s'",
1058 base, filename);
ad74751f 1059 bdrv_graph_rdunlock_main_loop();
1b22bffd
HR
1060 goto done;
1061 }
1062 } else {
1063 /* This is different from QMP, which by default uses the deepest file in
1064 * the backing chain (i.e., the very base); however, the traditional
1065 * behavior of qemu-img commit is using the immediate backing file. */
4a2061e6 1066 base_bs = bdrv_backing_chain_next(bs);
1b22bffd
HR
1067 if (!base_bs) {
1068 error_setg(&local_err, "Image does not have a backing file");
ad74751f 1069 bdrv_graph_rdunlock_main_loop();
1b22bffd
HR
1070 goto done;
1071 }
d4a3238a 1072 }
ad74751f 1073 bdrv_graph_rdunlock_main_loop();
d4a3238a
HR
1074
1075 cbi = (CommonBlockJobCBInfo){
1076 .errp = &local_err,
1077 .bs = bs,
1078 };
1079
a0441b66 1080 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, rate_limit,
0db832f4 1081 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
78bbd910 1082 &cbi, false, &local_err);
d4a3238a
HR
1083 if (local_err) {
1084 goto done;
ea2384d3
FB
1085 }
1086
3f09bfbc
KW
1087 /* When the block job completes, the BlockBackend reference will point to
1088 * the old backing file. In order to avoid that the top image is already
1089 * deleted, so we can still empty it afterwards, increment the reference
1090 * counter here preemptively. */
9a86fe48 1091 if (!drop) {
3f09bfbc 1092 bdrv_ref(bs);
9a86fe48
HR
1093 }
1094
4ef85a9c 1095 job = block_job_get("commit");
2e2db260 1096 assert(job);
4ef85a9c 1097 run_block_job(job, &local_err);
9a86fe48
HR
1098 if (local_err) {
1099 goto unref_backing;
1100 }
1101
2d97fde4
HR
1102 if (!drop) {
1103 BlockBackend *old_backing_blk;
1104
1105 old_backing_blk = blk_new_with_bs(bs, BLK_PERM_WRITE, BLK_PERM_ALL,
1106 &local_err);
1107 if (!old_backing_blk) {
1108 goto unref_backing;
1109 }
1110 ret = blk_make_empty(old_backing_blk, &local_err);
1111 blk_unref(old_backing_blk);
1112 if (ret == -ENOTSUP) {
1113 error_free(local_err);
1114 local_err = NULL;
1115 } else if (ret < 0) {
9a86fe48
HR
1116 goto unref_backing;
1117 }
1118 }
1119
1120unref_backing:
1121 if (!drop) {
3f09bfbc 1122 bdrv_unref(bs);
9a86fe48 1123 }
d4a3238a
HR
1124
1125done:
687fa1d8
HR
1126 qemu_progress_end();
1127
44efba2d
KW
1128 /*
1129 * Manually inactivate the image first because this way we can know whether
1130 * an error occurred. blk_unref() doesn't tell us about failures.
1131 */
1132 ret = bdrv_inactivate_all();
1133 if (ret < 0 && !local_err) {
1134 error_setg_errno(&local_err, -ret, "Error while closing the image");
1135 }
26f54e9a 1136 blk_unref(blk);
d4a3238a
HR
1137
1138 if (local_err) {
6936f299 1139 error_report_err(local_err);
c2abccec
MK
1140 return 1;
1141 }
d4a3238a
HR
1142
1143 qprintf(quiet, "Image committed.\n");
ea2384d3
FB
1144 return 0;
1145}
1146
debb38a4
EB
1147/*
1148 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1149 * of the first sector boundary within buf where the sector contains a
1150 * non-zero byte. This function is robust to a buffer that is not
1151 * sector-aligned.
1152 */
1153static int64_t find_nonzero(const uint8_t *buf, int64_t n)
1154{
1155 int64_t i;
1156 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);
1157
1158 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
1159 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
1160 return i;
1161 }
1162 }
1163 if (i < n && !buffer_is_zero(buf + i, n - end)) {
1164 return i;
1165 }
1166 return -1;
1167}
1168
f58c7b35
TS
1169/*
1170 * Returns true iff the first sector pointed to by 'buf' contains at least
1171 * a non-NUL byte.
1172 *
1173 * 'pnum' is set to the number of sectors (including and immediately following
1174 * the first one) that are known to be in the same allocated/unallocated state.
8dcd3c9b 1175 * The function will try to align the end offset to alignment boundaries so
e3a6e0da 1176 * that the request will at least end aligned and consecutive requests will
8dcd3c9b 1177 * also start at an aligned offset.
f58c7b35 1178 */
8dcd3c9b
PL
1179static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
1180 int64_t sector_num, int alignment)
ea2384d3 1181{
1a6d39fd 1182 bool is_zero;
8dcd3c9b 1183 int i, tail;
ea2384d3
FB
1184
1185 if (n <= 0) {
1186 *pnum = 0;
1187 return 0;
1188 }
c075c42f 1189 is_zero = buffer_is_zero(buf, BDRV_SECTOR_SIZE);
ea2384d3 1190 for(i = 1; i < n; i++) {
c075c42f
YL
1191 buf += BDRV_SECTOR_SIZE;
1192 if (is_zero != buffer_is_zero(buf, BDRV_SECTOR_SIZE)) {
ea2384d3 1193 break;
1a6d39fd 1194 }
ea2384d3 1195 }
8dcd3c9b 1196
96054c76
VSO
1197 if (i == n) {
1198 /*
1199 * The whole buf is the same.
1200 * No reason to split it into chunks, so return now.
1201 */
1202 *pnum = i;
1203 return !is_zero;
1204 }
1205
8dcd3c9b
PL
1206 tail = (sector_num + i) & (alignment - 1);
1207 if (tail) {
1208 if (is_zero && i <= tail) {
96054c76
VSO
1209 /*
1210 * For sure next sector after i is data, and it will rewrite this
1211 * tail anyway due to RMW. So, let's just write data now.
1212 */
8dcd3c9b
PL
1213 is_zero = false;
1214 }
1215 if (!is_zero) {
96054c76 1216 /* If possible, align up end offset of allocated areas. */
8dcd3c9b
PL
1217 i += alignment - tail;
1218 i = MIN(i, n);
1219 } else {
96054c76
VSO
1220 /*
1221 * For sure next sector after i is data, and it will rewrite this
1222 * tail anyway due to RMW. Better is avoid RMW and write zeroes up
1223 * to aligned bound.
1224 */
8dcd3c9b
PL
1225 i -= tail;
1226 }
1227 }
ea2384d3 1228 *pnum = i;
1a6d39fd 1229 return !is_zero;
ea2384d3
FB
1230}
1231
a22f123c
KW
1232/*
1233 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1234 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1235 * breaking up write requests for only small sparse areas.
1236 */
1237static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
8dcd3c9b 1238 int min, int64_t sector_num, int alignment)
a22f123c
KW
1239{
1240 int ret;
1241 int num_checked, num_used;
1242
1243 if (n < min) {
1244 min = n;
1245 }
1246
8dcd3c9b 1247 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
a22f123c
KW
1248 if (!ret) {
1249 return ret;
1250 }
1251
1252 num_used = *pnum;
1253 buf += BDRV_SECTOR_SIZE * *pnum;
1254 n -= *pnum;
8dcd3c9b 1255 sector_num += *pnum;
a22f123c
KW
1256 num_checked = num_used;
1257
1258 while (n > 0) {
8dcd3c9b 1259 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
a22f123c
KW
1260
1261 buf += BDRV_SECTOR_SIZE * *pnum;
1262 n -= *pnum;
8dcd3c9b 1263 sector_num += *pnum;
a22f123c
KW
1264 num_checked += *pnum;
1265 if (ret) {
1266 num_used = num_checked;
1267 } else if (*pnum >= min) {
1268 break;
1269 }
1270 }
1271
1272 *pnum = num_used;
1273 return 1;
1274}
1275
3e85c6fd 1276/*
c20c8ae7
AD
1277 * Compares two buffers chunk by chunk, where @chsize is the chunk size.
1278 * If @chsize is 0, default chunk size of BDRV_SECTOR_SIZE is used.
1279 * Returns 0 if the first chunk of each buffer matches, non-zero otherwise.
3e85c6fd 1280 *
c20c8ae7
AD
1281 * @pnum is set to the size of the buffer prefix aligned to @chsize that
1282 * has the same matching status as the first chunk.
3e85c6fd 1283 */
dc61cd3b 1284static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
c20c8ae7 1285 int64_t bytes, uint64_t chsize, int64_t *pnum)
3e85c6fd 1286{
8c1ac475 1287 bool res;
c20c8ae7 1288 int64_t i;
3e85c6fd 1289
dc61cd3b 1290 assert(bytes > 0);
3e85c6fd 1291
c20c8ae7
AD
1292 if (!chsize) {
1293 chsize = BDRV_SECTOR_SIZE;
1294 }
1295 i = MIN(bytes, chsize);
1296
dc61cd3b
EB
1297 res = !!memcmp(buf1, buf2, i);
1298 while (i < bytes) {
c20c8ae7 1299 int64_t len = MIN(bytes - i, chsize);
3e85c6fd 1300
dc61cd3b 1301 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
3e85c6fd
KW
1302 break;
1303 }
dc61cd3b 1304 i += len;
3e85c6fd
KW
1305 }
1306
1307 *pnum = i;
1308 return res;
1309}
1310
97ede57a 1311#define IO_BUF_SIZE (2 * MiB)
ea2384d3 1312
d14ed18c
MR
1313/*
1314 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1315 *
0608e40e
EB
1316 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1317 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1318 * failure), and 4 on error (the exit status for read errors), after emitting
1319 * an error message.
d14ed18c 1320 *
f1d3cd79 1321 * @param blk: BlockBackend for the image
c41508ed
EB
1322 * @param offset: Starting offset to check
1323 * @param bytes: Number of bytes to check
d14ed18c
MR
1324 * @param filename: Name of disk file we are checking (logging purpose)
1325 * @param buffer: Allocated buffer for storing read data
1326 * @param quiet: Flag for quiet mode
1327 */
c41508ed
EB
1328static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1329 int64_t bytes, const char *filename,
d14ed18c
MR
1330 uint8_t *buffer, bool quiet)
1331{
debb38a4
EB
1332 int ret = 0;
1333 int64_t idx;
1334
a9262f55 1335 ret = blk_pread(blk, offset, bytes, buffer, 0);
d14ed18c
MR
1336 if (ret < 0) {
1337 error_report("Error while reading offset %" PRId64 " of %s: %s",
c41508ed 1338 offset, filename, strerror(-ret));
0608e40e 1339 return 4;
d14ed18c 1340 }
c41508ed 1341 idx = find_nonzero(buffer, bytes);
debb38a4 1342 if (idx >= 0) {
d14ed18c 1343 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
c41508ed 1344 offset + idx);
d14ed18c
MR
1345 return 1;
1346 }
1347
1348 return 0;
1349}
1350
1351/*
1352 * Compares two images. Exit codes:
1353 *
99b1e646 1354 * 0 - Images are identical or the requested help was printed
d14ed18c
MR
1355 * 1 - Images differ
1356 * >1 - Error occurred
1357 */
1358static int img_compare(int argc, char **argv)
1359{
40055951 1360 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
26f54e9a 1361 BlockBackend *blk1, *blk2;
d14ed18c 1362 BlockDriverState *bs1, *bs2;
033d9fc2 1363 int64_t total_size1, total_size2;
d14ed18c 1364 uint8_t *buf1 = NULL, *buf2 = NULL;
31826642 1365 int64_t pnum1, pnum2;
d14ed18c
MR
1366 int allocated1, allocated2;
1367 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1368 bool progress = false, quiet = false, strict = false;
40055951 1369 int flags;
ce099547 1370 bool writethrough;
033d9fc2
EB
1371 int64_t total_size;
1372 int64_t offset = 0;
1373 int64_t chunk;
dc61cd3b 1374 int c;
d14ed18c 1375 uint64_t progress_base;
eb769f74 1376 bool image_opts = false;
335e9937 1377 bool force_share = false;
d14ed18c 1378
40055951 1379 cache = BDRV_DEFAULT_CACHE;
d14ed18c 1380 for (;;) {
3babeb15
DB
1381 static const struct option long_options[] = {
1382 {"help", no_argument, 0, 'h'},
1383 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 1384 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 1385 {"force-share", no_argument, 0, 'U'},
3babeb15
DB
1386 {0, 0, 0, 0}
1387 };
335e9937 1388 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
3babeb15 1389 long_options, NULL);
d14ed18c
MR
1390 if (c == -1) {
1391 break;
1392 }
1393 switch (c) {
c9192973
SH
1394 case ':':
1395 missing_argument(argv[optind - 1]);
1396 break;
d14ed18c 1397 case '?':
c9192973
SH
1398 unrecognized_option(argv[optind - 1]);
1399 break;
d14ed18c
MR
1400 case 'h':
1401 help();
1402 break;
1403 case 'f':
1404 fmt1 = optarg;
1405 break;
1406 case 'F':
1407 fmt2 = optarg;
1408 break;
40055951
HR
1409 case 'T':
1410 cache = optarg;
1411 break;
d14ed18c
MR
1412 case 'p':
1413 progress = true;
1414 break;
1415 case 'q':
1416 quiet = true;
1417 break;
1418 case 's':
1419 strict = true;
1420 break;
335e9937
FZ
1421 case 'U':
1422 force_share = true;
1423 break;
99b1e646
KW
1424 case OPTION_OBJECT:
1425 {
1426 Error *local_err = NULL;
1427
1428 if (!user_creatable_add_from_str(optarg, &local_err)) {
1429 if (local_err) {
1430 error_report_err(local_err);
1431 exit(2);
1432 } else {
1433 /* Help was printed */
1434 exit(EXIT_SUCCESS);
1435 }
1436 }
1437 break;
3babeb15 1438 }
eb769f74
DB
1439 case OPTION_IMAGE_OPTS:
1440 image_opts = true;
1441 break;
d14ed18c
MR
1442 }
1443 }
1444
1445 /* Progress is not shown in Quiet mode */
1446 if (quiet) {
1447 progress = false;
1448 }
1449
1450
fc11eb26 1451 if (optind != argc - 2) {
ac1307ab 1452 error_exit("Expecting two image file names");
d14ed18c
MR
1453 }
1454 filename1 = argv[optind++];
1455 filename2 = argv[optind++];
1456
cbda016d
SH
1457 /* Initialize before goto out */
1458 qemu_progress_init(progress, 2.0);
1459
ce099547
KW
1460 flags = 0;
1461 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
40055951
HR
1462 if (ret < 0) {
1463 error_report("Invalid source cache option: %s", cache);
1464 ret = 2;
1465 goto out3;
1466 }
1467
335e9937
FZ
1468 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1469 force_share);
7e7d56d9 1470 if (!blk1) {
d14ed18c 1471 ret = 2;
7e7d56d9 1472 goto out3;
d14ed18c
MR
1473 }
1474
335e9937
FZ
1475 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1476 force_share);
7e7d56d9 1477 if (!blk2) {
d14ed18c 1478 ret = 2;
7e7d56d9 1479 goto out2;
d14ed18c 1480 }
eb769f74 1481 bs1 = blk_bs(blk1);
7e7d56d9 1482 bs2 = blk_bs(blk2);
d14ed18c 1483
f1d3cd79
HR
1484 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1485 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
033d9fc2
EB
1486 total_size1 = blk_getlength(blk1);
1487 if (total_size1 < 0) {
52bf1e72 1488 error_report("Can't get size of %s: %s",
033d9fc2 1489 filename1, strerror(-total_size1));
52bf1e72
MA
1490 ret = 4;
1491 goto out;
1492 }
033d9fc2
EB
1493 total_size2 = blk_getlength(blk2);
1494 if (total_size2 < 0) {
52bf1e72 1495 error_report("Can't get size of %s: %s",
033d9fc2 1496 filename2, strerror(-total_size2));
52bf1e72
MA
1497 ret = 4;
1498 goto out;
1499 }
033d9fc2
EB
1500 total_size = MIN(total_size1, total_size2);
1501 progress_base = MAX(total_size1, total_size2);
d14ed18c
MR
1502
1503 qemu_progress_print(0, 100);
1504
033d9fc2 1505 if (strict && total_size1 != total_size2) {
d14ed18c
MR
1506 ret = 1;
1507 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1508 goto out;
1509 }
1510
033d9fc2 1511 while (offset < total_size) {
31826642 1512 int status1, status2;
67a0fd2a 1513
033d9fc2
EB
1514 status1 = bdrv_block_status_above(bs1, NULL, offset,
1515 total_size1 - offset, &pnum1, NULL,
1516 NULL);
25ad8e6e 1517 if (status1 < 0) {
d14ed18c
MR
1518 ret = 3;
1519 error_report("Sector allocation test failed for %s", filename1);
1520 goto out;
1521 }
25ad8e6e 1522 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
d14ed18c 1523
033d9fc2
EB
1524 status2 = bdrv_block_status_above(bs2, NULL, offset,
1525 total_size2 - offset, &pnum2, NULL,
1526 NULL);
25ad8e6e 1527 if (status2 < 0) {
d14ed18c
MR
1528 ret = 3;
1529 error_report("Sector allocation test failed for %s", filename2);
1530 goto out;
1531 }
25ad8e6e 1532 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
7daddc61
EB
1533
1534 assert(pnum1 && pnum2);
033d9fc2 1535 chunk = MIN(pnum1, pnum2);
d14ed18c 1536
25ad8e6e 1537 if (strict) {
31826642 1538 if (status1 != status2) {
25ad8e6e
FZ
1539 ret = 1;
1540 qprintf(quiet, "Strict mode: Offset %" PRId64
033d9fc2 1541 " block status mismatch!\n", offset);
25ad8e6e
FZ
1542 goto out;
1543 }
1544 }
1545 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
7daddc61 1546 /* nothing to do */
25ad8e6e 1547 } else if (allocated1 == allocated2) {
d14ed18c 1548 if (allocated1) {
dc61cd3b
EB
1549 int64_t pnum;
1550
033d9fc2 1551 chunk = MIN(chunk, IO_BUF_SIZE);
a9262f55 1552 ret = blk_pread(blk1, offset, chunk, buf1, 0);
d14ed18c 1553 if (ret < 0) {
033d9fc2
EB
1554 error_report("Error while reading offset %" PRId64
1555 " of %s: %s",
1556 offset, filename1, strerror(-ret));
d14ed18c
MR
1557 ret = 4;
1558 goto out;
1559 }
a9262f55 1560 ret = blk_pread(blk2, offset, chunk, buf2, 0);
d14ed18c
MR
1561 if (ret < 0) {
1562 error_report("Error while reading offset %" PRId64
033d9fc2
EB
1563 " of %s: %s",
1564 offset, filename2, strerror(-ret));
d14ed18c
MR
1565 ret = 4;
1566 goto out;
1567 }
c20c8ae7 1568 ret = compare_buffers(buf1, buf2, chunk, 0, &pnum);
033d9fc2 1569 if (ret || pnum != chunk) {
d14ed18c 1570 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
033d9fc2 1571 offset + (ret ? 0 : pnum));
36452f12 1572 ret = 1;
d14ed18c
MR
1573 goto out;
1574 }
1575 }
1576 } else {
033d9fc2 1577 chunk = MIN(chunk, IO_BUF_SIZE);
d14ed18c 1578 if (allocated1) {
033d9fc2 1579 ret = check_empty_sectors(blk1, offset, chunk,
d14ed18c
MR
1580 filename1, buf1, quiet);
1581 } else {
033d9fc2 1582 ret = check_empty_sectors(blk2, offset, chunk,
d14ed18c
MR
1583 filename2, buf1, quiet);
1584 }
1585 if (ret) {
d14ed18c
MR
1586 goto out;
1587 }
1588 }
033d9fc2
EB
1589 offset += chunk;
1590 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
d14ed18c
MR
1591 }
1592
033d9fc2 1593 if (total_size1 != total_size2) {
f1d3cd79 1594 BlockBackend *blk_over;
d14ed18c
MR
1595 const char *filename_over;
1596
1597 qprintf(quiet, "Warning: Image size mismatch!\n");
033d9fc2 1598 if (total_size1 > total_size2) {
f1d3cd79 1599 blk_over = blk1;
d14ed18c
MR
1600 filename_over = filename1;
1601 } else {
f1d3cd79 1602 blk_over = blk2;
d14ed18c
MR
1603 filename_over = filename2;
1604 }
1605
033d9fc2
EB
1606 while (offset < progress_base) {
1607 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1608 progress_base - offset, &chunk,
1609 NULL, NULL);
d14ed18c
MR
1610 if (ret < 0) {
1611 ret = 3;
1612 error_report("Sector allocation test failed for %s",
1613 filename_over);
1614 goto out;
1615
1616 }
391cb1aa 1617 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
033d9fc2
EB
1618 chunk = MIN(chunk, IO_BUF_SIZE);
1619 ret = check_empty_sectors(blk_over, offset, chunk,
d14ed18c
MR
1620 filename_over, buf1, quiet);
1621 if (ret) {
d14ed18c
MR
1622 goto out;
1623 }
1624 }
033d9fc2
EB
1625 offset += chunk;
1626 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
d14ed18c
MR
1627 }
1628 }
1629
1630 qprintf(quiet, "Images are identical.\n");
1631 ret = 0;
1632
1633out:
d14ed18c
MR
1634 qemu_vfree(buf1);
1635 qemu_vfree(buf2);
26f54e9a 1636 blk_unref(blk2);
d14ed18c 1637out2:
26f54e9a 1638 blk_unref(blk1);
d14ed18c
MR
1639out3:
1640 qemu_progress_end();
1641 return ret;
1642}
1643
6c729dd8
EB
1644/* Convenience wrapper around qmp_block_dirty_bitmap_merge */
1645static void do_dirty_bitmap_merge(const char *dst_node, const char *dst_name,
1646 const char *src_node, const char *src_name,
1647 Error **errp)
1648{
1466ef6c
VSO
1649 BlockDirtyBitmapOrStr *merge_src;
1650 BlockDirtyBitmapOrStrList *list = NULL;
6c729dd8 1651
1466ef6c 1652 merge_src = g_new0(BlockDirtyBitmapOrStr, 1);
6c729dd8
EB
1653 merge_src->type = QTYPE_QDICT;
1654 merge_src->u.external.node = g_strdup(src_node);
1655 merge_src->u.external.name = g_strdup(src_name);
54aa3de7 1656 QAPI_LIST_PREPEND(list, merge_src);
6c729dd8 1657 qmp_block_dirty_bitmap_merge(dst_node, dst_name, list, errp);
1466ef6c 1658 qapi_free_BlockDirtyBitmapOrStrList(list);
6c729dd8
EB
1659}
1660
690c7301
KW
1661enum ImgConvertBlockStatus {
1662 BLK_DATA,
1663 BLK_ZERO,
1664 BLK_BACKING_FILE,
1665};
1666
2d9187bc 1667#define MAX_COROUTINES 16
0c8c4895 1668#define CONVERT_THROTTLE_GROUP "img_convert"
2d9187bc 1669
690c7301
KW
1670typedef struct ImgConvertState {
1671 BlockBackend **src;
1672 int64_t *src_sectors;
af8d43d3 1673 int *src_alignment;
2d9187bc 1674 int src_num;
690c7301
KW
1675 int64_t total_sectors;
1676 int64_t allocated_sectors;
2d9187bc
PL
1677 int64_t allocated_done;
1678 int64_t sector_num;
1679 int64_t wr_offs;
690c7301
KW
1680 enum ImgConvertBlockStatus status;
1681 int64_t sector_next_status;
1682 BlockBackend *target;
1683 bool has_zero_init;
1684 bool compressed;
4d7c487e 1685 bool target_is_new;
690c7301 1686 bool target_has_backing;
351c8eff 1687 int64_t target_backing_sectors; /* negative if unknown */
2d9187bc 1688 bool wr_in_order;
ee5306d0 1689 bool copy_range;
8eaac025 1690 bool salvage;
3d96cb91 1691 bool quiet;
690c7301 1692 int min_sparse;
8dcd3c9b 1693 int alignment;
690c7301
KW
1694 size_t cluster_sectors;
1695 size_t buf_sectors;
9fd77f99 1696 long num_coroutines;
2d9187bc
PL
1697 int running_coroutines;
1698 Coroutine *co[MAX_COROUTINES];
1699 int64_t wait_sector_num[MAX_COROUTINES];
1700 CoMutex lock;
1701 int ret;
690c7301
KW
1702} ImgConvertState;
1703
2d9187bc
PL
1704static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1705 int *src_cur, int64_t *src_cur_offset)
690c7301 1706{
2d9187bc
PL
1707 *src_cur = 0;
1708 *src_cur_offset = 0;
1709 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1710 *src_cur_offset += s->src_sectors[*src_cur];
1711 (*src_cur)++;
1712 assert(*src_cur < s->src_num);
690c7301
KW
1713 }
1714}
1715
ad74751f
KW
1716static int coroutine_mixed_fn GRAPH_RDLOCK
1717convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
690c7301 1718{
31826642
EB
1719 int64_t src_cur_offset;
1720 int ret, n, src_cur;
351c8eff 1721 bool post_backing_zero = false;
690c7301 1722
2d9187bc 1723 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
690c7301
KW
1724
1725 assert(s->total_sectors > sector_num);
1726 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1727
351c8eff
HR
1728 if (s->target_backing_sectors >= 0) {
1729 if (sector_num >= s->target_backing_sectors) {
2253d86e 1730 post_backing_zero = true;
351c8eff
HR
1731 } else if (sector_num + n > s->target_backing_sectors) {
1732 /* Split requests around target_backing_sectors (because
1733 * starting from there, zeros are handled differently) */
1734 n = s->target_backing_sectors - sector_num;
1735 }
1736 }
1737
690c7301 1738 if (s->sector_next_status <= sector_num) {
8eaac025
HR
1739 uint64_t offset = (sector_num - src_cur_offset) * BDRV_SECTOR_SIZE;
1740 int64_t count;
af8d43d3 1741 int tail;
4a2061e6
HR
1742 BlockDriverState *src_bs = blk_bs(s->src[src_cur]);
1743 BlockDriverState *base;
1744
1745 if (s->target_has_backing) {
1746 base = bdrv_cow_bs(bdrv_skip_filters(src_bs));
1747 } else {
1748 base = NULL;
1749 }
31826642 1750
8eaac025
HR
1751 do {
1752 count = n * BDRV_SECTOR_SIZE;
1753
4a2061e6
HR
1754 ret = bdrv_block_status_above(src_bs, base, offset, count, &count,
1755 NULL, NULL);
8eaac025
HR
1756
1757 if (ret < 0) {
1758 if (s->salvage) {
1759 if (n == 1) {
1760 if (!s->quiet) {
1761 warn_report("error while reading block status at "
1762 "offset %" PRIu64 ": %s", offset,
1763 strerror(-ret));
1764 }
1765 /* Just try to read the data, then */
1766 ret = BDRV_BLOCK_DATA;
1767 count = BDRV_SECTOR_SIZE;
1768 } else {
1769 /* Retry on a shorter range */
1770 n = DIV_ROUND_UP(n, 4);
1771 }
1772 } else {
1773 error_report("error while reading block status at offset "
1774 "%" PRIu64 ": %s", offset, strerror(-ret));
1775 return ret;
1776 }
1777 }
1778 } while (ret < 0);
237d78f8 1779
31826642 1780 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
690c7301 1781
af8d43d3
PL
1782 /*
1783 * Avoid that s->sector_next_status becomes unaligned to the source
1784 * request alignment and/or cluster size to avoid unnecessary read
1785 * cycles.
1786 */
1787 tail = (sector_num - src_cur_offset + n) % s->src_alignment[src_cur];
1788 if (n > tail) {
1789 n -= tail;
1790 }
1791
690c7301 1792 if (ret & BDRV_BLOCK_ZERO) {
351c8eff 1793 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
690c7301
KW
1794 } else if (ret & BDRV_BLOCK_DATA) {
1795 s->status = BLK_DATA;
690c7301 1796 } else {
9f1b92ad 1797 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
690c7301
KW
1798 }
1799
1800 s->sector_next_status = sector_num + n;
1801 }
1802
1803 n = MIN(n, s->sector_next_status - sector_num);
1804 if (s->status == BLK_DATA) {
1805 n = MIN(n, s->buf_sectors);
1806 }
1807
1808 /* We need to write complete clusters for compressed images, so if an
1809 * unallocated area is shorter than that, we must consider the whole
1810 * cluster allocated. */
1811 if (s->compressed) {
1812 if (n < s->cluster_sectors) {
1813 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1814 s->status = BLK_DATA;
1815 } else {
1816 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1817 }
1818 }
1819
1820 return n;
1821}
1822
2d9187bc
PL
1823static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1824 int nb_sectors, uint8_t *buf)
690c7301 1825{
8eaac025 1826 uint64_t single_read_until = 0;
2d9187bc 1827 int n, ret;
690c7301 1828
690c7301
KW
1829 assert(nb_sectors <= s->buf_sectors);
1830 while (nb_sectors > 0) {
1831 BlockBackend *blk;
2d9187bc
PL
1832 int src_cur;
1833 int64_t bs_sectors, src_cur_offset;
8eaac025 1834 uint64_t offset;
690c7301
KW
1835
1836 /* In the case of compression with multiple source files, we can get a
1837 * nb_sectors that spreads into the next part. So we must be able to
1838 * read across multiple BDSes for one convert_read() call. */
2d9187bc
PL
1839 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1840 blk = s->src[src_cur];
1841 bs_sectors = s->src_sectors[src_cur];
1842
8eaac025
HR
1843 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1844
2d9187bc 1845 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
8eaac025
HR
1846 if (single_read_until > offset) {
1847 n = 1;
1848 }
2d9187bc 1849
8eaac025 1850 ret = blk_co_pread(blk, offset, n << BDRV_SECTOR_BITS, buf, 0);
690c7301 1851 if (ret < 0) {
8eaac025
HR
1852 if (s->salvage) {
1853 if (n > 1) {
1854 single_read_until = offset + (n << BDRV_SECTOR_BITS);
1855 continue;
1856 } else {
1857 if (!s->quiet) {
1858 warn_report("error while reading offset %" PRIu64
1859 ": %s", offset, strerror(-ret));
1860 }
1861 memset(buf, 0, BDRV_SECTOR_SIZE);
1862 }
1863 } else {
1864 return ret;
1865 }
690c7301
KW
1866 }
1867
1868 sector_num += n;
1869 nb_sectors -= n;
1870 buf += n * BDRV_SECTOR_SIZE;
1871 }
1872
1873 return 0;
1874}
1875
2d9187bc
PL
1876
1877static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1878 int nb_sectors, uint8_t *buf,
1879 enum ImgConvertBlockStatus status)
690c7301
KW
1880{
1881 int ret;
1882
1883 while (nb_sectors > 0) {
1884 int n = nb_sectors;
db933fbe
LC
1885 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1886
2d9187bc 1887 switch (status) {
690c7301
KW
1888 case BLK_BACKING_FILE:
1889 /* If we have a backing file, leave clusters unallocated that are
1890 * unallocated in the source image, so that the backing file is
1891 * visible at the respective offset. */
1892 assert(s->target_has_backing);
1893 break;
1894
1895 case BLK_DATA:
db933fbe
LC
1896 /* If we're told to keep the target fully allocated (-S 0) or there
1897 * is real non-zero data, we must write it. Otherwise we can treat
1898 * it as zero sectors.
1899 * Compressed clusters need to be written as a whole, so in that
1900 * case we can only save the write if the buffer is completely
1901 * zeroed. */
690c7301 1902 if (!s->min_sparse ||
db933fbe 1903 (!s->compressed &&
8dcd3c9b
PL
1904 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1905 sector_num, s->alignment)) ||
db933fbe
LC
1906 (s->compressed &&
1907 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
690c7301 1908 {
265a7e54
VSO
1909 ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1910 n << BDRV_SECTOR_BITS, buf, flags);
690c7301
KW
1911 if (ret < 0) {
1912 return ret;
1913 }
1914 break;
1915 }
1916 /* fall-through */
1917
1918 case BLK_ZERO:
1919 if (s->has_zero_init) {
db933fbe 1920 assert(!s->target_has_backing);
690c7301
KW
1921 break;
1922 }
2d9187bc
PL
1923 ret = blk_co_pwrite_zeroes(s->target,
1924 sector_num << BDRV_SECTOR_BITS,
a3d6ae22
NS
1925 n << BDRV_SECTOR_BITS,
1926 BDRV_REQ_MAY_UNMAP);
690c7301
KW
1927 if (ret < 0) {
1928 return ret;
1929 }
1930 break;
1931 }
1932
1933 sector_num += n;
1934 nb_sectors -= n;
1935 buf += n * BDRV_SECTOR_SIZE;
1936 }
1937
1938 return 0;
1939}
1940
ee5306d0
FZ
1941static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1942 int nb_sectors)
1943{
1944 int n, ret;
1945
1946 while (nb_sectors > 0) {
1947 BlockBackend *blk;
1948 int src_cur;
1949 int64_t bs_sectors, src_cur_offset;
1950 int64_t offset;
1951
1952 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1953 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1954 blk = s->src[src_cur];
1955 bs_sectors = s->src_sectors[src_cur];
1956
1957 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1958
1959 ret = blk_co_copy_range(blk, offset, s->target,
1960 sector_num << BDRV_SECTOR_BITS,
67b51fb9 1961 n << BDRV_SECTOR_BITS, 0, 0);
ee5306d0
FZ
1962 if (ret < 0) {
1963 return ret;
1964 }
1965
1966 sector_num += n;
1967 nb_sectors -= n;
1968 }
1969 return 0;
1970}
1971
2d9187bc 1972static void coroutine_fn convert_co_do_copy(void *opaque)
690c7301 1973{
2d9187bc 1974 ImgConvertState *s = opaque;
690c7301 1975 uint8_t *buf = NULL;
2d9187bc
PL
1976 int ret, i;
1977 int index = -1;
1978
1979 for (i = 0; i < s->num_coroutines; i++) {
1980 if (s->co[i] == qemu_coroutine_self()) {
1981 index = i;
1982 break;
1983 }
1984 }
1985 assert(index >= 0);
1986
1987 s->running_coroutines++;
1988 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1989
1990 while (1) {
1991 int n;
1992 int64_t sector_num;
1993 enum ImgConvertBlockStatus status;
ee5306d0 1994 bool copy_range;
2d9187bc
PL
1995
1996 qemu_co_mutex_lock(&s->lock);
1997 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1998 qemu_co_mutex_unlock(&s->lock);
b91127ed 1999 break;
2d9187bc 2000 }
7ff9579e
KW
2001 WITH_GRAPH_RDLOCK_GUARD() {
2002 n = convert_iteration_sectors(s, s->sector_num);
2003 }
2d9187bc
PL
2004 if (n < 0) {
2005 qemu_co_mutex_unlock(&s->lock);
2006 s->ret = n;
b91127ed 2007 break;
2d9187bc
PL
2008 }
2009 /* save current sector and allocation status to local variables */
2010 sector_num = s->sector_num;
2011 status = s->status;
2012 if (!s->min_sparse && s->status == BLK_ZERO) {
2013 n = MIN(n, s->buf_sectors);
2014 }
2015 /* increment global sector counter so that other coroutines can
2016 * already continue reading beyond this request */
2017 s->sector_num += n;
2018 qemu_co_mutex_unlock(&s->lock);
2019
2020 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
2021 s->allocated_done += n;
2022 qemu_progress_print(100.0 * s->allocated_done /
2023 s->allocated_sectors, 0);
2024 }
2025
ee5306d0
FZ
2026retry:
2027 copy_range = s->copy_range && s->status == BLK_DATA;
2028 if (status == BLK_DATA && !copy_range) {
2d9187bc
PL
2029 ret = convert_co_read(s, sector_num, n, buf);
2030 if (ret < 0) {
39f77cb6
EB
2031 error_report("error while reading at byte %lld: %s",
2032 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
2d9187bc 2033 s->ret = ret;
2d9187bc
PL
2034 }
2035 } else if (!s->min_sparse && status == BLK_ZERO) {
2036 status = BLK_DATA;
2037 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
2038 }
2039
2040 if (s->wr_in_order) {
2041 /* keep writes in order */
b91127ed 2042 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
2d9187bc
PL
2043 s->wait_sector_num[index] = sector_num;
2044 qemu_coroutine_yield();
2045 }
2046 s->wait_sector_num[index] = -1;
2047 }
2048
b91127ed 2049 if (s->ret == -EINPROGRESS) {
ee5306d0 2050 if (copy_range) {
742bf09b
EGE
2051 WITH_GRAPH_RDLOCK_GUARD() {
2052 ret = convert_co_copy_range(s, sector_num, n);
2053 }
ee5306d0
FZ
2054 if (ret) {
2055 s->copy_range = false;
2056 goto retry;
2057 }
2058 } else {
2059 ret = convert_co_write(s, sector_num, n, buf, status);
2060 }
b91127ed 2061 if (ret < 0) {
39f77cb6
EB
2062 error_report("error while writing at byte %lld: %s",
2063 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
b91127ed
AN
2064 s->ret = ret;
2065 }
2d9187bc
PL
2066 }
2067
2068 if (s->wr_in_order) {
2069 /* reenter the coroutine that might have waited
2070 * for this write to complete */
2071 s->wr_offs = sector_num + n;
2072 for (i = 0; i < s->num_coroutines; i++) {
2073 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
2074 /*
2075 * A -> B -> A cannot occur because A has
2076 * s->wait_sector_num[i] == -1 during A -> B. Therefore
2077 * B will never enter A during this time window.
2078 */
2079 qemu_coroutine_enter(s->co[i]);
2080 break;
2081 }
2082 }
2083 }
2084 }
2085
2d9187bc
PL
2086 qemu_vfree(buf);
2087 s->co[index] = NULL;
2088 s->running_coroutines--;
2089 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
2090 /* the convert job finished successfully */
2091 s->ret = 0;
2092 }
2093}
2094
2095static int convert_do_copy(ImgConvertState *s)
2096{
2097 int ret, i, n;
2098 int64_t sector_num = 0;
690c7301
KW
2099
2100 /* Check whether we have zero initialisation or can get it efficiently */
168468fe
DE
2101 if (!s->has_zero_init && s->target_is_new && s->min_sparse &&
2102 !s->target_has_backing) {
06717986 2103 bdrv_graph_rdlock_main_loop();
4d7c487e 2104 s->has_zero_init = bdrv_has_zero_init(blk_bs(s->target));
06717986 2105 bdrv_graph_rdunlock_main_loop();
4d7c487e 2106 }
690c7301 2107
690c7301
KW
2108 /* Allocate buffer for copied data. For compressed images, only one cluster
2109 * can be copied at a time. */
2110 if (s->compressed) {
2111 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
2112 error_report("invalid cluster size");
2d9187bc 2113 return -EINVAL;
690c7301
KW
2114 }
2115 s->buf_sectors = s->cluster_sectors;
2116 }
690c7301 2117
690c7301 2118 while (sector_num < s->total_sectors) {
ad74751f 2119 bdrv_graph_rdlock_main_loop();
690c7301 2120 n = convert_iteration_sectors(s, sector_num);
ad74751f 2121 bdrv_graph_rdunlock_main_loop();
690c7301 2122 if (n < 0) {
2d9187bc 2123 return n;
690c7301 2124 }
aad15de4
HR
2125 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
2126 {
690c7301
KW
2127 s->allocated_sectors += n;
2128 }
2129 sector_num += n;
2130 }
2131
2132 /* Do the copy */
690c7301 2133 s->sector_next_status = 0;
2d9187bc 2134 s->ret = -EINPROGRESS;
690c7301 2135
2d9187bc
PL
2136 qemu_co_mutex_init(&s->lock);
2137 for (i = 0; i < s->num_coroutines; i++) {
2138 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
2139 s->wait_sector_num[i] = -1;
2140 qemu_coroutine_enter(s->co[i]);
2141 }
690c7301 2142
b91127ed 2143 while (s->running_coroutines) {
2d9187bc 2144 main_loop_wait(false);
690c7301
KW
2145 }
2146
2d9187bc 2147 if (s->compressed && !s->ret) {
690c7301 2148 /* signal EOF to align */
0cadf2c8 2149 ret = blk_pwrite_compressed(s->target, 0, 0, NULL);
690c7301 2150 if (ret < 0) {
2d9187bc 2151 return ret;
690c7301
KW
2152 }
2153 }
2154
2d9187bc 2155 return s->ret;
690c7301
KW
2156}
2157
74a4320f 2158/* Check that bitmaps can be copied, or output an error */
955171e4 2159static int convert_check_bitmaps(BlockDriverState *src, bool skip_broken)
74a4320f
EB
2160{
2161 BdrvDirtyBitmap *bm;
2162
2163 if (!bdrv_supports_persistent_dirty_bitmap(src)) {
2164 error_report("Source lacks bitmap support");
2165 return -1;
2166 }
2167 FOR_EACH_DIRTY_BITMAP(src, bm) {
2168 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2169 continue;
2170 }
955171e4 2171 if (!skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) {
74a4320f
EB
2172 error_report("Cannot copy inconsistent bitmap '%s'",
2173 bdrv_dirty_bitmap_name(bm));
955171e4
EB
2174 error_printf("Try --skip-broken-bitmaps, or "
2175 "use 'qemu-img bitmap --remove' to delete it\n");
74a4320f
EB
2176 return -1;
2177 }
2178 }
2179 return 0;
2180}
2181
955171e4
EB
2182static int convert_copy_bitmaps(BlockDriverState *src, BlockDriverState *dst,
2183 bool skip_broken)
15e39ad9
EB
2184{
2185 BdrvDirtyBitmap *bm;
2186 Error *err = NULL;
2187
2188 FOR_EACH_DIRTY_BITMAP(src, bm) {
2189 const char *name;
2190
2191 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2192 continue;
2193 }
2194 name = bdrv_dirty_bitmap_name(bm);
955171e4
EB
2195 if (skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) {
2196 warn_report("Skipping inconsistent bitmap '%s'", name);
2197 continue;
2198 }
15e39ad9
EB
2199 qmp_block_dirty_bitmap_add(dst->node_name, name,
2200 true, bdrv_dirty_bitmap_granularity(bm),
2201 true, true,
2202 true, !bdrv_dirty_bitmap_enabled(bm),
2203 &err);
2204 if (err) {
2205 error_reportf_err(err, "Failed to create bitmap %s: ", name);
2206 return -1;
2207 }
2208
2209 do_dirty_bitmap_merge(dst->node_name, name, src->node_name, name,
2210 &err);
2211 if (err) {
2212 error_reportf_err(err, "Failed to populate bitmap %s: ", name);
74a4320f 2213 qmp_block_dirty_bitmap_remove(dst->node_name, name, NULL);
15e39ad9
EB
2214 return -1;
2215 }
2216 }
2217
2218 return 0;
2219}
2220
6360ab27
PL
2221#define MAX_BUF_SECTORS 32768
2222
0c8c4895
ZL
2223static void set_rate_limit(BlockBackend *blk, int64_t rate_limit)
2224{
2225 ThrottleConfig cfg;
2226
2227 throttle_config_init(&cfg);
2228 cfg.buckets[THROTTLE_BPS_WRITE].avg = rate_limit;
2229
2230 blk_io_limits_enable(blk, CONVERT_THROTTLE_GROUP);
2231 blk_set_io_limits(blk, &cfg);
2232}
2233
ea2384d3
FB
2234static int img_convert(int argc, char **argv)
2235{
0b8fb55c 2236 int c, bs_i, flags, src_flags = BDRV_O_NO_SHARE;
305b4c60 2237 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
9fd77f99 2238 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
1899bf47
EB
2239 *out_filename, *out_baseimg_param, *snapshot_name = NULL,
2240 *backing_fmt = NULL;
305b4c60 2241 BlockDriver *drv = NULL, *proto_drv = NULL;
faea38e7 2242 BlockDriverInfo bdi;
9fd77f99
PL
2243 BlockDriverState *out_bs;
2244 QemuOpts *opts = NULL, *sn_opts = NULL;
83d0521a 2245 QemuOptsList *create_opts = NULL;
8d65a3cc 2246 QDict *open_opts = NULL;
efa84d43 2247 char *options = NULL;
cc84d90f 2248 Error *local_err = NULL;
3d96cb91 2249 bool writethrough, src_writethrough, image_opts = false,
305b4c60 2250 skip_create = false, progress = false, tgt_image_opts = false;
9fd77f99 2251 int64_t ret = -EINVAL;
335e9937 2252 bool force_share = false;
e11ce12f 2253 bool explict_min_sparse = false;
15e39ad9 2254 bool bitmaps = false;
955171e4 2255 bool skip_broken = false;
0c8c4895 2256 int64_t rate_limit = 0;
9fd77f99
PL
2257
2258 ImgConvertState s = (ImgConvertState) {
2259 /* Need at least 4k of zeros for sparse detection */
2260 .min_sparse = 8,
e11ce12f 2261 .copy_range = false,
9fd77f99
PL
2262 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2263 .wr_in_order = true,
2264 .num_coroutines = 8,
2265 };
ea2384d3 2266
ea2384d3 2267 for(;;) {
3babeb15
DB
2268 static const struct option long_options[] = {
2269 {"help", no_argument, 0, 'h'},
2270 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 2271 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 2272 {"force-share", no_argument, 0, 'U'},
305b4c60 2273 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
8eaac025 2274 {"salvage", no_argument, 0, OPTION_SALVAGE},
168468fe 2275 {"target-is-zero", no_argument, 0, OPTION_TARGET_IS_ZERO},
15e39ad9 2276 {"bitmaps", no_argument, 0, OPTION_BITMAPS},
955171e4 2277 {"skip-broken-bitmaps", no_argument, 0, OPTION_SKIP_BROKEN},
3babeb15
DB
2278 {0, 0, 0, 0}
2279 };
1899bf47 2280 c = getopt_long(argc, argv, ":hf:O:B:CcF:o:l:S:pt:T:qnm:WUr:",
3babeb15 2281 long_options, NULL);
b8fb60da 2282 if (c == -1) {
ea2384d3 2283 break;
b8fb60da 2284 }
ea2384d3 2285 switch(c) {
c9192973
SH
2286 case ':':
2287 missing_argument(argv[optind - 1]);
2288 break;
ef87394c 2289 case '?':
c9192973
SH
2290 unrecognized_option(argv[optind - 1]);
2291 break;
ea2384d3
FB
2292 case 'h':
2293 help();
2294 break;
2295 case 'f':
2296 fmt = optarg;
2297 break;
2298 case 'O':
2299 out_fmt = optarg;
2300 break;
f58c7b35
TS
2301 case 'B':
2302 out_baseimg = optarg;
2303 break;
e11ce12f
FZ
2304 case 'C':
2305 s.copy_range = true;
2306 break;
ea2384d3 2307 case 'c':
9fd77f99 2308 s.compressed = true;
ea2384d3 2309 break;
1899bf47
EB
2310 case 'F':
2311 backing_fmt = optarg;
2312 break;
efa84d43 2313 case 'o':
6d2b5cba 2314 if (accumulate_options(&options, optarg) < 0) {
64bb01aa 2315 goto fail_getopt;
2dc8328b 2316 }
efa84d43 2317 break;
ef80654d
WX
2318 case 'l':
2319 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
70b94331
MA
2320 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2321 optarg, false);
ef80654d
WX
2322 if (!sn_opts) {
2323 error_report("Failed in parsing snapshot param '%s'",
2324 optarg);
64bb01aa 2325 goto fail_getopt;
ef80654d
WX
2326 }
2327 } else {
2328 snapshot_name = optarg;
2329 }
2330 break;
a22f123c
KW
2331 case 'S':
2332 {
2333 int64_t sval;
606caa0a 2334
43d589b0
EM
2335 sval = cvtnum("buffer size for sparse output", optarg);
2336 if (sval < 0) {
2337 goto fail_getopt;
2338 } else if (!QEMU_IS_ALIGNED(sval, BDRV_SECTOR_SIZE) ||
6360ab27
PL
2339 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2340 error_report("Invalid buffer size for sparse output specified. "
2341 "Valid sizes are multiples of %llu up to %llu. Select "
2342 "0 to disable sparse detection (fully allocates output).",
2343 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
64bb01aa 2344 goto fail_getopt;
a22f123c
KW
2345 }
2346
9fd77f99 2347 s.min_sparse = sval / BDRV_SECTOR_SIZE;
e11ce12f 2348 explict_min_sparse = true;
a22f123c
KW
2349 break;
2350 }
6b837bc4 2351 case 'p':
9fd77f99 2352 progress = true;
6b837bc4 2353 break;
661a0f71
FS
2354 case 't':
2355 cache = optarg;
2356 break;
40055951
HR
2357 case 'T':
2358 src_cache = optarg;
2359 break;
f382d43a 2360 case 'q':
3d96cb91 2361 s.quiet = true;
f382d43a 2362 break;
b2e10493 2363 case 'n':
9fd77f99 2364 skip_create = true;
b2e10493 2365 break;
2d9187bc 2366 case 'm':
9fd77f99
PL
2367 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2368 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
2d9187bc
PL
2369 error_report("Invalid number of coroutines. Allowed number of"
2370 " coroutines is between 1 and %d", MAX_COROUTINES);
2d9187bc
PL
2371 goto fail_getopt;
2372 }
2373 break;
2374 case 'W':
9fd77f99 2375 s.wr_in_order = false;
2d9187bc 2376 break;
335e9937
FZ
2377 case 'U':
2378 force_share = true;
2379 break;
0c8c4895
ZL
2380 case 'r':
2381 rate_limit = cvtnum("rate limit", optarg);
2382 if (rate_limit < 0) {
2383 goto fail_getopt;
2384 }
2385 break;
99b1e646
KW
2386 case OPTION_OBJECT:
2387 user_creatable_process_cmdline(optarg);
3babeb15 2388 break;
eb769f74
DB
2389 case OPTION_IMAGE_OPTS:
2390 image_opts = true;
2391 break;
8eaac025
HR
2392 case OPTION_SALVAGE:
2393 s.salvage = true;
2394 break;
305b4c60
DB
2395 case OPTION_TARGET_IMAGE_OPTS:
2396 tgt_image_opts = true;
2397 break;
168468fe
DE
2398 case OPTION_TARGET_IS_ZERO:
2399 /*
2400 * The user asserting that the target is blank has the
2401 * same effect as the target driver supporting zero
2402 * initialisation.
2403 */
2404 s.has_zero_init = true;
2405 break;
15e39ad9
EB
2406 case OPTION_BITMAPS:
2407 bitmaps = true;
2408 break;
955171e4
EB
2409 case OPTION_SKIP_BROKEN:
2410 skip_broken = true;
2411 break;
ea2384d3
FB
2412 }
2413 }
3b46e624 2414
305b4c60
DB
2415 if (!out_fmt && !tgt_image_opts) {
2416 out_fmt = "raw";
2417 }
2418
955171e4
EB
2419 if (skip_broken && !bitmaps) {
2420 error_report("Use of --skip-broken-bitmaps requires --bitmaps");
2421 goto fail_getopt;
2422 }
2423
e11ce12f
FZ
2424 if (s.compressed && s.copy_range) {
2425 error_report("Cannot enable copy offloading when -c is used");
2426 goto fail_getopt;
2427 }
2428
2429 if (explict_min_sparse && s.copy_range) {
2430 error_report("Cannot enable copy offloading when -S is used");
2431 goto fail_getopt;
2432 }
2433
8eaac025
HR
2434 if (s.copy_range && s.salvage) {
2435 error_report("Cannot use copy offloading in salvaging mode");
2436 goto fail_getopt;
2437 }
2438
305b4c60
DB
2439 if (tgt_image_opts && !skip_create) {
2440 error_report("--target-image-opts requires use of -n flag");
2441 goto fail_getopt;
2442 }
2443
ffd8e8ff 2444 if (skip_create && options) {
25956af3
EB
2445 error_report("-o has no effect when skipping image creation");
2446 goto fail_getopt;
ffd8e8ff
KW
2447 }
2448
168468fe
DE
2449 if (s.has_zero_init && !skip_create) {
2450 error_report("--target-is-zero requires use of -n flag");
2451 goto fail_getopt;
2452 }
2453
9fd77f99
PL
2454 s.src_num = argc - optind - 1;
2455 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
f58c7b35 2456
2dc8328b 2457 if (options && has_help_option(options)) {
305b4c60
DB
2458 if (out_fmt) {
2459 ret = print_block_option_help(out_filename, out_fmt);
2460 goto fail_getopt;
2461 } else {
2462 error_report("Option help requires a format be specified");
2463 goto fail_getopt;
2464 }
4ac8aacd
JS
2465 }
2466
9fd77f99
PL
2467 if (s.src_num < 1) {
2468 error_report("Must specify image file name");
2469 goto fail_getopt;
a283cb6e
KW
2470 }
2471
9fd77f99 2472 /* ret is still -EINVAL until here */
ce099547 2473 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
40055951
HR
2474 if (ret < 0) {
2475 error_report("Invalid source cache option: %s", src_cache);
9fd77f99 2476 goto fail_getopt;
40055951
HR
2477 }
2478
9fd77f99 2479 /* Initialize before goto out */
3d96cb91 2480 if (s.quiet) {
9fd77f99
PL
2481 progress = false;
2482 }
2483 qemu_progress_init(progress, 1.0);
6b837bc4
JS
2484 qemu_progress_print(0, 100);
2485
9fd77f99
PL
2486 s.src = g_new0(BlockBackend *, s.src_num);
2487 s.src_sectors = g_new(int64_t, s.src_num);
af8d43d3 2488 s.src_alignment = g_new(int, s.src_num);
926c2d23 2489
9fd77f99 2490 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
af8d43d3 2491 BlockDriverState *src_bs;
9fd77f99 2492 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
3d96cb91 2493 fmt, src_flags, src_writethrough, s.quiet,
335e9937 2494 force_share);
9fd77f99 2495 if (!s.src[bs_i]) {
c2abccec
MK
2496 ret = -1;
2497 goto out;
2498 }
9fd77f99
PL
2499 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2500 if (s.src_sectors[bs_i] < 0) {
52bf1e72 2501 error_report("Could not get size of %s: %s",
9fd77f99 2502 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
52bf1e72
MA
2503 ret = -1;
2504 goto out;
2505 }
af8d43d3
PL
2506 src_bs = blk_bs(s.src[bs_i]);
2507 s.src_alignment[bs_i] = DIV_ROUND_UP(src_bs->bl.request_alignment,
2508 BDRV_SECTOR_SIZE);
2509 if (!bdrv_get_info(src_bs, &bdi)) {
2510 s.src_alignment[bs_i] = MAX(s.src_alignment[bs_i],
2511 bdi.cluster_size / BDRV_SECTOR_SIZE);
2512 }
9fd77f99 2513 s.total_sectors += s.src_sectors[bs_i];
926c2d23 2514 }
ea2384d3 2515
ef80654d 2516 if (sn_opts) {
9fd77f99 2517 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
10d6eda1
PM
2518 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2519 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2520 &local_err);
ef80654d 2521 } else if (snapshot_name != NULL) {
9fd77f99 2522 if (s.src_num > 1) {
6daf194d 2523 error_report("No support for concatenating multiple snapshot");
51ef6727 2524 ret = -1;
2525 goto out;
2526 }
7b4c4781 2527
9fd77f99
PL
2528 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2529 &local_err);
ef80654d 2530 }
84d18f06 2531 if (local_err) {
c29b77f9 2532 error_reportf_err(local_err, "Failed to load snapshot: ");
ef80654d
WX
2533 ret = -1;
2534 goto out;
51ef6727 2535 }
2536
305b4c60
DB
2537 if (!skip_create) {
2538 /* Find driver and parse its options */
2539 drv = bdrv_find_format(out_fmt);
2540 if (!drv) {
2541 error_report("Unknown file format '%s'", out_fmt);
2542 ret = -1;
2543 goto out;
2544 }
efa84d43 2545
305b4c60
DB
2546 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2547 if (!proto_drv) {
2548 error_report_err(local_err);
2549 ret = -1;
2550 goto out;
2551 }
b50cbabc 2552
2e024cde
HR
2553 if (!drv->create_opts) {
2554 error_report("Format driver '%s' does not support image creation",
2555 drv->format_name);
2556 ret = -1;
2557 goto out;
2558 }
f75613cf 2559
2e024cde
HR
2560 if (!proto_drv->create_opts) {
2561 error_report("Protocol driver '%s' does not support image creation",
2562 proto_drv->format_name);
2563 ret = -1;
2564 goto out;
2565 }
f75613cf 2566
2e024cde
HR
2567 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2568 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
db08adf5 2569
2e024cde 2570 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
dc523cd3 2571 if (options) {
235e59cf 2572 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
97a2ca7a 2573 error_report_err(local_err);
dc523cd3
MA
2574 ret = -1;
2575 goto out;
2576 }
2e024cde 2577 }
efa84d43 2578
c075c42f
YL
2579 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
2580 s.total_sectors * BDRV_SECTOR_SIZE, &error_abort);
1899bf47 2581 ret = add_old_style_options(out_fmt, opts, out_baseimg, backing_fmt);
2e024cde
HR
2582 if (ret < 0) {
2583 goto out;
2584 }
c2abccec 2585 }
efa84d43 2586
a18953fb 2587 /* Get backing file name if -o backing_file was used */
83d0521a 2588 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
a18953fb 2589 if (out_baseimg_param) {
83d0521a 2590 out_baseimg = out_baseimg_param;
a18953fb 2591 }
9fd77f99 2592 s.target_has_backing = (bool) out_baseimg;
a18953fb 2593
168468fe
DE
2594 if (s.has_zero_init && s.target_has_backing) {
2595 error_report("Cannot use --target-is-zero when the destination "
2596 "image has a backing file");
2597 goto out;
2598 }
2599
48758a84
HR
2600 if (s.src_num > 1 && out_baseimg) {
2601 error_report("Having a backing file for the target makes no sense when "
2602 "concatenating multiple input images");
2603 ret = -1;
2604 goto out;
2605 }
2606
d9f059aa
EB
2607 if (out_baseimg_param) {
2608 if (!qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT)) {
497a30db
EB
2609 error_report("Use of backing file requires explicit "
2610 "backing format");
2611 ret = -1;
2612 goto out;
d9f059aa
EB
2613 }
2614 }
2615
efa84d43 2616 /* Check if compression is supported */
9fd77f99 2617 if (s.compressed) {
83d0521a
CL
2618 bool encryption =
2619 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
0cb8d47b
DB
2620 const char *encryptfmt =
2621 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
83d0521a
CL
2622 const char *preallocation =
2623 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
efa84d43 2624
ac850bf0 2625 if (drv && !block_driver_can_compress(drv)) {
15654a6d 2626 error_report("Compression not supported for this file format");
c2abccec
MK
2627 ret = -1;
2628 goto out;
efa84d43
KW
2629 }
2630
0cb8d47b 2631 if (encryption || encryptfmt) {
15654a6d
JS
2632 error_report("Compression and encryption not supported at "
2633 "the same time");
c2abccec
MK
2634 ret = -1;
2635 goto out;
efa84d43 2636 }
41521fa4 2637
83d0521a
CL
2638 if (preallocation
2639 && strcmp(preallocation, "off"))
41521fa4
KW
2640 {
2641 error_report("Compression and preallocation not supported at "
2642 "the same time");
2643 ret = -1;
2644 goto out;
2645 }
efa84d43
KW
2646 }
2647
15e39ad9
EB
2648 /* Determine if bitmaps need copying */
2649 if (bitmaps) {
2650 if (s.src_num > 1) {
2651 error_report("Copying bitmaps only possible with single source");
2652 ret = -1;
2653 goto out;
2654 }
955171e4 2655 ret = convert_check_bitmaps(blk_bs(s.src[0]), skip_broken);
74a4320f 2656 if (ret < 0) {
15e39ad9
EB
2657 goto out;
2658 }
2659 }
2660
8d65a3cc
DB
2661 /*
2662 * The later open call will need any decryption secrets, and
2663 * bdrv_create() will purge "opts", so extract them now before
2664 * they are lost.
2665 */
2666 if (!skip_create) {
2667 open_opts = qdict_new();
2668 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
8d65a3cc 2669
b2e10493 2670 /* Create the new image */
c282e1fd 2671 ret = bdrv_create(drv, out_filename, opts, &local_err);
b2e10493 2672 if (ret < 0) {
c29b77f9
MA
2673 error_reportf_err(local_err, "%s: error while converting %s: ",
2674 out_filename, out_fmt);
b2e10493 2675 goto out;
ea2384d3
FB
2676 }
2677 }
3b46e624 2678
4d7c487e
HR
2679 s.target_is_new = !skip_create;
2680
9fd77f99 2681 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
ce099547 2682 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
661a0f71
FS
2683 if (ret < 0) {
2684 error_report("Invalid cache option: %s", cache);
bb9cd2ee 2685 goto out;
661a0f71
FS
2686 }
2687
a1c62436
HR
2688 if (flags & BDRV_O_NOCACHE) {
2689 /*
2690 * If we open the target with O_DIRECT, it may be necessary to
2691 * extend its size to align to the physical sector size.
2692 */
2693 flags |= BDRV_O_RESIZE;
2694 }
2695
305b4c60
DB
2696 if (skip_create) {
2697 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
3d96cb91 2698 flags, writethrough, s.quiet, false);
305b4c60
DB
2699 } else {
2700 /* TODO ultimately we should allow --target-image-opts
2701 * to be used even when -n is not given.
2702 * That has to wait for bdrv_create to be improved
2703 * to allow filenames in option syntax
2704 */
8d65a3cc 2705 s.target = img_open_file(out_filename, open_opts, out_fmt,
3d96cb91 2706 flags, writethrough, s.quiet, false);
8d65a3cc 2707 open_opts = NULL; /* blk_new_open will have freed it */
305b4c60 2708 }
9fd77f99 2709 if (!s.target) {
c2abccec
MK
2710 ret = -1;
2711 goto out;
2712 }
9fd77f99 2713 out_bs = blk_bs(s.target);
ea2384d3 2714
15e39ad9
EB
2715 if (bitmaps && !bdrv_supports_persistent_dirty_bitmap(out_bs)) {
2716 error_report("Format driver '%s' does not support bitmaps",
2717 out_bs->drv->format_name);
2718 ret = -1;
2719 goto out;
2720 }
2721
ac850bf0 2722 if (s.compressed && !block_driver_can_compress(out_bs->drv)) {
305b4c60
DB
2723 error_report("Compression not supported for this file format");
2724 ret = -1;
2725 goto out;
2726 }
2727
5def6b80 2728 /* increase bufsectors from the default 4096 (2M) if opt_transfer
6360ab27
PL
2729 * or discard_alignment of the out_bs is greater. Limit to
2730 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2731 s.buf_sectors = MIN(MAX_BUF_SECTORS,
9fd77f99
PL
2732 MAX(s.buf_sectors,
2733 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2734 out_bs->bl.pdiscard_alignment >>
2735 BDRV_SECTOR_BITS)));
f2521c90 2736
8dcd3c9b
PL
2737 /* try to align the write requests to the destination to avoid unnecessary
2738 * RMW cycles. */
2739 s.alignment = MAX(pow2floor(s.min_sparse),
2740 DIV_ROUND_UP(out_bs->bl.request_alignment,
2741 BDRV_SECTOR_SIZE));
2742 assert(is_power_of_2(s.alignment));
2743
b2e10493 2744 if (skip_create) {
9fd77f99 2745 int64_t output_sectors = blk_nb_sectors(s.target);
43716fa8 2746 if (output_sectors < 0) {
eec5eb42 2747 error_report("unable to get output image length: %s",
43716fa8 2748 strerror(-output_sectors));
b2e10493
AD
2749 ret = -1;
2750 goto out;
9fd77f99 2751 } else if (output_sectors < s.total_sectors) {
b2e10493
AD
2752 error_report("output file is smaller than input file");
2753 ret = -1;
2754 goto out;
2755 }
2756 }
2757
c69291e7 2758 if (s.target_has_backing && s.target_is_new) {
351c8eff
HR
2759 /* Errors are treated as "backing length unknown" (which means
2760 * s.target_backing_sectors has to be negative, which it will
2761 * be automatically). The backing file length is used only
2762 * for optimizations, so such a case is not fatal. */
ad74751f 2763 bdrv_graph_rdlock_main_loop();
4a2061e6
HR
2764 s.target_backing_sectors =
2765 bdrv_nb_sectors(bdrv_backing_chain_next(out_bs));
ad74751f 2766 bdrv_graph_rdunlock_main_loop();
351c8eff
HR
2767 } else {
2768 s.target_backing_sectors = -1;
2769 }
2770
24f833cd
PL
2771 ret = bdrv_get_info(out_bs, &bdi);
2772 if (ret < 0) {
9fd77f99 2773 if (s.compressed) {
15654a6d 2774 error_report("could not get block driver info");
c2abccec
MK
2775 goto out;
2776 }
24f833cd 2777 } else {
9fd77f99
PL
2778 s.compressed = s.compressed || bdi.needs_compressed_writes;
2779 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2780 }
802c3d4c 2781
0c8c4895
ZL
2782 if (rate_limit) {
2783 set_rate_limit(s.target, rate_limit);
2784 }
2785
9fd77f99 2786 ret = convert_do_copy(&s);
15e39ad9
EB
2787
2788 /* Now copy the bitmaps */
2789 if (bitmaps && ret == 0) {
955171e4 2790 ret = convert_copy_bitmaps(blk_bs(s.src[0]), out_bs, skip_broken);
15e39ad9
EB
2791 }
2792
c2abccec 2793out:
13c28af8
PL
2794 if (!ret) {
2795 qemu_progress_print(100, 0);
2796 }
6b837bc4 2797 qemu_progress_end();
83d0521a
CL
2798 qemu_opts_del(opts);
2799 qemu_opts_free(create_opts);
8d65a3cc 2800 qobject_unref(open_opts);
9fd77f99
PL
2801 blk_unref(s.target);
2802 if (s.src) {
2803 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2804 blk_unref(s.src[bs_i]);
26f54e9a 2805 }
9fd77f99 2806 g_free(s.src);
26f54e9a 2807 }
9fd77f99 2808 g_free(s.src_sectors);
af8d43d3 2809 g_free(s.src_alignment);
64bb01aa 2810fail_getopt:
6aec830e 2811 qemu_opts_del(sn_opts);
64bb01aa
KW
2812 g_free(options);
2813
9fd77f99 2814 return !!ret;
ea2384d3
FB
2815}
2816
57d1a2b6 2817
faea38e7
FB
2818static void dump_snapshots(BlockDriverState *bs)
2819{
2820 QEMUSnapshotInfo *sn_tab, *sn;
2821 int nb_sns, i;
faea38e7
FB
2822
2823 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2824 if (nb_sns <= 0)
2825 return;
2826 printf("Snapshot list:\n");
e1ce7d74 2827 bdrv_snapshot_dump(NULL);
5b917044 2828 printf("\n");
faea38e7
FB
2829 for(i = 0; i < nb_sns; i++) {
2830 sn = &sn_tab[i];
e1ce7d74 2831 bdrv_snapshot_dump(sn);
5b917044 2832 printf("\n");
faea38e7 2833 }
7267c094 2834 g_free(sn_tab);
faea38e7
FB
2835}
2836
c04d0ab0 2837static void dump_json_block_graph_info_list(BlockGraphInfoList *list)
9699bf0d 2838{
eab3a467 2839 GString *str;
9699bf0d 2840 QObject *obj;
7d5e199a 2841 Visitor *v = qobject_output_visitor_new(&obj);
3b098d56 2842
c04d0ab0 2843 visit_type_BlockGraphInfoList(v, NULL, &list, &error_abort);
3b098d56 2844 visit_complete(v, &obj);
6589f459 2845 str = qobject_to_json_pretty(obj, true);
9699bf0d 2846 assert(str != NULL);
eab3a467 2847 printf("%s\n", str->str);
cb3e7f08 2848 qobject_unref(obj);
3b098d56 2849 visit_free(v);
eab3a467 2850 g_string_free(str, true);
9699bf0d
SH
2851}
2852
c04d0ab0 2853static void dump_json_block_graph_info(BlockGraphInfo *info)
c054b3fd 2854{
eab3a467 2855 GString *str;
c054b3fd 2856 QObject *obj;
7d5e199a 2857 Visitor *v = qobject_output_visitor_new(&obj);
3b098d56 2858
c04d0ab0 2859 visit_type_BlockGraphInfo(v, NULL, &info, &error_abort);
3b098d56 2860 visit_complete(v, &obj);
6589f459 2861 str = qobject_to_json_pretty(obj, true);
c054b3fd 2862 assert(str != NULL);
eab3a467 2863 printf("%s\n", str->str);
cb3e7f08 2864 qobject_unref(obj);
3b098d56 2865 visit_free(v);
eab3a467 2866 g_string_free(str, true);
c054b3fd
BC
2867}
2868
c04d0ab0
HR
2869static void dump_human_image_info(BlockGraphInfo *info, int indentation,
2870 const char *path)
9699bf0d 2871{
c04d0ab0
HR
2872 BlockChildInfoList *children_list;
2873
d570177b
HR
2874 bdrv_node_info_dump(qapi_BlockGraphInfo_base(info), indentation,
2875 info->children == NULL);
c04d0ab0
HR
2876
2877 for (children_list = info->children; children_list;
2878 children_list = children_list->next)
2879 {
2880 BlockChildInfo *child = children_list->value;
2881 g_autofree char *child_path = NULL;
2882
2883 printf("%*sChild node '%s%s':\n",
2884 indentation * 4, "", path, child->name);
2885 child_path = g_strdup_printf("%s%s/", path, child->name);
2886 dump_human_image_info(child->info, indentation + 1, child_path);
2887 }
2888}
2889
2890static void dump_human_image_info_list(BlockGraphInfoList *list)
2891{
2892 BlockGraphInfoList *elem;
9699bf0d
SH
2893 bool delim = false;
2894
2895 for (elem = list; elem; elem = elem->next) {
2896 if (delim) {
2897 printf("\n");
2898 }
2899 delim = true;
2900
c04d0ab0 2901 dump_human_image_info(elem->value, 0, "/");
9699bf0d
SH
2902 }
2903}
2904
2905static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2906{
2907 return strcmp(a, b) == 0;
2908}
2909
2910/**
c04d0ab0 2911 * Open an image file chain and return an BlockGraphInfoList
9699bf0d
SH
2912 *
2913 * @filename: topmost image filename
2914 * @fmt: topmost image format (may be NULL to autodetect)
2915 * @chain: true - enumerate entire backing file chain
2916 * false - only topmost image file
2917 *
b1f4cd15
HR
2918 * Returns a list of BlockNodeInfo objects or NULL if there was an error
2919 * opening an image file. If there was an error a message will have been
2920 * printed to stderr.
9699bf0d 2921 */
c04d0ab0
HR
2922static BlockGraphInfoList *collect_image_info_list(bool image_opts,
2923 const char *filename,
2924 const char *fmt,
2925 bool chain, bool force_share)
9699bf0d 2926{
c04d0ab0
HR
2927 BlockGraphInfoList *head = NULL;
2928 BlockGraphInfoList **tail = &head;
9699bf0d 2929 GHashTable *filenames;
43526ec8 2930 Error *err = NULL;
9699bf0d
SH
2931
2932 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2933
2934 while (filename) {
26f54e9a 2935 BlockBackend *blk;
9699bf0d 2936 BlockDriverState *bs;
c04d0ab0 2937 BlockGraphInfo *info;
9699bf0d
SH
2938
2939 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2940 error_report("Backing file '%s' creates an infinite loop.",
2941 filename);
2942 goto err;
2943 }
2944 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2945
efaa7c4e 2946 blk = img_open(image_opts, filename, fmt,
335e9937
FZ
2947 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2948 force_share);
7e7d56d9 2949 if (!blk) {
9699bf0d
SH
2950 goto err;
2951 }
7e7d56d9 2952 bs = blk_bs(blk);
9699bf0d 2953
c04d0ab0
HR
2954 /*
2955 * Note that the returned BlockGraphInfo object will not have
2956 * information about this image's backing node, because we have opened
2957 * it with BDRV_O_NO_BACKING. Printing this object will therefore not
2958 * duplicate the backing chain information that we obtain by walking
2959 * the chain manually here.
2960 */
3db0c8b2 2961 bdrv_graph_rdlock_main_loop();
c04d0ab0 2962 bdrv_query_block_graph_info(bs, &info, &err);
3db0c8b2
KW
2963 bdrv_graph_rdunlock_main_loop();
2964
84d18f06 2965 if (err) {
565f65d2 2966 error_report_err(err);
26f54e9a 2967 blk_unref(blk);
43526ec8 2968 goto err;
fb0ed453 2969 }
9699bf0d 2970
c3033fd3 2971 QAPI_LIST_APPEND(tail, info);
9699bf0d 2972
26f54e9a 2973 blk_unref(blk);
9699bf0d 2974
0da7d13a 2975 /* Clear parameters that only apply to the topmost image */
9699bf0d 2976 filename = fmt = NULL;
0da7d13a
SH
2977 image_opts = false;
2978
9699bf0d 2979 if (chain) {
54fde4ff 2980 if (info->full_backing_filename) {
9699bf0d 2981 filename = info->full_backing_filename;
54fde4ff 2982 } else if (info->backing_filename) {
92d617ab
JS
2983 error_report("Could not determine absolute backing filename,"
2984 " but backing filename '%s' present",
2985 info->backing_filename);
2986 goto err;
9699bf0d 2987 }
54fde4ff 2988 if (info->backing_filename_format) {
9699bf0d
SH
2989 fmt = info->backing_filename_format;
2990 }
2991 }
2992 }
2993 g_hash_table_destroy(filenames);
2994 return head;
2995
2996err:
c04d0ab0 2997 qapi_free_BlockGraphInfoList(head);
9699bf0d
SH
2998 g_hash_table_destroy(filenames);
2999 return NULL;
3000}
3001
c054b3fd
BC
3002static int img_info(int argc, char **argv)
3003{
3004 int c;
3005 OutputFormat output_format = OFORMAT_HUMAN;
9699bf0d 3006 bool chain = false;
c054b3fd 3007 const char *filename, *fmt, *output;
c04d0ab0 3008 BlockGraphInfoList *list;
eb769f74 3009 bool image_opts = false;
335e9937 3010 bool force_share = false;
c054b3fd 3011
ea2384d3 3012 fmt = NULL;
c054b3fd 3013 output = NULL;
ea2384d3 3014 for(;;) {
c054b3fd
BC
3015 int option_index = 0;
3016 static const struct option long_options[] = {
3017 {"help", no_argument, 0, 'h'},
3018 {"format", required_argument, 0, 'f'},
3019 {"output", required_argument, 0, OPTION_OUTPUT},
9699bf0d 3020 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
3babeb15 3021 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 3022 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 3023 {"force-share", no_argument, 0, 'U'},
c054b3fd
BC
3024 {0, 0, 0, 0}
3025 };
335e9937 3026 c = getopt_long(argc, argv, ":f:hU",
c054b3fd 3027 long_options, &option_index);
b8fb60da 3028 if (c == -1) {
ea2384d3 3029 break;
b8fb60da 3030 }
ea2384d3 3031 switch(c) {
c9192973
SH
3032 case ':':
3033 missing_argument(argv[optind - 1]);
3034 break;
ef87394c 3035 case '?':
c9192973
SH
3036 unrecognized_option(argv[optind - 1]);
3037 break;
ea2384d3
FB
3038 case 'h':
3039 help();
3040 break;
3041 case 'f':
3042 fmt = optarg;
3043 break;
335e9937
FZ
3044 case 'U':
3045 force_share = true;
3046 break;
c054b3fd
BC
3047 case OPTION_OUTPUT:
3048 output = optarg;
3049 break;
9699bf0d
SH
3050 case OPTION_BACKING_CHAIN:
3051 chain = true;
3052 break;
99b1e646
KW
3053 case OPTION_OBJECT:
3054 user_creatable_process_cmdline(optarg);
3055 break;
eb769f74
DB
3056 case OPTION_IMAGE_OPTS:
3057 image_opts = true;
3058 break;
ea2384d3
FB
3059 }
3060 }
fc11eb26 3061 if (optind != argc - 1) {
ac1307ab 3062 error_exit("Expecting one image file name");
b8fb60da 3063 }
ea2384d3
FB
3064 filename = argv[optind++];
3065
c054b3fd
BC
3066 if (output && !strcmp(output, "json")) {
3067 output_format = OFORMAT_JSON;
3068 } else if (output && !strcmp(output, "human")) {
3069 output_format = OFORMAT_HUMAN;
3070 } else if (output) {
3071 error_report("--output must be used with human or json as argument.");
c2abccec
MK
3072 return 1;
3073 }
c054b3fd 3074
335e9937
FZ
3075 list = collect_image_info_list(image_opts, filename, fmt, chain,
3076 force_share);
9699bf0d 3077 if (!list) {
c2abccec 3078 return 1;
faea38e7 3079 }
c054b3fd 3080
c054b3fd
BC
3081 switch (output_format) {
3082 case OFORMAT_HUMAN:
9699bf0d 3083 dump_human_image_info_list(list);
c054b3fd
BC
3084 break;
3085 case OFORMAT_JSON:
9699bf0d 3086 if (chain) {
c04d0ab0 3087 dump_json_block_graph_info_list(list);
9699bf0d 3088 } else {
c04d0ab0 3089 dump_json_block_graph_info(list->value);
9699bf0d 3090 }
c054b3fd 3091 break;
faea38e7 3092 }
c054b3fd 3093
c04d0ab0 3094 qapi_free_BlockGraphInfoList(list);
ea2384d3
FB
3095 return 0;
3096}
3097
30065d14
EB
3098static int dump_map_entry(OutputFormat output_format, MapEntry *e,
3099 MapEntry *next)
4c93a13b
PB
3100{
3101 switch (output_format) {
3102 case OFORMAT_HUMAN:
16b0d555 3103 if (e->data && !e->has_offset) {
4c93a13b 3104 error_report("File contains external, encrypted or compressed clusters.");
30065d14 3105 return -1;
4c93a13b 3106 }
16b0d555 3107 if (e->data && !e->zero) {
4c93a13b 3108 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
16b0d555
FZ
3109 e->start, e->length,
3110 e->has_offset ? e->offset : 0,
54fde4ff 3111 e->filename ?: "");
4c93a13b
PB
3112 }
3113 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
3114 * Modify the flags here to allow more coalescing.
3115 */
16b0d555
FZ
3116 if (next && (!next->data || next->zero)) {
3117 next->data = false;
3118 next->zero = true;
4c93a13b
PB
3119 }
3120 break;
3121 case OFORMAT_JSON:
e46c0b18 3122 printf("{ \"start\": %"PRId64", \"length\": %"PRId64","
8417e137 3123 " \"depth\": %"PRId64", \"present\": %s, \"zero\": %s,"
52b10c9c
AD
3124 " \"data\": %s, \"compressed\": %s",
3125 e->start, e->length, e->depth,
8417e137 3126 e->present ? "true" : "false",
16b0d555 3127 e->zero ? "true" : "false",
52b10c9c
AD
3128 e->data ? "true" : "false",
3129 e->compressed ? "true" : "false");
16b0d555 3130 if (e->has_offset) {
c745bfb4 3131 printf(", \"offset\": %"PRId64"", e->offset);
4c93a13b
PB
3132 }
3133 putchar('}');
3134
e46c0b18
EM
3135 if (next) {
3136 puts(",");
4c93a13b
PB
3137 }
3138 break;
3139 }
30065d14 3140 return 0;
4c93a13b
PB
3141}
3142
5e344dd8
EB
3143static int get_block_status(BlockDriverState *bs, int64_t offset,
3144 int64_t bytes, MapEntry *e)
4c93a13b 3145{
237d78f8 3146 int ret;
4c93a13b 3147 int depth;
67a0fd2a 3148 BlockDriverState *file;
2875645b 3149 bool has_offset;
237d78f8 3150 int64_t map;
f30c66ba 3151 char *filename = NULL;
4c93a13b 3152
ad74751f
KW
3153 GLOBAL_STATE_CODE();
3154 GRAPH_RDLOCK_GUARD_MAINLOOP();
3155
4c93a13b
PB
3156 /* As an optimization, we could cache the current range of unallocated
3157 * clusters in each file of the chain, and avoid querying the same
3158 * range repeatedly.
3159 */
3160
3161 depth = 0;
3162 for (;;) {
4a2061e6 3163 bs = bdrv_skip_filters(bs);
237d78f8 3164 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
4c93a13b
PB
3165 if (ret < 0) {
3166 return ret;
3167 }
237d78f8 3168 assert(bytes);
4c93a13b
PB
3169 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
3170 break;
3171 }
4a2061e6 3172 bs = bdrv_cow_bs(bs);
4c93a13b
PB
3173 if (bs == NULL) {
3174 ret = 0;
3175 break;
3176 }
3177
3178 depth++;
3179 }
3180
2875645b
JS
3181 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
3182
f30c66ba
HR
3183 if (file && has_offset) {
3184 bdrv_refresh_filename(file);
3185 filename = file->filename;
3186 }
3187
2875645b 3188 *e = (MapEntry) {
5e344dd8 3189 .start = offset,
237d78f8 3190 .length = bytes,
2875645b
JS
3191 .data = !!(ret & BDRV_BLOCK_DATA),
3192 .zero = !!(ret & BDRV_BLOCK_ZERO),
52b10c9c 3193 .compressed = !!(ret & BDRV_BLOCK_COMPRESSED),
237d78f8 3194 .offset = map,
2875645b
JS
3195 .has_offset = has_offset,
3196 .depth = depth,
8417e137 3197 .present = !!(ret & BDRV_BLOCK_ALLOCATED),
f30c66ba 3198 .filename = filename,
2875645b
JS
3199 };
3200
4c93a13b
PB
3201 return 0;
3202}
3203
16b0d555
FZ
3204static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
3205{
3206 if (curr->length == 0) {
3207 return false;
3208 }
3209 if (curr->zero != next->zero ||
3210 curr->data != next->data ||
52b10c9c 3211 curr->compressed != next->compressed ||
16b0d555 3212 curr->depth != next->depth ||
8417e137 3213 curr->present != next->present ||
54fde4ff 3214 !curr->filename != !next->filename ||
16b0d555
FZ
3215 curr->has_offset != next->has_offset) {
3216 return false;
3217 }
54fde4ff 3218 if (curr->filename && strcmp(curr->filename, next->filename)) {
16b0d555
FZ
3219 return false;
3220 }
3221 if (curr->has_offset && curr->offset + curr->length != next->offset) {
3222 return false;
3223 }
3224 return true;
3225}
3226
4c93a13b
PB
3227static int img_map(int argc, char **argv)
3228{
3229 int c;
3230 OutputFormat output_format = OFORMAT_HUMAN;
26f54e9a 3231 BlockBackend *blk;
4c93a13b
PB
3232 BlockDriverState *bs;
3233 const char *filename, *fmt, *output;
3234 int64_t length;
3235 MapEntry curr = { .length = 0 }, next;
3236 int ret = 0;
eb769f74 3237 bool image_opts = false;
335e9937 3238 bool force_share = false;
c0469496
EM
3239 int64_t start_offset = 0;
3240 int64_t max_length = -1;
4c93a13b
PB
3241
3242 fmt = NULL;
3243 output = NULL;
3244 for (;;) {
3245 int option_index = 0;
3246 static const struct option long_options[] = {
3247 {"help", no_argument, 0, 'h'},
3248 {"format", required_argument, 0, 'f'},
3249 {"output", required_argument, 0, OPTION_OUTPUT},
3babeb15 3250 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 3251 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 3252 {"force-share", no_argument, 0, 'U'},
c0469496
EM
3253 {"start-offset", required_argument, 0, 's'},
3254 {"max-length", required_argument, 0, 'l'},
4c93a13b
PB
3255 {0, 0, 0, 0}
3256 };
c0469496 3257 c = getopt_long(argc, argv, ":f:s:l:hU",
4c93a13b
PB
3258 long_options, &option_index);
3259 if (c == -1) {
3260 break;
3261 }
3262 switch (c) {
c9192973
SH
3263 case ':':
3264 missing_argument(argv[optind - 1]);
3265 break;
4c93a13b 3266 case '?':
c9192973
SH
3267 unrecognized_option(argv[optind - 1]);
3268 break;
4c93a13b
PB
3269 case 'h':
3270 help();
3271 break;
3272 case 'f':
3273 fmt = optarg;
3274 break;
335e9937
FZ
3275 case 'U':
3276 force_share = true;
3277 break;
4c93a13b
PB
3278 case OPTION_OUTPUT:
3279 output = optarg;
3280 break;
c0469496
EM
3281 case 's':
3282 start_offset = cvtnum("start offset", optarg);
3283 if (start_offset < 0) {
3284 return 1;
3285 }
3286 break;
3287 case 'l':
3288 max_length = cvtnum("max length", optarg);
3289 if (max_length < 0) {
3290 return 1;
3291 }
3292 break;
99b1e646
KW
3293 case OPTION_OBJECT:
3294 user_creatable_process_cmdline(optarg);
3295 break;
eb769f74
DB
3296 case OPTION_IMAGE_OPTS:
3297 image_opts = true;
3298 break;
4c93a13b
PB
3299 }
3300 }
ac1307ab
FZ
3301 if (optind != argc - 1) {
3302 error_exit("Expecting one image file name");
4c93a13b 3303 }
ac1307ab 3304 filename = argv[optind];
4c93a13b
PB
3305
3306 if (output && !strcmp(output, "json")) {
3307 output_format = OFORMAT_JSON;
3308 } else if (output && !strcmp(output, "human")) {
3309 output_format = OFORMAT_HUMAN;
3310 } else if (output) {
3311 error_report("--output must be used with human or json as argument.");
3312 return 1;
3313 }
3314
335e9937 3315 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
7e7d56d9
MA
3316 if (!blk) {
3317 return 1;
4c93a13b 3318 }
7e7d56d9 3319 bs = blk_bs(blk);
4c93a13b
PB
3320
3321 if (output_format == OFORMAT_HUMAN) {
3322 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
e46c0b18
EM
3323 } else if (output_format == OFORMAT_JSON) {
3324 putchar('[');
4c93a13b
PB
3325 }
3326
f1d3cd79 3327 length = blk_getlength(blk);
8f282e83
EM
3328 if (length < 0) {
3329 error_report("Failed to get size for '%s'", filename);
3330 return 1;
3331 }
c0469496
EM
3332 if (max_length != -1) {
3333 length = MIN(start_offset + max_length, length);
3334 }
8f282e83 3335
c0469496 3336 curr.start = start_offset;
4c93a13b 3337 while (curr.start + curr.length < length) {
5e344dd8 3338 int64_t offset = curr.start + curr.length;
d0ceea88 3339 int64_t n = length - offset;
4c93a13b 3340
5e344dd8 3341 ret = get_block_status(bs, offset, n, &next);
4c93a13b
PB
3342 if (ret < 0) {
3343 error_report("Could not read file metadata: %s", strerror(-ret));
3344 goto out;
3345 }
3346
16b0d555 3347 if (entry_mergeable(&curr, &next)) {
4c93a13b
PB
3348 curr.length += next.length;
3349 continue;
3350 }
3351
3352 if (curr.length > 0) {
30065d14
EB
3353 ret = dump_map_entry(output_format, &curr, &next);
3354 if (ret < 0) {
3355 goto out;
3356 }
4c93a13b
PB
3357 }
3358 curr = next;
3359 }
3360
30065d14 3361 ret = dump_map_entry(output_format, &curr, NULL);
e46c0b18
EM
3362 if (output_format == OFORMAT_JSON) {
3363 puts("]");
3364 }
4c93a13b
PB
3365
3366out:
26f54e9a 3367 blk_unref(blk);
4c93a13b
PB
3368 return ret < 0;
3369}
3370
f7b4a940
AL
3371#define SNAPSHOT_LIST 1
3372#define SNAPSHOT_CREATE 2
3373#define SNAPSHOT_APPLY 3
3374#define SNAPSHOT_DELETE 4
3375
153859be 3376static int img_snapshot(int argc, char **argv)
f7b4a940 3377{
26f54e9a 3378 BlockBackend *blk;
f7b4a940
AL
3379 BlockDriverState *bs;
3380 QEMUSnapshotInfo sn;
3381 char *filename, *snapshot_name = NULL;
c2abccec 3382 int c, ret = 0, bdrv_oflags;
f7b4a940 3383 int action = 0;
f382d43a 3384 bool quiet = false;
a89d89d3 3385 Error *err = NULL;
eb769f74 3386 bool image_opts = false;
335e9937 3387 bool force_share = false;
f793dde0 3388 int64_t rt;
f7b4a940 3389
ce099547 3390 bdrv_oflags = BDRV_O_RDWR;
f7b4a940
AL
3391 /* Parse commandline parameters */
3392 for(;;) {
3babeb15
DB
3393 static const struct option long_options[] = {
3394 {"help", no_argument, 0, 'h'},
3395 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 3396 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 3397 {"force-share", no_argument, 0, 'U'},
3babeb15
DB
3398 {0, 0, 0, 0}
3399 };
335e9937 3400 c = getopt_long(argc, argv, ":la:c:d:hqU",
3babeb15 3401 long_options, NULL);
b8fb60da 3402 if (c == -1) {
f7b4a940 3403 break;
b8fb60da 3404 }
f7b4a940 3405 switch(c) {
c9192973
SH
3406 case ':':
3407 missing_argument(argv[optind - 1]);
3408 break;
ef87394c 3409 case '?':
c9192973
SH
3410 unrecognized_option(argv[optind - 1]);
3411 break;
f7b4a940
AL
3412 case 'h':
3413 help();
153859be 3414 return 0;
f7b4a940
AL
3415 case 'l':
3416 if (action) {
ac1307ab 3417 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 3418 return 0;
f7b4a940
AL
3419 }
3420 action = SNAPSHOT_LIST;
f5edb014 3421 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
f7b4a940
AL
3422 break;
3423 case 'a':
3424 if (action) {
ac1307ab 3425 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 3426 return 0;
f7b4a940
AL
3427 }
3428 action = SNAPSHOT_APPLY;
3429 snapshot_name = optarg;
3430 break;
3431 case 'c':
3432 if (action) {
ac1307ab 3433 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 3434 return 0;
f7b4a940
AL
3435 }
3436 action = SNAPSHOT_CREATE;
3437 snapshot_name = optarg;
3438 break;
3439 case 'd':
3440 if (action) {
ac1307ab 3441 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 3442 return 0;
f7b4a940
AL
3443 }
3444 action = SNAPSHOT_DELETE;
3445 snapshot_name = optarg;
3446 break;
f382d43a
MR
3447 case 'q':
3448 quiet = true;
3449 break;
335e9937
FZ
3450 case 'U':
3451 force_share = true;
3452 break;
99b1e646
KW
3453 case OPTION_OBJECT:
3454 user_creatable_process_cmdline(optarg);
3455 break;
eb769f74
DB
3456 case OPTION_IMAGE_OPTS:
3457 image_opts = true;
3458 break;
f7b4a940
AL
3459 }
3460 }
3461
fc11eb26 3462 if (optind != argc - 1) {
ac1307ab 3463 error_exit("Expecting one image file name");
b8fb60da 3464 }
f7b4a940
AL
3465 filename = argv[optind++];
3466
3467 /* Open the image */
335e9937
FZ
3468 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3469 force_share);
7e7d56d9
MA
3470 if (!blk) {
3471 return 1;
c2abccec 3472 }
7e7d56d9 3473 bs = blk_bs(blk);
f7b4a940
AL
3474
3475 /* Perform the requested action */
3476 switch(action) {
3477 case SNAPSHOT_LIST:
3478 dump_snapshots(bs);
3479 break;
3480
3481 case SNAPSHOT_CREATE:
3482 memset(&sn, 0, sizeof(sn));
3483 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3484
f793dde0
MAL
3485 rt = g_get_real_time();
3486 sn.date_sec = rt / G_USEC_PER_SEC;
3487 sn.date_nsec = (rt % G_USEC_PER_SEC) * 1000;
f7b4a940 3488
a32e7818 3489 bdrv_graph_rdlock_main_loop();
f7b4a940 3490 ret = bdrv_snapshot_create(bs, &sn);
a32e7818
KW
3491 bdrv_graph_rdunlock_main_loop();
3492
b8fb60da 3493 if (ret) {
b0a6620a
MT
3494 error_report("Could not create snapshot '%s': %s",
3495 snapshot_name, strerror(-ret));
b8fb60da 3496 }
f7b4a940
AL
3497 break;
3498
3499 case SNAPSHOT_APPLY:
0b62bcbc 3500 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
b8fb60da 3501 if (ret) {
0b62bcbc
KW
3502 error_reportf_err(err, "Could not apply snapshot '%s': ",
3503 snapshot_name);
b8fb60da 3504 }
f7b4a940
AL
3505 break;
3506
3507 case SNAPSHOT_DELETE:
a32e7818 3508 bdrv_graph_rdlock_main_loop();
8c04093c
DHB
3509 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3510 if (ret < 0) {
3511 error_report("Could not delete snapshot '%s': snapshot not "
3512 "found", snapshot_name);
a89d89d3 3513 ret = 1;
8c04093c
DHB
3514 } else {
3515 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3516 if (ret < 0) {
3517 error_reportf_err(err, "Could not delete snapshot '%s': ",
3518 snapshot_name);
3519 ret = 1;
3520 }
b8fb60da 3521 }
a32e7818 3522 bdrv_graph_rdunlock_main_loop();
f7b4a940
AL
3523 break;
3524 }
3525
3526 /* Cleanup */
26f54e9a 3527 blk_unref(blk);
c2abccec
MK
3528 if (ret) {
3529 return 1;
3530 }
153859be 3531 return 0;
f7b4a940
AL
3532}
3533
3e85c6fd
KW
3534static int img_rebase(int argc, char **argv)
3535{
26f54e9a 3536 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
396374ca
PB
3537 uint8_t *buf_old = NULL;
3538 uint8_t *buf_new = NULL;
863cc78f 3539 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
78a9c76e 3540 BlockDriverState *unfiltered_bs, *unfiltered_bs_cow;
12df580b 3541 BlockDriverInfo bdi = {0};
3e85c6fd 3542 char *filename;
40055951
HR
3543 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3544 int c, flags, src_flags, ret;
26ea2789 3545 BdrvRequestFlags write_flags = 0;
ce099547 3546 bool writethrough, src_writethrough;
3e85c6fd 3547 int unsafe = 0;
335e9937 3548 bool force_share = false;
6b837bc4 3549 int progress = 0;
f382d43a 3550 bool quiet = false;
26ea2789 3551 bool compress = false;
34b5d2c6 3552 Error *local_err = NULL;
eb769f74 3553 bool image_opts = false;
12df580b 3554 int64_t write_align;
3e85c6fd
KW
3555
3556 /* Parse commandline parameters */
e53dbee0 3557 fmt = NULL;
661a0f71 3558 cache = BDRV_DEFAULT_CACHE;
40055951 3559 src_cache = BDRV_DEFAULT_CACHE;
3e85c6fd
KW
3560 out_baseimg = NULL;
3561 out_basefmt = NULL;
3e85c6fd 3562 for(;;) {
3babeb15
DB
3563 static const struct option long_options[] = {
3564 {"help", no_argument, 0, 'h'},
3565 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 3566 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 3567 {"force-share", no_argument, 0, 'U'},
26ea2789 3568 {"compress", no_argument, 0, 'c'},
3babeb15
DB
3569 {0, 0, 0, 0}
3570 };
26ea2789 3571 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qUc",
3babeb15 3572 long_options, NULL);
b8fb60da 3573 if (c == -1) {
3e85c6fd 3574 break;
b8fb60da 3575 }
3e85c6fd 3576 switch(c) {
c9192973
SH
3577 case ':':
3578 missing_argument(argv[optind - 1]);
3579 break;
ef87394c 3580 case '?':
c9192973
SH
3581 unrecognized_option(argv[optind - 1]);
3582 break;
3e85c6fd
KW
3583 case 'h':
3584 help();
3585 return 0;
e53dbee0
KW
3586 case 'f':
3587 fmt = optarg;
3588 break;
3e85c6fd
KW
3589 case 'F':
3590 out_basefmt = optarg;
3591 break;
3592 case 'b':
3593 out_baseimg = optarg;
3594 break;
3595 case 'u':
3596 unsafe = 1;
3597 break;
6b837bc4
JS
3598 case 'p':
3599 progress = 1;
3600 break;
661a0f71
FS
3601 case 't':
3602 cache = optarg;
3603 break;
40055951
HR
3604 case 'T':
3605 src_cache = optarg;
3606 break;
f382d43a
MR
3607 case 'q':
3608 quiet = true;
3609 break;
99b1e646
KW
3610 case OPTION_OBJECT:
3611 user_creatable_process_cmdline(optarg);
3612 break;
eb769f74
DB
3613 case OPTION_IMAGE_OPTS:
3614 image_opts = true;
3615 break;
335e9937
FZ
3616 case 'U':
3617 force_share = true;
3618 break;
26ea2789
AD
3619 case 'c':
3620 compress = true;
3621 break;
3e85c6fd
KW
3622 }
3623 }
3624
f382d43a
MR
3625 if (quiet) {
3626 progress = 0;
3627 }
3628
ac1307ab
FZ
3629 if (optind != argc - 1) {
3630 error_exit("Expecting one image file name");
3631 }
3632 if (!unsafe && !out_baseimg) {
3633 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
b8fb60da 3634 }
3e85c6fd
KW
3635 filename = argv[optind++];
3636
6b837bc4
JS
3637 qemu_progress_init(progress, 2.0);
3638 qemu_progress_print(0, 100);
3639
661a0f71 3640 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
ce099547 3641 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
661a0f71
FS
3642 if (ret < 0) {
3643 error_report("Invalid cache option: %s", cache);
40ed35a3 3644 goto out;
661a0f71
FS
3645 }
3646
ce099547
KW
3647 src_flags = 0;
3648 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
40055951
HR
3649 if (ret < 0) {
3650 error_report("Invalid source cache option: %s", src_cache);
40ed35a3 3651 goto out;
40055951
HR
3652 }
3653
ce099547
KW
3654 /* The source files are opened read-only, don't care about WCE */
3655 assert((src_flags & BDRV_O_RDWR) == 0);
3656 (void) src_writethrough;
3657
3e85c6fd
KW
3658 /*
3659 * Open the images.
3660 *
3661 * Ignore the old backing file for unsafe rebase in case we want to correct
3662 * the reference to a renamed or moved backing file.
3663 */
335e9937
FZ
3664 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3665 false);
7e7d56d9 3666 if (!blk) {
40ed35a3
SH
3667 ret = -1;
3668 goto out;
c2abccec 3669 }
7e7d56d9 3670 bs = blk_bs(blk);
3e85c6fd 3671
ad74751f 3672 bdrv_graph_rdlock_main_loop();
4a2061e6 3673 unfiltered_bs = bdrv_skip_filters(bs);
78a9c76e 3674 unfiltered_bs_cow = bdrv_cow_bs(unfiltered_bs);
ad74751f 3675 bdrv_graph_rdunlock_main_loop();
4a2061e6 3676
26ea2789
AD
3677 if (compress && !block_driver_can_compress(unfiltered_bs->drv)) {
3678 error_report("Compression not supported for this file format");
3679 ret = -1;
3680 goto out;
3681 } else if (compress) {
3682 write_flags |= BDRV_REQ_WRITE_COMPRESSED;
3683 }
3684
3e85c6fd 3685 if (out_basefmt != NULL) {
644483d9 3686 if (bdrv_find_format(out_basefmt) == NULL) {
15654a6d 3687 error_report("Invalid format name: '%s'", out_basefmt);
c2abccec
MK
3688 ret = -1;
3689 goto out;
3e85c6fd
KW
3690 }
3691 }
3692
12df580b 3693 /*
26ea2789
AD
3694 * We need overlay subcluster size (or cluster size in case writes are
3695 * compressed) to make sure write requests are aligned.
12df580b
AD
3696 */
3697 ret = bdrv_get_info(unfiltered_bs, &bdi);
3698 if (ret < 0) {
3699 error_report("could not get block driver info");
3700 goto out;
3701 } else if (bdi.subcluster_size == 0) {
26ea2789 3702 bdi.cluster_size = bdi.subcluster_size = 1;
12df580b
AD
3703 }
3704
26ea2789 3705 write_align = compress ? bdi.cluster_size : bdi.subcluster_size;
12df580b 3706
3e85c6fd 3707 /* For safe rebasing we need to compare old and new backing file */
40ed35a3 3708 if (!unsafe) {
644483d9 3709 QDict *options = NULL;
78a9c76e
KW
3710 BlockDriverState *base_bs;
3711
3712 bdrv_graph_rdlock_main_loop();
3713 base_bs = bdrv_cow_bs(unfiltered_bs);
3714 bdrv_graph_rdunlock_main_loop();
644483d9 3715
4ebe0617 3716 if (base_bs) {
d861ab3a
KW
3717 blk_old_backing = blk_new(qemu_get_aio_context(),
3718 BLK_PERM_CONSISTENT_READ,
4ebe0617
SE
3719 BLK_PERM_ALL);
3720 ret = blk_insert_bs(blk_old_backing, base_bs,
3721 &local_err);
3722 if (ret < 0) {
35ddd930 3723 error_reportf_err(local_err,
4ebe0617
SE
3724 "Could not reuse old backing file '%s': ",
3725 base_bs->filename);
35ddd930
HR
3726 goto out;
3727 }
3728 } else {
3729 blk_old_backing = NULL;
3e85c6fd 3730 }
644483d9 3731
a616673d 3732 if (out_baseimg[0]) {
d16699b6
HR
3733 const char *overlay_filename;
3734 char *out_real_path;
3735
335e9937 3736 options = qdict_new();
644483d9 3737 if (out_basefmt) {
46f5ac20 3738 qdict_put_str(options, "driver", out_basefmt);
335e9937
FZ
3739 }
3740 if (force_share) {
3741 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
644483d9
HR
3742 }
3743
b7cfc7d5 3744 bdrv_graph_rdlock_main_loop();
f30c66ba 3745 bdrv_refresh_filename(bs);
b7cfc7d5 3746 bdrv_graph_rdunlock_main_loop();
d16699b6
HR
3747 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3748 : bs->filename;
645ae7d8
HR
3749 out_real_path =
3750 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3751 out_baseimg,
3752 &local_err);
d16699b6 3753 if (local_err) {
f22356d9 3754 qobject_unref(options);
d16699b6
HR
3755 error_reportf_err(local_err,
3756 "Could not resolve backing filename: ");
3757 ret = -1;
d16699b6
HR
3758 goto out;
3759 }
3760
863cc78f
SE
3761 /*
3762 * Find out whether we rebase an image on top of a previous image
3763 * in its chain.
3764 */
3765 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
330c7295 3766 if (prefix_chain_bs) {
f22356d9 3767 qobject_unref(options);
330c7295 3768 g_free(out_real_path);
f22356d9 3769
d861ab3a
KW
3770 blk_new_backing = blk_new(qemu_get_aio_context(),
3771 BLK_PERM_CONSISTENT_READ,
330c7295
SE
3772 BLK_PERM_ALL);
3773 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
3774 &local_err);
3775 if (ret < 0) {
3776 error_reportf_err(local_err,
3777 "Could not reuse backing file '%s': ",
3778 out_baseimg);
3779 goto out;
3780 }
3781 } else {
3782 blk_new_backing = blk_new_open(out_real_path, NULL,
3783 options, src_flags, &local_err);
3784 g_free(out_real_path);
3785 if (!blk_new_backing) {
3786 error_reportf_err(local_err,
3787 "Could not open new backing file '%s': ",
3788 out_baseimg);
3789 ret = -1;
3790 goto out;
3791 }
a616673d 3792 }
3e85c6fd
KW
3793 }
3794 }
3795
3796 /*
3797 * Check each unallocated cluster in the COW file. If it is unallocated,
3798 * accesses go to the backing file. We must therefore compare this cluster
3799 * in the old and new backing file, and if they differ we need to copy it
3800 * from the old backing file into the COW file.
3801 *
3802 * If qemu-img crashes during this step, no harm is done. The content of
3803 * the image is the same as the original one at any time.
3804 */
3805 if (!unsafe) {
41536287 3806 int64_t size;
35ddd930 3807 int64_t old_backing_size = 0;
41536287
EB
3808 int64_t new_backing_size = 0;
3809 uint64_t offset;
12df580b 3810 int64_t n, n_old = 0, n_new = 0;
1f710495 3811 float local_progress = 0;
d6771bfa 3812
ce8b8f9f
AD
3813 if (blk_old_backing && bdrv_opt_mem_align(blk_bs(blk_old_backing)) >
3814 bdrv_opt_mem_align(blk_bs(blk))) {
3815 buf_old = blk_blockalign(blk_old_backing, IO_BUF_SIZE);
3816 } else {
3817 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3818 }
3819 buf_new = blk_blockalign(blk_new_backing, IO_BUF_SIZE);
3e85c6fd 3820
41536287
EB
3821 size = blk_getlength(blk);
3822 if (size < 0) {
52bf1e72 3823 error_report("Could not get size of '%s': %s",
41536287 3824 filename, strerror(-size));
52bf1e72
MA
3825 ret = -1;
3826 goto out;
3827 }
35ddd930
HR
3828 if (blk_old_backing) {
3829 old_backing_size = blk_getlength(blk_old_backing);
3830 if (old_backing_size < 0) {
3831 char backing_name[PATH_MAX];
52bf1e72 3832
35ddd930
HR
3833 bdrv_get_backing_filename(bs, backing_name,
3834 sizeof(backing_name));
3835 error_report("Could not get size of '%s': %s",
3836 backing_name, strerror(-old_backing_size));
3837 ret = -1;
3838 goto out;
3839 }
52bf1e72 3840 }
f1d3cd79 3841 if (blk_new_backing) {
41536287
EB
3842 new_backing_size = blk_getlength(blk_new_backing);
3843 if (new_backing_size < 0) {
52bf1e72 3844 error_report("Could not get size of '%s': %s",
41536287 3845 out_baseimg, strerror(-new_backing_size));
52bf1e72
MA
3846 ret = -1;
3847 goto out;
3848 }
a616673d 3849 }
3e85c6fd 3850
41536287
EB
3851 if (size != 0) {
3852 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
1f710495
KW
3853 }
3854
41536287 3855 for (offset = 0; offset < size; offset += n) {
12df580b
AD
3856 bool old_backing_eof = false;
3857 int64_t n_alloc;
1c6e8779 3858
41536287
EB
3859 /* How many bytes can we handle with the next read? */
3860 n = MIN(IO_BUF_SIZE, size - offset);
3e85c6fd
KW
3861
3862 /* If the cluster is allocated, we don't need to take action */
4a2061e6 3863 ret = bdrv_is_allocated(unfiltered_bs, offset, n, &n);
d663640c
PB
3864 if (ret < 0) {
3865 error_report("error while reading image metadata: %s",
3866 strerror(-ret));
3867 goto out;
3868 }
cc60e327 3869 if (ret) {
3e85c6fd
KW
3870 continue;
3871 }
3872
863cc78f 3873 if (prefix_chain_bs) {
8b097fd6
AD
3874 uint64_t bytes = n;
3875
863cc78f
SE
3876 /*
3877 * If cluster wasn't changed since prefix_chain, we don't need
3878 * to take action
3879 */
78a9c76e 3880 ret = bdrv_is_allocated_above(unfiltered_bs_cow,
4a2061e6
HR
3881 prefix_chain_bs, false,
3882 offset, n, &n);
863cc78f
SE
3883 if (ret < 0) {
3884 error_report("error while reading image metadata: %s",
3885 strerror(-ret));
3886 goto out;
3887 }
8b097fd6 3888 if (!ret && n) {
863cc78f
SE
3889 continue;
3890 }
8b097fd6
AD
3891 if (!n) {
3892 /*
3893 * If we've reached EOF of the old backing, it means that
3894 * offsets beyond the old backing size were read as zeroes.
3895 * Now we will need to explicitly zero the cluster in
3896 * order to preserve that state after the rebase.
3897 */
3898 n = bytes;
3899 }
863cc78f
SE
3900 }
3901
12df580b
AD
3902 /*
3903 * At this point we know that the region [offset; offset + n)
3904 * is unallocated within the target image. This region might be
3905 * unaligned to the target image's (sub)cluster boundaries, as
3906 * old backing may have smaller clusters (or have subclusters).
3907 * We extend it to the aligned boundaries to avoid CoW on
3908 * partial writes in blk_pwrite(),
3909 */
3910 n += offset - QEMU_ALIGN_DOWN(offset, write_align);
3911 offset = QEMU_ALIGN_DOWN(offset, write_align);
3912 n += QEMU_ALIGN_UP(offset + n, write_align) - (offset + n);
3913 n = MIN(n, size - offset);
3914 assert(!bdrv_is_allocated(unfiltered_bs, offset, n, &n_alloc) &&
3915 n_alloc == n);
3916
3917 /*
3918 * Much like with the target image, we'll try to read as much
3919 * of the old and new backings as we can.
3920 */
3921 n_old = MIN(n, MAX(0, old_backing_size - (int64_t) offset));
3922 n_new = MIN(n, MAX(0, new_backing_size - (int64_t) offset));
3923
87a1b3e3
KW
3924 /*
3925 * Read old and new backing file and take into consideration that
3926 * backing files may be smaller than the COW image.
3927 */
12df580b
AD
3928 memset(buf_old + n_old, 0, n - n_old);
3929 if (!n_old) {
3930 old_backing_eof = true;
87a1b3e3 3931 } else {
12df580b 3932 ret = blk_pread(blk_old_backing, offset, n_old, buf_old, 0);
87a1b3e3
KW
3933 if (ret < 0) {
3934 error_report("error while reading from old backing file");
3935 goto out;
3936 }
3e85c6fd 3937 }
87a1b3e3 3938
12df580b
AD
3939 memset(buf_new + n_new, 0, n - n_new);
3940 if (n_new) {
3941 ret = blk_pread(blk_new_backing, offset, n_new, buf_new, 0);
87a1b3e3
KW
3942 if (ret < 0) {
3943 error_report("error while reading from new backing file");
3944 goto out;
3945 }
3e85c6fd
KW
3946 }
3947
3948 /* If they differ, we need to write to the COW file */
3949 uint64_t written = 0;
3950
41536287 3951 while (written < n) {
dc61cd3b 3952 int64_t pnum;
3e85c6fd 3953
41536287 3954 if (compare_buffers(buf_old + written, buf_new + written,
12df580b 3955 n - written, write_align, &pnum))
3e85c6fd 3956 {
12df580b 3957 if (old_backing_eof) {
1c6e8779
HR
3958 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0);
3959 } else {
12df580b 3960 assert(written + pnum <= IO_BUF_SIZE);
a9262f55 3961 ret = blk_pwrite(blk, offset + written, pnum,
26ea2789 3962 buf_old + written, write_flags);
1c6e8779 3963 }
3e85c6fd 3964 if (ret < 0) {
15654a6d 3965 error_report("Error while writing to COW image: %s",
3e85c6fd 3966 strerror(-ret));
c2abccec 3967 goto out;
3e85c6fd
KW
3968 }
3969 }
3970
3971 written += pnum;
12df580b
AD
3972 if (offset + written >= old_backing_size) {
3973 old_backing_eof = true;
3974 }
3e85c6fd 3975 }
6b837bc4 3976 qemu_progress_print(local_progress, 100);
3e85c6fd
KW
3977 }
3978 }
3979
3980 /*
3981 * Change the backing file. All clusters that are different from the old
3982 * backing file are overwritten in the COW file now, so the visible content
3983 * doesn't change when we switch the backing file.
3984 */
a616673d 3985 if (out_baseimg && *out_baseimg) {
4a2061e6
HR
3986 ret = bdrv_change_backing_file(unfiltered_bs, out_baseimg, out_basefmt,
3987 true);
a616673d 3988 } else {
4a2061e6 3989 ret = bdrv_change_backing_file(unfiltered_bs, NULL, NULL, false);
a616673d
AB
3990 }
3991
3e85c6fd 3992 if (ret == -ENOSPC) {
15654a6d
JS
3993 error_report("Could not change the backing file to '%s': No "
3994 "space left in the file header", out_baseimg);
a7cd44be
EB
3995 } else if (ret == -EINVAL && out_baseimg && !out_basefmt) {
3996 error_report("Could not change the backing file to '%s': backing "
3997 "format must be specified", out_baseimg);
3e85c6fd 3998 } else if (ret < 0) {
15654a6d 3999 error_report("Could not change the backing file to '%s': %s",
3e85c6fd
KW
4000 out_baseimg, strerror(-ret));
4001 }
4002
6b837bc4 4003 qemu_progress_print(100, 0);
3e85c6fd
KW
4004 /*
4005 * TODO At this point it is possible to check if any clusters that are
4006 * allocated in the COW file are the same in the backing file. If so, they
4007 * could be dropped from the COW file. Don't do this before switching the
4008 * backing file, in case of a crash this would lead to corruption.
4009 */
c2abccec 4010out:
6b837bc4 4011 qemu_progress_end();
3e85c6fd
KW
4012 /* Cleanup */
4013 if (!unsafe) {
26f54e9a 4014 blk_unref(blk_old_backing);
26f54e9a 4015 blk_unref(blk_new_backing);
3e85c6fd 4016 }
396374ca
PB
4017 qemu_vfree(buf_old);
4018 qemu_vfree(buf_new);
3e85c6fd 4019
26f54e9a 4020 blk_unref(blk);
c2abccec
MK
4021 if (ret) {
4022 return 1;
4023 }
3e85c6fd
KW
4024 return 0;
4025}
4026
ae6b0ed6
SH
4027static int img_resize(int argc, char **argv)
4028{
6750e795 4029 Error *err = NULL;
ae6b0ed6
SH
4030 int c, ret, relative;
4031 const char *filename, *fmt, *size;
09c5c6de 4032 int64_t n, total_size, current_size;
f382d43a 4033 bool quiet = false;
26f54e9a 4034 BlockBackend *blk = NULL;
dc5f690b 4035 PreallocMode prealloc = PREALLOC_MODE_OFF;
20caf0f7 4036 QemuOpts *param;
3babeb15 4037
20caf0f7
DXW
4038 static QemuOptsList resize_options = {
4039 .name = "resize_options",
4040 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
4041 .desc = {
4042 {
4043 .name = BLOCK_OPT_SIZE,
4044 .type = QEMU_OPT_SIZE,
4045 .help = "Virtual disk size"
4046 }, {
4047 /* end of list */
4048 }
ae6b0ed6 4049 },
ae6b0ed6 4050 };
eb769f74 4051 bool image_opts = false;
4ffca890 4052 bool shrink = false;
ae6b0ed6 4053
e80fec7f
KW
4054 /* Remove size from argv manually so that negative numbers are not treated
4055 * as options by getopt. */
4056 if (argc < 3) {
ac1307ab 4057 error_exit("Not enough arguments");
e80fec7f
KW
4058 return 1;
4059 }
4060
4061 size = argv[--argc];
4062
4063 /* Parse getopt arguments */
ae6b0ed6
SH
4064 fmt = NULL;
4065 for(;;) {
3babeb15
DB
4066 static const struct option long_options[] = {
4067 {"help", no_argument, 0, 'h'},
4068 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 4069 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
dc5f690b 4070 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
4ffca890 4071 {"shrink", no_argument, 0, OPTION_SHRINK},
3babeb15
DB
4072 {0, 0, 0, 0}
4073 };
c9192973 4074 c = getopt_long(argc, argv, ":f:hq",
3babeb15 4075 long_options, NULL);
ae6b0ed6
SH
4076 if (c == -1) {
4077 break;
4078 }
4079 switch(c) {
c9192973
SH
4080 case ':':
4081 missing_argument(argv[optind - 1]);
4082 break;
ef87394c 4083 case '?':
c9192973
SH
4084 unrecognized_option(argv[optind - 1]);
4085 break;
ae6b0ed6
SH
4086 case 'h':
4087 help();
4088 break;
4089 case 'f':
4090 fmt = optarg;
4091 break;
f382d43a
MR
4092 case 'q':
4093 quiet = true;
4094 break;
99b1e646
KW
4095 case OPTION_OBJECT:
4096 user_creatable_process_cmdline(optarg);
4097 break;
eb769f74
DB
4098 case OPTION_IMAGE_OPTS:
4099 image_opts = true;
4100 break;
dc5f690b 4101 case OPTION_PREALLOCATION:
f7abe0ec 4102 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
06c60b6c 4103 PREALLOC_MODE__MAX, NULL);
dc5f690b
HR
4104 if (prealloc == PREALLOC_MODE__MAX) {
4105 error_report("Invalid preallocation mode '%s'", optarg);
4106 return 1;
4107 }
4108 break;
4ffca890
PB
4109 case OPTION_SHRINK:
4110 shrink = true;
4111 break;
ae6b0ed6
SH
4112 }
4113 }
fc11eb26 4114 if (optind != argc - 1) {
be8fbd47 4115 error_exit("Expecting image file name and size");
ae6b0ed6
SH
4116 }
4117 filename = argv[optind++];
ae6b0ed6
SH
4118
4119 /* Choose grow, shrink, or absolute resize mode */
4120 switch (size[0]) {
4121 case '+':
4122 relative = 1;
4123 size++;
4124 break;
4125 case '-':
4126 relative = -1;
4127 size++;
4128 break;
4129 default:
4130 relative = 0;
4131 break;
4132 }
4133
4134 /* Parse size */
87ea75d5 4135 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
235e59cf 4136 if (!qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err)) {
6750e795 4137 error_report_err(err);
2a81998a 4138 ret = -1;
20caf0f7 4139 qemu_opts_del(param);
2a81998a 4140 goto out;
ae6b0ed6 4141 }
20caf0f7
DXW
4142 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
4143 qemu_opts_del(param);
ae6b0ed6 4144
efaa7c4e 4145 blk = img_open(image_opts, filename, fmt,
335e9937
FZ
4146 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
4147 false);
7e7d56d9 4148 if (!blk) {
2a81998a
JS
4149 ret = -1;
4150 goto out;
c2abccec 4151 }
ae6b0ed6 4152
dc5f690b
HR
4153 current_size = blk_getlength(blk);
4154 if (current_size < 0) {
4155 error_report("Failed to inquire current image length: %s",
4156 strerror(-current_size));
4157 ret = -1;
4158 goto out;
4159 }
4160
ae6b0ed6 4161 if (relative) {
dc5f690b 4162 total_size = current_size + n * relative;
ae6b0ed6
SH
4163 } else {
4164 total_size = n;
4165 }
4166 if (total_size <= 0) {
15654a6d 4167 error_report("New image size must be positive");
c2abccec
MK
4168 ret = -1;
4169 goto out;
ae6b0ed6
SH
4170 }
4171
dc5f690b
HR
4172 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
4173 error_report("Preallocation can only be used for growing images");
4174 ret = -1;
4175 goto out;
4176 }
4177
4ffca890 4178 if (total_size < current_size && !shrink) {
1c404d75 4179 error_report("Use the --shrink option to perform a shrink operation.");
4ffca890
PB
4180 warn_report("Shrinking an image will delete all data beyond the "
4181 "shrunken image's end. Before performing such an "
4182 "operation, make sure there is no important data there.");
1c404d75
KW
4183 ret = -1;
4184 goto out;
4ffca890
PB
4185 }
4186
e8d04f92
HR
4187 /*
4188 * The user expects the image to have the desired size after
4189 * resizing, so pass @exact=true. It is of no use to report
4190 * success when the image has not actually been resized.
4191 */
8c6242b6 4192 ret = blk_truncate(blk, total_size, true, prealloc, 0, &err);
09c5c6de
HR
4193 if (!ret) {
4194 qprintf(quiet, "Image resized.\n");
4195 } else {
ed3d2ec9 4196 error_report_err(err);
ae6b0ed6 4197 }
c2abccec 4198out:
26f54e9a 4199 blk_unref(blk);
c2abccec
MK
4200 if (ret) {
4201 return 1;
4202 }
ae6b0ed6
SH
4203 return 0;
4204}
4205
76a3a34d 4206static void amend_status_cb(BlockDriverState *bs,
8b13976d
HR
4207 int64_t offset, int64_t total_work_size,
4208 void *opaque)
76a3a34d
HR
4209{
4210 qemu_progress_print(100.f * offset / total_work_size, 0);
4211}
4212
51641351
HR
4213static int print_amend_option_help(const char *format)
4214{
4215 BlockDriver *drv;
4216
bd131d67
KW
4217 GRAPH_RDLOCK_GUARD_MAINLOOP();
4218
51641351
HR
4219 /* Find driver and parse its options */
4220 drv = bdrv_find_format(format);
4221 if (!drv) {
4222 error_report("Unknown file format '%s'", format);
4223 return 1;
4224 }
4225
4226 if (!drv->bdrv_amend_options) {
4227 error_report("Format driver '%s' does not support option amendment",
4228 format);
4229 return 1;
4230 }
4231
df373fb0
ML
4232 /* Every driver supporting amendment must have amend_opts */
4233 assert(drv->amend_opts);
51641351 4234
0b6786a9 4235 printf("Amend options for '%s':\n", format);
df373fb0 4236 qemu_opts_print_help(drv->amend_opts, false);
51641351
HR
4237 return 0;
4238}
4239
6f176b48
HR
4240static int img_amend(int argc, char **argv)
4241{
dc523cd3 4242 Error *err = NULL;
6f176b48
HR
4243 int c, ret = 0;
4244 char *options = NULL;
df373fb0 4245 QemuOptsList *amend_opts = NULL;
83d0521a 4246 QemuOpts *opts = NULL;
bd39e6ed
HR
4247 const char *fmt = NULL, *filename, *cache;
4248 int flags;
ce099547 4249 bool writethrough;
76a3a34d 4250 bool quiet = false, progress = false;
26f54e9a 4251 BlockBackend *blk = NULL;
6f176b48 4252 BlockDriverState *bs = NULL;
eb769f74 4253 bool image_opts = false;
a3579bfa 4254 bool force = false;
6f176b48 4255
bd39e6ed 4256 cache = BDRV_DEFAULT_CACHE;
6f176b48 4257 for (;;) {
3babeb15
DB
4258 static const struct option long_options[] = {
4259 {"help", no_argument, 0, 'h'},
4260 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 4261 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
a3579bfa 4262 {"force", no_argument, 0, OPTION_FORCE},
3babeb15
DB
4263 {0, 0, 0, 0}
4264 };
c9192973 4265 c = getopt_long(argc, argv, ":ho:f:t:pq",
3babeb15 4266 long_options, NULL);
6f176b48
HR
4267 if (c == -1) {
4268 break;
4269 }
4270
4271 switch (c) {
c9192973
SH
4272 case ':':
4273 missing_argument(argv[optind - 1]);
4274 break;
f7077624 4275 case '?':
c9192973
SH
4276 unrecognized_option(argv[optind - 1]);
4277 break;
4278 case 'h':
f7077624
SH
4279 help();
4280 break;
4281 case 'o':
6d2b5cba 4282 if (accumulate_options(&options, optarg) < 0) {
f7077624
SH
4283 ret = -1;
4284 goto out_no_progress;
4285 }
f7077624
SH
4286 break;
4287 case 'f':
4288 fmt = optarg;
4289 break;
4290 case 't':
4291 cache = optarg;
4292 break;
4293 case 'p':
4294 progress = true;
4295 break;
4296 case 'q':
4297 quiet = true;
4298 break;
4299 case OPTION_OBJECT:
99b1e646 4300 user_creatable_process_cmdline(optarg);
f7077624
SH
4301 break;
4302 case OPTION_IMAGE_OPTS:
4303 image_opts = true;
4304 break;
a3579bfa
ML
4305 case OPTION_FORCE:
4306 force = true;
4307 break;
6f176b48
HR
4308 }
4309 }
4310
a283cb6e 4311 if (!options) {
ac1307ab 4312 error_exit("Must specify options (-o)");
6f176b48
HR
4313 }
4314
76a3a34d
HR
4315 if (quiet) {
4316 progress = false;
4317 }
4318 qemu_progress_init(progress, 1.0);
4319
a283cb6e
KW
4320 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
4321 if (fmt && has_help_option(options)) {
4322 /* If a format is explicitly specified (and possibly no filename is
4323 * given), print option help here */
51641351 4324 ret = print_amend_option_help(fmt);
a283cb6e 4325 goto out;
6f176b48
HR
4326 }
4327
a283cb6e 4328 if (optind != argc - 1) {
b2f27e44
HR
4329 error_report("Expecting one image file name");
4330 ret = -1;
4331 goto out;
a283cb6e 4332 }
6f176b48 4333
ce099547
KW
4334 flags = BDRV_O_RDWR;
4335 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
bd39e6ed
HR
4336 if (ret < 0) {
4337 error_report("Invalid cache option: %s", cache);
4338 goto out;
4339 }
4340
335e9937
FZ
4341 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4342 false);
7e7d56d9 4343 if (!blk) {
6f176b48
HR
4344 ret = -1;
4345 goto out;
4346 }
7e7d56d9 4347 bs = blk_bs(blk);
6f176b48
HR
4348
4349 fmt = bs->drv->format_name;
4350
626f84f3 4351 if (has_help_option(options)) {
a283cb6e 4352 /* If the format was auto-detected, print option help here */
51641351 4353 ret = print_amend_option_help(fmt);
6f176b48
HR
4354 goto out;
4355 }
4356
bd131d67 4357 bdrv_graph_rdlock_main_loop();
1f996683
HR
4358 if (!bs->drv->bdrv_amend_options) {
4359 error_report("Format driver '%s' does not support option amendment",
b2439d26 4360 fmt);
bd131d67 4361 bdrv_graph_rdunlock_main_loop();
b2439d26
HR
4362 ret = -1;
4363 goto out;
4364 }
4365
df373fb0
ML
4366 /* Every driver supporting amendment must have amend_opts */
4367 assert(bs->drv->amend_opts);
1f996683 4368
df373fb0
ML
4369 amend_opts = qemu_opts_append(amend_opts, bs->drv->amend_opts);
4370 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
235e59cf 4371 if (!qemu_opts_do_parse(opts, options, NULL, &err)) {
0b6786a9 4372 /* Try to parse options using the create options */
0b6786a9
ML
4373 amend_opts = qemu_opts_append(amend_opts, bs->drv->create_opts);
4374 qemu_opts_del(opts);
4375 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
9e194e06 4376 if (qemu_opts_do_parse(opts, options, NULL, NULL)) {
0b6786a9
ML
4377 error_append_hint(&err,
4378 "This option is only supported for image creation\n");
0b6786a9
ML
4379 }
4380
bd131d67 4381 bdrv_graph_rdunlock_main_loop();
ece9086e
PB
4382 error_report_err(err);
4383 ret = -1;
4384 goto out;
6f176b48
HR
4385 }
4386
76a3a34d
HR
4387 /* In case the driver does not call amend_status_cb() */
4388 qemu_progress_print(0.f, 0);
a3579bfa 4389 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, force, &err);
76a3a34d 4390 qemu_progress_print(100.f, 0);
bd131d67
KW
4391 bdrv_graph_rdunlock_main_loop();
4392
6f176b48 4393 if (ret < 0) {
d1402b50 4394 error_report_err(err);
6f176b48
HR
4395 goto out;
4396 }
4397
4398out:
76a3a34d
HR
4399 qemu_progress_end();
4400
e814dffc 4401out_no_progress:
26f54e9a 4402 blk_unref(blk);
83d0521a 4403 qemu_opts_del(opts);
df373fb0 4404 qemu_opts_free(amend_opts);
626f84f3
KW
4405 g_free(options);
4406
6f176b48
HR
4407 if (ret) {
4408 return 1;
4409 }
4410 return 0;
4411}
4412
b6133b8c
KW
4413typedef struct BenchData {
4414 BlockBackend *blk;
4415 uint64_t image_size;
b6495fa8 4416 bool write;
b6133b8c 4417 int bufsize;
83de9be0 4418 int step;
b6133b8c
KW
4419 int nrreq;
4420 int n;
55d539c8
KW
4421 int flush_interval;
4422 bool drain_on_flush;
b6133b8c
KW
4423 uint8_t *buf;
4424 QEMUIOVector *qiov;
4425
4426 int in_flight;
55d539c8 4427 bool in_flush;
b6133b8c
KW
4428 uint64_t offset;
4429} BenchData;
4430
55d539c8
KW
4431static void bench_undrained_flush_cb(void *opaque, int ret)
4432{
4433 if (ret < 0) {
df3c286c 4434 error_report("Failed flush request: %s", strerror(-ret));
55d539c8
KW
4435 exit(EXIT_FAILURE);
4436 }
4437}
4438
b6133b8c
KW
4439static void bench_cb(void *opaque, int ret)
4440{
4441 BenchData *b = opaque;
4442 BlockAIOCB *acb;
4443
4444 if (ret < 0) {
df3c286c 4445 error_report("Failed request: %s", strerror(-ret));
b6133b8c
KW
4446 exit(EXIT_FAILURE);
4447 }
55d539c8
KW
4448
4449 if (b->in_flush) {
4450 /* Just finished a flush with drained queue: Start next requests */
4451 assert(b->in_flight == 0);
4452 b->in_flush = false;
4453 } else if (b->in_flight > 0) {
4454 int remaining = b->n - b->in_flight;
4455
b6133b8c
KW
4456 b->n--;
4457 b->in_flight--;
55d539c8
KW
4458
4459 /* Time for flush? Drain queue if requested, then flush */
4460 if (b->flush_interval && remaining % b->flush_interval == 0) {
4461 if (!b->in_flight || !b->drain_on_flush) {
4462 BlockCompletionFunc *cb;
4463
4464 if (b->drain_on_flush) {
4465 b->in_flush = true;
4466 cb = bench_cb;
4467 } else {
4468 cb = bench_undrained_flush_cb;
4469 }
4470
4471 acb = blk_aio_flush(b->blk, cb, b);
4472 if (!acb) {
4473 error_report("Failed to issue flush request");
4474 exit(EXIT_FAILURE);
4475 }
4476 }
4477 if (b->drain_on_flush) {
4478 return;
4479 }
4480 }
b6133b8c
KW
4481 }
4482
4483 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
4baaa8c3
PB
4484 int64_t offset = b->offset;
4485 /* blk_aio_* might look for completed I/Os and kick bench_cb
4486 * again, so make sure this operation is counted by in_flight
4487 * and b->offset is ready for the next submission.
4488 */
4489 b->in_flight++;
4490 b->offset += b->step;
4491 b->offset %= b->image_size;
b6495fa8 4492 if (b->write) {
4baaa8c3 4493 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
b6495fa8 4494 } else {
4baaa8c3 4495 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
b6495fa8 4496 }
b6133b8c
KW
4497 if (!acb) {
4498 error_report("Failed to issue request");
4499 exit(EXIT_FAILURE);
4500 }
b6133b8c
KW
4501 }
4502}
4503
4504static int img_bench(int argc, char **argv)
4505{
4506 int c, ret = 0;
4507 const char *fmt = NULL, *filename;
4508 bool quiet = false;
4509 bool image_opts = false;
b6495fa8 4510 bool is_write = false;
b6133b8c
KW
4511 int count = 75000;
4512 int depth = 64;
d3199a31 4513 int64_t offset = 0;
b6133b8c 4514 size_t bufsize = 4096;
b6495fa8 4515 int pattern = 0;
83de9be0 4516 size_t step = 0;
55d539c8
KW
4517 int flush_interval = 0;
4518 bool drain_on_flush = true;
b6133b8c
KW
4519 int64_t image_size;
4520 BlockBackend *blk = NULL;
4521 BenchData data = {};
4522 int flags = 0;
604e8613 4523 bool writethrough = false;
b6133b8c
KW
4524 struct timeval t1, t2;
4525 int i;
335e9937 4526 bool force_share = false;
4f384011 4527 size_t buf_size = 0;
b6133b8c
KW
4528
4529 for (;;) {
4530 static const struct option long_options[] = {
4531 {"help", no_argument, 0, 'h'},
55d539c8 4532 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
b6133b8c 4533 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
b6495fa8 4534 {"pattern", required_argument, 0, OPTION_PATTERN},
55d539c8 4535 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
335e9937 4536 {"force-share", no_argument, 0, 'U'},
b6133b8c
KW
4537 {0, 0, 0, 0}
4538 };
cdd26774
AM
4539 c = getopt_long(argc, argv, ":hc:d:f:ni:o:qs:S:t:wU", long_options,
4540 NULL);
b6133b8c
KW
4541 if (c == -1) {
4542 break;
4543 }
4544
4545 switch (c) {
c9192973
SH
4546 case ':':
4547 missing_argument(argv[optind - 1]);
4548 break;
b6133b8c 4549 case '?':
c9192973
SH
4550 unrecognized_option(argv[optind - 1]);
4551 break;
4552 case 'h':
b6133b8c
KW
4553 help();
4554 break;
4555 case 'c':
4556 {
8b3c6792
PM
4557 unsigned long res;
4558
4559 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
b6133b8c
KW
4560 error_report("Invalid request count specified");
4561 return 1;
4562 }
8b3c6792 4563 count = res;
b6133b8c
KW
4564 break;
4565 }
4566 case 'd':
4567 {
8b3c6792
PM
4568 unsigned long res;
4569
4570 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
b6133b8c
KW
4571 error_report("Invalid queue depth specified");
4572 return 1;
4573 }
8b3c6792 4574 depth = res;
b6133b8c
KW
4575 break;
4576 }
4577 case 'f':
4578 fmt = optarg;
4579 break;
4580 case 'n':
4581 flags |= BDRV_O_NATIVE_AIO;
4582 break;
cdd26774
AM
4583 case 'i':
4584 ret = bdrv_parse_aio(optarg, &flags);
4585 if (ret < 0) {
4586 error_report("Invalid aio option: %s", optarg);
4587 ret = -1;
4588 goto out;
4589 }
4590 break;
d3199a31
KW
4591 case 'o':
4592 {
43d589b0 4593 offset = cvtnum("offset", optarg);
606caa0a 4594 if (offset < 0) {
d3199a31
KW
4595 return 1;
4596 }
4597 break;
4598 }
4599 break;
b6133b8c
KW
4600 case 'q':
4601 quiet = true;
4602 break;
4603 case 's':
4604 {
4605 int64_t sval;
b6133b8c 4606
43d589b0
EM
4607 sval = cvtnum_full("buffer size", optarg, 0, INT_MAX);
4608 if (sval < 0) {
b6133b8c
KW
4609 return 1;
4610 }
4611
4612 bufsize = sval;
4613 break;
4614 }
83de9be0
KW
4615 case 'S':
4616 {
4617 int64_t sval;
83de9be0 4618
43d589b0
EM
4619 sval = cvtnum_full("step_size", optarg, 0, INT_MAX);
4620 if (sval < 0) {
83de9be0
KW
4621 return 1;
4622 }
4623
4624 step = sval;
4625 break;
4626 }
b6133b8c
KW
4627 case 't':
4628 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4629 if (ret < 0) {
4630 error_report("Invalid cache mode");
4631 ret = -1;
4632 goto out;
4633 }
4634 break;
b6495fa8
KW
4635 case 'w':
4636 flags |= BDRV_O_RDWR;
4637 is_write = true;
4638 break;
335e9937
FZ
4639 case 'U':
4640 force_share = true;
4641 break;
b6495fa8
KW
4642 case OPTION_PATTERN:
4643 {
8b3c6792
PM
4644 unsigned long res;
4645
4646 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
b6495fa8
KW
4647 error_report("Invalid pattern byte specified");
4648 return 1;
4649 }
8b3c6792 4650 pattern = res;
b6495fa8
KW
4651 break;
4652 }
55d539c8
KW
4653 case OPTION_FLUSH_INTERVAL:
4654 {
8b3c6792
PM
4655 unsigned long res;
4656
4657 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
55d539c8
KW
4658 error_report("Invalid flush interval specified");
4659 return 1;
4660 }
8b3c6792 4661 flush_interval = res;
55d539c8
KW
4662 break;
4663 }
4664 case OPTION_NO_DRAIN:
4665 drain_on_flush = false;
4666 break;
b6133b8c
KW
4667 case OPTION_IMAGE_OPTS:
4668 image_opts = true;
4669 break;
4670 }
4671 }
4672
4673 if (optind != argc - 1) {
4674 error_exit("Expecting one image file name");
4675 }
4676 filename = argv[argc - 1];
4677
55d539c8
KW
4678 if (!is_write && flush_interval) {
4679 error_report("--flush-interval is only available in write tests");
4680 ret = -1;
4681 goto out;
4682 }
4683 if (flush_interval && flush_interval < depth) {
4684 error_report("Flush interval can't be smaller than depth");
4685 ret = -1;
4686 goto out;
4687 }
4688
335e9937
FZ
4689 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4690 force_share);
b6133b8c
KW
4691 if (!blk) {
4692 ret = -1;
4693 goto out;
4694 }
4695
4696 image_size = blk_getlength(blk);
4697 if (image_size < 0) {
4698 ret = image_size;
4699 goto out;
4700 }
4701
4702 data = (BenchData) {
55d539c8
KW
4703 .blk = blk,
4704 .image_size = image_size,
4705 .bufsize = bufsize,
4706 .step = step ?: bufsize,
4707 .nrreq = depth,
4708 .n = count,
4709 .offset = offset,
4710 .write = is_write,
4711 .flush_interval = flush_interval,
4712 .drain_on_flush = drain_on_flush,
b6133b8c 4713 };
d3199a31 4714 printf("Sending %d %s requests, %d bytes each, %d in parallel "
83de9be0 4715 "(starting at offset %" PRId64 ", step size %d)\n",
d3199a31 4716 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
83de9be0 4717 data.offset, data.step);
55d539c8
KW
4718 if (flush_interval) {
4719 printf("Sending flush every %d requests\n", flush_interval);
4720 }
b6133b8c 4721
79d46583
FZ
4722 buf_size = data.nrreq * data.bufsize;
4723 data.buf = blk_blockalign(blk, buf_size);
b6495fa8
KW
4724 memset(data.buf, pattern, data.nrreq * data.bufsize);
4725
f4ec04ba 4726 blk_register_buf(blk, data.buf, buf_size, &error_fatal);
79d46583 4727
b6133b8c
KW
4728 data.qiov = g_new(QEMUIOVector, data.nrreq);
4729 for (i = 0; i < data.nrreq; i++) {
4730 qemu_iovec_init(&data.qiov[i], 1);
4731 qemu_iovec_add(&data.qiov[i],
4732 data.buf + i * data.bufsize, data.bufsize);
4733 }
4734
4735 gettimeofday(&t1, NULL);
4736 bench_cb(&data, 0);
4737
4738 while (data.n > 0) {
4739 main_loop_wait(false);
4740 }
4741 gettimeofday(&t2, NULL);
4742
4743 printf("Run completed in %3.3f seconds.\n",
4744 (t2.tv_sec - t1.tv_sec)
4745 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4746
4747out:
79d46583 4748 if (data.buf) {
4f384011 4749 blk_unregister_buf(blk, data.buf, buf_size);
79d46583 4750 }
b6133b8c
KW
4751 qemu_vfree(data.buf);
4752 blk_unref(blk);
4753
4754 if (ret) {
86ce1f6e
RS
4755 return 1;
4756 }
4757 return 0;
4758}
4759
3b51ab4b
EB
4760enum ImgBitmapAct {
4761 BITMAP_ADD,
4762 BITMAP_REMOVE,
4763 BITMAP_CLEAR,
4764 BITMAP_ENABLE,
4765 BITMAP_DISABLE,
4766 BITMAP_MERGE,
4767};
4768typedef struct ImgBitmapAction {
4769 enum ImgBitmapAct act;
4770 const char *src; /* only used for merge */
4771 QSIMPLEQ_ENTRY(ImgBitmapAction) next;
4772} ImgBitmapAction;
4773
4774static int img_bitmap(int argc, char **argv)
4775{
4776 Error *err = NULL;
4777 int c, ret = 1;
4778 QemuOpts *opts = NULL;
4779 const char *fmt = NULL, *src_fmt = NULL, *src_filename = NULL;
4780 const char *filename, *bitmap;
4781 BlockBackend *blk = NULL, *src = NULL;
4782 BlockDriverState *bs = NULL, *src_bs = NULL;
4783 bool image_opts = false;
4784 int64_t granularity = 0;
4785 bool add = false, merge = false;
4786 QSIMPLEQ_HEAD(, ImgBitmapAction) actions;
4787 ImgBitmapAction *act, *act_next;
4788 const char *op;
c5e47711 4789 int inactivate_ret;
3b51ab4b
EB
4790
4791 QSIMPLEQ_INIT(&actions);
4792
4793 for (;;) {
4794 static const struct option long_options[] = {
4795 {"help", no_argument, 0, 'h'},
4796 {"object", required_argument, 0, OPTION_OBJECT},
4797 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4798 {"add", no_argument, 0, OPTION_ADD},
4799 {"remove", no_argument, 0, OPTION_REMOVE},
4800 {"clear", no_argument, 0, OPTION_CLEAR},
4801 {"enable", no_argument, 0, OPTION_ENABLE},
4802 {"disable", no_argument, 0, OPTION_DISABLE},
4803 {"merge", required_argument, 0, OPTION_MERGE},
4804 {"granularity", required_argument, 0, 'g'},
4805 {"source-file", required_argument, 0, 'b'},
4806 {"source-format", required_argument, 0, 'F'},
4807 {0, 0, 0, 0}
4808 };
4809 c = getopt_long(argc, argv, ":b:f:F:g:h", long_options, NULL);
4810 if (c == -1) {
4811 break;
4812 }
4813
4814 switch (c) {
4815 case ':':
4816 missing_argument(argv[optind - 1]);
4817 break;
4818 case '?':
4819 unrecognized_option(argv[optind - 1]);
4820 break;
4821 case 'h':
4822 help();
4823 break;
4824 case 'b':
4825 src_filename = optarg;
4826 break;
4827 case 'f':
4828 fmt = optarg;
4829 break;
4830 case 'F':
4831 src_fmt = optarg;
4832 break;
4833 case 'g':
4834 granularity = cvtnum("granularity", optarg);
4835 if (granularity < 0) {
4836 return 1;
4837 }
4838 break;
4839 case OPTION_ADD:
4840 act = g_new0(ImgBitmapAction, 1);
4841 act->act = BITMAP_ADD;
4842 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4843 add = true;
4844 break;
4845 case OPTION_REMOVE:
4846 act = g_new0(ImgBitmapAction, 1);
4847 act->act = BITMAP_REMOVE;
4848 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4849 break;
4850 case OPTION_CLEAR:
4851 act = g_new0(ImgBitmapAction, 1);
4852 act->act = BITMAP_CLEAR;
4853 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4854 break;
4855 case OPTION_ENABLE:
4856 act = g_new0(ImgBitmapAction, 1);
4857 act->act = BITMAP_ENABLE;
4858 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4859 break;
4860 case OPTION_DISABLE:
4861 act = g_new0(ImgBitmapAction, 1);
4862 act->act = BITMAP_DISABLE;
4863 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4864 break;
4865 case OPTION_MERGE:
4866 act = g_new0(ImgBitmapAction, 1);
4867 act->act = BITMAP_MERGE;
4868 act->src = optarg;
4869 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4870 merge = true;
4871 break;
4872 case OPTION_OBJECT:
99b1e646 4873 user_creatable_process_cmdline(optarg);
3b51ab4b
EB
4874 break;
4875 case OPTION_IMAGE_OPTS:
4876 image_opts = true;
4877 break;
4878 }
4879 }
4880
3b51ab4b
EB
4881 if (QSIMPLEQ_EMPTY(&actions)) {
4882 error_report("Need at least one of --add, --remove, --clear, "
4883 "--enable, --disable, or --merge");
4884 goto out;
4885 }
4886
4887 if (granularity && !add) {
4888 error_report("granularity only supported with --add");
4889 goto out;
4890 }
4891 if (src_fmt && !src_filename) {
4892 error_report("-F only supported with -b");
4893 goto out;
4894 }
4895 if (src_filename && !merge) {
4896 error_report("Merge bitmap source file only supported with "
4897 "--merge");
4898 goto out;
4899 }
4900
4901 if (optind != argc - 2) {
4902 error_report("Expecting filename and bitmap name");
4903 goto out;
4904 }
4905
4906 filename = argv[optind];
4907 bitmap = argv[optind + 1];
4908
14f16bf9
EB
4909 /*
4910 * No need to open backing chains; we will be manipulating bitmaps
4911 * directly in this image without reference to image contents.
4912 */
4913 blk = img_open(image_opts, filename, fmt, BDRV_O_RDWR | BDRV_O_NO_BACKING,
4914 false, false, false);
3b51ab4b
EB
4915 if (!blk) {
4916 goto out;
4917 }
4918 bs = blk_bs(blk);
4919 if (src_filename) {
14f16bf9
EB
4920 src = img_open(false, src_filename, src_fmt, BDRV_O_NO_BACKING,
4921 false, false, false);
3b51ab4b
EB
4922 if (!src) {
4923 goto out;
4924 }
4925 src_bs = blk_bs(src);
4926 } else {
4927 src_bs = bs;
4928 }
4929
4930 QSIMPLEQ_FOREACH_SAFE(act, &actions, next, act_next) {
4931 switch (act->act) {
4932 case BITMAP_ADD:
4933 qmp_block_dirty_bitmap_add(bs->node_name, bitmap,
4934 !!granularity, granularity, true, true,
4935 false, false, &err);
4936 op = "add";
4937 break;
4938 case BITMAP_REMOVE:
4939 qmp_block_dirty_bitmap_remove(bs->node_name, bitmap, &err);
4940 op = "remove";
4941 break;
4942 case BITMAP_CLEAR:
4943 qmp_block_dirty_bitmap_clear(bs->node_name, bitmap, &err);
4944 op = "clear";
4945 break;
4946 case BITMAP_ENABLE:
4947 qmp_block_dirty_bitmap_enable(bs->node_name, bitmap, &err);
4948 op = "enable";
4949 break;
4950 case BITMAP_DISABLE:
4951 qmp_block_dirty_bitmap_disable(bs->node_name, bitmap, &err);
4952 op = "disable";
4953 break;
6c729dd8
EB
4954 case BITMAP_MERGE:
4955 do_dirty_bitmap_merge(bs->node_name, bitmap, src_bs->node_name,
4956 act->src, &err);
3b51ab4b
EB
4957 op = "merge";
4958 break;
3b51ab4b
EB
4959 default:
4960 g_assert_not_reached();
4961 }
4962
4963 if (err) {
4964 error_reportf_err(err, "Operation %s on bitmap %s failed: ",
4965 op, bitmap);
4966 goto out;
4967 }
4968 g_free(act);
4969 }
4970
4971 ret = 0;
4972
4973 out:
c5e47711
KW
4974 /*
4975 * Manually inactivate the images first because this way we can know whether
4976 * an error occurred. blk_unref() doesn't tell us about failures.
4977 */
4978 inactivate_ret = bdrv_inactivate_all();
4979 if (inactivate_ret < 0) {
4980 error_report("Error while closing the image: %s", strerror(-inactivate_ret));
4981 ret = 1;
4982 }
4983
3b51ab4b
EB
4984 blk_unref(src);
4985 blk_unref(blk);
4986 qemu_opts_del(opts);
4987 return ret;
4988}
4989
86ce1f6e
RS
4990#define C_BS 01
4991#define C_COUNT 02
4992#define C_IF 04
4993#define C_OF 010
f7c15533 4994#define C_SKIP 020
86ce1f6e
RS
4995
4996struct DdInfo {
4997 unsigned int flags;
4998 int64_t count;
4999};
5000
5001struct DdIo {
5002 int bsz; /* Block size */
5003 char *filename;
5004 uint8_t *buf;
f7c15533 5005 int64_t offset;
86ce1f6e
RS
5006};
5007
5008struct DdOpts {
5009 const char *name;
5010 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
5011 unsigned int flag;
5012};
5013
5014static int img_dd_bs(const char *arg,
5015 struct DdIo *in, struct DdIo *out,
5016 struct DdInfo *dd)
5017{
86ce1f6e
RS
5018 int64_t res;
5019
43d589b0 5020 res = cvtnum_full("bs", arg, 1, INT_MAX);
86ce1f6e 5021
43d589b0 5022 if (res < 0) {
86ce1f6e
RS
5023 return 1;
5024 }
5025 in->bsz = out->bsz = res;
5026
5027 return 0;
5028}
5029
5030static int img_dd_count(const char *arg,
5031 struct DdIo *in, struct DdIo *out,
5032 struct DdInfo *dd)
5033{
43d589b0 5034 dd->count = cvtnum("count", arg);
86ce1f6e 5035
606caa0a 5036 if (dd->count < 0) {
86ce1f6e
RS
5037 return 1;
5038 }
5039
5040 return 0;
5041}
5042
5043static int img_dd_if(const char *arg,
5044 struct DdIo *in, struct DdIo *out,
5045 struct DdInfo *dd)
5046{
5047 in->filename = g_strdup(arg);
5048
5049 return 0;
5050}
5051
5052static int img_dd_of(const char *arg,
5053 struct DdIo *in, struct DdIo *out,
5054 struct DdInfo *dd)
5055{
5056 out->filename = g_strdup(arg);
5057
5058 return 0;
5059}
5060
f7c15533
RS
5061static int img_dd_skip(const char *arg,
5062 struct DdIo *in, struct DdIo *out,
5063 struct DdInfo *dd)
5064{
43d589b0 5065 in->offset = cvtnum("skip", arg);
f7c15533 5066
606caa0a 5067 if (in->offset < 0) {
f7c15533
RS
5068 return 1;
5069 }
5070
5071 return 0;
5072}
5073
86ce1f6e
RS
5074static int img_dd(int argc, char **argv)
5075{
5076 int ret = 0;
5077 char *arg = NULL;
5078 char *tmp;
5079 BlockDriver *drv = NULL, *proto_drv = NULL;
5080 BlockBackend *blk1 = NULL, *blk2 = NULL;
5081 QemuOpts *opts = NULL;
5082 QemuOptsList *create_opts = NULL;
5083 Error *local_err = NULL;
5084 bool image_opts = false;
5085 int c, i;
5086 const char *out_fmt = "raw";
5087 const char *fmt = NULL;
5088 int64_t size = 0;
0f48c47c 5089 int64_t out_pos, in_pos;
335e9937 5090 bool force_share = false;
86ce1f6e
RS
5091 struct DdInfo dd = {
5092 .flags = 0,
5093 .count = 0,
5094 };
5095 struct DdIo in = {
5096 .bsz = 512, /* Block size is by default 512 bytes */
5097 .filename = NULL,
f7c15533
RS
5098 .buf = NULL,
5099 .offset = 0
86ce1f6e
RS
5100 };
5101 struct DdIo out = {
5102 .bsz = 512,
5103 .filename = NULL,
f7c15533
RS
5104 .buf = NULL,
5105 .offset = 0
86ce1f6e
RS
5106 };
5107
5108 const struct DdOpts options[] = {
5109 { "bs", img_dd_bs, C_BS },
5110 { "count", img_dd_count, C_COUNT },
5111 { "if", img_dd_if, C_IF },
5112 { "of", img_dd_of, C_OF },
f7c15533 5113 { "skip", img_dd_skip, C_SKIP },
86ce1f6e
RS
5114 { NULL, NULL, 0 }
5115 };
5116 const struct option long_options[] = {
5117 { "help", no_argument, 0, 'h'},
83d4bf94 5118 { "object", required_argument, 0, OPTION_OBJECT},
86ce1f6e 5119 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 5120 { "force-share", no_argument, 0, 'U'},
86ce1f6e
RS
5121 { 0, 0, 0, 0 }
5122 };
5123
335e9937 5124 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
86ce1f6e
RS
5125 if (c == EOF) {
5126 break;
5127 }
5128 switch (c) {
5129 case 'O':
5130 out_fmt = optarg;
5131 break;
5132 case 'f':
5133 fmt = optarg;
5134 break;
c9192973
SH
5135 case ':':
5136 missing_argument(argv[optind - 1]);
5137 break;
86ce1f6e 5138 case '?':
c9192973
SH
5139 unrecognized_option(argv[optind - 1]);
5140 break;
86ce1f6e
RS
5141 case 'h':
5142 help();
5143 break;
335e9937
FZ
5144 case 'U':
5145 force_share = true;
5146 break;
2a245709 5147 case OPTION_OBJECT:
99b1e646 5148 user_creatable_process_cmdline(optarg);
2a245709 5149 break;
86ce1f6e
RS
5150 case OPTION_IMAGE_OPTS:
5151 image_opts = true;
5152 break;
5153 }
5154 }
5155
5156 for (i = optind; i < argc; i++) {
5157 int j;
5158 arg = g_strdup(argv[i]);
5159
5160 tmp = strchr(arg, '=');
5161 if (tmp == NULL) {
5162 error_report("unrecognized operand %s", arg);
5163 ret = -1;
5164 goto out;
5165 }
5166
5167 *tmp++ = '\0';
5168
5169 for (j = 0; options[j].name != NULL; j++) {
5170 if (!strcmp(arg, options[j].name)) {
5171 break;
5172 }
5173 }
5174 if (options[j].name == NULL) {
5175 error_report("unrecognized operand %s", arg);
5176 ret = -1;
5177 goto out;
5178 }
5179
5180 if (options[j].f(tmp, &in, &out, &dd) != 0) {
5181 ret = -1;
5182 goto out;
5183 }
5184 dd.flags |= options[j].flag;
5185 g_free(arg);
5186 arg = NULL;
5187 }
5188
5189 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
5190 error_report("Must specify both input and output files");
5191 ret = -1;
5192 goto out;
5193 }
83d4bf94 5194
335e9937
FZ
5195 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
5196 force_share);
86ce1f6e
RS
5197
5198 if (!blk1) {
5199 ret = -1;
5200 goto out;
5201 }
5202
5203 drv = bdrv_find_format(out_fmt);
5204 if (!drv) {
5205 error_report("Unknown file format");
5206 ret = -1;
5207 goto out;
5208 }
5209 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
5210
5211 if (!proto_drv) {
5212 error_report_err(local_err);
5213 ret = -1;
5214 goto out;
5215 }
5216 if (!drv->create_opts) {
5217 error_report("Format driver '%s' does not support image creation",
5218 drv->format_name);
5219 ret = -1;
5220 goto out;
5221 }
5222 if (!proto_drv->create_opts) {
5223 error_report("Protocol driver '%s' does not support image creation",
5224 proto_drv->format_name);
5225 ret = -1;
5226 goto out;
5227 }
5228 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5229 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
5230
5231 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5232
5233 size = blk_getlength(blk1);
5234 if (size < 0) {
5235 error_report("Failed to get size for '%s'", in.filename);
5236 ret = -1;
5237 goto out;
5238 }
5239
5240 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
5241 dd.count * in.bsz < size) {
5242 size = dd.count * in.bsz;
5243 }
5244
f7c15533
RS
5245 /* Overflow means the specified offset is beyond input image's size */
5246 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5247 size < in.bsz * in.offset)) {
5248 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
5249 } else {
5250 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
5251 size - in.bsz * in.offset, &error_abort);
5252 }
86ce1f6e
RS
5253
5254 ret = bdrv_create(drv, out.filename, opts, &local_err);
5255 if (ret < 0) {
5256 error_reportf_err(local_err,
5257 "%s: error while creating output image: ",
5258 out.filename);
5259 ret = -1;
5260 goto out;
5261 }
5262
ea204dda
DB
5263 /* TODO, we can't honour --image-opts for the target,
5264 * since it needs to be given in a format compatible
5265 * with the bdrv_create() call above which does not
5266 * support image-opts style.
5267 */
29cf9336 5268 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
ea204dda 5269 false, false, false);
86ce1f6e
RS
5270
5271 if (!blk2) {
5272 ret = -1;
5273 goto out;
5274 }
5275
f7c15533
RS
5276 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5277 size < in.offset * in.bsz)) {
5278 /* We give a warning if the skip option is bigger than the input
5279 * size and create an empty output disk image (i.e. like dd(1)).
5280 */
5281 error_report("%s: cannot skip to specified offset", in.filename);
5282 in_pos = size;
5283 } else {
5284 in_pos = in.offset * in.bsz;
5285 }
5286
86ce1f6e
RS
5287 in.buf = g_new(uint8_t, in.bsz);
5288
0f48c47c 5289 for (out_pos = 0; in_pos < size; ) {
bf5b16fa 5290 int bytes = (in_pos + in.bsz > size) ? size - in_pos : in.bsz;
86ce1f6e 5291
a9262f55 5292 ret = blk_pread(blk1, in_pos, bytes, in.buf, 0);
bf5b16fa 5293 if (ret < 0) {
86ce1f6e 5294 error_report("error while reading from input image file: %s",
bf5b16fa 5295 strerror(-ret));
86ce1f6e
RS
5296 goto out;
5297 }
bf5b16fa 5298 in_pos += bytes;
86ce1f6e 5299
a9262f55 5300 ret = blk_pwrite(blk2, out_pos, bytes, in.buf, 0);
bf5b16fa 5301 if (ret < 0) {
86ce1f6e 5302 error_report("error while writing to output image file: %s",
bf5b16fa 5303 strerror(-ret));
86ce1f6e
RS
5304 goto out;
5305 }
bf5b16fa 5306 out_pos += bytes;
86ce1f6e
RS
5307 }
5308
5309out:
5310 g_free(arg);
5311 qemu_opts_del(opts);
5312 qemu_opts_free(create_opts);
5313 blk_unref(blk1);
5314 blk_unref(blk2);
5315 g_free(in.filename);
5316 g_free(out.filename);
5317 g_free(in.buf);
5318 g_free(out.buf);
5319
5320 if (ret) {
b6133b8c
KW
5321 return 1;
5322 }
5323 return 0;
5324}
5325
fd03c2b8
SH
5326static void dump_json_block_measure_info(BlockMeasureInfo *info)
5327{
eab3a467 5328 GString *str;
fd03c2b8
SH
5329 QObject *obj;
5330 Visitor *v = qobject_output_visitor_new(&obj);
5331
5332 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
5333 visit_complete(v, &obj);
6589f459 5334 str = qobject_to_json_pretty(obj, true);
fd03c2b8 5335 assert(str != NULL);
eab3a467 5336 printf("%s\n", str->str);
cb3e7f08 5337 qobject_unref(obj);
fd03c2b8 5338 visit_free(v);
eab3a467 5339 g_string_free(str, true);
fd03c2b8
SH
5340}
5341
5342static int img_measure(int argc, char **argv)
5343{
5344 static const struct option long_options[] = {
5345 {"help", no_argument, 0, 'h'},
5346 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
5347 {"object", required_argument, 0, OPTION_OBJECT},
5348 {"output", required_argument, 0, OPTION_OUTPUT},
5349 {"size", required_argument, 0, OPTION_SIZE},
5350 {"force-share", no_argument, 0, 'U'},
5351 {0, 0, 0, 0}
5352 };
5353 OutputFormat output_format = OFORMAT_HUMAN;
5354 BlockBackend *in_blk = NULL;
5355 BlockDriver *drv;
5356 const char *filename = NULL;
5357 const char *fmt = NULL;
5358 const char *out_fmt = "raw";
5359 char *options = NULL;
5360 char *snapshot_name = NULL;
5361 bool force_share = false;
5362 QemuOpts *opts = NULL;
5363 QemuOpts *object_opts = NULL;
5364 QemuOpts *sn_opts = NULL;
5365 QemuOptsList *create_opts = NULL;
5366 bool image_opts = false;
5367 uint64_t img_size = UINT64_MAX;
5368 BlockMeasureInfo *info = NULL;
5369 Error *local_err = NULL;
5370 int ret = 1;
5371 int c;
5372
5373 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
5374 long_options, NULL)) != -1) {
5375 switch (c) {
5376 case '?':
5377 case 'h':
5378 help();
5379 break;
5380 case 'f':
5381 fmt = optarg;
5382 break;
5383 case 'O':
5384 out_fmt = optarg;
5385 break;
5386 case 'o':
6d2b5cba 5387 if (accumulate_options(&options, optarg) < 0) {
fd03c2b8
SH
5388 goto out;
5389 }
fd03c2b8
SH
5390 break;
5391 case 'l':
5392 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
5393 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
5394 optarg, false);
5395 if (!sn_opts) {
5396 error_report("Failed in parsing snapshot param '%s'",
5397 optarg);
5398 goto out;
5399 }
5400 } else {
5401 snapshot_name = optarg;
5402 }
5403 break;
5404 case 'U':
5405 force_share = true;
5406 break;
5407 case OPTION_OBJECT:
99b1e646 5408 user_creatable_process_cmdline(optarg);
fd03c2b8
SH
5409 break;
5410 case OPTION_IMAGE_OPTS:
5411 image_opts = true;
5412 break;
5413 case OPTION_OUTPUT:
5414 if (!strcmp(optarg, "json")) {
5415 output_format = OFORMAT_JSON;
5416 } else if (!strcmp(optarg, "human")) {
5417 output_format = OFORMAT_HUMAN;
5418 } else {
5419 error_report("--output must be used with human or json "
5420 "as argument.");
5421 goto out;
5422 }
5423 break;
5424 case OPTION_SIZE:
5425 {
5426 int64_t sval;
5427
43d589b0 5428 sval = cvtnum("image size", optarg);
fd03c2b8 5429 if (sval < 0) {
fd03c2b8
SH
5430 goto out;
5431 }
5432 img_size = (uint64_t)sval;
5433 }
5434 break;
5435 }
5436 }
5437
fd03c2b8
SH
5438 if (argc - optind > 1) {
5439 error_report("At most one filename argument is allowed.");
5440 goto out;
5441 } else if (argc - optind == 1) {
5442 filename = argv[optind];
5443 }
5444
c3673dcf
SH
5445 if (!filename && (image_opts || fmt || snapshot_name || sn_opts)) {
5446 error_report("--image-opts, -f, and -l require a filename argument.");
fd03c2b8
SH
5447 goto out;
5448 }
5449 if (filename && img_size != UINT64_MAX) {
5450 error_report("--size N cannot be used together with a filename.");
5451 goto out;
5452 }
5453 if (!filename && img_size == UINT64_MAX) {
5454 error_report("Either --size N or one filename must be specified.");
5455 goto out;
5456 }
5457
5458 if (filename) {
5459 in_blk = img_open(image_opts, filename, fmt, 0,
5460 false, false, force_share);
5461 if (!in_blk) {
5462 goto out;
5463 }
5464
5465 if (sn_opts) {
5466 bdrv_snapshot_load_tmp(blk_bs(in_blk),
5467 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
5468 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
5469 &local_err);
5470 } else if (snapshot_name != NULL) {
5471 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
5472 snapshot_name, &local_err);
5473 }
5474 if (local_err) {
5475 error_reportf_err(local_err, "Failed to load snapshot: ");
5476 goto out;
5477 }
5478 }
5479
5480 drv = bdrv_find_format(out_fmt);
5481 if (!drv) {
5482 error_report("Unknown file format '%s'", out_fmt);
5483 goto out;
5484 }
5485 if (!drv->create_opts) {
5486 error_report("Format driver '%s' does not support image creation",
5487 drv->format_name);
5488 goto out;
5489 }
5490
5491 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5492 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
5493 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5494 if (options) {
235e59cf 5495 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
fd03c2b8
SH
5496 error_report_err(local_err);
5497 error_report("Invalid options for file format '%s'", out_fmt);
5498 goto out;
5499 }
5500 }
5501 if (img_size != UINT64_MAX) {
5502 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
5503 }
5504
5505 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
5506 if (local_err) {
5507 error_report_err(local_err);
5508 goto out;
5509 }
5510
5511 if (output_format == OFORMAT_HUMAN) {
5512 printf("required size: %" PRIu64 "\n", info->required);
5513 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
5d72c68b
EB
5514 if (info->has_bitmaps) {
5515 printf("bitmaps size: %" PRIu64 "\n", info->bitmaps);
5516 }
fd03c2b8
SH
5517 } else {
5518 dump_json_block_measure_info(info);
5519 }
5520
5521 ret = 0;
5522
5523out:
5524 qapi_free_BlockMeasureInfo(info);
5525 qemu_opts_del(object_opts);
5526 qemu_opts_del(opts);
5527 qemu_opts_del(sn_opts);
5528 qemu_opts_free(create_opts);
5529 g_free(options);
5530 blk_unref(in_blk);
5531 return ret;
5532}
b6133b8c 5533
c227f099 5534static const img_cmd_t img_cmds[] = {
153859be
SB
5535#define DEF(option, callback, arg_string) \
5536 { option, callback },
5537#include "qemu-img-cmds.h"
5538#undef DEF
153859be
SB
5539 { NULL, NULL, },
5540};
5541
ea2384d3
FB
5542int main(int argc, char **argv)
5543{
c227f099 5544 const img_cmd_t *cmd;
153859be 5545 const char *cmdname;
7db1689c 5546 int c;
7db1689c
JC
5547 static const struct option long_options[] = {
5548 {"help", no_argument, 0, 'h'},
10985131 5549 {"version", no_argument, 0, 'V'},
06a1e0c1 5550 {"trace", required_argument, NULL, 'T'},
7db1689c
JC
5551 {0, 0, 0, 0}
5552 };
ea2384d3 5553
526eda14
MK
5554#ifdef CONFIG_POSIX
5555 signal(SIGPIPE, SIG_IGN);
5556#endif
5557
98c5d2e7 5558 socket_init();
f5852efa 5559 error_init(argv[0]);
fe4db84d 5560 module_call_init(MODULE_INIT_TRACE);
10f5bff6 5561 qemu_init_exec_dir(argv[0]);
53f76e58 5562
f9734d5d 5563 qemu_init_main_loop(&error_fatal);
2f78e491 5564
e8f2d272 5565 qcrypto_init(&error_fatal);
c2297088 5566
064097d9 5567 module_call_init(MODULE_INIT_QOM);
ea2384d3 5568 bdrv_init();
ac1307ab
FZ
5569 if (argc < 2) {
5570 error_exit("Not enough arguments");
5571 }
153859be 5572
eb769f74 5573 qemu_add_opts(&qemu_source_opts);
06a1e0c1 5574 qemu_add_opts(&qemu_trace_opts);
3babeb15 5575
c9192973 5576 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
10985131 5577 switch (c) {
c9192973
SH
5578 case ':':
5579 missing_argument(argv[optind - 1]);
5580 return 0;
4581c16f 5581 case '?':
c9192973
SH
5582 unrecognized_option(argv[optind - 1]);
5583 return 0;
5584 case 'h':
10985131
DL
5585 help();
5586 return 0;
5587 case 'V':
5588 printf(QEMU_IMG_VERSION);
5589 return 0;
06a1e0c1 5590 case 'T':
92eecfff 5591 trace_opt_parse(optarg);
06a1e0c1 5592 break;
153859be 5593 }
ea2384d3 5594 }
153859be 5595
10985131 5596 cmdname = argv[optind];
7db1689c 5597
10985131
DL
5598 /* reset getopt_long scanning */
5599 argc -= optind;
5600 if (argc < 1) {
5f6979cb
JC
5601 return 0;
5602 }
10985131 5603 argv += optind;
d339d766 5604 qemu_reset_optind();
10985131 5605
06a1e0c1
DL
5606 if (!trace_init_backends()) {
5607 exit(1);
5608 }
92eecfff 5609 trace_init_file();
c5955f4f 5610 qemu_set_log(LOG_TRACE, &error_fatal);
06a1e0c1 5611
10985131
DL
5612 /* find the command */
5613 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
5614 if (!strcmp(cmdname, cmd->name)) {
5615 return cmd->handler(argc, argv);
5616 }
5617 }
7db1689c 5618
153859be 5619 /* not found */
ac1307ab 5620 error_exit("Command not found: %s", cmdname);
ea2384d3 5621}