]> git.proxmox.com Git - mirror_qemu.git/blame - qemu-img.c
virtio: Import virtio_vring.h
[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 */
c054b3fd
BC
24#include "qapi-visit.h"
25#include "qapi/qmp-output-visitor.h"
7b1b5d19 26#include "qapi/qmp/qjson.h"
faf07963 27#include "qemu-common.h"
1de7afc9
PB
28#include "qemu/option.h"
29#include "qemu/error-report.h"
30#include "qemu/osdep.h"
9c17d615 31#include "sysemu/sysemu.h"
737e150e 32#include "block/block_int.h"
f364ec65 33#include "block/qapi.h"
c054b3fd 34#include <getopt.h>
e8445331 35
5f6979cb
JC
36#define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION \
37 ", Copyright (c) 2004-2008 Fabrice Bellard\n"
38
c227f099 39typedef struct img_cmd_t {
153859be
SB
40 const char *name;
41 int (*handler)(int argc, char **argv);
c227f099 42} img_cmd_t;
153859be 43
8599ea4c
FS
44enum {
45 OPTION_OUTPUT = 256,
46 OPTION_BACKING_CHAIN = 257,
47};
48
49typedef enum OutputFormat {
50 OFORMAT_JSON,
51 OFORMAT_HUMAN,
52} OutputFormat;
53
137519ce 54/* Default to cache=writeback as data integrity is not important for qemu-tcg. */
adfe078e 55#define BDRV_O_FLAGS BDRV_O_CACHE_WB
661a0f71 56#define BDRV_DEFAULT_CACHE "writeback"
137519ce 57
00c6d403 58static void format_print(void *opaque, const char *name)
ea2384d3 59{
00c6d403 60 printf(" %s", name);
ea2384d3
FB
61}
62
ac1307ab
FZ
63static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
64{
65 va_list ap;
66
67 error_printf("qemu-img: ");
68
69 va_start(ap, fmt);
70 error_vprintf(fmt, ap);
71 va_end(ap);
72
73 error_printf("\nTry 'qemu-img --help' for more information\n");
74 exit(EXIT_FAILURE);
75}
76
d2c639d6 77/* Please keep in synch with qemu-img.texi */
ac1307ab 78static void QEMU_NORETURN help(void)
ea2384d3 79{
e00291c0 80 const char *help_msg =
5f6979cb 81 QEMU_IMG_VERSION
3f020d70 82 "usage: qemu-img command [command options]\n"
83 "QEMU disk image utility\n"
84 "\n"
85 "Command syntax:\n"
153859be
SB
86#define DEF(option, callback, arg_string) \
87 " " arg_string "\n"
88#include "qemu-img-cmds.h"
89#undef DEF
90#undef GEN_DOCS
3f020d70 91 "\n"
92 "Command parameters:\n"
93 " 'filename' is a disk image filename\n"
94 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
661a0f71 95 " 'cache' is the cache mode used to write the output disk image, the valid\n"
80ccf93b
LY
96 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
97 " 'directsync' and 'unsafe' (default for convert)\n"
bb87fdf8
SH
98 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
99 " options are the same as for the 'cache' option\n"
3f020d70 100 " 'size' is the disk image size in bytes. Optional suffixes\n"
5e00984a
KW
101 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
102 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
103 " supported. 'b' is ignored.\n"
3f020d70 104 " 'output_filename' is the destination disk image filename\n"
105 " 'output_fmt' is the destination format\n"
106 " 'options' is a comma separated list of format specific options in a\n"
107 " name=value format. Use -o ? for an overview of the options supported by the\n"
108 " used format\n"
ef80654d
WX
109 " 'snapshot_param' is param used for internal snapshot, format\n"
110 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
111 " '[ID_OR_NAME]'\n"
112 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
113 " instead\n"
3f020d70 114 " '-c' indicates that target image must be compressed (qcow format only)\n"
115 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
116 " match exactly. The image doesn't need a working backing file before\n"
117 " rebasing in this case (useful for renaming the backing file)\n"
118 " '-h' with or without a command shows this help and lists the supported formats\n"
6b837bc4 119 " '-p' show progress of command (only certain commands)\n"
f382d43a 120 " '-q' use Quiet mode - do not print any output (except errors)\n"
11b6699a
PL
121 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
122 " contain only zeros for qemu-img to create a sparse image during\n"
123 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
124 " unallocated or zero sectors, and the destination image will always be\n"
125 " fully allocated\n"
c054b3fd 126 " '--output' takes the format in which the output must be done (human or json)\n"
b2e10493
AD
127 " '-n' skips the target volume creation (useful if the volume is created\n"
128 " prior to running qemu-img)\n"
3f020d70 129 "\n"
4534ff54
KW
130 "Parameters to check subcommand:\n"
131 " '-r' tries to repair any inconsistencies that are found during the check.\n"
132 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
133 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
0546b8c2 134 " hiding corruption that has already occurred.\n"
4534ff54 135 "\n"
3f020d70 136 "Parameters to snapshot subcommand:\n"
137 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
138 " '-a' applies a snapshot (revert disk to saved state)\n"
139 " '-c' creates a snapshot\n"
140 " '-d' deletes a snapshot\n"
d14ed18c
MR
141 " '-l' lists all snapshots in the given image\n"
142 "\n"
143 "Parameters to compare subcommand:\n"
144 " '-f' first image format\n"
145 " '-F' second image format\n"
146 " '-s' run in Strict mode - fail on different image size or sector allocation\n";
e00291c0
PB
147
148 printf("%s\nSupported formats:", help_msg);
00c6d403 149 bdrv_iterate_format(format_print, NULL);
ea2384d3 150 printf("\n");
ac1307ab 151 exit(EXIT_SUCCESS);
ea2384d3
FB
152}
153
7c30f657 154static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
f382d43a
MR
155{
156 int ret = 0;
157 if (!quiet) {
158 va_list args;
159 va_start(args, fmt);
160 ret = vprintf(fmt, args);
161 va_end(args);
162 }
163 return ret;
164}
165
ea2384d3
FB
166#if defined(WIN32)
167/* XXX: put correct support for win32 */
168static int read_password(char *buf, int buf_size)
169{
170 int c, i;
fdcf6e65 171
ea2384d3
FB
172 printf("Password: ");
173 fflush(stdout);
174 i = 0;
175 for(;;) {
176 c = getchar();
fdcf6e65
CG
177 if (c < 0) {
178 buf[i] = '\0';
179 return -1;
180 } else if (c == '\n') {
ea2384d3 181 break;
fdcf6e65 182 } else if (i < (buf_size - 1)) {
ea2384d3 183 buf[i++] = c;
fdcf6e65 184 }
ea2384d3
FB
185 }
186 buf[i] = '\0';
187 return 0;
188}
189
190#else
191
192#include <termios.h>
193
194static struct termios oldtty;
195
196static void term_exit(void)
197{
198 tcsetattr (0, TCSANOW, &oldtty);
199}
200
201static void term_init(void)
202{
203 struct termios tty;
204
205 tcgetattr (0, &tty);
206 oldtty = tty;
207
208 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
209 |INLCR|IGNCR|ICRNL|IXON);
210 tty.c_oflag |= OPOST;
211 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
212 tty.c_cflag &= ~(CSIZE|PARENB);
213 tty.c_cflag |= CS8;
214 tty.c_cc[VMIN] = 1;
215 tty.c_cc[VTIME] = 0;
3b46e624 216
ea2384d3
FB
217 tcsetattr (0, TCSANOW, &tty);
218
219 atexit(term_exit);
220}
221
3f379ab1 222static int read_password(char *buf, int buf_size)
ea2384d3
FB
223{
224 uint8_t ch;
225 int i, ret;
226
227 printf("password: ");
228 fflush(stdout);
229 term_init();
230 i = 0;
231 for(;;) {
232 ret = read(0, &ch, 1);
233 if (ret == -1) {
234 if (errno == EAGAIN || errno == EINTR) {
235 continue;
236 } else {
ea2384d3
FB
237 break;
238 }
239 } else if (ret == 0) {
240 ret = -1;
241 break;
242 } else {
243 if (ch == '\r') {
244 ret = 0;
245 break;
246 }
247 if (i < (buf_size - 1))
248 buf[i++] = ch;
249 }
250 }
251 term_exit();
252 buf[i] = '\0';
253 printf("\n");
254 return ret;
255}
256#endif
257
4ac8aacd
JS
258static int print_block_option_help(const char *filename, const char *fmt)
259{
260 BlockDriver *drv, *proto_drv;
83d0521a 261 QemuOptsList *create_opts = NULL;
4ac8aacd
JS
262
263 /* Find driver and parse its options */
264 drv = bdrv_find_format(fmt);
265 if (!drv) {
15654a6d 266 error_report("Unknown file format '%s'", fmt);
4ac8aacd
JS
267 return 1;
268 }
269
c282e1fd 270 create_opts = qemu_opts_append(create_opts, drv->create_opts);
a283cb6e
KW
271 if (filename) {
272 proto_drv = bdrv_find_protocol(filename, true);
273 if (!proto_drv) {
274 error_report("Unknown protocol '%s'", filename);
83d0521a 275 qemu_opts_free(create_opts);
a283cb6e
KW
276 return 1;
277 }
c282e1fd 278 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
a283cb6e
KW
279 }
280
83d0521a
CL
281 qemu_opts_print_help(create_opts);
282 qemu_opts_free(create_opts);
4ac8aacd
JS
283 return 0;
284}
285
9ffe3332
KW
286static BlockDriverState *bdrv_new_open(const char *id,
287 const char *filename,
9bc378c1 288 const char *fmt,
f0536bb8 289 int flags,
f382d43a
MR
290 bool require_io,
291 bool quiet)
75c23805
FB
292{
293 BlockDriverState *bs;
294 BlockDriver *drv;
295 char password[256];
34b5d2c6 296 Error *local_err = NULL;
b9eaf9ec 297 int ret;
75c23805 298
9ffe3332 299 bs = bdrv_new(id, &error_abort);
ad717139 300
75c23805
FB
301 if (fmt) {
302 drv = bdrv_find_format(fmt);
c2abccec 303 if (!drv) {
15654a6d 304 error_report("Unknown file format '%s'", fmt);
c2abccec
MK
305 goto fail;
306 }
75c23805
FB
307 } else {
308 drv = NULL;
309 }
b9eaf9ec 310
ddf5636d 311 ret = bdrv_open(&bs, filename, NULL, NULL, flags, drv, &local_err);
b9eaf9ec 312 if (ret < 0) {
34b5d2c6
HR
313 error_report("Could not open '%s': %s", filename,
314 error_get_pretty(local_err));
315 error_free(local_err);
c2abccec 316 goto fail;
75c23805 317 }
b9eaf9ec 318
f0536bb8 319 if (bdrv_is_encrypted(bs) && require_io) {
f382d43a 320 qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
c2abccec 321 if (read_password(password, sizeof(password)) < 0) {
15654a6d 322 error_report("No password given");
c2abccec
MK
323 goto fail;
324 }
325 if (bdrv_set_key(bs, password) < 0) {
15654a6d 326 error_report("invalid password");
c2abccec
MK
327 goto fail;
328 }
75c23805
FB
329 }
330 return bs;
c2abccec 331fail:
f67503e5 332 bdrv_unref(bs);
c2abccec 333 return NULL;
75c23805
FB
334}
335
83d0521a 336static int add_old_style_options(const char *fmt, QemuOpts *opts,
eec77d9e
JS
337 const char *base_filename,
338 const char *base_fmt)
efa84d43 339{
efa84d43 340 if (base_filename) {
83d0521a 341 if (qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename)) {
15654a6d
JS
342 error_report("Backing file not supported for file format '%s'",
343 fmt);
c2abccec 344 return -1;
efa84d43
KW
345 }
346 }
347 if (base_fmt) {
83d0521a 348 if (qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt)) {
15654a6d
JS
349 error_report("Backing file format not supported for file "
350 "format '%s'", fmt);
c2abccec 351 return -1;
efa84d43
KW
352 }
353 }
c2abccec 354 return 0;
efa84d43
KW
355}
356
ea2384d3
FB
357static int img_create(int argc, char **argv)
358{
a9300911 359 int c;
1da7cfbd 360 uint64_t img_size = -1;
ea2384d3 361 const char *fmt = "raw";
9230eaf6 362 const char *base_fmt = NULL;
ea2384d3
FB
363 const char *filename;
364 const char *base_filename = NULL;
9ea2ea71 365 char *options = NULL;
9b37525a 366 Error *local_err = NULL;
f382d43a 367 bool quiet = false;
3b46e624 368
ea2384d3 369 for(;;) {
f382d43a 370 c = getopt(argc, argv, "F:b:f:he6o:q");
b8fb60da 371 if (c == -1) {
ea2384d3 372 break;
b8fb60da 373 }
ea2384d3 374 switch(c) {
ef87394c 375 case '?':
ea2384d3
FB
376 case 'h':
377 help();
378 break;
9230eaf6
AL
379 case 'F':
380 base_fmt = optarg;
381 break;
ea2384d3
FB
382 case 'b':
383 base_filename = optarg;
384 break;
385 case 'f':
386 fmt = optarg;
387 break;
388 case 'e':
9d42e15d 389 error_report("option -e is deprecated, please use \'-o "
eec77d9e 390 "encryption\' instead!");
77386bf6 391 goto fail;
d8871c5a 392 case '6':
9d42e15d 393 error_report("option -6 is deprecated, please use \'-o "
eec77d9e 394 "compat6\' instead!");
77386bf6 395 goto fail;
9ea2ea71 396 case 'o':
77386bf6
KW
397 if (!is_valid_option_list(optarg)) {
398 error_report("Invalid option list: %s", optarg);
399 goto fail;
400 }
401 if (!options) {
402 options = g_strdup(optarg);
403 } else {
404 char *old_options = options;
405 options = g_strdup_printf("%s,%s", options, optarg);
406 g_free(old_options);
407 }
9ea2ea71 408 break;
f382d43a
MR
409 case 'q':
410 quiet = true;
411 break;
ea2384d3
FB
412 }
413 }
9230eaf6 414
b50cbabc 415 /* Get the filename */
a283cb6e
KW
416 filename = (optind < argc) ? argv[optind] : NULL;
417 if (options && has_help_option(options)) {
418 g_free(options);
419 return print_block_option_help(filename, fmt);
420 }
421
b8fb60da 422 if (optind >= argc) {
ac1307ab 423 error_exit("Expecting image file name");
b8fb60da 424 }
a283cb6e 425 optind++;
b50cbabc 426
1da7cfbd
JS
427 /* Get image size, if specified */
428 if (optind < argc) {
70b4f4bb 429 int64_t sval;
e36b3695
MA
430 char *end;
431 sval = strtosz_suffix(argv[optind++], &end, STRTOSZ_DEFSUFFIX_B);
432 if (sval < 0 || *end) {
79443397
LG
433 if (sval == -ERANGE) {
434 error_report("Image size must be less than 8 EiB!");
435 } else {
436 error_report("Invalid image size specified! You may use k, M, "
5e00984a
KW
437 "G, T, P or E suffixes for ");
438 error_report("kilobytes, megabytes, gigabytes, terabytes, "
439 "petabytes and exabytes.");
79443397 440 }
77386bf6 441 goto fail;
1da7cfbd
JS
442 }
443 img_size = (uint64_t)sval;
444 }
fc11eb26 445 if (optind != argc) {
ac1307ab 446 error_exit("Unexpected argument: %s", argv[optind]);
fc11eb26 447 }
1da7cfbd 448
9b37525a 449 bdrv_img_create(filename, fmt, base_filename, base_fmt,
f382d43a 450 options, img_size, BDRV_O_FLAGS, &local_err, quiet);
84d18f06 451 if (local_err) {
b70d8c23 452 error_report("%s: %s", filename, error_get_pretty(local_err));
9b37525a 453 error_free(local_err);
77386bf6 454 goto fail;
c2abccec 455 }
a9300911 456
77386bf6 457 g_free(options);
ea2384d3 458 return 0;
77386bf6
KW
459
460fail:
461 g_free(options);
462 return 1;
ea2384d3
FB
463}
464
f382d43a 465static void dump_json_image_check(ImageCheck *check, bool quiet)
8599ea4c 466{
4399c438 467 Error *local_err = NULL;
8599ea4c
FS
468 QString *str;
469 QmpOutputVisitor *ov = qmp_output_visitor_new();
470 QObject *obj;
471 visit_type_ImageCheck(qmp_output_get_visitor(ov),
4399c438 472 &check, NULL, &local_err);
8599ea4c
FS
473 obj = qmp_output_get_qobject(ov);
474 str = qobject_to_json_pretty(obj);
475 assert(str != NULL);
f382d43a 476 qprintf(quiet, "%s\n", qstring_get_str(str));
8599ea4c
FS
477 qobject_decref(obj);
478 qmp_output_visitor_cleanup(ov);
479 QDECREF(str);
480}
481
f382d43a 482static void dump_human_image_check(ImageCheck *check, bool quiet)
8599ea4c
FS
483{
484 if (!(check->corruptions || check->leaks || check->check_errors)) {
f382d43a 485 qprintf(quiet, "No errors were found on the image.\n");
8599ea4c
FS
486 } else {
487 if (check->corruptions) {
f382d43a
MR
488 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
489 "Data may be corrupted, or further writes to the image "
490 "may corrupt it.\n",
491 check->corruptions);
8599ea4c
FS
492 }
493
494 if (check->leaks) {
f382d43a
MR
495 qprintf(quiet,
496 "\n%" PRId64 " leaked clusters were found on the image.\n"
497 "This means waste of disk space, but no harm to data.\n",
498 check->leaks);
8599ea4c
FS
499 }
500
501 if (check->check_errors) {
f382d43a
MR
502 qprintf(quiet,
503 "\n%" PRId64
504 " internal errors have occurred during the check.\n",
505 check->check_errors);
8599ea4c
FS
506 }
507 }
508
509 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
f382d43a
MR
510 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
511 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
512 check->allocated_clusters, check->total_clusters,
513 check->allocated_clusters * 100.0 / check->total_clusters,
514 check->fragmented_clusters * 100.0 / check->allocated_clusters,
515 check->compressed_clusters * 100.0 /
516 check->allocated_clusters);
8599ea4c
FS
517 }
518
519 if (check->image_end_offset) {
f382d43a
MR
520 qprintf(quiet,
521 "Image end offset: %" PRId64 "\n", check->image_end_offset);
8599ea4c
FS
522 }
523}
524
525static int collect_image_check(BlockDriverState *bs,
526 ImageCheck *check,
527 const char *filename,
528 const char *fmt,
529 int fix)
530{
531 int ret;
532 BdrvCheckResult result;
533
534 ret = bdrv_check(bs, &result, fix);
535 if (ret < 0) {
536 return ret;
537 }
538
539 check->filename = g_strdup(filename);
540 check->format = g_strdup(bdrv_get_format_name(bs));
541 check->check_errors = result.check_errors;
542 check->corruptions = result.corruptions;
543 check->has_corruptions = result.corruptions != 0;
544 check->leaks = result.leaks;
545 check->has_leaks = result.leaks != 0;
546 check->corruptions_fixed = result.corruptions_fixed;
547 check->has_corruptions_fixed = result.corruptions != 0;
548 check->leaks_fixed = result.leaks_fixed;
549 check->has_leaks_fixed = result.leaks != 0;
550 check->image_end_offset = result.image_end_offset;
551 check->has_image_end_offset = result.image_end_offset != 0;
552 check->total_clusters = result.bfi.total_clusters;
553 check->has_total_clusters = result.bfi.total_clusters != 0;
554 check->allocated_clusters = result.bfi.allocated_clusters;
555 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
556 check->fragmented_clusters = result.bfi.fragmented_clusters;
557 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
e6439d78
SH
558 check->compressed_clusters = result.bfi.compressed_clusters;
559 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
8599ea4c
FS
560
561 return 0;
562}
563
e076f338
KW
564/*
565 * Checks an image for consistency. Exit codes:
566 *
d6635c4d
HR
567 * 0 - Check completed, image is good
568 * 1 - Check not completed because of internal errors
569 * 2 - Check completed, image is corrupted
570 * 3 - Check completed, image has leaked clusters, but is good otherwise
571 * 63 - Checks are not supported by the image format
e076f338 572 */
1585969c
AL
573static int img_check(int argc, char **argv)
574{
575 int c, ret;
8599ea4c 576 OutputFormat output_format = OFORMAT_HUMAN;
40055951 577 const char *filename, *fmt, *output, *cache;
1585969c 578 BlockDriverState *bs;
4534ff54 579 int fix = 0;
058f8f16 580 int flags = BDRV_O_FLAGS | BDRV_O_CHECK;
8599ea4c 581 ImageCheck *check;
f382d43a 582 bool quiet = false;
1585969c
AL
583
584 fmt = NULL;
8599ea4c 585 output = NULL;
40055951 586 cache = BDRV_DEFAULT_CACHE;
1585969c 587 for(;;) {
8599ea4c
FS
588 int option_index = 0;
589 static const struct option long_options[] = {
590 {"help", no_argument, 0, 'h'},
591 {"format", required_argument, 0, 'f'},
4fd6a984 592 {"repair", required_argument, 0, 'r'},
8599ea4c
FS
593 {"output", required_argument, 0, OPTION_OUTPUT},
594 {0, 0, 0, 0}
595 };
40055951 596 c = getopt_long(argc, argv, "hf:r:T:q",
8599ea4c 597 long_options, &option_index);
b8fb60da 598 if (c == -1) {
1585969c 599 break;
b8fb60da 600 }
1585969c 601 switch(c) {
ef87394c 602 case '?':
1585969c
AL
603 case 'h':
604 help();
605 break;
606 case 'f':
607 fmt = optarg;
608 break;
4534ff54
KW
609 case 'r':
610 flags |= BDRV_O_RDWR;
611
612 if (!strcmp(optarg, "leaks")) {
613 fix = BDRV_FIX_LEAKS;
614 } else if (!strcmp(optarg, "all")) {
615 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
616 } else {
ac1307ab
FZ
617 error_exit("Unknown option value for -r "
618 "(expecting 'leaks' or 'all'): %s", optarg);
4534ff54
KW
619 }
620 break;
8599ea4c
FS
621 case OPTION_OUTPUT:
622 output = optarg;
623 break;
40055951
HR
624 case 'T':
625 cache = optarg;
626 break;
f382d43a
MR
627 case 'q':
628 quiet = true;
629 break;
1585969c
AL
630 }
631 }
fc11eb26 632 if (optind != argc - 1) {
ac1307ab 633 error_exit("Expecting one image file name");
b8fb60da 634 }
1585969c
AL
635 filename = argv[optind++];
636
8599ea4c
FS
637 if (output && !strcmp(output, "json")) {
638 output_format = OFORMAT_JSON;
639 } else if (output && !strcmp(output, "human")) {
640 output_format = OFORMAT_HUMAN;
641 } else if (output) {
642 error_report("--output must be used with human or json as argument.");
643 return 1;
644 }
645
40055951
HR
646 ret = bdrv_parse_cache_flags(cache, &flags);
647 if (ret < 0) {
648 error_report("Invalid source cache option: %s", cache);
649 return 1;
650 }
651
9ffe3332 652 bs = bdrv_new_open("image", filename, fmt, flags, true, quiet);
c2abccec
MK
653 if (!bs) {
654 return 1;
655 }
8599ea4c
FS
656
657 check = g_new0(ImageCheck, 1);
658 ret = collect_image_check(bs, check, filename, fmt, fix);
e076f338
KW
659
660 if (ret == -ENOTSUP) {
55d492d7 661 error_report("This image format does not support checks");
fefddf95 662 ret = 63;
8599ea4c 663 goto fail;
e076f338
KW
664 }
665
8599ea4c
FS
666 if (check->corruptions_fixed || check->leaks_fixed) {
667 int corruptions_fixed, leaks_fixed;
ccf34716 668
8599ea4c
FS
669 leaks_fixed = check->leaks_fixed;
670 corruptions_fixed = check->corruptions_fixed;
e076f338 671
8599ea4c 672 if (output_format == OFORMAT_HUMAN) {
f382d43a
MR
673 qprintf(quiet,
674 "The following inconsistencies were found and repaired:\n\n"
675 " %" PRId64 " leaked clusters\n"
676 " %" PRId64 " corruptions\n\n"
677 "Double checking the fixed image now...\n",
678 check->leaks_fixed,
679 check->corruptions_fixed);
e076f338
KW
680 }
681
8599ea4c 682 ret = collect_image_check(bs, check, filename, fmt, 0);
1585969c 683
8599ea4c
FS
684 check->leaks_fixed = leaks_fixed;
685 check->corruptions_fixed = corruptions_fixed;
f8111c24
DXW
686 }
687
8599ea4c
FS
688 switch (output_format) {
689 case OFORMAT_HUMAN:
f382d43a 690 dump_human_image_check(check, quiet);
8599ea4c
FS
691 break;
692 case OFORMAT_JSON:
f382d43a 693 dump_json_image_check(check, quiet);
8599ea4c 694 break;
c6bb9ad1
FS
695 }
696
8599ea4c
FS
697 if (ret || check->check_errors) {
698 ret = 1;
699 goto fail;
c2abccec 700 }
e076f338 701
8599ea4c
FS
702 if (check->corruptions) {
703 ret = 2;
704 } else if (check->leaks) {
705 ret = 3;
e076f338 706 } else {
8599ea4c 707 ret = 0;
e076f338 708 }
8599ea4c
FS
709
710fail:
711 qapi_free_ImageCheck(check);
4f6fd349 712 bdrv_unref(bs);
8599ea4c
FS
713
714 return ret;
1585969c
AL
715}
716
ea2384d3
FB
717static int img_commit(int argc, char **argv)
718{
661a0f71
FS
719 int c, ret, flags;
720 const char *filename, *fmt, *cache;
ea2384d3 721 BlockDriverState *bs;
f382d43a 722 bool quiet = false;
ea2384d3
FB
723
724 fmt = NULL;
661a0f71 725 cache = BDRV_DEFAULT_CACHE;
ea2384d3 726 for(;;) {
f382d43a 727 c = getopt(argc, argv, "f:ht:q");
b8fb60da 728 if (c == -1) {
ea2384d3 729 break;
b8fb60da 730 }
ea2384d3 731 switch(c) {
ef87394c 732 case '?':
ea2384d3
FB
733 case 'h':
734 help();
735 break;
736 case 'f':
737 fmt = optarg;
738 break;
661a0f71
FS
739 case 't':
740 cache = optarg;
741 break;
f382d43a
MR
742 case 'q':
743 quiet = true;
744 break;
ea2384d3
FB
745 }
746 }
fc11eb26 747 if (optind != argc - 1) {
ac1307ab 748 error_exit("Expecting one image file name");
b8fb60da 749 }
ea2384d3
FB
750 filename = argv[optind++];
751
661a0f71 752 flags = BDRV_O_RDWR;
c3993cdc 753 ret = bdrv_parse_cache_flags(cache, &flags);
661a0f71
FS
754 if (ret < 0) {
755 error_report("Invalid cache option: %s", cache);
a3981eb9 756 return 1;
661a0f71
FS
757 }
758
9ffe3332 759 bs = bdrv_new_open("image", filename, fmt, flags, true, quiet);
c2abccec
MK
760 if (!bs) {
761 return 1;
762 }
ea2384d3
FB
763 ret = bdrv_commit(bs);
764 switch(ret) {
765 case 0:
f382d43a 766 qprintf(quiet, "Image committed.\n");
ea2384d3
FB
767 break;
768 case -ENOENT:
15654a6d 769 error_report("No disk inserted");
ea2384d3
FB
770 break;
771 case -EACCES:
15654a6d 772 error_report("Image is read-only");
ea2384d3
FB
773 break;
774 case -ENOTSUP:
15654a6d 775 error_report("Image is already committed");
ea2384d3
FB
776 break;
777 default:
15654a6d 778 error_report("Error while committing image");
ea2384d3
FB
779 break;
780 }
781
4f6fd349 782 bdrv_unref(bs);
c2abccec
MK
783 if (ret) {
784 return 1;
785 }
ea2384d3
FB
786 return 0;
787}
788
f58c7b35
TS
789/*
790 * Returns true iff the first sector pointed to by 'buf' contains at least
791 * a non-NUL byte.
792 *
793 * 'pnum' is set to the number of sectors (including and immediately following
794 * the first one) that are known to be in the same allocated/unallocated state.
795 */
ea2384d3
FB
796static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
797{
1a6d39fd
SH
798 bool is_zero;
799 int i;
ea2384d3
FB
800
801 if (n <= 0) {
802 *pnum = 0;
803 return 0;
804 }
1a6d39fd 805 is_zero = buffer_is_zero(buf, 512);
ea2384d3
FB
806 for(i = 1; i < n; i++) {
807 buf += 512;
1a6d39fd 808 if (is_zero != buffer_is_zero(buf, 512)) {
ea2384d3 809 break;
1a6d39fd 810 }
ea2384d3
FB
811 }
812 *pnum = i;
1a6d39fd 813 return !is_zero;
ea2384d3
FB
814}
815
a22f123c
KW
816/*
817 * Like is_allocated_sectors, but if the buffer starts with a used sector,
818 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
819 * breaking up write requests for only small sparse areas.
820 */
821static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
822 int min)
823{
824 int ret;
825 int num_checked, num_used;
826
827 if (n < min) {
828 min = n;
829 }
830
831 ret = is_allocated_sectors(buf, n, pnum);
832 if (!ret) {
833 return ret;
834 }
835
836 num_used = *pnum;
837 buf += BDRV_SECTOR_SIZE * *pnum;
838 n -= *pnum;
839 num_checked = num_used;
840
841 while (n > 0) {
842 ret = is_allocated_sectors(buf, n, pnum);
843
844 buf += BDRV_SECTOR_SIZE * *pnum;
845 n -= *pnum;
846 num_checked += *pnum;
847 if (ret) {
848 num_used = num_checked;
849 } else if (*pnum >= min) {
850 break;
851 }
852 }
853
854 *pnum = num_used;
855 return 1;
856}
857
3e85c6fd
KW
858/*
859 * Compares two buffers sector by sector. Returns 0 if the first sector of both
860 * buffers matches, non-zero otherwise.
861 *
862 * pnum is set to the number of sectors (including and immediately following
863 * the first one) that are known to have the same comparison result
864 */
865static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
866 int *pnum)
867{
868 int res, i;
869
870 if (n <= 0) {
871 *pnum = 0;
872 return 0;
873 }
874
875 res = !!memcmp(buf1, buf2, 512);
876 for(i = 1; i < n; i++) {
877 buf1 += 512;
878 buf2 += 512;
879
880 if (!!memcmp(buf1, buf2, 512) != res) {
881 break;
882 }
883 }
884
885 *pnum = i;
886 return res;
887}
888
80ee15a6 889#define IO_BUF_SIZE (2 * 1024 * 1024)
ea2384d3 890
d14ed18c
MR
891static int64_t sectors_to_bytes(int64_t sectors)
892{
893 return sectors << BDRV_SECTOR_BITS;
894}
895
896static int64_t sectors_to_process(int64_t total, int64_t from)
897{
898 return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
899}
900
901/*
902 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
903 *
904 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
905 * data and negative value on error.
906 *
907 * @param bs: Driver used for accessing file
908 * @param sect_num: Number of first sector to check
909 * @param sect_count: Number of sectors to check
910 * @param filename: Name of disk file we are checking (logging purpose)
911 * @param buffer: Allocated buffer for storing read data
912 * @param quiet: Flag for quiet mode
913 */
914static int check_empty_sectors(BlockDriverState *bs, int64_t sect_num,
915 int sect_count, const char *filename,
916 uint8_t *buffer, bool quiet)
917{
918 int pnum, ret = 0;
919 ret = bdrv_read(bs, sect_num, buffer, sect_count);
920 if (ret < 0) {
921 error_report("Error while reading offset %" PRId64 " of %s: %s",
922 sectors_to_bytes(sect_num), filename, strerror(-ret));
923 return ret;
924 }
925 ret = is_allocated_sectors(buffer, sect_count, &pnum);
926 if (ret || pnum != sect_count) {
927 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
928 sectors_to_bytes(ret ? sect_num : sect_num + pnum));
929 return 1;
930 }
931
932 return 0;
933}
934
935/*
936 * Compares two images. Exit codes:
937 *
938 * 0 - Images are identical
939 * 1 - Images differ
940 * >1 - Error occurred
941 */
942static int img_compare(int argc, char **argv)
943{
40055951 944 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
d14ed18c
MR
945 BlockDriverState *bs1, *bs2;
946 int64_t total_sectors1, total_sectors2;
947 uint8_t *buf1 = NULL, *buf2 = NULL;
948 int pnum1, pnum2;
949 int allocated1, allocated2;
950 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
951 bool progress = false, quiet = false, strict = false;
40055951 952 int flags;
d14ed18c
MR
953 int64_t total_sectors;
954 int64_t sector_num = 0;
955 int64_t nb_sectors;
956 int c, pnum;
d14ed18c
MR
957 uint64_t progress_base;
958
40055951 959 cache = BDRV_DEFAULT_CACHE;
d14ed18c 960 for (;;) {
40055951 961 c = getopt(argc, argv, "hf:F:T:pqs");
d14ed18c
MR
962 if (c == -1) {
963 break;
964 }
965 switch (c) {
966 case '?':
967 case 'h':
968 help();
969 break;
970 case 'f':
971 fmt1 = optarg;
972 break;
973 case 'F':
974 fmt2 = optarg;
975 break;
40055951
HR
976 case 'T':
977 cache = optarg;
978 break;
d14ed18c
MR
979 case 'p':
980 progress = true;
981 break;
982 case 'q':
983 quiet = true;
984 break;
985 case 's':
986 strict = true;
987 break;
988 }
989 }
990
991 /* Progress is not shown in Quiet mode */
992 if (quiet) {
993 progress = false;
994 }
995
996
fc11eb26 997 if (optind != argc - 2) {
ac1307ab 998 error_exit("Expecting two image file names");
d14ed18c
MR
999 }
1000 filename1 = argv[optind++];
1001 filename2 = argv[optind++];
1002
cbda016d
SH
1003 /* Initialize before goto out */
1004 qemu_progress_init(progress, 2.0);
1005
40055951
HR
1006 flags = BDRV_O_FLAGS;
1007 ret = bdrv_parse_cache_flags(cache, &flags);
1008 if (ret < 0) {
1009 error_report("Invalid source cache option: %s", cache);
1010 ret = 2;
1011 goto out3;
1012 }
1013
40055951 1014 bs1 = bdrv_new_open("image 1", filename1, fmt1, flags, true, quiet);
d14ed18c
MR
1015 if (!bs1) {
1016 error_report("Can't open file %s", filename1);
1017 ret = 2;
1018 goto out3;
1019 }
1020
40055951 1021 bs2 = bdrv_new_open("image 2", filename2, fmt2, flags, true, quiet);
d14ed18c
MR
1022 if (!bs2) {
1023 error_report("Can't open file %s", filename2);
1024 ret = 2;
1025 goto out2;
1026 }
1027
1028 buf1 = qemu_blockalign(bs1, IO_BUF_SIZE);
1029 buf2 = qemu_blockalign(bs2, IO_BUF_SIZE);
52bf1e72
MA
1030 total_sectors1 = bdrv_nb_sectors(bs1);
1031 if (total_sectors1 < 0) {
1032 error_report("Can't get size of %s: %s",
1033 filename1, strerror(-total_sectors1));
1034 ret = 4;
1035 goto out;
1036 }
1037 total_sectors2 = bdrv_nb_sectors(bs2);
1038 if (total_sectors2 < 0) {
1039 error_report("Can't get size of %s: %s",
1040 filename2, strerror(-total_sectors2));
1041 ret = 4;
1042 goto out;
1043 }
d14ed18c
MR
1044 total_sectors = MIN(total_sectors1, total_sectors2);
1045 progress_base = MAX(total_sectors1, total_sectors2);
1046
1047 qemu_progress_print(0, 100);
1048
1049 if (strict && total_sectors1 != total_sectors2) {
1050 ret = 1;
1051 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1052 goto out;
1053 }
1054
1055 for (;;) {
1056 nb_sectors = sectors_to_process(total_sectors, sector_num);
1057 if (nb_sectors <= 0) {
1058 break;
1059 }
1060 allocated1 = bdrv_is_allocated_above(bs1, NULL, sector_num, nb_sectors,
1061 &pnum1);
1062 if (allocated1 < 0) {
1063 ret = 3;
1064 error_report("Sector allocation test failed for %s", filename1);
1065 goto out;
1066 }
1067
1068 allocated2 = bdrv_is_allocated_above(bs2, NULL, sector_num, nb_sectors,
1069 &pnum2);
1070 if (allocated2 < 0) {
1071 ret = 3;
1072 error_report("Sector allocation test failed for %s", filename2);
1073 goto out;
1074 }
1075 nb_sectors = MIN(pnum1, pnum2);
1076
1077 if (allocated1 == allocated2) {
1078 if (allocated1) {
1079 ret = bdrv_read(bs1, sector_num, buf1, nb_sectors);
1080 if (ret < 0) {
1081 error_report("Error while reading offset %" PRId64 " of %s:"
1082 " %s", sectors_to_bytes(sector_num), filename1,
1083 strerror(-ret));
1084 ret = 4;
1085 goto out;
1086 }
1087 ret = bdrv_read(bs2, sector_num, buf2, nb_sectors);
1088 if (ret < 0) {
1089 error_report("Error while reading offset %" PRId64
1090 " of %s: %s", sectors_to_bytes(sector_num),
1091 filename2, strerror(-ret));
1092 ret = 4;
1093 goto out;
1094 }
1095 ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
1096 if (ret || pnum != nb_sectors) {
d14ed18c
MR
1097 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1098 sectors_to_bytes(
1099 ret ? sector_num : sector_num + pnum));
36452f12 1100 ret = 1;
d14ed18c
MR
1101 goto out;
1102 }
1103 }
1104 } else {
1105 if (strict) {
1106 ret = 1;
1107 qprintf(quiet, "Strict mode: Offset %" PRId64
1108 " allocation mismatch!\n",
1109 sectors_to_bytes(sector_num));
1110 goto out;
1111 }
1112
1113 if (allocated1) {
1114 ret = check_empty_sectors(bs1, sector_num, nb_sectors,
1115 filename1, buf1, quiet);
1116 } else {
1117 ret = check_empty_sectors(bs2, sector_num, nb_sectors,
1118 filename2, buf1, quiet);
1119 }
1120 if (ret) {
1121 if (ret < 0) {
d14ed18c
MR
1122 error_report("Error while reading offset %" PRId64 ": %s",
1123 sectors_to_bytes(sector_num), strerror(-ret));
36452f12 1124 ret = 4;
d14ed18c
MR
1125 }
1126 goto out;
1127 }
1128 }
1129 sector_num += nb_sectors;
1130 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1131 }
1132
1133 if (total_sectors1 != total_sectors2) {
1134 BlockDriverState *bs_over;
1135 int64_t total_sectors_over;
1136 const char *filename_over;
1137
1138 qprintf(quiet, "Warning: Image size mismatch!\n");
1139 if (total_sectors1 > total_sectors2) {
1140 total_sectors_over = total_sectors1;
1141 bs_over = bs1;
1142 filename_over = filename1;
1143 } else {
1144 total_sectors_over = total_sectors2;
1145 bs_over = bs2;
1146 filename_over = filename2;
1147 }
1148
1149 for (;;) {
1150 nb_sectors = sectors_to_process(total_sectors_over, sector_num);
1151 if (nb_sectors <= 0) {
1152 break;
1153 }
1154 ret = bdrv_is_allocated_above(bs_over, NULL, sector_num,
1155 nb_sectors, &pnum);
1156 if (ret < 0) {
1157 ret = 3;
1158 error_report("Sector allocation test failed for %s",
1159 filename_over);
1160 goto out;
1161
1162 }
1163 nb_sectors = pnum;
1164 if (ret) {
1165 ret = check_empty_sectors(bs_over, sector_num, nb_sectors,
1166 filename_over, buf1, quiet);
1167 if (ret) {
1168 if (ret < 0) {
d14ed18c
MR
1169 error_report("Error while reading offset %" PRId64
1170 " of %s: %s", sectors_to_bytes(sector_num),
1171 filename_over, strerror(-ret));
36452f12 1172 ret = 4;
d14ed18c
MR
1173 }
1174 goto out;
1175 }
1176 }
1177 sector_num += nb_sectors;
1178 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1179 }
1180 }
1181
1182 qprintf(quiet, "Images are identical.\n");
1183 ret = 0;
1184
1185out:
4f6fd349 1186 bdrv_unref(bs2);
d14ed18c
MR
1187 qemu_vfree(buf1);
1188 qemu_vfree(buf2);
1189out2:
4f6fd349 1190 bdrv_unref(bs1);
d14ed18c
MR
1191out3:
1192 qemu_progress_end();
1193 return ret;
1194}
1195
ea2384d3
FB
1196static int img_convert(int argc, char **argv)
1197{
24f833cd 1198 int c, n, n1, bs_n, bs_i, compress, cluster_sectors, skip_create;
13c28af8 1199 int64_t ret = 0;
40055951
HR
1200 int progress = 0, flags, src_flags;
1201 const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
b50cbabc 1202 BlockDriver *drv, *proto_drv;
c2abccec 1203 BlockDriverState **bs = NULL, *out_bs = NULL;
802c3d4c 1204 int64_t total_sectors, nb_sectors, sector_num, bs_offset;
52bf1e72 1205 int64_t *bs_sectors = NULL;
c2abccec 1206 uint8_t * buf = NULL;
f2521c90 1207 size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
ea2384d3 1208 const uint8_t *buf1;
faea38e7 1209 BlockDriverInfo bdi;
83d0521a
CL
1210 QemuOpts *opts = NULL;
1211 QemuOptsList *create_opts = NULL;
1212 const char *out_baseimg_param;
efa84d43 1213 char *options = NULL;
51ef6727 1214 const char *snapshot_name = NULL;
a22f123c 1215 int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
f382d43a 1216 bool quiet = false;
cc84d90f 1217 Error *local_err = NULL;
ef80654d 1218 QemuOpts *sn_opts = NULL;
ea2384d3
FB
1219
1220 fmt = NULL;
1221 out_fmt = "raw";
661a0f71 1222 cache = "unsafe";
40055951 1223 src_cache = BDRV_DEFAULT_CACHE;
f58c7b35 1224 out_baseimg = NULL;
eec77d9e 1225 compress = 0;
b2e10493 1226 skip_create = 0;
ea2384d3 1227 for(;;) {
40055951 1228 c = getopt(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qn");
b8fb60da 1229 if (c == -1) {
ea2384d3 1230 break;
b8fb60da 1231 }
ea2384d3 1232 switch(c) {
ef87394c 1233 case '?':
ea2384d3
FB
1234 case 'h':
1235 help();
1236 break;
1237 case 'f':
1238 fmt = optarg;
1239 break;
1240 case 'O':
1241 out_fmt = optarg;
1242 break;
f58c7b35
TS
1243 case 'B':
1244 out_baseimg = optarg;
1245 break;
ea2384d3 1246 case 'c':
eec77d9e 1247 compress = 1;
ea2384d3
FB
1248 break;
1249 case 'e':
9d42e15d 1250 error_report("option -e is deprecated, please use \'-o "
eec77d9e 1251 "encryption\' instead!");
2dc8328b 1252 ret = -1;
64bb01aa 1253 goto fail_getopt;
ec36ba14 1254 case '6':
9d42e15d 1255 error_report("option -6 is deprecated, please use \'-o "
eec77d9e 1256 "compat6\' instead!");
2dc8328b 1257 ret = -1;
64bb01aa 1258 goto fail_getopt;
efa84d43 1259 case 'o':
2dc8328b
KW
1260 if (!is_valid_option_list(optarg)) {
1261 error_report("Invalid option list: %s", optarg);
1262 ret = -1;
64bb01aa 1263 goto fail_getopt;
2dc8328b
KW
1264 }
1265 if (!options) {
1266 options = g_strdup(optarg);
1267 } else {
1268 char *old_options = options;
1269 options = g_strdup_printf("%s,%s", options, optarg);
1270 g_free(old_options);
1271 }
efa84d43 1272 break;
51ef6727 1273 case 's':
1274 snapshot_name = optarg;
1275 break;
ef80654d
WX
1276 case 'l':
1277 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
1278 sn_opts = qemu_opts_parse(&internal_snapshot_opts, optarg, 0);
1279 if (!sn_opts) {
1280 error_report("Failed in parsing snapshot param '%s'",
1281 optarg);
2dc8328b 1282 ret = -1;
64bb01aa 1283 goto fail_getopt;
ef80654d
WX
1284 }
1285 } else {
1286 snapshot_name = optarg;
1287 }
1288 break;
a22f123c
KW
1289 case 'S':
1290 {
1291 int64_t sval;
e36b3695
MA
1292 char *end;
1293 sval = strtosz_suffix(optarg, &end, STRTOSZ_DEFSUFFIX_B);
1294 if (sval < 0 || *end) {
a22f123c 1295 error_report("Invalid minimum zero buffer size for sparse output specified");
2dc8328b 1296 ret = -1;
64bb01aa 1297 goto fail_getopt;
a22f123c
KW
1298 }
1299
1300 min_sparse = sval / BDRV_SECTOR_SIZE;
1301 break;
1302 }
6b837bc4
JS
1303 case 'p':
1304 progress = 1;
1305 break;
661a0f71
FS
1306 case 't':
1307 cache = optarg;
1308 break;
40055951
HR
1309 case 'T':
1310 src_cache = optarg;
1311 break;
f382d43a
MR
1312 case 'q':
1313 quiet = true;
1314 break;
b2e10493
AD
1315 case 'n':
1316 skip_create = 1;
1317 break;
ea2384d3
FB
1318 }
1319 }
3b46e624 1320
64bb01aa 1321 /* Initialize before goto out */
f382d43a
MR
1322 if (quiet) {
1323 progress = 0;
1324 }
64bb01aa
KW
1325 qemu_progress_init(progress, 1.0);
1326
f382d43a 1327
926c2d23 1328 bs_n = argc - optind - 1;
a283cb6e 1329 out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
f58c7b35 1330
2dc8328b 1331 if (options && has_help_option(options)) {
4ac8aacd
JS
1332 ret = print_block_option_help(out_filename, out_fmt);
1333 goto out;
1334 }
1335
a283cb6e 1336 if (bs_n < 1) {
ac1307ab 1337 error_exit("Must specify image file name");
a283cb6e
KW
1338 }
1339
1340
c2abccec 1341 if (bs_n > 1 && out_baseimg) {
15654a6d
JS
1342 error_report("-B makes no sense when concatenating multiple input "
1343 "images");
31ca34b8
JS
1344 ret = -1;
1345 goto out;
c2abccec 1346 }
f8111c24 1347
40055951
HR
1348 src_flags = BDRV_O_FLAGS;
1349 ret = bdrv_parse_cache_flags(src_cache, &src_flags);
1350 if (ret < 0) {
1351 error_report("Invalid source cache option: %s", src_cache);
1352 goto out;
1353 }
1354
6b837bc4
JS
1355 qemu_progress_print(0, 100);
1356
d739f1c4 1357 bs = g_new0(BlockDriverState *, bs_n);
52bf1e72 1358 bs_sectors = g_new(int64_t, bs_n);
926c2d23
AZ
1359
1360 total_sectors = 0;
1361 for (bs_i = 0; bs_i < bs_n; bs_i++) {
9ffe3332
KW
1362 char *id = bs_n > 1 ? g_strdup_printf("source %d", bs_i)
1363 : g_strdup("source");
40055951 1364 bs[bs_i] = bdrv_new_open(id, argv[optind + bs_i], fmt, src_flags,
9ffe3332
KW
1365 true, quiet);
1366 g_free(id);
c2abccec 1367 if (!bs[bs_i]) {
15654a6d 1368 error_report("Could not open '%s'", argv[optind + bs_i]);
c2abccec
MK
1369 ret = -1;
1370 goto out;
1371 }
52bf1e72
MA
1372 bs_sectors[bs_i] = bdrv_nb_sectors(bs[bs_i]);
1373 if (bs_sectors[bs_i] < 0) {
1374 error_report("Could not get size of %s: %s",
1375 argv[optind + bs_i], strerror(-bs_sectors[bs_i]));
1376 ret = -1;
1377 goto out;
1378 }
d739f1c4 1379 total_sectors += bs_sectors[bs_i];
926c2d23 1380 }
ea2384d3 1381
ef80654d
WX
1382 if (sn_opts) {
1383 ret = bdrv_snapshot_load_tmp(bs[0],
1384 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
1385 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
1386 &local_err);
1387 } else if (snapshot_name != NULL) {
51ef6727 1388 if (bs_n > 1) {
6daf194d 1389 error_report("No support for concatenating multiple snapshot");
51ef6727 1390 ret = -1;
1391 goto out;
1392 }
7b4c4781
WX
1393
1394 bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
ef80654d 1395 }
84d18f06 1396 if (local_err) {
ef80654d
WX
1397 error_report("Failed to load snapshot: %s",
1398 error_get_pretty(local_err));
1399 error_free(local_err);
1400 ret = -1;
1401 goto out;
51ef6727 1402 }
1403
efa84d43 1404 /* Find driver and parse its options */
ea2384d3 1405 drv = bdrv_find_format(out_fmt);
c2abccec 1406 if (!drv) {
15654a6d 1407 error_report("Unknown file format '%s'", out_fmt);
c2abccec
MK
1408 ret = -1;
1409 goto out;
1410 }
efa84d43 1411
98289620 1412 proto_drv = bdrv_find_protocol(out_filename, true);
c2abccec 1413 if (!proto_drv) {
15654a6d 1414 error_report("Unknown protocol '%s'", out_filename);
c2abccec
MK
1415 ret = -1;
1416 goto out;
1417 }
b50cbabc 1418
c282e1fd
CL
1419 create_opts = qemu_opts_append(create_opts, drv->create_opts);
1420 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
db08adf5 1421
83d0521a
CL
1422 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
1423 if (options && qemu_opts_do_parse(opts, options, NULL)) {
1424 error_report("Invalid options for file format '%s'", out_fmt);
1425 ret = -1;
1426 goto out;
efa84d43
KW
1427 }
1428
83d0521a
CL
1429 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512);
1430 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
c2abccec
MK
1431 if (ret < 0) {
1432 goto out;
1433 }
efa84d43 1434
a18953fb 1435 /* Get backing file name if -o backing_file was used */
83d0521a 1436 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
a18953fb 1437 if (out_baseimg_param) {
83d0521a 1438 out_baseimg = out_baseimg_param;
a18953fb
KW
1439 }
1440
efa84d43 1441 /* Check if compression is supported */
eec77d9e 1442 if (compress) {
83d0521a
CL
1443 bool encryption =
1444 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
1445 const char *preallocation =
1446 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
efa84d43
KW
1447
1448 if (!drv->bdrv_write_compressed) {
15654a6d 1449 error_report("Compression not supported for this file format");
c2abccec
MK
1450 ret = -1;
1451 goto out;
efa84d43
KW
1452 }
1453
83d0521a 1454 if (encryption) {
15654a6d
JS
1455 error_report("Compression and encryption not supported at "
1456 "the same time");
c2abccec
MK
1457 ret = -1;
1458 goto out;
efa84d43 1459 }
41521fa4 1460
83d0521a
CL
1461 if (preallocation
1462 && strcmp(preallocation, "off"))
41521fa4
KW
1463 {
1464 error_report("Compression and preallocation not supported at "
1465 "the same time");
1466 ret = -1;
1467 goto out;
1468 }
efa84d43
KW
1469 }
1470
b2e10493
AD
1471 if (!skip_create) {
1472 /* Create the new image */
c282e1fd 1473 ret = bdrv_create(drv, out_filename, opts, &local_err);
b2e10493 1474 if (ret < 0) {
cc84d90f
HR
1475 error_report("%s: error while converting %s: %s",
1476 out_filename, out_fmt, error_get_pretty(local_err));
1477 error_free(local_err);
b2e10493 1478 goto out;
ea2384d3
FB
1479 }
1480 }
3b46e624 1481
5a37b60a 1482 flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
c3993cdc 1483 ret = bdrv_parse_cache_flags(cache, &flags);
661a0f71
FS
1484 if (ret < 0) {
1485 error_report("Invalid cache option: %s", cache);
bb9cd2ee 1486 goto out;
661a0f71
FS
1487 }
1488
9ffe3332 1489 out_bs = bdrv_new_open("target", out_filename, out_fmt, flags, true, quiet);
c2abccec
MK
1490 if (!out_bs) {
1491 ret = -1;
1492 goto out;
1493 }
ea2384d3 1494
926c2d23
AZ
1495 bs_i = 0;
1496 bs_offset = 0;
f2521c90
PL
1497
1498 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
1499 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
1500 * as maximum. */
1501 bufsectors = MIN(32768,
1502 MAX(bufsectors, MAX(out_bs->bl.opt_transfer_length,
1503 out_bs->bl.discard_alignment))
1504 );
1505
1506 buf = qemu_blockalign(out_bs, bufsectors * BDRV_SECTOR_SIZE);
926c2d23 1507
b2e10493 1508 if (skip_create) {
43716fa8
MA
1509 int64_t output_sectors = bdrv_nb_sectors(out_bs);
1510 if (output_sectors < 0) {
b2e10493 1511 error_report("unable to get output image length: %s\n",
43716fa8 1512 strerror(-output_sectors));
b2e10493
AD
1513 ret = -1;
1514 goto out;
43716fa8 1515 } else if (output_sectors < total_sectors) {
b2e10493
AD
1516 error_report("output file is smaller than input file");
1517 ret = -1;
1518 goto out;
1519 }
1520 }
1521
24f833cd
PL
1522 cluster_sectors = 0;
1523 ret = bdrv_get_info(out_bs, &bdi);
1524 if (ret < 0) {
1525 if (compress) {
15654a6d 1526 error_report("could not get block driver info");
c2abccec
MK
1527 goto out;
1528 }
24f833cd 1529 } else {
85f49cad 1530 compress = compress || bdi.needs_compressed_writes;
24f833cd
PL
1531 cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
1532 }
1533
1534 if (compress) {
1535 if (cluster_sectors <= 0 || cluster_sectors > bufsectors) {
15654a6d 1536 error_report("invalid cluster size");
c2abccec
MK
1537 ret = -1;
1538 goto out;
1539 }
ea2384d3 1540 sector_num = 0;
6b837bc4
JS
1541
1542 nb_sectors = total_sectors;
6b837bc4 1543
ea2384d3 1544 for(;;) {
926c2d23
AZ
1545 int64_t bs_num;
1546 int remainder;
1547 uint8_t *buf2;
1548
ea2384d3
FB
1549 nb_sectors = total_sectors - sector_num;
1550 if (nb_sectors <= 0)
1551 break;
1552 if (nb_sectors >= cluster_sectors)
1553 n = cluster_sectors;
1554 else
1555 n = nb_sectors;
926c2d23
AZ
1556
1557 bs_num = sector_num - bs_offset;
1558 assert (bs_num >= 0);
1559 remainder = n;
1560 buf2 = buf;
1561 while (remainder > 0) {
1562 int nlow;
d739f1c4
MA
1563 while (bs_num == bs_sectors[bs_i]) {
1564 bs_offset += bs_sectors[bs_i];
926c2d23
AZ
1565 bs_i++;
1566 assert (bs_i < bs_n);
926c2d23 1567 bs_num = 0;
0bfcd599
BS
1568 /* printf("changing part: sector_num=%" PRId64 ", "
1569 "bs_i=%d, bs_offset=%" PRId64 ", bs_sectors=%" PRId64
d739f1c4 1570 "\n", sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
926c2d23 1571 }
d739f1c4 1572 assert (bs_num < bs_sectors[bs_i]);
926c2d23 1573
d739f1c4
MA
1574 nlow = remainder > bs_sectors[bs_i] - bs_num
1575 ? bs_sectors[bs_i] - bs_num : remainder;
926c2d23 1576
c2abccec
MK
1577 ret = bdrv_read(bs[bs_i], bs_num, buf2, nlow);
1578 if (ret < 0) {
3fba9d81
SH
1579 error_report("error while reading sector %" PRId64 ": %s",
1580 bs_num, strerror(-ret));
c2abccec
MK
1581 goto out;
1582 }
926c2d23
AZ
1583
1584 buf2 += nlow * 512;
1585 bs_num += nlow;
1586
1587 remainder -= nlow;
1588 }
1589 assert (remainder == 0);
1590
54f106d5
SH
1591 if (!buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)) {
1592 ret = bdrv_write_compressed(out_bs, sector_num, buf, n);
c2abccec 1593 if (ret != 0) {
3fba9d81
SH
1594 error_report("error while compressing sector %" PRId64
1595 ": %s", sector_num, strerror(-ret));
c2abccec
MK
1596 goto out;
1597 }
ea2384d3
FB
1598 }
1599 sector_num += n;
13c28af8 1600 qemu_progress_print(100.0 * sector_num / total_sectors, 0);
ea2384d3 1601 }
faea38e7
FB
1602 /* signal EOF to align */
1603 bdrv_write_compressed(out_bs, 0, NULL, 0);
ea2384d3 1604 } else {
802c3d4c
PL
1605 int64_t sectors_to_read, sectors_read, sector_num_next_status;
1606 bool count_allocated_sectors;
11b6699a 1607 int has_zero_init = min_sparse ? bdrv_has_zero_init(out_bs) : 0;
f2feebbd 1608
5a37b60a
PL
1609 if (!has_zero_init && bdrv_can_write_zeroes_with_unmap(out_bs)) {
1610 ret = bdrv_make_zero(out_bs, BDRV_REQ_MAY_UNMAP);
1611 if (ret < 0) {
1612 goto out;
1613 }
1614 has_zero_init = 1;
1615 }
1616
802c3d4c
PL
1617 sectors_to_read = total_sectors;
1618 count_allocated_sectors = progress && (out_baseimg || has_zero_init);
1619restart:
f58c7b35 1620 sector_num = 0; // total number of sectors converted so far
802c3d4c
PL
1621 sectors_read = 0;
1622 sector_num_next_status = 0;
6b837bc4 1623
ea2384d3
FB
1624 for(;;) {
1625 nb_sectors = total_sectors - sector_num;
b8fb60da 1626 if (nb_sectors <= 0) {
802c3d4c
PL
1627 if (count_allocated_sectors) {
1628 sectors_to_read = sectors_read;
1629 count_allocated_sectors = false;
1630 goto restart;
1631 }
13c28af8 1632 ret = 0;
ea2384d3 1633 break;
b8fb60da 1634 }
926c2d23 1635
d739f1c4
MA
1636 while (sector_num - bs_offset >= bs_sectors[bs_i]) {
1637 bs_offset += bs_sectors[bs_i];
926c2d23
AZ
1638 bs_i ++;
1639 assert (bs_i < bs_n);
0bfcd599
BS
1640 /* printf("changing part: sector_num=%" PRId64 ", bs_i=%d, "
1641 "bs_offset=%" PRId64 ", bs_sectors=%" PRId64 "\n",
d739f1c4 1642 sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
926c2d23
AZ
1643 }
1644
13c28af8
PL
1645 if ((out_baseimg || has_zero_init) &&
1646 sector_num >= sector_num_next_status) {
1647 n = nb_sectors > INT_MAX ? INT_MAX : nb_sectors;
1648 ret = bdrv_get_block_status(bs[bs_i], sector_num - bs_offset,
1649 n, &n1);
e4a86f88 1650 if (ret < 0) {
13c28af8
PL
1651 error_report("error while reading block status of sector %"
1652 PRId64 ": %s", sector_num - bs_offset,
1653 strerror(-ret));
e4a86f88
PB
1654 goto out;
1655 }
13c28af8
PL
1656 /* If the output image is zero initialized, we are not working
1657 * on a shared base and the input is zero we can skip the next
1658 * n1 sectors */
1659 if (has_zero_init && !out_baseimg && (ret & BDRV_BLOCK_ZERO)) {
e4a86f88
PB
1660 sector_num += n1;
1661 continue;
93c65b47 1662 }
13c28af8
PL
1663 /* If the output image is being created as a copy on write
1664 * image, assume that sectors which are unallocated in the
1665 * input image are present in both the output's and input's
1666 * base images (no need to copy them). */
1667 if (out_baseimg) {
1668 if (!(ret & BDRV_BLOCK_DATA)) {
1669 sector_num += n1;
1670 continue;
1671 }
1672 /* The next 'n1' sectors are allocated in the input image.
1673 * Copy only those as they may be followed by unallocated
1674 * sectors. */
1675 nb_sectors = n1;
1676 }
1677 /* avoid redundant callouts to get_block_status */
1678 sector_num_next_status = sector_num + n1;
f58c7b35
TS
1679 }
1680
f2521c90 1681 n = MIN(nb_sectors, bufsectors);
24f833cd
PL
1682
1683 /* round down request length to an aligned sector, but
1684 * do not bother doing this on short requests. They happen
1685 * when we found an all-zero area, and the next sector to
1686 * write will not be sector_num + n. */
1687 if (cluster_sectors > 0 && n >= cluster_sectors) {
1688 int64_t next_aligned_sector = (sector_num + n);
1689 next_aligned_sector -= next_aligned_sector % cluster_sectors;
1690 if (sector_num + n > next_aligned_sector) {
1691 n = next_aligned_sector - sector_num;
1692 }
1693 }
1694
d739f1c4 1695 n = MIN(n, bs_sectors[bs_i] - (sector_num - bs_offset));
13c28af8 1696
802c3d4c
PL
1697 sectors_read += n;
1698 if (count_allocated_sectors) {
1699 sector_num += n;
1700 continue;
1701 }
1702
1703 n1 = n;
c2abccec
MK
1704 ret = bdrv_read(bs[bs_i], sector_num - bs_offset, buf, n);
1705 if (ret < 0) {
3fba9d81
SH
1706 error_report("error while reading sector %" PRId64 ": %s",
1707 sector_num - bs_offset, strerror(-ret));
c2abccec
MK
1708 goto out;
1709 }
ea2384d3
FB
1710 /* NOTE: at the same time we convert, we do not write zero
1711 sectors to have a chance to compress the image. Ideally, we
1712 should add a specific call to have the info to go faster */
1713 buf1 = buf;
1714 while (n > 0) {
11212d8f 1715 if (!has_zero_init ||
a22f123c 1716 is_allocated_sectors_min(buf1, n, &n1, min_sparse)) {
c2abccec
MK
1717 ret = bdrv_write(out_bs, sector_num, buf1, n1);
1718 if (ret < 0) {
3fba9d81
SH
1719 error_report("error while writing sector %" PRId64
1720 ": %s", sector_num, strerror(-ret));
c2abccec
MK
1721 goto out;
1722 }
ea2384d3
FB
1723 }
1724 sector_num += n1;
1725 n -= n1;
1726 buf1 += n1 * 512;
1727 }
802c3d4c 1728 qemu_progress_print(100.0 * sectors_read / sectors_to_read, 0);
ea2384d3
FB
1729 }
1730 }
c2abccec 1731out:
13c28af8
PL
1732 if (!ret) {
1733 qemu_progress_print(100, 0);
1734 }
6b837bc4 1735 qemu_progress_end();
83d0521a
CL
1736 qemu_opts_del(opts);
1737 qemu_opts_free(create_opts);
bb1c0597 1738 qemu_vfree(buf);
ef80654d
WX
1739 if (sn_opts) {
1740 qemu_opts_del(sn_opts);
1741 }
c2abccec 1742 if (out_bs) {
4f6fd349 1743 bdrv_unref(out_bs);
c2abccec 1744 }
31ca34b8
JS
1745 if (bs) {
1746 for (bs_i = 0; bs_i < bs_n; bs_i++) {
1747 if (bs[bs_i]) {
4f6fd349 1748 bdrv_unref(bs[bs_i]);
31ca34b8 1749 }
c2abccec 1750 }
7267c094 1751 g_free(bs);
c2abccec 1752 }
d739f1c4 1753 g_free(bs_sectors);
64bb01aa
KW
1754fail_getopt:
1755 g_free(options);
1756
c2abccec
MK
1757 if (ret) {
1758 return 1;
1759 }
ea2384d3
FB
1760 return 0;
1761}
1762
57d1a2b6 1763
faea38e7
FB
1764static void dump_snapshots(BlockDriverState *bs)
1765{
1766 QEMUSnapshotInfo *sn_tab, *sn;
1767 int nb_sns, i;
faea38e7
FB
1768
1769 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1770 if (nb_sns <= 0)
1771 return;
1772 printf("Snapshot list:\n");
5b917044
WX
1773 bdrv_snapshot_dump(fprintf, stdout, NULL);
1774 printf("\n");
faea38e7
FB
1775 for(i = 0; i < nb_sns; i++) {
1776 sn = &sn_tab[i];
5b917044
WX
1777 bdrv_snapshot_dump(fprintf, stdout, sn);
1778 printf("\n");
faea38e7 1779 }
7267c094 1780 g_free(sn_tab);
faea38e7
FB
1781}
1782
9699bf0d
SH
1783static void dump_json_image_info_list(ImageInfoList *list)
1784{
4399c438 1785 Error *local_err = NULL;
9699bf0d
SH
1786 QString *str;
1787 QmpOutputVisitor *ov = qmp_output_visitor_new();
1788 QObject *obj;
1789 visit_type_ImageInfoList(qmp_output_get_visitor(ov),
4399c438 1790 &list, NULL, &local_err);
9699bf0d
SH
1791 obj = qmp_output_get_qobject(ov);
1792 str = qobject_to_json_pretty(obj);
1793 assert(str != NULL);
1794 printf("%s\n", qstring_get_str(str));
1795 qobject_decref(obj);
1796 qmp_output_visitor_cleanup(ov);
1797 QDECREF(str);
1798}
1799
c054b3fd
BC
1800static void dump_json_image_info(ImageInfo *info)
1801{
4399c438 1802 Error *local_err = NULL;
c054b3fd
BC
1803 QString *str;
1804 QmpOutputVisitor *ov = qmp_output_visitor_new();
1805 QObject *obj;
1806 visit_type_ImageInfo(qmp_output_get_visitor(ov),
4399c438 1807 &info, NULL, &local_err);
c054b3fd
BC
1808 obj = qmp_output_get_qobject(ov);
1809 str = qobject_to_json_pretty(obj);
1810 assert(str != NULL);
1811 printf("%s\n", qstring_get_str(str));
1812 qobject_decref(obj);
1813 qmp_output_visitor_cleanup(ov);
1814 QDECREF(str);
1815}
1816
9699bf0d
SH
1817static void dump_human_image_info_list(ImageInfoList *list)
1818{
1819 ImageInfoList *elem;
1820 bool delim = false;
1821
1822 for (elem = list; elem; elem = elem->next) {
1823 if (delim) {
1824 printf("\n");
1825 }
1826 delim = true;
1827
5b917044 1828 bdrv_image_info_dump(fprintf, stdout, elem->value);
9699bf0d
SH
1829 }
1830}
1831
1832static gboolean str_equal_func(gconstpointer a, gconstpointer b)
1833{
1834 return strcmp(a, b) == 0;
1835}
1836
1837/**
1838 * Open an image file chain and return an ImageInfoList
1839 *
1840 * @filename: topmost image filename
1841 * @fmt: topmost image format (may be NULL to autodetect)
1842 * @chain: true - enumerate entire backing file chain
1843 * false - only topmost image file
1844 *
1845 * Returns a list of ImageInfo objects or NULL if there was an error opening an
1846 * image file. If there was an error a message will have been printed to
1847 * stderr.
1848 */
1849static ImageInfoList *collect_image_info_list(const char *filename,
1850 const char *fmt,
1851 bool chain)
1852{
1853 ImageInfoList *head = NULL;
1854 ImageInfoList **last = &head;
1855 GHashTable *filenames;
43526ec8 1856 Error *err = NULL;
9699bf0d
SH
1857
1858 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
1859
1860 while (filename) {
1861 BlockDriverState *bs;
1862 ImageInfo *info;
1863 ImageInfoList *elem;
1864
1865 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
1866 error_report("Backing file '%s' creates an infinite loop.",
1867 filename);
1868 goto err;
1869 }
1870 g_hash_table_insert(filenames, (gpointer)filename, NULL);
1871
9ffe3332
KW
1872 bs = bdrv_new_open("image", filename, fmt,
1873 BDRV_O_FLAGS | BDRV_O_NO_BACKING, false, false);
9699bf0d
SH
1874 if (!bs) {
1875 goto err;
1876 }
1877
43526ec8 1878 bdrv_query_image_info(bs, &info, &err);
84d18f06 1879 if (err) {
43526ec8
WX
1880 error_report("%s", error_get_pretty(err));
1881 error_free(err);
bdf866fe 1882 bdrv_unref(bs);
43526ec8 1883 goto err;
fb0ed453 1884 }
9699bf0d
SH
1885
1886 elem = g_new0(ImageInfoList, 1);
1887 elem->value = info;
1888 *last = elem;
1889 last = &elem->next;
1890
4f6fd349 1891 bdrv_unref(bs);
9699bf0d
SH
1892
1893 filename = fmt = NULL;
1894 if (chain) {
1895 if (info->has_full_backing_filename) {
1896 filename = info->full_backing_filename;
1897 } else if (info->has_backing_filename) {
1898 filename = info->backing_filename;
1899 }
1900 if (info->has_backing_filename_format) {
1901 fmt = info->backing_filename_format;
1902 }
1903 }
1904 }
1905 g_hash_table_destroy(filenames);
1906 return head;
1907
1908err:
1909 qapi_free_ImageInfoList(head);
1910 g_hash_table_destroy(filenames);
1911 return NULL;
1912}
1913
c054b3fd
BC
1914static int img_info(int argc, char **argv)
1915{
1916 int c;
1917 OutputFormat output_format = OFORMAT_HUMAN;
9699bf0d 1918 bool chain = false;
c054b3fd 1919 const char *filename, *fmt, *output;
9699bf0d 1920 ImageInfoList *list;
c054b3fd 1921
ea2384d3 1922 fmt = NULL;
c054b3fd 1923 output = NULL;
ea2384d3 1924 for(;;) {
c054b3fd
BC
1925 int option_index = 0;
1926 static const struct option long_options[] = {
1927 {"help", no_argument, 0, 'h'},
1928 {"format", required_argument, 0, 'f'},
1929 {"output", required_argument, 0, OPTION_OUTPUT},
9699bf0d 1930 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
c054b3fd
BC
1931 {0, 0, 0, 0}
1932 };
1933 c = getopt_long(argc, argv, "f:h",
1934 long_options, &option_index);
b8fb60da 1935 if (c == -1) {
ea2384d3 1936 break;
b8fb60da 1937 }
ea2384d3 1938 switch(c) {
ef87394c 1939 case '?':
ea2384d3
FB
1940 case 'h':
1941 help();
1942 break;
1943 case 'f':
1944 fmt = optarg;
1945 break;
c054b3fd
BC
1946 case OPTION_OUTPUT:
1947 output = optarg;
1948 break;
9699bf0d
SH
1949 case OPTION_BACKING_CHAIN:
1950 chain = true;
1951 break;
ea2384d3
FB
1952 }
1953 }
fc11eb26 1954 if (optind != argc - 1) {
ac1307ab 1955 error_exit("Expecting one image file name");
b8fb60da 1956 }
ea2384d3
FB
1957 filename = argv[optind++];
1958
c054b3fd
BC
1959 if (output && !strcmp(output, "json")) {
1960 output_format = OFORMAT_JSON;
1961 } else if (output && !strcmp(output, "human")) {
1962 output_format = OFORMAT_HUMAN;
1963 } else if (output) {
1964 error_report("--output must be used with human or json as argument.");
c2abccec
MK
1965 return 1;
1966 }
c054b3fd 1967
9699bf0d
SH
1968 list = collect_image_info_list(filename, fmt, chain);
1969 if (!list) {
c2abccec 1970 return 1;
faea38e7 1971 }
c054b3fd 1972
c054b3fd
BC
1973 switch (output_format) {
1974 case OFORMAT_HUMAN:
9699bf0d 1975 dump_human_image_info_list(list);
c054b3fd
BC
1976 break;
1977 case OFORMAT_JSON:
9699bf0d
SH
1978 if (chain) {
1979 dump_json_image_info_list(list);
1980 } else {
1981 dump_json_image_info(list->value);
1982 }
c054b3fd 1983 break;
faea38e7 1984 }
c054b3fd 1985
9699bf0d 1986 qapi_free_ImageInfoList(list);
ea2384d3
FB
1987 return 0;
1988}
1989
4c93a13b
PB
1990
1991typedef struct MapEntry {
1992 int flags;
1993 int depth;
1994 int64_t start;
1995 int64_t length;
1996 int64_t offset;
1997 BlockDriverState *bs;
1998} MapEntry;
1999
2000static void dump_map_entry(OutputFormat output_format, MapEntry *e,
2001 MapEntry *next)
2002{
2003 switch (output_format) {
2004 case OFORMAT_HUMAN:
2005 if ((e->flags & BDRV_BLOCK_DATA) &&
2006 !(e->flags & BDRV_BLOCK_OFFSET_VALID)) {
2007 error_report("File contains external, encrypted or compressed clusters.");
2008 exit(1);
2009 }
2010 if ((e->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) == BDRV_BLOCK_DATA) {
2011 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2012 e->start, e->length, e->offset, e->bs->filename);
2013 }
2014 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2015 * Modify the flags here to allow more coalescing.
2016 */
2017 if (next &&
2018 (next->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) != BDRV_BLOCK_DATA) {
2019 next->flags &= ~BDRV_BLOCK_DATA;
2020 next->flags |= BDRV_BLOCK_ZERO;
2021 }
2022 break;
2023 case OFORMAT_JSON:
2024 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64", \"depth\": %d,"
2025 " \"zero\": %s, \"data\": %s",
2026 (e->start == 0 ? "[" : ",\n"),
2027 e->start, e->length, e->depth,
2028 (e->flags & BDRV_BLOCK_ZERO) ? "true" : "false",
2029 (e->flags & BDRV_BLOCK_DATA) ? "true" : "false");
2030 if (e->flags & BDRV_BLOCK_OFFSET_VALID) {
c745bfb4 2031 printf(", \"offset\": %"PRId64"", e->offset);
4c93a13b
PB
2032 }
2033 putchar('}');
2034
2035 if (!next) {
2036 printf("]\n");
2037 }
2038 break;
2039 }
2040}
2041
2042static int get_block_status(BlockDriverState *bs, int64_t sector_num,
2043 int nb_sectors, MapEntry *e)
2044{
2045 int64_t ret;
2046 int depth;
2047
2048 /* As an optimization, we could cache the current range of unallocated
2049 * clusters in each file of the chain, and avoid querying the same
2050 * range repeatedly.
2051 */
2052
2053 depth = 0;
2054 for (;;) {
2055 ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors);
2056 if (ret < 0) {
2057 return ret;
2058 }
2059 assert(nb_sectors);
2060 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2061 break;
2062 }
2063 bs = bs->backing_hd;
2064 if (bs == NULL) {
2065 ret = 0;
2066 break;
2067 }
2068
2069 depth++;
2070 }
2071
2072 e->start = sector_num * BDRV_SECTOR_SIZE;
2073 e->length = nb_sectors * BDRV_SECTOR_SIZE;
2074 e->flags = ret & ~BDRV_BLOCK_OFFSET_MASK;
2075 e->offset = ret & BDRV_BLOCK_OFFSET_MASK;
2076 e->depth = depth;
2077 e->bs = bs;
2078 return 0;
2079}
2080
2081static int img_map(int argc, char **argv)
2082{
2083 int c;
2084 OutputFormat output_format = OFORMAT_HUMAN;
2085 BlockDriverState *bs;
2086 const char *filename, *fmt, *output;
2087 int64_t length;
2088 MapEntry curr = { .length = 0 }, next;
2089 int ret = 0;
2090
2091 fmt = NULL;
2092 output = NULL;
2093 for (;;) {
2094 int option_index = 0;
2095 static const struct option long_options[] = {
2096 {"help", no_argument, 0, 'h'},
2097 {"format", required_argument, 0, 'f'},
2098 {"output", required_argument, 0, OPTION_OUTPUT},
2099 {0, 0, 0, 0}
2100 };
2101 c = getopt_long(argc, argv, "f:h",
2102 long_options, &option_index);
2103 if (c == -1) {
2104 break;
2105 }
2106 switch (c) {
2107 case '?':
2108 case 'h':
2109 help();
2110 break;
2111 case 'f':
2112 fmt = optarg;
2113 break;
2114 case OPTION_OUTPUT:
2115 output = optarg;
2116 break;
2117 }
2118 }
ac1307ab
FZ
2119 if (optind != argc - 1) {
2120 error_exit("Expecting one image file name");
4c93a13b 2121 }
ac1307ab 2122 filename = argv[optind];
4c93a13b
PB
2123
2124 if (output && !strcmp(output, "json")) {
2125 output_format = OFORMAT_JSON;
2126 } else if (output && !strcmp(output, "human")) {
2127 output_format = OFORMAT_HUMAN;
2128 } else if (output) {
2129 error_report("--output must be used with human or json as argument.");
2130 return 1;
2131 }
2132
9ffe3332 2133 bs = bdrv_new_open("image", filename, fmt, BDRV_O_FLAGS, true, false);
4c93a13b
PB
2134 if (!bs) {
2135 return 1;
2136 }
2137
2138 if (output_format == OFORMAT_HUMAN) {
2139 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2140 }
2141
2142 length = bdrv_getlength(bs);
2143 while (curr.start + curr.length < length) {
2144 int64_t nsectors_left;
2145 int64_t sector_num;
2146 int n;
2147
2148 sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;
2149
2150 /* Probe up to 1 GiB at a time. */
2151 nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
2152 n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
2153 ret = get_block_status(bs, sector_num, n, &next);
2154
2155 if (ret < 0) {
2156 error_report("Could not read file metadata: %s", strerror(-ret));
2157 goto out;
2158 }
2159
2160 if (curr.length != 0 && curr.flags == next.flags &&
2161 curr.depth == next.depth &&
2162 ((curr.flags & BDRV_BLOCK_OFFSET_VALID) == 0 ||
2163 curr.offset + curr.length == next.offset)) {
2164 curr.length += next.length;
2165 continue;
2166 }
2167
2168 if (curr.length > 0) {
2169 dump_map_entry(output_format, &curr, &next);
2170 }
2171 curr = next;
2172 }
2173
2174 dump_map_entry(output_format, &curr, NULL);
2175
2176out:
2177 bdrv_unref(bs);
2178 return ret < 0;
2179}
2180
f7b4a940
AL
2181#define SNAPSHOT_LIST 1
2182#define SNAPSHOT_CREATE 2
2183#define SNAPSHOT_APPLY 3
2184#define SNAPSHOT_DELETE 4
2185
153859be 2186static int img_snapshot(int argc, char **argv)
f7b4a940
AL
2187{
2188 BlockDriverState *bs;
2189 QEMUSnapshotInfo sn;
2190 char *filename, *snapshot_name = NULL;
c2abccec 2191 int c, ret = 0, bdrv_oflags;
f7b4a940
AL
2192 int action = 0;
2193 qemu_timeval tv;
f382d43a 2194 bool quiet = false;
a89d89d3 2195 Error *err = NULL;
f7b4a940 2196
710da702 2197 bdrv_oflags = BDRV_O_FLAGS | BDRV_O_RDWR;
f7b4a940
AL
2198 /* Parse commandline parameters */
2199 for(;;) {
f382d43a 2200 c = getopt(argc, argv, "la:c:d:hq");
b8fb60da 2201 if (c == -1) {
f7b4a940 2202 break;
b8fb60da 2203 }
f7b4a940 2204 switch(c) {
ef87394c 2205 case '?':
f7b4a940
AL
2206 case 'h':
2207 help();
153859be 2208 return 0;
f7b4a940
AL
2209 case 'l':
2210 if (action) {
ac1307ab 2211 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2212 return 0;
f7b4a940
AL
2213 }
2214 action = SNAPSHOT_LIST;
f5edb014 2215 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
f7b4a940
AL
2216 break;
2217 case 'a':
2218 if (action) {
ac1307ab 2219 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2220 return 0;
f7b4a940
AL
2221 }
2222 action = SNAPSHOT_APPLY;
2223 snapshot_name = optarg;
2224 break;
2225 case 'c':
2226 if (action) {
ac1307ab 2227 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2228 return 0;
f7b4a940
AL
2229 }
2230 action = SNAPSHOT_CREATE;
2231 snapshot_name = optarg;
2232 break;
2233 case 'd':
2234 if (action) {
ac1307ab 2235 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2236 return 0;
f7b4a940
AL
2237 }
2238 action = SNAPSHOT_DELETE;
2239 snapshot_name = optarg;
2240 break;
f382d43a
MR
2241 case 'q':
2242 quiet = true;
2243 break;
f7b4a940
AL
2244 }
2245 }
2246
fc11eb26 2247 if (optind != argc - 1) {
ac1307ab 2248 error_exit("Expecting one image file name");
b8fb60da 2249 }
f7b4a940
AL
2250 filename = argv[optind++];
2251
2252 /* Open the image */
9ffe3332 2253 bs = bdrv_new_open("image", filename, NULL, bdrv_oflags, true, quiet);
c2abccec
MK
2254 if (!bs) {
2255 return 1;
2256 }
f7b4a940
AL
2257
2258 /* Perform the requested action */
2259 switch(action) {
2260 case SNAPSHOT_LIST:
2261 dump_snapshots(bs);
2262 break;
2263
2264 case SNAPSHOT_CREATE:
2265 memset(&sn, 0, sizeof(sn));
2266 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
2267
2268 qemu_gettimeofday(&tv);
2269 sn.date_sec = tv.tv_sec;
2270 sn.date_nsec = tv.tv_usec * 1000;
2271
2272 ret = bdrv_snapshot_create(bs, &sn);
b8fb60da 2273 if (ret) {
15654a6d 2274 error_report("Could not create snapshot '%s': %d (%s)",
f7b4a940 2275 snapshot_name, ret, strerror(-ret));
b8fb60da 2276 }
f7b4a940
AL
2277 break;
2278
2279 case SNAPSHOT_APPLY:
2280 ret = bdrv_snapshot_goto(bs, snapshot_name);
b8fb60da 2281 if (ret) {
15654a6d 2282 error_report("Could not apply snapshot '%s': %d (%s)",
f7b4a940 2283 snapshot_name, ret, strerror(-ret));
b8fb60da 2284 }
f7b4a940
AL
2285 break;
2286
2287 case SNAPSHOT_DELETE:
a89d89d3 2288 bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
84d18f06 2289 if (err) {
a89d89d3
WX
2290 error_report("Could not delete snapshot '%s': (%s)",
2291 snapshot_name, error_get_pretty(err));
2292 error_free(err);
2293 ret = 1;
b8fb60da 2294 }
f7b4a940
AL
2295 break;
2296 }
2297
2298 /* Cleanup */
4f6fd349 2299 bdrv_unref(bs);
c2abccec
MK
2300 if (ret) {
2301 return 1;
2302 }
153859be 2303 return 0;
f7b4a940
AL
2304}
2305
3e85c6fd
KW
2306static int img_rebase(int argc, char **argv)
2307{
40ed35a3 2308 BlockDriverState *bs = NULL, *bs_old_backing = NULL, *bs_new_backing = NULL;
f163d073 2309 BlockDriver *old_backing_drv, *new_backing_drv;
3e85c6fd 2310 char *filename;
40055951
HR
2311 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
2312 int c, flags, src_flags, ret;
3e85c6fd 2313 int unsafe = 0;
6b837bc4 2314 int progress = 0;
f382d43a 2315 bool quiet = false;
34b5d2c6 2316 Error *local_err = NULL;
3e85c6fd
KW
2317
2318 /* Parse commandline parameters */
e53dbee0 2319 fmt = NULL;
661a0f71 2320 cache = BDRV_DEFAULT_CACHE;
40055951 2321 src_cache = BDRV_DEFAULT_CACHE;
3e85c6fd
KW
2322 out_baseimg = NULL;
2323 out_basefmt = NULL;
3e85c6fd 2324 for(;;) {
40055951 2325 c = getopt(argc, argv, "hf:F:b:upt:T:q");
b8fb60da 2326 if (c == -1) {
3e85c6fd 2327 break;
b8fb60da 2328 }
3e85c6fd 2329 switch(c) {
ef87394c 2330 case '?':
3e85c6fd
KW
2331 case 'h':
2332 help();
2333 return 0;
e53dbee0
KW
2334 case 'f':
2335 fmt = optarg;
2336 break;
3e85c6fd
KW
2337 case 'F':
2338 out_basefmt = optarg;
2339 break;
2340 case 'b':
2341 out_baseimg = optarg;
2342 break;
2343 case 'u':
2344 unsafe = 1;
2345 break;
6b837bc4
JS
2346 case 'p':
2347 progress = 1;
2348 break;
661a0f71
FS
2349 case 't':
2350 cache = optarg;
2351 break;
40055951
HR
2352 case 'T':
2353 src_cache = optarg;
2354 break;
f382d43a
MR
2355 case 'q':
2356 quiet = true;
2357 break;
3e85c6fd
KW
2358 }
2359 }
2360
f382d43a
MR
2361 if (quiet) {
2362 progress = 0;
2363 }
2364
ac1307ab
FZ
2365 if (optind != argc - 1) {
2366 error_exit("Expecting one image file name");
2367 }
2368 if (!unsafe && !out_baseimg) {
2369 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
b8fb60da 2370 }
3e85c6fd
KW
2371 filename = argv[optind++];
2372
6b837bc4
JS
2373 qemu_progress_init(progress, 2.0);
2374 qemu_progress_print(0, 100);
2375
661a0f71 2376 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
c3993cdc 2377 ret = bdrv_parse_cache_flags(cache, &flags);
661a0f71
FS
2378 if (ret < 0) {
2379 error_report("Invalid cache option: %s", cache);
40ed35a3 2380 goto out;
661a0f71
FS
2381 }
2382
40055951
HR
2383 src_flags = BDRV_O_FLAGS;
2384 ret = bdrv_parse_cache_flags(src_cache, &src_flags);
2385 if (ret < 0) {
2386 error_report("Invalid source cache option: %s", src_cache);
40ed35a3 2387 goto out;
40055951
HR
2388 }
2389
3e85c6fd
KW
2390 /*
2391 * Open the images.
2392 *
2393 * Ignore the old backing file for unsafe rebase in case we want to correct
2394 * the reference to a renamed or moved backing file.
2395 */
9ffe3332 2396 bs = bdrv_new_open("image", filename, fmt, flags, true, quiet);
c2abccec 2397 if (!bs) {
40ed35a3
SH
2398 ret = -1;
2399 goto out;
c2abccec 2400 }
3e85c6fd
KW
2401
2402 /* Find the right drivers for the backing files */
2403 old_backing_drv = NULL;
2404 new_backing_drv = NULL;
2405
2406 if (!unsafe && bs->backing_format[0] != '\0') {
2407 old_backing_drv = bdrv_find_format(bs->backing_format);
2408 if (old_backing_drv == NULL) {
15654a6d 2409 error_report("Invalid format name: '%s'", bs->backing_format);
c2abccec
MK
2410 ret = -1;
2411 goto out;
3e85c6fd
KW
2412 }
2413 }
2414
2415 if (out_basefmt != NULL) {
2416 new_backing_drv = bdrv_find_format(out_basefmt);
2417 if (new_backing_drv == NULL) {
15654a6d 2418 error_report("Invalid format name: '%s'", out_basefmt);
c2abccec
MK
2419 ret = -1;
2420 goto out;
3e85c6fd
KW
2421 }
2422 }
2423
2424 /* For safe rebasing we need to compare old and new backing file */
40ed35a3 2425 if (!unsafe) {
3e85c6fd
KW
2426 char backing_name[1024];
2427
98522f63 2428 bs_old_backing = bdrv_new("old_backing", &error_abort);
3e85c6fd 2429 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
40055951 2430 ret = bdrv_open(&bs_old_backing, backing_name, NULL, NULL, src_flags,
34b5d2c6 2431 old_backing_drv, &local_err);
c2abccec 2432 if (ret) {
34b5d2c6
HR
2433 error_report("Could not open old backing file '%s': %s",
2434 backing_name, error_get_pretty(local_err));
2435 error_free(local_err);
c2abccec 2436 goto out;
3e85c6fd 2437 }
a616673d 2438 if (out_baseimg[0]) {
98522f63 2439 bs_new_backing = bdrv_new("new_backing", &error_abort);
40055951
HR
2440 ret = bdrv_open(&bs_new_backing, out_baseimg, NULL, NULL, src_flags,
2441 new_backing_drv, &local_err);
a616673d 2442 if (ret) {
34b5d2c6
HR
2443 error_report("Could not open new backing file '%s': %s",
2444 out_baseimg, error_get_pretty(local_err));
2445 error_free(local_err);
a616673d
AB
2446 goto out;
2447 }
3e85c6fd
KW
2448 }
2449 }
2450
2451 /*
2452 * Check each unallocated cluster in the COW file. If it is unallocated,
2453 * accesses go to the backing file. We must therefore compare this cluster
2454 * in the old and new backing file, and if they differ we need to copy it
2455 * from the old backing file into the COW file.
2456 *
2457 * If qemu-img crashes during this step, no harm is done. The content of
2458 * the image is the same as the original one at any time.
2459 */
2460 if (!unsafe) {
52bf1e72
MA
2461 int64_t num_sectors;
2462 int64_t old_backing_num_sectors;
2463 int64_t new_backing_num_sectors = 0;
3e85c6fd 2464 uint64_t sector;
cc60e327 2465 int n;
d6771bfa
T
2466 uint8_t * buf_old;
2467 uint8_t * buf_new;
1f710495 2468 float local_progress = 0;
d6771bfa 2469
bb1c0597
KW
2470 buf_old = qemu_blockalign(bs, IO_BUF_SIZE);
2471 buf_new = qemu_blockalign(bs, IO_BUF_SIZE);
3e85c6fd 2472
52bf1e72
MA
2473 num_sectors = bdrv_nb_sectors(bs);
2474 if (num_sectors < 0) {
2475 error_report("Could not get size of '%s': %s",
2476 filename, strerror(-num_sectors));
2477 ret = -1;
2478 goto out;
2479 }
2480 old_backing_num_sectors = bdrv_nb_sectors(bs_old_backing);
2481 if (old_backing_num_sectors < 0) {
2482 char backing_name[1024];
2483
2484 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2485 error_report("Could not get size of '%s': %s",
2486 backing_name, strerror(-old_backing_num_sectors));
2487 ret = -1;
2488 goto out;
2489 }
a616673d 2490 if (bs_new_backing) {
52bf1e72
MA
2491 new_backing_num_sectors = bdrv_nb_sectors(bs_new_backing);
2492 if (new_backing_num_sectors < 0) {
2493 error_report("Could not get size of '%s': %s",
2494 out_baseimg, strerror(-new_backing_num_sectors));
2495 ret = -1;
2496 goto out;
2497 }
a616673d 2498 }
3e85c6fd 2499
1f710495
KW
2500 if (num_sectors != 0) {
2501 local_progress = (float)100 /
2502 (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
2503 }
2504
3e85c6fd
KW
2505 for (sector = 0; sector < num_sectors; sector += n) {
2506
2507 /* How many sectors can we handle with the next read? */
2508 if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
2509 n = (IO_BUF_SIZE / 512);
2510 } else {
2511 n = num_sectors - sector;
2512 }
2513
2514 /* If the cluster is allocated, we don't need to take action */
cc60e327 2515 ret = bdrv_is_allocated(bs, sector, n, &n);
d663640c
PB
2516 if (ret < 0) {
2517 error_report("error while reading image metadata: %s",
2518 strerror(-ret));
2519 goto out;
2520 }
cc60e327 2521 if (ret) {
3e85c6fd
KW
2522 continue;
2523 }
2524
87a1b3e3
KW
2525 /*
2526 * Read old and new backing file and take into consideration that
2527 * backing files may be smaller than the COW image.
2528 */
2529 if (sector >= old_backing_num_sectors) {
2530 memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
2531 } else {
2532 if (sector + n > old_backing_num_sectors) {
2533 n = old_backing_num_sectors - sector;
2534 }
2535
2536 ret = bdrv_read(bs_old_backing, sector, buf_old, n);
2537 if (ret < 0) {
2538 error_report("error while reading from old backing file");
2539 goto out;
2540 }
3e85c6fd 2541 }
87a1b3e3 2542
a616673d 2543 if (sector >= new_backing_num_sectors || !bs_new_backing) {
87a1b3e3
KW
2544 memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
2545 } else {
2546 if (sector + n > new_backing_num_sectors) {
2547 n = new_backing_num_sectors - sector;
2548 }
2549
2550 ret = bdrv_read(bs_new_backing, sector, buf_new, n);
2551 if (ret < 0) {
2552 error_report("error while reading from new backing file");
2553 goto out;
2554 }
3e85c6fd
KW
2555 }
2556
2557 /* If they differ, we need to write to the COW file */
2558 uint64_t written = 0;
2559
2560 while (written < n) {
2561 int pnum;
2562
2563 if (compare_sectors(buf_old + written * 512,
60b1bd4f 2564 buf_new + written * 512, n - written, &pnum))
3e85c6fd
KW
2565 {
2566 ret = bdrv_write(bs, sector + written,
2567 buf_old + written * 512, pnum);
2568 if (ret < 0) {
15654a6d 2569 error_report("Error while writing to COW image: %s",
3e85c6fd 2570 strerror(-ret));
c2abccec 2571 goto out;
3e85c6fd
KW
2572 }
2573 }
2574
2575 written += pnum;
2576 }
6b837bc4 2577 qemu_progress_print(local_progress, 100);
3e85c6fd 2578 }
d6771bfa 2579
bb1c0597
KW
2580 qemu_vfree(buf_old);
2581 qemu_vfree(buf_new);
3e85c6fd
KW
2582 }
2583
2584 /*
2585 * Change the backing file. All clusters that are different from the old
2586 * backing file are overwritten in the COW file now, so the visible content
2587 * doesn't change when we switch the backing file.
2588 */
a616673d
AB
2589 if (out_baseimg && *out_baseimg) {
2590 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
2591 } else {
2592 ret = bdrv_change_backing_file(bs, NULL, NULL);
2593 }
2594
3e85c6fd 2595 if (ret == -ENOSPC) {
15654a6d
JS
2596 error_report("Could not change the backing file to '%s': No "
2597 "space left in the file header", out_baseimg);
3e85c6fd 2598 } else if (ret < 0) {
15654a6d 2599 error_report("Could not change the backing file to '%s': %s",
3e85c6fd
KW
2600 out_baseimg, strerror(-ret));
2601 }
2602
6b837bc4 2603 qemu_progress_print(100, 0);
3e85c6fd
KW
2604 /*
2605 * TODO At this point it is possible to check if any clusters that are
2606 * allocated in the COW file are the same in the backing file. If so, they
2607 * could be dropped from the COW file. Don't do this before switching the
2608 * backing file, in case of a crash this would lead to corruption.
2609 */
c2abccec 2610out:
6b837bc4 2611 qemu_progress_end();
3e85c6fd
KW
2612 /* Cleanup */
2613 if (!unsafe) {
eb863add 2614 if (bs_old_backing != NULL) {
4f6fd349 2615 bdrv_unref(bs_old_backing);
eb863add
KW
2616 }
2617 if (bs_new_backing != NULL) {
4f6fd349 2618 bdrv_unref(bs_new_backing);
eb863add 2619 }
3e85c6fd
KW
2620 }
2621
4f6fd349 2622 bdrv_unref(bs);
c2abccec
MK
2623 if (ret) {
2624 return 1;
2625 }
3e85c6fd
KW
2626 return 0;
2627}
2628
ae6b0ed6
SH
2629static int img_resize(int argc, char **argv)
2630{
2631 int c, ret, relative;
2632 const char *filename, *fmt, *size;
2633 int64_t n, total_size;
f382d43a 2634 bool quiet = false;
2a81998a 2635 BlockDriverState *bs = NULL;
20caf0f7
DXW
2636 QemuOpts *param;
2637 static QemuOptsList resize_options = {
2638 .name = "resize_options",
2639 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
2640 .desc = {
2641 {
2642 .name = BLOCK_OPT_SIZE,
2643 .type = QEMU_OPT_SIZE,
2644 .help = "Virtual disk size"
2645 }, {
2646 /* end of list */
2647 }
ae6b0ed6 2648 },
ae6b0ed6
SH
2649 };
2650
e80fec7f
KW
2651 /* Remove size from argv manually so that negative numbers are not treated
2652 * as options by getopt. */
2653 if (argc < 3) {
ac1307ab 2654 error_exit("Not enough arguments");
e80fec7f
KW
2655 return 1;
2656 }
2657
2658 size = argv[--argc];
2659
2660 /* Parse getopt arguments */
ae6b0ed6
SH
2661 fmt = NULL;
2662 for(;;) {
f382d43a 2663 c = getopt(argc, argv, "f:hq");
ae6b0ed6
SH
2664 if (c == -1) {
2665 break;
2666 }
2667 switch(c) {
ef87394c 2668 case '?':
ae6b0ed6
SH
2669 case 'h':
2670 help();
2671 break;
2672 case 'f':
2673 fmt = optarg;
2674 break;
f382d43a
MR
2675 case 'q':
2676 quiet = true;
2677 break;
ae6b0ed6
SH
2678 }
2679 }
fc11eb26 2680 if (optind != argc - 1) {
ac1307ab 2681 error_exit("Expecting one image file name");
ae6b0ed6
SH
2682 }
2683 filename = argv[optind++];
ae6b0ed6
SH
2684
2685 /* Choose grow, shrink, or absolute resize mode */
2686 switch (size[0]) {
2687 case '+':
2688 relative = 1;
2689 size++;
2690 break;
2691 case '-':
2692 relative = -1;
2693 size++;
2694 break;
2695 default:
2696 relative = 0;
2697 break;
2698 }
2699
2700 /* Parse size */
87ea75d5 2701 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
20caf0f7 2702 if (qemu_opt_set(param, BLOCK_OPT_SIZE, size)) {
ae6b0ed6 2703 /* Error message already printed when size parsing fails */
2a81998a 2704 ret = -1;
20caf0f7 2705 qemu_opts_del(param);
2a81998a 2706 goto out;
ae6b0ed6 2707 }
20caf0f7
DXW
2708 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
2709 qemu_opts_del(param);
ae6b0ed6 2710
9ffe3332
KW
2711 bs = bdrv_new_open("image", filename, fmt, BDRV_O_FLAGS | BDRV_O_RDWR,
2712 true, quiet);
c2abccec 2713 if (!bs) {
2a81998a
JS
2714 ret = -1;
2715 goto out;
c2abccec 2716 }
ae6b0ed6
SH
2717
2718 if (relative) {
2719 total_size = bdrv_getlength(bs) + n * relative;
2720 } else {
2721 total_size = n;
2722 }
2723 if (total_size <= 0) {
15654a6d 2724 error_report("New image size must be positive");
c2abccec
MK
2725 ret = -1;
2726 goto out;
ae6b0ed6
SH
2727 }
2728
2729 ret = bdrv_truncate(bs, total_size);
2730 switch (ret) {
2731 case 0:
f382d43a 2732 qprintf(quiet, "Image resized.\n");
ae6b0ed6
SH
2733 break;
2734 case -ENOTSUP:
259b2173 2735 error_report("This image does not support resize");
ae6b0ed6
SH
2736 break;
2737 case -EACCES:
15654a6d 2738 error_report("Image is read-only");
ae6b0ed6
SH
2739 break;
2740 default:
15654a6d 2741 error_report("Error resizing image (%d)", -ret);
ae6b0ed6
SH
2742 break;
2743 }
c2abccec 2744out:
2a81998a 2745 if (bs) {
4f6fd349 2746 bdrv_unref(bs);
2a81998a 2747 }
c2abccec
MK
2748 if (ret) {
2749 return 1;
2750 }
ae6b0ed6
SH
2751 return 0;
2752}
2753
6f176b48
HR
2754static int img_amend(int argc, char **argv)
2755{
2756 int c, ret = 0;
2757 char *options = NULL;
83d0521a
CL
2758 QemuOptsList *create_opts = NULL;
2759 QemuOpts *opts = NULL;
bd39e6ed
HR
2760 const char *fmt = NULL, *filename, *cache;
2761 int flags;
6f176b48
HR
2762 bool quiet = false;
2763 BlockDriverState *bs = NULL;
2764
bd39e6ed 2765 cache = BDRV_DEFAULT_CACHE;
6f176b48 2766 for (;;) {
bd39e6ed 2767 c = getopt(argc, argv, "ho:f:t:q");
6f176b48
HR
2768 if (c == -1) {
2769 break;
2770 }
2771
2772 switch (c) {
2773 case 'h':
2774 case '?':
2775 help();
2776 break;
2777 case 'o':
626f84f3
KW
2778 if (!is_valid_option_list(optarg)) {
2779 error_report("Invalid option list: %s", optarg);
2780 ret = -1;
2781 goto out;
2782 }
2783 if (!options) {
2784 options = g_strdup(optarg);
2785 } else {
2786 char *old_options = options;
2787 options = g_strdup_printf("%s,%s", options, optarg);
2788 g_free(old_options);
2789 }
6f176b48
HR
2790 break;
2791 case 'f':
2792 fmt = optarg;
2793 break;
bd39e6ed
HR
2794 case 't':
2795 cache = optarg;
2796 break;
6f176b48
HR
2797 case 'q':
2798 quiet = true;
2799 break;
2800 }
2801 }
2802
a283cb6e 2803 if (!options) {
ac1307ab 2804 error_exit("Must specify options (-o)");
6f176b48
HR
2805 }
2806
a283cb6e
KW
2807 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
2808 if (fmt && has_help_option(options)) {
2809 /* If a format is explicitly specified (and possibly no filename is
2810 * given), print option help here */
2811 ret = print_block_option_help(filename, fmt);
2812 goto out;
6f176b48
HR
2813 }
2814
a283cb6e 2815 if (optind != argc - 1) {
ac1307ab 2816 error_exit("Expecting one image file name");
a283cb6e 2817 }
6f176b48 2818
bd39e6ed
HR
2819 flags = BDRV_O_FLAGS | BDRV_O_RDWR;
2820 ret = bdrv_parse_cache_flags(cache, &flags);
2821 if (ret < 0) {
2822 error_report("Invalid cache option: %s", cache);
2823 goto out;
2824 }
2825
2826 bs = bdrv_new_open("image", filename, fmt, flags, true, quiet);
6f176b48
HR
2827 if (!bs) {
2828 error_report("Could not open image '%s'", filename);
2829 ret = -1;
2830 goto out;
2831 }
2832
2833 fmt = bs->drv->format_name;
2834
626f84f3 2835 if (has_help_option(options)) {
a283cb6e 2836 /* If the format was auto-detected, print option help here */
6f176b48
HR
2837 ret = print_block_option_help(filename, fmt);
2838 goto out;
2839 }
2840
c282e1fd 2841 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
83d0521a
CL
2842 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2843 if (options && qemu_opts_do_parse(opts, options, NULL)) {
6f176b48
HR
2844 error_report("Invalid options for file format '%s'", fmt);
2845 ret = -1;
2846 goto out;
2847 }
2848
c282e1fd 2849 ret = bdrv_amend_options(bs, opts);
6f176b48
HR
2850 if (ret < 0) {
2851 error_report("Error while amending options: %s", strerror(-ret));
2852 goto out;
2853 }
2854
2855out:
2856 if (bs) {
2857 bdrv_unref(bs);
2858 }
83d0521a
CL
2859 qemu_opts_del(opts);
2860 qemu_opts_free(create_opts);
626f84f3
KW
2861 g_free(options);
2862
6f176b48
HR
2863 if (ret) {
2864 return 1;
2865 }
2866 return 0;
2867}
2868
c227f099 2869static const img_cmd_t img_cmds[] = {
153859be
SB
2870#define DEF(option, callback, arg_string) \
2871 { option, callback },
2872#include "qemu-img-cmds.h"
2873#undef DEF
2874#undef GEN_DOCS
2875 { NULL, NULL, },
2876};
2877
ea2384d3
FB
2878int main(int argc, char **argv)
2879{
c227f099 2880 const img_cmd_t *cmd;
153859be 2881 const char *cmdname;
2f78e491 2882 Error *local_error = NULL;
7db1689c 2883 int c;
7db1689c
JC
2884 static const struct option long_options[] = {
2885 {"help", no_argument, 0, 'h'},
5f6979cb 2886 {"version", no_argument, 0, 'v'},
7db1689c
JC
2887 {0, 0, 0, 0}
2888 };
ea2384d3 2889
526eda14
MK
2890#ifdef CONFIG_POSIX
2891 signal(SIGPIPE, SIG_IGN);
2892#endif
2893
53f76e58 2894 error_set_progname(argv[0]);
10f5bff6 2895 qemu_init_exec_dir(argv[0]);
53f76e58 2896
2f78e491
CN
2897 if (qemu_init_main_loop(&local_error)) {
2898 error_report("%s", error_get_pretty(local_error));
2899 error_free(local_error);
2900 exit(EXIT_FAILURE);
2901 }
2902
ea2384d3 2903 bdrv_init();
ac1307ab
FZ
2904 if (argc < 2) {
2905 error_exit("Not enough arguments");
2906 }
153859be 2907 cmdname = argv[1];
153859be
SB
2908
2909 /* find the command */
5f6979cb 2910 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
153859be 2911 if (!strcmp(cmdname, cmd->name)) {
7db1689c 2912 return cmd->handler(argc - 1, argv + 1);
153859be 2913 }
ea2384d3 2914 }
153859be 2915
5f6979cb 2916 c = getopt_long(argc, argv, "h", long_options, NULL);
7db1689c
JC
2917
2918 if (c == 'h') {
2919 help();
2920 }
5f6979cb
JC
2921 if (c == 'v') {
2922 printf(QEMU_IMG_VERSION);
2923 return 0;
2924 }
7db1689c 2925
153859be 2926 /* not found */
ac1307ab 2927 error_exit("Command not found: %s", cmdname);
ea2384d3 2928}