qemu-img.c 145.2 KB
Newer Older
B
bellard 已提交
1
/*
B
bellard 已提交
2
 * QEMU disk image utility
3
 *
B
bellard 已提交
4
 * Copyright (c) 2003-2008 Fabrice Bellard
5
 *
B
bellard 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
24

P
Peter Maydell 已提交
25
#include "qemu/osdep.h"
26 27
#include <getopt.h>

28
#include "qemu-version.h"
29
#include "qapi/error.h"
30
#include "qapi/qapi-visit-block-core.h"
31
#include "qapi/qobject-output-visitor.h"
32
#include "qapi/qmp/qjson.h"
33
#include "qapi/qmp/qdict.h"
34
#include "qapi/qmp/qstring.h"
35
#include "qemu/cutils.h"
36
#include "qemu/config-file.h"
37 38
#include "qemu/option.h"
#include "qemu/error-report.h"
39
#include "qemu/log.h"
40
#include "qom/object_interfaces.h"
41
#include "sysemu/sysemu.h"
M
Markus Armbruster 已提交
42
#include "sysemu/block-backend.h"
43
#include "block/block_int.h"
M
Max Reitz 已提交
44
#include "block/blockjob.h"
45
#include "block/qapi.h"
46
#include "crypto/init.h"
47
#include "trace/control.h"
48

49
#define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
50
                          "\n" QEMU_COPYRIGHT "\n"
51

A
Anthony Liguori 已提交
52
typedef struct img_cmd_t {
53 54
    const char *name;
    int (*handler)(int argc, char **argv);
A
Anthony Liguori 已提交
55
} img_cmd_t;
56

57 58 59
enum {
    OPTION_OUTPUT = 256,
    OPTION_BACKING_CHAIN = 257,
60
    OPTION_OBJECT = 258,
61
    OPTION_IMAGE_OPTS = 259,
K
Kevin Wolf 已提交
62
    OPTION_PATTERN = 260,
63 64
    OPTION_FLUSH_INTERVAL = 261,
    OPTION_NO_DRAIN = 262,
65
    OPTION_TARGET_IMAGE_OPTS = 263,
66
    OPTION_SIZE = 264,
67
    OPTION_PREALLOCATION = 265,
68
    OPTION_SHRINK = 266,
69 70 71 72 73 74 75
};

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

76
/* Default to cache=writeback as data integrity is not important for qemu-img */
77
#define BDRV_DEFAULT_CACHE "writeback"
78

79
static void format_print(void *opaque, const char *name)
B
bellard 已提交
80
{
81
    printf(" %s", name);
B
bellard 已提交
82 83
}

F
Fam Zheng 已提交
84 85 86 87 88 89 90 91 92 93 94 95 96 97
static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
{
    va_list ap;

    error_printf("qemu-img: ");

    va_start(ap, fmt);
    error_vprintf(fmt, ap);
    va_end(ap);

    error_printf("\nTry 'qemu-img --help' for more information\n");
    exit(EXIT_FAILURE);
}

98 99 100 101 102 103 104 105 106 107
static void QEMU_NORETURN missing_argument(const char *option)
{
    error_exit("missing argument for option '%s'", option);
}

static void QEMU_NORETURN unrecognized_option(const char *option)
{
    error_exit("unrecognized option '%s'", option);
}

B
blueswir1 已提交
108
/* Please keep in synch with qemu-img.texi */
F
Fam Zheng 已提交
109
static void QEMU_NORETURN help(void)
B
bellard 已提交
110
{
111
    const char *help_msg =
112
           QEMU_IMG_VERSION
113
           "usage: qemu-img [standard options] command [command options]\n"
114 115
           "QEMU disk image utility\n"
           "\n"
116 117
           "    '-h', '--help'       display this help and exit\n"
           "    '-V', '--version'    output version information and exit\n"
118 119
           "    '-T', '--trace'      [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
           "                         specify tracing options\n"
120
           "\n"
121
           "Command syntax:\n"
122 123 124 125
#define DEF(option, callback, arg_string)        \
           "  " arg_string "\n"
#include "qemu-img-cmds.h"
#undef DEF
126 127 128
           "\n"
           "Command parameters:\n"
           "  'filename' is a disk image filename\n"
129 130 131 132
           "  'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
           "    manual page for a description of the object properties. The most common\n"
           "    object type is a 'secret', which is used to supply passwords and/or\n"
           "    encryption keys.\n"
133
           "  'fmt' is the disk image format. It is guessed automatically in most cases\n"
134
           "  'cache' is the cache mode used to write the output disk image, the valid\n"
135 136
           "    options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
           "    'directsync' and 'unsafe' (default for convert)\n"
137 138
           "  'src_cache' is the cache mode used to read input disk images, the valid\n"
           "    options are the same as for the 'cache' option\n"
139
           "  'size' is the disk image size in bytes. Optional suffixes\n"
140 141 142
           "    'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
           "    'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P)  are\n"
           "    supported. 'b' is ignored.\n"
143 144 145 146 147
           "  'output_filename' is the destination disk image filename\n"
           "  'output_fmt' is the destination format\n"
           "  'options' is a comma separated list of format specific options in a\n"
           "    name=value format. Use -o ? for an overview of the options supported by the\n"
           "    used format\n"
148 149 150
           "  'snapshot_param' is param used for internal snapshot, format\n"
           "    is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
           "    '[ID_OR_NAME]'\n"
151
           "  '-c' indicates that target image must be compressed (qcow format only)\n"
152 153 154 155 156
           "  '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
           "       new backing file match exactly. The image doesn't need a working\n"
           "       backing file before rebasing in this case (useful for renaming the\n"
           "       backing file). For image creation, allow creating without attempting\n"
           "       to open the backing file.\n"
157
           "  '-h' with or without a command shows this help and lists the supported formats\n"
158
           "  '-p' show progress of command (only certain commands)\n"
159
           "  '-q' use Quiet mode - do not print any output (except errors)\n"
160 161 162 163 164
           "  '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
           "       contain only zeros for qemu-img to create a sparse image during\n"
           "       conversion. If the number of bytes is 0, the source will not be scanned for\n"
           "       unallocated or zero sectors, and the destination image will always be\n"
           "       fully allocated\n"
165
           "  '--output' takes the format in which the output must be done (human or json)\n"
166 167
           "  '-n' skips the target volume creation (useful if the volume is created\n"
           "       prior to running qemu-img)\n"
168
           "\n"
169 170 171 172
           "Parameters to check subcommand:\n"
           "  '-r' tries to repair any inconsistencies that are found during the check.\n"
           "       '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
           "       kinds of errors, with a higher risk of choosing the wrong fix or\n"
173
           "       hiding corruption that has already occurred.\n"
174
           "\n"
P
Peter Lieven 已提交
175 176 177 178 179
           "Parameters to convert subcommand:\n"
           "  '-m' specifies how many coroutines work in parallel during the convert\n"
           "       process (defaults to 8)\n"
           "  '-W' allow to write to the target out of order rather than sequential\n"
           "\n"
180 181 182 183 184
           "Parameters to snapshot subcommand:\n"
           "  'snapshot' is the name of the snapshot to create, apply or delete\n"
           "  '-a' applies a snapshot (revert disk to saved state)\n"
           "  '-c' creates a snapshot\n"
           "  '-d' deletes a snapshot\n"
185 186 187 188 189
           "  '-l' lists all snapshots in the given image\n"
           "\n"
           "Parameters to compare subcommand:\n"
           "  '-f' first image format\n"
           "  '-F' second image format\n"
R
Reda Sallahi 已提交
190 191 192 193 194 195 196
           "  '-s' run in Strict mode - fail on different image size or sector allocation\n"
           "\n"
           "Parameters to dd subcommand:\n"
           "  'bs=BYTES' read and write up to BYTES bytes at a time "
           "(default: 512)\n"
           "  'count=N' copy only N input blocks\n"
           "  'if=FILE' read from FILE\n"
R
Reda Sallahi 已提交
197 198
           "  'of=FILE' write to FILE\n"
           "  'skip=N' skip N bs-sized blocks at the start of input\n";
199 200

    printf("%s\nSupported formats:", help_msg);
201
    bdrv_iterate_format(format_print, NULL);
202
    printf("\n\n" QEMU_HELP_BOTTOM "\n");
F
Fam Zheng 已提交
203
    exit(EXIT_SUCCESS);
B
bellard 已提交
204 205
}

206 207 208 209 210 211 212 213 214
static QemuOptsList qemu_object_opts = {
    .name = "object",
    .implied_opt_name = "qom-type",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
    .desc = {
        { }
    },
};

215 216 217 218 219 220 221 222 223
static QemuOptsList qemu_source_opts = {
    .name = "source",
    .implied_opt_name = "file",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
    .desc = {
        { }
    },
};

S
Stefan Weil 已提交
224
static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
225 226 227 228 229 230 231 232 233 234 235
{
    int ret = 0;
    if (!quiet) {
        va_list args;
        va_start(args, fmt);
        ret = vprintf(fmt, args);
        va_end(args);
    }
    return ret;
}

B
bellard 已提交
236

237 238 239
static int print_block_option_help(const char *filename, const char *fmt)
{
    BlockDriver *drv, *proto_drv;
240
    QemuOptsList *create_opts = NULL;
241
    Error *local_err = NULL;
242 243 244 245

    /* Find driver and parse its options */
    drv = bdrv_find_format(fmt);
    if (!drv) {
246
        error_report("Unknown file format '%s'", fmt);
247 248 249
        return 1;
    }

250 251 252 253 254
    if (!drv->create_opts) {
        error_report("Format driver '%s' does not support image creation", fmt);
        return 1;
    }

C
Chunyan Liu 已提交
255
    create_opts = qemu_opts_append(create_opts, drv->create_opts);
256
    if (filename) {
257
        proto_drv = bdrv_find_protocol(filename, true, &local_err);
258
        if (!proto_drv) {
259
            error_report_err(local_err);
260
            qemu_opts_free(create_opts);
261 262
            return 1;
        }
263
        if (!proto_drv->create_opts) {
M
Max Reitz 已提交
264
            error_report("Protocol driver '%s' does not support image creation",
265
                         proto_drv->format_name);
M
Max Reitz 已提交
266
            qemu_opts_free(create_opts);
267 268
            return 1;
        }
C
Chunyan Liu 已提交
269
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
270 271
    }

272
    printf("Supported options:\n");
M
Max Reitz 已提交
273
    qemu_opts_print_help(create_opts, false);
274
    qemu_opts_free(create_opts);
275 276 277
    return 0;
}

278

279
static BlockBackend *img_open_opts(const char *optstr,
280
                                   QemuOpts *opts, int flags, bool writethrough,
281
                                   bool quiet, bool force_share)
282 283 284 285 286
{
    QDict *options;
    Error *local_err = NULL;
    BlockBackend *blk;
    options = qemu_opts_to_qdict(opts, NULL);
287 288
    if (force_share) {
        if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
289
            && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
290
            error_report("--force-share/-U conflicts with image options");
291
            qobject_unref(options);
292 293
            return NULL;
        }
294
        qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
295
    }
296
    blk = blk_new_open(NULL, NULL, options, flags, &local_err);
297
    if (!blk) {
298
        error_reportf_err(local_err, "Could not open '%s': ", optstr);
299 300
        return NULL;
    }
301
    blk_set_enable_write_cache(blk, !writethrough);
302 303 304 305

    return blk;
}

306
static BlockBackend *img_open_file(const char *filename,
307
                                   QDict *options,
308
                                   const char *fmt, int flags,
309 310
                                   bool writethrough, bool quiet,
                                   bool force_share)
311 312
{
    BlockBackend *blk;
313
    Error *local_err = NULL;
314

315 316 317
    if (!options) {
        options = qdict_new();
    }
318
    if (fmt) {
319
        qdict_put_str(options, "driver", fmt);
320
    }
321

322
    if (force_share) {
323
        qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
324
    }
325
    blk = blk_new_open(filename, NULL, options, flags, &local_err);
326
    if (!blk) {
327
        error_reportf_err(local_err, "Could not open '%s': ", filename);
328
        return NULL;
329
    }
330
    blk_set_enable_write_cache(blk, !writethrough);
331

332 333 334 335
    return blk;
}


336 337 338 339 340 341 342
static int img_add_key_secrets(void *opaque,
                               const char *name, const char *value,
                               Error **errp)
{
    QDict *options = opaque;

    if (g_str_has_suffix(name, "key-secret")) {
343
        qdict_put_str(options, name, value);
344 345 346 347 348 349
    }

    return 0;
}


350
static BlockBackend *img_open(bool image_opts,
351
                              const char *filename,
352
                              const char *fmt, int flags, bool writethrough,
353
                              bool quiet, bool force_share)
354 355 356 357 358 359 360 361 362 363 364 365 366
{
    BlockBackend *blk;
    if (image_opts) {
        QemuOpts *opts;
        if (fmt) {
            error_report("--image-opts and --format are mutually exclusive");
            return NULL;
        }
        opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
                                       filename, true);
        if (!opts) {
            return NULL;
        }
367 368
        blk = img_open_opts(filename, opts, flags, writethrough, quiet,
                            force_share);
369
    } else {
370
        blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
371
                            force_share);
372
    }
373
    return blk;
374 375
}

376

377
static int add_old_style_options(const char *fmt, QemuOpts *opts,
378 379
                                 const char *base_filename,
                                 const char *base_fmt)
380
{
381 382
    Error *err = NULL;

383
    if (base_filename) {
384
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
385
        if (err) {
386 387
            error_report("Backing file not supported for file format '%s'",
                         fmt);
388
            error_free(err);
389
            return -1;
390 391 392
        }
    }
    if (base_fmt) {
393
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
394
        if (err) {
395 396
            error_report("Backing file format not supported for file "
                         "format '%s'", fmt);
397
            error_free(err);
398
            return -1;
399 400
        }
    }
401
    return 0;
402 403
}

404 405
static int64_t cvtnum(const char *s)
{
406
    int err;
407
    uint64_t value;
408

409 410 411 412
    err = qemu_strtosz(s, NULL, &value);
    if (err < 0) {
        return err;
    }
413 414 415
    if (value > INT64_MAX) {
        return -ERANGE;
    }
416
    return value;
417 418
}

B
bellard 已提交
419 420
static int img_create(int argc, char **argv)
{
421
    int c;
422
    uint64_t img_size = -1;
B
bellard 已提交
423
    const char *fmt = "raw";
424
    const char *base_fmt = NULL;
B
bellard 已提交
425 426
    const char *filename;
    const char *base_filename = NULL;
427
    char *options = NULL;
428
    Error *local_err = NULL;
429
    bool quiet = false;
430
    int flags = 0;
431

B
bellard 已提交
432
    for(;;) {
433 434 435 436 437
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
            {0, 0, 0, 0}
        };
438
        c = getopt_long(argc, argv, ":F:b:f:ho:qu",
439
                        long_options, NULL);
440
        if (c == -1) {
B
bellard 已提交
441
            break;
442
        }
B
bellard 已提交
443
        switch(c) {
444 445 446
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
447
        case '?':
448 449
            unrecognized_option(argv[optind - 1]);
            break;
B
bellard 已提交
450 451 452
        case 'h':
            help();
            break;
453 454 455
        case 'F':
            base_fmt = optarg;
            break;
B
bellard 已提交
456 457 458 459 460 461
        case 'b':
            base_filename = optarg;
            break;
        case 'f':
            fmt = optarg;
            break;
462
        case 'o':
463 464 465 466 467 468 469 470 471 472 473
            if (!is_valid_option_list(optarg)) {
                error_report("Invalid option list: %s", optarg);
                goto fail;
            }
            if (!options) {
                options = g_strdup(optarg);
            } else {
                char *old_options = options;
                options = g_strdup_printf("%s,%s", options, optarg);
                g_free(old_options);
            }
474
            break;
475 476 477
        case 'q':
            quiet = true;
            break;
478 479 480
        case 'u':
            flags |= BDRV_O_NO_BACKING;
            break;
481 482 483 484 485 486 487 488
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                goto fail;
            }
        }   break;
B
bellard 已提交
489 490
        }
    }
491

492
    /* Get the filename */
493 494 495 496 497 498
    filename = (optind < argc) ? argv[optind] : NULL;
    if (options && has_help_option(options)) {
        g_free(options);
        return print_block_option_help(filename, fmt);
    }

499
    if (optind >= argc) {
F
Fam Zheng 已提交
500
        error_exit("Expecting image file name");
501
    }
502
    optind++;
503

504 505
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
506
                          NULL, &error_fatal)) {
507 508 509
        goto fail;
    }

510 511
    /* Get image size, if specified */
    if (optind < argc) {
512
        int64_t sval;
513 514 515

        sval = cvtnum(argv[optind++]);
        if (sval < 0) {
516 517 518 519
            if (sval == -ERANGE) {
                error_report("Image size must be less than 8 EiB!");
            } else {
                error_report("Invalid image size specified! You may use k, M, "
520 521 522
                      "G, T, P or E suffixes for ");
                error_report("kilobytes, megabytes, gigabytes, terabytes, "
                             "petabytes and exabytes.");
523
            }
524
            goto fail;
525 526 527
        }
        img_size = (uint64_t)sval;
    }
528
    if (optind != argc) {
F
Fam Zheng 已提交
529
        error_exit("Unexpected argument: %s", argv[optind]);
530
    }
531

532
    bdrv_img_create(filename, fmt, base_filename, base_fmt,
533
                    options, img_size, flags, quiet, &local_err);
534
    if (local_err) {
535
        error_reportf_err(local_err, "%s: ", filename);
536
        goto fail;
537
    }
538

539
    g_free(options);
B
bellard 已提交
540
    return 0;
541 542 543 544

fail:
    g_free(options);
    return 1;
B
bellard 已提交
545 546
}

547
static void dump_json_image_check(ImageCheck *check, bool quiet)
548 549 550
{
    QString *str;
    QObject *obj;
551
    Visitor *v = qobject_output_visitor_new(&obj);
552 553 554

    visit_type_ImageCheck(v, NULL, &check, &error_abort);
    visit_complete(v, &obj);
555 556
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
557
    qprintf(quiet, "%s\n", qstring_get_str(str));
558
    qobject_unref(obj);
559
    visit_free(v);
560
    qobject_unref(str);
561 562
}

563
static void dump_human_image_check(ImageCheck *check, bool quiet)
564 565
{
    if (!(check->corruptions || check->leaks || check->check_errors)) {
566
        qprintf(quiet, "No errors were found on the image.\n");
567 568
    } else {
        if (check->corruptions) {
569 570 571 572
            qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
                    "Data may be corrupted, or further writes to the image "
                    "may corrupt it.\n",
                    check->corruptions);
573 574 575
        }

        if (check->leaks) {
576 577 578 579
            qprintf(quiet,
                    "\n%" PRId64 " leaked clusters were found on the image.\n"
                    "This means waste of disk space, but no harm to data.\n",
                    check->leaks);
580 581 582
        }

        if (check->check_errors) {
583 584 585 586
            qprintf(quiet,
                    "\n%" PRId64
                    " internal errors have occurred during the check.\n",
                    check->check_errors);
587 588 589 590
        }
    }

    if (check->total_clusters != 0 && check->allocated_clusters != 0) {
591 592 593 594 595 596 597
        qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
                "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
                check->allocated_clusters, check->total_clusters,
                check->allocated_clusters * 100.0 / check->total_clusters,
                check->fragmented_clusters * 100.0 / check->allocated_clusters,
                check->compressed_clusters * 100.0 /
                check->allocated_clusters);
