blob: d9321f6418bbed6a79dd88958710f7fa91472465 [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 Armbruster0b8fa322019-05-23 16:35:07 +020041#include "qemu/module.h"
Stefano Garzarella97ede572019-05-08 12:43:24 +020042#include "qemu/units.h"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000043#include "qom/object_interfaces.h"
Paolo Bonzini9c17d612012-12-17 18:20:04 +010044#include "sysemu/sysemu.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
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000217static QemuOptsList qemu_source_opts = {
218 .name = "source",
219 .implied_opt_name = "file",
220 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
221 .desc = {
222 { }
223 },
224};
225
Stefan Weil7c30f652013-06-16 17:01:05 +0200226static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100227{
228 int ret = 0;
229 if (!quiet) {
230 va_list args;
231 va_start(args, fmt);
232 ret = vprintf(fmt, args);
233 va_end(args);
234 }
235 return ret;
236}
237
bellardea2384d2004-08-01 21:59:26 +0000238
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100239static int print_block_option_help(const char *filename, const char *fmt)
240{
241 BlockDriver *drv, *proto_drv;
Chunyan Liu83d05212014-06-05 17:20:51 +0800242 QemuOptsList *create_opts = NULL;
Max Reitzb65a5e12015-02-05 13:58:12 -0500243 Error *local_err = NULL;
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100244
245 /* Find driver and parse its options */
246 drv = bdrv_find_format(fmt);
247 if (!drv) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100248 error_report("Unknown file format '%s'", fmt);
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100249 return 1;
250 }
251
Max Reitzd402b6a2018-05-09 23:00:21 +0200252 if (!drv->create_opts) {
253 error_report("Format driver '%s' does not support image creation", fmt);
254 return 1;
255 }
256
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800257 create_opts = qemu_opts_append(create_opts, drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100258 if (filename) {
Max Reitzb65a5e12015-02-05 13:58:12 -0500259 proto_drv = bdrv_find_protocol(filename, true, &local_err);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100260 if (!proto_drv) {
Markus Armbruster2867ce42015-03-12 16:08:02 +0100261 error_report_err(local_err);
Chunyan Liu83d05212014-06-05 17:20:51 +0800262 qemu_opts_free(create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100263 return 1;
264 }
Max Reitzd402b6a2018-05-09 23:00:21 +0200265 if (!proto_drv->create_opts) {
Max Reitzf0998872018-11-19 11:19:20 +0100266 error_report("Protocol driver '%s' does not support image creation",
Max Reitzd402b6a2018-05-09 23:00:21 +0200267 proto_drv->format_name);
Max Reitz3ecd5a42018-11-19 11:19:21 +0100268 qemu_opts_free(create_opts);
Max Reitzd402b6a2018-05-09 23:00:21 +0200269 return 1;
270 }
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800271 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100272 }
273
Max Reitzf4619af2019-04-13 17:20:37 +0200274 if (filename) {
275 printf("Supported options:\n");
276 } else {
277 printf("Supported %s options:\n", fmt);
278 }
Max Reitz63898712018-10-19 18:49:25 +0200279 qemu_opts_print_help(create_opts, false);
Chunyan Liu83d05212014-06-05 17:20:51 +0800280 qemu_opts_free(create_opts);
Max Reitzf4619af2019-04-13 17:20:37 +0200281
282 if (!filename) {
283 printf("\n"
284 "The protocol level may support further options.\n"
285 "Specify the target filename to include those options.\n");
286 }
287
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100288 return 0;
289}
290
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000291
Max Reitzefaa7c42016-03-16 19:54:38 +0100292static BlockBackend *img_open_opts(const char *optstr,
Kevin Wolfce099542016-03-15 13:01:04 +0100293 QemuOpts *opts, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800294 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000295{
296 QDict *options;
297 Error *local_err = NULL;
298 BlockBackend *blk;
299 options = qemu_opts_to_qdict(opts, NULL);
Fam Zheng335e9932017-05-03 00:35:39 +0800300 if (force_share) {
301 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
Max Reitz4615f872018-05-02 22:20:50 +0200302 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
Fam Zheng335e9932017-05-03 00:35:39 +0800303 error_report("--force-share/-U conflicts with image options");
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200304 qobject_unref(options);
Fam Zheng335e9932017-05-03 00:35:39 +0800305 return NULL;
306 }
Max Reitz4615f872018-05-02 22:20:50 +0200307 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
Fam Zheng335e9932017-05-03 00:35:39 +0800308 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100309 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000310 if (!blk) {
Daniel P. Berrange143605a2016-04-06 10:16:18 +0100311 error_reportf_err(local_err, "Could not open '%s': ", optstr);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000312 return NULL;
313 }
Kevin Wolfce099542016-03-15 13:01:04 +0100314 blk_set_enable_write_cache(blk, !writethrough);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000315
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000316 return blk;
317}
318
Max Reitzefaa7c42016-03-16 19:54:38 +0100319static BlockBackend *img_open_file(const char *filename,
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100320 QDict *options,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000321 const char *fmt, int flags,
Fam Zheng335e9932017-05-03 00:35:39 +0800322 bool writethrough, bool quiet,
323 bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000324{
325 BlockBackend *blk;
Max Reitz34b5d2c2013-09-05 14:45:29 +0200326 Error *local_err = NULL;
Kevin Wolfad717132010-12-16 15:37:41 +0100327
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100328 if (!options) {
329 options = qdict_new();
330 }
bellard75c23802004-08-27 21:28:58 +0000331 if (fmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -0500332 qdict_put_str(options, "driver", fmt);
bellard75c23802004-08-27 21:28:58 +0000333 }
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100334
Fam Zheng335e9932017-05-03 00:35:39 +0800335 if (force_share) {
Eric Blake579cf1d2017-05-15 14:54:39 -0500336 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Fam Zheng335e9932017-05-03 00:35:39 +0800337 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100338 blk = blk_new_open(filename, NULL, options, flags, &local_err);
Max Reitz5bd31322015-02-05 13:58:16 -0500339 if (!blk) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100340 error_reportf_err(local_err, "Could not open '%s': ", filename);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000341 return NULL;
bellard75c23802004-08-27 21:28:58 +0000342 }
Kevin Wolfce099542016-03-15 13:01:04 +0100343 blk_set_enable_write_cache(blk, !writethrough);
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100344
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200345 return blk;
bellard75c23802004-08-27 21:28:58 +0000346}
347
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000348
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100349static int img_add_key_secrets(void *opaque,
350 const char *name, const char *value,
351 Error **errp)
352{
353 QDict *options = opaque;
354
355 if (g_str_has_suffix(name, "key-secret")) {
Eric Blake187f47e2017-06-24 12:10:07 -0600356 qdict_put_str(options, name, value);
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100357 }
358
359 return 0;
360}
361
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100362
Max Reitzefaa7c42016-03-16 19:54:38 +0100363static BlockBackend *img_open(bool image_opts,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000364 const char *filename,
Kevin Wolfce099542016-03-15 13:01:04 +0100365 const char *fmt, int flags, bool writethrough,
Fam Zheng335e9932017-05-03 00:35:39 +0800366 bool quiet, bool force_share)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000367{
368 BlockBackend *blk;
369 if (image_opts) {
370 QemuOpts *opts;
371 if (fmt) {
372 error_report("--image-opts and --format are mutually exclusive");
373 return NULL;
374 }
375 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
376 filename, true);
377 if (!opts) {
378 return NULL;
379 }
Fam Zheng335e9932017-05-03 00:35:39 +0800380 blk = img_open_opts(filename, opts, flags, writethrough, quiet,
381 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000382 } else {
Daniel P. Berrange29cf9332017-05-15 17:47:12 +0100383 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
Fam Zheng335e9932017-05-03 00:35:39 +0800384 force_share);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000385 }
386 return blk;
387}
388
389
Chunyan Liu83d05212014-06-05 17:20:51 +0800390static int add_old_style_options(const char *fmt, QemuOpts *opts,
Jes Sorenseneec77d92010-12-07 17:44:34 +0100391 const char *base_filename,
392 const char *base_fmt)
Kevin Wolfefa84d42009-05-18 16:42:12 +0200393{
Markus Armbruster6750e792015-02-12 17:43:08 +0100394 Error *err = NULL;
395
Kevin Wolfefa84d42009-05-18 16:42:12 +0200396 if (base_filename) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100397 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +0100398 if (err) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100399 error_report("Backing file not supported for file format '%s'",
400 fmt);
Markus Armbruster6750e792015-02-12 17:43:08 +0100401 error_free(err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900402 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200403 }
404 }
405 if (base_fmt) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100406 qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +0100407 if (err) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100408 error_report("Backing file format not supported for file "
409 "format '%s'", fmt);
Markus Armbruster6750e792015-02-12 17:43:08 +0100410 error_free(err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900411 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200412 }
413 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900414 return 0;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200415}
416
Markus Armbruster606caa02017-02-21 21:14:04 +0100417static int64_t cvtnum(const char *s)
418{
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100419 int err;
Markus Armbrusterf46bfdb2017-02-21 21:14:07 +0100420 uint64_t value;
Markus Armbruster606caa02017-02-21 21:14:04 +0100421
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100422 err = qemu_strtosz(s, NULL, &value);
423 if (err < 0) {
424 return err;
425 }
Markus Armbrusterf46bfdb2017-02-21 21:14:07 +0100426 if (value > INT64_MAX) {
427 return -ERANGE;
428 }
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100429 return value;
Markus Armbruster606caa02017-02-21 21:14:04 +0100430}
431
bellardea2384d2004-08-01 21:59:26 +0000432static int img_create(int argc, char **argv)
433{
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200434 int c;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100435 uint64_t img_size = -1;
bellardea2384d2004-08-01 21:59:26 +0000436 const char *fmt = "raw";
aliguori9230eaf2009-03-28 17:55:19 +0000437 const char *base_fmt = NULL;
bellardea2384d2004-08-01 21:59:26 +0000438 const char *filename;
439 const char *base_filename = NULL;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200440 char *options = NULL;
Luiz Capitulino9b375252012-11-30 10:52:05 -0200441 Error *local_err = NULL;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100442 bool quiet = false;
John Snow6e6e55f2017-07-17 20:34:22 -0400443 int flags = 0;
ths3b46e622007-09-17 08:09:54 +0000444
bellardea2384d2004-08-01 21:59:26 +0000445 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000446 static const struct option long_options[] = {
447 {"help", no_argument, 0, 'h'},
448 {"object", required_argument, 0, OPTION_OBJECT},
449 {0, 0, 0, 0}
450 };
John Snow6e6e55f2017-07-17 20:34:22 -0400451 c = getopt_long(argc, argv, ":F:b:f:ho:qu",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000452 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100453 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000454 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100455 }
bellardea2384d2004-08-01 21:59:26 +0000456 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800457 case ':':
458 missing_argument(argv[optind - 1]);
459 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100460 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800461 unrecognized_option(argv[optind - 1]);
462 break;
bellardea2384d2004-08-01 21:59:26 +0000463 case 'h':
464 help();
465 break;
aliguori9230eaf2009-03-28 17:55:19 +0000466 case 'F':
467 base_fmt = optarg;
468 break;
bellardea2384d2004-08-01 21:59:26 +0000469 case 'b':
470 base_filename = optarg;
471 break;
472 case 'f':
473 fmt = optarg;
474 break;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200475 case 'o':
Kevin Wolf77386bf2014-02-21 16:24:04 +0100476 if (!is_valid_option_list(optarg)) {
477 error_report("Invalid option list: %s", optarg);
478 goto fail;
479 }
480 if (!options) {
481 options = g_strdup(optarg);
482 } else {
483 char *old_options = options;
484 options = g_strdup_printf("%s,%s", options, optarg);
485 g_free(old_options);
486 }
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200487 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100488 case 'q':
489 quiet = true;
490 break;
John Snow6e6e55f2017-07-17 20:34:22 -0400491 case 'u':
492 flags |= BDRV_O_NO_BACKING;
493 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000494 case OPTION_OBJECT: {
495 QemuOpts *opts;
496 opts = qemu_opts_parse_noisily(&qemu_object_opts,
497 optarg, true);
498 if (!opts) {
499 goto fail;
500 }
501 } break;
bellardea2384d2004-08-01 21:59:26 +0000502 }
503 }
aliguori9230eaf2009-03-28 17:55:19 +0000504
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900505 /* Get the filename */
Kevin Wolfa283cb62014-02-21 16:24:07 +0100506 filename = (optind < argc) ? argv[optind] : NULL;
507 if (options && has_help_option(options)) {
508 g_free(options);
509 return print_block_option_help(filename, fmt);
510 }
511
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100512 if (optind >= argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800513 error_exit("Expecting image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100514 }
Kevin Wolfa283cb62014-02-21 16:24:07 +0100515 optind++;
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900516
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000517 if (qemu_opts_foreach(&qemu_object_opts,
518 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +0000519 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000520 goto fail;
521 }
522
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100523 /* Get image size, if specified */
524 if (optind < argc) {
Jes Sorensen70b4f4b2011-01-05 11:41:02 +0100525 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +0100526
527 sval = cvtnum(argv[optind++]);
528 if (sval < 0) {
liguang79443392012-12-17 09:49:23 +0800529 if (sval == -ERANGE) {
530 error_report("Image size must be less than 8 EiB!");
531 } else {
532 error_report("Invalid image size specified! You may use k, M, "
Kevin Wolf5e009842013-06-05 14:19:27 +0200533 "G, T, P or E suffixes for ");
534 error_report("kilobytes, megabytes, gigabytes, terabytes, "
535 "petabytes and exabytes.");
liguang79443392012-12-17 09:49:23 +0800536 }
Kevin Wolf77386bf2014-02-21 16:24:04 +0100537 goto fail;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100538 }
539 img_size = (uint64_t)sval;
540 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200541 if (optind != argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800542 error_exit("Unexpected argument: %s", argv[optind]);
Kevin Wolffc11eb22013-08-05 10:53:04 +0200543 }
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100544
Luiz Capitulino9b375252012-11-30 10:52:05 -0200545 bdrv_img_create(filename, fmt, base_filename, base_fmt,
John Snow6e6e55f2017-07-17 20:34:22 -0400546 options, img_size, flags, quiet, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100547 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100548 error_reportf_err(local_err, "%s: ", filename);
Kevin Wolf77386bf2014-02-21 16:24:04 +0100549 goto fail;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900550 }
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200551
Kevin Wolf77386bf2014-02-21 16:24:04 +0100552 g_free(options);
bellardea2384d2004-08-01 21:59:26 +0000553 return 0;
Kevin Wolf77386bf2014-02-21 16:24:04 +0100554
555fail:
556 g_free(options);
557 return 1;
bellardea2384d2004-08-01 21:59:26 +0000558}
559
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100560static void dump_json_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500561{
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500562 QString *str;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500563 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +0100564 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600565
566 visit_type_ImageCheck(v, NULL, &check, &error_abort);
567 visit_complete(v, &obj);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500568 str = qobject_to_json_pretty(obj);
569 assert(str != NULL);
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100570 qprintf(quiet, "%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200571 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600572 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200573 qobject_unref(str);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500574}
575
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100576static void dump_human_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500577{
578 if (!(check->corruptions || check->leaks || check->check_errors)) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100579 qprintf(quiet, "No errors were found on the image.\n");
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500580 } else {
581 if (check->corruptions) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100582 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
583 "Data may be corrupted, or further writes to the image "
584 "may corrupt it.\n",
585 check->corruptions);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500586 }
587
588 if (check->leaks) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100589 qprintf(quiet,
590 "\n%" PRId64 " leaked clusters were found on the image.\n"
591 "This means waste of disk space, but no harm to data.\n",
592 check->leaks);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500593 }
594
595 if (check->check_errors) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100596 qprintf(quiet,
597 "\n%" PRId64
598 " internal errors have occurred during the check.\n",
599 check->check_errors);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500600 }
601 }
602
603 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100604 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
605 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
606 check->allocated_clusters, check->total_clusters,
607 check->allocated_clusters * 100.0 / check->total_clusters,
608 check->fragmented_clusters * 100.0 / check->allocated_clusters,
609 check->compressed_clusters * 100.0 /
610 check->allocated_clusters);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500611 }
612
613 if (check->image_end_offset) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100614 qprintf(quiet,
615 "Image end offset: %" PRId64 "\n", check->image_end_offset);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500616 }
617}
618
619static int collect_image_check(BlockDriverState *bs,
620 ImageCheck *check,
621 const char *filename,
622 const char *fmt,
623 int fix)
624{
625 int ret;
626 BdrvCheckResult result;
627
628 ret = bdrv_check(bs, &result, fix);
629 if (ret < 0) {
630 return ret;
631 }
632
633 check->filename = g_strdup(filename);
634 check->format = g_strdup(bdrv_get_format_name(bs));
635 check->check_errors = result.check_errors;
636 check->corruptions = result.corruptions;
637 check->has_corruptions = result.corruptions != 0;
638 check->leaks = result.leaks;
639 check->has_leaks = result.leaks != 0;
640 check->corruptions_fixed = result.corruptions_fixed;
641 check->has_corruptions_fixed = result.corruptions != 0;
642 check->leaks_fixed = result.leaks_fixed;
643 check->has_leaks_fixed = result.leaks != 0;
644 check->image_end_offset = result.image_end_offset;
645 check->has_image_end_offset = result.image_end_offset != 0;
646 check->total_clusters = result.bfi.total_clusters;
647 check->has_total_clusters = result.bfi.total_clusters != 0;
648 check->allocated_clusters = result.bfi.allocated_clusters;
649 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
650 check->fragmented_clusters = result.bfi.fragmented_clusters;
651 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
Stefan Hajnoczie6439d72013-02-07 17:15:04 +0100652 check->compressed_clusters = result.bfi.compressed_clusters;
653 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500654
655 return 0;
656}
657
Kevin Wolfe076f332010-06-29 11:43:13 +0200658/*
659 * Checks an image for consistency. Exit codes:
660 *
Max Reitzd6635c42014-06-02 22:15:21 +0200661 * 0 - Check completed, image is good
662 * 1 - Check not completed because of internal errors
663 * 2 - Check completed, image is corrupted
664 * 3 - Check completed, image has leaked clusters, but is good otherwise
665 * 63 - Checks are not supported by the image format
Kevin Wolfe076f332010-06-29 11:43:13 +0200666 */
aliguori15859692009-04-21 23:11:53 +0000667static int img_check(int argc, char **argv)
668{
669 int c, ret;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500670 OutputFormat output_format = OFORMAT_HUMAN;
Max Reitz40055952014-07-22 22:58:42 +0200671 const char *filename, *fmt, *output, *cache;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200672 BlockBackend *blk;
aliguori15859692009-04-21 23:11:53 +0000673 BlockDriverState *bs;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200674 int fix = 0;
Kevin Wolfce099542016-03-15 13:01:04 +0100675 int flags = BDRV_O_CHECK;
676 bool writethrough;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200677 ImageCheck *check;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100678 bool quiet = false;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000679 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +0800680 bool force_share = false;
aliguori15859692009-04-21 23:11:53 +0000681
682 fmt = NULL;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500683 output = NULL;
Max Reitz40055952014-07-22 22:58:42 +0200684 cache = BDRV_DEFAULT_CACHE;
Kevin Wolfce099542016-03-15 13:01:04 +0100685
aliguori15859692009-04-21 23:11:53 +0000686 for(;;) {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500687 int option_index = 0;
688 static const struct option long_options[] = {
689 {"help", no_argument, 0, 'h'},
690 {"format", required_argument, 0, 'f'},
Prasad Joshi4fd6a982014-03-25 00:08:54 +0530691 {"repair", required_argument, 0, 'r'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500692 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000693 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000694 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +0800695 {"force-share", no_argument, 0, 'U'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500696 {0, 0, 0, 0}
697 };
Fam Zheng335e9932017-05-03 00:35:39 +0800698 c = getopt_long(argc, argv, ":hf:r:T:qU",
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500699 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100700 if (c == -1) {
aliguori15859692009-04-21 23:11:53 +0000701 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100702 }
aliguori15859692009-04-21 23:11:53 +0000703 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800704 case ':':
705 missing_argument(argv[optind - 1]);
706 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100707 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800708 unrecognized_option(argv[optind - 1]);
709 break;
aliguori15859692009-04-21 23:11:53 +0000710 case 'h':
711 help();
712 break;
713 case 'f':
714 fmt = optarg;
715 break;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200716 case 'r':
717 flags |= BDRV_O_RDWR;
718
719 if (!strcmp(optarg, "leaks")) {
720 fix = BDRV_FIX_LEAKS;
721 } else if (!strcmp(optarg, "all")) {
722 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
723 } else {
Fam Zhengac1307a2014-04-22 13:36:11 +0800724 error_exit("Unknown option value for -r "
725 "(expecting 'leaks' or 'all'): %s", optarg);
Kevin Wolf4534ff52012-05-11 16:07:02 +0200726 }
727 break;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500728 case OPTION_OUTPUT:
729 output = optarg;
730 break;
Max Reitz40055952014-07-22 22:58:42 +0200731 case 'T':
732 cache = optarg;
733 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100734 case 'q':
735 quiet = true;
736 break;
Fam Zheng335e9932017-05-03 00:35:39 +0800737 case 'U':
738 force_share = true;
739 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000740 case OPTION_OBJECT: {
741 QemuOpts *opts;
742 opts = qemu_opts_parse_noisily(&qemu_object_opts,
743 optarg, true);
744 if (!opts) {
745 return 1;
746 }
747 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000748 case OPTION_IMAGE_OPTS:
749 image_opts = true;
750 break;
aliguori15859692009-04-21 23:11:53 +0000751 }
752 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200753 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800754 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100755 }
aliguori15859692009-04-21 23:11:53 +0000756 filename = argv[optind++];
757
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500758 if (output && !strcmp(output, "json")) {
759 output_format = OFORMAT_JSON;
760 } else if (output && !strcmp(output, "human")) {
761 output_format = OFORMAT_HUMAN;
762 } else if (output) {
763 error_report("--output must be used with human or json as argument.");
764 return 1;
765 }
766
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000767 if (qemu_opts_foreach(&qemu_object_opts,
768 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +0000769 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000770 return 1;
771 }
772
Kevin Wolfce099542016-03-15 13:01:04 +0100773 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +0200774 if (ret < 0) {
775 error_report("Invalid source cache option: %s", cache);
776 return 1;
777 }
778
Fam Zheng335e9932017-05-03 00:35:39 +0800779 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
780 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200781 if (!blk) {
782 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900783 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200784 bs = blk_bs(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500785
786 check = g_new0(ImageCheck, 1);
787 ret = collect_image_check(bs, check, filename, fmt, fix);
Kevin Wolfe076f332010-06-29 11:43:13 +0200788
789 if (ret == -ENOTSUP) {
Max Reitz55d492d2014-05-31 21:33:30 +0200790 error_report("This image format does not support checks");
Peter Lievenfefddf92013-10-24 08:53:34 +0200791 ret = 63;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500792 goto fail;
Kevin Wolfe076f332010-06-29 11:43:13 +0200793 }
794
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500795 if (check->corruptions_fixed || check->leaks_fixed) {
796 int corruptions_fixed, leaks_fixed;
797
798 leaks_fixed = check->leaks_fixed;
799 corruptions_fixed = check->corruptions_fixed;
800
801 if (output_format == OFORMAT_HUMAN) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100802 qprintf(quiet,
803 "The following inconsistencies were found and repaired:\n\n"
804 " %" PRId64 " leaked clusters\n"
805 " %" PRId64 " corruptions\n\n"
806 "Double checking the fixed image now...\n",
807 check->leaks_fixed,
808 check->corruptions_fixed);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500809 }
810
811 ret = collect_image_check(bs, check, filename, fmt, 0);
812
813 check->leaks_fixed = leaks_fixed;
814 check->corruptions_fixed = corruptions_fixed;
Kevin Wolfccf34712012-05-11 18:16:54 +0200815 }
816
Max Reitz832390a2014-10-23 15:29:12 +0200817 if (!ret) {
818 switch (output_format) {
819 case OFORMAT_HUMAN:
820 dump_human_image_check(check, quiet);
821 break;
822 case OFORMAT_JSON:
823 dump_json_image_check(check, quiet);
824 break;
825 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500826 }
827
828 if (ret || check->check_errors) {
Max Reitz832390a2014-10-23 15:29:12 +0200829 if (ret) {
830 error_report("Check failed: %s", strerror(-ret));
831 } else {
832 error_report("Check failed");
833 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500834 ret = 1;
835 goto fail;
836 }
837
838 if (check->corruptions) {
839 ret = 2;
840 } else if (check->leaks) {
841 ret = 3;
Kevin Wolfe076f332010-06-29 11:43:13 +0200842 } else {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500843 ret = 0;
aliguori15859692009-04-21 23:11:53 +0000844 }
845
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500846fail:
847 qapi_free_ImageCheck(check);
Markus Armbruster26f54e92014-10-07 13:59:04 +0200848 blk_unref(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500849 return ret;
aliguori15859692009-04-21 23:11:53 +0000850}
851
Max Reitzd4a32382014-10-24 15:57:37 +0200852typedef struct CommonBlockJobCBInfo {
853 BlockDriverState *bs;
854 Error **errp;
855} CommonBlockJobCBInfo;
856
857static void common_block_job_cb(void *opaque, int ret)
858{
859 CommonBlockJobCBInfo *cbi = opaque;
860
861 if (ret < 0) {
862 error_setg_errno(cbi->errp, -ret, "Block job failed");
863 }
Max Reitzd4a32382014-10-24 15:57:37 +0200864}
865
866static void run_block_job(BlockJob *job, Error **errp)
867{
Kevin Wolfb75536c2016-04-18 17:30:17 +0200868 AioContext *aio_context = blk_get_aio_context(job->blk);
sochin.jiang4172a002017-06-15 14:47:33 +0800869 int ret = 0;
Max Reitzd4a32382014-10-24 15:57:37 +0200870
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200871 aio_context_acquire(aio_context);
Kevin Wolf80fa2c72018-04-13 18:50:05 +0200872 job_ref(&job->job);
Max Reitzd4a32382014-10-24 15:57:37 +0200873 do {
Kevin Wolf30a5c882018-05-04 12:17:20 +0200874 float progress = 0.0f;
Max Reitzd4a32382014-10-24 15:57:37 +0200875 aio_poll(aio_context, true);
Kevin Wolf30a5c882018-05-04 12:17:20 +0200876 if (job->job.progress_total) {
877 progress = (float)job->job.progress_current /
878 job->job.progress_total * 100.f;
879 }
880 qemu_progress_print(progress, 0);
Kevin Wolfdf956ae2018-04-25 15:09:58 +0200881 } while (!job_is_ready(&job->job) && !job_is_completed(&job->job));
Max Reitzd4a32382014-10-24 15:57:37 +0200882
Kevin Wolfdbe5e6c2018-04-19 13:04:01 +0200883 if (!job_is_completed(&job->job)) {
Kevin Wolf3d70ff52018-04-24 16:13:52 +0200884 ret = job_complete_sync(&job->job, errp);
sochin.jiang4172a002017-06-15 14:47:33 +0800885 } else {
Kevin Wolf4ad35182018-04-19 17:30:16 +0200886 ret = job->job.ret;
sochin.jiang4172a002017-06-15 14:47:33 +0800887 }
Kevin Wolf80fa2c72018-04-13 18:50:05 +0200888 job_unref(&job->job);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200889 aio_context_release(aio_context);
Max Reitz687fa1d2014-10-24 15:57:39 +0200890
sochin.jiang4172a002017-06-15 14:47:33 +0800891 /* publish completion progress only when success */
892 if (!ret) {
893 qemu_progress_print(100.f, 0);
894 }
Max Reitzd4a32382014-10-24 15:57:37 +0200895}
896
bellardea2384d2004-08-01 21:59:26 +0000897static int img_commit(int argc, char **argv)
898{
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400899 int c, ret, flags;
Max Reitz1b22bff2014-10-24 15:57:40 +0200900 const char *filename, *fmt, *cache, *base;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200901 BlockBackend *blk;
Max Reitzd4a32382014-10-24 15:57:37 +0200902 BlockDriverState *bs, *base_bs;
Kevin Wolf4ef85a92017-01-25 19:16:34 +0100903 BlockJob *job;
Max Reitz687fa1d2014-10-24 15:57:39 +0200904 bool progress = false, quiet = false, drop = false;
Kevin Wolfce099542016-03-15 13:01:04 +0100905 bool writethrough;
Max Reitzd4a32382014-10-24 15:57:37 +0200906 Error *local_err = NULL;
907 CommonBlockJobCBInfo cbi;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000908 bool image_opts = false;
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200909 AioContext *aio_context;
bellardea2384d2004-08-01 21:59:26 +0000910
911 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400912 cache = BDRV_DEFAULT_CACHE;
Max Reitz1b22bff2014-10-24 15:57:40 +0200913 base = NULL;
bellardea2384d2004-08-01 21:59:26 +0000914 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000915 static const struct option long_options[] = {
916 {"help", no_argument, 0, 'h'},
917 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000918 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000919 {0, 0, 0, 0}
920 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800921 c = getopt_long(argc, argv, ":f:ht:b:dpq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000922 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100923 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000924 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100925 }
bellardea2384d2004-08-01 21:59:26 +0000926 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800927 case ':':
928 missing_argument(argv[optind - 1]);
929 break;
Jes Sorensenef873942010-12-06 15:25:40 +0100930 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +0800931 unrecognized_option(argv[optind - 1]);
932 break;
bellardea2384d2004-08-01 21:59:26 +0000933 case 'h':
934 help();
935 break;
936 case 'f':
937 fmt = optarg;
938 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400939 case 't':
940 cache = optarg;
941 break;
Max Reitz1b22bff2014-10-24 15:57:40 +0200942 case 'b':
943 base = optarg;
944 /* -b implies -d */
945 drop = true;
946 break;
Max Reitz9a86fe42014-10-24 15:57:38 +0200947 case 'd':
948 drop = true;
949 break;
Max Reitz687fa1d2014-10-24 15:57:39 +0200950 case 'p':
951 progress = true;
952 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100953 case 'q':
954 quiet = true;
955 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000956 case OPTION_OBJECT: {
957 QemuOpts *opts;
958 opts = qemu_opts_parse_noisily(&qemu_object_opts,
959 optarg, true);
960 if (!opts) {
961 return 1;
962 }
963 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000964 case OPTION_IMAGE_OPTS:
965 image_opts = true;
966 break;
bellardea2384d2004-08-01 21:59:26 +0000967 }
968 }
Max Reitz687fa1d2014-10-24 15:57:39 +0200969
970 /* Progress is not shown in Quiet mode */
971 if (quiet) {
972 progress = false;
973 }
974
Kevin Wolffc11eb22013-08-05 10:53:04 +0200975 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800976 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100977 }
bellardea2384d2004-08-01 21:59:26 +0000978 filename = argv[optind++];
979
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000980 if (qemu_opts_foreach(&qemu_object_opts,
981 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +0000982 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000983 return 1;
984 }
985
Max Reitz9a86fe42014-10-24 15:57:38 +0200986 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
Kevin Wolfce099542016-03-15 13:01:04 +0100987 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400988 if (ret < 0) {
989 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczia3981eb2014-08-26 19:17:54 +0100990 return 1;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400991 }
992
Fam Zheng335e9932017-05-03 00:35:39 +0800993 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
994 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200995 if (!blk) {
996 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900997 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200998 bs = blk_bs(blk);
999
Max Reitz687fa1d2014-10-24 15:57:39 +02001000 qemu_progress_init(progress, 1.f);
1001 qemu_progress_print(0.f, 100);
1002
Max Reitz1b22bff2014-10-24 15:57:40 +02001003 if (base) {
1004 base_bs = bdrv_find_backing_image(bs, base);
1005 if (!base_bs) {
Max Reitz6b33f3a2016-12-01 03:05:08 +01001006 error_setg(&local_err,
1007 "Did not find '%s' in the backing chain of '%s'",
1008 base, filename);
Max Reitz1b22bff2014-10-24 15:57:40 +02001009 goto done;
1010 }
1011 } else {
1012 /* This is different from QMP, which by default uses the deepest file in
1013 * the backing chain (i.e., the very base); however, the traditional
1014 * behavior of qemu-img commit is using the immediate backing file. */
Kevin Wolf760e0062015-06-17 14:55:21 +02001015 base_bs = backing_bs(bs);
Max Reitz1b22bff2014-10-24 15:57:40 +02001016 if (!base_bs) {
1017 error_setg(&local_err, "Image does not have a backing file");
1018 goto done;
1019 }
bellardea2384d2004-08-01 21:59:26 +00001020 }
1021
Max Reitzd4a32382014-10-24 15:57:37 +02001022 cbi = (CommonBlockJobCBInfo){
1023 .errp = &local_err,
1024 .bs = bs,
1025 };
1026
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001027 aio_context = bdrv_get_aio_context(bs);
1028 aio_context_acquire(aio_context);
Kevin Wolfbb02b652018-04-19 17:54:56 +02001029 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, 0,
Kevin Wolf0db832f2017-02-20 18:10:05 +01001030 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
Fam Zheng78bbd912017-04-21 20:27:04 +08001031 &cbi, false, &local_err);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +02001032 aio_context_release(aio_context);
Max Reitzd4a32382014-10-24 15:57:37 +02001033 if (local_err) {
1034 goto done;
1035 }
1036
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001037 /* When the block job completes, the BlockBackend reference will point to
1038 * the old backing file. In order to avoid that the top image is already
1039 * deleted, so we can still empty it afterwards, increment the reference
1040 * counter here preemptively. */
Max Reitz9a86fe42014-10-24 15:57:38 +02001041 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001042 bdrv_ref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001043 }
1044
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001045 job = block_job_get("commit");
Liam Merwick2e2db262018-11-05 21:38:37 +00001046 assert(job);
Kevin Wolf4ef85a92017-01-25 19:16:34 +01001047 run_block_job(job, &local_err);
Max Reitz9a86fe42014-10-24 15:57:38 +02001048 if (local_err) {
1049 goto unref_backing;
1050 }
1051
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001052 if (!drop && bs->drv->bdrv_make_empty) {
1053 ret = bs->drv->bdrv_make_empty(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001054 if (ret) {
1055 error_setg_errno(&local_err, -ret, "Could not empty %s",
1056 filename);
1057 goto unref_backing;
1058 }
1059 }
1060
1061unref_backing:
1062 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +02001063 bdrv_unref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +02001064 }
Max Reitzd4a32382014-10-24 15:57:37 +02001065
1066done:
Max Reitz687fa1d2014-10-24 15:57:39 +02001067 qemu_progress_end();
1068
Markus Armbruster26f54e92014-10-07 13:59:04 +02001069 blk_unref(blk);
Max Reitzd4a32382014-10-24 15:57:37 +02001070
1071 if (local_err) {
Markus Armbruster6936f292015-02-10 15:14:02 +01001072 error_report_err(local_err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001073 return 1;
1074 }
Max Reitzd4a32382014-10-24 15:57:37 +02001075
1076 qprintf(quiet, "Image committed.\n");
bellardea2384d2004-08-01 21:59:26 +00001077 return 0;
1078}
1079
Dmitry Konishchevf6a00aa2011-05-18 15:03:59 +04001080/*
Eric Blakedebb38a2017-10-11 22:47:11 -05001081 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1082 * of the first sector boundary within buf where the sector contains a
1083 * non-zero byte. This function is robust to a buffer that is not
1084 * sector-aligned.
1085 */
1086static int64_t find_nonzero(const uint8_t *buf, int64_t n)
1087{
1088 int64_t i;
1089 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);
1090
1091 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
1092 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
1093 return i;
1094 }
1095 }
1096 if (i < n && !buffer_is_zero(buf + i, n - end)) {
1097 return i;
1098 }
1099 return -1;
1100}
1101
1102/*
thsf58c7b32008-06-05 21:53:49 +00001103 * Returns true iff the first sector pointed to by 'buf' contains at least
1104 * a non-NUL byte.
1105 *
1106 * 'pnum' is set to the number of sectors (including and immediately following
1107 * the first one) that are known to be in the same allocated/unallocated state.
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001108 * The function will try to align the end offset to alignment boundaries so
1109 * that the request will at least end aligned and consequtive requests will
1110 * also start at an aligned offset.
thsf58c7b32008-06-05 21:53:49 +00001111 */
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001112static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
1113 int64_t sector_num, int alignment)
bellardea2384d2004-08-01 21:59:26 +00001114{
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001115 bool is_zero;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001116 int i, tail;
bellardea2384d2004-08-01 21:59:26 +00001117
1118 if (n <= 0) {
1119 *pnum = 0;
1120 return 0;
1121 }
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001122 is_zero = buffer_is_zero(buf, 512);
bellardea2384d2004-08-01 21:59:26 +00001123 for(i = 1; i < n; i++) {
1124 buf += 512;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001125 if (is_zero != buffer_is_zero(buf, 512)) {
bellardea2384d2004-08-01 21:59:26 +00001126 break;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001127 }
bellardea2384d2004-08-01 21:59:26 +00001128 }
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001129
1130 tail = (sector_num + i) & (alignment - 1);
1131 if (tail) {
1132 if (is_zero && i <= tail) {
1133 /* treat unallocated areas which only consist
1134 * of a small tail as allocated. */
1135 is_zero = false;
1136 }
1137 if (!is_zero) {
1138 /* align up end offset of allocated areas. */
1139 i += alignment - tail;
1140 i = MIN(i, n);
1141 } else {
1142 /* align down end offset of zero areas. */
1143 i -= tail;
1144 }
1145 }
bellardea2384d2004-08-01 21:59:26 +00001146 *pnum = i;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001147 return !is_zero;
bellardea2384d2004-08-01 21:59:26 +00001148}
1149
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001150/*
Kevin Wolfa22f1232011-08-26 15:27:13 +02001151 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1152 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1153 * breaking up write requests for only small sparse areas.
1154 */
1155static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001156 int min, int64_t sector_num, int alignment)
Kevin Wolfa22f1232011-08-26 15:27:13 +02001157{
1158 int ret;
1159 int num_checked, num_used;
1160
1161 if (n < min) {
1162 min = n;
1163 }
1164
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001165 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001166 if (!ret) {
1167 return ret;
1168 }
1169
1170 num_used = *pnum;
1171 buf += BDRV_SECTOR_SIZE * *pnum;
1172 n -= *pnum;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001173 sector_num += *pnum;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001174 num_checked = num_used;
1175
1176 while (n > 0) {
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001177 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
Kevin Wolfa22f1232011-08-26 15:27:13 +02001178
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 += *pnum;
1183 if (ret) {
1184 num_used = num_checked;
1185 } else if (*pnum >= min) {
1186 break;
1187 }
1188 }
1189
1190 *pnum = num_used;
1191 return 1;
1192}
1193
1194/*
Eric Blakedc61cd32017-10-11 22:47:14 -05001195 * Compares two buffers sector by sector. Returns 0 if the first
1196 * sector of each buffer matches, non-zero otherwise.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001197 *
Eric Blakedc61cd32017-10-11 22:47:14 -05001198 * pnum is set to the sector-aligned size of the buffer prefix that
1199 * has the same matching status as the first sector.
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001200 */
Eric Blakedc61cd32017-10-11 22:47:14 -05001201static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
1202 int64_t bytes, int64_t *pnum)
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001203{
Radim Krčmář8c1ac472015-02-20 17:06:15 +01001204 bool res;
Eric Blakedc61cd32017-10-11 22:47:14 -05001205 int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001206
Eric Blakedc61cd32017-10-11 22:47:14 -05001207 assert(bytes > 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001208
Eric Blakedc61cd32017-10-11 22:47:14 -05001209 res = !!memcmp(buf1, buf2, i);
1210 while (i < bytes) {
1211 int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001212
Eric Blakedc61cd32017-10-11 22:47:14 -05001213 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001214 break;
1215 }
Eric Blakedc61cd32017-10-11 22:47:14 -05001216 i += len;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001217 }
1218
1219 *pnum = i;
1220 return res;
1221}
1222
Stefano Garzarella97ede572019-05-08 12:43:24 +02001223#define IO_BUF_SIZE (2 * MiB)
bellardea2384d2004-08-01 21:59:26 +00001224
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001225/*
1226 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1227 *
Eric Blake0608e402017-10-11 22:47:12 -05001228 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1229 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1230 * failure), and 4 on error (the exit status for read errors), after emitting
1231 * an error message.
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001232 *
Max Reitzf1d3cd72015-02-05 13:58:18 -05001233 * @param blk: BlockBackend for the image
Eric Blakec41508e2017-10-11 22:47:13 -05001234 * @param offset: Starting offset to check
1235 * @param bytes: Number of bytes to check
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001236 * @param filename: Name of disk file we are checking (logging purpose)
1237 * @param buffer: Allocated buffer for storing read data
1238 * @param quiet: Flag for quiet mode
1239 */
Eric Blakec41508e2017-10-11 22:47:13 -05001240static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1241 int64_t bytes, const char *filename,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001242 uint8_t *buffer, bool quiet)
1243{
Eric Blakedebb38a2017-10-11 22:47:11 -05001244 int ret = 0;
1245 int64_t idx;
1246
Eric Blakec41508e2017-10-11 22:47:13 -05001247 ret = blk_pread(blk, offset, buffer, bytes);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001248 if (ret < 0) {
1249 error_report("Error while reading offset %" PRId64 " of %s: %s",
Eric Blakec41508e2017-10-11 22:47:13 -05001250 offset, filename, strerror(-ret));
Eric Blake0608e402017-10-11 22:47:12 -05001251 return 4;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001252 }
Eric Blakec41508e2017-10-11 22:47:13 -05001253 idx = find_nonzero(buffer, bytes);
Eric Blakedebb38a2017-10-11 22:47:11 -05001254 if (idx >= 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001255 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blakec41508e2017-10-11 22:47:13 -05001256 offset + idx);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001257 return 1;
1258 }
1259
1260 return 0;
1261}
1262
1263/*
1264 * Compares two images. Exit codes:
1265 *
1266 * 0 - Images are identical
1267 * 1 - Images differ
1268 * >1 - Error occurred
1269 */
1270static int img_compare(int argc, char **argv)
1271{
Max Reitz40055952014-07-22 22:58:42 +02001272 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001273 BlockBackend *blk1, *blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001274 BlockDriverState *bs1, *bs2;
Eric Blake033d9fc2017-10-11 22:47:16 -05001275 int64_t total_size1, total_size2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001276 uint8_t *buf1 = NULL, *buf2 = NULL;
Eric Blake31826642017-10-11 22:47:08 -05001277 int64_t pnum1, pnum2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001278 int allocated1, allocated2;
1279 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1280 bool progress = false, quiet = false, strict = false;
Max Reitz40055952014-07-22 22:58:42 +02001281 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01001282 bool writethrough;
Eric Blake033d9fc2017-10-11 22:47:16 -05001283 int64_t total_size;
1284 int64_t offset = 0;
1285 int64_t chunk;
Eric Blakedc61cd32017-10-11 22:47:14 -05001286 int c;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001287 uint64_t progress_base;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001288 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08001289 bool force_share = false;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001290
Max Reitz40055952014-07-22 22:58:42 +02001291 cache = BDRV_DEFAULT_CACHE;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001292 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001293 static const struct option long_options[] = {
1294 {"help", no_argument, 0, 'h'},
1295 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001296 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08001297 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001298 {0, 0, 0, 0}
1299 };
Fam Zheng335e9932017-05-03 00:35:39 +08001300 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001301 long_options, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001302 if (c == -1) {
1303 break;
1304 }
1305 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001306 case ':':
1307 missing_argument(argv[optind - 1]);
1308 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001309 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08001310 unrecognized_option(argv[optind - 1]);
1311 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001312 case 'h':
1313 help();
1314 break;
1315 case 'f':
1316 fmt1 = optarg;
1317 break;
1318 case 'F':
1319 fmt2 = optarg;
1320 break;
Max Reitz40055952014-07-22 22:58:42 +02001321 case 'T':
1322 cache = optarg;
1323 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001324 case 'p':
1325 progress = true;
1326 break;
1327 case 'q':
1328 quiet = true;
1329 break;
1330 case 's':
1331 strict = true;
1332 break;
Fam Zheng335e9932017-05-03 00:35:39 +08001333 case 'U':
1334 force_share = true;
1335 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001336 case OPTION_OBJECT: {
1337 QemuOpts *opts;
1338 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1339 optarg, true);
1340 if (!opts) {
1341 ret = 2;
1342 goto out4;
1343 }
1344 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001345 case OPTION_IMAGE_OPTS:
1346 image_opts = true;
1347 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001348 }
1349 }
1350
1351 /* Progress is not shown in Quiet mode */
1352 if (quiet) {
1353 progress = false;
1354 }
1355
1356
Kevin Wolffc11eb22013-08-05 10:53:04 +02001357 if (optind != argc - 2) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001358 error_exit("Expecting two image file names");
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001359 }
1360 filename1 = argv[optind++];
1361 filename2 = argv[optind++];
1362
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001363 if (qemu_opts_foreach(&qemu_object_opts,
1364 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00001365 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001366 ret = 2;
1367 goto out4;
1368 }
1369
Stefan Hajnoczicbda0162014-08-26 19:17:55 +01001370 /* Initialize before goto out */
1371 qemu_progress_init(progress, 2.0);
1372
Kevin Wolfce099542016-03-15 13:01:04 +01001373 flags = 0;
1374 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +02001375 if (ret < 0) {
1376 error_report("Invalid source cache option: %s", cache);
1377 ret = 2;
1378 goto out3;
1379 }
1380
Fam Zheng335e9932017-05-03 00:35:39 +08001381 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1382 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001383 if (!blk1) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001384 ret = 2;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001385 goto out3;
1386 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001387
Fam Zheng335e9932017-05-03 00:35:39 +08001388 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1389 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001390 if (!blk2) {
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001391 ret = 2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001392 goto out2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001393 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001394 bs1 = blk_bs(blk1);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001395 bs2 = blk_bs(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001396
Max Reitzf1d3cd72015-02-05 13:58:18 -05001397 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1398 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
Eric Blake033d9fc2017-10-11 22:47:16 -05001399 total_size1 = blk_getlength(blk1);
1400 if (total_size1 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001401 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001402 filename1, strerror(-total_size1));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001403 ret = 4;
1404 goto out;
1405 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001406 total_size2 = blk_getlength(blk2);
1407 if (total_size2 < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001408 error_report("Can't get size of %s: %s",
Eric Blake033d9fc2017-10-11 22:47:16 -05001409 filename2, strerror(-total_size2));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001410 ret = 4;
1411 goto out;
1412 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001413 total_size = MIN(total_size1, total_size2);
1414 progress_base = MAX(total_size1, total_size2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001415
1416 qemu_progress_print(0, 100);
1417
Eric Blake033d9fc2017-10-11 22:47:16 -05001418 if (strict && total_size1 != total_size2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001419 ret = 1;
1420 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1421 goto out;
1422 }
1423
Eric Blake033d9fc2017-10-11 22:47:16 -05001424 while (offset < total_size) {
Eric Blake31826642017-10-11 22:47:08 -05001425 int status1, status2;
Fam Zheng67a0fd22016-01-26 11:58:48 +08001426
Eric Blake033d9fc2017-10-11 22:47:16 -05001427 status1 = bdrv_block_status_above(bs1, NULL, offset,
1428 total_size1 - offset, &pnum1, NULL,
1429 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001430 if (status1 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001431 ret = 3;
1432 error_report("Sector allocation test failed for %s", filename1);
1433 goto out;
1434 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001435 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001436
Eric Blake033d9fc2017-10-11 22:47:16 -05001437 status2 = bdrv_block_status_above(bs2, NULL, offset,
1438 total_size2 - offset, &pnum2, NULL,
1439 NULL);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001440 if (status2 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001441 ret = 3;
1442 error_report("Sector allocation test failed for %s", filename2);
1443 goto out;
1444 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001445 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
Eric Blake7daddc62017-10-11 22:47:09 -05001446
1447 assert(pnum1 && pnum2);
Eric Blake033d9fc2017-10-11 22:47:16 -05001448 chunk = MIN(pnum1, pnum2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001449
Fam Zheng25ad8e62016-01-13 16:37:41 +08001450 if (strict) {
Eric Blake31826642017-10-11 22:47:08 -05001451 if (status1 != status2) {
Fam Zheng25ad8e62016-01-13 16:37:41 +08001452 ret = 1;
1453 qprintf(quiet, "Strict mode: Offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001454 " block status mismatch!\n", offset);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001455 goto out;
1456 }
1457 }
1458 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
Eric Blake7daddc62017-10-11 22:47:09 -05001459 /* nothing to do */
Fam Zheng25ad8e62016-01-13 16:37:41 +08001460 } else if (allocated1 == allocated2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001461 if (allocated1) {
Eric Blakedc61cd32017-10-11 22:47:14 -05001462 int64_t pnum;
1463
Eric Blake033d9fc2017-10-11 22:47:16 -05001464 chunk = MIN(chunk, IO_BUF_SIZE);
1465 ret = blk_pread(blk1, offset, buf1, chunk);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001466 if (ret < 0) {
1467 error_report("Error while reading offset %" PRId64
Eric Blake033d9fc2017-10-11 22:47:16 -05001468 " of %s: %s",
1469 offset, filename1, strerror(-ret));
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001470 ret = 4;
1471 goto out;
1472 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001473 ret = blk_pread(blk2, offset, buf2, chunk);
1474 if (ret < 0) {
1475 error_report("Error while reading offset %" PRId64
1476 " of %s: %s",
1477 offset, filename2, strerror(-ret));
1478 ret = 4;
1479 goto out;
1480 }
1481 ret = compare_buffers(buf1, buf2, chunk, &pnum);
1482 if (ret || pnum != chunk) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001483 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
Eric Blake033d9fc2017-10-11 22:47:16 -05001484 offset + (ret ? 0 : pnum));
Fam Zheng36452f12013-11-13 20:26:49 +08001485 ret = 1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001486 goto out;
1487 }
1488 }
1489 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001490 chunk = MIN(chunk, IO_BUF_SIZE);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001491 if (allocated1) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001492 ret = check_empty_sectors(blk1, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001493 filename1, buf1, quiet);
1494 } else {
Eric Blake033d9fc2017-10-11 22:47:16 -05001495 ret = check_empty_sectors(blk2, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001496 filename2, buf1, quiet);
1497 }
1498 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001499 goto out;
1500 }
1501 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001502 offset += chunk;
1503 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001504 }
1505
Eric Blake033d9fc2017-10-11 22:47:16 -05001506 if (total_size1 != total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001507 BlockBackend *blk_over;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001508 const char *filename_over;
1509
1510 qprintf(quiet, "Warning: Image size mismatch!\n");
Eric Blake033d9fc2017-10-11 22:47:16 -05001511 if (total_size1 > total_size2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001512 blk_over = blk1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001513 filename_over = filename1;
1514 } else {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001515 blk_over = blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001516 filename_over = filename2;
1517 }
1518
Eric Blake033d9fc2017-10-11 22:47:16 -05001519 while (offset < progress_base) {
1520 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1521 progress_base - offset, &chunk,
1522 NULL, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001523 if (ret < 0) {
1524 ret = 3;
1525 error_report("Sector allocation test failed for %s",
1526 filename_over);
1527 goto out;
1528
1529 }
Eric Blake391cb1a2017-10-11 22:47:10 -05001530 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
Eric Blake033d9fc2017-10-11 22:47:16 -05001531 chunk = MIN(chunk, IO_BUF_SIZE);
1532 ret = check_empty_sectors(blk_over, offset, chunk,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001533 filename_over, buf1, quiet);
1534 if (ret) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001535 goto out;
1536 }
1537 }
Eric Blake033d9fc2017-10-11 22:47:16 -05001538 offset += chunk;
1539 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001540 }
1541 }
1542
1543 qprintf(quiet, "Images are identical.\n");
1544 ret = 0;
1545
1546out:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001547 qemu_vfree(buf1);
1548 qemu_vfree(buf2);
Markus Armbruster26f54e92014-10-07 13:59:04 +02001549 blk_unref(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001550out2:
Markus Armbruster26f54e92014-10-07 13:59:04 +02001551 blk_unref(blk1);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001552out3:
1553 qemu_progress_end();
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001554out4:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001555 return ret;
1556}
1557
Kevin Wolf690c7302015-03-19 13:33:32 +01001558enum ImgConvertBlockStatus {
1559 BLK_DATA,
1560 BLK_ZERO,
1561 BLK_BACKING_FILE,
1562};
1563
Peter Lieven2d9187b2017-02-28 13:40:07 +01001564#define MAX_COROUTINES 16
1565
Kevin Wolf690c7302015-03-19 13:33:32 +01001566typedef struct ImgConvertState {
1567 BlockBackend **src;
1568 int64_t *src_sectors;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001569 int src_num;
Kevin Wolf690c7302015-03-19 13:33:32 +01001570 int64_t total_sectors;
1571 int64_t allocated_sectors;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001572 int64_t allocated_done;
1573 int64_t sector_num;
1574 int64_t wr_offs;
Kevin Wolf690c7302015-03-19 13:33:32 +01001575 enum ImgConvertBlockStatus status;
1576 int64_t sector_next_status;
1577 BlockBackend *target;
1578 bool has_zero_init;
1579 bool compressed;
Max Reitz351c8ef2018-05-01 18:57:49 +02001580 bool unallocated_blocks_are_zero;
Kevin Wolf690c7302015-03-19 13:33:32 +01001581 bool target_has_backing;
Max Reitz351c8ef2018-05-01 18:57:49 +02001582 int64_t target_backing_sectors; /* negative if unknown */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001583 bool wr_in_order;
Fam Zhengee5306d2018-06-01 17:26:48 +08001584 bool copy_range;
Max Reitz8eaac022019-05-07 22:35:03 +02001585 bool salvage;
Max Reitz3d96cb92019-05-07 22:35:02 +02001586 bool quiet;
Kevin Wolf690c7302015-03-19 13:33:32 +01001587 int min_sparse;
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001588 int alignment;
Kevin Wolf690c7302015-03-19 13:33:32 +01001589 size_t cluster_sectors;
1590 size_t buf_sectors;
Peter Lieven9fd77f92017-04-21 11:11:55 +02001591 long num_coroutines;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001592 int running_coroutines;
1593 Coroutine *co[MAX_COROUTINES];
1594 int64_t wait_sector_num[MAX_COROUTINES];
1595 CoMutex lock;
1596 int ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001597} ImgConvertState;
1598
Peter Lieven2d9187b2017-02-28 13:40:07 +01001599static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1600 int *src_cur, int64_t *src_cur_offset)
Kevin Wolf690c7302015-03-19 13:33:32 +01001601{
Peter Lieven2d9187b2017-02-28 13:40:07 +01001602 *src_cur = 0;
1603 *src_cur_offset = 0;
1604 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1605 *src_cur_offset += s->src_sectors[*src_cur];
1606 (*src_cur)++;
1607 assert(*src_cur < s->src_num);
Kevin Wolf690c7302015-03-19 13:33:32 +01001608 }
1609}
1610
1611static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1612{
Eric Blake31826642017-10-11 22:47:08 -05001613 int64_t src_cur_offset;
1614 int ret, n, src_cur;
Max Reitz351c8ef2018-05-01 18:57:49 +02001615 bool post_backing_zero = false;
Kevin Wolf690c7302015-03-19 13:33:32 +01001616
Peter Lieven2d9187b2017-02-28 13:40:07 +01001617 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
Kevin Wolf690c7302015-03-19 13:33:32 +01001618
1619 assert(s->total_sectors > sector_num);
1620 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1621
Max Reitz351c8ef2018-05-01 18:57:49 +02001622 if (s->target_backing_sectors >= 0) {
1623 if (sector_num >= s->target_backing_sectors) {
1624 post_backing_zero = s->unallocated_blocks_are_zero;
1625 } else if (sector_num + n > s->target_backing_sectors) {
1626 /* Split requests around target_backing_sectors (because
1627 * starting from there, zeros are handled differently) */
1628 n = s->target_backing_sectors - sector_num;
1629 }
1630 }
1631
Kevin Wolf690c7302015-03-19 13:33:32 +01001632 if (s->sector_next_status <= sector_num) {
Max Reitz8eaac022019-05-07 22:35:03 +02001633 uint64_t offset = (sector_num - src_cur_offset) * BDRV_SECTOR_SIZE;
1634 int64_t count;
Eric Blake31826642017-10-11 22:47:08 -05001635
Max Reitz8eaac022019-05-07 22:35:03 +02001636 do {
1637 count = n * BDRV_SECTOR_SIZE;
Eric Blake237d78f2017-10-11 22:47:03 -05001638
Max Reitz8eaac022019-05-07 22:35:03 +02001639 if (s->target_has_backing) {
1640 ret = bdrv_block_status(blk_bs(s->src[src_cur]), offset,
1641 count, &count, NULL, NULL);
1642 } else {
1643 ret = bdrv_block_status_above(blk_bs(s->src[src_cur]), NULL,
1644 offset, count, &count, NULL,
1645 NULL);
1646 }
1647
1648 if (ret < 0) {
1649 if (s->salvage) {
1650 if (n == 1) {
1651 if (!s->quiet) {
1652 warn_report("error while reading block status at "
1653 "offset %" PRIu64 ": %s", offset,
1654 strerror(-ret));
1655 }
1656 /* Just try to read the data, then */
1657 ret = BDRV_BLOCK_DATA;
1658 count = BDRV_SECTOR_SIZE;
1659 } else {
1660 /* Retry on a shorter range */
1661 n = DIV_ROUND_UP(n, 4);
1662 }
1663 } else {
1664 error_report("error while reading block status at offset "
1665 "%" PRIu64 ": %s", offset, strerror(-ret));
1666 return ret;
1667 }
1668 }
1669 } while (ret < 0);
1670
Eric Blake31826642017-10-11 22:47:08 -05001671 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
Kevin Wolf690c7302015-03-19 13:33:32 +01001672
1673 if (ret & BDRV_BLOCK_ZERO) {
Max Reitz351c8ef2018-05-01 18:57:49 +02001674 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
Kevin Wolf690c7302015-03-19 13:33:32 +01001675 } else if (ret & BDRV_BLOCK_DATA) {
1676 s->status = BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001677 } else {
Vladimir Sementsov-Ogievskiy9f1b92a2017-04-07 14:34:04 +03001678 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001679 }
1680
1681 s->sector_next_status = sector_num + n;
1682 }
1683
1684 n = MIN(n, s->sector_next_status - sector_num);
1685 if (s->status == BLK_DATA) {
1686 n = MIN(n, s->buf_sectors);
1687 }
1688
1689 /* We need to write complete clusters for compressed images, so if an
1690 * unallocated area is shorter than that, we must consider the whole
1691 * cluster allocated. */
1692 if (s->compressed) {
1693 if (n < s->cluster_sectors) {
1694 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1695 s->status = BLK_DATA;
1696 } else {
1697 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1698 }
1699 }
1700
1701 return n;
1702}
1703
Peter Lieven2d9187b2017-02-28 13:40:07 +01001704static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1705 int nb_sectors, uint8_t *buf)
Kevin Wolf690c7302015-03-19 13:33:32 +01001706{
Max Reitz8eaac022019-05-07 22:35:03 +02001707 uint64_t single_read_until = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001708 int n, ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01001709
Kevin Wolf690c7302015-03-19 13:33:32 +01001710 assert(nb_sectors <= s->buf_sectors);
1711 while (nb_sectors > 0) {
1712 BlockBackend *blk;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001713 int src_cur;
1714 int64_t bs_sectors, src_cur_offset;
Max Reitz8eaac022019-05-07 22:35:03 +02001715 uint64_t offset;
Kevin Wolf690c7302015-03-19 13:33:32 +01001716
1717 /* In the case of compression with multiple source files, we can get a
1718 * nb_sectors that spreads into the next part. So we must be able to
1719 * read across multiple BDSes for one convert_read() call. */
Peter Lieven2d9187b2017-02-28 13:40:07 +01001720 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1721 blk = s->src[src_cur];
1722 bs_sectors = s->src_sectors[src_cur];
Kevin Wolf690c7302015-03-19 13:33:32 +01001723
Max Reitz8eaac022019-05-07 22:35:03 +02001724 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001725
Max Reitz8eaac022019-05-07 22:35:03 +02001726 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1727 if (single_read_until > offset) {
1728 n = 1;
1729 }
1730
1731 ret = blk_co_pread(blk, offset, n << BDRV_SECTOR_BITS, buf, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01001732 if (ret < 0) {
Max Reitz8eaac022019-05-07 22:35:03 +02001733 if (s->salvage) {
1734 if (n > 1) {
1735 single_read_until = offset + (n << BDRV_SECTOR_BITS);
1736 continue;
1737 } else {
1738 if (!s->quiet) {
1739 warn_report("error while reading offset %" PRIu64
1740 ": %s", offset, strerror(-ret));
1741 }
1742 memset(buf, 0, BDRV_SECTOR_SIZE);
1743 }
1744 } else {
1745 return ret;
1746 }
Kevin Wolf690c7302015-03-19 13:33:32 +01001747 }
1748
1749 sector_num += n;
1750 nb_sectors -= n;
1751 buf += n * BDRV_SECTOR_SIZE;
1752 }
1753
1754 return 0;
1755}
1756
Peter Lieven2d9187b2017-02-28 13:40:07 +01001757
1758static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1759 int nb_sectors, uint8_t *buf,
1760 enum ImgConvertBlockStatus status)
Kevin Wolf690c7302015-03-19 13:33:32 +01001761{
1762 int ret;
1763
1764 while (nb_sectors > 0) {
1765 int n = nb_sectors;
Lidong Chendb933fb2017-04-27 10:58:27 +08001766 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1767
Peter Lieven2d9187b2017-02-28 13:40:07 +01001768 switch (status) {
Kevin Wolf690c7302015-03-19 13:33:32 +01001769 case BLK_BACKING_FILE:
1770 /* If we have a backing file, leave clusters unallocated that are
1771 * unallocated in the source image, so that the backing file is
1772 * visible at the respective offset. */
1773 assert(s->target_has_backing);
1774 break;
1775
1776 case BLK_DATA:
Lidong Chendb933fb2017-04-27 10:58:27 +08001777 /* If we're told to keep the target fully allocated (-S 0) or there
1778 * is real non-zero data, we must write it. Otherwise we can treat
1779 * it as zero sectors.
1780 * Compressed clusters need to be written as a whole, so in that
1781 * case we can only save the write if the buffer is completely
1782 * zeroed. */
Kevin Wolf690c7302015-03-19 13:33:32 +01001783 if (!s->min_sparse ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001784 (!s->compressed &&
Peter Lieven8dcd3c92018-07-12 15:00:10 +02001785 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1786 sector_num, s->alignment)) ||
Lidong Chendb933fb2017-04-27 10:58:27 +08001787 (s->compressed &&
1788 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
Kevin Wolf690c7302015-03-19 13:33:32 +01001789 {
Vladimir Sementsov-Ogievskiy265a7e52019-04-22 17:58:38 +03001790 ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1791 n << BDRV_SECTOR_BITS, buf, flags);
Kevin Wolf690c7302015-03-19 13:33:32 +01001792 if (ret < 0) {
1793 return ret;
1794 }
1795 break;
1796 }
1797 /* fall-through */
1798
1799 case BLK_ZERO:
1800 if (s->has_zero_init) {
Lidong Chendb933fb2017-04-27 10:58:27 +08001801 assert(!s->target_has_backing);
Kevin Wolf690c7302015-03-19 13:33:32 +01001802 break;
1803 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01001804 ret = blk_co_pwrite_zeroes(s->target,
1805 sector_num << BDRV_SECTOR_BITS,
Nir Soffera3d6ae22019-03-24 02:20:12 +02001806 n << BDRV_SECTOR_BITS,
1807 BDRV_REQ_MAY_UNMAP);
Kevin Wolf690c7302015-03-19 13:33:32 +01001808 if (ret < 0) {
1809 return ret;
1810 }
1811 break;
1812 }
1813
1814 sector_num += n;
1815 nb_sectors -= n;
1816 buf += n * BDRV_SECTOR_SIZE;
1817 }
1818
1819 return 0;
1820}
1821
Fam Zhengee5306d2018-06-01 17:26:48 +08001822static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1823 int nb_sectors)
1824{
1825 int n, ret;
1826
1827 while (nb_sectors > 0) {
1828 BlockBackend *blk;
1829 int src_cur;
1830 int64_t bs_sectors, src_cur_offset;
1831 int64_t offset;
1832
1833 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1834 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1835 blk = s->src[src_cur];
1836 bs_sectors = s->src_sectors[src_cur];
1837
1838 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1839
1840 ret = blk_co_copy_range(blk, offset, s->target,
1841 sector_num << BDRV_SECTOR_BITS,
Vladimir Sementsov-Ogievskiy67b51fb2018-07-09 19:37:17 +03001842 n << BDRV_SECTOR_BITS, 0, 0);
Fam Zhengee5306d2018-06-01 17:26:48 +08001843 if (ret < 0) {
1844 return ret;
1845 }
1846
1847 sector_num += n;
1848 nb_sectors -= n;
1849 }
1850 return 0;
1851}
1852
Peter Lieven2d9187b2017-02-28 13:40:07 +01001853static void coroutine_fn convert_co_do_copy(void *opaque)
1854{
1855 ImgConvertState *s = opaque;
1856 uint8_t *buf = NULL;
1857 int ret, i;
1858 int index = -1;
1859
1860 for (i = 0; i < s->num_coroutines; i++) {
1861 if (s->co[i] == qemu_coroutine_self()) {
1862 index = i;
1863 break;
1864 }
1865 }
1866 assert(index >= 0);
1867
1868 s->running_coroutines++;
1869 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1870
1871 while (1) {
1872 int n;
1873 int64_t sector_num;
1874 enum ImgConvertBlockStatus status;
Fam Zhengee5306d2018-06-01 17:26:48 +08001875 bool copy_range;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001876
1877 qemu_co_mutex_lock(&s->lock);
1878 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1879 qemu_co_mutex_unlock(&s->lock);
Anton Nefedovb91127e2017-04-26 11:33:15 +03001880 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001881 }
1882 n = convert_iteration_sectors(s, s->sector_num);
1883 if (n < 0) {
1884 qemu_co_mutex_unlock(&s->lock);
1885 s->ret = n;
Anton Nefedovb91127e2017-04-26 11:33:15 +03001886 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001887 }
1888 /* save current sector and allocation status to local variables */
1889 sector_num = s->sector_num;
1890 status = s->status;
1891 if (!s->min_sparse && s->status == BLK_ZERO) {
1892 n = MIN(n, s->buf_sectors);
1893 }
1894 /* increment global sector counter so that other coroutines can
1895 * already continue reading beyond this request */
1896 s->sector_num += n;
1897 qemu_co_mutex_unlock(&s->lock);
1898
1899 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
1900 s->allocated_done += n;
1901 qemu_progress_print(100.0 * s->allocated_done /
1902 s->allocated_sectors, 0);
1903 }
1904
Fam Zhengee5306d2018-06-01 17:26:48 +08001905retry:
1906 copy_range = s->copy_range && s->status == BLK_DATA;
1907 if (status == BLK_DATA && !copy_range) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01001908 ret = convert_co_read(s, sector_num, n, buf);
1909 if (ret < 0) {
1910 error_report("error while reading sector %" PRId64
1911 ": %s", sector_num, strerror(-ret));
1912 s->ret = ret;
Peter Lieven2d9187b2017-02-28 13:40:07 +01001913 }
1914 } else if (!s->min_sparse && status == BLK_ZERO) {
1915 status = BLK_DATA;
1916 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
1917 }
1918
1919 if (s->wr_in_order) {
1920 /* keep writes in order */
Anton Nefedovb91127e2017-04-26 11:33:15 +03001921 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01001922 s->wait_sector_num[index] = sector_num;
1923 qemu_coroutine_yield();
1924 }
1925 s->wait_sector_num[index] = -1;
1926 }
1927
Anton Nefedovb91127e2017-04-26 11:33:15 +03001928 if (s->ret == -EINPROGRESS) {
Fam Zhengee5306d2018-06-01 17:26:48 +08001929 if (copy_range) {
1930 ret = convert_co_copy_range(s, sector_num, n);
1931 if (ret) {
1932 s->copy_range = false;
1933 goto retry;
1934 }
1935 } else {
1936 ret = convert_co_write(s, sector_num, n, buf, status);
1937 }
Anton Nefedovb91127e2017-04-26 11:33:15 +03001938 if (ret < 0) {
1939 error_report("error while writing sector %" PRId64
1940 ": %s", sector_num, strerror(-ret));
1941 s->ret = ret;
1942 }
Peter Lieven2d9187b2017-02-28 13:40:07 +01001943 }
1944
1945 if (s->wr_in_order) {
1946 /* reenter the coroutine that might have waited
1947 * for this write to complete */
1948 s->wr_offs = sector_num + n;
1949 for (i = 0; i < s->num_coroutines; i++) {
1950 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
1951 /*
1952 * A -> B -> A cannot occur because A has
1953 * s->wait_sector_num[i] == -1 during A -> B. Therefore
1954 * B will never enter A during this time window.
1955 */
1956 qemu_coroutine_enter(s->co[i]);
1957 break;
1958 }
1959 }
1960 }
1961 }
1962
Peter Lieven2d9187b2017-02-28 13:40:07 +01001963 qemu_vfree(buf);
1964 s->co[index] = NULL;
1965 s->running_coroutines--;
1966 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
1967 /* the convert job finished successfully */
1968 s->ret = 0;
1969 }
1970}
1971
Kevin Wolf690c7302015-03-19 13:33:32 +01001972static int convert_do_copy(ImgConvertState *s)
1973{
Peter Lieven2d9187b2017-02-28 13:40:07 +01001974 int ret, i, n;
1975 int64_t sector_num = 0;
Kevin Wolf690c7302015-03-19 13:33:32 +01001976
1977 /* Check whether we have zero initialisation or can get it efficiently */
1978 s->has_zero_init = s->min_sparse && !s->target_has_backing
1979 ? bdrv_has_zero_init(blk_bs(s->target))
1980 : false;
1981
1982 if (!s->has_zero_init && !s->target_has_backing &&
1983 bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
1984 {
Kevin Wolfc9fdcf22019-03-22 13:49:28 +01001985 ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP | BDRV_REQ_NO_FALLBACK);
Kevin Wolf690c7302015-03-19 13:33:32 +01001986 if (ret == 0) {
1987 s->has_zero_init = true;
1988 }
1989 }
1990
1991 /* Allocate buffer for copied data. For compressed images, only one cluster
1992 * can be copied at a time. */
1993 if (s->compressed) {
1994 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
1995 error_report("invalid cluster size");
Peter Lieven2d9187b2017-02-28 13:40:07 +01001996 return -EINVAL;
Kevin Wolf690c7302015-03-19 13:33:32 +01001997 }
1998 s->buf_sectors = s->cluster_sectors;
1999 }
Kevin Wolf690c7302015-03-19 13:33:32 +01002000
Kevin Wolf690c7302015-03-19 13:33:32 +01002001 while (sector_num < s->total_sectors) {
2002 n = convert_iteration_sectors(s, sector_num);
2003 if (n < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002004 return n;
Kevin Wolf690c7302015-03-19 13:33:32 +01002005 }
Max Reitzaad15de2016-03-24 23:33:57 +01002006 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
2007 {
Kevin Wolf690c7302015-03-19 13:33:32 +01002008 s->allocated_sectors += n;
2009 }
2010 sector_num += n;
2011 }
2012
2013 /* Do the copy */
Kevin Wolf690c7302015-03-19 13:33:32 +01002014 s->sector_next_status = 0;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002015 s->ret = -EINPROGRESS;
Kevin Wolf690c7302015-03-19 13:33:32 +01002016
Peter Lieven2d9187b2017-02-28 13:40:07 +01002017 qemu_co_mutex_init(&s->lock);
2018 for (i = 0; i < s->num_coroutines; i++) {
2019 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
2020 s->wait_sector_num[i] = -1;
2021 qemu_coroutine_enter(s->co[i]);
Kevin Wolf690c7302015-03-19 13:33:32 +01002022 }
2023
Anton Nefedovb91127e2017-04-26 11:33:15 +03002024 while (s->running_coroutines) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002025 main_loop_wait(false);
2026 }
2027
2028 if (s->compressed && !s->ret) {
Kevin Wolf690c7302015-03-19 13:33:32 +01002029 /* signal EOF to align */
Pavel Butsykinfe5c1352016-07-22 11:17:40 +03002030 ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01002031 if (ret < 0) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002032 return ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002033 }
2034 }
2035
Peter Lieven2d9187b2017-02-28 13:40:07 +01002036 return s->ret;
Kevin Wolf690c7302015-03-19 13:33:32 +01002037}
2038
Peter Lieven6360ab22018-07-13 09:15:39 +02002039#define MAX_BUF_SECTORS 32768
2040
bellardea2384d2004-08-01 21:59:26 +00002041static int img_convert(int argc, char **argv)
2042{
Peter Lieven9fd77f92017-04-21 11:11:55 +02002043 int c, bs_i, flags, src_flags = 0;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002044 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002045 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
2046 *out_filename, *out_baseimg_param, *snapshot_name = NULL;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002047 BlockDriver *drv = NULL, *proto_drv = NULL;
bellardfaea38e2006-08-05 21:31:00 +00002048 BlockDriverInfo bdi;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002049 BlockDriverState *out_bs;
2050 QemuOpts *opts = NULL, *sn_opts = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08002051 QemuOptsList *create_opts = NULL;
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002052 QDict *open_opts = NULL;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002053 char *options = NULL;
Max Reitzcc84d902013-09-06 17:14:26 +02002054 Error *local_err = NULL;
Max Reitz3d96cb92019-05-07 22:35:02 +02002055 bool writethrough, src_writethrough, image_opts = false,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002056 skip_create = false, progress = false, tgt_image_opts = false;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002057 int64_t ret = -EINVAL;
Fam Zheng335e9932017-05-03 00:35:39 +08002058 bool force_share = false;
Fam Zhenge11ce122018-07-27 11:34:01 +08002059 bool explict_min_sparse = false;
bellardea2384d2004-08-01 21:59:26 +00002060
Peter Lieven9fd77f92017-04-21 11:11:55 +02002061 ImgConvertState s = (ImgConvertState) {
2062 /* Need at least 4k of zeros for sparse detection */
2063 .min_sparse = 8,
Fam Zhenge11ce122018-07-27 11:34:01 +08002064 .copy_range = false,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002065 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2066 .wr_in_order = true,
2067 .num_coroutines = 8,
2068 };
2069
bellardea2384d2004-08-01 21:59:26 +00002070 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002071 static const struct option long_options[] = {
2072 {"help", no_argument, 0, 'h'},
2073 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002074 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002075 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002076 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
Max Reitz8eaac022019-05-07 22:35:03 +02002077 {"salvage", no_argument, 0, OPTION_SALVAGE},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002078 {0, 0, 0, 0}
2079 };
Fam Zhenge11ce122018-07-27 11:34:01 +08002080 c = getopt_long(argc, argv, ":hf:O:B:Cco:l:S:pt:T:qnm:WU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002081 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002082 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002083 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002084 }
bellardea2384d2004-08-01 21:59:26 +00002085 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002086 case ':':
2087 missing_argument(argv[optind - 1]);
2088 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002089 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002090 unrecognized_option(argv[optind - 1]);
2091 break;
bellardea2384d2004-08-01 21:59:26 +00002092 case 'h':
2093 help();
2094 break;
2095 case 'f':
2096 fmt = optarg;
2097 break;
2098 case 'O':
2099 out_fmt = optarg;
2100 break;
thsf58c7b32008-06-05 21:53:49 +00002101 case 'B':
2102 out_baseimg = optarg;
2103 break;
Fam Zhenge11ce122018-07-27 11:34:01 +08002104 case 'C':
2105 s.copy_range = true;
2106 break;
bellardea2384d2004-08-01 21:59:26 +00002107 case 'c':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002108 s.compressed = true;
bellardea2384d2004-08-01 21:59:26 +00002109 break;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002110 case 'o':
Kevin Wolf2dc83282014-02-21 16:24:05 +01002111 if (!is_valid_option_list(optarg)) {
2112 error_report("Invalid option list: %s", optarg);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002113 goto fail_getopt;
Kevin Wolf2dc83282014-02-21 16:24:05 +01002114 }
2115 if (!options) {
2116 options = g_strdup(optarg);
2117 } else {
2118 char *old_options = options;
2119 options = g_strdup_printf("%s,%s", options, optarg);
2120 g_free(old_options);
2121 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002122 break;
Wenchao Xiaef806542013-12-04 17:10:57 +08002123 case 'l':
2124 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
Markus Armbruster70b94332015-02-13 12:50:26 +01002125 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2126 optarg, false);
Wenchao Xiaef806542013-12-04 17:10:57 +08002127 if (!sn_opts) {
2128 error_report("Failed in parsing snapshot param '%s'",
2129 optarg);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002130 goto fail_getopt;
Wenchao Xiaef806542013-12-04 17:10:57 +08002131 }
2132 } else {
2133 snapshot_name = optarg;
2134 }
2135 break;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002136 case 'S':
2137 {
2138 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +01002139
2140 sval = cvtnum(optarg);
Peter Lieven6360ab22018-07-13 09:15:39 +02002141 if (sval < 0 || sval & (BDRV_SECTOR_SIZE - 1) ||
2142 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2143 error_report("Invalid buffer size for sparse output specified. "
2144 "Valid sizes are multiples of %llu up to %llu. Select "
2145 "0 to disable sparse detection (fully allocates output).",
2146 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002147 goto fail_getopt;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002148 }
2149
Peter Lieven9fd77f92017-04-21 11:11:55 +02002150 s.min_sparse = sval / BDRV_SECTOR_SIZE;
Fam Zhenge11ce122018-07-27 11:34:01 +08002151 explict_min_sparse = true;
Kevin Wolfa22f1232011-08-26 15:27:13 +02002152 break;
2153 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002154 case 'p':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002155 progress = true;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002156 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002157 case 't':
2158 cache = optarg;
2159 break;
Max Reitz40055952014-07-22 22:58:42 +02002160 case 'T':
2161 src_cache = optarg;
2162 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002163 case 'q':
Max Reitz3d96cb92019-05-07 22:35:02 +02002164 s.quiet = true;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002165 break;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002166 case 'n':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002167 skip_create = true;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002168 break;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002169 case 'm':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002170 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2171 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
Peter Lieven2d9187b2017-02-28 13:40:07 +01002172 error_report("Invalid number of coroutines. Allowed number of"
2173 " coroutines is between 1 and %d", MAX_COROUTINES);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002174 goto fail_getopt;
2175 }
2176 break;
2177 case 'W':
Peter Lieven9fd77f92017-04-21 11:11:55 +02002178 s.wr_in_order = false;
Peter Lieven2d9187b2017-02-28 13:40:07 +01002179 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002180 case 'U':
2181 force_share = true;
2182 break;
Max Reitz3258b912017-04-26 15:46:47 +02002183 case OPTION_OBJECT: {
2184 QemuOpts *object_opts;
2185 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
2186 optarg, true);
2187 if (!object_opts) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002188 goto fail_getopt;
2189 }
2190 break;
Max Reitz3258b912017-04-26 15:46:47 +02002191 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002192 case OPTION_IMAGE_OPTS:
2193 image_opts = true;
2194 break;
Max Reitz8eaac022019-05-07 22:35:03 +02002195 case OPTION_SALVAGE:
2196 s.salvage = true;
2197 break;
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002198 case OPTION_TARGET_IMAGE_OPTS:
2199 tgt_image_opts = true;
2200 break;
bellardea2384d2004-08-01 21:59:26 +00002201 }
2202 }
ths3b46e622007-09-17 08:09:54 +00002203
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002204 if (!out_fmt && !tgt_image_opts) {
2205 out_fmt = "raw";
2206 }
2207
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002208 if (qemu_opts_foreach(&qemu_object_opts,
2209 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00002210 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002211 goto fail_getopt;
2212 }
2213
Fam Zhenge11ce122018-07-27 11:34:01 +08002214 if (s.compressed && s.copy_range) {
2215 error_report("Cannot enable copy offloading when -c is used");
2216 goto fail_getopt;
2217 }
2218
2219 if (explict_min_sparse && s.copy_range) {
2220 error_report("Cannot enable copy offloading when -S is used");
2221 goto fail_getopt;
2222 }
2223
Max Reitz8eaac022019-05-07 22:35:03 +02002224 if (s.copy_range && s.salvage) {
2225 error_report("Cannot use copy offloading in salvaging mode");
2226 goto fail_getopt;
2227 }
2228
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002229 if (tgt_image_opts && !skip_create) {
2230 error_report("--target-image-opts requires use of -n flag");
2231 goto fail_getopt;
2232 }
2233
Kevin Wolfffd8e8f2019-08-09 11:09:21 +02002234 if (skip_create && options) {
2235 warn_report("-o has no effect when skipping image creation");
2236 warn_report("This will become an error in future QEMU versions.");
2237 }
2238
Peter Lieven9fd77f92017-04-21 11:11:55 +02002239 s.src_num = argc - optind - 1;
2240 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2241
2242 if (options && has_help_option(options)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002243 if (out_fmt) {
2244 ret = print_block_option_help(out_filename, out_fmt);
2245 goto fail_getopt;
2246 } else {
2247 error_report("Option help requires a format be specified");
2248 goto fail_getopt;
2249 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002250 }
2251
2252 if (s.src_num < 1) {
2253 error_report("Must specify image file name");
2254 goto fail_getopt;
2255 }
2256
2257
Peter Lieven9fd77f92017-04-21 11:11:55 +02002258 /* ret is still -EINVAL until here */
2259 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2260 if (ret < 0) {
2261 error_report("Invalid source cache option: %s", src_cache);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002262 goto fail_getopt;
2263 }
2264
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002265 /* Initialize before goto out */
Max Reitz3d96cb92019-05-07 22:35:02 +02002266 if (s.quiet) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002267 progress = false;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002268 }
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002269 qemu_progress_init(progress, 1.0);
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002270 qemu_progress_print(0, 100);
2271
Peter Lieven9fd77f92017-04-21 11:11:55 +02002272 s.src = g_new0(BlockBackend *, s.src_num);
2273 s.src_sectors = g_new(int64_t, s.src_num);
balrog926c2d22007-10-31 01:11:44 +00002274
Peter Lieven9fd77f92017-04-21 11:11:55 +02002275 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2276 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
Max Reitz3d96cb92019-05-07 22:35:02 +02002277 fmt, src_flags, src_writethrough, s.quiet,
Fam Zheng335e9932017-05-03 00:35:39 +08002278 force_share);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002279 if (!s.src[bs_i]) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002280 ret = -1;
2281 goto out;
2282 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002283 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2284 if (s.src_sectors[bs_i] < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002285 error_report("Could not get size of %s: %s",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002286 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002287 ret = -1;
2288 goto out;
2289 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002290 s.total_sectors += s.src_sectors[bs_i];
balrog926c2d22007-10-31 01:11:44 +00002291 }
bellardea2384d2004-08-01 21:59:26 +00002292
Wenchao Xiaef806542013-12-04 17:10:57 +08002293 if (sn_opts) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002294 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
Peter Maydell10d6eda2017-02-10 16:28:24 +00002295 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2296 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2297 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002298 } else if (snapshot_name != NULL) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002299 if (s.src_num > 1) {
Markus Armbruster6daf1942011-06-22 14:03:54 +02002300 error_report("No support for concatenating multiple snapshot");
edison51ef6722010-09-21 19:58:41 -07002301 ret = -1;
2302 goto out;
2303 }
Wenchao Xia7b4c4782013-12-04 17:10:54 +08002304
Peter Lieven9fd77f92017-04-21 11:11:55 +02002305 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2306 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002307 }
Markus Armbruster84d18f02014-01-30 15:07:28 +01002308 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002309 error_reportf_err(local_err, "Failed to load snapshot: ");
Wenchao Xiaef806542013-12-04 17:10:57 +08002310 ret = -1;
2311 goto out;
edison51ef6722010-09-21 19:58:41 -07002312 }
2313
Max Reitz2e024cd2015-02-11 09:58:46 -05002314 if (!skip_create) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002315 /* Find driver and parse its options */
2316 drv = bdrv_find_format(out_fmt);
2317 if (!drv) {
2318 error_report("Unknown file format '%s'", out_fmt);
2319 ret = -1;
2320 goto out;
2321 }
2322
2323 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2324 if (!proto_drv) {
2325 error_report_err(local_err);
2326 ret = -1;
2327 goto out;
2328 }
2329
Max Reitz2e024cd2015-02-11 09:58:46 -05002330 if (!drv->create_opts) {
2331 error_report("Format driver '%s' does not support image creation",
2332 drv->format_name);
2333 ret = -1;
2334 goto out;
2335 }
Max Reitzf75613c2014-12-02 18:32:46 +01002336
Max Reitz2e024cd2015-02-11 09:58:46 -05002337 if (!proto_drv->create_opts) {
2338 error_report("Protocol driver '%s' does not support image creation",
2339 proto_drv->format_name);
2340 ret = -1;
2341 goto out;
2342 }
Max Reitzf75613c2014-12-02 18:32:46 +01002343
Max Reitz2e024cd2015-02-11 09:58:46 -05002344 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2345 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfdb08adf2009-06-04 15:39:38 +02002346
Max Reitz2e024cd2015-02-11 09:58:46 -05002347 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002348 if (options) {
2349 qemu_opts_do_parse(opts, options, NULL, &local_err);
2350 if (local_err) {
Markus Armbruster97a2ca72015-03-14 10:23:15 +01002351 error_report_err(local_err);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002352 ret = -1;
2353 goto out;
2354 }
Max Reitz2e024cd2015-02-11 09:58:46 -05002355 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002356
Peter Lieven9fd77f92017-04-21 11:11:55 +02002357 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
Markus Armbruster39101f22015-02-12 16:46:36 +01002358 &error_abort);
Max Reitz2e024cd2015-02-11 09:58:46 -05002359 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2360 if (ret < 0) {
2361 goto out;
2362 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002363 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002364
Kevin Wolfa18953f2010-10-14 15:46:04 +02002365 /* Get backing file name if -o backing_file was used */
Chunyan Liu83d05212014-06-05 17:20:51 +08002366 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
Kevin Wolfa18953f2010-10-14 15:46:04 +02002367 if (out_baseimg_param) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002368 out_baseimg = out_baseimg_param;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002369 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002370 s.target_has_backing = (bool) out_baseimg;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002371
Max Reitz48758a82017-04-26 15:46:48 +02002372 if (s.src_num > 1 && out_baseimg) {
2373 error_report("Having a backing file for the target makes no sense when "
2374 "concatenating multiple input images");
2375 ret = -1;
2376 goto out;
2377 }
2378
Kevin Wolfefa84d42009-05-18 16:42:12 +02002379 /* Check if compression is supported */
Peter Lieven9fd77f92017-04-21 11:11:55 +02002380 if (s.compressed) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002381 bool encryption =
2382 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002383 const char *encryptfmt =
2384 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
Chunyan Liu83d05212014-06-05 17:20:51 +08002385 const char *preallocation =
2386 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
Kevin Wolfefa84d42009-05-18 16:42:12 +02002387
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002388 if (drv && !drv->bdrv_co_pwritev_compressed) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002389 error_report("Compression not supported for this file format");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002390 ret = -1;
2391 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002392 }
2393
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002394 if (encryption || encryptfmt) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002395 error_report("Compression and encryption not supported at "
2396 "the same time");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002397 ret = -1;
2398 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002399 }
Kevin Wolf41521fa2011-10-18 16:19:42 +02002400
Chunyan Liu83d05212014-06-05 17:20:51 +08002401 if (preallocation
2402 && strcmp(preallocation, "off"))
Kevin Wolf41521fa2011-10-18 16:19:42 +02002403 {
2404 error_report("Compression and preallocation not supported at "
2405 "the same time");
2406 ret = -1;
2407 goto out;
2408 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002409 }
2410
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002411 /*
2412 * The later open call will need any decryption secrets, and
2413 * bdrv_create() will purge "opts", so extract them now before
2414 * they are lost.
2415 */
2416 if (!skip_create) {
2417 open_opts = qdict_new();
2418 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
2419 }
2420
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002421 if (!skip_create) {
2422 /* Create the new image */
Chunyan Liuc282e1f2014-06-05 17:21:11 +08002423 ret = bdrv_create(drv, out_filename, opts, &local_err);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002424 if (ret < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002425 error_reportf_err(local_err, "%s: error while converting %s: ",
2426 out_filename, out_fmt);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002427 goto out;
bellardea2384d2004-08-01 21:59:26 +00002428 }
2429 }
ths3b46e622007-09-17 08:09:54 +00002430
Peter Lieven9fd77f92017-04-21 11:11:55 +02002431 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
Kevin Wolfce099542016-03-15 13:01:04 +01002432 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002433 if (ret < 0) {
2434 error_report("Invalid cache option: %s", cache);
Markus Armbrusterbb9cd2e2014-05-28 11:17:07 +02002435 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002436 }
2437
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002438 if (skip_create) {
2439 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002440 flags, writethrough, s.quiet, false);
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002441 } else {
2442 /* TODO ultimately we should allow --target-image-opts
2443 * to be used even when -n is not given.
2444 * That has to wait for bdrv_create to be improved
2445 * to allow filenames in option syntax
2446 */
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002447 s.target = img_open_file(out_filename, open_opts, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002448 flags, writethrough, s.quiet, false);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002449 open_opts = NULL; /* blk_new_open will have freed it */
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002450 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002451 if (!s.target) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002452 ret = -1;
2453 goto out;
2454 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002455 out_bs = blk_bs(s.target);
bellardea2384d2004-08-01 21:59:26 +00002456
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002457 if (s.compressed && !out_bs->drv->bdrv_co_pwritev_compressed) {
2458 error_report("Compression not supported for this file format");
2459 ret = -1;
2460 goto out;
2461 }
2462
Eric Blake5def6b82016-06-23 16:37:19 -06002463 /* increase bufsectors from the default 4096 (2M) if opt_transfer
Peter Lieven6360ab22018-07-13 09:15:39 +02002464 * or discard_alignment of the out_bs is greater. Limit to
2465 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2466 s.buf_sectors = MIN(MAX_BUF_SECTORS,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002467 MAX(s.buf_sectors,
2468 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2469 out_bs->bl.pdiscard_alignment >>
2470 BDRV_SECTOR_BITS)));
Peter Lievenf2521c92013-11-27 11:07:06 +01002471
Peter Lieven8dcd3c92018-07-12 15:00:10 +02002472 /* try to align the write requests to the destination to avoid unnecessary
2473 * RMW cycles. */
2474 s.alignment = MAX(pow2floor(s.min_sparse),
2475 DIV_ROUND_UP(out_bs->bl.request_alignment,
2476 BDRV_SECTOR_SIZE));
2477 assert(is_power_of_2(s.alignment));
2478
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002479 if (skip_create) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002480 int64_t output_sectors = blk_nb_sectors(s.target);
Markus Armbruster43716fa2014-06-26 13:23:21 +02002481 if (output_sectors < 0) {
Gongleieec5eb42015-02-25 12:22:27 +08002482 error_report("unable to get output image length: %s",
Markus Armbruster43716fa2014-06-26 13:23:21 +02002483 strerror(-output_sectors));
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002484 ret = -1;
2485 goto out;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002486 } else if (output_sectors < s.total_sectors) {
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002487 error_report("output file is smaller than input file");
2488 ret = -1;
2489 goto out;
2490 }
2491 }
2492
Max Reitz351c8ef2018-05-01 18:57:49 +02002493 if (s.target_has_backing) {
2494 /* Errors are treated as "backing length unknown" (which means
2495 * s.target_backing_sectors has to be negative, which it will
2496 * be automatically). The backing file length is used only
2497 * for optimizations, so such a case is not fatal. */
2498 s.target_backing_sectors = bdrv_nb_sectors(out_bs->backing->bs);
2499 } else {
2500 s.target_backing_sectors = -1;
2501 }
2502
Peter Lieven24f833c2013-11-27 11:07:07 +01002503 ret = bdrv_get_info(out_bs, &bdi);
2504 if (ret < 0) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002505 if (s.compressed) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002506 error_report("could not get block driver info");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002507 goto out;
2508 }
Peter Lieven24f833c2013-11-27 11:07:07 +01002509 } else {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002510 s.compressed = s.compressed || bdi.needs_compressed_writes;
2511 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
Max Reitz351c8ef2018-05-01 18:57:49 +02002512 s.unallocated_blocks_are_zero = bdi.unallocated_blocks_are_zero;
Peter Lieven24f833c2013-11-27 11:07:07 +01002513 }
2514
Peter Lieven9fd77f92017-04-21 11:11:55 +02002515 ret = convert_do_copy(&s);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002516out:
Peter Lieven13c28af2013-11-27 11:07:01 +01002517 if (!ret) {
2518 qemu_progress_print(100, 0);
2519 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002520 qemu_progress_end();
Chunyan Liu83d05212014-06-05 17:20:51 +08002521 qemu_opts_del(opts);
2522 qemu_opts_free(create_opts);
Markus Armbrusterfbf28a42014-09-29 16:07:55 +02002523 qemu_opts_del(sn_opts);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002524 qobject_unref(open_opts);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002525 blk_unref(s.target);
2526 if (s.src) {
2527 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2528 blk_unref(s.src[bs_i]);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002529 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002530 g_free(s.src);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002531 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002532 g_free(s.src_sectors);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002533fail_getopt:
2534 g_free(options);
2535
Peter Lieven9fd77f92017-04-21 11:11:55 +02002536 return !!ret;
bellardea2384d2004-08-01 21:59:26 +00002537}
2538
bellard57d1a2b2004-08-03 21:15:11 +00002539
bellardfaea38e2006-08-05 21:31:00 +00002540static void dump_snapshots(BlockDriverState *bs)
2541{
2542 QEMUSnapshotInfo *sn_tab, *sn;
2543 int nb_sns, i;
bellardfaea38e2006-08-05 21:31:00 +00002544
2545 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2546 if (nb_sns <= 0)
2547 return;
2548 printf("Snapshot list:\n");
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002549 bdrv_snapshot_dump(NULL);
Wenchao Xia5b917042013-05-25 11:09:45 +08002550 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002551 for(i = 0; i < nb_sns; i++) {
2552 sn = &sn_tab[i];
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002553 bdrv_snapshot_dump(sn);
Wenchao Xia5b917042013-05-25 11:09:45 +08002554 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002555 }
Anthony Liguori7267c092011-08-20 22:09:37 -05002556 g_free(sn_tab);
bellardfaea38e2006-08-05 21:31:00 +00002557}
2558
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002559static void dump_json_image_info_list(ImageInfoList *list)
2560{
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002561 QString *str;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002562 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002563 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002564
2565 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2566 visit_complete(v, &obj);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002567 str = qobject_to_json_pretty(obj);
2568 assert(str != NULL);
2569 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002570 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002571 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002572 qobject_unref(str);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002573}
2574
Benoît Canetc054b3f2012-09-05 13:09:02 +02002575static void dump_json_image_info(ImageInfo *info)
2576{
Benoît Canetc054b3f2012-09-05 13:09:02 +02002577 QString *str;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002578 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002579 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002580
2581 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2582 visit_complete(v, &obj);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002583 str = qobject_to_json_pretty(obj);
2584 assert(str != NULL);
2585 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002586 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002587 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002588 qobject_unref(str);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002589}
2590
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002591static void dump_human_image_info_list(ImageInfoList *list)
2592{
2593 ImageInfoList *elem;
2594 bool delim = false;
2595
2596 for (elem = list; elem; elem = elem->next) {
2597 if (delim) {
2598 printf("\n");
2599 }
2600 delim = true;
2601
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002602 bdrv_image_info_dump(elem->value);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002603 }
2604}
2605
2606static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2607{
2608 return strcmp(a, b) == 0;
2609}
2610
2611/**
2612 * Open an image file chain and return an ImageInfoList
2613 *
2614 * @filename: topmost image filename
2615 * @fmt: topmost image format (may be NULL to autodetect)
2616 * @chain: true - enumerate entire backing file chain
2617 * false - only topmost image file
2618 *
2619 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2620 * image file. If there was an error a message will have been printed to
2621 * stderr.
2622 */
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002623static ImageInfoList *collect_image_info_list(bool image_opts,
2624 const char *filename,
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002625 const char *fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002626 bool chain, bool force_share)
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002627{
2628 ImageInfoList *head = NULL;
2629 ImageInfoList **last = &head;
2630 GHashTable *filenames;
Wenchao Xia43526ec2013-06-06 12:27:58 +08002631 Error *err = NULL;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002632
2633 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2634
2635 while (filename) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02002636 BlockBackend *blk;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002637 BlockDriverState *bs;
2638 ImageInfo *info;
2639 ImageInfoList *elem;
2640
2641 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2642 error_report("Backing file '%s' creates an infinite loop.",
2643 filename);
2644 goto err;
2645 }
2646 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2647
Max Reitzefaa7c42016-03-16 19:54:38 +01002648 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002649 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2650 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002651 if (!blk) {
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002652 goto err;
2653 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002654 bs = blk_bs(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002655
Wenchao Xia43526ec2013-06-06 12:27:58 +08002656 bdrv_query_image_info(bs, &info, &err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002657 if (err) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01002658 error_report_err(err);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002659 blk_unref(blk);
Wenchao Xia43526ec2013-06-06 12:27:58 +08002660 goto err;
Wenchao Xiafb0ed452013-06-06 12:27:57 +08002661 }
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002662
2663 elem = g_new0(ImageInfoList, 1);
2664 elem->value = info;
2665 *last = elem;
2666 last = &elem->next;
2667
Markus Armbruster26f54e92014-10-07 13:59:04 +02002668 blk_unref(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002669
2670 filename = fmt = NULL;
2671 if (chain) {
2672 if (info->has_full_backing_filename) {
2673 filename = info->full_backing_filename;
2674 } else if (info->has_backing_filename) {
John Snow92d617a2015-12-14 14:55:15 -05002675 error_report("Could not determine absolute backing filename,"
2676 " but backing filename '%s' present",
2677 info->backing_filename);
2678 goto err;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002679 }
2680 if (info->has_backing_filename_format) {
2681 fmt = info->backing_filename_format;
2682 }
2683 }
2684 }
2685 g_hash_table_destroy(filenames);
2686 return head;
2687
2688err:
2689 qapi_free_ImageInfoList(head);
2690 g_hash_table_destroy(filenames);
2691 return NULL;
2692}
2693
Benoît Canetc054b3f2012-09-05 13:09:02 +02002694static int img_info(int argc, char **argv)
2695{
2696 int c;
2697 OutputFormat output_format = OFORMAT_HUMAN;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002698 bool chain = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002699 const char *filename, *fmt, *output;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002700 ImageInfoList *list;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002701 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08002702 bool force_share = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002703
bellardea2384d2004-08-01 21:59:26 +00002704 fmt = NULL;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002705 output = NULL;
bellardea2384d2004-08-01 21:59:26 +00002706 for(;;) {
Benoît Canetc054b3f2012-09-05 13:09:02 +02002707 int option_index = 0;
2708 static const struct option long_options[] = {
2709 {"help", no_argument, 0, 'h'},
2710 {"format", required_argument, 0, 'f'},
2711 {"output", required_argument, 0, OPTION_OUTPUT},
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002712 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002713 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002714 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002715 {"force-share", no_argument, 0, 'U'},
Benoît Canetc054b3f2012-09-05 13:09:02 +02002716 {0, 0, 0, 0}
2717 };
Fam Zheng335e9932017-05-03 00:35:39 +08002718 c = getopt_long(argc, argv, ":f:hU",
Benoît Canetc054b3f2012-09-05 13:09:02 +02002719 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002720 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002721 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002722 }
bellardea2384d2004-08-01 21:59:26 +00002723 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002724 case ':':
2725 missing_argument(argv[optind - 1]);
2726 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002727 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002728 unrecognized_option(argv[optind - 1]);
2729 break;
bellardea2384d2004-08-01 21:59:26 +00002730 case 'h':
2731 help();
2732 break;
2733 case 'f':
2734 fmt = optarg;
2735 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002736 case 'U':
2737 force_share = true;
2738 break;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002739 case OPTION_OUTPUT:
2740 output = optarg;
2741 break;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002742 case OPTION_BACKING_CHAIN:
2743 chain = true;
2744 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002745 case OPTION_OBJECT: {
2746 QemuOpts *opts;
2747 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2748 optarg, true);
2749 if (!opts) {
2750 return 1;
2751 }
2752 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002753 case OPTION_IMAGE_OPTS:
2754 image_opts = true;
2755 break;
bellardea2384d2004-08-01 21:59:26 +00002756 }
2757 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02002758 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08002759 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002760 }
bellardea2384d2004-08-01 21:59:26 +00002761 filename = argv[optind++];
2762
Benoît Canetc054b3f2012-09-05 13:09:02 +02002763 if (output && !strcmp(output, "json")) {
2764 output_format = OFORMAT_JSON;
2765 } else if (output && !strcmp(output, "human")) {
2766 output_format = OFORMAT_HUMAN;
2767 } else if (output) {
2768 error_report("--output must be used with human or json as argument.");
2769 return 1;
2770 }
2771
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002772 if (qemu_opts_foreach(&qemu_object_opts,
2773 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00002774 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002775 return 1;
2776 }
2777
Fam Zheng335e9932017-05-03 00:35:39 +08002778 list = collect_image_info_list(image_opts, filename, fmt, chain,
2779 force_share);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002780 if (!list) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002781 return 1;
2782 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002783
Benoît Canetc054b3f2012-09-05 13:09:02 +02002784 switch (output_format) {
2785 case OFORMAT_HUMAN:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002786 dump_human_image_info_list(list);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002787 break;
2788 case OFORMAT_JSON:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002789 if (chain) {
2790 dump_json_image_info_list(list);
2791 } else {
2792 dump_json_image_info(list->value);
2793 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002794 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002795 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002796
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002797 qapi_free_ImageInfoList(list);
bellardea2384d2004-08-01 21:59:26 +00002798 return 0;
2799}
2800
Eric Blake30065d12019-03-26 13:40:43 -05002801static int dump_map_entry(OutputFormat output_format, MapEntry *e,
2802 MapEntry *next)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002803{
2804 switch (output_format) {
2805 case OFORMAT_HUMAN:
Fam Zheng16b0d552016-01-26 11:59:02 +08002806 if (e->data && !e->has_offset) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002807 error_report("File contains external, encrypted or compressed clusters.");
Eric Blake30065d12019-03-26 13:40:43 -05002808 return -1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002809 }
Fam Zheng16b0d552016-01-26 11:59:02 +08002810 if (e->data && !e->zero) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002811 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
Fam Zheng16b0d552016-01-26 11:59:02 +08002812 e->start, e->length,
2813 e->has_offset ? e->offset : 0,
2814 e->has_filename ? e->filename : "");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002815 }
2816 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2817 * Modify the flags here to allow more coalescing.
2818 */
Fam Zheng16b0d552016-01-26 11:59:02 +08002819 if (next && (!next->data || next->zero)) {
2820 next->data = false;
2821 next->zero = true;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002822 }
2823 break;
2824 case OFORMAT_JSON:
Fam Zheng16b0d552016-01-26 11:59:02 +08002825 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
2826 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002827 (e->start == 0 ? "[" : ",\n"),
2828 e->start, e->length, e->depth,
Fam Zheng16b0d552016-01-26 11:59:02 +08002829 e->zero ? "true" : "false",
2830 e->data ? "true" : "false");
2831 if (e->has_offset) {
Paolo Bonzinic745bfb2013-09-11 18:47:52 +02002832 printf(", \"offset\": %"PRId64"", e->offset);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002833 }
2834 putchar('}');
2835
2836 if (!next) {
2837 printf("]\n");
2838 }
2839 break;
2840 }
Eric Blake30065d12019-03-26 13:40:43 -05002841 return 0;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002842}
2843
Eric Blake5e344dd2017-10-11 22:47:02 -05002844static int get_block_status(BlockDriverState *bs, int64_t offset,
2845 int64_t bytes, MapEntry *e)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002846{
Eric Blake237d78f2017-10-11 22:47:03 -05002847 int ret;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002848 int depth;
Fam Zheng67a0fd22016-01-26 11:58:48 +08002849 BlockDriverState *file;
John Snow28756452016-02-05 13:12:33 -05002850 bool has_offset;
Eric Blake237d78f2017-10-11 22:47:03 -05002851 int64_t map;
Max Reitzf30c66b2019-02-01 20:29:05 +01002852 char *filename = NULL;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002853
2854 /* As an optimization, we could cache the current range of unallocated
2855 * clusters in each file of the chain, and avoid querying the same
2856 * range repeatedly.
2857 */
2858
2859 depth = 0;
2860 for (;;) {
Eric Blake237d78f2017-10-11 22:47:03 -05002861 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002862 if (ret < 0) {
2863 return ret;
2864 }
Eric Blake237d78f2017-10-11 22:47:03 -05002865 assert(bytes);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002866 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2867 break;
2868 }
Kevin Wolf760e0062015-06-17 14:55:21 +02002869 bs = backing_bs(bs);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002870 if (bs == NULL) {
2871 ret = 0;
2872 break;
2873 }
2874
2875 depth++;
2876 }
2877
John Snow28756452016-02-05 13:12:33 -05002878 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
2879
Max Reitzf30c66b2019-02-01 20:29:05 +01002880 if (file && has_offset) {
2881 bdrv_refresh_filename(file);
2882 filename = file->filename;
2883 }
2884
John Snow28756452016-02-05 13:12:33 -05002885 *e = (MapEntry) {
Eric Blake5e344dd2017-10-11 22:47:02 -05002886 .start = offset,
Eric Blake237d78f2017-10-11 22:47:03 -05002887 .length = bytes,
John Snow28756452016-02-05 13:12:33 -05002888 .data = !!(ret & BDRV_BLOCK_DATA),
2889 .zero = !!(ret & BDRV_BLOCK_ZERO),
Eric Blake237d78f2017-10-11 22:47:03 -05002890 .offset = map,
John Snow28756452016-02-05 13:12:33 -05002891 .has_offset = has_offset,
2892 .depth = depth,
Max Reitzf30c66b2019-02-01 20:29:05 +01002893 .has_filename = filename,
2894 .filename = filename,
John Snow28756452016-02-05 13:12:33 -05002895 };
2896
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002897 return 0;
2898}
2899
Fam Zheng16b0d552016-01-26 11:59:02 +08002900static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
2901{
2902 if (curr->length == 0) {
2903 return false;
2904 }
2905 if (curr->zero != next->zero ||
2906 curr->data != next->data ||
2907 curr->depth != next->depth ||
2908 curr->has_filename != next->has_filename ||
2909 curr->has_offset != next->has_offset) {
2910 return false;
2911 }
2912 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
2913 return false;
2914 }
2915 if (curr->has_offset && curr->offset + curr->length != next->offset) {
2916 return false;
2917 }
2918 return true;
2919}
2920
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002921static int img_map(int argc, char **argv)
2922{
2923 int c;
2924 OutputFormat output_format = OFORMAT_HUMAN;
Markus Armbruster26f54e92014-10-07 13:59:04 +02002925 BlockBackend *blk;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002926 BlockDriverState *bs;
2927 const char *filename, *fmt, *output;
2928 int64_t length;
2929 MapEntry curr = { .length = 0 }, next;
2930 int ret = 0;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002931 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08002932 bool force_share = false;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002933
2934 fmt = NULL;
2935 output = NULL;
2936 for (;;) {
2937 int option_index = 0;
2938 static const struct option long_options[] = {
2939 {"help", no_argument, 0, 'h'},
2940 {"format", required_argument, 0, 'f'},
2941 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002942 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002943 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002944 {"force-share", no_argument, 0, 'U'},
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002945 {0, 0, 0, 0}
2946 };
Fam Zheng335e9932017-05-03 00:35:39 +08002947 c = getopt_long(argc, argv, ":f:hU",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002948 long_options, &option_index);
2949 if (c == -1) {
2950 break;
2951 }
2952 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002953 case ':':
2954 missing_argument(argv[optind - 1]);
2955 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002956 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002957 unrecognized_option(argv[optind - 1]);
2958 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002959 case 'h':
2960 help();
2961 break;
2962 case 'f':
2963 fmt = optarg;
2964 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002965 case 'U':
2966 force_share = true;
2967 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002968 case OPTION_OUTPUT:
2969 output = optarg;
2970 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002971 case OPTION_OBJECT: {
2972 QemuOpts *opts;
2973 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2974 optarg, true);
2975 if (!opts) {
2976 return 1;
2977 }
2978 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002979 case OPTION_IMAGE_OPTS:
2980 image_opts = true;
2981 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002982 }
2983 }
Fam Zhengac1307a2014-04-22 13:36:11 +08002984 if (optind != argc - 1) {
2985 error_exit("Expecting one image file name");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002986 }
Fam Zhengac1307a2014-04-22 13:36:11 +08002987 filename = argv[optind];
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002988
2989 if (output && !strcmp(output, "json")) {
2990 output_format = OFORMAT_JSON;
2991 } else if (output && !strcmp(output, "human")) {
2992 output_format = OFORMAT_HUMAN;
2993 } else if (output) {
2994 error_report("--output must be used with human or json as argument.");
2995 return 1;
2996 }
2997
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002998 if (qemu_opts_foreach(&qemu_object_opts,
2999 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00003000 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003001 return 1;
3002 }
3003
Fam Zheng335e9932017-05-03 00:35:39 +08003004 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003005 if (!blk) {
3006 return 1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003007 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003008 bs = blk_bs(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003009
3010 if (output_format == OFORMAT_HUMAN) {
3011 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
3012 }
3013
Max Reitzf1d3cd72015-02-05 13:58:18 -05003014 length = blk_getlength(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003015 while (curr.start + curr.length < length) {
Eric Blake5e344dd2017-10-11 22:47:02 -05003016 int64_t offset = curr.start + curr.length;
3017 int64_t n;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003018
3019 /* Probe up to 1 GiB at a time. */
Stefano Garzarella97ede572019-05-08 12:43:24 +02003020 n = MIN(1 * GiB, length - offset);
Eric Blake5e344dd2017-10-11 22:47:02 -05003021 ret = get_block_status(bs, offset, n, &next);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003022
3023 if (ret < 0) {
3024 error_report("Could not read file metadata: %s", strerror(-ret));
3025 goto out;
3026 }
3027
Fam Zheng16b0d552016-01-26 11:59:02 +08003028 if (entry_mergeable(&curr, &next)) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003029 curr.length += next.length;
3030 continue;
3031 }
3032
3033 if (curr.length > 0) {
Eric Blake30065d12019-03-26 13:40:43 -05003034 ret = dump_map_entry(output_format, &curr, &next);
3035 if (ret < 0) {
3036 goto out;
3037 }
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003038 }
3039 curr = next;
3040 }
3041
Eric Blake30065d12019-03-26 13:40:43 -05003042 ret = dump_map_entry(output_format, &curr, NULL);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003043
3044out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003045 blk_unref(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003046 return ret < 0;
3047}
3048
aliguorif7b4a942009-01-07 17:40:15 +00003049#define SNAPSHOT_LIST 1
3050#define SNAPSHOT_CREATE 2
3051#define SNAPSHOT_APPLY 3
3052#define SNAPSHOT_DELETE 4
3053
Stuart Brady153859b2009-06-07 00:42:17 +01003054static int img_snapshot(int argc, char **argv)
aliguorif7b4a942009-01-07 17:40:15 +00003055{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003056 BlockBackend *blk;
aliguorif7b4a942009-01-07 17:40:15 +00003057 BlockDriverState *bs;
3058 QEMUSnapshotInfo sn;
3059 char *filename, *snapshot_name = NULL;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003060 int c, ret = 0, bdrv_oflags;
aliguorif7b4a942009-01-07 17:40:15 +00003061 int action = 0;
3062 qemu_timeval tv;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003063 bool quiet = false;
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003064 Error *err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003065 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003066 bool force_share = false;
aliguorif7b4a942009-01-07 17:40:15 +00003067
Kevin Wolfce099542016-03-15 13:01:04 +01003068 bdrv_oflags = BDRV_O_RDWR;
aliguorif7b4a942009-01-07 17:40:15 +00003069 /* Parse commandline parameters */
3070 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003071 static const struct option long_options[] = {
3072 {"help", no_argument, 0, 'h'},
3073 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003074 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003075 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003076 {0, 0, 0, 0}
3077 };
Fam Zheng335e9932017-05-03 00:35:39 +08003078 c = getopt_long(argc, argv, ":la:c:d:hqU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003079 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003080 if (c == -1) {
aliguorif7b4a942009-01-07 17:40:15 +00003081 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003082 }
aliguorif7b4a942009-01-07 17:40:15 +00003083 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003084 case ':':
3085 missing_argument(argv[optind - 1]);
3086 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003087 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003088 unrecognized_option(argv[optind - 1]);
3089 break;
aliguorif7b4a942009-01-07 17:40:15 +00003090 case 'h':
3091 help();
Stuart Brady153859b2009-06-07 00:42:17 +01003092 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003093 case 'l':
3094 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003095 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003096 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003097 }
3098 action = SNAPSHOT_LIST;
Naphtali Spreif5edb012010-01-17 16:48:13 +02003099 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
aliguorif7b4a942009-01-07 17:40:15 +00003100 break;
3101 case 'a':
3102 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003103 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003104 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003105 }
3106 action = SNAPSHOT_APPLY;
3107 snapshot_name = optarg;
3108 break;
3109 case 'c':
3110 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003111 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003112 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003113 }
3114 action = SNAPSHOT_CREATE;
3115 snapshot_name = optarg;
3116 break;
3117 case 'd':
3118 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003119 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003120 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003121 }
3122 action = SNAPSHOT_DELETE;
3123 snapshot_name = optarg;
3124 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003125 case 'q':
3126 quiet = true;
3127 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003128 case 'U':
3129 force_share = true;
3130 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003131 case OPTION_OBJECT: {
3132 QemuOpts *opts;
3133 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3134 optarg, true);
3135 if (!opts) {
3136 return 1;
3137 }
3138 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003139 case OPTION_IMAGE_OPTS:
3140 image_opts = true;
3141 break;
aliguorif7b4a942009-01-07 17:40:15 +00003142 }
3143 }
3144
Kevin Wolffc11eb22013-08-05 10:53:04 +02003145 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003146 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003147 }
aliguorif7b4a942009-01-07 17:40:15 +00003148 filename = argv[optind++];
3149
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003150 if (qemu_opts_foreach(&qemu_object_opts,
3151 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00003152 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003153 return 1;
3154 }
3155
aliguorif7b4a942009-01-07 17:40:15 +00003156 /* Open the image */
Fam Zheng335e9932017-05-03 00:35:39 +08003157 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3158 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003159 if (!blk) {
3160 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003161 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003162 bs = blk_bs(blk);
aliguorif7b4a942009-01-07 17:40:15 +00003163
3164 /* Perform the requested action */
3165 switch(action) {
3166 case SNAPSHOT_LIST:
3167 dump_snapshots(bs);
3168 break;
3169
3170 case SNAPSHOT_CREATE:
3171 memset(&sn, 0, sizeof(sn));
3172 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3173
3174 qemu_gettimeofday(&tv);
3175 sn.date_sec = tv.tv_sec;
3176 sn.date_nsec = tv.tv_usec * 1000;
3177
3178 ret = bdrv_snapshot_create(bs, &sn);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003179 if (ret) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003180 error_report("Could not create snapshot '%s': %d (%s)",
aliguorif7b4a942009-01-07 17:40:15 +00003181 snapshot_name, ret, strerror(-ret));
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003182 }
aliguorif7b4a942009-01-07 17:40:15 +00003183 break;
3184
3185 case SNAPSHOT_APPLY:
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003186 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003187 if (ret) {
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003188 error_reportf_err(err, "Could not apply snapshot '%s': ",
3189 snapshot_name);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003190 }
aliguorif7b4a942009-01-07 17:40:15 +00003191 break;
3192
3193 case SNAPSHOT_DELETE:
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003194 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3195 if (ret < 0) {
3196 error_report("Could not delete snapshot '%s': snapshot not "
3197 "found", snapshot_name);
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003198 ret = 1;
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003199 } else {
3200 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3201 if (ret < 0) {
3202 error_reportf_err(err, "Could not delete snapshot '%s': ",
3203 snapshot_name);
3204 ret = 1;
3205 }
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003206 }
aliguorif7b4a942009-01-07 17:40:15 +00003207 break;
3208 }
3209
3210 /* Cleanup */
Markus Armbruster26f54e92014-10-07 13:59:04 +02003211 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003212 if (ret) {
3213 return 1;
3214 }
Stuart Brady153859b2009-06-07 00:42:17 +01003215 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003216}
3217
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003218static int img_rebase(int argc, char **argv)
3219{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003220 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
Paolo Bonzini396374c2016-02-25 23:53:54 +01003221 uint8_t *buf_old = NULL;
3222 uint8_t *buf_new = NULL;
Sam Eiderman863cc782019-05-23 19:33:36 +03003223 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003224 char *filename;
Max Reitz40055952014-07-22 22:58:42 +02003225 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3226 int c, flags, src_flags, ret;
Kevin Wolfce099542016-03-15 13:01:04 +01003227 bool writethrough, src_writethrough;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003228 int unsafe = 0;
Fam Zheng335e9932017-05-03 00:35:39 +08003229 bool force_share = false;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003230 int progress = 0;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003231 bool quiet = false;
Max Reitz34b5d2c2013-09-05 14:45:29 +02003232 Error *local_err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003233 bool image_opts = false;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003234
3235 /* Parse commandline parameters */
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003236 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003237 cache = BDRV_DEFAULT_CACHE;
Max Reitz40055952014-07-22 22:58:42 +02003238 src_cache = BDRV_DEFAULT_CACHE;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003239 out_baseimg = NULL;
3240 out_basefmt = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003241 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003242 static const struct option long_options[] = {
3243 {"help", no_argument, 0, 'h'},
3244 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003245 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003246 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003247 {0, 0, 0, 0}
3248 };
Fam Zheng335e9932017-05-03 00:35:39 +08003249 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003250 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003251 if (c == -1) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003252 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003253 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003254 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003255 case ':':
3256 missing_argument(argv[optind - 1]);
3257 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003258 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003259 unrecognized_option(argv[optind - 1]);
3260 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003261 case 'h':
3262 help();
3263 return 0;
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003264 case 'f':
3265 fmt = optarg;
3266 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003267 case 'F':
3268 out_basefmt = optarg;
3269 break;
3270 case 'b':
3271 out_baseimg = optarg;
3272 break;
3273 case 'u':
3274 unsafe = 1;
3275 break;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003276 case 'p':
3277 progress = 1;
3278 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003279 case 't':
3280 cache = optarg;
3281 break;
Max Reitz40055952014-07-22 22:58:42 +02003282 case 'T':
3283 src_cache = optarg;
3284 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003285 case 'q':
3286 quiet = true;
3287 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003288 case OPTION_OBJECT: {
3289 QemuOpts *opts;
3290 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3291 optarg, true);
3292 if (!opts) {
3293 return 1;
3294 }
3295 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003296 case OPTION_IMAGE_OPTS:
3297 image_opts = true;
3298 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003299 case 'U':
3300 force_share = true;
3301 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003302 }
3303 }
3304
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003305 if (quiet) {
3306 progress = 0;
3307 }
3308
Fam Zhengac1307a2014-04-22 13:36:11 +08003309 if (optind != argc - 1) {
3310 error_exit("Expecting one image file name");
3311 }
3312 if (!unsafe && !out_baseimg) {
3313 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003314 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003315 filename = argv[optind++];
3316
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003317 if (qemu_opts_foreach(&qemu_object_opts,
3318 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00003319 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003320 return 1;
3321 }
3322
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003323 qemu_progress_init(progress, 2.0);
3324 qemu_progress_print(0, 100);
3325
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003326 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
Kevin Wolfce099542016-03-15 13:01:04 +01003327 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003328 if (ret < 0) {
3329 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003330 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003331 }
3332
Kevin Wolfce099542016-03-15 13:01:04 +01003333 src_flags = 0;
3334 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
Max Reitz40055952014-07-22 22:58:42 +02003335 if (ret < 0) {
3336 error_report("Invalid source cache option: %s", src_cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003337 goto out;
Max Reitz40055952014-07-22 22:58:42 +02003338 }
3339
Kevin Wolfce099542016-03-15 13:01:04 +01003340 /* The source files are opened read-only, don't care about WCE */
3341 assert((src_flags & BDRV_O_RDWR) == 0);
3342 (void) src_writethrough;
3343
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003344 /*
3345 * Open the images.
3346 *
3347 * Ignore the old backing file for unsafe rebase in case we want to correct
3348 * the reference to a renamed or moved backing file.
3349 */
Fam Zheng335e9932017-05-03 00:35:39 +08003350 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3351 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003352 if (!blk) {
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003353 ret = -1;
3354 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003355 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003356 bs = blk_bs(blk);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003357
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003358 if (out_basefmt != NULL) {
Max Reitz644483d2015-02-05 13:58:17 -05003359 if (bdrv_find_format(out_basefmt) == NULL) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003360 error_report("Invalid format name: '%s'", out_basefmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003361 ret = -1;
3362 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003363 }
3364 }
3365
3366 /* For safe rebasing we need to compare old and new backing file */
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003367 if (!unsafe) {
Max Reitz644483d2015-02-05 13:58:17 -05003368 QDict *options = NULL;
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003369 BlockDriverState *base_bs = backing_bs(bs);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003370
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003371 if (base_bs) {
Kevin Wolfd861ab32019-04-25 14:25:10 +02003372 blk_old_backing = blk_new(qemu_get_aio_context(),
3373 BLK_PERM_CONSISTENT_READ,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003374 BLK_PERM_ALL);
3375 ret = blk_insert_bs(blk_old_backing, base_bs,
3376 &local_err);
3377 if (ret < 0) {
Max Reitz35ddd932019-05-09 19:52:35 +02003378 error_reportf_err(local_err,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003379 "Could not reuse old backing file '%s': ",
3380 base_bs->filename);
Max Reitz35ddd932019-05-09 19:52:35 +02003381 goto out;
3382 }
3383 } else {
3384 blk_old_backing = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003385 }
Max Reitz644483d2015-02-05 13:58:17 -05003386
Alex Bligha6166732012-10-16 13:46:18 +01003387 if (out_baseimg[0]) {
Max Reitzd16699b2018-05-09 20:20:01 +02003388 const char *overlay_filename;
3389 char *out_real_path;
3390
Fam Zheng335e9932017-05-03 00:35:39 +08003391 options = qdict_new();
Max Reitz644483d2015-02-05 13:58:17 -05003392 if (out_basefmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003393 qdict_put_str(options, "driver", out_basefmt);
Fam Zheng335e9932017-05-03 00:35:39 +08003394 }
3395 if (force_share) {
3396 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Max Reitz644483d2015-02-05 13:58:17 -05003397 }
3398
Max Reitzf30c66b2019-02-01 20:29:05 +01003399 bdrv_refresh_filename(bs);
Max Reitzd16699b2018-05-09 20:20:01 +02003400 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3401 : bs->filename;
Max Reitz645ae7d2019-02-01 20:29:14 +01003402 out_real_path =
3403 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3404 out_baseimg,
3405 &local_err);
Max Reitzd16699b2018-05-09 20:20:01 +02003406 if (local_err) {
Max Reitzf22356d2019-05-28 21:53:38 +02003407 qobject_unref(options);
Max Reitzd16699b2018-05-09 20:20:01 +02003408 error_reportf_err(local_err,
3409 "Could not resolve backing filename: ");
3410 ret = -1;
Max Reitzd16699b2018-05-09 20:20:01 +02003411 goto out;
3412 }
3413
Sam Eiderman863cc782019-05-23 19:33:36 +03003414 /*
3415 * Find out whether we rebase an image on top of a previous image
3416 * in its chain.
3417 */
3418 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
Sam Eiderman330c7292019-05-23 19:33:37 +03003419 if (prefix_chain_bs) {
Max Reitzf22356d2019-05-28 21:53:38 +02003420 qobject_unref(options);
Sam Eiderman330c7292019-05-23 19:33:37 +03003421 g_free(out_real_path);
Max Reitzf22356d2019-05-28 21:53:38 +02003422
Kevin Wolfd861ab32019-04-25 14:25:10 +02003423 blk_new_backing = blk_new(qemu_get_aio_context(),
3424 BLK_PERM_CONSISTENT_READ,
Sam Eiderman330c7292019-05-23 19:33:37 +03003425 BLK_PERM_ALL);
3426 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
3427 &local_err);
3428 if (ret < 0) {
3429 error_reportf_err(local_err,
3430 "Could not reuse backing file '%s': ",
3431 out_baseimg);
3432 goto out;
3433 }
3434 } else {
3435 blk_new_backing = blk_new_open(out_real_path, NULL,
3436 options, src_flags, &local_err);
3437 g_free(out_real_path);
3438 if (!blk_new_backing) {
3439 error_reportf_err(local_err,
3440 "Could not open new backing file '%s': ",
3441 out_baseimg);
3442 ret = -1;
3443 goto out;
3444 }
Alex Bligha6166732012-10-16 13:46:18 +01003445 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003446 }
3447 }
3448
3449 /*
3450 * Check each unallocated cluster in the COW file. If it is unallocated,
3451 * accesses go to the backing file. We must therefore compare this cluster
3452 * in the old and new backing file, and if they differ we need to copy it
3453 * from the old backing file into the COW file.
3454 *
3455 * If qemu-img crashes during this step, no harm is done. The content of
3456 * the image is the same as the original one at any time.
3457 */
3458 if (!unsafe) {
Eric Blake41536282017-10-11 22:47:15 -05003459 int64_t size;
Max Reitz35ddd932019-05-09 19:52:35 +02003460 int64_t old_backing_size = 0;
Eric Blake41536282017-10-11 22:47:15 -05003461 int64_t new_backing_size = 0;
3462 uint64_t offset;
3463 int64_t n;
Kevin Wolf1f710492012-10-12 14:29:18 +02003464 float local_progress = 0;
TeLeMand6771bf2010-02-08 16:20:00 +08003465
Max Reitzf1d3cd72015-02-05 13:58:18 -05003466 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3467 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003468
Eric Blake41536282017-10-11 22:47:15 -05003469 size = blk_getlength(blk);
3470 if (size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003471 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003472 filename, strerror(-size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003473 ret = -1;
3474 goto out;
3475 }
Max Reitz35ddd932019-05-09 19:52:35 +02003476 if (blk_old_backing) {
3477 old_backing_size = blk_getlength(blk_old_backing);
3478 if (old_backing_size < 0) {
3479 char backing_name[PATH_MAX];
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003480
Max Reitz35ddd932019-05-09 19:52:35 +02003481 bdrv_get_backing_filename(bs, backing_name,
3482 sizeof(backing_name));
3483 error_report("Could not get size of '%s': %s",
3484 backing_name, strerror(-old_backing_size));
3485 ret = -1;
3486 goto out;
3487 }
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003488 }
Max Reitzf1d3cd72015-02-05 13:58:18 -05003489 if (blk_new_backing) {
Eric Blake41536282017-10-11 22:47:15 -05003490 new_backing_size = blk_getlength(blk_new_backing);
3491 if (new_backing_size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003492 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003493 out_baseimg, strerror(-new_backing_size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003494 ret = -1;
3495 goto out;
3496 }
Alex Bligha6166732012-10-16 13:46:18 +01003497 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003498
Eric Blake41536282017-10-11 22:47:15 -05003499 if (size != 0) {
3500 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
Kevin Wolf1f710492012-10-12 14:29:18 +02003501 }
3502
Eric Blake41536282017-10-11 22:47:15 -05003503 for (offset = 0; offset < size; offset += n) {
Max Reitz1c6e8772019-05-09 19:52:36 +02003504 bool buf_old_is_zero = false;
3505
Eric Blake41536282017-10-11 22:47:15 -05003506 /* How many bytes can we handle with the next read? */
3507 n = MIN(IO_BUF_SIZE, size - offset);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003508
3509 /* If the cluster is allocated, we don't need to take action */
Eric Blake41536282017-10-11 22:47:15 -05003510 ret = bdrv_is_allocated(bs, offset, n, &n);
Paolo Bonzinid6636402013-09-04 19:00:25 +02003511 if (ret < 0) {
3512 error_report("error while reading image metadata: %s",
3513 strerror(-ret));
3514 goto out;
3515 }
Kevin Wolfcc60e322010-04-29 14:47:48 +02003516 if (ret) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003517 continue;
3518 }
3519
Sam Eiderman863cc782019-05-23 19:33:36 +03003520 if (prefix_chain_bs) {
3521 /*
3522 * If cluster wasn't changed since prefix_chain, we don't need
3523 * to take action
3524 */
3525 ret = bdrv_is_allocated_above(backing_bs(bs), prefix_chain_bs,
Andrey Shinkevich170d3bd2019-05-29 20:56:14 +03003526 false, offset, n, &n);
Sam Eiderman863cc782019-05-23 19:33:36 +03003527 if (ret < 0) {
3528 error_report("error while reading image metadata: %s",
3529 strerror(-ret));
3530 goto out;
3531 }
3532 if (!ret) {
3533 continue;
3534 }
3535 }
3536
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003537 /*
3538 * Read old and new backing file and take into consideration that
3539 * backing files may be smaller than the COW image.
3540 */
Eric Blake41536282017-10-11 22:47:15 -05003541 if (offset >= old_backing_size) {
3542 memset(buf_old, 0, n);
Max Reitz1c6e8772019-05-09 19:52:36 +02003543 buf_old_is_zero = true;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003544 } else {
Eric Blake41536282017-10-11 22:47:15 -05003545 if (offset + n > old_backing_size) {
3546 n = old_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003547 }
3548
Eric Blake41536282017-10-11 22:47:15 -05003549 ret = blk_pread(blk_old_backing, offset, buf_old, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003550 if (ret < 0) {
3551 error_report("error while reading from old backing file");
3552 goto out;
3553 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003554 }
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003555
Eric Blake41536282017-10-11 22:47:15 -05003556 if (offset >= new_backing_size || !blk_new_backing) {
3557 memset(buf_new, 0, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003558 } else {
Eric Blake41536282017-10-11 22:47:15 -05003559 if (offset + n > new_backing_size) {
3560 n = new_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003561 }
3562
Eric Blake41536282017-10-11 22:47:15 -05003563 ret = blk_pread(blk_new_backing, offset, buf_new, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003564 if (ret < 0) {
3565 error_report("error while reading from new backing file");
3566 goto out;
3567 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003568 }
3569
3570 /* If they differ, we need to write to the COW file */
3571 uint64_t written = 0;
3572
Eric Blake41536282017-10-11 22:47:15 -05003573 while (written < n) {
Eric Blakedc61cd32017-10-11 22:47:14 -05003574 int64_t pnum;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003575
Eric Blake41536282017-10-11 22:47:15 -05003576 if (compare_buffers(buf_old + written, buf_new + written,
3577 n - written, &pnum))
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003578 {
Max Reitz1c6e8772019-05-09 19:52:36 +02003579 if (buf_old_is_zero) {
3580 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0);
3581 } else {
3582 ret = blk_pwrite(blk, offset + written,
3583 buf_old + written, pnum, 0);
3584 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003585 if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003586 error_report("Error while writing to COW image: %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003587 strerror(-ret));
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003588 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003589 }
3590 }
3591
3592 written += pnum;
3593 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003594 qemu_progress_print(local_progress, 100);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003595 }
3596 }
3597
3598 /*
3599 * Change the backing file. All clusters that are different from the old
3600 * backing file are overwritten in the COW file now, so the visible content
3601 * doesn't change when we switch the backing file.
3602 */
Alex Bligha6166732012-10-16 13:46:18 +01003603 if (out_baseimg && *out_baseimg) {
3604 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
3605 } else {
3606 ret = bdrv_change_backing_file(bs, NULL, NULL);
3607 }
3608
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003609 if (ret == -ENOSPC) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003610 error_report("Could not change the backing file to '%s': No "
3611 "space left in the file header", out_baseimg);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003612 } else if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003613 error_report("Could not change the backing file to '%s': %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003614 out_baseimg, strerror(-ret));
3615 }
3616
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003617 qemu_progress_print(100, 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003618 /*
3619 * TODO At this point it is possible to check if any clusters that are
3620 * allocated in the COW file are the same in the backing file. If so, they
3621 * could be dropped from the COW file. Don't do this before switching the
3622 * backing file, in case of a crash this would lead to corruption.
3623 */
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003624out:
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003625 qemu_progress_end();
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003626 /* Cleanup */
3627 if (!unsafe) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02003628 blk_unref(blk_old_backing);
Markus Armbruster26f54e92014-10-07 13:59:04 +02003629 blk_unref(blk_new_backing);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003630 }
Paolo Bonzini396374c2016-02-25 23:53:54 +01003631 qemu_vfree(buf_old);
3632 qemu_vfree(buf_new);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003633
Markus Armbruster26f54e92014-10-07 13:59:04 +02003634 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003635 if (ret) {
3636 return 1;
3637 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003638 return 0;
3639}
3640
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003641static int img_resize(int argc, char **argv)
3642{
Markus Armbruster6750e792015-02-12 17:43:08 +01003643 Error *err = NULL;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003644 int c, ret, relative;
3645 const char *filename, *fmt, *size;
Max Reitz5279b302018-04-21 18:39:57 +02003646 int64_t n, total_size, current_size, new_size;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003647 bool quiet = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003648 BlockBackend *blk = NULL;
Max Reitzdc5f6902017-06-13 22:20:55 +02003649 PreallocMode prealloc = PREALLOC_MODE_OFF;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003650 QemuOpts *param;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003651
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003652 static QemuOptsList resize_options = {
3653 .name = "resize_options",
3654 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3655 .desc = {
3656 {
3657 .name = BLOCK_OPT_SIZE,
3658 .type = QEMU_OPT_SIZE,
3659 .help = "Virtual disk size"
3660 }, {
3661 /* end of list */
3662 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003663 },
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003664 };
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003665 bool image_opts = false;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003666 bool shrink = false;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003667
Kevin Wolfe80fec72011-04-29 10:58:12 +02003668 /* Remove size from argv manually so that negative numbers are not treated
3669 * as options by getopt. */
3670 if (argc < 3) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003671 error_exit("Not enough arguments");
Kevin Wolfe80fec72011-04-29 10:58:12 +02003672 return 1;
3673 }
3674
3675 size = argv[--argc];
3676
3677 /* Parse getopt arguments */
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003678 fmt = NULL;
3679 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003680 static const struct option long_options[] = {
3681 {"help", no_argument, 0, 'h'},
3682 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003683 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Max Reitzdc5f6902017-06-13 22:20:55 +02003684 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003685 {"shrink", no_argument, 0, OPTION_SHRINK},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003686 {0, 0, 0, 0}
3687 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003688 c = getopt_long(argc, argv, ":f:hq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003689 long_options, NULL);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003690 if (c == -1) {
3691 break;
3692 }
3693 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003694 case ':':
3695 missing_argument(argv[optind - 1]);
3696 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003697 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003698 unrecognized_option(argv[optind - 1]);
3699 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003700 case 'h':
3701 help();
3702 break;
3703 case 'f':
3704 fmt = optarg;
3705 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003706 case 'q':
3707 quiet = true;
3708 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003709 case OPTION_OBJECT: {
3710 QemuOpts *opts;
3711 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3712 optarg, true);
3713 if (!opts) {
3714 return 1;
3715 }
3716 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003717 case OPTION_IMAGE_OPTS:
3718 image_opts = true;
3719 break;
Max Reitzdc5f6902017-06-13 22:20:55 +02003720 case OPTION_PREALLOCATION:
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02003721 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
Markus Armbruster06c60b62017-08-24 10:45:57 +02003722 PREALLOC_MODE__MAX, NULL);
Max Reitzdc5f6902017-06-13 22:20:55 +02003723 if (prealloc == PREALLOC_MODE__MAX) {
3724 error_report("Invalid preallocation mode '%s'", optarg);
3725 return 1;
3726 }
3727 break;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003728 case OPTION_SHRINK:
3729 shrink = true;
3730 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003731 }
3732 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02003733 if (optind != argc - 1) {
Max Reitzbe8fbd42018-02-05 17:27:45 +01003734 error_exit("Expecting image file name and size");
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003735 }
3736 filename = argv[optind++];
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003737
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003738 if (qemu_opts_foreach(&qemu_object_opts,
3739 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00003740 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003741 return 1;
3742 }
3743
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003744 /* Choose grow, shrink, or absolute resize mode */
3745 switch (size[0]) {
3746 case '+':
3747 relative = 1;
3748 size++;
3749 break;
3750 case '-':
3751 relative = -1;
3752 size++;
3753 break;
3754 default:
3755 relative = 0;
3756 break;
3757 }
3758
3759 /* Parse size */
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -08003760 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
Markus Armbrusterf43e47d2015-02-12 17:52:20 +01003761 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +01003762 if (err) {
3763 error_report_err(err);
Jes Sorensen2a819982010-12-06 17:08:31 +01003764 ret = -1;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003765 qemu_opts_del(param);
Jes Sorensen2a819982010-12-06 17:08:31 +01003766 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003767 }
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003768 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3769 qemu_opts_del(param);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003770
Max Reitzefaa7c42016-03-16 19:54:38 +01003771 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08003772 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
3773 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003774 if (!blk) {
Jes Sorensen2a819982010-12-06 17:08:31 +01003775 ret = -1;
3776 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003777 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003778
Max Reitzdc5f6902017-06-13 22:20:55 +02003779 current_size = blk_getlength(blk);
3780 if (current_size < 0) {
3781 error_report("Failed to inquire current image length: %s",
3782 strerror(-current_size));
3783 ret = -1;
3784 goto out;
3785 }
3786
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003787 if (relative) {
Max Reitzdc5f6902017-06-13 22:20:55 +02003788 total_size = current_size + n * relative;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003789 } else {
3790 total_size = n;
3791 }
3792 if (total_size <= 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003793 error_report("New image size must be positive");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003794 ret = -1;
3795 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003796 }
3797
Max Reitzdc5f6902017-06-13 22:20:55 +02003798 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
3799 error_report("Preallocation can only be used for growing images");
3800 ret = -1;
3801 goto out;
3802 }
3803
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003804 if (total_size < current_size && !shrink) {
3805 warn_report("Shrinking an image will delete all data beyond the "
3806 "shrunken image's end. Before performing such an "
3807 "operation, make sure there is no important data there.");
3808
3809 if (g_strcmp0(bdrv_get_format_name(blk_bs(blk)), "raw") != 0) {
3810 error_report(
3811 "Use the --shrink option to perform a shrink operation.");
3812 ret = -1;
3813 goto out;
3814 } else {
3815 warn_report("Using the --shrink option will suppress this message. "
3816 "Note that future versions of qemu-img may refuse to "
3817 "shrink images without this option.");
3818 }
3819 }
3820
Max Reitzdc5f6902017-06-13 22:20:55 +02003821 ret = blk_truncate(blk, total_size, prealloc, &err);
Max Reitz5279b302018-04-21 18:39:57 +02003822 if (ret < 0) {
Max Reitzed3d2ec2017-03-28 22:51:27 +02003823 error_report_err(err);
Max Reitz5279b302018-04-21 18:39:57 +02003824 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003825 }
Max Reitz5279b302018-04-21 18:39:57 +02003826
3827 new_size = blk_getlength(blk);
3828 if (new_size < 0) {
3829 error_report("Failed to verify truncated image length: %s",
3830 strerror(-new_size));
3831 ret = -1;
3832 goto out;
3833 }
3834
3835 /* Some block drivers implement a truncation method, but only so
3836 * the user can cause qemu to refresh the image's size from disk.
3837 * The idea is that the user resizes the image outside of qemu and
3838 * then invokes block_resize to inform qemu about it.
3839 * (This includes iscsi and file-posix for device files.)
3840 * Of course, that is not the behavior someone invoking
3841 * qemu-img resize would find useful, so we catch that behavior
3842 * here and tell the user. */
3843 if (new_size != total_size && new_size == current_size) {
3844 error_report("Image was not resized; resizing may not be supported "
3845 "for this image");
3846 ret = -1;
3847 goto out;
3848 }
3849
3850 if (new_size != total_size) {
3851 warn_report("Image should have been resized to %" PRIi64
3852 " bytes, but was resized to %" PRIi64 " bytes",
3853 total_size, new_size);
3854 }
3855
3856 qprintf(quiet, "Image resized.\n");
3857
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003858out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003859 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003860 if (ret) {
3861 return 1;
3862 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003863 return 0;
3864}
3865
Max Reitz76a3a342014-10-27 11:12:51 +01003866static void amend_status_cb(BlockDriverState *bs,
Max Reitz8b139762015-07-27 17:51:32 +02003867 int64_t offset, int64_t total_work_size,
3868 void *opaque)
Max Reitz76a3a342014-10-27 11:12:51 +01003869{
3870 qemu_progress_print(100.f * offset / total_work_size, 0);
3871}
3872
Max Reitz51641352018-05-09 23:00:20 +02003873static int print_amend_option_help(const char *format)
3874{
3875 BlockDriver *drv;
3876
3877 /* Find driver and parse its options */
3878 drv = bdrv_find_format(format);
3879 if (!drv) {
3880 error_report("Unknown file format '%s'", format);
3881 return 1;
3882 }
3883
3884 if (!drv->bdrv_amend_options) {
3885 error_report("Format driver '%s' does not support option amendment",
3886 format);
3887 return 1;
3888 }
3889
3890 /* Every driver supporting amendment must have create_opts */
3891 assert(drv->create_opts);
3892
3893 printf("Creation options for '%s':\n", format);
Max Reitz63898712018-10-19 18:49:25 +02003894 qemu_opts_print_help(drv->create_opts, false);
Max Reitz51641352018-05-09 23:00:20 +02003895 printf("\nNote that not all of these options may be amendable.\n");
3896 return 0;
3897}
3898
Max Reitz6f176b42013-09-03 10:09:50 +02003899static int img_amend(int argc, char **argv)
3900{
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01003901 Error *err = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02003902 int c, ret = 0;
3903 char *options = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08003904 QemuOptsList *create_opts = NULL;
3905 QemuOpts *opts = NULL;
Max Reitzbd39e6e2014-07-22 22:58:43 +02003906 const char *fmt = NULL, *filename, *cache;
3907 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01003908 bool writethrough;
Max Reitz76a3a342014-10-27 11:12:51 +01003909 bool quiet = false, progress = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003910 BlockBackend *blk = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02003911 BlockDriverState *bs = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003912 bool image_opts = false;
Max Reitz6f176b42013-09-03 10:09:50 +02003913
Max Reitzbd39e6e2014-07-22 22:58:43 +02003914 cache = BDRV_DEFAULT_CACHE;
Max Reitz6f176b42013-09-03 10:09:50 +02003915 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003916 static const struct option long_options[] = {
3917 {"help", no_argument, 0, 'h'},
3918 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003919 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003920 {0, 0, 0, 0}
3921 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003922 c = getopt_long(argc, argv, ":ho:f:t:pq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003923 long_options, NULL);
Max Reitz6f176b42013-09-03 10:09:50 +02003924 if (c == -1) {
3925 break;
3926 }
3927
3928 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003929 case ':':
3930 missing_argument(argv[optind - 1]);
3931 break;
Stefan Hajnoczif7077622017-03-17 18:45:40 +08003932 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003933 unrecognized_option(argv[optind - 1]);
3934 break;
3935 case 'h':
Stefan Hajnoczif7077622017-03-17 18:45:40 +08003936 help();
3937 break;
3938 case 'o':
3939 if (!is_valid_option_list(optarg)) {
3940 error_report("Invalid option list: %s", optarg);
3941 ret = -1;
3942 goto out_no_progress;
3943 }
3944 if (!options) {
3945 options = g_strdup(optarg);
3946 } else {
3947 char *old_options = options;
3948 options = g_strdup_printf("%s,%s", options, optarg);
3949 g_free(old_options);
3950 }
3951 break;
3952 case 'f':
3953 fmt = optarg;
3954 break;
3955 case 't':
3956 cache = optarg;
3957 break;
3958 case 'p':
3959 progress = true;
3960 break;
3961 case 'q':
3962 quiet = true;
3963 break;
3964 case OPTION_OBJECT:
3965 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3966 optarg, true);
3967 if (!opts) {
3968 ret = -1;
3969 goto out_no_progress;
3970 }
3971 break;
3972 case OPTION_IMAGE_OPTS:
3973 image_opts = true;
3974 break;
Max Reitz6f176b42013-09-03 10:09:50 +02003975 }
3976 }
3977
Max Reitz6f176b42013-09-03 10:09:50 +02003978 if (!options) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003979 error_exit("Must specify options (-o)");
Max Reitz6f176b42013-09-03 10:09:50 +02003980 }
3981
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003982 if (qemu_opts_foreach(&qemu_object_opts,
3983 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00003984 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003985 ret = -1;
3986 goto out_no_progress;
3987 }
3988
Max Reitz76a3a342014-10-27 11:12:51 +01003989 if (quiet) {
3990 progress = false;
3991 }
3992 qemu_progress_init(progress, 1.0);
3993
Kevin Wolfa283cb62014-02-21 16:24:07 +01003994 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
3995 if (fmt && has_help_option(options)) {
3996 /* If a format is explicitly specified (and possibly no filename is
3997 * given), print option help here */
Max Reitz51641352018-05-09 23:00:20 +02003998 ret = print_amend_option_help(fmt);
Kevin Wolfa283cb62014-02-21 16:24:07 +01003999 goto out;
4000 }
4001
4002 if (optind != argc - 1) {
Max Reitzb2f27e42014-10-27 11:12:52 +01004003 error_report("Expecting one image file name");
4004 ret = -1;
4005 goto out;
Kevin Wolfa283cb62014-02-21 16:24:07 +01004006 }
Max Reitz6f176b42013-09-03 10:09:50 +02004007
Kevin Wolfce099542016-03-15 13:01:04 +01004008 flags = BDRV_O_RDWR;
4009 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitzbd39e6e2014-07-22 22:58:43 +02004010 if (ret < 0) {
4011 error_report("Invalid cache option: %s", cache);
4012 goto out;
4013 }
4014
Fam Zheng335e9932017-05-03 00:35:39 +08004015 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4016 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004017 if (!blk) {
Max Reitz6f176b42013-09-03 10:09:50 +02004018 ret = -1;
4019 goto out;
4020 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004021 bs = blk_bs(blk);
Max Reitz6f176b42013-09-03 10:09:50 +02004022
4023 fmt = bs->drv->format_name;
4024
Kevin Wolf626f84f2014-02-21 16:24:06 +01004025 if (has_help_option(options)) {
Kevin Wolfa283cb62014-02-21 16:24:07 +01004026 /* If the format was auto-detected, print option help here */
Max Reitz51641352018-05-09 23:00:20 +02004027 ret = print_amend_option_help(fmt);
Max Reitz6f176b42013-09-03 10:09:50 +02004028 goto out;
4029 }
4030
Max Reitz1f996682018-05-09 23:00:17 +02004031 if (!bs->drv->bdrv_amend_options) {
4032 error_report("Format driver '%s' does not support option amendment",
Max Reitzb2439d22014-12-02 18:32:47 +01004033 fmt);
4034 ret = -1;
4035 goto out;
4036 }
4037
Max Reitz1f996682018-05-09 23:00:17 +02004038 /* Every driver supporting amendment must have create_opts */
4039 assert(bs->drv->create_opts);
4040
Chunyan Liuc282e1f2014-06-05 17:21:11 +08004041 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
Chunyan Liu83d05212014-06-05 17:20:51 +08004042 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Paolo Bonziniece90862017-01-04 15:56:24 +01004043 qemu_opts_do_parse(opts, options, NULL, &err);
4044 if (err) {
4045 error_report_err(err);
4046 ret = -1;
4047 goto out;
Max Reitz6f176b42013-09-03 10:09:50 +02004048 }
4049
Max Reitz76a3a342014-10-27 11:12:51 +01004050 /* In case the driver does not call amend_status_cb() */
4051 qemu_progress_print(0.f, 0);
Max Reitzd1402b52018-05-09 23:00:18 +02004052 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, &err);
Max Reitz76a3a342014-10-27 11:12:51 +01004053 qemu_progress_print(100.f, 0);
Max Reitz6f176b42013-09-03 10:09:50 +02004054 if (ret < 0) {
Max Reitzd1402b52018-05-09 23:00:18 +02004055 error_report_err(err);
Max Reitz6f176b42013-09-03 10:09:50 +02004056 goto out;
4057 }
4058
4059out:
Max Reitz76a3a342014-10-27 11:12:51 +01004060 qemu_progress_end();
4061
Max Reitze814dff2015-08-20 16:00:38 -07004062out_no_progress:
Markus Armbruster26f54e92014-10-07 13:59:04 +02004063 blk_unref(blk);
Chunyan Liu83d05212014-06-05 17:20:51 +08004064 qemu_opts_del(opts);
4065 qemu_opts_free(create_opts);
Kevin Wolf626f84f2014-02-21 16:24:06 +01004066 g_free(options);
4067
Max Reitz6f176b42013-09-03 10:09:50 +02004068 if (ret) {
4069 return 1;
4070 }
4071 return 0;
4072}
4073
Kevin Wolfb6133b82014-08-05 14:17:13 +02004074typedef struct BenchData {
4075 BlockBackend *blk;
4076 uint64_t image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004077 bool write;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004078 int bufsize;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004079 int step;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004080 int nrreq;
4081 int n;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004082 int flush_interval;
4083 bool drain_on_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004084 uint8_t *buf;
4085 QEMUIOVector *qiov;
4086
4087 int in_flight;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004088 bool in_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004089 uint64_t offset;
4090} BenchData;
4091
Kevin Wolf55d539c2016-06-03 13:59:41 +02004092static void bench_undrained_flush_cb(void *opaque, int ret)
4093{
4094 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004095 error_report("Failed flush request: %s", strerror(-ret));
Kevin Wolf55d539c2016-06-03 13:59:41 +02004096 exit(EXIT_FAILURE);
4097 }
4098}
4099
Kevin Wolfb6133b82014-08-05 14:17:13 +02004100static void bench_cb(void *opaque, int ret)
4101{
4102 BenchData *b = opaque;
4103 BlockAIOCB *acb;
4104
4105 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004106 error_report("Failed request: %s", strerror(-ret));
Kevin Wolfb6133b82014-08-05 14:17:13 +02004107 exit(EXIT_FAILURE);
4108 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004109
4110 if (b->in_flush) {
4111 /* Just finished a flush with drained queue: Start next requests */
4112 assert(b->in_flight == 0);
4113 b->in_flush = false;
4114 } else if (b->in_flight > 0) {
4115 int remaining = b->n - b->in_flight;
4116
Kevin Wolfb6133b82014-08-05 14:17:13 +02004117 b->n--;
4118 b->in_flight--;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004119
4120 /* Time for flush? Drain queue if requested, then flush */
4121 if (b->flush_interval && remaining % b->flush_interval == 0) {
4122 if (!b->in_flight || !b->drain_on_flush) {
4123 BlockCompletionFunc *cb;
4124
4125 if (b->drain_on_flush) {
4126 b->in_flush = true;
4127 cb = bench_cb;
4128 } else {
4129 cb = bench_undrained_flush_cb;
4130 }
4131
4132 acb = blk_aio_flush(b->blk, cb, b);
4133 if (!acb) {
4134 error_report("Failed to issue flush request");
4135 exit(EXIT_FAILURE);
4136 }
4137 }
4138 if (b->drain_on_flush) {
4139 return;
4140 }
4141 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004142 }
4143
4144 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004145 int64_t offset = b->offset;
4146 /* blk_aio_* might look for completed I/Os and kick bench_cb
4147 * again, so make sure this operation is counted by in_flight
4148 * and b->offset is ready for the next submission.
4149 */
4150 b->in_flight++;
4151 b->offset += b->step;
4152 b->offset %= b->image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004153 if (b->write) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004154 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004155 } else {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004156 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004157 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004158 if (!acb) {
4159 error_report("Failed to issue request");
4160 exit(EXIT_FAILURE);
4161 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004162 }
4163}
4164
4165static int img_bench(int argc, char **argv)
4166{
4167 int c, ret = 0;
4168 const char *fmt = NULL, *filename;
4169 bool quiet = false;
4170 bool image_opts = false;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004171 bool is_write = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004172 int count = 75000;
4173 int depth = 64;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004174 int64_t offset = 0;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004175 size_t bufsize = 4096;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004176 int pattern = 0;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004177 size_t step = 0;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004178 int flush_interval = 0;
4179 bool drain_on_flush = true;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004180 int64_t image_size;
4181 BlockBackend *blk = NULL;
4182 BenchData data = {};
4183 int flags = 0;
Kevin Wolf604e8612016-06-14 11:29:32 +02004184 bool writethrough = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004185 struct timeval t1, t2;
4186 int i;
Fam Zheng335e9932017-05-03 00:35:39 +08004187 bool force_share = false;
Fam Zheng79d46582018-01-16 14:08:58 +08004188 size_t buf_size;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004189
4190 for (;;) {
4191 static const struct option long_options[] = {
4192 {"help", no_argument, 0, 'h'},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004193 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004194 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004195 {"pattern", required_argument, 0, OPTION_PATTERN},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004196 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
Fam Zheng335e9932017-05-03 00:35:39 +08004197 {"force-share", no_argument, 0, 'U'},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004198 {0, 0, 0, 0}
4199 };
Fam Zheng335e9932017-05-03 00:35:39 +08004200 c = getopt_long(argc, argv, ":hc:d:f:no:qs:S:t:wU", long_options, NULL);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004201 if (c == -1) {
4202 break;
4203 }
4204
4205 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004206 case ':':
4207 missing_argument(argv[optind - 1]);
4208 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004209 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004210 unrecognized_option(argv[optind - 1]);
4211 break;
4212 case 'h':
Kevin Wolfb6133b82014-08-05 14:17:13 +02004213 help();
4214 break;
4215 case 'c':
4216 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004217 unsigned long res;
4218
4219 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004220 error_report("Invalid request count specified");
4221 return 1;
4222 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004223 count = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004224 break;
4225 }
4226 case 'd':
4227 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004228 unsigned long res;
4229
4230 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004231 error_report("Invalid queue depth specified");
4232 return 1;
4233 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004234 depth = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004235 break;
4236 }
4237 case 'f':
4238 fmt = optarg;
4239 break;
4240 case 'n':
4241 flags |= BDRV_O_NATIVE_AIO;
4242 break;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004243 case 'o':
4244 {
Markus Armbruster606caa02017-02-21 21:14:04 +01004245 offset = cvtnum(optarg);
4246 if (offset < 0) {
Kevin Wolfd3199a32015-07-10 18:09:18 +02004247 error_report("Invalid offset specified");
4248 return 1;
4249 }
4250 break;
4251 }
4252 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004253 case 'q':
4254 quiet = true;
4255 break;
4256 case 's':
4257 {
4258 int64_t sval;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004259
Markus Armbruster606caa02017-02-21 21:14:04 +01004260 sval = cvtnum(optarg);
4261 if (sval < 0 || sval > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004262 error_report("Invalid buffer size specified");
4263 return 1;
4264 }
4265
4266 bufsize = sval;
4267 break;
4268 }
Kevin Wolf83de9be2015-07-13 13:13:17 +02004269 case 'S':
4270 {
4271 int64_t sval;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004272
Markus Armbruster606caa02017-02-21 21:14:04 +01004273 sval = cvtnum(optarg);
4274 if (sval < 0 || sval > INT_MAX) {
Kevin Wolf83de9be2015-07-13 13:13:17 +02004275 error_report("Invalid step size specified");
4276 return 1;
4277 }
4278
4279 step = sval;
4280 break;
4281 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004282 case 't':
4283 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4284 if (ret < 0) {
4285 error_report("Invalid cache mode");
4286 ret = -1;
4287 goto out;
4288 }
4289 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004290 case 'w':
4291 flags |= BDRV_O_RDWR;
4292 is_write = true;
4293 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004294 case 'U':
4295 force_share = true;
4296 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004297 case OPTION_PATTERN:
4298 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004299 unsigned long res;
4300
4301 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004302 error_report("Invalid pattern byte specified");
4303 return 1;
4304 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004305 pattern = res;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004306 break;
4307 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004308 case OPTION_FLUSH_INTERVAL:
4309 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004310 unsigned long res;
4311
4312 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004313 error_report("Invalid flush interval specified");
4314 return 1;
4315 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004316 flush_interval = res;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004317 break;
4318 }
4319 case OPTION_NO_DRAIN:
4320 drain_on_flush = false;
4321 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004322 case OPTION_IMAGE_OPTS:
4323 image_opts = true;
4324 break;
4325 }
4326 }
4327
4328 if (optind != argc - 1) {
4329 error_exit("Expecting one image file name");
4330 }
4331 filename = argv[argc - 1];
4332
Kevin Wolf55d539c2016-06-03 13:59:41 +02004333 if (!is_write && flush_interval) {
4334 error_report("--flush-interval is only available in write tests");
4335 ret = -1;
4336 goto out;
4337 }
4338 if (flush_interval && flush_interval < depth) {
4339 error_report("Flush interval can't be smaller than depth");
4340 ret = -1;
4341 goto out;
4342 }
4343
Fam Zheng335e9932017-05-03 00:35:39 +08004344 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4345 force_share);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004346 if (!blk) {
4347 ret = -1;
4348 goto out;
4349 }
4350
4351 image_size = blk_getlength(blk);
4352 if (image_size < 0) {
4353 ret = image_size;
4354 goto out;
4355 }
4356
4357 data = (BenchData) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004358 .blk = blk,
4359 .image_size = image_size,
4360 .bufsize = bufsize,
4361 .step = step ?: bufsize,
4362 .nrreq = depth,
4363 .n = count,
4364 .offset = offset,
4365 .write = is_write,
4366 .flush_interval = flush_interval,
4367 .drain_on_flush = drain_on_flush,
Kevin Wolfb6133b82014-08-05 14:17:13 +02004368 };
Kevin Wolfd3199a32015-07-10 18:09:18 +02004369 printf("Sending %d %s requests, %d bytes each, %d in parallel "
Kevin Wolf83de9be2015-07-13 13:13:17 +02004370 "(starting at offset %" PRId64 ", step size %d)\n",
Kevin Wolfd3199a32015-07-10 18:09:18 +02004371 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
Kevin Wolf83de9be2015-07-13 13:13:17 +02004372 data.offset, data.step);
Kevin Wolf55d539c2016-06-03 13:59:41 +02004373 if (flush_interval) {
4374 printf("Sending flush every %d requests\n", flush_interval);
4375 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004376
Fam Zheng79d46582018-01-16 14:08:58 +08004377 buf_size = data.nrreq * data.bufsize;
4378 data.buf = blk_blockalign(blk, buf_size);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004379 memset(data.buf, pattern, data.nrreq * data.bufsize);
4380
Fam Zheng79d46582018-01-16 14:08:58 +08004381 blk_register_buf(blk, data.buf, buf_size);
4382
Kevin Wolfb6133b82014-08-05 14:17:13 +02004383 data.qiov = g_new(QEMUIOVector, data.nrreq);
4384 for (i = 0; i < data.nrreq; i++) {
4385 qemu_iovec_init(&data.qiov[i], 1);
4386 qemu_iovec_add(&data.qiov[i],
4387 data.buf + i * data.bufsize, data.bufsize);
4388 }
4389
4390 gettimeofday(&t1, NULL);
4391 bench_cb(&data, 0);
4392
4393 while (data.n > 0) {
4394 main_loop_wait(false);
4395 }
4396 gettimeofday(&t2, NULL);
4397
4398 printf("Run completed in %3.3f seconds.\n",
4399 (t2.tv_sec - t1.tv_sec)
4400 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4401
4402out:
Fam Zheng79d46582018-01-16 14:08:58 +08004403 if (data.buf) {
4404 blk_unregister_buf(blk, data.buf);
4405 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004406 qemu_vfree(data.buf);
4407 blk_unref(blk);
4408
4409 if (ret) {
4410 return 1;
4411 }
4412 return 0;
4413}
4414
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004415#define C_BS 01
4416#define C_COUNT 02
4417#define C_IF 04
4418#define C_OF 010
Reda Sallahif7c15532016-08-10 16:16:09 +02004419#define C_SKIP 020
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004420
4421struct DdInfo {
4422 unsigned int flags;
4423 int64_t count;
4424};
4425
4426struct DdIo {
4427 int bsz; /* Block size */
4428 char *filename;
4429 uint8_t *buf;
Reda Sallahif7c15532016-08-10 16:16:09 +02004430 int64_t offset;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004431};
4432
4433struct DdOpts {
4434 const char *name;
4435 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
4436 unsigned int flag;
4437};
4438
4439static int img_dd_bs(const char *arg,
4440 struct DdIo *in, struct DdIo *out,
4441 struct DdInfo *dd)
4442{
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004443 int64_t res;
4444
Markus Armbruster606caa02017-02-21 21:14:04 +01004445 res = cvtnum(arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004446
Markus Armbruster606caa02017-02-21 21:14:04 +01004447 if (res <= 0 || res > INT_MAX) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004448 error_report("invalid number: '%s'", arg);
4449 return 1;
4450 }
4451 in->bsz = out->bsz = res;
4452
4453 return 0;
4454}
4455
4456static int img_dd_count(const char *arg,
4457 struct DdIo *in, struct DdIo *out,
4458 struct DdInfo *dd)
4459{
Markus Armbruster606caa02017-02-21 21:14:04 +01004460 dd->count = cvtnum(arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004461
Markus Armbruster606caa02017-02-21 21:14:04 +01004462 if (dd->count < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004463 error_report("invalid number: '%s'", arg);
4464 return 1;
4465 }
4466
4467 return 0;
4468}
4469
4470static int img_dd_if(const char *arg,
4471 struct DdIo *in, struct DdIo *out,
4472 struct DdInfo *dd)
4473{
4474 in->filename = g_strdup(arg);
4475
4476 return 0;
4477}
4478
4479static int img_dd_of(const char *arg,
4480 struct DdIo *in, struct DdIo *out,
4481 struct DdInfo *dd)
4482{
4483 out->filename = g_strdup(arg);
4484
4485 return 0;
4486}
4487
Reda Sallahif7c15532016-08-10 16:16:09 +02004488static int img_dd_skip(const char *arg,
4489 struct DdIo *in, struct DdIo *out,
4490 struct DdInfo *dd)
4491{
Markus Armbruster606caa02017-02-21 21:14:04 +01004492 in->offset = cvtnum(arg);
Reda Sallahif7c15532016-08-10 16:16:09 +02004493
Markus Armbruster606caa02017-02-21 21:14:04 +01004494 if (in->offset < 0) {
Reda Sallahif7c15532016-08-10 16:16:09 +02004495 error_report("invalid number: '%s'", arg);
4496 return 1;
4497 }
4498
4499 return 0;
4500}
4501
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004502static int img_dd(int argc, char **argv)
4503{
4504 int ret = 0;
4505 char *arg = NULL;
4506 char *tmp;
4507 BlockDriver *drv = NULL, *proto_drv = NULL;
4508 BlockBackend *blk1 = NULL, *blk2 = NULL;
4509 QemuOpts *opts = NULL;
4510 QemuOptsList *create_opts = NULL;
4511 Error *local_err = NULL;
4512 bool image_opts = false;
4513 int c, i;
4514 const char *out_fmt = "raw";
4515 const char *fmt = NULL;
4516 int64_t size = 0;
4517 int64_t block_count = 0, out_pos, in_pos;
Fam Zheng335e9932017-05-03 00:35:39 +08004518 bool force_share = false;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004519 struct DdInfo dd = {
4520 .flags = 0,
4521 .count = 0,
4522 };
4523 struct DdIo in = {
4524 .bsz = 512, /* Block size is by default 512 bytes */
4525 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004526 .buf = NULL,
4527 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004528 };
4529 struct DdIo out = {
4530 .bsz = 512,
4531 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004532 .buf = NULL,
4533 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004534 };
4535
4536 const struct DdOpts options[] = {
4537 { "bs", img_dd_bs, C_BS },
4538 { "count", img_dd_count, C_COUNT },
4539 { "if", img_dd_if, C_IF },
4540 { "of", img_dd_of, C_OF },
Reda Sallahif7c15532016-08-10 16:16:09 +02004541 { "skip", img_dd_skip, C_SKIP },
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004542 { NULL, NULL, 0 }
4543 };
4544 const struct option long_options[] = {
4545 { "help", no_argument, 0, 'h'},
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004546 { "object", required_argument, 0, OPTION_OBJECT},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004547 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08004548 { "force-share", no_argument, 0, 'U'},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004549 { 0, 0, 0, 0 }
4550 };
4551
Fam Zheng335e9932017-05-03 00:35:39 +08004552 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004553 if (c == EOF) {
4554 break;
4555 }
4556 switch (c) {
4557 case 'O':
4558 out_fmt = optarg;
4559 break;
4560 case 'f':
4561 fmt = optarg;
4562 break;
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004563 case ':':
4564 missing_argument(argv[optind - 1]);
4565 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004566 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004567 unrecognized_option(argv[optind - 1]);
4568 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004569 case 'h':
4570 help();
4571 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004572 case 'U':
4573 force_share = true;
4574 break;
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01004575 case OPTION_OBJECT:
4576 if (!qemu_opts_parse_noisily(&qemu_object_opts, optarg, true)) {
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004577 ret = -1;
4578 goto out;
4579 }
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01004580 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004581 case OPTION_IMAGE_OPTS:
4582 image_opts = true;
4583 break;
4584 }
4585 }
4586
4587 for (i = optind; i < argc; i++) {
4588 int j;
4589 arg = g_strdup(argv[i]);
4590
4591 tmp = strchr(arg, '=');
4592 if (tmp == NULL) {
4593 error_report("unrecognized operand %s", arg);
4594 ret = -1;
4595 goto out;
4596 }
4597
4598 *tmp++ = '\0';
4599
4600 for (j = 0; options[j].name != NULL; j++) {
4601 if (!strcmp(arg, options[j].name)) {
4602 break;
4603 }
4604 }
4605 if (options[j].name == NULL) {
4606 error_report("unrecognized operand %s", arg);
4607 ret = -1;
4608 goto out;
4609 }
4610
4611 if (options[j].f(tmp, &in, &out, &dd) != 0) {
4612 ret = -1;
4613 goto out;
4614 }
4615 dd.flags |= options[j].flag;
4616 g_free(arg);
4617 arg = NULL;
4618 }
4619
4620 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
4621 error_report("Must specify both input and output files");
4622 ret = -1;
4623 goto out;
4624 }
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004625
4626 if (qemu_opts_foreach(&qemu_object_opts,
4627 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00004628 NULL, &error_fatal)) {
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004629 ret = -1;
4630 goto out;
4631 }
4632
Fam Zheng335e9932017-05-03 00:35:39 +08004633 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
4634 force_share);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004635
4636 if (!blk1) {
4637 ret = -1;
4638 goto out;
4639 }
4640
4641 drv = bdrv_find_format(out_fmt);
4642 if (!drv) {
4643 error_report("Unknown file format");
4644 ret = -1;
4645 goto out;
4646 }
4647 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
4648
4649 if (!proto_drv) {
4650 error_report_err(local_err);
4651 ret = -1;
4652 goto out;
4653 }
4654 if (!drv->create_opts) {
4655 error_report("Format driver '%s' does not support image creation",
4656 drv->format_name);
4657 ret = -1;
4658 goto out;
4659 }
4660 if (!proto_drv->create_opts) {
4661 error_report("Protocol driver '%s' does not support image creation",
4662 proto_drv->format_name);
4663 ret = -1;
4664 goto out;
4665 }
4666 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4667 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
4668
4669 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4670
4671 size = blk_getlength(blk1);
4672 if (size < 0) {
4673 error_report("Failed to get size for '%s'", in.filename);
4674 ret = -1;
4675 goto out;
4676 }
4677
4678 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
4679 dd.count * in.bsz < size) {
4680 size = dd.count * in.bsz;
4681 }
4682
Reda Sallahif7c15532016-08-10 16:16:09 +02004683 /* Overflow means the specified offset is beyond input image's size */
4684 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4685 size < in.bsz * in.offset)) {
4686 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
4687 } else {
4688 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
4689 size - in.bsz * in.offset, &error_abort);
4690 }
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004691
4692 ret = bdrv_create(drv, out.filename, opts, &local_err);
4693 if (ret < 0) {
4694 error_reportf_err(local_err,
4695 "%s: error while creating output image: ",
4696 out.filename);
4697 ret = -1;
4698 goto out;
4699 }
4700
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01004701 /* TODO, we can't honour --image-opts for the target,
4702 * since it needs to be given in a format compatible
4703 * with the bdrv_create() call above which does not
4704 * support image-opts style.
4705 */
Daniel P. Berrange29cf9332017-05-15 17:47:12 +01004706 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01004707 false, false, false);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004708
4709 if (!blk2) {
4710 ret = -1;
4711 goto out;
4712 }
4713
Reda Sallahif7c15532016-08-10 16:16:09 +02004714 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4715 size < in.offset * in.bsz)) {
4716 /* We give a warning if the skip option is bigger than the input
4717 * size and create an empty output disk image (i.e. like dd(1)).
4718 */
4719 error_report("%s: cannot skip to specified offset", in.filename);
4720 in_pos = size;
4721 } else {
4722 in_pos = in.offset * in.bsz;
4723 }
4724
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004725 in.buf = g_new(uint8_t, in.bsz);
4726
Reda Sallahif7c15532016-08-10 16:16:09 +02004727 for (out_pos = 0; in_pos < size; block_count++) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004728 int in_ret, out_ret;
4729
4730 if (in_pos + in.bsz > size) {
4731 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
4732 } else {
4733 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
4734 }
4735 if (in_ret < 0) {
4736 error_report("error while reading from input image file: %s",
4737 strerror(-in_ret));
4738 ret = -1;
4739 goto out;
4740 }
4741 in_pos += in_ret;
4742
4743 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
4744
4745 if (out_ret < 0) {
4746 error_report("error while writing to output image file: %s",
4747 strerror(-out_ret));
4748 ret = -1;
4749 goto out;
4750 }
4751 out_pos += out_ret;
4752 }
4753
4754out:
4755 g_free(arg);
4756 qemu_opts_del(opts);
4757 qemu_opts_free(create_opts);
4758 blk_unref(blk1);
4759 blk_unref(blk2);
4760 g_free(in.filename);
4761 g_free(out.filename);
4762 g_free(in.buf);
4763 g_free(out.buf);
4764
4765 if (ret) {
4766 return 1;
4767 }
4768 return 0;
4769}
4770
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01004771static void dump_json_block_measure_info(BlockMeasureInfo *info)
4772{
4773 QString *str;
4774 QObject *obj;
4775 Visitor *v = qobject_output_visitor_new(&obj);
4776
4777 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
4778 visit_complete(v, &obj);
4779 str = qobject_to_json_pretty(obj);
4780 assert(str != NULL);
4781 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02004782 qobject_unref(obj);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01004783 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02004784 qobject_unref(str);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01004785}
4786
4787static int img_measure(int argc, char **argv)
4788{
4789 static const struct option long_options[] = {
4790 {"help", no_argument, 0, 'h'},
4791 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4792 {"object", required_argument, 0, OPTION_OBJECT},
4793 {"output", required_argument, 0, OPTION_OUTPUT},
4794 {"size", required_argument, 0, OPTION_SIZE},
4795 {"force-share", no_argument, 0, 'U'},
4796 {0, 0, 0, 0}
4797 };
4798 OutputFormat output_format = OFORMAT_HUMAN;
4799 BlockBackend *in_blk = NULL;
4800 BlockDriver *drv;
4801 const char *filename = NULL;
4802 const char *fmt = NULL;
4803 const char *out_fmt = "raw";
4804 char *options = NULL;
4805 char *snapshot_name = NULL;
4806 bool force_share = false;
4807 QemuOpts *opts = NULL;
4808 QemuOpts *object_opts = NULL;
4809 QemuOpts *sn_opts = NULL;
4810 QemuOptsList *create_opts = NULL;
4811 bool image_opts = false;
4812 uint64_t img_size = UINT64_MAX;
4813 BlockMeasureInfo *info = NULL;
4814 Error *local_err = NULL;
4815 int ret = 1;
4816 int c;
4817
4818 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
4819 long_options, NULL)) != -1) {
4820 switch (c) {
4821 case '?':
4822 case 'h':
4823 help();
4824 break;
4825 case 'f':
4826 fmt = optarg;
4827 break;
4828 case 'O':
4829 out_fmt = optarg;
4830 break;
4831 case 'o':
4832 if (!is_valid_option_list(optarg)) {
4833 error_report("Invalid option list: %s", optarg);
4834 goto out;
4835 }
4836 if (!options) {
4837 options = g_strdup(optarg);
4838 } else {
4839 char *old_options = options;
4840 options = g_strdup_printf("%s,%s", options, optarg);
4841 g_free(old_options);
4842 }
4843 break;
4844 case 'l':
4845 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
4846 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
4847 optarg, false);
4848 if (!sn_opts) {
4849 error_report("Failed in parsing snapshot param '%s'",
4850 optarg);
4851 goto out;
4852 }
4853 } else {
4854 snapshot_name = optarg;
4855 }
4856 break;
4857 case 'U':
4858 force_share = true;
4859 break;
4860 case OPTION_OBJECT:
4861 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
4862 optarg, true);
4863 if (!object_opts) {
4864 goto out;
4865 }
4866 break;
4867 case OPTION_IMAGE_OPTS:
4868 image_opts = true;
4869 break;
4870 case OPTION_OUTPUT:
4871 if (!strcmp(optarg, "json")) {
4872 output_format = OFORMAT_JSON;
4873 } else if (!strcmp(optarg, "human")) {
4874 output_format = OFORMAT_HUMAN;
4875 } else {
4876 error_report("--output must be used with human or json "
4877 "as argument.");
4878 goto out;
4879 }
4880 break;
4881 case OPTION_SIZE:
4882 {
4883 int64_t sval;
4884
4885 sval = cvtnum(optarg);
4886 if (sval < 0) {
4887 if (sval == -ERANGE) {
4888 error_report("Image size must be less than 8 EiB!");
4889 } else {
4890 error_report("Invalid image size specified! You may use "
4891 "k, M, G, T, P or E suffixes for ");
4892 error_report("kilobytes, megabytes, gigabytes, terabytes, "
4893 "petabytes and exabytes.");
4894 }
4895 goto out;
4896 }
4897 img_size = (uint64_t)sval;
4898 }
4899 break;
4900 }
4901 }
4902
4903 if (qemu_opts_foreach(&qemu_object_opts,
4904 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00004905 NULL, &error_fatal)) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01004906 goto out;
4907 }
4908
4909 if (argc - optind > 1) {
4910 error_report("At most one filename argument is allowed.");
4911 goto out;
4912 } else if (argc - optind == 1) {
4913 filename = argv[optind];
4914 }
4915
4916 if (!filename &&
4917 (object_opts || image_opts || fmt || snapshot_name || sn_opts)) {
4918 error_report("--object, --image-opts, -f, and -l "
4919 "require a filename argument.");
4920 goto out;
4921 }
4922 if (filename && img_size != UINT64_MAX) {
4923 error_report("--size N cannot be used together with a filename.");
4924 goto out;
4925 }
4926 if (!filename && img_size == UINT64_MAX) {
4927 error_report("Either --size N or one filename must be specified.");
4928 goto out;
4929 }
4930
4931 if (filename) {
4932 in_blk = img_open(image_opts, filename, fmt, 0,
4933 false, false, force_share);
4934 if (!in_blk) {
4935 goto out;
4936 }
4937
4938 if (sn_opts) {
4939 bdrv_snapshot_load_tmp(blk_bs(in_blk),
4940 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
4941 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
4942 &local_err);
4943 } else if (snapshot_name != NULL) {
4944 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
4945 snapshot_name, &local_err);
4946 }
4947 if (local_err) {
4948 error_reportf_err(local_err, "Failed to load snapshot: ");
4949 goto out;
4950 }
4951 }
4952
4953 drv = bdrv_find_format(out_fmt);
4954 if (!drv) {
4955 error_report("Unknown file format '%s'", out_fmt);
4956 goto out;
4957 }
4958 if (!drv->create_opts) {
4959 error_report("Format driver '%s' does not support image creation",
4960 drv->format_name);
4961 goto out;
4962 }
4963
4964 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4965 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
4966 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4967 if (options) {
4968 qemu_opts_do_parse(opts, options, NULL, &local_err);
4969 if (local_err) {
4970 error_report_err(local_err);
4971 error_report("Invalid options for file format '%s'", out_fmt);
4972 goto out;
4973 }
4974 }
4975 if (img_size != UINT64_MAX) {
4976 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
4977 }
4978
4979 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
4980 if (local_err) {
4981 error_report_err(local_err);
4982 goto out;
4983 }
4984
4985 if (output_format == OFORMAT_HUMAN) {
4986 printf("required size: %" PRIu64 "\n", info->required);
4987 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
4988 } else {
4989 dump_json_block_measure_info(info);
4990 }
4991
4992 ret = 0;
4993
4994out:
4995 qapi_free_BlockMeasureInfo(info);
4996 qemu_opts_del(object_opts);
4997 qemu_opts_del(opts);
4998 qemu_opts_del(sn_opts);
4999 qemu_opts_free(create_opts);
5000 g_free(options);
5001 blk_unref(in_blk);
5002 return ret;
5003}
Kevin Wolfb6133b82014-08-05 14:17:13 +02005004
Anthony Liguoric227f092009-10-01 16:12:16 -05005005static const img_cmd_t img_cmds[] = {
Stuart Brady153859b2009-06-07 00:42:17 +01005006#define DEF(option, callback, arg_string) \
5007 { option, callback },
5008#include "qemu-img-cmds.h"
5009#undef DEF
Stuart Brady153859b2009-06-07 00:42:17 +01005010 { NULL, NULL, },
5011};
5012
bellardea2384d2004-08-01 21:59:26 +00005013int main(int argc, char **argv)
5014{
Anthony Liguoric227f092009-10-01 16:12:16 -05005015 const img_cmd_t *cmd;
Stuart Brady153859b2009-06-07 00:42:17 +01005016 const char *cmdname;
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005017 Error *local_error = NULL;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005018 char *trace_file = NULL;
Jeff Cody7db16892014-04-25 17:02:32 -04005019 int c;
Jeff Cody7db16892014-04-25 17:02:32 -04005020 static const struct option long_options[] = {
5021 {"help", no_argument, 0, 'h'},
Denis V. Lunev10985132016-06-17 17:44:13 +03005022 {"version", no_argument, 0, 'V'},
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005023 {"trace", required_argument, NULL, 'T'},
Jeff Cody7db16892014-04-25 17:02:32 -04005024 {0, 0, 0, 0}
5025 };
bellardea2384d2004-08-01 21:59:26 +00005026
MORITA Kazutaka526eda12013-07-23 17:30:11 +09005027#ifdef CONFIG_POSIX
5028 signal(SIGPIPE, SIG_IGN);
5029#endif
5030
Christophe Fergeauf5852ef2019-01-31 17:46:14 +01005031 error_init(argv[0]);
Daniel P. Berrangefe4db842016-10-04 14:35:52 +01005032 module_call_init(MODULE_INIT_TRACE);
Fam Zheng10f5bff2014-02-10 14:48:51 +08005033 qemu_init_exec_dir(argv[0]);
Kevin Wolf53f76e52010-12-16 15:10:32 +01005034
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005035 if (qemu_init_main_loop(&local_error)) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01005036 error_report_err(local_error);
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005037 exit(EXIT_FAILURE);
5038 }
5039
Eduardo Habkoste8f2d272016-05-12 11:10:04 -03005040 qcrypto_init(&error_fatal);
Daniel P. Berrangec2297082016-04-06 12:12:06 +01005041
Daniel P. Berrange064097d2016-02-10 18:41:01 +00005042 module_call_init(MODULE_INIT_QOM);
bellardea2384d2004-08-01 21:59:26 +00005043 bdrv_init();
Fam Zhengac1307a2014-04-22 13:36:11 +08005044 if (argc < 2) {
5045 error_exit("Not enough arguments");
5046 }
Stuart Brady153859b2009-06-07 00:42:17 +01005047
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00005048 qemu_add_opts(&qemu_object_opts);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00005049 qemu_add_opts(&qemu_source_opts);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005050 qemu_add_opts(&qemu_trace_opts);
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00005051
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005052 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
Denis V. Lunev10985132016-06-17 17:44:13 +03005053 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005054 case ':':
5055 missing_argument(argv[optind - 1]);
5056 return 0;
Stefan Hajnoczi4581c162017-03-17 18:45:39 +08005057 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005058 unrecognized_option(argv[optind - 1]);
5059 return 0;
5060 case 'h':
Denis V. Lunev10985132016-06-17 17:44:13 +03005061 help();
5062 return 0;
5063 case 'V':
5064 printf(QEMU_IMG_VERSION);
5065 return 0;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005066 case 'T':
5067 g_free(trace_file);
5068 trace_file = trace_opt_parse(optarg);
5069 break;
Stuart Brady153859b2009-06-07 00:42:17 +01005070 }
bellardea2384d2004-08-01 21:59:26 +00005071 }
Stuart Brady153859b2009-06-07 00:42:17 +01005072
Denis V. Lunev10985132016-06-17 17:44:13 +03005073 cmdname = argv[optind];
Jeff Cody7db16892014-04-25 17:02:32 -04005074
Denis V. Lunev10985132016-06-17 17:44:13 +03005075 /* reset getopt_long scanning */
5076 argc -= optind;
5077 if (argc < 1) {
Jeff Cody5f6979c2014-04-28 14:37:18 -04005078 return 0;
5079 }
Denis V. Lunev10985132016-06-17 17:44:13 +03005080 argv += optind;
Richard W.M. Jonesd339d762019-01-18 10:11:14 +00005081 qemu_reset_optind();
Denis V. Lunev10985132016-06-17 17:44:13 +03005082
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005083 if (!trace_init_backends()) {
5084 exit(1);
5085 }
5086 trace_init_file(trace_file);
5087 qemu_set_log(LOG_TRACE);
5088
Denis V. Lunev10985132016-06-17 17:44:13 +03005089 /* find the command */
5090 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
5091 if (!strcmp(cmdname, cmd->name)) {
5092 return cmd->handler(argc, argv);
5093 }
5094 }
Jeff Cody7db16892014-04-25 17:02:32 -04005095
Stuart Brady153859b2009-06-07 00:42:17 +01005096 /* not found */
Fam Zhengac1307a2014-04-22 13:36:11 +08005097 error_exit("Command not found: %s", cmdname);
bellardea2384d2004-08-01 21:59:26 +00005098}