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