598 599 600
    }

    if (check->image_end_offset) {
601 602
        qprintf(quiet,
                "Image end offset: %" PRId64 "\n", check->image_end_offset);
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
    }
}

static int collect_image_check(BlockDriverState *bs,
                   ImageCheck *check,
                   const char *filename,
                   const char *fmt,
                   int fix)
{
    int ret;
    BdrvCheckResult result;

    ret = bdrv_check(bs, &result, fix);
    if (ret < 0) {
        return ret;
    }

    check->filename                 = g_strdup(filename);
    check->format                   = g_strdup(bdrv_get_format_name(bs));
    check->check_errors             = result.check_errors;
    check->corruptions              = result.corruptions;
    check->has_corruptions          = result.corruptions != 0;
    check->leaks                    = result.leaks;
    check->has_leaks                = result.leaks != 0;
    check->corruptions_fixed        = result.corruptions_fixed;
    check->has_corruptions_fixed    = result.corruptions != 0;
    check->leaks_fixed              = result.leaks_fixed;
    check->has_leaks_fixed          = result.leaks != 0;
    check->image_end_offset         = result.image_end_offset;
    check->has_image_end_offset     = result.image_end_offset != 0;
    check->total_clusters           = result.bfi.total_clusters;
    check->has_total_clusters       = result.bfi.total_clusters != 0;
    check->allocated_clusters       = result.bfi.allocated_clusters;
    check->has_allocated_clusters   = result.bfi.allocated_clusters != 0;
    check->fragmented_clusters      = result.bfi.fragmented_clusters;
    check->has_fragmented_clusters  = result.bfi.fragmented_clusters != 0;
639 640
    check->compressed_clusters      = result.bfi.compressed_clusters;
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
641 642 643 644

    return 0;
}

645 646 647
/*
 * Checks an image for consistency. Exit codes:
 *
M
Max Reitz 已提交
648 649 650 651 652
 *  0 - Check completed, image is good
 *  1 - Check not completed because of internal errors
 *  2 - Check completed, image is corrupted
 *  3 - Check completed, image has leaked clusters, but is good otherwise
 * 63 - Checks are not supported by the image format
653
 */
654 655 656
static int img_check(int argc, char **argv)
{
    int c, ret;
657
    OutputFormat output_format = OFORMAT_HUMAN;
658
    const char *filename, *fmt, *output, *cache;
M
Markus Armbruster 已提交
659
    BlockBackend *blk;
660
    BlockDriverState *bs;
661
    int fix = 0;
662 663
    int flags = BDRV_O_CHECK;
    bool writethrough;
664
    ImageCheck *check;
665
    bool quiet = false;
666
    bool image_opts = false;
667
    bool force_share = false;
668 669

    fmt = NULL;
670
    output = NULL;
671
    cache = BDRV_DEFAULT_CACHE;
672

673
    for(;;) {
674 675 676 677
        int option_index = 0;
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"format", required_argument, 0, 'f'},
678
            {"repair", required_argument, 0, 'r'},
679
            {"output", required_argument, 0, OPTION_OUTPUT},
680
            {"object", required_argument, 0, OPTION_OBJECT},
681
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
682
            {"force-share", no_argument, 0, 'U'},
683 684
            {0, 0, 0, 0}
        };
685
        c = getopt_long(argc, argv, ":hf:r:T:qU",
686
                        long_options, &option_index);
687
        if (c == -1) {
688
            break;
689
        }
690
        switch(c) {
691 692 693
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
694
        case '?':
695 696
            unrecognized_option(argv[optind - 1]);
            break;
697 698 699 700 701 702
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
703 704 705 706 707 708 709 710
        case 'r':
            flags |= BDRV_O_RDWR;

            if (!strcmp(optarg, "leaks")) {
                fix = BDRV_FIX_LEAKS;
            } else if (!strcmp(optarg, "all")) {
                fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
            } else {
F
Fam Zheng 已提交
711 712
                error_exit("Unknown option value for -r "
                           "(expecting 'leaks' or 'all'): %s", optarg);
713 714
            }
            break;
715 716 717
        case OPTION_OUTPUT:
            output = optarg;
            break;
718 719 720
        case 'T':
            cache = optarg;
            break;
721 722 723
        case 'q':
            quiet = true;
            break;
724 725 726
        case 'U':
            force_share = true;
            break;
727 728 729 730 731 732 733 734
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
735 736 737
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
738 739
        }
    }
740
    if (optind != argc - 1) {
F
Fam Zheng 已提交
741
        error_exit("Expecting one image file name");
742
    }
743 744
    filename = argv[optind++];

745 746 747 748 749 750 751 752 753
    if (output && !strcmp(output, "json")) {
        output_format = OFORMAT_JSON;
    } else if (output && !strcmp(output, "human")) {
        output_format = OFORMAT_HUMAN;
    } else if (output) {
        error_report("--output must be used with human or json as argument.");
        return 1;
    }

754 755
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
756
                          NULL, &error_fatal)) {
757 758 759
        return 1;
    }

760
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
761 762 763 764 765
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        return 1;
    }

766 767
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   force_share);
768 769
    if (!blk) {
        return 1;
770
    }
771
    bs = blk_bs(blk);
772 773 774

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
775 776

    if (ret == -ENOTSUP) {
777
        error_report("This image format does not support checks");
778
        ret = 63;
779
        goto fail;
780 781
    }

782 783
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
784

785 786
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
787

788
        if (output_format == OFORMAT_HUMAN) {
789 790 791 792 793 794 795
            qprintf(quiet,
                    "The following inconsistencies were found and repaired:\n\n"
                    "    %" PRId64 " leaked clusters\n"
                    "    %" PRId64 " corruptions\n\n"
                    "Double checking the fixed image now...\n",
                    check->leaks_fixed,
                    check->corruptions_fixed);
796 797
        }

798
        ret = collect_image_check(bs, check, filename, fmt, 0);
799

800 801
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
802 803
    }

M
Max Reitz 已提交
804 805 806 807 808 809 810 811 812
    if (!ret) {
        switch (output_format) {
        case OFORMAT_HUMAN:
            dump_human_image_check(check, quiet);
            break;
        case OFORMAT_JSON:
            dump_json_image_check(check, quiet);
            break;
        }
813 814
    }

815
    if (ret || check->check_errors) {
M
Max Reitz 已提交
816 817 818 819 820
        if (ret) {
            error_report("Check failed: %s", strerror(-ret));
        } else {
            error_report("Check failed");
        }
821 822
        ret = 1;
        goto fail;
823
    }
824

825 826 827 828
    if (check->corruptions) {
        ret = 2;
    } else if (check->leaks) {
        ret = 3;
829
    } else {
830
        ret = 0;
831
    }
832 833 834

fail:
    qapi_free_ImageCheck(check);
M
Markus Armbruster 已提交
835
    blk_unref(blk);
836
    return ret;
837 838
}

M
Max Reitz 已提交
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
typedef struct CommonBlockJobCBInfo {
    BlockDriverState *bs;
    Error **errp;
} CommonBlockJobCBInfo;

static void common_block_job_cb(void *opaque, int ret)
{
    CommonBlockJobCBInfo *cbi = opaque;

    if (ret < 0) {
        error_setg_errno(cbi->errp, -ret, "Block job failed");
    }
}

static void run_block_job(BlockJob *job, Error **errp)
{
K
Kevin Wolf 已提交
855
    AioContext *aio_context = blk_get_aio_context(job->blk);
856
    int ret = 0;
M
Max Reitz 已提交
857

858
    aio_context_acquire(aio_context);
K
Kevin Wolf 已提交
859
    job_ref(&job->job);
M
Max Reitz 已提交
860
    do {
K
Kevin Wolf 已提交
861
        float progress = 0.0f;
M
Max Reitz 已提交
862
        aio_poll(aio_context, true);
K
Kevin Wolf 已提交
863 864 865 866 867
        if (job->job.progress_total) {
            progress = (float)job->job.progress_current /
                       job->job.progress_total * 100.f;
        }
        qemu_progress_print(progress, 0);
K
Kevin Wolf 已提交
868
    } while (!job_is_ready(&job->job) && !job_is_completed(&job->job));
M
Max Reitz 已提交
869

870
    if (!job_is_completed(&job->job)) {
871
        ret = job_complete_sync(&job->job, errp);
872
    } else {
873
        ret = job->job.ret;
874
    }
K
Kevin Wolf 已提交
875
    job_unref(&job->job);
876
    aio_context_release(aio_context);
877

878 879 880 881
    /* publish completion progress only when success */
    if (!ret) {
        qemu_progress_print(100.f, 0);
    }
M
Max Reitz 已提交
882 883
}

B
bellard 已提交
884 885
static int img_commit(int argc, char **argv)
{
886
    int c, ret, flags;
887
    const char *filename, *fmt, *cache, *base;
M
Markus Armbruster 已提交
888
    BlockBackend *blk;
M
Max Reitz 已提交
889
    BlockDriverState *bs, *base_bs;
890
    BlockJob *job;
891
    bool progress = false, quiet = false, drop = false;
892
    bool writethrough;
M
Max Reitz 已提交
893 894
    Error *local_err = NULL;
    CommonBlockJobCBInfo cbi;
895
    bool image_opts = false;
896
    AioContext *aio_context;
B
bellard 已提交
897 898

    fmt = NULL;
899
    cache = BDRV_DEFAULT_CACHE;
900
    base = NULL;
B
bellard 已提交
901
    for(;;) {
902 903 904
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
905
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
906 907
            {0, 0, 0, 0}
        };
908
        c = getopt_long(argc, argv, ":f:ht:b:dpq",
909
                        long_options, NULL);
910
        if (c == -1) {
B
bellard 已提交
911
            break;
912
        }
B
bellard 已提交
913
        switch(c) {
914 915 916
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
917
        case '?':
918 919
            unrecognized_option(argv[optind - 1]);
            break;
B
bellard 已提交
920 921 922 923 924 925
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
926 927 928
        case 't':
            cache = optarg;
            break;
929 930 931 932 933
        case 'b':
            base = optarg;
            /* -b implies -d */
            drop = true;
            break;
M
Max Reitz 已提交
934 935 936
        case 'd':
            drop = true;
            break;
937 938 939
        case 'p':
            progress = true;
            break;
940 941 942
        case 'q':
            quiet = true;
            break;
943 944 945 946 947 948 949 950
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
951 952 953
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
B
bellard 已提交
954 955
        }
    }
956 957 958 959 960 961

    /* Progress is not shown in Quiet mode */
    if (quiet) {
        progress = false;
    }

962
    if (optind != argc - 1) {
F
Fam Zheng 已提交
963
        error_exit("Expecting one image file name");
964
    }
B
bellard 已提交
965 966
    filename = argv[optind++];

967 968
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
969
                          NULL, &error_fatal)) {
970 971 972
        return 1;
    }

M
Max Reitz 已提交
973
    flags = BDRV_O_RDWR | BDRV_O_UNMAP;
974
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
975 976
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
977
        return 1;
978 979
    }

980 981
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   false);
982 983
    if (!blk) {
        return 1;
984
    }
985 986
    bs = blk_bs(blk);

987 988 989
    qemu_progress_init(progress, 1.f);
    qemu_progress_print(0.f, 100);

990 991 992
    if (base) {
        base_bs = bdrv_find_backing_image(bs, base);
        if (!base_bs) {
993 994 995
            error_setg(&local_err,
                       "Did not find '%s' in the backing chain of '%s'",
                       base, filename);
996 997 998 999 1000 1001
            goto done;
        }
    } else {
        /* This is different from QMP, which by default uses the deepest file in
         * the backing chain (i.e., the very base); however, the traditional
         * behavior of qemu-img commit is using the immediate backing file. */
1002
        base_bs = backing_bs(bs);
1003 1004 1005 1006
        if (!base_bs) {
            error_setg(&local_err, "Image does not have a backing file");
            goto done;
        }
M
Max Reitz 已提交
1007 1008 1009 1010 1011 1012 1013
    }

    cbi = (CommonBlockJobCBInfo){
        .errp = &local_err,
        .bs   = bs,
    };

1014 1015
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);
1016
    commit_active_start("commit", bs, base_bs, JOB_DEFAULT, 0,
1017
                        BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
1018
                        &cbi, false, &local_err);
1019
    aio_context_release(aio_context);
M
Max Reitz 已提交
1020 1021
    if (local_err) {
        goto done;
B
bellard 已提交
1022 1023
    }

1024 1025 1026 1027
    /* When the block job completes, the BlockBackend reference will point to
     * the old backing file. In order to avoid that the top image is already
     * deleted, so we can still empty it afterwards, increment the reference
     * counter here preemptively. */
M
Max Reitz 已提交
1028
    if (!drop) {
1029
        bdrv_ref(bs);
M
Max Reitz 已提交
1030 1031
    }

1032
    job = block_job_get("commit");
1033
    assert(job);
1034
    run_block_job(job, &local_err);
M
Max Reitz 已提交
1035 1036 1037 1038
    if (local_err) {
        goto unref_backing;
    }

1039 1040
    if (!drop && bs->drv->bdrv_make_empty) {
        ret = bs->drv->bdrv_make_empty(bs);
M
Max Reitz 已提交
1041 1042 1043 1044 1045 1046 1047 1048 1049
        if (ret) {
            error_setg_errno(&local_err, -ret, "Could not empty %s",
                             filename);
            goto unref_backing;
        }
    }

unref_backing:
    if (!drop) {
1050
        bdrv_unref(bs);
M
Max Reitz 已提交
1051
    }
M
Max Reitz 已提交
1052 1053

done:
1054 1055
    qemu_progress_end();

M
Markus Armbruster 已提交
1056
    blk_unref(blk);
M
Max Reitz 已提交
1057 1058

    if (local_err) {
1059
        error_report_err(local_err);
1060 1061
        return 1;
    }
M
Max Reitz 已提交
1062 1063

    qprintf(quiet, "Image committed.\n");
B
bellard 已提交
1064 1065 1066
    return 0;
}

E
Eric Blake 已提交
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
/*
 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
 * of the first sector boundary within buf where the sector contains a
 * non-zero byte.  This function is robust to a buffer that is not
 * sector-aligned.
 */
static int64_t find_nonzero(const uint8_t *buf, int64_t n)
{
    int64_t i;
    int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);

    for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
        if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
            return i;
        }
    }
    if (i < n && !buffer_is_zero(buf + i, n - end)) {
        return i;
    }
    return -1;
}

1089 1090 1091 1092 1093 1094
/*
 * Returns true iff the first sector pointed to by 'buf' contains at least
 * a non-NUL byte.
 *
 * 'pnum' is set to the number of sectors (including and immediately following
 * the first one) that are known to be in the same allocated/unallocated state.
1095 1096 1097
 * The function will try to align the end offset to alignment boundaries so
 * that the request will at least end aligned and consequtive requests will
 * also start at an aligned offset.
1098
 */
1099 1100
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
                                int64_t sector_num, int alignment)
B
bellard 已提交
1101
{
1102
    bool is_zero;
1103
    int i, tail;
B
bellard 已提交
1104 1105 1106 1107 1108

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
1109
    is_zero = buffer_is_zero(buf, 512);
B
bellard 已提交
1110 1111
    for(i = 1; i < n; i++) {
        buf += 512;
1112
        if (is_zero != buffer_is_zero(buf, 512)) {
B
bellard 已提交
1113
            break;
1114
        }
B
bellard 已提交
1115
    }
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132

    tail = (sector_num + i) & (alignment - 1);
    if (tail) {
        if (is_zero && i <= tail) {
            /* treat unallocated areas which only consist
             * of a small tail as allocated. */
            is_zero = false;
        }
        if (!is_zero) {
            /* align up end offset of allocated areas. */
            i += alignment - tail;
            i = MIN(i, n);
        } else {
            /* align down end offset of zero areas. */
            i -= tail;
        }
    }
B
bellard 已提交
1133
    *pnum = i;
1134
    return !is_zero;
B
bellard 已提交
1135 1136
}

1137 1138 1139 1140 1141 1142
/*
 * Like is_allocated_sectors, but if the buffer starts with a used sector,
 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
 * breaking up write requests for only small sparse areas.
 */
static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
1143
    int min, int64_t sector_num, int alignment)
1144 1145 1146 1147 1148 1149 1150 1151
{
    int ret;
    int num_checked, num_used;

    if (n < min) {
        min = n;
    }

1152
    ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
1153 1154 1155 1156 1157 1158 1159
    if (!ret) {
        return ret;
    }

    num_used = *pnum;
    buf += BDRV_SECTOR_SIZE * *pnum;
    n -= *pnum;
1160
    sector_num += *pnum;
1161 1162 1163
    num_checked = num_used;

    while (n > 0) {
1164
        ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
1165 1166 1167

        buf += BDRV_SECTOR_SIZE * *pnum;
        n -= *pnum;
1168
        sector_num += *pnum;
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
        num_checked += *pnum;
        if (ret) {
            num_used = num_checked;
        } else if (*pnum >= min) {
            break;
        }
    }

    *pnum = num_used;
    return 1;
}

K
Kevin Wolf 已提交
1181
/*
1182 1183
 * Compares two buffers sector by sector. Returns 0 if the first
 * sector of each buffer matches, non-zero otherwise.
K
Kevin Wolf 已提交
1184
 *
1185 1186
 * pnum is set to the sector-aligned size of the buffer prefix that
 * has the same matching status as the first sector.
K
Kevin Wolf 已提交
1187
 */
1188 1189
static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
                           int64_t bytes, int64_t *pnum)
K
Kevin Wolf 已提交
1190
{
1191
    bool res;
1192
    int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
K
Kevin Wolf 已提交
1193

1194
    assert(bytes > 0);
K
Kevin Wolf 已提交
1195

1196 1197 1198
    res = !!memcmp(buf1, buf2, i);
    while (i < bytes) {
        int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
K
Kevin Wolf 已提交
1199

1200
        if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
K
Kevin Wolf 已提交
1201 1202
            break;
        }
1203
        i += len;
K
Kevin Wolf 已提交
1204 1205 1206 1207 1208 1209
    }

    *pnum = i;
    return res;
}

1210
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
1211

1212 1213 1214
/*
 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
 *
1215 1216 1217 1218
 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
 * failure), and 4 on error (the exit status for read errors), after emitting
 * an error message.
1219
 *
1220
 * @param blk:  BlockBackend for the image
1221 1222
 * @param offset: Starting offset to check
 * @param bytes: Number of bytes to check
1223 1224 1225 1226
 * @param filename: Name of disk file we are checking (logging purpose)
 * @param buffer: Allocated buffer for storing read data
 * @param quiet: Flag for quiet mode
 */
1227 1228
static int check_empty_sectors(BlockBackend *blk, int64_t offset,
                               int64_t bytes, const char *filename,
1229 1230
                               uint8_t *buffer, bool quiet)
{
E
Eric Blake 已提交
1231 1232 1233
    int ret = 0;
    int64_t idx;

1234
    ret = blk_pread(blk, offset, buffer, bytes);
1235 1236
    if (ret < 0) {
        error_report("Error while reading offset %" PRId64 " of %s: %s",
1237
                     offset, filename, strerror(-ret));
1238
        return 4;
1239
    }
1240
    idx = find_nonzero(buffer, bytes);
E
Eric Blake 已提交
1241
    if (idx >= 0) {
1242
        qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1243
                offset + idx);
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
        return 1;
    }

    return 0;
}

