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