]> git.proxmox.com Git - mirror_qemu.git/blame - qemu-img.c
block: Add BDRV_O_RESIZE for blk_new_open()
[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 */
80c71a24 24#include "qemu/osdep.h"
67a1de0d 25#include "qemu-version.h"
da34e65c 26#include "qapi/error.h"
c054b3fd 27#include "qapi-visit.h"
b3db211f 28#include "qapi/qobject-output-visitor.h"
cc7a8ea7 29#include "qapi/qmp/qerror.h"
7b1b5d19 30#include "qapi/qmp/qjson.h"
f348b6d1 31#include "qemu/cutils.h"
3babeb15 32#include "qemu/config-file.h"
1de7afc9
PB
33#include "qemu/option.h"
34#include "qemu/error-report.h"
06a1e0c1 35#include "qemu/log.h"
3babeb15 36#include "qom/object_interfaces.h"
9c17d615 37#include "sysemu/sysemu.h"
26f54e9a 38#include "sysemu/block-backend.h"
737e150e 39#include "block/block_int.h"
d4a3238a 40#include "block/blockjob.h"
f364ec65 41#include "block/qapi.h"
c2297088 42#include "crypto/init.h"
06a1e0c1 43#include "trace/control.h"
c054b3fd 44#include <getopt.h>
e8445331 45
61979a6a 46#define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
0781dd6e 47 "\n" QEMU_COPYRIGHT "\n"
5f6979cb 48
c227f099 49typedef struct img_cmd_t {
153859be
SB
50 const char *name;
51 int (*handler)(int argc, char **argv);
c227f099 52} img_cmd_t;
153859be 53
8599ea4c
FS
54enum {
55 OPTION_OUTPUT = 256,
56 OPTION_BACKING_CHAIN = 257,
3babeb15 57 OPTION_OBJECT = 258,
eb769f74 58 OPTION_IMAGE_OPTS = 259,
b6495fa8 59 OPTION_PATTERN = 260,
55d539c8
KW
60 OPTION_FLUSH_INTERVAL = 261,
61 OPTION_NO_DRAIN = 262,
8599ea4c
FS
62};
63
64typedef enum OutputFormat {
65 OFORMAT_JSON,
66 OFORMAT_HUMAN,
67} OutputFormat;
68
e6996143 69/* Default to cache=writeback as data integrity is not important for qemu-img */
661a0f71 70#define BDRV_DEFAULT_CACHE "writeback"
137519ce 71
00c6d403 72static void format_print(void *opaque, const char *name)
ea2384d3 73{
00c6d403 74 printf(" %s", name);
ea2384d3
FB
75}
76
ac1307ab
FZ
77static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
78{
79 va_list ap;
80
81 error_printf("qemu-img: ");
82
83 va_start(ap, fmt);
84 error_vprintf(fmt, ap);
85 va_end(ap);
86
87 error_printf("\nTry 'qemu-img --help' for more information\n");
88 exit(EXIT_FAILURE);
89}
90
d2c639d6 91/* Please keep in synch with qemu-img.texi */
ac1307ab 92static void QEMU_NORETURN help(void)
ea2384d3 93{
e00291c0 94 const char *help_msg =
5f6979cb 95 QEMU_IMG_VERSION
10985131 96 "usage: qemu-img [standard options] command [command options]\n"
3f020d70 97 "QEMU disk image utility\n"
98 "\n"
10985131
DL
99 " '-h', '--help' display this help and exit\n"
100 " '-V', '--version' output version information and exit\n"
06a1e0c1
DL
101 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
102 " specify tracing options\n"
10985131 103 "\n"
3f020d70 104 "Command syntax:\n"
153859be
SB
105#define DEF(option, callback, arg_string) \
106 " " arg_string "\n"
107#include "qemu-img-cmds.h"
108#undef DEF
109#undef GEN_DOCS
3f020d70 110 "\n"
111 "Command parameters:\n"
112 " 'filename' is a disk image filename\n"
3babeb15
DB
113 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
114 " manual page for a description of the object properties. The most common\n"
115 " object type is a 'secret', which is used to supply passwords and/or\n"
116 " encryption keys.\n"
3f020d70 117 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
661a0f71 118 " 'cache' is the cache mode used to write the output disk image, the valid\n"
80ccf93b
LY
119 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
120 " 'directsync' and 'unsafe' (default for convert)\n"
bb87fdf8
SH
121 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
122 " options are the same as for the 'cache' option\n"
3f020d70 123 " 'size' is the disk image size in bytes. Optional suffixes\n"
5e00984a
KW
124 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
125 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
126 " supported. 'b' is ignored.\n"
3f020d70 127 " 'output_filename' is the destination disk image filename\n"
128 " 'output_fmt' is the destination format\n"
129 " 'options' is a comma separated list of format specific options in a\n"
130 " name=value format. Use -o ? for an overview of the options supported by the\n"
131 " used format\n"
ef80654d
WX
132 " 'snapshot_param' is param used for internal snapshot, format\n"
133 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
134 " '[ID_OR_NAME]'\n"
135 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
136 " instead\n"
3f020d70 137 " '-c' indicates that target image must be compressed (qcow format only)\n"
138 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
139 " match exactly. The image doesn't need a working backing file before\n"
140 " rebasing in this case (useful for renaming the backing file)\n"
141 " '-h' with or without a command shows this help and lists the supported formats\n"
6b837bc4 142 " '-p' show progress of command (only certain commands)\n"
f382d43a 143 " '-q' use Quiet mode - do not print any output (except errors)\n"
11b6699a
PL
144 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
145 " contain only zeros for qemu-img to create a sparse image during\n"
146 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
147 " unallocated or zero sectors, and the destination image will always be\n"
148 " fully allocated\n"
c054b3fd 149 " '--output' takes the format in which the output must be done (human or json)\n"
b2e10493
AD
150 " '-n' skips the target volume creation (useful if the volume is created\n"
151 " prior to running qemu-img)\n"
3f020d70 152 "\n"
4534ff54
KW
153 "Parameters to check subcommand:\n"
154 " '-r' tries to repair any inconsistencies that are found during the check.\n"
155 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
156 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
0546b8c2 157 " hiding corruption that has already occurred.\n"
4534ff54 158 "\n"
2d9187bc
PL
159 "Parameters to convert subcommand:\n"
160 " '-m' specifies how many coroutines work in parallel during the convert\n"
161 " process (defaults to 8)\n"
162 " '-W' allow to write to the target out of order rather than sequential\n"
163 "\n"
3f020d70 164 "Parameters to snapshot subcommand:\n"
165 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
166 " '-a' applies a snapshot (revert disk to saved state)\n"
167 " '-c' creates a snapshot\n"
168 " '-d' deletes a snapshot\n"
d14ed18c
MR
169 " '-l' lists all snapshots in the given image\n"
170 "\n"
171 "Parameters to compare subcommand:\n"
172 " '-f' first image format\n"
173 " '-F' second image format\n"
86ce1f6e
RS
174 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
175 "\n"
176 "Parameters to dd subcommand:\n"
177 " 'bs=BYTES' read and write up to BYTES bytes at a time "
178 "(default: 512)\n"
179 " 'count=N' copy only N input blocks\n"
180 " 'if=FILE' read from FILE\n"
f7c15533
RS
181 " 'of=FILE' write to FILE\n"
182 " 'skip=N' skip N bs-sized blocks at the start of input\n";
e00291c0
PB
183
184 printf("%s\nSupported formats:", help_msg);
00c6d403 185 bdrv_iterate_format(format_print, NULL);
ea2384d3 186 printf("\n");
ac1307ab 187 exit(EXIT_SUCCESS);
ea2384d3
FB
188}
189
3babeb15
DB
190static QemuOptsList qemu_object_opts = {
191 .name = "object",
192 .implied_opt_name = "qom-type",
193 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
194 .desc = {
195 { }
196 },
197};
198
eb769f74
DB
199static QemuOptsList qemu_source_opts = {
200 .name = "source",
201 .implied_opt_name = "file",
202 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
203 .desc = {
204 { }
205 },
206};
207
7c30f657 208static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
f382d43a
MR
209{
210 int ret = 0;
211 if (!quiet) {
212 va_list args;
213 va_start(args, fmt);
214 ret = vprintf(fmt, args);
215 va_end(args);
216 }
217 return ret;
218}
219
ea2384d3 220
4ac8aacd
JS
221static int print_block_option_help(const char *filename, const char *fmt)
222{
223 BlockDriver *drv, *proto_drv;
83d0521a 224 QemuOptsList *create_opts = NULL;
b65a5e12 225 Error *local_err = NULL;
4ac8aacd
JS
226
227 /* Find driver and parse its options */
228 drv = bdrv_find_format(fmt);
229 if (!drv) {
15654a6d 230 error_report("Unknown file format '%s'", fmt);
4ac8aacd
JS
231 return 1;
232 }
233
c282e1fd 234 create_opts = qemu_opts_append(create_opts, drv->create_opts);
a283cb6e 235 if (filename) {
b65a5e12 236 proto_drv = bdrv_find_protocol(filename, true, &local_err);
a283cb6e 237 if (!proto_drv) {
2867ce4a 238 error_report_err(local_err);
83d0521a 239 qemu_opts_free(create_opts);
a283cb6e
KW
240 return 1;
241 }
c282e1fd 242 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
a283cb6e
KW
243 }
244
83d0521a
CL
245 qemu_opts_print_help(create_opts);
246 qemu_opts_free(create_opts);
4ac8aacd
JS
247 return 0;
248}
249
eb769f74
DB
250
251static int img_open_password(BlockBackend *blk, const char *filename,
abb06c5a 252 int flags, bool quiet)
75c23805
FB
253{
254 BlockDriverState *bs;
75c23805 255 char password[256];
eb769f74
DB
256
257 bs = blk_bs(blk);
4ef130fc
DB
258 if (bdrv_is_encrypted(bs) && bdrv_key_required(bs) &&
259 !(flags & BDRV_O_NO_IO)) {
eb769f74
DB
260 qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
261 if (qemu_read_password(password, sizeof(password)) < 0) {
262 error_report("No password given");
263 return -1;
264 }
265 if (bdrv_set_key(bs, password) < 0) {
266 error_report("invalid password");
267 return -1;
268 }
269 }
270 return 0;
271}
272
273
efaa7c4e 274static BlockBackend *img_open_opts(const char *optstr,
ce099547 275 QemuOpts *opts, int flags, bool writethrough,
abb06c5a 276 bool quiet)
eb769f74
DB
277{
278 QDict *options;
279 Error *local_err = NULL;
280 BlockBackend *blk;
281 options = qemu_opts_to_qdict(opts, NULL);
efaa7c4e 282 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
eb769f74 283 if (!blk) {
143605a2 284 error_reportf_err(local_err, "Could not open '%s': ", optstr);
eb769f74
DB
285 return NULL;
286 }
ce099547 287 blk_set_enable_write_cache(blk, !writethrough);
eb769f74 288
abb06c5a 289 if (img_open_password(blk, optstr, flags, quiet) < 0) {
eb769f74
DB
290 blk_unref(blk);
291 return NULL;
292 }
293 return blk;
294}
295
efaa7c4e 296static BlockBackend *img_open_file(const char *filename,
eb769f74 297 const char *fmt, int flags,
ce099547 298 bool writethrough, bool quiet)
eb769f74
DB
299{
300 BlockBackend *blk;
34b5d2c6 301 Error *local_err = NULL;
5bd31326 302 QDict *options = NULL;
ad717139 303
75c23805 304 if (fmt) {
5bd31326
HR
305 options = qdict_new();
306 qdict_put(options, "driver", qstring_from_str(fmt));
75c23805 307 }
b9eaf9ec 308
efaa7c4e 309 blk = blk_new_open(filename, NULL, options, flags, &local_err);
5bd31326 310 if (!blk) {
c29b77f9 311 error_reportf_err(local_err, "Could not open '%s': ", filename);
eb769f74 312 return NULL;
75c23805 313 }
ce099547 314 blk_set_enable_write_cache(blk, !writethrough);
b9eaf9ec 315
abb06c5a 316 if (img_open_password(blk, filename, flags, quiet) < 0) {
eb769f74
DB
317 blk_unref(blk);
318 return NULL;
319 }
320 return blk;
321}
322
323
efaa7c4e 324static BlockBackend *img_open(bool image_opts,
eb769f74 325 const char *filename,
ce099547 326 const char *fmt, int flags, bool writethrough,
abb06c5a 327 bool quiet)
eb769f74
DB
328{
329 BlockBackend *blk;
330 if (image_opts) {
331 QemuOpts *opts;
332 if (fmt) {
333 error_report("--image-opts and --format are mutually exclusive");
334 return NULL;
335 }
336 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
337 filename, true);
338 if (!opts) {
339 return NULL;
340 }
ce099547 341 blk = img_open_opts(filename, opts, flags, writethrough, quiet);
eb769f74 342 } else {
ce099547 343 blk = img_open_file(filename, fmt, flags, writethrough, quiet);
75c23805 344 }
7e7d56d9 345 return blk;
75c23805
FB
346}
347
eb769f74 348
83d0521a 349static int add_old_style_options(const char *fmt, QemuOpts *opts,
eec77d9e
JS
350 const char *base_filename,
351 const char *base_fmt)
efa84d43 352{
6750e795
MA
353 Error *err = NULL;
354
efa84d43 355 if (base_filename) {
f43e47db 356 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
6750e795 357 if (err) {
15654a6d
JS
358 error_report("Backing file not supported for file format '%s'",
359 fmt);
6750e795 360 error_free(err);
c2abccec 361 return -1;
efa84d43
KW
362 }
363 }
364 if (base_fmt) {
f43e47db 365 qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
6750e795 366 if (err) {
15654a6d
JS
367 error_report("Backing file format not supported for file "
368 "format '%s'", fmt);
6750e795 369 error_free(err);
c2abccec 370 return -1;
efa84d43
KW
371 }
372 }
c2abccec 373 return 0;
efa84d43
KW
374}
375
606caa0a
MA
376static int64_t cvtnum(const char *s)
377{
f17fd4fd 378 int err;
f46bfdbf 379 uint64_t value;
606caa0a 380
f17fd4fd
MA
381 err = qemu_strtosz(s, NULL, &value);
382 if (err < 0) {
383 return err;
384 }
f46bfdbf
MA
385 if (value > INT64_MAX) {
386 return -ERANGE;
387 }
f17fd4fd 388 return value;
606caa0a
MA
389}
390
ea2384d3
FB
391static int img_create(int argc, char **argv)
392{
a9300911 393 int c;
1da7cfbd 394 uint64_t img_size = -1;
ea2384d3 395 const char *fmt = "raw";
9230eaf6 396 const char *base_fmt = NULL;
ea2384d3
FB
397 const char *filename;
398 const char *base_filename = NULL;
9ea2ea71 399 char *options = NULL;
9b37525a 400 Error *local_err = NULL;
f382d43a 401 bool quiet = false;
3b46e624 402
ea2384d3 403 for(;;) {
3babeb15
DB
404 static const struct option long_options[] = {
405 {"help", no_argument, 0, 'h'},
406 {"object", required_argument, 0, OPTION_OBJECT},
407 {0, 0, 0, 0}
408 };
409 c = getopt_long(argc, argv, "F:b:f:he6o:q",
410 long_options, NULL);
b8fb60da 411 if (c == -1) {
ea2384d3 412 break;
b8fb60da 413 }
ea2384d3 414 switch(c) {
ef87394c 415 case '?':
ea2384d3
FB
416 case 'h':
417 help();
418 break;
9230eaf6
AL
419 case 'F':
420 base_fmt = optarg;
421 break;
ea2384d3
FB
422 case 'b':
423 base_filename = optarg;
424 break;
425 case 'f':
426 fmt = optarg;
427 break;
428 case 'e':
9d42e15d 429 error_report("option -e is deprecated, please use \'-o "
eec77d9e 430 "encryption\' instead!");
77386bf6 431 goto fail;
d8871c5a 432 case '6':
9d42e15d 433 error_report("option -6 is deprecated, please use \'-o "
eec77d9e 434 "compat6\' instead!");
77386bf6 435 goto fail;
9ea2ea71 436 case 'o':
77386bf6
KW
437 if (!is_valid_option_list(optarg)) {
438 error_report("Invalid option list: %s", optarg);
439 goto fail;
440 }
441 if (!options) {
442 options = g_strdup(optarg);
443 } else {
444 char *old_options = options;
445 options = g_strdup_printf("%s,%s", options, optarg);
446 g_free(old_options);
447 }
9ea2ea71 448 break;
f382d43a
MR
449 case 'q':
450 quiet = true;
451 break;
3babeb15
DB
452 case OPTION_OBJECT: {
453 QemuOpts *opts;
454 opts = qemu_opts_parse_noisily(&qemu_object_opts,
455 optarg, true);
456 if (!opts) {
457 goto fail;
458 }
459 } break;
ea2384d3
FB
460 }
461 }
9230eaf6 462
b50cbabc 463 /* Get the filename */
a283cb6e
KW
464 filename = (optind < argc) ? argv[optind] : NULL;
465 if (options && has_help_option(options)) {
466 g_free(options);
467 return print_block_option_help(filename, fmt);
468 }
469
b8fb60da 470 if (optind >= argc) {
ac1307ab 471 error_exit("Expecting image file name");
b8fb60da 472 }
a283cb6e 473 optind++;
b50cbabc 474
3babeb15
DB
475 if (qemu_opts_foreach(&qemu_object_opts,
476 user_creatable_add_opts_foreach,
51b9b478 477 NULL, NULL)) {
3babeb15
DB
478 goto fail;
479 }
480
1da7cfbd
JS
481 /* Get image size, if specified */
482 if (optind < argc) {
70b4f4bb 483 int64_t sval;
606caa0a
MA
484
485 sval = cvtnum(argv[optind++]);
486 if (sval < 0) {
79443397
LG
487 if (sval == -ERANGE) {
488 error_report("Image size must be less than 8 EiB!");
489 } else {
490 error_report("Invalid image size specified! You may use k, M, "
5e00984a
KW
491 "G, T, P or E suffixes for ");
492 error_report("kilobytes, megabytes, gigabytes, terabytes, "
493 "petabytes and exabytes.");
79443397 494 }
77386bf6 495 goto fail;
1da7cfbd
JS
496 }
497 img_size = (uint64_t)sval;
498 }
fc11eb26 499 if (optind != argc) {
ac1307ab 500 error_exit("Unexpected argument: %s", argv[optind]);
fc11eb26 501 }
1da7cfbd 502
9b37525a 503 bdrv_img_create(filename, fmt, base_filename, base_fmt,
61de4c68 504 options, img_size, 0, &local_err, quiet);
84d18f06 505 if (local_err) {
c29b77f9 506 error_reportf_err(local_err, "%s: ", filename);
77386bf6 507 goto fail;
c2abccec 508 }
a9300911 509
77386bf6 510 g_free(options);
ea2384d3 511 return 0;
77386bf6
KW
512
513fail:
514 g_free(options);
515 return 1;
ea2384d3
FB
516}
517
f382d43a 518static void dump_json_image_check(ImageCheck *check, bool quiet)
8599ea4c 519{
8599ea4c 520 QString *str;
8599ea4c 521 QObject *obj;
7d5e199a 522 Visitor *v = qobject_output_visitor_new(&obj);
3b098d56
EB
523
524 visit_type_ImageCheck(v, NULL, &check, &error_abort);
525 visit_complete(v, &obj);
8599ea4c
FS
526 str = qobject_to_json_pretty(obj);
527 assert(str != NULL);
f382d43a 528 qprintf(quiet, "%s\n", qstring_get_str(str));
8599ea4c 529 qobject_decref(obj);
3b098d56 530 visit_free(v);
8599ea4c
FS
531 QDECREF(str);
532}
533
f382d43a 534static void dump_human_image_check(ImageCheck *check, bool quiet)
8599ea4c
FS
535{
536 if (!(check->corruptions || check->leaks || check->check_errors)) {
f382d43a 537 qprintf(quiet, "No errors were found on the image.\n");
8599ea4c
FS
538 } else {
539 if (check->corruptions) {
f382d43a
MR
540 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
541 "Data may be corrupted, or further writes to the image "
542 "may corrupt it.\n",
543 check->corruptions);
8599ea4c
FS
544 }
545
546 if (check->leaks) {
f382d43a
MR
547 qprintf(quiet,
548 "\n%" PRId64 " leaked clusters were found on the image.\n"
549 "This means waste of disk space, but no harm to data.\n",
550 check->leaks);
8599ea4c
FS
551 }
552
553 if (check->check_errors) {
f382d43a
MR
554 qprintf(quiet,
555 "\n%" PRId64
556 " internal errors have occurred during the check.\n",
557 check->check_errors);
8599ea4c
FS
558 }
559 }
560
561 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
f382d43a
MR
562 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
563 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
564 check->allocated_clusters, check->total_clusters,
565 check->allocated_clusters * 100.0 / check->total_clusters,
566 check->fragmented_clusters * 100.0 / check->allocated_clusters,
567 check->compressed_clusters * 100.0 /
568 check->allocated_clusters);
8599ea4c
FS
569 }
570
571 if (check->image_end_offset) {
f382d43a
MR
572 qprintf(quiet,
573 "Image end offset: %" PRId64 "\n", check->image_end_offset);
8599ea4c
FS
574 }
575}
576
577static int collect_image_check(BlockDriverState *bs,
578 ImageCheck *check,
579 const char *filename,
580 const char *fmt,
581 int fix)
582{
583 int ret;
584 BdrvCheckResult result;
585
586 ret = bdrv_check(bs, &result, fix);
587 if (ret < 0) {
588 return ret;
589 }
590
591 check->filename = g_strdup(filename);
592 check->format = g_strdup(bdrv_get_format_name(bs));
593 check->check_errors = result.check_errors;
594 check->corruptions = result.corruptions;
595 check->has_corruptions = result.corruptions != 0;
596 check->leaks = result.leaks;
597 check->has_leaks = result.leaks != 0;
598 check->corruptions_fixed = result.corruptions_fixed;
599 check->has_corruptions_fixed = result.corruptions != 0;
600 check->leaks_fixed = result.leaks_fixed;
601 check->has_leaks_fixed = result.leaks != 0;
602 check->image_end_offset = result.image_end_offset;
603 check->has_image_end_offset = result.image_end_offset != 0;
604 check->total_clusters = result.bfi.total_clusters;
605 check->has_total_clusters = result.bfi.total_clusters != 0;
606 check->allocated_clusters = result.bfi.allocated_clusters;
607 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
608 check->fragmented_clusters = result.bfi.fragmented_clusters;
609 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
e6439d78
SH
610 check->compressed_clusters = result.bfi.compressed_clusters;
611 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
8599ea4c
FS
612
613 return 0;
614}
615
e076f338
KW
616/*
617 * Checks an image for consistency. Exit codes:
618 *
d6635c4d
HR
619 * 0 - Check completed, image is good
620 * 1 - Check not completed because of internal errors
621 * 2 - Check completed, image is corrupted
622 * 3 - Check completed, image has leaked clusters, but is good otherwise
623 * 63 - Checks are not supported by the image format
e076f338 624 */
1585969c
AL
625static int img_check(int argc, char **argv)
626{
627 int c, ret;
8599ea4c 628 OutputFormat output_format = OFORMAT_HUMAN;
40055951 629 const char *filename, *fmt, *output, *cache;
26f54e9a 630 BlockBackend *blk;
1585969c 631 BlockDriverState *bs;
4534ff54 632 int fix = 0;
ce099547
KW
633 int flags = BDRV_O_CHECK;
634 bool writethrough;
7e7d56d9 635 ImageCheck *check;
f382d43a 636 bool quiet = false;
eb769f74 637 bool image_opts = false;
1585969c
AL
638
639 fmt = NULL;
8599ea4c 640 output = NULL;
40055951 641 cache = BDRV_DEFAULT_CACHE;
ce099547 642
1585969c 643 for(;;) {
8599ea4c
FS
644 int option_index = 0;
645 static const struct option long_options[] = {
646 {"help", no_argument, 0, 'h'},
647 {"format", required_argument, 0, 'f'},
4fd6a984 648 {"repair", required_argument, 0, 'r'},
8599ea4c 649 {"output", required_argument, 0, OPTION_OUTPUT},
3babeb15 650 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 651 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
8599ea4c
FS
652 {0, 0, 0, 0}
653 };
40055951 654 c = getopt_long(argc, argv, "hf:r:T:q",
8599ea4c 655 long_options, &option_index);
b8fb60da 656 if (c == -1) {
1585969c 657 break;
b8fb60da 658 }
1585969c 659 switch(c) {
ef87394c 660 case '?':
1585969c
AL
661 case 'h':
662 help();
663 break;
664 case 'f':
665 fmt = optarg;
666 break;
4534ff54
KW
667 case 'r':
668 flags |= BDRV_O_RDWR;
669
670 if (!strcmp(optarg, "leaks")) {
671 fix = BDRV_FIX_LEAKS;
672 } else if (!strcmp(optarg, "all")) {
673 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
674 } else {
ac1307ab
FZ
675 error_exit("Unknown option value for -r "
676 "(expecting 'leaks' or 'all'): %s", optarg);
4534ff54
KW
677 }
678 break;
8599ea4c
FS
679 case OPTION_OUTPUT:
680 output = optarg;
681 break;
40055951
HR
682 case 'T':
683 cache = optarg;
684 break;
f382d43a
MR
685 case 'q':
686 quiet = true;
687 break;
3babeb15
DB
688 case OPTION_OBJECT: {
689 QemuOpts *opts;
690 opts = qemu_opts_parse_noisily(&qemu_object_opts,
691 optarg, true);
692 if (!opts) {
693 return 1;
694 }
695 } break;
eb769f74
DB
696 case OPTION_IMAGE_OPTS:
697 image_opts = true;
698 break;
1585969c
AL
699 }
700 }
fc11eb26 701 if (optind != argc - 1) {
ac1307ab 702 error_exit("Expecting one image file name");
b8fb60da 703 }
1585969c
AL
704 filename = argv[optind++];
705
8599ea4c
FS
706 if (output && !strcmp(output, "json")) {
707 output_format = OFORMAT_JSON;
708 } else if (output && !strcmp(output, "human")) {
709 output_format = OFORMAT_HUMAN;
710 } else if (output) {
711 error_report("--output must be used with human or json as argument.");
712 return 1;
713 }
714
3babeb15
DB
715 if (qemu_opts_foreach(&qemu_object_opts,
716 user_creatable_add_opts_foreach,
51b9b478 717 NULL, NULL)) {
3babeb15
DB
718 return 1;
719 }
720
ce099547 721 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
40055951
HR
722 if (ret < 0) {
723 error_report("Invalid source cache option: %s", cache);
724 return 1;
725 }
726
ce099547 727 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
7e7d56d9
MA
728 if (!blk) {
729 return 1;
c2abccec 730 }
7e7d56d9 731 bs = blk_bs(blk);
8599ea4c
FS
732
733 check = g_new0(ImageCheck, 1);
734 ret = collect_image_check(bs, check, filename, fmt, fix);
e076f338
KW
735
736 if (ret == -ENOTSUP) {
55d492d7 737 error_report("This image format does not support checks");
fefddf95 738 ret = 63;
8599ea4c 739 goto fail;
e076f338
KW
740 }
741
8599ea4c
FS
742 if (check->corruptions_fixed || check->leaks_fixed) {
743 int corruptions_fixed, leaks_fixed;
ccf34716 744
8599ea4c
FS
745 leaks_fixed = check->leaks_fixed;
746 corruptions_fixed = check->corruptions_fixed;
e076f338 747
8599ea4c 748 if (output_format == OFORMAT_HUMAN) {
f382d43a
MR
749 qprintf(quiet,
750 "The following inconsistencies were found and repaired:\n\n"
751 " %" PRId64 " leaked clusters\n"
752 " %" PRId64 " corruptions\n\n"
753 "Double checking the fixed image now...\n",
754 check->leaks_fixed,
755 check->corruptions_fixed);
e076f338
KW
756 }
757
8599ea4c 758 ret = collect_image_check(bs, check, filename, fmt, 0);
1585969c 759
8599ea4c
FS
760 check->leaks_fixed = leaks_fixed;
761 check->corruptions_fixed = corruptions_fixed;
f8111c24
DXW
762 }
763
832390a5
HR
764 if (!ret) {
765 switch (output_format) {
766 case OFORMAT_HUMAN:
767 dump_human_image_check(check, quiet);
768 break;
769 case OFORMAT_JSON:
770 dump_json_image_check(check, quiet);
771 break;
772 }
c6bb9ad1
FS
773 }
774
8599ea4c 775 if (ret || check->check_errors) {
832390a5
HR
776 if (ret) {
777 error_report("Check failed: %s", strerror(-ret));
778 } else {
779 error_report("Check failed");
780 }
8599ea4c
FS
781 ret = 1;
782 goto fail;
c2abccec 783 }
e076f338 784
8599ea4c
FS
785 if (check->corruptions) {
786 ret = 2;
787 } else if (check->leaks) {
788 ret = 3;
e076f338 789 } else {
8599ea4c 790 ret = 0;
e076f338 791 }
8599ea4c
FS
792
793fail:
794 qapi_free_ImageCheck(check);
26f54e9a 795 blk_unref(blk);
8599ea4c 796 return ret;
1585969c
AL
797}
798
d4a3238a
HR
799typedef struct CommonBlockJobCBInfo {
800 BlockDriverState *bs;
801 Error **errp;
802} CommonBlockJobCBInfo;
803
804static void common_block_job_cb(void *opaque, int ret)
805{
806 CommonBlockJobCBInfo *cbi = opaque;
807
808 if (ret < 0) {
809 error_setg_errno(cbi->errp, -ret, "Block job failed");
810 }
d4a3238a
HR
811}
812
813static void run_block_job(BlockJob *job, Error **errp)
814{
b75536c9 815 AioContext *aio_context = blk_get_aio_context(job->blk);
d4a3238a 816
9e944cb4 817 aio_context_acquire(aio_context);
d4a3238a
HR
818 do {
819 aio_poll(aio_context, true);
62547b8a
JS
820 qemu_progress_print(job->len ?
821 ((float)job->offset / job->len * 100.f) : 0.0f, 0);
d4a3238a
HR
822 } while (!job->ready);
823
824 block_job_complete_sync(job, errp);
9e944cb4 825 aio_context_release(aio_context);
687fa1d8
HR
826
827 /* A block job may finish instantaneously without publishing any progress,
828 * so just signal completion here */
829 qemu_progress_print(100.f, 0);
d4a3238a
HR
830}
831
ea2384d3
FB
832static int img_commit(int argc, char **argv)
833{
661a0f71 834 int c, ret, flags;
1b22bffd 835 const char *filename, *fmt, *cache, *base;
26f54e9a 836 BlockBackend *blk;
d4a3238a 837 BlockDriverState *bs, *base_bs;
687fa1d8 838 bool progress = false, quiet = false, drop = false;
ce099547 839 bool writethrough;
d4a3238a
HR
840 Error *local_err = NULL;
841 CommonBlockJobCBInfo cbi;
eb769f74 842 bool image_opts = false;
9e944cb4 843 AioContext *aio_context;
ea2384d3
FB
844
845 fmt = NULL;
661a0f71 846 cache = BDRV_DEFAULT_CACHE;
1b22bffd 847 base = NULL;
ea2384d3 848 for(;;) {
3babeb15
DB
849 static const struct option long_options[] = {
850 {"help", no_argument, 0, 'h'},
851 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 852 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
853 {0, 0, 0, 0}
854 };
855 c = getopt_long(argc, argv, "f:ht:b:dpq",
856 long_options, NULL);
b8fb60da 857 if (c == -1) {
ea2384d3 858 break;
b8fb60da 859 }
ea2384d3 860 switch(c) {
ef87394c 861 case '?':
ea2384d3
FB
862 case 'h':
863 help();
864 break;
865 case 'f':
866 fmt = optarg;
867 break;
661a0f71
FS
868 case 't':
869 cache = optarg;
870 break;
1b22bffd
HR
871 case 'b':
872 base = optarg;
873 /* -b implies -d */
874 drop = true;
875 break;
9a86fe48
HR
876 case 'd':
877 drop = true;
878 break;
687fa1d8
HR
879 case 'p':
880 progress = true;
881 break;
f382d43a
MR
882 case 'q':
883 quiet = true;
884 break;
3babeb15
DB
885 case OPTION_OBJECT: {
886 QemuOpts *opts;
887 opts = qemu_opts_parse_noisily(&qemu_object_opts,
888 optarg, true);
889 if (!opts) {
890 return 1;
891 }
892 } break;
eb769f74
DB
893 case OPTION_IMAGE_OPTS:
894 image_opts = true;
895 break;
ea2384d3
FB
896 }
897 }
687fa1d8
HR
898
899 /* Progress is not shown in Quiet mode */
900 if (quiet) {
901 progress = false;
902 }
903
fc11eb26 904 if (optind != argc - 1) {
ac1307ab 905 error_exit("Expecting one image file name");
b8fb60da 906 }
ea2384d3
FB
907 filename = argv[optind++];
908
3babeb15
DB
909 if (qemu_opts_foreach(&qemu_object_opts,
910 user_creatable_add_opts_foreach,
51b9b478 911 NULL, NULL)) {
3babeb15
DB
912 return 1;
913 }
914
9a86fe48 915 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
ce099547 916 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
661a0f71
FS
917 if (ret < 0) {
918 error_report("Invalid cache option: %s", cache);
a3981eb9 919 return 1;
661a0f71
FS
920 }
921
ce099547 922 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
7e7d56d9
MA
923 if (!blk) {
924 return 1;
c2abccec 925 }
7e7d56d9
MA
926 bs = blk_bs(blk);
927
687fa1d8
HR
928 qemu_progress_init(progress, 1.f);
929 qemu_progress_print(0.f, 100);
930
1b22bffd
HR
931 if (base) {
932 base_bs = bdrv_find_backing_image(bs, base);
933 if (!base_bs) {
6b33f3ae
HR
934 error_setg(&local_err,
935 "Did not find '%s' in the backing chain of '%s'",
936 base, filename);
1b22bffd
HR
937 goto done;
938 }
939 } else {
940 /* This is different from QMP, which by default uses the deepest file in
941 * the backing chain (i.e., the very base); however, the traditional
942 * behavior of qemu-img commit is using the immediate backing file. */
760e0063 943 base_bs = backing_bs(bs);
1b22bffd
HR
944 if (!base_bs) {
945 error_setg(&local_err, "Image does not have a backing file");
946 goto done;
947 }
d4a3238a
HR
948 }
949
950 cbi = (CommonBlockJobCBInfo){
951 .errp = &local_err,
952 .bs = bs,
953 };
954
9e944cb4
PB
955 aio_context = bdrv_get_aio_context(bs);
956 aio_context_acquire(aio_context);
47970dfb
JS
957 commit_active_start("commit", bs, base_bs, BLOCK_JOB_DEFAULT, 0,
958 BLOCKDEV_ON_ERROR_REPORT, common_block_job_cb, &cbi,
959 &local_err, false);
9e944cb4 960 aio_context_release(aio_context);
d4a3238a
HR
961 if (local_err) {
962 goto done;
ea2384d3
FB
963 }
964
3f09bfbc
KW
965 /* When the block job completes, the BlockBackend reference will point to
966 * the old backing file. In order to avoid that the top image is already
967 * deleted, so we can still empty it afterwards, increment the reference
968 * counter here preemptively. */
9a86fe48 969 if (!drop) {
3f09bfbc 970 bdrv_ref(bs);
9a86fe48
HR
971 }
972
d4a3238a 973 run_block_job(bs->job, &local_err);
9a86fe48
HR
974 if (local_err) {
975 goto unref_backing;
976 }
977
3f09bfbc
KW
978 if (!drop && bs->drv->bdrv_make_empty) {
979 ret = bs->drv->bdrv_make_empty(bs);
9a86fe48
HR
980 if (ret) {
981 error_setg_errno(&local_err, -ret, "Could not empty %s",
982 filename);
983 goto unref_backing;
984 }
985 }
986
987unref_backing:
988 if (!drop) {
3f09bfbc 989 bdrv_unref(bs);
9a86fe48 990 }
d4a3238a
HR
991
992done:
687fa1d8
HR
993 qemu_progress_end();
994
26f54e9a 995 blk_unref(blk);
d4a3238a
HR
996
997 if (local_err) {
6936f299 998 error_report_err(local_err);
c2abccec
MK
999 return 1;
1000 }
d4a3238a
HR
1001
1002 qprintf(quiet, "Image committed.\n");
ea2384d3
FB
1003 return 0;
1004}
1005
f58c7b35
TS
1006/*
1007 * Returns true iff the first sector pointed to by 'buf' contains at least
1008 * a non-NUL byte.
1009 *
1010 * 'pnum' is set to the number of sectors (including and immediately following
1011 * the first one) that are known to be in the same allocated/unallocated state.
1012 */
ea2384d3
FB
1013static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
1014{
1a6d39fd
SH
1015 bool is_zero;
1016 int i;
ea2384d3
FB
1017
1018 if (n <= 0) {
1019 *pnum = 0;
1020 return 0;
1021 }
1a6d39fd 1022 is_zero = buffer_is_zero(buf, 512);
ea2384d3
FB
1023 for(i = 1; i < n; i++) {
1024 buf += 512;
1a6d39fd 1025 if (is_zero != buffer_is_zero(buf, 512)) {
ea2384d3 1026 break;
1a6d39fd 1027 }
ea2384d3
FB
1028 }
1029 *pnum = i;
1a6d39fd 1030 return !is_zero;
ea2384d3
FB
1031}
1032
a22f123c
KW
1033/*
1034 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1035 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1036 * breaking up write requests for only small sparse areas.
1037 */
1038static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
1039 int min)
1040{
1041 int ret;
1042 int num_checked, num_used;
1043
1044 if (n < min) {
1045 min = n;
1046 }
1047
1048 ret = is_allocated_sectors(buf, n, pnum);
1049 if (!ret) {
1050 return ret;
1051 }
1052
1053 num_used = *pnum;
1054 buf += BDRV_SECTOR_SIZE * *pnum;
1055 n -= *pnum;
1056 num_checked = num_used;
1057
1058 while (n > 0) {
1059 ret = is_allocated_sectors(buf, n, pnum);
1060
1061 buf += BDRV_SECTOR_SIZE * *pnum;
1062 n -= *pnum;
1063 num_checked += *pnum;
1064 if (ret) {
1065 num_used = num_checked;
1066 } else if (*pnum >= min) {
1067 break;
1068 }
1069 }
1070
1071 *pnum = num_used;
1072 return 1;
1073}
1074
3e85c6fd
KW
1075/*
1076 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1077 * buffers matches, non-zero otherwise.
1078 *
1079 * pnum is set to the number of sectors (including and immediately following
1080 * the first one) that are known to have the same comparison result
1081 */
1082static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
1083 int *pnum)
1084{
8c1ac475
RK
1085 bool res;
1086 int i;
3e85c6fd
KW
1087
1088 if (n <= 0) {
1089 *pnum = 0;
1090 return 0;
1091 }
1092
1093 res = !!memcmp(buf1, buf2, 512);
1094 for(i = 1; i < n; i++) {
1095 buf1 += 512;
1096 buf2 += 512;
1097
1098 if (!!memcmp(buf1, buf2, 512) != res) {
1099 break;
1100 }
1101 }
1102
1103 *pnum = i;
1104 return res;
1105}
1106
80ee15a6 1107#define IO_BUF_SIZE (2 * 1024 * 1024)
ea2384d3 1108
d14ed18c
MR
1109static int64_t sectors_to_bytes(int64_t sectors)
1110{
1111 return sectors << BDRV_SECTOR_BITS;
1112}
1113
1114static int64_t sectors_to_process(int64_t total, int64_t from)
1115{
1116 return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
1117}
1118
1119/*
1120 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1121 *
1122 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1123 * data and negative value on error.
1124 *
f1d3cd79 1125 * @param blk: BlockBackend for the image
d14ed18c
MR
1126 * @param sect_num: Number of first sector to check
1127 * @param sect_count: Number of sectors to check
1128 * @param filename: Name of disk file we are checking (logging purpose)
1129 * @param buffer: Allocated buffer for storing read data
1130 * @param quiet: Flag for quiet mode
1131 */
f1d3cd79 1132static int check_empty_sectors(BlockBackend *blk, int64_t sect_num,
d14ed18c
MR
1133 int sect_count, const char *filename,
1134 uint8_t *buffer, bool quiet)
1135{
1136 int pnum, ret = 0;
9166920a
EB
1137 ret = blk_pread(blk, sect_num << BDRV_SECTOR_BITS, buffer,
1138 sect_count << BDRV_SECTOR_BITS);
d14ed18c
MR
1139 if (ret < 0) {
1140 error_report("Error while reading offset %" PRId64 " of %s: %s",
1141 sectors_to_bytes(sect_num), filename, strerror(-ret));
1142 return ret;
1143 }
1144 ret = is_allocated_sectors(buffer, sect_count, &pnum);
1145 if (ret || pnum != sect_count) {
1146 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1147 sectors_to_bytes(ret ? sect_num : sect_num + pnum));
1148 return 1;
1149 }
1150
1151 return 0;
1152}
1153
1154/*
1155 * Compares two images. Exit codes:
1156 *
1157 * 0 - Images are identical
1158 * 1 - Images differ
1159 * >1 - Error occurred
1160 */
1161static int img_compare(int argc, char **argv)
1162{
40055951 1163 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
26f54e9a 1164 BlockBackend *blk1, *blk2;
d14ed18c
MR
1165 BlockDriverState *bs1, *bs2;
1166 int64_t total_sectors1, total_sectors2;
1167 uint8_t *buf1 = NULL, *buf2 = NULL;
1168 int pnum1, pnum2;
1169 int allocated1, allocated2;
1170 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1171 bool progress = false, quiet = false, strict = false;
40055951 1172 int flags;
ce099547 1173 bool writethrough;
d14ed18c
MR
1174 int64_t total_sectors;
1175 int64_t sector_num = 0;
1176 int64_t nb_sectors;
1177 int c, pnum;
d14ed18c 1178 uint64_t progress_base;
eb769f74 1179 bool image_opts = false;
d14ed18c 1180
40055951 1181 cache = BDRV_DEFAULT_CACHE;
d14ed18c 1182 for (;;) {
3babeb15
DB
1183 static const struct option long_options[] = {
1184 {"help", no_argument, 0, 'h'},
1185 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 1186 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
1187 {0, 0, 0, 0}
1188 };
1189 c = getopt_long(argc, argv, "hf:F:T:pqs",
1190 long_options, NULL);
d14ed18c
MR
1191 if (c == -1) {
1192 break;
1193 }
1194 switch (c) {
1195 case '?':
1196 case 'h':
1197 help();
1198 break;
1199 case 'f':
1200 fmt1 = optarg;
1201 break;
1202 case 'F':
1203 fmt2 = optarg;
1204 break;
40055951
HR
1205 case 'T':
1206 cache = optarg;
1207 break;
d14ed18c
MR
1208 case 'p':
1209 progress = true;
1210 break;
1211 case 'q':
1212 quiet = true;
1213 break;
1214 case 's':
1215 strict = true;
1216 break;
3babeb15
DB
1217 case OPTION_OBJECT: {
1218 QemuOpts *opts;
1219 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1220 optarg, true);
1221 if (!opts) {
1222 ret = 2;
1223 goto out4;
1224 }
1225 } break;
eb769f74
DB
1226 case OPTION_IMAGE_OPTS:
1227 image_opts = true;
1228 break;
d14ed18c
MR
1229 }
1230 }
1231
1232 /* Progress is not shown in Quiet mode */
1233 if (quiet) {
1234 progress = false;
1235 }
1236
1237
fc11eb26 1238 if (optind != argc - 2) {
ac1307ab 1239 error_exit("Expecting two image file names");
d14ed18c
MR
1240 }
1241 filename1 = argv[optind++];
1242 filename2 = argv[optind++];
1243
3babeb15
DB
1244 if (qemu_opts_foreach(&qemu_object_opts,
1245 user_creatable_add_opts_foreach,
51b9b478 1246 NULL, NULL)) {
3babeb15
DB
1247 ret = 2;
1248 goto out4;
1249 }
1250
cbda016d
SH
1251 /* Initialize before goto out */
1252 qemu_progress_init(progress, 2.0);
1253
ce099547
KW
1254 flags = 0;
1255 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
40055951
HR
1256 if (ret < 0) {
1257 error_report("Invalid source cache option: %s", cache);
1258 ret = 2;
1259 goto out3;
1260 }
1261
ce099547 1262 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet);
7e7d56d9 1263 if (!blk1) {
d14ed18c 1264 ret = 2;
7e7d56d9 1265 goto out3;
d14ed18c
MR
1266 }
1267
ce099547 1268 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet);
7e7d56d9 1269 if (!blk2) {
d14ed18c 1270 ret = 2;
7e7d56d9 1271 goto out2;
d14ed18c 1272 }
eb769f74 1273 bs1 = blk_bs(blk1);
7e7d56d9 1274 bs2 = blk_bs(blk2);
d14ed18c 1275
f1d3cd79
HR
1276 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1277 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1278 total_sectors1 = blk_nb_sectors(blk1);
52bf1e72
MA
1279 if (total_sectors1 < 0) {
1280 error_report("Can't get size of %s: %s",
1281 filename1, strerror(-total_sectors1));
1282 ret = 4;
1283 goto out;
1284 }
f1d3cd79 1285 total_sectors2 = blk_nb_sectors(blk2);
52bf1e72
MA
1286 if (total_sectors2 < 0) {
1287 error_report("Can't get size of %s: %s",
1288 filename2, strerror(-total_sectors2));
1289 ret = 4;
1290 goto out;
1291 }
d14ed18c
MR
1292 total_sectors = MIN(total_sectors1, total_sectors2);
1293 progress_base = MAX(total_sectors1, total_sectors2);
1294
1295 qemu_progress_print(0, 100);
1296
1297 if (strict && total_sectors1 != total_sectors2) {
1298 ret = 1;
1299 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1300 goto out;
1301 }
1302
1303 for (;;) {
25ad8e6e 1304 int64_t status1, status2;
67a0fd2a
FZ
1305 BlockDriverState *file;
1306
d14ed18c
MR
1307 nb_sectors = sectors_to_process(total_sectors, sector_num);
1308 if (nb_sectors <= 0) {
1309 break;
1310 }
25ad8e6e
FZ
1311 status1 = bdrv_get_block_status_above(bs1, NULL, sector_num,
1312 total_sectors1 - sector_num,
67a0fd2a 1313 &pnum1, &file);
25ad8e6e 1314 if (status1 < 0) {
d14ed18c
MR
1315 ret = 3;
1316 error_report("Sector allocation test failed for %s", filename1);
1317 goto out;
1318 }
25ad8e6e 1319 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
d14ed18c 1320
25ad8e6e
FZ
1321 status2 = bdrv_get_block_status_above(bs2, NULL, sector_num,
1322 total_sectors2 - sector_num,
67a0fd2a 1323 &pnum2, &file);
25ad8e6e 1324 if (status2 < 0) {
d14ed18c
MR
1325 ret = 3;
1326 error_report("Sector allocation test failed for %s", filename2);
1327 goto out;
1328 }
25ad8e6e
FZ
1329 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1330 if (pnum1) {
1331 nb_sectors = MIN(nb_sectors, pnum1);
1332 }
1333 if (pnum2) {
1334 nb_sectors = MIN(nb_sectors, pnum2);
1335 }
d14ed18c 1336
25ad8e6e
FZ
1337 if (strict) {
1338 if ((status1 & ~BDRV_BLOCK_OFFSET_MASK) !=
1339 (status2 & ~BDRV_BLOCK_OFFSET_MASK)) {
1340 ret = 1;
1341 qprintf(quiet, "Strict mode: Offset %" PRId64
1342 " block status mismatch!\n",
1343 sectors_to_bytes(sector_num));
1344 goto out;
1345 }
1346 }
1347 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1348 nb_sectors = MIN(pnum1, pnum2);
1349 } else if (allocated1 == allocated2) {
d14ed18c 1350 if (allocated1) {
9166920a
EB
1351 ret = blk_pread(blk1, sector_num << BDRV_SECTOR_BITS, buf1,
1352 nb_sectors << BDRV_SECTOR_BITS);
d14ed18c
MR
1353 if (ret < 0) {
1354 error_report("Error while reading offset %" PRId64 " of %s:"
1355 " %s", sectors_to_bytes(sector_num), filename1,
1356 strerror(-ret));
1357 ret = 4;
1358 goto out;
1359 }
9166920a
EB
1360 ret = blk_pread(blk2, sector_num << BDRV_SECTOR_BITS, buf2,
1361 nb_sectors << BDRV_SECTOR_BITS);
d14ed18c
MR
1362 if (ret < 0) {
1363 error_report("Error while reading offset %" PRId64
1364 " of %s: %s", sectors_to_bytes(sector_num),
1365 filename2, strerror(-ret));
1366 ret = 4;
1367 goto out;
1368 }
1369 ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
1370 if (ret || pnum != nb_sectors) {
d14ed18c
MR
1371 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1372 sectors_to_bytes(
1373 ret ? sector_num : sector_num + pnum));
36452f12 1374 ret = 1;
d14ed18c
MR
1375 goto out;
1376 }
1377 }
1378 } else {
d14ed18c
MR
1379
1380 if (allocated1) {
f1d3cd79 1381 ret = check_empty_sectors(blk1, sector_num, nb_sectors,
d14ed18c
MR
1382 filename1, buf1, quiet);
1383 } else {
f1d3cd79 1384 ret = check_empty_sectors(blk2, sector_num, nb_sectors,
d14ed18c
MR
1385 filename2, buf1, quiet);
1386 }
1387 if (ret) {
1388 if (ret < 0) {
d14ed18c
MR
1389 error_report("Error while reading offset %" PRId64 ": %s",
1390 sectors_to_bytes(sector_num), strerror(-ret));
36452f12 1391 ret = 4;
d14ed18c
MR
1392 }
1393 goto out;
1394 }
1395 }
1396 sector_num += nb_sectors;
1397 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1398 }
1399
1400 if (total_sectors1 != total_sectors2) {
f1d3cd79 1401 BlockBackend *blk_over;
d14ed18c
MR
1402 int64_t total_sectors_over;
1403 const char *filename_over;
1404
1405 qprintf(quiet, "Warning: Image size mismatch!\n");
1406 if (total_sectors1 > total_sectors2) {
1407 total_sectors_over = total_sectors1;
f1d3cd79 1408 blk_over = blk1;
d14ed18c
MR
1409 filename_over = filename1;
1410 } else {
1411 total_sectors_over = total_sectors2;
f1d3cd79 1412 blk_over = blk2;
d14ed18c
MR
1413 filename_over = filename2;
1414 }
1415
1416 for (;;) {
1417 nb_sectors = sectors_to_process(total_sectors_over, sector_num);
1418 if (nb_sectors <= 0) {
1419 break;
1420 }
f1d3cd79 1421 ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
d14ed18c
MR
1422 nb_sectors, &pnum);
1423 if (ret < 0) {
1424 ret = 3;
1425 error_report("Sector allocation test failed for %s",
1426 filename_over);
1427 goto out;
1428
1429 }
1430 nb_sectors = pnum;
1431 if (ret) {
f1d3cd79 1432 ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
d14ed18c
MR
1433 filename_over, buf1, quiet);
1434 if (ret) {
1435 if (ret < 0) {
d14ed18c
MR
1436 error_report("Error while reading offset %" PRId64
1437 " of %s: %s", sectors_to_bytes(sector_num),
1438 filename_over, strerror(-ret));
36452f12 1439 ret = 4;
d14ed18c
MR
1440 }
1441 goto out;
1442 }
1443 }
1444 sector_num += nb_sectors;
1445 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1446 }
1447 }
1448
1449 qprintf(quiet, "Images are identical.\n");
1450 ret = 0;
1451
1452out:
d14ed18c
MR
1453 qemu_vfree(buf1);
1454 qemu_vfree(buf2);
26f54e9a 1455 blk_unref(blk2);
d14ed18c 1456out2:
26f54e9a 1457 blk_unref(blk1);
d14ed18c
MR
1458out3:
1459 qemu_progress_end();
3babeb15 1460out4:
d14ed18c
MR
1461 return ret;
1462}
1463
690c7301
KW
1464enum ImgConvertBlockStatus {
1465 BLK_DATA,
1466 BLK_ZERO,
1467 BLK_BACKING_FILE,
1468};
1469
2d9187bc
PL
1470#define MAX_COROUTINES 16
1471
690c7301
KW
1472typedef struct ImgConvertState {
1473 BlockBackend **src;
1474 int64_t *src_sectors;
2d9187bc 1475 int src_num;
690c7301
KW
1476 int64_t total_sectors;
1477 int64_t allocated_sectors;
2d9187bc
PL
1478 int64_t allocated_done;
1479 int64_t sector_num;
1480 int64_t wr_offs;
690c7301
KW
1481 enum ImgConvertBlockStatus status;
1482 int64_t sector_next_status;
1483 BlockBackend *target;
1484 bool has_zero_init;
1485 bool compressed;
1486 bool target_has_backing;
2d9187bc 1487 bool wr_in_order;
690c7301
KW
1488 int min_sparse;
1489 size_t cluster_sectors;
1490 size_t buf_sectors;
2d9187bc
PL
1491 int num_coroutines;
1492 int running_coroutines;
1493 Coroutine *co[MAX_COROUTINES];
1494 int64_t wait_sector_num[MAX_COROUTINES];
1495 CoMutex lock;
1496 int ret;
690c7301
KW
1497} ImgConvertState;
1498
2d9187bc
PL
1499static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1500 int *src_cur, int64_t *src_cur_offset)
690c7301 1501{
2d9187bc
PL
1502 *src_cur = 0;
1503 *src_cur_offset = 0;
1504 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1505 *src_cur_offset += s->src_sectors[*src_cur];
1506 (*src_cur)++;
1507 assert(*src_cur < s->src_num);
690c7301
KW
1508 }
1509}
1510
1511static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1512{
2d9187bc
PL
1513 int64_t ret, src_cur_offset;
1514 int n, src_cur;
690c7301 1515
2d9187bc 1516 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
690c7301
KW
1517
1518 assert(s->total_sectors > sector_num);
1519 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1520
1521 if (s->sector_next_status <= sector_num) {
67a0fd2a 1522 BlockDriverState *file;
2d9187bc
PL
1523 ret = bdrv_get_block_status(blk_bs(s->src[src_cur]),
1524 sector_num - src_cur_offset,
67a0fd2a 1525 n, &n, &file);
690c7301
KW
1526 if (ret < 0) {
1527 return ret;
1528 }
1529
1530 if (ret & BDRV_BLOCK_ZERO) {
1531 s->status = BLK_ZERO;
1532 } else if (ret & BDRV_BLOCK_DATA) {
1533 s->status = BLK_DATA;
1534 } else if (!s->target_has_backing) {
1535 /* Without a target backing file we must copy over the contents of
1536 * the backing file as well. */
263a6f4c 1537 /* Check block status of the backing file chain to avoid
690c7301
KW
1538 * needlessly reading zeroes and limiting the iteration to the
1539 * buffer size */
2d9187bc
PL
1540 ret = bdrv_get_block_status_above(blk_bs(s->src[src_cur]), NULL,
1541 sector_num - src_cur_offset,
263a6f4c
RK
1542 n, &n, &file);
1543 if (ret < 0) {
1544 return ret;
1545 }
1546
1547 if (ret & BDRV_BLOCK_ZERO) {
1548 s->status = BLK_ZERO;
1549 } else {
1550 s->status = BLK_DATA;
1551 }
690c7301
KW
1552 } else {
1553 s->status = BLK_BACKING_FILE;
1554 }
1555
1556 s->sector_next_status = sector_num + n;
1557 }
1558
1559 n = MIN(n, s->sector_next_status - sector_num);
1560 if (s->status == BLK_DATA) {
1561 n = MIN(n, s->buf_sectors);
1562 }
1563
1564 /* We need to write complete clusters for compressed images, so if an
1565 * unallocated area is shorter than that, we must consider the whole
1566 * cluster allocated. */
1567 if (s->compressed) {
1568 if (n < s->cluster_sectors) {
1569 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1570 s->status = BLK_DATA;
1571 } else {
1572 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1573 }
1574 }
1575
1576 return n;
1577}
1578
2d9187bc
PL
1579static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1580 int nb_sectors, uint8_t *buf)
690c7301 1581{
2d9187bc
PL
1582 int n, ret;
1583 QEMUIOVector qiov;
1584 struct iovec iov;
690c7301 1585
690c7301
KW
1586 assert(nb_sectors <= s->buf_sectors);
1587 while (nb_sectors > 0) {
1588 BlockBackend *blk;
2d9187bc
PL
1589 int src_cur;
1590 int64_t bs_sectors, src_cur_offset;
690c7301
KW
1591
1592 /* In the case of compression with multiple source files, we can get a
1593 * nb_sectors that spreads into the next part. So we must be able to
1594 * read across multiple BDSes for one convert_read() call. */
2d9187bc
PL
1595 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1596 blk = s->src[src_cur];
1597 bs_sectors = s->src_sectors[src_cur];
1598
1599 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1600 iov.iov_base = buf;
1601 iov.iov_len = n << BDRV_SECTOR_BITS;
1602 qemu_iovec_init_external(&qiov, &iov, 1);
1603
1604 ret = blk_co_preadv(
1605 blk, (sector_num - src_cur_offset) << BDRV_SECTOR_BITS,
1606 n << BDRV_SECTOR_BITS, &qiov, 0);
690c7301
KW
1607 if (ret < 0) {
1608 return ret;
1609 }
1610
1611 sector_num += n;
1612 nb_sectors -= n;
1613 buf += n * BDRV_SECTOR_SIZE;
1614 }
1615
1616 return 0;
1617}
1618
2d9187bc
PL
1619
1620static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1621 int nb_sectors, uint8_t *buf,
1622 enum ImgConvertBlockStatus status)
690c7301
KW
1623{
1624 int ret;
2d9187bc
PL
1625 QEMUIOVector qiov;
1626 struct iovec iov;
690c7301
KW
1627
1628 while (nb_sectors > 0) {
1629 int n = nb_sectors;
2d9187bc 1630 switch (status) {
690c7301
KW
1631 case BLK_BACKING_FILE:
1632 /* If we have a backing file, leave clusters unallocated that are
1633 * unallocated in the source image, so that the backing file is
1634 * visible at the respective offset. */
1635 assert(s->target_has_backing);
1636 break;
1637
1638 case BLK_DATA:
1639 /* We must always write compressed clusters as a whole, so don't
1640 * try to find zeroed parts in the buffer. We can only save the
1641 * write if the buffer is completely zeroed and we're allowed to
1642 * keep the target sparse. */
1643 if (s->compressed) {
1644 if (s->has_zero_init && s->min_sparse &&
1645 buffer_is_zero(buf, n * BDRV_SECTOR_SIZE))
1646 {
1647 assert(!s->target_has_backing);
1648 break;
1649 }
1650
2d9187bc
PL
1651 iov.iov_base = buf;
1652 iov.iov_len = n << BDRV_SECTOR_BITS;
1653 qemu_iovec_init_external(&qiov, &iov, 1);
1654
1655 ret = blk_co_pwritev(s->target, sector_num << BDRV_SECTOR_BITS,
1656 n << BDRV_SECTOR_BITS, &qiov,
1657 BDRV_REQ_WRITE_COMPRESSED);
690c7301
KW
1658 if (ret < 0) {
1659 return ret;
1660 }
1661 break;
1662 }
1663
1664 /* If there is real non-zero data or we're told to keep the target
1665 * fully allocated (-S 0), we must write it. Otherwise we can treat
1666 * it as zero sectors. */
1667 if (!s->min_sparse ||
1668 is_allocated_sectors_min(buf, n, &n, s->min_sparse))
1669 {
2d9187bc
PL
1670 iov.iov_base = buf;
1671 iov.iov_len = n << BDRV_SECTOR_BITS;
1672 qemu_iovec_init_external(&qiov, &iov, 1);
1673
1674 ret = blk_co_pwritev(s->target, sector_num << BDRV_SECTOR_BITS,
1675 n << BDRV_SECTOR_BITS, &qiov, 0);
690c7301
KW
1676 if (ret < 0) {
1677 return ret;
1678 }
1679 break;
1680 }
1681 /* fall-through */
1682
1683 case BLK_ZERO:
1684 if (s->has_zero_init) {
1685 break;
1686 }
2d9187bc
PL
1687 ret = blk_co_pwrite_zeroes(s->target,
1688 sector_num << BDRV_SECTOR_BITS,
1689 n << BDRV_SECTOR_BITS, 0);
690c7301
KW
1690 if (ret < 0) {
1691 return ret;
1692 }
1693 break;
1694 }
1695
1696 sector_num += n;
1697 nb_sectors -= n;
1698 buf += n * BDRV_SECTOR_SIZE;
1699 }
1700
1701 return 0;
1702}
1703
2d9187bc 1704static void coroutine_fn convert_co_do_copy(void *opaque)
690c7301 1705{
2d9187bc 1706 ImgConvertState *s = opaque;
690c7301 1707 uint8_t *buf = NULL;
2d9187bc
PL
1708 int ret, i;
1709 int index = -1;
1710
1711 for (i = 0; i < s->num_coroutines; i++) {
1712 if (s->co[i] == qemu_coroutine_self()) {
1713 index = i;
1714 break;
1715 }
1716 }
1717 assert(index >= 0);
1718
1719 s->running_coroutines++;
1720 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1721
1722 while (1) {
1723 int n;
1724 int64_t sector_num;
1725 enum ImgConvertBlockStatus status;
1726
1727 qemu_co_mutex_lock(&s->lock);
1728 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1729 qemu_co_mutex_unlock(&s->lock);
1730 goto out;
1731 }
1732 n = convert_iteration_sectors(s, s->sector_num);
1733 if (n < 0) {
1734 qemu_co_mutex_unlock(&s->lock);
1735 s->ret = n;
1736 goto out;
1737 }
1738 /* save current sector and allocation status to local variables */
1739 sector_num = s->sector_num;
1740 status = s->status;
1741 if (!s->min_sparse && s->status == BLK_ZERO) {
1742 n = MIN(n, s->buf_sectors);
1743 }
1744 /* increment global sector counter so that other coroutines can
1745 * already continue reading beyond this request */
1746 s->sector_num += n;
1747 qemu_co_mutex_unlock(&s->lock);
1748
1749 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
1750 s->allocated_done += n;
1751 qemu_progress_print(100.0 * s->allocated_done /
1752 s->allocated_sectors, 0);
1753 }
1754
1755 if (status == BLK_DATA) {
1756 ret = convert_co_read(s, sector_num, n, buf);
1757 if (ret < 0) {
1758 error_report("error while reading sector %" PRId64
1759 ": %s", sector_num, strerror(-ret));
1760 s->ret = ret;
1761 goto out;
1762 }
1763 } else if (!s->min_sparse && status == BLK_ZERO) {
1764 status = BLK_DATA;
1765 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
1766 }
1767
1768 if (s->wr_in_order) {
1769 /* keep writes in order */
1770 while (s->wr_offs != sector_num) {
1771 if (s->ret != -EINPROGRESS) {
1772 goto out;
1773 }
1774 s->wait_sector_num[index] = sector_num;
1775 qemu_coroutine_yield();
1776 }
1777 s->wait_sector_num[index] = -1;
1778 }
1779
1780 ret = convert_co_write(s, sector_num, n, buf, status);
1781 if (ret < 0) {
1782 error_report("error while writing sector %" PRId64
1783 ": %s", sector_num, strerror(-ret));
1784 s->ret = ret;
1785 goto out;
1786 }
1787
1788 if (s->wr_in_order) {
1789 /* reenter the coroutine that might have waited
1790 * for this write to complete */
1791 s->wr_offs = sector_num + n;
1792 for (i = 0; i < s->num_coroutines; i++) {
1793 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
1794 /*
1795 * A -> B -> A cannot occur because A has
1796 * s->wait_sector_num[i] == -1 during A -> B. Therefore
1797 * B will never enter A during this time window.
1798 */
1799 qemu_coroutine_enter(s->co[i]);
1800 break;
1801 }
1802 }
1803 }
1804 }
1805
1806out:
1807 qemu_vfree(buf);
1808 s->co[index] = NULL;
1809 s->running_coroutines--;
1810 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
1811 /* the convert job finished successfully */
1812 s->ret = 0;
1813 }
1814}
1815
1816static int convert_do_copy(ImgConvertState *s)
1817{
1818 int ret, i, n;
1819 int64_t sector_num = 0;
690c7301
KW
1820
1821 /* Check whether we have zero initialisation or can get it efficiently */
1822 s->has_zero_init = s->min_sparse && !s->target_has_backing
1823 ? bdrv_has_zero_init(blk_bs(s->target))
1824 : false;
1825
1826 if (!s->has_zero_init && !s->target_has_backing &&
1827 bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
1828 {
720ff280 1829 ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP);
690c7301
KW
1830 if (ret == 0) {
1831 s->has_zero_init = true;
1832 }
1833 }
1834
1835 /* Allocate buffer for copied data. For compressed images, only one cluster
1836 * can be copied at a time. */
1837 if (s->compressed) {
1838 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
1839 error_report("invalid cluster size");
2d9187bc 1840 return -EINVAL;
690c7301
KW
1841 }
1842 s->buf_sectors = s->cluster_sectors;
1843 }
690c7301 1844
690c7301
KW
1845 while (sector_num < s->total_sectors) {
1846 n = convert_iteration_sectors(s, sector_num);
1847 if (n < 0) {
2d9187bc 1848 return n;
690c7301 1849 }
aad15de4
HR
1850 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1851 {
690c7301
KW
1852 s->allocated_sectors += n;
1853 }
1854 sector_num += n;
1855 }
1856
1857 /* Do the copy */
690c7301 1858 s->sector_next_status = 0;
2d9187bc 1859 s->ret = -EINPROGRESS;
690c7301 1860
2d9187bc
PL
1861 qemu_co_mutex_init(&s->lock);
1862 for (i = 0; i < s->num_coroutines; i++) {
1863 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
1864 s->wait_sector_num[i] = -1;
1865 qemu_coroutine_enter(s->co[i]);
1866 }
690c7301 1867
2d9187bc
PL
1868 while (s->ret == -EINPROGRESS) {
1869 main_loop_wait(false);
690c7301
KW
1870 }
1871
2d9187bc 1872 if (s->compressed && !s->ret) {
690c7301 1873 /* signal EOF to align */
fe5c1355 1874 ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
690c7301 1875 if (ret < 0) {
2d9187bc 1876 return ret;
690c7301
KW
1877 }
1878 }
1879
2d9187bc 1880 return s->ret;
690c7301
KW
1881}
1882
ea2384d3
FB
1883static int img_convert(int argc, char **argv)
1884{
690c7301 1885 int c, bs_n, bs_i, compress, cluster_sectors, skip_create;
13c28af8 1886 int64_t ret = 0;
40055951 1887 int progress = 0, flags, src_flags;
ce099547 1888 bool writethrough, src_writethrough;
40055951 1889 const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
b50cbabc 1890 BlockDriver *drv, *proto_drv;
26f54e9a 1891 BlockBackend **blk = NULL, *out_blk = NULL;
c2abccec 1892 BlockDriverState **bs = NULL, *out_bs = NULL;
690c7301 1893 int64_t total_sectors;
52bf1e72 1894 int64_t *bs_sectors = NULL;
f2521c90 1895 size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
faea38e7 1896 BlockDriverInfo bdi;
83d0521a
CL
1897 QemuOpts *opts = NULL;
1898 QemuOptsList *create_opts = NULL;
1899 const char *out_baseimg_param;
efa84d43 1900 char *options = NULL;
51ef6727 1901 const char *snapshot_name = NULL;
a22f123c 1902 int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
f382d43a 1903 bool quiet = false;
cc84d90f 1904 Error *local_err = NULL;
ef80654d 1905 QemuOpts *sn_opts = NULL;
690c7301 1906 ImgConvertState state;
eb769f74 1907 bool image_opts = false;
2d9187bc
PL
1908 bool wr_in_order = true;
1909 long num_coroutines = 8;
ea2384d3
FB
1910
1911 fmt = NULL;
1912 out_fmt = "raw";
661a0f71 1913 cache = "unsafe";
40055951 1914 src_cache = BDRV_DEFAULT_CACHE;
f58c7b35 1915 out_baseimg = NULL;
eec77d9e 1916 compress = 0;
b2e10493 1917 skip_create = 0;
ea2384d3 1918 for(;;) {
3babeb15
DB
1919 static const struct option long_options[] = {
1920 {"help", no_argument, 0, 'h'},
1921 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 1922 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
1923 {0, 0, 0, 0}
1924 };
2d9187bc 1925 c = getopt_long(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qnm:W",
3babeb15 1926 long_options, NULL);
b8fb60da 1927 if (c == -1) {
ea2384d3 1928 break;
b8fb60da 1929 }
ea2384d3 1930 switch(c) {
ef87394c 1931 case '?':
ea2384d3
FB
1932 case 'h':
1933 help();
1934 break;
1935 case 'f':
1936 fmt = optarg;
1937 break;
1938 case 'O':
1939 out_fmt = optarg;
1940 break;
f58c7b35
TS
1941 case 'B':
1942 out_baseimg = optarg;
1943 break;
ea2384d3 1944 case 'c':
eec77d9e 1945 compress = 1;
ea2384d3
FB
1946 break;
1947 case 'e':
9d42e15d 1948 error_report("option -e is deprecated, please use \'-o "
eec77d9e 1949 "encryption\' instead!");
2dc8328b 1950 ret = -1;
64bb01aa 1951 goto fail_getopt;
ec36ba14 1952 case '6':
9d42e15d 1953 error_report("option -6 is deprecated, please use \'-o "
eec77d9e 1954 "compat6\' instead!");
2dc8328b 1955 ret = -1;
64bb01aa 1956 goto fail_getopt;
efa84d43 1957 case 'o':
2dc8328b
KW
1958 if (!is_valid_option_list(optarg)) {
1959 error_report("Invalid option list: %s", optarg);
1960 ret = -1;
64bb01aa 1961 goto fail_getopt;
2dc8328b
KW
1962 }
1963 if (!options) {
1964 options = g_strdup(optarg);
1965 } else {
1966 char *old_options = options;
1967 options = g_strdup_printf("%s,%s", options, optarg);
1968 g_free(old_options);
1969 }
efa84d43 1970 break;
51ef6727 1971 case 's':
1972 snapshot_name = optarg;
1973 break;
ef80654d
WX
1974 case 'l':
1975 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
70b94331
MA
1976 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
1977 optarg, false);
ef80654d
WX
1978 if (!sn_opts) {
1979 error_report("Failed in parsing snapshot param '%s'",
1980 optarg);
2dc8328b 1981 ret = -1;
64bb01aa 1982 goto fail_getopt;
ef80654d
WX
1983 }
1984 } else {
1985 snapshot_name = optarg;
1986 }
1987 break;
a22f123c
KW
1988 case 'S':
1989 {
1990 int64_t sval;
606caa0a
MA
1991
1992 sval = cvtnum(optarg);
1993 if (sval < 0) {
a22f123c 1994 error_report("Invalid minimum zero buffer size for sparse output specified");
2dc8328b 1995 ret = -1;
64bb01aa 1996 goto fail_getopt;
a22f123c
KW
1997 }
1998
1999 min_sparse = sval / BDRV_SECTOR_SIZE;
2000 break;
2001 }
6b837bc4
JS
2002 case 'p':
2003 progress = 1;
2004 break;
661a0f71
FS
2005 case 't':
2006 cache = optarg;
2007 break;
40055951
HR
2008 case 'T':
2009 src_cache = optarg;
2010 break;
f382d43a
MR
2011 case 'q':
2012 quiet = true;
2013 break;
b2e10493
AD
2014 case 'n':
2015 skip_create = 1;
2016 break;
2d9187bc
PL
2017 case 'm':
2018 if (qemu_strtol(optarg, NULL, 0, &num_coroutines) ||
2019 num_coroutines < 1 || num_coroutines > MAX_COROUTINES) {
2020 error_report("Invalid number of coroutines. Allowed number of"
2021 " coroutines is between 1 and %d", MAX_COROUTINES);
2022 ret = -1;
2023 goto fail_getopt;
2024 }
2025 break;
2026 case 'W':
2027 wr_in_order = false;
2028 break;
3babeb15
DB
2029 case OPTION_OBJECT:
2030 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2031 optarg, true);
2032 if (!opts) {
2033 goto fail_getopt;
2034 }
2035 break;
eb769f74
DB
2036 case OPTION_IMAGE_OPTS:
2037 image_opts = true;
2038 break;
ea2384d3
FB
2039 }
2040 }
3b46e624 2041
3babeb15
DB
2042 if (qemu_opts_foreach(&qemu_object_opts,
2043 user_creatable_add_opts_foreach,
51b9b478 2044 NULL, NULL)) {
3babeb15
DB
2045 goto fail_getopt;
2046 }
2047
2d9187bc
PL
2048 if (!wr_in_order && compress) {
2049 error_report("Out of order write and compress are mutually exclusive");
2050 ret = -1;
2051 goto fail_getopt;
2052 }
2053
64bb01aa 2054 /* Initialize before goto out */
f382d43a
MR
2055 if (quiet) {
2056 progress = 0;
2057 }
64bb01aa
KW
2058 qemu_progress_init(progress, 1.0);
2059
926c2d23 2060 bs_n = argc - optind - 1;
a283cb6e 2061 out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
f58c7b35 2062
2dc8328b 2063 if (options && has_help_option(options)) {
4ac8aacd
JS
2064 ret = print_block_option_help(out_filename, out_fmt);
2065 goto out;
2066 }
2067
a283cb6e 2068 if (bs_n < 1) {
ac1307ab 2069 error_exit("Must specify image file name");
a283cb6e
KW
2070 }
2071
2072
c2abccec 2073 if (bs_n > 1 && out_baseimg) {
15654a6d
JS
2074 error_report("-B makes no sense when concatenating multiple input "
2075 "images");
31ca34b8
JS
2076 ret = -1;
2077 goto out;
c2abccec 2078 }
f8111c24 2079
ce099547
KW
2080 src_flags = 0;
2081 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
40055951
HR
2082 if (ret < 0) {
2083 error_report("Invalid source cache option: %s", src_cache);
2084 goto out;
2085 }
2086
6b837bc4
JS
2087 qemu_progress_print(0, 100);
2088
26f54e9a 2089 blk = g_new0(BlockBackend *, bs_n);
d739f1c4 2090 bs = g_new0(BlockDriverState *, bs_n);
52bf1e72 2091 bs_sectors = g_new(int64_t, bs_n);
926c2d23
AZ
2092
2093 total_sectors = 0;
2094 for (bs_i = 0; bs_i < bs_n; bs_i++) {
efaa7c4e 2095 blk[bs_i] = img_open(image_opts, argv[optind + bs_i],
ce099547 2096 fmt, src_flags, src_writethrough, quiet);
7e7d56d9 2097 if (!blk[bs_i]) {
c2abccec
MK
2098 ret = -1;
2099 goto out;
2100 }
7e7d56d9 2101 bs[bs_i] = blk_bs(blk[bs_i]);
f1d3cd79 2102 bs_sectors[bs_i] = blk_nb_sectors(blk[bs_i]);
52bf1e72
MA
2103 if (bs_sectors[bs_i] < 0) {
2104 error_report("Could not get size of %s: %s",
2105 argv[optind + bs_i], strerror(-bs_sectors[bs_i]));
2106 ret = -1;
2107 goto out;
2108 }
d739f1c4 2109 total_sectors += bs_sectors[bs_i];
926c2d23 2110 }
ea2384d3 2111
ef80654d 2112 if (sn_opts) {
10d6eda1
PM
2113 bdrv_snapshot_load_tmp(bs[0],
2114 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2115 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2116 &local_err);
ef80654d 2117 } else if (snapshot_name != NULL) {
51ef6727 2118 if (bs_n > 1) {
6daf194d 2119 error_report("No support for concatenating multiple snapshot");
51ef6727 2120 ret = -1;
2121 goto out;
2122 }
7b4c4781
WX
2123
2124 bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
ef80654d 2125 }
84d18f06 2126 if (local_err) {
c29b77f9 2127 error_reportf_err(local_err, "Failed to load snapshot: ");
ef80654d
WX
2128 ret = -1;
2129 goto out;
51ef6727 2130 }
2131
efa84d43 2132 /* Find driver and parse its options */
ea2384d3 2133 drv = bdrv_find_format(out_fmt);
c2abccec 2134 if (!drv) {
15654a6d 2135 error_report("Unknown file format '%s'", out_fmt);
c2abccec
MK
2136 ret = -1;
2137 goto out;
2138 }
efa84d43 2139
b65a5e12 2140 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
c2abccec 2141 if (!proto_drv) {
2867ce4a 2142 error_report_err(local_err);
c2abccec
MK
2143 ret = -1;
2144 goto out;
2145 }
b50cbabc 2146
2e024cde
HR
2147 if (!skip_create) {
2148 if (!drv->create_opts) {
2149 error_report("Format driver '%s' does not support image creation",
2150 drv->format_name);
2151 ret = -1;
2152 goto out;
2153 }
f75613cf 2154
2e024cde
HR
2155 if (!proto_drv->create_opts) {
2156 error_report("Protocol driver '%s' does not support image creation",
2157 proto_drv->format_name);
2158 ret = -1;
2159 goto out;
2160 }
f75613cf 2161
2e024cde
HR
2162 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2163 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
db08adf5 2164
2e024cde 2165 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
dc523cd3
MA
2166 if (options) {
2167 qemu_opts_do_parse(opts, options, NULL, &local_err);
2168 if (local_err) {
97a2ca7a 2169 error_report_err(local_err);
dc523cd3
MA
2170 ret = -1;
2171 goto out;
2172 }
2e024cde 2173 }
efa84d43 2174
39101f25
MA
2175 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512,
2176 &error_abort);
2e024cde
HR
2177 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2178 if (ret < 0) {
2179 goto out;
2180 }
c2abccec 2181 }
efa84d43 2182
a18953fb 2183 /* Get backing file name if -o backing_file was used */
83d0521a 2184 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
a18953fb 2185 if (out_baseimg_param) {
83d0521a 2186 out_baseimg = out_baseimg_param;
a18953fb
KW
2187 }
2188
efa84d43 2189 /* Check if compression is supported */
eec77d9e 2190 if (compress) {
83d0521a
CL
2191 bool encryption =
2192 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2193 const char *preallocation =
2194 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
efa84d43 2195
35fadca8 2196 if (!drv->bdrv_co_pwritev_compressed) {
15654a6d 2197 error_report("Compression not supported for this file format");
c2abccec
MK
2198 ret = -1;
2199 goto out;
efa84d43
KW
2200 }
2201
83d0521a 2202 if (encryption) {
15654a6d
JS
2203 error_report("Compression and encryption not supported at "
2204 "the same time");
c2abccec
MK
2205 ret = -1;
2206 goto out;
efa84d43 2207 }
41521fa4 2208
83d0521a
CL
2209 if (preallocation
2210 && strcmp(preallocation, "off"))
41521fa4
KW
2211 {
2212 error_report("Compression and preallocation not supported at "
2213 "the same time");
2214 ret = -1;
2215 goto out;
2216 }
efa84d43
KW
2217 }
2218
b2e10493
AD
2219 if (!skip_create) {
2220 /* Create the new image */
c282e1fd 2221 ret = bdrv_create(drv, out_filename, opts, &local_err);
b2e10493 2222 if (ret < 0) {
c29b77f9
MA
2223 error_reportf_err(local_err, "%s: error while converting %s: ",
2224 out_filename, out_fmt);
b2e10493 2225 goto out;
ea2384d3
FB
2226 }
2227 }
3b46e624 2228
5a37b60a 2229 flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
ce099547 2230 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
661a0f71
FS
2231 if (ret < 0) {
2232 error_report("Invalid cache option: %s", cache);
bb9cd2ee 2233 goto out;
661a0f71
FS
2234 }
2235
eb769f74
DB
2236 /* XXX we should allow --image-opts to trigger use of
2237 * img_open() here, but then we have trouble with
2238 * the bdrv_create() call which takes different params.
2239 * Not critical right now, so fix can wait...
2240 */
ce099547 2241 out_blk = img_open_file(out_filename, out_fmt, flags, writethrough, quiet);
7e7d56d9 2242 if (!out_blk) {
c2abccec
MK
2243 ret = -1;
2244 goto out;
2245 }
7e7d56d9 2246 out_bs = blk_bs(out_blk);
ea2384d3 2247
5def6b80 2248 /* increase bufsectors from the default 4096 (2M) if opt_transfer
f2521c90
PL
2249 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2250 * as maximum. */
2251 bufsectors = MIN(32768,
5def6b80
EB
2252 MAX(bufsectors,
2253 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
b9f7855a
EB
2254 out_bs->bl.pdiscard_alignment >>
2255 BDRV_SECTOR_BITS)));
f2521c90 2256
b2e10493 2257 if (skip_create) {
f1d3cd79 2258 int64_t output_sectors = blk_nb_sectors(out_blk);
43716fa8 2259 if (output_sectors < 0) {
eec5eb42 2260 error_report("unable to get output image length: %s",
43716fa8 2261 strerror(-output_sectors));
b2e10493
AD
2262 ret = -1;
2263 goto out;
43716fa8 2264 } else if (output_sectors < total_sectors) {
b2e10493
AD
2265 error_report("output file is smaller than input file");
2266 ret = -1;
2267 goto out;
2268 }
2269 }
2270
24f833cd
PL
2271 cluster_sectors = 0;
2272 ret = bdrv_get_info(out_bs, &bdi);
2273 if (ret < 0) {
2274 if (compress) {
15654a6d 2275 error_report("could not get block driver info");
c2abccec
MK
2276 goto out;
2277 }
24f833cd 2278 } else {
85f49cad 2279 compress = compress || bdi.needs_compressed_writes;
24f833cd
PL
2280 cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2281 }
2282
690c7301
KW
2283 state = (ImgConvertState) {
2284 .src = blk,
2285 .src_sectors = bs_sectors,
2286 .src_num = bs_n,
2287 .total_sectors = total_sectors,
2288 .target = out_blk,
2289 .compressed = compress,
2290 .target_has_backing = (bool) out_baseimg,
2291 .min_sparse = min_sparse,
2292 .cluster_sectors = cluster_sectors,
2293 .buf_sectors = bufsectors,
2d9187bc
PL
2294 .wr_in_order = wr_in_order,
2295 .num_coroutines = num_coroutines,
690c7301
KW
2296 };
2297 ret = convert_do_copy(&state);
802c3d4c 2298
c2abccec 2299out:
13c28af8
PL
2300 if (!ret) {
2301 qemu_progress_print(100, 0);
2302 }
6b837bc4 2303 qemu_progress_end();
83d0521a
CL
2304 qemu_opts_del(opts);
2305 qemu_opts_free(create_opts);
fbf28a43 2306 qemu_opts_del(sn_opts);
26f54e9a 2307 blk_unref(out_blk);
9ba10c95 2308 g_free(bs);
26f54e9a
MA
2309 if (blk) {
2310 for (bs_i = 0; bs_i < bs_n; bs_i++) {
2311 blk_unref(blk[bs_i]);
2312 }
2313 g_free(blk);
2314 }
d739f1c4 2315 g_free(bs_sectors);
64bb01aa
KW
2316fail_getopt:
2317 g_free(options);
2318
c2abccec
MK
2319 if (ret) {
2320 return 1;
2321 }
ea2384d3
FB
2322 return 0;
2323}
2324
57d1a2b6 2325
faea38e7
FB
2326static void dump_snapshots(BlockDriverState *bs)
2327{
2328 QEMUSnapshotInfo *sn_tab, *sn;
2329 int nb_sns, i;
faea38e7
FB
2330
2331 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2332 if (nb_sns <= 0)
2333 return;
2334 printf("Snapshot list:\n");
5b917044
WX
2335 bdrv_snapshot_dump(fprintf, stdout, NULL);
2336 printf("\n");
faea38e7
FB
2337 for(i = 0; i < nb_sns; i++) {
2338 sn = &sn_tab[i];
5b917044
WX
2339 bdrv_snapshot_dump(fprintf, stdout, sn);
2340 printf("\n");
faea38e7 2341 }
7267c094 2342 g_free(sn_tab);
faea38e7
FB
2343}
2344
9699bf0d
SH
2345static void dump_json_image_info_list(ImageInfoList *list)
2346{
9699bf0d 2347 QString *str;
9699bf0d 2348 QObject *obj;
7d5e199a 2349 Visitor *v = qobject_output_visitor_new(&obj);
3b098d56
EB
2350
2351 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2352 visit_complete(v, &obj);
9699bf0d
SH
2353 str = qobject_to_json_pretty(obj);
2354 assert(str != NULL);
2355 printf("%s\n", qstring_get_str(str));
2356 qobject_decref(obj);
3b098d56 2357 visit_free(v);
9699bf0d
SH
2358 QDECREF(str);
2359}
2360
c054b3fd
BC
2361static void dump_json_image_info(ImageInfo *info)
2362{
c054b3fd 2363 QString *str;
c054b3fd 2364 QObject *obj;
7d5e199a 2365 Visitor *v = qobject_output_visitor_new(&obj);
3b098d56
EB
2366
2367 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2368 visit_complete(v, &obj);
c054b3fd
BC
2369 str = qobject_to_json_pretty(obj);
2370 assert(str != NULL);
2371 printf("%s\n", qstring_get_str(str));
2372 qobject_decref(obj);
3b098d56 2373 visit_free(v);
c054b3fd
BC
2374 QDECREF(str);
2375}
2376
9699bf0d
SH
2377static void dump_human_image_info_list(ImageInfoList *list)
2378{
2379 ImageInfoList *elem;
2380 bool delim = false;
2381
2382 for (elem = list; elem; elem = elem->next) {
2383 if (delim) {
2384 printf("\n");
2385 }
2386 delim = true;
2387
5b917044 2388 bdrv_image_info_dump(fprintf, stdout, elem->value);
9699bf0d
SH
2389 }
2390}
2391
2392static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2393{
2394 return strcmp(a, b) == 0;
2395}
2396
2397/**
2398 * Open an image file chain and return an ImageInfoList
2399 *
2400 * @filename: topmost image filename
2401 * @fmt: topmost image format (may be NULL to autodetect)
2402 * @chain: true - enumerate entire backing file chain
2403 * false - only topmost image file
2404 *
2405 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2406 * image file. If there was an error a message will have been printed to
2407 * stderr.
2408 */
eb769f74
DB
2409static ImageInfoList *collect_image_info_list(bool image_opts,
2410 const char *filename,
9699bf0d
SH
2411 const char *fmt,
2412 bool chain)
2413{
2414 ImageInfoList *head = NULL;
2415 ImageInfoList **last = &head;
2416 GHashTable *filenames;
43526ec8 2417 Error *err = NULL;
9699bf0d
SH
2418
2419 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2420
2421 while (filename) {
26f54e9a 2422 BlockBackend *blk;
9699bf0d
SH
2423 BlockDriverState *bs;
2424 ImageInfo *info;
2425 ImageInfoList *elem;
2426
2427 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2428 error_report("Backing file '%s' creates an infinite loop.",
2429 filename);
2430 goto err;
2431 }
2432 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2433
efaa7c4e 2434 blk = img_open(image_opts, filename, fmt,
ce099547 2435 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false);
7e7d56d9 2436 if (!blk) {
9699bf0d
SH
2437 goto err;
2438 }
7e7d56d9 2439 bs = blk_bs(blk);
9699bf0d 2440
43526ec8 2441 bdrv_query_image_info(bs, &info, &err);
84d18f06 2442 if (err) {
565f65d2 2443 error_report_err(err);
26f54e9a 2444 blk_unref(blk);
43526ec8 2445 goto err;
fb0ed453 2446 }
9699bf0d
SH
2447
2448 elem = g_new0(ImageInfoList, 1);
2449 elem->value = info;
2450 *last = elem;
2451 last = &elem->next;
2452
26f54e9a 2453 blk_unref(blk);
9699bf0d
SH
2454
2455 filename = fmt = NULL;
2456 if (chain) {
2457 if (info->has_full_backing_filename) {
2458 filename = info->full_backing_filename;
2459 } else if (info->has_backing_filename) {
92d617ab
JS
2460 error_report("Could not determine absolute backing filename,"
2461 " but backing filename '%s' present",
2462 info->backing_filename);
2463 goto err;
9699bf0d
SH
2464 }
2465 if (info->has_backing_filename_format) {
2466 fmt = info->backing_filename_format;
2467 }
2468 }
2469 }
2470 g_hash_table_destroy(filenames);
2471 return head;
2472
2473err:
2474 qapi_free_ImageInfoList(head);
2475 g_hash_table_destroy(filenames);
2476 return NULL;
2477}
2478
c054b3fd
BC
2479static int img_info(int argc, char **argv)
2480{
2481 int c;
2482 OutputFormat output_format = OFORMAT_HUMAN;
9699bf0d 2483 bool chain = false;
c054b3fd 2484 const char *filename, *fmt, *output;
9699bf0d 2485 ImageInfoList *list;
eb769f74 2486 bool image_opts = false;
c054b3fd 2487
ea2384d3 2488 fmt = NULL;
c054b3fd 2489 output = NULL;
ea2384d3 2490 for(;;) {
c054b3fd
BC
2491 int option_index = 0;
2492 static const struct option long_options[] = {
2493 {"help", no_argument, 0, 'h'},
2494 {"format", required_argument, 0, 'f'},
2495 {"output", required_argument, 0, OPTION_OUTPUT},
9699bf0d 2496 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
3babeb15 2497 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 2498 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
c054b3fd
BC
2499 {0, 0, 0, 0}
2500 };
2501 c = getopt_long(argc, argv, "f:h",
2502 long_options, &option_index);
b8fb60da 2503 if (c == -1) {
ea2384d3 2504 break;
b8fb60da 2505 }
ea2384d3 2506 switch(c) {
ef87394c 2507 case '?':
ea2384d3
FB
2508 case 'h':
2509 help();
2510 break;
2511 case 'f':
2512 fmt = optarg;
2513 break;
c054b3fd
BC
2514 case OPTION_OUTPUT:
2515 output = optarg;
2516 break;
9699bf0d
SH
2517 case OPTION_BACKING_CHAIN:
2518 chain = true;
2519 break;
3babeb15
DB
2520 case OPTION_OBJECT: {
2521 QemuOpts *opts;
2522 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2523 optarg, true);
2524 if (!opts) {
2525 return 1;
2526 }
2527 } break;
eb769f74
DB
2528 case OPTION_IMAGE_OPTS:
2529 image_opts = true;
2530 break;
ea2384d3
FB
2531 }
2532 }
fc11eb26 2533 if (optind != argc - 1) {
ac1307ab 2534 error_exit("Expecting one image file name");
b8fb60da 2535 }
ea2384d3
FB
2536 filename = argv[optind++];
2537
c054b3fd
BC
2538 if (output && !strcmp(output, "json")) {
2539 output_format = OFORMAT_JSON;
2540 } else if (output && !strcmp(output, "human")) {
2541 output_format = OFORMAT_HUMAN;
2542 } else if (output) {
2543 error_report("--output must be used with human or json as argument.");
c2abccec
MK
2544 return 1;
2545 }
c054b3fd 2546
3babeb15
DB
2547 if (qemu_opts_foreach(&qemu_object_opts,
2548 user_creatable_add_opts_foreach,
51b9b478 2549 NULL, NULL)) {
3babeb15
DB
2550 return 1;
2551 }
2552
eb769f74 2553 list = collect_image_info_list(image_opts, filename, fmt, chain);
9699bf0d 2554 if (!list) {
c2abccec 2555 return 1;
faea38e7 2556 }
c054b3fd 2557
c054b3fd
BC
2558 switch (output_format) {
2559 case OFORMAT_HUMAN:
9699bf0d 2560 dump_human_image_info_list(list);
c054b3fd
BC
2561 break;
2562 case OFORMAT_JSON:
9699bf0d
SH
2563 if (chain) {
2564 dump_json_image_info_list(list);
2565 } else {
2566 dump_json_image_info(list->value);
2567 }
c054b3fd 2568 break;
faea38e7 2569 }
c054b3fd 2570
9699bf0d 2571 qapi_free_ImageInfoList(list);
ea2384d3
FB
2572 return 0;
2573}
2574
4c93a13b
PB
2575static void dump_map_entry(OutputFormat output_format, MapEntry *e,
2576 MapEntry *next)
2577{
2578 switch (output_format) {
2579 case OFORMAT_HUMAN:
16b0d555 2580 if (e->data && !e->has_offset) {
4c93a13b
PB
2581 error_report("File contains external, encrypted or compressed clusters.");
2582 exit(1);
2583 }
16b0d555 2584 if (e->data && !e->zero) {
4c93a13b 2585 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
16b0d555
FZ
2586 e->start, e->length,
2587 e->has_offset ? e->offset : 0,
2588 e->has_filename ? e->filename : "");
4c93a13b
PB
2589 }
2590 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2591 * Modify the flags here to allow more coalescing.
2592 */
16b0d555
FZ
2593 if (next && (!next->data || next->zero)) {
2594 next->data = false;
2595 next->zero = true;
4c93a13b
PB
2596 }
2597 break;
2598 case OFORMAT_JSON:
16b0d555
FZ
2599 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
2600 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
4c93a13b
PB
2601 (e->start == 0 ? "[" : ",\n"),
2602 e->start, e->length, e->depth,
16b0d555
FZ
2603 e->zero ? "true" : "false",
2604 e->data ? "true" : "false");
2605 if (e->has_offset) {
c745bfb4 2606 printf(", \"offset\": %"PRId64"", e->offset);
4c93a13b
PB
2607 }
2608 putchar('}');
2609
2610 if (!next) {
2611 printf("]\n");
2612 }
2613 break;
2614 }
2615}
2616
2617static int get_block_status(BlockDriverState *bs, int64_t sector_num,
2618 int nb_sectors, MapEntry *e)
2619{
2620 int64_t ret;
2621 int depth;
67a0fd2a 2622 BlockDriverState *file;
2875645b 2623 bool has_offset;
4c93a13b
PB
2624
2625 /* As an optimization, we could cache the current range of unallocated
2626 * clusters in each file of the chain, and avoid querying the same
2627 * range repeatedly.
2628 */
2629
2630 depth = 0;
2631 for (;;) {
67a0fd2a
FZ
2632 ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
2633 &file);
4c93a13b
PB
2634 if (ret < 0) {
2635 return ret;
2636 }
2637 assert(nb_sectors);
2638 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2639 break;
2640 }
760e0063 2641 bs = backing_bs(bs);
4c93a13b
PB
2642 if (bs == NULL) {
2643 ret = 0;
2644 break;
2645 }
2646
2647 depth++;
2648 }
2649
2875645b
JS
2650 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
2651
2652 *e = (MapEntry) {
2653 .start = sector_num * BDRV_SECTOR_SIZE,
2654 .length = nb_sectors * BDRV_SECTOR_SIZE,
2655 .data = !!(ret & BDRV_BLOCK_DATA),
2656 .zero = !!(ret & BDRV_BLOCK_ZERO),
2657 .offset = ret & BDRV_BLOCK_OFFSET_MASK,
2658 .has_offset = has_offset,
2659 .depth = depth,
2660 .has_filename = file && has_offset,
2661 .filename = file && has_offset ? file->filename : NULL,
2662 };
2663
4c93a13b
PB
2664 return 0;
2665}
2666
16b0d555
FZ
2667static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
2668{
2669 if (curr->length == 0) {
2670 return false;
2671 }
2672 if (curr->zero != next->zero ||
2673 curr->data != next->data ||
2674 curr->depth != next->depth ||
2675 curr->has_filename != next->has_filename ||
2676 curr->has_offset != next->has_offset) {
2677 return false;
2678 }
2679 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
2680 return false;
2681 }
2682 if (curr->has_offset && curr->offset + curr->length != next->offset) {
2683 return false;
2684 }
2685 return true;
2686}
2687
4c93a13b
PB
2688static int img_map(int argc, char **argv)
2689{
2690 int c;
2691 OutputFormat output_format = OFORMAT_HUMAN;
26f54e9a 2692 BlockBackend *blk;
4c93a13b
PB
2693 BlockDriverState *bs;
2694 const char *filename, *fmt, *output;
2695 int64_t length;
2696 MapEntry curr = { .length = 0 }, next;
2697 int ret = 0;
eb769f74 2698 bool image_opts = false;
4c93a13b
PB
2699
2700 fmt = NULL;
2701 output = NULL;
2702 for (;;) {
2703 int option_index = 0;
2704 static const struct option long_options[] = {
2705 {"help", no_argument, 0, 'h'},
2706 {"format", required_argument, 0, 'f'},
2707 {"output", required_argument, 0, OPTION_OUTPUT},
3babeb15 2708 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 2709 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4c93a13b
PB
2710 {0, 0, 0, 0}
2711 };
2712 c = getopt_long(argc, argv, "f:h",
2713 long_options, &option_index);
2714 if (c == -1) {
2715 break;
2716 }
2717 switch (c) {
2718 case '?':
2719 case 'h':
2720 help();
2721 break;
2722 case 'f':
2723 fmt = optarg;
2724 break;
2725 case OPTION_OUTPUT:
2726 output = optarg;
2727 break;
3babeb15
DB
2728 case OPTION_OBJECT: {
2729 QemuOpts *opts;
2730 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2731 optarg, true);
2732 if (!opts) {
2733 return 1;
2734 }
2735 } break;
eb769f74
DB
2736 case OPTION_IMAGE_OPTS:
2737 image_opts = true;
2738 break;
4c93a13b
PB
2739 }
2740 }
ac1307ab
FZ
2741 if (optind != argc - 1) {
2742 error_exit("Expecting one image file name");
4c93a13b 2743 }
ac1307ab 2744 filename = argv[optind];
4c93a13b
PB
2745
2746 if (output && !strcmp(output, "json")) {
2747 output_format = OFORMAT_JSON;
2748 } else if (output && !strcmp(output, "human")) {
2749 output_format = OFORMAT_HUMAN;
2750 } else if (output) {
2751 error_report("--output must be used with human or json as argument.");
2752 return 1;
2753 }
2754
3babeb15
DB
2755 if (qemu_opts_foreach(&qemu_object_opts,
2756 user_creatable_add_opts_foreach,
51b9b478 2757 NULL, NULL)) {
3babeb15
DB
2758 return 1;
2759 }
2760
ce099547 2761 blk = img_open(image_opts, filename, fmt, 0, false, false);
7e7d56d9
MA
2762 if (!blk) {
2763 return 1;
4c93a13b 2764 }
7e7d56d9 2765 bs = blk_bs(blk);
4c93a13b
PB
2766
2767 if (output_format == OFORMAT_HUMAN) {
2768 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2769 }
2770
f1d3cd79 2771 length = blk_getlength(blk);
4c93a13b
PB
2772 while (curr.start + curr.length < length) {
2773 int64_t nsectors_left;
2774 int64_t sector_num;
2775 int n;
2776
2777 sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;
2778
2779 /* Probe up to 1 GiB at a time. */
2780 nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
2781 n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
2782 ret = get_block_status(bs, sector_num, n, &next);
2783
2784 if (ret < 0) {
2785 error_report("Could not read file metadata: %s", strerror(-ret));
2786 goto out;
2787 }
2788
16b0d555 2789 if (entry_mergeable(&curr, &next)) {
4c93a13b
PB
2790 curr.length += next.length;
2791 continue;
2792 }
2793
2794 if (curr.length > 0) {
2795 dump_map_entry(output_format, &curr, &next);
2796 }
2797 curr = next;
2798 }
2799
2800 dump_map_entry(output_format, &curr, NULL);
2801
2802out:
26f54e9a 2803 blk_unref(blk);
4c93a13b
PB
2804 return ret < 0;
2805}
2806
f7b4a940
AL
2807#define SNAPSHOT_LIST 1
2808#define SNAPSHOT_CREATE 2
2809#define SNAPSHOT_APPLY 3
2810#define SNAPSHOT_DELETE 4
2811
153859be 2812static int img_snapshot(int argc, char **argv)
f7b4a940 2813{
26f54e9a 2814 BlockBackend *blk;
f7b4a940
AL
2815 BlockDriverState *bs;
2816 QEMUSnapshotInfo sn;
2817 char *filename, *snapshot_name = NULL;
c2abccec 2818 int c, ret = 0, bdrv_oflags;
f7b4a940
AL
2819 int action = 0;
2820 qemu_timeval tv;
f382d43a 2821 bool quiet = false;
a89d89d3 2822 Error *err = NULL;
eb769f74 2823 bool image_opts = false;
f7b4a940 2824
ce099547 2825 bdrv_oflags = BDRV_O_RDWR;
f7b4a940
AL
2826 /* Parse commandline parameters */
2827 for(;;) {
3babeb15
DB
2828 static const struct option long_options[] = {
2829 {"help", no_argument, 0, 'h'},
2830 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 2831 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
2832 {0, 0, 0, 0}
2833 };
2834 c = getopt_long(argc, argv, "la:c:d:hq",
2835 long_options, NULL);
b8fb60da 2836 if (c == -1) {
f7b4a940 2837 break;
b8fb60da 2838 }
f7b4a940 2839 switch(c) {
ef87394c 2840 case '?':
f7b4a940
AL
2841 case 'h':
2842 help();
153859be 2843 return 0;
f7b4a940
AL
2844 case 'l':
2845 if (action) {
ac1307ab 2846 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2847 return 0;
f7b4a940
AL
2848 }
2849 action = SNAPSHOT_LIST;
f5edb014 2850 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
f7b4a940
AL
2851 break;
2852 case 'a':
2853 if (action) {
ac1307ab 2854 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2855 return 0;
f7b4a940
AL
2856 }
2857 action = SNAPSHOT_APPLY;
2858 snapshot_name = optarg;
2859 break;
2860 case 'c':
2861 if (action) {
ac1307ab 2862 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2863 return 0;
f7b4a940
AL
2864 }
2865 action = SNAPSHOT_CREATE;
2866 snapshot_name = optarg;
2867 break;
2868 case 'd':
2869 if (action) {
ac1307ab 2870 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2871 return 0;
f7b4a940
AL
2872 }
2873 action = SNAPSHOT_DELETE;
2874 snapshot_name = optarg;
2875 break;
f382d43a
MR
2876 case 'q':
2877 quiet = true;
2878 break;
3babeb15
DB
2879 case OPTION_OBJECT: {
2880 QemuOpts *opts;
2881 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2882 optarg, true);
2883 if (!opts) {
2884 return 1;
2885 }
2886 } break;
eb769f74
DB
2887 case OPTION_IMAGE_OPTS:
2888 image_opts = true;
2889 break;
f7b4a940
AL
2890 }
2891 }
2892
fc11eb26 2893 if (optind != argc - 1) {
ac1307ab 2894 error_exit("Expecting one image file name");
b8fb60da 2895 }
f7b4a940
AL
2896 filename = argv[optind++];
2897
3babeb15
DB
2898 if (qemu_opts_foreach(&qemu_object_opts,
2899 user_creatable_add_opts_foreach,
51b9b478 2900 NULL, NULL)) {
3babeb15
DB
2901 return 1;
2902 }
2903
f7b4a940 2904 /* Open the image */
ce099547 2905 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet);
7e7d56d9
MA
2906 if (!blk) {
2907 return 1;
c2abccec 2908 }
7e7d56d9 2909 bs = blk_bs(blk);
f7b4a940
AL
2910
2911 /* Perform the requested action */
2912 switch(action) {
2913 case SNAPSHOT_LIST:
2914 dump_snapshots(bs);
2915 break;
2916
2917 case SNAPSHOT_CREATE:
2918 memset(&sn, 0, sizeof(sn));
2919 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
2920
2921 qemu_gettimeofday(&tv);
2922 sn.date_sec = tv.tv_sec;
2923 sn.date_nsec = tv.tv_usec * 1000;
2924
2925 ret = bdrv_snapshot_create(bs, &sn);
b8fb60da 2926 if (ret) {
15654a6d 2927 error_report("Could not create snapshot '%s': %d (%s)",
f7b4a940 2928 snapshot_name, ret, strerror(-ret));
b8fb60da 2929 }
f7b4a940
AL
2930 break;
2931
2932 case SNAPSHOT_APPLY:
2933 ret = bdrv_snapshot_goto(bs, snapshot_name);
b8fb60da 2934 if (ret) {
15654a6d 2935 error_report("Could not apply snapshot '%s': %d (%s)",
f7b4a940 2936 snapshot_name, ret, strerror(-ret));
b8fb60da 2937 }
f7b4a940
AL
2938 break;
2939
2940 case SNAPSHOT_DELETE:
a89d89d3 2941 bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
84d18f06 2942 if (err) {
c29b77f9
MA
2943 error_reportf_err(err, "Could not delete snapshot '%s': ",
2944 snapshot_name);
a89d89d3 2945 ret = 1;
b8fb60da 2946 }
f7b4a940
AL
2947 break;
2948 }
2949
2950 /* Cleanup */
26f54e9a 2951 blk_unref(blk);
c2abccec
MK
2952 if (ret) {
2953 return 1;
2954 }
153859be 2955 return 0;
f7b4a940
AL
2956}
2957
3e85c6fd
KW
2958static int img_rebase(int argc, char **argv)
2959{
26f54e9a 2960 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
396374ca
PB
2961 uint8_t *buf_old = NULL;
2962 uint8_t *buf_new = NULL;
f1d3cd79 2963 BlockDriverState *bs = NULL;
3e85c6fd 2964 char *filename;
40055951
HR
2965 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
2966 int c, flags, src_flags, ret;
ce099547 2967 bool writethrough, src_writethrough;
3e85c6fd 2968 int unsafe = 0;
6b837bc4 2969 int progress = 0;
f382d43a 2970 bool quiet = false;
34b5d2c6 2971 Error *local_err = NULL;
eb769f74 2972 bool image_opts = false;
3e85c6fd
KW
2973
2974 /* Parse commandline parameters */
e53dbee0 2975 fmt = NULL;
661a0f71 2976 cache = BDRV_DEFAULT_CACHE;
40055951 2977 src_cache = BDRV_DEFAULT_CACHE;
3e85c6fd
KW
2978 out_baseimg = NULL;
2979 out_basefmt = NULL;
3e85c6fd 2980 for(;;) {
3babeb15
DB
2981 static const struct option long_options[] = {
2982 {"help", no_argument, 0, 'h'},
2983 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 2984 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
2985 {0, 0, 0, 0}
2986 };
2987 c = getopt_long(argc, argv, "hf:F:b:upt:T:q",
2988 long_options, NULL);
b8fb60da 2989 if (c == -1) {
3e85c6fd 2990 break;
b8fb60da 2991 }
3e85c6fd 2992 switch(c) {
ef87394c 2993 case '?':
3e85c6fd
KW
2994 case 'h':
2995 help();
2996 return 0;
e53dbee0
KW
2997 case 'f':
2998 fmt = optarg;
2999 break;
3e85c6fd
KW
3000 case 'F':
3001 out_basefmt = optarg;
3002 break;
3003 case 'b':
3004 out_baseimg = optarg;
3005 break;
3006 case 'u':
3007 unsafe = 1;
3008 break;
6b837bc4
JS
3009 case 'p':
3010 progress = 1;
3011 break;
661a0f71
FS
3012 case 't':
3013 cache = optarg;
3014 break;
40055951
HR
3015 case 'T':
3016 src_cache = optarg;
3017 break;
f382d43a
MR
3018 case 'q':
3019 quiet = true;
3020 break;
3babeb15
DB
3021 case OPTION_OBJECT: {
3022 QemuOpts *opts;
3023 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3024 optarg, true);
3025 if (!opts) {
3026 return 1;
3027 }
3028 } break;
eb769f74
DB
3029 case OPTION_IMAGE_OPTS:
3030 image_opts = true;
3031 break;
3e85c6fd
KW
3032 }
3033 }
3034
f382d43a
MR
3035 if (quiet) {
3036 progress = 0;
3037 }
3038
ac1307ab
FZ
3039 if (optind != argc - 1) {
3040 error_exit("Expecting one image file name");
3041 }
3042 if (!unsafe && !out_baseimg) {
3043 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
b8fb60da 3044 }
3e85c6fd
KW
3045 filename = argv[optind++];
3046
3babeb15
DB
3047 if (qemu_opts_foreach(&qemu_object_opts,
3048 user_creatable_add_opts_foreach,
51b9b478 3049 NULL, NULL)) {
3babeb15
DB
3050 return 1;
3051 }
3052
6b837bc4
JS
3053 qemu_progress_init(progress, 2.0);
3054 qemu_progress_print(0, 100);
3055
661a0f71 3056 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
ce099547 3057 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
661a0f71
FS
3058 if (ret < 0) {
3059 error_report("Invalid cache option: %s", cache);
40ed35a3 3060 goto out;
661a0f71
FS
3061 }
3062
ce099547
KW
3063 src_flags = 0;
3064 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
40055951
HR
3065 if (ret < 0) {
3066 error_report("Invalid source cache option: %s", src_cache);
40ed35a3 3067 goto out;
40055951
HR
3068 }
3069
ce099547
KW
3070 /* The source files are opened read-only, don't care about WCE */
3071 assert((src_flags & BDRV_O_RDWR) == 0);
3072 (void) src_writethrough;
3073
3e85c6fd
KW
3074 /*
3075 * Open the images.
3076 *
3077 * Ignore the old backing file for unsafe rebase in case we want to correct
3078 * the reference to a renamed or moved backing file.
3079 */
ce099547 3080 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
7e7d56d9 3081 if (!blk) {
40ed35a3
SH
3082 ret = -1;
3083 goto out;
c2abccec 3084 }
7e7d56d9 3085 bs = blk_bs(blk);
3e85c6fd 3086
3e85c6fd 3087 if (out_basefmt != NULL) {
644483d9 3088 if (bdrv_find_format(out_basefmt) == NULL) {
15654a6d 3089 error_report("Invalid format name: '%s'", out_basefmt);
c2abccec
MK
3090 ret = -1;
3091 goto out;
3e85c6fd
KW
3092 }
3093 }
3094
3095 /* For safe rebasing we need to compare old and new backing file */
40ed35a3 3096 if (!unsafe) {
9a29e18f 3097 char backing_name[PATH_MAX];
644483d9
HR
3098 QDict *options = NULL;
3099
3100 if (bs->backing_format[0] != '\0') {
3101 options = qdict_new();
3102 qdict_put(options, "driver", qstring_from_str(bs->backing_format));
3103 }
3e85c6fd 3104
3e85c6fd 3105 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
efaa7c4e 3106 blk_old_backing = blk_new_open(backing_name, NULL,
644483d9
HR
3107 options, src_flags, &local_err);
3108 if (!blk_old_backing) {
c29b77f9
MA
3109 error_reportf_err(local_err,
3110 "Could not open old backing file '%s': ",
3111 backing_name);
e84a0dd5 3112 ret = -1;
c2abccec 3113 goto out;
3e85c6fd 3114 }
644483d9 3115
a616673d 3116 if (out_baseimg[0]) {
644483d9
HR
3117 if (out_basefmt) {
3118 options = qdict_new();
3119 qdict_put(options, "driver", qstring_from_str(out_basefmt));
3120 } else {
3121 options = NULL;
3122 }
3123
efaa7c4e 3124 blk_new_backing = blk_new_open(out_baseimg, NULL,
644483d9
HR
3125 options, src_flags, &local_err);
3126 if (!blk_new_backing) {
c29b77f9
MA
3127 error_reportf_err(local_err,
3128 "Could not open new backing file '%s': ",
3129 out_baseimg);
e84a0dd5 3130 ret = -1;
a616673d
AB
3131 goto out;
3132 }
3e85c6fd
KW
3133 }
3134 }
3135
3136 /*
3137 * Check each unallocated cluster in the COW file. If it is unallocated,
3138 * accesses go to the backing file. We must therefore compare this cluster
3139 * in the old and new backing file, and if they differ we need to copy it
3140 * from the old backing file into the COW file.
3141 *
3142 * If qemu-img crashes during this step, no harm is done. The content of
3143 * the image is the same as the original one at any time.
3144 */
3145 if (!unsafe) {
52bf1e72
MA
3146 int64_t num_sectors;
3147 int64_t old_backing_num_sectors;
3148 int64_t new_backing_num_sectors = 0;
3e85c6fd 3149 uint64_t sector;
cc60e327 3150 int n;
1f710495 3151 float local_progress = 0;
d6771bfa 3152
f1d3cd79
HR
3153 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3154 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
3e85c6fd 3155
f1d3cd79 3156 num_sectors = blk_nb_sectors(blk);
52bf1e72
MA
3157 if (num_sectors < 0) {
3158 error_report("Could not get size of '%s': %s",
3159 filename, strerror(-num_sectors));
3160 ret = -1;
3161 goto out;
3162 }
f1d3cd79 3163 old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
52bf1e72 3164 if (old_backing_num_sectors < 0) {
9a29e18f 3165 char backing_name[PATH_MAX];
52bf1e72
MA
3166
3167 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3168 error_report("Could not get size of '%s': %s",
3169 backing_name, strerror(-old_backing_num_sectors));
3170 ret = -1;
3171 goto out;
3172 }
f1d3cd79
HR
3173 if (blk_new_backing) {
3174 new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
52bf1e72
MA
3175 if (new_backing_num_sectors < 0) {
3176 error_report("Could not get size of '%s': %s",
3177 out_baseimg, strerror(-new_backing_num_sectors));
3178 ret = -1;
3179 goto out;
3180 }
a616673d 3181 }
3e85c6fd 3182
1f710495
KW
3183 if (num_sectors != 0) {
3184 local_progress = (float)100 /
3185 (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
3186 }
3187
3e85c6fd
KW
3188 for (sector = 0; sector < num_sectors; sector += n) {
3189
3190 /* How many sectors can we handle with the next read? */
3191 if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
3192 n = (IO_BUF_SIZE / 512);
3193 } else {
3194 n = num_sectors - sector;
3195 }
3196
3197 /* If the cluster is allocated, we don't need to take action */
cc60e327 3198 ret = bdrv_is_allocated(bs, sector, n, &n);
d663640c
PB
3199 if (ret < 0) {
3200 error_report("error while reading image metadata: %s",
3201 strerror(-ret));
3202 goto out;
3203 }
cc60e327 3204 if (ret) {
3e85c6fd
KW
3205 continue;
3206 }
3207
87a1b3e3
KW
3208 /*
3209 * Read old and new backing file and take into consideration that
3210 * backing files may be smaller than the COW image.
3211 */
3212 if (sector >= old_backing_num_sectors) {
3213 memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
3214 } else {
3215 if (sector + n > old_backing_num_sectors) {
3216 n = old_backing_num_sectors - sector;
3217 }
3218
9166920a
EB
3219 ret = blk_pread(blk_old_backing, sector << BDRV_SECTOR_BITS,
3220 buf_old, n << BDRV_SECTOR_BITS);
87a1b3e3
KW
3221 if (ret < 0) {
3222 error_report("error while reading from old backing file");
3223 goto out;
3224 }
3e85c6fd 3225 }
87a1b3e3 3226
f1d3cd79 3227 if (sector >= new_backing_num_sectors || !blk_new_backing) {
87a1b3e3
KW
3228 memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
3229 } else {
3230 if (sector + n > new_backing_num_sectors) {
3231 n = new_backing_num_sectors - sector;
3232 }
3233
9166920a
EB
3234 ret = blk_pread(blk_new_backing, sector << BDRV_SECTOR_BITS,
3235 buf_new, n << BDRV_SECTOR_BITS);
87a1b3e3
KW
3236 if (ret < 0) {
3237 error_report("error while reading from new backing file");
3238 goto out;
3239 }
3e85c6fd
KW
3240 }
3241
3242 /* If they differ, we need to write to the COW file */
3243 uint64_t written = 0;
3244
3245 while (written < n) {
3246 int pnum;
3247
3248 if (compare_sectors(buf_old + written * 512,
60b1bd4f 3249 buf_new + written * 512, n - written, &pnum))
3e85c6fd 3250 {
9166920a
EB
3251 ret = blk_pwrite(blk,
3252 (sector + written) << BDRV_SECTOR_BITS,
3253 buf_old + written * 512,
3254 pnum << BDRV_SECTOR_BITS, 0);
3e85c6fd 3255 if (ret < 0) {
15654a6d 3256 error_report("Error while writing to COW image: %s",
3e85c6fd 3257 strerror(-ret));
c2abccec 3258 goto out;
3e85c6fd
KW
3259 }
3260 }
3261
3262 written += pnum;
3263 }
6b837bc4 3264 qemu_progress_print(local_progress, 100);
3e85c6fd
KW
3265 }
3266 }
3267
3268 /*
3269 * Change the backing file. All clusters that are different from the old
3270 * backing file are overwritten in the COW file now, so the visible content
3271 * doesn't change when we switch the backing file.
3272 */
a616673d
AB
3273 if (out_baseimg && *out_baseimg) {
3274 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
3275 } else {
3276 ret = bdrv_change_backing_file(bs, NULL, NULL);
3277 }
3278
3e85c6fd 3279 if (ret == -ENOSPC) {
15654a6d
JS
3280 error_report("Could not change the backing file to '%s': No "
3281 "space left in the file header", out_baseimg);
3e85c6fd 3282 } else if (ret < 0) {
15654a6d 3283 error_report("Could not change the backing file to '%s': %s",
3e85c6fd
KW
3284 out_baseimg, strerror(-ret));
3285 }
3286
6b837bc4 3287 qemu_progress_print(100, 0);
3e85c6fd
KW
3288 /*
3289 * TODO At this point it is possible to check if any clusters that are
3290 * allocated in the COW file are the same in the backing file. If so, they
3291 * could be dropped from the COW file. Don't do this before switching the
3292 * backing file, in case of a crash this would lead to corruption.
3293 */
c2abccec 3294out:
6b837bc4 3295 qemu_progress_end();
3e85c6fd
KW
3296 /* Cleanup */
3297 if (!unsafe) {
26f54e9a 3298 blk_unref(blk_old_backing);
26f54e9a 3299 blk_unref(blk_new_backing);
3e85c6fd 3300 }
396374ca
PB
3301 qemu_vfree(buf_old);
3302 qemu_vfree(buf_new);
3e85c6fd 3303
26f54e9a 3304 blk_unref(blk);
c2abccec
MK
3305 if (ret) {
3306 return 1;
3307 }
3e85c6fd
KW
3308 return 0;
3309}
3310
ae6b0ed6
SH
3311static int img_resize(int argc, char **argv)
3312{
6750e795 3313 Error *err = NULL;
ae6b0ed6
SH
3314 int c, ret, relative;
3315 const char *filename, *fmt, *size;
3316 int64_t n, total_size;
f382d43a 3317 bool quiet = false;
26f54e9a 3318 BlockBackend *blk = NULL;
20caf0f7 3319 QemuOpts *param;
3babeb15 3320
20caf0f7
DXW
3321 static QemuOptsList resize_options = {
3322 .name = "resize_options",
3323 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3324 .desc = {
3325 {
3326 .name = BLOCK_OPT_SIZE,
3327 .type = QEMU_OPT_SIZE,
3328 .help = "Virtual disk size"
3329 }, {
3330 /* end of list */
3331 }
ae6b0ed6 3332 },
ae6b0ed6 3333 };
eb769f74 3334 bool image_opts = false;
ae6b0ed6 3335
e80fec7f
KW
3336 /* Remove size from argv manually so that negative numbers are not treated
3337 * as options by getopt. */
3338 if (argc < 3) {
ac1307ab 3339 error_exit("Not enough arguments");
e80fec7f
KW
3340 return 1;
3341 }
3342
3343 size = argv[--argc];
3344
3345 /* Parse getopt arguments */
ae6b0ed6
SH
3346 fmt = NULL;
3347 for(;;) {
3babeb15
DB
3348 static const struct option long_options[] = {
3349 {"help", no_argument, 0, 'h'},
3350 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 3351 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
3352 {0, 0, 0, 0}
3353 };
3354 c = getopt_long(argc, argv, "f:hq",
3355 long_options, NULL);
ae6b0ed6
SH
3356 if (c == -1) {
3357 break;
3358 }
3359 switch(c) {
ef87394c 3360 case '?':
ae6b0ed6
SH
3361 case 'h':
3362 help();
3363 break;
3364 case 'f':
3365 fmt = optarg;
3366 break;
f382d43a
MR
3367 case 'q':
3368 quiet = true;
3369 break;
3babeb15
DB
3370 case OPTION_OBJECT: {
3371 QemuOpts *opts;
3372 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3373 optarg, true);
3374 if (!opts) {
3375 return 1;
3376 }
3377 } break;
eb769f74
DB
3378 case OPTION_IMAGE_OPTS:
3379 image_opts = true;
3380 break;
ae6b0ed6
SH
3381 }
3382 }
fc11eb26 3383 if (optind != argc - 1) {
ac1307ab 3384 error_exit("Expecting one image file name");
ae6b0ed6
SH
3385 }
3386 filename = argv[optind++];
ae6b0ed6 3387
3babeb15
DB
3388 if (qemu_opts_foreach(&qemu_object_opts,
3389 user_creatable_add_opts_foreach,
51b9b478 3390 NULL, NULL)) {
3babeb15
DB
3391 return 1;
3392 }
3393
ae6b0ed6
SH
3394 /* Choose grow, shrink, or absolute resize mode */
3395 switch (size[0]) {
3396 case '+':
3397 relative = 1;
3398 size++;
3399 break;
3400 case '-':
3401 relative = -1;
3402 size++;
3403 break;
3404 default:
3405 relative = 0;
3406 break;
3407 }
3408
3409 /* Parse size */
87ea75d5 3410 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
f43e47db 3411 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
6750e795
MA
3412 if (err) {
3413 error_report_err(err);
2a81998a 3414 ret = -1;
20caf0f7 3415 qemu_opts_del(param);
2a81998a 3416 goto out;
ae6b0ed6 3417 }
20caf0f7
DXW
3418 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3419 qemu_opts_del(param);
ae6b0ed6 3420
efaa7c4e 3421 blk = img_open(image_opts, filename, fmt,
55880601 3422 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet);
7e7d56d9 3423 if (!blk) {
2a81998a
JS
3424 ret = -1;
3425 goto out;
c2abccec 3426 }
ae6b0ed6
SH
3427
3428 if (relative) {
f1d3cd79 3429 total_size = blk_getlength(blk) + n * relative;
ae6b0ed6
SH
3430 } else {
3431 total_size = n;
3432 }
3433 if (total_size <= 0) {
15654a6d 3434 error_report("New image size must be positive");
c2abccec
MK
3435 ret = -1;
3436 goto out;
ae6b0ed6
SH
3437 }
3438
f1d3cd79 3439 ret = blk_truncate(blk, total_size);
ae6b0ed6
SH
3440 switch (ret) {
3441 case 0:
f382d43a 3442 qprintf(quiet, "Image resized.\n");
ae6b0ed6
SH
3443 break;
3444 case -ENOTSUP:
259b2173 3445 error_report("This image does not support resize");
ae6b0ed6
SH
3446 break;
3447 case -EACCES:
15654a6d 3448 error_report("Image is read-only");
ae6b0ed6
SH
3449 break;
3450 default:
bcf23482 3451 error_report("Error resizing image: %s", strerror(-ret));
ae6b0ed6
SH
3452 break;
3453 }
c2abccec 3454out:
26f54e9a 3455 blk_unref(blk);
c2abccec
MK
3456 if (ret) {
3457 return 1;
3458 }
ae6b0ed6
SH
3459 return 0;
3460}
3461
76a3a34d 3462static void amend_status_cb(BlockDriverState *bs,
8b13976d
HR
3463 int64_t offset, int64_t total_work_size,
3464 void *opaque)
76a3a34d
HR
3465{
3466 qemu_progress_print(100.f * offset / total_work_size, 0);
3467}
3468
6f176b48
HR
3469static int img_amend(int argc, char **argv)
3470{
dc523cd3 3471 Error *err = NULL;
6f176b48
HR
3472 int c, ret = 0;
3473 char *options = NULL;
83d0521a
CL
3474 QemuOptsList *create_opts = NULL;
3475 QemuOpts *opts = NULL;
bd39e6ed
HR
3476 const char *fmt = NULL, *filename, *cache;
3477 int flags;
ce099547 3478 bool writethrough;
76a3a34d 3479 bool quiet = false, progress = false;
26f54e9a 3480 BlockBackend *blk = NULL;
6f176b48 3481 BlockDriverState *bs = NULL;
eb769f74 3482 bool image_opts = false;
6f176b48 3483
bd39e6ed 3484 cache = BDRV_DEFAULT_CACHE;
6f176b48 3485 for (;;) {
3babeb15
DB
3486 static const struct option long_options[] = {
3487 {"help", no_argument, 0, 'h'},
3488 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 3489 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
3490 {0, 0, 0, 0}
3491 };
3492 c = getopt_long(argc, argv, "ho:f:t:pq",
3493 long_options, NULL);
6f176b48
HR
3494 if (c == -1) {
3495 break;
3496 }
3497
3498 switch (c) {
3499 case 'h':
3500 case '?':
3501 help();
3502 break;
3503 case 'o':
626f84f3
KW
3504 if (!is_valid_option_list(optarg)) {
3505 error_report("Invalid option list: %s", optarg);
3506 ret = -1;
e814dffc 3507 goto out_no_progress;
626f84f3
KW
3508 }
3509 if (!options) {
3510 options = g_strdup(optarg);
3511 } else {
3512 char *old_options = options;
3513 options = g_strdup_printf("%s,%s", options, optarg);
3514 g_free(old_options);
3515 }
6f176b48
HR
3516 break;
3517 case 'f':
3518 fmt = optarg;
3519 break;
bd39e6ed
HR
3520 case 't':
3521 cache = optarg;
3522 break;
76a3a34d
HR
3523 case 'p':
3524 progress = true;
3525 break;
6f176b48
HR
3526 case 'q':
3527 quiet = true;
3528 break;
3babeb15
DB
3529 case OPTION_OBJECT:
3530 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3531 optarg, true);
3532 if (!opts) {
3533 ret = -1;
3534 goto out_no_progress;
3535 }
3536 break;
eb769f74
DB
3537 case OPTION_IMAGE_OPTS:
3538 image_opts = true;
3539 break;
6f176b48
HR
3540 }
3541 }
3542
a283cb6e 3543 if (!options) {
ac1307ab 3544 error_exit("Must specify options (-o)");
6f176b48
HR
3545 }
3546
3babeb15
DB
3547 if (qemu_opts_foreach(&qemu_object_opts,
3548 user_creatable_add_opts_foreach,
51b9b478 3549 NULL, NULL)) {
3babeb15
DB
3550 ret = -1;
3551 goto out_no_progress;
3552 }
3553
76a3a34d
HR
3554 if (quiet) {
3555 progress = false;
3556 }
3557 qemu_progress_init(progress, 1.0);
3558
a283cb6e
KW
3559 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
3560 if (fmt && has_help_option(options)) {
3561 /* If a format is explicitly specified (and possibly no filename is
3562 * given), print option help here */
3563 ret = print_block_option_help(filename, fmt);
3564 goto out;
6f176b48
HR
3565 }
3566
a283cb6e 3567 if (optind != argc - 1) {
b2f27e44
HR
3568 error_report("Expecting one image file name");
3569 ret = -1;
3570 goto out;
a283cb6e 3571 }
6f176b48 3572
ce099547
KW
3573 flags = BDRV_O_RDWR;
3574 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
bd39e6ed
HR
3575 if (ret < 0) {
3576 error_report("Invalid cache option: %s", cache);
3577 goto out;
3578 }
3579
ce099547 3580 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
7e7d56d9 3581 if (!blk) {
6f176b48
HR
3582 ret = -1;
3583 goto out;
3584 }
7e7d56d9 3585 bs = blk_bs(blk);
6f176b48
HR
3586
3587 fmt = bs->drv->format_name;
3588
626f84f3 3589 if (has_help_option(options)) {
a283cb6e 3590 /* If the format was auto-detected, print option help here */
6f176b48
HR
3591 ret = print_block_option_help(filename, fmt);
3592 goto out;
3593 }
3594
b2439d26
HR
3595 if (!bs->drv->create_opts) {
3596 error_report("Format driver '%s' does not support any options to amend",
3597 fmt);
3598 ret = -1;
3599 goto out;
3600 }
3601
c282e1fd 3602 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
83d0521a 3603 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
ece9086e
PB
3604 qemu_opts_do_parse(opts, options, NULL, &err);
3605 if (err) {
3606 error_report_err(err);
3607 ret = -1;
3608 goto out;
6f176b48
HR
3609 }
3610
76a3a34d
HR
3611 /* In case the driver does not call amend_status_cb() */
3612 qemu_progress_print(0.f, 0);
8b13976d 3613 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
76a3a34d 3614 qemu_progress_print(100.f, 0);
6f176b48
HR
3615 if (ret < 0) {
3616 error_report("Error while amending options: %s", strerror(-ret));
3617 goto out;
3618 }
3619
3620out:
76a3a34d
HR
3621 qemu_progress_end();
3622
e814dffc 3623out_no_progress:
26f54e9a 3624 blk_unref(blk);
83d0521a
CL
3625 qemu_opts_del(opts);
3626 qemu_opts_free(create_opts);
626f84f3
KW
3627 g_free(options);
3628
6f176b48
HR
3629 if (ret) {
3630 return 1;
3631 }
3632 return 0;
3633}
3634
b6133b8c
KW
3635typedef struct BenchData {
3636 BlockBackend *blk;
3637 uint64_t image_size;
b6495fa8 3638 bool write;
b6133b8c 3639 int bufsize;
83de9be0 3640 int step;
b6133b8c
KW
3641 int nrreq;
3642 int n;
55d539c8
KW
3643 int flush_interval;
3644 bool drain_on_flush;
b6133b8c
KW
3645 uint8_t *buf;
3646 QEMUIOVector *qiov;
3647
3648 int in_flight;
55d539c8 3649 bool in_flush;
b6133b8c
KW
3650 uint64_t offset;
3651} BenchData;
3652
55d539c8
KW
3653static void bench_undrained_flush_cb(void *opaque, int ret)
3654{
3655 if (ret < 0) {
df3c286c 3656 error_report("Failed flush request: %s", strerror(-ret));
55d539c8
KW
3657 exit(EXIT_FAILURE);
3658 }
3659}
3660
b6133b8c
KW
3661static void bench_cb(void *opaque, int ret)
3662{
3663 BenchData *b = opaque;
3664 BlockAIOCB *acb;
3665
3666 if (ret < 0) {
df3c286c 3667 error_report("Failed request: %s", strerror(-ret));
b6133b8c
KW
3668 exit(EXIT_FAILURE);
3669 }
55d539c8
KW
3670
3671 if (b->in_flush) {
3672 /* Just finished a flush with drained queue: Start next requests */
3673 assert(b->in_flight == 0);
3674 b->in_flush = false;
3675 } else if (b->in_flight > 0) {
3676 int remaining = b->n - b->in_flight;
3677
b6133b8c
KW
3678 b->n--;
3679 b->in_flight--;
55d539c8
KW
3680
3681 /* Time for flush? Drain queue if requested, then flush */
3682 if (b->flush_interval && remaining % b->flush_interval == 0) {
3683 if (!b->in_flight || !b->drain_on_flush) {
3684 BlockCompletionFunc *cb;
3685
3686 if (b->drain_on_flush) {
3687 b->in_flush = true;
3688 cb = bench_cb;
3689 } else {
3690 cb = bench_undrained_flush_cb;
3691 }
3692
3693 acb = blk_aio_flush(b->blk, cb, b);
3694 if (!acb) {
3695 error_report("Failed to issue flush request");
3696 exit(EXIT_FAILURE);
3697 }
3698 }
3699 if (b->drain_on_flush) {
3700 return;
3701 }
3702 }
b6133b8c
KW
3703 }
3704
3705 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
4baaa8c3
PB
3706 int64_t offset = b->offset;
3707 /* blk_aio_* might look for completed I/Os and kick bench_cb
3708 * again, so make sure this operation is counted by in_flight
3709 * and b->offset is ready for the next submission.
3710 */
3711 b->in_flight++;
3712 b->offset += b->step;
3713 b->offset %= b->image_size;
b6495fa8 3714 if (b->write) {
4baaa8c3 3715 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
b6495fa8 3716 } else {
4baaa8c3 3717 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
b6495fa8 3718 }
b6133b8c
KW
3719 if (!acb) {
3720 error_report("Failed to issue request");
3721 exit(EXIT_FAILURE);
3722 }
b6133b8c
KW
3723 }
3724}
3725
3726static int img_bench(int argc, char **argv)
3727{
3728 int c, ret = 0;
3729 const char *fmt = NULL, *filename;
3730 bool quiet = false;
3731 bool image_opts = false;
b6495fa8 3732 bool is_write = false;
b6133b8c
KW
3733 int count = 75000;
3734 int depth = 64;
d3199a31 3735 int64_t offset = 0;
b6133b8c 3736 size_t bufsize = 4096;
b6495fa8 3737 int pattern = 0;
83de9be0 3738 size_t step = 0;
55d539c8
KW
3739 int flush_interval = 0;
3740 bool drain_on_flush = true;
b6133b8c
KW
3741 int64_t image_size;
3742 BlockBackend *blk = NULL;
3743 BenchData data = {};
3744 int flags = 0;
604e8613 3745 bool writethrough = false;
b6133b8c
KW
3746 struct timeval t1, t2;
3747 int i;
3748
3749 for (;;) {
3750 static const struct option long_options[] = {
3751 {"help", no_argument, 0, 'h'},
55d539c8 3752 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
b6133b8c 3753 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
b6495fa8 3754 {"pattern", required_argument, 0, OPTION_PATTERN},
55d539c8 3755 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
b6133b8c
KW
3756 {0, 0, 0, 0}
3757 };
83de9be0 3758 c = getopt_long(argc, argv, "hc:d:f:no:qs:S:t:w", long_options, NULL);
b6133b8c
KW
3759 if (c == -1) {
3760 break;
3761 }
3762
3763 switch (c) {
3764 case 'h':
3765 case '?':
3766 help();
3767 break;
3768 case 'c':
3769 {
8b3c6792
PM
3770 unsigned long res;
3771
3772 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
b6133b8c
KW
3773 error_report("Invalid request count specified");
3774 return 1;
3775 }
8b3c6792 3776 count = res;
b6133b8c
KW
3777 break;
3778 }
3779 case 'd':
3780 {
8b3c6792
PM
3781 unsigned long res;
3782
3783 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
b6133b8c
KW
3784 error_report("Invalid queue depth specified");
3785 return 1;
3786 }
8b3c6792 3787 depth = res;
b6133b8c
KW
3788 break;
3789 }
3790 case 'f':
3791 fmt = optarg;
3792 break;
3793 case 'n':
3794 flags |= BDRV_O_NATIVE_AIO;
3795 break;
d3199a31
KW
3796 case 'o':
3797 {
606caa0a
MA
3798 offset = cvtnum(optarg);
3799 if (offset < 0) {
d3199a31
KW
3800 error_report("Invalid offset specified");
3801 return 1;
3802 }
3803 break;
3804 }
3805 break;
b6133b8c
KW
3806 case 'q':
3807 quiet = true;
3808 break;
3809 case 's':
3810 {
3811 int64_t sval;
b6133b8c 3812
606caa0a
MA
3813 sval = cvtnum(optarg);
3814 if (sval < 0 || sval > INT_MAX) {
b6133b8c
KW
3815 error_report("Invalid buffer size specified");
3816 return 1;
3817 }
3818
3819 bufsize = sval;
3820 break;
3821 }
83de9be0
KW
3822 case 'S':
3823 {
3824 int64_t sval;
83de9be0 3825
606caa0a
MA
3826 sval = cvtnum(optarg);
3827 if (sval < 0 || sval > INT_MAX) {
83de9be0
KW
3828 error_report("Invalid step size specified");
3829 return 1;
3830 }
3831
3832 step = sval;
3833 break;
3834 }
b6133b8c
KW
3835 case 't':
3836 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
3837 if (ret < 0) {
3838 error_report("Invalid cache mode");
3839 ret = -1;
3840 goto out;
3841 }
3842 break;
b6495fa8
KW
3843 case 'w':
3844 flags |= BDRV_O_RDWR;
3845 is_write = true;
3846 break;
3847 case OPTION_PATTERN:
3848 {
8b3c6792
PM
3849 unsigned long res;
3850
3851 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
b6495fa8
KW
3852 error_report("Invalid pattern byte specified");
3853 return 1;
3854 }
8b3c6792 3855 pattern = res;
b6495fa8
KW
3856 break;
3857 }
55d539c8
KW
3858 case OPTION_FLUSH_INTERVAL:
3859 {
8b3c6792
PM
3860 unsigned long res;
3861
3862 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
55d539c8
KW
3863 error_report("Invalid flush interval specified");
3864 return 1;
3865 }
8b3c6792 3866 flush_interval = res;
55d539c8
KW
3867 break;
3868 }
3869 case OPTION_NO_DRAIN:
3870 drain_on_flush = false;
3871 break;
b6133b8c
KW
3872 case OPTION_IMAGE_OPTS:
3873 image_opts = true;
3874 break;
3875 }
3876 }
3877
3878 if (optind != argc - 1) {
3879 error_exit("Expecting one image file name");
3880 }
3881 filename = argv[argc - 1];
3882
55d539c8
KW
3883 if (!is_write && flush_interval) {
3884 error_report("--flush-interval is only available in write tests");
3885 ret = -1;
3886 goto out;
3887 }
3888 if (flush_interval && flush_interval < depth) {
3889 error_report("Flush interval can't be smaller than depth");
3890 ret = -1;
3891 goto out;
3892 }
3893
b6133b8c
KW
3894 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3895 if (!blk) {
3896 ret = -1;
3897 goto out;
3898 }
3899
3900 image_size = blk_getlength(blk);
3901 if (image_size < 0) {
3902 ret = image_size;
3903 goto out;
3904 }
3905
3906 data = (BenchData) {
55d539c8
KW
3907 .blk = blk,
3908 .image_size = image_size,
3909 .bufsize = bufsize,
3910 .step = step ?: bufsize,
3911 .nrreq = depth,
3912 .n = count,
3913 .offset = offset,
3914 .write = is_write,
3915 .flush_interval = flush_interval,
3916 .drain_on_flush = drain_on_flush,
b6133b8c 3917 };
d3199a31 3918 printf("Sending %d %s requests, %d bytes each, %d in parallel "
83de9be0 3919 "(starting at offset %" PRId64 ", step size %d)\n",
d3199a31 3920 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
83de9be0 3921 data.offset, data.step);
55d539c8
KW
3922 if (flush_interval) {
3923 printf("Sending flush every %d requests\n", flush_interval);
3924 }
b6133b8c
KW
3925
3926 data.buf = blk_blockalign(blk, data.nrreq * data.bufsize);
b6495fa8
KW
3927 memset(data.buf, pattern, data.nrreq * data.bufsize);
3928
b6133b8c
KW
3929 data.qiov = g_new(QEMUIOVector, data.nrreq);
3930 for (i = 0; i < data.nrreq; i++) {
3931 qemu_iovec_init(&data.qiov[i], 1);
3932 qemu_iovec_add(&data.qiov[i],
3933 data.buf + i * data.bufsize, data.bufsize);
3934 }
3935
3936 gettimeofday(&t1, NULL);
3937 bench_cb(&data, 0);
3938
3939 while (data.n > 0) {
3940 main_loop_wait(false);
3941 }
3942 gettimeofday(&t2, NULL);
3943
3944 printf("Run completed in %3.3f seconds.\n",
3945 (t2.tv_sec - t1.tv_sec)
3946 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
3947
3948out:
3949 qemu_vfree(data.buf);
3950 blk_unref(blk);
3951
3952 if (ret) {
86ce1f6e
RS
3953 return 1;
3954 }
3955 return 0;
3956}
3957
3958#define C_BS 01
3959#define C_COUNT 02
3960#define C_IF 04
3961#define C_OF 010
f7c15533 3962#define C_SKIP 020
86ce1f6e
RS
3963
3964struct DdInfo {
3965 unsigned int flags;
3966 int64_t count;
3967};
3968
3969struct DdIo {
3970 int bsz; /* Block size */
3971 char *filename;
3972 uint8_t *buf;
f7c15533 3973 int64_t offset;
86ce1f6e
RS
3974};
3975
3976struct DdOpts {
3977 const char *name;
3978 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
3979 unsigned int flag;
3980};
3981
3982static int img_dd_bs(const char *arg,
3983 struct DdIo *in, struct DdIo *out,
3984 struct DdInfo *dd)
3985{
86ce1f6e
RS
3986 int64_t res;
3987
606caa0a 3988 res = cvtnum(arg);
86ce1f6e 3989
606caa0a 3990 if (res <= 0 || res > INT_MAX) {
86ce1f6e
RS
3991 error_report("invalid number: '%s'", arg);
3992 return 1;
3993 }
3994 in->bsz = out->bsz = res;
3995
3996 return 0;
3997}
3998
3999static int img_dd_count(const char *arg,
4000 struct DdIo *in, struct DdIo *out,
4001 struct DdInfo *dd)
4002{
606caa0a 4003 dd->count = cvtnum(arg);
86ce1f6e 4004
606caa0a 4005 if (dd->count < 0) {
86ce1f6e
RS
4006 error_report("invalid number: '%s'", arg);
4007 return 1;
4008 }
4009
4010 return 0;
4011}
4012
4013static int img_dd_if(const char *arg,
4014 struct DdIo *in, struct DdIo *out,
4015 struct DdInfo *dd)
4016{
4017 in->filename = g_strdup(arg);
4018
4019 return 0;
4020}
4021
4022static int img_dd_of(const char *arg,
4023 struct DdIo *in, struct DdIo *out,
4024 struct DdInfo *dd)
4025{
4026 out->filename = g_strdup(arg);
4027
4028 return 0;
4029}
4030
f7c15533
RS
4031static int img_dd_skip(const char *arg,
4032 struct DdIo *in, struct DdIo *out,
4033 struct DdInfo *dd)
4034{
606caa0a 4035 in->offset = cvtnum(arg);
f7c15533 4036
606caa0a 4037 if (in->offset < 0) {
f7c15533
RS
4038 error_report("invalid number: '%s'", arg);
4039 return 1;
4040 }
4041
4042 return 0;
4043}
4044
86ce1f6e
RS
4045static int img_dd(int argc, char **argv)
4046{
4047 int ret = 0;
4048 char *arg = NULL;
4049 char *tmp;
4050 BlockDriver *drv = NULL, *proto_drv = NULL;
4051 BlockBackend *blk1 = NULL, *blk2 = NULL;
4052 QemuOpts *opts = NULL;
4053 QemuOptsList *create_opts = NULL;
4054 Error *local_err = NULL;
4055 bool image_opts = false;
4056 int c, i;
4057 const char *out_fmt = "raw";
4058 const char *fmt = NULL;
4059 int64_t size = 0;
4060 int64_t block_count = 0, out_pos, in_pos;
4061 struct DdInfo dd = {
4062 .flags = 0,
4063 .count = 0,
4064 };
4065 struct DdIo in = {
4066 .bsz = 512, /* Block size is by default 512 bytes */
4067 .filename = NULL,
f7c15533
RS
4068 .buf = NULL,
4069 .offset = 0
86ce1f6e
RS
4070 };
4071 struct DdIo out = {
4072 .bsz = 512,
4073 .filename = NULL,
f7c15533
RS
4074 .buf = NULL,
4075 .offset = 0
86ce1f6e
RS
4076 };
4077
4078 const struct DdOpts options[] = {
4079 { "bs", img_dd_bs, C_BS },
4080 { "count", img_dd_count, C_COUNT },
4081 { "if", img_dd_if, C_IF },
4082 { "of", img_dd_of, C_OF },
f7c15533 4083 { "skip", img_dd_skip, C_SKIP },
86ce1f6e
RS
4084 { NULL, NULL, 0 }
4085 };
4086 const struct option long_options[] = {
4087 { "help", no_argument, 0, 'h'},
4088 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4089 { 0, 0, 0, 0 }
4090 };
4091
4092 while ((c = getopt_long(argc, argv, "hf:O:", long_options, NULL))) {
4093 if (c == EOF) {
4094 break;
4095 }
4096 switch (c) {
4097 case 'O':
4098 out_fmt = optarg;
4099 break;
4100 case 'f':
4101 fmt = optarg;
4102 break;
4103 case '?':
4104 error_report("Try 'qemu-img --help' for more information.");
4105 ret = -1;
4106 goto out;
4107 case 'h':
4108 help();
4109 break;
4110 case OPTION_IMAGE_OPTS:
4111 image_opts = true;
4112 break;
4113 }
4114 }
4115
4116 for (i = optind; i < argc; i++) {
4117 int j;
4118 arg = g_strdup(argv[i]);
4119
4120 tmp = strchr(arg, '=');
4121 if (tmp == NULL) {
4122 error_report("unrecognized operand %s", arg);
4123 ret = -1;
4124 goto out;
4125 }
4126
4127 *tmp++ = '\0';
4128
4129 for (j = 0; options[j].name != NULL; j++) {
4130 if (!strcmp(arg, options[j].name)) {
4131 break;
4132 }
4133 }
4134 if (options[j].name == NULL) {
4135 error_report("unrecognized operand %s", arg);
4136 ret = -1;
4137 goto out;
4138 }
4139
4140 if (options[j].f(tmp, &in, &out, &dd) != 0) {
4141 ret = -1;
4142 goto out;
4143 }
4144 dd.flags |= options[j].flag;
4145 g_free(arg);
4146 arg = NULL;
4147 }
4148
4149 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
4150 error_report("Must specify both input and output files");
4151 ret = -1;
4152 goto out;
4153 }
4154 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false);
4155
4156 if (!blk1) {
4157 ret = -1;
4158 goto out;
4159 }
4160
4161 drv = bdrv_find_format(out_fmt);
4162 if (!drv) {
4163 error_report("Unknown file format");
4164 ret = -1;
4165 goto out;
4166 }
4167 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
4168
4169 if (!proto_drv) {
4170 error_report_err(local_err);
4171 ret = -1;
4172 goto out;
4173 }
4174 if (!drv->create_opts) {
4175 error_report("Format driver '%s' does not support image creation",
4176 drv->format_name);
4177 ret = -1;
4178 goto out;
4179 }
4180 if (!proto_drv->create_opts) {
4181 error_report("Protocol driver '%s' does not support image creation",
4182 proto_drv->format_name);
4183 ret = -1;
4184 goto out;
4185 }
4186 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4187 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
4188
4189 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4190
4191 size = blk_getlength(blk1);
4192 if (size < 0) {
4193 error_report("Failed to get size for '%s'", in.filename);
4194 ret = -1;
4195 goto out;
4196 }
4197
4198 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
4199 dd.count * in.bsz < size) {
4200 size = dd.count * in.bsz;
4201 }
4202
f7c15533
RS
4203 /* Overflow means the specified offset is beyond input image's size */
4204 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4205 size < in.bsz * in.offset)) {
4206 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
4207 } else {
4208 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
4209 size - in.bsz * in.offset, &error_abort);
4210 }
86ce1f6e
RS
4211
4212 ret = bdrv_create(drv, out.filename, opts, &local_err);
4213 if (ret < 0) {
4214 error_reportf_err(local_err,
4215 "%s: error while creating output image: ",
4216 out.filename);
4217 ret = -1;
4218 goto out;
4219 }
4220
4221 blk2 = img_open(image_opts, out.filename, out_fmt, BDRV_O_RDWR,
4222 false, false);
4223
4224 if (!blk2) {
4225 ret = -1;
4226 goto out;
4227 }
4228
f7c15533
RS
4229 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4230 size < in.offset * in.bsz)) {
4231 /* We give a warning if the skip option is bigger than the input
4232 * size and create an empty output disk image (i.e. like dd(1)).
4233 */
4234 error_report("%s: cannot skip to specified offset", in.filename);
4235 in_pos = size;
4236 } else {
4237 in_pos = in.offset * in.bsz;
4238 }
4239
86ce1f6e
RS
4240 in.buf = g_new(uint8_t, in.bsz);
4241
f7c15533 4242 for (out_pos = 0; in_pos < size; block_count++) {
86ce1f6e
RS
4243 int in_ret, out_ret;
4244
4245 if (in_pos + in.bsz > size) {
4246 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
4247 } else {
4248 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
4249 }
4250 if (in_ret < 0) {
4251 error_report("error while reading from input image file: %s",
4252 strerror(-in_ret));
4253 ret = -1;
4254 goto out;
4255 }
4256 in_pos += in_ret;
4257
4258 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
4259
4260 if (out_ret < 0) {
4261 error_report("error while writing to output image file: %s",
4262 strerror(-out_ret));
4263 ret = -1;
4264 goto out;
4265 }
4266 out_pos += out_ret;
4267 }
4268
4269out:
4270 g_free(arg);
4271 qemu_opts_del(opts);
4272 qemu_opts_free(create_opts);
4273 blk_unref(blk1);
4274 blk_unref(blk2);
4275 g_free(in.filename);
4276 g_free(out.filename);
4277 g_free(in.buf);
4278 g_free(out.buf);
4279
4280 if (ret) {
b6133b8c
KW
4281 return 1;
4282 }
4283 return 0;
4284}
4285
4286
c227f099 4287static const img_cmd_t img_cmds[] = {
153859be
SB
4288#define DEF(option, callback, arg_string) \
4289 { option, callback },
4290#include "qemu-img-cmds.h"
4291#undef DEF
4292#undef GEN_DOCS
4293 { NULL, NULL, },
4294};
4295
ea2384d3
FB
4296int main(int argc, char **argv)
4297{
c227f099 4298 const img_cmd_t *cmd;
153859be 4299 const char *cmdname;
2f78e491 4300 Error *local_error = NULL;
06a1e0c1 4301 char *trace_file = NULL;
7db1689c 4302 int c;
7db1689c
JC
4303 static const struct option long_options[] = {
4304 {"help", no_argument, 0, 'h'},
10985131 4305 {"version", no_argument, 0, 'V'},
06a1e0c1 4306 {"trace", required_argument, NULL, 'T'},
7db1689c
JC
4307 {0, 0, 0, 0}
4308 };
ea2384d3 4309
526eda14
MK
4310#ifdef CONFIG_POSIX
4311 signal(SIGPIPE, SIG_IGN);
4312#endif
4313
fe4db84d 4314 module_call_init(MODULE_INIT_TRACE);
53f76e58 4315 error_set_progname(argv[0]);
10f5bff6 4316 qemu_init_exec_dir(argv[0]);
53f76e58 4317
2f78e491 4318 if (qemu_init_main_loop(&local_error)) {
565f65d2 4319 error_report_err(local_error);
2f78e491
CN
4320 exit(EXIT_FAILURE);
4321 }
4322
e8f2d272 4323 qcrypto_init(&error_fatal);
c2297088 4324
064097d9 4325 module_call_init(MODULE_INIT_QOM);
ea2384d3 4326 bdrv_init();
ac1307ab
FZ
4327 if (argc < 2) {
4328 error_exit("Not enough arguments");
4329 }
153859be 4330
3babeb15 4331 qemu_add_opts(&qemu_object_opts);
eb769f74 4332 qemu_add_opts(&qemu_source_opts);
06a1e0c1 4333 qemu_add_opts(&qemu_trace_opts);
3babeb15 4334
06a1e0c1 4335 while ((c = getopt_long(argc, argv, "+hVT:", long_options, NULL)) != -1) {
10985131
DL
4336 switch (c) {
4337 case 'h':
4338 help();
4339 return 0;
4340 case 'V':
4341 printf(QEMU_IMG_VERSION);
4342 return 0;
06a1e0c1
DL
4343 case 'T':
4344 g_free(trace_file);
4345 trace_file = trace_opt_parse(optarg);
4346 break;
153859be 4347 }
ea2384d3 4348 }
153859be 4349
10985131 4350 cmdname = argv[optind];
7db1689c 4351
10985131
DL
4352 /* reset getopt_long scanning */
4353 argc -= optind;
4354 if (argc < 1) {
5f6979cb
JC
4355 return 0;
4356 }
10985131 4357 argv += optind;
cfef6a45 4358 optind = 0;
10985131 4359
06a1e0c1
DL
4360 if (!trace_init_backends()) {
4361 exit(1);
4362 }
4363 trace_init_file(trace_file);
4364 qemu_set_log(LOG_TRACE);
4365
10985131
DL
4366 /* find the command */
4367 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
4368 if (!strcmp(cmdname, cmd->name)) {
4369 return cmd->handler(argc, argv);
4370 }
4371 }
7db1689c 4372
153859be 4373 /* not found */
ac1307ab 4374 error_exit("Command not found: %s", cmdname);
ea2384d3 4375}