]> git.proxmox.com Git - mirror_qemu.git/blame - qemu-img.c
virtio-iommu: Fix endianness in get_config
[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 */
452fcdbc 24
80c71a24 25#include "qemu/osdep.h"
c2a3d7da
EB
26#include <getopt.h>
27
a8d25326 28#include "qemu-common.h"
67a1de0d 29#include "qemu-version.h"
da34e65c 30#include "qapi/error.h"
3b51ab4b 31#include "qapi/qapi-commands-block-core.h"
9af23989 32#include "qapi/qapi-visit-block-core.h"
b3db211f 33#include "qapi/qobject-output-visitor.h"
7b1b5d19 34#include "qapi/qmp/qjson.h"
452fcdbc 35#include "qapi/qmp/qdict.h"
f348b6d1 36#include "qemu/cutils.h"
3babeb15 37#include "qemu/config-file.h"
1de7afc9
PB
38#include "qemu/option.h"
39#include "qemu/error-report.h"
06a1e0c1 40#include "qemu/log.h"
db725815 41#include "qemu/main-loop.h"
0b8fa32f 42#include "qemu/module.h"
98c5d2e7 43#include "qemu/sockets.h"
97ede57a 44#include "qemu/units.h"
3babeb15 45#include "qom/object_interfaces.h"
26f54e9a 46#include "sysemu/block-backend.h"
737e150e 47#include "block/block_int.h"
d4a3238a 48#include "block/blockjob.h"
f364ec65 49#include "block/qapi.h"
c2297088 50#include "crypto/init.h"
06a1e0c1 51#include "trace/control.h"
0c8c4895
ZL
52#include "qemu/throttle.h"
53#include "block/throttle-groups.h"
e8445331 54
7e563bfb 55#define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
0781dd6e 56 "\n" QEMU_COPYRIGHT "\n"
5f6979cb 57
c227f099 58typedef struct img_cmd_t {
153859be
SB
59 const char *name;
60 int (*handler)(int argc, char **argv);
c227f099 61} img_cmd_t;
153859be 62
8599ea4c
FS
63enum {
64 OPTION_OUTPUT = 256,
65 OPTION_BACKING_CHAIN = 257,
3babeb15 66 OPTION_OBJECT = 258,
eb769f74 67 OPTION_IMAGE_OPTS = 259,
b6495fa8 68 OPTION_PATTERN = 260,
55d539c8
KW
69 OPTION_FLUSH_INTERVAL = 261,
70 OPTION_NO_DRAIN = 262,
305b4c60 71 OPTION_TARGET_IMAGE_OPTS = 263,
fd03c2b8 72 OPTION_SIZE = 264,
dc5f690b 73 OPTION_PREALLOCATION = 265,
4ffca890 74 OPTION_SHRINK = 266,
8eaac025 75 OPTION_SALVAGE = 267,
168468fe 76 OPTION_TARGET_IS_ZERO = 268,
3b51ab4b
EB
77 OPTION_ADD = 269,
78 OPTION_REMOVE = 270,
79 OPTION_CLEAR = 271,
80 OPTION_ENABLE = 272,
81 OPTION_DISABLE = 273,
82 OPTION_MERGE = 274,
15e39ad9 83 OPTION_BITMAPS = 275,
a3579bfa 84 OPTION_FORCE = 276,
955171e4 85 OPTION_SKIP_BROKEN = 277,
8599ea4c
FS
86};
87
88typedef enum OutputFormat {
89 OFORMAT_JSON,
90 OFORMAT_HUMAN,
91} OutputFormat;
92
e6996143 93/* Default to cache=writeback as data integrity is not important for qemu-img */
661a0f71 94#define BDRV_DEFAULT_CACHE "writeback"
137519ce 95
00c6d403 96static void format_print(void *opaque, const char *name)
ea2384d3 97{
00c6d403 98 printf(" %s", name);
ea2384d3
FB
99}
100
ac1307ab
FZ
101static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
102{
103 va_list ap;
104
ac1307ab 105 va_start(ap, fmt);
e9e1d92d 106 error_vreport(fmt, ap);
ac1307ab
FZ
107 va_end(ap);
108
e9e1d92d 109 error_printf("Try 'qemu-img --help' for more information\n");
ac1307ab
FZ
110 exit(EXIT_FAILURE);
111}
112
c9192973
SH
113static void QEMU_NORETURN missing_argument(const char *option)
114{
115 error_exit("missing argument for option '%s'", option);
116}
117
118static void QEMU_NORETURN unrecognized_option(const char *option)
119{
120 error_exit("unrecognized option '%s'", option);
121}
122
0562adf5 123/* Please keep in synch with docs/tools/qemu-img.rst */
ac1307ab 124static void QEMU_NORETURN help(void)
ea2384d3 125{
e00291c0 126 const char *help_msg =
5f6979cb 127 QEMU_IMG_VERSION
10985131 128 "usage: qemu-img [standard options] command [command options]\n"
3f020d70 129 "QEMU disk image utility\n"
130 "\n"
10985131
DL
131 " '-h', '--help' display this help and exit\n"
132 " '-V', '--version' output version information and exit\n"
06a1e0c1
DL
133 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
134 " specify tracing options\n"
10985131 135 "\n"
3f020d70 136 "Command syntax:\n"
153859be
SB
137#define DEF(option, callback, arg_string) \
138 " " arg_string "\n"
139#include "qemu-img-cmds.h"
140#undef DEF
3f020d70 141 "\n"
142 "Command parameters:\n"
143 " 'filename' is a disk image filename\n"
3babeb15
DB
144 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
145 " manual page for a description of the object properties. The most common\n"
146 " object type is a 'secret', which is used to supply passwords and/or\n"
147 " encryption keys.\n"
3f020d70 148 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
661a0f71 149 " 'cache' is the cache mode used to write the output disk image, the valid\n"
80ccf93b
LY
150 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
151 " 'directsync' and 'unsafe' (default for convert)\n"
bb87fdf8
SH
152 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
153 " options are the same as for the 'cache' option\n"
3f020d70 154 " 'size' is the disk image size in bytes. Optional suffixes\n"
5e00984a
KW
155 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
156 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
157 " supported. 'b' is ignored.\n"
3f020d70 158 " 'output_filename' is the destination disk image filename\n"
159 " 'output_fmt' is the destination format\n"
160 " 'options' is a comma separated list of format specific options in a\n"
161 " name=value format. Use -o ? for an overview of the options supported by the\n"
162 " used format\n"
ef80654d
WX
163 " 'snapshot_param' is param used for internal snapshot, format\n"
164 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
165 " '[ID_OR_NAME]'\n"
3f020d70 166 " '-c' indicates that target image must be compressed (qcow format only)\n"
6e6e55f5
JS
167 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
168 " new backing file match exactly. The image doesn't need a working\n"
169 " backing file before rebasing in this case (useful for renaming the\n"
170 " backing file). For image creation, allow creating without attempting\n"
171 " to open the backing file.\n"
3f020d70 172 " '-h' with or without a command shows this help and lists the supported formats\n"
6b837bc4 173 " '-p' show progress of command (only certain commands)\n"
f382d43a 174 " '-q' use Quiet mode - do not print any output (except errors)\n"
11b6699a
PL
175 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
176 " contain only zeros for qemu-img to create a sparse image during\n"
177 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
178 " unallocated or zero sectors, and the destination image will always be\n"
179 " fully allocated\n"
c054b3fd 180 " '--output' takes the format in which the output must be done (human or json)\n"
b2e10493
AD
181 " '-n' skips the target volume creation (useful if the volume is created\n"
182 " prior to running qemu-img)\n"
3f020d70 183 "\n"
3b51ab4b
EB
184 "Parameters to bitmap subcommand:\n"
185 " 'bitmap' is the name of the bitmap to manipulate, through one or more\n"
186 " actions from '--add', '--remove', '--clear', '--enable', '--disable',\n"
187 " or '--merge source'\n"
188 " '-g granularity' sets the granularity for '--add' actions\n"
189 " '-b source' and '-F src_fmt' tell '--merge' actions to find the source\n"
190 " bitmaps from an alternative file\n"
191 "\n"
4534ff54
KW
192 "Parameters to check subcommand:\n"
193 " '-r' tries to repair any inconsistencies that are found during the check.\n"
194 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
195 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
0546b8c2 196 " hiding corruption that has already occurred.\n"
4534ff54 197 "\n"
2d9187bc 198 "Parameters to convert subcommand:\n"
15e39ad9 199 " '--bitmaps' copies all top-level persistent bitmaps to destination\n"
2d9187bc
PL
200 " '-m' specifies how many coroutines work in parallel during the convert\n"
201 " process (defaults to 8)\n"
202 " '-W' allow to write to the target out of order rather than sequential\n"
203 "\n"
3f020d70 204 "Parameters to snapshot subcommand:\n"
205 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
206 " '-a' applies a snapshot (revert disk to saved state)\n"
207 " '-c' creates a snapshot\n"
208 " '-d' deletes a snapshot\n"
d14ed18c
MR
209 " '-l' lists all snapshots in the given image\n"
210 "\n"
211 "Parameters to compare subcommand:\n"
212 " '-f' first image format\n"
213 " '-F' second image format\n"
86ce1f6e
RS
214 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
215 "\n"
216 "Parameters to dd subcommand:\n"
217 " 'bs=BYTES' read and write up to BYTES bytes at a time "
218 "(default: 512)\n"
219 " 'count=N' copy only N input blocks\n"
220 " 'if=FILE' read from FILE\n"
f7c15533
RS
221 " 'of=FILE' write to FILE\n"
222 " 'skip=N' skip N bs-sized blocks at the start of input\n";
e00291c0
PB
223
224 printf("%s\nSupported formats:", help_msg);
9ac404c5 225 bdrv_iterate_format(format_print, NULL, false);
f5048cb7 226 printf("\n\n" QEMU_HELP_BOTTOM "\n");
ac1307ab 227 exit(EXIT_SUCCESS);
ea2384d3
FB
228}
229
80c710cb
MA
230/*
231 * Is @optarg safe for accumulate_options()?
232 * It is when multiple of them can be joined together separated by ','.
233 * To make that work, @optarg must not start with ',' (or else a
234 * separating ',' preceding it gets escaped), and it must not end with
235 * an odd number of ',' (or else a separating ',' following it gets
f62514b3
MA
236 * escaped), or be empty (or else a separating ',' preceding it can
237 * escape a separating ',' following it).
238 *
80c710cb
MA
239 */
240static bool is_valid_option_list(const char *optarg)
241{
242 size_t len = strlen(optarg);
243 size_t i;
244
f62514b3 245 if (!optarg[0] || optarg[0] == ',') {
80c710cb
MA
246 return false;
247 }
248
249 for (i = len; i > 0 && optarg[i - 1] == ','; i--) {
250 }
251 if ((len - i) % 2) {
252 return false;
253 }
254
255 return true;
c6e5cdfd
KW
256}
257
6d2b5cba
MA
258static int accumulate_options(char **options, char *optarg)
259{
260 char *new_options;
261
262 if (!is_valid_option_list(optarg)) {
263 error_report("Invalid option list: %s", optarg);
264 return -1;
265 }
266
267 if (!*options) {
268 *options = g_strdup(optarg);
269 } else {
270 new_options = g_strdup_printf("%s,%s", *options, optarg);
271 g_free(*options);
272 *options = new_options;
273 }
274 return 0;
275}
276
eb769f74
DB
277static QemuOptsList qemu_source_opts = {
278 .name = "source",
279 .implied_opt_name = "file",
280 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
281 .desc = {
282 { }
283 },
284};
285
7c30f657 286static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
f382d43a
MR
287{
288 int ret = 0;
289 if (!quiet) {
290 va_list args;
291 va_start(args, fmt);
292 ret = vprintf(fmt, args);
293 va_end(args);
294 }
295 return ret;
296}
297
ea2384d3 298
4ac8aacd
JS
299static int print_block_option_help(const char *filename, const char *fmt)
300{
301 BlockDriver *drv, *proto_drv;
83d0521a 302 QemuOptsList *create_opts = NULL;
b65a5e12 303 Error *local_err = NULL;
4ac8aacd
JS
304
305 /* Find driver and parse its options */
306 drv = bdrv_find_format(fmt);
307 if (!drv) {
15654a6d 308 error_report("Unknown file format '%s'", fmt);
4ac8aacd
JS
309 return 1;
310 }
311
d402b6a2
HR
312 if (!drv->create_opts) {
313 error_report("Format driver '%s' does not support image creation", fmt);
314 return 1;
315 }
316
c282e1fd 317 create_opts = qemu_opts_append(create_opts, drv->create_opts);
a283cb6e 318 if (filename) {
b65a5e12 319 proto_drv = bdrv_find_protocol(filename, true, &local_err);
a283cb6e 320 if (!proto_drv) {
2867ce4a 321 error_report_err(local_err);
83d0521a 322 qemu_opts_free(create_opts);
a283cb6e
KW
323 return 1;
324 }
d402b6a2 325 if (!proto_drv->create_opts) {
f0998879 326 error_report("Protocol driver '%s' does not support image creation",
d402b6a2 327 proto_drv->format_name);
3ecd5a4f 328 qemu_opts_free(create_opts);
d402b6a2
HR
329 return 1;
330 }
c282e1fd 331 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
a283cb6e
KW
332 }
333
f4619af0
HR
334 if (filename) {
335 printf("Supported options:\n");
336 } else {
337 printf("Supported %s options:\n", fmt);
338 }
63898712 339 qemu_opts_print_help(create_opts, false);
83d0521a 340 qemu_opts_free(create_opts);
f4619af0
HR
341
342 if (!filename) {
343 printf("\n"
344 "The protocol level may support further options.\n"
345 "Specify the target filename to include those options.\n");
346 }
347
4ac8aacd
JS
348 return 0;
349}
350
eb769f74 351
efaa7c4e 352static BlockBackend *img_open_opts(const char *optstr,
ce099547 353 QemuOpts *opts, int flags, bool writethrough,
335e9937 354 bool quiet, bool force_share)
eb769f74
DB
355{
356 QDict *options;
357 Error *local_err = NULL;
358 BlockBackend *blk;
359 options = qemu_opts_to_qdict(opts, NULL);
335e9937
FZ
360 if (force_share) {
361 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
4615f878 362 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
335e9937 363 error_report("--force-share/-U conflicts with image options");
cb3e7f08 364 qobject_unref(options);
335e9937
FZ
365 return NULL;
366 }
4615f878 367 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
335e9937 368 }
efaa7c4e 369 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
eb769f74 370 if (!blk) {
143605a2 371 error_reportf_err(local_err, "Could not open '%s': ", optstr);
eb769f74
DB
372 return NULL;
373 }
ce099547 374 blk_set_enable_write_cache(blk, !writethrough);
eb769f74 375
eb769f74
DB
376 return blk;
377}
378
efaa7c4e 379static BlockBackend *img_open_file(const char *filename,
29cf9336 380 QDict *options,
eb769f74 381 const char *fmt, int flags,
335e9937
FZ
382 bool writethrough, bool quiet,
383 bool force_share)
eb769f74
DB
384{
385 BlockBackend *blk;
34b5d2c6 386 Error *local_err = NULL;
ad717139 387
29cf9336
DB
388 if (!options) {
389 options = qdict_new();
390 }
75c23805 391 if (fmt) {
46f5ac20 392 qdict_put_str(options, "driver", fmt);
75c23805 393 }
b9eaf9ec 394
335e9937 395 if (force_share) {
579cf1d1 396 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
335e9937 397 }
efaa7c4e 398 blk = blk_new_open(filename, NULL, options, flags, &local_err);
5bd31326 399 if (!blk) {
c29b77f9 400 error_reportf_err(local_err, "Could not open '%s': ", filename);
eb769f74 401 return NULL;
75c23805 402 }
ce099547 403 blk_set_enable_write_cache(blk, !writethrough);
b9eaf9ec 404
eb769f74
DB
405 return blk;
406}
407
408
29cf9336
DB
409static int img_add_key_secrets(void *opaque,
410 const char *name, const char *value,
411 Error **errp)
412{
413 QDict *options = opaque;
414
415 if (g_str_has_suffix(name, "key-secret")) {
187f47e9 416 qdict_put_str(options, name, value);
29cf9336
DB
417 }
418
419 return 0;
420}
421
29cf9336 422
efaa7c4e 423static BlockBackend *img_open(bool image_opts,
eb769f74 424 const char *filename,
ce099547 425 const char *fmt, int flags, bool writethrough,
335e9937 426 bool quiet, bool force_share)
eb769f74
DB
427{
428 BlockBackend *blk;
429 if (image_opts) {
430 QemuOpts *opts;
431 if (fmt) {
432 error_report("--image-opts and --format are mutually exclusive");
433 return NULL;
434 }
435 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
436 filename, true);
437 if (!opts) {
438 return NULL;
439 }
335e9937
FZ
440 blk = img_open_opts(filename, opts, flags, writethrough, quiet,
441 force_share);
eb769f74 442 } else {
29cf9336 443 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
335e9937 444 force_share);
75c23805 445 }
7e7d56d9 446 return blk;
75c23805
FB
447}
448
eb769f74 449
83d0521a 450static int add_old_style_options(const char *fmt, QemuOpts *opts,
eec77d9e
JS
451 const char *base_filename,
452 const char *base_fmt)
efa84d43 453{
efa84d43 454 if (base_filename) {
235e59cf 455 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename,
9e194e06 456 NULL)) {
15654a6d
JS
457 error_report("Backing file not supported for file format '%s'",
458 fmt);
c2abccec 459 return -1;
efa84d43
KW
460 }
461 }
462 if (base_fmt) {
9e194e06 463 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, NULL)) {
15654a6d
JS
464 error_report("Backing file format not supported for file "
465 "format '%s'", fmt);
c2abccec 466 return -1;
efa84d43
KW
467 }
468 }
c2abccec 469 return 0;
efa84d43
KW
470}
471
43d589b0
EM
472static int64_t cvtnum_full(const char *name, const char *value, int64_t min,
473 int64_t max)
606caa0a 474{
f17fd4fd 475 int err;
43d589b0
EM
476 uint64_t res;
477
478 err = qemu_strtosz(value, NULL, &res);
479 if (err < 0 && err != -ERANGE) {
480 error_report("Invalid %s specified. You may use "
481 "k, M, G, T, P or E suffixes for", name);
482 error_report("kilobytes, megabytes, gigabytes, terabytes, "
483 "petabytes and exabytes.");
f17fd4fd
MA
484 return err;
485 }
43d589b0
EM
486 if (err == -ERANGE || res > max || res < min) {
487 error_report("Invalid %s specified. Must be between %" PRId64
488 " and %" PRId64 ".", name, min, max);
f46bfdbf
MA
489 return -ERANGE;
490 }
43d589b0
EM
491 return res;
492}
493
494static int64_t cvtnum(const char *name, const char *value)
495{
496 return cvtnum_full(name, value, 0, INT64_MAX);
606caa0a
MA
497}
498
ea2384d3
FB
499static int img_create(int argc, char **argv)
500{
a9300911 501 int c;
1da7cfbd 502 uint64_t img_size = -1;
ea2384d3 503 const char *fmt = "raw";
9230eaf6 504 const char *base_fmt = NULL;
ea2384d3
FB
505 const char *filename;
506 const char *base_filename = NULL;
9ea2ea71 507 char *options = NULL;
9b37525a 508 Error *local_err = NULL;
f382d43a 509 bool quiet = false;
6e6e55f5 510 int flags = 0;
3b46e624 511
ea2384d3 512 for(;;) {
3babeb15
DB
513 static const struct option long_options[] = {
514 {"help", no_argument, 0, 'h'},
515 {"object", required_argument, 0, OPTION_OBJECT},
516 {0, 0, 0, 0}
517 };
6e6e55f5 518 c = getopt_long(argc, argv, ":F:b:f:ho:qu",
3babeb15 519 long_options, NULL);
b8fb60da 520 if (c == -1) {
ea2384d3 521 break;
b8fb60da 522 }
ea2384d3 523 switch(c) {
c9192973
SH
524 case ':':
525 missing_argument(argv[optind - 1]);
526 break;
ef87394c 527 case '?':
c9192973
SH
528 unrecognized_option(argv[optind - 1]);
529 break;
ea2384d3
FB
530 case 'h':
531 help();
532 break;
9230eaf6
AL
533 case 'F':
534 base_fmt = optarg;
535 break;
ea2384d3
FB
536 case 'b':
537 base_filename = optarg;
538 break;
539 case 'f':
540 fmt = optarg;
541 break;
9ea2ea71 542 case 'o':
6d2b5cba 543 if (accumulate_options(&options, optarg) < 0) {
77386bf6
KW
544 goto fail;
545 }
9ea2ea71 546 break;
f382d43a
MR
547 case 'q':
548 quiet = true;
549 break;
6e6e55f5
JS
550 case 'u':
551 flags |= BDRV_O_NO_BACKING;
552 break;
99b1e646
KW
553 case OPTION_OBJECT:
554 user_creatable_process_cmdline(optarg);
555 break;
ea2384d3
FB
556 }
557 }
9230eaf6 558
b50cbabc 559 /* Get the filename */
a283cb6e
KW
560 filename = (optind < argc) ? argv[optind] : NULL;
561 if (options && has_help_option(options)) {
562 g_free(options);
563 return print_block_option_help(filename, fmt);
564 }
565
b8fb60da 566 if (optind >= argc) {
ac1307ab 567 error_exit("Expecting image file name");
b8fb60da 568 }
a283cb6e 569 optind++;
b50cbabc 570
1da7cfbd
JS
571 /* Get image size, if specified */
572 if (optind < argc) {
70b4f4bb 573 int64_t sval;
606caa0a 574
43d589b0 575 sval = cvtnum("image size", argv[optind++]);
606caa0a 576 if (sval < 0) {
77386bf6 577 goto fail;
1da7cfbd
JS
578 }
579 img_size = (uint64_t)sval;
580 }
fc11eb26 581 if (optind != argc) {
ac1307ab 582 error_exit("Unexpected argument: %s", argv[optind]);
fc11eb26 583 }
1da7cfbd 584
9b37525a 585 bdrv_img_create(filename, fmt, base_filename, base_fmt,
6e6e55f5 586 options, img_size, flags, quiet, &local_err);
84d18f06 587 if (local_err) {
c29b77f9 588 error_reportf_err(local_err, "%s: ", filename);
77386bf6 589 goto fail;
c2abccec 590 }
a9300911 591
77386bf6 592 g_free(options);
ea2384d3 593 return 0;
77386bf6
KW
594
595fail:
596 g_free(options);
597 return 1;
ea2384d3
FB
598}
599
f382d43a 600static void dump_json_image_check(ImageCheck *check, bool quiet)
8599ea4c 601{
eab3a467 602 GString *str;
8599ea4c 603 QObject *obj;
7d5e199a 604 Visitor *v = qobject_output_visitor_new(&obj);
3b098d56
EB
605
606 visit_type_ImageCheck(v, NULL, &check, &error_abort);
607 visit_complete(v, &obj);
6589f459 608 str = qobject_to_json_pretty(obj, true);
8599ea4c 609 assert(str != NULL);
eab3a467 610 qprintf(quiet, "%s\n", str->str);
cb3e7f08 611 qobject_unref(obj);
3b098d56 612 visit_free(v);
eab3a467 613 g_string_free(str, true);
8599ea4c
FS
614}
615
f382d43a 616static void dump_human_image_check(ImageCheck *check, bool quiet)
8599ea4c
FS
617{
618 if (!(check->corruptions || check->leaks || check->check_errors)) {
f382d43a 619 qprintf(quiet, "No errors were found on the image.\n");
8599ea4c
FS
620 } else {
621 if (check->corruptions) {
f382d43a
MR
622 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
623 "Data may be corrupted, or further writes to the image "
624 "may corrupt it.\n",
625 check->corruptions);
8599ea4c
FS
626 }
627
628 if (check->leaks) {
f382d43a
MR
629 qprintf(quiet,
630 "\n%" PRId64 " leaked clusters were found on the image.\n"
631 "This means waste of disk space, but no harm to data.\n",
632 check->leaks);
8599ea4c
FS
633 }
634
635 if (check->check_errors) {
f382d43a
MR
636 qprintf(quiet,
637 "\n%" PRId64
638 " internal errors have occurred during the check.\n",
639 check->check_errors);
8599ea4c
FS
640 }
641 }
642
643 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
f382d43a
MR
644 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
645 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
646 check->allocated_clusters, check->total_clusters,
647 check->allocated_clusters * 100.0 / check->total_clusters,
648 check->fragmented_clusters * 100.0 / check->allocated_clusters,
649 check->compressed_clusters * 100.0 /
650 check->allocated_clusters);
8599ea4c
FS
651 }
652
653 if (check->image_end_offset) {
f382d43a
MR
654 qprintf(quiet,
655 "Image end offset: %" PRId64 "\n", check->image_end_offset);
8599ea4c
FS
656 }
657}
658
659static int collect_image_check(BlockDriverState *bs,
660 ImageCheck *check,
661 const char *filename,
662 const char *fmt,
663 int fix)
664{
665 int ret;
666 BdrvCheckResult result;
667
668 ret = bdrv_check(bs, &result, fix);
669 if (ret < 0) {
670 return ret;
671 }
672
673 check->filename = g_strdup(filename);
674 check->format = g_strdup(bdrv_get_format_name(bs));
675 check->check_errors = result.check_errors;
676 check->corruptions = result.corruptions;
677 check->has_corruptions = result.corruptions != 0;
678 check->leaks = result.leaks;
679 check->has_leaks = result.leaks != 0;
680 check->corruptions_fixed = result.corruptions_fixed;
1656324e 681 check->has_corruptions_fixed = result.corruptions_fixed != 0;
8599ea4c 682 check->leaks_fixed = result.leaks_fixed;
1656324e 683 check->has_leaks_fixed = result.leaks_fixed != 0;
8599ea4c
FS
684 check->image_end_offset = result.image_end_offset;
685 check->has_image_end_offset = result.image_end_offset != 0;
686 check->total_clusters = result.bfi.total_clusters;
687 check->has_total_clusters = result.bfi.total_clusters != 0;
688 check->allocated_clusters = result.bfi.allocated_clusters;
689 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
690 check->fragmented_clusters = result.bfi.fragmented_clusters;
691 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
e6439d78
SH
692 check->compressed_clusters = result.bfi.compressed_clusters;
693 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
8599ea4c
FS
694
695 return 0;
696}
697
e076f338
KW
698/*
699 * Checks an image for consistency. Exit codes:
700 *
d6635c4d
HR
701 * 0 - Check completed, image is good
702 * 1 - Check not completed because of internal errors
703 * 2 - Check completed, image is corrupted
704 * 3 - Check completed, image has leaked clusters, but is good otherwise
705 * 63 - Checks are not supported by the image format
e076f338 706 */
1585969c
AL
707static int img_check(int argc, char **argv)
708{
709 int c, ret;
8599ea4c 710 OutputFormat output_format = OFORMAT_HUMAN;
40055951 711 const char *filename, *fmt, *output, *cache;
26f54e9a 712 BlockBackend *blk;
1585969c 713 BlockDriverState *bs;
4534ff54 714 int fix = 0;
ce099547
KW
715 int flags = BDRV_O_CHECK;
716 bool writethrough;
7e7d56d9 717 ImageCheck *check;
f382d43a 718 bool quiet = false;
eb769f74 719 bool image_opts = false;
335e9937 720 bool force_share = false;
1585969c
AL
721
722 fmt = NULL;
8599ea4c 723 output = NULL;
40055951 724 cache = BDRV_DEFAULT_CACHE;
ce099547 725
1585969c 726 for(;;) {
8599ea4c
FS
727 int option_index = 0;
728 static const struct option long_options[] = {
729 {"help", no_argument, 0, 'h'},
730 {"format", required_argument, 0, 'f'},
4fd6a984 731 {"repair", required_argument, 0, 'r'},
8599ea4c 732 {"output", required_argument, 0, OPTION_OUTPUT},
3babeb15 733 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 734 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 735 {"force-share", no_argument, 0, 'U'},
8599ea4c
FS
736 {0, 0, 0, 0}
737 };
335e9937 738 c = getopt_long(argc, argv, ":hf:r:T:qU",
8599ea4c 739 long_options, &option_index);
b8fb60da 740 if (c == -1) {
1585969c 741 break;
b8fb60da 742 }
1585969c 743 switch(c) {
c9192973
SH
744 case ':':
745 missing_argument(argv[optind - 1]);
746 break;
ef87394c 747 case '?':
c9192973
SH
748 unrecognized_option(argv[optind - 1]);
749 break;
1585969c
AL
750 case 'h':
751 help();
752 break;
753 case 'f':
754 fmt = optarg;
755 break;
4534ff54
KW
756 case 'r':
757 flags |= BDRV_O_RDWR;
758
759 if (!strcmp(optarg, "leaks")) {
760 fix = BDRV_FIX_LEAKS;
761 } else if (!strcmp(optarg, "all")) {
762 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
763 } else {
ac1307ab
FZ
764 error_exit("Unknown option value for -r "
765 "(expecting 'leaks' or 'all'): %s", optarg);
4534ff54
KW
766 }
767 break;
8599ea4c
FS
768 case OPTION_OUTPUT:
769 output = optarg;
770 break;
40055951
HR
771 case 'T':
772 cache = optarg;
773 break;
f382d43a
MR
774 case 'q':
775 quiet = true;
776 break;
335e9937
FZ
777 case 'U':
778 force_share = true;
779 break;
99b1e646
KW
780 case OPTION_OBJECT:
781 user_creatable_process_cmdline(optarg);
782 break;
eb769f74
DB
783 case OPTION_IMAGE_OPTS:
784 image_opts = true;
785 break;
1585969c
AL
786 }
787 }
fc11eb26 788 if (optind != argc - 1) {
ac1307ab 789 error_exit("Expecting one image file name");
b8fb60da 790 }
1585969c
AL
791 filename = argv[optind++];
792
8599ea4c
FS
793 if (output && !strcmp(output, "json")) {
794 output_format = OFORMAT_JSON;
795 } else if (output && !strcmp(output, "human")) {
796 output_format = OFORMAT_HUMAN;
797 } else if (output) {
798 error_report("--output must be used with human or json as argument.");
799 return 1;
800 }
801
ce099547 802 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
40055951
HR
803 if (ret < 0) {
804 error_report("Invalid source cache option: %s", cache);
805 return 1;
806 }
807
335e9937
FZ
808 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
809 force_share);
7e7d56d9
MA
810 if (!blk) {
811 return 1;
c2abccec 812 }
7e7d56d9 813 bs = blk_bs(blk);
8599ea4c
FS
814
815 check = g_new0(ImageCheck, 1);
816 ret = collect_image_check(bs, check, filename, fmt, fix);
e076f338
KW
817
818 if (ret == -ENOTSUP) {
55d492d7 819 error_report("This image format does not support checks");
fefddf95 820 ret = 63;
8599ea4c 821 goto fail;
e076f338
KW
822 }
823
8599ea4c
FS
824 if (check->corruptions_fixed || check->leaks_fixed) {
825 int corruptions_fixed, leaks_fixed;
1656324e 826 bool has_leaks_fixed, has_corruptions_fixed;
ccf34716 827
8599ea4c 828 leaks_fixed = check->leaks_fixed;
1656324e 829 has_leaks_fixed = check->has_leaks_fixed;
8599ea4c 830 corruptions_fixed = check->corruptions_fixed;
1656324e 831 has_corruptions_fixed = check->has_corruptions_fixed;
e076f338 832
8599ea4c 833 if (output_format == OFORMAT_HUMAN) {
f382d43a
MR
834 qprintf(quiet,
835 "The following inconsistencies were found and repaired:\n\n"
836 " %" PRId64 " leaked clusters\n"
837 " %" PRId64 " corruptions\n\n"
838 "Double checking the fixed image now...\n",
839 check->leaks_fixed,
840 check->corruptions_fixed);
e076f338
KW
841 }
842
fc124ea1
PN
843 qapi_free_ImageCheck(check);
844 check = g_new0(ImageCheck, 1);
8599ea4c 845 ret = collect_image_check(bs, check, filename, fmt, 0);
1585969c 846
8599ea4c 847 check->leaks_fixed = leaks_fixed;
1656324e 848 check->has_leaks_fixed = has_leaks_fixed;
8599ea4c 849 check->corruptions_fixed = corruptions_fixed;
1656324e 850 check->has_corruptions_fixed = has_corruptions_fixed;
f8111c24
DXW
851 }
852
832390a5
HR
853 if (!ret) {
854 switch (output_format) {
855 case OFORMAT_HUMAN:
856 dump_human_image_check(check, quiet);
857 break;
858 case OFORMAT_JSON:
859 dump_json_image_check(check, quiet);
860 break;
861 }
c6bb9ad1
FS
862 }
863
8599ea4c 864 if (ret || check->check_errors) {
832390a5
HR
865 if (ret) {
866 error_report("Check failed: %s", strerror(-ret));
867 } else {
868 error_report("Check failed");
869 }
8599ea4c
FS
870 ret = 1;
871 goto fail;
c2abccec 872 }
e076f338 873
8599ea4c
FS
874 if (check->corruptions) {
875 ret = 2;
876 } else if (check->leaks) {
877 ret = 3;
e076f338 878 } else {
8599ea4c 879 ret = 0;
e076f338 880 }
8599ea4c
FS
881
882fail:
883 qapi_free_ImageCheck(check);
26f54e9a 884 blk_unref(blk);
8599ea4c 885 return ret;
1585969c
AL
886}
887
d4a3238a
HR
888typedef struct CommonBlockJobCBInfo {
889 BlockDriverState *bs;
890 Error **errp;
891} CommonBlockJobCBInfo;
892
893static void common_block_job_cb(void *opaque, int ret)
894{
895 CommonBlockJobCBInfo *cbi = opaque;
896
897 if (ret < 0) {
898 error_setg_errno(cbi->errp, -ret, "Block job failed");
899 }
d4a3238a
HR
900}
901
902static void run_block_job(BlockJob *job, Error **errp)
903{
a7b4f8fc 904 uint64_t progress_current, progress_total;
b75536c9 905 AioContext *aio_context = blk_get_aio_context(job->blk);
4172a003 906 int ret = 0;
d4a3238a 907
9e944cb4 908 aio_context_acquire(aio_context);
80fa2c75 909 job_ref(&job->job);
d4a3238a 910 do {
30a5c887 911 float progress = 0.0f;
d4a3238a 912 aio_poll(aio_context, true);
a7b4f8fc
EGE
913
914 progress_get_snapshot(&job->job.progress, &progress_current,
915 &progress_total);
916 if (progress_total) {
917 progress = (float)progress_current / progress_total * 100.f;
30a5c887
KW
918 }
919 qemu_progress_print(progress, 0);
df956ae2 920 } while (!job_is_ready(&job->job) && !job_is_completed(&job->job));
d4a3238a 921
dbe5e6c1 922 if (!job_is_completed(&job->job)) {
3d70ff53 923 ret = job_complete_sync(&job->job, errp);
4172a003 924 } else {
4ad35181 925 ret = job->job.ret;
4172a003 926 }
80fa2c75 927 job_unref(&job->job);
9e944cb4 928 aio_context_release(aio_context);
687fa1d8 929
4172a003
SJ
930 /* publish completion progress only when success */
931 if (!ret) {
932 qemu_progress_print(100.f, 0);
933 }
d4a3238a
HR
934}
935
ea2384d3
FB
936static int img_commit(int argc, char **argv)
937{
661a0f71 938 int c, ret, flags;
1b22bffd 939 const char *filename, *fmt, *cache, *base;
26f54e9a 940 BlockBackend *blk;
d4a3238a 941 BlockDriverState *bs, *base_bs;
4ef85a9c 942 BlockJob *job;
687fa1d8 943 bool progress = false, quiet = false, drop = false;
ce099547 944 bool writethrough;
d4a3238a
HR
945 Error *local_err = NULL;
946 CommonBlockJobCBInfo cbi;
eb769f74 947 bool image_opts = false;
9e944cb4 948 AioContext *aio_context;
a0441b66 949 int64_t rate_limit = 0;
ea2384d3
FB
950
951 fmt = NULL;
661a0f71 952 cache = BDRV_DEFAULT_CACHE;
1b22bffd 953 base = NULL;
ea2384d3 954 for(;;) {
3babeb15
DB
955 static const struct option long_options[] = {
956 {"help", no_argument, 0, 'h'},
957 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 958 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3babeb15
DB
959 {0, 0, 0, 0}
960 };
a0441b66 961 c = getopt_long(argc, argv, ":f:ht:b:dpqr:",
3babeb15 962 long_options, NULL);
b8fb60da 963 if (c == -1) {
ea2384d3 964 break;
b8fb60da 965 }
ea2384d3 966 switch(c) {
c9192973
SH
967 case ':':
968 missing_argument(argv[optind - 1]);
969 break;
ef87394c 970 case '?':
c9192973
SH
971 unrecognized_option(argv[optind - 1]);
972 break;
ea2384d3
FB
973 case 'h':
974 help();
975 break;
976 case 'f':
977 fmt = optarg;
978 break;
661a0f71
FS
979 case 't':
980 cache = optarg;
981 break;
1b22bffd
HR
982 case 'b':
983 base = optarg;
984 /* -b implies -d */
985 drop = true;
986 break;
9a86fe48
HR
987 case 'd':
988 drop = true;
989 break;
687fa1d8
HR
990 case 'p':
991 progress = true;
992 break;
f382d43a
MR
993 case 'q':
994 quiet = true;
995 break;
a0441b66
ZL
996 case 'r':
997 rate_limit = cvtnum("rate limit", optarg);
998 if (rate_limit < 0) {
999 return 1;
1000 }
1001 break;
99b1e646
KW
1002 case OPTION_OBJECT:
1003 user_creatable_process_cmdline(optarg);
1004 break;
eb769f74
DB
1005 case OPTION_IMAGE_OPTS:
1006 image_opts = true;
1007 break;
ea2384d3
FB
1008 }
1009 }
687fa1d8
HR
1010
1011 /* Progress is not shown in Quiet mode */
1012 if (quiet) {
1013 progress = false;
1014 }
1015
fc11eb26 1016 if (optind != argc - 1) {
ac1307ab 1017 error_exit("Expecting one image file name");
b8fb60da 1018 }
ea2384d3
FB
1019 filename = argv[optind++];
1020
9a86fe48 1021 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
ce099547 1022 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
661a0f71
FS
1023 if (ret < 0) {
1024 error_report("Invalid cache option: %s", cache);
a3981eb9 1025 return 1;
661a0f71
FS
1026 }
1027
335e9937
FZ
1028 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
1029 false);
7e7d56d9
MA
1030 if (!blk) {
1031 return 1;
c2abccec 1032 }
7e7d56d9
MA
1033 bs = blk_bs(blk);
1034
687fa1d8
HR
1035 qemu_progress_init(progress, 1.f);
1036 qemu_progress_print(0.f, 100);
1037
1b22bffd
HR
1038 if (base) {
1039 base_bs = bdrv_find_backing_image(bs, base);
1040 if (!base_bs) {
6b33f3ae
HR
1041 error_setg(&local_err,
1042 "Did not find '%s' in the backing chain of '%s'",
1043 base, filename);
1b22bffd
HR
1044 goto done;
1045 }
1046 } else {
1047 /* This is different from QMP, which by default uses the deepest file in
1048 * the backing chain (i.e., the very base); however, the traditional
1049 * behavior of qemu-img commit is using the immediate backing file. */
4a2061e6 1050 base_bs = bdrv_backing_chain_next(bs);
1b22bffd
HR
1051 if (!base_bs) {
1052 error_setg(&local_err, "Image does not have a backing file");
1053 goto done;
1054 }
d4a3238a
HR
1055 }
1056
1057 cbi = (CommonBlockJobCBInfo){
1058 .errp = &local_err,
1059 .bs = bs,
1060 };
1061
9e944cb4
PB
1062 aio_context = bdrv_get_aio_context(bs);
1063 aio_context_acquire(aio_context);
a0441b66 1064 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, rate_limit,
0db832f4 1065 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
78bbd910 1066 &cbi, false, &local_err);
9e944cb4 1067 aio_context_release(aio_context);
d4a3238a
HR
1068 if (local_err) {
1069 goto done;
ea2384d3
FB
1070 }
1071
3f09bfbc
KW
1072 /* When the block job completes, the BlockBackend reference will point to
1073 * the old backing file. In order to avoid that the top image is already
1074 * deleted, so we can still empty it afterwards, increment the reference
1075 * counter here preemptively. */
9a86fe48 1076 if (!drop) {
3f09bfbc 1077 bdrv_ref(bs);
9a86fe48
HR
1078 }
1079
4ef85a9c 1080 job = block_job_get("commit");
2e2db260 1081 assert(job);
4ef85a9c 1082 run_block_job(job, &local_err);
9a86fe48
HR
1083 if (local_err) {
1084 goto unref_backing;
1085 }
1086
2d97fde4
HR
1087 if (!drop) {
1088 BlockBackend *old_backing_blk;
1089
1090 old_backing_blk = blk_new_with_bs(bs, BLK_PERM_WRITE, BLK_PERM_ALL,
1091 &local_err);
1092 if (!old_backing_blk) {
1093 goto unref_backing;
1094 }
1095 ret = blk_make_empty(old_backing_blk, &local_err);
1096 blk_unref(old_backing_blk);
1097 if (ret == -ENOTSUP) {
1098 error_free(local_err);
1099 local_err = NULL;
1100 } else if (ret < 0) {
9a86fe48
HR
1101 goto unref_backing;
1102 }
1103 }
1104
1105unref_backing:
1106 if (!drop) {
3f09bfbc 1107 bdrv_unref(bs);
9a86fe48 1108 }
d4a3238a
HR
1109
1110done:
687fa1d8
HR
1111 qemu_progress_end();
1112
26f54e9a 1113 blk_unref(blk);
d4a3238a
HR
1114
1115 if (local_err) {
6936f299 1116 error_report_err(local_err);
c2abccec
MK
1117 return 1;
1118 }
d4a3238a
HR
1119
1120 qprintf(quiet, "Image committed.\n");
ea2384d3
FB
1121 return 0;
1122}
1123
debb38a4
EB
1124/*
1125 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1126 * of the first sector boundary within buf where the sector contains a
1127 * non-zero byte. This function is robust to a buffer that is not
1128 * sector-aligned.
1129 */
1130static int64_t find_nonzero(const uint8_t *buf, int64_t n)
1131{
1132 int64_t i;
1133 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);
1134
1135 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
1136 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
1137 return i;
1138 }
1139 }
1140 if (i < n && !buffer_is_zero(buf + i, n - end)) {
1141 return i;
1142 }
1143 return -1;
1144}
1145
f58c7b35
TS
1146/*
1147 * Returns true iff the first sector pointed to by 'buf' contains at least
1148 * a non-NUL byte.
1149 *
1150 * 'pnum' is set to the number of sectors (including and immediately following
1151 * the first one) that are known to be in the same allocated/unallocated state.
8dcd3c9b 1152 * The function will try to align the end offset to alignment boundaries so
e3a6e0da 1153 * that the request will at least end aligned and consecutive requests will
8dcd3c9b 1154 * also start at an aligned offset.
f58c7b35 1155 */
8dcd3c9b
PL
1156static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
1157 int64_t sector_num, int alignment)
ea2384d3 1158{
1a6d39fd 1159 bool is_zero;
8dcd3c9b 1160 int i, tail;
ea2384d3
FB
1161
1162 if (n <= 0) {
1163 *pnum = 0;
1164 return 0;
1165 }
c075c42f 1166 is_zero = buffer_is_zero(buf, BDRV_SECTOR_SIZE);
ea2384d3 1167 for(i = 1; i < n; i++) {
c075c42f
YL
1168 buf += BDRV_SECTOR_SIZE;
1169 if (is_zero != buffer_is_zero(buf, BDRV_SECTOR_SIZE)) {
ea2384d3 1170 break;
1a6d39fd 1171 }
ea2384d3 1172 }
8dcd3c9b
PL
1173
1174 tail = (sector_num + i) & (alignment - 1);
1175 if (tail) {
1176 if (is_zero && i <= tail) {
1177 /* treat unallocated areas which only consist
1178 * of a small tail as allocated. */
1179 is_zero = false;
1180 }
1181 if (!is_zero) {
1182 /* align up end offset of allocated areas. */
1183 i += alignment - tail;
1184 i = MIN(i, n);
1185 } else {
1186 /* align down end offset of zero areas. */
1187 i -= tail;
1188 }
1189 }
ea2384d3 1190 *pnum = i;
1a6d39fd 1191 return !is_zero;
ea2384d3
FB
1192}
1193
a22f123c
KW
1194/*
1195 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1196 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1197 * breaking up write requests for only small sparse areas.
1198 */
1199static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
8dcd3c9b 1200 int min, int64_t sector_num, int alignment)
a22f123c
KW
1201{
1202 int ret;
1203 int num_checked, num_used;
1204
1205 if (n < min) {
1206 min = n;
1207 }
1208
8dcd3c9b 1209 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
a22f123c
KW
1210 if (!ret) {
1211 return ret;
1212 }
1213
1214 num_used = *pnum;
1215 buf += BDRV_SECTOR_SIZE * *pnum;
1216 n -= *pnum;
8dcd3c9b 1217 sector_num += *pnum;
a22f123c
KW
1218 num_checked = num_used;
1219
1220 while (n > 0) {
8dcd3c9b 1221 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
a22f123c
KW
1222
1223 buf += BDRV_SECTOR_SIZE * *pnum;
1224 n -= *pnum;
8dcd3c9b 1225 sector_num += *pnum;
a22f123c
KW
1226 num_checked += *pnum;
1227 if (ret) {
1228 num_used = num_checked;
1229 } else if (*pnum >= min) {
1230 break;
1231 }
1232 }
1233
1234 *pnum = num_used;
1235 return 1;
1236}
1237
3e85c6fd 1238/*
dc61cd3b
EB
1239 * Compares two buffers sector by sector. Returns 0 if the first
1240 * sector of each buffer matches, non-zero otherwise.
3e85c6fd 1241 *
dc61cd3b
EB
1242 * pnum is set to the sector-aligned size of the buffer prefix that
1243 * has the same matching status as the first sector.
3e85c6fd 1244 */
dc61cd3b
EB
1245static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
1246 int64_t bytes, int64_t *pnum)
3e85c6fd 1247{
8c1ac475 1248 bool res;
dc61cd3b 1249 int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
3e85c6fd 1250
dc61cd3b 1251 assert(bytes > 0);
3e85c6fd 1252
dc61cd3b
EB
1253 res = !!memcmp(buf1, buf2, i);
1254 while (i < bytes) {
1255 int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
3e85c6fd 1256
dc61cd3b 1257 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
3e85c6fd
KW
1258 break;
1259 }
dc61cd3b 1260 i += len;
3e85c6fd
KW
1261 }
1262
1263 *pnum = i;
1264 return res;
1265}
1266
97ede57a 1267#define IO_BUF_SIZE (2 * MiB)
ea2384d3 1268
d14ed18c
MR
1269/*
1270 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1271 *
0608e40e
EB
1272 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1273 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1274 * failure), and 4 on error (the exit status for read errors), after emitting
1275 * an error message.
d14ed18c 1276 *
f1d3cd79 1277 * @param blk: BlockBackend for the image
c41508ed
EB
1278 * @param offset: Starting offset to check
1279 * @param bytes: Number of bytes to check
d14ed18c
MR
1280 * @param filename: Name of disk file we are checking (logging purpose)
1281 * @param buffer: Allocated buffer for storing read data
1282 * @param quiet: Flag for quiet mode
1283 */
c41508ed
EB
1284static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1285 int64_t bytes, const char *filename,
d14ed18c
MR
1286 uint8_t *buffer, bool quiet)
1287{
debb38a4
EB
1288 int ret = 0;
1289 int64_t idx;
1290
c41508ed 1291 ret = blk_pread(blk, offset, buffer, bytes);
d14ed18c
MR
1292 if (ret < 0) {
1293 error_report("Error while reading offset %" PRId64 " of %s: %s",
c41508ed 1294 offset, filename, strerror(-ret));
0608e40e 1295 return 4;
d14ed18c 1296 }
c41508ed 1297 idx = find_nonzero(buffer, bytes);
debb38a4 1298 if (idx >= 0) {
d14ed18c 1299 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
c41508ed 1300 offset + idx);
d14ed18c
MR
1301 return 1;
1302 }
1303
1304 return 0;
1305}
1306
1307/*
1308 * Compares two images. Exit codes:
1309 *
99b1e646 1310 * 0 - Images are identical or the requested help was printed
d14ed18c
MR
1311 * 1 - Images differ
1312 * >1 - Error occurred
1313 */
1314static int img_compare(int argc, char **argv)
1315{
40055951 1316 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
26f54e9a 1317 BlockBackend *blk1, *blk2;
d14ed18c 1318 BlockDriverState *bs1, *bs2;
033d9fc2 1319 int64_t total_size1, total_size2;
d14ed18c 1320 uint8_t *buf1 = NULL, *buf2 = NULL;
31826642 1321 int64_t pnum1, pnum2;
d14ed18c
MR
1322 int allocated1, allocated2;
1323 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1324 bool progress = false, quiet = false, strict = false;
40055951 1325 int flags;
ce099547 1326 bool writethrough;
033d9fc2
EB
1327 int64_t total_size;
1328 int64_t offset = 0;
1329 int64_t chunk;
dc61cd3b 1330 int c;
d14ed18c 1331 uint64_t progress_base;
eb769f74 1332 bool image_opts = false;
335e9937 1333 bool force_share = false;
d14ed18c 1334
40055951 1335 cache = BDRV_DEFAULT_CACHE;
d14ed18c 1336 for (;;) {
3babeb15
DB
1337 static const struct option long_options[] = {
1338 {"help", no_argument, 0, 'h'},
1339 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 1340 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 1341 {"force-share", no_argument, 0, 'U'},
3babeb15
DB
1342 {0, 0, 0, 0}
1343 };
335e9937 1344 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
3babeb15 1345 long_options, NULL);
d14ed18c
MR
1346 if (c == -1) {
1347 break;
1348 }
1349 switch (c) {
c9192973
SH
1350 case ':':
1351 missing_argument(argv[optind - 1]);
1352 break;
d14ed18c 1353 case '?':
c9192973
SH
1354 unrecognized_option(argv[optind - 1]);
1355 break;
d14ed18c
MR
1356 case 'h':
1357 help();
1358 break;
1359 case 'f':
1360 fmt1 = optarg;
1361 break;
1362 case 'F':
1363 fmt2 = optarg;
1364 break;
40055951
HR
1365 case 'T':
1366 cache = optarg;
1367 break;
d14ed18c
MR
1368 case 'p':
1369 progress = true;
1370 break;
1371 case 'q':
1372 quiet = true;
1373 break;
1374 case 's':
1375 strict = true;
1376 break;
335e9937
FZ
1377 case 'U':
1378 force_share = true;
1379 break;
99b1e646
KW
1380 case OPTION_OBJECT:
1381 {
1382 Error *local_err = NULL;
1383
1384 if (!user_creatable_add_from_str(optarg, &local_err)) {
1385 if (local_err) {
1386 error_report_err(local_err);
1387 exit(2);
1388 } else {
1389 /* Help was printed */
1390 exit(EXIT_SUCCESS);
1391 }
1392 }
1393 break;
3babeb15 1394 }
eb769f74
DB
1395 case OPTION_IMAGE_OPTS:
1396 image_opts = true;
1397 break;
d14ed18c
MR
1398 }
1399 }
1400
1401 /* Progress is not shown in Quiet mode */
1402 if (quiet) {
1403 progress = false;
1404 }
1405
1406
fc11eb26 1407 if (optind != argc - 2) {
ac1307ab 1408 error_exit("Expecting two image file names");
d14ed18c
MR
1409 }
1410 filename1 = argv[optind++];
1411 filename2 = argv[optind++];
1412
cbda016d
SH
1413 /* Initialize before goto out */
1414 qemu_progress_init(progress, 2.0);
1415
ce099547
KW
1416 flags = 0;
1417 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
40055951
HR
1418 if (ret < 0) {
1419 error_report("Invalid source cache option: %s", cache);
1420 ret = 2;
1421 goto out3;
1422 }
1423
335e9937
FZ
1424 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1425 force_share);
7e7d56d9 1426 if (!blk1) {
d14ed18c 1427 ret = 2;
7e7d56d9 1428 goto out3;
d14ed18c
MR
1429 }
1430
335e9937
FZ
1431 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1432 force_share);
7e7d56d9 1433 if (!blk2) {
d14ed18c 1434 ret = 2;
7e7d56d9 1435 goto out2;
d14ed18c 1436 }
eb769f74 1437 bs1 = blk_bs(blk1);
7e7d56d9 1438 bs2 = blk_bs(blk2);
d14ed18c 1439
f1d3cd79
HR
1440 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1441 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
033d9fc2
EB
1442 total_size1 = blk_getlength(blk1);
1443 if (total_size1 < 0) {
52bf1e72 1444 error_report("Can't get size of %s: %s",
033d9fc2 1445 filename1, strerror(-total_size1));
52bf1e72
MA
1446 ret = 4;
1447 goto out;
1448 }
033d9fc2
EB
1449 total_size2 = blk_getlength(blk2);
1450 if (total_size2 < 0) {
52bf1e72 1451 error_report("Can't get size of %s: %s",
033d9fc2 1452 filename2, strerror(-total_size2));
52bf1e72
MA
1453 ret = 4;
1454 goto out;
1455 }
033d9fc2
EB
1456 total_size = MIN(total_size1, total_size2);
1457 progress_base = MAX(total_size1, total_size2);
d14ed18c
MR
1458
1459 qemu_progress_print(0, 100);
1460
033d9fc2 1461 if (strict && total_size1 != total_size2) {
d14ed18c
MR
1462 ret = 1;
1463 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1464 goto out;
1465 }
1466
033d9fc2 1467 while (offset < total_size) {
31826642 1468 int status1, status2;
67a0fd2a 1469
033d9fc2
EB
1470 status1 = bdrv_block_status_above(bs1, NULL, offset,
1471 total_size1 - offset, &pnum1, NULL,
1472 NULL);
25ad8e6e 1473 if (status1 < 0) {
d14ed18c
MR
1474 ret = 3;
1475 error_report("Sector allocation test failed for %s", filename1);
1476 goto out;
1477 }
25ad8e6e 1478 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
d14ed18c 1479
033d9fc2
EB
1480 status2 = bdrv_block_status_above(bs2, NULL, offset,
1481 total_size2 - offset, &pnum2, NULL,
1482 NULL);
25ad8e6e 1483 if (status2 < 0) {
d14ed18c
MR
1484 ret = 3;
1485 error_report("Sector allocation test failed for %s", filename2);
1486 goto out;
1487 }
25ad8e6e 1488 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
7daddc61
EB
1489
1490 assert(pnum1 && pnum2);
033d9fc2 1491 chunk = MIN(pnum1, pnum2);
d14ed18c 1492
25ad8e6e 1493 if (strict) {
31826642 1494 if (status1 != status2) {
25ad8e6e
FZ
1495 ret = 1;
1496 qprintf(quiet, "Strict mode: Offset %" PRId64
033d9fc2 1497 " block status mismatch!\n", offset);
25ad8e6e
FZ
1498 goto out;
1499 }
1500 }
1501 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
7daddc61 1502 /* nothing to do */
25ad8e6e 1503 } else if (allocated1 == allocated2) {
d14ed18c 1504 if (allocated1) {
dc61cd3b
EB
1505 int64_t pnum;
1506
033d9fc2
EB
1507 chunk = MIN(chunk, IO_BUF_SIZE);
1508 ret = blk_pread(blk1, offset, buf1, chunk);
d14ed18c 1509 if (ret < 0) {
033d9fc2
EB
1510 error_report("Error while reading offset %" PRId64
1511 " of %s: %s",
1512 offset, filename1, strerror(-ret));
d14ed18c
MR
1513 ret = 4;
1514 goto out;
1515 }
033d9fc2 1516 ret = blk_pread(blk2, offset, buf2, chunk);
d14ed18c
MR
1517 if (ret < 0) {
1518 error_report("Error while reading offset %" PRId64
033d9fc2
EB
1519 " of %s: %s",
1520 offset, filename2, strerror(-ret));
d14ed18c
MR
1521 ret = 4;
1522 goto out;
1523 }
033d9fc2
EB
1524 ret = compare_buffers(buf1, buf2, chunk, &pnum);
1525 if (ret || pnum != chunk) {
d14ed18c 1526 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
033d9fc2 1527 offset + (ret ? 0 : pnum));
36452f12 1528 ret = 1;
d14ed18c
MR
1529 goto out;
1530 }
1531 }
1532 } else {
033d9fc2 1533 chunk = MIN(chunk, IO_BUF_SIZE);
d14ed18c 1534 if (allocated1) {
033d9fc2 1535 ret = check_empty_sectors(blk1, offset, chunk,
d14ed18c
MR
1536 filename1, buf1, quiet);
1537 } else {
033d9fc2 1538 ret = check_empty_sectors(blk2, offset, chunk,
d14ed18c
MR
1539 filename2, buf1, quiet);
1540 }
1541 if (ret) {
d14ed18c
MR
1542 goto out;
1543 }
1544 }
033d9fc2
EB
1545 offset += chunk;
1546 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
d14ed18c
MR
1547 }
1548
033d9fc2 1549 if (total_size1 != total_size2) {
f1d3cd79 1550 BlockBackend *blk_over;
d14ed18c
MR
1551 const char *filename_over;
1552
1553 qprintf(quiet, "Warning: Image size mismatch!\n");
033d9fc2 1554 if (total_size1 > total_size2) {
f1d3cd79 1555 blk_over = blk1;
d14ed18c
MR
1556 filename_over = filename1;
1557 } else {
f1d3cd79 1558 blk_over = blk2;
d14ed18c
MR
1559 filename_over = filename2;
1560 }
1561
033d9fc2
EB
1562 while (offset < progress_base) {
1563 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1564 progress_base - offset, &chunk,
1565 NULL, NULL);
d14ed18c
MR
1566 if (ret < 0) {
1567 ret = 3;
1568 error_report("Sector allocation test failed for %s",
1569 filename_over);
1570 goto out;
1571
1572 }
391cb1aa 1573 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
033d9fc2
EB
1574 chunk = MIN(chunk, IO_BUF_SIZE);
1575 ret = check_empty_sectors(blk_over, offset, chunk,
d14ed18c
MR
1576 filename_over, buf1, quiet);
1577 if (ret) {
d14ed18c
MR
1578 goto out;
1579 }
1580 }
033d9fc2
EB
1581 offset += chunk;
1582 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
d14ed18c
MR
1583 }
1584 }
1585
1586 qprintf(quiet, "Images are identical.\n");
1587 ret = 0;
1588
1589out:
d14ed18c
MR
1590 qemu_vfree(buf1);
1591 qemu_vfree(buf2);
26f54e9a 1592 blk_unref(blk2);
d14ed18c 1593out2:
26f54e9a 1594 blk_unref(blk1);
d14ed18c
MR
1595out3:
1596 qemu_progress_end();
1597 return ret;
1598}
1599
6c729dd8
EB
1600/* Convenience wrapper around qmp_block_dirty_bitmap_merge */
1601static void do_dirty_bitmap_merge(const char *dst_node, const char *dst_name,
1602 const char *src_node, const char *src_name,
1603 Error **errp)
1604{
1605 BlockDirtyBitmapMergeSource *merge_src;
54aa3de7 1606 BlockDirtyBitmapMergeSourceList *list = NULL;
6c729dd8
EB
1607
1608 merge_src = g_new0(BlockDirtyBitmapMergeSource, 1);
1609 merge_src->type = QTYPE_QDICT;
1610 merge_src->u.external.node = g_strdup(src_node);
1611 merge_src->u.external.name = g_strdup(src_name);
54aa3de7 1612 QAPI_LIST_PREPEND(list, merge_src);
6c729dd8
EB
1613 qmp_block_dirty_bitmap_merge(dst_node, dst_name, list, errp);
1614 qapi_free_BlockDirtyBitmapMergeSourceList(list);
1615}
1616
690c7301
KW
1617enum ImgConvertBlockStatus {
1618 BLK_DATA,
1619 BLK_ZERO,
1620 BLK_BACKING_FILE,
1621};
1622
2d9187bc 1623#define MAX_COROUTINES 16
0c8c4895 1624#define CONVERT_THROTTLE_GROUP "img_convert"
2d9187bc 1625
690c7301
KW
1626typedef struct ImgConvertState {
1627 BlockBackend **src;
1628 int64_t *src_sectors;
af8d43d3 1629 int *src_alignment;
2d9187bc 1630 int src_num;
690c7301
KW
1631 int64_t total_sectors;
1632 int64_t allocated_sectors;
2d9187bc
PL
1633 int64_t allocated_done;
1634 int64_t sector_num;
1635 int64_t wr_offs;
690c7301
KW
1636 enum ImgConvertBlockStatus status;
1637 int64_t sector_next_status;
1638 BlockBackend *target;
1639 bool has_zero_init;
1640 bool compressed;
4d7c487e 1641 bool target_is_new;
690c7301 1642 bool target_has_backing;
351c8eff 1643 int64_t target_backing_sectors; /* negative if unknown */
2d9187bc 1644 bool wr_in_order;
ee5306d0 1645 bool copy_range;
8eaac025 1646 bool salvage;
3d96cb91 1647 bool quiet;
690c7301 1648 int min_sparse;
8dcd3c9b 1649 int alignment;
690c7301
KW
1650 size_t cluster_sectors;
1651 size_t buf_sectors;
9fd77f99 1652 long num_coroutines;
2d9187bc
PL
1653 int running_coroutines;
1654 Coroutine *co[MAX_COROUTINES];
1655 int64_t wait_sector_num[MAX_COROUTINES];
1656 CoMutex lock;
1657 int ret;
690c7301
KW
1658} ImgConvertState;
1659
2d9187bc
PL
1660static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1661 int *src_cur, int64_t *src_cur_offset)
690c7301 1662{
2d9187bc
PL
1663 *src_cur = 0;
1664 *src_cur_offset = 0;
1665 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1666 *src_cur_offset += s->src_sectors[*src_cur];
1667 (*src_cur)++;
1668 assert(*src_cur < s->src_num);
690c7301
KW
1669 }
1670}
1671
1672static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1673{
31826642
EB
1674 int64_t src_cur_offset;
1675 int ret, n, src_cur;
351c8eff 1676 bool post_backing_zero = false;
690c7301 1677
2d9187bc 1678 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
690c7301
KW
1679
1680 assert(s->total_sectors > sector_num);
1681 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1682
351c8eff
HR
1683 if (s->target_backing_sectors >= 0) {
1684 if (sector_num >= s->target_backing_sectors) {
2253d86e 1685 post_backing_zero = true;
351c8eff
HR
1686 } else if (sector_num + n > s->target_backing_sectors) {
1687 /* Split requests around target_backing_sectors (because
1688 * starting from there, zeros are handled differently) */
1689 n = s->target_backing_sectors - sector_num;
1690 }
1691 }
1692
690c7301 1693 if (s->sector_next_status <= sector_num) {
8eaac025
HR
1694 uint64_t offset = (sector_num - src_cur_offset) * BDRV_SECTOR_SIZE;
1695 int64_t count;
af8d43d3 1696 int tail;
4a2061e6
HR
1697 BlockDriverState *src_bs = blk_bs(s->src[src_cur]);
1698 BlockDriverState *base;
1699
1700 if (s->target_has_backing) {
1701 base = bdrv_cow_bs(bdrv_skip_filters(src_bs));
1702 } else {
1703 base = NULL;
1704 }
31826642 1705
8eaac025
HR
1706 do {
1707 count = n * BDRV_SECTOR_SIZE;
1708
4a2061e6
HR
1709 ret = bdrv_block_status_above(src_bs, base, offset, count, &count,
1710 NULL, NULL);
8eaac025
HR
1711
1712 if (ret < 0) {
1713 if (s->salvage) {
1714 if (n == 1) {
1715 if (!s->quiet) {
1716 warn_report("error while reading block status at "
1717 "offset %" PRIu64 ": %s", offset,
1718 strerror(-ret));
1719 }
1720 /* Just try to read the data, then */
1721 ret = BDRV_BLOCK_DATA;
1722 count = BDRV_SECTOR_SIZE;
1723 } else {
1724 /* Retry on a shorter range */
1725 n = DIV_ROUND_UP(n, 4);
1726 }
1727 } else {
1728 error_report("error while reading block status at offset "
1729 "%" PRIu64 ": %s", offset, strerror(-ret));
1730 return ret;
1731 }
1732 }
1733 } while (ret < 0);
237d78f8 1734
31826642 1735 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
690c7301 1736
af8d43d3
PL
1737 /*
1738 * Avoid that s->sector_next_status becomes unaligned to the source
1739 * request alignment and/or cluster size to avoid unnecessary read
1740 * cycles.
1741 */
1742 tail = (sector_num - src_cur_offset + n) % s->src_alignment[src_cur];
1743 if (n > tail) {
1744 n -= tail;
1745 }
1746
690c7301 1747 if (ret & BDRV_BLOCK_ZERO) {
351c8eff 1748 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
690c7301
KW
1749 } else if (ret & BDRV_BLOCK_DATA) {
1750 s->status = BLK_DATA;
690c7301 1751 } else {
9f1b92ad 1752 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
690c7301
KW
1753 }
1754
1755 s->sector_next_status = sector_num + n;
1756 }
1757
1758 n = MIN(n, s->sector_next_status - sector_num);
1759 if (s->status == BLK_DATA) {
1760 n = MIN(n, s->buf_sectors);
1761 }
1762
1763 /* We need to write complete clusters for compressed images, so if an
1764 * unallocated area is shorter than that, we must consider the whole
1765 * cluster allocated. */
1766 if (s->compressed) {
1767 if (n < s->cluster_sectors) {
1768 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1769 s->status = BLK_DATA;
1770 } else {
1771 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1772 }
1773 }
1774
1775 return n;
1776}
1777
2d9187bc
PL
1778static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1779 int nb_sectors, uint8_t *buf)
690c7301 1780{
8eaac025 1781 uint64_t single_read_until = 0;
2d9187bc 1782 int n, ret;
690c7301 1783
690c7301
KW
1784 assert(nb_sectors <= s->buf_sectors);
1785 while (nb_sectors > 0) {
1786 BlockBackend *blk;
2d9187bc
PL
1787 int src_cur;
1788 int64_t bs_sectors, src_cur_offset;
8eaac025 1789 uint64_t offset;
690c7301
KW
1790
1791 /* In the case of compression with multiple source files, we can get a
1792 * nb_sectors that spreads into the next part. So we must be able to
1793 * read across multiple BDSes for one convert_read() call. */
2d9187bc
PL
1794 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1795 blk = s->src[src_cur];
1796 bs_sectors = s->src_sectors[src_cur];
1797
8eaac025
HR
1798 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1799
2d9187bc 1800 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
8eaac025
HR
1801 if (single_read_until > offset) {
1802 n = 1;
1803 }
2d9187bc 1804
8eaac025 1805 ret = blk_co_pread(blk, offset, n << BDRV_SECTOR_BITS, buf, 0);
690c7301 1806 if (ret < 0) {
8eaac025
HR
1807 if (s->salvage) {
1808 if (n > 1) {
1809 single_read_until = offset + (n << BDRV_SECTOR_BITS);
1810 continue;
1811 } else {
1812 if (!s->quiet) {
1813 warn_report("error while reading offset %" PRIu64
1814 ": %s", offset, strerror(-ret));
1815 }
1816 memset(buf, 0, BDRV_SECTOR_SIZE);
1817 }
1818 } else {
1819 return ret;
1820 }
690c7301
KW
1821 }
1822
1823 sector_num += n;
1824 nb_sectors -= n;
1825 buf += n * BDRV_SECTOR_SIZE;
1826 }
1827
1828 return 0;
1829}
1830
2d9187bc
PL
1831
1832static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1833 int nb_sectors, uint8_t *buf,
1834 enum ImgConvertBlockStatus status)
690c7301
KW
1835{
1836 int ret;
1837
1838 while (nb_sectors > 0) {
1839 int n = nb_sectors;
db933fbe
LC
1840 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1841
2d9187bc 1842 switch (status) {
690c7301
KW
1843 case BLK_BACKING_FILE:
1844 /* If we have a backing file, leave clusters unallocated that are
1845 * unallocated in the source image, so that the backing file is
1846 * visible at the respective offset. */
1847 assert(s->target_has_backing);
1848 break;
1849
1850 case BLK_DATA:
db933fbe
LC
1851 /* If we're told to keep the target fully allocated (-S 0) or there
1852 * is real non-zero data, we must write it. Otherwise we can treat
1853 * it as zero sectors.
1854 * Compressed clusters need to be written as a whole, so in that
1855 * case we can only save the write if the buffer is completely
1856 * zeroed. */
690c7301 1857 if (!s->min_sparse ||
db933fbe 1858 (!s->compressed &&
8dcd3c9b
PL
1859 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1860 sector_num, s->alignment)) ||
db933fbe
LC
1861 (s->compressed &&
1862 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
690c7301 1863 {
265a7e54
VSO
1864 ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1865 n << BDRV_SECTOR_BITS, buf, flags);
690c7301
KW
1866 if (ret < 0) {
1867 return ret;
1868 }
1869 break;
1870 }
1871 /* fall-through */
1872
1873 case BLK_ZERO:
1874 if (s->has_zero_init) {
db933fbe 1875 assert(!s->target_has_backing);
690c7301
KW
1876 break;
1877 }
2d9187bc
PL
1878 ret = blk_co_pwrite_zeroes(s->target,
1879 sector_num << BDRV_SECTOR_BITS,
a3d6ae22
NS
1880 n << BDRV_SECTOR_BITS,
1881 BDRV_REQ_MAY_UNMAP);
690c7301
KW
1882 if (ret < 0) {
1883 return ret;
1884 }
1885 break;
1886 }
1887
1888 sector_num += n;
1889 nb_sectors -= n;
1890 buf += n * BDRV_SECTOR_SIZE;
1891 }
1892
1893 return 0;
1894}
1895
ee5306d0
FZ
1896static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1897 int nb_sectors)
1898{
1899 int n, ret;
1900
1901 while (nb_sectors > 0) {
1902 BlockBackend *blk;
1903 int src_cur;
1904 int64_t bs_sectors, src_cur_offset;
1905 int64_t offset;
1906
1907 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1908 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1909 blk = s->src[src_cur];
1910 bs_sectors = s->src_sectors[src_cur];
1911
1912 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1913
1914 ret = blk_co_copy_range(blk, offset, s->target,
1915 sector_num << BDRV_SECTOR_BITS,
67b51fb9 1916 n << BDRV_SECTOR_BITS, 0, 0);
ee5306d0
FZ
1917 if (ret < 0) {
1918 return ret;
1919 }
1920
1921 sector_num += n;
1922 nb_sectors -= n;
1923 }
1924 return 0;
1925}
1926
2d9187bc 1927static void coroutine_fn convert_co_do_copy(void *opaque)
690c7301 1928{
2d9187bc 1929 ImgConvertState *s = opaque;
690c7301 1930 uint8_t *buf = NULL;
2d9187bc
PL
1931 int ret, i;
1932 int index = -1;
1933
1934 for (i = 0; i < s->num_coroutines; i++) {
1935 if (s->co[i] == qemu_coroutine_self()) {
1936 index = i;
1937 break;
1938 }
1939 }
1940 assert(index >= 0);
1941
1942 s->running_coroutines++;
1943 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1944
1945 while (1) {
1946 int n;
1947 int64_t sector_num;
1948 enum ImgConvertBlockStatus status;
ee5306d0 1949 bool copy_range;
2d9187bc
PL
1950
1951 qemu_co_mutex_lock(&s->lock);
1952 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1953 qemu_co_mutex_unlock(&s->lock);
b91127ed 1954 break;
2d9187bc
PL
1955 }
1956 n = convert_iteration_sectors(s, s->sector_num);
1957 if (n < 0) {
1958 qemu_co_mutex_unlock(&s->lock);
1959 s->ret = n;
b91127ed 1960 break;
2d9187bc
PL
1961 }
1962 /* save current sector and allocation status to local variables */
1963 sector_num = s->sector_num;
1964 status = s->status;
1965 if (!s->min_sparse && s->status == BLK_ZERO) {
1966 n = MIN(n, s->buf_sectors);
1967 }
1968 /* increment global sector counter so that other coroutines can
1969 * already continue reading beyond this request */
1970 s->sector_num += n;
1971 qemu_co_mutex_unlock(&s->lock);
1972
1973 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
1974 s->allocated_done += n;
1975 qemu_progress_print(100.0 * s->allocated_done /
1976 s->allocated_sectors, 0);
1977 }
1978
ee5306d0
FZ
1979retry:
1980 copy_range = s->copy_range && s->status == BLK_DATA;
1981 if (status == BLK_DATA && !copy_range) {
2d9187bc
PL
1982 ret = convert_co_read(s, sector_num, n, buf);
1983 if (ret < 0) {
39f77cb6
EB
1984 error_report("error while reading at byte %lld: %s",
1985 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
2d9187bc 1986 s->ret = ret;
2d9187bc
PL
1987 }
1988 } else if (!s->min_sparse && status == BLK_ZERO) {
1989 status = BLK_DATA;
1990 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
1991 }
1992
1993 if (s->wr_in_order) {
1994 /* keep writes in order */
b91127ed 1995 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
2d9187bc
PL
1996 s->wait_sector_num[index] = sector_num;
1997 qemu_coroutine_yield();
1998 }
1999 s->wait_sector_num[index] = -1;
2000 }
2001
b91127ed 2002 if (s->ret == -EINPROGRESS) {
ee5306d0
FZ
2003 if (copy_range) {
2004 ret = convert_co_copy_range(s, sector_num, n);
2005 if (ret) {
2006 s->copy_range = false;
2007 goto retry;
2008 }
2009 } else {
2010 ret = convert_co_write(s, sector_num, n, buf, status);
2011 }
b91127ed 2012 if (ret < 0) {
39f77cb6
EB
2013 error_report("error while writing at byte %lld: %s",
2014 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
b91127ed
AN
2015 s->ret = ret;
2016 }
2d9187bc
PL
2017 }
2018
2019 if (s->wr_in_order) {
2020 /* reenter the coroutine that might have waited
2021 * for this write to complete */
2022 s->wr_offs = sector_num + n;
2023 for (i = 0; i < s->num_coroutines; i++) {
2024 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
2025 /*
2026 * A -> B -> A cannot occur because A has
2027 * s->wait_sector_num[i] == -1 during A -> B. Therefore
2028 * B will never enter A during this time window.
2029 */
2030 qemu_coroutine_enter(s->co[i]);
2031 break;
2032 }
2033 }
2034 }
2035 }
2036
2d9187bc
PL
2037 qemu_vfree(buf);
2038 s->co[index] = NULL;
2039 s->running_coroutines--;
2040 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
2041 /* the convert job finished successfully */
2042 s->ret = 0;
2043 }
2044}
2045
2046static int convert_do_copy(ImgConvertState *s)
2047{
2048 int ret, i, n;
2049 int64_t sector_num = 0;
690c7301
KW
2050
2051 /* Check whether we have zero initialisation or can get it efficiently */
168468fe
DE
2052 if (!s->has_zero_init && s->target_is_new && s->min_sparse &&
2053 !s->target_has_backing) {
4d7c487e 2054 s->has_zero_init = bdrv_has_zero_init(blk_bs(s->target));
4d7c487e 2055 }
690c7301 2056
690c7301
KW
2057 /* Allocate buffer for copied data. For compressed images, only one cluster
2058 * can be copied at a time. */
2059 if (s->compressed) {
2060 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
2061 error_report("invalid cluster size");
2d9187bc 2062 return -EINVAL;
690c7301
KW
2063 }
2064 s->buf_sectors = s->cluster_sectors;
2065 }
690c7301 2066
690c7301
KW
2067 while (sector_num < s->total_sectors) {
2068 n = convert_iteration_sectors(s, sector_num);
2069 if (n < 0) {
2d9187bc 2070 return n;
690c7301 2071 }
aad15de4
HR
2072 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
2073 {
690c7301
KW
2074 s->allocated_sectors += n;
2075 }
2076 sector_num += n;
2077 }
2078
2079 /* Do the copy */
690c7301 2080 s->sector_next_status = 0;
2d9187bc 2081 s->ret = -EINPROGRESS;
690c7301 2082
2d9187bc
PL
2083 qemu_co_mutex_init(&s->lock);
2084 for (i = 0; i < s->num_coroutines; i++) {
2085 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
2086 s->wait_sector_num[i] = -1;
2087 qemu_coroutine_enter(s->co[i]);
2088 }
690c7301 2089
b91127ed 2090 while (s->running_coroutines) {
2d9187bc 2091 main_loop_wait(false);
690c7301
KW
2092 }
2093
2d9187bc 2094 if (s->compressed && !s->ret) {
690c7301 2095 /* signal EOF to align */
fe5c1355 2096 ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
690c7301 2097 if (ret < 0) {
2d9187bc 2098 return ret;
690c7301
KW
2099 }
2100 }
2101
2d9187bc 2102 return s->ret;
690c7301
KW
2103}
2104
74a4320f 2105/* Check that bitmaps can be copied, or output an error */
955171e4 2106static int convert_check_bitmaps(BlockDriverState *src, bool skip_broken)
74a4320f
EB
2107{
2108 BdrvDirtyBitmap *bm;
2109
2110 if (!bdrv_supports_persistent_dirty_bitmap(src)) {
2111 error_report("Source lacks bitmap support");
2112 return -1;
2113 }
2114 FOR_EACH_DIRTY_BITMAP(src, bm) {
2115 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2116 continue;
2117 }
955171e4 2118 if (!skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) {
74a4320f
EB
2119 error_report("Cannot copy inconsistent bitmap '%s'",
2120 bdrv_dirty_bitmap_name(bm));
955171e4
EB
2121 error_printf("Try --skip-broken-bitmaps, or "
2122 "use 'qemu-img bitmap --remove' to delete it\n");
74a4320f
EB
2123 return -1;
2124 }
2125 }
2126 return 0;
2127}
2128
955171e4
EB
2129static int convert_copy_bitmaps(BlockDriverState *src, BlockDriverState *dst,
2130 bool skip_broken)
15e39ad9
EB
2131{
2132 BdrvDirtyBitmap *bm;
2133 Error *err = NULL;
2134
2135 FOR_EACH_DIRTY_BITMAP(src, bm) {
2136 const char *name;
2137
2138 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2139 continue;
2140 }
2141 name = bdrv_dirty_bitmap_name(bm);
955171e4
EB
2142 if (skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) {
2143 warn_report("Skipping inconsistent bitmap '%s'", name);
2144 continue;
2145 }
15e39ad9
EB
2146 qmp_block_dirty_bitmap_add(dst->node_name, name,
2147 true, bdrv_dirty_bitmap_granularity(bm),
2148 true, true,
2149 true, !bdrv_dirty_bitmap_enabled(bm),
2150 &err);
2151 if (err) {
2152 error_reportf_err(err, "Failed to create bitmap %s: ", name);
2153 return -1;
2154 }
2155
2156 do_dirty_bitmap_merge(dst->node_name, name, src->node_name, name,
2157 &err);
2158 if (err) {
2159 error_reportf_err(err, "Failed to populate bitmap %s: ", name);
74a4320f 2160 qmp_block_dirty_bitmap_remove(dst->node_name, name, NULL);
15e39ad9
EB
2161 return -1;
2162 }
2163 }
2164
2165 return 0;
2166}
2167
6360ab27
PL
2168#define MAX_BUF_SECTORS 32768
2169
0c8c4895
ZL
2170static void set_rate_limit(BlockBackend *blk, int64_t rate_limit)
2171{
2172 ThrottleConfig cfg;
2173
2174 throttle_config_init(&cfg);
2175 cfg.buckets[THROTTLE_BPS_WRITE].avg = rate_limit;
2176
2177 blk_io_limits_enable(blk, CONVERT_THROTTLE_GROUP);
2178 blk_set_io_limits(blk, &cfg);
2179}
2180
ea2384d3
FB
2181static int img_convert(int argc, char **argv)
2182{
0b8fb55c 2183 int c, bs_i, flags, src_flags = BDRV_O_NO_SHARE;
305b4c60 2184 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
9fd77f99 2185 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
1899bf47
EB
2186 *out_filename, *out_baseimg_param, *snapshot_name = NULL,
2187 *backing_fmt = NULL;
305b4c60 2188 BlockDriver *drv = NULL, *proto_drv = NULL;
faea38e7 2189 BlockDriverInfo bdi;
9fd77f99
PL
2190 BlockDriverState *out_bs;
2191 QemuOpts *opts = NULL, *sn_opts = NULL;
83d0521a 2192 QemuOptsList *create_opts = NULL;
8d65a3cc 2193 QDict *open_opts = NULL;
efa84d43 2194 char *options = NULL;
cc84d90f 2195 Error *local_err = NULL;
3d96cb91 2196 bool writethrough, src_writethrough, image_opts = false,
305b4c60 2197 skip_create = false, progress = false, tgt_image_opts = false;
9fd77f99 2198 int64_t ret = -EINVAL;
335e9937 2199 bool force_share = false;
e11ce12f 2200 bool explict_min_sparse = false;
15e39ad9 2201 bool bitmaps = false;
955171e4 2202 bool skip_broken = false;
0c8c4895 2203 int64_t rate_limit = 0;
9fd77f99
PL
2204
2205 ImgConvertState s = (ImgConvertState) {
2206 /* Need at least 4k of zeros for sparse detection */
2207 .min_sparse = 8,
e11ce12f 2208 .copy_range = false,
9fd77f99
PL
2209 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2210 .wr_in_order = true,
2211 .num_coroutines = 8,
2212 };
ea2384d3 2213
ea2384d3 2214 for(;;) {
3babeb15
DB
2215 static const struct option long_options[] = {
2216 {"help", no_argument, 0, 'h'},
2217 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 2218 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 2219 {"force-share", no_argument, 0, 'U'},
305b4c60 2220 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
8eaac025 2221 {"salvage", no_argument, 0, OPTION_SALVAGE},
168468fe 2222 {"target-is-zero", no_argument, 0, OPTION_TARGET_IS_ZERO},
15e39ad9 2223 {"bitmaps", no_argument, 0, OPTION_BITMAPS},
955171e4 2224 {"skip-broken-bitmaps", no_argument, 0, OPTION_SKIP_BROKEN},
3babeb15
DB
2225 {0, 0, 0, 0}
2226 };
1899bf47 2227 c = getopt_long(argc, argv, ":hf:O:B:CcF:o:l:S:pt:T:qnm:WUr:",
3babeb15 2228 long_options, NULL);
b8fb60da 2229 if (c == -1) {
ea2384d3 2230 break;
b8fb60da 2231 }
ea2384d3 2232 switch(c) {
c9192973
SH
2233 case ':':
2234 missing_argument(argv[optind - 1]);
2235 break;
ef87394c 2236 case '?':
c9192973
SH
2237 unrecognized_option(argv[optind - 1]);
2238 break;
ea2384d3
FB
2239 case 'h':
2240 help();
2241 break;
2242 case 'f':
2243 fmt = optarg;
2244 break;
2245 case 'O':
2246 out_fmt = optarg;
2247 break;
f58c7b35
TS
2248 case 'B':
2249 out_baseimg = optarg;
2250 break;
e11ce12f
FZ
2251 case 'C':
2252 s.copy_range = true;
2253 break;
ea2384d3 2254 case 'c':
9fd77f99 2255 s.compressed = true;
ea2384d3 2256 break;
1899bf47
EB
2257 case 'F':
2258 backing_fmt = optarg;
2259 break;
efa84d43 2260 case 'o':
6d2b5cba 2261 if (accumulate_options(&options, optarg) < 0) {
64bb01aa 2262 goto fail_getopt;
2dc8328b 2263 }
efa84d43 2264 break;
ef80654d
WX
2265 case 'l':
2266 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
70b94331
MA
2267 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2268 optarg, false);
ef80654d
WX
2269 if (!sn_opts) {
2270 error_report("Failed in parsing snapshot param '%s'",
2271 optarg);
64bb01aa 2272 goto fail_getopt;
ef80654d
WX
2273 }
2274 } else {
2275 snapshot_name = optarg;
2276 }
2277 break;
a22f123c
KW
2278 case 'S':
2279 {
2280 int64_t sval;
606caa0a 2281
43d589b0
EM
2282 sval = cvtnum("buffer size for sparse output", optarg);
2283 if (sval < 0) {
2284 goto fail_getopt;
2285 } else if (!QEMU_IS_ALIGNED(sval, BDRV_SECTOR_SIZE) ||
6360ab27
PL
2286 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2287 error_report("Invalid buffer size for sparse output specified. "
2288 "Valid sizes are multiples of %llu up to %llu. Select "
2289 "0 to disable sparse detection (fully allocates output).",
2290 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
64bb01aa 2291 goto fail_getopt;
a22f123c
KW
2292 }
2293
9fd77f99 2294 s.min_sparse = sval / BDRV_SECTOR_SIZE;
e11ce12f 2295 explict_min_sparse = true;
a22f123c
KW
2296 break;
2297 }
6b837bc4 2298 case 'p':
9fd77f99 2299 progress = true;
6b837bc4 2300 break;
661a0f71
FS
2301 case 't':
2302 cache = optarg;
2303 break;
40055951
HR
2304 case 'T':
2305 src_cache = optarg;
2306 break;
f382d43a 2307 case 'q':
3d96cb91 2308 s.quiet = true;
f382d43a 2309 break;
b2e10493 2310 case 'n':
9fd77f99 2311 skip_create = true;
b2e10493 2312 break;
2d9187bc 2313 case 'm':
9fd77f99
PL
2314 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2315 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
2d9187bc
PL
2316 error_report("Invalid number of coroutines. Allowed number of"
2317 " coroutines is between 1 and %d", MAX_COROUTINES);
2d9187bc
PL
2318 goto fail_getopt;
2319 }
2320 break;
2321 case 'W':
9fd77f99 2322 s.wr_in_order = false;
2d9187bc 2323 break;
335e9937
FZ
2324 case 'U':
2325 force_share = true;
2326 break;
0c8c4895
ZL
2327 case 'r':
2328 rate_limit = cvtnum("rate limit", optarg);
2329 if (rate_limit < 0) {
2330 goto fail_getopt;
2331 }
2332 break;
99b1e646
KW
2333 case OPTION_OBJECT:
2334 user_creatable_process_cmdline(optarg);
3babeb15 2335 break;
eb769f74
DB
2336 case OPTION_IMAGE_OPTS:
2337 image_opts = true;
2338 break;
8eaac025
HR
2339 case OPTION_SALVAGE:
2340 s.salvage = true;
2341 break;
305b4c60
DB
2342 case OPTION_TARGET_IMAGE_OPTS:
2343 tgt_image_opts = true;
2344 break;
168468fe
DE
2345 case OPTION_TARGET_IS_ZERO:
2346 /*
2347 * The user asserting that the target is blank has the
2348 * same effect as the target driver supporting zero
2349 * initialisation.
2350 */
2351 s.has_zero_init = true;
2352 break;
15e39ad9
EB
2353 case OPTION_BITMAPS:
2354 bitmaps = true;
2355 break;
955171e4
EB
2356 case OPTION_SKIP_BROKEN:
2357 skip_broken = true;
2358 break;
ea2384d3
FB
2359 }
2360 }
3b46e624 2361
305b4c60
DB
2362 if (!out_fmt && !tgt_image_opts) {
2363 out_fmt = "raw";
2364 }
2365
955171e4
EB
2366 if (skip_broken && !bitmaps) {
2367 error_report("Use of --skip-broken-bitmaps requires --bitmaps");
2368 goto fail_getopt;
2369 }
2370
e11ce12f
FZ
2371 if (s.compressed && s.copy_range) {
2372 error_report("Cannot enable copy offloading when -c is used");
2373 goto fail_getopt;
2374 }
2375
2376 if (explict_min_sparse && s.copy_range) {
2377 error_report("Cannot enable copy offloading when -S is used");
2378 goto fail_getopt;
2379 }
2380
8eaac025
HR
2381 if (s.copy_range && s.salvage) {
2382 error_report("Cannot use copy offloading in salvaging mode");
2383 goto fail_getopt;
2384 }
2385
305b4c60
DB
2386 if (tgt_image_opts && !skip_create) {
2387 error_report("--target-image-opts requires use of -n flag");
2388 goto fail_getopt;
2389 }
2390
ffd8e8ff 2391 if (skip_create && options) {
25956af3
EB
2392 error_report("-o has no effect when skipping image creation");
2393 goto fail_getopt;
ffd8e8ff
KW
2394 }
2395
168468fe
DE
2396 if (s.has_zero_init && !skip_create) {
2397 error_report("--target-is-zero requires use of -n flag");
2398 goto fail_getopt;
2399 }
2400
9fd77f99
PL
2401 s.src_num = argc - optind - 1;
2402 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
f58c7b35 2403
2dc8328b 2404 if (options && has_help_option(options)) {
305b4c60
DB
2405 if (out_fmt) {
2406 ret = print_block_option_help(out_filename, out_fmt);
2407 goto fail_getopt;
2408 } else {
2409 error_report("Option help requires a format be specified");
2410 goto fail_getopt;
2411 }
4ac8aacd
JS
2412 }
2413
9fd77f99
PL
2414 if (s.src_num < 1) {
2415 error_report("Must specify image file name");
2416 goto fail_getopt;
a283cb6e
KW
2417 }
2418
9fd77f99 2419 /* ret is still -EINVAL until here */
ce099547 2420 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
40055951
HR
2421 if (ret < 0) {
2422 error_report("Invalid source cache option: %s", src_cache);
9fd77f99 2423 goto fail_getopt;
40055951
HR
2424 }
2425
9fd77f99 2426 /* Initialize before goto out */
3d96cb91 2427 if (s.quiet) {
9fd77f99
PL
2428 progress = false;
2429 }
2430 qemu_progress_init(progress, 1.0);
6b837bc4
JS
2431 qemu_progress_print(0, 100);
2432
9fd77f99
PL
2433 s.src = g_new0(BlockBackend *, s.src_num);
2434 s.src_sectors = g_new(int64_t, s.src_num);
af8d43d3 2435 s.src_alignment = g_new(int, s.src_num);
926c2d23 2436
9fd77f99 2437 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
af8d43d3 2438 BlockDriverState *src_bs;
9fd77f99 2439 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
3d96cb91 2440 fmt, src_flags, src_writethrough, s.quiet,
335e9937 2441 force_share);
9fd77f99 2442 if (!s.src[bs_i]) {
c2abccec
MK
2443 ret = -1;
2444 goto out;
2445 }
9fd77f99
PL
2446 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2447 if (s.src_sectors[bs_i] < 0) {
52bf1e72 2448 error_report("Could not get size of %s: %s",
9fd77f99 2449 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
52bf1e72
MA
2450 ret = -1;
2451 goto out;
2452 }
af8d43d3
PL
2453 src_bs = blk_bs(s.src[bs_i]);
2454 s.src_alignment[bs_i] = DIV_ROUND_UP(src_bs->bl.request_alignment,
2455 BDRV_SECTOR_SIZE);
2456 if (!bdrv_get_info(src_bs, &bdi)) {
2457 s.src_alignment[bs_i] = MAX(s.src_alignment[bs_i],
2458 bdi.cluster_size / BDRV_SECTOR_SIZE);
2459 }
9fd77f99 2460 s.total_sectors += s.src_sectors[bs_i];
926c2d23 2461 }
ea2384d3 2462
ef80654d 2463 if (sn_opts) {
9fd77f99 2464 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
10d6eda1
PM
2465 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2466 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2467 &local_err);
ef80654d 2468 } else if (snapshot_name != NULL) {
9fd77f99 2469 if (s.src_num > 1) {
6daf194d 2470 error_report("No support for concatenating multiple snapshot");
51ef6727 2471 ret = -1;
2472 goto out;
2473 }
7b4c4781 2474
9fd77f99
PL
2475 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2476 &local_err);
ef80654d 2477 }
84d18f06 2478 if (local_err) {
c29b77f9 2479 error_reportf_err(local_err, "Failed to load snapshot: ");
ef80654d
WX
2480 ret = -1;
2481 goto out;
51ef6727 2482 }
2483
305b4c60
DB
2484 if (!skip_create) {
2485 /* Find driver and parse its options */
2486 drv = bdrv_find_format(out_fmt);
2487 if (!drv) {
2488 error_report("Unknown file format '%s'", out_fmt);
2489 ret = -1;
2490 goto out;
2491 }
efa84d43 2492
305b4c60
DB
2493 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2494 if (!proto_drv) {
2495 error_report_err(local_err);
2496 ret = -1;
2497 goto out;
2498 }
b50cbabc 2499
2e024cde
HR
2500 if (!drv->create_opts) {
2501 error_report("Format driver '%s' does not support image creation",
2502 drv->format_name);
2503 ret = -1;
2504 goto out;
2505 }
f75613cf 2506
2e024cde
HR
2507 if (!proto_drv->create_opts) {
2508 error_report("Protocol driver '%s' does not support image creation",
2509 proto_drv->format_name);
2510 ret = -1;
2511 goto out;
2512 }
f75613cf 2513
2e024cde
HR
2514 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2515 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
db08adf5 2516
2e024cde 2517 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
dc523cd3 2518 if (options) {
235e59cf 2519 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
97a2ca7a 2520 error_report_err(local_err);
dc523cd3
MA
2521 ret = -1;
2522 goto out;
2523 }
2e024cde 2524 }
efa84d43 2525
c075c42f
YL
2526 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
2527 s.total_sectors * BDRV_SECTOR_SIZE, &error_abort);
1899bf47 2528 ret = add_old_style_options(out_fmt, opts, out_baseimg, backing_fmt);
2e024cde
HR
2529 if (ret < 0) {
2530 goto out;
2531 }
c2abccec 2532 }
efa84d43 2533
a18953fb 2534 /* Get backing file name if -o backing_file was used */
83d0521a 2535 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
a18953fb 2536 if (out_baseimg_param) {
83d0521a 2537 out_baseimg = out_baseimg_param;
a18953fb 2538 }
9fd77f99 2539 s.target_has_backing = (bool) out_baseimg;
a18953fb 2540
168468fe
DE
2541 if (s.has_zero_init && s.target_has_backing) {
2542 error_report("Cannot use --target-is-zero when the destination "
2543 "image has a backing file");
2544 goto out;
2545 }
2546
48758a84
HR
2547 if (s.src_num > 1 && out_baseimg) {
2548 error_report("Having a backing file for the target makes no sense when "
2549 "concatenating multiple input images");
2550 ret = -1;
2551 goto out;
2552 }
2553
d9f059aa
EB
2554 if (out_baseimg_param) {
2555 if (!qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT)) {
497a30db
EB
2556 error_report("Use of backing file requires explicit "
2557 "backing format");
2558 ret = -1;
2559 goto out;
d9f059aa
EB
2560 }
2561 }
2562
efa84d43 2563 /* Check if compression is supported */
9fd77f99 2564 if (s.compressed) {
83d0521a
CL
2565 bool encryption =
2566 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
0cb8d47b
DB
2567 const char *encryptfmt =
2568 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
83d0521a
CL
2569 const char *preallocation =
2570 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
efa84d43 2571
ac850bf0 2572 if (drv && !block_driver_can_compress(drv)) {
15654a6d 2573 error_report("Compression not supported for this file format");
c2abccec
MK
2574 ret = -1;
2575 goto out;
efa84d43
KW
2576 }
2577
0cb8d47b 2578 if (encryption || encryptfmt) {
15654a6d
JS
2579 error_report("Compression and encryption not supported at "
2580 "the same time");
c2abccec
MK
2581 ret = -1;
2582 goto out;
efa84d43 2583 }
41521fa4 2584
83d0521a
CL
2585 if (preallocation
2586 && strcmp(preallocation, "off"))
41521fa4
KW
2587 {
2588 error_report("Compression and preallocation not supported at "
2589 "the same time");
2590 ret = -1;
2591 goto out;
2592 }
efa84d43
KW
2593 }
2594
15e39ad9
EB
2595 /* Determine if bitmaps need copying */
2596 if (bitmaps) {
2597 if (s.src_num > 1) {
2598 error_report("Copying bitmaps only possible with single source");
2599 ret = -1;
2600 goto out;
2601 }
955171e4 2602 ret = convert_check_bitmaps(blk_bs(s.src[0]), skip_broken);
74a4320f 2603 if (ret < 0) {
15e39ad9
EB
2604 goto out;
2605 }
2606 }
2607
8d65a3cc
DB
2608 /*
2609 * The later open call will need any decryption secrets, and
2610 * bdrv_create() will purge "opts", so extract them now before
2611 * they are lost.
2612 */
2613 if (!skip_create) {
2614 open_opts = qdict_new();
2615 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
8d65a3cc 2616
b2e10493 2617 /* Create the new image */
c282e1fd 2618 ret = bdrv_create(drv, out_filename, opts, &local_err);
b2e10493 2619 if (ret < 0) {
c29b77f9
MA
2620 error_reportf_err(local_err, "%s: error while converting %s: ",
2621 out_filename, out_fmt);
b2e10493 2622 goto out;
ea2384d3
FB
2623 }
2624 }
3b46e624 2625
4d7c487e
HR
2626 s.target_is_new = !skip_create;
2627
9fd77f99 2628 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
ce099547 2629 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
661a0f71
FS
2630 if (ret < 0) {
2631 error_report("Invalid cache option: %s", cache);
bb9cd2ee 2632 goto out;
661a0f71
FS
2633 }
2634
a1c62436
HR
2635 if (flags & BDRV_O_NOCACHE) {
2636 /*
2637 * If we open the target with O_DIRECT, it may be necessary to
2638 * extend its size to align to the physical sector size.
2639 */
2640 flags |= BDRV_O_RESIZE;
2641 }
2642
305b4c60
DB
2643 if (skip_create) {
2644 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
3d96cb91 2645 flags, writethrough, s.quiet, false);
305b4c60
DB
2646 } else {
2647 /* TODO ultimately we should allow --target-image-opts
2648 * to be used even when -n is not given.
2649 * That has to wait for bdrv_create to be improved
2650 * to allow filenames in option syntax
2651 */
8d65a3cc 2652 s.target = img_open_file(out_filename, open_opts, out_fmt,
3d96cb91 2653 flags, writethrough, s.quiet, false);
8d65a3cc 2654 open_opts = NULL; /* blk_new_open will have freed it */
305b4c60 2655 }
9fd77f99 2656 if (!s.target) {
c2abccec
MK
2657 ret = -1;
2658 goto out;
2659 }
9fd77f99 2660 out_bs = blk_bs(s.target);
ea2384d3 2661
15e39ad9
EB
2662 if (bitmaps && !bdrv_supports_persistent_dirty_bitmap(out_bs)) {
2663 error_report("Format driver '%s' does not support bitmaps",
2664 out_bs->drv->format_name);
2665 ret = -1;
2666 goto out;
2667 }
2668
ac850bf0 2669 if (s.compressed && !block_driver_can_compress(out_bs->drv)) {
305b4c60
DB
2670 error_report("Compression not supported for this file format");
2671 ret = -1;
2672 goto out;
2673 }
2674
5def6b80 2675 /* increase bufsectors from the default 4096 (2M) if opt_transfer
6360ab27
PL
2676 * or discard_alignment of the out_bs is greater. Limit to
2677 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2678 s.buf_sectors = MIN(MAX_BUF_SECTORS,
9fd77f99
PL
2679 MAX(s.buf_sectors,
2680 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2681 out_bs->bl.pdiscard_alignment >>
2682 BDRV_SECTOR_BITS)));
f2521c90 2683
8dcd3c9b
PL
2684 /* try to align the write requests to the destination to avoid unnecessary
2685 * RMW cycles. */
2686 s.alignment = MAX(pow2floor(s.min_sparse),
2687 DIV_ROUND_UP(out_bs->bl.request_alignment,
2688 BDRV_SECTOR_SIZE));
2689 assert(is_power_of_2(s.alignment));
2690
b2e10493 2691 if (skip_create) {
9fd77f99 2692 int64_t output_sectors = blk_nb_sectors(s.target);
43716fa8 2693 if (output_sectors < 0) {
eec5eb42 2694 error_report("unable to get output image length: %s",
43716fa8 2695 strerror(-output_sectors));
b2e10493
AD
2696 ret = -1;
2697 goto out;
9fd77f99 2698 } else if (output_sectors < s.total_sectors) {
b2e10493
AD
2699 error_report("output file is smaller than input file");
2700 ret = -1;
2701 goto out;
2702 }
2703 }
2704
c69291e7 2705 if (s.target_has_backing && s.target_is_new) {
351c8eff
HR
2706 /* Errors are treated as "backing length unknown" (which means
2707 * s.target_backing_sectors has to be negative, which it will
2708 * be automatically). The backing file length is used only
2709 * for optimizations, so such a case is not fatal. */
4a2061e6
HR
2710 s.target_backing_sectors =
2711 bdrv_nb_sectors(bdrv_backing_chain_next(out_bs));
351c8eff
HR
2712 } else {
2713 s.target_backing_sectors = -1;
2714 }
2715
24f833cd
PL
2716 ret = bdrv_get_info(out_bs, &bdi);
2717 if (ret < 0) {
9fd77f99 2718 if (s.compressed) {
15654a6d 2719 error_report("could not get block driver info");
c2abccec
MK
2720 goto out;
2721 }
24f833cd 2722 } else {
9fd77f99
PL
2723 s.compressed = s.compressed || bdi.needs_compressed_writes;
2724 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2725 }
802c3d4c 2726
0c8c4895
ZL
2727 if (rate_limit) {
2728 set_rate_limit(s.target, rate_limit);
2729 }
2730
9fd77f99 2731 ret = convert_do_copy(&s);
15e39ad9
EB
2732
2733 /* Now copy the bitmaps */
2734 if (bitmaps && ret == 0) {
955171e4 2735 ret = convert_copy_bitmaps(blk_bs(s.src[0]), out_bs, skip_broken);
15e39ad9
EB
2736 }
2737
c2abccec 2738out:
13c28af8
PL
2739 if (!ret) {
2740 qemu_progress_print(100, 0);
2741 }
6b837bc4 2742 qemu_progress_end();
83d0521a
CL
2743 qemu_opts_del(opts);
2744 qemu_opts_free(create_opts);
8d65a3cc 2745 qobject_unref(open_opts);
9fd77f99
PL
2746 blk_unref(s.target);
2747 if (s.src) {
2748 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2749 blk_unref(s.src[bs_i]);
26f54e9a 2750 }
9fd77f99 2751 g_free(s.src);
26f54e9a 2752 }
9fd77f99 2753 g_free(s.src_sectors);
af8d43d3 2754 g_free(s.src_alignment);
64bb01aa 2755fail_getopt:
6aec830e 2756 qemu_opts_del(sn_opts);
64bb01aa
KW
2757 g_free(options);
2758
9fd77f99 2759 return !!ret;
ea2384d3
FB
2760}
2761
57d1a2b6 2762
faea38e7
FB
2763static void dump_snapshots(BlockDriverState *bs)
2764{
2765 QEMUSnapshotInfo *sn_tab, *sn;
2766 int nb_sns, i;
faea38e7
FB
2767
2768 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2769 if (nb_sns <= 0)
2770 return;
2771 printf("Snapshot list:\n");
e1ce7d74 2772 bdrv_snapshot_dump(NULL);
5b917044 2773 printf("\n");
faea38e7
FB
2774 for(i = 0; i < nb_sns; i++) {
2775 sn = &sn_tab[i];
e1ce7d74 2776 bdrv_snapshot_dump(sn);
5b917044 2777 printf("\n");
faea38e7 2778 }
7267c094 2779 g_free(sn_tab);
faea38e7
FB
2780}
2781
9699bf0d
SH
2782static void dump_json_image_info_list(ImageInfoList *list)
2783{
eab3a467 2784 GString *str;
9699bf0d 2785 QObject *obj;
7d5e199a 2786 Visitor *v = qobject_output_visitor_new(&obj);
3b098d56
EB
2787
2788 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2789 visit_complete(v, &obj);
6589f459 2790 str = qobject_to_json_pretty(obj, true);
9699bf0d 2791 assert(str != NULL);
eab3a467 2792 printf("%s\n", str->str);
cb3e7f08 2793 qobject_unref(obj);
3b098d56 2794 visit_free(v);
eab3a467 2795 g_string_free(str, true);
9699bf0d
SH
2796}
2797
c054b3fd
BC
2798static void dump_json_image_info(ImageInfo *info)
2799{
eab3a467 2800 GString *str;
c054b3fd 2801 QObject *obj;
7d5e199a 2802 Visitor *v = qobject_output_visitor_new(&obj);
3b098d56
EB
2803
2804 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2805 visit_complete(v, &obj);
6589f459 2806 str = qobject_to_json_pretty(obj, true);
c054b3fd 2807 assert(str != NULL);
eab3a467 2808 printf("%s\n", str->str);
cb3e7f08 2809 qobject_unref(obj);
3b098d56 2810 visit_free(v);
eab3a467 2811 g_string_free(str, true);
c054b3fd
BC
2812}
2813
9699bf0d
SH
2814static void dump_human_image_info_list(ImageInfoList *list)
2815{
2816 ImageInfoList *elem;
2817 bool delim = false;
2818
2819 for (elem = list; elem; elem = elem->next) {
2820 if (delim) {
2821 printf("\n");
2822 }
2823 delim = true;
2824
e1ce7d74 2825 bdrv_image_info_dump(elem->value);
9699bf0d
SH
2826 }
2827}
2828
2829static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2830{
2831 return strcmp(a, b) == 0;
2832}
2833
2834/**
2835 * Open an image file chain and return an ImageInfoList
2836 *
2837 * @filename: topmost image filename
2838 * @fmt: topmost image format (may be NULL to autodetect)
2839 * @chain: true - enumerate entire backing file chain
2840 * false - only topmost image file
2841 *
2842 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2843 * image file. If there was an error a message will have been printed to
2844 * stderr.
2845 */
eb769f74
DB
2846static ImageInfoList *collect_image_info_list(bool image_opts,
2847 const char *filename,
9699bf0d 2848 const char *fmt,
335e9937 2849 bool chain, bool force_share)
9699bf0d
SH
2850{
2851 ImageInfoList *head = NULL;
c3033fd3 2852 ImageInfoList **tail = &head;
9699bf0d 2853 GHashTable *filenames;
43526ec8 2854 Error *err = NULL;
9699bf0d
SH
2855
2856 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2857
2858 while (filename) {
26f54e9a 2859 BlockBackend *blk;
9699bf0d
SH
2860 BlockDriverState *bs;
2861 ImageInfo *info;
9699bf0d
SH
2862
2863 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2864 error_report("Backing file '%s' creates an infinite loop.",
2865 filename);
2866 goto err;
2867 }
2868 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2869
efaa7c4e 2870 blk = img_open(image_opts, filename, fmt,
335e9937
FZ
2871 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2872 force_share);
7e7d56d9 2873 if (!blk) {
9699bf0d
SH
2874 goto err;
2875 }
7e7d56d9 2876 bs = blk_bs(blk);
9699bf0d 2877
43526ec8 2878 bdrv_query_image_info(bs, &info, &err);
84d18f06 2879 if (err) {
565f65d2 2880 error_report_err(err);
26f54e9a 2881 blk_unref(blk);
43526ec8 2882 goto err;
fb0ed453 2883 }
9699bf0d 2884
c3033fd3 2885 QAPI_LIST_APPEND(tail, info);
9699bf0d 2886
26f54e9a 2887 blk_unref(blk);
9699bf0d 2888
0da7d13a 2889 /* Clear parameters that only apply to the topmost image */
9699bf0d 2890 filename = fmt = NULL;
0da7d13a
SH
2891 image_opts = false;
2892
9699bf0d
SH
2893 if (chain) {
2894 if (info->has_full_backing_filename) {
2895 filename = info->full_backing_filename;
2896 } else if (info->has_backing_filename) {
92d617ab
JS
2897 error_report("Could not determine absolute backing filename,"
2898 " but backing filename '%s' present",
2899 info->backing_filename);
2900 goto err;
9699bf0d
SH
2901 }
2902 if (info->has_backing_filename_format) {
2903 fmt = info->backing_filename_format;
2904 }
2905 }
2906 }
2907 g_hash_table_destroy(filenames);
2908 return head;
2909
2910err:
2911 qapi_free_ImageInfoList(head);
2912 g_hash_table_destroy(filenames);
2913 return NULL;
2914}
2915
c054b3fd
BC
2916static int img_info(int argc, char **argv)
2917{
2918 int c;
2919 OutputFormat output_format = OFORMAT_HUMAN;
9699bf0d 2920 bool chain = false;
c054b3fd 2921 const char *filename, *fmt, *output;
9699bf0d 2922 ImageInfoList *list;
eb769f74 2923 bool image_opts = false;
335e9937 2924 bool force_share = false;
c054b3fd 2925
ea2384d3 2926 fmt = NULL;
c054b3fd 2927 output = NULL;
ea2384d3 2928 for(;;) {
c054b3fd
BC
2929 int option_index = 0;
2930 static const struct option long_options[] = {
2931 {"help", no_argument, 0, 'h'},
2932 {"format", required_argument, 0, 'f'},
2933 {"output", required_argument, 0, OPTION_OUTPUT},
9699bf0d 2934 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
3babeb15 2935 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 2936 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 2937 {"force-share", no_argument, 0, 'U'},
c054b3fd
BC
2938 {0, 0, 0, 0}
2939 };
335e9937 2940 c = getopt_long(argc, argv, ":f:hU",
c054b3fd 2941 long_options, &option_index);
b8fb60da 2942 if (c == -1) {
ea2384d3 2943 break;
b8fb60da 2944 }
ea2384d3 2945 switch(c) {
c9192973
SH
2946 case ':':
2947 missing_argument(argv[optind - 1]);
2948 break;
ef87394c 2949 case '?':
c9192973
SH
2950 unrecognized_option(argv[optind - 1]);
2951 break;
ea2384d3
FB
2952 case 'h':
2953 help();
2954 break;
2955 case 'f':
2956 fmt = optarg;
2957 break;
335e9937
FZ
2958 case 'U':
2959 force_share = true;
2960 break;
c054b3fd
BC
2961 case OPTION_OUTPUT:
2962 output = optarg;
2963 break;
9699bf0d
SH
2964 case OPTION_BACKING_CHAIN:
2965 chain = true;
2966 break;
99b1e646
KW
2967 case OPTION_OBJECT:
2968 user_creatable_process_cmdline(optarg);
2969 break;
eb769f74
DB
2970 case OPTION_IMAGE_OPTS:
2971 image_opts = true;
2972 break;
ea2384d3
FB
2973 }
2974 }
fc11eb26 2975 if (optind != argc - 1) {
ac1307ab 2976 error_exit("Expecting one image file name");
b8fb60da 2977 }
ea2384d3
FB
2978 filename = argv[optind++];
2979
c054b3fd
BC
2980 if (output && !strcmp(output, "json")) {
2981 output_format = OFORMAT_JSON;
2982 } else if (output && !strcmp(output, "human")) {
2983 output_format = OFORMAT_HUMAN;
2984 } else if (output) {
2985 error_report("--output must be used with human or json as argument.");
c2abccec
MK
2986 return 1;
2987 }
c054b3fd 2988
335e9937
FZ
2989 list = collect_image_info_list(image_opts, filename, fmt, chain,
2990 force_share);
9699bf0d 2991 if (!list) {
c2abccec 2992 return 1;
faea38e7 2993 }
c054b3fd 2994
c054b3fd
BC
2995 switch (output_format) {
2996 case OFORMAT_HUMAN:
9699bf0d 2997 dump_human_image_info_list(list);
c054b3fd
BC
2998 break;
2999 case OFORMAT_JSON:
9699bf0d
SH
3000 if (chain) {
3001 dump_json_image_info_list(list);
3002 } else {
3003 dump_json_image_info(list->value);
3004 }
c054b3fd 3005 break;
faea38e7 3006 }
c054b3fd 3007
9699bf0d 3008 qapi_free_ImageInfoList(list);
ea2384d3
FB
3009 return 0;
3010}
3011
30065d14
EB
3012static int dump_map_entry(OutputFormat output_format, MapEntry *e,
3013 MapEntry *next)
4c93a13b
PB
3014{
3015 switch (output_format) {
3016 case OFORMAT_HUMAN:
16b0d555 3017 if (e->data && !e->has_offset) {
4c93a13b 3018 error_report("File contains external, encrypted or compressed clusters.");
30065d14 3019 return -1;
4c93a13b 3020 }
16b0d555 3021 if (e->data && !e->zero) {
4c93a13b 3022 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
16b0d555
FZ
3023 e->start, e->length,
3024 e->has_offset ? e->offset : 0,
3025 e->has_filename ? e->filename : "");
4c93a13b
PB
3026 }
3027 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
3028 * Modify the flags here to allow more coalescing.
3029 */
16b0d555
FZ
3030 if (next && (!next->data || next->zero)) {
3031 next->data = false;
3032 next->zero = true;
4c93a13b
PB
3033 }
3034 break;
3035 case OFORMAT_JSON:
e46c0b18 3036 printf("{ \"start\": %"PRId64", \"length\": %"PRId64","
8417e137
EB
3037 " \"depth\": %"PRId64", \"present\": %s, \"zero\": %s,"
3038 " \"data\": %s", e->start, e->length, e->depth,
3039 e->present ? "true" : "false",
16b0d555
FZ
3040 e->zero ? "true" : "false",
3041 e->data ? "true" : "false");
3042 if (e->has_offset) {
c745bfb4 3043 printf(", \"offset\": %"PRId64"", e->offset);
4c93a13b
PB
3044 }
3045 putchar('}');
3046
e46c0b18
EM
3047 if (next) {
3048 puts(",");
4c93a13b
PB
3049 }
3050 break;
3051 }
30065d14 3052 return 0;
4c93a13b
PB
3053}
3054
5e344dd8
EB
3055static int get_block_status(BlockDriverState *bs, int64_t offset,
3056 int64_t bytes, MapEntry *e)
4c93a13b 3057{
237d78f8 3058 int ret;
4c93a13b 3059 int depth;
67a0fd2a 3060 BlockDriverState *file;
2875645b 3061 bool has_offset;
237d78f8 3062 int64_t map;
f30c66ba 3063 char *filename = NULL;
4c93a13b
PB
3064
3065 /* As an optimization, we could cache the current range of unallocated
3066 * clusters in each file of the chain, and avoid querying the same
3067 * range repeatedly.
3068 */
3069
3070 depth = 0;
3071 for (;;) {
4a2061e6 3072 bs = bdrv_skip_filters(bs);
237d78f8 3073 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
4c93a13b
PB
3074 if (ret < 0) {
3075 return ret;
3076 }
237d78f8 3077 assert(bytes);
4c93a13b
PB
3078 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
3079 break;
3080 }
4a2061e6 3081 bs = bdrv_cow_bs(bs);
4c93a13b
PB
3082 if (bs == NULL) {
3083 ret = 0;
3084 break;
3085 }
3086
3087 depth++;
3088 }
3089
2875645b
JS
3090 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
3091
f30c66ba
HR
3092 if (file && has_offset) {
3093 bdrv_refresh_filename(file);
3094 filename = file->filename;
3095 }
3096
2875645b 3097 *e = (MapEntry) {
5e344dd8 3098 .start = offset,
237d78f8 3099 .length = bytes,
2875645b
JS
3100 .data = !!(ret & BDRV_BLOCK_DATA),
3101 .zero = !!(ret & BDRV_BLOCK_ZERO),
237d78f8 3102 .offset = map,
2875645b
JS
3103 .has_offset = has_offset,
3104 .depth = depth,
8417e137 3105 .present = !!(ret & BDRV_BLOCK_ALLOCATED),
f30c66ba
HR
3106 .has_filename = filename,
3107 .filename = filename,
2875645b
JS
3108 };
3109
4c93a13b
PB
3110 return 0;
3111}
3112
16b0d555
FZ
3113static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
3114{
3115 if (curr->length == 0) {
3116 return false;
3117 }
3118 if (curr->zero != next->zero ||
3119 curr->data != next->data ||
3120 curr->depth != next->depth ||
8417e137 3121 curr->present != next->present ||
16b0d555
FZ
3122 curr->has_filename != next->has_filename ||
3123 curr->has_offset != next->has_offset) {
3124 return false;
3125 }
3126 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
3127 return false;
3128 }
3129 if (curr->has_offset && curr->offset + curr->length != next->offset) {
3130 return false;
3131 }
3132 return true;
3133}
3134
4c93a13b
PB
3135static int img_map(int argc, char **argv)
3136{
3137 int c;
3138 OutputFormat output_format = OFORMAT_HUMAN;
26f54e9a 3139 BlockBackend *blk;
4c93a13b
PB
3140 BlockDriverState *bs;
3141 const char *filename, *fmt, *output;
3142 int64_t length;
3143 MapEntry curr = { .length = 0 }, next;
3144 int ret = 0;
eb769f74 3145 bool image_opts = false;
335e9937 3146 bool force_share = false;
c0469496
EM
3147 int64_t start_offset = 0;
3148 int64_t max_length = -1;
4c93a13b
PB
3149
3150 fmt = NULL;
3151 output = NULL;
3152 for (;;) {
3153 int option_index = 0;
3154 static const struct option long_options[] = {
3155 {"help", no_argument, 0, 'h'},
3156 {"format", required_argument, 0, 'f'},
3157 {"output", required_argument, 0, OPTION_OUTPUT},
3babeb15 3158 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 3159 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 3160 {"force-share", no_argument, 0, 'U'},
c0469496
EM
3161 {"start-offset", required_argument, 0, 's'},
3162 {"max-length", required_argument, 0, 'l'},
4c93a13b
PB
3163 {0, 0, 0, 0}
3164 };
c0469496 3165 c = getopt_long(argc, argv, ":f:s:l:hU",
4c93a13b
PB
3166 long_options, &option_index);
3167 if (c == -1) {
3168 break;
3169 }
3170 switch (c) {
c9192973
SH
3171 case ':':
3172 missing_argument(argv[optind - 1]);
3173 break;
4c93a13b 3174 case '?':
c9192973
SH
3175 unrecognized_option(argv[optind - 1]);
3176 break;
4c93a13b
PB
3177 case 'h':
3178 help();
3179 break;
3180 case 'f':
3181 fmt = optarg;
3182 break;
335e9937
FZ
3183 case 'U':
3184 force_share = true;
3185 break;
4c93a13b
PB
3186 case OPTION_OUTPUT:
3187 output = optarg;
3188 break;
c0469496
EM
3189 case 's':
3190 start_offset = cvtnum("start offset", optarg);
3191 if (start_offset < 0) {
3192 return 1;
3193 }
3194 break;
3195 case 'l':
3196 max_length = cvtnum("max length", optarg);
3197 if (max_length < 0) {
3198 return 1;
3199 }
3200 break;
99b1e646
KW
3201 case OPTION_OBJECT:
3202 user_creatable_process_cmdline(optarg);
3203 break;
eb769f74
DB
3204 case OPTION_IMAGE_OPTS:
3205 image_opts = true;
3206 break;
4c93a13b
PB
3207 }
3208 }
ac1307ab
FZ
3209 if (optind != argc - 1) {
3210 error_exit("Expecting one image file name");
4c93a13b 3211 }
ac1307ab 3212 filename = argv[optind];
4c93a13b
PB
3213
3214 if (output && !strcmp(output, "json")) {
3215 output_format = OFORMAT_JSON;
3216 } else if (output && !strcmp(output, "human")) {
3217 output_format = OFORMAT_HUMAN;
3218 } else if (output) {
3219 error_report("--output must be used with human or json as argument.");
3220 return 1;
3221 }
3222
335e9937 3223 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
7e7d56d9
MA
3224 if (!blk) {
3225 return 1;
4c93a13b 3226 }
7e7d56d9 3227 bs = blk_bs(blk);
4c93a13b
PB
3228
3229 if (output_format == OFORMAT_HUMAN) {
3230 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
e46c0b18
EM
3231 } else if (output_format == OFORMAT_JSON) {
3232 putchar('[');
4c93a13b
PB
3233 }
3234
f1d3cd79 3235 length = blk_getlength(blk);
8f282e83
EM
3236 if (length < 0) {
3237 error_report("Failed to get size for '%s'", filename);
3238 return 1;
3239 }
c0469496
EM
3240 if (max_length != -1) {
3241 length = MIN(start_offset + max_length, length);
3242 }
8f282e83 3243
c0469496 3244 curr.start = start_offset;
4c93a13b 3245 while (curr.start + curr.length < length) {
5e344dd8 3246 int64_t offset = curr.start + curr.length;
d0ceea88 3247 int64_t n = length - offset;
4c93a13b 3248
5e344dd8 3249 ret = get_block_status(bs, offset, n, &next);
4c93a13b
PB
3250 if (ret < 0) {
3251 error_report("Could not read file metadata: %s", strerror(-ret));
3252 goto out;
3253 }
3254
16b0d555 3255 if (entry_mergeable(&curr, &next)) {
4c93a13b
PB
3256 curr.length += next.length;
3257 continue;
3258 }
3259
3260 if (curr.length > 0) {
30065d14
EB
3261 ret = dump_map_entry(output_format, &curr, &next);
3262 if (ret < 0) {
3263 goto out;
3264 }
4c93a13b
PB
3265 }
3266 curr = next;
3267 }
3268
30065d14 3269 ret = dump_map_entry(output_format, &curr, NULL);
e46c0b18
EM
3270 if (output_format == OFORMAT_JSON) {
3271 puts("]");
3272 }
4c93a13b
PB
3273
3274out:
26f54e9a 3275 blk_unref(blk);
4c93a13b
PB
3276 return ret < 0;
3277}
3278
f7b4a940
AL
3279#define SNAPSHOT_LIST 1
3280#define SNAPSHOT_CREATE 2
3281#define SNAPSHOT_APPLY 3
3282#define SNAPSHOT_DELETE 4
3283
153859be 3284static int img_snapshot(int argc, char **argv)
f7b4a940 3285{
26f54e9a 3286 BlockBackend *blk;
f7b4a940
AL
3287 BlockDriverState *bs;
3288 QEMUSnapshotInfo sn;
3289 char *filename, *snapshot_name = NULL;
c2abccec 3290 int c, ret = 0, bdrv_oflags;
f7b4a940
AL
3291 int action = 0;
3292 qemu_timeval tv;
f382d43a 3293 bool quiet = false;
a89d89d3 3294 Error *err = NULL;
eb769f74 3295 bool image_opts = false;
335e9937 3296 bool force_share = false;
f7b4a940 3297
ce099547 3298 bdrv_oflags = BDRV_O_RDWR;
f7b4a940
AL
3299 /* Parse commandline parameters */
3300 for(;;) {
3babeb15
DB
3301 static const struct option long_options[] = {
3302 {"help", no_argument, 0, 'h'},
3303 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 3304 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 3305 {"force-share", no_argument, 0, 'U'},
3babeb15
DB
3306 {0, 0, 0, 0}
3307 };
335e9937 3308 c = getopt_long(argc, argv, ":la:c:d:hqU",
3babeb15 3309 long_options, NULL);
b8fb60da 3310 if (c == -1) {
f7b4a940 3311 break;
b8fb60da 3312 }
f7b4a940 3313 switch(c) {
c9192973
SH
3314 case ':':
3315 missing_argument(argv[optind - 1]);
3316 break;
ef87394c 3317 case '?':
c9192973
SH
3318 unrecognized_option(argv[optind - 1]);
3319 break;
f7b4a940
AL
3320 case 'h':
3321 help();
153859be 3322 return 0;
f7b4a940
AL
3323 case 'l':
3324 if (action) {
ac1307ab 3325 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 3326 return 0;
f7b4a940
AL
3327 }
3328 action = SNAPSHOT_LIST;
f5edb014 3329 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
f7b4a940
AL
3330 break;
3331 case 'a':
3332 if (action) {
ac1307ab 3333 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 3334 return 0;
f7b4a940
AL
3335 }
3336 action = SNAPSHOT_APPLY;
3337 snapshot_name = optarg;
3338 break;
3339 case 'c':
3340 if (action) {
ac1307ab 3341 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 3342 return 0;
f7b4a940
AL
3343 }
3344 action = SNAPSHOT_CREATE;
3345 snapshot_name = optarg;
3346 break;
3347 case 'd':
3348 if (action) {
ac1307ab 3349 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
153859be 3350 return 0;
f7b4a940
AL
3351 }
3352 action = SNAPSHOT_DELETE;
3353 snapshot_name = optarg;
3354 break;
f382d43a
MR
3355 case 'q':
3356 quiet = true;
3357 break;
335e9937
FZ
3358 case 'U':
3359 force_share = true;
3360 break;
99b1e646
KW
3361 case OPTION_OBJECT:
3362 user_creatable_process_cmdline(optarg);
3363 break;
eb769f74
DB
3364 case OPTION_IMAGE_OPTS:
3365 image_opts = true;
3366 break;
f7b4a940
AL
3367 }
3368 }
3369
fc11eb26 3370 if (optind != argc - 1) {
ac1307ab 3371 error_exit("Expecting one image file name");
b8fb60da 3372 }
f7b4a940
AL
3373 filename = argv[optind++];
3374
3375 /* Open the image */
335e9937
FZ
3376 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3377 force_share);
7e7d56d9
MA
3378 if (!blk) {
3379 return 1;
c2abccec 3380 }
7e7d56d9 3381 bs = blk_bs(blk);
f7b4a940
AL
3382
3383 /* Perform the requested action */
3384 switch(action) {
3385 case SNAPSHOT_LIST:
3386 dump_snapshots(bs);
3387 break;
3388
3389 case SNAPSHOT_CREATE:
3390 memset(&sn, 0, sizeof(sn));
3391 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3392
3393 qemu_gettimeofday(&tv);
3394 sn.date_sec = tv.tv_sec;
3395 sn.date_nsec = tv.tv_usec * 1000;
3396
3397 ret = bdrv_snapshot_create(bs, &sn);
b8fb60da 3398 if (ret) {
15654a6d 3399 error_report("Could not create snapshot '%s': %d (%s)",
f7b4a940 3400 snapshot_name, ret, strerror(-ret));
b8fb60da 3401 }
f7b4a940
AL
3402 break;
3403
3404 case SNAPSHOT_APPLY:
0b62bcbc 3405 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
b8fb60da 3406 if (ret) {
0b62bcbc
KW
3407 error_reportf_err(err, "Could not apply snapshot '%s': ",
3408 snapshot_name);
b8fb60da 3409 }
f7b4a940
AL
3410 break;
3411
3412 case SNAPSHOT_DELETE:
8c04093c
DHB
3413 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3414 if (ret < 0) {
3415 error_report("Could not delete snapshot '%s': snapshot not "
3416 "found", snapshot_name);
a89d89d3 3417 ret = 1;
8c04093c
DHB
3418 } else {
3419 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3420 if (ret < 0) {
3421 error_reportf_err(err, "Could not delete snapshot '%s': ",
3422 snapshot_name);
3423 ret = 1;
3424 }
b8fb60da 3425 }
f7b4a940
AL
3426 break;
3427 }
3428
3429 /* Cleanup */
26f54e9a 3430 blk_unref(blk);
c2abccec
MK
3431 if (ret) {
3432 return 1;
3433 }
153859be 3434 return 0;
f7b4a940
AL
3435}
3436
3e85c6fd
KW
3437static int img_rebase(int argc, char **argv)
3438{
26f54e9a 3439 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
396374ca
PB
3440 uint8_t *buf_old = NULL;
3441 uint8_t *buf_new = NULL;
863cc78f 3442 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
4a2061e6 3443 BlockDriverState *unfiltered_bs;
3e85c6fd 3444 char *filename;
40055951
HR
3445 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3446 int c, flags, src_flags, ret;
ce099547 3447 bool writethrough, src_writethrough;
3e85c6fd 3448 int unsafe = 0;
335e9937 3449 bool force_share = false;
6b837bc4 3450 int progress = 0;
f382d43a 3451 bool quiet = false;
34b5d2c6 3452 Error *local_err = NULL;
eb769f74 3453 bool image_opts = false;
3e85c6fd
KW
3454
3455 /* Parse commandline parameters */
e53dbee0 3456 fmt = NULL;
661a0f71 3457 cache = BDRV_DEFAULT_CACHE;
40055951 3458 src_cache = BDRV_DEFAULT_CACHE;
3e85c6fd
KW
3459 out_baseimg = NULL;
3460 out_basefmt = NULL;
3e85c6fd 3461 for(;;) {
3babeb15
DB
3462 static const struct option long_options[] = {
3463 {"help", no_argument, 0, 'h'},
3464 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 3465 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 3466 {"force-share", no_argument, 0, 'U'},
3babeb15
DB
3467 {0, 0, 0, 0}
3468 };
335e9937 3469 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
3babeb15 3470 long_options, NULL);
b8fb60da 3471 if (c == -1) {
3e85c6fd 3472 break;
b8fb60da 3473 }
3e85c6fd 3474 switch(c) {
c9192973
SH
3475 case ':':
3476 missing_argument(argv[optind - 1]);
3477 break;
ef87394c 3478 case '?':
c9192973
SH
3479 unrecognized_option(argv[optind - 1]);
3480 break;
3e85c6fd
KW
3481 case 'h':
3482 help();
3483 return 0;
e53dbee0
KW
3484 case 'f':
3485 fmt = optarg;
3486 break;
3e85c6fd
KW
3487 case 'F':
3488 out_basefmt = optarg;
3489 break;
3490 case 'b':
3491 out_baseimg = optarg;
3492 break;
3493 case 'u':
3494 unsafe = 1;
3495 break;
6b837bc4
JS
3496 case 'p':
3497 progress = 1;
3498 break;
661a0f71
FS
3499 case 't':
3500 cache = optarg;
3501 break;
40055951
HR
3502 case 'T':
3503 src_cache = optarg;
3504 break;
f382d43a
MR
3505 case 'q':
3506 quiet = true;
3507 break;
99b1e646
KW
3508 case OPTION_OBJECT:
3509 user_creatable_process_cmdline(optarg);
3510 break;
eb769f74
DB
3511 case OPTION_IMAGE_OPTS:
3512 image_opts = true;
3513 break;
335e9937
FZ
3514 case 'U':
3515 force_share = true;
3516 break;
3e85c6fd
KW
3517 }
3518 }
3519
f382d43a
MR
3520 if (quiet) {
3521 progress = 0;
3522 }
3523
ac1307ab
FZ
3524 if (optind != argc - 1) {
3525 error_exit("Expecting one image file name");
3526 }
3527 if (!unsafe && !out_baseimg) {
3528 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
b8fb60da 3529 }
3e85c6fd
KW
3530 filename = argv[optind++];
3531
6b837bc4
JS
3532 qemu_progress_init(progress, 2.0);
3533 qemu_progress_print(0, 100);
3534
661a0f71 3535 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
ce099547 3536 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
661a0f71
FS
3537 if (ret < 0) {
3538 error_report("Invalid cache option: %s", cache);
40ed35a3 3539 goto out;
661a0f71
FS
3540 }
3541
ce099547
KW
3542 src_flags = 0;
3543 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
40055951
HR
3544 if (ret < 0) {
3545 error_report("Invalid source cache option: %s", src_cache);
40ed35a3 3546 goto out;
40055951
HR
3547 }
3548
ce099547
KW
3549 /* The source files are opened read-only, don't care about WCE */
3550 assert((src_flags & BDRV_O_RDWR) == 0);
3551 (void) src_writethrough;
3552
3e85c6fd
KW
3553 /*
3554 * Open the images.
3555 *
3556 * Ignore the old backing file for unsafe rebase in case we want to correct
3557 * the reference to a renamed or moved backing file.
3558 */
335e9937
FZ
3559 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3560 false);
7e7d56d9 3561 if (!blk) {
40ed35a3
SH
3562 ret = -1;
3563 goto out;
c2abccec 3564 }
7e7d56d9 3565 bs = blk_bs(blk);
3e85c6fd 3566
4a2061e6
HR
3567 unfiltered_bs = bdrv_skip_filters(bs);
3568
3e85c6fd 3569 if (out_basefmt != NULL) {
644483d9 3570 if (bdrv_find_format(out_basefmt) == NULL) {
15654a6d 3571 error_report("Invalid format name: '%s'", out_basefmt);
c2abccec
MK
3572 ret = -1;
3573 goto out;
3e85c6fd
KW
3574 }
3575 }
3576
3577 /* For safe rebasing we need to compare old and new backing file */
40ed35a3 3578 if (!unsafe) {
644483d9 3579 QDict *options = NULL;
4a2061e6 3580 BlockDriverState *base_bs = bdrv_cow_bs(unfiltered_bs);
644483d9 3581
4ebe0617 3582 if (base_bs) {
d861ab3a
KW
3583 blk_old_backing = blk_new(qemu_get_aio_context(),
3584 BLK_PERM_CONSISTENT_READ,
4ebe0617
SE
3585 BLK_PERM_ALL);
3586 ret = blk_insert_bs(blk_old_backing, base_bs,
3587 &local_err);
3588 if (ret < 0) {
35ddd930 3589 error_reportf_err(local_err,
4ebe0617
SE
3590 "Could not reuse old backing file '%s': ",
3591 base_bs->filename);
35ddd930
HR
3592 goto out;
3593 }
3594 } else {
3595 blk_old_backing = NULL;
3e85c6fd 3596 }
644483d9 3597
a616673d 3598 if (out_baseimg[0]) {
d16699b6
HR
3599 const char *overlay_filename;
3600 char *out_real_path;
3601
335e9937 3602 options = qdict_new();
644483d9 3603 if (out_basefmt) {
46f5ac20 3604 qdict_put_str(options, "driver", out_basefmt);
335e9937
FZ
3605 }
3606 if (force_share) {
3607 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
644483d9
HR
3608 }
3609
f30c66ba 3610 bdrv_refresh_filename(bs);
d16699b6
HR
3611 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3612 : bs->filename;
645ae7d8
HR
3613 out_real_path =
3614 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3615 out_baseimg,
3616 &local_err);
d16699b6 3617 if (local_err) {
f22356d9 3618 qobject_unref(options);
d16699b6
HR
3619 error_reportf_err(local_err,
3620 "Could not resolve backing filename: ");
3621 ret = -1;
d16699b6
HR
3622 goto out;
3623 }
3624
863cc78f
SE
3625 /*
3626 * Find out whether we rebase an image on top of a previous image
3627 * in its chain.
3628 */
3629 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
330c7295 3630 if (prefix_chain_bs) {
f22356d9 3631 qobject_unref(options);
330c7295 3632 g_free(out_real_path);
f22356d9 3633
d861ab3a
KW
3634 blk_new_backing = blk_new(qemu_get_aio_context(),
3635 BLK_PERM_CONSISTENT_READ,
330c7295
SE
3636 BLK_PERM_ALL);
3637 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
3638 &local_err);
3639 if (ret < 0) {
3640 error_reportf_err(local_err,
3641 "Could not reuse backing file '%s': ",
3642 out_baseimg);
3643 goto out;
3644 }
3645 } else {
3646 blk_new_backing = blk_new_open(out_real_path, NULL,
3647 options, src_flags, &local_err);
3648 g_free(out_real_path);
3649 if (!blk_new_backing) {
3650 error_reportf_err(local_err,
3651 "Could not open new backing file '%s': ",
3652 out_baseimg);
3653 ret = -1;
3654 goto out;
3655 }
a616673d 3656 }
3e85c6fd
KW
3657 }
3658 }
3659
3660 /*
3661 * Check each unallocated cluster in the COW file. If it is unallocated,
3662 * accesses go to the backing file. We must therefore compare this cluster
3663 * in the old and new backing file, and if they differ we need to copy it
3664 * from the old backing file into the COW file.
3665 *
3666 * If qemu-img crashes during this step, no harm is done. The content of
3667 * the image is the same as the original one at any time.
3668 */
3669 if (!unsafe) {
41536287 3670 int64_t size;
35ddd930 3671 int64_t old_backing_size = 0;
41536287
EB
3672 int64_t new_backing_size = 0;
3673 uint64_t offset;
3674 int64_t n;
1f710495 3675 float local_progress = 0;
d6771bfa 3676
f1d3cd79
HR
3677 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3678 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
3e85c6fd 3679
41536287
EB
3680 size = blk_getlength(blk);
3681 if (size < 0) {
52bf1e72 3682 error_report("Could not get size of '%s': %s",
41536287 3683 filename, strerror(-size));
52bf1e72
MA
3684 ret = -1;
3685 goto out;
3686 }
35ddd930
HR
3687 if (blk_old_backing) {
3688 old_backing_size = blk_getlength(blk_old_backing);
3689 if (old_backing_size < 0) {
3690 char backing_name[PATH_MAX];
52bf1e72 3691
35ddd930
HR
3692 bdrv_get_backing_filename(bs, backing_name,
3693 sizeof(backing_name));
3694 error_report("Could not get size of '%s': %s",
3695 backing_name, strerror(-old_backing_size));
3696 ret = -1;
3697 goto out;
3698 }
52bf1e72 3699 }
f1d3cd79 3700 if (blk_new_backing) {
41536287
EB
3701 new_backing_size = blk_getlength(blk_new_backing);
3702 if (new_backing_size < 0) {
52bf1e72 3703 error_report("Could not get size of '%s': %s",
41536287 3704 out_baseimg, strerror(-new_backing_size));
52bf1e72
MA
3705 ret = -1;
3706 goto out;
3707 }
a616673d 3708 }
3e85c6fd 3709
41536287
EB
3710 if (size != 0) {
3711 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
1f710495
KW
3712 }
3713
41536287 3714 for (offset = 0; offset < size; offset += n) {
1c6e8779
HR
3715 bool buf_old_is_zero = false;
3716
41536287
EB
3717 /* How many bytes can we handle with the next read? */
3718 n = MIN(IO_BUF_SIZE, size - offset);
3e85c6fd
KW
3719
3720 /* If the cluster is allocated, we don't need to take action */
4a2061e6 3721 ret = bdrv_is_allocated(unfiltered_bs, offset, n, &n);
d663640c
PB
3722 if (ret < 0) {
3723 error_report("error while reading image metadata: %s",
3724 strerror(-ret));
3725 goto out;
3726 }
cc60e327 3727 if (ret) {
3e85c6fd
KW
3728 continue;
3729 }
3730
863cc78f
SE
3731 if (prefix_chain_bs) {
3732 /*
3733 * If cluster wasn't changed since prefix_chain, we don't need
3734 * to take action
3735 */
4a2061e6
HR
3736 ret = bdrv_is_allocated_above(bdrv_cow_bs(unfiltered_bs),
3737 prefix_chain_bs, false,
3738 offset, n, &n);
863cc78f
SE
3739 if (ret < 0) {
3740 error_report("error while reading image metadata: %s",
3741 strerror(-ret));
3742 goto out;
3743 }
3744 if (!ret) {
3745 continue;
3746 }
3747 }
3748
87a1b3e3
KW
3749 /*
3750 * Read old and new backing file and take into consideration that
3751 * backing files may be smaller than the COW image.
3752 */
41536287
EB
3753 if (offset >= old_backing_size) {
3754 memset(buf_old, 0, n);
1c6e8779 3755 buf_old_is_zero = true;
87a1b3e3 3756 } else {
41536287
EB
3757 if (offset + n > old_backing_size) {
3758 n = old_backing_size - offset;
87a1b3e3
KW
3759 }
3760
41536287 3761 ret = blk_pread(blk_old_backing, offset, buf_old, n);
87a1b3e3
KW
3762 if (ret < 0) {
3763 error_report("error while reading from old backing file");
3764 goto out;
3765 }
3e85c6fd 3766 }
87a1b3e3 3767
41536287
EB
3768 if (offset >= new_backing_size || !blk_new_backing) {
3769 memset(buf_new, 0, n);
87a1b3e3 3770 } else {
41536287
EB
3771 if (offset + n > new_backing_size) {
3772 n = new_backing_size - offset;
87a1b3e3
KW
3773 }
3774
41536287 3775 ret = blk_pread(blk_new_backing, offset, buf_new, n);
87a1b3e3
KW
3776 if (ret < 0) {
3777 error_report("error while reading from new backing file");
3778 goto out;
3779 }
3e85c6fd
KW
3780 }
3781
3782 /* If they differ, we need to write to the COW file */
3783 uint64_t written = 0;
3784
41536287 3785 while (written < n) {
dc61cd3b 3786 int64_t pnum;
3e85c6fd 3787
41536287
EB
3788 if (compare_buffers(buf_old + written, buf_new + written,
3789 n - written, &pnum))
3e85c6fd 3790 {
1c6e8779
HR
3791 if (buf_old_is_zero) {
3792 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0);
3793 } else {
3794 ret = blk_pwrite(blk, offset + written,
3795 buf_old + written, pnum, 0);
3796 }
3e85c6fd 3797 if (ret < 0) {
15654a6d 3798 error_report("Error while writing to COW image: %s",
3e85c6fd 3799 strerror(-ret));
c2abccec 3800 goto out;
3e85c6fd
KW
3801 }
3802 }
3803
3804 written += pnum;
3805 }
6b837bc4 3806 qemu_progress_print(local_progress, 100);
3e85c6fd
KW
3807 }
3808 }
3809
3810 /*
3811 * Change the backing file. All clusters that are different from the old
3812 * backing file are overwritten in the COW file now, so the visible content
3813 * doesn't change when we switch the backing file.
3814 */
a616673d 3815 if (out_baseimg && *out_baseimg) {
4a2061e6
HR
3816 ret = bdrv_change_backing_file(unfiltered_bs, out_baseimg, out_basefmt,
3817 true);
a616673d 3818 } else {
4a2061e6 3819 ret = bdrv_change_backing_file(unfiltered_bs, NULL, NULL, false);
a616673d
AB
3820 }
3821
3e85c6fd 3822 if (ret == -ENOSPC) {
15654a6d
JS
3823 error_report("Could not change the backing file to '%s': No "
3824 "space left in the file header", out_baseimg);
a7cd44be
EB
3825 } else if (ret == -EINVAL && out_baseimg && !out_basefmt) {
3826 error_report("Could not change the backing file to '%s': backing "
3827 "format must be specified", out_baseimg);
3e85c6fd 3828 } else if (ret < 0) {
15654a6d 3829 error_report("Could not change the backing file to '%s': %s",
3e85c6fd
KW
3830 out_baseimg, strerror(-ret));
3831 }
3832
6b837bc4 3833 qemu_progress_print(100, 0);
3e85c6fd
KW
3834 /*
3835 * TODO At this point it is possible to check if any clusters that are
3836 * allocated in the COW file are the same in the backing file. If so, they
3837 * could be dropped from the COW file. Don't do this before switching the
3838 * backing file, in case of a crash this would lead to corruption.
3839 */
c2abccec 3840out:
6b837bc4 3841 qemu_progress_end();
3e85c6fd
KW
3842 /* Cleanup */
3843 if (!unsafe) {
26f54e9a 3844 blk_unref(blk_old_backing);
26f54e9a 3845 blk_unref(blk_new_backing);
3e85c6fd 3846 }
396374ca
PB
3847 qemu_vfree(buf_old);
3848 qemu_vfree(buf_new);
3e85c6fd 3849
26f54e9a 3850 blk_unref(blk);
c2abccec
MK
3851 if (ret) {
3852 return 1;
3853 }
3e85c6fd
KW
3854 return 0;
3855}
3856
ae6b0ed6
SH
3857static int img_resize(int argc, char **argv)
3858{
6750e795 3859 Error *err = NULL;
ae6b0ed6
SH
3860 int c, ret, relative;
3861 const char *filename, *fmt, *size;
09c5c6de 3862 int64_t n, total_size, current_size;
f382d43a 3863 bool quiet = false;
26f54e9a 3864 BlockBackend *blk = NULL;
dc5f690b 3865 PreallocMode prealloc = PREALLOC_MODE_OFF;
20caf0f7 3866 QemuOpts *param;
3babeb15 3867
20caf0f7
DXW
3868 static QemuOptsList resize_options = {
3869 .name = "resize_options",
3870 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3871 .desc = {
3872 {
3873 .name = BLOCK_OPT_SIZE,
3874 .type = QEMU_OPT_SIZE,
3875 .help = "Virtual disk size"
3876 }, {
3877 /* end of list */
3878 }
ae6b0ed6 3879 },
ae6b0ed6 3880 };
eb769f74 3881 bool image_opts = false;
4ffca890 3882 bool shrink = false;
ae6b0ed6 3883
e80fec7f
KW
3884 /* Remove size from argv manually so that negative numbers are not treated
3885 * as options by getopt. */
3886 if (argc < 3) {
ac1307ab 3887 error_exit("Not enough arguments");
e80fec7f
KW
3888 return 1;
3889 }
3890
3891 size = argv[--argc];
3892
3893 /* Parse getopt arguments */
ae6b0ed6
SH
3894 fmt = NULL;
3895 for(;;) {
3babeb15
DB
3896 static const struct option long_options[] = {
3897 {"help", no_argument, 0, 'h'},
3898 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 3899 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
dc5f690b 3900 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
4ffca890 3901 {"shrink", no_argument, 0, OPTION_SHRINK},
3babeb15
DB
3902 {0, 0, 0, 0}
3903 };
c9192973 3904 c = getopt_long(argc, argv, ":f:hq",
3babeb15 3905 long_options, NULL);
ae6b0ed6
SH
3906 if (c == -1) {
3907 break;
3908 }
3909 switch(c) {
c9192973
SH
3910 case ':':
3911 missing_argument(argv[optind - 1]);
3912 break;
ef87394c 3913 case '?':
c9192973
SH
3914 unrecognized_option(argv[optind - 1]);
3915 break;
ae6b0ed6
SH
3916 case 'h':
3917 help();
3918 break;
3919 case 'f':
3920 fmt = optarg;
3921 break;
f382d43a
MR
3922 case 'q':
3923 quiet = true;
3924 break;
99b1e646
KW
3925 case OPTION_OBJECT:
3926 user_creatable_process_cmdline(optarg);
3927 break;
eb769f74
DB
3928 case OPTION_IMAGE_OPTS:
3929 image_opts = true;
3930 break;
dc5f690b 3931 case OPTION_PREALLOCATION:
f7abe0ec 3932 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
06c60b6c 3933 PREALLOC_MODE__MAX, NULL);
dc5f690b
HR
3934 if (prealloc == PREALLOC_MODE__MAX) {
3935 error_report("Invalid preallocation mode '%s'", optarg);
3936 return 1;
3937 }
3938 break;
4ffca890
PB
3939 case OPTION_SHRINK:
3940 shrink = true;
3941 break;
ae6b0ed6
SH
3942 }
3943 }
fc11eb26 3944 if (optind != argc - 1) {
be8fbd47 3945 error_exit("Expecting image file name and size");
ae6b0ed6
SH
3946 }
3947 filename = argv[optind++];
ae6b0ed6
SH
3948
3949 /* Choose grow, shrink, or absolute resize mode */
3950 switch (size[0]) {
3951 case '+':
3952 relative = 1;
3953 size++;
3954 break;
3955 case '-':
3956 relative = -1;
3957 size++;
3958 break;
3959 default:
3960 relative = 0;
3961 break;
3962 }
3963
3964 /* Parse size */
87ea75d5 3965 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
235e59cf 3966 if (!qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err)) {
6750e795 3967 error_report_err(err);
2a81998a 3968 ret = -1;
20caf0f7 3969 qemu_opts_del(param);
2a81998a 3970 goto out;
ae6b0ed6 3971 }
20caf0f7
DXW
3972 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3973 qemu_opts_del(param);
ae6b0ed6 3974
efaa7c4e 3975 blk = img_open(image_opts, filename, fmt,
335e9937
FZ
3976 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
3977 false);
7e7d56d9 3978 if (!blk) {
2a81998a
JS
3979 ret = -1;
3980 goto out;
c2abccec 3981 }
ae6b0ed6 3982
dc5f690b
HR
3983 current_size = blk_getlength(blk);
3984 if (current_size < 0) {
3985 error_report("Failed to inquire current image length: %s",
3986 strerror(-current_size));
3987 ret = -1;
3988 goto out;
3989 }
3990
ae6b0ed6 3991 if (relative) {
dc5f690b 3992 total_size = current_size + n * relative;
ae6b0ed6
SH
3993 } else {
3994 total_size = n;
3995 }
3996 if (total_size <= 0) {
15654a6d 3997 error_report("New image size must be positive");
c2abccec
MK
3998 ret = -1;
3999 goto out;
ae6b0ed6
SH
4000 }
4001
dc5f690b
HR
4002 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
4003 error_report("Preallocation can only be used for growing images");
4004 ret = -1;
4005 goto out;
4006 }
4007
4ffca890 4008 if (total_size < current_size && !shrink) {
1c404d75 4009 error_report("Use the --shrink option to perform a shrink operation.");
4ffca890
PB
4010 warn_report("Shrinking an image will delete all data beyond the "
4011 "shrunken image's end. Before performing such an "
4012 "operation, make sure there is no important data there.");
1c404d75
KW
4013 ret = -1;
4014 goto out;
4ffca890
PB
4015 }
4016
e8d04f92
HR
4017 /*
4018 * The user expects the image to have the desired size after
4019 * resizing, so pass @exact=true. It is of no use to report
4020 * success when the image has not actually been resized.
4021 */
8c6242b6 4022 ret = blk_truncate(blk, total_size, true, prealloc, 0, &err);
09c5c6de
HR
4023 if (!ret) {
4024 qprintf(quiet, "Image resized.\n");
4025 } else {
ed3d2ec9 4026 error_report_err(err);
ae6b0ed6 4027 }
c2abccec 4028out:
26f54e9a 4029 blk_unref(blk);
c2abccec
MK
4030 if (ret) {
4031 return 1;
4032 }
ae6b0ed6
SH
4033 return 0;
4034}
4035
76a3a34d 4036static void amend_status_cb(BlockDriverState *bs,
8b13976d
HR
4037 int64_t offset, int64_t total_work_size,
4038 void *opaque)
76a3a34d
HR
4039{
4040 qemu_progress_print(100.f * offset / total_work_size, 0);
4041}
4042
51641351
HR
4043static int print_amend_option_help(const char *format)
4044{
4045 BlockDriver *drv;
4046
4047 /* Find driver and parse its options */
4048 drv = bdrv_find_format(format);
4049 if (!drv) {
4050 error_report("Unknown file format '%s'", format);
4051 return 1;
4052 }
4053
4054 if (!drv->bdrv_amend_options) {
4055 error_report("Format driver '%s' does not support option amendment",
4056 format);
4057 return 1;
4058 }
4059
df373fb0
ML
4060 /* Every driver supporting amendment must have amend_opts */
4061 assert(drv->amend_opts);
51641351 4062
0b6786a9 4063 printf("Amend options for '%s':\n", format);
df373fb0 4064 qemu_opts_print_help(drv->amend_opts, false);
51641351
HR
4065 return 0;
4066}
4067
6f176b48
HR
4068static int img_amend(int argc, char **argv)
4069{
dc523cd3 4070 Error *err = NULL;
6f176b48
HR
4071 int c, ret = 0;
4072 char *options = NULL;
df373fb0 4073 QemuOptsList *amend_opts = NULL;
83d0521a 4074 QemuOpts *opts = NULL;
bd39e6ed
HR
4075 const char *fmt = NULL, *filename, *cache;
4076 int flags;
ce099547 4077 bool writethrough;
76a3a34d 4078 bool quiet = false, progress = false;
26f54e9a 4079 BlockBackend *blk = NULL;
6f176b48 4080 BlockDriverState *bs = NULL;
eb769f74 4081 bool image_opts = false;
a3579bfa 4082 bool force = false;
6f176b48 4083
bd39e6ed 4084 cache = BDRV_DEFAULT_CACHE;
6f176b48 4085 for (;;) {
3babeb15
DB
4086 static const struct option long_options[] = {
4087 {"help", no_argument, 0, 'h'},
4088 {"object", required_argument, 0, OPTION_OBJECT},
eb769f74 4089 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
a3579bfa 4090 {"force", no_argument, 0, OPTION_FORCE},
3babeb15
DB
4091 {0, 0, 0, 0}
4092 };
c9192973 4093 c = getopt_long(argc, argv, ":ho:f:t:pq",
3babeb15 4094 long_options, NULL);
6f176b48
HR
4095 if (c == -1) {
4096 break;
4097 }
4098
4099 switch (c) {
c9192973
SH
4100 case ':':
4101 missing_argument(argv[optind - 1]);
4102 break;
f7077624 4103 case '?':
c9192973
SH
4104 unrecognized_option(argv[optind - 1]);
4105 break;
4106 case 'h':
f7077624
SH
4107 help();
4108 break;
4109 case 'o':
6d2b5cba 4110 if (accumulate_options(&options, optarg) < 0) {
f7077624
SH
4111 ret = -1;
4112 goto out_no_progress;
4113 }
f7077624
SH
4114 break;
4115 case 'f':
4116 fmt = optarg;
4117 break;
4118 case 't':
4119 cache = optarg;
4120 break;
4121 case 'p':
4122 progress = true;
4123 break;
4124 case 'q':
4125 quiet = true;
4126 break;
4127 case OPTION_OBJECT:
99b1e646 4128 user_creatable_process_cmdline(optarg);
f7077624
SH
4129 break;
4130 case OPTION_IMAGE_OPTS:
4131 image_opts = true;
4132 break;
a3579bfa
ML
4133 case OPTION_FORCE:
4134 force = true;
4135 break;
6f176b48
HR
4136 }
4137 }
4138
a283cb6e 4139 if (!options) {
ac1307ab 4140 error_exit("Must specify options (-o)");
6f176b48
HR
4141 }
4142
76a3a34d
HR
4143 if (quiet) {
4144 progress = false;
4145 }
4146 qemu_progress_init(progress, 1.0);
4147
a283cb6e
KW
4148 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
4149 if (fmt && has_help_option(options)) {
4150 /* If a format is explicitly specified (and possibly no filename is
4151 * given), print option help here */
51641351 4152 ret = print_amend_option_help(fmt);
a283cb6e 4153 goto out;
6f176b48
HR
4154 }
4155
a283cb6e 4156 if (optind != argc - 1) {
b2f27e44
HR
4157 error_report("Expecting one image file name");
4158 ret = -1;
4159 goto out;
a283cb6e 4160 }
6f176b48 4161
ce099547
KW
4162 flags = BDRV_O_RDWR;
4163 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
bd39e6ed
HR
4164 if (ret < 0) {
4165 error_report("Invalid cache option: %s", cache);
4166 goto out;
4167 }
4168
335e9937
FZ
4169 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4170 false);
7e7d56d9 4171 if (!blk) {
6f176b48
HR
4172 ret = -1;
4173 goto out;
4174 }
7e7d56d9 4175 bs = blk_bs(blk);
6f176b48
HR
4176
4177 fmt = bs->drv->format_name;
4178
626f84f3 4179 if (has_help_option(options)) {
a283cb6e 4180 /* If the format was auto-detected, print option help here */
51641351 4181 ret = print_amend_option_help(fmt);
6f176b48
HR
4182 goto out;
4183 }
4184
1f996683
HR
4185 if (!bs->drv->bdrv_amend_options) {
4186 error_report("Format driver '%s' does not support option amendment",
b2439d26
HR
4187 fmt);
4188 ret = -1;
4189 goto out;
4190 }
4191
df373fb0
ML
4192 /* Every driver supporting amendment must have amend_opts */
4193 assert(bs->drv->amend_opts);
1f996683 4194
df373fb0
ML
4195 amend_opts = qemu_opts_append(amend_opts, bs->drv->amend_opts);
4196 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
235e59cf 4197 if (!qemu_opts_do_parse(opts, options, NULL, &err)) {
0b6786a9 4198 /* Try to parse options using the create options */
0b6786a9
ML
4199 amend_opts = qemu_opts_append(amend_opts, bs->drv->create_opts);
4200 qemu_opts_del(opts);
4201 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
9e194e06 4202 if (qemu_opts_do_parse(opts, options, NULL, NULL)) {
0b6786a9
ML
4203 error_append_hint(&err,
4204 "This option is only supported for image creation\n");
0b6786a9
ML
4205 }
4206
ece9086e
PB
4207 error_report_err(err);
4208 ret = -1;
4209 goto out;
6f176b48
HR
4210 }
4211
76a3a34d
HR
4212 /* In case the driver does not call amend_status_cb() */
4213 qemu_progress_print(0.f, 0);
a3579bfa 4214 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, force, &err);
76a3a34d 4215 qemu_progress_print(100.f, 0);
6f176b48 4216 if (ret < 0) {
d1402b50 4217 error_report_err(err);
6f176b48
HR
4218 goto out;
4219 }
4220
4221out:
76a3a34d
HR
4222 qemu_progress_end();
4223
e814dffc 4224out_no_progress:
26f54e9a 4225 blk_unref(blk);
83d0521a 4226 qemu_opts_del(opts);
df373fb0 4227 qemu_opts_free(amend_opts);
626f84f3
KW
4228 g_free(options);
4229
6f176b48
HR
4230 if (ret) {
4231 return 1;
4232 }
4233 return 0;
4234}
4235
b6133b8c
KW
4236typedef struct BenchData {
4237 BlockBackend *blk;
4238 uint64_t image_size;
b6495fa8 4239 bool write;
b6133b8c 4240 int bufsize;
83de9be0 4241 int step;
b6133b8c
KW
4242 int nrreq;
4243 int n;
55d539c8
KW
4244 int flush_interval;
4245 bool drain_on_flush;
b6133b8c
KW
4246 uint8_t *buf;
4247 QEMUIOVector *qiov;
4248
4249 int in_flight;
55d539c8 4250 bool in_flush;
b6133b8c
KW
4251 uint64_t offset;
4252} BenchData;
4253
55d539c8
KW
4254static void bench_undrained_flush_cb(void *opaque, int ret)
4255{
4256 if (ret < 0) {
df3c286c 4257 error_report("Failed flush request: %s", strerror(-ret));
55d539c8
KW
4258 exit(EXIT_FAILURE);
4259 }
4260}
4261
b6133b8c
KW
4262static void bench_cb(void *opaque, int ret)
4263{
4264 BenchData *b = opaque;
4265 BlockAIOCB *acb;
4266
4267 if (ret < 0) {
df3c286c 4268 error_report("Failed request: %s", strerror(-ret));
b6133b8c
KW
4269 exit(EXIT_FAILURE);
4270 }
55d539c8
KW
4271
4272 if (b->in_flush) {
4273 /* Just finished a flush with drained queue: Start next requests */
4274 assert(b->in_flight == 0);
4275 b->in_flush = false;
4276 } else if (b->in_flight > 0) {
4277 int remaining = b->n - b->in_flight;
4278
b6133b8c
KW
4279 b->n--;
4280 b->in_flight--;
55d539c8
KW
4281
4282 /* Time for flush? Drain queue if requested, then flush */
4283 if (b->flush_interval && remaining % b->flush_interval == 0) {
4284 if (!b->in_flight || !b->drain_on_flush) {
4285 BlockCompletionFunc *cb;
4286
4287 if (b->drain_on_flush) {
4288 b->in_flush = true;
4289 cb = bench_cb;
4290 } else {
4291 cb = bench_undrained_flush_cb;
4292 }
4293
4294 acb = blk_aio_flush(b->blk, cb, b);
4295 if (!acb) {
4296 error_report("Failed to issue flush request");
4297 exit(EXIT_FAILURE);
4298 }
4299 }
4300 if (b->drain_on_flush) {
4301 return;
4302 }
4303 }
b6133b8c
KW
4304 }
4305
4306 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
4baaa8c3
PB
4307 int64_t offset = b->offset;
4308 /* blk_aio_* might look for completed I/Os and kick bench_cb
4309 * again, so make sure this operation is counted by in_flight
4310 * and b->offset is ready for the next submission.
4311 */
4312 b->in_flight++;
4313 b->offset += b->step;
4314 b->offset %= b->image_size;
b6495fa8 4315 if (b->write) {
4baaa8c3 4316 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
b6495fa8 4317 } else {
4baaa8c3 4318 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
b6495fa8 4319 }
b6133b8c
KW
4320 if (!acb) {
4321 error_report("Failed to issue request");
4322 exit(EXIT_FAILURE);
4323 }
b6133b8c
KW
4324 }
4325}
4326
4327static int img_bench(int argc, char **argv)
4328{
4329 int c, ret = 0;
4330 const char *fmt = NULL, *filename;
4331 bool quiet = false;
4332 bool image_opts = false;
b6495fa8 4333 bool is_write = false;
b6133b8c
KW
4334 int count = 75000;
4335 int depth = 64;
d3199a31 4336 int64_t offset = 0;
b6133b8c 4337 size_t bufsize = 4096;
b6495fa8 4338 int pattern = 0;
83de9be0 4339 size_t step = 0;
55d539c8
KW
4340 int flush_interval = 0;
4341 bool drain_on_flush = true;
b6133b8c
KW
4342 int64_t image_size;
4343 BlockBackend *blk = NULL;
4344 BenchData data = {};
4345 int flags = 0;
604e8613 4346 bool writethrough = false;
b6133b8c
KW
4347 struct timeval t1, t2;
4348 int i;
335e9937 4349 bool force_share = false;
79d46583 4350 size_t buf_size;
b6133b8c
KW
4351
4352 for (;;) {
4353 static const struct option long_options[] = {
4354 {"help", no_argument, 0, 'h'},
55d539c8 4355 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
b6133b8c 4356 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
b6495fa8 4357 {"pattern", required_argument, 0, OPTION_PATTERN},
55d539c8 4358 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
335e9937 4359 {"force-share", no_argument, 0, 'U'},
b6133b8c
KW
4360 {0, 0, 0, 0}
4361 };
cdd26774
AM
4362 c = getopt_long(argc, argv, ":hc:d:f:ni:o:qs:S:t:wU", long_options,
4363 NULL);
b6133b8c
KW
4364 if (c == -1) {
4365 break;
4366 }
4367
4368 switch (c) {
c9192973
SH
4369 case ':':
4370 missing_argument(argv[optind - 1]);
4371 break;
b6133b8c 4372 case '?':
c9192973
SH
4373 unrecognized_option(argv[optind - 1]);
4374 break;
4375 case 'h':
b6133b8c
KW
4376 help();
4377 break;
4378 case 'c':
4379 {
8b3c6792
PM
4380 unsigned long res;
4381
4382 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
b6133b8c
KW
4383 error_report("Invalid request count specified");
4384 return 1;
4385 }
8b3c6792 4386 count = res;
b6133b8c
KW
4387 break;
4388 }
4389 case 'd':
4390 {
8b3c6792
PM
4391 unsigned long res;
4392
4393 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
b6133b8c
KW
4394 error_report("Invalid queue depth specified");
4395 return 1;
4396 }
8b3c6792 4397 depth = res;
b6133b8c
KW
4398 break;
4399 }
4400 case 'f':
4401 fmt = optarg;
4402 break;
4403 case 'n':
4404 flags |= BDRV_O_NATIVE_AIO;
4405 break;
cdd26774
AM
4406 case 'i':
4407 ret = bdrv_parse_aio(optarg, &flags);
4408 if (ret < 0) {
4409 error_report("Invalid aio option: %s", optarg);
4410 ret = -1;
4411 goto out;
4412 }
4413 break;
d3199a31
KW
4414 case 'o':
4415 {
43d589b0 4416 offset = cvtnum("offset", optarg);
606caa0a 4417 if (offset < 0) {
d3199a31
KW
4418 return 1;
4419 }
4420 break;
4421 }
4422 break;
b6133b8c
KW
4423 case 'q':
4424 quiet = true;
4425 break;
4426 case 's':
4427 {
4428 int64_t sval;
b6133b8c 4429
43d589b0
EM
4430 sval = cvtnum_full("buffer size", optarg, 0, INT_MAX);
4431 if (sval < 0) {
b6133b8c
KW
4432 return 1;
4433 }
4434
4435 bufsize = sval;
4436 break;
4437 }
83de9be0
KW
4438 case 'S':
4439 {
4440 int64_t sval;
83de9be0 4441
43d589b0
EM
4442 sval = cvtnum_full("step_size", optarg, 0, INT_MAX);
4443 if (sval < 0) {
83de9be0
KW
4444 return 1;
4445 }
4446
4447 step = sval;
4448 break;
4449 }
b6133b8c
KW
4450 case 't':
4451 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4452 if (ret < 0) {
4453 error_report("Invalid cache mode");
4454 ret = -1;
4455 goto out;
4456 }
4457 break;
b6495fa8
KW
4458 case 'w':
4459 flags |= BDRV_O_RDWR;
4460 is_write = true;
4461 break;
335e9937
FZ
4462 case 'U':
4463 force_share = true;
4464 break;
b6495fa8
KW
4465 case OPTION_PATTERN:
4466 {
8b3c6792
PM
4467 unsigned long res;
4468
4469 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
b6495fa8
KW
4470 error_report("Invalid pattern byte specified");
4471 return 1;
4472 }
8b3c6792 4473 pattern = res;
b6495fa8
KW
4474 break;
4475 }
55d539c8
KW
4476 case OPTION_FLUSH_INTERVAL:
4477 {
8b3c6792
PM
4478 unsigned long res;
4479
4480 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
55d539c8
KW
4481 error_report("Invalid flush interval specified");
4482 return 1;
4483 }
8b3c6792 4484 flush_interval = res;
55d539c8
KW
4485 break;
4486 }
4487 case OPTION_NO_DRAIN:
4488 drain_on_flush = false;
4489 break;
b6133b8c
KW
4490 case OPTION_IMAGE_OPTS:
4491 image_opts = true;
4492 break;
4493 }
4494 }
4495
4496 if (optind != argc - 1) {
4497 error_exit("Expecting one image file name");
4498 }
4499 filename = argv[argc - 1];
4500
55d539c8
KW
4501 if (!is_write && flush_interval) {
4502 error_report("--flush-interval is only available in write tests");
4503 ret = -1;
4504 goto out;
4505 }
4506 if (flush_interval && flush_interval < depth) {
4507 error_report("Flush interval can't be smaller than depth");
4508 ret = -1;
4509 goto out;
4510 }
4511
335e9937
FZ
4512 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4513 force_share);
b6133b8c
KW
4514 if (!blk) {
4515 ret = -1;
4516 goto out;
4517 }
4518
4519 image_size = blk_getlength(blk);
4520 if (image_size < 0) {
4521 ret = image_size;
4522 goto out;
4523 }
4524
4525 data = (BenchData) {
55d539c8
KW
4526 .blk = blk,
4527 .image_size = image_size,
4528 .bufsize = bufsize,
4529 .step = step ?: bufsize,
4530 .nrreq = depth,
4531 .n = count,
4532 .offset = offset,
4533 .write = is_write,
4534 .flush_interval = flush_interval,
4535 .drain_on_flush = drain_on_flush,
b6133b8c 4536 };
d3199a31 4537 printf("Sending %d %s requests, %d bytes each, %d in parallel "
83de9be0 4538 "(starting at offset %" PRId64 ", step size %d)\n",
d3199a31 4539 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
83de9be0 4540 data.offset, data.step);
55d539c8
KW
4541 if (flush_interval) {
4542 printf("Sending flush every %d requests\n", flush_interval);
4543 }
b6133b8c 4544
79d46583
FZ
4545 buf_size = data.nrreq * data.bufsize;
4546 data.buf = blk_blockalign(blk, buf_size);
b6495fa8
KW
4547 memset(data.buf, pattern, data.nrreq * data.bufsize);
4548
79d46583
FZ
4549 blk_register_buf(blk, data.buf, buf_size);
4550
b6133b8c
KW
4551 data.qiov = g_new(QEMUIOVector, data.nrreq);
4552 for (i = 0; i < data.nrreq; i++) {
4553 qemu_iovec_init(&data.qiov[i], 1);
4554 qemu_iovec_add(&data.qiov[i],
4555 data.buf + i * data.bufsize, data.bufsize);
4556 }
4557
4558 gettimeofday(&t1, NULL);
4559 bench_cb(&data, 0);
4560
4561 while (data.n > 0) {
4562 main_loop_wait(false);
4563 }
4564 gettimeofday(&t2, NULL);
4565
4566 printf("Run completed in %3.3f seconds.\n",
4567 (t2.tv_sec - t1.tv_sec)
4568 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4569
4570out:
79d46583
FZ
4571 if (data.buf) {
4572 blk_unregister_buf(blk, data.buf);
4573 }
b6133b8c
KW
4574 qemu_vfree(data.buf);
4575 blk_unref(blk);
4576
4577 if (ret) {
86ce1f6e
RS
4578 return 1;
4579 }
4580 return 0;
4581}
4582
3b51ab4b
EB
4583enum ImgBitmapAct {
4584 BITMAP_ADD,
4585 BITMAP_REMOVE,
4586 BITMAP_CLEAR,
4587 BITMAP_ENABLE,
4588 BITMAP_DISABLE,
4589 BITMAP_MERGE,
4590};
4591typedef struct ImgBitmapAction {
4592 enum ImgBitmapAct act;
4593 const char *src; /* only used for merge */
4594 QSIMPLEQ_ENTRY(ImgBitmapAction) next;
4595} ImgBitmapAction;
4596
4597static int img_bitmap(int argc, char **argv)
4598{
4599 Error *err = NULL;
4600 int c, ret = 1;
4601 QemuOpts *opts = NULL;
4602 const char *fmt = NULL, *src_fmt = NULL, *src_filename = NULL;
4603 const char *filename, *bitmap;
4604 BlockBackend *blk = NULL, *src = NULL;
4605 BlockDriverState *bs = NULL, *src_bs = NULL;
4606 bool image_opts = false;
4607 int64_t granularity = 0;
4608 bool add = false, merge = false;
4609 QSIMPLEQ_HEAD(, ImgBitmapAction) actions;
4610 ImgBitmapAction *act, *act_next;
4611 const char *op;
4612
4613 QSIMPLEQ_INIT(&actions);
4614
4615 for (;;) {
4616 static const struct option long_options[] = {
4617 {"help", no_argument, 0, 'h'},
4618 {"object", required_argument, 0, OPTION_OBJECT},
4619 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4620 {"add", no_argument, 0, OPTION_ADD},
4621 {"remove", no_argument, 0, OPTION_REMOVE},
4622 {"clear", no_argument, 0, OPTION_CLEAR},
4623 {"enable", no_argument, 0, OPTION_ENABLE},
4624 {"disable", no_argument, 0, OPTION_DISABLE},
4625 {"merge", required_argument, 0, OPTION_MERGE},
4626 {"granularity", required_argument, 0, 'g'},
4627 {"source-file", required_argument, 0, 'b'},
4628 {"source-format", required_argument, 0, 'F'},
4629 {0, 0, 0, 0}
4630 };
4631 c = getopt_long(argc, argv, ":b:f:F:g:h", long_options, NULL);
4632 if (c == -1) {
4633 break;
4634 }
4635
4636 switch (c) {
4637 case ':':
4638 missing_argument(argv[optind - 1]);
4639 break;
4640 case '?':
4641 unrecognized_option(argv[optind - 1]);
4642 break;
4643 case 'h':
4644 help();
4645 break;
4646 case 'b':
4647 src_filename = optarg;
4648 break;
4649 case 'f':
4650 fmt = optarg;
4651 break;
4652 case 'F':
4653 src_fmt = optarg;
4654 break;
4655 case 'g':
4656 granularity = cvtnum("granularity", optarg);
4657 if (granularity < 0) {
4658 return 1;
4659 }
4660 break;
4661 case OPTION_ADD:
4662 act = g_new0(ImgBitmapAction, 1);
4663 act->act = BITMAP_ADD;
4664 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4665 add = true;
4666 break;
4667 case OPTION_REMOVE:
4668 act = g_new0(ImgBitmapAction, 1);
4669 act->act = BITMAP_REMOVE;
4670 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4671 break;
4672 case OPTION_CLEAR:
4673 act = g_new0(ImgBitmapAction, 1);
4674 act->act = BITMAP_CLEAR;
4675 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4676 break;
4677 case OPTION_ENABLE:
4678 act = g_new0(ImgBitmapAction, 1);
4679 act->act = BITMAP_ENABLE;
4680 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4681 break;
4682 case OPTION_DISABLE:
4683 act = g_new0(ImgBitmapAction, 1);
4684 act->act = BITMAP_DISABLE;
4685 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4686 break;
4687 case OPTION_MERGE:
4688 act = g_new0(ImgBitmapAction, 1);
4689 act->act = BITMAP_MERGE;
4690 act->src = optarg;
4691 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4692 merge = true;
4693 break;
4694 case OPTION_OBJECT:
99b1e646 4695 user_creatable_process_cmdline(optarg);
3b51ab4b
EB
4696 break;
4697 case OPTION_IMAGE_OPTS:
4698 image_opts = true;
4699 break;
4700 }
4701 }
4702
3b51ab4b
EB
4703 if (QSIMPLEQ_EMPTY(&actions)) {
4704 error_report("Need at least one of --add, --remove, --clear, "
4705 "--enable, --disable, or --merge");
4706 goto out;
4707 }
4708
4709 if (granularity && !add) {
4710 error_report("granularity only supported with --add");
4711 goto out;
4712 }
4713 if (src_fmt && !src_filename) {
4714 error_report("-F only supported with -b");
4715 goto out;
4716 }
4717 if (src_filename && !merge) {
4718 error_report("Merge bitmap source file only supported with "
4719 "--merge");
4720 goto out;
4721 }
4722
4723 if (optind != argc - 2) {
4724 error_report("Expecting filename and bitmap name");
4725 goto out;
4726 }
4727
4728 filename = argv[optind];
4729 bitmap = argv[optind + 1];
4730
14f16bf9
EB
4731 /*
4732 * No need to open backing chains; we will be manipulating bitmaps
4733 * directly in this image without reference to image contents.
4734 */
4735 blk = img_open(image_opts, filename, fmt, BDRV_O_RDWR | BDRV_O_NO_BACKING,
4736 false, false, false);
3b51ab4b
EB
4737 if (!blk) {
4738 goto out;
4739 }
4740 bs = blk_bs(blk);
4741 if (src_filename) {
14f16bf9
EB
4742 src = img_open(false, src_filename, src_fmt, BDRV_O_NO_BACKING,
4743 false, false, false);
3b51ab4b
EB
4744 if (!src) {
4745 goto out;
4746 }
4747 src_bs = blk_bs(src);
4748 } else {
4749 src_bs = bs;
4750 }
4751
4752 QSIMPLEQ_FOREACH_SAFE(act, &actions, next, act_next) {
4753 switch (act->act) {
4754 case BITMAP_ADD:
4755 qmp_block_dirty_bitmap_add(bs->node_name, bitmap,
4756 !!granularity, granularity, true, true,
4757 false, false, &err);
4758 op = "add";
4759 break;
4760 case BITMAP_REMOVE:
4761 qmp_block_dirty_bitmap_remove(bs->node_name, bitmap, &err);
4762 op = "remove";
4763 break;
4764 case BITMAP_CLEAR:
4765 qmp_block_dirty_bitmap_clear(bs->node_name, bitmap, &err);
4766 op = "clear";
4767 break;
4768 case BITMAP_ENABLE:
4769 qmp_block_dirty_bitmap_enable(bs->node_name, bitmap, &err);
4770 op = "enable";
4771 break;
4772 case BITMAP_DISABLE:
4773 qmp_block_dirty_bitmap_disable(bs->node_name, bitmap, &err);
4774 op = "disable";
4775 break;
6c729dd8
EB
4776 case BITMAP_MERGE:
4777 do_dirty_bitmap_merge(bs->node_name, bitmap, src_bs->node_name,
4778 act->src, &err);
3b51ab4b
EB
4779 op = "merge";
4780 break;
3b51ab4b
EB
4781 default:
4782 g_assert_not_reached();
4783 }
4784
4785 if (err) {
4786 error_reportf_err(err, "Operation %s on bitmap %s failed: ",
4787 op, bitmap);
4788 goto out;
4789 }
4790 g_free(act);
4791 }
4792
4793 ret = 0;
4794
4795 out:
4796 blk_unref(src);
4797 blk_unref(blk);
4798 qemu_opts_del(opts);
4799 return ret;
4800}
4801
86ce1f6e
RS
4802#define C_BS 01
4803#define C_COUNT 02
4804#define C_IF 04
4805#define C_OF 010
f7c15533 4806#define C_SKIP 020
86ce1f6e
RS
4807
4808struct DdInfo {
4809 unsigned int flags;
4810 int64_t count;
4811};
4812
4813struct DdIo {
4814 int bsz; /* Block size */
4815 char *filename;
4816 uint8_t *buf;
f7c15533 4817 int64_t offset;
86ce1f6e
RS
4818};
4819
4820struct DdOpts {
4821 const char *name;
4822 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
4823 unsigned int flag;
4824};
4825
4826static int img_dd_bs(const char *arg,
4827 struct DdIo *in, struct DdIo *out,
4828 struct DdInfo *dd)
4829{
86ce1f6e
RS
4830 int64_t res;
4831
43d589b0 4832 res = cvtnum_full("bs", arg, 1, INT_MAX);
86ce1f6e 4833
43d589b0 4834 if (res < 0) {
86ce1f6e
RS
4835 return 1;
4836 }
4837 in->bsz = out->bsz = res;
4838
4839 return 0;
4840}
4841
4842static int img_dd_count(const char *arg,
4843 struct DdIo *in, struct DdIo *out,
4844 struct DdInfo *dd)
4845{
43d589b0 4846 dd->count = cvtnum("count", arg);
86ce1f6e 4847
606caa0a 4848 if (dd->count < 0) {
86ce1f6e
RS
4849 return 1;
4850 }
4851
4852 return 0;
4853}
4854
4855static int img_dd_if(const char *arg,
4856 struct DdIo *in, struct DdIo *out,
4857 struct DdInfo *dd)
4858{
4859 in->filename = g_strdup(arg);
4860
4861 return 0;
4862}
4863
4864static int img_dd_of(const char *arg,
4865 struct DdIo *in, struct DdIo *out,
4866 struct DdInfo *dd)
4867{
4868 out->filename = g_strdup(arg);
4869
4870 return 0;
4871}
4872
f7c15533
RS
4873static int img_dd_skip(const char *arg,
4874 struct DdIo *in, struct DdIo *out,
4875 struct DdInfo *dd)
4876{
43d589b0 4877 in->offset = cvtnum("skip", arg);
f7c15533 4878
606caa0a 4879 if (in->offset < 0) {
f7c15533
RS
4880 return 1;
4881 }
4882
4883 return 0;
4884}
4885
86ce1f6e
RS
4886static int img_dd(int argc, char **argv)
4887{
4888 int ret = 0;
4889 char *arg = NULL;
4890 char *tmp;
4891 BlockDriver *drv = NULL, *proto_drv = NULL;
4892 BlockBackend *blk1 = NULL, *blk2 = NULL;
4893 QemuOpts *opts = NULL;
4894 QemuOptsList *create_opts = NULL;
4895 Error *local_err = NULL;
4896 bool image_opts = false;
4897 int c, i;
4898 const char *out_fmt = "raw";
4899 const char *fmt = NULL;
4900 int64_t size = 0;
4901 int64_t block_count = 0, out_pos, in_pos;
335e9937 4902 bool force_share = false;
86ce1f6e
RS
4903 struct DdInfo dd = {
4904 .flags = 0,
4905 .count = 0,
4906 };
4907 struct DdIo in = {
4908 .bsz = 512, /* Block size is by default 512 bytes */
4909 .filename = NULL,
f7c15533
RS
4910 .buf = NULL,
4911 .offset = 0
86ce1f6e
RS
4912 };
4913 struct DdIo out = {
4914 .bsz = 512,
4915 .filename = NULL,
f7c15533
RS
4916 .buf = NULL,
4917 .offset = 0
86ce1f6e
RS
4918 };
4919
4920 const struct DdOpts options[] = {
4921 { "bs", img_dd_bs, C_BS },
4922 { "count", img_dd_count, C_COUNT },
4923 { "if", img_dd_if, C_IF },
4924 { "of", img_dd_of, C_OF },
f7c15533 4925 { "skip", img_dd_skip, C_SKIP },
86ce1f6e
RS
4926 { NULL, NULL, 0 }
4927 };
4928 const struct option long_options[] = {
4929 { "help", no_argument, 0, 'h'},
83d4bf94 4930 { "object", required_argument, 0, OPTION_OBJECT},
86ce1f6e 4931 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
335e9937 4932 { "force-share", no_argument, 0, 'U'},
86ce1f6e
RS
4933 { 0, 0, 0, 0 }
4934 };
4935
335e9937 4936 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
86ce1f6e
RS
4937 if (c == EOF) {
4938 break;
4939 }
4940 switch (c) {
4941 case 'O':
4942 out_fmt = optarg;
4943 break;
4944 case 'f':
4945 fmt = optarg;
4946 break;
c9192973
SH
4947 case ':':
4948 missing_argument(argv[optind - 1]);
4949 break;
86ce1f6e 4950 case '?':
c9192973
SH
4951 unrecognized_option(argv[optind - 1]);
4952 break;
86ce1f6e
RS
4953 case 'h':
4954 help();
4955 break;
335e9937
FZ
4956 case 'U':
4957 force_share = true;
4958 break;
2a245709 4959 case OPTION_OBJECT:
99b1e646 4960 user_creatable_process_cmdline(optarg);
2a245709 4961 break;
86ce1f6e
RS
4962 case OPTION_IMAGE_OPTS:
4963 image_opts = true;
4964 break;
4965 }
4966 }
4967
4968 for (i = optind; i < argc; i++) {
4969 int j;
4970 arg = g_strdup(argv[i]);
4971
4972 tmp = strchr(arg, '=');
4973 if (tmp == NULL) {
4974 error_report("unrecognized operand %s", arg);
4975 ret = -1;
4976 goto out;
4977 }
4978
4979 *tmp++ = '\0';
4980
4981 for (j = 0; options[j].name != NULL; j++) {
4982 if (!strcmp(arg, options[j].name)) {
4983 break;
4984 }
4985 }
4986 if (options[j].name == NULL) {
4987 error_report("unrecognized operand %s", arg);
4988 ret = -1;
4989 goto out;
4990 }
4991
4992 if (options[j].f(tmp, &in, &out, &dd) != 0) {
4993 ret = -1;
4994 goto out;
4995 }
4996 dd.flags |= options[j].flag;
4997 g_free(arg);
4998 arg = NULL;
4999 }
5000
5001 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
5002 error_report("Must specify both input and output files");
5003 ret = -1;
5004 goto out;
5005 }
83d4bf94 5006
335e9937
FZ
5007 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
5008 force_share);
86ce1f6e
RS
5009
5010 if (!blk1) {
5011 ret = -1;
5012 goto out;
5013 }
5014
5015 drv = bdrv_find_format(out_fmt);
5016 if (!drv) {
5017 error_report("Unknown file format");
5018 ret = -1;
5019 goto out;
5020 }
5021 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
5022
5023 if (!proto_drv) {
5024 error_report_err(local_err);
5025 ret = -1;
5026 goto out;
5027 }
5028 if (!drv->create_opts) {
5029 error_report("Format driver '%s' does not support image creation",
5030 drv->format_name);
5031 ret = -1;
5032 goto out;
5033 }
5034 if (!proto_drv->create_opts) {
5035 error_report("Protocol driver '%s' does not support image creation",
5036 proto_drv->format_name);
5037 ret = -1;
5038 goto out;
5039 }
5040 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5041 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
5042
5043 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5044
5045 size = blk_getlength(blk1);
5046 if (size < 0) {
5047 error_report("Failed to get size for '%s'", in.filename);
5048 ret = -1;
5049 goto out;
5050 }
5051
5052 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
5053 dd.count * in.bsz < size) {
5054 size = dd.count * in.bsz;
5055 }
5056
f7c15533
RS
5057 /* Overflow means the specified offset is beyond input image's size */
5058 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5059 size < in.bsz * in.offset)) {
5060 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
5061 } else {
5062 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
5063 size - in.bsz * in.offset, &error_abort);
5064 }
86ce1f6e
RS
5065
5066 ret = bdrv_create(drv, out.filename, opts, &local_err);
5067 if (ret < 0) {
5068 error_reportf_err(local_err,
5069 "%s: error while creating output image: ",
5070 out.filename);
5071 ret = -1;
5072 goto out;
5073 }
5074
ea204dda
DB
5075 /* TODO, we can't honour --image-opts for the target,
5076 * since it needs to be given in a format compatible
5077 * with the bdrv_create() call above which does not
5078 * support image-opts style.
5079 */
29cf9336 5080 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
ea204dda 5081 false, false, false);
86ce1f6e
RS
5082
5083 if (!blk2) {
5084 ret = -1;
5085 goto out;
5086 }
5087
f7c15533
RS
5088 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5089 size < in.offset * in.bsz)) {
5090 /* We give a warning if the skip option is bigger than the input
5091 * size and create an empty output disk image (i.e. like dd(1)).
5092 */
5093 error_report("%s: cannot skip to specified offset", in.filename);
5094 in_pos = size;
5095 } else {
5096 in_pos = in.offset * in.bsz;
5097 }
5098
86ce1f6e
RS
5099 in.buf = g_new(uint8_t, in.bsz);
5100
f7c15533 5101 for (out_pos = 0; in_pos < size; block_count++) {
86ce1f6e
RS
5102 int in_ret, out_ret;
5103
5104 if (in_pos + in.bsz > size) {
5105 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
5106 } else {
5107 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
5108 }
5109 if (in_ret < 0) {
5110 error_report("error while reading from input image file: %s",
5111 strerror(-in_ret));
5112 ret = -1;
5113 goto out;
5114 }
5115 in_pos += in_ret;
5116
5117 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
5118
5119 if (out_ret < 0) {
5120 error_report("error while writing to output image file: %s",
5121 strerror(-out_ret));
5122 ret = -1;
5123 goto out;
5124 }
5125 out_pos += out_ret;
5126 }
5127
5128out:
5129 g_free(arg);
5130 qemu_opts_del(opts);
5131 qemu_opts_free(create_opts);
5132 blk_unref(blk1);
5133 blk_unref(blk2);
5134 g_free(in.filename);
5135 g_free(out.filename);
5136 g_free(in.buf);
5137 g_free(out.buf);
5138
5139 if (ret) {
b6133b8c
KW
5140 return 1;
5141 }
5142 return 0;
5143}
5144
fd03c2b8
SH
5145static void dump_json_block_measure_info(BlockMeasureInfo *info)
5146{
eab3a467 5147 GString *str;
fd03c2b8
SH
5148 QObject *obj;
5149 Visitor *v = qobject_output_visitor_new(&obj);
5150
5151 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
5152 visit_complete(v, &obj);
6589f459 5153 str = qobject_to_json_pretty(obj, true);
fd03c2b8 5154 assert(str != NULL);
eab3a467 5155 printf("%s\n", str->str);
cb3e7f08 5156 qobject_unref(obj);
fd03c2b8 5157 visit_free(v);
eab3a467 5158 g_string_free(str, true);
fd03c2b8
SH
5159}
5160
5161static int img_measure(int argc, char **argv)
5162{
5163 static const struct option long_options[] = {
5164 {"help", no_argument, 0, 'h'},
5165 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
5166 {"object", required_argument, 0, OPTION_OBJECT},
5167 {"output", required_argument, 0, OPTION_OUTPUT},
5168 {"size", required_argument, 0, OPTION_SIZE},
5169 {"force-share", no_argument, 0, 'U'},
5170 {0, 0, 0, 0}
5171 };
5172 OutputFormat output_format = OFORMAT_HUMAN;
5173 BlockBackend *in_blk = NULL;
5174 BlockDriver *drv;
5175 const char *filename = NULL;
5176 const char *fmt = NULL;
5177 const char *out_fmt = "raw";
5178 char *options = NULL;
5179 char *snapshot_name = NULL;
5180 bool force_share = false;
5181 QemuOpts *opts = NULL;
5182 QemuOpts *object_opts = NULL;
5183 QemuOpts *sn_opts = NULL;
5184 QemuOptsList *create_opts = NULL;
5185 bool image_opts = false;
5186 uint64_t img_size = UINT64_MAX;
5187 BlockMeasureInfo *info = NULL;
5188 Error *local_err = NULL;
5189 int ret = 1;
5190 int c;
5191
5192 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
5193 long_options, NULL)) != -1) {
5194 switch (c) {
5195 case '?':
5196 case 'h':
5197 help();
5198 break;
5199 case 'f':
5200 fmt = optarg;
5201 break;
5202 case 'O':
5203 out_fmt = optarg;
5204 break;
5205 case 'o':
6d2b5cba 5206 if (accumulate_options(&options, optarg) < 0) {
fd03c2b8
SH
5207 goto out;
5208 }
fd03c2b8
SH
5209 break;
5210 case 'l':
5211 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
5212 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
5213 optarg, false);
5214 if (!sn_opts) {
5215 error_report("Failed in parsing snapshot param '%s'",
5216 optarg);
5217 goto out;
5218 }
5219 } else {
5220 snapshot_name = optarg;
5221 }
5222 break;
5223 case 'U':
5224 force_share = true;
5225 break;
5226 case OPTION_OBJECT:
99b1e646 5227 user_creatable_process_cmdline(optarg);
fd03c2b8
SH
5228 break;
5229 case OPTION_IMAGE_OPTS:
5230 image_opts = true;
5231 break;
5232 case OPTION_OUTPUT:
5233 if (!strcmp(optarg, "json")) {
5234 output_format = OFORMAT_JSON;
5235 } else if (!strcmp(optarg, "human")) {
5236 output_format = OFORMAT_HUMAN;
5237 } else {
5238 error_report("--output must be used with human or json "
5239 "as argument.");
5240 goto out;
5241 }
5242 break;
5243 case OPTION_SIZE:
5244 {
5245 int64_t sval;
5246
43d589b0 5247 sval = cvtnum("image size", optarg);
fd03c2b8 5248 if (sval < 0) {
fd03c2b8
SH
5249 goto out;
5250 }
5251 img_size = (uint64_t)sval;
5252 }
5253 break;
5254 }
5255 }
5256
fd03c2b8
SH
5257 if (argc - optind > 1) {
5258 error_report("At most one filename argument is allowed.");
5259 goto out;
5260 } else if (argc - optind == 1) {
5261 filename = argv[optind];
5262 }
5263
c3673dcf
SH
5264 if (!filename && (image_opts || fmt || snapshot_name || sn_opts)) {
5265 error_report("--image-opts, -f, and -l require a filename argument.");
fd03c2b8
SH
5266 goto out;
5267 }
5268 if (filename && img_size != UINT64_MAX) {
5269 error_report("--size N cannot be used together with a filename.");
5270 goto out;
5271 }
5272 if (!filename && img_size == UINT64_MAX) {
5273 error_report("Either --size N or one filename must be specified.");
5274 goto out;
5275 }
5276
5277 if (filename) {
5278 in_blk = img_open(image_opts, filename, fmt, 0,
5279 false, false, force_share);
5280 if (!in_blk) {
5281 goto out;
5282 }
5283
5284 if (sn_opts) {
5285 bdrv_snapshot_load_tmp(blk_bs(in_blk),
5286 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
5287 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
5288 &local_err);
5289 } else if (snapshot_name != NULL) {
5290 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
5291 snapshot_name, &local_err);
5292 }
5293 if (local_err) {
5294 error_reportf_err(local_err, "Failed to load snapshot: ");
5295 goto out;
5296 }
5297 }
5298
5299 drv = bdrv_find_format(out_fmt);
5300 if (!drv) {
5301 error_report("Unknown file format '%s'", out_fmt);
5302 goto out;
5303 }
5304 if (!drv->create_opts) {
5305 error_report("Format driver '%s' does not support image creation",
5306 drv->format_name);
5307 goto out;
5308 }
5309
5310 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5311 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
5312 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5313 if (options) {
235e59cf 5314 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
fd03c2b8
SH
5315 error_report_err(local_err);
5316 error_report("Invalid options for file format '%s'", out_fmt);
5317 goto out;
5318 }
5319 }
5320 if (img_size != UINT64_MAX) {
5321 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
5322 }
5323
5324 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
5325 if (local_err) {
5326 error_report_err(local_err);
5327 goto out;
5328 }
5329
5330 if (output_format == OFORMAT_HUMAN) {
5331 printf("required size: %" PRIu64 "\n", info->required);
5332 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
5d72c68b
EB
5333 if (info->has_bitmaps) {
5334 printf("bitmaps size: %" PRIu64 "\n", info->bitmaps);
5335 }
fd03c2b8
SH
5336 } else {
5337 dump_json_block_measure_info(info);
5338 }
5339
5340 ret = 0;
5341
5342out:
5343 qapi_free_BlockMeasureInfo(info);
5344 qemu_opts_del(object_opts);
5345 qemu_opts_del(opts);
5346 qemu_opts_del(sn_opts);
5347 qemu_opts_free(create_opts);
5348 g_free(options);
5349 blk_unref(in_blk);
5350 return ret;
5351}
b6133b8c 5352
c227f099 5353static const img_cmd_t img_cmds[] = {
153859be
SB
5354#define DEF(option, callback, arg_string) \
5355 { option, callback },
5356#include "qemu-img-cmds.h"
5357#undef DEF
153859be
SB
5358 { NULL, NULL, },
5359};
5360
ea2384d3
FB
5361int main(int argc, char **argv)
5362{
c227f099 5363 const img_cmd_t *cmd;
153859be 5364 const char *cmdname;
7db1689c 5365 int c;
7db1689c
JC
5366 static const struct option long_options[] = {
5367 {"help", no_argument, 0, 'h'},
10985131 5368 {"version", no_argument, 0, 'V'},
06a1e0c1 5369 {"trace", required_argument, NULL, 'T'},
7db1689c
JC
5370 {0, 0, 0, 0}
5371 };
ea2384d3 5372
526eda14
MK
5373#ifdef CONFIG_POSIX
5374 signal(SIGPIPE, SIG_IGN);
5375#endif
5376
98c5d2e7 5377 socket_init();
f5852efa 5378 error_init(argv[0]);
fe4db84d 5379 module_call_init(MODULE_INIT_TRACE);
10f5bff6 5380 qemu_init_exec_dir(argv[0]);
53f76e58 5381
f9734d5d 5382 qemu_init_main_loop(&error_fatal);
2f78e491 5383
e8f2d272 5384 qcrypto_init(&error_fatal);
c2297088 5385
064097d9 5386 module_call_init(MODULE_INIT_QOM);
ea2384d3 5387 bdrv_init();
ac1307ab
FZ
5388 if (argc < 2) {
5389 error_exit("Not enough arguments");
5390 }
153859be 5391
eb769f74 5392 qemu_add_opts(&qemu_source_opts);
06a1e0c1 5393 qemu_add_opts(&qemu_trace_opts);
3babeb15 5394
c9192973 5395 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
10985131 5396 switch (c) {
c9192973
SH
5397 case ':':
5398 missing_argument(argv[optind - 1]);
5399 return 0;
4581c16f 5400 case '?':
c9192973
SH
5401 unrecognized_option(argv[optind - 1]);
5402 return 0;
5403 case 'h':
10985131
DL
5404 help();
5405 return 0;
5406 case 'V':
5407 printf(QEMU_IMG_VERSION);
5408 return 0;
06a1e0c1 5409 case 'T':
92eecfff 5410 trace_opt_parse(optarg);
06a1e0c1 5411 break;
153859be 5412 }
ea2384d3 5413 }
153859be 5414
10985131 5415 cmdname = argv[optind];
7db1689c 5416
10985131
DL
5417 /* reset getopt_long scanning */
5418 argc -= optind;
5419 if (argc < 1) {
5f6979cb
JC
5420 return 0;
5421 }
10985131 5422 argv += optind;
d339d766 5423 qemu_reset_optind();
10985131 5424
06a1e0c1
DL
5425 if (!trace_init_backends()) {
5426 exit(1);
5427 }
92eecfff 5428 trace_init_file();
06a1e0c1
DL
5429 qemu_set_log(LOG_TRACE);
5430
10985131
DL
5431 /* find the command */
5432 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
5433 if (!strcmp(cmdname, cmd->name)) {
5434 return cmd->handler(argc, argv);
5435 }
5436 }
7db1689c 5437
153859be 5438 /* not found */
ac1307ab 5439 error_exit("Command not found: %s", cmdname);
ea2384d3 5440}