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