/*
 * Compares two images. Exit codes:
 *
 * 0 - Images are identical
 * 1 - Images differ
 * >1 - Error occurred
 */
static int img_compare(int argc, char **argv)
{
1259
    const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
M
Markus Armbruster 已提交
1260
    BlockBackend *blk1, *blk2;
1261
    BlockDriverState *bs1, *bs2;
1262
    int64_t total_size1, total_size2;
1263
    uint8_t *buf1 = NULL, *buf2 = NULL;
1264
    int64_t pnum1, pnum2;
1265 1266 1267
    int allocated1, allocated2;
    int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
    bool progress = false, quiet = false, strict = false;
1268
    int flags;
1269
    bool writethrough;
1270 1271 1272
    int64_t total_size;
    int64_t offset = 0;
    int64_t chunk;
1273
    int c;
1274
    uint64_t progress_base;
1275
    bool image_opts = false;
1276
    bool force_share = false;
1277

1278
    cache = BDRV_DEFAULT_CACHE;
1279
    for (;;) {
1280 1281 1282
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
1283
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1284
            {"force-share", no_argument, 0, 'U'},
1285 1286
            {0, 0, 0, 0}
        };
1287
        c = getopt_long(argc, argv, ":hf:F:T:pqsU",
1288
                        long_options, NULL);
1289 1290 1291 1292
        if (c == -1) {
            break;
        }
        switch (c) {
1293 1294 1295
        case ':':
            missing_argument(argv[optind - 1]);
            break;
1296
        case '?':
1297 1298
            unrecognized_option(argv[optind - 1]);
            break;
1299 1300 1301 1302 1303 1304 1305 1306 1307
        case 'h':
            help();
            break;
        case 'f':
            fmt1 = optarg;
            break;
        case 'F':
            fmt2 = optarg;
            break;
1308 1309 1310
        case 'T':
            cache = optarg;
            break;
1311 1312 1313 1314 1315 1316 1317 1318 1319
        case 'p':
            progress = true;
            break;
        case 'q':
            quiet = true;
            break;
        case 's':
            strict = true;
            break;
1320 1321 1322
        case 'U':
            force_share = true;
            break;
1323 1324 1325 1326 1327 1328 1329 1330 1331
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                ret = 2;
                goto out4;
            }
        }   break;
1332 1333 1334
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
1335 1336 1337 1338 1339 1340 1341 1342 1343
        }
    }

    /* Progress is not shown in Quiet mode */
    if (quiet) {
        progress = false;
    }


1344
    if (optind != argc - 2) {
F
Fam Zheng 已提交
1345
        error_exit("Expecting two image file names");
1346 1347 1348 1349
    }
    filename1 = argv[optind++];
    filename2 = argv[optind++];

1350 1351
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
1352
                          NULL, &error_fatal)) {
1353 1354 1355 1356
        ret = 2;
        goto out4;
    }

1357 1358 1359
    /* Initialize before goto out */
    qemu_progress_init(progress, 2.0);

1360 1361
    flags = 0;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1362 1363 1364 1365 1366 1367
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        ret = 2;
        goto out3;
    }

1368 1369
    blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
                    force_share);
1370
    if (!blk1) {
1371
        ret = 2;
1372
        goto out3;
1373 1374
    }

1375 1376
    blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
                    force_share);
1377
    if (!blk2) {
1378
        ret = 2;
1379
        goto out2;
1380
    }
1381
    bs1 = blk_bs(blk1);
1382
    bs2 = blk_bs(blk2);
1383

1384 1385
    buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
    buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1386 1387
    total_size1 = blk_getlength(blk1);
    if (total_size1 < 0) {
1388
        error_report("Can't get size of %s: %s",
1389
                     filename1, strerror(-total_size1));
1390 1391 1392
        ret = 4;
        goto out;
    }
1393 1394
    total_size2 = blk_getlength(blk2);
    if (total_size2 < 0) {
1395
        error_report("Can't get size of %s: %s",
1396
                     filename2, strerror(-total_size2));
1397 1398 1399
        ret = 4;
        goto out;
    }
1400 1401
    total_size = MIN(total_size1, total_size2);
    progress_base = MAX(total_size1, total_size2);
1402 1403 1404

    qemu_progress_print(0, 100);

1405
    if (strict && total_size1 != total_size2) {
1406 1407 1408 1409 1410
        ret = 1;
        qprintf(quiet, "Strict mode: Image size mismatch!\n");
        goto out;
    }

1411
    while (offset < total_size) {
1412
        int status1, status2;
1413

1414 1415 1416
        status1 = bdrv_block_status_above(bs1, NULL, offset,
                                          total_size1 - offset, &pnum1, NULL,
                                          NULL);
1417
        if (status1 < 0) {
1418 1419 1420 1421
            ret = 3;
            error_report("Sector allocation test failed for %s", filename1);
            goto out;
        }
1422
        allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1423

1424 1425 1426
        status2 = bdrv_block_status_above(bs2, NULL, offset,
                                          total_size2 - offset, &pnum2, NULL,
                                          NULL);
1427
        if (status2 < 0) {
1428 1429 1430 1431
            ret = 3;
            error_report("Sector allocation test failed for %s", filename2);
            goto out;
        }
1432
        allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1433 1434

        assert(pnum1 && pnum2);
1435
        chunk = MIN(pnum1, pnum2);
1436

1437
        if (strict) {
1438
            if (status1 != status2) {
1439 1440
                ret = 1;
                qprintf(quiet, "Strict mode: Offset %" PRId64
1441
                        " block status mismatch!\n", offset);
1442 1443 1444 1445
                goto out;
            }
        }
        if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1446
            /* nothing to do */
1447
        } else if (allocated1 == allocated2) {
1448
            if (allocated1) {
1449 1450
                int64_t pnum;

1451 1452
                chunk = MIN(chunk, IO_BUF_SIZE);
                ret = blk_pread(blk1, offset, buf1, chunk);
1453
                if (ret < 0) {
1454 1455 1456
                    error_report("Error while reading offset %" PRId64
                                 " of %s: %s",
                                 offset, filename1, strerror(-ret));
1457 1458 1459
                    ret = 4;
                    goto out;
                }
1460
                ret = blk_pread(blk2, offset, buf2, chunk);
1461 1462
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64
1463 1464
                                 " of %s: %s",
                                 offset, filename2, strerror(-ret));
1465 1466 1467
                    ret = 4;
                    goto out;
                }
1468 1469
                ret = compare_buffers(buf1, buf2, chunk, &pnum);
                if (ret || pnum != chunk) {
1470
                    qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1471
                            offset + (ret ? 0 : pnum));
1472
                    ret = 1;
1473 1474 1475 1476
                    goto out;
                }
            }
        } else {
1477
            chunk = MIN(chunk, IO_BUF_SIZE);
1478
            if (allocated1) {
1479
                ret = check_empty_sectors(blk1, offset, chunk,
1480 1481
                                          filename1, buf1, quiet);
            } else {
1482
                ret = check_empty_sectors(blk2, offset, chunk,
1483 1484 1485 1486 1487 1488
                                          filename2, buf1, quiet);
            }
            if (ret) {
                goto out;
            }
        }
1489 1490
        offset += chunk;
        qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1491 1492
    }

1493
    if (total_size1 != total_size2) {
1494
        BlockBackend *blk_over;
1495 1496 1497
        const char *filename_over;

        qprintf(quiet, "Warning: Image size mismatch!\n");
1498
        if (total_size1 > total_size2) {
1499
            blk_over = blk1;
1500 1501
            filename_over = filename1;
        } else {
1502
            blk_over = blk2;
1503 1504 1505
            filename_over = filename2;
        }

1506 1507 1508 1509
        while (offset < progress_base) {
            ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
                                          progress_base - offset, &chunk,
                                          NULL, NULL);
1510 1511 1512 1513 1514 1515 1516
            if (ret < 0) {
                ret = 3;
                error_report("Sector allocation test failed for %s",
                             filename_over);
                goto out;

            }
1517
            if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
1518 1519
                chunk = MIN(chunk, IO_BUF_SIZE);
                ret = check_empty_sectors(blk_over, offset, chunk,
1520 1521 1522 1523 1524
                                          filename_over, buf1, quiet);
                if (ret) {
                    goto out;
                }
            }
1525 1526
            offset += chunk;
            qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1527 1528 1529 1530 1531 1532 1533 1534 1535
        }
    }

    qprintf(quiet, "Images are identical.\n");
    ret = 0;

out:
    qemu_vfree(buf1);
    qemu_vfree(buf2);
M
Markus Armbruster 已提交
1536
    blk_unref(blk2);
1537
out2:
M
Markus Armbruster 已提交
1538
    blk_unref(blk1);
1539 1540
out3:
    qemu_progress_end();
1541
out4:
1542 1543 1544
    return ret;
}

1545 1546 1547 1548 1549 1550
enum ImgConvertBlockStatus {
    BLK_DATA,
    BLK_ZERO,
    BLK_BACKING_FILE,
};

P
Peter Lieven 已提交
1551 1552
#define MAX_COROUTINES 16

1553 1554 1555
typedef struct ImgConvertState {
    BlockBackend **src;
    int64_t *src_sectors;
P
Peter Lieven 已提交
1556
    int src_num;
1557 1558
    int64_t total_sectors;
    int64_t allocated_sectors;
P
Peter Lieven 已提交
1559 1560 1561
    int64_t allocated_done;
    int64_t sector_num;
    int64_t wr_offs;
1562 1563 1564 1565 1566
    enum ImgConvertBlockStatus status;
    int64_t sector_next_status;
    BlockBackend *target;
    bool has_zero_init;
    bool compressed;
1567
    bool unallocated_blocks_are_zero;
1568
    bool target_has_backing;
1569
    int64_t target_backing_sectors; /* negative if unknown */
P
Peter Lieven 已提交
1570
    bool wr_in_order;
1571
    bool copy_range;
1572
    int min_sparse;
1573
    int alignment;
1574 1575
    size_t cluster_sectors;
    size_t buf_sectors;
P
Peter Lieven 已提交
1576
    long num_coroutines;
P
Peter Lieven 已提交
1577 1578 1579 1580 1581
    int running_coroutines;
    Coroutine *co[MAX_COROUTINES];
    int64_t wait_sector_num[MAX_COROUTINES];
    CoMutex lock;
    int ret;
1582 1583
} ImgConvertState;

P
Peter Lieven 已提交
1584 1585
static void convert_select_part(ImgConvertState *s, int64_t sector_num,
                                int *src_cur, int64_t *src_cur_offset)
1586
{
P
Peter Lieven 已提交
1587 1588 1589 1590 1591 1592
    *src_cur = 0;
    *src_cur_offset = 0;
    while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
        *src_cur_offset += s->src_sectors[*src_cur];
        (*src_cur)++;
        assert(*src_cur < s->src_num);
1593 1594 1595 1596 1597
    }
}

static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
{
1598 1599
    int64_t src_cur_offset;
    int ret, n, src_cur;
1600
    bool post_backing_zero = false;
1601

P
Peter Lieven 已提交
1602
    convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1603 1604 1605 1606

    assert(s->total_sectors > sector_num);
    n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);

1607 1608 1609 1610 1611 1612 1613 1614 1615 1616
    if (s->target_backing_sectors >= 0) {
        if (sector_num >= s->target_backing_sectors) {
            post_backing_zero = s->unallocated_blocks_are_zero;
        } else if (sector_num + n > s->target_backing_sectors) {
            /* Split requests around target_backing_sectors (because
             * starting from there, zeros are handled differently) */
            n = s->target_backing_sectors - sector_num;
        }
    }

1617
    if (s->sector_next_status <= sector_num) {
1618 1619
        int64_t count = n * BDRV_SECTOR_SIZE;

1620
        if (s->target_has_backing) {
1621 1622 1623 1624 1625

            ret = bdrv_block_status(blk_bs(s->src[src_cur]),
                                    (sector_num - src_cur_offset) *
                                    BDRV_SECTOR_SIZE,
                                    count, &count, NULL, NULL);
1626
        } else {
1627 1628 1629 1630
            ret = bdrv_block_status_above(blk_bs(s->src[src_cur]), NULL,
                                          (sector_num - src_cur_offset) *
                                          BDRV_SECTOR_SIZE,
                                          count, &count, NULL, NULL);
1631
        }
1632 1633 1634
        if (ret < 0) {
            return ret;
        }
1635
        n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
1636 1637

        if (ret & BDRV_BLOCK_ZERO) {
1638
            s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
1639 1640 1641
        } else if (ret & BDRV_BLOCK_DATA) {
            s->status = BLK_DATA;
        } else {
1642
            s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
        }

        s->sector_next_status = sector_num + n;
    }

    n = MIN(n, s->sector_next_status - sector_num);
    if (s->status == BLK_DATA) {
        n = MIN(n, s->buf_sectors);
    }

    /* We need to write complete clusters for compressed images, so if an
     * unallocated area is shorter than that, we must consider the whole
     * cluster allocated. */
    if (s->compressed) {
        if (n < s->cluster_sectors) {
            n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
            s->status = BLK_DATA;
        } else {
            n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
        }
    }

    return n;
}

P
Peter Lieven 已提交
1668 1669
static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
                                        int nb_sectors, uint8_t *buf)
1670
{
P
Peter Lieven 已提交
1671 1672 1673
    int n, ret;
    QEMUIOVector qiov;
    struct iovec iov;
1674 1675 1676 1677

    assert(nb_sectors <= s->buf_sectors);
    while (nb_sectors > 0) {
        BlockBackend *blk;
P
Peter Lieven 已提交
1678 1679
        int src_cur;
        int64_t bs_sectors, src_cur_offset;
1680 1681 1682 1683

        /* In the case of compression with multiple source files, we can get a
         * nb_sectors that spreads into the next part. So we must be able to
         * read across multiple BDSes for one convert_read() call. */
P
Peter Lieven 已提交
1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695
        convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
        blk = s->src[src_cur];
        bs_sectors = s->src_sectors[src_cur];

        n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
        iov.iov_base = buf;
        iov.iov_len = n << BDRV_SECTOR_BITS;
        qemu_iovec_init_external(&qiov, &iov, 1);

        ret = blk_co_preadv(
                blk, (sector_num - src_cur_offset) << BDRV_SECTOR_BITS,
                n << BDRV_SECTOR_BITS, &qiov, 0);
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707
        if (ret < 0) {
            return ret;
        }

        sector_num += n;
        nb_sectors -= n;
        buf += n * BDRV_SECTOR_SIZE;
    }

    return 0;
}

P
Peter Lieven 已提交
1708 1709 1710 1711

static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
                                         int nb_sectors, uint8_t *buf,
                                         enum ImgConvertBlockStatus status)
1712 1713
{
    int ret;
P
Peter Lieven 已提交
1714 1715
    QEMUIOVector qiov;
    struct iovec iov;
1716 1717 1718

    while (nb_sectors > 0) {
        int n = nb_sectors;
1719 1720
        BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;

P
Peter Lieven 已提交
1721
        switch (status) {
1722 1723 1724 1725 1726 1727 1728 1729
        case BLK_BACKING_FILE:
            /* If we have a backing file, leave clusters unallocated that are
             * unallocated in the source image, so that the backing file is
             * visible at the respective offset. */
            assert(s->target_has_backing);
            break;

        case BLK_DATA:
1730 1731 1732 1733 1734 1735
            /* If we're told to keep the target fully allocated (-S 0) or there
             * is real non-zero data, we must write it. Otherwise we can treat
             * it as zero sectors.
             * Compressed clusters need to be written as a whole, so in that
             * case we can only save the write if the buffer is completely
             * zeroed. */
1736
            if (!s->min_sparse ||
1737
                (!s->compressed &&
1738 1739
                 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
                                          sector_num, s->alignment)) ||
1740 1741
                (s->compressed &&
                 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
1742
            {
P
Peter Lieven 已提交
1743 1744 1745 1746 1747
                iov.iov_base = buf;
                iov.iov_len = n << BDRV_SECTOR_BITS;
                qemu_iovec_init_external(&qiov, &iov, 1);

                ret = blk_co_pwritev(s->target, sector_num << BDRV_SECTOR_BITS,
1748
                                     n << BDRV_SECTOR_BITS, &qiov, flags);
1749 1750 1751 1752 1753 1754 1755 1756 1757
                if (ret < 0) {
                    return ret;
                }
                break;
            }
            /* fall-through */

        case BLK_ZERO:
            if (s->has_zero_init) {
1758
                assert(!s->target_has_backing);
1759 1760
                break;
            }
P
Peter Lieven 已提交
1761 1762 1763
            ret = blk_co_pwrite_zeroes(s->target,
                                       sector_num << BDRV_SECTOR_BITS,
                                       n << BDRV_SECTOR_BITS, 0);
1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777
            if (ret < 0) {
                return ret;
            }
            break;
        }

        sector_num += n;
        nb_sectors -= n;
        buf += n * BDRV_SECTOR_SIZE;
    }

    return 0;
}

1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797
static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
                                              int nb_sectors)
{
    int n, ret;

    while (nb_sectors > 0) {
        BlockBackend *blk;
        int src_cur;
        int64_t bs_sectors, src_cur_offset;
        int64_t offset;

        convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
        offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
        blk = s->src[src_cur];
        bs_sectors = s->src_sectors[src_cur];

        n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));

        ret = blk_co_copy_range(blk, offset, s->target,
                                sector_num << BDRV_SECTOR_BITS,
1798
                                n << BDRV_SECTOR_BITS, 0, 0);
1799 1800 1801 1802 1803 1804 1805 1806 1807 1808
        if (ret < 0) {
            return ret;
        }

        sector_num += n;
        nb_sectors -= n;
    }
    return 0;
}

P
Peter Lieven 已提交
1809
static void coroutine_fn convert_co_do_copy(void *opaque)
1810
{
P
Peter Lieven 已提交
1811
    ImgConvertState *s = opaque;
1812
    uint8_t *buf = NULL;
P
Peter Lieven 已提交
1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830
    int ret, i;
    int index = -1;

    for (i = 0; i < s->num_coroutines; i++) {
        if (s->co[i] == qemu_coroutine_self()) {
            index = i;
            break;
        }
    }
    assert(index >= 0);

    s->running_coroutines++;
    buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);

    while (1) {
        int n;
        int64_t sector_num;
        enum ImgConvertBlockStatus status;
1831
        bool copy_range;
P
Peter Lieven 已提交
1832 1833 1834 1835

        qemu_co_mutex_lock(&s->lock);
        if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
            qemu_co_mutex_unlock(&s->lock);
1836
            break;
P
Peter Lieven 已提交
1837 1838 1839 1840 1841
        }
        n = convert_iteration_sectors(s, s->sector_num);
        if (n < 0) {
            qemu_co_mutex_unlock(&s->lock);
            s->ret = n;
1842
            break;
P
Peter Lieven 已提交
1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860
        }
        /* save current sector and allocation status to local variables */
        sector_num = s->sector_num;
        status = s->status;
        if (!s->min_sparse && s->status == BLK_ZERO) {
            n = MIN(n, s->buf_sectors);
        }
        /* increment global sector counter so that other coroutines can
         * already continue reading beyond this request */
        s->sector_num += n;
        qemu_co_mutex_unlock(&s->lock);

        if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
            s->allocated_done += n;
            qemu_progress_print(100.0 * s->allocated_done /
                                        s->allocated_sectors, 0);
        }

