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