blob: df3aefd35a680c8ad7c3fd4e901b6087b527e9c2 [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 */
Peter Maydell80c71a22016-01-18 18:01:42 +000024#include "qemu/osdep.h"
Fam Zheng67a1de02016-06-01 17:44:21 +080025#include "qemu-version.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010026#include "qapi/error.h"
Benoît Canetc054b3f2012-09-05 13:09:02 +020027#include "qapi-visit.h"
Daniel P. Berrangeb3db2112016-09-30 15:45:27 +010028#include "qapi/qobject-output-visitor.h"
Markus Armbrustercc7a8ea2015-03-17 17:22:46 +010029#include "qapi/qmp/qerror.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010030#include "qapi/qmp/qjson.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020031#include "qemu/cutils.h"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000032#include "qemu/config-file.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010033#include "qemu/option.h"
34#include "qemu/error-report.h"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +030035#include "qemu/log.h"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000036#include "qom/object_interfaces.h"
Paolo Bonzini9c17d612012-12-17 18:20:04 +010037#include "sysemu/sysemu.h"
Markus Armbruster26f54e92014-10-07 13:59:04 +020038#include "sysemu/block-backend.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010039#include "block/block_int.h"
Max Reitzd4a32382014-10-24 15:57:37 +020040#include "block/blockjob.h"
Wenchao Xiaf364ec62013-05-25 11:09:44 +080041#include "block/qapi.h"
Daniel P. Berrangec2297082016-04-06 12:12:06 +010042#include "crypto/init.h"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +030043#include "trace/control.h"
Benoît Canetc054b3f2012-09-05 13:09:02 +020044#include <getopt.h>
bellarde8445332006-06-14 15:32:10 +000045
Don Slutz61979a62015-01-09 10:17:35 -050046#define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
Thomas Huth0781dd62016-10-05 11:54:44 +020047 "\n" QEMU_COPYRIGHT "\n"
Jeff Cody5f6979c2014-04-28 14:37:18 -040048
Anthony Liguoric227f092009-10-01 16:12:16 -050049typedef struct img_cmd_t {
Stuart Brady153859b2009-06-07 00:42:17 +010050 const char *name;
51 int (*handler)(int argc, char **argv);
Anthony Liguoric227f092009-10-01 16:12:16 -050052} img_cmd_t;
Stuart Brady153859b2009-06-07 00:42:17 +010053
Federico Simoncelli8599ea42013-01-28 06:59:47 -050054enum {
55 OPTION_OUTPUT = 256,
56 OPTION_BACKING_CHAIN = 257,
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000057 OPTION_OBJECT = 258,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000058 OPTION_IMAGE_OPTS = 259,
Kevin Wolfb6495fa2015-07-10 18:09:18 +020059 OPTION_PATTERN = 260,
Kevin Wolf55d539c2016-06-03 13:59:41 +020060 OPTION_FLUSH_INTERVAL = 261,
61 OPTION_NO_DRAIN = 262,
Federico Simoncelli8599ea42013-01-28 06:59:47 -050062};
63
64typedef enum OutputFormat {
65 OFORMAT_JSON,
66 OFORMAT_HUMAN,
67} OutputFormat;
68
Kevin Wolfe6996142016-03-15 13:03:11 +010069/* Default to cache=writeback as data integrity is not important for qemu-img */
Federico Simoncelli661a0f72011-06-20 12:48:19 -040070#define BDRV_DEFAULT_CACHE "writeback"
aurel32137519c2008-11-30 19:12:49 +000071
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +010072static void format_print(void *opaque, const char *name)
bellardea2384d2004-08-01 21:59:26 +000073{
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +010074 printf(" %s", name);
bellardea2384d2004-08-01 21:59:26 +000075}
76
Fam Zhengac1307a2014-04-22 13:36:11 +080077static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
78{
79 va_list ap;
80
81 error_printf("qemu-img: ");
82
83 va_start(ap, fmt);
84 error_vprintf(fmt, ap);
85 va_end(ap);
86
87 error_printf("\nTry 'qemu-img --help' for more information\n");
88 exit(EXIT_FAILURE);
89}
90
blueswir1d2c639d2009-01-24 18:19:25 +000091/* Please keep in synch with qemu-img.texi */
Fam Zhengac1307a2014-04-22 13:36:11 +080092static void QEMU_NORETURN help(void)
bellardea2384d2004-08-01 21:59:26 +000093{
Paolo Bonzinie00291c2010-02-04 16:49:56 +010094 const char *help_msg =
Jeff Cody5f6979c2014-04-28 14:37:18 -040095 QEMU_IMG_VERSION
Denis V. Lunev10985132016-06-17 17:44:13 +030096 "usage: qemu-img [standard options] command [command options]\n"
malc3f020d72010-02-08 12:04:56 +030097 "QEMU disk image utility\n"
98 "\n"
Denis V. Lunev10985132016-06-17 17:44:13 +030099 " '-h', '--help' display this help and exit\n"
100 " '-V', '--version' output version information and exit\n"
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +0300101 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
102 " specify tracing options\n"
Denis V. Lunev10985132016-06-17 17:44:13 +0300103 "\n"
malc3f020d72010-02-08 12:04:56 +0300104 "Command syntax:\n"
Stuart Brady153859b2009-06-07 00:42:17 +0100105#define DEF(option, callback, arg_string) \
106 " " arg_string "\n"
107#include "qemu-img-cmds.h"
108#undef DEF
109#undef GEN_DOCS
malc3f020d72010-02-08 12:04:56 +0300110 "\n"
111 "Command parameters:\n"
112 " 'filename' is a disk image filename\n"
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000113 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
114 " manual page for a description of the object properties. The most common\n"
115 " object type is a 'secret', which is used to supply passwords and/or\n"
116 " encryption keys.\n"
malc3f020d72010-02-08 12:04:56 +0300117 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400118 " 'cache' is the cache mode used to write the output disk image, the valid\n"
Liu Yuan80ccf932012-04-20 17:10:56 +0800119 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
120 " 'directsync' and 'unsafe' (default for convert)\n"
Stefan Hajnoczibb87fdf2014-09-02 11:01:02 +0100121 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
122 " options are the same as for the 'cache' option\n"
malc3f020d72010-02-08 12:04:56 +0300123 " 'size' is the disk image size in bytes. Optional suffixes\n"
Kevin Wolf5e009842013-06-05 14:19:27 +0200124 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
125 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
126 " supported. 'b' is ignored.\n"
malc3f020d72010-02-08 12:04:56 +0300127 " 'output_filename' is the destination disk image filename\n"
128 " 'output_fmt' is the destination format\n"
129 " 'options' is a comma separated list of format specific options in a\n"
130 " name=value format. Use -o ? for an overview of the options supported by the\n"
131 " used format\n"
Wenchao Xiaef806542013-12-04 17:10:57 +0800132 " 'snapshot_param' is param used for internal snapshot, format\n"
133 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
134 " '[ID_OR_NAME]'\n"
135 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
136 " instead\n"
malc3f020d72010-02-08 12:04:56 +0300137 " '-c' indicates that target image must be compressed (qcow format only)\n"
138 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
139 " match exactly. The image doesn't need a working backing file before\n"
140 " rebasing in this case (useful for renaming the backing file)\n"
141 " '-h' with or without a command shows this help and lists the supported formats\n"
Jes Sorensen6b837bc2011-03-30 14:16:25 +0200142 " '-p' show progress of command (only certain commands)\n"
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100143 " '-q' use Quiet mode - do not print any output (except errors)\n"
Peter Lieven11b66992013-10-24 12:07:05 +0200144 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
145 " contain only zeros for qemu-img to create a sparse image during\n"
146 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
147 " unallocated or zero sectors, and the destination image will always be\n"
148 " fully allocated\n"
Benoît Canetc054b3f2012-09-05 13:09:02 +0200149 " '--output' takes the format in which the output must be done (human or json)\n"
Alexandre Derumierb2e10492013-09-02 19:07:24 +0100150 " '-n' skips the target volume creation (useful if the volume is created\n"
151 " prior to running qemu-img)\n"
malc3f020d72010-02-08 12:04:56 +0300152 "\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200153 "Parameters to check subcommand:\n"
154 " '-r' tries to repair any inconsistencies that are found during the check.\n"
155 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
156 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
Stefan Weil0546b8c2012-08-10 22:03:25 +0200157 " hiding corruption that has already occurred.\n"
Kevin Wolf4534ff52012-05-11 16:07:02 +0200158 "\n"
malc3f020d72010-02-08 12:04:56 +0300159 "Parameters to snapshot subcommand:\n"
160 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
161 " '-a' applies a snapshot (revert disk to saved state)\n"
162 " '-c' creates a snapshot\n"
163 " '-d' deletes a snapshot\n"
Miroslav Rezaninad14ed182013-02-13 09:09:41 +0100164 " '-l' lists all snapshots in the given image\n"
165 "\n"
166 "Parameters to compare subcommand:\n"
167 " '-f' first image format\n"
168 " '-F' second image format\n"
Reda Sallahi86ce1f62016-08-10 04:43:12 +0200169 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
170 "\n"
171 "Parameters to dd subcommand:\n"
172 " 'bs=BYTES' read and write up to BYTES bytes at a time "
173 "(default: 512)\n"
174 " 'count=N' copy only N input blocks\n"
175 " 'if=FILE' read from FILE\n"
Reda Sallahif7c15532016-08-10 16:16:09 +0200176 " 'of=FILE' write to FILE\n"
177 " 'skip=N' skip N bs-sized blocks at the start of input\n";
Paolo Bonzinie00291c2010-02-04 16:49:56 +0100178
179 printf("%s\nSupported formats:", help_msg);
Stefan Hajnoczi00c6d402014-08-27 12:08:56 +0100180 bdrv_iterate_format(format_print, NULL);
bellardea2384d2004-08-01 21:59:26 +0000181 printf("\n");
Fam Zhengac1307a2014-04-22 13:36:11 +0800182 exit(EXIT_SUCCESS);
bellardea2384d2004-08-01 21:59:26 +0000183}
184
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000185static QemuOptsList qemu_object_opts = {
186 .name = "object",
187 .implied_opt_name = "qom-type",
188 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
189 .desc = {
190 { }
191 },
192};
193
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000194static QemuOptsList qemu_source_opts = {
195 .name = "source",
196 .implied_opt_name = "file",
197 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
198 .desc = {
199 { }
200 },
201};
202
Stefan Weil7c30f652013-06-16 17:01:05 +0200203static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100204{
205 int ret = 0;
206 if (!quiet) {
207 va_list args;
208 va_start(args, fmt);
209 ret = vprintf(fmt, args);
210 va_end(args);
211 }
212 return ret;
213}
214
bellardea2384d2004-08-01 21:59:26 +0000215
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100216static int print_block_option_help(const char *filename, const char *fmt)
217{
218 BlockDriver *drv, *proto_drv;
Chunyan Liu83d05212014-06-05 17:20:51 +0800219 QemuOptsList *create_opts = NULL;
Max Reitzb65a5e12015-02-05 13:58:12 -0500220 Error *local_err = NULL;
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100221
222 /* Find driver and parse its options */
223 drv = bdrv_find_format(fmt);
224 if (!drv) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100225 error_report("Unknown file format '%s'", fmt);
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100226 return 1;
227 }
228
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800229 create_opts = qemu_opts_append(create_opts, drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100230 if (filename) {
Max Reitzb65a5e12015-02-05 13:58:12 -0500231 proto_drv = bdrv_find_protocol(filename, true, &local_err);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100232 if (!proto_drv) {
Markus Armbruster2867ce42015-03-12 16:08:02 +0100233 error_report_err(local_err);
Chunyan Liu83d05212014-06-05 17:20:51 +0800234 qemu_opts_free(create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100235 return 1;
236 }
Chunyan Liuc282e1f2014-06-05 17:21:11 +0800237 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfa283cb62014-02-21 16:24:07 +0100238 }
239
Chunyan Liu83d05212014-06-05 17:20:51 +0800240 qemu_opts_print_help(create_opts);
241 qemu_opts_free(create_opts);
Jes Sorensen4ac8aac2010-12-06 15:25:38 +0100242 return 0;
243}
244
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000245
246static int img_open_password(BlockBackend *blk, const char *filename,
Daniel P. Berrangeabb06c52016-03-21 14:11:42 +0000247 int flags, bool quiet)
bellard75c23802004-08-27 21:28:58 +0000248{
249 BlockDriverState *bs;
bellard75c23802004-08-27 21:28:58 +0000250 char password[256];
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000251
252 bs = blk_bs(blk);
Daniel P. Berrange4ef130f2016-03-21 14:11:43 +0000253 if (bdrv_is_encrypted(bs) && bdrv_key_required(bs) &&
254 !(flags & BDRV_O_NO_IO)) {
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000255 qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
256 if (qemu_read_password(password, sizeof(password)) < 0) {
257 error_report("No password given");
258 return -1;
259 }
260 if (bdrv_set_key(bs, password) < 0) {
261 error_report("invalid password");
262 return -1;
263 }
264 }
265 return 0;
266}
267
268
Max Reitzefaa7c42016-03-16 19:54:38 +0100269static BlockBackend *img_open_opts(const char *optstr,
Kevin Wolfce099542016-03-15 13:01:04 +0100270 QemuOpts *opts, int flags, bool writethrough,
Daniel P. Berrangeabb06c52016-03-21 14:11:42 +0000271 bool quiet)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000272{
273 QDict *options;
274 Error *local_err = NULL;
275 BlockBackend *blk;
276 options = qemu_opts_to_qdict(opts, NULL);
Max Reitzefaa7c42016-03-16 19:54:38 +0100277 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000278 if (!blk) {
Daniel P. Berrange143605a2016-04-06 10:16:18 +0100279 error_reportf_err(local_err, "Could not open '%s': ", optstr);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000280 return NULL;
281 }
Kevin Wolfce099542016-03-15 13:01:04 +0100282 blk_set_enable_write_cache(blk, !writethrough);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000283
Daniel P. Berrangeabb06c52016-03-21 14:11:42 +0000284 if (img_open_password(blk, optstr, flags, quiet) < 0) {
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000285 blk_unref(blk);
286 return NULL;
287 }
288 return blk;
289}
290
Max Reitzefaa7c42016-03-16 19:54:38 +0100291static BlockBackend *img_open_file(const char *filename,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000292 const char *fmt, int flags,
Kevin Wolfce099542016-03-15 13:01:04 +0100293 bool writethrough, bool quiet)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000294{
295 BlockBackend *blk;
Max Reitz34b5d2c2013-09-05 14:45:29 +0200296 Error *local_err = NULL;
Max Reitz5bd31322015-02-05 13:58:16 -0500297 QDict *options = NULL;
Kevin Wolfad717132010-12-16 15:37:41 +0100298
bellard75c23802004-08-27 21:28:58 +0000299 if (fmt) {
Max Reitz5bd31322015-02-05 13:58:16 -0500300 options = qdict_new();
301 qdict_put(options, "driver", qstring_from_str(fmt));
bellard75c23802004-08-27 21:28:58 +0000302 }
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100303
Max Reitzefaa7c42016-03-16 19:54:38 +0100304 blk = blk_new_open(filename, NULL, options, flags, &local_err);
Max Reitz5bd31322015-02-05 13:58:16 -0500305 if (!blk) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100306 error_reportf_err(local_err, "Could not open '%s': ", filename);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000307 return NULL;
bellard75c23802004-08-27 21:28:58 +0000308 }
Kevin Wolfce099542016-03-15 13:01:04 +0100309 blk_set_enable_write_cache(blk, !writethrough);
Kevin Wolfb9eaf9e2011-02-09 11:25:53 +0100310
Daniel P. Berrangeabb06c52016-03-21 14:11:42 +0000311 if (img_open_password(blk, filename, flags, quiet) < 0) {
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000312 blk_unref(blk);
313 return NULL;
bellard75c23802004-08-27 21:28:58 +0000314 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200315 return blk;
bellard75c23802004-08-27 21:28:58 +0000316}
317
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000318
Max Reitzefaa7c42016-03-16 19:54:38 +0100319static BlockBackend *img_open(bool image_opts,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000320 const char *filename,
Kevin Wolfce099542016-03-15 13:01:04 +0100321 const char *fmt, int flags, bool writethrough,
Daniel P. Berrangeabb06c52016-03-21 14:11:42 +0000322 bool quiet)
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000323{
324 BlockBackend *blk;
325 if (image_opts) {
326 QemuOpts *opts;
327 if (fmt) {
328 error_report("--image-opts and --format are mutually exclusive");
329 return NULL;
330 }
331 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
332 filename, true);
333 if (!opts) {
334 return NULL;
335 }
Kevin Wolfce099542016-03-15 13:01:04 +0100336 blk = img_open_opts(filename, opts, flags, writethrough, quiet);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000337 } else {
Kevin Wolfce099542016-03-15 13:01:04 +0100338 blk = img_open_file(filename, fmt, flags, writethrough, quiet);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000339 }
340 return blk;
341}
342
343
Chunyan Liu83d05212014-06-05 17:20:51 +0800344static int add_old_style_options(const char *fmt, QemuOpts *opts,
Jes Sorenseneec77d92010-12-07 17:44:34 +0100345 const char *base_filename,
346 const char *base_fmt)
Kevin Wolfefa84d42009-05-18 16:42:12 +0200347{
Markus Armbruster6750e792015-02-12 17:43:08 +0100348 Error *err = NULL;
349
Kevin Wolfefa84d42009-05-18 16:42:12 +0200350 if (base_filename) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100351 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +0100352 if (err) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100353 error_report("Backing file not supported for file format '%s'",
354 fmt);
Markus Armbruster6750e792015-02-12 17:43:08 +0100355 error_free(err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900356 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200357 }
358 }
359 if (base_fmt) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100360 qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +0100361 if (err) {
Jes Sorensen15654a62010-12-16 14:31:53 +0100362 error_report("Backing file format not supported for file "
363 "format '%s'", fmt);
Markus Armbruster6750e792015-02-12 17:43:08 +0100364 error_free(err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900365 return -1;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200366 }
367 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900368 return 0;
Kevin Wolfefa84d42009-05-18 16:42:12 +0200369}
370
Markus Armbruster606caa02017-02-21 21:14:04 +0100371static int64_t cvtnum(const char *s)
372{
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100373 int err;
Markus Armbrusterf46bfdb2017-02-21 21:14:07 +0100374 uint64_t value;
Markus Armbruster606caa02017-02-21 21:14:04 +0100375
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100376 err = qemu_strtosz(s, NULL, &value);
377 if (err < 0) {
378 return err;
379 }
Markus Armbrusterf46bfdb2017-02-21 21:14:07 +0100380 if (value > INT64_MAX) {
381 return -ERANGE;
382 }
Markus Armbrusterf17fd4f2017-02-21 21:14:06 +0100383 return value;
Markus Armbruster606caa02017-02-21 21:14:04 +0100384}
385
bellardea2384d2004-08-01 21:59:26 +0000386static int img_create(int argc, char **argv)
387{
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200388 int c;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100389 uint64_t img_size = -1;
bellardea2384d2004-08-01 21:59:26 +0000390 const char *fmt = "raw";
aliguori9230eaf2009-03-28 17:55:19 +0000391 const char *base_fmt = NULL;
bellardea2384d2004-08-01 21:59:26 +0000392 const char *filename;
393 const char *base_filename = NULL;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200394 char *options = NULL;
Luiz Capitulino9b375252012-11-30 10:52:05 -0200395 Error *local_err = NULL;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100396 bool quiet = false;
ths3b46e622007-09-17 08:09:54 +0000397
bellardea2384d2004-08-01 21:59:26 +0000398 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000399 static const struct option long_options[] = {
400 {"help", no_argument, 0, 'h'},
401 {"object", required_argument, 0, OPTION_OBJECT},
402 {0, 0, 0, 0}
403 };
404 c = getopt_long(argc, argv, "F:b:f:he6o:q",
405 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100406 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000407 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100408 }
bellardea2384d2004-08-01 21:59:26 +0000409 switch(c) {
Jes Sorensenef873942010-12-06 15:25:40 +0100410 case '?':
bellardea2384d2004-08-01 21:59:26 +0000411 case 'h':
412 help();
413 break;
aliguori9230eaf2009-03-28 17:55:19 +0000414 case 'F':
415 base_fmt = optarg;
416 break;
bellardea2384d2004-08-01 21:59:26 +0000417 case 'b':
418 base_filename = optarg;
419 break;
420 case 'f':
421 fmt = optarg;
422 break;
423 case 'e':
Markus Armbruster9d42e152011-06-22 14:03:55 +0200424 error_report("option -e is deprecated, please use \'-o "
Jes Sorenseneec77d92010-12-07 17:44:34 +0100425 "encryption\' instead!");
Kevin Wolf77386bf2014-02-21 16:24:04 +0100426 goto fail;
thsd8871c52007-10-24 16:11:42 +0000427 case '6':
Markus Armbruster9d42e152011-06-22 14:03:55 +0200428 error_report("option -6 is deprecated, please use \'-o "
Jes Sorenseneec77d92010-12-07 17:44:34 +0100429 "compat6\' instead!");
Kevin Wolf77386bf2014-02-21 16:24:04 +0100430 goto fail;
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200431 case 'o':
Kevin Wolf77386bf2014-02-21 16:24:04 +0100432 if (!is_valid_option_list(optarg)) {
433 error_report("Invalid option list: %s", optarg);
434 goto fail;
435 }
436 if (!options) {
437 options = g_strdup(optarg);
438 } else {
439 char *old_options = options;
440 options = g_strdup_printf("%s,%s", options, optarg);
441 g_free(old_options);
442 }
Kevin Wolf9ea2ea72009-05-18 16:42:11 +0200443 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100444 case 'q':
445 quiet = true;
446 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000447 case OPTION_OBJECT: {
448 QemuOpts *opts;
449 opts = qemu_opts_parse_noisily(&qemu_object_opts,
450 optarg, true);
451 if (!opts) {
452 goto fail;
453 }
454 } break;
bellardea2384d2004-08-01 21:59:26 +0000455 }
456 }
aliguori9230eaf2009-03-28 17:55:19 +0000457
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900458 /* Get the filename */
Kevin Wolfa283cb62014-02-21 16:24:07 +0100459 filename = (optind < argc) ? argv[optind] : NULL;
460 if (options && has_help_option(options)) {
461 g_free(options);
462 return print_block_option_help(filename, fmt);
463 }
464
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100465 if (optind >= argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800466 error_exit("Expecting image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100467 }
Kevin Wolfa283cb62014-02-21 16:24:07 +0100468 optind++;
MORITA Kazutakab50cbab2010-05-26 11:35:36 +0900469
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000470 if (qemu_opts_foreach(&qemu_object_opts,
471 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +0200472 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000473 goto fail;
474 }
475
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100476 /* Get image size, if specified */
477 if (optind < argc) {
Jes Sorensen70b4f4b2011-01-05 11:41:02 +0100478 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +0100479
480 sval = cvtnum(argv[optind++]);
481 if (sval < 0) {
liguang79443392012-12-17 09:49:23 +0800482 if (sval == -ERANGE) {
483 error_report("Image size must be less than 8 EiB!");
484 } else {
485 error_report("Invalid image size specified! You may use k, M, "
Kevin Wolf5e009842013-06-05 14:19:27 +0200486 "G, T, P or E suffixes for ");
487 error_report("kilobytes, megabytes, gigabytes, terabytes, "
488 "petabytes and exabytes.");
liguang79443392012-12-17 09:49:23 +0800489 }
Kevin Wolf77386bf2014-02-21 16:24:04 +0100490 goto fail;
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100491 }
492 img_size = (uint64_t)sval;
493 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200494 if (optind != argc) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800495 error_exit("Unexpected argument: %s", argv[optind]);
Kevin Wolffc11eb22013-08-05 10:53:04 +0200496 }
Jes Sorensen1da7cfb2010-12-09 14:17:25 +0100497
Luiz Capitulino9b375252012-11-30 10:52:05 -0200498 bdrv_img_create(filename, fmt, base_filename, base_fmt,
Kevin Wolf61de4c62016-03-18 17:46:45 +0100499 options, img_size, 0, &local_err, quiet);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100500 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100501 error_reportf_err(local_err, "%s: ", filename);
Kevin Wolf77386bf2014-02-21 16:24:04 +0100502 goto fail;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900503 }
Luiz Capitulinoa9300912012-11-30 10:52:06 -0200504
Kevin Wolf77386bf2014-02-21 16:24:04 +0100505 g_free(options);
bellardea2384d2004-08-01 21:59:26 +0000506 return 0;
Kevin Wolf77386bf2014-02-21 16:24:04 +0100507
508fail:
509 g_free(options);
510 return 1;
bellardea2384d2004-08-01 21:59:26 +0000511}
512
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100513static void dump_json_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500514{
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500515 QString *str;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500516 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +0100517 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600518
519 visit_type_ImageCheck(v, NULL, &check, &error_abort);
520 visit_complete(v, &obj);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500521 str = qobject_to_json_pretty(obj);
522 assert(str != NULL);
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100523 qprintf(quiet, "%s\n", qstring_get_str(str));
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500524 qobject_decref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -0600525 visit_free(v);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500526 QDECREF(str);
527}
528
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100529static void dump_human_image_check(ImageCheck *check, bool quiet)
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500530{
531 if (!(check->corruptions || check->leaks || check->check_errors)) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100532 qprintf(quiet, "No errors were found on the image.\n");
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500533 } else {
534 if (check->corruptions) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100535 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
536 "Data may be corrupted, or further writes to the image "
537 "may corrupt it.\n",
538 check->corruptions);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500539 }
540
541 if (check->leaks) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100542 qprintf(quiet,
543 "\n%" PRId64 " leaked clusters were found on the image.\n"
544 "This means waste of disk space, but no harm to data.\n",
545 check->leaks);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500546 }
547
548 if (check->check_errors) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100549 qprintf(quiet,
550 "\n%" PRId64
551 " internal errors have occurred during the check.\n",
552 check->check_errors);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500553 }
554 }
555
556 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100557 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
558 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
559 check->allocated_clusters, check->total_clusters,
560 check->allocated_clusters * 100.0 / check->total_clusters,
561 check->fragmented_clusters * 100.0 / check->allocated_clusters,
562 check->compressed_clusters * 100.0 /
563 check->allocated_clusters);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500564 }
565
566 if (check->image_end_offset) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100567 qprintf(quiet,
568 "Image end offset: %" PRId64 "\n", check->image_end_offset);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500569 }
570}
571
572static int collect_image_check(BlockDriverState *bs,
573 ImageCheck *check,
574 const char *filename,
575 const char *fmt,
576 int fix)
577{
578 int ret;
579 BdrvCheckResult result;
580
581 ret = bdrv_check(bs, &result, fix);
582 if (ret < 0) {
583 return ret;
584 }
585
586 check->filename = g_strdup(filename);
587 check->format = g_strdup(bdrv_get_format_name(bs));
588 check->check_errors = result.check_errors;
589 check->corruptions = result.corruptions;
590 check->has_corruptions = result.corruptions != 0;
591 check->leaks = result.leaks;
592 check->has_leaks = result.leaks != 0;
593 check->corruptions_fixed = result.corruptions_fixed;
594 check->has_corruptions_fixed = result.corruptions != 0;
595 check->leaks_fixed = result.leaks_fixed;
596 check->has_leaks_fixed = result.leaks != 0;
597 check->image_end_offset = result.image_end_offset;
598 check->has_image_end_offset = result.image_end_offset != 0;
599 check->total_clusters = result.bfi.total_clusters;
600 check->has_total_clusters = result.bfi.total_clusters != 0;
601 check->allocated_clusters = result.bfi.allocated_clusters;
602 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
603 check->fragmented_clusters = result.bfi.fragmented_clusters;
604 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
Stefan Hajnoczie6439d72013-02-07 17:15:04 +0100605 check->compressed_clusters = result.bfi.compressed_clusters;
606 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500607
608 return 0;
609}
610
Kevin Wolfe076f332010-06-29 11:43:13 +0200611/*
612 * Checks an image for consistency. Exit codes:
613 *
Max Reitzd6635c42014-06-02 22:15:21 +0200614 * 0 - Check completed, image is good
615 * 1 - Check not completed because of internal errors
616 * 2 - Check completed, image is corrupted
617 * 3 - Check completed, image has leaked clusters, but is good otherwise
618 * 63 - Checks are not supported by the image format
Kevin Wolfe076f332010-06-29 11:43:13 +0200619 */
aliguori15859692009-04-21 23:11:53 +0000620static int img_check(int argc, char **argv)
621{
622 int c, ret;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500623 OutputFormat output_format = OFORMAT_HUMAN;
Max Reitz40055952014-07-22 22:58:42 +0200624 const char *filename, *fmt, *output, *cache;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200625 BlockBackend *blk;
aliguori15859692009-04-21 23:11:53 +0000626 BlockDriverState *bs;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200627 int fix = 0;
Kevin Wolfce099542016-03-15 13:01:04 +0100628 int flags = BDRV_O_CHECK;
629 bool writethrough;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200630 ImageCheck *check;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100631 bool quiet = false;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000632 bool image_opts = false;
aliguori15859692009-04-21 23:11:53 +0000633
634 fmt = NULL;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500635 output = NULL;
Max Reitz40055952014-07-22 22:58:42 +0200636 cache = BDRV_DEFAULT_CACHE;
Kevin Wolfce099542016-03-15 13:01:04 +0100637
aliguori15859692009-04-21 23:11:53 +0000638 for(;;) {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500639 int option_index = 0;
640 static const struct option long_options[] = {
641 {"help", no_argument, 0, 'h'},
642 {"format", required_argument, 0, 'f'},
Prasad Joshi4fd6a982014-03-25 00:08:54 +0530643 {"repair", required_argument, 0, 'r'},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500644 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000645 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000646 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500647 {0, 0, 0, 0}
648 };
Max Reitz40055952014-07-22 22:58:42 +0200649 c = getopt_long(argc, argv, "hf:r:T:q",
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500650 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100651 if (c == -1) {
aliguori15859692009-04-21 23:11:53 +0000652 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100653 }
aliguori15859692009-04-21 23:11:53 +0000654 switch(c) {
Jes Sorensenef873942010-12-06 15:25:40 +0100655 case '?':
aliguori15859692009-04-21 23:11:53 +0000656 case 'h':
657 help();
658 break;
659 case 'f':
660 fmt = optarg;
661 break;
Kevin Wolf4534ff52012-05-11 16:07:02 +0200662 case 'r':
663 flags |= BDRV_O_RDWR;
664
665 if (!strcmp(optarg, "leaks")) {
666 fix = BDRV_FIX_LEAKS;
667 } else if (!strcmp(optarg, "all")) {
668 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
669 } else {
Fam Zhengac1307a2014-04-22 13:36:11 +0800670 error_exit("Unknown option value for -r "
671 "(expecting 'leaks' or 'all'): %s", optarg);
Kevin Wolf4534ff52012-05-11 16:07:02 +0200672 }
673 break;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500674 case OPTION_OUTPUT:
675 output = optarg;
676 break;
Max Reitz40055952014-07-22 22:58:42 +0200677 case 'T':
678 cache = optarg;
679 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100680 case 'q':
681 quiet = true;
682 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000683 case OPTION_OBJECT: {
684 QemuOpts *opts;
685 opts = qemu_opts_parse_noisily(&qemu_object_opts,
686 optarg, true);
687 if (!opts) {
688 return 1;
689 }
690 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000691 case OPTION_IMAGE_OPTS:
692 image_opts = true;
693 break;
aliguori15859692009-04-21 23:11:53 +0000694 }
695 }
Kevin Wolffc11eb22013-08-05 10:53:04 +0200696 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800697 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100698 }
aliguori15859692009-04-21 23:11:53 +0000699 filename = argv[optind++];
700
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500701 if (output && !strcmp(output, "json")) {
702 output_format = OFORMAT_JSON;
703 } else if (output && !strcmp(output, "human")) {
704 output_format = OFORMAT_HUMAN;
705 } else if (output) {
706 error_report("--output must be used with human or json as argument.");
707 return 1;
708 }
709
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000710 if (qemu_opts_foreach(&qemu_object_opts,
711 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +0200712 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000713 return 1;
714 }
715
Kevin Wolfce099542016-03-15 13:01:04 +0100716 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +0200717 if (ret < 0) {
718 error_report("Invalid source cache option: %s", cache);
719 return 1;
720 }
721
Kevin Wolfce099542016-03-15 13:01:04 +0100722 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200723 if (!blk) {
724 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900725 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200726 bs = blk_bs(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500727
728 check = g_new0(ImageCheck, 1);
729 ret = collect_image_check(bs, check, filename, fmt, fix);
Kevin Wolfe076f332010-06-29 11:43:13 +0200730
731 if (ret == -ENOTSUP) {
Max Reitz55d492d2014-05-31 21:33:30 +0200732 error_report("This image format does not support checks");
Peter Lievenfefddf92013-10-24 08:53:34 +0200733 ret = 63;
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500734 goto fail;
Kevin Wolfe076f332010-06-29 11:43:13 +0200735 }
736
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500737 if (check->corruptions_fixed || check->leaks_fixed) {
738 int corruptions_fixed, leaks_fixed;
739
740 leaks_fixed = check->leaks_fixed;
741 corruptions_fixed = check->corruptions_fixed;
742
743 if (output_format == OFORMAT_HUMAN) {
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100744 qprintf(quiet,
745 "The following inconsistencies were found and repaired:\n\n"
746 " %" PRId64 " leaked clusters\n"
747 " %" PRId64 " corruptions\n\n"
748 "Double checking the fixed image now...\n",
749 check->leaks_fixed,
750 check->corruptions_fixed);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500751 }
752
753 ret = collect_image_check(bs, check, filename, fmt, 0);
754
755 check->leaks_fixed = leaks_fixed;
756 check->corruptions_fixed = corruptions_fixed;
Kevin Wolfccf34712012-05-11 18:16:54 +0200757 }
758
Max Reitz832390a2014-10-23 15:29:12 +0200759 if (!ret) {
760 switch (output_format) {
761 case OFORMAT_HUMAN:
762 dump_human_image_check(check, quiet);
763 break;
764 case OFORMAT_JSON:
765 dump_json_image_check(check, quiet);
766 break;
767 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500768 }
769
770 if (ret || check->check_errors) {
Max Reitz832390a2014-10-23 15:29:12 +0200771 if (ret) {
772 error_report("Check failed: %s", strerror(-ret));
773 } else {
774 error_report("Check failed");
775 }
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500776 ret = 1;
777 goto fail;
778 }
779
780 if (check->corruptions) {
781 ret = 2;
782 } else if (check->leaks) {
783 ret = 3;
Kevin Wolfe076f332010-06-29 11:43:13 +0200784 } else {
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500785 ret = 0;
aliguori15859692009-04-21 23:11:53 +0000786 }
787
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500788fail:
789 qapi_free_ImageCheck(check);
Markus Armbruster26f54e92014-10-07 13:59:04 +0200790 blk_unref(blk);
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500791 return ret;
aliguori15859692009-04-21 23:11:53 +0000792}
793
Max Reitzd4a32382014-10-24 15:57:37 +0200794typedef struct CommonBlockJobCBInfo {
795 BlockDriverState *bs;
796 Error **errp;
797} CommonBlockJobCBInfo;
798
799static void common_block_job_cb(void *opaque, int ret)
800{
801 CommonBlockJobCBInfo *cbi = opaque;
802
803 if (ret < 0) {
804 error_setg_errno(cbi->errp, -ret, "Block job failed");
805 }
Max Reitzd4a32382014-10-24 15:57:37 +0200806}
807
808static void run_block_job(BlockJob *job, Error **errp)
809{
Kevin Wolfb75536c2016-04-18 17:30:17 +0200810 AioContext *aio_context = blk_get_aio_context(job->blk);
Max Reitzd4a32382014-10-24 15:57:37 +0200811
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200812 aio_context_acquire(aio_context);
Max Reitzd4a32382014-10-24 15:57:37 +0200813 do {
814 aio_poll(aio_context, true);
John Snow62547b82015-11-02 18:28:20 -0500815 qemu_progress_print(job->len ?
816 ((float)job->offset / job->len * 100.f) : 0.0f, 0);
Max Reitzd4a32382014-10-24 15:57:37 +0200817 } while (!job->ready);
818
819 block_job_complete_sync(job, errp);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200820 aio_context_release(aio_context);
Max Reitz687fa1d2014-10-24 15:57:39 +0200821
822 /* A block job may finish instantaneously without publishing any progress,
823 * so just signal completion here */
824 qemu_progress_print(100.f, 0);
Max Reitzd4a32382014-10-24 15:57:37 +0200825}
826
bellardea2384d2004-08-01 21:59:26 +0000827static int img_commit(int argc, char **argv)
828{
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400829 int c, ret, flags;
Max Reitz1b22bff2014-10-24 15:57:40 +0200830 const char *filename, *fmt, *cache, *base;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200831 BlockBackend *blk;
Max Reitzd4a32382014-10-24 15:57:37 +0200832 BlockDriverState *bs, *base_bs;
Max Reitz687fa1d2014-10-24 15:57:39 +0200833 bool progress = false, quiet = false, drop = false;
Kevin Wolfce099542016-03-15 13:01:04 +0100834 bool writethrough;
Max Reitzd4a32382014-10-24 15:57:37 +0200835 Error *local_err = NULL;
836 CommonBlockJobCBInfo cbi;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000837 bool image_opts = false;
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200838 AioContext *aio_context;
bellardea2384d2004-08-01 21:59:26 +0000839
840 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400841 cache = BDRV_DEFAULT_CACHE;
Max Reitz1b22bff2014-10-24 15:57:40 +0200842 base = NULL;
bellardea2384d2004-08-01 21:59:26 +0000843 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000844 static const struct option long_options[] = {
845 {"help", no_argument, 0, 'h'},
846 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000847 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000848 {0, 0, 0, 0}
849 };
850 c = getopt_long(argc, argv, "f:ht:b:dpq",
851 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100852 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +0000853 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100854 }
bellardea2384d2004-08-01 21:59:26 +0000855 switch(c) {
Jes Sorensenef873942010-12-06 15:25:40 +0100856 case '?':
bellardea2384d2004-08-01 21:59:26 +0000857 case 'h':
858 help();
859 break;
860 case 'f':
861 fmt = optarg;
862 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400863 case 't':
864 cache = optarg;
865 break;
Max Reitz1b22bff2014-10-24 15:57:40 +0200866 case 'b':
867 base = optarg;
868 /* -b implies -d */
869 drop = true;
870 break;
Max Reitz9a86fe42014-10-24 15:57:38 +0200871 case 'd':
872 drop = true;
873 break;
Max Reitz687fa1d2014-10-24 15:57:39 +0200874 case 'p':
875 progress = true;
876 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +0100877 case 'q':
878 quiet = true;
879 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000880 case OPTION_OBJECT: {
881 QemuOpts *opts;
882 opts = qemu_opts_parse_noisily(&qemu_object_opts,
883 optarg, true);
884 if (!opts) {
885 return 1;
886 }
887 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +0000888 case OPTION_IMAGE_OPTS:
889 image_opts = true;
890 break;
bellardea2384d2004-08-01 21:59:26 +0000891 }
892 }
Max Reitz687fa1d2014-10-24 15:57:39 +0200893
894 /* Progress is not shown in Quiet mode */
895 if (quiet) {
896 progress = false;
897 }
898
Kevin Wolffc11eb22013-08-05 10:53:04 +0200899 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +0800900 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +0100901 }
bellardea2384d2004-08-01 21:59:26 +0000902 filename = argv[optind++];
903
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000904 if (qemu_opts_foreach(&qemu_object_opts,
905 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +0200906 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +0000907 return 1;
908 }
909
Max Reitz9a86fe42014-10-24 15:57:38 +0200910 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
Kevin Wolfce099542016-03-15 13:01:04 +0100911 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400912 if (ret < 0) {
913 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczia3981eb2014-08-26 19:17:54 +0100914 return 1;
Federico Simoncelli661a0f72011-06-20 12:48:19 -0400915 }
916
Kevin Wolfce099542016-03-15 13:01:04 +0100917 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200918 if (!blk) {
919 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900920 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +0200921 bs = blk_bs(blk);
922
Max Reitz687fa1d2014-10-24 15:57:39 +0200923 qemu_progress_init(progress, 1.f);
924 qemu_progress_print(0.f, 100);
925
Max Reitz1b22bff2014-10-24 15:57:40 +0200926 if (base) {
927 base_bs = bdrv_find_backing_image(bs, base);
928 if (!base_bs) {
Max Reitz6b33f3a2016-12-01 03:05:08 +0100929 error_setg(&local_err,
930 "Did not find '%s' in the backing chain of '%s'",
931 base, filename);
Max Reitz1b22bff2014-10-24 15:57:40 +0200932 goto done;
933 }
934 } else {
935 /* This is different from QMP, which by default uses the deepest file in
936 * the backing chain (i.e., the very base); however, the traditional
937 * behavior of qemu-img commit is using the immediate backing file. */
Kevin Wolf760e0062015-06-17 14:55:21 +0200938 base_bs = backing_bs(bs);
Max Reitz1b22bff2014-10-24 15:57:40 +0200939 if (!base_bs) {
940 error_setg(&local_err, "Image does not have a backing file");
941 goto done;
942 }
bellardea2384d2004-08-01 21:59:26 +0000943 }
944
Max Reitzd4a32382014-10-24 15:57:37 +0200945 cbi = (CommonBlockJobCBInfo){
946 .errp = &local_err,
947 .bs = bs,
948 };
949
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200950 aio_context = bdrv_get_aio_context(bs);
951 aio_context_acquire(aio_context);
John Snow47970df2016-10-27 12:06:57 -0400952 commit_active_start("commit", bs, base_bs, BLOCK_JOB_DEFAULT, 0,
953 BLOCKDEV_ON_ERROR_REPORT, common_block_job_cb, &cbi,
954 &local_err, false);
Paolo Bonzini9e944cb2016-10-27 12:49:04 +0200955 aio_context_release(aio_context);
Max Reitzd4a32382014-10-24 15:57:37 +0200956 if (local_err) {
957 goto done;
958 }
959
Kevin Wolf3f09bfb2015-09-15 11:58:23 +0200960 /* When the block job completes, the BlockBackend reference will point to
961 * the old backing file. In order to avoid that the top image is already
962 * deleted, so we can still empty it afterwards, increment the reference
963 * counter here preemptively. */
Max Reitz9a86fe42014-10-24 15:57:38 +0200964 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +0200965 bdrv_ref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +0200966 }
967
Max Reitzd4a32382014-10-24 15:57:37 +0200968 run_block_job(bs->job, &local_err);
Max Reitz9a86fe42014-10-24 15:57:38 +0200969 if (local_err) {
970 goto unref_backing;
971 }
972
Kevin Wolf3f09bfb2015-09-15 11:58:23 +0200973 if (!drop && bs->drv->bdrv_make_empty) {
974 ret = bs->drv->bdrv_make_empty(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +0200975 if (ret) {
976 error_setg_errno(&local_err, -ret, "Could not empty %s",
977 filename);
978 goto unref_backing;
979 }
980 }
981
982unref_backing:
983 if (!drop) {
Kevin Wolf3f09bfb2015-09-15 11:58:23 +0200984 bdrv_unref(bs);
Max Reitz9a86fe42014-10-24 15:57:38 +0200985 }
Max Reitzd4a32382014-10-24 15:57:37 +0200986
987done:
Max Reitz687fa1d2014-10-24 15:57:39 +0200988 qemu_progress_end();
989
Markus Armbruster26f54e92014-10-07 13:59:04 +0200990 blk_unref(blk);
Max Reitzd4a32382014-10-24 15:57:37 +0200991
992 if (local_err) {
Markus Armbruster6936f292015-02-10 15:14:02 +0100993 error_report_err(local_err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +0900994 return 1;
995 }
Max Reitzd4a32382014-10-24 15:57:37 +0200996
997 qprintf(quiet, "Image committed.\n");
bellardea2384d2004-08-01 21:59:26 +0000998 return 0;
999}
1000
Dmitry Konishchevf6a00aa2011-05-18 15:03:59 +04001001/*
thsf58c7b32008-06-05 21:53:49 +00001002 * Returns true iff the first sector pointed to by 'buf' contains at least
1003 * a non-NUL byte.
1004 *
1005 * 'pnum' is set to the number of sectors (including and immediately following
1006 * the first one) that are known to be in the same allocated/unallocated state.
1007 */
bellardea2384d2004-08-01 21:59:26 +00001008static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
1009{
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001010 bool is_zero;
1011 int i;
bellardea2384d2004-08-01 21:59:26 +00001012
1013 if (n <= 0) {
1014 *pnum = 0;
1015 return 0;
1016 }
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001017 is_zero = buffer_is_zero(buf, 512);
bellardea2384d2004-08-01 21:59:26 +00001018 for(i = 1; i < n; i++) {
1019 buf += 512;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001020 if (is_zero != buffer_is_zero(buf, 512)) {
bellardea2384d2004-08-01 21:59:26 +00001021 break;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001022 }
bellardea2384d2004-08-01 21:59:26 +00001023 }
1024 *pnum = i;
Stefan Hajnoczi1a6d39f2012-02-07 13:27:24 +00001025 return !is_zero;
bellardea2384d2004-08-01 21:59:26 +00001026}
1027
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001028/*
Kevin Wolfa22f1232011-08-26 15:27:13 +02001029 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1030 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1031 * breaking up write requests for only small sparse areas.
1032 */
1033static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
1034 int min)
1035{
1036 int ret;
1037 int num_checked, num_used;
1038
1039 if (n < min) {
1040 min = n;
1041 }
1042
1043 ret = is_allocated_sectors(buf, n, pnum);
1044 if (!ret) {
1045 return ret;
1046 }
1047
1048 num_used = *pnum;
1049 buf += BDRV_SECTOR_SIZE * *pnum;
1050 n -= *pnum;
1051 num_checked = num_used;
1052
1053 while (n > 0) {
1054 ret = is_allocated_sectors(buf, n, pnum);
1055
1056 buf += BDRV_SECTOR_SIZE * *pnum;
1057 n -= *pnum;
1058 num_checked += *pnum;
1059 if (ret) {
1060 num_used = num_checked;
1061 } else if (*pnum >= min) {
1062 break;
1063 }
1064 }
1065
1066 *pnum = num_used;
1067 return 1;
1068}
1069
1070/*
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001071 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1072 * buffers matches, non-zero otherwise.
1073 *
1074 * pnum is set to the number of sectors (including and immediately following
1075 * the first one) that are known to have the same comparison result
1076 */
1077static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
1078 int *pnum)
1079{
Radim Krčmář8c1ac472015-02-20 17:06:15 +01001080 bool res;
1081 int i;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01001082
1083 if (n <= 0) {
1084 *pnum = 0;
1085 return 0;
1086 }
1087
1088 res = !!memcmp(buf1, buf2, 512);
1089 for(i = 1; i < n; i++) {
1090 buf1 += 512;
1091 buf2 += 512;
1092
1093 if (!!memcmp(buf1, buf2, 512) != res) {
1094 break;
1095 }
1096 }
1097
1098 *pnum = i;
1099 return res;
1100}
1101
Kevin Wolf80ee15a2009-09-15 12:30:43 +02001102#define IO_BUF_SIZE (2 * 1024 * 1024)
bellardea2384d2004-08-01 21:59:26 +00001103
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001104static int64_t sectors_to_bytes(int64_t sectors)
1105{
1106 return sectors << BDRV_SECTOR_BITS;
1107}
1108
1109static int64_t sectors_to_process(int64_t total, int64_t from)
1110{
1111 return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
1112}
1113
1114/*
1115 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1116 *
1117 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1118 * data and negative value on error.
1119 *
Max Reitzf1d3cd72015-02-05 13:58:18 -05001120 * @param blk: BlockBackend for the image
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001121 * @param sect_num: Number of first sector to check
1122 * @param sect_count: Number of sectors to check
1123 * @param filename: Name of disk file we are checking (logging purpose)
1124 * @param buffer: Allocated buffer for storing read data
1125 * @param quiet: Flag for quiet mode
1126 */
Max Reitzf1d3cd72015-02-05 13:58:18 -05001127static int check_empty_sectors(BlockBackend *blk, int64_t sect_num,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001128 int sect_count, const char *filename,
1129 uint8_t *buffer, bool quiet)
1130{
1131 int pnum, ret = 0;
Eric Blake91669202016-05-06 10:26:43 -06001132 ret = blk_pread(blk, sect_num << BDRV_SECTOR_BITS, buffer,
1133 sect_count << BDRV_SECTOR_BITS);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001134 if (ret < 0) {
1135 error_report("Error while reading offset %" PRId64 " of %s: %s",
1136 sectors_to_bytes(sect_num), filename, strerror(-ret));
1137 return ret;
1138 }
1139 ret = is_allocated_sectors(buffer, sect_count, &pnum);
1140 if (ret || pnum != sect_count) {
1141 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1142 sectors_to_bytes(ret ? sect_num : sect_num + pnum));
1143 return 1;
1144 }
1145
1146 return 0;
1147}
1148
1149/*
1150 * Compares two images. Exit codes:
1151 *
1152 * 0 - Images are identical
1153 * 1 - Images differ
1154 * >1 - Error occurred
1155 */
1156static int img_compare(int argc, char **argv)
1157{
Max Reitz40055952014-07-22 22:58:42 +02001158 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001159 BlockBackend *blk1, *blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001160 BlockDriverState *bs1, *bs2;
1161 int64_t total_sectors1, total_sectors2;
1162 uint8_t *buf1 = NULL, *buf2 = NULL;
1163 int pnum1, pnum2;
1164 int allocated1, allocated2;
1165 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1166 bool progress = false, quiet = false, strict = false;
Max Reitz40055952014-07-22 22:58:42 +02001167 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01001168 bool writethrough;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001169 int64_t total_sectors;
1170 int64_t sector_num = 0;
1171 int64_t nb_sectors;
1172 int c, pnum;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001173 uint64_t progress_base;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001174 bool image_opts = false;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001175
Max Reitz40055952014-07-22 22:58:42 +02001176 cache = BDRV_DEFAULT_CACHE;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001177 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001178 static const struct option long_options[] = {
1179 {"help", no_argument, 0, 'h'},
1180 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001181 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001182 {0, 0, 0, 0}
1183 };
1184 c = getopt_long(argc, argv, "hf:F:T:pqs",
1185 long_options, NULL);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001186 if (c == -1) {
1187 break;
1188 }
1189 switch (c) {
1190 case '?':
1191 case 'h':
1192 help();
1193 break;
1194 case 'f':
1195 fmt1 = optarg;
1196 break;
1197 case 'F':
1198 fmt2 = optarg;
1199 break;
Max Reitz40055952014-07-22 22:58:42 +02001200 case 'T':
1201 cache = optarg;
1202 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001203 case 'p':
1204 progress = true;
1205 break;
1206 case 'q':
1207 quiet = true;
1208 break;
1209 case 's':
1210 strict = true;
1211 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001212 case OPTION_OBJECT: {
1213 QemuOpts *opts;
1214 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1215 optarg, true);
1216 if (!opts) {
1217 ret = 2;
1218 goto out4;
1219 }
1220 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001221 case OPTION_IMAGE_OPTS:
1222 image_opts = true;
1223 break;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001224 }
1225 }
1226
1227 /* Progress is not shown in Quiet mode */
1228 if (quiet) {
1229 progress = false;
1230 }
1231
1232
Kevin Wolffc11eb22013-08-05 10:53:04 +02001233 if (optind != argc - 2) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001234 error_exit("Expecting two image file names");
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001235 }
1236 filename1 = argv[optind++];
1237 filename2 = argv[optind++];
1238
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001239 if (qemu_opts_foreach(&qemu_object_opts,
1240 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02001241 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001242 ret = 2;
1243 goto out4;
1244 }
1245
Stefan Hajnoczicbda0162014-08-26 19:17:55 +01001246 /* Initialize before goto out */
1247 qemu_progress_init(progress, 2.0);
1248
Kevin Wolfce099542016-03-15 13:01:04 +01001249 flags = 0;
1250 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitz40055952014-07-22 22:58:42 +02001251 if (ret < 0) {
1252 error_report("Invalid source cache option: %s", cache);
1253 ret = 2;
1254 goto out3;
1255 }
1256
Kevin Wolfce099542016-03-15 13:01:04 +01001257 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001258 if (!blk1) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001259 ret = 2;
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001260 goto out3;
1261 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001262
Kevin Wolfce099542016-03-15 13:01:04 +01001263 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001264 if (!blk2) {
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001265 ret = 2;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001266 goto out2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001267 }
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001268 bs1 = blk_bs(blk1);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001269 bs2 = blk_bs(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001270
Max Reitzf1d3cd72015-02-05 13:58:18 -05001271 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1272 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1273 total_sectors1 = blk_nb_sectors(blk1);
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001274 if (total_sectors1 < 0) {
1275 error_report("Can't get size of %s: %s",
1276 filename1, strerror(-total_sectors1));
1277 ret = 4;
1278 goto out;
1279 }
Max Reitzf1d3cd72015-02-05 13:58:18 -05001280 total_sectors2 = blk_nb_sectors(blk2);
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001281 if (total_sectors2 < 0) {
1282 error_report("Can't get size of %s: %s",
1283 filename2, strerror(-total_sectors2));
1284 ret = 4;
1285 goto out;
1286 }
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001287 total_sectors = MIN(total_sectors1, total_sectors2);
1288 progress_base = MAX(total_sectors1, total_sectors2);
1289
1290 qemu_progress_print(0, 100);
1291
1292 if (strict && total_sectors1 != total_sectors2) {
1293 ret = 1;
1294 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1295 goto out;
1296 }
1297
1298 for (;;) {
Fam Zheng25ad8e62016-01-13 16:37:41 +08001299 int64_t status1, status2;
Fam Zheng67a0fd22016-01-26 11:58:48 +08001300 BlockDriverState *file;
1301
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001302 nb_sectors = sectors_to_process(total_sectors, sector_num);
1303 if (nb_sectors <= 0) {
1304 break;
1305 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001306 status1 = bdrv_get_block_status_above(bs1, NULL, sector_num,
1307 total_sectors1 - sector_num,
Fam Zheng67a0fd22016-01-26 11:58:48 +08001308 &pnum1, &file);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001309 if (status1 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001310 ret = 3;
1311 error_report("Sector allocation test failed for %s", filename1);
1312 goto out;
1313 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001314 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001315
Fam Zheng25ad8e62016-01-13 16:37:41 +08001316 status2 = bdrv_get_block_status_above(bs2, NULL, sector_num,
1317 total_sectors2 - sector_num,
Fam Zheng67a0fd22016-01-26 11:58:48 +08001318 &pnum2, &file);
Fam Zheng25ad8e62016-01-13 16:37:41 +08001319 if (status2 < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001320 ret = 3;
1321 error_report("Sector allocation test failed for %s", filename2);
1322 goto out;
1323 }
Fam Zheng25ad8e62016-01-13 16:37:41 +08001324 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1325 if (pnum1) {
1326 nb_sectors = MIN(nb_sectors, pnum1);
1327 }
1328 if (pnum2) {
1329 nb_sectors = MIN(nb_sectors, pnum2);
1330 }
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001331
Fam Zheng25ad8e62016-01-13 16:37:41 +08001332 if (strict) {
1333 if ((status1 & ~BDRV_BLOCK_OFFSET_MASK) !=
1334 (status2 & ~BDRV_BLOCK_OFFSET_MASK)) {
1335 ret = 1;
1336 qprintf(quiet, "Strict mode: Offset %" PRId64
1337 " block status mismatch!\n",
1338 sectors_to_bytes(sector_num));
1339 goto out;
1340 }
1341 }
1342 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1343 nb_sectors = MIN(pnum1, pnum2);
1344 } else if (allocated1 == allocated2) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001345 if (allocated1) {
Eric Blake91669202016-05-06 10:26:43 -06001346 ret = blk_pread(blk1, sector_num << BDRV_SECTOR_BITS, buf1,
1347 nb_sectors << BDRV_SECTOR_BITS);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001348 if (ret < 0) {
1349 error_report("Error while reading offset %" PRId64 " of %s:"
1350 " %s", sectors_to_bytes(sector_num), filename1,
1351 strerror(-ret));
1352 ret = 4;
1353 goto out;
1354 }
Eric Blake91669202016-05-06 10:26:43 -06001355 ret = blk_pread(blk2, sector_num << BDRV_SECTOR_BITS, buf2,
1356 nb_sectors << BDRV_SECTOR_BITS);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001357 if (ret < 0) {
1358 error_report("Error while reading offset %" PRId64
1359 " of %s: %s", sectors_to_bytes(sector_num),
1360 filename2, strerror(-ret));
1361 ret = 4;
1362 goto out;
1363 }
1364 ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
1365 if (ret || pnum != nb_sectors) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001366 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1367 sectors_to_bytes(
1368 ret ? sector_num : sector_num + pnum));
Fam Zheng36452f12013-11-13 20:26:49 +08001369 ret = 1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001370 goto out;
1371 }
1372 }
1373 } else {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001374
1375 if (allocated1) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001376 ret = check_empty_sectors(blk1, sector_num, nb_sectors,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001377 filename1, buf1, quiet);
1378 } else {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001379 ret = check_empty_sectors(blk2, sector_num, nb_sectors,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001380 filename2, buf1, quiet);
1381 }
1382 if (ret) {
1383 if (ret < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001384 error_report("Error while reading offset %" PRId64 ": %s",
1385 sectors_to_bytes(sector_num), strerror(-ret));
Fam Zheng36452f12013-11-13 20:26:49 +08001386 ret = 4;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001387 }
1388 goto out;
1389 }
1390 }
1391 sector_num += nb_sectors;
1392 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1393 }
1394
1395 if (total_sectors1 != total_sectors2) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001396 BlockBackend *blk_over;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001397 int64_t total_sectors_over;
1398 const char *filename_over;
1399
1400 qprintf(quiet, "Warning: Image size mismatch!\n");
1401 if (total_sectors1 > total_sectors2) {
1402 total_sectors_over = total_sectors1;
Max Reitzf1d3cd72015-02-05 13:58:18 -05001403 blk_over = blk1;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001404 filename_over = filename1;
1405 } else {
1406 total_sectors_over = total_sectors2;
Max Reitzf1d3cd72015-02-05 13:58:18 -05001407 blk_over = blk2;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001408 filename_over = filename2;
1409 }
1410
1411 for (;;) {
1412 nb_sectors = sectors_to_process(total_sectors_over, sector_num);
1413 if (nb_sectors <= 0) {
1414 break;
1415 }
Max Reitzf1d3cd72015-02-05 13:58:18 -05001416 ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001417 nb_sectors, &pnum);
1418 if (ret < 0) {
1419 ret = 3;
1420 error_report("Sector allocation test failed for %s",
1421 filename_over);
1422 goto out;
1423
1424 }
1425 nb_sectors = pnum;
1426 if (ret) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05001427 ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001428 filename_over, buf1, quiet);
1429 if (ret) {
1430 if (ret < 0) {
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001431 error_report("Error while reading offset %" PRId64
1432 " of %s: %s", sectors_to_bytes(sector_num),
1433 filename_over, strerror(-ret));
Fam Zheng36452f12013-11-13 20:26:49 +08001434 ret = 4;
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001435 }
1436 goto out;
1437 }
1438 }
1439 sector_num += nb_sectors;
1440 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1441 }
1442 }
1443
1444 qprintf(quiet, "Images are identical.\n");
1445 ret = 0;
1446
1447out:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001448 qemu_vfree(buf1);
1449 qemu_vfree(buf2);
Markus Armbruster26f54e92014-10-07 13:59:04 +02001450 blk_unref(blk2);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001451out2:
Markus Armbruster26f54e92014-10-07 13:59:04 +02001452 blk_unref(blk1);
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001453out3:
1454 qemu_progress_end();
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001455out4:
Miroslav Rezaninad14ed182013-02-13 09:09:41 +01001456 return ret;
1457}
1458
Kevin Wolf690c7302015-03-19 13:33:32 +01001459enum ImgConvertBlockStatus {
1460 BLK_DATA,
1461 BLK_ZERO,
1462 BLK_BACKING_FILE,
1463};
1464
1465typedef struct ImgConvertState {
1466 BlockBackend **src;
1467 int64_t *src_sectors;
1468 int src_cur, src_num;
1469 int64_t src_cur_offset;
1470 int64_t total_sectors;
1471 int64_t allocated_sectors;
1472 enum ImgConvertBlockStatus status;
1473 int64_t sector_next_status;
1474 BlockBackend *target;
1475 bool has_zero_init;
1476 bool compressed;
1477 bool target_has_backing;
1478 int min_sparse;
1479 size_t cluster_sectors;
1480 size_t buf_sectors;
1481} ImgConvertState;
1482
1483static void convert_select_part(ImgConvertState *s, int64_t sector_num)
1484{
1485 assert(sector_num >= s->src_cur_offset);
1486 while (sector_num - s->src_cur_offset >= s->src_sectors[s->src_cur]) {
1487 s->src_cur_offset += s->src_sectors[s->src_cur];
1488 s->src_cur++;
1489 assert(s->src_cur < s->src_num);
1490 }
1491}
1492
1493static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1494{
1495 int64_t ret;
1496 int n;
1497
1498 convert_select_part(s, sector_num);
1499
1500 assert(s->total_sectors > sector_num);
1501 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1502
1503 if (s->sector_next_status <= sector_num) {
Fam Zheng67a0fd22016-01-26 11:58:48 +08001504 BlockDriverState *file;
Kevin Wolf690c7302015-03-19 13:33:32 +01001505 ret = bdrv_get_block_status(blk_bs(s->src[s->src_cur]),
1506 sector_num - s->src_cur_offset,
Fam Zheng67a0fd22016-01-26 11:58:48 +08001507 n, &n, &file);
Kevin Wolf690c7302015-03-19 13:33:32 +01001508 if (ret < 0) {
1509 return ret;
1510 }
1511
1512 if (ret & BDRV_BLOCK_ZERO) {
1513 s->status = BLK_ZERO;
1514 } else if (ret & BDRV_BLOCK_DATA) {
1515 s->status = BLK_DATA;
1516 } else if (!s->target_has_backing) {
1517 /* Without a target backing file we must copy over the contents of
1518 * the backing file as well. */
Ren Kimura263a6f42016-04-28 01:04:58 +09001519 /* Check block status of the backing file chain to avoid
Kevin Wolf690c7302015-03-19 13:33:32 +01001520 * needlessly reading zeroes and limiting the iteration to the
1521 * buffer size */
Ren Kimura263a6f42016-04-28 01:04:58 +09001522 ret = bdrv_get_block_status_above(blk_bs(s->src[s->src_cur]), NULL,
1523 sector_num - s->src_cur_offset,
1524 n, &n, &file);
1525 if (ret < 0) {
1526 return ret;
1527 }
1528
1529 if (ret & BDRV_BLOCK_ZERO) {
1530 s->status = BLK_ZERO;
1531 } else {
1532 s->status = BLK_DATA;
1533 }
Kevin Wolf690c7302015-03-19 13:33:32 +01001534 } else {
1535 s->status = BLK_BACKING_FILE;
1536 }
1537
1538 s->sector_next_status = sector_num + n;
1539 }
1540
1541 n = MIN(n, s->sector_next_status - sector_num);
1542 if (s->status == BLK_DATA) {
1543 n = MIN(n, s->buf_sectors);
1544 }
1545
1546 /* We need to write complete clusters for compressed images, so if an
1547 * unallocated area is shorter than that, we must consider the whole
1548 * cluster allocated. */
1549 if (s->compressed) {
1550 if (n < s->cluster_sectors) {
1551 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1552 s->status = BLK_DATA;
1553 } else {
1554 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1555 }
1556 }
1557
1558 return n;
1559}
1560
1561static int convert_read(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1562 uint8_t *buf)
1563{
1564 int n;
1565 int ret;
1566
Kevin Wolf690c7302015-03-19 13:33:32 +01001567 assert(nb_sectors <= s->buf_sectors);
1568 while (nb_sectors > 0) {
1569 BlockBackend *blk;
1570 int64_t bs_sectors;
1571
1572 /* In the case of compression with multiple source files, we can get a
1573 * nb_sectors that spreads into the next part. So we must be able to
1574 * read across multiple BDSes for one convert_read() call. */
1575 convert_select_part(s, sector_num);
1576 blk = s->src[s->src_cur];
1577 bs_sectors = s->src_sectors[s->src_cur];
1578
1579 n = MIN(nb_sectors, bs_sectors - (sector_num - s->src_cur_offset));
Eric Blake91669202016-05-06 10:26:43 -06001580 ret = blk_pread(blk,
1581 (sector_num - s->src_cur_offset) << BDRV_SECTOR_BITS,
1582 buf, n << BDRV_SECTOR_BITS);
Kevin Wolf690c7302015-03-19 13:33:32 +01001583 if (ret < 0) {
1584 return ret;
1585 }
1586
1587 sector_num += n;
1588 nb_sectors -= n;
1589 buf += n * BDRV_SECTOR_SIZE;
1590 }
1591
1592 return 0;
1593}
1594
1595static int convert_write(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1596 const uint8_t *buf)
1597{
1598 int ret;
1599
1600 while (nb_sectors > 0) {
1601 int n = nb_sectors;
1602
1603 switch (s->status) {
1604 case BLK_BACKING_FILE:
1605 /* If we have a backing file, leave clusters unallocated that are
1606 * unallocated in the source image, so that the backing file is
1607 * visible at the respective offset. */
1608 assert(s->target_has_backing);
1609 break;
1610
1611 case BLK_DATA:
1612 /* We must always write compressed clusters as a whole, so don't
1613 * try to find zeroed parts in the buffer. We can only save the
1614 * write if the buffer is completely zeroed and we're allowed to
1615 * keep the target sparse. */
1616 if (s->compressed) {
1617 if (s->has_zero_init && s->min_sparse &&
1618 buffer_is_zero(buf, n * BDRV_SECTOR_SIZE))
1619 {
1620 assert(!s->target_has_backing);
1621 break;
1622 }
1623
Pavel Butsykinfe5c1352016-07-22 11:17:40 +03001624 ret = blk_pwrite_compressed(s->target,
1625 sector_num << BDRV_SECTOR_BITS,
1626 buf, n << BDRV_SECTOR_BITS);
Kevin Wolf690c7302015-03-19 13:33:32 +01001627 if (ret < 0) {
1628 return ret;
1629 }
1630 break;
1631 }
1632
1633 /* If there is real non-zero data or we're told to keep the target
1634 * fully allocated (-S 0), we must write it. Otherwise we can treat
1635 * it as zero sectors. */
1636 if (!s->min_sparse ||
1637 is_allocated_sectors_min(buf, n, &n, s->min_sparse))
1638 {
Eric Blake91669202016-05-06 10:26:43 -06001639 ret = blk_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1640 buf, n << BDRV_SECTOR_BITS, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01001641 if (ret < 0) {
1642 return ret;
1643 }
1644 break;
1645 }
1646 /* fall-through */
1647
1648 case BLK_ZERO:
1649 if (s->has_zero_init) {
1650 break;
1651 }
Eric Blaked004bd52016-05-24 16:25:20 -06001652 ret = blk_pwrite_zeroes(s->target, sector_num << BDRV_SECTOR_BITS,
1653 n << BDRV_SECTOR_BITS, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01001654 if (ret < 0) {
1655 return ret;
1656 }
1657 break;
1658 }
1659
1660 sector_num += n;
1661 nb_sectors -= n;
1662 buf += n * BDRV_SECTOR_SIZE;
1663 }
1664
1665 return 0;
1666}
1667
1668static int convert_do_copy(ImgConvertState *s)
1669{
1670 uint8_t *buf = NULL;
1671 int64_t sector_num, allocated_done;
1672 int ret;
1673 int n;
1674
1675 /* Check whether we have zero initialisation or can get it efficiently */
1676 s->has_zero_init = s->min_sparse && !s->target_has_backing
1677 ? bdrv_has_zero_init(blk_bs(s->target))
1678 : false;
1679
1680 if (!s->has_zero_init && !s->target_has_backing &&
1681 bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
1682 {
Kevin Wolf720ff282016-06-16 15:13:15 +02001683 ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP);
Kevin Wolf690c7302015-03-19 13:33:32 +01001684 if (ret == 0) {
1685 s->has_zero_init = true;
1686 }
1687 }
1688
1689 /* Allocate buffer for copied data. For compressed images, only one cluster
1690 * can be copied at a time. */
1691 if (s->compressed) {
1692 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
1693 error_report("invalid cluster size");
1694 ret = -EINVAL;
1695 goto fail;
1696 }
1697 s->buf_sectors = s->cluster_sectors;
1698 }
1699 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1700
1701 /* Calculate allocated sectors for progress */
1702 s->allocated_sectors = 0;
1703 sector_num = 0;
1704 while (sector_num < s->total_sectors) {
1705 n = convert_iteration_sectors(s, sector_num);
1706 if (n < 0) {
1707 ret = n;
1708 goto fail;
1709 }
Max Reitzaad15de2016-03-24 23:33:57 +01001710 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1711 {
Kevin Wolf690c7302015-03-19 13:33:32 +01001712 s->allocated_sectors += n;
1713 }
1714 sector_num += n;
1715 }
1716
1717 /* Do the copy */
1718 s->src_cur = 0;
1719 s->src_cur_offset = 0;
1720 s->sector_next_status = 0;
1721
1722 sector_num = 0;
1723 allocated_done = 0;
1724
1725 while (sector_num < s->total_sectors) {
1726 n = convert_iteration_sectors(s, sector_num);
1727 if (n < 0) {
1728 ret = n;
1729 goto fail;
1730 }
Max Reitzaad15de2016-03-24 23:33:57 +01001731 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1732 {
Kevin Wolf690c7302015-03-19 13:33:32 +01001733 allocated_done += n;
1734 qemu_progress_print(100.0 * allocated_done / s->allocated_sectors,
1735 0);
1736 }
1737
Max Reitzaad15de2016-03-24 23:33:57 +01001738 if (s->status == BLK_DATA) {
1739 ret = convert_read(s, sector_num, n, buf);
1740 if (ret < 0) {
1741 error_report("error while reading sector %" PRId64
1742 ": %s", sector_num, strerror(-ret));
1743 goto fail;
1744 }
1745 } else if (!s->min_sparse && s->status == BLK_ZERO) {
1746 n = MIN(n, s->buf_sectors);
1747 memset(buf, 0, n * BDRV_SECTOR_SIZE);
1748 s->status = BLK_DATA;
Kevin Wolf690c7302015-03-19 13:33:32 +01001749 }
1750
1751 ret = convert_write(s, sector_num, n, buf);
1752 if (ret < 0) {
1753 error_report("error while writing sector %" PRId64
1754 ": %s", sector_num, strerror(-ret));
1755 goto fail;
1756 }
1757
1758 sector_num += n;
1759 }
1760
1761 if (s->compressed) {
1762 /* signal EOF to align */
Pavel Butsykinfe5c1352016-07-22 11:17:40 +03001763 ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
Kevin Wolf690c7302015-03-19 13:33:32 +01001764 if (ret < 0) {
1765 goto fail;
1766 }
1767 }
1768
1769 ret = 0;
1770fail:
1771 qemu_vfree(buf);
1772 return ret;
1773}
1774
bellardea2384d2004-08-01 21:59:26 +00001775static int img_convert(int argc, char **argv)
1776{
Kevin Wolf690c7302015-03-19 13:33:32 +01001777 int c, bs_n, bs_i, compress, cluster_sectors, skip_create;
Peter Lieven13c28af2013-11-27 11:07:01 +01001778 int64_t ret = 0;
Max Reitz40055952014-07-22 22:58:42 +02001779 int progress = 0, flags, src_flags;
Kevin Wolfce099542016-03-15 13:01:04 +01001780 bool writethrough, src_writethrough;
Max Reitz40055952014-07-22 22:58:42 +02001781 const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
MORITA Kazutakab50cbab2010-05-26 11:35:36 +09001782 BlockDriver *drv, *proto_drv;
Markus Armbruster26f54e92014-10-07 13:59:04 +02001783 BlockBackend **blk = NULL, *out_blk = NULL;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001784 BlockDriverState **bs = NULL, *out_bs = NULL;
Kevin Wolf690c7302015-03-19 13:33:32 +01001785 int64_t total_sectors;
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001786 int64_t *bs_sectors = NULL;
Peter Lievenf2521c92013-11-27 11:07:06 +01001787 size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
bellardfaea38e2006-08-05 21:31:00 +00001788 BlockDriverInfo bdi;
Chunyan Liu83d05212014-06-05 17:20:51 +08001789 QemuOpts *opts = NULL;
1790 QemuOptsList *create_opts = NULL;
1791 const char *out_baseimg_param;
Kevin Wolfefa84d42009-05-18 16:42:12 +02001792 char *options = NULL;
edison51ef6722010-09-21 19:58:41 -07001793 const char *snapshot_name = NULL;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001794 int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01001795 bool quiet = false;
Max Reitzcc84d902013-09-06 17:14:26 +02001796 Error *local_err = NULL;
Wenchao Xiaef806542013-12-04 17:10:57 +08001797 QemuOpts *sn_opts = NULL;
Kevin Wolf690c7302015-03-19 13:33:32 +01001798 ImgConvertState state;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001799 bool image_opts = false;
bellardea2384d2004-08-01 21:59:26 +00001800
1801 fmt = NULL;
1802 out_fmt = "raw";
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001803 cache = "unsafe";
Max Reitz40055952014-07-22 22:58:42 +02001804 src_cache = BDRV_DEFAULT_CACHE;
thsf58c7b32008-06-05 21:53:49 +00001805 out_baseimg = NULL;
Jes Sorenseneec77d92010-12-07 17:44:34 +01001806 compress = 0;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01001807 skip_create = 0;
bellardea2384d2004-08-01 21:59:26 +00001808 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001809 static const struct option long_options[] = {
1810 {"help", no_argument, 0, 'h'},
1811 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001812 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001813 {0, 0, 0, 0}
1814 };
1815 c = getopt_long(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qn",
1816 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01001817 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00001818 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01001819 }
bellardea2384d2004-08-01 21:59:26 +00001820 switch(c) {
Jes Sorensenef873942010-12-06 15:25:40 +01001821 case '?':
bellardea2384d2004-08-01 21:59:26 +00001822 case 'h':
1823 help();
1824 break;
1825 case 'f':
1826 fmt = optarg;
1827 break;
1828 case 'O':
1829 out_fmt = optarg;
1830 break;
thsf58c7b32008-06-05 21:53:49 +00001831 case 'B':
1832 out_baseimg = optarg;
1833 break;
bellardea2384d2004-08-01 21:59:26 +00001834 case 'c':
Jes Sorenseneec77d92010-12-07 17:44:34 +01001835 compress = 1;
bellardea2384d2004-08-01 21:59:26 +00001836 break;
1837 case 'e':
Markus Armbruster9d42e152011-06-22 14:03:55 +02001838 error_report("option -e is deprecated, please use \'-o "
Jes Sorenseneec77d92010-12-07 17:44:34 +01001839 "encryption\' instead!");
Kevin Wolf2dc83282014-02-21 16:24:05 +01001840 ret = -1;
Kevin Wolf64bb01a2014-03-03 14:54:07 +01001841 goto fail_getopt;
thsec36ba12007-09-16 21:59:02 +00001842 case '6':
Markus Armbruster9d42e152011-06-22 14:03:55 +02001843 error_report("option -6 is deprecated, please use \'-o "
Jes Sorenseneec77d92010-12-07 17:44:34 +01001844 "compat6\' instead!");
Kevin Wolf2dc83282014-02-21 16:24:05 +01001845 ret = -1;
Kevin Wolf64bb01a2014-03-03 14:54:07 +01001846 goto fail_getopt;
Kevin Wolfefa84d42009-05-18 16:42:12 +02001847 case 'o':
Kevin Wolf2dc83282014-02-21 16:24:05 +01001848 if (!is_valid_option_list(optarg)) {
1849 error_report("Invalid option list: %s", optarg);
1850 ret = -1;
Kevin Wolf64bb01a2014-03-03 14:54:07 +01001851 goto fail_getopt;
Kevin Wolf2dc83282014-02-21 16:24:05 +01001852 }
1853 if (!options) {
1854 options = g_strdup(optarg);
1855 } else {
1856 char *old_options = options;
1857 options = g_strdup_printf("%s,%s", options, optarg);
1858 g_free(old_options);
1859 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02001860 break;
edison51ef6722010-09-21 19:58:41 -07001861 case 's':
1862 snapshot_name = optarg;
1863 break;
Wenchao Xiaef806542013-12-04 17:10:57 +08001864 case 'l':
1865 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
Markus Armbruster70b94332015-02-13 12:50:26 +01001866 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
1867 optarg, false);
Wenchao Xiaef806542013-12-04 17:10:57 +08001868 if (!sn_opts) {
1869 error_report("Failed in parsing snapshot param '%s'",
1870 optarg);
Kevin Wolf2dc83282014-02-21 16:24:05 +01001871 ret = -1;
Kevin Wolf64bb01a2014-03-03 14:54:07 +01001872 goto fail_getopt;
Wenchao Xiaef806542013-12-04 17:10:57 +08001873 }
1874 } else {
1875 snapshot_name = optarg;
1876 }
1877 break;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001878 case 'S':
1879 {
1880 int64_t sval;
Markus Armbruster606caa02017-02-21 21:14:04 +01001881
1882 sval = cvtnum(optarg);
1883 if (sval < 0) {
Kevin Wolfa22f1232011-08-26 15:27:13 +02001884 error_report("Invalid minimum zero buffer size for sparse output specified");
Kevin Wolf2dc83282014-02-21 16:24:05 +01001885 ret = -1;
Kevin Wolf64bb01a2014-03-03 14:54:07 +01001886 goto fail_getopt;
Kevin Wolfa22f1232011-08-26 15:27:13 +02001887 }
1888
1889 min_sparse = sval / BDRV_SECTOR_SIZE;
1890 break;
1891 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02001892 case 'p':
1893 progress = 1;
1894 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04001895 case 't':
1896 cache = optarg;
1897 break;
Max Reitz40055952014-07-22 22:58:42 +02001898 case 'T':
1899 src_cache = optarg;
1900 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01001901 case 'q':
1902 quiet = true;
1903 break;
Alexandre Derumierb2e10492013-09-02 19:07:24 +01001904 case 'n':
1905 skip_create = 1;
1906 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001907 case OPTION_OBJECT:
1908 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1909 optarg, true);
1910 if (!opts) {
1911 goto fail_getopt;
1912 }
1913 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00001914 case OPTION_IMAGE_OPTS:
1915 image_opts = true;
1916 break;
bellardea2384d2004-08-01 21:59:26 +00001917 }
1918 }
ths3b46e622007-09-17 08:09:54 +00001919
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001920 if (qemu_opts_foreach(&qemu_object_opts,
1921 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02001922 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00001923 goto fail_getopt;
1924 }
1925
Kevin Wolf64bb01a2014-03-03 14:54:07 +01001926 /* Initialize before goto out */
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01001927 if (quiet) {
1928 progress = 0;
1929 }
Kevin Wolf64bb01a2014-03-03 14:54:07 +01001930 qemu_progress_init(progress, 1.0);
1931
balrog926c2d22007-10-31 01:11:44 +00001932 bs_n = argc - optind - 1;
Kevin Wolfa283cb62014-02-21 16:24:07 +01001933 out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
thsf58c7b32008-06-05 21:53:49 +00001934
Kevin Wolf2dc83282014-02-21 16:24:05 +01001935 if (options && has_help_option(options)) {
Jes Sorensen4ac8aac2010-12-06 15:25:38 +01001936 ret = print_block_option_help(out_filename, out_fmt);
1937 goto out;
1938 }
1939
bellardea2384d2004-08-01 21:59:26 +00001940 if (bs_n < 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08001941 error_exit("Must specify image file name");
ths5fafdf22007-09-16 21:08:06 +00001942 }
bellardea2384d2004-08-01 21:59:26 +00001943
thsf58c7b32008-06-05 21:53:49 +00001944
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001945 if (bs_n > 1 && out_baseimg) {
Jes Sorensen15654a62010-12-16 14:31:53 +01001946 error_report("-B makes no sense when concatenating multiple input "
1947 "images");
Jes Sorensen31ca34b2010-12-06 15:25:36 +01001948 ret = -1;
1949 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001950 }
Dong Xu Wangf8111c22012-03-15 20:13:31 +08001951
Kevin Wolfce099542016-03-15 13:01:04 +01001952 src_flags = 0;
1953 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
Max Reitz40055952014-07-22 22:58:42 +02001954 if (ret < 0) {
1955 error_report("Invalid source cache option: %s", src_cache);
1956 goto out;
1957 }
1958
Jes Sorensen6b837bc2011-03-30 14:16:25 +02001959 qemu_progress_print(0, 100);
1960
Markus Armbruster26f54e92014-10-07 13:59:04 +02001961 blk = g_new0(BlockBackend *, bs_n);
Markus Armbrusterd739f1c2014-06-26 13:23:24 +02001962 bs = g_new0(BlockDriverState *, bs_n);
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001963 bs_sectors = g_new(int64_t, bs_n);
balrog926c2d22007-10-31 01:11:44 +00001964
1965 total_sectors = 0;
1966 for (bs_i = 0; bs_i < bs_n; bs_i++) {
Max Reitzefaa7c42016-03-16 19:54:38 +01001967 blk[bs_i] = img_open(image_opts, argv[optind + bs_i],
Kevin Wolfce099542016-03-15 13:01:04 +01001968 fmt, src_flags, src_writethrough, quiet);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001969 if (!blk[bs_i]) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09001970 ret = -1;
1971 goto out;
1972 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02001973 bs[bs_i] = blk_bs(blk[bs_i]);
Max Reitzf1d3cd72015-02-05 13:58:18 -05001974 bs_sectors[bs_i] = blk_nb_sectors(blk[bs_i]);
Markus Armbruster52bf1e72014-06-26 13:23:25 +02001975 if (bs_sectors[bs_i] < 0) {
1976 error_report("Could not get size of %s: %s",
1977 argv[optind + bs_i], strerror(-bs_sectors[bs_i]));
1978 ret = -1;
1979 goto out;
1980 }
Markus Armbrusterd739f1c2014-06-26 13:23:24 +02001981 total_sectors += bs_sectors[bs_i];
balrog926c2d22007-10-31 01:11:44 +00001982 }
bellardea2384d2004-08-01 21:59:26 +00001983
Wenchao Xiaef806542013-12-04 17:10:57 +08001984 if (sn_opts) {
Peter Maydell10d6eda2017-02-10 16:28:24 +00001985 bdrv_snapshot_load_tmp(bs[0],
1986 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
1987 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
1988 &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08001989 } else if (snapshot_name != NULL) {
edison51ef6722010-09-21 19:58:41 -07001990 if (bs_n > 1) {
Markus Armbruster6daf1942011-06-22 14:03:54 +02001991 error_report("No support for concatenating multiple snapshot");
edison51ef6722010-09-21 19:58:41 -07001992 ret = -1;
1993 goto out;
1994 }
Wenchao Xia7b4c4782013-12-04 17:10:54 +08001995
1996 bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
Wenchao Xiaef806542013-12-04 17:10:57 +08001997 }
Markus Armbruster84d18f02014-01-30 15:07:28 +01001998 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01001999 error_reportf_err(local_err, "Failed to load snapshot: ");
Wenchao Xiaef806542013-12-04 17:10:57 +08002000 ret = -1;
2001 goto out;
edison51ef6722010-09-21 19:58:41 -07002002 }
2003
Kevin Wolfefa84d42009-05-18 16:42:12 +02002004 /* Find driver and parse its options */
bellardea2384d2004-08-01 21:59:26 +00002005 drv = bdrv_find_format(out_fmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002006 if (!drv) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002007 error_report("Unknown file format '%s'", out_fmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002008 ret = -1;
2009 goto out;
2010 }
balrog926c2d22007-10-31 01:11:44 +00002011
Max Reitzb65a5e12015-02-05 13:58:12 -05002012 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002013 if (!proto_drv) {
Markus Armbruster2867ce42015-03-12 16:08:02 +01002014 error_report_err(local_err);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002015 ret = -1;
2016 goto out;
2017 }
MORITA Kazutakab50cbab2010-05-26 11:35:36 +09002018
Max Reitz2e024cd2015-02-11 09:58:46 -05002019 if (!skip_create) {
2020 if (!drv->create_opts) {
2021 error_report("Format driver '%s' does not support image creation",
2022 drv->format_name);
2023 ret = -1;
2024 goto out;
2025 }
Max Reitzf75613c2014-12-02 18:32:46 +01002026
Max Reitz2e024cd2015-02-11 09:58:46 -05002027 if (!proto_drv->create_opts) {
2028 error_report("Protocol driver '%s' does not support image creation",
2029 proto_drv->format_name);
2030 ret = -1;
2031 goto out;
2032 }
Max Reitzf75613c2014-12-02 18:32:46 +01002033
Max Reitz2e024cd2015-02-11 09:58:46 -05002034 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2035 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
Kevin Wolfdb08adf2009-06-04 15:39:38 +02002036
Max Reitz2e024cd2015-02-11 09:58:46 -05002037 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002038 if (options) {
2039 qemu_opts_do_parse(opts, options, NULL, &local_err);
2040 if (local_err) {
Markus Armbruster97a2ca72015-03-14 10:23:15 +01002041 error_report_err(local_err);
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01002042 ret = -1;
2043 goto out;
2044 }
Max Reitz2e024cd2015-02-11 09:58:46 -05002045 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002046
Markus Armbruster39101f22015-02-12 16:46:36 +01002047 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512,
2048 &error_abort);
Max Reitz2e024cd2015-02-11 09:58:46 -05002049 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2050 if (ret < 0) {
2051 goto out;
2052 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002053 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002054
Kevin Wolfa18953f2010-10-14 15:46:04 +02002055 /* Get backing file name if -o backing_file was used */
Chunyan Liu83d05212014-06-05 17:20:51 +08002056 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
Kevin Wolfa18953f2010-10-14 15:46:04 +02002057 if (out_baseimg_param) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002058 out_baseimg = out_baseimg_param;
Kevin Wolfa18953f2010-10-14 15:46:04 +02002059 }
2060
Kevin Wolfefa84d42009-05-18 16:42:12 +02002061 /* Check if compression is supported */
Jes Sorenseneec77d92010-12-07 17:44:34 +01002062 if (compress) {
Chunyan Liu83d05212014-06-05 17:20:51 +08002063 bool encryption =
2064 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2065 const char *preallocation =
2066 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
Kevin Wolfefa84d42009-05-18 16:42:12 +02002067
Pavel Butsykin35fadca2016-07-22 11:17:48 +03002068 if (!drv->bdrv_co_pwritev_compressed) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002069 error_report("Compression not supported for this file format");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002070 ret = -1;
2071 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002072 }
2073
Chunyan Liu83d05212014-06-05 17:20:51 +08002074 if (encryption) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002075 error_report("Compression and encryption not supported at "
2076 "the same time");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002077 ret = -1;
2078 goto out;
Kevin Wolfefa84d42009-05-18 16:42:12 +02002079 }
Kevin Wolf41521fa2011-10-18 16:19:42 +02002080
Chunyan Liu83d05212014-06-05 17:20:51 +08002081 if (preallocation
2082 && strcmp(preallocation, "off"))
Kevin Wolf41521fa2011-10-18 16:19:42 +02002083 {
2084 error_report("Compression and preallocation not supported at "
2085 "the same time");
2086 ret = -1;
2087 goto out;
2088 }
Kevin Wolfefa84d42009-05-18 16:42:12 +02002089 }
2090
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002091 if (!skip_create) {
2092 /* Create the new image */
Chunyan Liuc282e1f2014-06-05 17:21:11 +08002093 ret = bdrv_create(drv, out_filename, opts, &local_err);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002094 if (ret < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002095 error_reportf_err(local_err, "%s: error while converting %s: ",
2096 out_filename, out_fmt);
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002097 goto out;
bellardea2384d2004-08-01 21:59:26 +00002098 }
2099 }
ths3b46e622007-09-17 08:09:54 +00002100
Peter Lieven5a37b602013-10-24 12:07:06 +02002101 flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
Kevin Wolfce099542016-03-15 13:01:04 +01002102 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002103 if (ret < 0) {
2104 error_report("Invalid cache option: %s", cache);
Markus Armbrusterbb9cd2e2014-05-28 11:17:07 +02002105 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002106 }
2107
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002108 /* XXX we should allow --image-opts to trigger use of
2109 * img_open() here, but then we have trouble with
2110 * the bdrv_create() call which takes different params.
2111 * Not critical right now, so fix can wait...
2112 */
Kevin Wolfce099542016-03-15 13:01:04 +01002113 out_blk = img_open_file(out_filename, out_fmt, flags, writethrough, quiet);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002114 if (!out_blk) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002115 ret = -1;
2116 goto out;
2117 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002118 out_bs = blk_bs(out_blk);
bellardea2384d2004-08-01 21:59:26 +00002119
Eric Blake5def6b82016-06-23 16:37:19 -06002120 /* increase bufsectors from the default 4096 (2M) if opt_transfer
Peter Lievenf2521c92013-11-27 11:07:06 +01002121 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2122 * as maximum. */
2123 bufsectors = MIN(32768,
Eric Blake5def6b82016-06-23 16:37:19 -06002124 MAX(bufsectors,
2125 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
Eric Blakeb9f78552016-06-23 16:37:21 -06002126 out_bs->bl.pdiscard_alignment >>
2127 BDRV_SECTOR_BITS)));
Peter Lievenf2521c92013-11-27 11:07:06 +01002128
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002129 if (skip_create) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05002130 int64_t output_sectors = blk_nb_sectors(out_blk);
Markus Armbruster43716fa2014-06-26 13:23:21 +02002131 if (output_sectors < 0) {
Gongleieec5eb42015-02-25 12:22:27 +08002132 error_report("unable to get output image length: %s",
Markus Armbruster43716fa2014-06-26 13:23:21 +02002133 strerror(-output_sectors));
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002134 ret = -1;
2135 goto out;
Markus Armbruster43716fa2014-06-26 13:23:21 +02002136 } else if (output_sectors < total_sectors) {
Alexandre Derumierb2e10492013-09-02 19:07:24 +01002137 error_report("output file is smaller than input file");
2138 ret = -1;
2139 goto out;
2140 }
2141 }
2142
Peter Lieven24f833c2013-11-27 11:07:07 +01002143 cluster_sectors = 0;
2144 ret = bdrv_get_info(out_bs, &bdi);
2145 if (ret < 0) {
2146 if (compress) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002147 error_report("could not get block driver info");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002148 goto out;
2149 }
Peter Lieven24f833c2013-11-27 11:07:07 +01002150 } else {
Fam Zheng85f49ca2014-05-06 21:08:43 +08002151 compress = compress || bdi.needs_compressed_writes;
Peter Lieven24f833c2013-11-27 11:07:07 +01002152 cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2153 }
2154
Kevin Wolf690c7302015-03-19 13:33:32 +01002155 state = (ImgConvertState) {
2156 .src = blk,
2157 .src_sectors = bs_sectors,
2158 .src_num = bs_n,
2159 .total_sectors = total_sectors,
2160 .target = out_blk,
2161 .compressed = compress,
2162 .target_has_backing = (bool) out_baseimg,
2163 .min_sparse = min_sparse,
2164 .cluster_sectors = cluster_sectors,
2165 .buf_sectors = bufsectors,
2166 };
2167 ret = convert_do_copy(&state);
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002168
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002169out:
Peter Lieven13c28af2013-11-27 11:07:01 +01002170 if (!ret) {
2171 qemu_progress_print(100, 0);
2172 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002173 qemu_progress_end();
Chunyan Liu83d05212014-06-05 17:20:51 +08002174 qemu_opts_del(opts);
2175 qemu_opts_free(create_opts);
Markus Armbrusterfbf28a42014-09-29 16:07:55 +02002176 qemu_opts_del(sn_opts);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002177 blk_unref(out_blk);
Markus Armbruster9ba10c92014-10-07 13:59:08 +02002178 g_free(bs);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002179 if (blk) {
2180 for (bs_i = 0; bs_i < bs_n; bs_i++) {
2181 blk_unref(blk[bs_i]);
2182 }
2183 g_free(blk);
2184 }
Markus Armbrusterd739f1c2014-06-26 13:23:24 +02002185 g_free(bs_sectors);
Kevin Wolf64bb01a2014-03-03 14:54:07 +01002186fail_getopt:
2187 g_free(options);
2188
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002189 if (ret) {
2190 return 1;
2191 }
bellardea2384d2004-08-01 21:59:26 +00002192 return 0;
2193}
2194
bellard57d1a2b2004-08-03 21:15:11 +00002195
bellardfaea38e2006-08-05 21:31:00 +00002196static void dump_snapshots(BlockDriverState *bs)
2197{
2198 QEMUSnapshotInfo *sn_tab, *sn;
2199 int nb_sns, i;
bellardfaea38e2006-08-05 21:31:00 +00002200
2201 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2202 if (nb_sns <= 0)
2203 return;
2204 printf("Snapshot list:\n");
Wenchao Xia5b917042013-05-25 11:09:45 +08002205 bdrv_snapshot_dump(fprintf, stdout, NULL);
2206 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002207 for(i = 0; i < nb_sns; i++) {
2208 sn = &sn_tab[i];
Wenchao Xia5b917042013-05-25 11:09:45 +08002209 bdrv_snapshot_dump(fprintf, stdout, sn);
2210 printf("\n");
bellardfaea38e2006-08-05 21:31:00 +00002211 }
Anthony Liguori7267c092011-08-20 22:09:37 -05002212 g_free(sn_tab);
bellardfaea38e2006-08-05 21:31:00 +00002213}
2214
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002215static void dump_json_image_info_list(ImageInfoList *list)
2216{
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002217 QString *str;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002218 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002219 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002220
2221 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2222 visit_complete(v, &obj);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002223 str = qobject_to_json_pretty(obj);
2224 assert(str != NULL);
2225 printf("%s\n", qstring_get_str(str));
2226 qobject_decref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002227 visit_free(v);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002228 QDECREF(str);
2229}
2230
Benoît Canetc054b3f2012-09-05 13:09:02 +02002231static void dump_json_image_info(ImageInfo *info)
2232{
Benoît Canetc054b3f2012-09-05 13:09:02 +02002233 QString *str;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002234 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01002235 Visitor *v = qobject_output_visitor_new(&obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002236
2237 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2238 visit_complete(v, &obj);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002239 str = qobject_to_json_pretty(obj);
2240 assert(str != NULL);
2241 printf("%s\n", qstring_get_str(str));
2242 qobject_decref(obj);
Eric Blake3b098d52016-06-09 10:48:43 -06002243 visit_free(v);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002244 QDECREF(str);
2245}
2246
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002247static void dump_human_image_info_list(ImageInfoList *list)
2248{
2249 ImageInfoList *elem;
2250 bool delim = false;
2251
2252 for (elem = list; elem; elem = elem->next) {
2253 if (delim) {
2254 printf("\n");
2255 }
2256 delim = true;
2257
Wenchao Xia5b917042013-05-25 11:09:45 +08002258 bdrv_image_info_dump(fprintf, stdout, elem->value);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002259 }
2260}
2261
2262static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2263{
2264 return strcmp(a, b) == 0;
2265}
2266
2267/**
2268 * Open an image file chain and return an ImageInfoList
2269 *
2270 * @filename: topmost image filename
2271 * @fmt: topmost image format (may be NULL to autodetect)
2272 * @chain: true - enumerate entire backing file chain
2273 * false - only topmost image file
2274 *
2275 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2276 * image file. If there was an error a message will have been printed to
2277 * stderr.
2278 */
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002279static ImageInfoList *collect_image_info_list(bool image_opts,
2280 const char *filename,
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002281 const char *fmt,
2282 bool chain)
2283{
2284 ImageInfoList *head = NULL;
2285 ImageInfoList **last = &head;
2286 GHashTable *filenames;
Wenchao Xia43526ec2013-06-06 12:27:58 +08002287 Error *err = NULL;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002288
2289 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2290
2291 while (filename) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02002292 BlockBackend *blk;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002293 BlockDriverState *bs;
2294 ImageInfo *info;
2295 ImageInfoList *elem;
2296
2297 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2298 error_report("Backing file '%s' creates an infinite loop.",
2299 filename);
2300 goto err;
2301 }
2302 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2303
Max Reitzefaa7c42016-03-16 19:54:38 +01002304 blk = img_open(image_opts, filename, fmt,
Kevin Wolfce099542016-03-15 13:01:04 +01002305 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002306 if (!blk) {
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002307 goto err;
2308 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002309 bs = blk_bs(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002310
Wenchao Xia43526ec2013-06-06 12:27:58 +08002311 bdrv_query_image_info(bs, &info, &err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002312 if (err) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01002313 error_report_err(err);
Markus Armbruster26f54e92014-10-07 13:59:04 +02002314 blk_unref(blk);
Wenchao Xia43526ec2013-06-06 12:27:58 +08002315 goto err;
Wenchao Xiafb0ed452013-06-06 12:27:57 +08002316 }
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002317
2318 elem = g_new0(ImageInfoList, 1);
2319 elem->value = info;
2320 *last = elem;
2321 last = &elem->next;
2322
Markus Armbruster26f54e92014-10-07 13:59:04 +02002323 blk_unref(blk);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002324
2325 filename = fmt = NULL;
2326 if (chain) {
2327 if (info->has_full_backing_filename) {
2328 filename = info->full_backing_filename;
2329 } else if (info->has_backing_filename) {
John Snow92d617a2015-12-14 14:55:15 -05002330 error_report("Could not determine absolute backing filename,"
2331 " but backing filename '%s' present",
2332 info->backing_filename);
2333 goto err;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002334 }
2335 if (info->has_backing_filename_format) {
2336 fmt = info->backing_filename_format;
2337 }
2338 }
2339 }
2340 g_hash_table_destroy(filenames);
2341 return head;
2342
2343err:
2344 qapi_free_ImageInfoList(head);
2345 g_hash_table_destroy(filenames);
2346 return NULL;
2347}
2348
Benoît Canetc054b3f2012-09-05 13:09:02 +02002349static int img_info(int argc, char **argv)
2350{
2351 int c;
2352 OutputFormat output_format = OFORMAT_HUMAN;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002353 bool chain = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002354 const char *filename, *fmt, *output;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002355 ImageInfoList *list;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002356 bool image_opts = false;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002357
bellardea2384d2004-08-01 21:59:26 +00002358 fmt = NULL;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002359 output = NULL;
bellardea2384d2004-08-01 21:59:26 +00002360 for(;;) {
Benoît Canetc054b3f2012-09-05 13:09:02 +02002361 int option_index = 0;
2362 static const struct option long_options[] = {
2363 {"help", no_argument, 0, 'h'},
2364 {"format", required_argument, 0, 'f'},
2365 {"output", required_argument, 0, OPTION_OUTPUT},
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002366 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002367 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002368 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Benoît Canetc054b3f2012-09-05 13:09:02 +02002369 {0, 0, 0, 0}
2370 };
2371 c = getopt_long(argc, argv, "f:h",
2372 long_options, &option_index);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002373 if (c == -1) {
bellardea2384d2004-08-01 21:59:26 +00002374 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002375 }
bellardea2384d2004-08-01 21:59:26 +00002376 switch(c) {
Jes Sorensenef873942010-12-06 15:25:40 +01002377 case '?':
bellardea2384d2004-08-01 21:59:26 +00002378 case 'h':
2379 help();
2380 break;
2381 case 'f':
2382 fmt = optarg;
2383 break;
Benoît Canetc054b3f2012-09-05 13:09:02 +02002384 case OPTION_OUTPUT:
2385 output = optarg;
2386 break;
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002387 case OPTION_BACKING_CHAIN:
2388 chain = true;
2389 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002390 case OPTION_OBJECT: {
2391 QemuOpts *opts;
2392 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2393 optarg, true);
2394 if (!opts) {
2395 return 1;
2396 }
2397 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002398 case OPTION_IMAGE_OPTS:
2399 image_opts = true;
2400 break;
bellardea2384d2004-08-01 21:59:26 +00002401 }
2402 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02002403 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08002404 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002405 }
bellardea2384d2004-08-01 21:59:26 +00002406 filename = argv[optind++];
2407
Benoît Canetc054b3f2012-09-05 13:09:02 +02002408 if (output && !strcmp(output, "json")) {
2409 output_format = OFORMAT_JSON;
2410 } else if (output && !strcmp(output, "human")) {
2411 output_format = OFORMAT_HUMAN;
2412 } else if (output) {
2413 error_report("--output must be used with human or json as argument.");
2414 return 1;
2415 }
2416
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002417 if (qemu_opts_foreach(&qemu_object_opts,
2418 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02002419 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002420 return 1;
2421 }
2422
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002423 list = collect_image_info_list(image_opts, filename, fmt, chain);
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002424 if (!list) {
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002425 return 1;
2426 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002427
Benoît Canetc054b3f2012-09-05 13:09:02 +02002428 switch (output_format) {
2429 case OFORMAT_HUMAN:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002430 dump_human_image_info_list(list);
Benoît Canetc054b3f2012-09-05 13:09:02 +02002431 break;
2432 case OFORMAT_JSON:
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002433 if (chain) {
2434 dump_json_image_info_list(list);
2435 } else {
2436 dump_json_image_info(list->value);
2437 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002438 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002439 }
Benoît Canetc054b3f2012-09-05 13:09:02 +02002440
Stefan Hajnoczi9699bf02012-10-17 14:02:31 +02002441 qapi_free_ImageInfoList(list);
bellardea2384d2004-08-01 21:59:26 +00002442 return 0;
2443}
2444
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002445static void dump_map_entry(OutputFormat output_format, MapEntry *e,
2446 MapEntry *next)
2447{
2448 switch (output_format) {
2449 case OFORMAT_HUMAN:
Fam Zheng16b0d552016-01-26 11:59:02 +08002450 if (e->data && !e->has_offset) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002451 error_report("File contains external, encrypted or compressed clusters.");
2452 exit(1);
2453 }
Fam Zheng16b0d552016-01-26 11:59:02 +08002454 if (e->data && !e->zero) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002455 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
Fam Zheng16b0d552016-01-26 11:59:02 +08002456 e->start, e->length,
2457 e->has_offset ? e->offset : 0,
2458 e->has_filename ? e->filename : "");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002459 }
2460 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2461 * Modify the flags here to allow more coalescing.
2462 */
Fam Zheng16b0d552016-01-26 11:59:02 +08002463 if (next && (!next->data || next->zero)) {
2464 next->data = false;
2465 next->zero = true;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002466 }
2467 break;
2468 case OFORMAT_JSON:
Fam Zheng16b0d552016-01-26 11:59:02 +08002469 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
2470 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002471 (e->start == 0 ? "[" : ",\n"),
2472 e->start, e->length, e->depth,
Fam Zheng16b0d552016-01-26 11:59:02 +08002473 e->zero ? "true" : "false",
2474 e->data ? "true" : "false");
2475 if (e->has_offset) {
Paolo Bonzinic745bfb2013-09-11 18:47:52 +02002476 printf(", \"offset\": %"PRId64"", e->offset);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002477 }
2478 putchar('}');
2479
2480 if (!next) {
2481 printf("]\n");
2482 }
2483 break;
2484 }
2485}
2486
2487static int get_block_status(BlockDriverState *bs, int64_t sector_num,
2488 int nb_sectors, MapEntry *e)
2489{
2490 int64_t ret;
2491 int depth;
Fam Zheng67a0fd22016-01-26 11:58:48 +08002492 BlockDriverState *file;
John Snow28756452016-02-05 13:12:33 -05002493 bool has_offset;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002494
2495 /* As an optimization, we could cache the current range of unallocated
2496 * clusters in each file of the chain, and avoid querying the same
2497 * range repeatedly.
2498 */
2499
2500 depth = 0;
2501 for (;;) {
Fam Zheng67a0fd22016-01-26 11:58:48 +08002502 ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
2503 &file);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002504 if (ret < 0) {
2505 return ret;
2506 }
2507 assert(nb_sectors);
2508 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2509 break;
2510 }
Kevin Wolf760e0062015-06-17 14:55:21 +02002511 bs = backing_bs(bs);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002512 if (bs == NULL) {
2513 ret = 0;
2514 break;
2515 }
2516
2517 depth++;
2518 }
2519
John Snow28756452016-02-05 13:12:33 -05002520 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
2521
2522 *e = (MapEntry) {
2523 .start = sector_num * BDRV_SECTOR_SIZE,
2524 .length = nb_sectors * BDRV_SECTOR_SIZE,
2525 .data = !!(ret & BDRV_BLOCK_DATA),
2526 .zero = !!(ret & BDRV_BLOCK_ZERO),
2527 .offset = ret & BDRV_BLOCK_OFFSET_MASK,
2528 .has_offset = has_offset,
2529 .depth = depth,
2530 .has_filename = file && has_offset,
2531 .filename = file && has_offset ? file->filename : NULL,
2532 };
2533
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002534 return 0;
2535}
2536
Fam Zheng16b0d552016-01-26 11:59:02 +08002537static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
2538{
2539 if (curr->length == 0) {
2540 return false;
2541 }
2542 if (curr->zero != next->zero ||
2543 curr->data != next->data ||
2544 curr->depth != next->depth ||
2545 curr->has_filename != next->has_filename ||
2546 curr->has_offset != next->has_offset) {
2547 return false;
2548 }
2549 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
2550 return false;
2551 }
2552 if (curr->has_offset && curr->offset + curr->length != next->offset) {
2553 return false;
2554 }
2555 return true;
2556}
2557
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002558static int img_map(int argc, char **argv)
2559{
2560 int c;
2561 OutputFormat output_format = OFORMAT_HUMAN;
Markus Armbruster26f54e92014-10-07 13:59:04 +02002562 BlockBackend *blk;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002563 BlockDriverState *bs;
2564 const char *filename, *fmt, *output;
2565 int64_t length;
2566 MapEntry curr = { .length = 0 }, next;
2567 int ret = 0;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002568 bool image_opts = false;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002569
2570 fmt = NULL;
2571 output = NULL;
2572 for (;;) {
2573 int option_index = 0;
2574 static const struct option long_options[] = {
2575 {"help", no_argument, 0, 'h'},
2576 {"format", required_argument, 0, 'f'},
2577 {"output", required_argument, 0, OPTION_OUTPUT},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002578 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002579 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002580 {0, 0, 0, 0}
2581 };
2582 c = getopt_long(argc, argv, "f:h",
2583 long_options, &option_index);
2584 if (c == -1) {
2585 break;
2586 }
2587 switch (c) {
2588 case '?':
2589 case 'h':
2590 help();
2591 break;
2592 case 'f':
2593 fmt = optarg;
2594 break;
2595 case OPTION_OUTPUT:
2596 output = optarg;
2597 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002598 case OPTION_OBJECT: {
2599 QemuOpts *opts;
2600 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2601 optarg, true);
2602 if (!opts) {
2603 return 1;
2604 }
2605 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002606 case OPTION_IMAGE_OPTS:
2607 image_opts = true;
2608 break;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002609 }
2610 }
Fam Zhengac1307a2014-04-22 13:36:11 +08002611 if (optind != argc - 1) {
2612 error_exit("Expecting one image file name");
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002613 }
Fam Zhengac1307a2014-04-22 13:36:11 +08002614 filename = argv[optind];
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002615
2616 if (output && !strcmp(output, "json")) {
2617 output_format = OFORMAT_JSON;
2618 } else if (output && !strcmp(output, "human")) {
2619 output_format = OFORMAT_HUMAN;
2620 } else if (output) {
2621 error_report("--output must be used with human or json as argument.");
2622 return 1;
2623 }
2624
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002625 if (qemu_opts_foreach(&qemu_object_opts,
2626 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02002627 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002628 return 1;
2629 }
2630
Kevin Wolfce099542016-03-15 13:01:04 +01002631 blk = img_open(image_opts, filename, fmt, 0, false, false);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002632 if (!blk) {
2633 return 1;
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002634 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002635 bs = blk_bs(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002636
2637 if (output_format == OFORMAT_HUMAN) {
2638 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2639 }
2640
Max Reitzf1d3cd72015-02-05 13:58:18 -05002641 length = blk_getlength(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002642 while (curr.start + curr.length < length) {
2643 int64_t nsectors_left;
2644 int64_t sector_num;
2645 int n;
2646
2647 sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;
2648
2649 /* Probe up to 1 GiB at a time. */
2650 nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
2651 n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
2652 ret = get_block_status(bs, sector_num, n, &next);
2653
2654 if (ret < 0) {
2655 error_report("Could not read file metadata: %s", strerror(-ret));
2656 goto out;
2657 }
2658
Fam Zheng16b0d552016-01-26 11:59:02 +08002659 if (entry_mergeable(&curr, &next)) {
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002660 curr.length += next.length;
2661 continue;
2662 }
2663
2664 if (curr.length > 0) {
2665 dump_map_entry(output_format, &curr, &next);
2666 }
2667 curr = next;
2668 }
2669
2670 dump_map_entry(output_format, &curr, NULL);
2671
2672out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02002673 blk_unref(blk);
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +02002674 return ret < 0;
2675}
2676
aliguorif7b4a942009-01-07 17:40:15 +00002677#define SNAPSHOT_LIST 1
2678#define SNAPSHOT_CREATE 2
2679#define SNAPSHOT_APPLY 3
2680#define SNAPSHOT_DELETE 4
2681
Stuart Brady153859b2009-06-07 00:42:17 +01002682static int img_snapshot(int argc, char **argv)
aliguorif7b4a942009-01-07 17:40:15 +00002683{
Markus Armbruster26f54e92014-10-07 13:59:04 +02002684 BlockBackend *blk;
aliguorif7b4a942009-01-07 17:40:15 +00002685 BlockDriverState *bs;
2686 QEMUSnapshotInfo sn;
2687 char *filename, *snapshot_name = NULL;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002688 int c, ret = 0, bdrv_oflags;
aliguorif7b4a942009-01-07 17:40:15 +00002689 int action = 0;
2690 qemu_timeval tv;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002691 bool quiet = false;
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08002692 Error *err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002693 bool image_opts = false;
aliguorif7b4a942009-01-07 17:40:15 +00002694
Kevin Wolfce099542016-03-15 13:01:04 +01002695 bdrv_oflags = BDRV_O_RDWR;
aliguorif7b4a942009-01-07 17:40:15 +00002696 /* Parse commandline parameters */
2697 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002698 static const struct option long_options[] = {
2699 {"help", no_argument, 0, 'h'},
2700 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002701 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002702 {0, 0, 0, 0}
2703 };
2704 c = getopt_long(argc, argv, "la:c:d:hq",
2705 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002706 if (c == -1) {
aliguorif7b4a942009-01-07 17:40:15 +00002707 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002708 }
aliguorif7b4a942009-01-07 17:40:15 +00002709 switch(c) {
Jes Sorensenef873942010-12-06 15:25:40 +01002710 case '?':
aliguorif7b4a942009-01-07 17:40:15 +00002711 case 'h':
2712 help();
Stuart Brady153859b2009-06-07 00:42:17 +01002713 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00002714 case 'l':
2715 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08002716 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01002717 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00002718 }
2719 action = SNAPSHOT_LIST;
Naphtali Spreif5edb012010-01-17 16:48:13 +02002720 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
aliguorif7b4a942009-01-07 17:40:15 +00002721 break;
2722 case 'a':
2723 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08002724 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01002725 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00002726 }
2727 action = SNAPSHOT_APPLY;
2728 snapshot_name = optarg;
2729 break;
2730 case 'c':
2731 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08002732 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01002733 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00002734 }
2735 action = SNAPSHOT_CREATE;
2736 snapshot_name = optarg;
2737 break;
2738 case 'd':
2739 if (action) {
Fam Zhengac1307a2014-04-22 13:36:11 +08002740 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
Stuart Brady153859b2009-06-07 00:42:17 +01002741 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00002742 }
2743 action = SNAPSHOT_DELETE;
2744 snapshot_name = optarg;
2745 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002746 case 'q':
2747 quiet = true;
2748 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002749 case OPTION_OBJECT: {
2750 QemuOpts *opts;
2751 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2752 optarg, true);
2753 if (!opts) {
2754 return 1;
2755 }
2756 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002757 case OPTION_IMAGE_OPTS:
2758 image_opts = true;
2759 break;
aliguorif7b4a942009-01-07 17:40:15 +00002760 }
2761 }
2762
Kevin Wolffc11eb22013-08-05 10:53:04 +02002763 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08002764 error_exit("Expecting one image file name");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002765 }
aliguorif7b4a942009-01-07 17:40:15 +00002766 filename = argv[optind++];
2767
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002768 if (qemu_opts_foreach(&qemu_object_opts,
2769 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02002770 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002771 return 1;
2772 }
2773
aliguorif7b4a942009-01-07 17:40:15 +00002774 /* Open the image */
Kevin Wolfce099542016-03-15 13:01:04 +01002775 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002776 if (!blk) {
2777 return 1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002778 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002779 bs = blk_bs(blk);
aliguorif7b4a942009-01-07 17:40:15 +00002780
2781 /* Perform the requested action */
2782 switch(action) {
2783 case SNAPSHOT_LIST:
2784 dump_snapshots(bs);
2785 break;
2786
2787 case SNAPSHOT_CREATE:
2788 memset(&sn, 0, sizeof(sn));
2789 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
2790
2791 qemu_gettimeofday(&tv);
2792 sn.date_sec = tv.tv_sec;
2793 sn.date_nsec = tv.tv_usec * 1000;
2794
2795 ret = bdrv_snapshot_create(bs, &sn);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002796 if (ret) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002797 error_report("Could not create snapshot '%s': %d (%s)",
aliguorif7b4a942009-01-07 17:40:15 +00002798 snapshot_name, ret, strerror(-ret));
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002799 }
aliguorif7b4a942009-01-07 17:40:15 +00002800 break;
2801
2802 case SNAPSHOT_APPLY:
2803 ret = bdrv_snapshot_goto(bs, snapshot_name);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002804 if (ret) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002805 error_report("Could not apply snapshot '%s': %d (%s)",
aliguorif7b4a942009-01-07 17:40:15 +00002806 snapshot_name, ret, strerror(-ret));
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002807 }
aliguorif7b4a942009-01-07 17:40:15 +00002808 break;
2809
2810 case SNAPSHOT_DELETE:
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08002811 bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002812 if (err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002813 error_reportf_err(err, "Could not delete snapshot '%s': ",
2814 snapshot_name);
Wenchao Xiaa89d89d2013-09-11 14:04:33 +08002815 ret = 1;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002816 }
aliguorif7b4a942009-01-07 17:40:15 +00002817 break;
2818 }
2819
2820 /* Cleanup */
Markus Armbruster26f54e92014-10-07 13:59:04 +02002821 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002822 if (ret) {
2823 return 1;
2824 }
Stuart Brady153859b2009-06-07 00:42:17 +01002825 return 0;
aliguorif7b4a942009-01-07 17:40:15 +00002826}
2827
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002828static int img_rebase(int argc, char **argv)
2829{
Markus Armbruster26f54e92014-10-07 13:59:04 +02002830 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
Paolo Bonzini396374c2016-02-25 23:53:54 +01002831 uint8_t *buf_old = NULL;
2832 uint8_t *buf_new = NULL;
Max Reitzf1d3cd72015-02-05 13:58:18 -05002833 BlockDriverState *bs = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002834 char *filename;
Max Reitz40055952014-07-22 22:58:42 +02002835 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
2836 int c, flags, src_flags, ret;
Kevin Wolfce099542016-03-15 13:01:04 +01002837 bool writethrough, src_writethrough;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002838 int unsafe = 0;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002839 int progress = 0;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002840 bool quiet = false;
Max Reitz34b5d2c2013-09-05 14:45:29 +02002841 Error *local_err = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002842 bool image_opts = false;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002843
2844 /* Parse commandline parameters */
Kevin Wolfe53dbee2010-03-02 12:14:31 +01002845 fmt = NULL;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002846 cache = BDRV_DEFAULT_CACHE;
Max Reitz40055952014-07-22 22:58:42 +02002847 src_cache = BDRV_DEFAULT_CACHE;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002848 out_baseimg = NULL;
2849 out_basefmt = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002850 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002851 static const struct option long_options[] = {
2852 {"help", no_argument, 0, 'h'},
2853 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002854 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002855 {0, 0, 0, 0}
2856 };
2857 c = getopt_long(argc, argv, "hf:F:b:upt:T:q",
2858 long_options, NULL);
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002859 if (c == -1) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002860 break;
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002861 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002862 switch(c) {
Jes Sorensenef873942010-12-06 15:25:40 +01002863 case '?':
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002864 case 'h':
2865 help();
2866 return 0;
Kevin Wolfe53dbee2010-03-02 12:14:31 +01002867 case 'f':
2868 fmt = optarg;
2869 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002870 case 'F':
2871 out_basefmt = optarg;
2872 break;
2873 case 'b':
2874 out_baseimg = optarg;
2875 break;
2876 case 'u':
2877 unsafe = 1;
2878 break;
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002879 case 'p':
2880 progress = 1;
2881 break;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002882 case 't':
2883 cache = optarg;
2884 break;
Max Reitz40055952014-07-22 22:58:42 +02002885 case 'T':
2886 src_cache = optarg;
2887 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002888 case 'q':
2889 quiet = true;
2890 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002891 case OPTION_OBJECT: {
2892 QemuOpts *opts;
2893 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2894 optarg, true);
2895 if (!opts) {
2896 return 1;
2897 }
2898 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00002899 case OPTION_IMAGE_OPTS:
2900 image_opts = true;
2901 break;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002902 }
2903 }
2904
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01002905 if (quiet) {
2906 progress = 0;
2907 }
2908
Fam Zhengac1307a2014-04-22 13:36:11 +08002909 if (optind != argc - 1) {
2910 error_exit("Expecting one image file name");
2911 }
2912 if (!unsafe && !out_baseimg) {
2913 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
Jes Sorensenb8fb60d2010-12-06 15:25:39 +01002914 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002915 filename = argv[optind++];
2916
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002917 if (qemu_opts_foreach(&qemu_object_opts,
2918 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02002919 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00002920 return 1;
2921 }
2922
Jes Sorensen6b837bc2011-03-30 14:16:25 +02002923 qemu_progress_init(progress, 2.0);
2924 qemu_progress_print(0, 100);
2925
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002926 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
Kevin Wolfce099542016-03-15 13:01:04 +01002927 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002928 if (ret < 0) {
2929 error_report("Invalid cache option: %s", cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01002930 goto out;
Federico Simoncelli661a0f72011-06-20 12:48:19 -04002931 }
2932
Kevin Wolfce099542016-03-15 13:01:04 +01002933 src_flags = 0;
2934 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
Max Reitz40055952014-07-22 22:58:42 +02002935 if (ret < 0) {
2936 error_report("Invalid source cache option: %s", src_cache);
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01002937 goto out;
Max Reitz40055952014-07-22 22:58:42 +02002938 }
2939
Kevin Wolfce099542016-03-15 13:01:04 +01002940 /* The source files are opened read-only, don't care about WCE */
2941 assert((src_flags & BDRV_O_RDWR) == 0);
2942 (void) src_writethrough;
2943
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002944 /*
2945 * Open the images.
2946 *
2947 * Ignore the old backing file for unsafe rebase in case we want to correct
2948 * the reference to a renamed or moved backing file.
2949 */
Kevin Wolfce099542016-03-15 13:01:04 +01002950 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002951 if (!blk) {
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01002952 ret = -1;
2953 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002954 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02002955 bs = blk_bs(blk);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002956
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002957 if (out_basefmt != NULL) {
Max Reitz644483d2015-02-05 13:58:17 -05002958 if (bdrv_find_format(out_basefmt) == NULL) {
Jes Sorensen15654a62010-12-16 14:31:53 +01002959 error_report("Invalid format name: '%s'", out_basefmt);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002960 ret = -1;
2961 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002962 }
2963 }
2964
2965 /* For safe rebasing we need to compare old and new backing file */
Stefan Hajnoczi40ed35a2014-08-26 19:17:56 +01002966 if (!unsafe) {
Jeff Cody9a29e182015-01-22 08:03:30 -05002967 char backing_name[PATH_MAX];
Max Reitz644483d2015-02-05 13:58:17 -05002968 QDict *options = NULL;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002969
Max Reitz644483d2015-02-05 13:58:17 -05002970 if (bs->backing_format[0] != '\0') {
2971 options = qdict_new();
2972 qdict_put(options, "driver", qstring_from_str(bs->backing_format));
2973 }
2974
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002975 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
Max Reitzefaa7c42016-03-16 19:54:38 +01002976 blk_old_backing = blk_new_open(backing_name, NULL,
Max Reitz644483d2015-02-05 13:58:17 -05002977 options, src_flags, &local_err);
2978 if (!blk_old_backing) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002979 error_reportf_err(local_err,
2980 "Could not open old backing file '%s': ",
2981 backing_name);
Xu Tiane84a0dd2016-10-09 17:17:27 +08002982 ret = -1;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09002983 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01002984 }
Max Reitz644483d2015-02-05 13:58:17 -05002985
Alex Bligha6166732012-10-16 13:46:18 +01002986 if (out_baseimg[0]) {
Max Reitz644483d2015-02-05 13:58:17 -05002987 if (out_basefmt) {
2988 options = qdict_new();
2989 qdict_put(options, "driver", qstring_from_str(out_basefmt));
2990 } else {
2991 options = NULL;
2992 }
2993
Max Reitzefaa7c42016-03-16 19:54:38 +01002994 blk_new_backing = blk_new_open(out_baseimg, NULL,
Max Reitz644483d2015-02-05 13:58:17 -05002995 options, src_flags, &local_err);
2996 if (!blk_new_backing) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01002997 error_reportf_err(local_err,
2998 "Could not open new backing file '%s': ",
2999 out_baseimg);
Xu Tiane84a0dd2016-10-09 17:17:27 +08003000 ret = -1;
Alex Bligha6166732012-10-16 13:46:18 +01003001 goto out;
3002 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003003 }
3004 }
3005
3006 /*
3007 * Check each unallocated cluster in the COW file. If it is unallocated,
3008 * accesses go to the backing file. We must therefore compare this cluster
3009 * in the old and new backing file, and if they differ we need to copy it
3010 * from the old backing file into the COW file.
3011 *
3012 * If qemu-img crashes during this step, no harm is done. The content of
3013 * the image is the same as the original one at any time.
3014 */
3015 if (!unsafe) {
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003016 int64_t num_sectors;
3017 int64_t old_backing_num_sectors;
3018 int64_t new_backing_num_sectors = 0;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003019 uint64_t sector;
Kevin Wolfcc60e322010-04-29 14:47:48 +02003020 int n;
Kevin Wolf1f710492012-10-12 14:29:18 +02003021 float local_progress = 0;
TeLeMand6771bf2010-02-08 16:20:00 +08003022
Max Reitzf1d3cd72015-02-05 13:58:18 -05003023 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3024 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003025
Max Reitzf1d3cd72015-02-05 13:58:18 -05003026 num_sectors = blk_nb_sectors(blk);
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003027 if (num_sectors < 0) {
3028 error_report("Could not get size of '%s': %s",
3029 filename, strerror(-num_sectors));
3030 ret = -1;
3031 goto out;
3032 }
Max Reitzf1d3cd72015-02-05 13:58:18 -05003033 old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003034 if (old_backing_num_sectors < 0) {
Jeff Cody9a29e182015-01-22 08:03:30 -05003035 char backing_name[PATH_MAX];
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003036
3037 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3038 error_report("Could not get size of '%s': %s",
3039 backing_name, strerror(-old_backing_num_sectors));
3040 ret = -1;
3041 goto out;
3042 }
Max Reitzf1d3cd72015-02-05 13:58:18 -05003043 if (blk_new_backing) {
3044 new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
Markus Armbruster52bf1e72014-06-26 13:23:25 +02003045 if (new_backing_num_sectors < 0) {
3046 error_report("Could not get size of '%s': %s",
3047 out_baseimg, strerror(-new_backing_num_sectors));
3048 ret = -1;
3049 goto out;
3050 }
Alex Bligha6166732012-10-16 13:46:18 +01003051 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003052
Kevin Wolf1f710492012-10-12 14:29:18 +02003053 if (num_sectors != 0) {
3054 local_progress = (float)100 /
3055 (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
3056 }
3057
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003058 for (sector = 0; sector < num_sectors; sector += n) {
3059
3060 /* How many sectors can we handle with the next read? */
3061 if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
3062 n = (IO_BUF_SIZE / 512);
3063 } else {
3064 n = num_sectors - sector;
3065 }
3066
3067 /* If the cluster is allocated, we don't need to take action */
Kevin Wolfcc60e322010-04-29 14:47:48 +02003068 ret = bdrv_is_allocated(bs, sector, n, &n);
Paolo Bonzinid6636402013-09-04 19:00:25 +02003069 if (ret < 0) {
3070 error_report("error while reading image metadata: %s",
3071 strerror(-ret));
3072 goto out;
3073 }
Kevin Wolfcc60e322010-04-29 14:47:48 +02003074 if (ret) {
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003075 continue;
3076 }
3077
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003078 /*
3079 * Read old and new backing file and take into consideration that
3080 * backing files may be smaller than the COW image.
3081 */
3082 if (sector >= old_backing_num_sectors) {
3083 memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
3084 } else {
3085 if (sector + n > old_backing_num_sectors) {
3086 n = old_backing_num_sectors - sector;
3087 }
3088
Eric Blake91669202016-05-06 10:26:43 -06003089 ret = blk_pread(blk_old_backing, sector << BDRV_SECTOR_BITS,
3090 buf_old, n << BDRV_SECTOR_BITS);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003091 if (ret < 0) {
3092 error_report("error while reading from old backing file");
3093 goto out;
3094 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003095 }
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003096
Max Reitzf1d3cd72015-02-05 13:58:18 -05003097 if (sector >= new_backing_num_sectors || !blk_new_backing) {
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003098 memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
3099 } else {
3100 if (sector + n > new_backing_num_sectors) {
3101 n = new_backing_num_sectors - sector;
3102 }
3103
Eric Blake91669202016-05-06 10:26:43 -06003104 ret = blk_pread(blk_new_backing, sector << BDRV_SECTOR_BITS,
3105 buf_new, n << BDRV_SECTOR_BITS);
Kevin Wolf87a1b3e2011-12-07 12:42:10 +01003106 if (ret < 0) {
3107 error_report("error while reading from new backing file");
3108 goto out;
3109 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003110 }
3111
3112 /* If they differ, we need to write to the COW file */
3113 uint64_t written = 0;
3114
3115 while (written < n) {
3116 int pnum;
3117
3118 if (compare_sectors(buf_old + written * 512,
Kevin Wolf60b1bd42010-02-17 12:32:59 +01003119 buf_new + written * 512, n - written, &pnum))
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003120 {
Eric Blake91669202016-05-06 10:26:43 -06003121 ret = blk_pwrite(blk,
3122 (sector + written) << BDRV_SECTOR_BITS,
3123 buf_old + written * 512,
3124 pnum << BDRV_SECTOR_BITS, 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003125 if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003126 error_report("Error while writing to COW image: %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003127 strerror(-ret));
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003128 goto out;
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003129 }
3130 }
3131
3132 written += pnum;
3133 }
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003134 qemu_progress_print(local_progress, 100);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003135 }
3136 }
3137
3138 /*
3139 * Change the backing file. All clusters that are different from the old
3140 * backing file are overwritten in the COW file now, so the visible content
3141 * doesn't change when we switch the backing file.
3142 */
Alex Bligha6166732012-10-16 13:46:18 +01003143 if (out_baseimg && *out_baseimg) {
3144 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
3145 } else {
3146 ret = bdrv_change_backing_file(bs, NULL, NULL);
3147 }
3148
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003149 if (ret == -ENOSPC) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003150 error_report("Could not change the backing file to '%s': No "
3151 "space left in the file header", out_baseimg);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003152 } else if (ret < 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003153 error_report("Could not change the backing file to '%s': %s",
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003154 out_baseimg, strerror(-ret));
3155 }
3156
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003157 qemu_progress_print(100, 0);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003158 /*
3159 * TODO At this point it is possible to check if any clusters that are
3160 * allocated in the COW file are the same in the backing file. If so, they
3161 * could be dropped from the COW file. Don't do this before switching the
3162 * backing file, in case of a crash this would lead to corruption.
3163 */
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003164out:
Jes Sorensen6b837bc2011-03-30 14:16:25 +02003165 qemu_progress_end();
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003166 /* Cleanup */
3167 if (!unsafe) {
Markus Armbruster26f54e92014-10-07 13:59:04 +02003168 blk_unref(blk_old_backing);
Markus Armbruster26f54e92014-10-07 13:59:04 +02003169 blk_unref(blk_new_backing);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003170 }
Paolo Bonzini396374c2016-02-25 23:53:54 +01003171 qemu_vfree(buf_old);
3172 qemu_vfree(buf_new);
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003173
Markus Armbruster26f54e92014-10-07 13:59:04 +02003174 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003175 if (ret) {
3176 return 1;
3177 }
Kevin Wolf3e85c6f2010-01-12 12:55:18 +01003178 return 0;
3179}
3180
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003181static int img_resize(int argc, char **argv)
3182{
Markus Armbruster6750e792015-02-12 17:43:08 +01003183 Error *err = NULL;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003184 int c, ret, relative;
3185 const char *filename, *fmt, *size;
3186 int64_t n, total_size;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003187 bool quiet = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003188 BlockBackend *blk = NULL;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003189 QemuOpts *param;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003190
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003191 static QemuOptsList resize_options = {
3192 .name = "resize_options",
3193 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3194 .desc = {
3195 {
3196 .name = BLOCK_OPT_SIZE,
3197 .type = QEMU_OPT_SIZE,
3198 .help = "Virtual disk size"
3199 }, {
3200 /* end of list */
3201 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003202 },
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003203 };
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003204 bool image_opts = false;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003205
Kevin Wolfe80fec72011-04-29 10:58:12 +02003206 /* Remove size from argv manually so that negative numbers are not treated
3207 * as options by getopt. */
3208 if (argc < 3) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003209 error_exit("Not enough arguments");
Kevin Wolfe80fec72011-04-29 10:58:12 +02003210 return 1;
3211 }
3212
3213 size = argv[--argc];
3214
3215 /* Parse getopt arguments */
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003216 fmt = NULL;
3217 for(;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003218 static const struct option long_options[] = {
3219 {"help", no_argument, 0, 'h'},
3220 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003221 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003222 {0, 0, 0, 0}
3223 };
3224 c = getopt_long(argc, argv, "f:hq",
3225 long_options, NULL);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003226 if (c == -1) {
3227 break;
3228 }
3229 switch(c) {
Jes Sorensenef873942010-12-06 15:25:40 +01003230 case '?':
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003231 case 'h':
3232 help();
3233 break;
3234 case 'f':
3235 fmt = optarg;
3236 break;
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003237 case 'q':
3238 quiet = true;
3239 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003240 case OPTION_OBJECT: {
3241 QemuOpts *opts;
3242 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3243 optarg, true);
3244 if (!opts) {
3245 return 1;
3246 }
3247 } break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003248 case OPTION_IMAGE_OPTS:
3249 image_opts = true;
3250 break;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003251 }
3252 }
Kevin Wolffc11eb22013-08-05 10:53:04 +02003253 if (optind != argc - 1) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003254 error_exit("Expecting one image file name");
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003255 }
3256 filename = argv[optind++];
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003257
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003258 if (qemu_opts_foreach(&qemu_object_opts,
3259 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02003260 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003261 return 1;
3262 }
3263
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003264 /* Choose grow, shrink, or absolute resize mode */
3265 switch (size[0]) {
3266 case '+':
3267 relative = 1;
3268 size++;
3269 break;
3270 case '-':
3271 relative = -1;
3272 size++;
3273 break;
3274 default:
3275 relative = 0;
3276 break;
3277 }
3278
3279 /* Parse size */
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -08003280 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
Markus Armbrusterf43e47d2015-02-12 17:52:20 +01003281 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
Markus Armbruster6750e792015-02-12 17:43:08 +01003282 if (err) {
3283 error_report_err(err);
Jes Sorensen2a819982010-12-06 17:08:31 +01003284 ret = -1;
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003285 qemu_opts_del(param);
Jes Sorensen2a819982010-12-06 17:08:31 +01003286 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003287 }
Dong Xu Wang20caf0f2012-08-06 10:18:42 +08003288 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3289 qemu_opts_del(param);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003290
Max Reitzefaa7c42016-03-16 19:54:38 +01003291 blk = img_open(image_opts, filename, fmt,
Kevin Wolfce099542016-03-15 13:01:04 +01003292 BDRV_O_RDWR, false, quiet);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003293 if (!blk) {
Jes Sorensen2a819982010-12-06 17:08:31 +01003294 ret = -1;
3295 goto out;
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003296 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003297
3298 if (relative) {
Max Reitzf1d3cd72015-02-05 13:58:18 -05003299 total_size = blk_getlength(blk) + n * relative;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003300 } else {
3301 total_size = n;
3302 }
3303 if (total_size <= 0) {
Jes Sorensen15654a62010-12-16 14:31:53 +01003304 error_report("New image size must be positive");
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003305 ret = -1;
3306 goto out;
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003307 }
3308
Max Reitzf1d3cd72015-02-05 13:58:18 -05003309 ret = blk_truncate(blk, total_size);
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003310 switch (ret) {
3311 case 0:
Miroslav Rezaninaf382d432013-02-13 09:09:40 +01003312 qprintf(quiet, "Image resized.\n");
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003313 break;
3314 case -ENOTSUP:
Kevin Wolf259b2172012-03-06 12:44:45 +01003315 error_report("This image does not support resize");
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003316 break;
3317 case -EACCES:
Jes Sorensen15654a62010-12-16 14:31:53 +01003318 error_report("Image is read-only");
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003319 break;
3320 default:
Max Reitzbcf23482016-06-15 17:36:29 +02003321 error_report("Error resizing image: %s", strerror(-ret));
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003322 break;
3323 }
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003324out:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003325 blk_unref(blk);
MORITA Kazutakac2abcce2010-06-21 04:26:35 +09003326 if (ret) {
3327 return 1;
3328 }
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +01003329 return 0;
3330}
3331
Max Reitz76a3a342014-10-27 11:12:51 +01003332static void amend_status_cb(BlockDriverState *bs,
Max Reitz8b139762015-07-27 17:51:32 +02003333 int64_t offset, int64_t total_work_size,
3334 void *opaque)
Max Reitz76a3a342014-10-27 11:12:51 +01003335{
3336 qemu_progress_print(100.f * offset / total_work_size, 0);
3337}
3338
Max Reitz6f176b42013-09-03 10:09:50 +02003339static int img_amend(int argc, char **argv)
3340{
Markus Armbrusterdc523cd342015-02-12 18:37:11 +01003341 Error *err = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02003342 int c, ret = 0;
3343 char *options = NULL;
Chunyan Liu83d05212014-06-05 17:20:51 +08003344 QemuOptsList *create_opts = NULL;
3345 QemuOpts *opts = NULL;
Max Reitzbd39e6e2014-07-22 22:58:43 +02003346 const char *fmt = NULL, *filename, *cache;
3347 int flags;
Kevin Wolfce099542016-03-15 13:01:04 +01003348 bool writethrough;
Max Reitz76a3a342014-10-27 11:12:51 +01003349 bool quiet = false, progress = false;
Markus Armbruster26f54e92014-10-07 13:59:04 +02003350 BlockBackend *blk = NULL;
Max Reitz6f176b42013-09-03 10:09:50 +02003351 BlockDriverState *bs = NULL;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003352 bool image_opts = false;
Max Reitz6f176b42013-09-03 10:09:50 +02003353
Max Reitzbd39e6e2014-07-22 22:58:43 +02003354 cache = BDRV_DEFAULT_CACHE;
Max Reitz6f176b42013-09-03 10:09:50 +02003355 for (;;) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003356 static const struct option long_options[] = {
3357 {"help", no_argument, 0, 'h'},
3358 {"object", required_argument, 0, OPTION_OBJECT},
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003359 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003360 {0, 0, 0, 0}
3361 };
3362 c = getopt_long(argc, argv, "ho:f:t:pq",
3363 long_options, NULL);
Max Reitz6f176b42013-09-03 10:09:50 +02003364 if (c == -1) {
3365 break;
3366 }
3367
3368 switch (c) {
3369 case 'h':
3370 case '?':
3371 help();
3372 break;
3373 case 'o':
Kevin Wolf626f84f2014-02-21 16:24:06 +01003374 if (!is_valid_option_list(optarg)) {
3375 error_report("Invalid option list: %s", optarg);
3376 ret = -1;
Max Reitze814dff2015-08-20 16:00:38 -07003377 goto out_no_progress;
Kevin Wolf626f84f2014-02-21 16:24:06 +01003378 }
3379 if (!options) {
3380 options = g_strdup(optarg);
3381 } else {
3382 char *old_options = options;
3383 options = g_strdup_printf("%s,%s", options, optarg);
3384 g_free(old_options);
3385 }
Max Reitz6f176b42013-09-03 10:09:50 +02003386 break;
3387 case 'f':
3388 fmt = optarg;
3389 break;
Max Reitzbd39e6e2014-07-22 22:58:43 +02003390 case 't':
3391 cache = optarg;
3392 break;
Max Reitz76a3a342014-10-27 11:12:51 +01003393 case 'p':
3394 progress = true;
3395 break;
Max Reitz6f176b42013-09-03 10:09:50 +02003396 case 'q':
3397 quiet = true;
3398 break;
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003399 case OPTION_OBJECT:
3400 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3401 optarg, true);
3402 if (!opts) {
3403 ret = -1;
3404 goto out_no_progress;
3405 }
3406 break;
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00003407 case OPTION_IMAGE_OPTS:
3408 image_opts = true;
3409 break;
Max Reitz6f176b42013-09-03 10:09:50 +02003410 }
3411 }
3412
Max Reitz6f176b42013-09-03 10:09:50 +02003413 if (!options) {
Fam Zhengac1307a2014-04-22 13:36:11 +08003414 error_exit("Must specify options (-o)");
Max Reitz6f176b42013-09-03 10:09:50 +02003415 }
3416
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003417 if (qemu_opts_foreach(&qemu_object_opts,
3418 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +02003419 NULL, NULL)) {
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00003420 ret = -1;
3421 goto out_no_progress;
3422 }
3423
Max Reitz76a3a342014-10-27 11:12:51 +01003424 if (quiet) {
3425 progress = false;
3426 }
3427 qemu_progress_init(progress, 1.0);
3428
Kevin Wolfa283cb62014-02-21 16:24:07 +01003429 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
3430 if (fmt && has_help_option(options)) {
3431 /* If a format is explicitly specified (and possibly no filename is
3432 * given), print option help here */
3433 ret = print_block_option_help(filename, fmt);
3434 goto out;
3435 }
3436
3437 if (optind != argc - 1) {
Max Reitzb2f27e42014-10-27 11:12:52 +01003438 error_report("Expecting one image file name");
3439 ret = -1;
3440 goto out;
Kevin Wolfa283cb62014-02-21 16:24:07 +01003441 }
Max Reitz6f176b42013-09-03 10:09:50 +02003442
Kevin Wolfce099542016-03-15 13:01:04 +01003443 flags = BDRV_O_RDWR;
3444 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
Max Reitzbd39e6e2014-07-22 22:58:43 +02003445 if (ret < 0) {
3446 error_report("Invalid cache option: %s", cache);
3447 goto out;
3448 }
3449
Kevin Wolfce099542016-03-15 13:01:04 +01003450 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003451 if (!blk) {
Max Reitz6f176b42013-09-03 10:09:50 +02003452 ret = -1;
3453 goto out;
3454 }
Markus Armbruster7e7d56d2014-10-07 13:59:05 +02003455 bs = blk_bs(blk);
Max Reitz6f176b42013-09-03 10:09:50 +02003456
3457 fmt = bs->drv->format_name;
3458
Kevin Wolf626f84f2014-02-21 16:24:06 +01003459 if (has_help_option(options)) {
Kevin Wolfa283cb62014-02-21 16:24:07 +01003460 /* If the format was auto-detected, print option help here */
Max Reitz6f176b42013-09-03 10:09:50 +02003461 ret = print_block_option_help(filename, fmt);
3462 goto out;
3463 }
3464
Max Reitzb2439d22014-12-02 18:32:47 +01003465 if (!bs->drv->create_opts) {
3466 error_report("Format driver '%s' does not support any options to amend",
3467 fmt);
3468 ret = -1;
3469 goto out;
3470 }
3471
Chunyan Liuc282e1f2014-06-05 17:21:11 +08003472 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
Chunyan Liu83d05212014-06-05 17:20:51 +08003473 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
Paolo Bonziniece90862017-01-04 15:56:24 +01003474 qemu_opts_do_parse(opts, options, NULL, &err);
3475 if (err) {
3476 error_report_err(err);
3477 ret = -1;
3478 goto out;
Max Reitz6f176b42013-09-03 10:09:50 +02003479 }
3480
Max Reitz76a3a342014-10-27 11:12:51 +01003481 /* In case the driver does not call amend_status_cb() */
3482 qemu_progress_print(0.f, 0);
Max Reitz8b139762015-07-27 17:51:32 +02003483 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
Max Reitz76a3a342014-10-27 11:12:51 +01003484 qemu_progress_print(100.f, 0);
Max Reitz6f176b42013-09-03 10:09:50 +02003485 if (ret < 0) {
3486 error_report("Error while amending options: %s", strerror(-ret));
3487 goto out;
3488 }
3489
3490out:
Max Reitz76a3a342014-10-27 11:12:51 +01003491 qemu_progress_end();
3492
Max Reitze814dff2015-08-20 16:00:38 -07003493out_no_progress:
Markus Armbruster26f54e92014-10-07 13:59:04 +02003494 blk_unref(blk);
Chunyan Liu83d05212014-06-05 17:20:51 +08003495 qemu_opts_del(opts);
3496 qemu_opts_free(create_opts);
Kevin Wolf626f84f2014-02-21 16:24:06 +01003497 g_free(options);
3498
Max Reitz6f176b42013-09-03 10:09:50 +02003499 if (ret) {
3500 return 1;
3501 }
3502 return 0;
3503}
3504
Kevin Wolfb6133b82014-08-05 14:17:13 +02003505typedef struct BenchData {
3506 BlockBackend *blk;
3507 uint64_t image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02003508 bool write;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003509 int bufsize;
Kevin Wolf83de9be2015-07-13 13:13:17 +02003510 int step;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003511 int nrreq;
3512 int n;
Kevin Wolf55d539c2016-06-03 13:59:41 +02003513 int flush_interval;
3514 bool drain_on_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003515 uint8_t *buf;
3516 QEMUIOVector *qiov;
3517
3518 int in_flight;
Kevin Wolf55d539c2016-06-03 13:59:41 +02003519 bool in_flush;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003520 uint64_t offset;
3521} BenchData;
3522
Kevin Wolf55d539c2016-06-03 13:59:41 +02003523static void bench_undrained_flush_cb(void *opaque, int ret)
3524{
3525 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02003526 error_report("Failed flush request: %s", strerror(-ret));
Kevin Wolf55d539c2016-06-03 13:59:41 +02003527 exit(EXIT_FAILURE);
3528 }
3529}
3530
Kevin Wolfb6133b82014-08-05 14:17:13 +02003531static void bench_cb(void *opaque, int ret)
3532{
3533 BenchData *b = opaque;
3534 BlockAIOCB *acb;
3535
3536 if (ret < 0) {
Markus Armbrusterdf3c2862016-08-03 13:37:51 +02003537 error_report("Failed request: %s", strerror(-ret));
Kevin Wolfb6133b82014-08-05 14:17:13 +02003538 exit(EXIT_FAILURE);
3539 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02003540
3541 if (b->in_flush) {
3542 /* Just finished a flush with drained queue: Start next requests */
3543 assert(b->in_flight == 0);
3544 b->in_flush = false;
3545 } else if (b->in_flight > 0) {
3546 int remaining = b->n - b->in_flight;
3547
Kevin Wolfb6133b82014-08-05 14:17:13 +02003548 b->n--;
3549 b->in_flight--;
Kevin Wolf55d539c2016-06-03 13:59:41 +02003550
3551 /* Time for flush? Drain queue if requested, then flush */
3552 if (b->flush_interval && remaining % b->flush_interval == 0) {
3553 if (!b->in_flight || !b->drain_on_flush) {
3554 BlockCompletionFunc *cb;
3555
3556 if (b->drain_on_flush) {
3557 b->in_flush = true;
3558 cb = bench_cb;
3559 } else {
3560 cb = bench_undrained_flush_cb;
3561 }
3562
3563 acb = blk_aio_flush(b->blk, cb, b);
3564 if (!acb) {
3565 error_report("Failed to issue flush request");
3566 exit(EXIT_FAILURE);
3567 }
3568 }
3569 if (b->drain_on_flush) {
3570 return;
3571 }
3572 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02003573 }
3574
3575 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01003576 int64_t offset = b->offset;
3577 /* blk_aio_* might look for completed I/Os and kick bench_cb
3578 * again, so make sure this operation is counted by in_flight
3579 * and b->offset is ready for the next submission.
3580 */
3581 b->in_flight++;
3582 b->offset += b->step;
3583 b->offset %= b->image_size;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02003584 if (b->write) {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01003585 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02003586 } else {
Paolo Bonzini4baaa8c2016-12-07 16:08:27 +01003587 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02003588 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02003589 if (!acb) {
3590 error_report("Failed to issue request");
3591 exit(EXIT_FAILURE);
3592 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02003593 }
3594}
3595
3596static int img_bench(int argc, char **argv)
3597{
3598 int c, ret = 0;
3599 const char *fmt = NULL, *filename;
3600 bool quiet = false;
3601 bool image_opts = false;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02003602 bool is_write = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003603 int count = 75000;
3604 int depth = 64;
Kevin Wolfd3199a32015-07-10 18:09:18 +02003605 int64_t offset = 0;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003606 size_t bufsize = 4096;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02003607 int pattern = 0;
Kevin Wolf83de9be2015-07-13 13:13:17 +02003608 size_t step = 0;
Kevin Wolf55d539c2016-06-03 13:59:41 +02003609 int flush_interval = 0;
3610 bool drain_on_flush = true;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003611 int64_t image_size;
3612 BlockBackend *blk = NULL;
3613 BenchData data = {};
3614 int flags = 0;
Kevin Wolf604e8612016-06-14 11:29:32 +02003615 bool writethrough = false;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003616 struct timeval t1, t2;
3617 int i;
3618
3619 for (;;) {
3620 static const struct option long_options[] = {
3621 {"help", no_argument, 0, 'h'},
Kevin Wolf55d539c2016-06-03 13:59:41 +02003622 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
Kevin Wolfb6133b82014-08-05 14:17:13 +02003623 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
Kevin Wolfb6495fa2015-07-10 18:09:18 +02003624 {"pattern", required_argument, 0, OPTION_PATTERN},
Kevin Wolf55d539c2016-06-03 13:59:41 +02003625 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
Kevin Wolfb6133b82014-08-05 14:17:13 +02003626 {0, 0, 0, 0}
3627 };
Kevin Wolf83de9be2015-07-13 13:13:17 +02003628 c = getopt_long(argc, argv, "hc:d:f:no:qs:S:t:w", long_options, NULL);
Kevin Wolfb6133b82014-08-05 14:17:13 +02003629 if (c == -1) {
3630 break;
3631 }
3632
3633 switch (c) {
3634 case 'h':
3635 case '?':
3636 help();
3637 break;
3638 case 'c':
3639 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00003640 unsigned long res;
3641
3642 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02003643 error_report("Invalid request count specified");
3644 return 1;
3645 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00003646 count = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003647 break;
3648 }
3649 case 'd':
3650 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00003651 unsigned long res;
3652
3653 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02003654 error_report("Invalid queue depth specified");
3655 return 1;
3656 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00003657 depth = res;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003658 break;
3659 }
3660 case 'f':
3661 fmt = optarg;
3662 break;
3663 case 'n':
3664 flags |= BDRV_O_NATIVE_AIO;
3665 break;
Kevin Wolfd3199a32015-07-10 18:09:18 +02003666 case 'o':
3667 {
Markus Armbruster606caa02017-02-21 21:14:04 +01003668 offset = cvtnum(optarg);
3669 if (offset < 0) {
Kevin Wolfd3199a32015-07-10 18:09:18 +02003670 error_report("Invalid offset specified");
3671 return 1;
3672 }
3673 break;
3674 }
3675 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003676 case 'q':
3677 quiet = true;
3678 break;
3679 case 's':
3680 {
3681 int64_t sval;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003682
Markus Armbruster606caa02017-02-21 21:14:04 +01003683 sval = cvtnum(optarg);
3684 if (sval < 0 || sval > INT_MAX) {
Kevin Wolfb6133b82014-08-05 14:17:13 +02003685 error_report("Invalid buffer size specified");
3686 return 1;
3687 }
3688
3689 bufsize = sval;
3690 break;
3691 }
Kevin Wolf83de9be2015-07-13 13:13:17 +02003692 case 'S':
3693 {
3694 int64_t sval;
Kevin Wolf83de9be2015-07-13 13:13:17 +02003695
Markus Armbruster606caa02017-02-21 21:14:04 +01003696 sval = cvtnum(optarg);
3697 if (sval < 0 || sval > INT_MAX) {
Kevin Wolf83de9be2015-07-13 13:13:17 +02003698 error_report("Invalid step size specified");
3699 return 1;
3700 }
3701
3702 step = sval;
3703 break;
3704 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02003705 case 't':
3706 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
3707 if (ret < 0) {
3708 error_report("Invalid cache mode");
3709 ret = -1;
3710 goto out;
3711 }
3712 break;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02003713 case 'w':
3714 flags |= BDRV_O_RDWR;
3715 is_write = true;
3716 break;
3717 case OPTION_PATTERN:
3718 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00003719 unsigned long res;
3720
3721 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
Kevin Wolfb6495fa2015-07-10 18:09:18 +02003722 error_report("Invalid pattern byte specified");
3723 return 1;
3724 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00003725 pattern = res;
Kevin Wolfb6495fa2015-07-10 18:09:18 +02003726 break;
3727 }
Kevin Wolf55d539c2016-06-03 13:59:41 +02003728 case OPTION_FLUSH_INTERVAL:
3729 {
Peter Maydell8b3c6792017-02-10 16:28:23 +00003730 unsigned long res;
3731
3732 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02003733 error_report("Invalid flush interval specified");
3734 return 1;
3735 }
Peter Maydell8b3c6792017-02-10 16:28:23 +00003736 flush_interval = res;
Kevin Wolf55d539c2016-06-03 13:59:41 +02003737 break;
3738 }
3739 case OPTION_NO_DRAIN:
3740 drain_on_flush = false;
3741 break;
Kevin Wolfb6133b82014-08-05 14:17:13 +02003742 case OPTION_IMAGE_OPTS:
3743 image_opts = true;
3744 break;
3745 }
3746 }
3747
3748 if (optind != argc - 1) {
3749 error_exit("Expecting one image file name");
3750 }
3751 filename = argv[argc - 1];
3752
Kevin Wolf55d539c2016-06-03 13:59:41 +02003753 if (!is_write && flush_interval) {
3754 error_report("--flush-interval is only available in write tests");
3755 ret = -1;
3756 goto out;
3757 }
3758 if (flush_interval && flush_interval < depth) {
3759 error_report("Flush interval can't be smaller than depth");
3760 ret = -1;
3761 goto out;
3762 }
3763
Kevin Wolfb6133b82014-08-05 14:17:13 +02003764 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3765 if (!blk) {
3766 ret = -1;
3767 goto out;
3768 }
3769
3770 image_size = blk_getlength(blk);
3771 if (image_size < 0) {
3772 ret = image_size;
3773 goto out;
3774 }
3775
3776 data = (BenchData) {
Kevin Wolf55d539c2016-06-03 13:59:41 +02003777 .blk = blk,
3778 .image_size = image_size,
3779 .bufsize = bufsize,
3780 .step = step ?: bufsize,
3781 .nrreq = depth,
3782 .n = count,
3783 .offset = offset,
3784 .write = is_write,
3785 .flush_interval = flush_interval,
3786 .drain_on_flush = drain_on_flush,
Kevin Wolfb6133b82014-08-05 14:17:13 +02003787 };
Kevin Wolfd3199a32015-07-10 18:09:18 +02003788 printf("Sending %d %s requests, %d bytes each, %d in parallel "
Kevin Wolf83de9be2015-07-13 13:13:17 +02003789 "(starting at offset %" PRId64 ", step size %d)\n",
Kevin Wolfd3199a32015-07-10 18:09:18 +02003790 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
Kevin Wolf83de9be2015-07-13 13:13:17 +02003791 data.offset, data.step);
Kevin Wolf55d539c2016-06-03 13:59:41 +02003792 if (flush_interval) {
3793 printf("Sending flush every %d requests\n", flush_interval);
3794 }
Kevin Wolfb6133b82014-08-05 14:17:13 +02003795
3796 data.buf = blk_blockalign(blk, data.nrreq * data.bufsize);
Kevin Wolfb6495fa2015-07-10 18:09:18 +02003797 memset(data.buf, pattern, data.nrreq * data.bufsize);
3798
Kevin Wolfb6133b82014-08-05 14:17:13 +02003799 data.qiov = g_new(QEMUIOVector, data.nrreq);
3800 for (i = 0; i < data.nrreq; i++) {
3801 qemu_iovec_init(&data.qiov[i], 1);
3802 qemu_iovec_add(&data.qiov[i],
3803 data.buf + i * data.bufsize, data.bufsize);
3804 }
3805
3806 gettimeofday(&t1, NULL);
3807 bench_cb(&data, 0);
3808
3809 while (data.n > 0) {
3810 main_loop_wait(false);
3811 }
3812 gettimeofday(&t2, NULL);
3813
3814 printf("Run completed in %3.3f seconds.\n",
3815 (t2.tv_sec - t1.tv_sec)
3816 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
3817
3818out:
3819 qemu_vfree(data.buf);
3820 blk_unref(blk);
3821
3822 if (ret) {
3823 return 1;
3824 }
3825 return 0;
3826}
3827
Reda Sallahi86ce1f62016-08-10 04:43:12 +02003828#define C_BS 01
3829#define C_COUNT 02
3830#define C_IF 04
3831#define C_OF 010
Reda Sallahif7c15532016-08-10 16:16:09 +02003832#define C_SKIP 020
Reda Sallahi86ce1f62016-08-10 04:43:12 +02003833
3834struct DdInfo {
3835 unsigned int flags;
3836 int64_t count;
3837};
3838
3839struct DdIo {
3840 int bsz; /* Block size */
3841 char *filename;
3842 uint8_t *buf;
Reda Sallahif7c15532016-08-10 16:16:09 +02003843 int64_t offset;
Reda Sallahi86ce1f62016-08-10 04:43:12 +02003844};
3845
3846struct DdOpts {
3847 const char *name;
3848 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
3849 unsigned int flag;
3850};
3851
3852static int img_dd_bs(const char *arg,
3853 struct DdIo *in, struct DdIo *out,
3854 struct DdInfo *dd)
3855{
Reda Sallahi86ce1f62016-08-10 04:43:12 +02003856 int64_t res;
3857
Markus Armbruster606caa02017-02-21 21:14:04 +01003858 res = cvtnum(arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02003859
Markus Armbruster606caa02017-02-21 21:14:04 +01003860 if (res <= 0 || res > INT_MAX) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02003861 error_report("invalid number: '%s'", arg);
3862 return 1;
3863 }
3864 in->bsz = out->bsz = res;
3865
3866 return 0;
3867}
3868
3869static int img_dd_count(const char *arg,
3870 struct DdIo *in, struct DdIo *out,
3871 struct DdInfo *dd)
3872{
Markus Armbruster606caa02017-02-21 21:14:04 +01003873 dd->count = cvtnum(arg);
Reda Sallahi86ce1f62016-08-10 04:43:12 +02003874
Markus Armbruster606caa02017-02-21 21:14:04 +01003875 if (dd->count < 0) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02003876 error_report("invalid number: '%s'", arg);
3877 return 1;
3878 }
3879
3880 return 0;
3881}
3882
3883static int img_dd_if(const char *arg,
3884 struct DdIo *in, struct DdIo *out,
3885 struct DdInfo *dd)
3886{
3887 in->filename = g_strdup(arg);
3888
3889 return 0;
3890}
3891
3892static int img_dd_of(const char *arg,
3893 struct DdIo *in, struct DdIo *out,
3894 struct DdInfo *dd)
3895{
3896 out->filename = g_strdup(arg);
3897
3898 return 0;
3899}
3900
Reda Sallahif7c15532016-08-10 16:16:09 +02003901static int img_dd_skip(const char *arg,
3902 struct DdIo *in, struct DdIo *out,
3903 struct DdInfo *dd)
3904{
Markus Armbruster606caa02017-02-21 21:14:04 +01003905 in->offset = cvtnum(arg);
Reda Sallahif7c15532016-08-10 16:16:09 +02003906
Markus Armbruster606caa02017-02-21 21:14:04 +01003907 if (in->offset < 0) {
Reda Sallahif7c15532016-08-10 16:16:09 +02003908 error_report("invalid number: '%s'", arg);
3909 return 1;
3910 }
3911
3912 return 0;
3913}
3914
Reda Sallahi86ce1f62016-08-10 04:43:12 +02003915static int img_dd(int argc, char **argv)
3916{
3917 int ret = 0;
3918 char *arg = NULL;
3919 char *tmp;
3920 BlockDriver *drv = NULL, *proto_drv = NULL;
3921 BlockBackend *blk1 = NULL, *blk2 = NULL;
3922 QemuOpts *opts = NULL;
3923 QemuOptsList *create_opts = NULL;
3924 Error *local_err = NULL;
3925 bool image_opts = false;
3926 int c, i;
3927 const char *out_fmt = "raw";
3928 const char *fmt = NULL;
3929 int64_t size = 0;
3930 int64_t block_count = 0, out_pos, in_pos;
3931 struct DdInfo dd = {
3932 .flags = 0,
3933 .count = 0,
3934 };
3935 struct DdIo in = {
3936 .bsz = 512, /* Block size is by default 512 bytes */
3937 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02003938 .buf = NULL,
3939 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02003940 };
3941 struct DdIo out = {
3942 .bsz = 512,
3943 .filename = NULL,
Reda Sallahif7c15532016-08-10 16:16:09 +02003944 .buf = NULL,
3945 .offset = 0
Reda Sallahi86ce1f62016-08-10 04:43:12 +02003946 };
3947
3948 const struct DdOpts options[] = {
3949 { "bs", img_dd_bs, C_BS },
3950 { "count", img_dd_count, C_COUNT },
3951 { "if", img_dd_if, C_IF },
3952 { "of", img_dd_of, C_OF },
Reda Sallahif7c15532016-08-10 16:16:09 +02003953 { "skip", img_dd_skip, C_SKIP },
Reda Sallahi86ce1f62016-08-10 04:43:12 +02003954 { NULL, NULL, 0 }
3955 };
3956 const struct option long_options[] = {
3957 { "help", no_argument, 0, 'h'},
3958 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3959 { 0, 0, 0, 0 }
3960 };
3961
3962 while ((c = getopt_long(argc, argv, "hf:O:", long_options, NULL))) {
3963 if (c == EOF) {
3964 break;
3965 }
3966 switch (c) {
3967 case 'O':
3968 out_fmt = optarg;
3969 break;
3970 case 'f':
3971 fmt = optarg;
3972 break;
3973 case '?':
3974 error_report("Try 'qemu-img --help' for more information.");
3975 ret = -1;
3976 goto out;
3977 case 'h':
3978 help();
3979 break;
3980 case OPTION_IMAGE_OPTS:
3981 image_opts = true;
3982 break;
3983 }
3984 }
3985
3986 for (i = optind; i < argc; i++) {
3987 int j;
3988 arg = g_strdup(argv[i]);
3989
3990 tmp = strchr(arg, '=');
3991 if (tmp == NULL) {
3992 error_report("unrecognized operand %s", arg);
3993 ret = -1;
3994 goto out;
3995 }
3996
3997 *tmp++ = '\0';
3998
3999 for (j = 0; options[j].name != NULL; j++) {
4000 if (!strcmp(arg, options[j].name)) {
4001 break;
4002 }
4003 }
4004 if (options[j].name == NULL) {
4005 error_report("unrecognized operand %s", arg);
4006 ret = -1;
4007 goto out;
4008 }
4009
4010 if (options[j].f(tmp, &in, &out, &dd) != 0) {
4011 ret = -1;
4012 goto out;
4013 }
4014 dd.flags |= options[j].flag;
4015 g_free(arg);
4016 arg = NULL;
4017 }
4018
4019 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
4020 error_report("Must specify both input and output files");
4021 ret = -1;
4022 goto out;
4023 }
4024 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false);
4025
4026 if (!blk1) {
4027 ret = -1;
4028 goto out;
4029 }
4030
4031 drv = bdrv_find_format(out_fmt);
4032 if (!drv) {
4033 error_report("Unknown file format");
4034 ret = -1;
4035 goto out;
4036 }
4037 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
4038
4039 if (!proto_drv) {
4040 error_report_err(local_err);
4041 ret = -1;
4042 goto out;
4043 }
4044 if (!drv->create_opts) {
4045 error_report("Format driver '%s' does not support image creation",
4046 drv->format_name);
4047 ret = -1;
4048 goto out;
4049 }
4050 if (!proto_drv->create_opts) {
4051 error_report("Protocol driver '%s' does not support image creation",
4052 proto_drv->format_name);
4053 ret = -1;
4054 goto out;
4055 }
4056 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4057 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
4058
4059 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4060
4061 size = blk_getlength(blk1);
4062 if (size < 0) {
4063 error_report("Failed to get size for '%s'", in.filename);
4064 ret = -1;
4065 goto out;
4066 }
4067
4068 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
4069 dd.count * in.bsz < size) {
4070 size = dd.count * in.bsz;
4071 }
4072
Reda Sallahif7c15532016-08-10 16:16:09 +02004073 /* Overflow means the specified offset is beyond input image's size */
4074 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4075 size < in.bsz * in.offset)) {
4076 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
4077 } else {
4078 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
4079 size - in.bsz * in.offset, &error_abort);
4080 }
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004081
4082 ret = bdrv_create(drv, out.filename, opts, &local_err);
4083 if (ret < 0) {
4084 error_reportf_err(local_err,
4085 "%s: error while creating output image: ",
4086 out.filename);
4087 ret = -1;
4088 goto out;
4089 }
4090
4091 blk2 = img_open(image_opts, out.filename, out_fmt, BDRV_O_RDWR,
4092 false, false);
4093
4094 if (!blk2) {
4095 ret = -1;
4096 goto out;
4097 }
4098
Reda Sallahif7c15532016-08-10 16:16:09 +02004099 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4100 size < in.offset * in.bsz)) {
4101 /* We give a warning if the skip option is bigger than the input
4102 * size and create an empty output disk image (i.e. like dd(1)).
4103 */
4104 error_report("%s: cannot skip to specified offset", in.filename);
4105 in_pos = size;
4106 } else {
4107 in_pos = in.offset * in.bsz;
4108 }
4109
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004110 in.buf = g_new(uint8_t, in.bsz);
4111
Reda Sallahif7c15532016-08-10 16:16:09 +02004112 for (out_pos = 0; in_pos < size; block_count++) {
Reda Sallahi86ce1f62016-08-10 04:43:12 +02004113 int in_ret, out_ret;
4114
4115 if (in_pos + in.bsz > size) {
4116 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
4117 } else {
4118 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
4119 }
4120 if (in_ret < 0) {
4121 error_report("error while reading from input image file: %s",
4122 strerror(-in_ret));
4123 ret = -1;
4124 goto out;
4125 }
4126 in_pos += in_ret;
4127
4128 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
4129
4130 if (out_ret < 0) {
4131 error_report("error while writing to output image file: %s",
4132 strerror(-out_ret));
4133 ret = -1;
4134 goto out;
4135 }
4136 out_pos += out_ret;
4137 }
4138
4139out:
4140 g_free(arg);
4141 qemu_opts_del(opts);
4142 qemu_opts_free(create_opts);
4143 blk_unref(blk1);
4144 blk_unref(blk2);
4145 g_free(in.filename);
4146 g_free(out.filename);
4147 g_free(in.buf);
4148 g_free(out.buf);
4149
4150 if (ret) {
4151 return 1;
4152 }
4153 return 0;
4154}
4155
Kevin Wolfb6133b82014-08-05 14:17:13 +02004156
Anthony Liguoric227f092009-10-01 16:12:16 -05004157static const img_cmd_t img_cmds[] = {
Stuart Brady153859b2009-06-07 00:42:17 +01004158#define DEF(option, callback, arg_string) \
4159 { option, callback },
4160#include "qemu-img-cmds.h"
4161#undef DEF
4162#undef GEN_DOCS
4163 { NULL, NULL, },
4164};
4165
bellardea2384d2004-08-01 21:59:26 +00004166int main(int argc, char **argv)
4167{
Anthony Liguoric227f092009-10-01 16:12:16 -05004168 const img_cmd_t *cmd;
Stuart Brady153859b2009-06-07 00:42:17 +01004169 const char *cmdname;
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03004170 Error *local_error = NULL;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03004171 char *trace_file = NULL;
Jeff Cody7db16892014-04-25 17:02:32 -04004172 int c;
Jeff Cody7db16892014-04-25 17:02:32 -04004173 static const struct option long_options[] = {
4174 {"help", no_argument, 0, 'h'},
Denis V. Lunev10985132016-06-17 17:44:13 +03004175 {"version", no_argument, 0, 'V'},
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03004176 {"trace", required_argument, NULL, 'T'},
Jeff Cody7db16892014-04-25 17:02:32 -04004177 {0, 0, 0, 0}
4178 };
bellardea2384d2004-08-01 21:59:26 +00004179
MORITA Kazutaka526eda12013-07-23 17:30:11 +09004180#ifdef CONFIG_POSIX
4181 signal(SIGPIPE, SIG_IGN);
4182#endif
4183
Daniel P. Berrangefe4db842016-10-04 14:35:52 +01004184 module_call_init(MODULE_INIT_TRACE);
Kevin Wolf53f76e52010-12-16 15:10:32 +01004185 error_set_progname(argv[0]);
Fam Zheng10f5bff2014-02-10 14:48:51 +08004186 qemu_init_exec_dir(argv[0]);
Kevin Wolf53f76e52010-12-16 15:10:32 +01004187
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03004188 if (qemu_init_main_loop(&local_error)) {
Markus Armbruster565f65d2015-02-12 13:55:05 +01004189 error_report_err(local_error);
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +03004190 exit(EXIT_FAILURE);
4191 }
4192
Eduardo Habkoste8f2d272016-05-12 11:10:04 -03004193 qcrypto_init(&error_fatal);
Daniel P. Berrangec2297082016-04-06 12:12:06 +01004194
Daniel P. Berrange064097d2016-02-10 18:41:01 +00004195 module_call_init(MODULE_INIT_QOM);
bellardea2384d2004-08-01 21:59:26 +00004196 bdrv_init();
Fam Zhengac1307a2014-04-22 13:36:11 +08004197 if (argc < 2) {
4198 error_exit("Not enough arguments");
4199 }
Stuart Brady153859b2009-06-07 00:42:17 +01004200
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004201 qemu_add_opts(&qemu_object_opts);
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +00004202 qemu_add_opts(&qemu_source_opts);
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03004203 qemu_add_opts(&qemu_trace_opts);
Daniel P. Berrange3babeb12016-02-17 10:10:17 +00004204
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03004205 while ((c = getopt_long(argc, argv, "+hVT:", long_options, NULL)) != -1) {
Denis V. Lunev10985132016-06-17 17:44:13 +03004206 switch (c) {
4207 case 'h':
4208 help();
4209 return 0;
4210 case 'V':
4211 printf(QEMU_IMG_VERSION);
4212 return 0;
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03004213 case 'T':
4214 g_free(trace_file);
4215 trace_file = trace_opt_parse(optarg);
4216 break;
Stuart Brady153859b2009-06-07 00:42:17 +01004217 }
bellardea2384d2004-08-01 21:59:26 +00004218 }
Stuart Brady153859b2009-06-07 00:42:17 +01004219
Denis V. Lunev10985132016-06-17 17:44:13 +03004220 cmdname = argv[optind];
Jeff Cody7db16892014-04-25 17:02:32 -04004221
Denis V. Lunev10985132016-06-17 17:44:13 +03004222 /* reset getopt_long scanning */
4223 argc -= optind;
4224 if (argc < 1) {
Jeff Cody5f6979c2014-04-28 14:37:18 -04004225 return 0;
4226 }
Denis V. Lunev10985132016-06-17 17:44:13 +03004227 argv += optind;
Denis V. Lunevcfef6a42016-07-04 16:16:48 +03004228 optind = 0;
Denis V. Lunev10985132016-06-17 17:44:13 +03004229
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +03004230 if (!trace_init_backends()) {
4231 exit(1);
4232 }
4233 trace_init_file(trace_file);
4234 qemu_set_log(LOG_TRACE);
4235
Denis V. Lunev10985132016-06-17 17:44:13 +03004236 /* find the command */
4237 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
4238 if (!strcmp(cmdname, cmd->name)) {
4239 return cmd->handler(argc, argv);
4240 }
4241 }
Jeff Cody7db16892014-04-25 17:02:32 -04004242
Stuart Brady153859b2009-06-07 00:42:17 +01004243 /* not found */
Fam Zhengac1307a2014-04-22 13:36:11 +08004244 error_exit("Command not found: %s", cmdname);
bellardea2384d2004-08-01 21:59:26 +00004245}