1861 1862 1863
retry:
        copy_range = s->copy_range && s->status == BLK_DATA;
        if (status == BLK_DATA && !copy_range) {
P
Peter Lieven 已提交
1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876
            ret = convert_co_read(s, sector_num, n, buf);
            if (ret < 0) {
                error_report("error while reading sector %" PRId64
                             ": %s", sector_num, strerror(-ret));
                s->ret = ret;
            }
        } else if (!s->min_sparse && status == BLK_ZERO) {
            status = BLK_DATA;
            memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
        }

        if (s->wr_in_order) {
            /* keep writes in order */
1877
            while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
P
Peter Lieven 已提交
1878 1879 1880 1881 1882 1883
                s->wait_sector_num[index] = sector_num;
                qemu_coroutine_yield();
            }
            s->wait_sector_num[index] = -1;
        }

1884
        if (s->ret == -EINPROGRESS) {
1885 1886 1887 1888 1889 1890 1891 1892 1893
            if (copy_range) {
                ret = convert_co_copy_range(s, sector_num, n);
                if (ret) {
                    s->copy_range = false;
                    goto retry;
                }
            } else {
                ret = convert_co_write(s, sector_num, n, buf, status);
            }
1894 1895 1896 1897 1898
            if (ret < 0) {
                error_report("error while writing sector %" PRId64
                             ": %s", sector_num, strerror(-ret));
                s->ret = ret;
            }
P
Peter Lieven 已提交
1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931
        }

        if (s->wr_in_order) {
            /* reenter the coroutine that might have waited
             * for this write to complete */
            s->wr_offs = sector_num + n;
            for (i = 0; i < s->num_coroutines; i++) {
                if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
                    /*
                     * A -> B -> A cannot occur because A has
                     * s->wait_sector_num[i] == -1 during A -> B.  Therefore
                     * B will never enter A during this time window.
                     */
                    qemu_coroutine_enter(s->co[i]);
                    break;
                }
            }
        }
    }

    qemu_vfree(buf);
    s->co[index] = NULL;
    s->running_coroutines--;
    if (!s->running_coroutines && s->ret == -EINPROGRESS) {
        /* the convert job finished successfully */
        s->ret = 0;
    }
}

static int convert_do_copy(ImgConvertState *s)
{
    int ret, i, n;
    int64_t sector_num = 0;
1932 1933 1934 1935 1936 1937 1938 1939 1940

    /* Check whether we have zero initialisation or can get it efficiently */
    s->has_zero_init = s->min_sparse && !s->target_has_backing
                     ? bdrv_has_zero_init(blk_bs(s->target))
                     : false;

    if (!s->has_zero_init && !s->target_has_backing &&
        bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
    {
1941
        ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP);
1942 1943 1944 1945 1946 1947 1948 1949 1950 1951
        if (ret == 0) {
            s->has_zero_init = true;
        }
    }

    /* Allocate buffer for copied data. For compressed images, only one cluster
     * can be copied at a time. */
    if (s->compressed) {
        if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
            error_report("invalid cluster size");
P
Peter Lieven 已提交
1952
            return -EINVAL;
1953 1954 1955 1956 1957 1958 1959
        }
        s->buf_sectors = s->cluster_sectors;
    }

    while (sector_num < s->total_sectors) {
        n = convert_iteration_sectors(s, sector_num);
        if (n < 0) {
P
Peter Lieven 已提交
1960
            return n;
1961
        }
1962 1963
        if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
        {
1964 1965 1966 1967 1968 1969 1970
            s->allocated_sectors += n;
        }
        sector_num += n;
    }

    /* Do the copy */
    s->sector_next_status = 0;
P
Peter Lieven 已提交
1971
    s->ret = -EINPROGRESS;
1972

P
Peter Lieven 已提交
1973 1974 1975 1976 1977 1978
    qemu_co_mutex_init(&s->lock);
    for (i = 0; i < s->num_coroutines; i++) {
        s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
        s->wait_sector_num[i] = -1;
        qemu_coroutine_enter(s->co[i]);
    }
1979

1980
    while (s->running_coroutines) {
P
Peter Lieven 已提交
1981
        main_loop_wait(false);
1982 1983
    }

P
Peter Lieven 已提交
1984
    if (s->compressed && !s->ret) {
1985
        /* signal EOF to align */
1986
        ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
1987
        if (ret < 0) {
P
Peter Lieven 已提交
1988
            return ret;
1989 1990 1991
        }
    }

P
Peter Lieven 已提交
1992
    return s->ret;
1993 1994
}

1995 1996
#define MAX_BUF_SECTORS 32768

B
bellard 已提交
1997 1998
static int img_convert(int argc, char **argv)
{
P
Peter Lieven 已提交
1999
    int c, bs_i, flags, src_flags = 0;
2000
    const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
P
Peter Lieven 已提交
2001 2002
               *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
               *out_filename, *out_baseimg_param, *snapshot_name = NULL;
2003
    BlockDriver *drv = NULL, *proto_drv = NULL;
B
bellard 已提交
2004
    BlockDriverInfo bdi;
P
Peter Lieven 已提交
2005 2006
    BlockDriverState *out_bs;
    QemuOpts *opts = NULL, *sn_opts = NULL;
2007
    QemuOptsList *create_opts = NULL;
2008
    QDict *open_opts = NULL;
2009
    char *options = NULL;
2010
    Error *local_err = NULL;
P
Peter Lieven 已提交
2011
    bool writethrough, src_writethrough, quiet = false, image_opts = false,
2012
         skip_create = false, progress = false, tgt_image_opts = false;
P
Peter Lieven 已提交
2013
    int64_t ret = -EINVAL;
2014
    bool force_share = false;
2015
    bool explict_min_sparse = false;
P
Peter Lieven 已提交
2016 2017 2018 2019

    ImgConvertState s = (ImgConvertState) {
        /* Need at least 4k of zeros for sparse detection */
        .min_sparse         = 8,
2020
        .copy_range         = false,
P
Peter Lieven 已提交
2021 2022 2023 2024
        .buf_sectors        = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
        .wr_in_order        = true,
        .num_coroutines     = 8,
    };
B
bellard 已提交
2025 2026

    for(;;) {
2027 2028 2029
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
2030
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2031
            {"force-share", no_argument, 0, 'U'},
2032
            {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
2033 2034
            {0, 0, 0, 0}
        };
2035
        c = getopt_long(argc, argv, ":hf:O:B:Cco:l:S:pt:T:qnm:WU",
2036
                        long_options, NULL);
2037
        if (c == -1) {
B
bellard 已提交
2038
            break;
2039
        }
B
bellard 已提交
2040
        switch(c) {
2041 2042 2043
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
2044
        case '?':
2045 2046
            unrecognized_option(argv[optind - 1]);
            break;
B
bellard 已提交
2047 2048 2049 2050 2051 2052 2053 2054 2055
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'O':
            out_fmt = optarg;
            break;
2056 2057 2058
        case 'B':
            out_baseimg = optarg;
            break;
2059 2060 2061
        case 'C':
            s.copy_range = true;
            break;
B
bellard 已提交
2062
        case 'c':
P
Peter Lieven 已提交
2063
            s.compressed = true;
B
bellard 已提交
2064
            break;
2065
        case 'o':
2066 2067
            if (!is_valid_option_list(optarg)) {
                error_report("Invalid option list: %s", optarg);
2068
                goto fail_getopt;
2069 2070 2071 2072 2073 2074 2075 2076
            }
            if (!options) {
                options = g_strdup(optarg);
            } else {
                char *old_options = options;
                options = g_strdup_printf("%s,%s", options, optarg);
                g_free(old_options);
            }
2077
            break;
2078 2079
        case 'l':
            if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
2080 2081
                sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
                                                  optarg, false);
2082 2083 2084
                if (!sn_opts) {
                    error_report("Failed in parsing snapshot param '%s'",
                                 optarg);
2085
                    goto fail_getopt;
2086 2087 2088 2089 2090
                }
            } else {
                snapshot_name = optarg;
            }
            break;
2091 2092 2093
        case 'S':
        {
            int64_t sval;
2094 2095

            sval = cvtnum(optarg);
2096 2097 2098 2099 2100 2101
            if (sval < 0 || sval & (BDRV_SECTOR_SIZE - 1) ||
                sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
                error_report("Invalid buffer size for sparse output specified. "
                    "Valid sizes are multiples of %llu up to %llu. Select "
                    "0 to disable sparse detection (fully allocates output).",
                    BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
2102
                goto fail_getopt;
2103 2104
            }

P
Peter Lieven 已提交
2105
            s.min_sparse = sval / BDRV_SECTOR_SIZE;
2106
            explict_min_sparse = true;
2107 2108
            break;
        }
2109
        case 'p':
P
Peter Lieven 已提交
2110
            progress = true;
2111
            break;
2112 2113 2114
        case 't':
            cache = optarg;
            break;
2115 2116 2117
        case 'T':
            src_cache = optarg;
            break;
2118 2119 2120
        case 'q':
            quiet = true;
            break;
2121
        case 'n':
P
Peter Lieven 已提交
2122
            skip_create = true;
2123
            break;
P
Peter Lieven 已提交
2124
        case 'm':
P
Peter Lieven 已提交
2125 2126
            if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
                s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
P
Peter Lieven 已提交
2127 2128 2129 2130 2131 2132
                error_report("Invalid number of coroutines. Allowed number of"
                             " coroutines is between 1 and %d", MAX_COROUTINES);
                goto fail_getopt;
            }
            break;
        case 'W':
P
Peter Lieven 已提交
2133
            s.wr_in_order = false;
P
Peter Lieven 已提交
2134
            break;
2135 2136 2137
        case 'U':
            force_share = true;
            break;
2138 2139 2140 2141 2142
        case OPTION_OBJECT: {
            QemuOpts *object_opts;
            object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                                  optarg, true);
            if (!object_opts) {
2143 2144 2145
                goto fail_getopt;
            }
            break;
2146
        }
2147 2148 2149
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
2150 2151 2152
        case OPTION_TARGET_IMAGE_OPTS:
            tgt_image_opts = true;
            break;
B
bellard 已提交
2153 2154
        }
    }
2155

2156 2157 2158 2159
    if (!out_fmt && !tgt_image_opts) {
        out_fmt = "raw";
    }

2160 2161
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2162
                          NULL, &error_fatal)) {
2163 2164 2165
        goto fail_getopt;
    }

2166 2167 2168 2169 2170 2171 2172 2173 2174 2175
    if (s.compressed && s.copy_range) {
        error_report("Cannot enable copy offloading when -c is used");
        goto fail_getopt;
    }

    if (explict_min_sparse && s.copy_range) {
        error_report("Cannot enable copy offloading when -S is used");
        goto fail_getopt;
    }

2176 2177 2178 2179 2180
    if (tgt_image_opts && !skip_create) {
        error_report("--target-image-opts requires use of -n flag");
        goto fail_getopt;
    }

P
Peter Lieven 已提交
2181 2182
    s.src_num = argc - optind - 1;
    out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2183

2184
    if (options && has_help_option(options)) {
2185 2186 2187 2188 2189 2190 2191
        if (out_fmt) {
            ret = print_block_option_help(out_filename, out_fmt);
            goto fail_getopt;
        } else {
            error_report("Option help requires a format be specified");
            goto fail_getopt;
        }
2192 2193
    }

P
Peter Lieven 已提交
2194 2195 2196
    if (s.src_num < 1) {
        error_report("Must specify image file name");
        goto fail_getopt;
2197 2198 2199
    }


P
Peter Lieven 已提交
2200
    /* ret is still -EINVAL until here */
2201
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2202 2203
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
P
Peter Lieven 已提交
2204
        goto fail_getopt;
2205 2206
    }

P
Peter Lieven 已提交
2207 2208 2209 2210 2211
    /* Initialize before goto out */
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);
2212 2213
    qemu_progress_print(0, 100);

P
Peter Lieven 已提交
2214 2215
    s.src = g_new0(BlockBackend *, s.src_num);
    s.src_sectors = g_new(int64_t, s.src_num);
2216

P
Peter Lieven 已提交
2217 2218
    for (bs_i = 0; bs_i < s.src_num; bs_i++) {
        s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
2219 2220
                               fmt, src_flags, src_writethrough, quiet,
                               force_share);
P
Peter Lieven 已提交
2221
        if (!s.src[bs_i]) {
2222 2223 2224
            ret = -1;
            goto out;
        }
P
Peter Lieven 已提交
2225 2226
        s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
        if (s.src_sectors[bs_i] < 0) {
2227
            error_report("Could not get size of %s: %s",
P
Peter Lieven 已提交
2228
                         argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
2229 2230 2231
            ret = -1;
            goto out;
        }
P
Peter Lieven 已提交
2232
        s.total_sectors += s.src_sectors[bs_i];
2233
    }
B
bellard 已提交
2234

2235
    if (sn_opts) {
P
Peter Lieven 已提交
2236
        bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
2237 2238 2239
                               qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
                               qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
                               &local_err);
2240
    } else if (snapshot_name != NULL) {
P
Peter Lieven 已提交
2241
        if (s.src_num > 1) {
2242
            error_report("No support for concatenating multiple snapshot");
E
edison 已提交
2243 2244 2245
            ret = -1;
            goto out;
        }
2246

P
Peter Lieven 已提交
2247 2248
        bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
                                             &local_err);
2249
    }
2250
    if (local_err) {
2251
        error_reportf_err(local_err, "Failed to load snapshot: ");
2252 2253
        ret = -1;
        goto out;
E
edison 已提交
2254 2255
    }

2256 2257 2258 2259 2260 2261 2262 2263
    if (!skip_create) {
        /* Find driver and parse its options */
        drv = bdrv_find_format(out_fmt);
        if (!drv) {
            error_report("Unknown file format '%s'", out_fmt);
            ret = -1;
            goto out;
        }
2264

2265 2266 2267 2268 2269 2270
        proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
        if (!proto_drv) {
            error_report_err(local_err);
            ret = -1;
            goto out;
        }
2271

M
Max Reitz 已提交
2272 2273 2274 2275 2276 2277
        if (!drv->create_opts) {
            error_report("Format driver '%s' does not support image creation",
                         drv->format_name);
            ret = -1;
            goto out;
        }
2278

M
Max Reitz 已提交
2279 2280 2281 2282 2283 2284
        if (!proto_drv->create_opts) {
            error_report("Protocol driver '%s' does not support image creation",
                         proto_drv->format_name);
            ret = -1;
            goto out;
        }
2285

M
Max Reitz 已提交
2286 2287
        create_opts = qemu_opts_append(create_opts, drv->create_opts);
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2288

M
Max Reitz 已提交
2289
        opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2290 2291 2292
        if (options) {
            qemu_opts_do_parse(opts, options, NULL, &local_err);
            if (local_err) {
2293
                error_report_err(local_err);
2294 2295 2296
                ret = -1;
                goto out;
            }
M
Max Reitz 已提交
2297
        }
2298

P
Peter Lieven 已提交
2299
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
2300
                            &error_abort);
M
Max Reitz 已提交
2301 2302 2303 2304
        ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
        if (ret < 0) {
            goto out;
        }
2305
    }
2306

2307
    /* Get backing file name if -o backing_file was used */
2308
    out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2309
    if (out_baseimg_param) {
2310
        out_baseimg = out_baseimg_param;
2311
    }
P
Peter Lieven 已提交
2312
    s.target_has_backing = (bool) out_baseimg;
2313

2314 2315 2316 2317 2318 2319 2320
    if (s.src_num > 1 && out_baseimg) {
        error_report("Having a backing file for the target makes no sense when "
                     "concatenating multiple input images");
        ret = -1;
        goto out;
    }

2321
    /* Check if compression is supported */
P
Peter Lieven 已提交
2322
    if (s.compressed) {
2323 2324
        bool encryption =
            qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2325 2326
        const char *encryptfmt =
            qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
2327 2328
        const char *preallocation =
            qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2329

2330
        if (drv && !drv->bdrv_co_pwritev_compressed) {
2331
            error_report("Compression not supported for this file format");
2332 2333
            ret = -1;
            goto out;
2334 2335
        }

2336
        if (encryption || encryptfmt) {
2337 2338
            error_report("Compression and encryption not supported at "
                         "the same time");
2339 2340
            ret = -1;
            goto out;
2341
        }
2342

2343 2344
        if (preallocation
            && strcmp(preallocation, "off"))
2345 2346 2347 2348 2349 2350
        {
            error_report("Compression and preallocation not supported at "
                         "the same time");
            ret = -1;
            goto out;
        }
2351 2352
    }

2353 2354 2355 2356 2357 2358 2359 2360 2361 2362
    /*
     * The later open call will need any decryption secrets, and
     * bdrv_create() will purge "opts", so extract them now before
     * they are lost.
     */
    if (!skip_create) {
        open_opts = qdict_new();
        qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
    }

2363 2364
    if (!skip_create) {
        /* Create the new image */
C
Chunyan Liu 已提交
2365
        ret = bdrv_create(drv, out_filename, opts, &local_err);
2366
        if (ret < 0) {
2367 2368
            error_reportf_err(local_err, "%s: error while converting %s: ",
                              out_filename, out_fmt);
2369
            goto out;
B
bellard 已提交
2370 2371
        }
    }
2372

P
Peter Lieven 已提交
2373
    flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2374
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2375 2376
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2377
        goto out;
2378 2379
    }

2380 2381 2382 2383 2384 2385 2386 2387 2388
    if (skip_create) {
        s.target = img_open(tgt_image_opts, out_filename, out_fmt,
                            flags, writethrough, quiet, false);
    } else {
        /* TODO ultimately we should allow --target-image-opts
         * to be used even when -n is not given.
         * That has to wait for bdrv_create to be improved
         * to allow filenames in option syntax
         */
2389 2390 2391
        s.target = img_open_file(out_filename, open_opts, out_fmt,
                                 flags, writethrough, quiet, false);
        open_opts = NULL; /* blk_new_open will have freed it */
2392
    }
P
Peter Lieven 已提交
2393
    if (!s.target) {
2394 2395 2396
        ret = -1;
        goto out;
    }
P
Peter Lieven 已提交
2397
    out_bs = blk_bs(s.target);
B
bellard 已提交
2398

2399 2400 2401 2402 2403 2404
    if (s.compressed && !out_bs->drv->bdrv_co_pwritev_compressed) {
        error_report("Compression not supported for this file format");
        ret = -1;
        goto out;
    }

2405
    /* increase bufsectors from the default 4096 (2M) if opt_transfer
2406 2407 2408
     * or discard_alignment of the out_bs is greater. Limit to
     * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
    s.buf_sectors = MIN(MAX_BUF_SECTORS,
P
Peter Lieven 已提交
2409 2410 2411 2412
                        MAX(s.buf_sectors,
                            MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
                                out_bs->bl.pdiscard_alignment >>
                                BDRV_SECTOR_BITS)));
2413

2414 2415 2416 2417 2418 2419 2420
    /* try to align the write requests to the destination to avoid unnecessary
     * RMW cycles. */
    s.alignment = MAX(pow2floor(s.min_sparse),
                      DIV_ROUND_UP(out_bs->bl.request_alignment,
                                   BDRV_SECTOR_SIZE));
    assert(is_power_of_2(s.alignment));

