]> git.proxmox.com Git - mirror_qemu.git/blame - qemu-img.c
error: Use error_report_err() where appropriate
[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
61979a6a 38#define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
5f6979cb
JC
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 761 int c, ret, flags;
1b22bffd 762 const char *filename, *fmt, *cache, *base;
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;
1b22bffd 771 base = NULL;
ea2384d3 772 for(;;) {
1b22bffd 773 c = getopt(argc, argv, "f:ht:b:dpq");
b8fb60da 774 if (c == -1) {
ea2384d3 775 break;
b8fb60da 776 }
ea2384d3 777 switch(c) {
ef87394c 778 case '?':
ea2384d3
FB
779 case 'h':
780 help();
781 break;
782 case 'f':
783 fmt = optarg;
784 break;
661a0f71
FS
785 case 't':
786 cache = optarg;
787 break;
1b22bffd
HR
788 case 'b':
789 base = optarg;
790 /* -b implies -d */
791 drop = true;
792 break;
9a86fe48
HR
793 case 'd':
794 drop = true;
795 break;
687fa1d8
HR
796 case 'p':
797 progress = true;
798 break;
f382d43a
MR
799 case 'q':
800 quiet = true;
801 break;
ea2384d3
FB
802 }
803 }
687fa1d8
HR
804
805 /* Progress is not shown in Quiet mode */
806 if (quiet) {
807 progress = false;
808 }
809
fc11eb26 810 if (optind != argc - 1) {
ac1307ab 811 error_exit("Expecting one image file name");
b8fb60da 812 }
ea2384d3
FB
813 filename = argv[optind++];
814
9a86fe48 815 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
c3993cdc 816 ret = bdrv_parse_cache_flags(cache, &flags);
661a0f71
FS
817 if (ret < 0) {
818 error_report("Invalid cache option: %s", cache);
a3981eb9 819 return 1;
661a0f71
FS
820 }
821
7e7d56d9
MA
822 blk = img_open("image", filename, fmt, flags, true, quiet);
823 if (!blk) {
824 return 1;
c2abccec 825 }
7e7d56d9
MA
826 bs = blk_bs(blk);
827
687fa1d8
HR
828 qemu_progress_init(progress, 1.f);
829 qemu_progress_print(0.f, 100);
830
1b22bffd
HR
831 if (base) {
832 base_bs = bdrv_find_backing_image(bs, base);
833 if (!base_bs) {
834 error_set(&local_err, QERR_BASE_NOT_FOUND, base);
835 goto done;
836 }
837 } else {
838 /* This is different from QMP, which by default uses the deepest file in
839 * the backing chain (i.e., the very base); however, the traditional
840 * behavior of qemu-img commit is using the immediate backing file. */
841 base_bs = bs->backing_hd;
842 if (!base_bs) {
843 error_setg(&local_err, "Image does not have a backing file");
844 goto done;
845 }
d4a3238a
HR
846 }
847
848 cbi = (CommonBlockJobCBInfo){
849 .errp = &local_err,
850 .bs = bs,
851 };
852
853 commit_active_start(bs, base_bs, 0, BLOCKDEV_ON_ERROR_REPORT,
854 common_block_job_cb, &cbi, &local_err);
855 if (local_err) {
856 goto done;
ea2384d3
FB
857 }
858
9a86fe48
HR
859 /* The block job will swap base_bs and bs (which is not what we really want
860 * here, but okay) and unref base_bs (after the swap, i.e., the old top
861 * image). In order to still be able to empty that top image afterwards,
862 * increment the reference counter here preemptively. */
863 if (!drop) {
864 bdrv_ref(base_bs);
865 }
866
d4a3238a 867 run_block_job(bs->job, &local_err);
9a86fe48
HR
868 if (local_err) {
869 goto unref_backing;
870 }
871
872 if (!drop && base_bs->drv->bdrv_make_empty) {
873 ret = base_bs->drv->bdrv_make_empty(base_bs);
874 if (ret) {
875 error_setg_errno(&local_err, -ret, "Could not empty %s",
876 filename);
877 goto unref_backing;
878 }
879 }
880
881unref_backing:
882 if (!drop) {
883 bdrv_unref(base_bs);
884 }
d4a3238a
HR
885
886done:
687fa1d8
HR
887 qemu_progress_end();
888
26f54e9a 889 blk_unref(blk);
d4a3238a
HR
890
891 if (local_err) {
892 qerror_report_err(local_err);
893 error_free(local_err);
c2abccec
MK
894 return 1;
895 }
d4a3238a
HR
896
897 qprintf(quiet, "Image committed.\n");
ea2384d3
FB
898 return 0;
899}
900
f58c7b35
TS
901/*
902 * Returns true iff the first sector pointed to by 'buf' contains at least
903 * a non-NUL byte.
904 *
905 * 'pnum' is set to the number of sectors (including and immediately following
906 * the first one) that are known to be in the same allocated/unallocated state.
907 */
ea2384d3
FB
908static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
909{
1a6d39fd
SH
910 bool is_zero;
911 int i;
ea2384d3
FB
912
913 if (n <= 0) {
914 *pnum = 0;
915 return 0;
916 }
1a6d39fd 917 is_zero = buffer_is_zero(buf, 512);
ea2384d3
FB
918 for(i = 1; i < n; i++) {
919 buf += 512;
1a6d39fd 920 if (is_zero != buffer_is_zero(buf, 512)) {
ea2384d3 921 break;
1a6d39fd 922 }
ea2384d3
FB
923 }
924 *pnum = i;
1a6d39fd 925 return !is_zero;
ea2384d3
FB
926}
927
a22f123c
KW
928/*
929 * Like is_allocated_sectors, but if the buffer starts with a used sector,
930 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
931 * breaking up write requests for only small sparse areas.
932 */
933static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
934 int min)
935{
936 int ret;
937 int num_checked, num_used;
938
939 if (n < min) {
940 min = n;
941 }
942
943 ret = is_allocated_sectors(buf, n, pnum);
944 if (!ret) {
945 return ret;
946 }
947
948 num_used = *pnum;
949 buf += BDRV_SECTOR_SIZE * *pnum;
950 n -= *pnum;
951 num_checked = num_used;
952
953 while (n > 0) {
954 ret = is_allocated_sectors(buf, n, pnum);
955
956 buf += BDRV_SECTOR_SIZE * *pnum;
957 n -= *pnum;
958 num_checked += *pnum;
959 if (ret) {
960 num_used = num_checked;
961 } else if (*pnum >= min) {
962 break;
963 }
964 }
965
966 *pnum = num_used;
967 return 1;
968}
969
3e85c6fd
KW
970/*
971 * Compares two buffers sector by sector. Returns 0 if the first sector of both
972 * buffers matches, non-zero otherwise.
973 *
974 * pnum is set to the number of sectors (including and immediately following
975 * the first one) that are known to have the same comparison result
976 */
977static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
978 int *pnum)
979{
980 int res, i;
981
982 if (n <= 0) {
983 *pnum = 0;
984 return 0;
985 }
986
987 res = !!memcmp(buf1, buf2, 512);
988 for(i = 1; i < n; i++) {
989 buf1 += 512;
990 buf2 += 512;
991
992 if (!!memcmp(buf1, buf2, 512) != res) {
993 break;
994 }
995 }
996
997 *pnum = i;
998 return res;
999}
1000
80ee15a6 1001#define IO_BUF_SIZE (2 * 1024 * 1024)
ea2384d3 1002
d14ed18c
MR
1003static int64_t sectors_to_bytes(int64_t sectors)
1004{
1005 return sectors << BDRV_SECTOR_BITS;
1006}
1007
1008static int64_t sectors_to_process(int64_t total, int64_t from)
1009{
1010 return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
1011}
1012
1013/*
1014 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1015 *
1016 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1017 * data and negative value on error.
1018 *
1019 * @param bs: Driver used for accessing file
1020 * @param sect_num: Number of first sector to check
1021 * @param sect_count: Number of sectors to check
1022 * @param filename: Name of disk file we are checking (logging purpose)
1023 * @param buffer: Allocated buffer for storing read data
1024 * @param quiet: Flag for quiet mode
1025 */
1026static int check_empty_sectors(BlockDriverState *bs, int64_t sect_num,
1027 int sect_count, const char *filename,
1028 uint8_t *buffer, bool quiet)
1029{
1030 int pnum, ret = 0;
1031 ret = bdrv_read(bs, sect_num, buffer, sect_count);
1032 if (ret < 0) {
1033 error_report("Error while reading offset %" PRId64 " of %s: %s",
1034 sectors_to_bytes(sect_num), filename, strerror(-ret));
1035 return ret;
1036 }
1037 ret = is_allocated_sectors(buffer, sect_count, &pnum);
1038 if (ret || pnum != sect_count) {
1039 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1040 sectors_to_bytes(ret ? sect_num : sect_num + pnum));
1041 return 1;
1042 }
1043
1044 return 0;
1045}
1046
1047/*
1048 * Compares two images. Exit codes:
1049 *
1050 * 0 - Images are identical
1051 * 1 - Images differ
1052 * >1 - Error occurred
1053 */
1054static int img_compare(int argc, char **argv)
1055{
40055951 1056 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
26f54e9a 1057 BlockBackend *blk1, *blk2;
d14ed18c
MR
1058 BlockDriverState *bs1, *bs2;
1059 int64_t total_sectors1, total_sectors2;
1060 uint8_t *buf1 = NULL, *buf2 = NULL;
1061 int pnum1, pnum2;
1062 int allocated1, allocated2;
1063 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1064 bool progress = false, quiet = false, strict = false;
40055951 1065 int flags;
d14ed18c
MR
1066 int64_t total_sectors;
1067 int64_t sector_num = 0;
1068 int64_t nb_sectors;
1069 int c, pnum;
d14ed18c
MR
1070 uint64_t progress_base;
1071
40055951 1072 cache = BDRV_DEFAULT_CACHE;
d14ed18c 1073 for (;;) {
40055951 1074 c = getopt(argc, argv, "hf:F:T:pqs");
d14ed18c
MR
1075 if (c == -1) {
1076 break;
1077 }
1078 switch (c) {
1079 case '?':
1080 case 'h':
1081 help();
1082 break;
1083 case 'f':
1084 fmt1 = optarg;
1085 break;
1086 case 'F':
1087 fmt2 = optarg;
1088 break;
40055951
HR
1089 case 'T':
1090 cache = optarg;
1091 break;
d14ed18c
MR
1092 case 'p':
1093 progress = true;
1094 break;
1095 case 'q':
1096 quiet = true;
1097 break;
1098 case 's':
1099 strict = true;
1100 break;
1101 }
1102 }
1103
1104 /* Progress is not shown in Quiet mode */
1105 if (quiet) {
1106 progress = false;
1107 }
1108
1109
fc11eb26 1110 if (optind != argc - 2) {
ac1307ab 1111 error_exit("Expecting two image file names");
d14ed18c
MR
1112 }
1113 filename1 = argv[optind++];
1114 filename2 = argv[optind++];
1115
cbda016d
SH
1116 /* Initialize before goto out */
1117 qemu_progress_init(progress, 2.0);
1118
40055951
HR
1119 flags = BDRV_O_FLAGS;
1120 ret = bdrv_parse_cache_flags(cache, &flags);
1121 if (ret < 0) {
1122 error_report("Invalid source cache option: %s", cache);
1123 ret = 2;
1124 goto out3;
1125 }
1126
7e7d56d9
MA
1127 blk1 = img_open("image_1", filename1, fmt1, flags, true, quiet);
1128 if (!blk1) {
d14ed18c 1129 ret = 2;
7e7d56d9 1130 goto out3;
d14ed18c 1131 }
7e7d56d9 1132 bs1 = blk_bs(blk1);
d14ed18c 1133
7e7d56d9
MA
1134 blk2 = img_open("image_2", filename2, fmt2, flags, true, quiet);
1135 if (!blk2) {
d14ed18c 1136 ret = 2;
7e7d56d9 1137 goto out2;
d14ed18c 1138 }
7e7d56d9 1139 bs2 = blk_bs(blk2);
d14ed18c
MR
1140
1141 buf1 = qemu_blockalign(bs1, IO_BUF_SIZE);
1142 buf2 = qemu_blockalign(bs2, IO_BUF_SIZE);
52bf1e72
MA
1143 total_sectors1 = bdrv_nb_sectors(bs1);
1144 if (total_sectors1 < 0) {
1145 error_report("Can't get size of %s: %s",
1146 filename1, strerror(-total_sectors1));
1147 ret = 4;
1148 goto out;
1149 }
1150 total_sectors2 = bdrv_nb_sectors(bs2);
1151 if (total_sectors2 < 0) {
1152 error_report("Can't get size of %s: %s",
1153 filename2, strerror(-total_sectors2));
1154 ret = 4;
1155 goto out;
1156 }
d14ed18c
MR
1157 total_sectors = MIN(total_sectors1, total_sectors2);
1158 progress_base = MAX(total_sectors1, total_sectors2);
1159
1160 qemu_progress_print(0, 100);
1161
1162 if (strict && total_sectors1 != total_sectors2) {
1163 ret = 1;
1164 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1165 goto out;
1166 }
1167
1168 for (;;) {
1169 nb_sectors = sectors_to_process(total_sectors, sector_num);
1170 if (nb_sectors <= 0) {
1171 break;
1172 }
1173 allocated1 = bdrv_is_allocated_above(bs1, NULL, sector_num, nb_sectors,
1174 &pnum1);
1175 if (allocated1 < 0) {
1176 ret = 3;
1177 error_report("Sector allocation test failed for %s", filename1);
1178 goto out;
1179 }
1180
1181 allocated2 = bdrv_is_allocated_above(bs2, NULL, sector_num, nb_sectors,
1182 &pnum2);
1183 if (allocated2 < 0) {
1184 ret = 3;
1185 error_report("Sector allocation test failed for %s", filename2);
1186 goto out;
1187 }
1188 nb_sectors = MIN(pnum1, pnum2);
1189
1190 if (allocated1 == allocated2) {
1191 if (allocated1) {
1192 ret = bdrv_read(bs1, sector_num, buf1, nb_sectors);
1193 if (ret < 0) {
1194 error_report("Error while reading offset %" PRId64 " of %s:"
1195 " %s", sectors_to_bytes(sector_num), filename1,
1196 strerror(-ret));
1197 ret = 4;
1198 goto out;
1199 }
1200 ret = bdrv_read(bs2, sector_num, buf2, nb_sectors);
1201 if (ret < 0) {
1202 error_report("Error while reading offset %" PRId64
1203 " of %s: %s", sectors_to_bytes(sector_num),
1204 filename2, strerror(-ret));
1205 ret = 4;
1206 goto out;
1207 }
1208 ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
1209 if (ret || pnum != nb_sectors) {
d14ed18c
MR
1210 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1211 sectors_to_bytes(
1212 ret ? sector_num : sector_num + pnum));
36452f12 1213 ret = 1;
d14ed18c
MR
1214 goto out;
1215 }
1216 }
1217 } else {
1218 if (strict) {
1219 ret = 1;
1220 qprintf(quiet, "Strict mode: Offset %" PRId64
1221 " allocation mismatch!\n",
1222 sectors_to_bytes(sector_num));
1223 goto out;
1224 }
1225
1226 if (allocated1) {
1227 ret = check_empty_sectors(bs1, sector_num, nb_sectors,
1228 filename1, buf1, quiet);
1229 } else {
1230 ret = check_empty_sectors(bs2, sector_num, nb_sectors,
1231 filename2, buf1, quiet);
1232 }
1233 if (ret) {
1234 if (ret < 0) {
d14ed18c
MR
1235 error_report("Error while reading offset %" PRId64 ": %s",
1236 sectors_to_bytes(sector_num), strerror(-ret));
36452f12 1237 ret = 4;
d14ed18c
MR
1238 }
1239 goto out;
1240 }
1241 }
1242 sector_num += nb_sectors;
1243 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1244 }
1245
1246 if (total_sectors1 != total_sectors2) {
1247 BlockDriverState *bs_over;
1248 int64_t total_sectors_over;
1249 const char *filename_over;
1250
1251 qprintf(quiet, "Warning: Image size mismatch!\n");
1252 if (total_sectors1 > total_sectors2) {
1253 total_sectors_over = total_sectors1;
1254 bs_over = bs1;
1255 filename_over = filename1;
1256 } else {
1257 total_sectors_over = total_sectors2;
1258 bs_over = bs2;
1259 filename_over = filename2;
1260 }
1261
1262 for (;;) {
1263 nb_sectors = sectors_to_process(total_sectors_over, sector_num);
1264 if (nb_sectors <= 0) {
1265 break;
1266 }
1267 ret = bdrv_is_allocated_above(bs_over, NULL, sector_num,
1268 nb_sectors, &pnum);
1269 if (ret < 0) {
1270 ret = 3;
1271 error_report("Sector allocation test failed for %s",
1272 filename_over);
1273 goto out;
1274
1275 }
1276 nb_sectors = pnum;
1277 if (ret) {
1278 ret = check_empty_sectors(bs_over, sector_num, nb_sectors,
1279 filename_over, buf1, quiet);
1280 if (ret) {
1281 if (ret < 0) {
d14ed18c
MR
1282 error_report("Error while reading offset %" PRId64
1283 " of %s: %s", sectors_to_bytes(sector_num),
1284 filename_over, strerror(-ret));
36452f12 1285 ret = 4;
d14ed18c
MR
1286 }
1287 goto out;
1288 }
1289 }
1290 sector_num += nb_sectors;
1291 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1292 }
1293 }
1294
1295 qprintf(quiet, "Images are identical.\n");
1296 ret = 0;
1297
1298out:
d14ed18c
MR
1299 qemu_vfree(buf1);
1300 qemu_vfree(buf2);
26f54e9a 1301 blk_unref(blk2);
d14ed18c 1302out2:
26f54e9a 1303 blk_unref(blk1);
d14ed18c
MR
1304out3:
1305 qemu_progress_end();
1306 return ret;
1307}
1308
ea2384d3
FB
1309static int img_convert(int argc, char **argv)
1310{
24f833cd 1311 int c, n, n1, bs_n, bs_i, compress, cluster_sectors, skip_create;
13c28af8 1312 int64_t ret = 0;
40055951
HR
1313 int progress = 0, flags, src_flags;
1314 const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
b50cbabc 1315 BlockDriver *drv, *proto_drv;
26f54e9a 1316 BlockBackend **blk = NULL, *out_blk = NULL;
c2abccec 1317 BlockDriverState **bs = NULL, *out_bs = NULL;
802c3d4c 1318 int64_t total_sectors, nb_sectors, sector_num, bs_offset;
52bf1e72 1319 int64_t *bs_sectors = NULL;
c2abccec 1320 uint8_t * buf = NULL;
f2521c90 1321 size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
ea2384d3 1322 const uint8_t *buf1;
faea38e7 1323 BlockDriverInfo bdi;
83d0521a
CL
1324 QemuOpts *opts = NULL;
1325 QemuOptsList *create_opts = NULL;
1326 const char *out_baseimg_param;
efa84d43 1327 char *options = NULL;
51ef6727 1328 const char *snapshot_name = NULL;
a22f123c 1329 int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
f382d43a 1330 bool quiet = false;
cc84d90f 1331 Error *local_err = NULL;
ef80654d 1332 QemuOpts *sn_opts = NULL;
ea2384d3
FB
1333
1334 fmt = NULL;
1335 out_fmt = "raw";
661a0f71 1336 cache = "unsafe";
40055951 1337 src_cache = BDRV_DEFAULT_CACHE;
f58c7b35 1338 out_baseimg = NULL;
eec77d9e 1339 compress = 0;
b2e10493 1340 skip_create = 0;
ea2384d3 1341 for(;;) {
40055951 1342 c = getopt(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qn");
b8fb60da 1343 if (c == -1) {
ea2384d3 1344 break;
b8fb60da 1345 }
ea2384d3 1346 switch(c) {
ef87394c 1347 case '?':
ea2384d3
FB
1348 case 'h':
1349 help();
1350 break;
1351 case 'f':
1352 fmt = optarg;
1353 break;
1354 case 'O':
1355 out_fmt = optarg;
1356 break;
f58c7b35
TS
1357 case 'B':
1358 out_baseimg = optarg;
1359 break;
ea2384d3 1360 case 'c':
eec77d9e 1361 compress = 1;
ea2384d3
FB
1362 break;
1363 case 'e':
9d42e15d 1364 error_report("option -e is deprecated, please use \'-o "
eec77d9e 1365 "encryption\' instead!");
2dc8328b 1366 ret = -1;
64bb01aa 1367 goto fail_getopt;
ec36ba14 1368 case '6':
9d42e15d 1369 error_report("option -6 is deprecated, please use \'-o "
eec77d9e 1370 "compat6\' instead!");
2dc8328b 1371 ret = -1;
64bb01aa 1372 goto fail_getopt;
efa84d43 1373 case 'o':
2dc8328b
KW
1374 if (!is_valid_option_list(optarg)) {
1375 error_report("Invalid option list: %s", optarg);
1376 ret = -1;
64bb01aa 1377 goto fail_getopt;
2dc8328b
KW
1378 }
1379 if (!options) {
1380 options = g_strdup(optarg);
1381 } else {
1382 char *old_options = options;
1383 options = g_strdup_printf("%s,%s", options, optarg);
1384 g_free(old_options);
1385 }
efa84d43 1386 break;
51ef6727 1387 case 's':
1388 snapshot_name = optarg;
1389 break;
ef80654d
WX
1390 case 'l':
1391 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
1392 sn_opts = qemu_opts_parse(&internal_snapshot_opts, optarg, 0);
1393 if (!sn_opts) {
1394 error_report("Failed in parsing snapshot param '%s'",
1395 optarg);
2dc8328b 1396 ret = -1;
64bb01aa 1397 goto fail_getopt;
ef80654d
WX
1398 }
1399 } else {
1400 snapshot_name = optarg;
1401 }
1402 break;
a22f123c
KW
1403 case 'S':
1404 {
1405 int64_t sval;
e36b3695
MA
1406 char *end;
1407 sval = strtosz_suffix(optarg, &end, STRTOSZ_DEFSUFFIX_B);
1408 if (sval < 0 || *end) {
a22f123c 1409 error_report("Invalid minimum zero buffer size for sparse output specified");
2dc8328b 1410 ret = -1;
64bb01aa 1411 goto fail_getopt;
a22f123c
KW
1412 }
1413
1414 min_sparse = sval / BDRV_SECTOR_SIZE;
1415 break;
1416 }
6b837bc4
JS
1417 case 'p':
1418 progress = 1;
1419 break;
661a0f71
FS
1420 case 't':
1421 cache = optarg;
1422 break;
40055951
HR
1423 case 'T':
1424 src_cache = optarg;
1425 break;
f382d43a
MR
1426 case 'q':
1427 quiet = true;
1428 break;
b2e10493
AD
1429 case 'n':
1430 skip_create = 1;
1431 break;
ea2384d3
FB
1432 }
1433 }
3b46e624 1434
64bb01aa 1435 /* Initialize before goto out */
f382d43a
MR
1436 if (quiet) {
1437 progress = 0;
1438 }
64bb01aa
KW
1439 qemu_progress_init(progress, 1.0);
1440
f382d43a 1441
926c2d23 1442 bs_n = argc - optind - 1;
a283cb6e 1443 out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
f58c7b35 1444
2dc8328b 1445 if (options && has_help_option(options)) {
4ac8aacd
JS
1446 ret = print_block_option_help(out_filename, out_fmt);
1447 goto out;
1448 }
1449
a283cb6e 1450 if (bs_n < 1) {
ac1307ab 1451 error_exit("Must specify image file name");
a283cb6e
KW
1452 }
1453
1454
c2abccec 1455 if (bs_n > 1 && out_baseimg) {
15654a6d
JS
1456 error_report("-B makes no sense when concatenating multiple input "
1457 "images");
31ca34b8
JS
1458 ret = -1;
1459 goto out;
c2abccec 1460 }
f8111c24 1461
40055951
HR
1462 src_flags = BDRV_O_FLAGS;
1463 ret = bdrv_parse_cache_flags(src_cache, &src_flags);
1464 if (ret < 0) {
1465 error_report("Invalid source cache option: %s", src_cache);
1466 goto out;
1467 }
1468
6b837bc4
JS
1469 qemu_progress_print(0, 100);
1470
26f54e9a 1471 blk = g_new0(BlockBackend *, bs_n);
d739f1c4 1472 bs = g_new0(BlockDriverState *, bs_n);
52bf1e72 1473 bs_sectors = g_new(int64_t, bs_n);
926c2d23
AZ
1474
1475 total_sectors = 0;
1476 for (bs_i = 0; bs_i < bs_n; bs_i++) {
9aebf3b8 1477 char *id = bs_n > 1 ? g_strdup_printf("source_%d", bs_i)
9ffe3332 1478 : g_strdup("source");
7e7d56d9
MA
1479 blk[bs_i] = img_open(id, argv[optind + bs_i], fmt, src_flags,
1480 true, quiet);
9ffe3332 1481 g_free(id);
7e7d56d9 1482 if (!blk[bs_i]) {
c2abccec
MK
1483 ret = -1;
1484 goto out;
1485 }
7e7d56d9 1486 bs[bs_i] = blk_bs(blk[bs_i]);
52bf1e72
MA
1487 bs_sectors[bs_i] = bdrv_nb_sectors(bs[bs_i]);
1488 if (bs_sectors[bs_i] < 0) {
1489 error_report("Could not get size of %s: %s",
1490 argv[optind + bs_i], strerror(-bs_sectors[bs_i]));
1491 ret = -1;
1492 goto out;
1493 }
d739f1c4 1494 total_sectors += bs_sectors[bs_i];
926c2d23 1495 }
ea2384d3 1496
ef80654d
WX
1497 if (sn_opts) {
1498 ret = bdrv_snapshot_load_tmp(bs[0],
1499 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
1500 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
1501 &local_err);
1502 } else if (snapshot_name != NULL) {
51ef6727 1503 if (bs_n > 1) {
6daf194d 1504 error_report("No support for concatenating multiple snapshot");
51ef6727 1505 ret = -1;
1506 goto out;
1507 }
7b4c4781
WX
1508
1509 bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
ef80654d 1510 }
84d18f06 1511 if (local_err) {
ef80654d
WX
1512 error_report("Failed to load snapshot: %s",
1513 error_get_pretty(local_err));
1514 error_free(local_err);
1515 ret = -1;
1516 goto out;
51ef6727 1517 }
1518
efa84d43 1519 /* Find driver and parse its options */
ea2384d3 1520 drv = bdrv_find_format(out_fmt);
c2abccec 1521 if (!drv) {
15654a6d 1522 error_report("Unknown file format '%s'", out_fmt);
c2abccec
MK
1523 ret = -1;
1524 goto out;
1525 }
efa84d43 1526
98289620 1527 proto_drv = bdrv_find_protocol(out_filename, true);
c2abccec 1528 if (!proto_drv) {
15654a6d 1529 error_report("Unknown protocol '%s'", out_filename);
c2abccec
MK
1530 ret = -1;
1531 goto out;
1532 }
b50cbabc 1533
f75613cf
HR
1534 if (!drv->create_opts) {
1535 error_report("Format driver '%s' does not support image creation",
1536 drv->format_name);
1537 ret = -1;
1538 goto out;
1539 }
1540
1541 if (!proto_drv->create_opts) {
1542 error_report("Protocol driver '%s' does not support image creation",
1543 proto_drv->format_name);
1544 ret = -1;
1545 goto out;
1546 }
1547
c282e1fd
CL
1548 create_opts = qemu_opts_append(create_opts, drv->create_opts);
1549 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
db08adf5 1550
83d0521a
CL
1551 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
1552 if (options && qemu_opts_do_parse(opts, options, NULL)) {
1553 error_report("Invalid options for file format '%s'", out_fmt);
1554 ret = -1;
1555 goto out;
efa84d43
KW
1556 }
1557
83d0521a
CL
1558 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512);
1559 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
c2abccec
MK
1560 if (ret < 0) {
1561 goto out;
1562 }
efa84d43 1563
a18953fb 1564 /* Get backing file name if -o backing_file was used */
83d0521a 1565 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
a18953fb 1566 if (out_baseimg_param) {
83d0521a 1567 out_baseimg = out_baseimg_param;
a18953fb
KW
1568 }
1569
efa84d43 1570 /* Check if compression is supported */
eec77d9e 1571 if (compress) {
83d0521a
CL
1572 bool encryption =
1573 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
1574 const char *preallocation =
1575 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
efa84d43
KW
1576
1577 if (!drv->bdrv_write_compressed) {
15654a6d 1578 error_report("Compression not supported for this file format");
c2abccec
MK
1579 ret = -1;
1580 goto out;
efa84d43
KW
1581 }
1582
83d0521a 1583 if (encryption) {
15654a6d
JS
1584 error_report("Compression and encryption not supported at "
1585 "the same time");
c2abccec
MK
1586 ret = -1;
1587 goto out;
efa84d43 1588 }
41521fa4 1589
83d0521a
CL
1590 if (preallocation
1591 && strcmp(preallocation, "off"))
41521fa4
KW
1592 {
1593 error_report("Compression and preallocation not supported at "
1594 "the same time");
1595 ret = -1;
1596 goto out;
1597 }
efa84d43
KW
1598 }
1599
b2e10493
AD
1600 if (!skip_create) {
1601 /* Create the new image */
c282e1fd 1602 ret = bdrv_create(drv, out_filename, opts, &local_err);
b2e10493 1603 if (ret < 0) {
cc84d90f
HR
1604 error_report("%s: error while converting %s: %s",
1605 out_filename, out_fmt, error_get_pretty(local_err));
1606 error_free(local_err);
b2e10493 1607 goto out;
ea2384d3
FB
1608 }
1609 }
3b46e624 1610
5a37b60a 1611 flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
c3993cdc 1612 ret = bdrv_parse_cache_flags(cache, &flags);
661a0f71
FS
1613 if (ret < 0) {
1614 error_report("Invalid cache option: %s", cache);
bb9cd2ee 1615 goto out;
661a0f71
FS
1616 }
1617
7e7d56d9
MA
1618 out_blk = img_open("target", out_filename, out_fmt, flags, true, quiet);
1619 if (!out_blk) {
c2abccec
MK
1620 ret = -1;
1621 goto out;
1622 }
7e7d56d9 1623 out_bs = blk_bs(out_blk);
ea2384d3 1624
926c2d23
AZ
1625 bs_i = 0;
1626 bs_offset = 0;
f2521c90
PL
1627
1628 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
1629 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
1630 * as maximum. */
1631 bufsectors = MIN(32768,
1632 MAX(bufsectors, MAX(out_bs->bl.opt_transfer_length,
1633 out_bs->bl.discard_alignment))
1634 );
1635
1636 buf = qemu_blockalign(out_bs, bufsectors * BDRV_SECTOR_SIZE);
926c2d23 1637
b2e10493 1638 if (skip_create) {
43716fa8
MA
1639 int64_t output_sectors = bdrv_nb_sectors(out_bs);
1640 if (output_sectors < 0) {
b2e10493 1641 error_report("unable to get output image length: %s\n",
43716fa8 1642 strerror(-output_sectors));
b2e10493
AD
1643 ret = -1;
1644 goto out;
43716fa8 1645 } else if (output_sectors < total_sectors) {
b2e10493
AD
1646 error_report("output file is smaller than input file");
1647 ret = -1;
1648 goto out;
1649 }
1650 }
1651
24f833cd
PL
1652 cluster_sectors = 0;
1653 ret = bdrv_get_info(out_bs, &bdi);
1654 if (ret < 0) {
1655 if (compress) {
15654a6d 1656 error_report("could not get block driver info");
c2abccec
MK
1657 goto out;
1658 }
24f833cd 1659 } else {
85f49cad 1660 compress = compress || bdi.needs_compressed_writes;
24f833cd
PL
1661 cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
1662 }
1663
1664 if (compress) {
1665 if (cluster_sectors <= 0 || cluster_sectors > bufsectors) {
15654a6d 1666 error_report("invalid cluster size");
c2abccec
MK
1667 ret = -1;
1668 goto out;
1669 }
ea2384d3 1670 sector_num = 0;
6b837bc4
JS
1671
1672 nb_sectors = total_sectors;
6b837bc4 1673
ea2384d3 1674 for(;;) {
926c2d23
AZ
1675 int64_t bs_num;
1676 int remainder;
1677 uint8_t *buf2;
1678
ea2384d3
FB
1679 nb_sectors = total_sectors - sector_num;
1680 if (nb_sectors <= 0)
1681 break;
1682 if (nb_sectors >= cluster_sectors)
1683 n = cluster_sectors;
1684 else
1685 n = nb_sectors;
926c2d23
AZ
1686
1687 bs_num = sector_num - bs_offset;
1688 assert (bs_num >= 0);
1689 remainder = n;
1690 buf2 = buf;
1691 while (remainder > 0) {
1692 int nlow;
d739f1c4
MA
1693 while (bs_num == bs_sectors[bs_i]) {
1694 bs_offset += bs_sectors[bs_i];
926c2d23
AZ
1695 bs_i++;
1696 assert (bs_i < bs_n);
926c2d23 1697 bs_num = 0;
0bfcd599
BS
1698 /* printf("changing part: sector_num=%" PRId64 ", "
1699 "bs_i=%d, bs_offset=%" PRId64 ", bs_sectors=%" PRId64
d739f1c4 1700 "\n", sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
926c2d23 1701 }
d739f1c4 1702 assert (bs_num < bs_sectors[bs_i]);
926c2d23 1703
d739f1c4
MA
1704 nlow = remainder > bs_sectors[bs_i] - bs_num
1705 ? bs_sectors[bs_i] - bs_num : remainder;
926c2d23 1706
c2abccec
MK
1707 ret = bdrv_read(bs[bs_i], bs_num, buf2, nlow);
1708 if (ret < 0) {
3fba9d81
SH
1709 error_report("error while reading sector %" PRId64 ": %s",
1710 bs_num, strerror(-ret));
c2abccec
MK
1711 goto out;
1712 }
926c2d23
AZ
1713
1714 buf2 += nlow * 512;
1715 bs_num += nlow;
1716
1717 remainder -= nlow;
1718 }
1719 assert (remainder == 0);
1720
54f106d5
SH
1721 if (!buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)) {
1722 ret = bdrv_write_compressed(out_bs, sector_num, buf, n);
c2abccec 1723 if (ret != 0) {
3fba9d81
SH
1724 error_report("error while compressing sector %" PRId64
1725 ": %s", sector_num, strerror(-ret));
c2abccec
MK
1726 goto out;
1727 }
ea2384d3
FB
1728 }
1729 sector_num += n;
13c28af8 1730 qemu_progress_print(100.0 * sector_num / total_sectors, 0);
ea2384d3 1731 }
faea38e7
FB
1732 /* signal EOF to align */
1733 bdrv_write_compressed(out_bs, 0, NULL, 0);
ea2384d3 1734 } else {
802c3d4c
PL
1735 int64_t sectors_to_read, sectors_read, sector_num_next_status;
1736 bool count_allocated_sectors;
11b6699a 1737 int has_zero_init = min_sparse ? bdrv_has_zero_init(out_bs) : 0;
f2feebbd 1738
5a37b60a
PL
1739 if (!has_zero_init && bdrv_can_write_zeroes_with_unmap(out_bs)) {
1740 ret = bdrv_make_zero(out_bs, BDRV_REQ_MAY_UNMAP);
1741 if (ret < 0) {
1742 goto out;
1743 }
1744 has_zero_init = 1;
1745 }
1746
802c3d4c
PL
1747 sectors_to_read = total_sectors;
1748 count_allocated_sectors = progress && (out_baseimg || has_zero_init);
1749restart:
f58c7b35 1750 sector_num = 0; // total number of sectors converted so far
802c3d4c
PL
1751 sectors_read = 0;
1752 sector_num_next_status = 0;
6b837bc4 1753
ea2384d3
FB
1754 for(;;) {
1755 nb_sectors = total_sectors - sector_num;
b8fb60da 1756 if (nb_sectors <= 0) {
802c3d4c
PL
1757 if (count_allocated_sectors) {
1758 sectors_to_read = sectors_read;
1759 count_allocated_sectors = false;
1760 goto restart;
1761 }
13c28af8 1762 ret = 0;
ea2384d3 1763 break;
b8fb60da 1764 }
926c2d23 1765
d739f1c4
MA
1766 while (sector_num - bs_offset >= bs_sectors[bs_i]) {
1767 bs_offset += bs_sectors[bs_i];
926c2d23
AZ
1768 bs_i ++;
1769 assert (bs_i < bs_n);
0bfcd599
BS
1770 /* printf("changing part: sector_num=%" PRId64 ", bs_i=%d, "
1771 "bs_offset=%" PRId64 ", bs_sectors=%" PRId64 "\n",
d739f1c4 1772 sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
926c2d23
AZ
1773 }
1774
13c28af8
PL
1775 if ((out_baseimg || has_zero_init) &&
1776 sector_num >= sector_num_next_status) {
1777 n = nb_sectors > INT_MAX ? INT_MAX : nb_sectors;
1778 ret = bdrv_get_block_status(bs[bs_i], sector_num - bs_offset,
1779 n, &n1);
e4a86f88 1780 if (ret < 0) {
13c28af8
PL
1781 error_report("error while reading block status of sector %"
1782 PRId64 ": %s", sector_num - bs_offset,
1783 strerror(-ret));
e4a86f88
PB
1784 goto out;
1785 }
13c28af8
PL
1786 /* If the output image is zero initialized, we are not working
1787 * on a shared base and the input is zero we can skip the next
1788 * n1 sectors */
1789 if (has_zero_init && !out_baseimg && (ret & BDRV_BLOCK_ZERO)) {
e4a86f88
PB
1790 sector_num += n1;
1791 continue;
93c65b47 1792 }
13c28af8
PL
1793 /* If the output image is being created as a copy on write
1794 * image, assume that sectors which are unallocated in the
1795 * input image are present in both the output's and input's
1796 * base images (no need to copy them). */
1797 if (out_baseimg) {
1798 if (!(ret & BDRV_BLOCK_DATA)) {
1799 sector_num += n1;
1800 continue;
1801 }
1802 /* The next 'n1' sectors are allocated in the input image.
1803 * Copy only those as they may be followed by unallocated
1804 * sectors. */
1805 nb_sectors = n1;
1806 }
1807 /* avoid redundant callouts to get_block_status */
1808 sector_num_next_status = sector_num + n1;
f58c7b35
TS
1809 }
1810
f2521c90 1811 n = MIN(nb_sectors, bufsectors);
24f833cd
PL
1812
1813 /* round down request length to an aligned sector, but
1814 * do not bother doing this on short requests. They happen
1815 * when we found an all-zero area, and the next sector to
1816 * write will not be sector_num + n. */
1817 if (cluster_sectors > 0 && n >= cluster_sectors) {
1818 int64_t next_aligned_sector = (sector_num + n);
1819 next_aligned_sector -= next_aligned_sector % cluster_sectors;
1820 if (sector_num + n > next_aligned_sector) {
1821 n = next_aligned_sector - sector_num;
1822 }
1823 }
1824
d739f1c4 1825 n = MIN(n, bs_sectors[bs_i] - (sector_num - bs_offset));
13c28af8 1826
802c3d4c
PL
1827 sectors_read += n;
1828 if (count_allocated_sectors) {
1829 sector_num += n;
1830 continue;
1831 }
1832
1833 n1 = n;
c2abccec
MK
1834 ret = bdrv_read(bs[bs_i], sector_num - bs_offset, buf, n);
1835 if (ret < 0) {
3fba9d81
SH
1836 error_report("error while reading sector %" PRId64 ": %s",
1837 sector_num - bs_offset, strerror(-ret));
c2abccec
MK
1838 goto out;
1839 }
ea2384d3
FB
1840 /* NOTE: at the same time we convert, we do not write zero
1841 sectors to have a chance to compress the image. Ideally, we
1842 should add a specific call to have the info to go faster */
1843 buf1 = buf;
1844 while (n > 0) {
11212d8f 1845 if (!has_zero_init ||
a22f123c 1846 is_allocated_sectors_min(buf1, n, &n1, min_sparse)) {
c2abccec
MK
1847 ret = bdrv_write(out_bs, sector_num, buf1, n1);
1848 if (ret < 0) {
3fba9d81
SH
1849 error_report("error while writing sector %" PRId64
1850 ": %s", sector_num, strerror(-ret));
c2abccec
MK
1851 goto out;
1852 }
ea2384d3
FB
1853 }
1854 sector_num += n1;
1855 n -= n1;
1856 buf1 += n1 * 512;
1857 }
802c3d4c 1858 qemu_progress_print(100.0 * sectors_read / sectors_to_read, 0);
ea2384d3
FB
1859 }
1860 }
c2abccec 1861out:
13c28af8
PL
1862 if (!ret) {
1863 qemu_progress_print(100, 0);
1864 }
6b837bc4 1865 qemu_progress_end();
83d0521a
CL
1866 qemu_opts_del(opts);
1867 qemu_opts_free(create_opts);
bb1c0597 1868 qemu_vfree(buf);
fbf28a43 1869 qemu_opts_del(sn_opts);
26f54e9a 1870 blk_unref(out_blk);
9ba10c95 1871 g_free(bs);
26f54e9a
MA
1872 if (blk) {
1873 for (bs_i = 0; bs_i < bs_n; bs_i++) {
1874 blk_unref(blk[bs_i]);
1875 }
1876 g_free(blk);
1877 }
d739f1c4 1878 g_free(bs_sectors);
64bb01aa
KW
1879fail_getopt:
1880 g_free(options);
1881
c2abccec
MK
1882 if (ret) {
1883 return 1;
1884 }
ea2384d3
FB
1885 return 0;
1886}
1887
57d1a2b6 1888
faea38e7
FB
1889static void dump_snapshots(BlockDriverState *bs)
1890{
1891 QEMUSnapshotInfo *sn_tab, *sn;
1892 int nb_sns, i;
faea38e7
FB
1893
1894 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1895 if (nb_sns <= 0)
1896 return;
1897 printf("Snapshot list:\n");
5b917044
WX
1898 bdrv_snapshot_dump(fprintf, stdout, NULL);
1899 printf("\n");
faea38e7
FB
1900 for(i = 0; i < nb_sns; i++) {
1901 sn = &sn_tab[i];
5b917044
WX
1902 bdrv_snapshot_dump(fprintf, stdout, sn);
1903 printf("\n");
faea38e7 1904 }
7267c094 1905 g_free(sn_tab);
faea38e7
FB
1906}
1907
9699bf0d
SH
1908static void dump_json_image_info_list(ImageInfoList *list)
1909{
4399c438 1910 Error *local_err = NULL;
9699bf0d
SH
1911 QString *str;
1912 QmpOutputVisitor *ov = qmp_output_visitor_new();
1913 QObject *obj;
1914 visit_type_ImageInfoList(qmp_output_get_visitor(ov),
4399c438 1915 &list, NULL, &local_err);
9699bf0d
SH
1916 obj = qmp_output_get_qobject(ov);
1917 str = qobject_to_json_pretty(obj);
1918 assert(str != NULL);
1919 printf("%s\n", qstring_get_str(str));
1920 qobject_decref(obj);
1921 qmp_output_visitor_cleanup(ov);
1922 QDECREF(str);
1923}
1924
c054b3fd
BC
1925static void dump_json_image_info(ImageInfo *info)
1926{
4399c438 1927 Error *local_err = NULL;
c054b3fd
BC
1928 QString *str;
1929 QmpOutputVisitor *ov = qmp_output_visitor_new();
1930 QObject *obj;
1931 visit_type_ImageInfo(qmp_output_get_visitor(ov),
4399c438 1932 &info, NULL, &local_err);
c054b3fd
BC
1933 obj = qmp_output_get_qobject(ov);
1934 str = qobject_to_json_pretty(obj);
1935 assert(str != NULL);
1936 printf("%s\n", qstring_get_str(str));
1937 qobject_decref(obj);
1938 qmp_output_visitor_cleanup(ov);
1939 QDECREF(str);
1940}
1941
9699bf0d
SH
1942static void dump_human_image_info_list(ImageInfoList *list)
1943{
1944 ImageInfoList *elem;
1945 bool delim = false;
1946
1947 for (elem = list; elem; elem = elem->next) {
1948 if (delim) {
1949 printf("\n");
1950 }
1951 delim = true;
1952
5b917044 1953 bdrv_image_info_dump(fprintf, stdout, elem->value);
9699bf0d
SH
1954 }
1955}
1956
1957static gboolean str_equal_func(gconstpointer a, gconstpointer b)
1958{
1959 return strcmp(a, b) == 0;
1960}
1961
1962/**
1963 * Open an image file chain and return an ImageInfoList
1964 *
1965 * @filename: topmost image filename
1966 * @fmt: topmost image format (may be NULL to autodetect)
1967 * @chain: true - enumerate entire backing file chain
1968 * false - only topmost image file
1969 *
1970 * Returns a list of ImageInfo objects or NULL if there was an error opening an
1971 * image file. If there was an error a message will have been printed to
1972 * stderr.
1973 */
1974static ImageInfoList *collect_image_info_list(const char *filename,
1975 const char *fmt,
1976 bool chain)
1977{
1978 ImageInfoList *head = NULL;
1979 ImageInfoList **last = &head;
1980 GHashTable *filenames;
43526ec8 1981 Error *err = NULL;
9699bf0d
SH
1982
1983 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
1984
1985 while (filename) {
26f54e9a 1986 BlockBackend *blk;
9699bf0d
SH
1987 BlockDriverState *bs;
1988 ImageInfo *info;
1989 ImageInfoList *elem;
1990
1991 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
1992 error_report("Backing file '%s' creates an infinite loop.",
1993 filename);
1994 goto err;
1995 }
1996 g_hash_table_insert(filenames, (gpointer)filename, NULL);
1997
7e7d56d9
MA
1998 blk = img_open("image", filename, fmt,
1999 BDRV_O_FLAGS | BDRV_O_NO_BACKING, false, false);
2000 if (!blk) {
9699bf0d
SH
2001 goto err;
2002 }
7e7d56d9 2003 bs = blk_bs(blk);
9699bf0d 2004
43526ec8 2005 bdrv_query_image_info(bs, &info, &err);
84d18f06 2006 if (err) {
565f65d2 2007 error_report_err(err);
26f54e9a 2008 blk_unref(blk);
43526ec8 2009 goto err;
fb0ed453 2010 }
9699bf0d
SH
2011
2012 elem = g_new0(ImageInfoList, 1);
2013 elem->value = info;
2014 *last = elem;
2015 last = &elem->next;
2016
26f54e9a 2017 blk_unref(blk);
9699bf0d
SH
2018
2019 filename = fmt = NULL;
2020 if (chain) {
2021 if (info->has_full_backing_filename) {
2022 filename = info->full_backing_filename;
2023 } else if (info->has_backing_filename) {
2024 filename = info->backing_filename;
2025 }
2026 if (info->has_backing_filename_format) {
2027 fmt = info->backing_filename_format;
2028 }
2029 }
2030 }
2031 g_hash_table_destroy(filenames);
2032 return head;
2033
2034err:
2035 qapi_free_ImageInfoList(head);
2036 g_hash_table_destroy(filenames);
2037 return NULL;
2038}
2039
c054b3fd
BC
2040static int img_info(int argc, char **argv)
2041{
2042 int c;
2043 OutputFormat output_format = OFORMAT_HUMAN;
9699bf0d 2044 bool chain = false;
c054b3fd 2045 const char *filename, *fmt, *output;
9699bf0d 2046 ImageInfoList *list;
c054b3fd 2047
ea2384d3 2048 fmt = NULL;
c054b3fd 2049 output = NULL;
ea2384d3 2050 for(;;) {
c054b3fd
BC
2051 int option_index = 0;
2052 static const struct option long_options[] = {
2053 {"help", no_argument, 0, 'h'},
2054 {"format", required_argument, 0, 'f'},
2055 {"output", required_argument, 0, OPTION_OUTPUT},
9699bf0d 2056 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
c054b3fd
BC
2057 {0, 0, 0, 0}
2058 };
2059 c = getopt_long(argc, argv, "f:h",
2060 long_options, &option_index);
b8fb60da 2061 if (c == -1) {
ea2384d3 2062 break;
b8fb60da 2063 }
ea2384d3 2064 switch(c) {
ef87394c 2065 case '?':
ea2384d3
FB
2066 case 'h':
2067 help();
2068 break;
2069 case 'f':
2070 fmt = optarg;
2071 break;
c054b3fd
BC
2072 case OPTION_OUTPUT:
2073 output = optarg;
2074 break;
9699bf0d
SH
2075 case OPTION_BACKING_CHAIN:
2076 chain = true;
2077 break;
ea2384d3
FB
2078 }
2079 }
fc11eb26 2080 if (optind != argc - 1) {
ac1307ab 2081 error_exit("Expecting one image file name");
b8fb60da 2082 }
ea2384d3
FB
2083 filename = argv[optind++];
2084
c054b3fd
BC
2085 if (output && !strcmp(output, "json")) {
2086 output_format = OFORMAT_JSON;
2087 } else if (output && !strcmp(output, "human")) {
2088 output_format = OFORMAT_HUMAN;
2089 } else if (output) {
2090 error_report("--output must be used with human or json as argument.");
c2abccec
MK
2091 return 1;
2092 }
c054b3fd 2093
9699bf0d
SH
2094 list = collect_image_info_list(filename, fmt, chain);
2095 if (!list) {
c2abccec 2096 return 1;
faea38e7 2097 }
c054b3fd 2098
c054b3fd
BC
2099 switch (output_format) {
2100 case OFORMAT_HUMAN:
9699bf0d 2101 dump_human_image_info_list(list);
c054b3fd
BC
2102 break;
2103 case OFORMAT_JSON:
9699bf0d
SH
2104 if (chain) {
2105 dump_json_image_info_list(list);
2106 } else {
2107 dump_json_image_info(list->value);
2108 }
c054b3fd 2109 break;
faea38e7 2110 }
c054b3fd 2111
9699bf0d 2112 qapi_free_ImageInfoList(list);
ea2384d3
FB
2113 return 0;
2114}
2115
4c93a13b
PB
2116
2117typedef struct MapEntry {
2118 int flags;
2119 int depth;
2120 int64_t start;
2121 int64_t length;
2122 int64_t offset;
2123 BlockDriverState *bs;
2124} MapEntry;
2125
2126static void dump_map_entry(OutputFormat output_format, MapEntry *e,
2127 MapEntry *next)
2128{
2129 switch (output_format) {
2130 case OFORMAT_HUMAN:
2131 if ((e->flags & BDRV_BLOCK_DATA) &&
2132 !(e->flags & BDRV_BLOCK_OFFSET_VALID)) {
2133 error_report("File contains external, encrypted or compressed clusters.");
2134 exit(1);
2135 }
2136 if ((e->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) == BDRV_BLOCK_DATA) {
2137 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2138 e->start, e->length, e->offset, e->bs->filename);
2139 }
2140 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2141 * Modify the flags here to allow more coalescing.
2142 */
2143 if (next &&
2144 (next->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) != BDRV_BLOCK_DATA) {
2145 next->flags &= ~BDRV_BLOCK_DATA;
2146 next->flags |= BDRV_BLOCK_ZERO;
2147 }
2148 break;
2149 case OFORMAT_JSON:
2150 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64", \"depth\": %d,"
2151 " \"zero\": %s, \"data\": %s",
2152 (e->start == 0 ? "[" : ",\n"),
2153 e->start, e->length, e->depth,
2154 (e->flags & BDRV_BLOCK_ZERO) ? "true" : "false",
2155 (e->flags & BDRV_BLOCK_DATA) ? "true" : "false");
2156 if (e->flags & BDRV_BLOCK_OFFSET_VALID) {
c745bfb4 2157 printf(", \"offset\": %"PRId64"", e->offset);
4c93a13b
PB
2158 }
2159 putchar('}');
2160
2161 if (!next) {
2162 printf("]\n");
2163 }
2164 break;
2165 }
2166}
2167
2168static int get_block_status(BlockDriverState *bs, int64_t sector_num,
2169 int nb_sectors, MapEntry *e)
2170{
2171 int64_t ret;
2172 int depth;
2173
2174 /* As an optimization, we could cache the current range of unallocated
2175 * clusters in each file of the chain, and avoid querying the same
2176 * range repeatedly.
2177 */
2178
2179 depth = 0;
2180 for (;;) {
2181 ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors);
2182 if (ret < 0) {
2183 return ret;
2184 }
2185 assert(nb_sectors);
2186 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2187 break;
2188 }
2189 bs = bs->backing_hd;
2190 if (bs == NULL) {
2191 ret = 0;
2192 break;
2193 }
2194
2195 depth++;
2196 }
2197
2198 e->start = sector_num * BDRV_SECTOR_SIZE;
2199 e->length = nb_sectors * BDRV_SECTOR_SIZE;
2200 e->flags = ret & ~BDRV_BLOCK_OFFSET_MASK;
2201 e->offset = ret & BDRV_BLOCK_OFFSET_MASK;
2202 e->depth = depth;
2203 e->bs = bs;
2204 return 0;
2205}
2206
2207static int img_map(int argc, char **argv)
2208{
2209 int c;
2210 OutputFormat output_format = OFORMAT_HUMAN;
26f54e9a 2211 BlockBackend *blk;
4c93a13b
PB
2212 BlockDriverState *bs;
2213 const char *filename, *fmt, *output;
2214 int64_t length;
2215 MapEntry curr = { .length = 0 }, next;
2216 int ret = 0;
2217
2218 fmt = NULL;
2219 output = NULL;
2220 for (;;) {
2221 int option_index = 0;
2222 static const struct option long_options[] = {
2223 {"help", no_argument, 0, 'h'},
2224 {"format", required_argument, 0, 'f'},
2225 {"output", required_argument, 0, OPTION_OUTPUT},
2226 {0, 0, 0, 0}
2227 };
2228 c = getopt_long(argc, argv, "f:h",
2229 long_options, &option_index);
2230 if (c == -1) {
2231 break;
2232 }
2233 switch (c) {
2234 case '?':
2235 case 'h':
2236 help();
2237 break;
2238 case 'f':
2239 fmt = optarg;
2240 break;
2241 case OPTION_OUTPUT:
2242 output = optarg;
2243 break;
2244 }
2245 }
ac1307ab
FZ
2246 if (optind != argc - 1) {
2247 error_exit("Expecting one image file name");
4c93a13b 2248 }
ac1307ab 2249 filename = argv[optind];
4c93a13b
PB
2250
2251 if (output && !strcmp(output, "json")) {
2252 output_format = OFORMAT_JSON;
2253 } else if (output && !strcmp(output, "human")) {
2254 output_format = OFORMAT_HUMAN;
2255 } else if (output) {
2256 error_report("--output must be used with human or json as argument.");
2257 return 1;
2258 }
2259
7e7d56d9
MA
2260 blk = img_open("image", filename, fmt, BDRV_O_FLAGS, true, false);
2261 if (!blk) {
2262 return 1;
4c93a13b 2263 }
7e7d56d9 2264 bs = blk_bs(blk);
4c93a13b
PB
2265
2266 if (output_format == OFORMAT_HUMAN) {
2267 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2268 }
2269
2270 length = bdrv_getlength(bs);
2271 while (curr.start + curr.length < length) {
2272 int64_t nsectors_left;
2273 int64_t sector_num;
2274 int n;
2275
2276 sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;
2277
2278 /* Probe up to 1 GiB at a time. */
2279 nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
2280 n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
2281 ret = get_block_status(bs, sector_num, n, &next);
2282
2283 if (ret < 0) {
2284 error_report("Could not read file metadata: %s", strerror(-ret));
2285 goto out;
2286 }
2287
2288 if (curr.length != 0 && curr.flags == next.flags &&
2289 curr.depth == next.depth &&
2290 ((curr.flags & BDRV_BLOCK_OFFSET_VALID) == 0 ||
2291 curr.offset + curr.length == next.offset)) {
2292 curr.length += next.length;
2293 continue;
2294 }
2295
2296 if (curr.length > 0) {
2297 dump_map_entry(output_format, &curr, &next);
2298 }
2299 curr = next;
2300 }
2301
2302 dump_map_entry(output_format, &curr, NULL);
2303
2304out:
26f54e9a 2305 blk_unref(blk);
4c93a13b
PB
2306 return ret < 0;
2307}
2308
f7b4a940
AL
2309#define SNAPSHOT_LIST 1
2310#define SNAPSHOT_CREATE 2
2311#define SNAPSHOT_APPLY 3
2312#define SNAPSHOT_DELETE 4
2313
153859be 2314static int img_snapshot(int argc, char **argv)
f7b4a940 2315{
26f54e9a 2316 BlockBackend *blk;
f7b4a940
AL
2317 BlockDriverState *bs;
2318 QEMUSnapshotInfo sn;
2319 char *filename, *snapshot_name = NULL;
c2abccec 2320 int c, ret = 0, bdrv_oflags;
f7b4a940
AL
2321 int action = 0;
2322 qemu_timeval tv;
f382d43a 2323 bool quiet = false;
a89d89d3 2324 Error *err = NULL;
f7b4a940 2325
710da702 2326 bdrv_oflags = BDRV_O_FLAGS | BDRV_O_RDWR;
f7b4a940
AL
2327 /* Parse commandline parameters */
2328 for(;;) {
f382d43a 2329 c = getopt(argc, argv, "la:c:d:hq");
b8fb60da 2330 if (c == -1) {
f7b4a940 2331 break;
b8fb60da 2332 }
f7b4a940 2333 switch(c) {
ef87394c 2334 case '?':
f7b4a940
AL
2335 case 'h':
2336 help();
153859be 2337 return 0;
f7b4a940
AL
2338 case 'l':
2339 if (action) {
ac1307ab 2340 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2341 return 0;
f7b4a940
AL
2342 }
2343 action = SNAPSHOT_LIST;
f5edb014 2344 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
f7b4a940
AL
2345 break;
2346 case 'a':
2347 if (action) {
ac1307ab 2348 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2349 return 0;
f7b4a940
AL
2350 }
2351 action = SNAPSHOT_APPLY;
2352 snapshot_name = optarg;
2353 break;
2354 case 'c':
2355 if (action) {
ac1307ab 2356 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2357 return 0;
f7b4a940
AL
2358 }
2359 action = SNAPSHOT_CREATE;
2360 snapshot_name = optarg;
2361 break;
2362 case 'd':
2363 if (action) {
ac1307ab 2364 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 2365 return 0;
f7b4a940
AL
2366 }
2367 action = SNAPSHOT_DELETE;
2368 snapshot_name = optarg;
2369 break;
f382d43a
MR
2370 case 'q':
2371 quiet = true;
2372 break;
f7b4a940
AL
2373 }
2374 }
2375
fc11eb26 2376 if (optind != argc - 1) {
ac1307ab 2377 error_exit("Expecting one image file name");
b8fb60da 2378 }
f7b4a940
AL
2379 filename = argv[optind++];
2380
2381 /* Open the image */
7e7d56d9
MA
2382 blk = img_open("image", filename, NULL, bdrv_oflags, true, quiet);
2383 if (!blk) {
2384 return 1;
c2abccec 2385 }
7e7d56d9 2386 bs = blk_bs(blk);
f7b4a940
AL
2387
2388 /* Perform the requested action */
2389 switch(action) {
2390 case SNAPSHOT_LIST:
2391 dump_snapshots(bs);
2392 break;
2393
2394 case SNAPSHOT_CREATE:
2395 memset(&sn, 0, sizeof(sn));
2396 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
2397
2398 qemu_gettimeofday(&tv);
2399 sn.date_sec = tv.tv_sec;
2400 sn.date_nsec = tv.tv_usec * 1000;
2401
2402 ret = bdrv_snapshot_create(bs, &sn);
b8fb60da 2403 if (ret) {
15654a6d 2404 error_report("Could not create snapshot '%s': %d (%s)",
f7b4a940 2405 snapshot_name, ret, strerror(-ret));
b8fb60da 2406 }
f7b4a940
AL
2407 break;
2408
2409 case SNAPSHOT_APPLY:
2410 ret = bdrv_snapshot_goto(bs, snapshot_name);
b8fb60da 2411 if (ret) {
15654a6d 2412 error_report("Could not apply snapshot '%s': %d (%s)",
f7b4a940 2413 snapshot_name, ret, strerror(-ret));
b8fb60da 2414 }
f7b4a940
AL
2415 break;
2416
2417 case SNAPSHOT_DELETE:
a89d89d3 2418 bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
84d18f06 2419 if (err) {
a89d89d3
WX
2420 error_report("Could not delete snapshot '%s': (%s)",
2421 snapshot_name, error_get_pretty(err));
2422 error_free(err);
2423 ret = 1;
b8fb60da 2424 }
f7b4a940
AL
2425 break;
2426 }
2427
2428 /* Cleanup */
26f54e9a 2429 blk_unref(blk);
c2abccec
MK
2430 if (ret) {
2431 return 1;
2432 }
153859be 2433 return 0;
f7b4a940
AL
2434}
2435
3e85c6fd
KW
2436static int img_rebase(int argc, char **argv)
2437{
26f54e9a 2438 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
40ed35a3 2439 BlockDriverState *bs = NULL, *bs_old_backing = NULL, *bs_new_backing = NULL;
f163d073 2440 BlockDriver *old_backing_drv, *new_backing_drv;
3e85c6fd 2441 char *filename;
40055951
HR
2442 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
2443 int c, flags, src_flags, ret;
3e85c6fd 2444 int unsafe = 0;
6b837bc4 2445 int progress = 0;
f382d43a 2446 bool quiet = false;
34b5d2c6 2447 Error *local_err = NULL;
3e85c6fd
KW
2448
2449 /* Parse commandline parameters */
e53dbee0 2450 fmt = NULL;
661a0f71 2451 cache = BDRV_DEFAULT_CACHE;
40055951 2452 src_cache = BDRV_DEFAULT_CACHE;
3e85c6fd
KW
2453 out_baseimg = NULL;
2454 out_basefmt = NULL;
3e85c6fd 2455 for(;;) {
40055951 2456 c = getopt(argc, argv, "hf:F:b:upt:T:q");
b8fb60da 2457 if (c == -1) {
3e85c6fd 2458 break;
b8fb60da 2459 }
3e85c6fd 2460 switch(c) {
ef87394c 2461 case '?':
3e85c6fd
KW
2462 case 'h':
2463 help();
2464 return 0;
e53dbee0
KW
2465 case 'f':
2466 fmt = optarg;
2467 break;
3e85c6fd
KW
2468 case 'F':
2469 out_basefmt = optarg;
2470 break;
2471 case 'b':
2472 out_baseimg = optarg;
2473 break;
2474 case 'u':
2475 unsafe = 1;
2476 break;
6b837bc4
JS
2477 case 'p':
2478 progress = 1;
2479 break;
661a0f71
FS
2480 case 't':
2481 cache = optarg;
2482 break;
40055951
HR
2483 case 'T':
2484 src_cache = optarg;
2485 break;
f382d43a
MR
2486 case 'q':
2487 quiet = true;
2488 break;
3e85c6fd
KW
2489 }
2490 }
2491
f382d43a
MR
2492 if (quiet) {
2493 progress = 0;
2494 }
2495
ac1307ab
FZ
2496 if (optind != argc - 1) {
2497 error_exit("Expecting one image file name");
2498 }
2499 if (!unsafe && !out_baseimg) {
2500 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
b8fb60da 2501 }
3e85c6fd
KW
2502 filename = argv[optind++];
2503
6b837bc4
JS
2504 qemu_progress_init(progress, 2.0);
2505 qemu_progress_print(0, 100);
2506
661a0f71 2507 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
c3993cdc 2508 ret = bdrv_parse_cache_flags(cache, &flags);
661a0f71
FS
2509 if (ret < 0) {
2510 error_report("Invalid cache option: %s", cache);
40ed35a3 2511 goto out;
661a0f71
FS
2512 }
2513
40055951
HR
2514 src_flags = BDRV_O_FLAGS;
2515 ret = bdrv_parse_cache_flags(src_cache, &src_flags);
2516 if (ret < 0) {
2517 error_report("Invalid source cache option: %s", src_cache);
40ed35a3 2518 goto out;
40055951
HR
2519 }
2520
3e85c6fd
KW
2521 /*
2522 * Open the images.
2523 *
2524 * Ignore the old backing file for unsafe rebase in case we want to correct
2525 * the reference to a renamed or moved backing file.
2526 */
7e7d56d9
MA
2527 blk = img_open("image", filename, fmt, flags, true, quiet);
2528 if (!blk) {
40ed35a3
SH
2529 ret = -1;
2530 goto out;
c2abccec 2531 }
7e7d56d9 2532 bs = blk_bs(blk);
3e85c6fd
KW
2533
2534 /* Find the right drivers for the backing files */
2535 old_backing_drv = NULL;
2536 new_backing_drv = NULL;
2537
2538 if (!unsafe && bs->backing_format[0] != '\0') {
2539 old_backing_drv = bdrv_find_format(bs->backing_format);
2540 if (old_backing_drv == NULL) {
15654a6d 2541 error_report("Invalid format name: '%s'", bs->backing_format);
c2abccec
MK
2542 ret = -1;
2543 goto out;
3e85c6fd
KW
2544 }
2545 }
2546
2547 if (out_basefmt != NULL) {
2548 new_backing_drv = bdrv_find_format(out_basefmt);
2549 if (new_backing_drv == NULL) {
15654a6d 2550 error_report("Invalid format name: '%s'", out_basefmt);
c2abccec
MK
2551 ret = -1;
2552 goto out;
3e85c6fd
KW
2553 }
2554 }
2555
2556 /* For safe rebasing we need to compare old and new backing file */
40ed35a3 2557 if (!unsafe) {
9a29e18f 2558 char backing_name[PATH_MAX];
3e85c6fd 2559
7e7d56d9
MA
2560 blk_old_backing = blk_new_with_bs("old_backing", &error_abort);
2561 bs_old_backing = blk_bs(blk_old_backing);
3e85c6fd 2562 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
40055951 2563 ret = bdrv_open(&bs_old_backing, backing_name, NULL, NULL, src_flags,
34b5d2c6 2564 old_backing_drv, &local_err);
c2abccec 2565 if (ret) {
34b5d2c6
HR
2566 error_report("Could not open old backing file '%s': %s",
2567 backing_name, error_get_pretty(local_err));
2568 error_free(local_err);
c2abccec 2569 goto out;
3e85c6fd 2570 }
a616673d 2571 if (out_baseimg[0]) {
7e7d56d9
MA
2572 blk_new_backing = blk_new_with_bs("new_backing", &error_abort);
2573 bs_new_backing = blk_bs(blk_new_backing);
40055951
HR
2574 ret = bdrv_open(&bs_new_backing, out_baseimg, NULL, NULL, src_flags,
2575 new_backing_drv, &local_err);
a616673d 2576 if (ret) {
34b5d2c6
HR
2577 error_report("Could not open new backing file '%s': %s",
2578 out_baseimg, error_get_pretty(local_err));
2579 error_free(local_err);
a616673d
AB
2580 goto out;
2581 }
3e85c6fd
KW
2582 }
2583 }
2584
2585 /*
2586 * Check each unallocated cluster in the COW file. If it is unallocated,
2587 * accesses go to the backing file. We must therefore compare this cluster
2588 * in the old and new backing file, and if they differ we need to copy it
2589 * from the old backing file into the COW file.
2590 *
2591 * If qemu-img crashes during this step, no harm is done. The content of
2592 * the image is the same as the original one at any time.
2593 */
2594 if (!unsafe) {
52bf1e72
MA
2595 int64_t num_sectors;
2596 int64_t old_backing_num_sectors;
2597 int64_t new_backing_num_sectors = 0;
3e85c6fd 2598 uint64_t sector;
cc60e327 2599 int n;
d6771bfa
T
2600 uint8_t * buf_old;
2601 uint8_t * buf_new;
1f710495 2602 float local_progress = 0;
d6771bfa 2603
bb1c0597
KW
2604 buf_old = qemu_blockalign(bs, IO_BUF_SIZE);
2605 buf_new = qemu_blockalign(bs, IO_BUF_SIZE);
3e85c6fd 2606
52bf1e72
MA
2607 num_sectors = bdrv_nb_sectors(bs);
2608 if (num_sectors < 0) {
2609 error_report("Could not get size of '%s': %s",
2610 filename, strerror(-num_sectors));
2611 ret = -1;
2612 goto out;
2613 }
2614 old_backing_num_sectors = bdrv_nb_sectors(bs_old_backing);
2615 if (old_backing_num_sectors < 0) {
9a29e18f 2616 char backing_name[PATH_MAX];
52bf1e72
MA
2617
2618 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2619 error_report("Could not get size of '%s': %s",
2620 backing_name, strerror(-old_backing_num_sectors));
2621 ret = -1;
2622 goto out;
2623 }
a616673d 2624 if (bs_new_backing) {
52bf1e72
MA
2625 new_backing_num_sectors = bdrv_nb_sectors(bs_new_backing);
2626 if (new_backing_num_sectors < 0) {
2627 error_report("Could not get size of '%s': %s",
2628 out_baseimg, strerror(-new_backing_num_sectors));
2629 ret = -1;
2630 goto out;
2631 }
a616673d 2632 }
3e85c6fd 2633
1f710495
KW
2634 if (num_sectors != 0) {
2635 local_progress = (float)100 /
2636 (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
2637 }
2638
3e85c6fd
KW
2639 for (sector = 0; sector < num_sectors; sector += n) {
2640
2641 /* How many sectors can we handle with the next read? */
2642 if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
2643 n = (IO_BUF_SIZE / 512);
2644 } else {
2645 n = num_sectors - sector;
2646 }
2647
2648 /* If the cluster is allocated, we don't need to take action */
cc60e327 2649 ret = bdrv_is_allocated(bs, sector, n, &n);
d663640c
PB
2650 if (ret < 0) {
2651 error_report("error while reading image metadata: %s",
2652 strerror(-ret));
2653 goto out;
2654 }
cc60e327 2655 if (ret) {
3e85c6fd
KW
2656 continue;
2657 }
2658
87a1b3e3
KW
2659 /*
2660 * Read old and new backing file and take into consideration that
2661 * backing files may be smaller than the COW image.
2662 */
2663 if (sector >= old_backing_num_sectors) {
2664 memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
2665 } else {
2666 if (sector + n > old_backing_num_sectors) {
2667 n = old_backing_num_sectors - sector;
2668 }
2669
2670 ret = bdrv_read(bs_old_backing, sector, buf_old, n);
2671 if (ret < 0) {
2672 error_report("error while reading from old backing file");
2673 goto out;
2674 }
3e85c6fd 2675 }
87a1b3e3 2676
a616673d 2677 if (sector >= new_backing_num_sectors || !bs_new_backing) {
87a1b3e3
KW
2678 memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
2679 } else {
2680 if (sector + n > new_backing_num_sectors) {
2681 n = new_backing_num_sectors - sector;
2682 }
2683
2684 ret = bdrv_read(bs_new_backing, sector, buf_new, n);
2685 if (ret < 0) {
2686 error_report("error while reading from new backing file");
2687 goto out;
2688 }
3e85c6fd
KW
2689 }
2690
2691 /* If they differ, we need to write to the COW file */
2692 uint64_t written = 0;
2693
2694 while (written < n) {
2695 int pnum;
2696
2697 if (compare_sectors(buf_old + written * 512,
60b1bd4f 2698 buf_new + written * 512, n - written, &pnum))
3e85c6fd
KW
2699 {
2700 ret = bdrv_write(bs, sector + written,
2701 buf_old + written * 512, pnum);
2702 if (ret < 0) {
15654a6d 2703 error_report("Error while writing to COW image: %s",
3e85c6fd 2704 strerror(-ret));
c2abccec 2705 goto out;
3e85c6fd
KW
2706 }
2707 }
2708
2709 written += pnum;
2710 }
6b837bc4 2711 qemu_progress_print(local_progress, 100);
3e85c6fd 2712 }
d6771bfa 2713
bb1c0597
KW
2714 qemu_vfree(buf_old);
2715 qemu_vfree(buf_new);
3e85c6fd
KW
2716 }
2717
2718 /*
2719 * Change the backing file. All clusters that are different from the old
2720 * backing file are overwritten in the COW file now, so the visible content
2721 * doesn't change when we switch the backing file.
2722 */
a616673d
AB
2723 if (out_baseimg && *out_baseimg) {
2724 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
2725 } else {
2726 ret = bdrv_change_backing_file(bs, NULL, NULL);
2727 }
2728
3e85c6fd 2729 if (ret == -ENOSPC) {
15654a6d
JS
2730 error_report("Could not change the backing file to '%s': No "
2731 "space left in the file header", out_baseimg);
3e85c6fd 2732 } else if (ret < 0) {
15654a6d 2733 error_report("Could not change the backing file to '%s': %s",
3e85c6fd
KW
2734 out_baseimg, strerror(-ret));
2735 }
2736
6b837bc4 2737 qemu_progress_print(100, 0);
3e85c6fd
KW
2738 /*
2739 * TODO At this point it is possible to check if any clusters that are
2740 * allocated in the COW file are the same in the backing file. If so, they
2741 * could be dropped from the COW file. Don't do this before switching the
2742 * backing file, in case of a crash this would lead to corruption.
2743 */
c2abccec 2744out:
6b837bc4 2745 qemu_progress_end();
3e85c6fd
KW
2746 /* Cleanup */
2747 if (!unsafe) {
26f54e9a 2748 blk_unref(blk_old_backing);
26f54e9a 2749 blk_unref(blk_new_backing);
3e85c6fd
KW
2750 }
2751
26f54e9a 2752 blk_unref(blk);
c2abccec
MK
2753 if (ret) {
2754 return 1;
2755 }
3e85c6fd
KW
2756 return 0;
2757}
2758
ae6b0ed6
SH
2759static int img_resize(int argc, char **argv)
2760{
2761 int c, ret, relative;
2762 const char *filename, *fmt, *size;
2763 int64_t n, total_size;
f382d43a 2764 bool quiet = false;
26f54e9a 2765 BlockBackend *blk = NULL;
2a81998a 2766 BlockDriverState *bs = NULL;
20caf0f7
DXW
2767 QemuOpts *param;
2768 static QemuOptsList resize_options = {
2769 .name = "resize_options",
2770 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
2771 .desc = {
2772 {
2773 .name = BLOCK_OPT_SIZE,
2774 .type = QEMU_OPT_SIZE,
2775 .help = "Virtual disk size"
2776 }, {
2777 /* end of list */
2778 }
ae6b0ed6 2779 },
ae6b0ed6
SH
2780 };
2781
e80fec7f
KW
2782 /* Remove size from argv manually so that negative numbers are not treated
2783 * as options by getopt. */
2784 if (argc < 3) {
ac1307ab 2785 error_exit("Not enough arguments");
e80fec7f
KW
2786 return 1;
2787 }
2788
2789 size = argv[--argc];
2790
2791 /* Parse getopt arguments */
ae6b0ed6
SH
2792 fmt = NULL;
2793 for(;;) {
f382d43a 2794 c = getopt(argc, argv, "f:hq");
ae6b0ed6
SH
2795 if (c == -1) {
2796 break;
2797 }
2798 switch(c) {
ef87394c 2799 case '?':
ae6b0ed6
SH
2800 case 'h':
2801 help();
2802 break;
2803 case 'f':
2804 fmt = optarg;
2805 break;
f382d43a
MR
2806 case 'q':
2807 quiet = true;
2808 break;
ae6b0ed6
SH
2809 }
2810 }
fc11eb26 2811 if (optind != argc - 1) {
ac1307ab 2812 error_exit("Expecting one image file name");
ae6b0ed6
SH
2813 }
2814 filename = argv[optind++];
ae6b0ed6
SH
2815
2816 /* Choose grow, shrink, or absolute resize mode */
2817 switch (size[0]) {
2818 case '+':
2819 relative = 1;
2820 size++;
2821 break;
2822 case '-':
2823 relative = -1;
2824 size++;
2825 break;
2826 default:
2827 relative = 0;
2828 break;
2829 }
2830
2831 /* Parse size */
87ea75d5 2832 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
20caf0f7 2833 if (qemu_opt_set(param, BLOCK_OPT_SIZE, size)) {
ae6b0ed6 2834 /* Error message already printed when size parsing fails */
2a81998a 2835 ret = -1;
20caf0f7 2836 qemu_opts_del(param);
2a81998a 2837 goto out;
ae6b0ed6 2838 }
20caf0f7
DXW
2839 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
2840 qemu_opts_del(param);
ae6b0ed6 2841
7e7d56d9
MA
2842 blk = img_open("image", filename, fmt, BDRV_O_FLAGS | BDRV_O_RDWR,
2843 true, quiet);
2844 if (!blk) {
2a81998a
JS
2845 ret = -1;
2846 goto out;
c2abccec 2847 }
7e7d56d9 2848 bs = blk_bs(blk);
ae6b0ed6
SH
2849
2850 if (relative) {
2851 total_size = bdrv_getlength(bs) + n * relative;
2852 } else {
2853 total_size = n;
2854 }
2855 if (total_size <= 0) {
15654a6d 2856 error_report("New image size must be positive");
c2abccec
MK
2857 ret = -1;
2858 goto out;
ae6b0ed6
SH
2859 }
2860
2861 ret = bdrv_truncate(bs, total_size);
2862 switch (ret) {
2863 case 0:
f382d43a 2864 qprintf(quiet, "Image resized.\n");
ae6b0ed6
SH
2865 break;
2866 case -ENOTSUP:
259b2173 2867 error_report("This image does not support resize");
ae6b0ed6
SH
2868 break;
2869 case -EACCES:
15654a6d 2870 error_report("Image is read-only");
ae6b0ed6
SH
2871 break;
2872 default:
15654a6d 2873 error_report("Error resizing image (%d)", -ret);
ae6b0ed6
SH
2874 break;
2875 }
c2abccec 2876out:
26f54e9a 2877 blk_unref(blk);
c2abccec
MK
2878 if (ret) {
2879 return 1;
2880 }
ae6b0ed6
SH
2881 return 0;
2882}
2883
76a3a34d
HR
2884static void amend_status_cb(BlockDriverState *bs,
2885 int64_t offset, int64_t total_work_size)
2886{
2887 qemu_progress_print(100.f * offset / total_work_size, 0);
2888}
2889
6f176b48
HR
2890static int img_amend(int argc, char **argv)
2891{
2892 int c, ret = 0;
2893 char *options = NULL;
83d0521a
CL
2894 QemuOptsList *create_opts = NULL;
2895 QemuOpts *opts = NULL;
bd39e6ed
HR
2896 const char *fmt = NULL, *filename, *cache;
2897 int flags;
76a3a34d 2898 bool quiet = false, progress = false;
26f54e9a 2899 BlockBackend *blk = NULL;
6f176b48
HR
2900 BlockDriverState *bs = NULL;
2901
bd39e6ed 2902 cache = BDRV_DEFAULT_CACHE;
6f176b48 2903 for (;;) {
76a3a34d 2904 c = getopt(argc, argv, "ho:f:t:pq");
6f176b48
HR
2905 if (c == -1) {
2906 break;
2907 }
2908
2909 switch (c) {
2910 case 'h':
2911 case '?':
2912 help();
2913 break;
2914 case 'o':
626f84f3
KW
2915 if (!is_valid_option_list(optarg)) {
2916 error_report("Invalid option list: %s", optarg);
2917 ret = -1;
2918 goto out;
2919 }
2920 if (!options) {
2921 options = g_strdup(optarg);
2922 } else {
2923 char *old_options = options;
2924 options = g_strdup_printf("%s,%s", options, optarg);
2925 g_free(old_options);
2926 }
6f176b48
HR
2927 break;
2928 case 'f':
2929 fmt = optarg;
2930 break;
bd39e6ed
HR
2931 case 't':
2932 cache = optarg;
2933 break;
76a3a34d
HR
2934 case 'p':
2935 progress = true;
2936 break;
6f176b48
HR
2937 case 'q':
2938 quiet = true;
2939 break;
2940 }
2941 }
2942
a283cb6e 2943 if (!options) {
ac1307ab 2944 error_exit("Must specify options (-o)");
6f176b48
HR
2945 }
2946
76a3a34d
HR
2947 if (quiet) {
2948 progress = false;
2949 }
2950 qemu_progress_init(progress, 1.0);
2951
a283cb6e
KW
2952 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
2953 if (fmt && has_help_option(options)) {
2954 /* If a format is explicitly specified (and possibly no filename is
2955 * given), print option help here */
2956 ret = print_block_option_help(filename, fmt);
2957 goto out;
6f176b48
HR
2958 }
2959
a283cb6e 2960 if (optind != argc - 1) {
b2f27e44
HR
2961 error_report("Expecting one image file name");
2962 ret = -1;
2963 goto out;
a283cb6e 2964 }
6f176b48 2965
bd39e6ed
HR
2966 flags = BDRV_O_FLAGS | BDRV_O_RDWR;
2967 ret = bdrv_parse_cache_flags(cache, &flags);
2968 if (ret < 0) {
2969 error_report("Invalid cache option: %s", cache);
2970 goto out;
2971 }
2972
7e7d56d9
MA
2973 blk = img_open("image", filename, fmt, flags, true, quiet);
2974 if (!blk) {
6f176b48
HR
2975 ret = -1;
2976 goto out;
2977 }
7e7d56d9 2978 bs = blk_bs(blk);
6f176b48
HR
2979
2980 fmt = bs->drv->format_name;
2981
626f84f3 2982 if (has_help_option(options)) {
a283cb6e 2983 /* If the format was auto-detected, print option help here */
6f176b48
HR
2984 ret = print_block_option_help(filename, fmt);
2985 goto out;
2986 }
2987
b2439d26
HR
2988 if (!bs->drv->create_opts) {
2989 error_report("Format driver '%s' does not support any options to amend",
2990 fmt);
2991 ret = -1;
2992 goto out;
2993 }
2994
c282e1fd 2995 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
83d0521a
CL
2996 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2997 if (options && qemu_opts_do_parse(opts, options, NULL)) {
6f176b48
HR
2998 error_report("Invalid options for file format '%s'", fmt);
2999 ret = -1;
3000 goto out;
3001 }
3002
76a3a34d
HR
3003 /* In case the driver does not call amend_status_cb() */
3004 qemu_progress_print(0.f, 0);
3005 ret = bdrv_amend_options(bs, opts, &amend_status_cb);
3006 qemu_progress_print(100.f, 0);
6f176b48
HR
3007 if (ret < 0) {
3008 error_report("Error while amending options: %s", strerror(-ret));
3009 goto out;
3010 }
3011
3012out:
76a3a34d
HR
3013 qemu_progress_end();
3014
26f54e9a 3015 blk_unref(blk);
83d0521a
CL
3016 qemu_opts_del(opts);
3017 qemu_opts_free(create_opts);
626f84f3
KW
3018 g_free(options);
3019
6f176b48
HR
3020 if (ret) {
3021 return 1;
3022 }
3023 return 0;
3024}
3025
c227f099 3026static const img_cmd_t img_cmds[] = {
153859be
SB
3027#define DEF(option, callback, arg_string) \
3028 { option, callback },
3029#include "qemu-img-cmds.h"
3030#undef DEF
3031#undef GEN_DOCS
3032 { NULL, NULL, },
3033};
3034
ea2384d3
FB
3035int main(int argc, char **argv)
3036{
c227f099 3037 const img_cmd_t *cmd;
153859be 3038 const char *cmdname;
2f78e491 3039 Error *local_error = NULL;
7db1689c 3040 int c;
7db1689c
JC
3041 static const struct option long_options[] = {
3042 {"help", no_argument, 0, 'h'},
5f6979cb 3043 {"version", no_argument, 0, 'v'},
7db1689c
JC
3044 {0, 0, 0, 0}
3045 };
ea2384d3 3046
526eda14
MK
3047#ifdef CONFIG_POSIX
3048 signal(SIGPIPE, SIG_IGN);
3049#endif
3050
53f76e58 3051 error_set_progname(argv[0]);
10f5bff6 3052 qemu_init_exec_dir(argv[0]);
53f76e58 3053
2f78e491 3054 if (qemu_init_main_loop(&local_error)) {
565f65d2 3055 error_report_err(local_error);
2f78e491
CN
3056 exit(EXIT_FAILURE);
3057 }
3058
ea2384d3 3059 bdrv_init();
ac1307ab
FZ
3060 if (argc < 2) {
3061 error_exit("Not enough arguments");
3062 }
153859be 3063 cmdname = argv[1];
153859be
SB
3064
3065 /* find the command */
5f6979cb 3066 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
153859be 3067 if (!strcmp(cmdname, cmd->name)) {
7db1689c 3068 return cmd->handler(argc - 1, argv + 1);
153859be 3069 }
ea2384d3 3070 }
153859be 3071
5f6979cb 3072 c = getopt_long(argc, argv, "h", long_options, NULL);
7db1689c
JC
3073
3074 if (c == 'h') {
3075 help();
3076 }
5f6979cb
JC
3077 if (c == 'v') {
3078 printf(QEMU_IMG_VERSION);
3079 return 0;
3080 }
7db1689c 3081
153859be 3082 /* not found */
ac1307ab 3083 error_exit("Command not found: %s", cmdname);
ea2384d3 3084}