blob: 3b7700c780d80f0808e03d40f70f19855cf0da46 [file] [log] [blame]
bellardea2384d2004-08-01 21:59:26 +00001/*
bellardfb43f4d2006-08-07 21:34:46 +00002 * QEMU disk image utility
ths5fafdf22007-09-16 21:08:06 +00003 *
bellard68d0f702008-01-06 17:21:48 +00004 * Copyright (c) 2003-2008 Fabrice Bellard
ths5fafdf22007-09-16 21:08:06 +00005 *
bellardea2384d2004-08-01 21:59:26 +00006 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
Markus Armbruster452fcdb2018-02-01 12:18:39 +010024
Peter Maydell80c71a22016-01-18 18:01:42 +000025#include "qemu/osdep.h"
Eric Blakec2a3d7d2017-07-21 08:50:47 -050026#include <getopt.h>
27
Markus Armbrustera8d25322019-05-23 16:35:08 +020028#include "qemu-common.h"
Fam Zheng67a1de02016-06-01 17:44:21 +080029#include "qemu-version.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010030#include "qapi/error.h"
Eric Blake3b51ab42020-05-12 20:16:45 -050031#include "qapi/qapi-commands-block-core.h"
Markus Armbruster9af23982018-02-11 10:36:01 +010032#include "qapi/qapi-visit-block-core.h"
Daniel P. Berrangeb3db2112016-09-30 15:45:27 +010033#include "qapi/qobject-output-visitor.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010034#include "qapi/qmp/qjson.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010035#include "qapi/qmp/qdict.h"
Markus Armbrusterfc81fa12018-02-01 12:18:40 +010036#include "qapi/qmp/qstring.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"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000046#include "qom/object_interfaces.h"
Markus Armbruster26f54e92014-10-07 13:59:04 +020047#include "sysemu/block-backend.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010048#include "block/block_int.h"
Max Reitzd4a32382014-10-24 15:57:37 +020049#include "block/blockjob.h"
Wenchao Xiaf364ec62013-05-25 11:09:44 +080050#include "block/qapi.h"
Daniel P. Berrangec2297082016-04-06 12:12:06 +010051#include "crypto/init.h"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +030052#include "trace/control.h"
bellarde8445332006-06-14 15:32:10 +000053
Thomas Huth7e563bf2018-02-15 12:06:47 +010054#define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
Thomas Huth0781dd62016-10-05 11:54:44 +020055 "\n" QEMU_COPYRIGHT "\n"
Jeff Cody5f6979c2014-04-28 14:37:18 -040056
Anthony Liguoric227f092009-10-01 16:12:16 -050057typedef struct img_cmd_t {
Stuart Brady153859b2009-06-07 00:42:17 +010058 const char *name;
59 int (*handler)(int argc, char **argv);
Anthony Liguoric227f092009-10-01 16:12:16 -050060} img_cmd_t;
Stuart Brady153859b2009-06-07 00:42:17 +010061
Federico Simoncelli8599ea42013-01-28 06:59:47 -050062enum {
63 OPTION_OUTPUT = 256,
64 OPTION_BACKING_CHAIN = 257,
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000065 OPTION_OBJECT = 258,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000066 OPTION_IMAGE_OPTS = 259,
Kevin Wolfb6495fa2015-07-10 18:09:18 +020067 OPTION_PATTERN = 260,
Kevin Wolf55d539c2016-06-03 13:59:41 +020068 OPTION_FLUSH_INTERVAL = 261,
69 OPTION_NO_DRAIN = 262,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +010070 OPTION_TARGET_IMAGE_OPTS = 263,
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +010071 OPTION_SIZE = 264,
Max Reitzdc5f6902017-06-13 22:20:55 +020072 OPTION_PREALLOCATION = 265,
Pavel Butsykin4ffca892017-09-18 15:42:27 +030073 OPTION_SHRINK = 266,
Max Reitz8eaac022019-05-07 22:35:03 +020074 OPTION_SALVAGE = 267,
David Edmondson168468f2020-02-05 11:02:48 +000075 OPTION_TARGET_IS_ZERO = 268,
Eric Blake3b51ab42020-05-12 20:16:45 -050076 OPTION_ADD = 269,
77 OPTION_REMOVE = 270,
78 OPTION_CLEAR = 271,
79 OPTION_ENABLE = 272,
80 OPTION_DISABLE = 273,
81 OPTION_MERGE = 274,
Eric Blake15e39ad2020-05-21 14:21:36 -050082 OPTION_BITMAPS = 275,
Maxim Levitskya3579bf2020-06-25 14:55:38 +020083 OPTION_FORCE = 276,
Federico Simoncelli8599ea42013-01-28 06:59:47 -050084};
85
86typedef enum OutputFormat {
87 OFORMAT_JSON,
88 OFORMAT_HUMAN,
89} OutputFormat;
90
Kevin Wolfe6996142016-03-15 13:03:11 +010091/* Default to cache=writeback as data integrity is not important for qemu-img */
Federico Simoncelli661a0f72011-06-20 12:48:19 -040092#define BDRV_DEFAULT_CACHE "writeback"
aurel32137519c2008-11-30 19:12:49 +000093
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +010094static void format_print(void *opaque, const char *name)
bellardea2384d2004-08-01 21:59:26 +000095{
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +010096 printf(" %s", name);
bellardea2384d2004-08-01 21:59:26 +000097}
98
Fam Zhengac1307a2014-04-22 13:36:11 +080099static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
100{
101 va_list ap;
102
Fam Zhengac1307a2014-04-22 13:36:11 +0800103 va_start(ap, fmt);
Markus Armbrustere9e1d922019-04-17 21:06:27 +0200104 error_vreport(fmt, ap);
Fam Zhengac1307a2014-04-22 13:36:11 +0800105 va_end(ap);
106
Markus Armbrustere9e1d922019-04-17 21:06:27 +0200107 error_printf("Try 'qemu-img --help' for more information\n");
Fam Zhengac1307a2014-04-22 13:36:11 +0800108 exit(EXIT_FAILURE);
109}
110
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800111static void QEMU_NORETURN missing_argument(const char *option)
112{
113 error_exit("missing argument for option '%s'", option);
114}
115
116static void QEMU_NORETURN unrecognized_option(const char *option)
117{
118 error_exit("unrecognized option '%s'", option);
119}
120
Eric Blake0562adf2020-05-12 20:16:41 -0500121/* Please keep in synch with docs/tools/qemu-img.rst */
Fam Zhengac1307a2014-04-22 13:36:11 +0800122static void QEMU_NORETURN help(void)
bellardea2384d2004-08-01 21:59:26 +0000123{
Paolo Bonzinie00291c2010-02-04 16:49:56 +0100124 const char *help_msg =
Jeff Cody5f6979c2014-04-28 14:37:18 -0400125 QEMU_IMG_VERSION
Denis V. Lunev10985132016-06-17 17:44:13 +0300126 "usage: qemu-img [standard options] command [command options]\n"
malc3f020d72010-02-08 12:04:56 +0300127 "QEMU disk image utility\n"
128 "\n"
Denis V. Lunev10985132016-06-17 17:44:13 +0300129 " '-h', '--help' display this help and exit\n"
130 " '-V', '--version' output version information and exit\n"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +0300131 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
132 " specify tracing options\n"
Denis V. Lunev10985132016-06-17 17:44:13 +0300133 "\n"
malc3f020d72010-02-08 12:04:56 +0300134 "Command syntax:\n"
Stuart Brady153859b2009-06-07 00:42:17 +0100135#define DEF(option, callback, arg_string) \
136 " " arg_string "\n"
137#include "qemu-img-cmds.h"
138#undef DEF
malc3f020d72010-02-08 12:04:56 +0300139 "\n"
140 "Command parameters:\n"
141 " 'filename' is a disk image filename\n"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000142 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
143 " manual page for a description of the object properties. The most common\n"
144 " object type is a 'secret', which is used to supply passwords and/or\n"
145 " encryption keys.\n"
malc3f020d72010-02-08 12:04:56 +0300146 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400147 " 'cache' is the cache mode used to write the output disk image, the valid\n"
Liu Yuan80ccf932012-04-20 17:10:56 +0800148 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
149 " 'directsync' and 'unsafe' (default for convert)\n"
Stefan Hajnoczibb87fdf2014-09-02 11:01:02 +0100150 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
151 " options are the same as for the 'cache' option\n"
malc3f020d72010-02-08 12:04:56 +0300152 " 'size' is the disk image size in bytes. Optional suffixes\n"
Kevin Wolf5e009842013-06-05 14:19:27 +0200153 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
154 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
155 " supported. 'b' is ignored.\n"
malc3f020d72010-02-08 12:04:56 +0300156 " 'output_filename' is the destination disk image filename\n"
157 " 'output_fmt' is the destination format\n"
158 " 'options' is a comma separated list of format specific options in a\n"
159 " name=value format. Use -o ? for an overview of the options supported by the\n"
160 " used format\n"
Wenchao Xiaef806542013-12-04 17:10:57 +0800161 " 'snapshot_param' is param used for internal snapshot, format\n"
162 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
163 " '[ID_OR_NAME]'\n"
malc3f020d72010-02-08 12:04:56 +0300164 " '-c' indicates that target image must be compressed (qcow format only)\n"
John Snow6e6e55f2017-07-17 20:34:22 -0400165 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
166 " new backing file match exactly. The image doesn't need a working\n"
167 " backing file before rebasing in this case (useful for renaming the\n"
168 " backing file). For image creation, allow creating without attempting\n"
169 " to open the backing file.\n"
malc3f020d72010-02-08 12:04:56 +0300170 " '-h' with or without a command shows this help and lists the supported formats\n"
Jes Sorensen6b837bc2011-03-30 14:16:25 +0200171 " '-p' show progress of command (only certain commands)\n"
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100172 " '-q' use Quiet mode - do not print any output (except errors)\n"
Peter Lieven11b66992013-10-24 12:07:05 +0200173 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
174 " contain only zeros for qemu-img to create a sparse image during\n"
175 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
176 " unallocated or zero sectors, and the destination image will always be\n"
177 " fully allocated\n"
Benoît Canetc054b3f2012-09-05 13:09:02 +0200178 " '--output' takes the format in which the output must be done (human or json)\n"
Alexandre Derumierb2e10492013-09-02 19:07:24 +0100179 " '-n' skips the target volume creation (useful if the volume is created\n"
180 " prior to running qemu-img)\n"
malc3f020d72010-02-08 12:04:56 +0300181 "\n"
Eric Blake3b51ab42020-05-12 20:16:45 -0500182 "Parameters to bitmap subcommand:\n"
183 " 'bitmap' is the name of the bitmap to manipulate, through one or more\n"
184 " actions from '--add', '--remove', '--clear', '--enable', '--disable',\n"
185 " or '--merge source'\n"
186 " '-g granularity' sets the granularity for '--add' actions\n"
187 " '-b source' and '-F src_fmt' tell '--merge' actions to find the source\n"
188 " bitmaps from an alternative file\n"
189 "\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200190 "Parameters to check subcommand:\n"
191 " '-r' tries to repair any inconsistencies that are found during the check.\n"
192 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
193 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
Stefan Weil0546b8c2012-08-10 22:03:25 +0200194 " hiding corruption that has already occurred.\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200195 "\n"
Peter Lieven2d9187b2017-02-28 13:40:07 +0100196 "Parameters to convert subcommand:\n"
Eric Blake15e39ad2020-05-21 14:21:36 -0500197 " '--bitmaps' copies all top-level persistent bitmaps to destination\n"
Peter Lieven2d9187b2017-02-28 13:40:07 +0100198 " '-m' specifies how many coroutines work in parallel during the convert\n"
199 " process (defaults to 8)\n"
200 " '-W' allow to write to the target out of order rather than sequential\n"
201 "\n"
malc3f020d72010-02-08 12:04:56 +0300202 "Parameters to snapshot subcommand:\n"
203 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
204 " '-a' applies a snapshot (revert disk to saved state)\n"
205 " '-c' creates a snapshot\n"
206 " '-d' deletes a snapshot\n"
Miroslav Rezaninad14ed182013-02-13 09:09:41 +0100207 " '-l' lists all snapshots in the given image\n"
208 "\n"
209 "Parameters to compare subcommand:\n"
210 " '-f' first image format\n"
211 " '-F' second image format\n"
Reda Sallahi86ce1f62016-08-10 04:43:12 +0200212 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
213 "\n"
214 "Parameters to dd subcommand:\n"
215 " 'bs=BYTES' read and write up to BYTES bytes at a time "
216 "(default: 512)\n"
217 " 'count=N' copy only N input blocks\n"
218 " 'if=FILE' read from FILE\n"
Reda Sallahif7c15532016-08-10 16:16:09 +0200219 " 'of=FILE' write to FILE\n"
220 " 'skip=N' skip N bs-sized blocks at the start of input\n";
Paolo Bonzinie00291c2010-02-04 16:49:56 +0100221
222 printf("%s\nSupported formats:", help_msg);
Andrey Shinkevich9ac404c2019-03-07 16:33:58 +0300223 bdrv_iterate_format(format_print, NULL, false);
Eric Blakef5048cb2017-08-03 11:33:53 -0500224 printf("\n\n" QEMU_HELP_BOTTOM "\n");
Fam Zhengac1307a2014-04-22 13:36:11 +0800225 exit(EXIT_SUCCESS);
bellardea2384d2004-08-01 21:59:26 +0000226}
227
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000228static QemuOptsList qemu_object_opts = {
229 .name = "object",
230 .implied_opt_name = "qom-type",
231 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
232 .desc = {
233 { }
234 },
235};
236
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +0200237static bool qemu_img_object_print_help(const char *type, QemuOpts *opts)
238{
239 if (user_creatable_print_help(type, opts)) {
240 exit(0);
241 }
242 return true;
243}
244
Markus Armbruster80c710c2020-04-15 09:49:26 +0200245/*
246 * Is @optarg safe for accumulate_options()?
247 * It is when multiple of them can be joined together separated by ','.
248 * To make that work, @optarg must not start with ',' (or else a
249 * separating ',' preceding it gets escaped), and it must not end with
250 * an odd number of ',' (or else a separating ',' following it gets
Markus Armbrusterf62514b2020-04-15 09:49:27 +0200251 * escaped), or be empty (or else a separating ',' preceding it can
252 * escape a separating ',' following it).
253 *
Markus Armbruster80c710c2020-04-15 09:49:26 +0200254 */
255static bool is_valid_option_list(const char *optarg)
256{
257 size_t len = strlen(optarg);
258 size_t i;
259
Markus Armbrusterf62514b2020-04-15 09:49:27 +0200260 if (!optarg[0] || optarg[0] == ',') {
Markus Armbruster80c710c2020-04-15 09:49:26 +0200261 return false;
262 }
263
264 for (i = len; i > 0 && optarg[i - 1] == ','; i--) {
265 }
266 if ((len - i) % 2) {
267 return false;
268 }
269
270 return true;
271}
272
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +0200273static int accumulate_options(char **options, char *optarg)
274{
275 char *new_options;
276
277 if (!is_valid_option_list(optarg)) {
278 error_report("Invalid option list: %s", optarg);
279 return -1;
280 }
281
282 if (!*options) {
283 *options = g_strdup(optarg);
284 } else {
285 new_options = g_strdup_printf("%s,%s", *options, optarg);
286 g_free(*options);
287 *options = new_options;
288 }
289 return 0;
290}
291
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000292static QemuOptsList qemu_source_opts = {
293 .name = "source",
294 .implied_opt_name = "file",
295 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
296 .desc = {
297 { }
298 },
299};
300
Stefan Weil7c30f652013-06-16 17:01:05 +0200301static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100302{
303 int ret = 0;
304 if (!quiet) {
305 va_list args;
306 va_start(args, fmt);
307 ret = vprintf(fmt, args);
308 va_end(args);
309 }
310 return ret;
311}
312
bellardea2384d2004-08-01 21:59:26 +0000313
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100314static int print_block_option_help(const char *filename, const char *fmt)
315{
316 BlockDriver *drv, *proto_drv;
Chunyan Liu83d05212014-06-05 17:20:51 +0800317 QemuOptsList *create_opts = NULL;
Max Reitzb65a5e12015-02-05 13:58:12 -0500318 Error *local_err = NULL;
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100319
320 /* Find driver and parse its options */
321 drv = bdrv_find_format(fmt);
322 if (!drv) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100323 error_report("Unknown file format '%s'", fmt);
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100324 return 1;
325 }
326
Max Reitzd402b6a2018-05-09 23:00:21 +0200327 if (!drv->create_opts) {
328 error_report("Format driver '%s' does not support image creation", fmt);
329 return 1;
330 }
331
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800332 create_opts = qemu_opts_append(create_opts, drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100333 if (filename) {
Max Reitzb65a5e12015-02-05 13:58:12 -0500334 proto_drv = bdrv_find_protocol(filename, true, &local_err);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100335 if (!proto_drv) {
Markus Armbruster2867ce42015-03-12 16:08:02 +0100336 error_report_err(local_err);
Chunyan Liu83d05212014-06-05 17:20:51 +0800337 qemu_opts_free(create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100338 return 1;
339 }
Max Reitzd402b6a2018-05-09 23:00:21 +0200340 if (!proto_drv->create_opts) {
Max Reitzf0998872018-11-19 11:19:20 +0100341 error_report("Protocol driver '%s' does not support image creation",
Max Reitzd402b6a2018-05-09 23:00:21 +0200342 proto_drv->format_name);
Max Reitz3ecd5a42018-11-19 11:19:21 +0100343 qemu_opts_free(create_opts);
Max Reitzd402b6a2018-05-09 23:00:21 +0200344 return 1;
345 }
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800346 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100347 }
348
Max Reitzf4619af2019-04-13 17:20:37 +0200349 if (filename) {
350 printf("Supported options:\n");
351 } else {
352 printf("Supported %s options:\n", fmt);
353 }
Max Reitz63898712018-10-19 18:49:25 +0200354 qemu_opts_print_help(create_opts, false);
Chunyan Liu83d05212014-06-05 17:20:51 +0800355 qemu_opts_free(create_opts);
Max Reitzf4619af2019-04-13 17:20:37 +0200356
357 if (!filename) {
358 printf("\n"
359 "The protocol level may support further options.\n"
360 "Specify the target filename to include those options.\n");
361 }
362
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100363 return 0;
364}
365
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000366
Max Reitzefaa7c42016-03-16 19:54:38 +0100367static BlockBackend *img_open_opts(const char *optstr,
Kevin Wolfce099542016-03-15 13:01:04 +0100368 QemuOpts *opts, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800369 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000370{
371 QDict *options;
372 Error *local_err = NULL;
373 BlockBackend *blk;
374 options = qemu_opts_to_qdict(opts, NULL);
Fam Zheng335e9932017-05-03 00:35:39 +0800375 if (force_share) {
376 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
Max Reitz4615f872018-05-02 22:20:50 +0200377 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
Fam Zheng335e9932017-05-03 00:35:39 +0800378 error_report("--force-share/-U conflicts with image options");
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200379 qobject_unref(options);
Fam Zheng335e9932017-05-03 00:35:39 +0800380 return NULL;
381 }
Max Reitz4615f872018-05-02 22:20:50 +0200382 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
Fam Zheng335e9932017-05-03 00:35:39 +0800383 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100384 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000385 if (!blk) {
Daniel P. Berrange143605a2016-04-06 10:16:18 +0100386 error_reportf_err(local_err, "Could not open '%s': ", optstr);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000387 return NULL;
388 }
Kevin Wolfce099542016-03-15 13:01:04 +0100389 blk_set_enable_write_cache(blk, !writethrough);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000390
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000391 return blk;
392}
393
Max Reitzefaa7c42016-03-16 19:54:38 +0100394static BlockBackend *img_open_file(const char *filename,
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100395 QDict *options,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000396 const char *fmt, int flags,
Fam Zheng335e9932017-05-03 00:35:39 +0800397 bool writethrough, bool quiet,
398 bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000399{
400 BlockBackend *blk;
Max Reitz34b5d2c2013-09-05 14:45:29 +0200401 Error *local_err = NULL;
Kevin Wolfad717132010-12-16 15:37:41 +0100402
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100403 if (!options) {
404 options = qdict_new();
405 }
bellard75c23802004-08-27 21:28:58 +0000406 if (fmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -0500407 qdict_put_str(options, "driver", fmt);
bellard75c23802004-08-27 21:28:58 +0000408 }
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100409
Fam Zheng335e9932017-05-03 00:35:39 +0800410 if (force_share) {
Eric Blake579cf1d2017-05-15 14:54:39 -0500411 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Fam Zheng335e9932017-05-03 00:35:39 +0800412 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100413 blk = blk_new_open(filename, NULL, options, flags, &local_err);
Max Reitz5bd31322015-02-05 13:58:16 -0500414 if (!blk) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100415 error_reportf_err(local_err, "Could not open '%s': ", filename);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000416 return NULL;
bellard75c23802004-08-27 21:28:58 +0000417 }
Kevin Wolfce099542016-03-15 13:01:04 +0100418 blk_set_enable_write_cache(blk, !writethrough);
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100419
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200420 return blk;
bellard75c23802004-08-27 21:28:58 +0000421}
422
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000423
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100424static int img_add_key_secrets(void *opaque,
425 const char *name, const char *value,
426 Error **errp)
427{
428 QDict *options = opaque;
429
430 if (g_str_has_suffix(name, "key-secret")) {
Eric Blake187f47e2017-06-24 12:10:07 -0600431 qdict_put_str(options, name, value);
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100432 }
433
434 return 0;
435}
436
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100437
Max Reitzefaa7c42016-03-16 19:54:38 +0100438static BlockBackend *img_open(bool image_opts,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000439 const char *filename,
Kevin Wolfce099542016-03-15 13:01:04 +0100440 const char *fmt, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800441 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000442{
443 BlockBackend *blk;
444 if (image_opts) {
445 QemuOpts *opts;
446 if (fmt) {
447 error_report("--image-opts and --format are mutually exclusive");
448 return NULL;
449 }
450 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
451 filename, true);
452 if (!opts) {
453 return NULL;
454 }
Fam Zheng335e9932017-05-03 00:35:39 +0800455 blk = img_open_opts(filename, opts, flags, writethrough, quiet,
456 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000457 } else {
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100458 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
Fam Zheng335e9932017-05-03 00:35:39 +0800459 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000460 }
461 return blk;
462}
463
464
Chunyan Liu83d05212014-06-05 17:20:51 +0800465static int add_old_style_options(const char *fmt, QemuOpts *opts,
Jes Sorenseneec77d92010-12-07 17:44:34 +0100466 const char *base_filename,
467 const char *base_fmt)
Kevin Wolfefa84d42009-05-18 16:42:12 +0200468{
Kevin Wolfefa84d42009-05-18 16:42:12 +0200469 if (base_filename) {
Markus Armbruster235e59c2020-07-07 18:05:42 +0200470 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename,
Markus Armbruster9e194e02020-07-07 18:06:11 +0200471 NULL)) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100472 error_report("Backing file not supported for file format '%s'",
473 fmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900474 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200475 }
476 }
477 if (base_fmt) {
Markus Armbruster9e194e02020-07-07 18:06:11 +0200478 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, NULL)) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100479 error_report("Backing file format not supported for file "
480 "format '%s'", fmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900481 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200482 }
483 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900484 return 0;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200485}
486
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300487static int64_t cvtnum_full(const char *name, const char *value, int64_t min,
488 int64_t max)
Markus Armbruster606caa02017-02-21 21:14:04 +0100489{
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100490 int err;
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300491 uint64_t res;
Markus Armbruster606caa02017-02-21 21:14:04 +0100492
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300493 err = qemu_strtosz(value, NULL, &res);
494 if (err < 0 && err != -ERANGE) {
495 error_report("Invalid %s specified. You may use "
496 "k, M, G, T, P or E suffixes for", name);
497 error_report("kilobytes, megabytes, gigabytes, terabytes, "
498 "petabytes and exabytes.");
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100499 return err;
500 }
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300501 if (err == -ERANGE || res > max || res < min) {
502 error_report("Invalid %s specified. Must be between %" PRId64
503 " and %" PRId64 ".", name, min, max);
Markus Armbrusterf46bfdb2017-02-21 21:14:07 +0100504 return -ERANGE;
505 }
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300506 return res;
507}
508
509static int64_t cvtnum(const char *name, const char *value)
510{
511 return cvtnum_full(name, value, 0, INT64_MAX);
Markus Armbruster606caa02017-02-21 21:14:04 +0100512}
513
bellardea2384d2004-08-01 21:59:26 +0000514static int img_create(int argc, char **argv)
515{
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200516 int c;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100517 uint64_t img_size = -1;
bellardea2384d2004-08-01 21:59:26 +0000518 const char *fmt = "raw";
aliguori9230eaf2009-03-28 17:55:19 +0000519 const char *base_fmt = NULL;
bellardea2384d2004-08-01 21:59:26 +0000520 const char *filename;
521 const char *base_filename = NULL;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200522 char *options = NULL;
Luiz Capitulino9b375252012-11-30 10:52:05 -0200523 Error *local_err = NULL;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100524 bool quiet = false;
John Snow6e6e55f2017-07-17 20:34:22 -0400525 int flags = 0;
ths3b46e622007-09-17 08:09:54 +0000526
bellardea2384d2004-08-01 21:59:26 +0000527 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000528 static const struct option long_options[] = {
529 {"help", no_argument, 0, 'h'},
530 {"object", required_argument, 0, OPTION_OBJECT},
531 {0, 0, 0, 0}
532 };
John Snow6e6e55f2017-07-17 20:34:22 -0400533 c = getopt_long(argc, argv, ":F:b:f:ho:qu",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000534 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100535 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000536 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100537 }
bellardea2384d2004-08-01 21:59:26 +0000538 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800539 case ':':
540 missing_argument(argv[optind - 1]);
541 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100542 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800543 unrecognized_option(argv[optind - 1]);
544 break;
bellardea2384d2004-08-01 21:59:26 +0000545 case 'h':
546 help();
547 break;
aliguori9230eaf2009-03-28 17:55:19 +0000548 case 'F':
549 base_fmt = optarg;
550 break;
bellardea2384d2004-08-01 21:59:26 +0000551 case 'b':
552 base_filename = optarg;
553 break;
554 case 'f':
555 fmt = optarg;
556 break;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200557 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +0200558 if (accumulate_options(&options, optarg) < 0) {
Kevin Wolf77386bf2014-02-21 16:24:04 +0100559 goto fail;
560 }
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200561 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100562 case 'q':
563 quiet = true;
564 break;
John Snow6e6e55f2017-07-17 20:34:22 -0400565 case 'u':
566 flags |= BDRV_O_NO_BACKING;
567 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000568 case OPTION_OBJECT: {
569 QemuOpts *opts;
570 opts = qemu_opts_parse_noisily(&qemu_object_opts,
571 optarg, true);
572 if (!opts) {
573 goto fail;
574 }
575 } break;
bellardea2384d2004-08-01 21:59:26 +0000576 }
577 }
aliguori9230eaf2009-03-28 17:55:19 +0000578
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900579 /* Get the filename */
Kevin Wolfa283cb62014-02-21 16:24:07 +0100580 filename = (optind < argc) ? argv[optind] : NULL;
581 if (options && has_help_option(options)) {
582 g_free(options);
583 return print_block_option_help(filename, fmt);
584 }
585
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100586 if (optind >= argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800587 error_exit("Expecting image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100588 }
Kevin Wolfa283cb62014-02-21 16:24:07 +0100589 optind++;
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900590
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000591 if (qemu_opts_foreach(&qemu_object_opts,
592 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +0200593 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000594 goto fail;
595 }
596
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100597 /* Get image size, if specified */
598 if (optind < argc) {
Jes Sorensen70b4f4b2011-01-05 11:41:02 +0100599 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +0100600
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300601 sval = cvtnum("image size", argv[optind++]);
Markus Armbruster606caa02017-02-21 21:14:04 +0100602 if (sval < 0) {
Kevin Wolf77386bf2014-02-21 16:24:04 +0100603 goto fail;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100604 }
605 img_size = (uint64_t)sval;
606 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200607 if (optind != argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800608 error_exit("Unexpected argument: %s", argv[optind]);
Kevin Wolffc11eb22013-08-05 10:53:04 +0200609 }
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100610
Luiz Capitulino9b375252012-11-30 10:52:05 -0200611 bdrv_img_create(filename, fmt, base_filename, base_fmt,
John Snow6e6e55f2017-07-17 20:34:22 -0400612 options, img_size, flags, quiet, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100613 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100614 error_reportf_err(local_err, "%s: ", filename);
Kevin Wolf77386bf2014-02-21 16:24:04 +0100615 goto fail;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900616 }
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200617
Kevin Wolf77386bf2014-02-21 16:24:04 +0100618 g_free(options);
bellardea2384d2004-08-01 21:59:26 +0000619 return 0;
Kevin Wolf77386bf2014-02-21 16:24:04 +0100620
621fail:
622 g_free(options);
623 return 1;
bellardea2384d2004-08-01 21:59:26 +0000624}
625
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100626static void dump_json_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500627{
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500628 QString *str;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500629 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +0100630 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600631
632 visit_type_ImageCheck(v, NULL, &check, &error_abort);
633 visit_complete(v, &obj);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500634 str = qobject_to_json_pretty(obj);
635 assert(str != NULL);
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100636 qprintf(quiet, "%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200637 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600638 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200639 qobject_unref(str);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500640}
641
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100642static void dump_human_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500643{
644 if (!(check->corruptions || check->leaks || check->check_errors)) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100645 qprintf(quiet, "No errors were found on the image.\n");
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500646 } else {
647 if (check->corruptions) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100648 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
649 "Data may be corrupted, or further writes to the image "
650 "may corrupt it.\n",
651 check->corruptions);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500652 }
653
654 if (check->leaks) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100655 qprintf(quiet,
656 "\n%" PRId64 " leaked clusters were found on the image.\n"
657 "This means waste of disk space, but no harm to data.\n",
658 check->leaks);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500659 }
660
661 if (check->check_errors) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100662 qprintf(quiet,
663 "\n%" PRId64
664 " internal errors have occurred during the check.\n",
665 check->check_errors);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500666 }
667 }
668
669 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100670 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
671 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
672 check->allocated_clusters, check->total_clusters,
673 check->allocated_clusters * 100.0 / check->total_clusters,
674 check->fragmented_clusters * 100.0 / check->allocated_clusters,
675 check->compressed_clusters * 100.0 /
676 check->allocated_clusters);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500677 }
678
679 if (check->image_end_offset) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100680 qprintf(quiet,
681 "Image end offset: %" PRId64 "\n", check->image_end_offset);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500682 }
683}
684
685static int collect_image_check(BlockDriverState *bs,
686 ImageCheck *check,
687 const char *filename,
688 const char *fmt,
689 int fix)
690{
691 int ret;
692 BdrvCheckResult result;
693
694 ret = bdrv_check(bs, &result, fix);
695 if (ret < 0) {
696 return ret;
697 }
698
699 check->filename = g_strdup(filename);
700 check->format = g_strdup(bdrv_get_format_name(bs));
701 check->check_errors = result.check_errors;
702 check->corruptions = result.corruptions;
703 check->has_corruptions = result.corruptions != 0;
704 check->leaks = result.leaks;
705 check->has_leaks = result.leaks != 0;
706 check->corruptions_fixed = result.corruptions_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100707 check->has_corruptions_fixed = result.corruptions_fixed != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500708 check->leaks_fixed = result.leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100709 check->has_leaks_fixed = result.leaks_fixed != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500710 check->image_end_offset = result.image_end_offset;
711 check->has_image_end_offset = result.image_end_offset != 0;
712 check->total_clusters = result.bfi.total_clusters;
713 check->has_total_clusters = result.bfi.total_clusters != 0;
714 check->allocated_clusters = result.bfi.allocated_clusters;
715 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
716 check->fragmented_clusters = result.bfi.fragmented_clusters;
717 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
Stefan Hajnoczie6439d72013-02-07 17:15:04 +0100718 check->compressed_clusters = result.bfi.compressed_clusters;
719 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500720
721 return 0;
722}
723
Kevin Wolfe076f332010-06-29 11:43:13 +0200724/*
725 * Checks an image for consistency. Exit codes:
726 *
Max Reitzd6635c42014-06-02 22:15:21 +0200727 * 0 - Check completed, image is good
728 * 1 - Check not completed because of internal errors
729 * 2 - Check completed, image is corrupted
730 * 3 - Check completed, image has leaked clusters, but is good otherwise
731 * 63 - Checks are not supported by the image format
Kevin Wolfe076f332010-06-29 11:43:13 +0200732 */
aliguori15859692009-04-21 23:11:53 +0000733static int img_check(int argc, char **argv)
734{
735 int c, ret;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500736 OutputFormat output_format = OFORMAT_HUMAN;
Max Reitz40055952014-07-22 22:58:42 +0200737 const char *filename, *fmt, *output, *cache;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200738 BlockBackend *blk;
aliguori15859692009-04-21 23:11:53 +0000739 BlockDriverState *bs;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200740 int fix = 0;
Kevin Wolfce099542016-03-15 13:01:04 +0100741 int flags = BDRV_O_CHECK;
742 bool writethrough;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200743 ImageCheck *check;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100744 bool quiet = false;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000745 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +0800746 bool force_share = false;
aliguori15859692009-04-21 23:11:53 +0000747
748 fmt = NULL;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500749 output = NULL;
Max Reitz40055952014-07-22 22:58:42 +0200750 cache = BDRV_DEFAULT_CACHE;
Kevin Wolfce099542016-03-15 13:01:04 +0100751
aliguori15859692009-04-21 23:11:53 +0000752 for(;;) {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500753 int option_index = 0;
754 static const struct option long_options[] = {
755 {"help", no_argument, 0, 'h'},
756 {"format", required_argument, 0, 'f'},
Prasad Joshi4fd6a982014-03-25 00:08:54 +0530757 {"repair", required_argument, 0, 'r'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500758 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000759 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000760 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +0800761 {"force-share", no_argument, 0, 'U'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500762 {0, 0, 0, 0}
763 };
Fam Zheng335e9932017-05-03 00:35:39 +0800764 c = getopt_long(argc, argv, ":hf:r:T:qU",
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500765 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100766 if (c == -1) {
aliguori15859692009-04-21 23:11:53 +0000767 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100768 }
aliguori15859692009-04-21 23:11:53 +0000769 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800770 case ':':
771 missing_argument(argv[optind - 1]);
772 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100773 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800774 unrecognized_option(argv[optind - 1]);
775 break;
aliguori15859692009-04-21 23:11:53 +0000776 case 'h':
777 help();
778 break;
779 case 'f':
780 fmt = optarg;
781 break;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200782 case 'r':
783 flags |= BDRV_O_RDWR;
784
785 if (!strcmp(optarg, "leaks")) {
786 fix = BDRV_FIX_LEAKS;
787 } else if (!strcmp(optarg, "all")) {
788 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
789 } else {
Fam Zhengac1307a2014-04-22 13:36:11 +0800790 error_exit("Unknown option value for -r "
791 "(expecting 'leaks' or 'all'): %s", optarg);
Kevin Wolf4534ff52012-05-11 16:07:02 +0200792 }
793 break;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500794 case OPTION_OUTPUT:
795 output = optarg;
796 break;
Max Reitz40055952014-07-22 22:58:42 +0200797 case 'T':
798 cache = optarg;
799 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100800 case 'q':
801 quiet = true;
802 break;
Fam Zheng335e9932017-05-03 00:35:39 +0800803 case 'U':
804 force_share = true;
805 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000806 case OPTION_OBJECT: {
807 QemuOpts *opts;
808 opts = qemu_opts_parse_noisily(&qemu_object_opts,
809 optarg, true);
810 if (!opts) {
811 return 1;
812 }
813 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000814 case OPTION_IMAGE_OPTS:
815 image_opts = true;
816 break;
aliguori15859692009-04-21 23:11:53 +0000817 }
818 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200819 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800820 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100821 }
aliguori15859692009-04-21 23:11:53 +0000822 filename = argv[optind++];
823
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500824 if (output && !strcmp(output, "json")) {
825 output_format = OFORMAT_JSON;
826 } else if (output && !strcmp(output, "human")) {
827 output_format = OFORMAT_HUMAN;
828 } else if (output) {
829 error_report("--output must be used with human or json as argument.");
830 return 1;
831 }
832
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000833 if (qemu_opts_foreach(&qemu_object_opts,
834 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +0200835 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000836 return 1;
837 }
838
Kevin Wolfce099542016-03-15 13:01:04 +0100839 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +0200840 if (ret < 0) {
841 error_report("Invalid source cache option: %s", cache);
842 return 1;
843 }
844
Fam Zheng335e9932017-05-03 00:35:39 +0800845 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
846 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200847 if (!blk) {
848 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900849 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200850 bs = blk_bs(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500851
852 check = g_new0(ImageCheck, 1);
853 ret = collect_image_check(bs, check, filename, fmt, fix);
Kevin Wolfe076f332010-06-29 11:43:13 +0200854
855 if (ret == -ENOTSUP) {
Max Reitz55d492d2014-05-31 21:33:30 +0200856 error_report("This image format does not support checks");
Peter Lievenfefddf92013-10-24 08:53:34 +0200857 ret = 63;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500858 goto fail;
Kevin Wolfe076f332010-06-29 11:43:13 +0200859 }
860
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500861 if (check->corruptions_fixed || check->leaks_fixed) {
862 int corruptions_fixed, leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100863 bool has_leaks_fixed, has_corruptions_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500864
865 leaks_fixed = check->leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100866 has_leaks_fixed = check->has_leaks_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500867 corruptions_fixed = check->corruptions_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100868 has_corruptions_fixed = check->has_corruptions_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500869
870 if (output_format == OFORMAT_HUMAN) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100871 qprintf(quiet,
872 "The following inconsistencies were found and repaired:\n\n"
873 " %" PRId64 " leaked clusters\n"
874 " %" PRId64 " corruptions\n\n"
875 "Double checking the fixed image now...\n",
876 check->leaks_fixed,
877 check->corruptions_fixed);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500878 }
879
Pan Nengyuanfc124ea2020-02-27 09:29:50 +0800880 qapi_free_ImageCheck(check);
881 check = g_new0(ImageCheck, 1);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500882 ret = collect_image_check(bs, check, filename, fmt, 0);
883
884 check->leaks_fixed = leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100885 check->has_leaks_fixed = has_leaks_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500886 check->corruptions_fixed = corruptions_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100887 check->has_corruptions_fixed = has_corruptions_fixed;
Kevin Wolfccf34712012-05-11 18:16:54 +0200888 }
889
Max Reitz832390a2014-10-23 15:29:12 +0200890 if (!ret) {
891 switch (output_format) {
892 case OFORMAT_HUMAN:
893 dump_human_image_check(check, quiet);
894 break;
895 case OFORMAT_JSON:
896 dump_json_image_check(check, quiet);
897 break;
898 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500899 }
900
901 if (ret || check->check_errors) {
Max Reitz832390a2014-10-23 15:29:12 +0200902 if (ret) {
903 error_report("Check failed: %s", strerror(-ret));
904 } else {
905 error_report("Check failed");
906 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500907 ret = 1;
908 goto fail;
909 }
910
911 if (check->corruptions) {
912 ret = 2;
913 } else if (check->leaks) {
914 ret = 3;
Kevin Wolfe076f332010-06-29 11:43:13 +0200915 } else {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500916 ret = 0;
aliguori15859692009-04-21 23:11:53 +0000917 }
918
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500919fail:
920 qapi_free_ImageCheck(check);
Markus Armbruster26f54e92014-10-07 13:59:04 +0200921 blk_unref(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500922 return ret;
aliguori15859692009-04-21 23:11:53 +0000923}
924
Max Reitzd4a32382014-10-24 15:57:37 +0200925typedef struct CommonBlockJobCBInfo {
926 BlockDriverState *bs;
927 Error **errp;
928} CommonBlockJobCBInfo;
929
930static void common_block_job_cb(void *opaque, int ret)
931{
932 CommonBlockJobCBInfo *cbi = opaque;
933
934 if (ret < 0) {
935 error_setg_errno(cbi->errp, -ret, "Block job failed");
936 }
Max Reitzd4a32382014-10-24 15:57:37 +0200937}
938
939static void run_block_job(BlockJob *job, Error **errp)
940{
Kevin Wolfb75536c2016-04-18 17:30:17 +0200941 AioContext *aio_context = blk_get_aio_context(job->blk);
sochin.jiang4172a002017-06-15 14:47:33 +0800942 int ret = 0;
Max Reitzd4a32382014-10-24 15:57:37 +0200943
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200944 aio_context_acquire(aio_context);
Kevin Wolf80fa2c72018-04-13 18:50:05 +0200945 job_ref(&job->job);
Max Reitzd4a32382014-10-24 15:57:37 +0200946 do {
Kevin Wolf30a5c882018-05-04 12:17:20 +0200947 float progress = 0.0f;
Max Reitzd4a32382014-10-24 15:57:37 +0200948 aio_poll(aio_context, true);
Vladimir Sementsov-Ogievskiy01fe1ca2020-03-11 13:29:56 +0300949 if (job->job.progress.total) {
950 progress = (float)job->job.progress.current /
951 job->job.progress.total * 100.f;
Kevin Wolf30a5c882018-05-04 12:17:20 +0200952 }
953 qemu_progress_print(progress, 0);
Kevin Wolfdf956ae2018-04-25 15:09:58 +0200954 } while (!job_is_ready(&job->job) && !job_is_completed(&job->job));
Max Reitzd4a32382014-10-24 15:57:37 +0200955
Kevin Wolfdbe5e6c2018-04-19 13:04:01 +0200956 if (!job_is_completed(&job->job)) {
Kevin Wolf3d70ff52018-04-24 16:13:52 +0200957 ret = job_complete_sync(&job->job, errp);
sochin.jiang4172a002017-06-15 14:47:33 +0800958 } else {
Kevin Wolf4ad35182018-04-19 17:30:16 +0200959 ret = job->job.ret;
sochin.jiang4172a002017-06-15 14:47:33 +0800960 }
Kevin Wolf80fa2c72018-04-13 18:50:05 +0200961 job_unref(&job->job);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200962 aio_context_release(aio_context);
Max Reitz687fa1d2014-10-24 15:57:39 +0200963
sochin.jiang4172a002017-06-15 14:47:33 +0800964 /* publish completion progress only when success */
965 if (!ret) {
966 qemu_progress_print(100.f, 0);
967 }
Max Reitzd4a32382014-10-24 15:57:37 +0200968}
969
bellardea2384d2004-08-01 21:59:26 +0000970static int img_commit(int argc, char **argv)
971{
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400972 int c, ret, flags;
Max Reitz1b22bff2014-10-24 15:57:40 +0200973 const char *filename, *fmt, *cache, *base;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200974 BlockBackend *blk;
Max Reitzd4a32382014-10-24 15:57:37 +0200975 BlockDriverState *bs, *base_bs;
Kevin Wolf4ef85a92017-01-25 19:16:34 +0100976 BlockJob *job;
Max Reitz687fa1d2014-10-24 15:57:39 +0200977 bool progress = false, quiet = false, drop = false;
Kevin Wolfce099542016-03-15 13:01:04 +0100978 bool writethrough;
Max Reitzd4a32382014-10-24 15:57:37 +0200979 Error *local_err = NULL;
980 CommonBlockJobCBInfo cbi;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000981 bool image_opts = false;
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200982 AioContext *aio_context;
bellardea2384d2004-08-01 21:59:26 +0000983
984 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400985 cache = BDRV_DEFAULT_CACHE;
Max Reitz1b22bff2014-10-24 15:57:40 +0200986 base = NULL;
bellardea2384d2004-08-01 21:59:26 +0000987 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000988 static const struct option long_options[] = {
989 {"help", no_argument, 0, 'h'},
990 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000991 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000992 {0, 0, 0, 0}
993 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800994 c = getopt_long(argc, argv, ":f:ht:b:dpq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000995 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100996 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000997 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100998 }
bellardea2384d2004-08-01 21:59:26 +0000999 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001000 case ':':
1001 missing_argument(argv[optind - 1]);
1002 break;
Jes Sorensenef873942010-12-06 15:25:40 +01001003 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001004 unrecognized_option(argv[optind - 1]);
1005 break;
bellardea2384d2004-08-01 21:59:26 +00001006 case 'h':
1007 help();
1008 break;
1009 case 'f':
1010 fmt = optarg;
1011 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001012 case 't':
1013 cache = optarg;
1014 break;
Max Reitz1b22bff2014-10-24 15:57:40 +02001015 case 'b':
1016 base = optarg;
1017 /* -b implies -d */
1018 drop = true;
1019 break;
Max Reitz9a86fe42014-10-24 15:57:38 +02001020 case 'd':
1021 drop = true;
1022 break;
Max Reitz687fa1d2014-10-24 15:57:39 +02001023 case 'p':
1024 progress = true;
1025 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01001026 case 'q':
1027 quiet = true;
1028 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001029 case OPTION_OBJECT: {
1030 QemuOpts *opts;
1031 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1032 optarg, true);
1033 if (!opts) {
1034 return 1;
1035 }
1036 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001037 case OPTION_IMAGE_OPTS:
1038 image_opts = true;
1039 break;
bellardea2384d2004-08-01 21:59:26 +00001040 }
1041 }
Max Reitz687fa1d2014-10-24 15:57:39 +02001042
1043 /* Progress is not shown in Quiet mode */
1044 if (quiet) {
1045 progress = false;
1046 }
1047
Kevin Wolffc11eb22013-08-05 10:53:04 +02001048 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001049 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01001050 }
bellardea2384d2004-08-01 21:59:26 +00001051 filename = argv[optind++];
1052
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001053 if (qemu_opts_foreach(&qemu_object_opts,
1054 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02001055 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001056 return 1;
1057 }
1058
Max Reitz9a86fe42014-10-24 15:57:38 +02001059 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
Kevin Wolfce099542016-03-15 13:01:04 +01001060 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001061 if (ret < 0) {
1062 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczia3981eb2014-08-26 19:17:54 +01001063 return 1;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001064 }
1065
Fam Zheng335e9932017-05-03 00:35:39 +08001066 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
1067 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001068 if (!blk) {
1069 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001070 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001071 bs = blk_bs(blk);
1072
Max Reitz687fa1d2014-10-24 15:57:39 +02001073 qemu_progress_init(progress, 1.f);
1074 qemu_progress_print(0.f, 100);
1075
Max Reitz1b22bff2014-10-24 15:57:40 +02001076 if (base) {
1077 base_bs = bdrv_find_backing_image(bs, base);
1078 if (!base_bs) {
Max Reitz6b33f3a2016-12-01 03:05:08 +01001079 error_setg(&local_err,
1080 "Did not find '%s' in the backing chain of '%s'",
1081 base, filename);
Max Reitz1b22bff2014-10-24 15:57:40 +02001082 goto done;
1083 }
1084 } else {
1085 /* This is different from QMP, which by default uses the deepest file in
1086 * the backing chain (i.e., the very base); however, the traditional
1087 * behavior of qemu-img commit is using the immediate backing file. */
Max Reitz4a2061e2019-06-12 19:00:30 +02001088 base_bs = bdrv_backing_chain_next(bs);
Max Reitz1b22bff2014-10-24 15:57:40 +02001089 if (!base_bs) {
1090 error_setg(&local_err, "Image does not have a backing file");
1091 goto done;
1092 }
bellardea2384d2004-08-01 21:59:26 +00001093 }
1094
Max Reitzd4a32382014-10-24 15:57:37 +02001095 cbi = (CommonBlockJobCBInfo){
1096 .errp = &local_err,
1097 .bs = bs,
1098 };
1099
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001100 aio_context = bdrv_get_aio_context(bs);
1101 aio_context_acquire(aio_context);
Kevin Wolfbb02b652018-04-19 17:54:56 +02001102 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, 0,
Kevin Wolf0db832f2017-02-20 18:10:05 +01001103 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
Fam Zheng78bbd912017-04-21 20:27:04 +08001104 &cbi, false, &local_err);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001105 aio_context_release(aio_context);
Max Reitzd4a32382014-10-24 15:57:37 +02001106 if (local_err) {
1107 goto done;
1108 }
1109
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001110 /* When the block job completes, the BlockBackend reference will point to
1111 * the old backing file. In order to avoid that the top image is already
1112 * deleted, so we can still empty it afterwards, increment the reference
1113 * counter here preemptively. */
Max Reitz9a86fe42014-10-24 15:57:38 +02001114 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001115 bdrv_ref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001116 }
1117
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001118 job = block_job_get("commit");
Liam Merwick2e2db262018-11-05 21:38:37 +00001119 assert(job);
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001120 run_block_job(job, &local_err);
Max Reitz9a86fe42014-10-24 15:57:38 +02001121 if (local_err) {
1122 goto unref_backing;
1123 }
1124
Max Reitz2d97fde2020-04-29 16:11:26 +02001125 if (!drop) {
1126 BlockBackend *old_backing_blk;
1127
1128 old_backing_blk = blk_new_with_bs(bs, BLK_PERM_WRITE, BLK_PERM_ALL,
1129 &local_err);
1130 if (!old_backing_blk) {
1131 goto unref_backing;
1132 }
1133 ret = blk_make_empty(old_backing_blk, &local_err);
1134 blk_unref(old_backing_blk);
1135 if (ret == -ENOTSUP) {
1136 error_free(local_err);
1137 local_err = NULL;
1138 } else if (ret < 0) {
Max Reitz9a86fe42014-10-24 15:57:38 +02001139 goto unref_backing;
1140 }
1141 }
1142
1143unref_backing:
1144 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001145 bdrv_unref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001146 }
Max Reitzd4a32382014-10-24 15:57:37 +02001147
1148done:
Max Reitz687fa1d2014-10-24 15:57:39 +02001149 qemu_progress_end();
1150
Markus Armbruster26f54e92014-10-07 13:59:04 +02001151 blk_unref(blk);
Max Reitzd4a32382014-10-24 15:57:37 +02001152
1153 if (local_err) {
Markus Armbruster6936f292015-02-10 15:14:02 +01001154 error_report_err(local_err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001155 return 1;
1156 }
Max Reitzd4a32382014-10-24 15:57:37 +02001157
1158 qprintf(quiet, "Image committed.\n");
bellardea2384d2004-08-01 21:59:26 +00001159 return 0;
1160}
1161
Dmitry Konishchevf6a00aa2011-05-18 15:03:59 +04001162/*
Eric Blakedebb38a2017-10-11 22:47:11 -05001163 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1164 * of the first sector boundary within buf where the sector contains a
1165 * non-zero byte. This function is robust to a buffer that is not
1166 * sector-aligned.
1167 */
1168static int64_t find_nonzero(const uint8_t *buf, int64_t n)
1169{
1170 int64_t i;
1171 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);
1172
1173 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
1174 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
1175 return i;
1176 }
1177 }
1178 if (i < n && !buffer_is_zero(buf + i, n - end)) {
1179 return i;
1180 }
1181 return -1;
1182}
1183
1184/*
thsf58c7b32008-06-05 21:53:49 +00001185 * Returns true iff the first sector pointed to by 'buf' contains at least
1186 * a non-NUL byte.
1187 *
1188 * 'pnum' is set to the number of sectors (including and immediately following
1189 * the first one) that are known to be in the same allocated/unallocated state.
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001190 * The function will try to align the end offset to alignment boundaries so
zhaolichange3a6e0d2020-09-17 15:50:20 +08001191 * that the request will at least end aligned and consecutive requests will
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001192 * also start at an aligned offset.
thsf58c7b32008-06-05 21:53:49 +00001193 */
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001194static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
1195 int64_t sector_num, int alignment)
bellardea2384d2004-08-01 21:59:26 +00001196{
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001197 bool is_zero;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001198 int i, tail;
bellardea2384d2004-08-01 21:59:26 +00001199
1200 if (n <= 0) {
1201 *pnum = 0;
1202 return 0;
1203 }
Yi Lic075c422020-08-19 09:36:07 +08001204 is_zero = buffer_is_zero(buf, BDRV_SECTOR_SIZE);
bellardea2384d2004-08-01 21:59:26 +00001205 for(i = 1; i < n; i++) {
Yi Lic075c422020-08-19 09:36:07 +08001206 buf += BDRV_SECTOR_SIZE;
1207 if (is_zero != buffer_is_zero(buf, BDRV_SECTOR_SIZE)) {
bellardea2384d2004-08-01 21:59:26 +00001208 break;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001209 }
bellardea2384d2004-08-01 21:59:26 +00001210 }
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001211
1212 tail = (sector_num + i) & (alignment - 1);
1213 if (tail) {
1214 if (is_zero && i <= tail) {
1215 /* treat unallocated areas which only consist
1216 * of a small tail as allocated. */
1217 is_zero = false;
1218 }
1219 if (!is_zero) {
1220 /* align up end offset of allocated areas. */
1221 i += alignment - tail;
1222 i = MIN(i, n);
1223 } else {
1224 /* align down end offset of zero areas. */
1225 i -= tail;
1226 }
1227 }
bellardea2384d2004-08-01 21:59:26 +00001228 *pnum = i;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001229 return !is_zero;
bellardea2384d2004-08-01 21:59:26 +00001230}
1231
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001232/*
Kevin Wolfa22f1232011-08-26 15:27:13 +02001233 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1234 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1235 * breaking up write requests for only small sparse areas.
1236 */
1237static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001238 int min, int64_t sector_num, int alignment)
Kevin Wolfa22f1232011-08-26 15:27:13 +02001239{
1240 int ret;
1241 int num_checked, num_used;
1242
1243 if (n < min) {
1244 min = n;
1245 }
1246
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001247 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001248 if (!ret) {
1249 return ret;
1250 }
1251
1252 num_used = *pnum;
1253 buf += BDRV_SECTOR_SIZE * *pnum;
1254 n -= *pnum;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001255 sector_num += *pnum;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001256 num_checked = num_used;
1257
1258 while (n > 0) {
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001259 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001260
1261 buf += BDRV_SECTOR_SIZE * *pnum;
1262 n -= *pnum;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001263 sector_num += *pnum;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001264 num_checked += *pnum;
1265 if (ret) {
1266 num_used = num_checked;
1267 } else if (*pnum >= min) {
1268 break;
1269 }
1270 }
1271
1272 *pnum = num_used;
1273 return 1;
1274}
1275
1276/*
Eric Blakedc61cd32017-10-11 22:47:14 -05001277 * Compares two buffers sector by sector. Returns 0 if the first
1278 * sector of each buffer matches, non-zero otherwise.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001279 *
Eric Blakedc61cd32017-10-11 22:47:14 -05001280 * pnum is set to the sector-aligned size of the buffer prefix that
1281 * has the same matching status as the first sector.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001282 */
Eric Blakedc61cd32017-10-11 22:47:14 -05001283static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
1284 int64_t bytes, int64_t *pnum)
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001285{
Radim Krčmář8c1ac472015-02-20 17:06:15 +01001286 bool res;
Eric Blakedc61cd32017-10-11 22:47:14 -05001287 int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001288
Eric Blakedc61cd32017-10-11 22:47:14 -05001289 assert(bytes > 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001290
Eric Blakedc61cd32017-10-11 22:47:14 -05001291 res = !!memcmp(buf1, buf2, i);
1292 while (i < bytes) {
1293 int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001294
Eric Blakedc61cd32017-10-11 22:47:14 -05001295 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001296 break;
1297 }
Eric Blakedc61cd32017-10-11 22:47:14 -05001298 i += len;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001299 }
1300
1301 *pnum = i;
1302 return res;
1303}
1304
Stefano Garzarella97ede572019-05-08 12:43:24 +02001305#define IO_BUF_SIZE (2 * MiB)
bellardea2384d2004-08-01 21:59:26 +00001306
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001307/*
1308 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1309 *
Eric Blake0608e402017-10-11 22:47:12 -05001310 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1311 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1312 * failure), and 4 on error (the exit status for read errors), after emitting
1313 * an error message.
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001314 *
Max Reitzf1d3cd72015-02-05 13:58:18 -05001315 * @param blk: BlockBackend for the image
Eric Blakec41508e2017-10-11 22:47:13 -05001316 * @param offset: Starting offset to check
1317 * @param bytes: Number of bytes to check
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001318 * @param filename: Name of disk file we are checking (logging purpose)
1319 * @param buffer: Allocated buffer for storing read data
1320 * @param quiet: Flag for quiet mode
1321 */
Eric Blakec41508e2017-10-11 22:47:13 -05001322static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1323 int64_t bytes, const char *filename,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001324 uint8_t *buffer, bool quiet)
1325{
Eric Blakedebb38a2017-10-11 22:47:11 -05001326 int ret = 0;
1327 int64_t idx;
1328
Eric Blakec41508e2017-10-11 22:47:13 -05001329 ret = blk_pread(blk, offset, buffer, bytes);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001330 if (ret < 0) {
1331 error_report("Error while reading offset %" PRId64 " of %s: %s",
Eric Blakec41508e2017-10-11 22:47:13 -05001332 offset, filename, strerror(-ret));
Eric Blake0608e402017-10-11 22:47:12 -05001333 return 4;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001334 }
Eric Blakec41508e2017-10-11 22:47:13 -05001335 idx = find_nonzero(buffer, bytes);
Eric Blakedebb38a2017-10-11 22:47:11 -05001336 if (idx >= 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001337 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blakec41508e2017-10-11 22:47:13 -05001338 offset + idx);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001339 return 1;
1340 }
1341
1342 return 0;
1343}
1344
1345/*
1346 * Compares two images. Exit codes:
1347 *
1348 * 0 - Images are identical
1349 * 1 - Images differ
1350 * >1 - Error occurred
1351 */
1352static int img_compare(int argc, char **argv)
1353{
Max Reitz40055952014-07-22 22:58:42 +02001354 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001355 BlockBackend *blk1, *blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001356 BlockDriverState *bs1, *bs2;
Eric Blake033d9fc2017-10-11 22:47:16 -05001357 int64_t total_size1, total_size2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001358 uint8_t *buf1 = NULL, *buf2 = NULL;
Eric Blake31826642017-10-11 22:47:08 -05001359 int64_t pnum1, pnum2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001360 int allocated1, allocated2;
1361 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1362 bool progress = false, quiet = false, strict = false;
Max Reitz40055952014-07-22 22:58:42 +02001363 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01001364 bool writethrough;
Eric Blake033d9fc2017-10-11 22:47:16 -05001365 int64_t total_size;
1366 int64_t offset = 0;
1367 int64_t chunk;
Eric Blakedc61cd32017-10-11 22:47:14 -05001368 int c;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001369 uint64_t progress_base;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001370 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08001371 bool force_share = false;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001372
Max Reitz40055952014-07-22 22:58:42 +02001373 cache = BDRV_DEFAULT_CACHE;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001374 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001375 static const struct option long_options[] = {
1376 {"help", no_argument, 0, 'h'},
1377 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001378 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08001379 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001380 {0, 0, 0, 0}
1381 };
Fam Zheng335e9932017-05-03 00:35:39 +08001382 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001383 long_options, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001384 if (c == -1) {
1385 break;
1386 }
1387 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001388 case ':':
1389 missing_argument(argv[optind - 1]);
1390 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001391 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001392 unrecognized_option(argv[optind - 1]);
1393 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001394 case 'h':
1395 help();
1396 break;
1397 case 'f':
1398 fmt1 = optarg;
1399 break;
1400 case 'F':
1401 fmt2 = optarg;
1402 break;
Max Reitz40055952014-07-22 22:58:42 +02001403 case 'T':
1404 cache = optarg;
1405 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001406 case 'p':
1407 progress = true;
1408 break;
1409 case 'q':
1410 quiet = true;
1411 break;
1412 case 's':
1413 strict = true;
1414 break;
Fam Zheng335e9932017-05-03 00:35:39 +08001415 case 'U':
1416 force_share = true;
1417 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001418 case OPTION_OBJECT: {
1419 QemuOpts *opts;
1420 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1421 optarg, true);
1422 if (!opts) {
1423 ret = 2;
1424 goto out4;
1425 }
1426 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001427 case OPTION_IMAGE_OPTS:
1428 image_opts = true;
1429 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001430 }
1431 }
1432
1433 /* Progress is not shown in Quiet mode */
1434 if (quiet) {
1435 progress = false;
1436 }
1437
1438
Kevin Wolffc11eb22013-08-05 10:53:04 +02001439 if (optind != argc - 2) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001440 error_exit("Expecting two image file names");
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001441 }
1442 filename1 = argv[optind++];
1443 filename2 = argv[optind++];
1444
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001445 if (qemu_opts_foreach(&qemu_object_opts,
1446 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02001447 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001448 ret = 2;
1449 goto out4;
1450 }
1451
Stefan Hajnoczicbda0162014-08-26 19:17:55 +01001452 /* Initialize before goto out */
1453 qemu_progress_init(progress, 2.0);
1454
Kevin Wolfce099542016-03-15 13:01:04 +01001455 flags = 0;
1456 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +02001457 if (ret < 0) {
1458 error_report("Invalid source cache option: %s", cache);
1459 ret = 2;
1460 goto out3;
1461 }
1462
Fam Zheng335e9932017-05-03 00:35:39 +08001463 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1464 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001465 if (!blk1) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001466 ret = 2;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001467 goto out3;
1468 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001469
Fam Zheng335e9932017-05-03 00:35:39 +08001470 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1471 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001472 if (!blk2) {
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001473 ret = 2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001474 goto out2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001475 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001476 bs1 = blk_bs(blk1);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001477 bs2 = blk_bs(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001478
Max Reitzf1d3cd72015-02-05 13:58:18 -05001479 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1480 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
Eric Blake033d9fc2017-10-11 22:47:16 -05001481 total_size1 = blk_getlength(blk1);
1482 if (total_size1 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001483 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001484 filename1, strerror(-total_size1));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001485 ret = 4;
1486 goto out;
1487 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001488 total_size2 = blk_getlength(blk2);
1489 if (total_size2 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001490 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001491 filename2, strerror(-total_size2));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001492 ret = 4;
1493 goto out;
1494 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001495 total_size = MIN(total_size1, total_size2);
1496 progress_base = MAX(total_size1, total_size2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001497
1498 qemu_progress_print(0, 100);
1499
Eric Blake033d9fc2017-10-11 22:47:16 -05001500 if (strict && total_size1 != total_size2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001501 ret = 1;
1502 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1503 goto out;
1504 }
1505
Eric Blake033d9fc2017-10-11 22:47:16 -05001506 while (offset < total_size) {
Eric Blake31826642017-10-11 22:47:08 -05001507 int status1, status2;
Fam Zheng67a0fd22016-01-26 11:58:48 +08001508
Eric Blake033d9fc2017-10-11 22:47:16 -05001509 status1 = bdrv_block_status_above(bs1, NULL, offset,
1510 total_size1 - offset, &pnum1, NULL,
1511 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001512 if (status1 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001513 ret = 3;
1514 error_report("Sector allocation test failed for %s", filename1);
1515 goto out;
1516 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001517 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001518
Eric Blake033d9fc2017-10-11 22:47:16 -05001519 status2 = bdrv_block_status_above(bs2, NULL, offset,
1520 total_size2 - offset, &pnum2, NULL,
1521 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001522 if (status2 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001523 ret = 3;
1524 error_report("Sector allocation test failed for %s", filename2);
1525 goto out;
1526 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001527 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
Eric Blake7daddc62017-10-11 22:47:09 -05001528
1529 assert(pnum1 && pnum2);
Eric Blake033d9fc2017-10-11 22:47:16 -05001530 chunk = MIN(pnum1, pnum2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001531
Fam Zheng25ad8e62016-01-13 16:37:41 +08001532 if (strict) {
Eric Blake31826642017-10-11 22:47:08 -05001533 if (status1 != status2) {
Fam Zheng25ad8e62016-01-13 16:37:41 +08001534 ret = 1;
1535 qprintf(quiet, "Strict mode: Offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001536 " block status mismatch!\n", offset);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001537 goto out;
1538 }
1539 }
1540 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
Eric Blake7daddc62017-10-11 22:47:09 -05001541 /* nothing to do */
Fam Zheng25ad8e62016-01-13 16:37:41 +08001542 } else if (allocated1 == allocated2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001543 if (allocated1) {
Eric Blakedc61cd32017-10-11 22:47:14 -05001544 int64_t pnum;
1545
Eric Blake033d9fc2017-10-11 22:47:16 -05001546 chunk = MIN(chunk, IO_BUF_SIZE);
1547 ret = blk_pread(blk1, offset, buf1, chunk);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001548 if (ret < 0) {
1549 error_report("Error while reading offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001550 " of %s: %s",
1551 offset, filename1, strerror(-ret));
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001552 ret = 4;
1553 goto out;
1554 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001555 ret = blk_pread(blk2, offset, buf2, chunk);
1556 if (ret < 0) {
1557 error_report("Error while reading offset %" PRId64
1558 " of %s: %s",
1559 offset, filename2, strerror(-ret));
1560 ret = 4;
1561 goto out;
1562 }
1563 ret = compare_buffers(buf1, buf2, chunk, &pnum);
1564 if (ret || pnum != chunk) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001565 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blake033d9fc2017-10-11 22:47:16 -05001566 offset + (ret ? 0 : pnum));
Fam Zheng36452f12013-11-13 20:26:49 +08001567 ret = 1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001568 goto out;
1569 }
1570 }
1571 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001572 chunk = MIN(chunk, IO_BUF_SIZE);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001573 if (allocated1) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001574 ret = check_empty_sectors(blk1, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001575 filename1, buf1, quiet);
1576 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001577 ret = check_empty_sectors(blk2, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001578 filename2, buf1, quiet);
1579 }
1580 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001581 goto out;
1582 }
1583 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001584 offset += chunk;
1585 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001586 }
1587
Eric Blake033d9fc2017-10-11 22:47:16 -05001588 if (total_size1 != total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001589 BlockBackend *blk_over;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001590 const char *filename_over;
1591
1592 qprintf(quiet, "Warning: Image size mismatch!\n");
Eric Blake033d9fc2017-10-11 22:47:16 -05001593 if (total_size1 > total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001594 blk_over = blk1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001595 filename_over = filename1;
1596 } else {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001597 blk_over = blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001598 filename_over = filename2;
1599 }
1600
Eric Blake033d9fc2017-10-11 22:47:16 -05001601 while (offset < progress_base) {
1602 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1603 progress_base - offset, &chunk,
1604 NULL, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001605 if (ret < 0) {
1606 ret = 3;
1607 error_report("Sector allocation test failed for %s",
1608 filename_over);
1609 goto out;
1610
1611 }
Eric Blake391cb1a2017-10-11 22:47:10 -05001612 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001613 chunk = MIN(chunk, IO_BUF_SIZE);
1614 ret = check_empty_sectors(blk_over, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001615 filename_over, buf1, quiet);
1616 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001617 goto out;
1618 }
1619 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001620 offset += chunk;
1621 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001622 }
1623 }
1624
1625 qprintf(quiet, "Images are identical.\n");
1626 ret = 0;
1627
1628out:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001629 qemu_vfree(buf1);
1630 qemu_vfree(buf2);
Markus Armbruster26f54e92014-10-07 13:59:04 +02001631 blk_unref(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001632out2:
Markus Armbruster26f54e92014-10-07 13:59:04 +02001633 blk_unref(blk1);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001634out3:
1635 qemu_progress_end();
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001636out4:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001637 return ret;
1638}
1639
Eric Blake6c729dd2020-05-21 14:21:35 -05001640/* Convenience wrapper around qmp_block_dirty_bitmap_merge */
1641static void do_dirty_bitmap_merge(const char *dst_node, const char *dst_name,
1642 const char *src_node, const char *src_name,
1643 Error **errp)
1644{
1645 BlockDirtyBitmapMergeSource *merge_src;
1646 BlockDirtyBitmapMergeSourceList *list;
1647
1648 merge_src = g_new0(BlockDirtyBitmapMergeSource, 1);
1649 merge_src->type = QTYPE_QDICT;
1650 merge_src->u.external.node = g_strdup(src_node);
1651 merge_src->u.external.name = g_strdup(src_name);
1652 list = g_new0(BlockDirtyBitmapMergeSourceList, 1);
1653 list->value = merge_src;
1654 qmp_block_dirty_bitmap_merge(dst_node, dst_name, list, errp);
1655 qapi_free_BlockDirtyBitmapMergeSourceList(list);
1656}
1657
Kevin Wolf690c7302015-03-19 13:33:32 +01001658enum ImgConvertBlockStatus {
1659 BLK_DATA,
1660 BLK_ZERO,
1661 BLK_BACKING_FILE,
1662};
1663
Peter Lieven2d9187b2017-02-28 13:40:07 +01001664#define MAX_COROUTINES 16
1665
Kevin Wolf690c7302015-03-19 13:33:32 +01001666typedef struct ImgConvertState {
1667 BlockBackend **src;
1668 int64_t *src_sectors;
Peter Lievenaf8d43d2020-09-01 14:51:29 +02001669 int *src_alignment;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001670 int src_num;
Kevin Wolf690c7302015-03-19 13:33:32 +01001671 int64_t total_sectors;
1672 int64_t allocated_sectors;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001673 int64_t allocated_done;
1674 int64_t sector_num;
1675 int64_t wr_offs;
Kevin Wolf690c7302015-03-19 13:33:32 +01001676 enum ImgConvertBlockStatus status;
1677 int64_t sector_next_status;
1678 BlockBackend *target;
1679 bool has_zero_init;
1680 bool compressed;
Max Reitz4d7c4872019-07-24 19:12:29 +02001681 bool target_is_new;
Kevin Wolf690c7302015-03-19 13:33:32 +01001682 bool target_has_backing;
Max Reitz351c8ef2018-05-01 18:57:49 +02001683 int64_t target_backing_sectors; /* negative if unknown */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001684 bool wr_in_order;
Fam Zhengee5306d2018-06-01 17:26:48 +08001685 bool copy_range;
Max Reitz8eaac022019-05-07 22:35:03 +02001686 bool salvage;
Max Reitz3d96cb92019-05-07 22:35:02 +02001687 bool quiet;
Kevin Wolf690c7302015-03-19 13:33:32 +01001688 int min_sparse;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001689 int alignment;
Kevin Wolf690c7302015-03-19 13:33:32 +01001690 size_t cluster_sectors;
1691 size_t buf_sectors;
Peter Lieven9fd77f92017-04-21 11:11:55 +02001692 long num_coroutines;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001693 int running_coroutines;
1694 Coroutine *co[MAX_COROUTINES];
1695 int64_t wait_sector_num[MAX_COROUTINES];
1696 CoMutex lock;
1697 int ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001698} ImgConvertState;
1699
Peter Lieven2d9187b2017-02-28 13:40:07 +01001700static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1701 int *src_cur, int64_t *src_cur_offset)
Kevin Wolf690c7302015-03-19 13:33:32 +01001702{
Peter Lieven2d9187b2017-02-28 13:40:07 +01001703 *src_cur = 0;
1704 *src_cur_offset = 0;
1705 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1706 *src_cur_offset += s->src_sectors[*src_cur];
1707 (*src_cur)++;
1708 assert(*src_cur < s->src_num);
Kevin Wolf690c7302015-03-19 13:33:32 +01001709 }
1710}
1711
1712static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1713{
Eric Blake31826642017-10-11 22:47:08 -05001714 int64_t src_cur_offset;
1715 int ret, n, src_cur;
Max Reitz351c8ef2018-05-01 18:57:49 +02001716 bool post_backing_zero = false;
Kevin Wolf690c7302015-03-19 13:33:32 +01001717
Peter Lieven2d9187b2017-02-28 13:40:07 +01001718 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
Kevin Wolf690c7302015-03-19 13:33:32 +01001719
1720 assert(s->total_sectors > sector_num);
1721 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1722
Max Reitz351c8ef2018-05-01 18:57:49 +02001723 if (s->target_backing_sectors >= 0) {
1724 if (sector_num >= s->target_backing_sectors) {
Vladimir Sementsov-Ogievskiy2253d862020-05-28 12:43:56 +03001725 post_backing_zero = true;
Max Reitz351c8ef2018-05-01 18:57:49 +02001726 } else if (sector_num + n > s->target_backing_sectors) {
1727 /* Split requests around target_backing_sectors (because
1728 * starting from there, zeros are handled differently) */
1729 n = s->target_backing_sectors - sector_num;
1730 }
1731 }
1732
Kevin Wolf690c7302015-03-19 13:33:32 +01001733 if (s->sector_next_status <= sector_num) {
Max Reitz8eaac022019-05-07 22:35:03 +02001734 uint64_t offset = (sector_num - src_cur_offset) * BDRV_SECTOR_SIZE;
1735 int64_t count;
Peter Lievenaf8d43d2020-09-01 14:51:29 +02001736 int tail;
Max Reitz4a2061e2019-06-12 19:00:30 +02001737 BlockDriverState *src_bs = blk_bs(s->src[src_cur]);
1738 BlockDriverState *base;
1739
1740 if (s->target_has_backing) {
1741 base = bdrv_cow_bs(bdrv_skip_filters(src_bs));
1742 } else {
1743 base = NULL;
1744 }
Eric Blake31826642017-10-11 22:47:08 -05001745
Max Reitz8eaac022019-05-07 22:35:03 +02001746 do {
1747 count = n * BDRV_SECTOR_SIZE;
Eric Blake237d78f2017-10-11 22:47:03 -05001748
Max Reitz4a2061e2019-06-12 19:00:30 +02001749 ret = bdrv_block_status_above(src_bs, base, offset, count, &count,
1750 NULL, NULL);
Max Reitz8eaac022019-05-07 22:35:03 +02001751
1752 if (ret < 0) {
1753 if (s->salvage) {
1754 if (n == 1) {
1755 if (!s->quiet) {
1756 warn_report("error while reading block status at "
1757 "offset %" PRIu64 ": %s", offset,
1758 strerror(-ret));
1759 }
1760 /* Just try to read the data, then */
1761 ret = BDRV_BLOCK_DATA;
1762 count = BDRV_SECTOR_SIZE;
1763 } else {
1764 /* Retry on a shorter range */
1765 n = DIV_ROUND_UP(n, 4);
1766 }
1767 } else {
1768 error_report("error while reading block status at offset "
1769 "%" PRIu64 ": %s", offset, strerror(-ret));
1770 return ret;
1771 }
1772 }
1773 } while (ret < 0);
1774
Eric Blake31826642017-10-11 22:47:08 -05001775 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
Kevin Wolf690c7302015-03-19 13:33:32 +01001776
Peter Lievenaf8d43d2020-09-01 14:51:29 +02001777 /*
1778 * Avoid that s->sector_next_status becomes unaligned to the source
1779 * request alignment and/or cluster size to avoid unnecessary read
1780 * cycles.
1781 */
1782 tail = (sector_num - src_cur_offset + n) % s->src_alignment[src_cur];
1783 if (n > tail) {
1784 n -= tail;
1785 }
1786
Kevin Wolf690c7302015-03-19 13:33:32 +01001787 if (ret & BDRV_BLOCK_ZERO) {
Max Reitz351c8ef2018-05-01 18:57:49 +02001788 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
Kevin Wolf690c7302015-03-19 13:33:32 +01001789 } else if (ret & BDRV_BLOCK_DATA) {
1790 s->status = BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001791 } else {
Vladimir Sementsov-Ogievskiy9f1b92a2017-04-07 14:34:04 +03001792 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001793 }
1794
1795 s->sector_next_status = sector_num + n;
1796 }
1797
1798 n = MIN(n, s->sector_next_status - sector_num);
1799 if (s->status == BLK_DATA) {
1800 n = MIN(n, s->buf_sectors);
1801 }
1802
1803 /* We need to write complete clusters for compressed images, so if an
1804 * unallocated area is shorter than that, we must consider the whole
1805 * cluster allocated. */
1806 if (s->compressed) {
1807 if (n < s->cluster_sectors) {
1808 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1809 s->status = BLK_DATA;
1810 } else {
1811 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1812 }
1813 }
1814
1815 return n;
1816}
1817
Peter Lieven2d9187b2017-02-28 13:40:07 +01001818static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1819 int nb_sectors, uint8_t *buf)
Kevin Wolf690c7302015-03-19 13:33:32 +01001820{
Max Reitz8eaac022019-05-07 22:35:03 +02001821 uint64_t single_read_until = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001822 int n, ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001823
Kevin Wolf690c7302015-03-19 13:33:32 +01001824 assert(nb_sectors <= s->buf_sectors);
1825 while (nb_sectors > 0) {
1826 BlockBackend *blk;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001827 int src_cur;
1828 int64_t bs_sectors, src_cur_offset;
Max Reitz8eaac022019-05-07 22:35:03 +02001829 uint64_t offset;
Kevin Wolf690c7302015-03-19 13:33:32 +01001830
1831 /* In the case of compression with multiple source files, we can get a
1832 * nb_sectors that spreads into the next part. So we must be able to
1833 * read across multiple BDSes for one convert_read() call. */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001834 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1835 blk = s->src[src_cur];
1836 bs_sectors = s->src_sectors[src_cur];
Kevin Wolf690c7302015-03-19 13:33:32 +01001837
Max Reitz8eaac022019-05-07 22:35:03 +02001838 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001839
Max Reitz8eaac022019-05-07 22:35:03 +02001840 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1841 if (single_read_until > offset) {
1842 n = 1;
1843 }
1844
1845 ret = blk_co_pread(blk, offset, n << BDRV_SECTOR_BITS, buf, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01001846 if (ret < 0) {
Max Reitz8eaac022019-05-07 22:35:03 +02001847 if (s->salvage) {
1848 if (n > 1) {
1849 single_read_until = offset + (n << BDRV_SECTOR_BITS);
1850 continue;
1851 } else {
1852 if (!s->quiet) {
1853 warn_report("error while reading offset %" PRIu64
1854 ": %s", offset, strerror(-ret));
1855 }
1856 memset(buf, 0, BDRV_SECTOR_SIZE);
1857 }
1858 } else {
1859 return ret;
1860 }
Kevin Wolf690c7302015-03-19 13:33:32 +01001861 }
1862
1863 sector_num += n;
1864 nb_sectors -= n;
1865 buf += n * BDRV_SECTOR_SIZE;
1866 }
1867
1868 return 0;
1869}
1870
Peter Lieven2d9187b2017-02-28 13:40:07 +01001871
1872static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1873 int nb_sectors, uint8_t *buf,
1874 enum ImgConvertBlockStatus status)
Kevin Wolf690c7302015-03-19 13:33:32 +01001875{
1876 int ret;
1877
1878 while (nb_sectors > 0) {
1879 int n = nb_sectors;
Lidong Chendb933fb2017-04-27 10:58:27 +08001880 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1881
Peter Lieven2d9187b2017-02-28 13:40:07 +01001882 switch (status) {
Kevin Wolf690c7302015-03-19 13:33:32 +01001883 case BLK_BACKING_FILE:
1884 /* If we have a backing file, leave clusters unallocated that are
1885 * unallocated in the source image, so that the backing file is
1886 * visible at the respective offset. */
1887 assert(s->target_has_backing);
1888 break;
1889
1890 case BLK_DATA:
Lidong Chendb933fb2017-04-27 10:58:27 +08001891 /* If we're told to keep the target fully allocated (-S 0) or there
1892 * is real non-zero data, we must write it. Otherwise we can treat
1893 * it as zero sectors.
1894 * Compressed clusters need to be written as a whole, so in that
1895 * case we can only save the write if the buffer is completely
1896 * zeroed. */
Kevin Wolf690c7302015-03-19 13:33:32 +01001897 if (!s->min_sparse ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001898 (!s->compressed &&
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001899 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1900 sector_num, s->alignment)) ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001901 (s->compressed &&
1902 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
Kevin Wolf690c7302015-03-19 13:33:32 +01001903 {
Vladimir Sementsov-Ogievskiy265a7e52019-04-22 17:58:38 +03001904 ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1905 n << BDRV_SECTOR_BITS, buf, flags);
Kevin Wolf690c7302015-03-19 13:33:32 +01001906 if (ret < 0) {
1907 return ret;
1908 }
1909 break;
1910 }
1911 /* fall-through */
1912
1913 case BLK_ZERO:
1914 if (s->has_zero_init) {
Lidong Chendb933fb2017-04-27 10:58:27 +08001915 assert(!s->target_has_backing);
Kevin Wolf690c7302015-03-19 13:33:32 +01001916 break;
1917 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01001918 ret = blk_co_pwrite_zeroes(s->target,
1919 sector_num << BDRV_SECTOR_BITS,
Nir Soffera3d6ae22019-03-24 02:20:12 +02001920 n << BDRV_SECTOR_BITS,
1921 BDRV_REQ_MAY_UNMAP);
Kevin Wolf690c7302015-03-19 13:33:32 +01001922 if (ret < 0) {
1923 return ret;
1924 }
1925 break;
1926 }
1927
1928 sector_num += n;
1929 nb_sectors -= n;
1930 buf += n * BDRV_SECTOR_SIZE;
1931 }
1932
1933 return 0;
1934}
1935
Fam Zhengee5306d2018-06-01 17:26:48 +08001936static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1937 int nb_sectors)
1938{
1939 int n, ret;
1940
1941 while (nb_sectors > 0) {
1942 BlockBackend *blk;
1943 int src_cur;
1944 int64_t bs_sectors, src_cur_offset;
1945 int64_t offset;
1946
1947 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1948 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1949 blk = s->src[src_cur];
1950 bs_sectors = s->src_sectors[src_cur];
1951
1952 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1953
1954 ret = blk_co_copy_range(blk, offset, s->target,
1955 sector_num << BDRV_SECTOR_BITS,
Vladimir Sementsov-Ogievskiy67b51fb2018-07-09 19:37:17 +03001956 n << BDRV_SECTOR_BITS, 0, 0);
Fam Zhengee5306d2018-06-01 17:26:48 +08001957 if (ret < 0) {
1958 return ret;
1959 }
1960
1961 sector_num += n;
1962 nb_sectors -= n;
1963 }
1964 return 0;
1965}
1966
Peter Lieven2d9187b2017-02-28 13:40:07 +01001967static void coroutine_fn convert_co_do_copy(void *opaque)
1968{
1969 ImgConvertState *s = opaque;
1970 uint8_t *buf = NULL;
1971 int ret, i;
1972 int index = -1;
1973
1974 for (i = 0; i < s->num_coroutines; i++) {
1975 if (s->co[i] == qemu_coroutine_self()) {
1976 index = i;
1977 break;
1978 }
1979 }
1980 assert(index >= 0);
1981
1982 s->running_coroutines++;
1983 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1984
1985 while (1) {
1986 int n;
1987 int64_t sector_num;
1988 enum ImgConvertBlockStatus status;
Fam Zhengee5306d2018-06-01 17:26:48 +08001989 bool copy_range;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001990
1991 qemu_co_mutex_lock(&s->lock);
1992 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1993 qemu_co_mutex_unlock(&s->lock);
Anton Nefedovb91127e2017-04-26 11:33:15 +03001994 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001995 }
1996 n = convert_iteration_sectors(s, s->sector_num);
1997 if (n < 0) {
1998 qemu_co_mutex_unlock(&s->lock);
1999 s->ret = n;
Anton Nefedovb91127e2017-04-26 11:33:15 +03002000 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002001 }
2002 /* save current sector and allocation status to local variables */
2003 sector_num = s->sector_num;
2004 status = s->status;
2005 if (!s->min_sparse && s->status == BLK_ZERO) {
2006 n = MIN(n, s->buf_sectors);
2007 }
2008 /* increment global sector counter so that other coroutines can
2009 * already continue reading beyond this request */
2010 s->sector_num += n;
2011 qemu_co_mutex_unlock(&s->lock);
2012
2013 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
2014 s->allocated_done += n;
2015 qemu_progress_print(100.0 * s->allocated_done /
2016 s->allocated_sectors, 0);
2017 }
2018
Fam Zhengee5306d2018-06-01 17:26:48 +08002019retry:
2020 copy_range = s->copy_range && s->status == BLK_DATA;
2021 if (status == BLK_DATA && !copy_range) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002022 ret = convert_co_read(s, sector_num, n, buf);
2023 if (ret < 0) {
Eric Blake39f77cb2020-04-02 08:57:17 -05002024 error_report("error while reading at byte %lld: %s",
2025 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
Peter Lieven2d9187b2017-02-28 13:40:07 +01002026 s->ret = ret;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002027 }
2028 } else if (!s->min_sparse && status == BLK_ZERO) {
2029 status = BLK_DATA;
2030 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
2031 }
2032
2033 if (s->wr_in_order) {
2034 /* keep writes in order */
Anton Nefedovb91127e2017-04-26 11:33:15 +03002035 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002036 s->wait_sector_num[index] = sector_num;
2037 qemu_coroutine_yield();
2038 }
2039 s->wait_sector_num[index] = -1;
2040 }
2041
Anton Nefedovb91127e2017-04-26 11:33:15 +03002042 if (s->ret == -EINPROGRESS) {
Fam Zhengee5306d2018-06-01 17:26:48 +08002043 if (copy_range) {
2044 ret = convert_co_copy_range(s, sector_num, n);
2045 if (ret) {
2046 s->copy_range = false;
2047 goto retry;
2048 }
2049 } else {
2050 ret = convert_co_write(s, sector_num, n, buf, status);
2051 }
Anton Nefedovb91127e2017-04-26 11:33:15 +03002052 if (ret < 0) {
Eric Blake39f77cb2020-04-02 08:57:17 -05002053 error_report("error while writing at byte %lld: %s",
2054 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
Anton Nefedovb91127e2017-04-26 11:33:15 +03002055 s->ret = ret;
2056 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01002057 }
2058
2059 if (s->wr_in_order) {
2060 /* reenter the coroutine that might have waited
2061 * for this write to complete */
2062 s->wr_offs = sector_num + n;
2063 for (i = 0; i < s->num_coroutines; i++) {
2064 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
2065 /*
2066 * A -> B -> A cannot occur because A has
2067 * s->wait_sector_num[i] == -1 during A -> B. Therefore
2068 * B will never enter A during this time window.
2069 */
2070 qemu_coroutine_enter(s->co[i]);
2071 break;
2072 }
2073 }
2074 }
2075 }
2076
Peter Lieven2d9187b2017-02-28 13:40:07 +01002077 qemu_vfree(buf);
2078 s->co[index] = NULL;
2079 s->running_coroutines--;
2080 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
2081 /* the convert job finished successfully */
2082 s->ret = 0;
2083 }
2084}
2085
Kevin Wolf690c7302015-03-19 13:33:32 +01002086static int convert_do_copy(ImgConvertState *s)
2087{
Peter Lieven2d9187b2017-02-28 13:40:07 +01002088 int ret, i, n;
2089 int64_t sector_num = 0;
Kevin Wolf690c7302015-03-19 13:33:32 +01002090
2091 /* Check whether we have zero initialisation or can get it efficiently */
David Edmondson168468f2020-02-05 11:02:48 +00002092 if (!s->has_zero_init && s->target_is_new && s->min_sparse &&
2093 !s->target_has_backing) {
Max Reitz4d7c4872019-07-24 19:12:29 +02002094 s->has_zero_init = bdrv_has_zero_init(blk_bs(s->target));
Max Reitz4d7c4872019-07-24 19:12:29 +02002095 }
Kevin Wolf690c7302015-03-19 13:33:32 +01002096
Kevin Wolf690c7302015-03-19 13:33:32 +01002097 /* Allocate buffer for copied data. For compressed images, only one cluster
2098 * can be copied at a time. */
2099 if (s->compressed) {
2100 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
2101 error_report("invalid cluster size");
Peter Lieven2d9187b2017-02-28 13:40:07 +01002102 return -EINVAL;
Kevin Wolf690c7302015-03-19 13:33:32 +01002103 }
2104 s->buf_sectors = s->cluster_sectors;
2105 }
Kevin Wolf690c7302015-03-19 13:33:32 +01002106
Kevin Wolf690c7302015-03-19 13:33:32 +01002107 while (sector_num < s->total_sectors) {
2108 n = convert_iteration_sectors(s, sector_num);
2109 if (n < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002110 return n;
Kevin Wolf690c7302015-03-19 13:33:32 +01002111 }
Max Reitzaad15de2016-03-24 23:33:57 +01002112 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
2113 {
Kevin Wolf690c7302015-03-19 13:33:32 +01002114 s->allocated_sectors += n;
2115 }
2116 sector_num += n;
2117 }
2118
2119 /* Do the copy */
Kevin Wolf690c7302015-03-19 13:33:32 +01002120 s->sector_next_status = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002121 s->ret = -EINPROGRESS;
Kevin Wolf690c7302015-03-19 13:33:32 +01002122
Peter Lieven2d9187b2017-02-28 13:40:07 +01002123 qemu_co_mutex_init(&s->lock);
2124 for (i = 0; i < s->num_coroutines; i++) {
2125 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
2126 s->wait_sector_num[i] = -1;
2127 qemu_coroutine_enter(s->co[i]);
Kevin Wolf690c7302015-03-19 13:33:32 +01002128 }
2129
Anton Nefedovb91127e2017-04-26 11:33:15 +03002130 while (s->running_coroutines) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002131 main_loop_wait(false);
2132 }
2133
2134 if (s->compressed && !s->ret) {
Kevin Wolf690c7302015-03-19 13:33:32 +01002135 /* signal EOF to align */
Pavel Butsykinfe5c1352016-07-22 11:17:40 +03002136 ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01002137 if (ret < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002138 return ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002139 }
2140 }
2141
Peter Lieven2d9187b2017-02-28 13:40:07 +01002142 return s->ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002143}
2144
Eric Blake15e39ad2020-05-21 14:21:36 -05002145static int convert_copy_bitmaps(BlockDriverState *src, BlockDriverState *dst)
2146{
2147 BdrvDirtyBitmap *bm;
2148 Error *err = NULL;
2149
2150 FOR_EACH_DIRTY_BITMAP(src, bm) {
2151 const char *name;
2152
2153 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2154 continue;
2155 }
2156 name = bdrv_dirty_bitmap_name(bm);
2157 qmp_block_dirty_bitmap_add(dst->node_name, name,
2158 true, bdrv_dirty_bitmap_granularity(bm),
2159 true, true,
2160 true, !bdrv_dirty_bitmap_enabled(bm),
2161 &err);
2162 if (err) {
2163 error_reportf_err(err, "Failed to create bitmap %s: ", name);
2164 return -1;
2165 }
2166
2167 do_dirty_bitmap_merge(dst->node_name, name, src->node_name, name,
2168 &err);
2169 if (err) {
2170 error_reportf_err(err, "Failed to populate bitmap %s: ", name);
2171 return -1;
2172 }
2173 }
2174
2175 return 0;
2176}
2177
Peter Lieven6360ab22018-07-13 09:15:39 +02002178#define MAX_BUF_SECTORS 32768
2179
bellardea2384d2004-08-01 21:59:26 +00002180static int img_convert(int argc, char **argv)
2181{
Peter Lieven9fd77f92017-04-21 11:11:55 +02002182 int c, bs_i, flags, src_flags = 0;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002183 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002184 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
2185 *out_filename, *out_baseimg_param, *snapshot_name = NULL;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002186 BlockDriver *drv = NULL, *proto_drv = NULL;
bellardfaea38e2006-08-05 21:31:00 +00002187 BlockDriverInfo bdi;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002188 BlockDriverState *out_bs;
2189 QemuOpts *opts = NULL, *sn_opts = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08002190 QemuOptsList *create_opts = NULL;
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002191 QDict *open_opts = NULL;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002192 char *options = NULL;
Max Reitzcc84d902013-09-06 17:14:26 +02002193 Error *local_err = NULL;
Max Reitz3d96cb92019-05-07 22:35:02 +02002194 bool writethrough, src_writethrough, image_opts = false,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002195 skip_create = false, progress = false, tgt_image_opts = false;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002196 int64_t ret = -EINVAL;
Fam Zheng335e9932017-05-03 00:35:39 +08002197 bool force_share = false;
Fam Zhenge11ce122018-07-27 11:34:01 +08002198 bool explict_min_sparse = false;
Eric Blake15e39ad2020-05-21 14:21:36 -05002199 bool bitmaps = false;
bellardea2384d2004-08-01 21:59:26 +00002200
Peter Lieven9fd77f92017-04-21 11:11:55 +02002201 ImgConvertState s = (ImgConvertState) {
2202 /* Need at least 4k of zeros for sparse detection */
2203 .min_sparse = 8,
Fam Zhenge11ce122018-07-27 11:34:01 +08002204 .copy_range = false,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002205 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2206 .wr_in_order = true,
2207 .num_coroutines = 8,
2208 };
2209
bellardea2384d2004-08-01 21:59:26 +00002210 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002211 static const struct option long_options[] = {
2212 {"help", no_argument, 0, 'h'},
2213 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002214 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002215 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002216 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
Max Reitz8eaac022019-05-07 22:35:03 +02002217 {"salvage", no_argument, 0, OPTION_SALVAGE},
David Edmondson168468f2020-02-05 11:02:48 +00002218 {"target-is-zero", no_argument, 0, OPTION_TARGET_IS_ZERO},
Eric Blake15e39ad2020-05-21 14:21:36 -05002219 {"bitmaps", no_argument, 0, OPTION_BITMAPS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002220 {0, 0, 0, 0}
2221 };
Fam Zhenge11ce122018-07-27 11:34:01 +08002222 c = getopt_long(argc, argv, ":hf:O:B:Cco:l:S:pt:T:qnm:WU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002223 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002224 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002225 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002226 }
bellardea2384d2004-08-01 21:59:26 +00002227 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002228 case ':':
2229 missing_argument(argv[optind - 1]);
2230 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002231 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002232 unrecognized_option(argv[optind - 1]);
2233 break;
bellardea2384d2004-08-01 21:59:26 +00002234 case 'h':
2235 help();
2236 break;
2237 case 'f':
2238 fmt = optarg;
2239 break;
2240 case 'O':
2241 out_fmt = optarg;
2242 break;
thsf58c7b32008-06-05 21:53:49 +00002243 case 'B':
2244 out_baseimg = optarg;
2245 break;
Fam Zhenge11ce122018-07-27 11:34:01 +08002246 case 'C':
2247 s.copy_range = true;
2248 break;
bellardea2384d2004-08-01 21:59:26 +00002249 case 'c':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002250 s.compressed = true;
bellardea2384d2004-08-01 21:59:26 +00002251 break;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002252 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02002253 if (accumulate_options(&options, optarg) < 0) {
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002254 goto fail_getopt;
Kevin Wolf2dc83282014-02-21 16:24:05 +01002255 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002256 break;
Wenchao Xiaef806542013-12-04 17:10:57 +08002257 case 'l':
2258 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
Markus Armbruster70b94332015-02-13 12:50:26 +01002259 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2260 optarg, false);
Wenchao Xiaef806542013-12-04 17:10:57 +08002261 if (!sn_opts) {
2262 error_report("Failed in parsing snapshot param '%s'",
2263 optarg);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002264 goto fail_getopt;
Wenchao Xiaef806542013-12-04 17:10:57 +08002265 }
2266 } else {
2267 snapshot_name = optarg;
2268 }
2269 break;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002270 case 'S':
2271 {
2272 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +01002273
Eyal Moscovici43d589b2020-05-13 16:36:26 +03002274 sval = cvtnum("buffer size for sparse output", optarg);
2275 if (sval < 0) {
2276 goto fail_getopt;
2277 } else if (!QEMU_IS_ALIGNED(sval, BDRV_SECTOR_SIZE) ||
Peter Lieven6360ab22018-07-13 09:15:39 +02002278 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2279 error_report("Invalid buffer size for sparse output specified. "
2280 "Valid sizes are multiples of %llu up to %llu. Select "
2281 "0 to disable sparse detection (fully allocates output).",
2282 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002283 goto fail_getopt;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002284 }
2285
Peter Lieven9fd77f92017-04-21 11:11:55 +02002286 s.min_sparse = sval / BDRV_SECTOR_SIZE;
Fam Zhenge11ce122018-07-27 11:34:01 +08002287 explict_min_sparse = true;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002288 break;
2289 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002290 case 'p':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002291 progress = true;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002292 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002293 case 't':
2294 cache = optarg;
2295 break;
Max Reitz40055952014-07-22 22:58:42 +02002296 case 'T':
2297 src_cache = optarg;
2298 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002299 case 'q':
Max Reitz3d96cb92019-05-07 22:35:02 +02002300 s.quiet = true;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002301 break;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002302 case 'n':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002303 skip_create = true;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002304 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002305 case 'm':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002306 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2307 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002308 error_report("Invalid number of coroutines. Allowed number of"
2309 " coroutines is between 1 and %d", MAX_COROUTINES);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002310 goto fail_getopt;
2311 }
2312 break;
2313 case 'W':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002314 s.wr_in_order = false;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002315 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002316 case 'U':
2317 force_share = true;
2318 break;
Max Reitz3258b912017-04-26 15:46:47 +02002319 case OPTION_OBJECT: {
2320 QemuOpts *object_opts;
2321 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
2322 optarg, true);
2323 if (!object_opts) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002324 goto fail_getopt;
2325 }
2326 break;
Max Reitz3258b912017-04-26 15:46:47 +02002327 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002328 case OPTION_IMAGE_OPTS:
2329 image_opts = true;
2330 break;
Max Reitz8eaac022019-05-07 22:35:03 +02002331 case OPTION_SALVAGE:
2332 s.salvage = true;
2333 break;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002334 case OPTION_TARGET_IMAGE_OPTS:
2335 tgt_image_opts = true;
2336 break;
David Edmondson168468f2020-02-05 11:02:48 +00002337 case OPTION_TARGET_IS_ZERO:
2338 /*
2339 * The user asserting that the target is blank has the
2340 * same effect as the target driver supporting zero
2341 * initialisation.
2342 */
2343 s.has_zero_init = true;
2344 break;
Eric Blake15e39ad2020-05-21 14:21:36 -05002345 case OPTION_BITMAPS:
2346 bitmaps = true;
2347 break;
bellardea2384d2004-08-01 21:59:26 +00002348 }
2349 }
ths3b46e622007-09-17 08:09:54 +00002350
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002351 if (!out_fmt && !tgt_image_opts) {
2352 out_fmt = "raw";
2353 }
2354
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002355 if (qemu_opts_foreach(&qemu_object_opts,
2356 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02002357 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002358 goto fail_getopt;
2359 }
2360
Fam Zhenge11ce122018-07-27 11:34:01 +08002361 if (s.compressed && s.copy_range) {
2362 error_report("Cannot enable copy offloading when -c is used");
2363 goto fail_getopt;
2364 }
2365
2366 if (explict_min_sparse && s.copy_range) {
2367 error_report("Cannot enable copy offloading when -S is used");
2368 goto fail_getopt;
2369 }
2370
Max Reitz8eaac022019-05-07 22:35:03 +02002371 if (s.copy_range && s.salvage) {
2372 error_report("Cannot use copy offloading in salvaging mode");
2373 goto fail_getopt;
2374 }
2375
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002376 if (tgt_image_opts && !skip_create) {
2377 error_report("--target-image-opts requires use of -n flag");
2378 goto fail_getopt;
2379 }
2380
Kevin Wolfffd8e8f2019-08-09 11:09:21 +02002381 if (skip_create && options) {
Eric Blake25956af2020-07-06 15:39:46 -05002382 error_report("-o has no effect when skipping image creation");
2383 goto fail_getopt;
Kevin Wolfffd8e8f2019-08-09 11:09:21 +02002384 }
2385
David Edmondson168468f2020-02-05 11:02:48 +00002386 if (s.has_zero_init && !skip_create) {
2387 error_report("--target-is-zero requires use of -n flag");
2388 goto fail_getopt;
2389 }
2390
Peter Lieven9fd77f92017-04-21 11:11:55 +02002391 s.src_num = argc - optind - 1;
2392 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2393
2394 if (options && has_help_option(options)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002395 if (out_fmt) {
2396 ret = print_block_option_help(out_filename, out_fmt);
2397 goto fail_getopt;
2398 } else {
2399 error_report("Option help requires a format be specified");
2400 goto fail_getopt;
2401 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002402 }
2403
2404 if (s.src_num < 1) {
2405 error_report("Must specify image file name");
2406 goto fail_getopt;
2407 }
2408
Peter Lieven9fd77f92017-04-21 11:11:55 +02002409 /* ret is still -EINVAL until here */
2410 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2411 if (ret < 0) {
2412 error_report("Invalid source cache option: %s", src_cache);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002413 goto fail_getopt;
2414 }
2415
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002416 /* Initialize before goto out */
Max Reitz3d96cb92019-05-07 22:35:02 +02002417 if (s.quiet) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002418 progress = false;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002419 }
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002420 qemu_progress_init(progress, 1.0);
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002421 qemu_progress_print(0, 100);
2422
Peter Lieven9fd77f92017-04-21 11:11:55 +02002423 s.src = g_new0(BlockBackend *, s.src_num);
2424 s.src_sectors = g_new(int64_t, s.src_num);
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002425 s.src_alignment = g_new(int, s.src_num);
balrog926c2d22007-10-31 01:11:44 +00002426
Peter Lieven9fd77f92017-04-21 11:11:55 +02002427 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002428 BlockDriverState *src_bs;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002429 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
Max Reitz3d96cb92019-05-07 22:35:02 +02002430 fmt, src_flags, src_writethrough, s.quiet,
Fam Zheng335e9932017-05-03 00:35:39 +08002431 force_share);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002432 if (!s.src[bs_i]) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002433 ret = -1;
2434 goto out;
2435 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002436 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2437 if (s.src_sectors[bs_i] < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002438 error_report("Could not get size of %s: %s",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002439 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002440 ret = -1;
2441 goto out;
2442 }
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002443 src_bs = blk_bs(s.src[bs_i]);
2444 s.src_alignment[bs_i] = DIV_ROUND_UP(src_bs->bl.request_alignment,
2445 BDRV_SECTOR_SIZE);
2446 if (!bdrv_get_info(src_bs, &bdi)) {
2447 s.src_alignment[bs_i] = MAX(s.src_alignment[bs_i],
2448 bdi.cluster_size / BDRV_SECTOR_SIZE);
2449 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002450 s.total_sectors += s.src_sectors[bs_i];
balrog926c2d22007-10-31 01:11:44 +00002451 }
bellardea2384d2004-08-01 21:59:26 +00002452
Wenchao Xiaef806542013-12-04 17:10:57 +08002453 if (sn_opts) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002454 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
Peter Maydell10d6eda2017-02-10 16:28:24 +00002455 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2456 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2457 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002458 } else if (snapshot_name != NULL) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002459 if (s.src_num > 1) {
Markus Armbruster6daf1942011-06-22 14:03:54 +02002460 error_report("No support for concatenating multiple snapshot");
edison51ef6722010-09-21 19:58:41 -07002461 ret = -1;
2462 goto out;
2463 }
Wenchao Xia7b4c4782013-12-04 17:10:54 +08002464
Peter Lieven9fd77f92017-04-21 11:11:55 +02002465 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2466 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002467 }
Markus Armbruster84d18f02014-01-30 15:07:28 +01002468 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002469 error_reportf_err(local_err, "Failed to load snapshot: ");
Wenchao Xiaef806542013-12-04 17:10:57 +08002470 ret = -1;
2471 goto out;
edison51ef6722010-09-21 19:58:41 -07002472 }
2473
Max Reitz2e024cd2015-02-11 09:58:46 -05002474 if (!skip_create) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002475 /* Find driver and parse its options */
2476 drv = bdrv_find_format(out_fmt);
2477 if (!drv) {
2478 error_report("Unknown file format '%s'", out_fmt);
2479 ret = -1;
2480 goto out;
2481 }
2482
2483 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2484 if (!proto_drv) {
2485 error_report_err(local_err);
2486 ret = -1;
2487 goto out;
2488 }
2489
Max Reitz2e024cd2015-02-11 09:58:46 -05002490 if (!drv->create_opts) {
2491 error_report("Format driver '%s' does not support image creation",
2492 drv->format_name);
2493 ret = -1;
2494 goto out;
2495 }
Max Reitzf75613c2014-12-02 18:32:46 +01002496
Max Reitz2e024cd2015-02-11 09:58:46 -05002497 if (!proto_drv->create_opts) {
2498 error_report("Protocol driver '%s' does not support image creation",
2499 proto_drv->format_name);
2500 ret = -1;
2501 goto out;
2502 }
Max Reitzf75613c2014-12-02 18:32:46 +01002503
Max Reitz2e024cd2015-02-11 09:58:46 -05002504 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2505 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfdb08adf2009-06-04 15:39:38 +02002506
Max Reitz2e024cd2015-02-11 09:58:46 -05002507 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002508 if (options) {
Markus Armbruster235e59c2020-07-07 18:05:42 +02002509 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
Markus Armbruster97a2ca72015-03-14 10:23:15 +01002510 error_report_err(local_err);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002511 ret = -1;
2512 goto out;
2513 }
Max Reitz2e024cd2015-02-11 09:58:46 -05002514 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002515
Yi Lic075c422020-08-19 09:36:07 +08002516 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
2517 s.total_sectors * BDRV_SECTOR_SIZE, &error_abort);
Max Reitz2e024cd2015-02-11 09:58:46 -05002518 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2519 if (ret < 0) {
2520 goto out;
2521 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002522 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002523
Kevin Wolfa18953f2010-10-14 15:46:04 +02002524 /* Get backing file name if -o backing_file was used */
Chunyan Liu83d05212014-06-05 17:20:51 +08002525 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
Kevin Wolfa18953f2010-10-14 15:46:04 +02002526 if (out_baseimg_param) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002527 out_baseimg = out_baseimg_param;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002528 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002529 s.target_has_backing = (bool) out_baseimg;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002530
David Edmondson168468f2020-02-05 11:02:48 +00002531 if (s.has_zero_init && s.target_has_backing) {
2532 error_report("Cannot use --target-is-zero when the destination "
2533 "image has a backing file");
2534 goto out;
2535 }
2536
Max Reitz48758a82017-04-26 15:46:48 +02002537 if (s.src_num > 1 && out_baseimg) {
2538 error_report("Having a backing file for the target makes no sense when "
2539 "concatenating multiple input images");
2540 ret = -1;
2541 goto out;
2542 }
2543
Eric Blaked9f059a2020-07-06 15:39:54 -05002544 if (out_baseimg_param) {
2545 if (!qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT)) {
2546 warn_report("Deprecated use of backing file without explicit "
2547 "backing format");
2548 }
2549 }
2550
Kevin Wolfefa84d42009-05-18 16:42:12 +02002551 /* Check if compression is supported */
Peter Lieven9fd77f92017-04-21 11:11:55 +02002552 if (s.compressed) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002553 bool encryption =
2554 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002555 const char *encryptfmt =
2556 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
Chunyan Liu83d05212014-06-05 17:20:51 +08002557 const char *preallocation =
2558 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
Kevin Wolfefa84d42009-05-18 16:42:12 +02002559
Vladimir Sementsov-Ogievskiyac850bf2019-06-04 19:15:06 +03002560 if (drv && !block_driver_can_compress(drv)) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002561 error_report("Compression not supported for this file format");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002562 ret = -1;
2563 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002564 }
2565
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002566 if (encryption || encryptfmt) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002567 error_report("Compression and encryption not supported at "
2568 "the same time");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002569 ret = -1;
2570 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002571 }
Kevin Wolf41521fa2011-10-18 16:19:42 +02002572
Chunyan Liu83d05212014-06-05 17:20:51 +08002573 if (preallocation
2574 && strcmp(preallocation, "off"))
Kevin Wolf41521fa2011-10-18 16:19:42 +02002575 {
2576 error_report("Compression and preallocation not supported at "
2577 "the same time");
2578 ret = -1;
2579 goto out;
2580 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002581 }
2582
Eric Blake15e39ad2020-05-21 14:21:36 -05002583 /* Determine if bitmaps need copying */
2584 if (bitmaps) {
2585 if (s.src_num > 1) {
2586 error_report("Copying bitmaps only possible with single source");
2587 ret = -1;
2588 goto out;
2589 }
2590 if (!bdrv_supports_persistent_dirty_bitmap(blk_bs(s.src[0]))) {
2591 error_report("Source lacks bitmap support");
2592 ret = -1;
2593 goto out;
2594 }
2595 }
2596
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002597 /*
2598 * The later open call will need any decryption secrets, and
2599 * bdrv_create() will purge "opts", so extract them now before
2600 * they are lost.
2601 */
2602 if (!skip_create) {
2603 open_opts = qdict_new();
2604 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002605
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002606 /* Create the new image */
Chunyan Liuc282e1f2014-06-05 17:21:11 +08002607 ret = bdrv_create(drv, out_filename, opts, &local_err);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002608 if (ret < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002609 error_reportf_err(local_err, "%s: error while converting %s: ",
2610 out_filename, out_fmt);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002611 goto out;
bellardea2384d2004-08-01 21:59:26 +00002612 }
2613 }
ths3b46e622007-09-17 08:09:54 +00002614
Max Reitz4d7c4872019-07-24 19:12:29 +02002615 s.target_is_new = !skip_create;
2616
Peter Lieven9fd77f92017-04-21 11:11:55 +02002617 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
Kevin Wolfce099542016-03-15 13:01:04 +01002618 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002619 if (ret < 0) {
2620 error_report("Invalid cache option: %s", cache);
Markus Armbrusterbb9cd2e2014-05-28 11:17:07 +02002621 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002622 }
2623
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002624 if (skip_create) {
2625 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002626 flags, writethrough, s.quiet, false);
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002627 } else {
2628 /* TODO ultimately we should allow --target-image-opts
2629 * to be used even when -n is not given.
2630 * That has to wait for bdrv_create to be improved
2631 * to allow filenames in option syntax
2632 */
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002633 s.target = img_open_file(out_filename, open_opts, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002634 flags, writethrough, s.quiet, false);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002635 open_opts = NULL; /* blk_new_open will have freed it */
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002636 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002637 if (!s.target) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002638 ret = -1;
2639 goto out;
2640 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002641 out_bs = blk_bs(s.target);
bellardea2384d2004-08-01 21:59:26 +00002642
Eric Blake15e39ad2020-05-21 14:21:36 -05002643 if (bitmaps && !bdrv_supports_persistent_dirty_bitmap(out_bs)) {
2644 error_report("Format driver '%s' does not support bitmaps",
2645 out_bs->drv->format_name);
2646 ret = -1;
2647 goto out;
2648 }
2649
Vladimir Sementsov-Ogievskiyac850bf2019-06-04 19:15:06 +03002650 if (s.compressed && !block_driver_can_compress(out_bs->drv)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002651 error_report("Compression not supported for this file format");
2652 ret = -1;
2653 goto out;
2654 }
2655
Eric Blake5def6b82016-06-23 16:37:19 -06002656 /* increase bufsectors from the default 4096 (2M) if opt_transfer
Peter Lieven6360ab22018-07-13 09:15:39 +02002657 * or discard_alignment of the out_bs is greater. Limit to
2658 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2659 s.buf_sectors = MIN(MAX_BUF_SECTORS,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002660 MAX(s.buf_sectors,
2661 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2662 out_bs->bl.pdiscard_alignment >>
2663 BDRV_SECTOR_BITS)));
Peter Lievenf2521c92013-11-27 11:07:06 +01002664
Peter Lieven8dcd3c92018-07-12 15:00:10 +02002665 /* try to align the write requests to the destination to avoid unnecessary
2666 * RMW cycles. */
2667 s.alignment = MAX(pow2floor(s.min_sparse),
2668 DIV_ROUND_UP(out_bs->bl.request_alignment,
2669 BDRV_SECTOR_SIZE));
2670 assert(is_power_of_2(s.alignment));
2671
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002672 if (skip_create) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002673 int64_t output_sectors = blk_nb_sectors(s.target);
Markus Armbruster43716fa2014-06-26 13:23:21 +02002674 if (output_sectors < 0) {
Gongleieec5eb42015-02-25 12:22:27 +08002675 error_report("unable to get output image length: %s",
Markus Armbruster43716fa2014-06-26 13:23:21 +02002676 strerror(-output_sectors));
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002677 ret = -1;
2678 goto out;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002679 } else if (output_sectors < s.total_sectors) {
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002680 error_report("output file is smaller than input file");
2681 ret = -1;
2682 goto out;
2683 }
2684 }
2685
Max Reitzc69291e2020-01-21 16:59:14 +01002686 if (s.target_has_backing && s.target_is_new) {
Max Reitz351c8ef2018-05-01 18:57:49 +02002687 /* Errors are treated as "backing length unknown" (which means
2688 * s.target_backing_sectors has to be negative, which it will
2689 * be automatically). The backing file length is used only
2690 * for optimizations, so such a case is not fatal. */
Max Reitz4a2061e2019-06-12 19:00:30 +02002691 s.target_backing_sectors =
2692 bdrv_nb_sectors(bdrv_backing_chain_next(out_bs));
Max Reitz351c8ef2018-05-01 18:57:49 +02002693 } else {
2694 s.target_backing_sectors = -1;
2695 }
2696
Peter Lieven24f833c2013-11-27 11:07:07 +01002697 ret = bdrv_get_info(out_bs, &bdi);
2698 if (ret < 0) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002699 if (s.compressed) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002700 error_report("could not get block driver info");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002701 goto out;
2702 }
Peter Lieven24f833c2013-11-27 11:07:07 +01002703 } else {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002704 s.compressed = s.compressed || bdi.needs_compressed_writes;
2705 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
Peter Lieven24f833c2013-11-27 11:07:07 +01002706 }
2707
Peter Lieven9fd77f92017-04-21 11:11:55 +02002708 ret = convert_do_copy(&s);
Eric Blake15e39ad2020-05-21 14:21:36 -05002709
2710 /* Now copy the bitmaps */
2711 if (bitmaps && ret == 0) {
2712 ret = convert_copy_bitmaps(blk_bs(s.src[0]), out_bs);
2713 }
2714
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002715out:
Peter Lieven13c28af2013-11-27 11:07:01 +01002716 if (!ret) {
2717 qemu_progress_print(100, 0);
2718 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002719 qemu_progress_end();
Chunyan Liu83d05212014-06-05 17:20:51 +08002720 qemu_opts_del(opts);
2721 qemu_opts_free(create_opts);
Markus Armbrusterfbf28a42014-09-29 16:07:55 +02002722 qemu_opts_del(sn_opts);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002723 qobject_unref(open_opts);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002724 blk_unref(s.target);
2725 if (s.src) {
2726 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2727 blk_unref(s.src[bs_i]);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002728 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002729 g_free(s.src);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002730 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002731 g_free(s.src_sectors);
Peter Lievenaf8d43d2020-09-01 14:51:29 +02002732 g_free(s.src_alignment);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002733fail_getopt:
2734 g_free(options);
2735
Peter Lieven9fd77f92017-04-21 11:11:55 +02002736 return !!ret;
bellardea2384d2004-08-01 21:59:26 +00002737}
2738
bellard57d1a2b2004-08-03 21:15:11 +00002739
bellardfaea38e2006-08-05 21:31:00 +00002740static void dump_snapshots(BlockDriverState *bs)
2741{
2742 QEMUSnapshotInfo *sn_tab, *sn;
2743 int nb_sns, i;
bellardfaea38e2006-08-05 21:31:00 +00002744
2745 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2746 if (nb_sns <= 0)
2747 return;
2748 printf("Snapshot list:\n");
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002749 bdrv_snapshot_dump(NULL);
Wenchao Xia5b917042013-05-25 11:09:45 +08002750 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002751 for(i = 0; i < nb_sns; i++) {
2752 sn = &sn_tab[i];
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002753 bdrv_snapshot_dump(sn);
Wenchao Xia5b917042013-05-25 11:09:45 +08002754 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002755 }
Anthony Liguori7267c092011-08-20 22:09:37 -05002756 g_free(sn_tab);
bellardfaea38e2006-08-05 21:31:00 +00002757}
2758
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002759static void dump_json_image_info_list(ImageInfoList *list)
2760{
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002761 QString *str;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002762 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002763 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002764
2765 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2766 visit_complete(v, &obj);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002767 str = qobject_to_json_pretty(obj);
2768 assert(str != NULL);
2769 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002770 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002771 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002772 qobject_unref(str);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002773}
2774
Benoît Canetc054b3f2012-09-05 13:09:02 +02002775static void dump_json_image_info(ImageInfo *info)
2776{
Benoît Canetc054b3f2012-09-05 13:09:02 +02002777 QString *str;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002778 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002779 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002780
2781 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2782 visit_complete(v, &obj);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002783 str = qobject_to_json_pretty(obj);
2784 assert(str != NULL);
2785 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002786 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002787 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002788 qobject_unref(str);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002789}
2790
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002791static void dump_human_image_info_list(ImageInfoList *list)
2792{
2793 ImageInfoList *elem;
2794 bool delim = false;
2795
2796 for (elem = list; elem; elem = elem->next) {
2797 if (delim) {
2798 printf("\n");
2799 }
2800 delim = true;
2801
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002802 bdrv_image_info_dump(elem->value);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002803 }
2804}
2805
2806static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2807{
2808 return strcmp(a, b) == 0;
2809}
2810
2811/**
2812 * Open an image file chain and return an ImageInfoList
2813 *
2814 * @filename: topmost image filename
2815 * @fmt: topmost image format (may be NULL to autodetect)
2816 * @chain: true - enumerate entire backing file chain
2817 * false - only topmost image file
2818 *
2819 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2820 * image file. If there was an error a message will have been printed to
2821 * stderr.
2822 */
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002823static ImageInfoList *collect_image_info_list(bool image_opts,
2824 const char *filename,
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002825 const char *fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002826 bool chain, bool force_share)
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002827{
2828 ImageInfoList *head = NULL;
2829 ImageInfoList **last = &head;
2830 GHashTable *filenames;
Wenchao Xia43526ec2013-06-06 12:27:58 +08002831 Error *err = NULL;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002832
2833 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2834
2835 while (filename) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02002836 BlockBackend *blk;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002837 BlockDriverState *bs;
2838 ImageInfo *info;
2839 ImageInfoList *elem;
2840
2841 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2842 error_report("Backing file '%s' creates an infinite loop.",
2843 filename);
2844 goto err;
2845 }
2846 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2847
Max Reitzefaa7c42016-03-16 19:54:38 +01002848 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002849 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2850 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002851 if (!blk) {
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002852 goto err;
2853 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002854 bs = blk_bs(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002855
Wenchao Xia43526ec2013-06-06 12:27:58 +08002856 bdrv_query_image_info(bs, &info, &err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002857 if (err) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01002858 error_report_err(err);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002859 blk_unref(blk);
Wenchao Xia43526ec2013-06-06 12:27:58 +08002860 goto err;
Wenchao Xiafb0ed452013-06-06 12:27:57 +08002861 }
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002862
2863 elem = g_new0(ImageInfoList, 1);
2864 elem->value = info;
2865 *last = elem;
2866 last = &elem->next;
2867
Markus Armbruster26f54e92014-10-07 13:59:04 +02002868 blk_unref(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002869
Stefan Hajnoczi0da7d132019-12-05 13:46:46 +00002870 /* Clear parameters that only apply to the topmost image */
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002871 filename = fmt = NULL;
Stefan Hajnoczi0da7d132019-12-05 13:46:46 +00002872 image_opts = false;
2873
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002874 if (chain) {
2875 if (info->has_full_backing_filename) {
2876 filename = info->full_backing_filename;
2877 } else if (info->has_backing_filename) {
John Snow92d617a2015-12-14 14:55:15 -05002878 error_report("Could not determine absolute backing filename,"
2879 " but backing filename '%s' present",
2880 info->backing_filename);
2881 goto err;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002882 }
2883 if (info->has_backing_filename_format) {
2884 fmt = info->backing_filename_format;
2885 }
2886 }
2887 }
2888 g_hash_table_destroy(filenames);
2889 return head;
2890
2891err:
2892 qapi_free_ImageInfoList(head);
2893 g_hash_table_destroy(filenames);
2894 return NULL;
2895}
2896
Benoît Canetc054b3f2012-09-05 13:09:02 +02002897static int img_info(int argc, char **argv)
2898{
2899 int c;
2900 OutputFormat output_format = OFORMAT_HUMAN;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002901 bool chain = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002902 const char *filename, *fmt, *output;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002903 ImageInfoList *list;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002904 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08002905 bool force_share = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002906
bellardea2384d2004-08-01 21:59:26 +00002907 fmt = NULL;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002908 output = NULL;
bellardea2384d2004-08-01 21:59:26 +00002909 for(;;) {
Benoît Canetc054b3f2012-09-05 13:09:02 +02002910 int option_index = 0;
2911 static const struct option long_options[] = {
2912 {"help", no_argument, 0, 'h'},
2913 {"format", required_argument, 0, 'f'},
2914 {"output", required_argument, 0, OPTION_OUTPUT},
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002915 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002916 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002917 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002918 {"force-share", no_argument, 0, 'U'},
Benoît Canetc054b3f2012-09-05 13:09:02 +02002919 {0, 0, 0, 0}
2920 };
Fam Zheng335e9932017-05-03 00:35:39 +08002921 c = getopt_long(argc, argv, ":f:hU",
Benoît Canetc054b3f2012-09-05 13:09:02 +02002922 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002923 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002924 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002925 }
bellardea2384d2004-08-01 21:59:26 +00002926 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002927 case ':':
2928 missing_argument(argv[optind - 1]);
2929 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002930 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002931 unrecognized_option(argv[optind - 1]);
2932 break;
bellardea2384d2004-08-01 21:59:26 +00002933 case 'h':
2934 help();
2935 break;
2936 case 'f':
2937 fmt = optarg;
2938 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002939 case 'U':
2940 force_share = true;
2941 break;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002942 case OPTION_OUTPUT:
2943 output = optarg;
2944 break;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002945 case OPTION_BACKING_CHAIN:
2946 chain = true;
2947 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002948 case OPTION_OBJECT: {
2949 QemuOpts *opts;
2950 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2951 optarg, true);
2952 if (!opts) {
2953 return 1;
2954 }
2955 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002956 case OPTION_IMAGE_OPTS:
2957 image_opts = true;
2958 break;
bellardea2384d2004-08-01 21:59:26 +00002959 }
2960 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02002961 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08002962 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002963 }
bellardea2384d2004-08-01 21:59:26 +00002964 filename = argv[optind++];
2965
Benoît Canetc054b3f2012-09-05 13:09:02 +02002966 if (output && !strcmp(output, "json")) {
2967 output_format = OFORMAT_JSON;
2968 } else if (output && !strcmp(output, "human")) {
2969 output_format = OFORMAT_HUMAN;
2970 } else if (output) {
2971 error_report("--output must be used with human or json as argument.");
2972 return 1;
2973 }
2974
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002975 if (qemu_opts_foreach(&qemu_object_opts,
2976 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02002977 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002978 return 1;
2979 }
2980
Fam Zheng335e9932017-05-03 00:35:39 +08002981 list = collect_image_info_list(image_opts, filename, fmt, chain,
2982 force_share);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002983 if (!list) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002984 return 1;
2985 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002986
Benoît Canetc054b3f2012-09-05 13:09:02 +02002987 switch (output_format) {
2988 case OFORMAT_HUMAN:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002989 dump_human_image_info_list(list);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002990 break;
2991 case OFORMAT_JSON:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002992 if (chain) {
2993 dump_json_image_info_list(list);
2994 } else {
2995 dump_json_image_info(list->value);
2996 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002997 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002998 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002999
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02003000 qapi_free_ImageInfoList(list);
bellardea2384d2004-08-01 21:59:26 +00003001 return 0;
3002}
3003
Eric Blake30065d12019-03-26 13:40:43 -05003004static int dump_map_entry(OutputFormat output_format, MapEntry *e,
3005 MapEntry *next)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003006{
3007 switch (output_format) {
3008 case OFORMAT_HUMAN:
Fam Zheng16b0d552016-01-26 11:59:02 +08003009 if (e->data && !e->has_offset) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003010 error_report("File contains external, encrypted or compressed clusters.");
Eric Blake30065d12019-03-26 13:40:43 -05003011 return -1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003012 }
Fam Zheng16b0d552016-01-26 11:59:02 +08003013 if (e->data && !e->zero) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003014 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
Fam Zheng16b0d552016-01-26 11:59:02 +08003015 e->start, e->length,
3016 e->has_offset ? e->offset : 0,
3017 e->has_filename ? e->filename : "");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003018 }
3019 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
3020 * Modify the flags here to allow more coalescing.
3021 */
Fam Zheng16b0d552016-01-26 11:59:02 +08003022 if (next && (!next->data || next->zero)) {
3023 next->data = false;
3024 next->zero = true;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003025 }
3026 break;
3027 case OFORMAT_JSON:
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003028 printf("{ \"start\": %"PRId64", \"length\": %"PRId64","
Fam Zheng16b0d552016-01-26 11:59:02 +08003029 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003030 e->start, e->length, e->depth,
Fam Zheng16b0d552016-01-26 11:59:02 +08003031 e->zero ? "true" : "false",
3032 e->data ? "true" : "false");
3033 if (e->has_offset) {
Paolo Bonzinic745bfb2013-09-11 18:47:52 +02003034 printf(", \"offset\": %"PRId64"", e->offset);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003035 }
3036 putchar('}');
3037
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003038 if (next) {
3039 puts(",");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003040 }
3041 break;
3042 }
Eric Blake30065d12019-03-26 13:40:43 -05003043 return 0;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003044}
3045
Eric Blake5e344dd2017-10-11 22:47:02 -05003046static int get_block_status(BlockDriverState *bs, int64_t offset,
3047 int64_t bytes, MapEntry *e)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003048{
Eric Blake237d78f2017-10-11 22:47:03 -05003049 int ret;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003050 int depth;
Fam Zheng67a0fd22016-01-26 11:58:48 +08003051 BlockDriverState *file;
John Snow28756452016-02-05 13:12:33 -05003052 bool has_offset;
Eric Blake237d78f2017-10-11 22:47:03 -05003053 int64_t map;
Max Reitzf30c66b2019-02-01 20:29:05 +01003054 char *filename = NULL;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003055
3056 /* As an optimization, we could cache the current range of unallocated
3057 * clusters in each file of the chain, and avoid querying the same
3058 * range repeatedly.
3059 */
3060
3061 depth = 0;
3062 for (;;) {
Max Reitz4a2061e2019-06-12 19:00:30 +02003063 bs = bdrv_skip_filters(bs);
Eric Blake237d78f2017-10-11 22:47:03 -05003064 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003065 if (ret < 0) {
3066 return ret;
3067 }
Eric Blake237d78f2017-10-11 22:47:03 -05003068 assert(bytes);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003069 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
3070 break;
3071 }
Max Reitz4a2061e2019-06-12 19:00:30 +02003072 bs = bdrv_cow_bs(bs);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003073 if (bs == NULL) {
3074 ret = 0;
3075 break;
3076 }
3077
3078 depth++;
3079 }
3080
John Snow28756452016-02-05 13:12:33 -05003081 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
3082
Max Reitzf30c66b2019-02-01 20:29:05 +01003083 if (file && has_offset) {
3084 bdrv_refresh_filename(file);
3085 filename = file->filename;
3086 }
3087
John Snow28756452016-02-05 13:12:33 -05003088 *e = (MapEntry) {
Eric Blake5e344dd2017-10-11 22:47:02 -05003089 .start = offset,
Eric Blake237d78f2017-10-11 22:47:03 -05003090 .length = bytes,
John Snow28756452016-02-05 13:12:33 -05003091 .data = !!(ret & BDRV_BLOCK_DATA),
3092 .zero = !!(ret & BDRV_BLOCK_ZERO),
Eric Blake237d78f2017-10-11 22:47:03 -05003093 .offset = map,
John Snow28756452016-02-05 13:12:33 -05003094 .has_offset = has_offset,
3095 .depth = depth,
Max Reitzf30c66b2019-02-01 20:29:05 +01003096 .has_filename = filename,
3097 .filename = filename,
John Snow28756452016-02-05 13:12:33 -05003098 };
3099
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003100 return 0;
3101}
3102
Fam Zheng16b0d552016-01-26 11:59:02 +08003103static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
3104{
3105 if (curr->length == 0) {
3106 return false;
3107 }
3108 if (curr->zero != next->zero ||
3109 curr->data != next->data ||
3110 curr->depth != next->depth ||
3111 curr->has_filename != next->has_filename ||
3112 curr->has_offset != next->has_offset) {
3113 return false;
3114 }
3115 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
3116 return false;
3117 }
3118 if (curr->has_offset && curr->offset + curr->length != next->offset) {
3119 return false;
3120 }
3121 return true;
3122}
3123
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003124static int img_map(int argc, char **argv)
3125{
3126 int c;
3127 OutputFormat output_format = OFORMAT_HUMAN;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003128 BlockBackend *blk;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003129 BlockDriverState *bs;
3130 const char *filename, *fmt, *output;
3131 int64_t length;
3132 MapEntry curr = { .length = 0 }, next;
3133 int ret = 0;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003134 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003135 bool force_share = false;
Eyal Moscovicic0469492020-05-13 16:36:29 +03003136 int64_t start_offset = 0;
3137 int64_t max_length = -1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003138
3139 fmt = NULL;
3140 output = NULL;
3141 for (;;) {
3142 int option_index = 0;
3143 static const struct option long_options[] = {
3144 {"help", no_argument, 0, 'h'},
3145 {"format", required_argument, 0, 'f'},
3146 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003147 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003148 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003149 {"force-share", no_argument, 0, 'U'},
Eyal Moscovicic0469492020-05-13 16:36:29 +03003150 {"start-offset", required_argument, 0, 's'},
3151 {"max-length", required_argument, 0, 'l'},
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003152 {0, 0, 0, 0}
3153 };
Eyal Moscovicic0469492020-05-13 16:36:29 +03003154 c = getopt_long(argc, argv, ":f:s:l:hU",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003155 long_options, &option_index);
3156 if (c == -1) {
3157 break;
3158 }
3159 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003160 case ':':
3161 missing_argument(argv[optind - 1]);
3162 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003163 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003164 unrecognized_option(argv[optind - 1]);
3165 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003166 case 'h':
3167 help();
3168 break;
3169 case 'f':
3170 fmt = optarg;
3171 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003172 case 'U':
3173 force_share = true;
3174 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003175 case OPTION_OUTPUT:
3176 output = optarg;
3177 break;
Eyal Moscovicic0469492020-05-13 16:36:29 +03003178 case 's':
3179 start_offset = cvtnum("start offset", optarg);
3180 if (start_offset < 0) {
3181 return 1;
3182 }
3183 break;
3184 case 'l':
3185 max_length = cvtnum("max length", optarg);
3186 if (max_length < 0) {
3187 return 1;
3188 }
3189 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003190 case OPTION_OBJECT: {
3191 QemuOpts *opts;
3192 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3193 optarg, true);
3194 if (!opts) {
3195 return 1;
3196 }
3197 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003198 case OPTION_IMAGE_OPTS:
3199 image_opts = true;
3200 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003201 }
3202 }
Fam Zhengac1307a2014-04-22 13:36:11 +08003203 if (optind != argc - 1) {
3204 error_exit("Expecting one image file name");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003205 }
Fam Zhengac1307a2014-04-22 13:36:11 +08003206 filename = argv[optind];
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003207
3208 if (output && !strcmp(output, "json")) {
3209 output_format = OFORMAT_JSON;
3210 } else if (output && !strcmp(output, "human")) {
3211 output_format = OFORMAT_HUMAN;
3212 } else if (output) {
3213 error_report("--output must be used with human or json as argument.");
3214 return 1;
3215 }
3216
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003217 if (qemu_opts_foreach(&qemu_object_opts,
3218 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02003219 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003220 return 1;
3221 }
3222
Fam Zheng335e9932017-05-03 00:35:39 +08003223 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003224 if (!blk) {
3225 return 1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003226 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003227 bs = blk_bs(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003228
3229 if (output_format == OFORMAT_HUMAN) {
3230 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003231 } else if (output_format == OFORMAT_JSON) {
3232 putchar('[');
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003233 }
3234
Max Reitzf1d3cd72015-02-05 13:58:18 -05003235 length = blk_getlength(blk);
Eyal Moscovici8f282e82020-05-13 16:36:27 +03003236 if (length < 0) {
3237 error_report("Failed to get size for '%s'", filename);
3238 return 1;
3239 }
Eyal Moscovicic0469492020-05-13 16:36:29 +03003240 if (max_length != -1) {
3241 length = MIN(start_offset + max_length, length);
3242 }
Eyal Moscovici8f282e82020-05-13 16:36:27 +03003243
Eyal Moscovicic0469492020-05-13 16:36:29 +03003244 curr.start = start_offset;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003245 while (curr.start + curr.length < length) {
Eric Blake5e344dd2017-10-11 22:47:02 -05003246 int64_t offset = curr.start + curr.length;
Kevin Wolfd0ceea82020-07-07 16:46:29 +02003247 int64_t n = length - offset;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003248
Eric Blake5e344dd2017-10-11 22:47:02 -05003249 ret = get_block_status(bs, offset, n, &next);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003250 if (ret < 0) {
3251 error_report("Could not read file metadata: %s", strerror(-ret));
3252 goto out;
3253 }
3254
Fam Zheng16b0d552016-01-26 11:59:02 +08003255 if (entry_mergeable(&curr, &next)) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003256 curr.length += next.length;
3257 continue;
3258 }
3259
3260 if (curr.length > 0) {
Eric Blake30065d12019-03-26 13:40:43 -05003261 ret = dump_map_entry(output_format, &curr, &next);
3262 if (ret < 0) {
3263 goto out;
3264 }
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003265 }
3266 curr = next;
3267 }
3268
Eric Blake30065d12019-03-26 13:40:43 -05003269 ret = dump_map_entry(output_format, &curr, NULL);
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003270 if (output_format == OFORMAT_JSON) {
3271 puts("]");
3272 }
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003273
3274out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003275 blk_unref(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003276 return ret < 0;
3277}
3278
aliguorif7b4a942009-01-07 17:40:15 +00003279#define SNAPSHOT_LIST 1
3280#define SNAPSHOT_CREATE 2
3281#define SNAPSHOT_APPLY 3
3282#define SNAPSHOT_DELETE 4
3283
Stuart Brady153859b2009-06-07 00:42:17 +01003284static int img_snapshot(int argc, char **argv)
aliguorif7b4a942009-01-07 17:40:15 +00003285{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003286 BlockBackend *blk;
aliguorif7b4a942009-01-07 17:40:15 +00003287 BlockDriverState *bs;
3288 QEMUSnapshotInfo sn;
3289 char *filename, *snapshot_name = NULL;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003290 int c, ret = 0, bdrv_oflags;
aliguorif7b4a942009-01-07 17:40:15 +00003291 int action = 0;
3292 qemu_timeval tv;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003293 bool quiet = false;
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003294 Error *err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003295 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003296 bool force_share = false;
aliguorif7b4a942009-01-07 17:40:15 +00003297
Kevin Wolfce099542016-03-15 13:01:04 +01003298 bdrv_oflags = BDRV_O_RDWR;
aliguorif7b4a942009-01-07 17:40:15 +00003299 /* Parse commandline parameters */
3300 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003301 static const struct option long_options[] = {
3302 {"help", no_argument, 0, 'h'},
3303 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003304 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003305 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003306 {0, 0, 0, 0}
3307 };
Fam Zheng335e9932017-05-03 00:35:39 +08003308 c = getopt_long(argc, argv, ":la:c:d:hqU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003309 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003310 if (c == -1) {
aliguorif7b4a942009-01-07 17:40:15 +00003311 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003312 }
aliguorif7b4a942009-01-07 17:40:15 +00003313 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003314 case ':':
3315 missing_argument(argv[optind - 1]);
3316 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003317 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003318 unrecognized_option(argv[optind - 1]);
3319 break;
aliguorif7b4a942009-01-07 17:40:15 +00003320 case 'h':
3321 help();
Stuart Brady153859b2009-06-07 00:42:17 +01003322 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003323 case 'l':
3324 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003325 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003326 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003327 }
3328 action = SNAPSHOT_LIST;
Naphtali Spreif5edb012010-01-17 16:48:13 +02003329 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
aliguorif7b4a942009-01-07 17:40:15 +00003330 break;
3331 case 'a':
3332 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003333 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003334 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003335 }
3336 action = SNAPSHOT_APPLY;
3337 snapshot_name = optarg;
3338 break;
3339 case 'c':
3340 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003341 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003342 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003343 }
3344 action = SNAPSHOT_CREATE;
3345 snapshot_name = optarg;
3346 break;
3347 case 'd':
3348 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003349 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003350 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003351 }
3352 action = SNAPSHOT_DELETE;
3353 snapshot_name = optarg;
3354 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003355 case 'q':
3356 quiet = true;
3357 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003358 case 'U':
3359 force_share = true;
3360 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003361 case OPTION_OBJECT: {
3362 QemuOpts *opts;
3363 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3364 optarg, true);
3365 if (!opts) {
3366 return 1;
3367 }
3368 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003369 case OPTION_IMAGE_OPTS:
3370 image_opts = true;
3371 break;
aliguorif7b4a942009-01-07 17:40:15 +00003372 }
3373 }
3374
Kevin Wolffc11eb22013-08-05 10:53:04 +02003375 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003376 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003377 }
aliguorif7b4a942009-01-07 17:40:15 +00003378 filename = argv[optind++];
3379
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003380 if (qemu_opts_foreach(&qemu_object_opts,
3381 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02003382 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003383 return 1;
3384 }
3385
aliguorif7b4a942009-01-07 17:40:15 +00003386 /* Open the image */
Fam Zheng335e9932017-05-03 00:35:39 +08003387 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3388 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003389 if (!blk) {
3390 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003391 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003392 bs = blk_bs(blk);
aliguorif7b4a942009-01-07 17:40:15 +00003393
3394 /* Perform the requested action */
3395 switch(action) {
3396 case SNAPSHOT_LIST:
3397 dump_snapshots(bs);
3398 break;
3399
3400 case SNAPSHOT_CREATE:
3401 memset(&sn, 0, sizeof(sn));
3402 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3403
3404 qemu_gettimeofday(&tv);
3405 sn.date_sec = tv.tv_sec;
3406 sn.date_nsec = tv.tv_usec * 1000;
3407
3408 ret = bdrv_snapshot_create(bs, &sn);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003409 if (ret) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003410 error_report("Could not create snapshot '%s': %d (%s)",
aliguorif7b4a942009-01-07 17:40:15 +00003411 snapshot_name, ret, strerror(-ret));
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003412 }
aliguorif7b4a942009-01-07 17:40:15 +00003413 break;
3414
3415 case SNAPSHOT_APPLY:
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003416 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003417 if (ret) {
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003418 error_reportf_err(err, "Could not apply snapshot '%s': ",
3419 snapshot_name);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003420 }
aliguorif7b4a942009-01-07 17:40:15 +00003421 break;
3422
3423 case SNAPSHOT_DELETE:
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003424 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3425 if (ret < 0) {
3426 error_report("Could not delete snapshot '%s': snapshot not "
3427 "found", snapshot_name);
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003428 ret = 1;
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003429 } else {
3430 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3431 if (ret < 0) {
3432 error_reportf_err(err, "Could not delete snapshot '%s': ",
3433 snapshot_name);
3434 ret = 1;
3435 }
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003436 }
aliguorif7b4a942009-01-07 17:40:15 +00003437 break;
3438 }
3439
3440 /* Cleanup */
Markus Armbruster26f54e92014-10-07 13:59:04 +02003441 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003442 if (ret) {
3443 return 1;
3444 }
Stuart Brady153859b2009-06-07 00:42:17 +01003445 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003446}
3447
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003448static int img_rebase(int argc, char **argv)
3449{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003450 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
Paolo Bonzini396374c2016-02-25 23:53:54 +01003451 uint8_t *buf_old = NULL;
3452 uint8_t *buf_new = NULL;
Sam Eiderman863cc782019-05-23 19:33:36 +03003453 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
Max Reitz4a2061e2019-06-12 19:00:30 +02003454 BlockDriverState *unfiltered_bs;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003455 char *filename;
Max Reitz40055952014-07-22 22:58:42 +02003456 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3457 int c, flags, src_flags, ret;
Kevin Wolfce099542016-03-15 13:01:04 +01003458 bool writethrough, src_writethrough;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003459 int unsafe = 0;
Fam Zheng335e9932017-05-03 00:35:39 +08003460 bool force_share = false;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003461 int progress = 0;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003462 bool quiet = false;
Max Reitz34b5d2c2013-09-05 14:45:29 +02003463 Error *local_err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003464 bool image_opts = false;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003465
3466 /* Parse commandline parameters */
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003467 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003468 cache = BDRV_DEFAULT_CACHE;
Max Reitz40055952014-07-22 22:58:42 +02003469 src_cache = BDRV_DEFAULT_CACHE;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003470 out_baseimg = NULL;
3471 out_basefmt = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003472 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003473 static const struct option long_options[] = {
3474 {"help", no_argument, 0, 'h'},
3475 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003476 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003477 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003478 {0, 0, 0, 0}
3479 };
Fam Zheng335e9932017-05-03 00:35:39 +08003480 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003481 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003482 if (c == -1) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003483 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003484 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003485 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003486 case ':':
3487 missing_argument(argv[optind - 1]);
3488 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003489 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003490 unrecognized_option(argv[optind - 1]);
3491 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003492 case 'h':
3493 help();
3494 return 0;
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003495 case 'f':
3496 fmt = optarg;
3497 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003498 case 'F':
3499 out_basefmt = optarg;
3500 break;
3501 case 'b':
3502 out_baseimg = optarg;
3503 break;
3504 case 'u':
3505 unsafe = 1;
3506 break;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003507 case 'p':
3508 progress = 1;
3509 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003510 case 't':
3511 cache = optarg;
3512 break;
Max Reitz40055952014-07-22 22:58:42 +02003513 case 'T':
3514 src_cache = optarg;
3515 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003516 case 'q':
3517 quiet = true;
3518 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003519 case OPTION_OBJECT: {
3520 QemuOpts *opts;
3521 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3522 optarg, true);
3523 if (!opts) {
3524 return 1;
3525 }
3526 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003527 case OPTION_IMAGE_OPTS:
3528 image_opts = true;
3529 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003530 case 'U':
3531 force_share = true;
3532 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003533 }
3534 }
3535
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003536 if (quiet) {
3537 progress = 0;
3538 }
3539
Fam Zhengac1307a2014-04-22 13:36:11 +08003540 if (optind != argc - 1) {
3541 error_exit("Expecting one image file name");
3542 }
3543 if (!unsafe && !out_baseimg) {
3544 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003545 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003546 filename = argv[optind++];
3547
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003548 if (qemu_opts_foreach(&qemu_object_opts,
3549 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02003550 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003551 return 1;
3552 }
3553
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003554 qemu_progress_init(progress, 2.0);
3555 qemu_progress_print(0, 100);
3556
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003557 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
Kevin Wolfce099542016-03-15 13:01:04 +01003558 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003559 if (ret < 0) {
3560 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003561 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003562 }
3563
Kevin Wolfce099542016-03-15 13:01:04 +01003564 src_flags = 0;
3565 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
Max Reitz40055952014-07-22 22:58:42 +02003566 if (ret < 0) {
3567 error_report("Invalid source cache option: %s", src_cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003568 goto out;
Max Reitz40055952014-07-22 22:58:42 +02003569 }
3570
Kevin Wolfce099542016-03-15 13:01:04 +01003571 /* The source files are opened read-only, don't care about WCE */
3572 assert((src_flags & BDRV_O_RDWR) == 0);
3573 (void) src_writethrough;
3574
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003575 /*
3576 * Open the images.
3577 *
3578 * Ignore the old backing file for unsafe rebase in case we want to correct
3579 * the reference to a renamed or moved backing file.
3580 */
Fam Zheng335e9932017-05-03 00:35:39 +08003581 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3582 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003583 if (!blk) {
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003584 ret = -1;
3585 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003586 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003587 bs = blk_bs(blk);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003588
Max Reitz4a2061e2019-06-12 19:00:30 +02003589 unfiltered_bs = bdrv_skip_filters(bs);
3590
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003591 if (out_basefmt != NULL) {
Max Reitz644483d2015-02-05 13:58:17 -05003592 if (bdrv_find_format(out_basefmt) == NULL) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003593 error_report("Invalid format name: '%s'", out_basefmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003594 ret = -1;
3595 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003596 }
3597 }
3598
3599 /* For safe rebasing we need to compare old and new backing file */
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003600 if (!unsafe) {
Max Reitz644483d2015-02-05 13:58:17 -05003601 QDict *options = NULL;
Max Reitz4a2061e2019-06-12 19:00:30 +02003602 BlockDriverState *base_bs = bdrv_cow_bs(unfiltered_bs);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003603
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003604 if (base_bs) {
Kevin Wolfd861ab32019-04-25 14:25:10 +02003605 blk_old_backing = blk_new(qemu_get_aio_context(),
3606 BLK_PERM_CONSISTENT_READ,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003607 BLK_PERM_ALL);
3608 ret = blk_insert_bs(blk_old_backing, base_bs,
3609 &local_err);
3610 if (ret < 0) {
Max Reitz35ddd932019-05-09 19:52:35 +02003611 error_reportf_err(local_err,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003612 "Could not reuse old backing file '%s': ",
3613 base_bs->filename);
Max Reitz35ddd932019-05-09 19:52:35 +02003614 goto out;
3615 }
3616 } else {
3617 blk_old_backing = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003618 }
Max Reitz644483d2015-02-05 13:58:17 -05003619
Alex Bligha6166732012-10-16 13:46:18 +01003620 if (out_baseimg[0]) {
Max Reitzd16699b2018-05-09 20:20:01 +02003621 const char *overlay_filename;
3622 char *out_real_path;
3623
Fam Zheng335e9932017-05-03 00:35:39 +08003624 options = qdict_new();
Max Reitz644483d2015-02-05 13:58:17 -05003625 if (out_basefmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003626 qdict_put_str(options, "driver", out_basefmt);
Fam Zheng335e9932017-05-03 00:35:39 +08003627 }
3628 if (force_share) {
3629 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Max Reitz644483d2015-02-05 13:58:17 -05003630 }
3631
Max Reitzf30c66b2019-02-01 20:29:05 +01003632 bdrv_refresh_filename(bs);
Max Reitzd16699b2018-05-09 20:20:01 +02003633 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3634 : bs->filename;
Max Reitz645ae7d2019-02-01 20:29:14 +01003635 out_real_path =
3636 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3637 out_baseimg,
3638 &local_err);
Max Reitzd16699b2018-05-09 20:20:01 +02003639 if (local_err) {
Max Reitzf22356d2019-05-28 21:53:38 +02003640 qobject_unref(options);
Max Reitzd16699b2018-05-09 20:20:01 +02003641 error_reportf_err(local_err,
3642 "Could not resolve backing filename: ");
3643 ret = -1;
Max Reitzd16699b2018-05-09 20:20:01 +02003644 goto out;
3645 }
3646
Sam Eiderman863cc782019-05-23 19:33:36 +03003647 /*
3648 * Find out whether we rebase an image on top of a previous image
3649 * in its chain.
3650 */
3651 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
Sam Eiderman330c7292019-05-23 19:33:37 +03003652 if (prefix_chain_bs) {
Max Reitzf22356d2019-05-28 21:53:38 +02003653 qobject_unref(options);
Sam Eiderman330c7292019-05-23 19:33:37 +03003654 g_free(out_real_path);
Max Reitzf22356d2019-05-28 21:53:38 +02003655
Kevin Wolfd861ab32019-04-25 14:25:10 +02003656 blk_new_backing = blk_new(qemu_get_aio_context(),
3657 BLK_PERM_CONSISTENT_READ,
Sam Eiderman330c7292019-05-23 19:33:37 +03003658 BLK_PERM_ALL);
3659 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
3660 &local_err);
3661 if (ret < 0) {
3662 error_reportf_err(local_err,
3663 "Could not reuse backing file '%s': ",
3664 out_baseimg);
3665 goto out;
3666 }
3667 } else {
3668 blk_new_backing = blk_new_open(out_real_path, NULL,
3669 options, src_flags, &local_err);
3670 g_free(out_real_path);
3671 if (!blk_new_backing) {
3672 error_reportf_err(local_err,
3673 "Could not open new backing file '%s': ",
3674 out_baseimg);
3675 ret = -1;
3676 goto out;
3677 }
Alex Bligha6166732012-10-16 13:46:18 +01003678 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003679 }
3680 }
3681
3682 /*
3683 * Check each unallocated cluster in the COW file. If it is unallocated,
3684 * accesses go to the backing file. We must therefore compare this cluster
3685 * in the old and new backing file, and if they differ we need to copy it
3686 * from the old backing file into the COW file.
3687 *
3688 * If qemu-img crashes during this step, no harm is done. The content of
3689 * the image is the same as the original one at any time.
3690 */
3691 if (!unsafe) {
Eric Blake41536282017-10-11 22:47:15 -05003692 int64_t size;
Max Reitz35ddd932019-05-09 19:52:35 +02003693 int64_t old_backing_size = 0;
Eric Blake41536282017-10-11 22:47:15 -05003694 int64_t new_backing_size = 0;
3695 uint64_t offset;
3696 int64_t n;
Kevin Wolf1f710492012-10-12 14:29:18 +02003697 float local_progress = 0;
TeLeMand6771bf2010-02-08 16:20:00 +08003698
Max Reitzf1d3cd72015-02-05 13:58:18 -05003699 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3700 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003701
Eric Blake41536282017-10-11 22:47:15 -05003702 size = blk_getlength(blk);
3703 if (size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003704 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003705 filename, strerror(-size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003706 ret = -1;
3707 goto out;
3708 }
Max Reitz35ddd932019-05-09 19:52:35 +02003709 if (blk_old_backing) {
3710 old_backing_size = blk_getlength(blk_old_backing);
3711 if (old_backing_size < 0) {
3712 char backing_name[PATH_MAX];
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003713
Max Reitz35ddd932019-05-09 19:52:35 +02003714 bdrv_get_backing_filename(bs, backing_name,
3715 sizeof(backing_name));
3716 error_report("Could not get size of '%s': %s",
3717 backing_name, strerror(-old_backing_size));
3718 ret = -1;
3719 goto out;
3720 }
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003721 }
Max Reitzf1d3cd72015-02-05 13:58:18 -05003722 if (blk_new_backing) {
Eric Blake41536282017-10-11 22:47:15 -05003723 new_backing_size = blk_getlength(blk_new_backing);
3724 if (new_backing_size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003725 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003726 out_baseimg, strerror(-new_backing_size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003727 ret = -1;
3728 goto out;
3729 }
Alex Bligha6166732012-10-16 13:46:18 +01003730 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003731
Eric Blake41536282017-10-11 22:47:15 -05003732 if (size != 0) {
3733 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
Kevin Wolf1f710492012-10-12 14:29:18 +02003734 }
3735
Eric Blake41536282017-10-11 22:47:15 -05003736 for (offset = 0; offset < size; offset += n) {
Max Reitz1c6e8772019-05-09 19:52:36 +02003737 bool buf_old_is_zero = false;
3738
Eric Blake41536282017-10-11 22:47:15 -05003739 /* How many bytes can we handle with the next read? */
3740 n = MIN(IO_BUF_SIZE, size - offset);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003741
3742 /* If the cluster is allocated, we don't need to take action */
Max Reitz4a2061e2019-06-12 19:00:30 +02003743 ret = bdrv_is_allocated(unfiltered_bs, offset, n, &n);
Paolo Bonzinid6636402013-09-04 19:00:25 +02003744 if (ret < 0) {
3745 error_report("error while reading image metadata: %s",
3746 strerror(-ret));
3747 goto out;
3748 }
Kevin Wolfcc60e322010-04-29 14:47:48 +02003749 if (ret) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003750 continue;
3751 }
3752
Sam Eiderman863cc782019-05-23 19:33:36 +03003753 if (prefix_chain_bs) {
3754 /*
3755 * If cluster wasn't changed since prefix_chain, we don't need
3756 * to take action
3757 */
Max Reitz4a2061e2019-06-12 19:00:30 +02003758 ret = bdrv_is_allocated_above(bdrv_cow_bs(unfiltered_bs),
3759 prefix_chain_bs, false,
3760 offset, n, &n);
Sam Eiderman863cc782019-05-23 19:33:36 +03003761 if (ret < 0) {
3762 error_report("error while reading image metadata: %s",
3763 strerror(-ret));
3764 goto out;
3765 }
3766 if (!ret) {
3767 continue;
3768 }
3769 }
3770
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003771 /*
3772 * Read old and new backing file and take into consideration that
3773 * backing files may be smaller than the COW image.
3774 */
Eric Blake41536282017-10-11 22:47:15 -05003775 if (offset >= old_backing_size) {
3776 memset(buf_old, 0, n);
Max Reitz1c6e8772019-05-09 19:52:36 +02003777 buf_old_is_zero = true;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003778 } else {
Eric Blake41536282017-10-11 22:47:15 -05003779 if (offset + n > old_backing_size) {
3780 n = old_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003781 }
3782
Eric Blake41536282017-10-11 22:47:15 -05003783 ret = blk_pread(blk_old_backing, offset, buf_old, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003784 if (ret < 0) {
3785 error_report("error while reading from old backing file");
3786 goto out;
3787 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003788 }
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003789
Eric Blake41536282017-10-11 22:47:15 -05003790 if (offset >= new_backing_size || !blk_new_backing) {
3791 memset(buf_new, 0, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003792 } else {
Eric Blake41536282017-10-11 22:47:15 -05003793 if (offset + n > new_backing_size) {
3794 n = new_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003795 }
3796
Eric Blake41536282017-10-11 22:47:15 -05003797 ret = blk_pread(blk_new_backing, offset, buf_new, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003798 if (ret < 0) {
3799 error_report("error while reading from new backing file");
3800 goto out;
3801 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003802 }
3803
3804 /* If they differ, we need to write to the COW file */
3805 uint64_t written = 0;
3806
Eric Blake41536282017-10-11 22:47:15 -05003807 while (written < n) {
Eric Blakedc61cd32017-10-11 22:47:14 -05003808 int64_t pnum;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003809
Eric Blake41536282017-10-11 22:47:15 -05003810 if (compare_buffers(buf_old + written, buf_new + written,
3811 n - written, &pnum))
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003812 {
Max Reitz1c6e8772019-05-09 19:52:36 +02003813 if (buf_old_is_zero) {
3814 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0);
3815 } else {
3816 ret = blk_pwrite(blk, offset + written,
3817 buf_old + written, pnum, 0);
3818 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003819 if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003820 error_report("Error while writing to COW image: %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003821 strerror(-ret));
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003822 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003823 }
3824 }
3825
3826 written += pnum;
3827 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003828 qemu_progress_print(local_progress, 100);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003829 }
3830 }
3831
3832 /*
3833 * Change the backing file. All clusters that are different from the old
3834 * backing file are overwritten in the COW file now, so the visible content
3835 * doesn't change when we switch the backing file.
3836 */
Alex Bligha6166732012-10-16 13:46:18 +01003837 if (out_baseimg && *out_baseimg) {
Max Reitz4a2061e2019-06-12 19:00:30 +02003838 ret = bdrv_change_backing_file(unfiltered_bs, out_baseimg, out_basefmt,
3839 true);
Alex Bligha6166732012-10-16 13:46:18 +01003840 } else {
Max Reitz4a2061e2019-06-12 19:00:30 +02003841 ret = bdrv_change_backing_file(unfiltered_bs, NULL, NULL, false);
Alex Bligha6166732012-10-16 13:46:18 +01003842 }
3843
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003844 if (ret == -ENOSPC) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003845 error_report("Could not change the backing file to '%s': No "
3846 "space left in the file header", out_baseimg);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003847 } else if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003848 error_report("Could not change the backing file to '%s': %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003849 out_baseimg, strerror(-ret));
3850 }
3851
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003852 qemu_progress_print(100, 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003853 /*
3854 * TODO At this point it is possible to check if any clusters that are
3855 * allocated in the COW file are the same in the backing file. If so, they
3856 * could be dropped from the COW file. Don't do this before switching the
3857 * backing file, in case of a crash this would lead to corruption.
3858 */
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003859out:
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003860 qemu_progress_end();
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003861 /* Cleanup */
3862 if (!unsafe) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02003863 blk_unref(blk_old_backing);
Markus Armbruster26f54e92014-10-07 13:59:04 +02003864 blk_unref(blk_new_backing);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003865 }
Paolo Bonzini396374c2016-02-25 23:53:54 +01003866 qemu_vfree(buf_old);
3867 qemu_vfree(buf_new);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003868
Markus Armbruster26f54e92014-10-07 13:59:04 +02003869 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003870 if (ret) {
3871 return 1;
3872 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003873 return 0;
3874}
3875
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003876static int img_resize(int argc, char **argv)
3877{
Markus Armbruster6750e792015-02-12 17:43:08 +01003878 Error *err = NULL;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003879 int c, ret, relative;
3880 const char *filename, *fmt, *size;
Max Reitz09c5c6d2019-09-18 11:51:44 +02003881 int64_t n, total_size, current_size;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003882 bool quiet = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003883 BlockBackend *blk = NULL;
Max Reitzdc5f6902017-06-13 22:20:55 +02003884 PreallocMode prealloc = PREALLOC_MODE_OFF;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003885 QemuOpts *param;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003886
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003887 static QemuOptsList resize_options = {
3888 .name = "resize_options",
3889 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3890 .desc = {
3891 {
3892 .name = BLOCK_OPT_SIZE,
3893 .type = QEMU_OPT_SIZE,
3894 .help = "Virtual disk size"
3895 }, {
3896 /* end of list */
3897 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003898 },
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003899 };
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003900 bool image_opts = false;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003901 bool shrink = false;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003902
Kevin Wolfe80fec72011-04-29 10:58:12 +02003903 /* Remove size from argv manually so that negative numbers are not treated
3904 * as options by getopt. */
3905 if (argc < 3) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003906 error_exit("Not enough arguments");
Kevin Wolfe80fec72011-04-29 10:58:12 +02003907 return 1;
3908 }
3909
3910 size = argv[--argc];
3911
3912 /* Parse getopt arguments */
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003913 fmt = NULL;
3914 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003915 static const struct option long_options[] = {
3916 {"help", no_argument, 0, 'h'},
3917 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003918 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Max Reitzdc5f6902017-06-13 22:20:55 +02003919 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003920 {"shrink", no_argument, 0, OPTION_SHRINK},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003921 {0, 0, 0, 0}
3922 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003923 c = getopt_long(argc, argv, ":f:hq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003924 long_options, NULL);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003925 if (c == -1) {
3926 break;
3927 }
3928 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003929 case ':':
3930 missing_argument(argv[optind - 1]);
3931 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003932 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003933 unrecognized_option(argv[optind - 1]);
3934 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003935 case 'h':
3936 help();
3937 break;
3938 case 'f':
3939 fmt = optarg;
3940 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003941 case 'q':
3942 quiet = true;
3943 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003944 case OPTION_OBJECT: {
3945 QemuOpts *opts;
3946 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3947 optarg, true);
3948 if (!opts) {
3949 return 1;
3950 }
3951 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003952 case OPTION_IMAGE_OPTS:
3953 image_opts = true;
3954 break;
Max Reitzdc5f6902017-06-13 22:20:55 +02003955 case OPTION_PREALLOCATION:
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02003956 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
Markus Armbruster06c60b62017-08-24 10:45:57 +02003957 PREALLOC_MODE__MAX, NULL);
Max Reitzdc5f6902017-06-13 22:20:55 +02003958 if (prealloc == PREALLOC_MODE__MAX) {
3959 error_report("Invalid preallocation mode '%s'", optarg);
3960 return 1;
3961 }
3962 break;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003963 case OPTION_SHRINK:
3964 shrink = true;
3965 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003966 }
3967 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02003968 if (optind != argc - 1) {
Max Reitzbe8fbd42018-02-05 17:27:45 +01003969 error_exit("Expecting image file name and size");
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003970 }
3971 filename = argv[optind++];
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003972
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003973 if (qemu_opts_foreach(&qemu_object_opts,
3974 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02003975 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003976 return 1;
3977 }
3978
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003979 /* Choose grow, shrink, or absolute resize mode */
3980 switch (size[0]) {
3981 case '+':
3982 relative = 1;
3983 size++;
3984 break;
3985 case '-':
3986 relative = -1;
3987 size++;
3988 break;
3989 default:
3990 relative = 0;
3991 break;
3992 }
3993
3994 /* Parse size */
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -08003995 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
Markus Armbruster235e59c2020-07-07 18:05:42 +02003996 if (!qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err)) {
Markus Armbruster6750e792015-02-12 17:43:08 +01003997 error_report_err(err);
Jes Sorensen2a819982010-12-06 17:08:31 +01003998 ret = -1;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003999 qemu_opts_del(param);
Jes Sorensen2a819982010-12-06 17:08:31 +01004000 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004001 }
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08004002 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
4003 qemu_opts_del(param);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004004
Max Reitzefaa7c42016-03-16 19:54:38 +01004005 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08004006 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
4007 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004008 if (!blk) {
Jes Sorensen2a819982010-12-06 17:08:31 +01004009 ret = -1;
4010 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004011 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004012
Max Reitzdc5f6902017-06-13 22:20:55 +02004013 current_size = blk_getlength(blk);
4014 if (current_size < 0) {
4015 error_report("Failed to inquire current image length: %s",
4016 strerror(-current_size));
4017 ret = -1;
4018 goto out;
4019 }
4020
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004021 if (relative) {
Max Reitzdc5f6902017-06-13 22:20:55 +02004022 total_size = current_size + n * relative;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004023 } else {
4024 total_size = n;
4025 }
4026 if (total_size <= 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01004027 error_report("New image size must be positive");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004028 ret = -1;
4029 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004030 }
4031
Max Reitzdc5f6902017-06-13 22:20:55 +02004032 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
4033 error_report("Preallocation can only be used for growing images");
4034 ret = -1;
4035 goto out;
4036 }
4037
Pavel Butsykin4ffca892017-09-18 15:42:27 +03004038 if (total_size < current_size && !shrink) {
Kevin Wolf1c404d72020-07-10 14:17:17 +02004039 error_report("Use the --shrink option to perform a shrink operation.");
Pavel Butsykin4ffca892017-09-18 15:42:27 +03004040 warn_report("Shrinking an image will delete all data beyond the "
4041 "shrunken image's end. Before performing such an "
4042 "operation, make sure there is no important data there.");
Kevin Wolf1c404d72020-07-10 14:17:17 +02004043 ret = -1;
4044 goto out;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03004045 }
4046
Max Reitze8d04f92019-09-18 11:51:43 +02004047 /*
4048 * The user expects the image to have the desired size after
4049 * resizing, so pass @exact=true. It is of no use to report
4050 * success when the image has not actually been resized.
4051 */
Kevin Wolf8c6242b2020-04-24 14:54:41 +02004052 ret = blk_truncate(blk, total_size, true, prealloc, 0, &err);
Max Reitz09c5c6d2019-09-18 11:51:44 +02004053 if (!ret) {
4054 qprintf(quiet, "Image resized.\n");
4055 } else {
Max Reitzed3d2ec2017-03-28 22:51:27 +02004056 error_report_err(err);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004057 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004058out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02004059 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09004060 if (ret) {
4061 return 1;
4062 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01004063 return 0;
4064}
4065
Max Reitz76a3a342014-10-27 11:12:51 +01004066static void amend_status_cb(BlockDriverState *bs,
Max Reitz8b139762015-07-27 17:51:32 +02004067 int64_t offset, int64_t total_work_size,
4068 void *opaque)
Max Reitz76a3a342014-10-27 11:12:51 +01004069{
4070 qemu_progress_print(100.f * offset / total_work_size, 0);
4071}
4072
Max Reitz51641352018-05-09 23:00:20 +02004073static int print_amend_option_help(const char *format)
4074{
4075 BlockDriver *drv;
4076
4077 /* Find driver and parse its options */
4078 drv = bdrv_find_format(format);
4079 if (!drv) {
4080 error_report("Unknown file format '%s'", format);
4081 return 1;
4082 }
4083
4084 if (!drv->bdrv_amend_options) {
4085 error_report("Format driver '%s' does not support option amendment",
4086 format);
4087 return 1;
4088 }
4089
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004090 /* Every driver supporting amendment must have amend_opts */
4091 assert(drv->amend_opts);
Max Reitz51641352018-05-09 23:00:20 +02004092
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004093 printf("Amend options for '%s':\n", format);
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004094 qemu_opts_print_help(drv->amend_opts, false);
Max Reitz51641352018-05-09 23:00:20 +02004095 return 0;
4096}
4097
Max Reitz6f176b42013-09-03 10:09:50 +02004098static int img_amend(int argc, char **argv)
4099{
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01004100 Error *err = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02004101 int c, ret = 0;
4102 char *options = NULL;
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004103 QemuOptsList *amend_opts = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08004104 QemuOpts *opts = NULL;
Max Reitzbd39e6e2014-07-22 22:58:43 +02004105 const char *fmt = NULL, *filename, *cache;
4106 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01004107 bool writethrough;
Max Reitz76a3a342014-10-27 11:12:51 +01004108 bool quiet = false, progress = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02004109 BlockBackend *blk = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02004110 BlockDriverState *bs = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004111 bool image_opts = false;
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004112 bool force = false;
Max Reitz6f176b42013-09-03 10:09:50 +02004113
Max Reitzbd39e6e2014-07-22 22:58:43 +02004114 cache = BDRV_DEFAULT_CACHE;
Max Reitz6f176b42013-09-03 10:09:50 +02004115 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004116 static const struct option long_options[] = {
4117 {"help", no_argument, 0, 'h'},
4118 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004119 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004120 {"force", no_argument, 0, OPTION_FORCE},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004121 {0, 0, 0, 0}
4122 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004123 c = getopt_long(argc, argv, ":ho:f:t:pq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004124 long_options, NULL);
Max Reitz6f176b42013-09-03 10:09:50 +02004125 if (c == -1) {
4126 break;
4127 }
4128
4129 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004130 case ':':
4131 missing_argument(argv[optind - 1]);
4132 break;
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004133 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004134 unrecognized_option(argv[optind - 1]);
4135 break;
4136 case 'h':
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004137 help();
4138 break;
4139 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02004140 if (accumulate_options(&options, optarg) < 0) {
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004141 ret = -1;
4142 goto out_no_progress;
4143 }
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004144 break;
4145 case 'f':
4146 fmt = optarg;
4147 break;
4148 case 't':
4149 cache = optarg;
4150 break;
4151 case 'p':
4152 progress = true;
4153 break;
4154 case 'q':
4155 quiet = true;
4156 break;
4157 case OPTION_OBJECT:
4158 opts = qemu_opts_parse_noisily(&qemu_object_opts,
4159 optarg, true);
4160 if (!opts) {
4161 ret = -1;
4162 goto out_no_progress;
4163 }
4164 break;
4165 case OPTION_IMAGE_OPTS:
4166 image_opts = true;
4167 break;
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004168 case OPTION_FORCE:
4169 force = true;
4170 break;
Max Reitz6f176b42013-09-03 10:09:50 +02004171 }
4172 }
4173
Max Reitz6f176b42013-09-03 10:09:50 +02004174 if (!options) {
Fam Zhengac1307a2014-04-22 13:36:11 +08004175 error_exit("Must specify options (-o)");
Max Reitz6f176b42013-09-03 10:09:50 +02004176 }
4177
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004178 if (qemu_opts_foreach(&qemu_object_opts,
4179 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02004180 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004181 ret = -1;
4182 goto out_no_progress;
4183 }
4184
Max Reitz76a3a342014-10-27 11:12:51 +01004185 if (quiet) {
4186 progress = false;
4187 }
4188 qemu_progress_init(progress, 1.0);
4189
Kevin Wolfa283cb62014-02-21 16:24:07 +01004190 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
4191 if (fmt && has_help_option(options)) {
4192 /* If a format is explicitly specified (and possibly no filename is
4193 * given), print option help here */
Max Reitz51641352018-05-09 23:00:20 +02004194 ret = print_amend_option_help(fmt);
Kevin Wolfa283cb62014-02-21 16:24:07 +01004195 goto out;
4196 }
4197
4198 if (optind != argc - 1) {
Max Reitzb2f27e42014-10-27 11:12:52 +01004199 error_report("Expecting one image file name");
4200 ret = -1;
4201 goto out;
Kevin Wolfa283cb62014-02-21 16:24:07 +01004202 }
Max Reitz6f176b42013-09-03 10:09:50 +02004203
Kevin Wolfce099542016-03-15 13:01:04 +01004204 flags = BDRV_O_RDWR;
4205 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitzbd39e6e2014-07-22 22:58:43 +02004206 if (ret < 0) {
4207 error_report("Invalid cache option: %s", cache);
4208 goto out;
4209 }
4210
Fam Zheng335e9932017-05-03 00:35:39 +08004211 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4212 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004213 if (!blk) {
Max Reitz6f176b42013-09-03 10:09:50 +02004214 ret = -1;
4215 goto out;
4216 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004217 bs = blk_bs(blk);
Max Reitz6f176b42013-09-03 10:09:50 +02004218
4219 fmt = bs->drv->format_name;
4220
Kevin Wolf626f84f2014-02-21 16:24:06 +01004221 if (has_help_option(options)) {
Kevin Wolfa283cb62014-02-21 16:24:07 +01004222 /* If the format was auto-detected, print option help here */
Max Reitz51641352018-05-09 23:00:20 +02004223 ret = print_amend_option_help(fmt);
Max Reitz6f176b42013-09-03 10:09:50 +02004224 goto out;
4225 }
4226
Max Reitz1f996682018-05-09 23:00:17 +02004227 if (!bs->drv->bdrv_amend_options) {
4228 error_report("Format driver '%s' does not support option amendment",
Max Reitzb2439d22014-12-02 18:32:47 +01004229 fmt);
4230 ret = -1;
4231 goto out;
4232 }
4233
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004234 /* Every driver supporting amendment must have amend_opts */
4235 assert(bs->drv->amend_opts);
Max Reitz1f996682018-05-09 23:00:17 +02004236
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004237 amend_opts = qemu_opts_append(amend_opts, bs->drv->amend_opts);
4238 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
Markus Armbruster235e59c2020-07-07 18:05:42 +02004239 if (!qemu_opts_do_parse(opts, options, NULL, &err)) {
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004240 /* Try to parse options using the create options */
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004241 amend_opts = qemu_opts_append(amend_opts, bs->drv->create_opts);
4242 qemu_opts_del(opts);
4243 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
Markus Armbruster9e194e02020-07-07 18:06:11 +02004244 if (qemu_opts_do_parse(opts, options, NULL, NULL)) {
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004245 error_append_hint(&err,
4246 "This option is only supported for image creation\n");
Maxim Levitsky0b6786a2020-06-25 14:55:40 +02004247 }
4248
Paolo Bonziniece90862017-01-04 15:56:24 +01004249 error_report_err(err);
4250 ret = -1;
4251 goto out;
Max Reitz6f176b42013-09-03 10:09:50 +02004252 }
4253
Max Reitz76a3a342014-10-27 11:12:51 +01004254 /* In case the driver does not call amend_status_cb() */
4255 qemu_progress_print(0.f, 0);
Maxim Levitskya3579bf2020-06-25 14:55:38 +02004256 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, force, &err);
Max Reitz76a3a342014-10-27 11:12:51 +01004257 qemu_progress_print(100.f, 0);
Max Reitz6f176b42013-09-03 10:09:50 +02004258 if (ret < 0) {
Max Reitzd1402b52018-05-09 23:00:18 +02004259 error_report_err(err);
Max Reitz6f176b42013-09-03 10:09:50 +02004260 goto out;
4261 }
4262
4263out:
Max Reitz76a3a342014-10-27 11:12:51 +01004264 qemu_progress_end();
4265
Max Reitze814dff2015-08-20 16:00:38 -07004266out_no_progress:
Markus Armbruster26f54e92014-10-07 13:59:04 +02004267 blk_unref(blk);
Chunyan Liu83d05212014-06-05 17:20:51 +08004268 qemu_opts_del(opts);
Maxim Levitskydf373fb2020-06-25 14:55:39 +02004269 qemu_opts_free(amend_opts);
Kevin Wolf626f84f2014-02-21 16:24:06 +01004270 g_free(options);
4271
Max Reitz6f176b42013-09-03 10:09:50 +02004272 if (ret) {
4273 return 1;
4274 }
4275 return 0;
4276}
4277
Kevin Wolfb6133b82014-08-05 14:17:13 +02004278typedef struct BenchData {
4279 BlockBackend *blk;
4280 uint64_t image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004281 bool write;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004282 int bufsize;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004283 int step;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004284 int nrreq;
4285 int n;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004286 int flush_interval;
4287 bool drain_on_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004288 uint8_t *buf;
4289 QEMUIOVector *qiov;
4290
4291 int in_flight;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004292 bool in_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004293 uint64_t offset;
4294} BenchData;
4295
Kevin Wolf55d539c2016-06-03 13:59:41 +02004296static void bench_undrained_flush_cb(void *opaque, int ret)
4297{
4298 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004299 error_report("Failed flush request: %s", strerror(-ret));
Kevin Wolf55d539c2016-06-03 13:59:41 +02004300 exit(EXIT_FAILURE);
4301 }
4302}
4303
Kevin Wolfb6133b82014-08-05 14:17:13 +02004304static void bench_cb(void *opaque, int ret)
4305{
4306 BenchData *b = opaque;
4307 BlockAIOCB *acb;
4308
4309 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004310 error_report("Failed request: %s", strerror(-ret));
Kevin Wolfb6133b82014-08-05 14:17:13 +02004311 exit(EXIT_FAILURE);
4312 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004313
4314 if (b->in_flush) {
4315 /* Just finished a flush with drained queue: Start next requests */
4316 assert(b->in_flight == 0);
4317 b->in_flush = false;
4318 } else if (b->in_flight > 0) {
4319 int remaining = b->n - b->in_flight;
4320
Kevin Wolfb6133b82014-08-05 14:17:13 +02004321 b->n--;
4322 b->in_flight--;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004323
4324 /* Time for flush? Drain queue if requested, then flush */
4325 if (b->flush_interval && remaining % b->flush_interval == 0) {
4326 if (!b->in_flight || !b->drain_on_flush) {
4327 BlockCompletionFunc *cb;
4328
4329 if (b->drain_on_flush) {
4330 b->in_flush = true;
4331 cb = bench_cb;
4332 } else {
4333 cb = bench_undrained_flush_cb;
4334 }
4335
4336 acb = blk_aio_flush(b->blk, cb, b);
4337 if (!acb) {
4338 error_report("Failed to issue flush request");
4339 exit(EXIT_FAILURE);
4340 }
4341 }
4342 if (b->drain_on_flush) {
4343 return;
4344 }
4345 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004346 }
4347
4348 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004349 int64_t offset = b->offset;
4350 /* blk_aio_* might look for completed I/Os and kick bench_cb
4351 * again, so make sure this operation is counted by in_flight
4352 * and b->offset is ready for the next submission.
4353 */
4354 b->in_flight++;
4355 b->offset += b->step;
4356 b->offset %= b->image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004357 if (b->write) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004358 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004359 } else {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004360 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004361 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004362 if (!acb) {
4363 error_report("Failed to issue request");
4364 exit(EXIT_FAILURE);
4365 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004366 }
4367}
4368
4369static int img_bench(int argc, char **argv)
4370{
4371 int c, ret = 0;
4372 const char *fmt = NULL, *filename;
4373 bool quiet = false;
4374 bool image_opts = false;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004375 bool is_write = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004376 int count = 75000;
4377 int depth = 64;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004378 int64_t offset = 0;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004379 size_t bufsize = 4096;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004380 int pattern = 0;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004381 size_t step = 0;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004382 int flush_interval = 0;
4383 bool drain_on_flush = true;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004384 int64_t image_size;
4385 BlockBackend *blk = NULL;
4386 BenchData data = {};
4387 int flags = 0;
Kevin Wolf604e8612016-06-14 11:29:32 +02004388 bool writethrough = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004389 struct timeval t1, t2;
4390 int i;
Fam Zheng335e9932017-05-03 00:35:39 +08004391 bool force_share = false;
Fam Zheng79d46582018-01-16 14:08:58 +08004392 size_t buf_size;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004393
4394 for (;;) {
4395 static const struct option long_options[] = {
4396 {"help", no_argument, 0, 'h'},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004397 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004398 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004399 {"pattern", required_argument, 0, OPTION_PATTERN},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004400 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
Fam Zheng335e9932017-05-03 00:35:39 +08004401 {"force-share", no_argument, 0, 'U'},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004402 {0, 0, 0, 0}
4403 };
Aarushi Mehtacdd26772020-01-20 14:18:55 +00004404 c = getopt_long(argc, argv, ":hc:d:f:ni:o:qs:S:t:wU", long_options,
4405 NULL);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004406 if (c == -1) {
4407 break;
4408 }
4409
4410 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004411 case ':':
4412 missing_argument(argv[optind - 1]);
4413 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004414 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004415 unrecognized_option(argv[optind - 1]);
4416 break;
4417 case 'h':
Kevin Wolfb6133b82014-08-05 14:17:13 +02004418 help();
4419 break;
4420 case 'c':
4421 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004422 unsigned long res;
4423
4424 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004425 error_report("Invalid request count specified");
4426 return 1;
4427 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004428 count = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004429 break;
4430 }
4431 case 'd':
4432 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004433 unsigned long res;
4434
4435 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004436 error_report("Invalid queue depth specified");
4437 return 1;
4438 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004439 depth = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004440 break;
4441 }
4442 case 'f':
4443 fmt = optarg;
4444 break;
4445 case 'n':
4446 flags |= BDRV_O_NATIVE_AIO;
4447 break;
Aarushi Mehtacdd26772020-01-20 14:18:55 +00004448 case 'i':
4449 ret = bdrv_parse_aio(optarg, &flags);
4450 if (ret < 0) {
4451 error_report("Invalid aio option: %s", optarg);
4452 ret = -1;
4453 goto out;
4454 }
4455 break;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004456 case 'o':
4457 {
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004458 offset = cvtnum("offset", optarg);
Markus Armbruster606caa02017-02-21 21:14:04 +01004459 if (offset < 0) {
Kevin Wolfd3199a32015-07-10 18:09:18 +02004460 return 1;
4461 }
4462 break;
4463 }
4464 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004465 case 'q':
4466 quiet = true;
4467 break;
4468 case 's':
4469 {
4470 int64_t sval;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004471
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004472 sval = cvtnum_full("buffer size", optarg, 0, INT_MAX);
4473 if (sval < 0) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004474 return 1;
4475 }
4476
4477 bufsize = sval;
4478 break;
4479 }
Kevin Wolf83de9be2015-07-13 13:13:17 +02004480 case 'S':
4481 {
4482 int64_t sval;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004483
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004484 sval = cvtnum_full("step_size", optarg, 0, INT_MAX);
4485 if (sval < 0) {
Kevin Wolf83de9be2015-07-13 13:13:17 +02004486 return 1;
4487 }
4488
4489 step = sval;
4490 break;
4491 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004492 case 't':
4493 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4494 if (ret < 0) {
4495 error_report("Invalid cache mode");
4496 ret = -1;
4497 goto out;
4498 }
4499 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004500 case 'w':
4501 flags |= BDRV_O_RDWR;
4502 is_write = true;
4503 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004504 case 'U':
4505 force_share = true;
4506 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004507 case OPTION_PATTERN:
4508 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004509 unsigned long res;
4510
4511 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004512 error_report("Invalid pattern byte specified");
4513 return 1;
4514 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004515 pattern = res;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004516 break;
4517 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004518 case OPTION_FLUSH_INTERVAL:
4519 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004520 unsigned long res;
4521
4522 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004523 error_report("Invalid flush interval specified");
4524 return 1;
4525 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004526 flush_interval = res;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004527 break;
4528 }
4529 case OPTION_NO_DRAIN:
4530 drain_on_flush = false;
4531 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004532 case OPTION_IMAGE_OPTS:
4533 image_opts = true;
4534 break;
4535 }
4536 }
4537
4538 if (optind != argc - 1) {
4539 error_exit("Expecting one image file name");
4540 }
4541 filename = argv[argc - 1];
4542
Kevin Wolf55d539c2016-06-03 13:59:41 +02004543 if (!is_write && flush_interval) {
4544 error_report("--flush-interval is only available in write tests");
4545 ret = -1;
4546 goto out;
4547 }
4548 if (flush_interval && flush_interval < depth) {
4549 error_report("Flush interval can't be smaller than depth");
4550 ret = -1;
4551 goto out;
4552 }
4553
Fam Zheng335e9932017-05-03 00:35:39 +08004554 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4555 force_share);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004556 if (!blk) {
4557 ret = -1;
4558 goto out;
4559 }
4560
4561 image_size = blk_getlength(blk);
4562 if (image_size < 0) {
4563 ret = image_size;
4564 goto out;
4565 }
4566
4567 data = (BenchData) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004568 .blk = blk,
4569 .image_size = image_size,
4570 .bufsize = bufsize,
4571 .step = step ?: bufsize,
4572 .nrreq = depth,
4573 .n = count,
4574 .offset = offset,
4575 .write = is_write,
4576 .flush_interval = flush_interval,
4577 .drain_on_flush = drain_on_flush,
Kevin Wolfb6133b82014-08-05 14:17:13 +02004578 };
Kevin Wolfd3199a32015-07-10 18:09:18 +02004579 printf("Sending %d %s requests, %d bytes each, %d in parallel "
Kevin Wolf83de9be2015-07-13 13:13:17 +02004580 "(starting at offset %" PRId64 ", step size %d)\n",
Kevin Wolfd3199a32015-07-10 18:09:18 +02004581 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
Kevin Wolf83de9be2015-07-13 13:13:17 +02004582 data.offset, data.step);
Kevin Wolf55d539c2016-06-03 13:59:41 +02004583 if (flush_interval) {
4584 printf("Sending flush every %d requests\n", flush_interval);
4585 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004586
Fam Zheng79d46582018-01-16 14:08:58 +08004587 buf_size = data.nrreq * data.bufsize;
4588 data.buf = blk_blockalign(blk, buf_size);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004589 memset(data.buf, pattern, data.nrreq * data.bufsize);
4590
Fam Zheng79d46582018-01-16 14:08:58 +08004591 blk_register_buf(blk, data.buf, buf_size);
4592
Kevin Wolfb6133b82014-08-05 14:17:13 +02004593 data.qiov = g_new(QEMUIOVector, data.nrreq);
4594 for (i = 0; i < data.nrreq; i++) {
4595 qemu_iovec_init(&data.qiov[i], 1);
4596 qemu_iovec_add(&data.qiov[i],
4597 data.buf + i * data.bufsize, data.bufsize);
4598 }
4599
4600 gettimeofday(&t1, NULL);
4601 bench_cb(&data, 0);
4602
4603 while (data.n > 0) {
4604 main_loop_wait(false);
4605 }
4606 gettimeofday(&t2, NULL);
4607
4608 printf("Run completed in %3.3f seconds.\n",
4609 (t2.tv_sec - t1.tv_sec)
4610 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4611
4612out:
Fam Zheng79d46582018-01-16 14:08:58 +08004613 if (data.buf) {
4614 blk_unregister_buf(blk, data.buf);
4615 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004616 qemu_vfree(data.buf);
4617 blk_unref(blk);
4618
4619 if (ret) {
4620 return 1;
4621 }
4622 return 0;
4623}
4624
Eric Blake3b51ab42020-05-12 20:16:45 -05004625enum ImgBitmapAct {
4626 BITMAP_ADD,
4627 BITMAP_REMOVE,
4628 BITMAP_CLEAR,
4629 BITMAP_ENABLE,
4630 BITMAP_DISABLE,
4631 BITMAP_MERGE,
4632};
4633typedef struct ImgBitmapAction {
4634 enum ImgBitmapAct act;
4635 const char *src; /* only used for merge */
4636 QSIMPLEQ_ENTRY(ImgBitmapAction) next;
4637} ImgBitmapAction;
4638
4639static int img_bitmap(int argc, char **argv)
4640{
4641 Error *err = NULL;
4642 int c, ret = 1;
4643 QemuOpts *opts = NULL;
4644 const char *fmt = NULL, *src_fmt = NULL, *src_filename = NULL;
4645 const char *filename, *bitmap;
4646 BlockBackend *blk = NULL, *src = NULL;
4647 BlockDriverState *bs = NULL, *src_bs = NULL;
4648 bool image_opts = false;
4649 int64_t granularity = 0;
4650 bool add = false, merge = false;
4651 QSIMPLEQ_HEAD(, ImgBitmapAction) actions;
4652 ImgBitmapAction *act, *act_next;
4653 const char *op;
4654
4655 QSIMPLEQ_INIT(&actions);
4656
4657 for (;;) {
4658 static const struct option long_options[] = {
4659 {"help", no_argument, 0, 'h'},
4660 {"object", required_argument, 0, OPTION_OBJECT},
4661 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4662 {"add", no_argument, 0, OPTION_ADD},
4663 {"remove", no_argument, 0, OPTION_REMOVE},
4664 {"clear", no_argument, 0, OPTION_CLEAR},
4665 {"enable", no_argument, 0, OPTION_ENABLE},
4666 {"disable", no_argument, 0, OPTION_DISABLE},
4667 {"merge", required_argument, 0, OPTION_MERGE},
4668 {"granularity", required_argument, 0, 'g'},
4669 {"source-file", required_argument, 0, 'b'},
4670 {"source-format", required_argument, 0, 'F'},
4671 {0, 0, 0, 0}
4672 };
4673 c = getopt_long(argc, argv, ":b:f:F:g:h", long_options, NULL);
4674 if (c == -1) {
4675 break;
4676 }
4677
4678 switch (c) {
4679 case ':':
4680 missing_argument(argv[optind - 1]);
4681 break;
4682 case '?':
4683 unrecognized_option(argv[optind - 1]);
4684 break;
4685 case 'h':
4686 help();
4687 break;
4688 case 'b':
4689 src_filename = optarg;
4690 break;
4691 case 'f':
4692 fmt = optarg;
4693 break;
4694 case 'F':
4695 src_fmt = optarg;
4696 break;
4697 case 'g':
4698 granularity = cvtnum("granularity", optarg);
4699 if (granularity < 0) {
4700 return 1;
4701 }
4702 break;
4703 case OPTION_ADD:
4704 act = g_new0(ImgBitmapAction, 1);
4705 act->act = BITMAP_ADD;
4706 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4707 add = true;
4708 break;
4709 case OPTION_REMOVE:
4710 act = g_new0(ImgBitmapAction, 1);
4711 act->act = BITMAP_REMOVE;
4712 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4713 break;
4714 case OPTION_CLEAR:
4715 act = g_new0(ImgBitmapAction, 1);
4716 act->act = BITMAP_CLEAR;
4717 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4718 break;
4719 case OPTION_ENABLE:
4720 act = g_new0(ImgBitmapAction, 1);
4721 act->act = BITMAP_ENABLE;
4722 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4723 break;
4724 case OPTION_DISABLE:
4725 act = g_new0(ImgBitmapAction, 1);
4726 act->act = BITMAP_DISABLE;
4727 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4728 break;
4729 case OPTION_MERGE:
4730 act = g_new0(ImgBitmapAction, 1);
4731 act->act = BITMAP_MERGE;
4732 act->src = optarg;
4733 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4734 merge = true;
4735 break;
4736 case OPTION_OBJECT:
4737 opts = qemu_opts_parse_noisily(&qemu_object_opts, optarg, true);
4738 if (!opts) {
4739 goto out;
4740 }
4741 break;
4742 case OPTION_IMAGE_OPTS:
4743 image_opts = true;
4744 break;
4745 }
4746 }
4747
4748 if (qemu_opts_foreach(&qemu_object_opts,
4749 user_creatable_add_opts_foreach,
4750 qemu_img_object_print_help, &error_fatal)) {
4751 goto out;
4752 }
4753
4754 if (QSIMPLEQ_EMPTY(&actions)) {
4755 error_report("Need at least one of --add, --remove, --clear, "
4756 "--enable, --disable, or --merge");
4757 goto out;
4758 }
4759
4760 if (granularity && !add) {
4761 error_report("granularity only supported with --add");
4762 goto out;
4763 }
4764 if (src_fmt && !src_filename) {
4765 error_report("-F only supported with -b");
4766 goto out;
4767 }
4768 if (src_filename && !merge) {
4769 error_report("Merge bitmap source file only supported with "
4770 "--merge");
4771 goto out;
4772 }
4773
4774 if (optind != argc - 2) {
4775 error_report("Expecting filename and bitmap name");
4776 goto out;
4777 }
4778
4779 filename = argv[optind];
4780 bitmap = argv[optind + 1];
4781
4782 blk = img_open(image_opts, filename, fmt, BDRV_O_RDWR, false, false,
4783 false);
4784 if (!blk) {
4785 goto out;
4786 }
4787 bs = blk_bs(blk);
4788 if (src_filename) {
4789 src = img_open(false, src_filename, src_fmt, 0, false, false, false);
4790 if (!src) {
4791 goto out;
4792 }
4793 src_bs = blk_bs(src);
4794 } else {
4795 src_bs = bs;
4796 }
4797
4798 QSIMPLEQ_FOREACH_SAFE(act, &actions, next, act_next) {
4799 switch (act->act) {
4800 case BITMAP_ADD:
4801 qmp_block_dirty_bitmap_add(bs->node_name, bitmap,
4802 !!granularity, granularity, true, true,
4803 false, false, &err);
4804 op = "add";
4805 break;
4806 case BITMAP_REMOVE:
4807 qmp_block_dirty_bitmap_remove(bs->node_name, bitmap, &err);
4808 op = "remove";
4809 break;
4810 case BITMAP_CLEAR:
4811 qmp_block_dirty_bitmap_clear(bs->node_name, bitmap, &err);
4812 op = "clear";
4813 break;
4814 case BITMAP_ENABLE:
4815 qmp_block_dirty_bitmap_enable(bs->node_name, bitmap, &err);
4816 op = "enable";
4817 break;
4818 case BITMAP_DISABLE:
4819 qmp_block_dirty_bitmap_disable(bs->node_name, bitmap, &err);
4820 op = "disable";
4821 break;
Eric Blake6c729dd2020-05-21 14:21:35 -05004822 case BITMAP_MERGE:
4823 do_dirty_bitmap_merge(bs->node_name, bitmap, src_bs->node_name,
4824 act->src, &err);
Eric Blake3b51ab42020-05-12 20:16:45 -05004825 op = "merge";
4826 break;
Eric Blake3b51ab42020-05-12 20:16:45 -05004827 default:
4828 g_assert_not_reached();
4829 }
4830
4831 if (err) {
4832 error_reportf_err(err, "Operation %s on bitmap %s failed: ",
4833 op, bitmap);
4834 goto out;
4835 }
4836 g_free(act);
4837 }
4838
4839 ret = 0;
4840
4841 out:
4842 blk_unref(src);
4843 blk_unref(blk);
4844 qemu_opts_del(opts);
4845 return ret;
4846}
4847
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004848#define C_BS 01
4849#define C_COUNT 02
4850#define C_IF 04
4851#define C_OF 010
Reda Sallahif7c15532016-08-10 16:16:09 +02004852#define C_SKIP 020
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004853
4854struct DdInfo {
4855 unsigned int flags;
4856 int64_t count;
4857};
4858
4859struct DdIo {
4860 int bsz; /* Block size */
4861 char *filename;
4862 uint8_t *buf;
Reda Sallahif7c15532016-08-10 16:16:09 +02004863 int64_t offset;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004864};
4865
4866struct DdOpts {
4867 const char *name;
4868 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
4869 unsigned int flag;
4870};
4871
4872static int img_dd_bs(const char *arg,
4873 struct DdIo *in, struct DdIo *out,
4874 struct DdInfo *dd)
4875{
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004876 int64_t res;
4877
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004878 res = cvtnum_full("bs", arg, 1, INT_MAX);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004879
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004880 if (res < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004881 return 1;
4882 }
4883 in->bsz = out->bsz = res;
4884
4885 return 0;
4886}
4887
4888static int img_dd_count(const char *arg,
4889 struct DdIo *in, struct DdIo *out,
4890 struct DdInfo *dd)
4891{
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004892 dd->count = cvtnum("count", arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004893
Markus Armbruster606caa02017-02-21 21:14:04 +01004894 if (dd->count < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004895 return 1;
4896 }
4897
4898 return 0;
4899}
4900
4901static int img_dd_if(const char *arg,
4902 struct DdIo *in, struct DdIo *out,
4903 struct DdInfo *dd)
4904{
4905 in->filename = g_strdup(arg);
4906
4907 return 0;
4908}
4909
4910static int img_dd_of(const char *arg,
4911 struct DdIo *in, struct DdIo *out,
4912 struct DdInfo *dd)
4913{
4914 out->filename = g_strdup(arg);
4915
4916 return 0;
4917}
4918
Reda Sallahif7c15532016-08-10 16:16:09 +02004919static int img_dd_skip(const char *arg,
4920 struct DdIo *in, struct DdIo *out,
4921 struct DdInfo *dd)
4922{
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004923 in->offset = cvtnum("skip", arg);
Reda Sallahif7c15532016-08-10 16:16:09 +02004924
Markus Armbruster606caa02017-02-21 21:14:04 +01004925 if (in->offset < 0) {
Reda Sallahif7c15532016-08-10 16:16:09 +02004926 return 1;
4927 }
4928
4929 return 0;
4930}
4931
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004932static int img_dd(int argc, char **argv)
4933{
4934 int ret = 0;
4935 char *arg = NULL;
4936 char *tmp;
4937 BlockDriver *drv = NULL, *proto_drv = NULL;
4938 BlockBackend *blk1 = NULL, *blk2 = NULL;
4939 QemuOpts *opts = NULL;
4940 QemuOptsList *create_opts = NULL;
4941 Error *local_err = NULL;
4942 bool image_opts = false;
4943 int c, i;
4944 const char *out_fmt = "raw";
4945 const char *fmt = NULL;
4946 int64_t size = 0;
4947 int64_t block_count = 0, out_pos, in_pos;
Fam Zheng335e9932017-05-03 00:35:39 +08004948 bool force_share = false;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004949 struct DdInfo dd = {
4950 .flags = 0,
4951 .count = 0,
4952 };
4953 struct DdIo in = {
4954 .bsz = 512, /* Block size is by default 512 bytes */
4955 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004956 .buf = NULL,
4957 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004958 };
4959 struct DdIo out = {
4960 .bsz = 512,
4961 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004962 .buf = NULL,
4963 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004964 };
4965
4966 const struct DdOpts options[] = {
4967 { "bs", img_dd_bs, C_BS },
4968 { "count", img_dd_count, C_COUNT },
4969 { "if", img_dd_if, C_IF },
4970 { "of", img_dd_of, C_OF },
Reda Sallahif7c15532016-08-10 16:16:09 +02004971 { "skip", img_dd_skip, C_SKIP },
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004972 { NULL, NULL, 0 }
4973 };
4974 const struct option long_options[] = {
4975 { "help", no_argument, 0, 'h'},
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004976 { "object", required_argument, 0, OPTION_OBJECT},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004977 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08004978 { "force-share", no_argument, 0, 'U'},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004979 { 0, 0, 0, 0 }
4980 };
4981
Fam Zheng335e9932017-05-03 00:35:39 +08004982 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004983 if (c == EOF) {
4984 break;
4985 }
4986 switch (c) {
4987 case 'O':
4988 out_fmt = optarg;
4989 break;
4990 case 'f':
4991 fmt = optarg;
4992 break;
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004993 case ':':
4994 missing_argument(argv[optind - 1]);
4995 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004996 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004997 unrecognized_option(argv[optind - 1]);
4998 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004999 case 'h':
5000 help();
5001 break;
Fam Zheng335e9932017-05-03 00:35:39 +08005002 case 'U':
5003 force_share = true;
5004 break;
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01005005 case OPTION_OBJECT:
5006 if (!qemu_opts_parse_noisily(&qemu_object_opts, optarg, true)) {
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01005007 ret = -1;
5008 goto out;
5009 }
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01005010 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005011 case OPTION_IMAGE_OPTS:
5012 image_opts = true;
5013 break;
5014 }
5015 }
5016
5017 for (i = optind; i < argc; i++) {
5018 int j;
5019 arg = g_strdup(argv[i]);
5020
5021 tmp = strchr(arg, '=');
5022 if (tmp == NULL) {
5023 error_report("unrecognized operand %s", arg);
5024 ret = -1;
5025 goto out;
5026 }
5027
5028 *tmp++ = '\0';
5029
5030 for (j = 0; options[j].name != NULL; j++) {
5031 if (!strcmp(arg, options[j].name)) {
5032 break;
5033 }
5034 }
5035 if (options[j].name == NULL) {
5036 error_report("unrecognized operand %s", arg);
5037 ret = -1;
5038 goto out;
5039 }
5040
5041 if (options[j].f(tmp, &in, &out, &dd) != 0) {
5042 ret = -1;
5043 goto out;
5044 }
5045 dd.flags |= options[j].flag;
5046 g_free(arg);
5047 arg = NULL;
5048 }
5049
5050 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
5051 error_report("Must specify both input and output files");
5052 ret = -1;
5053 goto out;
5054 }
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01005055
5056 if (qemu_opts_foreach(&qemu_object_opts,
5057 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02005058 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01005059 ret = -1;
5060 goto out;
5061 }
5062
Fam Zheng335e9932017-05-03 00:35:39 +08005063 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
5064 force_share);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005065
5066 if (!blk1) {
5067 ret = -1;
5068 goto out;
5069 }
5070
5071 drv = bdrv_find_format(out_fmt);
5072 if (!drv) {
5073 error_report("Unknown file format");
5074 ret = -1;
5075 goto out;
5076 }
5077 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
5078
5079 if (!proto_drv) {
5080 error_report_err(local_err);
5081 ret = -1;
5082 goto out;
5083 }
5084 if (!drv->create_opts) {
5085 error_report("Format driver '%s' does not support image creation",
5086 drv->format_name);
5087 ret = -1;
5088 goto out;
5089 }
5090 if (!proto_drv->create_opts) {
5091 error_report("Protocol driver '%s' does not support image creation",
5092 proto_drv->format_name);
5093 ret = -1;
5094 goto out;
5095 }
5096 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5097 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
5098
5099 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5100
5101 size = blk_getlength(blk1);
5102 if (size < 0) {
5103 error_report("Failed to get size for '%s'", in.filename);
5104 ret = -1;
5105 goto out;
5106 }
5107
5108 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
5109 dd.count * in.bsz < size) {
5110 size = dd.count * in.bsz;
5111 }
5112
Reda Sallahif7c15532016-08-10 16:16:09 +02005113 /* Overflow means the specified offset is beyond input image's size */
5114 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5115 size < in.bsz * in.offset)) {
5116 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
5117 } else {
5118 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
5119 size - in.bsz * in.offset, &error_abort);
5120 }
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005121
5122 ret = bdrv_create(drv, out.filename, opts, &local_err);
5123 if (ret < 0) {
5124 error_reportf_err(local_err,
5125 "%s: error while creating output image: ",
5126 out.filename);
5127 ret = -1;
5128 goto out;
5129 }
5130
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01005131 /* TODO, we can't honour --image-opts for the target,
5132 * since it needs to be given in a format compatible
5133 * with the bdrv_create() call above which does not
5134 * support image-opts style.
5135 */
Daniel P. Berrange29cf9332017-05-15 17:47:12 +01005136 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01005137 false, false, false);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005138
5139 if (!blk2) {
5140 ret = -1;
5141 goto out;
5142 }
5143
Reda Sallahif7c15532016-08-10 16:16:09 +02005144 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5145 size < in.offset * in.bsz)) {
5146 /* We give a warning if the skip option is bigger than the input
5147 * size and create an empty output disk image (i.e. like dd(1)).
5148 */
5149 error_report("%s: cannot skip to specified offset", in.filename);
5150 in_pos = size;
5151 } else {
5152 in_pos = in.offset * in.bsz;
5153 }
5154
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005155 in.buf = g_new(uint8_t, in.bsz);
5156
Reda Sallahif7c15532016-08-10 16:16:09 +02005157 for (out_pos = 0; in_pos < size; block_count++) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005158 int in_ret, out_ret;
5159
5160 if (in_pos + in.bsz > size) {
5161 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
5162 } else {
5163 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
5164 }
5165 if (in_ret < 0) {
5166 error_report("error while reading from input image file: %s",
5167 strerror(-in_ret));
5168 ret = -1;
5169 goto out;
5170 }
5171 in_pos += in_ret;
5172
5173 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
5174
5175 if (out_ret < 0) {
5176 error_report("error while writing to output image file: %s",
5177 strerror(-out_ret));
5178 ret = -1;
5179 goto out;
5180 }
5181 out_pos += out_ret;
5182 }
5183
5184out:
5185 g_free(arg);
5186 qemu_opts_del(opts);
5187 qemu_opts_free(create_opts);
5188 blk_unref(blk1);
5189 blk_unref(blk2);
5190 g_free(in.filename);
5191 g_free(out.filename);
5192 g_free(in.buf);
5193 g_free(out.buf);
5194
5195 if (ret) {
5196 return 1;
5197 }
5198 return 0;
5199}
5200
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005201static void dump_json_block_measure_info(BlockMeasureInfo *info)
5202{
5203 QString *str;
5204 QObject *obj;
5205 Visitor *v = qobject_output_visitor_new(&obj);
5206
5207 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
5208 visit_complete(v, &obj);
5209 str = qobject_to_json_pretty(obj);
5210 assert(str != NULL);
5211 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02005212 qobject_unref(obj);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005213 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02005214 qobject_unref(str);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005215}
5216
5217static int img_measure(int argc, char **argv)
5218{
5219 static const struct option long_options[] = {
5220 {"help", no_argument, 0, 'h'},
5221 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
5222 {"object", required_argument, 0, OPTION_OBJECT},
5223 {"output", required_argument, 0, OPTION_OUTPUT},
5224 {"size", required_argument, 0, OPTION_SIZE},
5225 {"force-share", no_argument, 0, 'U'},
5226 {0, 0, 0, 0}
5227 };
5228 OutputFormat output_format = OFORMAT_HUMAN;
5229 BlockBackend *in_blk = NULL;
5230 BlockDriver *drv;
5231 const char *filename = NULL;
5232 const char *fmt = NULL;
5233 const char *out_fmt = "raw";
5234 char *options = NULL;
5235 char *snapshot_name = NULL;
5236 bool force_share = false;
5237 QemuOpts *opts = NULL;
5238 QemuOpts *object_opts = NULL;
5239 QemuOpts *sn_opts = NULL;
5240 QemuOptsList *create_opts = NULL;
5241 bool image_opts = false;
5242 uint64_t img_size = UINT64_MAX;
5243 BlockMeasureInfo *info = NULL;
5244 Error *local_err = NULL;
5245 int ret = 1;
5246 int c;
5247
5248 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
5249 long_options, NULL)) != -1) {
5250 switch (c) {
5251 case '?':
5252 case 'h':
5253 help();
5254 break;
5255 case 'f':
5256 fmt = optarg;
5257 break;
5258 case 'O':
5259 out_fmt = optarg;
5260 break;
5261 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02005262 if (accumulate_options(&options, optarg) < 0) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005263 goto out;
5264 }
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005265 break;
5266 case 'l':
5267 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
5268 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
5269 optarg, false);
5270 if (!sn_opts) {
5271 error_report("Failed in parsing snapshot param '%s'",
5272 optarg);
5273 goto out;
5274 }
5275 } else {
5276 snapshot_name = optarg;
5277 }
5278 break;
5279 case 'U':
5280 force_share = true;
5281 break;
5282 case OPTION_OBJECT:
5283 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
5284 optarg, true);
5285 if (!object_opts) {
5286 goto out;
5287 }
5288 break;
5289 case OPTION_IMAGE_OPTS:
5290 image_opts = true;
5291 break;
5292 case OPTION_OUTPUT:
5293 if (!strcmp(optarg, "json")) {
5294 output_format = OFORMAT_JSON;
5295 } else if (!strcmp(optarg, "human")) {
5296 output_format = OFORMAT_HUMAN;
5297 } else {
5298 error_report("--output must be used with human or json "
5299 "as argument.");
5300 goto out;
5301 }
5302 break;
5303 case OPTION_SIZE:
5304 {
5305 int64_t sval;
5306
Eyal Moscovici43d589b2020-05-13 16:36:26 +03005307 sval = cvtnum("image size", optarg);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005308 if (sval < 0) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005309 goto out;
5310 }
5311 img_size = (uint64_t)sval;
5312 }
5313 break;
5314 }
5315 }
5316
5317 if (qemu_opts_foreach(&qemu_object_opts,
5318 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02005319 qemu_img_object_print_help, &error_fatal)) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005320 goto out;
5321 }
5322
5323 if (argc - optind > 1) {
5324 error_report("At most one filename argument is allowed.");
5325 goto out;
5326 } else if (argc - optind == 1) {
5327 filename = argv[optind];
5328 }
5329
Stefan Hajnoczic3673dc2020-02-21 11:25:21 +00005330 if (!filename && (image_opts || fmt || snapshot_name || sn_opts)) {
5331 error_report("--image-opts, -f, and -l require a filename argument.");
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005332 goto out;
5333 }
5334 if (filename && img_size != UINT64_MAX) {
5335 error_report("--size N cannot be used together with a filename.");
5336 goto out;
5337 }
5338 if (!filename && img_size == UINT64_MAX) {
5339 error_report("Either --size N or one filename must be specified.");
5340 goto out;
5341 }
5342
5343 if (filename) {
5344 in_blk = img_open(image_opts, filename, fmt, 0,
5345 false, false, force_share);
5346 if (!in_blk) {
5347 goto out;
5348 }
5349
5350 if (sn_opts) {
5351 bdrv_snapshot_load_tmp(blk_bs(in_blk),
5352 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
5353 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
5354 &local_err);
5355 } else if (snapshot_name != NULL) {
5356 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
5357 snapshot_name, &local_err);
5358 }
5359 if (local_err) {
5360 error_reportf_err(local_err, "Failed to load snapshot: ");
5361 goto out;
5362 }
5363 }
5364
5365 drv = bdrv_find_format(out_fmt);
5366 if (!drv) {
5367 error_report("Unknown file format '%s'", out_fmt);
5368 goto out;
5369 }
5370 if (!drv->create_opts) {
5371 error_report("Format driver '%s' does not support image creation",
5372 drv->format_name);
5373 goto out;
5374 }
5375
5376 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5377 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
5378 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5379 if (options) {
Markus Armbruster235e59c2020-07-07 18:05:42 +02005380 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005381 error_report_err(local_err);
5382 error_report("Invalid options for file format '%s'", out_fmt);
5383 goto out;
5384 }
5385 }
5386 if (img_size != UINT64_MAX) {
5387 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
5388 }
5389
5390 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
5391 if (local_err) {
5392 error_report_err(local_err);
5393 goto out;
5394 }
5395
5396 if (output_format == OFORMAT_HUMAN) {
5397 printf("required size: %" PRIu64 "\n", info->required);
5398 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
Eric Blake5d72c682020-05-21 14:21:34 -05005399 if (info->has_bitmaps) {
5400 printf("bitmaps size: %" PRIu64 "\n", info->bitmaps);
5401 }
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005402 } else {
5403 dump_json_block_measure_info(info);
5404 }
5405
5406 ret = 0;
5407
5408out:
5409 qapi_free_BlockMeasureInfo(info);
5410 qemu_opts_del(object_opts);
5411 qemu_opts_del(opts);
5412 qemu_opts_del(sn_opts);
5413 qemu_opts_free(create_opts);
5414 g_free(options);
5415 blk_unref(in_blk);
5416 return ret;
5417}
Kevin Wolfb6133b82014-08-05 14:17:13 +02005418
Anthony Liguoric227f092009-10-01 16:12:16 -05005419static const img_cmd_t img_cmds[] = {
Stuart Brady153859b2009-06-07 00:42:17 +01005420#define DEF(option, callback, arg_string) \
5421 { option, callback },
5422#include "qemu-img-cmds.h"
5423#undef DEF
Stuart Brady153859b2009-06-07 00:42:17 +01005424 { NULL, NULL, },
5425};
5426
bellardea2384d2004-08-01 21:59:26 +00005427int main(int argc, char **argv)
5428{
Anthony Liguoric227f092009-10-01 16:12:16 -05005429 const img_cmd_t *cmd;
Stuart Brady153859b2009-06-07 00:42:17 +01005430 const char *cmdname;
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005431 Error *local_error = NULL;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005432 char *trace_file = NULL;
Jeff Cody7db16892014-04-25 17:02:32 -04005433 int c;
Jeff Cody7db16892014-04-25 17:02:32 -04005434 static const struct option long_options[] = {
5435 {"help", no_argument, 0, 'h'},
Denis V. Lunev10985132016-06-17 17:44:13 +03005436 {"version", no_argument, 0, 'V'},
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005437 {"trace", required_argument, NULL, 'T'},
Jeff Cody7db16892014-04-25 17:02:32 -04005438 {0, 0, 0, 0}
5439 };
bellardea2384d2004-08-01 21:59:26 +00005440
MORITA Kazutaka526eda12013-07-23 17:30:11 +09005441#ifdef CONFIG_POSIX
5442 signal(SIGPIPE, SIG_IGN);
5443#endif
5444
Daniel P. Berrangé98c5d2e2020-08-25 11:38:48 +01005445 socket_init();
Christophe Fergeauf5852ef2019-01-31 17:46:14 +01005446 error_init(argv[0]);
Daniel P. Berrangefe4db842016-10-04 14:35:52 +01005447 module_call_init(MODULE_INIT_TRACE);
Fam Zheng10f5bff2014-02-10 14:48:51 +08005448 qemu_init_exec_dir(argv[0]);
Kevin Wolf53f76e52010-12-16 15:10:32 +01005449
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005450 if (qemu_init_main_loop(&local_error)) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01005451 error_report_err(local_error);
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005452 exit(EXIT_FAILURE);
5453 }
5454
Eduardo Habkoste8f2d272016-05-12 11:10:04 -03005455 qcrypto_init(&error_fatal);
Daniel P. Berrangec2297082016-04-06 12:12:06 +01005456
Daniel P. Berrange064097d2016-02-10 18:41:01 +00005457 module_call_init(MODULE_INIT_QOM);
bellardea2384d2004-08-01 21:59:26 +00005458 bdrv_init();
Fam Zhengac1307a2014-04-22 13:36:11 +08005459 if (argc < 2) {
5460 error_exit("Not enough arguments");
5461 }
Stuart Brady153859b2009-06-07 00:42:17 +01005462
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00005463 qemu_add_opts(&qemu_object_opts);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00005464 qemu_add_opts(&qemu_source_opts);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005465 qemu_add_opts(&qemu_trace_opts);
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00005466
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005467 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
Denis V. Lunev10985132016-06-17 17:44:13 +03005468 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005469 case ':':
5470 missing_argument(argv[optind - 1]);
5471 return 0;
Stefan Hajnoczi4581c162017-03-17 18:45:39 +08005472 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005473 unrecognized_option(argv[optind - 1]);
5474 return 0;
5475 case 'h':
Denis V. Lunev10985132016-06-17 17:44:13 +03005476 help();
5477 return 0;
5478 case 'V':
5479 printf(QEMU_IMG_VERSION);
5480 return 0;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005481 case 'T':
5482 g_free(trace_file);
5483 trace_file = trace_opt_parse(optarg);
5484 break;
Stuart Brady153859b2009-06-07 00:42:17 +01005485 }
bellardea2384d2004-08-01 21:59:26 +00005486 }
Stuart Brady153859b2009-06-07 00:42:17 +01005487
Denis V. Lunev10985132016-06-17 17:44:13 +03005488 cmdname = argv[optind];
Jeff Cody7db16892014-04-25 17:02:32 -04005489
Denis V. Lunev10985132016-06-17 17:44:13 +03005490 /* reset getopt_long scanning */
5491 argc -= optind;
5492 if (argc < 1) {
Jeff Cody5f6979c2014-04-28 14:37:18 -04005493 return 0;
5494 }
Denis V. Lunev10985132016-06-17 17:44:13 +03005495 argv += optind;
Richard W.M. Jonesd339d762019-01-18 10:11:14 +00005496 qemu_reset_optind();
Denis V. Lunev10985132016-06-17 17:44:13 +03005497
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005498 if (!trace_init_backends()) {
5499 exit(1);
5500 }
5501 trace_init_file(trace_file);
5502 qemu_set_log(LOG_TRACE);
5503
Denis V. Lunev10985132016-06-17 17:44:13 +03005504 /* find the command */
5505 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
5506 if (!strcmp(cmdname, cmd->name)) {
5507 return cmd->handler(argc, argv);
5508 }
5509 }
Jeff Cody7db16892014-04-25 17:02:32 -04005510
Stuart Brady153859b2009-06-07 00:42:17 +01005511 /* not found */
Fam Zhengac1307a2014-04-22 13:36:11 +08005512 error_exit("Command not found: %s", cmdname);
bellardea2384d2004-08-01 21:59:26 +00005513}