blob: 7668f86769feed4a9fc6b663de1b4ac7f5bd6d22 [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/*
Philippe Mathieu-Daudé46bb9442023-10-04 14:00:09 +0200238 * Is @list safe for accumulate_options()?
Markus Armbruster80c710c2020-04-15 09:49:26 +0200239 * It is when multiple of them can be joined together separated by ','.
Philippe Mathieu-Daudé46bb9442023-10-04 14:00:09 +0200240 * To make that work, @list must not start with ',' (or else a
Markus Armbruster80c710c2020-04-15 09:49:26 +0200241 * 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 */
Philippe Mathieu-Daudé46bb9442023-10-04 14:00:09 +0200247static bool is_valid_option_list(const char *list)
Markus Armbruster80c710c2020-04-15 09:49:26 +0200248{
Philippe Mathieu-Daudé46bb9442023-10-04 14:00:09 +0200249 size_t len = strlen(list);
Markus Armbruster80c710c2020-04-15 09:49:26 +0200250 size_t i;
251
Philippe Mathieu-Daudé46bb9442023-10-04 14:00:09 +0200252 if (!list[0] || list[0] == ',') {
Markus Armbruster80c710c2020-04-15 09:49:26 +0200253 return false;
254 }
255
Philippe Mathieu-Daudé46bb9442023-10-04 14:00:09 +0200256 for (i = len; i > 0 && list[i - 1] == ','; i--) {
Markus Armbruster80c710c2020-04-15 09:49:26 +0200257 }
258 if ((len - i) % 2) {
259 return false;
260 }
261
262 return true;
263}
264
Philippe Mathieu-Daudé46bb9442023-10-04 14:00:09 +0200265static int accumulate_options(char **options, char *list)
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +0200266{
267 char *new_options;
268
Philippe Mathieu-Daudé46bb9442023-10-04 14:00:09 +0200269 if (!is_valid_option_list(list)) {
270 error_report("Invalid option list: %s", list);
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +0200271 return -1;
272 }
273
274 if (!*options) {
Philippe Mathieu-Daudé46bb9442023-10-04 14:00:09 +0200275 *options = g_strdup(list);
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +0200276 } else {
Philippe Mathieu-Daudé46bb9442023-10-04 14:00:09 +0200277 new_options = g_strdup_printf("%s,%s", *options, list);
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +0200278 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;
Zhenguia0441b62020-10-20 14:47:43 +0000963 int64_t rate_limit = 0;
bellardea2384d2004-08-01 21:59:26 +0000964
965 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400966 cache = BDRV_DEFAULT_CACHE;
Max Reitz1b22bff2014-10-24 15:57:40 +0200967 base = NULL;
bellardea2384d2004-08-01 21:59:26 +0000968 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000969 static const struct option long_options[] = {
970 {"help", no_argument, 0, 'h'},
971 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000972 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000973 {0, 0, 0, 0}
974 };
Zhenguia0441b62020-10-20 14:47:43 +0000975 c = getopt_long(argc, argv, ":f:ht:b:dpqr:",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000976 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100977 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000978 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100979 }
bellardea2384d2004-08-01 21:59:26 +0000980 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800981 case ':':
982 missing_argument(argv[optind - 1]);
983 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100984 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800985 unrecognized_option(argv[optind - 1]);
986 break;
bellardea2384d2004-08-01 21:59:26 +0000987 case 'h':
988 help();
989 break;
990 case 'f':
991 fmt = optarg;
992 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400993 case 't':
994 cache = optarg;
995 break;
Max Reitz1b22bff2014-10-24 15:57:40 +0200996 case 'b':
997 base = optarg;
998 /* -b implies -d */
999 drop = true;
1000 break;
Max Reitz9a86fe42014-10-24 15:57:38 +02001001 case 'd':
1002 drop = true;
1003 break;
Max Reitz687fa1d2014-10-24 15:57:39 +02001004 case 'p':
1005 progress = true;
1006 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01001007 case 'q':
1008 quiet = true;
1009 break;
Zhenguia0441b62020-10-20 14:47:43 +00001010 case 'r':
1011 rate_limit = cvtnum("rate limit", optarg);
1012 if (rate_limit < 0) {
1013 return 1;
1014 }
1015 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01001016 case OPTION_OBJECT:
1017 user_creatable_process_cmdline(optarg);
1018 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001019 case OPTION_IMAGE_OPTS:
1020 image_opts = true;
1021 break;
bellardea2384d2004-08-01 21:59:26 +00001022 }
1023 }
Max Reitz687fa1d2014-10-24 15:57:39 +02001024
1025 /* Progress is not shown in Quiet mode */
1026 if (quiet) {
1027 progress = false;
1028 }
1029
Kevin Wolffc11eb22013-08-05 10:53:04 +02001030 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001031 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01001032 }
bellardea2384d2004-08-01 21:59:26 +00001033 filename = argv[optind++];
1034
Max Reitz9a86fe42014-10-24 15:57:38 +02001035 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
Kevin Wolfce099542016-03-15 13:01:04 +01001036 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001037 if (ret < 0) {
1038 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczia3981eb2014-08-26 19:17:54 +01001039 return 1;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001040 }
1041
Fam Zheng335e9932017-05-03 00:35:39 +08001042 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
1043 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001044 if (!blk) {
1045 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001046 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001047 bs = blk_bs(blk);
1048
Max Reitz687fa1d2014-10-24 15:57:39 +02001049 qemu_progress_init(progress, 1.f);
1050 qemu_progress_print(0.f, 100);
1051
Kevin Wolfad747512023-10-27 17:53:17 +02001052 bdrv_graph_rdlock_main_loop();
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);
Kevin Wolfad747512023-10-27 17:53:17 +02001059 bdrv_graph_rdunlock_main_loop();
Max Reitz1b22bff2014-10-24 15:57:40 +02001060 goto done;
1061 }
1062 } else {
1063 /* This is different from QMP, which by default uses the deepest file in
1064 * the backing chain (i.e., the very base); however, the traditional
1065 * behavior of qemu-img commit is using the immediate backing file. */
Max Reitz4a2061e2019-06-12 19:00:30 +02001066 base_bs = bdrv_backing_chain_next(bs);
Max Reitz1b22bff2014-10-24 15:57:40 +02001067 if (!base_bs) {
1068 error_setg(&local_err, "Image does not have a backing file");
Kevin Wolfad747512023-10-27 17:53:17 +02001069 bdrv_graph_rdunlock_main_loop();
Max Reitz1b22bff2014-10-24 15:57:40 +02001070 goto done;
1071 }
bellardea2384d2004-08-01 21:59:26 +00001072 }
Kevin Wolfad747512023-10-27 17:53:17 +02001073 bdrv_graph_rdunlock_main_loop();
bellardea2384d2004-08-01 21:59:26 +00001074
Max Reitzd4a32382014-10-24 15:57:37 +02001075 cbi = (CommonBlockJobCBInfo){
1076 .errp = &local_err,
1077 .bs = bs,
1078 };
1079
Zhenguia0441b62020-10-20 14:47:43 +00001080 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, rate_limit,
Kevin Wolf0db832f2017-02-20 18:10:05 +01001081 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
Fam Zheng78bbd912017-04-21 20:27:04 +08001082 &cbi, false, &local_err);
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/*
Andrey Drobyshevc20c8ae2023-09-19 19:58:00 +03001277 * Compares two buffers chunk by chunk, where @chsize is the chunk size.
1278 * If @chsize is 0, default chunk size of BDRV_SECTOR_SIZE is used.
1279 * Returns 0 if the first chunk of each buffer matches, non-zero otherwise.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001280 *
Andrey Drobyshevc20c8ae2023-09-19 19:58:00 +03001281 * @pnum is set to the size of the buffer prefix aligned to @chsize that
1282 * has the same matching status as the first chunk.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001283 */
Eric Blakedc61cd32017-10-11 22:47:14 -05001284static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
Andrey Drobyshevc20c8ae2023-09-19 19:58:00 +03001285 int64_t bytes, uint64_t chsize, int64_t *pnum)
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001286{
Radim Krčmář8c1ac472015-02-20 17:06:15 +01001287 bool res;
Andrey Drobyshevc20c8ae2023-09-19 19:58:00 +03001288 int64_t i;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001289
Eric Blakedc61cd32017-10-11 22:47:14 -05001290 assert(bytes > 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001291
Andrey Drobyshevc20c8ae2023-09-19 19:58:00 +03001292 if (!chsize) {
1293 chsize = BDRV_SECTOR_SIZE;
1294 }
1295 i = MIN(bytes, chsize);
1296
Eric Blakedc61cd32017-10-11 22:47:14 -05001297 res = !!memcmp(buf1, buf2, i);
1298 while (i < bytes) {
Andrey Drobyshevc20c8ae2023-09-19 19:58:00 +03001299 int64_t len = MIN(bytes - i, chsize);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001300
Eric Blakedc61cd32017-10-11 22:47:14 -05001301 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001302 break;
1303 }
Eric Blakedc61cd32017-10-11 22:47:14 -05001304 i += len;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001305 }
1306
1307 *pnum = i;
1308 return res;
1309}
1310
Stefano Garzarella97ede572019-05-08 12:43:24 +02001311#define IO_BUF_SIZE (2 * MiB)
bellardea2384d2004-08-01 21:59:26 +00001312
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001313/*
1314 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1315 *
Eric Blake0608e402017-10-11 22:47:12 -05001316 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1317 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1318 * failure), and 4 on error (the exit status for read errors), after emitting
1319 * an error message.
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001320 *
Max Reitzf1d3cd72015-02-05 13:58:18 -05001321 * @param blk: BlockBackend for the image
Eric Blakec41508e2017-10-11 22:47:13 -05001322 * @param offset: Starting offset to check
1323 * @param bytes: Number of bytes to check
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001324 * @param filename: Name of disk file we are checking (logging purpose)
1325 * @param buffer: Allocated buffer for storing read data
1326 * @param quiet: Flag for quiet mode
1327 */
Eric Blakec41508e2017-10-11 22:47:13 -05001328static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1329 int64_t bytes, const char *filename,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001330 uint8_t *buffer, bool quiet)
1331{
Eric Blakedebb38a2017-10-11 22:47:11 -05001332 int ret = 0;
1333 int64_t idx;
1334
Alberto Fariaa9262f52022-07-05 17:15:11 +01001335 ret = blk_pread(blk, offset, bytes, buffer, 0);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001336 if (ret < 0) {
1337 error_report("Error while reading offset %" PRId64 " of %s: %s",
Eric Blakec41508e2017-10-11 22:47:13 -05001338 offset, filename, strerror(-ret));
Eric Blake0608e402017-10-11 22:47:12 -05001339 return 4;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001340 }
Eric Blakec41508e2017-10-11 22:47:13 -05001341 idx = find_nonzero(buffer, bytes);
Eric Blakedebb38a2017-10-11 22:47:11 -05001342 if (idx >= 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001343 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blakec41508e2017-10-11 22:47:13 -05001344 offset + idx);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001345 return 1;
1346 }
1347
1348 return 0;
1349}
1350
1351/*
1352 * Compares two images. Exit codes:
1353 *
Kevin Wolf99b1e642021-02-17 12:56:45 +01001354 * 0 - Images are identical or the requested help was printed
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001355 * 1 - Images differ
1356 * >1 - Error occurred
1357 */
1358static int img_compare(int argc, char **argv)
1359{
Max Reitz40055952014-07-22 22:58:42 +02001360 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001361 BlockBackend *blk1, *blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001362 BlockDriverState *bs1, *bs2;
Eric Blake033d9fc2017-10-11 22:47:16 -05001363 int64_t total_size1, total_size2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001364 uint8_t *buf1 = NULL, *buf2 = NULL;
Eric Blake31826642017-10-11 22:47:08 -05001365 int64_t pnum1, pnum2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001366 int allocated1, allocated2;
1367 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1368 bool progress = false, quiet = false, strict = false;
Max Reitz40055952014-07-22 22:58:42 +02001369 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01001370 bool writethrough;
Eric Blake033d9fc2017-10-11 22:47:16 -05001371 int64_t total_size;
1372 int64_t offset = 0;
1373 int64_t chunk;
Eric Blakedc61cd32017-10-11 22:47:14 -05001374 int c;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001375 uint64_t progress_base;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001376 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08001377 bool force_share = false;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001378
Max Reitz40055952014-07-22 22:58:42 +02001379 cache = BDRV_DEFAULT_CACHE;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001380 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001381 static const struct option long_options[] = {
1382 {"help", no_argument, 0, 'h'},
1383 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001384 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08001385 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001386 {0, 0, 0, 0}
1387 };
Fam Zheng335e9932017-05-03 00:35:39 +08001388 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001389 long_options, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001390 if (c == -1) {
1391 break;
1392 }
1393 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001394 case ':':
1395 missing_argument(argv[optind - 1]);
1396 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001397 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001398 unrecognized_option(argv[optind - 1]);
1399 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001400 case 'h':
1401 help();
1402 break;
1403 case 'f':
1404 fmt1 = optarg;
1405 break;
1406 case 'F':
1407 fmt2 = optarg;
1408 break;
Max Reitz40055952014-07-22 22:58:42 +02001409 case 'T':
1410 cache = optarg;
1411 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001412 case 'p':
1413 progress = true;
1414 break;
1415 case 'q':
1416 quiet = true;
1417 break;
1418 case 's':
1419 strict = true;
1420 break;
Fam Zheng335e9932017-05-03 00:35:39 +08001421 case 'U':
1422 force_share = true;
1423 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01001424 case OPTION_OBJECT:
1425 {
1426 Error *local_err = NULL;
1427
1428 if (!user_creatable_add_from_str(optarg, &local_err)) {
1429 if (local_err) {
1430 error_report_err(local_err);
1431 exit(2);
1432 } else {
1433 /* Help was printed */
1434 exit(EXIT_SUCCESS);
1435 }
1436 }
1437 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001438 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001439 case OPTION_IMAGE_OPTS:
1440 image_opts = true;
1441 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001442 }
1443 }
1444
1445 /* Progress is not shown in Quiet mode */
1446 if (quiet) {
1447 progress = false;
1448 }
1449
1450
Kevin Wolffc11eb22013-08-05 10:53:04 +02001451 if (optind != argc - 2) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001452 error_exit("Expecting two image file names");
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001453 }
1454 filename1 = argv[optind++];
1455 filename2 = argv[optind++];
1456
Stefan Hajnoczicbda0162014-08-26 19:17:55 +01001457 /* Initialize before goto out */
1458 qemu_progress_init(progress, 2.0);
1459
Kevin Wolfce099542016-03-15 13:01:04 +01001460 flags = 0;
1461 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +02001462 if (ret < 0) {
1463 error_report("Invalid source cache option: %s", cache);
1464 ret = 2;
1465 goto out3;
1466 }
1467
Fam Zheng335e9932017-05-03 00:35:39 +08001468 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1469 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001470 if (!blk1) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001471 ret = 2;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001472 goto out3;
1473 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001474
Fam Zheng335e9932017-05-03 00:35:39 +08001475 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1476 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001477 if (!blk2) {
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001478 ret = 2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001479 goto out2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001480 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001481 bs1 = blk_bs(blk1);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001482 bs2 = blk_bs(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001483
Max Reitzf1d3cd72015-02-05 13:58:18 -05001484 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1485 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
Eric Blake033d9fc2017-10-11 22:47:16 -05001486 total_size1 = blk_getlength(blk1);
1487 if (total_size1 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001488 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001489 filename1, strerror(-total_size1));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001490 ret = 4;
1491 goto out;
1492 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001493 total_size2 = blk_getlength(blk2);
1494 if (total_size2 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001495 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001496 filename2, strerror(-total_size2));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001497 ret = 4;
1498 goto out;
1499 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001500 total_size = MIN(total_size1, total_size2);
1501 progress_base = MAX(total_size1, total_size2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001502
1503 qemu_progress_print(0, 100);
1504
Eric Blake033d9fc2017-10-11 22:47:16 -05001505 if (strict && total_size1 != total_size2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001506 ret = 1;
1507 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1508 goto out;
1509 }
1510
Eric Blake033d9fc2017-10-11 22:47:16 -05001511 while (offset < total_size) {
Eric Blake31826642017-10-11 22:47:08 -05001512 int status1, status2;
Fam Zheng67a0fd22016-01-26 11:58:48 +08001513
Eric Blake033d9fc2017-10-11 22:47:16 -05001514 status1 = bdrv_block_status_above(bs1, NULL, offset,
1515 total_size1 - offset, &pnum1, NULL,
1516 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001517 if (status1 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001518 ret = 3;
1519 error_report("Sector allocation test failed for %s", filename1);
1520 goto out;
1521 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001522 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001523
Eric Blake033d9fc2017-10-11 22:47:16 -05001524 status2 = bdrv_block_status_above(bs2, NULL, offset,
1525 total_size2 - offset, &pnum2, NULL,
1526 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001527 if (status2 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001528 ret = 3;
1529 error_report("Sector allocation test failed for %s", filename2);
1530 goto out;
1531 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001532 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
Eric Blake7daddc62017-10-11 22:47:09 -05001533
1534 assert(pnum1 && pnum2);
Eric Blake033d9fc2017-10-11 22:47:16 -05001535 chunk = MIN(pnum1, pnum2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001536
Fam Zheng25ad8e62016-01-13 16:37:41 +08001537 if (strict) {
Eric Blake31826642017-10-11 22:47:08 -05001538 if (status1 != status2) {
Fam Zheng25ad8e62016-01-13 16:37:41 +08001539 ret = 1;
1540 qprintf(quiet, "Strict mode: Offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001541 " block status mismatch!\n", offset);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001542 goto out;
1543 }
1544 }
1545 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
Eric Blake7daddc62017-10-11 22:47:09 -05001546 /* nothing to do */
Fam Zheng25ad8e62016-01-13 16:37:41 +08001547 } else if (allocated1 == allocated2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001548 if (allocated1) {
Eric Blakedc61cd32017-10-11 22:47:14 -05001549 int64_t pnum;
1550
Eric Blake033d9fc2017-10-11 22:47:16 -05001551 chunk = MIN(chunk, IO_BUF_SIZE);
Alberto Fariaa9262f52022-07-05 17:15:11 +01001552 ret = blk_pread(blk1, offset, chunk, buf1, 0);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001553 if (ret < 0) {
1554 error_report("Error while reading offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001555 " of %s: %s",
1556 offset, filename1, strerror(-ret));
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001557 ret = 4;
1558 goto out;
1559 }
Alberto Fariaa9262f52022-07-05 17:15:11 +01001560 ret = blk_pread(blk2, offset, chunk, buf2, 0);
Eric Blake033d9fc2017-10-11 22:47:16 -05001561 if (ret < 0) {
1562 error_report("Error while reading offset %" PRId64
1563 " of %s: %s",
1564 offset, filename2, strerror(-ret));
1565 ret = 4;
1566 goto out;
1567 }
Andrey Drobyshevc20c8ae2023-09-19 19:58:00 +03001568 ret = compare_buffers(buf1, buf2, chunk, 0, &pnum);
Eric Blake033d9fc2017-10-11 22:47:16 -05001569 if (ret || pnum != chunk) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001570 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blake033d9fc2017-10-11 22:47:16 -05001571 offset + (ret ? 0 : pnum));
Fam Zheng36452f12013-11-13 20:26:49 +08001572 ret = 1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001573 goto out;
1574 }
1575 }
1576 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001577 chunk = MIN(chunk, IO_BUF_SIZE);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001578 if (allocated1) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001579 ret = check_empty_sectors(blk1, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001580 filename1, buf1, quiet);
1581 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001582 ret = check_empty_sectors(blk2, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001583 filename2, buf1, quiet);
1584 }
1585 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001586 goto out;
1587 }
1588 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001589 offset += chunk;
1590 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001591 }
1592
Eric Blake033d9fc2017-10-11 22:47:16 -05001593 if (total_size1 != total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001594 BlockBackend *blk_over;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001595 const char *filename_over;
1596
1597 qprintf(quiet, "Warning: Image size mismatch!\n");
Eric Blake033d9fc2017-10-11 22:47:16 -05001598 if (total_size1 > total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001599 blk_over = blk1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001600 filename_over = filename1;
1601 } else {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001602 blk_over = blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001603 filename_over = filename2;
1604 }
1605
Eric Blake033d9fc2017-10-11 22:47:16 -05001606 while (offset < progress_base) {
1607 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1608 progress_base - offset, &chunk,
1609 NULL, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001610 if (ret < 0) {
1611 ret = 3;
1612 error_report("Sector allocation test failed for %s",
1613 filename_over);
1614 goto out;
1615
1616 }
Eric Blake391cb1a2017-10-11 22:47:10 -05001617 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001618 chunk = MIN(chunk, IO_BUF_SIZE);
1619 ret = check_empty_sectors(blk_over, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001620 filename_over, buf1, quiet);
1621 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001622 goto out;
1623 }
1624 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001625 offset += chunk;
1626 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001627 }
1628 }
1629
1630 qprintf(quiet, "Images are identical.\n");
1631 ret = 0;
1632
1633out:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001634 qemu_vfree(buf1);
1635 qemu_vfree(buf2);
Markus Armbruster26f54e92014-10-07 13:59:04 +02001636 blk_unref(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001637out2:
Markus Armbruster26f54e92014-10-07 13:59:04 +02001638 blk_unref(blk1);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001639out3:
1640 qemu_progress_end();
1641 return ret;
1642}
1643
Eric Blake6c729dd2020-05-21 14:21:35 -05001644/* Convenience wrapper around qmp_block_dirty_bitmap_merge */
1645static void do_dirty_bitmap_merge(const char *dst_node, const char *dst_name,
1646 const char *src_node, const char *src_name,
1647 Error **errp)
1648{
Vladimir Sementsov-Ogievskiy1466ef62022-03-15 00:32:24 +03001649 BlockDirtyBitmapOrStr *merge_src;
1650 BlockDirtyBitmapOrStrList *list = NULL;
Eric Blake6c729dd2020-05-21 14:21:35 -05001651
Vladimir Sementsov-Ogievskiy1466ef62022-03-15 00:32:24 +03001652 merge_src = g_new0(BlockDirtyBitmapOrStr, 1);
Eric Blake6c729dd2020-05-21 14:21:35 -05001653 merge_src->type = QTYPE_QDICT;
1654 merge_src->u.external.node = g_strdup(src_node);
1655 merge_src->u.external.name = g_strdup(src_name);
Eric Blake54aa3de2020-11-12 19:13:37 -06001656 QAPI_LIST_PREPEND(list, merge_src);
Eric Blake6c729dd2020-05-21 14:21:35 -05001657 qmp_block_dirty_bitmap_merge(dst_node, dst_name, list, errp);
Vladimir Sementsov-Ogievskiy1466ef62022-03-15 00:32:24 +03001658 qapi_free_BlockDirtyBitmapOrStrList(list);
Eric Blake6c729dd2020-05-21 14:21:35 -05001659}
1660
Kevin Wolf690c7302015-03-19 13:33:32 +01001661enum ImgConvertBlockStatus {
1662 BLK_DATA,
1663 BLK_ZERO,
1664 BLK_BACKING_FILE,
1665};
1666
Peter Lieven2d9187b2017-02-28 13:40:07 +01001667#define MAX_COROUTINES 16
Zhengui0c8c4892020-10-20 14:47:44 +00001668#define CONVERT_THROTTLE_GROUP "img_convert"
Peter Lieven2d9187b2017-02-28 13:40:07 +01001669
Kevin Wolf690c7302015-03-19 13:33:32 +01001670typedef struct ImgConvertState {
1671 BlockBackend **src;
1672 int64_t *src_sectors;
Peter Lievenaf8d43d2020-09-01 14:51:29 +02001673 int *src_alignment;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001674 int src_num;
Kevin Wolf690c7302015-03-19 13:33:32 +01001675 int64_t total_sectors;
1676 int64_t allocated_sectors;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001677 int64_t allocated_done;
1678 int64_t sector_num;
1679 int64_t wr_offs;
Kevin Wolf690c7302015-03-19 13:33:32 +01001680 enum ImgConvertBlockStatus status;
1681 int64_t sector_next_status;
1682 BlockBackend *target;
1683 bool has_zero_init;
1684 bool compressed;
Max Reitz4d7c4872019-07-24 19:12:29 +02001685 bool target_is_new;
Kevin Wolf690c7302015-03-19 13:33:32 +01001686 bool target_has_backing;
Max Reitz351c8ef2018-05-01 18:57:49 +02001687 int64_t target_backing_sectors; /* negative if unknown */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001688 bool wr_in_order;
Fam Zhengee5306d2018-06-01 17:26:48 +08001689 bool copy_range;
Max Reitz8eaac022019-05-07 22:35:03 +02001690 bool salvage;
Max Reitz3d96cb92019-05-07 22:35:02 +02001691 bool quiet;
Kevin Wolf690c7302015-03-19 13:33:32 +01001692 int min_sparse;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001693 int alignment;
Kevin Wolf690c7302015-03-19 13:33:32 +01001694 size_t cluster_sectors;
1695 size_t buf_sectors;
Peter Lieven9fd77f92017-04-21 11:11:55 +02001696 long num_coroutines;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001697 int running_coroutines;
1698 Coroutine *co[MAX_COROUTINES];
1699 int64_t wait_sector_num[MAX_COROUTINES];
1700 CoMutex lock;
1701 int ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001702} ImgConvertState;
1703
Peter Lieven2d9187b2017-02-28 13:40:07 +01001704static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1705 int *src_cur, int64_t *src_cur_offset)
Kevin Wolf690c7302015-03-19 13:33:32 +01001706{
Peter Lieven2d9187b2017-02-28 13:40:07 +01001707 *src_cur = 0;
1708 *src_cur_offset = 0;
1709 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1710 *src_cur_offset += s->src_sectors[*src_cur];
1711 (*src_cur)++;
1712 assert(*src_cur < s->src_num);
Kevin Wolf690c7302015-03-19 13:33:32 +01001713 }
1714}
1715
Kevin Wolfad747512023-10-27 17:53:17 +02001716static int coroutine_mixed_fn GRAPH_RDLOCK
1717convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
Kevin Wolf690c7302015-03-19 13:33:32 +01001718{
Eric Blake31826642017-10-11 22:47:08 -05001719 int64_t src_cur_offset;
1720 int ret, n, src_cur;
Max Reitz351c8ef2018-05-01 18:57:49 +02001721 bool post_backing_zero = false;
Kevin Wolf690c7302015-03-19 13:33:32 +01001722
Peter Lieven2d9187b2017-02-28 13:40:07 +01001723 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
Kevin Wolf690c7302015-03-19 13:33:32 +01001724
1725 assert(s->total_sectors > sector_num);
1726 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1727
Max Reitz351c8ef2018-05-01 18:57:49 +02001728 if (s->target_backing_sectors >= 0) {
1729 if (sector_num >= s->target_backing_sectors) {
Vladimir Sementsov-Ogievskiy2253d862020-05-28 12:43:56 +03001730 post_backing_zero = true;
Max Reitz351c8ef2018-05-01 18:57:49 +02001731 } else if (sector_num + n > s->target_backing_sectors) {
1732 /* Split requests around target_backing_sectors (because
1733 * starting from there, zeros are handled differently) */
1734 n = s->target_backing_sectors - sector_num;
1735 }
1736 }
1737
Kevin Wolf690c7302015-03-19 13:33:32 +01001738 if (s->sector_next_status <= sector_num) {
Max Reitz8eaac022019-05-07 22:35:03 +02001739 uint64_t offset = (sector_num - src_cur_offset) * BDRV_SECTOR_SIZE;
1740 int64_t count;
Peter Lievenaf8d43d2020-09-01 14:51:29 +02001741 int tail;
Max Reitz4a2061e2019-06-12 19:00:30 +02001742 BlockDriverState *src_bs = blk_bs(s->src[src_cur]);
1743 BlockDriverState *base;
1744
1745 if (s->target_has_backing) {
1746 base = bdrv_cow_bs(bdrv_skip_filters(src_bs));
1747 } else {
1748 base = NULL;
1749 }
Eric Blake31826642017-10-11 22:47:08 -05001750
Max Reitz8eaac022019-05-07 22:35:03 +02001751 do {
1752 count = n * BDRV_SECTOR_SIZE;
Eric Blake237d78f2017-10-11 22:47:03 -05001753
Max Reitz4a2061e2019-06-12 19:00:30 +02001754 ret = bdrv_block_status_above(src_bs, base, offset, count, &count,
1755 NULL, NULL);
Max Reitz8eaac022019-05-07 22:35:03 +02001756
1757 if (ret < 0) {
1758 if (s->salvage) {
1759 if (n == 1) {
1760 if (!s->quiet) {
1761 warn_report("error while reading block status at "
1762 "offset %" PRIu64 ": %s", offset,
1763 strerror(-ret));
1764 }
1765 /* Just try to read the data, then */
1766 ret = BDRV_BLOCK_DATA;
1767 count = BDRV_SECTOR_SIZE;
1768 } else {
1769 /* Retry on a shorter range */
1770 n = DIV_ROUND_UP(n, 4);
1771 }
1772 } else {
1773 error_report("error while reading block status at offset "
1774 "%" PRIu64 ": %s", offset, strerror(-ret));
1775 return ret;
1776 }
1777 }
1778 } while (ret < 0);
1779
Eric Blake31826642017-10-11 22:47:08 -05001780 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
Kevin Wolf690c7302015-03-19 13:33:32 +01001781
Peter Lievenaf8d43d2020-09-01 14:51:29 +02001782 /*
1783 * Avoid that s->sector_next_status becomes unaligned to the source
1784 * request alignment and/or cluster size to avoid unnecessary read
1785 * cycles.
1786 */
1787 tail = (sector_num - src_cur_offset + n) % s->src_alignment[src_cur];
1788 if (n > tail) {
1789 n -= tail;
1790 }
1791
Kevin Wolf690c7302015-03-19 13:33:32 +01001792 if (ret & BDRV_BLOCK_ZERO) {
Max Reitz351c8ef2018-05-01 18:57:49 +02001793 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
Kevin Wolf690c7302015-03-19 13:33:32 +01001794 } else if (ret & BDRV_BLOCK_DATA) {
1795 s->status = BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001796 } else {
Vladimir Sementsov-Ogievskiy9f1b92a2017-04-07 14:34:04 +03001797 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001798 }
1799
1800 s->sector_next_status = sector_num + n;
1801 }
1802
1803 n = MIN(n, s->sector_next_status - sector_num);
1804 if (s->status == BLK_DATA) {
1805 n = MIN(n, s->buf_sectors);
1806 }
1807
1808 /* We need to write complete clusters for compressed images, so if an
1809 * unallocated area is shorter than that, we must consider the whole
1810 * cluster allocated. */
1811 if (s->compressed) {
1812 if (n < s->cluster_sectors) {
1813 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1814 s->status = BLK_DATA;
1815 } else {
1816 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1817 }
1818 }
1819
1820 return n;
1821}
1822
Peter Lieven2d9187b2017-02-28 13:40:07 +01001823static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1824 int nb_sectors, uint8_t *buf)
Kevin Wolf690c7302015-03-19 13:33:32 +01001825{
Max Reitz8eaac022019-05-07 22:35:03 +02001826 uint64_t single_read_until = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001827 int n, ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001828
Kevin Wolf690c7302015-03-19 13:33:32 +01001829 assert(nb_sectors <= s->buf_sectors);
1830 while (nb_sectors > 0) {
1831 BlockBackend *blk;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001832 int src_cur;
1833 int64_t bs_sectors, src_cur_offset;
Max Reitz8eaac022019-05-07 22:35:03 +02001834 uint64_t offset;
Kevin Wolf690c7302015-03-19 13:33:32 +01001835
1836 /* In the case of compression with multiple source files, we can get a
1837 * nb_sectors that spreads into the next part. So we must be able to
1838 * read across multiple BDSes for one convert_read() call. */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001839 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1840 blk = s->src[src_cur];
1841 bs_sectors = s->src_sectors[src_cur];
Kevin Wolf690c7302015-03-19 13:33:32 +01001842
Max Reitz8eaac022019-05-07 22:35:03 +02001843 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001844
Max Reitz8eaac022019-05-07 22:35:03 +02001845 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1846 if (single_read_until > offset) {
1847 n = 1;
1848 }
1849
1850 ret = blk_co_pread(blk, offset, n << BDRV_SECTOR_BITS, buf, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01001851 if (ret < 0) {
Max Reitz8eaac022019-05-07 22:35:03 +02001852 if (s->salvage) {
1853 if (n > 1) {
1854 single_read_until = offset + (n << BDRV_SECTOR_BITS);
1855 continue;
1856 } else {
1857 if (!s->quiet) {
1858 warn_report("error while reading offset %" PRIu64
1859 ": %s", offset, strerror(-ret));
1860 }
1861 memset(buf, 0, BDRV_SECTOR_SIZE);
1862 }
1863 } else {
1864 return ret;
1865 }
Kevin Wolf690c7302015-03-19 13:33:32 +01001866 }
1867
1868 sector_num += n;
1869 nb_sectors -= n;
1870 buf += n * BDRV_SECTOR_SIZE;
1871 }
1872
1873 return 0;
1874}
1875
Peter Lieven2d9187b2017-02-28 13:40:07 +01001876
1877static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1878 int nb_sectors, uint8_t *buf,
1879 enum ImgConvertBlockStatus status)
Kevin Wolf690c7302015-03-19 13:33:32 +01001880{
1881 int ret;
1882
1883 while (nb_sectors > 0) {
1884 int n = nb_sectors;
Lidong Chendb933fb2017-04-27 10:58:27 +08001885 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1886
Peter Lieven2d9187b2017-02-28 13:40:07 +01001887 switch (status) {
Kevin Wolf690c7302015-03-19 13:33:32 +01001888 case BLK_BACKING_FILE:
1889 /* If we have a backing file, leave clusters unallocated that are
1890 * unallocated in the source image, so that the backing file is
1891 * visible at the respective offset. */
1892 assert(s->target_has_backing);
1893 break;
1894
1895 case BLK_DATA:
Lidong Chendb933fb2017-04-27 10:58:27 +08001896 /* If we're told to keep the target fully allocated (-S 0) or there
1897 * is real non-zero data, we must write it. Otherwise we can treat
1898 * it as zero sectors.
1899 * Compressed clusters need to be written as a whole, so in that
1900 * case we can only save the write if the buffer is completely
1901 * zeroed. */
Kevin Wolf690c7302015-03-19 13:33:32 +01001902 if (!s->min_sparse ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001903 (!s->compressed &&
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001904 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1905 sector_num, s->alignment)) ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001906 (s->compressed &&
1907 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
Kevin Wolf690c7302015-03-19 13:33:32 +01001908 {
Vladimir Sementsov-Ogievskiy265a7e52019-04-22 17:58:38 +03001909 ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1910 n << BDRV_SECTOR_BITS, buf, flags);
Kevin Wolf690c7302015-03-19 13:33:32 +01001911 if (ret < 0) {
1912 return ret;
1913 }
1914 break;
1915 }
1916 /* fall-through */
1917
1918 case BLK_ZERO:
1919 if (s->has_zero_init) {
Lidong Chendb933fb2017-04-27 10:58:27 +08001920 assert(!s->target_has_backing);
Kevin Wolf690c7302015-03-19 13:33:32 +01001921 break;
1922 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01001923 ret = blk_co_pwrite_zeroes(s->target,
1924 sector_num << BDRV_SECTOR_BITS,
Nir Soffera3d6ae22019-03-24 02:20:12 +02001925 n << BDRV_SECTOR_BITS,
1926 BDRV_REQ_MAY_UNMAP);
Kevin Wolf690c7302015-03-19 13:33:32 +01001927 if (ret < 0) {
1928 return ret;
1929 }
1930 break;
1931 }
1932
1933 sector_num += n;
1934 nb_sectors -= n;
1935 buf += n * BDRV_SECTOR_SIZE;
1936 }
1937
1938 return 0;
1939}
1940
Fam Zhengee5306d2018-06-01 17:26:48 +08001941static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1942 int nb_sectors)
1943{
1944 int n, ret;
1945
1946 while (nb_sectors > 0) {
1947 BlockBackend *blk;
1948 int src_cur;
1949 int64_t bs_sectors, src_cur_offset;
1950 int64_t offset;
1951
1952 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1953 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1954 blk = s->src[src_cur];
1955 bs_sectors = s->src_sectors[src_cur];
1956
1957 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1958
1959 ret = blk_co_copy_range(blk, offset, s->target,
1960 sector_num << BDRV_SECTOR_BITS,
Vladimir Sementsov-Ogievskiy67b51fb2018-07-09 19:37:17 +03001961 n << BDRV_SECTOR_BITS, 0, 0);
Fam Zhengee5306d2018-06-01 17:26:48 +08001962 if (ret < 0) {
1963 return ret;
1964 }
1965
1966 sector_num += n;
1967 nb_sectors -= n;
1968 }
1969 return 0;
1970}
1971
Peter Lieven2d9187b2017-02-28 13:40:07 +01001972static void coroutine_fn convert_co_do_copy(void *opaque)
1973{
1974 ImgConvertState *s = opaque;
1975 uint8_t *buf = NULL;
1976 int ret, i;
1977 int index = -1;
1978
1979 for (i = 0; i < s->num_coroutines; i++) {
1980 if (s->co[i] == qemu_coroutine_self()) {
1981 index = i;
1982 break;
1983 }
1984 }
1985 assert(index >= 0);
1986
1987 s->running_coroutines++;
1988 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1989
1990 while (1) {
1991 int n;
1992 int64_t sector_num;
1993 enum ImgConvertBlockStatus status;
Fam Zhengee5306d2018-06-01 17:26:48 +08001994 bool copy_range;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001995
1996 qemu_co_mutex_lock(&s->lock);
1997 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1998 qemu_co_mutex_unlock(&s->lock);
Anton Nefedovb91127e2017-04-26 11:33:15 +03001999 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002000 }
Kevin Wolf7ff95792023-02-03 16:21:43 +01002001 WITH_GRAPH_RDLOCK_GUARD() {
2002 n = convert_iteration_sectors(s, s->sector_num);
2003 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01002004 if (n < 0) {
2005 qemu_co_mutex_unlock(&s->lock);
2006 s->ret = n;
Anton Nefedovb91127e2017-04-26 11:33:15 +03002007 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002008 }
2009 /* save current sector and allocation status to local variables */
2010 sector_num = s->sector_num;
2011 status = s->status;
2012 if (!s->min_sparse && s->status == BLK_ZERO) {
2013 n = MIN(n, s->buf_sectors);
2014 }
2015 /* increment global sector counter so that other coroutines can
2016 * already continue reading beyond this request */
2017 s->sector_num += n;
2018 qemu_co_mutex_unlock(&s->lock);
2019
2020 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
2021 s->allocated_done += n;
2022 qemu_progress_print(100.0 * s->allocated_done /
2023 s->allocated_sectors, 0);
2024 }
2025
Fam Zhengee5306d2018-06-01 17:26:48 +08002026retry:
2027 copy_range = s->copy_range && s->status == BLK_DATA;
2028 if (status == BLK_DATA && !copy_range) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002029 ret = convert_co_read(s, sector_num, n, buf);
2030 if (ret < 0) {
Eric Blake39f77cb2020-04-02 08:57:17 -05002031 error_report("error while reading at byte %lld: %s",
2032 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
Peter Lieven2d9187b2017-02-28 13:40:07 +01002033 s->ret = ret;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002034 }
2035 } else if (!s->min_sparse && status == BLK_ZERO) {
2036 status = BLK_DATA;
2037 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
2038 }
2039
2040 if (s->wr_in_order) {
2041 /* keep writes in order */
Anton Nefedovb91127e2017-04-26 11:33:15 +03002042 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002043 s->wait_sector_num[index] = sector_num;
2044 qemu_coroutine_yield();
2045 }
2046 s->wait_sector_num[index] = -1;
2047 }
2048
Anton Nefedovb91127e2017-04-26 11:33:15 +03002049 if (s->ret == -EINPROGRESS) {
Fam Zhengee5306d2018-06-01 17:26:48 +08002050 if (copy_range) {
Emanuele Giuseppe Esposito742bf092023-02-03 16:21:53 +01002051 WITH_GRAPH_RDLOCK_GUARD() {
2052 ret = convert_co_copy_range(s, sector_num, n);
2053 }
Fam Zhengee5306d2018-06-01 17:26:48 +08002054 if (ret) {
2055 s->copy_range = false;
2056 goto retry;
2057 }
2058 } else {
2059 ret = convert_co_write(s, sector_num, n, buf, status);
2060 }
Anton Nefedovb91127e2017-04-26 11:33:15 +03002061 if (ret < 0) {
Eric Blake39f77cb2020-04-02 08:57:17 -05002062 error_report("error while writing at byte %lld: %s",
2063 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
Anton Nefedovb91127e2017-04-26 11:33:15 +03002064 s->ret = ret;
2065 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01002066 }
2067
2068 if (s->wr_in_order) {
2069 /* reenter the coroutine that might have waited
2070 * for this write to complete */
2071 s->wr_offs = sector_num + n;
2072 for (i = 0; i < s->num_coroutines; i++) {
2073 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
2074 /*
2075 * A -> B -> A cannot occur because A has
2076 * s->wait_sector_num[i] == -1 during A -> B. Therefore
2077 * B will never enter A during this time window.
2078 */
2079 qemu_coroutine_enter(s->co[i]);
2080 break;
2081 }
2082 }
2083 }
2084 }
2085
Peter Lieven2d9187b2017-02-28 13:40:07 +01002086 qemu_vfree(buf);
2087 s->co[index] = NULL;
2088 s->running_coroutines--;
2089 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
2090 /* the convert job finished successfully */
2091 s->ret = 0;
2092 }
2093}
2094
Kevin Wolf690c7302015-03-19 13:33:32 +01002095static int convert_do_copy(ImgConvertState *s)
2096{
Peter Lieven2d9187b2017-02-28 13:40:07 +01002097 int ret, i, n;
2098 int64_t sector_num = 0;
Kevin Wolf690c7302015-03-19 13:33:32 +01002099
2100 /* Check whether we have zero initialisation or can get it efficiently */
David Edmondson168468f2020-02-05 11:02:48 +00002101 if (!s->has_zero_init && s->target_is_new && s->min_sparse &&
2102 !s->target_has_backing) {
Kevin Wolf06717982023-10-27 17:53:11 +02002103 bdrv_graph_rdlock_main_loop();
Max Reitz4d7c4872019-07-24 19:12:29 +02002104 s->has_zero_init = bdrv_has_zero_init(blk_bs(s->target));
Kevin Wolf06717982023-10-27 17:53:11 +02002105 bdrv_graph_rdunlock_main_loop();
Max Reitz4d7c4872019-07-24 19:12:29 +02002106 }
Kevin Wolf690c7302015-03-19 13:33:32 +01002107
Kevin Wolf690c7302015-03-19 13:33:32 +01002108 /* Allocate buffer for copied data. For compressed images, only one cluster
2109 * can be copied at a time. */
2110 if (s->compressed) {
2111 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
2112 error_report("invalid cluster size");
Peter Lieven2d9187b2017-02-28 13:40:07 +01002113 return -EINVAL;
Kevin Wolf690c7302015-03-19 13:33:32 +01002114 }
2115 s->buf_sectors = s->cluster_sectors;
2116 }
Kevin Wolf690c7302015-03-19 13:33:32 +01002117
Kevin Wolf690c7302015-03-19 13:33:32 +01002118 while (sector_num < s->total_sectors) {
Kevin Wolfad747512023-10-27 17:53:17 +02002119 bdrv_graph_rdlock_main_loop();
Kevin Wolf690c7302015-03-19 13:33:32 +01002120 n = convert_iteration_sectors(s, sector_num);
Kevin Wolfad747512023-10-27 17:53:17 +02002121 bdrv_graph_rdunlock_main_loop();
Kevin Wolf690c7302015-03-19 13:33:32 +01002122 if (n < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002123 return n;
Kevin Wolf690c7302015-03-19 13:33:32 +01002124 }
Max Reitzaad15de2016-03-24 23:33:57 +01002125 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
2126 {
Kevin Wolf690c7302015-03-19 13:33:32 +01002127 s->allocated_sectors += n;
2128 }
2129 sector_num += n;
2130 }
2131
2132 /* Do the copy */
Kevin Wolf690c7302015-03-19 13:33:32 +01002133 s->sector_next_status = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002134 s->ret = -EINPROGRESS;
Kevin Wolf690c7302015-03-19 13:33:32 +01002135
Peter Lieven2d9187b2017-02-28 13:40:07 +01002136 qemu_co_mutex_init(&s->lock);
2137 for (i = 0; i < s->num_coroutines; i++) {
2138 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
2139 s->wait_sector_num[i] = -1;
2140 qemu_coroutine_enter(s->co[i]);
Kevin Wolf690c7302015-03-19 13:33:32 +01002141 }
2142
Anton Nefedovb91127e2017-04-26 11:33:15 +03002143 while (s->running_coroutines) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002144 main_loop_wait(false);
2145 }
2146
2147 if (s->compressed && !s->ret) {
Kevin Wolf690c7302015-03-19 13:33:32 +01002148 /* signal EOF to align */
Alberto Faria0cadf2c2022-07-05 17:15:18 +01002149 ret = blk_pwrite_compressed(s->target, 0, 0, NULL);
Kevin Wolf690c7302015-03-19 13:33:32 +01002150 if (ret < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002151 return ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002152 }
2153 }
2154
Peter Lieven2d9187b2017-02-28 13:40:07 +01002155 return s->ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002156}
2157
Eric Blake74a43202021-07-09 10:39:50 -05002158/* Check that bitmaps can be copied, or output an error */
Eric Blake955171e2021-07-21 10:53:48 -05002159static int convert_check_bitmaps(BlockDriverState *src, bool skip_broken)
Eric Blake74a43202021-07-09 10:39:50 -05002160{
2161 BdrvDirtyBitmap *bm;
2162
2163 if (!bdrv_supports_persistent_dirty_bitmap(src)) {
2164 error_report("Source lacks bitmap support");
2165 return -1;
2166 }
2167 FOR_EACH_DIRTY_BITMAP(src, bm) {
2168 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2169 continue;
2170 }
Eric Blake955171e2021-07-21 10:53:48 -05002171 if (!skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) {
Eric Blake74a43202021-07-09 10:39:50 -05002172 error_report("Cannot copy inconsistent bitmap '%s'",
2173 bdrv_dirty_bitmap_name(bm));
Eric Blake955171e2021-07-21 10:53:48 -05002174 error_printf("Try --skip-broken-bitmaps, or "
2175 "use 'qemu-img bitmap --remove' to delete it\n");
Eric Blake74a43202021-07-09 10:39:50 -05002176 return -1;
2177 }
2178 }
2179 return 0;
2180}
2181
Eric Blake955171e2021-07-21 10:53:48 -05002182static int convert_copy_bitmaps(BlockDriverState *src, BlockDriverState *dst,
2183 bool skip_broken)
Eric Blake15e39ad2020-05-21 14:21:36 -05002184{
2185 BdrvDirtyBitmap *bm;
2186 Error *err = NULL;
2187
2188 FOR_EACH_DIRTY_BITMAP(src, bm) {
2189 const char *name;
2190
2191 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2192 continue;
2193 }
2194 name = bdrv_dirty_bitmap_name(bm);
Eric Blake955171e2021-07-21 10:53:48 -05002195 if (skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) {
2196 warn_report("Skipping inconsistent bitmap '%s'", name);
2197 continue;
2198 }
Eric Blake15e39ad2020-05-21 14:21:36 -05002199 qmp_block_dirty_bitmap_add(dst->node_name, name,
2200 true, bdrv_dirty_bitmap_granularity(bm),
2201 true, true,
2202 true, !bdrv_dirty_bitmap_enabled(bm),
2203 &err);
2204 if (err) {
2205 error_reportf_err(err, "Failed to create bitmap %s: ", name);
2206 return -1;
2207 }
2208
2209 do_dirty_bitmap_merge(dst->node_name, name, src->node_name, name,
2210 &err);
2211 if (err) {
2212 error_reportf_err(err, "Failed to populate bitmap %s: ", name);
Eric Blake74a43202021-07-09 10:39:50 -05002213 qmp_block_dirty_bitmap_remove(dst->node_name, name, NULL);
Eric Blake15e39ad2020-05-21 14:21:36 -05002214 return -1;
2215 }
2216 }
2217
2218 return 0;
2219}
2220
Peter Lieven6360ab22018-07-13 09:15:39 +02002221#define MAX_BUF_SECTORS 32768
2222
Zhengui0c8c4892020-10-20 14:47:44 +00002223static void set_rate_limit(BlockBackend *blk, int64_t rate_limit)
2224{
2225 ThrottleConfig cfg;
2226
2227 throttle_config_init(&cfg);
2228 cfg.buckets[THROTTLE_BPS_WRITE].avg = rate_limit;
2229
2230 blk_io_limits_enable(blk, CONVERT_THROTTLE_GROUP);
2231 blk_set_io_limits(blk, &cfg);
2232}
2233
bellardea2384d2004-08-01 21:59:26 +00002234static int img_convert(int argc, char **argv)
2235{
Kevin Wolf0b8fb552021-04-22 18:43:44 +02002236 int c, bs_i, flags, src_flags = BDRV_O_NO_SHARE;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002237 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002238 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
Eric Blake1899bf42021-09-13 08:17:35 -05002239 *out_filename, *out_baseimg_param, *snapshot_name = NULL,
2240 *backing_fmt = NULL;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002241 BlockDriver *drv = NULL, *proto_drv = NULL;
bellardfaea38e2006-08-05 21:31:00 +00002242 BlockDriverInfo bdi;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002243 BlockDriverState *out_bs;
2244 QemuOpts *opts = NULL, *sn_opts = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08002245 QemuOptsList *create_opts = NULL;
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002246 QDict *open_opts = NULL;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002247 char *options = NULL;
Max Reitzcc84d902013-09-06 17:14:26 +02002248 Error *local_err = NULL;
Max Reitz3d96cb92019-05-07 22:35:02 +02002249 bool writethrough, src_writethrough, image_opts = false,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002250 skip_create = false, progress = false, tgt_image_opts = false;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002251 int64_t ret = -EINVAL;
Fam Zheng335e9932017-05-03 00:35:39 +08002252 bool force_share = false;
Fam Zhenge11ce122018-07-27 11:34:01 +08002253 bool explict_min_sparse = false;
Eric Blake15e39ad2020-05-21 14:21:36 -05002254 bool bitmaps = false;
Eric Blake955171e2021-07-21 10:53:48 -05002255 bool skip_broken = false;
Zhengui0c8c4892020-10-20 14:47:44 +00002256 int64_t rate_limit = 0;
bellardea2384d2004-08-01 21:59:26 +00002257
Peter Lieven9fd77f92017-04-21 11:11:55 +02002258 ImgConvertState s = (ImgConvertState) {
2259 /* Need at least 4k of zeros for sparse detection */
2260 .min_sparse = 8,
Fam Zhenge11ce122018-07-27 11:34:01 +08002261 .copy_range = false,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002262 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2263 .wr_in_order = true,
2264 .num_coroutines = 8,
2265 };
2266
bellardea2384d2004-08-01 21:59:26 +00002267 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002268 static const struct option long_options[] = {
2269 {"help", no_argument, 0, 'h'},
2270 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002271 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002272 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002273 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
Max Reitz8eaac022019-05-07 22:35:03 +02002274 {"salvage", no_argument, 0, OPTION_SALVAGE},
David Edmondson168468f2020-02-05 11:02:48 +00002275 {"target-is-zero", no_argument, 0, OPTION_TARGET_IS_ZERO},
Eric Blake15e39ad2020-05-21 14:21:36 -05002276 {"bitmaps", no_argument, 0, OPTION_BITMAPS},
Eric Blake955171e2021-07-21 10:53:48 -05002277 {"skip-broken-bitmaps", no_argument, 0, OPTION_SKIP_BROKEN},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002278 {0, 0, 0, 0}
2279 };
Eric Blake1899bf42021-09-13 08:17:35 -05002280 c = getopt_long(argc, argv, ":hf:O:B:CcF:o:l:S:pt:T:qnm:WUr:",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002281 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002282 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002283 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002284 }
bellardea2384d2004-08-01 21:59:26 +00002285 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002286 case ':':
2287 missing_argument(argv[optind - 1]);
2288 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002289 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002290 unrecognized_option(argv[optind - 1]);
2291 break;
bellardea2384d2004-08-01 21:59:26 +00002292 case 'h':
2293 help();
2294 break;
2295 case 'f':
2296 fmt = optarg;
2297 break;
2298 case 'O':
2299 out_fmt = optarg;
2300 break;
thsf58c7b32008-06-05 21:53:49 +00002301 case 'B':
2302 out_baseimg = optarg;
2303 break;
Fam Zhenge11ce122018-07-27 11:34:01 +08002304 case 'C':
2305 s.copy_range = true;
2306 break;
bellardea2384d2004-08-01 21:59:26 +00002307 case 'c':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002308 s.compressed = true;
bellardea2384d2004-08-01 21:59:26 +00002309 break;
Eric Blake1899bf42021-09-13 08:17:35 -05002310 case 'F':
2311 backing_fmt = optarg;
2312 break;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002313 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02002314 if (accumulate_options(&options, optarg) < 0) {
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002315 goto fail_getopt;
Kevin Wolf2dc83282014-02-21 16:24:05 +01002316 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002317 break;
Wenchao Xiaef806542013-12-04 17:10:57 +08002318 case 'l':
2319 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
Markus Armbruster70b94332015-02-13 12:50:26 +01002320 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2321 optarg, false);
Wenchao Xiaef806542013-12-04 17:10:57 +08002322 if (!sn_opts) {
2323 error_report("Failed in parsing snapshot param '%s'",
2324 optarg);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002325 goto fail_getopt;
Wenchao Xiaef806542013-12-04 17:10:57 +08002326 }
2327 } else {
2328 snapshot_name = optarg;
2329 }
2330 break;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002331 case 'S':
2332 {
2333 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +01002334
Eyal Moscovici43d589b2020-05-13 16:36:26 +03002335 sval = cvtnum("buffer size for sparse output", optarg);
2336 if (sval < 0) {
2337 goto fail_getopt;
2338 } else if (!QEMU_IS_ALIGNED(sval, BDRV_SECTOR_SIZE) ||
Peter Lieven6360ab22018-07-13 09:15:39 +02002339 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2340 error_report("Invalid buffer size for sparse output specified. "
2341 "Valid sizes are multiples of %llu up to %llu. Select "
2342 "0 to disable sparse detection (fully allocates output).",
2343 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002344 goto fail_getopt;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002345 }
2346
Peter Lieven9fd77f92017-04-21 11:11:55 +02002347 s.min_sparse = sval / BDRV_SECTOR_SIZE;
Fam Zhenge11ce122018-07-27 11:34:01 +08002348 explict_min_sparse = true;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002349 break;
2350 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002351 case 'p':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002352 progress = true;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002353 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002354 case 't':
2355 cache = optarg;
2356 break;
Max Reitz40055952014-07-22 22:58:42 +02002357 case 'T':
2358 src_cache = optarg;
2359 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002360 case 'q':
Max Reitz3d96cb92019-05-07 22:35:02 +02002361 s.quiet = true;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002362 break;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002363 case 'n':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002364 skip_create = true;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002365 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002366 case 'm':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002367 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2368 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002369 error_report("Invalid number of coroutines. Allowed number of"
2370 " coroutines is between 1 and %d", MAX_COROUTINES);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002371 goto fail_getopt;
2372 }
2373 break;
2374 case 'W':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002375 s.wr_in_order = false;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002376 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002377 case 'U':
2378 force_share = true;
2379 break;
Zhengui0c8c4892020-10-20 14:47:44 +00002380 case 'r':
2381 rate_limit = cvtnum("rate limit", optarg);
2382 if (rate_limit < 0) {
2383 goto fail_getopt;
2384 }
2385 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01002386 case OPTION_OBJECT:
2387 user_creatable_process_cmdline(optarg);
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002388 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002389 case OPTION_IMAGE_OPTS:
2390 image_opts = true;
2391 break;
Max Reitz8eaac022019-05-07 22:35:03 +02002392 case OPTION_SALVAGE:
2393 s.salvage = true;
2394 break;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002395 case OPTION_TARGET_IMAGE_OPTS:
2396 tgt_image_opts = true;
2397 break;
David Edmondson168468f2020-02-05 11:02:48 +00002398 case OPTION_TARGET_IS_ZERO:
2399 /*
2400 * The user asserting that the target is blank has the
2401 * same effect as the target driver supporting zero
2402 * initialisation.
2403 */
2404 s.has_zero_init = true;
2405 break;
Eric Blake15e39ad2020-05-21 14:21:36 -05002406 case OPTION_BITMAPS:
2407 bitmaps = true;
2408 break;
Eric Blake955171e2021-07-21 10:53:48 -05002409 case OPTION_SKIP_BROKEN:
2410 skip_broken = true;
2411 break;
bellardea2384d2004-08-01 21:59:26 +00002412 }
2413 }
ths3b46e622007-09-17 08:09:54 +00002414
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002415 if (!out_fmt && !tgt_image_opts) {
2416 out_fmt = "raw";
2417 }
2418
Eric Blake955171e2021-07-21 10:53:48 -05002419 if (skip_broken && !bitmaps) {
2420 error_report("Use of --skip-broken-bitmaps requires --bitmaps");
2421 goto fail_getopt;
2422 }
2423
Fam Zhenge11ce122018-07-27 11:34:01 +08002424 if (s.compressed && s.copy_range) {
2425 error_report("Cannot enable copy offloading when -c is used");
2426 goto fail_getopt;
2427 }
2428
2429 if (explict_min_sparse && s.copy_range) {
2430 error_report("Cannot enable copy offloading when -S is used");
2431 goto fail_getopt;
2432 }
2433
Max Reitz8eaac022019-05-07 22:35:03 +02002434 if (s.copy_range && s.salvage) {
2435 error_report("Cannot use copy offloading in salvaging mode");
2436 goto fail_getopt;
2437 }
2438
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002439 if (tgt_image_opts && !skip_create) {
2440 error_report("--target-image-opts requires use of -n flag");
2441 goto fail_getopt;
2442 }
2443
Kevin Wolfffd8e8f2019-08-09 11:09:21 +02002444 if (skip_create && options) {
Eric Blake25956af2020-07-06 15:39:46 -05002445 error_report("-o has no effect when skipping image creation");
2446 goto fail_getopt;
Kevin Wolfffd8e8f2019-08-09 11:09:21 +02002447 }
2448
David Edmondson168468f2020-02-05 11:02:48 +00002449 if (s.has_zero_init && !skip_create) {
2450 error_report("--target-is-zero requires use of -n flag");
2451 goto fail_getopt;
2452 }
2453
Peter Lieven9fd77f92017-04-21 11:11:55 +02002454 s.src_num = argc - optind - 1;
2455 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2456
2457 if (options && has_help_option(options)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002458 if (out_fmt) {
2459 ret = print_block_option_help(out_filename, out_fmt);
2460 goto fail_getopt;
2461 } else {
2462 error_report("Option help requires a format be specified");
2463 goto fail_getopt;
2464 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002465 }
2466
2467 if (s.src_num < 1) {
2468 error_report("Must specify image file name");
2469 goto fail_getopt;
2470 }
2471
Peter Lieven9fd77f92017-04-21 11:11:55 +02002472 /* ret is still -EINVAL until here */
2473 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2474 if (ret < 0) {
2475 error_report("Invalid source cache option: %s", src_cache);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002476 goto fail_getopt;
2477 }
2478
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002479 /* Initialize before goto out */
Max Reitz3d96cb92019-05-07 22:35:02 +02002480 if (s.quiet) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002481 progress = false;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002482 }
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002483 qemu_progress_init(progress, 1.0);
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002484 qemu_progress_print(0, 100);
2485
Peter Lieven9fd77f92017-04-21 11:11:55 +02002486 s.src = g_new0(BlockBackend *, s.src_num);
2487 s.src_sectors = g_new(int64_t, s.src_num);
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002488 s.src_alignment = g_new(int, s.src_num);
balrog926c2d22007-10-31 01:11:44 +00002489
Peter Lieven9fd77f92017-04-21 11:11:55 +02002490 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002491 BlockDriverState *src_bs;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002492 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
Max Reitz3d96cb92019-05-07 22:35:02 +02002493 fmt, src_flags, src_writethrough, s.quiet,
Fam Zheng335e9932017-05-03 00:35:39 +08002494 force_share);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002495 if (!s.src[bs_i]) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002496 ret = -1;
2497 goto out;
2498 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002499 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2500 if (s.src_sectors[bs_i] < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002501 error_report("Could not get size of %s: %s",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002502 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002503 ret = -1;
2504 goto out;
2505 }
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002506 src_bs = blk_bs(s.src[bs_i]);
2507 s.src_alignment[bs_i] = DIV_ROUND_UP(src_bs->bl.request_alignment,
2508 BDRV_SECTOR_SIZE);
2509 if (!bdrv_get_info(src_bs, &bdi)) {
2510 s.src_alignment[bs_i] = MAX(s.src_alignment[bs_i],
2511 bdi.cluster_size / BDRV_SECTOR_SIZE);
2512 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002513 s.total_sectors += s.src_sectors[bs_i];
balrog926c2d22007-10-31 01:11:44 +00002514 }
bellardea2384d2004-08-01 21:59:26 +00002515
Wenchao Xiaef806542013-12-04 17:10:57 +08002516 if (sn_opts) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002517 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
Peter Maydell10d6eda2017-02-10 16:28:24 +00002518 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2519 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2520 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002521 } else if (snapshot_name != NULL) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002522 if (s.src_num > 1) {
Markus Armbruster6daf1942011-06-22 14:03:54 +02002523 error_report("No support for concatenating multiple snapshot");
edison51ef6722010-09-21 19:58:41 -07002524 ret = -1;
2525 goto out;
2526 }
Wenchao Xia7b4c4782013-12-04 17:10:54 +08002527
Peter Lieven9fd77f92017-04-21 11:11:55 +02002528 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2529 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002530 }
Markus Armbruster84d18f02014-01-30 15:07:28 +01002531 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002532 error_reportf_err(local_err, "Failed to load snapshot: ");
Wenchao Xiaef806542013-12-04 17:10:57 +08002533 ret = -1;
2534 goto out;
edison51ef6722010-09-21 19:58:41 -07002535 }
2536
Max Reitz2e024cd2015-02-11 09:58:46 -05002537 if (!skip_create) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002538 /* Find driver and parse its options */
2539 drv = bdrv_find_format(out_fmt);
2540 if (!drv) {
2541 error_report("Unknown file format '%s'", out_fmt);
2542 ret = -1;
2543 goto out;
2544 }
2545
2546 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2547 if (!proto_drv) {
2548 error_report_err(local_err);
2549 ret = -1;
2550 goto out;
2551 }
2552
Max Reitz2e024cd2015-02-11 09:58:46 -05002553 if (!drv->create_opts) {
2554 error_report("Format driver '%s' does not support image creation",
2555 drv->format_name);
2556 ret = -1;
2557 goto out;
2558 }
Max Reitzf75613c2014-12-02 18:32:46 +01002559
Max Reitz2e024cd2015-02-11 09:58:46 -05002560 if (!proto_drv->create_opts) {
2561 error_report("Protocol driver '%s' does not support image creation",
2562 proto_drv->format_name);
2563 ret = -1;
2564 goto out;
2565 }
Max Reitzf75613c2014-12-02 18:32:46 +01002566
Max Reitz2e024cd2015-02-11 09:58:46 -05002567 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2568 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfdb08adf2009-06-04 15:39:38 +02002569
Max Reitz2e024cd2015-02-11 09:58:46 -05002570 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002571 if (options) {
Markus Armbruster235e59c2020-07-07 18:05:42 +02002572 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
Markus Armbruster97a2ca72015-03-14 10:23:15 +01002573 error_report_err(local_err);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002574 ret = -1;
2575 goto out;
2576 }
Max Reitz2e024cd2015-02-11 09:58:46 -05002577 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002578
Yi Lic075c422020-08-19 09:36:07 +08002579 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
2580 s.total_sectors * BDRV_SECTOR_SIZE, &error_abort);
Eric Blake1899bf42021-09-13 08:17:35 -05002581 ret = add_old_style_options(out_fmt, opts, out_baseimg, backing_fmt);
Max Reitz2e024cd2015-02-11 09:58:46 -05002582 if (ret < 0) {
2583 goto out;
2584 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002585 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002586
Kevin Wolfa18953f2010-10-14 15:46:04 +02002587 /* Get backing file name if -o backing_file was used */
Chunyan Liu83d05212014-06-05 17:20:51 +08002588 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
Kevin Wolfa18953f2010-10-14 15:46:04 +02002589 if (out_baseimg_param) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002590 out_baseimg = out_baseimg_param;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002591 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002592 s.target_has_backing = (bool) out_baseimg;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002593
David Edmondson168468f2020-02-05 11:02:48 +00002594 if (s.has_zero_init && s.target_has_backing) {
2595 error_report("Cannot use --target-is-zero when the destination "
2596 "image has a backing file");
2597 goto out;
2598 }
2599
Max Reitz48758a82017-04-26 15:46:48 +02002600 if (s.src_num > 1 && out_baseimg) {
2601 error_report("Having a backing file for the target makes no sense when "
2602 "concatenating multiple input images");
2603 ret = -1;
2604 goto out;
2605 }
2606
Eric Blaked9f059a2020-07-06 15:39:54 -05002607 if (out_baseimg_param) {
2608 if (!qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT)) {
Eric Blake497a30d2021-05-03 14:36:00 -07002609 error_report("Use of backing file requires explicit "
2610 "backing format");
2611 ret = -1;
2612 goto out;
Eric Blaked9f059a2020-07-06 15:39:54 -05002613 }
2614 }
2615
Kevin Wolfefa84d42009-05-18 16:42:12 +02002616 /* Check if compression is supported */
Peter Lieven9fd77f92017-04-21 11:11:55 +02002617 if (s.compressed) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002618 bool encryption =
2619 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002620 const char *encryptfmt =
2621 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
Chunyan Liu83d05212014-06-05 17:20:51 +08002622 const char *preallocation =
2623 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
Kevin Wolfefa84d42009-05-18 16:42:12 +02002624
Vladimir Sementsov-Ogievskiyac850bf2019-06-04 19:15:06 +03002625 if (drv && !block_driver_can_compress(drv)) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002626 error_report("Compression not supported for this file format");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002627 ret = -1;
2628 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002629 }
2630
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002631 if (encryption || encryptfmt) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002632 error_report("Compression and encryption not supported at "
2633 "the same time");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002634 ret = -1;
2635 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002636 }
Kevin Wolf41521fa2011-10-18 16:19:42 +02002637
Chunyan Liu83d05212014-06-05 17:20:51 +08002638 if (preallocation
2639 && strcmp(preallocation, "off"))
Kevin Wolf41521fa2011-10-18 16:19:42 +02002640 {
2641 error_report("Compression and preallocation not supported at "
2642 "the same time");
2643 ret = -1;
2644 goto out;
2645 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002646 }
2647
Eric Blake15e39ad2020-05-21 14:21:36 -05002648 /* Determine if bitmaps need copying */
2649 if (bitmaps) {
2650 if (s.src_num > 1) {
2651 error_report("Copying bitmaps only possible with single source");
2652 ret = -1;
2653 goto out;
2654 }
Eric Blake955171e2021-07-21 10:53:48 -05002655 ret = convert_check_bitmaps(blk_bs(s.src[0]), skip_broken);
Eric Blake74a43202021-07-09 10:39:50 -05002656 if (ret < 0) {
Eric Blake15e39ad2020-05-21 14:21:36 -05002657 goto out;
2658 }
2659 }
2660
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002661 /*
2662 * The later open call will need any decryption secrets, and
2663 * bdrv_create() will purge "opts", so extract them now before
2664 * they are lost.
2665 */
2666 if (!skip_create) {
2667 open_opts = qdict_new();
2668 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002669
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002670 /* Create the new image */
Chunyan Liuc282e1f2014-06-05 17:21:11 +08002671 ret = bdrv_create(drv, out_filename, opts, &local_err);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002672 if (ret < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002673 error_reportf_err(local_err, "%s: error while converting %s: ",
2674 out_filename, out_fmt);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002675 goto out;
bellardea2384d2004-08-01 21:59:26 +00002676 }
2677 }
ths3b46e622007-09-17 08:09:54 +00002678
Max Reitz4d7c4872019-07-24 19:12:29 +02002679 s.target_is_new = !skip_create;
2680
Peter Lieven9fd77f92017-04-21 11:11:55 +02002681 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
Kevin Wolfce099542016-03-15 13:01:04 +01002682 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002683 if (ret < 0) {
2684 error_report("Invalid cache option: %s", cache);
Markus Armbrusterbb9cd2e2014-05-28 11:17:07 +02002685 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002686 }
2687
Hanna Reitza1c62432021-08-19 12:12:00 +02002688 if (flags & BDRV_O_NOCACHE) {
2689 /*
2690 * If we open the target with O_DIRECT, it may be necessary to
2691 * extend its size to align to the physical sector size.
2692 */
2693 flags |= BDRV_O_RESIZE;
2694 }
2695
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002696 if (skip_create) {
2697 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002698 flags, writethrough, s.quiet, false);
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002699 } else {
2700 /* TODO ultimately we should allow --target-image-opts
2701 * to be used even when -n is not given.
2702 * That has to wait for bdrv_create to be improved
2703 * to allow filenames in option syntax
2704 */
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002705 s.target = img_open_file(out_filename, open_opts, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002706 flags, writethrough, s.quiet, false);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002707 open_opts = NULL; /* blk_new_open will have freed it */
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002708 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002709 if (!s.target) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002710 ret = -1;
2711 goto out;
2712 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002713 out_bs = blk_bs(s.target);
bellardea2384d2004-08-01 21:59:26 +00002714
Eric Blake15e39ad2020-05-21 14:21:36 -05002715 if (bitmaps && !bdrv_supports_persistent_dirty_bitmap(out_bs)) {
2716 error_report("Format driver '%s' does not support bitmaps",
2717 out_bs->drv->format_name);
2718 ret = -1;
2719 goto out;
2720 }
2721
Vladimir Sementsov-Ogievskiyac850bf2019-06-04 19:15:06 +03002722 if (s.compressed && !block_driver_can_compress(out_bs->drv)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002723 error_report("Compression not supported for this file format");
2724 ret = -1;
2725 goto out;
2726 }
2727
Eric Blake5def6b82016-06-23 16:37:19 -06002728 /* increase bufsectors from the default 4096 (2M) if opt_transfer
Peter Lieven6360ab22018-07-13 09:15:39 +02002729 * or discard_alignment of the out_bs is greater. Limit to
2730 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2731 s.buf_sectors = MIN(MAX_BUF_SECTORS,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002732 MAX(s.buf_sectors,
2733 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2734 out_bs->bl.pdiscard_alignment >>
2735 BDRV_SECTOR_BITS)));
Peter Lievenf2521c92013-11-27 11:07:06 +01002736
Peter Lieven8dcd3c92018-07-12 15:00:10 +02002737 /* try to align the write requests to the destination to avoid unnecessary
2738 * RMW cycles. */
2739 s.alignment = MAX(pow2floor(s.min_sparse),
2740 DIV_ROUND_UP(out_bs->bl.request_alignment,
2741 BDRV_SECTOR_SIZE));
2742 assert(is_power_of_2(s.alignment));
2743
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002744 if (skip_create) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002745 int64_t output_sectors = blk_nb_sectors(s.target);
Markus Armbruster43716fa2014-06-26 13:23:21 +02002746 if (output_sectors < 0) {
Gongleieec5eb42015-02-25 12:22:27 +08002747 error_report("unable to get output image length: %s",
Markus Armbruster43716fa2014-06-26 13:23:21 +02002748 strerror(-output_sectors));
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002749 ret = -1;
2750 goto out;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002751 } else if (output_sectors < s.total_sectors) {
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002752 error_report("output file is smaller than input file");
2753 ret = -1;
2754 goto out;
2755 }
2756 }
2757
Max Reitzc69291e2020-01-21 16:59:14 +01002758 if (s.target_has_backing && s.target_is_new) {
Max Reitz351c8ef2018-05-01 18:57:49 +02002759 /* Errors are treated as "backing length unknown" (which means
2760 * s.target_backing_sectors has to be negative, which it will
2761 * be automatically). The backing file length is used only
2762 * for optimizations, so such a case is not fatal. */
Kevin Wolfad747512023-10-27 17:53:17 +02002763 bdrv_graph_rdlock_main_loop();
Max Reitz4a2061e2019-06-12 19:00:30 +02002764 s.target_backing_sectors =
2765 bdrv_nb_sectors(bdrv_backing_chain_next(out_bs));
Kevin Wolfad747512023-10-27 17:53:17 +02002766 bdrv_graph_rdunlock_main_loop();
Max Reitz351c8ef2018-05-01 18:57:49 +02002767 } else {
2768 s.target_backing_sectors = -1;
2769 }
2770
Peter Lieven24f833c2013-11-27 11:07:07 +01002771 ret = bdrv_get_info(out_bs, &bdi);
2772 if (ret < 0) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002773 if (s.compressed) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002774 error_report("could not get block driver info");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002775 goto out;
2776 }
Peter Lieven24f833c2013-11-27 11:07:07 +01002777 } else {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002778 s.compressed = s.compressed || bdi.needs_compressed_writes;
2779 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
Peter Lieven24f833c2013-11-27 11:07:07 +01002780 }
2781
Zhengui0c8c4892020-10-20 14:47:44 +00002782 if (rate_limit) {
2783 set_rate_limit(s.target, rate_limit);
2784 }
2785
Peter Lieven9fd77f92017-04-21 11:11:55 +02002786 ret = convert_do_copy(&s);
Eric Blake15e39ad2020-05-21 14:21:36 -05002787
2788 /* Now copy the bitmaps */
2789 if (bitmaps && ret == 0) {
Eric Blake955171e2021-07-21 10:53:48 -05002790 ret = convert_copy_bitmaps(blk_bs(s.src[0]), out_bs, skip_broken);
Eric Blake15e39ad2020-05-21 14:21:36 -05002791 }
2792
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002793out:
Peter Lieven13c28af2013-11-27 11:07:01 +01002794 if (!ret) {
2795 qemu_progress_print(100, 0);
2796 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002797 qemu_progress_end();
Chunyan Liu83d05212014-06-05 17:20:51 +08002798 qemu_opts_del(opts);
2799 qemu_opts_free(create_opts);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002800 qobject_unref(open_opts);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002801 blk_unref(s.target);
2802 if (s.src) {
2803 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2804 blk_unref(s.src[bs_i]);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002805 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002806 g_free(s.src);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002807 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002808 g_free(s.src_sectors);
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002809 g_free(s.src_alignment);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002810fail_getopt:
Tuguoyi6aec8302020-11-02 09:04:57 +00002811 qemu_opts_del(sn_opts);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002812 g_free(options);
2813
Peter Lieven9fd77f92017-04-21 11:11:55 +02002814 return !!ret;
bellardea2384d2004-08-01 21:59:26 +00002815}
2816
bellard57d1a2b2004-08-03 21:15:11 +00002817
bellardfaea38e2006-08-05 21:31:00 +00002818static void dump_snapshots(BlockDriverState *bs)
2819{
2820 QEMUSnapshotInfo *sn_tab, *sn;
2821 int nb_sns, i;
bellardfaea38e2006-08-05 21:31:00 +00002822
2823 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2824 if (nb_sns <= 0)
2825 return;
2826 printf("Snapshot list:\n");
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002827 bdrv_snapshot_dump(NULL);
Wenchao Xia5b917042013-05-25 11:09:45 +08002828 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002829 for(i = 0; i < nb_sns; i++) {
2830 sn = &sn_tab[i];
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002831 bdrv_snapshot_dump(sn);
Wenchao Xia5b917042013-05-25 11:09:45 +08002832 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002833 }
Anthony Liguori7267c092011-08-20 22:09:37 -05002834 g_free(sn_tab);
bellardfaea38e2006-08-05 21:31:00 +00002835}
2836
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02002837static void dump_json_block_graph_info_list(BlockGraphInfoList *list)
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002838{
Markus Armbrustereab3a462020-12-11 18:11:37 +01002839 GString *str;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002840 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002841 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002842
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02002843 visit_type_BlockGraphInfoList(v, NULL, &list, &error_abort);
Eric Blake3b098d52016-06-09 10:48:43 -06002844 visit_complete(v, &obj);
Markus Armbruster6589f452020-12-11 18:11:35 +01002845 str = qobject_to_json_pretty(obj, true);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002846 assert(str != NULL);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002847 printf("%s\n", str->str);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002848 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002849 visit_free(v);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002850 g_string_free(str, true);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002851}
2852
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02002853static void dump_json_block_graph_info(BlockGraphInfo *info)
Benoît Canetc054b3f2012-09-05 13:09:02 +02002854{
Markus Armbrustereab3a462020-12-11 18:11:37 +01002855 GString *str;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002856 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002857 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002858
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02002859 visit_type_BlockGraphInfo(v, NULL, &info, &error_abort);
Eric Blake3b098d52016-06-09 10:48:43 -06002860 visit_complete(v, &obj);
Markus Armbruster6589f452020-12-11 18:11:35 +01002861 str = qobject_to_json_pretty(obj, true);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002862 assert(str != NULL);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002863 printf("%s\n", str->str);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002864 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002865 visit_free(v);
Markus Armbrustereab3a462020-12-11 18:11:37 +01002866 g_string_free(str, true);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002867}
2868
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02002869static void dump_human_image_info(BlockGraphInfo *info, int indentation,
2870 const char *path)
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002871{
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02002872 BlockChildInfoList *children_list;
2873
Hanna Reitzd5701772022-06-20 18:27:04 +02002874 bdrv_node_info_dump(qapi_BlockGraphInfo_base(info), indentation,
2875 info->children == NULL);
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02002876
2877 for (children_list = info->children; children_list;
2878 children_list = children_list->next)
2879 {
2880 BlockChildInfo *child = children_list->value;
2881 g_autofree char *child_path = NULL;
2882
2883 printf("%*sChild node '%s%s':\n",
2884 indentation * 4, "", path, child->name);
2885 child_path = g_strdup_printf("%s%s/", path, child->name);
2886 dump_human_image_info(child->info, indentation + 1, child_path);
2887 }
2888}
2889
2890static void dump_human_image_info_list(BlockGraphInfoList *list)
2891{
2892 BlockGraphInfoList *elem;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002893 bool delim = false;
2894
2895 for (elem = list; elem; elem = elem->next) {
2896 if (delim) {
2897 printf("\n");
2898 }
2899 delim = true;
2900
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02002901 dump_human_image_info(elem->value, 0, "/");
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002902 }
2903}
2904
2905static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2906{
2907 return strcmp(a, b) == 0;
2908}
2909
2910/**
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02002911 * Open an image file chain and return an BlockGraphInfoList
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002912 *
2913 * @filename: topmost image filename
2914 * @fmt: topmost image format (may be NULL to autodetect)
2915 * @chain: true - enumerate entire backing file chain
2916 * false - only topmost image file
2917 *
Hanna Reitzb1f4cd12022-06-20 18:26:57 +02002918 * Returns a list of BlockNodeInfo objects or NULL if there was an error
2919 * opening an image file. If there was an error a message will have been
2920 * printed to stderr.
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002921 */
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02002922static BlockGraphInfoList *collect_image_info_list(bool image_opts,
2923 const char *filename,
2924 const char *fmt,
2925 bool chain, bool force_share)
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002926{
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02002927 BlockGraphInfoList *head = NULL;
2928 BlockGraphInfoList **tail = &head;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002929 GHashTable *filenames;
Wenchao Xia43526ec2013-06-06 12:27:58 +08002930 Error *err = NULL;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002931
2932 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2933
2934 while (filename) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02002935 BlockBackend *blk;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002936 BlockDriverState *bs;
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02002937 BlockGraphInfo *info;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002938
2939 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2940 error_report("Backing file '%s' creates an infinite loop.",
2941 filename);
2942 goto err;
2943 }
2944 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2945
Max Reitzefaa7c42016-03-16 19:54:38 +01002946 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002947 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2948 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002949 if (!blk) {
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002950 goto err;
2951 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002952 bs = blk_bs(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002953
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02002954 /*
2955 * Note that the returned BlockGraphInfo object will not have
2956 * information about this image's backing node, because we have opened
2957 * it with BDRV_O_NO_BACKING. Printing this object will therefore not
2958 * duplicate the backing chain information that we obtain by walking
2959 * the chain manually here.
2960 */
Kevin Wolf3db0c8b2023-05-10 22:35:57 +02002961 bdrv_graph_rdlock_main_loop();
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02002962 bdrv_query_block_graph_info(bs, &info, &err);
Kevin Wolf3db0c8b2023-05-10 22:35:57 +02002963 bdrv_graph_rdunlock_main_loop();
2964
Markus Armbruster84d18f02014-01-30 15:07:28 +01002965 if (err) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01002966 error_report_err(err);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002967 blk_unref(blk);
Wenchao Xia43526ec2013-06-06 12:27:58 +08002968 goto err;
Wenchao Xiafb0ed452013-06-06 12:27:57 +08002969 }
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002970
Eric Blakec3033fd2021-01-13 16:10:12 -06002971 QAPI_LIST_APPEND(tail, info);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002972
Markus Armbruster26f54e92014-10-07 13:59:04 +02002973 blk_unref(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002974
Stefan Hajnoczi0da7d132019-12-05 13:46:46 +00002975 /* Clear parameters that only apply to the topmost image */
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002976 filename = fmt = NULL;
Stefan Hajnoczi0da7d132019-12-05 13:46:46 +00002977 image_opts = false;
2978
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002979 if (chain) {
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002980 if (info->full_backing_filename) {
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002981 filename = info->full_backing_filename;
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002982 } else if (info->backing_filename) {
John Snow92d617a2015-12-14 14:55:15 -05002983 error_report("Could not determine absolute backing filename,"
2984 " but backing filename '%s' present",
2985 info->backing_filename);
2986 goto err;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002987 }
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002988 if (info->backing_filename_format) {
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002989 fmt = info->backing_filename_format;
2990 }
2991 }
2992 }
2993 g_hash_table_destroy(filenames);
2994 return head;
2995
2996err:
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02002997 qapi_free_BlockGraphInfoList(head);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002998 g_hash_table_destroy(filenames);
2999 return NULL;
3000}
3001
Benoît Canetc054b3f2012-09-05 13:09:02 +02003002static int img_info(int argc, char **argv)
3003{
3004 int c;
3005 OutputFormat output_format = OFORMAT_HUMAN;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003006 bool chain = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02003007 const char *filename, *fmt, *output;
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02003008 BlockGraphInfoList *list;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003009 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003010 bool force_share = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02003011
bellardea2384d2004-08-01 21:59:26 +00003012 fmt = NULL;
Benoît Canetc054b3f2012-09-05 13:09:02 +02003013 output = NULL;
bellardea2384d2004-08-01 21:59:26 +00003014 for(;;) {
Benoît Canetc054b3f2012-09-05 13:09:02 +02003015 int option_index = 0;
3016 static const struct option long_options[] = {
3017 {"help", no_argument, 0, 'h'},
3018 {"format", required_argument, 0, 'f'},
3019 {"output", required_argument, 0, OPTION_OUTPUT},
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003020 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003021 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003022 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003023 {"force-share", no_argument, 0, 'U'},
Benoît Canetc054b3f2012-09-05 13:09:02 +02003024 {0, 0, 0, 0}
3025 };
Fam Zheng335e9932017-05-03 00:35:39 +08003026 c = getopt_long(argc, argv, ":f:hU",
Benoît Canetc054b3f2012-09-05 13:09:02 +02003027 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003028 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00003029 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003030 }
bellardea2384d2004-08-01 21:59:26 +00003031 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003032 case ':':
3033 missing_argument(argv[optind - 1]);
3034 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003035 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003036 unrecognized_option(argv[optind - 1]);
3037 break;
bellardea2384d2004-08-01 21:59:26 +00003038 case 'h':
3039 help();
3040 break;
3041 case 'f':
3042 fmt = optarg;
3043 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003044 case 'U':
3045 force_share = true;
3046 break;
Benoît Canetc054b3f2012-09-05 13:09:02 +02003047 case OPTION_OUTPUT:
3048 output = optarg;
3049 break;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003050 case OPTION_BACKING_CHAIN:
3051 chain = true;
3052 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003053 case OPTION_OBJECT:
3054 user_creatable_process_cmdline(optarg);
3055 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003056 case OPTION_IMAGE_OPTS:
3057 image_opts = true;
3058 break;
bellardea2384d2004-08-01 21:59:26 +00003059 }
3060 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02003061 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003062 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003063 }
bellardea2384d2004-08-01 21:59:26 +00003064 filename = argv[optind++];
3065
Benoît Canetc054b3f2012-09-05 13:09:02 +02003066 if (output && !strcmp(output, "json")) {
3067 output_format = OFORMAT_JSON;
3068 } else if (output && !strcmp(output, "human")) {
3069 output_format = OFORMAT_HUMAN;
3070 } else if (output) {
3071 error_report("--output must be used with human or json as argument.");
3072 return 1;
3073 }
3074
Fam Zheng335e9932017-05-03 00:35:39 +08003075 list = collect_image_info_list(image_opts, filename, fmt, chain,
3076 force_share);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003077 if (!list) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003078 return 1;
3079 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02003080
Benoît Canetc054b3f2012-09-05 13:09:02 +02003081 switch (output_format) {
3082 case OFORMAT_HUMAN:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003083 dump_human_image_info_list(list);
Benoît Canetc054b3f2012-09-05 13:09:02 +02003084 break;
3085 case OFORMAT_JSON:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003086 if (chain) {
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02003087 dump_json_block_graph_info_list(list);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003088 } else {
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02003089 dump_json_block_graph_info(list->value);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003090 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02003091 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003092 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02003093
Hanna Reitzc04d0ab2022-06-20 18:27:03 +02003094 qapi_free_BlockGraphInfoList(list);
bellardea2384d2004-08-01 21:59:26 +00003095 return 0;
3096}
3097
Eric Blake30065d12019-03-26 13:40:43 -05003098static int dump_map_entry(OutputFormat output_format, MapEntry *e,
3099 MapEntry *next)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003100{
3101 switch (output_format) {
3102 case OFORMAT_HUMAN:
Fam Zheng16b0d552016-01-26 11:59:02 +08003103 if (e->data && !e->has_offset) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003104 error_report("File contains external, encrypted or compressed clusters.");
Eric Blake30065d12019-03-26 13:40:43 -05003105 return -1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003106 }
Fam Zheng16b0d552016-01-26 11:59:02 +08003107 if (e->data && !e->zero) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003108 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
Fam Zheng16b0d552016-01-26 11:59:02 +08003109 e->start, e->length,
3110 e->has_offset ? e->offset : 0,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003111 e->filename ?: "");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003112 }
3113 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
3114 * Modify the flags here to allow more coalescing.
3115 */
Fam Zheng16b0d552016-01-26 11:59:02 +08003116 if (next && (!next->data || next->zero)) {
3117 next->data = false;
3118 next->zero = true;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003119 }
3120 break;
3121 case OFORMAT_JSON:
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003122 printf("{ \"start\": %"PRId64", \"length\": %"PRId64","
Eric Blake8417e132021-07-01 14:06:55 -05003123 " \"depth\": %"PRId64", \"present\": %s, \"zero\": %s,"
Andrey Drobyshev via52b10c92023-09-08 00:02:26 +03003124 " \"data\": %s, \"compressed\": %s",
3125 e->start, e->length, e->depth,
Eric Blake8417e132021-07-01 14:06:55 -05003126 e->present ? "true" : "false",
Fam Zheng16b0d552016-01-26 11:59:02 +08003127 e->zero ? "true" : "false",
Andrey Drobyshev via52b10c92023-09-08 00:02:26 +03003128 e->data ? "true" : "false",
3129 e->compressed ? "true" : "false");
Fam Zheng16b0d552016-01-26 11:59:02 +08003130 if (e->has_offset) {
Paolo Bonzinic745bfb2013-09-11 18:47:52 +02003131 printf(", \"offset\": %"PRId64"", e->offset);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003132 }
3133 putchar('}');
3134
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003135 if (next) {
3136 puts(",");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003137 }
3138 break;
3139 }
Eric Blake30065d12019-03-26 13:40:43 -05003140 return 0;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003141}
3142
Eric Blake5e344dd2017-10-11 22:47:02 -05003143static int get_block_status(BlockDriverState *bs, int64_t offset,
3144 int64_t bytes, MapEntry *e)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003145{
Eric Blake237d78f2017-10-11 22:47:03 -05003146 int ret;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003147 int depth;
Fam Zheng67a0fd22016-01-26 11:58:48 +08003148 BlockDriverState *file;
John Snow28756452016-02-05 13:12:33 -05003149 bool has_offset;
Eric Blake237d78f2017-10-11 22:47:03 -05003150 int64_t map;
Max Reitzf30c66b2019-02-01 20:29:05 +01003151 char *filename = NULL;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003152
Kevin Wolfad747512023-10-27 17:53:17 +02003153 GLOBAL_STATE_CODE();
3154 GRAPH_RDLOCK_GUARD_MAINLOOP();
3155
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003156 /* As an optimization, we could cache the current range of unallocated
3157 * clusters in each file of the chain, and avoid querying the same
3158 * range repeatedly.
3159 */
3160
3161 depth = 0;
3162 for (;;) {
Max Reitz4a2061e2019-06-12 19:00:30 +02003163 bs = bdrv_skip_filters(bs);
Eric Blake237d78f2017-10-11 22:47:03 -05003164 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003165 if (ret < 0) {
3166 return ret;
3167 }
Eric Blake237d78f2017-10-11 22:47:03 -05003168 assert(bytes);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003169 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
3170 break;
3171 }
Max Reitz4a2061e2019-06-12 19:00:30 +02003172 bs = bdrv_cow_bs(bs);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003173 if (bs == NULL) {
3174 ret = 0;
3175 break;
3176 }
3177
3178 depth++;
3179 }
3180
John Snow28756452016-02-05 13:12:33 -05003181 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
3182
Max Reitzf30c66b2019-02-01 20:29:05 +01003183 if (file && has_offset) {
3184 bdrv_refresh_filename(file);
3185 filename = file->filename;
3186 }
3187
John Snow28756452016-02-05 13:12:33 -05003188 *e = (MapEntry) {
Eric Blake5e344dd2017-10-11 22:47:02 -05003189 .start = offset,
Eric Blake237d78f2017-10-11 22:47:03 -05003190 .length = bytes,
John Snow28756452016-02-05 13:12:33 -05003191 .data = !!(ret & BDRV_BLOCK_DATA),
3192 .zero = !!(ret & BDRV_BLOCK_ZERO),
Andrey Drobyshev via52b10c92023-09-08 00:02:26 +03003193 .compressed = !!(ret & BDRV_BLOCK_COMPRESSED),
Eric Blake237d78f2017-10-11 22:47:03 -05003194 .offset = map,
John Snow28756452016-02-05 13:12:33 -05003195 .has_offset = has_offset,
3196 .depth = depth,
Eric Blake8417e132021-07-01 14:06:55 -05003197 .present = !!(ret & BDRV_BLOCK_ALLOCATED),
Max Reitzf30c66b2019-02-01 20:29:05 +01003198 .filename = filename,
John Snow28756452016-02-05 13:12:33 -05003199 };
3200
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003201 return 0;
3202}
3203
Fam Zheng16b0d552016-01-26 11:59:02 +08003204static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
3205{
3206 if (curr->length == 0) {
3207 return false;
3208 }
3209 if (curr->zero != next->zero ||
3210 curr->data != next->data ||
Andrey Drobyshev via52b10c92023-09-08 00:02:26 +03003211 curr->compressed != next->compressed ||
Fam Zheng16b0d552016-01-26 11:59:02 +08003212 curr->depth != next->depth ||
Eric Blake8417e132021-07-01 14:06:55 -05003213 curr->present != next->present ||
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003214 !curr->filename != !next->filename ||
Fam Zheng16b0d552016-01-26 11:59:02 +08003215 curr->has_offset != next->has_offset) {
3216 return false;
3217 }
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003218 if (curr->filename && strcmp(curr->filename, next->filename)) {
Fam Zheng16b0d552016-01-26 11:59:02 +08003219 return false;
3220 }
3221 if (curr->has_offset && curr->offset + curr->length != next->offset) {
3222 return false;
3223 }
3224 return true;
3225}
3226
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003227static int img_map(int argc, char **argv)
3228{
3229 int c;
3230 OutputFormat output_format = OFORMAT_HUMAN;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003231 BlockBackend *blk;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003232 BlockDriverState *bs;
3233 const char *filename, *fmt, *output;
3234 int64_t length;
3235 MapEntry curr = { .length = 0 }, next;
3236 int ret = 0;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003237 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003238 bool force_share = false;
Eyal Moscovicic0469492020-05-13 16:36:29 +03003239 int64_t start_offset = 0;
3240 int64_t max_length = -1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003241
3242 fmt = NULL;
3243 output = NULL;
3244 for (;;) {
3245 int option_index = 0;
3246 static const struct option long_options[] = {
3247 {"help", no_argument, 0, 'h'},
3248 {"format", required_argument, 0, 'f'},
3249 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003250 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003251 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003252 {"force-share", no_argument, 0, 'U'},
Eyal Moscovicic0469492020-05-13 16:36:29 +03003253 {"start-offset", required_argument, 0, 's'},
3254 {"max-length", required_argument, 0, 'l'},
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003255 {0, 0, 0, 0}
3256 };
Eyal Moscovicic0469492020-05-13 16:36:29 +03003257 c = getopt_long(argc, argv, ":f:s:l:hU",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003258 long_options, &option_index);
3259 if (c == -1) {
3260 break;
3261 }
3262 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003263 case ':':
3264 missing_argument(argv[optind - 1]);
3265 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003266 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003267 unrecognized_option(argv[optind - 1]);
3268 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003269 case 'h':
3270 help();
3271 break;
3272 case 'f':
3273 fmt = optarg;
3274 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003275 case 'U':
3276 force_share = true;
3277 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003278 case OPTION_OUTPUT:
3279 output = optarg;
3280 break;
Eyal Moscovicic0469492020-05-13 16:36:29 +03003281 case 's':
3282 start_offset = cvtnum("start offset", optarg);
3283 if (start_offset < 0) {
3284 return 1;
3285 }
3286 break;
3287 case 'l':
3288 max_length = cvtnum("max length", optarg);
3289 if (max_length < 0) {
3290 return 1;
3291 }
3292 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003293 case OPTION_OBJECT:
3294 user_creatable_process_cmdline(optarg);
3295 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003296 case OPTION_IMAGE_OPTS:
3297 image_opts = true;
3298 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003299 }
3300 }
Fam Zhengac1307a2014-04-22 13:36:11 +08003301 if (optind != argc - 1) {
3302 error_exit("Expecting one image file name");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003303 }
Fam Zhengac1307a2014-04-22 13:36:11 +08003304 filename = argv[optind];
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003305
3306 if (output && !strcmp(output, "json")) {
3307 output_format = OFORMAT_JSON;
3308 } else if (output && !strcmp(output, "human")) {
3309 output_format = OFORMAT_HUMAN;
3310 } else if (output) {
3311 error_report("--output must be used with human or json as argument.");
3312 return 1;
3313 }
3314
Fam Zheng335e9932017-05-03 00:35:39 +08003315 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003316 if (!blk) {
3317 return 1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003318 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003319 bs = blk_bs(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003320
3321 if (output_format == OFORMAT_HUMAN) {
3322 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003323 } else if (output_format == OFORMAT_JSON) {
3324 putchar('[');
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003325 }
3326
Max Reitzf1d3cd72015-02-05 13:58:18 -05003327 length = blk_getlength(blk);
Eyal Moscovici8f282e82020-05-13 16:36:27 +03003328 if (length < 0) {
3329 error_report("Failed to get size for '%s'", filename);
3330 return 1;
3331 }
Eyal Moscovicic0469492020-05-13 16:36:29 +03003332 if (max_length != -1) {
3333 length = MIN(start_offset + max_length, length);
3334 }
Eyal Moscovici8f282e82020-05-13 16:36:27 +03003335
Eyal Moscovicic0469492020-05-13 16:36:29 +03003336 curr.start = start_offset;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003337 while (curr.start + curr.length < length) {
Eric Blake5e344dd2017-10-11 22:47:02 -05003338 int64_t offset = curr.start + curr.length;
Kevin Wolfd0ceea82020-07-07 16:46:29 +02003339 int64_t n = length - offset;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003340
Eric Blake5e344dd2017-10-11 22:47:02 -05003341 ret = get_block_status(bs, offset, n, &next);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003342 if (ret < 0) {
3343 error_report("Could not read file metadata: %s", strerror(-ret));
3344 goto out;
3345 }
3346
Fam Zheng16b0d552016-01-26 11:59:02 +08003347 if (entry_mergeable(&curr, &next)) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003348 curr.length += next.length;
3349 continue;
3350 }
3351
3352 if (curr.length > 0) {
Eric Blake30065d12019-03-26 13:40:43 -05003353 ret = dump_map_entry(output_format, &curr, &next);
3354 if (ret < 0) {
3355 goto out;
3356 }
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003357 }
3358 curr = next;
3359 }
3360
Eric Blake30065d12019-03-26 13:40:43 -05003361 ret = dump_map_entry(output_format, &curr, NULL);
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003362 if (output_format == OFORMAT_JSON) {
3363 puts("]");
3364 }
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003365
3366out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003367 blk_unref(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003368 return ret < 0;
3369}
3370
aliguorif7b4a942009-01-07 17:40:15 +00003371#define SNAPSHOT_LIST 1
3372#define SNAPSHOT_CREATE 2
3373#define SNAPSHOT_APPLY 3
3374#define SNAPSHOT_DELETE 4
3375
Stuart Brady153859b2009-06-07 00:42:17 +01003376static int img_snapshot(int argc, char **argv)
aliguorif7b4a942009-01-07 17:40:15 +00003377{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003378 BlockBackend *blk;
aliguorif7b4a942009-01-07 17:40:15 +00003379 BlockDriverState *bs;
3380 QEMUSnapshotInfo sn;
3381 char *filename, *snapshot_name = NULL;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003382 int c, ret = 0, bdrv_oflags;
aliguorif7b4a942009-01-07 17:40:15 +00003383 int action = 0;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003384 bool quiet = false;
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003385 Error *err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003386 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003387 bool force_share = false;
Marc-André Lureauf793dde2022-03-07 11:04:00 +04003388 int64_t rt;
aliguorif7b4a942009-01-07 17:40:15 +00003389
Kevin Wolfce099542016-03-15 13:01:04 +01003390 bdrv_oflags = BDRV_O_RDWR;
aliguorif7b4a942009-01-07 17:40:15 +00003391 /* Parse commandline parameters */
3392 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003393 static const struct option long_options[] = {
3394 {"help", no_argument, 0, 'h'},
3395 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003396 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003397 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003398 {0, 0, 0, 0}
3399 };
Fam Zheng335e9932017-05-03 00:35:39 +08003400 c = getopt_long(argc, argv, ":la:c:d:hqU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003401 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003402 if (c == -1) {
aliguorif7b4a942009-01-07 17:40:15 +00003403 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003404 }
aliguorif7b4a942009-01-07 17:40:15 +00003405 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003406 case ':':
3407 missing_argument(argv[optind - 1]);
3408 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003409 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003410 unrecognized_option(argv[optind - 1]);
3411 break;
aliguorif7b4a942009-01-07 17:40:15 +00003412 case 'h':
3413 help();
Stuart Brady153859b2009-06-07 00:42:17 +01003414 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003415 case 'l':
3416 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003417 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003418 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003419 }
3420 action = SNAPSHOT_LIST;
Naphtali Spreif5edb012010-01-17 16:48:13 +02003421 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
aliguorif7b4a942009-01-07 17:40:15 +00003422 break;
3423 case 'a':
3424 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003425 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003426 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003427 }
3428 action = SNAPSHOT_APPLY;
3429 snapshot_name = optarg;
3430 break;
3431 case 'c':
3432 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003433 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003434 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003435 }
3436 action = SNAPSHOT_CREATE;
3437 snapshot_name = optarg;
3438 break;
3439 case 'd':
3440 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003441 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003442 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003443 }
3444 action = SNAPSHOT_DELETE;
3445 snapshot_name = optarg;
3446 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003447 case 'q':
3448 quiet = true;
3449 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003450 case 'U':
3451 force_share = true;
3452 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003453 case OPTION_OBJECT:
3454 user_creatable_process_cmdline(optarg);
3455 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003456 case OPTION_IMAGE_OPTS:
3457 image_opts = true;
3458 break;
aliguorif7b4a942009-01-07 17:40:15 +00003459 }
3460 }
3461
Kevin Wolffc11eb22013-08-05 10:53:04 +02003462 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003463 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003464 }
aliguorif7b4a942009-01-07 17:40:15 +00003465 filename = argv[optind++];
3466
3467 /* Open the image */
Fam Zheng335e9932017-05-03 00:35:39 +08003468 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3469 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003470 if (!blk) {
3471 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003472 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003473 bs = blk_bs(blk);
aliguorif7b4a942009-01-07 17:40:15 +00003474
3475 /* Perform the requested action */
3476 switch(action) {
3477 case SNAPSHOT_LIST:
3478 dump_snapshots(bs);
3479 break;
3480
3481 case SNAPSHOT_CREATE:
3482 memset(&sn, 0, sizeof(sn));
3483 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3484
Marc-André Lureauf793dde2022-03-07 11:04:00 +04003485 rt = g_get_real_time();
3486 sn.date_sec = rt / G_USEC_PER_SEC;
3487 sn.date_nsec = (rt % G_USEC_PER_SEC) * 1000;
aliguorif7b4a942009-01-07 17:40:15 +00003488
Kevin Wolfa32e7812023-09-29 16:51:42 +02003489 bdrv_graph_rdlock_main_loop();
aliguorif7b4a942009-01-07 17:40:15 +00003490 ret = bdrv_snapshot_create(bs, &sn);
Kevin Wolfa32e7812023-09-29 16:51:42 +02003491 bdrv_graph_rdunlock_main_loop();
3492
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003493 if (ret) {
Michael Tokarevb0a66202023-08-11 14:09:46 +03003494 error_report("Could not create snapshot '%s': %s",
3495 snapshot_name, strerror(-ret));
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003496 }
aliguorif7b4a942009-01-07 17:40:15 +00003497 break;
3498
3499 case SNAPSHOT_APPLY:
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003500 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003501 if (ret) {
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003502 error_reportf_err(err, "Could not apply snapshot '%s': ",
3503 snapshot_name);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003504 }
aliguorif7b4a942009-01-07 17:40:15 +00003505 break;
3506
3507 case SNAPSHOT_DELETE:
Kevin Wolfa32e7812023-09-29 16:51:42 +02003508 bdrv_graph_rdlock_main_loop();
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003509 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3510 if (ret < 0) {
3511 error_report("Could not delete snapshot '%s': snapshot not "
3512 "found", snapshot_name);
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003513 ret = 1;
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003514 } else {
3515 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3516 if (ret < 0) {
3517 error_reportf_err(err, "Could not delete snapshot '%s': ",
3518 snapshot_name);
3519 ret = 1;
3520 }
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003521 }
Kevin Wolfa32e7812023-09-29 16:51:42 +02003522 bdrv_graph_rdunlock_main_loop();
aliguorif7b4a942009-01-07 17:40:15 +00003523 break;
3524 }
3525
3526 /* Cleanup */
Markus Armbruster26f54e92014-10-07 13:59:04 +02003527 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003528 if (ret) {
3529 return 1;
3530 }
Stuart Brady153859b2009-06-07 00:42:17 +01003531 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003532}
3533
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003534static int img_rebase(int argc, char **argv)
3535{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003536 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
Paolo Bonzini396374c2016-02-25 23:53:54 +01003537 uint8_t *buf_old = NULL;
3538 uint8_t *buf_new = NULL;
Sam Eiderman863cc782019-05-23 19:33:36 +03003539 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
Kevin Wolf78a9c762023-10-27 17:53:21 +02003540 BlockDriverState *unfiltered_bs, *unfiltered_bs_cow;
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003541 BlockDriverInfo bdi = {0};
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003542 char *filename;
Max Reitz40055952014-07-22 22:58:42 +02003543 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3544 int c, flags, src_flags, ret;
Andrey Drobyshev26ea2782023-09-19 19:58:03 +03003545 BdrvRequestFlags write_flags = 0;
Kevin Wolfce099542016-03-15 13:01:04 +01003546 bool writethrough, src_writethrough;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003547 int unsafe = 0;
Fam Zheng335e9932017-05-03 00:35:39 +08003548 bool force_share = false;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003549 int progress = 0;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003550 bool quiet = false;
Andrey Drobyshev26ea2782023-09-19 19:58:03 +03003551 bool compress = false;
Max Reitz34b5d2c2013-09-05 14:45:29 +02003552 Error *local_err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003553 bool image_opts = false;
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003554 int64_t write_align;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003555
3556 /* Parse commandline parameters */
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003557 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003558 cache = BDRV_DEFAULT_CACHE;
Max Reitz40055952014-07-22 22:58:42 +02003559 src_cache = BDRV_DEFAULT_CACHE;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003560 out_baseimg = NULL;
3561 out_basefmt = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003562 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003563 static const struct option long_options[] = {
3564 {"help", no_argument, 0, 'h'},
3565 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003566 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003567 {"force-share", no_argument, 0, 'U'},
Andrey Drobyshev26ea2782023-09-19 19:58:03 +03003568 {"compress", no_argument, 0, 'c'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003569 {0, 0, 0, 0}
3570 };
Andrey Drobyshev26ea2782023-09-19 19:58:03 +03003571 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qUc",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003572 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003573 if (c == -1) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003574 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003575 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003576 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003577 case ':':
3578 missing_argument(argv[optind - 1]);
3579 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003580 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003581 unrecognized_option(argv[optind - 1]);
3582 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003583 case 'h':
3584 help();
3585 return 0;
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003586 case 'f':
3587 fmt = optarg;
3588 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003589 case 'F':
3590 out_basefmt = optarg;
3591 break;
3592 case 'b':
3593 out_baseimg = optarg;
3594 break;
3595 case 'u':
3596 unsafe = 1;
3597 break;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003598 case 'p':
3599 progress = 1;
3600 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003601 case 't':
3602 cache = optarg;
3603 break;
Max Reitz40055952014-07-22 22:58:42 +02003604 case 'T':
3605 src_cache = optarg;
3606 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003607 case 'q':
3608 quiet = true;
3609 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01003610 case OPTION_OBJECT:
3611 user_creatable_process_cmdline(optarg);
3612 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003613 case OPTION_IMAGE_OPTS:
3614 image_opts = true;
3615 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003616 case 'U':
3617 force_share = true;
3618 break;
Andrey Drobyshev26ea2782023-09-19 19:58:03 +03003619 case 'c':
3620 compress = true;
3621 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003622 }
3623 }
3624
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003625 if (quiet) {
3626 progress = 0;
3627 }
3628
Fam Zhengac1307a2014-04-22 13:36:11 +08003629 if (optind != argc - 1) {
3630 error_exit("Expecting one image file name");
3631 }
3632 if (!unsafe && !out_baseimg) {
3633 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003634 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003635 filename = argv[optind++];
3636
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003637 qemu_progress_init(progress, 2.0);
3638 qemu_progress_print(0, 100);
3639
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003640 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
Kevin Wolfce099542016-03-15 13:01:04 +01003641 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003642 if (ret < 0) {
3643 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003644 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003645 }
3646
Kevin Wolfce099542016-03-15 13:01:04 +01003647 src_flags = 0;
3648 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
Max Reitz40055952014-07-22 22:58:42 +02003649 if (ret < 0) {
3650 error_report("Invalid source cache option: %s", src_cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003651 goto out;
Max Reitz40055952014-07-22 22:58:42 +02003652 }
3653
Kevin Wolfce099542016-03-15 13:01:04 +01003654 /* The source files are opened read-only, don't care about WCE */
3655 assert((src_flags & BDRV_O_RDWR) == 0);
3656 (void) src_writethrough;
3657
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003658 /*
3659 * Open the images.
3660 *
3661 * Ignore the old backing file for unsafe rebase in case we want to correct
3662 * the reference to a renamed or moved backing file.
3663 */
Fam Zheng335e9932017-05-03 00:35:39 +08003664 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3665 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003666 if (!blk) {
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003667 ret = -1;
3668 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003669 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003670 bs = blk_bs(blk);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003671
Kevin Wolfad747512023-10-27 17:53:17 +02003672 bdrv_graph_rdlock_main_loop();
Max Reitz4a2061e2019-06-12 19:00:30 +02003673 unfiltered_bs = bdrv_skip_filters(bs);
Kevin Wolf78a9c762023-10-27 17:53:21 +02003674 unfiltered_bs_cow = bdrv_cow_bs(unfiltered_bs);
Kevin Wolfad747512023-10-27 17:53:17 +02003675 bdrv_graph_rdunlock_main_loop();
Max Reitz4a2061e2019-06-12 19:00:30 +02003676
Andrey Drobyshev26ea2782023-09-19 19:58:03 +03003677 if (compress && !block_driver_can_compress(unfiltered_bs->drv)) {
3678 error_report("Compression not supported for this file format");
3679 ret = -1;
3680 goto out;
3681 } else if (compress) {
3682 write_flags |= BDRV_REQ_WRITE_COMPRESSED;
3683 }
3684
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003685 if (out_basefmt != NULL) {
Max Reitz644483d2015-02-05 13:58:17 -05003686 if (bdrv_find_format(out_basefmt) == NULL) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003687 error_report("Invalid format name: '%s'", out_basefmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003688 ret = -1;
3689 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003690 }
3691 }
3692
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003693 /*
Andrey Drobyshev26ea2782023-09-19 19:58:03 +03003694 * We need overlay subcluster size (or cluster size in case writes are
3695 * compressed) to make sure write requests are aligned.
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003696 */
3697 ret = bdrv_get_info(unfiltered_bs, &bdi);
3698 if (ret < 0) {
3699 error_report("could not get block driver info");
3700 goto out;
3701 } else if (bdi.subcluster_size == 0) {
Andrey Drobyshev26ea2782023-09-19 19:58:03 +03003702 bdi.cluster_size = bdi.subcluster_size = 1;
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003703 }
3704
Andrey Drobyshev26ea2782023-09-19 19:58:03 +03003705 write_align = compress ? bdi.cluster_size : bdi.subcluster_size;
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003706
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003707 /* For safe rebasing we need to compare old and new backing file */
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003708 if (!unsafe) {
Max Reitz644483d2015-02-05 13:58:17 -05003709 QDict *options = NULL;
Kevin Wolf78a9c762023-10-27 17:53:21 +02003710 BlockDriverState *base_bs;
3711
3712 bdrv_graph_rdlock_main_loop();
3713 base_bs = bdrv_cow_bs(unfiltered_bs);
3714 bdrv_graph_rdunlock_main_loop();
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003715
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003716 if (base_bs) {
Kevin Wolfd861ab32019-04-25 14:25:10 +02003717 blk_old_backing = blk_new(qemu_get_aio_context(),
3718 BLK_PERM_CONSISTENT_READ,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003719 BLK_PERM_ALL);
3720 ret = blk_insert_bs(blk_old_backing, base_bs,
3721 &local_err);
3722 if (ret < 0) {
Max Reitz35ddd932019-05-09 19:52:35 +02003723 error_reportf_err(local_err,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003724 "Could not reuse old backing file '%s': ",
3725 base_bs->filename);
Max Reitz35ddd932019-05-09 19:52:35 +02003726 goto out;
3727 }
3728 } else {
3729 blk_old_backing = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003730 }
Max Reitz644483d2015-02-05 13:58:17 -05003731
Alex Bligha6166732012-10-16 13:46:18 +01003732 if (out_baseimg[0]) {
Max Reitzd16699b2018-05-09 20:20:01 +02003733 const char *overlay_filename;
3734 char *out_real_path;
3735
Fam Zheng335e9932017-05-03 00:35:39 +08003736 options = qdict_new();
Max Reitz644483d2015-02-05 13:58:17 -05003737 if (out_basefmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003738 qdict_put_str(options, "driver", out_basefmt);
Fam Zheng335e9932017-05-03 00:35:39 +08003739 }
3740 if (force_share) {
3741 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Max Reitz644483d2015-02-05 13:58:17 -05003742 }
3743
Kevin Wolfb7cfc7d2023-09-29 16:51:45 +02003744 bdrv_graph_rdlock_main_loop();
Max Reitzf30c66b2019-02-01 20:29:05 +01003745 bdrv_refresh_filename(bs);
Kevin Wolfb7cfc7d2023-09-29 16:51:45 +02003746 bdrv_graph_rdunlock_main_loop();
Max Reitzd16699b2018-05-09 20:20:01 +02003747 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3748 : bs->filename;
Max Reitz645ae7d2019-02-01 20:29:14 +01003749 out_real_path =
3750 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3751 out_baseimg,
3752 &local_err);
Max Reitzd16699b2018-05-09 20:20:01 +02003753 if (local_err) {
Max Reitzf22356d2019-05-28 21:53:38 +02003754 qobject_unref(options);
Max Reitzd16699b2018-05-09 20:20:01 +02003755 error_reportf_err(local_err,
3756 "Could not resolve backing filename: ");
3757 ret = -1;
Max Reitzd16699b2018-05-09 20:20:01 +02003758 goto out;
3759 }
3760
Sam Eiderman863cc782019-05-23 19:33:36 +03003761 /*
3762 * Find out whether we rebase an image on top of a previous image
3763 * in its chain.
3764 */
3765 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
Sam Eiderman330c7292019-05-23 19:33:37 +03003766 if (prefix_chain_bs) {
Max Reitzf22356d2019-05-28 21:53:38 +02003767 qobject_unref(options);
Sam Eiderman330c7292019-05-23 19:33:37 +03003768 g_free(out_real_path);
Max Reitzf22356d2019-05-28 21:53:38 +02003769
Kevin Wolfd861ab32019-04-25 14:25:10 +02003770 blk_new_backing = blk_new(qemu_get_aio_context(),
3771 BLK_PERM_CONSISTENT_READ,
Sam Eiderman330c7292019-05-23 19:33:37 +03003772 BLK_PERM_ALL);
3773 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
3774 &local_err);
3775 if (ret < 0) {
3776 error_reportf_err(local_err,
3777 "Could not reuse backing file '%s': ",
3778 out_baseimg);
3779 goto out;
3780 }
3781 } else {
3782 blk_new_backing = blk_new_open(out_real_path, NULL,
3783 options, src_flags, &local_err);
3784 g_free(out_real_path);
3785 if (!blk_new_backing) {
3786 error_reportf_err(local_err,
3787 "Could not open new backing file '%s': ",
3788 out_baseimg);
3789 ret = -1;
3790 goto out;
3791 }
Alex Bligha6166732012-10-16 13:46:18 +01003792 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003793 }
3794 }
3795
3796 /*
3797 * Check each unallocated cluster in the COW file. If it is unallocated,
3798 * accesses go to the backing file. We must therefore compare this cluster
3799 * in the old and new backing file, and if they differ we need to copy it
3800 * from the old backing file into the COW file.
3801 *
3802 * If qemu-img crashes during this step, no harm is done. The content of
3803 * the image is the same as the original one at any time.
3804 */
3805 if (!unsafe) {
Eric Blake41536282017-10-11 22:47:15 -05003806 int64_t size;
Max Reitz35ddd932019-05-09 19:52:35 +02003807 int64_t old_backing_size = 0;
Eric Blake41536282017-10-11 22:47:15 -05003808 int64_t new_backing_size = 0;
3809 uint64_t offset;
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003810 int64_t n, n_old = 0, n_new = 0;
Kevin Wolf1f710492012-10-12 14:29:18 +02003811 float local_progress = 0;
TeLeMand6771bf2010-02-08 16:20:00 +08003812
Andrey Drobyshevce8b8f92023-09-19 19:57:59 +03003813 if (blk_old_backing && bdrv_opt_mem_align(blk_bs(blk_old_backing)) >
3814 bdrv_opt_mem_align(blk_bs(blk))) {
3815 buf_old = blk_blockalign(blk_old_backing, IO_BUF_SIZE);
3816 } else {
3817 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3818 }
3819 buf_new = blk_blockalign(blk_new_backing, IO_BUF_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003820
Eric Blake41536282017-10-11 22:47:15 -05003821 size = blk_getlength(blk);
3822 if (size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003823 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003824 filename, strerror(-size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003825 ret = -1;
3826 goto out;
3827 }
Max Reitz35ddd932019-05-09 19:52:35 +02003828 if (blk_old_backing) {
3829 old_backing_size = blk_getlength(blk_old_backing);
3830 if (old_backing_size < 0) {
3831 char backing_name[PATH_MAX];
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003832
Max Reitz35ddd932019-05-09 19:52:35 +02003833 bdrv_get_backing_filename(bs, backing_name,
3834 sizeof(backing_name));
3835 error_report("Could not get size of '%s': %s",
3836 backing_name, strerror(-old_backing_size));
3837 ret = -1;
3838 goto out;
3839 }
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003840 }
Max Reitzf1d3cd72015-02-05 13:58:18 -05003841 if (blk_new_backing) {
Eric Blake41536282017-10-11 22:47:15 -05003842 new_backing_size = blk_getlength(blk_new_backing);
3843 if (new_backing_size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003844 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003845 out_baseimg, strerror(-new_backing_size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003846 ret = -1;
3847 goto out;
3848 }
Alex Bligha6166732012-10-16 13:46:18 +01003849 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003850
Eric Blake41536282017-10-11 22:47:15 -05003851 if (size != 0) {
3852 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
Kevin Wolf1f710492012-10-12 14:29:18 +02003853 }
3854
Eric Blake41536282017-10-11 22:47:15 -05003855 for (offset = 0; offset < size; offset += n) {
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003856 bool old_backing_eof = false;
3857 int64_t n_alloc;
Max Reitz1c6e8772019-05-09 19:52:36 +02003858
Eric Blake41536282017-10-11 22:47:15 -05003859 /* How many bytes can we handle with the next read? */
3860 n = MIN(IO_BUF_SIZE, size - offset);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003861
3862 /* If the cluster is allocated, we don't need to take action */
Max Reitz4a2061e2019-06-12 19:00:30 +02003863 ret = bdrv_is_allocated(unfiltered_bs, offset, n, &n);
Paolo Bonzinid6636402013-09-04 19:00:25 +02003864 if (ret < 0) {
3865 error_report("error while reading image metadata: %s",
3866 strerror(-ret));
3867 goto out;
3868 }
Kevin Wolfcc60e322010-04-29 14:47:48 +02003869 if (ret) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003870 continue;
3871 }
3872
Sam Eiderman863cc782019-05-23 19:33:36 +03003873 if (prefix_chain_bs) {
Andrey Drobyshev8b097fd2023-09-19 19:57:57 +03003874 uint64_t bytes = n;
3875
Sam Eiderman863cc782019-05-23 19:33:36 +03003876 /*
3877 * If cluster wasn't changed since prefix_chain, we don't need
3878 * to take action
3879 */
Kevin Wolf78a9c762023-10-27 17:53:21 +02003880 ret = bdrv_is_allocated_above(unfiltered_bs_cow,
Max Reitz4a2061e2019-06-12 19:00:30 +02003881 prefix_chain_bs, false,
3882 offset, n, &n);
Sam Eiderman863cc782019-05-23 19:33:36 +03003883 if (ret < 0) {
3884 error_report("error while reading image metadata: %s",
3885 strerror(-ret));
3886 goto out;
3887 }
Andrey Drobyshev8b097fd2023-09-19 19:57:57 +03003888 if (!ret && n) {
Sam Eiderman863cc782019-05-23 19:33:36 +03003889 continue;
3890 }
Andrey Drobyshev8b097fd2023-09-19 19:57:57 +03003891 if (!n) {
3892 /*
3893 * If we've reached EOF of the old backing, it means that
3894 * offsets beyond the old backing size were read as zeroes.
3895 * Now we will need to explicitly zero the cluster in
3896 * order to preserve that state after the rebase.
3897 */
3898 n = bytes;
3899 }
Sam Eiderman863cc782019-05-23 19:33:36 +03003900 }
3901
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003902 /*
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003903 * At this point we know that the region [offset; offset + n)
3904 * is unallocated within the target image. This region might be
3905 * unaligned to the target image's (sub)cluster boundaries, as
3906 * old backing may have smaller clusters (or have subclusters).
3907 * We extend it to the aligned boundaries to avoid CoW on
3908 * partial writes in blk_pwrite(),
3909 */
3910 n += offset - QEMU_ALIGN_DOWN(offset, write_align);
3911 offset = QEMU_ALIGN_DOWN(offset, write_align);
3912 n += QEMU_ALIGN_UP(offset + n, write_align) - (offset + n);
3913 n = MIN(n, size - offset);
3914 assert(!bdrv_is_allocated(unfiltered_bs, offset, n, &n_alloc) &&
3915 n_alloc == n);
3916
3917 /*
3918 * Much like with the target image, we'll try to read as much
3919 * of the old and new backings as we can.
3920 */
3921 n_old = MIN(n, MAX(0, old_backing_size - (int64_t) offset));
3922 n_new = MIN(n, MAX(0, new_backing_size - (int64_t) offset));
3923
3924 /*
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003925 * Read old and new backing file and take into consideration that
3926 * backing files may be smaller than the COW image.
3927 */
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003928 memset(buf_old + n_old, 0, n - n_old);
3929 if (!n_old) {
3930 old_backing_eof = true;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003931 } else {
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003932 ret = blk_pread(blk_old_backing, offset, n_old, buf_old, 0);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003933 if (ret < 0) {
3934 error_report("error while reading from old backing file");
3935 goto out;
3936 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003937 }
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003938
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003939 memset(buf_new + n_new, 0, n - n_new);
3940 if (n_new) {
3941 ret = blk_pread(blk_new_backing, offset, n_new, buf_new, 0);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003942 if (ret < 0) {
3943 error_report("error while reading from new backing file");
3944 goto out;
3945 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003946 }
3947
3948 /* If they differ, we need to write to the COW file */
3949 uint64_t written = 0;
3950
Eric Blake41536282017-10-11 22:47:15 -05003951 while (written < n) {
Eric Blakedc61cd32017-10-11 22:47:14 -05003952 int64_t pnum;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003953
Eric Blake41536282017-10-11 22:47:15 -05003954 if (compare_buffers(buf_old + written, buf_new + written,
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003955 n - written, write_align, &pnum))
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003956 {
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003957 if (old_backing_eof) {
Max Reitz1c6e8772019-05-09 19:52:36 +02003958 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0);
3959 } else {
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003960 assert(written + pnum <= IO_BUF_SIZE);
Alberto Fariaa9262f52022-07-05 17:15:11 +01003961 ret = blk_pwrite(blk, offset + written, pnum,
Andrey Drobyshev26ea2782023-09-19 19:58:03 +03003962 buf_old + written, write_flags);
Max Reitz1c6e8772019-05-09 19:52:36 +02003963 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003964 if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003965 error_report("Error while writing to COW image: %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003966 strerror(-ret));
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003967 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003968 }
3969 }
3970
3971 written += pnum;
Andrey Drobyshev12df5802023-09-19 19:58:01 +03003972 if (offset + written >= old_backing_size) {
3973 old_backing_eof = true;
3974 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003975 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003976 qemu_progress_print(local_progress, 100);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003977 }
3978 }
3979
3980 /*
3981 * Change the backing file. All clusters that are different from the old
3982 * backing file are overwritten in the COW file now, so the visible content
3983 * doesn't change when we switch the backing file.
3984 */
Alex Bligha6166732012-10-16 13:46:18 +01003985 if (out_baseimg && *out_baseimg) {
Max Reitz4a2061e2019-06-12 19:00:30 +02003986 ret = bdrv_change_backing_file(unfiltered_bs, out_baseimg, out_basefmt,
3987 true);
Alex Bligha6166732012-10-16 13:46:18 +01003988 } else {
Max Reitz4a2061e2019-06-12 19:00:30 +02003989 ret = bdrv_change_backing_file(unfiltered_bs, NULL, NULL, false);
Alex Bligha6166732012-10-16 13:46:18 +01003990 }
3991
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003992 if (ret == -ENOSPC) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003993 error_report("Could not change the backing file to '%s': No "
3994 "space left in the file header", out_baseimg);
Eric Blakea7cd44b2021-07-08 10:52:28 -05003995 } else if (ret == -EINVAL && out_baseimg && !out_basefmt) {
3996 error_report("Could not change the backing file to '%s': backing "
3997 "format must be specified", out_baseimg);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003998 } else if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003999 error_report("Could not change the backing file to '%s': %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01004000 out_baseimg, strerror(-ret));
4001 }
4002
Jes Sorensen6b837bc2011-03-30 14:16:25 +02004003 qemu_progress_print(100, 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01004004 /*
4005 * TODO At this point it is possible to check if any clusters that are
4006 * allocated in the COW file are the same in the backing file. If so, they
4007 * could be dropped from the COW file. Don't do this before switching the
4008 * backing file, in case of a crash this would lead to corruption.
4009 */
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004010out:
Jes Sorensen6b837bc2011-03-30 14:16:25 +02004011 qemu_progress_end();
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01004012 /* Cleanup */
4013 if (!unsafe) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02004014 blk_unref(blk_old_backing);
Markus Armbruster26f54e92014-10-07 13:59:04 +02004015 blk_unref(blk_new_backing);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01004016 }
Paolo Bonzini396374c2016-02-25 23:53:54 +01004017 qemu_vfree(buf_old);
4018 qemu_vfree(buf_new);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01004019
Markus Armbruster26f54e92014-10-07 13:59:04 +02004020 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004021 if (ret) {
4022 return 1;
4023 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01004024 return 0;
4025}
4026
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004027static int img_resize(int argc, char **argv)
4028{
Markus Armbruster6750e792015-02-12 17:43:08 +01004029 Error *err = NULL;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004030 int c, ret, relative;
4031 const char *filename, *fmt, *size;
Max Reitz09c5c6d2019-09-18 11:51:44 +02004032 int64_t n, total_size, current_size;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01004033 bool quiet = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02004034 BlockBackend *blk = NULL;
Max Reitzdc5f6902017-06-13 22:20:55 +02004035 PreallocMode prealloc = PREALLOC_MODE_OFF;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08004036 QemuOpts *param;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004037
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08004038 static QemuOptsList resize_options = {
4039 .name = "resize_options",
4040 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
4041 .desc = {
4042 {
4043 .name = BLOCK_OPT_SIZE,
4044 .type = QEMU_OPT_SIZE,
4045 .help = "Virtual disk size"
4046 }, {
4047 /* end of list */
4048 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004049 },
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004050 };
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004051 bool image_opts = false;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03004052 bool shrink = false;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004053
Kevin Wolfe80fec72011-04-29 10:58:12 +02004054 /* Remove size from argv manually so that negative numbers are not treated
4055 * as options by getopt. */
4056 if (argc < 3) {
Fam Zhengac1307a2014-04-22 13:36:11 +08004057 error_exit("Not enough arguments");
Kevin Wolfe80fec72011-04-29 10:58:12 +02004058 return 1;
4059 }
4060
4061 size = argv[--argc];
4062
4063 /* Parse getopt arguments */
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004064 fmt = NULL;
4065 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004066 static const struct option long_options[] = {
4067 {"help", no_argument, 0, 'h'},
4068 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004069 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Max Reitzdc5f6902017-06-13 22:20:55 +02004070 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
Pavel Butsykin4ffca892017-09-18 15:42:27 +03004071 {"shrink", no_argument, 0, OPTION_SHRINK},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004072 {0, 0, 0, 0}
4073 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004074 c = getopt_long(argc, argv, ":f:hq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004075 long_options, NULL);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004076 if (c == -1) {
4077 break;
4078 }
4079 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004080 case ':':
4081 missing_argument(argv[optind - 1]);
4082 break;
Jes Sorensenef873942010-12-06 15:25:40 +01004083 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004084 unrecognized_option(argv[optind - 1]);
4085 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004086 case 'h':
4087 help();
4088 break;
4089 case 'f':
4090 fmt = optarg;
4091 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01004092 case 'q':
4093 quiet = true;
4094 break;
Kevin Wolf99b1e642021-02-17 12:56:45 +01004095 case OPTION_OBJECT:
4096 user_creatable_process_cmdline(optarg);
4097 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004098 case OPTION_IMAGE_OPTS:
4099 image_opts = true;
4100 break;
Max Reitzdc5f6902017-06-13 22:20:55 +02004101 case OPTION_PREALLOCATION:
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02004102 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
Markus Armbruster06c60b62017-08-24 10:45:57 +02004103 PREALLOC_MODE__MAX, NULL);
Max Reitzdc5f6902017-06-13 22:20:55 +02004104 if (prealloc == PREALLOC_MODE__MAX) {
4105 error_report("Invalid preallocation mode '%s'", optarg);
4106 return 1;
4107 }
4108 break;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03004109 case OPTION_SHRINK:
4110 shrink = true;
4111 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004112 }
4113 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02004114 if (optind != argc - 1) {
Max Reitzbe8fbd42018-02-05 17:27:45 +01004115 error_exit("Expecting image file name and size");
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004116 }
4117 filename = argv[optind++];
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004118
4119 /* Choose grow, shrink, or absolute resize mode */
4120 switch (size[0]) {
4121 case '+':
4122 relative = 1;
4123 size++;
4124 break;
4125 case '-':
4126 relative = -1;
4127 size++;
4128 break;
4129 default:
4130 relative = 0;
4131 break;
4132 }
4133
4134 /* Parse size */
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -08004135 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
Markus Armbruster235e59c2020-07-07 18:05:42 +02004136 if (!qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err)) {
Markus Armbruster6750e792015-02-12 17:43:08 +01004137 error_report_err(err);
Jes Sorensen2a819982010-12-06 17:08:31 +01004138 ret = -1;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08004139 qemu_opts_del(param);
Jes Sorensen2a819982010-12-06 17:08:31 +01004140 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004141 }
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08004142 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
4143 qemu_opts_del(param);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004144
Max Reitzefaa7c42016-03-16 19:54:38 +01004145 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08004146 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
4147 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004148 if (!blk) {
Jes Sorensen2a819982010-12-06 17:08:31 +01004149 ret = -1;
4150 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004151 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004152
Max Reitzdc5f6902017-06-13 22:20:55 +02004153 current_size = blk_getlength(blk);
4154 if (current_size < 0) {
4155 error_report("Failed to inquire current image length: %s",
4156 strerror(-current_size));
4157 ret = -1;
4158 goto out;
4159 }
4160
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004161 if (relative) {
Max Reitzdc5f6902017-06-13 22:20:55 +02004162 total_size = current_size + n * relative;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004163 } else {
4164 total_size = n;
4165 }
4166 if (total_size <= 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01004167 error_report("New image size must be positive");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004168 ret = -1;
4169 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004170 }
4171
Max Reitzdc5f6902017-06-13 22:20:55 +02004172 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
4173 error_report("Preallocation can only be used for growing images");
4174 ret = -1;
4175 goto out;
4176 }
4177
Pavel Butsykin4ffca892017-09-18 15:42:27 +03004178 if (total_size < current_size && !shrink) {
Kevin Wolf1c404d72020-07-10 14:17:17 +02004179 error_report("Use the --shrink option to perform a shrink operation.");
Pavel Butsykin4ffca892017-09-18 15:42:27 +03004180 warn_report("Shrinking an image will delete all data beyond the "
4181 "shrunken image's end. Before performing such an "
4182 "operation, make sure there is no important data there.");
Kevin Wolf1c404d72020-07-10 14:17:17 +02004183 ret = -1;
4184 goto out;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03004185 }
4186
Max Reitze8d04f92019-09-18 11:51:43 +02004187 /*
4188 * The user expects the image to have the desired size after
4189 * resizing, so pass @exact=true. It is of no use to report
4190 * success when the image has not actually been resized.
4191 */
Kevin Wolf8c6242b2020-04-24 14:54:41 +02004192 ret = blk_truncate(blk, total_size, true, prealloc, 0, &err);
Max Reitz09c5c6d2019-09-18 11:51:44 +02004193 if (!ret) {
4194 qprintf(quiet, "Image resized.\n");
4195 } else {
Max Reitzed3d2ec2017-03-28 22:51:27 +02004196 error_report_err(err);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004197 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004198out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02004199 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004200 if (ret) {
4201 return 1;
4202 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004203 return 0;
4204}
4205
Max Reitz76a3a342014-10-27 11:12:51 +01004206static void amend_status_cb(BlockDriverState *bs,
Max Reitz8b139762015-07-27 17:51:32 +02004207 int64_t offset, int64_t total_work_size,
4208 void *opaque)
Max Reitz76a3a342014-10-27 11:12:51 +01004209{
4210 qemu_progress_print(100.f * offset / total_work_size, 0);
4211}
4212
Max Reitz51641352018-05-09 23:00:20 +02004213static int print_amend_option_help(const char *format)
4214{
4215 BlockDriver *drv;
4216
Kevin Wolfbd131d62023-09-29 16:51:48 +02004217 GRAPH_RDLOCK_GUARD_MAINLOOP();
4218
Max Reitz51641352018-05-09 23:00:20 +02004219 /* Find driver and parse its options */
4220 drv = bdrv_find_format(format);
4221 if (!drv) {
4222 error_report("Unknown file format '%s'", format);
4223 return 1;
4224 }
4225
4226 if (!drv->bdrv_amend_options) {
4227 error_report("Format driver '%s' does not support option amendment",
4228 format);
4229 return 1;
4230 }
4231
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004232 /* Every driver supporting amendment must have amend_opts */
4233 assert(drv->amend_opts);
Max Reitz51641352018-05-09 23:00:20 +02004234
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004235 printf("Amend options for '%s':\n", format);
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004236 qemu_opts_print_help(drv->amend_opts, false);
Max Reitz51641352018-05-09 23:00:20 +02004237 return 0;
4238}
4239
Max Reitz6f176b42013-09-03 10:09:50 +02004240static int img_amend(int argc, char **argv)
4241{
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01004242 Error *err = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02004243 int c, ret = 0;
4244 char *options = NULL;
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004245 QemuOptsList *amend_opts = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08004246 QemuOpts *opts = NULL;
Max Reitzbd39e6e2014-07-22 22:58:43 +02004247 const char *fmt = NULL, *filename, *cache;
4248 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01004249 bool writethrough;
Max Reitz76a3a342014-10-27 11:12:51 +01004250 bool quiet = false, progress = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02004251 BlockBackend *blk = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02004252 BlockDriverState *bs = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004253 bool image_opts = false;
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004254 bool force = false;
Max Reitz6f176b42013-09-03 10:09:50 +02004255
Max Reitzbd39e6e2014-07-22 22:58:43 +02004256 cache = BDRV_DEFAULT_CACHE;
Max Reitz6f176b42013-09-03 10:09:50 +02004257 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004258 static const struct option long_options[] = {
4259 {"help", no_argument, 0, 'h'},
4260 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004261 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004262 {"force", no_argument, 0, OPTION_FORCE},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004263 {0, 0, 0, 0}
4264 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004265 c = getopt_long(argc, argv, ":ho:f:t:pq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004266 long_options, NULL);
Max Reitz6f176b42013-09-03 10:09:50 +02004267 if (c == -1) {
4268 break;
4269 }
4270
4271 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004272 case ':':
4273 missing_argument(argv[optind - 1]);
4274 break;
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004275 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004276 unrecognized_option(argv[optind - 1]);
4277 break;
4278 case 'h':
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004279 help();
4280 break;
4281 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02004282 if (accumulate_options(&options, optarg) < 0) {
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004283 ret = -1;
4284 goto out_no_progress;
4285 }
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004286 break;
4287 case 'f':
4288 fmt = optarg;
4289 break;
4290 case 't':
4291 cache = optarg;
4292 break;
4293 case 'p':
4294 progress = true;
4295 break;
4296 case 'q':
4297 quiet = true;
4298 break;
4299 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01004300 user_creatable_process_cmdline(optarg);
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004301 break;
4302 case OPTION_IMAGE_OPTS:
4303 image_opts = true;
4304 break;
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004305 case OPTION_FORCE:
4306 force = true;
4307 break;
Max Reitz6f176b42013-09-03 10:09:50 +02004308 }
4309 }
4310
Max Reitz6f176b42013-09-03 10:09:50 +02004311 if (!options) {
Fam Zhengac1307a2014-04-22 13:36:11 +08004312 error_exit("Must specify options (-o)");
Max Reitz6f176b42013-09-03 10:09:50 +02004313 }
4314
Max Reitz76a3a342014-10-27 11:12:51 +01004315 if (quiet) {
4316 progress = false;
4317 }
4318 qemu_progress_init(progress, 1.0);
4319
Kevin Wolfa283cb62014-02-21 16:24:07 +01004320 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
4321 if (fmt && has_help_option(options)) {
4322 /* If a format is explicitly specified (and possibly no filename is
4323 * given), print option help here */
Max Reitz51641352018-05-09 23:00:20 +02004324 ret = print_amend_option_help(fmt);
Kevin Wolfa283cb62014-02-21 16:24:07 +01004325 goto out;
4326 }
4327
4328 if (optind != argc - 1) {
Max Reitzb2f27e42014-10-27 11:12:52 +01004329 error_report("Expecting one image file name");
4330 ret = -1;
4331 goto out;
Kevin Wolfa283cb62014-02-21 16:24:07 +01004332 }
Max Reitz6f176b42013-09-03 10:09:50 +02004333
Kevin Wolfce099542016-03-15 13:01:04 +01004334 flags = BDRV_O_RDWR;
4335 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitzbd39e6e2014-07-22 22:58:43 +02004336 if (ret < 0) {
4337 error_report("Invalid cache option: %s", cache);
4338 goto out;
4339 }
4340
Fam Zheng335e9932017-05-03 00:35:39 +08004341 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4342 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004343 if (!blk) {
Max Reitz6f176b42013-09-03 10:09:50 +02004344 ret = -1;
4345 goto out;
4346 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004347 bs = blk_bs(blk);
Max Reitz6f176b42013-09-03 10:09:50 +02004348
4349 fmt = bs->drv->format_name;
4350
Kevin Wolf626f84f2014-02-21 16:24:06 +01004351 if (has_help_option(options)) {
Kevin Wolfa283cb62014-02-21 16:24:07 +01004352 /* If the format was auto-detected, print option help here */
Max Reitz51641352018-05-09 23:00:20 +02004353 ret = print_amend_option_help(fmt);
Max Reitz6f176b42013-09-03 10:09:50 +02004354 goto out;
4355 }
4356
Kevin Wolfbd131d62023-09-29 16:51:48 +02004357 bdrv_graph_rdlock_main_loop();
Max Reitz1f996682018-05-09 23:00:17 +02004358 if (!bs->drv->bdrv_amend_options) {
4359 error_report("Format driver '%s' does not support option amendment",
Max Reitzb2439d22014-12-02 18:32:47 +01004360 fmt);
Kevin Wolfbd131d62023-09-29 16:51:48 +02004361 bdrv_graph_rdunlock_main_loop();
Max Reitzb2439d22014-12-02 18:32:47 +01004362 ret = -1;
4363 goto out;
4364 }
4365
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004366 /* Every driver supporting amendment must have amend_opts */
4367 assert(bs->drv->amend_opts);
Max Reitz1f996682018-05-09 23:00:17 +02004368
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004369 amend_opts = qemu_opts_append(amend_opts, bs->drv->amend_opts);
4370 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
Markus Armbruster235e59c2020-07-07 18:05:42 +02004371 if (!qemu_opts_do_parse(opts, options, NULL, &err)) {
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004372 /* Try to parse options using the create options */
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004373 amend_opts = qemu_opts_append(amend_opts, bs->drv->create_opts);
4374 qemu_opts_del(opts);
4375 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
Markus Armbruster9e194e02020-07-07 18:06:11 +02004376 if (qemu_opts_do_parse(opts, options, NULL, NULL)) {
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004377 error_append_hint(&err,
4378 "This option is only supported for image creation\n");
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004379 }
4380
Kevin Wolfbd131d62023-09-29 16:51:48 +02004381 bdrv_graph_rdunlock_main_loop();
Paolo Bonziniece90862017-01-04 15:56:24 +01004382 error_report_err(err);
4383 ret = -1;
4384 goto out;
Max Reitz6f176b42013-09-03 10:09:50 +02004385 }
4386
Max Reitz76a3a342014-10-27 11:12:51 +01004387 /* In case the driver does not call amend_status_cb() */
4388 qemu_progress_print(0.f, 0);
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004389 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, force, &err);
Max Reitz76a3a342014-10-27 11:12:51 +01004390 qemu_progress_print(100.f, 0);
Kevin Wolfbd131d62023-09-29 16:51:48 +02004391 bdrv_graph_rdunlock_main_loop();
4392
Max Reitz6f176b42013-09-03 10:09:50 +02004393 if (ret < 0) {
Max Reitzd1402b52018-05-09 23:00:18 +02004394 error_report_err(err);
Max Reitz6f176b42013-09-03 10:09:50 +02004395 goto out;
4396 }
4397
4398out:
Max Reitz76a3a342014-10-27 11:12:51 +01004399 qemu_progress_end();
4400
Max Reitze814dff2015-08-20 16:00:38 -07004401out_no_progress:
Markus Armbruster26f54e92014-10-07 13:59:04 +02004402 blk_unref(blk);
Chunyan Liu83d05212014-06-05 17:20:51 +08004403 qemu_opts_del(opts);
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004404 qemu_opts_free(amend_opts);
Kevin Wolf626f84f2014-02-21 16:24:06 +01004405 g_free(options);
4406
Max Reitz6f176b42013-09-03 10:09:50 +02004407 if (ret) {
4408 return 1;
4409 }
4410 return 0;
4411}
4412
Kevin Wolfb6133b82014-08-05 14:17:13 +02004413typedef struct BenchData {
4414 BlockBackend *blk;
4415 uint64_t image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004416 bool write;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004417 int bufsize;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004418 int step;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004419 int nrreq;
4420 int n;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004421 int flush_interval;
4422 bool drain_on_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004423 uint8_t *buf;
4424 QEMUIOVector *qiov;
4425
4426 int in_flight;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004427 bool in_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004428 uint64_t offset;
4429} BenchData;
4430
Kevin Wolf55d539c2016-06-03 13:59:41 +02004431static void bench_undrained_flush_cb(void *opaque, int ret)
4432{
4433 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004434 error_report("Failed flush request: %s", strerror(-ret));
Kevin Wolf55d539c2016-06-03 13:59:41 +02004435 exit(EXIT_FAILURE);
4436 }
4437}
4438
Kevin Wolfb6133b82014-08-05 14:17:13 +02004439static void bench_cb(void *opaque, int ret)
4440{
4441 BenchData *b = opaque;
4442 BlockAIOCB *acb;
4443
4444 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004445 error_report("Failed request: %s", strerror(-ret));
Kevin Wolfb6133b82014-08-05 14:17:13 +02004446 exit(EXIT_FAILURE);
4447 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004448
4449 if (b->in_flush) {
4450 /* Just finished a flush with drained queue: Start next requests */
4451 assert(b->in_flight == 0);
4452 b->in_flush = false;
4453 } else if (b->in_flight > 0) {
4454 int remaining = b->n - b->in_flight;
4455
Kevin Wolfb6133b82014-08-05 14:17:13 +02004456 b->n--;
4457 b->in_flight--;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004458
4459 /* Time for flush? Drain queue if requested, then flush */
4460 if (b->flush_interval && remaining % b->flush_interval == 0) {
4461 if (!b->in_flight || !b->drain_on_flush) {
4462 BlockCompletionFunc *cb;
4463
4464 if (b->drain_on_flush) {
4465 b->in_flush = true;
4466 cb = bench_cb;
4467 } else {
4468 cb = bench_undrained_flush_cb;
4469 }
4470
4471 acb = blk_aio_flush(b->blk, cb, b);
4472 if (!acb) {
4473 error_report("Failed to issue flush request");
4474 exit(EXIT_FAILURE);
4475 }
4476 }
4477 if (b->drain_on_flush) {
4478 return;
4479 }
4480 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004481 }
4482
4483 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004484 int64_t offset = b->offset;
4485 /* blk_aio_* might look for completed I/Os and kick bench_cb
4486 * again, so make sure this operation is counted by in_flight
4487 * and b->offset is ready for the next submission.
4488 */
4489 b->in_flight++;
4490 b->offset += b->step;
4491 b->offset %= b->image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004492 if (b->write) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004493 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004494 } else {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004495 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004496 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004497 if (!acb) {
4498 error_report("Failed to issue request");
4499 exit(EXIT_FAILURE);
4500 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004501 }
4502}
4503
4504static int img_bench(int argc, char **argv)
4505{
4506 int c, ret = 0;
4507 const char *fmt = NULL, *filename;
4508 bool quiet = false;
4509 bool image_opts = false;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004510 bool is_write = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004511 int count = 75000;
4512 int depth = 64;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004513 int64_t offset = 0;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004514 size_t bufsize = 4096;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004515 int pattern = 0;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004516 size_t step = 0;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004517 int flush_interval = 0;
4518 bool drain_on_flush = true;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004519 int64_t image_size;
4520 BlockBackend *blk = NULL;
4521 BenchData data = {};
4522 int flags = 0;
Kevin Wolf604e8612016-06-14 11:29:32 +02004523 bool writethrough = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004524 struct timeval t1, t2;
4525 int i;
Fam Zheng335e9932017-05-03 00:35:39 +08004526 bool force_share = false;
Stefan Hajnoczi4f384012022-10-13 14:58:59 -04004527 size_t buf_size = 0;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004528
4529 for (;;) {
4530 static const struct option long_options[] = {
4531 {"help", no_argument, 0, 'h'},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004532 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004533 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004534 {"pattern", required_argument, 0, OPTION_PATTERN},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004535 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
Fam Zheng335e9932017-05-03 00:35:39 +08004536 {"force-share", no_argument, 0, 'U'},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004537 {0, 0, 0, 0}
4538 };
Aarushi Mehtacdd26772020-01-20 14:18:55 +00004539 c = getopt_long(argc, argv, ":hc:d:f:ni:o:qs:S:t:wU", long_options,
4540 NULL);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004541 if (c == -1) {
4542 break;
4543 }
4544
4545 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004546 case ':':
4547 missing_argument(argv[optind - 1]);
4548 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004549 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004550 unrecognized_option(argv[optind - 1]);
4551 break;
4552 case 'h':
Kevin Wolfb6133b82014-08-05 14:17:13 +02004553 help();
4554 break;
4555 case 'c':
4556 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004557 unsigned long res;
4558
4559 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004560 error_report("Invalid request count specified");
4561 return 1;
4562 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004563 count = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004564 break;
4565 }
4566 case 'd':
4567 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004568 unsigned long res;
4569
4570 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004571 error_report("Invalid queue depth specified");
4572 return 1;
4573 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004574 depth = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004575 break;
4576 }
4577 case 'f':
4578 fmt = optarg;
4579 break;
4580 case 'n':
4581 flags |= BDRV_O_NATIVE_AIO;
4582 break;
Aarushi Mehtacdd26772020-01-20 14:18:55 +00004583 case 'i':
4584 ret = bdrv_parse_aio(optarg, &flags);
4585 if (ret < 0) {
4586 error_report("Invalid aio option: %s", optarg);
4587 ret = -1;
4588 goto out;
4589 }
4590 break;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004591 case 'o':
4592 {
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004593 offset = cvtnum("offset", optarg);
Markus Armbruster606caa02017-02-21 21:14:04 +01004594 if (offset < 0) {
Kevin Wolfd3199a32015-07-10 18:09:18 +02004595 return 1;
4596 }
4597 break;
4598 }
4599 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004600 case 'q':
4601 quiet = true;
4602 break;
4603 case 's':
4604 {
4605 int64_t sval;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004606
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004607 sval = cvtnum_full("buffer size", optarg, 0, INT_MAX);
4608 if (sval < 0) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004609 return 1;
4610 }
4611
4612 bufsize = sval;
4613 break;
4614 }
Kevin Wolf83de9be2015-07-13 13:13:17 +02004615 case 'S':
4616 {
4617 int64_t sval;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004618
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004619 sval = cvtnum_full("step_size", optarg, 0, INT_MAX);
4620 if (sval < 0) {
Kevin Wolf83de9be2015-07-13 13:13:17 +02004621 return 1;
4622 }
4623
4624 step = sval;
4625 break;
4626 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004627 case 't':
4628 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4629 if (ret < 0) {
4630 error_report("Invalid cache mode");
4631 ret = -1;
4632 goto out;
4633 }
4634 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004635 case 'w':
4636 flags |= BDRV_O_RDWR;
4637 is_write = true;
4638 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004639 case 'U':
4640 force_share = true;
4641 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004642 case OPTION_PATTERN:
4643 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004644 unsigned long res;
4645
4646 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004647 error_report("Invalid pattern byte specified");
4648 return 1;
4649 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004650 pattern = res;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004651 break;
4652 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004653 case OPTION_FLUSH_INTERVAL:
4654 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004655 unsigned long res;
4656
4657 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004658 error_report("Invalid flush interval specified");
4659 return 1;
4660 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004661 flush_interval = res;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004662 break;
4663 }
4664 case OPTION_NO_DRAIN:
4665 drain_on_flush = false;
4666 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004667 case OPTION_IMAGE_OPTS:
4668 image_opts = true;
4669 break;
4670 }
4671 }
4672
4673 if (optind != argc - 1) {
4674 error_exit("Expecting one image file name");
4675 }
4676 filename = argv[argc - 1];
4677
Kevin Wolf55d539c2016-06-03 13:59:41 +02004678 if (!is_write && flush_interval) {
4679 error_report("--flush-interval is only available in write tests");
4680 ret = -1;
4681 goto out;
4682 }
4683 if (flush_interval && flush_interval < depth) {
4684 error_report("Flush interval can't be smaller than depth");
4685 ret = -1;
4686 goto out;
4687 }
4688
Fam Zheng335e9932017-05-03 00:35:39 +08004689 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4690 force_share);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004691 if (!blk) {
4692 ret = -1;
4693 goto out;
4694 }
4695
4696 image_size = blk_getlength(blk);
4697 if (image_size < 0) {
4698 ret = image_size;
4699 goto out;
4700 }
4701
4702 data = (BenchData) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004703 .blk = blk,
4704 .image_size = image_size,
4705 .bufsize = bufsize,
4706 .step = step ?: bufsize,
4707 .nrreq = depth,
4708 .n = count,
4709 .offset = offset,
4710 .write = is_write,
4711 .flush_interval = flush_interval,
4712 .drain_on_flush = drain_on_flush,
Kevin Wolfb6133b82014-08-05 14:17:13 +02004713 };
Kevin Wolfd3199a32015-07-10 18:09:18 +02004714 printf("Sending %d %s requests, %d bytes each, %d in parallel "
Kevin Wolf83de9be2015-07-13 13:13:17 +02004715 "(starting at offset %" PRId64 ", step size %d)\n",
Kevin Wolfd3199a32015-07-10 18:09:18 +02004716 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
Kevin Wolf83de9be2015-07-13 13:13:17 +02004717 data.offset, data.step);
Kevin Wolf55d539c2016-06-03 13:59:41 +02004718 if (flush_interval) {
4719 printf("Sending flush every %d requests\n", flush_interval);
4720 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004721
Fam Zheng79d46582018-01-16 14:08:58 +08004722 buf_size = data.nrreq * data.bufsize;
4723 data.buf = blk_blockalign(blk, buf_size);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004724 memset(data.buf, pattern, data.nrreq * data.bufsize);
4725
Stefan Hajnoczif4ec04b2022-10-13 14:59:02 -04004726 blk_register_buf(blk, data.buf, buf_size, &error_fatal);
Fam Zheng79d46582018-01-16 14:08:58 +08004727
Kevin Wolfb6133b82014-08-05 14:17:13 +02004728 data.qiov = g_new(QEMUIOVector, data.nrreq);
4729 for (i = 0; i < data.nrreq; i++) {
4730 qemu_iovec_init(&data.qiov[i], 1);
4731 qemu_iovec_add(&data.qiov[i],
4732 data.buf + i * data.bufsize, data.bufsize);
4733 }
4734
4735 gettimeofday(&t1, NULL);
4736 bench_cb(&data, 0);
4737
4738 while (data.n > 0) {
4739 main_loop_wait(false);
4740 }
4741 gettimeofday(&t2, NULL);
4742
4743 printf("Run completed in %3.3f seconds.\n",
4744 (t2.tv_sec - t1.tv_sec)
4745 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4746
4747out:
Fam Zheng79d46582018-01-16 14:08:58 +08004748 if (data.buf) {
Stefan Hajnoczi4f384012022-10-13 14:58:59 -04004749 blk_unregister_buf(blk, data.buf, buf_size);
Fam Zheng79d46582018-01-16 14:08:58 +08004750 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004751 qemu_vfree(data.buf);
4752 blk_unref(blk);
4753
4754 if (ret) {
4755 return 1;
4756 }
4757 return 0;
4758}
4759
Eric Blake3b51ab42020-05-12 20:16:45 -05004760enum ImgBitmapAct {
4761 BITMAP_ADD,
4762 BITMAP_REMOVE,
4763 BITMAP_CLEAR,
4764 BITMAP_ENABLE,
4765 BITMAP_DISABLE,
4766 BITMAP_MERGE,
4767};
4768typedef struct ImgBitmapAction {
4769 enum ImgBitmapAct act;
4770 const char *src; /* only used for merge */
4771 QSIMPLEQ_ENTRY(ImgBitmapAction) next;
4772} ImgBitmapAction;
4773
4774static int img_bitmap(int argc, char **argv)
4775{
4776 Error *err = NULL;
4777 int c, ret = 1;
4778 QemuOpts *opts = NULL;
4779 const char *fmt = NULL, *src_fmt = NULL, *src_filename = NULL;
4780 const char *filename, *bitmap;
4781 BlockBackend *blk = NULL, *src = NULL;
4782 BlockDriverState *bs = NULL, *src_bs = NULL;
4783 bool image_opts = false;
4784 int64_t granularity = 0;
4785 bool add = false, merge = false;
4786 QSIMPLEQ_HEAD(, ImgBitmapAction) actions;
4787 ImgBitmapAction *act, *act_next;
4788 const char *op;
Kevin Wolfc5e47712023-01-12 20:14:53 +01004789 int inactivate_ret;
Eric Blake3b51ab42020-05-12 20:16:45 -05004790
4791 QSIMPLEQ_INIT(&actions);
4792
4793 for (;;) {
4794 static const struct option long_options[] = {
4795 {"help", no_argument, 0, 'h'},
4796 {"object", required_argument, 0, OPTION_OBJECT},
4797 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4798 {"add", no_argument, 0, OPTION_ADD},
4799 {"remove", no_argument, 0, OPTION_REMOVE},
4800 {"clear", no_argument, 0, OPTION_CLEAR},
4801 {"enable", no_argument, 0, OPTION_ENABLE},
4802 {"disable", no_argument, 0, OPTION_DISABLE},
4803 {"merge", required_argument, 0, OPTION_MERGE},
4804 {"granularity", required_argument, 0, 'g'},
4805 {"source-file", required_argument, 0, 'b'},
4806 {"source-format", required_argument, 0, 'F'},
4807 {0, 0, 0, 0}
4808 };
4809 c = getopt_long(argc, argv, ":b:f:F:g:h", long_options, NULL);
4810 if (c == -1) {
4811 break;
4812 }
4813
4814 switch (c) {
4815 case ':':
4816 missing_argument(argv[optind - 1]);
4817 break;
4818 case '?':
4819 unrecognized_option(argv[optind - 1]);
4820 break;
4821 case 'h':
4822 help();
4823 break;
4824 case 'b':
4825 src_filename = optarg;
4826 break;
4827 case 'f':
4828 fmt = optarg;
4829 break;
4830 case 'F':
4831 src_fmt = optarg;
4832 break;
4833 case 'g':
4834 granularity = cvtnum("granularity", optarg);
4835 if (granularity < 0) {
4836 return 1;
4837 }
4838 break;
4839 case OPTION_ADD:
4840 act = g_new0(ImgBitmapAction, 1);
4841 act->act = BITMAP_ADD;
4842 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4843 add = true;
4844 break;
4845 case OPTION_REMOVE:
4846 act = g_new0(ImgBitmapAction, 1);
4847 act->act = BITMAP_REMOVE;
4848 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4849 break;
4850 case OPTION_CLEAR:
4851 act = g_new0(ImgBitmapAction, 1);
4852 act->act = BITMAP_CLEAR;
4853 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4854 break;
4855 case OPTION_ENABLE:
4856 act = g_new0(ImgBitmapAction, 1);
4857 act->act = BITMAP_ENABLE;
4858 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4859 break;
4860 case OPTION_DISABLE:
4861 act = g_new0(ImgBitmapAction, 1);
4862 act->act = BITMAP_DISABLE;
4863 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4864 break;
4865 case OPTION_MERGE:
4866 act = g_new0(ImgBitmapAction, 1);
4867 act->act = BITMAP_MERGE;
4868 act->src = optarg;
4869 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4870 merge = true;
4871 break;
4872 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01004873 user_creatable_process_cmdline(optarg);
Eric Blake3b51ab42020-05-12 20:16:45 -05004874 break;
4875 case OPTION_IMAGE_OPTS:
4876 image_opts = true;
4877 break;
4878 }
4879 }
4880
Eric Blake3b51ab42020-05-12 20:16:45 -05004881 if (QSIMPLEQ_EMPTY(&actions)) {
4882 error_report("Need at least one of --add, --remove, --clear, "
4883 "--enable, --disable, or --merge");
4884 goto out;
4885 }
4886
4887 if (granularity && !add) {
4888 error_report("granularity only supported with --add");
4889 goto out;
4890 }
4891 if (src_fmt && !src_filename) {
4892 error_report("-F only supported with -b");
4893 goto out;
4894 }
4895 if (src_filename && !merge) {
4896 error_report("Merge bitmap source file only supported with "
4897 "--merge");
4898 goto out;
4899 }
4900
4901 if (optind != argc - 2) {
4902 error_report("Expecting filename and bitmap name");
4903 goto out;
4904 }
4905
4906 filename = argv[optind];
4907 bitmap = argv[optind + 1];
4908
Eric Blake14f16bf2020-09-14 14:10:09 -05004909 /*
4910 * No need to open backing chains; we will be manipulating bitmaps
4911 * directly in this image without reference to image contents.
4912 */
4913 blk = img_open(image_opts, filename, fmt, BDRV_O_RDWR | BDRV_O_NO_BACKING,
4914 false, false, false);
Eric Blake3b51ab42020-05-12 20:16:45 -05004915 if (!blk) {
4916 goto out;
4917 }
4918 bs = blk_bs(blk);
4919 if (src_filename) {
Eric Blake14f16bf2020-09-14 14:10:09 -05004920 src = img_open(false, src_filename, src_fmt, BDRV_O_NO_BACKING,
4921 false, false, false);
Eric Blake3b51ab42020-05-12 20:16:45 -05004922 if (!src) {
4923 goto out;
4924 }
4925 src_bs = blk_bs(src);
4926 } else {
4927 src_bs = bs;
4928 }
4929
4930 QSIMPLEQ_FOREACH_SAFE(act, &actions, next, act_next) {
4931 switch (act->act) {
4932 case BITMAP_ADD:
4933 qmp_block_dirty_bitmap_add(bs->node_name, bitmap,
4934 !!granularity, granularity, true, true,
4935 false, false, &err);
4936 op = "add";
4937 break;
4938 case BITMAP_REMOVE:
4939 qmp_block_dirty_bitmap_remove(bs->node_name, bitmap, &err);
4940 op = "remove";
4941 break;
4942 case BITMAP_CLEAR:
4943 qmp_block_dirty_bitmap_clear(bs->node_name, bitmap, &err);
4944 op = "clear";
4945 break;
4946 case BITMAP_ENABLE:
4947 qmp_block_dirty_bitmap_enable(bs->node_name, bitmap, &err);
4948 op = "enable";
4949 break;
4950 case BITMAP_DISABLE:
4951 qmp_block_dirty_bitmap_disable(bs->node_name, bitmap, &err);
4952 op = "disable";
4953 break;
Eric Blake6c729dd2020-05-21 14:21:35 -05004954 case BITMAP_MERGE:
4955 do_dirty_bitmap_merge(bs->node_name, bitmap, src_bs->node_name,
4956 act->src, &err);
Eric Blake3b51ab42020-05-12 20:16:45 -05004957 op = "merge";
4958 break;
Eric Blake3b51ab42020-05-12 20:16:45 -05004959 default:
4960 g_assert_not_reached();
4961 }
4962
4963 if (err) {
4964 error_reportf_err(err, "Operation %s on bitmap %s failed: ",
4965 op, bitmap);
4966 goto out;
4967 }
4968 g_free(act);
4969 }
4970
4971 ret = 0;
4972
4973 out:
Kevin Wolfc5e47712023-01-12 20:14:53 +01004974 /*
4975 * Manually inactivate the images first because this way we can know whether
4976 * an error occurred. blk_unref() doesn't tell us about failures.
4977 */
4978 inactivate_ret = bdrv_inactivate_all();
4979 if (inactivate_ret < 0) {
4980 error_report("Error while closing the image: %s", strerror(-inactivate_ret));
4981 ret = 1;
4982 }
4983
Eric Blake3b51ab42020-05-12 20:16:45 -05004984 blk_unref(src);
4985 blk_unref(blk);
4986 qemu_opts_del(opts);
4987 return ret;
4988}
4989
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004990#define C_BS 01
4991#define C_COUNT 02
4992#define C_IF 04
4993#define C_OF 010
Reda Sallahif7c15532016-08-10 16:16:09 +02004994#define C_SKIP 020
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004995
4996struct DdInfo {
4997 unsigned int flags;
4998 int64_t count;
4999};
5000
5001struct DdIo {
5002 int bsz; /* Block size */
5003 char *filename;
5004 uint8_t *buf;
Reda Sallahif7c15532016-08-10 16:16:09 +02005005 int64_t offset;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005006};
5007
5008struct DdOpts {
5009 const char *name;
5010 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
5011 unsigned int flag;
5012};
5013
5014static int img_dd_bs(const char *arg,
5015 struct DdIo *in, struct DdIo *out,
5016 struct DdInfo *dd)
5017{
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005018 int64_t res;
5019
Eyal Moscovici43d589b2020-05-13 16:36:26 +03005020 res = cvtnum_full("bs", arg, 1, INT_MAX);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005021
Eyal Moscovici43d589b2020-05-13 16:36:26 +03005022 if (res < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005023 return 1;
5024 }
5025 in->bsz = out->bsz = res;
5026
5027 return 0;
5028}
5029
5030static int img_dd_count(const char *arg,
5031 struct DdIo *in, struct DdIo *out,
5032 struct DdInfo *dd)
5033{
Eyal Moscovici43d589b2020-05-13 16:36:26 +03005034 dd->count = cvtnum("count", arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005035
Markus Armbruster606caa02017-02-21 21:14:04 +01005036 if (dd->count < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005037 return 1;
5038 }
5039
5040 return 0;
5041}
5042
5043static int img_dd_if(const char *arg,
5044 struct DdIo *in, struct DdIo *out,
5045 struct DdInfo *dd)
5046{
5047 in->filename = g_strdup(arg);
5048
5049 return 0;
5050}
5051
5052static int img_dd_of(const char *arg,
5053 struct DdIo *in, struct DdIo *out,
5054 struct DdInfo *dd)
5055{
5056 out->filename = g_strdup(arg);
5057
5058 return 0;
5059}
5060
Reda Sallahif7c15532016-08-10 16:16:09 +02005061static int img_dd_skip(const char *arg,
5062 struct DdIo *in, struct DdIo *out,
5063 struct DdInfo *dd)
5064{
Eyal Moscovici43d589b2020-05-13 16:36:26 +03005065 in->offset = cvtnum("skip", arg);
Reda Sallahif7c15532016-08-10 16:16:09 +02005066
Markus Armbruster606caa02017-02-21 21:14:04 +01005067 if (in->offset < 0) {
Reda Sallahif7c15532016-08-10 16:16:09 +02005068 return 1;
5069 }
5070
5071 return 0;
5072}
5073
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005074static int img_dd(int argc, char **argv)
5075{
5076 int ret = 0;
5077 char *arg = NULL;
5078 char *tmp;
5079 BlockDriver *drv = NULL, *proto_drv = NULL;
5080 BlockBackend *blk1 = NULL, *blk2 = NULL;
5081 QemuOpts *opts = NULL;
5082 QemuOptsList *create_opts = NULL;
5083 Error *local_err = NULL;
5084 bool image_opts = false;
5085 int c, i;
5086 const char *out_fmt = "raw";
5087 const char *fmt = NULL;
5088 int64_t size = 0;
Miroslav Rezanina0f48c472022-11-09 10:57:13 -05005089 int64_t out_pos, in_pos;
Fam Zheng335e9932017-05-03 00:35:39 +08005090 bool force_share = false;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005091 struct DdInfo dd = {
5092 .flags = 0,
5093 .count = 0,
5094 };
5095 struct DdIo in = {
5096 .bsz = 512, /* Block size is by default 512 bytes */
5097 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02005098 .buf = NULL,
5099 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005100 };
5101 struct DdIo out = {
5102 .bsz = 512,
5103 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02005104 .buf = NULL,
5105 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005106 };
5107
5108 const struct DdOpts options[] = {
5109 { "bs", img_dd_bs, C_BS },
5110 { "count", img_dd_count, C_COUNT },
5111 { "if", img_dd_if, C_IF },
5112 { "of", img_dd_of, C_OF },
Reda Sallahif7c15532016-08-10 16:16:09 +02005113 { "skip", img_dd_skip, C_SKIP },
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005114 { NULL, NULL, 0 }
5115 };
5116 const struct option long_options[] = {
5117 { "help", no_argument, 0, 'h'},
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01005118 { "object", required_argument, 0, OPTION_OBJECT},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005119 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08005120 { "force-share", no_argument, 0, 'U'},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005121 { 0, 0, 0, 0 }
5122 };
5123
Fam Zheng335e9932017-05-03 00:35:39 +08005124 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005125 if (c == EOF) {
5126 break;
5127 }
5128 switch (c) {
5129 case 'O':
5130 out_fmt = optarg;
5131 break;
5132 case 'f':
5133 fmt = optarg;
5134 break;
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005135 case ':':
5136 missing_argument(argv[optind - 1]);
5137 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005138 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005139 unrecognized_option(argv[optind - 1]);
5140 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005141 case 'h':
5142 help();
5143 break;
Fam Zheng335e9932017-05-03 00:35:39 +08005144 case 'U':
5145 force_share = true;
5146 break;
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01005147 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01005148 user_creatable_process_cmdline(optarg);
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01005149 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005150 case OPTION_IMAGE_OPTS:
5151 image_opts = true;
5152 break;
5153 }
5154 }
5155
5156 for (i = optind; i < argc; i++) {
5157 int j;
5158 arg = g_strdup(argv[i]);
5159
5160 tmp = strchr(arg, '=');
5161 if (tmp == NULL) {
5162 error_report("unrecognized operand %s", arg);
5163 ret = -1;
5164 goto out;
5165 }
5166
5167 *tmp++ = '\0';
5168
5169 for (j = 0; options[j].name != NULL; j++) {
5170 if (!strcmp(arg, options[j].name)) {
5171 break;
5172 }
5173 }
5174 if (options[j].name == NULL) {
5175 error_report("unrecognized operand %s", arg);
5176 ret = -1;
5177 goto out;
5178 }
5179
5180 if (options[j].f(tmp, &in, &out, &dd) != 0) {
5181 ret = -1;
5182 goto out;
5183 }
5184 dd.flags |= options[j].flag;
5185 g_free(arg);
5186 arg = NULL;
5187 }
5188
5189 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
5190 error_report("Must specify both input and output files");
5191 ret = -1;
5192 goto out;
5193 }
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01005194
Fam Zheng335e9932017-05-03 00:35:39 +08005195 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
5196 force_share);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005197
5198 if (!blk1) {
5199 ret = -1;
5200 goto out;
5201 }
5202
5203 drv = bdrv_find_format(out_fmt);
5204 if (!drv) {
5205 error_report("Unknown file format");
5206 ret = -1;
5207 goto out;
5208 }
5209 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
5210
5211 if (!proto_drv) {
5212 error_report_err(local_err);
5213 ret = -1;
5214 goto out;
5215 }
5216 if (!drv->create_opts) {
5217 error_report("Format driver '%s' does not support image creation",
5218 drv->format_name);
5219 ret = -1;
5220 goto out;
5221 }
5222 if (!proto_drv->create_opts) {
5223 error_report("Protocol driver '%s' does not support image creation",
5224 proto_drv->format_name);
5225 ret = -1;
5226 goto out;
5227 }
5228 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5229 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
5230
5231 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5232
5233 size = blk_getlength(blk1);
5234 if (size < 0) {
5235 error_report("Failed to get size for '%s'", in.filename);
5236 ret = -1;
5237 goto out;
5238 }
5239
5240 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
5241 dd.count * in.bsz < size) {
5242 size = dd.count * in.bsz;
5243 }
5244
Reda Sallahif7c15532016-08-10 16:16:09 +02005245 /* Overflow means the specified offset is beyond input image's size */
5246 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5247 size < in.bsz * in.offset)) {
5248 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
5249 } else {
5250 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
5251 size - in.bsz * in.offset, &error_abort);
5252 }
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005253
5254 ret = bdrv_create(drv, out.filename, opts, &local_err);
5255 if (ret < 0) {
5256 error_reportf_err(local_err,
5257 "%s: error while creating output image: ",
5258 out.filename);
5259 ret = -1;
5260 goto out;
5261 }
5262
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01005263 /* TODO, we can't honour --image-opts for the target,
5264 * since it needs to be given in a format compatible
5265 * with the bdrv_create() call above which does not
5266 * support image-opts style.
5267 */
Daniel P. Berrange29cf9332017-05-15 17:47:12 +01005268 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01005269 false, false, false);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005270
5271 if (!blk2) {
5272 ret = -1;
5273 goto out;
5274 }
5275
Reda Sallahif7c15532016-08-10 16:16:09 +02005276 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5277 size < in.offset * in.bsz)) {
5278 /* We give a warning if the skip option is bigger than the input
5279 * size and create an empty output disk image (i.e. like dd(1)).
5280 */
5281 error_report("%s: cannot skip to specified offset", in.filename);
5282 in_pos = size;
5283 } else {
5284 in_pos = in.offset * in.bsz;
5285 }
5286
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005287 in.buf = g_new(uint8_t, in.bsz);
5288
Miroslav Rezanina0f48c472022-11-09 10:57:13 -05005289 for (out_pos = 0; in_pos < size; ) {
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005290 int bytes = (in_pos + in.bsz > size) ? size - in_pos : in.bsz;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005291
Alberto Fariaa9262f52022-07-05 17:15:11 +01005292 ret = blk_pread(blk1, in_pos, bytes, in.buf, 0);
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005293 if (ret < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005294 error_report("error while reading from input image file: %s",
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005295 strerror(-ret));
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005296 goto out;
5297 }
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005298 in_pos += bytes;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005299
Alberto Fariaa9262f52022-07-05 17:15:11 +01005300 ret = blk_pwrite(blk2, out_pos, bytes, in.buf, 0);
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005301 if (ret < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005302 error_report("error while writing to output image file: %s",
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005303 strerror(-ret));
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005304 goto out;
5305 }
Alberto Fariabf5b16f2022-07-05 17:15:09 +01005306 out_pos += bytes;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005307 }
5308
5309out:
5310 g_free(arg);
5311 qemu_opts_del(opts);
5312 qemu_opts_free(create_opts);
5313 blk_unref(blk1);
5314 blk_unref(blk2);
5315 g_free(in.filename);
5316 g_free(out.filename);
5317 g_free(in.buf);
5318 g_free(out.buf);
5319
5320 if (ret) {
5321 return 1;
5322 }
5323 return 0;
5324}
5325
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005326static void dump_json_block_measure_info(BlockMeasureInfo *info)
5327{
Markus Armbrustereab3a462020-12-11 18:11:37 +01005328 GString *str;
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005329 QObject *obj;
5330 Visitor *v = qobject_output_visitor_new(&obj);
5331
5332 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
5333 visit_complete(v, &obj);
Markus Armbruster6589f452020-12-11 18:11:35 +01005334 str = qobject_to_json_pretty(obj, true);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005335 assert(str != NULL);
Markus Armbrustereab3a462020-12-11 18:11:37 +01005336 printf("%s\n", str->str);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02005337 qobject_unref(obj);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005338 visit_free(v);
Markus Armbrustereab3a462020-12-11 18:11:37 +01005339 g_string_free(str, true);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005340}
5341
5342static int img_measure(int argc, char **argv)
5343{
5344 static const struct option long_options[] = {
5345 {"help", no_argument, 0, 'h'},
5346 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
5347 {"object", required_argument, 0, OPTION_OBJECT},
5348 {"output", required_argument, 0, OPTION_OUTPUT},
5349 {"size", required_argument, 0, OPTION_SIZE},
5350 {"force-share", no_argument, 0, 'U'},
5351 {0, 0, 0, 0}
5352 };
5353 OutputFormat output_format = OFORMAT_HUMAN;
5354 BlockBackend *in_blk = NULL;
5355 BlockDriver *drv;
5356 const char *filename = NULL;
5357 const char *fmt = NULL;
5358 const char *out_fmt = "raw";
5359 char *options = NULL;
5360 char *snapshot_name = NULL;
5361 bool force_share = false;
5362 QemuOpts *opts = NULL;
5363 QemuOpts *object_opts = NULL;
5364 QemuOpts *sn_opts = NULL;
5365 QemuOptsList *create_opts = NULL;
5366 bool image_opts = false;
5367 uint64_t img_size = UINT64_MAX;
5368 BlockMeasureInfo *info = NULL;
5369 Error *local_err = NULL;
5370 int ret = 1;
5371 int c;
5372
5373 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
5374 long_options, NULL)) != -1) {
5375 switch (c) {
5376 case '?':
5377 case 'h':
5378 help();
5379 break;
5380 case 'f':
5381 fmt = optarg;
5382 break;
5383 case 'O':
5384 out_fmt = optarg;
5385 break;
5386 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02005387 if (accumulate_options(&options, optarg) < 0) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005388 goto out;
5389 }
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005390 break;
5391 case 'l':
5392 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
5393 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
5394 optarg, false);
5395 if (!sn_opts) {
5396 error_report("Failed in parsing snapshot param '%s'",
5397 optarg);
5398 goto out;
5399 }
5400 } else {
5401 snapshot_name = optarg;
5402 }
5403 break;
5404 case 'U':
5405 force_share = true;
5406 break;
5407 case OPTION_OBJECT:
Kevin Wolf99b1e642021-02-17 12:56:45 +01005408 user_creatable_process_cmdline(optarg);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005409 break;
5410 case OPTION_IMAGE_OPTS:
5411 image_opts = true;
5412 break;
5413 case OPTION_OUTPUT:
5414 if (!strcmp(optarg, "json")) {
5415 output_format = OFORMAT_JSON;
5416 } else if (!strcmp(optarg, "human")) {
5417 output_format = OFORMAT_HUMAN;
5418 } else {
5419 error_report("--output must be used with human or json "
5420 "as argument.");
5421 goto out;
5422 }
5423 break;
5424 case OPTION_SIZE:
5425 {
5426 int64_t sval;
5427
Eyal Moscovici43d589b2020-05-13 16:36:26 +03005428 sval = cvtnum("image size", optarg);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005429 if (sval < 0) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005430 goto out;
5431 }
5432 img_size = (uint64_t)sval;
5433 }
5434 break;
5435 }
5436 }
5437
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005438 if (argc - optind > 1) {
5439 error_report("At most one filename argument is allowed.");
5440 goto out;
5441 } else if (argc - optind == 1) {
5442 filename = argv[optind];
5443 }
5444
Stefan Hajnoczic3673dc2020-02-21 11:25:21 +00005445 if (!filename && (image_opts || fmt || snapshot_name || sn_opts)) {
5446 error_report("--image-opts, -f, and -l require a filename argument.");
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005447 goto out;
5448 }
5449 if (filename && img_size != UINT64_MAX) {
5450 error_report("--size N cannot be used together with a filename.");
5451 goto out;
5452 }
5453 if (!filename && img_size == UINT64_MAX) {
5454 error_report("Either --size N or one filename must be specified.");
5455 goto out;
5456 }
5457
5458 if (filename) {
5459 in_blk = img_open(image_opts, filename, fmt, 0,
5460 false, false, force_share);
5461 if (!in_blk) {
5462 goto out;
5463 }
5464
5465 if (sn_opts) {
5466 bdrv_snapshot_load_tmp(blk_bs(in_blk),
5467 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
5468 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
5469 &local_err);
5470 } else if (snapshot_name != NULL) {
5471 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
5472 snapshot_name, &local_err);
5473 }
5474 if (local_err) {
5475 error_reportf_err(local_err, "Failed to load snapshot: ");
5476 goto out;
5477 }
5478 }
5479
5480 drv = bdrv_find_format(out_fmt);
5481 if (!drv) {
5482 error_report("Unknown file format '%s'", out_fmt);
5483 goto out;
5484 }
5485 if (!drv->create_opts) {
5486 error_report("Format driver '%s' does not support image creation",
5487 drv->format_name);
5488 goto out;
5489 }
5490
5491 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5492 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
5493 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5494 if (options) {
Markus Armbruster235e59c2020-07-07 18:05:42 +02005495 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005496 error_report_err(local_err);
5497 error_report("Invalid options for file format '%s'", out_fmt);
5498 goto out;
5499 }
5500 }
5501 if (img_size != UINT64_MAX) {
5502 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
5503 }
5504
5505 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
5506 if (local_err) {
5507 error_report_err(local_err);
5508 goto out;
5509 }
5510
5511 if (output_format == OFORMAT_HUMAN) {
5512 printf("required size: %" PRIu64 "\n", info->required);
5513 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
Eric Blake5d72c682020-05-21 14:21:34 -05005514 if (info->has_bitmaps) {
5515 printf("bitmaps size: %" PRIu64 "\n", info->bitmaps);
5516 }
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005517 } else {
5518 dump_json_block_measure_info(info);
5519 }
5520
5521 ret = 0;
5522
5523out:
5524 qapi_free_BlockMeasureInfo(info);
5525 qemu_opts_del(object_opts);
5526 qemu_opts_del(opts);
5527 qemu_opts_del(sn_opts);
5528 qemu_opts_free(create_opts);
5529 g_free(options);
5530 blk_unref(in_blk);
5531 return ret;
5532}
Kevin Wolfb6133b82014-08-05 14:17:13 +02005533
Anthony Liguoric227f092009-10-01 16:12:16 -05005534static const img_cmd_t img_cmds[] = {
Stuart Brady153859b2009-06-07 00:42:17 +01005535#define DEF(option, callback, arg_string) \
5536 { option, callback },
5537#include "qemu-img-cmds.h"
5538#undef DEF
Stuart Brady153859b2009-06-07 00:42:17 +01005539 { NULL, NULL, },
5540};
5541
bellardea2384d2004-08-01 21:59:26 +00005542int main(int argc, char **argv)
5543{
Anthony Liguoric227f092009-10-01 16:12:16 -05005544 const img_cmd_t *cmd;
Stuart Brady153859b2009-06-07 00:42:17 +01005545 const char *cmdname;
Jeff Cody7db16892014-04-25 17:02:32 -04005546 int c;
Jeff Cody7db16892014-04-25 17:02:32 -04005547 static const struct option long_options[] = {
5548 {"help", no_argument, 0, 'h'},
Denis V. Lunev10985132016-06-17 17:44:13 +03005549 {"version", no_argument, 0, 'V'},
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005550 {"trace", required_argument, NULL, 'T'},
Jeff Cody7db16892014-04-25 17:02:32 -04005551 {0, 0, 0, 0}
5552 };
bellardea2384d2004-08-01 21:59:26 +00005553
MORITA Kazutaka526eda12013-07-23 17:30:11 +09005554#ifdef CONFIG_POSIX
5555 signal(SIGPIPE, SIG_IGN);
5556#endif
5557
Daniel P. Berrangé98c5d2e2020-08-25 11:38:48 +01005558 socket_init();
Christophe Fergeauf5852ef2019-01-31 17:46:14 +01005559 error_init(argv[0]);
Daniel P. Berrangefe4db842016-10-04 14:35:52 +01005560 module_call_init(MODULE_INIT_TRACE);
Fam Zheng10f5bff2014-02-10 14:48:51 +08005561 qemu_init_exec_dir(argv[0]);
Kevin Wolf53f76e52010-12-16 15:10:32 +01005562
Markus Armbrusterf9734d52021-07-20 14:53:53 +02005563 qemu_init_main_loop(&error_fatal);
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005564
Eduardo Habkoste8f2d272016-05-12 11:10:04 -03005565 qcrypto_init(&error_fatal);
Daniel P. Berrangec2297082016-04-06 12:12:06 +01005566
Daniel P. Berrange064097d2016-02-10 18:41:01 +00005567 module_call_init(MODULE_INIT_QOM);
bellardea2384d2004-08-01 21:59:26 +00005568 bdrv_init();
Fam Zhengac1307a2014-04-22 13:36:11 +08005569 if (argc < 2) {
5570 error_exit("Not enough arguments");
5571 }
Stuart Brady153859b2009-06-07 00:42:17 +01005572
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00005573 qemu_add_opts(&qemu_source_opts);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005574 qemu_add_opts(&qemu_trace_opts);
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00005575
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005576 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
Denis V. Lunev10985132016-06-17 17:44:13 +03005577 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005578 case ':':
5579 missing_argument(argv[optind - 1]);
5580 return 0;
Stefan Hajnoczi4581c162017-03-17 18:45:39 +08005581 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005582 unrecognized_option(argv[optind - 1]);
5583 return 0;
5584 case 'h':
Denis V. Lunev10985132016-06-17 17:44:13 +03005585 help();
5586 return 0;
5587 case 'V':
5588 printf(QEMU_IMG_VERSION);
5589 return 0;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005590 case 'T':
Paolo Bonzini92eecff2020-11-02 06:58:41 -05005591 trace_opt_parse(optarg);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005592 break;
Stuart Brady153859b2009-06-07 00:42:17 +01005593 }
bellardea2384d2004-08-01 21:59:26 +00005594 }
Stuart Brady153859b2009-06-07 00:42:17 +01005595
Denis V. Lunev10985132016-06-17 17:44:13 +03005596 cmdname = argv[optind];
Jeff Cody7db16892014-04-25 17:02:32 -04005597
Denis V. Lunev10985132016-06-17 17:44:13 +03005598 /* reset getopt_long scanning */
5599 argc -= optind;
5600 if (argc < 1) {
Jeff Cody5f6979c2014-04-28 14:37:18 -04005601 return 0;
5602 }
Denis V. Lunev10985132016-06-17 17:44:13 +03005603 argv += optind;
Richard W.M. Jonesd339d762019-01-18 10:11:14 +00005604 qemu_reset_optind();
Denis V. Lunev10985132016-06-17 17:44:13 +03005605
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005606 if (!trace_init_backends()) {
5607 exit(1);
5608 }
Paolo Bonzini92eecff2020-11-02 06:58:41 -05005609 trace_init_file();
Richard Hendersonc5955f42022-04-17 11:29:44 -07005610 qemu_set_log(LOG_TRACE, &error_fatal);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005611
Denis V. Lunev10985132016-06-17 17:44:13 +03005612 /* find the command */
5613 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
5614 if (!strcmp(cmdname, cmd->name)) {
5615 return cmd->handler(argc, argv);
5616 }
5617 }
Jeff Cody7db16892014-04-25 17:02:32 -04005618
Stuart Brady153859b2009-06-07 00:42:17 +01005619 /* not found */
Fam Zhengac1307a2014-04-22 13:36:11 +08005620 error_exit("Command not found: %s", cmdname);
bellardea2384d2004-08-01 21:59:26 +00005621}