blob: a3b64c88af0f4fce8da9521206ef6a2302bb80e8 [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
Marc-André Lureau49f95222022-04-20 17:25:49 +040028#include "qemu/help-texts.h"
Marc-André Lureau16a18f22022-03-23 19:57:35 +040029#include "qemu/qemu-progress.h"
Fam Zheng67a1de02016-06-01 17:44:21 +080030#include "qemu-version.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010031#include "qapi/error.h"
Eric Blake3b51ab42020-05-12 20:16:45 -050032#include "qapi/qapi-commands-block-core.h"
Markus Armbruster9af23982018-02-11 10:36:01 +010033#include "qapi/qapi-visit-block-core.h"
Daniel P. Berrangeb3db2112016-09-30 15:45:27 +010034#include "qapi/qobject-output-visitor.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010035#include "qapi/qmp/qjson.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010036#include "qapi/qmp/qdict.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020037#include "qemu/cutils.h"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000038#include "qemu/config-file.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010039#include "qemu/option.h"
40#include "qemu/error-report.h"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +030041#include "qemu/log.h"
Markus Armbrusterdb725812019-08-12 07:23:50 +020042#include "qemu/main-loop.h"
Markus Armbruster0b8fa322019-05-23 16:35:07 +020043#include "qemu/module.h"
Daniel P. Berrangé98c5d2e2020-08-25 11:38:48 +010044#include "qemu/sockets.h"
Stefano Garzarella97ede572019-05-08 12:43:24 +020045#include "qemu/units.h"
Peter Maydell5df022c2022-02-26 18:07:23 +000046#include "qemu/memalign.h"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000047#include "qom/object_interfaces.h"
Markus Armbruster26f54e92014-10-07 13:59:04 +020048#include "sysemu/block-backend.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010049#include "block/block_int.h"
Max Reitzd4a32382014-10-24 15:57:37 +020050#include "block/blockjob.h"
Wenchao Xiaf364ec62013-05-25 11:09:44 +080051#include "block/qapi.h"
Daniel P. Berrangec2297082016-04-06 12:12:06 +010052#include "crypto/init.h"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +030053#include "trace/control.h"
Zhengui0c8c4892020-10-20 14:47:44 +000054#include "qemu/throttle.h"
55#include "block/throttle-groups.h"
bellarde8445332006-06-14 15:32:10 +000056
Thomas Huth7e563bf2018-02-15 12:06:47 +010057#define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
Thomas Huth0781dd62016-10-05 11:54:44 +020058 "\n" QEMU_COPYRIGHT "\n"
Jeff Cody5f6979c2014-04-28 14:37:18 -040059
Anthony Liguoric227f092009-10-01 16:12:16 -050060typedef struct img_cmd_t {
Stuart Brady153859b2009-06-07 00:42:17 +010061 const char *name;
62 int (*handler)(int argc, char **argv);
Anthony Liguoric227f092009-10-01 16:12:16 -050063} img_cmd_t;
Stuart Brady153859b2009-06-07 00:42:17 +010064
Federico Simoncelli8599ea42013-01-28 06:59:47 -050065enum {
66 OPTION_OUTPUT = 256,
67 OPTION_BACKING_CHAIN = 257,
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000068 OPTION_OBJECT = 258,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000069 OPTION_IMAGE_OPTS = 259,
Kevin Wolfb6495fa2015-07-10 18:09:18 +020070 OPTION_PATTERN = 260,
Kevin Wolf55d539c2016-06-03 13:59:41 +020071 OPTION_FLUSH_INTERVAL = 261,
72 OPTION_NO_DRAIN = 262,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +010073 OPTION_TARGET_IMAGE_OPTS = 263,
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +010074 OPTION_SIZE = 264,
Max Reitzdc5f6902017-06-13 22:20:55 +020075 OPTION_PREALLOCATION = 265,
Pavel Butsykin4ffca892017-09-18 15:42:27 +030076 OPTION_SHRINK = 266,
Max Reitz8eaac022019-05-07 22:35:03 +020077 OPTION_SALVAGE = 267,
David Edmondson168468f2020-02-05 11:02:48 +000078 OPTION_TARGET_IS_ZERO = 268,
Eric Blake3b51ab42020-05-12 20:16:45 -050079 OPTION_ADD = 269,
80 OPTION_REMOVE = 270,
81 OPTION_CLEAR = 271,
82 OPTION_ENABLE = 272,
83 OPTION_DISABLE = 273,
84 OPTION_MERGE = 274,
Eric Blake15e39ad2020-05-21 14:21:36 -050085 OPTION_BITMAPS = 275,
Maxim Levitskya3579bf2020-06-25 14:55:38 +020086 OPTION_FORCE = 276,
Eric Blake955171e2021-07-21 10:53:48 -050087 OPTION_SKIP_BROKEN = 277,
Federico Simoncelli8599ea42013-01-28 06:59:47 -050088};
89
90typedef enum OutputFormat {
91 OFORMAT_JSON,
92 OFORMAT_HUMAN,
93} OutputFormat;
94
Kevin Wolfe6996142016-03-15 13:03:11 +010095/* Default to cache=writeback as data integrity is not important for qemu-img */
Federico Simoncelli661a0f72011-06-20 12:48:19 -040096#define BDRV_DEFAULT_CACHE "writeback"
aurel32137519c2008-11-30 19:12:49 +000097
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +010098static void format_print(void *opaque, const char *name)
bellardea2384d2004-08-01 21:59:26 +000099{
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +0100100 printf(" %s", name);
bellardea2384d2004-08-01 21:59:26 +0000101}
102
Marc-André Lureau89057702022-04-20 17:26:02 +0400103static G_NORETURN G_GNUC_PRINTF(1, 2)
104void error_exit(const char *fmt, ...)
Fam Zhengac1307a2014-04-22 13:36:11 +0800105{
106 va_list ap;
107
Fam Zhengac1307a2014-04-22 13:36:11 +0800108 va_start(ap, fmt);
Markus Armbrustere9e1d922019-04-17 21:06:27 +0200109 error_vreport(fmt, ap);
Fam Zhengac1307a2014-04-22 13:36:11 +0800110 va_end(ap);
111
Markus Armbrustere9e1d922019-04-17 21:06:27 +0200112 error_printf("Try 'qemu-img --help' for more information\n");
Fam Zhengac1307a2014-04-22 13:36:11 +0800113 exit(EXIT_FAILURE);
114}
115
Marc-André Lureau89057702022-04-20 17:26:02 +0400116static G_NORETURN
117void missing_argument(const char *option)
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800118{
119 error_exit("missing argument for option '%s'", option);
120}
121
Marc-André Lureau89057702022-04-20 17:26:02 +0400122static G_NORETURN
123void unrecognized_option(const char *option)
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800124{
125 error_exit("unrecognized option '%s'", option);
126}
127
Eric Blake0562adf2020-05-12 20:16:41 -0500128/* Please keep in synch with docs/tools/qemu-img.rst */
Marc-André Lureau89057702022-04-20 17:26:02 +0400129static G_NORETURN
130void help(void)
bellardea2384d2004-08-01 21:59:26 +0000131{
Paolo Bonzinie00291c2010-02-04 16:49:56 +0100132 const char *help_msg =
Jeff Cody5f6979c2014-04-28 14:37:18 -0400133 QEMU_IMG_VERSION
Denis V. Lunev10985132016-06-17 17:44:13 +0300134 "usage: qemu-img [standard options] command [command options]\n"
malc3f020d72010-02-08 12:04:56 +0300135 "QEMU disk image utility\n"
136 "\n"
Denis V. Lunev10985132016-06-17 17:44:13 +0300137 " '-h', '--help' display this help and exit\n"
138 " '-V', '--version' output version information and exit\n"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +0300139 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
140 " specify tracing options\n"
Denis V. Lunev10985132016-06-17 17:44:13 +0300141 "\n"
malc3f020d72010-02-08 12:04:56 +0300142 "Command syntax:\n"
Stuart Brady153859b2009-06-07 00:42:17 +0100143#define DEF(option, callback, arg_string) \
144 " " arg_string "\n"
145#include "qemu-img-cmds.h"
146#undef DEF
malc3f020d72010-02-08 12:04:56 +0300147 "\n"
148 "Command parameters:\n"
149 " 'filename' is a disk image filename\n"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000150 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
151 " manual page for a description of the object properties. The most common\n"
152 " object type is a 'secret', which is used to supply passwords and/or\n"
153 " encryption keys.\n"
malc3f020d72010-02-08 12:04:56 +0300154 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400155 " 'cache' is the cache mode used to write the output disk image, the valid\n"
Liu Yuan80ccf932012-04-20 17:10:56 +0800156 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
157 " 'directsync' and 'unsafe' (default for convert)\n"
Stefan Hajnoczibb87fdf2014-09-02 11:01:02 +0100158 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
159 " options are the same as for the 'cache' option\n"
malc3f020d72010-02-08 12:04:56 +0300160 " 'size' is the disk image size in bytes. Optional suffixes\n"
Kevin Wolf5e009842013-06-05 14:19:27 +0200161 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
162 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
163 " supported. 'b' is ignored.\n"
malc3f020d72010-02-08 12:04:56 +0300164 " 'output_filename' is the destination disk image filename\n"
165 " 'output_fmt' is the destination format\n"
166 " 'options' is a comma separated list of format specific options in a\n"
Markus Armbruster7f118b42022-09-08 15:08:42 +0200167 " name=value format. Use -o help for an overview of the options supported by\n"
168 " the used format\n"
Wenchao Xiaef806542013-12-04 17:10:57 +0800169 " 'snapshot_param' is param used for internal snapshot, format\n"
170 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
171 " '[ID_OR_NAME]'\n"
malc3f020d72010-02-08 12:04:56 +0300172 " '-c' indicates that target image must be compressed (qcow format only)\n"
John Snow6e6e55f2017-07-17 20:34:22 -0400173 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
174 " new backing file match exactly. The image doesn't need a working\n"
175 " backing file before rebasing in this case (useful for renaming the\n"
176 " backing file). For image creation, allow creating without attempting\n"
177 " to open the backing file.\n"
malc3f020d72010-02-08 12:04:56 +0300178 " '-h' with or without a command shows this help and lists the supported formats\n"
Jes Sorensen6b837bc2011-03-30 14:16:25 +0200179 " '-p' show progress of command (only certain commands)\n"
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100180 " '-q' use Quiet mode - do not print any output (except errors)\n"
Peter Lieven11b66992013-10-24 12:07:05 +0200181 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
182 " contain only zeros for qemu-img to create a sparse image during\n"
183 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
184 " unallocated or zero sectors, and the destination image will always be\n"
185 " fully allocated\n"
Benoît Canetc054b3f2012-09-05 13:09:02 +0200186 " '--output' takes the format in which the output must be done (human or json)\n"
Alexandre Derumierb2e10492013-09-02 19:07:24 +0100187 " '-n' skips the target volume creation (useful if the volume is created\n"
188 " prior to running qemu-img)\n"
malc3f020d72010-02-08 12:04:56 +0300189 "\n"
Eric Blake3b51ab42020-05-12 20:16:45 -0500190 "Parameters to bitmap subcommand:\n"
191 " 'bitmap' is the name of the bitmap to manipulate, through one or more\n"
192 " actions from '--add', '--remove', '--clear', '--enable', '--disable',\n"
193 " or '--merge source'\n"
194 " '-g granularity' sets the granularity for '--add' actions\n"
195 " '-b source' and '-F src_fmt' tell '--merge' actions to find the source\n"
196 " bitmaps from an alternative file\n"
197 "\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200198 "Parameters to check subcommand:\n"
199 " '-r' tries to repair any inconsistencies that are found during the check.\n"
200 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
201 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
Stefan Weil0546b8c2012-08-10 22:03:25 +0200202 " hiding corruption that has already occurred.\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200203 "\n"
Peter Lieven2d9187b2017-02-28 13:40:07 +0100204 "Parameters to convert subcommand:\n"
Eric Blake15e39ad2020-05-21 14:21:36 -0500205 " '--bitmaps' copies all top-level persistent bitmaps to destination\n"
Peter Lieven2d9187b2017-02-28 13:40:07 +0100206 " '-m' specifies how many coroutines work in parallel during the convert\n"
207 " process (defaults to 8)\n"
208 " '-W' allow to write to the target out of order rather than sequential\n"
209 "\n"
malc3f020d72010-02-08 12:04:56 +0300210 "Parameters to snapshot subcommand:\n"
211 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
212 " '-a' applies a snapshot (revert disk to saved state)\n"
213 " '-c' creates a snapshot\n"
214 " '-d' deletes a snapshot\n"
Miroslav Rezaninad14ed182013-02-13 09:09:41 +0100215 " '-l' lists all snapshots in the given image\n"
216 "\n"
217 "Parameters to compare subcommand:\n"
218 " '-f' first image format\n"
219 " '-F' second image format\n"
Reda Sallahi86ce1f62016-08-10 04:43:12 +0200220 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
221 "\n"
222 "Parameters to dd subcommand:\n"
223 " 'bs=BYTES' read and write up to BYTES bytes at a time "
224 "(default: 512)\n"
225 " 'count=N' copy only N input blocks\n"
226 " 'if=FILE' read from FILE\n"
Reda Sallahif7c15532016-08-10 16:16:09 +0200227 " 'of=FILE' write to FILE\n"
228 " 'skip=N' skip N bs-sized blocks at the start of input\n";
Paolo Bonzinie00291c2010-02-04 16:49:56 +0100229
230 printf("%s\nSupported formats:", help_msg);
Andrey Shinkevich9ac404c2019-03-07 16:33:58 +0300231 bdrv_iterate_format(format_print, NULL, false);
Eric Blakef5048cb2017-08-03 11:33:53 -0500232 printf("\n\n" QEMU_HELP_BOTTOM "\n");
Fam Zhengac1307a2014-04-22 13:36:11 +0800233 exit(EXIT_SUCCESS);
bellardea2384d2004-08-01 21:59:26 +0000234}
235
Markus Armbruster80c710c2020-04-15 09:49:26 +0200236/*
237 * Is @optarg safe for accumulate_options()?
238 * It is when multiple of them can be joined together separated by ','.
239 * To make that work, @optarg must not start with ',' (or else a
240 * separating ',' preceding it gets escaped), and it must not end with
241 * an odd number of ',' (or else a separating ',' following it gets
Markus Armbrusterf62514b2020-04-15 09:49:27 +0200242 * escaped), or be empty (or else a separating ',' preceding it can
243 * escape a separating ',' following it).
244 *
Markus Armbruster80c710c2020-04-15 09:49:26 +0200245 */
246static bool is_valid_option_list(const char *optarg)
247{
248 size_t len = strlen(optarg);
249 size_t i;
250
Markus Armbrusterf62514b2020-04-15 09:49:27 +0200251 if (!optarg[0] || optarg[0] == ',') {
Markus Armbruster80c710c2020-04-15 09:49:26 +0200252 return false;
253 }
254
255 for (i = len; i > 0 && optarg[i - 1] == ','; i--) {
256 }
257 if ((len - i) % 2) {
258 return false;
259 }
260
261 return true;
262}
263
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +0200264static int accumulate_options(char **options, char *optarg)
265{
266 char *new_options;
267
268 if (!is_valid_option_list(optarg)) {
269 error_report("Invalid option list: %s", optarg);
270 return -1;
271 }
272
273 if (!*options) {
274 *options = g_strdup(optarg);
275 } else {
276 new_options = g_strdup_printf("%s,%s", *options, optarg);
277 g_free(*options);
278 *options = new_options;
279 }
280 return 0;
281}
282
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000283static QemuOptsList qemu_source_opts = {
284 .name = "source",
285 .implied_opt_name = "file",
286 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
287 .desc = {
288 { }
289 },
290};
291
Marc-André Lureau9edc6312022-02-20 20:39:25 +0400292static int G_GNUC_PRINTF(2, 3) qprintf(bool quiet, const char *fmt, ...)
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100293{
294 int ret = 0;
295 if (!quiet) {
296 va_list args;
297 va_start(args, fmt);
298 ret = vprintf(fmt, args);
299 va_end(args);
300 }
301 return ret;
302}
303
bellardea2384d2004-08-01 21:59:26 +0000304
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100305static int print_block_option_help(const char *filename, const char *fmt)
306{
307 BlockDriver *drv, *proto_drv;
Chunyan Liu83d05212014-06-05 17:20:51 +0800308 QemuOptsList *create_opts = NULL;
Max Reitzb65a5e12015-02-05 13:58:12 -0500309 Error *local_err = NULL;
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100310
311 /* Find driver and parse its options */
312 drv = bdrv_find_format(fmt);
313 if (!drv) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100314 error_report("Unknown file format '%s'", fmt);
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100315 return 1;
316 }
317
Max Reitzd402b6a2018-05-09 23:00:21 +0200318 if (!drv->create_opts) {
319 error_report("Format driver '%s' does not support image creation", fmt);
320 return 1;
321 }
322
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800323 create_opts = qemu_opts_append(create_opts, drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100324 if (filename) {
Max Reitzb65a5e12015-02-05 13:58:12 -0500325 proto_drv = bdrv_find_protocol(filename, true, &local_err);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100326 if (!proto_drv) {
Markus Armbruster2867ce42015-03-12 16:08:02 +0100327 error_report_err(local_err);
Chunyan Liu83d05212014-06-05 17:20:51 +0800328 qemu_opts_free(create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100329 return 1;
330 }
Max Reitzd402b6a2018-05-09 23:00:21 +0200331 if (!proto_drv->create_opts) {
Max Reitzf0998872018-11-19 11:19:20 +0100332 error_report("Protocol driver '%s' does not support image creation",
Max Reitzd402b6a2018-05-09 23:00:21 +0200333 proto_drv->format_name);
Max Reitz3ecd5a42018-11-19 11:19:21 +0100334 qemu_opts_free(create_opts);
Max Reitzd402b6a2018-05-09 23:00:21 +0200335 return 1;
336 }
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800337 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100338 }
339
Max Reitzf4619af2019-04-13 17:20:37 +0200340 if (filename) {
341 printf("Supported options:\n");
342 } else {
343 printf("Supported %s options:\n", fmt);
344 }
Max Reitz63898712018-10-19 18:49:25 +0200345 qemu_opts_print_help(create_opts, false);
Chunyan Liu83d05212014-06-05 17:20:51 +0800346 qemu_opts_free(create_opts);
Max Reitzf4619af2019-04-13 17:20:37 +0200347
348 if (!filename) {
349 printf("\n"
350 "The protocol level may support further options.\n"
351 "Specify the target filename to include those options.\n");
352 }
353
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100354 return 0;
355}
356
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000357
Max Reitzefaa7c42016-03-16 19:54:38 +0100358static BlockBackend *img_open_opts(const char *optstr,
Kevin Wolfce099542016-03-15 13:01:04 +0100359 QemuOpts *opts, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800360 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000361{
362 QDict *options;
363 Error *local_err = NULL;
364 BlockBackend *blk;
365 options = qemu_opts_to_qdict(opts, NULL);
Fam Zheng335e9932017-05-03 00:35:39 +0800366 if (force_share) {
367 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
Max Reitz4615f872018-05-02 22:20:50 +0200368 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
Fam Zheng335e9932017-05-03 00:35:39 +0800369 error_report("--force-share/-U conflicts with image options");
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200370 qobject_unref(options);
Fam Zheng335e9932017-05-03 00:35:39 +0800371 return NULL;
372 }
Max Reitz4615f872018-05-02 22:20:50 +0200373 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
Fam Zheng335e9932017-05-03 00:35:39 +0800374 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100375 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000376 if (!blk) {
Daniel P. Berrange143605a2016-04-06 10:16:18 +0100377 error_reportf_err(local_err, "Could not open '%s': ", optstr);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000378 return NULL;
379 }
Kevin Wolfce099542016-03-15 13:01:04 +0100380 blk_set_enable_write_cache(blk, !writethrough);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000381
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000382 return blk;
383}
384
Max Reitzefaa7c42016-03-16 19:54:38 +0100385static BlockBackend *img_open_file(const char *filename,
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100386 QDict *options,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000387 const char *fmt, int flags,
Fam Zheng335e9932017-05-03 00:35:39 +0800388 bool writethrough, bool quiet,
389 bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000390{
391 BlockBackend *blk;
Max Reitz34b5d2c2013-09-05 14:45:29 +0200392 Error *local_err = NULL;
Kevin Wolfad717132010-12-16 15:37:41 +0100393
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100394 if (!options) {
395 options = qdict_new();
396 }
bellard75c23802004-08-27 21:28:58 +0000397 if (fmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -0500398 qdict_put_str(options, "driver", fmt);
bellard75c23802004-08-27 21:28:58 +0000399 }
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100400
Fam Zheng335e9932017-05-03 00:35:39 +0800401 if (force_share) {
Eric Blake579cf1d2017-05-15 14:54:39 -0500402 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Fam Zheng335e9932017-05-03 00:35:39 +0800403 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100404 blk = blk_new_open(filename, NULL, options, flags, &local_err);
Max Reitz5bd31322015-02-05 13:58:16 -0500405 if (!blk) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100406 error_reportf_err(local_err, "Could not open '%s': ", filename);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000407 return NULL;
bellard75c23802004-08-27 21:28:58 +0000408 }
Kevin Wolfce099542016-03-15 13:01:04 +0100409 blk_set_enable_write_cache(blk, !writethrough);
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100410
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200411 return blk;
bellard75c23802004-08-27 21:28:58 +0000412}
413
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000414
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100415static int img_add_key_secrets(void *opaque,
416 const char *name, const char *value,
417 Error **errp)
418{
419 QDict *options = opaque;
420
421 if (g_str_has_suffix(name, "key-secret")) {
Eric Blake187f47e2017-06-24 12:10:07 -0600422 qdict_put_str(options, name, value);
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100423 }
424
425 return 0;
426}
427
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100428
Max Reitzefaa7c42016-03-16 19:54:38 +0100429static BlockBackend *img_open(bool image_opts,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000430 const char *filename,
Kevin Wolfce099542016-03-15 13:01:04 +0100431 const char *fmt, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800432 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000433{
434 BlockBackend *blk;
435 if (image_opts) {
436 QemuOpts *opts;
437 if (fmt) {
438 error_report("--image-opts and --format are mutually exclusive");
439 return NULL;
440 }
441 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
442 filename, true);
443 if (!opts) {
444 return NULL;
445 }
Fam Zheng335e9932017-05-03 00:35:39 +0800446 blk = img_open_opts(filename, opts, flags, writethrough, quiet,
447 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000448 } else {
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100449 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
Fam Zheng335e9932017-05-03 00:35:39 +0800450 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000451 }
452 return blk;
453}
454
455
Chunyan Liu83d05212014-06-05 17:20:51 +0800456static int add_old_style_options(const char *fmt, QemuOpts *opts,
Jes Sorenseneec77d92010-12-07 17:44:34 +0100457 const char *base_filename,
458 const char *base_fmt)
Kevin Wolfefa84d42009-05-18 16:42:12 +0200459{
Kevin Wolfefa84d42009-05-18 16:42:12 +0200460 if (base_filename) {
Markus Armbruster235e59c2020-07-07 18:05:42 +0200461 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename,
Markus Armbruster9e194e02020-07-07 18:06:11 +0200462 NULL)) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100463 error_report("Backing file not supported for file format '%s'",
464 fmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900465 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200466 }
467 }
468 if (base_fmt) {
Markus Armbruster9e194e02020-07-07 18:06:11 +0200469 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, NULL)) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100470 error_report("Backing file format not supported for file "
471 "format '%s'", fmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900472 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200473 }
474 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900475 return 0;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200476}
477
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300478static int64_t cvtnum_full(const char *name, const char *value, int64_t min,
479 int64_t max)
Markus Armbruster606caa02017-02-21 21:14:04 +0100480{
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100481 int err;
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300482 uint64_t res;
Markus Armbruster606caa02017-02-21 21:14:04 +0100483
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300484 err = qemu_strtosz(value, NULL, &res);
485 if (err < 0 && err != -ERANGE) {
486 error_report("Invalid %s specified. You may use "
487 "k, M, G, T, P or E suffixes for", name);
488 error_report("kilobytes, megabytes, gigabytes, terabytes, "
489 "petabytes and exabytes.");
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100490 return err;
491 }
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300492 if (err == -ERANGE || res > max || res < min) {
493 error_report("Invalid %s specified. Must be between %" PRId64
494 " and %" PRId64 ".", name, min, max);
Markus Armbrusterf46bfdb2017-02-21 21:14:07 +0100495 return -ERANGE;
496 }
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300497 return res;
498}
499
500static int64_t cvtnum(const char *name, const char *value)
501{
502 return cvtnum_full(name, value, 0, INT64_MAX);
Markus Armbruster606caa02017-02-21 21:14:04 +0100503}
504
bellardea2384d2004-08-01 21:59:26 +0000505static int img_create(int argc, char **argv)
506{
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200507 int c;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100508 uint64_t img_size = -1;
bellardea2384d2004-08-01 21:59:26 +0000509 const char *fmt = "raw";
aliguori9230eaf2009-03-28 17:55:19 +0000510 const char *base_fmt = NULL;
bellardea2384d2004-08-01 21:59:26 +0000511 const char *filename;
512 const char *base_filename = NULL;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200513 char *options = NULL;
Luiz Capitulino9b375252012-11-30 10:52:05 -0200514 Error *local_err = NULL;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100515 bool quiet = false;
John Snow6e6e55f2017-07-17 20:34:22 -0400516 int flags = 0;
ths3b46e622007-09-17 08:09:54 +0000517
bellardea2384d2004-08-01 21:59:26 +0000518 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000519 static const struct option long_options[] = {
520 {"help", no_argument, 0, 'h'},
521 {"object", required_argument, 0, OPTION_OBJECT},
522 {0, 0, 0, 0}
523 };
John Snow6e6e55f2017-07-17 20:34:22 -0400524 c = getopt_long(argc, argv, ":F:b:f:ho:qu",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000525 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100526 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000527 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100528 }
bellardea2384d2004-08-01 21:59:26 +0000529 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800530 case ':':
531 missing_argument(argv[optind - 1]);
532 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100533 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800534 unrecognized_option(argv[optind - 1]);
535 break;
bellardea2384d2004-08-01 21:59:26 +0000536 case 'h':
537 help();
538 break;
aliguori9230eaf2009-03-28 17:55:19 +0000539 case 'F':
540 base_fmt = optarg;
541 break;
bellardea2384d2004-08-01 21:59:26 +0000542 case 'b':
543 base_filename = optarg;
544 break;
545 case 'f':
546 fmt = optarg;
547 break;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200548 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +0200549 if (accumulate_options(&options, optarg) < 0) {
Kevin Wolf77386bf2014-02-21 16:24:04 +0100550 goto fail;
551 }
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200552 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100553 case 'q':
554 quiet = true;
555 break;
John Snow6e6e55f2017-07-17 20:34:22 -0400556 case 'u':
557 flags |= BDRV_O_NO_BACKING;
558 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +0100559 case OPTION_OBJECT:
560 user_creatable_process_cmdline(optarg);
561 break;
bellardea2384d2004-08-01 21:59:26 +0000562 }
563 }
aliguori9230eaf2009-03-28 17:55:19 +0000564
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900565 /* Get the filename */
Kevin Wolfa283cb62014-02-21 16:24:07 +0100566 filename = (optind < argc) ? argv[optind] : NULL;
567 if (options && has_help_option(options)) {
568 g_free(options);
569 return print_block_option_help(filename, fmt);
570 }
571
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100572 if (optind >= argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800573 error_exit("Expecting image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100574 }
Kevin Wolfa283cb62014-02-21 16:24:07 +0100575 optind++;
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900576
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100577 /* Get image size, if specified */
578 if (optind < argc) {
Jes Sorensen70b4f4b2011-01-05 11:41:02 +0100579 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +0100580
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300581 sval = cvtnum("image size", argv[optind++]);
Markus Armbruster606caa02017-02-21 21:14:04 +0100582 if (sval < 0) {
Kevin Wolf77386bf2014-02-21 16:24:04 +0100583 goto fail;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100584 }
585 img_size = (uint64_t)sval;
586 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200587 if (optind != argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800588 error_exit("Unexpected argument: %s", argv[optind]);
Kevin Wolffc11eb22013-08-05 10:53:04 +0200589 }
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100590
Luiz Capitulino9b375252012-11-30 10:52:05 -0200591 bdrv_img_create(filename, fmt, base_filename, base_fmt,
John Snow6e6e55f2017-07-17 20:34:22 -0400592 options, img_size, flags, quiet, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100593 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100594 error_reportf_err(local_err, "%s: ", filename);
Kevin Wolf77386bf2014-02-21 16:24:04 +0100595 goto fail;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900596 }
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200597
Kevin Wolf77386bf2014-02-21 16:24:04 +0100598 g_free(options);
bellardea2384d2004-08-01 21:59:26 +0000599 return 0;
Kevin Wolf77386bf2014-02-21 16:24:04 +0100600
601fail:
602 g_free(options);
603 return 1;
bellardea2384d2004-08-01 21:59:26 +0000604}
605
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100606static void dump_json_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500607{
Markus Armbrustereab3a462020-12-11 18:11:37 +0100608 GString *str;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500609 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +0100610 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600611
612 visit_type_ImageCheck(v, NULL, &check, &error_abort);
613 visit_complete(v, &obj);
Markus Armbruster6589f452020-12-11 18:11:35 +0100614 str = qobject_to_json_pretty(obj, true);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500615 assert(str != NULL);
Markus Armbrustereab3a462020-12-11 18:11:37 +0100616 qprintf(quiet, "%s\n", str->str);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200617 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600618 visit_free(v);
Markus Armbrustereab3a462020-12-11 18:11:37 +0100619 g_string_free(str, true);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500620}
621
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100622static void dump_human_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500623{
624 if (!(check->corruptions || check->leaks || check->check_errors)) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100625 qprintf(quiet, "No errors were found on the image.\n");
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500626 } else {
627 if (check->corruptions) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100628 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
629 "Data may be corrupted, or further writes to the image "
630 "may corrupt it.\n",
631 check->corruptions);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500632 }
633
634 if (check->leaks) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100635 qprintf(quiet,
636 "\n%" PRId64 " leaked clusters were found on the image.\n"
637 "This means waste of disk space, but no harm to data.\n",
638 check->leaks);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500639 }
640
641 if (check->check_errors) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100642 qprintf(quiet,
643 "\n%" PRId64
644 " internal errors have occurred during the check.\n",
645 check->check_errors);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500646 }
647 }
648
649 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100650 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
651 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
652 check->allocated_clusters, check->total_clusters,
653 check->allocated_clusters * 100.0 / check->total_clusters,
654 check->fragmented_clusters * 100.0 / check->allocated_clusters,
655 check->compressed_clusters * 100.0 /
656 check->allocated_clusters);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500657 }
658
659 if (check->image_end_offset) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100660 qprintf(quiet,
661 "Image end offset: %" PRId64 "\n", check->image_end_offset);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500662 }
663}
664
665static int collect_image_check(BlockDriverState *bs,
666 ImageCheck *check,
667 const char *filename,
668 const char *fmt,
669 int fix)
670{
671 int ret;
672 BdrvCheckResult result;
673
674 ret = bdrv_check(bs, &result, fix);
675 if (ret < 0) {
676 return ret;
677 }
678
679 check->filename = g_strdup(filename);
680 check->format = g_strdup(bdrv_get_format_name(bs));
681 check->check_errors = result.check_errors;
682 check->corruptions = result.corruptions;
683 check->has_corruptions = result.corruptions != 0;
684 check->leaks = result.leaks;
685 check->has_leaks = result.leaks != 0;
686 check->corruptions_fixed = result.corruptions_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100687 check->has_corruptions_fixed = result.corruptions_fixed != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500688 check->leaks_fixed = result.leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100689 check->has_leaks_fixed = result.leaks_fixed != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500690 check->image_end_offset = result.image_end_offset;
691 check->has_image_end_offset = result.image_end_offset != 0;
692 check->total_clusters = result.bfi.total_clusters;
693 check->has_total_clusters = result.bfi.total_clusters != 0;
694 check->allocated_clusters = result.bfi.allocated_clusters;
695 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
696 check->fragmented_clusters = result.bfi.fragmented_clusters;
697 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
Stefan Hajnoczie6439d72013-02-07 17:15:04 +0100698 check->compressed_clusters = result.bfi.compressed_clusters;
699 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500700
701 return 0;
702}
703
Kevin Wolfe076f332010-06-29 11:43:13 +0200704/*
705 * Checks an image for consistency. Exit codes:
706 *
Max Reitzd6635c42014-06-02 22:15:21 +0200707 * 0 - Check completed, image is good
708 * 1 - Check not completed because of internal errors
709 * 2 - Check completed, image is corrupted
710 * 3 - Check completed, image has leaked clusters, but is good otherwise
711 * 63 - Checks are not supported by the image format
Kevin Wolfe076f332010-06-29 11:43:13 +0200712 */
aliguori15859692009-04-21 23:11:53 +0000713static int img_check(int argc, char **argv)
714{
715 int c, ret;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500716 OutputFormat output_format = OFORMAT_HUMAN;
Max Reitz40055952014-07-22 22:58:42 +0200717 const char *filename, *fmt, *output, *cache;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200718 BlockBackend *blk;
aliguori15859692009-04-21 23:11:53 +0000719 BlockDriverState *bs;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200720 int fix = 0;
Kevin Wolfce099542016-03-15 13:01:04 +0100721 int flags = BDRV_O_CHECK;
722 bool writethrough;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200723 ImageCheck *check;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100724 bool quiet = false;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000725 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +0800726 bool force_share = false;
aliguori15859692009-04-21 23:11:53 +0000727
728 fmt = NULL;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500729 output = NULL;
Max Reitz40055952014-07-22 22:58:42 +0200730 cache = BDRV_DEFAULT_CACHE;
Kevin Wolfce099542016-03-15 13:01:04 +0100731
aliguori15859692009-04-21 23:11:53 +0000732 for(;;) {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500733 int option_index = 0;
734 static const struct option long_options[] = {
735 {"help", no_argument, 0, 'h'},
736 {"format", required_argument, 0, 'f'},
Prasad Joshi4fd6a982014-03-25 00:08:54 +0530737 {"repair", required_argument, 0, 'r'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500738 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000739 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000740 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +0800741 {"force-share", no_argument, 0, 'U'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500742 {0, 0, 0, 0}
743 };
Fam Zheng335e9932017-05-03 00:35:39 +0800744 c = getopt_long(argc, argv, ":hf:r:T:qU",
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500745 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100746 if (c == -1) {
aliguori15859692009-04-21 23:11:53 +0000747 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100748 }
aliguori15859692009-04-21 23:11:53 +0000749 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800750 case ':':
751 missing_argument(argv[optind - 1]);
752 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100753 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800754 unrecognized_option(argv[optind - 1]);
755 break;
aliguori15859692009-04-21 23:11:53 +0000756 case 'h':
757 help();
758 break;
759 case 'f':
760 fmt = optarg;
761 break;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200762 case 'r':
763 flags |= BDRV_O_RDWR;
764
765 if (!strcmp(optarg, "leaks")) {
766 fix = BDRV_FIX_LEAKS;
767 } else if (!strcmp(optarg, "all")) {
768 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
769 } else {
Fam Zhengac1307a2014-04-22 13:36:11 +0800770 error_exit("Unknown option value for -r "
771 "(expecting 'leaks' or 'all'): %s", optarg);
Kevin Wolf4534ff52012-05-11 16:07:02 +0200772 }
773 break;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500774 case OPTION_OUTPUT:
775 output = optarg;
776 break;
Max Reitz40055952014-07-22 22:58:42 +0200777 case 'T':
778 cache = optarg;
779 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100780 case 'q':
781 quiet = true;
782 break;
Fam Zheng335e9932017-05-03 00:35:39 +0800783 case 'U':
784 force_share = true;
785 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +0100786 case OPTION_OBJECT:
787 user_creatable_process_cmdline(optarg);
788 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000789 case OPTION_IMAGE_OPTS:
790 image_opts = true;
791 break;
aliguori15859692009-04-21 23:11:53 +0000792 }
793 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200794 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800795 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100796 }
aliguori15859692009-04-21 23:11:53 +0000797 filename = argv[optind++];
798
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500799 if (output && !strcmp(output, "json")) {
800 output_format = OFORMAT_JSON;
801 } else if (output && !strcmp(output, "human")) {
802 output_format = OFORMAT_HUMAN;
803 } else if (output) {
804 error_report("--output must be used with human or json as argument.");
805 return 1;
806 }
807
Kevin Wolfce099542016-03-15 13:01:04 +0100808 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +0200809 if (ret < 0) {
810 error_report("Invalid source cache option: %s", cache);
811 return 1;
812 }
813
Fam Zheng335e9932017-05-03 00:35:39 +0800814 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
815 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200816 if (!blk) {
817 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900818 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200819 bs = blk_bs(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500820
821 check = g_new0(ImageCheck, 1);
822 ret = collect_image_check(bs, check, filename, fmt, fix);
Kevin Wolfe076f332010-06-29 11:43:13 +0200823
824 if (ret == -ENOTSUP) {
Max Reitz55d492d2014-05-31 21:33:30 +0200825 error_report("This image format does not support checks");
Peter Lievenfefddf92013-10-24 08:53:34 +0200826 ret = 63;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500827 goto fail;
Kevin Wolfe076f332010-06-29 11:43:13 +0200828 }
829
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500830 if (check->corruptions_fixed || check->leaks_fixed) {
831 int corruptions_fixed, leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100832 bool has_leaks_fixed, has_corruptions_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500833
834 leaks_fixed = check->leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100835 has_leaks_fixed = check->has_leaks_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500836 corruptions_fixed = check->corruptions_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100837 has_corruptions_fixed = check->has_corruptions_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500838
839 if (output_format == OFORMAT_HUMAN) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100840 qprintf(quiet,
841 "The following inconsistencies were found and repaired:\n\n"
842 " %" PRId64 " leaked clusters\n"
843 " %" PRId64 " corruptions\n\n"
844 "Double checking the fixed image now...\n",
845 check->leaks_fixed,
846 check->corruptions_fixed);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500847 }
848
Pan Nengyuanfc124ea2020-02-27 09:29:50 +0800849 qapi_free_ImageCheck(check);
850 check = g_new0(ImageCheck, 1);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500851 ret = collect_image_check(bs, check, filename, fmt, 0);
852
853 check->leaks_fixed = leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100854 check->has_leaks_fixed = has_leaks_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500855 check->corruptions_fixed = corruptions_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100856 check->has_corruptions_fixed = has_corruptions_fixed;
Kevin Wolfccf34712012-05-11 18:16:54 +0200857 }
858
Max Reitz832390a2014-10-23 15:29:12 +0200859 if (!ret) {
860 switch (output_format) {
861 case OFORMAT_HUMAN:
862 dump_human_image_check(check, quiet);
863 break;
864 case OFORMAT_JSON:
865 dump_json_image_check(check, quiet);
866 break;
867 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500868 }
869
870 if (ret || check->check_errors) {
Max Reitz832390a2014-10-23 15:29:12 +0200871 if (ret) {
872 error_report("Check failed: %s", strerror(-ret));
873 } else {
874 error_report("Check failed");
875 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500876 ret = 1;
877 goto fail;
878 }
879
880 if (check->corruptions) {
881 ret = 2;
882 } else if (check->leaks) {
883 ret = 3;
Kevin Wolfe076f332010-06-29 11:43:13 +0200884 } else {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500885 ret = 0;
aliguori15859692009-04-21 23:11:53 +0000886 }
887
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500888fail:
889 qapi_free_ImageCheck(check);
Markus Armbruster26f54e92014-10-07 13:59:04 +0200890 blk_unref(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500891 return ret;
aliguori15859692009-04-21 23:11:53 +0000892}
893
Max Reitzd4a32382014-10-24 15:57:37 +0200894typedef struct CommonBlockJobCBInfo {
895 BlockDriverState *bs;
896 Error **errp;
897} CommonBlockJobCBInfo;
898
899static void common_block_job_cb(void *opaque, int ret)
900{
901 CommonBlockJobCBInfo *cbi = opaque;
902
903 if (ret < 0) {
904 error_setg_errno(cbi->errp, -ret, "Block job failed");
905 }
Max Reitzd4a32382014-10-24 15:57:37 +0200906}
907
908static void run_block_job(BlockJob *job, Error **errp)
909{
Emanuele Giuseppe Espositoa7b4f8f2021-06-14 10:11:29 +0200910 uint64_t progress_current, progress_total;
Vladimir Sementsov-Ogievskiydf9a3162021-05-06 17:13:53 +0300911 AioContext *aio_context = block_job_get_aio_context(job);
sochin.jiang4172a002017-06-15 14:47:33 +0800912 int ret = 0;
Max Reitzd4a32382014-10-24 15:57:37 +0200913
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -0400914 job_lock();
915 job_ref_locked(&job->job);
Max Reitzd4a32382014-10-24 15:57:37 +0200916 do {
Kevin Wolf30a5c882018-05-04 12:17:20 +0200917 float progress = 0.0f;
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -0400918 job_unlock();
Max Reitzd4a32382014-10-24 15:57:37 +0200919 aio_poll(aio_context, true);
Emanuele Giuseppe Espositoa7b4f8f2021-06-14 10:11:29 +0200920
921 progress_get_snapshot(&job->job.progress, &progress_current,
922 &progress_total);
923 if (progress_total) {
924 progress = (float)progress_current / progress_total * 100.f;
Kevin Wolf30a5c882018-05-04 12:17:20 +0200925 }
926 qemu_progress_print(progress, 0);
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -0400927 job_lock();
928 } while (!job_is_ready_locked(&job->job) &&
929 !job_is_completed_locked(&job->job));
Max Reitzd4a32382014-10-24 15:57:37 +0200930
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -0400931 if (!job_is_completed_locked(&job->job)) {
932 ret = job_complete_sync_locked(&job->job, errp);
sochin.jiang4172a002017-06-15 14:47:33 +0800933 } else {
Kevin Wolf4ad35182018-04-19 17:30:16 +0200934 ret = job->job.ret;
sochin.jiang4172a002017-06-15 14:47:33 +0800935 }
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -0400936 job_unref_locked(&job->job);
937 job_unlock();
Max Reitz687fa1d2014-10-24 15:57:39 +0200938
sochin.jiang4172a002017-06-15 14:47:33 +0800939 /* publish completion progress only when success */
940 if (!ret) {
941 qemu_progress_print(100.f, 0);
942 }
Max Reitzd4a32382014-10-24 15:57:37 +0200943}
944
bellardea2384d2004-08-01 21:59:26 +0000945static int img_commit(int argc, char **argv)
946{
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400947 int c, ret, flags;
Max Reitz1b22bff2014-10-24 15:57:40 +0200948 const char *filename, *fmt, *cache, *base;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200949 BlockBackend *blk;
Max Reitzd4a32382014-10-24 15:57:37 +0200950 BlockDriverState *bs, *base_bs;
Kevin Wolf4ef85a92017-01-25 19:16:34 +0100951 BlockJob *job;
Max Reitz687fa1d2014-10-24 15:57:39 +0200952 bool progress = false, quiet = false, drop = false;
Kevin Wolfce099542016-03-15 13:01:04 +0100953 bool writethrough;
Max Reitzd4a32382014-10-24 15:57:37 +0200954 Error *local_err = NULL;
955 CommonBlockJobCBInfo cbi;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000956 bool image_opts = false;
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200957 AioContext *aio_context;
Zhenguia0441b62020-10-20 14:47:43 +0000958 int64_t rate_limit = 0;
bellardea2384d2004-08-01 21:59:26 +0000959
960 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400961 cache = BDRV_DEFAULT_CACHE;
Max Reitz1b22bff2014-10-24 15:57:40 +0200962 base = NULL;
bellardea2384d2004-08-01 21:59:26 +0000963 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000964 static const struct option long_options[] = {
965 {"help", no_argument, 0, 'h'},
966 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000967 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000968 {0, 0, 0, 0}
969 };
Zhenguia0441b62020-10-20 14:47:43 +0000970 c = getopt_long(argc, argv, ":f:ht:b:dpqr:",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000971 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100972 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000973 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100974 }
bellardea2384d2004-08-01 21:59:26 +0000975 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800976 case ':':
977 missing_argument(argv[optind - 1]);
978 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100979 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800980 unrecognized_option(argv[optind - 1]);
981 break;
bellardea2384d2004-08-01 21:59:26 +0000982 case 'h':
983 help();
984 break;
985 case 'f':
986 fmt = optarg;
987 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400988 case 't':
989 cache = optarg;
990 break;
Max Reitz1b22bff2014-10-24 15:57:40 +0200991 case 'b':
992 base = optarg;
993 /* -b implies -d */
994 drop = true;
995 break;
Max Reitz9a86fe42014-10-24 15:57:38 +0200996 case 'd':
997 drop = true;
998 break;
Max Reitz687fa1d2014-10-24 15:57:39 +0200999 case 'p':
1000 progress = true;
1001 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01001002 case 'q':
1003 quiet = true;
1004 break;
Zhenguia0441b62020-10-20 14:47:43 +00001005 case 'r':
1006 rate_limit = cvtnum("rate limit", optarg);
1007 if (rate_limit < 0) {
1008 return 1;
1009 }
1010 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01001011 case OPTION_OBJECT:
1012 user_creatable_process_cmdline(optarg);
1013 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001014 case OPTION_IMAGE_OPTS:
1015 image_opts = true;
1016 break;
bellardea2384d2004-08-01 21:59:26 +00001017 }
1018 }
Max Reitz687fa1d2014-10-24 15:57:39 +02001019
1020 /* Progress is not shown in Quiet mode */
1021 if (quiet) {
1022 progress = false;
1023 }
1024
Kevin Wolffc11eb22013-08-05 10:53:04 +02001025 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001026 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01001027 }
bellardea2384d2004-08-01 21:59:26 +00001028 filename = argv[optind++];
1029
Max Reitz9a86fe42014-10-24 15:57:38 +02001030 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
Kevin Wolfce099542016-03-15 13:01:04 +01001031 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001032 if (ret < 0) {
1033 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczia3981eb2014-08-26 19:17:54 +01001034 return 1;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001035 }
1036
Fam Zheng335e9932017-05-03 00:35:39 +08001037 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
1038 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001039 if (!blk) {
1040 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001041 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001042 bs = blk_bs(blk);
1043
Max Reitz687fa1d2014-10-24 15:57:39 +02001044 qemu_progress_init(progress, 1.f);
1045 qemu_progress_print(0.f, 100);
1046
Max Reitz1b22bff2014-10-24 15:57:40 +02001047 if (base) {
1048 base_bs = bdrv_find_backing_image(bs, base);
1049 if (!base_bs) {
Max Reitz6b33f3a2016-12-01 03:05:08 +01001050 error_setg(&local_err,
1051 "Did not find '%s' in the backing chain of '%s'",
1052 base, filename);
Max Reitz1b22bff2014-10-24 15:57:40 +02001053 goto done;
1054 }
1055 } else {
1056 /* This is different from QMP, which by default uses the deepest file in
1057 * the backing chain (i.e., the very base); however, the traditional
1058 * behavior of qemu-img commit is using the immediate backing file. */
Max Reitz4a2061e2019-06-12 19:00:30 +02001059 base_bs = bdrv_backing_chain_next(bs);
Max Reitz1b22bff2014-10-24 15:57:40 +02001060 if (!base_bs) {
1061 error_setg(&local_err, "Image does not have a backing file");
1062 goto done;
1063 }
bellardea2384d2004-08-01 21:59:26 +00001064 }
1065
Max Reitzd4a32382014-10-24 15:57:37 +02001066 cbi = (CommonBlockJobCBInfo){
1067 .errp = &local_err,
1068 .bs = bs,
1069 };
1070
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001071 aio_context = bdrv_get_aio_context(bs);
1072 aio_context_acquire(aio_context);
Zhenguia0441b62020-10-20 14:47:43 +00001073 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, rate_limit,
Kevin Wolf0db832f2017-02-20 18:10:05 +01001074 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
Fam Zheng78bbd912017-04-21 20:27:04 +08001075 &cbi, false, &local_err);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001076 aio_context_release(aio_context);
Max Reitzd4a32382014-10-24 15:57:37 +02001077 if (local_err) {
1078 goto done;
1079 }
1080
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001081 /* When the block job completes, the BlockBackend reference will point to
1082 * the old backing file. In order to avoid that the top image is already
1083 * deleted, so we can still empty it afterwards, increment the reference
1084 * counter here preemptively. */
Max Reitz9a86fe42014-10-24 15:57:38 +02001085 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001086 bdrv_ref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001087 }
1088
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001089 job = block_job_get("commit");
Liam Merwick2e2db262018-11-05 21:38:37 +00001090 assert(job);
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001091 run_block_job(job, &local_err);
Max Reitz9a86fe42014-10-24 15:57:38 +02001092 if (local_err) {
1093 goto unref_backing;
1094 }
1095
Max Reitz2d97fde2020-04-29 16:11:26 +02001096 if (!drop) {
1097 BlockBackend *old_backing_blk;
1098
1099 old_backing_blk = blk_new_with_bs(bs, BLK_PERM_WRITE, BLK_PERM_ALL,
1100 &local_err);
1101 if (!old_backing_blk) {
1102 goto unref_backing;
1103 }
1104 ret = blk_make_empty(old_backing_blk, &local_err);
1105 blk_unref(old_backing_blk);
1106 if (ret == -ENOTSUP) {
1107 error_free(local_err);
1108 local_err = NULL;
1109 } else if (ret < 0) {
Max Reitz9a86fe42014-10-24 15:57:38 +02001110 goto unref_backing;
1111 }
1112 }
1113
1114unref_backing:
1115 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001116 bdrv_unref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001117 }
Max Reitzd4a32382014-10-24 15:57:37 +02001118
1119done:
Max Reitz687fa1d2014-10-24 15:57:39 +02001120 qemu_progress_end();
1121
Markus Armbruster26f54e92014-10-07 13:59:04 +02001122 blk_unref(blk);
Max Reitzd4a32382014-10-24 15:57:37 +02001123
1124 if (local_err) {
Markus Armbruster6936f292015-02-10 15:14:02 +01001125 error_report_err(local_err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001126 return 1;
1127 }
Max Reitzd4a32382014-10-24 15:57:37 +02001128
1129 qprintf(quiet, "Image committed.\n");
bellardea2384d2004-08-01 21:59:26 +00001130 return 0;
1131}
1132
Dmitry Konishchevf6a00aa2011-05-18 15:03:59 +04001133/*
Eric Blakedebb38a2017-10-11 22:47:11 -05001134 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1135 * of the first sector boundary within buf where the sector contains a
1136 * non-zero byte. This function is robust to a buffer that is not
1137 * sector-aligned.
1138 */
1139static int64_t find_nonzero(const uint8_t *buf, int64_t n)
1140{
1141 int64_t i;
1142 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);
1143
1144 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
1145 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
1146 return i;
1147 }
1148 }
1149 if (i < n && !buffer_is_zero(buf + i, n - end)) {
1150 return i;
1151 }
1152 return -1;
1153}
1154
1155/*
thsf58c7b32008-06-05 21:53:49 +00001156 * Returns true iff the first sector pointed to by 'buf' contains at least
1157 * a non-NUL byte.
1158 *
1159 * 'pnum' is set to the number of sectors (including and immediately following
1160 * the first one) that are known to be in the same allocated/unallocated state.
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001161 * The function will try to align the end offset to alignment boundaries so
zhaolichange3a6e0d2020-09-17 15:50:20 +08001162 * that the request will at least end aligned and consecutive requests will
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001163 * also start at an aligned offset.
thsf58c7b32008-06-05 21:53:49 +00001164 */
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001165static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
1166 int64_t sector_num, int alignment)
bellardea2384d2004-08-01 21:59:26 +00001167{
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001168 bool is_zero;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001169 int i, tail;
bellardea2384d2004-08-01 21:59:26 +00001170
1171 if (n <= 0) {
1172 *pnum = 0;
1173 return 0;
1174 }
Yi Lic075c422020-08-19 09:36:07 +08001175 is_zero = buffer_is_zero(buf, BDRV_SECTOR_SIZE);
bellardea2384d2004-08-01 21:59:26 +00001176 for(i = 1; i < n; i++) {
Yi Lic075c422020-08-19 09:36:07 +08001177 buf += BDRV_SECTOR_SIZE;
1178 if (is_zero != buffer_is_zero(buf, BDRV_SECTOR_SIZE)) {
bellardea2384d2004-08-01 21:59:26 +00001179 break;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001180 }
bellardea2384d2004-08-01 21:59:26 +00001181 }
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001182
Vladimir Sementsov-Ogievskiy96054c72021-12-17 17:46:54 +01001183 if (i == n) {
1184 /*
1185 * The whole buf is the same.
1186 * No reason to split it into chunks, so return now.
1187 */
1188 *pnum = i;
1189 return !is_zero;
1190 }
1191
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001192 tail = (sector_num + i) & (alignment - 1);
1193 if (tail) {
1194 if (is_zero && i <= tail) {
Vladimir Sementsov-Ogievskiy96054c72021-12-17 17:46:54 +01001195 /*
1196 * For sure next sector after i is data, and it will rewrite this
1197 * tail anyway due to RMW. So, let's just write data now.
1198 */
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001199 is_zero = false;
1200 }
1201 if (!is_zero) {
Vladimir Sementsov-Ogievskiy96054c72021-12-17 17:46:54 +01001202 /* If possible, align up end offset of allocated areas. */
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001203 i += alignment - tail;
1204 i = MIN(i, n);
1205 } else {
Vladimir Sementsov-Ogievskiy96054c72021-12-17 17:46:54 +01001206 /*
1207 * For sure next sector after i is data, and it will rewrite this
1208 * tail anyway due to RMW. Better is avoid RMW and write zeroes up
1209 * to aligned bound.
1210 */
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001211 i -= tail;
1212 }
1213 }
bellardea2384d2004-08-01 21:59:26 +00001214 *pnum = i;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001215 return !is_zero;
bellardea2384d2004-08-01 21:59:26 +00001216}
1217
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001218/*
Kevin Wolfa22f1232011-08-26 15:27:13 +02001219 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1220 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1221 * breaking up write requests for only small sparse areas.
1222 */
1223static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001224 int min, int64_t sector_num, int alignment)
Kevin Wolfa22f1232011-08-26 15:27:13 +02001225{
1226 int ret;
1227 int num_checked, num_used;
1228
1229 if (n < min) {
1230 min = n;
1231 }
1232
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001233 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001234 if (!ret) {
1235 return ret;
1236 }
1237
1238 num_used = *pnum;
1239 buf += BDRV_SECTOR_SIZE * *pnum;
1240 n -= *pnum;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001241 sector_num += *pnum;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001242 num_checked = num_used;
1243
1244 while (n > 0) {
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001245 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001246
1247 buf += BDRV_SECTOR_SIZE * *pnum;
1248 n -= *pnum;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001249 sector_num += *pnum;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001250 num_checked += *pnum;
1251 if (ret) {
1252 num_used = num_checked;
1253 } else if (*pnum >= min) {
1254 break;
1255 }
1256 }
1257
1258 *pnum = num_used;
1259 return 1;
1260}
1261
1262/*
Eric Blakedc61cd32017-10-11 22:47:14 -05001263 * Compares two buffers sector by sector. Returns 0 if the first
1264 * sector of each buffer matches, non-zero otherwise.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001265 *
Eric Blakedc61cd32017-10-11 22:47:14 -05001266 * pnum is set to the sector-aligned size of the buffer prefix that
1267 * has the same matching status as the first sector.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001268 */
Eric Blakedc61cd32017-10-11 22:47:14 -05001269static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
1270 int64_t bytes, int64_t *pnum)
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001271{
Radim Krčmář8c1ac472015-02-20 17:06:15 +01001272 bool res;
Eric Blakedc61cd32017-10-11 22:47:14 -05001273 int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001274
Eric Blakedc61cd32017-10-11 22:47:14 -05001275 assert(bytes > 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001276
Eric Blakedc61cd32017-10-11 22:47:14 -05001277 res = !!memcmp(buf1, buf2, i);
1278 while (i < bytes) {
1279 int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001280
Eric Blakedc61cd32017-10-11 22:47:14 -05001281 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001282 break;
1283 }
Eric Blakedc61cd32017-10-11 22:47:14 -05001284 i += len;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001285 }
1286
1287 *pnum = i;
1288 return res;
1289}
1290
Stefano Garzarella97ede572019-05-08 12:43:24 +02001291#define IO_BUF_SIZE (2 * MiB)
bellardea2384d2004-08-01 21:59:26 +00001292
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001293/*
1294 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1295 *
Eric Blake0608e402017-10-11 22:47:12 -05001296 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1297 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1298 * failure), and 4 on error (the exit status for read errors), after emitting
1299 * an error message.
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001300 *
Max Reitzf1d3cd72015-02-05 13:58:18 -05001301 * @param blk: BlockBackend for the image
Eric Blakec41508e2017-10-11 22:47:13 -05001302 * @param offset: Starting offset to check
1303 * @param bytes: Number of bytes to check
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001304 * @param filename: Name of disk file we are checking (logging purpose)
1305 * @param buffer: Allocated buffer for storing read data
1306 * @param quiet: Flag for quiet mode
1307 */
Eric Blakec41508e2017-10-11 22:47:13 -05001308static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1309 int64_t bytes, const char *filename,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001310 uint8_t *buffer, bool quiet)
1311{
Eric Blakedebb38a2017-10-11 22:47:11 -05001312 int ret = 0;
1313 int64_t idx;
1314
Alberto Fariaa9262f52022-07-05 17:15:11 +01001315 ret = blk_pread(blk, offset, bytes, buffer, 0);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001316 if (ret < 0) {
1317 error_report("Error while reading offset %" PRId64 " of %s: %s",
Eric Blakec41508e2017-10-11 22:47:13 -05001318 offset, filename, strerror(-ret));
Eric Blake0608e402017-10-11 22:47:12 -05001319 return 4;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001320 }
Eric Blakec41508e2017-10-11 22:47:13 -05001321 idx = find_nonzero(buffer, bytes);
Eric Blakedebb38a2017-10-11 22:47:11 -05001322 if (idx >= 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001323 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blakec41508e2017-10-11 22:47:13 -05001324 offset + idx);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001325 return 1;
1326 }
1327
1328 return 0;
1329}
1330
1331/*
1332 * Compares two images. Exit codes:
1333 *
Kevin Wolf99b1e642021-02-17 12:56:45 +01001334 * 0 - Images are identical or the requested help was printed
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001335 * 1 - Images differ
1336 * >1 - Error occurred
1337 */
1338static int img_compare(int argc, char **argv)
1339{
Max Reitz40055952014-07-22 22:58:42 +02001340 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001341 BlockBackend *blk1, *blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001342 BlockDriverState *bs1, *bs2;
Eric Blake033d9fc2017-10-11 22:47:16 -05001343 int64_t total_size1, total_size2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001344 uint8_t *buf1 = NULL, *buf2 = NULL;
Eric Blake31826642017-10-11 22:47:08 -05001345 int64_t pnum1, pnum2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001346 int allocated1, allocated2;
1347 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1348 bool progress = false, quiet = false, strict = false;
Max Reitz40055952014-07-22 22:58:42 +02001349 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01001350 bool writethrough;
Eric Blake033d9fc2017-10-11 22:47:16 -05001351 int64_t total_size;
1352 int64_t offset = 0;
1353 int64_t chunk;
Eric Blakedc61cd32017-10-11 22:47:14 -05001354 int c;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001355 uint64_t progress_base;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001356 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08001357 bool force_share = false;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001358
Max Reitz40055952014-07-22 22:58:42 +02001359 cache = BDRV_DEFAULT_CACHE;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001360 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001361 static const struct option long_options[] = {
1362 {"help", no_argument, 0, 'h'},
1363 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001364 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08001365 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001366 {0, 0, 0, 0}
1367 };
Fam Zheng335e9932017-05-03 00:35:39 +08001368 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001369 long_options, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001370 if (c == -1) {
1371 break;
1372 }
1373 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001374 case ':':
1375 missing_argument(argv[optind - 1]);
1376 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001377 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001378 unrecognized_option(argv[optind - 1]);
1379 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001380 case 'h':
1381 help();
1382 break;
1383 case 'f':
1384 fmt1 = optarg;
1385 break;
1386 case 'F':
1387 fmt2 = optarg;
1388 break;
Max Reitz40055952014-07-22 22:58:42 +02001389 case 'T':
1390 cache = optarg;
1391 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001392 case 'p':
1393 progress = true;
1394 break;
1395 case 'q':
1396 quiet = true;
1397 break;
1398 case 's':
1399 strict = true;
1400 break;
Fam Zheng335e9932017-05-03 00:35:39 +08001401 case 'U':
1402 force_share = true;
1403 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01001404 case OPTION_OBJECT:
1405 {
1406 Error *local_err = NULL;
1407
1408 if (!user_creatable_add_from_str(optarg, &local_err)) {
1409 if (local_err) {
1410 error_report_err(local_err);
1411 exit(2);
1412 } else {
1413 /* Help was printed */
1414 exit(EXIT_SUCCESS);
1415 }
1416 }
1417 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001418 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001419 case OPTION_IMAGE_OPTS:
1420 image_opts = true;
1421 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001422 }
1423 }
1424
1425 /* Progress is not shown in Quiet mode */
1426 if (quiet) {
1427 progress = false;
1428 }
1429
1430
Kevin Wolffc11eb22013-08-05 10:53:04 +02001431 if (optind != argc - 2) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001432 error_exit("Expecting two image file names");
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001433 }
1434 filename1 = argv[optind++];
1435 filename2 = argv[optind++];
1436
Stefan Hajnoczicbda0162014-08-26 19:17:55 +01001437 /* Initialize before goto out */
1438 qemu_progress_init(progress, 2.0);
1439
Kevin Wolfce099542016-03-15 13:01:04 +01001440 flags = 0;
1441 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +02001442 if (ret < 0) {
1443 error_report("Invalid source cache option: %s", cache);
1444 ret = 2;
1445 goto out3;
1446 }
1447
Fam Zheng335e9932017-05-03 00:35:39 +08001448 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1449 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001450 if (!blk1) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001451 ret = 2;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001452 goto out3;
1453 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001454
Fam Zheng335e9932017-05-03 00:35:39 +08001455 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1456 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001457 if (!blk2) {
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001458 ret = 2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001459 goto out2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001460 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001461 bs1 = blk_bs(blk1);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001462 bs2 = blk_bs(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001463
Max Reitzf1d3cd72015-02-05 13:58:18 -05001464 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1465 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
Eric Blake033d9fc2017-10-11 22:47:16 -05001466 total_size1 = blk_getlength(blk1);
1467 if (total_size1 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001468 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001469 filename1, strerror(-total_size1));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001470 ret = 4;
1471 goto out;
1472 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001473 total_size2 = blk_getlength(blk2);
1474 if (total_size2 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001475 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001476 filename2, strerror(-total_size2));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001477 ret = 4;
1478 goto out;
1479 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001480 total_size = MIN(total_size1, total_size2);
1481 progress_base = MAX(total_size1, total_size2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001482
1483 qemu_progress_print(0, 100);
1484
Eric Blake033d9fc2017-10-11 22:47:16 -05001485 if (strict && total_size1 != total_size2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001486 ret = 1;
1487 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1488 goto out;
1489 }
1490
Eric Blake033d9fc2017-10-11 22:47:16 -05001491 while (offset < total_size) {
Eric Blake31826642017-10-11 22:47:08 -05001492 int status1, status2;
Fam Zheng67a0fd22016-01-26 11:58:48 +08001493
Eric Blake033d9fc2017-10-11 22:47:16 -05001494 status1 = bdrv_block_status_above(bs1, NULL, offset,
1495 total_size1 - offset, &pnum1, NULL,
1496 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001497 if (status1 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001498 ret = 3;
1499 error_report("Sector allocation test failed for %s", filename1);
1500 goto out;
1501 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001502 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001503
Eric Blake033d9fc2017-10-11 22:47:16 -05001504 status2 = bdrv_block_status_above(bs2, NULL, offset,
1505 total_size2 - offset, &pnum2, NULL,
1506 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001507 if (status2 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001508 ret = 3;
1509 error_report("Sector allocation test failed for %s", filename2);
1510 goto out;
1511 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001512 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
Eric Blake7daddc62017-10-11 22:47:09 -05001513
1514 assert(pnum1 && pnum2);
Eric Blake033d9fc2017-10-11 22:47:16 -05001515 chunk = MIN(pnum1, pnum2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001516
Fam Zheng25ad8e62016-01-13 16:37:41 +08001517 if (strict) {
Eric Blake31826642017-10-11 22:47:08 -05001518 if (status1 != status2) {
Fam Zheng25ad8e62016-01-13 16:37:41 +08001519 ret = 1;
1520 qprintf(quiet, "Strict mode: Offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001521 " block status mismatch!\n", offset);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001522 goto out;
1523 }
1524 }
1525 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
Eric Blake7daddc62017-10-11 22:47:09 -05001526 /* nothing to do */
Fam Zheng25ad8e62016-01-13 16:37:41 +08001527 } else if (allocated1 == allocated2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001528 if (allocated1) {
Eric Blakedc61cd32017-10-11 22:47:14 -05001529 int64_t pnum;
1530
Eric Blake033d9fc2017-10-11 22:47:16 -05001531 chunk = MIN(chunk, IO_BUF_SIZE);
Alberto Fariaa9262f52022-07-05 17:15:11 +01001532 ret = blk_pread(blk1, offset, chunk, buf1, 0);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001533 if (ret < 0) {
1534 error_report("Error while reading offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001535 " of %s: %s",
1536 offset, filename1, strerror(-ret));
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001537 ret = 4;
1538 goto out;
1539 }
Alberto Fariaa9262f52022-07-05 17:15:11 +01001540 ret = blk_pread(blk2, offset, chunk, buf2, 0);
Eric Blake033d9fc2017-10-11 22:47:16 -05001541 if (ret < 0) {
1542 error_report("Error while reading offset %" PRId64
1543 " of %s: %s",
1544 offset, filename2, strerror(-ret));
1545 ret = 4;
1546 goto out;
1547 }
1548 ret = compare_buffers(buf1, buf2, chunk, &pnum);
1549 if (ret || pnum != chunk) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001550 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blake033d9fc2017-10-11 22:47:16 -05001551 offset + (ret ? 0 : pnum));
Fam Zheng36452f12013-11-13 20:26:49 +08001552 ret = 1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001553 goto out;
1554 }
1555 }
1556 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001557 chunk = MIN(chunk, IO_BUF_SIZE);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001558 if (allocated1) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001559 ret = check_empty_sectors(blk1, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001560 filename1, buf1, quiet);
1561 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001562 ret = check_empty_sectors(blk2, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001563 filename2, buf1, quiet);
1564 }
1565 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001566 goto out;
1567 }
1568 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001569 offset += chunk;
1570 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001571 }
1572
Eric Blake033d9fc2017-10-11 22:47:16 -05001573 if (total_size1 != total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001574 BlockBackend *blk_over;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001575 const char *filename_over;
1576
1577 qprintf(quiet, "Warning: Image size mismatch!\n");
Eric Blake033d9fc2017-10-11 22:47:16 -05001578 if (total_size1 > total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001579 blk_over = blk1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001580 filename_over = filename1;
1581 } else {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001582 blk_over = blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001583 filename_over = filename2;
1584 }
1585
Eric Blake033d9fc2017-10-11 22:47:16 -05001586 while (offset < progress_base) {
1587 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1588 progress_base - offset, &chunk,
1589 NULL, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001590 if (ret < 0) {
1591 ret = 3;
1592 error_report("Sector allocation test failed for %s",
1593 filename_over);
1594 goto out;
1595
1596 }
Eric Blake391cb1a2017-10-11 22:47:10 -05001597 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001598 chunk = MIN(chunk, IO_BUF_SIZE);
1599 ret = check_empty_sectors(blk_over, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001600 filename_over, buf1, quiet);
1601 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001602 goto out;
1603 }
1604 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001605 offset += chunk;
1606 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001607 }
1608 }
1609
1610 qprintf(quiet, "Images are identical.\n");
1611 ret = 0;
1612
1613out:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001614 qemu_vfree(buf1);
1615 qemu_vfree(buf2);
Markus Armbruster26f54e92014-10-07 13:59:04 +02001616 blk_unref(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001617out2:
Markus Armbruster26f54e92014-10-07 13:59:04 +02001618 blk_unref(blk1);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001619out3:
1620 qemu_progress_end();
1621 return ret;
1622}
1623
Eric Blake6c729dd2020-05-21 14:21:35 -05001624/* Convenience wrapper around qmp_block_dirty_bitmap_merge */
1625static void do_dirty_bitmap_merge(const char *dst_node, const char *dst_name,
1626 const char *src_node, const char *src_name,
1627 Error **errp)
1628{
Vladimir Sementsov-Ogievskiy1466ef62022-03-15 00:32:24 +03001629 BlockDirtyBitmapOrStr *merge_src;
1630 BlockDirtyBitmapOrStrList *list = NULL;
Eric Blake6c729dd2020-05-21 14:21:35 -05001631
Vladimir Sementsov-Ogievskiy1466ef62022-03-15 00:32:24 +03001632 merge_src = g_new0(BlockDirtyBitmapOrStr, 1);
Eric Blake6c729dd2020-05-21 14:21:35 -05001633 merge_src->type = QTYPE_QDICT;
1634 merge_src->u.external.node = g_strdup(src_node);
1635 merge_src->u.external.name = g_strdup(src_name);
Eric Blake54aa3de2020-11-12 19:13:37 -06001636 QAPI_LIST_PREPEND(list, merge_src);
Eric Blake6c729dd2020-05-21 14:21:35 -05001637 qmp_block_dirty_bitmap_merge(dst_node, dst_name, list, errp);
Vladimir Sementsov-Ogievskiy1466ef62022-03-15 00:32:24 +03001638 qapi_free_BlockDirtyBitmapOrStrList(list);
Eric Blake6c729dd2020-05-21 14:21:35 -05001639}
1640
Kevin Wolf690c7302015-03-19 13:33:32 +01001641enum ImgConvertBlockStatus {
1642 BLK_DATA,
1643 BLK_ZERO,
1644 BLK_BACKING_FILE,
1645};
1646
Peter Lieven2d9187b2017-02-28 13:40:07 +01001647#define MAX_COROUTINES 16
Zhengui0c8c4892020-10-20 14:47:44 +00001648#define CONVERT_THROTTLE_GROUP "img_convert"
Peter Lieven2d9187b2017-02-28 13:40:07 +01001649
Kevin Wolf690c7302015-03-19 13:33:32 +01001650typedef struct ImgConvertState {
1651 BlockBackend **src;
1652 int64_t *src_sectors;
Peter Lievenaf8d43d2020-09-01 14:51:29 +02001653 int *src_alignment;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001654 int src_num;
Kevin Wolf690c7302015-03-19 13:33:32 +01001655 int64_t total_sectors;
1656 int64_t allocated_sectors;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001657 int64_t allocated_done;
1658 int64_t sector_num;
1659 int64_t wr_offs;
Kevin Wolf690c7302015-03-19 13:33:32 +01001660 enum ImgConvertBlockStatus status;
1661 int64_t sector_next_status;
1662 BlockBackend *target;
1663 bool has_zero_init;
1664 bool compressed;
Max Reitz4d7c4872019-07-24 19:12:29 +02001665 bool target_is_new;
Kevin Wolf690c7302015-03-19 13:33:32 +01001666 bool target_has_backing;
Max Reitz351c8ef2018-05-01 18:57:49 +02001667 int64_t target_backing_sectors; /* negative if unknown */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001668 bool wr_in_order;
Fam Zhengee5306d2018-06-01 17:26:48 +08001669 bool copy_range;
Max Reitz8eaac022019-05-07 22:35:03 +02001670 bool salvage;
Max Reitz3d96cb92019-05-07 22:35:02 +02001671 bool quiet;
Kevin Wolf690c7302015-03-19 13:33:32 +01001672 int min_sparse;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001673 int alignment;
Kevin Wolf690c7302015-03-19 13:33:32 +01001674 size_t cluster_sectors;
1675 size_t buf_sectors;
Peter Lieven9fd77f92017-04-21 11:11:55 +02001676 long num_coroutines;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001677 int running_coroutines;
1678 Coroutine *co[MAX_COROUTINES];
1679 int64_t wait_sector_num[MAX_COROUTINES];
1680 CoMutex lock;
1681 int ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001682} ImgConvertState;
1683
Peter Lieven2d9187b2017-02-28 13:40:07 +01001684static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1685 int *src_cur, int64_t *src_cur_offset)
Kevin Wolf690c7302015-03-19 13:33:32 +01001686{
Peter Lieven2d9187b2017-02-28 13:40:07 +01001687 *src_cur = 0;
1688 *src_cur_offset = 0;
1689 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1690 *src_cur_offset += s->src_sectors[*src_cur];
1691 (*src_cur)++;
1692 assert(*src_cur < s->src_num);
Kevin Wolf690c7302015-03-19 13:33:32 +01001693 }
1694}
1695
1696static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1697{
Eric Blake31826642017-10-11 22:47:08 -05001698 int64_t src_cur_offset;
1699 int ret, n, src_cur;
Max Reitz351c8ef2018-05-01 18:57:49 +02001700 bool post_backing_zero = false;
Kevin Wolf690c7302015-03-19 13:33:32 +01001701
Peter Lieven2d9187b2017-02-28 13:40:07 +01001702 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
Kevin Wolf690c7302015-03-19 13:33:32 +01001703
1704 assert(s->total_sectors > sector_num);
1705 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1706
Max Reitz351c8ef2018-05-01 18:57:49 +02001707 if (s->target_backing_sectors >= 0) {
1708 if (sector_num >= s->target_backing_sectors) {
Vladimir Sementsov-Ogievskiy2253d862020-05-28 12:43:56 +03001709 post_backing_zero = true;
Max Reitz351c8ef2018-05-01 18:57:49 +02001710 } else if (sector_num + n > s->target_backing_sectors) {
1711 /* Split requests around target_backing_sectors (because
1712 * starting from there, zeros are handled differently) */
1713 n = s->target_backing_sectors - sector_num;
1714 }
1715 }
1716
Kevin Wolf690c7302015-03-19 13:33:32 +01001717 if (s->sector_next_status <= sector_num) {
Max Reitz8eaac022019-05-07 22:35:03 +02001718 uint64_t offset = (sector_num - src_cur_offset) * BDRV_SECTOR_SIZE;
1719 int64_t count;
Peter Lievenaf8d43d2020-09-01 14:51:29 +02001720 int tail;
Max Reitz4a2061e2019-06-12 19:00:30 +02001721 BlockDriverState *src_bs = blk_bs(s->src[src_cur]);
1722 BlockDriverState *base;
1723
1724 if (s->target_has_backing) {
1725 base = bdrv_cow_bs(bdrv_skip_filters(src_bs));
1726 } else {
1727 base = NULL;
1728 }
Eric Blake31826642017-10-11 22:47:08 -05001729
Max Reitz8eaac022019-05-07 22:35:03 +02001730 do {
1731 count = n * BDRV_SECTOR_SIZE;
Eric Blake237d78f2017-10-11 22:47:03 -05001732
Max Reitz4a2061e2019-06-12 19:00:30 +02001733 ret = bdrv_block_status_above(src_bs, base, offset, count, &count,
1734 NULL, NULL);
Max Reitz8eaac022019-05-07 22:35:03 +02001735
1736 if (ret < 0) {
1737 if (s->salvage) {
1738 if (n == 1) {
1739 if (!s->quiet) {
1740 warn_report("error while reading block status at "
1741 "offset %" PRIu64 ": %s", offset,
1742 strerror(-ret));
1743 }
1744 /* Just try to read the data, then */
1745 ret = BDRV_BLOCK_DATA;
1746 count = BDRV_SECTOR_SIZE;
1747 } else {
1748 /* Retry on a shorter range */
1749 n = DIV_ROUND_UP(n, 4);
1750 }
1751 } else {
1752 error_report("error while reading block status at offset "
1753 "%" PRIu64 ": %s", offset, strerror(-ret));
1754 return ret;
1755 }
1756 }
1757 } while (ret < 0);
1758
Eric Blake31826642017-10-11 22:47:08 -05001759 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
Kevin Wolf690c7302015-03-19 13:33:32 +01001760
Peter Lievenaf8d43d2020-09-01 14:51:29 +02001761 /*
1762 * Avoid that s->sector_next_status becomes unaligned to the source
1763 * request alignment and/or cluster size to avoid unnecessary read
1764 * cycles.
1765 */
1766 tail = (sector_num - src_cur_offset + n) % s->src_alignment[src_cur];
1767 if (n > tail) {
1768 n -= tail;
1769 }
1770
Kevin Wolf690c7302015-03-19 13:33:32 +01001771 if (ret & BDRV_BLOCK_ZERO) {
Max Reitz351c8ef2018-05-01 18:57:49 +02001772 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
Kevin Wolf690c7302015-03-19 13:33:32 +01001773 } else if (ret & BDRV_BLOCK_DATA) {
1774 s->status = BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001775 } else {
Vladimir Sementsov-Ogievskiy9f1b92a2017-04-07 14:34:04 +03001776 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001777 }
1778
1779 s->sector_next_status = sector_num + n;
1780 }
1781
1782 n = MIN(n, s->sector_next_status - sector_num);
1783 if (s->status == BLK_DATA) {
1784 n = MIN(n, s->buf_sectors);
1785 }
1786
1787 /* We need to write complete clusters for compressed images, so if an
1788 * unallocated area is shorter than that, we must consider the whole
1789 * cluster allocated. */
1790 if (s->compressed) {
1791 if (n < s->cluster_sectors) {
1792 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1793 s->status = BLK_DATA;
1794 } else {
1795 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1796 }
1797 }
1798
1799 return n;
1800}
1801
Peter Lieven2d9187b2017-02-28 13:40:07 +01001802static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1803 int nb_sectors, uint8_t *buf)
Kevin Wolf690c7302015-03-19 13:33:32 +01001804{
Max Reitz8eaac022019-05-07 22:35:03 +02001805 uint64_t single_read_until = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001806 int n, ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001807
Kevin Wolf690c7302015-03-19 13:33:32 +01001808 assert(nb_sectors <= s->buf_sectors);
1809 while (nb_sectors > 0) {
1810 BlockBackend *blk;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001811 int src_cur;
1812 int64_t bs_sectors, src_cur_offset;
Max Reitz8eaac022019-05-07 22:35:03 +02001813 uint64_t offset;
Kevin Wolf690c7302015-03-19 13:33:32 +01001814
1815 /* In the case of compression with multiple source files, we can get a
1816 * nb_sectors that spreads into the next part. So we must be able to
1817 * read across multiple BDSes for one convert_read() call. */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001818 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1819 blk = s->src[src_cur];
1820 bs_sectors = s->src_sectors[src_cur];
Kevin Wolf690c7302015-03-19 13:33:32 +01001821
Max Reitz8eaac022019-05-07 22:35:03 +02001822 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001823
Max Reitz8eaac022019-05-07 22:35:03 +02001824 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1825 if (single_read_until > offset) {
1826 n = 1;
1827 }
1828
1829 ret = blk_co_pread(blk, offset, n << BDRV_SECTOR_BITS, buf, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01001830 if (ret < 0) {
Max Reitz8eaac022019-05-07 22:35:03 +02001831 if (s->salvage) {
1832 if (n > 1) {
1833 single_read_until = offset + (n << BDRV_SECTOR_BITS);
1834 continue;
1835 } else {
1836 if (!s->quiet) {
1837 warn_report("error while reading offset %" PRIu64
1838 ": %s", offset, strerror(-ret));
1839 }
1840 memset(buf, 0, BDRV_SECTOR_SIZE);
1841 }
1842 } else {
1843 return ret;
1844 }
Kevin Wolf690c7302015-03-19 13:33:32 +01001845 }
1846
1847 sector_num += n;
1848 nb_sectors -= n;
1849 buf += n * BDRV_SECTOR_SIZE;
1850 }
1851
1852 return 0;
1853}
1854
Peter Lieven2d9187b2017-02-28 13:40:07 +01001855
1856static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1857 int nb_sectors, uint8_t *buf,
1858 enum ImgConvertBlockStatus status)
Kevin Wolf690c7302015-03-19 13:33:32 +01001859{
1860 int ret;
1861
1862 while (nb_sectors > 0) {
1863 int n = nb_sectors;
Lidong Chendb933fb2017-04-27 10:58:27 +08001864 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1865
Peter Lieven2d9187b2017-02-28 13:40:07 +01001866 switch (status) {
Kevin Wolf690c7302015-03-19 13:33:32 +01001867 case BLK_BACKING_FILE:
1868 /* If we have a backing file, leave clusters unallocated that are
1869 * unallocated in the source image, so that the backing file is
1870 * visible at the respective offset. */
1871 assert(s->target_has_backing);
1872 break;
1873
1874 case BLK_DATA:
Lidong Chendb933fb2017-04-27 10:58:27 +08001875 /* If we're told to keep the target fully allocated (-S 0) or there
1876 * is real non-zero data, we must write it. Otherwise we can treat
1877 * it as zero sectors.
1878 * Compressed clusters need to be written as a whole, so in that
1879 * case we can only save the write if the buffer is completely
1880 * zeroed. */
Kevin Wolf690c7302015-03-19 13:33:32 +01001881 if (!s->min_sparse ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001882 (!s->compressed &&
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001883 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1884 sector_num, s->alignment)) ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001885 (s->compressed &&
1886 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
Kevin Wolf690c7302015-03-19 13:33:32 +01001887 {
Vladimir Sementsov-Ogievskiy265a7e52019-04-22 17:58:38 +03001888 ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1889 n << BDRV_SECTOR_BITS, buf, flags);
Kevin Wolf690c7302015-03-19 13:33:32 +01001890 if (ret < 0) {
1891 return ret;
1892 }
1893 break;
1894 }
1895 /* fall-through */
1896
1897 case BLK_ZERO:
1898 if (s->has_zero_init) {
Lidong Chendb933fb2017-04-27 10:58:27 +08001899 assert(!s->target_has_backing);
Kevin Wolf690c7302015-03-19 13:33:32 +01001900 break;
1901 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01001902 ret = blk_co_pwrite_zeroes(s->target,
1903 sector_num << BDRV_SECTOR_BITS,
Nir Soffera3d6ae22019-03-24 02:20:12 +02001904 n << BDRV_SECTOR_BITS,
1905 BDRV_REQ_MAY_UNMAP);
Kevin Wolf690c7302015-03-19 13:33:32 +01001906 if (ret < 0) {
1907 return ret;
1908 }
1909 break;
1910 }
1911
1912 sector_num += n;
1913 nb_sectors -= n;
1914 buf += n * BDRV_SECTOR_SIZE;
1915 }
1916
1917 return 0;
1918}
1919
Fam Zhengee5306d2018-06-01 17:26:48 +08001920static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1921 int nb_sectors)
1922{
1923 int n, ret;
1924
1925 while (nb_sectors > 0) {
1926 BlockBackend *blk;
1927 int src_cur;
1928 int64_t bs_sectors, src_cur_offset;
1929 int64_t offset;
1930
1931 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1932 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1933 blk = s->src[src_cur];
1934 bs_sectors = s->src_sectors[src_cur];
1935
1936 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1937
1938 ret = blk_co_copy_range(blk, offset, s->target,
1939 sector_num << BDRV_SECTOR_BITS,
Vladimir Sementsov-Ogievskiy67b51fb2018-07-09 19:37:17 +03001940 n << BDRV_SECTOR_BITS, 0, 0);
Fam Zhengee5306d2018-06-01 17:26:48 +08001941 if (ret < 0) {
1942 return ret;
1943 }
1944
1945 sector_num += n;
1946 nb_sectors -= n;
1947 }
1948 return 0;
1949}
1950
Peter Lieven2d9187b2017-02-28 13:40:07 +01001951static void coroutine_fn convert_co_do_copy(void *opaque)
1952{
1953 ImgConvertState *s = opaque;
1954 uint8_t *buf = NULL;
1955 int ret, i;
1956 int index = -1;
1957
1958 for (i = 0; i < s->num_coroutines; i++) {
1959 if (s->co[i] == qemu_coroutine_self()) {
1960 index = i;
1961 break;
1962 }
1963 }
1964 assert(index >= 0);
1965
1966 s->running_coroutines++;
1967 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1968
1969 while (1) {
1970 int n;
1971 int64_t sector_num;
1972 enum ImgConvertBlockStatus status;
Fam Zhengee5306d2018-06-01 17:26:48 +08001973 bool copy_range;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001974
1975 qemu_co_mutex_lock(&s->lock);
1976 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1977 qemu_co_mutex_unlock(&s->lock);
Anton Nefedovb91127e2017-04-26 11:33:15 +03001978 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001979 }
1980 n = convert_iteration_sectors(s, s->sector_num);
1981 if (n < 0) {
1982 qemu_co_mutex_unlock(&s->lock);
1983 s->ret = n;
Anton Nefedovb91127e2017-04-26 11:33:15 +03001984 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001985 }
1986 /* save current sector and allocation status to local variables */
1987 sector_num = s->sector_num;
1988 status = s->status;
1989 if (!s->min_sparse && s->status == BLK_ZERO) {
1990 n = MIN(n, s->buf_sectors);
1991 }
1992 /* increment global sector counter so that other coroutines can
1993 * already continue reading beyond this request */
1994 s->sector_num += n;
1995 qemu_co_mutex_unlock(&s->lock);
1996
1997 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
1998 s->allocated_done += n;
1999 qemu_progress_print(100.0 * s->allocated_done /
2000 s->allocated_sectors, 0);
2001 }
2002
Fam Zhengee5306d2018-06-01 17:26:48 +08002003retry:
2004 copy_range = s->copy_range && s->status == BLK_DATA;
2005 if (status == BLK_DATA && !copy_range) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002006 ret = convert_co_read(s, sector_num, n, buf);
2007 if (ret < 0) {
Eric Blake39f77cb2020-04-02 08:57:17 -05002008 error_report("error while reading at byte %lld: %s",
2009 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
Peter Lieven2d9187b2017-02-28 13:40:07 +01002010 s->ret = ret;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002011 }
2012 } else if (!s->min_sparse && status == BLK_ZERO) {
2013 status = BLK_DATA;
2014 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
2015 }
2016
2017 if (s->wr_in_order) {
2018 /* keep writes in order */
Anton Nefedovb91127e2017-04-26 11:33:15 +03002019 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002020 s->wait_sector_num[index] = sector_num;
2021 qemu_coroutine_yield();
2022 }
2023 s->wait_sector_num[index] = -1;
2024 }
2025
Anton Nefedovb91127e2017-04-26 11:33:15 +03002026 if (s->ret == -EINPROGRESS) {
Fam Zhengee5306d2018-06-01 17:26:48 +08002027 if (copy_range) {
2028 ret = convert_co_copy_range(s, sector_num, n);
2029 if (ret) {
2030 s->copy_range = false;
2031 goto retry;
2032 }
2033 } else {
2034 ret = convert_co_write(s, sector_num, n, buf, status);
2035 }
Anton Nefedovb91127e2017-04-26 11:33:15 +03002036 if (ret < 0) {
Eric Blake39f77cb2020-04-02 08:57:17 -05002037 error_report("error while writing at byte %lld: %s",
2038 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
Anton Nefedovb91127e2017-04-26 11:33:15 +03002039 s->ret = ret;
2040 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01002041 }
2042
2043 if (s->wr_in_order) {
2044 /* reenter the coroutine that might have waited
2045 * for this write to complete */
2046 s->wr_offs = sector_num + n;
2047 for (i = 0; i < s->num_coroutines; i++) {
2048 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
2049 /*
2050 * A -> B -> A cannot occur because A has
2051 * s->wait_sector_num[i] == -1 during A -> B. Therefore
2052 * B will never enter A during this time window.
2053 */
2054 qemu_coroutine_enter(s->co[i]);
2055 break;
2056 }
2057 }
2058 }
2059 }
2060
Peter Lieven2d9187b2017-02-28 13:40:07 +01002061 qemu_vfree(buf);
2062 s->co[index] = NULL;
2063 s->running_coroutines--;
2064 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
2065 /* the convert job finished successfully */
2066 s->ret = 0;
2067 }
2068}
2069
Kevin Wolf690c7302015-03-19 13:33:32 +01002070static int convert_do_copy(ImgConvertState *s)
2071{
Peter Lieven2d9187b2017-02-28 13:40:07 +01002072 int ret, i, n;
2073 int64_t sector_num = 0;
Kevin Wolf690c7302015-03-19 13:33:32 +01002074
2075 /* Check whether we have zero initialisation or can get it efficiently */
David Edmondson168468f2020-02-05 11:02:48 +00002076 if (!s->has_zero_init && s->target_is_new && s->min_sparse &&
2077 !s->target_has_backing) {
Max Reitz4d7c4872019-07-24 19:12:29 +02002078 s->has_zero_init = bdrv_has_zero_init(blk_bs(s->target));
Max Reitz4d7c4872019-07-24 19:12:29 +02002079 }
Kevin Wolf690c7302015-03-19 13:33:32 +01002080
Kevin Wolf690c7302015-03-19 13:33:32 +01002081 /* Allocate buffer for copied data. For compressed images, only one cluster
2082 * can be copied at a time. */
2083 if (s->compressed) {
2084 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
2085 error_report("invalid cluster size");
Peter Lieven2d9187b2017-02-28 13:40:07 +01002086 return -EINVAL;
Kevin Wolf690c7302015-03-19 13:33:32 +01002087 }
2088 s->buf_sectors = s->cluster_sectors;
2089 }
Kevin Wolf690c7302015-03-19 13:33:32 +01002090
Kevin Wolf690c7302015-03-19 13:33:32 +01002091 while (sector_num < s->total_sectors) {
2092 n = convert_iteration_sectors(s, sector_num);
2093 if (n < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002094 return n;
Kevin Wolf690c7302015-03-19 13:33:32 +01002095 }
Max Reitzaad15de2016-03-24 23:33:57 +01002096 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
2097 {
Kevin Wolf690c7302015-03-19 13:33:32 +01002098 s->allocated_sectors += n;
2099 }
2100 sector_num += n;
2101 }
2102
2103 /* Do the copy */
Kevin Wolf690c7302015-03-19 13:33:32 +01002104 s->sector_next_status = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002105 s->ret = -EINPROGRESS;
Kevin Wolf690c7302015-03-19 13:33:32 +01002106
Peter Lieven2d9187b2017-02-28 13:40:07 +01002107 qemu_co_mutex_init(&s->lock);
2108 for (i = 0; i < s->num_coroutines; i++) {
2109 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
2110 s->wait_sector_num[i] = -1;
2111 qemu_coroutine_enter(s->co[i]);
Kevin Wolf690c7302015-03-19 13:33:32 +01002112 }
2113
Anton Nefedovb91127e2017-04-26 11:33:15 +03002114 while (s->running_coroutines) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002115 main_loop_wait(false);
2116 }
2117
2118 if (s->compressed && !s->ret) {
Kevin Wolf690c7302015-03-19 13:33:32 +01002119 /* signal EOF to align */
Alberto Faria0cadf2c2022-07-05 17:15:18 +01002120 ret = blk_pwrite_compressed(s->target, 0, 0, NULL);
Kevin Wolf690c7302015-03-19 13:33:32 +01002121 if (ret < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002122 return ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002123 }
2124 }
2125
Peter Lieven2d9187b2017-02-28 13:40:07 +01002126 return s->ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002127}
2128
Eric Blake74a43202021-07-09 10:39:50 -05002129/* Check that bitmaps can be copied, or output an error */
Eric Blake955171e2021-07-21 10:53:48 -05002130static int convert_check_bitmaps(BlockDriverState *src, bool skip_broken)
Eric Blake74a43202021-07-09 10:39:50 -05002131{
2132 BdrvDirtyBitmap *bm;
2133
2134 if (!bdrv_supports_persistent_dirty_bitmap(src)) {
2135 error_report("Source lacks bitmap support");
2136 return -1;
2137 }
2138 FOR_EACH_DIRTY_BITMAP(src, bm) {
2139 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2140 continue;
2141 }
Eric Blake955171e2021-07-21 10:53:48 -05002142 if (!skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) {
Eric Blake74a43202021-07-09 10:39:50 -05002143 error_report("Cannot copy inconsistent bitmap '%s'",
2144 bdrv_dirty_bitmap_name(bm));
Eric Blake955171e2021-07-21 10:53:48 -05002145 error_printf("Try --skip-broken-bitmaps, or "
2146 "use 'qemu-img bitmap --remove' to delete it\n");
Eric Blake74a43202021-07-09 10:39:50 -05002147 return -1;
2148 }
2149 }
2150 return 0;
2151}
2152
Eric Blake955171e2021-07-21 10:53:48 -05002153static int convert_copy_bitmaps(BlockDriverState *src, BlockDriverState *dst,
2154 bool skip_broken)
Eric Blake15e39ad2020-05-21 14:21:36 -05002155{
2156 BdrvDirtyBitmap *bm;
2157 Error *err = NULL;
2158
2159 FOR_EACH_DIRTY_BITMAP(src, bm) {
2160 const char *name;
2161
2162 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2163 continue;
2164 }
2165 name = bdrv_dirty_bitmap_name(bm);
Eric Blake955171e2021-07-21 10:53:48 -05002166 if (skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) {
2167 warn_report("Skipping inconsistent bitmap '%s'", name);
2168 continue;
2169 }
Eric Blake15e39ad2020-05-21 14:21:36 -05002170 qmp_block_dirty_bitmap_add(dst->node_name, name,
2171 true, bdrv_dirty_bitmap_granularity(bm),
2172 true, true,
2173 true, !bdrv_dirty_bitmap_enabled(bm),
2174 &err);
2175 if (err) {
2176 error_reportf_err(err, "Failed to create bitmap %s: ", name);
2177 return -1;
2178 }
2179
2180 do_dirty_bitmap_merge(dst->node_name, name, src->node_name, name,
2181 &err);
2182 if (err) {
2183 error_reportf_err(err, "Failed to populate bitmap %s: ", name);
Eric Blake74a43202021-07-09 10:39:50 -05002184 qmp_block_dirty_bitmap_remove(dst->node_name, name, NULL);
Eric Blake15e39ad2020-05-21 14:21:36 -05002185 return -1;
2186 }
2187 }
2188
2189 return 0;
2190}
2191
Peter Lieven6360ab22018-07-13 09:15:39 +02002192#define MAX_BUF_SECTORS 32768
2193
Zhengui0c8c4892020-10-20 14:47:44 +00002194static void set_rate_limit(BlockBackend *blk, int64_t rate_limit)
2195{
2196 ThrottleConfig cfg;
2197
2198 throttle_config_init(&cfg);
2199 cfg.buckets[THROTTLE_BPS_WRITE].avg = rate_limit;
2200
2201 blk_io_limits_enable(blk, CONVERT_THROTTLE_GROUP);
2202 blk_set_io_limits(blk, &cfg);
2203}
2204
bellardea2384d2004-08-01 21:59:26 +00002205static int img_convert(int argc, char **argv)
2206{
Kevin Wolf0b8fb552021-04-22 18:43:44 +02002207 int c, bs_i, flags, src_flags = BDRV_O_NO_SHARE;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002208 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002209 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
Eric Blake1899bf42021-09-13 08:17:35 -05002210 *out_filename, *out_baseimg_param, *snapshot_name = NULL,
2211 *backing_fmt = NULL;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002212 BlockDriver *drv = NULL, *proto_drv = NULL;
bellardfaea38e2006-08-05 21:31:00 +00002213 BlockDriverInfo bdi;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002214 BlockDriverState *out_bs;
2215 QemuOpts *opts = NULL, *sn_opts = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08002216 QemuOptsList *create_opts = NULL;
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002217 QDict *open_opts = NULL;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002218 char *options = NULL;
Max Reitzcc84d902013-09-06 17:14:26 +02002219 Error *local_err = NULL;
Max Reitz3d96cb92019-05-07 22:35:02 +02002220 bool writethrough, src_writethrough, image_opts = false,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002221 skip_create = false, progress = false, tgt_image_opts = false;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002222 int64_t ret = -EINVAL;
Fam Zheng335e9932017-05-03 00:35:39 +08002223 bool force_share = false;
Fam Zhenge11ce122018-07-27 11:34:01 +08002224 bool explict_min_sparse = false;
Eric Blake15e39ad2020-05-21 14:21:36 -05002225 bool bitmaps = false;
Eric Blake955171e2021-07-21 10:53:48 -05002226 bool skip_broken = false;
Zhengui0c8c4892020-10-20 14:47:44 +00002227 int64_t rate_limit = 0;
bellardea2384d2004-08-01 21:59:26 +00002228
Peter Lieven9fd77f92017-04-21 11:11:55 +02002229 ImgConvertState s = (ImgConvertState) {
2230 /* Need at least 4k of zeros for sparse detection */
2231 .min_sparse = 8,
Fam Zhenge11ce122018-07-27 11:34:01 +08002232 .copy_range = false,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002233 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2234 .wr_in_order = true,
2235 .num_coroutines = 8,
2236 };
2237
bellardea2384d2004-08-01 21:59:26 +00002238 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002239 static const struct option long_options[] = {
2240 {"help", no_argument, 0, 'h'},
2241 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002242 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002243 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002244 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
Max Reitz8eaac022019-05-07 22:35:03 +02002245 {"salvage", no_argument, 0, OPTION_SALVAGE},
David Edmondson168468f2020-02-05 11:02:48 +00002246 {"target-is-zero", no_argument, 0, OPTION_TARGET_IS_ZERO},
Eric Blake15e39ad2020-05-21 14:21:36 -05002247 {"bitmaps", no_argument, 0, OPTION_BITMAPS},
Eric Blake955171e2021-07-21 10:53:48 -05002248 {"skip-broken-bitmaps", no_argument, 0, OPTION_SKIP_BROKEN},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002249 {0, 0, 0, 0}
2250 };
Eric Blake1899bf42021-09-13 08:17:35 -05002251 c = getopt_long(argc, argv, ":hf:O:B:CcF:o:l:S:pt:T:qnm:WUr:",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002252 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002253 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002254 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002255 }
bellardea2384d2004-08-01 21:59:26 +00002256 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002257 case ':':
2258 missing_argument(argv[optind - 1]);
2259 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002260 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002261 unrecognized_option(argv[optind - 1]);
2262 break;
bellardea2384d2004-08-01 21:59:26 +00002263 case 'h':
2264 help();
2265 break;
2266 case 'f':
2267 fmt = optarg;
2268 break;
2269 case 'O':
2270 out_fmt = optarg;
2271 break;
thsf58c7b32008-06-05 21:53:49 +00002272 case 'B':
2273 out_baseimg = optarg;
2274 break;
Fam Zhenge11ce122018-07-27 11:34:01 +08002275 case 'C':
2276 s.copy_range = true;
2277 break;
bellardea2384d2004-08-01 21:59:26 +00002278 case 'c':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002279 s.compressed = true;
bellardea2384d2004-08-01 21:59:26 +00002280 break;
Eric Blake1899bf42021-09-13 08:17:35 -05002281 case 'F':
2282 backing_fmt = optarg;
2283 break;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002284 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02002285 if (accumulate_options(&options, optarg) < 0) {
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002286 goto fail_getopt;
Kevin Wolf2dc83282014-02-21 16:24:05 +01002287 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002288 break;
Wenchao Xiaef806542013-12-04 17:10:57 +08002289 case 'l':
2290 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
Markus Armbruster70b94332015-02-13 12:50:26 +01002291 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2292 optarg, false);
Wenchao Xiaef806542013-12-04 17:10:57 +08002293 if (!sn_opts) {
2294 error_report("Failed in parsing snapshot param '%s'",
2295 optarg);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002296 goto fail_getopt;
Wenchao Xiaef806542013-12-04 17:10:57 +08002297 }
2298 } else {
2299 snapshot_name = optarg;
2300 }
2301 break;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002302 case 'S':
2303 {
2304 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +01002305
Eyal Moscovici43d589b2020-05-13 16:36:26 +03002306 sval = cvtnum("buffer size for sparse output", optarg);
2307 if (sval < 0) {
2308 goto fail_getopt;
2309 } else if (!QEMU_IS_ALIGNED(sval, BDRV_SECTOR_SIZE) ||
Peter Lieven6360ab22018-07-13 09:15:39 +02002310 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2311 error_report("Invalid buffer size for sparse output specified. "
2312 "Valid sizes are multiples of %llu up to %llu. Select "
2313 "0 to disable sparse detection (fully allocates output).",
2314 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002315 goto fail_getopt;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002316 }
2317
Peter Lieven9fd77f92017-04-21 11:11:55 +02002318 s.min_sparse = sval / BDRV_SECTOR_SIZE;
Fam Zhenge11ce122018-07-27 11:34:01 +08002319 explict_min_sparse = true;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002320 break;
2321 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002322 case 'p':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002323 progress = true;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002324 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002325 case 't':
2326 cache = optarg;
2327 break;
Max Reitz40055952014-07-22 22:58:42 +02002328 case 'T':
2329 src_cache = optarg;
2330 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002331 case 'q':
Max Reitz3d96cb92019-05-07 22:35:02 +02002332 s.quiet = true;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002333 break;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002334 case 'n':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002335 skip_create = true;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002336 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002337 case 'm':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002338 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2339 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002340 error_report("Invalid number of coroutines. Allowed number of"
2341 " coroutines is between 1 and %d", MAX_COROUTINES);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002342 goto fail_getopt;
2343 }
2344 break;
2345 case 'W':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002346 s.wr_in_order = false;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002347 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002348 case 'U':
2349 force_share = true;
2350 break;
Zhengui0c8c4892020-10-20 14:47:44 +00002351 case 'r':
2352 rate_limit = cvtnum("rate limit", optarg);
2353 if (rate_limit < 0) {
2354 goto fail_getopt;
2355 }
2356 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01002357 case OPTION_OBJECT:
2358 user_creatable_process_cmdline(optarg);
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002359 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002360 case OPTION_IMAGE_OPTS:
2361 image_opts = true;
2362 break;
Max Reitz8eaac022019-05-07 22:35:03 +02002363 case OPTION_SALVAGE:
2364 s.salvage = true;
2365 break;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002366 case OPTION_TARGET_IMAGE_OPTS:
2367 tgt_image_opts = true;
2368 break;
David Edmondson168468f2020-02-05 11:02:48 +00002369 case OPTION_TARGET_IS_ZERO:
2370 /*
2371 * The user asserting that the target is blank has the
2372 * same effect as the target driver supporting zero
2373 * initialisation.
2374 */
2375 s.has_zero_init = true;
2376 break;
Eric Blake15e39ad2020-05-21 14:21:36 -05002377 case OPTION_BITMAPS:
2378 bitmaps = true;
2379 break;
Eric Blake955171e2021-07-21 10:53:48 -05002380 case OPTION_SKIP_BROKEN:
2381 skip_broken = true;
2382 break;
bellardea2384d2004-08-01 21:59:26 +00002383 }
2384 }
ths3b46e622007-09-17 08:09:54 +00002385
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002386 if (!out_fmt && !tgt_image_opts) {
2387 out_fmt = "raw";
2388 }
2389
Eric Blake955171e2021-07-21 10:53:48 -05002390 if (skip_broken && !bitmaps) {
2391 error_report("Use of --skip-broken-bitmaps requires --bitmaps");
2392 goto fail_getopt;
2393 }
2394
Fam Zhenge11ce122018-07-27 11:34:01 +08002395 if (s.compressed && s.copy_range) {
2396 error_report("Cannot enable copy offloading when -c is used");
2397 goto fail_getopt;
2398 }
2399
2400 if (explict_min_sparse && s.copy_range) {
2401 error_report("Cannot enable copy offloading when -S is used");
2402 goto fail_getopt;
2403 }
2404
Max Reitz8eaac022019-05-07 22:35:03 +02002405 if (s.copy_range && s.salvage) {
2406 error_report("Cannot use copy offloading in salvaging mode");
2407 goto fail_getopt;
2408 }
2409
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002410 if (tgt_image_opts && !skip_create) {
2411 error_report("--target-image-opts requires use of -n flag");
2412 goto fail_getopt;
2413 }
2414
Kevin Wolfffd8e8f2019-08-09 11:09:21 +02002415 if (skip_create && options) {
Eric Blake25956af2020-07-06 15:39:46 -05002416 error_report("-o has no effect when skipping image creation");
2417 goto fail_getopt;
Kevin Wolfffd8e8f2019-08-09 11:09:21 +02002418 }
2419
David Edmondson168468f2020-02-05 11:02:48 +00002420 if (s.has_zero_init && !skip_create) {
2421 error_report("--target-is-zero requires use of -n flag");
2422 goto fail_getopt;
2423 }
2424
Peter Lieven9fd77f92017-04-21 11:11:55 +02002425 s.src_num = argc - optind - 1;
2426 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2427
2428 if (options && has_help_option(options)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002429 if (out_fmt) {
2430 ret = print_block_option_help(out_filename, out_fmt);
2431 goto fail_getopt;
2432 } else {
2433 error_report("Option help requires a format be specified");
2434 goto fail_getopt;
2435 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002436 }
2437
2438 if (s.src_num < 1) {
2439 error_report("Must specify image file name");
2440 goto fail_getopt;
2441 }
2442
Peter Lieven9fd77f92017-04-21 11:11:55 +02002443 /* ret is still -EINVAL until here */
2444 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2445 if (ret < 0) {
2446 error_report("Invalid source cache option: %s", src_cache);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002447 goto fail_getopt;
2448 }
2449
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002450 /* Initialize before goto out */
Max Reitz3d96cb92019-05-07 22:35:02 +02002451 if (s.quiet) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002452 progress = false;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002453 }
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002454 qemu_progress_init(progress, 1.0);
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002455 qemu_progress_print(0, 100);
2456
Peter Lieven9fd77f92017-04-21 11:11:55 +02002457 s.src = g_new0(BlockBackend *, s.src_num);
2458 s.src_sectors = g_new(int64_t, s.src_num);
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002459 s.src_alignment = g_new(int, s.src_num);
balrog926c2d22007-10-31 01:11:44 +00002460
Peter Lieven9fd77f92017-04-21 11:11:55 +02002461 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002462 BlockDriverState *src_bs;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002463 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
Max Reitz3d96cb92019-05-07 22:35:02 +02002464 fmt, src_flags, src_writethrough, s.quiet,
Fam Zheng335e9932017-05-03 00:35:39 +08002465 force_share);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002466 if (!s.src[bs_i]) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002467 ret = -1;
2468 goto out;
2469 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002470 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2471 if (s.src_sectors[bs_i] < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002472 error_report("Could not get size of %s: %s",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002473 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002474 ret = -1;
2475 goto out;
2476 }
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002477 src_bs = blk_bs(s.src[bs_i]);
2478 s.src_alignment[bs_i] = DIV_ROUND_UP(src_bs->bl.request_alignment,
2479 BDRV_SECTOR_SIZE);
2480 if (!bdrv_get_info(src_bs, &bdi)) {
2481 s.src_alignment[bs_i] = MAX(s.src_alignment[bs_i],
2482 bdi.cluster_size / BDRV_SECTOR_SIZE);
2483 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002484 s.total_sectors += s.src_sectors[bs_i];
balrog926c2d22007-10-31 01:11:44 +00002485 }
bellardea2384d2004-08-01 21:59:26 +00002486
Wenchao Xiaef806542013-12-04 17:10:57 +08002487 if (sn_opts) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002488 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
Peter Maydell10d6eda2017-02-10 16:28:24 +00002489 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2490 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2491 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002492 } else if (snapshot_name != NULL) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002493 if (s.src_num > 1) {
Markus Armbruster6daf1942011-06-22 14:03:54 +02002494 error_report("No support for concatenating multiple snapshot");
edison51ef6722010-09-21 19:58:41 -07002495 ret = -1;
2496 goto out;
2497 }
Wenchao Xia7b4c4782013-12-04 17:10:54 +08002498
Peter Lieven9fd77f92017-04-21 11:11:55 +02002499 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2500 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002501 }
Markus Armbruster84d18f02014-01-30 15:07:28 +01002502 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002503 error_reportf_err(local_err, "Failed to load snapshot: ");
Wenchao Xiaef806542013-12-04 17:10:57 +08002504 ret = -1;
2505 goto out;
edison51ef6722010-09-21 19:58:41 -07002506 }
2507
Max Reitz2e024cd2015-02-11 09:58:46 -05002508 if (!skip_create) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002509 /* Find driver and parse its options */
2510 drv = bdrv_find_format(out_fmt);
2511 if (!drv) {
2512 error_report("Unknown file format '%s'", out_fmt);
2513 ret = -1;
2514 goto out;
2515 }
2516
2517 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2518 if (!proto_drv) {
2519 error_report_err(local_err);
2520 ret = -1;
2521 goto out;
2522 }
2523
Max Reitz2e024cd2015-02-11 09:58:46 -05002524 if (!drv->create_opts) {
2525 error_report("Format driver '%s' does not support image creation",
2526 drv->format_name);
2527 ret = -1;
2528 goto out;
2529 }
Max Reitzf75613c2014-12-02 18:32:46 +01002530
Max Reitz2e024cd2015-02-11 09:58:46 -05002531 if (!proto_drv->create_opts) {
2532 error_report("Protocol driver '%s' does not support image creation",
2533 proto_drv->format_name);
2534 ret = -1;
2535 goto out;
2536 }
Max Reitzf75613c2014-12-02 18:32:46 +01002537
Max Reitz2e024cd2015-02-11 09:58:46 -05002538 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2539 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfdb08adf2009-06-04 15:39:38 +02002540
Max Reitz2e024cd2015-02-11 09:58:46 -05002541 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002542 if (options) {
Markus Armbruster235e59c2020-07-07 18:05:42 +02002543 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
Markus Armbruster97a2ca72015-03-14 10:23:15 +01002544 error_report_err(local_err);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002545 ret = -1;
2546 goto out;
2547 }
Max Reitz2e024cd2015-02-11 09:58:46 -05002548 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002549
Yi Lic075c422020-08-19 09:36:07 +08002550 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
2551 s.total_sectors * BDRV_SECTOR_SIZE, &error_abort);
Eric Blake1899bf42021-09-13 08:17:35 -05002552 ret = add_old_style_options(out_fmt, opts, out_baseimg, backing_fmt);
Max Reitz2e024cd2015-02-11 09:58:46 -05002553 if (ret < 0) {
2554 goto out;
2555 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002556 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002557
Kevin Wolfa18953f2010-10-14 15:46:04 +02002558 /* Get backing file name if -o backing_file was used */
Chunyan Liu83d05212014-06-05 17:20:51 +08002559 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
Kevin Wolfa18953f2010-10-14 15:46:04 +02002560 if (out_baseimg_param) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002561 out_baseimg = out_baseimg_param;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002562 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002563 s.target_has_backing = (bool) out_baseimg;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002564
David Edmondson168468f2020-02-05 11:02:48 +00002565 if (s.has_zero_init && s.target_has_backing) {
2566 error_report("Cannot use --target-is-zero when the destination "
2567 "image has a backing file");
2568 goto out;
2569 }
2570
Max Reitz48758a82017-04-26 15:46:48 +02002571 if (s.src_num > 1 && out_baseimg) {
2572 error_report("Having a backing file for the target makes no sense when "
2573 "concatenating multiple input images");
2574 ret = -1;
2575 goto out;
2576 }
2577
Eric Blaked9f059a2020-07-06 15:39:54 -05002578 if (out_baseimg_param) {
2579 if (!qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT)) {
Eric Blake497a30d2021-05-03 14:36:00 -07002580 error_report("Use of backing file requires explicit "
2581 "backing format");
2582 ret = -1;
2583 goto out;
Eric Blaked9f059a2020-07-06 15:39:54 -05002584 }
2585 }
2586
Kevin Wolfefa84d42009-05-18 16:42:12 +02002587 /* Check if compression is supported */
Peter Lieven9fd77f92017-04-21 11:11:55 +02002588 if (s.compressed) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002589 bool encryption =
2590 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002591 const char *encryptfmt =
2592 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
Chunyan Liu83d05212014-06-05 17:20:51 +08002593 const char *preallocation =
2594 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
Kevin Wolfefa84d42009-05-18 16:42:12 +02002595
Vladimir Sementsov-Ogievskiyac850bf2019-06-04 19:15:06 +03002596 if (drv && !block_driver_can_compress(drv)) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002597 error_report("Compression not supported for this file format");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002598 ret = -1;
2599 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002600 }
2601
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002602 if (encryption || encryptfmt) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002603 error_report("Compression and encryption not supported at "
2604 "the same time");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002605 ret = -1;
2606 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002607 }
Kevin Wolf41521fa2011-10-18 16:19:42 +02002608
Chunyan Liu83d05212014-06-05 17:20:51 +08002609 if (preallocation
2610 && strcmp(preallocation, "off"))
Kevin Wolf41521fa2011-10-18 16:19:42 +02002611 {
2612 error_report("Compression and preallocation not supported at "
2613 "the same time");
2614 ret = -1;
2615 goto out;
2616 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002617 }
2618
Eric Blake15e39ad2020-05-21 14:21:36 -05002619 /* Determine if bitmaps need copying */
2620 if (bitmaps) {
2621 if (s.src_num > 1) {
2622 error_report("Copying bitmaps only possible with single source");
2623 ret = -1;
2624 goto out;
2625 }
Eric Blake955171e2021-07-21 10:53:48 -05002626 ret = convert_check_bitmaps(blk_bs(s.src[0]), skip_broken);
Eric Blake74a43202021-07-09 10:39:50 -05002627 if (ret < 0) {
Eric Blake15e39ad2020-05-21 14:21:36 -05002628 goto out;
2629 }
2630 }
2631
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002632 /*
2633 * The later open call will need any decryption secrets, and
2634 * bdrv_create() will purge "opts", so extract them now before
2635 * they are lost.
2636 */
2637 if (!skip_create) {
2638 open_opts = qdict_new();
2639 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002640
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002641 /* Create the new image */
Chunyan Liuc282e1f2014-06-05 17:21:11 +08002642 ret = bdrv_create(drv, out_filename, opts, &local_err);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002643 if (ret < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002644 error_reportf_err(local_err, "%s: error while converting %s: ",
2645 out_filename, out_fmt);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002646 goto out;
bellardea2384d2004-08-01 21:59:26 +00002647 }
2648 }
ths3b46e622007-09-17 08:09:54 +00002649
Max Reitz4d7c4872019-07-24 19:12:29 +02002650 s.target_is_new = !skip_create;
2651
Peter Lieven9fd77f92017-04-21 11:11:55 +02002652 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
Kevin Wolfce099542016-03-15 13:01:04 +01002653 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002654 if (ret < 0) {
2655 error_report("Invalid cache option: %s", cache);
Markus Armbrusterbb9cd2e2014-05-28 11:17:07 +02002656 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002657 }
2658
Hanna Reitza1c62432021-08-19 12:12:00 +02002659 if (flags & BDRV_O_NOCACHE) {
2660 /*
2661 * If we open the target with O_DIRECT, it may be necessary to
2662 * extend its size to align to the physical sector size.
2663 */
2664 flags |= BDRV_O_RESIZE;
2665 }
2666
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002667 if (skip_create) {
2668 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002669 flags, writethrough, s.quiet, false);
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002670 } else {
2671 /* TODO ultimately we should allow --target-image-opts
2672 * to be used even when -n is not given.
2673 * That has to wait for bdrv_create to be improved
2674 * to allow filenames in option syntax
2675 */
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002676 s.target = img_open_file(out_filename, open_opts, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002677 flags, writethrough, s.quiet, false);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002678 open_opts = NULL; /* blk_new_open will have freed it */
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002679 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002680 if (!s.target) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002681 ret = -1;
2682 goto out;
2683 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002684 out_bs = blk_bs(s.target);
bellardea2384d2004-08-01 21:59:26 +00002685
Eric Blake15e39ad2020-05-21 14:21:36 -05002686 if (bitmaps && !bdrv_supports_persistent_dirty_bitmap(out_bs)) {
2687 error_report("Format driver '%s' does not support bitmaps",
2688 out_bs->drv->format_name);
2689 ret = -1;
2690 goto out;
2691 }
2692
Vladimir Sementsov-Ogievskiyac850bf2019-06-04 19:15:06 +03002693 if (s.compressed && !block_driver_can_compress(out_bs->drv)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002694 error_report("Compression not supported for this file format");
2695 ret = -1;
2696 goto out;
2697 }
2698
Eric Blake5def6b82016-06-23 16:37:19 -06002699 /* increase bufsectors from the default 4096 (2M) if opt_transfer
Peter Lieven6360ab22018-07-13 09:15:39 +02002700 * or discard_alignment of the out_bs is greater. Limit to
2701 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2702 s.buf_sectors = MIN(MAX_BUF_SECTORS,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002703 MAX(s.buf_sectors,
2704 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2705 out_bs->bl.pdiscard_alignment >>
2706 BDRV_SECTOR_BITS)));
Peter Lievenf2521c92013-11-27 11:07:06 +01002707
Peter Lieven8dcd3c92018-07-12 15:00:10 +02002708 /* try to align the write requests to the destination to avoid unnecessary
2709 * RMW cycles. */
2710 s.alignment = MAX(pow2floor(s.min_sparse),
2711 DIV_ROUND_UP(out_bs->bl.request_alignment,
2712 BDRV_SECTOR_SIZE));
2713 assert(is_power_of_2(s.alignment));
2714
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002715 if (skip_create) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002716 int64_t output_sectors = blk_nb_sectors(s.target);
Markus Armbruster43716fa2014-06-26 13:23:21 +02002717 if (output_sectors < 0) {
Gongleieec5eb42015-02-25 12:22:27 +08002718 error_report("unable to get output image length: %s",
Markus Armbruster43716fa2014-06-26 13:23:21 +02002719 strerror(-output_sectors));
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002720 ret = -1;
2721 goto out;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002722 } else if (output_sectors < s.total_sectors) {
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002723 error_report("output file is smaller than input file");
2724 ret = -1;
2725 goto out;
2726 }
2727 }
2728
Max Reitzc69291e2020-01-21 16:59:14 +01002729 if (s.target_has_backing && s.target_is_new) {
Max Reitz351c8ef2018-05-01 18:57:49 +02002730 /* Errors are treated as "backing length unknown" (which means
2731 * s.target_backing_sectors has to be negative, which it will
2732 * be automatically). The backing file length is used only
2733 * for optimizations, so such a case is not fatal. */
Max Reitz4a2061e2019-06-12 19:00:30 +02002734 s.target_backing_sectors =
2735 bdrv_nb_sectors(bdrv_backing_chain_next(out_bs));
Max Reitz351c8ef2018-05-01 18:57:49 +02002736 } else {
2737 s.target_backing_sectors = -1;
2738 }
2739
Peter Lieven24f833c2013-11-27 11:07:07 +01002740 ret = bdrv_get_info(out_bs, &bdi);
2741 if (ret < 0) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002742 if (s.compressed) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002743 error_report("could not get block driver info");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002744 goto out;
2745 }
Peter Lieven24f833c2013-11-27 11:07:07 +01002746 } else {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002747 s.compressed = s.compressed || bdi.needs_compressed_writes;
2748 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
Peter Lieven24f833c2013-11-27 11:07:07 +01002749 }
2750
Zhengui0c8c4892020-10-20 14:47:44 +00002751 if (rate_limit) {
2752 set_rate_limit(s.target, rate_limit);
2753 }
2754
Peter Lieven9fd77f92017-04-21 11:11:55 +02002755 ret = convert_do_copy(&s);
Eric Blake15e39ad2020-05-21 14:21:36 -05002756
2757 /* Now copy the bitmaps */
2758 if (bitmaps && ret == 0) {
Eric Blake955171e2021-07-21 10:53:48 -05002759 ret = convert_copy_bitmaps(blk_bs(s.src[0]), out_bs, skip_broken);
Eric Blake15e39ad2020-05-21 14:21:36 -05002760 }
2761
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002762out:
Peter Lieven13c28af2013-11-27 11:07:01 +01002763 if (!ret) {
2764 qemu_progress_print(100, 0);
2765 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002766 qemu_progress_end();
Chunyan Liu83d05212014-06-05 17:20:51 +08002767 qemu_opts_del(opts);
2768 qemu_opts_free(create_opts);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002769 qobject_unref(open_opts);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002770 blk_unref(s.target);
2771 if (s.src) {
2772 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2773 blk_unref(s.src[bs_i]);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002774 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002775 g_free(s.src);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002776 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002777 g_free(s.src_sectors);
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002778 g_free(s.src_alignment);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002779fail_getopt:
Tuguoyi6aec8302020-11-02 09:04:57 +00002780 qemu_opts_del(sn_opts);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002781 g_free(options);
2782
Peter Lieven9fd77f92017-04-21 11:11:55 +02002783 return !!ret;
bellardea2384d2004-08-01 21:59:26 +00002784}
2785
bellard57d1a2b2004-08-03 21:15:11 +00002786
bellardfaea38e2006-08-05 21:31:00 +00002787static void dump_snapshots(BlockDriverState *bs)
2788{
2789 QEMUSnapshotInfo *sn_tab, *sn;
2790 int nb_sns, i;
bellardfaea38e2006-08-05 21:31:00 +00002791
2792 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2793 if (nb_sns <= 0)
2794 return;
2795 printf("Snapshot list:\n");
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002796 bdrv_snapshot_dump(NULL);
Wenchao Xia5b917042013-05-25 11:09:45 +08002797 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002798 for(i = 0; i < nb_sns; i++) {
2799 sn = &sn_tab[i];
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002800 bdrv_snapshot_dump(sn);
Wenchao Xia5b917042013-05-25 11:09:45 +08002801 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002802 }
Anthony Liguori7267c092011-08-20 22:09:37 -05002803 g_free(sn_tab);
bellardfaea38e2006-08-05 21:31:00 +00002804}
2805
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002806static void dump_json_image_info_list(ImageInfoList *list)
2807{
Markus Armbrustereab3a462020-12-11 18:11:37 +01002808 GString *str;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002809 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002810 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002811
2812 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2813 visit_complete(v, &obj);
Markus Armbruster6589f452020-12-11 18:11:35 +01002814 str = qobject_to_json_pretty(obj, true);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002815 assert(str != NULL);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002816 printf("%s\n", str->str);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002817 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002818 visit_free(v);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002819 g_string_free(str, true);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002820}
2821
Benoît Canetc054b3f2012-09-05 13:09:02 +02002822static void dump_json_image_info(ImageInfo *info)
2823{
Markus Armbrustereab3a462020-12-11 18:11:37 +01002824 GString *str;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002825 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002826 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002827
2828 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2829 visit_complete(v, &obj);
Markus Armbruster6589f452020-12-11 18:11:35 +01002830 str = qobject_to_json_pretty(obj, true);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002831 assert(str != NULL);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002832 printf("%s\n", str->str);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002833 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002834 visit_free(v);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002835 g_string_free(str, true);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002836}
2837
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002838static void dump_human_image_info_list(ImageInfoList *list)
2839{
2840 ImageInfoList *elem;
2841 bool delim = false;
2842
2843 for (elem = list; elem; elem = elem->next) {
2844 if (delim) {
2845 printf("\n");
2846 }
2847 delim = true;
2848
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002849 bdrv_image_info_dump(elem->value);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002850 }
2851}
2852
2853static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2854{
2855 return strcmp(a, b) == 0;
2856}
2857
2858/**
2859 * Open an image file chain and return an ImageInfoList
2860 *
2861 * @filename: topmost image filename
2862 * @fmt: topmost image format (may be NULL to autodetect)
2863 * @chain: true - enumerate entire backing file chain
2864 * false - only topmost image file
2865 *
2866 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2867 * image file. If there was an error a message will have been printed to
2868 * stderr.
2869 */
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002870static ImageInfoList *collect_image_info_list(bool image_opts,
2871 const char *filename,
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002872 const char *fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002873 bool chain, bool force_share)
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002874{
2875 ImageInfoList *head = NULL;
Eric Blakec3033fd2021-01-13 16:10:12 -06002876 ImageInfoList **tail = &head;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002877 GHashTable *filenames;
Wenchao Xia43526ec2013-06-06 12:27:58 +08002878 Error *err = NULL;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002879
2880 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2881
2882 while (filename) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02002883 BlockBackend *blk;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002884 BlockDriverState *bs;
2885 ImageInfo *info;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002886
2887 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2888 error_report("Backing file '%s' creates an infinite loop.",
2889 filename);
2890 goto err;
2891 }
2892 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2893
Max Reitzefaa7c42016-03-16 19:54:38 +01002894 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002895 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2896 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002897 if (!blk) {
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002898 goto err;
2899 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002900 bs = blk_bs(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002901
Wenchao Xia43526ec2013-06-06 12:27:58 +08002902 bdrv_query_image_info(bs, &info, &err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002903 if (err) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01002904 error_report_err(err);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002905 blk_unref(blk);
Wenchao Xia43526ec2013-06-06 12:27:58 +08002906 goto err;
Wenchao Xiafb0ed452013-06-06 12:27:57 +08002907 }
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002908
Eric Blakec3033fd2021-01-13 16:10:12 -06002909 QAPI_LIST_APPEND(tail, info);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002910
Markus Armbruster26f54e92014-10-07 13:59:04 +02002911 blk_unref(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002912
Stefan Hajnoczi0da7d132019-12-05 13:46:46 +00002913 /* Clear parameters that only apply to the topmost image */
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002914 filename = fmt = NULL;
Stefan Hajnoczi0da7d132019-12-05 13:46:46 +00002915 image_opts = false;
2916
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002917 if (chain) {
2918 if (info->has_full_backing_filename) {
2919 filename = info->full_backing_filename;
2920 } else if (info->has_backing_filename) {
John Snow92d617a2015-12-14 14:55:15 -05002921 error_report("Could not determine absolute backing filename,"
2922 " but backing filename '%s' present",
2923 info->backing_filename);
2924 goto err;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002925 }
2926 if (info->has_backing_filename_format) {
2927 fmt = info->backing_filename_format;
2928 }
2929 }
2930 }
2931 g_hash_table_destroy(filenames);
2932 return head;
2933
2934err:
2935 qapi_free_ImageInfoList(head);
2936 g_hash_table_destroy(filenames);
2937 return NULL;
2938}
2939
Benoît Canetc054b3f2012-09-05 13:09:02 +02002940static int img_info(int argc, char **argv)
2941{
2942 int c;
2943 OutputFormat output_format = OFORMAT_HUMAN;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002944 bool chain = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002945 const char *filename, *fmt, *output;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002946 ImageInfoList *list;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002947 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08002948 bool force_share = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002949
bellardea2384d2004-08-01 21:59:26 +00002950 fmt = NULL;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002951 output = NULL;
bellardea2384d2004-08-01 21:59:26 +00002952 for(;;) {
Benoît Canetc054b3f2012-09-05 13:09:02 +02002953 int option_index = 0;
2954 static const struct option long_options[] = {
2955 {"help", no_argument, 0, 'h'},
2956 {"format", required_argument, 0, 'f'},
2957 {"output", required_argument, 0, OPTION_OUTPUT},
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002958 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002959 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002960 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002961 {"force-share", no_argument, 0, 'U'},
Benoît Canetc054b3f2012-09-05 13:09:02 +02002962 {0, 0, 0, 0}
2963 };
Fam Zheng335e9932017-05-03 00:35:39 +08002964 c = getopt_long(argc, argv, ":f:hU",
Benoît Canetc054b3f2012-09-05 13:09:02 +02002965 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002966 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002967 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002968 }
bellardea2384d2004-08-01 21:59:26 +00002969 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002970 case ':':
2971 missing_argument(argv[optind - 1]);
2972 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002973 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002974 unrecognized_option(argv[optind - 1]);
2975 break;
bellardea2384d2004-08-01 21:59:26 +00002976 case 'h':
2977 help();
2978 break;
2979 case 'f':
2980 fmt = optarg;
2981 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002982 case 'U':
2983 force_share = true;
2984 break;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002985 case OPTION_OUTPUT:
2986 output = optarg;
2987 break;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002988 case OPTION_BACKING_CHAIN:
2989 chain = true;
2990 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01002991 case OPTION_OBJECT:
2992 user_creatable_process_cmdline(optarg);
2993 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002994 case OPTION_IMAGE_OPTS:
2995 image_opts = true;
2996 break;
bellardea2384d2004-08-01 21:59:26 +00002997 }
2998 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02002999 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003000 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003001 }
bellardea2384d2004-08-01 21:59:26 +00003002 filename = argv[optind++];
3003
Benoît Canetc054b3f2012-09-05 13:09:02 +02003004 if (output && !strcmp(output, "json")) {
3005 output_format = OFORMAT_JSON;
3006 } else if (output && !strcmp(output, "human")) {
3007 output_format = OFORMAT_HUMAN;
3008 } else if (output) {
3009 error_report("--output must be used with human or json as argument.");
3010 return 1;
3011 }
3012
Fam Zheng335e9932017-05-03 00:35:39 +08003013 list = collect_image_info_list(image_opts, filename, fmt, chain,
3014 force_share);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003015 if (!list) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003016 return 1;
3017 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02003018
Benoît Canetc054b3f2012-09-05 13:09:02 +02003019 switch (output_format) {
3020 case OFORMAT_HUMAN:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003021 dump_human_image_info_list(list);
Benoît Canetc054b3f2012-09-05 13:09:02 +02003022 break;
3023 case OFORMAT_JSON:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003024 if (chain) {
3025 dump_json_image_info_list(list);
3026 } else {
3027 dump_json_image_info(list->value);
3028 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02003029 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003030 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02003031
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003032 qapi_free_ImageInfoList(list);
bellardea2384d2004-08-01 21:59:26 +00003033 return 0;
3034}
3035
Eric Blake30065d12019-03-26 13:40:43 -05003036static int dump_map_entry(OutputFormat output_format, MapEntry *e,
3037 MapEntry *next)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003038{
3039 switch (output_format) {
3040 case OFORMAT_HUMAN:
Fam Zheng16b0d552016-01-26 11:59:02 +08003041 if (e->data && !e->has_offset) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003042 error_report("File contains external, encrypted or compressed clusters.");
Eric Blake30065d12019-03-26 13:40:43 -05003043 return -1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003044 }
Fam Zheng16b0d552016-01-26 11:59:02 +08003045 if (e->data && !e->zero) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003046 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
Fam Zheng16b0d552016-01-26 11:59:02 +08003047 e->start, e->length,
3048 e->has_offset ? e->offset : 0,
3049 e->has_filename ? e->filename : "");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003050 }
3051 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
3052 * Modify the flags here to allow more coalescing.
3053 */
Fam Zheng16b0d552016-01-26 11:59:02 +08003054 if (next && (!next->data || next->zero)) {
3055 next->data = false;
3056 next->zero = true;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003057 }
3058 break;
3059 case OFORMAT_JSON:
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003060 printf("{ \"start\": %"PRId64", \"length\": %"PRId64","
Eric Blake8417e132021-07-01 14:06:55 -05003061 " \"depth\": %"PRId64", \"present\": %s, \"zero\": %s,"
3062 " \"data\": %s", e->start, e->length, e->depth,
3063 e->present ? "true" : "false",
Fam Zheng16b0d552016-01-26 11:59:02 +08003064 e->zero ? "true" : "false",
3065 e->data ? "true" : "false");
3066 if (e->has_offset) {
Paolo Bonzinic745bfb2013-09-11 18:47:52 +02003067 printf(", \"offset\": %"PRId64"", e->offset);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003068 }
3069 putchar('}');
3070
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003071 if (next) {
3072 puts(",");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003073 }
3074 break;
3075 }
Eric Blake30065d12019-03-26 13:40:43 -05003076 return 0;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003077}
3078
Eric Blake5e344dd2017-10-11 22:47:02 -05003079static int get_block_status(BlockDriverState *bs, int64_t offset,
3080 int64_t bytes, MapEntry *e)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003081{
Eric Blake237d78f2017-10-11 22:47:03 -05003082 int ret;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003083 int depth;
Fam Zheng67a0fd22016-01-26 11:58:48 +08003084 BlockDriverState *file;
John Snow28756452016-02-05 13:12:33 -05003085 bool has_offset;
Eric Blake237d78f2017-10-11 22:47:03 -05003086 int64_t map;
Max Reitzf30c66b2019-02-01 20:29:05 +01003087 char *filename = NULL;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003088
3089 /* As an optimization, we could cache the current range of unallocated
3090 * clusters in each file of the chain, and avoid querying the same
3091 * range repeatedly.
3092 */
3093
3094 depth = 0;
3095 for (;;) {
Max Reitz4a2061e2019-06-12 19:00:30 +02003096 bs = bdrv_skip_filters(bs);
Eric Blake237d78f2017-10-11 22:47:03 -05003097 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003098 if (ret < 0) {
3099 return ret;
3100 }
Eric Blake237d78f2017-10-11 22:47:03 -05003101 assert(bytes);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003102 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
3103 break;
3104 }
Max Reitz4a2061e2019-06-12 19:00:30 +02003105 bs = bdrv_cow_bs(bs);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003106 if (bs == NULL) {
3107 ret = 0;
3108 break;
3109 }
3110
3111 depth++;
3112 }
3113
John Snow28756452016-02-05 13:12:33 -05003114 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
3115
Max Reitzf30c66b2019-02-01 20:29:05 +01003116 if (file && has_offset) {
3117 bdrv_refresh_filename(file);
3118 filename = file->filename;
3119 }
3120
John Snow28756452016-02-05 13:12:33 -05003121 *e = (MapEntry) {
Eric Blake5e344dd2017-10-11 22:47:02 -05003122 .start = offset,
Eric Blake237d78f2017-10-11 22:47:03 -05003123 .length = bytes,
John Snow28756452016-02-05 13:12:33 -05003124 .data = !!(ret & BDRV_BLOCK_DATA),
3125 .zero = !!(ret & BDRV_BLOCK_ZERO),
Eric Blake237d78f2017-10-11 22:47:03 -05003126 .offset = map,
John Snow28756452016-02-05 13:12:33 -05003127 .has_offset = has_offset,
3128 .depth = depth,
Eric Blake8417e132021-07-01 14:06:55 -05003129 .present = !!(ret & BDRV_BLOCK_ALLOCATED),
Max Reitzf30c66b2019-02-01 20:29:05 +01003130 .has_filename = filename,
3131 .filename = filename,
John Snow28756452016-02-05 13:12:33 -05003132 };
3133
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003134 return 0;
3135}
3136
Fam Zheng16b0d552016-01-26 11:59:02 +08003137static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
3138{
3139 if (curr->length == 0) {
3140 return false;
3141 }
3142 if (curr->zero != next->zero ||
3143 curr->data != next->data ||
3144 curr->depth != next->depth ||
Eric Blake8417e132021-07-01 14:06:55 -05003145 curr->present != next->present ||
Fam Zheng16b0d552016-01-26 11:59:02 +08003146 curr->has_filename != next->has_filename ||
3147 curr->has_offset != next->has_offset) {
3148 return false;
3149 }
3150 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
3151 return false;
3152 }
3153 if (curr->has_offset && curr->offset + curr->length != next->offset) {
3154 return false;
3155 }
3156 return true;
3157}
3158
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003159static int img_map(int argc, char **argv)
3160{
3161 int c;
3162 OutputFormat output_format = OFORMAT_HUMAN;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003163 BlockBackend *blk;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003164 BlockDriverState *bs;
3165 const char *filename, *fmt, *output;
3166 int64_t length;
3167 MapEntry curr = { .length = 0 }, next;
3168 int ret = 0;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003169 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003170 bool force_share = false;
Eyal Moscovicic0469492020-05-13 16:36:29 +03003171 int64_t start_offset = 0;
3172 int64_t max_length = -1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003173
3174 fmt = NULL;
3175 output = NULL;
3176 for (;;) {
3177 int option_index = 0;
3178 static const struct option long_options[] = {
3179 {"help", no_argument, 0, 'h'},
3180 {"format", required_argument, 0, 'f'},
3181 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003182 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003183 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003184 {"force-share", no_argument, 0, 'U'},
Eyal Moscovicic0469492020-05-13 16:36:29 +03003185 {"start-offset", required_argument, 0, 's'},
3186 {"max-length", required_argument, 0, 'l'},
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003187 {0, 0, 0, 0}
3188 };
Eyal Moscovicic0469492020-05-13 16:36:29 +03003189 c = getopt_long(argc, argv, ":f:s:l:hU",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003190 long_options, &option_index);
3191 if (c == -1) {
3192 break;
3193 }
3194 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003195 case ':':
3196 missing_argument(argv[optind - 1]);
3197 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003198 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003199 unrecognized_option(argv[optind - 1]);
3200 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003201 case 'h':
3202 help();
3203 break;
3204 case 'f':
3205 fmt = optarg;
3206 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003207 case 'U':
3208 force_share = true;
3209 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003210 case OPTION_OUTPUT:
3211 output = optarg;
3212 break;
Eyal Moscovicic0469492020-05-13 16:36:29 +03003213 case 's':
3214 start_offset = cvtnum("start offset", optarg);
3215 if (start_offset < 0) {
3216 return 1;
3217 }
3218 break;
3219 case 'l':
3220 max_length = cvtnum("max length", optarg);
3221 if (max_length < 0) {
3222 return 1;
3223 }
3224 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003225 case OPTION_OBJECT:
3226 user_creatable_process_cmdline(optarg);
3227 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003228 case OPTION_IMAGE_OPTS:
3229 image_opts = true;
3230 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003231 }
3232 }
Fam Zhengac1307a2014-04-22 13:36:11 +08003233 if (optind != argc - 1) {
3234 error_exit("Expecting one image file name");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003235 }
Fam Zhengac1307a2014-04-22 13:36:11 +08003236 filename = argv[optind];
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003237
3238 if (output && !strcmp(output, "json")) {
3239 output_format = OFORMAT_JSON;
3240 } else if (output && !strcmp(output, "human")) {
3241 output_format = OFORMAT_HUMAN;
3242 } else if (output) {
3243 error_report("--output must be used with human or json as argument.");
3244 return 1;
3245 }
3246
Fam Zheng335e9932017-05-03 00:35:39 +08003247 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003248 if (!blk) {
3249 return 1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003250 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003251 bs = blk_bs(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003252
3253 if (output_format == OFORMAT_HUMAN) {
3254 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003255 } else if (output_format == OFORMAT_JSON) {
3256 putchar('[');
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003257 }
3258
Max Reitzf1d3cd72015-02-05 13:58:18 -05003259 length = blk_getlength(blk);
Eyal Moscovici8f282e82020-05-13 16:36:27 +03003260 if (length < 0) {
3261 error_report("Failed to get size for '%s'", filename);
3262 return 1;
3263 }
Eyal Moscovicic0469492020-05-13 16:36:29 +03003264 if (max_length != -1) {
3265 length = MIN(start_offset + max_length, length);
3266 }
Eyal Moscovici8f282e82020-05-13 16:36:27 +03003267
Eyal Moscovicic0469492020-05-13 16:36:29 +03003268 curr.start = start_offset;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003269 while (curr.start + curr.length < length) {
Eric Blake5e344dd2017-10-11 22:47:02 -05003270 int64_t offset = curr.start + curr.length;
Kevin Wolfd0ceea82020-07-07 16:46:29 +02003271 int64_t n = length - offset;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003272
Eric Blake5e344dd2017-10-11 22:47:02 -05003273 ret = get_block_status(bs, offset, n, &next);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003274 if (ret < 0) {
3275 error_report("Could not read file metadata: %s", strerror(-ret));
3276 goto out;
3277 }
3278
Fam Zheng16b0d552016-01-26 11:59:02 +08003279 if (entry_mergeable(&curr, &next)) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003280 curr.length += next.length;
3281 continue;
3282 }
3283
3284 if (curr.length > 0) {
Eric Blake30065d12019-03-26 13:40:43 -05003285 ret = dump_map_entry(output_format, &curr, &next);
3286 if (ret < 0) {
3287 goto out;
3288 }
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003289 }
3290 curr = next;
3291 }
3292
Eric Blake30065d12019-03-26 13:40:43 -05003293 ret = dump_map_entry(output_format, &curr, NULL);
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003294 if (output_format == OFORMAT_JSON) {
3295 puts("]");
3296 }
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003297
3298out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003299 blk_unref(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003300 return ret < 0;
3301}
3302
aliguorif7b4a942009-01-07 17:40:15 +00003303#define SNAPSHOT_LIST 1
3304#define SNAPSHOT_CREATE 2
3305#define SNAPSHOT_APPLY 3
3306#define SNAPSHOT_DELETE 4
3307
Stuart Brady153859b2009-06-07 00:42:17 +01003308static int img_snapshot(int argc, char **argv)
aliguorif7b4a942009-01-07 17:40:15 +00003309{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003310 BlockBackend *blk;
aliguorif7b4a942009-01-07 17:40:15 +00003311 BlockDriverState *bs;
3312 QEMUSnapshotInfo sn;
3313 char *filename, *snapshot_name = NULL;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003314 int c, ret = 0, bdrv_oflags;
aliguorif7b4a942009-01-07 17:40:15 +00003315 int action = 0;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003316 bool quiet = false;
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003317 Error *err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003318 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003319 bool force_share = false;
Marc-André Lureauf793dde2022-03-07 11:04:00 +04003320 int64_t rt;
aliguorif7b4a942009-01-07 17:40:15 +00003321
Kevin Wolfce099542016-03-15 13:01:04 +01003322 bdrv_oflags = BDRV_O_RDWR;
aliguorif7b4a942009-01-07 17:40:15 +00003323 /* Parse commandline parameters */
3324 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003325 static const struct option long_options[] = {
3326 {"help", no_argument, 0, 'h'},
3327 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003328 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003329 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003330 {0, 0, 0, 0}
3331 };
Fam Zheng335e9932017-05-03 00:35:39 +08003332 c = getopt_long(argc, argv, ":la:c:d:hqU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003333 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003334 if (c == -1) {
aliguorif7b4a942009-01-07 17:40:15 +00003335 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003336 }
aliguorif7b4a942009-01-07 17:40:15 +00003337 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003338 case ':':
3339 missing_argument(argv[optind - 1]);
3340 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003341 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003342 unrecognized_option(argv[optind - 1]);
3343 break;
aliguorif7b4a942009-01-07 17:40:15 +00003344 case 'h':
3345 help();
Stuart Brady153859b2009-06-07 00:42:17 +01003346 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003347 case 'l':
3348 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003349 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003350 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003351 }
3352 action = SNAPSHOT_LIST;
Naphtali Spreif5edb012010-01-17 16:48:13 +02003353 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
aliguorif7b4a942009-01-07 17:40:15 +00003354 break;
3355 case 'a':
3356 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003357 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003358 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003359 }
3360 action = SNAPSHOT_APPLY;
3361 snapshot_name = optarg;
3362 break;
3363 case 'c':
3364 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003365 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003366 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003367 }
3368 action = SNAPSHOT_CREATE;
3369 snapshot_name = optarg;
3370 break;
3371 case 'd':
3372 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003373 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003374 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003375 }
3376 action = SNAPSHOT_DELETE;
3377 snapshot_name = optarg;
3378 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003379 case 'q':
3380 quiet = true;
3381 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003382 case 'U':
3383 force_share = true;
3384 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003385 case OPTION_OBJECT:
3386 user_creatable_process_cmdline(optarg);
3387 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003388 case OPTION_IMAGE_OPTS:
3389 image_opts = true;
3390 break;
aliguorif7b4a942009-01-07 17:40:15 +00003391 }
3392 }
3393
Kevin Wolffc11eb22013-08-05 10:53:04 +02003394 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003395 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003396 }
aliguorif7b4a942009-01-07 17:40:15 +00003397 filename = argv[optind++];
3398
3399 /* Open the image */
Fam Zheng335e9932017-05-03 00:35:39 +08003400 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3401 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003402 if (!blk) {
3403 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003404 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003405 bs = blk_bs(blk);
aliguorif7b4a942009-01-07 17:40:15 +00003406
3407 /* Perform the requested action */
3408 switch(action) {
3409 case SNAPSHOT_LIST:
3410 dump_snapshots(bs);
3411 break;
3412
3413 case SNAPSHOT_CREATE:
3414 memset(&sn, 0, sizeof(sn));
3415 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3416
Marc-André Lureauf793dde2022-03-07 11:04:00 +04003417 rt = g_get_real_time();
3418 sn.date_sec = rt / G_USEC_PER_SEC;
3419 sn.date_nsec = (rt % G_USEC_PER_SEC) * 1000;
aliguorif7b4a942009-01-07 17:40:15 +00003420
3421 ret = bdrv_snapshot_create(bs, &sn);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003422 if (ret) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003423 error_report("Could not create snapshot '%s': %d (%s)",
aliguorif7b4a942009-01-07 17:40:15 +00003424 snapshot_name, ret, strerror(-ret));
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003425 }
aliguorif7b4a942009-01-07 17:40:15 +00003426 break;
3427
3428 case SNAPSHOT_APPLY:
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003429 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003430 if (ret) {
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003431 error_reportf_err(err, "Could not apply snapshot '%s': ",
3432 snapshot_name);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003433 }
aliguorif7b4a942009-01-07 17:40:15 +00003434 break;
3435
3436 case SNAPSHOT_DELETE:
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003437 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3438 if (ret < 0) {
3439 error_report("Could not delete snapshot '%s': snapshot not "
3440 "found", snapshot_name);
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003441 ret = 1;
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003442 } else {
3443 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3444 if (ret < 0) {
3445 error_reportf_err(err, "Could not delete snapshot '%s': ",
3446 snapshot_name);
3447 ret = 1;
3448 }
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003449 }
aliguorif7b4a942009-01-07 17:40:15 +00003450 break;
3451 }
3452
3453 /* Cleanup */
Markus Armbruster26f54e92014-10-07 13:59:04 +02003454 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003455 if (ret) {
3456 return 1;
3457 }
Stuart Brady153859b2009-06-07 00:42:17 +01003458 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003459}
3460
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003461static int img_rebase(int argc, char **argv)
3462{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003463 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
Paolo Bonzini396374c2016-02-25 23:53:54 +01003464 uint8_t *buf_old = NULL;
3465 uint8_t *buf_new = NULL;
Sam Eiderman863cc782019-05-23 19:33:36 +03003466 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
Max Reitz4a2061e2019-06-12 19:00:30 +02003467 BlockDriverState *unfiltered_bs;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003468 char *filename;
Max Reitz40055952014-07-22 22:58:42 +02003469 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3470 int c, flags, src_flags, ret;
Kevin Wolfce099542016-03-15 13:01:04 +01003471 bool writethrough, src_writethrough;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003472 int unsafe = 0;
Fam Zheng335e9932017-05-03 00:35:39 +08003473 bool force_share = false;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003474 int progress = 0;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003475 bool quiet = false;
Max Reitz34b5d2c2013-09-05 14:45:29 +02003476 Error *local_err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003477 bool image_opts = false;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003478
3479 /* Parse commandline parameters */
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003480 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003481 cache = BDRV_DEFAULT_CACHE;
Max Reitz40055952014-07-22 22:58:42 +02003482 src_cache = BDRV_DEFAULT_CACHE;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003483 out_baseimg = NULL;
3484 out_basefmt = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003485 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003486 static const struct option long_options[] = {
3487 {"help", no_argument, 0, 'h'},
3488 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003489 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003490 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003491 {0, 0, 0, 0}
3492 };
Fam Zheng335e9932017-05-03 00:35:39 +08003493 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003494 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003495 if (c == -1) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003496 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003497 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003498 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003499 case ':':
3500 missing_argument(argv[optind - 1]);
3501 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003502 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003503 unrecognized_option(argv[optind - 1]);
3504 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003505 case 'h':
3506 help();
3507 return 0;
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003508 case 'f':
3509 fmt = optarg;
3510 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003511 case 'F':
3512 out_basefmt = optarg;
3513 break;
3514 case 'b':
3515 out_baseimg = optarg;
3516 break;
3517 case 'u':
3518 unsafe = 1;
3519 break;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003520 case 'p':
3521 progress = 1;
3522 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003523 case 't':
3524 cache = optarg;
3525 break;
Max Reitz40055952014-07-22 22:58:42 +02003526 case 'T':
3527 src_cache = optarg;
3528 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003529 case 'q':
3530 quiet = true;
3531 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003532 case OPTION_OBJECT:
3533 user_creatable_process_cmdline(optarg);
3534 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003535 case OPTION_IMAGE_OPTS:
3536 image_opts = true;
3537 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003538 case 'U':
3539 force_share = true;
3540 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003541 }
3542 }
3543
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003544 if (quiet) {
3545 progress = 0;
3546 }
3547
Fam Zhengac1307a2014-04-22 13:36:11 +08003548 if (optind != argc - 1) {
3549 error_exit("Expecting one image file name");
3550 }
3551 if (!unsafe && !out_baseimg) {
3552 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003553 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003554 filename = argv[optind++];
3555
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003556 qemu_progress_init(progress, 2.0);
3557 qemu_progress_print(0, 100);
3558
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003559 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
Kevin Wolfce099542016-03-15 13:01:04 +01003560 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003561 if (ret < 0) {
3562 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003563 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003564 }
3565
Kevin Wolfce099542016-03-15 13:01:04 +01003566 src_flags = 0;
3567 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
Max Reitz40055952014-07-22 22:58:42 +02003568 if (ret < 0) {
3569 error_report("Invalid source cache option: %s", src_cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003570 goto out;
Max Reitz40055952014-07-22 22:58:42 +02003571 }
3572
Kevin Wolfce099542016-03-15 13:01:04 +01003573 /* The source files are opened read-only, don't care about WCE */
3574 assert((src_flags & BDRV_O_RDWR) == 0);
3575 (void) src_writethrough;
3576
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003577 /*
3578 * Open the images.
3579 *
3580 * Ignore the old backing file for unsafe rebase in case we want to correct
3581 * the reference to a renamed or moved backing file.
3582 */
Fam Zheng335e9932017-05-03 00:35:39 +08003583 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3584 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003585 if (!blk) {
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003586 ret = -1;
3587 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003588 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003589 bs = blk_bs(blk);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003590
Max Reitz4a2061e2019-06-12 19:00:30 +02003591 unfiltered_bs = bdrv_skip_filters(bs);
3592
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003593 if (out_basefmt != NULL) {
Max Reitz644483d2015-02-05 13:58:17 -05003594 if (bdrv_find_format(out_basefmt) == NULL) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003595 error_report("Invalid format name: '%s'", out_basefmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003596 ret = -1;
3597 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003598 }
3599 }
3600
3601 /* For safe rebasing we need to compare old and new backing file */
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003602 if (!unsafe) {
Max Reitz644483d2015-02-05 13:58:17 -05003603 QDict *options = NULL;
Max Reitz4a2061e2019-06-12 19:00:30 +02003604 BlockDriverState *base_bs = bdrv_cow_bs(unfiltered_bs);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003605
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003606 if (base_bs) {
Kevin Wolfd861ab32019-04-25 14:25:10 +02003607 blk_old_backing = blk_new(qemu_get_aio_context(),
3608 BLK_PERM_CONSISTENT_READ,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003609 BLK_PERM_ALL);
3610 ret = blk_insert_bs(blk_old_backing, base_bs,
3611 &local_err);
3612 if (ret < 0) {
Max Reitz35ddd932019-05-09 19:52:35 +02003613 error_reportf_err(local_err,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003614 "Could not reuse old backing file '%s': ",
3615 base_bs->filename);
Max Reitz35ddd932019-05-09 19:52:35 +02003616 goto out;
3617 }
3618 } else {
3619 blk_old_backing = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003620 }
Max Reitz644483d2015-02-05 13:58:17 -05003621
Alex Bligha6166732012-10-16 13:46:18 +01003622 if (out_baseimg[0]) {
Max Reitzd16699b2018-05-09 20:20:01 +02003623 const char *overlay_filename;
3624 char *out_real_path;
3625
Fam Zheng335e9932017-05-03 00:35:39 +08003626 options = qdict_new();
Max Reitz644483d2015-02-05 13:58:17 -05003627 if (out_basefmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003628 qdict_put_str(options, "driver", out_basefmt);
Fam Zheng335e9932017-05-03 00:35:39 +08003629 }
3630 if (force_share) {
3631 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Max Reitz644483d2015-02-05 13:58:17 -05003632 }
3633
Max Reitzf30c66b2019-02-01 20:29:05 +01003634 bdrv_refresh_filename(bs);
Max Reitzd16699b2018-05-09 20:20:01 +02003635 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3636 : bs->filename;
Max Reitz645ae7d2019-02-01 20:29:14 +01003637 out_real_path =
3638 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3639 out_baseimg,
3640 &local_err);
Max Reitzd16699b2018-05-09 20:20:01 +02003641 if (local_err) {
Max Reitzf22356d2019-05-28 21:53:38 +02003642 qobject_unref(options);
Max Reitzd16699b2018-05-09 20:20:01 +02003643 error_reportf_err(local_err,
3644 "Could not resolve backing filename: ");
3645 ret = -1;
Max Reitzd16699b2018-05-09 20:20:01 +02003646 goto out;
3647 }
3648
Sam Eiderman863cc782019-05-23 19:33:36 +03003649 /*
3650 * Find out whether we rebase an image on top of a previous image
3651 * in its chain.
3652 */
3653 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
Sam Eiderman330c7292019-05-23 19:33:37 +03003654 if (prefix_chain_bs) {
Max Reitzf22356d2019-05-28 21:53:38 +02003655 qobject_unref(options);
Sam Eiderman330c7292019-05-23 19:33:37 +03003656 g_free(out_real_path);
Max Reitzf22356d2019-05-28 21:53:38 +02003657
Kevin Wolfd861ab32019-04-25 14:25:10 +02003658 blk_new_backing = blk_new(qemu_get_aio_context(),
3659 BLK_PERM_CONSISTENT_READ,
Sam Eiderman330c7292019-05-23 19:33:37 +03003660 BLK_PERM_ALL);
3661 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
3662 &local_err);
3663 if (ret < 0) {
3664 error_reportf_err(local_err,
3665 "Could not reuse backing file '%s': ",
3666 out_baseimg);
3667 goto out;
3668 }
3669 } else {
3670 blk_new_backing = blk_new_open(out_real_path, NULL,
3671 options, src_flags, &local_err);
3672 g_free(out_real_path);
3673 if (!blk_new_backing) {
3674 error_reportf_err(local_err,
3675 "Could not open new backing file '%s': ",
3676 out_baseimg);
3677 ret = -1;
3678 goto out;
3679 }
Alex Bligha6166732012-10-16 13:46:18 +01003680 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003681 }
3682 }
3683
3684 /*
3685 * Check each unallocated cluster in the COW file. If it is unallocated,
3686 * accesses go to the backing file. We must therefore compare this cluster
3687 * in the old and new backing file, and if they differ we need to copy it
3688 * from the old backing file into the COW file.
3689 *
3690 * If qemu-img crashes during this step, no harm is done. The content of
3691 * the image is the same as the original one at any time.
3692 */
3693 if (!unsafe) {
Eric Blake41536282017-10-11 22:47:15 -05003694 int64_t size;
Max Reitz35ddd932019-05-09 19:52:35 +02003695 int64_t old_backing_size = 0;
Eric Blake41536282017-10-11 22:47:15 -05003696 int64_t new_backing_size = 0;
3697 uint64_t offset;
3698 int64_t n;
Kevin Wolf1f710492012-10-12 14:29:18 +02003699 float local_progress = 0;
TeLeMand6771bf2010-02-08 16:20:00 +08003700
Max Reitzf1d3cd72015-02-05 13:58:18 -05003701 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3702 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003703
Eric Blake41536282017-10-11 22:47:15 -05003704 size = blk_getlength(blk);
3705 if (size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003706 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003707 filename, strerror(-size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003708 ret = -1;
3709 goto out;
3710 }
Max Reitz35ddd932019-05-09 19:52:35 +02003711 if (blk_old_backing) {
3712 old_backing_size = blk_getlength(blk_old_backing);
3713 if (old_backing_size < 0) {
3714 char backing_name[PATH_MAX];
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003715
Max Reitz35ddd932019-05-09 19:52:35 +02003716 bdrv_get_backing_filename(bs, backing_name,
3717 sizeof(backing_name));
3718 error_report("Could not get size of '%s': %s",
3719 backing_name, strerror(-old_backing_size));
3720 ret = -1;
3721 goto out;
3722 }
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003723 }
Max Reitzf1d3cd72015-02-05 13:58:18 -05003724 if (blk_new_backing) {
Eric Blake41536282017-10-11 22:47:15 -05003725 new_backing_size = blk_getlength(blk_new_backing);
3726 if (new_backing_size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003727 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003728 out_baseimg, strerror(-new_backing_size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003729 ret = -1;
3730 goto out;
3731 }
Alex Bligha6166732012-10-16 13:46:18 +01003732 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003733
Eric Blake41536282017-10-11 22:47:15 -05003734 if (size != 0) {
3735 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
Kevin Wolf1f710492012-10-12 14:29:18 +02003736 }
3737
Eric Blake41536282017-10-11 22:47:15 -05003738 for (offset = 0; offset < size; offset += n) {
Max Reitz1c6e8772019-05-09 19:52:36 +02003739 bool buf_old_is_zero = false;
3740
Eric Blake41536282017-10-11 22:47:15 -05003741 /* How many bytes can we handle with the next read? */
3742 n = MIN(IO_BUF_SIZE, size - offset);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003743
3744 /* If the cluster is allocated, we don't need to take action */
Max Reitz4a2061e2019-06-12 19:00:30 +02003745 ret = bdrv_is_allocated(unfiltered_bs, offset, n, &n);
Paolo Bonzinid6636402013-09-04 19:00:25 +02003746 if (ret < 0) {
3747 error_report("error while reading image metadata: %s",
3748 strerror(-ret));
3749 goto out;
3750 }
Kevin Wolfcc60e322010-04-29 14:47:48 +02003751 if (ret) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003752 continue;
3753 }
3754
Sam Eiderman863cc782019-05-23 19:33:36 +03003755 if (prefix_chain_bs) {
3756 /*
3757 * If cluster wasn't changed since prefix_chain, we don't need
3758 * to take action
3759 */
Max Reitz4a2061e2019-06-12 19:00:30 +02003760 ret = bdrv_is_allocated_above(bdrv_cow_bs(unfiltered_bs),
3761 prefix_chain_bs, false,
3762 offset, n, &n);
Sam Eiderman863cc782019-05-23 19:33:36 +03003763 if (ret < 0) {
3764 error_report("error while reading image metadata: %s",
3765 strerror(-ret));
3766 goto out;
3767 }
3768 if (!ret) {
3769 continue;
3770 }
3771 }
3772
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003773 /*
3774 * Read old and new backing file and take into consideration that
3775 * backing files may be smaller than the COW image.
3776 */
Eric Blake41536282017-10-11 22:47:15 -05003777 if (offset >= old_backing_size) {
3778 memset(buf_old, 0, n);
Max Reitz1c6e8772019-05-09 19:52:36 +02003779 buf_old_is_zero = true;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003780 } else {
Eric Blake41536282017-10-11 22:47:15 -05003781 if (offset + n > old_backing_size) {
3782 n = old_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003783 }
3784
Alberto Fariaa9262f52022-07-05 17:15:11 +01003785 ret = blk_pread(blk_old_backing, offset, n, buf_old, 0);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003786 if (ret < 0) {
3787 error_report("error while reading from old backing file");
3788 goto out;
3789 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003790 }
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003791
Eric Blake41536282017-10-11 22:47:15 -05003792 if (offset >= new_backing_size || !blk_new_backing) {
3793 memset(buf_new, 0, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003794 } else {
Eric Blake41536282017-10-11 22:47:15 -05003795 if (offset + n > new_backing_size) {
3796 n = new_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003797 }
3798
Alberto Fariaa9262f52022-07-05 17:15:11 +01003799 ret = blk_pread(blk_new_backing, offset, n, buf_new, 0);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003800 if (ret < 0) {
3801 error_report("error while reading from new backing file");
3802 goto out;
3803 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003804 }
3805
3806 /* If they differ, we need to write to the COW file */
3807 uint64_t written = 0;
3808
Eric Blake41536282017-10-11 22:47:15 -05003809 while (written < n) {
Eric Blakedc61cd32017-10-11 22:47:14 -05003810 int64_t pnum;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003811
Eric Blake41536282017-10-11 22:47:15 -05003812 if (compare_buffers(buf_old + written, buf_new + written,
3813 n - written, &pnum))
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003814 {
Max Reitz1c6e8772019-05-09 19:52:36 +02003815 if (buf_old_is_zero) {
3816 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0);
3817 } else {
Alberto Fariaa9262f52022-07-05 17:15:11 +01003818 ret = blk_pwrite(blk, offset + written, pnum,
3819 buf_old + written, 0);
Max Reitz1c6e8772019-05-09 19:52:36 +02003820 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003821 if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003822 error_report("Error while writing to COW image: %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003823 strerror(-ret));
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003824 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003825 }
3826 }
3827
3828 written += pnum;
3829 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003830 qemu_progress_print(local_progress, 100);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003831 }
3832 }
3833
3834 /*
3835 * Change the backing file. All clusters that are different from the old
3836 * backing file are overwritten in the COW file now, so the visible content
3837 * doesn't change when we switch the backing file.
3838 */
Alex Bligha6166732012-10-16 13:46:18 +01003839 if (out_baseimg && *out_baseimg) {
Max Reitz4a2061e2019-06-12 19:00:30 +02003840 ret = bdrv_change_backing_file(unfiltered_bs, out_baseimg, out_basefmt,
3841 true);
Alex Bligha6166732012-10-16 13:46:18 +01003842 } else {
Max Reitz4a2061e2019-06-12 19:00:30 +02003843 ret = bdrv_change_backing_file(unfiltered_bs, NULL, NULL, false);
Alex Bligha6166732012-10-16 13:46:18 +01003844 }
3845
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003846 if (ret == -ENOSPC) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003847 error_report("Could not change the backing file to '%s': No "
3848 "space left in the file header", out_baseimg);
Eric Blakea7cd44b2021-07-08 10:52:28 -05003849 } else if (ret == -EINVAL && out_baseimg && !out_basefmt) {
3850 error_report("Could not change the backing file to '%s': backing "
3851 "format must be specified", out_baseimg);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003852 } else if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003853 error_report("Could not change the backing file to '%s': %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003854 out_baseimg, strerror(-ret));
3855 }
3856
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003857 qemu_progress_print(100, 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003858 /*
3859 * TODO At this point it is possible to check if any clusters that are
3860 * allocated in the COW file are the same in the backing file. If so, they
3861 * could be dropped from the COW file. Don't do this before switching the
3862 * backing file, in case of a crash this would lead to corruption.
3863 */
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003864out:
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003865 qemu_progress_end();
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003866 /* Cleanup */
3867 if (!unsafe) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02003868 blk_unref(blk_old_backing);
Markus Armbruster26f54e92014-10-07 13:59:04 +02003869 blk_unref(blk_new_backing);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003870 }
Paolo Bonzini396374c2016-02-25 23:53:54 +01003871 qemu_vfree(buf_old);
3872 qemu_vfree(buf_new);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003873
Markus Armbruster26f54e92014-10-07 13:59:04 +02003874 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003875 if (ret) {
3876 return 1;
3877 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003878 return 0;
3879}
3880
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003881static int img_resize(int argc, char **argv)
3882{
Markus Armbruster6750e792015-02-12 17:43:08 +01003883 Error *err = NULL;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003884 int c, ret, relative;
3885 const char *filename, *fmt, *size;
Max Reitz09c5c6d2019-09-18 11:51:44 +02003886 int64_t n, total_size, current_size;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003887 bool quiet = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003888 BlockBackend *blk = NULL;
Max Reitzdc5f6902017-06-13 22:20:55 +02003889 PreallocMode prealloc = PREALLOC_MODE_OFF;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003890 QemuOpts *param;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003891
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003892 static QemuOptsList resize_options = {
3893 .name = "resize_options",
3894 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3895 .desc = {
3896 {
3897 .name = BLOCK_OPT_SIZE,
3898 .type = QEMU_OPT_SIZE,
3899 .help = "Virtual disk size"
3900 }, {
3901 /* end of list */
3902 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003903 },
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003904 };
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003905 bool image_opts = false;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003906 bool shrink = false;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003907
Kevin Wolfe80fec72011-04-29 10:58:12 +02003908 /* Remove size from argv manually so that negative numbers are not treated
3909 * as options by getopt. */
3910 if (argc < 3) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003911 error_exit("Not enough arguments");
Kevin Wolfe80fec72011-04-29 10:58:12 +02003912 return 1;
3913 }
3914
3915 size = argv[--argc];
3916
3917 /* Parse getopt arguments */
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003918 fmt = NULL;
3919 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003920 static const struct option long_options[] = {
3921 {"help", no_argument, 0, 'h'},
3922 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003923 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Max Reitzdc5f6902017-06-13 22:20:55 +02003924 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003925 {"shrink", no_argument, 0, OPTION_SHRINK},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003926 {0, 0, 0, 0}
3927 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003928 c = getopt_long(argc, argv, ":f:hq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003929 long_options, NULL);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003930 if (c == -1) {
3931 break;
3932 }
3933 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003934 case ':':
3935 missing_argument(argv[optind - 1]);
3936 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003937 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003938 unrecognized_option(argv[optind - 1]);
3939 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003940 case 'h':
3941 help();
3942 break;
3943 case 'f':
3944 fmt = optarg;
3945 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003946 case 'q':
3947 quiet = true;
3948 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003949 case OPTION_OBJECT:
3950 user_creatable_process_cmdline(optarg);
3951 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003952 case OPTION_IMAGE_OPTS:
3953 image_opts = true;
3954 break;
Max Reitzdc5f6902017-06-13 22:20:55 +02003955 case OPTION_PREALLOCATION:
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02003956 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
Markus Armbruster06c60b62017-08-24 10:45:57 +02003957 PREALLOC_MODE__MAX, NULL);
Max Reitzdc5f6902017-06-13 22:20:55 +02003958 if (prealloc == PREALLOC_MODE__MAX) {
3959 error_report("Invalid preallocation mode '%s'", optarg);
3960 return 1;
3961 }
3962 break;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003963 case OPTION_SHRINK:
3964 shrink = true;
3965 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003966 }
3967 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02003968 if (optind != argc - 1) {
Max Reitzbe8fbd42018-02-05 17:27:45 +01003969 error_exit("Expecting image file name and size");
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003970 }
3971 filename = argv[optind++];
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003972
3973 /* Choose grow, shrink, or absolute resize mode */
3974 switch (size[0]) {
3975 case '+':
3976 relative = 1;
3977 size++;
3978 break;
3979 case '-':
3980 relative = -1;
3981 size++;
3982 break;
3983 default:
3984 relative = 0;
3985 break;
3986 }
3987
3988 /* Parse size */
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -08003989 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
Markus Armbruster235e59c2020-07-07 18:05:42 +02003990 if (!qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err)) {
Markus Armbruster6750e792015-02-12 17:43:08 +01003991 error_report_err(err);
Jes Sorensen2a819982010-12-06 17:08:31 +01003992 ret = -1;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003993 qemu_opts_del(param);
Jes Sorensen2a819982010-12-06 17:08:31 +01003994 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003995 }
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003996 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3997 qemu_opts_del(param);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003998
Max Reitzefaa7c42016-03-16 19:54:38 +01003999 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08004000 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
4001 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004002 if (!blk) {
Jes Sorensen2a819982010-12-06 17:08:31 +01004003 ret = -1;
4004 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004005 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004006
Max Reitzdc5f6902017-06-13 22:20:55 +02004007 current_size = blk_getlength(blk);
4008 if (current_size < 0) {
4009 error_report("Failed to inquire current image length: %s",
4010 strerror(-current_size));
4011 ret = -1;
4012 goto out;
4013 }
4014
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004015 if (relative) {
Max Reitzdc5f6902017-06-13 22:20:55 +02004016 total_size = current_size + n * relative;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004017 } else {
4018 total_size = n;
4019 }
4020 if (total_size <= 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01004021 error_report("New image size must be positive");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004022 ret = -1;
4023 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004024 }
4025
Max Reitzdc5f6902017-06-13 22:20:55 +02004026 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
4027 error_report("Preallocation can only be used for growing images");
4028 ret = -1;
4029 goto out;
4030 }
4031
Pavel Butsykin4ffca892017-09-18 15:42:27 +03004032 if (total_size < current_size && !shrink) {
Kevin Wolf1c404d72020-07-10 14:17:17 +02004033 error_report("Use the --shrink option to perform a shrink operation.");
Pavel Butsykin4ffca892017-09-18 15:42:27 +03004034 warn_report("Shrinking an image will delete all data beyond the "
4035 "shrunken image's end. Before performing such an "
4036 "operation, make sure there is no important data there.");
Kevin Wolf1c404d72020-07-10 14:17:17 +02004037 ret = -1;
4038 goto out;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03004039 }
4040
Max Reitze8d04f92019-09-18 11:51:43 +02004041 /*
4042 * The user expects the image to have the desired size after
4043 * resizing, so pass @exact=true. It is of no use to report
4044 * success when the image has not actually been resized.
4045 */
Kevin Wolf8c6242b2020-04-24 14:54:41 +02004046 ret = blk_truncate(blk, total_size, true, prealloc, 0, &err);
Max Reitz09c5c6d2019-09-18 11:51:44 +02004047 if (!ret) {
4048 qprintf(quiet, "Image resized.\n");
4049 } else {
Max Reitzed3d2ec2017-03-28 22:51:27 +02004050 error_report_err(err);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004051 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004052out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02004053 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004054 if (ret) {
4055 return 1;
4056 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004057 return 0;
4058}
4059
Max Reitz76a3a342014-10-27 11:12:51 +01004060static void amend_status_cb(BlockDriverState *bs,
Max Reitz8b139762015-07-27 17:51:32 +02004061 int64_t offset, int64_t total_work_size,
4062 void *opaque)
Max Reitz76a3a342014-10-27 11:12:51 +01004063{
4064 qemu_progress_print(100.f * offset / total_work_size, 0);
4065}
4066
Max Reitz51641352018-05-09 23:00:20 +02004067static int print_amend_option_help(const char *format)
4068{
4069 BlockDriver *drv;
4070
4071 /* Find driver and parse its options */
4072 drv = bdrv_find_format(format);
4073 if (!drv) {
4074 error_report("Unknown file format '%s'", format);
4075 return 1;
4076 }
4077
4078 if (!drv->bdrv_amend_options) {
4079 error_report("Format driver '%s' does not support option amendment",
4080 format);
4081 return 1;
4082 }
4083
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004084 /* Every driver supporting amendment must have amend_opts */
4085 assert(drv->amend_opts);
Max Reitz51641352018-05-09 23:00:20 +02004086
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004087 printf("Amend options for '%s':\n", format);
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004088 qemu_opts_print_help(drv->amend_opts, false);
Max Reitz51641352018-05-09 23:00:20 +02004089 return 0;
4090}
4091
Max Reitz6f176b42013-09-03 10:09:50 +02004092static int img_amend(int argc, char **argv)
4093{
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01004094 Error *err = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02004095 int c, ret = 0;
4096 char *options = NULL;
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004097 QemuOptsList *amend_opts = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08004098 QemuOpts *opts = NULL;
Max Reitzbd39e6e2014-07-22 22:58:43 +02004099 const char *fmt = NULL, *filename, *cache;
4100 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01004101 bool writethrough;
Max Reitz76a3a342014-10-27 11:12:51 +01004102 bool quiet = false, progress = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02004103 BlockBackend *blk = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02004104 BlockDriverState *bs = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004105 bool image_opts = false;
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004106 bool force = false;
Max Reitz6f176b42013-09-03 10:09:50 +02004107
Max Reitzbd39e6e2014-07-22 22:58:43 +02004108 cache = BDRV_DEFAULT_CACHE;
Max Reitz6f176b42013-09-03 10:09:50 +02004109 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004110 static const struct option long_options[] = {
4111 {"help", no_argument, 0, 'h'},
4112 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004113 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004114 {"force", no_argument, 0, OPTION_FORCE},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004115 {0, 0, 0, 0}
4116 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004117 c = getopt_long(argc, argv, ":ho:f:t:pq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004118 long_options, NULL);
Max Reitz6f176b42013-09-03 10:09:50 +02004119 if (c == -1) {
4120 break;
4121 }
4122
4123 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004124 case ':':
4125 missing_argument(argv[optind - 1]);
4126 break;
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004127 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004128 unrecognized_option(argv[optind - 1]);
4129 break;
4130 case 'h':
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004131 help();
4132 break;
4133 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02004134 if (accumulate_options(&options, optarg) < 0) {
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004135 ret = -1;
4136 goto out_no_progress;
4137 }
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004138 break;
4139 case 'f':
4140 fmt = optarg;
4141 break;
4142 case 't':
4143 cache = optarg;
4144 break;
4145 case 'p':
4146 progress = true;
4147 break;
4148 case 'q':
4149 quiet = true;
4150 break;
4151 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01004152 user_creatable_process_cmdline(optarg);
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004153 break;
4154 case OPTION_IMAGE_OPTS:
4155 image_opts = true;
4156 break;
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004157 case OPTION_FORCE:
4158 force = true;
4159 break;
Max Reitz6f176b42013-09-03 10:09:50 +02004160 }
4161 }
4162
Max Reitz6f176b42013-09-03 10:09:50 +02004163 if (!options) {
Fam Zhengac1307a2014-04-22 13:36:11 +08004164 error_exit("Must specify options (-o)");
Max Reitz6f176b42013-09-03 10:09:50 +02004165 }
4166
Max Reitz76a3a342014-10-27 11:12:51 +01004167 if (quiet) {
4168 progress = false;
4169 }
4170 qemu_progress_init(progress, 1.0);
4171
Kevin Wolfa283cb62014-02-21 16:24:07 +01004172 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
4173 if (fmt && has_help_option(options)) {
4174 /* If a format is explicitly specified (and possibly no filename is
4175 * given), print option help here */
Max Reitz51641352018-05-09 23:00:20 +02004176 ret = print_amend_option_help(fmt);
Kevin Wolfa283cb62014-02-21 16:24:07 +01004177 goto out;
4178 }
4179
4180 if (optind != argc - 1) {
Max Reitzb2f27e42014-10-27 11:12:52 +01004181 error_report("Expecting one image file name");
4182 ret = -1;
4183 goto out;
Kevin Wolfa283cb62014-02-21 16:24:07 +01004184 }
Max Reitz6f176b42013-09-03 10:09:50 +02004185
Kevin Wolfce099542016-03-15 13:01:04 +01004186 flags = BDRV_O_RDWR;
4187 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitzbd39e6e2014-07-22 22:58:43 +02004188 if (ret < 0) {
4189 error_report("Invalid cache option: %s", cache);
4190 goto out;
4191 }
4192
Fam Zheng335e9932017-05-03 00:35:39 +08004193 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4194 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004195 if (!blk) {
Max Reitz6f176b42013-09-03 10:09:50 +02004196 ret = -1;
4197 goto out;
4198 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004199 bs = blk_bs(blk);
Max Reitz6f176b42013-09-03 10:09:50 +02004200
4201 fmt = bs->drv->format_name;
4202
Kevin Wolf626f84f2014-02-21 16:24:06 +01004203 if (has_help_option(options)) {
Kevin Wolfa283cb62014-02-21 16:24:07 +01004204 /* If the format was auto-detected, print option help here */
Max Reitz51641352018-05-09 23:00:20 +02004205 ret = print_amend_option_help(fmt);
Max Reitz6f176b42013-09-03 10:09:50 +02004206 goto out;
4207 }
4208
Max Reitz1f996682018-05-09 23:00:17 +02004209 if (!bs->drv->bdrv_amend_options) {
4210 error_report("Format driver '%s' does not support option amendment",
Max Reitzb2439d22014-12-02 18:32:47 +01004211 fmt);
4212 ret = -1;
4213 goto out;
4214 }
4215
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004216 /* Every driver supporting amendment must have amend_opts */
4217 assert(bs->drv->amend_opts);
Max Reitz1f996682018-05-09 23:00:17 +02004218
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004219 amend_opts = qemu_opts_append(amend_opts, bs->drv->amend_opts);
4220 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
Markus Armbruster235e59c2020-07-07 18:05:42 +02004221 if (!qemu_opts_do_parse(opts, options, NULL, &err)) {
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004222 /* Try to parse options using the create options */
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004223 amend_opts = qemu_opts_append(amend_opts, bs->drv->create_opts);
4224 qemu_opts_del(opts);
4225 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
Markus Armbruster9e194e02020-07-07 18:06:11 +02004226 if (qemu_opts_do_parse(opts, options, NULL, NULL)) {
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004227 error_append_hint(&err,
4228 "This option is only supported for image creation\n");
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004229 }
4230
Paolo Bonziniece90862017-01-04 15:56:24 +01004231 error_report_err(err);
4232 ret = -1;
4233 goto out;
Max Reitz6f176b42013-09-03 10:09:50 +02004234 }
4235
Max Reitz76a3a342014-10-27 11:12:51 +01004236 /* In case the driver does not call amend_status_cb() */
4237 qemu_progress_print(0.f, 0);
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004238 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, force, &err);
Max Reitz76a3a342014-10-27 11:12:51 +01004239 qemu_progress_print(100.f, 0);
Max Reitz6f176b42013-09-03 10:09:50 +02004240 if (ret < 0) {
Max Reitzd1402b52018-05-09 23:00:18 +02004241 error_report_err(err);
Max Reitz6f176b42013-09-03 10:09:50 +02004242 goto out;
4243 }
4244
4245out:
Max Reitz76a3a342014-10-27 11:12:51 +01004246 qemu_progress_end();
4247
Max Reitze814dff2015-08-20 16:00:38 -07004248out_no_progress:
Markus Armbruster26f54e92014-10-07 13:59:04 +02004249 blk_unref(blk);
Chunyan Liu83d05212014-06-05 17:20:51 +08004250 qemu_opts_del(opts);
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004251 qemu_opts_free(amend_opts);
Kevin Wolf626f84f2014-02-21 16:24:06 +01004252 g_free(options);
4253
Max Reitz6f176b42013-09-03 10:09:50 +02004254 if (ret) {
4255 return 1;
4256 }
4257 return 0;
4258}
4259
Kevin Wolfb6133b82014-08-05 14:17:13 +02004260typedef struct BenchData {
4261 BlockBackend *blk;
4262 uint64_t image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004263 bool write;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004264 int bufsize;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004265 int step;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004266 int nrreq;
4267 int n;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004268 int flush_interval;
4269 bool drain_on_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004270 uint8_t *buf;
4271 QEMUIOVector *qiov;
4272
4273 int in_flight;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004274 bool in_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004275 uint64_t offset;
4276} BenchData;
4277
Kevin Wolf55d539c2016-06-03 13:59:41 +02004278static void bench_undrained_flush_cb(void *opaque, int ret)
4279{
4280 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004281 error_report("Failed flush request: %s", strerror(-ret));
Kevin Wolf55d539c2016-06-03 13:59:41 +02004282 exit(EXIT_FAILURE);
4283 }
4284}
4285
Kevin Wolfb6133b82014-08-05 14:17:13 +02004286static void bench_cb(void *opaque, int ret)
4287{
4288 BenchData *b = opaque;
4289 BlockAIOCB *acb;
4290
4291 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004292 error_report("Failed request: %s", strerror(-ret));
Kevin Wolfb6133b82014-08-05 14:17:13 +02004293 exit(EXIT_FAILURE);
4294 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004295
4296 if (b->in_flush) {
4297 /* Just finished a flush with drained queue: Start next requests */
4298 assert(b->in_flight == 0);
4299 b->in_flush = false;
4300 } else if (b->in_flight > 0) {
4301 int remaining = b->n - b->in_flight;
4302
Kevin Wolfb6133b82014-08-05 14:17:13 +02004303 b->n--;
4304 b->in_flight--;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004305
4306 /* Time for flush? Drain queue if requested, then flush */
4307 if (b->flush_interval && remaining % b->flush_interval == 0) {
4308 if (!b->in_flight || !b->drain_on_flush) {
4309 BlockCompletionFunc *cb;
4310
4311 if (b->drain_on_flush) {
4312 b->in_flush = true;
4313 cb = bench_cb;
4314 } else {
4315 cb = bench_undrained_flush_cb;
4316 }
4317
4318 acb = blk_aio_flush(b->blk, cb, b);
4319 if (!acb) {
4320 error_report("Failed to issue flush request");
4321 exit(EXIT_FAILURE);
4322 }
4323 }
4324 if (b->drain_on_flush) {
4325 return;
4326 }
4327 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004328 }
4329
4330 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004331 int64_t offset = b->offset;
4332 /* blk_aio_* might look for completed I/Os and kick bench_cb
4333 * again, so make sure this operation is counted by in_flight
4334 * and b->offset is ready for the next submission.
4335 */
4336 b->in_flight++;
4337 b->offset += b->step;
4338 b->offset %= b->image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004339 if (b->write) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004340 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004341 } else {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004342 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004343 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004344 if (!acb) {
4345 error_report("Failed to issue request");
4346 exit(EXIT_FAILURE);
4347 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004348 }
4349}
4350
4351static int img_bench(int argc, char **argv)
4352{
4353 int c, ret = 0;
4354 const char *fmt = NULL, *filename;
4355 bool quiet = false;
4356 bool image_opts = false;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004357 bool is_write = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004358 int count = 75000;
4359 int depth = 64;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004360 int64_t offset = 0;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004361 size_t bufsize = 4096;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004362 int pattern = 0;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004363 size_t step = 0;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004364 int flush_interval = 0;
4365 bool drain_on_flush = true;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004366 int64_t image_size;
4367 BlockBackend *blk = NULL;
4368 BenchData data = {};
4369 int flags = 0;
Kevin Wolf604e8612016-06-14 11:29:32 +02004370 bool writethrough = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004371 struct timeval t1, t2;
4372 int i;
Fam Zheng335e9932017-05-03 00:35:39 +08004373 bool force_share = false;
Stefan Hajnoczi4f384012022-10-13 14:58:59 -04004374 size_t buf_size = 0;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004375
4376 for (;;) {
4377 static const struct option long_options[] = {
4378 {"help", no_argument, 0, 'h'},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004379 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004380 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004381 {"pattern", required_argument, 0, OPTION_PATTERN},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004382 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
Fam Zheng335e9932017-05-03 00:35:39 +08004383 {"force-share", no_argument, 0, 'U'},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004384 {0, 0, 0, 0}
4385 };
Aarushi Mehtacdd26772020-01-20 14:18:55 +00004386 c = getopt_long(argc, argv, ":hc:d:f:ni:o:qs:S:t:wU", long_options,
4387 NULL);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004388 if (c == -1) {
4389 break;
4390 }
4391
4392 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004393 case ':':
4394 missing_argument(argv[optind - 1]);
4395 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004396 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004397 unrecognized_option(argv[optind - 1]);
4398 break;
4399 case 'h':
Kevin Wolfb6133b82014-08-05 14:17:13 +02004400 help();
4401 break;
4402 case 'c':
4403 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004404 unsigned long res;
4405
4406 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004407 error_report("Invalid request count specified");
4408 return 1;
4409 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004410 count = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004411 break;
4412 }
4413 case 'd':
4414 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004415 unsigned long res;
4416
4417 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004418 error_report("Invalid queue depth specified");
4419 return 1;
4420 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004421 depth = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004422 break;
4423 }
4424 case 'f':
4425 fmt = optarg;
4426 break;
4427 case 'n':
4428 flags |= BDRV_O_NATIVE_AIO;
4429 break;
Aarushi Mehtacdd26772020-01-20 14:18:55 +00004430 case 'i':
4431 ret = bdrv_parse_aio(optarg, &flags);
4432 if (ret < 0) {
4433 error_report("Invalid aio option: %s", optarg);
4434 ret = -1;
4435 goto out;
4436 }
4437 break;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004438 case 'o':
4439 {
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004440 offset = cvtnum("offset", optarg);
Markus Armbruster606caa02017-02-21 21:14:04 +01004441 if (offset < 0) {
Kevin Wolfd3199a32015-07-10 18:09:18 +02004442 return 1;
4443 }
4444 break;
4445 }
4446 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004447 case 'q':
4448 quiet = true;
4449 break;
4450 case 's':
4451 {
4452 int64_t sval;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004453
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004454 sval = cvtnum_full("buffer size", optarg, 0, INT_MAX);
4455 if (sval < 0) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004456 return 1;
4457 }
4458
4459 bufsize = sval;
4460 break;
4461 }
Kevin Wolf83de9be2015-07-13 13:13:17 +02004462 case 'S':
4463 {
4464 int64_t sval;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004465
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004466 sval = cvtnum_full("step_size", optarg, 0, INT_MAX);
4467 if (sval < 0) {
Kevin Wolf83de9be2015-07-13 13:13:17 +02004468 return 1;
4469 }
4470
4471 step = sval;
4472 break;
4473 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004474 case 't':
4475 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4476 if (ret < 0) {
4477 error_report("Invalid cache mode");
4478 ret = -1;
4479 goto out;
4480 }
4481 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004482 case 'w':
4483 flags |= BDRV_O_RDWR;
4484 is_write = true;
4485 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004486 case 'U':
4487 force_share = true;
4488 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004489 case OPTION_PATTERN:
4490 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004491 unsigned long res;
4492
4493 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004494 error_report("Invalid pattern byte specified");
4495 return 1;
4496 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004497 pattern = res;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004498 break;
4499 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004500 case OPTION_FLUSH_INTERVAL:
4501 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004502 unsigned long res;
4503
4504 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004505 error_report("Invalid flush interval specified");
4506 return 1;
4507 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004508 flush_interval = res;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004509 break;
4510 }
4511 case OPTION_NO_DRAIN:
4512 drain_on_flush = false;
4513 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004514 case OPTION_IMAGE_OPTS:
4515 image_opts = true;
4516 break;
4517 }
4518 }
4519
4520 if (optind != argc - 1) {
4521 error_exit("Expecting one image file name");
4522 }
4523 filename = argv[argc - 1];
4524
Kevin Wolf55d539c2016-06-03 13:59:41 +02004525 if (!is_write && flush_interval) {
4526 error_report("--flush-interval is only available in write tests");
4527 ret = -1;
4528 goto out;
4529 }
4530 if (flush_interval && flush_interval < depth) {
4531 error_report("Flush interval can't be smaller than depth");
4532 ret = -1;
4533 goto out;
4534 }
4535
Fam Zheng335e9932017-05-03 00:35:39 +08004536 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4537 force_share);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004538 if (!blk) {
4539 ret = -1;
4540 goto out;
4541 }
4542
4543 image_size = blk_getlength(blk);
4544 if (image_size < 0) {
4545 ret = image_size;
4546 goto out;
4547 }
4548
4549 data = (BenchData) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004550 .blk = blk,
4551 .image_size = image_size,
4552 .bufsize = bufsize,
4553 .step = step ?: bufsize,
4554 .nrreq = depth,
4555 .n = count,
4556 .offset = offset,
4557 .write = is_write,
4558 .flush_interval = flush_interval,
4559 .drain_on_flush = drain_on_flush,
Kevin Wolfb6133b82014-08-05 14:17:13 +02004560 };
Kevin Wolfd3199a32015-07-10 18:09:18 +02004561 printf("Sending %d %s requests, %d bytes each, %d in parallel "
Kevin Wolf83de9be2015-07-13 13:13:17 +02004562 "(starting at offset %" PRId64 ", step size %d)\n",
Kevin Wolfd3199a32015-07-10 18:09:18 +02004563 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
Kevin Wolf83de9be2015-07-13 13:13:17 +02004564 data.offset, data.step);
Kevin Wolf55d539c2016-06-03 13:59:41 +02004565 if (flush_interval) {
4566 printf("Sending flush every %d requests\n", flush_interval);
4567 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004568
Fam Zheng79d46582018-01-16 14:08:58 +08004569 buf_size = data.nrreq * data.bufsize;
4570 data.buf = blk_blockalign(blk, buf_size);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004571 memset(data.buf, pattern, data.nrreq * data.bufsize);
4572
Stefan Hajnoczif4ec04b2022-10-13 14:59:02 -04004573 blk_register_buf(blk, data.buf, buf_size, &error_fatal);
Fam Zheng79d46582018-01-16 14:08:58 +08004574
Kevin Wolfb6133b82014-08-05 14:17:13 +02004575 data.qiov = g_new(QEMUIOVector, data.nrreq);
4576 for (i = 0; i < data.nrreq; i++) {
4577 qemu_iovec_init(&data.qiov[i], 1);
4578 qemu_iovec_add(&data.qiov[i],
4579 data.buf + i * data.bufsize, data.bufsize);
4580 }
4581
4582 gettimeofday(&t1, NULL);
4583 bench_cb(&data, 0);
4584
4585 while (data.n > 0) {
4586 main_loop_wait(false);
4587 }
4588 gettimeofday(&t2, NULL);
4589
4590 printf("Run completed in %3.3f seconds.\n",
4591 (t2.tv_sec - t1.tv_sec)
4592 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4593
4594out:
Fam Zheng79d46582018-01-16 14:08:58 +08004595 if (data.buf) {
Stefan Hajnoczi4f384012022-10-13 14:58:59 -04004596 blk_unregister_buf(blk, data.buf, buf_size);
Fam Zheng79d46582018-01-16 14:08:58 +08004597 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004598 qemu_vfree(data.buf);
4599 blk_unref(blk);
4600
4601 if (ret) {
4602 return 1;
4603 }
4604 return 0;
4605}
4606
Eric Blake3b51ab42020-05-12 20:16:45 -05004607enum ImgBitmapAct {
4608 BITMAP_ADD,
4609 BITMAP_REMOVE,
4610 BITMAP_CLEAR,
4611 BITMAP_ENABLE,
4612 BITMAP_DISABLE,
4613 BITMAP_MERGE,
4614};
4615typedef struct ImgBitmapAction {
4616 enum ImgBitmapAct act;
4617 const char *src; /* only used for merge */
4618 QSIMPLEQ_ENTRY(ImgBitmapAction) next;
4619} ImgBitmapAction;
4620
4621static int img_bitmap(int argc, char **argv)
4622{
4623 Error *err = NULL;
4624 int c, ret = 1;
4625 QemuOpts *opts = NULL;
4626 const char *fmt = NULL, *src_fmt = NULL, *src_filename = NULL;
4627 const char *filename, *bitmap;
4628 BlockBackend *blk = NULL, *src = NULL;
4629 BlockDriverState *bs = NULL, *src_bs = NULL;
4630 bool image_opts = false;
4631 int64_t granularity = 0;
4632 bool add = false, merge = false;
4633 QSIMPLEQ_HEAD(, ImgBitmapAction) actions;
4634 ImgBitmapAction *act, *act_next;
4635 const char *op;
4636
4637 QSIMPLEQ_INIT(&actions);
4638
4639 for (;;) {
4640 static const struct option long_options[] = {
4641 {"help", no_argument, 0, 'h'},
4642 {"object", required_argument, 0, OPTION_OBJECT},
4643 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4644 {"add", no_argument, 0, OPTION_ADD},
4645 {"remove", no_argument, 0, OPTION_REMOVE},
4646 {"clear", no_argument, 0, OPTION_CLEAR},
4647 {"enable", no_argument, 0, OPTION_ENABLE},
4648 {"disable", no_argument, 0, OPTION_DISABLE},
4649 {"merge", required_argument, 0, OPTION_MERGE},
4650 {"granularity", required_argument, 0, 'g'},
4651 {"source-file", required_argument, 0, 'b'},
4652 {"source-format", required_argument, 0, 'F'},
4653 {0, 0, 0, 0}
4654 };
4655 c = getopt_long(argc, argv, ":b:f:F:g:h", long_options, NULL);
4656 if (c == -1) {
4657 break;
4658 }
4659
4660 switch (c) {
4661 case ':':
4662 missing_argument(argv[optind - 1]);
4663 break;
4664 case '?':
4665 unrecognized_option(argv[optind - 1]);
4666 break;
4667 case 'h':
4668 help();
4669 break;
4670 case 'b':
4671 src_filename = optarg;
4672 break;
4673 case 'f':
4674 fmt = optarg;
4675 break;
4676 case 'F':
4677 src_fmt = optarg;
4678 break;
4679 case 'g':
4680 granularity = cvtnum("granularity", optarg);
4681 if (granularity < 0) {
4682 return 1;
4683 }
4684 break;
4685 case OPTION_ADD:
4686 act = g_new0(ImgBitmapAction, 1);
4687 act->act = BITMAP_ADD;
4688 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4689 add = true;
4690 break;
4691 case OPTION_REMOVE:
4692 act = g_new0(ImgBitmapAction, 1);
4693 act->act = BITMAP_REMOVE;
4694 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4695 break;
4696 case OPTION_CLEAR:
4697 act = g_new0(ImgBitmapAction, 1);
4698 act->act = BITMAP_CLEAR;
4699 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4700 break;
4701 case OPTION_ENABLE:
4702 act = g_new0(ImgBitmapAction, 1);
4703 act->act = BITMAP_ENABLE;
4704 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4705 break;
4706 case OPTION_DISABLE:
4707 act = g_new0(ImgBitmapAction, 1);
4708 act->act = BITMAP_DISABLE;
4709 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4710 break;
4711 case OPTION_MERGE:
4712 act = g_new0(ImgBitmapAction, 1);
4713 act->act = BITMAP_MERGE;
4714 act->src = optarg;
4715 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4716 merge = true;
4717 break;
4718 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01004719 user_creatable_process_cmdline(optarg);
Eric Blake3b51ab42020-05-12 20:16:45 -05004720 break;
4721 case OPTION_IMAGE_OPTS:
4722 image_opts = true;
4723 break;
4724 }
4725 }
4726
Eric Blake3b51ab42020-05-12 20:16:45 -05004727 if (QSIMPLEQ_EMPTY(&actions)) {
4728 error_report("Need at least one of --add, --remove, --clear, "
4729 "--enable, --disable, or --merge");
4730 goto out;
4731 }
4732
4733 if (granularity && !add) {
4734 error_report("granularity only supported with --add");
4735 goto out;
4736 }
4737 if (src_fmt && !src_filename) {
4738 error_report("-F only supported with -b");
4739 goto out;
4740 }
4741 if (src_filename && !merge) {
4742 error_report("Merge bitmap source file only supported with "
4743 "--merge");
4744 goto out;
4745 }
4746
4747 if (optind != argc - 2) {
4748 error_report("Expecting filename and bitmap name");
4749 goto out;
4750 }
4751
4752 filename = argv[optind];
4753 bitmap = argv[optind + 1];
4754
Eric Blake14f16bf2020-09-14 14:10:09 -05004755 /*
4756 * No need to open backing chains; we will be manipulating bitmaps
4757 * directly in this image without reference to image contents.
4758 */
4759 blk = img_open(image_opts, filename, fmt, BDRV_O_RDWR | BDRV_O_NO_BACKING,
4760 false, false, false);
Eric Blake3b51ab42020-05-12 20:16:45 -05004761 if (!blk) {
4762 goto out;
4763 }
4764 bs = blk_bs(blk);
4765 if (src_filename) {
Eric Blake14f16bf2020-09-14 14:10:09 -05004766 src = img_open(false, src_filename, src_fmt, BDRV_O_NO_BACKING,
4767 false, false, false);
Eric Blake3b51ab42020-05-12 20:16:45 -05004768 if (!src) {
4769 goto out;
4770 }
4771 src_bs = blk_bs(src);
4772 } else {
4773 src_bs = bs;
4774 }
4775
4776 QSIMPLEQ_FOREACH_SAFE(act, &actions, next, act_next) {
4777 switch (act->act) {
4778 case BITMAP_ADD:
4779 qmp_block_dirty_bitmap_add(bs->node_name, bitmap,
4780 !!granularity, granularity, true, true,
4781 false, false, &err);
4782 op = "add";
4783 break;
4784 case BITMAP_REMOVE:
4785 qmp_block_dirty_bitmap_remove(bs->node_name, bitmap, &err);
4786 op = "remove";
4787 break;
4788 case BITMAP_CLEAR:
4789 qmp_block_dirty_bitmap_clear(bs->node_name, bitmap, &err);
4790 op = "clear";
4791 break;
4792 case BITMAP_ENABLE:
4793 qmp_block_dirty_bitmap_enable(bs->node_name, bitmap, &err);
4794 op = "enable";
4795 break;
4796 case BITMAP_DISABLE:
4797 qmp_block_dirty_bitmap_disable(bs->node_name, bitmap, &err);
4798 op = "disable";
4799 break;
Eric Blake6c729dd2020-05-21 14:21:35 -05004800 case BITMAP_MERGE:
4801 do_dirty_bitmap_merge(bs->node_name, bitmap, src_bs->node_name,
4802 act->src, &err);
Eric Blake3b51ab42020-05-12 20:16:45 -05004803 op = "merge";
4804 break;
Eric Blake3b51ab42020-05-12 20:16:45 -05004805 default:
4806 g_assert_not_reached();
4807 }
4808
4809 if (err) {
4810 error_reportf_err(err, "Operation %s on bitmap %s failed: ",
4811 op, bitmap);
4812 goto out;
4813 }
4814 g_free(act);
4815 }
4816
4817 ret = 0;
4818
4819 out:
4820 blk_unref(src);
4821 blk_unref(blk);
4822 qemu_opts_del(opts);
4823 return ret;
4824}
4825
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004826#define C_BS 01
4827#define C_COUNT 02
4828#define C_IF 04
4829#define C_OF 010
Reda Sallahif7c15532016-08-10 16:16:09 +02004830#define C_SKIP 020
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004831
4832struct DdInfo {
4833 unsigned int flags;
4834 int64_t count;
4835};
4836
4837struct DdIo {
4838 int bsz; /* Block size */
4839 char *filename;
4840 uint8_t *buf;
Reda Sallahif7c15532016-08-10 16:16:09 +02004841 int64_t offset;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004842};
4843
4844struct DdOpts {
4845 const char *name;
4846 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
4847 unsigned int flag;
4848};
4849
4850static int img_dd_bs(const char *arg,
4851 struct DdIo *in, struct DdIo *out,
4852 struct DdInfo *dd)
4853{
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004854 int64_t res;
4855
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004856 res = cvtnum_full("bs", arg, 1, INT_MAX);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004857
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004858 if (res < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004859 return 1;
4860 }
4861 in->bsz = out->bsz = res;
4862
4863 return 0;
4864}
4865
4866static int img_dd_count(const char *arg,
4867 struct DdIo *in, struct DdIo *out,
4868 struct DdInfo *dd)
4869{
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004870 dd->count = cvtnum("count", arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004871
Markus Armbruster606caa02017-02-21 21:14:04 +01004872 if (dd->count < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004873 return 1;
4874 }
4875
4876 return 0;
4877}
4878
4879static int img_dd_if(const char *arg,
4880 struct DdIo *in, struct DdIo *out,
4881 struct DdInfo *dd)
4882{
4883 in->filename = g_strdup(arg);
4884
4885 return 0;
4886}
4887
4888static int img_dd_of(const char *arg,
4889 struct DdIo *in, struct DdIo *out,
4890 struct DdInfo *dd)
4891{
4892 out->filename = g_strdup(arg);
4893
4894 return 0;
4895}
4896
Reda Sallahif7c15532016-08-10 16:16:09 +02004897static int img_dd_skip(const char *arg,
4898 struct DdIo *in, struct DdIo *out,
4899 struct DdInfo *dd)
4900{
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004901 in->offset = cvtnum("skip", arg);
Reda Sallahif7c15532016-08-10 16:16:09 +02004902
Markus Armbruster606caa02017-02-21 21:14:04 +01004903 if (in->offset < 0) {
Reda Sallahif7c15532016-08-10 16:16:09 +02004904 return 1;
4905 }
4906
4907 return 0;
4908}
4909
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004910static int img_dd(int argc, char **argv)
4911{
4912 int ret = 0;
4913 char *arg = NULL;
4914 char *tmp;
4915 BlockDriver *drv = NULL, *proto_drv = NULL;
4916 BlockBackend *blk1 = NULL, *blk2 = NULL;
4917 QemuOpts *opts = NULL;
4918 QemuOptsList *create_opts = NULL;
4919 Error *local_err = NULL;
4920 bool image_opts = false;
4921 int c, i;
4922 const char *out_fmt = "raw";
4923 const char *fmt = NULL;
4924 int64_t size = 0;
4925 int64_t block_count = 0, out_pos, in_pos;
Fam Zheng335e9932017-05-03 00:35:39 +08004926 bool force_share = false;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004927 struct DdInfo dd = {
4928 .flags = 0,
4929 .count = 0,
4930 };
4931 struct DdIo in = {
4932 .bsz = 512, /* Block size is by default 512 bytes */
4933 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004934 .buf = NULL,
4935 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004936 };
4937 struct DdIo out = {
4938 .bsz = 512,
4939 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004940 .buf = NULL,
4941 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004942 };
4943
4944 const struct DdOpts options[] = {
4945 { "bs", img_dd_bs, C_BS },
4946 { "count", img_dd_count, C_COUNT },
4947 { "if", img_dd_if, C_IF },
4948 { "of", img_dd_of, C_OF },
Reda Sallahif7c15532016-08-10 16:16:09 +02004949 { "skip", img_dd_skip, C_SKIP },
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004950 { NULL, NULL, 0 }
4951 };
4952 const struct option long_options[] = {
4953 { "help", no_argument, 0, 'h'},
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004954 { "object", required_argument, 0, OPTION_OBJECT},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004955 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08004956 { "force-share", no_argument, 0, 'U'},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004957 { 0, 0, 0, 0 }
4958 };
4959
Fam Zheng335e9932017-05-03 00:35:39 +08004960 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004961 if (c == EOF) {
4962 break;
4963 }
4964 switch (c) {
4965 case 'O':
4966 out_fmt = optarg;
4967 break;
4968 case 'f':
4969 fmt = optarg;
4970 break;
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004971 case ':':
4972 missing_argument(argv[optind - 1]);
4973 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004974 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004975 unrecognized_option(argv[optind - 1]);
4976 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004977 case 'h':
4978 help();
4979 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004980 case 'U':
4981 force_share = true;
4982 break;
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01004983 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01004984 user_creatable_process_cmdline(optarg);
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01004985 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004986 case OPTION_IMAGE_OPTS:
4987 image_opts = true;
4988 break;
4989 }
4990 }
4991
4992 for (i = optind; i < argc; i++) {
4993 int j;
4994 arg = g_strdup(argv[i]);
4995
4996 tmp = strchr(arg, '=');
4997 if (tmp == NULL) {
4998 error_report("unrecognized operand %s", arg);
4999 ret = -1;
5000 goto out;
5001 }
5002
5003 *tmp++ = '\0';
5004
5005 for (j = 0; options[j].name != NULL; j++) {
5006 if (!strcmp(arg, options[j].name)) {
5007 break;
5008 }
5009 }
5010 if (options[j].name == NULL) {
5011 error_report("unrecognized operand %s", arg);
5012 ret = -1;
5013 goto out;
5014 }
5015
5016 if (options[j].f(tmp, &in, &out, &dd) != 0) {
5017 ret = -1;
5018 goto out;
5019 }
5020 dd.flags |= options[j].flag;
5021 g_free(arg);
5022 arg = NULL;
5023 }
5024
5025 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
5026 error_report("Must specify both input and output files");
5027 ret = -1;
5028 goto out;
5029 }
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01005030
Fam Zheng335e9932017-05-03 00:35:39 +08005031 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
5032 force_share);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005033
5034 if (!blk1) {
5035 ret = -1;
5036 goto out;
5037 }
5038
5039 drv = bdrv_find_format(out_fmt);
5040 if (!drv) {
5041 error_report("Unknown file format");
5042 ret = -1;
5043 goto out;
5044 }
5045 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
5046
5047 if (!proto_drv) {
5048 error_report_err(local_err);
5049 ret = -1;
5050 goto out;
5051 }
5052 if (!drv->create_opts) {
5053 error_report("Format driver '%s' does not support image creation",
5054 drv->format_name);
5055 ret = -1;
5056 goto out;
5057 }
5058 if (!proto_drv->create_opts) {
5059 error_report("Protocol driver '%s' does not support image creation",
5060 proto_drv->format_name);
5061 ret = -1;
5062 goto out;
5063 }
5064 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5065 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
5066
5067 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5068
5069 size = blk_getlength(blk1);
5070 if (size < 0) {
5071 error_report("Failed to get size for '%s'", in.filename);
5072 ret = -1;
5073 goto out;
5074 }
5075
5076 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
5077 dd.count * in.bsz < size) {
5078 size = dd.count * in.bsz;
5079 }
5080
Reda Sallahif7c15532016-08-10 16:16:09 +02005081 /* Overflow means the specified offset is beyond input image's size */
5082 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5083 size < in.bsz * in.offset)) {
5084 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
5085 } else {
5086 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
5087 size - in.bsz * in.offset, &error_abort);
5088 }
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005089
5090 ret = bdrv_create(drv, out.filename, opts, &local_err);
5091 if (ret < 0) {
5092 error_reportf_err(local_err,
5093 "%s: error while creating output image: ",
5094 out.filename);
5095 ret = -1;
5096 goto out;
5097 }
5098
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01005099 /* TODO, we can't honour --image-opts for the target,
5100 * since it needs to be given in a format compatible
5101 * with the bdrv_create() call above which does not
5102 * support image-opts style.
5103 */
Daniel P. Berrange29cf9332017-05-15 17:47:12 +01005104 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01005105 false, false, false);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005106
5107 if (!blk2) {
5108 ret = -1;
5109 goto out;
5110 }
5111
Reda Sallahif7c15532016-08-10 16:16:09 +02005112 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5113 size < in.offset * in.bsz)) {
5114 /* We give a warning if the skip option is bigger than the input
5115 * size and create an empty output disk image (i.e. like dd(1)).
5116 */
5117 error_report("%s: cannot skip to specified offset", in.filename);
5118 in_pos = size;
5119 } else {
5120 in_pos = in.offset * in.bsz;
5121 }
5122
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005123 in.buf = g_new(uint8_t, in.bsz);
5124
Reda Sallahif7c15532016-08-10 16:16:09 +02005125 for (out_pos = 0; in_pos < size; block_count++) {
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005126 int bytes = (in_pos + in.bsz > size) ? size - in_pos : in.bsz;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005127
Alberto Fariaa9262f52022-07-05 17:15:11 +01005128 ret = blk_pread(blk1, in_pos, bytes, in.buf, 0);
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005129 if (ret < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005130 error_report("error while reading from input image file: %s",
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005131 strerror(-ret));
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005132 goto out;
5133 }
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005134 in_pos += bytes;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005135
Alberto Fariaa9262f52022-07-05 17:15:11 +01005136 ret = blk_pwrite(blk2, out_pos, bytes, in.buf, 0);
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005137 if (ret < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005138 error_report("error while writing to output image file: %s",
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005139 strerror(-ret));
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005140 goto out;
5141 }
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005142 out_pos += bytes;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005143 }
5144
5145out:
5146 g_free(arg);
5147 qemu_opts_del(opts);
5148 qemu_opts_free(create_opts);
5149 blk_unref(blk1);
5150 blk_unref(blk2);
5151 g_free(in.filename);
5152 g_free(out.filename);
5153 g_free(in.buf);
5154 g_free(out.buf);
5155
5156 if (ret) {
5157 return 1;
5158 }
5159 return 0;
5160}
5161
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005162static void dump_json_block_measure_info(BlockMeasureInfo *info)
5163{
Markus Armbrustereab3a462020-12-11 18:11:37 +01005164 GString *str;
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005165 QObject *obj;
5166 Visitor *v = qobject_output_visitor_new(&obj);
5167
5168 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
5169 visit_complete(v, &obj);
Markus Armbruster6589f452020-12-11 18:11:35 +01005170 str = qobject_to_json_pretty(obj, true);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005171 assert(str != NULL);
Markus Armbrustereab3a462020-12-11 18:11:37 +01005172 printf("%s\n", str->str);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02005173 qobject_unref(obj);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005174 visit_free(v);
Markus Armbrustereab3a462020-12-11 18:11:37 +01005175 g_string_free(str, true);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005176}
5177
5178static int img_measure(int argc, char **argv)
5179{
5180 static const struct option long_options[] = {
5181 {"help", no_argument, 0, 'h'},
5182 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
5183 {"object", required_argument, 0, OPTION_OBJECT},
5184 {"output", required_argument, 0, OPTION_OUTPUT},
5185 {"size", required_argument, 0, OPTION_SIZE},
5186 {"force-share", no_argument, 0, 'U'},
5187 {0, 0, 0, 0}
5188 };
5189 OutputFormat output_format = OFORMAT_HUMAN;
5190 BlockBackend *in_blk = NULL;
5191 BlockDriver *drv;
5192 const char *filename = NULL;
5193 const char *fmt = NULL;
5194 const char *out_fmt = "raw";
5195 char *options = NULL;
5196 char *snapshot_name = NULL;
5197 bool force_share = false;
5198 QemuOpts *opts = NULL;
5199 QemuOpts *object_opts = NULL;
5200 QemuOpts *sn_opts = NULL;
5201 QemuOptsList *create_opts = NULL;
5202 bool image_opts = false;
5203 uint64_t img_size = UINT64_MAX;
5204 BlockMeasureInfo *info = NULL;
5205 Error *local_err = NULL;
5206 int ret = 1;
5207 int c;
5208
5209 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
5210 long_options, NULL)) != -1) {
5211 switch (c) {
5212 case '?':
5213 case 'h':
5214 help();
5215 break;
5216 case 'f':
5217 fmt = optarg;
5218 break;
5219 case 'O':
5220 out_fmt = optarg;
5221 break;
5222 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02005223 if (accumulate_options(&options, optarg) < 0) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005224 goto out;
5225 }
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005226 break;
5227 case 'l':
5228 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
5229 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
5230 optarg, false);
5231 if (!sn_opts) {
5232 error_report("Failed in parsing snapshot param '%s'",
5233 optarg);
5234 goto out;
5235 }
5236 } else {
5237 snapshot_name = optarg;
5238 }
5239 break;
5240 case 'U':
5241 force_share = true;
5242 break;
5243 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01005244 user_creatable_process_cmdline(optarg);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005245 break;
5246 case OPTION_IMAGE_OPTS:
5247 image_opts = true;
5248 break;
5249 case OPTION_OUTPUT:
5250 if (!strcmp(optarg, "json")) {
5251 output_format = OFORMAT_JSON;
5252 } else if (!strcmp(optarg, "human")) {
5253 output_format = OFORMAT_HUMAN;
5254 } else {
5255 error_report("--output must be used with human or json "
5256 "as argument.");
5257 goto out;
5258 }
5259 break;
5260 case OPTION_SIZE:
5261 {
5262 int64_t sval;
5263
Eyal Moscovici43d589b2020-05-13 16:36:26 +03005264 sval = cvtnum("image size", optarg);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005265 if (sval < 0) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005266 goto out;
5267 }
5268 img_size = (uint64_t)sval;
5269 }
5270 break;
5271 }
5272 }
5273
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005274 if (argc - optind > 1) {
5275 error_report("At most one filename argument is allowed.");
5276 goto out;
5277 } else if (argc - optind == 1) {
5278 filename = argv[optind];
5279 }
5280
Stefan Hajnoczic3673dc2020-02-21 11:25:21 +00005281 if (!filename && (image_opts || fmt || snapshot_name || sn_opts)) {
5282 error_report("--image-opts, -f, and -l require a filename argument.");
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005283 goto out;
5284 }
5285 if (filename && img_size != UINT64_MAX) {
5286 error_report("--size N cannot be used together with a filename.");
5287 goto out;
5288 }
5289 if (!filename && img_size == UINT64_MAX) {
5290 error_report("Either --size N or one filename must be specified.");
5291 goto out;
5292 }
5293
5294 if (filename) {
5295 in_blk = img_open(image_opts, filename, fmt, 0,
5296 false, false, force_share);
5297 if (!in_blk) {
5298 goto out;
5299 }
5300
5301 if (sn_opts) {
5302 bdrv_snapshot_load_tmp(blk_bs(in_blk),
5303 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
5304 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
5305 &local_err);
5306 } else if (snapshot_name != NULL) {
5307 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
5308 snapshot_name, &local_err);
5309 }
5310 if (local_err) {
5311 error_reportf_err(local_err, "Failed to load snapshot: ");
5312 goto out;
5313 }
5314 }
5315
5316 drv = bdrv_find_format(out_fmt);
5317 if (!drv) {
5318 error_report("Unknown file format '%s'", out_fmt);
5319 goto out;
5320 }
5321 if (!drv->create_opts) {
5322 error_report("Format driver '%s' does not support image creation",
5323 drv->format_name);
5324 goto out;
5325 }
5326
5327 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5328 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
5329 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5330 if (options) {
Markus Armbruster235e59c2020-07-07 18:05:42 +02005331 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005332 error_report_err(local_err);
5333 error_report("Invalid options for file format '%s'", out_fmt);
5334 goto out;
5335 }
5336 }
5337 if (img_size != UINT64_MAX) {
5338 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
5339 }
5340
5341 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
5342 if (local_err) {
5343 error_report_err(local_err);
5344 goto out;
5345 }
5346
5347 if (output_format == OFORMAT_HUMAN) {
5348 printf("required size: %" PRIu64 "\n", info->required);
5349 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
Eric Blake5d72c682020-05-21 14:21:34 -05005350 if (info->has_bitmaps) {
5351 printf("bitmaps size: %" PRIu64 "\n", info->bitmaps);
5352 }
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005353 } else {
5354 dump_json_block_measure_info(info);
5355 }
5356
5357 ret = 0;
5358
5359out:
5360 qapi_free_BlockMeasureInfo(info);
5361 qemu_opts_del(object_opts);
5362 qemu_opts_del(opts);
5363 qemu_opts_del(sn_opts);
5364 qemu_opts_free(create_opts);
5365 g_free(options);
5366 blk_unref(in_blk);
5367 return ret;
5368}
Kevin Wolfb6133b82014-08-05 14:17:13 +02005369
Anthony Liguoric227f092009-10-01 16:12:16 -05005370static const img_cmd_t img_cmds[] = {
Stuart Brady153859b2009-06-07 00:42:17 +01005371#define DEF(option, callback, arg_string) \
5372 { option, callback },
5373#include "qemu-img-cmds.h"
5374#undef DEF
Stuart Brady153859b2009-06-07 00:42:17 +01005375 { NULL, NULL, },
5376};
5377
bellardea2384d2004-08-01 21:59:26 +00005378int main(int argc, char **argv)
5379{
Anthony Liguoric227f092009-10-01 16:12:16 -05005380 const img_cmd_t *cmd;
Stuart Brady153859b2009-06-07 00:42:17 +01005381 const char *cmdname;
Jeff Cody7db16892014-04-25 17:02:32 -04005382 int c;
Jeff Cody7db16892014-04-25 17:02:32 -04005383 static const struct option long_options[] = {
5384 {"help", no_argument, 0, 'h'},
Denis V. Lunev10985132016-06-17 17:44:13 +03005385 {"version", no_argument, 0, 'V'},
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005386 {"trace", required_argument, NULL, 'T'},
Jeff Cody7db16892014-04-25 17:02:32 -04005387 {0, 0, 0, 0}
5388 };
bellardea2384d2004-08-01 21:59:26 +00005389
MORITA Kazutaka526eda12013-07-23 17:30:11 +09005390#ifdef CONFIG_POSIX
5391 signal(SIGPIPE, SIG_IGN);
5392#endif
5393
Daniel P. Berrangé98c5d2e2020-08-25 11:38:48 +01005394 socket_init();
Christophe Fergeauf5852ef2019-01-31 17:46:14 +01005395 error_init(argv[0]);
Daniel P. Berrangefe4db842016-10-04 14:35:52 +01005396 module_call_init(MODULE_INIT_TRACE);
Fam Zheng10f5bff2014-02-10 14:48:51 +08005397 qemu_init_exec_dir(argv[0]);
Kevin Wolf53f76e52010-12-16 15:10:32 +01005398
Markus Armbrusterf9734d52021-07-20 14:53:53 +02005399 qemu_init_main_loop(&error_fatal);
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005400
Eduardo Habkoste8f2d272016-05-12 11:10:04 -03005401 qcrypto_init(&error_fatal);
Daniel P. Berrangec2297082016-04-06 12:12:06 +01005402
Daniel P. Berrange064097d2016-02-10 18:41:01 +00005403 module_call_init(MODULE_INIT_QOM);
bellardea2384d2004-08-01 21:59:26 +00005404 bdrv_init();
Fam Zhengac1307a2014-04-22 13:36:11 +08005405 if (argc < 2) {
5406 error_exit("Not enough arguments");
5407 }
Stuart Brady153859b2009-06-07 00:42:17 +01005408
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00005409 qemu_add_opts(&qemu_source_opts);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005410 qemu_add_opts(&qemu_trace_opts);
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00005411
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005412 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
Denis V. Lunev10985132016-06-17 17:44:13 +03005413 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005414 case ':':
5415 missing_argument(argv[optind - 1]);
5416 return 0;
Stefan Hajnoczi4581c162017-03-17 18:45:39 +08005417 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005418 unrecognized_option(argv[optind - 1]);
5419 return 0;
5420 case 'h':
Denis V. Lunev10985132016-06-17 17:44:13 +03005421 help();
5422 return 0;
5423 case 'V':
5424 printf(QEMU_IMG_VERSION);
5425 return 0;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005426 case 'T':
Paolo Bonzini92eecff2020-11-02 06:58:41 -05005427 trace_opt_parse(optarg);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005428 break;
Stuart Brady153859b2009-06-07 00:42:17 +01005429 }
bellardea2384d2004-08-01 21:59:26 +00005430 }
Stuart Brady153859b2009-06-07 00:42:17 +01005431
Denis V. Lunev10985132016-06-17 17:44:13 +03005432 cmdname = argv[optind];
Jeff Cody7db16892014-04-25 17:02:32 -04005433
Denis V. Lunev10985132016-06-17 17:44:13 +03005434 /* reset getopt_long scanning */
5435 argc -= optind;
5436 if (argc < 1) {
Jeff Cody5f6979c2014-04-28 14:37:18 -04005437 return 0;
5438 }
Denis V. Lunev10985132016-06-17 17:44:13 +03005439 argv += optind;
Richard W.M. Jonesd339d762019-01-18 10:11:14 +00005440 qemu_reset_optind();
Denis V. Lunev10985132016-06-17 17:44:13 +03005441
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005442 if (!trace_init_backends()) {
5443 exit(1);
5444 }
Paolo Bonzini92eecff2020-11-02 06:58:41 -05005445 trace_init_file();
Richard Hendersonc5955f42022-04-17 11:29:44 -07005446 qemu_set_log(LOG_TRACE, &error_fatal);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005447
Denis V. Lunev10985132016-06-17 17:44:13 +03005448 /* find the command */
5449 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
5450 if (!strcmp(cmdname, cmd->name)) {
5451 return cmd->handler(argc, argv);
5452 }
5453 }
Jeff Cody7db16892014-04-25 17:02:32 -04005454
Stuart Brady153859b2009-06-07 00:42:17 +01005455 /* not found */
Fam Zhengac1307a2014-04-22 13:36:11 +08005456 error_exit("Command not found: %s", cmdname);
bellardea2384d2004-08-01 21:59:26 +00005457}