blob: 797742a44331622d5f9b18d0a878ef587ffa26e5 [file] [log] [blame]
bellardea2384d2004-08-01 21:59:26 +00001/*
bellardfb43f4d2006-08-07 21:34:46 +00002 * QEMU disk image utility
ths5fafdf22007-09-16 21:08:06 +00003 *
bellard68d0f702008-01-06 17:21:48 +00004 * Copyright (c) 2003-2008 Fabrice Bellard
ths5fafdf22007-09-16 21:08:06 +00005 *
bellardea2384d2004-08-01 21:59:26 +00006 * 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 */
Markus Armbruster452fcdb2018-02-01 12:18:39 +010024
Peter Maydell80c71a22016-01-18 18:01:42 +000025#include "qemu/osdep.h"
Eric Blakec2a3d7d2017-07-21 08:50:47 -050026#include <getopt.h>
27
Markus Armbrustera8d25322019-05-23 16:35:08 +020028#include "qemu-common.h"
Fam Zheng67a1de02016-06-01 17:44:21 +080029#include "qemu-version.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010030#include "qapi/error.h"
Eric Blake3b51ab42020-05-12 20:16:45 -050031#include "qapi/qapi-commands-block-core.h"
Markus Armbruster9af23982018-02-11 10:36:01 +010032#include "qapi/qapi-visit-block-core.h"
Daniel P. Berrangeb3db2112016-09-30 15:45:27 +010033#include "qapi/qobject-output-visitor.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010034#include "qapi/qmp/qjson.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010035#include "qapi/qmp/qdict.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020036#include "qemu/cutils.h"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000037#include "qemu/config-file.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010038#include "qemu/option.h"
39#include "qemu/error-report.h"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +030040#include "qemu/log.h"
Markus Armbrusterdb725812019-08-12 07:23:50 +020041#include "qemu/main-loop.h"
Markus Armbruster0b8fa322019-05-23 16:35:07 +020042#include "qemu/module.h"
Daniel P. Berrangé98c5d2e2020-08-25 11:38:48 +010043#include "qemu/sockets.h"
Stefano Garzarella97ede572019-05-08 12:43:24 +020044#include "qemu/units.h"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000045#include "qom/object_interfaces.h"
Markus Armbruster26f54e92014-10-07 13:59:04 +020046#include "sysemu/block-backend.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010047#include "block/block_int.h"
Max Reitzd4a32382014-10-24 15:57:37 +020048#include "block/blockjob.h"
Wenchao Xiaf364ec62013-05-25 11:09:44 +080049#include "block/qapi.h"
Daniel P. Berrangec2297082016-04-06 12:12:06 +010050#include "crypto/init.h"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +030051#include "trace/control.h"
Zhengui0c8c4892020-10-20 14:47:44 +000052#include "qemu/throttle.h"
53#include "block/throttle-groups.h"
bellarde8445332006-06-14 15:32:10 +000054
Thomas Huth7e563bf2018-02-15 12:06:47 +010055#define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
Thomas Huth0781dd62016-10-05 11:54:44 +020056 "\n" QEMU_COPYRIGHT "\n"
Jeff Cody5f6979c2014-04-28 14:37:18 -040057
Anthony Liguoric227f092009-10-01 16:12:16 -050058typedef struct img_cmd_t {
Stuart Brady153859b2009-06-07 00:42:17 +010059 const char *name;
60 int (*handler)(int argc, char **argv);
Anthony Liguoric227f092009-10-01 16:12:16 -050061} img_cmd_t;
Stuart Brady153859b2009-06-07 00:42:17 +010062
Federico Simoncelli8599ea42013-01-28 06:59:47 -050063enum {
64 OPTION_OUTPUT = 256,
65 OPTION_BACKING_CHAIN = 257,
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000066 OPTION_OBJECT = 258,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000067 OPTION_IMAGE_OPTS = 259,
Kevin Wolfb6495fa2015-07-10 18:09:18 +020068 OPTION_PATTERN = 260,
Kevin Wolf55d539c2016-06-03 13:59:41 +020069 OPTION_FLUSH_INTERVAL = 261,
70 OPTION_NO_DRAIN = 262,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +010071 OPTION_TARGET_IMAGE_OPTS = 263,
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +010072 OPTION_SIZE = 264,
Max Reitzdc5f6902017-06-13 22:20:55 +020073 OPTION_PREALLOCATION = 265,
Pavel Butsykin4ffca892017-09-18 15:42:27 +030074 OPTION_SHRINK = 266,
Max Reitz8eaac022019-05-07 22:35:03 +020075 OPTION_SALVAGE = 267,
David Edmondson168468f2020-02-05 11:02:48 +000076 OPTION_TARGET_IS_ZERO = 268,
Eric Blake3b51ab42020-05-12 20:16:45 -050077 OPTION_ADD = 269,
78 OPTION_REMOVE = 270,
79 OPTION_CLEAR = 271,
80 OPTION_ENABLE = 272,
81 OPTION_DISABLE = 273,
82 OPTION_MERGE = 274,
Eric Blake15e39ad2020-05-21 14:21:36 -050083 OPTION_BITMAPS = 275,
Maxim Levitskya3579bf2020-06-25 14:55:38 +020084 OPTION_FORCE = 276,
Federico Simoncelli8599ea42013-01-28 06:59:47 -050085};
86
87typedef enum OutputFormat {
88 OFORMAT_JSON,
89 OFORMAT_HUMAN,
90} OutputFormat;
91
Kevin Wolfe6996142016-03-15 13:03:11 +010092/* Default to cache=writeback as data integrity is not important for qemu-img */
Federico Simoncelli661a0f72011-06-20 12:48:19 -040093#define BDRV_DEFAULT_CACHE "writeback"
aurel32137519c2008-11-30 19:12:49 +000094
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +010095static void format_print(void *opaque, const char *name)
bellardea2384d2004-08-01 21:59:26 +000096{
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +010097 printf(" %s", name);
bellardea2384d2004-08-01 21:59:26 +000098}
99
Fam Zhengac1307a2014-04-22 13:36:11 +0800100static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
101{
102 va_list ap;
103
Fam Zhengac1307a2014-04-22 13:36:11 +0800104 va_start(ap, fmt);
Markus Armbrustere9e1d922019-04-17 21:06:27 +0200105 error_vreport(fmt, ap);
Fam Zhengac1307a2014-04-22 13:36:11 +0800106 va_end(ap);
107
Markus Armbrustere9e1d922019-04-17 21:06:27 +0200108 error_printf("Try 'qemu-img --help' for more information\n");
Fam Zhengac1307a2014-04-22 13:36:11 +0800109 exit(EXIT_FAILURE);
110}
111
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800112static void QEMU_NORETURN missing_argument(const char *option)
113{
114 error_exit("missing argument for option '%s'", option);
115}
116
117static void QEMU_NORETURN unrecognized_option(const char *option)
118{
119 error_exit("unrecognized option '%s'", option);
120}
121
Eric Blake0562adf2020-05-12 20:16:41 -0500122/* Please keep in synch with docs/tools/qemu-img.rst */
Fam Zhengac1307a2014-04-22 13:36:11 +0800123static void QEMU_NORETURN help(void)
bellardea2384d2004-08-01 21:59:26 +0000124{
Paolo Bonzinie00291c2010-02-04 16:49:56 +0100125 const char *help_msg =
Jeff Cody5f6979c2014-04-28 14:37:18 -0400126 QEMU_IMG_VERSION
Denis V. Lunev10985132016-06-17 17:44:13 +0300127 "usage: qemu-img [standard options] command [command options]\n"
malc3f020d72010-02-08 12:04:56 +0300128 "QEMU disk image utility\n"
129 "\n"
Denis V. Lunev10985132016-06-17 17:44:13 +0300130 " '-h', '--help' display this help and exit\n"
131 " '-V', '--version' output version information and exit\n"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +0300132 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
133 " specify tracing options\n"
Denis V. Lunev10985132016-06-17 17:44:13 +0300134 "\n"
malc3f020d72010-02-08 12:04:56 +0300135 "Command syntax:\n"
Stuart Brady153859b2009-06-07 00:42:17 +0100136#define DEF(option, callback, arg_string) \
137 " " arg_string "\n"
138#include "qemu-img-cmds.h"
139#undef DEF
malc3f020d72010-02-08 12:04:56 +0300140 "\n"
141 "Command parameters:\n"
142 " 'filename' is a disk image filename\n"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000143 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
144 " manual page for a description of the object properties. The most common\n"
145 " object type is a 'secret', which is used to supply passwords and/or\n"
146 " encryption keys.\n"
malc3f020d72010-02-08 12:04:56 +0300147 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400148 " 'cache' is the cache mode used to write the output disk image, the valid\n"
Liu Yuan80ccf932012-04-20 17:10:56 +0800149 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
150 " 'directsync' and 'unsafe' (default for convert)\n"
Stefan Hajnoczibb87fdf2014-09-02 11:01:02 +0100151 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
152 " options are the same as for the 'cache' option\n"
malc3f020d72010-02-08 12:04:56 +0300153 " 'size' is the disk image size in bytes. Optional suffixes\n"
Kevin Wolf5e009842013-06-05 14:19:27 +0200154 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
155 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
156 " supported. 'b' is ignored.\n"
malc3f020d72010-02-08 12:04:56 +0300157 " 'output_filename' is the destination disk image filename\n"
158 " 'output_fmt' is the destination format\n"
159 " 'options' is a comma separated list of format specific options in a\n"
160 " name=value format. Use -o ? for an overview of the options supported by the\n"
161 " used format\n"
Wenchao Xiaef806542013-12-04 17:10:57 +0800162 " 'snapshot_param' is param used for internal snapshot, format\n"
163 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
164 " '[ID_OR_NAME]'\n"
malc3f020d72010-02-08 12:04:56 +0300165 " '-c' indicates that target image must be compressed (qcow format only)\n"
John Snow6e6e55f2017-07-17 20:34:22 -0400166 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
167 " new backing file match exactly. The image doesn't need a working\n"
168 " backing file before rebasing in this case (useful for renaming the\n"
169 " backing file). For image creation, allow creating without attempting\n"
170 " to open the backing file.\n"
malc3f020d72010-02-08 12:04:56 +0300171 " '-h' with or without a command shows this help and lists the supported formats\n"
Jes Sorensen6b837bc2011-03-30 14:16:25 +0200172 " '-p' show progress of command (only certain commands)\n"
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100173 " '-q' use Quiet mode - do not print any output (except errors)\n"
Peter Lieven11b66992013-10-24 12:07:05 +0200174 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
175 " contain only zeros for qemu-img to create a sparse image during\n"
176 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
177 " unallocated or zero sectors, and the destination image will always be\n"
178 " fully allocated\n"
Benoît Canetc054b3f2012-09-05 13:09:02 +0200179 " '--output' takes the format in which the output must be done (human or json)\n"
Alexandre Derumierb2e10492013-09-02 19:07:24 +0100180 " '-n' skips the target volume creation (useful if the volume is created\n"
181 " prior to running qemu-img)\n"
malc3f020d72010-02-08 12:04:56 +0300182 "\n"
Eric Blake3b51ab42020-05-12 20:16:45 -0500183 "Parameters to bitmap subcommand:\n"
184 " 'bitmap' is the name of the bitmap to manipulate, through one or more\n"
185 " actions from '--add', '--remove', '--clear', '--enable', '--disable',\n"
186 " or '--merge source'\n"
187 " '-g granularity' sets the granularity for '--add' actions\n"
188 " '-b source' and '-F src_fmt' tell '--merge' actions to find the source\n"
189 " bitmaps from an alternative file\n"
190 "\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200191 "Parameters to check subcommand:\n"
192 " '-r' tries to repair any inconsistencies that are found during the check.\n"
193 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
194 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
Stefan Weil0546b8c2012-08-10 22:03:25 +0200195 " hiding corruption that has already occurred.\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200196 "\n"
Peter Lieven2d9187b2017-02-28 13:40:07 +0100197 "Parameters to convert subcommand:\n"
Eric Blake15e39ad2020-05-21 14:21:36 -0500198 " '--bitmaps' copies all top-level persistent bitmaps to destination\n"
Peter Lieven2d9187b2017-02-28 13:40:07 +0100199 " '-m' specifies how many coroutines work in parallel during the convert\n"
200 " process (defaults to 8)\n"
201 " '-W' allow to write to the target out of order rather than sequential\n"
202 "\n"
malc3f020d72010-02-08 12:04:56 +0300203 "Parameters to snapshot subcommand:\n"
204 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
205 " '-a' applies a snapshot (revert disk to saved state)\n"
206 " '-c' creates a snapshot\n"
207 " '-d' deletes a snapshot\n"
Miroslav Rezaninad14ed182013-02-13 09:09:41 +0100208 " '-l' lists all snapshots in the given image\n"
209 "\n"
210 "Parameters to compare subcommand:\n"
211 " '-f' first image format\n"
212 " '-F' second image format\n"
Reda Sallahi86ce1f62016-08-10 04:43:12 +0200213 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
214 "\n"
215 "Parameters to dd subcommand:\n"
216 " 'bs=BYTES' read and write up to BYTES bytes at a time "
217 "(default: 512)\n"
218 " 'count=N' copy only N input blocks\n"
219 " 'if=FILE' read from FILE\n"
Reda Sallahif7c15532016-08-10 16:16:09 +0200220 " 'of=FILE' write to FILE\n"
221 " 'skip=N' skip N bs-sized blocks at the start of input\n";
Paolo Bonzinie00291c2010-02-04 16:49:56 +0100222
223 printf("%s\nSupported formats:", help_msg);
Andrey Shinkevich9ac404c2019-03-07 16:33:58 +0300224 bdrv_iterate_format(format_print, NULL, false);
Eric Blakef5048cb2017-08-03 11:33:53 -0500225 printf("\n\n" QEMU_HELP_BOTTOM "\n");
Fam Zhengac1307a2014-04-22 13:36:11 +0800226 exit(EXIT_SUCCESS);
bellardea2384d2004-08-01 21:59:26 +0000227}
228
Markus Armbruster80c710c2020-04-15 09:49:26 +0200229/*
230 * Is @optarg safe for accumulate_options()?
231 * It is when multiple of them can be joined together separated by ','.
232 * To make that work, @optarg must not start with ',' (or else a
233 * separating ',' preceding it gets escaped), and it must not end with
234 * an odd number of ',' (or else a separating ',' following it gets
Markus Armbrusterf62514b2020-04-15 09:49:27 +0200235 * escaped), or be empty (or else a separating ',' preceding it can
236 * escape a separating ',' following it).
237 *
Markus Armbruster80c710c2020-04-15 09:49:26 +0200238 */
239static bool is_valid_option_list(const char *optarg)
240{
241 size_t len = strlen(optarg);
242 size_t i;
243
Markus Armbrusterf62514b2020-04-15 09:49:27 +0200244 if (!optarg[0] || optarg[0] == ',') {
Markus Armbruster80c710c2020-04-15 09:49:26 +0200245 return false;
246 }
247
248 for (i = len; i > 0 && optarg[i - 1] == ','; i--) {
249 }
250 if ((len - i) % 2) {
251 return false;
252 }
253
254 return true;
255}
256
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +0200257static int accumulate_options(char **options, char *optarg)
258{
259 char *new_options;
260
261 if (!is_valid_option_list(optarg)) {
262 error_report("Invalid option list: %s", optarg);
263 return -1;
264 }
265
266 if (!*options) {
267 *options = g_strdup(optarg);
268 } else {
269 new_options = g_strdup_printf("%s,%s", *options, optarg);
270 g_free(*options);
271 *options = new_options;
272 }
273 return 0;
274}
275
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000276static QemuOptsList qemu_source_opts = {
277 .name = "source",
278 .implied_opt_name = "file",
279 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
280 .desc = {
281 { }
282 },
283};
284
Stefan Weil7c30f652013-06-16 17:01:05 +0200285static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100286{
287 int ret = 0;
288 if (!quiet) {
289 va_list args;
290 va_start(args, fmt);
291 ret = vprintf(fmt, args);
292 va_end(args);
293 }
294 return ret;
295}
296
bellardea2384d2004-08-01 21:59:26 +0000297
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100298static int print_block_option_help(const char *filename, const char *fmt)
299{
300 BlockDriver *drv, *proto_drv;
Chunyan Liu83d05212014-06-05 17:20:51 +0800301 QemuOptsList *create_opts = NULL;
Max Reitzb65a5e12015-02-05 13:58:12 -0500302 Error *local_err = NULL;
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100303
304 /* Find driver and parse its options */
305 drv = bdrv_find_format(fmt);
306 if (!drv) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100307 error_report("Unknown file format '%s'", fmt);
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100308 return 1;
309 }
310
Max Reitzd402b6a2018-05-09 23:00:21 +0200311 if (!drv->create_opts) {
312 error_report("Format driver '%s' does not support image creation", fmt);
313 return 1;
314 }
315
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800316 create_opts = qemu_opts_append(create_opts, drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100317 if (filename) {
Max Reitzb65a5e12015-02-05 13:58:12 -0500318 proto_drv = bdrv_find_protocol(filename, true, &local_err);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100319 if (!proto_drv) {
Markus Armbruster2867ce42015-03-12 16:08:02 +0100320 error_report_err(local_err);
Chunyan Liu83d05212014-06-05 17:20:51 +0800321 qemu_opts_free(create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100322 return 1;
323 }
Max Reitzd402b6a2018-05-09 23:00:21 +0200324 if (!proto_drv->create_opts) {
Max Reitzf0998872018-11-19 11:19:20 +0100325 error_report("Protocol driver '%s' does not support image creation",
Max Reitzd402b6a2018-05-09 23:00:21 +0200326 proto_drv->format_name);
Max Reitz3ecd5a42018-11-19 11:19:21 +0100327 qemu_opts_free(create_opts);
Max Reitzd402b6a2018-05-09 23:00:21 +0200328 return 1;
329 }
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800330 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100331 }
332
Max Reitzf4619af2019-04-13 17:20:37 +0200333 if (filename) {
334 printf("Supported options:\n");
335 } else {
336 printf("Supported %s options:\n", fmt);
337 }
Max Reitz63898712018-10-19 18:49:25 +0200338 qemu_opts_print_help(create_opts, false);
Chunyan Liu83d05212014-06-05 17:20:51 +0800339 qemu_opts_free(create_opts);
Max Reitzf4619af2019-04-13 17:20:37 +0200340
341 if (!filename) {
342 printf("\n"
343 "The protocol level may support further options.\n"
344 "Specify the target filename to include those options.\n");
345 }
346
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100347 return 0;
348}
349
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000350
Max Reitzefaa7c42016-03-16 19:54:38 +0100351static BlockBackend *img_open_opts(const char *optstr,
Kevin Wolfce099542016-03-15 13:01:04 +0100352 QemuOpts *opts, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800353 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000354{
355 QDict *options;
356 Error *local_err = NULL;
357 BlockBackend *blk;
358 options = qemu_opts_to_qdict(opts, NULL);
Fam Zheng335e9932017-05-03 00:35:39 +0800359 if (force_share) {
360 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
Max Reitz4615f872018-05-02 22:20:50 +0200361 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
Fam Zheng335e9932017-05-03 00:35:39 +0800362 error_report("--force-share/-U conflicts with image options");
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200363 qobject_unref(options);
Fam Zheng335e9932017-05-03 00:35:39 +0800364 return NULL;
365 }
Max Reitz4615f872018-05-02 22:20:50 +0200366 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
Fam Zheng335e9932017-05-03 00:35:39 +0800367 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100368 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000369 if (!blk) {
Daniel P. Berrange143605a2016-04-06 10:16:18 +0100370 error_reportf_err(local_err, "Could not open '%s': ", optstr);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000371 return NULL;
372 }
Kevin Wolfce099542016-03-15 13:01:04 +0100373 blk_set_enable_write_cache(blk, !writethrough);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000374
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000375 return blk;
376}
377
Max Reitzefaa7c42016-03-16 19:54:38 +0100378static BlockBackend *img_open_file(const char *filename,
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100379 QDict *options,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000380 const char *fmt, int flags,
Fam Zheng335e9932017-05-03 00:35:39 +0800381 bool writethrough, bool quiet,
382 bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000383{
384 BlockBackend *blk;
Max Reitz34b5d2c2013-09-05 14:45:29 +0200385 Error *local_err = NULL;
Kevin Wolfad717132010-12-16 15:37:41 +0100386
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100387 if (!options) {
388 options = qdict_new();
389 }
bellard75c23802004-08-27 21:28:58 +0000390 if (fmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -0500391 qdict_put_str(options, "driver", fmt);
bellard75c23802004-08-27 21:28:58 +0000392 }
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100393
Fam Zheng335e9932017-05-03 00:35:39 +0800394 if (force_share) {
Eric Blake579cf1d2017-05-15 14:54:39 -0500395 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Fam Zheng335e9932017-05-03 00:35:39 +0800396 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100397 blk = blk_new_open(filename, NULL, options, flags, &local_err);
Max Reitz5bd31322015-02-05 13:58:16 -0500398 if (!blk) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100399 error_reportf_err(local_err, "Could not open '%s': ", filename);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000400 return NULL;
bellard75c23802004-08-27 21:28:58 +0000401 }
Kevin Wolfce099542016-03-15 13:01:04 +0100402 blk_set_enable_write_cache(blk, !writethrough);
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100403
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200404 return blk;
bellard75c23802004-08-27 21:28:58 +0000405}
406
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000407
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100408static int img_add_key_secrets(void *opaque,
409 const char *name, const char *value,
410 Error **errp)
411{
412 QDict *options = opaque;
413
414 if (g_str_has_suffix(name, "key-secret")) {
Eric Blake187f47e2017-06-24 12:10:07 -0600415 qdict_put_str(options, name, value);
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100416 }
417
418 return 0;
419}
420
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100421
Max Reitzefaa7c42016-03-16 19:54:38 +0100422static BlockBackend *img_open(bool image_opts,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000423 const char *filename,
Kevin Wolfce099542016-03-15 13:01:04 +0100424 const char *fmt, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800425 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000426{
427 BlockBackend *blk;
428 if (image_opts) {
429 QemuOpts *opts;
430 if (fmt) {
431 error_report("--image-opts and --format are mutually exclusive");
432 return NULL;
433 }
434 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
435 filename, true);
436 if (!opts) {
437 return NULL;
438 }
Fam Zheng335e9932017-05-03 00:35:39 +0800439 blk = img_open_opts(filename, opts, flags, writethrough, quiet,
440 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000441 } else {
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100442 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
Fam Zheng335e9932017-05-03 00:35:39 +0800443 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000444 }
445 return blk;
446}
447
448
Chunyan Liu83d05212014-06-05 17:20:51 +0800449static int add_old_style_options(const char *fmt, QemuOpts *opts,
Jes Sorenseneec77d92010-12-07 17:44:34 +0100450 const char *base_filename,
451 const char *base_fmt)
Kevin Wolfefa84d42009-05-18 16:42:12 +0200452{
Kevin Wolfefa84d42009-05-18 16:42:12 +0200453 if (base_filename) {
Markus Armbruster235e59c2020-07-07 18:05:42 +0200454 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename,
Markus Armbruster9e194e02020-07-07 18:06:11 +0200455 NULL)) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100456 error_report("Backing file not supported for file format '%s'",
457 fmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900458 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200459 }
460 }
461 if (base_fmt) {
Markus Armbruster9e194e02020-07-07 18:06:11 +0200462 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, NULL)) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100463 error_report("Backing file format not supported for file "
464 "format '%s'", fmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900465 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200466 }
467 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900468 return 0;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200469}
470
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300471static int64_t cvtnum_full(const char *name, const char *value, int64_t min,
472 int64_t max)
Markus Armbruster606caa02017-02-21 21:14:04 +0100473{
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100474 int err;
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300475 uint64_t res;
Markus Armbruster606caa02017-02-21 21:14:04 +0100476
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300477 err = qemu_strtosz(value, NULL, &res);
478 if (err < 0 && err != -ERANGE) {
479 error_report("Invalid %s specified. You may use "
480 "k, M, G, T, P or E suffixes for", name);
481 error_report("kilobytes, megabytes, gigabytes, terabytes, "
482 "petabytes and exabytes.");
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100483 return err;
484 }
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300485 if (err == -ERANGE || res > max || res < min) {
486 error_report("Invalid %s specified. Must be between %" PRId64
487 " and %" PRId64 ".", name, min, max);
Markus Armbrusterf46bfdb2017-02-21 21:14:07 +0100488 return -ERANGE;
489 }
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300490 return res;
491}
492
493static int64_t cvtnum(const char *name, const char *value)
494{
495 return cvtnum_full(name, value, 0, INT64_MAX);
Markus Armbruster606caa02017-02-21 21:14:04 +0100496}
497
bellardea2384d2004-08-01 21:59:26 +0000498static int img_create(int argc, char **argv)
499{
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200500 int c;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100501 uint64_t img_size = -1;
bellardea2384d2004-08-01 21:59:26 +0000502 const char *fmt = "raw";
aliguori9230eaf2009-03-28 17:55:19 +0000503 const char *base_fmt = NULL;
bellardea2384d2004-08-01 21:59:26 +0000504 const char *filename;
505 const char *base_filename = NULL;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200506 char *options = NULL;
Luiz Capitulino9b375252012-11-30 10:52:05 -0200507 Error *local_err = NULL;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100508 bool quiet = false;
John Snow6e6e55f2017-07-17 20:34:22 -0400509 int flags = 0;
ths3b46e622007-09-17 08:09:54 +0000510
bellardea2384d2004-08-01 21:59:26 +0000511 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000512 static const struct option long_options[] = {
513 {"help", no_argument, 0, 'h'},
514 {"object", required_argument, 0, OPTION_OBJECT},
515 {0, 0, 0, 0}
516 };
John Snow6e6e55f2017-07-17 20:34:22 -0400517 c = getopt_long(argc, argv, ":F:b:f:ho:qu",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000518 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100519 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000520 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100521 }
bellardea2384d2004-08-01 21:59:26 +0000522 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800523 case ':':
524 missing_argument(argv[optind - 1]);
525 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100526 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800527 unrecognized_option(argv[optind - 1]);
528 break;
bellardea2384d2004-08-01 21:59:26 +0000529 case 'h':
530 help();
531 break;
aliguori9230eaf2009-03-28 17:55:19 +0000532 case 'F':
533 base_fmt = optarg;
534 break;
bellardea2384d2004-08-01 21:59:26 +0000535 case 'b':
536 base_filename = optarg;
537 break;
538 case 'f':
539 fmt = optarg;
540 break;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200541 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +0200542 if (accumulate_options(&options, optarg) < 0) {
Kevin Wolf77386bf2014-02-21 16:24:04 +0100543 goto fail;
544 }
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200545 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100546 case 'q':
547 quiet = true;
548 break;
John Snow6e6e55f2017-07-17 20:34:22 -0400549 case 'u':
550 flags |= BDRV_O_NO_BACKING;
551 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +0100552 case OPTION_OBJECT:
553 user_creatable_process_cmdline(optarg);
554 break;
bellardea2384d2004-08-01 21:59:26 +0000555 }
556 }
aliguori9230eaf2009-03-28 17:55:19 +0000557
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900558 /* Get the filename */
Kevin Wolfa283cb62014-02-21 16:24:07 +0100559 filename = (optind < argc) ? argv[optind] : NULL;
560 if (options && has_help_option(options)) {
561 g_free(options);
562 return print_block_option_help(filename, fmt);
563 }
564
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100565 if (optind >= argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800566 error_exit("Expecting image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100567 }
Kevin Wolfa283cb62014-02-21 16:24:07 +0100568 optind++;
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900569
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100570 /* Get image size, if specified */
571 if (optind < argc) {
Jes Sorensen70b4f4b2011-01-05 11:41:02 +0100572 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +0100573
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300574 sval = cvtnum("image size", argv[optind++]);
Markus Armbruster606caa02017-02-21 21:14:04 +0100575 if (sval < 0) {
Kevin Wolf77386bf2014-02-21 16:24:04 +0100576 goto fail;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100577 }
578 img_size = (uint64_t)sval;
579 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200580 if (optind != argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800581 error_exit("Unexpected argument: %s", argv[optind]);
Kevin Wolffc11eb22013-08-05 10:53:04 +0200582 }
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100583
Luiz Capitulino9b375252012-11-30 10:52:05 -0200584 bdrv_img_create(filename, fmt, base_filename, base_fmt,
John Snow6e6e55f2017-07-17 20:34:22 -0400585 options, img_size, flags, quiet, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100586 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100587 error_reportf_err(local_err, "%s: ", filename);
Kevin Wolf77386bf2014-02-21 16:24:04 +0100588 goto fail;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900589 }
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200590
Kevin Wolf77386bf2014-02-21 16:24:04 +0100591 g_free(options);
bellardea2384d2004-08-01 21:59:26 +0000592 return 0;
Kevin Wolf77386bf2014-02-21 16:24:04 +0100593
594fail:
595 g_free(options);
596 return 1;
bellardea2384d2004-08-01 21:59:26 +0000597}
598
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100599static void dump_json_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500600{
Markus Armbrustereab3a462020-12-11 18:11:37 +0100601 GString *str;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500602 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +0100603 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600604
605 visit_type_ImageCheck(v, NULL, &check, &error_abort);
606 visit_complete(v, &obj);
Markus Armbruster6589f452020-12-11 18:11:35 +0100607 str = qobject_to_json_pretty(obj, true);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500608 assert(str != NULL);
Markus Armbrustereab3a462020-12-11 18:11:37 +0100609 qprintf(quiet, "%s\n", str->str);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200610 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600611 visit_free(v);
Markus Armbrustereab3a462020-12-11 18:11:37 +0100612 g_string_free(str, true);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500613}
614
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100615static void dump_human_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500616{
617 if (!(check->corruptions || check->leaks || check->check_errors)) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100618 qprintf(quiet, "No errors were found on the image.\n");
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500619 } else {
620 if (check->corruptions) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100621 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
622 "Data may be corrupted, or further writes to the image "
623 "may corrupt it.\n",
624 check->corruptions);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500625 }
626
627 if (check->leaks) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100628 qprintf(quiet,
629 "\n%" PRId64 " leaked clusters were found on the image.\n"
630 "This means waste of disk space, but no harm to data.\n",
631 check->leaks);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500632 }
633
634 if (check->check_errors) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100635 qprintf(quiet,
636 "\n%" PRId64
637 " internal errors have occurred during the check.\n",
638 check->check_errors);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500639 }
640 }
641
642 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100643 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
644 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
645 check->allocated_clusters, check->total_clusters,
646 check->allocated_clusters * 100.0 / check->total_clusters,
647 check->fragmented_clusters * 100.0 / check->allocated_clusters,
648 check->compressed_clusters * 100.0 /
649 check->allocated_clusters);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500650 }
651
652 if (check->image_end_offset) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100653 qprintf(quiet,
654 "Image end offset: %" PRId64 "\n", check->image_end_offset);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500655 }
656}
657
658static int collect_image_check(BlockDriverState *bs,
659 ImageCheck *check,
660 const char *filename,
661 const char *fmt,
662 int fix)
663{
664 int ret;
665 BdrvCheckResult result;
666
667 ret = bdrv_check(bs, &result, fix);
668 if (ret < 0) {
669 return ret;
670 }
671
672 check->filename = g_strdup(filename);
673 check->format = g_strdup(bdrv_get_format_name(bs));
674 check->check_errors = result.check_errors;
675 check->corruptions = result.corruptions;
676 check->has_corruptions = result.corruptions != 0;
677 check->leaks = result.leaks;
678 check->has_leaks = result.leaks != 0;
679 check->corruptions_fixed = result.corruptions_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100680 check->has_corruptions_fixed = result.corruptions_fixed != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500681 check->leaks_fixed = result.leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100682 check->has_leaks_fixed = result.leaks_fixed != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500683 check->image_end_offset = result.image_end_offset;
684 check->has_image_end_offset = result.image_end_offset != 0;
685 check->total_clusters = result.bfi.total_clusters;
686 check->has_total_clusters = result.bfi.total_clusters != 0;
687 check->allocated_clusters = result.bfi.allocated_clusters;
688 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
689 check->fragmented_clusters = result.bfi.fragmented_clusters;
690 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
Stefan Hajnoczie6439d72013-02-07 17:15:04 +0100691 check->compressed_clusters = result.bfi.compressed_clusters;
692 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500693
694 return 0;
695}
696
Kevin Wolfe076f332010-06-29 11:43:13 +0200697/*
698 * Checks an image for consistency. Exit codes:
699 *
Max Reitzd6635c42014-06-02 22:15:21 +0200700 * 0 - Check completed, image is good
701 * 1 - Check not completed because of internal errors
702 * 2 - Check completed, image is corrupted
703 * 3 - Check completed, image has leaked clusters, but is good otherwise
704 * 63 - Checks are not supported by the image format
Kevin Wolfe076f332010-06-29 11:43:13 +0200705 */
aliguori15859692009-04-21 23:11:53 +0000706static int img_check(int argc, char **argv)
707{
708 int c, ret;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500709 OutputFormat output_format = OFORMAT_HUMAN;
Max Reitz40055952014-07-22 22:58:42 +0200710 const char *filename, *fmt, *output, *cache;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200711 BlockBackend *blk;
aliguori15859692009-04-21 23:11:53 +0000712 BlockDriverState *bs;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200713 int fix = 0;
Kevin Wolfce099542016-03-15 13:01:04 +0100714 int flags = BDRV_O_CHECK;
715 bool writethrough;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200716 ImageCheck *check;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100717 bool quiet = false;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000718 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +0800719 bool force_share = false;
aliguori15859692009-04-21 23:11:53 +0000720
721 fmt = NULL;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500722 output = NULL;
Max Reitz40055952014-07-22 22:58:42 +0200723 cache = BDRV_DEFAULT_CACHE;
Kevin Wolfce099542016-03-15 13:01:04 +0100724
aliguori15859692009-04-21 23:11:53 +0000725 for(;;) {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500726 int option_index = 0;
727 static const struct option long_options[] = {
728 {"help", no_argument, 0, 'h'},
729 {"format", required_argument, 0, 'f'},
Prasad Joshi4fd6a982014-03-25 00:08:54 +0530730 {"repair", required_argument, 0, 'r'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500731 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000732 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000733 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +0800734 {"force-share", no_argument, 0, 'U'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500735 {0, 0, 0, 0}
736 };
Fam Zheng335e9932017-05-03 00:35:39 +0800737 c = getopt_long(argc, argv, ":hf:r:T:qU",
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500738 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100739 if (c == -1) {
aliguori15859692009-04-21 23:11:53 +0000740 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100741 }
aliguori15859692009-04-21 23:11:53 +0000742 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800743 case ':':
744 missing_argument(argv[optind - 1]);
745 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100746 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800747 unrecognized_option(argv[optind - 1]);
748 break;
aliguori15859692009-04-21 23:11:53 +0000749 case 'h':
750 help();
751 break;
752 case 'f':
753 fmt = optarg;
754 break;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200755 case 'r':
756 flags |= BDRV_O_RDWR;
757
758 if (!strcmp(optarg, "leaks")) {
759 fix = BDRV_FIX_LEAKS;
760 } else if (!strcmp(optarg, "all")) {
761 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
762 } else {
Fam Zhengac1307a2014-04-22 13:36:11 +0800763 error_exit("Unknown option value for -r "
764 "(expecting 'leaks' or 'all'): %s", optarg);
Kevin Wolf4534ff52012-05-11 16:07:02 +0200765 }
766 break;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500767 case OPTION_OUTPUT:
768 output = optarg;
769 break;
Max Reitz40055952014-07-22 22:58:42 +0200770 case 'T':
771 cache = optarg;
772 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100773 case 'q':
774 quiet = true;
775 break;
Fam Zheng335e9932017-05-03 00:35:39 +0800776 case 'U':
777 force_share = true;
778 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +0100779 case OPTION_OBJECT:
780 user_creatable_process_cmdline(optarg);
781 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000782 case OPTION_IMAGE_OPTS:
783 image_opts = true;
784 break;
aliguori15859692009-04-21 23:11:53 +0000785 }
786 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200787 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800788 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100789 }
aliguori15859692009-04-21 23:11:53 +0000790 filename = argv[optind++];
791
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500792 if (output && !strcmp(output, "json")) {
793 output_format = OFORMAT_JSON;
794 } else if (output && !strcmp(output, "human")) {
795 output_format = OFORMAT_HUMAN;
796 } else if (output) {
797 error_report("--output must be used with human or json as argument.");
798 return 1;
799 }
800
Kevin Wolfce099542016-03-15 13:01:04 +0100801 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +0200802 if (ret < 0) {
803 error_report("Invalid source cache option: %s", cache);
804 return 1;
805 }
806
Fam Zheng335e9932017-05-03 00:35:39 +0800807 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
808 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200809 if (!blk) {
810 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900811 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200812 bs = blk_bs(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500813
814 check = g_new0(ImageCheck, 1);
815 ret = collect_image_check(bs, check, filename, fmt, fix);
Kevin Wolfe076f332010-06-29 11:43:13 +0200816
817 if (ret == -ENOTSUP) {
Max Reitz55d492d2014-05-31 21:33:30 +0200818 error_report("This image format does not support checks");
Peter Lievenfefddf92013-10-24 08:53:34 +0200819 ret = 63;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500820 goto fail;
Kevin Wolfe076f332010-06-29 11:43:13 +0200821 }
822
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500823 if (check->corruptions_fixed || check->leaks_fixed) {
824 int corruptions_fixed, leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100825 bool has_leaks_fixed, has_corruptions_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500826
827 leaks_fixed = check->leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100828 has_leaks_fixed = check->has_leaks_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500829 corruptions_fixed = check->corruptions_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100830 has_corruptions_fixed = check->has_corruptions_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500831
832 if (output_format == OFORMAT_HUMAN) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100833 qprintf(quiet,
834 "The following inconsistencies were found and repaired:\n\n"
835 " %" PRId64 " leaked clusters\n"
836 " %" PRId64 " corruptions\n\n"
837 "Double checking the fixed image now...\n",
838 check->leaks_fixed,
839 check->corruptions_fixed);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500840 }
841
Pan Nengyuanfc124ea2020-02-27 09:29:50 +0800842 qapi_free_ImageCheck(check);
843 check = g_new0(ImageCheck, 1);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500844 ret = collect_image_check(bs, check, filename, fmt, 0);
845
846 check->leaks_fixed = leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100847 check->has_leaks_fixed = has_leaks_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500848 check->corruptions_fixed = corruptions_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100849 check->has_corruptions_fixed = has_corruptions_fixed;
Kevin Wolfccf34712012-05-11 18:16:54 +0200850 }
851
Max Reitz832390a2014-10-23 15:29:12 +0200852 if (!ret) {
853 switch (output_format) {
854 case OFORMAT_HUMAN:
855 dump_human_image_check(check, quiet);
856 break;
857 case OFORMAT_JSON:
858 dump_json_image_check(check, quiet);
859 break;
860 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500861 }
862
863 if (ret || check->check_errors) {
Max Reitz832390a2014-10-23 15:29:12 +0200864 if (ret) {
865 error_report("Check failed: %s", strerror(-ret));
866 } else {
867 error_report("Check failed");
868 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500869 ret = 1;
870 goto fail;
871 }
872
873 if (check->corruptions) {
874 ret = 2;
875 } else if (check->leaks) {
876 ret = 3;
Kevin Wolfe076f332010-06-29 11:43:13 +0200877 } else {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500878 ret = 0;
aliguori15859692009-04-21 23:11:53 +0000879 }
880
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500881fail:
882 qapi_free_ImageCheck(check);
Markus Armbruster26f54e92014-10-07 13:59:04 +0200883 blk_unref(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500884 return ret;
aliguori15859692009-04-21 23:11:53 +0000885}
886
Max Reitzd4a32382014-10-24 15:57:37 +0200887typedef struct CommonBlockJobCBInfo {
888 BlockDriverState *bs;
889 Error **errp;
890} CommonBlockJobCBInfo;
891
892static void common_block_job_cb(void *opaque, int ret)
893{
894 CommonBlockJobCBInfo *cbi = opaque;
895
896 if (ret < 0) {
897 error_setg_errno(cbi->errp, -ret, "Block job failed");
898 }
Max Reitzd4a32382014-10-24 15:57:37 +0200899}
900
901static void run_block_job(BlockJob *job, Error **errp)
902{
Emanuele Giuseppe Espositoa7b4f8f2021-06-14 10:11:29 +0200903 uint64_t progress_current, progress_total;
Kevin Wolfb75536c2016-04-18 17:30:17 +0200904 AioContext *aio_context = blk_get_aio_context(job->blk);
sochin.jiang4172a002017-06-15 14:47:33 +0800905 int ret = 0;
Max Reitzd4a32382014-10-24 15:57:37 +0200906
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200907 aio_context_acquire(aio_context);
Kevin Wolf80fa2c72018-04-13 18:50:05 +0200908 job_ref(&job->job);
Max Reitzd4a32382014-10-24 15:57:37 +0200909 do {
Kevin Wolf30a5c882018-05-04 12:17:20 +0200910 float progress = 0.0f;
Max Reitzd4a32382014-10-24 15:57:37 +0200911 aio_poll(aio_context, true);
Emanuele Giuseppe Espositoa7b4f8f2021-06-14 10:11:29 +0200912
913 progress_get_snapshot(&job->job.progress, &progress_current,
914 &progress_total);
915 if (progress_total) {
916 progress = (float)progress_current / progress_total * 100.f;
Kevin Wolf30a5c882018-05-04 12:17:20 +0200917 }
918 qemu_progress_print(progress, 0);
Kevin Wolfdf956ae2018-04-25 15:09:58 +0200919 } while (!job_is_ready(&job->job) && !job_is_completed(&job->job));
Max Reitzd4a32382014-10-24 15:57:37 +0200920
Kevin Wolfdbe5e6c2018-04-19 13:04:01 +0200921 if (!job_is_completed(&job->job)) {
Kevin Wolf3d70ff52018-04-24 16:13:52 +0200922 ret = job_complete_sync(&job->job, errp);
sochin.jiang4172a002017-06-15 14:47:33 +0800923 } else {
Kevin Wolf4ad35182018-04-19 17:30:16 +0200924 ret = job->job.ret;
sochin.jiang4172a002017-06-15 14:47:33 +0800925 }
Kevin Wolf80fa2c72018-04-13 18:50:05 +0200926 job_unref(&job->job);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200927 aio_context_release(aio_context);
Max Reitz687fa1d2014-10-24 15:57:39 +0200928
sochin.jiang4172a002017-06-15 14:47:33 +0800929 /* publish completion progress only when success */
930 if (!ret) {
931 qemu_progress_print(100.f, 0);
932 }
Max Reitzd4a32382014-10-24 15:57:37 +0200933}
934
bellardea2384d2004-08-01 21:59:26 +0000935static int img_commit(int argc, char **argv)
936{
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400937 int c, ret, flags;
Max Reitz1b22bff2014-10-24 15:57:40 +0200938 const char *filename, *fmt, *cache, *base;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200939 BlockBackend *blk;
Max Reitzd4a32382014-10-24 15:57:37 +0200940 BlockDriverState *bs, *base_bs;
Kevin Wolf4ef85a92017-01-25 19:16:34 +0100941 BlockJob *job;
Max Reitz687fa1d2014-10-24 15:57:39 +0200942 bool progress = false, quiet = false, drop = false;
Kevin Wolfce099542016-03-15 13:01:04 +0100943 bool writethrough;
Max Reitzd4a32382014-10-24 15:57:37 +0200944 Error *local_err = NULL;
945 CommonBlockJobCBInfo cbi;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000946 bool image_opts = false;
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200947 AioContext *aio_context;
Zhenguia0441b62020-10-20 14:47:43 +0000948 int64_t rate_limit = 0;
bellardea2384d2004-08-01 21:59:26 +0000949
950 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400951 cache = BDRV_DEFAULT_CACHE;
Max Reitz1b22bff2014-10-24 15:57:40 +0200952 base = NULL;
bellardea2384d2004-08-01 21:59:26 +0000953 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000954 static const struct option long_options[] = {
955 {"help", no_argument, 0, 'h'},
956 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000957 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000958 {0, 0, 0, 0}
959 };
Zhenguia0441b62020-10-20 14:47:43 +0000960 c = getopt_long(argc, argv, ":f:ht:b:dpqr:",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000961 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100962 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000963 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100964 }
bellardea2384d2004-08-01 21:59:26 +0000965 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800966 case ':':
967 missing_argument(argv[optind - 1]);
968 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100969 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800970 unrecognized_option(argv[optind - 1]);
971 break;
bellardea2384d2004-08-01 21:59:26 +0000972 case 'h':
973 help();
974 break;
975 case 'f':
976 fmt = optarg;
977 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400978 case 't':
979 cache = optarg;
980 break;
Max Reitz1b22bff2014-10-24 15:57:40 +0200981 case 'b':
982 base = optarg;
983 /* -b implies -d */
984 drop = true;
985 break;
Max Reitz9a86fe42014-10-24 15:57:38 +0200986 case 'd':
987 drop = true;
988 break;
Max Reitz687fa1d2014-10-24 15:57:39 +0200989 case 'p':
990 progress = true;
991 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100992 case 'q':
993 quiet = true;
994 break;
Zhenguia0441b62020-10-20 14:47:43 +0000995 case 'r':
996 rate_limit = cvtnum("rate limit", optarg);
997 if (rate_limit < 0) {
998 return 1;
999 }
1000 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01001001 case OPTION_OBJECT:
1002 user_creatable_process_cmdline(optarg);
1003 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001004 case OPTION_IMAGE_OPTS:
1005 image_opts = true;
1006 break;
bellardea2384d2004-08-01 21:59:26 +00001007 }
1008 }
Max Reitz687fa1d2014-10-24 15:57:39 +02001009
1010 /* Progress is not shown in Quiet mode */
1011 if (quiet) {
1012 progress = false;
1013 }
1014
Kevin Wolffc11eb22013-08-05 10:53:04 +02001015 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001016 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01001017 }
bellardea2384d2004-08-01 21:59:26 +00001018 filename = argv[optind++];
1019
Max Reitz9a86fe42014-10-24 15:57:38 +02001020 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
Kevin Wolfce099542016-03-15 13:01:04 +01001021 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001022 if (ret < 0) {
1023 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczia3981eb2014-08-26 19:17:54 +01001024 return 1;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001025 }
1026
Fam Zheng335e9932017-05-03 00:35:39 +08001027 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
1028 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001029 if (!blk) {
1030 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001031 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001032 bs = blk_bs(blk);
1033
Max Reitz687fa1d2014-10-24 15:57:39 +02001034 qemu_progress_init(progress, 1.f);
1035 qemu_progress_print(0.f, 100);
1036
Max Reitz1b22bff2014-10-24 15:57:40 +02001037 if (base) {
1038 base_bs = bdrv_find_backing_image(bs, base);
1039 if (!base_bs) {
Max Reitz6b33f3a2016-12-01 03:05:08 +01001040 error_setg(&local_err,
1041 "Did not find '%s' in the backing chain of '%s'",
1042 base, filename);
Max Reitz1b22bff2014-10-24 15:57:40 +02001043 goto done;
1044 }
1045 } else {
1046 /* This is different from QMP, which by default uses the deepest file in
1047 * the backing chain (i.e., the very base); however, the traditional
1048 * behavior of qemu-img commit is using the immediate backing file. */
Max Reitz4a2061e2019-06-12 19:00:30 +02001049 base_bs = bdrv_backing_chain_next(bs);
Max Reitz1b22bff2014-10-24 15:57:40 +02001050 if (!base_bs) {
1051 error_setg(&local_err, "Image does not have a backing file");
1052 goto done;
1053 }
bellardea2384d2004-08-01 21:59:26 +00001054 }
1055
Max Reitzd4a32382014-10-24 15:57:37 +02001056 cbi = (CommonBlockJobCBInfo){
1057 .errp = &local_err,
1058 .bs = bs,
1059 };
1060
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001061 aio_context = bdrv_get_aio_context(bs);
1062 aio_context_acquire(aio_context);
Zhenguia0441b62020-10-20 14:47:43 +00001063 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, rate_limit,
Kevin Wolf0db832f2017-02-20 18:10:05 +01001064 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
Fam Zheng78bbd912017-04-21 20:27:04 +08001065 &cbi, false, &local_err);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001066 aio_context_release(aio_context);
Max Reitzd4a32382014-10-24 15:57:37 +02001067 if (local_err) {
1068 goto done;
1069 }
1070
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001071 /* When the block job completes, the BlockBackend reference will point to
1072 * the old backing file. In order to avoid that the top image is already
1073 * deleted, so we can still empty it afterwards, increment the reference
1074 * counter here preemptively. */
Max Reitz9a86fe42014-10-24 15:57:38 +02001075 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001076 bdrv_ref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001077 }
1078
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001079 job = block_job_get("commit");
Liam Merwick2e2db262018-11-05 21:38:37 +00001080 assert(job);
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001081 run_block_job(job, &local_err);
Max Reitz9a86fe42014-10-24 15:57:38 +02001082 if (local_err) {
1083 goto unref_backing;
1084 }
1085
Max Reitz2d97fde2020-04-29 16:11:26 +02001086 if (!drop) {
1087 BlockBackend *old_backing_blk;
1088
1089 old_backing_blk = blk_new_with_bs(bs, BLK_PERM_WRITE, BLK_PERM_ALL,
1090 &local_err);
1091 if (!old_backing_blk) {
1092 goto unref_backing;
1093 }
1094 ret = blk_make_empty(old_backing_blk, &local_err);
1095 blk_unref(old_backing_blk);
1096 if (ret == -ENOTSUP) {
1097 error_free(local_err);
1098 local_err = NULL;
1099 } else if (ret < 0) {
Max Reitz9a86fe42014-10-24 15:57:38 +02001100 goto unref_backing;
1101 }
1102 }
1103
1104unref_backing:
1105 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001106 bdrv_unref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001107 }
Max Reitzd4a32382014-10-24 15:57:37 +02001108
1109done:
Max Reitz687fa1d2014-10-24 15:57:39 +02001110 qemu_progress_end();
1111
Markus Armbruster26f54e92014-10-07 13:59:04 +02001112 blk_unref(blk);
Max Reitzd4a32382014-10-24 15:57:37 +02001113
1114 if (local_err) {
Markus Armbruster6936f292015-02-10 15:14:02 +01001115 error_report_err(local_err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001116 return 1;
1117 }
Max Reitzd4a32382014-10-24 15:57:37 +02001118
1119 qprintf(quiet, "Image committed.\n");
bellardea2384d2004-08-01 21:59:26 +00001120 return 0;
1121}
1122
Dmitry Konishchevf6a00aa2011-05-18 15:03:59 +04001123/*
Eric Blakedebb38a2017-10-11 22:47:11 -05001124 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1125 * of the first sector boundary within buf where the sector contains a
1126 * non-zero byte. This function is robust to a buffer that is not
1127 * sector-aligned.
1128 */
1129static int64_t find_nonzero(const uint8_t *buf, int64_t n)
1130{
1131 int64_t i;
1132 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);
1133
1134 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
1135 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
1136 return i;
1137 }
1138 }
1139 if (i < n && !buffer_is_zero(buf + i, n - end)) {
1140 return i;
1141 }
1142 return -1;
1143}
1144
1145/*
thsf58c7b32008-06-05 21:53:49 +00001146 * Returns true iff the first sector pointed to by 'buf' contains at least
1147 * a non-NUL byte.
1148 *
1149 * 'pnum' is set to the number of sectors (including and immediately following
1150 * the first one) that are known to be in the same allocated/unallocated state.
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001151 * The function will try to align the end offset to alignment boundaries so
zhaolichange3a6e0d2020-09-17 15:50:20 +08001152 * that the request will at least end aligned and consecutive requests will
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001153 * also start at an aligned offset.
thsf58c7b32008-06-05 21:53:49 +00001154 */
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001155static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
1156 int64_t sector_num, int alignment)
bellardea2384d2004-08-01 21:59:26 +00001157{
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001158 bool is_zero;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001159 int i, tail;
bellardea2384d2004-08-01 21:59:26 +00001160
1161 if (n <= 0) {
1162 *pnum = 0;
1163 return 0;
1164 }
Yi Lic075c422020-08-19 09:36:07 +08001165 is_zero = buffer_is_zero(buf, BDRV_SECTOR_SIZE);
bellardea2384d2004-08-01 21:59:26 +00001166 for(i = 1; i < n; i++) {
Yi Lic075c422020-08-19 09:36:07 +08001167 buf += BDRV_SECTOR_SIZE;
1168 if (is_zero != buffer_is_zero(buf, BDRV_SECTOR_SIZE)) {
bellardea2384d2004-08-01 21:59:26 +00001169 break;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001170 }
bellardea2384d2004-08-01 21:59:26 +00001171 }
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001172
1173 tail = (sector_num + i) & (alignment - 1);
1174 if (tail) {
1175 if (is_zero && i <= tail) {
1176 /* treat unallocated areas which only consist
1177 * of a small tail as allocated. */
1178 is_zero = false;
1179 }
1180 if (!is_zero) {
1181 /* align up end offset of allocated areas. */
1182 i += alignment - tail;
1183 i = MIN(i, n);
1184 } else {
1185 /* align down end offset of zero areas. */
1186 i -= tail;
1187 }
1188 }
bellardea2384d2004-08-01 21:59:26 +00001189 *pnum = i;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001190 return !is_zero;
bellardea2384d2004-08-01 21:59:26 +00001191}
1192
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001193/*
Kevin Wolfa22f1232011-08-26 15:27:13 +02001194 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1195 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1196 * breaking up write requests for only small sparse areas.
1197 */
1198static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001199 int min, int64_t sector_num, int alignment)
Kevin Wolfa22f1232011-08-26 15:27:13 +02001200{
1201 int ret;
1202 int num_checked, num_used;
1203
1204 if (n < min) {
1205 min = n;
1206 }
1207
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001208 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001209 if (!ret) {
1210 return ret;
1211 }
1212
1213 num_used = *pnum;
1214 buf += BDRV_SECTOR_SIZE * *pnum;
1215 n -= *pnum;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001216 sector_num += *pnum;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001217 num_checked = num_used;
1218
1219 while (n > 0) {
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001220 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001221
1222 buf += BDRV_SECTOR_SIZE * *pnum;
1223 n -= *pnum;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001224 sector_num += *pnum;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001225 num_checked += *pnum;
1226 if (ret) {
1227 num_used = num_checked;
1228 } else if (*pnum >= min) {
1229 break;
1230 }
1231 }
1232
1233 *pnum = num_used;
1234 return 1;
1235}
1236
1237/*
Eric Blakedc61cd32017-10-11 22:47:14 -05001238 * Compares two buffers sector by sector. Returns 0 if the first
1239 * sector of each buffer matches, non-zero otherwise.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001240 *
Eric Blakedc61cd32017-10-11 22:47:14 -05001241 * pnum is set to the sector-aligned size of the buffer prefix that
1242 * has the same matching status as the first sector.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001243 */
Eric Blakedc61cd32017-10-11 22:47:14 -05001244static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
1245 int64_t bytes, int64_t *pnum)
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001246{
Radim Krčmář8c1ac472015-02-20 17:06:15 +01001247 bool res;
Eric Blakedc61cd32017-10-11 22:47:14 -05001248 int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001249
Eric Blakedc61cd32017-10-11 22:47:14 -05001250 assert(bytes > 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001251
Eric Blakedc61cd32017-10-11 22:47:14 -05001252 res = !!memcmp(buf1, buf2, i);
1253 while (i < bytes) {
1254 int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001255
Eric Blakedc61cd32017-10-11 22:47:14 -05001256 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001257 break;
1258 }
Eric Blakedc61cd32017-10-11 22:47:14 -05001259 i += len;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001260 }
1261
1262 *pnum = i;
1263 return res;
1264}
1265
Stefano Garzarella97ede572019-05-08 12:43:24 +02001266#define IO_BUF_SIZE (2 * MiB)
bellardea2384d2004-08-01 21:59:26 +00001267
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001268/*
1269 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1270 *
Eric Blake0608e402017-10-11 22:47:12 -05001271 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1272 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1273 * failure), and 4 on error (the exit status for read errors), after emitting
1274 * an error message.
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001275 *
Max Reitzf1d3cd72015-02-05 13:58:18 -05001276 * @param blk: BlockBackend for the image
Eric Blakec41508e2017-10-11 22:47:13 -05001277 * @param offset: Starting offset to check
1278 * @param bytes: Number of bytes to check
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001279 * @param filename: Name of disk file we are checking (logging purpose)
1280 * @param buffer: Allocated buffer for storing read data
1281 * @param quiet: Flag for quiet mode
1282 */
Eric Blakec41508e2017-10-11 22:47:13 -05001283static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1284 int64_t bytes, const char *filename,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001285 uint8_t *buffer, bool quiet)
1286{
Eric Blakedebb38a2017-10-11 22:47:11 -05001287 int ret = 0;
1288 int64_t idx;
1289
Eric Blakec41508e2017-10-11 22:47:13 -05001290 ret = blk_pread(blk, offset, buffer, bytes);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001291 if (ret < 0) {
1292 error_report("Error while reading offset %" PRId64 " of %s: %s",
Eric Blakec41508e2017-10-11 22:47:13 -05001293 offset, filename, strerror(-ret));
Eric Blake0608e402017-10-11 22:47:12 -05001294 return 4;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001295 }
Eric Blakec41508e2017-10-11 22:47:13 -05001296 idx = find_nonzero(buffer, bytes);
Eric Blakedebb38a2017-10-11 22:47:11 -05001297 if (idx >= 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001298 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blakec41508e2017-10-11 22:47:13 -05001299 offset + idx);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001300 return 1;
1301 }
1302
1303 return 0;
1304}
1305
1306/*
1307 * Compares two images. Exit codes:
1308 *
Kevin Wolf99b1e642021-02-17 12:56:45 +01001309 * 0 - Images are identical or the requested help was printed
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001310 * 1 - Images differ
1311 * >1 - Error occurred
1312 */
1313static int img_compare(int argc, char **argv)
1314{
Max Reitz40055952014-07-22 22:58:42 +02001315 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001316 BlockBackend *blk1, *blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001317 BlockDriverState *bs1, *bs2;
Eric Blake033d9fc2017-10-11 22:47:16 -05001318 int64_t total_size1, total_size2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001319 uint8_t *buf1 = NULL, *buf2 = NULL;
Eric Blake31826642017-10-11 22:47:08 -05001320 int64_t pnum1, pnum2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001321 int allocated1, allocated2;
1322 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1323 bool progress = false, quiet = false, strict = false;
Max Reitz40055952014-07-22 22:58:42 +02001324 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01001325 bool writethrough;
Eric Blake033d9fc2017-10-11 22:47:16 -05001326 int64_t total_size;
1327 int64_t offset = 0;
1328 int64_t chunk;
Eric Blakedc61cd32017-10-11 22:47:14 -05001329 int c;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001330 uint64_t progress_base;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001331 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08001332 bool force_share = false;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001333
Max Reitz40055952014-07-22 22:58:42 +02001334 cache = BDRV_DEFAULT_CACHE;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001335 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001336 static const struct option long_options[] = {
1337 {"help", no_argument, 0, 'h'},
1338 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001339 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08001340 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001341 {0, 0, 0, 0}
1342 };
Fam Zheng335e9932017-05-03 00:35:39 +08001343 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001344 long_options, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001345 if (c == -1) {
1346 break;
1347 }
1348 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001349 case ':':
1350 missing_argument(argv[optind - 1]);
1351 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001352 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001353 unrecognized_option(argv[optind - 1]);
1354 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001355 case 'h':
1356 help();
1357 break;
1358 case 'f':
1359 fmt1 = optarg;
1360 break;
1361 case 'F':
1362 fmt2 = optarg;
1363 break;
Max Reitz40055952014-07-22 22:58:42 +02001364 case 'T':
1365 cache = optarg;
1366 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001367 case 'p':
1368 progress = true;
1369 break;
1370 case 'q':
1371 quiet = true;
1372 break;
1373 case 's':
1374 strict = true;
1375 break;
Fam Zheng335e9932017-05-03 00:35:39 +08001376 case 'U':
1377 force_share = true;
1378 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01001379 case OPTION_OBJECT:
1380 {
1381 Error *local_err = NULL;
1382
1383 if (!user_creatable_add_from_str(optarg, &local_err)) {
1384 if (local_err) {
1385 error_report_err(local_err);
1386 exit(2);
1387 } else {
1388 /* Help was printed */
1389 exit(EXIT_SUCCESS);
1390 }
1391 }
1392 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001393 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001394 case OPTION_IMAGE_OPTS:
1395 image_opts = true;
1396 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001397 }
1398 }
1399
1400 /* Progress is not shown in Quiet mode */
1401 if (quiet) {
1402 progress = false;
1403 }
1404
1405
Kevin Wolffc11eb22013-08-05 10:53:04 +02001406 if (optind != argc - 2) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001407 error_exit("Expecting two image file names");
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001408 }
1409 filename1 = argv[optind++];
1410 filename2 = argv[optind++];
1411
Stefan Hajnoczicbda0162014-08-26 19:17:55 +01001412 /* Initialize before goto out */
1413 qemu_progress_init(progress, 2.0);
1414
Kevin Wolfce099542016-03-15 13:01:04 +01001415 flags = 0;
1416 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +02001417 if (ret < 0) {
1418 error_report("Invalid source cache option: %s", cache);
1419 ret = 2;
1420 goto out3;
1421 }
1422
Fam Zheng335e9932017-05-03 00:35:39 +08001423 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1424 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001425 if (!blk1) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001426 ret = 2;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001427 goto out3;
1428 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001429
Fam Zheng335e9932017-05-03 00:35:39 +08001430 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1431 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001432 if (!blk2) {
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001433 ret = 2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001434 goto out2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001435 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001436 bs1 = blk_bs(blk1);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001437 bs2 = blk_bs(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001438
Max Reitzf1d3cd72015-02-05 13:58:18 -05001439 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1440 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
Eric Blake033d9fc2017-10-11 22:47:16 -05001441 total_size1 = blk_getlength(blk1);
1442 if (total_size1 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001443 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001444 filename1, strerror(-total_size1));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001445 ret = 4;
1446 goto out;
1447 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001448 total_size2 = blk_getlength(blk2);
1449 if (total_size2 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001450 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001451 filename2, strerror(-total_size2));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001452 ret = 4;
1453 goto out;
1454 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001455 total_size = MIN(total_size1, total_size2);
1456 progress_base = MAX(total_size1, total_size2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001457
1458 qemu_progress_print(0, 100);
1459
Eric Blake033d9fc2017-10-11 22:47:16 -05001460 if (strict && total_size1 != total_size2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001461 ret = 1;
1462 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1463 goto out;
1464 }
1465
Eric Blake033d9fc2017-10-11 22:47:16 -05001466 while (offset < total_size) {
Eric Blake31826642017-10-11 22:47:08 -05001467 int status1, status2;
Fam Zheng67a0fd22016-01-26 11:58:48 +08001468
Eric Blake033d9fc2017-10-11 22:47:16 -05001469 status1 = bdrv_block_status_above(bs1, NULL, offset,
1470 total_size1 - offset, &pnum1, NULL,
1471 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001472 if (status1 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001473 ret = 3;
1474 error_report("Sector allocation test failed for %s", filename1);
1475 goto out;
1476 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001477 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001478
Eric Blake033d9fc2017-10-11 22:47:16 -05001479 status2 = bdrv_block_status_above(bs2, NULL, offset,
1480 total_size2 - offset, &pnum2, NULL,
1481 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001482 if (status2 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001483 ret = 3;
1484 error_report("Sector allocation test failed for %s", filename2);
1485 goto out;
1486 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001487 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
Eric Blake7daddc62017-10-11 22:47:09 -05001488
1489 assert(pnum1 && pnum2);
Eric Blake033d9fc2017-10-11 22:47:16 -05001490 chunk = MIN(pnum1, pnum2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001491
Fam Zheng25ad8e62016-01-13 16:37:41 +08001492 if (strict) {
Eric Blake31826642017-10-11 22:47:08 -05001493 if (status1 != status2) {
Fam Zheng25ad8e62016-01-13 16:37:41 +08001494 ret = 1;
1495 qprintf(quiet, "Strict mode: Offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001496 " block status mismatch!\n", offset);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001497 goto out;
1498 }
1499 }
1500 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
Eric Blake7daddc62017-10-11 22:47:09 -05001501 /* nothing to do */
Fam Zheng25ad8e62016-01-13 16:37:41 +08001502 } else if (allocated1 == allocated2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001503 if (allocated1) {
Eric Blakedc61cd32017-10-11 22:47:14 -05001504 int64_t pnum;
1505
Eric Blake033d9fc2017-10-11 22:47:16 -05001506 chunk = MIN(chunk, IO_BUF_SIZE);
1507 ret = blk_pread(blk1, offset, buf1, chunk);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001508 if (ret < 0) {
1509 error_report("Error while reading offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001510 " of %s: %s",
1511 offset, filename1, strerror(-ret));
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001512 ret = 4;
1513 goto out;
1514 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001515 ret = blk_pread(blk2, offset, buf2, chunk);
1516 if (ret < 0) {
1517 error_report("Error while reading offset %" PRId64
1518 " of %s: %s",
1519 offset, filename2, strerror(-ret));
1520 ret = 4;
1521 goto out;
1522 }
1523 ret = compare_buffers(buf1, buf2, chunk, &pnum);
1524 if (ret || pnum != chunk) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001525 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blake033d9fc2017-10-11 22:47:16 -05001526 offset + (ret ? 0 : pnum));
Fam Zheng36452f12013-11-13 20:26:49 +08001527 ret = 1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001528 goto out;
1529 }
1530 }
1531 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001532 chunk = MIN(chunk, IO_BUF_SIZE);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001533 if (allocated1) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001534 ret = check_empty_sectors(blk1, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001535 filename1, buf1, quiet);
1536 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001537 ret = check_empty_sectors(blk2, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001538 filename2, buf1, quiet);
1539 }
1540 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001541 goto out;
1542 }
1543 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001544 offset += chunk;
1545 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001546 }
1547
Eric Blake033d9fc2017-10-11 22:47:16 -05001548 if (total_size1 != total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001549 BlockBackend *blk_over;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001550 const char *filename_over;
1551
1552 qprintf(quiet, "Warning: Image size mismatch!\n");
Eric Blake033d9fc2017-10-11 22:47:16 -05001553 if (total_size1 > total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001554 blk_over = blk1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001555 filename_over = filename1;
1556 } else {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001557 blk_over = blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001558 filename_over = filename2;
1559 }
1560
Eric Blake033d9fc2017-10-11 22:47:16 -05001561 while (offset < progress_base) {
1562 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1563 progress_base - offset, &chunk,
1564 NULL, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001565 if (ret < 0) {
1566 ret = 3;
1567 error_report("Sector allocation test failed for %s",
1568 filename_over);
1569 goto out;
1570
1571 }
Eric Blake391cb1a2017-10-11 22:47:10 -05001572 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001573 chunk = MIN(chunk, IO_BUF_SIZE);
1574 ret = check_empty_sectors(blk_over, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001575 filename_over, buf1, quiet);
1576 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001577 goto out;
1578 }
1579 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001580 offset += chunk;
1581 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001582 }
1583 }
1584
1585 qprintf(quiet, "Images are identical.\n");
1586 ret = 0;
1587
1588out:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001589 qemu_vfree(buf1);
1590 qemu_vfree(buf2);
Markus Armbruster26f54e92014-10-07 13:59:04 +02001591 blk_unref(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001592out2:
Markus Armbruster26f54e92014-10-07 13:59:04 +02001593 blk_unref(blk1);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001594out3:
1595 qemu_progress_end();
1596 return ret;
1597}
1598
Eric Blake6c729dd2020-05-21 14:21:35 -05001599/* Convenience wrapper around qmp_block_dirty_bitmap_merge */
1600static void do_dirty_bitmap_merge(const char *dst_node, const char *dst_name,
1601 const char *src_node, const char *src_name,
1602 Error **errp)
1603{
1604 BlockDirtyBitmapMergeSource *merge_src;
Eric Blake54aa3de2020-11-12 19:13:37 -06001605 BlockDirtyBitmapMergeSourceList *list = NULL;
Eric Blake6c729dd2020-05-21 14:21:35 -05001606
1607 merge_src = g_new0(BlockDirtyBitmapMergeSource, 1);
1608 merge_src->type = QTYPE_QDICT;
1609 merge_src->u.external.node = g_strdup(src_node);
1610 merge_src->u.external.name = g_strdup(src_name);
Eric Blake54aa3de2020-11-12 19:13:37 -06001611 QAPI_LIST_PREPEND(list, merge_src);
Eric Blake6c729dd2020-05-21 14:21:35 -05001612 qmp_block_dirty_bitmap_merge(dst_node, dst_name, list, errp);
1613 qapi_free_BlockDirtyBitmapMergeSourceList(list);
1614}
1615
Kevin Wolf690c7302015-03-19 13:33:32 +01001616enum ImgConvertBlockStatus {
1617 BLK_DATA,
1618 BLK_ZERO,
1619 BLK_BACKING_FILE,
1620};
1621
Peter Lieven2d9187b2017-02-28 13:40:07 +01001622#define MAX_COROUTINES 16
Zhengui0c8c4892020-10-20 14:47:44 +00001623#define CONVERT_THROTTLE_GROUP "img_convert"
Peter Lieven2d9187b2017-02-28 13:40:07 +01001624
Kevin Wolf690c7302015-03-19 13:33:32 +01001625typedef struct ImgConvertState {
1626 BlockBackend **src;
1627 int64_t *src_sectors;
Peter Lievenaf8d43d2020-09-01 14:51:29 +02001628 int *src_alignment;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001629 int src_num;
Kevin Wolf690c7302015-03-19 13:33:32 +01001630 int64_t total_sectors;
1631 int64_t allocated_sectors;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001632 int64_t allocated_done;
1633 int64_t sector_num;
1634 int64_t wr_offs;
Kevin Wolf690c7302015-03-19 13:33:32 +01001635 enum ImgConvertBlockStatus status;
1636 int64_t sector_next_status;
1637 BlockBackend *target;
1638 bool has_zero_init;
1639 bool compressed;
Max Reitz4d7c4872019-07-24 19:12:29 +02001640 bool target_is_new;
Kevin Wolf690c7302015-03-19 13:33:32 +01001641 bool target_has_backing;
Max Reitz351c8ef2018-05-01 18:57:49 +02001642 int64_t target_backing_sectors; /* negative if unknown */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001643 bool wr_in_order;
Fam Zhengee5306d2018-06-01 17:26:48 +08001644 bool copy_range;
Max Reitz8eaac022019-05-07 22:35:03 +02001645 bool salvage;
Max Reitz3d96cb92019-05-07 22:35:02 +02001646 bool quiet;
Kevin Wolf690c7302015-03-19 13:33:32 +01001647 int min_sparse;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001648 int alignment;
Kevin Wolf690c7302015-03-19 13:33:32 +01001649 size_t cluster_sectors;
1650 size_t buf_sectors;
Peter Lieven9fd77f92017-04-21 11:11:55 +02001651 long num_coroutines;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001652 int running_coroutines;
1653 Coroutine *co[MAX_COROUTINES];
1654 int64_t wait_sector_num[MAX_COROUTINES];
1655 CoMutex lock;
1656 int ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001657} ImgConvertState;
1658
Peter Lieven2d9187b2017-02-28 13:40:07 +01001659static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1660 int *src_cur, int64_t *src_cur_offset)
Kevin Wolf690c7302015-03-19 13:33:32 +01001661{
Peter Lieven2d9187b2017-02-28 13:40:07 +01001662 *src_cur = 0;
1663 *src_cur_offset = 0;
1664 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1665 *src_cur_offset += s->src_sectors[*src_cur];
1666 (*src_cur)++;
1667 assert(*src_cur < s->src_num);
Kevin Wolf690c7302015-03-19 13:33:32 +01001668 }
1669}
1670
1671static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1672{
Eric Blake31826642017-10-11 22:47:08 -05001673 int64_t src_cur_offset;
1674 int ret, n, src_cur;
Max Reitz351c8ef2018-05-01 18:57:49 +02001675 bool post_backing_zero = false;
Kevin Wolf690c7302015-03-19 13:33:32 +01001676
Peter Lieven2d9187b2017-02-28 13:40:07 +01001677 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
Kevin Wolf690c7302015-03-19 13:33:32 +01001678
1679 assert(s->total_sectors > sector_num);
1680 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1681
Max Reitz351c8ef2018-05-01 18:57:49 +02001682 if (s->target_backing_sectors >= 0) {
1683 if (sector_num >= s->target_backing_sectors) {
Vladimir Sementsov-Ogievskiy2253d862020-05-28 12:43:56 +03001684 post_backing_zero = true;
Max Reitz351c8ef2018-05-01 18:57:49 +02001685 } else if (sector_num + n > s->target_backing_sectors) {
1686 /* Split requests around target_backing_sectors (because
1687 * starting from there, zeros are handled differently) */
1688 n = s->target_backing_sectors - sector_num;
1689 }
1690 }
1691
Kevin Wolf690c7302015-03-19 13:33:32 +01001692 if (s->sector_next_status <= sector_num) {
Max Reitz8eaac022019-05-07 22:35:03 +02001693 uint64_t offset = (sector_num - src_cur_offset) * BDRV_SECTOR_SIZE;
1694 int64_t count;
Peter Lievenaf8d43d2020-09-01 14:51:29 +02001695 int tail;
Max Reitz4a2061e2019-06-12 19:00:30 +02001696 BlockDriverState *src_bs = blk_bs(s->src[src_cur]);
1697 BlockDriverState *base;
1698
1699 if (s->target_has_backing) {
1700 base = bdrv_cow_bs(bdrv_skip_filters(src_bs));
1701 } else {
1702 base = NULL;
1703 }
Eric Blake31826642017-10-11 22:47:08 -05001704
Max Reitz8eaac022019-05-07 22:35:03 +02001705 do {
1706 count = n * BDRV_SECTOR_SIZE;
Eric Blake237d78f2017-10-11 22:47:03 -05001707
Max Reitz4a2061e2019-06-12 19:00:30 +02001708 ret = bdrv_block_status_above(src_bs, base, offset, count, &count,
1709 NULL, NULL);
Max Reitz8eaac022019-05-07 22:35:03 +02001710
1711 if (ret < 0) {
1712 if (s->salvage) {
1713 if (n == 1) {
1714 if (!s->quiet) {
1715 warn_report("error while reading block status at "
1716 "offset %" PRIu64 ": %s", offset,
1717 strerror(-ret));
1718 }
1719 /* Just try to read the data, then */
1720 ret = BDRV_BLOCK_DATA;
1721 count = BDRV_SECTOR_SIZE;
1722 } else {
1723 /* Retry on a shorter range */
1724 n = DIV_ROUND_UP(n, 4);
1725 }
1726 } else {
1727 error_report("error while reading block status at offset "
1728 "%" PRIu64 ": %s", offset, strerror(-ret));
1729 return ret;
1730 }
1731 }
1732 } while (ret < 0);
1733
Eric Blake31826642017-10-11 22:47:08 -05001734 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
Kevin Wolf690c7302015-03-19 13:33:32 +01001735
Peter Lievenaf8d43d2020-09-01 14:51:29 +02001736 /*
1737 * Avoid that s->sector_next_status becomes unaligned to the source
1738 * request alignment and/or cluster size to avoid unnecessary read
1739 * cycles.
1740 */
1741 tail = (sector_num - src_cur_offset + n) % s->src_alignment[src_cur];
1742 if (n > tail) {
1743 n -= tail;
1744 }
1745
Kevin Wolf690c7302015-03-19 13:33:32 +01001746 if (ret & BDRV_BLOCK_ZERO) {
Max Reitz351c8ef2018-05-01 18:57:49 +02001747 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
Kevin Wolf690c7302015-03-19 13:33:32 +01001748 } else if (ret & BDRV_BLOCK_DATA) {
1749 s->status = BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001750 } else {
Vladimir Sementsov-Ogievskiy9f1b92a2017-04-07 14:34:04 +03001751 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001752 }
1753
1754 s->sector_next_status = sector_num + n;
1755 }
1756
1757 n = MIN(n, s->sector_next_status - sector_num);
1758 if (s->status == BLK_DATA) {
1759 n = MIN(n, s->buf_sectors);
1760 }
1761
1762 /* We need to write complete clusters for compressed images, so if an
1763 * unallocated area is shorter than that, we must consider the whole
1764 * cluster allocated. */
1765 if (s->compressed) {
1766 if (n < s->cluster_sectors) {
1767 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1768 s->status = BLK_DATA;
1769 } else {
1770 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1771 }
1772 }
1773
1774 return n;
1775}
1776
Peter Lieven2d9187b2017-02-28 13:40:07 +01001777static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1778 int nb_sectors, uint8_t *buf)
Kevin Wolf690c7302015-03-19 13:33:32 +01001779{
Max Reitz8eaac022019-05-07 22:35:03 +02001780 uint64_t single_read_until = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001781 int n, ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001782
Kevin Wolf690c7302015-03-19 13:33:32 +01001783 assert(nb_sectors <= s->buf_sectors);
1784 while (nb_sectors > 0) {
1785 BlockBackend *blk;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001786 int src_cur;
1787 int64_t bs_sectors, src_cur_offset;
Max Reitz8eaac022019-05-07 22:35:03 +02001788 uint64_t offset;
Kevin Wolf690c7302015-03-19 13:33:32 +01001789
1790 /* In the case of compression with multiple source files, we can get a
1791 * nb_sectors that spreads into the next part. So we must be able to
1792 * read across multiple BDSes for one convert_read() call. */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001793 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1794 blk = s->src[src_cur];
1795 bs_sectors = s->src_sectors[src_cur];
Kevin Wolf690c7302015-03-19 13:33:32 +01001796
Max Reitz8eaac022019-05-07 22:35:03 +02001797 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001798
Max Reitz8eaac022019-05-07 22:35:03 +02001799 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1800 if (single_read_until > offset) {
1801 n = 1;
1802 }
1803
1804 ret = blk_co_pread(blk, offset, n << BDRV_SECTOR_BITS, buf, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01001805 if (ret < 0) {
Max Reitz8eaac022019-05-07 22:35:03 +02001806 if (s->salvage) {
1807 if (n > 1) {
1808 single_read_until = offset + (n << BDRV_SECTOR_BITS);
1809 continue;
1810 } else {
1811 if (!s->quiet) {
1812 warn_report("error while reading offset %" PRIu64
1813 ": %s", offset, strerror(-ret));
1814 }
1815 memset(buf, 0, BDRV_SECTOR_SIZE);
1816 }
1817 } else {
1818 return ret;
1819 }
Kevin Wolf690c7302015-03-19 13:33:32 +01001820 }
1821
1822 sector_num += n;
1823 nb_sectors -= n;
1824 buf += n * BDRV_SECTOR_SIZE;
1825 }
1826
1827 return 0;
1828}
1829
Peter Lieven2d9187b2017-02-28 13:40:07 +01001830
1831static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1832 int nb_sectors, uint8_t *buf,
1833 enum ImgConvertBlockStatus status)
Kevin Wolf690c7302015-03-19 13:33:32 +01001834{
1835 int ret;
1836
1837 while (nb_sectors > 0) {
1838 int n = nb_sectors;
Lidong Chendb933fb2017-04-27 10:58:27 +08001839 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1840
Peter Lieven2d9187b2017-02-28 13:40:07 +01001841 switch (status) {
Kevin Wolf690c7302015-03-19 13:33:32 +01001842 case BLK_BACKING_FILE:
1843 /* If we have a backing file, leave clusters unallocated that are
1844 * unallocated in the source image, so that the backing file is
1845 * visible at the respective offset. */
1846 assert(s->target_has_backing);
1847 break;
1848
1849 case BLK_DATA:
Lidong Chendb933fb2017-04-27 10:58:27 +08001850 /* If we're told to keep the target fully allocated (-S 0) or there
1851 * is real non-zero data, we must write it. Otherwise we can treat
1852 * it as zero sectors.
1853 * Compressed clusters need to be written as a whole, so in that
1854 * case we can only save the write if the buffer is completely
1855 * zeroed. */
Kevin Wolf690c7302015-03-19 13:33:32 +01001856 if (!s->min_sparse ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001857 (!s->compressed &&
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001858 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1859 sector_num, s->alignment)) ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001860 (s->compressed &&
1861 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
Kevin Wolf690c7302015-03-19 13:33:32 +01001862 {
Vladimir Sementsov-Ogievskiy265a7e52019-04-22 17:58:38 +03001863 ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1864 n << BDRV_SECTOR_BITS, buf, flags);
Kevin Wolf690c7302015-03-19 13:33:32 +01001865 if (ret < 0) {
1866 return ret;
1867 }
1868 break;
1869 }
1870 /* fall-through */
1871
1872 case BLK_ZERO:
1873 if (s->has_zero_init) {
Lidong Chendb933fb2017-04-27 10:58:27 +08001874 assert(!s->target_has_backing);
Kevin Wolf690c7302015-03-19 13:33:32 +01001875 break;
1876 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01001877 ret = blk_co_pwrite_zeroes(s->target,
1878 sector_num << BDRV_SECTOR_BITS,
Nir Soffera3d6ae22019-03-24 02:20:12 +02001879 n << BDRV_SECTOR_BITS,
1880 BDRV_REQ_MAY_UNMAP);
Kevin Wolf690c7302015-03-19 13:33:32 +01001881 if (ret < 0) {
1882 return ret;
1883 }
1884 break;
1885 }
1886
1887 sector_num += n;
1888 nb_sectors -= n;
1889 buf += n * BDRV_SECTOR_SIZE;
1890 }
1891
1892 return 0;
1893}
1894
Fam Zhengee5306d2018-06-01 17:26:48 +08001895static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1896 int nb_sectors)
1897{
1898 int n, ret;
1899
1900 while (nb_sectors > 0) {
1901 BlockBackend *blk;
1902 int src_cur;
1903 int64_t bs_sectors, src_cur_offset;
1904 int64_t offset;
1905
1906 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1907 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1908 blk = s->src[src_cur];
1909 bs_sectors = s->src_sectors[src_cur];
1910
1911 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1912
1913 ret = blk_co_copy_range(blk, offset, s->target,
1914 sector_num << BDRV_SECTOR_BITS,
Vladimir Sementsov-Ogievskiy67b51fb2018-07-09 19:37:17 +03001915 n << BDRV_SECTOR_BITS, 0, 0);
Fam Zhengee5306d2018-06-01 17:26:48 +08001916 if (ret < 0) {
1917 return ret;
1918 }
1919
1920 sector_num += n;
1921 nb_sectors -= n;
1922 }
1923 return 0;
1924}
1925
Peter Lieven2d9187b2017-02-28 13:40:07 +01001926static void coroutine_fn convert_co_do_copy(void *opaque)
1927{
1928 ImgConvertState *s = opaque;
1929 uint8_t *buf = NULL;
1930 int ret, i;
1931 int index = -1;
1932
1933 for (i = 0; i < s->num_coroutines; i++) {
1934 if (s->co[i] == qemu_coroutine_self()) {
1935 index = i;
1936 break;
1937 }
1938 }
1939 assert(index >= 0);
1940
1941 s->running_coroutines++;
1942 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1943
1944 while (1) {
1945 int n;
1946 int64_t sector_num;
1947 enum ImgConvertBlockStatus status;
Fam Zhengee5306d2018-06-01 17:26:48 +08001948 bool copy_range;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001949
1950 qemu_co_mutex_lock(&s->lock);
1951 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1952 qemu_co_mutex_unlock(&s->lock);
Anton Nefedovb91127e2017-04-26 11:33:15 +03001953 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001954 }
1955 n = convert_iteration_sectors(s, s->sector_num);
1956 if (n < 0) {
1957 qemu_co_mutex_unlock(&s->lock);
1958 s->ret = n;
Anton Nefedovb91127e2017-04-26 11:33:15 +03001959 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001960 }
1961 /* save current sector and allocation status to local variables */
1962 sector_num = s->sector_num;
1963 status = s->status;
1964 if (!s->min_sparse && s->status == BLK_ZERO) {
1965 n = MIN(n, s->buf_sectors);
1966 }
1967 /* increment global sector counter so that other coroutines can
1968 * already continue reading beyond this request */
1969 s->sector_num += n;
1970 qemu_co_mutex_unlock(&s->lock);
1971
1972 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
1973 s->allocated_done += n;
1974 qemu_progress_print(100.0 * s->allocated_done /
1975 s->allocated_sectors, 0);
1976 }
1977
Fam Zhengee5306d2018-06-01 17:26:48 +08001978retry:
1979 copy_range = s->copy_range && s->status == BLK_DATA;
1980 if (status == BLK_DATA && !copy_range) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01001981 ret = convert_co_read(s, sector_num, n, buf);
1982 if (ret < 0) {
Eric Blake39f77cb2020-04-02 08:57:17 -05001983 error_report("error while reading at byte %lld: %s",
1984 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
Peter Lieven2d9187b2017-02-28 13:40:07 +01001985 s->ret = ret;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001986 }
1987 } else if (!s->min_sparse && status == BLK_ZERO) {
1988 status = BLK_DATA;
1989 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
1990 }
1991
1992 if (s->wr_in_order) {
1993 /* keep writes in order */
Anton Nefedovb91127e2017-04-26 11:33:15 +03001994 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01001995 s->wait_sector_num[index] = sector_num;
1996 qemu_coroutine_yield();
1997 }
1998 s->wait_sector_num[index] = -1;
1999 }
2000
Anton Nefedovb91127e2017-04-26 11:33:15 +03002001 if (s->ret == -EINPROGRESS) {
Fam Zhengee5306d2018-06-01 17:26:48 +08002002 if (copy_range) {
2003 ret = convert_co_copy_range(s, sector_num, n);
2004 if (ret) {
2005 s->copy_range = false;
2006 goto retry;
2007 }
2008 } else {
2009 ret = convert_co_write(s, sector_num, n, buf, status);
2010 }
Anton Nefedovb91127e2017-04-26 11:33:15 +03002011 if (ret < 0) {
Eric Blake39f77cb2020-04-02 08:57:17 -05002012 error_report("error while writing at byte %lld: %s",
2013 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
Anton Nefedovb91127e2017-04-26 11:33:15 +03002014 s->ret = ret;
2015 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01002016 }
2017
2018 if (s->wr_in_order) {
2019 /* reenter the coroutine that might have waited
2020 * for this write to complete */
2021 s->wr_offs = sector_num + n;
2022 for (i = 0; i < s->num_coroutines; i++) {
2023 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
2024 /*
2025 * A -> B -> A cannot occur because A has
2026 * s->wait_sector_num[i] == -1 during A -> B. Therefore
2027 * B will never enter A during this time window.
2028 */
2029 qemu_coroutine_enter(s->co[i]);
2030 break;
2031 }
2032 }
2033 }
2034 }
2035
Peter Lieven2d9187b2017-02-28 13:40:07 +01002036 qemu_vfree(buf);
2037 s->co[index] = NULL;
2038 s->running_coroutines--;
2039 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
2040 /* the convert job finished successfully */
2041 s->ret = 0;
2042 }
2043}
2044
Kevin Wolf690c7302015-03-19 13:33:32 +01002045static int convert_do_copy(ImgConvertState *s)
2046{
Peter Lieven2d9187b2017-02-28 13:40:07 +01002047 int ret, i, n;
2048 int64_t sector_num = 0;
Kevin Wolf690c7302015-03-19 13:33:32 +01002049
2050 /* Check whether we have zero initialisation or can get it efficiently */
David Edmondson168468f2020-02-05 11:02:48 +00002051 if (!s->has_zero_init && s->target_is_new && s->min_sparse &&
2052 !s->target_has_backing) {
Max Reitz4d7c4872019-07-24 19:12:29 +02002053 s->has_zero_init = bdrv_has_zero_init(blk_bs(s->target));
Max Reitz4d7c4872019-07-24 19:12:29 +02002054 }
Kevin Wolf690c7302015-03-19 13:33:32 +01002055
Kevin Wolf690c7302015-03-19 13:33:32 +01002056 /* Allocate buffer for copied data. For compressed images, only one cluster
2057 * can be copied at a time. */
2058 if (s->compressed) {
2059 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
2060 error_report("invalid cluster size");
Peter Lieven2d9187b2017-02-28 13:40:07 +01002061 return -EINVAL;
Kevin Wolf690c7302015-03-19 13:33:32 +01002062 }
2063 s->buf_sectors = s->cluster_sectors;
2064 }
Kevin Wolf690c7302015-03-19 13:33:32 +01002065
Kevin Wolf690c7302015-03-19 13:33:32 +01002066 while (sector_num < s->total_sectors) {
2067 n = convert_iteration_sectors(s, sector_num);
2068 if (n < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002069 return n;
Kevin Wolf690c7302015-03-19 13:33:32 +01002070 }
Max Reitzaad15de2016-03-24 23:33:57 +01002071 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
2072 {
Kevin Wolf690c7302015-03-19 13:33:32 +01002073 s->allocated_sectors += n;
2074 }
2075 sector_num += n;
2076 }
2077
2078 /* Do the copy */
Kevin Wolf690c7302015-03-19 13:33:32 +01002079 s->sector_next_status = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002080 s->ret = -EINPROGRESS;
Kevin Wolf690c7302015-03-19 13:33:32 +01002081
Peter Lieven2d9187b2017-02-28 13:40:07 +01002082 qemu_co_mutex_init(&s->lock);
2083 for (i = 0; i < s->num_coroutines; i++) {
2084 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
2085 s->wait_sector_num[i] = -1;
2086 qemu_coroutine_enter(s->co[i]);
Kevin Wolf690c7302015-03-19 13:33:32 +01002087 }
2088
Anton Nefedovb91127e2017-04-26 11:33:15 +03002089 while (s->running_coroutines) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002090 main_loop_wait(false);
2091 }
2092
2093 if (s->compressed && !s->ret) {
Kevin Wolf690c7302015-03-19 13:33:32 +01002094 /* signal EOF to align */
Pavel Butsykinfe5c1352016-07-22 11:17:40 +03002095 ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01002096 if (ret < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002097 return ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002098 }
2099 }
2100
Peter Lieven2d9187b2017-02-28 13:40:07 +01002101 return s->ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002102}
2103
Eric Blake15e39ad2020-05-21 14:21:36 -05002104static int convert_copy_bitmaps(BlockDriverState *src, BlockDriverState *dst)
2105{
2106 BdrvDirtyBitmap *bm;
2107 Error *err = NULL;
2108
2109 FOR_EACH_DIRTY_BITMAP(src, bm) {
2110 const char *name;
2111
2112 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2113 continue;
2114 }
2115 name = bdrv_dirty_bitmap_name(bm);
2116 qmp_block_dirty_bitmap_add(dst->node_name, name,
2117 true, bdrv_dirty_bitmap_granularity(bm),
2118 true, true,
2119 true, !bdrv_dirty_bitmap_enabled(bm),
2120 &err);
2121 if (err) {
2122 error_reportf_err(err, "Failed to create bitmap %s: ", name);
2123 return -1;
2124 }
2125
2126 do_dirty_bitmap_merge(dst->node_name, name, src->node_name, name,
2127 &err);
2128 if (err) {
2129 error_reportf_err(err, "Failed to populate bitmap %s: ", name);
2130 return -1;
2131 }
2132 }
2133
2134 return 0;
2135}
2136
Peter Lieven6360ab22018-07-13 09:15:39 +02002137#define MAX_BUF_SECTORS 32768
2138
Zhengui0c8c4892020-10-20 14:47:44 +00002139static void set_rate_limit(BlockBackend *blk, int64_t rate_limit)
2140{
2141 ThrottleConfig cfg;
2142
2143 throttle_config_init(&cfg);
2144 cfg.buckets[THROTTLE_BPS_WRITE].avg = rate_limit;
2145
2146 blk_io_limits_enable(blk, CONVERT_THROTTLE_GROUP);
2147 blk_set_io_limits(blk, &cfg);
2148}
2149
bellardea2384d2004-08-01 21:59:26 +00002150static int img_convert(int argc, char **argv)
2151{
Kevin Wolf0b8fb552021-04-22 18:43:44 +02002152 int c, bs_i, flags, src_flags = BDRV_O_NO_SHARE;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002153 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002154 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
2155 *out_filename, *out_baseimg_param, *snapshot_name = NULL;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002156 BlockDriver *drv = NULL, *proto_drv = NULL;
bellardfaea38e2006-08-05 21:31:00 +00002157 BlockDriverInfo bdi;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002158 BlockDriverState *out_bs;
2159 QemuOpts *opts = NULL, *sn_opts = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08002160 QemuOptsList *create_opts = NULL;
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002161 QDict *open_opts = NULL;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002162 char *options = NULL;
Max Reitzcc84d902013-09-06 17:14:26 +02002163 Error *local_err = NULL;
Max Reitz3d96cb92019-05-07 22:35:02 +02002164 bool writethrough, src_writethrough, image_opts = false,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002165 skip_create = false, progress = false, tgt_image_opts = false;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002166 int64_t ret = -EINVAL;
Fam Zheng335e9932017-05-03 00:35:39 +08002167 bool force_share = false;
Fam Zhenge11ce122018-07-27 11:34:01 +08002168 bool explict_min_sparse = false;
Eric Blake15e39ad2020-05-21 14:21:36 -05002169 bool bitmaps = false;
Zhengui0c8c4892020-10-20 14:47:44 +00002170 int64_t rate_limit = 0;
bellardea2384d2004-08-01 21:59:26 +00002171
Peter Lieven9fd77f92017-04-21 11:11:55 +02002172 ImgConvertState s = (ImgConvertState) {
2173 /* Need at least 4k of zeros for sparse detection */
2174 .min_sparse = 8,
Fam Zhenge11ce122018-07-27 11:34:01 +08002175 .copy_range = false,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002176 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2177 .wr_in_order = true,
2178 .num_coroutines = 8,
2179 };
2180
bellardea2384d2004-08-01 21:59:26 +00002181 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002182 static const struct option long_options[] = {
2183 {"help", no_argument, 0, 'h'},
2184 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002185 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002186 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002187 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
Max Reitz8eaac022019-05-07 22:35:03 +02002188 {"salvage", no_argument, 0, OPTION_SALVAGE},
David Edmondson168468f2020-02-05 11:02:48 +00002189 {"target-is-zero", no_argument, 0, OPTION_TARGET_IS_ZERO},
Eric Blake15e39ad2020-05-21 14:21:36 -05002190 {"bitmaps", no_argument, 0, OPTION_BITMAPS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002191 {0, 0, 0, 0}
2192 };
Zhengui0c8c4892020-10-20 14:47:44 +00002193 c = getopt_long(argc, argv, ":hf:O:B:Cco:l:S:pt:T:qnm:WUr:",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002194 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002195 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002196 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002197 }
bellardea2384d2004-08-01 21:59:26 +00002198 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002199 case ':':
2200 missing_argument(argv[optind - 1]);
2201 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002202 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002203 unrecognized_option(argv[optind - 1]);
2204 break;
bellardea2384d2004-08-01 21:59:26 +00002205 case 'h':
2206 help();
2207 break;
2208 case 'f':
2209 fmt = optarg;
2210 break;
2211 case 'O':
2212 out_fmt = optarg;
2213 break;
thsf58c7b32008-06-05 21:53:49 +00002214 case 'B':
2215 out_baseimg = optarg;
2216 break;
Fam Zhenge11ce122018-07-27 11:34:01 +08002217 case 'C':
2218 s.copy_range = true;
2219 break;
bellardea2384d2004-08-01 21:59:26 +00002220 case 'c':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002221 s.compressed = true;
bellardea2384d2004-08-01 21:59:26 +00002222 break;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002223 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02002224 if (accumulate_options(&options, optarg) < 0) {
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002225 goto fail_getopt;
Kevin Wolf2dc83282014-02-21 16:24:05 +01002226 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002227 break;
Wenchao Xiaef806542013-12-04 17:10:57 +08002228 case 'l':
2229 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
Markus Armbruster70b94332015-02-13 12:50:26 +01002230 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2231 optarg, false);
Wenchao Xiaef806542013-12-04 17:10:57 +08002232 if (!sn_opts) {
2233 error_report("Failed in parsing snapshot param '%s'",
2234 optarg);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002235 goto fail_getopt;
Wenchao Xiaef806542013-12-04 17:10:57 +08002236 }
2237 } else {
2238 snapshot_name = optarg;
2239 }
2240 break;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002241 case 'S':
2242 {
2243 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +01002244
Eyal Moscovici43d589b2020-05-13 16:36:26 +03002245 sval = cvtnum("buffer size for sparse output", optarg);
2246 if (sval < 0) {
2247 goto fail_getopt;
2248 } else if (!QEMU_IS_ALIGNED(sval, BDRV_SECTOR_SIZE) ||
Peter Lieven6360ab22018-07-13 09:15:39 +02002249 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2250 error_report("Invalid buffer size for sparse output specified. "
2251 "Valid sizes are multiples of %llu up to %llu. Select "
2252 "0 to disable sparse detection (fully allocates output).",
2253 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002254 goto fail_getopt;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002255 }
2256
Peter Lieven9fd77f92017-04-21 11:11:55 +02002257 s.min_sparse = sval / BDRV_SECTOR_SIZE;
Fam Zhenge11ce122018-07-27 11:34:01 +08002258 explict_min_sparse = true;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002259 break;
2260 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002261 case 'p':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002262 progress = true;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002263 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002264 case 't':
2265 cache = optarg;
2266 break;
Max Reitz40055952014-07-22 22:58:42 +02002267 case 'T':
2268 src_cache = optarg;
2269 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002270 case 'q':
Max Reitz3d96cb92019-05-07 22:35:02 +02002271 s.quiet = true;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002272 break;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002273 case 'n':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002274 skip_create = true;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002275 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002276 case 'm':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002277 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2278 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002279 error_report("Invalid number of coroutines. Allowed number of"
2280 " coroutines is between 1 and %d", MAX_COROUTINES);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002281 goto fail_getopt;
2282 }
2283 break;
2284 case 'W':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002285 s.wr_in_order = false;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002286 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002287 case 'U':
2288 force_share = true;
2289 break;
Zhengui0c8c4892020-10-20 14:47:44 +00002290 case 'r':
2291 rate_limit = cvtnum("rate limit", optarg);
2292 if (rate_limit < 0) {
2293 goto fail_getopt;
2294 }
2295 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01002296 case OPTION_OBJECT:
2297 user_creatable_process_cmdline(optarg);
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002298 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002299 case OPTION_IMAGE_OPTS:
2300 image_opts = true;
2301 break;
Max Reitz8eaac022019-05-07 22:35:03 +02002302 case OPTION_SALVAGE:
2303 s.salvage = true;
2304 break;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002305 case OPTION_TARGET_IMAGE_OPTS:
2306 tgt_image_opts = true;
2307 break;
David Edmondson168468f2020-02-05 11:02:48 +00002308 case OPTION_TARGET_IS_ZERO:
2309 /*
2310 * The user asserting that the target is blank has the
2311 * same effect as the target driver supporting zero
2312 * initialisation.
2313 */
2314 s.has_zero_init = true;
2315 break;
Eric Blake15e39ad2020-05-21 14:21:36 -05002316 case OPTION_BITMAPS:
2317 bitmaps = true;
2318 break;
bellardea2384d2004-08-01 21:59:26 +00002319 }
2320 }
ths3b46e622007-09-17 08:09:54 +00002321
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002322 if (!out_fmt && !tgt_image_opts) {
2323 out_fmt = "raw";
2324 }
2325
Fam Zhenge11ce122018-07-27 11:34:01 +08002326 if (s.compressed && s.copy_range) {
2327 error_report("Cannot enable copy offloading when -c is used");
2328 goto fail_getopt;
2329 }
2330
2331 if (explict_min_sparse && s.copy_range) {
2332 error_report("Cannot enable copy offloading when -S is used");
2333 goto fail_getopt;
2334 }
2335
Max Reitz8eaac022019-05-07 22:35:03 +02002336 if (s.copy_range && s.salvage) {
2337 error_report("Cannot use copy offloading in salvaging mode");
2338 goto fail_getopt;
2339 }
2340
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002341 if (tgt_image_opts && !skip_create) {
2342 error_report("--target-image-opts requires use of -n flag");
2343 goto fail_getopt;
2344 }
2345
Kevin Wolfffd8e8f2019-08-09 11:09:21 +02002346 if (skip_create && options) {
Eric Blake25956af2020-07-06 15:39:46 -05002347 error_report("-o has no effect when skipping image creation");
2348 goto fail_getopt;
Kevin Wolfffd8e8f2019-08-09 11:09:21 +02002349 }
2350
David Edmondson168468f2020-02-05 11:02:48 +00002351 if (s.has_zero_init && !skip_create) {
2352 error_report("--target-is-zero requires use of -n flag");
2353 goto fail_getopt;
2354 }
2355
Peter Lieven9fd77f92017-04-21 11:11:55 +02002356 s.src_num = argc - optind - 1;
2357 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2358
2359 if (options && has_help_option(options)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002360 if (out_fmt) {
2361 ret = print_block_option_help(out_filename, out_fmt);
2362 goto fail_getopt;
2363 } else {
2364 error_report("Option help requires a format be specified");
2365 goto fail_getopt;
2366 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002367 }
2368
2369 if (s.src_num < 1) {
2370 error_report("Must specify image file name");
2371 goto fail_getopt;
2372 }
2373
Peter Lieven9fd77f92017-04-21 11:11:55 +02002374 /* ret is still -EINVAL until here */
2375 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2376 if (ret < 0) {
2377 error_report("Invalid source cache option: %s", src_cache);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002378 goto fail_getopt;
2379 }
2380
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002381 /* Initialize before goto out */
Max Reitz3d96cb92019-05-07 22:35:02 +02002382 if (s.quiet) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002383 progress = false;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002384 }
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002385 qemu_progress_init(progress, 1.0);
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002386 qemu_progress_print(0, 100);
2387
Peter Lieven9fd77f92017-04-21 11:11:55 +02002388 s.src = g_new0(BlockBackend *, s.src_num);
2389 s.src_sectors = g_new(int64_t, s.src_num);
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002390 s.src_alignment = g_new(int, s.src_num);
balrog926c2d22007-10-31 01:11:44 +00002391
Peter Lieven9fd77f92017-04-21 11:11:55 +02002392 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002393 BlockDriverState *src_bs;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002394 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
Max Reitz3d96cb92019-05-07 22:35:02 +02002395 fmt, src_flags, src_writethrough, s.quiet,
Fam Zheng335e9932017-05-03 00:35:39 +08002396 force_share);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002397 if (!s.src[bs_i]) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002398 ret = -1;
2399 goto out;
2400 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002401 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2402 if (s.src_sectors[bs_i] < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002403 error_report("Could not get size of %s: %s",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002404 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002405 ret = -1;
2406 goto out;
2407 }
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002408 src_bs = blk_bs(s.src[bs_i]);
2409 s.src_alignment[bs_i] = DIV_ROUND_UP(src_bs->bl.request_alignment,
2410 BDRV_SECTOR_SIZE);
2411 if (!bdrv_get_info(src_bs, &bdi)) {
2412 s.src_alignment[bs_i] = MAX(s.src_alignment[bs_i],
2413 bdi.cluster_size / BDRV_SECTOR_SIZE);
2414 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002415 s.total_sectors += s.src_sectors[bs_i];
balrog926c2d22007-10-31 01:11:44 +00002416 }
bellardea2384d2004-08-01 21:59:26 +00002417
Wenchao Xiaef806542013-12-04 17:10:57 +08002418 if (sn_opts) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002419 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
Peter Maydell10d6eda2017-02-10 16:28:24 +00002420 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2421 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2422 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002423 } else if (snapshot_name != NULL) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002424 if (s.src_num > 1) {
Markus Armbruster6daf1942011-06-22 14:03:54 +02002425 error_report("No support for concatenating multiple snapshot");
edison51ef6722010-09-21 19:58:41 -07002426 ret = -1;
2427 goto out;
2428 }
Wenchao Xia7b4c4782013-12-04 17:10:54 +08002429
Peter Lieven9fd77f92017-04-21 11:11:55 +02002430 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2431 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002432 }
Markus Armbruster84d18f02014-01-30 15:07:28 +01002433 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002434 error_reportf_err(local_err, "Failed to load snapshot: ");
Wenchao Xiaef806542013-12-04 17:10:57 +08002435 ret = -1;
2436 goto out;
edison51ef6722010-09-21 19:58:41 -07002437 }
2438
Max Reitz2e024cd2015-02-11 09:58:46 -05002439 if (!skip_create) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002440 /* Find driver and parse its options */
2441 drv = bdrv_find_format(out_fmt);
2442 if (!drv) {
2443 error_report("Unknown file format '%s'", out_fmt);
2444 ret = -1;
2445 goto out;
2446 }
2447
2448 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2449 if (!proto_drv) {
2450 error_report_err(local_err);
2451 ret = -1;
2452 goto out;
2453 }
2454
Max Reitz2e024cd2015-02-11 09:58:46 -05002455 if (!drv->create_opts) {
2456 error_report("Format driver '%s' does not support image creation",
2457 drv->format_name);
2458 ret = -1;
2459 goto out;
2460 }
Max Reitzf75613c2014-12-02 18:32:46 +01002461
Max Reitz2e024cd2015-02-11 09:58:46 -05002462 if (!proto_drv->create_opts) {
2463 error_report("Protocol driver '%s' does not support image creation",
2464 proto_drv->format_name);
2465 ret = -1;
2466 goto out;
2467 }
Max Reitzf75613c2014-12-02 18:32:46 +01002468
Max Reitz2e024cd2015-02-11 09:58:46 -05002469 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2470 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfdb08adf2009-06-04 15:39:38 +02002471
Max Reitz2e024cd2015-02-11 09:58:46 -05002472 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002473 if (options) {
Markus Armbruster235e59c2020-07-07 18:05:42 +02002474 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
Markus Armbruster97a2ca72015-03-14 10:23:15 +01002475 error_report_err(local_err);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002476 ret = -1;
2477 goto out;
2478 }
Max Reitz2e024cd2015-02-11 09:58:46 -05002479 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002480
Yi Lic075c422020-08-19 09:36:07 +08002481 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
2482 s.total_sectors * BDRV_SECTOR_SIZE, &error_abort);
Max Reitz2e024cd2015-02-11 09:58:46 -05002483 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2484 if (ret < 0) {
2485 goto out;
2486 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002487 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002488
Kevin Wolfa18953f2010-10-14 15:46:04 +02002489 /* Get backing file name if -o backing_file was used */
Chunyan Liu83d05212014-06-05 17:20:51 +08002490 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
Kevin Wolfa18953f2010-10-14 15:46:04 +02002491 if (out_baseimg_param) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002492 out_baseimg = out_baseimg_param;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002493 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002494 s.target_has_backing = (bool) out_baseimg;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002495
David Edmondson168468f2020-02-05 11:02:48 +00002496 if (s.has_zero_init && s.target_has_backing) {
2497 error_report("Cannot use --target-is-zero when the destination "
2498 "image has a backing file");
2499 goto out;
2500 }
2501
Max Reitz48758a82017-04-26 15:46:48 +02002502 if (s.src_num > 1 && out_baseimg) {
2503 error_report("Having a backing file for the target makes no sense when "
2504 "concatenating multiple input images");
2505 ret = -1;
2506 goto out;
2507 }
2508
Eric Blaked9f059a2020-07-06 15:39:54 -05002509 if (out_baseimg_param) {
2510 if (!qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT)) {
Eric Blake497a30d2021-05-03 14:36:00 -07002511 error_report("Use of backing file requires explicit "
2512 "backing format");
2513 ret = -1;
2514 goto out;
Eric Blaked9f059a2020-07-06 15:39:54 -05002515 }
2516 }
2517
Kevin Wolfefa84d42009-05-18 16:42:12 +02002518 /* Check if compression is supported */
Peter Lieven9fd77f92017-04-21 11:11:55 +02002519 if (s.compressed) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002520 bool encryption =
2521 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002522 const char *encryptfmt =
2523 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
Chunyan Liu83d05212014-06-05 17:20:51 +08002524 const char *preallocation =
2525 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
Kevin Wolfefa84d42009-05-18 16:42:12 +02002526
Vladimir Sementsov-Ogievskiyac850bf2019-06-04 19:15:06 +03002527 if (drv && !block_driver_can_compress(drv)) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002528 error_report("Compression not supported for this file format");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002529 ret = -1;
2530 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002531 }
2532
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002533 if (encryption || encryptfmt) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002534 error_report("Compression and encryption not supported at "
2535 "the same time");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002536 ret = -1;
2537 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002538 }
Kevin Wolf41521fa2011-10-18 16:19:42 +02002539
Chunyan Liu83d05212014-06-05 17:20:51 +08002540 if (preallocation
2541 && strcmp(preallocation, "off"))
Kevin Wolf41521fa2011-10-18 16:19:42 +02002542 {
2543 error_report("Compression and preallocation not supported at "
2544 "the same time");
2545 ret = -1;
2546 goto out;
2547 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002548 }
2549
Eric Blake15e39ad2020-05-21 14:21:36 -05002550 /* Determine if bitmaps need copying */
2551 if (bitmaps) {
2552 if (s.src_num > 1) {
2553 error_report("Copying bitmaps only possible with single source");
2554 ret = -1;
2555 goto out;
2556 }
2557 if (!bdrv_supports_persistent_dirty_bitmap(blk_bs(s.src[0]))) {
2558 error_report("Source lacks bitmap support");
2559 ret = -1;
2560 goto out;
2561 }
2562 }
2563
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002564 /*
2565 * The later open call will need any decryption secrets, and
2566 * bdrv_create() will purge "opts", so extract them now before
2567 * they are lost.
2568 */
2569 if (!skip_create) {
2570 open_opts = qdict_new();
2571 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002572
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002573 /* Create the new image */
Chunyan Liuc282e1f2014-06-05 17:21:11 +08002574 ret = bdrv_create(drv, out_filename, opts, &local_err);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002575 if (ret < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002576 error_reportf_err(local_err, "%s: error while converting %s: ",
2577 out_filename, out_fmt);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002578 goto out;
bellardea2384d2004-08-01 21:59:26 +00002579 }
2580 }
ths3b46e622007-09-17 08:09:54 +00002581
Max Reitz4d7c4872019-07-24 19:12:29 +02002582 s.target_is_new = !skip_create;
2583
Peter Lieven9fd77f92017-04-21 11:11:55 +02002584 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
Kevin Wolfce099542016-03-15 13:01:04 +01002585 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002586 if (ret < 0) {
2587 error_report("Invalid cache option: %s", cache);
Markus Armbrusterbb9cd2e2014-05-28 11:17:07 +02002588 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002589 }
2590
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002591 if (skip_create) {
2592 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002593 flags, writethrough, s.quiet, false);
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002594 } else {
2595 /* TODO ultimately we should allow --target-image-opts
2596 * to be used even when -n is not given.
2597 * That has to wait for bdrv_create to be improved
2598 * to allow filenames in option syntax
2599 */
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002600 s.target = img_open_file(out_filename, open_opts, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002601 flags, writethrough, s.quiet, false);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002602 open_opts = NULL; /* blk_new_open will have freed it */
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002603 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002604 if (!s.target) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002605 ret = -1;
2606 goto out;
2607 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002608 out_bs = blk_bs(s.target);
bellardea2384d2004-08-01 21:59:26 +00002609
Eric Blake15e39ad2020-05-21 14:21:36 -05002610 if (bitmaps && !bdrv_supports_persistent_dirty_bitmap(out_bs)) {
2611 error_report("Format driver '%s' does not support bitmaps",
2612 out_bs->drv->format_name);
2613 ret = -1;
2614 goto out;
2615 }
2616
Vladimir Sementsov-Ogievskiyac850bf2019-06-04 19:15:06 +03002617 if (s.compressed && !block_driver_can_compress(out_bs->drv)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002618 error_report("Compression not supported for this file format");
2619 ret = -1;
2620 goto out;
2621 }
2622
Eric Blake5def6b82016-06-23 16:37:19 -06002623 /* increase bufsectors from the default 4096 (2M) if opt_transfer
Peter Lieven6360ab22018-07-13 09:15:39 +02002624 * or discard_alignment of the out_bs is greater. Limit to
2625 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2626 s.buf_sectors = MIN(MAX_BUF_SECTORS,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002627 MAX(s.buf_sectors,
2628 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2629 out_bs->bl.pdiscard_alignment >>
2630 BDRV_SECTOR_BITS)));
Peter Lievenf2521c92013-11-27 11:07:06 +01002631
Peter Lieven8dcd3c92018-07-12 15:00:10 +02002632 /* try to align the write requests to the destination to avoid unnecessary
2633 * RMW cycles. */
2634 s.alignment = MAX(pow2floor(s.min_sparse),
2635 DIV_ROUND_UP(out_bs->bl.request_alignment,
2636 BDRV_SECTOR_SIZE));
2637 assert(is_power_of_2(s.alignment));
2638
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002639 if (skip_create) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002640 int64_t output_sectors = blk_nb_sectors(s.target);
Markus Armbruster43716fa2014-06-26 13:23:21 +02002641 if (output_sectors < 0) {
Gongleieec5eb42015-02-25 12:22:27 +08002642 error_report("unable to get output image length: %s",
Markus Armbruster43716fa2014-06-26 13:23:21 +02002643 strerror(-output_sectors));
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002644 ret = -1;
2645 goto out;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002646 } else if (output_sectors < s.total_sectors) {
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002647 error_report("output file is smaller than input file");
2648 ret = -1;
2649 goto out;
2650 }
2651 }
2652
Max Reitzc69291e2020-01-21 16:59:14 +01002653 if (s.target_has_backing && s.target_is_new) {
Max Reitz351c8ef2018-05-01 18:57:49 +02002654 /* Errors are treated as "backing length unknown" (which means
2655 * s.target_backing_sectors has to be negative, which it will
2656 * be automatically). The backing file length is used only
2657 * for optimizations, so such a case is not fatal. */
Max Reitz4a2061e2019-06-12 19:00:30 +02002658 s.target_backing_sectors =
2659 bdrv_nb_sectors(bdrv_backing_chain_next(out_bs));
Max Reitz351c8ef2018-05-01 18:57:49 +02002660 } else {
2661 s.target_backing_sectors = -1;
2662 }
2663
Peter Lieven24f833c2013-11-27 11:07:07 +01002664 ret = bdrv_get_info(out_bs, &bdi);
2665 if (ret < 0) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002666 if (s.compressed) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002667 error_report("could not get block driver info");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002668 goto out;
2669 }
Peter Lieven24f833c2013-11-27 11:07:07 +01002670 } else {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002671 s.compressed = s.compressed || bdi.needs_compressed_writes;
2672 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
Peter Lieven24f833c2013-11-27 11:07:07 +01002673 }
2674
Zhengui0c8c4892020-10-20 14:47:44 +00002675 if (rate_limit) {
2676 set_rate_limit(s.target, rate_limit);
2677 }
2678
Peter Lieven9fd77f92017-04-21 11:11:55 +02002679 ret = convert_do_copy(&s);
Eric Blake15e39ad2020-05-21 14:21:36 -05002680
2681 /* Now copy the bitmaps */
2682 if (bitmaps && ret == 0) {
2683 ret = convert_copy_bitmaps(blk_bs(s.src[0]), out_bs);
2684 }
2685
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002686out:
Peter Lieven13c28af2013-11-27 11:07:01 +01002687 if (!ret) {
2688 qemu_progress_print(100, 0);
2689 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002690 qemu_progress_end();
Chunyan Liu83d05212014-06-05 17:20:51 +08002691 qemu_opts_del(opts);
2692 qemu_opts_free(create_opts);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002693 qobject_unref(open_opts);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002694 blk_unref(s.target);
2695 if (s.src) {
2696 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2697 blk_unref(s.src[bs_i]);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002698 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002699 g_free(s.src);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002700 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002701 g_free(s.src_sectors);
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002702 g_free(s.src_alignment);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002703fail_getopt:
Tuguoyi6aec8302020-11-02 09:04:57 +00002704 qemu_opts_del(sn_opts);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002705 g_free(options);
2706
Peter Lieven9fd77f92017-04-21 11:11:55 +02002707 return !!ret;
bellardea2384d2004-08-01 21:59:26 +00002708}
2709
bellard57d1a2b2004-08-03 21:15:11 +00002710
bellardfaea38e2006-08-05 21:31:00 +00002711static void dump_snapshots(BlockDriverState *bs)
2712{
2713 QEMUSnapshotInfo *sn_tab, *sn;
2714 int nb_sns, i;
bellardfaea38e2006-08-05 21:31:00 +00002715
2716 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2717 if (nb_sns <= 0)
2718 return;
2719 printf("Snapshot list:\n");
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002720 bdrv_snapshot_dump(NULL);
Wenchao Xia5b917042013-05-25 11:09:45 +08002721 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002722 for(i = 0; i < nb_sns; i++) {
2723 sn = &sn_tab[i];
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002724 bdrv_snapshot_dump(sn);
Wenchao Xia5b917042013-05-25 11:09:45 +08002725 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002726 }
Anthony Liguori7267c092011-08-20 22:09:37 -05002727 g_free(sn_tab);
bellardfaea38e2006-08-05 21:31:00 +00002728}
2729
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002730static void dump_json_image_info_list(ImageInfoList *list)
2731{
Markus Armbrustereab3a462020-12-11 18:11:37 +01002732 GString *str;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002733 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002734 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002735
2736 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2737 visit_complete(v, &obj);
Markus Armbruster6589f452020-12-11 18:11:35 +01002738 str = qobject_to_json_pretty(obj, true);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002739 assert(str != NULL);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002740 printf("%s\n", str->str);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002741 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002742 visit_free(v);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002743 g_string_free(str, true);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002744}
2745
Benoît Canetc054b3f2012-09-05 13:09:02 +02002746static void dump_json_image_info(ImageInfo *info)
2747{
Markus Armbrustereab3a462020-12-11 18:11:37 +01002748 GString *str;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002749 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002750 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002751
2752 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2753 visit_complete(v, &obj);
Markus Armbruster6589f452020-12-11 18:11:35 +01002754 str = qobject_to_json_pretty(obj, true);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002755 assert(str != NULL);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002756 printf("%s\n", str->str);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002757 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002758 visit_free(v);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002759 g_string_free(str, true);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002760}
2761
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002762static void dump_human_image_info_list(ImageInfoList *list)
2763{
2764 ImageInfoList *elem;
2765 bool delim = false;
2766
2767 for (elem = list; elem; elem = elem->next) {
2768 if (delim) {
2769 printf("\n");
2770 }
2771 delim = true;
2772
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002773 bdrv_image_info_dump(elem->value);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002774 }
2775}
2776
2777static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2778{
2779 return strcmp(a, b) == 0;
2780}
2781
2782/**
2783 * Open an image file chain and return an ImageInfoList
2784 *
2785 * @filename: topmost image filename
2786 * @fmt: topmost image format (may be NULL to autodetect)
2787 * @chain: true - enumerate entire backing file chain
2788 * false - only topmost image file
2789 *
2790 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2791 * image file. If there was an error a message will have been printed to
2792 * stderr.
2793 */
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002794static ImageInfoList *collect_image_info_list(bool image_opts,
2795 const char *filename,
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002796 const char *fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002797 bool chain, bool force_share)
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002798{
2799 ImageInfoList *head = NULL;
Eric Blakec3033fd2021-01-13 16:10:12 -06002800 ImageInfoList **tail = &head;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002801 GHashTable *filenames;
Wenchao Xia43526ec2013-06-06 12:27:58 +08002802 Error *err = NULL;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002803
2804 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2805
2806 while (filename) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02002807 BlockBackend *blk;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002808 BlockDriverState *bs;
2809 ImageInfo *info;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002810
2811 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2812 error_report("Backing file '%s' creates an infinite loop.",
2813 filename);
2814 goto err;
2815 }
2816 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2817
Max Reitzefaa7c42016-03-16 19:54:38 +01002818 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002819 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2820 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002821 if (!blk) {
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002822 goto err;
2823 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002824 bs = blk_bs(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002825
Wenchao Xia43526ec2013-06-06 12:27:58 +08002826 bdrv_query_image_info(bs, &info, &err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002827 if (err) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01002828 error_report_err(err);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002829 blk_unref(blk);
Wenchao Xia43526ec2013-06-06 12:27:58 +08002830 goto err;
Wenchao Xiafb0ed452013-06-06 12:27:57 +08002831 }
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002832
Eric Blakec3033fd2021-01-13 16:10:12 -06002833 QAPI_LIST_APPEND(tail, info);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002834
Markus Armbruster26f54e92014-10-07 13:59:04 +02002835 blk_unref(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002836
Stefan Hajnoczi0da7d132019-12-05 13:46:46 +00002837 /* Clear parameters that only apply to the topmost image */
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002838 filename = fmt = NULL;
Stefan Hajnoczi0da7d132019-12-05 13:46:46 +00002839 image_opts = false;
2840
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002841 if (chain) {
2842 if (info->has_full_backing_filename) {
2843 filename = info->full_backing_filename;
2844 } else if (info->has_backing_filename) {
John Snow92d617a2015-12-14 14:55:15 -05002845 error_report("Could not determine absolute backing filename,"
2846 " but backing filename '%s' present",
2847 info->backing_filename);
2848 goto err;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002849 }
2850 if (info->has_backing_filename_format) {
2851 fmt = info->backing_filename_format;
2852 }
2853 }
2854 }
2855 g_hash_table_destroy(filenames);
2856 return head;
2857
2858err:
2859 qapi_free_ImageInfoList(head);
2860 g_hash_table_destroy(filenames);
2861 return NULL;
2862}
2863
Benoît Canetc054b3f2012-09-05 13:09:02 +02002864static int img_info(int argc, char **argv)
2865{
2866 int c;
2867 OutputFormat output_format = OFORMAT_HUMAN;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002868 bool chain = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002869 const char *filename, *fmt, *output;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002870 ImageInfoList *list;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002871 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08002872 bool force_share = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002873
bellardea2384d2004-08-01 21:59:26 +00002874 fmt = NULL;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002875 output = NULL;
bellardea2384d2004-08-01 21:59:26 +00002876 for(;;) {
Benoît Canetc054b3f2012-09-05 13:09:02 +02002877 int option_index = 0;
2878 static const struct option long_options[] = {
2879 {"help", no_argument, 0, 'h'},
2880 {"format", required_argument, 0, 'f'},
2881 {"output", required_argument, 0, OPTION_OUTPUT},
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002882 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002883 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002884 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002885 {"force-share", no_argument, 0, 'U'},
Benoît Canetc054b3f2012-09-05 13:09:02 +02002886 {0, 0, 0, 0}
2887 };
Fam Zheng335e9932017-05-03 00:35:39 +08002888 c = getopt_long(argc, argv, ":f:hU",
Benoît Canetc054b3f2012-09-05 13:09:02 +02002889 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002890 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002891 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002892 }
bellardea2384d2004-08-01 21:59:26 +00002893 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002894 case ':':
2895 missing_argument(argv[optind - 1]);
2896 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002897 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002898 unrecognized_option(argv[optind - 1]);
2899 break;
bellardea2384d2004-08-01 21:59:26 +00002900 case 'h':
2901 help();
2902 break;
2903 case 'f':
2904 fmt = optarg;
2905 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002906 case 'U':
2907 force_share = true;
2908 break;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002909 case OPTION_OUTPUT:
2910 output = optarg;
2911 break;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002912 case OPTION_BACKING_CHAIN:
2913 chain = true;
2914 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01002915 case OPTION_OBJECT:
2916 user_creatable_process_cmdline(optarg);
2917 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002918 case OPTION_IMAGE_OPTS:
2919 image_opts = true;
2920 break;
bellardea2384d2004-08-01 21:59:26 +00002921 }
2922 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02002923 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08002924 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002925 }
bellardea2384d2004-08-01 21:59:26 +00002926 filename = argv[optind++];
2927
Benoît Canetc054b3f2012-09-05 13:09:02 +02002928 if (output && !strcmp(output, "json")) {
2929 output_format = OFORMAT_JSON;
2930 } else if (output && !strcmp(output, "human")) {
2931 output_format = OFORMAT_HUMAN;
2932 } else if (output) {
2933 error_report("--output must be used with human or json as argument.");
2934 return 1;
2935 }
2936
Fam Zheng335e9932017-05-03 00:35:39 +08002937 list = collect_image_info_list(image_opts, filename, fmt, chain,
2938 force_share);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002939 if (!list) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002940 return 1;
2941 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002942
Benoît Canetc054b3f2012-09-05 13:09:02 +02002943 switch (output_format) {
2944 case OFORMAT_HUMAN:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002945 dump_human_image_info_list(list);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002946 break;
2947 case OFORMAT_JSON:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002948 if (chain) {
2949 dump_json_image_info_list(list);
2950 } else {
2951 dump_json_image_info(list->value);
2952 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002953 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002954 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002955
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002956 qapi_free_ImageInfoList(list);
bellardea2384d2004-08-01 21:59:26 +00002957 return 0;
2958}
2959
Eric Blake30065d12019-03-26 13:40:43 -05002960static int dump_map_entry(OutputFormat output_format, MapEntry *e,
2961 MapEntry *next)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002962{
2963 switch (output_format) {
2964 case OFORMAT_HUMAN:
Fam Zheng16b0d552016-01-26 11:59:02 +08002965 if (e->data && !e->has_offset) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002966 error_report("File contains external, encrypted or compressed clusters.");
Eric Blake30065d12019-03-26 13:40:43 -05002967 return -1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002968 }
Fam Zheng16b0d552016-01-26 11:59:02 +08002969 if (e->data && !e->zero) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002970 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
Fam Zheng16b0d552016-01-26 11:59:02 +08002971 e->start, e->length,
2972 e->has_offset ? e->offset : 0,
2973 e->has_filename ? e->filename : "");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002974 }
2975 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2976 * Modify the flags here to allow more coalescing.
2977 */
Fam Zheng16b0d552016-01-26 11:59:02 +08002978 if (next && (!next->data || next->zero)) {
2979 next->data = false;
2980 next->zero = true;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002981 }
2982 break;
2983 case OFORMAT_JSON:
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03002984 printf("{ \"start\": %"PRId64", \"length\": %"PRId64","
Eric Blake8417e132021-07-01 14:06:55 -05002985 " \"depth\": %"PRId64", \"present\": %s, \"zero\": %s,"
2986 " \"data\": %s", e->start, e->length, e->depth,
2987 e->present ? "true" : "false",
Fam Zheng16b0d552016-01-26 11:59:02 +08002988 e->zero ? "true" : "false",
2989 e->data ? "true" : "false");
2990 if (e->has_offset) {
Paolo Bonzinic745bfb2013-09-11 18:47:52 +02002991 printf(", \"offset\": %"PRId64"", e->offset);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002992 }
2993 putchar('}');
2994
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03002995 if (next) {
2996 puts(",");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002997 }
2998 break;
2999 }
Eric Blake30065d12019-03-26 13:40:43 -05003000 return 0;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003001}
3002
Eric Blake5e344dd2017-10-11 22:47:02 -05003003static int get_block_status(BlockDriverState *bs, int64_t offset,
3004 int64_t bytes, MapEntry *e)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003005{
Eric Blake237d78f2017-10-11 22:47:03 -05003006 int ret;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003007 int depth;
Fam Zheng67a0fd22016-01-26 11:58:48 +08003008 BlockDriverState *file;
John Snow28756452016-02-05 13:12:33 -05003009 bool has_offset;
Eric Blake237d78f2017-10-11 22:47:03 -05003010 int64_t map;
Max Reitzf30c66b2019-02-01 20:29:05 +01003011 char *filename = NULL;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003012
3013 /* As an optimization, we could cache the current range of unallocated
3014 * clusters in each file of the chain, and avoid querying the same
3015 * range repeatedly.
3016 */
3017
3018 depth = 0;
3019 for (;;) {
Max Reitz4a2061e2019-06-12 19:00:30 +02003020 bs = bdrv_skip_filters(bs);
Eric Blake237d78f2017-10-11 22:47:03 -05003021 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003022 if (ret < 0) {
3023 return ret;
3024 }
Eric Blake237d78f2017-10-11 22:47:03 -05003025 assert(bytes);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003026 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
3027 break;
3028 }
Max Reitz4a2061e2019-06-12 19:00:30 +02003029 bs = bdrv_cow_bs(bs);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003030 if (bs == NULL) {
3031 ret = 0;
3032 break;
3033 }
3034
3035 depth++;
3036 }
3037
John Snow28756452016-02-05 13:12:33 -05003038 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
3039
Max Reitzf30c66b2019-02-01 20:29:05 +01003040 if (file && has_offset) {
3041 bdrv_refresh_filename(file);
3042 filename = file->filename;
3043 }
3044
John Snow28756452016-02-05 13:12:33 -05003045 *e = (MapEntry) {
Eric Blake5e344dd2017-10-11 22:47:02 -05003046 .start = offset,
Eric Blake237d78f2017-10-11 22:47:03 -05003047 .length = bytes,
John Snow28756452016-02-05 13:12:33 -05003048 .data = !!(ret & BDRV_BLOCK_DATA),
3049 .zero = !!(ret & BDRV_BLOCK_ZERO),
Eric Blake237d78f2017-10-11 22:47:03 -05003050 .offset = map,
John Snow28756452016-02-05 13:12:33 -05003051 .has_offset = has_offset,
3052 .depth = depth,
Eric Blake8417e132021-07-01 14:06:55 -05003053 .present = !!(ret & BDRV_BLOCK_ALLOCATED),
Max Reitzf30c66b2019-02-01 20:29:05 +01003054 .has_filename = filename,
3055 .filename = filename,
John Snow28756452016-02-05 13:12:33 -05003056 };
3057
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003058 return 0;
3059}
3060
Fam Zheng16b0d552016-01-26 11:59:02 +08003061static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
3062{
3063 if (curr->length == 0) {
3064 return false;
3065 }
3066 if (curr->zero != next->zero ||
3067 curr->data != next->data ||
3068 curr->depth != next->depth ||
Eric Blake8417e132021-07-01 14:06:55 -05003069 curr->present != next->present ||
Fam Zheng16b0d552016-01-26 11:59:02 +08003070 curr->has_filename != next->has_filename ||
3071 curr->has_offset != next->has_offset) {
3072 return false;
3073 }
3074 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
3075 return false;
3076 }
3077 if (curr->has_offset && curr->offset + curr->length != next->offset) {
3078 return false;
3079 }
3080 return true;
3081}
3082
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003083static int img_map(int argc, char **argv)
3084{
3085 int c;
3086 OutputFormat output_format = OFORMAT_HUMAN;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003087 BlockBackend *blk;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003088 BlockDriverState *bs;
3089 const char *filename, *fmt, *output;
3090 int64_t length;
3091 MapEntry curr = { .length = 0 }, next;
3092 int ret = 0;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003093 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003094 bool force_share = false;
Eyal Moscovicic0469492020-05-13 16:36:29 +03003095 int64_t start_offset = 0;
3096 int64_t max_length = -1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003097
3098 fmt = NULL;
3099 output = NULL;
3100 for (;;) {
3101 int option_index = 0;
3102 static const struct option long_options[] = {
3103 {"help", no_argument, 0, 'h'},
3104 {"format", required_argument, 0, 'f'},
3105 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003106 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003107 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003108 {"force-share", no_argument, 0, 'U'},
Eyal Moscovicic0469492020-05-13 16:36:29 +03003109 {"start-offset", required_argument, 0, 's'},
3110 {"max-length", required_argument, 0, 'l'},
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003111 {0, 0, 0, 0}
3112 };
Eyal Moscovicic0469492020-05-13 16:36:29 +03003113 c = getopt_long(argc, argv, ":f:s:l:hU",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003114 long_options, &option_index);
3115 if (c == -1) {
3116 break;
3117 }
3118 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003119 case ':':
3120 missing_argument(argv[optind - 1]);
3121 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003122 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003123 unrecognized_option(argv[optind - 1]);
3124 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003125 case 'h':
3126 help();
3127 break;
3128 case 'f':
3129 fmt = optarg;
3130 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003131 case 'U':
3132 force_share = true;
3133 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003134 case OPTION_OUTPUT:
3135 output = optarg;
3136 break;
Eyal Moscovicic0469492020-05-13 16:36:29 +03003137 case 's':
3138 start_offset = cvtnum("start offset", optarg);
3139 if (start_offset < 0) {
3140 return 1;
3141 }
3142 break;
3143 case 'l':
3144 max_length = cvtnum("max length", optarg);
3145 if (max_length < 0) {
3146 return 1;
3147 }
3148 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003149 case OPTION_OBJECT:
3150 user_creatable_process_cmdline(optarg);
3151 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003152 case OPTION_IMAGE_OPTS:
3153 image_opts = true;
3154 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003155 }
3156 }
Fam Zhengac1307a2014-04-22 13:36:11 +08003157 if (optind != argc - 1) {
3158 error_exit("Expecting one image file name");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003159 }
Fam Zhengac1307a2014-04-22 13:36:11 +08003160 filename = argv[optind];
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003161
3162 if (output && !strcmp(output, "json")) {
3163 output_format = OFORMAT_JSON;
3164 } else if (output && !strcmp(output, "human")) {
3165 output_format = OFORMAT_HUMAN;
3166 } else if (output) {
3167 error_report("--output must be used with human or json as argument.");
3168 return 1;
3169 }
3170
Fam Zheng335e9932017-05-03 00:35:39 +08003171 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003172 if (!blk) {
3173 return 1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003174 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003175 bs = blk_bs(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003176
3177 if (output_format == OFORMAT_HUMAN) {
3178 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003179 } else if (output_format == OFORMAT_JSON) {
3180 putchar('[');
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003181 }
3182
Max Reitzf1d3cd72015-02-05 13:58:18 -05003183 length = blk_getlength(blk);
Eyal Moscovici8f282e82020-05-13 16:36:27 +03003184 if (length < 0) {
3185 error_report("Failed to get size for '%s'", filename);
3186 return 1;
3187 }
Eyal Moscovicic0469492020-05-13 16:36:29 +03003188 if (max_length != -1) {
3189 length = MIN(start_offset + max_length, length);
3190 }
Eyal Moscovici8f282e82020-05-13 16:36:27 +03003191
Eyal Moscovicic0469492020-05-13 16:36:29 +03003192 curr.start = start_offset;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003193 while (curr.start + curr.length < length) {
Eric Blake5e344dd2017-10-11 22:47:02 -05003194 int64_t offset = curr.start + curr.length;
Kevin Wolfd0ceea82020-07-07 16:46:29 +02003195 int64_t n = length - offset;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003196
Eric Blake5e344dd2017-10-11 22:47:02 -05003197 ret = get_block_status(bs, offset, n, &next);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003198 if (ret < 0) {
3199 error_report("Could not read file metadata: %s", strerror(-ret));
3200 goto out;
3201 }
3202
Fam Zheng16b0d552016-01-26 11:59:02 +08003203 if (entry_mergeable(&curr, &next)) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003204 curr.length += next.length;
3205 continue;
3206 }
3207
3208 if (curr.length > 0) {
Eric Blake30065d12019-03-26 13:40:43 -05003209 ret = dump_map_entry(output_format, &curr, &next);
3210 if (ret < 0) {
3211 goto out;
3212 }
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003213 }
3214 curr = next;
3215 }
3216
Eric Blake30065d12019-03-26 13:40:43 -05003217 ret = dump_map_entry(output_format, &curr, NULL);
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003218 if (output_format == OFORMAT_JSON) {
3219 puts("]");
3220 }
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003221
3222out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003223 blk_unref(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003224 return ret < 0;
3225}
3226
aliguorif7b4a942009-01-07 17:40:15 +00003227#define SNAPSHOT_LIST 1
3228#define SNAPSHOT_CREATE 2
3229#define SNAPSHOT_APPLY 3
3230#define SNAPSHOT_DELETE 4
3231
Stuart Brady153859b2009-06-07 00:42:17 +01003232static int img_snapshot(int argc, char **argv)
aliguorif7b4a942009-01-07 17:40:15 +00003233{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003234 BlockBackend *blk;
aliguorif7b4a942009-01-07 17:40:15 +00003235 BlockDriverState *bs;
3236 QEMUSnapshotInfo sn;
3237 char *filename, *snapshot_name = NULL;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003238 int c, ret = 0, bdrv_oflags;
aliguorif7b4a942009-01-07 17:40:15 +00003239 int action = 0;
3240 qemu_timeval tv;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003241 bool quiet = false;
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003242 Error *err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003243 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003244 bool force_share = false;
aliguorif7b4a942009-01-07 17:40:15 +00003245
Kevin Wolfce099542016-03-15 13:01:04 +01003246 bdrv_oflags = BDRV_O_RDWR;
aliguorif7b4a942009-01-07 17:40:15 +00003247 /* Parse commandline parameters */
3248 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003249 static const struct option long_options[] = {
3250 {"help", no_argument, 0, 'h'},
3251 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003252 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003253 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003254 {0, 0, 0, 0}
3255 };
Fam Zheng335e9932017-05-03 00:35:39 +08003256 c = getopt_long(argc, argv, ":la:c:d:hqU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003257 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003258 if (c == -1) {
aliguorif7b4a942009-01-07 17:40:15 +00003259 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003260 }
aliguorif7b4a942009-01-07 17:40:15 +00003261 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003262 case ':':
3263 missing_argument(argv[optind - 1]);
3264 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003265 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003266 unrecognized_option(argv[optind - 1]);
3267 break;
aliguorif7b4a942009-01-07 17:40:15 +00003268 case 'h':
3269 help();
Stuart Brady153859b2009-06-07 00:42:17 +01003270 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003271 case 'l':
3272 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003273 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003274 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003275 }
3276 action = SNAPSHOT_LIST;
Naphtali Spreif5edb012010-01-17 16:48:13 +02003277 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
aliguorif7b4a942009-01-07 17:40:15 +00003278 break;
3279 case 'a':
3280 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003281 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003282 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003283 }
3284 action = SNAPSHOT_APPLY;
3285 snapshot_name = optarg;
3286 break;
3287 case 'c':
3288 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003289 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003290 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003291 }
3292 action = SNAPSHOT_CREATE;
3293 snapshot_name = optarg;
3294 break;
3295 case 'd':
3296 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003297 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003298 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003299 }
3300 action = SNAPSHOT_DELETE;
3301 snapshot_name = optarg;
3302 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003303 case 'q':
3304 quiet = true;
3305 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003306 case 'U':
3307 force_share = true;
3308 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003309 case OPTION_OBJECT:
3310 user_creatable_process_cmdline(optarg);
3311 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003312 case OPTION_IMAGE_OPTS:
3313 image_opts = true;
3314 break;
aliguorif7b4a942009-01-07 17:40:15 +00003315 }
3316 }
3317
Kevin Wolffc11eb22013-08-05 10:53:04 +02003318 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003319 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003320 }
aliguorif7b4a942009-01-07 17:40:15 +00003321 filename = argv[optind++];
3322
3323 /* Open the image */
Fam Zheng335e9932017-05-03 00:35:39 +08003324 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3325 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003326 if (!blk) {
3327 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003328 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003329 bs = blk_bs(blk);
aliguorif7b4a942009-01-07 17:40:15 +00003330
3331 /* Perform the requested action */
3332 switch(action) {
3333 case SNAPSHOT_LIST:
3334 dump_snapshots(bs);
3335 break;
3336
3337 case SNAPSHOT_CREATE:
3338 memset(&sn, 0, sizeof(sn));
3339 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3340
3341 qemu_gettimeofday(&tv);
3342 sn.date_sec = tv.tv_sec;
3343 sn.date_nsec = tv.tv_usec * 1000;
3344
3345 ret = bdrv_snapshot_create(bs, &sn);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003346 if (ret) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003347 error_report("Could not create snapshot '%s': %d (%s)",
aliguorif7b4a942009-01-07 17:40:15 +00003348 snapshot_name, ret, strerror(-ret));
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003349 }
aliguorif7b4a942009-01-07 17:40:15 +00003350 break;
3351
3352 case SNAPSHOT_APPLY:
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003353 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003354 if (ret) {
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003355 error_reportf_err(err, "Could not apply snapshot '%s': ",
3356 snapshot_name);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003357 }
aliguorif7b4a942009-01-07 17:40:15 +00003358 break;
3359
3360 case SNAPSHOT_DELETE:
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003361 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3362 if (ret < 0) {
3363 error_report("Could not delete snapshot '%s': snapshot not "
3364 "found", snapshot_name);
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003365 ret = 1;
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003366 } else {
3367 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3368 if (ret < 0) {
3369 error_reportf_err(err, "Could not delete snapshot '%s': ",
3370 snapshot_name);
3371 ret = 1;
3372 }
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003373 }
aliguorif7b4a942009-01-07 17:40:15 +00003374 break;
3375 }
3376
3377 /* Cleanup */
Markus Armbruster26f54e92014-10-07 13:59:04 +02003378 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003379 if (ret) {
3380 return 1;
3381 }
Stuart Brady153859b2009-06-07 00:42:17 +01003382 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003383}
3384
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003385static int img_rebase(int argc, char **argv)
3386{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003387 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
Paolo Bonzini396374c2016-02-25 23:53:54 +01003388 uint8_t *buf_old = NULL;
3389 uint8_t *buf_new = NULL;
Sam Eiderman863cc782019-05-23 19:33:36 +03003390 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
Max Reitz4a2061e2019-06-12 19:00:30 +02003391 BlockDriverState *unfiltered_bs;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003392 char *filename;
Max Reitz40055952014-07-22 22:58:42 +02003393 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3394 int c, flags, src_flags, ret;
Kevin Wolfce099542016-03-15 13:01:04 +01003395 bool writethrough, src_writethrough;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003396 int unsafe = 0;
Fam Zheng335e9932017-05-03 00:35:39 +08003397 bool force_share = false;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003398 int progress = 0;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003399 bool quiet = false;
Max Reitz34b5d2c2013-09-05 14:45:29 +02003400 Error *local_err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003401 bool image_opts = false;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003402
3403 /* Parse commandline parameters */
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003404 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003405 cache = BDRV_DEFAULT_CACHE;
Max Reitz40055952014-07-22 22:58:42 +02003406 src_cache = BDRV_DEFAULT_CACHE;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003407 out_baseimg = NULL;
3408 out_basefmt = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003409 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003410 static const struct option long_options[] = {
3411 {"help", no_argument, 0, 'h'},
3412 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003413 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003414 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003415 {0, 0, 0, 0}
3416 };
Fam Zheng335e9932017-05-03 00:35:39 +08003417 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003418 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003419 if (c == -1) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003420 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003421 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003422 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003423 case ':':
3424 missing_argument(argv[optind - 1]);
3425 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003426 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003427 unrecognized_option(argv[optind - 1]);
3428 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003429 case 'h':
3430 help();
3431 return 0;
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003432 case 'f':
3433 fmt = optarg;
3434 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003435 case 'F':
3436 out_basefmt = optarg;
3437 break;
3438 case 'b':
3439 out_baseimg = optarg;
3440 break;
3441 case 'u':
3442 unsafe = 1;
3443 break;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003444 case 'p':
3445 progress = 1;
3446 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003447 case 't':
3448 cache = optarg;
3449 break;
Max Reitz40055952014-07-22 22:58:42 +02003450 case 'T':
3451 src_cache = optarg;
3452 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003453 case 'q':
3454 quiet = true;
3455 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003456 case OPTION_OBJECT:
3457 user_creatable_process_cmdline(optarg);
3458 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003459 case OPTION_IMAGE_OPTS:
3460 image_opts = true;
3461 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003462 case 'U':
3463 force_share = true;
3464 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003465 }
3466 }
3467
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003468 if (quiet) {
3469 progress = 0;
3470 }
3471
Fam Zhengac1307a2014-04-22 13:36:11 +08003472 if (optind != argc - 1) {
3473 error_exit("Expecting one image file name");
3474 }
3475 if (!unsafe && !out_baseimg) {
3476 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003477 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003478 filename = argv[optind++];
3479
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003480 qemu_progress_init(progress, 2.0);
3481 qemu_progress_print(0, 100);
3482
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003483 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
Kevin Wolfce099542016-03-15 13:01:04 +01003484 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003485 if (ret < 0) {
3486 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003487 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003488 }
3489
Kevin Wolfce099542016-03-15 13:01:04 +01003490 src_flags = 0;
3491 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
Max Reitz40055952014-07-22 22:58:42 +02003492 if (ret < 0) {
3493 error_report("Invalid source cache option: %s", src_cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003494 goto out;
Max Reitz40055952014-07-22 22:58:42 +02003495 }
3496
Kevin Wolfce099542016-03-15 13:01:04 +01003497 /* The source files are opened read-only, don't care about WCE */
3498 assert((src_flags & BDRV_O_RDWR) == 0);
3499 (void) src_writethrough;
3500
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003501 /*
3502 * Open the images.
3503 *
3504 * Ignore the old backing file for unsafe rebase in case we want to correct
3505 * the reference to a renamed or moved backing file.
3506 */
Fam Zheng335e9932017-05-03 00:35:39 +08003507 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3508 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003509 if (!blk) {
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003510 ret = -1;
3511 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003512 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003513 bs = blk_bs(blk);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003514
Max Reitz4a2061e2019-06-12 19:00:30 +02003515 unfiltered_bs = bdrv_skip_filters(bs);
3516
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003517 if (out_basefmt != NULL) {
Max Reitz644483d2015-02-05 13:58:17 -05003518 if (bdrv_find_format(out_basefmt) == NULL) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003519 error_report("Invalid format name: '%s'", out_basefmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003520 ret = -1;
3521 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003522 }
3523 }
3524
3525 /* For safe rebasing we need to compare old and new backing file */
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003526 if (!unsafe) {
Max Reitz644483d2015-02-05 13:58:17 -05003527 QDict *options = NULL;
Max Reitz4a2061e2019-06-12 19:00:30 +02003528 BlockDriverState *base_bs = bdrv_cow_bs(unfiltered_bs);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003529
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003530 if (base_bs) {
Kevin Wolfd861ab32019-04-25 14:25:10 +02003531 blk_old_backing = blk_new(qemu_get_aio_context(),
3532 BLK_PERM_CONSISTENT_READ,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003533 BLK_PERM_ALL);
3534 ret = blk_insert_bs(blk_old_backing, base_bs,
3535 &local_err);
3536 if (ret < 0) {
Max Reitz35ddd932019-05-09 19:52:35 +02003537 error_reportf_err(local_err,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003538 "Could not reuse old backing file '%s': ",
3539 base_bs->filename);
Max Reitz35ddd932019-05-09 19:52:35 +02003540 goto out;
3541 }
3542 } else {
3543 blk_old_backing = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003544 }
Max Reitz644483d2015-02-05 13:58:17 -05003545
Alex Bligha6166732012-10-16 13:46:18 +01003546 if (out_baseimg[0]) {
Max Reitzd16699b2018-05-09 20:20:01 +02003547 const char *overlay_filename;
3548 char *out_real_path;
3549
Fam Zheng335e9932017-05-03 00:35:39 +08003550 options = qdict_new();
Max Reitz644483d2015-02-05 13:58:17 -05003551 if (out_basefmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003552 qdict_put_str(options, "driver", out_basefmt);
Fam Zheng335e9932017-05-03 00:35:39 +08003553 }
3554 if (force_share) {
3555 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Max Reitz644483d2015-02-05 13:58:17 -05003556 }
3557
Max Reitzf30c66b2019-02-01 20:29:05 +01003558 bdrv_refresh_filename(bs);
Max Reitzd16699b2018-05-09 20:20:01 +02003559 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3560 : bs->filename;
Max Reitz645ae7d2019-02-01 20:29:14 +01003561 out_real_path =
3562 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3563 out_baseimg,
3564 &local_err);
Max Reitzd16699b2018-05-09 20:20:01 +02003565 if (local_err) {
Max Reitzf22356d2019-05-28 21:53:38 +02003566 qobject_unref(options);
Max Reitzd16699b2018-05-09 20:20:01 +02003567 error_reportf_err(local_err,
3568 "Could not resolve backing filename: ");
3569 ret = -1;
Max Reitzd16699b2018-05-09 20:20:01 +02003570 goto out;
3571 }
3572
Sam Eiderman863cc782019-05-23 19:33:36 +03003573 /*
3574 * Find out whether we rebase an image on top of a previous image
3575 * in its chain.
3576 */
3577 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
Sam Eiderman330c7292019-05-23 19:33:37 +03003578 if (prefix_chain_bs) {
Max Reitzf22356d2019-05-28 21:53:38 +02003579 qobject_unref(options);
Sam Eiderman330c7292019-05-23 19:33:37 +03003580 g_free(out_real_path);
Max Reitzf22356d2019-05-28 21:53:38 +02003581
Kevin Wolfd861ab32019-04-25 14:25:10 +02003582 blk_new_backing = blk_new(qemu_get_aio_context(),
3583 BLK_PERM_CONSISTENT_READ,
Sam Eiderman330c7292019-05-23 19:33:37 +03003584 BLK_PERM_ALL);
3585 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
3586 &local_err);
3587 if (ret < 0) {
3588 error_reportf_err(local_err,
3589 "Could not reuse backing file '%s': ",
3590 out_baseimg);
3591 goto out;
3592 }
3593 } else {
3594 blk_new_backing = blk_new_open(out_real_path, NULL,
3595 options, src_flags, &local_err);
3596 g_free(out_real_path);
3597 if (!blk_new_backing) {
3598 error_reportf_err(local_err,
3599 "Could not open new backing file '%s': ",
3600 out_baseimg);
3601 ret = -1;
3602 goto out;
3603 }
Alex Bligha6166732012-10-16 13:46:18 +01003604 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003605 }
3606 }
3607
3608 /*
3609 * Check each unallocated cluster in the COW file. If it is unallocated,
3610 * accesses go to the backing file. We must therefore compare this cluster
3611 * in the old and new backing file, and if they differ we need to copy it
3612 * from the old backing file into the COW file.
3613 *
3614 * If qemu-img crashes during this step, no harm is done. The content of
3615 * the image is the same as the original one at any time.
3616 */
3617 if (!unsafe) {
Eric Blake41536282017-10-11 22:47:15 -05003618 int64_t size;
Max Reitz35ddd932019-05-09 19:52:35 +02003619 int64_t old_backing_size = 0;
Eric Blake41536282017-10-11 22:47:15 -05003620 int64_t new_backing_size = 0;
3621 uint64_t offset;
3622 int64_t n;
Kevin Wolf1f710492012-10-12 14:29:18 +02003623 float local_progress = 0;
TeLeMand6771bf2010-02-08 16:20:00 +08003624
Max Reitzf1d3cd72015-02-05 13:58:18 -05003625 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3626 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003627
Eric Blake41536282017-10-11 22:47:15 -05003628 size = blk_getlength(blk);
3629 if (size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003630 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003631 filename, strerror(-size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003632 ret = -1;
3633 goto out;
3634 }
Max Reitz35ddd932019-05-09 19:52:35 +02003635 if (blk_old_backing) {
3636 old_backing_size = blk_getlength(blk_old_backing);
3637 if (old_backing_size < 0) {
3638 char backing_name[PATH_MAX];
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003639
Max Reitz35ddd932019-05-09 19:52:35 +02003640 bdrv_get_backing_filename(bs, backing_name,
3641 sizeof(backing_name));
3642 error_report("Could not get size of '%s': %s",
3643 backing_name, strerror(-old_backing_size));
3644 ret = -1;
3645 goto out;
3646 }
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003647 }
Max Reitzf1d3cd72015-02-05 13:58:18 -05003648 if (blk_new_backing) {
Eric Blake41536282017-10-11 22:47:15 -05003649 new_backing_size = blk_getlength(blk_new_backing);
3650 if (new_backing_size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003651 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003652 out_baseimg, strerror(-new_backing_size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003653 ret = -1;
3654 goto out;
3655 }
Alex Bligha6166732012-10-16 13:46:18 +01003656 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003657
Eric Blake41536282017-10-11 22:47:15 -05003658 if (size != 0) {
3659 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
Kevin Wolf1f710492012-10-12 14:29:18 +02003660 }
3661
Eric Blake41536282017-10-11 22:47:15 -05003662 for (offset = 0; offset < size; offset += n) {
Max Reitz1c6e8772019-05-09 19:52:36 +02003663 bool buf_old_is_zero = false;
3664
Eric Blake41536282017-10-11 22:47:15 -05003665 /* How many bytes can we handle with the next read? */
3666 n = MIN(IO_BUF_SIZE, size - offset);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003667
3668 /* If the cluster is allocated, we don't need to take action */
Max Reitz4a2061e2019-06-12 19:00:30 +02003669 ret = bdrv_is_allocated(unfiltered_bs, offset, n, &n);
Paolo Bonzinid6636402013-09-04 19:00:25 +02003670 if (ret < 0) {
3671 error_report("error while reading image metadata: %s",
3672 strerror(-ret));
3673 goto out;
3674 }
Kevin Wolfcc60e322010-04-29 14:47:48 +02003675 if (ret) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003676 continue;
3677 }
3678
Sam Eiderman863cc782019-05-23 19:33:36 +03003679 if (prefix_chain_bs) {
3680 /*
3681 * If cluster wasn't changed since prefix_chain, we don't need
3682 * to take action
3683 */
Max Reitz4a2061e2019-06-12 19:00:30 +02003684 ret = bdrv_is_allocated_above(bdrv_cow_bs(unfiltered_bs),
3685 prefix_chain_bs, false,
3686 offset, n, &n);
Sam Eiderman863cc782019-05-23 19:33:36 +03003687 if (ret < 0) {
3688 error_report("error while reading image metadata: %s",
3689 strerror(-ret));
3690 goto out;
3691 }
3692 if (!ret) {
3693 continue;
3694 }
3695 }
3696
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003697 /*
3698 * Read old and new backing file and take into consideration that
3699 * backing files may be smaller than the COW image.
3700 */
Eric Blake41536282017-10-11 22:47:15 -05003701 if (offset >= old_backing_size) {
3702 memset(buf_old, 0, n);
Max Reitz1c6e8772019-05-09 19:52:36 +02003703 buf_old_is_zero = true;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003704 } else {
Eric Blake41536282017-10-11 22:47:15 -05003705 if (offset + n > old_backing_size) {
3706 n = old_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003707 }
3708
Eric Blake41536282017-10-11 22:47:15 -05003709 ret = blk_pread(blk_old_backing, offset, buf_old, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003710 if (ret < 0) {
3711 error_report("error while reading from old backing file");
3712 goto out;
3713 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003714 }
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003715
Eric Blake41536282017-10-11 22:47:15 -05003716 if (offset >= new_backing_size || !blk_new_backing) {
3717 memset(buf_new, 0, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003718 } else {
Eric Blake41536282017-10-11 22:47:15 -05003719 if (offset + n > new_backing_size) {
3720 n = new_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003721 }
3722
Eric Blake41536282017-10-11 22:47:15 -05003723 ret = blk_pread(blk_new_backing, offset, buf_new, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003724 if (ret < 0) {
3725 error_report("error while reading from new backing file");
3726 goto out;
3727 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003728 }
3729
3730 /* If they differ, we need to write to the COW file */
3731 uint64_t written = 0;
3732
Eric Blake41536282017-10-11 22:47:15 -05003733 while (written < n) {
Eric Blakedc61cd32017-10-11 22:47:14 -05003734 int64_t pnum;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003735
Eric Blake41536282017-10-11 22:47:15 -05003736 if (compare_buffers(buf_old + written, buf_new + written,
3737 n - written, &pnum))
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003738 {
Max Reitz1c6e8772019-05-09 19:52:36 +02003739 if (buf_old_is_zero) {
3740 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0);
3741 } else {
3742 ret = blk_pwrite(blk, offset + written,
3743 buf_old + written, pnum, 0);
3744 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003745 if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003746 error_report("Error while writing to COW image: %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003747 strerror(-ret));
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003748 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003749 }
3750 }
3751
3752 written += pnum;
3753 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003754 qemu_progress_print(local_progress, 100);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003755 }
3756 }
3757
3758 /*
3759 * Change the backing file. All clusters that are different from the old
3760 * backing file are overwritten in the COW file now, so the visible content
3761 * doesn't change when we switch the backing file.
3762 */
Alex Bligha6166732012-10-16 13:46:18 +01003763 if (out_baseimg && *out_baseimg) {
Max Reitz4a2061e2019-06-12 19:00:30 +02003764 ret = bdrv_change_backing_file(unfiltered_bs, out_baseimg, out_basefmt,
3765 true);
Alex Bligha6166732012-10-16 13:46:18 +01003766 } else {
Max Reitz4a2061e2019-06-12 19:00:30 +02003767 ret = bdrv_change_backing_file(unfiltered_bs, NULL, NULL, false);
Alex Bligha6166732012-10-16 13:46:18 +01003768 }
3769
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003770 if (ret == -ENOSPC) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003771 error_report("Could not change the backing file to '%s': No "
3772 "space left in the file header", out_baseimg);
Eric Blakea7cd44b2021-07-08 10:52:28 -05003773 } else if (ret == -EINVAL && out_baseimg && !out_basefmt) {
3774 error_report("Could not change the backing file to '%s': backing "
3775 "format must be specified", out_baseimg);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003776 } else if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003777 error_report("Could not change the backing file to '%s': %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003778 out_baseimg, strerror(-ret));
3779 }
3780
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003781 qemu_progress_print(100, 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003782 /*
3783 * TODO At this point it is possible to check if any clusters that are
3784 * allocated in the COW file are the same in the backing file. If so, they
3785 * could be dropped from the COW file. Don't do this before switching the
3786 * backing file, in case of a crash this would lead to corruption.
3787 */
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003788out:
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003789 qemu_progress_end();
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003790 /* Cleanup */
3791 if (!unsafe) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02003792 blk_unref(blk_old_backing);
Markus Armbruster26f54e92014-10-07 13:59:04 +02003793 blk_unref(blk_new_backing);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003794 }
Paolo Bonzini396374c2016-02-25 23:53:54 +01003795 qemu_vfree(buf_old);
3796 qemu_vfree(buf_new);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003797
Markus Armbruster26f54e92014-10-07 13:59:04 +02003798 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003799 if (ret) {
3800 return 1;
3801 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003802 return 0;
3803}
3804
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003805static int img_resize(int argc, char **argv)
3806{
Markus Armbruster6750e792015-02-12 17:43:08 +01003807 Error *err = NULL;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003808 int c, ret, relative;
3809 const char *filename, *fmt, *size;
Max Reitz09c5c6d2019-09-18 11:51:44 +02003810 int64_t n, total_size, current_size;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003811 bool quiet = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003812 BlockBackend *blk = NULL;
Max Reitzdc5f6902017-06-13 22:20:55 +02003813 PreallocMode prealloc = PREALLOC_MODE_OFF;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003814 QemuOpts *param;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003815
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003816 static QemuOptsList resize_options = {
3817 .name = "resize_options",
3818 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3819 .desc = {
3820 {
3821 .name = BLOCK_OPT_SIZE,
3822 .type = QEMU_OPT_SIZE,
3823 .help = "Virtual disk size"
3824 }, {
3825 /* end of list */
3826 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003827 },
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003828 };
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003829 bool image_opts = false;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003830 bool shrink = false;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003831
Kevin Wolfe80fec72011-04-29 10:58:12 +02003832 /* Remove size from argv manually so that negative numbers are not treated
3833 * as options by getopt. */
3834 if (argc < 3) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003835 error_exit("Not enough arguments");
Kevin Wolfe80fec72011-04-29 10:58:12 +02003836 return 1;
3837 }
3838
3839 size = argv[--argc];
3840
3841 /* Parse getopt arguments */
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003842 fmt = NULL;
3843 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003844 static const struct option long_options[] = {
3845 {"help", no_argument, 0, 'h'},
3846 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003847 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Max Reitzdc5f6902017-06-13 22:20:55 +02003848 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003849 {"shrink", no_argument, 0, OPTION_SHRINK},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003850 {0, 0, 0, 0}
3851 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003852 c = getopt_long(argc, argv, ":f:hq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003853 long_options, NULL);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003854 if (c == -1) {
3855 break;
3856 }
3857 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003858 case ':':
3859 missing_argument(argv[optind - 1]);
3860 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003861 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003862 unrecognized_option(argv[optind - 1]);
3863 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003864 case 'h':
3865 help();
3866 break;
3867 case 'f':
3868 fmt = optarg;
3869 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003870 case 'q':
3871 quiet = true;
3872 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003873 case OPTION_OBJECT:
3874 user_creatable_process_cmdline(optarg);
3875 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003876 case OPTION_IMAGE_OPTS:
3877 image_opts = true;
3878 break;
Max Reitzdc5f6902017-06-13 22:20:55 +02003879 case OPTION_PREALLOCATION:
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02003880 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
Markus Armbruster06c60b62017-08-24 10:45:57 +02003881 PREALLOC_MODE__MAX, NULL);
Max Reitzdc5f6902017-06-13 22:20:55 +02003882 if (prealloc == PREALLOC_MODE__MAX) {
3883 error_report("Invalid preallocation mode '%s'", optarg);
3884 return 1;
3885 }
3886 break;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003887 case OPTION_SHRINK:
3888 shrink = true;
3889 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003890 }
3891 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02003892 if (optind != argc - 1) {
Max Reitzbe8fbd42018-02-05 17:27:45 +01003893 error_exit("Expecting image file name and size");
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003894 }
3895 filename = argv[optind++];
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003896
3897 /* Choose grow, shrink, or absolute resize mode */
3898 switch (size[0]) {
3899 case '+':
3900 relative = 1;
3901 size++;
3902 break;
3903 case '-':
3904 relative = -1;
3905 size++;
3906 break;
3907 default:
3908 relative = 0;
3909 break;
3910 }
3911
3912 /* Parse size */
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -08003913 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
Markus Armbruster235e59c2020-07-07 18:05:42 +02003914 if (!qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err)) {
Markus Armbruster6750e792015-02-12 17:43:08 +01003915 error_report_err(err);
Jes Sorensen2a819982010-12-06 17:08:31 +01003916 ret = -1;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003917 qemu_opts_del(param);
Jes Sorensen2a819982010-12-06 17:08:31 +01003918 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003919 }
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003920 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3921 qemu_opts_del(param);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003922
Max Reitzefaa7c42016-03-16 19:54:38 +01003923 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08003924 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
3925 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003926 if (!blk) {
Jes Sorensen2a819982010-12-06 17:08:31 +01003927 ret = -1;
3928 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003929 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003930
Max Reitzdc5f6902017-06-13 22:20:55 +02003931 current_size = blk_getlength(blk);
3932 if (current_size < 0) {
3933 error_report("Failed to inquire current image length: %s",
3934 strerror(-current_size));
3935 ret = -1;
3936 goto out;
3937 }
3938
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003939 if (relative) {
Max Reitzdc5f6902017-06-13 22:20:55 +02003940 total_size = current_size + n * relative;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003941 } else {
3942 total_size = n;
3943 }
3944 if (total_size <= 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003945 error_report("New image size must be positive");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003946 ret = -1;
3947 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003948 }
3949
Max Reitzdc5f6902017-06-13 22:20:55 +02003950 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
3951 error_report("Preallocation can only be used for growing images");
3952 ret = -1;
3953 goto out;
3954 }
3955
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003956 if (total_size < current_size && !shrink) {
Kevin Wolf1c404d72020-07-10 14:17:17 +02003957 error_report("Use the --shrink option to perform a shrink operation.");
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003958 warn_report("Shrinking an image will delete all data beyond the "
3959 "shrunken image's end. Before performing such an "
3960 "operation, make sure there is no important data there.");
Kevin Wolf1c404d72020-07-10 14:17:17 +02003961 ret = -1;
3962 goto out;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003963 }
3964
Max Reitze8d04f92019-09-18 11:51:43 +02003965 /*
3966 * The user expects the image to have the desired size after
3967 * resizing, so pass @exact=true. It is of no use to report
3968 * success when the image has not actually been resized.
3969 */
Kevin Wolf8c6242b2020-04-24 14:54:41 +02003970 ret = blk_truncate(blk, total_size, true, prealloc, 0, &err);
Max Reitz09c5c6d2019-09-18 11:51:44 +02003971 if (!ret) {
3972 qprintf(quiet, "Image resized.\n");
3973 } else {
Max Reitzed3d2ec2017-03-28 22:51:27 +02003974 error_report_err(err);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003975 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003976out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003977 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003978 if (ret) {
3979 return 1;
3980 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003981 return 0;
3982}
3983
Max Reitz76a3a342014-10-27 11:12:51 +01003984static void amend_status_cb(BlockDriverState *bs,
Max Reitz8b139762015-07-27 17:51:32 +02003985 int64_t offset, int64_t total_work_size,
3986 void *opaque)
Max Reitz76a3a342014-10-27 11:12:51 +01003987{
3988 qemu_progress_print(100.f * offset / total_work_size, 0);
3989}
3990
Max Reitz51641352018-05-09 23:00:20 +02003991static int print_amend_option_help(const char *format)
3992{
3993 BlockDriver *drv;
3994
3995 /* Find driver and parse its options */
3996 drv = bdrv_find_format(format);
3997 if (!drv) {
3998 error_report("Unknown file format '%s'", format);
3999 return 1;
4000 }
4001
4002 if (!drv->bdrv_amend_options) {
4003 error_report("Format driver '%s' does not support option amendment",
4004 format);
4005 return 1;
4006 }
4007
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004008 /* Every driver supporting amendment must have amend_opts */
4009 assert(drv->amend_opts);
Max Reitz51641352018-05-09 23:00:20 +02004010
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004011 printf("Amend options for '%s':\n", format);
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004012 qemu_opts_print_help(drv->amend_opts, false);
Max Reitz51641352018-05-09 23:00:20 +02004013 return 0;
4014}
4015
Max Reitz6f176b42013-09-03 10:09:50 +02004016static int img_amend(int argc, char **argv)
4017{
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01004018 Error *err = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02004019 int c, ret = 0;
4020 char *options = NULL;
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004021 QemuOptsList *amend_opts = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08004022 QemuOpts *opts = NULL;
Max Reitzbd39e6e2014-07-22 22:58:43 +02004023 const char *fmt = NULL, *filename, *cache;
4024 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01004025 bool writethrough;
Max Reitz76a3a342014-10-27 11:12:51 +01004026 bool quiet = false, progress = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02004027 BlockBackend *blk = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02004028 BlockDriverState *bs = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004029 bool image_opts = false;
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004030 bool force = false;
Max Reitz6f176b42013-09-03 10:09:50 +02004031
Max Reitzbd39e6e2014-07-22 22:58:43 +02004032 cache = BDRV_DEFAULT_CACHE;
Max Reitz6f176b42013-09-03 10:09:50 +02004033 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004034 static const struct option long_options[] = {
4035 {"help", no_argument, 0, 'h'},
4036 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004037 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004038 {"force", no_argument, 0, OPTION_FORCE},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004039 {0, 0, 0, 0}
4040 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004041 c = getopt_long(argc, argv, ":ho:f:t:pq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004042 long_options, NULL);
Max Reitz6f176b42013-09-03 10:09:50 +02004043 if (c == -1) {
4044 break;
4045 }
4046
4047 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004048 case ':':
4049 missing_argument(argv[optind - 1]);
4050 break;
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004051 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004052 unrecognized_option(argv[optind - 1]);
4053 break;
4054 case 'h':
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004055 help();
4056 break;
4057 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02004058 if (accumulate_options(&options, optarg) < 0) {
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004059 ret = -1;
4060 goto out_no_progress;
4061 }
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004062 break;
4063 case 'f':
4064 fmt = optarg;
4065 break;
4066 case 't':
4067 cache = optarg;
4068 break;
4069 case 'p':
4070 progress = true;
4071 break;
4072 case 'q':
4073 quiet = true;
4074 break;
4075 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01004076 user_creatable_process_cmdline(optarg);
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004077 break;
4078 case OPTION_IMAGE_OPTS:
4079 image_opts = true;
4080 break;
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004081 case OPTION_FORCE:
4082 force = true;
4083 break;
Max Reitz6f176b42013-09-03 10:09:50 +02004084 }
4085 }
4086
Max Reitz6f176b42013-09-03 10:09:50 +02004087 if (!options) {
Fam Zhengac1307a2014-04-22 13:36:11 +08004088 error_exit("Must specify options (-o)");
Max Reitz6f176b42013-09-03 10:09:50 +02004089 }
4090
Max Reitz76a3a342014-10-27 11:12:51 +01004091 if (quiet) {
4092 progress = false;
4093 }
4094 qemu_progress_init(progress, 1.0);
4095
Kevin Wolfa283cb62014-02-21 16:24:07 +01004096 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
4097 if (fmt && has_help_option(options)) {
4098 /* If a format is explicitly specified (and possibly no filename is
4099 * given), print option help here */
Max Reitz51641352018-05-09 23:00:20 +02004100 ret = print_amend_option_help(fmt);
Kevin Wolfa283cb62014-02-21 16:24:07 +01004101 goto out;
4102 }
4103
4104 if (optind != argc - 1) {
Max Reitzb2f27e42014-10-27 11:12:52 +01004105 error_report("Expecting one image file name");
4106 ret = -1;
4107 goto out;
Kevin Wolfa283cb62014-02-21 16:24:07 +01004108 }
Max Reitz6f176b42013-09-03 10:09:50 +02004109
Kevin Wolfce099542016-03-15 13:01:04 +01004110 flags = BDRV_O_RDWR;
4111 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitzbd39e6e2014-07-22 22:58:43 +02004112 if (ret < 0) {
4113 error_report("Invalid cache option: %s", cache);
4114 goto out;
4115 }
4116
Fam Zheng335e9932017-05-03 00:35:39 +08004117 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4118 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004119 if (!blk) {
Max Reitz6f176b42013-09-03 10:09:50 +02004120 ret = -1;
4121 goto out;
4122 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004123 bs = blk_bs(blk);
Max Reitz6f176b42013-09-03 10:09:50 +02004124
4125 fmt = bs->drv->format_name;
4126
Kevin Wolf626f84f2014-02-21 16:24:06 +01004127 if (has_help_option(options)) {
Kevin Wolfa283cb62014-02-21 16:24:07 +01004128 /* If the format was auto-detected, print option help here */
Max Reitz51641352018-05-09 23:00:20 +02004129 ret = print_amend_option_help(fmt);
Max Reitz6f176b42013-09-03 10:09:50 +02004130 goto out;
4131 }
4132
Max Reitz1f996682018-05-09 23:00:17 +02004133 if (!bs->drv->bdrv_amend_options) {
4134 error_report("Format driver '%s' does not support option amendment",
Max Reitzb2439d22014-12-02 18:32:47 +01004135 fmt);
4136 ret = -1;
4137 goto out;
4138 }
4139
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004140 /* Every driver supporting amendment must have amend_opts */
4141 assert(bs->drv->amend_opts);
Max Reitz1f996682018-05-09 23:00:17 +02004142
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004143 amend_opts = qemu_opts_append(amend_opts, bs->drv->amend_opts);
4144 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
Markus Armbruster235e59c2020-07-07 18:05:42 +02004145 if (!qemu_opts_do_parse(opts, options, NULL, &err)) {
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004146 /* Try to parse options using the create options */
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004147 amend_opts = qemu_opts_append(amend_opts, bs->drv->create_opts);
4148 qemu_opts_del(opts);
4149 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
Markus Armbruster9e194e02020-07-07 18:06:11 +02004150 if (qemu_opts_do_parse(opts, options, NULL, NULL)) {
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004151 error_append_hint(&err,
4152 "This option is only supported for image creation\n");
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004153 }
4154
Paolo Bonziniece90862017-01-04 15:56:24 +01004155 error_report_err(err);
4156 ret = -1;
4157 goto out;
Max Reitz6f176b42013-09-03 10:09:50 +02004158 }
4159
Max Reitz76a3a342014-10-27 11:12:51 +01004160 /* In case the driver does not call amend_status_cb() */
4161 qemu_progress_print(0.f, 0);
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004162 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, force, &err);
Max Reitz76a3a342014-10-27 11:12:51 +01004163 qemu_progress_print(100.f, 0);
Max Reitz6f176b42013-09-03 10:09:50 +02004164 if (ret < 0) {
Max Reitzd1402b52018-05-09 23:00:18 +02004165 error_report_err(err);
Max Reitz6f176b42013-09-03 10:09:50 +02004166 goto out;
4167 }
4168
4169out:
Max Reitz76a3a342014-10-27 11:12:51 +01004170 qemu_progress_end();
4171
Max Reitze814dff2015-08-20 16:00:38 -07004172out_no_progress:
Markus Armbruster26f54e92014-10-07 13:59:04 +02004173 blk_unref(blk);
Chunyan Liu83d05212014-06-05 17:20:51 +08004174 qemu_opts_del(opts);
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004175 qemu_opts_free(amend_opts);
Kevin Wolf626f84f2014-02-21 16:24:06 +01004176 g_free(options);
4177
Max Reitz6f176b42013-09-03 10:09:50 +02004178 if (ret) {
4179 return 1;
4180 }
4181 return 0;
4182}
4183
Kevin Wolfb6133b82014-08-05 14:17:13 +02004184typedef struct BenchData {
4185 BlockBackend *blk;
4186 uint64_t image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004187 bool write;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004188 int bufsize;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004189 int step;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004190 int nrreq;
4191 int n;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004192 int flush_interval;
4193 bool drain_on_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004194 uint8_t *buf;
4195 QEMUIOVector *qiov;
4196
4197 int in_flight;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004198 bool in_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004199 uint64_t offset;
4200} BenchData;
4201
Kevin Wolf55d539c2016-06-03 13:59:41 +02004202static void bench_undrained_flush_cb(void *opaque, int ret)
4203{
4204 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004205 error_report("Failed flush request: %s", strerror(-ret));
Kevin Wolf55d539c2016-06-03 13:59:41 +02004206 exit(EXIT_FAILURE);
4207 }
4208}
4209
Kevin Wolfb6133b82014-08-05 14:17:13 +02004210static void bench_cb(void *opaque, int ret)
4211{
4212 BenchData *b = opaque;
4213 BlockAIOCB *acb;
4214
4215 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004216 error_report("Failed request: %s", strerror(-ret));
Kevin Wolfb6133b82014-08-05 14:17:13 +02004217 exit(EXIT_FAILURE);
4218 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004219
4220 if (b->in_flush) {
4221 /* Just finished a flush with drained queue: Start next requests */
4222 assert(b->in_flight == 0);
4223 b->in_flush = false;
4224 } else if (b->in_flight > 0) {
4225 int remaining = b->n - b->in_flight;
4226
Kevin Wolfb6133b82014-08-05 14:17:13 +02004227 b->n--;
4228 b->in_flight--;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004229
4230 /* Time for flush? Drain queue if requested, then flush */
4231 if (b->flush_interval && remaining % b->flush_interval == 0) {
4232 if (!b->in_flight || !b->drain_on_flush) {
4233 BlockCompletionFunc *cb;
4234
4235 if (b->drain_on_flush) {
4236 b->in_flush = true;
4237 cb = bench_cb;
4238 } else {
4239 cb = bench_undrained_flush_cb;
4240 }
4241
4242 acb = blk_aio_flush(b->blk, cb, b);
4243 if (!acb) {
4244 error_report("Failed to issue flush request");
4245 exit(EXIT_FAILURE);
4246 }
4247 }
4248 if (b->drain_on_flush) {
4249 return;
4250 }
4251 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004252 }
4253
4254 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004255 int64_t offset = b->offset;
4256 /* blk_aio_* might look for completed I/Os and kick bench_cb
4257 * again, so make sure this operation is counted by in_flight
4258 * and b->offset is ready for the next submission.
4259 */
4260 b->in_flight++;
4261 b->offset += b->step;
4262 b->offset %= b->image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004263 if (b->write) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004264 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004265 } else {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004266 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004267 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004268 if (!acb) {
4269 error_report("Failed to issue request");
4270 exit(EXIT_FAILURE);
4271 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004272 }
4273}
4274
4275static int img_bench(int argc, char **argv)
4276{
4277 int c, ret = 0;
4278 const char *fmt = NULL, *filename;
4279 bool quiet = false;
4280 bool image_opts = false;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004281 bool is_write = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004282 int count = 75000;
4283 int depth = 64;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004284 int64_t offset = 0;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004285 size_t bufsize = 4096;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004286 int pattern = 0;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004287 size_t step = 0;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004288 int flush_interval = 0;
4289 bool drain_on_flush = true;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004290 int64_t image_size;
4291 BlockBackend *blk = NULL;
4292 BenchData data = {};
4293 int flags = 0;
Kevin Wolf604e8612016-06-14 11:29:32 +02004294 bool writethrough = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004295 struct timeval t1, t2;
4296 int i;
Fam Zheng335e9932017-05-03 00:35:39 +08004297 bool force_share = false;
Fam Zheng79d46582018-01-16 14:08:58 +08004298 size_t buf_size;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004299
4300 for (;;) {
4301 static const struct option long_options[] = {
4302 {"help", no_argument, 0, 'h'},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004303 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004304 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004305 {"pattern", required_argument, 0, OPTION_PATTERN},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004306 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
Fam Zheng335e9932017-05-03 00:35:39 +08004307 {"force-share", no_argument, 0, 'U'},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004308 {0, 0, 0, 0}
4309 };
Aarushi Mehtacdd26772020-01-20 14:18:55 +00004310 c = getopt_long(argc, argv, ":hc:d:f:ni:o:qs:S:t:wU", long_options,
4311 NULL);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004312 if (c == -1) {
4313 break;
4314 }
4315
4316 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004317 case ':':
4318 missing_argument(argv[optind - 1]);
4319 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004320 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004321 unrecognized_option(argv[optind - 1]);
4322 break;
4323 case 'h':
Kevin Wolfb6133b82014-08-05 14:17:13 +02004324 help();
4325 break;
4326 case 'c':
4327 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004328 unsigned long res;
4329
4330 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004331 error_report("Invalid request count specified");
4332 return 1;
4333 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004334 count = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004335 break;
4336 }
4337 case 'd':
4338 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004339 unsigned long res;
4340
4341 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004342 error_report("Invalid queue depth specified");
4343 return 1;
4344 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004345 depth = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004346 break;
4347 }
4348 case 'f':
4349 fmt = optarg;
4350 break;
4351 case 'n':
4352 flags |= BDRV_O_NATIVE_AIO;
4353 break;
Aarushi Mehtacdd26772020-01-20 14:18:55 +00004354 case 'i':
4355 ret = bdrv_parse_aio(optarg, &flags);
4356 if (ret < 0) {
4357 error_report("Invalid aio option: %s", optarg);
4358 ret = -1;
4359 goto out;
4360 }
4361 break;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004362 case 'o':
4363 {
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004364 offset = cvtnum("offset", optarg);
Markus Armbruster606caa02017-02-21 21:14:04 +01004365 if (offset < 0) {
Kevin Wolfd3199a32015-07-10 18:09:18 +02004366 return 1;
4367 }
4368 break;
4369 }
4370 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004371 case 'q':
4372 quiet = true;
4373 break;
4374 case 's':
4375 {
4376 int64_t sval;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004377
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004378 sval = cvtnum_full("buffer size", optarg, 0, INT_MAX);
4379 if (sval < 0) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004380 return 1;
4381 }
4382
4383 bufsize = sval;
4384 break;
4385 }
Kevin Wolf83de9be2015-07-13 13:13:17 +02004386 case 'S':
4387 {
4388 int64_t sval;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004389
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004390 sval = cvtnum_full("step_size", optarg, 0, INT_MAX);
4391 if (sval < 0) {
Kevin Wolf83de9be2015-07-13 13:13:17 +02004392 return 1;
4393 }
4394
4395 step = sval;
4396 break;
4397 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004398 case 't':
4399 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4400 if (ret < 0) {
4401 error_report("Invalid cache mode");
4402 ret = -1;
4403 goto out;
4404 }
4405 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004406 case 'w':
4407 flags |= BDRV_O_RDWR;
4408 is_write = true;
4409 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004410 case 'U':
4411 force_share = true;
4412 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004413 case OPTION_PATTERN:
4414 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004415 unsigned long res;
4416
4417 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004418 error_report("Invalid pattern byte specified");
4419 return 1;
4420 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004421 pattern = res;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004422 break;
4423 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004424 case OPTION_FLUSH_INTERVAL:
4425 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004426 unsigned long res;
4427
4428 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004429 error_report("Invalid flush interval specified");
4430 return 1;
4431 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004432 flush_interval = res;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004433 break;
4434 }
4435 case OPTION_NO_DRAIN:
4436 drain_on_flush = false;
4437 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004438 case OPTION_IMAGE_OPTS:
4439 image_opts = true;
4440 break;
4441 }
4442 }
4443
4444 if (optind != argc - 1) {
4445 error_exit("Expecting one image file name");
4446 }
4447 filename = argv[argc - 1];
4448
Kevin Wolf55d539c2016-06-03 13:59:41 +02004449 if (!is_write && flush_interval) {
4450 error_report("--flush-interval is only available in write tests");
4451 ret = -1;
4452 goto out;
4453 }
4454 if (flush_interval && flush_interval < depth) {
4455 error_report("Flush interval can't be smaller than depth");
4456 ret = -1;
4457 goto out;
4458 }
4459
Fam Zheng335e9932017-05-03 00:35:39 +08004460 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4461 force_share);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004462 if (!blk) {
4463 ret = -1;
4464 goto out;
4465 }
4466
4467 image_size = blk_getlength(blk);
4468 if (image_size < 0) {
4469 ret = image_size;
4470 goto out;
4471 }
4472
4473 data = (BenchData) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004474 .blk = blk,
4475 .image_size = image_size,
4476 .bufsize = bufsize,
4477 .step = step ?: bufsize,
4478 .nrreq = depth,
4479 .n = count,
4480 .offset = offset,
4481 .write = is_write,
4482 .flush_interval = flush_interval,
4483 .drain_on_flush = drain_on_flush,
Kevin Wolfb6133b82014-08-05 14:17:13 +02004484 };
Kevin Wolfd3199a32015-07-10 18:09:18 +02004485 printf("Sending %d %s requests, %d bytes each, %d in parallel "
Kevin Wolf83de9be2015-07-13 13:13:17 +02004486 "(starting at offset %" PRId64 ", step size %d)\n",
Kevin Wolfd3199a32015-07-10 18:09:18 +02004487 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
Kevin Wolf83de9be2015-07-13 13:13:17 +02004488 data.offset, data.step);
Kevin Wolf55d539c2016-06-03 13:59:41 +02004489 if (flush_interval) {
4490 printf("Sending flush every %d requests\n", flush_interval);
4491 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004492
Fam Zheng79d46582018-01-16 14:08:58 +08004493 buf_size = data.nrreq * data.bufsize;
4494 data.buf = blk_blockalign(blk, buf_size);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004495 memset(data.buf, pattern, data.nrreq * data.bufsize);
4496
Fam Zheng79d46582018-01-16 14:08:58 +08004497 blk_register_buf(blk, data.buf, buf_size);
4498
Kevin Wolfb6133b82014-08-05 14:17:13 +02004499 data.qiov = g_new(QEMUIOVector, data.nrreq);
4500 for (i = 0; i < data.nrreq; i++) {
4501 qemu_iovec_init(&data.qiov[i], 1);
4502 qemu_iovec_add(&data.qiov[i],
4503 data.buf + i * data.bufsize, data.bufsize);
4504 }
4505
4506 gettimeofday(&t1, NULL);
4507 bench_cb(&data, 0);
4508
4509 while (data.n > 0) {
4510 main_loop_wait(false);
4511 }
4512 gettimeofday(&t2, NULL);
4513
4514 printf("Run completed in %3.3f seconds.\n",
4515 (t2.tv_sec - t1.tv_sec)
4516 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4517
4518out:
Fam Zheng79d46582018-01-16 14:08:58 +08004519 if (data.buf) {
4520 blk_unregister_buf(blk, data.buf);
4521 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004522 qemu_vfree(data.buf);
4523 blk_unref(blk);
4524
4525 if (ret) {
4526 return 1;
4527 }
4528 return 0;
4529}
4530
Eric Blake3b51ab42020-05-12 20:16:45 -05004531enum ImgBitmapAct {
4532 BITMAP_ADD,
4533 BITMAP_REMOVE,
4534 BITMAP_CLEAR,
4535 BITMAP_ENABLE,
4536 BITMAP_DISABLE,
4537 BITMAP_MERGE,
4538};
4539typedef struct ImgBitmapAction {
4540 enum ImgBitmapAct act;
4541 const char *src; /* only used for merge */
4542 QSIMPLEQ_ENTRY(ImgBitmapAction) next;
4543} ImgBitmapAction;
4544
4545static int img_bitmap(int argc, char **argv)
4546{
4547 Error *err = NULL;
4548 int c, ret = 1;
4549 QemuOpts *opts = NULL;
4550 const char *fmt = NULL, *src_fmt = NULL, *src_filename = NULL;
4551 const char *filename, *bitmap;
4552 BlockBackend *blk = NULL, *src = NULL;
4553 BlockDriverState *bs = NULL, *src_bs = NULL;
4554 bool image_opts = false;
4555 int64_t granularity = 0;
4556 bool add = false, merge = false;
4557 QSIMPLEQ_HEAD(, ImgBitmapAction) actions;
4558 ImgBitmapAction *act, *act_next;
4559 const char *op;
4560
4561 QSIMPLEQ_INIT(&actions);
4562
4563 for (;;) {
4564 static const struct option long_options[] = {
4565 {"help", no_argument, 0, 'h'},
4566 {"object", required_argument, 0, OPTION_OBJECT},
4567 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4568 {"add", no_argument, 0, OPTION_ADD},
4569 {"remove", no_argument, 0, OPTION_REMOVE},
4570 {"clear", no_argument, 0, OPTION_CLEAR},
4571 {"enable", no_argument, 0, OPTION_ENABLE},
4572 {"disable", no_argument, 0, OPTION_DISABLE},
4573 {"merge", required_argument, 0, OPTION_MERGE},
4574 {"granularity", required_argument, 0, 'g'},
4575 {"source-file", required_argument, 0, 'b'},
4576 {"source-format", required_argument, 0, 'F'},
4577 {0, 0, 0, 0}
4578 };
4579 c = getopt_long(argc, argv, ":b:f:F:g:h", long_options, NULL);
4580 if (c == -1) {
4581 break;
4582 }
4583
4584 switch (c) {
4585 case ':':
4586 missing_argument(argv[optind - 1]);
4587 break;
4588 case '?':
4589 unrecognized_option(argv[optind - 1]);
4590 break;
4591 case 'h':
4592 help();
4593 break;
4594 case 'b':
4595 src_filename = optarg;
4596 break;
4597 case 'f':
4598 fmt = optarg;
4599 break;
4600 case 'F':
4601 src_fmt = optarg;
4602 break;
4603 case 'g':
4604 granularity = cvtnum("granularity", optarg);
4605 if (granularity < 0) {
4606 return 1;
4607 }
4608 break;
4609 case OPTION_ADD:
4610 act = g_new0(ImgBitmapAction, 1);
4611 act->act = BITMAP_ADD;
4612 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4613 add = true;
4614 break;
4615 case OPTION_REMOVE:
4616 act = g_new0(ImgBitmapAction, 1);
4617 act->act = BITMAP_REMOVE;
4618 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4619 break;
4620 case OPTION_CLEAR:
4621 act = g_new0(ImgBitmapAction, 1);
4622 act->act = BITMAP_CLEAR;
4623 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4624 break;
4625 case OPTION_ENABLE:
4626 act = g_new0(ImgBitmapAction, 1);
4627 act->act = BITMAP_ENABLE;
4628 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4629 break;
4630 case OPTION_DISABLE:
4631 act = g_new0(ImgBitmapAction, 1);
4632 act->act = BITMAP_DISABLE;
4633 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4634 break;
4635 case OPTION_MERGE:
4636 act = g_new0(ImgBitmapAction, 1);
4637 act->act = BITMAP_MERGE;
4638 act->src = optarg;
4639 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4640 merge = true;
4641 break;
4642 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01004643 user_creatable_process_cmdline(optarg);
Eric Blake3b51ab42020-05-12 20:16:45 -05004644 break;
4645 case OPTION_IMAGE_OPTS:
4646 image_opts = true;
4647 break;
4648 }
4649 }
4650
Eric Blake3b51ab42020-05-12 20:16:45 -05004651 if (QSIMPLEQ_EMPTY(&actions)) {
4652 error_report("Need at least one of --add, --remove, --clear, "
4653 "--enable, --disable, or --merge");
4654 goto out;
4655 }
4656
4657 if (granularity && !add) {
4658 error_report("granularity only supported with --add");
4659 goto out;
4660 }
4661 if (src_fmt && !src_filename) {
4662 error_report("-F only supported with -b");
4663 goto out;
4664 }
4665 if (src_filename && !merge) {
4666 error_report("Merge bitmap source file only supported with "
4667 "--merge");
4668 goto out;
4669 }
4670
4671 if (optind != argc - 2) {
4672 error_report("Expecting filename and bitmap name");
4673 goto out;
4674 }
4675
4676 filename = argv[optind];
4677 bitmap = argv[optind + 1];
4678
Eric Blake14f16bf2020-09-14 14:10:09 -05004679 /*
4680 * No need to open backing chains; we will be manipulating bitmaps
4681 * directly in this image without reference to image contents.
4682 */
4683 blk = img_open(image_opts, filename, fmt, BDRV_O_RDWR | BDRV_O_NO_BACKING,
4684 false, false, false);
Eric Blake3b51ab42020-05-12 20:16:45 -05004685 if (!blk) {
4686 goto out;
4687 }
4688 bs = blk_bs(blk);
4689 if (src_filename) {
Eric Blake14f16bf2020-09-14 14:10:09 -05004690 src = img_open(false, src_filename, src_fmt, BDRV_O_NO_BACKING,
4691 false, false, false);
Eric Blake3b51ab42020-05-12 20:16:45 -05004692 if (!src) {
4693 goto out;
4694 }
4695 src_bs = blk_bs(src);
4696 } else {
4697 src_bs = bs;
4698 }
4699
4700 QSIMPLEQ_FOREACH_SAFE(act, &actions, next, act_next) {
4701 switch (act->act) {
4702 case BITMAP_ADD:
4703 qmp_block_dirty_bitmap_add(bs->node_name, bitmap,
4704 !!granularity, granularity, true, true,
4705 false, false, &err);
4706 op = "add";
4707 break;
4708 case BITMAP_REMOVE:
4709 qmp_block_dirty_bitmap_remove(bs->node_name, bitmap, &err);
4710 op = "remove";
4711 break;
4712 case BITMAP_CLEAR:
4713 qmp_block_dirty_bitmap_clear(bs->node_name, bitmap, &err);
4714 op = "clear";
4715 break;
4716 case BITMAP_ENABLE:
4717 qmp_block_dirty_bitmap_enable(bs->node_name, bitmap, &err);
4718 op = "enable";
4719 break;
4720 case BITMAP_DISABLE:
4721 qmp_block_dirty_bitmap_disable(bs->node_name, bitmap, &err);
4722 op = "disable";
4723 break;
Eric Blake6c729dd2020-05-21 14:21:35 -05004724 case BITMAP_MERGE:
4725 do_dirty_bitmap_merge(bs->node_name, bitmap, src_bs->node_name,
4726 act->src, &err);
Eric Blake3b51ab42020-05-12 20:16:45 -05004727 op = "merge";
4728 break;
Eric Blake3b51ab42020-05-12 20:16:45 -05004729 default:
4730 g_assert_not_reached();
4731 }
4732
4733 if (err) {
4734 error_reportf_err(err, "Operation %s on bitmap %s failed: ",
4735 op, bitmap);
4736 goto out;
4737 }
4738 g_free(act);
4739 }
4740
4741 ret = 0;
4742
4743 out:
4744 blk_unref(src);
4745 blk_unref(blk);
4746 qemu_opts_del(opts);
4747 return ret;
4748}
4749
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004750#define C_BS 01
4751#define C_COUNT 02
4752#define C_IF 04
4753#define C_OF 010
Reda Sallahif7c15532016-08-10 16:16:09 +02004754#define C_SKIP 020
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004755
4756struct DdInfo {
4757 unsigned int flags;
4758 int64_t count;
4759};
4760
4761struct DdIo {
4762 int bsz; /* Block size */
4763 char *filename;
4764 uint8_t *buf;
Reda Sallahif7c15532016-08-10 16:16:09 +02004765 int64_t offset;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004766};
4767
4768struct DdOpts {
4769 const char *name;
4770 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
4771 unsigned int flag;
4772};
4773
4774static int img_dd_bs(const char *arg,
4775 struct DdIo *in, struct DdIo *out,
4776 struct DdInfo *dd)
4777{
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004778 int64_t res;
4779
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004780 res = cvtnum_full("bs", arg, 1, INT_MAX);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004781
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004782 if (res < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004783 return 1;
4784 }
4785 in->bsz = out->bsz = res;
4786
4787 return 0;
4788}
4789
4790static int img_dd_count(const char *arg,
4791 struct DdIo *in, struct DdIo *out,
4792 struct DdInfo *dd)
4793{
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004794 dd->count = cvtnum("count", arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004795
Markus Armbruster606caa02017-02-21 21:14:04 +01004796 if (dd->count < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004797 return 1;
4798 }
4799
4800 return 0;
4801}
4802
4803static int img_dd_if(const char *arg,
4804 struct DdIo *in, struct DdIo *out,
4805 struct DdInfo *dd)
4806{
4807 in->filename = g_strdup(arg);
4808
4809 return 0;
4810}
4811
4812static int img_dd_of(const char *arg,
4813 struct DdIo *in, struct DdIo *out,
4814 struct DdInfo *dd)
4815{
4816 out->filename = g_strdup(arg);
4817
4818 return 0;
4819}
4820
Reda Sallahif7c15532016-08-10 16:16:09 +02004821static int img_dd_skip(const char *arg,
4822 struct DdIo *in, struct DdIo *out,
4823 struct DdInfo *dd)
4824{
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004825 in->offset = cvtnum("skip", arg);
Reda Sallahif7c15532016-08-10 16:16:09 +02004826
Markus Armbruster606caa02017-02-21 21:14:04 +01004827 if (in->offset < 0) {
Reda Sallahif7c15532016-08-10 16:16:09 +02004828 return 1;
4829 }
4830
4831 return 0;
4832}
4833
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004834static int img_dd(int argc, char **argv)
4835{
4836 int ret = 0;
4837 char *arg = NULL;
4838 char *tmp;
4839 BlockDriver *drv = NULL, *proto_drv = NULL;
4840 BlockBackend *blk1 = NULL, *blk2 = NULL;
4841 QemuOpts *opts = NULL;
4842 QemuOptsList *create_opts = NULL;
4843 Error *local_err = NULL;
4844 bool image_opts = false;
4845 int c, i;
4846 const char *out_fmt = "raw";
4847 const char *fmt = NULL;
4848 int64_t size = 0;
4849 int64_t block_count = 0, out_pos, in_pos;
Fam Zheng335e9932017-05-03 00:35:39 +08004850 bool force_share = false;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004851 struct DdInfo dd = {
4852 .flags = 0,
4853 .count = 0,
4854 };
4855 struct DdIo in = {
4856 .bsz = 512, /* Block size is by default 512 bytes */
4857 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004858 .buf = NULL,
4859 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004860 };
4861 struct DdIo out = {
4862 .bsz = 512,
4863 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004864 .buf = NULL,
4865 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004866 };
4867
4868 const struct DdOpts options[] = {
4869 { "bs", img_dd_bs, C_BS },
4870 { "count", img_dd_count, C_COUNT },
4871 { "if", img_dd_if, C_IF },
4872 { "of", img_dd_of, C_OF },
Reda Sallahif7c15532016-08-10 16:16:09 +02004873 { "skip", img_dd_skip, C_SKIP },
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004874 { NULL, NULL, 0 }
4875 };
4876 const struct option long_options[] = {
4877 { "help", no_argument, 0, 'h'},
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004878 { "object", required_argument, 0, OPTION_OBJECT},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004879 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08004880 { "force-share", no_argument, 0, 'U'},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004881 { 0, 0, 0, 0 }
4882 };
4883
Fam Zheng335e9932017-05-03 00:35:39 +08004884 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004885 if (c == EOF) {
4886 break;
4887 }
4888 switch (c) {
4889 case 'O':
4890 out_fmt = optarg;
4891 break;
4892 case 'f':
4893 fmt = optarg;
4894 break;
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004895 case ':':
4896 missing_argument(argv[optind - 1]);
4897 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004898 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004899 unrecognized_option(argv[optind - 1]);
4900 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004901 case 'h':
4902 help();
4903 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004904 case 'U':
4905 force_share = true;
4906 break;
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01004907 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01004908 user_creatable_process_cmdline(optarg);
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01004909 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004910 case OPTION_IMAGE_OPTS:
4911 image_opts = true;
4912 break;
4913 }
4914 }
4915
4916 for (i = optind; i < argc; i++) {
4917 int j;
4918 arg = g_strdup(argv[i]);
4919
4920 tmp = strchr(arg, '=');
4921 if (tmp == NULL) {
4922 error_report("unrecognized operand %s", arg);
4923 ret = -1;
4924 goto out;
4925 }
4926
4927 *tmp++ = '\0';
4928
4929 for (j = 0; options[j].name != NULL; j++) {
4930 if (!strcmp(arg, options[j].name)) {
4931 break;
4932 }
4933 }
4934 if (options[j].name == NULL) {
4935 error_report("unrecognized operand %s", arg);
4936 ret = -1;
4937 goto out;
4938 }
4939
4940 if (options[j].f(tmp, &in, &out, &dd) != 0) {
4941 ret = -1;
4942 goto out;
4943 }
4944 dd.flags |= options[j].flag;
4945 g_free(arg);
4946 arg = NULL;
4947 }
4948
4949 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
4950 error_report("Must specify both input and output files");
4951 ret = -1;
4952 goto out;
4953 }
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004954
Fam Zheng335e9932017-05-03 00:35:39 +08004955 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
4956 force_share);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004957
4958 if (!blk1) {
4959 ret = -1;
4960 goto out;
4961 }
4962
4963 drv = bdrv_find_format(out_fmt);
4964 if (!drv) {
4965 error_report("Unknown file format");
4966 ret = -1;
4967 goto out;
4968 }
4969 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
4970
4971 if (!proto_drv) {
4972 error_report_err(local_err);
4973 ret = -1;
4974 goto out;
4975 }
4976 if (!drv->create_opts) {
4977 error_report("Format driver '%s' does not support image creation",
4978 drv->format_name);
4979 ret = -1;
4980 goto out;
4981 }
4982 if (!proto_drv->create_opts) {
4983 error_report("Protocol driver '%s' does not support image creation",
4984 proto_drv->format_name);
4985 ret = -1;
4986 goto out;
4987 }
4988 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4989 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
4990
4991 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4992
4993 size = blk_getlength(blk1);
4994 if (size < 0) {
4995 error_report("Failed to get size for '%s'", in.filename);
4996 ret = -1;
4997 goto out;
4998 }
4999
5000 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
5001 dd.count * in.bsz < size) {
5002 size = dd.count * in.bsz;
5003 }
5004
Reda Sallahif7c15532016-08-10 16:16:09 +02005005 /* Overflow means the specified offset is beyond input image's size */
5006 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5007 size < in.bsz * in.offset)) {
5008 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
5009 } else {
5010 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
5011 size - in.bsz * in.offset, &error_abort);
5012 }
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005013
5014 ret = bdrv_create(drv, out.filename, opts, &local_err);
5015 if (ret < 0) {
5016 error_reportf_err(local_err,
5017 "%s: error while creating output image: ",
5018 out.filename);
5019 ret = -1;
5020 goto out;
5021 }
5022
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01005023 /* TODO, we can't honour --image-opts for the target,
5024 * since it needs to be given in a format compatible
5025 * with the bdrv_create() call above which does not
5026 * support image-opts style.
5027 */
Daniel P. Berrange29cf9332017-05-15 17:47:12 +01005028 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01005029 false, false, false);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005030
5031 if (!blk2) {
5032 ret = -1;
5033 goto out;
5034 }
5035
Reda Sallahif7c15532016-08-10 16:16:09 +02005036 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5037 size < in.offset * in.bsz)) {
5038 /* We give a warning if the skip option is bigger than the input
5039 * size and create an empty output disk image (i.e. like dd(1)).
5040 */
5041 error_report("%s: cannot skip to specified offset", in.filename);
5042 in_pos = size;
5043 } else {
5044 in_pos = in.offset * in.bsz;
5045 }
5046
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005047 in.buf = g_new(uint8_t, in.bsz);
5048
Reda Sallahif7c15532016-08-10 16:16:09 +02005049 for (out_pos = 0; in_pos < size; block_count++) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005050 int in_ret, out_ret;
5051
5052 if (in_pos + in.bsz > size) {
5053 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
5054 } else {
5055 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
5056 }
5057 if (in_ret < 0) {
5058 error_report("error while reading from input image file: %s",
5059 strerror(-in_ret));
5060 ret = -1;
5061 goto out;
5062 }
5063 in_pos += in_ret;
5064
5065 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
5066
5067 if (out_ret < 0) {
5068 error_report("error while writing to output image file: %s",
5069 strerror(-out_ret));
5070 ret = -1;
5071 goto out;
5072 }
5073 out_pos += out_ret;
5074 }
5075
5076out:
5077 g_free(arg);
5078 qemu_opts_del(opts);
5079 qemu_opts_free(create_opts);
5080 blk_unref(blk1);
5081 blk_unref(blk2);
5082 g_free(in.filename);
5083 g_free(out.filename);
5084 g_free(in.buf);
5085 g_free(out.buf);
5086
5087 if (ret) {
5088 return 1;
5089 }
5090 return 0;
5091}
5092
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005093static void dump_json_block_measure_info(BlockMeasureInfo *info)
5094{
Markus Armbrustereab3a462020-12-11 18:11:37 +01005095 GString *str;
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005096 QObject *obj;
5097 Visitor *v = qobject_output_visitor_new(&obj);
5098
5099 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
5100 visit_complete(v, &obj);
Markus Armbruster6589f452020-12-11 18:11:35 +01005101 str = qobject_to_json_pretty(obj, true);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005102 assert(str != NULL);
Markus Armbrustereab3a462020-12-11 18:11:37 +01005103 printf("%s\n", str->str);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02005104 qobject_unref(obj);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005105 visit_free(v);
Markus Armbrustereab3a462020-12-11 18:11:37 +01005106 g_string_free(str, true);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005107}
5108
5109static int img_measure(int argc, char **argv)
5110{
5111 static const struct option long_options[] = {
5112 {"help", no_argument, 0, 'h'},
5113 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
5114 {"object", required_argument, 0, OPTION_OBJECT},
5115 {"output", required_argument, 0, OPTION_OUTPUT},
5116 {"size", required_argument, 0, OPTION_SIZE},
5117 {"force-share", no_argument, 0, 'U'},
5118 {0, 0, 0, 0}
5119 };
5120 OutputFormat output_format = OFORMAT_HUMAN;
5121 BlockBackend *in_blk = NULL;
5122 BlockDriver *drv;
5123 const char *filename = NULL;
5124 const char *fmt = NULL;
5125 const char *out_fmt = "raw";
5126 char *options = NULL;
5127 char *snapshot_name = NULL;
5128 bool force_share = false;
5129 QemuOpts *opts = NULL;
5130 QemuOpts *object_opts = NULL;
5131 QemuOpts *sn_opts = NULL;
5132 QemuOptsList *create_opts = NULL;
5133 bool image_opts = false;
5134 uint64_t img_size = UINT64_MAX;
5135 BlockMeasureInfo *info = NULL;
5136 Error *local_err = NULL;
5137 int ret = 1;
5138 int c;
5139
5140 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
5141 long_options, NULL)) != -1) {
5142 switch (c) {
5143 case '?':
5144 case 'h':
5145 help();
5146 break;
5147 case 'f':
5148 fmt = optarg;
5149 break;
5150 case 'O':
5151 out_fmt = optarg;
5152 break;
5153 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02005154 if (accumulate_options(&options, optarg) < 0) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005155 goto out;
5156 }
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005157 break;
5158 case 'l':
5159 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
5160 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
5161 optarg, false);
5162 if (!sn_opts) {
5163 error_report("Failed in parsing snapshot param '%s'",
5164 optarg);
5165 goto out;
5166 }
5167 } else {
5168 snapshot_name = optarg;
5169 }
5170 break;
5171 case 'U':
5172 force_share = true;
5173 break;
5174 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01005175 user_creatable_process_cmdline(optarg);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005176 break;
5177 case OPTION_IMAGE_OPTS:
5178 image_opts = true;
5179 break;
5180 case OPTION_OUTPUT:
5181 if (!strcmp(optarg, "json")) {
5182 output_format = OFORMAT_JSON;
5183 } else if (!strcmp(optarg, "human")) {
5184 output_format = OFORMAT_HUMAN;
5185 } else {
5186 error_report("--output must be used with human or json "
5187 "as argument.");
5188 goto out;
5189 }
5190 break;
5191 case OPTION_SIZE:
5192 {
5193 int64_t sval;
5194
Eyal Moscovici43d589b2020-05-13 16:36:26 +03005195 sval = cvtnum("image size", optarg);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005196 if (sval < 0) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005197 goto out;
5198 }
5199 img_size = (uint64_t)sval;
5200 }
5201 break;
5202 }
5203 }
5204
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005205 if (argc - optind > 1) {
5206 error_report("At most one filename argument is allowed.");
5207 goto out;
5208 } else if (argc - optind == 1) {
5209 filename = argv[optind];
5210 }
5211
Stefan Hajnoczic3673dc2020-02-21 11:25:21 +00005212 if (!filename && (image_opts || fmt || snapshot_name || sn_opts)) {
5213 error_report("--image-opts, -f, and -l require a filename argument.");
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005214 goto out;
5215 }
5216 if (filename && img_size != UINT64_MAX) {
5217 error_report("--size N cannot be used together with a filename.");
5218 goto out;
5219 }
5220 if (!filename && img_size == UINT64_MAX) {
5221 error_report("Either --size N or one filename must be specified.");
5222 goto out;
5223 }
5224
5225 if (filename) {
5226 in_blk = img_open(image_opts, filename, fmt, 0,
5227 false, false, force_share);
5228 if (!in_blk) {
5229 goto out;
5230 }
5231
5232 if (sn_opts) {
5233 bdrv_snapshot_load_tmp(blk_bs(in_blk),
5234 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
5235 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
5236 &local_err);
5237 } else if (snapshot_name != NULL) {
5238 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
5239 snapshot_name, &local_err);
5240 }
5241 if (local_err) {
5242 error_reportf_err(local_err, "Failed to load snapshot: ");
5243 goto out;
5244 }
5245 }
5246
5247 drv = bdrv_find_format(out_fmt);
5248 if (!drv) {
5249 error_report("Unknown file format '%s'", out_fmt);
5250 goto out;
5251 }
5252 if (!drv->create_opts) {
5253 error_report("Format driver '%s' does not support image creation",
5254 drv->format_name);
5255 goto out;
5256 }
5257
5258 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5259 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
5260 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5261 if (options) {
Markus Armbruster235e59c2020-07-07 18:05:42 +02005262 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005263 error_report_err(local_err);
5264 error_report("Invalid options for file format '%s'", out_fmt);
5265 goto out;
5266 }
5267 }
5268 if (img_size != UINT64_MAX) {
5269 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
5270 }
5271
5272 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
5273 if (local_err) {
5274 error_report_err(local_err);
5275 goto out;
5276 }
5277
5278 if (output_format == OFORMAT_HUMAN) {
5279 printf("required size: %" PRIu64 "\n", info->required);
5280 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
Eric Blake5d72c682020-05-21 14:21:34 -05005281 if (info->has_bitmaps) {
5282 printf("bitmaps size: %" PRIu64 "\n", info->bitmaps);
5283 }
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005284 } else {
5285 dump_json_block_measure_info(info);
5286 }
5287
5288 ret = 0;
5289
5290out:
5291 qapi_free_BlockMeasureInfo(info);
5292 qemu_opts_del(object_opts);
5293 qemu_opts_del(opts);
5294 qemu_opts_del(sn_opts);
5295 qemu_opts_free(create_opts);
5296 g_free(options);
5297 blk_unref(in_blk);
5298 return ret;
5299}
Kevin Wolfb6133b82014-08-05 14:17:13 +02005300
Anthony Liguoric227f092009-10-01 16:12:16 -05005301static const img_cmd_t img_cmds[] = {
Stuart Brady153859b2009-06-07 00:42:17 +01005302#define DEF(option, callback, arg_string) \
5303 { option, callback },
5304#include "qemu-img-cmds.h"
5305#undef DEF
Stuart Brady153859b2009-06-07 00:42:17 +01005306 { NULL, NULL, },
5307};
5308
bellardea2384d2004-08-01 21:59:26 +00005309int main(int argc, char **argv)
5310{
Anthony Liguoric227f092009-10-01 16:12:16 -05005311 const img_cmd_t *cmd;
Stuart Brady153859b2009-06-07 00:42:17 +01005312 const char *cmdname;
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005313 Error *local_error = NULL;
Jeff Cody7db16892014-04-25 17:02:32 -04005314 int c;
Jeff Cody7db16892014-04-25 17:02:32 -04005315 static const struct option long_options[] = {
5316 {"help", no_argument, 0, 'h'},
Denis V. Lunev10985132016-06-17 17:44:13 +03005317 {"version", no_argument, 0, 'V'},
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005318 {"trace", required_argument, NULL, 'T'},
Jeff Cody7db16892014-04-25 17:02:32 -04005319 {0, 0, 0, 0}
5320 };
bellardea2384d2004-08-01 21:59:26 +00005321
MORITA Kazutaka526eda12013-07-23 17:30:11 +09005322#ifdef CONFIG_POSIX
5323 signal(SIGPIPE, SIG_IGN);
5324#endif
5325
Daniel P. Berrangé98c5d2e2020-08-25 11:38:48 +01005326 socket_init();
Christophe Fergeauf5852ef2019-01-31 17:46:14 +01005327 error_init(argv[0]);
Daniel P. Berrangefe4db842016-10-04 14:35:52 +01005328 module_call_init(MODULE_INIT_TRACE);
Fam Zheng10f5bff2014-02-10 14:48:51 +08005329 qemu_init_exec_dir(argv[0]);
Kevin Wolf53f76e52010-12-16 15:10:32 +01005330
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005331 if (qemu_init_main_loop(&local_error)) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01005332 error_report_err(local_error);
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005333 exit(EXIT_FAILURE);
5334 }
5335
Eduardo Habkoste8f2d272016-05-12 11:10:04 -03005336 qcrypto_init(&error_fatal);
Daniel P. Berrangec2297082016-04-06 12:12:06 +01005337
Daniel P. Berrange064097d2016-02-10 18:41:01 +00005338 module_call_init(MODULE_INIT_QOM);
bellardea2384d2004-08-01 21:59:26 +00005339 bdrv_init();
Fam Zhengac1307a2014-04-22 13:36:11 +08005340 if (argc < 2) {
5341 error_exit("Not enough arguments");
5342 }
Stuart Brady153859b2009-06-07 00:42:17 +01005343
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00005344 qemu_add_opts(&qemu_source_opts);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005345 qemu_add_opts(&qemu_trace_opts);
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00005346
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005347 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
Denis V. Lunev10985132016-06-17 17:44:13 +03005348 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005349 case ':':
5350 missing_argument(argv[optind - 1]);
5351 return 0;
Stefan Hajnoczi4581c162017-03-17 18:45:39 +08005352 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005353 unrecognized_option(argv[optind - 1]);
5354 return 0;
5355 case 'h':
Denis V. Lunev10985132016-06-17 17:44:13 +03005356 help();
5357 return 0;
5358 case 'V':
5359 printf(QEMU_IMG_VERSION);
5360 return 0;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005361 case 'T':
Paolo Bonzini92eecff2020-11-02 06:58:41 -05005362 trace_opt_parse(optarg);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005363 break;
Stuart Brady153859b2009-06-07 00:42:17 +01005364 }
bellardea2384d2004-08-01 21:59:26 +00005365 }
Stuart Brady153859b2009-06-07 00:42:17 +01005366
Denis V. Lunev10985132016-06-17 17:44:13 +03005367 cmdname = argv[optind];
Jeff Cody7db16892014-04-25 17:02:32 -04005368
Denis V. Lunev10985132016-06-17 17:44:13 +03005369 /* reset getopt_long scanning */
5370 argc -= optind;
5371 if (argc < 1) {
Jeff Cody5f6979c2014-04-28 14:37:18 -04005372 return 0;
5373 }
Denis V. Lunev10985132016-06-17 17:44:13 +03005374 argv += optind;
Richard W.M. Jonesd339d762019-01-18 10:11:14 +00005375 qemu_reset_optind();
Denis V. Lunev10985132016-06-17 17:44:13 +03005376
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005377 if (!trace_init_backends()) {
5378 exit(1);
5379 }
Paolo Bonzini92eecff2020-11-02 06:58:41 -05005380 trace_init_file();
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005381 qemu_set_log(LOG_TRACE);
5382
Denis V. Lunev10985132016-06-17 17:44:13 +03005383 /* find the command */
5384 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
5385 if (!strcmp(cmdname, cmd->name)) {
5386 return cmd->handler(argc, argv);
5387 }
5388 }
Jeff Cody7db16892014-04-25 17:02:32 -04005389
Stuart Brady153859b2009-06-07 00:42:17 +01005390 /* not found */
Fam Zhengac1307a2014-04-22 13:36:11 +08005391 error_exit("Command not found: %s", cmdname);
bellardea2384d2004-08-01 21:59:26 +00005392}