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