blob: 2d30682f129fb8a2b808b8cd56426d30457b35d2 [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"
Stefano Garzarella97ede572019-05-08 12:43:24 +020044#include "qemu/units.h"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000045#include "qom/object_interfaces.h"
Markus Armbruster26f54e92014-10-07 13:59:04 +020046#include "sysemu/block-backend.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010047#include "block/block_int.h"
Max Reitzd4a32382014-10-24 15:57:37 +020048#include "block/blockjob.h"
Wenchao Xiaf364ec62013-05-25 11:09:44 +080049#include "block/qapi.h"
Daniel P. Berrangec2297082016-04-06 12:12:06 +010050#include "crypto/init.h"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +030051#include "trace/control.h"
bellarde8445332006-06-14 15:32:10 +000052
Thomas Huth7e563bf2018-02-15 12:06:47 +010053#define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
Thomas Huth0781dd62016-10-05 11:54:44 +020054 "\n" QEMU_COPYRIGHT "\n"
Jeff Cody5f6979c2014-04-28 14:37:18 -040055
Anthony Liguoric227f092009-10-01 16:12:16 -050056typedef struct img_cmd_t {
Stuart Brady153859b2009-06-07 00:42:17 +010057 const char *name;
58 int (*handler)(int argc, char **argv);
Anthony Liguoric227f092009-10-01 16:12:16 -050059} img_cmd_t;
Stuart Brady153859b2009-06-07 00:42:17 +010060
Federico Simoncelli8599ea42013-01-28 06:59:47 -050061enum {
62 OPTION_OUTPUT = 256,
63 OPTION_BACKING_CHAIN = 257,
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000064 OPTION_OBJECT = 258,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000065 OPTION_IMAGE_OPTS = 259,
Kevin Wolfb6495fa2015-07-10 18:09:18 +020066 OPTION_PATTERN = 260,
Kevin Wolf55d539c2016-06-03 13:59:41 +020067 OPTION_FLUSH_INTERVAL = 261,
68 OPTION_NO_DRAIN = 262,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +010069 OPTION_TARGET_IMAGE_OPTS = 263,
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +010070 OPTION_SIZE = 264,
Max Reitzdc5f6902017-06-13 22:20:55 +020071 OPTION_PREALLOCATION = 265,
Pavel Butsykin4ffca892017-09-18 15:42:27 +030072 OPTION_SHRINK = 266,
Max Reitz8eaac022019-05-07 22:35:03 +020073 OPTION_SALVAGE = 267,
David Edmondson168468f2020-02-05 11:02:48 +000074 OPTION_TARGET_IS_ZERO = 268,
Eric Blake3b51ab42020-05-12 20:16:45 -050075 OPTION_ADD = 269,
76 OPTION_REMOVE = 270,
77 OPTION_CLEAR = 271,
78 OPTION_ENABLE = 272,
79 OPTION_DISABLE = 273,
80 OPTION_MERGE = 274,
Federico Simoncelli8599ea42013-01-28 06:59:47 -050081};
82
83typedef enum OutputFormat {
84 OFORMAT_JSON,
85 OFORMAT_HUMAN,
86} OutputFormat;
87
Kevin Wolfe6996142016-03-15 13:03:11 +010088/* Default to cache=writeback as data integrity is not important for qemu-img */
Federico Simoncelli661a0f72011-06-20 12:48:19 -040089#define BDRV_DEFAULT_CACHE "writeback"
aurel32137519c2008-11-30 19:12:49 +000090
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +010091static void format_print(void *opaque, const char *name)
bellardea2384d2004-08-01 21:59:26 +000092{
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +010093 printf(" %s", name);
bellardea2384d2004-08-01 21:59:26 +000094}
95
Fam Zhengac1307a2014-04-22 13:36:11 +080096static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
97{
98 va_list ap;
99
Fam Zhengac1307a2014-04-22 13:36:11 +0800100 va_start(ap, fmt);
Markus Armbrustere9e1d922019-04-17 21:06:27 +0200101 error_vreport(fmt, ap);
Fam Zhengac1307a2014-04-22 13:36:11 +0800102 va_end(ap);
103
Markus Armbrustere9e1d922019-04-17 21:06:27 +0200104 error_printf("Try 'qemu-img --help' for more information\n");
Fam Zhengac1307a2014-04-22 13:36:11 +0800105 exit(EXIT_FAILURE);
106}
107
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800108static void QEMU_NORETURN missing_argument(const char *option)
109{
110 error_exit("missing argument for option '%s'", option);
111}
112
113static void QEMU_NORETURN unrecognized_option(const char *option)
114{
115 error_exit("unrecognized option '%s'", option);
116}
117
Eric Blake0562adf2020-05-12 20:16:41 -0500118/* Please keep in synch with docs/tools/qemu-img.rst */
Fam Zhengac1307a2014-04-22 13:36:11 +0800119static void QEMU_NORETURN help(void)
bellardea2384d2004-08-01 21:59:26 +0000120{
Paolo Bonzinie00291c2010-02-04 16:49:56 +0100121 const char *help_msg =
Jeff Cody5f6979c2014-04-28 14:37:18 -0400122 QEMU_IMG_VERSION
Denis V. Lunev10985132016-06-17 17:44:13 +0300123 "usage: qemu-img [standard options] command [command options]\n"
malc3f020d72010-02-08 12:04:56 +0300124 "QEMU disk image utility\n"
125 "\n"
Denis V. Lunev10985132016-06-17 17:44:13 +0300126 " '-h', '--help' display this help and exit\n"
127 " '-V', '--version' output version information and exit\n"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +0300128 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
129 " specify tracing options\n"
Denis V. Lunev10985132016-06-17 17:44:13 +0300130 "\n"
malc3f020d72010-02-08 12:04:56 +0300131 "Command syntax:\n"
Stuart Brady153859b2009-06-07 00:42:17 +0100132#define DEF(option, callback, arg_string) \
133 " " arg_string "\n"
134#include "qemu-img-cmds.h"
135#undef DEF
malc3f020d72010-02-08 12:04:56 +0300136 "\n"
137 "Command parameters:\n"
138 " 'filename' is a disk image filename\n"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000139 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
140 " manual page for a description of the object properties. The most common\n"
141 " object type is a 'secret', which is used to supply passwords and/or\n"
142 " encryption keys.\n"
malc3f020d72010-02-08 12:04:56 +0300143 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400144 " 'cache' is the cache mode used to write the output disk image, the valid\n"
Liu Yuan80ccf932012-04-20 17:10:56 +0800145 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
146 " 'directsync' and 'unsafe' (default for convert)\n"
Stefan Hajnoczibb87fdf2014-09-02 11:01:02 +0100147 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
148 " options are the same as for the 'cache' option\n"
malc3f020d72010-02-08 12:04:56 +0300149 " 'size' is the disk image size in bytes. Optional suffixes\n"
Kevin Wolf5e009842013-06-05 14:19:27 +0200150 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
151 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
152 " supported. 'b' is ignored.\n"
malc3f020d72010-02-08 12:04:56 +0300153 " 'output_filename' is the destination disk image filename\n"
154 " 'output_fmt' is the destination format\n"
155 " 'options' is a comma separated list of format specific options in a\n"
156 " name=value format. Use -o ? for an overview of the options supported by the\n"
157 " used format\n"
Wenchao Xiaef806542013-12-04 17:10:57 +0800158 " 'snapshot_param' is param used for internal snapshot, format\n"
159 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
160 " '[ID_OR_NAME]'\n"
malc3f020d72010-02-08 12:04:56 +0300161 " '-c' indicates that target image must be compressed (qcow format only)\n"
John Snow6e6e55f2017-07-17 20:34:22 -0400162 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
163 " new backing file match exactly. The image doesn't need a working\n"
164 " backing file before rebasing in this case (useful for renaming the\n"
165 " backing file). For image creation, allow creating without attempting\n"
166 " to open the backing file.\n"
malc3f020d72010-02-08 12:04:56 +0300167 " '-h' with or without a command shows this help and lists the supported formats\n"
Jes Sorensen6b837bc2011-03-30 14:16:25 +0200168 " '-p' show progress of command (only certain commands)\n"
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100169 " '-q' use Quiet mode - do not print any output (except errors)\n"
Peter Lieven11b66992013-10-24 12:07:05 +0200170 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
171 " contain only zeros for qemu-img to create a sparse image during\n"
172 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
173 " unallocated or zero sectors, and the destination image will always be\n"
174 " fully allocated\n"
Benoît Canetc054b3f2012-09-05 13:09:02 +0200175 " '--output' takes the format in which the output must be done (human or json)\n"
Alexandre Derumierb2e10492013-09-02 19:07:24 +0100176 " '-n' skips the target volume creation (useful if the volume is created\n"
177 " prior to running qemu-img)\n"
malc3f020d72010-02-08 12:04:56 +0300178 "\n"
Eric Blake3b51ab42020-05-12 20:16:45 -0500179 "Parameters to bitmap subcommand:\n"
180 " 'bitmap' is the name of the bitmap to manipulate, through one or more\n"
181 " actions from '--add', '--remove', '--clear', '--enable', '--disable',\n"
182 " or '--merge source'\n"
183 " '-g granularity' sets the granularity for '--add' actions\n"
184 " '-b source' and '-F src_fmt' tell '--merge' actions to find the source\n"
185 " bitmaps from an alternative file\n"
186 "\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200187 "Parameters to check subcommand:\n"
188 " '-r' tries to repair any inconsistencies that are found during the check.\n"
189 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
190 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
Stefan Weil0546b8c2012-08-10 22:03:25 +0200191 " hiding corruption that has already occurred.\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200192 "\n"
Peter Lieven2d9187b2017-02-28 13:40:07 +0100193 "Parameters to convert subcommand:\n"
194 " '-m' specifies how many coroutines work in parallel during the convert\n"
195 " process (defaults to 8)\n"
196 " '-W' allow to write to the target out of order rather than sequential\n"
197 "\n"
malc3f020d72010-02-08 12:04:56 +0300198 "Parameters to snapshot subcommand:\n"
199 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
200 " '-a' applies a snapshot (revert disk to saved state)\n"
201 " '-c' creates a snapshot\n"
202 " '-d' deletes a snapshot\n"
Miroslav Rezaninad14ed182013-02-13 09:09:41 +0100203 " '-l' lists all snapshots in the given image\n"
204 "\n"
205 "Parameters to compare subcommand:\n"
206 " '-f' first image format\n"
207 " '-F' second image format\n"
Reda Sallahi86ce1f62016-08-10 04:43:12 +0200208 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
209 "\n"
210 "Parameters to dd subcommand:\n"
211 " 'bs=BYTES' read and write up to BYTES bytes at a time "
212 "(default: 512)\n"
213 " 'count=N' copy only N input blocks\n"
214 " 'if=FILE' read from FILE\n"
Reda Sallahif7c15532016-08-10 16:16:09 +0200215 " 'of=FILE' write to FILE\n"
216 " 'skip=N' skip N bs-sized blocks at the start of input\n";
Paolo Bonzinie00291c2010-02-04 16:49:56 +0100217
218 printf("%s\nSupported formats:", help_msg);
Andrey Shinkevich9ac404c2019-03-07 16:33:58 +0300219 bdrv_iterate_format(format_print, NULL, false);
Eric Blakef5048cb2017-08-03 11:33:53 -0500220 printf("\n\n" QEMU_HELP_BOTTOM "\n");
Fam Zhengac1307a2014-04-22 13:36:11 +0800221 exit(EXIT_SUCCESS);
bellardea2384d2004-08-01 21:59:26 +0000222}
223
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000224static QemuOptsList qemu_object_opts = {
225 .name = "object",
226 .implied_opt_name = "qom-type",
227 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
228 .desc = {
229 { }
230 },
231};
232
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +0200233static bool qemu_img_object_print_help(const char *type, QemuOpts *opts)
234{
235 if (user_creatable_print_help(type, opts)) {
236 exit(0);
237 }
238 return true;
239}
240
Markus Armbruster80c710c2020-04-15 09:49:26 +0200241/*
242 * Is @optarg safe for accumulate_options()?
243 * It is when multiple of them can be joined together separated by ','.
244 * To make that work, @optarg must not start with ',' (or else a
245 * separating ',' preceding it gets escaped), and it must not end with
246 * an odd number of ',' (or else a separating ',' following it gets
Markus Armbrusterf62514b2020-04-15 09:49:27 +0200247 * escaped), or be empty (or else a separating ',' preceding it can
248 * escape a separating ',' following it).
249 *
Markus Armbruster80c710c2020-04-15 09:49:26 +0200250 */
251static bool is_valid_option_list(const char *optarg)
252{
253 size_t len = strlen(optarg);
254 size_t i;
255
Markus Armbrusterf62514b2020-04-15 09:49:27 +0200256 if (!optarg[0] || optarg[0] == ',') {
Markus Armbruster80c710c2020-04-15 09:49:26 +0200257 return false;
258 }
259
260 for (i = len; i > 0 && optarg[i - 1] == ','; i--) {
261 }
262 if ((len - i) % 2) {
263 return false;
264 }
265
266 return true;
267}
268
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +0200269static int accumulate_options(char **options, char *optarg)
270{
271 char *new_options;
272
273 if (!is_valid_option_list(optarg)) {
274 error_report("Invalid option list: %s", optarg);
275 return -1;
276 }
277
278 if (!*options) {
279 *options = g_strdup(optarg);
280 } else {
281 new_options = g_strdup_printf("%s,%s", *options, optarg);
282 g_free(*options);
283 *options = new_options;
284 }
285 return 0;
286}
287
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000288static QemuOptsList qemu_source_opts = {
289 .name = "source",
290 .implied_opt_name = "file",
291 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
292 .desc = {
293 { }
294 },
295};
296
Stefan Weil7c30f652013-06-16 17:01:05 +0200297static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100298{
299 int ret = 0;
300 if (!quiet) {
301 va_list args;
302 va_start(args, fmt);
303 ret = vprintf(fmt, args);
304 va_end(args);
305 }
306 return ret;
307}
308
bellardea2384d2004-08-01 21:59:26 +0000309
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100310static int print_block_option_help(const char *filename, const char *fmt)
311{
312 BlockDriver *drv, *proto_drv;
Chunyan Liu83d05212014-06-05 17:20:51 +0800313 QemuOptsList *create_opts = NULL;
Max Reitzb65a5e12015-02-05 13:58:12 -0500314 Error *local_err = NULL;
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100315
316 /* Find driver and parse its options */
317 drv = bdrv_find_format(fmt);
318 if (!drv) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100319 error_report("Unknown file format '%s'", fmt);
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100320 return 1;
321 }
322
Max Reitzd402b6a2018-05-09 23:00:21 +0200323 if (!drv->create_opts) {
324 error_report("Format driver '%s' does not support image creation", fmt);
325 return 1;
326 }
327
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800328 create_opts = qemu_opts_append(create_opts, drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100329 if (filename) {
Max Reitzb65a5e12015-02-05 13:58:12 -0500330 proto_drv = bdrv_find_protocol(filename, true, &local_err);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100331 if (!proto_drv) {
Markus Armbruster2867ce42015-03-12 16:08:02 +0100332 error_report_err(local_err);
Chunyan Liu83d05212014-06-05 17:20:51 +0800333 qemu_opts_free(create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100334 return 1;
335 }
Max Reitzd402b6a2018-05-09 23:00:21 +0200336 if (!proto_drv->create_opts) {
Max Reitzf0998872018-11-19 11:19:20 +0100337 error_report("Protocol driver '%s' does not support image creation",
Max Reitzd402b6a2018-05-09 23:00:21 +0200338 proto_drv->format_name);
Max Reitz3ecd5a42018-11-19 11:19:21 +0100339 qemu_opts_free(create_opts);
Max Reitzd402b6a2018-05-09 23:00:21 +0200340 return 1;
341 }
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800342 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100343 }
344
Max Reitzf4619af2019-04-13 17:20:37 +0200345 if (filename) {
346 printf("Supported options:\n");
347 } else {
348 printf("Supported %s options:\n", fmt);
349 }
Max Reitz63898712018-10-19 18:49:25 +0200350 qemu_opts_print_help(create_opts, false);
Chunyan Liu83d05212014-06-05 17:20:51 +0800351 qemu_opts_free(create_opts);
Max Reitzf4619af2019-04-13 17:20:37 +0200352
353 if (!filename) {
354 printf("\n"
355 "The protocol level may support further options.\n"
356 "Specify the target filename to include those options.\n");
357 }
358
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100359 return 0;
360}
361
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000362
Max Reitzefaa7c42016-03-16 19:54:38 +0100363static BlockBackend *img_open_opts(const char *optstr,
Kevin Wolfce099542016-03-15 13:01:04 +0100364 QemuOpts *opts, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800365 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000366{
367 QDict *options;
368 Error *local_err = NULL;
369 BlockBackend *blk;
370 options = qemu_opts_to_qdict(opts, NULL);
Fam Zheng335e9932017-05-03 00:35:39 +0800371 if (force_share) {
372 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
Max Reitz4615f872018-05-02 22:20:50 +0200373 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
Fam Zheng335e9932017-05-03 00:35:39 +0800374 error_report("--force-share/-U conflicts with image options");
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200375 qobject_unref(options);
Fam Zheng335e9932017-05-03 00:35:39 +0800376 return NULL;
377 }
Max Reitz4615f872018-05-02 22:20:50 +0200378 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
Fam Zheng335e9932017-05-03 00:35:39 +0800379 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100380 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000381 if (!blk) {
Daniel P. Berrange143605a2016-04-06 10:16:18 +0100382 error_reportf_err(local_err, "Could not open '%s': ", optstr);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000383 return NULL;
384 }
Kevin Wolfce099542016-03-15 13:01:04 +0100385 blk_set_enable_write_cache(blk, !writethrough);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000386
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000387 return blk;
388}
389
Max Reitzefaa7c42016-03-16 19:54:38 +0100390static BlockBackend *img_open_file(const char *filename,
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100391 QDict *options,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000392 const char *fmt, int flags,
Fam Zheng335e9932017-05-03 00:35:39 +0800393 bool writethrough, bool quiet,
394 bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000395{
396 BlockBackend *blk;
Max Reitz34b5d2c2013-09-05 14:45:29 +0200397 Error *local_err = NULL;
Kevin Wolfad717132010-12-16 15:37:41 +0100398
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100399 if (!options) {
400 options = qdict_new();
401 }
bellard75c23802004-08-27 21:28:58 +0000402 if (fmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -0500403 qdict_put_str(options, "driver", fmt);
bellard75c23802004-08-27 21:28:58 +0000404 }
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100405
Fam Zheng335e9932017-05-03 00:35:39 +0800406 if (force_share) {
Eric Blake579cf1d2017-05-15 14:54:39 -0500407 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Fam Zheng335e9932017-05-03 00:35:39 +0800408 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100409 blk = blk_new_open(filename, NULL, options, flags, &local_err);
Max Reitz5bd31322015-02-05 13:58:16 -0500410 if (!blk) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100411 error_reportf_err(local_err, "Could not open '%s': ", filename);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000412 return NULL;
bellard75c23802004-08-27 21:28:58 +0000413 }
Kevin Wolfce099542016-03-15 13:01:04 +0100414 blk_set_enable_write_cache(blk, !writethrough);
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100415
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200416 return blk;
bellard75c23802004-08-27 21:28:58 +0000417}
418
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000419
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100420static int img_add_key_secrets(void *opaque,
421 const char *name, const char *value,
422 Error **errp)
423{
424 QDict *options = opaque;
425
426 if (g_str_has_suffix(name, "key-secret")) {
Eric Blake187f47e2017-06-24 12:10:07 -0600427 qdict_put_str(options, name, value);
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100428 }
429
430 return 0;
431}
432
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100433
Max Reitzefaa7c42016-03-16 19:54:38 +0100434static BlockBackend *img_open(bool image_opts,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000435 const char *filename,
Kevin Wolfce099542016-03-15 13:01:04 +0100436 const char *fmt, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800437 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000438{
439 BlockBackend *blk;
440 if (image_opts) {
441 QemuOpts *opts;
442 if (fmt) {
443 error_report("--image-opts and --format are mutually exclusive");
444 return NULL;
445 }
446 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
447 filename, true);
448 if (!opts) {
449 return NULL;
450 }
Fam Zheng335e9932017-05-03 00:35:39 +0800451 blk = img_open_opts(filename, opts, flags, writethrough, quiet,
452 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000453 } else {
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100454 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
Fam Zheng335e9932017-05-03 00:35:39 +0800455 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000456 }
457 return blk;
458}
459
460
Chunyan Liu83d05212014-06-05 17:20:51 +0800461static int add_old_style_options(const char *fmt, QemuOpts *opts,
Jes Sorenseneec77d92010-12-07 17:44:34 +0100462 const char *base_filename,
463 const char *base_fmt)
Kevin Wolfefa84d42009-05-18 16:42:12 +0200464{
Markus Armbruster6750e792015-02-12 17:43:08 +0100465 Error *err = NULL;
466
Kevin Wolfefa84d42009-05-18 16:42:12 +0200467 if (base_filename) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100468 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +0100469 if (err) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100470 error_report("Backing file not supported for file format '%s'",
471 fmt);
Markus Armbruster6750e792015-02-12 17:43:08 +0100472 error_free(err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900473 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200474 }
475 }
476 if (base_fmt) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100477 qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +0100478 if (err) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100479 error_report("Backing file format not supported for file "
480 "format '%s'", fmt);
Markus Armbruster6750e792015-02-12 17:43:08 +0100481 error_free(err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900482 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200483 }
484 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900485 return 0;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200486}
487
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300488static int64_t cvtnum_full(const char *name, const char *value, int64_t min,
489 int64_t max)
Markus Armbruster606caa02017-02-21 21:14:04 +0100490{
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100491 int err;
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300492 uint64_t res;
Markus Armbruster606caa02017-02-21 21:14:04 +0100493
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300494 err = qemu_strtosz(value, NULL, &res);
495 if (err < 0 && err != -ERANGE) {
496 error_report("Invalid %s specified. You may use "
497 "k, M, G, T, P or E suffixes for", name);
498 error_report("kilobytes, megabytes, gigabytes, terabytes, "
499 "petabytes and exabytes.");
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100500 return err;
501 }
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300502 if (err == -ERANGE || res > max || res < min) {
503 error_report("Invalid %s specified. Must be between %" PRId64
504 " and %" PRId64 ".", name, min, max);
Markus Armbrusterf46bfdb2017-02-21 21:14:07 +0100505 return -ERANGE;
506 }
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300507 return res;
508}
509
510static int64_t cvtnum(const char *name, const char *value)
511{
512 return cvtnum_full(name, value, 0, INT64_MAX);
Markus Armbruster606caa02017-02-21 21:14:04 +0100513}
514
bellardea2384d2004-08-01 21:59:26 +0000515static int img_create(int argc, char **argv)
516{
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200517 int c;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100518 uint64_t img_size = -1;
bellardea2384d2004-08-01 21:59:26 +0000519 const char *fmt = "raw";
aliguori9230eaf2009-03-28 17:55:19 +0000520 const char *base_fmt = NULL;
bellardea2384d2004-08-01 21:59:26 +0000521 const char *filename;
522 const char *base_filename = NULL;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200523 char *options = NULL;
Luiz Capitulino9b375252012-11-30 10:52:05 -0200524 Error *local_err = NULL;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100525 bool quiet = false;
John Snow6e6e55f2017-07-17 20:34:22 -0400526 int flags = 0;
ths3b46e622007-09-17 08:09:54 +0000527
bellardea2384d2004-08-01 21:59:26 +0000528 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000529 static const struct option long_options[] = {
530 {"help", no_argument, 0, 'h'},
531 {"object", required_argument, 0, OPTION_OBJECT},
532 {0, 0, 0, 0}
533 };
John Snow6e6e55f2017-07-17 20:34:22 -0400534 c = getopt_long(argc, argv, ":F:b:f:ho:qu",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000535 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100536 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000537 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100538 }
bellardea2384d2004-08-01 21:59:26 +0000539 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800540 case ':':
541 missing_argument(argv[optind - 1]);
542 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100543 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800544 unrecognized_option(argv[optind - 1]);
545 break;
bellardea2384d2004-08-01 21:59:26 +0000546 case 'h':
547 help();
548 break;
aliguori9230eaf2009-03-28 17:55:19 +0000549 case 'F':
550 base_fmt = optarg;
551 break;
bellardea2384d2004-08-01 21:59:26 +0000552 case 'b':
553 base_filename = optarg;
554 break;
555 case 'f':
556 fmt = optarg;
557 break;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200558 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +0200559 if (accumulate_options(&options, optarg) < 0) {
Kevin Wolf77386bf2014-02-21 16:24:04 +0100560 goto fail;
561 }
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200562 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100563 case 'q':
564 quiet = true;
565 break;
John Snow6e6e55f2017-07-17 20:34:22 -0400566 case 'u':
567 flags |= BDRV_O_NO_BACKING;
568 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000569 case OPTION_OBJECT: {
570 QemuOpts *opts;
571 opts = qemu_opts_parse_noisily(&qemu_object_opts,
572 optarg, true);
573 if (!opts) {
574 goto fail;
575 }
576 } break;
bellardea2384d2004-08-01 21:59:26 +0000577 }
578 }
aliguori9230eaf2009-03-28 17:55:19 +0000579
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900580 /* Get the filename */
Kevin Wolfa283cb62014-02-21 16:24:07 +0100581 filename = (optind < argc) ? argv[optind] : NULL;
582 if (options && has_help_option(options)) {
583 g_free(options);
584 return print_block_option_help(filename, fmt);
585 }
586
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100587 if (optind >= argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800588 error_exit("Expecting image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100589 }
Kevin Wolfa283cb62014-02-21 16:24:07 +0100590 optind++;
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900591
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000592 if (qemu_opts_foreach(&qemu_object_opts,
593 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +0200594 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000595 goto fail;
596 }
597
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100598 /* Get image size, if specified */
599 if (optind < argc) {
Jes Sorensen70b4f4b2011-01-05 11:41:02 +0100600 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +0100601
Eyal Moscovici43d589b2020-05-13 16:36:26 +0300602 sval = cvtnum("image size", argv[optind++]);
Markus Armbruster606caa02017-02-21 21:14:04 +0100603 if (sval < 0) {
Kevin Wolf77386bf2014-02-21 16:24:04 +0100604 goto fail;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100605 }
606 img_size = (uint64_t)sval;
607 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200608 if (optind != argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800609 error_exit("Unexpected argument: %s", argv[optind]);
Kevin Wolffc11eb22013-08-05 10:53:04 +0200610 }
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100611
Luiz Capitulino9b375252012-11-30 10:52:05 -0200612 bdrv_img_create(filename, fmt, base_filename, base_fmt,
John Snow6e6e55f2017-07-17 20:34:22 -0400613 options, img_size, flags, quiet, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100614 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100615 error_reportf_err(local_err, "%s: ", filename);
Kevin Wolf77386bf2014-02-21 16:24:04 +0100616 goto fail;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900617 }
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200618
Kevin Wolf77386bf2014-02-21 16:24:04 +0100619 g_free(options);
bellardea2384d2004-08-01 21:59:26 +0000620 return 0;
Kevin Wolf77386bf2014-02-21 16:24:04 +0100621
622fail:
623 g_free(options);
624 return 1;
bellardea2384d2004-08-01 21:59:26 +0000625}
626
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100627static void dump_json_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500628{
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500629 QString *str;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500630 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +0100631 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600632
633 visit_type_ImageCheck(v, NULL, &check, &error_abort);
634 visit_complete(v, &obj);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500635 str = qobject_to_json_pretty(obj);
636 assert(str != NULL);
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100637 qprintf(quiet, "%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200638 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600639 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200640 qobject_unref(str);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500641}
642
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100643static void dump_human_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500644{
645 if (!(check->corruptions || check->leaks || check->check_errors)) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100646 qprintf(quiet, "No errors were found on the image.\n");
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500647 } else {
648 if (check->corruptions) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100649 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
650 "Data may be corrupted, or further writes to the image "
651 "may corrupt it.\n",
652 check->corruptions);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500653 }
654
655 if (check->leaks) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100656 qprintf(quiet,
657 "\n%" PRId64 " leaked clusters were found on the image.\n"
658 "This means waste of disk space, but no harm to data.\n",
659 check->leaks);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500660 }
661
662 if (check->check_errors) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100663 qprintf(quiet,
664 "\n%" PRId64
665 " internal errors have occurred during the check.\n",
666 check->check_errors);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500667 }
668 }
669
670 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100671 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
672 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
673 check->allocated_clusters, check->total_clusters,
674 check->allocated_clusters * 100.0 / check->total_clusters,
675 check->fragmented_clusters * 100.0 / check->allocated_clusters,
676 check->compressed_clusters * 100.0 /
677 check->allocated_clusters);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500678 }
679
680 if (check->image_end_offset) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100681 qprintf(quiet,
682 "Image end offset: %" PRId64 "\n", check->image_end_offset);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500683 }
684}
685
686static int collect_image_check(BlockDriverState *bs,
687 ImageCheck *check,
688 const char *filename,
689 const char *fmt,
690 int fix)
691{
692 int ret;
693 BdrvCheckResult result;
694
695 ret = bdrv_check(bs, &result, fix);
696 if (ret < 0) {
697 return ret;
698 }
699
700 check->filename = g_strdup(filename);
701 check->format = g_strdup(bdrv_get_format_name(bs));
702 check->check_errors = result.check_errors;
703 check->corruptions = result.corruptions;
704 check->has_corruptions = result.corruptions != 0;
705 check->leaks = result.leaks;
706 check->has_leaks = result.leaks != 0;
707 check->corruptions_fixed = result.corruptions_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100708 check->has_corruptions_fixed = result.corruptions_fixed != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500709 check->leaks_fixed = result.leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100710 check->has_leaks_fixed = result.leaks_fixed != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500711 check->image_end_offset = result.image_end_offset;
712 check->has_image_end_offset = result.image_end_offset != 0;
713 check->total_clusters = result.bfi.total_clusters;
714 check->has_total_clusters = result.bfi.total_clusters != 0;
715 check->allocated_clusters = result.bfi.allocated_clusters;
716 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
717 check->fragmented_clusters = result.bfi.fragmented_clusters;
718 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
Stefan Hajnoczie6439d72013-02-07 17:15:04 +0100719 check->compressed_clusters = result.bfi.compressed_clusters;
720 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500721
722 return 0;
723}
724
Kevin Wolfe076f332010-06-29 11:43:13 +0200725/*
726 * Checks an image for consistency. Exit codes:
727 *
Max Reitzd6635c42014-06-02 22:15:21 +0200728 * 0 - Check completed, image is good
729 * 1 - Check not completed because of internal errors
730 * 2 - Check completed, image is corrupted
731 * 3 - Check completed, image has leaked clusters, but is good otherwise
732 * 63 - Checks are not supported by the image format
Kevin Wolfe076f332010-06-29 11:43:13 +0200733 */
aliguori15859692009-04-21 23:11:53 +0000734static int img_check(int argc, char **argv)
735{
736 int c, ret;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500737 OutputFormat output_format = OFORMAT_HUMAN;
Max Reitz40055952014-07-22 22:58:42 +0200738 const char *filename, *fmt, *output, *cache;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200739 BlockBackend *blk;
aliguori15859692009-04-21 23:11:53 +0000740 BlockDriverState *bs;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200741 int fix = 0;
Kevin Wolfce099542016-03-15 13:01:04 +0100742 int flags = BDRV_O_CHECK;
743 bool writethrough;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200744 ImageCheck *check;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100745 bool quiet = false;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000746 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +0800747 bool force_share = false;
aliguori15859692009-04-21 23:11:53 +0000748
749 fmt = NULL;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500750 output = NULL;
Max Reitz40055952014-07-22 22:58:42 +0200751 cache = BDRV_DEFAULT_CACHE;
Kevin Wolfce099542016-03-15 13:01:04 +0100752
aliguori15859692009-04-21 23:11:53 +0000753 for(;;) {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500754 int option_index = 0;
755 static const struct option long_options[] = {
756 {"help", no_argument, 0, 'h'},
757 {"format", required_argument, 0, 'f'},
Prasad Joshi4fd6a982014-03-25 00:08:54 +0530758 {"repair", required_argument, 0, 'r'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500759 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000760 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000761 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +0800762 {"force-share", no_argument, 0, 'U'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500763 {0, 0, 0, 0}
764 };
Fam Zheng335e9932017-05-03 00:35:39 +0800765 c = getopt_long(argc, argv, ":hf:r:T:qU",
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500766 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100767 if (c == -1) {
aliguori15859692009-04-21 23:11:53 +0000768 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100769 }
aliguori15859692009-04-21 23:11:53 +0000770 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800771 case ':':
772 missing_argument(argv[optind - 1]);
773 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100774 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800775 unrecognized_option(argv[optind - 1]);
776 break;
aliguori15859692009-04-21 23:11:53 +0000777 case 'h':
778 help();
779 break;
780 case 'f':
781 fmt = optarg;
782 break;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200783 case 'r':
784 flags |= BDRV_O_RDWR;
785
786 if (!strcmp(optarg, "leaks")) {
787 fix = BDRV_FIX_LEAKS;
788 } else if (!strcmp(optarg, "all")) {
789 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
790 } else {
Fam Zhengac1307a2014-04-22 13:36:11 +0800791 error_exit("Unknown option value for -r "
792 "(expecting 'leaks' or 'all'): %s", optarg);
Kevin Wolf4534ff52012-05-11 16:07:02 +0200793 }
794 break;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500795 case OPTION_OUTPUT:
796 output = optarg;
797 break;
Max Reitz40055952014-07-22 22:58:42 +0200798 case 'T':
799 cache = optarg;
800 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100801 case 'q':
802 quiet = true;
803 break;
Fam Zheng335e9932017-05-03 00:35:39 +0800804 case 'U':
805 force_share = true;
806 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000807 case OPTION_OBJECT: {
808 QemuOpts *opts;
809 opts = qemu_opts_parse_noisily(&qemu_object_opts,
810 optarg, true);
811 if (!opts) {
812 return 1;
813 }
814 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000815 case OPTION_IMAGE_OPTS:
816 image_opts = true;
817 break;
aliguori15859692009-04-21 23:11:53 +0000818 }
819 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200820 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800821 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100822 }
aliguori15859692009-04-21 23:11:53 +0000823 filename = argv[optind++];
824
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500825 if (output && !strcmp(output, "json")) {
826 output_format = OFORMAT_JSON;
827 } else if (output && !strcmp(output, "human")) {
828 output_format = OFORMAT_HUMAN;
829 } else if (output) {
830 error_report("--output must be used with human or json as argument.");
831 return 1;
832 }
833
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000834 if (qemu_opts_foreach(&qemu_object_opts,
835 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +0200836 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000837 return 1;
838 }
839
Kevin Wolfce099542016-03-15 13:01:04 +0100840 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +0200841 if (ret < 0) {
842 error_report("Invalid source cache option: %s", cache);
843 return 1;
844 }
845
Fam Zheng335e9932017-05-03 00:35:39 +0800846 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
847 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200848 if (!blk) {
849 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900850 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200851 bs = blk_bs(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500852
853 check = g_new0(ImageCheck, 1);
854 ret = collect_image_check(bs, check, filename, fmt, fix);
Kevin Wolfe076f332010-06-29 11:43:13 +0200855
856 if (ret == -ENOTSUP) {
Max Reitz55d492d2014-05-31 21:33:30 +0200857 error_report("This image format does not support checks");
Peter Lievenfefddf92013-10-24 08:53:34 +0200858 ret = 63;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500859 goto fail;
Kevin Wolfe076f332010-06-29 11:43:13 +0200860 }
861
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500862 if (check->corruptions_fixed || check->leaks_fixed) {
863 int corruptions_fixed, leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100864 bool has_leaks_fixed, has_corruptions_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500865
866 leaks_fixed = check->leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100867 has_leaks_fixed = check->has_leaks_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500868 corruptions_fixed = check->corruptions_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100869 has_corruptions_fixed = check->has_corruptions_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500870
871 if (output_format == OFORMAT_HUMAN) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100872 qprintf(quiet,
873 "The following inconsistencies were found and repaired:\n\n"
874 " %" PRId64 " leaked clusters\n"
875 " %" PRId64 " corruptions\n\n"
876 "Double checking the fixed image now...\n",
877 check->leaks_fixed,
878 check->corruptions_fixed);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500879 }
880
Pan Nengyuanfc124ea2020-02-27 09:29:50 +0800881 qapi_free_ImageCheck(check);
882 check = g_new0(ImageCheck, 1);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500883 ret = collect_image_check(bs, check, filename, fmt, 0);
884
885 check->leaks_fixed = leaks_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100886 check->has_leaks_fixed = has_leaks_fixed;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500887 check->corruptions_fixed = corruptions_fixed;
Max Reitz16563242020-03-24 18:27:55 +0100888 check->has_corruptions_fixed = has_corruptions_fixed;
Kevin Wolfccf34712012-05-11 18:16:54 +0200889 }
890
Max Reitz832390a2014-10-23 15:29:12 +0200891 if (!ret) {
892 switch (output_format) {
893 case OFORMAT_HUMAN:
894 dump_human_image_check(check, quiet);
895 break;
896 case OFORMAT_JSON:
897 dump_json_image_check(check, quiet);
898 break;
899 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500900 }
901
902 if (ret || check->check_errors) {
Max Reitz832390a2014-10-23 15:29:12 +0200903 if (ret) {
904 error_report("Check failed: %s", strerror(-ret));
905 } else {
906 error_report("Check failed");
907 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500908 ret = 1;
909 goto fail;
910 }
911
912 if (check->corruptions) {
913 ret = 2;
914 } else if (check->leaks) {
915 ret = 3;
Kevin Wolfe076f332010-06-29 11:43:13 +0200916 } else {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500917 ret = 0;
aliguori15859692009-04-21 23:11:53 +0000918 }
919
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500920fail:
921 qapi_free_ImageCheck(check);
Markus Armbruster26f54e92014-10-07 13:59:04 +0200922 blk_unref(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500923 return ret;
aliguori15859692009-04-21 23:11:53 +0000924}
925
Max Reitzd4a32382014-10-24 15:57:37 +0200926typedef struct CommonBlockJobCBInfo {
927 BlockDriverState *bs;
928 Error **errp;
929} CommonBlockJobCBInfo;
930
931static void common_block_job_cb(void *opaque, int ret)
932{
933 CommonBlockJobCBInfo *cbi = opaque;
934
935 if (ret < 0) {
936 error_setg_errno(cbi->errp, -ret, "Block job failed");
937 }
Max Reitzd4a32382014-10-24 15:57:37 +0200938}
939
940static void run_block_job(BlockJob *job, Error **errp)
941{
Kevin Wolfb75536c2016-04-18 17:30:17 +0200942 AioContext *aio_context = blk_get_aio_context(job->blk);
sochin.jiang4172a002017-06-15 14:47:33 +0800943 int ret = 0;
Max Reitzd4a32382014-10-24 15:57:37 +0200944
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200945 aio_context_acquire(aio_context);
Kevin Wolf80fa2c72018-04-13 18:50:05 +0200946 job_ref(&job->job);
Max Reitzd4a32382014-10-24 15:57:37 +0200947 do {
Kevin Wolf30a5c882018-05-04 12:17:20 +0200948 float progress = 0.0f;
Max Reitzd4a32382014-10-24 15:57:37 +0200949 aio_poll(aio_context, true);
Vladimir Sementsov-Ogievskiy01fe1ca2020-03-11 13:29:56 +0300950 if (job->job.progress.total) {
951 progress = (float)job->job.progress.current /
952 job->job.progress.total * 100.f;
Kevin Wolf30a5c882018-05-04 12:17:20 +0200953 }
954 qemu_progress_print(progress, 0);
Kevin Wolfdf956ae2018-04-25 15:09:58 +0200955 } while (!job_is_ready(&job->job) && !job_is_completed(&job->job));
Max Reitzd4a32382014-10-24 15:57:37 +0200956
Kevin Wolfdbe5e6c2018-04-19 13:04:01 +0200957 if (!job_is_completed(&job->job)) {
Kevin Wolf3d70ff52018-04-24 16:13:52 +0200958 ret = job_complete_sync(&job->job, errp);
sochin.jiang4172a002017-06-15 14:47:33 +0800959 } else {
Kevin Wolf4ad35182018-04-19 17:30:16 +0200960 ret = job->job.ret;
sochin.jiang4172a002017-06-15 14:47:33 +0800961 }
Kevin Wolf80fa2c72018-04-13 18:50:05 +0200962 job_unref(&job->job);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200963 aio_context_release(aio_context);
Max Reitz687fa1d2014-10-24 15:57:39 +0200964
sochin.jiang4172a002017-06-15 14:47:33 +0800965 /* publish completion progress only when success */
966 if (!ret) {
967 qemu_progress_print(100.f, 0);
968 }
Max Reitzd4a32382014-10-24 15:57:37 +0200969}
970
bellardea2384d2004-08-01 21:59:26 +0000971static int img_commit(int argc, char **argv)
972{
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400973 int c, ret, flags;
Max Reitz1b22bff2014-10-24 15:57:40 +0200974 const char *filename, *fmt, *cache, *base;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200975 BlockBackend *blk;
Max Reitzd4a32382014-10-24 15:57:37 +0200976 BlockDriverState *bs, *base_bs;
Kevin Wolf4ef85a92017-01-25 19:16:34 +0100977 BlockJob *job;
Max Reitz687fa1d2014-10-24 15:57:39 +0200978 bool progress = false, quiet = false, drop = false;
Kevin Wolfce099542016-03-15 13:01:04 +0100979 bool writethrough;
Max Reitzd4a32382014-10-24 15:57:37 +0200980 Error *local_err = NULL;
981 CommonBlockJobCBInfo cbi;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000982 bool image_opts = false;
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200983 AioContext *aio_context;
bellardea2384d2004-08-01 21:59:26 +0000984
985 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400986 cache = BDRV_DEFAULT_CACHE;
Max Reitz1b22bff2014-10-24 15:57:40 +0200987 base = NULL;
bellardea2384d2004-08-01 21:59:26 +0000988 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000989 static const struct option long_options[] = {
990 {"help", no_argument, 0, 'h'},
991 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000992 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000993 {0, 0, 0, 0}
994 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800995 c = getopt_long(argc, argv, ":f:ht:b:dpq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000996 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100997 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000998 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100999 }
bellardea2384d2004-08-01 21:59:26 +00001000 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001001 case ':':
1002 missing_argument(argv[optind - 1]);
1003 break;
Jes Sorensenef873942010-12-06 15:25:40 +01001004 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001005 unrecognized_option(argv[optind - 1]);
1006 break;
bellardea2384d2004-08-01 21:59:26 +00001007 case 'h':
1008 help();
1009 break;
1010 case 'f':
1011 fmt = optarg;
1012 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001013 case 't':
1014 cache = optarg;
1015 break;
Max Reitz1b22bff2014-10-24 15:57:40 +02001016 case 'b':
1017 base = optarg;
1018 /* -b implies -d */
1019 drop = true;
1020 break;
Max Reitz9a86fe42014-10-24 15:57:38 +02001021 case 'd':
1022 drop = true;
1023 break;
Max Reitz687fa1d2014-10-24 15:57:39 +02001024 case 'p':
1025 progress = true;
1026 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01001027 case 'q':
1028 quiet = true;
1029 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001030 case OPTION_OBJECT: {
1031 QemuOpts *opts;
1032 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1033 optarg, true);
1034 if (!opts) {
1035 return 1;
1036 }
1037 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001038 case OPTION_IMAGE_OPTS:
1039 image_opts = true;
1040 break;
bellardea2384d2004-08-01 21:59:26 +00001041 }
1042 }
Max Reitz687fa1d2014-10-24 15:57:39 +02001043
1044 /* Progress is not shown in Quiet mode */
1045 if (quiet) {
1046 progress = false;
1047 }
1048
Kevin Wolffc11eb22013-08-05 10:53:04 +02001049 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001050 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01001051 }
bellardea2384d2004-08-01 21:59:26 +00001052 filename = argv[optind++];
1053
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001054 if (qemu_opts_foreach(&qemu_object_opts,
1055 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02001056 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001057 return 1;
1058 }
1059
Max Reitz9a86fe42014-10-24 15:57:38 +02001060 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
Kevin Wolfce099542016-03-15 13:01:04 +01001061 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001062 if (ret < 0) {
1063 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczia3981eb2014-08-26 19:17:54 +01001064 return 1;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001065 }
1066
Fam Zheng335e9932017-05-03 00:35:39 +08001067 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
1068 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001069 if (!blk) {
1070 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001071 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001072 bs = blk_bs(blk);
1073
Max Reitz687fa1d2014-10-24 15:57:39 +02001074 qemu_progress_init(progress, 1.f);
1075 qemu_progress_print(0.f, 100);
1076
Max Reitz1b22bff2014-10-24 15:57:40 +02001077 if (base) {
1078 base_bs = bdrv_find_backing_image(bs, base);
1079 if (!base_bs) {
Max Reitz6b33f3a2016-12-01 03:05:08 +01001080 error_setg(&local_err,
1081 "Did not find '%s' in the backing chain of '%s'",
1082 base, filename);
Max Reitz1b22bff2014-10-24 15:57:40 +02001083 goto done;
1084 }
1085 } else {
1086 /* This is different from QMP, which by default uses the deepest file in
1087 * the backing chain (i.e., the very base); however, the traditional
1088 * behavior of qemu-img commit is using the immediate backing file. */
Kevin Wolf760e0062015-06-17 14:55:21 +02001089 base_bs = backing_bs(bs);
Max Reitz1b22bff2014-10-24 15:57:40 +02001090 if (!base_bs) {
1091 error_setg(&local_err, "Image does not have a backing file");
1092 goto done;
1093 }
bellardea2384d2004-08-01 21:59:26 +00001094 }
1095
Max Reitzd4a32382014-10-24 15:57:37 +02001096 cbi = (CommonBlockJobCBInfo){
1097 .errp = &local_err,
1098 .bs = bs,
1099 };
1100
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001101 aio_context = bdrv_get_aio_context(bs);
1102 aio_context_acquire(aio_context);
Kevin Wolfbb02b652018-04-19 17:54:56 +02001103 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, 0,
Kevin Wolf0db832f2017-02-20 18:10:05 +01001104 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
Fam Zheng78bbd912017-04-21 20:27:04 +08001105 &cbi, false, &local_err);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001106 aio_context_release(aio_context);
Max Reitzd4a32382014-10-24 15:57:37 +02001107 if (local_err) {
1108 goto done;
1109 }
1110
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001111 /* When the block job completes, the BlockBackend reference will point to
1112 * the old backing file. In order to avoid that the top image is already
1113 * deleted, so we can still empty it afterwards, increment the reference
1114 * counter here preemptively. */
Max Reitz9a86fe42014-10-24 15:57:38 +02001115 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001116 bdrv_ref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001117 }
1118
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001119 job = block_job_get("commit");
Liam Merwick2e2db262018-11-05 21:38:37 +00001120 assert(job);
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001121 run_block_job(job, &local_err);
Max Reitz9a86fe42014-10-24 15:57:38 +02001122 if (local_err) {
1123 goto unref_backing;
1124 }
1125
Max Reitz2d97fde2020-04-29 16:11:26 +02001126 if (!drop) {
1127 BlockBackend *old_backing_blk;
1128
1129 old_backing_blk = blk_new_with_bs(bs, BLK_PERM_WRITE, BLK_PERM_ALL,
1130 &local_err);
1131 if (!old_backing_blk) {
1132 goto unref_backing;
1133 }
1134 ret = blk_make_empty(old_backing_blk, &local_err);
1135 blk_unref(old_backing_blk);
1136 if (ret == -ENOTSUP) {
1137 error_free(local_err);
1138 local_err = NULL;
1139 } else if (ret < 0) {
Max Reitz9a86fe42014-10-24 15:57:38 +02001140 goto unref_backing;
1141 }
1142 }
1143
1144unref_backing:
1145 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001146 bdrv_unref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001147 }
Max Reitzd4a32382014-10-24 15:57:37 +02001148
1149done:
Max Reitz687fa1d2014-10-24 15:57:39 +02001150 qemu_progress_end();
1151
Markus Armbruster26f54e92014-10-07 13:59:04 +02001152 blk_unref(blk);
Max Reitzd4a32382014-10-24 15:57:37 +02001153
1154 if (local_err) {
Markus Armbruster6936f292015-02-10 15:14:02 +01001155 error_report_err(local_err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001156 return 1;
1157 }
Max Reitzd4a32382014-10-24 15:57:37 +02001158
1159 qprintf(quiet, "Image committed.\n");
bellardea2384d2004-08-01 21:59:26 +00001160 return 0;
1161}
1162
Dmitry Konishchevf6a00aa2011-05-18 15:03:59 +04001163/*
Eric Blakedebb38a2017-10-11 22:47:11 -05001164 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1165 * of the first sector boundary within buf where the sector contains a
1166 * non-zero byte. This function is robust to a buffer that is not
1167 * sector-aligned.
1168 */
1169static int64_t find_nonzero(const uint8_t *buf, int64_t n)
1170{
1171 int64_t i;
1172 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);
1173
1174 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
1175 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
1176 return i;
1177 }
1178 }
1179 if (i < n && !buffer_is_zero(buf + i, n - end)) {
1180 return i;
1181 }
1182 return -1;
1183}
1184
1185/*
thsf58c7b32008-06-05 21:53:49 +00001186 * Returns true iff the first sector pointed to by 'buf' contains at least
1187 * a non-NUL byte.
1188 *
1189 * 'pnum' is set to the number of sectors (including and immediately following
1190 * the first one) that are known to be in the same allocated/unallocated state.
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001191 * The function will try to align the end offset to alignment boundaries so
1192 * that the request will at least end aligned and consequtive requests will
1193 * also start at an aligned offset.
thsf58c7b32008-06-05 21:53:49 +00001194 */
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001195static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
1196 int64_t sector_num, int alignment)
bellardea2384d2004-08-01 21:59:26 +00001197{
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001198 bool is_zero;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001199 int i, tail;
bellardea2384d2004-08-01 21:59:26 +00001200
1201 if (n <= 0) {
1202 *pnum = 0;
1203 return 0;
1204 }
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001205 is_zero = buffer_is_zero(buf, 512);
bellardea2384d2004-08-01 21:59:26 +00001206 for(i = 1; i < n; i++) {
1207 buf += 512;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001208 if (is_zero != buffer_is_zero(buf, 512)) {
bellardea2384d2004-08-01 21:59:26 +00001209 break;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001210 }
bellardea2384d2004-08-01 21:59:26 +00001211 }
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001212
1213 tail = (sector_num + i) & (alignment - 1);
1214 if (tail) {
1215 if (is_zero && i <= tail) {
1216 /* treat unallocated areas which only consist
1217 * of a small tail as allocated. */
1218 is_zero = false;
1219 }
1220 if (!is_zero) {
1221 /* align up end offset of allocated areas. */
1222 i += alignment - tail;
1223 i = MIN(i, n);
1224 } else {
1225 /* align down end offset of zero areas. */
1226 i -= tail;
1227 }
1228 }
bellardea2384d2004-08-01 21:59:26 +00001229 *pnum = i;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001230 return !is_zero;
bellardea2384d2004-08-01 21:59:26 +00001231}
1232
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001233/*
Kevin Wolfa22f1232011-08-26 15:27:13 +02001234 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1235 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1236 * breaking up write requests for only small sparse areas.
1237 */
1238static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001239 int min, int64_t sector_num, int alignment)
Kevin Wolfa22f1232011-08-26 15:27:13 +02001240{
1241 int ret;
1242 int num_checked, num_used;
1243
1244 if (n < min) {
1245 min = n;
1246 }
1247
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001248 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001249 if (!ret) {
1250 return ret;
1251 }
1252
1253 num_used = *pnum;
1254 buf += BDRV_SECTOR_SIZE * *pnum;
1255 n -= *pnum;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001256 sector_num += *pnum;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001257 num_checked = num_used;
1258
1259 while (n > 0) {
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001260 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001261
1262 buf += BDRV_SECTOR_SIZE * *pnum;
1263 n -= *pnum;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001264 sector_num += *pnum;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001265 num_checked += *pnum;
1266 if (ret) {
1267 num_used = num_checked;
1268 } else if (*pnum >= min) {
1269 break;
1270 }
1271 }
1272
1273 *pnum = num_used;
1274 return 1;
1275}
1276
1277/*
Eric Blakedc61cd32017-10-11 22:47:14 -05001278 * Compares two buffers sector by sector. Returns 0 if the first
1279 * sector of each buffer matches, non-zero otherwise.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001280 *
Eric Blakedc61cd32017-10-11 22:47:14 -05001281 * pnum is set to the sector-aligned size of the buffer prefix that
1282 * has the same matching status as the first sector.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001283 */
Eric Blakedc61cd32017-10-11 22:47:14 -05001284static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
1285 int64_t bytes, int64_t *pnum)
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001286{
Radim Krčmář8c1ac472015-02-20 17:06:15 +01001287 bool res;
Eric Blakedc61cd32017-10-11 22:47:14 -05001288 int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001289
Eric Blakedc61cd32017-10-11 22:47:14 -05001290 assert(bytes > 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001291
Eric Blakedc61cd32017-10-11 22:47:14 -05001292 res = !!memcmp(buf1, buf2, i);
1293 while (i < bytes) {
1294 int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001295
Eric Blakedc61cd32017-10-11 22:47:14 -05001296 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001297 break;
1298 }
Eric Blakedc61cd32017-10-11 22:47:14 -05001299 i += len;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001300 }
1301
1302 *pnum = i;
1303 return res;
1304}
1305
Stefano Garzarella97ede572019-05-08 12:43:24 +02001306#define IO_BUF_SIZE (2 * MiB)
bellardea2384d2004-08-01 21:59:26 +00001307
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001308/*
1309 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1310 *
Eric Blake0608e402017-10-11 22:47:12 -05001311 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1312 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1313 * failure), and 4 on error (the exit status for read errors), after emitting
1314 * an error message.
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001315 *
Max Reitzf1d3cd72015-02-05 13:58:18 -05001316 * @param blk: BlockBackend for the image
Eric Blakec41508e2017-10-11 22:47:13 -05001317 * @param offset: Starting offset to check
1318 * @param bytes: Number of bytes to check
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001319 * @param filename: Name of disk file we are checking (logging purpose)
1320 * @param buffer: Allocated buffer for storing read data
1321 * @param quiet: Flag for quiet mode
1322 */
Eric Blakec41508e2017-10-11 22:47:13 -05001323static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1324 int64_t bytes, const char *filename,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001325 uint8_t *buffer, bool quiet)
1326{
Eric Blakedebb38a2017-10-11 22:47:11 -05001327 int ret = 0;
1328 int64_t idx;
1329
Eric Blakec41508e2017-10-11 22:47:13 -05001330 ret = blk_pread(blk, offset, buffer, bytes);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001331 if (ret < 0) {
1332 error_report("Error while reading offset %" PRId64 " of %s: %s",
Eric Blakec41508e2017-10-11 22:47:13 -05001333 offset, filename, strerror(-ret));
Eric Blake0608e402017-10-11 22:47:12 -05001334 return 4;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001335 }
Eric Blakec41508e2017-10-11 22:47:13 -05001336 idx = find_nonzero(buffer, bytes);
Eric Blakedebb38a2017-10-11 22:47:11 -05001337 if (idx >= 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001338 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blakec41508e2017-10-11 22:47:13 -05001339 offset + idx);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001340 return 1;
1341 }
1342
1343 return 0;
1344}
1345
1346/*
1347 * Compares two images. Exit codes:
1348 *
1349 * 0 - Images are identical
1350 * 1 - Images differ
1351 * >1 - Error occurred
1352 */
1353static int img_compare(int argc, char **argv)
1354{
Max Reitz40055952014-07-22 22:58:42 +02001355 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001356 BlockBackend *blk1, *blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001357 BlockDriverState *bs1, *bs2;
Eric Blake033d9fc2017-10-11 22:47:16 -05001358 int64_t total_size1, total_size2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001359 uint8_t *buf1 = NULL, *buf2 = NULL;
Eric Blake31826642017-10-11 22:47:08 -05001360 int64_t pnum1, pnum2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001361 int allocated1, allocated2;
1362 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1363 bool progress = false, quiet = false, strict = false;
Max Reitz40055952014-07-22 22:58:42 +02001364 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01001365 bool writethrough;
Eric Blake033d9fc2017-10-11 22:47:16 -05001366 int64_t total_size;
1367 int64_t offset = 0;
1368 int64_t chunk;
Eric Blakedc61cd32017-10-11 22:47:14 -05001369 int c;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001370 uint64_t progress_base;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001371 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08001372 bool force_share = false;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001373
Max Reitz40055952014-07-22 22:58:42 +02001374 cache = BDRV_DEFAULT_CACHE;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001375 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001376 static const struct option long_options[] = {
1377 {"help", no_argument, 0, 'h'},
1378 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001379 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08001380 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001381 {0, 0, 0, 0}
1382 };
Fam Zheng335e9932017-05-03 00:35:39 +08001383 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001384 long_options, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001385 if (c == -1) {
1386 break;
1387 }
1388 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001389 case ':':
1390 missing_argument(argv[optind - 1]);
1391 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001392 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001393 unrecognized_option(argv[optind - 1]);
1394 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001395 case 'h':
1396 help();
1397 break;
1398 case 'f':
1399 fmt1 = optarg;
1400 break;
1401 case 'F':
1402 fmt2 = optarg;
1403 break;
Max Reitz40055952014-07-22 22:58:42 +02001404 case 'T':
1405 cache = optarg;
1406 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001407 case 'p':
1408 progress = true;
1409 break;
1410 case 'q':
1411 quiet = true;
1412 break;
1413 case 's':
1414 strict = true;
1415 break;
Fam Zheng335e9932017-05-03 00:35:39 +08001416 case 'U':
1417 force_share = true;
1418 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001419 case OPTION_OBJECT: {
1420 QemuOpts *opts;
1421 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1422 optarg, true);
1423 if (!opts) {
1424 ret = 2;
1425 goto out4;
1426 }
1427 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001428 case OPTION_IMAGE_OPTS:
1429 image_opts = true;
1430 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001431 }
1432 }
1433
1434 /* Progress is not shown in Quiet mode */
1435 if (quiet) {
1436 progress = false;
1437 }
1438
1439
Kevin Wolffc11eb22013-08-05 10:53:04 +02001440 if (optind != argc - 2) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001441 error_exit("Expecting two image file names");
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001442 }
1443 filename1 = argv[optind++];
1444 filename2 = argv[optind++];
1445
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001446 if (qemu_opts_foreach(&qemu_object_opts,
1447 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02001448 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001449 ret = 2;
1450 goto out4;
1451 }
1452
Stefan Hajnoczicbda0162014-08-26 19:17:55 +01001453 /* Initialize before goto out */
1454 qemu_progress_init(progress, 2.0);
1455
Kevin Wolfce099542016-03-15 13:01:04 +01001456 flags = 0;
1457 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +02001458 if (ret < 0) {
1459 error_report("Invalid source cache option: %s", cache);
1460 ret = 2;
1461 goto out3;
1462 }
1463
Fam Zheng335e9932017-05-03 00:35:39 +08001464 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1465 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001466 if (!blk1) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001467 ret = 2;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001468 goto out3;
1469 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001470
Fam Zheng335e9932017-05-03 00:35:39 +08001471 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1472 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001473 if (!blk2) {
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001474 ret = 2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001475 goto out2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001476 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001477 bs1 = blk_bs(blk1);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001478 bs2 = blk_bs(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001479
Max Reitzf1d3cd72015-02-05 13:58:18 -05001480 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1481 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
Eric Blake033d9fc2017-10-11 22:47:16 -05001482 total_size1 = blk_getlength(blk1);
1483 if (total_size1 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001484 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001485 filename1, strerror(-total_size1));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001486 ret = 4;
1487 goto out;
1488 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001489 total_size2 = blk_getlength(blk2);
1490 if (total_size2 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001491 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001492 filename2, strerror(-total_size2));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001493 ret = 4;
1494 goto out;
1495 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001496 total_size = MIN(total_size1, total_size2);
1497 progress_base = MAX(total_size1, total_size2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001498
1499 qemu_progress_print(0, 100);
1500
Eric Blake033d9fc2017-10-11 22:47:16 -05001501 if (strict && total_size1 != total_size2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001502 ret = 1;
1503 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1504 goto out;
1505 }
1506
Eric Blake033d9fc2017-10-11 22:47:16 -05001507 while (offset < total_size) {
Eric Blake31826642017-10-11 22:47:08 -05001508 int status1, status2;
Fam Zheng67a0fd22016-01-26 11:58:48 +08001509
Eric Blake033d9fc2017-10-11 22:47:16 -05001510 status1 = bdrv_block_status_above(bs1, NULL, offset,
1511 total_size1 - offset, &pnum1, NULL,
1512 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001513 if (status1 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001514 ret = 3;
1515 error_report("Sector allocation test failed for %s", filename1);
1516 goto out;
1517 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001518 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001519
Eric Blake033d9fc2017-10-11 22:47:16 -05001520 status2 = bdrv_block_status_above(bs2, NULL, offset,
1521 total_size2 - offset, &pnum2, NULL,
1522 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001523 if (status2 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001524 ret = 3;
1525 error_report("Sector allocation test failed for %s", filename2);
1526 goto out;
1527 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001528 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
Eric Blake7daddc62017-10-11 22:47:09 -05001529
1530 assert(pnum1 && pnum2);
Eric Blake033d9fc2017-10-11 22:47:16 -05001531 chunk = MIN(pnum1, pnum2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001532
Fam Zheng25ad8e62016-01-13 16:37:41 +08001533 if (strict) {
Eric Blake31826642017-10-11 22:47:08 -05001534 if (status1 != status2) {
Fam Zheng25ad8e62016-01-13 16:37:41 +08001535 ret = 1;
1536 qprintf(quiet, "Strict mode: Offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001537 " block status mismatch!\n", offset);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001538 goto out;
1539 }
1540 }
1541 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
Eric Blake7daddc62017-10-11 22:47:09 -05001542 /* nothing to do */
Fam Zheng25ad8e62016-01-13 16:37:41 +08001543 } else if (allocated1 == allocated2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001544 if (allocated1) {
Eric Blakedc61cd32017-10-11 22:47:14 -05001545 int64_t pnum;
1546
Eric Blake033d9fc2017-10-11 22:47:16 -05001547 chunk = MIN(chunk, IO_BUF_SIZE);
1548 ret = blk_pread(blk1, offset, buf1, chunk);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001549 if (ret < 0) {
1550 error_report("Error while reading offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001551 " of %s: %s",
1552 offset, filename1, strerror(-ret));
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001553 ret = 4;
1554 goto out;
1555 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001556 ret = blk_pread(blk2, offset, buf2, chunk);
1557 if (ret < 0) {
1558 error_report("Error while reading offset %" PRId64
1559 " of %s: %s",
1560 offset, filename2, strerror(-ret));
1561 ret = 4;
1562 goto out;
1563 }
1564 ret = compare_buffers(buf1, buf2, chunk, &pnum);
1565 if (ret || pnum != chunk) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001566 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blake033d9fc2017-10-11 22:47:16 -05001567 offset + (ret ? 0 : pnum));
Fam Zheng36452f12013-11-13 20:26:49 +08001568 ret = 1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001569 goto out;
1570 }
1571 }
1572 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001573 chunk = MIN(chunk, IO_BUF_SIZE);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001574 if (allocated1) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001575 ret = check_empty_sectors(blk1, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001576 filename1, buf1, quiet);
1577 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001578 ret = check_empty_sectors(blk2, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001579 filename2, buf1, quiet);
1580 }
1581 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001582 goto out;
1583 }
1584 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001585 offset += chunk;
1586 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001587 }
1588
Eric Blake033d9fc2017-10-11 22:47:16 -05001589 if (total_size1 != total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001590 BlockBackend *blk_over;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001591 const char *filename_over;
1592
1593 qprintf(quiet, "Warning: Image size mismatch!\n");
Eric Blake033d9fc2017-10-11 22:47:16 -05001594 if (total_size1 > total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001595 blk_over = blk1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001596 filename_over = filename1;
1597 } else {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001598 blk_over = blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001599 filename_over = filename2;
1600 }
1601
Eric Blake033d9fc2017-10-11 22:47:16 -05001602 while (offset < progress_base) {
1603 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1604 progress_base - offset, &chunk,
1605 NULL, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001606 if (ret < 0) {
1607 ret = 3;
1608 error_report("Sector allocation test failed for %s",
1609 filename_over);
1610 goto out;
1611
1612 }
Eric Blake391cb1a2017-10-11 22:47:10 -05001613 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001614 chunk = MIN(chunk, IO_BUF_SIZE);
1615 ret = check_empty_sectors(blk_over, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001616 filename_over, buf1, quiet);
1617 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001618 goto out;
1619 }
1620 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001621 offset += chunk;
1622 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001623 }
1624 }
1625
1626 qprintf(quiet, "Images are identical.\n");
1627 ret = 0;
1628
1629out:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001630 qemu_vfree(buf1);
1631 qemu_vfree(buf2);
Markus Armbruster26f54e92014-10-07 13:59:04 +02001632 blk_unref(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001633out2:
Markus Armbruster26f54e92014-10-07 13:59:04 +02001634 blk_unref(blk1);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001635out3:
1636 qemu_progress_end();
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001637out4:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001638 return ret;
1639}
1640
Kevin Wolf690c7302015-03-19 13:33:32 +01001641enum ImgConvertBlockStatus {
1642 BLK_DATA,
1643 BLK_ZERO,
1644 BLK_BACKING_FILE,
1645};
1646
Peter Lieven2d9187b2017-02-28 13:40:07 +01001647#define MAX_COROUTINES 16
1648
Kevin Wolf690c7302015-03-19 13:33:32 +01001649typedef struct ImgConvertState {
1650 BlockBackend **src;
1651 int64_t *src_sectors;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001652 int src_num;
Kevin Wolf690c7302015-03-19 13:33:32 +01001653 int64_t total_sectors;
1654 int64_t allocated_sectors;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001655 int64_t allocated_done;
1656 int64_t sector_num;
1657 int64_t wr_offs;
Kevin Wolf690c7302015-03-19 13:33:32 +01001658 enum ImgConvertBlockStatus status;
1659 int64_t sector_next_status;
1660 BlockBackend *target;
1661 bool has_zero_init;
1662 bool compressed;
Max Reitz351c8ef2018-05-01 18:57:49 +02001663 bool unallocated_blocks_are_zero;
Max Reitz4d7c4872019-07-24 19:12:29 +02001664 bool target_is_new;
Kevin Wolf690c7302015-03-19 13:33:32 +01001665 bool target_has_backing;
Max Reitz351c8ef2018-05-01 18:57:49 +02001666 int64_t target_backing_sectors; /* negative if unknown */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001667 bool wr_in_order;
Fam Zhengee5306d2018-06-01 17:26:48 +08001668 bool copy_range;
Max Reitz8eaac022019-05-07 22:35:03 +02001669 bool salvage;
Max Reitz3d96cb92019-05-07 22:35:02 +02001670 bool quiet;
Kevin Wolf690c7302015-03-19 13:33:32 +01001671 int min_sparse;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001672 int alignment;
Kevin Wolf690c7302015-03-19 13:33:32 +01001673 size_t cluster_sectors;
1674 size_t buf_sectors;
Peter Lieven9fd77f92017-04-21 11:11:55 +02001675 long num_coroutines;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001676 int running_coroutines;
1677 Coroutine *co[MAX_COROUTINES];
1678 int64_t wait_sector_num[MAX_COROUTINES];
1679 CoMutex lock;
1680 int ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001681} ImgConvertState;
1682
Peter Lieven2d9187b2017-02-28 13:40:07 +01001683static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1684 int *src_cur, int64_t *src_cur_offset)
Kevin Wolf690c7302015-03-19 13:33:32 +01001685{
Peter Lieven2d9187b2017-02-28 13:40:07 +01001686 *src_cur = 0;
1687 *src_cur_offset = 0;
1688 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1689 *src_cur_offset += s->src_sectors[*src_cur];
1690 (*src_cur)++;
1691 assert(*src_cur < s->src_num);
Kevin Wolf690c7302015-03-19 13:33:32 +01001692 }
1693}
1694
1695static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1696{
Eric Blake31826642017-10-11 22:47:08 -05001697 int64_t src_cur_offset;
1698 int ret, n, src_cur;
Max Reitz351c8ef2018-05-01 18:57:49 +02001699 bool post_backing_zero = false;
Kevin Wolf690c7302015-03-19 13:33:32 +01001700
Peter Lieven2d9187b2017-02-28 13:40:07 +01001701 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
Kevin Wolf690c7302015-03-19 13:33:32 +01001702
1703 assert(s->total_sectors > sector_num);
1704 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1705
Max Reitz351c8ef2018-05-01 18:57:49 +02001706 if (s->target_backing_sectors >= 0) {
1707 if (sector_num >= s->target_backing_sectors) {
1708 post_backing_zero = s->unallocated_blocks_are_zero;
1709 } else if (sector_num + n > s->target_backing_sectors) {
1710 /* Split requests around target_backing_sectors (because
1711 * starting from there, zeros are handled differently) */
1712 n = s->target_backing_sectors - sector_num;
1713 }
1714 }
1715
Kevin Wolf690c7302015-03-19 13:33:32 +01001716 if (s->sector_next_status <= sector_num) {
Max Reitz8eaac022019-05-07 22:35:03 +02001717 uint64_t offset = (sector_num - src_cur_offset) * BDRV_SECTOR_SIZE;
1718 int64_t count;
Eric Blake31826642017-10-11 22:47:08 -05001719
Max Reitz8eaac022019-05-07 22:35:03 +02001720 do {
1721 count = n * BDRV_SECTOR_SIZE;
Eric Blake237d78f2017-10-11 22:47:03 -05001722
Max Reitz8eaac022019-05-07 22:35:03 +02001723 if (s->target_has_backing) {
1724 ret = bdrv_block_status(blk_bs(s->src[src_cur]), offset,
1725 count, &count, NULL, NULL);
1726 } else {
1727 ret = bdrv_block_status_above(blk_bs(s->src[src_cur]), NULL,
1728 offset, count, &count, NULL,
1729 NULL);
1730 }
1731
1732 if (ret < 0) {
1733 if (s->salvage) {
1734 if (n == 1) {
1735 if (!s->quiet) {
1736 warn_report("error while reading block status at "
1737 "offset %" PRIu64 ": %s", offset,
1738 strerror(-ret));
1739 }
1740 /* Just try to read the data, then */
1741 ret = BDRV_BLOCK_DATA;
1742 count = BDRV_SECTOR_SIZE;
1743 } else {
1744 /* Retry on a shorter range */
1745 n = DIV_ROUND_UP(n, 4);
1746 }
1747 } else {
1748 error_report("error while reading block status at offset "
1749 "%" PRIu64 ": %s", offset, strerror(-ret));
1750 return ret;
1751 }
1752 }
1753 } while (ret < 0);
1754
Eric Blake31826642017-10-11 22:47:08 -05001755 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
Kevin Wolf690c7302015-03-19 13:33:32 +01001756
1757 if (ret & BDRV_BLOCK_ZERO) {
Max Reitz351c8ef2018-05-01 18:57:49 +02001758 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
Kevin Wolf690c7302015-03-19 13:33:32 +01001759 } else if (ret & BDRV_BLOCK_DATA) {
1760 s->status = BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001761 } else {
Vladimir Sementsov-Ogievskiy9f1b92a2017-04-07 14:34:04 +03001762 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001763 }
1764
1765 s->sector_next_status = sector_num + n;
1766 }
1767
1768 n = MIN(n, s->sector_next_status - sector_num);
1769 if (s->status == BLK_DATA) {
1770 n = MIN(n, s->buf_sectors);
1771 }
1772
1773 /* We need to write complete clusters for compressed images, so if an
1774 * unallocated area is shorter than that, we must consider the whole
1775 * cluster allocated. */
1776 if (s->compressed) {
1777 if (n < s->cluster_sectors) {
1778 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1779 s->status = BLK_DATA;
1780 } else {
1781 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1782 }
1783 }
1784
1785 return n;
1786}
1787
Peter Lieven2d9187b2017-02-28 13:40:07 +01001788static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1789 int nb_sectors, uint8_t *buf)
Kevin Wolf690c7302015-03-19 13:33:32 +01001790{
Max Reitz8eaac022019-05-07 22:35:03 +02001791 uint64_t single_read_until = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001792 int n, ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001793
Kevin Wolf690c7302015-03-19 13:33:32 +01001794 assert(nb_sectors <= s->buf_sectors);
1795 while (nb_sectors > 0) {
1796 BlockBackend *blk;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001797 int src_cur;
1798 int64_t bs_sectors, src_cur_offset;
Max Reitz8eaac022019-05-07 22:35:03 +02001799 uint64_t offset;
Kevin Wolf690c7302015-03-19 13:33:32 +01001800
1801 /* In the case of compression with multiple source files, we can get a
1802 * nb_sectors that spreads into the next part. So we must be able to
1803 * read across multiple BDSes for one convert_read() call. */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001804 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1805 blk = s->src[src_cur];
1806 bs_sectors = s->src_sectors[src_cur];
Kevin Wolf690c7302015-03-19 13:33:32 +01001807
Max Reitz8eaac022019-05-07 22:35:03 +02001808 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001809
Max Reitz8eaac022019-05-07 22:35:03 +02001810 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1811 if (single_read_until > offset) {
1812 n = 1;
1813 }
1814
1815 ret = blk_co_pread(blk, offset, n << BDRV_SECTOR_BITS, buf, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01001816 if (ret < 0) {
Max Reitz8eaac022019-05-07 22:35:03 +02001817 if (s->salvage) {
1818 if (n > 1) {
1819 single_read_until = offset + (n << BDRV_SECTOR_BITS);
1820 continue;
1821 } else {
1822 if (!s->quiet) {
1823 warn_report("error while reading offset %" PRIu64
1824 ": %s", offset, strerror(-ret));
1825 }
1826 memset(buf, 0, BDRV_SECTOR_SIZE);
1827 }
1828 } else {
1829 return ret;
1830 }
Kevin Wolf690c7302015-03-19 13:33:32 +01001831 }
1832
1833 sector_num += n;
1834 nb_sectors -= n;
1835 buf += n * BDRV_SECTOR_SIZE;
1836 }
1837
1838 return 0;
1839}
1840
Peter Lieven2d9187b2017-02-28 13:40:07 +01001841
1842static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1843 int nb_sectors, uint8_t *buf,
1844 enum ImgConvertBlockStatus status)
Kevin Wolf690c7302015-03-19 13:33:32 +01001845{
1846 int ret;
1847
1848 while (nb_sectors > 0) {
1849 int n = nb_sectors;
Lidong Chendb933fb2017-04-27 10:58:27 +08001850 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1851
Peter Lieven2d9187b2017-02-28 13:40:07 +01001852 switch (status) {
Kevin Wolf690c7302015-03-19 13:33:32 +01001853 case BLK_BACKING_FILE:
1854 /* If we have a backing file, leave clusters unallocated that are
1855 * unallocated in the source image, so that the backing file is
1856 * visible at the respective offset. */
1857 assert(s->target_has_backing);
1858 break;
1859
1860 case BLK_DATA:
Lidong Chendb933fb2017-04-27 10:58:27 +08001861 /* If we're told to keep the target fully allocated (-S 0) or there
1862 * is real non-zero data, we must write it. Otherwise we can treat
1863 * it as zero sectors.
1864 * Compressed clusters need to be written as a whole, so in that
1865 * case we can only save the write if the buffer is completely
1866 * zeroed. */
Kevin Wolf690c7302015-03-19 13:33:32 +01001867 if (!s->min_sparse ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001868 (!s->compressed &&
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001869 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1870 sector_num, s->alignment)) ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001871 (s->compressed &&
1872 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
Kevin Wolf690c7302015-03-19 13:33:32 +01001873 {
Vladimir Sementsov-Ogievskiy265a7e52019-04-22 17:58:38 +03001874 ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1875 n << BDRV_SECTOR_BITS, buf, flags);
Kevin Wolf690c7302015-03-19 13:33:32 +01001876 if (ret < 0) {
1877 return ret;
1878 }
1879 break;
1880 }
1881 /* fall-through */
1882
1883 case BLK_ZERO:
1884 if (s->has_zero_init) {
Lidong Chendb933fb2017-04-27 10:58:27 +08001885 assert(!s->target_has_backing);
Kevin Wolf690c7302015-03-19 13:33:32 +01001886 break;
1887 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01001888 ret = blk_co_pwrite_zeroes(s->target,
1889 sector_num << BDRV_SECTOR_BITS,
Nir Soffera3d6ae22019-03-24 02:20:12 +02001890 n << BDRV_SECTOR_BITS,
1891 BDRV_REQ_MAY_UNMAP);
Kevin Wolf690c7302015-03-19 13:33:32 +01001892 if (ret < 0) {
1893 return ret;
1894 }
1895 break;
1896 }
1897
1898 sector_num += n;
1899 nb_sectors -= n;
1900 buf += n * BDRV_SECTOR_SIZE;
1901 }
1902
1903 return 0;
1904}
1905
Fam Zhengee5306d2018-06-01 17:26:48 +08001906static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1907 int nb_sectors)
1908{
1909 int n, ret;
1910
1911 while (nb_sectors > 0) {
1912 BlockBackend *blk;
1913 int src_cur;
1914 int64_t bs_sectors, src_cur_offset;
1915 int64_t offset;
1916
1917 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1918 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1919 blk = s->src[src_cur];
1920 bs_sectors = s->src_sectors[src_cur];
1921
1922 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1923
1924 ret = blk_co_copy_range(blk, offset, s->target,
1925 sector_num << BDRV_SECTOR_BITS,
Vladimir Sementsov-Ogievskiy67b51fb2018-07-09 19:37:17 +03001926 n << BDRV_SECTOR_BITS, 0, 0);
Fam Zhengee5306d2018-06-01 17:26:48 +08001927 if (ret < 0) {
1928 return ret;
1929 }
1930
1931 sector_num += n;
1932 nb_sectors -= n;
1933 }
1934 return 0;
1935}
1936
Peter Lieven2d9187b2017-02-28 13:40:07 +01001937static void coroutine_fn convert_co_do_copy(void *opaque)
1938{
1939 ImgConvertState *s = opaque;
1940 uint8_t *buf = NULL;
1941 int ret, i;
1942 int index = -1;
1943
1944 for (i = 0; i < s->num_coroutines; i++) {
1945 if (s->co[i] == qemu_coroutine_self()) {
1946 index = i;
1947 break;
1948 }
1949 }
1950 assert(index >= 0);
1951
1952 s->running_coroutines++;
1953 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1954
1955 while (1) {
1956 int n;
1957 int64_t sector_num;
1958 enum ImgConvertBlockStatus status;
Fam Zhengee5306d2018-06-01 17:26:48 +08001959 bool copy_range;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001960
1961 qemu_co_mutex_lock(&s->lock);
1962 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1963 qemu_co_mutex_unlock(&s->lock);
Anton Nefedovb91127e2017-04-26 11:33:15 +03001964 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001965 }
1966 n = convert_iteration_sectors(s, s->sector_num);
1967 if (n < 0) {
1968 qemu_co_mutex_unlock(&s->lock);
1969 s->ret = n;
Anton Nefedovb91127e2017-04-26 11:33:15 +03001970 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001971 }
1972 /* save current sector and allocation status to local variables */
1973 sector_num = s->sector_num;
1974 status = s->status;
1975 if (!s->min_sparse && s->status == BLK_ZERO) {
1976 n = MIN(n, s->buf_sectors);
1977 }
1978 /* increment global sector counter so that other coroutines can
1979 * already continue reading beyond this request */
1980 s->sector_num += n;
1981 qemu_co_mutex_unlock(&s->lock);
1982
1983 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
1984 s->allocated_done += n;
1985 qemu_progress_print(100.0 * s->allocated_done /
1986 s->allocated_sectors, 0);
1987 }
1988
Fam Zhengee5306d2018-06-01 17:26:48 +08001989retry:
1990 copy_range = s->copy_range && s->status == BLK_DATA;
1991 if (status == BLK_DATA && !copy_range) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01001992 ret = convert_co_read(s, sector_num, n, buf);
1993 if (ret < 0) {
Eric Blake39f77cb2020-04-02 08:57:17 -05001994 error_report("error while reading at byte %lld: %s",
1995 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
Peter Lieven2d9187b2017-02-28 13:40:07 +01001996 s->ret = ret;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001997 }
1998 } else if (!s->min_sparse && status == BLK_ZERO) {
1999 status = BLK_DATA;
2000 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
2001 }
2002
2003 if (s->wr_in_order) {
2004 /* keep writes in order */
Anton Nefedovb91127e2017-04-26 11:33:15 +03002005 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002006 s->wait_sector_num[index] = sector_num;
2007 qemu_coroutine_yield();
2008 }
2009 s->wait_sector_num[index] = -1;
2010 }
2011
Anton Nefedovb91127e2017-04-26 11:33:15 +03002012 if (s->ret == -EINPROGRESS) {
Fam Zhengee5306d2018-06-01 17:26:48 +08002013 if (copy_range) {
2014 ret = convert_co_copy_range(s, sector_num, n);
2015 if (ret) {
2016 s->copy_range = false;
2017 goto retry;
2018 }
2019 } else {
2020 ret = convert_co_write(s, sector_num, n, buf, status);
2021 }
Anton Nefedovb91127e2017-04-26 11:33:15 +03002022 if (ret < 0) {
Eric Blake39f77cb2020-04-02 08:57:17 -05002023 error_report("error while writing at byte %lld: %s",
2024 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
Anton Nefedovb91127e2017-04-26 11:33:15 +03002025 s->ret = ret;
2026 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01002027 }
2028
2029 if (s->wr_in_order) {
2030 /* reenter the coroutine that might have waited
2031 * for this write to complete */
2032 s->wr_offs = sector_num + n;
2033 for (i = 0; i < s->num_coroutines; i++) {
2034 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
2035 /*
2036 * A -> B -> A cannot occur because A has
2037 * s->wait_sector_num[i] == -1 during A -> B. Therefore
2038 * B will never enter A during this time window.
2039 */
2040 qemu_coroutine_enter(s->co[i]);
2041 break;
2042 }
2043 }
2044 }
2045 }
2046
Peter Lieven2d9187b2017-02-28 13:40:07 +01002047 qemu_vfree(buf);
2048 s->co[index] = NULL;
2049 s->running_coroutines--;
2050 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
2051 /* the convert job finished successfully */
2052 s->ret = 0;
2053 }
2054}
2055
Kevin Wolf690c7302015-03-19 13:33:32 +01002056static int convert_do_copy(ImgConvertState *s)
2057{
Peter Lieven2d9187b2017-02-28 13:40:07 +01002058 int ret, i, n;
2059 int64_t sector_num = 0;
Kevin Wolf690c7302015-03-19 13:33:32 +01002060
2061 /* Check whether we have zero initialisation or can get it efficiently */
David Edmondson168468f2020-02-05 11:02:48 +00002062 if (!s->has_zero_init && s->target_is_new && s->min_sparse &&
2063 !s->target_has_backing) {
Max Reitz4d7c4872019-07-24 19:12:29 +02002064 s->has_zero_init = bdrv_has_zero_init(blk_bs(s->target));
Max Reitz4d7c4872019-07-24 19:12:29 +02002065 }
Kevin Wolf690c7302015-03-19 13:33:32 +01002066
2067 if (!s->has_zero_init && !s->target_has_backing &&
2068 bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
2069 {
Kevin Wolfc9fdcf22019-03-22 13:49:28 +01002070 ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP | BDRV_REQ_NO_FALLBACK);
Kevin Wolf690c7302015-03-19 13:33:32 +01002071 if (ret == 0) {
2072 s->has_zero_init = true;
2073 }
2074 }
2075
2076 /* Allocate buffer for copied data. For compressed images, only one cluster
2077 * can be copied at a time. */
2078 if (s->compressed) {
2079 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
2080 error_report("invalid cluster size");
Peter Lieven2d9187b2017-02-28 13:40:07 +01002081 return -EINVAL;
Kevin Wolf690c7302015-03-19 13:33:32 +01002082 }
2083 s->buf_sectors = s->cluster_sectors;
2084 }
Kevin Wolf690c7302015-03-19 13:33:32 +01002085
Kevin Wolf690c7302015-03-19 13:33:32 +01002086 while (sector_num < s->total_sectors) {
2087 n = convert_iteration_sectors(s, sector_num);
2088 if (n < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002089 return n;
Kevin Wolf690c7302015-03-19 13:33:32 +01002090 }
Max Reitzaad15de2016-03-24 23:33:57 +01002091 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
2092 {
Kevin Wolf690c7302015-03-19 13:33:32 +01002093 s->allocated_sectors += n;
2094 }
2095 sector_num += n;
2096 }
2097
2098 /* Do the copy */
Kevin Wolf690c7302015-03-19 13:33:32 +01002099 s->sector_next_status = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002100 s->ret = -EINPROGRESS;
Kevin Wolf690c7302015-03-19 13:33:32 +01002101
Peter Lieven2d9187b2017-02-28 13:40:07 +01002102 qemu_co_mutex_init(&s->lock);
2103 for (i = 0; i < s->num_coroutines; i++) {
2104 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
2105 s->wait_sector_num[i] = -1;
2106 qemu_coroutine_enter(s->co[i]);
Kevin Wolf690c7302015-03-19 13:33:32 +01002107 }
2108
Anton Nefedovb91127e2017-04-26 11:33:15 +03002109 while (s->running_coroutines) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002110 main_loop_wait(false);
2111 }
2112
2113 if (s->compressed && !s->ret) {
Kevin Wolf690c7302015-03-19 13:33:32 +01002114 /* signal EOF to align */
Pavel Butsykinfe5c1352016-07-22 11:17:40 +03002115 ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01002116 if (ret < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002117 return ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002118 }
2119 }
2120
Peter Lieven2d9187b2017-02-28 13:40:07 +01002121 return s->ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002122}
2123
Peter Lieven6360ab22018-07-13 09:15:39 +02002124#define MAX_BUF_SECTORS 32768
2125
bellardea2384d2004-08-01 21:59:26 +00002126static int img_convert(int argc, char **argv)
2127{
Peter Lieven9fd77f92017-04-21 11:11:55 +02002128 int c, bs_i, flags, src_flags = 0;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002129 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002130 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
2131 *out_filename, *out_baseimg_param, *snapshot_name = NULL;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002132 BlockDriver *drv = NULL, *proto_drv = NULL;
bellardfaea38e2006-08-05 21:31:00 +00002133 BlockDriverInfo bdi;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002134 BlockDriverState *out_bs;
2135 QemuOpts *opts = NULL, *sn_opts = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08002136 QemuOptsList *create_opts = NULL;
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002137 QDict *open_opts = NULL;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002138 char *options = NULL;
Max Reitzcc84d902013-09-06 17:14:26 +02002139 Error *local_err = NULL;
Max Reitz3d96cb92019-05-07 22:35:02 +02002140 bool writethrough, src_writethrough, image_opts = false,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002141 skip_create = false, progress = false, tgt_image_opts = false;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002142 int64_t ret = -EINVAL;
Fam Zheng335e9932017-05-03 00:35:39 +08002143 bool force_share = false;
Fam Zhenge11ce122018-07-27 11:34:01 +08002144 bool explict_min_sparse = false;
bellardea2384d2004-08-01 21:59:26 +00002145
Peter Lieven9fd77f92017-04-21 11:11:55 +02002146 ImgConvertState s = (ImgConvertState) {
2147 /* Need at least 4k of zeros for sparse detection */
2148 .min_sparse = 8,
Fam Zhenge11ce122018-07-27 11:34:01 +08002149 .copy_range = false,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002150 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2151 .wr_in_order = true,
2152 .num_coroutines = 8,
2153 };
2154
bellardea2384d2004-08-01 21:59:26 +00002155 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002156 static const struct option long_options[] = {
2157 {"help", no_argument, 0, 'h'},
2158 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002159 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002160 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002161 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
Max Reitz8eaac022019-05-07 22:35:03 +02002162 {"salvage", no_argument, 0, OPTION_SALVAGE},
David Edmondson168468f2020-02-05 11:02:48 +00002163 {"target-is-zero", no_argument, 0, OPTION_TARGET_IS_ZERO},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002164 {0, 0, 0, 0}
2165 };
Fam Zhenge11ce122018-07-27 11:34:01 +08002166 c = getopt_long(argc, argv, ":hf:O:B:Cco:l:S:pt:T:qnm:WU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002167 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002168 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002169 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002170 }
bellardea2384d2004-08-01 21:59:26 +00002171 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002172 case ':':
2173 missing_argument(argv[optind - 1]);
2174 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002175 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002176 unrecognized_option(argv[optind - 1]);
2177 break;
bellardea2384d2004-08-01 21:59:26 +00002178 case 'h':
2179 help();
2180 break;
2181 case 'f':
2182 fmt = optarg;
2183 break;
2184 case 'O':
2185 out_fmt = optarg;
2186 break;
thsf58c7b32008-06-05 21:53:49 +00002187 case 'B':
2188 out_baseimg = optarg;
2189 break;
Fam Zhenge11ce122018-07-27 11:34:01 +08002190 case 'C':
2191 s.copy_range = true;
2192 break;
bellardea2384d2004-08-01 21:59:26 +00002193 case 'c':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002194 s.compressed = true;
bellardea2384d2004-08-01 21:59:26 +00002195 break;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002196 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02002197 if (accumulate_options(&options, optarg) < 0) {
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002198 goto fail_getopt;
Kevin Wolf2dc83282014-02-21 16:24:05 +01002199 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002200 break;
Wenchao Xiaef806542013-12-04 17:10:57 +08002201 case 'l':
2202 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
Markus Armbruster70b94332015-02-13 12:50:26 +01002203 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2204 optarg, false);
Wenchao Xiaef806542013-12-04 17:10:57 +08002205 if (!sn_opts) {
2206 error_report("Failed in parsing snapshot param '%s'",
2207 optarg);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002208 goto fail_getopt;
Wenchao Xiaef806542013-12-04 17:10:57 +08002209 }
2210 } else {
2211 snapshot_name = optarg;
2212 }
2213 break;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002214 case 'S':
2215 {
2216 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +01002217
Eyal Moscovici43d589b2020-05-13 16:36:26 +03002218 sval = cvtnum("buffer size for sparse output", optarg);
2219 if (sval < 0) {
2220 goto fail_getopt;
2221 } else if (!QEMU_IS_ALIGNED(sval, BDRV_SECTOR_SIZE) ||
Peter Lieven6360ab22018-07-13 09:15:39 +02002222 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2223 error_report("Invalid buffer size for sparse output specified. "
2224 "Valid sizes are multiples of %llu up to %llu. Select "
2225 "0 to disable sparse detection (fully allocates output).",
2226 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002227 goto fail_getopt;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002228 }
2229
Peter Lieven9fd77f92017-04-21 11:11:55 +02002230 s.min_sparse = sval / BDRV_SECTOR_SIZE;
Fam Zhenge11ce122018-07-27 11:34:01 +08002231 explict_min_sparse = true;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002232 break;
2233 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002234 case 'p':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002235 progress = true;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002236 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002237 case 't':
2238 cache = optarg;
2239 break;
Max Reitz40055952014-07-22 22:58:42 +02002240 case 'T':
2241 src_cache = optarg;
2242 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002243 case 'q':
Max Reitz3d96cb92019-05-07 22:35:02 +02002244 s.quiet = true;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002245 break;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002246 case 'n':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002247 skip_create = true;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002248 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002249 case 'm':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002250 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2251 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002252 error_report("Invalid number of coroutines. Allowed number of"
2253 " coroutines is between 1 and %d", MAX_COROUTINES);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002254 goto fail_getopt;
2255 }
2256 break;
2257 case 'W':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002258 s.wr_in_order = false;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002259 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002260 case 'U':
2261 force_share = true;
2262 break;
Max Reitz3258b912017-04-26 15:46:47 +02002263 case OPTION_OBJECT: {
2264 QemuOpts *object_opts;
2265 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
2266 optarg, true);
2267 if (!object_opts) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002268 goto fail_getopt;
2269 }
2270 break;
Max Reitz3258b912017-04-26 15:46:47 +02002271 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002272 case OPTION_IMAGE_OPTS:
2273 image_opts = true;
2274 break;
Max Reitz8eaac022019-05-07 22:35:03 +02002275 case OPTION_SALVAGE:
2276 s.salvage = true;
2277 break;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002278 case OPTION_TARGET_IMAGE_OPTS:
2279 tgt_image_opts = true;
2280 break;
David Edmondson168468f2020-02-05 11:02:48 +00002281 case OPTION_TARGET_IS_ZERO:
2282 /*
2283 * The user asserting that the target is blank has the
2284 * same effect as the target driver supporting zero
2285 * initialisation.
2286 */
2287 s.has_zero_init = true;
2288 break;
bellardea2384d2004-08-01 21:59:26 +00002289 }
2290 }
ths3b46e622007-09-17 08:09:54 +00002291
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002292 if (!out_fmt && !tgt_image_opts) {
2293 out_fmt = "raw";
2294 }
2295
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002296 if (qemu_opts_foreach(&qemu_object_opts,
2297 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02002298 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002299 goto fail_getopt;
2300 }
2301
Fam Zhenge11ce122018-07-27 11:34:01 +08002302 if (s.compressed && s.copy_range) {
2303 error_report("Cannot enable copy offloading when -c is used");
2304 goto fail_getopt;
2305 }
2306
2307 if (explict_min_sparse && s.copy_range) {
2308 error_report("Cannot enable copy offloading when -S is used");
2309 goto fail_getopt;
2310 }
2311
Max Reitz8eaac022019-05-07 22:35:03 +02002312 if (s.copy_range && s.salvage) {
2313 error_report("Cannot use copy offloading in salvaging mode");
2314 goto fail_getopt;
2315 }
2316
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002317 if (tgt_image_opts && !skip_create) {
2318 error_report("--target-image-opts requires use of -n flag");
2319 goto fail_getopt;
2320 }
2321
Kevin Wolfffd8e8f2019-08-09 11:09:21 +02002322 if (skip_create && options) {
2323 warn_report("-o has no effect when skipping image creation");
2324 warn_report("This will become an error in future QEMU versions.");
2325 }
2326
David Edmondson168468f2020-02-05 11:02:48 +00002327 if (s.has_zero_init && !skip_create) {
2328 error_report("--target-is-zero requires use of -n flag");
2329 goto fail_getopt;
2330 }
2331
Peter Lieven9fd77f92017-04-21 11:11:55 +02002332 s.src_num = argc - optind - 1;
2333 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2334
2335 if (options && has_help_option(options)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002336 if (out_fmt) {
2337 ret = print_block_option_help(out_filename, out_fmt);
2338 goto fail_getopt;
2339 } else {
2340 error_report("Option help requires a format be specified");
2341 goto fail_getopt;
2342 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002343 }
2344
2345 if (s.src_num < 1) {
2346 error_report("Must specify image file name");
2347 goto fail_getopt;
2348 }
2349
2350
Peter Lieven9fd77f92017-04-21 11:11:55 +02002351 /* ret is still -EINVAL until here */
2352 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2353 if (ret < 0) {
2354 error_report("Invalid source cache option: %s", src_cache);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002355 goto fail_getopt;
2356 }
2357
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002358 /* Initialize before goto out */
Max Reitz3d96cb92019-05-07 22:35:02 +02002359 if (s.quiet) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002360 progress = false;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002361 }
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002362 qemu_progress_init(progress, 1.0);
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002363 qemu_progress_print(0, 100);
2364
Peter Lieven9fd77f92017-04-21 11:11:55 +02002365 s.src = g_new0(BlockBackend *, s.src_num);
2366 s.src_sectors = g_new(int64_t, s.src_num);
balrog926c2d22007-10-31 01:11:44 +00002367
Peter Lieven9fd77f92017-04-21 11:11:55 +02002368 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2369 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
Max Reitz3d96cb92019-05-07 22:35:02 +02002370 fmt, src_flags, src_writethrough, s.quiet,
Fam Zheng335e9932017-05-03 00:35:39 +08002371 force_share);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002372 if (!s.src[bs_i]) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002373 ret = -1;
2374 goto out;
2375 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002376 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2377 if (s.src_sectors[bs_i] < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002378 error_report("Could not get size of %s: %s",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002379 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002380 ret = -1;
2381 goto out;
2382 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002383 s.total_sectors += s.src_sectors[bs_i];
balrog926c2d22007-10-31 01:11:44 +00002384 }
bellardea2384d2004-08-01 21:59:26 +00002385
Wenchao Xiaef806542013-12-04 17:10:57 +08002386 if (sn_opts) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002387 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
Peter Maydell10d6eda2017-02-10 16:28:24 +00002388 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2389 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2390 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002391 } else if (snapshot_name != NULL) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002392 if (s.src_num > 1) {
Markus Armbruster6daf1942011-06-22 14:03:54 +02002393 error_report("No support for concatenating multiple snapshot");
edison51ef6722010-09-21 19:58:41 -07002394 ret = -1;
2395 goto out;
2396 }
Wenchao Xia7b4c4782013-12-04 17:10:54 +08002397
Peter Lieven9fd77f92017-04-21 11:11:55 +02002398 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2399 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002400 }
Markus Armbruster84d18f02014-01-30 15:07:28 +01002401 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002402 error_reportf_err(local_err, "Failed to load snapshot: ");
Wenchao Xiaef806542013-12-04 17:10:57 +08002403 ret = -1;
2404 goto out;
edison51ef6722010-09-21 19:58:41 -07002405 }
2406
Max Reitz2e024cd2015-02-11 09:58:46 -05002407 if (!skip_create) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002408 /* Find driver and parse its options */
2409 drv = bdrv_find_format(out_fmt);
2410 if (!drv) {
2411 error_report("Unknown file format '%s'", out_fmt);
2412 ret = -1;
2413 goto out;
2414 }
2415
2416 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2417 if (!proto_drv) {
2418 error_report_err(local_err);
2419 ret = -1;
2420 goto out;
2421 }
2422
Max Reitz2e024cd2015-02-11 09:58:46 -05002423 if (!drv->create_opts) {
2424 error_report("Format driver '%s' does not support image creation",
2425 drv->format_name);
2426 ret = -1;
2427 goto out;
2428 }
Max Reitzf75613c2014-12-02 18:32:46 +01002429
Max Reitz2e024cd2015-02-11 09:58:46 -05002430 if (!proto_drv->create_opts) {
2431 error_report("Protocol driver '%s' does not support image creation",
2432 proto_drv->format_name);
2433 ret = -1;
2434 goto out;
2435 }
Max Reitzf75613c2014-12-02 18:32:46 +01002436
Max Reitz2e024cd2015-02-11 09:58:46 -05002437 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2438 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfdb08adf2009-06-04 15:39:38 +02002439
Max Reitz2e024cd2015-02-11 09:58:46 -05002440 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002441 if (options) {
2442 qemu_opts_do_parse(opts, options, NULL, &local_err);
2443 if (local_err) {
Markus Armbruster97a2ca72015-03-14 10:23:15 +01002444 error_report_err(local_err);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002445 ret = -1;
2446 goto out;
2447 }
Max Reitz2e024cd2015-02-11 09:58:46 -05002448 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002449
Peter Lieven9fd77f92017-04-21 11:11:55 +02002450 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
Markus Armbruster39101f22015-02-12 16:46:36 +01002451 &error_abort);
Max Reitz2e024cd2015-02-11 09:58:46 -05002452 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2453 if (ret < 0) {
2454 goto out;
2455 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002456 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002457
Kevin Wolfa18953f2010-10-14 15:46:04 +02002458 /* Get backing file name if -o backing_file was used */
Chunyan Liu83d05212014-06-05 17:20:51 +08002459 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
Kevin Wolfa18953f2010-10-14 15:46:04 +02002460 if (out_baseimg_param) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002461 out_baseimg = out_baseimg_param;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002462 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002463 s.target_has_backing = (bool) out_baseimg;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002464
David Edmondson168468f2020-02-05 11:02:48 +00002465 if (s.has_zero_init && s.target_has_backing) {
2466 error_report("Cannot use --target-is-zero when the destination "
2467 "image has a backing file");
2468 goto out;
2469 }
2470
Max Reitz48758a82017-04-26 15:46:48 +02002471 if (s.src_num > 1 && out_baseimg) {
2472 error_report("Having a backing file for the target makes no sense when "
2473 "concatenating multiple input images");
2474 ret = -1;
2475 goto out;
2476 }
2477
Kevin Wolfefa84d42009-05-18 16:42:12 +02002478 /* Check if compression is supported */
Peter Lieven9fd77f92017-04-21 11:11:55 +02002479 if (s.compressed) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002480 bool encryption =
2481 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002482 const char *encryptfmt =
2483 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
Chunyan Liu83d05212014-06-05 17:20:51 +08002484 const char *preallocation =
2485 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
Kevin Wolfefa84d42009-05-18 16:42:12 +02002486
Vladimir Sementsov-Ogievskiyac850bf2019-06-04 19:15:06 +03002487 if (drv && !block_driver_can_compress(drv)) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002488 error_report("Compression not supported for this file format");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002489 ret = -1;
2490 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002491 }
2492
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002493 if (encryption || encryptfmt) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002494 error_report("Compression and encryption not supported at "
2495 "the same time");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002496 ret = -1;
2497 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002498 }
Kevin Wolf41521fa2011-10-18 16:19:42 +02002499
Chunyan Liu83d05212014-06-05 17:20:51 +08002500 if (preallocation
2501 && strcmp(preallocation, "off"))
Kevin Wolf41521fa2011-10-18 16:19:42 +02002502 {
2503 error_report("Compression and preallocation not supported at "
2504 "the same time");
2505 ret = -1;
2506 goto out;
2507 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002508 }
2509
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002510 /*
2511 * The later open call will need any decryption secrets, and
2512 * bdrv_create() will purge "opts", so extract them now before
2513 * they are lost.
2514 */
2515 if (!skip_create) {
2516 open_opts = qdict_new();
2517 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
2518 }
2519
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002520 if (!skip_create) {
2521 /* Create the new image */
Chunyan Liuc282e1f2014-06-05 17:21:11 +08002522 ret = bdrv_create(drv, out_filename, opts, &local_err);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002523 if (ret < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002524 error_reportf_err(local_err, "%s: error while converting %s: ",
2525 out_filename, out_fmt);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002526 goto out;
bellardea2384d2004-08-01 21:59:26 +00002527 }
2528 }
ths3b46e622007-09-17 08:09:54 +00002529
Max Reitz4d7c4872019-07-24 19:12:29 +02002530 s.target_is_new = !skip_create;
2531
Peter Lieven9fd77f92017-04-21 11:11:55 +02002532 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
Kevin Wolfce099542016-03-15 13:01:04 +01002533 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002534 if (ret < 0) {
2535 error_report("Invalid cache option: %s", cache);
Markus Armbrusterbb9cd2e2014-05-28 11:17:07 +02002536 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002537 }
2538
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002539 if (skip_create) {
2540 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002541 flags, writethrough, s.quiet, false);
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002542 } else {
2543 /* TODO ultimately we should allow --target-image-opts
2544 * to be used even when -n is not given.
2545 * That has to wait for bdrv_create to be improved
2546 * to allow filenames in option syntax
2547 */
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002548 s.target = img_open_file(out_filename, open_opts, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002549 flags, writethrough, s.quiet, false);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002550 open_opts = NULL; /* blk_new_open will have freed it */
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002551 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002552 if (!s.target) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002553 ret = -1;
2554 goto out;
2555 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002556 out_bs = blk_bs(s.target);
bellardea2384d2004-08-01 21:59:26 +00002557
Vladimir Sementsov-Ogievskiyac850bf2019-06-04 19:15:06 +03002558 if (s.compressed && !block_driver_can_compress(out_bs->drv)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002559 error_report("Compression not supported for this file format");
2560 ret = -1;
2561 goto out;
2562 }
2563
Eric Blake5def6b82016-06-23 16:37:19 -06002564 /* increase bufsectors from the default 4096 (2M) if opt_transfer
Peter Lieven6360ab22018-07-13 09:15:39 +02002565 * or discard_alignment of the out_bs is greater. Limit to
2566 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2567 s.buf_sectors = MIN(MAX_BUF_SECTORS,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002568 MAX(s.buf_sectors,
2569 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2570 out_bs->bl.pdiscard_alignment >>
2571 BDRV_SECTOR_BITS)));
Peter Lievenf2521c92013-11-27 11:07:06 +01002572
Peter Lieven8dcd3c92018-07-12 15:00:10 +02002573 /* try to align the write requests to the destination to avoid unnecessary
2574 * RMW cycles. */
2575 s.alignment = MAX(pow2floor(s.min_sparse),
2576 DIV_ROUND_UP(out_bs->bl.request_alignment,
2577 BDRV_SECTOR_SIZE));
2578 assert(is_power_of_2(s.alignment));
2579
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002580 if (skip_create) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002581 int64_t output_sectors = blk_nb_sectors(s.target);
Markus Armbruster43716fa2014-06-26 13:23:21 +02002582 if (output_sectors < 0) {
Gongleieec5eb42015-02-25 12:22:27 +08002583 error_report("unable to get output image length: %s",
Markus Armbruster43716fa2014-06-26 13:23:21 +02002584 strerror(-output_sectors));
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002585 ret = -1;
2586 goto out;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002587 } else if (output_sectors < s.total_sectors) {
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002588 error_report("output file is smaller than input file");
2589 ret = -1;
2590 goto out;
2591 }
2592 }
2593
Max Reitzc69291e2020-01-21 16:59:14 +01002594 if (s.target_has_backing && s.target_is_new) {
Max Reitz351c8ef2018-05-01 18:57:49 +02002595 /* Errors are treated as "backing length unknown" (which means
2596 * s.target_backing_sectors has to be negative, which it will
2597 * be automatically). The backing file length is used only
2598 * for optimizations, so such a case is not fatal. */
2599 s.target_backing_sectors = bdrv_nb_sectors(out_bs->backing->bs);
2600 } else {
2601 s.target_backing_sectors = -1;
2602 }
2603
Peter Lieven24f833c2013-11-27 11:07:07 +01002604 ret = bdrv_get_info(out_bs, &bdi);
2605 if (ret < 0) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002606 if (s.compressed) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002607 error_report("could not get block driver info");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002608 goto out;
2609 }
Peter Lieven24f833c2013-11-27 11:07:07 +01002610 } else {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002611 s.compressed = s.compressed || bdi.needs_compressed_writes;
2612 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
Max Reitz351c8ef2018-05-01 18:57:49 +02002613 s.unallocated_blocks_are_zero = bdi.unallocated_blocks_are_zero;
Peter Lieven24f833c2013-11-27 11:07:07 +01002614 }
2615
Peter Lieven9fd77f92017-04-21 11:11:55 +02002616 ret = convert_do_copy(&s);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002617out:
Peter Lieven13c28af2013-11-27 11:07:01 +01002618 if (!ret) {
2619 qemu_progress_print(100, 0);
2620 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002621 qemu_progress_end();
Chunyan Liu83d05212014-06-05 17:20:51 +08002622 qemu_opts_del(opts);
2623 qemu_opts_free(create_opts);
Markus Armbrusterfbf28a42014-09-29 16:07:55 +02002624 qemu_opts_del(sn_opts);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002625 qobject_unref(open_opts);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002626 blk_unref(s.target);
2627 if (s.src) {
2628 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2629 blk_unref(s.src[bs_i]);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002630 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002631 g_free(s.src);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002632 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002633 g_free(s.src_sectors);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002634fail_getopt:
2635 g_free(options);
2636
Peter Lieven9fd77f92017-04-21 11:11:55 +02002637 return !!ret;
bellardea2384d2004-08-01 21:59:26 +00002638}
2639
bellard57d1a2b2004-08-03 21:15:11 +00002640
bellardfaea38e2006-08-05 21:31:00 +00002641static void dump_snapshots(BlockDriverState *bs)
2642{
2643 QEMUSnapshotInfo *sn_tab, *sn;
2644 int nb_sns, i;
bellardfaea38e2006-08-05 21:31:00 +00002645
2646 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2647 if (nb_sns <= 0)
2648 return;
2649 printf("Snapshot list:\n");
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002650 bdrv_snapshot_dump(NULL);
Wenchao Xia5b917042013-05-25 11:09:45 +08002651 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002652 for(i = 0; i < nb_sns; i++) {
2653 sn = &sn_tab[i];
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002654 bdrv_snapshot_dump(sn);
Wenchao Xia5b917042013-05-25 11:09:45 +08002655 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002656 }
Anthony Liguori7267c092011-08-20 22:09:37 -05002657 g_free(sn_tab);
bellardfaea38e2006-08-05 21:31:00 +00002658}
2659
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002660static void dump_json_image_info_list(ImageInfoList *list)
2661{
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002662 QString *str;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002663 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002664 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002665
2666 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2667 visit_complete(v, &obj);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002668 str = qobject_to_json_pretty(obj);
2669 assert(str != NULL);
2670 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002671 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002672 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002673 qobject_unref(str);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002674}
2675
Benoît Canetc054b3f2012-09-05 13:09:02 +02002676static void dump_json_image_info(ImageInfo *info)
2677{
Benoît Canetc054b3f2012-09-05 13:09:02 +02002678 QString *str;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002679 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002680 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002681
2682 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2683 visit_complete(v, &obj);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002684 str = qobject_to_json_pretty(obj);
2685 assert(str != NULL);
2686 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002687 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002688 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002689 qobject_unref(str);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002690}
2691
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002692static void dump_human_image_info_list(ImageInfoList *list)
2693{
2694 ImageInfoList *elem;
2695 bool delim = false;
2696
2697 for (elem = list; elem; elem = elem->next) {
2698 if (delim) {
2699 printf("\n");
2700 }
2701 delim = true;
2702
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002703 bdrv_image_info_dump(elem->value);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002704 }
2705}
2706
2707static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2708{
2709 return strcmp(a, b) == 0;
2710}
2711
2712/**
2713 * Open an image file chain and return an ImageInfoList
2714 *
2715 * @filename: topmost image filename
2716 * @fmt: topmost image format (may be NULL to autodetect)
2717 * @chain: true - enumerate entire backing file chain
2718 * false - only topmost image file
2719 *
2720 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2721 * image file. If there was an error a message will have been printed to
2722 * stderr.
2723 */
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002724static ImageInfoList *collect_image_info_list(bool image_opts,
2725 const char *filename,
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002726 const char *fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002727 bool chain, bool force_share)
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002728{
2729 ImageInfoList *head = NULL;
2730 ImageInfoList **last = &head;
2731 GHashTable *filenames;
Wenchao Xia43526ec2013-06-06 12:27:58 +08002732 Error *err = NULL;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002733
2734 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2735
2736 while (filename) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02002737 BlockBackend *blk;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002738 BlockDriverState *bs;
2739 ImageInfo *info;
2740 ImageInfoList *elem;
2741
2742 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2743 error_report("Backing file '%s' creates an infinite loop.",
2744 filename);
2745 goto err;
2746 }
2747 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2748
Max Reitzefaa7c42016-03-16 19:54:38 +01002749 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002750 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2751 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002752 if (!blk) {
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002753 goto err;
2754 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002755 bs = blk_bs(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002756
Wenchao Xia43526ec2013-06-06 12:27:58 +08002757 bdrv_query_image_info(bs, &info, &err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002758 if (err) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01002759 error_report_err(err);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002760 blk_unref(blk);
Wenchao Xia43526ec2013-06-06 12:27:58 +08002761 goto err;
Wenchao Xiafb0ed452013-06-06 12:27:57 +08002762 }
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002763
2764 elem = g_new0(ImageInfoList, 1);
2765 elem->value = info;
2766 *last = elem;
2767 last = &elem->next;
2768
Markus Armbruster26f54e92014-10-07 13:59:04 +02002769 blk_unref(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002770
Stefan Hajnoczi0da7d132019-12-05 13:46:46 +00002771 /* Clear parameters that only apply to the topmost image */
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002772 filename = fmt = NULL;
Stefan Hajnoczi0da7d132019-12-05 13:46:46 +00002773 image_opts = false;
2774
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002775 if (chain) {
2776 if (info->has_full_backing_filename) {
2777 filename = info->full_backing_filename;
2778 } else if (info->has_backing_filename) {
John Snow92d617a2015-12-14 14:55:15 -05002779 error_report("Could not determine absolute backing filename,"
2780 " but backing filename '%s' present",
2781 info->backing_filename);
2782 goto err;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002783 }
2784 if (info->has_backing_filename_format) {
2785 fmt = info->backing_filename_format;
2786 }
2787 }
2788 }
2789 g_hash_table_destroy(filenames);
2790 return head;
2791
2792err:
2793 qapi_free_ImageInfoList(head);
2794 g_hash_table_destroy(filenames);
2795 return NULL;
2796}
2797
Benoît Canetc054b3f2012-09-05 13:09:02 +02002798static int img_info(int argc, char **argv)
2799{
2800 int c;
2801 OutputFormat output_format = OFORMAT_HUMAN;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002802 bool chain = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002803 const char *filename, *fmt, *output;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002804 ImageInfoList *list;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002805 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08002806 bool force_share = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002807
bellardea2384d2004-08-01 21:59:26 +00002808 fmt = NULL;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002809 output = NULL;
bellardea2384d2004-08-01 21:59:26 +00002810 for(;;) {
Benoît Canetc054b3f2012-09-05 13:09:02 +02002811 int option_index = 0;
2812 static const struct option long_options[] = {
2813 {"help", no_argument, 0, 'h'},
2814 {"format", required_argument, 0, 'f'},
2815 {"output", required_argument, 0, OPTION_OUTPUT},
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002816 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002817 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002818 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002819 {"force-share", no_argument, 0, 'U'},
Benoît Canetc054b3f2012-09-05 13:09:02 +02002820 {0, 0, 0, 0}
2821 };
Fam Zheng335e9932017-05-03 00:35:39 +08002822 c = getopt_long(argc, argv, ":f:hU",
Benoît Canetc054b3f2012-09-05 13:09:02 +02002823 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002824 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002825 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002826 }
bellardea2384d2004-08-01 21:59:26 +00002827 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002828 case ':':
2829 missing_argument(argv[optind - 1]);
2830 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002831 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002832 unrecognized_option(argv[optind - 1]);
2833 break;
bellardea2384d2004-08-01 21:59:26 +00002834 case 'h':
2835 help();
2836 break;
2837 case 'f':
2838 fmt = optarg;
2839 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002840 case 'U':
2841 force_share = true;
2842 break;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002843 case OPTION_OUTPUT:
2844 output = optarg;
2845 break;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002846 case OPTION_BACKING_CHAIN:
2847 chain = true;
2848 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002849 case OPTION_OBJECT: {
2850 QemuOpts *opts;
2851 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2852 optarg, true);
2853 if (!opts) {
2854 return 1;
2855 }
2856 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002857 case OPTION_IMAGE_OPTS:
2858 image_opts = true;
2859 break;
bellardea2384d2004-08-01 21:59:26 +00002860 }
2861 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02002862 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08002863 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002864 }
bellardea2384d2004-08-01 21:59:26 +00002865 filename = argv[optind++];
2866
Benoît Canetc054b3f2012-09-05 13:09:02 +02002867 if (output && !strcmp(output, "json")) {
2868 output_format = OFORMAT_JSON;
2869 } else if (output && !strcmp(output, "human")) {
2870 output_format = OFORMAT_HUMAN;
2871 } else if (output) {
2872 error_report("--output must be used with human or json as argument.");
2873 return 1;
2874 }
2875
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002876 if (qemu_opts_foreach(&qemu_object_opts,
2877 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02002878 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002879 return 1;
2880 }
2881
Fam Zheng335e9932017-05-03 00:35:39 +08002882 list = collect_image_info_list(image_opts, filename, fmt, chain,
2883 force_share);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002884 if (!list) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002885 return 1;
2886 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002887
Benoît Canetc054b3f2012-09-05 13:09:02 +02002888 switch (output_format) {
2889 case OFORMAT_HUMAN:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002890 dump_human_image_info_list(list);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002891 break;
2892 case OFORMAT_JSON:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002893 if (chain) {
2894 dump_json_image_info_list(list);
2895 } else {
2896 dump_json_image_info(list->value);
2897 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002898 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002899 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002900
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002901 qapi_free_ImageInfoList(list);
bellardea2384d2004-08-01 21:59:26 +00002902 return 0;
2903}
2904
Eric Blake30065d12019-03-26 13:40:43 -05002905static int dump_map_entry(OutputFormat output_format, MapEntry *e,
2906 MapEntry *next)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002907{
2908 switch (output_format) {
2909 case OFORMAT_HUMAN:
Fam Zheng16b0d552016-01-26 11:59:02 +08002910 if (e->data && !e->has_offset) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002911 error_report("File contains external, encrypted or compressed clusters.");
Eric Blake30065d12019-03-26 13:40:43 -05002912 return -1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002913 }
Fam Zheng16b0d552016-01-26 11:59:02 +08002914 if (e->data && !e->zero) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002915 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
Fam Zheng16b0d552016-01-26 11:59:02 +08002916 e->start, e->length,
2917 e->has_offset ? e->offset : 0,
2918 e->has_filename ? e->filename : "");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002919 }
2920 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2921 * Modify the flags here to allow more coalescing.
2922 */
Fam Zheng16b0d552016-01-26 11:59:02 +08002923 if (next && (!next->data || next->zero)) {
2924 next->data = false;
2925 next->zero = true;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002926 }
2927 break;
2928 case OFORMAT_JSON:
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03002929 printf("{ \"start\": %"PRId64", \"length\": %"PRId64","
Fam Zheng16b0d552016-01-26 11:59:02 +08002930 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002931 e->start, e->length, e->depth,
Fam Zheng16b0d552016-01-26 11:59:02 +08002932 e->zero ? "true" : "false",
2933 e->data ? "true" : "false");
2934 if (e->has_offset) {
Paolo Bonzinic745bfb2013-09-11 18:47:52 +02002935 printf(", \"offset\": %"PRId64"", e->offset);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002936 }
2937 putchar('}');
2938
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03002939 if (next) {
2940 puts(",");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002941 }
2942 break;
2943 }
Eric Blake30065d12019-03-26 13:40:43 -05002944 return 0;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002945}
2946
Eric Blake5e344dd2017-10-11 22:47:02 -05002947static int get_block_status(BlockDriverState *bs, int64_t offset,
2948 int64_t bytes, MapEntry *e)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002949{
Eric Blake237d78f2017-10-11 22:47:03 -05002950 int ret;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002951 int depth;
Fam Zheng67a0fd22016-01-26 11:58:48 +08002952 BlockDriverState *file;
John Snow28756452016-02-05 13:12:33 -05002953 bool has_offset;
Eric Blake237d78f2017-10-11 22:47:03 -05002954 int64_t map;
Max Reitzf30c66b2019-02-01 20:29:05 +01002955 char *filename = NULL;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002956
2957 /* As an optimization, we could cache the current range of unallocated
2958 * clusters in each file of the chain, and avoid querying the same
2959 * range repeatedly.
2960 */
2961
2962 depth = 0;
2963 for (;;) {
Eric Blake237d78f2017-10-11 22:47:03 -05002964 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002965 if (ret < 0) {
2966 return ret;
2967 }
Eric Blake237d78f2017-10-11 22:47:03 -05002968 assert(bytes);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002969 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2970 break;
2971 }
Kevin Wolf760e0062015-06-17 14:55:21 +02002972 bs = backing_bs(bs);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002973 if (bs == NULL) {
2974 ret = 0;
2975 break;
2976 }
2977
2978 depth++;
2979 }
2980
John Snow28756452016-02-05 13:12:33 -05002981 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
2982
Max Reitzf30c66b2019-02-01 20:29:05 +01002983 if (file && has_offset) {
2984 bdrv_refresh_filename(file);
2985 filename = file->filename;
2986 }
2987
John Snow28756452016-02-05 13:12:33 -05002988 *e = (MapEntry) {
Eric Blake5e344dd2017-10-11 22:47:02 -05002989 .start = offset,
Eric Blake237d78f2017-10-11 22:47:03 -05002990 .length = bytes,
John Snow28756452016-02-05 13:12:33 -05002991 .data = !!(ret & BDRV_BLOCK_DATA),
2992 .zero = !!(ret & BDRV_BLOCK_ZERO),
Eric Blake237d78f2017-10-11 22:47:03 -05002993 .offset = map,
John Snow28756452016-02-05 13:12:33 -05002994 .has_offset = has_offset,
2995 .depth = depth,
Max Reitzf30c66b2019-02-01 20:29:05 +01002996 .has_filename = filename,
2997 .filename = filename,
John Snow28756452016-02-05 13:12:33 -05002998 };
2999
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003000 return 0;
3001}
3002
Fam Zheng16b0d552016-01-26 11:59:02 +08003003static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
3004{
3005 if (curr->length == 0) {
3006 return false;
3007 }
3008 if (curr->zero != next->zero ||
3009 curr->data != next->data ||
3010 curr->depth != next->depth ||
3011 curr->has_filename != next->has_filename ||
3012 curr->has_offset != next->has_offset) {
3013 return false;
3014 }
3015 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
3016 return false;
3017 }
3018 if (curr->has_offset && curr->offset + curr->length != next->offset) {
3019 return false;
3020 }
3021 return true;
3022}
3023
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003024static int img_map(int argc, char **argv)
3025{
3026 int c;
3027 OutputFormat output_format = OFORMAT_HUMAN;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003028 BlockBackend *blk;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003029 BlockDriverState *bs;
3030 const char *filename, *fmt, *output;
3031 int64_t length;
3032 MapEntry curr = { .length = 0 }, next;
3033 int ret = 0;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003034 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003035 bool force_share = false;
Eyal Moscovicic0469492020-05-13 16:36:29 +03003036 int64_t start_offset = 0;
3037 int64_t max_length = -1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003038
3039 fmt = NULL;
3040 output = NULL;
3041 for (;;) {
3042 int option_index = 0;
3043 static const struct option long_options[] = {
3044 {"help", no_argument, 0, 'h'},
3045 {"format", required_argument, 0, 'f'},
3046 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003047 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003048 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003049 {"force-share", no_argument, 0, 'U'},
Eyal Moscovicic0469492020-05-13 16:36:29 +03003050 {"start-offset", required_argument, 0, 's'},
3051 {"max-length", required_argument, 0, 'l'},
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003052 {0, 0, 0, 0}
3053 };
Eyal Moscovicic0469492020-05-13 16:36:29 +03003054 c = getopt_long(argc, argv, ":f:s:l:hU",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003055 long_options, &option_index);
3056 if (c == -1) {
3057 break;
3058 }
3059 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003060 case ':':
3061 missing_argument(argv[optind - 1]);
3062 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003063 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003064 unrecognized_option(argv[optind - 1]);
3065 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003066 case 'h':
3067 help();
3068 break;
3069 case 'f':
3070 fmt = optarg;
3071 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003072 case 'U':
3073 force_share = true;
3074 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003075 case OPTION_OUTPUT:
3076 output = optarg;
3077 break;
Eyal Moscovicic0469492020-05-13 16:36:29 +03003078 case 's':
3079 start_offset = cvtnum("start offset", optarg);
3080 if (start_offset < 0) {
3081 return 1;
3082 }
3083 break;
3084 case 'l':
3085 max_length = cvtnum("max length", optarg);
3086 if (max_length < 0) {
3087 return 1;
3088 }
3089 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003090 case OPTION_OBJECT: {
3091 QemuOpts *opts;
3092 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3093 optarg, true);
3094 if (!opts) {
3095 return 1;
3096 }
3097 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003098 case OPTION_IMAGE_OPTS:
3099 image_opts = true;
3100 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003101 }
3102 }
Fam Zhengac1307a2014-04-22 13:36:11 +08003103 if (optind != argc - 1) {
3104 error_exit("Expecting one image file name");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003105 }
Fam Zhengac1307a2014-04-22 13:36:11 +08003106 filename = argv[optind];
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003107
3108 if (output && !strcmp(output, "json")) {
3109 output_format = OFORMAT_JSON;
3110 } else if (output && !strcmp(output, "human")) {
3111 output_format = OFORMAT_HUMAN;
3112 } else if (output) {
3113 error_report("--output must be used with human or json as argument.");
3114 return 1;
3115 }
3116
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003117 if (qemu_opts_foreach(&qemu_object_opts,
3118 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02003119 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003120 return 1;
3121 }
3122
Fam Zheng335e9932017-05-03 00:35:39 +08003123 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003124 if (!blk) {
3125 return 1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003126 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003127 bs = blk_bs(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003128
3129 if (output_format == OFORMAT_HUMAN) {
3130 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003131 } else if (output_format == OFORMAT_JSON) {
3132 putchar('[');
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003133 }
3134
Max Reitzf1d3cd72015-02-05 13:58:18 -05003135 length = blk_getlength(blk);
Eyal Moscovici8f282e82020-05-13 16:36:27 +03003136 if (length < 0) {
3137 error_report("Failed to get size for '%s'", filename);
3138 return 1;
3139 }
Eyal Moscovicic0469492020-05-13 16:36:29 +03003140 if (max_length != -1) {
3141 length = MIN(start_offset + max_length, length);
3142 }
Eyal Moscovici8f282e82020-05-13 16:36:27 +03003143
Eyal Moscovicic0469492020-05-13 16:36:29 +03003144 curr.start = start_offset;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003145 while (curr.start + curr.length < length) {
Eric Blake5e344dd2017-10-11 22:47:02 -05003146 int64_t offset = curr.start + curr.length;
3147 int64_t n;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003148
3149 /* Probe up to 1 GiB at a time. */
Stefano Garzarella97ede572019-05-08 12:43:24 +02003150 n = MIN(1 * GiB, length - offset);
Eric Blake5e344dd2017-10-11 22:47:02 -05003151 ret = get_block_status(bs, offset, n, &next);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003152
3153 if (ret < 0) {
3154 error_report("Could not read file metadata: %s", strerror(-ret));
3155 goto out;
3156 }
3157
Fam Zheng16b0d552016-01-26 11:59:02 +08003158 if (entry_mergeable(&curr, &next)) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003159 curr.length += next.length;
3160 continue;
3161 }
3162
3163 if (curr.length > 0) {
Eric Blake30065d12019-03-26 13:40:43 -05003164 ret = dump_map_entry(output_format, &curr, &next);
3165 if (ret < 0) {
3166 goto out;
3167 }
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003168 }
3169 curr = next;
3170 }
3171
Eric Blake30065d12019-03-26 13:40:43 -05003172 ret = dump_map_entry(output_format, &curr, NULL);
Eyal Moscovicie46c0b12020-05-13 16:36:28 +03003173 if (output_format == OFORMAT_JSON) {
3174 puts("]");
3175 }
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003176
3177out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003178 blk_unref(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003179 return ret < 0;
3180}
3181
aliguorif7b4a942009-01-07 17:40:15 +00003182#define SNAPSHOT_LIST 1
3183#define SNAPSHOT_CREATE 2
3184#define SNAPSHOT_APPLY 3
3185#define SNAPSHOT_DELETE 4
3186
Stuart Brady153859b2009-06-07 00:42:17 +01003187static int img_snapshot(int argc, char **argv)
aliguorif7b4a942009-01-07 17:40:15 +00003188{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003189 BlockBackend *blk;
aliguorif7b4a942009-01-07 17:40:15 +00003190 BlockDriverState *bs;
3191 QEMUSnapshotInfo sn;
3192 char *filename, *snapshot_name = NULL;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003193 int c, ret = 0, bdrv_oflags;
aliguorif7b4a942009-01-07 17:40:15 +00003194 int action = 0;
3195 qemu_timeval tv;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003196 bool quiet = false;
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003197 Error *err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003198 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003199 bool force_share = false;
aliguorif7b4a942009-01-07 17:40:15 +00003200
Kevin Wolfce099542016-03-15 13:01:04 +01003201 bdrv_oflags = BDRV_O_RDWR;
aliguorif7b4a942009-01-07 17:40:15 +00003202 /* Parse commandline parameters */
3203 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003204 static const struct option long_options[] = {
3205 {"help", no_argument, 0, 'h'},
3206 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003207 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003208 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003209 {0, 0, 0, 0}
3210 };
Fam Zheng335e9932017-05-03 00:35:39 +08003211 c = getopt_long(argc, argv, ":la:c:d:hqU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003212 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003213 if (c == -1) {
aliguorif7b4a942009-01-07 17:40:15 +00003214 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003215 }
aliguorif7b4a942009-01-07 17:40:15 +00003216 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003217 case ':':
3218 missing_argument(argv[optind - 1]);
3219 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003220 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003221 unrecognized_option(argv[optind - 1]);
3222 break;
aliguorif7b4a942009-01-07 17:40:15 +00003223 case 'h':
3224 help();
Stuart Brady153859b2009-06-07 00:42:17 +01003225 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003226 case 'l':
3227 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003228 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003229 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003230 }
3231 action = SNAPSHOT_LIST;
Naphtali Spreif5edb012010-01-17 16:48:13 +02003232 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
aliguorif7b4a942009-01-07 17:40:15 +00003233 break;
3234 case 'a':
3235 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003236 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003237 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003238 }
3239 action = SNAPSHOT_APPLY;
3240 snapshot_name = optarg;
3241 break;
3242 case 'c':
3243 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003244 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003245 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003246 }
3247 action = SNAPSHOT_CREATE;
3248 snapshot_name = optarg;
3249 break;
3250 case 'd':
3251 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003252 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003253 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003254 }
3255 action = SNAPSHOT_DELETE;
3256 snapshot_name = optarg;
3257 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003258 case 'q':
3259 quiet = true;
3260 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003261 case 'U':
3262 force_share = true;
3263 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003264 case OPTION_OBJECT: {
3265 QemuOpts *opts;
3266 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3267 optarg, true);
3268 if (!opts) {
3269 return 1;
3270 }
3271 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003272 case OPTION_IMAGE_OPTS:
3273 image_opts = true;
3274 break;
aliguorif7b4a942009-01-07 17:40:15 +00003275 }
3276 }
3277
Kevin Wolffc11eb22013-08-05 10:53:04 +02003278 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003279 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003280 }
aliguorif7b4a942009-01-07 17:40:15 +00003281 filename = argv[optind++];
3282
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003283 if (qemu_opts_foreach(&qemu_object_opts,
3284 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02003285 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003286 return 1;
3287 }
3288
aliguorif7b4a942009-01-07 17:40:15 +00003289 /* Open the image */
Fam Zheng335e9932017-05-03 00:35:39 +08003290 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3291 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003292 if (!blk) {
3293 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003294 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003295 bs = blk_bs(blk);
aliguorif7b4a942009-01-07 17:40:15 +00003296
3297 /* Perform the requested action */
3298 switch(action) {
3299 case SNAPSHOT_LIST:
3300 dump_snapshots(bs);
3301 break;
3302
3303 case SNAPSHOT_CREATE:
3304 memset(&sn, 0, sizeof(sn));
3305 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3306
3307 qemu_gettimeofday(&tv);
3308 sn.date_sec = tv.tv_sec;
3309 sn.date_nsec = tv.tv_usec * 1000;
3310
3311 ret = bdrv_snapshot_create(bs, &sn);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003312 if (ret) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003313 error_report("Could not create snapshot '%s': %d (%s)",
aliguorif7b4a942009-01-07 17:40:15 +00003314 snapshot_name, ret, strerror(-ret));
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003315 }
aliguorif7b4a942009-01-07 17:40:15 +00003316 break;
3317
3318 case SNAPSHOT_APPLY:
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003319 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003320 if (ret) {
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003321 error_reportf_err(err, "Could not apply snapshot '%s': ",
3322 snapshot_name);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003323 }
aliguorif7b4a942009-01-07 17:40:15 +00003324 break;
3325
3326 case SNAPSHOT_DELETE:
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003327 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3328 if (ret < 0) {
3329 error_report("Could not delete snapshot '%s': snapshot not "
3330 "found", snapshot_name);
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003331 ret = 1;
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003332 } else {
3333 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3334 if (ret < 0) {
3335 error_reportf_err(err, "Could not delete snapshot '%s': ",
3336 snapshot_name);
3337 ret = 1;
3338 }
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003339 }
aliguorif7b4a942009-01-07 17:40:15 +00003340 break;
3341 }
3342
3343 /* Cleanup */
Markus Armbruster26f54e92014-10-07 13:59:04 +02003344 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003345 if (ret) {
3346 return 1;
3347 }
Stuart Brady153859b2009-06-07 00:42:17 +01003348 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003349}
3350
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003351static int img_rebase(int argc, char **argv)
3352{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003353 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
Paolo Bonzini396374c2016-02-25 23:53:54 +01003354 uint8_t *buf_old = NULL;
3355 uint8_t *buf_new = NULL;
Sam Eiderman863cc782019-05-23 19:33:36 +03003356 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003357 char *filename;
Max Reitz40055952014-07-22 22:58:42 +02003358 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3359 int c, flags, src_flags, ret;
Kevin Wolfce099542016-03-15 13:01:04 +01003360 bool writethrough, src_writethrough;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003361 int unsafe = 0;
Fam Zheng335e9932017-05-03 00:35:39 +08003362 bool force_share = false;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003363 int progress = 0;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003364 bool quiet = false;
Max Reitz34b5d2c2013-09-05 14:45:29 +02003365 Error *local_err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003366 bool image_opts = false;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003367
3368 /* Parse commandline parameters */
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003369 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003370 cache = BDRV_DEFAULT_CACHE;
Max Reitz40055952014-07-22 22:58:42 +02003371 src_cache = BDRV_DEFAULT_CACHE;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003372 out_baseimg = NULL;
3373 out_basefmt = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003374 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003375 static const struct option long_options[] = {
3376 {"help", no_argument, 0, 'h'},
3377 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003378 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003379 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003380 {0, 0, 0, 0}
3381 };
Fam Zheng335e9932017-05-03 00:35:39 +08003382 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003383 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003384 if (c == -1) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003385 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003386 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003387 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003388 case ':':
3389 missing_argument(argv[optind - 1]);
3390 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003391 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003392 unrecognized_option(argv[optind - 1]);
3393 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003394 case 'h':
3395 help();
3396 return 0;
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003397 case 'f':
3398 fmt = optarg;
3399 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003400 case 'F':
3401 out_basefmt = optarg;
3402 break;
3403 case 'b':
3404 out_baseimg = optarg;
3405 break;
3406 case 'u':
3407 unsafe = 1;
3408 break;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003409 case 'p':
3410 progress = 1;
3411 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003412 case 't':
3413 cache = optarg;
3414 break;
Max Reitz40055952014-07-22 22:58:42 +02003415 case 'T':
3416 src_cache = optarg;
3417 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003418 case 'q':
3419 quiet = true;
3420 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003421 case OPTION_OBJECT: {
3422 QemuOpts *opts;
3423 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3424 optarg, true);
3425 if (!opts) {
3426 return 1;
3427 }
3428 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003429 case OPTION_IMAGE_OPTS:
3430 image_opts = true;
3431 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003432 case 'U':
3433 force_share = true;
3434 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003435 }
3436 }
3437
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003438 if (quiet) {
3439 progress = 0;
3440 }
3441
Fam Zhengac1307a2014-04-22 13:36:11 +08003442 if (optind != argc - 1) {
3443 error_exit("Expecting one image file name");
3444 }
3445 if (!unsafe && !out_baseimg) {
3446 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003447 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003448 filename = argv[optind++];
3449
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003450 if (qemu_opts_foreach(&qemu_object_opts,
3451 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02003452 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003453 return 1;
3454 }
3455
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003456 qemu_progress_init(progress, 2.0);
3457 qemu_progress_print(0, 100);
3458
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003459 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
Kevin Wolfce099542016-03-15 13:01:04 +01003460 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003461 if (ret < 0) {
3462 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003463 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003464 }
3465
Kevin Wolfce099542016-03-15 13:01:04 +01003466 src_flags = 0;
3467 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
Max Reitz40055952014-07-22 22:58:42 +02003468 if (ret < 0) {
3469 error_report("Invalid source cache option: %s", src_cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003470 goto out;
Max Reitz40055952014-07-22 22:58:42 +02003471 }
3472
Kevin Wolfce099542016-03-15 13:01:04 +01003473 /* The source files are opened read-only, don't care about WCE */
3474 assert((src_flags & BDRV_O_RDWR) == 0);
3475 (void) src_writethrough;
3476
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003477 /*
3478 * Open the images.
3479 *
3480 * Ignore the old backing file for unsafe rebase in case we want to correct
3481 * the reference to a renamed or moved backing file.
3482 */
Fam Zheng335e9932017-05-03 00:35:39 +08003483 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3484 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003485 if (!blk) {
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003486 ret = -1;
3487 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003488 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003489 bs = blk_bs(blk);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003490
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003491 if (out_basefmt != NULL) {
Max Reitz644483d2015-02-05 13:58:17 -05003492 if (bdrv_find_format(out_basefmt) == NULL) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003493 error_report("Invalid format name: '%s'", out_basefmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003494 ret = -1;
3495 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003496 }
3497 }
3498
3499 /* For safe rebasing we need to compare old and new backing file */
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003500 if (!unsafe) {
Max Reitz644483d2015-02-05 13:58:17 -05003501 QDict *options = NULL;
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003502 BlockDriverState *base_bs = backing_bs(bs);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003503
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003504 if (base_bs) {
Kevin Wolfd861ab32019-04-25 14:25:10 +02003505 blk_old_backing = blk_new(qemu_get_aio_context(),
3506 BLK_PERM_CONSISTENT_READ,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003507 BLK_PERM_ALL);
3508 ret = blk_insert_bs(blk_old_backing, base_bs,
3509 &local_err);
3510 if (ret < 0) {
Max Reitz35ddd932019-05-09 19:52:35 +02003511 error_reportf_err(local_err,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003512 "Could not reuse old backing file '%s': ",
3513 base_bs->filename);
Max Reitz35ddd932019-05-09 19:52:35 +02003514 goto out;
3515 }
3516 } else {
3517 blk_old_backing = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003518 }
Max Reitz644483d2015-02-05 13:58:17 -05003519
Alex Bligha6166732012-10-16 13:46:18 +01003520 if (out_baseimg[0]) {
Max Reitzd16699b2018-05-09 20:20:01 +02003521 const char *overlay_filename;
3522 char *out_real_path;
3523
Fam Zheng335e9932017-05-03 00:35:39 +08003524 options = qdict_new();
Max Reitz644483d2015-02-05 13:58:17 -05003525 if (out_basefmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003526 qdict_put_str(options, "driver", out_basefmt);
Fam Zheng335e9932017-05-03 00:35:39 +08003527 }
3528 if (force_share) {
3529 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Max Reitz644483d2015-02-05 13:58:17 -05003530 }
3531
Max Reitzf30c66b2019-02-01 20:29:05 +01003532 bdrv_refresh_filename(bs);
Max Reitzd16699b2018-05-09 20:20:01 +02003533 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3534 : bs->filename;
Max Reitz645ae7d2019-02-01 20:29:14 +01003535 out_real_path =
3536 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3537 out_baseimg,
3538 &local_err);
Max Reitzd16699b2018-05-09 20:20:01 +02003539 if (local_err) {
Max Reitzf22356d2019-05-28 21:53:38 +02003540 qobject_unref(options);
Max Reitzd16699b2018-05-09 20:20:01 +02003541 error_reportf_err(local_err,
3542 "Could not resolve backing filename: ");
3543 ret = -1;
Max Reitzd16699b2018-05-09 20:20:01 +02003544 goto out;
3545 }
3546
Sam Eiderman863cc782019-05-23 19:33:36 +03003547 /*
3548 * Find out whether we rebase an image on top of a previous image
3549 * in its chain.
3550 */
3551 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
Sam Eiderman330c7292019-05-23 19:33:37 +03003552 if (prefix_chain_bs) {
Max Reitzf22356d2019-05-28 21:53:38 +02003553 qobject_unref(options);
Sam Eiderman330c7292019-05-23 19:33:37 +03003554 g_free(out_real_path);
Max Reitzf22356d2019-05-28 21:53:38 +02003555
Kevin Wolfd861ab32019-04-25 14:25:10 +02003556 blk_new_backing = blk_new(qemu_get_aio_context(),
3557 BLK_PERM_CONSISTENT_READ,
Sam Eiderman330c7292019-05-23 19:33:37 +03003558 BLK_PERM_ALL);
3559 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
3560 &local_err);
3561 if (ret < 0) {
3562 error_reportf_err(local_err,
3563 "Could not reuse backing file '%s': ",
3564 out_baseimg);
3565 goto out;
3566 }
3567 } else {
3568 blk_new_backing = blk_new_open(out_real_path, NULL,
3569 options, src_flags, &local_err);
3570 g_free(out_real_path);
3571 if (!blk_new_backing) {
3572 error_reportf_err(local_err,
3573 "Could not open new backing file '%s': ",
3574 out_baseimg);
3575 ret = -1;
3576 goto out;
3577 }
Alex Bligha6166732012-10-16 13:46:18 +01003578 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003579 }
3580 }
3581
3582 /*
3583 * Check each unallocated cluster in the COW file. If it is unallocated,
3584 * accesses go to the backing file. We must therefore compare this cluster
3585 * in the old and new backing file, and if they differ we need to copy it
3586 * from the old backing file into the COW file.
3587 *
3588 * If qemu-img crashes during this step, no harm is done. The content of
3589 * the image is the same as the original one at any time.
3590 */
3591 if (!unsafe) {
Eric Blake41536282017-10-11 22:47:15 -05003592 int64_t size;
Max Reitz35ddd932019-05-09 19:52:35 +02003593 int64_t old_backing_size = 0;
Eric Blake41536282017-10-11 22:47:15 -05003594 int64_t new_backing_size = 0;
3595 uint64_t offset;
3596 int64_t n;
Kevin Wolf1f710492012-10-12 14:29:18 +02003597 float local_progress = 0;
TeLeMand6771bf2010-02-08 16:20:00 +08003598
Max Reitzf1d3cd72015-02-05 13:58:18 -05003599 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3600 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003601
Eric Blake41536282017-10-11 22:47:15 -05003602 size = blk_getlength(blk);
3603 if (size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003604 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003605 filename, strerror(-size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003606 ret = -1;
3607 goto out;
3608 }
Max Reitz35ddd932019-05-09 19:52:35 +02003609 if (blk_old_backing) {
3610 old_backing_size = blk_getlength(blk_old_backing);
3611 if (old_backing_size < 0) {
3612 char backing_name[PATH_MAX];
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003613
Max Reitz35ddd932019-05-09 19:52:35 +02003614 bdrv_get_backing_filename(bs, backing_name,
3615 sizeof(backing_name));
3616 error_report("Could not get size of '%s': %s",
3617 backing_name, strerror(-old_backing_size));
3618 ret = -1;
3619 goto out;
3620 }
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003621 }
Max Reitzf1d3cd72015-02-05 13:58:18 -05003622 if (blk_new_backing) {
Eric Blake41536282017-10-11 22:47:15 -05003623 new_backing_size = blk_getlength(blk_new_backing);
3624 if (new_backing_size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003625 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003626 out_baseimg, strerror(-new_backing_size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003627 ret = -1;
3628 goto out;
3629 }
Alex Bligha6166732012-10-16 13:46:18 +01003630 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003631
Eric Blake41536282017-10-11 22:47:15 -05003632 if (size != 0) {
3633 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
Kevin Wolf1f710492012-10-12 14:29:18 +02003634 }
3635
Eric Blake41536282017-10-11 22:47:15 -05003636 for (offset = 0; offset < size; offset += n) {
Max Reitz1c6e8772019-05-09 19:52:36 +02003637 bool buf_old_is_zero = false;
3638
Eric Blake41536282017-10-11 22:47:15 -05003639 /* How many bytes can we handle with the next read? */
3640 n = MIN(IO_BUF_SIZE, size - offset);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003641
3642 /* If the cluster is allocated, we don't need to take action */
Eric Blake41536282017-10-11 22:47:15 -05003643 ret = bdrv_is_allocated(bs, offset, n, &n);
Paolo Bonzinid6636402013-09-04 19:00:25 +02003644 if (ret < 0) {
3645 error_report("error while reading image metadata: %s",
3646 strerror(-ret));
3647 goto out;
3648 }
Kevin Wolfcc60e322010-04-29 14:47:48 +02003649 if (ret) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003650 continue;
3651 }
3652
Sam Eiderman863cc782019-05-23 19:33:36 +03003653 if (prefix_chain_bs) {
3654 /*
3655 * If cluster wasn't changed since prefix_chain, we don't need
3656 * to take action
3657 */
3658 ret = bdrv_is_allocated_above(backing_bs(bs), prefix_chain_bs,
Andrey Shinkevich170d3bd2019-05-29 20:56:14 +03003659 false, offset, n, &n);
Sam Eiderman863cc782019-05-23 19:33:36 +03003660 if (ret < 0) {
3661 error_report("error while reading image metadata: %s",
3662 strerror(-ret));
3663 goto out;
3664 }
3665 if (!ret) {
3666 continue;
3667 }
3668 }
3669
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003670 /*
3671 * Read old and new backing file and take into consideration that
3672 * backing files may be smaller than the COW image.
3673 */
Eric Blake41536282017-10-11 22:47:15 -05003674 if (offset >= old_backing_size) {
3675 memset(buf_old, 0, n);
Max Reitz1c6e8772019-05-09 19:52:36 +02003676 buf_old_is_zero = true;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003677 } else {
Eric Blake41536282017-10-11 22:47:15 -05003678 if (offset + n > old_backing_size) {
3679 n = old_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003680 }
3681
Eric Blake41536282017-10-11 22:47:15 -05003682 ret = blk_pread(blk_old_backing, offset, buf_old, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003683 if (ret < 0) {
3684 error_report("error while reading from old backing file");
3685 goto out;
3686 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003687 }
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003688
Eric Blake41536282017-10-11 22:47:15 -05003689 if (offset >= new_backing_size || !blk_new_backing) {
3690 memset(buf_new, 0, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003691 } else {
Eric Blake41536282017-10-11 22:47:15 -05003692 if (offset + n > new_backing_size) {
3693 n = new_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003694 }
3695
Eric Blake41536282017-10-11 22:47:15 -05003696 ret = blk_pread(blk_new_backing, offset, buf_new, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003697 if (ret < 0) {
3698 error_report("error while reading from new backing file");
3699 goto out;
3700 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003701 }
3702
3703 /* If they differ, we need to write to the COW file */
3704 uint64_t written = 0;
3705
Eric Blake41536282017-10-11 22:47:15 -05003706 while (written < n) {
Eric Blakedc61cd32017-10-11 22:47:14 -05003707 int64_t pnum;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003708
Eric Blake41536282017-10-11 22:47:15 -05003709 if (compare_buffers(buf_old + written, buf_new + written,
3710 n - written, &pnum))
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003711 {
Max Reitz1c6e8772019-05-09 19:52:36 +02003712 if (buf_old_is_zero) {
3713 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0);
3714 } else {
3715 ret = blk_pwrite(blk, offset + written,
3716 buf_old + written, pnum, 0);
3717 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003718 if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003719 error_report("Error while writing to COW image: %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003720 strerror(-ret));
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003721 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003722 }
3723 }
3724
3725 written += pnum;
3726 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003727 qemu_progress_print(local_progress, 100);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003728 }
3729 }
3730
3731 /*
3732 * Change the backing file. All clusters that are different from the old
3733 * backing file are overwritten in the COW file now, so the visible content
3734 * doesn't change when we switch the backing file.
3735 */
Alex Bligha6166732012-10-16 13:46:18 +01003736 if (out_baseimg && *out_baseimg) {
3737 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
3738 } else {
3739 ret = bdrv_change_backing_file(bs, NULL, NULL);
3740 }
3741
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003742 if (ret == -ENOSPC) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003743 error_report("Could not change the backing file to '%s': No "
3744 "space left in the file header", out_baseimg);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003745 } else if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003746 error_report("Could not change the backing file to '%s': %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003747 out_baseimg, strerror(-ret));
3748 }
3749
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003750 qemu_progress_print(100, 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003751 /*
3752 * TODO At this point it is possible to check if any clusters that are
3753 * allocated in the COW file are the same in the backing file. If so, they
3754 * could be dropped from the COW file. Don't do this before switching the
3755 * backing file, in case of a crash this would lead to corruption.
3756 */
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003757out:
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003758 qemu_progress_end();
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003759 /* Cleanup */
3760 if (!unsafe) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02003761 blk_unref(blk_old_backing);
Markus Armbruster26f54e92014-10-07 13:59:04 +02003762 blk_unref(blk_new_backing);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003763 }
Paolo Bonzini396374c2016-02-25 23:53:54 +01003764 qemu_vfree(buf_old);
3765 qemu_vfree(buf_new);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003766
Markus Armbruster26f54e92014-10-07 13:59:04 +02003767 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003768 if (ret) {
3769 return 1;
3770 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003771 return 0;
3772}
3773
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003774static int img_resize(int argc, char **argv)
3775{
Markus Armbruster6750e792015-02-12 17:43:08 +01003776 Error *err = NULL;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003777 int c, ret, relative;
3778 const char *filename, *fmt, *size;
Max Reitz09c5c6d2019-09-18 11:51:44 +02003779 int64_t n, total_size, current_size;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003780 bool quiet = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003781 BlockBackend *blk = NULL;
Max Reitzdc5f6902017-06-13 22:20:55 +02003782 PreallocMode prealloc = PREALLOC_MODE_OFF;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003783 QemuOpts *param;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003784
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003785 static QemuOptsList resize_options = {
3786 .name = "resize_options",
3787 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3788 .desc = {
3789 {
3790 .name = BLOCK_OPT_SIZE,
3791 .type = QEMU_OPT_SIZE,
3792 .help = "Virtual disk size"
3793 }, {
3794 /* end of list */
3795 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003796 },
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003797 };
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003798 bool image_opts = false;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003799 bool shrink = false;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003800
Kevin Wolfe80fec72011-04-29 10:58:12 +02003801 /* Remove size from argv manually so that negative numbers are not treated
3802 * as options by getopt. */
3803 if (argc < 3) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003804 error_exit("Not enough arguments");
Kevin Wolfe80fec72011-04-29 10:58:12 +02003805 return 1;
3806 }
3807
3808 size = argv[--argc];
3809
3810 /* Parse getopt arguments */
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003811 fmt = NULL;
3812 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003813 static const struct option long_options[] = {
3814 {"help", no_argument, 0, 'h'},
3815 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003816 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Max Reitzdc5f6902017-06-13 22:20:55 +02003817 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003818 {"shrink", no_argument, 0, OPTION_SHRINK},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003819 {0, 0, 0, 0}
3820 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003821 c = getopt_long(argc, argv, ":f:hq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003822 long_options, NULL);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003823 if (c == -1) {
3824 break;
3825 }
3826 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003827 case ':':
3828 missing_argument(argv[optind - 1]);
3829 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003830 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003831 unrecognized_option(argv[optind - 1]);
3832 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003833 case 'h':
3834 help();
3835 break;
3836 case 'f':
3837 fmt = optarg;
3838 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003839 case 'q':
3840 quiet = true;
3841 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003842 case OPTION_OBJECT: {
3843 QemuOpts *opts;
3844 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3845 optarg, true);
3846 if (!opts) {
3847 return 1;
3848 }
3849 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003850 case OPTION_IMAGE_OPTS:
3851 image_opts = true;
3852 break;
Max Reitzdc5f6902017-06-13 22:20:55 +02003853 case OPTION_PREALLOCATION:
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02003854 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
Markus Armbruster06c60b62017-08-24 10:45:57 +02003855 PREALLOC_MODE__MAX, NULL);
Max Reitzdc5f6902017-06-13 22:20:55 +02003856 if (prealloc == PREALLOC_MODE__MAX) {
3857 error_report("Invalid preallocation mode '%s'", optarg);
3858 return 1;
3859 }
3860 break;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003861 case OPTION_SHRINK:
3862 shrink = true;
3863 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003864 }
3865 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02003866 if (optind != argc - 1) {
Max Reitzbe8fbd42018-02-05 17:27:45 +01003867 error_exit("Expecting image file name and size");
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003868 }
3869 filename = argv[optind++];
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003870
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003871 if (qemu_opts_foreach(&qemu_object_opts,
3872 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02003873 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003874 return 1;
3875 }
3876
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003877 /* Choose grow, shrink, or absolute resize mode */
3878 switch (size[0]) {
3879 case '+':
3880 relative = 1;
3881 size++;
3882 break;
3883 case '-':
3884 relative = -1;
3885 size++;
3886 break;
3887 default:
3888 relative = 0;
3889 break;
3890 }
3891
3892 /* Parse size */
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -08003893 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
Markus Armbrusterf43e47d2015-02-12 17:52:20 +01003894 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +01003895 if (err) {
3896 error_report_err(err);
Jes Sorensen2a819982010-12-06 17:08:31 +01003897 ret = -1;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003898 qemu_opts_del(param);
Jes Sorensen2a819982010-12-06 17:08:31 +01003899 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003900 }
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003901 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3902 qemu_opts_del(param);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003903
Max Reitzefaa7c42016-03-16 19:54:38 +01003904 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08003905 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
3906 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003907 if (!blk) {
Jes Sorensen2a819982010-12-06 17:08:31 +01003908 ret = -1;
3909 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003910 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003911
Max Reitzdc5f6902017-06-13 22:20:55 +02003912 current_size = blk_getlength(blk);
3913 if (current_size < 0) {
3914 error_report("Failed to inquire current image length: %s",
3915 strerror(-current_size));
3916 ret = -1;
3917 goto out;
3918 }
3919
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003920 if (relative) {
Max Reitzdc5f6902017-06-13 22:20:55 +02003921 total_size = current_size + n * relative;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003922 } else {
3923 total_size = n;
3924 }
3925 if (total_size <= 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003926 error_report("New image size must be positive");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003927 ret = -1;
3928 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003929 }
3930
Max Reitzdc5f6902017-06-13 22:20:55 +02003931 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
3932 error_report("Preallocation can only be used for growing images");
3933 ret = -1;
3934 goto out;
3935 }
3936
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003937 if (total_size < current_size && !shrink) {
3938 warn_report("Shrinking an image will delete all data beyond the "
3939 "shrunken image's end. Before performing such an "
3940 "operation, make sure there is no important data there.");
3941
3942 if (g_strcmp0(bdrv_get_format_name(blk_bs(blk)), "raw") != 0) {
3943 error_report(
3944 "Use the --shrink option to perform a shrink operation.");
3945 ret = -1;
3946 goto out;
3947 } else {
3948 warn_report("Using the --shrink option will suppress this message. "
3949 "Note that future versions of qemu-img may refuse to "
3950 "shrink images without this option.");
3951 }
3952 }
3953
Max Reitze8d04f92019-09-18 11:51:43 +02003954 /*
3955 * The user expects the image to have the desired size after
3956 * resizing, so pass @exact=true. It is of no use to report
3957 * success when the image has not actually been resized.
3958 */
Kevin Wolf8c6242b2020-04-24 14:54:41 +02003959 ret = blk_truncate(blk, total_size, true, prealloc, 0, &err);
Max Reitz09c5c6d2019-09-18 11:51:44 +02003960 if (!ret) {
3961 qprintf(quiet, "Image resized.\n");
3962 } else {
Max Reitzed3d2ec2017-03-28 22:51:27 +02003963 error_report_err(err);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003964 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003965out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003966 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003967 if (ret) {
3968 return 1;
3969 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003970 return 0;
3971}
3972
Max Reitz76a3a342014-10-27 11:12:51 +01003973static void amend_status_cb(BlockDriverState *bs,
Max Reitz8b139762015-07-27 17:51:32 +02003974 int64_t offset, int64_t total_work_size,
3975 void *opaque)
Max Reitz76a3a342014-10-27 11:12:51 +01003976{
3977 qemu_progress_print(100.f * offset / total_work_size, 0);
3978}
3979
Max Reitz51641352018-05-09 23:00:20 +02003980static int print_amend_option_help(const char *format)
3981{
3982 BlockDriver *drv;
3983
3984 /* Find driver and parse its options */
3985 drv = bdrv_find_format(format);
3986 if (!drv) {
3987 error_report("Unknown file format '%s'", format);
3988 return 1;
3989 }
3990
3991 if (!drv->bdrv_amend_options) {
3992 error_report("Format driver '%s' does not support option amendment",
3993 format);
3994 return 1;
3995 }
3996
3997 /* Every driver supporting amendment must have create_opts */
3998 assert(drv->create_opts);
3999
4000 printf("Creation options for '%s':\n", format);
Max Reitz63898712018-10-19 18:49:25 +02004001 qemu_opts_print_help(drv->create_opts, false);
Max Reitz51641352018-05-09 23:00:20 +02004002 printf("\nNote that not all of these options may be amendable.\n");
4003 return 0;
4004}
4005
Max Reitz6f176b42013-09-03 10:09:50 +02004006static int img_amend(int argc, char **argv)
4007{
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01004008 Error *err = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02004009 int c, ret = 0;
4010 char *options = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08004011 QemuOptsList *create_opts = NULL;
4012 QemuOpts *opts = NULL;
Max Reitzbd39e6e2014-07-22 22:58:43 +02004013 const char *fmt = NULL, *filename, *cache;
4014 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01004015 bool writethrough;
Max Reitz76a3a342014-10-27 11:12:51 +01004016 bool quiet = false, progress = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02004017 BlockBackend *blk = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02004018 BlockDriverState *bs = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004019 bool image_opts = false;
Max Reitz6f176b42013-09-03 10:09:50 +02004020
Max Reitzbd39e6e2014-07-22 22:58:43 +02004021 cache = BDRV_DEFAULT_CACHE;
Max Reitz6f176b42013-09-03 10:09:50 +02004022 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004023 static const struct option long_options[] = {
4024 {"help", no_argument, 0, 'h'},
4025 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004026 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004027 {0, 0, 0, 0}
4028 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004029 c = getopt_long(argc, argv, ":ho:f:t:pq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004030 long_options, NULL);
Max Reitz6f176b42013-09-03 10:09:50 +02004031 if (c == -1) {
4032 break;
4033 }
4034
4035 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004036 case ':':
4037 missing_argument(argv[optind - 1]);
4038 break;
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004039 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004040 unrecognized_option(argv[optind - 1]);
4041 break;
4042 case 'h':
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004043 help();
4044 break;
4045 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02004046 if (accumulate_options(&options, optarg) < 0) {
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004047 ret = -1;
4048 goto out_no_progress;
4049 }
Stefan Hajnoczif7077622017-03-17 18:45:40 +08004050 break;
4051 case 'f':
4052 fmt = optarg;
4053 break;
4054 case 't':
4055 cache = optarg;
4056 break;
4057 case 'p':
4058 progress = true;
4059 break;
4060 case 'q':
4061 quiet = true;
4062 break;
4063 case OPTION_OBJECT:
4064 opts = qemu_opts_parse_noisily(&qemu_object_opts,
4065 optarg, true);
4066 if (!opts) {
4067 ret = -1;
4068 goto out_no_progress;
4069 }
4070 break;
4071 case OPTION_IMAGE_OPTS:
4072 image_opts = true;
4073 break;
Max Reitz6f176b42013-09-03 10:09:50 +02004074 }
4075 }
4076
Max Reitz6f176b42013-09-03 10:09:50 +02004077 if (!options) {
Fam Zhengac1307a2014-04-22 13:36:11 +08004078 error_exit("Must specify options (-o)");
Max Reitz6f176b42013-09-03 10:09:50 +02004079 }
4080
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004081 if (qemu_opts_foreach(&qemu_object_opts,
4082 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02004083 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004084 ret = -1;
4085 goto out_no_progress;
4086 }
4087
Max Reitz76a3a342014-10-27 11:12:51 +01004088 if (quiet) {
4089 progress = false;
4090 }
4091 qemu_progress_init(progress, 1.0);
4092
Kevin Wolfa283cb62014-02-21 16:24:07 +01004093 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
4094 if (fmt && has_help_option(options)) {
4095 /* If a format is explicitly specified (and possibly no filename is
4096 * given), print option help here */
Max Reitz51641352018-05-09 23:00:20 +02004097 ret = print_amend_option_help(fmt);
Kevin Wolfa283cb62014-02-21 16:24:07 +01004098 goto out;
4099 }
4100
4101 if (optind != argc - 1) {
Max Reitzb2f27e42014-10-27 11:12:52 +01004102 error_report("Expecting one image file name");
4103 ret = -1;
4104 goto out;
Kevin Wolfa283cb62014-02-21 16:24:07 +01004105 }
Max Reitz6f176b42013-09-03 10:09:50 +02004106
Kevin Wolfce099542016-03-15 13:01:04 +01004107 flags = BDRV_O_RDWR;
4108 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitzbd39e6e2014-07-22 22:58:43 +02004109 if (ret < 0) {
4110 error_report("Invalid cache option: %s", cache);
4111 goto out;
4112 }
4113
Fam Zheng335e9932017-05-03 00:35:39 +08004114 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4115 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004116 if (!blk) {
Max Reitz6f176b42013-09-03 10:09:50 +02004117 ret = -1;
4118 goto out;
4119 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004120 bs = blk_bs(blk);
Max Reitz6f176b42013-09-03 10:09:50 +02004121
4122 fmt = bs->drv->format_name;
4123
Kevin Wolf626f84f2014-02-21 16:24:06 +01004124 if (has_help_option(options)) {
Kevin Wolfa283cb62014-02-21 16:24:07 +01004125 /* If the format was auto-detected, print option help here */
Max Reitz51641352018-05-09 23:00:20 +02004126 ret = print_amend_option_help(fmt);
Max Reitz6f176b42013-09-03 10:09:50 +02004127 goto out;
4128 }
4129
Max Reitz1f996682018-05-09 23:00:17 +02004130 if (!bs->drv->bdrv_amend_options) {
4131 error_report("Format driver '%s' does not support option amendment",
Max Reitzb2439d22014-12-02 18:32:47 +01004132 fmt);
4133 ret = -1;
4134 goto out;
4135 }
4136
Max Reitz1f996682018-05-09 23:00:17 +02004137 /* Every driver supporting amendment must have create_opts */
4138 assert(bs->drv->create_opts);
4139
Chunyan Liuc282e1f2014-06-05 17:21:11 +08004140 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
Chunyan Liu83d05212014-06-05 17:20:51 +08004141 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Paolo Bonziniece90862017-01-04 15:56:24 +01004142 qemu_opts_do_parse(opts, options, NULL, &err);
4143 if (err) {
4144 error_report_err(err);
4145 ret = -1;
4146 goto out;
Max Reitz6f176b42013-09-03 10:09:50 +02004147 }
4148
Max Reitz76a3a342014-10-27 11:12:51 +01004149 /* In case the driver does not call amend_status_cb() */
4150 qemu_progress_print(0.f, 0);
Max Reitzd1402b52018-05-09 23:00:18 +02004151 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, &err);
Max Reitz76a3a342014-10-27 11:12:51 +01004152 qemu_progress_print(100.f, 0);
Max Reitz6f176b42013-09-03 10:09:50 +02004153 if (ret < 0) {
Max Reitzd1402b52018-05-09 23:00:18 +02004154 error_report_err(err);
Max Reitz6f176b42013-09-03 10:09:50 +02004155 goto out;
4156 }
4157
4158out:
Max Reitz76a3a342014-10-27 11:12:51 +01004159 qemu_progress_end();
4160
Max Reitze814dff2015-08-20 16:00:38 -07004161out_no_progress:
Markus Armbruster26f54e92014-10-07 13:59:04 +02004162 blk_unref(blk);
Chunyan Liu83d05212014-06-05 17:20:51 +08004163 qemu_opts_del(opts);
4164 qemu_opts_free(create_opts);
Kevin Wolf626f84f2014-02-21 16:24:06 +01004165 g_free(options);
4166
Max Reitz6f176b42013-09-03 10:09:50 +02004167 if (ret) {
4168 return 1;
4169 }
4170 return 0;
4171}
4172
Kevin Wolfb6133b82014-08-05 14:17:13 +02004173typedef struct BenchData {
4174 BlockBackend *blk;
4175 uint64_t image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004176 bool write;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004177 int bufsize;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004178 int step;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004179 int nrreq;
4180 int n;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004181 int flush_interval;
4182 bool drain_on_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004183 uint8_t *buf;
4184 QEMUIOVector *qiov;
4185
4186 int in_flight;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004187 bool in_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004188 uint64_t offset;
4189} BenchData;
4190
Kevin Wolf55d539c2016-06-03 13:59:41 +02004191static void bench_undrained_flush_cb(void *opaque, int ret)
4192{
4193 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004194 error_report("Failed flush request: %s", strerror(-ret));
Kevin Wolf55d539c2016-06-03 13:59:41 +02004195 exit(EXIT_FAILURE);
4196 }
4197}
4198
Kevin Wolfb6133b82014-08-05 14:17:13 +02004199static void bench_cb(void *opaque, int ret)
4200{
4201 BenchData *b = opaque;
4202 BlockAIOCB *acb;
4203
4204 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004205 error_report("Failed request: %s", strerror(-ret));
Kevin Wolfb6133b82014-08-05 14:17:13 +02004206 exit(EXIT_FAILURE);
4207 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004208
4209 if (b->in_flush) {
4210 /* Just finished a flush with drained queue: Start next requests */
4211 assert(b->in_flight == 0);
4212 b->in_flush = false;
4213 } else if (b->in_flight > 0) {
4214 int remaining = b->n - b->in_flight;
4215
Kevin Wolfb6133b82014-08-05 14:17:13 +02004216 b->n--;
4217 b->in_flight--;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004218
4219 /* Time for flush? Drain queue if requested, then flush */
4220 if (b->flush_interval && remaining % b->flush_interval == 0) {
4221 if (!b->in_flight || !b->drain_on_flush) {
4222 BlockCompletionFunc *cb;
4223
4224 if (b->drain_on_flush) {
4225 b->in_flush = true;
4226 cb = bench_cb;
4227 } else {
4228 cb = bench_undrained_flush_cb;
4229 }
4230
4231 acb = blk_aio_flush(b->blk, cb, b);
4232 if (!acb) {
4233 error_report("Failed to issue flush request");
4234 exit(EXIT_FAILURE);
4235 }
4236 }
4237 if (b->drain_on_flush) {
4238 return;
4239 }
4240 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004241 }
4242
4243 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004244 int64_t offset = b->offset;
4245 /* blk_aio_* might look for completed I/Os and kick bench_cb
4246 * again, so make sure this operation is counted by in_flight
4247 * and b->offset is ready for the next submission.
4248 */
4249 b->in_flight++;
4250 b->offset += b->step;
4251 b->offset %= b->image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004252 if (b->write) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004253 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004254 } else {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004255 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004256 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004257 if (!acb) {
4258 error_report("Failed to issue request");
4259 exit(EXIT_FAILURE);
4260 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004261 }
4262}
4263
4264static int img_bench(int argc, char **argv)
4265{
4266 int c, ret = 0;
4267 const char *fmt = NULL, *filename;
4268 bool quiet = false;
4269 bool image_opts = false;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004270 bool is_write = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004271 int count = 75000;
4272 int depth = 64;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004273 int64_t offset = 0;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004274 size_t bufsize = 4096;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004275 int pattern = 0;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004276 size_t step = 0;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004277 int flush_interval = 0;
4278 bool drain_on_flush = true;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004279 int64_t image_size;
4280 BlockBackend *blk = NULL;
4281 BenchData data = {};
4282 int flags = 0;
Kevin Wolf604e8612016-06-14 11:29:32 +02004283 bool writethrough = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004284 struct timeval t1, t2;
4285 int i;
Fam Zheng335e9932017-05-03 00:35:39 +08004286 bool force_share = false;
Fam Zheng79d46582018-01-16 14:08:58 +08004287 size_t buf_size;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004288
4289 for (;;) {
4290 static const struct option long_options[] = {
4291 {"help", no_argument, 0, 'h'},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004292 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004293 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004294 {"pattern", required_argument, 0, OPTION_PATTERN},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004295 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
Fam Zheng335e9932017-05-03 00:35:39 +08004296 {"force-share", no_argument, 0, 'U'},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004297 {0, 0, 0, 0}
4298 };
Aarushi Mehtacdd26772020-01-20 14:18:55 +00004299 c = getopt_long(argc, argv, ":hc:d:f:ni:o:qs:S:t:wU", long_options,
4300 NULL);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004301 if (c == -1) {
4302 break;
4303 }
4304
4305 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004306 case ':':
4307 missing_argument(argv[optind - 1]);
4308 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004309 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004310 unrecognized_option(argv[optind - 1]);
4311 break;
4312 case 'h':
Kevin Wolfb6133b82014-08-05 14:17:13 +02004313 help();
4314 break;
4315 case 'c':
4316 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004317 unsigned long res;
4318
4319 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004320 error_report("Invalid request count specified");
4321 return 1;
4322 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004323 count = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004324 break;
4325 }
4326 case 'd':
4327 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004328 unsigned long res;
4329
4330 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004331 error_report("Invalid queue depth specified");
4332 return 1;
4333 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004334 depth = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004335 break;
4336 }
4337 case 'f':
4338 fmt = optarg;
4339 break;
4340 case 'n':
4341 flags |= BDRV_O_NATIVE_AIO;
4342 break;
Aarushi Mehtacdd26772020-01-20 14:18:55 +00004343 case 'i':
4344 ret = bdrv_parse_aio(optarg, &flags);
4345 if (ret < 0) {
4346 error_report("Invalid aio option: %s", optarg);
4347 ret = -1;
4348 goto out;
4349 }
4350 break;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004351 case 'o':
4352 {
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004353 offset = cvtnum("offset", optarg);
Markus Armbruster606caa02017-02-21 21:14:04 +01004354 if (offset < 0) {
Kevin Wolfd3199a32015-07-10 18:09:18 +02004355 return 1;
4356 }
4357 break;
4358 }
4359 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004360 case 'q':
4361 quiet = true;
4362 break;
4363 case 's':
4364 {
4365 int64_t sval;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004366
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004367 sval = cvtnum_full("buffer size", optarg, 0, INT_MAX);
4368 if (sval < 0) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004369 return 1;
4370 }
4371
4372 bufsize = sval;
4373 break;
4374 }
Kevin Wolf83de9be2015-07-13 13:13:17 +02004375 case 'S':
4376 {
4377 int64_t sval;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004378
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004379 sval = cvtnum_full("step_size", optarg, 0, INT_MAX);
4380 if (sval < 0) {
Kevin Wolf83de9be2015-07-13 13:13:17 +02004381 return 1;
4382 }
4383
4384 step = sval;
4385 break;
4386 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004387 case 't':
4388 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4389 if (ret < 0) {
4390 error_report("Invalid cache mode");
4391 ret = -1;
4392 goto out;
4393 }
4394 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004395 case 'w':
4396 flags |= BDRV_O_RDWR;
4397 is_write = true;
4398 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004399 case 'U':
4400 force_share = true;
4401 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004402 case OPTION_PATTERN:
4403 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004404 unsigned long res;
4405
4406 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004407 error_report("Invalid pattern byte specified");
4408 return 1;
4409 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004410 pattern = res;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004411 break;
4412 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004413 case OPTION_FLUSH_INTERVAL:
4414 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004415 unsigned long res;
4416
4417 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004418 error_report("Invalid flush interval specified");
4419 return 1;
4420 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004421 flush_interval = res;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004422 break;
4423 }
4424 case OPTION_NO_DRAIN:
4425 drain_on_flush = false;
4426 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004427 case OPTION_IMAGE_OPTS:
4428 image_opts = true;
4429 break;
4430 }
4431 }
4432
4433 if (optind != argc - 1) {
4434 error_exit("Expecting one image file name");
4435 }
4436 filename = argv[argc - 1];
4437
Kevin Wolf55d539c2016-06-03 13:59:41 +02004438 if (!is_write && flush_interval) {
4439 error_report("--flush-interval is only available in write tests");
4440 ret = -1;
4441 goto out;
4442 }
4443 if (flush_interval && flush_interval < depth) {
4444 error_report("Flush interval can't be smaller than depth");
4445 ret = -1;
4446 goto out;
4447 }
4448
Fam Zheng335e9932017-05-03 00:35:39 +08004449 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4450 force_share);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004451 if (!blk) {
4452 ret = -1;
4453 goto out;
4454 }
4455
4456 image_size = blk_getlength(blk);
4457 if (image_size < 0) {
4458 ret = image_size;
4459 goto out;
4460 }
4461
4462 data = (BenchData) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004463 .blk = blk,
4464 .image_size = image_size,
4465 .bufsize = bufsize,
4466 .step = step ?: bufsize,
4467 .nrreq = depth,
4468 .n = count,
4469 .offset = offset,
4470 .write = is_write,
4471 .flush_interval = flush_interval,
4472 .drain_on_flush = drain_on_flush,
Kevin Wolfb6133b82014-08-05 14:17:13 +02004473 };
Kevin Wolfd3199a32015-07-10 18:09:18 +02004474 printf("Sending %d %s requests, %d bytes each, %d in parallel "
Kevin Wolf83de9be2015-07-13 13:13:17 +02004475 "(starting at offset %" PRId64 ", step size %d)\n",
Kevin Wolfd3199a32015-07-10 18:09:18 +02004476 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
Kevin Wolf83de9be2015-07-13 13:13:17 +02004477 data.offset, data.step);
Kevin Wolf55d539c2016-06-03 13:59:41 +02004478 if (flush_interval) {
4479 printf("Sending flush every %d requests\n", flush_interval);
4480 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004481
Fam Zheng79d46582018-01-16 14:08:58 +08004482 buf_size = data.nrreq * data.bufsize;
4483 data.buf = blk_blockalign(blk, buf_size);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004484 memset(data.buf, pattern, data.nrreq * data.bufsize);
4485
Fam Zheng79d46582018-01-16 14:08:58 +08004486 blk_register_buf(blk, data.buf, buf_size);
4487
Kevin Wolfb6133b82014-08-05 14:17:13 +02004488 data.qiov = g_new(QEMUIOVector, data.nrreq);
4489 for (i = 0; i < data.nrreq; i++) {
4490 qemu_iovec_init(&data.qiov[i], 1);
4491 qemu_iovec_add(&data.qiov[i],
4492 data.buf + i * data.bufsize, data.bufsize);
4493 }
4494
4495 gettimeofday(&t1, NULL);
4496 bench_cb(&data, 0);
4497
4498 while (data.n > 0) {
4499 main_loop_wait(false);
4500 }
4501 gettimeofday(&t2, NULL);
4502
4503 printf("Run completed in %3.3f seconds.\n",
4504 (t2.tv_sec - t1.tv_sec)
4505 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4506
4507out:
Fam Zheng79d46582018-01-16 14:08:58 +08004508 if (data.buf) {
4509 blk_unregister_buf(blk, data.buf);
4510 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004511 qemu_vfree(data.buf);
4512 blk_unref(blk);
4513
4514 if (ret) {
4515 return 1;
4516 }
4517 return 0;
4518}
4519
Eric Blake3b51ab42020-05-12 20:16:45 -05004520enum ImgBitmapAct {
4521 BITMAP_ADD,
4522 BITMAP_REMOVE,
4523 BITMAP_CLEAR,
4524 BITMAP_ENABLE,
4525 BITMAP_DISABLE,
4526 BITMAP_MERGE,
4527};
4528typedef struct ImgBitmapAction {
4529 enum ImgBitmapAct act;
4530 const char *src; /* only used for merge */
4531 QSIMPLEQ_ENTRY(ImgBitmapAction) next;
4532} ImgBitmapAction;
4533
4534static int img_bitmap(int argc, char **argv)
4535{
4536 Error *err = NULL;
4537 int c, ret = 1;
4538 QemuOpts *opts = NULL;
4539 const char *fmt = NULL, *src_fmt = NULL, *src_filename = NULL;
4540 const char *filename, *bitmap;
4541 BlockBackend *blk = NULL, *src = NULL;
4542 BlockDriverState *bs = NULL, *src_bs = NULL;
4543 bool image_opts = false;
4544 int64_t granularity = 0;
4545 bool add = false, merge = false;
4546 QSIMPLEQ_HEAD(, ImgBitmapAction) actions;
4547 ImgBitmapAction *act, *act_next;
4548 const char *op;
4549
4550 QSIMPLEQ_INIT(&actions);
4551
4552 for (;;) {
4553 static const struct option long_options[] = {
4554 {"help", no_argument, 0, 'h'},
4555 {"object", required_argument, 0, OPTION_OBJECT},
4556 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4557 {"add", no_argument, 0, OPTION_ADD},
4558 {"remove", no_argument, 0, OPTION_REMOVE},
4559 {"clear", no_argument, 0, OPTION_CLEAR},
4560 {"enable", no_argument, 0, OPTION_ENABLE},
4561 {"disable", no_argument, 0, OPTION_DISABLE},
4562 {"merge", required_argument, 0, OPTION_MERGE},
4563 {"granularity", required_argument, 0, 'g'},
4564 {"source-file", required_argument, 0, 'b'},
4565 {"source-format", required_argument, 0, 'F'},
4566 {0, 0, 0, 0}
4567 };
4568 c = getopt_long(argc, argv, ":b:f:F:g:h", long_options, NULL);
4569 if (c == -1) {
4570 break;
4571 }
4572
4573 switch (c) {
4574 case ':':
4575 missing_argument(argv[optind - 1]);
4576 break;
4577 case '?':
4578 unrecognized_option(argv[optind - 1]);
4579 break;
4580 case 'h':
4581 help();
4582 break;
4583 case 'b':
4584 src_filename = optarg;
4585 break;
4586 case 'f':
4587 fmt = optarg;
4588 break;
4589 case 'F':
4590 src_fmt = optarg;
4591 break;
4592 case 'g':
4593 granularity = cvtnum("granularity", optarg);
4594 if (granularity < 0) {
4595 return 1;
4596 }
4597 break;
4598 case OPTION_ADD:
4599 act = g_new0(ImgBitmapAction, 1);
4600 act->act = BITMAP_ADD;
4601 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4602 add = true;
4603 break;
4604 case OPTION_REMOVE:
4605 act = g_new0(ImgBitmapAction, 1);
4606 act->act = BITMAP_REMOVE;
4607 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4608 break;
4609 case OPTION_CLEAR:
4610 act = g_new0(ImgBitmapAction, 1);
4611 act->act = BITMAP_CLEAR;
4612 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4613 break;
4614 case OPTION_ENABLE:
4615 act = g_new0(ImgBitmapAction, 1);
4616 act->act = BITMAP_ENABLE;
4617 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4618 break;
4619 case OPTION_DISABLE:
4620 act = g_new0(ImgBitmapAction, 1);
4621 act->act = BITMAP_DISABLE;
4622 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4623 break;
4624 case OPTION_MERGE:
4625 act = g_new0(ImgBitmapAction, 1);
4626 act->act = BITMAP_MERGE;
4627 act->src = optarg;
4628 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4629 merge = true;
4630 break;
4631 case OPTION_OBJECT:
4632 opts = qemu_opts_parse_noisily(&qemu_object_opts, optarg, true);
4633 if (!opts) {
4634 goto out;
4635 }
4636 break;
4637 case OPTION_IMAGE_OPTS:
4638 image_opts = true;
4639 break;
4640 }
4641 }
4642
4643 if (qemu_opts_foreach(&qemu_object_opts,
4644 user_creatable_add_opts_foreach,
4645 qemu_img_object_print_help, &error_fatal)) {
4646 goto out;
4647 }
4648
4649 if (QSIMPLEQ_EMPTY(&actions)) {
4650 error_report("Need at least one of --add, --remove, --clear, "
4651 "--enable, --disable, or --merge");
4652 goto out;
4653 }
4654
4655 if (granularity && !add) {
4656 error_report("granularity only supported with --add");
4657 goto out;
4658 }
4659 if (src_fmt && !src_filename) {
4660 error_report("-F only supported with -b");
4661 goto out;
4662 }
4663 if (src_filename && !merge) {
4664 error_report("Merge bitmap source file only supported with "
4665 "--merge");
4666 goto out;
4667 }
4668
4669 if (optind != argc - 2) {
4670 error_report("Expecting filename and bitmap name");
4671 goto out;
4672 }
4673
4674 filename = argv[optind];
4675 bitmap = argv[optind + 1];
4676
4677 blk = img_open(image_opts, filename, fmt, BDRV_O_RDWR, false, false,
4678 false);
4679 if (!blk) {
4680 goto out;
4681 }
4682 bs = blk_bs(blk);
4683 if (src_filename) {
4684 src = img_open(false, src_filename, src_fmt, 0, false, false, false);
4685 if (!src) {
4686 goto out;
4687 }
4688 src_bs = blk_bs(src);
4689 } else {
4690 src_bs = bs;
4691 }
4692
4693 QSIMPLEQ_FOREACH_SAFE(act, &actions, next, act_next) {
4694 switch (act->act) {
4695 case BITMAP_ADD:
4696 qmp_block_dirty_bitmap_add(bs->node_name, bitmap,
4697 !!granularity, granularity, true, true,
4698 false, false, &err);
4699 op = "add";
4700 break;
4701 case BITMAP_REMOVE:
4702 qmp_block_dirty_bitmap_remove(bs->node_name, bitmap, &err);
4703 op = "remove";
4704 break;
4705 case BITMAP_CLEAR:
4706 qmp_block_dirty_bitmap_clear(bs->node_name, bitmap, &err);
4707 op = "clear";
4708 break;
4709 case BITMAP_ENABLE:
4710 qmp_block_dirty_bitmap_enable(bs->node_name, bitmap, &err);
4711 op = "enable";
4712 break;
4713 case BITMAP_DISABLE:
4714 qmp_block_dirty_bitmap_disable(bs->node_name, bitmap, &err);
4715 op = "disable";
4716 break;
4717 case BITMAP_MERGE: {
4718 BlockDirtyBitmapMergeSource *merge_src;
4719 BlockDirtyBitmapMergeSourceList *list;
4720
4721 merge_src = g_new0(BlockDirtyBitmapMergeSource, 1);
4722 merge_src->type = QTYPE_QDICT;
4723 merge_src->u.external.node = g_strdup(src_bs->node_name);
4724 merge_src->u.external.name = g_strdup(act->src);
4725 list = g_new0(BlockDirtyBitmapMergeSourceList, 1);
4726 list->value = merge_src;
4727 qmp_block_dirty_bitmap_merge(bs->node_name, bitmap, list, &err);
4728 qapi_free_BlockDirtyBitmapMergeSourceList(list);
4729 op = "merge";
4730 break;
4731 }
4732 default:
4733 g_assert_not_reached();
4734 }
4735
4736 if (err) {
4737 error_reportf_err(err, "Operation %s on bitmap %s failed: ",
4738 op, bitmap);
4739 goto out;
4740 }
4741 g_free(act);
4742 }
4743
4744 ret = 0;
4745
4746 out:
4747 blk_unref(src);
4748 blk_unref(blk);
4749 qemu_opts_del(opts);
4750 return ret;
4751}
4752
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004753#define C_BS 01
4754#define C_COUNT 02
4755#define C_IF 04
4756#define C_OF 010
Reda Sallahif7c15532016-08-10 16:16:09 +02004757#define C_SKIP 020
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004758
4759struct DdInfo {
4760 unsigned int flags;
4761 int64_t count;
4762};
4763
4764struct DdIo {
4765 int bsz; /* Block size */
4766 char *filename;
4767 uint8_t *buf;
Reda Sallahif7c15532016-08-10 16:16:09 +02004768 int64_t offset;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004769};
4770
4771struct DdOpts {
4772 const char *name;
4773 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
4774 unsigned int flag;
4775};
4776
4777static int img_dd_bs(const char *arg,
4778 struct DdIo *in, struct DdIo *out,
4779 struct DdInfo *dd)
4780{
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004781 int64_t res;
4782
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004783 res = cvtnum_full("bs", arg, 1, INT_MAX);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004784
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004785 if (res < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004786 return 1;
4787 }
4788 in->bsz = out->bsz = res;
4789
4790 return 0;
4791}
4792
4793static int img_dd_count(const char *arg,
4794 struct DdIo *in, struct DdIo *out,
4795 struct DdInfo *dd)
4796{
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004797 dd->count = cvtnum("count", arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004798
Markus Armbruster606caa02017-02-21 21:14:04 +01004799 if (dd->count < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004800 return 1;
4801 }
4802
4803 return 0;
4804}
4805
4806static int img_dd_if(const char *arg,
4807 struct DdIo *in, struct DdIo *out,
4808 struct DdInfo *dd)
4809{
4810 in->filename = g_strdup(arg);
4811
4812 return 0;
4813}
4814
4815static int img_dd_of(const char *arg,
4816 struct DdIo *in, struct DdIo *out,
4817 struct DdInfo *dd)
4818{
4819 out->filename = g_strdup(arg);
4820
4821 return 0;
4822}
4823
Reda Sallahif7c15532016-08-10 16:16:09 +02004824static int img_dd_skip(const char *arg,
4825 struct DdIo *in, struct DdIo *out,
4826 struct DdInfo *dd)
4827{
Eyal Moscovici43d589b2020-05-13 16:36:26 +03004828 in->offset = cvtnum("skip", arg);
Reda Sallahif7c15532016-08-10 16:16:09 +02004829
Markus Armbruster606caa02017-02-21 21:14:04 +01004830 if (in->offset < 0) {
Reda Sallahif7c15532016-08-10 16:16:09 +02004831 return 1;
4832 }
4833
4834 return 0;
4835}
4836
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004837static int img_dd(int argc, char **argv)
4838{
4839 int ret = 0;
4840 char *arg = NULL;
4841 char *tmp;
4842 BlockDriver *drv = NULL, *proto_drv = NULL;
4843 BlockBackend *blk1 = NULL, *blk2 = NULL;
4844 QemuOpts *opts = NULL;
4845 QemuOptsList *create_opts = NULL;
4846 Error *local_err = NULL;
4847 bool image_opts = false;
4848 int c, i;
4849 const char *out_fmt = "raw";
4850 const char *fmt = NULL;
4851 int64_t size = 0;
4852 int64_t block_count = 0, out_pos, in_pos;
Fam Zheng335e9932017-05-03 00:35:39 +08004853 bool force_share = false;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004854 struct DdInfo dd = {
4855 .flags = 0,
4856 .count = 0,
4857 };
4858 struct DdIo in = {
4859 .bsz = 512, /* Block size is by default 512 bytes */
4860 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004861 .buf = NULL,
4862 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004863 };
4864 struct DdIo out = {
4865 .bsz = 512,
4866 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004867 .buf = NULL,
4868 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004869 };
4870
4871 const struct DdOpts options[] = {
4872 { "bs", img_dd_bs, C_BS },
4873 { "count", img_dd_count, C_COUNT },
4874 { "if", img_dd_if, C_IF },
4875 { "of", img_dd_of, C_OF },
Reda Sallahif7c15532016-08-10 16:16:09 +02004876 { "skip", img_dd_skip, C_SKIP },
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004877 { NULL, NULL, 0 }
4878 };
4879 const struct option long_options[] = {
4880 { "help", no_argument, 0, 'h'},
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004881 { "object", required_argument, 0, OPTION_OBJECT},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004882 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08004883 { "force-share", no_argument, 0, 'U'},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004884 { 0, 0, 0, 0 }
4885 };
4886
Fam Zheng335e9932017-05-03 00:35:39 +08004887 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004888 if (c == EOF) {
4889 break;
4890 }
4891 switch (c) {
4892 case 'O':
4893 out_fmt = optarg;
4894 break;
4895 case 'f':
4896 fmt = optarg;
4897 break;
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004898 case ':':
4899 missing_argument(argv[optind - 1]);
4900 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004901 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004902 unrecognized_option(argv[optind - 1]);
4903 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004904 case 'h':
4905 help();
4906 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004907 case 'U':
4908 force_share = true;
4909 break;
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01004910 case OPTION_OBJECT:
4911 if (!qemu_opts_parse_noisily(&qemu_object_opts, optarg, true)) {
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004912 ret = -1;
4913 goto out;
4914 }
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01004915 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004916 case OPTION_IMAGE_OPTS:
4917 image_opts = true;
4918 break;
4919 }
4920 }
4921
4922 for (i = optind; i < argc; i++) {
4923 int j;
4924 arg = g_strdup(argv[i]);
4925
4926 tmp = strchr(arg, '=');
4927 if (tmp == NULL) {
4928 error_report("unrecognized operand %s", arg);
4929 ret = -1;
4930 goto out;
4931 }
4932
4933 *tmp++ = '\0';
4934
4935 for (j = 0; options[j].name != NULL; j++) {
4936 if (!strcmp(arg, options[j].name)) {
4937 break;
4938 }
4939 }
4940 if (options[j].name == NULL) {
4941 error_report("unrecognized operand %s", arg);
4942 ret = -1;
4943 goto out;
4944 }
4945
4946 if (options[j].f(tmp, &in, &out, &dd) != 0) {
4947 ret = -1;
4948 goto out;
4949 }
4950 dd.flags |= options[j].flag;
4951 g_free(arg);
4952 arg = NULL;
4953 }
4954
4955 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
4956 error_report("Must specify both input and output files");
4957 ret = -1;
4958 goto out;
4959 }
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004960
4961 if (qemu_opts_foreach(&qemu_object_opts,
4962 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02004963 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004964 ret = -1;
4965 goto out;
4966 }
4967
Fam Zheng335e9932017-05-03 00:35:39 +08004968 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
4969 force_share);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004970
4971 if (!blk1) {
4972 ret = -1;
4973 goto out;
4974 }
4975
4976 drv = bdrv_find_format(out_fmt);
4977 if (!drv) {
4978 error_report("Unknown file format");
4979 ret = -1;
4980 goto out;
4981 }
4982 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
4983
4984 if (!proto_drv) {
4985 error_report_err(local_err);
4986 ret = -1;
4987 goto out;
4988 }
4989 if (!drv->create_opts) {
4990 error_report("Format driver '%s' does not support image creation",
4991 drv->format_name);
4992 ret = -1;
4993 goto out;
4994 }
4995 if (!proto_drv->create_opts) {
4996 error_report("Protocol driver '%s' does not support image creation",
4997 proto_drv->format_name);
4998 ret = -1;
4999 goto out;
5000 }
5001 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5002 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
5003
5004 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5005
5006 size = blk_getlength(blk1);
5007 if (size < 0) {
5008 error_report("Failed to get size for '%s'", in.filename);
5009 ret = -1;
5010 goto out;
5011 }
5012
5013 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
5014 dd.count * in.bsz < size) {
5015 size = dd.count * in.bsz;
5016 }
5017
Reda Sallahif7c15532016-08-10 16:16:09 +02005018 /* Overflow means the specified offset is beyond input image's size */
5019 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5020 size < in.bsz * in.offset)) {
5021 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
5022 } else {
5023 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
5024 size - in.bsz * in.offset, &error_abort);
5025 }
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005026
5027 ret = bdrv_create(drv, out.filename, opts, &local_err);
5028 if (ret < 0) {
5029 error_reportf_err(local_err,
5030 "%s: error while creating output image: ",
5031 out.filename);
5032 ret = -1;
5033 goto out;
5034 }
5035
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01005036 /* TODO, we can't honour --image-opts for the target,
5037 * since it needs to be given in a format compatible
5038 * with the bdrv_create() call above which does not
5039 * support image-opts style.
5040 */
Daniel P. Berrange29cf9332017-05-15 17:47:12 +01005041 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01005042 false, false, false);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005043
5044 if (!blk2) {
5045 ret = -1;
5046 goto out;
5047 }
5048
Reda Sallahif7c15532016-08-10 16:16:09 +02005049 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5050 size < in.offset * in.bsz)) {
5051 /* We give a warning if the skip option is bigger than the input
5052 * size and create an empty output disk image (i.e. like dd(1)).
5053 */
5054 error_report("%s: cannot skip to specified offset", in.filename);
5055 in_pos = size;
5056 } else {
5057 in_pos = in.offset * in.bsz;
5058 }
5059
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005060 in.buf = g_new(uint8_t, in.bsz);
5061
Reda Sallahif7c15532016-08-10 16:16:09 +02005062 for (out_pos = 0; in_pos < size; block_count++) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02005063 int in_ret, out_ret;
5064
5065 if (in_pos + in.bsz > size) {
5066 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
5067 } else {
5068 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
5069 }
5070 if (in_ret < 0) {
5071 error_report("error while reading from input image file: %s",
5072 strerror(-in_ret));
5073 ret = -1;
5074 goto out;
5075 }
5076 in_pos += in_ret;
5077
5078 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
5079
5080 if (out_ret < 0) {
5081 error_report("error while writing to output image file: %s",
5082 strerror(-out_ret));
5083 ret = -1;
5084 goto out;
5085 }
5086 out_pos += out_ret;
5087 }
5088
5089out:
5090 g_free(arg);
5091 qemu_opts_del(opts);
5092 qemu_opts_free(create_opts);
5093 blk_unref(blk1);
5094 blk_unref(blk2);
5095 g_free(in.filename);
5096 g_free(out.filename);
5097 g_free(in.buf);
5098 g_free(out.buf);
5099
5100 if (ret) {
5101 return 1;
5102 }
5103 return 0;
5104}
5105
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005106static void dump_json_block_measure_info(BlockMeasureInfo *info)
5107{
5108 QString *str;
5109 QObject *obj;
5110 Visitor *v = qobject_output_visitor_new(&obj);
5111
5112 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
5113 visit_complete(v, &obj);
5114 str = qobject_to_json_pretty(obj);
5115 assert(str != NULL);
5116 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02005117 qobject_unref(obj);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005118 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02005119 qobject_unref(str);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005120}
5121
5122static int img_measure(int argc, char **argv)
5123{
5124 static const struct option long_options[] = {
5125 {"help", no_argument, 0, 'h'},
5126 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
5127 {"object", required_argument, 0, OPTION_OBJECT},
5128 {"output", required_argument, 0, OPTION_OUTPUT},
5129 {"size", required_argument, 0, OPTION_SIZE},
5130 {"force-share", no_argument, 0, 'U'},
5131 {0, 0, 0, 0}
5132 };
5133 OutputFormat output_format = OFORMAT_HUMAN;
5134 BlockBackend *in_blk = NULL;
5135 BlockDriver *drv;
5136 const char *filename = NULL;
5137 const char *fmt = NULL;
5138 const char *out_fmt = "raw";
5139 char *options = NULL;
5140 char *snapshot_name = NULL;
5141 bool force_share = false;
5142 QemuOpts *opts = NULL;
5143 QemuOpts *object_opts = NULL;
5144 QemuOpts *sn_opts = NULL;
5145 QemuOptsList *create_opts = NULL;
5146 bool image_opts = false;
5147 uint64_t img_size = UINT64_MAX;
5148 BlockMeasureInfo *info = NULL;
5149 Error *local_err = NULL;
5150 int ret = 1;
5151 int c;
5152
5153 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
5154 long_options, NULL)) != -1) {
5155 switch (c) {
5156 case '?':
5157 case 'h':
5158 help();
5159 break;
5160 case 'f':
5161 fmt = optarg;
5162 break;
5163 case 'O':
5164 out_fmt = optarg;
5165 break;
5166 case 'o':
Markus Armbruster6d2b5cb2020-04-15 09:49:25 +02005167 if (accumulate_options(&options, optarg) < 0) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005168 goto out;
5169 }
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005170 break;
5171 case 'l':
5172 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
5173 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
5174 optarg, false);
5175 if (!sn_opts) {
5176 error_report("Failed in parsing snapshot param '%s'",
5177 optarg);
5178 goto out;
5179 }
5180 } else {
5181 snapshot_name = optarg;
5182 }
5183 break;
5184 case 'U':
5185 force_share = true;
5186 break;
5187 case OPTION_OBJECT:
5188 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
5189 optarg, true);
5190 if (!object_opts) {
5191 goto out;
5192 }
5193 break;
5194 case OPTION_IMAGE_OPTS:
5195 image_opts = true;
5196 break;
5197 case OPTION_OUTPUT:
5198 if (!strcmp(optarg, "json")) {
5199 output_format = OFORMAT_JSON;
5200 } else if (!strcmp(optarg, "human")) {
5201 output_format = OFORMAT_HUMAN;
5202 } else {
5203 error_report("--output must be used with human or json "
5204 "as argument.");
5205 goto out;
5206 }
5207 break;
5208 case OPTION_SIZE:
5209 {
5210 int64_t sval;
5211
Eyal Moscovici43d589b2020-05-13 16:36:26 +03005212 sval = cvtnum("image size", optarg);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005213 if (sval < 0) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005214 goto out;
5215 }
5216 img_size = (uint64_t)sval;
5217 }
5218 break;
5219 }
5220 }
5221
5222 if (qemu_opts_foreach(&qemu_object_opts,
5223 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02005224 qemu_img_object_print_help, &error_fatal)) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005225 goto out;
5226 }
5227
5228 if (argc - optind > 1) {
5229 error_report("At most one filename argument is allowed.");
5230 goto out;
5231 } else if (argc - optind == 1) {
5232 filename = argv[optind];
5233 }
5234
Stefan Hajnoczic3673dc2020-02-21 11:25:21 +00005235 if (!filename && (image_opts || fmt || snapshot_name || sn_opts)) {
5236 error_report("--image-opts, -f, and -l require a filename argument.");
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01005237 goto out;
5238 }
5239 if (filename && img_size != UINT64_MAX) {
5240 error_report("--size N cannot be used together with a filename.");
5241 goto out;
5242 }
5243 if (!filename && img_size == UINT64_MAX) {
5244 error_report("Either --size N or one filename must be specified.");
5245 goto out;
5246 }
5247
5248 if (filename) {
5249 in_blk = img_open(image_opts, filename, fmt, 0,
5250 false, false, force_share);
5251 if (!in_blk) {
5252 goto out;
5253 }
5254
5255 if (sn_opts) {
5256 bdrv_snapshot_load_tmp(blk_bs(in_blk),
5257 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
5258 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
5259 &local_err);
5260 } else if (snapshot_name != NULL) {
5261 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
5262 snapshot_name, &local_err);
5263 }
5264 if (local_err) {
5265 error_reportf_err(local_err, "Failed to load snapshot: ");
5266 goto out;
5267 }
5268 }
5269
5270 drv = bdrv_find_format(out_fmt);
5271 if (!drv) {
5272 error_report("Unknown file format '%s'", out_fmt);
5273 goto out;
5274 }
5275 if (!drv->create_opts) {
5276 error_report("Format driver '%s' does not support image creation",
5277 drv->format_name);
5278 goto out;
5279 }
5280
5281 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5282 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
5283 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5284 if (options) {
5285 qemu_opts_do_parse(opts, options, NULL, &local_err);
5286 if (local_err) {
5287 error_report_err(local_err);
5288 error_report("Invalid options for file format '%s'", out_fmt);
5289 goto out;
5290 }
5291 }
5292 if (img_size != UINT64_MAX) {
5293 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
5294 }
5295
5296 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
5297 if (local_err) {
5298 error_report_err(local_err);
5299 goto out;
5300 }
5301
5302 if (output_format == OFORMAT_HUMAN) {
5303 printf("required size: %" PRIu64 "\n", info->required);
5304 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
5305 } else {
5306 dump_json_block_measure_info(info);
5307 }
5308
5309 ret = 0;
5310
5311out:
5312 qapi_free_BlockMeasureInfo(info);
5313 qemu_opts_del(object_opts);
5314 qemu_opts_del(opts);
5315 qemu_opts_del(sn_opts);
5316 qemu_opts_free(create_opts);
5317 g_free(options);
5318 blk_unref(in_blk);
5319 return ret;
5320}
Kevin Wolfb6133b82014-08-05 14:17:13 +02005321
Anthony Liguoric227f092009-10-01 16:12:16 -05005322static const img_cmd_t img_cmds[] = {
Stuart Brady153859b2009-06-07 00:42:17 +01005323#define DEF(option, callback, arg_string) \
5324 { option, callback },
5325#include "qemu-img-cmds.h"
5326#undef DEF
Stuart Brady153859b2009-06-07 00:42:17 +01005327 { NULL, NULL, },
5328};
5329
bellardea2384d2004-08-01 21:59:26 +00005330int main(int argc, char **argv)
5331{
Anthony Liguoric227f092009-10-01 16:12:16 -05005332 const img_cmd_t *cmd;
Stuart Brady153859b2009-06-07 00:42:17 +01005333 const char *cmdname;
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005334 Error *local_error = NULL;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005335 char *trace_file = NULL;
Jeff Cody7db16892014-04-25 17:02:32 -04005336 int c;
Jeff Cody7db16892014-04-25 17:02:32 -04005337 static const struct option long_options[] = {
5338 {"help", no_argument, 0, 'h'},
Denis V. Lunev10985132016-06-17 17:44:13 +03005339 {"version", no_argument, 0, 'V'},
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005340 {"trace", required_argument, NULL, 'T'},
Jeff Cody7db16892014-04-25 17:02:32 -04005341 {0, 0, 0, 0}
5342 };
bellardea2384d2004-08-01 21:59:26 +00005343
MORITA Kazutaka526eda12013-07-23 17:30:11 +09005344#ifdef CONFIG_POSIX
5345 signal(SIGPIPE, SIG_IGN);
5346#endif
5347
Christophe Fergeauf5852ef2019-01-31 17:46:14 +01005348 error_init(argv[0]);
Daniel P. Berrangefe4db842016-10-04 14:35:52 +01005349 module_call_init(MODULE_INIT_TRACE);
Fam Zheng10f5bff2014-02-10 14:48:51 +08005350 qemu_init_exec_dir(argv[0]);
Kevin Wolf53f76e52010-12-16 15:10:32 +01005351
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005352 if (qemu_init_main_loop(&local_error)) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01005353 error_report_err(local_error);
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005354 exit(EXIT_FAILURE);
5355 }
5356
Eduardo Habkoste8f2d272016-05-12 11:10:04 -03005357 qcrypto_init(&error_fatal);
Daniel P. Berrangec2297082016-04-06 12:12:06 +01005358
Daniel P. Berrange064097d2016-02-10 18:41:01 +00005359 module_call_init(MODULE_INIT_QOM);
bellardea2384d2004-08-01 21:59:26 +00005360 bdrv_init();
Fam Zhengac1307a2014-04-22 13:36:11 +08005361 if (argc < 2) {
5362 error_exit("Not enough arguments");
5363 }
Stuart Brady153859b2009-06-07 00:42:17 +01005364
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00005365 qemu_add_opts(&qemu_object_opts);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00005366 qemu_add_opts(&qemu_source_opts);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005367 qemu_add_opts(&qemu_trace_opts);
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00005368
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005369 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
Denis V. Lunev10985132016-06-17 17:44:13 +03005370 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005371 case ':':
5372 missing_argument(argv[optind - 1]);
5373 return 0;
Stefan Hajnoczi4581c162017-03-17 18:45:39 +08005374 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005375 unrecognized_option(argv[optind - 1]);
5376 return 0;
5377 case 'h':
Denis V. Lunev10985132016-06-17 17:44:13 +03005378 help();
5379 return 0;
5380 case 'V':
5381 printf(QEMU_IMG_VERSION);
5382 return 0;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005383 case 'T':
5384 g_free(trace_file);
5385 trace_file = trace_opt_parse(optarg);
5386 break;
Stuart Brady153859b2009-06-07 00:42:17 +01005387 }
bellardea2384d2004-08-01 21:59:26 +00005388 }
Stuart Brady153859b2009-06-07 00:42:17 +01005389
Denis V. Lunev10985132016-06-17 17:44:13 +03005390 cmdname = argv[optind];
Jeff Cody7db16892014-04-25 17:02:32 -04005391
Denis V. Lunev10985132016-06-17 17:44:13 +03005392 /* reset getopt_long scanning */
5393 argc -= optind;
5394 if (argc < 1) {
Jeff Cody5f6979c2014-04-28 14:37:18 -04005395 return 0;
5396 }
Denis V. Lunev10985132016-06-17 17:44:13 +03005397 argv += optind;
Richard W.M. Jonesd339d762019-01-18 10:11:14 +00005398 qemu_reset_optind();
Denis V. Lunev10985132016-06-17 17:44:13 +03005399
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005400 if (!trace_init_backends()) {
5401 exit(1);
5402 }
5403 trace_init_file(trace_file);
5404 qemu_set_log(LOG_TRACE);
5405
Denis V. Lunev10985132016-06-17 17:44:13 +03005406 /* find the command */
5407 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
5408 if (!strcmp(cmdname, cmd->name)) {
5409 return cmd->handler(argc, argv);
5410 }
5411 }
Jeff Cody7db16892014-04-25 17:02:32 -04005412
Stuart Brady153859b2009-06-07 00:42:17 +01005413 /* not found */
Fam Zhengac1307a2014-04-22 13:36:11 +08005414 error_exit("Command not found: %s", cmdname);
bellardea2384d2004-08-01 21:59:26 +00005415}