2421
    if (skip_create) {
P
Peter Lieven 已提交
2422
        int64_t output_sectors = blk_nb_sectors(s.target);
2423
        if (output_sectors < 0) {
2424
            error_report("unable to get output image length: %s",
2425
                         strerror(-output_sectors));
2426 2427
            ret = -1;
            goto out;
P
Peter Lieven 已提交
2428
        } else if (output_sectors < s.total_sectors) {
2429 2430 2431 2432 2433 2434
            error_report("output file is smaller than input file");
            ret = -1;
            goto out;
        }
    }

2435 2436 2437 2438 2439 2440 2441 2442 2443 2444
    if (s.target_has_backing) {
        /* Errors are treated as "backing length unknown" (which means
         * s.target_backing_sectors has to be negative, which it will
         * be automatically).  The backing file length is used only
         * for optimizations, so such a case is not fatal. */
        s.target_backing_sectors = bdrv_nb_sectors(out_bs->backing->bs);
    } else {
        s.target_backing_sectors = -1;
    }

2445 2446
    ret = bdrv_get_info(out_bs, &bdi);
    if (ret < 0) {
P
Peter Lieven 已提交
2447
        if (s.compressed) {
2448
            error_report("could not get block driver info");
2449 2450
            goto out;
        }
2451
    } else {
P
Peter Lieven 已提交
2452 2453
        s.compressed = s.compressed || bdi.needs_compressed_writes;
        s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2454
        s.unallocated_blocks_are_zero = bdi.unallocated_blocks_are_zero;
P
Peter Lieven 已提交
2455
    }
2456

P
Peter Lieven 已提交
2457
    ret = convert_do_copy(&s);
2458
out:
2459 2460 2461
    if (!ret) {
        qemu_progress_print(100, 0);
    }
2462
    qemu_progress_end();
2463 2464
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
2465
    qemu_opts_del(sn_opts);
2466
    qobject_unref(open_opts);
P
Peter Lieven 已提交
2467 2468 2469 2470
    blk_unref(s.target);
    if (s.src) {
        for (bs_i = 0; bs_i < s.src_num; bs_i++) {
            blk_unref(s.src[bs_i]);
M
Markus Armbruster 已提交
2471
        }
P
Peter Lieven 已提交
2472
        g_free(s.src);
M
Markus Armbruster 已提交
2473
    }
P
Peter Lieven 已提交
2474
    g_free(s.src_sectors);
2475 2476 2477
fail_getopt:
    g_free(options);

P
Peter Lieven 已提交
2478
    return !!ret;
B
bellard 已提交
2479 2480
}

B
bellard 已提交
2481

B
bellard 已提交
2482 2483 2484 2485 2486 2487 2488 2489 2490
static void dump_snapshots(BlockDriverState *bs)
{
    QEMUSnapshotInfo *sn_tab, *sn;
    int nb_sns, i;

    nb_sns = bdrv_snapshot_list(bs, &sn_tab);
    if (nb_sns <= 0)
        return;
    printf("Snapshot list:\n");
2491 2492
    bdrv_snapshot_dump(fprintf, stdout, NULL);
    printf("\n");
B
bellard 已提交
2493 2494
    for(i = 0; i < nb_sns; i++) {
        sn = &sn_tab[i];
2495 2496
        bdrv_snapshot_dump(fprintf, stdout, sn);
        printf("\n");
B
bellard 已提交
2497
    }
2498
    g_free(sn_tab);
B
bellard 已提交
2499 2500
}

2501 2502 2503 2504
static void dump_json_image_info_list(ImageInfoList *list)
{
    QString *str;
    QObject *obj;
2505
    Visitor *v = qobject_output_visitor_new(&obj);
2506 2507 2508

    visit_type_ImageInfoList(v, NULL, &list, &error_abort);
    visit_complete(v, &obj);
2509 2510 2511
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
2512
    qobject_unref(obj);
2513
    visit_free(v);
2514
    qobject_unref(str);
2515 2516
}

2517 2518 2519 2520
static void dump_json_image_info(ImageInfo *info)
{
    QString *str;
    QObject *obj;
2521
    Visitor *v = qobject_output_visitor_new(&obj);
2522 2523 2524

    visit_type_ImageInfo(v, NULL, &info, &error_abort);
    visit_complete(v, &obj);
2525 2526 2527
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
2528
    qobject_unref(obj);
2529
    visit_free(v);
2530
    qobject_unref(str);
2531 2532
}

2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543
static void dump_human_image_info_list(ImageInfoList *list)
{
    ImageInfoList *elem;
    bool delim = false;

    for (elem = list; elem; elem = elem->next) {
        if (delim) {
            printf("\n");
        }
        delim = true;

2544
        bdrv_image_info_dump(fprintf, stdout, elem->value);
2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564
    }
}

static gboolean str_equal_func(gconstpointer a, gconstpointer b)
{
    return strcmp(a, b) == 0;
}

/**
 * Open an image file chain and return an ImageInfoList
 *
 * @filename: topmost image filename
 * @fmt: topmost image format (may be NULL to autodetect)
 * @chain: true  - enumerate entire backing file chain
 *         false - only topmost image file
 *
 * Returns a list of ImageInfo objects or NULL if there was an error opening an
 * image file.  If there was an error a message will have been printed to
 * stderr.
 */
2565 2566
static ImageInfoList *collect_image_info_list(bool image_opts,
                                              const char *filename,
2567
                                              const char *fmt,
2568
                                              bool chain, bool force_share)
2569 2570 2571 2572
{
    ImageInfoList *head = NULL;
    ImageInfoList **last = &head;
    GHashTable *filenames;
2573
    Error *err = NULL;
2574 2575 2576 2577

    filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);

    while (filename) {
M
Markus Armbruster 已提交
2578
        BlockBackend *blk;
2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589
        BlockDriverState *bs;
        ImageInfo *info;
        ImageInfoList *elem;

        if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
            error_report("Backing file '%s' creates an infinite loop.",
                         filename);
            goto err;
        }
        g_hash_table_insert(filenames, (gpointer)filename, NULL);

2590
        blk = img_open(image_opts, filename, fmt,
2591 2592
                       BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
                       force_share);
2593
        if (!blk) {
2594 2595
            goto err;
        }
2596
        bs = blk_bs(blk);
2597

2598
        bdrv_query_image_info(bs, &info, &err);
2599
        if (err) {
2600
            error_report_err(err);
M
Markus Armbruster 已提交
2601
            blk_unref(blk);
2602
            goto err;
2603
        }
2604 2605 2606 2607 2608 2609

        elem = g_new0(ImageInfoList, 1);
        elem->value = info;
        *last = elem;
        last = &elem->next;

M
Markus Armbruster 已提交
2610
        blk_unref(blk);
2611 2612 2613 2614 2615 2616

        filename = fmt = NULL;
        if (chain) {
            if (info->has_full_backing_filename) {
                filename = info->full_backing_filename;
            } else if (info->has_backing_filename) {
2617 2618 2619 2620
                error_report("Could not determine absolute backing filename,"
                             " but backing filename '%s' present",
                             info->backing_filename);
                goto err;
2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635
            }
            if (info->has_backing_filename_format) {
                fmt = info->backing_filename_format;
            }
        }
    }
    g_hash_table_destroy(filenames);
    return head;

err:
    qapi_free_ImageInfoList(head);
    g_hash_table_destroy(filenames);
    return NULL;
}

2636 2637 2638 2639
static int img_info(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
2640
    bool chain = false;
2641
    const char *filename, *fmt, *output;
2642
    ImageInfoList *list;
2643
    bool image_opts = false;
2644
    bool force_share = false;
2645

B
bellard 已提交
2646
    fmt = NULL;
2647
    output = NULL;
B
bellard 已提交
2648
    for(;;) {
2649 2650 2651 2652 2653
        int option_index = 0;
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"format", required_argument, 0, 'f'},
            {"output", required_argument, 0, OPTION_OUTPUT},
2654
            {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2655
            {"object", required_argument, 0, OPTION_OBJECT},
2656
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2657
            {"force-share", no_argument, 0, 'U'},
2658 2659
            {0, 0, 0, 0}
        };
2660
        c = getopt_long(argc, argv, ":f:hU",
2661
                        long_options, &option_index);
2662
        if (c == -1) {
B
bellard 已提交
2663
            break;
2664
        }
B
bellard 已提交
2665
        switch(c) {
2666 2667 2668
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
2669
        case '?':
2670 2671
            unrecognized_option(argv[optind - 1]);
            break;
B
bellard 已提交
2672 2673 2674 2675 2676 2677
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2678 2679 2680
        case 'U':
            force_share = true;
            break;
2681 2682 2683
        case OPTION_OUTPUT:
            output = optarg;
            break;
2684 2685 2686
        case OPTION_BACKING_CHAIN:
            chain = true;
            break;
2687 2688 2689 2690 2691 2692 2693 2694
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2695 2696 2697
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
B
bellard 已提交
2698 2699
        }
    }
2700
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2701
        error_exit("Expecting one image file name");
2702
    }
B
bellard 已提交
2703 2704
    filename = argv[optind++];

2705 2706 2707 2708 2709 2710
    if (output && !strcmp(output, "json")) {
        output_format = OFORMAT_JSON;
    } else if (output && !strcmp(output, "human")) {
        output_format = OFORMAT_HUMAN;
    } else if (output) {
        error_report("--output must be used with human or json as argument.");
2711 2712
        return 1;
    }
2713

2714 2715
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2716
                          NULL, &error_fatal)) {
2717 2718 2719
        return 1;
    }

2720 2721
    list = collect_image_info_list(image_opts, filename, fmt, chain,
                                   force_share);
2722
    if (!list) {
2723
        return 1;
B
bellard 已提交
2724
    }
2725 2726 2727

    switch (output_format) {
    case OFORMAT_HUMAN:
2728
        dump_human_image_info_list(list);
2729 2730
        break;
    case OFORMAT_JSON:
2731 2732 2733 2734 2735
        if (chain) {
            dump_json_image_info_list(list);
        } else {
            dump_json_image_info(list->value);
        }
2736
        break;
B
bellard 已提交
2737
    }
2738

2739
    qapi_free_ImageInfoList(list);
B
bellard 已提交
2740 2741 2742
    return 0;
}

P
Paolo Bonzini 已提交
2743 2744 2745 2746 2747
static void dump_map_entry(OutputFormat output_format, MapEntry *e,
                           MapEntry *next)
{
    switch (output_format) {
    case OFORMAT_HUMAN:
2748
        if (e->data && !e->has_offset) {
P
Paolo Bonzini 已提交
2749 2750 2751
            error_report("File contains external, encrypted or compressed clusters.");
            exit(1);
        }
2752
        if (e->data && !e->zero) {
P
Paolo Bonzini 已提交
2753
            printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2754 2755 2756
                   e->start, e->length,
                   e->has_offset ? e->offset : 0,
                   e->has_filename ? e->filename : "");
P
Paolo Bonzini 已提交
2757 2758 2759 2760
        }
        /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
         * Modify the flags here to allow more coalescing.
         */
2761 2762 2763
        if (next && (!next->data || next->zero)) {
            next->data = false;
            next->zero = true;
P
Paolo Bonzini 已提交
2764 2765 2766
        }
        break;
    case OFORMAT_JSON:
2767 2768
        printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
               " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
P
Paolo Bonzini 已提交
2769 2770
               (e->start == 0 ? "[" : ",\n"),
               e->start, e->length, e->depth,
2771 2772 2773
               e->zero ? "true" : "false",
               e->data ? "true" : "false");
        if (e->has_offset) {
P
Paolo Bonzini 已提交
2774
            printf(", \"offset\": %"PRId64"", e->offset);
P
Paolo Bonzini 已提交
2775 2776 2777 2778 2779 2780 2781 2782 2783 2784
        }
        putchar('}');

        if (!next) {
            printf("]\n");
        }
        break;
    }
}

2785 2786
static int get_block_status(BlockDriverState *bs, int64_t offset,
                            int64_t bytes, MapEntry *e)
P
Paolo Bonzini 已提交
2787
{
2788
    int ret;
P
Paolo Bonzini 已提交
2789
    int depth;
2790
    BlockDriverState *file;
J
John Snow 已提交
2791
    bool has_offset;
2792
    int64_t map;
2793
    char *filename = NULL;
P
Paolo Bonzini 已提交
2794 2795 2796 2797 2798 2799 2800 2801

    /* As an optimization, we could cache the current range of unallocated
     * clusters in each file of the chain, and avoid querying the same
     * range repeatedly.
     */

    depth = 0;
    for (;;) {
2802
        ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
P
Paolo Bonzini 已提交
2803 2804 2805
        if (ret < 0) {
            return ret;
        }
2806
        assert(bytes);
P
Paolo Bonzini 已提交
2807 2808 2809
        if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
            break;
        }
2810
        bs = backing_bs(bs);
P
Paolo Bonzini 已提交
2811 2812 2813 2814 2815 2816 2817 2818
        if (bs == NULL) {
            ret = 0;
            break;
        }

        depth++;
    }

J
John Snow 已提交
2819 2820
    has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);

2821 2822 2823 2824 2825
    if (file && has_offset) {
        bdrv_refresh_filename(file);
        filename = file->filename;
    }

J
John Snow 已提交
2826
    *e = (MapEntry) {
2827
        .start = offset,
2828
        .length = bytes,
J
John Snow 已提交
2829 2830
        .data = !!(ret & BDRV_BLOCK_DATA),
        .zero = !!(ret & BDRV_BLOCK_ZERO),
2831
        .offset = map,
J
John Snow 已提交
2832 2833
        .has_offset = has_offset,
        .depth = depth,
2834 2835
        .has_filename = filename,
        .filename = filename,
J
John Snow 已提交
2836 2837
    };

P
Paolo Bonzini 已提交
2838 2839 2840
    return 0;
}

2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861
static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
{
    if (curr->length == 0) {
        return false;
    }
    if (curr->zero != next->zero ||
        curr->data != next->data ||
        curr->depth != next->depth ||
        curr->has_filename != next->has_filename ||
        curr->has_offset != next->has_offset) {
        return false;
    }
    if (curr->has_filename && strcmp(curr->filename, next->filename)) {
        return false;
    }
    if (curr->has_offset && curr->offset + curr->length != next->offset) {
        return false;
    }
    return true;
}

P
Paolo Bonzini 已提交
2862 2863 2864 2865
static int img_map(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
M
Markus Armbruster 已提交
2866
    BlockBackend *blk;
P
Paolo Bonzini 已提交
2867 2868 2869 2870 2871
    BlockDriverState *bs;
    const char *filename, *fmt, *output;
    int64_t length;
    MapEntry curr = { .length = 0 }, next;
    int ret = 0;
2872
    bool image_opts = false;
2873
    bool force_share = false;
P
Paolo Bonzini 已提交
2874 2875 2876 2877 2878 2879 2880 2881 2882

    fmt = NULL;
    output = NULL;
    for (;;) {
        int option_index = 0;
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"format", required_argument, 0, 'f'},
            {"output", required_argument, 0, OPTION_OUTPUT},
2883
            {"object", required_argument, 0, OPTION_OBJECT},
2884
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2885
            {"force-share", no_argument, 0, 'U'},
P
Paolo Bonzini 已提交
2886 2887
            {0, 0, 0, 0}
        };
2888
        c = getopt_long(argc, argv, ":f:hU",
P
Paolo Bonzini 已提交
2889 2890 2891 2892 2893
                        long_options, &option_index);
        if (c == -1) {
            break;
        }
        switch (c) {
2894 2895 2896
        case ':':
            missing_argument(argv[optind - 1]);
            break;
P
Paolo Bonzini 已提交
2897
        case '?':
2898 2899
            unrecognized_option(argv[optind - 1]);
            break;
P
Paolo Bonzini 已提交
2900 2901 2902 2903 2904 2905
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2906 2907 2908
        case 'U':
            force_share = true;
            break;
P
Paolo Bonzini 已提交
2909 2910 2911
        case OPTION_OUTPUT:
            output = optarg;
            break;
2912 2913 2914 2915 2916 2917 2918 2919
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2920 2921 2922
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
P
Paolo Bonzini 已提交
2923 2924
        }
    }
F
Fam Zheng 已提交
2925 2926
    if (optind != argc - 1) {
        error_exit("Expecting one image file name");
P
Paolo Bonzini 已提交
2927
    }
F
Fam Zheng 已提交
2928
    filename = argv[optind];
P
Paolo Bonzini 已提交
2929 2930 2931 2932 2933 2934 2935 2936 2937 2938

    if (output && !strcmp(output, "json")) {
        output_format = OFORMAT_JSON;
    } else if (output && !strcmp(output, "human")) {
        output_format = OFORMAT_HUMAN;
    } else if (output) {
        error_report("--output must be used with human or json as argument.");
        return 1;
    }

2939 2940
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2941
                          NULL, &error_fatal)) {
2942 2943 2944
        return 1;
    }

2945
    blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
2946 2947
    if (!blk) {
        return 1;
P
Paolo Bonzini 已提交
2948
    }
2949
    bs = blk_bs(blk);
P
Paolo Bonzini 已提交
2950 2951 2952 2953 2954

    if (output_format == OFORMAT_HUMAN) {
        printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
    }

2955
    length = blk_getlength(blk);
P
Paolo Bonzini 已提交
2956
    while (curr.start + curr.length < length) {
2957 2958
        int64_t offset = curr.start + curr.length;
        int64_t n;
P
Paolo Bonzini 已提交
2959 2960

        /* Probe up to 1 GiB at a time.  */
2961
        n = MIN(1 << 30, length - offset);
2962
        ret = get_block_status(bs, offset, n, &next);
P
Paolo Bonzini 已提交
2963 2964 2965 2966 2967 2968

        if (ret < 0) {
            error_report("Could not read file metadata: %s", strerror(-ret));
            goto out;
        }

2969
        if (entry_mergeable(&curr, &next)) {
P
Paolo Bonzini 已提交
2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982
            curr.length += next.length;
            continue;
        }

        if (curr.length > 0) {
            dump_map_entry(output_format, &curr, &next);
        }
        curr = next;
    }

    dump_map_entry(output_format, &curr, NULL);

out:
M
Markus Armbruster 已提交
2983
    blk_unref(blk);
P
Paolo Bonzini 已提交
2984 2985 2986
    return ret < 0;
}

2987 2988 2989 2990 2991
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

2992
static int img_snapshot(int argc, char **argv)
2993
{
M
Markus Armbruster 已提交
2994
    BlockBackend *blk;
2995 2996 2997
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
2998
    int c, ret = 0, bdrv_oflags;
2999 3000
    int action = 0;
    qemu_timeval tv;
3001
    bool quiet = false;
3002
    Error *err = NULL;
3003
    bool image_opts = false;
3004
    bool force_share = false;
3005

3006
    bdrv_oflags = BDRV_O_RDWR;
3007 3008
    /* Parse commandline parameters */
    for(;;) {
3009 3010 3011
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3012
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3013
            {"force-share", no_argument, 0, 'U'},
3014 3015
            {0, 0, 0, 0}
        };
3016
        c = getopt_long(argc, argv, ":la:c:d:hqU",
3017
                        long_options, NULL);
3018
        if (c == -1) {
3019
            break;
3020
        }
3021
        switch(c) {
3022 3023 3024
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
3025
        case '?':
3026 3027
            unrecognized_option(argv[optind - 1]);
            break;
3028 3029
        case 'h':
            help();
3030
            return 0;
3031 3032
        case 'l':
            if (action) {
F
Fam Zheng 已提交
3033
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3034
                return 0;
3035 3036
            }
            action = SNAPSHOT_LIST;
3037
            bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
3038 3039 3040
            break;
        case 'a':
            if (action) {
F
Fam Zheng 已提交
3041
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3042
                return 0;
3043 3044 3045 3046 3047 3048
            }
            action = SNAPSHOT_APPLY;
            snapshot_name = optarg;
            break;
        case 'c':
            if (action) {
F
Fam Zheng 已提交
3049
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3050
                return 0;
3051 3052 3053 3054 3055 3056
            }
            action = SNAPSHOT_CREATE;
            snapshot_name = optarg;
            break;
        case 'd':
            if (action) {
F
Fam Zheng 已提交
3057
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3058
                return 0;
3059 3060 3061 3062
            }
            action = SNAPSHOT_DELETE;
            snapshot_name = optarg;
            break;
3063 3064 3065
        case 'q':
            quiet = true;
            break;
3066 3067 3068
        case 'U':
            force_share = true;
            break;
3069 3070 3071 3072 3073 3074 3075 3076
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3077 3078 3079
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
3080 3081 3082
        }
    }

