blob: 5bb63c5e0cc8d7442bfbb7a32c942fe7ab6470d4 [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"
Markus Armbrustere2c1c342022-12-21 14:35:49 +010051#include "block/dirty-bitmap.h"
Wenchao Xiaf364ec62013-05-25 11:09:44 +080052#include "block/qapi.h"
Daniel P. Berrangec2297082016-04-06 12:12:06 +010053#include "crypto/init.h"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +030054#include "trace/control.h"
Zhengui0c8c4892020-10-20 14:47:44 +000055#include "qemu/throttle.h"
56#include "block/throttle-groups.h"
bellarde8445332006-06-14 15:32:10 +000057
Thomas Huth7e563bf2018-02-15 12:06:47 +010058#define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
Thomas Huth0781dd62016-10-05 11:54:44 +020059 "\n" QEMU_COPYRIGHT "\n"
Jeff Cody5f6979c2014-04-28 14:37:18 -040060
Anthony Liguoric227f092009-10-01 16:12:16 -050061typedef struct img_cmd_t {
Stuart Brady153859b2009-06-07 00:42:17 +010062 const char *name;
63 int (*handler)(int argc, char **argv);
Anthony Liguoric227f092009-10-01 16:12:16 -050064} img_cmd_t;
Stuart Brady153859b2009-06-07 00:42:17 +010065
Federico Simoncelli8599ea42013-01-28 06:59:47 -050066enum {
67 OPTION_OUTPUT = 256,
68 OPTION_BACKING_CHAIN = 257,
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000069 OPTION_OBJECT = 258,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000070 OPTION_IMAGE_OPTS = 259,
Kevin Wolfb6495fa2015-07-10 18:09:18 +020071 OPTION_PATTERN = 260,
Kevin Wolf55d539c2016-06-03 13:59:41 +020072 OPTION_FLUSH_INTERVAL = 261,
73 OPTION_NO_DRAIN = 262,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +010074 OPTION_TARGET_IMAGE_OPTS = 263,
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +010075 OPTION_SIZE = 264,
Max Reitzdc5f6902017-06-13 22:20:55 +020076 OPTION_PREALLOCATION = 265,
Pavel Butsykin4ffca892017-09-18 15:42:27 +030077 OPTION_SHRINK = 266,
Max Reitz8eaac022019-05-07 22:35:03 +020078 OPTION_SALVAGE = 267,
David Edmondson168468f2020-02-05 11:02:48 +000079 OPTION_TARGET_IS_ZERO = 268,
Eric Blake3b51ab42020-05-12 20:16:45 -050080 OPTION_ADD = 269,
81 OPTION_REMOVE = 270,
82 OPTION_CLEAR = 271,
83 OPTION_ENABLE = 272,
84 OPTION_DISABLE = 273,
85 OPTION_MERGE = 274,
Eric Blake15e39ad2020-05-21 14:21:36 -050086 OPTION_BITMAPS = 275,
Maxim Levitskya3579bf2020-06-25 14:55:38 +020087 OPTION_FORCE = 276,
Eric Blake955171e2021-07-21 10:53:48 -050088 OPTION_SKIP_BROKEN = 277,
Federico Simoncelli8599ea42013-01-28 06:59:47 -050089};
90
91typedef enum OutputFormat {
92 OFORMAT_JSON,
93 OFORMAT_HUMAN,
94} OutputFormat;
95
Kevin Wolfe6996142016-03-15 13:03:11 +010096/* Default to cache=writeback as data integrity is not important for qemu-img */
Federico Simoncelli661a0f72011-06-20 12:48:19 -040097#define BDRV_DEFAULT_CACHE "writeback"
aurel32137519c2008-11-30 19:12:49 +000098
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +010099static void format_print(void *opaque, const char *name)
bellardea2384d2004-08-01 21:59:26 +0000100{
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +0100101 printf(" %s", name);
bellardea2384d2004-08-01 21:59:26 +0000102}
103
Marc-André Lureau89057702022-04-20 17:26:02 +0400104static G_NORETURN G_GNUC_PRINTF(1, 2)
105void error_exit(const char *fmt, ...)
Fam Zhengac1307a2014-04-22 13:36:11 +0800106{
107 va_list ap;
108
Fam Zhengac1307a2014-04-22 13:36:11 +0800109 va_start(ap, fmt);
Markus Armbrustere9e1d922019-04-17 21:06:27 +0200110 error_vreport(fmt, ap);
Fam Zhengac1307a2014-04-22 13:36:11 +0800111 va_end(ap);
112
Markus Armbrustere9e1d922019-04-17 21:06:27 +0200113 error_printf("Try 'qemu-img --help' for more information\n");
Fam Zhengac1307a2014-04-22 13:36:11 +0800114 exit(EXIT_FAILURE);
115}
116
Marc-André Lureau89057702022-04-20 17:26:02 +0400117static G_NORETURN
118void missing_argument(const char *option)
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800119{
120 error_exit("missing argument for option '%s'", option);
121}
122
Marc-André Lureau89057702022-04-20 17:26:02 +0400123static G_NORETURN
124void unrecognized_option(const char *option)
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800125{
126 error_exit("unrecognized option '%s'", option);
127}
128
Eric Blake0562adf2020-05-12 20:16:41 -0500129/* Please keep in synch with docs/tools/qemu-img.rst */
Marc-André Lureau89057702022-04-20 17:26:02 +0400130static G_NORETURN
131void help(void)
bellardea2384d2004-08-01 21:59:26 +0000132{
Paolo Bonzinie00291c2010-02-04 16:49:56 +0100133 const char *help_msg =
Jeff Cody5f6979c2014-04-28 14:37:18 -0400134 QEMU_IMG_VERSION
Denis V. Lunev10985132016-06-17 17:44:13 +0300135 "usage: qemu-img [standard options] command [command options]\n"
malc3f020d72010-02-08 12:04:56 +0300136 "QEMU disk image utility\n"
137 "\n"
Denis V. Lunev10985132016-06-17 17:44:13 +0300138 " '-h', '--help' display this help and exit\n"
139 " '-V', '--version' output version information and exit\n"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +0300140 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
141 " specify tracing options\n"
Denis V. Lunev10985132016-06-17 17:44:13 +0300142 "\n"
malc3f020d72010-02-08 12:04:56 +0300143 "Command syntax:\n"
Stuart Brady153859b2009-06-07 00:42:17 +0100144#define DEF(option, callback, arg_string) \
145 " " arg_string "\n"
146#include "qemu-img-cmds.h"
147#undef DEF
malc3f020d72010-02-08 12:04:56 +0300148 "\n"
149 "Command parameters:\n"
150 " 'filename' is a disk image filename\n"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000151 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
152 " manual page for a description of the object properties. The most common\n"
153 " object type is a 'secret', which is used to supply passwords and/or\n"
154 " encryption keys.\n"
malc3f020d72010-02-08 12:04:56 +0300155 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400156 " 'cache' is the cache mode used to write the output disk image, the valid\n"
Liu Yuan80ccf932012-04-20 17:10:56 +0800157 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
158 " 'directsync' and 'unsafe' (default for convert)\n"
Stefan Hajnoczibb87fdf2014-09-02 11:01:02 +0100159 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
160 " options are the same as for the 'cache' option\n"
malc3f020d72010-02-08 12:04:56 +0300161 " 'size' is the disk image size in bytes. Optional suffixes\n"
Kevin Wolf5e009842013-06-05 14:19:27 +0200162 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
163 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
164 " supported. 'b' is ignored.\n"
malc3f020d72010-02-08 12:04:56 +0300165 " 'output_filename' is the destination disk image filename\n"
166 " 'output_fmt' is the destination format\n"
167 " 'options' is a comma separated list of format specific options in a\n"
Markus Armbruster7f118b42022-09-08 15:08:42 +0200168 " name=value format. Use -o help for an overview of the options supported by\n"
169 " the used format\n"
Wenchao Xiaef806542013-12-04 17:10:57 +0800170 " 'snapshot_param' is param used for internal snapshot, format\n"
171 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
172 " '[ID_OR_NAME]'\n"
malc3f020d72010-02-08 12:04:56 +0300173 " '-c' indicates that target image must be compressed (qcow format only)\n"
John Snow6e6e55f2017-07-17 20:34:22 -0400174 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
175 " new backing file match exactly. The image doesn't need a working\n"
176 " backing file before rebasing in this case (useful for renaming the\n"
177 " backing file). For image creation, allow creating without attempting\n"
178 " to open the backing file.\n"
malc3f020d72010-02-08 12:04:56 +0300179 " '-h' with or without a command shows this help and lists the supported formats\n"
Jes Sorensen6b837bc2011-03-30 14:16:25 +0200180 " '-p' show progress of command (only certain commands)\n"
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100181 " '-q' use Quiet mode - do not print any output (except errors)\n"
Peter Lieven11b66992013-10-24 12:07:05 +0200182 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
183 " contain only zeros for qemu-img to create a sparse image during\n"
184 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
185 " unallocated or zero sectors, and the destination image will always be\n"
186 " fully allocated\n"
Benoît Canetc054b3f2012-09-05 13:09:02 +0200187 " '--output' takes the format in which the output must be done (human or json)\n"
Alexandre Derumierb2e10492013-09-02 19:07:24 +0100188 " '-n' skips the target volume creation (useful if the volume is created\n"
189 " prior to running qemu-img)\n"
malc3f020d72010-02-08 12:04:56 +0300190 "\n"
Eric Blake3b51ab42020-05-12 20:16:45 -0500191 "Parameters to bitmap subcommand:\n"
192 " 'bitmap' is the name of the bitmap to manipulate, through one or more\n"
193 " actions from '--add', '--remove', '--clear', '--enable', '--disable',\n"
194 " or '--merge source'\n"
195 " '-g granularity' sets the granularity for '--add' actions\n"
196 " '-b source' and '-F src_fmt' tell '--merge' actions to find the source\n"
197 " bitmaps from an alternative file\n"
198 "\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200199 "Parameters to check subcommand:\n"
200 " '-r' tries to repair any inconsistencies that are found during the check.\n"
201 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
202 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
Stefan Weil0546b8c2012-08-10 22:03:25 +0200203 " hiding corruption that has already occurred.\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200204 "\n"
Peter Lieven2d9187b2017-02-28 13:40:07 +0100205 "Parameters to convert subcommand:\n"
Eric Blake15e39ad2020-05-21 14:21:36 -0500206 " '--bitmaps' copies all top-level persistent bitmaps to destination\n"
Peter Lieven2d9187b2017-02-28 13:40:07 +0100207 " '-m' specifies how many coroutines work in parallel during the convert\n"
208 " process (defaults to 8)\n"
209 " '-W' allow to write to the target out of order rather than sequential\n"
210 "\n"
malc3f020d72010-02-08 12:04:56 +0300211 "Parameters to snapshot subcommand:\n"
212 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
213 " '-a' applies a snapshot (revert disk to saved state)\n"
214 " '-c' creates a snapshot\n"
215 " '-d' deletes a snapshot\n"
Miroslav Rezaninad14ed182013-02-13 09:09:41 +0100216 " '-l' lists all snapshots in the given image\n"
217 "\n"
218 "Parameters to compare subcommand:\n"
219 " '-f' first image format\n"
220 " '-F' second image format\n"
Reda Sallahi86ce1f62016-08-10 04:43:12 +0200221 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
222 "\n"
223 "Parameters to dd subcommand:\n"
224 " 'bs=BYTES' read and write up to BYTES bytes at a time "
225 "(default: 512)\n"
226 " 'count=N' copy only N input blocks\n"
227 " 'if=FILE' read from FILE\n"
Reda Sallahif7c15532016-08-10 16:16:09 +0200228 " 'of=FILE' write to FILE\n"
229 " 'skip=N' skip N bs-sized blocks at the start of input\n";
Paolo Bonzinie00291c2010-02-04 16:49:56 +0100230
231 printf("%s\nSupported formats:", help_msg);
Andrey Shinkevich9ac404c2019-03-07 16:33:58 +0300232 bdrv_iterate_format(format_print, NULL, false);
Eric Blakef5048cb2017-08-03 11:33:53 -0500233 printf("\n\n" QEMU_HELP_BOTTOM "\n");
Fam Zhengac1307a2014-04-22 13:36:11 +0800234 exit(EXIT_SUCCESS);
bellardea2384d2004-08-01 21:59:26 +0000235}
236
Markus Armbruster80c710c2020-04-15 09:49:26 +0200237/*
238 * Is @optarg safe for accumulate_options()?
239 * It is when multiple of them can be joined together separated by ','.
240 * To make that work, @optarg must not start with ',' (or else a
241 * separating ',' preceding it gets escaped), and it must not end with
242 * an odd number of ',' (or else a separating ',' following it gets
Markus Armbrusterf62514b2020-04-15 09:49:27 +0200243 * escaped), or be empty (or else a separating ',' preceding it can
244 * escape a separating ',' following it).
245 *
Markus Armbruster80c710c2020-04-15 09:49:26 +0200246 */
247static bool is_valid_option_list(const char *optarg)
248{
249 size_t len = strlen(optarg);
250 size_t i;
251
Markus Armbrusterf62514b2020-04-15 09:49:27 +0200252 if (!optarg[0] || optarg[0] == ',') {
Markus Armbruster80c710c2020-04-15 09:49:26 +0200253 return false;
254 }
255
256 for (i = len; i > 0 && optarg[i - 1] == ','; i--) {
257 }
258 if ((len - i) % 2) {
259 return false;
260 }
261
262 return true;
263}
264
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +0200265static int accumulate_options(char **options, char *optarg)
266{
267 char *new_options;
268
269 if (!is_valid_option_list(optarg)) {
270 error_report("Invalid option list: %s", optarg);
271 return -1;
272 }
273
274 if (!*options) {
275 *options = g_strdup(optarg);
276 } else {
277 new_options = g_strdup_printf("%s,%s", *options, optarg);
278 g_free(*options);
279 *options = new_options;
280 }
281 return 0;
282}
283
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000284static QemuOptsList qemu_source_opts = {
285 .name = "source",
286 .implied_opt_name = "file",
287 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
288 .desc = {
289 { }
290 },
291};
292
Marc-André Lureau9edc6312022-02-20 20:39:25 +0400293static int G_GNUC_PRINTF(2, 3) qprintf(bool quiet, const char *fmt, ...)
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100294{
295 int ret = 0;
296 if (!quiet) {
297 va_list args;
298 va_start(args, fmt);
299 ret = vprintf(fmt, args);
300 va_end(args);
301 }
302 return ret;
303}
304
bellardea2384d2004-08-01 21:59:26 +0000305
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100306static int print_block_option_help(const char *filename, const char *fmt)
307{
308 BlockDriver *drv, *proto_drv;
Chunyan Liu83d05212014-06-05 17:20:51 +0800309 QemuOptsList *create_opts = NULL;
Max Reitzb65a5e12015-02-05 13:58:12 -0500310 Error *local_err = NULL;
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100311
312 /* Find driver and parse its options */
313 drv = bdrv_find_format(fmt);
314 if (!drv) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100315 error_report("Unknown file format '%s'", fmt);
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100316 return 1;
317 }
318
Max Reitzd402b6a2018-05-09 23:00:21 +0200319 if (!drv->create_opts) {
320 error_report("Format driver '%s' does not support image creation", fmt);
321 return 1;
322 }
323
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800324 create_opts = qemu_opts_append(create_opts, drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100325 if (filename) {
Max Reitzb65a5e12015-02-05 13:58:12 -0500326 proto_drv = bdrv_find_protocol(filename, true, &local_err);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100327 if (!proto_drv) {
Markus Armbruster2867ce42015-03-12 16:08:02 +0100328 error_report_err(local_err);
Chunyan Liu83d05212014-06-05 17:20:51 +0800329 qemu_opts_free(create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100330 return 1;
331 }
Max Reitzd402b6a2018-05-09 23:00:21 +0200332 if (!proto_drv->create_opts) {
Max Reitzf0998872018-11-19 11:19:20 +0100333 error_report("Protocol driver '%s' does not support image creation",
Max Reitzd402b6a2018-05-09 23:00:21 +0200334 proto_drv->format_name);
Max Reitz3ecd5a42018-11-19 11:19:21 +0100335 qemu_opts_free(create_opts);
Max Reitzd402b6a2018-05-09 23:00:21 +0200336 return 1;
337 }
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800338 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100339 }
340
Max Reitzf4619af2019-04-13 17:20:37 +0200341 if (filename) {
342 printf("Supported options:\n");
343 } else {
344 printf("Supported %s options:\n", fmt);
345 }
Max Reitz63898712018-10-19 18:49:25 +0200346 qemu_opts_print_help(create_opts, false);
Chunyan Liu83d05212014-06-05 17:20:51 +0800347 qemu_opts_free(create_opts);
Max Reitzf4619af2019-04-13 17:20:37 +0200348
349 if (!filename) {
350 printf("\n"
351 "The protocol level may support further options.\n"
352 "Specify the target filename to include those options.\n");
353 }
354
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100355 return 0;
356}
357
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000358
Max Reitzefaa7c42016-03-16 19:54:38 +0100359static BlockBackend *img_open_opts(const char *optstr,
Kevin Wolfce099542016-03-15 13:01:04 +0100360 QemuOpts *opts, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800361 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000362{
363 QDict *options;
364 Error *local_err = NULL;
365 BlockBackend *blk;
366 options = qemu_opts_to_qdict(opts, NULL);
Fam Zheng335e9932017-05-03 00:35:39 +0800367 if (force_share) {
368 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
Max Reitz4615f872018-05-02 22:20:50 +0200369 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
Fam Zheng335e9932017-05-03 00:35:39 +0800370 error_report("--force-share/-U conflicts with image options");
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200371 qobject_unref(options);
Fam Zheng335e9932017-05-03 00:35:39 +0800372 return NULL;
373 }
Max Reitz4615f872018-05-02 22:20:50 +0200374 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
Fam Zheng335e9932017-05-03 00:35:39 +0800375 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100376 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000377 if (!blk) {
Daniel P. Berrange143605a2016-04-06 10:16:18 +0100378 error_reportf_err(local_err, "Could not open '%s': ", optstr);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000379 return NULL;
380 }
Kevin Wolfce099542016-03-15 13:01:04 +0100381 blk_set_enable_write_cache(blk, !writethrough);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000382
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000383 return blk;
384}
385
Max Reitzefaa7c42016-03-16 19:54:38 +0100386static BlockBackend *img_open_file(const char *filename,
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100387 QDict *options,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000388 const char *fmt, int flags,
Fam Zheng335e9932017-05-03 00:35:39 +0800389 bool writethrough, bool quiet,
390 bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000391{
392 BlockBackend *blk;
Max Reitz34b5d2c2013-09-05 14:45:29 +0200393 Error *local_err = NULL;
Kevin Wolfad717132010-12-16 15:37:41 +0100394
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100395 if (!options) {
396 options = qdict_new();
397 }
bellard75c23802004-08-27 21:28:58 +0000398 if (fmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -0500399 qdict_put_str(options, "driver", fmt);
bellard75c23802004-08-27 21:28:58 +0000400 }
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100401
Fam Zheng335e9932017-05-03 00:35:39 +0800402 if (force_share) {
Eric Blake579cf1d2017-05-15 14:54:39 -0500403 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Fam Zheng335e9932017-05-03 00:35:39 +0800404 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100405 blk = blk_new_open(filename, NULL, options, flags, &local_err);
Max Reitz5bd31322015-02-05 13:58:16 -0500406 if (!blk) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100407 error_reportf_err(local_err, "Could not open '%s': ", filename);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000408 return NULL;
bellard75c23802004-08-27 21:28:58 +0000409 }
Kevin Wolfce099542016-03-15 13:01:04 +0100410 blk_set_enable_write_cache(blk, !writethrough);
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100411
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200412 return blk;
bellard75c23802004-08-27 21:28:58 +0000413}
414
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000415
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100416static int img_add_key_secrets(void *opaque,
417 const char *name, const char *value,
418 Error **errp)
419{
420 QDict *options = opaque;
421
422 if (g_str_has_suffix(name, "key-secret")) {
Eric Blake187f47e2017-06-24 12:10:07 -0600423 qdict_put_str(options, name, value);
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100424 }
425
426 return 0;
427}
428
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100429
Max Reitzefaa7c42016-03-16 19:54:38 +0100430static BlockBackend *img_open(bool image_opts,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000431 const char *filename,
Kevin Wolfce099542016-03-15 13:01:04 +0100432 const char *fmt, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800433 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000434{
435 BlockBackend *blk;
436 if (image_opts) {
437 QemuOpts *opts;
438 if (fmt) {
439 error_report("--image-opts and --format are mutually exclusive");
440 return NULL;
441 }
442 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
443 filename, true);
444 if (!opts) {
445 return NULL;
446 }
Fam Zheng335e9932017-05-03 00:35:39 +0800447 blk = img_open_opts(filename, opts, flags, writethrough, quiet,
448 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000449 } else {
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100450 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
Fam Zheng335e9932017-05-03 00:35:39 +0800451 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000452 }
Kevin Wolf44efba22023-01-12 20:14:52 +0100453
454 if (blk) {
455 blk_set_force_allow_inactivate(blk);
456 }
457
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000458 return blk;
459}
460
461
Chunyan Liu83d05212014-06-05 17:20:51 +0800462static int add_old_style_options(const char *fmt, QemuOpts *opts,
Jes Sorenseneec77d92010-12-07 17:44:34 +0100463 const char *base_filename,
464 const char *base_fmt)
Kevin Wolfefa84d42009-05-18 16:42:12 +0200465{
Kevin Wolfefa84d42009-05-18 16:42:12 +0200466 if (base_filename) {
Markus Armbruster235e59c2020-07-07 18:05:42 +0200467 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename,
Markus Armbruster9e194e02020-07-07 18:06:11 +0200468 NULL)) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100469 error_report("Backing file not supported for file format '%s'",
470 fmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900471 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200472 }
473 }
474 if (base_fmt) {
Markus Armbruster9e194e02020-07-07 18:06:11 +0200475 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, NULL)) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100476 error_report("Backing file format not supported for file "
477 "format '%s'", fmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900478 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200479 }
480 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900481 return 0;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200482}
483
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300484static int64_t cvtnum_full(const char *name, const char *value, int64_t min,
485 int64_t max)
Markus Armbruster606caa02017-02-21 21:14:04 +0100486{
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100487 int err;
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300488 uint64_t res;
Markus Armbruster606caa02017-02-21 21:14:04 +0100489
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300490 err = qemu_strtosz(value, NULL, &res);
491 if (err < 0 && err != -ERANGE) {
492 error_report("Invalid %s specified. You may use "
493 "k, M, G, T, P or E suffixes for", name);
494 error_report("kilobytes, megabytes, gigabytes, terabytes, "
495 "petabytes and exabytes.");
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100496 return err;
497 }
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300498 if (err == -ERANGE || res > max || res < min) {
499 error_report("Invalid %s specified. Must be between %" PRId64
500 " and %" PRId64 ".", name, min, max);
Markus Armbrusterf46bfdb2017-02-21 21:14:07 +0100501 return -ERANGE;
502 }
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300503 return res;
504}
505
506static int64_t cvtnum(const char *name, const char *value)
507{
508 return cvtnum_full(name, value, 0, INT64_MAX);
Markus Armbruster606caa02017-02-21 21:14:04 +0100509}
510
bellardea2384d2004-08-01 21:59:26 +0000511static int img_create(int argc, char **argv)
512{
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200513 int c;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100514 uint64_t img_size = -1;
bellardea2384d2004-08-01 21:59:26 +0000515 const char *fmt = "raw";
aliguori9230eaf2009-03-28 17:55:19 +0000516 const char *base_fmt = NULL;
bellardea2384d2004-08-01 21:59:26 +0000517 const char *filename;
518 const char *base_filename = NULL;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200519 char *options = NULL;
Luiz Capitulino9b375252012-11-30 10:52:05 -0200520 Error *local_err = NULL;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100521 bool quiet = false;
John Snow6e6e55f2017-07-17 20:34:22 -0400522 int flags = 0;
ths3b46e622007-09-17 08:09:54 +0000523
bellardea2384d2004-08-01 21:59:26 +0000524 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000525 static const struct option long_options[] = {
526 {"help", no_argument, 0, 'h'},
527 {"object", required_argument, 0, OPTION_OBJECT},
528 {0, 0, 0, 0}
529 };
John Snow6e6e55f2017-07-17 20:34:22 -0400530 c = getopt_long(argc, argv, ":F:b:f:ho:qu",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000531 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100532 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000533 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100534 }
bellardea2384d2004-08-01 21:59:26 +0000535 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800536 case ':':
537 missing_argument(argv[optind - 1]);
538 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100539 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800540 unrecognized_option(argv[optind - 1]);
541 break;
bellardea2384d2004-08-01 21:59:26 +0000542 case 'h':
543 help();
544 break;
aliguori9230eaf2009-03-28 17:55:19 +0000545 case 'F':
546 base_fmt = optarg;
547 break;
bellardea2384d2004-08-01 21:59:26 +0000548 case 'b':
549 base_filename = optarg;
550 break;
551 case 'f':
552 fmt = optarg;
553 break;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200554 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +0200555 if (accumulate_options(&options, optarg) < 0) {
Kevin Wolf77386bf2014-02-21 16:24:04 +0100556 goto fail;
557 }
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200558 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100559 case 'q':
560 quiet = true;
561 break;
John Snow6e6e55f2017-07-17 20:34:22 -0400562 case 'u':
563 flags |= BDRV_O_NO_BACKING;
564 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +0100565 case OPTION_OBJECT:
566 user_creatable_process_cmdline(optarg);
567 break;
bellardea2384d2004-08-01 21:59:26 +0000568 }
569 }
aliguori9230eaf2009-03-28 17:55:19 +0000570
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900571 /* Get the filename */
Kevin Wolfa283cb62014-02-21 16:24:07 +0100572 filename = (optind < argc) ? argv[optind] : NULL;
573 if (options && has_help_option(options)) {
574 g_free(options);
575 return print_block_option_help(filename, fmt);
576 }
577
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100578 if (optind >= argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800579 error_exit("Expecting image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100580 }
Kevin Wolfa283cb62014-02-21 16:24:07 +0100581 optind++;
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900582
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100583 /* Get image size, if specified */
584 if (optind < argc) {
Jes Sorensen70b4f4b2011-01-05 11:41:02 +0100585 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +0100586
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300587 sval = cvtnum("image size", argv[optind++]);
Markus Armbruster606caa02017-02-21 21:14:04 +0100588 if (sval < 0) {
Kevin Wolf77386bf2014-02-21 16:24:04 +0100589 goto fail;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100590 }
591 img_size = (uint64_t)sval;
592 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200593 if (optind != argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800594 error_exit("Unexpected argument: %s", argv[optind]);
Kevin Wolffc11eb22013-08-05 10:53:04 +0200595 }
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100596
Luiz Capitulino9b375252012-11-30 10:52:05 -0200597 bdrv_img_create(filename, fmt, base_filename, base_fmt,
John Snow6e6e55f2017-07-17 20:34:22 -0400598 options, img_size, flags, quiet, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100599 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100600 error_reportf_err(local_err, "%s: ", filename);
Kevin Wolf77386bf2014-02-21 16:24:04 +0100601 goto fail;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900602 }
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200603
Kevin Wolf77386bf2014-02-21 16:24:04 +0100604 g_free(options);
bellardea2384d2004-08-01 21:59:26 +0000605 return 0;
Kevin Wolf77386bf2014-02-21 16:24:04 +0100606
607fail:
608 g_free(options);
609 return 1;
bellardea2384d2004-08-01 21:59:26 +0000610}
611
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100612static void dump_json_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500613{
Markus Armbrustereab3a462020-12-11 18:11:37 +0100614 GString *str;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500615 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +0100616 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600617
618 visit_type_ImageCheck(v, NULL, &check, &error_abort);
619 visit_complete(v, &obj);
Markus Armbruster6589f452020-12-11 18:11:35 +0100620 str = qobject_to_json_pretty(obj, true);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500621 assert(str != NULL);
Markus Armbrustereab3a462020-12-11 18:11:37 +0100622 qprintf(quiet, "%s\n", str->str);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200623 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600624 visit_free(v);
Markus Armbrustereab3a462020-12-11 18:11:37 +0100625 g_string_free(str, true);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500626}
627
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100628static void dump_human_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500629{
630 if (!(check->corruptions || check->leaks || check->check_errors)) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100631 qprintf(quiet, "No errors were found on the image.\n");
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500632 } else {
633 if (check->corruptions) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100634 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
635 "Data may be corrupted, or further writes to the image "
636 "may corrupt it.\n",
637 check->corruptions);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500638 }
639
640 if (check->leaks) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100641 qprintf(quiet,
642 "\n%" PRId64 " leaked clusters were found on the image.\n"
643 "This means waste of disk space, but no harm to data.\n",
644 check->leaks);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500645 }
646
647 if (check->check_errors) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100648 qprintf(quiet,
649 "\n%" PRId64
650 " internal errors have occurred during the check.\n",
651 check->check_errors);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500652 }
653 }
654
655 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100656 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
657 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
658 check->allocated_clusters, check->total_clusters,
659 check->allocated_clusters * 100.0 / check->total_clusters,
660 check->fragmented_clusters * 100.0 / check->allocated_clusters,
661 check->compressed_clusters * 100.0 /
662 check->allocated_clusters);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500663 }
664
665 if (check->image_end_offset) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100666 qprintf(quiet,
667 "Image end offset: %" PRId64 "\n", check->image_end_offset);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500668 }
669}
670
671static int collect_image_check(BlockDriverState *bs,
672 ImageCheck *check,
673 const char *filename,
674 const char *fmt,
675 int fix)
676{
677 int ret;
678 BdrvCheckResult result;
679
680 ret = bdrv_check(bs, &result, fix);
681 if (ret < 0) {
682 return ret;
683 }
684
685 check->filename = g_strdup(filename);
686 check->format = g_strdup(bdrv_get_format_name(bs));
687 check->check_errors = result.check_errors;
688 check->corruptions = result.corruptions;
689 check->has_corruptions = result.corruptions != 0;
690 check->leaks = result.leaks;
691 check->has_leaks = result.leaks != 0;
692 check->corruptions_fixed = result.corruptions_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100693 check->has_corruptions_fixed = result.corruptions_fixed != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500694 check->leaks_fixed = result.leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100695 check->has_leaks_fixed = result.leaks_fixed != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500696 check->image_end_offset = result.image_end_offset;
697 check->has_image_end_offset = result.image_end_offset != 0;
698 check->total_clusters = result.bfi.total_clusters;
699 check->has_total_clusters = result.bfi.total_clusters != 0;
700 check->allocated_clusters = result.bfi.allocated_clusters;
701 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
702 check->fragmented_clusters = result.bfi.fragmented_clusters;
703 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
Stefan Hajnoczie6439d72013-02-07 17:15:04 +0100704 check->compressed_clusters = result.bfi.compressed_clusters;
705 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500706
707 return 0;
708}
709
Kevin Wolfe076f332010-06-29 11:43:13 +0200710/*
711 * Checks an image for consistency. Exit codes:
712 *
Max Reitzd6635c42014-06-02 22:15:21 +0200713 * 0 - Check completed, image is good
714 * 1 - Check not completed because of internal errors
715 * 2 - Check completed, image is corrupted
716 * 3 - Check completed, image has leaked clusters, but is good otherwise
717 * 63 - Checks are not supported by the image format
Kevin Wolfe076f332010-06-29 11:43:13 +0200718 */
aliguori15859692009-04-21 23:11:53 +0000719static int img_check(int argc, char **argv)
720{
721 int c, ret;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500722 OutputFormat output_format = OFORMAT_HUMAN;
Max Reitz40055952014-07-22 22:58:42 +0200723 const char *filename, *fmt, *output, *cache;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200724 BlockBackend *blk;
aliguori15859692009-04-21 23:11:53 +0000725 BlockDriverState *bs;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200726 int fix = 0;
Kevin Wolfce099542016-03-15 13:01:04 +0100727 int flags = BDRV_O_CHECK;
728 bool writethrough;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200729 ImageCheck *check;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100730 bool quiet = false;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000731 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +0800732 bool force_share = false;
aliguori15859692009-04-21 23:11:53 +0000733
734 fmt = NULL;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500735 output = NULL;
Max Reitz40055952014-07-22 22:58:42 +0200736 cache = BDRV_DEFAULT_CACHE;
Kevin Wolfce099542016-03-15 13:01:04 +0100737
aliguori15859692009-04-21 23:11:53 +0000738 for(;;) {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500739 int option_index = 0;
740 static const struct option long_options[] = {
741 {"help", no_argument, 0, 'h'},
742 {"format", required_argument, 0, 'f'},
Prasad Joshi4fd6a982014-03-25 00:08:54 +0530743 {"repair", required_argument, 0, 'r'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500744 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000745 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000746 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +0800747 {"force-share", no_argument, 0, 'U'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500748 {0, 0, 0, 0}
749 };
Fam Zheng335e9932017-05-03 00:35:39 +0800750 c = getopt_long(argc, argv, ":hf:r:T:qU",
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500751 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100752 if (c == -1) {
aliguori15859692009-04-21 23:11:53 +0000753 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100754 }
aliguori15859692009-04-21 23:11:53 +0000755 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800756 case ':':
757 missing_argument(argv[optind - 1]);
758 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100759 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800760 unrecognized_option(argv[optind - 1]);
761 break;
aliguori15859692009-04-21 23:11:53 +0000762 case 'h':
763 help();
764 break;
765 case 'f':
766 fmt = optarg;
767 break;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200768 case 'r':
769 flags |= BDRV_O_RDWR;
770
771 if (!strcmp(optarg, "leaks")) {
772 fix = BDRV_FIX_LEAKS;
773 } else if (!strcmp(optarg, "all")) {
774 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
775 } else {
Fam Zhengac1307a2014-04-22 13:36:11 +0800776 error_exit("Unknown option value for -r "
777 "(expecting 'leaks' or 'all'): %s", optarg);
Kevin Wolf4534ff52012-05-11 16:07:02 +0200778 }
779 break;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500780 case OPTION_OUTPUT:
781 output = optarg;
782 break;
Max Reitz40055952014-07-22 22:58:42 +0200783 case 'T':
784 cache = optarg;
785 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100786 case 'q':
787 quiet = true;
788 break;
Fam Zheng335e9932017-05-03 00:35:39 +0800789 case 'U':
790 force_share = true;
791 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +0100792 case OPTION_OBJECT:
793 user_creatable_process_cmdline(optarg);
794 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000795 case OPTION_IMAGE_OPTS:
796 image_opts = true;
797 break;
aliguori15859692009-04-21 23:11:53 +0000798 }
799 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200800 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800801 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100802 }
aliguori15859692009-04-21 23:11:53 +0000803 filename = argv[optind++];
804
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500805 if (output && !strcmp(output, "json")) {
806 output_format = OFORMAT_JSON;
807 } else if (output && !strcmp(output, "human")) {
808 output_format = OFORMAT_HUMAN;
809 } else if (output) {
810 error_report("--output must be used with human or json as argument.");
811 return 1;
812 }
813
Kevin Wolfce099542016-03-15 13:01:04 +0100814 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +0200815 if (ret < 0) {
816 error_report("Invalid source cache option: %s", cache);
817 return 1;
818 }
819
Fam Zheng335e9932017-05-03 00:35:39 +0800820 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
821 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200822 if (!blk) {
823 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900824 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200825 bs = blk_bs(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500826
827 check = g_new0(ImageCheck, 1);
828 ret = collect_image_check(bs, check, filename, fmt, fix);
Kevin Wolfe076f332010-06-29 11:43:13 +0200829
830 if (ret == -ENOTSUP) {
Max Reitz55d492d2014-05-31 21:33:30 +0200831 error_report("This image format does not support checks");
Peter Lievenfefddf92013-10-24 08:53:34 +0200832 ret = 63;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500833 goto fail;
Kevin Wolfe076f332010-06-29 11:43:13 +0200834 }
835
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500836 if (check->corruptions_fixed || check->leaks_fixed) {
837 int corruptions_fixed, leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100838 bool has_leaks_fixed, has_corruptions_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500839
840 leaks_fixed = check->leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100841 has_leaks_fixed = check->has_leaks_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500842 corruptions_fixed = check->corruptions_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100843 has_corruptions_fixed = check->has_corruptions_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500844
845 if (output_format == OFORMAT_HUMAN) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100846 qprintf(quiet,
847 "The following inconsistencies were found and repaired:\n\n"
848 " %" PRId64 " leaked clusters\n"
849 " %" PRId64 " corruptions\n\n"
850 "Double checking the fixed image now...\n",
851 check->leaks_fixed,
852 check->corruptions_fixed);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500853 }
854
Pan Nengyuanfc124ea2020-02-27 09:29:50 +0800855 qapi_free_ImageCheck(check);
856 check = g_new0(ImageCheck, 1);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500857 ret = collect_image_check(bs, check, filename, fmt, 0);
858
859 check->leaks_fixed = leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100860 check->has_leaks_fixed = has_leaks_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500861 check->corruptions_fixed = corruptions_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100862 check->has_corruptions_fixed = has_corruptions_fixed;
Kevin Wolfccf34712012-05-11 18:16:54 +0200863 }
864
Max Reitz832390a2014-10-23 15:29:12 +0200865 if (!ret) {
866 switch (output_format) {
867 case OFORMAT_HUMAN:
868 dump_human_image_check(check, quiet);
869 break;
870 case OFORMAT_JSON:
871 dump_json_image_check(check, quiet);
872 break;
873 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500874 }
875
876 if (ret || check->check_errors) {
Max Reitz832390a2014-10-23 15:29:12 +0200877 if (ret) {
878 error_report("Check failed: %s", strerror(-ret));
879 } else {
880 error_report("Check failed");
881 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500882 ret = 1;
883 goto fail;
884 }
885
886 if (check->corruptions) {
887 ret = 2;
888 } else if (check->leaks) {
889 ret = 3;
Kevin Wolfe076f332010-06-29 11:43:13 +0200890 } else {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500891 ret = 0;
aliguori15859692009-04-21 23:11:53 +0000892 }
893
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500894fail:
895 qapi_free_ImageCheck(check);
Markus Armbruster26f54e92014-10-07 13:59:04 +0200896 blk_unref(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500897 return ret;
aliguori15859692009-04-21 23:11:53 +0000898}
899
Max Reitzd4a32382014-10-24 15:57:37 +0200900typedef struct CommonBlockJobCBInfo {
901 BlockDriverState *bs;
902 Error **errp;
903} CommonBlockJobCBInfo;
904
905static void common_block_job_cb(void *opaque, int ret)
906{
907 CommonBlockJobCBInfo *cbi = opaque;
908
909 if (ret < 0) {
910 error_setg_errno(cbi->errp, -ret, "Block job failed");
911 }
Max Reitzd4a32382014-10-24 15:57:37 +0200912}
913
914static void run_block_job(BlockJob *job, Error **errp)
915{
Emanuele Giuseppe Espositoa7b4f8f2021-06-14 10:11:29 +0200916 uint64_t progress_current, progress_total;
Vladimir Sementsov-Ogievskiydf9a3162021-05-06 17:13:53 +0300917 AioContext *aio_context = block_job_get_aio_context(job);
sochin.jiang4172a002017-06-15 14:47:33 +0800918 int ret = 0;
Max Reitzd4a32382014-10-24 15:57:37 +0200919
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -0400920 job_lock();
921 job_ref_locked(&job->job);
Max Reitzd4a32382014-10-24 15:57:37 +0200922 do {
Kevin Wolf30a5c882018-05-04 12:17:20 +0200923 float progress = 0.0f;
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -0400924 job_unlock();
Max Reitzd4a32382014-10-24 15:57:37 +0200925 aio_poll(aio_context, true);
Emanuele Giuseppe Espositoa7b4f8f2021-06-14 10:11:29 +0200926
927 progress_get_snapshot(&job->job.progress, &progress_current,
928 &progress_total);
929 if (progress_total) {
930 progress = (float)progress_current / progress_total * 100.f;
Kevin Wolf30a5c882018-05-04 12:17:20 +0200931 }
932 qemu_progress_print(progress, 0);
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -0400933 job_lock();
934 } while (!job_is_ready_locked(&job->job) &&
935 !job_is_completed_locked(&job->job));
Max Reitzd4a32382014-10-24 15:57:37 +0200936
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -0400937 if (!job_is_completed_locked(&job->job)) {
938 ret = job_complete_sync_locked(&job->job, errp);
sochin.jiang4172a002017-06-15 14:47:33 +0800939 } else {
Kevin Wolf4ad35182018-04-19 17:30:16 +0200940 ret = job->job.ret;
sochin.jiang4172a002017-06-15 14:47:33 +0800941 }
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -0400942 job_unref_locked(&job->job);
943 job_unlock();
Max Reitz687fa1d2014-10-24 15:57:39 +0200944
sochin.jiang4172a002017-06-15 14:47:33 +0800945 /* publish completion progress only when success */
946 if (!ret) {
947 qemu_progress_print(100.f, 0);
948 }
Max Reitzd4a32382014-10-24 15:57:37 +0200949}
950
bellardea2384d2004-08-01 21:59:26 +0000951static int img_commit(int argc, char **argv)
952{
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400953 int c, ret, flags;
Max Reitz1b22bff2014-10-24 15:57:40 +0200954 const char *filename, *fmt, *cache, *base;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200955 BlockBackend *blk;
Max Reitzd4a32382014-10-24 15:57:37 +0200956 BlockDriverState *bs, *base_bs;
Kevin Wolf4ef85a92017-01-25 19:16:34 +0100957 BlockJob *job;
Max Reitz687fa1d2014-10-24 15:57:39 +0200958 bool progress = false, quiet = false, drop = false;
Kevin Wolfce099542016-03-15 13:01:04 +0100959 bool writethrough;
Max Reitzd4a32382014-10-24 15:57:37 +0200960 Error *local_err = NULL;
961 CommonBlockJobCBInfo cbi;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000962 bool image_opts = false;
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200963 AioContext *aio_context;
Zhenguia0441b62020-10-20 14:47:43 +0000964 int64_t rate_limit = 0;
bellardea2384d2004-08-01 21:59:26 +0000965
966 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400967 cache = BDRV_DEFAULT_CACHE;
Max Reitz1b22bff2014-10-24 15:57:40 +0200968 base = NULL;
bellardea2384d2004-08-01 21:59:26 +0000969 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000970 static const struct option long_options[] = {
971 {"help", no_argument, 0, 'h'},
972 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000973 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000974 {0, 0, 0, 0}
975 };
Zhenguia0441b62020-10-20 14:47:43 +0000976 c = getopt_long(argc, argv, ":f:ht:b:dpqr:",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000977 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100978 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000979 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100980 }
bellardea2384d2004-08-01 21:59:26 +0000981 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800982 case ':':
983 missing_argument(argv[optind - 1]);
984 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100985 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800986 unrecognized_option(argv[optind - 1]);
987 break;
bellardea2384d2004-08-01 21:59:26 +0000988 case 'h':
989 help();
990 break;
991 case 'f':
992 fmt = optarg;
993 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400994 case 't':
995 cache = optarg;
996 break;
Max Reitz1b22bff2014-10-24 15:57:40 +0200997 case 'b':
998 base = optarg;
999 /* -b implies -d */
1000 drop = true;
1001 break;
Max Reitz9a86fe42014-10-24 15:57:38 +02001002 case 'd':
1003 drop = true;
1004 break;
Max Reitz687fa1d2014-10-24 15:57:39 +02001005 case 'p':
1006 progress = true;
1007 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01001008 case 'q':
1009 quiet = true;
1010 break;
Zhenguia0441b62020-10-20 14:47:43 +00001011 case 'r':
1012 rate_limit = cvtnum("rate limit", optarg);
1013 if (rate_limit < 0) {
1014 return 1;
1015 }
1016 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01001017 case OPTION_OBJECT:
1018 user_creatable_process_cmdline(optarg);
1019 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001020 case OPTION_IMAGE_OPTS:
1021 image_opts = true;
1022 break;
bellardea2384d2004-08-01 21:59:26 +00001023 }
1024 }
Max Reitz687fa1d2014-10-24 15:57:39 +02001025
1026 /* Progress is not shown in Quiet mode */
1027 if (quiet) {
1028 progress = false;
1029 }
1030
Kevin Wolffc11eb22013-08-05 10:53:04 +02001031 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001032 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01001033 }
bellardea2384d2004-08-01 21:59:26 +00001034 filename = argv[optind++];
1035
Max Reitz9a86fe42014-10-24 15:57:38 +02001036 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
Kevin Wolfce099542016-03-15 13:01:04 +01001037 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001038 if (ret < 0) {
1039 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczia3981eb2014-08-26 19:17:54 +01001040 return 1;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001041 }
1042
Fam Zheng335e9932017-05-03 00:35:39 +08001043 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
1044 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001045 if (!blk) {
1046 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001047 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001048 bs = blk_bs(blk);
1049
Max Reitz687fa1d2014-10-24 15:57:39 +02001050 qemu_progress_init(progress, 1.f);
1051 qemu_progress_print(0.f, 100);
1052
Max Reitz1b22bff2014-10-24 15:57:40 +02001053 if (base) {
1054 base_bs = bdrv_find_backing_image(bs, base);
1055 if (!base_bs) {
Max Reitz6b33f3a2016-12-01 03:05:08 +01001056 error_setg(&local_err,
1057 "Did not find '%s' in the backing chain of '%s'",
1058 base, filename);
Max Reitz1b22bff2014-10-24 15:57:40 +02001059 goto done;
1060 }
1061 } else {
1062 /* This is different from QMP, which by default uses the deepest file in
1063 * the backing chain (i.e., the very base); however, the traditional
1064 * behavior of qemu-img commit is using the immediate backing file. */
Max Reitz4a2061e2019-06-12 19:00:30 +02001065 base_bs = bdrv_backing_chain_next(bs);
Max Reitz1b22bff2014-10-24 15:57:40 +02001066 if (!base_bs) {
1067 error_setg(&local_err, "Image does not have a backing file");
1068 goto done;
1069 }
bellardea2384d2004-08-01 21:59:26 +00001070 }
1071
Max Reitzd4a32382014-10-24 15:57:37 +02001072 cbi = (CommonBlockJobCBInfo){
1073 .errp = &local_err,
1074 .bs = bs,
1075 };
1076
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001077 aio_context = bdrv_get_aio_context(bs);
1078 aio_context_acquire(aio_context);
Zhenguia0441b62020-10-20 14:47:43 +00001079 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, rate_limit,
Kevin Wolf0db832f2017-02-20 18:10:05 +01001080 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
Fam Zheng78bbd912017-04-21 20:27:04 +08001081 &cbi, false, &local_err);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001082 aio_context_release(aio_context);
Max Reitzd4a32382014-10-24 15:57:37 +02001083 if (local_err) {
1084 goto done;
1085 }
1086
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001087 /* When the block job completes, the BlockBackend reference will point to
1088 * the old backing file. In order to avoid that the top image is already
1089 * deleted, so we can still empty it afterwards, increment the reference
1090 * counter here preemptively. */
Max Reitz9a86fe42014-10-24 15:57:38 +02001091 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001092 bdrv_ref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001093 }
1094
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001095 job = block_job_get("commit");
Liam Merwick2e2db262018-11-05 21:38:37 +00001096 assert(job);
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001097 run_block_job(job, &local_err);
Max Reitz9a86fe42014-10-24 15:57:38 +02001098 if (local_err) {
1099 goto unref_backing;
1100 }
1101
Max Reitz2d97fde2020-04-29 16:11:26 +02001102 if (!drop) {
1103 BlockBackend *old_backing_blk;
1104
1105 old_backing_blk = blk_new_with_bs(bs, BLK_PERM_WRITE, BLK_PERM_ALL,
1106 &local_err);
1107 if (!old_backing_blk) {
1108 goto unref_backing;
1109 }
1110 ret = blk_make_empty(old_backing_blk, &local_err);
1111 blk_unref(old_backing_blk);
1112 if (ret == -ENOTSUP) {
1113 error_free(local_err);
1114 local_err = NULL;
1115 } else if (ret < 0) {
Max Reitz9a86fe42014-10-24 15:57:38 +02001116 goto unref_backing;
1117 }
1118 }
1119
1120unref_backing:
1121 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001122 bdrv_unref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001123 }
Max Reitzd4a32382014-10-24 15:57:37 +02001124
1125done:
Max Reitz687fa1d2014-10-24 15:57:39 +02001126 qemu_progress_end();
1127
Kevin Wolf44efba22023-01-12 20:14:52 +01001128 /*
1129 * Manually inactivate the image first because this way we can know whether
1130 * an error occurred. blk_unref() doesn't tell us about failures.
1131 */
1132 ret = bdrv_inactivate_all();
1133 if (ret < 0 && !local_err) {
1134 error_setg_errno(&local_err, -ret, "Error while closing the image");
1135 }
Markus Armbruster26f54e92014-10-07 13:59:04 +02001136 blk_unref(blk);
Max Reitzd4a32382014-10-24 15:57:37 +02001137
1138 if (local_err) {
Markus Armbruster6936f292015-02-10 15:14:02 +01001139 error_report_err(local_err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001140 return 1;
1141 }
Max Reitzd4a32382014-10-24 15:57:37 +02001142
1143 qprintf(quiet, "Image committed.\n");
bellardea2384d2004-08-01 21:59:26 +00001144 return 0;
1145}
1146
Dmitry Konishchevf6a00aa2011-05-18 15:03:59 +04001147/*
Eric Blakedebb38a2017-10-11 22:47:11 -05001148 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1149 * of the first sector boundary within buf where the sector contains a
1150 * non-zero byte. This function is robust to a buffer that is not
1151 * sector-aligned.
1152 */
1153static int64_t find_nonzero(const uint8_t *buf, int64_t n)
1154{
1155 int64_t i;
1156 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);
1157
1158 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
1159 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
1160 return i;
1161 }
1162 }
1163 if (i < n && !buffer_is_zero(buf + i, n - end)) {
1164 return i;
1165 }
1166 return -1;
1167}
1168
1169/*
thsf58c7b32008-06-05 21:53:49 +00001170 * Returns true iff the first sector pointed to by 'buf' contains at least
1171 * a non-NUL byte.
1172 *
1173 * 'pnum' is set to the number of sectors (including and immediately following
1174 * the first one) that are known to be in the same allocated/unallocated state.
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001175 * The function will try to align the end offset to alignment boundaries so
zhaolichange3a6e0d2020-09-17 15:50:20 +08001176 * that the request will at least end aligned and consecutive requests will
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001177 * also start at an aligned offset.
thsf58c7b32008-06-05 21:53:49 +00001178 */
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001179static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
1180 int64_t sector_num, int alignment)
bellardea2384d2004-08-01 21:59:26 +00001181{
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001182 bool is_zero;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001183 int i, tail;
bellardea2384d2004-08-01 21:59:26 +00001184
1185 if (n <= 0) {
1186 *pnum = 0;
1187 return 0;
1188 }
Yi Lic075c422020-08-19 09:36:07 +08001189 is_zero = buffer_is_zero(buf, BDRV_SECTOR_SIZE);
bellardea2384d2004-08-01 21:59:26 +00001190 for(i = 1; i < n; i++) {
Yi Lic075c422020-08-19 09:36:07 +08001191 buf += BDRV_SECTOR_SIZE;
1192 if (is_zero != buffer_is_zero(buf, BDRV_SECTOR_SIZE)) {
bellardea2384d2004-08-01 21:59:26 +00001193 break;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001194 }
bellardea2384d2004-08-01 21:59:26 +00001195 }
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001196
Vladimir Sementsov-Ogievskiy96054c72021-12-17 17:46:54 +01001197 if (i == n) {
1198 /*
1199 * The whole buf is the same.
1200 * No reason to split it into chunks, so return now.
1201 */
1202 *pnum = i;
1203 return !is_zero;
1204 }
1205
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001206 tail = (sector_num + i) & (alignment - 1);
1207 if (tail) {
1208 if (is_zero && i <= tail) {
Vladimir Sementsov-Ogievskiy96054c72021-12-17 17:46:54 +01001209 /*
1210 * For sure next sector after i is data, and it will rewrite this
1211 * tail anyway due to RMW. So, let's just write data now.
1212 */
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001213 is_zero = false;
1214 }
1215 if (!is_zero) {
Vladimir Sementsov-Ogievskiy96054c72021-12-17 17:46:54 +01001216 /* If possible, align up end offset of allocated areas. */
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001217 i += alignment - tail;
1218 i = MIN(i, n);
1219 } else {
Vladimir Sementsov-Ogievskiy96054c72021-12-17 17:46:54 +01001220 /*
1221 * For sure next sector after i is data, and it will rewrite this
1222 * tail anyway due to RMW. Better is avoid RMW and write zeroes up
1223 * to aligned bound.
1224 */
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001225 i -= tail;
1226 }
1227 }
bellardea2384d2004-08-01 21:59:26 +00001228 *pnum = i;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001229 return !is_zero;
bellardea2384d2004-08-01 21:59:26 +00001230}
1231
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001232/*
Kevin Wolfa22f1232011-08-26 15:27:13 +02001233 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1234 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1235 * breaking up write requests for only small sparse areas.
1236 */
1237static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001238 int min, int64_t sector_num, int alignment)
Kevin Wolfa22f1232011-08-26 15:27:13 +02001239{
1240 int ret;
1241 int num_checked, num_used;
1242
1243 if (n < min) {
1244 min = n;
1245 }
1246
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001247 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001248 if (!ret) {
1249 return ret;
1250 }
1251
1252 num_used = *pnum;
1253 buf += BDRV_SECTOR_SIZE * *pnum;
1254 n -= *pnum;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001255 sector_num += *pnum;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001256 num_checked = num_used;
1257
1258 while (n > 0) {
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001259 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001260
1261 buf += BDRV_SECTOR_SIZE * *pnum;
1262 n -= *pnum;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001263 sector_num += *pnum;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001264 num_checked += *pnum;
1265 if (ret) {
1266 num_used = num_checked;
1267 } else if (*pnum >= min) {
1268 break;
1269 }
1270 }
1271
1272 *pnum = num_used;
1273 return 1;
1274}
1275
1276/*
Eric Blakedc61cd32017-10-11 22:47:14 -05001277 * Compares two buffers sector by sector. Returns 0 if the first
1278 * sector of each buffer matches, non-zero otherwise.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001279 *
Eric Blakedc61cd32017-10-11 22:47:14 -05001280 * pnum is set to the sector-aligned size of the buffer prefix that
1281 * has the same matching status as the first sector.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001282 */
Eric Blakedc61cd32017-10-11 22:47:14 -05001283static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
1284 int64_t bytes, int64_t *pnum)
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001285{
Radim Krčmář8c1ac472015-02-20 17:06:15 +01001286 bool res;
Eric Blakedc61cd32017-10-11 22:47:14 -05001287 int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001288
Eric Blakedc61cd32017-10-11 22:47:14 -05001289 assert(bytes > 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001290
Eric Blakedc61cd32017-10-11 22:47:14 -05001291 res = !!memcmp(buf1, buf2, i);
1292 while (i < bytes) {
1293 int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001294
Eric Blakedc61cd32017-10-11 22:47:14 -05001295 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001296 break;
1297 }
Eric Blakedc61cd32017-10-11 22:47:14 -05001298 i += len;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001299 }
1300
1301 *pnum = i;
1302 return res;
1303}
1304
Stefano Garzarella97ede572019-05-08 12:43:24 +02001305#define IO_BUF_SIZE (2 * MiB)
bellardea2384d2004-08-01 21:59:26 +00001306
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001307/*
1308 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1309 *
Eric Blake0608e402017-10-11 22:47:12 -05001310 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1311 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1312 * failure), and 4 on error (the exit status for read errors), after emitting
1313 * an error message.
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001314 *
Max Reitzf1d3cd72015-02-05 13:58:18 -05001315 * @param blk: BlockBackend for the image
Eric Blakec41508e2017-10-11 22:47:13 -05001316 * @param offset: Starting offset to check
1317 * @param bytes: Number of bytes to check
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001318 * @param filename: Name of disk file we are checking (logging purpose)
1319 * @param buffer: Allocated buffer for storing read data
1320 * @param quiet: Flag for quiet mode
1321 */
Eric Blakec41508e2017-10-11 22:47:13 -05001322static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1323 int64_t bytes, const char *filename,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001324 uint8_t *buffer, bool quiet)
1325{
Eric Blakedebb38a2017-10-11 22:47:11 -05001326 int ret = 0;
1327 int64_t idx;
1328
Alberto Fariaa9262f52022-07-05 17:15:11 +01001329 ret = blk_pread(blk, offset, bytes, buffer, 0);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001330 if (ret < 0) {
1331 error_report("Error while reading offset %" PRId64 " of %s: %s",
Eric Blakec41508e2017-10-11 22:47:13 -05001332 offset, filename, strerror(-ret));
Eric Blake0608e402017-10-11 22:47:12 -05001333 return 4;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001334 }
Eric Blakec41508e2017-10-11 22:47:13 -05001335 idx = find_nonzero(buffer, bytes);
Eric Blakedebb38a2017-10-11 22:47:11 -05001336 if (idx >= 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001337 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blakec41508e2017-10-11 22:47:13 -05001338 offset + idx);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001339 return 1;
1340 }
1341
1342 return 0;
1343}
1344
1345/*
1346 * Compares two images. Exit codes:
1347 *
Kevin Wolf99b1e642021-02-17 12:56:45 +01001348 * 0 - Images are identical or the requested help was printed
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001349 * 1 - Images differ
1350 * >1 - Error occurred
1351 */
1352static int img_compare(int argc, char **argv)
1353{
Max Reitz40055952014-07-22 22:58:42 +02001354 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001355 BlockBackend *blk1, *blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001356 BlockDriverState *bs1, *bs2;
Eric Blake033d9fc2017-10-11 22:47:16 -05001357 int64_t total_size1, total_size2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001358 uint8_t *buf1 = NULL, *buf2 = NULL;
Eric Blake31826642017-10-11 22:47:08 -05001359 int64_t pnum1, pnum2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001360 int allocated1, allocated2;
1361 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1362 bool progress = false, quiet = false, strict = false;
Max Reitz40055952014-07-22 22:58:42 +02001363 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01001364 bool writethrough;
Eric Blake033d9fc2017-10-11 22:47:16 -05001365 int64_t total_size;
1366 int64_t offset = 0;
1367 int64_t chunk;
Eric Blakedc61cd32017-10-11 22:47:14 -05001368 int c;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001369 uint64_t progress_base;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001370 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08001371 bool force_share = false;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001372
Max Reitz40055952014-07-22 22:58:42 +02001373 cache = BDRV_DEFAULT_CACHE;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001374 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001375 static const struct option long_options[] = {
1376 {"help", no_argument, 0, 'h'},
1377 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001378 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08001379 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001380 {0, 0, 0, 0}
1381 };
Fam Zheng335e9932017-05-03 00:35:39 +08001382 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001383 long_options, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001384 if (c == -1) {
1385 break;
1386 }
1387 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001388 case ':':
1389 missing_argument(argv[optind - 1]);
1390 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001391 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001392 unrecognized_option(argv[optind - 1]);
1393 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001394 case 'h':
1395 help();
1396 break;
1397 case 'f':
1398 fmt1 = optarg;
1399 break;
1400 case 'F':
1401 fmt2 = optarg;
1402 break;
Max Reitz40055952014-07-22 22:58:42 +02001403 case 'T':
1404 cache = optarg;
1405 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001406 case 'p':
1407 progress = true;
1408 break;
1409 case 'q':
1410 quiet = true;
1411 break;
1412 case 's':
1413 strict = true;
1414 break;
Fam Zheng335e9932017-05-03 00:35:39 +08001415 case 'U':
1416 force_share = true;
1417 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01001418 case OPTION_OBJECT:
1419 {
1420 Error *local_err = NULL;
1421
1422 if (!user_creatable_add_from_str(optarg, &local_err)) {
1423 if (local_err) {
1424 error_report_err(local_err);
1425 exit(2);
1426 } else {
1427 /* Help was printed */
1428 exit(EXIT_SUCCESS);
1429 }
1430 }
1431 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001432 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001433 case OPTION_IMAGE_OPTS:
1434 image_opts = true;
1435 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001436 }
1437 }
1438
1439 /* Progress is not shown in Quiet mode */
1440 if (quiet) {
1441 progress = false;
1442 }
1443
1444
Kevin Wolffc11eb22013-08-05 10:53:04 +02001445 if (optind != argc - 2) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001446 error_exit("Expecting two image file names");
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001447 }
1448 filename1 = argv[optind++];
1449 filename2 = argv[optind++];
1450
Stefan Hajnoczicbda0162014-08-26 19:17:55 +01001451 /* Initialize before goto out */
1452 qemu_progress_init(progress, 2.0);
1453
Kevin Wolfce099542016-03-15 13:01:04 +01001454 flags = 0;
1455 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +02001456 if (ret < 0) {
1457 error_report("Invalid source cache option: %s", cache);
1458 ret = 2;
1459 goto out3;
1460 }
1461
Fam Zheng335e9932017-05-03 00:35:39 +08001462 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1463 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001464 if (!blk1) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001465 ret = 2;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001466 goto out3;
1467 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001468
Fam Zheng335e9932017-05-03 00:35:39 +08001469 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1470 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001471 if (!blk2) {
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001472 ret = 2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001473 goto out2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001474 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001475 bs1 = blk_bs(blk1);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001476 bs2 = blk_bs(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001477
Max Reitzf1d3cd72015-02-05 13:58:18 -05001478 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1479 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
Eric Blake033d9fc2017-10-11 22:47:16 -05001480 total_size1 = blk_getlength(blk1);
1481 if (total_size1 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001482 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001483 filename1, strerror(-total_size1));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001484 ret = 4;
1485 goto out;
1486 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001487 total_size2 = blk_getlength(blk2);
1488 if (total_size2 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001489 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001490 filename2, strerror(-total_size2));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001491 ret = 4;
1492 goto out;
1493 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001494 total_size = MIN(total_size1, total_size2);
1495 progress_base = MAX(total_size1, total_size2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001496
1497 qemu_progress_print(0, 100);
1498
Eric Blake033d9fc2017-10-11 22:47:16 -05001499 if (strict && total_size1 != total_size2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001500 ret = 1;
1501 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1502 goto out;
1503 }
1504
Eric Blake033d9fc2017-10-11 22:47:16 -05001505 while (offset < total_size) {
Eric Blake31826642017-10-11 22:47:08 -05001506 int status1, status2;
Fam Zheng67a0fd22016-01-26 11:58:48 +08001507
Eric Blake033d9fc2017-10-11 22:47:16 -05001508 status1 = bdrv_block_status_above(bs1, NULL, offset,
1509 total_size1 - offset, &pnum1, NULL,
1510 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001511 if (status1 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001512 ret = 3;
1513 error_report("Sector allocation test failed for %s", filename1);
1514 goto out;
1515 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001516 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001517
Eric Blake033d9fc2017-10-11 22:47:16 -05001518 status2 = bdrv_block_status_above(bs2, NULL, offset,
1519 total_size2 - offset, &pnum2, NULL,
1520 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001521 if (status2 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001522 ret = 3;
1523 error_report("Sector allocation test failed for %s", filename2);
1524 goto out;
1525 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001526 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
Eric Blake7daddc62017-10-11 22:47:09 -05001527
1528 assert(pnum1 && pnum2);
Eric Blake033d9fc2017-10-11 22:47:16 -05001529 chunk = MIN(pnum1, pnum2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001530
Fam Zheng25ad8e62016-01-13 16:37:41 +08001531 if (strict) {
Eric Blake31826642017-10-11 22:47:08 -05001532 if (status1 != status2) {
Fam Zheng25ad8e62016-01-13 16:37:41 +08001533 ret = 1;
1534 qprintf(quiet, "Strict mode: Offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001535 " block status mismatch!\n", offset);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001536 goto out;
1537 }
1538 }
1539 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
Eric Blake7daddc62017-10-11 22:47:09 -05001540 /* nothing to do */
Fam Zheng25ad8e62016-01-13 16:37:41 +08001541 } else if (allocated1 == allocated2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001542 if (allocated1) {
Eric Blakedc61cd32017-10-11 22:47:14 -05001543 int64_t pnum;
1544
Eric Blake033d9fc2017-10-11 22:47:16 -05001545 chunk = MIN(chunk, IO_BUF_SIZE);
Alberto Fariaa9262f52022-07-05 17:15:11 +01001546 ret = blk_pread(blk1, offset, chunk, buf1, 0);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001547 if (ret < 0) {
1548 error_report("Error while reading offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001549 " of %s: %s",
1550 offset, filename1, strerror(-ret));
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001551 ret = 4;
1552 goto out;
1553 }
Alberto Fariaa9262f52022-07-05 17:15:11 +01001554 ret = blk_pread(blk2, offset, chunk, buf2, 0);
Eric Blake033d9fc2017-10-11 22:47:16 -05001555 if (ret < 0) {
1556 error_report("Error while reading offset %" PRId64
1557 " of %s: %s",
1558 offset, filename2, strerror(-ret));
1559 ret = 4;
1560 goto out;
1561 }
1562 ret = compare_buffers(buf1, buf2, chunk, &pnum);
1563 if (ret || pnum != chunk) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001564 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blake033d9fc2017-10-11 22:47:16 -05001565 offset + (ret ? 0 : pnum));
Fam Zheng36452f12013-11-13 20:26:49 +08001566 ret = 1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001567 goto out;
1568 }
1569 }
1570 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001571 chunk = MIN(chunk, IO_BUF_SIZE);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001572 if (allocated1) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001573 ret = check_empty_sectors(blk1, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001574 filename1, buf1, quiet);
1575 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001576 ret = check_empty_sectors(blk2, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001577 filename2, buf1, quiet);
1578 }
1579 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001580 goto out;
1581 }
1582 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001583 offset += chunk;
1584 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001585 }
1586
Eric Blake033d9fc2017-10-11 22:47:16 -05001587 if (total_size1 != total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001588 BlockBackend *blk_over;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001589 const char *filename_over;
1590
1591 qprintf(quiet, "Warning: Image size mismatch!\n");
Eric Blake033d9fc2017-10-11 22:47:16 -05001592 if (total_size1 > total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001593 blk_over = blk1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001594 filename_over = filename1;
1595 } else {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001596 blk_over = blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001597 filename_over = filename2;
1598 }
1599
Eric Blake033d9fc2017-10-11 22:47:16 -05001600 while (offset < progress_base) {
1601 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1602 progress_base - offset, &chunk,
1603 NULL, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001604 if (ret < 0) {
1605 ret = 3;
1606 error_report("Sector allocation test failed for %s",
1607 filename_over);
1608 goto out;
1609
1610 }
Eric Blake391cb1a2017-10-11 22:47:10 -05001611 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001612 chunk = MIN(chunk, IO_BUF_SIZE);
1613 ret = check_empty_sectors(blk_over, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001614 filename_over, buf1, quiet);
1615 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001616 goto out;
1617 }
1618 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001619 offset += chunk;
1620 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001621 }
1622 }
1623
1624 qprintf(quiet, "Images are identical.\n");
1625 ret = 0;
1626
1627out:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001628 qemu_vfree(buf1);
1629 qemu_vfree(buf2);
Markus Armbruster26f54e92014-10-07 13:59:04 +02001630 blk_unref(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001631out2:
Markus Armbruster26f54e92014-10-07 13:59:04 +02001632 blk_unref(blk1);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001633out3:
1634 qemu_progress_end();
1635 return ret;
1636}
1637
Eric Blake6c729dd2020-05-21 14:21:35 -05001638/* Convenience wrapper around qmp_block_dirty_bitmap_merge */
1639static void do_dirty_bitmap_merge(const char *dst_node, const char *dst_name,
1640 const char *src_node, const char *src_name,
1641 Error **errp)
1642{
Vladimir Sementsov-Ogievskiy1466ef62022-03-15 00:32:24 +03001643 BlockDirtyBitmapOrStr *merge_src;
1644 BlockDirtyBitmapOrStrList *list = NULL;
Eric Blake6c729dd2020-05-21 14:21:35 -05001645
Vladimir Sementsov-Ogievskiy1466ef62022-03-15 00:32:24 +03001646 merge_src = g_new0(BlockDirtyBitmapOrStr, 1);
Eric Blake6c729dd2020-05-21 14:21:35 -05001647 merge_src->type = QTYPE_QDICT;
1648 merge_src->u.external.node = g_strdup(src_node);
1649 merge_src->u.external.name = g_strdup(src_name);
Eric Blake54aa3de2020-11-12 19:13:37 -06001650 QAPI_LIST_PREPEND(list, merge_src);
Eric Blake6c729dd2020-05-21 14:21:35 -05001651 qmp_block_dirty_bitmap_merge(dst_node, dst_name, list, errp);
Vladimir Sementsov-Ogievskiy1466ef62022-03-15 00:32:24 +03001652 qapi_free_BlockDirtyBitmapOrStrList(list);
Eric Blake6c729dd2020-05-21 14:21:35 -05001653}
1654
Kevin Wolf690c7302015-03-19 13:33:32 +01001655enum ImgConvertBlockStatus {
1656 BLK_DATA,
1657 BLK_ZERO,
1658 BLK_BACKING_FILE,
1659};
1660
Peter Lieven2d9187b2017-02-28 13:40:07 +01001661#define MAX_COROUTINES 16
Zhengui0c8c4892020-10-20 14:47:44 +00001662#define CONVERT_THROTTLE_GROUP "img_convert"
Peter Lieven2d9187b2017-02-28 13:40:07 +01001663
Kevin Wolf690c7302015-03-19 13:33:32 +01001664typedef struct ImgConvertState {
1665 BlockBackend **src;
1666 int64_t *src_sectors;
Peter Lievenaf8d43d2020-09-01 14:51:29 +02001667 int *src_alignment;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001668 int src_num;
Kevin Wolf690c7302015-03-19 13:33:32 +01001669 int64_t total_sectors;
1670 int64_t allocated_sectors;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001671 int64_t allocated_done;
1672 int64_t sector_num;
1673 int64_t wr_offs;
Kevin Wolf690c7302015-03-19 13:33:32 +01001674 enum ImgConvertBlockStatus status;
1675 int64_t sector_next_status;
1676 BlockBackend *target;
1677 bool has_zero_init;
1678 bool compressed;
Max Reitz4d7c4872019-07-24 19:12:29 +02001679 bool target_is_new;
Kevin Wolf690c7302015-03-19 13:33:32 +01001680 bool target_has_backing;
Max Reitz351c8ef2018-05-01 18:57:49 +02001681 int64_t target_backing_sectors; /* negative if unknown */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001682 bool wr_in_order;
Fam Zhengee5306d2018-06-01 17:26:48 +08001683 bool copy_range;
Max Reitz8eaac022019-05-07 22:35:03 +02001684 bool salvage;
Max Reitz3d96cb92019-05-07 22:35:02 +02001685 bool quiet;
Kevin Wolf690c7302015-03-19 13:33:32 +01001686 int min_sparse;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001687 int alignment;
Kevin Wolf690c7302015-03-19 13:33:32 +01001688 size_t cluster_sectors;
1689 size_t buf_sectors;
Peter Lieven9fd77f92017-04-21 11:11:55 +02001690 long num_coroutines;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001691 int running_coroutines;
1692 Coroutine *co[MAX_COROUTINES];
1693 int64_t wait_sector_num[MAX_COROUTINES];
1694 CoMutex lock;
1695 int ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001696} ImgConvertState;
1697
Peter Lieven2d9187b2017-02-28 13:40:07 +01001698static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1699 int *src_cur, int64_t *src_cur_offset)
Kevin Wolf690c7302015-03-19 13:33:32 +01001700{
Peter Lieven2d9187b2017-02-28 13:40:07 +01001701 *src_cur = 0;
1702 *src_cur_offset = 0;
1703 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1704 *src_cur_offset += s->src_sectors[*src_cur];
1705 (*src_cur)++;
1706 assert(*src_cur < s->src_num);
Kevin Wolf690c7302015-03-19 13:33:32 +01001707 }
1708}
1709
1710static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1711{
Eric Blake31826642017-10-11 22:47:08 -05001712 int64_t src_cur_offset;
1713 int ret, n, src_cur;
Max Reitz351c8ef2018-05-01 18:57:49 +02001714 bool post_backing_zero = false;
Kevin Wolf690c7302015-03-19 13:33:32 +01001715
Peter Lieven2d9187b2017-02-28 13:40:07 +01001716 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
Kevin Wolf690c7302015-03-19 13:33:32 +01001717
1718 assert(s->total_sectors > sector_num);
1719 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1720
Max Reitz351c8ef2018-05-01 18:57:49 +02001721 if (s->target_backing_sectors >= 0) {
1722 if (sector_num >= s->target_backing_sectors) {
Vladimir Sementsov-Ogievskiy2253d862020-05-28 12:43:56 +03001723 post_backing_zero = true;
Max Reitz351c8ef2018-05-01 18:57:49 +02001724 } else if (sector_num + n > s->target_backing_sectors) {
1725 /* Split requests around target_backing_sectors (because
1726 * starting from there, zeros are handled differently) */
1727 n = s->target_backing_sectors - sector_num;
1728 }
1729 }
1730
Kevin Wolf690c7302015-03-19 13:33:32 +01001731 if (s->sector_next_status <= sector_num) {
Max Reitz8eaac022019-05-07 22:35:03 +02001732 uint64_t offset = (sector_num - src_cur_offset) * BDRV_SECTOR_SIZE;
1733 int64_t count;
Peter Lievenaf8d43d2020-09-01 14:51:29 +02001734 int tail;
Max Reitz4a2061e2019-06-12 19:00:30 +02001735 BlockDriverState *src_bs = blk_bs(s->src[src_cur]);
1736 BlockDriverState *base;
1737
1738 if (s->target_has_backing) {
1739 base = bdrv_cow_bs(bdrv_skip_filters(src_bs));
1740 } else {
1741 base = NULL;
1742 }
Eric Blake31826642017-10-11 22:47:08 -05001743
Max Reitz8eaac022019-05-07 22:35:03 +02001744 do {
1745 count = n * BDRV_SECTOR_SIZE;
Eric Blake237d78f2017-10-11 22:47:03 -05001746
Max Reitz4a2061e2019-06-12 19:00:30 +02001747 ret = bdrv_block_status_above(src_bs, base, offset, count, &count,
1748 NULL, NULL);
Max Reitz8eaac022019-05-07 22:35:03 +02001749
1750 if (ret < 0) {
1751 if (s->salvage) {
1752 if (n == 1) {
1753 if (!s->quiet) {
1754 warn_report("error while reading block status at "
1755 "offset %" PRIu64 ": %s", offset,
1756 strerror(-ret));
1757 }
1758 /* Just try to read the data, then */
1759 ret = BDRV_BLOCK_DATA;
1760 count = BDRV_SECTOR_SIZE;
1761 } else {
1762 /* Retry on a shorter range */
1763 n = DIV_ROUND_UP(n, 4);
1764 }
1765 } else {
1766 error_report("error while reading block status at offset "
1767 "%" PRIu64 ": %s", offset, strerror(-ret));
1768 return ret;
1769 }
1770 }
1771 } while (ret < 0);
1772
Eric Blake31826642017-10-11 22:47:08 -05001773 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
Kevin Wolf690c7302015-03-19 13:33:32 +01001774
Peter Lievenaf8d43d2020-09-01 14:51:29 +02001775 /*
1776 * Avoid that s->sector_next_status becomes unaligned to the source
1777 * request alignment and/or cluster size to avoid unnecessary read
1778 * cycles.
1779 */
1780 tail = (sector_num - src_cur_offset + n) % s->src_alignment[src_cur];
1781 if (n > tail) {
1782 n -= tail;
1783 }
1784
Kevin Wolf690c7302015-03-19 13:33:32 +01001785 if (ret & BDRV_BLOCK_ZERO) {
Max Reitz351c8ef2018-05-01 18:57:49 +02001786 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
Kevin Wolf690c7302015-03-19 13:33:32 +01001787 } else if (ret & BDRV_BLOCK_DATA) {
1788 s->status = BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001789 } else {
Vladimir Sementsov-Ogievskiy9f1b92a2017-04-07 14:34:04 +03001790 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001791 }
1792
1793 s->sector_next_status = sector_num + n;
1794 }
1795
1796 n = MIN(n, s->sector_next_status - sector_num);
1797 if (s->status == BLK_DATA) {
1798 n = MIN(n, s->buf_sectors);
1799 }
1800
1801 /* We need to write complete clusters for compressed images, so if an
1802 * unallocated area is shorter than that, we must consider the whole
1803 * cluster allocated. */
1804 if (s->compressed) {
1805 if (n < s->cluster_sectors) {
1806 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1807 s->status = BLK_DATA;
1808 } else {
1809 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1810 }
1811 }
1812
1813 return n;
1814}
1815
Peter Lieven2d9187b2017-02-28 13:40:07 +01001816static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1817 int nb_sectors, uint8_t *buf)
Kevin Wolf690c7302015-03-19 13:33:32 +01001818{
Max Reitz8eaac022019-05-07 22:35:03 +02001819 uint64_t single_read_until = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001820 int n, ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001821
Kevin Wolf690c7302015-03-19 13:33:32 +01001822 assert(nb_sectors <= s->buf_sectors);
1823 while (nb_sectors > 0) {
1824 BlockBackend *blk;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001825 int src_cur;
1826 int64_t bs_sectors, src_cur_offset;
Max Reitz8eaac022019-05-07 22:35:03 +02001827 uint64_t offset;
Kevin Wolf690c7302015-03-19 13:33:32 +01001828
1829 /* In the case of compression with multiple source files, we can get a
1830 * nb_sectors that spreads into the next part. So we must be able to
1831 * read across multiple BDSes for one convert_read() call. */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001832 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1833 blk = s->src[src_cur];
1834 bs_sectors = s->src_sectors[src_cur];
Kevin Wolf690c7302015-03-19 13:33:32 +01001835
Max Reitz8eaac022019-05-07 22:35:03 +02001836 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001837
Max Reitz8eaac022019-05-07 22:35:03 +02001838 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1839 if (single_read_until > offset) {
1840 n = 1;
1841 }
1842
1843 ret = blk_co_pread(blk, offset, n << BDRV_SECTOR_BITS, buf, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01001844 if (ret < 0) {
Max Reitz8eaac022019-05-07 22:35:03 +02001845 if (s->salvage) {
1846 if (n > 1) {
1847 single_read_until = offset + (n << BDRV_SECTOR_BITS);
1848 continue;
1849 } else {
1850 if (!s->quiet) {
1851 warn_report("error while reading offset %" PRIu64
1852 ": %s", offset, strerror(-ret));
1853 }
1854 memset(buf, 0, BDRV_SECTOR_SIZE);
1855 }
1856 } else {
1857 return ret;
1858 }
Kevin Wolf690c7302015-03-19 13:33:32 +01001859 }
1860
1861 sector_num += n;
1862 nb_sectors -= n;
1863 buf += n * BDRV_SECTOR_SIZE;
1864 }
1865
1866 return 0;
1867}
1868
Peter Lieven2d9187b2017-02-28 13:40:07 +01001869
1870static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1871 int nb_sectors, uint8_t *buf,
1872 enum ImgConvertBlockStatus status)
Kevin Wolf690c7302015-03-19 13:33:32 +01001873{
1874 int ret;
1875
1876 while (nb_sectors > 0) {
1877 int n = nb_sectors;
Lidong Chendb933fb2017-04-27 10:58:27 +08001878 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1879
Peter Lieven2d9187b2017-02-28 13:40:07 +01001880 switch (status) {
Kevin Wolf690c7302015-03-19 13:33:32 +01001881 case BLK_BACKING_FILE:
1882 /* If we have a backing file, leave clusters unallocated that are
1883 * unallocated in the source image, so that the backing file is
1884 * visible at the respective offset. */
1885 assert(s->target_has_backing);
1886 break;
1887
1888 case BLK_DATA:
Lidong Chendb933fb2017-04-27 10:58:27 +08001889 /* If we're told to keep the target fully allocated (-S 0) or there
1890 * is real non-zero data, we must write it. Otherwise we can treat
1891 * it as zero sectors.
1892 * Compressed clusters need to be written as a whole, so in that
1893 * case we can only save the write if the buffer is completely
1894 * zeroed. */
Kevin Wolf690c7302015-03-19 13:33:32 +01001895 if (!s->min_sparse ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001896 (!s->compressed &&
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001897 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1898 sector_num, s->alignment)) ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001899 (s->compressed &&
1900 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
Kevin Wolf690c7302015-03-19 13:33:32 +01001901 {
Vladimir Sementsov-Ogievskiy265a7e52019-04-22 17:58:38 +03001902 ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1903 n << BDRV_SECTOR_BITS, buf, flags);
Kevin Wolf690c7302015-03-19 13:33:32 +01001904 if (ret < 0) {
1905 return ret;
1906 }
1907 break;
1908 }
1909 /* fall-through */
1910
1911 case BLK_ZERO:
1912 if (s->has_zero_init) {
Lidong Chendb933fb2017-04-27 10:58:27 +08001913 assert(!s->target_has_backing);
Kevin Wolf690c7302015-03-19 13:33:32 +01001914 break;
1915 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01001916 ret = blk_co_pwrite_zeroes(s->target,
1917 sector_num << BDRV_SECTOR_BITS,
Nir Soffera3d6ae22019-03-24 02:20:12 +02001918 n << BDRV_SECTOR_BITS,
1919 BDRV_REQ_MAY_UNMAP);
Kevin Wolf690c7302015-03-19 13:33:32 +01001920 if (ret < 0) {
1921 return ret;
1922 }
1923 break;
1924 }
1925
1926 sector_num += n;
1927 nb_sectors -= n;
1928 buf += n * BDRV_SECTOR_SIZE;
1929 }
1930
1931 return 0;
1932}
1933
Fam Zhengee5306d2018-06-01 17:26:48 +08001934static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1935 int nb_sectors)
1936{
1937 int n, ret;
1938
1939 while (nb_sectors > 0) {
1940 BlockBackend *blk;
1941 int src_cur;
1942 int64_t bs_sectors, src_cur_offset;
1943 int64_t offset;
1944
1945 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1946 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1947 blk = s->src[src_cur];
1948 bs_sectors = s->src_sectors[src_cur];
1949
1950 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1951
1952 ret = blk_co_copy_range(blk, offset, s->target,
1953 sector_num << BDRV_SECTOR_BITS,
Vladimir Sementsov-Ogievskiy67b51fb2018-07-09 19:37:17 +03001954 n << BDRV_SECTOR_BITS, 0, 0);
Fam Zhengee5306d2018-06-01 17:26:48 +08001955 if (ret < 0) {
1956 return ret;
1957 }
1958
1959 sector_num += n;
1960 nb_sectors -= n;
1961 }
1962 return 0;
1963}
1964
Peter Lieven2d9187b2017-02-28 13:40:07 +01001965static void coroutine_fn convert_co_do_copy(void *opaque)
1966{
1967 ImgConvertState *s = opaque;
1968 uint8_t *buf = NULL;
1969 int ret, i;
1970 int index = -1;
1971
1972 for (i = 0; i < s->num_coroutines; i++) {
1973 if (s->co[i] == qemu_coroutine_self()) {
1974 index = i;
1975 break;
1976 }
1977 }
1978 assert(index >= 0);
1979
1980 s->running_coroutines++;
1981 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1982
1983 while (1) {
1984 int n;
1985 int64_t sector_num;
1986 enum ImgConvertBlockStatus status;
Fam Zhengee5306d2018-06-01 17:26:48 +08001987 bool copy_range;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001988
1989 qemu_co_mutex_lock(&s->lock);
1990 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1991 qemu_co_mutex_unlock(&s->lock);
Anton Nefedovb91127e2017-04-26 11:33:15 +03001992 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001993 }
1994 n = convert_iteration_sectors(s, s->sector_num);
1995 if (n < 0) {
1996 qemu_co_mutex_unlock(&s->lock);
1997 s->ret = n;
Anton Nefedovb91127e2017-04-26 11:33:15 +03001998 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001999 }
2000 /* save current sector and allocation status to local variables */
2001 sector_num = s->sector_num;
2002 status = s->status;
2003 if (!s->min_sparse && s->status == BLK_ZERO) {
2004 n = MIN(n, s->buf_sectors);
2005 }
2006 /* increment global sector counter so that other coroutines can
2007 * already continue reading beyond this request */
2008 s->sector_num += n;
2009 qemu_co_mutex_unlock(&s->lock);
2010
2011 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
2012 s->allocated_done += n;
2013 qemu_progress_print(100.0 * s->allocated_done /
2014 s->allocated_sectors, 0);
2015 }
2016
Fam Zhengee5306d2018-06-01 17:26:48 +08002017retry:
2018 copy_range = s->copy_range && s->status == BLK_DATA;
2019 if (status == BLK_DATA && !copy_range) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002020 ret = convert_co_read(s, sector_num, n, buf);
2021 if (ret < 0) {
Eric Blake39f77cb2020-04-02 08:57:17 -05002022 error_report("error while reading at byte %lld: %s",
2023 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
Peter Lieven2d9187b2017-02-28 13:40:07 +01002024 s->ret = ret;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002025 }
2026 } else if (!s->min_sparse && status == BLK_ZERO) {
2027 status = BLK_DATA;
2028 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
2029 }
2030
2031 if (s->wr_in_order) {
2032 /* keep writes in order */
Anton Nefedovb91127e2017-04-26 11:33:15 +03002033 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002034 s->wait_sector_num[index] = sector_num;
2035 qemu_coroutine_yield();
2036 }
2037 s->wait_sector_num[index] = -1;
2038 }
2039
Anton Nefedovb91127e2017-04-26 11:33:15 +03002040 if (s->ret == -EINPROGRESS) {
Fam Zhengee5306d2018-06-01 17:26:48 +08002041 if (copy_range) {
2042 ret = convert_co_copy_range(s, sector_num, n);
2043 if (ret) {
2044 s->copy_range = false;
2045 goto retry;
2046 }
2047 } else {
2048 ret = convert_co_write(s, sector_num, n, buf, status);
2049 }
Anton Nefedovb91127e2017-04-26 11:33:15 +03002050 if (ret < 0) {
Eric Blake39f77cb2020-04-02 08:57:17 -05002051 error_report("error while writing at byte %lld: %s",
2052 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
Anton Nefedovb91127e2017-04-26 11:33:15 +03002053 s->ret = ret;
2054 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01002055 }
2056
2057 if (s->wr_in_order) {
2058 /* reenter the coroutine that might have waited
2059 * for this write to complete */
2060 s->wr_offs = sector_num + n;
2061 for (i = 0; i < s->num_coroutines; i++) {
2062 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
2063 /*
2064 * A -> B -> A cannot occur because A has
2065 * s->wait_sector_num[i] == -1 during A -> B. Therefore
2066 * B will never enter A during this time window.
2067 */
2068 qemu_coroutine_enter(s->co[i]);
2069 break;
2070 }
2071 }
2072 }
2073 }
2074
Peter Lieven2d9187b2017-02-28 13:40:07 +01002075 qemu_vfree(buf);
2076 s->co[index] = NULL;
2077 s->running_coroutines--;
2078 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
2079 /* the convert job finished successfully */
2080 s->ret = 0;
2081 }
2082}
2083
Kevin Wolf690c7302015-03-19 13:33:32 +01002084static int convert_do_copy(ImgConvertState *s)
2085{
Peter Lieven2d9187b2017-02-28 13:40:07 +01002086 int ret, i, n;
2087 int64_t sector_num = 0;
Kevin Wolf690c7302015-03-19 13:33:32 +01002088
2089 /* Check whether we have zero initialisation or can get it efficiently */
David Edmondson168468f2020-02-05 11:02:48 +00002090 if (!s->has_zero_init && s->target_is_new && s->min_sparse &&
2091 !s->target_has_backing) {
Max Reitz4d7c4872019-07-24 19:12:29 +02002092 s->has_zero_init = bdrv_has_zero_init(blk_bs(s->target));
Max Reitz4d7c4872019-07-24 19:12:29 +02002093 }
Kevin Wolf690c7302015-03-19 13:33:32 +01002094
Kevin Wolf690c7302015-03-19 13:33:32 +01002095 /* Allocate buffer for copied data. For compressed images, only one cluster
2096 * can be copied at a time. */
2097 if (s->compressed) {
2098 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
2099 error_report("invalid cluster size");
Peter Lieven2d9187b2017-02-28 13:40:07 +01002100 return -EINVAL;
Kevin Wolf690c7302015-03-19 13:33:32 +01002101 }
2102 s->buf_sectors = s->cluster_sectors;
2103 }
Kevin Wolf690c7302015-03-19 13:33:32 +01002104
Kevin Wolf690c7302015-03-19 13:33:32 +01002105 while (sector_num < s->total_sectors) {
2106 n = convert_iteration_sectors(s, sector_num);
2107 if (n < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002108 return n;
Kevin Wolf690c7302015-03-19 13:33:32 +01002109 }
Max Reitzaad15de2016-03-24 23:33:57 +01002110 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
2111 {
Kevin Wolf690c7302015-03-19 13:33:32 +01002112 s->allocated_sectors += n;
2113 }
2114 sector_num += n;
2115 }
2116
2117 /* Do the copy */
Kevin Wolf690c7302015-03-19 13:33:32 +01002118 s->sector_next_status = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002119 s->ret = -EINPROGRESS;
Kevin Wolf690c7302015-03-19 13:33:32 +01002120
Peter Lieven2d9187b2017-02-28 13:40:07 +01002121 qemu_co_mutex_init(&s->lock);
2122 for (i = 0; i < s->num_coroutines; i++) {
2123 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
2124 s->wait_sector_num[i] = -1;
2125 qemu_coroutine_enter(s->co[i]);
Kevin Wolf690c7302015-03-19 13:33:32 +01002126 }
2127
Anton Nefedovb91127e2017-04-26 11:33:15 +03002128 while (s->running_coroutines) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002129 main_loop_wait(false);
2130 }
2131
2132 if (s->compressed && !s->ret) {
Kevin Wolf690c7302015-03-19 13:33:32 +01002133 /* signal EOF to align */
Alberto Faria0cadf2c2022-07-05 17:15:18 +01002134 ret = blk_pwrite_compressed(s->target, 0, 0, NULL);
Kevin Wolf690c7302015-03-19 13:33:32 +01002135 if (ret < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002136 return ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002137 }
2138 }
2139
Peter Lieven2d9187b2017-02-28 13:40:07 +01002140 return s->ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002141}
2142
Eric Blake74a43202021-07-09 10:39:50 -05002143/* Check that bitmaps can be copied, or output an error */
Eric Blake955171e2021-07-21 10:53:48 -05002144static int convert_check_bitmaps(BlockDriverState *src, bool skip_broken)
Eric Blake74a43202021-07-09 10:39:50 -05002145{
2146 BdrvDirtyBitmap *bm;
2147
2148 if (!bdrv_supports_persistent_dirty_bitmap(src)) {
2149 error_report("Source lacks bitmap support");
2150 return -1;
2151 }
2152 FOR_EACH_DIRTY_BITMAP(src, bm) {
2153 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2154 continue;
2155 }
Eric Blake955171e2021-07-21 10:53:48 -05002156 if (!skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) {
Eric Blake74a43202021-07-09 10:39:50 -05002157 error_report("Cannot copy inconsistent bitmap '%s'",
2158 bdrv_dirty_bitmap_name(bm));
Eric Blake955171e2021-07-21 10:53:48 -05002159 error_printf("Try --skip-broken-bitmaps, or "
2160 "use 'qemu-img bitmap --remove' to delete it\n");
Eric Blake74a43202021-07-09 10:39:50 -05002161 return -1;
2162 }
2163 }
2164 return 0;
2165}
2166
Eric Blake955171e2021-07-21 10:53:48 -05002167static int convert_copy_bitmaps(BlockDriverState *src, BlockDriverState *dst,
2168 bool skip_broken)
Eric Blake15e39ad2020-05-21 14:21:36 -05002169{
2170 BdrvDirtyBitmap *bm;
2171 Error *err = NULL;
2172
2173 FOR_EACH_DIRTY_BITMAP(src, bm) {
2174 const char *name;
2175
2176 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2177 continue;
2178 }
2179 name = bdrv_dirty_bitmap_name(bm);
Eric Blake955171e2021-07-21 10:53:48 -05002180 if (skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) {
2181 warn_report("Skipping inconsistent bitmap '%s'", name);
2182 continue;
2183 }
Eric Blake15e39ad2020-05-21 14:21:36 -05002184 qmp_block_dirty_bitmap_add(dst->node_name, name,
2185 true, bdrv_dirty_bitmap_granularity(bm),
2186 true, true,
2187 true, !bdrv_dirty_bitmap_enabled(bm),
2188 &err);
2189 if (err) {
2190 error_reportf_err(err, "Failed to create bitmap %s: ", name);
2191 return -1;
2192 }
2193
2194 do_dirty_bitmap_merge(dst->node_name, name, src->node_name, name,
2195 &err);
2196 if (err) {
2197 error_reportf_err(err, "Failed to populate bitmap %s: ", name);
Eric Blake74a43202021-07-09 10:39:50 -05002198 qmp_block_dirty_bitmap_remove(dst->node_name, name, NULL);
Eric Blake15e39ad2020-05-21 14:21:36 -05002199 return -1;
2200 }
2201 }
2202
2203 return 0;
2204}
2205
Peter Lieven6360ab22018-07-13 09:15:39 +02002206#define MAX_BUF_SECTORS 32768
2207
Zhengui0c8c4892020-10-20 14:47:44 +00002208static void set_rate_limit(BlockBackend *blk, int64_t rate_limit)
2209{
2210 ThrottleConfig cfg;
2211
2212 throttle_config_init(&cfg);
2213 cfg.buckets[THROTTLE_BPS_WRITE].avg = rate_limit;
2214
2215 blk_io_limits_enable(blk, CONVERT_THROTTLE_GROUP);
2216 blk_set_io_limits(blk, &cfg);
2217}
2218
bellardea2384d2004-08-01 21:59:26 +00002219static int img_convert(int argc, char **argv)
2220{
Kevin Wolf0b8fb552021-04-22 18:43:44 +02002221 int c, bs_i, flags, src_flags = BDRV_O_NO_SHARE;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002222 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002223 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
Eric Blake1899bf42021-09-13 08:17:35 -05002224 *out_filename, *out_baseimg_param, *snapshot_name = NULL,
2225 *backing_fmt = NULL;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002226 BlockDriver *drv = NULL, *proto_drv = NULL;
bellardfaea38e2006-08-05 21:31:00 +00002227 BlockDriverInfo bdi;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002228 BlockDriverState *out_bs;
2229 QemuOpts *opts = NULL, *sn_opts = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08002230 QemuOptsList *create_opts = NULL;
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002231 QDict *open_opts = NULL;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002232 char *options = NULL;
Max Reitzcc84d902013-09-06 17:14:26 +02002233 Error *local_err = NULL;
Max Reitz3d96cb92019-05-07 22:35:02 +02002234 bool writethrough, src_writethrough, image_opts = false,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002235 skip_create = false, progress = false, tgt_image_opts = false;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002236 int64_t ret = -EINVAL;
Fam Zheng335e9932017-05-03 00:35:39 +08002237 bool force_share = false;
Fam Zhenge11ce122018-07-27 11:34:01 +08002238 bool explict_min_sparse = false;
Eric Blake15e39ad2020-05-21 14:21:36 -05002239 bool bitmaps = false;
Eric Blake955171e2021-07-21 10:53:48 -05002240 bool skip_broken = false;
Zhengui0c8c4892020-10-20 14:47:44 +00002241 int64_t rate_limit = 0;
bellardea2384d2004-08-01 21:59:26 +00002242
Peter Lieven9fd77f92017-04-21 11:11:55 +02002243 ImgConvertState s = (ImgConvertState) {
2244 /* Need at least 4k of zeros for sparse detection */
2245 .min_sparse = 8,
Fam Zhenge11ce122018-07-27 11:34:01 +08002246 .copy_range = false,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002247 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2248 .wr_in_order = true,
2249 .num_coroutines = 8,
2250 };
2251
bellardea2384d2004-08-01 21:59:26 +00002252 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002253 static const struct option long_options[] = {
2254 {"help", no_argument, 0, 'h'},
2255 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002256 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002257 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002258 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
Max Reitz8eaac022019-05-07 22:35:03 +02002259 {"salvage", no_argument, 0, OPTION_SALVAGE},
David Edmondson168468f2020-02-05 11:02:48 +00002260 {"target-is-zero", no_argument, 0, OPTION_TARGET_IS_ZERO},
Eric Blake15e39ad2020-05-21 14:21:36 -05002261 {"bitmaps", no_argument, 0, OPTION_BITMAPS},
Eric Blake955171e2021-07-21 10:53:48 -05002262 {"skip-broken-bitmaps", no_argument, 0, OPTION_SKIP_BROKEN},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002263 {0, 0, 0, 0}
2264 };
Eric Blake1899bf42021-09-13 08:17:35 -05002265 c = getopt_long(argc, argv, ":hf:O:B:CcF:o:l:S:pt:T:qnm:WUr:",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002266 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002267 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002268 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002269 }
bellardea2384d2004-08-01 21:59:26 +00002270 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002271 case ':':
2272 missing_argument(argv[optind - 1]);
2273 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002274 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002275 unrecognized_option(argv[optind - 1]);
2276 break;
bellardea2384d2004-08-01 21:59:26 +00002277 case 'h':
2278 help();
2279 break;
2280 case 'f':
2281 fmt = optarg;
2282 break;
2283 case 'O':
2284 out_fmt = optarg;
2285 break;
thsf58c7b32008-06-05 21:53:49 +00002286 case 'B':
2287 out_baseimg = optarg;
2288 break;
Fam Zhenge11ce122018-07-27 11:34:01 +08002289 case 'C':
2290 s.copy_range = true;
2291 break;
bellardea2384d2004-08-01 21:59:26 +00002292 case 'c':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002293 s.compressed = true;
bellardea2384d2004-08-01 21:59:26 +00002294 break;
Eric Blake1899bf42021-09-13 08:17:35 -05002295 case 'F':
2296 backing_fmt = optarg;
2297 break;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002298 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02002299 if (accumulate_options(&options, optarg) < 0) {
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002300 goto fail_getopt;
Kevin Wolf2dc83282014-02-21 16:24:05 +01002301 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002302 break;
Wenchao Xiaef806542013-12-04 17:10:57 +08002303 case 'l':
2304 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
Markus Armbruster70b94332015-02-13 12:50:26 +01002305 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2306 optarg, false);
Wenchao Xiaef806542013-12-04 17:10:57 +08002307 if (!sn_opts) {
2308 error_report("Failed in parsing snapshot param '%s'",
2309 optarg);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002310 goto fail_getopt;
Wenchao Xiaef806542013-12-04 17:10:57 +08002311 }
2312 } else {
2313 snapshot_name = optarg;
2314 }
2315 break;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002316 case 'S':
2317 {
2318 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +01002319
Eyal Moscovici43d589b2020-05-13 16:36:26 +03002320 sval = cvtnum("buffer size for sparse output", optarg);
2321 if (sval < 0) {
2322 goto fail_getopt;
2323 } else if (!QEMU_IS_ALIGNED(sval, BDRV_SECTOR_SIZE) ||
Peter Lieven6360ab22018-07-13 09:15:39 +02002324 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2325 error_report("Invalid buffer size for sparse output specified. "
2326 "Valid sizes are multiples of %llu up to %llu. Select "
2327 "0 to disable sparse detection (fully allocates output).",
2328 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002329 goto fail_getopt;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002330 }
2331
Peter Lieven9fd77f92017-04-21 11:11:55 +02002332 s.min_sparse = sval / BDRV_SECTOR_SIZE;
Fam Zhenge11ce122018-07-27 11:34:01 +08002333 explict_min_sparse = true;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002334 break;
2335 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002336 case 'p':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002337 progress = true;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002338 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002339 case 't':
2340 cache = optarg;
2341 break;
Max Reitz40055952014-07-22 22:58:42 +02002342 case 'T':
2343 src_cache = optarg;
2344 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002345 case 'q':
Max Reitz3d96cb92019-05-07 22:35:02 +02002346 s.quiet = true;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002347 break;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002348 case 'n':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002349 skip_create = true;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002350 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002351 case 'm':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002352 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2353 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002354 error_report("Invalid number of coroutines. Allowed number of"
2355 " coroutines is between 1 and %d", MAX_COROUTINES);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002356 goto fail_getopt;
2357 }
2358 break;
2359 case 'W':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002360 s.wr_in_order = false;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002361 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002362 case 'U':
2363 force_share = true;
2364 break;
Zhengui0c8c4892020-10-20 14:47:44 +00002365 case 'r':
2366 rate_limit = cvtnum("rate limit", optarg);
2367 if (rate_limit < 0) {
2368 goto fail_getopt;
2369 }
2370 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01002371 case OPTION_OBJECT:
2372 user_creatable_process_cmdline(optarg);
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002373 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002374 case OPTION_IMAGE_OPTS:
2375 image_opts = true;
2376 break;
Max Reitz8eaac022019-05-07 22:35:03 +02002377 case OPTION_SALVAGE:
2378 s.salvage = true;
2379 break;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002380 case OPTION_TARGET_IMAGE_OPTS:
2381 tgt_image_opts = true;
2382 break;
David Edmondson168468f2020-02-05 11:02:48 +00002383 case OPTION_TARGET_IS_ZERO:
2384 /*
2385 * The user asserting that the target is blank has the
2386 * same effect as the target driver supporting zero
2387 * initialisation.
2388 */
2389 s.has_zero_init = true;
2390 break;
Eric Blake15e39ad2020-05-21 14:21:36 -05002391 case OPTION_BITMAPS:
2392 bitmaps = true;
2393 break;
Eric Blake955171e2021-07-21 10:53:48 -05002394 case OPTION_SKIP_BROKEN:
2395 skip_broken = true;
2396 break;
bellardea2384d2004-08-01 21:59:26 +00002397 }
2398 }
ths3b46e622007-09-17 08:09:54 +00002399
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002400 if (!out_fmt && !tgt_image_opts) {
2401 out_fmt = "raw";
2402 }
2403
Eric Blake955171e2021-07-21 10:53:48 -05002404 if (skip_broken && !bitmaps) {
2405 error_report("Use of --skip-broken-bitmaps requires --bitmaps");
2406 goto fail_getopt;
2407 }
2408
Fam Zhenge11ce122018-07-27 11:34:01 +08002409 if (s.compressed && s.copy_range) {
2410 error_report("Cannot enable copy offloading when -c is used");
2411 goto fail_getopt;
2412 }
2413
2414 if (explict_min_sparse && s.copy_range) {
2415 error_report("Cannot enable copy offloading when -S is used");
2416 goto fail_getopt;
2417 }
2418
Max Reitz8eaac022019-05-07 22:35:03 +02002419 if (s.copy_range && s.salvage) {
2420 error_report("Cannot use copy offloading in salvaging mode");
2421 goto fail_getopt;
2422 }
2423
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002424 if (tgt_image_opts && !skip_create) {
2425 error_report("--target-image-opts requires use of -n flag");
2426 goto fail_getopt;
2427 }
2428
Kevin Wolfffd8e8f2019-08-09 11:09:21 +02002429 if (skip_create && options) {
Eric Blake25956af2020-07-06 15:39:46 -05002430 error_report("-o has no effect when skipping image creation");
2431 goto fail_getopt;
Kevin Wolfffd8e8f2019-08-09 11:09:21 +02002432 }
2433
David Edmondson168468f2020-02-05 11:02:48 +00002434 if (s.has_zero_init && !skip_create) {
2435 error_report("--target-is-zero requires use of -n flag");
2436 goto fail_getopt;
2437 }
2438
Peter Lieven9fd77f92017-04-21 11:11:55 +02002439 s.src_num = argc - optind - 1;
2440 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2441
2442 if (options && has_help_option(options)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002443 if (out_fmt) {
2444 ret = print_block_option_help(out_filename, out_fmt);
2445 goto fail_getopt;
2446 } else {
2447 error_report("Option help requires a format be specified");
2448 goto fail_getopt;
2449 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002450 }
2451
2452 if (s.src_num < 1) {
2453 error_report("Must specify image file name");
2454 goto fail_getopt;
2455 }
2456
Peter Lieven9fd77f92017-04-21 11:11:55 +02002457 /* ret is still -EINVAL until here */
2458 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2459 if (ret < 0) {
2460 error_report("Invalid source cache option: %s", src_cache);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002461 goto fail_getopt;
2462 }
2463
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002464 /* Initialize before goto out */
Max Reitz3d96cb92019-05-07 22:35:02 +02002465 if (s.quiet) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002466 progress = false;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002467 }
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002468 qemu_progress_init(progress, 1.0);
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002469 qemu_progress_print(0, 100);
2470
Peter Lieven9fd77f92017-04-21 11:11:55 +02002471 s.src = g_new0(BlockBackend *, s.src_num);
2472 s.src_sectors = g_new(int64_t, s.src_num);
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002473 s.src_alignment = g_new(int, s.src_num);
balrog926c2d22007-10-31 01:11:44 +00002474
Peter Lieven9fd77f92017-04-21 11:11:55 +02002475 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002476 BlockDriverState *src_bs;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002477 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
Max Reitz3d96cb92019-05-07 22:35:02 +02002478 fmt, src_flags, src_writethrough, s.quiet,
Fam Zheng335e9932017-05-03 00:35:39 +08002479 force_share);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002480 if (!s.src[bs_i]) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002481 ret = -1;
2482 goto out;
2483 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002484 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2485 if (s.src_sectors[bs_i] < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002486 error_report("Could not get size of %s: %s",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002487 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002488 ret = -1;
2489 goto out;
2490 }
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002491 src_bs = blk_bs(s.src[bs_i]);
2492 s.src_alignment[bs_i] = DIV_ROUND_UP(src_bs->bl.request_alignment,
2493 BDRV_SECTOR_SIZE);
2494 if (!bdrv_get_info(src_bs, &bdi)) {
2495 s.src_alignment[bs_i] = MAX(s.src_alignment[bs_i],
2496 bdi.cluster_size / BDRV_SECTOR_SIZE);
2497 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002498 s.total_sectors += s.src_sectors[bs_i];
balrog926c2d22007-10-31 01:11:44 +00002499 }
bellardea2384d2004-08-01 21:59:26 +00002500
Wenchao Xiaef806542013-12-04 17:10:57 +08002501 if (sn_opts) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002502 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
Peter Maydell10d6eda2017-02-10 16:28:24 +00002503 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2504 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2505 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002506 } else if (snapshot_name != NULL) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002507 if (s.src_num > 1) {
Markus Armbruster6daf1942011-06-22 14:03:54 +02002508 error_report("No support for concatenating multiple snapshot");
edison51ef6722010-09-21 19:58:41 -07002509 ret = -1;
2510 goto out;
2511 }
Wenchao Xia7b4c4782013-12-04 17:10:54 +08002512
Peter Lieven9fd77f92017-04-21 11:11:55 +02002513 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2514 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002515 }
Markus Armbruster84d18f02014-01-30 15:07:28 +01002516 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002517 error_reportf_err(local_err, "Failed to load snapshot: ");
Wenchao Xiaef806542013-12-04 17:10:57 +08002518 ret = -1;
2519 goto out;
edison51ef6722010-09-21 19:58:41 -07002520 }
2521
Max Reitz2e024cd2015-02-11 09:58:46 -05002522 if (!skip_create) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002523 /* Find driver and parse its options */
2524 drv = bdrv_find_format(out_fmt);
2525 if (!drv) {
2526 error_report("Unknown file format '%s'", out_fmt);
2527 ret = -1;
2528 goto out;
2529 }
2530
2531 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2532 if (!proto_drv) {
2533 error_report_err(local_err);
2534 ret = -1;
2535 goto out;
2536 }
2537
Max Reitz2e024cd2015-02-11 09:58:46 -05002538 if (!drv->create_opts) {
2539 error_report("Format driver '%s' does not support image creation",
2540 drv->format_name);
2541 ret = -1;
2542 goto out;
2543 }
Max Reitzf75613c2014-12-02 18:32:46 +01002544
Max Reitz2e024cd2015-02-11 09:58:46 -05002545 if (!proto_drv->create_opts) {
2546 error_report("Protocol driver '%s' does not support image creation",
2547 proto_drv->format_name);
2548 ret = -1;
2549 goto out;
2550 }
Max Reitzf75613c2014-12-02 18:32:46 +01002551
Max Reitz2e024cd2015-02-11 09:58:46 -05002552 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2553 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfdb08adf2009-06-04 15:39:38 +02002554
Max Reitz2e024cd2015-02-11 09:58:46 -05002555 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002556 if (options) {
Markus Armbruster235e59c2020-07-07 18:05:42 +02002557 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
Markus Armbruster97a2ca72015-03-14 10:23:15 +01002558 error_report_err(local_err);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002559 ret = -1;
2560 goto out;
2561 }
Max Reitz2e024cd2015-02-11 09:58:46 -05002562 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002563
Yi Lic075c422020-08-19 09:36:07 +08002564 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
2565 s.total_sectors * BDRV_SECTOR_SIZE, &error_abort);
Eric Blake1899bf42021-09-13 08:17:35 -05002566 ret = add_old_style_options(out_fmt, opts, out_baseimg, backing_fmt);
Max Reitz2e024cd2015-02-11 09:58:46 -05002567 if (ret < 0) {
2568 goto out;
2569 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002570 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002571
Kevin Wolfa18953f2010-10-14 15:46:04 +02002572 /* Get backing file name if -o backing_file was used */
Chunyan Liu83d05212014-06-05 17:20:51 +08002573 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
Kevin Wolfa18953f2010-10-14 15:46:04 +02002574 if (out_baseimg_param) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002575 out_baseimg = out_baseimg_param;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002576 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002577 s.target_has_backing = (bool) out_baseimg;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002578
David Edmondson168468f2020-02-05 11:02:48 +00002579 if (s.has_zero_init && s.target_has_backing) {
2580 error_report("Cannot use --target-is-zero when the destination "
2581 "image has a backing file");
2582 goto out;
2583 }
2584
Max Reitz48758a82017-04-26 15:46:48 +02002585 if (s.src_num > 1 && out_baseimg) {
2586 error_report("Having a backing file for the target makes no sense when "
2587 "concatenating multiple input images");
2588 ret = -1;
2589 goto out;
2590 }
2591
Eric Blaked9f059a2020-07-06 15:39:54 -05002592 if (out_baseimg_param) {
2593 if (!qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT)) {
Eric Blake497a30d2021-05-03 14:36:00 -07002594 error_report("Use of backing file requires explicit "
2595 "backing format");
2596 ret = -1;
2597 goto out;
Eric Blaked9f059a2020-07-06 15:39:54 -05002598 }
2599 }
2600
Kevin Wolfefa84d42009-05-18 16:42:12 +02002601 /* Check if compression is supported */
Peter Lieven9fd77f92017-04-21 11:11:55 +02002602 if (s.compressed) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002603 bool encryption =
2604 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002605 const char *encryptfmt =
2606 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
Chunyan Liu83d05212014-06-05 17:20:51 +08002607 const char *preallocation =
2608 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
Kevin Wolfefa84d42009-05-18 16:42:12 +02002609
Vladimir Sementsov-Ogievskiyac850bf2019-06-04 19:15:06 +03002610 if (drv && !block_driver_can_compress(drv)) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002611 error_report("Compression not supported for this file format");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002612 ret = -1;
2613 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002614 }
2615
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002616 if (encryption || encryptfmt) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002617 error_report("Compression and encryption not supported at "
2618 "the same time");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002619 ret = -1;
2620 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002621 }
Kevin Wolf41521fa2011-10-18 16:19:42 +02002622
Chunyan Liu83d05212014-06-05 17:20:51 +08002623 if (preallocation
2624 && strcmp(preallocation, "off"))
Kevin Wolf41521fa2011-10-18 16:19:42 +02002625 {
2626 error_report("Compression and preallocation not supported at "
2627 "the same time");
2628 ret = -1;
2629 goto out;
2630 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002631 }
2632
Eric Blake15e39ad2020-05-21 14:21:36 -05002633 /* Determine if bitmaps need copying */
2634 if (bitmaps) {
2635 if (s.src_num > 1) {
2636 error_report("Copying bitmaps only possible with single source");
2637 ret = -1;
2638 goto out;
2639 }
Eric Blake955171e2021-07-21 10:53:48 -05002640 ret = convert_check_bitmaps(blk_bs(s.src[0]), skip_broken);
Eric Blake74a43202021-07-09 10:39:50 -05002641 if (ret < 0) {
Eric Blake15e39ad2020-05-21 14:21:36 -05002642 goto out;
2643 }
2644 }
2645
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002646 /*
2647 * The later open call will need any decryption secrets, and
2648 * bdrv_create() will purge "opts", so extract them now before
2649 * they are lost.
2650 */
2651 if (!skip_create) {
2652 open_opts = qdict_new();
2653 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002654
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002655 /* Create the new image */
Chunyan Liuc282e1f2014-06-05 17:21:11 +08002656 ret = bdrv_create(drv, out_filename, opts, &local_err);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002657 if (ret < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002658 error_reportf_err(local_err, "%s: error while converting %s: ",
2659 out_filename, out_fmt);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002660 goto out;
bellardea2384d2004-08-01 21:59:26 +00002661 }
2662 }
ths3b46e622007-09-17 08:09:54 +00002663
Max Reitz4d7c4872019-07-24 19:12:29 +02002664 s.target_is_new = !skip_create;
2665
Peter Lieven9fd77f92017-04-21 11:11:55 +02002666 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
Kevin Wolfce099542016-03-15 13:01:04 +01002667 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002668 if (ret < 0) {
2669 error_report("Invalid cache option: %s", cache);
Markus Armbrusterbb9cd2e2014-05-28 11:17:07 +02002670 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002671 }
2672
Hanna Reitza1c62432021-08-19 12:12:00 +02002673 if (flags & BDRV_O_NOCACHE) {
2674 /*
2675 * If we open the target with O_DIRECT, it may be necessary to
2676 * extend its size to align to the physical sector size.
2677 */
2678 flags |= BDRV_O_RESIZE;
2679 }
2680
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002681 if (skip_create) {
2682 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002683 flags, writethrough, s.quiet, false);
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002684 } else {
2685 /* TODO ultimately we should allow --target-image-opts
2686 * to be used even when -n is not given.
2687 * That has to wait for bdrv_create to be improved
2688 * to allow filenames in option syntax
2689 */
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002690 s.target = img_open_file(out_filename, open_opts, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002691 flags, writethrough, s.quiet, false);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002692 open_opts = NULL; /* blk_new_open will have freed it */
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002693 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002694 if (!s.target) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002695 ret = -1;
2696 goto out;
2697 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002698 out_bs = blk_bs(s.target);
bellardea2384d2004-08-01 21:59:26 +00002699
Eric Blake15e39ad2020-05-21 14:21:36 -05002700 if (bitmaps && !bdrv_supports_persistent_dirty_bitmap(out_bs)) {
2701 error_report("Format driver '%s' does not support bitmaps",
2702 out_bs->drv->format_name);
2703 ret = -1;
2704 goto out;
2705 }
2706
Vladimir Sementsov-Ogievskiyac850bf2019-06-04 19:15:06 +03002707 if (s.compressed && !block_driver_can_compress(out_bs->drv)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002708 error_report("Compression not supported for this file format");
2709 ret = -1;
2710 goto out;
2711 }
2712
Eric Blake5def6b82016-06-23 16:37:19 -06002713 /* increase bufsectors from the default 4096 (2M) if opt_transfer
Peter Lieven6360ab22018-07-13 09:15:39 +02002714 * or discard_alignment of the out_bs is greater. Limit to
2715 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2716 s.buf_sectors = MIN(MAX_BUF_SECTORS,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002717 MAX(s.buf_sectors,
2718 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2719 out_bs->bl.pdiscard_alignment >>
2720 BDRV_SECTOR_BITS)));
Peter Lievenf2521c92013-11-27 11:07:06 +01002721
Peter Lieven8dcd3c92018-07-12 15:00:10 +02002722 /* try to align the write requests to the destination to avoid unnecessary
2723 * RMW cycles. */
2724 s.alignment = MAX(pow2floor(s.min_sparse),
2725 DIV_ROUND_UP(out_bs->bl.request_alignment,
2726 BDRV_SECTOR_SIZE));
2727 assert(is_power_of_2(s.alignment));
2728
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002729 if (skip_create) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002730 int64_t output_sectors = blk_nb_sectors(s.target);
Markus Armbruster43716fa2014-06-26 13:23:21 +02002731 if (output_sectors < 0) {
Gongleieec5eb42015-02-25 12:22:27 +08002732 error_report("unable to get output image length: %s",
Markus Armbruster43716fa2014-06-26 13:23:21 +02002733 strerror(-output_sectors));
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002734 ret = -1;
2735 goto out;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002736 } else if (output_sectors < s.total_sectors) {
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002737 error_report("output file is smaller than input file");
2738 ret = -1;
2739 goto out;
2740 }
2741 }
2742
Max Reitzc69291e2020-01-21 16:59:14 +01002743 if (s.target_has_backing && s.target_is_new) {
Max Reitz351c8ef2018-05-01 18:57:49 +02002744 /* Errors are treated as "backing length unknown" (which means
2745 * s.target_backing_sectors has to be negative, which it will
2746 * be automatically). The backing file length is used only
2747 * for optimizations, so such a case is not fatal. */
Max Reitz4a2061e2019-06-12 19:00:30 +02002748 s.target_backing_sectors =
2749 bdrv_nb_sectors(bdrv_backing_chain_next(out_bs));
Max Reitz351c8ef2018-05-01 18:57:49 +02002750 } else {
2751 s.target_backing_sectors = -1;
2752 }
2753
Peter Lieven24f833c2013-11-27 11:07:07 +01002754 ret = bdrv_get_info(out_bs, &bdi);
2755 if (ret < 0) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002756 if (s.compressed) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002757 error_report("could not get block driver info");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002758 goto out;
2759 }
Peter Lieven24f833c2013-11-27 11:07:07 +01002760 } else {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002761 s.compressed = s.compressed || bdi.needs_compressed_writes;
2762 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
Peter Lieven24f833c2013-11-27 11:07:07 +01002763 }
2764
Zhengui0c8c4892020-10-20 14:47:44 +00002765 if (rate_limit) {
2766 set_rate_limit(s.target, rate_limit);
2767 }
2768
Peter Lieven9fd77f92017-04-21 11:11:55 +02002769 ret = convert_do_copy(&s);
Eric Blake15e39ad2020-05-21 14:21:36 -05002770
2771 /* Now copy the bitmaps */
2772 if (bitmaps && ret == 0) {
Eric Blake955171e2021-07-21 10:53:48 -05002773 ret = convert_copy_bitmaps(blk_bs(s.src[0]), out_bs, skip_broken);
Eric Blake15e39ad2020-05-21 14:21:36 -05002774 }
2775
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002776out:
Peter Lieven13c28af2013-11-27 11:07:01 +01002777 if (!ret) {
2778 qemu_progress_print(100, 0);
2779 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002780 qemu_progress_end();
Chunyan Liu83d05212014-06-05 17:20:51 +08002781 qemu_opts_del(opts);
2782 qemu_opts_free(create_opts);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002783 qobject_unref(open_opts);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002784 blk_unref(s.target);
2785 if (s.src) {
2786 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2787 blk_unref(s.src[bs_i]);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002788 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002789 g_free(s.src);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002790 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002791 g_free(s.src_sectors);
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002792 g_free(s.src_alignment);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002793fail_getopt:
Tuguoyi6aec8302020-11-02 09:04:57 +00002794 qemu_opts_del(sn_opts);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002795 g_free(options);
2796
Peter Lieven9fd77f92017-04-21 11:11:55 +02002797 return !!ret;
bellardea2384d2004-08-01 21:59:26 +00002798}
2799
bellard57d1a2b2004-08-03 21:15:11 +00002800
bellardfaea38e2006-08-05 21:31:00 +00002801static void dump_snapshots(BlockDriverState *bs)
2802{
2803 QEMUSnapshotInfo *sn_tab, *sn;
2804 int nb_sns, i;
bellardfaea38e2006-08-05 21:31:00 +00002805
2806 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2807 if (nb_sns <= 0)
2808 return;
2809 printf("Snapshot list:\n");
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002810 bdrv_snapshot_dump(NULL);
Wenchao Xia5b917042013-05-25 11:09:45 +08002811 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002812 for(i = 0; i < nb_sns; i++) {
2813 sn = &sn_tab[i];
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002814 bdrv_snapshot_dump(sn);
Wenchao Xia5b917042013-05-25 11:09:45 +08002815 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002816 }
Anthony Liguori7267c092011-08-20 22:09:37 -05002817 g_free(sn_tab);
bellardfaea38e2006-08-05 21:31:00 +00002818}
2819
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002820static void dump_json_image_info_list(ImageInfoList *list)
2821{
Markus Armbrustereab3a462020-12-11 18:11:37 +01002822 GString *str;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002823 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002824 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002825
2826 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2827 visit_complete(v, &obj);
Markus Armbruster6589f452020-12-11 18:11:35 +01002828 str = qobject_to_json_pretty(obj, true);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002829 assert(str != NULL);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002830 printf("%s\n", str->str);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002831 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002832 visit_free(v);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002833 g_string_free(str, true);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002834}
2835
Benoît Canetc054b3f2012-09-05 13:09:02 +02002836static void dump_json_image_info(ImageInfo *info)
2837{
Markus Armbrustereab3a462020-12-11 18:11:37 +01002838 GString *str;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002839 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002840 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002841
2842 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2843 visit_complete(v, &obj);
Markus Armbruster6589f452020-12-11 18:11:35 +01002844 str = qobject_to_json_pretty(obj, true);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002845 assert(str != NULL);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002846 printf("%s\n", str->str);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002847 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002848 visit_free(v);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002849 g_string_free(str, true);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002850}
2851
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002852static void dump_human_image_info_list(ImageInfoList *list)
2853{
2854 ImageInfoList *elem;
2855 bool delim = false;
2856
2857 for (elem = list; elem; elem = elem->next) {
2858 if (delim) {
2859 printf("\n");
2860 }
2861 delim = true;
2862
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002863 bdrv_image_info_dump(elem->value);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002864 }
2865}
2866
2867static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2868{
2869 return strcmp(a, b) == 0;
2870}
2871
2872/**
2873 * Open an image file chain and return an ImageInfoList
2874 *
2875 * @filename: topmost image filename
2876 * @fmt: topmost image format (may be NULL to autodetect)
2877 * @chain: true - enumerate entire backing file chain
2878 * false - only topmost image file
2879 *
2880 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2881 * image file. If there was an error a message will have been printed to
2882 * stderr.
2883 */
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002884static ImageInfoList *collect_image_info_list(bool image_opts,
2885 const char *filename,
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002886 const char *fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002887 bool chain, bool force_share)
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002888{
2889 ImageInfoList *head = NULL;
Eric Blakec3033fd2021-01-13 16:10:12 -06002890 ImageInfoList **tail = &head;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002891 GHashTable *filenames;
Wenchao Xia43526ec2013-06-06 12:27:58 +08002892 Error *err = NULL;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002893
2894 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2895
2896 while (filename) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02002897 BlockBackend *blk;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002898 BlockDriverState *bs;
2899 ImageInfo *info;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002900
2901 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2902 error_report("Backing file '%s' creates an infinite loop.",
2903 filename);
2904 goto err;
2905 }
2906 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2907
Max Reitzefaa7c42016-03-16 19:54:38 +01002908 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002909 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2910 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002911 if (!blk) {
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002912 goto err;
2913 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002914 bs = blk_bs(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002915
Wenchao Xia43526ec2013-06-06 12:27:58 +08002916 bdrv_query_image_info(bs, &info, &err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002917 if (err) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01002918 error_report_err(err);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002919 blk_unref(blk);
Wenchao Xia43526ec2013-06-06 12:27:58 +08002920 goto err;
Wenchao Xiafb0ed452013-06-06 12:27:57 +08002921 }
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002922
Eric Blakec3033fd2021-01-13 16:10:12 -06002923 QAPI_LIST_APPEND(tail, info);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002924
Markus Armbruster26f54e92014-10-07 13:59:04 +02002925 blk_unref(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002926
Stefan Hajnoczi0da7d132019-12-05 13:46:46 +00002927 /* Clear parameters that only apply to the topmost image */
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002928 filename = fmt = NULL;
Stefan Hajnoczi0da7d132019-12-05 13:46:46 +00002929 image_opts = false;
2930
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002931 if (chain) {
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002932 if (info->full_backing_filename) {
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002933 filename = info->full_backing_filename;
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002934 } else if (info->backing_filename) {
John Snow92d617a2015-12-14 14:55:15 -05002935 error_report("Could not determine absolute backing filename,"
2936 " but backing filename '%s' present",
2937 info->backing_filename);
2938 goto err;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002939 }
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002940 if (info->backing_filename_format) {
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002941 fmt = info->backing_filename_format;
2942 }
2943 }
2944 }
2945 g_hash_table_destroy(filenames);
2946 return head;
2947
2948err:
2949 qapi_free_ImageInfoList(head);
2950 g_hash_table_destroy(filenames);
2951 return NULL;
2952}
2953
Benoît Canetc054b3f2012-09-05 13:09:02 +02002954static int img_info(int argc, char **argv)
2955{
2956 int c;
2957 OutputFormat output_format = OFORMAT_HUMAN;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002958 bool chain = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002959 const char *filename, *fmt, *output;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002960 ImageInfoList *list;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002961 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08002962 bool force_share = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002963
bellardea2384d2004-08-01 21:59:26 +00002964 fmt = NULL;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002965 output = NULL;
bellardea2384d2004-08-01 21:59:26 +00002966 for(;;) {
Benoît Canetc054b3f2012-09-05 13:09:02 +02002967 int option_index = 0;
2968 static const struct option long_options[] = {
2969 {"help", no_argument, 0, 'h'},
2970 {"format", required_argument, 0, 'f'},
2971 {"output", required_argument, 0, OPTION_OUTPUT},
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002972 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002973 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002974 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002975 {"force-share", no_argument, 0, 'U'},
Benoît Canetc054b3f2012-09-05 13:09:02 +02002976 {0, 0, 0, 0}
2977 };
Fam Zheng335e9932017-05-03 00:35:39 +08002978 c = getopt_long(argc, argv, ":f:hU",
Benoît Canetc054b3f2012-09-05 13:09:02 +02002979 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002980 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002981 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002982 }
bellardea2384d2004-08-01 21:59:26 +00002983 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002984 case ':':
2985 missing_argument(argv[optind - 1]);
2986 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002987 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002988 unrecognized_option(argv[optind - 1]);
2989 break;
bellardea2384d2004-08-01 21:59:26 +00002990 case 'h':
2991 help();
2992 break;
2993 case 'f':
2994 fmt = optarg;
2995 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002996 case 'U':
2997 force_share = true;
2998 break;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002999 case OPTION_OUTPUT:
3000 output = optarg;
3001 break;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003002 case OPTION_BACKING_CHAIN:
3003 chain = true;
3004 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003005 case OPTION_OBJECT:
3006 user_creatable_process_cmdline(optarg);
3007 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003008 case OPTION_IMAGE_OPTS:
3009 image_opts = true;
3010 break;
bellardea2384d2004-08-01 21:59:26 +00003011 }
3012 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02003013 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003014 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003015 }
bellardea2384d2004-08-01 21:59:26 +00003016 filename = argv[optind++];
3017
Benoît Canetc054b3f2012-09-05 13:09:02 +02003018 if (output && !strcmp(output, "json")) {
3019 output_format = OFORMAT_JSON;
3020 } else if (output && !strcmp(output, "human")) {
3021 output_format = OFORMAT_HUMAN;
3022 } else if (output) {
3023 error_report("--output must be used with human or json as argument.");
3024 return 1;
3025 }
3026
Fam Zheng335e9932017-05-03 00:35:39 +08003027 list = collect_image_info_list(image_opts, filename, fmt, chain,
3028 force_share);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003029 if (!list) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003030 return 1;
3031 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02003032
Benoît Canetc054b3f2012-09-05 13:09:02 +02003033 switch (output_format) {
3034 case OFORMAT_HUMAN:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003035 dump_human_image_info_list(list);
Benoît Canetc054b3f2012-09-05 13:09:02 +02003036 break;
3037 case OFORMAT_JSON:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003038 if (chain) {
3039 dump_json_image_info_list(list);
3040 } else {
3041 dump_json_image_info(list->value);
3042 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02003043 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003044 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02003045
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003046 qapi_free_ImageInfoList(list);
bellardea2384d2004-08-01 21:59:26 +00003047 return 0;
3048}
3049
Eric Blake30065d12019-03-26 13:40:43 -05003050static int dump_map_entry(OutputFormat output_format, MapEntry *e,
3051 MapEntry *next)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003052{
3053 switch (output_format) {
3054 case OFORMAT_HUMAN:
Fam Zheng16b0d552016-01-26 11:59:02 +08003055 if (e->data && !e->has_offset) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003056 error_report("File contains external, encrypted or compressed clusters.");
Eric Blake30065d12019-03-26 13:40:43 -05003057 return -1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003058 }
Fam Zheng16b0d552016-01-26 11:59:02 +08003059 if (e->data && !e->zero) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003060 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
Fam Zheng16b0d552016-01-26 11:59:02 +08003061 e->start, e->length,
3062 e->has_offset ? e->offset : 0,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003063 e->filename ?: "");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003064 }
3065 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
3066 * Modify the flags here to allow more coalescing.
3067 */
Fam Zheng16b0d552016-01-26 11:59:02 +08003068 if (next && (!next->data || next->zero)) {
3069 next->data = false;
3070 next->zero = true;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003071 }
3072 break;
3073 case OFORMAT_JSON:
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003074 printf("{ \"start\": %"PRId64", \"length\": %"PRId64","
Eric Blake8417e132021-07-01 14:06:55 -05003075 " \"depth\": %"PRId64", \"present\": %s, \"zero\": %s,"
3076 " \"data\": %s", e->start, e->length, e->depth,
3077 e->present ? "true" : "false",
Fam Zheng16b0d552016-01-26 11:59:02 +08003078 e->zero ? "true" : "false",
3079 e->data ? "true" : "false");
3080 if (e->has_offset) {
Paolo Bonzinic745bfb2013-09-11 18:47:52 +02003081 printf(", \"offset\": %"PRId64"", e->offset);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003082 }
3083 putchar('}');
3084
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003085 if (next) {
3086 puts(",");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003087 }
3088 break;
3089 }
Eric Blake30065d12019-03-26 13:40:43 -05003090 return 0;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003091}
3092
Eric Blake5e344dd2017-10-11 22:47:02 -05003093static int get_block_status(BlockDriverState *bs, int64_t offset,
3094 int64_t bytes, MapEntry *e)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003095{
Eric Blake237d78f2017-10-11 22:47:03 -05003096 int ret;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003097 int depth;
Fam Zheng67a0fd22016-01-26 11:58:48 +08003098 BlockDriverState *file;
John Snow28756452016-02-05 13:12:33 -05003099 bool has_offset;
Eric Blake237d78f2017-10-11 22:47:03 -05003100 int64_t map;
Max Reitzf30c66b2019-02-01 20:29:05 +01003101 char *filename = NULL;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003102
3103 /* As an optimization, we could cache the current range of unallocated
3104 * clusters in each file of the chain, and avoid querying the same
3105 * range repeatedly.
3106 */
3107
3108 depth = 0;
3109 for (;;) {
Max Reitz4a2061e2019-06-12 19:00:30 +02003110 bs = bdrv_skip_filters(bs);
Eric Blake237d78f2017-10-11 22:47:03 -05003111 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003112 if (ret < 0) {
3113 return ret;
3114 }
Eric Blake237d78f2017-10-11 22:47:03 -05003115 assert(bytes);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003116 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
3117 break;
3118 }
Max Reitz4a2061e2019-06-12 19:00:30 +02003119 bs = bdrv_cow_bs(bs);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003120 if (bs == NULL) {
3121 ret = 0;
3122 break;
3123 }
3124
3125 depth++;
3126 }
3127
John Snow28756452016-02-05 13:12:33 -05003128 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
3129
Max Reitzf30c66b2019-02-01 20:29:05 +01003130 if (file && has_offset) {
3131 bdrv_refresh_filename(file);
3132 filename = file->filename;
3133 }
3134
John Snow28756452016-02-05 13:12:33 -05003135 *e = (MapEntry) {
Eric Blake5e344dd2017-10-11 22:47:02 -05003136 .start = offset,
Eric Blake237d78f2017-10-11 22:47:03 -05003137 .length = bytes,
John Snow28756452016-02-05 13:12:33 -05003138 .data = !!(ret & BDRV_BLOCK_DATA),
3139 .zero = !!(ret & BDRV_BLOCK_ZERO),
Eric Blake237d78f2017-10-11 22:47:03 -05003140 .offset = map,
John Snow28756452016-02-05 13:12:33 -05003141 .has_offset = has_offset,
3142 .depth = depth,
Eric Blake8417e132021-07-01 14:06:55 -05003143 .present = !!(ret & BDRV_BLOCK_ALLOCATED),
Max Reitzf30c66b2019-02-01 20:29:05 +01003144 .filename = filename,
John Snow28756452016-02-05 13:12:33 -05003145 };
3146
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003147 return 0;
3148}
3149
Fam Zheng16b0d552016-01-26 11:59:02 +08003150static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
3151{
3152 if (curr->length == 0) {
3153 return false;
3154 }
3155 if (curr->zero != next->zero ||
3156 curr->data != next->data ||
3157 curr->depth != next->depth ||
Eric Blake8417e132021-07-01 14:06:55 -05003158 curr->present != next->present ||
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003159 !curr->filename != !next->filename ||
Fam Zheng16b0d552016-01-26 11:59:02 +08003160 curr->has_offset != next->has_offset) {
3161 return false;
3162 }
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003163 if (curr->filename && strcmp(curr->filename, next->filename)) {
Fam Zheng16b0d552016-01-26 11:59:02 +08003164 return false;
3165 }
3166 if (curr->has_offset && curr->offset + curr->length != next->offset) {
3167 return false;
3168 }
3169 return true;
3170}
3171
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003172static int img_map(int argc, char **argv)
3173{
3174 int c;
3175 OutputFormat output_format = OFORMAT_HUMAN;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003176 BlockBackend *blk;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003177 BlockDriverState *bs;
3178 const char *filename, *fmt, *output;
3179 int64_t length;
3180 MapEntry curr = { .length = 0 }, next;
3181 int ret = 0;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003182 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003183 bool force_share = false;
Eyal Moscovicic0469492020-05-13 16:36:29 +03003184 int64_t start_offset = 0;
3185 int64_t max_length = -1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003186
3187 fmt = NULL;
3188 output = NULL;
3189 for (;;) {
3190 int option_index = 0;
3191 static const struct option long_options[] = {
3192 {"help", no_argument, 0, 'h'},
3193 {"format", required_argument, 0, 'f'},
3194 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003195 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003196 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003197 {"force-share", no_argument, 0, 'U'},
Eyal Moscovicic0469492020-05-13 16:36:29 +03003198 {"start-offset", required_argument, 0, 's'},
3199 {"max-length", required_argument, 0, 'l'},
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003200 {0, 0, 0, 0}
3201 };
Eyal Moscovicic0469492020-05-13 16:36:29 +03003202 c = getopt_long(argc, argv, ":f:s:l:hU",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003203 long_options, &option_index);
3204 if (c == -1) {
3205 break;
3206 }
3207 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003208 case ':':
3209 missing_argument(argv[optind - 1]);
3210 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003211 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003212 unrecognized_option(argv[optind - 1]);
3213 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003214 case 'h':
3215 help();
3216 break;
3217 case 'f':
3218 fmt = optarg;
3219 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003220 case 'U':
3221 force_share = true;
3222 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003223 case OPTION_OUTPUT:
3224 output = optarg;
3225 break;
Eyal Moscovicic0469492020-05-13 16:36:29 +03003226 case 's':
3227 start_offset = cvtnum("start offset", optarg);
3228 if (start_offset < 0) {
3229 return 1;
3230 }
3231 break;
3232 case 'l':
3233 max_length = cvtnum("max length", optarg);
3234 if (max_length < 0) {
3235 return 1;
3236 }
3237 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003238 case OPTION_OBJECT:
3239 user_creatable_process_cmdline(optarg);
3240 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003241 case OPTION_IMAGE_OPTS:
3242 image_opts = true;
3243 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003244 }
3245 }
Fam Zhengac1307a2014-04-22 13:36:11 +08003246 if (optind != argc - 1) {
3247 error_exit("Expecting one image file name");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003248 }
Fam Zhengac1307a2014-04-22 13:36:11 +08003249 filename = argv[optind];
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003250
3251 if (output && !strcmp(output, "json")) {
3252 output_format = OFORMAT_JSON;
3253 } else if (output && !strcmp(output, "human")) {
3254 output_format = OFORMAT_HUMAN;
3255 } else if (output) {
3256 error_report("--output must be used with human or json as argument.");
3257 return 1;
3258 }
3259
Fam Zheng335e9932017-05-03 00:35:39 +08003260 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003261 if (!blk) {
3262 return 1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003263 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003264 bs = blk_bs(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003265
3266 if (output_format == OFORMAT_HUMAN) {
3267 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003268 } else if (output_format == OFORMAT_JSON) {
3269 putchar('[');
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003270 }
3271
Max Reitzf1d3cd72015-02-05 13:58:18 -05003272 length = blk_getlength(blk);
Eyal Moscovici8f282e82020-05-13 16:36:27 +03003273 if (length < 0) {
3274 error_report("Failed to get size for '%s'", filename);
3275 return 1;
3276 }
Eyal Moscovicic0469492020-05-13 16:36:29 +03003277 if (max_length != -1) {
3278 length = MIN(start_offset + max_length, length);
3279 }
Eyal Moscovici8f282e82020-05-13 16:36:27 +03003280
Eyal Moscovicic0469492020-05-13 16:36:29 +03003281 curr.start = start_offset;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003282 while (curr.start + curr.length < length) {
Eric Blake5e344dd2017-10-11 22:47:02 -05003283 int64_t offset = curr.start + curr.length;
Kevin Wolfd0ceea82020-07-07 16:46:29 +02003284 int64_t n = length - offset;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003285
Eric Blake5e344dd2017-10-11 22:47:02 -05003286 ret = get_block_status(bs, offset, n, &next);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003287 if (ret < 0) {
3288 error_report("Could not read file metadata: %s", strerror(-ret));
3289 goto out;
3290 }
3291
Fam Zheng16b0d552016-01-26 11:59:02 +08003292 if (entry_mergeable(&curr, &next)) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003293 curr.length += next.length;
3294 continue;
3295 }
3296
3297 if (curr.length > 0) {
Eric Blake30065d12019-03-26 13:40:43 -05003298 ret = dump_map_entry(output_format, &curr, &next);
3299 if (ret < 0) {
3300 goto out;
3301 }
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003302 }
3303 curr = next;
3304 }
3305
Eric Blake30065d12019-03-26 13:40:43 -05003306 ret = dump_map_entry(output_format, &curr, NULL);
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003307 if (output_format == OFORMAT_JSON) {
3308 puts("]");
3309 }
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003310
3311out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003312 blk_unref(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003313 return ret < 0;
3314}
3315
aliguorif7b4a942009-01-07 17:40:15 +00003316#define SNAPSHOT_LIST 1
3317#define SNAPSHOT_CREATE 2
3318#define SNAPSHOT_APPLY 3
3319#define SNAPSHOT_DELETE 4
3320
Stuart Brady153859b2009-06-07 00:42:17 +01003321static int img_snapshot(int argc, char **argv)
aliguorif7b4a942009-01-07 17:40:15 +00003322{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003323 BlockBackend *blk;
aliguorif7b4a942009-01-07 17:40:15 +00003324 BlockDriverState *bs;
3325 QEMUSnapshotInfo sn;
3326 char *filename, *snapshot_name = NULL;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003327 int c, ret = 0, bdrv_oflags;
aliguorif7b4a942009-01-07 17:40:15 +00003328 int action = 0;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003329 bool quiet = false;
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003330 Error *err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003331 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003332 bool force_share = false;
Marc-André Lureauf793dde2022-03-07 11:04:00 +04003333 int64_t rt;
aliguorif7b4a942009-01-07 17:40:15 +00003334
Kevin Wolfce099542016-03-15 13:01:04 +01003335 bdrv_oflags = BDRV_O_RDWR;
aliguorif7b4a942009-01-07 17:40:15 +00003336 /* Parse commandline parameters */
3337 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003338 static const struct option long_options[] = {
3339 {"help", no_argument, 0, 'h'},
3340 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003341 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003342 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003343 {0, 0, 0, 0}
3344 };
Fam Zheng335e9932017-05-03 00:35:39 +08003345 c = getopt_long(argc, argv, ":la:c:d:hqU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003346 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003347 if (c == -1) {
aliguorif7b4a942009-01-07 17:40:15 +00003348 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003349 }
aliguorif7b4a942009-01-07 17:40:15 +00003350 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003351 case ':':
3352 missing_argument(argv[optind - 1]);
3353 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003354 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003355 unrecognized_option(argv[optind - 1]);
3356 break;
aliguorif7b4a942009-01-07 17:40:15 +00003357 case 'h':
3358 help();
Stuart Brady153859b2009-06-07 00:42:17 +01003359 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003360 case 'l':
3361 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003362 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003363 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003364 }
3365 action = SNAPSHOT_LIST;
Naphtali Spreif5edb012010-01-17 16:48:13 +02003366 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
aliguorif7b4a942009-01-07 17:40:15 +00003367 break;
3368 case 'a':
3369 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003370 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003371 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003372 }
3373 action = SNAPSHOT_APPLY;
3374 snapshot_name = optarg;
3375 break;
3376 case 'c':
3377 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003378 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003379 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003380 }
3381 action = SNAPSHOT_CREATE;
3382 snapshot_name = optarg;
3383 break;
3384 case 'd':
3385 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003386 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003387 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003388 }
3389 action = SNAPSHOT_DELETE;
3390 snapshot_name = optarg;
3391 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003392 case 'q':
3393 quiet = true;
3394 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003395 case 'U':
3396 force_share = true;
3397 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003398 case OPTION_OBJECT:
3399 user_creatable_process_cmdline(optarg);
3400 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003401 case OPTION_IMAGE_OPTS:
3402 image_opts = true;
3403 break;
aliguorif7b4a942009-01-07 17:40:15 +00003404 }
3405 }
3406
Kevin Wolffc11eb22013-08-05 10:53:04 +02003407 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003408 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003409 }
aliguorif7b4a942009-01-07 17:40:15 +00003410 filename = argv[optind++];
3411
3412 /* Open the image */
Fam Zheng335e9932017-05-03 00:35:39 +08003413 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3414 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003415 if (!blk) {
3416 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003417 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003418 bs = blk_bs(blk);
aliguorif7b4a942009-01-07 17:40:15 +00003419
3420 /* Perform the requested action */
3421 switch(action) {
3422 case SNAPSHOT_LIST:
3423 dump_snapshots(bs);
3424 break;
3425
3426 case SNAPSHOT_CREATE:
3427 memset(&sn, 0, sizeof(sn));
3428 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3429
Marc-André Lureauf793dde2022-03-07 11:04:00 +04003430 rt = g_get_real_time();
3431 sn.date_sec = rt / G_USEC_PER_SEC;
3432 sn.date_nsec = (rt % G_USEC_PER_SEC) * 1000;
aliguorif7b4a942009-01-07 17:40:15 +00003433
3434 ret = bdrv_snapshot_create(bs, &sn);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003435 if (ret) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003436 error_report("Could not create snapshot '%s': %d (%s)",
aliguorif7b4a942009-01-07 17:40:15 +00003437 snapshot_name, ret, strerror(-ret));
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003438 }
aliguorif7b4a942009-01-07 17:40:15 +00003439 break;
3440
3441 case SNAPSHOT_APPLY:
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003442 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003443 if (ret) {
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003444 error_reportf_err(err, "Could not apply snapshot '%s': ",
3445 snapshot_name);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003446 }
aliguorif7b4a942009-01-07 17:40:15 +00003447 break;
3448
3449 case SNAPSHOT_DELETE:
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003450 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3451 if (ret < 0) {
3452 error_report("Could not delete snapshot '%s': snapshot not "
3453 "found", snapshot_name);
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003454 ret = 1;
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003455 } else {
3456 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3457 if (ret < 0) {
3458 error_reportf_err(err, "Could not delete snapshot '%s': ",
3459 snapshot_name);
3460 ret = 1;
3461 }
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003462 }
aliguorif7b4a942009-01-07 17:40:15 +00003463 break;
3464 }
3465
3466 /* Cleanup */
Markus Armbruster26f54e92014-10-07 13:59:04 +02003467 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003468 if (ret) {
3469 return 1;
3470 }
Stuart Brady153859b2009-06-07 00:42:17 +01003471 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003472}
3473
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003474static int img_rebase(int argc, char **argv)
3475{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003476 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
Paolo Bonzini396374c2016-02-25 23:53:54 +01003477 uint8_t *buf_old = NULL;
3478 uint8_t *buf_new = NULL;
Sam Eiderman863cc782019-05-23 19:33:36 +03003479 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
Max Reitz4a2061e2019-06-12 19:00:30 +02003480 BlockDriverState *unfiltered_bs;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003481 char *filename;
Max Reitz40055952014-07-22 22:58:42 +02003482 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3483 int c, flags, src_flags, ret;
Kevin Wolfce099542016-03-15 13:01:04 +01003484 bool writethrough, src_writethrough;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003485 int unsafe = 0;
Fam Zheng335e9932017-05-03 00:35:39 +08003486 bool force_share = false;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003487 int progress = 0;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003488 bool quiet = false;
Max Reitz34b5d2c2013-09-05 14:45:29 +02003489 Error *local_err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003490 bool image_opts = false;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003491
3492 /* Parse commandline parameters */
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003493 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003494 cache = BDRV_DEFAULT_CACHE;
Max Reitz40055952014-07-22 22:58:42 +02003495 src_cache = BDRV_DEFAULT_CACHE;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003496 out_baseimg = NULL;
3497 out_basefmt = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003498 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003499 static const struct option long_options[] = {
3500 {"help", no_argument, 0, 'h'},
3501 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003502 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003503 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003504 {0, 0, 0, 0}
3505 };
Fam Zheng335e9932017-05-03 00:35:39 +08003506 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003507 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003508 if (c == -1) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003509 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003510 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003511 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003512 case ':':
3513 missing_argument(argv[optind - 1]);
3514 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003515 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003516 unrecognized_option(argv[optind - 1]);
3517 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003518 case 'h':
3519 help();
3520 return 0;
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003521 case 'f':
3522 fmt = optarg;
3523 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003524 case 'F':
3525 out_basefmt = optarg;
3526 break;
3527 case 'b':
3528 out_baseimg = optarg;
3529 break;
3530 case 'u':
3531 unsafe = 1;
3532 break;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003533 case 'p':
3534 progress = 1;
3535 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003536 case 't':
3537 cache = optarg;
3538 break;
Max Reitz40055952014-07-22 22:58:42 +02003539 case 'T':
3540 src_cache = optarg;
3541 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003542 case 'q':
3543 quiet = true;
3544 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003545 case OPTION_OBJECT:
3546 user_creatable_process_cmdline(optarg);
3547 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003548 case OPTION_IMAGE_OPTS:
3549 image_opts = true;
3550 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003551 case 'U':
3552 force_share = true;
3553 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003554 }
3555 }
3556
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003557 if (quiet) {
3558 progress = 0;
3559 }
3560
Fam Zhengac1307a2014-04-22 13:36:11 +08003561 if (optind != argc - 1) {
3562 error_exit("Expecting one image file name");
3563 }
3564 if (!unsafe && !out_baseimg) {
3565 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003566 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003567 filename = argv[optind++];
3568
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003569 qemu_progress_init(progress, 2.0);
3570 qemu_progress_print(0, 100);
3571
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003572 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
Kevin Wolfce099542016-03-15 13:01:04 +01003573 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003574 if (ret < 0) {
3575 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003576 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003577 }
3578
Kevin Wolfce099542016-03-15 13:01:04 +01003579 src_flags = 0;
3580 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
Max Reitz40055952014-07-22 22:58:42 +02003581 if (ret < 0) {
3582 error_report("Invalid source cache option: %s", src_cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003583 goto out;
Max Reitz40055952014-07-22 22:58:42 +02003584 }
3585
Kevin Wolfce099542016-03-15 13:01:04 +01003586 /* The source files are opened read-only, don't care about WCE */
3587 assert((src_flags & BDRV_O_RDWR) == 0);
3588 (void) src_writethrough;
3589
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003590 /*
3591 * Open the images.
3592 *
3593 * Ignore the old backing file for unsafe rebase in case we want to correct
3594 * the reference to a renamed or moved backing file.
3595 */
Fam Zheng335e9932017-05-03 00:35:39 +08003596 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3597 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003598 if (!blk) {
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003599 ret = -1;
3600 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003601 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003602 bs = blk_bs(blk);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003603
Max Reitz4a2061e2019-06-12 19:00:30 +02003604 unfiltered_bs = bdrv_skip_filters(bs);
3605
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003606 if (out_basefmt != NULL) {
Max Reitz644483d2015-02-05 13:58:17 -05003607 if (bdrv_find_format(out_basefmt) == NULL) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003608 error_report("Invalid format name: '%s'", out_basefmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003609 ret = -1;
3610 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003611 }
3612 }
3613
3614 /* For safe rebasing we need to compare old and new backing file */
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003615 if (!unsafe) {
Max Reitz644483d2015-02-05 13:58:17 -05003616 QDict *options = NULL;
Max Reitz4a2061e2019-06-12 19:00:30 +02003617 BlockDriverState *base_bs = bdrv_cow_bs(unfiltered_bs);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003618
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003619 if (base_bs) {
Kevin Wolfd861ab32019-04-25 14:25:10 +02003620 blk_old_backing = blk_new(qemu_get_aio_context(),
3621 BLK_PERM_CONSISTENT_READ,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003622 BLK_PERM_ALL);
3623 ret = blk_insert_bs(blk_old_backing, base_bs,
3624 &local_err);
3625 if (ret < 0) {
Max Reitz35ddd932019-05-09 19:52:35 +02003626 error_reportf_err(local_err,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003627 "Could not reuse old backing file '%s': ",
3628 base_bs->filename);
Max Reitz35ddd932019-05-09 19:52:35 +02003629 goto out;
3630 }
3631 } else {
3632 blk_old_backing = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003633 }
Max Reitz644483d2015-02-05 13:58:17 -05003634
Alex Bligha6166732012-10-16 13:46:18 +01003635 if (out_baseimg[0]) {
Max Reitzd16699b2018-05-09 20:20:01 +02003636 const char *overlay_filename;
3637 char *out_real_path;
3638
Fam Zheng335e9932017-05-03 00:35:39 +08003639 options = qdict_new();
Max Reitz644483d2015-02-05 13:58:17 -05003640 if (out_basefmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003641 qdict_put_str(options, "driver", out_basefmt);
Fam Zheng335e9932017-05-03 00:35:39 +08003642 }
3643 if (force_share) {
3644 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Max Reitz644483d2015-02-05 13:58:17 -05003645 }
3646
Max Reitzf30c66b2019-02-01 20:29:05 +01003647 bdrv_refresh_filename(bs);
Max Reitzd16699b2018-05-09 20:20:01 +02003648 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3649 : bs->filename;
Max Reitz645ae7d2019-02-01 20:29:14 +01003650 out_real_path =
3651 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3652 out_baseimg,
3653 &local_err);
Max Reitzd16699b2018-05-09 20:20:01 +02003654 if (local_err) {
Max Reitzf22356d2019-05-28 21:53:38 +02003655 qobject_unref(options);
Max Reitzd16699b2018-05-09 20:20:01 +02003656 error_reportf_err(local_err,
3657 "Could not resolve backing filename: ");
3658 ret = -1;
Max Reitzd16699b2018-05-09 20:20:01 +02003659 goto out;
3660 }
3661
Sam Eiderman863cc782019-05-23 19:33:36 +03003662 /*
3663 * Find out whether we rebase an image on top of a previous image
3664 * in its chain.
3665 */
3666 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
Sam Eiderman330c7292019-05-23 19:33:37 +03003667 if (prefix_chain_bs) {
Max Reitzf22356d2019-05-28 21:53:38 +02003668 qobject_unref(options);
Sam Eiderman330c7292019-05-23 19:33:37 +03003669 g_free(out_real_path);
Max Reitzf22356d2019-05-28 21:53:38 +02003670
Kevin Wolfd861ab32019-04-25 14:25:10 +02003671 blk_new_backing = blk_new(qemu_get_aio_context(),
3672 BLK_PERM_CONSISTENT_READ,
Sam Eiderman330c7292019-05-23 19:33:37 +03003673 BLK_PERM_ALL);
3674 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
3675 &local_err);
3676 if (ret < 0) {
3677 error_reportf_err(local_err,
3678 "Could not reuse backing file '%s': ",
3679 out_baseimg);
3680 goto out;
3681 }
3682 } else {
3683 blk_new_backing = blk_new_open(out_real_path, NULL,
3684 options, src_flags, &local_err);
3685 g_free(out_real_path);
3686 if (!blk_new_backing) {
3687 error_reportf_err(local_err,
3688 "Could not open new backing file '%s': ",
3689 out_baseimg);
3690 ret = -1;
3691 goto out;
3692 }
Alex Bligha6166732012-10-16 13:46:18 +01003693 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003694 }
3695 }
3696
3697 /*
3698 * Check each unallocated cluster in the COW file. If it is unallocated,
3699 * accesses go to the backing file. We must therefore compare this cluster
3700 * in the old and new backing file, and if they differ we need to copy it
3701 * from the old backing file into the COW file.
3702 *
3703 * If qemu-img crashes during this step, no harm is done. The content of
3704 * the image is the same as the original one at any time.
3705 */
3706 if (!unsafe) {
Eric Blake41536282017-10-11 22:47:15 -05003707 int64_t size;
Max Reitz35ddd932019-05-09 19:52:35 +02003708 int64_t old_backing_size = 0;
Eric Blake41536282017-10-11 22:47:15 -05003709 int64_t new_backing_size = 0;
3710 uint64_t offset;
3711 int64_t n;
Kevin Wolf1f710492012-10-12 14:29:18 +02003712 float local_progress = 0;
TeLeMand6771bf2010-02-08 16:20:00 +08003713
Max Reitzf1d3cd72015-02-05 13:58:18 -05003714 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3715 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003716
Eric Blake41536282017-10-11 22:47:15 -05003717 size = blk_getlength(blk);
3718 if (size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003719 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003720 filename, strerror(-size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003721 ret = -1;
3722 goto out;
3723 }
Max Reitz35ddd932019-05-09 19:52:35 +02003724 if (blk_old_backing) {
3725 old_backing_size = blk_getlength(blk_old_backing);
3726 if (old_backing_size < 0) {
3727 char backing_name[PATH_MAX];
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003728
Max Reitz35ddd932019-05-09 19:52:35 +02003729 bdrv_get_backing_filename(bs, backing_name,
3730 sizeof(backing_name));
3731 error_report("Could not get size of '%s': %s",
3732 backing_name, strerror(-old_backing_size));
3733 ret = -1;
3734 goto out;
3735 }
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003736 }
Max Reitzf1d3cd72015-02-05 13:58:18 -05003737 if (blk_new_backing) {
Eric Blake41536282017-10-11 22:47:15 -05003738 new_backing_size = blk_getlength(blk_new_backing);
3739 if (new_backing_size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003740 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003741 out_baseimg, strerror(-new_backing_size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003742 ret = -1;
3743 goto out;
3744 }
Alex Bligha6166732012-10-16 13:46:18 +01003745 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003746
Eric Blake41536282017-10-11 22:47:15 -05003747 if (size != 0) {
3748 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
Kevin Wolf1f710492012-10-12 14:29:18 +02003749 }
3750
Eric Blake41536282017-10-11 22:47:15 -05003751 for (offset = 0; offset < size; offset += n) {
Max Reitz1c6e8772019-05-09 19:52:36 +02003752 bool buf_old_is_zero = false;
3753
Eric Blake41536282017-10-11 22:47:15 -05003754 /* How many bytes can we handle with the next read? */
3755 n = MIN(IO_BUF_SIZE, size - offset);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003756
3757 /* If the cluster is allocated, we don't need to take action */
Max Reitz4a2061e2019-06-12 19:00:30 +02003758 ret = bdrv_is_allocated(unfiltered_bs, offset, n, &n);
Paolo Bonzinid6636402013-09-04 19:00:25 +02003759 if (ret < 0) {
3760 error_report("error while reading image metadata: %s",
3761 strerror(-ret));
3762 goto out;
3763 }
Kevin Wolfcc60e322010-04-29 14:47:48 +02003764 if (ret) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003765 continue;
3766 }
3767
Sam Eiderman863cc782019-05-23 19:33:36 +03003768 if (prefix_chain_bs) {
3769 /*
3770 * If cluster wasn't changed since prefix_chain, we don't need
3771 * to take action
3772 */
Max Reitz4a2061e2019-06-12 19:00:30 +02003773 ret = bdrv_is_allocated_above(bdrv_cow_bs(unfiltered_bs),
3774 prefix_chain_bs, false,
3775 offset, n, &n);
Sam Eiderman863cc782019-05-23 19:33:36 +03003776 if (ret < 0) {
3777 error_report("error while reading image metadata: %s",
3778 strerror(-ret));
3779 goto out;
3780 }
3781 if (!ret) {
3782 continue;
3783 }
3784 }
3785
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003786 /*
3787 * Read old and new backing file and take into consideration that
3788 * backing files may be smaller than the COW image.
3789 */
Eric Blake41536282017-10-11 22:47:15 -05003790 if (offset >= old_backing_size) {
3791 memset(buf_old, 0, n);
Max Reitz1c6e8772019-05-09 19:52:36 +02003792 buf_old_is_zero = true;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003793 } else {
Eric Blake41536282017-10-11 22:47:15 -05003794 if (offset + n > old_backing_size) {
3795 n = old_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003796 }
3797
Alberto Fariaa9262f52022-07-05 17:15:11 +01003798 ret = blk_pread(blk_old_backing, offset, n, buf_old, 0);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003799 if (ret < 0) {
3800 error_report("error while reading from old backing file");
3801 goto out;
3802 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003803 }
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003804
Eric Blake41536282017-10-11 22:47:15 -05003805 if (offset >= new_backing_size || !blk_new_backing) {
3806 memset(buf_new, 0, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003807 } else {
Eric Blake41536282017-10-11 22:47:15 -05003808 if (offset + n > new_backing_size) {
3809 n = new_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003810 }
3811
Alberto Fariaa9262f52022-07-05 17:15:11 +01003812 ret = blk_pread(blk_new_backing, offset, n, buf_new, 0);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003813 if (ret < 0) {
3814 error_report("error while reading from new backing file");
3815 goto out;
3816 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003817 }
3818
3819 /* If they differ, we need to write to the COW file */
3820 uint64_t written = 0;
3821
Eric Blake41536282017-10-11 22:47:15 -05003822 while (written < n) {
Eric Blakedc61cd32017-10-11 22:47:14 -05003823 int64_t pnum;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003824
Eric Blake41536282017-10-11 22:47:15 -05003825 if (compare_buffers(buf_old + written, buf_new + written,
3826 n - written, &pnum))
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003827 {
Max Reitz1c6e8772019-05-09 19:52:36 +02003828 if (buf_old_is_zero) {
3829 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0);
3830 } else {
Alberto Fariaa9262f52022-07-05 17:15:11 +01003831 ret = blk_pwrite(blk, offset + written, pnum,
3832 buf_old + written, 0);
Max Reitz1c6e8772019-05-09 19:52:36 +02003833 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003834 if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003835 error_report("Error while writing to COW image: %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003836 strerror(-ret));
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003837 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003838 }
3839 }
3840
3841 written += pnum;
3842 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003843 qemu_progress_print(local_progress, 100);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003844 }
3845 }
3846
3847 /*
3848 * Change the backing file. All clusters that are different from the old
3849 * backing file are overwritten in the COW file now, so the visible content
3850 * doesn't change when we switch the backing file.
3851 */
Alex Bligha6166732012-10-16 13:46:18 +01003852 if (out_baseimg && *out_baseimg) {
Max Reitz4a2061e2019-06-12 19:00:30 +02003853 ret = bdrv_change_backing_file(unfiltered_bs, out_baseimg, out_basefmt,
3854 true);
Alex Bligha6166732012-10-16 13:46:18 +01003855 } else {
Max Reitz4a2061e2019-06-12 19:00:30 +02003856 ret = bdrv_change_backing_file(unfiltered_bs, NULL, NULL, false);
Alex Bligha6166732012-10-16 13:46:18 +01003857 }
3858
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003859 if (ret == -ENOSPC) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003860 error_report("Could not change the backing file to '%s': No "
3861 "space left in the file header", out_baseimg);
Eric Blakea7cd44b2021-07-08 10:52:28 -05003862 } else if (ret == -EINVAL && out_baseimg && !out_basefmt) {
3863 error_report("Could not change the backing file to '%s': backing "
3864 "format must be specified", out_baseimg);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003865 } else if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003866 error_report("Could not change the backing file to '%s': %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003867 out_baseimg, strerror(-ret));
3868 }
3869
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003870 qemu_progress_print(100, 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003871 /*
3872 * TODO At this point it is possible to check if any clusters that are
3873 * allocated in the COW file are the same in the backing file. If so, they
3874 * could be dropped from the COW file. Don't do this before switching the
3875 * backing file, in case of a crash this would lead to corruption.
3876 */
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003877out:
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003878 qemu_progress_end();
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003879 /* Cleanup */
3880 if (!unsafe) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02003881 blk_unref(blk_old_backing);
Markus Armbruster26f54e92014-10-07 13:59:04 +02003882 blk_unref(blk_new_backing);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003883 }
Paolo Bonzini396374c2016-02-25 23:53:54 +01003884 qemu_vfree(buf_old);
3885 qemu_vfree(buf_new);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003886
Markus Armbruster26f54e92014-10-07 13:59:04 +02003887 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003888 if (ret) {
3889 return 1;
3890 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003891 return 0;
3892}
3893
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003894static int img_resize(int argc, char **argv)
3895{
Markus Armbruster6750e792015-02-12 17:43:08 +01003896 Error *err = NULL;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003897 int c, ret, relative;
3898 const char *filename, *fmt, *size;
Max Reitz09c5c6d2019-09-18 11:51:44 +02003899 int64_t n, total_size, current_size;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003900 bool quiet = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003901 BlockBackend *blk = NULL;
Max Reitzdc5f6902017-06-13 22:20:55 +02003902 PreallocMode prealloc = PREALLOC_MODE_OFF;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003903 QemuOpts *param;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003904
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003905 static QemuOptsList resize_options = {
3906 .name = "resize_options",
3907 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3908 .desc = {
3909 {
3910 .name = BLOCK_OPT_SIZE,
3911 .type = QEMU_OPT_SIZE,
3912 .help = "Virtual disk size"
3913 }, {
3914 /* end of list */
3915 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003916 },
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003917 };
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003918 bool image_opts = false;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003919 bool shrink = false;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003920
Kevin Wolfe80fec72011-04-29 10:58:12 +02003921 /* Remove size from argv manually so that negative numbers are not treated
3922 * as options by getopt. */
3923 if (argc < 3) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003924 error_exit("Not enough arguments");
Kevin Wolfe80fec72011-04-29 10:58:12 +02003925 return 1;
3926 }
3927
3928 size = argv[--argc];
3929
3930 /* Parse getopt arguments */
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003931 fmt = NULL;
3932 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003933 static const struct option long_options[] = {
3934 {"help", no_argument, 0, 'h'},
3935 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003936 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Max Reitzdc5f6902017-06-13 22:20:55 +02003937 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003938 {"shrink", no_argument, 0, OPTION_SHRINK},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003939 {0, 0, 0, 0}
3940 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003941 c = getopt_long(argc, argv, ":f:hq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003942 long_options, NULL);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003943 if (c == -1) {
3944 break;
3945 }
3946 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003947 case ':':
3948 missing_argument(argv[optind - 1]);
3949 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003950 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003951 unrecognized_option(argv[optind - 1]);
3952 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003953 case 'h':
3954 help();
3955 break;
3956 case 'f':
3957 fmt = optarg;
3958 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003959 case 'q':
3960 quiet = true;
3961 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003962 case OPTION_OBJECT:
3963 user_creatable_process_cmdline(optarg);
3964 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003965 case OPTION_IMAGE_OPTS:
3966 image_opts = true;
3967 break;
Max Reitzdc5f6902017-06-13 22:20:55 +02003968 case OPTION_PREALLOCATION:
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02003969 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
Markus Armbruster06c60b62017-08-24 10:45:57 +02003970 PREALLOC_MODE__MAX, NULL);
Max Reitzdc5f6902017-06-13 22:20:55 +02003971 if (prealloc == PREALLOC_MODE__MAX) {
3972 error_report("Invalid preallocation mode '%s'", optarg);
3973 return 1;
3974 }
3975 break;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003976 case OPTION_SHRINK:
3977 shrink = true;
3978 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003979 }
3980 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02003981 if (optind != argc - 1) {
Max Reitzbe8fbd42018-02-05 17:27:45 +01003982 error_exit("Expecting image file name and size");
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003983 }
3984 filename = argv[optind++];
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003985
3986 /* Choose grow, shrink, or absolute resize mode */
3987 switch (size[0]) {
3988 case '+':
3989 relative = 1;
3990 size++;
3991 break;
3992 case '-':
3993 relative = -1;
3994 size++;
3995 break;
3996 default:
3997 relative = 0;
3998 break;
3999 }
4000
4001 /* Parse size */
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -08004002 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
Markus Armbruster235e59c2020-07-07 18:05:42 +02004003 if (!qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err)) {
Markus Armbruster6750e792015-02-12 17:43:08 +01004004 error_report_err(err);
Jes Sorensen2a819982010-12-06 17:08:31 +01004005 ret = -1;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08004006 qemu_opts_del(param);
Jes Sorensen2a819982010-12-06 17:08:31 +01004007 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004008 }
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08004009 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
4010 qemu_opts_del(param);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004011
Max Reitzefaa7c42016-03-16 19:54:38 +01004012 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08004013 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
4014 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004015 if (!blk) {
Jes Sorensen2a819982010-12-06 17:08:31 +01004016 ret = -1;
4017 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004018 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004019
Max Reitzdc5f6902017-06-13 22:20:55 +02004020 current_size = blk_getlength(blk);
4021 if (current_size < 0) {
4022 error_report("Failed to inquire current image length: %s",
4023 strerror(-current_size));
4024 ret = -1;
4025 goto out;
4026 }
4027
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004028 if (relative) {
Max Reitzdc5f6902017-06-13 22:20:55 +02004029 total_size = current_size + n * relative;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004030 } else {
4031 total_size = n;
4032 }
4033 if (total_size <= 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01004034 error_report("New image size must be positive");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004035 ret = -1;
4036 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004037 }
4038
Max Reitzdc5f6902017-06-13 22:20:55 +02004039 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
4040 error_report("Preallocation can only be used for growing images");
4041 ret = -1;
4042 goto out;
4043 }
4044
Pavel Butsykin4ffca892017-09-18 15:42:27 +03004045 if (total_size < current_size && !shrink) {
Kevin Wolf1c404d72020-07-10 14:17:17 +02004046 error_report("Use the --shrink option to perform a shrink operation.");
Pavel Butsykin4ffca892017-09-18 15:42:27 +03004047 warn_report("Shrinking an image will delete all data beyond the "
4048 "shrunken image's end. Before performing such an "
4049 "operation, make sure there is no important data there.");
Kevin Wolf1c404d72020-07-10 14:17:17 +02004050 ret = -1;
4051 goto out;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03004052 }
4053
Max Reitze8d04f92019-09-18 11:51:43 +02004054 /*
4055 * The user expects the image to have the desired size after
4056 * resizing, so pass @exact=true. It is of no use to report
4057 * success when the image has not actually been resized.
4058 */
Kevin Wolf8c6242b2020-04-24 14:54:41 +02004059 ret = blk_truncate(blk, total_size, true, prealloc, 0, &err);
Max Reitz09c5c6d2019-09-18 11:51:44 +02004060 if (!ret) {
4061 qprintf(quiet, "Image resized.\n");
4062 } else {
Max Reitzed3d2ec2017-03-28 22:51:27 +02004063 error_report_err(err);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004064 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004065out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02004066 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004067 if (ret) {
4068 return 1;
4069 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004070 return 0;
4071}
4072
Max Reitz76a3a342014-10-27 11:12:51 +01004073static void amend_status_cb(BlockDriverState *bs,
Max Reitz8b139762015-07-27 17:51:32 +02004074 int64_t offset, int64_t total_work_size,
4075 void *opaque)
Max Reitz76a3a342014-10-27 11:12:51 +01004076{
4077 qemu_progress_print(100.f * offset / total_work_size, 0);
4078}
4079
Max Reitz51641352018-05-09 23:00:20 +02004080static int print_amend_option_help(const char *format)
4081{
4082 BlockDriver *drv;
4083
4084 /* Find driver and parse its options */
4085 drv = bdrv_find_format(format);
4086 if (!drv) {
4087 error_report("Unknown file format '%s'", format);
4088 return 1;
4089 }
4090
4091 if (!drv->bdrv_amend_options) {
4092 error_report("Format driver '%s' does not support option amendment",
4093 format);
4094 return 1;
4095 }
4096
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004097 /* Every driver supporting amendment must have amend_opts */
4098 assert(drv->amend_opts);
Max Reitz51641352018-05-09 23:00:20 +02004099
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004100 printf("Amend options for '%s':\n", format);
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004101 qemu_opts_print_help(drv->amend_opts, false);
Max Reitz51641352018-05-09 23:00:20 +02004102 return 0;
4103}
4104
Max Reitz6f176b42013-09-03 10:09:50 +02004105static int img_amend(int argc, char **argv)
4106{
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01004107 Error *err = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02004108 int c, ret = 0;
4109 char *options = NULL;
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004110 QemuOptsList *amend_opts = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08004111 QemuOpts *opts = NULL;
Max Reitzbd39e6e2014-07-22 22:58:43 +02004112 const char *fmt = NULL, *filename, *cache;
4113 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01004114 bool writethrough;
Max Reitz76a3a342014-10-27 11:12:51 +01004115 bool quiet = false, progress = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02004116 BlockBackend *blk = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02004117 BlockDriverState *bs = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004118 bool image_opts = false;
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004119 bool force = false;
Max Reitz6f176b42013-09-03 10:09:50 +02004120
Max Reitzbd39e6e2014-07-22 22:58:43 +02004121 cache = BDRV_DEFAULT_CACHE;
Max Reitz6f176b42013-09-03 10:09:50 +02004122 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004123 static const struct option long_options[] = {
4124 {"help", no_argument, 0, 'h'},
4125 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004126 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004127 {"force", no_argument, 0, OPTION_FORCE},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004128 {0, 0, 0, 0}
4129 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004130 c = getopt_long(argc, argv, ":ho:f:t:pq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004131 long_options, NULL);
Max Reitz6f176b42013-09-03 10:09:50 +02004132 if (c == -1) {
4133 break;
4134 }
4135
4136 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004137 case ':':
4138 missing_argument(argv[optind - 1]);
4139 break;
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004140 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004141 unrecognized_option(argv[optind - 1]);
4142 break;
4143 case 'h':
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004144 help();
4145 break;
4146 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02004147 if (accumulate_options(&options, optarg) < 0) {
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004148 ret = -1;
4149 goto out_no_progress;
4150 }
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004151 break;
4152 case 'f':
4153 fmt = optarg;
4154 break;
4155 case 't':
4156 cache = optarg;
4157 break;
4158 case 'p':
4159 progress = true;
4160 break;
4161 case 'q':
4162 quiet = true;
4163 break;
4164 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01004165 user_creatable_process_cmdline(optarg);
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004166 break;
4167 case OPTION_IMAGE_OPTS:
4168 image_opts = true;
4169 break;
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004170 case OPTION_FORCE:
4171 force = true;
4172 break;
Max Reitz6f176b42013-09-03 10:09:50 +02004173 }
4174 }
4175
Max Reitz6f176b42013-09-03 10:09:50 +02004176 if (!options) {
Fam Zhengac1307a2014-04-22 13:36:11 +08004177 error_exit("Must specify options (-o)");
Max Reitz6f176b42013-09-03 10:09:50 +02004178 }
4179
Max Reitz76a3a342014-10-27 11:12:51 +01004180 if (quiet) {
4181 progress = false;
4182 }
4183 qemu_progress_init(progress, 1.0);
4184
Kevin Wolfa283cb62014-02-21 16:24:07 +01004185 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
4186 if (fmt && has_help_option(options)) {
4187 /* If a format is explicitly specified (and possibly no filename is
4188 * given), print option help here */
Max Reitz51641352018-05-09 23:00:20 +02004189 ret = print_amend_option_help(fmt);
Kevin Wolfa283cb62014-02-21 16:24:07 +01004190 goto out;
4191 }
4192
4193 if (optind != argc - 1) {
Max Reitzb2f27e42014-10-27 11:12:52 +01004194 error_report("Expecting one image file name");
4195 ret = -1;
4196 goto out;
Kevin Wolfa283cb62014-02-21 16:24:07 +01004197 }
Max Reitz6f176b42013-09-03 10:09:50 +02004198
Kevin Wolfce099542016-03-15 13:01:04 +01004199 flags = BDRV_O_RDWR;
4200 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitzbd39e6e2014-07-22 22:58:43 +02004201 if (ret < 0) {
4202 error_report("Invalid cache option: %s", cache);
4203 goto out;
4204 }
4205
Fam Zheng335e9932017-05-03 00:35:39 +08004206 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4207 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004208 if (!blk) {
Max Reitz6f176b42013-09-03 10:09:50 +02004209 ret = -1;
4210 goto out;
4211 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004212 bs = blk_bs(blk);
Max Reitz6f176b42013-09-03 10:09:50 +02004213
4214 fmt = bs->drv->format_name;
4215
Kevin Wolf626f84f2014-02-21 16:24:06 +01004216 if (has_help_option(options)) {
Kevin Wolfa283cb62014-02-21 16:24:07 +01004217 /* If the format was auto-detected, print option help here */
Max Reitz51641352018-05-09 23:00:20 +02004218 ret = print_amend_option_help(fmt);
Max Reitz6f176b42013-09-03 10:09:50 +02004219 goto out;
4220 }
4221
Max Reitz1f996682018-05-09 23:00:17 +02004222 if (!bs->drv->bdrv_amend_options) {
4223 error_report("Format driver '%s' does not support option amendment",
Max Reitzb2439d22014-12-02 18:32:47 +01004224 fmt);
4225 ret = -1;
4226 goto out;
4227 }
4228
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004229 /* Every driver supporting amendment must have amend_opts */
4230 assert(bs->drv->amend_opts);
Max Reitz1f996682018-05-09 23:00:17 +02004231
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004232 amend_opts = qemu_opts_append(amend_opts, bs->drv->amend_opts);
4233 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
Markus Armbruster235e59c2020-07-07 18:05:42 +02004234 if (!qemu_opts_do_parse(opts, options, NULL, &err)) {
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004235 /* Try to parse options using the create options */
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004236 amend_opts = qemu_opts_append(amend_opts, bs->drv->create_opts);
4237 qemu_opts_del(opts);
4238 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
Markus Armbruster9e194e02020-07-07 18:06:11 +02004239 if (qemu_opts_do_parse(opts, options, NULL, NULL)) {
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004240 error_append_hint(&err,
4241 "This option is only supported for image creation\n");
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004242 }
4243
Paolo Bonziniece90862017-01-04 15:56:24 +01004244 error_report_err(err);
4245 ret = -1;
4246 goto out;
Max Reitz6f176b42013-09-03 10:09:50 +02004247 }
4248
Max Reitz76a3a342014-10-27 11:12:51 +01004249 /* In case the driver does not call amend_status_cb() */
4250 qemu_progress_print(0.f, 0);
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004251 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, force, &err);
Max Reitz76a3a342014-10-27 11:12:51 +01004252 qemu_progress_print(100.f, 0);
Max Reitz6f176b42013-09-03 10:09:50 +02004253 if (ret < 0) {
Max Reitzd1402b52018-05-09 23:00:18 +02004254 error_report_err(err);
Max Reitz6f176b42013-09-03 10:09:50 +02004255 goto out;
4256 }
4257
4258out:
Max Reitz76a3a342014-10-27 11:12:51 +01004259 qemu_progress_end();
4260
Max Reitze814dff2015-08-20 16:00:38 -07004261out_no_progress:
Markus Armbruster26f54e92014-10-07 13:59:04 +02004262 blk_unref(blk);
Chunyan Liu83d05212014-06-05 17:20:51 +08004263 qemu_opts_del(opts);
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004264 qemu_opts_free(amend_opts);
Kevin Wolf626f84f2014-02-21 16:24:06 +01004265 g_free(options);
4266
Max Reitz6f176b42013-09-03 10:09:50 +02004267 if (ret) {
4268 return 1;
4269 }
4270 return 0;
4271}
4272
Kevin Wolfb6133b82014-08-05 14:17:13 +02004273typedef struct BenchData {
4274 BlockBackend *blk;
4275 uint64_t image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004276 bool write;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004277 int bufsize;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004278 int step;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004279 int nrreq;
4280 int n;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004281 int flush_interval;
4282 bool drain_on_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004283 uint8_t *buf;
4284 QEMUIOVector *qiov;
4285
4286 int in_flight;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004287 bool in_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004288 uint64_t offset;
4289} BenchData;
4290
Kevin Wolf55d539c2016-06-03 13:59:41 +02004291static void bench_undrained_flush_cb(void *opaque, int ret)
4292{
4293 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004294 error_report("Failed flush request: %s", strerror(-ret));
Kevin Wolf55d539c2016-06-03 13:59:41 +02004295 exit(EXIT_FAILURE);
4296 }
4297}
4298
Kevin Wolfb6133b82014-08-05 14:17:13 +02004299static void bench_cb(void *opaque, int ret)
4300{
4301 BenchData *b = opaque;
4302 BlockAIOCB *acb;
4303
4304 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004305 error_report("Failed request: %s", strerror(-ret));
Kevin Wolfb6133b82014-08-05 14:17:13 +02004306 exit(EXIT_FAILURE);
4307 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004308
4309 if (b->in_flush) {
4310 /* Just finished a flush with drained queue: Start next requests */
4311 assert(b->in_flight == 0);
4312 b->in_flush = false;
4313 } else if (b->in_flight > 0) {
4314 int remaining = b->n - b->in_flight;
4315
Kevin Wolfb6133b82014-08-05 14:17:13 +02004316 b->n--;
4317 b->in_flight--;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004318
4319 /* Time for flush? Drain queue if requested, then flush */
4320 if (b->flush_interval && remaining % b->flush_interval == 0) {
4321 if (!b->in_flight || !b->drain_on_flush) {
4322 BlockCompletionFunc *cb;
4323
4324 if (b->drain_on_flush) {
4325 b->in_flush = true;
4326 cb = bench_cb;
4327 } else {
4328 cb = bench_undrained_flush_cb;
4329 }
4330
4331 acb = blk_aio_flush(b->blk, cb, b);
4332 if (!acb) {
4333 error_report("Failed to issue flush request");
4334 exit(EXIT_FAILURE);
4335 }
4336 }
4337 if (b->drain_on_flush) {
4338 return;
4339 }
4340 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004341 }
4342
4343 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004344 int64_t offset = b->offset;
4345 /* blk_aio_* might look for completed I/Os and kick bench_cb
4346 * again, so make sure this operation is counted by in_flight
4347 * and b->offset is ready for the next submission.
4348 */
4349 b->in_flight++;
4350 b->offset += b->step;
4351 b->offset %= b->image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004352 if (b->write) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004353 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004354 } else {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004355 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004356 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004357 if (!acb) {
4358 error_report("Failed to issue request");
4359 exit(EXIT_FAILURE);
4360 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004361 }
4362}
4363
4364static int img_bench(int argc, char **argv)
4365{
4366 int c, ret = 0;
4367 const char *fmt = NULL, *filename;
4368 bool quiet = false;
4369 bool image_opts = false;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004370 bool is_write = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004371 int count = 75000;
4372 int depth = 64;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004373 int64_t offset = 0;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004374 size_t bufsize = 4096;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004375 int pattern = 0;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004376 size_t step = 0;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004377 int flush_interval = 0;
4378 bool drain_on_flush = true;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004379 int64_t image_size;
4380 BlockBackend *blk = NULL;
4381 BenchData data = {};
4382 int flags = 0;
Kevin Wolf604e8612016-06-14 11:29:32 +02004383 bool writethrough = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004384 struct timeval t1, t2;
4385 int i;
Fam Zheng335e9932017-05-03 00:35:39 +08004386 bool force_share = false;
Stefan Hajnoczi4f384012022-10-13 14:58:59 -04004387 size_t buf_size = 0;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004388
4389 for (;;) {
4390 static const struct option long_options[] = {
4391 {"help", no_argument, 0, 'h'},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004392 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004393 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004394 {"pattern", required_argument, 0, OPTION_PATTERN},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004395 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
Fam Zheng335e9932017-05-03 00:35:39 +08004396 {"force-share", no_argument, 0, 'U'},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004397 {0, 0, 0, 0}
4398 };
Aarushi Mehtacdd26772020-01-20 14:18:55 +00004399 c = getopt_long(argc, argv, ":hc:d:f:ni:o:qs:S:t:wU", long_options,
4400 NULL);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004401 if (c == -1) {
4402 break;
4403 }
4404
4405 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004406 case ':':
4407 missing_argument(argv[optind - 1]);
4408 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004409 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004410 unrecognized_option(argv[optind - 1]);
4411 break;
4412 case 'h':
Kevin Wolfb6133b82014-08-05 14:17:13 +02004413 help();
4414 break;
4415 case 'c':
4416 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004417 unsigned long res;
4418
4419 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004420 error_report("Invalid request count specified");
4421 return 1;
4422 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004423 count = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004424 break;
4425 }
4426 case 'd':
4427 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004428 unsigned long res;
4429
4430 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004431 error_report("Invalid queue depth specified");
4432 return 1;
4433 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004434 depth = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004435 break;
4436 }
4437 case 'f':
4438 fmt = optarg;
4439 break;
4440 case 'n':
4441 flags |= BDRV_O_NATIVE_AIO;
4442 break;
Aarushi Mehtacdd26772020-01-20 14:18:55 +00004443 case 'i':
4444 ret = bdrv_parse_aio(optarg, &flags);
4445 if (ret < 0) {
4446 error_report("Invalid aio option: %s", optarg);
4447 ret = -1;
4448 goto out;
4449 }
4450 break;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004451 case 'o':
4452 {
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004453 offset = cvtnum("offset", optarg);
Markus Armbruster606caa02017-02-21 21:14:04 +01004454 if (offset < 0) {
Kevin Wolfd3199a32015-07-10 18:09:18 +02004455 return 1;
4456 }
4457 break;
4458 }
4459 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004460 case 'q':
4461 quiet = true;
4462 break;
4463 case 's':
4464 {
4465 int64_t sval;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004466
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004467 sval = cvtnum_full("buffer size", optarg, 0, INT_MAX);
4468 if (sval < 0) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004469 return 1;
4470 }
4471
4472 bufsize = sval;
4473 break;
4474 }
Kevin Wolf83de9be2015-07-13 13:13:17 +02004475 case 'S':
4476 {
4477 int64_t sval;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004478
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004479 sval = cvtnum_full("step_size", optarg, 0, INT_MAX);
4480 if (sval < 0) {
Kevin Wolf83de9be2015-07-13 13:13:17 +02004481 return 1;
4482 }
4483
4484 step = sval;
4485 break;
4486 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004487 case 't':
4488 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4489 if (ret < 0) {
4490 error_report("Invalid cache mode");
4491 ret = -1;
4492 goto out;
4493 }
4494 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004495 case 'w':
4496 flags |= BDRV_O_RDWR;
4497 is_write = true;
4498 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004499 case 'U':
4500 force_share = true;
4501 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004502 case OPTION_PATTERN:
4503 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004504 unsigned long res;
4505
4506 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004507 error_report("Invalid pattern byte specified");
4508 return 1;
4509 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004510 pattern = res;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004511 break;
4512 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004513 case OPTION_FLUSH_INTERVAL:
4514 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004515 unsigned long res;
4516
4517 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004518 error_report("Invalid flush interval specified");
4519 return 1;
4520 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004521 flush_interval = res;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004522 break;
4523 }
4524 case OPTION_NO_DRAIN:
4525 drain_on_flush = false;
4526 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004527 case OPTION_IMAGE_OPTS:
4528 image_opts = true;
4529 break;
4530 }
4531 }
4532
4533 if (optind != argc - 1) {
4534 error_exit("Expecting one image file name");
4535 }
4536 filename = argv[argc - 1];
4537
Kevin Wolf55d539c2016-06-03 13:59:41 +02004538 if (!is_write && flush_interval) {
4539 error_report("--flush-interval is only available in write tests");
4540 ret = -1;
4541 goto out;
4542 }
4543 if (flush_interval && flush_interval < depth) {
4544 error_report("Flush interval can't be smaller than depth");
4545 ret = -1;
4546 goto out;
4547 }
4548
Fam Zheng335e9932017-05-03 00:35:39 +08004549 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4550 force_share);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004551 if (!blk) {
4552 ret = -1;
4553 goto out;
4554 }
4555
4556 image_size = blk_getlength(blk);
4557 if (image_size < 0) {
4558 ret = image_size;
4559 goto out;
4560 }
4561
4562 data = (BenchData) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004563 .blk = blk,
4564 .image_size = image_size,
4565 .bufsize = bufsize,
4566 .step = step ?: bufsize,
4567 .nrreq = depth,
4568 .n = count,
4569 .offset = offset,
4570 .write = is_write,
4571 .flush_interval = flush_interval,
4572 .drain_on_flush = drain_on_flush,
Kevin Wolfb6133b82014-08-05 14:17:13 +02004573 };
Kevin Wolfd3199a32015-07-10 18:09:18 +02004574 printf("Sending %d %s requests, %d bytes each, %d in parallel "
Kevin Wolf83de9be2015-07-13 13:13:17 +02004575 "(starting at offset %" PRId64 ", step size %d)\n",
Kevin Wolfd3199a32015-07-10 18:09:18 +02004576 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
Kevin Wolf83de9be2015-07-13 13:13:17 +02004577 data.offset, data.step);
Kevin Wolf55d539c2016-06-03 13:59:41 +02004578 if (flush_interval) {
4579 printf("Sending flush every %d requests\n", flush_interval);
4580 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004581
Fam Zheng79d46582018-01-16 14:08:58 +08004582 buf_size = data.nrreq * data.bufsize;
4583 data.buf = blk_blockalign(blk, buf_size);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004584 memset(data.buf, pattern, data.nrreq * data.bufsize);
4585
Stefan Hajnoczif4ec04b2022-10-13 14:59:02 -04004586 blk_register_buf(blk, data.buf, buf_size, &error_fatal);
Fam Zheng79d46582018-01-16 14:08:58 +08004587
Kevin Wolfb6133b82014-08-05 14:17:13 +02004588 data.qiov = g_new(QEMUIOVector, data.nrreq);
4589 for (i = 0; i < data.nrreq; i++) {
4590 qemu_iovec_init(&data.qiov[i], 1);
4591 qemu_iovec_add(&data.qiov[i],
4592 data.buf + i * data.bufsize, data.bufsize);
4593 }
4594
4595 gettimeofday(&t1, NULL);
4596 bench_cb(&data, 0);
4597
4598 while (data.n > 0) {
4599 main_loop_wait(false);
4600 }
4601 gettimeofday(&t2, NULL);
4602
4603 printf("Run completed in %3.3f seconds.\n",
4604 (t2.tv_sec - t1.tv_sec)
4605 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4606
4607out:
Fam Zheng79d46582018-01-16 14:08:58 +08004608 if (data.buf) {
Stefan Hajnoczi4f384012022-10-13 14:58:59 -04004609 blk_unregister_buf(blk, data.buf, buf_size);
Fam Zheng79d46582018-01-16 14:08:58 +08004610 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004611 qemu_vfree(data.buf);
4612 blk_unref(blk);
4613
4614 if (ret) {
4615 return 1;
4616 }
4617 return 0;
4618}
4619
Eric Blake3b51ab42020-05-12 20:16:45 -05004620enum ImgBitmapAct {
4621 BITMAP_ADD,
4622 BITMAP_REMOVE,
4623 BITMAP_CLEAR,
4624 BITMAP_ENABLE,
4625 BITMAP_DISABLE,
4626 BITMAP_MERGE,
4627};
4628typedef struct ImgBitmapAction {
4629 enum ImgBitmapAct act;
4630 const char *src; /* only used for merge */
4631 QSIMPLEQ_ENTRY(ImgBitmapAction) next;
4632} ImgBitmapAction;
4633
4634static int img_bitmap(int argc, char **argv)
4635{
4636 Error *err = NULL;
4637 int c, ret = 1;
4638 QemuOpts *opts = NULL;
4639 const char *fmt = NULL, *src_fmt = NULL, *src_filename = NULL;
4640 const char *filename, *bitmap;
4641 BlockBackend *blk = NULL, *src = NULL;
4642 BlockDriverState *bs = NULL, *src_bs = NULL;
4643 bool image_opts = false;
4644 int64_t granularity = 0;
4645 bool add = false, merge = false;
4646 QSIMPLEQ_HEAD(, ImgBitmapAction) actions;
4647 ImgBitmapAction *act, *act_next;
4648 const char *op;
Kevin Wolfc5e47712023-01-12 20:14:53 +01004649 int inactivate_ret;
Eric Blake3b51ab42020-05-12 20:16:45 -05004650
4651 QSIMPLEQ_INIT(&actions);
4652
4653 for (;;) {
4654 static const struct option long_options[] = {
4655 {"help", no_argument, 0, 'h'},
4656 {"object", required_argument, 0, OPTION_OBJECT},
4657 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4658 {"add", no_argument, 0, OPTION_ADD},
4659 {"remove", no_argument, 0, OPTION_REMOVE},
4660 {"clear", no_argument, 0, OPTION_CLEAR},
4661 {"enable", no_argument, 0, OPTION_ENABLE},
4662 {"disable", no_argument, 0, OPTION_DISABLE},
4663 {"merge", required_argument, 0, OPTION_MERGE},
4664 {"granularity", required_argument, 0, 'g'},
4665 {"source-file", required_argument, 0, 'b'},
4666 {"source-format", required_argument, 0, 'F'},
4667 {0, 0, 0, 0}
4668 };
4669 c = getopt_long(argc, argv, ":b:f:F:g:h", long_options, NULL);
4670 if (c == -1) {
4671 break;
4672 }
4673
4674 switch (c) {
4675 case ':':
4676 missing_argument(argv[optind - 1]);
4677 break;
4678 case '?':
4679 unrecognized_option(argv[optind - 1]);
4680 break;
4681 case 'h':
4682 help();
4683 break;
4684 case 'b':
4685 src_filename = optarg;
4686 break;
4687 case 'f':
4688 fmt = optarg;
4689 break;
4690 case 'F':
4691 src_fmt = optarg;
4692 break;
4693 case 'g':
4694 granularity = cvtnum("granularity", optarg);
4695 if (granularity < 0) {
4696 return 1;
4697 }
4698 break;
4699 case OPTION_ADD:
4700 act = g_new0(ImgBitmapAction, 1);
4701 act->act = BITMAP_ADD;
4702 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4703 add = true;
4704 break;
4705 case OPTION_REMOVE:
4706 act = g_new0(ImgBitmapAction, 1);
4707 act->act = BITMAP_REMOVE;
4708 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4709 break;
4710 case OPTION_CLEAR:
4711 act = g_new0(ImgBitmapAction, 1);
4712 act->act = BITMAP_CLEAR;
4713 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4714 break;
4715 case OPTION_ENABLE:
4716 act = g_new0(ImgBitmapAction, 1);
4717 act->act = BITMAP_ENABLE;
4718 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4719 break;
4720 case OPTION_DISABLE:
4721 act = g_new0(ImgBitmapAction, 1);
4722 act->act = BITMAP_DISABLE;
4723 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4724 break;
4725 case OPTION_MERGE:
4726 act = g_new0(ImgBitmapAction, 1);
4727 act->act = BITMAP_MERGE;
4728 act->src = optarg;
4729 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4730 merge = true;
4731 break;
4732 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01004733 user_creatable_process_cmdline(optarg);
Eric Blake3b51ab42020-05-12 20:16:45 -05004734 break;
4735 case OPTION_IMAGE_OPTS:
4736 image_opts = true;
4737 break;
4738 }
4739 }
4740
Eric Blake3b51ab42020-05-12 20:16:45 -05004741 if (QSIMPLEQ_EMPTY(&actions)) {
4742 error_report("Need at least one of --add, --remove, --clear, "
4743 "--enable, --disable, or --merge");
4744 goto out;
4745 }
4746
4747 if (granularity && !add) {
4748 error_report("granularity only supported with --add");
4749 goto out;
4750 }
4751 if (src_fmt && !src_filename) {
4752 error_report("-F only supported with -b");
4753 goto out;
4754 }
4755 if (src_filename && !merge) {
4756 error_report("Merge bitmap source file only supported with "
4757 "--merge");
4758 goto out;
4759 }
4760
4761 if (optind != argc - 2) {
4762 error_report("Expecting filename and bitmap name");
4763 goto out;
4764 }
4765
4766 filename = argv[optind];
4767 bitmap = argv[optind + 1];
4768
Eric Blake14f16bf2020-09-14 14:10:09 -05004769 /*
4770 * No need to open backing chains; we will be manipulating bitmaps
4771 * directly in this image without reference to image contents.
4772 */
4773 blk = img_open(image_opts, filename, fmt, BDRV_O_RDWR | BDRV_O_NO_BACKING,
4774 false, false, false);
Eric Blake3b51ab42020-05-12 20:16:45 -05004775 if (!blk) {
4776 goto out;
4777 }
4778 bs = blk_bs(blk);
4779 if (src_filename) {
Eric Blake14f16bf2020-09-14 14:10:09 -05004780 src = img_open(false, src_filename, src_fmt, BDRV_O_NO_BACKING,
4781 false, false, false);
Eric Blake3b51ab42020-05-12 20:16:45 -05004782 if (!src) {
4783 goto out;
4784 }
4785 src_bs = blk_bs(src);
4786 } else {
4787 src_bs = bs;
4788 }
4789
4790 QSIMPLEQ_FOREACH_SAFE(act, &actions, next, act_next) {
4791 switch (act->act) {
4792 case BITMAP_ADD:
4793 qmp_block_dirty_bitmap_add(bs->node_name, bitmap,
4794 !!granularity, granularity, true, true,
4795 false, false, &err);
4796 op = "add";
4797 break;
4798 case BITMAP_REMOVE:
4799 qmp_block_dirty_bitmap_remove(bs->node_name, bitmap, &err);
4800 op = "remove";
4801 break;
4802 case BITMAP_CLEAR:
4803 qmp_block_dirty_bitmap_clear(bs->node_name, bitmap, &err);
4804 op = "clear";
4805 break;
4806 case BITMAP_ENABLE:
4807 qmp_block_dirty_bitmap_enable(bs->node_name, bitmap, &err);
4808 op = "enable";
4809 break;
4810 case BITMAP_DISABLE:
4811 qmp_block_dirty_bitmap_disable(bs->node_name, bitmap, &err);
4812 op = "disable";
4813 break;
Eric Blake6c729dd2020-05-21 14:21:35 -05004814 case BITMAP_MERGE:
4815 do_dirty_bitmap_merge(bs->node_name, bitmap, src_bs->node_name,
4816 act->src, &err);
Eric Blake3b51ab42020-05-12 20:16:45 -05004817 op = "merge";
4818 break;
Eric Blake3b51ab42020-05-12 20:16:45 -05004819 default:
4820 g_assert_not_reached();
4821 }
4822
4823 if (err) {
4824 error_reportf_err(err, "Operation %s on bitmap %s failed: ",
4825 op, bitmap);
4826 goto out;
4827 }
4828 g_free(act);
4829 }
4830
4831 ret = 0;
4832
4833 out:
Kevin Wolfc5e47712023-01-12 20:14:53 +01004834 /*
4835 * Manually inactivate the images first because this way we can know whether
4836 * an error occurred. blk_unref() doesn't tell us about failures.
4837 */
4838 inactivate_ret = bdrv_inactivate_all();
4839 if (inactivate_ret < 0) {
4840 error_report("Error while closing the image: %s", strerror(-inactivate_ret));
4841 ret = 1;
4842 }
4843
Eric Blake3b51ab42020-05-12 20:16:45 -05004844 blk_unref(src);
4845 blk_unref(blk);
4846 qemu_opts_del(opts);
4847 return ret;
4848}
4849
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004850#define C_BS 01
4851#define C_COUNT 02
4852#define C_IF 04
4853#define C_OF 010
Reda Sallahif7c15532016-08-10 16:16:09 +02004854#define C_SKIP 020
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004855
4856struct DdInfo {
4857 unsigned int flags;
4858 int64_t count;
4859};
4860
4861struct DdIo {
4862 int bsz; /* Block size */
4863 char *filename;
4864 uint8_t *buf;
Reda Sallahif7c15532016-08-10 16:16:09 +02004865 int64_t offset;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004866};
4867
4868struct DdOpts {
4869 const char *name;
4870 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
4871 unsigned int flag;
4872};
4873
4874static int img_dd_bs(const char *arg,
4875 struct DdIo *in, struct DdIo *out,
4876 struct DdInfo *dd)
4877{
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004878 int64_t res;
4879
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004880 res = cvtnum_full("bs", arg, 1, INT_MAX);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004881
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004882 if (res < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004883 return 1;
4884 }
4885 in->bsz = out->bsz = res;
4886
4887 return 0;
4888}
4889
4890static int img_dd_count(const char *arg,
4891 struct DdIo *in, struct DdIo *out,
4892 struct DdInfo *dd)
4893{
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004894 dd->count = cvtnum("count", arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004895
Markus Armbruster606caa02017-02-21 21:14:04 +01004896 if (dd->count < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004897 return 1;
4898 }
4899
4900 return 0;
4901}
4902
4903static int img_dd_if(const char *arg,
4904 struct DdIo *in, struct DdIo *out,
4905 struct DdInfo *dd)
4906{
4907 in->filename = g_strdup(arg);
4908
4909 return 0;
4910}
4911
4912static int img_dd_of(const char *arg,
4913 struct DdIo *in, struct DdIo *out,
4914 struct DdInfo *dd)
4915{
4916 out->filename = g_strdup(arg);
4917
4918 return 0;
4919}
4920
Reda Sallahif7c15532016-08-10 16:16:09 +02004921static int img_dd_skip(const char *arg,
4922 struct DdIo *in, struct DdIo *out,
4923 struct DdInfo *dd)
4924{
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004925 in->offset = cvtnum("skip", arg);
Reda Sallahif7c15532016-08-10 16:16:09 +02004926
Markus Armbruster606caa02017-02-21 21:14:04 +01004927 if (in->offset < 0) {
Reda Sallahif7c15532016-08-10 16:16:09 +02004928 return 1;
4929 }
4930
4931 return 0;
4932}
4933
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004934static int img_dd(int argc, char **argv)
4935{
4936 int ret = 0;
4937 char *arg = NULL;
4938 char *tmp;
4939 BlockDriver *drv = NULL, *proto_drv = NULL;
4940 BlockBackend *blk1 = NULL, *blk2 = NULL;
4941 QemuOpts *opts = NULL;
4942 QemuOptsList *create_opts = NULL;
4943 Error *local_err = NULL;
4944 bool image_opts = false;
4945 int c, i;
4946 const char *out_fmt = "raw";
4947 const char *fmt = NULL;
4948 int64_t size = 0;
Miroslav Rezanina0f48c472022-11-09 10:57:13 -05004949 int64_t out_pos, in_pos;
Fam Zheng335e9932017-05-03 00:35:39 +08004950 bool force_share = false;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004951 struct DdInfo dd = {
4952 .flags = 0,
4953 .count = 0,
4954 };
4955 struct DdIo in = {
4956 .bsz = 512, /* Block size is by default 512 bytes */
4957 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004958 .buf = NULL,
4959 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004960 };
4961 struct DdIo out = {
4962 .bsz = 512,
4963 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004964 .buf = NULL,
4965 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004966 };
4967
4968 const struct DdOpts options[] = {
4969 { "bs", img_dd_bs, C_BS },
4970 { "count", img_dd_count, C_COUNT },
4971 { "if", img_dd_if, C_IF },
4972 { "of", img_dd_of, C_OF },
Reda Sallahif7c15532016-08-10 16:16:09 +02004973 { "skip", img_dd_skip, C_SKIP },
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004974 { NULL, NULL, 0 }
4975 };
4976 const struct option long_options[] = {
4977 { "help", no_argument, 0, 'h'},
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004978 { "object", required_argument, 0, OPTION_OBJECT},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004979 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08004980 { "force-share", no_argument, 0, 'U'},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004981 { 0, 0, 0, 0 }
4982 };
4983
Fam Zheng335e9932017-05-03 00:35:39 +08004984 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004985 if (c == EOF) {
4986 break;
4987 }
4988 switch (c) {
4989 case 'O':
4990 out_fmt = optarg;
4991 break;
4992 case 'f':
4993 fmt = optarg;
4994 break;
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004995 case ':':
4996 missing_argument(argv[optind - 1]);
4997 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004998 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004999 unrecognized_option(argv[optind - 1]);
5000 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005001 case 'h':
5002 help();
5003 break;
Fam Zheng335e9932017-05-03 00:35:39 +08005004 case 'U':
5005 force_share = true;
5006 break;
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01005007 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01005008 user_creatable_process_cmdline(optarg);
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01005009 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005010 case OPTION_IMAGE_OPTS:
5011 image_opts = true;
5012 break;
5013 }
5014 }
5015
5016 for (i = optind; i < argc; i++) {
5017 int j;
5018 arg = g_strdup(argv[i]);
5019
5020 tmp = strchr(arg, '=');
5021 if (tmp == NULL) {
5022 error_report("unrecognized operand %s", arg);
5023 ret = -1;
5024 goto out;
5025 }
5026
5027 *tmp++ = '\0';
5028
5029 for (j = 0; options[j].name != NULL; j++) {
5030 if (!strcmp(arg, options[j].name)) {
5031 break;
5032 }
5033 }
5034 if (options[j].name == NULL) {
5035 error_report("unrecognized operand %s", arg);
5036 ret = -1;
5037 goto out;
5038 }
5039
5040 if (options[j].f(tmp, &in, &out, &dd) != 0) {
5041 ret = -1;
5042 goto out;
5043 }
5044 dd.flags |= options[j].flag;
5045 g_free(arg);
5046 arg = NULL;
5047 }
5048
5049 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
5050 error_report("Must specify both input and output files");
5051 ret = -1;
5052 goto out;
5053 }
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01005054
Fam Zheng335e9932017-05-03 00:35:39 +08005055 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
5056 force_share);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005057
5058 if (!blk1) {
5059 ret = -1;
5060 goto out;
5061 }
5062
5063 drv = bdrv_find_format(out_fmt);
5064 if (!drv) {
5065 error_report("Unknown file format");
5066 ret = -1;
5067 goto out;
5068 }
5069 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
5070
5071 if (!proto_drv) {
5072 error_report_err(local_err);
5073 ret = -1;
5074 goto out;
5075 }
5076 if (!drv->create_opts) {
5077 error_report("Format driver '%s' does not support image creation",
5078 drv->format_name);
5079 ret = -1;
5080 goto out;
5081 }
5082 if (!proto_drv->create_opts) {
5083 error_report("Protocol driver '%s' does not support image creation",
5084 proto_drv->format_name);
5085 ret = -1;
5086 goto out;
5087 }
5088 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5089 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
5090
5091 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5092
5093 size = blk_getlength(blk1);
5094 if (size < 0) {
5095 error_report("Failed to get size for '%s'", in.filename);
5096 ret = -1;
5097 goto out;
5098 }
5099
5100 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
5101 dd.count * in.bsz < size) {
5102 size = dd.count * in.bsz;
5103 }
5104
Reda Sallahif7c15532016-08-10 16:16:09 +02005105 /* Overflow means the specified offset is beyond input image's size */
5106 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5107 size < in.bsz * in.offset)) {
5108 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
5109 } else {
5110 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
5111 size - in.bsz * in.offset, &error_abort);
5112 }
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005113
5114 ret = bdrv_create(drv, out.filename, opts, &local_err);
5115 if (ret < 0) {
5116 error_reportf_err(local_err,
5117 "%s: error while creating output image: ",
5118 out.filename);
5119 ret = -1;
5120 goto out;
5121 }
5122
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01005123 /* TODO, we can't honour --image-opts for the target,
5124 * since it needs to be given in a format compatible
5125 * with the bdrv_create() call above which does not
5126 * support image-opts style.
5127 */
Daniel P. Berrange29cf9332017-05-15 17:47:12 +01005128 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01005129 false, false, false);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005130
5131 if (!blk2) {
5132 ret = -1;
5133 goto out;
5134 }
5135
Reda Sallahif7c15532016-08-10 16:16:09 +02005136 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5137 size < in.offset * in.bsz)) {
5138 /* We give a warning if the skip option is bigger than the input
5139 * size and create an empty output disk image (i.e. like dd(1)).
5140 */
5141 error_report("%s: cannot skip to specified offset", in.filename);
5142 in_pos = size;
5143 } else {
5144 in_pos = in.offset * in.bsz;
5145 }
5146
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005147 in.buf = g_new(uint8_t, in.bsz);
5148
Miroslav Rezanina0f48c472022-11-09 10:57:13 -05005149 for (out_pos = 0; in_pos < size; ) {
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005150 int bytes = (in_pos + in.bsz > size) ? size - in_pos : in.bsz;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005151
Alberto Fariaa9262f52022-07-05 17:15:11 +01005152 ret = blk_pread(blk1, in_pos, bytes, in.buf, 0);
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005153 if (ret < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005154 error_report("error while reading from input image file: %s",
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005155 strerror(-ret));
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005156 goto out;
5157 }
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005158 in_pos += bytes;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005159
Alberto Fariaa9262f52022-07-05 17:15:11 +01005160 ret = blk_pwrite(blk2, out_pos, bytes, in.buf, 0);
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005161 if (ret < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005162 error_report("error while writing to output image file: %s",
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005163 strerror(-ret));
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005164 goto out;
5165 }
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005166 out_pos += bytes;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005167 }
5168
5169out:
5170 g_free(arg);
5171 qemu_opts_del(opts);
5172 qemu_opts_free(create_opts);
5173 blk_unref(blk1);
5174 blk_unref(blk2);
5175 g_free(in.filename);
5176 g_free(out.filename);
5177 g_free(in.buf);
5178 g_free(out.buf);
5179
5180 if (ret) {
5181 return 1;
5182 }
5183 return 0;
5184}
5185
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005186static void dump_json_block_measure_info(BlockMeasureInfo *info)
5187{
Markus Armbrustereab3a462020-12-11 18:11:37 +01005188 GString *str;
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005189 QObject *obj;
5190 Visitor *v = qobject_output_visitor_new(&obj);
5191
5192 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
5193 visit_complete(v, &obj);
Markus Armbruster6589f452020-12-11 18:11:35 +01005194 str = qobject_to_json_pretty(obj, true);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005195 assert(str != NULL);
Markus Armbrustereab3a462020-12-11 18:11:37 +01005196 printf("%s\n", str->str);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02005197 qobject_unref(obj);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005198 visit_free(v);
Markus Armbrustereab3a462020-12-11 18:11:37 +01005199 g_string_free(str, true);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005200}
5201
5202static int img_measure(int argc, char **argv)
5203{
5204 static const struct option long_options[] = {
5205 {"help", no_argument, 0, 'h'},
5206 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
5207 {"object", required_argument, 0, OPTION_OBJECT},
5208 {"output", required_argument, 0, OPTION_OUTPUT},
5209 {"size", required_argument, 0, OPTION_SIZE},
5210 {"force-share", no_argument, 0, 'U'},
5211 {0, 0, 0, 0}
5212 };
5213 OutputFormat output_format = OFORMAT_HUMAN;
5214 BlockBackend *in_blk = NULL;
5215 BlockDriver *drv;
5216 const char *filename = NULL;
5217 const char *fmt = NULL;
5218 const char *out_fmt = "raw";
5219 char *options = NULL;
5220 char *snapshot_name = NULL;
5221 bool force_share = false;
5222 QemuOpts *opts = NULL;
5223 QemuOpts *object_opts = NULL;
5224 QemuOpts *sn_opts = NULL;
5225 QemuOptsList *create_opts = NULL;
5226 bool image_opts = false;
5227 uint64_t img_size = UINT64_MAX;
5228 BlockMeasureInfo *info = NULL;
5229 Error *local_err = NULL;
5230 int ret = 1;
5231 int c;
5232
5233 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
5234 long_options, NULL)) != -1) {
5235 switch (c) {
5236 case '?':
5237 case 'h':
5238 help();
5239 break;
5240 case 'f':
5241 fmt = optarg;
5242 break;
5243 case 'O':
5244 out_fmt = optarg;
5245 break;
5246 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02005247 if (accumulate_options(&options, optarg) < 0) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005248 goto out;
5249 }
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005250 break;
5251 case 'l':
5252 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
5253 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
5254 optarg, false);
5255 if (!sn_opts) {
5256 error_report("Failed in parsing snapshot param '%s'",
5257 optarg);
5258 goto out;
5259 }
5260 } else {
5261 snapshot_name = optarg;
5262 }
5263 break;
5264 case 'U':
5265 force_share = true;
5266 break;
5267 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01005268 user_creatable_process_cmdline(optarg);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005269 break;
5270 case OPTION_IMAGE_OPTS:
5271 image_opts = true;
5272 break;
5273 case OPTION_OUTPUT:
5274 if (!strcmp(optarg, "json")) {
5275 output_format = OFORMAT_JSON;
5276 } else if (!strcmp(optarg, "human")) {
5277 output_format = OFORMAT_HUMAN;
5278 } else {
5279 error_report("--output must be used with human or json "
5280 "as argument.");
5281 goto out;
5282 }
5283 break;
5284 case OPTION_SIZE:
5285 {
5286 int64_t sval;
5287
Eyal Moscovici43d589b2020-05-13 16:36:26 +03005288 sval = cvtnum("image size", optarg);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005289 if (sval < 0) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005290 goto out;
5291 }
5292 img_size = (uint64_t)sval;
5293 }
5294 break;
5295 }
5296 }
5297
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005298 if (argc - optind > 1) {
5299 error_report("At most one filename argument is allowed.");
5300 goto out;
5301 } else if (argc - optind == 1) {
5302 filename = argv[optind];
5303 }
5304
Stefan Hajnoczic3673dc2020-02-21 11:25:21 +00005305 if (!filename && (image_opts || fmt || snapshot_name || sn_opts)) {
5306 error_report("--image-opts, -f, and -l require a filename argument.");
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005307 goto out;
5308 }
5309 if (filename && img_size != UINT64_MAX) {
5310 error_report("--size N cannot be used together with a filename.");
5311 goto out;
5312 }
5313 if (!filename && img_size == UINT64_MAX) {
5314 error_report("Either --size N or one filename must be specified.");
5315 goto out;
5316 }
5317
5318 if (filename) {
5319 in_blk = img_open(image_opts, filename, fmt, 0,
5320 false, false, force_share);
5321 if (!in_blk) {
5322 goto out;
5323 }
5324
5325 if (sn_opts) {
5326 bdrv_snapshot_load_tmp(blk_bs(in_blk),
5327 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
5328 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
5329 &local_err);
5330 } else if (snapshot_name != NULL) {
5331 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
5332 snapshot_name, &local_err);
5333 }
5334 if (local_err) {
5335 error_reportf_err(local_err, "Failed to load snapshot: ");
5336 goto out;
5337 }
5338 }
5339
5340 drv = bdrv_find_format(out_fmt);
5341 if (!drv) {
5342 error_report("Unknown file format '%s'", out_fmt);
5343 goto out;
5344 }
5345 if (!drv->create_opts) {
5346 error_report("Format driver '%s' does not support image creation",
5347 drv->format_name);
5348 goto out;
5349 }
5350
5351 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5352 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
5353 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5354 if (options) {
Markus Armbruster235e59c2020-07-07 18:05:42 +02005355 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005356 error_report_err(local_err);
5357 error_report("Invalid options for file format '%s'", out_fmt);
5358 goto out;
5359 }
5360 }
5361 if (img_size != UINT64_MAX) {
5362 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
5363 }
5364
5365 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
5366 if (local_err) {
5367 error_report_err(local_err);
5368 goto out;
5369 }
5370
5371 if (output_format == OFORMAT_HUMAN) {
5372 printf("required size: %" PRIu64 "\n", info->required);
5373 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
Eric Blake5d72c682020-05-21 14:21:34 -05005374 if (info->has_bitmaps) {
5375 printf("bitmaps size: %" PRIu64 "\n", info->bitmaps);
5376 }
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005377 } else {
5378 dump_json_block_measure_info(info);
5379 }
5380
5381 ret = 0;
5382
5383out:
5384 qapi_free_BlockMeasureInfo(info);
5385 qemu_opts_del(object_opts);
5386 qemu_opts_del(opts);
5387 qemu_opts_del(sn_opts);
5388 qemu_opts_free(create_opts);
5389 g_free(options);
5390 blk_unref(in_blk);
5391 return ret;
5392}
Kevin Wolfb6133b82014-08-05 14:17:13 +02005393
Anthony Liguoric227f092009-10-01 16:12:16 -05005394static const img_cmd_t img_cmds[] = {
Stuart Brady153859b2009-06-07 00:42:17 +01005395#define DEF(option, callback, arg_string) \
5396 { option, callback },
5397#include "qemu-img-cmds.h"
5398#undef DEF
Stuart Brady153859b2009-06-07 00:42:17 +01005399 { NULL, NULL, },
5400};
5401
bellardea2384d2004-08-01 21:59:26 +00005402int main(int argc, char **argv)
5403{
Anthony Liguoric227f092009-10-01 16:12:16 -05005404 const img_cmd_t *cmd;
Stuart Brady153859b2009-06-07 00:42:17 +01005405 const char *cmdname;
Jeff Cody7db16892014-04-25 17:02:32 -04005406 int c;
Jeff Cody7db16892014-04-25 17:02:32 -04005407 static const struct option long_options[] = {
5408 {"help", no_argument, 0, 'h'},
Denis V. Lunev10985132016-06-17 17:44:13 +03005409 {"version", no_argument, 0, 'V'},
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005410 {"trace", required_argument, NULL, 'T'},
Jeff Cody7db16892014-04-25 17:02:32 -04005411 {0, 0, 0, 0}
5412 };
bellardea2384d2004-08-01 21:59:26 +00005413
MORITA Kazutaka526eda12013-07-23 17:30:11 +09005414#ifdef CONFIG_POSIX
5415 signal(SIGPIPE, SIG_IGN);
5416#endif
5417
Daniel P. Berrangé98c5d2e2020-08-25 11:38:48 +01005418 socket_init();
Christophe Fergeauf5852ef2019-01-31 17:46:14 +01005419 error_init(argv[0]);
Daniel P. Berrangefe4db842016-10-04 14:35:52 +01005420 module_call_init(MODULE_INIT_TRACE);
Fam Zheng10f5bff2014-02-10 14:48:51 +08005421 qemu_init_exec_dir(argv[0]);
Kevin Wolf53f76e52010-12-16 15:10:32 +01005422
Markus Armbrusterf9734d52021-07-20 14:53:53 +02005423 qemu_init_main_loop(&error_fatal);
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005424
Eduardo Habkoste8f2d272016-05-12 11:10:04 -03005425 qcrypto_init(&error_fatal);
Daniel P. Berrangec2297082016-04-06 12:12:06 +01005426
Daniel P. Berrange064097d2016-02-10 18:41:01 +00005427 module_call_init(MODULE_INIT_QOM);
bellardea2384d2004-08-01 21:59:26 +00005428 bdrv_init();
Fam Zhengac1307a2014-04-22 13:36:11 +08005429 if (argc < 2) {
5430 error_exit("Not enough arguments");
5431 }
Stuart Brady153859b2009-06-07 00:42:17 +01005432
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00005433 qemu_add_opts(&qemu_source_opts);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005434 qemu_add_opts(&qemu_trace_opts);
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00005435
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005436 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
Denis V. Lunev10985132016-06-17 17:44:13 +03005437 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005438 case ':':
5439 missing_argument(argv[optind - 1]);
5440 return 0;
Stefan Hajnoczi4581c162017-03-17 18:45:39 +08005441 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005442 unrecognized_option(argv[optind - 1]);
5443 return 0;
5444 case 'h':
Denis V. Lunev10985132016-06-17 17:44:13 +03005445 help();
5446 return 0;
5447 case 'V':
5448 printf(QEMU_IMG_VERSION);
5449 return 0;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005450 case 'T':
Paolo Bonzini92eecff2020-11-02 06:58:41 -05005451 trace_opt_parse(optarg);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005452 break;
Stuart Brady153859b2009-06-07 00:42:17 +01005453 }
bellardea2384d2004-08-01 21:59:26 +00005454 }
Stuart Brady153859b2009-06-07 00:42:17 +01005455
Denis V. Lunev10985132016-06-17 17:44:13 +03005456 cmdname = argv[optind];
Jeff Cody7db16892014-04-25 17:02:32 -04005457
Denis V. Lunev10985132016-06-17 17:44:13 +03005458 /* reset getopt_long scanning */
5459 argc -= optind;
5460 if (argc < 1) {
Jeff Cody5f6979c2014-04-28 14:37:18 -04005461 return 0;
5462 }
Denis V. Lunev10985132016-06-17 17:44:13 +03005463 argv += optind;
Richard W.M. Jonesd339d762019-01-18 10:11:14 +00005464 qemu_reset_optind();
Denis V. Lunev10985132016-06-17 17:44:13 +03005465
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005466 if (!trace_init_backends()) {
5467 exit(1);
5468 }
Paolo Bonzini92eecff2020-11-02 06:58:41 -05005469 trace_init_file();
Richard Hendersonc5955f42022-04-17 11:29:44 -07005470 qemu_set_log(LOG_TRACE, &error_fatal);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005471
Denis V. Lunev10985132016-06-17 17:44:13 +03005472 /* find the command */
5473 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
5474 if (!strcmp(cmdname, cmd->name)) {
5475 return cmd->handler(argc, argv);
5476 }
5477 }
Jeff Cody7db16892014-04-25 17:02:32 -04005478
Stuart Brady153859b2009-06-07 00:42:17 +01005479 /* not found */
Fam Zhengac1307a2014-04-22 13:36:11 +08005480 error_exit("Command not found: %s", cmdname);
bellardea2384d2004-08-01 21:59:26 +00005481}