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