blob: 95a24b9762b0b00ef13f68cd4251864572189144 [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"
Markus Armbruster9af23982018-02-11 10:36:01 +010031#include "qapi/qapi-visit-block-core.h"
Daniel P. Berrangeb3db2112016-09-30 15:45:27 +010032#include "qapi/qobject-output-visitor.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010033#include "qapi/qmp/qjson.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010034#include "qapi/qmp/qdict.h"
Markus Armbrusterfc81fa12018-02-01 12:18:40 +010035#include "qapi/qmp/qstring.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020036#include "qemu/cutils.h"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000037#include "qemu/config-file.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010038#include "qemu/option.h"
39#include "qemu/error-report.h"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +030040#include "qemu/log.h"
Markus Armbrusterdb725812019-08-12 07:23:50 +020041#include "qemu/main-loop.h"
Markus Armbruster0b8fa322019-05-23 16:35:07 +020042#include "qemu/module.h"
Stefano Garzarella97ede572019-05-08 12:43:24 +020043#include "qemu/units.h"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000044#include "qom/object_interfaces.h"
Markus Armbruster26f54e92014-10-07 13:59:04 +020045#include "sysemu/block-backend.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010046#include "block/block_int.h"
Max Reitzd4a32382014-10-24 15:57:37 +020047#include "block/blockjob.h"
Wenchao Xiaf364ec62013-05-25 11:09:44 +080048#include "block/qapi.h"
Daniel P. Berrangec2297082016-04-06 12:12:06 +010049#include "crypto/init.h"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +030050#include "trace/control.h"
bellarde8445332006-06-14 15:32:10 +000051
Thomas Huth7e563bf2018-02-15 12:06:47 +010052#define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
Thomas Huth0781dd62016-10-05 11:54:44 +020053 "\n" QEMU_COPYRIGHT "\n"
Jeff Cody5f6979c2014-04-28 14:37:18 -040054
Anthony Liguoric227f092009-10-01 16:12:16 -050055typedef struct img_cmd_t {
Stuart Brady153859b2009-06-07 00:42:17 +010056 const char *name;
57 int (*handler)(int argc, char **argv);
Anthony Liguoric227f092009-10-01 16:12:16 -050058} img_cmd_t;
Stuart Brady153859b2009-06-07 00:42:17 +010059
Federico Simoncelli8599ea42013-01-28 06:59:47 -050060enum {
61 OPTION_OUTPUT = 256,
62 OPTION_BACKING_CHAIN = 257,
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000063 OPTION_OBJECT = 258,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000064 OPTION_IMAGE_OPTS = 259,
Kevin Wolfb6495fa2015-07-10 18:09:18 +020065 OPTION_PATTERN = 260,
Kevin Wolf55d539c2016-06-03 13:59:41 +020066 OPTION_FLUSH_INTERVAL = 261,
67 OPTION_NO_DRAIN = 262,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +010068 OPTION_TARGET_IMAGE_OPTS = 263,
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +010069 OPTION_SIZE = 264,
Max Reitzdc5f6902017-06-13 22:20:55 +020070 OPTION_PREALLOCATION = 265,
Pavel Butsykin4ffca892017-09-18 15:42:27 +030071 OPTION_SHRINK = 266,
Max Reitz8eaac022019-05-07 22:35:03 +020072 OPTION_SALVAGE = 267,
Federico Simoncelli8599ea42013-01-28 06:59:47 -050073};
74
75typedef enum OutputFormat {
76 OFORMAT_JSON,
77 OFORMAT_HUMAN,
78} OutputFormat;
79
Kevin Wolfe6996142016-03-15 13:03:11 +010080/* Default to cache=writeback as data integrity is not important for qemu-img */
Federico Simoncelli661a0f72011-06-20 12:48:19 -040081#define BDRV_DEFAULT_CACHE "writeback"
aurel32137519c2008-11-30 19:12:49 +000082
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +010083static void format_print(void *opaque, const char *name)
bellardea2384d2004-08-01 21:59:26 +000084{
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +010085 printf(" %s", name);
bellardea2384d2004-08-01 21:59:26 +000086}
87
Fam Zhengac1307a2014-04-22 13:36:11 +080088static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
89{
90 va_list ap;
91
Fam Zhengac1307a2014-04-22 13:36:11 +080092 va_start(ap, fmt);
Markus Armbrustere9e1d922019-04-17 21:06:27 +020093 error_vreport(fmt, ap);
Fam Zhengac1307a2014-04-22 13:36:11 +080094 va_end(ap);
95
Markus Armbrustere9e1d922019-04-17 21:06:27 +020096 error_printf("Try 'qemu-img --help' for more information\n");
Fam Zhengac1307a2014-04-22 13:36:11 +080097 exit(EXIT_FAILURE);
98}
99
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800100static void QEMU_NORETURN missing_argument(const char *option)
101{
102 error_exit("missing argument for option '%s'", option);
103}
104
105static void QEMU_NORETURN unrecognized_option(const char *option)
106{
107 error_exit("unrecognized option '%s'", option);
108}
109
blueswir1d2c639d2009-01-24 18:19:25 +0000110/* Please keep in synch with qemu-img.texi */
Fam Zhengac1307a2014-04-22 13:36:11 +0800111static void QEMU_NORETURN help(void)
bellardea2384d2004-08-01 21:59:26 +0000112{
Paolo Bonzinie00291c2010-02-04 16:49:56 +0100113 const char *help_msg =
Jeff Cody5f6979c2014-04-28 14:37:18 -0400114 QEMU_IMG_VERSION
Denis V. Lunev10985132016-06-17 17:44:13 +0300115 "usage: qemu-img [standard options] command [command options]\n"
malc3f020d72010-02-08 12:04:56 +0300116 "QEMU disk image utility\n"
117 "\n"
Denis V. Lunev10985132016-06-17 17:44:13 +0300118 " '-h', '--help' display this help and exit\n"
119 " '-V', '--version' output version information and exit\n"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +0300120 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
121 " specify tracing options\n"
Denis V. Lunev10985132016-06-17 17:44:13 +0300122 "\n"
malc3f020d72010-02-08 12:04:56 +0300123 "Command syntax:\n"
Stuart Brady153859b2009-06-07 00:42:17 +0100124#define DEF(option, callback, arg_string) \
125 " " arg_string "\n"
126#include "qemu-img-cmds.h"
127#undef DEF
malc3f020d72010-02-08 12:04:56 +0300128 "\n"
129 "Command parameters:\n"
130 " 'filename' is a disk image filename\n"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000131 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
132 " manual page for a description of the object properties. The most common\n"
133 " object type is a 'secret', which is used to supply passwords and/or\n"
134 " encryption keys.\n"
malc3f020d72010-02-08 12:04:56 +0300135 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400136 " 'cache' is the cache mode used to write the output disk image, the valid\n"
Liu Yuan80ccf932012-04-20 17:10:56 +0800137 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
138 " 'directsync' and 'unsafe' (default for convert)\n"
Stefan Hajnoczibb87fdf2014-09-02 11:01:02 +0100139 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
140 " options are the same as for the 'cache' option\n"
malc3f020d72010-02-08 12:04:56 +0300141 " 'size' is the disk image size in bytes. Optional suffixes\n"
Kevin Wolf5e009842013-06-05 14:19:27 +0200142 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
143 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
144 " supported. 'b' is ignored.\n"
malc3f020d72010-02-08 12:04:56 +0300145 " 'output_filename' is the destination disk image filename\n"
146 " 'output_fmt' is the destination format\n"
147 " 'options' is a comma separated list of format specific options in a\n"
148 " name=value format. Use -o ? for an overview of the options supported by the\n"
149 " used format\n"
Wenchao Xiaef806542013-12-04 17:10:57 +0800150 " 'snapshot_param' is param used for internal snapshot, format\n"
151 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
152 " '[ID_OR_NAME]'\n"
malc3f020d72010-02-08 12:04:56 +0300153 " '-c' indicates that target image must be compressed (qcow format only)\n"
John Snow6e6e55f2017-07-17 20:34:22 -0400154 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
155 " new backing file match exactly. The image doesn't need a working\n"
156 " backing file before rebasing in this case (useful for renaming the\n"
157 " backing file). For image creation, allow creating without attempting\n"
158 " to open the backing file.\n"
malc3f020d72010-02-08 12:04:56 +0300159 " '-h' with or without a command shows this help and lists the supported formats\n"
Jes Sorensen6b837bc2011-03-30 14:16:25 +0200160 " '-p' show progress of command (only certain commands)\n"
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100161 " '-q' use Quiet mode - do not print any output (except errors)\n"
Peter Lieven11b66992013-10-24 12:07:05 +0200162 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
163 " contain only zeros for qemu-img to create a sparse image during\n"
164 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
165 " unallocated or zero sectors, and the destination image will always be\n"
166 " fully allocated\n"
Benoît Canetc054b3f2012-09-05 13:09:02 +0200167 " '--output' takes the format in which the output must be done (human or json)\n"
Alexandre Derumierb2e10492013-09-02 19:07:24 +0100168 " '-n' skips the target volume creation (useful if the volume is created\n"
169 " prior to running qemu-img)\n"
malc3f020d72010-02-08 12:04:56 +0300170 "\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200171 "Parameters to check subcommand:\n"
172 " '-r' tries to repair any inconsistencies that are found during the check.\n"
173 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
174 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
Stefan Weil0546b8c2012-08-10 22:03:25 +0200175 " hiding corruption that has already occurred.\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200176 "\n"
Peter Lieven2d9187b2017-02-28 13:40:07 +0100177 "Parameters to convert subcommand:\n"
178 " '-m' specifies how many coroutines work in parallel during the convert\n"
179 " process (defaults to 8)\n"
180 " '-W' allow to write to the target out of order rather than sequential\n"
181 "\n"
malc3f020d72010-02-08 12:04:56 +0300182 "Parameters to snapshot subcommand:\n"
183 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
184 " '-a' applies a snapshot (revert disk to saved state)\n"
185 " '-c' creates a snapshot\n"
186 " '-d' deletes a snapshot\n"
Miroslav Rezaninad14ed182013-02-13 09:09:41 +0100187 " '-l' lists all snapshots in the given image\n"
188 "\n"
189 "Parameters to compare subcommand:\n"
190 " '-f' first image format\n"
191 " '-F' second image format\n"
Reda Sallahi86ce1f62016-08-10 04:43:12 +0200192 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
193 "\n"
194 "Parameters to dd subcommand:\n"
195 " 'bs=BYTES' read and write up to BYTES bytes at a time "
196 "(default: 512)\n"
197 " 'count=N' copy only N input blocks\n"
198 " 'if=FILE' read from FILE\n"
Reda Sallahif7c15532016-08-10 16:16:09 +0200199 " 'of=FILE' write to FILE\n"
200 " 'skip=N' skip N bs-sized blocks at the start of input\n";
Paolo Bonzinie00291c2010-02-04 16:49:56 +0100201
202 printf("%s\nSupported formats:", help_msg);
Andrey Shinkevich9ac404c2019-03-07 16:33:58 +0300203 bdrv_iterate_format(format_print, NULL, false);
Eric Blakef5048cb2017-08-03 11:33:53 -0500204 printf("\n\n" QEMU_HELP_BOTTOM "\n");
Fam Zhengac1307a2014-04-22 13:36:11 +0800205 exit(EXIT_SUCCESS);
bellardea2384d2004-08-01 21:59:26 +0000206}
207
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000208static QemuOptsList qemu_object_opts = {
209 .name = "object",
210 .implied_opt_name = "qom-type",
211 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
212 .desc = {
213 { }
214 },
215};
216
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +0200217static bool qemu_img_object_print_help(const char *type, QemuOpts *opts)
218{
219 if (user_creatable_print_help(type, opts)) {
220 exit(0);
221 }
222 return true;
223}
224
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000225static QemuOptsList qemu_source_opts = {
226 .name = "source",
227 .implied_opt_name = "file",
228 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
229 .desc = {
230 { }
231 },
232};
233
Stefan Weil7c30f652013-06-16 17:01:05 +0200234static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100235{
236 int ret = 0;
237 if (!quiet) {
238 va_list args;
239 va_start(args, fmt);
240 ret = vprintf(fmt, args);
241 va_end(args);
242 }
243 return ret;
244}
245
bellardea2384d2004-08-01 21:59:26 +0000246
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100247static int print_block_option_help(const char *filename, const char *fmt)
248{
249 BlockDriver *drv, *proto_drv;
Chunyan Liu83d05212014-06-05 17:20:51 +0800250 QemuOptsList *create_opts = NULL;
Max Reitzb65a5e12015-02-05 13:58:12 -0500251 Error *local_err = NULL;
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100252
253 /* Find driver and parse its options */
254 drv = bdrv_find_format(fmt);
255 if (!drv) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100256 error_report("Unknown file format '%s'", fmt);
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100257 return 1;
258 }
259
Max Reitzd402b6a2018-05-09 23:00:21 +0200260 if (!drv->create_opts) {
261 error_report("Format driver '%s' does not support image creation", fmt);
262 return 1;
263 }
264
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800265 create_opts = qemu_opts_append(create_opts, drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100266 if (filename) {
Max Reitzb65a5e12015-02-05 13:58:12 -0500267 proto_drv = bdrv_find_protocol(filename, true, &local_err);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100268 if (!proto_drv) {
Markus Armbruster2867ce42015-03-12 16:08:02 +0100269 error_report_err(local_err);
Chunyan Liu83d05212014-06-05 17:20:51 +0800270 qemu_opts_free(create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100271 return 1;
272 }
Max Reitzd402b6a2018-05-09 23:00:21 +0200273 if (!proto_drv->create_opts) {
Max Reitzf0998872018-11-19 11:19:20 +0100274 error_report("Protocol driver '%s' does not support image creation",
Max Reitzd402b6a2018-05-09 23:00:21 +0200275 proto_drv->format_name);
Max Reitz3ecd5a42018-11-19 11:19:21 +0100276 qemu_opts_free(create_opts);
Max Reitzd402b6a2018-05-09 23:00:21 +0200277 return 1;
278 }
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800279 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100280 }
281
Max Reitzf4619af2019-04-13 17:20:37 +0200282 if (filename) {
283 printf("Supported options:\n");
284 } else {
285 printf("Supported %s options:\n", fmt);
286 }
Max Reitz63898712018-10-19 18:49:25 +0200287 qemu_opts_print_help(create_opts, false);
Chunyan Liu83d05212014-06-05 17:20:51 +0800288 qemu_opts_free(create_opts);
Max Reitzf4619af2019-04-13 17:20:37 +0200289
290 if (!filename) {
291 printf("\n"
292 "The protocol level may support further options.\n"
293 "Specify the target filename to include those options.\n");
294 }
295
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100296 return 0;
297}
298
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000299
Max Reitzefaa7c42016-03-16 19:54:38 +0100300static BlockBackend *img_open_opts(const char *optstr,
Kevin Wolfce099542016-03-15 13:01:04 +0100301 QemuOpts *opts, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800302 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000303{
304 QDict *options;
305 Error *local_err = NULL;
306 BlockBackend *blk;
307 options = qemu_opts_to_qdict(opts, NULL);
Fam Zheng335e9932017-05-03 00:35:39 +0800308 if (force_share) {
309 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
Max Reitz4615f872018-05-02 22:20:50 +0200310 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
Fam Zheng335e9932017-05-03 00:35:39 +0800311 error_report("--force-share/-U conflicts with image options");
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200312 qobject_unref(options);
Fam Zheng335e9932017-05-03 00:35:39 +0800313 return NULL;
314 }
Max Reitz4615f872018-05-02 22:20:50 +0200315 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
Fam Zheng335e9932017-05-03 00:35:39 +0800316 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100317 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000318 if (!blk) {
Daniel P. Berrange143605a2016-04-06 10:16:18 +0100319 error_reportf_err(local_err, "Could not open '%s': ", optstr);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000320 return NULL;
321 }
Kevin Wolfce099542016-03-15 13:01:04 +0100322 blk_set_enable_write_cache(blk, !writethrough);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000323
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000324 return blk;
325}
326
Max Reitzefaa7c42016-03-16 19:54:38 +0100327static BlockBackend *img_open_file(const char *filename,
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100328 QDict *options,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000329 const char *fmt, int flags,
Fam Zheng335e9932017-05-03 00:35:39 +0800330 bool writethrough, bool quiet,
331 bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000332{
333 BlockBackend *blk;
Max Reitz34b5d2c2013-09-05 14:45:29 +0200334 Error *local_err = NULL;
Kevin Wolfad717132010-12-16 15:37:41 +0100335
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100336 if (!options) {
337 options = qdict_new();
338 }
bellard75c23802004-08-27 21:28:58 +0000339 if (fmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -0500340 qdict_put_str(options, "driver", fmt);
bellard75c23802004-08-27 21:28:58 +0000341 }
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100342
Fam Zheng335e9932017-05-03 00:35:39 +0800343 if (force_share) {
Eric Blake579cf1d2017-05-15 14:54:39 -0500344 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Fam Zheng335e9932017-05-03 00:35:39 +0800345 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100346 blk = blk_new_open(filename, NULL, options, flags, &local_err);
Max Reitz5bd31322015-02-05 13:58:16 -0500347 if (!blk) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100348 error_reportf_err(local_err, "Could not open '%s': ", filename);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000349 return NULL;
bellard75c23802004-08-27 21:28:58 +0000350 }
Kevin Wolfce099542016-03-15 13:01:04 +0100351 blk_set_enable_write_cache(blk, !writethrough);
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100352
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200353 return blk;
bellard75c23802004-08-27 21:28:58 +0000354}
355
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000356
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100357static int img_add_key_secrets(void *opaque,
358 const char *name, const char *value,
359 Error **errp)
360{
361 QDict *options = opaque;
362
363 if (g_str_has_suffix(name, "key-secret")) {
Eric Blake187f47e2017-06-24 12:10:07 -0600364 qdict_put_str(options, name, value);
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100365 }
366
367 return 0;
368}
369
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100370
Max Reitzefaa7c42016-03-16 19:54:38 +0100371static BlockBackend *img_open(bool image_opts,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000372 const char *filename,
Kevin Wolfce099542016-03-15 13:01:04 +0100373 const char *fmt, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800374 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000375{
376 BlockBackend *blk;
377 if (image_opts) {
378 QemuOpts *opts;
379 if (fmt) {
380 error_report("--image-opts and --format are mutually exclusive");
381 return NULL;
382 }
383 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
384 filename, true);
385 if (!opts) {
386 return NULL;
387 }
Fam Zheng335e9932017-05-03 00:35:39 +0800388 blk = img_open_opts(filename, opts, flags, writethrough, quiet,
389 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000390 } else {
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100391 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
Fam Zheng335e9932017-05-03 00:35:39 +0800392 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000393 }
394 return blk;
395}
396
397
Chunyan Liu83d05212014-06-05 17:20:51 +0800398static int add_old_style_options(const char *fmt, QemuOpts *opts,
Jes Sorenseneec77d92010-12-07 17:44:34 +0100399 const char *base_filename,
400 const char *base_fmt)
Kevin Wolfefa84d42009-05-18 16:42:12 +0200401{
Markus Armbruster6750e792015-02-12 17:43:08 +0100402 Error *err = NULL;
403
Kevin Wolfefa84d42009-05-18 16:42:12 +0200404 if (base_filename) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100405 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +0100406 if (err) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100407 error_report("Backing file not supported for file format '%s'",
408 fmt);
Markus Armbruster6750e792015-02-12 17:43:08 +0100409 error_free(err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900410 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200411 }
412 }
413 if (base_fmt) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100414 qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +0100415 if (err) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100416 error_report("Backing file format not supported for file "
417 "format '%s'", fmt);
Markus Armbruster6750e792015-02-12 17:43:08 +0100418 error_free(err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900419 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200420 }
421 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900422 return 0;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200423}
424
Markus Armbruster606caa02017-02-21 21:14:04 +0100425static int64_t cvtnum(const char *s)
426{
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100427 int err;
Markus Armbrusterf46bfdb2017-02-21 21:14:07 +0100428 uint64_t value;
Markus Armbruster606caa02017-02-21 21:14:04 +0100429
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100430 err = qemu_strtosz(s, NULL, &value);
431 if (err < 0) {
432 return err;
433 }
Markus Armbrusterf46bfdb2017-02-21 21:14:07 +0100434 if (value > INT64_MAX) {
435 return -ERANGE;
436 }
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100437 return value;
Markus Armbruster606caa02017-02-21 21:14:04 +0100438}
439
bellardea2384d2004-08-01 21:59:26 +0000440static int img_create(int argc, char **argv)
441{
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200442 int c;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100443 uint64_t img_size = -1;
bellardea2384d2004-08-01 21:59:26 +0000444 const char *fmt = "raw";
aliguori9230eaf2009-03-28 17:55:19 +0000445 const char *base_fmt = NULL;
bellardea2384d2004-08-01 21:59:26 +0000446 const char *filename;
447 const char *base_filename = NULL;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200448 char *options = NULL;
Luiz Capitulino9b375252012-11-30 10:52:05 -0200449 Error *local_err = NULL;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100450 bool quiet = false;
John Snow6e6e55f2017-07-17 20:34:22 -0400451 int flags = 0;
ths3b46e622007-09-17 08:09:54 +0000452
bellardea2384d2004-08-01 21:59:26 +0000453 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000454 static const struct option long_options[] = {
455 {"help", no_argument, 0, 'h'},
456 {"object", required_argument, 0, OPTION_OBJECT},
457 {0, 0, 0, 0}
458 };
John Snow6e6e55f2017-07-17 20:34:22 -0400459 c = getopt_long(argc, argv, ":F:b:f:ho:qu",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000460 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100461 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000462 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100463 }
bellardea2384d2004-08-01 21:59:26 +0000464 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800465 case ':':
466 missing_argument(argv[optind - 1]);
467 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100468 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800469 unrecognized_option(argv[optind - 1]);
470 break;
bellardea2384d2004-08-01 21:59:26 +0000471 case 'h':
472 help();
473 break;
aliguori9230eaf2009-03-28 17:55:19 +0000474 case 'F':
475 base_fmt = optarg;
476 break;
bellardea2384d2004-08-01 21:59:26 +0000477 case 'b':
478 base_filename = optarg;
479 break;
480 case 'f':
481 fmt = optarg;
482 break;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200483 case 'o':
Kevin Wolf77386bf2014-02-21 16:24:04 +0100484 if (!is_valid_option_list(optarg)) {
485 error_report("Invalid option list: %s", optarg);
486 goto fail;
487 }
488 if (!options) {
489 options = g_strdup(optarg);
490 } else {
491 char *old_options = options;
492 options = g_strdup_printf("%s,%s", options, optarg);
493 g_free(old_options);
494 }
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200495 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100496 case 'q':
497 quiet = true;
498 break;
John Snow6e6e55f2017-07-17 20:34:22 -0400499 case 'u':
500 flags |= BDRV_O_NO_BACKING;
501 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000502 case OPTION_OBJECT: {
503 QemuOpts *opts;
504 opts = qemu_opts_parse_noisily(&qemu_object_opts,
505 optarg, true);
506 if (!opts) {
507 goto fail;
508 }
509 } break;
bellardea2384d2004-08-01 21:59:26 +0000510 }
511 }
aliguori9230eaf2009-03-28 17:55:19 +0000512
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900513 /* Get the filename */
Kevin Wolfa283cb62014-02-21 16:24:07 +0100514 filename = (optind < argc) ? argv[optind] : NULL;
515 if (options && has_help_option(options)) {
516 g_free(options);
517 return print_block_option_help(filename, fmt);
518 }
519
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100520 if (optind >= argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800521 error_exit("Expecting image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100522 }
Kevin Wolfa283cb62014-02-21 16:24:07 +0100523 optind++;
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900524
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000525 if (qemu_opts_foreach(&qemu_object_opts,
526 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +0200527 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000528 goto fail;
529 }
530
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100531 /* Get image size, if specified */
532 if (optind < argc) {
Jes Sorensen70b4f4b2011-01-05 11:41:02 +0100533 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +0100534
535 sval = cvtnum(argv[optind++]);
536 if (sval < 0) {
liguang79443392012-12-17 09:49:23 +0800537 if (sval == -ERANGE) {
538 error_report("Image size must be less than 8 EiB!");
539 } else {
540 error_report("Invalid image size specified! You may use k, M, "
Kevin Wolf5e009842013-06-05 14:19:27 +0200541 "G, T, P or E suffixes for ");
542 error_report("kilobytes, megabytes, gigabytes, terabytes, "
543 "petabytes and exabytes.");
liguang79443392012-12-17 09:49:23 +0800544 }
Kevin Wolf77386bf2014-02-21 16:24:04 +0100545 goto fail;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100546 }
547 img_size = (uint64_t)sval;
548 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200549 if (optind != argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800550 error_exit("Unexpected argument: %s", argv[optind]);
Kevin Wolffc11eb22013-08-05 10:53:04 +0200551 }
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100552
Luiz Capitulino9b375252012-11-30 10:52:05 -0200553 bdrv_img_create(filename, fmt, base_filename, base_fmt,
John Snow6e6e55f2017-07-17 20:34:22 -0400554 options, img_size, flags, quiet, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100555 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100556 error_reportf_err(local_err, "%s: ", filename);
Kevin Wolf77386bf2014-02-21 16:24:04 +0100557 goto fail;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900558 }
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200559
Kevin Wolf77386bf2014-02-21 16:24:04 +0100560 g_free(options);
bellardea2384d2004-08-01 21:59:26 +0000561 return 0;
Kevin Wolf77386bf2014-02-21 16:24:04 +0100562
563fail:
564 g_free(options);
565 return 1;
bellardea2384d2004-08-01 21:59:26 +0000566}
567
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100568static void dump_json_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500569{
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500570 QString *str;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500571 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +0100572 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600573
574 visit_type_ImageCheck(v, NULL, &check, &error_abort);
575 visit_complete(v, &obj);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500576 str = qobject_to_json_pretty(obj);
577 assert(str != NULL);
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100578 qprintf(quiet, "%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200579 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600580 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200581 qobject_unref(str);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500582}
583
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100584static void dump_human_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500585{
586 if (!(check->corruptions || check->leaks || check->check_errors)) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100587 qprintf(quiet, "No errors were found on the image.\n");
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500588 } else {
589 if (check->corruptions) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100590 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
591 "Data may be corrupted, or further writes to the image "
592 "may corrupt it.\n",
593 check->corruptions);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500594 }
595
596 if (check->leaks) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100597 qprintf(quiet,
598 "\n%" PRId64 " leaked clusters were found on the image.\n"
599 "This means waste of disk space, but no harm to data.\n",
600 check->leaks);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500601 }
602
603 if (check->check_errors) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100604 qprintf(quiet,
605 "\n%" PRId64
606 " internal errors have occurred during the check.\n",
607 check->check_errors);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500608 }
609 }
610
611 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100612 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
613 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
614 check->allocated_clusters, check->total_clusters,
615 check->allocated_clusters * 100.0 / check->total_clusters,
616 check->fragmented_clusters * 100.0 / check->allocated_clusters,
617 check->compressed_clusters * 100.0 /
618 check->allocated_clusters);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500619 }
620
621 if (check->image_end_offset) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100622 qprintf(quiet,
623 "Image end offset: %" PRId64 "\n", check->image_end_offset);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500624 }
625}
626
627static int collect_image_check(BlockDriverState *bs,
628 ImageCheck *check,
629 const char *filename,
630 const char *fmt,
631 int fix)
632{
633 int ret;
634 BdrvCheckResult result;
635
636 ret = bdrv_check(bs, &result, fix);
637 if (ret < 0) {
638 return ret;
639 }
640
641 check->filename = g_strdup(filename);
642 check->format = g_strdup(bdrv_get_format_name(bs));
643 check->check_errors = result.check_errors;
644 check->corruptions = result.corruptions;
645 check->has_corruptions = result.corruptions != 0;
646 check->leaks = result.leaks;
647 check->has_leaks = result.leaks != 0;
648 check->corruptions_fixed = result.corruptions_fixed;
649 check->has_corruptions_fixed = result.corruptions != 0;
650 check->leaks_fixed = result.leaks_fixed;
651 check->has_leaks_fixed = result.leaks != 0;
652 check->image_end_offset = result.image_end_offset;
653 check->has_image_end_offset = result.image_end_offset != 0;
654 check->total_clusters = result.bfi.total_clusters;
655 check->has_total_clusters = result.bfi.total_clusters != 0;
656 check->allocated_clusters = result.bfi.allocated_clusters;
657 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
658 check->fragmented_clusters = result.bfi.fragmented_clusters;
659 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
Stefan Hajnoczie6439d72013-02-07 17:15:04 +0100660 check->compressed_clusters = result.bfi.compressed_clusters;
661 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500662
663 return 0;
664}
665
Kevin Wolfe076f332010-06-29 11:43:13 +0200666/*
667 * Checks an image for consistency. Exit codes:
668 *
Max Reitzd6635c42014-06-02 22:15:21 +0200669 * 0 - Check completed, image is good
670 * 1 - Check not completed because of internal errors
671 * 2 - Check completed, image is corrupted
672 * 3 - Check completed, image has leaked clusters, but is good otherwise
673 * 63 - Checks are not supported by the image format
Kevin Wolfe076f332010-06-29 11:43:13 +0200674 */
aliguori15859692009-04-21 23:11:53 +0000675static int img_check(int argc, char **argv)
676{
677 int c, ret;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500678 OutputFormat output_format = OFORMAT_HUMAN;
Max Reitz40055952014-07-22 22:58:42 +0200679 const char *filename, *fmt, *output, *cache;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200680 BlockBackend *blk;
aliguori15859692009-04-21 23:11:53 +0000681 BlockDriverState *bs;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200682 int fix = 0;
Kevin Wolfce099542016-03-15 13:01:04 +0100683 int flags = BDRV_O_CHECK;
684 bool writethrough;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200685 ImageCheck *check;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100686 bool quiet = false;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000687 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +0800688 bool force_share = false;
aliguori15859692009-04-21 23:11:53 +0000689
690 fmt = NULL;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500691 output = NULL;
Max Reitz40055952014-07-22 22:58:42 +0200692 cache = BDRV_DEFAULT_CACHE;
Kevin Wolfce099542016-03-15 13:01:04 +0100693
aliguori15859692009-04-21 23:11:53 +0000694 for(;;) {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500695 int option_index = 0;
696 static const struct option long_options[] = {
697 {"help", no_argument, 0, 'h'},
698 {"format", required_argument, 0, 'f'},
Prasad Joshi4fd6a982014-03-25 00:08:54 +0530699 {"repair", required_argument, 0, 'r'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500700 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000701 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000702 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +0800703 {"force-share", no_argument, 0, 'U'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500704 {0, 0, 0, 0}
705 };
Fam Zheng335e9932017-05-03 00:35:39 +0800706 c = getopt_long(argc, argv, ":hf:r:T:qU",
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500707 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100708 if (c == -1) {
aliguori15859692009-04-21 23:11:53 +0000709 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100710 }
aliguori15859692009-04-21 23:11:53 +0000711 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800712 case ':':
713 missing_argument(argv[optind - 1]);
714 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100715 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800716 unrecognized_option(argv[optind - 1]);
717 break;
aliguori15859692009-04-21 23:11:53 +0000718 case 'h':
719 help();
720 break;
721 case 'f':
722 fmt = optarg;
723 break;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200724 case 'r':
725 flags |= BDRV_O_RDWR;
726
727 if (!strcmp(optarg, "leaks")) {
728 fix = BDRV_FIX_LEAKS;
729 } else if (!strcmp(optarg, "all")) {
730 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
731 } else {
Fam Zhengac1307a2014-04-22 13:36:11 +0800732 error_exit("Unknown option value for -r "
733 "(expecting 'leaks' or 'all'): %s", optarg);
Kevin Wolf4534ff52012-05-11 16:07:02 +0200734 }
735 break;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500736 case OPTION_OUTPUT:
737 output = optarg;
738 break;
Max Reitz40055952014-07-22 22:58:42 +0200739 case 'T':
740 cache = optarg;
741 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100742 case 'q':
743 quiet = true;
744 break;
Fam Zheng335e9932017-05-03 00:35:39 +0800745 case 'U':
746 force_share = true;
747 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000748 case OPTION_OBJECT: {
749 QemuOpts *opts;
750 opts = qemu_opts_parse_noisily(&qemu_object_opts,
751 optarg, true);
752 if (!opts) {
753 return 1;
754 }
755 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000756 case OPTION_IMAGE_OPTS:
757 image_opts = true;
758 break;
aliguori15859692009-04-21 23:11:53 +0000759 }
760 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200761 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800762 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100763 }
aliguori15859692009-04-21 23:11:53 +0000764 filename = argv[optind++];
765
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500766 if (output && !strcmp(output, "json")) {
767 output_format = OFORMAT_JSON;
768 } else if (output && !strcmp(output, "human")) {
769 output_format = OFORMAT_HUMAN;
770 } else if (output) {
771 error_report("--output must be used with human or json as argument.");
772 return 1;
773 }
774
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000775 if (qemu_opts_foreach(&qemu_object_opts,
776 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +0200777 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000778 return 1;
779 }
780
Kevin Wolfce099542016-03-15 13:01:04 +0100781 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +0200782 if (ret < 0) {
783 error_report("Invalid source cache option: %s", cache);
784 return 1;
785 }
786
Fam Zheng335e9932017-05-03 00:35:39 +0800787 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
788 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200789 if (!blk) {
790 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900791 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200792 bs = blk_bs(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500793
794 check = g_new0(ImageCheck, 1);
795 ret = collect_image_check(bs, check, filename, fmt, fix);
Kevin Wolfe076f332010-06-29 11:43:13 +0200796
797 if (ret == -ENOTSUP) {
Max Reitz55d492d2014-05-31 21:33:30 +0200798 error_report("This image format does not support checks");
Peter Lievenfefddf92013-10-24 08:53:34 +0200799 ret = 63;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500800 goto fail;
Kevin Wolfe076f332010-06-29 11:43:13 +0200801 }
802
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500803 if (check->corruptions_fixed || check->leaks_fixed) {
804 int corruptions_fixed, leaks_fixed;
805
806 leaks_fixed = check->leaks_fixed;
807 corruptions_fixed = check->corruptions_fixed;
808
809 if (output_format == OFORMAT_HUMAN) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100810 qprintf(quiet,
811 "The following inconsistencies were found and repaired:\n\n"
812 " %" PRId64 " leaked clusters\n"
813 " %" PRId64 " corruptions\n\n"
814 "Double checking the fixed image now...\n",
815 check->leaks_fixed,
816 check->corruptions_fixed);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500817 }
818
819 ret = collect_image_check(bs, check, filename, fmt, 0);
820
821 check->leaks_fixed = leaks_fixed;
822 check->corruptions_fixed = corruptions_fixed;
Kevin Wolfccf34712012-05-11 18:16:54 +0200823 }
824
Max Reitz832390a2014-10-23 15:29:12 +0200825 if (!ret) {
826 switch (output_format) {
827 case OFORMAT_HUMAN:
828 dump_human_image_check(check, quiet);
829 break;
830 case OFORMAT_JSON:
831 dump_json_image_check(check, quiet);
832 break;
833 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500834 }
835
836 if (ret || check->check_errors) {
Max Reitz832390a2014-10-23 15:29:12 +0200837 if (ret) {
838 error_report("Check failed: %s", strerror(-ret));
839 } else {
840 error_report("Check failed");
841 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500842 ret = 1;
843 goto fail;
844 }
845
846 if (check->corruptions) {
847 ret = 2;
848 } else if (check->leaks) {
849 ret = 3;
Kevin Wolfe076f332010-06-29 11:43:13 +0200850 } else {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500851 ret = 0;
aliguori15859692009-04-21 23:11:53 +0000852 }
853
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500854fail:
855 qapi_free_ImageCheck(check);
Markus Armbruster26f54e92014-10-07 13:59:04 +0200856 blk_unref(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500857 return ret;
aliguori15859692009-04-21 23:11:53 +0000858}
859
Max Reitzd4a32382014-10-24 15:57:37 +0200860typedef struct CommonBlockJobCBInfo {
861 BlockDriverState *bs;
862 Error **errp;
863} CommonBlockJobCBInfo;
864
865static void common_block_job_cb(void *opaque, int ret)
866{
867 CommonBlockJobCBInfo *cbi = opaque;
868
869 if (ret < 0) {
870 error_setg_errno(cbi->errp, -ret, "Block job failed");
871 }
Max Reitzd4a32382014-10-24 15:57:37 +0200872}
873
874static void run_block_job(BlockJob *job, Error **errp)
875{
Kevin Wolfb75536c2016-04-18 17:30:17 +0200876 AioContext *aio_context = blk_get_aio_context(job->blk);
sochin.jiang4172a002017-06-15 14:47:33 +0800877 int ret = 0;
Max Reitzd4a32382014-10-24 15:57:37 +0200878
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200879 aio_context_acquire(aio_context);
Kevin Wolf80fa2c72018-04-13 18:50:05 +0200880 job_ref(&job->job);
Max Reitzd4a32382014-10-24 15:57:37 +0200881 do {
Kevin Wolf30a5c882018-05-04 12:17:20 +0200882 float progress = 0.0f;
Max Reitzd4a32382014-10-24 15:57:37 +0200883 aio_poll(aio_context, true);
Kevin Wolf30a5c882018-05-04 12:17:20 +0200884 if (job->job.progress_total) {
885 progress = (float)job->job.progress_current /
886 job->job.progress_total * 100.f;
887 }
888 qemu_progress_print(progress, 0);
Kevin Wolfdf956ae2018-04-25 15:09:58 +0200889 } while (!job_is_ready(&job->job) && !job_is_completed(&job->job));
Max Reitzd4a32382014-10-24 15:57:37 +0200890
Kevin Wolfdbe5e6c2018-04-19 13:04:01 +0200891 if (!job_is_completed(&job->job)) {
Kevin Wolf3d70ff52018-04-24 16:13:52 +0200892 ret = job_complete_sync(&job->job, errp);
sochin.jiang4172a002017-06-15 14:47:33 +0800893 } else {
Kevin Wolf4ad35182018-04-19 17:30:16 +0200894 ret = job->job.ret;
sochin.jiang4172a002017-06-15 14:47:33 +0800895 }
Kevin Wolf80fa2c72018-04-13 18:50:05 +0200896 job_unref(&job->job);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200897 aio_context_release(aio_context);
Max Reitz687fa1d2014-10-24 15:57:39 +0200898
sochin.jiang4172a002017-06-15 14:47:33 +0800899 /* publish completion progress only when success */
900 if (!ret) {
901 qemu_progress_print(100.f, 0);
902 }
Max Reitzd4a32382014-10-24 15:57:37 +0200903}
904
bellardea2384d2004-08-01 21:59:26 +0000905static int img_commit(int argc, char **argv)
906{
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400907 int c, ret, flags;
Max Reitz1b22bff2014-10-24 15:57:40 +0200908 const char *filename, *fmt, *cache, *base;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200909 BlockBackend *blk;
Max Reitzd4a32382014-10-24 15:57:37 +0200910 BlockDriverState *bs, *base_bs;
Kevin Wolf4ef85a92017-01-25 19:16:34 +0100911 BlockJob *job;
Max Reitz687fa1d2014-10-24 15:57:39 +0200912 bool progress = false, quiet = false, drop = false;
Kevin Wolfce099542016-03-15 13:01:04 +0100913 bool writethrough;
Max Reitzd4a32382014-10-24 15:57:37 +0200914 Error *local_err = NULL;
915 CommonBlockJobCBInfo cbi;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000916 bool image_opts = false;
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200917 AioContext *aio_context;
bellardea2384d2004-08-01 21:59:26 +0000918
919 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400920 cache = BDRV_DEFAULT_CACHE;
Max Reitz1b22bff2014-10-24 15:57:40 +0200921 base = NULL;
bellardea2384d2004-08-01 21:59:26 +0000922 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000923 static const struct option long_options[] = {
924 {"help", no_argument, 0, 'h'},
925 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000926 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000927 {0, 0, 0, 0}
928 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800929 c = getopt_long(argc, argv, ":f:ht:b:dpq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000930 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100931 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000932 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100933 }
bellardea2384d2004-08-01 21:59:26 +0000934 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800935 case ':':
936 missing_argument(argv[optind - 1]);
937 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100938 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800939 unrecognized_option(argv[optind - 1]);
940 break;
bellardea2384d2004-08-01 21:59:26 +0000941 case 'h':
942 help();
943 break;
944 case 'f':
945 fmt = optarg;
946 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400947 case 't':
948 cache = optarg;
949 break;
Max Reitz1b22bff2014-10-24 15:57:40 +0200950 case 'b':
951 base = optarg;
952 /* -b implies -d */
953 drop = true;
954 break;
Max Reitz9a86fe42014-10-24 15:57:38 +0200955 case 'd':
956 drop = true;
957 break;
Max Reitz687fa1d2014-10-24 15:57:39 +0200958 case 'p':
959 progress = true;
960 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100961 case 'q':
962 quiet = true;
963 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000964 case OPTION_OBJECT: {
965 QemuOpts *opts;
966 opts = qemu_opts_parse_noisily(&qemu_object_opts,
967 optarg, true);
968 if (!opts) {
969 return 1;
970 }
971 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000972 case OPTION_IMAGE_OPTS:
973 image_opts = true;
974 break;
bellardea2384d2004-08-01 21:59:26 +0000975 }
976 }
Max Reitz687fa1d2014-10-24 15:57:39 +0200977
978 /* Progress is not shown in Quiet mode */
979 if (quiet) {
980 progress = false;
981 }
982
Kevin Wolffc11eb22013-08-05 10:53:04 +0200983 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800984 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100985 }
bellardea2384d2004-08-01 21:59:26 +0000986 filename = argv[optind++];
987
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000988 if (qemu_opts_foreach(&qemu_object_opts,
989 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +0200990 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000991 return 1;
992 }
993
Max Reitz9a86fe42014-10-24 15:57:38 +0200994 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
Kevin Wolfce099542016-03-15 13:01:04 +0100995 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400996 if (ret < 0) {
997 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczia3981eb2014-08-26 19:17:54 +0100998 return 1;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400999 }
1000
Fam Zheng335e9932017-05-03 00:35:39 +08001001 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
1002 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001003 if (!blk) {
1004 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001005 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001006 bs = blk_bs(blk);
1007
Max Reitz687fa1d2014-10-24 15:57:39 +02001008 qemu_progress_init(progress, 1.f);
1009 qemu_progress_print(0.f, 100);
1010
Max Reitz1b22bff2014-10-24 15:57:40 +02001011 if (base) {
1012 base_bs = bdrv_find_backing_image(bs, base);
1013 if (!base_bs) {
Max Reitz6b33f3a2016-12-01 03:05:08 +01001014 error_setg(&local_err,
1015 "Did not find '%s' in the backing chain of '%s'",
1016 base, filename);
Max Reitz1b22bff2014-10-24 15:57:40 +02001017 goto done;
1018 }
1019 } else {
1020 /* This is different from QMP, which by default uses the deepest file in
1021 * the backing chain (i.e., the very base); however, the traditional
1022 * behavior of qemu-img commit is using the immediate backing file. */
Kevin Wolf760e0062015-06-17 14:55:21 +02001023 base_bs = backing_bs(bs);
Max Reitz1b22bff2014-10-24 15:57:40 +02001024 if (!base_bs) {
1025 error_setg(&local_err, "Image does not have a backing file");
1026 goto done;
1027 }
bellardea2384d2004-08-01 21:59:26 +00001028 }
1029
Max Reitzd4a32382014-10-24 15:57:37 +02001030 cbi = (CommonBlockJobCBInfo){
1031 .errp = &local_err,
1032 .bs = bs,
1033 };
1034
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001035 aio_context = bdrv_get_aio_context(bs);
1036 aio_context_acquire(aio_context);
Kevin Wolfbb02b652018-04-19 17:54:56 +02001037 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, 0,
Kevin Wolf0db832f2017-02-20 18:10:05 +01001038 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
Fam Zheng78bbd912017-04-21 20:27:04 +08001039 &cbi, false, &local_err);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001040 aio_context_release(aio_context);
Max Reitzd4a32382014-10-24 15:57:37 +02001041 if (local_err) {
1042 goto done;
1043 }
1044
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001045 /* When the block job completes, the BlockBackend reference will point to
1046 * the old backing file. In order to avoid that the top image is already
1047 * deleted, so we can still empty it afterwards, increment the reference
1048 * counter here preemptively. */
Max Reitz9a86fe42014-10-24 15:57:38 +02001049 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001050 bdrv_ref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001051 }
1052
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001053 job = block_job_get("commit");
Liam Merwick2e2db262018-11-05 21:38:37 +00001054 assert(job);
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001055 run_block_job(job, &local_err);
Max Reitz9a86fe42014-10-24 15:57:38 +02001056 if (local_err) {
1057 goto unref_backing;
1058 }
1059
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001060 if (!drop && bs->drv->bdrv_make_empty) {
1061 ret = bs->drv->bdrv_make_empty(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001062 if (ret) {
1063 error_setg_errno(&local_err, -ret, "Could not empty %s",
1064 filename);
1065 goto unref_backing;
1066 }
1067 }
1068
1069unref_backing:
1070 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001071 bdrv_unref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001072 }
Max Reitzd4a32382014-10-24 15:57:37 +02001073
1074done:
Max Reitz687fa1d2014-10-24 15:57:39 +02001075 qemu_progress_end();
1076
Markus Armbruster26f54e92014-10-07 13:59:04 +02001077 blk_unref(blk);
Max Reitzd4a32382014-10-24 15:57:37 +02001078
1079 if (local_err) {
Markus Armbruster6936f292015-02-10 15:14:02 +01001080 error_report_err(local_err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001081 return 1;
1082 }
Max Reitzd4a32382014-10-24 15:57:37 +02001083
1084 qprintf(quiet, "Image committed.\n");
bellardea2384d2004-08-01 21:59:26 +00001085 return 0;
1086}
1087
Dmitry Konishchevf6a00aa2011-05-18 15:03:59 +04001088/*
Eric Blakedebb38a2017-10-11 22:47:11 -05001089 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1090 * of the first sector boundary within buf where the sector contains a
1091 * non-zero byte. This function is robust to a buffer that is not
1092 * sector-aligned.
1093 */
1094static int64_t find_nonzero(const uint8_t *buf, int64_t n)
1095{
1096 int64_t i;
1097 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);
1098
1099 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
1100 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
1101 return i;
1102 }
1103 }
1104 if (i < n && !buffer_is_zero(buf + i, n - end)) {
1105 return i;
1106 }
1107 return -1;
1108}
1109
1110/*
thsf58c7b32008-06-05 21:53:49 +00001111 * Returns true iff the first sector pointed to by 'buf' contains at least
1112 * a non-NUL byte.
1113 *
1114 * 'pnum' is set to the number of sectors (including and immediately following
1115 * the first one) that are known to be in the same allocated/unallocated state.
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001116 * The function will try to align the end offset to alignment boundaries so
1117 * that the request will at least end aligned and consequtive requests will
1118 * also start at an aligned offset.
thsf58c7b32008-06-05 21:53:49 +00001119 */
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001120static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
1121 int64_t sector_num, int alignment)
bellardea2384d2004-08-01 21:59:26 +00001122{
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001123 bool is_zero;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001124 int i, tail;
bellardea2384d2004-08-01 21:59:26 +00001125
1126 if (n <= 0) {
1127 *pnum = 0;
1128 return 0;
1129 }
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001130 is_zero = buffer_is_zero(buf, 512);
bellardea2384d2004-08-01 21:59:26 +00001131 for(i = 1; i < n; i++) {
1132 buf += 512;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001133 if (is_zero != buffer_is_zero(buf, 512)) {
bellardea2384d2004-08-01 21:59:26 +00001134 break;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001135 }
bellardea2384d2004-08-01 21:59:26 +00001136 }
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001137
1138 tail = (sector_num + i) & (alignment - 1);
1139 if (tail) {
1140 if (is_zero && i <= tail) {
1141 /* treat unallocated areas which only consist
1142 * of a small tail as allocated. */
1143 is_zero = false;
1144 }
1145 if (!is_zero) {
1146 /* align up end offset of allocated areas. */
1147 i += alignment - tail;
1148 i = MIN(i, n);
1149 } else {
1150 /* align down end offset of zero areas. */
1151 i -= tail;
1152 }
1153 }
bellardea2384d2004-08-01 21:59:26 +00001154 *pnum = i;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001155 return !is_zero;
bellardea2384d2004-08-01 21:59:26 +00001156}
1157
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001158/*
Kevin Wolfa22f1232011-08-26 15:27:13 +02001159 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1160 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1161 * breaking up write requests for only small sparse areas.
1162 */
1163static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001164 int min, int64_t sector_num, int alignment)
Kevin Wolfa22f1232011-08-26 15:27:13 +02001165{
1166 int ret;
1167 int num_checked, num_used;
1168
1169 if (n < min) {
1170 min = n;
1171 }
1172
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001173 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001174 if (!ret) {
1175 return ret;
1176 }
1177
1178 num_used = *pnum;
1179 buf += BDRV_SECTOR_SIZE * *pnum;
1180 n -= *pnum;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001181 sector_num += *pnum;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001182 num_checked = num_used;
1183
1184 while (n > 0) {
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001185 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001186
1187 buf += BDRV_SECTOR_SIZE * *pnum;
1188 n -= *pnum;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001189 sector_num += *pnum;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001190 num_checked += *pnum;
1191 if (ret) {
1192 num_used = num_checked;
1193 } else if (*pnum >= min) {
1194 break;
1195 }
1196 }
1197
1198 *pnum = num_used;
1199 return 1;
1200}
1201
1202/*
Eric Blakedc61cd32017-10-11 22:47:14 -05001203 * Compares two buffers sector by sector. Returns 0 if the first
1204 * sector of each buffer matches, non-zero otherwise.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001205 *
Eric Blakedc61cd32017-10-11 22:47:14 -05001206 * pnum is set to the sector-aligned size of the buffer prefix that
1207 * has the same matching status as the first sector.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001208 */
Eric Blakedc61cd32017-10-11 22:47:14 -05001209static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
1210 int64_t bytes, int64_t *pnum)
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001211{
Radim Krčmář8c1ac472015-02-20 17:06:15 +01001212 bool res;
Eric Blakedc61cd32017-10-11 22:47:14 -05001213 int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001214
Eric Blakedc61cd32017-10-11 22:47:14 -05001215 assert(bytes > 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001216
Eric Blakedc61cd32017-10-11 22:47:14 -05001217 res = !!memcmp(buf1, buf2, i);
1218 while (i < bytes) {
1219 int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001220
Eric Blakedc61cd32017-10-11 22:47:14 -05001221 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001222 break;
1223 }
Eric Blakedc61cd32017-10-11 22:47:14 -05001224 i += len;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001225 }
1226
1227 *pnum = i;
1228 return res;
1229}
1230
Stefano Garzarella97ede572019-05-08 12:43:24 +02001231#define IO_BUF_SIZE (2 * MiB)
bellardea2384d2004-08-01 21:59:26 +00001232
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001233/*
1234 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1235 *
Eric Blake0608e402017-10-11 22:47:12 -05001236 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1237 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1238 * failure), and 4 on error (the exit status for read errors), after emitting
1239 * an error message.
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001240 *
Max Reitzf1d3cd72015-02-05 13:58:18 -05001241 * @param blk: BlockBackend for the image
Eric Blakec41508e2017-10-11 22:47:13 -05001242 * @param offset: Starting offset to check
1243 * @param bytes: Number of bytes to check
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001244 * @param filename: Name of disk file we are checking (logging purpose)
1245 * @param buffer: Allocated buffer for storing read data
1246 * @param quiet: Flag for quiet mode
1247 */
Eric Blakec41508e2017-10-11 22:47:13 -05001248static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1249 int64_t bytes, const char *filename,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001250 uint8_t *buffer, bool quiet)
1251{
Eric Blakedebb38a2017-10-11 22:47:11 -05001252 int ret = 0;
1253 int64_t idx;
1254
Eric Blakec41508e2017-10-11 22:47:13 -05001255 ret = blk_pread(blk, offset, buffer, bytes);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001256 if (ret < 0) {
1257 error_report("Error while reading offset %" PRId64 " of %s: %s",
Eric Blakec41508e2017-10-11 22:47:13 -05001258 offset, filename, strerror(-ret));
Eric Blake0608e402017-10-11 22:47:12 -05001259 return 4;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001260 }
Eric Blakec41508e2017-10-11 22:47:13 -05001261 idx = find_nonzero(buffer, bytes);
Eric Blakedebb38a2017-10-11 22:47:11 -05001262 if (idx >= 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001263 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blakec41508e2017-10-11 22:47:13 -05001264 offset + idx);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001265 return 1;
1266 }
1267
1268 return 0;
1269}
1270
1271/*
1272 * Compares two images. Exit codes:
1273 *
1274 * 0 - Images are identical
1275 * 1 - Images differ
1276 * >1 - Error occurred
1277 */
1278static int img_compare(int argc, char **argv)
1279{
Max Reitz40055952014-07-22 22:58:42 +02001280 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001281 BlockBackend *blk1, *blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001282 BlockDriverState *bs1, *bs2;
Eric Blake033d9fc2017-10-11 22:47:16 -05001283 int64_t total_size1, total_size2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001284 uint8_t *buf1 = NULL, *buf2 = NULL;
Eric Blake31826642017-10-11 22:47:08 -05001285 int64_t pnum1, pnum2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001286 int allocated1, allocated2;
1287 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1288 bool progress = false, quiet = false, strict = false;
Max Reitz40055952014-07-22 22:58:42 +02001289 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01001290 bool writethrough;
Eric Blake033d9fc2017-10-11 22:47:16 -05001291 int64_t total_size;
1292 int64_t offset = 0;
1293 int64_t chunk;
Eric Blakedc61cd32017-10-11 22:47:14 -05001294 int c;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001295 uint64_t progress_base;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001296 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08001297 bool force_share = false;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001298
Max Reitz40055952014-07-22 22:58:42 +02001299 cache = BDRV_DEFAULT_CACHE;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001300 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001301 static const struct option long_options[] = {
1302 {"help", no_argument, 0, 'h'},
1303 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001304 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08001305 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001306 {0, 0, 0, 0}
1307 };
Fam Zheng335e9932017-05-03 00:35:39 +08001308 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001309 long_options, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001310 if (c == -1) {
1311 break;
1312 }
1313 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001314 case ':':
1315 missing_argument(argv[optind - 1]);
1316 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001317 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001318 unrecognized_option(argv[optind - 1]);
1319 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001320 case 'h':
1321 help();
1322 break;
1323 case 'f':
1324 fmt1 = optarg;
1325 break;
1326 case 'F':
1327 fmt2 = optarg;
1328 break;
Max Reitz40055952014-07-22 22:58:42 +02001329 case 'T':
1330 cache = optarg;
1331 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001332 case 'p':
1333 progress = true;
1334 break;
1335 case 'q':
1336 quiet = true;
1337 break;
1338 case 's':
1339 strict = true;
1340 break;
Fam Zheng335e9932017-05-03 00:35:39 +08001341 case 'U':
1342 force_share = true;
1343 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001344 case OPTION_OBJECT: {
1345 QemuOpts *opts;
1346 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1347 optarg, true);
1348 if (!opts) {
1349 ret = 2;
1350 goto out4;
1351 }
1352 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001353 case OPTION_IMAGE_OPTS:
1354 image_opts = true;
1355 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001356 }
1357 }
1358
1359 /* Progress is not shown in Quiet mode */
1360 if (quiet) {
1361 progress = false;
1362 }
1363
1364
Kevin Wolffc11eb22013-08-05 10:53:04 +02001365 if (optind != argc - 2) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001366 error_exit("Expecting two image file names");
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001367 }
1368 filename1 = argv[optind++];
1369 filename2 = argv[optind++];
1370
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001371 if (qemu_opts_foreach(&qemu_object_opts,
1372 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02001373 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001374 ret = 2;
1375 goto out4;
1376 }
1377
Stefan Hajnoczicbda0162014-08-26 19:17:55 +01001378 /* Initialize before goto out */
1379 qemu_progress_init(progress, 2.0);
1380
Kevin Wolfce099542016-03-15 13:01:04 +01001381 flags = 0;
1382 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +02001383 if (ret < 0) {
1384 error_report("Invalid source cache option: %s", cache);
1385 ret = 2;
1386 goto out3;
1387 }
1388
Fam Zheng335e9932017-05-03 00:35:39 +08001389 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1390 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001391 if (!blk1) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001392 ret = 2;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001393 goto out3;
1394 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001395
Fam Zheng335e9932017-05-03 00:35:39 +08001396 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1397 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001398 if (!blk2) {
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001399 ret = 2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001400 goto out2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001401 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001402 bs1 = blk_bs(blk1);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001403 bs2 = blk_bs(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001404
Max Reitzf1d3cd72015-02-05 13:58:18 -05001405 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1406 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
Eric Blake033d9fc2017-10-11 22:47:16 -05001407 total_size1 = blk_getlength(blk1);
1408 if (total_size1 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001409 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001410 filename1, strerror(-total_size1));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001411 ret = 4;
1412 goto out;
1413 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001414 total_size2 = blk_getlength(blk2);
1415 if (total_size2 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001416 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001417 filename2, strerror(-total_size2));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001418 ret = 4;
1419 goto out;
1420 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001421 total_size = MIN(total_size1, total_size2);
1422 progress_base = MAX(total_size1, total_size2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001423
1424 qemu_progress_print(0, 100);
1425
Eric Blake033d9fc2017-10-11 22:47:16 -05001426 if (strict && total_size1 != total_size2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001427 ret = 1;
1428 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1429 goto out;
1430 }
1431
Eric Blake033d9fc2017-10-11 22:47:16 -05001432 while (offset < total_size) {
Eric Blake31826642017-10-11 22:47:08 -05001433 int status1, status2;
Fam Zheng67a0fd22016-01-26 11:58:48 +08001434
Eric Blake033d9fc2017-10-11 22:47:16 -05001435 status1 = bdrv_block_status_above(bs1, NULL, offset,
1436 total_size1 - offset, &pnum1, NULL,
1437 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001438 if (status1 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001439 ret = 3;
1440 error_report("Sector allocation test failed for %s", filename1);
1441 goto out;
1442 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001443 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001444
Eric Blake033d9fc2017-10-11 22:47:16 -05001445 status2 = bdrv_block_status_above(bs2, NULL, offset,
1446 total_size2 - offset, &pnum2, NULL,
1447 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001448 if (status2 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001449 ret = 3;
1450 error_report("Sector allocation test failed for %s", filename2);
1451 goto out;
1452 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001453 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
Eric Blake7daddc62017-10-11 22:47:09 -05001454
1455 assert(pnum1 && pnum2);
Eric Blake033d9fc2017-10-11 22:47:16 -05001456 chunk = MIN(pnum1, pnum2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001457
Fam Zheng25ad8e62016-01-13 16:37:41 +08001458 if (strict) {
Eric Blake31826642017-10-11 22:47:08 -05001459 if (status1 != status2) {
Fam Zheng25ad8e62016-01-13 16:37:41 +08001460 ret = 1;
1461 qprintf(quiet, "Strict mode: Offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001462 " block status mismatch!\n", offset);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001463 goto out;
1464 }
1465 }
1466 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
Eric Blake7daddc62017-10-11 22:47:09 -05001467 /* nothing to do */
Fam Zheng25ad8e62016-01-13 16:37:41 +08001468 } else if (allocated1 == allocated2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001469 if (allocated1) {
Eric Blakedc61cd32017-10-11 22:47:14 -05001470 int64_t pnum;
1471
Eric Blake033d9fc2017-10-11 22:47:16 -05001472 chunk = MIN(chunk, IO_BUF_SIZE);
1473 ret = blk_pread(blk1, offset, buf1, chunk);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001474 if (ret < 0) {
1475 error_report("Error while reading offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001476 " of %s: %s",
1477 offset, filename1, strerror(-ret));
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001478 ret = 4;
1479 goto out;
1480 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001481 ret = blk_pread(blk2, offset, buf2, chunk);
1482 if (ret < 0) {
1483 error_report("Error while reading offset %" PRId64
1484 " of %s: %s",
1485 offset, filename2, strerror(-ret));
1486 ret = 4;
1487 goto out;
1488 }
1489 ret = compare_buffers(buf1, buf2, chunk, &pnum);
1490 if (ret || pnum != chunk) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001491 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blake033d9fc2017-10-11 22:47:16 -05001492 offset + (ret ? 0 : pnum));
Fam Zheng36452f12013-11-13 20:26:49 +08001493 ret = 1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001494 goto out;
1495 }
1496 }
1497 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001498 chunk = MIN(chunk, IO_BUF_SIZE);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001499 if (allocated1) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001500 ret = check_empty_sectors(blk1, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001501 filename1, buf1, quiet);
1502 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001503 ret = check_empty_sectors(blk2, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001504 filename2, buf1, quiet);
1505 }
1506 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001507 goto out;
1508 }
1509 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001510 offset += chunk;
1511 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001512 }
1513
Eric Blake033d9fc2017-10-11 22:47:16 -05001514 if (total_size1 != total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001515 BlockBackend *blk_over;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001516 const char *filename_over;
1517
1518 qprintf(quiet, "Warning: Image size mismatch!\n");
Eric Blake033d9fc2017-10-11 22:47:16 -05001519 if (total_size1 > total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001520 blk_over = blk1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001521 filename_over = filename1;
1522 } else {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001523 blk_over = blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001524 filename_over = filename2;
1525 }
1526
Eric Blake033d9fc2017-10-11 22:47:16 -05001527 while (offset < progress_base) {
1528 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1529 progress_base - offset, &chunk,
1530 NULL, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001531 if (ret < 0) {
1532 ret = 3;
1533 error_report("Sector allocation test failed for %s",
1534 filename_over);
1535 goto out;
1536
1537 }
Eric Blake391cb1a2017-10-11 22:47:10 -05001538 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001539 chunk = MIN(chunk, IO_BUF_SIZE);
1540 ret = check_empty_sectors(blk_over, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001541 filename_over, buf1, quiet);
1542 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001543 goto out;
1544 }
1545 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001546 offset += chunk;
1547 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001548 }
1549 }
1550
1551 qprintf(quiet, "Images are identical.\n");
1552 ret = 0;
1553
1554out:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001555 qemu_vfree(buf1);
1556 qemu_vfree(buf2);
Markus Armbruster26f54e92014-10-07 13:59:04 +02001557 blk_unref(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001558out2:
Markus Armbruster26f54e92014-10-07 13:59:04 +02001559 blk_unref(blk1);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001560out3:
1561 qemu_progress_end();
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001562out4:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001563 return ret;
1564}
1565
Kevin Wolf690c7302015-03-19 13:33:32 +01001566enum ImgConvertBlockStatus {
1567 BLK_DATA,
1568 BLK_ZERO,
1569 BLK_BACKING_FILE,
1570};
1571
Peter Lieven2d9187b2017-02-28 13:40:07 +01001572#define MAX_COROUTINES 16
1573
Kevin Wolf690c7302015-03-19 13:33:32 +01001574typedef struct ImgConvertState {
1575 BlockBackend **src;
1576 int64_t *src_sectors;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001577 int src_num;
Kevin Wolf690c7302015-03-19 13:33:32 +01001578 int64_t total_sectors;
1579 int64_t allocated_sectors;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001580 int64_t allocated_done;
1581 int64_t sector_num;
1582 int64_t wr_offs;
Kevin Wolf690c7302015-03-19 13:33:32 +01001583 enum ImgConvertBlockStatus status;
1584 int64_t sector_next_status;
1585 BlockBackend *target;
1586 bool has_zero_init;
1587 bool compressed;
Max Reitz351c8ef2018-05-01 18:57:49 +02001588 bool unallocated_blocks_are_zero;
Max Reitz4d7c4872019-07-24 19:12:29 +02001589 bool target_is_new;
Kevin Wolf690c7302015-03-19 13:33:32 +01001590 bool target_has_backing;
Max Reitz351c8ef2018-05-01 18:57:49 +02001591 int64_t target_backing_sectors; /* negative if unknown */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001592 bool wr_in_order;
Fam Zhengee5306d2018-06-01 17:26:48 +08001593 bool copy_range;
Max Reitz8eaac022019-05-07 22:35:03 +02001594 bool salvage;
Max Reitz3d96cb92019-05-07 22:35:02 +02001595 bool quiet;
Kevin Wolf690c7302015-03-19 13:33:32 +01001596 int min_sparse;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001597 int alignment;
Kevin Wolf690c7302015-03-19 13:33:32 +01001598 size_t cluster_sectors;
1599 size_t buf_sectors;
Peter Lieven9fd77f92017-04-21 11:11:55 +02001600 long num_coroutines;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001601 int running_coroutines;
1602 Coroutine *co[MAX_COROUTINES];
1603 int64_t wait_sector_num[MAX_COROUTINES];
1604 CoMutex lock;
1605 int ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001606} ImgConvertState;
1607
Peter Lieven2d9187b2017-02-28 13:40:07 +01001608static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1609 int *src_cur, int64_t *src_cur_offset)
Kevin Wolf690c7302015-03-19 13:33:32 +01001610{
Peter Lieven2d9187b2017-02-28 13:40:07 +01001611 *src_cur = 0;
1612 *src_cur_offset = 0;
1613 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1614 *src_cur_offset += s->src_sectors[*src_cur];
1615 (*src_cur)++;
1616 assert(*src_cur < s->src_num);
Kevin Wolf690c7302015-03-19 13:33:32 +01001617 }
1618}
1619
1620static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1621{
Eric Blake31826642017-10-11 22:47:08 -05001622 int64_t src_cur_offset;
1623 int ret, n, src_cur;
Max Reitz351c8ef2018-05-01 18:57:49 +02001624 bool post_backing_zero = false;
Kevin Wolf690c7302015-03-19 13:33:32 +01001625
Peter Lieven2d9187b2017-02-28 13:40:07 +01001626 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
Kevin Wolf690c7302015-03-19 13:33:32 +01001627
1628 assert(s->total_sectors > sector_num);
1629 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1630
Max Reitz351c8ef2018-05-01 18:57:49 +02001631 if (s->target_backing_sectors >= 0) {
1632 if (sector_num >= s->target_backing_sectors) {
1633 post_backing_zero = s->unallocated_blocks_are_zero;
1634 } else if (sector_num + n > s->target_backing_sectors) {
1635 /* Split requests around target_backing_sectors (because
1636 * starting from there, zeros are handled differently) */
1637 n = s->target_backing_sectors - sector_num;
1638 }
1639 }
1640
Kevin Wolf690c7302015-03-19 13:33:32 +01001641 if (s->sector_next_status <= sector_num) {
Max Reitz8eaac022019-05-07 22:35:03 +02001642 uint64_t offset = (sector_num - src_cur_offset) * BDRV_SECTOR_SIZE;
1643 int64_t count;
Eric Blake31826642017-10-11 22:47:08 -05001644
Max Reitz8eaac022019-05-07 22:35:03 +02001645 do {
1646 count = n * BDRV_SECTOR_SIZE;
Eric Blake237d78f2017-10-11 22:47:03 -05001647
Max Reitz8eaac022019-05-07 22:35:03 +02001648 if (s->target_has_backing) {
1649 ret = bdrv_block_status(blk_bs(s->src[src_cur]), offset,
1650 count, &count, NULL, NULL);
1651 } else {
1652 ret = bdrv_block_status_above(blk_bs(s->src[src_cur]), NULL,
1653 offset, count, &count, NULL,
1654 NULL);
1655 }
1656
1657 if (ret < 0) {
1658 if (s->salvage) {
1659 if (n == 1) {
1660 if (!s->quiet) {
1661 warn_report("error while reading block status at "
1662 "offset %" PRIu64 ": %s", offset,
1663 strerror(-ret));
1664 }
1665 /* Just try to read the data, then */
1666 ret = BDRV_BLOCK_DATA;
1667 count = BDRV_SECTOR_SIZE;
1668 } else {
1669 /* Retry on a shorter range */
1670 n = DIV_ROUND_UP(n, 4);
1671 }
1672 } else {
1673 error_report("error while reading block status at offset "
1674 "%" PRIu64 ": %s", offset, strerror(-ret));
1675 return ret;
1676 }
1677 }
1678 } while (ret < 0);
1679
Eric Blake31826642017-10-11 22:47:08 -05001680 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
Kevin Wolf690c7302015-03-19 13:33:32 +01001681
1682 if (ret & BDRV_BLOCK_ZERO) {
Max Reitz351c8ef2018-05-01 18:57:49 +02001683 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
Kevin Wolf690c7302015-03-19 13:33:32 +01001684 } else if (ret & BDRV_BLOCK_DATA) {
1685 s->status = BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001686 } else {
Vladimir Sementsov-Ogievskiy9f1b92a2017-04-07 14:34:04 +03001687 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001688 }
1689
1690 s->sector_next_status = sector_num + n;
1691 }
1692
1693 n = MIN(n, s->sector_next_status - sector_num);
1694 if (s->status == BLK_DATA) {
1695 n = MIN(n, s->buf_sectors);
1696 }
1697
1698 /* We need to write complete clusters for compressed images, so if an
1699 * unallocated area is shorter than that, we must consider the whole
1700 * cluster allocated. */
1701 if (s->compressed) {
1702 if (n < s->cluster_sectors) {
1703 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1704 s->status = BLK_DATA;
1705 } else {
1706 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1707 }
1708 }
1709
1710 return n;
1711}
1712
Peter Lieven2d9187b2017-02-28 13:40:07 +01001713static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1714 int nb_sectors, uint8_t *buf)
Kevin Wolf690c7302015-03-19 13:33:32 +01001715{
Max Reitz8eaac022019-05-07 22:35:03 +02001716 uint64_t single_read_until = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001717 int n, ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001718
Kevin Wolf690c7302015-03-19 13:33:32 +01001719 assert(nb_sectors <= s->buf_sectors);
1720 while (nb_sectors > 0) {
1721 BlockBackend *blk;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001722 int src_cur;
1723 int64_t bs_sectors, src_cur_offset;
Max Reitz8eaac022019-05-07 22:35:03 +02001724 uint64_t offset;
Kevin Wolf690c7302015-03-19 13:33:32 +01001725
1726 /* In the case of compression with multiple source files, we can get a
1727 * nb_sectors that spreads into the next part. So we must be able to
1728 * read across multiple BDSes for one convert_read() call. */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001729 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1730 blk = s->src[src_cur];
1731 bs_sectors = s->src_sectors[src_cur];
Kevin Wolf690c7302015-03-19 13:33:32 +01001732
Max Reitz8eaac022019-05-07 22:35:03 +02001733 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001734
Max Reitz8eaac022019-05-07 22:35:03 +02001735 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1736 if (single_read_until > offset) {
1737 n = 1;
1738 }
1739
1740 ret = blk_co_pread(blk, offset, n << BDRV_SECTOR_BITS, buf, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01001741 if (ret < 0) {
Max Reitz8eaac022019-05-07 22:35:03 +02001742 if (s->salvage) {
1743 if (n > 1) {
1744 single_read_until = offset + (n << BDRV_SECTOR_BITS);
1745 continue;
1746 } else {
1747 if (!s->quiet) {
1748 warn_report("error while reading offset %" PRIu64
1749 ": %s", offset, strerror(-ret));
1750 }
1751 memset(buf, 0, BDRV_SECTOR_SIZE);
1752 }
1753 } else {
1754 return ret;
1755 }
Kevin Wolf690c7302015-03-19 13:33:32 +01001756 }
1757
1758 sector_num += n;
1759 nb_sectors -= n;
1760 buf += n * BDRV_SECTOR_SIZE;
1761 }
1762
1763 return 0;
1764}
1765
Peter Lieven2d9187b2017-02-28 13:40:07 +01001766
1767static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1768 int nb_sectors, uint8_t *buf,
1769 enum ImgConvertBlockStatus status)
Kevin Wolf690c7302015-03-19 13:33:32 +01001770{
1771 int ret;
1772
1773 while (nb_sectors > 0) {
1774 int n = nb_sectors;
Lidong Chendb933fb2017-04-27 10:58:27 +08001775 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1776
Peter Lieven2d9187b2017-02-28 13:40:07 +01001777 switch (status) {
Kevin Wolf690c7302015-03-19 13:33:32 +01001778 case BLK_BACKING_FILE:
1779 /* If we have a backing file, leave clusters unallocated that are
1780 * unallocated in the source image, so that the backing file is
1781 * visible at the respective offset. */
1782 assert(s->target_has_backing);
1783 break;
1784
1785 case BLK_DATA:
Lidong Chendb933fb2017-04-27 10:58:27 +08001786 /* If we're told to keep the target fully allocated (-S 0) or there
1787 * is real non-zero data, we must write it. Otherwise we can treat
1788 * it as zero sectors.
1789 * Compressed clusters need to be written as a whole, so in that
1790 * case we can only save the write if the buffer is completely
1791 * zeroed. */
Kevin Wolf690c7302015-03-19 13:33:32 +01001792 if (!s->min_sparse ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001793 (!s->compressed &&
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001794 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1795 sector_num, s->alignment)) ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001796 (s->compressed &&
1797 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
Kevin Wolf690c7302015-03-19 13:33:32 +01001798 {
Vladimir Sementsov-Ogievskiy265a7e52019-04-22 17:58:38 +03001799 ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1800 n << BDRV_SECTOR_BITS, buf, flags);
Kevin Wolf690c7302015-03-19 13:33:32 +01001801 if (ret < 0) {
1802 return ret;
1803 }
1804 break;
1805 }
1806 /* fall-through */
1807
1808 case BLK_ZERO:
1809 if (s->has_zero_init) {
Lidong Chendb933fb2017-04-27 10:58:27 +08001810 assert(!s->target_has_backing);
Kevin Wolf690c7302015-03-19 13:33:32 +01001811 break;
1812 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01001813 ret = blk_co_pwrite_zeroes(s->target,
1814 sector_num << BDRV_SECTOR_BITS,
Nir Soffera3d6ae22019-03-24 02:20:12 +02001815 n << BDRV_SECTOR_BITS,
1816 BDRV_REQ_MAY_UNMAP);
Kevin Wolf690c7302015-03-19 13:33:32 +01001817 if (ret < 0) {
1818 return ret;
1819 }
1820 break;
1821 }
1822
1823 sector_num += n;
1824 nb_sectors -= n;
1825 buf += n * BDRV_SECTOR_SIZE;
1826 }
1827
1828 return 0;
1829}
1830
Fam Zhengee5306d2018-06-01 17:26:48 +08001831static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1832 int nb_sectors)
1833{
1834 int n, ret;
1835
1836 while (nb_sectors > 0) {
1837 BlockBackend *blk;
1838 int src_cur;
1839 int64_t bs_sectors, src_cur_offset;
1840 int64_t offset;
1841
1842 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1843 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1844 blk = s->src[src_cur];
1845 bs_sectors = s->src_sectors[src_cur];
1846
1847 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1848
1849 ret = blk_co_copy_range(blk, offset, s->target,
1850 sector_num << BDRV_SECTOR_BITS,
Vladimir Sementsov-Ogievskiy67b51fb2018-07-09 19:37:17 +03001851 n << BDRV_SECTOR_BITS, 0, 0);
Fam Zhengee5306d2018-06-01 17:26:48 +08001852 if (ret < 0) {
1853 return ret;
1854 }
1855
1856 sector_num += n;
1857 nb_sectors -= n;
1858 }
1859 return 0;
1860}
1861
Peter Lieven2d9187b2017-02-28 13:40:07 +01001862static void coroutine_fn convert_co_do_copy(void *opaque)
1863{
1864 ImgConvertState *s = opaque;
1865 uint8_t *buf = NULL;
1866 int ret, i;
1867 int index = -1;
1868
1869 for (i = 0; i < s->num_coroutines; i++) {
1870 if (s->co[i] == qemu_coroutine_self()) {
1871 index = i;
1872 break;
1873 }
1874 }
1875 assert(index >= 0);
1876
1877 s->running_coroutines++;
1878 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1879
1880 while (1) {
1881 int n;
1882 int64_t sector_num;
1883 enum ImgConvertBlockStatus status;
Fam Zhengee5306d2018-06-01 17:26:48 +08001884 bool copy_range;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001885
1886 qemu_co_mutex_lock(&s->lock);
1887 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1888 qemu_co_mutex_unlock(&s->lock);
Anton Nefedovb91127e2017-04-26 11:33:15 +03001889 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001890 }
1891 n = convert_iteration_sectors(s, s->sector_num);
1892 if (n < 0) {
1893 qemu_co_mutex_unlock(&s->lock);
1894 s->ret = n;
Anton Nefedovb91127e2017-04-26 11:33:15 +03001895 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001896 }
1897 /* save current sector and allocation status to local variables */
1898 sector_num = s->sector_num;
1899 status = s->status;
1900 if (!s->min_sparse && s->status == BLK_ZERO) {
1901 n = MIN(n, s->buf_sectors);
1902 }
1903 /* increment global sector counter so that other coroutines can
1904 * already continue reading beyond this request */
1905 s->sector_num += n;
1906 qemu_co_mutex_unlock(&s->lock);
1907
1908 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
1909 s->allocated_done += n;
1910 qemu_progress_print(100.0 * s->allocated_done /
1911 s->allocated_sectors, 0);
1912 }
1913
Fam Zhengee5306d2018-06-01 17:26:48 +08001914retry:
1915 copy_range = s->copy_range && s->status == BLK_DATA;
1916 if (status == BLK_DATA && !copy_range) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01001917 ret = convert_co_read(s, sector_num, n, buf);
1918 if (ret < 0) {
1919 error_report("error while reading sector %" PRId64
1920 ": %s", sector_num, strerror(-ret));
1921 s->ret = ret;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001922 }
1923 } else if (!s->min_sparse && status == BLK_ZERO) {
1924 status = BLK_DATA;
1925 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
1926 }
1927
1928 if (s->wr_in_order) {
1929 /* keep writes in order */
Anton Nefedovb91127e2017-04-26 11:33:15 +03001930 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01001931 s->wait_sector_num[index] = sector_num;
1932 qemu_coroutine_yield();
1933 }
1934 s->wait_sector_num[index] = -1;
1935 }
1936
Anton Nefedovb91127e2017-04-26 11:33:15 +03001937 if (s->ret == -EINPROGRESS) {
Fam Zhengee5306d2018-06-01 17:26:48 +08001938 if (copy_range) {
1939 ret = convert_co_copy_range(s, sector_num, n);
1940 if (ret) {
1941 s->copy_range = false;
1942 goto retry;
1943 }
1944 } else {
1945 ret = convert_co_write(s, sector_num, n, buf, status);
1946 }
Anton Nefedovb91127e2017-04-26 11:33:15 +03001947 if (ret < 0) {
1948 error_report("error while writing sector %" PRId64
1949 ": %s", sector_num, strerror(-ret));
1950 s->ret = ret;
1951 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01001952 }
1953
1954 if (s->wr_in_order) {
1955 /* reenter the coroutine that might have waited
1956 * for this write to complete */
1957 s->wr_offs = sector_num + n;
1958 for (i = 0; i < s->num_coroutines; i++) {
1959 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
1960 /*
1961 * A -> B -> A cannot occur because A has
1962 * s->wait_sector_num[i] == -1 during A -> B. Therefore
1963 * B will never enter A during this time window.
1964 */
1965 qemu_coroutine_enter(s->co[i]);
1966 break;
1967 }
1968 }
1969 }
1970 }
1971
Peter Lieven2d9187b2017-02-28 13:40:07 +01001972 qemu_vfree(buf);
1973 s->co[index] = NULL;
1974 s->running_coroutines--;
1975 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
1976 /* the convert job finished successfully */
1977 s->ret = 0;
1978 }
1979}
1980
Kevin Wolf690c7302015-03-19 13:33:32 +01001981static int convert_do_copy(ImgConvertState *s)
1982{
Peter Lieven2d9187b2017-02-28 13:40:07 +01001983 int ret, i, n;
1984 int64_t sector_num = 0;
Kevin Wolf690c7302015-03-19 13:33:32 +01001985
1986 /* Check whether we have zero initialisation or can get it efficiently */
Max Reitz4d7c4872019-07-24 19:12:29 +02001987 if (s->target_is_new && s->min_sparse && !s->target_has_backing) {
1988 s->has_zero_init = bdrv_has_zero_init(blk_bs(s->target));
1989 } else {
1990 s->has_zero_init = false;
1991 }
Kevin Wolf690c7302015-03-19 13:33:32 +01001992
1993 if (!s->has_zero_init && !s->target_has_backing &&
1994 bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
1995 {
Kevin Wolfc9fdcf22019-03-22 13:49:28 +01001996 ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP | BDRV_REQ_NO_FALLBACK);
Kevin Wolf690c7302015-03-19 13:33:32 +01001997 if (ret == 0) {
1998 s->has_zero_init = true;
1999 }
2000 }
2001
2002 /* Allocate buffer for copied data. For compressed images, only one cluster
2003 * can be copied at a time. */
2004 if (s->compressed) {
2005 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
2006 error_report("invalid cluster size");
Peter Lieven2d9187b2017-02-28 13:40:07 +01002007 return -EINVAL;
Kevin Wolf690c7302015-03-19 13:33:32 +01002008 }
2009 s->buf_sectors = s->cluster_sectors;
2010 }
Kevin Wolf690c7302015-03-19 13:33:32 +01002011
Kevin Wolf690c7302015-03-19 13:33:32 +01002012 while (sector_num < s->total_sectors) {
2013 n = convert_iteration_sectors(s, sector_num);
2014 if (n < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002015 return n;
Kevin Wolf690c7302015-03-19 13:33:32 +01002016 }
Max Reitzaad15de2016-03-24 23:33:57 +01002017 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
2018 {
Kevin Wolf690c7302015-03-19 13:33:32 +01002019 s->allocated_sectors += n;
2020 }
2021 sector_num += n;
2022 }
2023
2024 /* Do the copy */
Kevin Wolf690c7302015-03-19 13:33:32 +01002025 s->sector_next_status = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002026 s->ret = -EINPROGRESS;
Kevin Wolf690c7302015-03-19 13:33:32 +01002027
Peter Lieven2d9187b2017-02-28 13:40:07 +01002028 qemu_co_mutex_init(&s->lock);
2029 for (i = 0; i < s->num_coroutines; i++) {
2030 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
2031 s->wait_sector_num[i] = -1;
2032 qemu_coroutine_enter(s->co[i]);
Kevin Wolf690c7302015-03-19 13:33:32 +01002033 }
2034
Anton Nefedovb91127e2017-04-26 11:33:15 +03002035 while (s->running_coroutines) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002036 main_loop_wait(false);
2037 }
2038
2039 if (s->compressed && !s->ret) {
Kevin Wolf690c7302015-03-19 13:33:32 +01002040 /* signal EOF to align */
Pavel Butsykinfe5c1352016-07-22 11:17:40 +03002041 ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01002042 if (ret < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002043 return ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002044 }
2045 }
2046
Peter Lieven2d9187b2017-02-28 13:40:07 +01002047 return s->ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002048}
2049
Peter Lieven6360ab22018-07-13 09:15:39 +02002050#define MAX_BUF_SECTORS 32768
2051
bellardea2384d2004-08-01 21:59:26 +00002052static int img_convert(int argc, char **argv)
2053{
Peter Lieven9fd77f92017-04-21 11:11:55 +02002054 int c, bs_i, flags, src_flags = 0;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002055 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002056 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
2057 *out_filename, *out_baseimg_param, *snapshot_name = NULL;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002058 BlockDriver *drv = NULL, *proto_drv = NULL;
bellardfaea38e2006-08-05 21:31:00 +00002059 BlockDriverInfo bdi;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002060 BlockDriverState *out_bs;
2061 QemuOpts *opts = NULL, *sn_opts = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08002062 QemuOptsList *create_opts = NULL;
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002063 QDict *open_opts = NULL;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002064 char *options = NULL;
Max Reitzcc84d902013-09-06 17:14:26 +02002065 Error *local_err = NULL;
Max Reitz3d96cb92019-05-07 22:35:02 +02002066 bool writethrough, src_writethrough, image_opts = false,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002067 skip_create = false, progress = false, tgt_image_opts = false;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002068 int64_t ret = -EINVAL;
Fam Zheng335e9932017-05-03 00:35:39 +08002069 bool force_share = false;
Fam Zhenge11ce122018-07-27 11:34:01 +08002070 bool explict_min_sparse = false;
bellardea2384d2004-08-01 21:59:26 +00002071
Peter Lieven9fd77f92017-04-21 11:11:55 +02002072 ImgConvertState s = (ImgConvertState) {
2073 /* Need at least 4k of zeros for sparse detection */
2074 .min_sparse = 8,
Fam Zhenge11ce122018-07-27 11:34:01 +08002075 .copy_range = false,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002076 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2077 .wr_in_order = true,
2078 .num_coroutines = 8,
2079 };
2080
bellardea2384d2004-08-01 21:59:26 +00002081 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002082 static const struct option long_options[] = {
2083 {"help", no_argument, 0, 'h'},
2084 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002085 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002086 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002087 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
Max Reitz8eaac022019-05-07 22:35:03 +02002088 {"salvage", no_argument, 0, OPTION_SALVAGE},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002089 {0, 0, 0, 0}
2090 };
Fam Zhenge11ce122018-07-27 11:34:01 +08002091 c = getopt_long(argc, argv, ":hf:O:B:Cco:l:S:pt:T:qnm:WU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002092 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002093 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002094 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002095 }
bellardea2384d2004-08-01 21:59:26 +00002096 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002097 case ':':
2098 missing_argument(argv[optind - 1]);
2099 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002100 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002101 unrecognized_option(argv[optind - 1]);
2102 break;
bellardea2384d2004-08-01 21:59:26 +00002103 case 'h':
2104 help();
2105 break;
2106 case 'f':
2107 fmt = optarg;
2108 break;
2109 case 'O':
2110 out_fmt = optarg;
2111 break;
thsf58c7b32008-06-05 21:53:49 +00002112 case 'B':
2113 out_baseimg = optarg;
2114 break;
Fam Zhenge11ce122018-07-27 11:34:01 +08002115 case 'C':
2116 s.copy_range = true;
2117 break;
bellardea2384d2004-08-01 21:59:26 +00002118 case 'c':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002119 s.compressed = true;
bellardea2384d2004-08-01 21:59:26 +00002120 break;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002121 case 'o':
Kevin Wolf2dc83282014-02-21 16:24:05 +01002122 if (!is_valid_option_list(optarg)) {
2123 error_report("Invalid option list: %s", optarg);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002124 goto fail_getopt;
Kevin Wolf2dc83282014-02-21 16:24:05 +01002125 }
2126 if (!options) {
2127 options = g_strdup(optarg);
2128 } else {
2129 char *old_options = options;
2130 options = g_strdup_printf("%s,%s", options, optarg);
2131 g_free(old_options);
2132 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002133 break;
Wenchao Xiaef806542013-12-04 17:10:57 +08002134 case 'l':
2135 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
Markus Armbruster70b94332015-02-13 12:50:26 +01002136 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2137 optarg, false);
Wenchao Xiaef806542013-12-04 17:10:57 +08002138 if (!sn_opts) {
2139 error_report("Failed in parsing snapshot param '%s'",
2140 optarg);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002141 goto fail_getopt;
Wenchao Xiaef806542013-12-04 17:10:57 +08002142 }
2143 } else {
2144 snapshot_name = optarg;
2145 }
2146 break;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002147 case 'S':
2148 {
2149 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +01002150
2151 sval = cvtnum(optarg);
Nir Soffer1bbbf322019-08-27 21:59:12 +03002152 if (sval < 0 || !QEMU_IS_ALIGNED(sval, BDRV_SECTOR_SIZE) ||
Peter Lieven6360ab22018-07-13 09:15:39 +02002153 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2154 error_report("Invalid buffer size for sparse output specified. "
2155 "Valid sizes are multiples of %llu up to %llu. Select "
2156 "0 to disable sparse detection (fully allocates output).",
2157 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002158 goto fail_getopt;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002159 }
2160
Peter Lieven9fd77f92017-04-21 11:11:55 +02002161 s.min_sparse = sval / BDRV_SECTOR_SIZE;
Fam Zhenge11ce122018-07-27 11:34:01 +08002162 explict_min_sparse = true;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002163 break;
2164 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002165 case 'p':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002166 progress = true;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002167 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002168 case 't':
2169 cache = optarg;
2170 break;
Max Reitz40055952014-07-22 22:58:42 +02002171 case 'T':
2172 src_cache = optarg;
2173 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002174 case 'q':
Max Reitz3d96cb92019-05-07 22:35:02 +02002175 s.quiet = true;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002176 break;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002177 case 'n':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002178 skip_create = true;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002179 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002180 case 'm':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002181 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2182 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002183 error_report("Invalid number of coroutines. Allowed number of"
2184 " coroutines is between 1 and %d", MAX_COROUTINES);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002185 goto fail_getopt;
2186 }
2187 break;
2188 case 'W':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002189 s.wr_in_order = false;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002190 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002191 case 'U':
2192 force_share = true;
2193 break;
Max Reitz3258b912017-04-26 15:46:47 +02002194 case OPTION_OBJECT: {
2195 QemuOpts *object_opts;
2196 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
2197 optarg, true);
2198 if (!object_opts) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002199 goto fail_getopt;
2200 }
2201 break;
Max Reitz3258b912017-04-26 15:46:47 +02002202 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002203 case OPTION_IMAGE_OPTS:
2204 image_opts = true;
2205 break;
Max Reitz8eaac022019-05-07 22:35:03 +02002206 case OPTION_SALVAGE:
2207 s.salvage = true;
2208 break;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002209 case OPTION_TARGET_IMAGE_OPTS:
2210 tgt_image_opts = true;
2211 break;
bellardea2384d2004-08-01 21:59:26 +00002212 }
2213 }
ths3b46e622007-09-17 08:09:54 +00002214
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002215 if (!out_fmt && !tgt_image_opts) {
2216 out_fmt = "raw";
2217 }
2218
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002219 if (qemu_opts_foreach(&qemu_object_opts,
2220 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02002221 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002222 goto fail_getopt;
2223 }
2224
Fam Zhenge11ce122018-07-27 11:34:01 +08002225 if (s.compressed && s.copy_range) {
2226 error_report("Cannot enable copy offloading when -c is used");
2227 goto fail_getopt;
2228 }
2229
2230 if (explict_min_sparse && s.copy_range) {
2231 error_report("Cannot enable copy offloading when -S is used");
2232 goto fail_getopt;
2233 }
2234
Max Reitz8eaac022019-05-07 22:35:03 +02002235 if (s.copy_range && s.salvage) {
2236 error_report("Cannot use copy offloading in salvaging mode");
2237 goto fail_getopt;
2238 }
2239
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002240 if (tgt_image_opts && !skip_create) {
2241 error_report("--target-image-opts requires use of -n flag");
2242 goto fail_getopt;
2243 }
2244
Kevin Wolfffd8e8f2019-08-09 11:09:21 +02002245 if (skip_create && options) {
2246 warn_report("-o has no effect when skipping image creation");
2247 warn_report("This will become an error in future QEMU versions.");
2248 }
2249
Peter Lieven9fd77f92017-04-21 11:11:55 +02002250 s.src_num = argc - optind - 1;
2251 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2252
2253 if (options && has_help_option(options)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002254 if (out_fmt) {
2255 ret = print_block_option_help(out_filename, out_fmt);
2256 goto fail_getopt;
2257 } else {
2258 error_report("Option help requires a format be specified");
2259 goto fail_getopt;
2260 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002261 }
2262
2263 if (s.src_num < 1) {
2264 error_report("Must specify image file name");
2265 goto fail_getopt;
2266 }
2267
2268
Peter Lieven9fd77f92017-04-21 11:11:55 +02002269 /* ret is still -EINVAL until here */
2270 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2271 if (ret < 0) {
2272 error_report("Invalid source cache option: %s", src_cache);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002273 goto fail_getopt;
2274 }
2275
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002276 /* Initialize before goto out */
Max Reitz3d96cb92019-05-07 22:35:02 +02002277 if (s.quiet) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002278 progress = false;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002279 }
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002280 qemu_progress_init(progress, 1.0);
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002281 qemu_progress_print(0, 100);
2282
Peter Lieven9fd77f92017-04-21 11:11:55 +02002283 s.src = g_new0(BlockBackend *, s.src_num);
2284 s.src_sectors = g_new(int64_t, s.src_num);
balrog926c2d22007-10-31 01:11:44 +00002285
Peter Lieven9fd77f92017-04-21 11:11:55 +02002286 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2287 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
Max Reitz3d96cb92019-05-07 22:35:02 +02002288 fmt, src_flags, src_writethrough, s.quiet,
Fam Zheng335e9932017-05-03 00:35:39 +08002289 force_share);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002290 if (!s.src[bs_i]) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002291 ret = -1;
2292 goto out;
2293 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002294 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2295 if (s.src_sectors[bs_i] < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002296 error_report("Could not get size of %s: %s",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002297 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002298 ret = -1;
2299 goto out;
2300 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002301 s.total_sectors += s.src_sectors[bs_i];
balrog926c2d22007-10-31 01:11:44 +00002302 }
bellardea2384d2004-08-01 21:59:26 +00002303
Wenchao Xiaef806542013-12-04 17:10:57 +08002304 if (sn_opts) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002305 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
Peter Maydell10d6eda2017-02-10 16:28:24 +00002306 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2307 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2308 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002309 } else if (snapshot_name != NULL) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002310 if (s.src_num > 1) {
Markus Armbruster6daf1942011-06-22 14:03:54 +02002311 error_report("No support for concatenating multiple snapshot");
edison51ef6722010-09-21 19:58:41 -07002312 ret = -1;
2313 goto out;
2314 }
Wenchao Xia7b4c4782013-12-04 17:10:54 +08002315
Peter Lieven9fd77f92017-04-21 11:11:55 +02002316 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2317 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002318 }
Markus Armbruster84d18f02014-01-30 15:07:28 +01002319 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002320 error_reportf_err(local_err, "Failed to load snapshot: ");
Wenchao Xiaef806542013-12-04 17:10:57 +08002321 ret = -1;
2322 goto out;
edison51ef6722010-09-21 19:58:41 -07002323 }
2324
Max Reitz2e024cd2015-02-11 09:58:46 -05002325 if (!skip_create) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002326 /* Find driver and parse its options */
2327 drv = bdrv_find_format(out_fmt);
2328 if (!drv) {
2329 error_report("Unknown file format '%s'", out_fmt);
2330 ret = -1;
2331 goto out;
2332 }
2333
2334 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2335 if (!proto_drv) {
2336 error_report_err(local_err);
2337 ret = -1;
2338 goto out;
2339 }
2340
Max Reitz2e024cd2015-02-11 09:58:46 -05002341 if (!drv->create_opts) {
2342 error_report("Format driver '%s' does not support image creation",
2343 drv->format_name);
2344 ret = -1;
2345 goto out;
2346 }
Max Reitzf75613c2014-12-02 18:32:46 +01002347
Max Reitz2e024cd2015-02-11 09:58:46 -05002348 if (!proto_drv->create_opts) {
2349 error_report("Protocol driver '%s' does not support image creation",
2350 proto_drv->format_name);
2351 ret = -1;
2352 goto out;
2353 }
Max Reitzf75613c2014-12-02 18:32:46 +01002354
Max Reitz2e024cd2015-02-11 09:58:46 -05002355 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2356 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfdb08adf2009-06-04 15:39:38 +02002357
Max Reitz2e024cd2015-02-11 09:58:46 -05002358 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002359 if (options) {
2360 qemu_opts_do_parse(opts, options, NULL, &local_err);
2361 if (local_err) {
Markus Armbruster97a2ca72015-03-14 10:23:15 +01002362 error_report_err(local_err);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002363 ret = -1;
2364 goto out;
2365 }
Max Reitz2e024cd2015-02-11 09:58:46 -05002366 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002367
Peter Lieven9fd77f92017-04-21 11:11:55 +02002368 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
Markus Armbruster39101f22015-02-12 16:46:36 +01002369 &error_abort);
Max Reitz2e024cd2015-02-11 09:58:46 -05002370 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2371 if (ret < 0) {
2372 goto out;
2373 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002374 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002375
Kevin Wolfa18953f2010-10-14 15:46:04 +02002376 /* Get backing file name if -o backing_file was used */
Chunyan Liu83d05212014-06-05 17:20:51 +08002377 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
Kevin Wolfa18953f2010-10-14 15:46:04 +02002378 if (out_baseimg_param) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002379 out_baseimg = out_baseimg_param;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002380 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002381 s.target_has_backing = (bool) out_baseimg;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002382
Max Reitz48758a82017-04-26 15:46:48 +02002383 if (s.src_num > 1 && out_baseimg) {
2384 error_report("Having a backing file for the target makes no sense when "
2385 "concatenating multiple input images");
2386 ret = -1;
2387 goto out;
2388 }
2389
Kevin Wolfefa84d42009-05-18 16:42:12 +02002390 /* Check if compression is supported */
Peter Lieven9fd77f92017-04-21 11:11:55 +02002391 if (s.compressed) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002392 bool encryption =
2393 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002394 const char *encryptfmt =
2395 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
Chunyan Liu83d05212014-06-05 17:20:51 +08002396 const char *preallocation =
2397 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
Kevin Wolfefa84d42009-05-18 16:42:12 +02002398
Vladimir Sementsov-Ogievskiyac850bf2019-06-04 19:15:06 +03002399 if (drv && !block_driver_can_compress(drv)) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002400 error_report("Compression not supported for this file format");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002401 ret = -1;
2402 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002403 }
2404
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002405 if (encryption || encryptfmt) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002406 error_report("Compression and encryption not supported at "
2407 "the same time");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002408 ret = -1;
2409 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002410 }
Kevin Wolf41521fa2011-10-18 16:19:42 +02002411
Chunyan Liu83d05212014-06-05 17:20:51 +08002412 if (preallocation
2413 && strcmp(preallocation, "off"))
Kevin Wolf41521fa2011-10-18 16:19:42 +02002414 {
2415 error_report("Compression and preallocation not supported at "
2416 "the same time");
2417 ret = -1;
2418 goto out;
2419 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002420 }
2421
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002422 /*
2423 * The later open call will need any decryption secrets, and
2424 * bdrv_create() will purge "opts", so extract them now before
2425 * they are lost.
2426 */
2427 if (!skip_create) {
2428 open_opts = qdict_new();
2429 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
2430 }
2431
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002432 if (!skip_create) {
2433 /* Create the new image */
Chunyan Liuc282e1f2014-06-05 17:21:11 +08002434 ret = bdrv_create(drv, out_filename, opts, &local_err);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002435 if (ret < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002436 error_reportf_err(local_err, "%s: error while converting %s: ",
2437 out_filename, out_fmt);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002438 goto out;
bellardea2384d2004-08-01 21:59:26 +00002439 }
2440 }
ths3b46e622007-09-17 08:09:54 +00002441
Max Reitz4d7c4872019-07-24 19:12:29 +02002442 s.target_is_new = !skip_create;
2443
Peter Lieven9fd77f92017-04-21 11:11:55 +02002444 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
Kevin Wolfce099542016-03-15 13:01:04 +01002445 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002446 if (ret < 0) {
2447 error_report("Invalid cache option: %s", cache);
Markus Armbrusterbb9cd2e2014-05-28 11:17:07 +02002448 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002449 }
2450
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002451 if (skip_create) {
2452 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002453 flags, writethrough, s.quiet, false);
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002454 } else {
2455 /* TODO ultimately we should allow --target-image-opts
2456 * to be used even when -n is not given.
2457 * That has to wait for bdrv_create to be improved
2458 * to allow filenames in option syntax
2459 */
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002460 s.target = img_open_file(out_filename, open_opts, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002461 flags, writethrough, s.quiet, false);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002462 open_opts = NULL; /* blk_new_open will have freed it */
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002463 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002464 if (!s.target) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002465 ret = -1;
2466 goto out;
2467 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002468 out_bs = blk_bs(s.target);
bellardea2384d2004-08-01 21:59:26 +00002469
Vladimir Sementsov-Ogievskiyac850bf2019-06-04 19:15:06 +03002470 if (s.compressed && !block_driver_can_compress(out_bs->drv)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002471 error_report("Compression not supported for this file format");
2472 ret = -1;
2473 goto out;
2474 }
2475
Eric Blake5def6b82016-06-23 16:37:19 -06002476 /* increase bufsectors from the default 4096 (2M) if opt_transfer
Peter Lieven6360ab22018-07-13 09:15:39 +02002477 * or discard_alignment of the out_bs is greater. Limit to
2478 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2479 s.buf_sectors = MIN(MAX_BUF_SECTORS,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002480 MAX(s.buf_sectors,
2481 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2482 out_bs->bl.pdiscard_alignment >>
2483 BDRV_SECTOR_BITS)));
Peter Lievenf2521c92013-11-27 11:07:06 +01002484
Peter Lieven8dcd3c92018-07-12 15:00:10 +02002485 /* try to align the write requests to the destination to avoid unnecessary
2486 * RMW cycles. */
2487 s.alignment = MAX(pow2floor(s.min_sparse),
2488 DIV_ROUND_UP(out_bs->bl.request_alignment,
2489 BDRV_SECTOR_SIZE));
2490 assert(is_power_of_2(s.alignment));
2491
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002492 if (skip_create) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002493 int64_t output_sectors = blk_nb_sectors(s.target);
Markus Armbruster43716fa2014-06-26 13:23:21 +02002494 if (output_sectors < 0) {
Gongleieec5eb42015-02-25 12:22:27 +08002495 error_report("unable to get output image length: %s",
Markus Armbruster43716fa2014-06-26 13:23:21 +02002496 strerror(-output_sectors));
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002497 ret = -1;
2498 goto out;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002499 } else if (output_sectors < s.total_sectors) {
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002500 error_report("output file is smaller than input file");
2501 ret = -1;
2502 goto out;
2503 }
2504 }
2505
Max Reitz351c8ef2018-05-01 18:57:49 +02002506 if (s.target_has_backing) {
2507 /* Errors are treated as "backing length unknown" (which means
2508 * s.target_backing_sectors has to be negative, which it will
2509 * be automatically). The backing file length is used only
2510 * for optimizations, so such a case is not fatal. */
2511 s.target_backing_sectors = bdrv_nb_sectors(out_bs->backing->bs);
2512 } else {
2513 s.target_backing_sectors = -1;
2514 }
2515
Peter Lieven24f833c2013-11-27 11:07:07 +01002516 ret = bdrv_get_info(out_bs, &bdi);
2517 if (ret < 0) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002518 if (s.compressed) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002519 error_report("could not get block driver info");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002520 goto out;
2521 }
Peter Lieven24f833c2013-11-27 11:07:07 +01002522 } else {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002523 s.compressed = s.compressed || bdi.needs_compressed_writes;
2524 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
Max Reitz351c8ef2018-05-01 18:57:49 +02002525 s.unallocated_blocks_are_zero = bdi.unallocated_blocks_are_zero;
Peter Lieven24f833c2013-11-27 11:07:07 +01002526 }
2527
Peter Lieven9fd77f92017-04-21 11:11:55 +02002528 ret = convert_do_copy(&s);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002529out:
Peter Lieven13c28af2013-11-27 11:07:01 +01002530 if (!ret) {
2531 qemu_progress_print(100, 0);
2532 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002533 qemu_progress_end();
Chunyan Liu83d05212014-06-05 17:20:51 +08002534 qemu_opts_del(opts);
2535 qemu_opts_free(create_opts);
Markus Armbrusterfbf28a42014-09-29 16:07:55 +02002536 qemu_opts_del(sn_opts);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002537 qobject_unref(open_opts);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002538 blk_unref(s.target);
2539 if (s.src) {
2540 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2541 blk_unref(s.src[bs_i]);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002542 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002543 g_free(s.src);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002544 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002545 g_free(s.src_sectors);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002546fail_getopt:
2547 g_free(options);
2548
Peter Lieven9fd77f92017-04-21 11:11:55 +02002549 return !!ret;
bellardea2384d2004-08-01 21:59:26 +00002550}
2551
bellard57d1a2b2004-08-03 21:15:11 +00002552
bellardfaea38e2006-08-05 21:31:00 +00002553static void dump_snapshots(BlockDriverState *bs)
2554{
2555 QEMUSnapshotInfo *sn_tab, *sn;
2556 int nb_sns, i;
bellardfaea38e2006-08-05 21:31:00 +00002557
2558 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2559 if (nb_sns <= 0)
2560 return;
2561 printf("Snapshot list:\n");
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002562 bdrv_snapshot_dump(NULL);
Wenchao Xia5b917042013-05-25 11:09:45 +08002563 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002564 for(i = 0; i < nb_sns; i++) {
2565 sn = &sn_tab[i];
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002566 bdrv_snapshot_dump(sn);
Wenchao Xia5b917042013-05-25 11:09:45 +08002567 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002568 }
Anthony Liguori7267c092011-08-20 22:09:37 -05002569 g_free(sn_tab);
bellardfaea38e2006-08-05 21:31:00 +00002570}
2571
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002572static void dump_json_image_info_list(ImageInfoList *list)
2573{
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002574 QString *str;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002575 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002576 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002577
2578 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2579 visit_complete(v, &obj);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002580 str = qobject_to_json_pretty(obj);
2581 assert(str != NULL);
2582 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002583 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002584 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002585 qobject_unref(str);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002586}
2587
Benoît Canetc054b3f2012-09-05 13:09:02 +02002588static void dump_json_image_info(ImageInfo *info)
2589{
Benoît Canetc054b3f2012-09-05 13:09:02 +02002590 QString *str;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002591 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002592 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002593
2594 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2595 visit_complete(v, &obj);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002596 str = qobject_to_json_pretty(obj);
2597 assert(str != NULL);
2598 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002599 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002600 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002601 qobject_unref(str);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002602}
2603
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002604static void dump_human_image_info_list(ImageInfoList *list)
2605{
2606 ImageInfoList *elem;
2607 bool delim = false;
2608
2609 for (elem = list; elem; elem = elem->next) {
2610 if (delim) {
2611 printf("\n");
2612 }
2613 delim = true;
2614
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002615 bdrv_image_info_dump(elem->value);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002616 }
2617}
2618
2619static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2620{
2621 return strcmp(a, b) == 0;
2622}
2623
2624/**
2625 * Open an image file chain and return an ImageInfoList
2626 *
2627 * @filename: topmost image filename
2628 * @fmt: topmost image format (may be NULL to autodetect)
2629 * @chain: true - enumerate entire backing file chain
2630 * false - only topmost image file
2631 *
2632 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2633 * image file. If there was an error a message will have been printed to
2634 * stderr.
2635 */
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002636static ImageInfoList *collect_image_info_list(bool image_opts,
2637 const char *filename,
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002638 const char *fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002639 bool chain, bool force_share)
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002640{
2641 ImageInfoList *head = NULL;
2642 ImageInfoList **last = &head;
2643 GHashTable *filenames;
Wenchao Xia43526ec2013-06-06 12:27:58 +08002644 Error *err = NULL;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002645
2646 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2647
2648 while (filename) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02002649 BlockBackend *blk;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002650 BlockDriverState *bs;
2651 ImageInfo *info;
2652 ImageInfoList *elem;
2653
2654 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2655 error_report("Backing file '%s' creates an infinite loop.",
2656 filename);
2657 goto err;
2658 }
2659 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2660
Max Reitzefaa7c42016-03-16 19:54:38 +01002661 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002662 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2663 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002664 if (!blk) {
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002665 goto err;
2666 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002667 bs = blk_bs(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002668
Wenchao Xia43526ec2013-06-06 12:27:58 +08002669 bdrv_query_image_info(bs, &info, &err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002670 if (err) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01002671 error_report_err(err);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002672 blk_unref(blk);
Wenchao Xia43526ec2013-06-06 12:27:58 +08002673 goto err;
Wenchao Xiafb0ed452013-06-06 12:27:57 +08002674 }
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002675
2676 elem = g_new0(ImageInfoList, 1);
2677 elem->value = info;
2678 *last = elem;
2679 last = &elem->next;
2680
Markus Armbruster26f54e92014-10-07 13:59:04 +02002681 blk_unref(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002682
2683 filename = fmt = NULL;
2684 if (chain) {
2685 if (info->has_full_backing_filename) {
2686 filename = info->full_backing_filename;
2687 } else if (info->has_backing_filename) {
John Snow92d617a2015-12-14 14:55:15 -05002688 error_report("Could not determine absolute backing filename,"
2689 " but backing filename '%s' present",
2690 info->backing_filename);
2691 goto err;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002692 }
2693 if (info->has_backing_filename_format) {
2694 fmt = info->backing_filename_format;
2695 }
2696 }
2697 }
2698 g_hash_table_destroy(filenames);
2699 return head;
2700
2701err:
2702 qapi_free_ImageInfoList(head);
2703 g_hash_table_destroy(filenames);
2704 return NULL;
2705}
2706
Benoît Canetc054b3f2012-09-05 13:09:02 +02002707static int img_info(int argc, char **argv)
2708{
2709 int c;
2710 OutputFormat output_format = OFORMAT_HUMAN;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002711 bool chain = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002712 const char *filename, *fmt, *output;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002713 ImageInfoList *list;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002714 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08002715 bool force_share = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002716
bellardea2384d2004-08-01 21:59:26 +00002717 fmt = NULL;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002718 output = NULL;
bellardea2384d2004-08-01 21:59:26 +00002719 for(;;) {
Benoît Canetc054b3f2012-09-05 13:09:02 +02002720 int option_index = 0;
2721 static const struct option long_options[] = {
2722 {"help", no_argument, 0, 'h'},
2723 {"format", required_argument, 0, 'f'},
2724 {"output", required_argument, 0, OPTION_OUTPUT},
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002725 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002726 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002727 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002728 {"force-share", no_argument, 0, 'U'},
Benoît Canetc054b3f2012-09-05 13:09:02 +02002729 {0, 0, 0, 0}
2730 };
Fam Zheng335e9932017-05-03 00:35:39 +08002731 c = getopt_long(argc, argv, ":f:hU",
Benoît Canetc054b3f2012-09-05 13:09:02 +02002732 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002733 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002734 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002735 }
bellardea2384d2004-08-01 21:59:26 +00002736 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002737 case ':':
2738 missing_argument(argv[optind - 1]);
2739 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002740 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002741 unrecognized_option(argv[optind - 1]);
2742 break;
bellardea2384d2004-08-01 21:59:26 +00002743 case 'h':
2744 help();
2745 break;
2746 case 'f':
2747 fmt = optarg;
2748 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002749 case 'U':
2750 force_share = true;
2751 break;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002752 case OPTION_OUTPUT:
2753 output = optarg;
2754 break;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002755 case OPTION_BACKING_CHAIN:
2756 chain = true;
2757 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002758 case OPTION_OBJECT: {
2759 QemuOpts *opts;
2760 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2761 optarg, true);
2762 if (!opts) {
2763 return 1;
2764 }
2765 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002766 case OPTION_IMAGE_OPTS:
2767 image_opts = true;
2768 break;
bellardea2384d2004-08-01 21:59:26 +00002769 }
2770 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02002771 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08002772 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002773 }
bellardea2384d2004-08-01 21:59:26 +00002774 filename = argv[optind++];
2775
Benoît Canetc054b3f2012-09-05 13:09:02 +02002776 if (output && !strcmp(output, "json")) {
2777 output_format = OFORMAT_JSON;
2778 } else if (output && !strcmp(output, "human")) {
2779 output_format = OFORMAT_HUMAN;
2780 } else if (output) {
2781 error_report("--output must be used with human or json as argument.");
2782 return 1;
2783 }
2784
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002785 if (qemu_opts_foreach(&qemu_object_opts,
2786 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02002787 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002788 return 1;
2789 }
2790
Fam Zheng335e9932017-05-03 00:35:39 +08002791 list = collect_image_info_list(image_opts, filename, fmt, chain,
2792 force_share);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002793 if (!list) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002794 return 1;
2795 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002796
Benoît Canetc054b3f2012-09-05 13:09:02 +02002797 switch (output_format) {
2798 case OFORMAT_HUMAN:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002799 dump_human_image_info_list(list);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002800 break;
2801 case OFORMAT_JSON:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002802 if (chain) {
2803 dump_json_image_info_list(list);
2804 } else {
2805 dump_json_image_info(list->value);
2806 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002807 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002808 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002809
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002810 qapi_free_ImageInfoList(list);
bellardea2384d2004-08-01 21:59:26 +00002811 return 0;
2812}
2813
Eric Blake30065d12019-03-26 13:40:43 -05002814static int dump_map_entry(OutputFormat output_format, MapEntry *e,
2815 MapEntry *next)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002816{
2817 switch (output_format) {
2818 case OFORMAT_HUMAN:
Fam Zheng16b0d552016-01-26 11:59:02 +08002819 if (e->data && !e->has_offset) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002820 error_report("File contains external, encrypted or compressed clusters.");
Eric Blake30065d12019-03-26 13:40:43 -05002821 return -1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002822 }
Fam Zheng16b0d552016-01-26 11:59:02 +08002823 if (e->data && !e->zero) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002824 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
Fam Zheng16b0d552016-01-26 11:59:02 +08002825 e->start, e->length,
2826 e->has_offset ? e->offset : 0,
2827 e->has_filename ? e->filename : "");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002828 }
2829 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2830 * Modify the flags here to allow more coalescing.
2831 */
Fam Zheng16b0d552016-01-26 11:59:02 +08002832 if (next && (!next->data || next->zero)) {
2833 next->data = false;
2834 next->zero = true;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002835 }
2836 break;
2837 case OFORMAT_JSON:
Fam Zheng16b0d552016-01-26 11:59:02 +08002838 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
2839 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002840 (e->start == 0 ? "[" : ",\n"),
2841 e->start, e->length, e->depth,
Fam Zheng16b0d552016-01-26 11:59:02 +08002842 e->zero ? "true" : "false",
2843 e->data ? "true" : "false");
2844 if (e->has_offset) {
Paolo Bonzinic745bfb2013-09-11 18:47:52 +02002845 printf(", \"offset\": %"PRId64"", e->offset);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002846 }
2847 putchar('}');
2848
2849 if (!next) {
2850 printf("]\n");
2851 }
2852 break;
2853 }
Eric Blake30065d12019-03-26 13:40:43 -05002854 return 0;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002855}
2856
Eric Blake5e344dd2017-10-11 22:47:02 -05002857static int get_block_status(BlockDriverState *bs, int64_t offset,
2858 int64_t bytes, MapEntry *e)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002859{
Eric Blake237d78f2017-10-11 22:47:03 -05002860 int ret;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002861 int depth;
Fam Zheng67a0fd22016-01-26 11:58:48 +08002862 BlockDriverState *file;
John Snow28756452016-02-05 13:12:33 -05002863 bool has_offset;
Eric Blake237d78f2017-10-11 22:47:03 -05002864 int64_t map;
Max Reitzf30c66b2019-02-01 20:29:05 +01002865 char *filename = NULL;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002866
2867 /* As an optimization, we could cache the current range of unallocated
2868 * clusters in each file of the chain, and avoid querying the same
2869 * range repeatedly.
2870 */
2871
2872 depth = 0;
2873 for (;;) {
Eric Blake237d78f2017-10-11 22:47:03 -05002874 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002875 if (ret < 0) {
2876 return ret;
2877 }
Eric Blake237d78f2017-10-11 22:47:03 -05002878 assert(bytes);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002879 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2880 break;
2881 }
Kevin Wolf760e0062015-06-17 14:55:21 +02002882 bs = backing_bs(bs);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002883 if (bs == NULL) {
2884 ret = 0;
2885 break;
2886 }
2887
2888 depth++;
2889 }
2890
John Snow28756452016-02-05 13:12:33 -05002891 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
2892
Max Reitzf30c66b2019-02-01 20:29:05 +01002893 if (file && has_offset) {
2894 bdrv_refresh_filename(file);
2895 filename = file->filename;
2896 }
2897
John Snow28756452016-02-05 13:12:33 -05002898 *e = (MapEntry) {
Eric Blake5e344dd2017-10-11 22:47:02 -05002899 .start = offset,
Eric Blake237d78f2017-10-11 22:47:03 -05002900 .length = bytes,
John Snow28756452016-02-05 13:12:33 -05002901 .data = !!(ret & BDRV_BLOCK_DATA),
2902 .zero = !!(ret & BDRV_BLOCK_ZERO),
Eric Blake237d78f2017-10-11 22:47:03 -05002903 .offset = map,
John Snow28756452016-02-05 13:12:33 -05002904 .has_offset = has_offset,
2905 .depth = depth,
Max Reitzf30c66b2019-02-01 20:29:05 +01002906 .has_filename = filename,
2907 .filename = filename,
John Snow28756452016-02-05 13:12:33 -05002908 };
2909
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002910 return 0;
2911}
2912
Fam Zheng16b0d552016-01-26 11:59:02 +08002913static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
2914{
2915 if (curr->length == 0) {
2916 return false;
2917 }
2918 if (curr->zero != next->zero ||
2919 curr->data != next->data ||
2920 curr->depth != next->depth ||
2921 curr->has_filename != next->has_filename ||
2922 curr->has_offset != next->has_offset) {
2923 return false;
2924 }
2925 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
2926 return false;
2927 }
2928 if (curr->has_offset && curr->offset + curr->length != next->offset) {
2929 return false;
2930 }
2931 return true;
2932}
2933
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002934static int img_map(int argc, char **argv)
2935{
2936 int c;
2937 OutputFormat output_format = OFORMAT_HUMAN;
Markus Armbruster26f54e92014-10-07 13:59:04 +02002938 BlockBackend *blk;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002939 BlockDriverState *bs;
2940 const char *filename, *fmt, *output;
2941 int64_t length;
2942 MapEntry curr = { .length = 0 }, next;
2943 int ret = 0;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002944 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08002945 bool force_share = false;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002946
2947 fmt = NULL;
2948 output = NULL;
2949 for (;;) {
2950 int option_index = 0;
2951 static const struct option long_options[] = {
2952 {"help", no_argument, 0, 'h'},
2953 {"format", required_argument, 0, 'f'},
2954 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002955 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002956 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002957 {"force-share", no_argument, 0, 'U'},
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002958 {0, 0, 0, 0}
2959 };
Fam Zheng335e9932017-05-03 00:35:39 +08002960 c = getopt_long(argc, argv, ":f:hU",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002961 long_options, &option_index);
2962 if (c == -1) {
2963 break;
2964 }
2965 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002966 case ':':
2967 missing_argument(argv[optind - 1]);
2968 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002969 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002970 unrecognized_option(argv[optind - 1]);
2971 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002972 case 'h':
2973 help();
2974 break;
2975 case 'f':
2976 fmt = optarg;
2977 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002978 case 'U':
2979 force_share = true;
2980 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002981 case OPTION_OUTPUT:
2982 output = optarg;
2983 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002984 case OPTION_OBJECT: {
2985 QemuOpts *opts;
2986 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2987 optarg, true);
2988 if (!opts) {
2989 return 1;
2990 }
2991 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002992 case OPTION_IMAGE_OPTS:
2993 image_opts = true;
2994 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002995 }
2996 }
Fam Zhengac1307a2014-04-22 13:36:11 +08002997 if (optind != argc - 1) {
2998 error_exit("Expecting one image file name");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002999 }
Fam Zhengac1307a2014-04-22 13:36:11 +08003000 filename = argv[optind];
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003001
3002 if (output && !strcmp(output, "json")) {
3003 output_format = OFORMAT_JSON;
3004 } else if (output && !strcmp(output, "human")) {
3005 output_format = OFORMAT_HUMAN;
3006 } else if (output) {
3007 error_report("--output must be used with human or json as argument.");
3008 return 1;
3009 }
3010
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003011 if (qemu_opts_foreach(&qemu_object_opts,
3012 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02003013 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003014 return 1;
3015 }
3016
Fam Zheng335e9932017-05-03 00:35:39 +08003017 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003018 if (!blk) {
3019 return 1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003020 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003021 bs = blk_bs(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003022
3023 if (output_format == OFORMAT_HUMAN) {
3024 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
3025 }
3026
Max Reitzf1d3cd72015-02-05 13:58:18 -05003027 length = blk_getlength(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003028 while (curr.start + curr.length < length) {
Eric Blake5e344dd2017-10-11 22:47:02 -05003029 int64_t offset = curr.start + curr.length;
3030 int64_t n;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003031
3032 /* Probe up to 1 GiB at a time. */
Stefano Garzarella97ede572019-05-08 12:43:24 +02003033 n = MIN(1 * GiB, length - offset);
Eric Blake5e344dd2017-10-11 22:47:02 -05003034 ret = get_block_status(bs, offset, n, &next);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003035
3036 if (ret < 0) {
3037 error_report("Could not read file metadata: %s", strerror(-ret));
3038 goto out;
3039 }
3040
Fam Zheng16b0d552016-01-26 11:59:02 +08003041 if (entry_mergeable(&curr, &next)) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003042 curr.length += next.length;
3043 continue;
3044 }
3045
3046 if (curr.length > 0) {
Eric Blake30065d12019-03-26 13:40:43 -05003047 ret = dump_map_entry(output_format, &curr, &next);
3048 if (ret < 0) {
3049 goto out;
3050 }
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003051 }
3052 curr = next;
3053 }
3054
Eric Blake30065d12019-03-26 13:40:43 -05003055 ret = dump_map_entry(output_format, &curr, NULL);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003056
3057out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003058 blk_unref(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003059 return ret < 0;
3060}
3061
aliguorif7b4a942009-01-07 17:40:15 +00003062#define SNAPSHOT_LIST 1
3063#define SNAPSHOT_CREATE 2
3064#define SNAPSHOT_APPLY 3
3065#define SNAPSHOT_DELETE 4
3066
Stuart Brady153859b2009-06-07 00:42:17 +01003067static int img_snapshot(int argc, char **argv)
aliguorif7b4a942009-01-07 17:40:15 +00003068{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003069 BlockBackend *blk;
aliguorif7b4a942009-01-07 17:40:15 +00003070 BlockDriverState *bs;
3071 QEMUSnapshotInfo sn;
3072 char *filename, *snapshot_name = NULL;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003073 int c, ret = 0, bdrv_oflags;
aliguorif7b4a942009-01-07 17:40:15 +00003074 int action = 0;
3075 qemu_timeval tv;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003076 bool quiet = false;
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003077 Error *err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003078 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003079 bool force_share = false;
aliguorif7b4a942009-01-07 17:40:15 +00003080
Kevin Wolfce099542016-03-15 13:01:04 +01003081 bdrv_oflags = BDRV_O_RDWR;
aliguorif7b4a942009-01-07 17:40:15 +00003082 /* Parse commandline parameters */
3083 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003084 static const struct option long_options[] = {
3085 {"help", no_argument, 0, 'h'},
3086 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003087 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003088 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003089 {0, 0, 0, 0}
3090 };
Fam Zheng335e9932017-05-03 00:35:39 +08003091 c = getopt_long(argc, argv, ":la:c:d:hqU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003092 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003093 if (c == -1) {
aliguorif7b4a942009-01-07 17:40:15 +00003094 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003095 }
aliguorif7b4a942009-01-07 17:40:15 +00003096 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003097 case ':':
3098 missing_argument(argv[optind - 1]);
3099 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003100 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003101 unrecognized_option(argv[optind - 1]);
3102 break;
aliguorif7b4a942009-01-07 17:40:15 +00003103 case 'h':
3104 help();
Stuart Brady153859b2009-06-07 00:42:17 +01003105 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003106 case 'l':
3107 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003108 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003109 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003110 }
3111 action = SNAPSHOT_LIST;
Naphtali Spreif5edb012010-01-17 16:48:13 +02003112 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
aliguorif7b4a942009-01-07 17:40:15 +00003113 break;
3114 case 'a':
3115 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003116 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003117 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003118 }
3119 action = SNAPSHOT_APPLY;
3120 snapshot_name = optarg;
3121 break;
3122 case 'c':
3123 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003124 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003125 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003126 }
3127 action = SNAPSHOT_CREATE;
3128 snapshot_name = optarg;
3129 break;
3130 case 'd':
3131 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003132 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003133 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003134 }
3135 action = SNAPSHOT_DELETE;
3136 snapshot_name = optarg;
3137 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003138 case 'q':
3139 quiet = true;
3140 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003141 case 'U':
3142 force_share = true;
3143 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003144 case OPTION_OBJECT: {
3145 QemuOpts *opts;
3146 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3147 optarg, true);
3148 if (!opts) {
3149 return 1;
3150 }
3151 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003152 case OPTION_IMAGE_OPTS:
3153 image_opts = true;
3154 break;
aliguorif7b4a942009-01-07 17:40:15 +00003155 }
3156 }
3157
Kevin Wolffc11eb22013-08-05 10:53:04 +02003158 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003159 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003160 }
aliguorif7b4a942009-01-07 17:40:15 +00003161 filename = argv[optind++];
3162
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003163 if (qemu_opts_foreach(&qemu_object_opts,
3164 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02003165 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003166 return 1;
3167 }
3168
aliguorif7b4a942009-01-07 17:40:15 +00003169 /* Open the image */
Fam Zheng335e9932017-05-03 00:35:39 +08003170 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3171 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003172 if (!blk) {
3173 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003174 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003175 bs = blk_bs(blk);
aliguorif7b4a942009-01-07 17:40:15 +00003176
3177 /* Perform the requested action */
3178 switch(action) {
3179 case SNAPSHOT_LIST:
3180 dump_snapshots(bs);
3181 break;
3182
3183 case SNAPSHOT_CREATE:
3184 memset(&sn, 0, sizeof(sn));
3185 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3186
3187 qemu_gettimeofday(&tv);
3188 sn.date_sec = tv.tv_sec;
3189 sn.date_nsec = tv.tv_usec * 1000;
3190
3191 ret = bdrv_snapshot_create(bs, &sn);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003192 if (ret) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003193 error_report("Could not create snapshot '%s': %d (%s)",
aliguorif7b4a942009-01-07 17:40:15 +00003194 snapshot_name, ret, strerror(-ret));
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003195 }
aliguorif7b4a942009-01-07 17:40:15 +00003196 break;
3197
3198 case SNAPSHOT_APPLY:
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003199 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003200 if (ret) {
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003201 error_reportf_err(err, "Could not apply snapshot '%s': ",
3202 snapshot_name);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003203 }
aliguorif7b4a942009-01-07 17:40:15 +00003204 break;
3205
3206 case SNAPSHOT_DELETE:
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003207 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3208 if (ret < 0) {
3209 error_report("Could not delete snapshot '%s': snapshot not "
3210 "found", snapshot_name);
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003211 ret = 1;
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003212 } else {
3213 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3214 if (ret < 0) {
3215 error_reportf_err(err, "Could not delete snapshot '%s': ",
3216 snapshot_name);
3217 ret = 1;
3218 }
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003219 }
aliguorif7b4a942009-01-07 17:40:15 +00003220 break;
3221 }
3222
3223 /* Cleanup */
Markus Armbruster26f54e92014-10-07 13:59:04 +02003224 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003225 if (ret) {
3226 return 1;
3227 }
Stuart Brady153859b2009-06-07 00:42:17 +01003228 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003229}
3230
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003231static int img_rebase(int argc, char **argv)
3232{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003233 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
Paolo Bonzini396374c2016-02-25 23:53:54 +01003234 uint8_t *buf_old = NULL;
3235 uint8_t *buf_new = NULL;
Sam Eiderman863cc782019-05-23 19:33:36 +03003236 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003237 char *filename;
Max Reitz40055952014-07-22 22:58:42 +02003238 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3239 int c, flags, src_flags, ret;
Kevin Wolfce099542016-03-15 13:01:04 +01003240 bool writethrough, src_writethrough;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003241 int unsafe = 0;
Fam Zheng335e9932017-05-03 00:35:39 +08003242 bool force_share = false;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003243 int progress = 0;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003244 bool quiet = false;
Max Reitz34b5d2c2013-09-05 14:45:29 +02003245 Error *local_err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003246 bool image_opts = false;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003247
3248 /* Parse commandline parameters */
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003249 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003250 cache = BDRV_DEFAULT_CACHE;
Max Reitz40055952014-07-22 22:58:42 +02003251 src_cache = BDRV_DEFAULT_CACHE;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003252 out_baseimg = NULL;
3253 out_basefmt = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003254 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003255 static const struct option long_options[] = {
3256 {"help", no_argument, 0, 'h'},
3257 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003258 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003259 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003260 {0, 0, 0, 0}
3261 };
Fam Zheng335e9932017-05-03 00:35:39 +08003262 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003263 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003264 if (c == -1) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003265 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003266 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003267 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003268 case ':':
3269 missing_argument(argv[optind - 1]);
3270 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003271 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003272 unrecognized_option(argv[optind - 1]);
3273 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003274 case 'h':
3275 help();
3276 return 0;
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003277 case 'f':
3278 fmt = optarg;
3279 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003280 case 'F':
3281 out_basefmt = optarg;
3282 break;
3283 case 'b':
3284 out_baseimg = optarg;
3285 break;
3286 case 'u':
3287 unsafe = 1;
3288 break;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003289 case 'p':
3290 progress = 1;
3291 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003292 case 't':
3293 cache = optarg;
3294 break;
Max Reitz40055952014-07-22 22:58:42 +02003295 case 'T':
3296 src_cache = optarg;
3297 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003298 case 'q':
3299 quiet = true;
3300 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003301 case OPTION_OBJECT: {
3302 QemuOpts *opts;
3303 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3304 optarg, true);
3305 if (!opts) {
3306 return 1;
3307 }
3308 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003309 case OPTION_IMAGE_OPTS:
3310 image_opts = true;
3311 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003312 case 'U':
3313 force_share = true;
3314 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003315 }
3316 }
3317
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003318 if (quiet) {
3319 progress = 0;
3320 }
3321
Fam Zhengac1307a2014-04-22 13:36:11 +08003322 if (optind != argc - 1) {
3323 error_exit("Expecting one image file name");
3324 }
3325 if (!unsafe && !out_baseimg) {
3326 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003327 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003328 filename = argv[optind++];
3329
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003330 if (qemu_opts_foreach(&qemu_object_opts,
3331 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02003332 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003333 return 1;
3334 }
3335
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003336 qemu_progress_init(progress, 2.0);
3337 qemu_progress_print(0, 100);
3338
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003339 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
Kevin Wolfce099542016-03-15 13:01:04 +01003340 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003341 if (ret < 0) {
3342 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003343 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003344 }
3345
Kevin Wolfce099542016-03-15 13:01:04 +01003346 src_flags = 0;
3347 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
Max Reitz40055952014-07-22 22:58:42 +02003348 if (ret < 0) {
3349 error_report("Invalid source cache option: %s", src_cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003350 goto out;
Max Reitz40055952014-07-22 22:58:42 +02003351 }
3352
Kevin Wolfce099542016-03-15 13:01:04 +01003353 /* The source files are opened read-only, don't care about WCE */
3354 assert((src_flags & BDRV_O_RDWR) == 0);
3355 (void) src_writethrough;
3356
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003357 /*
3358 * Open the images.
3359 *
3360 * Ignore the old backing file for unsafe rebase in case we want to correct
3361 * the reference to a renamed or moved backing file.
3362 */
Fam Zheng335e9932017-05-03 00:35:39 +08003363 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3364 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003365 if (!blk) {
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003366 ret = -1;
3367 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003368 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003369 bs = blk_bs(blk);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003370
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003371 if (out_basefmt != NULL) {
Max Reitz644483d2015-02-05 13:58:17 -05003372 if (bdrv_find_format(out_basefmt) == NULL) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003373 error_report("Invalid format name: '%s'", out_basefmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003374 ret = -1;
3375 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003376 }
3377 }
3378
3379 /* For safe rebasing we need to compare old and new backing file */
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003380 if (!unsafe) {
Max Reitz644483d2015-02-05 13:58:17 -05003381 QDict *options = NULL;
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003382 BlockDriverState *base_bs = backing_bs(bs);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003383
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003384 if (base_bs) {
Kevin Wolfd861ab32019-04-25 14:25:10 +02003385 blk_old_backing = blk_new(qemu_get_aio_context(),
3386 BLK_PERM_CONSISTENT_READ,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003387 BLK_PERM_ALL);
3388 ret = blk_insert_bs(blk_old_backing, base_bs,
3389 &local_err);
3390 if (ret < 0) {
Max Reitz35ddd932019-05-09 19:52:35 +02003391 error_reportf_err(local_err,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003392 "Could not reuse old backing file '%s': ",
3393 base_bs->filename);
Max Reitz35ddd932019-05-09 19:52:35 +02003394 goto out;
3395 }
3396 } else {
3397 blk_old_backing = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003398 }
Max Reitz644483d2015-02-05 13:58:17 -05003399
Alex Bligha6166732012-10-16 13:46:18 +01003400 if (out_baseimg[0]) {
Max Reitzd16699b2018-05-09 20:20:01 +02003401 const char *overlay_filename;
3402 char *out_real_path;
3403
Fam Zheng335e9932017-05-03 00:35:39 +08003404 options = qdict_new();
Max Reitz644483d2015-02-05 13:58:17 -05003405 if (out_basefmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003406 qdict_put_str(options, "driver", out_basefmt);
Fam Zheng335e9932017-05-03 00:35:39 +08003407 }
3408 if (force_share) {
3409 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Max Reitz644483d2015-02-05 13:58:17 -05003410 }
3411
Max Reitzf30c66b2019-02-01 20:29:05 +01003412 bdrv_refresh_filename(bs);
Max Reitzd16699b2018-05-09 20:20:01 +02003413 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3414 : bs->filename;
Max Reitz645ae7d2019-02-01 20:29:14 +01003415 out_real_path =
3416 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3417 out_baseimg,
3418 &local_err);
Max Reitzd16699b2018-05-09 20:20:01 +02003419 if (local_err) {
Max Reitzf22356d2019-05-28 21:53:38 +02003420 qobject_unref(options);
Max Reitzd16699b2018-05-09 20:20:01 +02003421 error_reportf_err(local_err,
3422 "Could not resolve backing filename: ");
3423 ret = -1;
Max Reitzd16699b2018-05-09 20:20:01 +02003424 goto out;
3425 }
3426
Sam Eiderman863cc782019-05-23 19:33:36 +03003427 /*
3428 * Find out whether we rebase an image on top of a previous image
3429 * in its chain.
3430 */
3431 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
Sam Eiderman330c7292019-05-23 19:33:37 +03003432 if (prefix_chain_bs) {
Max Reitzf22356d2019-05-28 21:53:38 +02003433 qobject_unref(options);
Sam Eiderman330c7292019-05-23 19:33:37 +03003434 g_free(out_real_path);
Max Reitzf22356d2019-05-28 21:53:38 +02003435
Kevin Wolfd861ab32019-04-25 14:25:10 +02003436 blk_new_backing = blk_new(qemu_get_aio_context(),
3437 BLK_PERM_CONSISTENT_READ,
Sam Eiderman330c7292019-05-23 19:33:37 +03003438 BLK_PERM_ALL);
3439 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
3440 &local_err);
3441 if (ret < 0) {
3442 error_reportf_err(local_err,
3443 "Could not reuse backing file '%s': ",
3444 out_baseimg);
3445 goto out;
3446 }
3447 } else {
3448 blk_new_backing = blk_new_open(out_real_path, NULL,
3449 options, src_flags, &local_err);
3450 g_free(out_real_path);
3451 if (!blk_new_backing) {
3452 error_reportf_err(local_err,
3453 "Could not open new backing file '%s': ",
3454 out_baseimg);
3455 ret = -1;
3456 goto out;
3457 }
Alex Bligha6166732012-10-16 13:46:18 +01003458 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003459 }
3460 }
3461
3462 /*
3463 * Check each unallocated cluster in the COW file. If it is unallocated,
3464 * accesses go to the backing file. We must therefore compare this cluster
3465 * in the old and new backing file, and if they differ we need to copy it
3466 * from the old backing file into the COW file.
3467 *
3468 * If qemu-img crashes during this step, no harm is done. The content of
3469 * the image is the same as the original one at any time.
3470 */
3471 if (!unsafe) {
Eric Blake41536282017-10-11 22:47:15 -05003472 int64_t size;
Max Reitz35ddd932019-05-09 19:52:35 +02003473 int64_t old_backing_size = 0;
Eric Blake41536282017-10-11 22:47:15 -05003474 int64_t new_backing_size = 0;
3475 uint64_t offset;
3476 int64_t n;
Kevin Wolf1f710492012-10-12 14:29:18 +02003477 float local_progress = 0;
TeLeMand6771bf2010-02-08 16:20:00 +08003478
Max Reitzf1d3cd72015-02-05 13:58:18 -05003479 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3480 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003481
Eric Blake41536282017-10-11 22:47:15 -05003482 size = blk_getlength(blk);
3483 if (size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003484 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003485 filename, strerror(-size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003486 ret = -1;
3487 goto out;
3488 }
Max Reitz35ddd932019-05-09 19:52:35 +02003489 if (blk_old_backing) {
3490 old_backing_size = blk_getlength(blk_old_backing);
3491 if (old_backing_size < 0) {
3492 char backing_name[PATH_MAX];
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003493
Max Reitz35ddd932019-05-09 19:52:35 +02003494 bdrv_get_backing_filename(bs, backing_name,
3495 sizeof(backing_name));
3496 error_report("Could not get size of '%s': %s",
3497 backing_name, strerror(-old_backing_size));
3498 ret = -1;
3499 goto out;
3500 }
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003501 }
Max Reitzf1d3cd72015-02-05 13:58:18 -05003502 if (blk_new_backing) {
Eric Blake41536282017-10-11 22:47:15 -05003503 new_backing_size = blk_getlength(blk_new_backing);
3504 if (new_backing_size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003505 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003506 out_baseimg, strerror(-new_backing_size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003507 ret = -1;
3508 goto out;
3509 }
Alex Bligha6166732012-10-16 13:46:18 +01003510 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003511
Eric Blake41536282017-10-11 22:47:15 -05003512 if (size != 0) {
3513 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
Kevin Wolf1f710492012-10-12 14:29:18 +02003514 }
3515
Eric Blake41536282017-10-11 22:47:15 -05003516 for (offset = 0; offset < size; offset += n) {
Max Reitz1c6e8772019-05-09 19:52:36 +02003517 bool buf_old_is_zero = false;
3518
Eric Blake41536282017-10-11 22:47:15 -05003519 /* How many bytes can we handle with the next read? */
3520 n = MIN(IO_BUF_SIZE, size - offset);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003521
3522 /* If the cluster is allocated, we don't need to take action */
Eric Blake41536282017-10-11 22:47:15 -05003523 ret = bdrv_is_allocated(bs, offset, n, &n);
Paolo Bonzinid6636402013-09-04 19:00:25 +02003524 if (ret < 0) {
3525 error_report("error while reading image metadata: %s",
3526 strerror(-ret));
3527 goto out;
3528 }
Kevin Wolfcc60e322010-04-29 14:47:48 +02003529 if (ret) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003530 continue;
3531 }
3532
Sam Eiderman863cc782019-05-23 19:33:36 +03003533 if (prefix_chain_bs) {
3534 /*
3535 * If cluster wasn't changed since prefix_chain, we don't need
3536 * to take action
3537 */
3538 ret = bdrv_is_allocated_above(backing_bs(bs), prefix_chain_bs,
Andrey Shinkevich170d3bd2019-05-29 20:56:14 +03003539 false, offset, n, &n);
Sam Eiderman863cc782019-05-23 19:33:36 +03003540 if (ret < 0) {
3541 error_report("error while reading image metadata: %s",
3542 strerror(-ret));
3543 goto out;
3544 }
3545 if (!ret) {
3546 continue;
3547 }
3548 }
3549
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003550 /*
3551 * Read old and new backing file and take into consideration that
3552 * backing files may be smaller than the COW image.
3553 */
Eric Blake41536282017-10-11 22:47:15 -05003554 if (offset >= old_backing_size) {
3555 memset(buf_old, 0, n);
Max Reitz1c6e8772019-05-09 19:52:36 +02003556 buf_old_is_zero = true;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003557 } else {
Eric Blake41536282017-10-11 22:47:15 -05003558 if (offset + n > old_backing_size) {
3559 n = old_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003560 }
3561
Eric Blake41536282017-10-11 22:47:15 -05003562 ret = blk_pread(blk_old_backing, offset, buf_old, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003563 if (ret < 0) {
3564 error_report("error while reading from old backing file");
3565 goto out;
3566 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003567 }
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003568
Eric Blake41536282017-10-11 22:47:15 -05003569 if (offset >= new_backing_size || !blk_new_backing) {
3570 memset(buf_new, 0, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003571 } else {
Eric Blake41536282017-10-11 22:47:15 -05003572 if (offset + n > new_backing_size) {
3573 n = new_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003574 }
3575
Eric Blake41536282017-10-11 22:47:15 -05003576 ret = blk_pread(blk_new_backing, offset, buf_new, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003577 if (ret < 0) {
3578 error_report("error while reading from new backing file");
3579 goto out;
3580 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003581 }
3582
3583 /* If they differ, we need to write to the COW file */
3584 uint64_t written = 0;
3585
Eric Blake41536282017-10-11 22:47:15 -05003586 while (written < n) {
Eric Blakedc61cd32017-10-11 22:47:14 -05003587 int64_t pnum;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003588
Eric Blake41536282017-10-11 22:47:15 -05003589 if (compare_buffers(buf_old + written, buf_new + written,
3590 n - written, &pnum))
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003591 {
Max Reitz1c6e8772019-05-09 19:52:36 +02003592 if (buf_old_is_zero) {
3593 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0);
3594 } else {
3595 ret = blk_pwrite(blk, offset + written,
3596 buf_old + written, pnum, 0);
3597 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003598 if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003599 error_report("Error while writing to COW image: %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003600 strerror(-ret));
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003601 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003602 }
3603 }
3604
3605 written += pnum;
3606 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003607 qemu_progress_print(local_progress, 100);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003608 }
3609 }
3610
3611 /*
3612 * Change the backing file. All clusters that are different from the old
3613 * backing file are overwritten in the COW file now, so the visible content
3614 * doesn't change when we switch the backing file.
3615 */
Alex Bligha6166732012-10-16 13:46:18 +01003616 if (out_baseimg && *out_baseimg) {
3617 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
3618 } else {
3619 ret = bdrv_change_backing_file(bs, NULL, NULL);
3620 }
3621
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003622 if (ret == -ENOSPC) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003623 error_report("Could not change the backing file to '%s': No "
3624 "space left in the file header", out_baseimg);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003625 } else if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003626 error_report("Could not change the backing file to '%s': %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003627 out_baseimg, strerror(-ret));
3628 }
3629
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003630 qemu_progress_print(100, 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003631 /*
3632 * TODO At this point it is possible to check if any clusters that are
3633 * allocated in the COW file are the same in the backing file. If so, they
3634 * could be dropped from the COW file. Don't do this before switching the
3635 * backing file, in case of a crash this would lead to corruption.
3636 */
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003637out:
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003638 qemu_progress_end();
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003639 /* Cleanup */
3640 if (!unsafe) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02003641 blk_unref(blk_old_backing);
Markus Armbruster26f54e92014-10-07 13:59:04 +02003642 blk_unref(blk_new_backing);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003643 }
Paolo Bonzini396374c2016-02-25 23:53:54 +01003644 qemu_vfree(buf_old);
3645 qemu_vfree(buf_new);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003646
Markus Armbruster26f54e92014-10-07 13:59:04 +02003647 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003648 if (ret) {
3649 return 1;
3650 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003651 return 0;
3652}
3653
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003654static int img_resize(int argc, char **argv)
3655{
Markus Armbruster6750e792015-02-12 17:43:08 +01003656 Error *err = NULL;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003657 int c, ret, relative;
3658 const char *filename, *fmt, *size;
Max Reitz09c5c6d2019-09-18 11:51:44 +02003659 int64_t n, total_size, current_size;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003660 bool quiet = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003661 BlockBackend *blk = NULL;
Max Reitzdc5f6902017-06-13 22:20:55 +02003662 PreallocMode prealloc = PREALLOC_MODE_OFF;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003663 QemuOpts *param;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003664
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003665 static QemuOptsList resize_options = {
3666 .name = "resize_options",
3667 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3668 .desc = {
3669 {
3670 .name = BLOCK_OPT_SIZE,
3671 .type = QEMU_OPT_SIZE,
3672 .help = "Virtual disk size"
3673 }, {
3674 /* end of list */
3675 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003676 },
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003677 };
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003678 bool image_opts = false;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003679 bool shrink = false;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003680
Kevin Wolfe80fec72011-04-29 10:58:12 +02003681 /* Remove size from argv manually so that negative numbers are not treated
3682 * as options by getopt. */
3683 if (argc < 3) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003684 error_exit("Not enough arguments");
Kevin Wolfe80fec72011-04-29 10:58:12 +02003685 return 1;
3686 }
3687
3688 size = argv[--argc];
3689
3690 /* Parse getopt arguments */
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003691 fmt = NULL;
3692 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003693 static const struct option long_options[] = {
3694 {"help", no_argument, 0, 'h'},
3695 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003696 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Max Reitzdc5f6902017-06-13 22:20:55 +02003697 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003698 {"shrink", no_argument, 0, OPTION_SHRINK},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003699 {0, 0, 0, 0}
3700 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003701 c = getopt_long(argc, argv, ":f:hq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003702 long_options, NULL);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003703 if (c == -1) {
3704 break;
3705 }
3706 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003707 case ':':
3708 missing_argument(argv[optind - 1]);
3709 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003710 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003711 unrecognized_option(argv[optind - 1]);
3712 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003713 case 'h':
3714 help();
3715 break;
3716 case 'f':
3717 fmt = optarg;
3718 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003719 case 'q':
3720 quiet = true;
3721 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003722 case OPTION_OBJECT: {
3723 QemuOpts *opts;
3724 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3725 optarg, true);
3726 if (!opts) {
3727 return 1;
3728 }
3729 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003730 case OPTION_IMAGE_OPTS:
3731 image_opts = true;
3732 break;
Max Reitzdc5f6902017-06-13 22:20:55 +02003733 case OPTION_PREALLOCATION:
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02003734 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
Markus Armbruster06c60b62017-08-24 10:45:57 +02003735 PREALLOC_MODE__MAX, NULL);
Max Reitzdc5f6902017-06-13 22:20:55 +02003736 if (prealloc == PREALLOC_MODE__MAX) {
3737 error_report("Invalid preallocation mode '%s'", optarg);
3738 return 1;
3739 }
3740 break;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003741 case OPTION_SHRINK:
3742 shrink = true;
3743 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003744 }
3745 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02003746 if (optind != argc - 1) {
Max Reitzbe8fbd42018-02-05 17:27:45 +01003747 error_exit("Expecting image file name and size");
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003748 }
3749 filename = argv[optind++];
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003750
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003751 if (qemu_opts_foreach(&qemu_object_opts,
3752 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02003753 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003754 return 1;
3755 }
3756
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003757 /* Choose grow, shrink, or absolute resize mode */
3758 switch (size[0]) {
3759 case '+':
3760 relative = 1;
3761 size++;
3762 break;
3763 case '-':
3764 relative = -1;
3765 size++;
3766 break;
3767 default:
3768 relative = 0;
3769 break;
3770 }
3771
3772 /* Parse size */
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -08003773 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
Markus Armbrusterf43e47d2015-02-12 17:52:20 +01003774 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +01003775 if (err) {
3776 error_report_err(err);
Jes Sorensen2a819982010-12-06 17:08:31 +01003777 ret = -1;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003778 qemu_opts_del(param);
Jes Sorensen2a819982010-12-06 17:08:31 +01003779 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003780 }
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003781 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3782 qemu_opts_del(param);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003783
Max Reitzefaa7c42016-03-16 19:54:38 +01003784 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08003785 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
3786 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003787 if (!blk) {
Jes Sorensen2a819982010-12-06 17:08:31 +01003788 ret = -1;
3789 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003790 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003791
Max Reitzdc5f6902017-06-13 22:20:55 +02003792 current_size = blk_getlength(blk);
3793 if (current_size < 0) {
3794 error_report("Failed to inquire current image length: %s",
3795 strerror(-current_size));
3796 ret = -1;
3797 goto out;
3798 }
3799
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003800 if (relative) {
Max Reitzdc5f6902017-06-13 22:20:55 +02003801 total_size = current_size + n * relative;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003802 } else {
3803 total_size = n;
3804 }
3805 if (total_size <= 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003806 error_report("New image size must be positive");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003807 ret = -1;
3808 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003809 }
3810
Max Reitzdc5f6902017-06-13 22:20:55 +02003811 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
3812 error_report("Preallocation can only be used for growing images");
3813 ret = -1;
3814 goto out;
3815 }
3816
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003817 if (total_size < current_size && !shrink) {
3818 warn_report("Shrinking an image will delete all data beyond the "
3819 "shrunken image's end. Before performing such an "
3820 "operation, make sure there is no important data there.");
3821
3822 if (g_strcmp0(bdrv_get_format_name(blk_bs(blk)), "raw") != 0) {
3823 error_report(
3824 "Use the --shrink option to perform a shrink operation.");
3825 ret = -1;
3826 goto out;
3827 } else {
3828 warn_report("Using the --shrink option will suppress this message. "
3829 "Note that future versions of qemu-img may refuse to "
3830 "shrink images without this option.");
3831 }
3832 }
3833
Max Reitze8d04f92019-09-18 11:51:43 +02003834 /*
3835 * The user expects the image to have the desired size after
3836 * resizing, so pass @exact=true. It is of no use to report
3837 * success when the image has not actually been resized.
3838 */
3839 ret = blk_truncate(blk, total_size, true, prealloc, &err);
Max Reitz09c5c6d2019-09-18 11:51:44 +02003840 if (!ret) {
3841 qprintf(quiet, "Image resized.\n");
3842 } else {
Max Reitzed3d2ec2017-03-28 22:51:27 +02003843 error_report_err(err);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003844 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003845out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003846 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003847 if (ret) {
3848 return 1;
3849 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003850 return 0;
3851}
3852
Max Reitz76a3a342014-10-27 11:12:51 +01003853static void amend_status_cb(BlockDriverState *bs,
Max Reitz8b139762015-07-27 17:51:32 +02003854 int64_t offset, int64_t total_work_size,
3855 void *opaque)
Max Reitz76a3a342014-10-27 11:12:51 +01003856{
3857 qemu_progress_print(100.f * offset / total_work_size, 0);
3858}
3859
Max Reitz51641352018-05-09 23:00:20 +02003860static int print_amend_option_help(const char *format)
3861{
3862 BlockDriver *drv;
3863
3864 /* Find driver and parse its options */
3865 drv = bdrv_find_format(format);
3866 if (!drv) {
3867 error_report("Unknown file format '%s'", format);
3868 return 1;
3869 }
3870
3871 if (!drv->bdrv_amend_options) {
3872 error_report("Format driver '%s' does not support option amendment",
3873 format);
3874 return 1;
3875 }
3876
3877 /* Every driver supporting amendment must have create_opts */
3878 assert(drv->create_opts);
3879
3880 printf("Creation options for '%s':\n", format);
Max Reitz63898712018-10-19 18:49:25 +02003881 qemu_opts_print_help(drv->create_opts, false);
Max Reitz51641352018-05-09 23:00:20 +02003882 printf("\nNote that not all of these options may be amendable.\n");
3883 return 0;
3884}
3885
Max Reitz6f176b42013-09-03 10:09:50 +02003886static int img_amend(int argc, char **argv)
3887{
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01003888 Error *err = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02003889 int c, ret = 0;
3890 char *options = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08003891 QemuOptsList *create_opts = NULL;
3892 QemuOpts *opts = NULL;
Max Reitzbd39e6e2014-07-22 22:58:43 +02003893 const char *fmt = NULL, *filename, *cache;
3894 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01003895 bool writethrough;
Max Reitz76a3a342014-10-27 11:12:51 +01003896 bool quiet = false, progress = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003897 BlockBackend *blk = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02003898 BlockDriverState *bs = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003899 bool image_opts = false;
Max Reitz6f176b42013-09-03 10:09:50 +02003900
Max Reitzbd39e6e2014-07-22 22:58:43 +02003901 cache = BDRV_DEFAULT_CACHE;
Max Reitz6f176b42013-09-03 10:09:50 +02003902 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003903 static const struct option long_options[] = {
3904 {"help", no_argument, 0, 'h'},
3905 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003906 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003907 {0, 0, 0, 0}
3908 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003909 c = getopt_long(argc, argv, ":ho:f:t:pq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003910 long_options, NULL);
Max Reitz6f176b42013-09-03 10:09:50 +02003911 if (c == -1) {
3912 break;
3913 }
3914
3915 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003916 case ':':
3917 missing_argument(argv[optind - 1]);
3918 break;
Stefan Hajnoczif7077622017-03-17 18:45:40 +08003919 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003920 unrecognized_option(argv[optind - 1]);
3921 break;
3922 case 'h':
Stefan Hajnoczif7077622017-03-17 18:45:40 +08003923 help();
3924 break;
3925 case 'o':
3926 if (!is_valid_option_list(optarg)) {
3927 error_report("Invalid option list: %s", optarg);
3928 ret = -1;
3929 goto out_no_progress;
3930 }
3931 if (!options) {
3932 options = g_strdup(optarg);
3933 } else {
3934 char *old_options = options;
3935 options = g_strdup_printf("%s,%s", options, optarg);
3936 g_free(old_options);
3937 }
3938 break;
3939 case 'f':
3940 fmt = optarg;
3941 break;
3942 case 't':
3943 cache = optarg;
3944 break;
3945 case 'p':
3946 progress = true;
3947 break;
3948 case 'q':
3949 quiet = true;
3950 break;
3951 case OPTION_OBJECT:
3952 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3953 optarg, true);
3954 if (!opts) {
3955 ret = -1;
3956 goto out_no_progress;
3957 }
3958 break;
3959 case OPTION_IMAGE_OPTS:
3960 image_opts = true;
3961 break;
Max Reitz6f176b42013-09-03 10:09:50 +02003962 }
3963 }
3964
Max Reitz6f176b42013-09-03 10:09:50 +02003965 if (!options) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003966 error_exit("Must specify options (-o)");
Max Reitz6f176b42013-09-03 10:09:50 +02003967 }
3968
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003969 if (qemu_opts_foreach(&qemu_object_opts,
3970 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02003971 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003972 ret = -1;
3973 goto out_no_progress;
3974 }
3975
Max Reitz76a3a342014-10-27 11:12:51 +01003976 if (quiet) {
3977 progress = false;
3978 }
3979 qemu_progress_init(progress, 1.0);
3980
Kevin Wolfa283cb62014-02-21 16:24:07 +01003981 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
3982 if (fmt && has_help_option(options)) {
3983 /* If a format is explicitly specified (and possibly no filename is
3984 * given), print option help here */
Max Reitz51641352018-05-09 23:00:20 +02003985 ret = print_amend_option_help(fmt);
Kevin Wolfa283cb62014-02-21 16:24:07 +01003986 goto out;
3987 }
3988
3989 if (optind != argc - 1) {
Max Reitzb2f27e42014-10-27 11:12:52 +01003990 error_report("Expecting one image file name");
3991 ret = -1;
3992 goto out;
Kevin Wolfa283cb62014-02-21 16:24:07 +01003993 }
Max Reitz6f176b42013-09-03 10:09:50 +02003994
Kevin Wolfce099542016-03-15 13:01:04 +01003995 flags = BDRV_O_RDWR;
3996 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitzbd39e6e2014-07-22 22:58:43 +02003997 if (ret < 0) {
3998 error_report("Invalid cache option: %s", cache);
3999 goto out;
4000 }
4001
Fam Zheng335e9932017-05-03 00:35:39 +08004002 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4003 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004004 if (!blk) {
Max Reitz6f176b42013-09-03 10:09:50 +02004005 ret = -1;
4006 goto out;
4007 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004008 bs = blk_bs(blk);
Max Reitz6f176b42013-09-03 10:09:50 +02004009
4010 fmt = bs->drv->format_name;
4011
Kevin Wolf626f84f2014-02-21 16:24:06 +01004012 if (has_help_option(options)) {
Kevin Wolfa283cb62014-02-21 16:24:07 +01004013 /* If the format was auto-detected, print option help here */
Max Reitz51641352018-05-09 23:00:20 +02004014 ret = print_amend_option_help(fmt);
Max Reitz6f176b42013-09-03 10:09:50 +02004015 goto out;
4016 }
4017
Max Reitz1f996682018-05-09 23:00:17 +02004018 if (!bs->drv->bdrv_amend_options) {
4019 error_report("Format driver '%s' does not support option amendment",
Max Reitzb2439d22014-12-02 18:32:47 +01004020 fmt);
4021 ret = -1;
4022 goto out;
4023 }
4024
Max Reitz1f996682018-05-09 23:00:17 +02004025 /* Every driver supporting amendment must have create_opts */
4026 assert(bs->drv->create_opts);
4027
Chunyan Liuc282e1f2014-06-05 17:21:11 +08004028 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
Chunyan Liu83d05212014-06-05 17:20:51 +08004029 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Paolo Bonziniece90862017-01-04 15:56:24 +01004030 qemu_opts_do_parse(opts, options, NULL, &err);
4031 if (err) {
4032 error_report_err(err);
4033 ret = -1;
4034 goto out;
Max Reitz6f176b42013-09-03 10:09:50 +02004035 }
4036
Max Reitz76a3a342014-10-27 11:12:51 +01004037 /* In case the driver does not call amend_status_cb() */
4038 qemu_progress_print(0.f, 0);
Max Reitzd1402b52018-05-09 23:00:18 +02004039 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, &err);
Max Reitz76a3a342014-10-27 11:12:51 +01004040 qemu_progress_print(100.f, 0);
Max Reitz6f176b42013-09-03 10:09:50 +02004041 if (ret < 0) {
Max Reitzd1402b52018-05-09 23:00:18 +02004042 error_report_err(err);
Max Reitz6f176b42013-09-03 10:09:50 +02004043 goto out;
4044 }
4045
4046out:
Max Reitz76a3a342014-10-27 11:12:51 +01004047 qemu_progress_end();
4048
Max Reitze814dff2015-08-20 16:00:38 -07004049out_no_progress:
Markus Armbruster26f54e92014-10-07 13:59:04 +02004050 blk_unref(blk);
Chunyan Liu83d05212014-06-05 17:20:51 +08004051 qemu_opts_del(opts);
4052 qemu_opts_free(create_opts);
Kevin Wolf626f84f2014-02-21 16:24:06 +01004053 g_free(options);
4054
Max Reitz6f176b42013-09-03 10:09:50 +02004055 if (ret) {
4056 return 1;
4057 }
4058 return 0;
4059}
4060
Kevin Wolfb6133b82014-08-05 14:17:13 +02004061typedef struct BenchData {
4062 BlockBackend *blk;
4063 uint64_t image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004064 bool write;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004065 int bufsize;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004066 int step;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004067 int nrreq;
4068 int n;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004069 int flush_interval;
4070 bool drain_on_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004071 uint8_t *buf;
4072 QEMUIOVector *qiov;
4073
4074 int in_flight;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004075 bool in_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004076 uint64_t offset;
4077} BenchData;
4078
Kevin Wolf55d539c2016-06-03 13:59:41 +02004079static void bench_undrained_flush_cb(void *opaque, int ret)
4080{
4081 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004082 error_report("Failed flush request: %s", strerror(-ret));
Kevin Wolf55d539c2016-06-03 13:59:41 +02004083 exit(EXIT_FAILURE);
4084 }
4085}
4086
Kevin Wolfb6133b82014-08-05 14:17:13 +02004087static void bench_cb(void *opaque, int ret)
4088{
4089 BenchData *b = opaque;
4090 BlockAIOCB *acb;
4091
4092 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004093 error_report("Failed request: %s", strerror(-ret));
Kevin Wolfb6133b82014-08-05 14:17:13 +02004094 exit(EXIT_FAILURE);
4095 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004096
4097 if (b->in_flush) {
4098 /* Just finished a flush with drained queue: Start next requests */
4099 assert(b->in_flight == 0);
4100 b->in_flush = false;
4101 } else if (b->in_flight > 0) {
4102 int remaining = b->n - b->in_flight;
4103
Kevin Wolfb6133b82014-08-05 14:17:13 +02004104 b->n--;
4105 b->in_flight--;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004106
4107 /* Time for flush? Drain queue if requested, then flush */
4108 if (b->flush_interval && remaining % b->flush_interval == 0) {
4109 if (!b->in_flight || !b->drain_on_flush) {
4110 BlockCompletionFunc *cb;
4111
4112 if (b->drain_on_flush) {
4113 b->in_flush = true;
4114 cb = bench_cb;
4115 } else {
4116 cb = bench_undrained_flush_cb;
4117 }
4118
4119 acb = blk_aio_flush(b->blk, cb, b);
4120 if (!acb) {
4121 error_report("Failed to issue flush request");
4122 exit(EXIT_FAILURE);
4123 }
4124 }
4125 if (b->drain_on_flush) {
4126 return;
4127 }
4128 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004129 }
4130
4131 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004132 int64_t offset = b->offset;
4133 /* blk_aio_* might look for completed I/Os and kick bench_cb
4134 * again, so make sure this operation is counted by in_flight
4135 * and b->offset is ready for the next submission.
4136 */
4137 b->in_flight++;
4138 b->offset += b->step;
4139 b->offset %= b->image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004140 if (b->write) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004141 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004142 } else {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004143 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004144 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004145 if (!acb) {
4146 error_report("Failed to issue request");
4147 exit(EXIT_FAILURE);
4148 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004149 }
4150}
4151
4152static int img_bench(int argc, char **argv)
4153{
4154 int c, ret = 0;
4155 const char *fmt = NULL, *filename;
4156 bool quiet = false;
4157 bool image_opts = false;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004158 bool is_write = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004159 int count = 75000;
4160 int depth = 64;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004161 int64_t offset = 0;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004162 size_t bufsize = 4096;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004163 int pattern = 0;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004164 size_t step = 0;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004165 int flush_interval = 0;
4166 bool drain_on_flush = true;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004167 int64_t image_size;
4168 BlockBackend *blk = NULL;
4169 BenchData data = {};
4170 int flags = 0;
Kevin Wolf604e8612016-06-14 11:29:32 +02004171 bool writethrough = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004172 struct timeval t1, t2;
4173 int i;
Fam Zheng335e9932017-05-03 00:35:39 +08004174 bool force_share = false;
Fam Zheng79d46582018-01-16 14:08:58 +08004175 size_t buf_size;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004176
4177 for (;;) {
4178 static const struct option long_options[] = {
4179 {"help", no_argument, 0, 'h'},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004180 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004181 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004182 {"pattern", required_argument, 0, OPTION_PATTERN},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004183 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
Fam Zheng335e9932017-05-03 00:35:39 +08004184 {"force-share", no_argument, 0, 'U'},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004185 {0, 0, 0, 0}
4186 };
Fam Zheng335e9932017-05-03 00:35:39 +08004187 c = getopt_long(argc, argv, ":hc:d:f:no:qs:S:t:wU", long_options, NULL);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004188 if (c == -1) {
4189 break;
4190 }
4191
4192 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004193 case ':':
4194 missing_argument(argv[optind - 1]);
4195 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004196 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004197 unrecognized_option(argv[optind - 1]);
4198 break;
4199 case 'h':
Kevin Wolfb6133b82014-08-05 14:17:13 +02004200 help();
4201 break;
4202 case 'c':
4203 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004204 unsigned long res;
4205
4206 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004207 error_report("Invalid request count specified");
4208 return 1;
4209 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004210 count = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004211 break;
4212 }
4213 case 'd':
4214 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004215 unsigned long res;
4216
4217 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004218 error_report("Invalid queue depth specified");
4219 return 1;
4220 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004221 depth = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004222 break;
4223 }
4224 case 'f':
4225 fmt = optarg;
4226 break;
4227 case 'n':
4228 flags |= BDRV_O_NATIVE_AIO;
4229 break;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004230 case 'o':
4231 {
Markus Armbruster606caa02017-02-21 21:14:04 +01004232 offset = cvtnum(optarg);
4233 if (offset < 0) {
Kevin Wolfd3199a32015-07-10 18:09:18 +02004234 error_report("Invalid offset specified");
4235 return 1;
4236 }
4237 break;
4238 }
4239 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004240 case 'q':
4241 quiet = true;
4242 break;
4243 case 's':
4244 {
4245 int64_t sval;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004246
Markus Armbruster606caa02017-02-21 21:14:04 +01004247 sval = cvtnum(optarg);
4248 if (sval < 0 || sval > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004249 error_report("Invalid buffer size specified");
4250 return 1;
4251 }
4252
4253 bufsize = sval;
4254 break;
4255 }
Kevin Wolf83de9be2015-07-13 13:13:17 +02004256 case 'S':
4257 {
4258 int64_t sval;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004259
Markus Armbruster606caa02017-02-21 21:14:04 +01004260 sval = cvtnum(optarg);
4261 if (sval < 0 || sval > INT_MAX) {
Kevin Wolf83de9be2015-07-13 13:13:17 +02004262 error_report("Invalid step size specified");
4263 return 1;
4264 }
4265
4266 step = sval;
4267 break;
4268 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004269 case 't':
4270 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4271 if (ret < 0) {
4272 error_report("Invalid cache mode");
4273 ret = -1;
4274 goto out;
4275 }
4276 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004277 case 'w':
4278 flags |= BDRV_O_RDWR;
4279 is_write = true;
4280 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004281 case 'U':
4282 force_share = true;
4283 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004284 case OPTION_PATTERN:
4285 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004286 unsigned long res;
4287
4288 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004289 error_report("Invalid pattern byte specified");
4290 return 1;
4291 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004292 pattern = res;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004293 break;
4294 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004295 case OPTION_FLUSH_INTERVAL:
4296 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004297 unsigned long res;
4298
4299 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004300 error_report("Invalid flush interval specified");
4301 return 1;
4302 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004303 flush_interval = res;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004304 break;
4305 }
4306 case OPTION_NO_DRAIN:
4307 drain_on_flush = false;
4308 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004309 case OPTION_IMAGE_OPTS:
4310 image_opts = true;
4311 break;
4312 }
4313 }
4314
4315 if (optind != argc - 1) {
4316 error_exit("Expecting one image file name");
4317 }
4318 filename = argv[argc - 1];
4319
Kevin Wolf55d539c2016-06-03 13:59:41 +02004320 if (!is_write && flush_interval) {
4321 error_report("--flush-interval is only available in write tests");
4322 ret = -1;
4323 goto out;
4324 }
4325 if (flush_interval && flush_interval < depth) {
4326 error_report("Flush interval can't be smaller than depth");
4327 ret = -1;
4328 goto out;
4329 }
4330
Fam Zheng335e9932017-05-03 00:35:39 +08004331 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4332 force_share);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004333 if (!blk) {
4334 ret = -1;
4335 goto out;
4336 }
4337
4338 image_size = blk_getlength(blk);
4339 if (image_size < 0) {
4340 ret = image_size;
4341 goto out;
4342 }
4343
4344 data = (BenchData) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004345 .blk = blk,
4346 .image_size = image_size,
4347 .bufsize = bufsize,
4348 .step = step ?: bufsize,
4349 .nrreq = depth,
4350 .n = count,
4351 .offset = offset,
4352 .write = is_write,
4353 .flush_interval = flush_interval,
4354 .drain_on_flush = drain_on_flush,
Kevin Wolfb6133b82014-08-05 14:17:13 +02004355 };
Kevin Wolfd3199a32015-07-10 18:09:18 +02004356 printf("Sending %d %s requests, %d bytes each, %d in parallel "
Kevin Wolf83de9be2015-07-13 13:13:17 +02004357 "(starting at offset %" PRId64 ", step size %d)\n",
Kevin Wolfd3199a32015-07-10 18:09:18 +02004358 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
Kevin Wolf83de9be2015-07-13 13:13:17 +02004359 data.offset, data.step);
Kevin Wolf55d539c2016-06-03 13:59:41 +02004360 if (flush_interval) {
4361 printf("Sending flush every %d requests\n", flush_interval);
4362 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004363
Fam Zheng79d46582018-01-16 14:08:58 +08004364 buf_size = data.nrreq * data.bufsize;
4365 data.buf = blk_blockalign(blk, buf_size);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004366 memset(data.buf, pattern, data.nrreq * data.bufsize);
4367
Fam Zheng79d46582018-01-16 14:08:58 +08004368 blk_register_buf(blk, data.buf, buf_size);
4369
Kevin Wolfb6133b82014-08-05 14:17:13 +02004370 data.qiov = g_new(QEMUIOVector, data.nrreq);
4371 for (i = 0; i < data.nrreq; i++) {
4372 qemu_iovec_init(&data.qiov[i], 1);
4373 qemu_iovec_add(&data.qiov[i],
4374 data.buf + i * data.bufsize, data.bufsize);
4375 }
4376
4377 gettimeofday(&t1, NULL);
4378 bench_cb(&data, 0);
4379
4380 while (data.n > 0) {
4381 main_loop_wait(false);
4382 }
4383 gettimeofday(&t2, NULL);
4384
4385 printf("Run completed in %3.3f seconds.\n",
4386 (t2.tv_sec - t1.tv_sec)
4387 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4388
4389out:
Fam Zheng79d46582018-01-16 14:08:58 +08004390 if (data.buf) {
4391 blk_unregister_buf(blk, data.buf);
4392 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004393 qemu_vfree(data.buf);
4394 blk_unref(blk);
4395
4396 if (ret) {
4397 return 1;
4398 }
4399 return 0;
4400}
4401
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004402#define C_BS 01
4403#define C_COUNT 02
4404#define C_IF 04
4405#define C_OF 010
Reda Sallahif7c15532016-08-10 16:16:09 +02004406#define C_SKIP 020
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004407
4408struct DdInfo {
4409 unsigned int flags;
4410 int64_t count;
4411};
4412
4413struct DdIo {
4414 int bsz; /* Block size */
4415 char *filename;
4416 uint8_t *buf;
Reda Sallahif7c15532016-08-10 16:16:09 +02004417 int64_t offset;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004418};
4419
4420struct DdOpts {
4421 const char *name;
4422 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
4423 unsigned int flag;
4424};
4425
4426static int img_dd_bs(const char *arg,
4427 struct DdIo *in, struct DdIo *out,
4428 struct DdInfo *dd)
4429{
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004430 int64_t res;
4431
Markus Armbruster606caa02017-02-21 21:14:04 +01004432 res = cvtnum(arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004433
Markus Armbruster606caa02017-02-21 21:14:04 +01004434 if (res <= 0 || res > INT_MAX) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004435 error_report("invalid number: '%s'", arg);
4436 return 1;
4437 }
4438 in->bsz = out->bsz = res;
4439
4440 return 0;
4441}
4442
4443static int img_dd_count(const char *arg,
4444 struct DdIo *in, struct DdIo *out,
4445 struct DdInfo *dd)
4446{
Markus Armbruster606caa02017-02-21 21:14:04 +01004447 dd->count = cvtnum(arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004448
Markus Armbruster606caa02017-02-21 21:14:04 +01004449 if (dd->count < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004450 error_report("invalid number: '%s'", arg);
4451 return 1;
4452 }
4453
4454 return 0;
4455}
4456
4457static int img_dd_if(const char *arg,
4458 struct DdIo *in, struct DdIo *out,
4459 struct DdInfo *dd)
4460{
4461 in->filename = g_strdup(arg);
4462
4463 return 0;
4464}
4465
4466static int img_dd_of(const char *arg,
4467 struct DdIo *in, struct DdIo *out,
4468 struct DdInfo *dd)
4469{
4470 out->filename = g_strdup(arg);
4471
4472 return 0;
4473}
4474
Reda Sallahif7c15532016-08-10 16:16:09 +02004475static int img_dd_skip(const char *arg,
4476 struct DdIo *in, struct DdIo *out,
4477 struct DdInfo *dd)
4478{
Markus Armbruster606caa02017-02-21 21:14:04 +01004479 in->offset = cvtnum(arg);
Reda Sallahif7c15532016-08-10 16:16:09 +02004480
Markus Armbruster606caa02017-02-21 21:14:04 +01004481 if (in->offset < 0) {
Reda Sallahif7c15532016-08-10 16:16:09 +02004482 error_report("invalid number: '%s'", arg);
4483 return 1;
4484 }
4485
4486 return 0;
4487}
4488
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004489static int img_dd(int argc, char **argv)
4490{
4491 int ret = 0;
4492 char *arg = NULL;
4493 char *tmp;
4494 BlockDriver *drv = NULL, *proto_drv = NULL;
4495 BlockBackend *blk1 = NULL, *blk2 = NULL;
4496 QemuOpts *opts = NULL;
4497 QemuOptsList *create_opts = NULL;
4498 Error *local_err = NULL;
4499 bool image_opts = false;
4500 int c, i;
4501 const char *out_fmt = "raw";
4502 const char *fmt = NULL;
4503 int64_t size = 0;
4504 int64_t block_count = 0, out_pos, in_pos;
Fam Zheng335e9932017-05-03 00:35:39 +08004505 bool force_share = false;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004506 struct DdInfo dd = {
4507 .flags = 0,
4508 .count = 0,
4509 };
4510 struct DdIo in = {
4511 .bsz = 512, /* Block size is by default 512 bytes */
4512 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004513 .buf = NULL,
4514 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004515 };
4516 struct DdIo out = {
4517 .bsz = 512,
4518 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004519 .buf = NULL,
4520 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004521 };
4522
4523 const struct DdOpts options[] = {
4524 { "bs", img_dd_bs, C_BS },
4525 { "count", img_dd_count, C_COUNT },
4526 { "if", img_dd_if, C_IF },
4527 { "of", img_dd_of, C_OF },
Reda Sallahif7c15532016-08-10 16:16:09 +02004528 { "skip", img_dd_skip, C_SKIP },
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004529 { NULL, NULL, 0 }
4530 };
4531 const struct option long_options[] = {
4532 { "help", no_argument, 0, 'h'},
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004533 { "object", required_argument, 0, OPTION_OBJECT},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004534 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08004535 { "force-share", no_argument, 0, 'U'},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004536 { 0, 0, 0, 0 }
4537 };
4538
Fam Zheng335e9932017-05-03 00:35:39 +08004539 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004540 if (c == EOF) {
4541 break;
4542 }
4543 switch (c) {
4544 case 'O':
4545 out_fmt = optarg;
4546 break;
4547 case 'f':
4548 fmt = optarg;
4549 break;
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004550 case ':':
4551 missing_argument(argv[optind - 1]);
4552 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004553 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004554 unrecognized_option(argv[optind - 1]);
4555 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004556 case 'h':
4557 help();
4558 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004559 case 'U':
4560 force_share = true;
4561 break;
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01004562 case OPTION_OBJECT:
4563 if (!qemu_opts_parse_noisily(&qemu_object_opts, optarg, true)) {
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004564 ret = -1;
4565 goto out;
4566 }
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01004567 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004568 case OPTION_IMAGE_OPTS:
4569 image_opts = true;
4570 break;
4571 }
4572 }
4573
4574 for (i = optind; i < argc; i++) {
4575 int j;
4576 arg = g_strdup(argv[i]);
4577
4578 tmp = strchr(arg, '=');
4579 if (tmp == NULL) {
4580 error_report("unrecognized operand %s", arg);
4581 ret = -1;
4582 goto out;
4583 }
4584
4585 *tmp++ = '\0';
4586
4587 for (j = 0; options[j].name != NULL; j++) {
4588 if (!strcmp(arg, options[j].name)) {
4589 break;
4590 }
4591 }
4592 if (options[j].name == NULL) {
4593 error_report("unrecognized operand %s", arg);
4594 ret = -1;
4595 goto out;
4596 }
4597
4598 if (options[j].f(tmp, &in, &out, &dd) != 0) {
4599 ret = -1;
4600 goto out;
4601 }
4602 dd.flags |= options[j].flag;
4603 g_free(arg);
4604 arg = NULL;
4605 }
4606
4607 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
4608 error_report("Must specify both input and output files");
4609 ret = -1;
4610 goto out;
4611 }
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004612
4613 if (qemu_opts_foreach(&qemu_object_opts,
4614 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02004615 qemu_img_object_print_help, &error_fatal)) {
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004616 ret = -1;
4617 goto out;
4618 }
4619
Fam Zheng335e9932017-05-03 00:35:39 +08004620 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
4621 force_share);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004622
4623 if (!blk1) {
4624 ret = -1;
4625 goto out;
4626 }
4627
4628 drv = bdrv_find_format(out_fmt);
4629 if (!drv) {
4630 error_report("Unknown file format");
4631 ret = -1;
4632 goto out;
4633 }
4634 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
4635
4636 if (!proto_drv) {
4637 error_report_err(local_err);
4638 ret = -1;
4639 goto out;
4640 }
4641 if (!drv->create_opts) {
4642 error_report("Format driver '%s' does not support image creation",
4643 drv->format_name);
4644 ret = -1;
4645 goto out;
4646 }
4647 if (!proto_drv->create_opts) {
4648 error_report("Protocol driver '%s' does not support image creation",
4649 proto_drv->format_name);
4650 ret = -1;
4651 goto out;
4652 }
4653 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4654 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
4655
4656 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4657
4658 size = blk_getlength(blk1);
4659 if (size < 0) {
4660 error_report("Failed to get size for '%s'", in.filename);
4661 ret = -1;
4662 goto out;
4663 }
4664
4665 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
4666 dd.count * in.bsz < size) {
4667 size = dd.count * in.bsz;
4668 }
4669
Reda Sallahif7c15532016-08-10 16:16:09 +02004670 /* Overflow means the specified offset is beyond input image's size */
4671 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4672 size < in.bsz * in.offset)) {
4673 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
4674 } else {
4675 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
4676 size - in.bsz * in.offset, &error_abort);
4677 }
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004678
4679 ret = bdrv_create(drv, out.filename, opts, &local_err);
4680 if (ret < 0) {
4681 error_reportf_err(local_err,
4682 "%s: error while creating output image: ",
4683 out.filename);
4684 ret = -1;
4685 goto out;
4686 }
4687
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01004688 /* TODO, we can't honour --image-opts for the target,
4689 * since it needs to be given in a format compatible
4690 * with the bdrv_create() call above which does not
4691 * support image-opts style.
4692 */
Daniel P. Berrange29cf9332017-05-15 17:47:12 +01004693 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01004694 false, false, false);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004695
4696 if (!blk2) {
4697 ret = -1;
4698 goto out;
4699 }
4700
Reda Sallahif7c15532016-08-10 16:16:09 +02004701 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4702 size < in.offset * in.bsz)) {
4703 /* We give a warning if the skip option is bigger than the input
4704 * size and create an empty output disk image (i.e. like dd(1)).
4705 */
4706 error_report("%s: cannot skip to specified offset", in.filename);
4707 in_pos = size;
4708 } else {
4709 in_pos = in.offset * in.bsz;
4710 }
4711
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004712 in.buf = g_new(uint8_t, in.bsz);
4713
Reda Sallahif7c15532016-08-10 16:16:09 +02004714 for (out_pos = 0; in_pos < size; block_count++) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004715 int in_ret, out_ret;
4716
4717 if (in_pos + in.bsz > size) {
4718 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
4719 } else {
4720 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
4721 }
4722 if (in_ret < 0) {
4723 error_report("error while reading from input image file: %s",
4724 strerror(-in_ret));
4725 ret = -1;
4726 goto out;
4727 }
4728 in_pos += in_ret;
4729
4730 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
4731
4732 if (out_ret < 0) {
4733 error_report("error while writing to output image file: %s",
4734 strerror(-out_ret));
4735 ret = -1;
4736 goto out;
4737 }
4738 out_pos += out_ret;
4739 }
4740
4741out:
4742 g_free(arg);
4743 qemu_opts_del(opts);
4744 qemu_opts_free(create_opts);
4745 blk_unref(blk1);
4746 blk_unref(blk2);
4747 g_free(in.filename);
4748 g_free(out.filename);
4749 g_free(in.buf);
4750 g_free(out.buf);
4751
4752 if (ret) {
4753 return 1;
4754 }
4755 return 0;
4756}
4757
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01004758static void dump_json_block_measure_info(BlockMeasureInfo *info)
4759{
4760 QString *str;
4761 QObject *obj;
4762 Visitor *v = qobject_output_visitor_new(&obj);
4763
4764 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
4765 visit_complete(v, &obj);
4766 str = qobject_to_json_pretty(obj);
4767 assert(str != NULL);
4768 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02004769 qobject_unref(obj);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01004770 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02004771 qobject_unref(str);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01004772}
4773
4774static int img_measure(int argc, char **argv)
4775{
4776 static const struct option long_options[] = {
4777 {"help", no_argument, 0, 'h'},
4778 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4779 {"object", required_argument, 0, OPTION_OBJECT},
4780 {"output", required_argument, 0, OPTION_OUTPUT},
4781 {"size", required_argument, 0, OPTION_SIZE},
4782 {"force-share", no_argument, 0, 'U'},
4783 {0, 0, 0, 0}
4784 };
4785 OutputFormat output_format = OFORMAT_HUMAN;
4786 BlockBackend *in_blk = NULL;
4787 BlockDriver *drv;
4788 const char *filename = NULL;
4789 const char *fmt = NULL;
4790 const char *out_fmt = "raw";
4791 char *options = NULL;
4792 char *snapshot_name = NULL;
4793 bool force_share = false;
4794 QemuOpts *opts = NULL;
4795 QemuOpts *object_opts = NULL;
4796 QemuOpts *sn_opts = NULL;
4797 QemuOptsList *create_opts = NULL;
4798 bool image_opts = false;
4799 uint64_t img_size = UINT64_MAX;
4800 BlockMeasureInfo *info = NULL;
4801 Error *local_err = NULL;
4802 int ret = 1;
4803 int c;
4804
4805 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
4806 long_options, NULL)) != -1) {
4807 switch (c) {
4808 case '?':
4809 case 'h':
4810 help();
4811 break;
4812 case 'f':
4813 fmt = optarg;
4814 break;
4815 case 'O':
4816 out_fmt = optarg;
4817 break;
4818 case 'o':
4819 if (!is_valid_option_list(optarg)) {
4820 error_report("Invalid option list: %s", optarg);
4821 goto out;
4822 }
4823 if (!options) {
4824 options = g_strdup(optarg);
4825 } else {
4826 char *old_options = options;
4827 options = g_strdup_printf("%s,%s", options, optarg);
4828 g_free(old_options);
4829 }
4830 break;
4831 case 'l':
4832 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
4833 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
4834 optarg, false);
4835 if (!sn_opts) {
4836 error_report("Failed in parsing snapshot param '%s'",
4837 optarg);
4838 goto out;
4839 }
4840 } else {
4841 snapshot_name = optarg;
4842 }
4843 break;
4844 case 'U':
4845 force_share = true;
4846 break;
4847 case OPTION_OBJECT:
4848 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
4849 optarg, true);
4850 if (!object_opts) {
4851 goto out;
4852 }
4853 break;
4854 case OPTION_IMAGE_OPTS:
4855 image_opts = true;
4856 break;
4857 case OPTION_OUTPUT:
4858 if (!strcmp(optarg, "json")) {
4859 output_format = OFORMAT_JSON;
4860 } else if (!strcmp(optarg, "human")) {
4861 output_format = OFORMAT_HUMAN;
4862 } else {
4863 error_report("--output must be used with human or json "
4864 "as argument.");
4865 goto out;
4866 }
4867 break;
4868 case OPTION_SIZE:
4869 {
4870 int64_t sval;
4871
4872 sval = cvtnum(optarg);
4873 if (sval < 0) {
4874 if (sval == -ERANGE) {
4875 error_report("Image size must be less than 8 EiB!");
4876 } else {
4877 error_report("Invalid image size specified! You may use "
4878 "k, M, G, T, P or E suffixes for ");
4879 error_report("kilobytes, megabytes, gigabytes, terabytes, "
4880 "petabytes and exabytes.");
4881 }
4882 goto out;
4883 }
4884 img_size = (uint64_t)sval;
4885 }
4886 break;
4887 }
4888 }
4889
4890 if (qemu_opts_foreach(&qemu_object_opts,
4891 user_creatable_add_opts_foreach,
Kevin Wolfc6e5cdf2019-10-11 21:49:17 +02004892 qemu_img_object_print_help, &error_fatal)) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01004893 goto out;
4894 }
4895
4896 if (argc - optind > 1) {
4897 error_report("At most one filename argument is allowed.");
4898 goto out;
4899 } else if (argc - optind == 1) {
4900 filename = argv[optind];
4901 }
4902
4903 if (!filename &&
4904 (object_opts || image_opts || fmt || snapshot_name || sn_opts)) {
4905 error_report("--object, --image-opts, -f, and -l "
4906 "require a filename argument.");
4907 goto out;
4908 }
4909 if (filename && img_size != UINT64_MAX) {
4910 error_report("--size N cannot be used together with a filename.");
4911 goto out;
4912 }
4913 if (!filename && img_size == UINT64_MAX) {
4914 error_report("Either --size N or one filename must be specified.");
4915 goto out;
4916 }
4917
4918 if (filename) {
4919 in_blk = img_open(image_opts, filename, fmt, 0,
4920 false, false, force_share);
4921 if (!in_blk) {
4922 goto out;
4923 }
4924
4925 if (sn_opts) {
4926 bdrv_snapshot_load_tmp(blk_bs(in_blk),
4927 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
4928 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
4929 &local_err);
4930 } else if (snapshot_name != NULL) {
4931 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
4932 snapshot_name, &local_err);
4933 }
4934 if (local_err) {
4935 error_reportf_err(local_err, "Failed to load snapshot: ");
4936 goto out;
4937 }
4938 }
4939
4940 drv = bdrv_find_format(out_fmt);
4941 if (!drv) {
4942 error_report("Unknown file format '%s'", out_fmt);
4943 goto out;
4944 }
4945 if (!drv->create_opts) {
4946 error_report("Format driver '%s' does not support image creation",
4947 drv->format_name);
4948 goto out;
4949 }
4950
4951 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4952 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
4953 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4954 if (options) {
4955 qemu_opts_do_parse(opts, options, NULL, &local_err);
4956 if (local_err) {
4957 error_report_err(local_err);
4958 error_report("Invalid options for file format '%s'", out_fmt);
4959 goto out;
4960 }
4961 }
4962 if (img_size != UINT64_MAX) {
4963 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
4964 }
4965
4966 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
4967 if (local_err) {
4968 error_report_err(local_err);
4969 goto out;
4970 }
4971
4972 if (output_format == OFORMAT_HUMAN) {
4973 printf("required size: %" PRIu64 "\n", info->required);
4974 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
4975 } else {
4976 dump_json_block_measure_info(info);
4977 }
4978
4979 ret = 0;
4980
4981out:
4982 qapi_free_BlockMeasureInfo(info);
4983 qemu_opts_del(object_opts);
4984 qemu_opts_del(opts);
4985 qemu_opts_del(sn_opts);
4986 qemu_opts_free(create_opts);
4987 g_free(options);
4988 blk_unref(in_blk);
4989 return ret;
4990}
Kevin Wolfb6133b82014-08-05 14:17:13 +02004991
Anthony Liguoric227f092009-10-01 16:12:16 -05004992static const img_cmd_t img_cmds[] = {
Stuart Brady153859b2009-06-07 00:42:17 +01004993#define DEF(option, callback, arg_string) \
4994 { option, callback },
4995#include "qemu-img-cmds.h"
4996#undef DEF
Stuart Brady153859b2009-06-07 00:42:17 +01004997 { NULL, NULL, },
4998};
4999
bellardea2384d2004-08-01 21:59:26 +00005000int main(int argc, char **argv)
5001{
Anthony Liguoric227f092009-10-01 16:12:16 -05005002 const img_cmd_t *cmd;
Stuart Brady153859b2009-06-07 00:42:17 +01005003 const char *cmdname;
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005004 Error *local_error = NULL;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005005 char *trace_file = NULL;
Jeff Cody7db16892014-04-25 17:02:32 -04005006 int c;
Jeff Cody7db16892014-04-25 17:02:32 -04005007 static const struct option long_options[] = {
5008 {"help", no_argument, 0, 'h'},
Denis V. Lunev10985132016-06-17 17:44:13 +03005009 {"version", no_argument, 0, 'V'},
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005010 {"trace", required_argument, NULL, 'T'},
Jeff Cody7db16892014-04-25 17:02:32 -04005011 {0, 0, 0, 0}
5012 };
bellardea2384d2004-08-01 21:59:26 +00005013
MORITA Kazutaka526eda12013-07-23 17:30:11 +09005014#ifdef CONFIG_POSIX
5015 signal(SIGPIPE, SIG_IGN);
5016#endif
5017
Christophe Fergeauf5852ef2019-01-31 17:46:14 +01005018 error_init(argv[0]);
Daniel P. Berrangefe4db842016-10-04 14:35:52 +01005019 module_call_init(MODULE_INIT_TRACE);
Fam Zheng10f5bff2014-02-10 14:48:51 +08005020 qemu_init_exec_dir(argv[0]);
Kevin Wolf53f76e52010-12-16 15:10:32 +01005021
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005022 if (qemu_init_main_loop(&local_error)) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01005023 error_report_err(local_error);
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005024 exit(EXIT_FAILURE);
5025 }
5026
Eduardo Habkoste8f2d272016-05-12 11:10:04 -03005027 qcrypto_init(&error_fatal);
Daniel P. Berrangec2297082016-04-06 12:12:06 +01005028
Daniel P. Berrange064097d2016-02-10 18:41:01 +00005029 module_call_init(MODULE_INIT_QOM);
bellardea2384d2004-08-01 21:59:26 +00005030 bdrv_init();
Fam Zhengac1307a2014-04-22 13:36:11 +08005031 if (argc < 2) {
5032 error_exit("Not enough arguments");
5033 }
Stuart Brady153859b2009-06-07 00:42:17 +01005034
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00005035 qemu_add_opts(&qemu_object_opts);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00005036 qemu_add_opts(&qemu_source_opts);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005037 qemu_add_opts(&qemu_trace_opts);
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00005038
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005039 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
Denis V. Lunev10985132016-06-17 17:44:13 +03005040 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005041 case ':':
5042 missing_argument(argv[optind - 1]);
5043 return 0;
Stefan Hajnoczi4581c162017-03-17 18:45:39 +08005044 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005045 unrecognized_option(argv[optind - 1]);
5046 return 0;
5047 case 'h':
Denis V. Lunev10985132016-06-17 17:44:13 +03005048 help();
5049 return 0;
5050 case 'V':
5051 printf(QEMU_IMG_VERSION);
5052 return 0;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005053 case 'T':
5054 g_free(trace_file);
5055 trace_file = trace_opt_parse(optarg);
5056 break;
Stuart Brady153859b2009-06-07 00:42:17 +01005057 }
bellardea2384d2004-08-01 21:59:26 +00005058 }
Stuart Brady153859b2009-06-07 00:42:17 +01005059
Denis V. Lunev10985132016-06-17 17:44:13 +03005060 cmdname = argv[optind];
Jeff Cody7db16892014-04-25 17:02:32 -04005061
Denis V. Lunev10985132016-06-17 17:44:13 +03005062 /* reset getopt_long scanning */
5063 argc -= optind;
5064 if (argc < 1) {
Jeff Cody5f6979c2014-04-28 14:37:18 -04005065 return 0;
5066 }
Denis V. Lunev10985132016-06-17 17:44:13 +03005067 argv += optind;
Richard W.M. Jonesd339d762019-01-18 10:11:14 +00005068 qemu_reset_optind();
Denis V. Lunev10985132016-06-17 17:44:13 +03005069
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005070 if (!trace_init_backends()) {
5071 exit(1);
5072 }
5073 trace_init_file(trace_file);
5074 qemu_set_log(LOG_TRACE);
5075
Denis V. Lunev10985132016-06-17 17:44:13 +03005076 /* find the command */
5077 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
5078 if (!strcmp(cmdname, cmd->name)) {
5079 return cmd->handler(argc, argv);
5080 }
5081 }
Jeff Cody7db16892014-04-25 17:02:32 -04005082
Stuart Brady153859b2009-06-07 00:42:17 +01005083 /* not found */
Fam Zhengac1307a2014-04-22 13:36:11 +08005084 error_exit("Command not found: %s", cmdname);
bellardea2384d2004-08-01 21:59:26 +00005085}