3083
    if (optind != argc - 1) {
F
Fam Zheng 已提交
3084
        error_exit("Expecting one image file name");
3085
    }
3086 3087
    filename = argv[optind++];

3088 3089
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3090
                          NULL, &error_fatal)) {
3091 3092 3093
        return 1;
    }

3094
    /* Open the image */
3095 3096
    blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
                   force_share);
3097 3098
    if (!blk) {
        return 1;
3099
    }
3100
    bs = blk_bs(blk);
3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116

    /* Perform the requested action */
    switch(action) {
    case SNAPSHOT_LIST:
        dump_snapshots(bs);
        break;

    case SNAPSHOT_CREATE:
        memset(&sn, 0, sizeof(sn));
        pstrcpy(sn.name, sizeof(sn.name), snapshot_name);

        qemu_gettimeofday(&tv);
        sn.date_sec = tv.tv_sec;
        sn.date_nsec = tv.tv_usec * 1000;

        ret = bdrv_snapshot_create(bs, &sn);
3117
        if (ret) {
3118
            error_report("Could not create snapshot '%s': %d (%s)",
3119
                snapshot_name, ret, strerror(-ret));
3120
        }
3121 3122 3123
        break;

    case SNAPSHOT_APPLY:
3124
        ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
3125
        if (ret) {
3126 3127
            error_reportf_err(err, "Could not apply snapshot '%s': ",
                              snapshot_name);
3128
        }
3129 3130 3131
        break;

    case SNAPSHOT_DELETE:
3132 3133 3134 3135
        ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
        if (ret < 0) {
            error_report("Could not delete snapshot '%s': snapshot not "
                         "found", snapshot_name);
3136
            ret = 1;
3137 3138 3139 3140 3141 3142 3143
        } else {
            ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
            if (ret < 0) {
                error_reportf_err(err, "Could not delete snapshot '%s': ",
                                  snapshot_name);
                ret = 1;
            }
3144
        }
3145 3146 3147 3148
        break;
    }

    /* Cleanup */
M
Markus Armbruster 已提交
3149
    blk_unref(blk);
3150 3151 3152
    if (ret) {
        return 1;
    }
3153
    return 0;
3154 3155
}

K
Kevin Wolf 已提交
3156 3157
static int img_rebase(int argc, char **argv)
{
M
Markus Armbruster 已提交
3158
    BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
P
Paolo Bonzini 已提交
3159 3160
    uint8_t *buf_old = NULL;
    uint8_t *buf_new = NULL;
3161
    BlockDriverState *bs = NULL;
K
Kevin Wolf 已提交
3162
    char *filename;
3163 3164
    const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
    int c, flags, src_flags, ret;
3165
    bool writethrough, src_writethrough;
K
Kevin Wolf 已提交
3166
    int unsafe = 0;
3167
    bool force_share = false;
3168
    int progress = 0;
3169
    bool quiet = false;
3170
    Error *local_err = NULL;
3171
    bool image_opts = false;
K
Kevin Wolf 已提交
3172 3173

    /* Parse commandline parameters */
K
Kevin Wolf 已提交
3174
    fmt = NULL;
3175
    cache = BDRV_DEFAULT_CACHE;
3176
    src_cache = BDRV_DEFAULT_CACHE;
K
Kevin Wolf 已提交
3177 3178 3179
    out_baseimg = NULL;
    out_basefmt = NULL;
    for(;;) {
3180 3181 3182
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3183
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3184
            {"force-share", no_argument, 0, 'U'},
3185 3186
            {0, 0, 0, 0}
        };
3187
        c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
3188
                        long_options, NULL);
3189
        if (c == -1) {
K
Kevin Wolf 已提交
3190
            break;
3191
        }
K
Kevin Wolf 已提交
3192
        switch(c) {
3193 3194 3195
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
3196
        case '?':
3197 3198
            unrecognized_option(argv[optind - 1]);
            break;
K
Kevin Wolf 已提交
3199 3200 3201
        case 'h':
            help();
            return 0;
K
Kevin Wolf 已提交
3202 3203 3204
        case 'f':
            fmt = optarg;
            break;
K
Kevin Wolf 已提交
3205 3206 3207 3208 3209 3210 3211 3212 3213
        case 'F':
            out_basefmt = optarg;
            break;
        case 'b':
            out_baseimg = optarg;
            break;
        case 'u':
            unsafe = 1;
            break;
3214 3215 3216
        case 'p':
            progress = 1;
            break;
3217 3218 3219
        case 't':
            cache = optarg;
            break;
3220 3221 3222
        case 'T':
            src_cache = optarg;
            break;
3223 3224 3225
        case 'q':
            quiet = true;
            break;
3226 3227 3228 3229 3230 3231 3232 3233
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3234 3235 3236
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
3237 3238 3239
        case 'U':
            force_share = true;
            break;
K
Kevin Wolf 已提交
3240 3241 3242
        }
    }

3243 3244 3245 3246
    if (quiet) {
        progress = 0;
    }

F
Fam Zheng 已提交
3247 3248 3249 3250 3251
    if (optind != argc - 1) {
        error_exit("Expecting one image file name");
    }
    if (!unsafe && !out_baseimg) {
        error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3252
    }
K
Kevin Wolf 已提交
3253 3254
    filename = argv[optind++];

3255 3256
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3257
                          NULL, &error_fatal)) {
3258 3259 3260
        return 1;
    }

3261 3262 3263
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

3264
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
3265
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3266 3267
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
3268
        goto out;
3269 3270
    }

3271 3272
    src_flags = 0;
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
3273 3274
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
3275
        goto out;
3276 3277
    }

3278 3279 3280 3281
    /* The source files are opened read-only, don't care about WCE */
    assert((src_flags & BDRV_O_RDWR) == 0);
    (void) src_writethrough;

K
Kevin Wolf 已提交
3282 3283 3284 3285 3286 3287
    /*
     * Open the images.
     *
     * Ignore the old backing file for unsafe rebase in case we want to correct
     * the reference to a renamed or moved backing file.
     */
3288 3289
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   false);
3290
    if (!blk) {
3291 3292
        ret = -1;
        goto out;
3293
    }
3294
    bs = blk_bs(blk);
K
Kevin Wolf 已提交
3295 3296

    if (out_basefmt != NULL) {
3297
        if (bdrv_find_format(out_basefmt) == NULL) {
3298
            error_report("Invalid format name: '%s'", out_basefmt);
3299 3300
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
3301 3302 3303 3304
        }
    }

    /* For safe rebasing we need to compare old and new backing file */
3305
    if (!unsafe) {
3306
        char backing_name[PATH_MAX];
3307 3308 3309 3310
        QDict *options = NULL;

        if (bs->backing_format[0] != '\0') {
            options = qdict_new();
3311
            qdict_put_str(options, "driver", bs->backing_format);
3312
        }
K
Kevin Wolf 已提交
3313

3314 3315 3316 3317
        if (force_share) {
            if (!options) {
                options = qdict_new();
            }
3318
            qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3319
        }
K
Kevin Wolf 已提交
3320
        bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3321
        blk_old_backing = blk_new_open(backing_name, NULL,
3322 3323
                                       options, src_flags, &local_err);
        if (!blk_old_backing) {
3324 3325 3326
            error_reportf_err(local_err,
                              "Could not open old backing file '%s': ",
                              backing_name);
3327
            ret = -1;
3328
            goto out;
K
Kevin Wolf 已提交
3329
        }
3330

3331
        if (out_baseimg[0]) {
3332 3333 3334
            const char *overlay_filename;
            char *out_real_path;

3335
            options = qdict_new();
3336
            if (out_basefmt) {
3337
                qdict_put_str(options, "driver", out_basefmt);
3338 3339 3340
            }
            if (force_share) {
                qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3341 3342
            }

3343
            bdrv_refresh_filename(bs);
3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361
            overlay_filename = bs->exact_filename[0] ? bs->exact_filename
                                                     : bs->filename;
            out_real_path = g_malloc(PATH_MAX);

            bdrv_get_full_backing_filename_from_filename(overlay_filename,
                                                         out_baseimg,
                                                         out_real_path,
                                                         PATH_MAX,
                                                         &local_err);
            if (local_err) {
                error_reportf_err(local_err,
                                  "Could not resolve backing filename: ");
                ret = -1;
                g_free(out_real_path);
                goto out;
            }

            blk_new_backing = blk_new_open(out_real_path, NULL,
3362
                                           options, src_flags, &local_err);
3363
            g_free(out_real_path);
3364
            if (!blk_new_backing) {
3365 3366 3367
                error_reportf_err(local_err,
                                  "Could not open new backing file '%s': ",
                                  out_baseimg);
3368
                ret = -1;
3369 3370
                goto out;
            }
K
Kevin Wolf 已提交
3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383
        }
    }

    /*
     * Check each unallocated cluster in the COW file. If it is unallocated,
     * accesses go to the backing file. We must therefore compare this cluster
     * in the old and new backing file, and if they differ we need to copy it
     * from the old backing file into the COW file.
     *
     * If qemu-img crashes during this step, no harm is done. The content of
     * the image is the same as the original one at any time.
     */
    if (!unsafe) {
3384 3385 3386 3387 3388
        int64_t size;
        int64_t old_backing_size;
        int64_t new_backing_size = 0;
        uint64_t offset;
        int64_t n;
3389
        float local_progress = 0;
3390

3391 3392
        buf_old = blk_blockalign(blk, IO_BUF_SIZE);
        buf_new = blk_blockalign(blk, IO_BUF_SIZE);
K
Kevin Wolf 已提交
3393

3394 3395
        size = blk_getlength(blk);
        if (size < 0) {
3396
            error_report("Could not get size of '%s': %s",
3397
                         filename, strerror(-size));
3398 3399 3400
            ret = -1;
            goto out;
        }
3401 3402
        old_backing_size = blk_getlength(blk_old_backing);
        if (old_backing_size < 0) {
3403
            char backing_name[PATH_MAX];
3404 3405 3406

            bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
            error_report("Could not get size of '%s': %s",
3407
                         backing_name, strerror(-old_backing_size));
3408 3409 3410
            ret = -1;
            goto out;
        }
3411
        if (blk_new_backing) {
3412 3413
            new_backing_size = blk_getlength(blk_new_backing);
            if (new_backing_size < 0) {
3414
                error_report("Could not get size of '%s': %s",
3415
                             out_baseimg, strerror(-new_backing_size));
3416 3417 3418
                ret = -1;
                goto out;
            }
3419
        }
K
Kevin Wolf 已提交
3420

3421 3422
        if (size != 0) {
            local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
3423 3424
        }

3425 3426 3427
        for (offset = 0; offset < size; offset += n) {
            /* How many bytes can we handle with the next read? */
            n = MIN(IO_BUF_SIZE, size - offset);
K
Kevin Wolf 已提交
3428 3429

            /* If the cluster is allocated, we don't need to take action */
3430
            ret = bdrv_is_allocated(bs, offset, n, &n);
3431 3432 3433 3434 3435
            if (ret < 0) {
                error_report("error while reading image metadata: %s",
                             strerror(-ret));
                goto out;
            }
3436
            if (ret) {
K
Kevin Wolf 已提交
3437 3438 3439
                continue;
            }

3440 3441 3442 3443
            /*
             * Read old and new backing file and take into consideration that
             * backing files may be smaller than the COW image.
             */
3444 3445
            if (offset >= old_backing_size) {
                memset(buf_old, 0, n);
3446
            } else {
3447 3448
                if (offset + n > old_backing_size) {
                    n = old_backing_size - offset;
3449 3450
                }

3451
                ret = blk_pread(blk_old_backing, offset, buf_old, n);
3452 3453 3454 3455
                if (ret < 0) {
                    error_report("error while reading from old backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3456
            }
3457

3458 3459
            if (offset >= new_backing_size || !blk_new_backing) {
                memset(buf_new, 0, n);
3460
            } else {
3461 3462
                if (offset + n > new_backing_size) {
                    n = new_backing_size - offset;
3463 3464
                }

3465
                ret = blk_pread(blk_new_backing, offset, buf_new, n);
3466 3467 3468 3469
                if (ret < 0) {
                    error_report("error while reading from new backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3470 3471 3472 3473 3474
            }

            /* If they differ, we need to write to the COW file */
            uint64_t written = 0;

3475
            while (written < n) {
3476
                int64_t pnum;
K
Kevin Wolf 已提交
3477

3478 3479
                if (compare_buffers(buf_old + written, buf_new + written,
                                    n - written, &pnum))
K
Kevin Wolf 已提交
3480
                {
3481
                    ret = blk_pwrite(blk, offset + written,
3482
                                     buf_old + written, pnum, 0);
K
Kevin Wolf 已提交
3483
                    if (ret < 0) {
3484
                        error_report("Error while writing to COW image: %s",
K
Kevin Wolf 已提交
3485
                            strerror(-ret));
3486
                        goto out;
K
Kevin Wolf 已提交
3487 3488 3489 3490 3491
                    }
                }

                written += pnum;
            }
3492
            qemu_progress_print(local_progress, 100);
K
Kevin Wolf 已提交
3493 3494 3495 3496 3497 3498 3499 3500
        }
    }

    /*
     * Change the backing file. All clusters that are different from the old
     * backing file are overwritten in the COW file now, so the visible content
     * doesn't change when we switch the backing file.
     */
3501 3502 3503 3504 3505 3506
    if (out_baseimg && *out_baseimg) {
        ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
    } else {
        ret = bdrv_change_backing_file(bs, NULL, NULL);
    }

K
Kevin Wolf 已提交
3507
    if (ret == -ENOSPC) {
3508 3509
        error_report("Could not change the backing file to '%s': No "
                     "space left in the file header", out_baseimg);
K
Kevin Wolf 已提交
3510
    } else if (ret < 0) {
3511
        error_report("Could not change the backing file to '%s': %s",
K
Kevin Wolf 已提交
3512 3513 3514
            out_baseimg, strerror(-ret));
    }

3515
    qemu_progress_print(100, 0);
K
Kevin Wolf 已提交
3516 3517 3518 3519 3520 3521
    /*
     * TODO At this point it is possible to check if any clusters that are
     * allocated in the COW file are the same in the backing file. If so, they
     * could be dropped from the COW file. Don't do this before switching the
     * backing file, in case of a crash this would lead to corruption.
     */
3522
out:
3523
    qemu_progress_end();
K
Kevin Wolf 已提交
3524 3525
    /* Cleanup */
    if (!unsafe) {
M
Markus Armbruster 已提交
3526 3527
        blk_unref(blk_old_backing);
        blk_unref(blk_new_backing);
K
Kevin Wolf 已提交
3528
    }
P
Paolo Bonzini 已提交
3529 3530
    qemu_vfree(buf_old);
    qemu_vfree(buf_new);
K
Kevin Wolf 已提交
3531

M
Markus Armbruster 已提交
3532
    blk_unref(blk);
3533 3534 3535
    if (ret) {
        return 1;
    }
K
Kevin Wolf 已提交
3536 3537 3538
    return 0;
}

3539 3540
static int img_resize(int argc, char **argv)
{
3541
    Error *err = NULL;
3542 3543
    int c, ret, relative;
    const char *filename, *fmt, *size;
M
Max Reitz 已提交
3544
    int64_t n, total_size, current_size, new_size;
3545
    bool quiet = false;
M
Markus Armbruster 已提交
3546
    BlockBackend *blk = NULL;
3547
    PreallocMode prealloc = PREALLOC_MODE_OFF;
3548
    QemuOpts *param;
3549

3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560
    static QemuOptsList resize_options = {
        .name = "resize_options",
        .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
        .desc = {
            {
                .name = BLOCK_OPT_SIZE,
                .type = QEMU_OPT_SIZE,
                .help = "Virtual disk size"
            }, {
                /* end of list */
            }
3561 3562
        },
    };
3563
    bool image_opts = false;
3564
    bool shrink = false;
3565

K
Kevin Wolf 已提交
3566 3567 3568
    /* Remove size from argv manually so that negative numbers are not treated
     * as options by getopt. */
    if (argc < 3) {
F
Fam Zheng 已提交
3569
        error_exit("Not enough arguments");
K
Kevin Wolf 已提交
3570 3571 3572 3573 3574 3575
        return 1;
    }

    size = argv[--argc];

    /* Parse getopt arguments */
3576 3577
    fmt = NULL;
    for(;;) {
3578 3579 3580
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3581
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3582
            {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
3583
            {"shrink", no_argument, 0, OPTION_SHRINK},
3584 3585
            {0, 0, 0, 0}
        };
3586
        c = getopt_long(argc, argv, ":f:hq",
3587
                        long_options, NULL);
3588 3589 3590 3591
        if (c == -1) {
            break;
        }
        switch(c) {
3592 3593 3594
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
3595
        case '?':
3596 3597
            unrecognized_option(argv[optind - 1]);
            break;
3598 3599 3600 3601 3602 3603
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
3604 3605 3606
        case 'q':
            quiet = true;
            break;
3607 3608 3609 3610 3611 3612 3613 3614
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3615 3616 3617
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
3618
        case OPTION_PREALLOCATION:
3619
            prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
3620
                                       PREALLOC_MODE__MAX, NULL);
3621 3622 3623 3624 3625
            if (prealloc == PREALLOC_MODE__MAX) {
                error_report("Invalid preallocation mode '%s'", optarg);
                return 1;
            }
            break;
3626 3627 3628
        case OPTION_SHRINK:
            shrink = true;
            break;
3629 3630
        }
    }
3631
    if (optind != argc - 1) {
3632
        error_exit("Expecting image file name and size");
3633 3634 3635
    }
    filename = argv[optind++];

3636 3637
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3638
                          NULL, &error_fatal)) {
3639 3640 3641
        return 1;
    }

3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657
    /* Choose grow, shrink, or absolute resize mode */
    switch (size[0]) {
    case '+':
        relative = 1;
        size++;
        break;
    case '-':
        relative = -1;
        size++;
        break;
    default:
        relative = 0;
        break;
    }

    /* Parse size */
3658
    param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3659
    qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3660 3661
    if (err) {
        error_report_err(err);
3662
        ret = -1;
3663
        qemu_opts_del(param);
3664
        goto out;
3665
    }
3666 3667
    n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
    qemu_opts_del(param);
3668

3669
    blk = img_open(image_opts, filename, fmt,
3670 3671
                   BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
                   false);
3672
    if (!blk) {
3673 3674
        ret = -1;
        goto out;
3675
    }
3676

3677 3678 3679 3680 3681 3682 3683 3684
    current_size = blk_getlength(blk);
    if (current_size < 0) {
        error_report("Failed to inquire current image length: %s",
                     strerror(-current_size));
        ret = -1;
        goto out;
    }

3685
    if (relative) {
3686
        total_size = current_size + n * relative;
3687 3688 3689 3690
    } else {
        total_size = n;
    }
    if (total_size <= 0) {
3691
        error_report("New image size must be positive");
3692 3693
        ret = -1;
        goto out;
3694 3695
    }

3696 3697 3698 3699 3700 3701
    if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
        error_report("Preallocation can only be used for growing images");
        ret = -1;
        goto out;
    }

