blob: 158b3a505f5cc37a1ef3c7b9429d3a6c68978de7 [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
Peter Lieven9fd77f92017-04-21 11:11:55 +02002234 s.src_num = argc - optind - 1;
2235 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2236
2237 if (options && has_help_option(options)) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002238 if (out_fmt) {
2239 ret = print_block_option_help(out_filename, out_fmt);
2240 goto fail_getopt;
2241 } else {
2242 error_report("Option help requires a format be specified");
2243 goto fail_getopt;
2244 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002245 }
2246
2247 if (s.src_num < 1) {
2248 error_report("Must specify image file name");
2249 goto fail_getopt;
2250 }
2251
2252
Peter Lieven9fd77f92017-04-21 11:11:55 +02002253 /* ret is still -EINVAL until here */
2254 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2255 if (ret < 0) {
2256 error_report("Invalid source cache option: %s", src_cache);
Peter Lieven2d9187b2017-02-28 13:40:07 +01002257 goto fail_getopt;
2258 }
2259
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002260 /* Initialize before goto out */
Max Reitz3d96cb92019-05-07 22:35:02 +02002261 if (s.quiet) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002262 progress = false;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002263 }
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002264 qemu_progress_init(progress, 1.0);
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002265 qemu_progress_print(0, 100);
2266
Peter Lieven9fd77f92017-04-21 11:11:55 +02002267 s.src = g_new0(BlockBackend *, s.src_num);
2268 s.src_sectors = g_new(int64_t, s.src_num);
balrog926c2d22007-10-31 01:11:44 +00002269
Peter Lieven9fd77f92017-04-21 11:11:55 +02002270 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2271 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
Max Reitz3d96cb92019-05-07 22:35:02 +02002272 fmt, src_flags, src_writethrough, s.quiet,
Fam Zheng335e9932017-05-03 00:35:39 +08002273 force_share);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002274 if (!s.src[bs_i]) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002275 ret = -1;
2276 goto out;
2277 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002278 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2279 if (s.src_sectors[bs_i] < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002280 error_report("Could not get size of %s: %s",
Peter Lieven9fd77f92017-04-21 11:11:55 +02002281 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02002282 ret = -1;
2283 goto out;
2284 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002285 s.total_sectors += s.src_sectors[bs_i];
balrog926c2d22007-10-31 01:11:44 +00002286 }
bellardea2384d2004-08-01 21:59:26 +00002287
Wenchao Xiaef806542013-12-04 17:10:57 +08002288 if (sn_opts) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002289 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
Peter Maydell10d6eda2017-02-10 16:28:24 +00002290 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2291 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2292 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002293 } else if (snapshot_name != NULL) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002294 if (s.src_num > 1) {
Markus Armbruster6daf1942011-06-22 14:03:54 +02002295 error_report("No support for concatenating multiple snapshot");
edison51ef6722010-09-21 19:58:41 -07002296 ret = -1;
2297 goto out;
2298 }
Wenchao Xia7b4c4782013-12-04 17:10:54 +08002299
Peter Lieven9fd77f92017-04-21 11:11:55 +02002300 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2301 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08002302 }
Markus Armbruster84d18f02014-01-30 15:07:28 +01002303 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002304 error_reportf_err(local_err, "Failed to load snapshot: ");
Wenchao Xiaef806542013-12-04 17:10:57 +08002305 ret = -1;
2306 goto out;
edison51ef6722010-09-21 19:58:41 -07002307 }
2308
Max Reitz2e024cd2015-02-11 09:58:46 -05002309 if (!skip_create) {
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002310 /* Find driver and parse its options */
2311 drv = bdrv_find_format(out_fmt);
2312 if (!drv) {
2313 error_report("Unknown file format '%s'", out_fmt);
2314 ret = -1;
2315 goto out;
2316 }
2317
2318 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2319 if (!proto_drv) {
2320 error_report_err(local_err);
2321 ret = -1;
2322 goto out;
2323 }
2324
Max Reitz2e024cd2015-02-11 09:58:46 -05002325 if (!drv->create_opts) {
2326 error_report("Format driver '%s' does not support image creation",
2327 drv->format_name);
2328 ret = -1;
2329 goto out;
2330 }
Max Reitzf75613c2014-12-02 18:32:46 +01002331
Max Reitz2e024cd2015-02-11 09:58:46 -05002332 if (!proto_drv->create_opts) {
2333 error_report("Protocol driver '%s' does not support image creation",
2334 proto_drv->format_name);
2335 ret = -1;
2336 goto out;
2337 }
Max Reitzf75613c2014-12-02 18:32:46 +01002338
Max Reitz2e024cd2015-02-11 09:58:46 -05002339 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2340 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfdb08adf2009-06-04 15:39:38 +02002341
Max Reitz2e024cd2015-02-11 09:58:46 -05002342 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002343 if (options) {
2344 qemu_opts_do_parse(opts, options, NULL, &local_err);
2345 if (local_err) {
Markus Armbruster97a2ca72015-03-14 10:23:15 +01002346 error_report_err(local_err);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002347 ret = -1;
2348 goto out;
2349 }
Max Reitz2e024cd2015-02-11 09:58:46 -05002350 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002351
Peter Lieven9fd77f92017-04-21 11:11:55 +02002352 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
Markus Armbruster39101f22015-02-12 16:46:36 +01002353 &error_abort);
Max Reitz2e024cd2015-02-11 09:58:46 -05002354 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2355 if (ret < 0) {
2356 goto out;
2357 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002358 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002359
Kevin Wolfa18953f2010-10-14 15:46:04 +02002360 /* Get backing file name if -o backing_file was used */
Chunyan Liu83d05212014-06-05 17:20:51 +08002361 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
Kevin Wolfa18953f2010-10-14 15:46:04 +02002362 if (out_baseimg_param) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002363 out_baseimg = out_baseimg_param;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002364 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002365 s.target_has_backing = (bool) out_baseimg;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002366
Max Reitz48758a82017-04-26 15:46:48 +02002367 if (s.src_num > 1 && out_baseimg) {
2368 error_report("Having a backing file for the target makes no sense when "
2369 "concatenating multiple input images");
2370 ret = -1;
2371 goto out;
2372 }
2373
Kevin Wolfefa84d42009-05-18 16:42:12 +02002374 /* Check if compression is supported */
Peter Lieven9fd77f92017-04-21 11:11:55 +02002375 if (s.compressed) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002376 bool encryption =
2377 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002378 const char *encryptfmt =
2379 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
Chunyan Liu83d05212014-06-05 17:20:51 +08002380 const char *preallocation =
2381 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
Kevin Wolfefa84d42009-05-18 16:42:12 +02002382
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002383 if (drv && !drv->bdrv_co_pwritev_compressed) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002384 error_report("Compression not supported for this file format");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002385 ret = -1;
2386 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002387 }
2388
Daniel P. Berrange0cb8d472017-06-23 17:24:06 +01002389 if (encryption || encryptfmt) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002390 error_report("Compression and encryption not supported at "
2391 "the same time");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002392 ret = -1;
2393 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002394 }
Kevin Wolf41521fa2011-10-18 16:19:42 +02002395
Chunyan Liu83d05212014-06-05 17:20:51 +08002396 if (preallocation
2397 && strcmp(preallocation, "off"))
Kevin Wolf41521fa2011-10-18 16:19:42 +02002398 {
2399 error_report("Compression and preallocation not supported at "
2400 "the same time");
2401 ret = -1;
2402 goto out;
2403 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002404 }
2405
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002406 /*
2407 * The later open call will need any decryption secrets, and
2408 * bdrv_create() will purge "opts", so extract them now before
2409 * they are lost.
2410 */
2411 if (!skip_create) {
2412 open_opts = qdict_new();
2413 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
2414 }
2415
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002416 if (!skip_create) {
2417 /* Create the new image */
Chunyan Liuc282e1f2014-06-05 17:21:11 +08002418 ret = bdrv_create(drv, out_filename, opts, &local_err);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002419 if (ret < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002420 error_reportf_err(local_err, "%s: error while converting %s: ",
2421 out_filename, out_fmt);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002422 goto out;
bellardea2384d2004-08-01 21:59:26 +00002423 }
2424 }
ths3b46e622007-09-17 08:09:54 +00002425
Peter Lieven9fd77f92017-04-21 11:11:55 +02002426 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
Kevin Wolfce099542016-03-15 13:01:04 +01002427 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002428 if (ret < 0) {
2429 error_report("Invalid cache option: %s", cache);
Markus Armbrusterbb9cd2e2014-05-28 11:17:07 +02002430 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002431 }
2432
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002433 if (skip_create) {
2434 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002435 flags, writethrough, s.quiet, false);
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002436 } else {
2437 /* TODO ultimately we should allow --target-image-opts
2438 * to be used even when -n is not given.
2439 * That has to wait for bdrv_create to be improved
2440 * to allow filenames in option syntax
2441 */
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002442 s.target = img_open_file(out_filename, open_opts, out_fmt,
Max Reitz3d96cb92019-05-07 22:35:02 +02002443 flags, writethrough, s.quiet, false);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002444 open_opts = NULL; /* blk_new_open will have freed it */
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002445 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002446 if (!s.target) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002447 ret = -1;
2448 goto out;
2449 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002450 out_bs = blk_bs(s.target);
bellardea2384d2004-08-01 21:59:26 +00002451
Daniel P. Berrange305b4c62017-05-15 17:47:11 +01002452 if (s.compressed && !out_bs->drv->bdrv_co_pwritev_compressed) {
2453 error_report("Compression not supported for this file format");
2454 ret = -1;
2455 goto out;
2456 }
2457
Eric Blake5def6b82016-06-23 16:37:19 -06002458 /* increase bufsectors from the default 4096 (2M) if opt_transfer
Peter Lieven6360ab22018-07-13 09:15:39 +02002459 * or discard_alignment of the out_bs is greater. Limit to
2460 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2461 s.buf_sectors = MIN(MAX_BUF_SECTORS,
Peter Lieven9fd77f92017-04-21 11:11:55 +02002462 MAX(s.buf_sectors,
2463 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2464 out_bs->bl.pdiscard_alignment >>
2465 BDRV_SECTOR_BITS)));
Peter Lievenf2521c92013-11-27 11:07:06 +01002466
Peter Lieven8dcd3c92018-07-12 15:00:10 +02002467 /* try to align the write requests to the destination to avoid unnecessary
2468 * RMW cycles. */
2469 s.alignment = MAX(pow2floor(s.min_sparse),
2470 DIV_ROUND_UP(out_bs->bl.request_alignment,
2471 BDRV_SECTOR_SIZE));
2472 assert(is_power_of_2(s.alignment));
2473
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002474 if (skip_create) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002475 int64_t output_sectors = blk_nb_sectors(s.target);
Markus Armbruster43716fa2014-06-26 13:23:21 +02002476 if (output_sectors < 0) {
Gongleieec5eb42015-02-25 12:22:27 +08002477 error_report("unable to get output image length: %s",
Markus Armbruster43716fa2014-06-26 13:23:21 +02002478 strerror(-output_sectors));
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002479 ret = -1;
2480 goto out;
Peter Lieven9fd77f92017-04-21 11:11:55 +02002481 } else if (output_sectors < s.total_sectors) {
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002482 error_report("output file is smaller than input file");
2483 ret = -1;
2484 goto out;
2485 }
2486 }
2487
Max Reitz351c8ef2018-05-01 18:57:49 +02002488 if (s.target_has_backing) {
2489 /* Errors are treated as "backing length unknown" (which means
2490 * s.target_backing_sectors has to be negative, which it will
2491 * be automatically). The backing file length is used only
2492 * for optimizations, so such a case is not fatal. */
2493 s.target_backing_sectors = bdrv_nb_sectors(out_bs->backing->bs);
2494 } else {
2495 s.target_backing_sectors = -1;
2496 }
2497
Peter Lieven24f833c2013-11-27 11:07:07 +01002498 ret = bdrv_get_info(out_bs, &bdi);
2499 if (ret < 0) {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002500 if (s.compressed) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002501 error_report("could not get block driver info");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002502 goto out;
2503 }
Peter Lieven24f833c2013-11-27 11:07:07 +01002504 } else {
Peter Lieven9fd77f92017-04-21 11:11:55 +02002505 s.compressed = s.compressed || bdi.needs_compressed_writes;
2506 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
Max Reitz351c8ef2018-05-01 18:57:49 +02002507 s.unallocated_blocks_are_zero = bdi.unallocated_blocks_are_zero;
Peter Lieven24f833c2013-11-27 11:07:07 +01002508 }
2509
Peter Lieven9fd77f92017-04-21 11:11:55 +02002510 ret = convert_do_copy(&s);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002511out:
Peter Lieven13c28af2013-11-27 11:07:01 +01002512 if (!ret) {
2513 qemu_progress_print(100, 0);
2514 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002515 qemu_progress_end();
Chunyan Liu83d05212014-06-05 17:20:51 +08002516 qemu_opts_del(opts);
2517 qemu_opts_free(create_opts);
Markus Armbrusterfbf28a42014-09-29 16:07:55 +02002518 qemu_opts_del(sn_opts);
Daniel P. Berrangé8d65a3c2018-08-14 13:39:47 +01002519 qobject_unref(open_opts);
Peter Lieven9fd77f92017-04-21 11:11:55 +02002520 blk_unref(s.target);
2521 if (s.src) {
2522 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2523 blk_unref(s.src[bs_i]);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002524 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002525 g_free(s.src);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002526 }
Peter Lieven9fd77f92017-04-21 11:11:55 +02002527 g_free(s.src_sectors);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002528fail_getopt:
2529 g_free(options);
2530
Peter Lieven9fd77f92017-04-21 11:11:55 +02002531 return !!ret;
bellardea2384d2004-08-01 21:59:26 +00002532}
2533
bellard57d1a2b2004-08-03 21:15:11 +00002534
bellardfaea38e2006-08-05 21:31:00 +00002535static void dump_snapshots(BlockDriverState *bs)
2536{
2537 QEMUSnapshotInfo *sn_tab, *sn;
2538 int nb_sns, i;
bellardfaea38e2006-08-05 21:31:00 +00002539
2540 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2541 if (nb_sns <= 0)
2542 return;
2543 printf("Snapshot list:\n");
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002544 bdrv_snapshot_dump(NULL);
Wenchao Xia5b917042013-05-25 11:09:45 +08002545 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002546 for(i = 0; i < nb_sns; i++) {
2547 sn = &sn_tab[i];
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002548 bdrv_snapshot_dump(sn);
Wenchao Xia5b917042013-05-25 11:09:45 +08002549 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002550 }
Anthony Liguori7267c092011-08-20 22:09:37 -05002551 g_free(sn_tab);
bellardfaea38e2006-08-05 21:31:00 +00002552}
2553
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002554static void dump_json_image_info_list(ImageInfoList *list)
2555{
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002556 QString *str;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002557 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002558 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002559
2560 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2561 visit_complete(v, &obj);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002562 str = qobject_to_json_pretty(obj);
2563 assert(str != NULL);
2564 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002565 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002566 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002567 qobject_unref(str);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002568}
2569
Benoît Canetc054b3f2012-09-05 13:09:02 +02002570static void dump_json_image_info(ImageInfo *info)
2571{
Benoît Canetc054b3f2012-09-05 13:09:02 +02002572 QString *str;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002573 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002574 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002575
2576 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2577 visit_complete(v, &obj);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002578 str = qobject_to_json_pretty(obj);
2579 assert(str != NULL);
2580 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002581 qobject_unref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002582 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02002583 qobject_unref(str);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002584}
2585
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002586static void dump_human_image_info_list(ImageInfoList *list)
2587{
2588 ImageInfoList *elem;
2589 bool delim = false;
2590
2591 for (elem = list; elem; elem = elem->next) {
2592 if (delim) {
2593 printf("\n");
2594 }
2595 delim = true;
2596
Markus Armbrustere1ce7d72019-04-17 21:17:55 +02002597 bdrv_image_info_dump(elem->value);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002598 }
2599}
2600
2601static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2602{
2603 return strcmp(a, b) == 0;
2604}
2605
2606/**
2607 * Open an image file chain and return an ImageInfoList
2608 *
2609 * @filename: topmost image filename
2610 * @fmt: topmost image format (may be NULL to autodetect)
2611 * @chain: true - enumerate entire backing file chain
2612 * false - only topmost image file
2613 *
2614 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2615 * image file. If there was an error a message will have been printed to
2616 * stderr.
2617 */
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002618static ImageInfoList *collect_image_info_list(bool image_opts,
2619 const char *filename,
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002620 const char *fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002621 bool chain, bool force_share)
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002622{
2623 ImageInfoList *head = NULL;
2624 ImageInfoList **last = &head;
2625 GHashTable *filenames;
Wenchao Xia43526ec2013-06-06 12:27:58 +08002626 Error *err = NULL;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002627
2628 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2629
2630 while (filename) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02002631 BlockBackend *blk;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002632 BlockDriverState *bs;
2633 ImageInfo *info;
2634 ImageInfoList *elem;
2635
2636 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2637 error_report("Backing file '%s' creates an infinite loop.",
2638 filename);
2639 goto err;
2640 }
2641 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2642
Max Reitzefaa7c42016-03-16 19:54:38 +01002643 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08002644 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2645 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002646 if (!blk) {
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002647 goto err;
2648 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002649 bs = blk_bs(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002650
Wenchao Xia43526ec2013-06-06 12:27:58 +08002651 bdrv_query_image_info(bs, &info, &err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002652 if (err) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01002653 error_report_err(err);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002654 blk_unref(blk);
Wenchao Xia43526ec2013-06-06 12:27:58 +08002655 goto err;
Wenchao Xiafb0ed452013-06-06 12:27:57 +08002656 }
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002657
2658 elem = g_new0(ImageInfoList, 1);
2659 elem->value = info;
2660 *last = elem;
2661 last = &elem->next;
2662
Markus Armbruster26f54e92014-10-07 13:59:04 +02002663 blk_unref(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002664
2665 filename = fmt = NULL;
2666 if (chain) {
2667 if (info->has_full_backing_filename) {
2668 filename = info->full_backing_filename;
2669 } else if (info->has_backing_filename) {
John Snow92d617a2015-12-14 14:55:15 -05002670 error_report("Could not determine absolute backing filename,"
2671 " but backing filename '%s' present",
2672 info->backing_filename);
2673 goto err;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002674 }
2675 if (info->has_backing_filename_format) {
2676 fmt = info->backing_filename_format;
2677 }
2678 }
2679 }
2680 g_hash_table_destroy(filenames);
2681 return head;
2682
2683err:
2684 qapi_free_ImageInfoList(head);
2685 g_hash_table_destroy(filenames);
2686 return NULL;
2687}
2688
Benoît Canetc054b3f2012-09-05 13:09:02 +02002689static int img_info(int argc, char **argv)
2690{
2691 int c;
2692 OutputFormat output_format = OFORMAT_HUMAN;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002693 bool chain = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002694 const char *filename, *fmt, *output;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002695 ImageInfoList *list;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002696 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08002697 bool force_share = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002698
bellardea2384d2004-08-01 21:59:26 +00002699 fmt = NULL;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002700 output = NULL;
bellardea2384d2004-08-01 21:59:26 +00002701 for(;;) {
Benoît Canetc054b3f2012-09-05 13:09:02 +02002702 int option_index = 0;
2703 static const struct option long_options[] = {
2704 {"help", no_argument, 0, 'h'},
2705 {"format", required_argument, 0, 'f'},
2706 {"output", required_argument, 0, OPTION_OUTPUT},
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002707 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002708 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002709 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002710 {"force-share", no_argument, 0, 'U'},
Benoît Canetc054b3f2012-09-05 13:09:02 +02002711 {0, 0, 0, 0}
2712 };
Fam Zheng335e9932017-05-03 00:35:39 +08002713 c = getopt_long(argc, argv, ":f:hU",
Benoît Canetc054b3f2012-09-05 13:09:02 +02002714 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002715 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002716 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002717 }
bellardea2384d2004-08-01 21:59:26 +00002718 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002719 case ':':
2720 missing_argument(argv[optind - 1]);
2721 break;
Jes Sorensenef873942010-12-06 15:25:40 +01002722 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002723 unrecognized_option(argv[optind - 1]);
2724 break;
bellardea2384d2004-08-01 21:59:26 +00002725 case 'h':
2726 help();
2727 break;
2728 case 'f':
2729 fmt = optarg;
2730 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002731 case 'U':
2732 force_share = true;
2733 break;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002734 case OPTION_OUTPUT:
2735 output = optarg;
2736 break;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002737 case OPTION_BACKING_CHAIN:
2738 chain = true;
2739 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002740 case OPTION_OBJECT: {
2741 QemuOpts *opts;
2742 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2743 optarg, true);
2744 if (!opts) {
2745 return 1;
2746 }
2747 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002748 case OPTION_IMAGE_OPTS:
2749 image_opts = true;
2750 break;
bellardea2384d2004-08-01 21:59:26 +00002751 }
2752 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02002753 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08002754 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002755 }
bellardea2384d2004-08-01 21:59:26 +00002756 filename = argv[optind++];
2757
Benoît Canetc054b3f2012-09-05 13:09:02 +02002758 if (output && !strcmp(output, "json")) {
2759 output_format = OFORMAT_JSON;
2760 } else if (output && !strcmp(output, "human")) {
2761 output_format = OFORMAT_HUMAN;
2762 } else if (output) {
2763 error_report("--output must be used with human or json as argument.");
2764 return 1;
2765 }
2766
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002767 if (qemu_opts_foreach(&qemu_object_opts,
2768 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00002769 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002770 return 1;
2771 }
2772
Fam Zheng335e9932017-05-03 00:35:39 +08002773 list = collect_image_info_list(image_opts, filename, fmt, chain,
2774 force_share);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002775 if (!list) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002776 return 1;
2777 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002778
Benoît Canetc054b3f2012-09-05 13:09:02 +02002779 switch (output_format) {
2780 case OFORMAT_HUMAN:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002781 dump_human_image_info_list(list);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002782 break;
2783 case OFORMAT_JSON:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002784 if (chain) {
2785 dump_json_image_info_list(list);
2786 } else {
2787 dump_json_image_info(list->value);
2788 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002789 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002790 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002791
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002792 qapi_free_ImageInfoList(list);
bellardea2384d2004-08-01 21:59:26 +00002793 return 0;
2794}
2795
Eric Blake30065d12019-03-26 13:40:43 -05002796static int dump_map_entry(OutputFormat output_format, MapEntry *e,
2797 MapEntry *next)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002798{
2799 switch (output_format) {
2800 case OFORMAT_HUMAN:
Fam Zheng16b0d552016-01-26 11:59:02 +08002801 if (e->data && !e->has_offset) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002802 error_report("File contains external, encrypted or compressed clusters.");
Eric Blake30065d12019-03-26 13:40:43 -05002803 return -1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002804 }
Fam Zheng16b0d552016-01-26 11:59:02 +08002805 if (e->data && !e->zero) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002806 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
Fam Zheng16b0d552016-01-26 11:59:02 +08002807 e->start, e->length,
2808 e->has_offset ? e->offset : 0,
2809 e->has_filename ? e->filename : "");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002810 }
2811 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2812 * Modify the flags here to allow more coalescing.
2813 */
Fam Zheng16b0d552016-01-26 11:59:02 +08002814 if (next && (!next->data || next->zero)) {
2815 next->data = false;
2816 next->zero = true;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002817 }
2818 break;
2819 case OFORMAT_JSON:
Fam Zheng16b0d552016-01-26 11:59:02 +08002820 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
2821 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002822 (e->start == 0 ? "[" : ",\n"),
2823 e->start, e->length, e->depth,
Fam Zheng16b0d552016-01-26 11:59:02 +08002824 e->zero ? "true" : "false",
2825 e->data ? "true" : "false");
2826 if (e->has_offset) {
Paolo Bonzinic745bfb2013-09-11 18:47:52 +02002827 printf(", \"offset\": %"PRId64"", e->offset);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002828 }
2829 putchar('}');
2830
2831 if (!next) {
2832 printf("]\n");
2833 }
2834 break;
2835 }
Eric Blake30065d12019-03-26 13:40:43 -05002836 return 0;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002837}
2838
Eric Blake5e344dd2017-10-11 22:47:02 -05002839static int get_block_status(BlockDriverState *bs, int64_t offset,
2840 int64_t bytes, MapEntry *e)
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002841{
Eric Blake237d78f2017-10-11 22:47:03 -05002842 int ret;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002843 int depth;
Fam Zheng67a0fd22016-01-26 11:58:48 +08002844 BlockDriverState *file;
John Snow28756452016-02-05 13:12:33 -05002845 bool has_offset;
Eric Blake237d78f2017-10-11 22:47:03 -05002846 int64_t map;
Max Reitzf30c66b2019-02-01 20:29:05 +01002847 char *filename = NULL;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002848
2849 /* As an optimization, we could cache the current range of unallocated
2850 * clusters in each file of the chain, and avoid querying the same
2851 * range repeatedly.
2852 */
2853
2854 depth = 0;
2855 for (;;) {
Eric Blake237d78f2017-10-11 22:47:03 -05002856 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002857 if (ret < 0) {
2858 return ret;
2859 }
Eric Blake237d78f2017-10-11 22:47:03 -05002860 assert(bytes);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002861 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2862 break;
2863 }
Kevin Wolf760e0062015-06-17 14:55:21 +02002864 bs = backing_bs(bs);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002865 if (bs == NULL) {
2866 ret = 0;
2867 break;
2868 }
2869
2870 depth++;
2871 }
2872
John Snow28756452016-02-05 13:12:33 -05002873 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
2874
Max Reitzf30c66b2019-02-01 20:29:05 +01002875 if (file && has_offset) {
2876 bdrv_refresh_filename(file);
2877 filename = file->filename;
2878 }
2879
John Snow28756452016-02-05 13:12:33 -05002880 *e = (MapEntry) {
Eric Blake5e344dd2017-10-11 22:47:02 -05002881 .start = offset,
Eric Blake237d78f2017-10-11 22:47:03 -05002882 .length = bytes,
John Snow28756452016-02-05 13:12:33 -05002883 .data = !!(ret & BDRV_BLOCK_DATA),
2884 .zero = !!(ret & BDRV_BLOCK_ZERO),
Eric Blake237d78f2017-10-11 22:47:03 -05002885 .offset = map,
John Snow28756452016-02-05 13:12:33 -05002886 .has_offset = has_offset,
2887 .depth = depth,
Max Reitzf30c66b2019-02-01 20:29:05 +01002888 .has_filename = filename,
2889 .filename = filename,
John Snow28756452016-02-05 13:12:33 -05002890 };
2891
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002892 return 0;
2893}
2894
Fam Zheng16b0d552016-01-26 11:59:02 +08002895static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
2896{
2897 if (curr->length == 0) {
2898 return false;
2899 }
2900 if (curr->zero != next->zero ||
2901 curr->data != next->data ||
2902 curr->depth != next->depth ||
2903 curr->has_filename != next->has_filename ||
2904 curr->has_offset != next->has_offset) {
2905 return false;
2906 }
2907 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
2908 return false;
2909 }
2910 if (curr->has_offset && curr->offset + curr->length != next->offset) {
2911 return false;
2912 }
2913 return true;
2914}
2915
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002916static int img_map(int argc, char **argv)
2917{
2918 int c;
2919 OutputFormat output_format = OFORMAT_HUMAN;
Markus Armbruster26f54e92014-10-07 13:59:04 +02002920 BlockBackend *blk;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002921 BlockDriverState *bs;
2922 const char *filename, *fmt, *output;
2923 int64_t length;
2924 MapEntry curr = { .length = 0 }, next;
2925 int ret = 0;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002926 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08002927 bool force_share = false;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002928
2929 fmt = NULL;
2930 output = NULL;
2931 for (;;) {
2932 int option_index = 0;
2933 static const struct option long_options[] = {
2934 {"help", no_argument, 0, 'h'},
2935 {"format", required_argument, 0, 'f'},
2936 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002937 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002938 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08002939 {"force-share", no_argument, 0, 'U'},
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002940 {0, 0, 0, 0}
2941 };
Fam Zheng335e9932017-05-03 00:35:39 +08002942 c = getopt_long(argc, argv, ":f:hU",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002943 long_options, &option_index);
2944 if (c == -1) {
2945 break;
2946 }
2947 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002948 case ':':
2949 missing_argument(argv[optind - 1]);
2950 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002951 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08002952 unrecognized_option(argv[optind - 1]);
2953 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002954 case 'h':
2955 help();
2956 break;
2957 case 'f':
2958 fmt = optarg;
2959 break;
Fam Zheng335e9932017-05-03 00:35:39 +08002960 case 'U':
2961 force_share = true;
2962 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002963 case OPTION_OUTPUT:
2964 output = optarg;
2965 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002966 case OPTION_OBJECT: {
2967 QemuOpts *opts;
2968 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2969 optarg, true);
2970 if (!opts) {
2971 return 1;
2972 }
2973 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002974 case OPTION_IMAGE_OPTS:
2975 image_opts = true;
2976 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002977 }
2978 }
Fam Zhengac1307a2014-04-22 13:36:11 +08002979 if (optind != argc - 1) {
2980 error_exit("Expecting one image file name");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002981 }
Fam Zhengac1307a2014-04-22 13:36:11 +08002982 filename = argv[optind];
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002983
2984 if (output && !strcmp(output, "json")) {
2985 output_format = OFORMAT_JSON;
2986 } else if (output && !strcmp(output, "human")) {
2987 output_format = OFORMAT_HUMAN;
2988 } else if (output) {
2989 error_report("--output must be used with human or json as argument.");
2990 return 1;
2991 }
2992
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002993 if (qemu_opts_foreach(&qemu_object_opts,
2994 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00002995 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002996 return 1;
2997 }
2998
Fam Zheng335e9932017-05-03 00:35:39 +08002999 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003000 if (!blk) {
3001 return 1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003002 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003003 bs = blk_bs(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003004
3005 if (output_format == OFORMAT_HUMAN) {
3006 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
3007 }
3008
Max Reitzf1d3cd72015-02-05 13:58:18 -05003009 length = blk_getlength(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003010 while (curr.start + curr.length < length) {
Eric Blake5e344dd2017-10-11 22:47:02 -05003011 int64_t offset = curr.start + curr.length;
3012 int64_t n;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003013
3014 /* Probe up to 1 GiB at a time. */
Stefano Garzarella97ede572019-05-08 12:43:24 +02003015 n = MIN(1 * GiB, length - offset);
Eric Blake5e344dd2017-10-11 22:47:02 -05003016 ret = get_block_status(bs, offset, n, &next);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003017
3018 if (ret < 0) {
3019 error_report("Could not read file metadata: %s", strerror(-ret));
3020 goto out;
3021 }
3022
Fam Zheng16b0d552016-01-26 11:59:02 +08003023 if (entry_mergeable(&curr, &next)) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003024 curr.length += next.length;
3025 continue;
3026 }
3027
3028 if (curr.length > 0) {
Eric Blake30065d12019-03-26 13:40:43 -05003029 ret = dump_map_entry(output_format, &curr, &next);
3030 if (ret < 0) {
3031 goto out;
3032 }
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003033 }
3034 curr = next;
3035 }
3036
Eric Blake30065d12019-03-26 13:40:43 -05003037 ret = dump_map_entry(output_format, &curr, NULL);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003038
3039out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003040 blk_unref(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02003041 return ret < 0;
3042}
3043
aliguorif7b4a942009-01-07 17:40:15 +00003044#define SNAPSHOT_LIST 1
3045#define SNAPSHOT_CREATE 2
3046#define SNAPSHOT_APPLY 3
3047#define SNAPSHOT_DELETE 4
3048
Stuart Brady153859b2009-06-07 00:42:17 +01003049static int img_snapshot(int argc, char **argv)
aliguorif7b4a942009-01-07 17:40:15 +00003050{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003051 BlockBackend *blk;
aliguorif7b4a942009-01-07 17:40:15 +00003052 BlockDriverState *bs;
3053 QEMUSnapshotInfo sn;
3054 char *filename, *snapshot_name = NULL;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003055 int c, ret = 0, bdrv_oflags;
aliguorif7b4a942009-01-07 17:40:15 +00003056 int action = 0;
3057 qemu_timeval tv;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003058 bool quiet = false;
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003059 Error *err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003060 bool image_opts = false;
Fam Zheng335e9932017-05-03 00:35:39 +08003061 bool force_share = false;
aliguorif7b4a942009-01-07 17:40:15 +00003062
Kevin Wolfce099542016-03-15 13:01:04 +01003063 bdrv_oflags = BDRV_O_RDWR;
aliguorif7b4a942009-01-07 17:40:15 +00003064 /* Parse commandline parameters */
3065 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003066 static const struct option long_options[] = {
3067 {"help", no_argument, 0, 'h'},
3068 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003069 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003070 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003071 {0, 0, 0, 0}
3072 };
Fam Zheng335e9932017-05-03 00:35:39 +08003073 c = getopt_long(argc, argv, ":la:c:d:hqU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003074 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003075 if (c == -1) {
aliguorif7b4a942009-01-07 17:40:15 +00003076 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003077 }
aliguorif7b4a942009-01-07 17:40:15 +00003078 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003079 case ':':
3080 missing_argument(argv[optind - 1]);
3081 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003082 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003083 unrecognized_option(argv[optind - 1]);
3084 break;
aliguorif7b4a942009-01-07 17:40:15 +00003085 case 'h':
3086 help();
Stuart Brady153859b2009-06-07 00:42:17 +01003087 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003088 case 'l':
3089 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003090 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003091 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003092 }
3093 action = SNAPSHOT_LIST;
Naphtali Spreif5edb012010-01-17 16:48:13 +02003094 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
aliguorif7b4a942009-01-07 17:40:15 +00003095 break;
3096 case 'a':
3097 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003098 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003099 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003100 }
3101 action = SNAPSHOT_APPLY;
3102 snapshot_name = optarg;
3103 break;
3104 case 'c':
3105 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003106 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003107 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003108 }
3109 action = SNAPSHOT_CREATE;
3110 snapshot_name = optarg;
3111 break;
3112 case 'd':
3113 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003114 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01003115 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003116 }
3117 action = SNAPSHOT_DELETE;
3118 snapshot_name = optarg;
3119 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003120 case 'q':
3121 quiet = true;
3122 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003123 case 'U':
3124 force_share = true;
3125 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003126 case OPTION_OBJECT: {
3127 QemuOpts *opts;
3128 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3129 optarg, true);
3130 if (!opts) {
3131 return 1;
3132 }
3133 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003134 case OPTION_IMAGE_OPTS:
3135 image_opts = true;
3136 break;
aliguorif7b4a942009-01-07 17:40:15 +00003137 }
3138 }
3139
Kevin Wolffc11eb22013-08-05 10:53:04 +02003140 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003141 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003142 }
aliguorif7b4a942009-01-07 17:40:15 +00003143 filename = argv[optind++];
3144
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003145 if (qemu_opts_foreach(&qemu_object_opts,
3146 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00003147 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003148 return 1;
3149 }
3150
aliguorif7b4a942009-01-07 17:40:15 +00003151 /* Open the image */
Fam Zheng335e9932017-05-03 00:35:39 +08003152 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3153 force_share);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003154 if (!blk) {
3155 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003156 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003157 bs = blk_bs(blk);
aliguorif7b4a942009-01-07 17:40:15 +00003158
3159 /* Perform the requested action */
3160 switch(action) {
3161 case SNAPSHOT_LIST:
3162 dump_snapshots(bs);
3163 break;
3164
3165 case SNAPSHOT_CREATE:
3166 memset(&sn, 0, sizeof(sn));
3167 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3168
3169 qemu_gettimeofday(&tv);
3170 sn.date_sec = tv.tv_sec;
3171 sn.date_nsec = tv.tv_usec * 1000;
3172
3173 ret = bdrv_snapshot_create(bs, &sn);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003174 if (ret) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003175 error_report("Could not create snapshot '%s': %d (%s)",
aliguorif7b4a942009-01-07 17:40:15 +00003176 snapshot_name, ret, strerror(-ret));
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003177 }
aliguorif7b4a942009-01-07 17:40:15 +00003178 break;
3179
3180 case SNAPSHOT_APPLY:
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003181 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003182 if (ret) {
Kevin Wolf0b62bcb2017-11-20 15:28:41 +01003183 error_reportf_err(err, "Could not apply snapshot '%s': ",
3184 snapshot_name);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003185 }
aliguorif7b4a942009-01-07 17:40:15 +00003186 break;
3187
3188 case SNAPSHOT_DELETE:
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003189 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3190 if (ret < 0) {
3191 error_report("Could not delete snapshot '%s': snapshot not "
3192 "found", snapshot_name);
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08003193 ret = 1;
Daniel Henrique Barboza8c040932018-11-07 11:09:59 -02003194 } else {
3195 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3196 if (ret < 0) {
3197 error_reportf_err(err, "Could not delete snapshot '%s': ",
3198 snapshot_name);
3199 ret = 1;
3200 }
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003201 }
aliguorif7b4a942009-01-07 17:40:15 +00003202 break;
3203 }
3204
3205 /* Cleanup */
Markus Armbruster26f54e92014-10-07 13:59:04 +02003206 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003207 if (ret) {
3208 return 1;
3209 }
Stuart Brady153859b2009-06-07 00:42:17 +01003210 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00003211}
3212
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003213static int img_rebase(int argc, char **argv)
3214{
Markus Armbruster26f54e92014-10-07 13:59:04 +02003215 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
Paolo Bonzini396374c2016-02-25 23:53:54 +01003216 uint8_t *buf_old = NULL;
3217 uint8_t *buf_new = NULL;
Sam Eiderman863cc782019-05-23 19:33:36 +03003218 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003219 char *filename;
Max Reitz40055952014-07-22 22:58:42 +02003220 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3221 int c, flags, src_flags, ret;
Kevin Wolfce099542016-03-15 13:01:04 +01003222 bool writethrough, src_writethrough;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003223 int unsafe = 0;
Fam Zheng335e9932017-05-03 00:35:39 +08003224 bool force_share = false;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003225 int progress = 0;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003226 bool quiet = false;
Max Reitz34b5d2c2013-09-05 14:45:29 +02003227 Error *local_err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003228 bool image_opts = false;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003229
3230 /* Parse commandline parameters */
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003231 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003232 cache = BDRV_DEFAULT_CACHE;
Max Reitz40055952014-07-22 22:58:42 +02003233 src_cache = BDRV_DEFAULT_CACHE;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003234 out_baseimg = NULL;
3235 out_basefmt = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003236 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003237 static const struct option long_options[] = {
3238 {"help", no_argument, 0, 'h'},
3239 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003240 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08003241 {"force-share", no_argument, 0, 'U'},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003242 {0, 0, 0, 0}
3243 };
Fam Zheng335e9932017-05-03 00:35:39 +08003244 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003245 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003246 if (c == -1) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003247 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003248 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003249 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003250 case ':':
3251 missing_argument(argv[optind - 1]);
3252 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003253 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003254 unrecognized_option(argv[optind - 1]);
3255 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003256 case 'h':
3257 help();
3258 return 0;
Kevin Wolfe53dbee2010-03-02 12:14:31 +01003259 case 'f':
3260 fmt = optarg;
3261 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003262 case 'F':
3263 out_basefmt = optarg;
3264 break;
3265 case 'b':
3266 out_baseimg = optarg;
3267 break;
3268 case 'u':
3269 unsafe = 1;
3270 break;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003271 case 'p':
3272 progress = 1;
3273 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003274 case 't':
3275 cache = optarg;
3276 break;
Max Reitz40055952014-07-22 22:58:42 +02003277 case 'T':
3278 src_cache = optarg;
3279 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003280 case 'q':
3281 quiet = true;
3282 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003283 case OPTION_OBJECT: {
3284 QemuOpts *opts;
3285 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3286 optarg, true);
3287 if (!opts) {
3288 return 1;
3289 }
3290 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003291 case OPTION_IMAGE_OPTS:
3292 image_opts = true;
3293 break;
Fam Zheng335e9932017-05-03 00:35:39 +08003294 case 'U':
3295 force_share = true;
3296 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003297 }
3298 }
3299
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003300 if (quiet) {
3301 progress = 0;
3302 }
3303
Fam Zhengac1307a2014-04-22 13:36:11 +08003304 if (optind != argc - 1) {
3305 error_exit("Expecting one image file name");
3306 }
3307 if (!unsafe && !out_baseimg) {
3308 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01003309 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003310 filename = argv[optind++];
3311
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003312 if (qemu_opts_foreach(&qemu_object_opts,
3313 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00003314 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003315 return 1;
3316 }
3317
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003318 qemu_progress_init(progress, 2.0);
3319 qemu_progress_print(0, 100);
3320
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003321 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
Kevin Wolfce099542016-03-15 13:01:04 +01003322 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003323 if (ret < 0) {
3324 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003325 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04003326 }
3327
Kevin Wolfce099542016-03-15 13:01:04 +01003328 src_flags = 0;
3329 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
Max Reitz40055952014-07-22 22:58:42 +02003330 if (ret < 0) {
3331 error_report("Invalid source cache option: %s", src_cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003332 goto out;
Max Reitz40055952014-07-22 22:58:42 +02003333 }
3334
Kevin Wolfce099542016-03-15 13:01:04 +01003335 /* The source files are opened read-only, don't care about WCE */
3336 assert((src_flags & BDRV_O_RDWR) == 0);
3337 (void) src_writethrough;
3338
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003339 /*
3340 * Open the images.
3341 *
3342 * Ignore the old backing file for unsafe rebase in case we want to correct
3343 * the reference to a renamed or moved backing file.
3344 */
Fam Zheng335e9932017-05-03 00:35:39 +08003345 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3346 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003347 if (!blk) {
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003348 ret = -1;
3349 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003350 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003351 bs = blk_bs(blk);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003352
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003353 if (out_basefmt != NULL) {
Max Reitz644483d2015-02-05 13:58:17 -05003354 if (bdrv_find_format(out_basefmt) == NULL) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003355 error_report("Invalid format name: '%s'", out_basefmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003356 ret = -1;
3357 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003358 }
3359 }
3360
3361 /* For safe rebasing we need to compare old and new backing file */
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01003362 if (!unsafe) {
Max Reitz644483d2015-02-05 13:58:17 -05003363 QDict *options = NULL;
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003364 BlockDriverState *base_bs = backing_bs(bs);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003365
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003366 if (base_bs) {
Kevin Wolfd861ab32019-04-25 14:25:10 +02003367 blk_old_backing = blk_new(qemu_get_aio_context(),
3368 BLK_PERM_CONSISTENT_READ,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003369 BLK_PERM_ALL);
3370 ret = blk_insert_bs(blk_old_backing, base_bs,
3371 &local_err);
3372 if (ret < 0) {
Max Reitz35ddd932019-05-09 19:52:35 +02003373 error_reportf_err(local_err,
Sam Eiderman4ebe0612019-05-23 19:33:35 +03003374 "Could not reuse old backing file '%s': ",
3375 base_bs->filename);
Max Reitz35ddd932019-05-09 19:52:35 +02003376 goto out;
3377 }
3378 } else {
3379 blk_old_backing = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003380 }
Max Reitz644483d2015-02-05 13:58:17 -05003381
Alex Bligha6166732012-10-16 13:46:18 +01003382 if (out_baseimg[0]) {
Max Reitzd16699b2018-05-09 20:20:01 +02003383 const char *overlay_filename;
3384 char *out_real_path;
3385
Fam Zheng335e9932017-05-03 00:35:39 +08003386 options = qdict_new();
Max Reitz644483d2015-02-05 13:58:17 -05003387 if (out_basefmt) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003388 qdict_put_str(options, "driver", out_basefmt);
Fam Zheng335e9932017-05-03 00:35:39 +08003389 }
3390 if (force_share) {
3391 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
Max Reitz644483d2015-02-05 13:58:17 -05003392 }
3393
Max Reitzf30c66b2019-02-01 20:29:05 +01003394 bdrv_refresh_filename(bs);
Max Reitzd16699b2018-05-09 20:20:01 +02003395 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3396 : bs->filename;
Max Reitz645ae7d2019-02-01 20:29:14 +01003397 out_real_path =
3398 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3399 out_baseimg,
3400 &local_err);
Max Reitzd16699b2018-05-09 20:20:01 +02003401 if (local_err) {
Max Reitzf22356d2019-05-28 21:53:38 +02003402 qobject_unref(options);
Max Reitzd16699b2018-05-09 20:20:01 +02003403 error_reportf_err(local_err,
3404 "Could not resolve backing filename: ");
3405 ret = -1;
Max Reitzd16699b2018-05-09 20:20:01 +02003406 goto out;
3407 }
3408
Sam Eiderman863cc782019-05-23 19:33:36 +03003409 /*
3410 * Find out whether we rebase an image on top of a previous image
3411 * in its chain.
3412 */
3413 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
Sam Eiderman330c7292019-05-23 19:33:37 +03003414 if (prefix_chain_bs) {
Max Reitzf22356d2019-05-28 21:53:38 +02003415 qobject_unref(options);
Sam Eiderman330c7292019-05-23 19:33:37 +03003416 g_free(out_real_path);
Max Reitzf22356d2019-05-28 21:53:38 +02003417
Kevin Wolfd861ab32019-04-25 14:25:10 +02003418 blk_new_backing = blk_new(qemu_get_aio_context(),
3419 BLK_PERM_CONSISTENT_READ,
Sam Eiderman330c7292019-05-23 19:33:37 +03003420 BLK_PERM_ALL);
3421 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
3422 &local_err);
3423 if (ret < 0) {
3424 error_reportf_err(local_err,
3425 "Could not reuse backing file '%s': ",
3426 out_baseimg);
3427 goto out;
3428 }
3429 } else {
3430 blk_new_backing = blk_new_open(out_real_path, NULL,
3431 options, src_flags, &local_err);
3432 g_free(out_real_path);
3433 if (!blk_new_backing) {
3434 error_reportf_err(local_err,
3435 "Could not open new backing file '%s': ",
3436 out_baseimg);
3437 ret = -1;
3438 goto out;
3439 }
Alex Bligha6166732012-10-16 13:46:18 +01003440 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003441 }
3442 }
3443
3444 /*
3445 * Check each unallocated cluster in the COW file. If it is unallocated,
3446 * accesses go to the backing file. We must therefore compare this cluster
3447 * in the old and new backing file, and if they differ we need to copy it
3448 * from the old backing file into the COW file.
3449 *
3450 * If qemu-img crashes during this step, no harm is done. The content of
3451 * the image is the same as the original one at any time.
3452 */
3453 if (!unsafe) {
Eric Blake41536282017-10-11 22:47:15 -05003454 int64_t size;
Max Reitz35ddd932019-05-09 19:52:35 +02003455 int64_t old_backing_size = 0;
Eric Blake41536282017-10-11 22:47:15 -05003456 int64_t new_backing_size = 0;
3457 uint64_t offset;
3458 int64_t n;
Kevin Wolf1f710492012-10-12 14:29:18 +02003459 float local_progress = 0;
TeLeMand6771bf2010-02-08 16:20:00 +08003460
Max Reitzf1d3cd72015-02-05 13:58:18 -05003461 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3462 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003463
Eric Blake41536282017-10-11 22:47:15 -05003464 size = blk_getlength(blk);
3465 if (size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003466 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003467 filename, strerror(-size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003468 ret = -1;
3469 goto out;
3470 }
Max Reitz35ddd932019-05-09 19:52:35 +02003471 if (blk_old_backing) {
3472 old_backing_size = blk_getlength(blk_old_backing);
3473 if (old_backing_size < 0) {
3474 char backing_name[PATH_MAX];
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003475
Max Reitz35ddd932019-05-09 19:52:35 +02003476 bdrv_get_backing_filename(bs, backing_name,
3477 sizeof(backing_name));
3478 error_report("Could not get size of '%s': %s",
3479 backing_name, strerror(-old_backing_size));
3480 ret = -1;
3481 goto out;
3482 }
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003483 }
Max Reitzf1d3cd72015-02-05 13:58:18 -05003484 if (blk_new_backing) {
Eric Blake41536282017-10-11 22:47:15 -05003485 new_backing_size = blk_getlength(blk_new_backing);
3486 if (new_backing_size < 0) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003487 error_report("Could not get size of '%s': %s",
Eric Blake41536282017-10-11 22:47:15 -05003488 out_baseimg, strerror(-new_backing_size));
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003489 ret = -1;
3490 goto out;
3491 }
Alex Bligha6166732012-10-16 13:46:18 +01003492 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003493
Eric Blake41536282017-10-11 22:47:15 -05003494 if (size != 0) {
3495 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
Kevin Wolf1f710492012-10-12 14:29:18 +02003496 }
3497
Eric Blake41536282017-10-11 22:47:15 -05003498 for (offset = 0; offset < size; offset += n) {
Max Reitz1c6e8772019-05-09 19:52:36 +02003499 bool buf_old_is_zero = false;
3500
Eric Blake41536282017-10-11 22:47:15 -05003501 /* How many bytes can we handle with the next read? */
3502 n = MIN(IO_BUF_SIZE, size - offset);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003503
3504 /* If the cluster is allocated, we don't need to take action */
Eric Blake41536282017-10-11 22:47:15 -05003505 ret = bdrv_is_allocated(bs, offset, n, &n);
Paolo Bonzinid6636402013-09-04 19:00:25 +02003506 if (ret < 0) {
3507 error_report("error while reading image metadata: %s",
3508 strerror(-ret));
3509 goto out;
3510 }
Kevin Wolfcc60e322010-04-29 14:47:48 +02003511 if (ret) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003512 continue;
3513 }
3514
Sam Eiderman863cc782019-05-23 19:33:36 +03003515 if (prefix_chain_bs) {
3516 /*
3517 * If cluster wasn't changed since prefix_chain, we don't need
3518 * to take action
3519 */
3520 ret = bdrv_is_allocated_above(backing_bs(bs), prefix_chain_bs,
3521 offset, n, &n);
3522 if (ret < 0) {
3523 error_report("error while reading image metadata: %s",
3524 strerror(-ret));
3525 goto out;
3526 }
3527 if (!ret) {
3528 continue;
3529 }
3530 }
3531
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003532 /*
3533 * Read old and new backing file and take into consideration that
3534 * backing files may be smaller than the COW image.
3535 */
Eric Blake41536282017-10-11 22:47:15 -05003536 if (offset >= old_backing_size) {
3537 memset(buf_old, 0, n);
Max Reitz1c6e8772019-05-09 19:52:36 +02003538 buf_old_is_zero = true;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003539 } else {
Eric Blake41536282017-10-11 22:47:15 -05003540 if (offset + n > old_backing_size) {
3541 n = old_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003542 }
3543
Eric Blake41536282017-10-11 22:47:15 -05003544 ret = blk_pread(blk_old_backing, offset, buf_old, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003545 if (ret < 0) {
3546 error_report("error while reading from old backing file");
3547 goto out;
3548 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003549 }
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003550
Eric Blake41536282017-10-11 22:47:15 -05003551 if (offset >= new_backing_size || !blk_new_backing) {
3552 memset(buf_new, 0, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003553 } else {
Eric Blake41536282017-10-11 22:47:15 -05003554 if (offset + n > new_backing_size) {
3555 n = new_backing_size - offset;
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003556 }
3557
Eric Blake41536282017-10-11 22:47:15 -05003558 ret = blk_pread(blk_new_backing, offset, buf_new, n);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003559 if (ret < 0) {
3560 error_report("error while reading from new backing file");
3561 goto out;
3562 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003563 }
3564
3565 /* If they differ, we need to write to the COW file */
3566 uint64_t written = 0;
3567
Eric Blake41536282017-10-11 22:47:15 -05003568 while (written < n) {
Eric Blakedc61cd32017-10-11 22:47:14 -05003569 int64_t pnum;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003570
Eric Blake41536282017-10-11 22:47:15 -05003571 if (compare_buffers(buf_old + written, buf_new + written,
3572 n - written, &pnum))
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003573 {
Max Reitz1c6e8772019-05-09 19:52:36 +02003574 if (buf_old_is_zero) {
3575 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0);
3576 } else {
3577 ret = blk_pwrite(blk, offset + written,
3578 buf_old + written, pnum, 0);
3579 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003580 if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003581 error_report("Error while writing to COW image: %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003582 strerror(-ret));
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003583 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003584 }
3585 }
3586
3587 written += pnum;
3588 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003589 qemu_progress_print(local_progress, 100);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003590 }
3591 }
3592
3593 /*
3594 * Change the backing file. All clusters that are different from the old
3595 * backing file are overwritten in the COW file now, so the visible content
3596 * doesn't change when we switch the backing file.
3597 */
Alex Bligha6166732012-10-16 13:46:18 +01003598 if (out_baseimg && *out_baseimg) {
3599 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
3600 } else {
3601 ret = bdrv_change_backing_file(bs, NULL, NULL);
3602 }
3603
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003604 if (ret == -ENOSPC) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003605 error_report("Could not change the backing file to '%s': No "
3606 "space left in the file header", out_baseimg);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003607 } else if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003608 error_report("Could not change the backing file to '%s': %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003609 out_baseimg, strerror(-ret));
3610 }
3611
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003612 qemu_progress_print(100, 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003613 /*
3614 * TODO At this point it is possible to check if any clusters that are
3615 * allocated in the COW file are the same in the backing file. If so, they
3616 * could be dropped from the COW file. Don't do this before switching the
3617 * backing file, in case of a crash this would lead to corruption.
3618 */
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003619out:
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003620 qemu_progress_end();
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003621 /* Cleanup */
3622 if (!unsafe) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02003623 blk_unref(blk_old_backing);
Markus Armbruster26f54e92014-10-07 13:59:04 +02003624 blk_unref(blk_new_backing);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003625 }
Paolo Bonzini396374c2016-02-25 23:53:54 +01003626 qemu_vfree(buf_old);
3627 qemu_vfree(buf_new);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003628
Markus Armbruster26f54e92014-10-07 13:59:04 +02003629 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003630 if (ret) {
3631 return 1;
3632 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003633 return 0;
3634}
3635
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003636static int img_resize(int argc, char **argv)
3637{
Markus Armbruster6750e792015-02-12 17:43:08 +01003638 Error *err = NULL;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003639 int c, ret, relative;
3640 const char *filename, *fmt, *size;
Max Reitz5279b302018-04-21 18:39:57 +02003641 int64_t n, total_size, current_size, new_size;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003642 bool quiet = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003643 BlockBackend *blk = NULL;
Max Reitzdc5f6902017-06-13 22:20:55 +02003644 PreallocMode prealloc = PREALLOC_MODE_OFF;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003645 QemuOpts *param;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003646
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003647 static QemuOptsList resize_options = {
3648 .name = "resize_options",
3649 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3650 .desc = {
3651 {
3652 .name = BLOCK_OPT_SIZE,
3653 .type = QEMU_OPT_SIZE,
3654 .help = "Virtual disk size"
3655 }, {
3656 /* end of list */
3657 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003658 },
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003659 };
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003660 bool image_opts = false;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003661 bool shrink = false;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003662
Kevin Wolfe80fec72011-04-29 10:58:12 +02003663 /* Remove size from argv manually so that negative numbers are not treated
3664 * as options by getopt. */
3665 if (argc < 3) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003666 error_exit("Not enough arguments");
Kevin Wolfe80fec72011-04-29 10:58:12 +02003667 return 1;
3668 }
3669
3670 size = argv[--argc];
3671
3672 /* Parse getopt arguments */
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003673 fmt = NULL;
3674 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003675 static const struct option long_options[] = {
3676 {"help", no_argument, 0, 'h'},
3677 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003678 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Max Reitzdc5f6902017-06-13 22:20:55 +02003679 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003680 {"shrink", no_argument, 0, OPTION_SHRINK},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003681 {0, 0, 0, 0}
3682 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003683 c = getopt_long(argc, argv, ":f:hq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003684 long_options, NULL);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003685 if (c == -1) {
3686 break;
3687 }
3688 switch(c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003689 case ':':
3690 missing_argument(argv[optind - 1]);
3691 break;
Jes Sorensenef873942010-12-06 15:25:40 +01003692 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003693 unrecognized_option(argv[optind - 1]);
3694 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003695 case 'h':
3696 help();
3697 break;
3698 case 'f':
3699 fmt = optarg;
3700 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003701 case 'q':
3702 quiet = true;
3703 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003704 case OPTION_OBJECT: {
3705 QemuOpts *opts;
3706 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3707 optarg, true);
3708 if (!opts) {
3709 return 1;
3710 }
3711 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003712 case OPTION_IMAGE_OPTS:
3713 image_opts = true;
3714 break;
Max Reitzdc5f6902017-06-13 22:20:55 +02003715 case OPTION_PREALLOCATION:
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +02003716 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
Markus Armbruster06c60b62017-08-24 10:45:57 +02003717 PREALLOC_MODE__MAX, NULL);
Max Reitzdc5f6902017-06-13 22:20:55 +02003718 if (prealloc == PREALLOC_MODE__MAX) {
3719 error_report("Invalid preallocation mode '%s'", optarg);
3720 return 1;
3721 }
3722 break;
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003723 case OPTION_SHRINK:
3724 shrink = true;
3725 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003726 }
3727 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02003728 if (optind != argc - 1) {
Max Reitzbe8fbd42018-02-05 17:27:45 +01003729 error_exit("Expecting image file name and size");
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003730 }
3731 filename = argv[optind++];
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003732
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003733 if (qemu_opts_foreach(&qemu_object_opts,
3734 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00003735 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003736 return 1;
3737 }
3738
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003739 /* Choose grow, shrink, or absolute resize mode */
3740 switch (size[0]) {
3741 case '+':
3742 relative = 1;
3743 size++;
3744 break;
3745 case '-':
3746 relative = -1;
3747 size++;
3748 break;
3749 default:
3750 relative = 0;
3751 break;
3752 }
3753
3754 /* Parse size */
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -08003755 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
Markus Armbrusterf43e47d2015-02-12 17:52:20 +01003756 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +01003757 if (err) {
3758 error_report_err(err);
Jes Sorensen2a819982010-12-06 17:08:31 +01003759 ret = -1;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003760 qemu_opts_del(param);
Jes Sorensen2a819982010-12-06 17:08:31 +01003761 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003762 }
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003763 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3764 qemu_opts_del(param);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003765
Max Reitzefaa7c42016-03-16 19:54:38 +01003766 blk = img_open(image_opts, filename, fmt,
Fam Zheng335e9932017-05-03 00:35:39 +08003767 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
3768 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003769 if (!blk) {
Jes Sorensen2a819982010-12-06 17:08:31 +01003770 ret = -1;
3771 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003772 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003773
Max Reitzdc5f6902017-06-13 22:20:55 +02003774 current_size = blk_getlength(blk);
3775 if (current_size < 0) {
3776 error_report("Failed to inquire current image length: %s",
3777 strerror(-current_size));
3778 ret = -1;
3779 goto out;
3780 }
3781
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003782 if (relative) {
Max Reitzdc5f6902017-06-13 22:20:55 +02003783 total_size = current_size + n * relative;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003784 } else {
3785 total_size = n;
3786 }
3787 if (total_size <= 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003788 error_report("New image size must be positive");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003789 ret = -1;
3790 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003791 }
3792
Max Reitzdc5f6902017-06-13 22:20:55 +02003793 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
3794 error_report("Preallocation can only be used for growing images");
3795 ret = -1;
3796 goto out;
3797 }
3798
Pavel Butsykin4ffca892017-09-18 15:42:27 +03003799 if (total_size < current_size && !shrink) {
3800 warn_report("Shrinking an image will delete all data beyond the "
3801 "shrunken image's end. Before performing such an "
3802 "operation, make sure there is no important data there.");
3803
3804 if (g_strcmp0(bdrv_get_format_name(blk_bs(blk)), "raw") != 0) {
3805 error_report(
3806 "Use the --shrink option to perform a shrink operation.");
3807 ret = -1;
3808 goto out;
3809 } else {
3810 warn_report("Using the --shrink option will suppress this message. "
3811 "Note that future versions of qemu-img may refuse to "
3812 "shrink images without this option.");
3813 }
3814 }
3815
Max Reitzdc5f6902017-06-13 22:20:55 +02003816 ret = blk_truncate(blk, total_size, prealloc, &err);
Max Reitz5279b302018-04-21 18:39:57 +02003817 if (ret < 0) {
Max Reitzed3d2ec2017-03-28 22:51:27 +02003818 error_report_err(err);
Max Reitz5279b302018-04-21 18:39:57 +02003819 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003820 }
Max Reitz5279b302018-04-21 18:39:57 +02003821
3822 new_size = blk_getlength(blk);
3823 if (new_size < 0) {
3824 error_report("Failed to verify truncated image length: %s",
3825 strerror(-new_size));
3826 ret = -1;
3827 goto out;
3828 }
3829
3830 /* Some block drivers implement a truncation method, but only so
3831 * the user can cause qemu to refresh the image's size from disk.
3832 * The idea is that the user resizes the image outside of qemu and
3833 * then invokes block_resize to inform qemu about it.
3834 * (This includes iscsi and file-posix for device files.)
3835 * Of course, that is not the behavior someone invoking
3836 * qemu-img resize would find useful, so we catch that behavior
3837 * here and tell the user. */
3838 if (new_size != total_size && new_size == current_size) {
3839 error_report("Image was not resized; resizing may not be supported "
3840 "for this image");
3841 ret = -1;
3842 goto out;
3843 }
3844
3845 if (new_size != total_size) {
3846 warn_report("Image should have been resized to %" PRIi64
3847 " bytes, but was resized to %" PRIi64 " bytes",
3848 total_size, new_size);
3849 }
3850
3851 qprintf(quiet, "Image resized.\n");
3852
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003853out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003854 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003855 if (ret) {
3856 return 1;
3857 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003858 return 0;
3859}
3860
Max Reitz76a3a342014-10-27 11:12:51 +01003861static void amend_status_cb(BlockDriverState *bs,
Max Reitz8b139762015-07-27 17:51:32 +02003862 int64_t offset, int64_t total_work_size,
3863 void *opaque)
Max Reitz76a3a342014-10-27 11:12:51 +01003864{
3865 qemu_progress_print(100.f * offset / total_work_size, 0);
3866}
3867
Max Reitz51641352018-05-09 23:00:20 +02003868static int print_amend_option_help(const char *format)
3869{
3870 BlockDriver *drv;
3871
3872 /* Find driver and parse its options */
3873 drv = bdrv_find_format(format);
3874 if (!drv) {
3875 error_report("Unknown file format '%s'", format);
3876 return 1;
3877 }
3878
3879 if (!drv->bdrv_amend_options) {
3880 error_report("Format driver '%s' does not support option amendment",
3881 format);
3882 return 1;
3883 }
3884
3885 /* Every driver supporting amendment must have create_opts */
3886 assert(drv->create_opts);
3887
3888 printf("Creation options for '%s':\n", format);
Max Reitz63898712018-10-19 18:49:25 +02003889 qemu_opts_print_help(drv->create_opts, false);
Max Reitz51641352018-05-09 23:00:20 +02003890 printf("\nNote that not all of these options may be amendable.\n");
3891 return 0;
3892}
3893
Max Reitz6f176b42013-09-03 10:09:50 +02003894static int img_amend(int argc, char **argv)
3895{
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01003896 Error *err = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02003897 int c, ret = 0;
3898 char *options = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08003899 QemuOptsList *create_opts = NULL;
3900 QemuOpts *opts = NULL;
Max Reitzbd39e6e2014-07-22 22:58:43 +02003901 const char *fmt = NULL, *filename, *cache;
3902 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01003903 bool writethrough;
Max Reitz76a3a342014-10-27 11:12:51 +01003904 bool quiet = false, progress = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003905 BlockBackend *blk = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02003906 BlockDriverState *bs = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003907 bool image_opts = false;
Max Reitz6f176b42013-09-03 10:09:50 +02003908
Max Reitzbd39e6e2014-07-22 22:58:43 +02003909 cache = BDRV_DEFAULT_CACHE;
Max Reitz6f176b42013-09-03 10:09:50 +02003910 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003911 static const struct option long_options[] = {
3912 {"help", no_argument, 0, 'h'},
3913 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003914 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003915 {0, 0, 0, 0}
3916 };
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003917 c = getopt_long(argc, argv, ":ho:f:t:pq",
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003918 long_options, NULL);
Max Reitz6f176b42013-09-03 10:09:50 +02003919 if (c == -1) {
3920 break;
3921 }
3922
3923 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003924 case ':':
3925 missing_argument(argv[optind - 1]);
3926 break;
Stefan Hajnoczif7077622017-03-17 18:45:40 +08003927 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08003928 unrecognized_option(argv[optind - 1]);
3929 break;
3930 case 'h':
Stefan Hajnoczif7077622017-03-17 18:45:40 +08003931 help();
3932 break;
3933 case 'o':
3934 if (!is_valid_option_list(optarg)) {
3935 error_report("Invalid option list: %s", optarg);
3936 ret = -1;
3937 goto out_no_progress;
3938 }
3939 if (!options) {
3940 options = g_strdup(optarg);
3941 } else {
3942 char *old_options = options;
3943 options = g_strdup_printf("%s,%s", options, optarg);
3944 g_free(old_options);
3945 }
3946 break;
3947 case 'f':
3948 fmt = optarg;
3949 break;
3950 case 't':
3951 cache = optarg;
3952 break;
3953 case 'p':
3954 progress = true;
3955 break;
3956 case 'q':
3957 quiet = true;
3958 break;
3959 case OPTION_OBJECT:
3960 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3961 optarg, true);
3962 if (!opts) {
3963 ret = -1;
3964 goto out_no_progress;
3965 }
3966 break;
3967 case OPTION_IMAGE_OPTS:
3968 image_opts = true;
3969 break;
Max Reitz6f176b42013-09-03 10:09:50 +02003970 }
3971 }
3972
Max Reitz6f176b42013-09-03 10:09:50 +02003973 if (!options) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003974 error_exit("Must specify options (-o)");
Max Reitz6f176b42013-09-03 10:09:50 +02003975 }
3976
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003977 if (qemu_opts_foreach(&qemu_object_opts,
3978 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00003979 NULL, &error_fatal)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003980 ret = -1;
3981 goto out_no_progress;
3982 }
3983
Max Reitz76a3a342014-10-27 11:12:51 +01003984 if (quiet) {
3985 progress = false;
3986 }
3987 qemu_progress_init(progress, 1.0);
3988
Kevin Wolfa283cb62014-02-21 16:24:07 +01003989 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
3990 if (fmt && has_help_option(options)) {
3991 /* If a format is explicitly specified (and possibly no filename is
3992 * given), print option help here */
Max Reitz51641352018-05-09 23:00:20 +02003993 ret = print_amend_option_help(fmt);
Kevin Wolfa283cb62014-02-21 16:24:07 +01003994 goto out;
3995 }
3996
3997 if (optind != argc - 1) {
Max Reitzb2f27e42014-10-27 11:12:52 +01003998 error_report("Expecting one image file name");
3999 ret = -1;
4000 goto out;
Kevin Wolfa283cb62014-02-21 16:24:07 +01004001 }
Max Reitz6f176b42013-09-03 10:09:50 +02004002
Kevin Wolfce099542016-03-15 13:01:04 +01004003 flags = BDRV_O_RDWR;
4004 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitzbd39e6e2014-07-22 22:58:43 +02004005 if (ret < 0) {
4006 error_report("Invalid cache option: %s", cache);
4007 goto out;
4008 }
4009
Fam Zheng335e9932017-05-03 00:35:39 +08004010 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4011 false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004012 if (!blk) {
Max Reitz6f176b42013-09-03 10:09:50 +02004013 ret = -1;
4014 goto out;
4015 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02004016 bs = blk_bs(blk);
Max Reitz6f176b42013-09-03 10:09:50 +02004017
4018 fmt = bs->drv->format_name;
4019
Kevin Wolf626f84f2014-02-21 16:24:06 +01004020 if (has_help_option(options)) {
Kevin Wolfa283cb62014-02-21 16:24:07 +01004021 /* If the format was auto-detected, print option help here */
Max Reitz51641352018-05-09 23:00:20 +02004022 ret = print_amend_option_help(fmt);
Max Reitz6f176b42013-09-03 10:09:50 +02004023 goto out;
4024 }
4025
Max Reitz1f996682018-05-09 23:00:17 +02004026 if (!bs->drv->bdrv_amend_options) {
4027 error_report("Format driver '%s' does not support option amendment",
Max Reitzb2439d22014-12-02 18:32:47 +01004028 fmt);
4029 ret = -1;
4030 goto out;
4031 }
4032
Max Reitz1f996682018-05-09 23:00:17 +02004033 /* Every driver supporting amendment must have create_opts */
4034 assert(bs->drv->create_opts);
4035
Chunyan Liuc282e1f2014-06-05 17:21:11 +08004036 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
Chunyan Liu83d05212014-06-05 17:20:51 +08004037 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Paolo Bonziniece90862017-01-04 15:56:24 +01004038 qemu_opts_do_parse(opts, options, NULL, &err);
4039 if (err) {
4040 error_report_err(err);
4041 ret = -1;
4042 goto out;
Max Reitz6f176b42013-09-03 10:09:50 +02004043 }
4044
Max Reitz76a3a342014-10-27 11:12:51 +01004045 /* In case the driver does not call amend_status_cb() */
4046 qemu_progress_print(0.f, 0);
Max Reitzd1402b52018-05-09 23:00:18 +02004047 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, &err);
Max Reitz76a3a342014-10-27 11:12:51 +01004048 qemu_progress_print(100.f, 0);
Max Reitz6f176b42013-09-03 10:09:50 +02004049 if (ret < 0) {
Max Reitzd1402b52018-05-09 23:00:18 +02004050 error_report_err(err);
Max Reitz6f176b42013-09-03 10:09:50 +02004051 goto out;
4052 }
4053
4054out:
Max Reitz76a3a342014-10-27 11:12:51 +01004055 qemu_progress_end();
4056
Max Reitze814dff2015-08-20 16:00:38 -07004057out_no_progress:
Markus Armbruster26f54e92014-10-07 13:59:04 +02004058 blk_unref(blk);
Chunyan Liu83d05212014-06-05 17:20:51 +08004059 qemu_opts_del(opts);
4060 qemu_opts_free(create_opts);
Kevin Wolf626f84f2014-02-21 16:24:06 +01004061 g_free(options);
4062
Max Reitz6f176b42013-09-03 10:09:50 +02004063 if (ret) {
4064 return 1;
4065 }
4066 return 0;
4067}
4068
Kevin Wolfb6133b82014-08-05 14:17:13 +02004069typedef struct BenchData {
4070 BlockBackend *blk;
4071 uint64_t image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004072 bool write;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004073 int bufsize;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004074 int step;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004075 int nrreq;
4076 int n;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004077 int flush_interval;
4078 bool drain_on_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004079 uint8_t *buf;
4080 QEMUIOVector *qiov;
4081
4082 int in_flight;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004083 bool in_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004084 uint64_t offset;
4085} BenchData;
4086
Kevin Wolf55d539c2016-06-03 13:59:41 +02004087static void bench_undrained_flush_cb(void *opaque, int ret)
4088{
4089 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004090 error_report("Failed flush request: %s", strerror(-ret));
Kevin Wolf55d539c2016-06-03 13:59:41 +02004091 exit(EXIT_FAILURE);
4092 }
4093}
4094
Kevin Wolfb6133b82014-08-05 14:17:13 +02004095static void bench_cb(void *opaque, int ret)
4096{
4097 BenchData *b = opaque;
4098 BlockAIOCB *acb;
4099
4100 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02004101 error_report("Failed request: %s", strerror(-ret));
Kevin Wolfb6133b82014-08-05 14:17:13 +02004102 exit(EXIT_FAILURE);
4103 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004104
4105 if (b->in_flush) {
4106 /* Just finished a flush with drained queue: Start next requests */
4107 assert(b->in_flight == 0);
4108 b->in_flush = false;
4109 } else if (b->in_flight > 0) {
4110 int remaining = b->n - b->in_flight;
4111
Kevin Wolfb6133b82014-08-05 14:17:13 +02004112 b->n--;
4113 b->in_flight--;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004114
4115 /* Time for flush? Drain queue if requested, then flush */
4116 if (b->flush_interval && remaining % b->flush_interval == 0) {
4117 if (!b->in_flight || !b->drain_on_flush) {
4118 BlockCompletionFunc *cb;
4119
4120 if (b->drain_on_flush) {
4121 b->in_flush = true;
4122 cb = bench_cb;
4123 } else {
4124 cb = bench_undrained_flush_cb;
4125 }
4126
4127 acb = blk_aio_flush(b->blk, cb, b);
4128 if (!acb) {
4129 error_report("Failed to issue flush request");
4130 exit(EXIT_FAILURE);
4131 }
4132 }
4133 if (b->drain_on_flush) {
4134 return;
4135 }
4136 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004137 }
4138
4139 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004140 int64_t offset = b->offset;
4141 /* blk_aio_* might look for completed I/Os and kick bench_cb
4142 * again, so make sure this operation is counted by in_flight
4143 * and b->offset is ready for the next submission.
4144 */
4145 b->in_flight++;
4146 b->offset += b->step;
4147 b->offset %= b->image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004148 if (b->write) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004149 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004150 } else {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01004151 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004152 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004153 if (!acb) {
4154 error_report("Failed to issue request");
4155 exit(EXIT_FAILURE);
4156 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004157 }
4158}
4159
4160static int img_bench(int argc, char **argv)
4161{
4162 int c, ret = 0;
4163 const char *fmt = NULL, *filename;
4164 bool quiet = false;
4165 bool image_opts = false;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004166 bool is_write = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004167 int count = 75000;
4168 int depth = 64;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004169 int64_t offset = 0;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004170 size_t bufsize = 4096;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004171 int pattern = 0;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004172 size_t step = 0;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004173 int flush_interval = 0;
4174 bool drain_on_flush = true;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004175 int64_t image_size;
4176 BlockBackend *blk = NULL;
4177 BenchData data = {};
4178 int flags = 0;
Kevin Wolf604e8612016-06-14 11:29:32 +02004179 bool writethrough = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004180 struct timeval t1, t2;
4181 int i;
Fam Zheng335e9932017-05-03 00:35:39 +08004182 bool force_share = false;
Fam Zheng79d46582018-01-16 14:08:58 +08004183 size_t buf_size;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004184
4185 for (;;) {
4186 static const struct option long_options[] = {
4187 {"help", no_argument, 0, 'h'},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004188 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004189 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004190 {"pattern", required_argument, 0, OPTION_PATTERN},
Kevin Wolf55d539c2016-06-03 13:59:41 +02004191 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
Fam Zheng335e9932017-05-03 00:35:39 +08004192 {"force-share", no_argument, 0, 'U'},
Kevin Wolfb6133b82014-08-05 14:17:13 +02004193 {0, 0, 0, 0}
4194 };
Fam Zheng335e9932017-05-03 00:35:39 +08004195 c = getopt_long(argc, argv, ":hc:d:f:no:qs:S:t:wU", long_options, NULL);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004196 if (c == -1) {
4197 break;
4198 }
4199
4200 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004201 case ':':
4202 missing_argument(argv[optind - 1]);
4203 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004204 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004205 unrecognized_option(argv[optind - 1]);
4206 break;
4207 case 'h':
Kevin Wolfb6133b82014-08-05 14:17:13 +02004208 help();
4209 break;
4210 case 'c':
4211 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004212 unsigned long res;
4213
4214 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004215 error_report("Invalid request count specified");
4216 return 1;
4217 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004218 count = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004219 break;
4220 }
4221 case 'd':
4222 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004223 unsigned long res;
4224
4225 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004226 error_report("Invalid queue depth specified");
4227 return 1;
4228 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004229 depth = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004230 break;
4231 }
4232 case 'f':
4233 fmt = optarg;
4234 break;
4235 case 'n':
4236 flags |= BDRV_O_NATIVE_AIO;
4237 break;
Kevin Wolfd3199a32015-07-10 18:09:18 +02004238 case 'o':
4239 {
Markus Armbruster606caa02017-02-21 21:14:04 +01004240 offset = cvtnum(optarg);
4241 if (offset < 0) {
Kevin Wolfd3199a32015-07-10 18:09:18 +02004242 error_report("Invalid offset specified");
4243 return 1;
4244 }
4245 break;
4246 }
4247 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004248 case 'q':
4249 quiet = true;
4250 break;
4251 case 's':
4252 {
4253 int64_t sval;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004254
Markus Armbruster606caa02017-02-21 21:14:04 +01004255 sval = cvtnum(optarg);
4256 if (sval < 0 || sval > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02004257 error_report("Invalid buffer size specified");
4258 return 1;
4259 }
4260
4261 bufsize = sval;
4262 break;
4263 }
Kevin Wolf83de9be2015-07-13 13:13:17 +02004264 case 'S':
4265 {
4266 int64_t sval;
Kevin Wolf83de9be2015-07-13 13:13:17 +02004267
Markus Armbruster606caa02017-02-21 21:14:04 +01004268 sval = cvtnum(optarg);
4269 if (sval < 0 || sval > INT_MAX) {
Kevin Wolf83de9be2015-07-13 13:13:17 +02004270 error_report("Invalid step size specified");
4271 return 1;
4272 }
4273
4274 step = sval;
4275 break;
4276 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004277 case 't':
4278 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4279 if (ret < 0) {
4280 error_report("Invalid cache mode");
4281 ret = -1;
4282 goto out;
4283 }
4284 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004285 case 'w':
4286 flags |= BDRV_O_RDWR;
4287 is_write = true;
4288 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004289 case 'U':
4290 force_share = true;
4291 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004292 case OPTION_PATTERN:
4293 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004294 unsigned long res;
4295
4296 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004297 error_report("Invalid pattern byte specified");
4298 return 1;
4299 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004300 pattern = res;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004301 break;
4302 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02004303 case OPTION_FLUSH_INTERVAL:
4304 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00004305 unsigned long res;
4306
4307 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004308 error_report("Invalid flush interval specified");
4309 return 1;
4310 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00004311 flush_interval = res;
Kevin Wolf55d539c2016-06-03 13:59:41 +02004312 break;
4313 }
4314 case OPTION_NO_DRAIN:
4315 drain_on_flush = false;
4316 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02004317 case OPTION_IMAGE_OPTS:
4318 image_opts = true;
4319 break;
4320 }
4321 }
4322
4323 if (optind != argc - 1) {
4324 error_exit("Expecting one image file name");
4325 }
4326 filename = argv[argc - 1];
4327
Kevin Wolf55d539c2016-06-03 13:59:41 +02004328 if (!is_write && flush_interval) {
4329 error_report("--flush-interval is only available in write tests");
4330 ret = -1;
4331 goto out;
4332 }
4333 if (flush_interval && flush_interval < depth) {
4334 error_report("Flush interval can't be smaller than depth");
4335 ret = -1;
4336 goto out;
4337 }
4338
Fam Zheng335e9932017-05-03 00:35:39 +08004339 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4340 force_share);
Kevin Wolfb6133b82014-08-05 14:17:13 +02004341 if (!blk) {
4342 ret = -1;
4343 goto out;
4344 }
4345
4346 image_size = blk_getlength(blk);
4347 if (image_size < 0) {
4348 ret = image_size;
4349 goto out;
4350 }
4351
4352 data = (BenchData) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02004353 .blk = blk,
4354 .image_size = image_size,
4355 .bufsize = bufsize,
4356 .step = step ?: bufsize,
4357 .nrreq = depth,
4358 .n = count,
4359 .offset = offset,
4360 .write = is_write,
4361 .flush_interval = flush_interval,
4362 .drain_on_flush = drain_on_flush,
Kevin Wolfb6133b82014-08-05 14:17:13 +02004363 };
Kevin Wolfd3199a32015-07-10 18:09:18 +02004364 printf("Sending %d %s requests, %d bytes each, %d in parallel "
Kevin Wolf83de9be2015-07-13 13:13:17 +02004365 "(starting at offset %" PRId64 ", step size %d)\n",
Kevin Wolfd3199a32015-07-10 18:09:18 +02004366 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
Kevin Wolf83de9be2015-07-13 13:13:17 +02004367 data.offset, data.step);
Kevin Wolf55d539c2016-06-03 13:59:41 +02004368 if (flush_interval) {
4369 printf("Sending flush every %d requests\n", flush_interval);
4370 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004371
Fam Zheng79d46582018-01-16 14:08:58 +08004372 buf_size = data.nrreq * data.bufsize;
4373 data.buf = blk_blockalign(blk, buf_size);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02004374 memset(data.buf, pattern, data.nrreq * data.bufsize);
4375
Fam Zheng79d46582018-01-16 14:08:58 +08004376 blk_register_buf(blk, data.buf, buf_size);
4377
Kevin Wolfb6133b82014-08-05 14:17:13 +02004378 data.qiov = g_new(QEMUIOVector, data.nrreq);
4379 for (i = 0; i < data.nrreq; i++) {
4380 qemu_iovec_init(&data.qiov[i], 1);
4381 qemu_iovec_add(&data.qiov[i],
4382 data.buf + i * data.bufsize, data.bufsize);
4383 }
4384
4385 gettimeofday(&t1, NULL);
4386 bench_cb(&data, 0);
4387
4388 while (data.n > 0) {
4389 main_loop_wait(false);
4390 }
4391 gettimeofday(&t2, NULL);
4392
4393 printf("Run completed in %3.3f seconds.\n",
4394 (t2.tv_sec - t1.tv_sec)
4395 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4396
4397out:
Fam Zheng79d46582018-01-16 14:08:58 +08004398 if (data.buf) {
4399 blk_unregister_buf(blk, data.buf);
4400 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02004401 qemu_vfree(data.buf);
4402 blk_unref(blk);
4403
4404 if (ret) {
4405 return 1;
4406 }
4407 return 0;
4408}
4409
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004410#define C_BS 01
4411#define C_COUNT 02
4412#define C_IF 04
4413#define C_OF 010
Reda Sallahif7c15532016-08-10 16:16:09 +02004414#define C_SKIP 020
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004415
4416struct DdInfo {
4417 unsigned int flags;
4418 int64_t count;
4419};
4420
4421struct DdIo {
4422 int bsz; /* Block size */
4423 char *filename;
4424 uint8_t *buf;
Reda Sallahif7c15532016-08-10 16:16:09 +02004425 int64_t offset;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004426};
4427
4428struct DdOpts {
4429 const char *name;
4430 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
4431 unsigned int flag;
4432};
4433
4434static int img_dd_bs(const char *arg,
4435 struct DdIo *in, struct DdIo *out,
4436 struct DdInfo *dd)
4437{
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004438 int64_t res;
4439
Markus Armbruster606caa02017-02-21 21:14:04 +01004440 res = cvtnum(arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004441
Markus Armbruster606caa02017-02-21 21:14:04 +01004442 if (res <= 0 || res > INT_MAX) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004443 error_report("invalid number: '%s'", arg);
4444 return 1;
4445 }
4446 in->bsz = out->bsz = res;
4447
4448 return 0;
4449}
4450
4451static int img_dd_count(const char *arg,
4452 struct DdIo *in, struct DdIo *out,
4453 struct DdInfo *dd)
4454{
Markus Armbruster606caa02017-02-21 21:14:04 +01004455 dd->count = cvtnum(arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004456
Markus Armbruster606caa02017-02-21 21:14:04 +01004457 if (dd->count < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004458 error_report("invalid number: '%s'", arg);
4459 return 1;
4460 }
4461
4462 return 0;
4463}
4464
4465static int img_dd_if(const char *arg,
4466 struct DdIo *in, struct DdIo *out,
4467 struct DdInfo *dd)
4468{
4469 in->filename = g_strdup(arg);
4470
4471 return 0;
4472}
4473
4474static int img_dd_of(const char *arg,
4475 struct DdIo *in, struct DdIo *out,
4476 struct DdInfo *dd)
4477{
4478 out->filename = g_strdup(arg);
4479
4480 return 0;
4481}
4482
Reda Sallahif7c15532016-08-10 16:16:09 +02004483static int img_dd_skip(const char *arg,
4484 struct DdIo *in, struct DdIo *out,
4485 struct DdInfo *dd)
4486{
Markus Armbruster606caa02017-02-21 21:14:04 +01004487 in->offset = cvtnum(arg);
Reda Sallahif7c15532016-08-10 16:16:09 +02004488
Markus Armbruster606caa02017-02-21 21:14:04 +01004489 if (in->offset < 0) {
Reda Sallahif7c15532016-08-10 16:16:09 +02004490 error_report("invalid number: '%s'", arg);
4491 return 1;
4492 }
4493
4494 return 0;
4495}
4496
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004497static int img_dd(int argc, char **argv)
4498{
4499 int ret = 0;
4500 char *arg = NULL;
4501 char *tmp;
4502 BlockDriver *drv = NULL, *proto_drv = NULL;
4503 BlockBackend *blk1 = NULL, *blk2 = NULL;
4504 QemuOpts *opts = NULL;
4505 QemuOptsList *create_opts = NULL;
4506 Error *local_err = NULL;
4507 bool image_opts = false;
4508 int c, i;
4509 const char *out_fmt = "raw";
4510 const char *fmt = NULL;
4511 int64_t size = 0;
4512 int64_t block_count = 0, out_pos, in_pos;
Fam Zheng335e9932017-05-03 00:35:39 +08004513 bool force_share = false;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004514 struct DdInfo dd = {
4515 .flags = 0,
4516 .count = 0,
4517 };
4518 struct DdIo in = {
4519 .bsz = 512, /* Block size is by default 512 bytes */
4520 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004521 .buf = NULL,
4522 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004523 };
4524 struct DdIo out = {
4525 .bsz = 512,
4526 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02004527 .buf = NULL,
4528 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004529 };
4530
4531 const struct DdOpts options[] = {
4532 { "bs", img_dd_bs, C_BS },
4533 { "count", img_dd_count, C_COUNT },
4534 { "if", img_dd_if, C_IF },
4535 { "of", img_dd_of, C_OF },
Reda Sallahif7c15532016-08-10 16:16:09 +02004536 { "skip", img_dd_skip, C_SKIP },
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004537 { NULL, NULL, 0 }
4538 };
4539 const struct option long_options[] = {
4540 { "help", no_argument, 0, 'h'},
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004541 { "object", required_argument, 0, OPTION_OBJECT},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004542 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Fam Zheng335e9932017-05-03 00:35:39 +08004543 { "force-share", no_argument, 0, 'U'},
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004544 { 0, 0, 0, 0 }
4545 };
4546
Fam Zheng335e9932017-05-03 00:35:39 +08004547 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004548 if (c == EOF) {
4549 break;
4550 }
4551 switch (c) {
4552 case 'O':
4553 out_fmt = optarg;
4554 break;
4555 case 'f':
4556 fmt = optarg;
4557 break;
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004558 case ':':
4559 missing_argument(argv[optind - 1]);
4560 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004561 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08004562 unrecognized_option(argv[optind - 1]);
4563 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004564 case 'h':
4565 help();
4566 break;
Fam Zheng335e9932017-05-03 00:35:39 +08004567 case 'U':
4568 force_share = true;
4569 break;
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01004570 case OPTION_OBJECT:
4571 if (!qemu_opts_parse_noisily(&qemu_object_opts, optarg, true)) {
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004572 ret = -1;
4573 goto out;
4574 }
Stefan Hajnoczi2a245702017-06-19 16:00:02 +01004575 break;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004576 case OPTION_IMAGE_OPTS:
4577 image_opts = true;
4578 break;
4579 }
4580 }
4581
4582 for (i = optind; i < argc; i++) {
4583 int j;
4584 arg = g_strdup(argv[i]);
4585
4586 tmp = strchr(arg, '=');
4587 if (tmp == NULL) {
4588 error_report("unrecognized operand %s", arg);
4589 ret = -1;
4590 goto out;
4591 }
4592
4593 *tmp++ = '\0';
4594
4595 for (j = 0; options[j].name != NULL; j++) {
4596 if (!strcmp(arg, options[j].name)) {
4597 break;
4598 }
4599 }
4600 if (options[j].name == NULL) {
4601 error_report("unrecognized operand %s", arg);
4602 ret = -1;
4603 goto out;
4604 }
4605
4606 if (options[j].f(tmp, &in, &out, &dd) != 0) {
4607 ret = -1;
4608 goto out;
4609 }
4610 dd.flags |= options[j].flag;
4611 g_free(arg);
4612 arg = NULL;
4613 }
4614
4615 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
4616 error_report("Must specify both input and output files");
4617 ret = -1;
4618 goto out;
4619 }
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004620
4621 if (qemu_opts_foreach(&qemu_object_opts,
4622 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00004623 NULL, &error_fatal)) {
Daniel P. Berrange83d4bf92017-05-15 17:47:09 +01004624 ret = -1;
4625 goto out;
4626 }
4627
Fam Zheng335e9932017-05-03 00:35:39 +08004628 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
4629 force_share);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004630
4631 if (!blk1) {
4632 ret = -1;
4633 goto out;
4634 }
4635
4636 drv = bdrv_find_format(out_fmt);
4637 if (!drv) {
4638 error_report("Unknown file format");
4639 ret = -1;
4640 goto out;
4641 }
4642 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
4643
4644 if (!proto_drv) {
4645 error_report_err(local_err);
4646 ret = -1;
4647 goto out;
4648 }
4649 if (!drv->create_opts) {
4650 error_report("Format driver '%s' does not support image creation",
4651 drv->format_name);
4652 ret = -1;
4653 goto out;
4654 }
4655 if (!proto_drv->create_opts) {
4656 error_report("Protocol driver '%s' does not support image creation",
4657 proto_drv->format_name);
4658 ret = -1;
4659 goto out;
4660 }
4661 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4662 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
4663
4664 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4665
4666 size = blk_getlength(blk1);
4667 if (size < 0) {
4668 error_report("Failed to get size for '%s'", in.filename);
4669 ret = -1;
4670 goto out;
4671 }
4672
4673 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
4674 dd.count * in.bsz < size) {
4675 size = dd.count * in.bsz;
4676 }
4677
Reda Sallahif7c15532016-08-10 16:16:09 +02004678 /* Overflow means the specified offset is beyond input image's size */
4679 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4680 size < in.bsz * in.offset)) {
4681 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
4682 } else {
4683 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
4684 size - in.bsz * in.offset, &error_abort);
4685 }
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004686
4687 ret = bdrv_create(drv, out.filename, opts, &local_err);
4688 if (ret < 0) {
4689 error_reportf_err(local_err,
4690 "%s: error while creating output image: ",
4691 out.filename);
4692 ret = -1;
4693 goto out;
4694 }
4695
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01004696 /* TODO, we can't honour --image-opts for the target,
4697 * since it needs to be given in a format compatible
4698 * with the bdrv_create() call above which does not
4699 * support image-opts style.
4700 */
Daniel P. Berrange29cf9332017-05-15 17:47:12 +01004701 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
Daniel P. Berrangeea204dd2017-05-15 17:47:10 +01004702 false, false, false);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004703
4704 if (!blk2) {
4705 ret = -1;
4706 goto out;
4707 }
4708
Reda Sallahif7c15532016-08-10 16:16:09 +02004709 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4710 size < in.offset * in.bsz)) {
4711 /* We give a warning if the skip option is bigger than the input
4712 * size and create an empty output disk image (i.e. like dd(1)).
4713 */
4714 error_report("%s: cannot skip to specified offset", in.filename);
4715 in_pos = size;
4716 } else {
4717 in_pos = in.offset * in.bsz;
4718 }
4719
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004720 in.buf = g_new(uint8_t, in.bsz);
4721
Reda Sallahif7c15532016-08-10 16:16:09 +02004722 for (out_pos = 0; in_pos < size; block_count++) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004723 int in_ret, out_ret;
4724
4725 if (in_pos + in.bsz > size) {
4726 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
4727 } else {
4728 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
4729 }
4730 if (in_ret < 0) {
4731 error_report("error while reading from input image file: %s",
4732 strerror(-in_ret));
4733 ret = -1;
4734 goto out;
4735 }
4736 in_pos += in_ret;
4737
4738 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
4739
4740 if (out_ret < 0) {
4741 error_report("error while writing to output image file: %s",
4742 strerror(-out_ret));
4743 ret = -1;
4744 goto out;
4745 }
4746 out_pos += out_ret;
4747 }
4748
4749out:
4750 g_free(arg);
4751 qemu_opts_del(opts);
4752 qemu_opts_free(create_opts);
4753 blk_unref(blk1);
4754 blk_unref(blk2);
4755 g_free(in.filename);
4756 g_free(out.filename);
4757 g_free(in.buf);
4758 g_free(out.buf);
4759
4760 if (ret) {
4761 return 1;
4762 }
4763 return 0;
4764}
4765
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01004766static void dump_json_block_measure_info(BlockMeasureInfo *info)
4767{
4768 QString *str;
4769 QObject *obj;
4770 Visitor *v = qobject_output_visitor_new(&obj);
4771
4772 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
4773 visit_complete(v, &obj);
4774 str = qobject_to_json_pretty(obj);
4775 assert(str != NULL);
4776 printf("%s\n", qstring_get_str(str));
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02004777 qobject_unref(obj);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01004778 visit_free(v);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02004779 qobject_unref(str);
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01004780}
4781
4782static int img_measure(int argc, char **argv)
4783{
4784 static const struct option long_options[] = {
4785 {"help", no_argument, 0, 'h'},
4786 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4787 {"object", required_argument, 0, OPTION_OBJECT},
4788 {"output", required_argument, 0, OPTION_OUTPUT},
4789 {"size", required_argument, 0, OPTION_SIZE},
4790 {"force-share", no_argument, 0, 'U'},
4791 {0, 0, 0, 0}
4792 };
4793 OutputFormat output_format = OFORMAT_HUMAN;
4794 BlockBackend *in_blk = NULL;
4795 BlockDriver *drv;
4796 const char *filename = NULL;
4797 const char *fmt = NULL;
4798 const char *out_fmt = "raw";
4799 char *options = NULL;
4800 char *snapshot_name = NULL;
4801 bool force_share = false;
4802 QemuOpts *opts = NULL;
4803 QemuOpts *object_opts = NULL;
4804 QemuOpts *sn_opts = NULL;
4805 QemuOptsList *create_opts = NULL;
4806 bool image_opts = false;
4807 uint64_t img_size = UINT64_MAX;
4808 BlockMeasureInfo *info = NULL;
4809 Error *local_err = NULL;
4810 int ret = 1;
4811 int c;
4812
4813 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
4814 long_options, NULL)) != -1) {
4815 switch (c) {
4816 case '?':
4817 case 'h':
4818 help();
4819 break;
4820 case 'f':
4821 fmt = optarg;
4822 break;
4823 case 'O':
4824 out_fmt = optarg;
4825 break;
4826 case 'o':
4827 if (!is_valid_option_list(optarg)) {
4828 error_report("Invalid option list: %s", optarg);
4829 goto out;
4830 }
4831 if (!options) {
4832 options = g_strdup(optarg);
4833 } else {
4834 char *old_options = options;
4835 options = g_strdup_printf("%s,%s", options, optarg);
4836 g_free(old_options);
4837 }
4838 break;
4839 case 'l':
4840 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
4841 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
4842 optarg, false);
4843 if (!sn_opts) {
4844 error_report("Failed in parsing snapshot param '%s'",
4845 optarg);
4846 goto out;
4847 }
4848 } else {
4849 snapshot_name = optarg;
4850 }
4851 break;
4852 case 'U':
4853 force_share = true;
4854 break;
4855 case OPTION_OBJECT:
4856 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
4857 optarg, true);
4858 if (!object_opts) {
4859 goto out;
4860 }
4861 break;
4862 case OPTION_IMAGE_OPTS:
4863 image_opts = true;
4864 break;
4865 case OPTION_OUTPUT:
4866 if (!strcmp(optarg, "json")) {
4867 output_format = OFORMAT_JSON;
4868 } else if (!strcmp(optarg, "human")) {
4869 output_format = OFORMAT_HUMAN;
4870 } else {
4871 error_report("--output must be used with human or json "
4872 "as argument.");
4873 goto out;
4874 }
4875 break;
4876 case OPTION_SIZE:
4877 {
4878 int64_t sval;
4879
4880 sval = cvtnum(optarg);
4881 if (sval < 0) {
4882 if (sval == -ERANGE) {
4883 error_report("Image size must be less than 8 EiB!");
4884 } else {
4885 error_report("Invalid image size specified! You may use "
4886 "k, M, G, T, P or E suffixes for ");
4887 error_report("kilobytes, megabytes, gigabytes, terabytes, "
4888 "petabytes and exabytes.");
4889 }
4890 goto out;
4891 }
4892 img_size = (uint64_t)sval;
4893 }
4894 break;
4895 }
4896 }
4897
4898 if (qemu_opts_foreach(&qemu_object_opts,
4899 user_creatable_add_opts_foreach,
Daniel P. Berrangé334c43e2019-02-19 11:46:09 +00004900 NULL, &error_fatal)) {
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +01004901 goto out;
4902 }
4903
4904 if (argc - optind > 1) {
4905 error_report("At most one filename argument is allowed.");
4906 goto out;
4907 } else if (argc - optind == 1) {
4908 filename = argv[optind];
4909 }
4910
4911 if (!filename &&
4912 (object_opts || image_opts || fmt || snapshot_name || sn_opts)) {
4913 error_report("--object, --image-opts, -f, and -l "
4914 "require a filename argument.");
4915 goto out;
4916 }
4917 if (filename && img_size != UINT64_MAX) {
4918 error_report("--size N cannot be used together with a filename.");
4919 goto out;
4920 }
4921 if (!filename && img_size == UINT64_MAX) {
4922 error_report("Either --size N or one filename must be specified.");
4923 goto out;
4924 }
4925
4926 if (filename) {
4927 in_blk = img_open(image_opts, filename, fmt, 0,
4928 false, false, force_share);
4929 if (!in_blk) {
4930 goto out;
4931 }
4932
4933 if (sn_opts) {
4934 bdrv_snapshot_load_tmp(blk_bs(in_blk),
4935 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
4936 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
4937 &local_err);
4938 } else if (snapshot_name != NULL) {
4939 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
4940 snapshot_name, &local_err);
4941 }
4942 if (local_err) {
4943 error_reportf_err(local_err, "Failed to load snapshot: ");
4944 goto out;
4945 }
4946 }
4947
4948 drv = bdrv_find_format(out_fmt);
4949 if (!drv) {
4950 error_report("Unknown file format '%s'", out_fmt);
4951 goto out;
4952 }
4953 if (!drv->create_opts) {
4954 error_report("Format driver '%s' does not support image creation",
4955 drv->format_name);
4956 goto out;
4957 }
4958
4959 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4960 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
4961 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4962 if (options) {
4963 qemu_opts_do_parse(opts, options, NULL, &local_err);
4964 if (local_err) {
4965 error_report_err(local_err);
4966 error_report("Invalid options for file format '%s'", out_fmt);
4967 goto out;
4968 }
4969 }
4970 if (img_size != UINT64_MAX) {
4971 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
4972 }
4973
4974 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
4975 if (local_err) {
4976 error_report_err(local_err);
4977 goto out;
4978 }
4979
4980 if (output_format == OFORMAT_HUMAN) {
4981 printf("required size: %" PRIu64 "\n", info->required);
4982 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
4983 } else {
4984 dump_json_block_measure_info(info);
4985 }
4986
4987 ret = 0;
4988
4989out:
4990 qapi_free_BlockMeasureInfo(info);
4991 qemu_opts_del(object_opts);
4992 qemu_opts_del(opts);
4993 qemu_opts_del(sn_opts);
4994 qemu_opts_free(create_opts);
4995 g_free(options);
4996 blk_unref(in_blk);
4997 return ret;
4998}
Kevin Wolfb6133b82014-08-05 14:17:13 +02004999
Anthony Liguoric227f092009-10-01 16:12:16 -05005000static const img_cmd_t img_cmds[] = {
Stuart Brady153859b2009-06-07 00:42:17 +01005001#define DEF(option, callback, arg_string) \
5002 { option, callback },
5003#include "qemu-img-cmds.h"
5004#undef DEF
Stuart Brady153859b2009-06-07 00:42:17 +01005005 { NULL, NULL, },
5006};
5007
bellardea2384d2004-08-01 21:59:26 +00005008int main(int argc, char **argv)
5009{
Anthony Liguoric227f092009-10-01 16:12:16 -05005010 const img_cmd_t *cmd;
Stuart Brady153859b2009-06-07 00:42:17 +01005011 const char *cmdname;
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005012 Error *local_error = NULL;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005013 char *trace_file = NULL;
Jeff Cody7db16892014-04-25 17:02:32 -04005014 int c;
Jeff Cody7db16892014-04-25 17:02:32 -04005015 static const struct option long_options[] = {
5016 {"help", no_argument, 0, 'h'},
Denis V. Lunev10985132016-06-17 17:44:13 +03005017 {"version", no_argument, 0, 'V'},
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005018 {"trace", required_argument, NULL, 'T'},
Jeff Cody7db16892014-04-25 17:02:32 -04005019 {0, 0, 0, 0}
5020 };
bellardea2384d2004-08-01 21:59:26 +00005021
MORITA Kazutaka526eda12013-07-23 17:30:11 +09005022#ifdef CONFIG_POSIX
5023 signal(SIGPIPE, SIG_IGN);
5024#endif
5025
Christophe Fergeauf5852ef2019-01-31 17:46:14 +01005026 error_init(argv[0]);
Daniel P. Berrangefe4db842016-10-04 14:35:52 +01005027 module_call_init(MODULE_INIT_TRACE);
Fam Zheng10f5bff2014-02-10 14:48:51 +08005028 qemu_init_exec_dir(argv[0]);
Kevin Wolf53f76e52010-12-16 15:10:32 +01005029
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005030 if (qemu_init_main_loop(&local_error)) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01005031 error_report_err(local_error);
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03005032 exit(EXIT_FAILURE);
5033 }
5034
Eduardo Habkoste8f2d272016-05-12 11:10:04 -03005035 qcrypto_init(&error_fatal);
Daniel P. Berrangec2297082016-04-06 12:12:06 +01005036
Daniel P. Berrange064097d2016-02-10 18:41:01 +00005037 module_call_init(MODULE_INIT_QOM);
bellardea2384d2004-08-01 21:59:26 +00005038 bdrv_init();
Fam Zhengac1307a2014-04-22 13:36:11 +08005039 if (argc < 2) {
5040 error_exit("Not enough arguments");
5041 }
Stuart Brady153859b2009-06-07 00:42:17 +01005042
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00005043 qemu_add_opts(&qemu_object_opts);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00005044 qemu_add_opts(&qemu_source_opts);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005045 qemu_add_opts(&qemu_trace_opts);
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00005046
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005047 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
Denis V. Lunev10985132016-06-17 17:44:13 +03005048 switch (c) {
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005049 case ':':
5050 missing_argument(argv[optind - 1]);
5051 return 0;
Stefan Hajnoczi4581c162017-03-17 18:45:39 +08005052 case '?':
Stefan Hajnoczic9192972017-03-17 18:45:41 +08005053 unrecognized_option(argv[optind - 1]);
5054 return 0;
5055 case 'h':
Denis V. Lunev10985132016-06-17 17:44:13 +03005056 help();
5057 return 0;
5058 case 'V':
5059 printf(QEMU_IMG_VERSION);
5060 return 0;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005061 case 'T':
5062 g_free(trace_file);
5063 trace_file = trace_opt_parse(optarg);
5064 break;
Stuart Brady153859b2009-06-07 00:42:17 +01005065 }
bellardea2384d2004-08-01 21:59:26 +00005066 }
Stuart Brady153859b2009-06-07 00:42:17 +01005067
Denis V. Lunev10985132016-06-17 17:44:13 +03005068 cmdname = argv[optind];
Jeff Cody7db16892014-04-25 17:02:32 -04005069
Denis V. Lunev10985132016-06-17 17:44:13 +03005070 /* reset getopt_long scanning */
5071 argc -= optind;
5072 if (argc < 1) {
Jeff Cody5f6979c2014-04-28 14:37:18 -04005073 return 0;
5074 }
Denis V. Lunev10985132016-06-17 17:44:13 +03005075 argv += optind;
Richard W.M. Jonesd339d762019-01-18 10:11:14 +00005076 qemu_reset_optind();
Denis V. Lunev10985132016-06-17 17:44:13 +03005077
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03005078 if (!trace_init_backends()) {
5079 exit(1);
5080 }
5081 trace_init_file(trace_file);
5082 qemu_set_log(LOG_TRACE);
5083
Denis V. Lunev10985132016-06-17 17:44:13 +03005084 /* find the command */
5085 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
5086 if (!strcmp(cmdname, cmd->name)) {
5087 return cmd->handler(argc, argv);
5088 }
5089 }
Jeff Cody7db16892014-04-25 17:02:32 -04005090
Stuart Brady153859b2009-06-07 00:42:17 +01005091 /* not found */
Fam Zhengac1307a2014-04-22 13:36:11 +08005092 error_exit("Command not found: %s", cmdname);
bellardea2384d2004-08-01 21:59:26 +00005093}