]> git.proxmox.com Git - mirror_qemu.git/blame - qemu-img.c
block: Don't emulate natively supported pwritev flags
[mirror_qemu.git] / qemu-img.c
CommitLineData
ea2384d3 1/*
fb43f4dd 2 * QEMU disk image utility
5fafdf24 3 *
68d0f70e 4 * Copyright (c) 2003-2008 Fabrice Bellard
5fafdf24 5 *
ea2384d3
FB
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
80c71a24 24#include "qemu/osdep.h"
da34e65c 25#include "qapi/error.h"
c054b3fd
BC
26#include "qapi-visit.h"
27#include "qapi/qmp-output-visitor.h"
cc7a8ea7 28#include "qapi/qmp/qerror.h"
7b1b5d19 29#include "qapi/qmp/qjson.h"
f348b6d1 30#include "qemu/cutils.h"
3babeb15 31#include "qemu/config-file.h"
1de7afc9
PB
32#include "qemu/option.h"
33#include "qemu/error-report.h"
3babeb15 34#include "qom/object_interfaces.h"
9c17d615 35#include "sysemu/sysemu.h"
26f54e9a 36#include "sysemu/block-backend.h"
737e150e 37#include "block/block_int.h"
d4a3238a 38#include "block/blockjob.h"
f364ec65 39#include "block/qapi.h"
c2297088 40#include "crypto/init.h"
c054b3fd 41#include <getopt.h>
e8445331 42
61979a6a 43#define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
5f6979cb
JC
44 ", Copyright (c) 2004-2008 Fabrice Bellard\n"
45
c227f099 46typedef struct img_cmd_t {
153859be
SB
47 const char *name;
48 int (*handler)(int argc, char **argv);
c227f099 49} img_cmd_t;
153859be 50
8599ea4c
FS
51enum {
52 OPTION_OUTPUT = 256,
53 OPTION_BACKING_CHAIN = 257,
3babeb15 54 OPTION_OBJECT = 258,
eb769f74 55 OPTION_IMAGE_OPTS = 259,
8599ea4c
FS
56};
57
58typedef enum OutputFormat {
59 OFORMAT_JSON,
60 OFORMAT_HUMAN,
61} OutputFormat;
62
e6996143 63/* Default to cache=writeback as data integrity is not important for qemu-img */
661a0f71 64#define BDRV_DEFAULT_CACHE "writeback"
137519ce 65
00c6d403 66static void format_print(void *opaque, const char *name)
ea2384d3 67{
00c6d403 68 printf(" %s", name);
ea2384d3
FB
69}
70
ac1307ab
FZ
71static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
72{
73 va_list ap;
74
75 error_printf("qemu-img: ");
76
77 va_start(ap, fmt);
78 error_vprintf(fmt, ap);
79 va_end(ap);
80
81 error_printf("\nTry 'qemu-img --help' for more information\n");
82 exit(EXIT_FAILURE);
83}
84
d2c639d6 85/* Please keep in synch with qemu-img.texi */
ac1307ab 86static void QEMU_NORETURN help(void)
ea2384d3 87{
e00291c0 88 const char *help_msg =
5f6979cb 89 QEMU_IMG_VERSION
3f020d70 90 "usage: qemu-img command [command options]\n"
91 "QEMU disk image utility\n"
92 "\n"
93 "Command syntax:\n"
153859be
SB
94#define DEF(option, callback, arg_string) \
95 " " arg_string "\n"
96#include "qemu-img-cmds.h"
97#undef DEF
98#undef GEN_DOCS
3f020d70 99 "\n"
100 "Command parameters:\n"
101 " 'filename' is a disk image filename\n"
3babeb15
DB
102 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
103 " manual page for a description of the object properties. The most common\n"
104 " object type is a 'secret', which is used to supply passwords and/or\n"
105 " encryption keys.\n"
3f020d70 106 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
661a0f71 107 " 'cache' is the cache mode used to write the output disk image, the valid\n"
80ccf93b
LY
108 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
109 " 'directsync' and 'unsafe' (default for convert)\n"
bb87fdf8
SH
110 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
111 " options are the same as for the 'cache' option\n"
3f020d70 112 " 'size' is the disk image size in bytes. Optional suffixes\n"
5e00984a
KW
113 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
114 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
115 " supported. 'b' is ignored.\n"
3f020d70 116 " 'output_filename' is the destination disk image filename\n"
117 " 'output_fmt' is the destination format\n"
118 " 'options' is a comma separated list of format specific options in a\n"
119 " name=value format. Use -o ? for an overview of the options supported by the\n"
120 " used format\n"
ef80654d
WX
121 " 'snapshot_param' is param used for internal snapshot, format\n"
122 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
123 " '[ID_OR_NAME]'\n"
124 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
125 " instead\n"
3f020d70 126 " '-c' indicates that target image must be compressed (qcow format only)\n"
127 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
128 " match exactly. The image doesn't need a working backing file before\n"
129 " rebasing in this case (useful for renaming the backing file)\n"
130 " '-h' with or without a command shows this help and lists the supported formats\n"
6b837bc4 131 " '-p' show progress of command (only certain commands)\n"
f382d43a 132 " '-q' use Quiet mode - do not print any output (except errors)\n"
11b6699a
PL
133 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
134 " contain only zeros for qemu-img to create a sparse image during\n"
135 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
136 " unallocated or zero sectors, and the destination image will always be\n"
137 " fully allocated\n"
c054b3fd 138 " '--output' takes the format in which the output must be done (human or json)\n"
b2e10493
AD
139 " '-n' skips the target volume creation (useful if the volume is created\n"
140 " prior to running qemu-img)\n"
3f020d70 141 "\n"
4534ff54
KW
142 "Parameters to check subcommand:\n"
143 " '-r' tries to repair any inconsistencies that are found during the check.\n"
144 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
145 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
0546b8c2 146 " hiding corruption that has already occurred.\n"
4534ff54 147 "\n"
3f020d70 148 "Parameters to snapshot subcommand:\n"
149 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
150 " '-a' applies a snapshot (revert disk to saved state)\n"
151 " '-c' creates a snapshot\n"
152 " '-d' deletes a snapshot\n"
d14ed18c
MR
153 " '-l' lists all snapshots in the given image\n"
154 "\n"
155 "Parameters to compare subcommand:\n"
156 " '-f' first image format\n"
157 " '-F' second image format\n"
158 " '-s' run in Strict mode - fail on different image size or sector allocation\n";
e00291c0
PB
159
160 printf("%s\nSupported formats:", help_msg);
00c6d403 161 bdrv_iterate_format(format_print, NULL);
ea2384d3 162 printf("\n");
ac1307ab 163 exit(EXIT_SUCCESS);
ea2384d3
FB
164}
165
3babeb15
DB
166static QemuOptsList qemu_object_opts = {
167 .name = "object",
168 .implied_opt_name = "qom-type",
169 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
170 .desc = {
171 { }
172 },
173};
174
eb769f74
DB
175static QemuOptsList qemu_source_opts = {
176 .name = "source",
177 .implied_opt_name = "file",
178 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
179 .desc = {
180 { }
181 },
182};
183
7c30f657 184static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
f382d43a
MR
185{
186 int ret = 0;
187 if (!quiet) {
188 va_list args;
189 va_start(args, fmt);
190 ret = vprintf(fmt, args);
191 va_end(args);
192 }
193 return ret;
194}
195
ea2384d3 196
4ac8aacd
JS
197static int print_block_option_help(const char *filename, const char *fmt)
198{
199 BlockDriver *drv, *proto_drv;
83d0521a 200 QemuOptsList *create_opts = NULL;
b65a5e12 201 Error *local_err = NULL;
4ac8aacd
JS
202
203 /* Find driver and parse its options */
204 drv = bdrv_find_format(fmt);
205 if (!drv) {
15654a6d 206 error_report("Unknown file format '%s'", fmt);
4ac8aacd
JS
207 return 1;
208 }
209
c282e1fd 210 create_opts = qemu_opts_append(create_opts, drv->create_opts);
a283cb6e 211 if (filename) {
b65a5e12 212 proto_drv = bdrv_find_protocol(filename, true, &local_err);
a283cb6e 213 if (!proto_drv) {
2867ce4a 214 error_report_err(local_err);
83d0521a 215 qemu_opts_free(create_opts);
a283cb6e
KW
216 return 1;
217 }
c282e1fd 218 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
a283cb6e
KW
219 }
220
83d0521a
CL
221 qemu_opts_print_help(create_opts);
222 qemu_opts_free(create_opts);
4ac8aacd
JS
223 return 0;
224}
225
eb769f74
DB
226
227static int img_open_password(BlockBackend *blk, const char *filename,
abb06c5a 228 int flags, bool quiet)
75c23805
FB
229{
230 BlockDriverState *bs;
75c23805 231 char password[256];
eb769f74
DB
232
233 bs = blk_bs(blk);
4ef130fc
DB
234 if (bdrv_is_encrypted(bs) && bdrv_key_required(bs) &&
235 !(flags & BDRV_O_NO_IO)) {
eb769f74
DB
236 qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
237 if (qemu_read_password(password, sizeof(password)) < 0) {
238 error_report("No password given");
239 return -1;
240 }
241 if (bdrv_set_key(bs, password) < 0) {
242 error_report("invalid password");
243 return -1;
244 }
245 }
246 return 0;
247}
248
249
efaa7c4e 250static BlockBackend *img_open_opts(const char *optstr,
ce099547 251 QemuOpts *opts, int flags, bool writethrough,
abb06c5a 252 bool quiet)
eb769f74
DB
253{
254 QDict *options;
255 Error *local_err = NULL;
256 BlockBackend *blk;
257 options = qemu_opts_to_qdict(opts, NULL);
efaa7c4e 258 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
eb769f74 259 if (!blk) {
143605a2 260 error_reportf_err(local_err, "Could not open '%s': ", optstr);
eb769f74
DB
261 return NULL;
262 }
ce099547 263 blk_set_enable_write_cache(blk, !writethrough);
eb769f74 264
abb06c5a 265 if (img_open_password(blk, optstr, flags, quiet) < 0) {
eb769f74
DB
266 blk_unref(blk);
267 return NULL;
268 }
269 return blk;
270}
271
efaa7c4e 272static BlockBackend *img_open_file(const char *filename,
eb769f74 273 const char *fmt, int flags,
ce099547 274 bool writethrough, bool quiet)
eb769f74
DB
275{
276 BlockBackend *blk;
34b5d2c6 277 Error *local_err = NULL;
5bd31326 278 QDict *options = NULL;
ad717139 279
75c23805 280 if (fmt) {
5bd31326
HR
281 options = qdict_new();
282 qdict_put(options, "driver", qstring_from_str(fmt));
75c23805 283 }
b9eaf9ec 284
efaa7c4e 285 blk = blk_new_open(filename, NULL, options, flags, &local_err);
5bd31326 286 if (!blk) {
c29b77f9 287 error_reportf_err(local_err, "Could not open '%s': ", filename);
eb769f74 288 return NULL;
75c23805 289 }
ce099547 290 blk_set_enable_write_cache(blk, !writethrough);
b9eaf9ec 291
abb06c5a 292 if (img_open_password(blk, filename, flags, quiet) < 0) {
eb769f74
DB
293 blk_unref(blk);
294 return NULL;
295 }
296 return blk;
297}
298
299
efaa7c4e 300static BlockBackend *img_open(bool image_opts,
eb769f74 301 const char *filename,
ce099547 302 const char *fmt, int flags, bool writethrough,
abb06c5a 303 bool quiet)
eb769f74
DB
304{
305 BlockBackend *blk;
306 if (image_opts) {
307 QemuOpts *opts;
308 if (fmt) {
309 error_report("--image-opts and --format are mutually exclusive");
310 return NULL;
311 }
312 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
313 filename, true);
314 if (!opts) {
315 return NULL;
316 }
ce099547 317 blk = img_open_opts(filename, opts, flags, writethrough, quiet);
eb769f74 318 } else {
ce099547 319 blk = img_open_file(filename, fmt, flags, writethrough, quiet);
75c23805 320 }
7e7d56d9 321 return blk;
75c23805
FB
322}
323
eb769f74 324
83d0521a 325static int add_old_style_options(const char *fmt, QemuOpts *opts,
eec77d9e
JS
326 const char *base_filename,
327 const char *base_fmt)
efa84d43 328{
6750e795
MA
329 Error *err = NULL;
330
efa84d43 331 if (base_filename) {
f43e47db 332 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
6750e795 333 if (err) {
15654a6d
JS
334 error_report("Backing file not supported for file format '%s'",
335 fmt);
6750e795 336 error_free(err);
c2abccec 337 return -1;
efa84d43
KW
338 }
339 }
340 if (base_fmt) {
f43e47db 341 qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
6750e795 342 if (err) {
15654a6d
JS
343 error_report("Backing file format not supported for file "
344 "format '%s'", fmt);
6750e795 345 error_free(err);
c2abccec 346 return -1;
efa84d43
KW
347 }
348 }
c2abccec 349 return 0;
efa84d43
KW
350}
351
ea2384d3
FB
352static int img_create(int argc, char **argv)
353{
a9300911 354 int c;
1da7cfbd 355 uint64_t img_size = -1;
ea2384d3 356 const char *fmt = "raw";
9230eaf6 357 const char *base_fmt = NULL;
ea2384d3
FB
358 const char *filename;
359 const char *base_filename = NULL;
9ea2ea71 360 char *options = NULL;
9b37525a 361 Error *local_err = NULL;
f382d43a 362 bool quiet = false;
3b46e624 363
ea2384d3 364 for(;;) {
3babeb15
DB
365 static const struct option long_options[] = {
366 {"help", no_argument, 0, 'h'},
367 {"object", required_argument, 0, OPTION_OBJECT},
368 {0, 0, 0, 0}
369 };
370 c = getopt_long(argc, argv, "F:b:f:he6o:q",
371 long_options, NULL);
b8fb60da 372 if (c == -1) {
ea2384d3 373 break;
b8fb60da 374 }
ea2384d3 375 switch(c) {
ef87394c 376 case '?':
ea2384d3
FB
377 case 'h':
378 help();
379 break;
9230eaf6
AL
380 case 'F':
381 base_fmt = optarg;
382 break;
ea2384d3
FB
383 case 'b':
384 base_filename = optarg;
385 break;
386 case 'f':
387 fmt = optarg;
388 break;
389 case 'e':
9d42e15d 390 error_report("option -e is deprecated, please use \'-o "
eec77d9e 391 "encryption\' instead!");
77386bf6 392 goto fail;
d8871c5a 393 case '6':
9d42e15d 394 error_report("option -6 is deprecated, please use \'-o "
eec77d9e 395 "compat6\' instead!");
77386bf6 396 goto fail;
9ea2ea71 397 case 'o':
77386bf6
KW
398 if (!is_valid_option_list(optarg)) {
399 error_report("Invalid option list: %s", optarg);
400 goto fail;
401 }
402 if (!options) {
403 options = g_strdup(optarg);
404 } else {
405 char *old_options = options;
406 options = g_strdup_printf("%s,%s", options, optarg);
407 g_free(old_options);
408 }
9ea2ea71 409 break;
f382d43a
MR
410 case 'q':
411 quiet = true;
412 break;
3babeb15
DB
413 case OPTION_OBJECT: {
414 QemuOpts *opts;
415 opts = qemu_opts_parse_noisily(&qemu_object_opts,
416 optarg, true);
417 if (!opts) {
418 goto fail;
419 }
420 } break;
ea2384d3
FB
421 }
422 }
9230eaf6 423
b50cbabc 424 /* Get the filename */
a283cb6e
KW
425 filename = (optind < argc) ? argv[optind] : NULL;
426 if (options && has_help_option(options)) {
427 g_free(options);
428 return print_block_option_help(filename, fmt);
429 }
430
b8fb60da 431 if (optind >= argc) {
ac1307ab 432 error_exit("Expecting image file name");
b8fb60da 433 }
a283cb6e 434 optind++;
b50cbabc 435
3babeb15
DB
436 if (qemu_opts_foreach(&qemu_object_opts,
437 user_creatable_add_opts_foreach,
51b9b478 438 NULL, NULL)) {
3babeb15
DB
439 goto fail;
440 }
441
1da7cfbd
JS
442 /* Get image size, if specified */
443 if (optind < argc) {
70b4f4bb 444 int64_t sval;
e36b3695 445 char *end;
4677bb40
MAL
446 sval = qemu_strtosz_suffix(argv[optind++], &end,
447 QEMU_STRTOSZ_DEFSUFFIX_B);
e36b3695 448 if (sval < 0 || *end) {
79443397
LG
449 if (sval == -ERANGE) {
450 error_report("Image size must be less than 8 EiB!");
451 } else {
452 error_report("Invalid image size specified! You may use k, M, "
5e00984a
KW
453 "G, T, P or E suffixes for ");
454 error_report("kilobytes, megabytes, gigabytes, terabytes, "
455 "petabytes and exabytes.");
79443397 456 }
77386bf6 457 goto fail;
1da7cfbd
JS
458 }
459 img_size = (uint64_t)sval;
460 }
fc11eb26 461 if (optind != argc) {
ac1307ab 462 error_exit("Unexpected argument: %s", argv[optind]);
fc11eb26 463 }
1da7cfbd 464
9b37525a 465 bdrv_img_create(filename, fmt, base_filename, base_fmt,
61de4c68 466 options, img_size, 0, &local_err, quiet);
84d18f06 467 if (local_err) {
c29b77f9 468 error_reportf_err(local_err, "%s: ", filename);
77386bf6 469 goto fail;
c2abccec 470 }
a9300911 471
77386bf6 472 g_free(options);
ea2384d3 473 return 0;
77386bf6
KW
474
475fail:
476 g_free(options);
477 return 1;
ea2384d3
FB
478}
479
f382d43a 480static void dump_json_image_check(ImageCheck *check, bool quiet)
8599ea4c 481{
4399c438 482 Error *local_err = NULL;
8599ea4c
FS
483 QString *str;
484 QmpOutputVisitor *ov = qmp_output_visitor_new();
485 QObject *obj;
51e72bc1
EB
486 visit_type_ImageCheck(qmp_output_get_visitor(ov), NULL, &check,
487 &local_err);
8599ea4c
FS
488 obj = qmp_output_get_qobject(ov);
489 str = qobject_to_json_pretty(obj);
490 assert(str != NULL);
f382d43a 491 qprintf(quiet, "%s\n", qstring_get_str(str));
8599ea4c
FS
492 qobject_decref(obj);
493 qmp_output_visitor_cleanup(ov);
494 QDECREF(str);
495}
496
f382d43a 497static void dump_human_image_check(ImageCheck *check, bool quiet)
8599ea4c
FS
498{
499 if (!(check->corruptions || check->leaks || check->check_errors)) {
f382d43a 500 qprintf(quiet, "No errors were found on the image.\n");
8599ea4c
FS
501 } else {
502 if (check->corruptions) {
f382d43a
MR
503 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
504 "Data may be corrupted, or further writes to the image "
505 "may corrupt it.\n",
506 check->corruptions);
8599ea4c
FS
507 }
508
509 if (check->leaks) {
f382d43a
MR
510 qprintf(quiet,
511 "\n%" PRId64 " leaked clusters were found on the image.\n"
512 "This means waste of disk space, but no harm to data.\n",
513 check->leaks);
8599ea4c
FS
514 }
515
516 if (check->check_errors) {
f382d43a
MR
517 qprintf(quiet,
518 "\n%" PRId64
519 " internal errors have occurred during the check.\n",
520 check->check_errors);
8599ea4c
FS
521 }
522 }
523
524 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
f382d43a
MR
525 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
526 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
527 check->allocated_clusters, check->total_clusters,
528 check->allocated_clusters * 100.0 / check->total_clusters,
529 check->fragmented_clusters * 100.0 / check->allocated_clusters,
530 check->compressed_clusters * 100.0 /
531 check->allocated_clusters);
8599ea4c
FS
532 }
533
534 if (check->image_end_offset) {
f382d43a
MR
535 qprintf(quiet,
536 "Image end offset: %" PRId64 "\n", check->image_end_offset);
8599ea4c
FS
537 }
538}
539
540static int collect_image_check(BlockDriverState *bs,
541 ImageCheck *check,
542 const char *filename,
543 const char *fmt,
544 int fix)
545{
546 int ret;
547 BdrvCheckResult result;
548
549 ret = bdrv_check(bs, &result, fix);
550 if (ret < 0) {
551 return ret;
552 }
553
554 check->filename = g_strdup(filename);
555 check->format = g_strdup(bdrv_get_format_name(bs));
556 check->check_errors = result.check_errors;
557 check->corruptions = result.corruptions;
558 check->has_corruptions = result.corruptions != 0;
559 check->leaks = result.leaks;
560 check->has_leaks = result.leaks != 0;
561 check->corruptions_fixed = result.corruptions_fixed;
562 check->has_corruptions_fixed = result.corruptions != 0;
563 check->leaks_fixed = result.leaks_fixed;
564 check->has_leaks_fixed = result.leaks != 0;
565 check->image_end_offset = result.image_end_offset;
566 check->has_image_end_offset = result.image_end_offset != 0;
567 check->total_clusters = result.bfi.total_clusters;
568 check->has_total_clusters = result.bfi.total_clusters != 0;
569 check->allocated_clusters = result.bfi.allocated_clusters;
570 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
571 check->fragmented_clusters = result.bfi.fragmented_clusters;
572 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
e6439d78
SH
573 check->compressed_clusters = result.bfi.compressed_clusters;
574 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
8599ea4c
FS
575
576 return 0;
577}
578
e076f338
KW
579/*
580 * Checks an image for consistency. Exit codes:
581 *
d6635c4d
HR
582 * 0 - Check completed, image is good
583 * 1 - Check not completed because of internal errors
584 * 2 - Check completed, image is corrupted
585 * 3 - Check completed, image has leaked clusters, but is good otherwise
586 * 63 - Checks are not supported by the image format
e076f338 587 */
1585969c
AL
588static int img_check(int argc, char **argv)
589{
590 int c, ret;
8599ea4c 591 OutputFormat output_format = OFORMAT_HUMAN;
40055951 592 const char *filename, *fmt, *output, *cache;
26f54e9a 593 BlockBackend *blk;
1585969c 594 BlockDriverState *bs;
4534ff54 595 int fix = 0;
ce099547
KW
596 int flags = BDRV_O_CHECK;
597 bool writethrough;
7e7d56d9 598 ImageCheck *check;
f382d43a 599 bool quiet = false;
eb769f74 600 bool image_opts = false;
1585969c
AL
601
602 fmt = NULL;
8599ea4c 603 output = NULL;
40055951 604 cache = BDRV_DEFAULT_CACHE;
ce099547 605
1585969c 606 for(;;) {
8599ea4c
FS
607 int option_index = 0;
608 static const struct option long_options[] = {
609 {"help", no_argument, 0, 'h'},
610 {"format", required_argument, 0, 'f'},
4fd6a984 611 {"repair", required_argument, 0, 'r'},
8599ea4c 612 {"output", required_argument, 0, OPTION_OUTPUT},
3babeb15 613 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 614 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
8599ea4c
FS
615 {0, 0, 0, 0}
616 };
40055951 617 c = getopt_long(argc, argv, "hf:r:T:q",
8599ea4c 618 long_options, &option_index);
b8fb60da 619 if (c == -1) {
1585969c 620 break;
b8fb60da 621 }
1585969c 622 switch(c) {
ef87394c 623 case '?':
1585969c
AL
624 case 'h':
625 help();
626 break;
627 case 'f':
628 fmt = optarg;
629 break;
4534ff54
KW
630 case 'r':
631 flags |= BDRV_O_RDWR;
632
633 if (!strcmp(optarg, "leaks")) {
634 fix = BDRV_FIX_LEAKS;
635 } else if (!strcmp(optarg, "all")) {
636 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
637 } else {
ac1307ab
FZ
638 error_exit("Unknown option value for -r "
639 "(expecting 'leaks' or 'all'): %s", optarg);
4534ff54
KW
640 }
641 break;
8599ea4c
FS
642 case OPTION_OUTPUT:
643 output = optarg;
644 break;
40055951
HR
645 case 'T':
646 cache = optarg;
647 break;
f382d43a
MR
648 case 'q':
649 quiet = true;
650 break;
3babeb15
DB
651 case OPTION_OBJECT: {
652 QemuOpts *opts;
653 opts = qemu_opts_parse_noisily(&qemu_object_opts,
654 optarg, true);
655 if (!opts) {
656 return 1;
657 }
658 } break;
eb769f74
DB
659 case OPTION_IMAGE_OPTS:
660 image_opts = true;
661 break;
1585969c
AL
662 }
663 }
fc11eb26 664 if (optind != argc - 1) {
ac1307ab 665 error_exit("Expecting one image file name");
b8fb60da 666 }
1585969c
AL
667 filename = argv[optind++];
668
8599ea4c
FS
669 if (output && !strcmp(output, "json")) {
670 output_format = OFORMAT_JSON;
671 } else if (output && !strcmp(output, "human")) {
672 output_format = OFORMAT_HUMAN;
673 } else if (output) {
674 error_report("--output must be used with human or json as argument.");
675 return 1;
676 }
677
3babeb15
DB
678 if (qemu_opts_foreach(&qemu_object_opts,
679 user_creatable_add_opts_foreach,
51b9b478 680 NULL, NULL)) {
3babeb15
DB
681 return 1;
682 }
683
ce099547 684 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
40055951
HR
685 if (ret < 0) {
686 error_report("Invalid source cache option: %s", cache);
687 return 1;
688 }
689
ce099547 690 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
7e7d56d9
MA
691 if (!blk) {
692 return 1;
c2abccec 693 }
7e7d56d9 694 bs = blk_bs(blk);
8599ea4c
FS
695
696 check = g_new0(ImageCheck, 1);
697 ret = collect_image_check(bs, check, filename, fmt, fix);
e076f338
KW
698
699 if (ret == -ENOTSUP) {
55d492d7 700 error_report("This image format does not support checks");
fefddf95 701 ret = 63;
8599ea4c 702 goto fail;
e076f338
KW
703 }
704
8599ea4c
FS
705 if (check->corruptions_fixed || check->leaks_fixed) {
706 int corruptions_fixed, leaks_fixed;
ccf34716 707
8599ea4c
FS
708 leaks_fixed = check->leaks_fixed;
709 corruptions_fixed = check->corruptions_fixed;
e076f338 710
8599ea4c 711 if (output_format == OFORMAT_HUMAN) {
f382d43a
MR
712 qprintf(quiet,
713 "The following inconsistencies were found and repaired:\n\n"
714 " %" PRId64 " leaked clusters\n"
715 " %" PRId64 " corruptions\n\n"
716 "Double checking the fixed image now...\n",
717 check->leaks_fixed,
718 check->corruptions_fixed);
e076f338
KW
719 }
720
8599ea4c 721 ret = collect_image_check(bs, check, filename, fmt, 0);
1585969c 722
8599ea4c
FS
723 check->leaks_fixed = leaks_fixed;
724 check->corruptions_fixed = corruptions_fixed;
f8111c24
DXW
725 }
726
832390a5
HR
727 if (!ret) {
728 switch (output_format) {
729 case OFORMAT_HUMAN:
730 dump_human_image_check(check, quiet);
731 break;
732 case OFORMAT_JSON:
733 dump_json_image_check(check, quiet);
734 break;
735 }
c6bb9ad1
FS
736 }
737
8599ea4c 738 if (ret || check->check_errors) {
832390a5
HR
739 if (ret) {
740 error_report("Check failed: %s", strerror(-ret));
741 } else {
742 error_report("Check failed");
743 }
8599ea4c
FS
744 ret = 1;
745 goto fail;
c2abccec 746 }
e076f338 747
8599ea4c
FS
748 if (check->corruptions) {
749 ret = 2;
750 } else if (check->leaks) {
751 ret = 3;
e076f338 752 } else {
8599ea4c 753 ret = 0;
e076f338 754 }
8599ea4c
FS
755
756fail:
757 qapi_free_ImageCheck(check);
26f54e9a 758 blk_unref(blk);
8599ea4c 759 return ret;
1585969c
AL
760}
761
d4a3238a
HR
762typedef struct CommonBlockJobCBInfo {
763 BlockDriverState *bs;
764 Error **errp;
765} CommonBlockJobCBInfo;
766
767static void common_block_job_cb(void *opaque, int ret)
768{
769 CommonBlockJobCBInfo *cbi = opaque;
770
771 if (ret < 0) {
772 error_setg_errno(cbi->errp, -ret, "Block job failed");
773 }
d4a3238a
HR
774}
775
776static void run_block_job(BlockJob *job, Error **errp)
777{
b75536c9 778 AioContext *aio_context = blk_get_aio_context(job->blk);
d4a3238a
HR
779
780 do {
781 aio_poll(aio_context, true);
62547b8a
JS
782 qemu_progress_print(job->len ?
783 ((float)job->offset / job->len * 100.f) : 0.0f, 0);
d4a3238a
HR
784 } while (!job->ready);
785
786 block_job_complete_sync(job, errp);
687fa1d8
HR
787
788 /* A block job may finish instantaneously without publishing any progress,
789 * so just signal completion here */
790 qemu_progress_print(100.f, 0);
d4a3238a
HR
791}
792
ea2384d3
FB
793static int img_commit(int argc, char **argv)
794{
661a0f71 795 int c, ret, flags;
1b22bffd 796 const char *filename, *fmt, *cache, *base;
26f54e9a 797 BlockBackend *blk;
d4a3238a 798 BlockDriverState *bs, *base_bs;
687fa1d8 799 bool progress = false, quiet = false, drop = false;
ce099547 800 bool writethrough;
d4a3238a
HR
801 Error *local_err = NULL;
802 CommonBlockJobCBInfo cbi;
eb769f74 803 bool image_opts = false;
ea2384d3
FB
804
805 fmt = NULL;
661a0f71 806 cache = BDRV_DEFAULT_CACHE;
1b22bffd 807 base = NULL;
ea2384d3 808 for(;;) {
3babeb15
DB
809 static const struct option long_options[] = {
810 {"help", no_argument, 0, 'h'},
811 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 812 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
813 {0, 0, 0, 0}
814 };
815 c = getopt_long(argc, argv, "f:ht:b:dpq",
816 long_options, NULL);
b8fb60da 817 if (c == -1) {
ea2384d3 818 break;
b8fb60da 819 }
ea2384d3 820 switch(c) {
ef87394c 821 case '?':
ea2384d3
FB
822 case 'h':
823 help();
824 break;
825 case 'f':
826 fmt = optarg;
827 break;
661a0f71
FS
828 case 't':
829 cache = optarg;
830 break;
1b22bffd
HR
831 case 'b':
832 base = optarg;
833 /* -b implies -d */
834 drop = true;
835 break;
9a86fe48
HR
836 case 'd':
837 drop = true;
838 break;
687fa1d8
HR
839 case 'p':
840 progress = true;
841 break;
f382d43a
MR
842 case 'q':
843 quiet = true;
844 break;
3babeb15
DB
845 case OPTION_OBJECT: {
846 QemuOpts *opts;
847 opts = qemu_opts_parse_noisily(&qemu_object_opts,
848 optarg, true);
849 if (!opts) {
850 return 1;
851 }
852 } break;
eb769f74
DB
853 case OPTION_IMAGE_OPTS:
854 image_opts = true;
855 break;
ea2384d3
FB
856 }
857 }
687fa1d8
HR
858
859 /* Progress is not shown in Quiet mode */
860 if (quiet) {
861 progress = false;
862 }
863
fc11eb26 864 if (optind != argc - 1) {
ac1307ab 865 error_exit("Expecting one image file name");
b8fb60da 866 }
ea2384d3
FB
867 filename = argv[optind++];
868
3babeb15
DB
869 if (qemu_opts_foreach(&qemu_object_opts,
870 user_creatable_add_opts_foreach,
51b9b478 871 NULL, NULL)) {
3babeb15
DB
872 return 1;
873 }
874
9a86fe48 875 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
ce099547 876 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
661a0f71
FS
877 if (ret < 0) {
878 error_report("Invalid cache option: %s", cache);
a3981eb9 879 return 1;
661a0f71
FS
880 }
881
ce099547 882 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
7e7d56d9
MA
883 if (!blk) {
884 return 1;
c2abccec 885 }
7e7d56d9
MA
886 bs = blk_bs(blk);
887
687fa1d8
HR
888 qemu_progress_init(progress, 1.f);
889 qemu_progress_print(0.f, 100);
890
1b22bffd
HR
891 if (base) {
892 base_bs = bdrv_find_backing_image(bs, base);
893 if (!base_bs) {
c6bd8c70 894 error_setg(&local_err, QERR_BASE_NOT_FOUND, base);
1b22bffd
HR
895 goto done;
896 }
897 } else {
898 /* This is different from QMP, which by default uses the deepest file in
899 * the backing chain (i.e., the very base); however, the traditional
900 * behavior of qemu-img commit is using the immediate backing file. */
760e0063 901 base_bs = backing_bs(bs);
1b22bffd
HR
902 if (!base_bs) {
903 error_setg(&local_err, "Image does not have a backing file");
904 goto done;
905 }
d4a3238a
HR
906 }
907
908 cbi = (CommonBlockJobCBInfo){
909 .errp = &local_err,
910 .bs = bs,
911 };
912
913 commit_active_start(bs, base_bs, 0, BLOCKDEV_ON_ERROR_REPORT,
914 common_block_job_cb, &cbi, &local_err);
915 if (local_err) {
916 goto done;
ea2384d3
FB
917 }
918
3f09bfbc
KW
919 /* When the block job completes, the BlockBackend reference will point to
920 * the old backing file. In order to avoid that the top image is already
921 * deleted, so we can still empty it afterwards, increment the reference
922 * counter here preemptively. */
9a86fe48 923 if (!drop) {
3f09bfbc 924 bdrv_ref(bs);
9a86fe48
HR
925 }
926
d4a3238a 927 run_block_job(bs->job, &local_err);
9a86fe48
HR
928 if (local_err) {
929 goto unref_backing;
930 }
931
3f09bfbc
KW
932 if (!drop && bs->drv->bdrv_make_empty) {
933 ret = bs->drv->bdrv_make_empty(bs);
9a86fe48
HR
934 if (ret) {
935 error_setg_errno(&local_err, -ret, "Could not empty %s",
936 filename);
937 goto unref_backing;
938 }
939 }
940
941unref_backing:
942 if (!drop) {
3f09bfbc 943 bdrv_unref(bs);
9a86fe48 944 }
d4a3238a
HR
945
946done:
687fa1d8
HR
947 qemu_progress_end();
948
26f54e9a 949 blk_unref(blk);
d4a3238a
HR
950
951 if (local_err) {
6936f299 952 error_report_err(local_err);
c2abccec
MK
953 return 1;
954 }
d4a3238a
HR
955
956 qprintf(quiet, "Image committed.\n");
ea2384d3
FB
957 return 0;
958}
959
f58c7b35
TS
960/*
961 * Returns true iff the first sector pointed to by 'buf' contains at least
962 * a non-NUL byte.
963 *
964 * 'pnum' is set to the number of sectors (including and immediately following
965 * the first one) that are known to be in the same allocated/unallocated state.
966 */
ea2384d3
FB
967static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
968{
1a6d39fd
SH
969 bool is_zero;
970 int i;
ea2384d3
FB
971
972 if (n <= 0) {
973 *pnum = 0;
974 return 0;
975 }
1a6d39fd 976 is_zero = buffer_is_zero(buf, 512);
ea2384d3
FB
977 for(i = 1; i < n; i++) {
978 buf += 512;
1a6d39fd 979 if (is_zero != buffer_is_zero(buf, 512)) {
ea2384d3 980 break;
1a6d39fd 981 }
ea2384d3
FB
982 }
983 *pnum = i;
1a6d39fd 984 return !is_zero;
ea2384d3
FB
985}
986
a22f123c
KW
987/*
988 * Like is_allocated_sectors, but if the buffer starts with a used sector,
989 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
990 * breaking up write requests for only small sparse areas.
991 */
992static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
993 int min)
994{
995 int ret;
996 int num_checked, num_used;
997
998 if (n < min) {
999 min = n;
1000 }
1001
1002 ret = is_allocated_sectors(buf, n, pnum);
1003 if (!ret) {
1004 return ret;
1005 }
1006
1007 num_used = *pnum;
1008 buf += BDRV_SECTOR_SIZE * *pnum;
1009 n -= *pnum;
1010 num_checked = num_used;
1011
1012 while (n > 0) {
1013 ret = is_allocated_sectors(buf, n, pnum);
1014
1015 buf += BDRV_SECTOR_SIZE * *pnum;
1016 n -= *pnum;
1017 num_checked += *pnum;
1018 if (ret) {
1019 num_used = num_checked;
1020 } else if (*pnum >= min) {
1021 break;
1022 }
1023 }
1024
1025 *pnum = num_used;
1026 return 1;
1027}
1028
3e85c6fd
KW
1029/*
1030 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1031 * buffers matches, non-zero otherwise.
1032 *
1033 * pnum is set to the number of sectors (including and immediately following
1034 * the first one) that are known to have the same comparison result
1035 */
1036static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
1037 int *pnum)
1038{
8c1ac475
RK
1039 bool res;
1040 int i;
3e85c6fd
KW
1041
1042 if (n <= 0) {
1043 *pnum = 0;
1044 return 0;
1045 }
1046
1047 res = !!memcmp(buf1, buf2, 512);
1048 for(i = 1; i < n; i++) {
1049 buf1 += 512;
1050 buf2 += 512;
1051
1052 if (!!memcmp(buf1, buf2, 512) != res) {
1053 break;
1054 }
1055 }
1056
1057 *pnum = i;
1058 return res;
1059}
1060
80ee15a6 1061#define IO_BUF_SIZE (2 * 1024 * 1024)
ea2384d3 1062
d14ed18c
MR
1063static int64_t sectors_to_bytes(int64_t sectors)
1064{
1065 return sectors << BDRV_SECTOR_BITS;
1066}
1067
1068static int64_t sectors_to_process(int64_t total, int64_t from)
1069{
1070 return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
1071}
1072
1073/*
1074 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1075 *
1076 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1077 * data and negative value on error.
1078 *
f1d3cd79 1079 * @param blk: BlockBackend for the image
d14ed18c
MR
1080 * @param sect_num: Number of first sector to check
1081 * @param sect_count: Number of sectors to check
1082 * @param filename: Name of disk file we are checking (logging purpose)
1083 * @param buffer: Allocated buffer for storing read data
1084 * @param quiet: Flag for quiet mode
1085 */
f1d3cd79 1086static int check_empty_sectors(BlockBackend *blk, int64_t sect_num,
d14ed18c
MR
1087 int sect_count, const char *filename,
1088 uint8_t *buffer, bool quiet)
1089{
1090 int pnum, ret = 0;
9166920a
EB
1091 ret = blk_pread(blk, sect_num << BDRV_SECTOR_BITS, buffer,
1092 sect_count << BDRV_SECTOR_BITS);
d14ed18c
MR
1093 if (ret < 0) {
1094 error_report("Error while reading offset %" PRId64 " of %s: %s",
1095 sectors_to_bytes(sect_num), filename, strerror(-ret));
1096 return ret;
1097 }
1098 ret = is_allocated_sectors(buffer, sect_count, &pnum);
1099 if (ret || pnum != sect_count) {
1100 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1101 sectors_to_bytes(ret ? sect_num : sect_num + pnum));
1102 return 1;
1103 }
1104
1105 return 0;
1106}
1107
1108/*
1109 * Compares two images. Exit codes:
1110 *
1111 * 0 - Images are identical
1112 * 1 - Images differ
1113 * >1 - Error occurred
1114 */
1115static int img_compare(int argc, char **argv)
1116{
40055951 1117 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
26f54e9a 1118 BlockBackend *blk1, *blk2;
d14ed18c
MR
1119 BlockDriverState *bs1, *bs2;
1120 int64_t total_sectors1, total_sectors2;
1121 uint8_t *buf1 = NULL, *buf2 = NULL;
1122 int pnum1, pnum2;
1123 int allocated1, allocated2;
1124 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1125 bool progress = false, quiet = false, strict = false;
40055951 1126 int flags;
ce099547 1127 bool writethrough;
d14ed18c
MR
1128 int64_t total_sectors;
1129 int64_t sector_num = 0;
1130 int64_t nb_sectors;
1131 int c, pnum;
d14ed18c 1132 uint64_t progress_base;
eb769f74 1133 bool image_opts = false;
d14ed18c 1134
40055951 1135 cache = BDRV_DEFAULT_CACHE;
d14ed18c 1136 for (;;) {
3babeb15
DB
1137 static const struct option long_options[] = {
1138 {"help", no_argument, 0, 'h'},
1139 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 1140 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
1141 {0, 0, 0, 0}
1142 };
1143 c = getopt_long(argc, argv, "hf:F:T:pqs",
1144 long_options, NULL);
d14ed18c
MR
1145 if (c == -1) {
1146 break;
1147 }
1148 switch (c) {
1149 case '?':
1150 case 'h':
1151 help();
1152 break;
1153 case 'f':
1154 fmt1 = optarg;
1155 break;
1156 case 'F':
1157 fmt2 = optarg;
1158 break;
40055951
HR
1159 case 'T':
1160 cache = optarg;
1161 break;
d14ed18c
MR
1162 case 'p':
1163 progress = true;
1164 break;
1165 case 'q':
1166 quiet = true;
1167 break;
1168 case 's':
1169 strict = true;
1170 break;
3babeb15
DB
1171 case OPTION_OBJECT: {
1172 QemuOpts *opts;
1173 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1174 optarg, true);
1175 if (!opts) {
1176 ret = 2;
1177 goto out4;
1178 }
1179 } break;
eb769f74
DB
1180 case OPTION_IMAGE_OPTS:
1181 image_opts = true;
1182 break;
d14ed18c
MR
1183 }
1184 }
1185
1186 /* Progress is not shown in Quiet mode */
1187 if (quiet) {
1188 progress = false;
1189 }
1190
1191
fc11eb26 1192 if (optind != argc - 2) {
ac1307ab 1193 error_exit("Expecting two image file names");
d14ed18c
MR
1194 }
1195 filename1 = argv[optind++];
1196 filename2 = argv[optind++];
1197
3babeb15
DB
1198 if (qemu_opts_foreach(&qemu_object_opts,
1199 user_creatable_add_opts_foreach,
51b9b478 1200 NULL, NULL)) {
3babeb15
DB
1201 ret = 2;
1202 goto out4;
1203 }
1204
cbda016d
SH
1205 /* Initialize before goto out */
1206 qemu_progress_init(progress, 2.0);
1207
ce099547
KW
1208 flags = 0;
1209 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
40055951
HR
1210 if (ret < 0) {
1211 error_report("Invalid source cache option: %s", cache);
1212 ret = 2;
1213 goto out3;
1214 }
1215
ce099547 1216 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet);
7e7d56d9 1217 if (!blk1) {
d14ed18c 1218 ret = 2;
7e7d56d9 1219 goto out3;
d14ed18c
MR
1220 }
1221
ce099547 1222 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet);
7e7d56d9 1223 if (!blk2) {
d14ed18c 1224 ret = 2;
7e7d56d9 1225 goto out2;
d14ed18c 1226 }
eb769f74 1227 bs1 = blk_bs(blk1);
7e7d56d9 1228 bs2 = blk_bs(blk2);
d14ed18c 1229
f1d3cd79
HR
1230 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1231 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1232 total_sectors1 = blk_nb_sectors(blk1);
52bf1e72
MA
1233 if (total_sectors1 < 0) {
1234 error_report("Can't get size of %s: %s",
1235 filename1, strerror(-total_sectors1));
1236 ret = 4;
1237 goto out;
1238 }
f1d3cd79 1239 total_sectors2 = blk_nb_sectors(blk2);
52bf1e72
MA
1240 if (total_sectors2 < 0) {
1241 error_report("Can't get size of %s: %s",
1242 filename2, strerror(-total_sectors2));
1243 ret = 4;
1244 goto out;
1245 }
d14ed18c
MR
1246 total_sectors = MIN(total_sectors1, total_sectors2);
1247 progress_base = MAX(total_sectors1, total_sectors2);
1248
1249 qemu_progress_print(0, 100);
1250
1251 if (strict && total_sectors1 != total_sectors2) {
1252 ret = 1;
1253 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1254 goto out;
1255 }
1256
1257 for (;;) {
25ad8e6e 1258 int64_t status1, status2;
67a0fd2a
FZ
1259 BlockDriverState *file;
1260
d14ed18c
MR
1261 nb_sectors = sectors_to_process(total_sectors, sector_num);
1262 if (nb_sectors <= 0) {
1263 break;
1264 }
25ad8e6e
FZ
1265 status1 = bdrv_get_block_status_above(bs1, NULL, sector_num,
1266 total_sectors1 - sector_num,
67a0fd2a 1267 &pnum1, &file);
25ad8e6e 1268 if (status1 < 0) {
d14ed18c
MR
1269 ret = 3;
1270 error_report("Sector allocation test failed for %s", filename1);
1271 goto out;
1272 }
25ad8e6e 1273 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
d14ed18c 1274
25ad8e6e
FZ
1275 status2 = bdrv_get_block_status_above(bs2, NULL, sector_num,
1276 total_sectors2 - sector_num,
67a0fd2a 1277 &pnum2, &file);
25ad8e6e 1278 if (status2 < 0) {
d14ed18c
MR
1279 ret = 3;
1280 error_report("Sector allocation test failed for %s", filename2);
1281 goto out;
1282 }
25ad8e6e
FZ
1283 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1284 if (pnum1) {
1285 nb_sectors = MIN(nb_sectors, pnum1);
1286 }
1287 if (pnum2) {
1288 nb_sectors = MIN(nb_sectors, pnum2);
1289 }
d14ed18c 1290
25ad8e6e
FZ
1291 if (strict) {
1292 if ((status1 & ~BDRV_BLOCK_OFFSET_MASK) !=
1293 (status2 & ~BDRV_BLOCK_OFFSET_MASK)) {
1294 ret = 1;
1295 qprintf(quiet, "Strict mode: Offset %" PRId64
1296 " block status mismatch!\n",
1297 sectors_to_bytes(sector_num));
1298 goto out;
1299 }
1300 }
1301 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1302 nb_sectors = MIN(pnum1, pnum2);
1303 } else if (allocated1 == allocated2) {
d14ed18c 1304 if (allocated1) {
9166920a
EB
1305 ret = blk_pread(blk1, sector_num << BDRV_SECTOR_BITS, buf1,
1306 nb_sectors << BDRV_SECTOR_BITS);
d14ed18c
MR
1307 if (ret < 0) {
1308 error_report("Error while reading offset %" PRId64 " of %s:"
1309 " %s", sectors_to_bytes(sector_num), filename1,
1310 strerror(-ret));
1311 ret = 4;
1312 goto out;
1313 }
9166920a
EB
1314 ret = blk_pread(blk2, sector_num << BDRV_SECTOR_BITS, buf2,
1315 nb_sectors << BDRV_SECTOR_BITS);
d14ed18c
MR
1316 if (ret < 0) {
1317 error_report("Error while reading offset %" PRId64
1318 " of %s: %s", sectors_to_bytes(sector_num),
1319 filename2, strerror(-ret));
1320 ret = 4;
1321 goto out;
1322 }
1323 ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
1324 if (ret || pnum != nb_sectors) {
d14ed18c
MR
1325 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1326 sectors_to_bytes(
1327 ret ? sector_num : sector_num + pnum));
36452f12 1328 ret = 1;
d14ed18c
MR
1329 goto out;
1330 }
1331 }
1332 } else {
d14ed18c
MR
1333
1334 if (allocated1) {
f1d3cd79 1335 ret = check_empty_sectors(blk1, sector_num, nb_sectors,
d14ed18c
MR
1336 filename1, buf1, quiet);
1337 } else {
f1d3cd79 1338 ret = check_empty_sectors(blk2, sector_num, nb_sectors,
d14ed18c
MR
1339 filename2, buf1, quiet);
1340 }
1341 if (ret) {
1342 if (ret < 0) {
d14ed18c
MR
1343 error_report("Error while reading offset %" PRId64 ": %s",
1344 sectors_to_bytes(sector_num), strerror(-ret));
36452f12 1345 ret = 4;
d14ed18c
MR
1346 }
1347 goto out;
1348 }
1349 }
1350 sector_num += nb_sectors;
1351 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1352 }
1353
1354 if (total_sectors1 != total_sectors2) {
f1d3cd79 1355 BlockBackend *blk_over;
d14ed18c
MR
1356 int64_t total_sectors_over;
1357 const char *filename_over;
1358
1359 qprintf(quiet, "Warning: Image size mismatch!\n");
1360 if (total_sectors1 > total_sectors2) {
1361 total_sectors_over = total_sectors1;
f1d3cd79 1362 blk_over = blk1;
d14ed18c
MR
1363 filename_over = filename1;
1364 } else {
1365 total_sectors_over = total_sectors2;
f1d3cd79 1366 blk_over = blk2;
d14ed18c
MR
1367 filename_over = filename2;
1368 }
1369
1370 for (;;) {
1371 nb_sectors = sectors_to_process(total_sectors_over, sector_num);
1372 if (nb_sectors <= 0) {
1373 break;
1374 }
f1d3cd79 1375 ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
d14ed18c
MR
1376 nb_sectors, &pnum);
1377 if (ret < 0) {
1378 ret = 3;
1379 error_report("Sector allocation test failed for %s",
1380 filename_over);
1381 goto out;
1382
1383 }
1384 nb_sectors = pnum;
1385 if (ret) {
f1d3cd79 1386 ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
d14ed18c
MR
1387 filename_over, buf1, quiet);
1388 if (ret) {
1389 if (ret < 0) {
d14ed18c
MR
1390 error_report("Error while reading offset %" PRId64
1391 " of %s: %s", sectors_to_bytes(sector_num),
1392 filename_over, strerror(-ret));
36452f12 1393 ret = 4;
d14ed18c
MR
1394 }
1395 goto out;
1396 }
1397 }
1398 sector_num += nb_sectors;
1399 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1400 }
1401 }
1402
1403 qprintf(quiet, "Images are identical.\n");
1404 ret = 0;
1405
1406out:
d14ed18c
MR
1407 qemu_vfree(buf1);
1408 qemu_vfree(buf2);
26f54e9a 1409 blk_unref(blk2);
d14ed18c 1410out2:
26f54e9a 1411 blk_unref(blk1);
d14ed18c
MR
1412out3:
1413 qemu_progress_end();
3babeb15 1414out4:
d14ed18c
MR
1415 return ret;
1416}
1417
690c7301
KW
1418enum ImgConvertBlockStatus {
1419 BLK_DATA,
1420 BLK_ZERO,
1421 BLK_BACKING_FILE,
1422};
1423
1424typedef struct ImgConvertState {
1425 BlockBackend **src;
1426 int64_t *src_sectors;
1427 int src_cur, src_num;
1428 int64_t src_cur_offset;
1429 int64_t total_sectors;
1430 int64_t allocated_sectors;
1431 enum ImgConvertBlockStatus status;
1432 int64_t sector_next_status;
1433 BlockBackend *target;
1434 bool has_zero_init;
1435 bool compressed;
1436 bool target_has_backing;
1437 int min_sparse;
1438 size_t cluster_sectors;
1439 size_t buf_sectors;
1440} ImgConvertState;
1441
1442static void convert_select_part(ImgConvertState *s, int64_t sector_num)
1443{
1444 assert(sector_num >= s->src_cur_offset);
1445 while (sector_num - s->src_cur_offset >= s->src_sectors[s->src_cur]) {
1446 s->src_cur_offset += s->src_sectors[s->src_cur];
1447 s->src_cur++;
1448 assert(s->src_cur < s->src_num);
1449 }
1450}
1451
1452static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1453{
1454 int64_t ret;
1455 int n;
1456
1457 convert_select_part(s, sector_num);
1458
1459 assert(s->total_sectors > sector_num);
1460 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1461
1462 if (s->sector_next_status <= sector_num) {
67a0fd2a 1463 BlockDriverState *file;
690c7301
KW
1464 ret = bdrv_get_block_status(blk_bs(s->src[s->src_cur]),
1465 sector_num - s->src_cur_offset,
67a0fd2a 1466 n, &n, &file);
690c7301
KW
1467 if (ret < 0) {
1468 return ret;
1469 }
1470
1471 if (ret & BDRV_BLOCK_ZERO) {
1472 s->status = BLK_ZERO;
1473 } else if (ret & BDRV_BLOCK_DATA) {
1474 s->status = BLK_DATA;
1475 } else if (!s->target_has_backing) {
1476 /* Without a target backing file we must copy over the contents of
1477 * the backing file as well. */
263a6f4c 1478 /* Check block status of the backing file chain to avoid
690c7301
KW
1479 * needlessly reading zeroes and limiting the iteration to the
1480 * buffer size */
263a6f4c
RK
1481 ret = bdrv_get_block_status_above(blk_bs(s->src[s->src_cur]), NULL,
1482 sector_num - s->src_cur_offset,
1483 n, &n, &file);
1484 if (ret < 0) {
1485 return ret;
1486 }
1487
1488 if (ret & BDRV_BLOCK_ZERO) {
1489 s->status = BLK_ZERO;
1490 } else {
1491 s->status = BLK_DATA;
1492 }
690c7301
KW
1493 } else {
1494 s->status = BLK_BACKING_FILE;
1495 }
1496
1497 s->sector_next_status = sector_num + n;
1498 }
1499
1500 n = MIN(n, s->sector_next_status - sector_num);
1501 if (s->status == BLK_DATA) {
1502 n = MIN(n, s->buf_sectors);
1503 }
1504
1505 /* We need to write complete clusters for compressed images, so if an
1506 * unallocated area is shorter than that, we must consider the whole
1507 * cluster allocated. */
1508 if (s->compressed) {
1509 if (n < s->cluster_sectors) {
1510 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1511 s->status = BLK_DATA;
1512 } else {
1513 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1514 }
1515 }
1516
1517 return n;
1518}
1519
1520static int convert_read(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1521 uint8_t *buf)
1522{
1523 int n;
1524 int ret;
1525
690c7301
KW
1526 assert(nb_sectors <= s->buf_sectors);
1527 while (nb_sectors > 0) {
1528 BlockBackend *blk;
1529 int64_t bs_sectors;
1530
1531 /* In the case of compression with multiple source files, we can get a
1532 * nb_sectors that spreads into the next part. So we must be able to
1533 * read across multiple BDSes for one convert_read() call. */
1534 convert_select_part(s, sector_num);
1535 blk = s->src[s->src_cur];
1536 bs_sectors = s->src_sectors[s->src_cur];
1537
1538 n = MIN(nb_sectors, bs_sectors - (sector_num - s->src_cur_offset));
9166920a
EB
1539 ret = blk_pread(blk,
1540 (sector_num - s->src_cur_offset) << BDRV_SECTOR_BITS,
1541 buf, n << BDRV_SECTOR_BITS);
690c7301
KW
1542 if (ret < 0) {
1543 return ret;
1544 }
1545
1546 sector_num += n;
1547 nb_sectors -= n;
1548 buf += n * BDRV_SECTOR_SIZE;
1549 }
1550
1551 return 0;
1552}
1553
1554static int convert_write(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1555 const uint8_t *buf)
1556{
1557 int ret;
1558
1559 while (nb_sectors > 0) {
1560 int n = nb_sectors;
1561
1562 switch (s->status) {
1563 case BLK_BACKING_FILE:
1564 /* If we have a backing file, leave clusters unallocated that are
1565 * unallocated in the source image, so that the backing file is
1566 * visible at the respective offset. */
1567 assert(s->target_has_backing);
1568 break;
1569
1570 case BLK_DATA:
1571 /* We must always write compressed clusters as a whole, so don't
1572 * try to find zeroed parts in the buffer. We can only save the
1573 * write if the buffer is completely zeroed and we're allowed to
1574 * keep the target sparse. */
1575 if (s->compressed) {
1576 if (s->has_zero_init && s->min_sparse &&
1577 buffer_is_zero(buf, n * BDRV_SECTOR_SIZE))
1578 {
1579 assert(!s->target_has_backing);
1580 break;
1581 }
1582
1583 ret = blk_write_compressed(s->target, sector_num, buf, n);
1584 if (ret < 0) {
1585 return ret;
1586 }
1587 break;
1588 }
1589
1590 /* If there is real non-zero data or we're told to keep the target
1591 * fully allocated (-S 0), we must write it. Otherwise we can treat
1592 * it as zero sectors. */
1593 if (!s->min_sparse ||
1594 is_allocated_sectors_min(buf, n, &n, s->min_sparse))
1595 {
9166920a
EB
1596 ret = blk_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1597 buf, n << BDRV_SECTOR_BITS, 0);
690c7301
KW
1598 if (ret < 0) {
1599 return ret;
1600 }
1601 break;
1602 }
1603 /* fall-through */
1604
1605 case BLK_ZERO:
1606 if (s->has_zero_init) {
1607 break;
1608 }
d004bd52
EB
1609 ret = blk_pwrite_zeroes(s->target, sector_num << BDRV_SECTOR_BITS,
1610 n << BDRV_SECTOR_BITS, 0);
690c7301
KW
1611 if (ret < 0) {
1612 return ret;
1613 }
1614 break;
1615 }
1616
1617 sector_num += n;
1618 nb_sectors -= n;
1619 buf += n * BDRV_SECTOR_SIZE;
1620 }
1621
1622 return 0;
1623}
1624
1625static int convert_do_copy(ImgConvertState *s)
1626{
1627 uint8_t *buf = NULL;
1628 int64_t sector_num, allocated_done;
1629 int ret;
1630 int n;
1631
1632 /* Check whether we have zero initialisation or can get it efficiently */
1633 s->has_zero_init = s->min_sparse && !s->target_has_backing
1634 ? bdrv_has_zero_init(blk_bs(s->target))
1635 : false;
1636
1637 if (!s->has_zero_init && !s->target_has_backing &&
1638 bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
1639 {
1640 ret = bdrv_make_zero(blk_bs(s->target), BDRV_REQ_MAY_UNMAP);
1641 if (ret == 0) {
1642 s->has_zero_init = true;
1643 }
1644 }
1645
1646 /* Allocate buffer for copied data. For compressed images, only one cluster
1647 * can be copied at a time. */
1648 if (s->compressed) {
1649 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
1650 error_report("invalid cluster size");
1651 ret = -EINVAL;
1652 goto fail;
1653 }
1654 s->buf_sectors = s->cluster_sectors;
1655 }
1656 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1657
1658 /* Calculate allocated sectors for progress */
1659 s->allocated_sectors = 0;
1660 sector_num = 0;
1661 while (sector_num < s->total_sectors) {
1662 n = convert_iteration_sectors(s, sector_num);
1663 if (n < 0) {
1664 ret = n;
1665 goto fail;
1666 }
aad15de4
HR
1667 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1668 {
690c7301
KW
1669 s->allocated_sectors += n;
1670 }
1671 sector_num += n;
1672 }
1673
1674 /* Do the copy */
1675 s->src_cur = 0;
1676 s->src_cur_offset = 0;
1677 s->sector_next_status = 0;
1678
1679 sector_num = 0;
1680 allocated_done = 0;
1681
1682 while (sector_num < s->total_sectors) {
1683 n = convert_iteration_sectors(s, sector_num);
1684 if (n < 0) {
1685 ret = n;
1686 goto fail;
1687 }
aad15de4
HR
1688 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1689 {
690c7301
KW
1690 allocated_done += n;
1691 qemu_progress_print(100.0 * allocated_done / s->allocated_sectors,
1692 0);
1693 }
1694
aad15de4
HR
1695 if (s->status == BLK_DATA) {
1696 ret = convert_read(s, sector_num, n, buf);
1697 if (ret < 0) {
1698 error_report("error while reading sector %" PRId64
1699 ": %s", sector_num, strerror(-ret));
1700 goto fail;
1701 }
1702 } else if (!s->min_sparse && s->status == BLK_ZERO) {
1703 n = MIN(n, s->buf_sectors);
1704 memset(buf, 0, n * BDRV_SECTOR_SIZE);
1705 s->status = BLK_DATA;
690c7301
KW
1706 }
1707
1708 ret = convert_write(s, sector_num, n, buf);
1709 if (ret < 0) {
1710 error_report("error while writing sector %" PRId64
1711 ": %s", sector_num, strerror(-ret));
1712 goto fail;
1713 }
1714
1715 sector_num += n;
1716 }
1717
1718 if (s->compressed) {
1719 /* signal EOF to align */
1720 ret = blk_write_compressed(s->target, 0, NULL, 0);
1721 if (ret < 0) {
1722 goto fail;
1723 }
1724 }
1725
1726 ret = 0;
1727fail:
1728 qemu_vfree(buf);
1729 return ret;
1730}
1731
ea2384d3
FB
1732static int img_convert(int argc, char **argv)
1733{
690c7301 1734 int c, bs_n, bs_i, compress, cluster_sectors, skip_create;
13c28af8 1735 int64_t ret = 0;
40055951 1736 int progress = 0, flags, src_flags;
ce099547 1737 bool writethrough, src_writethrough;
40055951 1738 const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
b50cbabc 1739 BlockDriver *drv, *proto_drv;
26f54e9a 1740 BlockBackend **blk = NULL, *out_blk = NULL;
c2abccec 1741 BlockDriverState **bs = NULL, *out_bs = NULL;
690c7301 1742 int64_t total_sectors;
52bf1e72 1743 int64_t *bs_sectors = NULL;
f2521c90 1744 size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
faea38e7 1745 BlockDriverInfo bdi;
83d0521a
CL
1746 QemuOpts *opts = NULL;
1747 QemuOptsList *create_opts = NULL;
1748 const char *out_baseimg_param;
efa84d43 1749 char *options = NULL;
51ef6727 1750 const char *snapshot_name = NULL;
a22f123c 1751 int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
f382d43a 1752 bool quiet = false;
cc84d90f 1753 Error *local_err = NULL;
ef80654d 1754 QemuOpts *sn_opts = NULL;
690c7301 1755 ImgConvertState state;
eb769f74 1756 bool image_opts = false;
ea2384d3
FB
1757
1758 fmt = NULL;
1759 out_fmt = "raw";
661a0f71 1760 cache = "unsafe";
40055951 1761 src_cache = BDRV_DEFAULT_CACHE;
f58c7b35 1762 out_baseimg = NULL;
eec77d9e 1763 compress = 0;
b2e10493 1764 skip_create = 0;
ea2384d3 1765 for(;;) {
3babeb15
DB
1766 static const struct option long_options[] = {
1767 {"help", no_argument, 0, 'h'},
1768 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 1769 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
1770 {0, 0, 0, 0}
1771 };
1772 c = getopt_long(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qn",
1773 long_options, NULL);
b8fb60da 1774 if (c == -1) {
ea2384d3 1775 break;
b8fb60da 1776 }
ea2384d3 1777 switch(c) {
ef87394c 1778 case '?':
ea2384d3
FB
1779 case 'h':
1780 help();
1781 break;
1782 case 'f':
1783 fmt = optarg;
1784 break;
1785 case 'O':
1786 out_fmt = optarg;
1787 break;
f58c7b35
TS
1788 case 'B':
1789 out_baseimg = optarg;
1790 break;
ea2384d3 1791 case 'c':
eec77d9e 1792 compress = 1;
ea2384d3
FB
1793 break;
1794 case 'e':
9d42e15d 1795 error_report("option -e is deprecated, please use \'-o "
eec77d9e 1796 "encryption\' instead!");
2dc8328b 1797 ret = -1;
64bb01aa 1798 goto fail_getopt;
ec36ba14 1799 case '6':
9d42e15d 1800 error_report("option -6 is deprecated, please use \'-o "
eec77d9e 1801 "compat6\' instead!");
2dc8328b 1802 ret = -1;
64bb01aa 1803 goto fail_getopt;
efa84d43 1804 case 'o':
2dc8328b
KW
1805 if (!is_valid_option_list(optarg)) {
1806 error_report("Invalid option list: %s", optarg);
1807 ret = -1;
64bb01aa 1808 goto fail_getopt;
2dc8328b
KW
1809 }
1810 if (!options) {
1811 options = g_strdup(optarg);
1812 } else {
1813 char *old_options = options;
1814 options = g_strdup_printf("%s,%s", options, optarg);
1815 g_free(old_options);
1816 }
efa84d43 1817 break;
51ef6727 1818 case 's':
1819 snapshot_name = optarg;
1820 break;
ef80654d
WX
1821 case 'l':
1822 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
70b94331
MA
1823 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
1824 optarg, false);
ef80654d
WX
1825 if (!sn_opts) {
1826 error_report("Failed in parsing snapshot param '%s'",
1827 optarg);
2dc8328b 1828 ret = -1;
64bb01aa 1829 goto fail_getopt;
ef80654d
WX
1830 }
1831 } else {
1832 snapshot_name = optarg;
1833 }
1834 break;
a22f123c
KW
1835 case 'S':
1836 {
1837 int64_t sval;
e36b3695 1838 char *end;
4677bb40 1839 sval = qemu_strtosz_suffix(optarg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
e36b3695 1840 if (sval < 0 || *end) {
a22f123c 1841 error_report("Invalid minimum zero buffer size for sparse output specified");
2dc8328b 1842 ret = -1;
64bb01aa 1843 goto fail_getopt;
a22f123c
KW
1844 }
1845
1846 min_sparse = sval / BDRV_SECTOR_SIZE;
1847 break;
1848 }
6b837bc4
JS
1849 case 'p':
1850 progress = 1;
1851 break;
661a0f71
FS
1852 case 't':
1853 cache = optarg;
1854 break;
40055951
HR
1855 case 'T':
1856 src_cache = optarg;
1857 break;
f382d43a
MR
1858 case 'q':
1859 quiet = true;
1860 break;
b2e10493
AD
1861 case 'n':
1862 skip_create = 1;
1863 break;
3babeb15
DB
1864 case OPTION_OBJECT:
1865 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1866 optarg, true);
1867 if (!opts) {
1868 goto fail_getopt;
1869 }
1870 break;
eb769f74
DB
1871 case OPTION_IMAGE_OPTS:
1872 image_opts = true;
1873 break;
ea2384d3
FB
1874 }
1875 }
3b46e624 1876
3babeb15
DB
1877 if (qemu_opts_foreach(&qemu_object_opts,
1878 user_creatable_add_opts_foreach,
51b9b478 1879 NULL, NULL)) {
3babeb15
DB
1880 goto fail_getopt;
1881 }
1882
64bb01aa 1883 /* Initialize before goto out */
f382d43a
MR
1884 if (quiet) {
1885 progress = 0;
1886 }
64bb01aa
KW
1887 qemu_progress_init(progress, 1.0);
1888
926c2d23 1889 bs_n = argc - optind - 1;
a283cb6e 1890 out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
f58c7b35 1891
2dc8328b 1892 if (options && has_help_option(options)) {
4ac8aacd
JS
1893 ret = print_block_option_help(out_filename, out_fmt);
1894 goto out;
1895 }
1896
a283cb6e 1897 if (bs_n < 1) {
ac1307ab 1898 error_exit("Must specify image file name");
a283cb6e
KW
1899 }
1900
1901
c2abccec 1902 if (bs_n > 1 && out_baseimg) {
15654a6d
JS
1903 error_report("-B makes no sense when concatenating multiple input "
1904 "images");
31ca34b8
JS
1905 ret = -1;
1906 goto out;
c2abccec 1907 }
f8111c24 1908
ce099547
KW
1909 src_flags = 0;
1910 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
40055951
HR
1911 if (ret < 0) {
1912 error_report("Invalid source cache option: %s", src_cache);
1913 goto out;
1914 }
1915
6b837bc4
JS
1916 qemu_progress_print(0, 100);
1917
26f54e9a 1918 blk = g_new0(BlockBackend *, bs_n);
d739f1c4 1919 bs = g_new0(BlockDriverState *, bs_n);
52bf1e72 1920 bs_sectors = g_new(int64_t, bs_n);
926c2d23
AZ
1921
1922 total_sectors = 0;
1923 for (bs_i = 0; bs_i < bs_n; bs_i++) {
efaa7c4e 1924 blk[bs_i] = img_open(image_opts, argv[optind + bs_i],
ce099547 1925 fmt, src_flags, src_writethrough, quiet);
7e7d56d9 1926 if (!blk[bs_i]) {
c2abccec
MK
1927 ret = -1;
1928 goto out;
1929 }
7e7d56d9 1930 bs[bs_i] = blk_bs(blk[bs_i]);
f1d3cd79 1931 bs_sectors[bs_i] = blk_nb_sectors(blk[bs_i]);
52bf1e72
MA
1932 if (bs_sectors[bs_i] < 0) {
1933 error_report("Could not get size of %s: %s",
1934 argv[optind + bs_i], strerror(-bs_sectors[bs_i]));
1935 ret = -1;
1936 goto out;
1937 }
d739f1c4 1938 total_sectors += bs_sectors[bs_i];
926c2d23 1939 }
ea2384d3 1940
ef80654d
WX
1941 if (sn_opts) {
1942 ret = bdrv_snapshot_load_tmp(bs[0],
1943 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
1944 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
1945 &local_err);
1946 } else if (snapshot_name != NULL) {
51ef6727 1947 if (bs_n > 1) {
6daf194d 1948 error_report("No support for concatenating multiple snapshot");
51ef6727 1949 ret = -1;
1950 goto out;
1951 }
7b4c4781
WX
1952
1953 bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
ef80654d 1954 }
84d18f06 1955 if (local_err) {
c29b77f9 1956 error_reportf_err(local_err, "Failed to load snapshot: ");
ef80654d
WX
1957 ret = -1;
1958 goto out;
51ef6727 1959 }
1960
efa84d43 1961 /* Find driver and parse its options */
ea2384d3 1962 drv = bdrv_find_format(out_fmt);
c2abccec 1963 if (!drv) {
15654a6d 1964 error_report("Unknown file format '%s'", out_fmt);
c2abccec
MK
1965 ret = -1;
1966 goto out;
1967 }
efa84d43 1968
b65a5e12 1969 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
c2abccec 1970 if (!proto_drv) {
2867ce4a 1971 error_report_err(local_err);
c2abccec
MK
1972 ret = -1;
1973 goto out;
1974 }
b50cbabc 1975
2e024cde
HR
1976 if (!skip_create) {
1977 if (!drv->create_opts) {
1978 error_report("Format driver '%s' does not support image creation",
1979 drv->format_name);
1980 ret = -1;
1981 goto out;
1982 }
f75613cf 1983
2e024cde
HR
1984 if (!proto_drv->create_opts) {
1985 error_report("Protocol driver '%s' does not support image creation",
1986 proto_drv->format_name);
1987 ret = -1;
1988 goto out;
1989 }
f75613cf 1990
2e024cde
HR
1991 create_opts = qemu_opts_append(create_opts, drv->create_opts);
1992 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
db08adf5 1993
2e024cde 1994 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
dc523cd3
MA
1995 if (options) {
1996 qemu_opts_do_parse(opts, options, NULL, &local_err);
1997 if (local_err) {
97a2ca7a 1998 error_report_err(local_err);
dc523cd3
MA
1999 ret = -1;
2000 goto out;
2001 }
2e024cde 2002 }
efa84d43 2003
39101f25
MA
2004 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512,
2005 &error_abort);
2e024cde
HR
2006 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2007 if (ret < 0) {
2008 goto out;
2009 }
c2abccec 2010 }
efa84d43 2011
a18953fb 2012 /* Get backing file name if -o backing_file was used */
83d0521a 2013 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
a18953fb 2014 if (out_baseimg_param) {
83d0521a 2015 out_baseimg = out_baseimg_param;
a18953fb
KW
2016 }
2017
efa84d43 2018 /* Check if compression is supported */
eec77d9e 2019 if (compress) {
83d0521a
CL
2020 bool encryption =
2021 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2022 const char *preallocation =
2023 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
efa84d43
KW
2024
2025 if (!drv->bdrv_write_compressed) {
15654a6d 2026 error_report("Compression not supported for this file format");
c2abccec
MK
2027 ret = -1;
2028 goto out;
efa84d43
KW
2029 }
2030
83d0521a 2031 if (encryption) {
15654a6d
JS
2032 error_report("Compression and encryption not supported at "
2033 "the same time");
c2abccec
MK
2034 ret = -1;
2035 goto out;
efa84d43 2036 }
41521fa4 2037
83d0521a
CL
2038 if (preallocation
2039 && strcmp(preallocation, "off"))
41521fa4
KW
2040 {
2041 error_report("Compression and preallocation not supported at "
2042 "the same time");
2043 ret = -1;
2044 goto out;
2045 }
efa84d43
KW
2046 }
2047
b2e10493
AD
2048 if (!skip_create) {
2049 /* Create the new image */
c282e1fd 2050 ret = bdrv_create(drv, out_filename, opts, &local_err);
b2e10493 2051 if (ret < 0) {
c29b77f9
MA
2052 error_reportf_err(local_err, "%s: error while converting %s: ",
2053 out_filename, out_fmt);
b2e10493 2054 goto out;
ea2384d3
FB
2055 }
2056 }
3b46e624 2057
5a37b60a 2058 flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
ce099547 2059 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
661a0f71
FS
2060 if (ret < 0) {
2061 error_report("Invalid cache option: %s", cache);
bb9cd2ee 2062 goto out;
661a0f71
FS
2063 }
2064
eb769f74
DB
2065 /* XXX we should allow --image-opts to trigger use of
2066 * img_open() here, but then we have trouble with
2067 * the bdrv_create() call which takes different params.
2068 * Not critical right now, so fix can wait...
2069 */
ce099547 2070 out_blk = img_open_file(out_filename, out_fmt, flags, writethrough, quiet);
7e7d56d9 2071 if (!out_blk) {
c2abccec
MK
2072 ret = -1;
2073 goto out;
2074 }
7e7d56d9 2075 out_bs = blk_bs(out_blk);
ea2384d3 2076
f2521c90
PL
2077 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
2078 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2079 * as maximum. */
2080 bufsectors = MIN(32768,
2081 MAX(bufsectors, MAX(out_bs->bl.opt_transfer_length,
2082 out_bs->bl.discard_alignment))
2083 );
2084
b2e10493 2085 if (skip_create) {
f1d3cd79 2086 int64_t output_sectors = blk_nb_sectors(out_blk);
43716fa8 2087 if (output_sectors < 0) {
eec5eb42 2088 error_report("unable to get output image length: %s",
43716fa8 2089 strerror(-output_sectors));
b2e10493
AD
2090 ret = -1;
2091 goto out;
43716fa8 2092 } else if (output_sectors < total_sectors) {
b2e10493
AD
2093 error_report("output file is smaller than input file");
2094 ret = -1;
2095 goto out;
2096 }
2097 }
2098
24f833cd
PL
2099 cluster_sectors = 0;
2100 ret = bdrv_get_info(out_bs, &bdi);
2101 if (ret < 0) {
2102 if (compress) {
15654a6d 2103 error_report("could not get block driver info");
c2abccec
MK
2104 goto out;
2105 }
24f833cd 2106 } else {
85f49cad 2107 compress = compress || bdi.needs_compressed_writes;
24f833cd
PL
2108 cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2109 }
2110
690c7301
KW
2111 state = (ImgConvertState) {
2112 .src = blk,
2113 .src_sectors = bs_sectors,
2114 .src_num = bs_n,
2115 .total_sectors = total_sectors,
2116 .target = out_blk,
2117 .compressed = compress,
2118 .target_has_backing = (bool) out_baseimg,
2119 .min_sparse = min_sparse,
2120 .cluster_sectors = cluster_sectors,
2121 .buf_sectors = bufsectors,
2122 };
2123 ret = convert_do_copy(&state);
802c3d4c 2124
c2abccec 2125out:
13c28af8
PL
2126 if (!ret) {
2127 qemu_progress_print(100, 0);
2128 }
6b837bc4 2129 qemu_progress_end();
83d0521a
CL
2130 qemu_opts_del(opts);
2131 qemu_opts_free(create_opts);
fbf28a43 2132 qemu_opts_del(sn_opts);
26f54e9a 2133 blk_unref(out_blk);
9ba10c95 2134 g_free(bs);
26f54e9a
MA
2135 if (blk) {
2136 for (bs_i = 0; bs_i < bs_n; bs_i++) {
2137 blk_unref(blk[bs_i]);
2138 }
2139 g_free(blk);
2140 }
d739f1c4 2141 g_free(bs_sectors);
64bb01aa
KW
2142fail_getopt:
2143 g_free(options);
2144
c2abccec
MK
2145 if (ret) {
2146 return 1;
2147 }
ea2384d3
FB
2148 return 0;
2149}
2150
57d1a2b6 2151
faea38e7
FB
2152static void dump_snapshots(BlockDriverState *bs)
2153{
2154 QEMUSnapshotInfo *sn_tab, *sn;
2155 int nb_sns, i;
faea38e7
FB
2156
2157 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2158 if (nb_sns <= 0)
2159 return;
2160 printf("Snapshot list:\n");
5b917044
WX
2161 bdrv_snapshot_dump(fprintf, stdout, NULL);
2162 printf("\n");
faea38e7
FB
2163 for(i = 0; i < nb_sns; i++) {
2164 sn = &sn_tab[i];
5b917044
WX
2165 bdrv_snapshot_dump(fprintf, stdout, sn);
2166 printf("\n");
faea38e7 2167 }
7267c094 2168 g_free(sn_tab);
faea38e7
FB
2169}
2170
9699bf0d
SH
2171static void dump_json_image_info_list(ImageInfoList *list)
2172{
4399c438 2173 Error *local_err = NULL;
9699bf0d
SH
2174 QString *str;
2175 QmpOutputVisitor *ov = qmp_output_visitor_new();
2176 QObject *obj;
51e72bc1
EB
2177 visit_type_ImageInfoList(qmp_output_get_visitor(ov), NULL, &list,
2178 &local_err);
9699bf0d
SH
2179 obj = qmp_output_get_qobject(ov);
2180 str = qobject_to_json_pretty(obj);
2181 assert(str != NULL);
2182 printf("%s\n", qstring_get_str(str));
2183 qobject_decref(obj);
2184 qmp_output_visitor_cleanup(ov);
2185 QDECREF(str);
2186}
2187
c054b3fd
BC
2188static void dump_json_image_info(ImageInfo *info)
2189{
4399c438 2190 Error *local_err = NULL;
c054b3fd
BC
2191 QString *str;
2192 QmpOutputVisitor *ov = qmp_output_visitor_new();
2193 QObject *obj;
51e72bc1 2194 visit_type_ImageInfo(qmp_output_get_visitor(ov), NULL, &info, &local_err);
c054b3fd
BC
2195 obj = qmp_output_get_qobject(ov);
2196 str = qobject_to_json_pretty(obj);
2197 assert(str != NULL);
2198 printf("%s\n", qstring_get_str(str));
2199 qobject_decref(obj);
2200 qmp_output_visitor_cleanup(ov);
2201 QDECREF(str);
2202}
2203
9699bf0d
SH
2204static void dump_human_image_info_list(ImageInfoList *list)
2205{
2206 ImageInfoList *elem;
2207 bool delim = false;
2208
2209 for (elem = list; elem; elem = elem->next) {
2210 if (delim) {
2211 printf("\n");
2212 }
2213 delim = true;
2214
5b917044 2215 bdrv_image_info_dump(fprintf, stdout, elem->value);
9699bf0d
SH
2216 }
2217}
2218
2219static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2220{
2221 return strcmp(a, b) == 0;
2222}
2223
2224/**
2225 * Open an image file chain and return an ImageInfoList
2226 *
2227 * @filename: topmost image filename
2228 * @fmt: topmost image format (may be NULL to autodetect)
2229 * @chain: true - enumerate entire backing file chain
2230 * false - only topmost image file
2231 *
2232 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2233 * image file. If there was an error a message will have been printed to
2234 * stderr.
2235 */
eb769f74
DB
2236static ImageInfoList *collect_image_info_list(bool image_opts,
2237 const char *filename,
9699bf0d
SH
2238 const char *fmt,
2239 bool chain)
2240{
2241 ImageInfoList *head = NULL;
2242 ImageInfoList **last = &head;
2243 GHashTable *filenames;
43526ec8 2244 Error *err = NULL;
9699bf0d
SH
2245
2246 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2247
2248 while (filename) {
26f54e9a 2249 BlockBackend *blk;
9699bf0d
SH
2250 BlockDriverState *bs;
2251 ImageInfo *info;
2252 ImageInfoList *elem;
2253
2254 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2255 error_report("Backing file '%s' creates an infinite loop.",
2256 filename);
2257 goto err;
2258 }
2259 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2260
efaa7c4e 2261 blk = img_open(image_opts, filename, fmt,
ce099547 2262 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false);
7e7d56d9 2263 if (!blk) {
9699bf0d
SH
2264 goto err;
2265 }
7e7d56d9 2266 bs = blk_bs(blk);
9699bf0d 2267
43526ec8 2268 bdrv_query_image_info(bs, &info, &err);
84d18f06 2269 if (err) {
565f65d2 2270 error_report_err(err);
26f54e9a 2271 blk_unref(blk);
43526ec8 2272 goto err;
fb0ed453 2273 }
9699bf0d
SH
2274
2275 elem = g_new0(ImageInfoList, 1);
2276 elem->value = info;
2277 *last = elem;
2278 last = &elem->next;
2279
26f54e9a 2280 blk_unref(blk);
9699bf0d
SH
2281
2282 filename = fmt = NULL;
2283 if (chain) {
2284 if (info->has_full_backing_filename) {
2285 filename = info->full_backing_filename;
2286 } else if (info->has_backing_filename) {
92d617ab
JS
2287 error_report("Could not determine absolute backing filename,"
2288 " but backing filename '%s' present",
2289 info->backing_filename);
2290 goto err;
9699bf0d
SH
2291 }
2292 if (info->has_backing_filename_format) {
2293 fmt = info->backing_filename_format;
2294 }
2295 }
2296 }
2297 g_hash_table_destroy(filenames);
2298 return head;
2299
2300err:
2301 qapi_free_ImageInfoList(head);
2302 g_hash_table_destroy(filenames);
2303 return NULL;
2304}
2305
c054b3fd
BC
2306static int img_info(int argc, char **argv)
2307{
2308 int c;
2309 OutputFormat output_format = OFORMAT_HUMAN;
9699bf0d 2310 bool chain = false;
c054b3fd 2311 const char *filename, *fmt, *output;
9699bf0d 2312 ImageInfoList *list;
eb769f74 2313 bool image_opts = false;
c054b3fd 2314
ea2384d3 2315 fmt = NULL;
c054b3fd 2316 output = NULL;
ea2384d3 2317 for(;;) {
c054b3fd
BC
2318 int option_index = 0;
2319 static const struct option long_options[] = {
2320 {"help", no_argument, 0, 'h'},
2321 {"format", required_argument, 0, 'f'},
2322 {"output", required_argument, 0, OPTION_OUTPUT},
9699bf0d 2323 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
3babeb15 2324 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 2325 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
c054b3fd
BC
2326 {0, 0, 0, 0}
2327 };
2328 c = getopt_long(argc, argv, "f:h",
2329 long_options, &option_index);
b8fb60da 2330 if (c == -1) {
ea2384d3 2331 break;
b8fb60da 2332 }
ea2384d3 2333 switch(c) {
ef87394c 2334 case '?':
ea2384d3
FB
2335 case 'h':
2336 help();
2337 break;
2338 case 'f':
2339 fmt = optarg;
2340 break;
c054b3fd
BC
2341 case OPTION_OUTPUT:
2342 output = optarg;
2343 break;
9699bf0d
SH
2344 case OPTION_BACKING_CHAIN:
2345 chain = true;
2346 break;
3babeb15
DB
2347 case OPTION_OBJECT: {
2348 QemuOpts *opts;
2349 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2350 optarg, true);
2351 if (!opts) {
2352 return 1;
2353 }
2354 } break;
eb769f74
DB
2355 case OPTION_IMAGE_OPTS:
2356 image_opts = true;
2357 break;
ea2384d3
FB
2358 }
2359 }
fc11eb26 2360 if (optind != argc - 1) {
ac1307ab 2361 error_exit("Expecting one image file name");
b8fb60da 2362 }
ea2384d3
FB
2363 filename = argv[optind++];
2364
c054b3fd
BC
2365 if (output && !strcmp(output, "json")) {
2366 output_format = OFORMAT_JSON;
2367 } else if (output && !strcmp(output, "human")) {
2368 output_format = OFORMAT_HUMAN;
2369 } else if (output) {
2370 error_report("--output must be used with human or json as argument.");
c2abccec
MK
2371 return 1;
2372 }
c054b3fd 2373
3babeb15
DB
2374 if (qemu_opts_foreach(&qemu_object_opts,
2375 user_creatable_add_opts_foreach,
51b9b478 2376 NULL, NULL)) {
3babeb15
DB
2377 return 1;
2378 }
2379
eb769f74 2380 list = collect_image_info_list(image_opts, filename, fmt, chain);
9699bf0d 2381 if (!list) {
c2abccec 2382 return 1;
faea38e7 2383 }
c054b3fd 2384
c054b3fd
BC
2385 switch (output_format) {
2386 case OFORMAT_HUMAN:
9699bf0d 2387 dump_human_image_info_list(list);
c054b3fd
BC
2388 break;
2389 case OFORMAT_JSON:
9699bf0d
SH
2390 if (chain) {
2391 dump_json_image_info_list(list);
2392 } else {
2393 dump_json_image_info(list->value);
2394 }
c054b3fd 2395 break;
faea38e7 2396 }
c054b3fd 2397
9699bf0d 2398 qapi_free_ImageInfoList(list);
ea2384d3
FB
2399 return 0;
2400}
2401
4c93a13b
PB
2402static void dump_map_entry(OutputFormat output_format, MapEntry *e,
2403 MapEntry *next)
2404{
2405 switch (output_format) {
2406 case OFORMAT_HUMAN:
16b0d555 2407 if (e->data && !e->has_offset) {
4c93a13b
PB
2408 error_report("File contains external, encrypted or compressed clusters.");
2409 exit(1);
2410 }
16b0d555 2411 if (e->data && !e->zero) {
4c93a13b 2412 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
16b0d555
FZ
2413 e->start, e->length,
2414 e->has_offset ? e->offset : 0,
2415 e->has_filename ? e->filename : "");
4c93a13b
PB
2416 }
2417 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2418 * Modify the flags here to allow more coalescing.
2419 */
16b0d555
FZ
2420 if (next && (!next->data || next->zero)) {
2421 next->data = false;
2422 next->zero = true;
4c93a13b
PB
2423 }
2424 break;
2425 case OFORMAT_JSON:
16b0d555
FZ
2426 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
2427 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
4c93a13b
PB
2428 (e->start == 0 ? "[" : ",\n"),
2429 e->start, e->length, e->depth,
16b0d555
FZ
2430 e->zero ? "true" : "false",
2431 e->data ? "true" : "false");
2432 if (e->has_offset) {
c745bfb4 2433 printf(", \"offset\": %"PRId64"", e->offset);
4c93a13b
PB
2434 }
2435 putchar('}');
2436
2437 if (!next) {
2438 printf("]\n");
2439 }
2440 break;
2441 }
2442}
2443
2444static int get_block_status(BlockDriverState *bs, int64_t sector_num,
2445 int nb_sectors, MapEntry *e)
2446{
2447 int64_t ret;
2448 int depth;
67a0fd2a 2449 BlockDriverState *file;
2875645b 2450 bool has_offset;
4c93a13b
PB
2451
2452 /* As an optimization, we could cache the current range of unallocated
2453 * clusters in each file of the chain, and avoid querying the same
2454 * range repeatedly.
2455 */
2456
2457 depth = 0;
2458 for (;;) {
67a0fd2a
FZ
2459 ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
2460 &file);
4c93a13b
PB
2461 if (ret < 0) {
2462 return ret;
2463 }
2464 assert(nb_sectors);
2465 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2466 break;
2467 }
760e0063 2468 bs = backing_bs(bs);
4c93a13b
PB
2469 if (bs == NULL) {
2470 ret = 0;
2471 break;
2472 }
2473
2474 depth++;
2475 }
2476
2875645b
JS
2477 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
2478
2479 *e = (MapEntry) {
2480 .start = sector_num * BDRV_SECTOR_SIZE,
2481 .length = nb_sectors * BDRV_SECTOR_SIZE,
2482 .data = !!(ret & BDRV_BLOCK_DATA),
2483 .zero = !!(ret & BDRV_BLOCK_ZERO),
2484 .offset = ret & BDRV_BLOCK_OFFSET_MASK,
2485 .has_offset = has_offset,
2486 .depth = depth,
2487 .has_filename = file && has_offset,
2488 .filename = file && has_offset ? file->filename : NULL,
2489 };
2490
4c93a13b
PB
2491 return 0;
2492}
2493
16b0d555
FZ
2494static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
2495{
2496 if (curr->length == 0) {
2497 return false;
2498 }
2499 if (curr->zero != next->zero ||
2500 curr->data != next->data ||
2501 curr->depth != next->depth ||
2502 curr->has_filename != next->has_filename ||
2503 curr->has_offset != next->has_offset) {
2504 return false;
2505 }
2506 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
2507 return false;
2508 }
2509 if (curr->has_offset && curr->offset + curr->length != next->offset) {
2510 return false;
2511 }
2512 return true;
2513}
2514
4c93a13b
PB
2515static int img_map(int argc, char **argv)
2516{
2517 int c;
2518 OutputFormat output_format = OFORMAT_HUMAN;
26f54e9a 2519 BlockBackend *blk;
4c93a13b
PB
2520 BlockDriverState *bs;
2521 const char *filename, *fmt, *output;
2522 int64_t length;
2523 MapEntry curr = { .length = 0 }, next;
2524 int ret = 0;
eb769f74 2525 bool image_opts = false;
4c93a13b
PB
2526
2527 fmt = NULL;
2528 output = NULL;
2529 for (;;) {
2530 int option_index = 0;
2531 static const struct option long_options[] = {
2532 {"help", no_argument, 0, 'h'},
2533 {"format", required_argument, 0, 'f'},
2534 {"output", required_argument, 0, OPTION_OUTPUT},
3babeb15 2535 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 2536 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4c93a13b
PB
2537 {0, 0, 0, 0}
2538 };
2539 c = getopt_long(argc, argv, "f:h",
2540 long_options, &option_index);
2541 if (c == -1) {
2542 break;
2543 }
2544 switch (c) {
2545 case '?':
2546 case 'h':
2547 help();
2548 break;
2549 case 'f':
2550 fmt = optarg;
2551 break;
2552 case OPTION_OUTPUT:
2553 output = optarg;
2554 break;
3babeb15
DB
2555 case OPTION_OBJECT: {
2556 QemuOpts *opts;
2557 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2558 optarg, true);
2559 if (!opts) {
2560 return 1;
2561 }
2562 } break;
eb769f74
DB
2563 case OPTION_IMAGE_OPTS:
2564 image_opts = true;
2565 break;
4c93a13b
PB
2566 }
2567 }
ac1307ab
FZ
2568 if (optind != argc - 1) {
2569 error_exit("Expecting one image file name");
4c93a13b 2570 }
ac1307ab 2571 filename = argv[optind];
4c93a13b
PB
2572
2573 if (output && !strcmp(output, "json")) {
2574 output_format = OFORMAT_JSON;
2575 } else if (output && !strcmp(output, "human")) {
2576 output_format = OFORMAT_HUMAN;
2577 } else if (output) {
2578 error_report("--output must be used with human or json as argument.");
2579 return 1;
2580 }
2581
3babeb15
DB
2582 if (qemu_opts_foreach(&qemu_object_opts,
2583 user_creatable_add_opts_foreach,
51b9b478 2584 NULL, NULL)) {
3babeb15
DB
2585 return 1;
2586 }
2587
ce099547 2588 blk = img_open(image_opts, filename, fmt, 0, false, false);
7e7d56d9
MA
2589 if (!blk) {
2590 return 1;
4c93a13b 2591 }
7e7d56d9 2592 bs = blk_bs(blk);
4c93a13b
PB
2593
2594 if (output_format == OFORMAT_HUMAN) {
2595 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2596 }
2597
f1d3cd79 2598 length = blk_getlength(blk);
4c93a13b
PB
2599 while (curr.start + curr.length < length) {
2600 int64_t nsectors_left;
2601 int64_t sector_num;
2602 int n;
2603
2604 sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;
2605
2606 /* Probe up to 1 GiB at a time. */
2607 nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
2608 n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
2609 ret = get_block_status(bs, sector_num, n, &next);
2610
2611 if (ret < 0) {
2612 error_report("Could not read file metadata: %s", strerror(-ret));
2613 goto out;
2614 }
2615
16b0d555 2616 if (entry_mergeable(&curr, &next)) {
4c93a13b
PB
2617 curr.length += next.length;
2618 continue;
2619 }
2620
2621 if (curr.length > 0) {
2622 dump_map_entry(output_format, &curr, &next);
2623 }
2624 curr = next;
2625 }
2626
2627 dump_map_entry(output_format, &curr, NULL);
2628
2629out:
26f54e9a 2630 blk_unref(blk);
4c93a13b
PB
2631 return ret < 0;
2632}
2633
f7b4a940
AL
2634#define SNAPSHOT_LIST 1
2635#define SNAPSHOT_CREATE 2
2636#define SNAPSHOT_APPLY 3
2637#define SNAPSHOT_DELETE 4
2638
153859be 2639static int img_snapshot(int argc, char **argv)
f7b4a940 2640{
26f54e9a 2641 BlockBackend *blk;
f7b4a940
AL
2642 BlockDriverState *bs;
2643 QEMUSnapshotInfo sn;
2644 char *filename, *snapshot_name = NULL;
c2abccec 2645 int c, ret = 0, bdrv_oflags;
f7b4a940
AL
2646 int action = 0;
2647 qemu_timeval tv;
f382d43a 2648 bool quiet = false;
a89d89d3 2649 Error *err = NULL;
eb769f74 2650 bool image_opts = false;
f7b4a940 2651
ce099547 2652 bdrv_oflags = BDRV_O_RDWR;
f7b4a940
AL
2653 /* Parse commandline parameters */
2654 for(;;) {
3babeb15
DB
2655 static const struct option long_options[] = {
2656 {"help", no_argument, 0, 'h'},
2657 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 2658 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
2659 {0, 0, 0, 0}
2660 };
2661 c = getopt_long(argc, argv, "la:c:d:hq",
2662 long_options, NULL);
b8fb60da 2663 if (c == -1) {
f7b4a940 2664 break;
b8fb60da 2665 }
f7b4a940 2666 switch(c) {
ef87394c 2667 case '?':
f7b4a940
AL
2668 case 'h':
2669 help();
153859be 2670 return 0;
f7b4a940
AL
2671 case 'l':
2672 if (action) {
ac1307ab 2673 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2674 return 0;
f7b4a940
AL
2675 }
2676 action = SNAPSHOT_LIST;
f5edb014 2677 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
f7b4a940
AL
2678 break;
2679 case 'a':
2680 if (action) {
ac1307ab 2681 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2682 return 0;
f7b4a940
AL
2683 }
2684 action = SNAPSHOT_APPLY;
2685 snapshot_name = optarg;
2686 break;
2687 case 'c':
2688 if (action) {
ac1307ab 2689 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2690 return 0;
f7b4a940
AL
2691 }
2692 action = SNAPSHOT_CREATE;
2693 snapshot_name = optarg;
2694 break;
2695 case 'd':
2696 if (action) {
ac1307ab 2697 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2698 return 0;
f7b4a940
AL
2699 }
2700 action = SNAPSHOT_DELETE;
2701 snapshot_name = optarg;
2702 break;
f382d43a
MR
2703 case 'q':
2704 quiet = true;
2705 break;
3babeb15
DB
2706 case OPTION_OBJECT: {
2707 QemuOpts *opts;
2708 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2709 optarg, true);
2710 if (!opts) {
2711 return 1;
2712 }
2713 } break;
eb769f74
DB
2714 case OPTION_IMAGE_OPTS:
2715 image_opts = true;
2716 break;
f7b4a940
AL
2717 }
2718 }
2719
fc11eb26 2720 if (optind != argc - 1) {
ac1307ab 2721 error_exit("Expecting one image file name");
b8fb60da 2722 }
f7b4a940
AL
2723 filename = argv[optind++];
2724
3babeb15
DB
2725 if (qemu_opts_foreach(&qemu_object_opts,
2726 user_creatable_add_opts_foreach,
51b9b478 2727 NULL, NULL)) {
3babeb15
DB
2728 return 1;
2729 }
2730
f7b4a940 2731 /* Open the image */
ce099547 2732 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet);
7e7d56d9
MA
2733 if (!blk) {
2734 return 1;
c2abccec 2735 }
7e7d56d9 2736 bs = blk_bs(blk);
f7b4a940
AL
2737
2738 /* Perform the requested action */
2739 switch(action) {
2740 case SNAPSHOT_LIST:
2741 dump_snapshots(bs);
2742 break;
2743
2744 case SNAPSHOT_CREATE:
2745 memset(&sn, 0, sizeof(sn));
2746 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
2747
2748 qemu_gettimeofday(&tv);
2749 sn.date_sec = tv.tv_sec;
2750 sn.date_nsec = tv.tv_usec * 1000;
2751
2752 ret = bdrv_snapshot_create(bs, &sn);
b8fb60da 2753 if (ret) {
15654a6d 2754 error_report("Could not create snapshot '%s': %d (%s)",
f7b4a940 2755 snapshot_name, ret, strerror(-ret));
b8fb60da 2756 }
f7b4a940
AL
2757 break;
2758
2759 case SNAPSHOT_APPLY:
2760 ret = bdrv_snapshot_goto(bs, snapshot_name);
b8fb60da 2761 if (ret) {
15654a6d 2762 error_report("Could not apply snapshot '%s': %d (%s)",
f7b4a940 2763 snapshot_name, ret, strerror(-ret));
b8fb60da 2764 }
f7b4a940
AL
2765 break;
2766
2767 case SNAPSHOT_DELETE:
a89d89d3 2768 bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
84d18f06 2769 if (err) {
c29b77f9
MA
2770 error_reportf_err(err, "Could not delete snapshot '%s': ",
2771 snapshot_name);
a89d89d3 2772 ret = 1;
b8fb60da 2773 }
f7b4a940
AL
2774 break;
2775 }
2776
2777 /* Cleanup */
26f54e9a 2778 blk_unref(blk);
c2abccec
MK
2779 if (ret) {
2780 return 1;
2781 }
153859be 2782 return 0;
f7b4a940
AL
2783}
2784
3e85c6fd
KW
2785static int img_rebase(int argc, char **argv)
2786{
26f54e9a 2787 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
396374ca
PB
2788 uint8_t *buf_old = NULL;
2789 uint8_t *buf_new = NULL;
f1d3cd79 2790 BlockDriverState *bs = NULL;
3e85c6fd 2791 char *filename;
40055951
HR
2792 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
2793 int c, flags, src_flags, ret;
ce099547 2794 bool writethrough, src_writethrough;
3e85c6fd 2795 int unsafe = 0;
6b837bc4 2796 int progress = 0;
f382d43a 2797 bool quiet = false;
34b5d2c6 2798 Error *local_err = NULL;
eb769f74 2799 bool image_opts = false;
3e85c6fd
KW
2800
2801 /* Parse commandline parameters */
e53dbee0 2802 fmt = NULL;
661a0f71 2803 cache = BDRV_DEFAULT_CACHE;
40055951 2804 src_cache = BDRV_DEFAULT_CACHE;
3e85c6fd
KW
2805 out_baseimg = NULL;
2806 out_basefmt = NULL;
3e85c6fd 2807 for(;;) {
3babeb15
DB
2808 static const struct option long_options[] = {
2809 {"help", no_argument, 0, 'h'},
2810 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 2811 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
2812 {0, 0, 0, 0}
2813 };
2814 c = getopt_long(argc, argv, "hf:F:b:upt:T:q",
2815 long_options, NULL);
b8fb60da 2816 if (c == -1) {
3e85c6fd 2817 break;
b8fb60da 2818 }
3e85c6fd 2819 switch(c) {
ef87394c 2820 case '?':
3e85c6fd
KW
2821 case 'h':
2822 help();
2823 return 0;
e53dbee0
KW
2824 case 'f':
2825 fmt = optarg;
2826 break;
3e85c6fd
KW
2827 case 'F':
2828 out_basefmt = optarg;
2829 break;
2830 case 'b':
2831 out_baseimg = optarg;
2832 break;
2833 case 'u':
2834 unsafe = 1;
2835 break;
6b837bc4
JS
2836 case 'p':
2837 progress = 1;
2838 break;
661a0f71
FS
2839 case 't':
2840 cache = optarg;
2841 break;
40055951
HR
2842 case 'T':
2843 src_cache = optarg;
2844 break;
f382d43a
MR
2845 case 'q':
2846 quiet = true;
2847 break;
3babeb15
DB
2848 case OPTION_OBJECT: {
2849 QemuOpts *opts;
2850 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2851 optarg, true);
2852 if (!opts) {
2853 return 1;
2854 }
2855 } break;
eb769f74
DB
2856 case OPTION_IMAGE_OPTS:
2857 image_opts = true;
2858 break;
3e85c6fd
KW
2859 }
2860 }
2861
f382d43a
MR
2862 if (quiet) {
2863 progress = 0;
2864 }
2865
ac1307ab
FZ
2866 if (optind != argc - 1) {
2867 error_exit("Expecting one image file name");
2868 }
2869 if (!unsafe && !out_baseimg) {
2870 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
b8fb60da 2871 }
3e85c6fd
KW
2872 filename = argv[optind++];
2873
3babeb15
DB
2874 if (qemu_opts_foreach(&qemu_object_opts,
2875 user_creatable_add_opts_foreach,
51b9b478 2876 NULL, NULL)) {
3babeb15
DB
2877 return 1;
2878 }
2879
6b837bc4
JS
2880 qemu_progress_init(progress, 2.0);
2881 qemu_progress_print(0, 100);
2882
661a0f71 2883 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
ce099547 2884 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
661a0f71
FS
2885 if (ret < 0) {
2886 error_report("Invalid cache option: %s", cache);
40ed35a3 2887 goto out;
661a0f71
FS
2888 }
2889
ce099547
KW
2890 src_flags = 0;
2891 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
40055951
HR
2892 if (ret < 0) {
2893 error_report("Invalid source cache option: %s", src_cache);
40ed35a3 2894 goto out;
40055951
HR
2895 }
2896
ce099547
KW
2897 /* The source files are opened read-only, don't care about WCE */
2898 assert((src_flags & BDRV_O_RDWR) == 0);
2899 (void) src_writethrough;
2900
3e85c6fd
KW
2901 /*
2902 * Open the images.
2903 *
2904 * Ignore the old backing file for unsafe rebase in case we want to correct
2905 * the reference to a renamed or moved backing file.
2906 */
ce099547 2907 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
7e7d56d9 2908 if (!blk) {
40ed35a3
SH
2909 ret = -1;
2910 goto out;
c2abccec 2911 }
7e7d56d9 2912 bs = blk_bs(blk);
3e85c6fd 2913
3e85c6fd 2914 if (out_basefmt != NULL) {
644483d9 2915 if (bdrv_find_format(out_basefmt) == NULL) {
15654a6d 2916 error_report("Invalid format name: '%s'", out_basefmt);
c2abccec
MK
2917 ret = -1;
2918 goto out;
3e85c6fd
KW
2919 }
2920 }
2921
2922 /* For safe rebasing we need to compare old and new backing file */
40ed35a3 2923 if (!unsafe) {
9a29e18f 2924 char backing_name[PATH_MAX];
644483d9
HR
2925 QDict *options = NULL;
2926
2927 if (bs->backing_format[0] != '\0') {
2928 options = qdict_new();
2929 qdict_put(options, "driver", qstring_from_str(bs->backing_format));
2930 }
3e85c6fd 2931
3e85c6fd 2932 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
efaa7c4e 2933 blk_old_backing = blk_new_open(backing_name, NULL,
644483d9
HR
2934 options, src_flags, &local_err);
2935 if (!blk_old_backing) {
c29b77f9
MA
2936 error_reportf_err(local_err,
2937 "Could not open old backing file '%s': ",
2938 backing_name);
c2abccec 2939 goto out;
3e85c6fd 2940 }
644483d9 2941
a616673d 2942 if (out_baseimg[0]) {
644483d9
HR
2943 if (out_basefmt) {
2944 options = qdict_new();
2945 qdict_put(options, "driver", qstring_from_str(out_basefmt));
2946 } else {
2947 options = NULL;
2948 }
2949
efaa7c4e 2950 blk_new_backing = blk_new_open(out_baseimg, NULL,
644483d9
HR
2951 options, src_flags, &local_err);
2952 if (!blk_new_backing) {
c29b77f9
MA
2953 error_reportf_err(local_err,
2954 "Could not open new backing file '%s': ",
2955 out_baseimg);
a616673d
AB
2956 goto out;
2957 }
3e85c6fd
KW
2958 }
2959 }
2960
2961 /*
2962 * Check each unallocated cluster in the COW file. If it is unallocated,
2963 * accesses go to the backing file. We must therefore compare this cluster
2964 * in the old and new backing file, and if they differ we need to copy it
2965 * from the old backing file into the COW file.
2966 *
2967 * If qemu-img crashes during this step, no harm is done. The content of
2968 * the image is the same as the original one at any time.
2969 */
2970 if (!unsafe) {
52bf1e72
MA
2971 int64_t num_sectors;
2972 int64_t old_backing_num_sectors;
2973 int64_t new_backing_num_sectors = 0;
3e85c6fd 2974 uint64_t sector;
cc60e327 2975 int n;
1f710495 2976 float local_progress = 0;
d6771bfa 2977
f1d3cd79
HR
2978 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
2979 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
3e85c6fd 2980
f1d3cd79 2981 num_sectors = blk_nb_sectors(blk);
52bf1e72
MA
2982 if (num_sectors < 0) {
2983 error_report("Could not get size of '%s': %s",
2984 filename, strerror(-num_sectors));
2985 ret = -1;
2986 goto out;
2987 }
f1d3cd79 2988 old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
52bf1e72 2989 if (old_backing_num_sectors < 0) {
9a29e18f 2990 char backing_name[PATH_MAX];
52bf1e72
MA
2991
2992 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2993 error_report("Could not get size of '%s': %s",
2994 backing_name, strerror(-old_backing_num_sectors));
2995 ret = -1;
2996 goto out;
2997 }
f1d3cd79
HR
2998 if (blk_new_backing) {
2999 new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
52bf1e72
MA
3000 if (new_backing_num_sectors < 0) {
3001 error_report("Could not get size of '%s': %s",
3002 out_baseimg, strerror(-new_backing_num_sectors));
3003 ret = -1;
3004 goto out;
3005 }
a616673d 3006 }
3e85c6fd 3007
1f710495
KW
3008 if (num_sectors != 0) {
3009 local_progress = (float)100 /
3010 (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
3011 }
3012
3e85c6fd
KW
3013 for (sector = 0; sector < num_sectors; sector += n) {
3014
3015 /* How many sectors can we handle with the next read? */
3016 if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
3017 n = (IO_BUF_SIZE / 512);
3018 } else {
3019 n = num_sectors - sector;
3020 }
3021
3022 /* If the cluster is allocated, we don't need to take action */
cc60e327 3023 ret = bdrv_is_allocated(bs, sector, n, &n);
d663640c
PB
3024 if (ret < 0) {
3025 error_report("error while reading image metadata: %s",
3026 strerror(-ret));
3027 goto out;
3028 }
cc60e327 3029 if (ret) {
3e85c6fd
KW
3030 continue;
3031 }
3032
87a1b3e3
KW
3033 /*
3034 * Read old and new backing file and take into consideration that
3035 * backing files may be smaller than the COW image.
3036 */
3037 if (sector >= old_backing_num_sectors) {
3038 memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
3039 } else {
3040 if (sector + n > old_backing_num_sectors) {
3041 n = old_backing_num_sectors - sector;
3042 }
3043
9166920a
EB
3044 ret = blk_pread(blk_old_backing, sector << BDRV_SECTOR_BITS,
3045 buf_old, n << BDRV_SECTOR_BITS);
87a1b3e3
KW
3046 if (ret < 0) {
3047 error_report("error while reading from old backing file");
3048 goto out;
3049 }
3e85c6fd 3050 }
87a1b3e3 3051
f1d3cd79 3052 if (sector >= new_backing_num_sectors || !blk_new_backing) {
87a1b3e3
KW
3053 memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
3054 } else {
3055 if (sector + n > new_backing_num_sectors) {
3056 n = new_backing_num_sectors - sector;
3057 }
3058
9166920a
EB
3059 ret = blk_pread(blk_new_backing, sector << BDRV_SECTOR_BITS,
3060 buf_new, n << BDRV_SECTOR_BITS);
87a1b3e3
KW
3061 if (ret < 0) {
3062 error_report("error while reading from new backing file");
3063 goto out;
3064 }
3e85c6fd
KW
3065 }
3066
3067 /* If they differ, we need to write to the COW file */
3068 uint64_t written = 0;
3069
3070 while (written < n) {
3071 int pnum;
3072
3073 if (compare_sectors(buf_old + written * 512,
60b1bd4f 3074 buf_new + written * 512, n - written, &pnum))
3e85c6fd 3075 {
9166920a
EB
3076 ret = blk_pwrite(blk,
3077 (sector + written) << BDRV_SECTOR_BITS,
3078 buf_old + written * 512,
3079 pnum << BDRV_SECTOR_BITS, 0);
3e85c6fd 3080 if (ret < 0) {
15654a6d 3081 error_report("Error while writing to COW image: %s",
3e85c6fd 3082 strerror(-ret));
c2abccec 3083 goto out;
3e85c6fd
KW
3084 }
3085 }
3086
3087 written += pnum;
3088 }
6b837bc4 3089 qemu_progress_print(local_progress, 100);
3e85c6fd
KW
3090 }
3091 }
3092
3093 /*
3094 * Change the backing file. All clusters that are different from the old
3095 * backing file are overwritten in the COW file now, so the visible content
3096 * doesn't change when we switch the backing file.
3097 */
a616673d
AB
3098 if (out_baseimg && *out_baseimg) {
3099 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
3100 } else {
3101 ret = bdrv_change_backing_file(bs, NULL, NULL);
3102 }
3103
3e85c6fd 3104 if (ret == -ENOSPC) {
15654a6d
JS
3105 error_report("Could not change the backing file to '%s': No "
3106 "space left in the file header", out_baseimg);
3e85c6fd 3107 } else if (ret < 0) {
15654a6d 3108 error_report("Could not change the backing file to '%s': %s",
3e85c6fd
KW
3109 out_baseimg, strerror(-ret));
3110 }
3111
6b837bc4 3112 qemu_progress_print(100, 0);
3e85c6fd
KW
3113 /*
3114 * TODO At this point it is possible to check if any clusters that are
3115 * allocated in the COW file are the same in the backing file. If so, they
3116 * could be dropped from the COW file. Don't do this before switching the
3117 * backing file, in case of a crash this would lead to corruption.
3118 */
c2abccec 3119out:
6b837bc4 3120 qemu_progress_end();
3e85c6fd
KW
3121 /* Cleanup */
3122 if (!unsafe) {
26f54e9a 3123 blk_unref(blk_old_backing);
26f54e9a 3124 blk_unref(blk_new_backing);
3e85c6fd 3125 }
396374ca
PB
3126 qemu_vfree(buf_old);
3127 qemu_vfree(buf_new);
3e85c6fd 3128
26f54e9a 3129 blk_unref(blk);
c2abccec
MK
3130 if (ret) {
3131 return 1;
3132 }
3e85c6fd
KW
3133 return 0;
3134}
3135
ae6b0ed6
SH
3136static int img_resize(int argc, char **argv)
3137{
6750e795 3138 Error *err = NULL;
ae6b0ed6
SH
3139 int c, ret, relative;
3140 const char *filename, *fmt, *size;
3141 int64_t n, total_size;
f382d43a 3142 bool quiet = false;
26f54e9a 3143 BlockBackend *blk = NULL;
20caf0f7 3144 QemuOpts *param;
3babeb15 3145
20caf0f7
DXW
3146 static QemuOptsList resize_options = {
3147 .name = "resize_options",
3148 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3149 .desc = {
3150 {
3151 .name = BLOCK_OPT_SIZE,
3152 .type = QEMU_OPT_SIZE,
3153 .help = "Virtual disk size"
3154 }, {
3155 /* end of list */
3156 }
ae6b0ed6 3157 },
ae6b0ed6 3158 };
eb769f74 3159 bool image_opts = false;
ae6b0ed6 3160
e80fec7f
KW
3161 /* Remove size from argv manually so that negative numbers are not treated
3162 * as options by getopt. */
3163 if (argc < 3) {
ac1307ab 3164 error_exit("Not enough arguments");
e80fec7f
KW
3165 return 1;
3166 }
3167
3168 size = argv[--argc];
3169
3170 /* Parse getopt arguments */
ae6b0ed6
SH
3171 fmt = NULL;
3172 for(;;) {
3babeb15
DB
3173 static const struct option long_options[] = {
3174 {"help", no_argument, 0, 'h'},
3175 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 3176 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
3177 {0, 0, 0, 0}
3178 };
3179 c = getopt_long(argc, argv, "f:hq",
3180 long_options, NULL);
ae6b0ed6
SH
3181 if (c == -1) {
3182 break;
3183 }
3184 switch(c) {
ef87394c 3185 case '?':
ae6b0ed6
SH
3186 case 'h':
3187 help();
3188 break;
3189 case 'f':
3190 fmt = optarg;
3191 break;
f382d43a
MR
3192 case 'q':
3193 quiet = true;
3194 break;
3babeb15
DB
3195 case OPTION_OBJECT: {
3196 QemuOpts *opts;
3197 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3198 optarg, true);
3199 if (!opts) {
3200 return 1;
3201 }
3202 } break;
eb769f74
DB
3203 case OPTION_IMAGE_OPTS:
3204 image_opts = true;
3205 break;
ae6b0ed6
SH
3206 }
3207 }
fc11eb26 3208 if (optind != argc - 1) {
ac1307ab 3209 error_exit("Expecting one image file name");
ae6b0ed6
SH
3210 }
3211 filename = argv[optind++];
ae6b0ed6 3212
3babeb15
DB
3213 if (qemu_opts_foreach(&qemu_object_opts,
3214 user_creatable_add_opts_foreach,
51b9b478 3215 NULL, NULL)) {
3babeb15
DB
3216 return 1;
3217 }
3218
ae6b0ed6
SH
3219 /* Choose grow, shrink, or absolute resize mode */
3220 switch (size[0]) {
3221 case '+':
3222 relative = 1;
3223 size++;
3224 break;
3225 case '-':
3226 relative = -1;
3227 size++;
3228 break;
3229 default:
3230 relative = 0;
3231 break;
3232 }
3233
3234 /* Parse size */
87ea75d5 3235 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
f43e47db 3236 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
6750e795
MA
3237 if (err) {
3238 error_report_err(err);
2a81998a 3239 ret = -1;
20caf0f7 3240 qemu_opts_del(param);
2a81998a 3241 goto out;
ae6b0ed6 3242 }
20caf0f7
DXW
3243 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3244 qemu_opts_del(param);
ae6b0ed6 3245
efaa7c4e 3246 blk = img_open(image_opts, filename, fmt,
ce099547 3247 BDRV_O_RDWR, false, quiet);
7e7d56d9 3248 if (!blk) {
2a81998a
JS
3249 ret = -1;
3250 goto out;
c2abccec 3251 }
ae6b0ed6
SH
3252
3253 if (relative) {
f1d3cd79 3254 total_size = blk_getlength(blk) + n * relative;
ae6b0ed6
SH
3255 } else {
3256 total_size = n;
3257 }
3258 if (total_size <= 0) {
15654a6d 3259 error_report("New image size must be positive");
c2abccec
MK
3260 ret = -1;
3261 goto out;
ae6b0ed6
SH
3262 }
3263
f1d3cd79 3264 ret = blk_truncate(blk, total_size);
ae6b0ed6
SH
3265 switch (ret) {
3266 case 0:
f382d43a 3267 qprintf(quiet, "Image resized.\n");
ae6b0ed6
SH
3268 break;
3269 case -ENOTSUP:
259b2173 3270 error_report("This image does not support resize");
ae6b0ed6
SH
3271 break;
3272 case -EACCES:
15654a6d 3273 error_report("Image is read-only");
ae6b0ed6
SH
3274 break;
3275 default:
15654a6d 3276 error_report("Error resizing image (%d)", -ret);
ae6b0ed6
SH
3277 break;
3278 }
c2abccec 3279out:
26f54e9a 3280 blk_unref(blk);
c2abccec
MK
3281 if (ret) {
3282 return 1;
3283 }
ae6b0ed6
SH
3284 return 0;
3285}
3286
76a3a34d 3287static void amend_status_cb(BlockDriverState *bs,
8b13976d
HR
3288 int64_t offset, int64_t total_work_size,
3289 void *opaque)
76a3a34d
HR
3290{
3291 qemu_progress_print(100.f * offset / total_work_size, 0);
3292}
3293
6f176b48
HR
3294static int img_amend(int argc, char **argv)
3295{
dc523cd3 3296 Error *err = NULL;
6f176b48
HR
3297 int c, ret = 0;
3298 char *options = NULL;
83d0521a
CL
3299 QemuOptsList *create_opts = NULL;
3300 QemuOpts *opts = NULL;
bd39e6ed
HR
3301 const char *fmt = NULL, *filename, *cache;
3302 int flags;
ce099547 3303 bool writethrough;
76a3a34d 3304 bool quiet = false, progress = false;
26f54e9a 3305 BlockBackend *blk = NULL;
6f176b48 3306 BlockDriverState *bs = NULL;
eb769f74 3307 bool image_opts = false;
6f176b48 3308
bd39e6ed 3309 cache = BDRV_DEFAULT_CACHE;
6f176b48 3310 for (;;) {
3babeb15
DB
3311 static const struct option long_options[] = {
3312 {"help", no_argument, 0, 'h'},
3313 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 3314 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
3315 {0, 0, 0, 0}
3316 };
3317 c = getopt_long(argc, argv, "ho:f:t:pq",
3318 long_options, NULL);
6f176b48
HR
3319 if (c == -1) {
3320 break;
3321 }
3322
3323 switch (c) {
3324 case 'h':
3325 case '?':
3326 help();
3327 break;
3328 case 'o':
626f84f3
KW
3329 if (!is_valid_option_list(optarg)) {
3330 error_report("Invalid option list: %s", optarg);
3331 ret = -1;
e814dffc 3332 goto out_no_progress;
626f84f3
KW
3333 }
3334 if (!options) {
3335 options = g_strdup(optarg);
3336 } else {
3337 char *old_options = options;
3338 options = g_strdup_printf("%s,%s", options, optarg);
3339 g_free(old_options);
3340 }
6f176b48
HR
3341 break;
3342 case 'f':
3343 fmt = optarg;
3344 break;
bd39e6ed
HR
3345 case 't':
3346 cache = optarg;
3347 break;
76a3a34d
HR
3348 case 'p':
3349 progress = true;
3350 break;
6f176b48
HR
3351 case 'q':
3352 quiet = true;
3353 break;
3babeb15
DB
3354 case OPTION_OBJECT:
3355 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3356 optarg, true);
3357 if (!opts) {
3358 ret = -1;
3359 goto out_no_progress;
3360 }
3361 break;
eb769f74
DB
3362 case OPTION_IMAGE_OPTS:
3363 image_opts = true;
3364 break;
6f176b48
HR
3365 }
3366 }
3367
a283cb6e 3368 if (!options) {
ac1307ab 3369 error_exit("Must specify options (-o)");
6f176b48
HR
3370 }
3371
3babeb15
DB
3372 if (qemu_opts_foreach(&qemu_object_opts,
3373 user_creatable_add_opts_foreach,
51b9b478 3374 NULL, NULL)) {
3babeb15
DB
3375 ret = -1;
3376 goto out_no_progress;
3377 }
3378
76a3a34d
HR
3379 if (quiet) {
3380 progress = false;
3381 }
3382 qemu_progress_init(progress, 1.0);
3383
a283cb6e
KW
3384 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
3385 if (fmt && has_help_option(options)) {
3386 /* If a format is explicitly specified (and possibly no filename is
3387 * given), print option help here */
3388 ret = print_block_option_help(filename, fmt);
3389 goto out;
6f176b48
HR
3390 }
3391
a283cb6e 3392 if (optind != argc - 1) {
b2f27e44
HR
3393 error_report("Expecting one image file name");
3394 ret = -1;
3395 goto out;
a283cb6e 3396 }
6f176b48 3397
ce099547
KW
3398 flags = BDRV_O_RDWR;
3399 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
bd39e6ed
HR
3400 if (ret < 0) {
3401 error_report("Invalid cache option: %s", cache);
3402 goto out;
3403 }
3404
ce099547 3405 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
7e7d56d9 3406 if (!blk) {
6f176b48
HR
3407 ret = -1;
3408 goto out;
3409 }
7e7d56d9 3410 bs = blk_bs(blk);
6f176b48
HR
3411
3412 fmt = bs->drv->format_name;
3413
626f84f3 3414 if (has_help_option(options)) {
a283cb6e 3415 /* If the format was auto-detected, print option help here */
6f176b48
HR
3416 ret = print_block_option_help(filename, fmt);
3417 goto out;
3418 }
3419
b2439d26
HR
3420 if (!bs->drv->create_opts) {
3421 error_report("Format driver '%s' does not support any options to amend",
3422 fmt);
3423 ret = -1;
3424 goto out;
3425 }
3426
c282e1fd 3427 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
83d0521a 3428 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
dc523cd3
MA
3429 if (options) {
3430 qemu_opts_do_parse(opts, options, NULL, &err);
3431 if (err) {
97a2ca7a 3432 error_report_err(err);
dc523cd3
MA
3433 ret = -1;
3434 goto out;
3435 }
6f176b48
HR
3436 }
3437
76a3a34d
HR
3438 /* In case the driver does not call amend_status_cb() */
3439 qemu_progress_print(0.f, 0);
8b13976d 3440 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
76a3a34d 3441 qemu_progress_print(100.f, 0);
6f176b48
HR
3442 if (ret < 0) {
3443 error_report("Error while amending options: %s", strerror(-ret));
3444 goto out;
3445 }
3446
3447out:
76a3a34d
HR
3448 qemu_progress_end();
3449
e814dffc 3450out_no_progress:
26f54e9a 3451 blk_unref(blk);
83d0521a
CL
3452 qemu_opts_del(opts);
3453 qemu_opts_free(create_opts);
626f84f3
KW
3454 g_free(options);
3455
6f176b48
HR
3456 if (ret) {
3457 return 1;
3458 }
3459 return 0;
3460}
3461
c227f099 3462static const img_cmd_t img_cmds[] = {
153859be
SB
3463#define DEF(option, callback, arg_string) \
3464 { option, callback },
3465#include "qemu-img-cmds.h"
3466#undef DEF
3467#undef GEN_DOCS
3468 { NULL, NULL, },
3469};
3470
ea2384d3
FB
3471int main(int argc, char **argv)
3472{
c227f099 3473 const img_cmd_t *cmd;
153859be 3474 const char *cmdname;
2f78e491 3475 Error *local_error = NULL;
7db1689c 3476 int c;
7db1689c
JC
3477 static const struct option long_options[] = {
3478 {"help", no_argument, 0, 'h'},
5f6979cb 3479 {"version", no_argument, 0, 'v'},
7db1689c
JC
3480 {0, 0, 0, 0}
3481 };
ea2384d3 3482
526eda14
MK
3483#ifdef CONFIG_POSIX
3484 signal(SIGPIPE, SIG_IGN);
3485#endif
3486
53f76e58 3487 error_set_progname(argv[0]);
10f5bff6 3488 qemu_init_exec_dir(argv[0]);
53f76e58 3489
2f78e491 3490 if (qemu_init_main_loop(&local_error)) {
565f65d2 3491 error_report_err(local_error);
2f78e491
CN
3492 exit(EXIT_FAILURE);
3493 }
3494
e8f2d272 3495 qcrypto_init(&error_fatal);
c2297088 3496
064097d9 3497 module_call_init(MODULE_INIT_QOM);
ea2384d3 3498 bdrv_init();
ac1307ab
FZ
3499 if (argc < 2) {
3500 error_exit("Not enough arguments");
3501 }
153859be 3502 cmdname = argv[1];
153859be 3503
3babeb15 3504 qemu_add_opts(&qemu_object_opts);
eb769f74 3505 qemu_add_opts(&qemu_source_opts);
3babeb15 3506
153859be 3507 /* find the command */
5f6979cb 3508 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
153859be 3509 if (!strcmp(cmdname, cmd->name)) {
7db1689c 3510 return cmd->handler(argc - 1, argv + 1);
153859be 3511 }
ea2384d3 3512 }
153859be 3513
5f6979cb 3514 c = getopt_long(argc, argv, "h", long_options, NULL);
7db1689c
JC
3515
3516 if (c == 'h') {
3517 help();
3518 }
5f6979cb
JC
3519 if (c == 'v') {
3520 printf(QEMU_IMG_VERSION);
3521 return 0;
3522 }
7db1689c 3523
153859be 3524 /* not found */
ac1307ab 3525 error_exit("Command not found: %s", cmdname);
ea2384d3 3526}