3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718
    if (total_size < current_size && !shrink) {
        warn_report("Shrinking an image will delete all data beyond the "
                    "shrunken image's end. Before performing such an "
                    "operation, make sure there is no important data there.");

        if (g_strcmp0(bdrv_get_format_name(blk_bs(blk)), "raw") != 0) {
            error_report(
              "Use the --shrink option to perform a shrink operation.");
            ret = -1;
            goto out;
        } else {
            warn_report("Using the --shrink option will suppress this message. "
                        "Note that future versions of qemu-img may refuse to "
                        "shrink images without this option.");
        }
    }

3719
    ret = blk_truncate(blk, total_size, prealloc, &err);
M
Max Reitz 已提交
3720
    if (ret < 0) {
3721
        error_report_err(err);
M
Max Reitz 已提交
3722 3723 3724 3725 3726 3727 3728 3729 3730
        goto out;
    }

    new_size = blk_getlength(blk);
    if (new_size < 0) {
        error_report("Failed to verify truncated image length: %s",
                     strerror(-new_size));
        ret = -1;
        goto out;
3731
    }
M
Max Reitz 已提交
3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755

    /* Some block drivers implement a truncation method, but only so
     * the user can cause qemu to refresh the image's size from disk.
     * The idea is that the user resizes the image outside of qemu and
     * then invokes block_resize to inform qemu about it.
     * (This includes iscsi and file-posix for device files.)
     * Of course, that is not the behavior someone invoking
     * qemu-img resize would find useful, so we catch that behavior
     * here and tell the user. */
    if (new_size != total_size && new_size == current_size) {
        error_report("Image was not resized; resizing may not be supported "
                     "for this image");
        ret = -1;
        goto out;
    }

    if (new_size != total_size) {
        warn_report("Image should have been resized to %" PRIi64
                    " bytes, but was resized to %" PRIi64 " bytes",
                    total_size, new_size);
    }

    qprintf(quiet, "Image resized.\n");

3756
out:
M
Markus Armbruster 已提交
3757
    blk_unref(blk);
3758 3759 3760
    if (ret) {
        return 1;
    }
3761 3762 3763
    return 0;
}

3764
static void amend_status_cb(BlockDriverState *bs,
3765 3766
                            int64_t offset, int64_t total_work_size,
                            void *opaque)
3767 3768 3769 3770
{
    qemu_progress_print(100.f * offset / total_work_size, 0);
}

3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791
static int print_amend_option_help(const char *format)
{
    BlockDriver *drv;

    /* Find driver and parse its options */
    drv = bdrv_find_format(format);
    if (!drv) {
        error_report("Unknown file format '%s'", format);
        return 1;
    }

    if (!drv->bdrv_amend_options) {
        error_report("Format driver '%s' does not support option amendment",
                     format);
        return 1;
    }

    /* Every driver supporting amendment must have create_opts */
    assert(drv->create_opts);

    printf("Creation options for '%s':\n", format);
M
Max Reitz 已提交
3792
    qemu_opts_print_help(drv->create_opts, false);
3793 3794 3795 3796
    printf("\nNote that not all of these options may be amendable.\n");
    return 0;
}

M
Max Reitz 已提交
3797 3798
static int img_amend(int argc, char **argv)
{
3799
    Error *err = NULL;
M
Max Reitz 已提交
3800 3801
    int c, ret = 0;
    char *options = NULL;
3802 3803
    QemuOptsList *create_opts = NULL;
    QemuOpts *opts = NULL;
3804 3805
    const char *fmt = NULL, *filename, *cache;
    int flags;
3806
    bool writethrough;
3807
    bool quiet = false, progress = false;
M
Markus Armbruster 已提交
3808
    BlockBackend *blk = NULL;
M
Max Reitz 已提交
3809
    BlockDriverState *bs = NULL;
3810
    bool image_opts = false;
M
Max Reitz 已提交
3811

3812
    cache = BDRV_DEFAULT_CACHE;
M
Max Reitz 已提交
3813
    for (;;) {
3814 3815 3816
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3817
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3818 3819
            {0, 0, 0, 0}
        };
3820
        c = getopt_long(argc, argv, ":ho:f:t:pq",
3821
                        long_options, NULL);
M
Max Reitz 已提交
3822 3823 3824 3825 3826
        if (c == -1) {
            break;
        }

        switch (c) {
3827 3828 3829
        case ':':
            missing_argument(argv[optind - 1]);
            break;
3830
        case '?':
3831 3832 3833
            unrecognized_option(argv[optind - 1]);
            break;
        case 'h':
3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872
            help();
            break;
        case 'o':
            if (!is_valid_option_list(optarg)) {
                error_report("Invalid option list: %s", optarg);
                ret = -1;
                goto out_no_progress;
            }
            if (!options) {
                options = g_strdup(optarg);
            } else {
                char *old_options = options;
                options = g_strdup_printf("%s,%s", options, optarg);
                g_free(old_options);
            }
            break;
        case 'f':
            fmt = optarg;
            break;
        case 't':
            cache = optarg;
            break;
        case 'p':
            progress = true;
            break;
        case 'q':
            quiet = true;
            break;
        case OPTION_OBJECT:
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                ret = -1;
                goto out_no_progress;
            }
            break;
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
M
Max Reitz 已提交
3873 3874 3875
        }
    }

3876
    if (!options) {
F
Fam Zheng 已提交
3877
        error_exit("Must specify options (-o)");
M
Max Reitz 已提交
3878 3879
    }

3880 3881
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3882
                          NULL, &error_fatal)) {
3883 3884 3885 3886
        ret = -1;
        goto out_no_progress;
    }

3887 3888 3889 3890 3891
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);

3892 3893 3894 3895
    filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
    if (fmt && has_help_option(options)) {
        /* If a format is explicitly specified (and possibly no filename is
         * given), print option help here */
3896
        ret = print_amend_option_help(fmt);
3897
        goto out;
M
Max Reitz 已提交
3898 3899
    }

3900
    if (optind != argc - 1) {
M
Max Reitz 已提交
3901 3902 3903
        error_report("Expecting one image file name");
        ret = -1;
        goto out;
3904
    }
M
Max Reitz 已提交
3905

3906 3907
    flags = BDRV_O_RDWR;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3908 3909 3910 3911 3912
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        goto out;
    }

3913 3914
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   false);
3915
    if (!blk) {
M
Max Reitz 已提交
3916 3917 3918
        ret = -1;
        goto out;
    }
3919
    bs = blk_bs(blk);
M
Max Reitz 已提交
3920 3921 3922

    fmt = bs->drv->format_name;

3923
    if (has_help_option(options)) {
3924
        /* If the format was auto-detected, print option help here */
3925
        ret = print_amend_option_help(fmt);
M
Max Reitz 已提交
3926 3927 3928
        goto out;
    }

3929 3930
    if (!bs->drv->bdrv_amend_options) {
        error_report("Format driver '%s' does not support option amendment",
3931 3932 3933 3934 3935
                     fmt);
        ret = -1;
        goto out;
    }

3936 3937 3938
    /* Every driver supporting amendment must have create_opts */
    assert(bs->drv->create_opts);

C
Chunyan Liu 已提交
3939
    create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3940
    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
P
Paolo Bonzini 已提交
3941 3942 3943 3944 3945
    qemu_opts_do_parse(opts, options, NULL, &err);
    if (err) {
        error_report_err(err);
        ret = -1;
        goto out;
M
Max Reitz 已提交
3946 3947
    }

3948 3949
    /* In case the driver does not call amend_status_cb() */
    qemu_progress_print(0.f, 0);
3950
    ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, &err);
3951
    qemu_progress_print(100.f, 0);
M
Max Reitz 已提交
3952
    if (ret < 0) {
3953
        error_report_err(err);
M
Max Reitz 已提交
3954 3955 3956 3957
        goto out;
    }

out:
3958 3959
    qemu_progress_end();

3960
out_no_progress:
M
Markus Armbruster 已提交
3961
    blk_unref(blk);
3962 3963
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
3964 3965
    g_free(options);

M
Max Reitz 已提交
3966 3967 3968 3969 3970 3971
    if (ret) {
        return 1;
    }
    return 0;
}

K
Kevin Wolf 已提交
3972 3973 3974
typedef struct BenchData {
    BlockBackend *blk;
    uint64_t image_size;
K
Kevin Wolf 已提交
3975
    bool write;
K
Kevin Wolf 已提交
3976
    int bufsize;
3977
    int step;
K
Kevin Wolf 已提交
3978 3979
    int nrreq;
    int n;
3980 3981
    int flush_interval;
    bool drain_on_flush;
K
Kevin Wolf 已提交
3982 3983 3984 3985
    uint8_t *buf;
    QEMUIOVector *qiov;

    int in_flight;
3986
    bool in_flush;
K
Kevin Wolf 已提交
3987 3988 3989
    uint64_t offset;
} BenchData;

3990 3991 3992
static void bench_undrained_flush_cb(void *opaque, int ret)
{
    if (ret < 0) {
3993
        error_report("Failed flush request: %s", strerror(-ret));
3994 3995 3996 3997
        exit(EXIT_FAILURE);
    }
}

K
Kevin Wolf 已提交
3998 3999 4000 4001 4002 4003
static void bench_cb(void *opaque, int ret)
{
    BenchData *b = opaque;
    BlockAIOCB *acb;

    if (ret < 0) {
4004
        error_report("Failed request: %s", strerror(-ret));
K
Kevin Wolf 已提交
4005 4006
        exit(EXIT_FAILURE);
    }
4007 4008 4009 4010 4011 4012 4013 4014

    if (b->in_flush) {
        /* Just finished a flush with drained queue: Start next requests */
        assert(b->in_flight == 0);
        b->in_flush = false;
    } else if (b->in_flight > 0) {
        int remaining = b->n - b->in_flight;

K
Kevin Wolf 已提交
4015 4016
        b->n--;
        b->in_flight--;
4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039

        /* Time for flush? Drain queue if requested, then flush */
        if (b->flush_interval && remaining % b->flush_interval == 0) {
            if (!b->in_flight || !b->drain_on_flush) {
                BlockCompletionFunc *cb;

                if (b->drain_on_flush) {
                    b->in_flush = true;
                    cb = bench_cb;
                } else {
                    cb = bench_undrained_flush_cb;
                }

                acb = blk_aio_flush(b->blk, cb, b);
                if (!acb) {
                    error_report("Failed to issue flush request");
                    exit(EXIT_FAILURE);
                }
            }
            if (b->drain_on_flush) {
                return;
            }
        }
K
Kevin Wolf 已提交
4040 4041 4042
    }

    while (b->n > b->in_flight && b->in_flight < b->nrreq) {
4043 4044 4045 4046 4047 4048 4049 4050
        int64_t offset = b->offset;
        /* blk_aio_* might look for completed I/Os and kick bench_cb
         * again, so make sure this operation is counted by in_flight
         * and b->offset is ready for the next submission.
         */
        b->in_flight++;
        b->offset += b->step;
        b->offset %= b->image_size;
K
Kevin Wolf 已提交
4051
        if (b->write) {
4052
            acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
K
Kevin Wolf 已提交
4053
        } else {
4054
            acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
K
Kevin Wolf 已提交
4055
        }
K
Kevin Wolf 已提交
4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068
        if (!acb) {
            error_report("Failed to issue request");
            exit(EXIT_FAILURE);
        }
    }
}

static int img_bench(int argc, char **argv)
{
    int c, ret = 0;
    const char *fmt = NULL, *filename;
    bool quiet = false;
    bool image_opts = false;
K
Kevin Wolf 已提交
4069
    bool is_write = false;
K
Kevin Wolf 已提交
4070 4071
    int count = 75000;
    int depth = 64;
4072
    int64_t offset = 0;
K
Kevin Wolf 已提交
4073
    size_t bufsize = 4096;
K
Kevin Wolf 已提交
4074
    int pattern = 0;
4075
    size_t step = 0;
4076 4077
    int flush_interval = 0;
    bool drain_on_flush = true;
K
Kevin Wolf 已提交
4078 4079 4080 4081
    int64_t image_size;
    BlockBackend *blk = NULL;
    BenchData data = {};
    int flags = 0;
4082
    bool writethrough = false;
K
Kevin Wolf 已提交
4083 4084
    struct timeval t1, t2;
    int i;
4085
    bool force_share = false;
F
Fam Zheng 已提交
4086
    size_t buf_size;
K
Kevin Wolf 已提交
4087 4088 4089 4090

    for (;;) {
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
4091
            {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
K
Kevin Wolf 已提交
4092
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
K
Kevin Wolf 已提交
4093
            {"pattern", required_argument, 0, OPTION_PATTERN},
4094
            {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
4095
            {"force-share", no_argument, 0, 'U'},
K
Kevin Wolf 已提交
4096 4097
            {0, 0, 0, 0}
        };
4098
        c = getopt_long(argc, argv, ":hc:d:f:no:qs:S:t:wU", long_options, NULL);
K
Kevin Wolf 已提交
4099 4100 4101 4102 4103
        if (c == -1) {
            break;
        }

        switch (c) {
4104 4105 4106
        case ':':
            missing_argument(argv[optind - 1]);
            break;
K
Kevin Wolf 已提交
4107
        case '?':
4108 4109 4110
            unrecognized_option(argv[optind - 1]);
            break;
        case 'h':
K
Kevin Wolf 已提交
4111 4112 4113 4114
            help();
            break;
        case 'c':
        {
4115 4116 4117
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
K
Kevin Wolf 已提交
4118 4119 4120
                error_report("Invalid request count specified");
                return 1;
            }
4121
            count = res;
K
Kevin Wolf 已提交
4122 4123 4124 4125
            break;
        }
        case 'd':
        {
4126 4127 4128
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
K
Kevin Wolf 已提交
4129 4130 4131
                error_report("Invalid queue depth specified");
                return 1;
            }
4132
            depth = res;
K
Kevin Wolf 已提交
4133 4134 4135 4136 4137 4138 4139 4140
            break;
        }
        case 'f':
            fmt = optarg;
            break;
        case 'n':
            flags |= BDRV_O_NATIVE_AIO;
            break;
4141 4142
        case 'o':
        {
4143 4144
            offset = cvtnum(optarg);
            if (offset < 0) {
4145 4146 4147 4148 4149 4150
                error_report("Invalid offset specified");
                return 1;
            }
            break;
        }
            break;
K
Kevin Wolf 已提交
4151 4152 4153 4154 4155 4156 4157
        case 'q':
            quiet = true;
            break;
        case 's':
        {
            int64_t sval;

4158 4159
            sval = cvtnum(optarg);
            if (sval < 0 || sval > INT_MAX) {
K
Kevin Wolf 已提交
4160 4161 4162 4163 4164 4165 4166
                error_report("Invalid buffer size specified");
                return 1;
            }

            bufsize = sval;
            break;
        }
4167 4168 4169 4170
        case 'S':
        {
            int64_t sval;

4171 4172
            sval = cvtnum(optarg);
            if (sval < 0 || sval > INT_MAX) {
4173 4174 4175 4176 4177 4178 4179
                error_report("Invalid step size specified");
                return 1;
            }

            step = sval;
            break;
        }
K
Kevin Wolf 已提交
4180 4181 4182 4183 4184 4185 4186 4187
        case 't':
            ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
            if (ret < 0) {
                error_report("Invalid cache mode");
                ret = -1;
                goto out;
            }
            break;
K
Kevin Wolf 已提交
4188 4189 4190 4191
        case 'w':
            flags |= BDRV_O_RDWR;
            is_write = true;
            break;
4192 4193 4194
        case 'U':
            force_share = true;
            break;
K
Kevin Wolf 已提交
4195 4196
        case OPTION_PATTERN:
        {
4197 4198 4199
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
K
Kevin Wolf 已提交
4200 4201 4202
                error_report("Invalid pattern byte specified");
                return 1;
            }
4203
            pattern = res;
K
Kevin Wolf 已提交
4204 4205
            break;
        }
4206 4207
        case OPTION_FLUSH_INTERVAL:
        {
4208 4209 4210
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4211 4212 4213
                error_report("Invalid flush interval specified");
                return 1;
            }
4214
            flush_interval = res;
4215 4216 4217 4218 4219
            break;
        }
        case OPTION_NO_DRAIN:
            drain_on_flush = false;
            break;
K
Kevin Wolf 已提交
4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
        }
    }

    if (optind != argc - 1) {
        error_exit("Expecting one image file name");
    }
    filename = argv[argc - 1];

4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241
    if (!is_write && flush_interval) {
        error_report("--flush-interval is only available in write tests");
        ret = -1;
        goto out;
    }
    if (flush_interval && flush_interval < depth) {
        error_report("Flush interval can't be smaller than depth");
        ret = -1;
        goto out;
    }

4242 4243
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   force_share);
K
Kevin Wolf 已提交
4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255
    if (!blk) {
        ret = -1;
        goto out;
    }

    image_size = blk_getlength(blk);
    if (image_size < 0) {
        ret = image_size;
        goto out;
    }

    data = (BenchData) {
4256 4257 4258 4259 4260 4261 4262 4263 4264 4265
        .blk            = blk,
        .image_size     = image_size,
        .bufsize        = bufsize,
        .step           = step ?: bufsize,
        .nrreq          = depth,
        .n              = count,
        .offset         = offset,
        .write          = is_write,
        .flush_interval = flush_interval,
        .drain_on_flush = drain_on_flush,
K
Kevin Wolf 已提交
4266
    };
4267
    printf("Sending %d %s requests, %d bytes each, %d in parallel "
4268
           "(starting at offset %" PRId64 ", step size %d)\n",
4269
           data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
4270
           data.offset, data.step);
4271 4272 4273
    if (flush_interval) {
        printf("Sending flush every %d requests\n", flush_interval);
    }
K
Kevin Wolf 已提交
4274

F
Fam Zheng 已提交
4275 4276
    buf_size = data.nrreq * data.bufsize;
    data.buf = blk_blockalign(blk, buf_size);
K
Kevin Wolf 已提交
4277 4278
    memset(data.buf, pattern, data.nrreq * data.bufsize);

F
Fam Zheng 已提交
4279 4280
    blk_register_buf(blk, data.buf, buf_size);

K
Kevin Wolf 已提交
4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300
    data.qiov = g_new(QEMUIOVector, data.nrreq);
    for (i = 0; i < data.nrreq; i++) {
        qemu_iovec_init(&data.qiov[i], 1);
        qemu_iovec_add(&data.qiov[i],
                       data.buf + i * data.bufsize, data.bufsize);
    }

    gettimeofday(&t1, NULL);
    bench_cb(&data, 0);

    while (data.n > 0) {
        main_loop_wait(false);
    }
    gettimeofday(&t2, NULL);

    printf("Run completed in %3.3f seconds.\n",
           (t2.tv_sec - t1.tv_sec)
           + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));

out:
F
Fam Zheng 已提交
4301 4302 4303
    if (data.buf) {
        blk_unregister_buf(blk, data.buf);
    }
K
Kevin Wolf 已提交
4304 4305 4306 4307
    qemu_vfree(data.buf);
    blk_unref(blk);

    if (ret) {
R
Reda Sallahi 已提交
4308 4309 4310 4311 4312 4313 4314 4315 4316
        return 1;
    }
    return 0;
}

#define C_BS      01
#define C_COUNT   02
#define C_IF      04
#define C_OF      010
R
Reda Sallahi 已提交
4317
#define C_SKIP    020
R
Reda Sallahi 已提交
4318 4319 4320 4321 4322 4323 4324 4325 4326 4327

struct DdInfo {
    unsigned int flags;
    int64_t count;
};

struct DdIo {
    int bsz;    /* Block size */
    char *filename;
    uint8_t *buf;
R
Reda Sallahi 已提交
4328
    int64_t offset;
R
Reda Sallahi 已提交
4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342
};

struct DdOpts {
    const char *name;
    int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
    unsigned int flag;
};

static int img_dd_bs(const char *arg,
                     struct DdIo *in, struct DdIo *out,
                     struct DdInfo *dd)
{
    int64_t res;

4343
    res = cvtnum(arg);
R
Reda Sallahi 已提交
4344

4345
    if (res <= 0 || res > INT_MAX) {
R
Reda Sallahi 已提交
4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357
        error_report("invalid number: '%s'", arg);
        return 1;
    }
    in->bsz = out->bsz = res;

    return 0;
}

static int img_dd_count(const char *arg,
                        struct DdIo *in, struct DdIo *out,
                        struct DdInfo *dd)
{
4358
    dd->count = cvtnum(arg);
R
Reda Sallahi 已提交
4359

4360
    if (dd->count < 0) {
R
Reda Sallahi 已提交
4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385
        error_report("invalid number: '%s'", arg);
        return 1;
    }

    return 0;
}

static int img_dd_if(const char *arg,
                     struct DdIo *in, struct DdIo *out,
                     struct DdInfo *dd)
{
    in->filename = g_strdup(arg);

    return 0;
}

static int img_dd_of(const char *arg,
                     struct DdIo *in, struct DdIo *out,
                     struct DdInfo *dd)
{
    out->filename = g_strdup(arg);

    return 0;
}

R
Reda Sallahi 已提交
4386 4387 4388 4389
static int img_dd_skip(const char *arg,
                       struct DdIo *in, struct DdIo *out,
                       struct DdInfo *dd)
{
4390
    in->offset = cvtnum(arg);
R
Reda Sallahi 已提交
4391

4392
    if (in->offset < 0) {
R
Reda Sallahi 已提交
4393 4394 4395 4396 4397 4398 4399
        error_report("invalid number: '%s'", arg);
        return 1;
    }

    return 0;
}

R
Reda Sallahi 已提交
4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415
static int img_dd(int argc, char **argv)
{
    int ret = 0;
    char *arg = NULL;
    char *tmp;
    BlockDriver *drv = NULL, *proto_drv = NULL;
    BlockBackend *blk1 = NULL, *blk2 = NULL;
    QemuOpts *opts = NULL;
    QemuOptsList *create_opts = NULL;
    Error *local_err = NULL;
    bool image_opts = false;
    int c, i;
    const char *out_fmt = "raw";
    const char *fmt = NULL;
    int64_t size = 0;
    int64_t block_count = 0, out_pos, in_pos;
4416
    bool force_share = false;
R
Reda Sallahi 已提交
4417 4418 4419 4420 4421 4422 4423
    struct DdInfo dd = {
        .flags = 0,
        .count = 0,
    };
    struct DdIo in = {
        .bsz = 512, /* Block size is by default 512 bytes */
        .filename = NULL,
R
Reda Sallahi 已提交
4424 4425
        .buf = NULL,
        .offset = 0
R
Reda Sallahi 已提交
4426 4427 4428 4429
    };
    struct DdIo out = {
        .bsz = 512,
        .filename = NULL,
R
Reda Sallahi 已提交
4430 4431
        .buf = NULL,
        .offset = 0
R
Reda Sallahi 已提交
4432 4433 4434 4435 4436 4437 4438
    };

    const struct DdOpts options[] = {
        { "bs", img_dd_bs, C_BS },
        { "count", img_dd_count, C_COUNT },
        { "if", img_dd_if, C_IF },
        { "of", img_dd_of, C_OF },
R
Reda Sallahi 已提交
4439
        { "skip", img_dd_skip, C_SKIP },
R
Reda Sallahi 已提交
4440 4441 4442 4443
        { NULL, NULL, 0 }
    };
    const struct option long_options[] = {
        { "help", no_argument, 0, 'h'},
4444
        { "object", required_argument, 0, OPTION_OBJECT},
R
Reda Sallahi 已提交
4445
        { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4446
        { "force-share", no_argument, 0, 'U'},
R
Reda Sallahi 已提交
4447 4448 4449
        { 0, 0, 0, 0 }
    };

4450
    while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
R
Reda Sallahi 已提交
4451 4452 4453 4454 4455 4456 4457 4458 4459 4460
        if (c == EOF) {
            break;
        }
        switch (c) {
        case 'O':
            out_fmt = optarg;
            break;
        case 'f':
            fmt = optarg;
            break;
4461 4462 4463
        case ':':
            missing_argument(argv[optind - 1]);
            break;
R
Reda Sallahi 已提交
4464
        case '?':
4465 4466
            unrecognized_option(argv[optind - 1]);
            break;
R
Reda Sallahi 已提交
4467 4468 4469
        case 'h':
            help();
            break;
4470 4471 4472
        case 'U':
            force_share = true;
            break;
4473 4474
        case OPTION_OBJECT:
            if (!qemu_opts_parse_noisily(&qemu_object_opts, optarg, true)) {
4475 4476 4477
                ret = -1;
                goto out;
            }
4478
            break;
R
Reda Sallahi 已提交
4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
        }
    }

    for (i = optind; i < argc; i++) {
        int j;
        arg = g_strdup(argv[i]);

        tmp = strchr(arg, '=');
        if (tmp == NULL) {
            error_report("unrecognized operand %s", arg);
            ret = -1;
            goto out;
        }

        *tmp++ = '\0';

        for (j = 0; options[j].name != NULL; j++) {
            if (!strcmp(arg, options[j].name)) {
                break;
            }
        }
        if (options[j].name == NULL) {
            error_report("unrecognized operand %s", arg);
            ret = -1;
            goto out;
        }

        if (options[j].f(tmp, &in, &out, &dd) != 0) {
            ret = -1;
            goto out;
        }
        dd.flags |= options[j].flag;
        g_free(arg);
        arg = NULL;
    }

    if (!(dd.flags & C_IF && dd.flags & C_OF)) {
        error_report("Must specify both input and output files");
        ret = -1;
        goto out;
    }
4523 4524 4525

    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
4526
                          NULL, &error_fatal)) {
4527 4528 4529 4530
        ret = -1;
        goto out;
    }

4531 4532
    blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
                    force_share);
R
Reda Sallahi 已提交
4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580

    if (!blk1) {
        ret = -1;
        goto out;
    }

    drv = bdrv_find_format(out_fmt);
    if (!drv) {
        error_report("Unknown file format");
        ret = -1;
        goto out;
    }
    proto_drv = bdrv_find_protocol(out.filename, true, &local_err);

    if (!proto_drv) {
        error_report_err(local_err);
        ret = -1;
        goto out;
    }
    if (!drv->create_opts) {
        error_report("Format driver '%s' does not support image creation",
                     drv->format_name);
        ret = -1;
        goto out;
    }
    if (!proto_drv->create_opts) {
        error_report("Protocol driver '%s' does not support image creation",
                     proto_drv->format_name);
        ret = -1;
        goto out;
    }
    create_opts = qemu_opts_append(create_opts, drv->create_opts);
    create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);

    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);

    size = blk_getlength(blk1);
    if (size < 0) {
        error_report("Failed to get size for '%s'", in.filename);
        ret = -1;
        goto out;
    }

    if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
        dd.count * in.bsz < size) {
        size = dd.count * in.bsz;
    }

R
Reda Sallahi 已提交
4581 4582 4583 4584 4585 4586 4587 4588
    /* Overflow means the specified offset is beyond input image's size */
    if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
                              size < in.bsz * in.offset)) {
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
    } else {
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
                            size - in.bsz * in.offset, &error_abort);
    }
R
Reda Sallahi 已提交
4589 4590 4591 4592 4593 4594 4595 4596 4597 4598

    ret = bdrv_create(drv, out.filename, opts, &local_err);
    if (ret < 0) {
        error_reportf_err(local_err,
                          "%s: error while creating output image: ",
                          out.filename);
        ret = -1;
        goto out;
    }

4599 4600 4601 4602 4603
    /* TODO, we can't honour --image-opts for the target,
     * since it needs to be given in a format compatible
     * with the bdrv_create() call above which does not
     * support image-opts style.
     */
4604
    blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
4605
                         false, false, false);
R
Reda Sallahi 已提交
4606 4607 4608 4609 4610 4611

    if (!blk2) {
        ret = -1;
        goto out;
    }

R
Reda Sallahi 已提交
4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622
    if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
                              size < in.offset * in.bsz)) {
        /* We give a warning if the skip option is bigger than the input
         * size and create an empty output disk image (i.e. like dd(1)).
         */
        error_report("%s: cannot skip to specified offset", in.filename);
        in_pos = size;
    } else {
        in_pos = in.offset * in.bsz;
    }

R
Reda Sallahi 已提交
4623 4624
    in.buf = g_new(uint8_t, in.bsz);

R
Reda Sallahi 已提交
4625
    for (out_pos = 0; in_pos < size; block_count++) {
R
Reda Sallahi 已提交
4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663
        int in_ret, out_ret;

        if (in_pos + in.bsz > size) {
            in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
        } else {
            in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
        }
        if (in_ret < 0) {
            error_report("error while reading from input image file: %s",
                         strerror(-in_ret));
            ret = -1;
            goto out;
        }
        in_pos += in_ret;

        out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);

        if (out_ret < 0) {
            error_report("error while writing to output image file: %s",
                         strerror(-out_ret));
            ret = -1;
            goto out;
        }
        out_pos += out_ret;
    }

out:
    g_free(arg);
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
    blk_unref(blk1);
    blk_unref(blk2);
    g_free(in.filename);
    g_free(out.filename);
    g_free(in.buf);
    g_free(out.buf);

    if (ret) {
K
Kevin Wolf 已提交
4664 4665 4666 4667 4668
        return 1;
    }
    return 0;
}

4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679
static void dump_json_block_measure_info(BlockMeasureInfo *info)
{
    QString *str;
    QObject *obj;
    Visitor *v = qobject_output_visitor_new(&obj);

    visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
    visit_complete(v, &obj);
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
4680
    qobject_unref(obj);
4681
    visit_free(v);
4682
    qobject_unref(str);
4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802
}

static int img_measure(int argc, char **argv)
{
    static const struct option long_options[] = {
        {"help", no_argument, 0, 'h'},
        {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
        {"object", required_argument, 0, OPTION_OBJECT},
        {"output", required_argument, 0, OPTION_OUTPUT},
        {"size", required_argument, 0, OPTION_SIZE},
        {"force-share", no_argument, 0, 'U'},
        {0, 0, 0, 0}
    };
    OutputFormat output_format = OFORMAT_HUMAN;
    BlockBackend *in_blk = NULL;
    BlockDriver *drv;
    const char *filename = NULL;
    const char *fmt = NULL;
    const char *out_fmt = "raw";
    char *options = NULL;
    char *snapshot_name = NULL;
    bool force_share = false;
    QemuOpts *opts = NULL;
    QemuOpts *object_opts = NULL;
    QemuOpts *sn_opts = NULL;
    QemuOptsList *create_opts = NULL;
    bool image_opts = false;
    uint64_t img_size = UINT64_MAX;
    BlockMeasureInfo *info = NULL;
    Error *local_err = NULL;
    int ret = 1;
    int c;

    while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
                            long_options, NULL)) != -1) {
        switch (c) {
        case '?':
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'O':
            out_fmt = optarg;
            break;
        case 'o':
            if (!is_valid_option_list(optarg)) {
                error_report("Invalid option list: %s", optarg);
                goto out;
            }
            if (!options) {
                options = g_strdup(optarg);
            } else {
                char *old_options = options;
                options = g_strdup_printf("%s,%s", options, optarg);
                g_free(old_options);
            }
            break;
        case 'l':
            if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
                sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
                                                  optarg, false);
                if (!sn_opts) {
                    error_report("Failed in parsing snapshot param '%s'",
                                 optarg);
                    goto out;
                }
            } else {
                snapshot_name = optarg;
            }
            break;
        case 'U':
            force_share = true;
            break;
        case OPTION_OBJECT:
            object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                                  optarg, true);
            if (!object_opts) {
                goto out;
            }
            break;
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
        case OPTION_OUTPUT:
            if (!strcmp(optarg, "json")) {
                output_format = OFORMAT_JSON;
            } else if (!strcmp(optarg, "human")) {
                output_format = OFORMAT_HUMAN;
            } else {
                error_report("--output must be used with human or json "
                             "as argument.");
                goto out;
            }
            break;
        case OPTION_SIZE:
        {
            int64_t sval;

            sval = cvtnum(optarg);
            if (sval < 0) {
                if (sval == -ERANGE) {
                    error_report("Image size must be less than 8 EiB!");
                } else {
                    error_report("Invalid image size specified! You may use "
                                 "k, M, G, T, P or E suffixes for ");
                    error_report("kilobytes, megabytes, gigabytes, terabytes, "
                                 "petabytes and exabytes.");
                }
                goto out;
            }
            img_size = (uint64_t)sval;
        }
        break;
        }
    }

    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
4803
                          NULL, &error_fatal)) {
4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901
        goto out;
    }

    if (argc - optind > 1) {
        error_report("At most one filename argument is allowed.");
        goto out;
    } else if (argc - optind == 1) {
        filename = argv[optind];
    }

    if (!filename &&
        (object_opts || image_opts || fmt || snapshot_name || sn_opts)) {
        error_report("--object, --image-opts, -f, and -l "
                     "require a filename argument.");
        goto out;
    }
    if (filename && img_size != UINT64_MAX) {
        error_report("--size N cannot be used together with a filename.");
        goto out;
    }
    if (!filename && img_size == UINT64_MAX) {
        error_report("Either --size N or one filename must be specified.");
        goto out;
    }

    if (filename) {
        in_blk = img_open(image_opts, filename, fmt, 0,
                          false, false, force_share);
        if (!in_blk) {
            goto out;
        }

        if (sn_opts) {
            bdrv_snapshot_load_tmp(blk_bs(in_blk),
                    qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
                    qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
                    &local_err);
        } else if (snapshot_name != NULL) {
            bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
                    snapshot_name, &local_err);
        }
        if (local_err) {
            error_reportf_err(local_err, "Failed to load snapshot: ");
            goto out;
        }
    }

    drv = bdrv_find_format(out_fmt);
    if (!drv) {
        error_report("Unknown file format '%s'", out_fmt);
        goto out;
    }
    if (!drv->create_opts) {
        error_report("Format driver '%s' does not support image creation",
                     drv->format_name);
        goto out;
    }

    create_opts = qemu_opts_append(create_opts, drv->create_opts);
    create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
    if (options) {
        qemu_opts_do_parse(opts, options, NULL, &local_err);
        if (local_err) {
            error_report_err(local_err);
            error_report("Invalid options for file format '%s'", out_fmt);
            goto out;
        }
    }
    if (img_size != UINT64_MAX) {
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
    }

    info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
    if (local_err) {
        error_report_err(local_err);
        goto out;
    }

    if (output_format == OFORMAT_HUMAN) {
        printf("required size: %" PRIu64 "\n", info->required);
        printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
    } else {
        dump_json_block_measure_info(info);
    }

    ret = 0;

out:
    qapi_free_BlockMeasureInfo(info);
    qemu_opts_del(object_opts);
    qemu_opts_del(opts);
    qemu_opts_del(sn_opts);
    qemu_opts_free(create_opts);
    g_free(options);
    blk_unref(in_blk);
    return ret;
}
K
Kevin Wolf 已提交
4902

A
Anthony Liguori 已提交
4903
static const img_cmd_t img_cmds[] = {
4904 4905 4906 4907 4908 4909 4910
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
    { NULL, NULL, },
};

B
bellard 已提交
4911 4912
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
4913
    const img_cmd_t *cmd;
4914
    const char *cmdname;
4915
    Error *local_error = NULL;
4916
    char *trace_file = NULL;
4917 4918 4919
    int c;
    static const struct option long_options[] = {
        {"help", no_argument, 0, 'h'},
4920
        {"version", no_argument, 0, 'V'},
4921
        {"trace", required_argument, NULL, 'T'},
4922 4923
        {0, 0, 0, 0}
    };
B
bellard 已提交
4924

4925 4926 4927 4928
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

4929
    module_call_init(MODULE_INIT_TRACE);
K
Kevin Wolf 已提交
4930
    error_set_progname(argv[0]);
4931
    qemu_init_exec_dir(argv[0]);
K
Kevin Wolf 已提交
4932

4933
    if (qemu_init_main_loop(&local_error)) {
4934
        error_report_err(local_error);
4935 4936 4937
        exit(EXIT_FAILURE);
    }

4938
    qcrypto_init(&error_fatal);
4939

4940
    module_call_init(MODULE_INIT_QOM);
B
bellard 已提交
4941
    bdrv_init();
F
Fam Zheng 已提交
4942 4943 4944
    if (argc < 2) {
        error_exit("Not enough arguments");
    }
4945

4946
    qemu_add_opts(&qemu_object_opts);
4947
    qemu_add_opts(&qemu_source_opts);
4948
    qemu_add_opts(&qemu_trace_opts);
4949

4950
    while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
4951
        switch (c) {
4952 4953 4954
        case ':':
            missing_argument(argv[optind - 1]);
            return 0;
4955
        case '?':
4956 4957 4958
            unrecognized_option(argv[optind - 1]);
            return 0;
        case 'h':
4959 4960 4961 4962 4963
            help();
            return 0;
        case 'V':
            printf(QEMU_IMG_VERSION);
            return 0;
4964 4965 4966 4967
        case 'T':
            g_free(trace_file);
            trace_file = trace_opt_parse(optarg);
            break;
4968
        }
B
bellard 已提交
4969
    }
4970

4971
    cmdname = argv[optind];
4972

4973 4974 4975
    /* reset getopt_long scanning */
    argc -= optind;
    if (argc < 1) {
4976 4977
        return 0;
    }
4978
    argv += optind;
4979
    qemu_reset_optind();
4980

4981 4982 4983 4984 4985 4986
    if (!trace_init_backends()) {
        exit(1);
    }
    trace_init_file(trace_file);
    qemu_set_log(LOG_TRACE);

4987 4988 4989 4990 4991 4992
    /* find the command */
    for (cmd = img_cmds; cmd->name != NULL; cmd++) {
        if (!strcmp(cmdname, cmd->name)) {
            return cmd->handler(argc, argv);
        }
    }
4993

4994
    /* not found */
F
Fam Zheng 已提交
4995
    error_exit("Command not found: %s", cmdname);
B
bellard 已提交
4996
}