qemu-img.c 137.4 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 126
#define DEF(option, callback, arg_string)        \
           "  " arg_string "\n"
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
127 128 129
           "\n"
           "Command parameters:\n"
           "  'filename' is a disk image filename\n"
130 131 132 133
           "  '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"
134
           "  'fmt' is the disk image format. It is guessed automatically in most cases\n"
135
           "  'cache' is the cache mode used to write the output disk image, the valid\n"
136 137
           "    options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
           "    'directsync' and 'unsafe' (default for convert)\n"
138 139
           "  '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"
140
           "  'size' is the disk image size in bytes. Optional suffixes\n"
141 142 143
           "    '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"
144 145 146 147 148
           "  '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"
149 150 151 152 153
           "  'snapshot_param' is param used for internal snapshot, format\n"
           "    is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
           "    '[ID_OR_NAME]'\n"
           "  'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
           "    instead\n"
154
           "  '-c' indicates that target image must be compressed (qcow format only)\n"
155 156 157 158 159
           "  '-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"
160
           "  '-h' with or without a command shows this help and lists the supported formats\n"
161
           "  '-p' show progress of command (only certain commands)\n"
162
           "  '-q' use Quiet mode - do not print any output (except errors)\n"
163 164 165 166 167
           "  '-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"
168
           "  '--output' takes the format in which the output must be done (human or json)\n"
169 170
           "  '-n' skips the target volume creation (useful if the volume is created\n"
           "       prior to running qemu-img)\n"
171
           "\n"
172 173 174 175
           "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"
176
           "       hiding corruption that has already occurred.\n"
177
           "\n"
P
Peter Lieven 已提交
178 179 180 181 182
           "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"
183 184 185 186 187
           "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"
188 189 190 191 192
           "  '-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 已提交
193 194 195 196 197 198 199
           "  '-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 已提交
200 201
           "  'of=FILE' write to FILE\n"
           "  'skip=N' skip N bs-sized blocks at the start of input\n";
202 203

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

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

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

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

B
bellard 已提交
239

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

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

C
Chunyan Liu 已提交
253
    create_opts = qemu_opts_append(create_opts, drv->create_opts);
254
    if (filename) {
255
        proto_drv = bdrv_find_protocol(filename, true, &local_err);
256
        if (!proto_drv) {
257
            error_report_err(local_err);
258
            qemu_opts_free(create_opts);
259 260
            return 1;
        }
C
Chunyan Liu 已提交
261
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
262 263
    }

264 265
    qemu_opts_print_help(create_opts);
    qemu_opts_free(create_opts);
266 267 268
    return 0;
}

269

270
static BlockBackend *img_open_opts(const char *optstr,
271
                                   QemuOpts *opts, int flags, bool writethrough,
272
                                   bool quiet, bool force_share)
273 274 275 276 277
{
    QDict *options;
    Error *local_err = NULL;
    BlockBackend *blk;
    options = qemu_opts_to_qdict(opts, NULL);
278 279 280 281
    if (force_share) {
        if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
            && !qdict_get_bool(options, BDRV_OPT_FORCE_SHARE)) {
            error_report("--force-share/-U conflicts with image options");
282
            QDECREF(options);
283 284
            return NULL;
        }
285
        qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
286
    }
287
    blk = blk_new_open(NULL, NULL, options, flags, &local_err);
288
    if (!blk) {
289
        error_reportf_err(local_err, "Could not open '%s': ", optstr);
290 291
        return NULL;
    }
292
    blk_set_enable_write_cache(blk, !writethrough);
293 294 295 296

    return blk;
}

297
static BlockBackend *img_open_file(const char *filename,
298
                                   QDict *options,
299
                                   const char *fmt, int flags,
300 301
                                   bool writethrough, bool quiet,
                                   bool force_share)
302 303
{
    BlockBackend *blk;
304
    Error *local_err = NULL;
305

306 307 308
    if (!options) {
        options = qdict_new();
    }
309
    if (fmt) {
310
        qdict_put_str(options, "driver", fmt);
311
    }
312

313
    if (force_share) {
314
        qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
315
    }
316
    blk = blk_new_open(filename, NULL, options, flags, &local_err);
317
    if (!blk) {
318
        error_reportf_err(local_err, "Could not open '%s': ", filename);
319
        return NULL;
320
    }
321
    blk_set_enable_write_cache(blk, !writethrough);
322

323 324 325 326
    return blk;
}


327 328 329 330 331 332 333
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")) {
334
        qdict_put_str(options, name, value);
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
    }

    return 0;
}

static BlockBackend *img_open_new_file(const char *filename,
                                       QemuOpts *create_opts,
                                       const char *fmt, int flags,
                                       bool writethrough, bool quiet,
                                       bool force_share)
{
    QDict *options = NULL;

    options = qdict_new();
    qemu_opt_foreach(create_opts, img_add_key_secrets, options, &error_abort);

    return img_open_file(filename, options, fmt, flags, writethrough, quiet,
                         force_share);
}


356
static BlockBackend *img_open(bool image_opts,
357
                              const char *filename,
358
                              const char *fmt, int flags, bool writethrough,
359
                              bool quiet, bool force_share)
360 361 362 363 364 365 366 367 368 369 370 371 372
{
    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;
        }
373 374
        blk = img_open_opts(filename, opts, flags, writethrough, quiet,
                            force_share);
375
    } else {
376
        blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
377
                            force_share);
378
    }
379
    return blk;
380 381
}

382

383
static int add_old_style_options(const char *fmt, QemuOpts *opts,
384 385
                                 const char *base_filename,
                                 const char *base_fmt)
386
{
387 388
    Error *err = NULL;

389
    if (base_filename) {
390
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
391
        if (err) {
392 393
            error_report("Backing file not supported for file format '%s'",
                         fmt);
394
            error_free(err);
395
            return -1;
396 397 398
        }
    }
    if (base_fmt) {
399
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
400
        if (err) {
401 402
            error_report("Backing file format not supported for file "
                         "format '%s'", fmt);
403
            error_free(err);
404
            return -1;
405 406
        }
    }
407
    return 0;
408 409
}

410 411
static int64_t cvtnum(const char *s)
{
412
    int err;
413
    uint64_t value;
414

415 416 417 418
    err = qemu_strtosz(s, NULL, &value);
    if (err < 0) {
        return err;
    }
419 420 421
    if (value > INT64_MAX) {
        return -ERANGE;
    }
422
    return value;
423 424
}

B
bellard 已提交
425 426
static int img_create(int argc, char **argv)
{
427
    int c;
428
    uint64_t img_size = -1;
B
bellard 已提交
429
    const char *fmt = "raw";
430
    const char *base_fmt = NULL;
B
bellard 已提交
431 432
    const char *filename;
    const char *base_filename = NULL;
433
    char *options = NULL;
434
    Error *local_err = NULL;
435
    bool quiet = false;
436
    int flags = 0;
437

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

498
    /* Get the filename */
499 500 501 502 503 504
    filename = (optind < argc) ? argv[optind] : NULL;
    if (options && has_help_option(options)) {
        g_free(options);
        return print_block_option_help(filename, fmt);
    }

505
    if (optind >= argc) {
F
Fam Zheng 已提交
506
        error_exit("Expecting image file name");
507
    }
508
    optind++;
509

510 511
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
512
                          NULL, NULL)) {
513 514 515
        goto fail;
    }

516 517
    /* Get image size, if specified */
    if (optind < argc) {
518
        int64_t sval;
519 520 521

        sval = cvtnum(argv[optind++]);
        if (sval < 0) {
522 523 524 525
            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, "
526 527 528
                      "G, T, P or E suffixes for ");
                error_report("kilobytes, megabytes, gigabytes, terabytes, "
                             "petabytes and exabytes.");
529
            }
530
            goto fail;
531 532 533
        }
        img_size = (uint64_t)sval;
    }
534
    if (optind != argc) {
F
Fam Zheng 已提交
535
        error_exit("Unexpected argument: %s", argv[optind]);
536
    }
537

538
    bdrv_img_create(filename, fmt, base_filename, base_fmt,
539
                    options, img_size, flags, quiet, &local_err);
540
    if (local_err) {
541
        error_reportf_err(local_err, "%s: ", filename);
542
        goto fail;
543
    }
544

545
    g_free(options);
B
bellard 已提交
546
    return 0;
547 548 549 550

fail:
    g_free(options);
    return 1;
B
bellard 已提交
551 552
}

553
static void dump_json_image_check(ImageCheck *check, bool quiet)
554 555 556
{
    QString *str;
    QObject *obj;
557
    Visitor *v = qobject_output_visitor_new(&obj);
558 559 560

    visit_type_ImageCheck(v, NULL, &check, &error_abort);
    visit_complete(v, &obj);
561 562
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
563
    qprintf(quiet, "%s\n", qstring_get_str(str));
564
    qobject_decref(obj);
565
    visit_free(v);
566 567 568
    QDECREF(str);
}

569
static void dump_human_image_check(ImageCheck *check, bool quiet)
570 571
{
    if (!(check->corruptions || check->leaks || check->check_errors)) {
572
        qprintf(quiet, "No errors were found on the image.\n");
573 574
    } else {
        if (check->corruptions) {
575 576 577 578
            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);
579 580 581
        }

        if (check->leaks) {
582 583 584 585
            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);
586 587 588
        }

        if (check->check_errors) {
589 590 591 592
            qprintf(quiet,
                    "\n%" PRId64
                    " internal errors have occurred during the check.\n",
                    check->check_errors);
593 594 595 596
        }
    }

    if (check->total_clusters != 0 && check->allocated_clusters != 0) {
597 598 599 600 601 602 603
        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);
604 605 606
    }

    if (check->image_end_offset) {
607 608
        qprintf(quiet,
                "Image end offset: %" PRId64 "\n", check->image_end_offset);
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 639 640 641 642 643 644
    }
}

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;
645 646
    check->compressed_clusters      = result.bfi.compressed_clusters;
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
647 648 649 650

    return 0;
}

651 652 653
/*
 * Checks an image for consistency. Exit codes:
 *
M
Max Reitz 已提交
654 655 656 657 658
 *  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
659
 */
660 661 662
static int img_check(int argc, char **argv)
{
    int c, ret;
663
    OutputFormat output_format = OFORMAT_HUMAN;
664
    const char *filename, *fmt, *output, *cache;
M
Markus Armbruster 已提交
665
    BlockBackend *blk;
666
    BlockDriverState *bs;
667
    int fix = 0;
668 669
    int flags = BDRV_O_CHECK;
    bool writethrough;
670
    ImageCheck *check;
671
    bool quiet = false;
672
    bool image_opts = false;
673
    bool force_share = false;
674 675

    fmt = NULL;
676
    output = NULL;
677
    cache = BDRV_DEFAULT_CACHE;
678

679
    for(;;) {
680 681 682 683
        int option_index = 0;
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"format", required_argument, 0, 'f'},
684
            {"repair", required_argument, 0, 'r'},
685
            {"output", required_argument, 0, OPTION_OUTPUT},
686
            {"object", required_argument, 0, OPTION_OBJECT},
687
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
688
            {"force-share", no_argument, 0, 'U'},
689 690
            {0, 0, 0, 0}
        };
691
        c = getopt_long(argc, argv, ":hf:r:T:qU",
692
                        long_options, &option_index);
693
        if (c == -1) {
694
            break;
695
        }
696
        switch(c) {
697 698 699
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
700
        case '?':
701 702
            unrecognized_option(argv[optind - 1]);
            break;
703 704 705 706 707 708
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
709 710 711 712 713 714 715 716
        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 已提交
717 718
                error_exit("Unknown option value for -r "
                           "(expecting 'leaks' or 'all'): %s", optarg);
719 720
            }
            break;
721 722 723
        case OPTION_OUTPUT:
            output = optarg;
            break;
724 725 726
        case 'T':
            cache = optarg;
            break;
727 728 729
        case 'q':
            quiet = true;
            break;
730 731 732
        case 'U':
            force_share = true;
            break;
733 734 735 736 737 738 739 740
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
741 742 743
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
744 745
        }
    }
746
    if (optind != argc - 1) {
F
Fam Zheng 已提交
747
        error_exit("Expecting one image file name");
748
    }
749 750
    filename = argv[optind++];

751 752 753 754 755 756 757 758 759
    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;
    }

760 761
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
762
                          NULL, NULL)) {
763 764 765
        return 1;
    }

766
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
767 768 769 770 771
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        return 1;
    }

772 773
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   force_share);
774 775
    if (!blk) {
        return 1;
776
    }
777
    bs = blk_bs(blk);
778 779 780

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
781 782

    if (ret == -ENOTSUP) {
783
        error_report("This image format does not support checks");
784
        ret = 63;
785
        goto fail;
786 787
    }

788 789
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
790

791 792
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
793

794
        if (output_format == OFORMAT_HUMAN) {
795 796 797 798 799 800 801
            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);
802 803
        }

804
        ret = collect_image_check(bs, check, filename, fmt, 0);
805

806 807
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
808 809
    }

M
Max Reitz 已提交
810 811 812 813 814 815 816 817 818
    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;
        }
819 820
    }

821
    if (ret || check->check_errors) {
M
Max Reitz 已提交
822 823 824 825 826
        if (ret) {
            error_report("Check failed: %s", strerror(-ret));
        } else {
            error_report("Check failed");
        }
827 828
        ret = 1;
        goto fail;
829
    }
830

831 832 833 834
    if (check->corruptions) {
        ret = 2;
    } else if (check->leaks) {
        ret = 3;
835
    } else {
836
        ret = 0;
837
    }
838 839 840

fail:
    qapi_free_ImageCheck(check);
M
Markus Armbruster 已提交
841
    blk_unref(blk);
842
    return ret;
843 844
}

M
Max Reitz 已提交
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
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 已提交
861
    AioContext *aio_context = blk_get_aio_context(job->blk);
862
    int ret = 0;
M
Max Reitz 已提交
863

864
    aio_context_acquire(aio_context);
865
    block_job_ref(job);
M
Max Reitz 已提交
866 867
    do {
        aio_poll(aio_context, true);
868 869
        qemu_progress_print(job->len ?
                            ((float)job->offset / job->len * 100.f) : 0.0f, 0);
870
    } while (!job->ready && !job->completed);
M
Max Reitz 已提交
871

872 873 874 875 876 877
    if (!job->completed) {
        ret = block_job_complete_sync(job, errp);
    } else {
        ret = job->ret;
    }
    block_job_unref(job);
878
    aio_context_release(aio_context);
879

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

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

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

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

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

969 970
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
971
                          NULL, NULL)) {
972 973 974
        return 1;
    }

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

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

989 990 991
    qemu_progress_init(progress, 1.f);
    qemu_progress_print(0.f, 100);

992 993 994
    if (base) {
        base_bs = bdrv_find_backing_image(bs, base);
        if (!base_bs) {
995 996 997
            error_setg(&local_err,
                       "Did not find '%s' in the backing chain of '%s'",
                       base, filename);
998 999 1000 1001 1002 1003
            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. */
1004
        base_bs = backing_bs(bs);
1005 1006 1007 1008
        if (!base_bs) {
            error_setg(&local_err, "Image does not have a backing file");
            goto done;
        }
M
Max Reitz 已提交
1009 1010 1011 1012 1013 1014 1015
    }

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

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

1026 1027 1028 1029
    /* 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 已提交
1030
    if (!drop) {
1031
        bdrv_ref(bs);
M
Max Reitz 已提交
1032 1033
    }

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

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

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

done:
1055 1056
    qemu_progress_end();

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

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

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

E
Eric Blake 已提交
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
/*
 * 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;
}

1090 1091 1092 1093 1094 1095 1096
/*
 * 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.
 */
B
bellard 已提交
1097 1098
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
{
1099 1100
    bool is_zero;
    int i;
B
bellard 已提交
1101 1102 1103 1104 1105

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
1106
    is_zero = buffer_is_zero(buf, 512);
B
bellard 已提交
1107 1108
    for(i = 1; i < n; i++) {
        buf += 512;
1109
        if (is_zero != buffer_is_zero(buf, 512)) {
B
bellard 已提交
1110
            break;
1111
        }
B
bellard 已提交
1112 1113
    }
    *pnum = i;
1114
    return !is_zero;
B
bellard 已提交
1115 1116
}

1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
/*
 * 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,
    int min)
{
    int ret;
    int num_checked, num_used;

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

    ret = is_allocated_sectors(buf, n, pnum);
    if (!ret) {
        return ret;
    }

    num_used = *pnum;
    buf += BDRV_SECTOR_SIZE * *pnum;
    n -= *pnum;
    num_checked = num_used;

    while (n > 0) {
        ret = is_allocated_sectors(buf, n, pnum);

        buf += BDRV_SECTOR_SIZE * *pnum;
        n -= *pnum;
        num_checked += *pnum;
        if (ret) {
            num_used = num_checked;
        } else if (*pnum >= min) {
            break;
        }
    }

    *pnum = num_used;
    return 1;
}

K
Kevin Wolf 已提交
1159
/*
1160 1161
 * Compares two buffers sector by sector. Returns 0 if the first
 * sector of each buffer matches, non-zero otherwise.
K
Kevin Wolf 已提交
1162
 *
1163 1164
 * 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 已提交
1165
 */
1166 1167
static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
                           int64_t bytes, int64_t *pnum)
K
Kevin Wolf 已提交
1168
{
1169
    bool res;
1170
    int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
K
Kevin Wolf 已提交
1171

1172
    assert(bytes > 0);
K
Kevin Wolf 已提交
1173

1174 1175 1176
    res = !!memcmp(buf1, buf2, i);
    while (i < bytes) {
        int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
K
Kevin Wolf 已提交
1177

1178
        if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
K
Kevin Wolf 已提交
1179 1180
            break;
        }
1181
        i += len;
K
Kevin Wolf 已提交
1182 1183 1184 1185 1186 1187
    }

    *pnum = i;
    return res;
}

1188
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
1189

1190 1191 1192
/*
 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
 *
1193 1194 1195 1196
 * 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.
1197
 *
1198
 * @param blk:  BlockBackend for the image
1199 1200
 * @param offset: Starting offset to check
 * @param bytes: Number of bytes to check
1201 1202 1203 1204
 * @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
 */
1205 1206
static int check_empty_sectors(BlockBackend *blk, int64_t offset,
                               int64_t bytes, const char *filename,
1207 1208
                               uint8_t *buffer, bool quiet)
{
E
Eric Blake 已提交
1209 1210 1211
    int ret = 0;
    int64_t idx;

1212
    ret = blk_pread(blk, offset, buffer, bytes);
1213 1214
    if (ret < 0) {
        error_report("Error while reading offset %" PRId64 " of %s: %s",
1215
                     offset, filename, strerror(-ret));
1216
        return 4;
1217
    }
1218
    idx = find_nonzero(buffer, bytes);
E
Eric Blake 已提交
1219
    if (idx >= 0) {
1220
        qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1221
                offset + idx);
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
        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)
{
1237
    const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
M
Markus Armbruster 已提交
1238
    BlockBackend *blk1, *blk2;
1239
    BlockDriverState *bs1, *bs2;
1240
    int64_t total_size1, total_size2;
1241
    uint8_t *buf1 = NULL, *buf2 = NULL;
1242
    int64_t pnum1, pnum2;
1243 1244 1245
    int allocated1, allocated2;
    int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
    bool progress = false, quiet = false, strict = false;
1246
    int flags;
1247
    bool writethrough;
1248 1249 1250
    int64_t total_size;
    int64_t offset = 0;
    int64_t chunk;
1251
    int c;
1252
    uint64_t progress_base;
1253
    bool image_opts = false;
1254
    bool force_share = false;
1255

1256
    cache = BDRV_DEFAULT_CACHE;
1257
    for (;;) {
1258 1259 1260
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
1261
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1262
            {"force-share", no_argument, 0, 'U'},
1263 1264
            {0, 0, 0, 0}
        };
1265
        c = getopt_long(argc, argv, ":hf:F:T:pqsU",
1266
                        long_options, NULL);
1267 1268 1269 1270
        if (c == -1) {
            break;
        }
        switch (c) {
1271 1272 1273
        case ':':
            missing_argument(argv[optind - 1]);
            break;
1274
        case '?':
1275 1276
            unrecognized_option(argv[optind - 1]);
            break;
1277 1278 1279 1280 1281 1282 1283 1284 1285
        case 'h':
            help();
            break;
        case 'f':
            fmt1 = optarg;
            break;
        case 'F':
            fmt2 = optarg;
            break;
1286 1287 1288
        case 'T':
            cache = optarg;
            break;
1289 1290 1291 1292 1293 1294 1295 1296 1297
        case 'p':
            progress = true;
            break;
        case 'q':
            quiet = true;
            break;
        case 's':
            strict = true;
            break;
1298 1299 1300
        case 'U':
            force_share = true;
            break;
1301 1302 1303 1304 1305 1306 1307 1308 1309
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                ret = 2;
                goto out4;
            }
        }   break;
1310 1311 1312
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
1313 1314 1315 1316 1317 1318 1319 1320 1321
        }
    }

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


1322
    if (optind != argc - 2) {
F
Fam Zheng 已提交
1323
        error_exit("Expecting two image file names");
1324 1325 1326 1327
    }
    filename1 = argv[optind++];
    filename2 = argv[optind++];

1328 1329
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
1330
                          NULL, NULL)) {
1331 1332 1333 1334
        ret = 2;
        goto out4;
    }

1335 1336 1337
    /* Initialize before goto out */
    qemu_progress_init(progress, 2.0);

1338 1339
    flags = 0;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1340 1341 1342 1343 1344 1345
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        ret = 2;
        goto out3;
    }

1346 1347
    blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
                    force_share);
1348
    if (!blk1) {
1349
        ret = 2;
1350
        goto out3;
1351 1352
    }

1353 1354
    blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
                    force_share);
1355
    if (!blk2) {
1356
        ret = 2;
1357
        goto out2;
1358
    }
1359
    bs1 = blk_bs(blk1);
1360
    bs2 = blk_bs(blk2);
1361

1362 1363
    buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
    buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1364 1365
    total_size1 = blk_getlength(blk1);
    if (total_size1 < 0) {
1366
        error_report("Can't get size of %s: %s",
1367
                     filename1, strerror(-total_size1));
1368 1369 1370
        ret = 4;
        goto out;
    }
1371 1372
    total_size2 = blk_getlength(blk2);
    if (total_size2 < 0) {
1373
        error_report("Can't get size of %s: %s",
1374
                     filename2, strerror(-total_size2));
1375 1376 1377
        ret = 4;
        goto out;
    }
1378 1379
    total_size = MIN(total_size1, total_size2);
    progress_base = MAX(total_size1, total_size2);
1380 1381 1382

    qemu_progress_print(0, 100);

1383
    if (strict && total_size1 != total_size2) {
1384 1385 1386 1387 1388
        ret = 1;
        qprintf(quiet, "Strict mode: Image size mismatch!\n");
        goto out;
    }

1389
    while (offset < total_size) {
1390
        int status1, status2;
1391

1392 1393 1394
        status1 = bdrv_block_status_above(bs1, NULL, offset,
                                          total_size1 - offset, &pnum1, NULL,
                                          NULL);
1395
        if (status1 < 0) {
1396 1397 1398 1399
            ret = 3;
            error_report("Sector allocation test failed for %s", filename1);
            goto out;
        }
1400
        allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1401

1402 1403 1404
        status2 = bdrv_block_status_above(bs2, NULL, offset,
                                          total_size2 - offset, &pnum2, NULL,
                                          NULL);
1405
        if (status2 < 0) {
1406 1407 1408 1409
            ret = 3;
            error_report("Sector allocation test failed for %s", filename2);
            goto out;
        }
1410
        allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1411 1412

        assert(pnum1 && pnum2);
1413
        chunk = MIN(pnum1, pnum2);
1414

1415
        if (strict) {
1416
            if (status1 != status2) {
1417 1418
                ret = 1;
                qprintf(quiet, "Strict mode: Offset %" PRId64
1419
                        " block status mismatch!\n", offset);
1420 1421 1422 1423
                goto out;
            }
        }
        if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1424
            /* nothing to do */
1425
        } else if (allocated1 == allocated2) {
1426
            if (allocated1) {
1427 1428
                int64_t pnum;

1429 1430
                chunk = MIN(chunk, IO_BUF_SIZE);
                ret = blk_pread(blk1, offset, buf1, chunk);
1431
                if (ret < 0) {
1432 1433 1434
                    error_report("Error while reading offset %" PRId64
                                 " of %s: %s",
                                 offset, filename1, strerror(-ret));
1435 1436 1437
                    ret = 4;
                    goto out;
                }
1438
                ret = blk_pread(blk2, offset, buf2, chunk);
1439 1440
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64
1441 1442
                                 " of %s: %s",
                                 offset, filename2, strerror(-ret));
1443 1444 1445
                    ret = 4;
                    goto out;
                }
1446 1447
                ret = compare_buffers(buf1, buf2, chunk, &pnum);
                if (ret || pnum != chunk) {
1448
                    qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1449
                            offset + (ret ? 0 : pnum));
1450
                    ret = 1;
1451 1452 1453 1454
                    goto out;
                }
            }
        } else {
1455
            chunk = MIN(chunk, IO_BUF_SIZE);
1456
            if (allocated1) {
1457
                ret = check_empty_sectors(blk1, offset, chunk,
1458 1459
                                          filename1, buf1, quiet);
            } else {
1460
                ret = check_empty_sectors(blk2, offset, chunk,
1461 1462 1463 1464 1465 1466
                                          filename2, buf1, quiet);
            }
            if (ret) {
                goto out;
            }
        }
1467 1468
        offset += chunk;
        qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1469 1470
    }

1471
    if (total_size1 != total_size2) {
1472
        BlockBackend *blk_over;
1473 1474 1475
        const char *filename_over;

        qprintf(quiet, "Warning: Image size mismatch!\n");
1476
        if (total_size1 > total_size2) {
1477
            blk_over = blk1;
1478 1479
            filename_over = filename1;
        } else {
1480
            blk_over = blk2;
1481 1482 1483
            filename_over = filename2;
        }

1484 1485 1486 1487
        while (offset < progress_base) {
            ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
                                          progress_base - offset, &chunk,
                                          NULL, NULL);
1488 1489 1490 1491 1492 1493 1494
            if (ret < 0) {
                ret = 3;
                error_report("Sector allocation test failed for %s",
                             filename_over);
                goto out;

            }
1495
            if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
1496 1497
                chunk = MIN(chunk, IO_BUF_SIZE);
                ret = check_empty_sectors(blk_over, offset, chunk,
1498 1499 1500 1501 1502
                                          filename_over, buf1, quiet);
                if (ret) {
                    goto out;
                }
            }
1503 1504
            offset += chunk;
            qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1505 1506 1507 1508 1509 1510 1511 1512 1513
        }
    }

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

out:
    qemu_vfree(buf1);
    qemu_vfree(buf2);
M
Markus Armbruster 已提交
1514
    blk_unref(blk2);
1515
out2:
M
Markus Armbruster 已提交
1516
    blk_unref(blk1);
1517 1518
out3:
    qemu_progress_end();
1519
out4:
1520 1521 1522
    return ret;
}

1523 1524 1525 1526 1527 1528
enum ImgConvertBlockStatus {
    BLK_DATA,
    BLK_ZERO,
    BLK_BACKING_FILE,
};

P
Peter Lieven 已提交
1529 1530
#define MAX_COROUTINES 16

1531 1532 1533
typedef struct ImgConvertState {
    BlockBackend **src;
    int64_t *src_sectors;
P
Peter Lieven 已提交
1534
    int src_num;
1535 1536
    int64_t total_sectors;
    int64_t allocated_sectors;
P
Peter Lieven 已提交
1537 1538 1539
    int64_t allocated_done;
    int64_t sector_num;
    int64_t wr_offs;
1540 1541 1542 1543 1544 1545
    enum ImgConvertBlockStatus status;
    int64_t sector_next_status;
    BlockBackend *target;
    bool has_zero_init;
    bool compressed;
    bool target_has_backing;
P
Peter Lieven 已提交
1546
    bool wr_in_order;
1547 1548 1549
    int min_sparse;
    size_t cluster_sectors;
    size_t buf_sectors;
P
Peter Lieven 已提交
1550
    long num_coroutines;
P
Peter Lieven 已提交
1551 1552 1553 1554 1555
    int running_coroutines;
    Coroutine *co[MAX_COROUTINES];
    int64_t wait_sector_num[MAX_COROUTINES];
    CoMutex lock;
    int ret;
1556 1557
} ImgConvertState;

P
Peter Lieven 已提交
1558 1559
static void convert_select_part(ImgConvertState *s, int64_t sector_num,
                                int *src_cur, int64_t *src_cur_offset)
1560
{
P
Peter Lieven 已提交
1561 1562 1563 1564 1565 1566
    *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);
1567 1568 1569 1570 1571
    }
}

static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
{
1572 1573
    int64_t src_cur_offset;
    int ret, n, src_cur;
1574

P
Peter Lieven 已提交
1575
    convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1576 1577 1578 1579 1580

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

    if (s->sector_next_status <= sector_num) {
1581 1582
        int64_t count = n * BDRV_SECTOR_SIZE;

1583
        if (s->target_has_backing) {
1584 1585 1586 1587 1588

            ret = bdrv_block_status(blk_bs(s->src[src_cur]),
                                    (sector_num - src_cur_offset) *
                                    BDRV_SECTOR_SIZE,
                                    count, &count, NULL, NULL);
1589
        } else {
1590 1591 1592 1593
            ret = bdrv_block_status_above(blk_bs(s->src[src_cur]), NULL,
                                          (sector_num - src_cur_offset) *
                                          BDRV_SECTOR_SIZE,
                                          count, &count, NULL, NULL);
1594
        }
1595 1596 1597
        if (ret < 0) {
            return ret;
        }
1598
        n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
1599 1600 1601 1602 1603 1604

        if (ret & BDRV_BLOCK_ZERO) {
            s->status = BLK_ZERO;
        } else if (ret & BDRV_BLOCK_DATA) {
            s->status = BLK_DATA;
        } else {
1605
            s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630
        }

        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 已提交
1631 1632
static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
                                        int nb_sectors, uint8_t *buf)
1633
{
P
Peter Lieven 已提交
1634 1635 1636
    int n, ret;
    QEMUIOVector qiov;
    struct iovec iov;
1637 1638 1639 1640

    assert(nb_sectors <= s->buf_sectors);
    while (nb_sectors > 0) {
        BlockBackend *blk;
P
Peter Lieven 已提交
1641 1642
        int src_cur;
        int64_t bs_sectors, src_cur_offset;
1643 1644 1645 1646

        /* 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 已提交
1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658
        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);
1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670
        if (ret < 0) {
            return ret;
        }

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

    return 0;
}

P
Peter Lieven 已提交
1671 1672 1673 1674

static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
                                         int nb_sectors, uint8_t *buf,
                                         enum ImgConvertBlockStatus status)
1675 1676
{
    int ret;
P
Peter Lieven 已提交
1677 1678
    QEMUIOVector qiov;
    struct iovec iov;
1679 1680 1681

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

P
Peter Lieven 已提交
1684
        switch (status) {
1685 1686 1687 1688 1689 1690 1691 1692
        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:
1693 1694 1695 1696 1697 1698
            /* 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. */
1699
            if (!s->min_sparse ||
1700 1701 1702 1703
                (!s->compressed &&
                 is_allocated_sectors_min(buf, n, &n, s->min_sparse)) ||
                (s->compressed &&
                 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
1704
            {
P
Peter Lieven 已提交
1705 1706 1707 1708 1709
                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,
1710
                                     n << BDRV_SECTOR_BITS, &qiov, flags);
1711 1712 1713 1714 1715 1716 1717 1718 1719
                if (ret < 0) {
                    return ret;
                }
                break;
            }
            /* fall-through */

        case BLK_ZERO:
            if (s->has_zero_init) {
1720
                assert(!s->target_has_backing);
1721 1722
                break;
            }
P
Peter Lieven 已提交
1723 1724 1725
            ret = blk_co_pwrite_zeroes(s->target,
                                       sector_num << BDRV_SECTOR_BITS,
                                       n << BDRV_SECTOR_BITS, 0);
1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739
            if (ret < 0) {
                return ret;
            }
            break;
        }

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

    return 0;
}

P
Peter Lieven 已提交
1740
static void coroutine_fn convert_co_do_copy(void *opaque)
1741
{
P
Peter Lieven 已提交
1742
    ImgConvertState *s = opaque;
1743
    uint8_t *buf = NULL;
P
Peter Lieven 已提交
1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765
    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;

        qemu_co_mutex_lock(&s->lock);
        if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
            qemu_co_mutex_unlock(&s->lock);
1766
            break;
P
Peter Lieven 已提交
1767 1768 1769 1770 1771
        }
        n = convert_iteration_sectors(s, s->sector_num);
        if (n < 0) {
            qemu_co_mutex_unlock(&s->lock);
            s->ret = n;
1772
            break;
P
Peter Lieven 已提交
1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804
        }
        /* 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);
        }

        if (status == BLK_DATA) {
            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 */
1805
            while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
P
Peter Lieven 已提交
1806 1807 1808 1809 1810 1811
                s->wait_sector_num[index] = sector_num;
                qemu_coroutine_yield();
            }
            s->wait_sector_num[index] = -1;
        }

1812 1813 1814 1815 1816 1817 1818
        if (s->ret == -EINPROGRESS) {
            ret = convert_co_write(s, sector_num, n, buf, status);
            if (ret < 0) {
                error_report("error while writing sector %" PRId64
                             ": %s", sector_num, strerror(-ret));
                s->ret = ret;
            }
P
Peter Lieven 已提交
1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851
        }

        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;
1852 1853 1854 1855 1856 1857 1858 1859 1860

    /* 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)))
    {
1861
        ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP);
1862 1863 1864 1865 1866 1867 1868 1869 1870 1871
        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 已提交
1872
            return -EINVAL;
1873 1874 1875 1876 1877 1878 1879
        }
        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 已提交
1880
            return n;
1881
        }
1882 1883
        if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
        {
1884 1885 1886 1887 1888 1889 1890
            s->allocated_sectors += n;
        }
        sector_num += n;
    }

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

P
Peter Lieven 已提交
1893 1894 1895 1896 1897 1898
    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]);
    }
1899

1900
    while (s->running_coroutines) {
P
Peter Lieven 已提交
1901
        main_loop_wait(false);
1902 1903
    }

P
Peter Lieven 已提交
1904
    if (s->compressed && !s->ret) {
1905
        /* signal EOF to align */
1906
        ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
1907
        if (ret < 0) {
P
Peter Lieven 已提交
1908
            return ret;
1909 1910 1911
        }
    }

P
Peter Lieven 已提交
1912
    return s->ret;
1913 1914
}

B
bellard 已提交
1915 1916
static int img_convert(int argc, char **argv)
{
P
Peter Lieven 已提交
1917
    int c, bs_i, flags, src_flags = 0;
1918
    const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
P
Peter Lieven 已提交
1919 1920
               *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
               *out_filename, *out_baseimg_param, *snapshot_name = NULL;
1921
    BlockDriver *drv = NULL, *proto_drv = NULL;
B
bellard 已提交
1922
    BlockDriverInfo bdi;
P
Peter Lieven 已提交
1923 1924
    BlockDriverState *out_bs;
    QemuOpts *opts = NULL, *sn_opts = NULL;
1925
    QemuOptsList *create_opts = NULL;
1926
    char *options = NULL;
1927
    Error *local_err = NULL;
P
Peter Lieven 已提交
1928
    bool writethrough, src_writethrough, quiet = false, image_opts = false,
1929
         skip_create = false, progress = false, tgt_image_opts = false;
P
Peter Lieven 已提交
1930
    int64_t ret = -EINVAL;
1931
    bool force_share = false;
P
Peter Lieven 已提交
1932 1933 1934 1935 1936 1937 1938 1939

    ImgConvertState s = (ImgConvertState) {
        /* Need at least 4k of zeros for sparse detection */
        .min_sparse         = 8,
        .buf_sectors        = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
        .wr_in_order        = true,
        .num_coroutines     = 8,
    };
B
bellard 已提交
1940 1941

    for(;;) {
1942 1943 1944
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
1945
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1946
            {"force-share", no_argument, 0, 'U'},
1947
            {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
1948 1949
            {0, 0, 0, 0}
        };
1950
        c = getopt_long(argc, argv, ":hf:O:B:co:s:l:S:pt:T:qnm:WU",
1951
                        long_options, NULL);
1952
        if (c == -1) {
B
bellard 已提交
1953
            break;
1954
        }
B
bellard 已提交
1955
        switch(c) {
1956 1957 1958
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
1959
        case '?':
1960 1961
            unrecognized_option(argv[optind - 1]);
            break;
B
bellard 已提交
1962 1963 1964 1965 1966 1967 1968 1969 1970
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'O':
            out_fmt = optarg;
            break;
1971 1972 1973
        case 'B':
            out_baseimg = optarg;
            break;
B
bellard 已提交
1974
        case 'c':
P
Peter Lieven 已提交
1975
            s.compressed = true;
B
bellard 已提交
1976
            break;
1977
        case 'o':
1978 1979
            if (!is_valid_option_list(optarg)) {
                error_report("Invalid option list: %s", optarg);
1980
                goto fail_getopt;
1981 1982 1983 1984 1985 1986 1987 1988
            }
            if (!options) {
                options = g_strdup(optarg);
            } else {
                char *old_options = options;
                options = g_strdup_printf("%s,%s", options, optarg);
                g_free(old_options);
            }
1989
            break;
E
edison 已提交
1990 1991 1992
        case 's':
            snapshot_name = optarg;
            break;
1993 1994
        case 'l':
            if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
1995 1996
                sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
                                                  optarg, false);
1997 1998 1999
                if (!sn_opts) {
                    error_report("Failed in parsing snapshot param '%s'",
                                 optarg);
2000
                    goto fail_getopt;
2001 2002 2003 2004 2005
                }
            } else {
                snapshot_name = optarg;
            }
            break;
2006 2007 2008
        case 'S':
        {
            int64_t sval;
2009 2010 2011

            sval = cvtnum(optarg);
            if (sval < 0) {
2012
                error_report("Invalid minimum zero buffer size for sparse output specified");
2013
                goto fail_getopt;
2014 2015
            }

P
Peter Lieven 已提交
2016
            s.min_sparse = sval / BDRV_SECTOR_SIZE;
2017 2018
            break;
        }
2019
        case 'p':
P
Peter Lieven 已提交
2020
            progress = true;
2021
            break;
2022 2023 2024
        case 't':
            cache = optarg;
            break;
2025 2026 2027
        case 'T':
            src_cache = optarg;
            break;
2028 2029 2030
        case 'q':
            quiet = true;
            break;
2031
        case 'n':
P
Peter Lieven 已提交
2032
            skip_create = true;
2033
            break;
P
Peter Lieven 已提交
2034
        case 'm':
P
Peter Lieven 已提交
2035 2036
            if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
                s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
P
Peter Lieven 已提交
2037 2038 2039 2040 2041 2042
                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 已提交
2043
            s.wr_in_order = false;
P
Peter Lieven 已提交
2044
            break;
2045 2046 2047
        case 'U':
            force_share = true;
            break;
2048 2049 2050 2051 2052
        case OPTION_OBJECT: {
            QemuOpts *object_opts;
            object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                                  optarg, true);
            if (!object_opts) {
2053 2054 2055
                goto fail_getopt;
            }
            break;
2056
        }
2057 2058 2059
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
2060 2061 2062
        case OPTION_TARGET_IMAGE_OPTS:
            tgt_image_opts = true;
            break;
B
bellard 已提交
2063 2064
        }
    }
2065

2066 2067 2068 2069
    if (!out_fmt && !tgt_image_opts) {
        out_fmt = "raw";
    }

2070 2071
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2072
                          NULL, NULL)) {
2073 2074 2075
        goto fail_getopt;
    }

P
Peter Lieven 已提交
2076
    if (!s.wr_in_order && s.compressed) {
P
Peter Lieven 已提交
2077 2078 2079 2080
        error_report("Out of order write and compress are mutually exclusive");
        goto fail_getopt;
    }

2081 2082 2083 2084 2085
    if (tgt_image_opts && !skip_create) {
        error_report("--target-image-opts requires use of -n flag");
        goto fail_getopt;
    }

P
Peter Lieven 已提交
2086 2087
    s.src_num = argc - optind - 1;
    out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2088

2089
    if (options && has_help_option(options)) {
2090 2091 2092 2093 2094 2095 2096
        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;
        }
2097 2098
    }

P
Peter Lieven 已提交
2099 2100 2101
    if (s.src_num < 1) {
        error_report("Must specify image file name");
        goto fail_getopt;
2102 2103 2104
    }


P
Peter Lieven 已提交
2105
    /* ret is still -EINVAL until here */
2106
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2107 2108
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
P
Peter Lieven 已提交
2109
        goto fail_getopt;
2110 2111
    }

P
Peter Lieven 已提交
2112 2113 2114 2115 2116
    /* Initialize before goto out */
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);
2117 2118
    qemu_progress_print(0, 100);

P
Peter Lieven 已提交
2119 2120
    s.src = g_new0(BlockBackend *, s.src_num);
    s.src_sectors = g_new(int64_t, s.src_num);
2121

P
Peter Lieven 已提交
2122 2123
    for (bs_i = 0; bs_i < s.src_num; bs_i++) {
        s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
2124 2125
                               fmt, src_flags, src_writethrough, quiet,
                               force_share);
P
Peter Lieven 已提交
2126
        if (!s.src[bs_i]) {
2127 2128 2129
            ret = -1;
            goto out;
        }
P
Peter Lieven 已提交
2130 2131
        s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
        if (s.src_sectors[bs_i] < 0) {
2132
            error_report("Could not get size of %s: %s",
P
Peter Lieven 已提交
2133
                         argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
2134 2135 2136
            ret = -1;
            goto out;
        }
P
Peter Lieven 已提交
2137
        s.total_sectors += s.src_sectors[bs_i];
2138
    }
B
bellard 已提交
2139

2140
    if (sn_opts) {
P
Peter Lieven 已提交
2141
        bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
2142 2143 2144
                               qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
                               qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
                               &local_err);
2145
    } else if (snapshot_name != NULL) {
P
Peter Lieven 已提交
2146
        if (s.src_num > 1) {
2147
            error_report("No support for concatenating multiple snapshot");
E
edison 已提交
2148 2149 2150
            ret = -1;
            goto out;
        }
2151

P
Peter Lieven 已提交
2152 2153
        bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
                                             &local_err);
2154
    }
2155
    if (local_err) {
2156
        error_reportf_err(local_err, "Failed to load snapshot: ");
2157 2158
        ret = -1;
        goto out;
E
edison 已提交
2159 2160
    }

2161 2162 2163 2164 2165 2166 2167 2168
    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;
        }
2169

2170 2171 2172 2173 2174 2175
        proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
        if (!proto_drv) {
            error_report_err(local_err);
            ret = -1;
            goto out;
        }
2176

M
Max Reitz 已提交
2177 2178 2179 2180 2181 2182
        if (!drv->create_opts) {
            error_report("Format driver '%s' does not support image creation",
                         drv->format_name);
            ret = -1;
            goto out;
        }
2183

M
Max Reitz 已提交
2184 2185 2186 2187 2188 2189
        if (!proto_drv->create_opts) {
            error_report("Protocol driver '%s' does not support image creation",
                         proto_drv->format_name);
            ret = -1;
            goto out;
        }
2190

M
Max Reitz 已提交
2191 2192
        create_opts = qemu_opts_append(create_opts, drv->create_opts);
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2193

M
Max Reitz 已提交
2194
        opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2195 2196 2197
        if (options) {
            qemu_opts_do_parse(opts, options, NULL, &local_err);
            if (local_err) {
2198
                error_report_err(local_err);
2199 2200 2201
                ret = -1;
                goto out;
            }
M
Max Reitz 已提交
2202
        }
2203

P
Peter Lieven 已提交
2204
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
2205
                            &error_abort);
M
Max Reitz 已提交
2206 2207 2208 2209
        ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
        if (ret < 0) {
            goto out;
        }
2210
    }
2211

2212
    /* Get backing file name if -o backing_file was used */
2213
    out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2214
    if (out_baseimg_param) {
2215
        out_baseimg = out_baseimg_param;
2216
    }
P
Peter Lieven 已提交
2217
    s.target_has_backing = (bool) out_baseimg;
2218

2219 2220 2221 2222 2223 2224 2225
    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;
    }

2226
    /* Check if compression is supported */
P
Peter Lieven 已提交
2227
    if (s.compressed) {
2228 2229
        bool encryption =
            qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2230 2231
        const char *encryptfmt =
            qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
2232 2233
        const char *preallocation =
            qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2234

2235
        if (drv && !drv->bdrv_co_pwritev_compressed) {
2236
            error_report("Compression not supported for this file format");
2237 2238
            ret = -1;
            goto out;
2239 2240
        }

2241
        if (encryption || encryptfmt) {
2242 2243
            error_report("Compression and encryption not supported at "
                         "the same time");
2244 2245
            ret = -1;
            goto out;
2246
        }
2247

2248 2249
        if (preallocation
            && strcmp(preallocation, "off"))
2250 2251 2252 2253 2254 2255
        {
            error_report("Compression and preallocation not supported at "
                         "the same time");
            ret = -1;
            goto out;
        }
2256 2257
    }

2258 2259
    if (!skip_create) {
        /* Create the new image */
C
Chunyan Liu 已提交
2260
        ret = bdrv_create(drv, out_filename, opts, &local_err);
2261
        if (ret < 0) {
2262 2263
            error_reportf_err(local_err, "%s: error while converting %s: ",
                              out_filename, out_fmt);
2264
            goto out;
B
bellard 已提交
2265 2266
        }
    }
2267

P
Peter Lieven 已提交
2268
    flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2269
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2270 2271
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2272
        goto out;
2273 2274
    }

2275 2276 2277 2278 2279 2280 2281 2282 2283
    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
         */
2284 2285
        s.target = img_open_new_file(out_filename, opts, out_fmt,
                                     flags, writethrough, quiet, false);
2286
    }
P
Peter Lieven 已提交
2287
    if (!s.target) {
2288 2289 2290
        ret = -1;
        goto out;
    }
P
Peter Lieven 已提交
2291
    out_bs = blk_bs(s.target);
B
bellard 已提交
2292

2293 2294 2295 2296 2297 2298
    if (s.compressed && !out_bs->drv->bdrv_co_pwritev_compressed) {
        error_report("Compression not supported for this file format");
        ret = -1;
        goto out;
    }

2299
    /* increase bufsectors from the default 4096 (2M) if opt_transfer
2300 2301
     * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
     * as maximum. */
P
Peter Lieven 已提交
2302 2303 2304 2305 2306
    s.buf_sectors = MIN(32768,
                        MAX(s.buf_sectors,
                            MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
                                out_bs->bl.pdiscard_alignment >>
                                BDRV_SECTOR_BITS)));
2307

2308
    if (skip_create) {
P
Peter Lieven 已提交
2309
        int64_t output_sectors = blk_nb_sectors(s.target);
2310
        if (output_sectors < 0) {
2311
            error_report("unable to get output image length: %s",
2312
                         strerror(-output_sectors));
2313 2314
            ret = -1;
            goto out;
P
Peter Lieven 已提交
2315
        } else if (output_sectors < s.total_sectors) {
2316 2317 2318 2319 2320 2321
            error_report("output file is smaller than input file");
            ret = -1;
            goto out;
        }
    }

2322 2323
    ret = bdrv_get_info(out_bs, &bdi);
    if (ret < 0) {
P
Peter Lieven 已提交
2324
        if (s.compressed) {
2325
            error_report("could not get block driver info");
2326 2327
            goto out;
        }
2328
    } else {
P
Peter Lieven 已提交
2329 2330 2331
        s.compressed = s.compressed || bdi.needs_compressed_writes;
        s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
    }
2332

P
Peter Lieven 已提交
2333
    ret = convert_do_copy(&s);
2334
out:
2335 2336 2337
    if (!ret) {
        qemu_progress_print(100, 0);
    }
2338
    qemu_progress_end();
2339 2340
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
2341
    qemu_opts_del(sn_opts);
P
Peter Lieven 已提交
2342 2343 2344 2345
    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 已提交
2346
        }
P
Peter Lieven 已提交
2347
        g_free(s.src);
M
Markus Armbruster 已提交
2348
    }
P
Peter Lieven 已提交
2349
    g_free(s.src_sectors);
2350 2351 2352
fail_getopt:
    g_free(options);

P
Peter Lieven 已提交
2353
    return !!ret;
B
bellard 已提交
2354 2355
}

B
bellard 已提交
2356

B
bellard 已提交
2357 2358 2359 2360 2361 2362 2363 2364 2365
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");
2366 2367
    bdrv_snapshot_dump(fprintf, stdout, NULL);
    printf("\n");
B
bellard 已提交
2368 2369
    for(i = 0; i < nb_sns; i++) {
        sn = &sn_tab[i];
2370 2371
        bdrv_snapshot_dump(fprintf, stdout, sn);
        printf("\n");
B
bellard 已提交
2372
    }
2373
    g_free(sn_tab);
B
bellard 已提交
2374 2375
}

2376 2377 2378 2379
static void dump_json_image_info_list(ImageInfoList *list)
{
    QString *str;
    QObject *obj;
2380
    Visitor *v = qobject_output_visitor_new(&obj);
2381 2382 2383

    visit_type_ImageInfoList(v, NULL, &list, &error_abort);
    visit_complete(v, &obj);
2384 2385 2386 2387
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
2388
    visit_free(v);
2389 2390 2391
    QDECREF(str);
}

2392 2393 2394 2395
static void dump_json_image_info(ImageInfo *info)
{
    QString *str;
    QObject *obj;
2396
    Visitor *v = qobject_output_visitor_new(&obj);
2397 2398 2399

    visit_type_ImageInfo(v, NULL, &info, &error_abort);
    visit_complete(v, &obj);
2400 2401 2402 2403
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
2404
    visit_free(v);
2405 2406 2407
    QDECREF(str);
}

2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418
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;

2419
        bdrv_image_info_dump(fprintf, stdout, elem->value);
2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439
    }
}

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.
 */
2440 2441
static ImageInfoList *collect_image_info_list(bool image_opts,
                                              const char *filename,
2442
                                              const char *fmt,
2443
                                              bool chain, bool force_share)
2444 2445 2446 2447
{
    ImageInfoList *head = NULL;
    ImageInfoList **last = &head;
    GHashTable *filenames;
2448
    Error *err = NULL;
2449 2450 2451 2452

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

    while (filename) {
M
Markus Armbruster 已提交
2453
        BlockBackend *blk;
2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464
        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);

2465
        blk = img_open(image_opts, filename, fmt,
2466 2467
                       BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
                       force_share);
2468
        if (!blk) {
2469 2470
            goto err;
        }
2471
        bs = blk_bs(blk);
2472

2473
        bdrv_query_image_info(bs, &info, &err);
2474
        if (err) {
2475
            error_report_err(err);
M
Markus Armbruster 已提交
2476
            blk_unref(blk);
2477
            goto err;
2478
        }
2479 2480 2481 2482 2483 2484

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

M
Markus Armbruster 已提交
2485
        blk_unref(blk);
2486 2487 2488 2489 2490 2491

        filename = fmt = NULL;
        if (chain) {
            if (info->has_full_backing_filename) {
                filename = info->full_backing_filename;
            } else if (info->has_backing_filename) {
2492 2493 2494 2495
                error_report("Could not determine absolute backing filename,"
                             " but backing filename '%s' present",
                             info->backing_filename);
                goto err;
2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510
            }
            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;
}

2511 2512 2513 2514
static int img_info(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
2515
    bool chain = false;
2516
    const char *filename, *fmt, *output;
2517
    ImageInfoList *list;
2518
    bool image_opts = false;
2519
    bool force_share = false;
2520

B
bellard 已提交
2521
    fmt = NULL;
2522
    output = NULL;
B
bellard 已提交
2523
    for(;;) {
2524 2525 2526 2527 2528
        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},
2529
            {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2530
            {"object", required_argument, 0, OPTION_OBJECT},
2531
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2532
            {"force-share", no_argument, 0, 'U'},
2533 2534
            {0, 0, 0, 0}
        };
2535
        c = getopt_long(argc, argv, ":f:hU",
2536
                        long_options, &option_index);
2537
        if (c == -1) {
B
bellard 已提交
2538
            break;
2539
        }
B
bellard 已提交
2540
        switch(c) {
2541 2542 2543
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
2544
        case '?':
2545 2546
            unrecognized_option(argv[optind - 1]);
            break;
B
bellard 已提交
2547 2548 2549 2550 2551 2552
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2553 2554 2555
        case 'U':
            force_share = true;
            break;
2556 2557 2558
        case OPTION_OUTPUT:
            output = optarg;
            break;
2559 2560 2561
        case OPTION_BACKING_CHAIN:
            chain = true;
            break;
2562 2563 2564 2565 2566 2567 2568 2569
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2570 2571 2572
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
B
bellard 已提交
2573 2574
        }
    }
2575
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2576
        error_exit("Expecting one image file name");
2577
    }
B
bellard 已提交
2578 2579
    filename = argv[optind++];

2580 2581 2582 2583 2584 2585
    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.");
2586 2587
        return 1;
    }
2588

2589 2590
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2591
                          NULL, NULL)) {
2592 2593 2594
        return 1;
    }

2595 2596
    list = collect_image_info_list(image_opts, filename, fmt, chain,
                                   force_share);
2597
    if (!list) {
2598
        return 1;
B
bellard 已提交
2599
    }
2600 2601 2602

    switch (output_format) {
    case OFORMAT_HUMAN:
2603
        dump_human_image_info_list(list);
2604 2605
        break;
    case OFORMAT_JSON:
2606 2607 2608 2609 2610
        if (chain) {
            dump_json_image_info_list(list);
        } else {
            dump_json_image_info(list->value);
        }
2611
        break;
B
bellard 已提交
2612
    }
2613

2614
    qapi_free_ImageInfoList(list);
B
bellard 已提交
2615 2616 2617
    return 0;
}

P
Paolo Bonzini 已提交
2618 2619 2620 2621 2622
static void dump_map_entry(OutputFormat output_format, MapEntry *e,
                           MapEntry *next)
{
    switch (output_format) {
    case OFORMAT_HUMAN:
2623
        if (e->data && !e->has_offset) {
P
Paolo Bonzini 已提交
2624 2625 2626
            error_report("File contains external, encrypted or compressed clusters.");
            exit(1);
        }
2627
        if (e->data && !e->zero) {
P
Paolo Bonzini 已提交
2628
            printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2629 2630 2631
                   e->start, e->length,
                   e->has_offset ? e->offset : 0,
                   e->has_filename ? e->filename : "");
P
Paolo Bonzini 已提交
2632 2633 2634 2635
        }
        /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
         * Modify the flags here to allow more coalescing.
         */
2636 2637 2638
        if (next && (!next->data || next->zero)) {
            next->data = false;
            next->zero = true;
P
Paolo Bonzini 已提交
2639 2640 2641
        }
        break;
    case OFORMAT_JSON:
2642 2643
        printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
               " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
P
Paolo Bonzini 已提交
2644 2645
               (e->start == 0 ? "[" : ",\n"),
               e->start, e->length, e->depth,
2646 2647 2648
               e->zero ? "true" : "false",
               e->data ? "true" : "false");
        if (e->has_offset) {
P
Paolo Bonzini 已提交
2649
            printf(", \"offset\": %"PRId64"", e->offset);
P
Paolo Bonzini 已提交
2650 2651 2652 2653 2654 2655 2656 2657 2658 2659
        }
        putchar('}');

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

2660 2661
static int get_block_status(BlockDriverState *bs, int64_t offset,
                            int64_t bytes, MapEntry *e)
P
Paolo Bonzini 已提交
2662
{
2663
    int ret;
P
Paolo Bonzini 已提交
2664
    int depth;
2665
    BlockDriverState *file;
J
John Snow 已提交
2666
    bool has_offset;
2667
    int64_t map;
P
Paolo Bonzini 已提交
2668 2669 2670 2671 2672 2673 2674 2675

    /* 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 (;;) {
2676
        ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
P
Paolo Bonzini 已提交
2677 2678 2679
        if (ret < 0) {
            return ret;
        }
2680
        assert(bytes);
P
Paolo Bonzini 已提交
2681 2682 2683
        if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
            break;
        }
2684
        bs = backing_bs(bs);
P
Paolo Bonzini 已提交
2685 2686 2687 2688 2689 2690 2691 2692
        if (bs == NULL) {
            ret = 0;
            break;
        }

        depth++;
    }

J
John Snow 已提交
2693 2694 2695
    has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);

    *e = (MapEntry) {
2696
        .start = offset,
2697
        .length = bytes,
J
John Snow 已提交
2698 2699
        .data = !!(ret & BDRV_BLOCK_DATA),
        .zero = !!(ret & BDRV_BLOCK_ZERO),
2700
        .offset = map,
J
John Snow 已提交
2701 2702 2703 2704 2705 2706
        .has_offset = has_offset,
        .depth = depth,
        .has_filename = file && has_offset,
        .filename = file && has_offset ? file->filename : NULL,
    };

P
Paolo Bonzini 已提交
2707 2708 2709
    return 0;
}

2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730
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 已提交
2731 2732 2733 2734
static int img_map(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
M
Markus Armbruster 已提交
2735
    BlockBackend *blk;
P
Paolo Bonzini 已提交
2736 2737 2738 2739 2740
    BlockDriverState *bs;
    const char *filename, *fmt, *output;
    int64_t length;
    MapEntry curr = { .length = 0 }, next;
    int ret = 0;
2741
    bool image_opts = false;
2742
    bool force_share = false;
P
Paolo Bonzini 已提交
2743 2744 2745 2746 2747 2748 2749 2750 2751

    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},
2752
            {"object", required_argument, 0, OPTION_OBJECT},
2753
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2754
            {"force-share", no_argument, 0, 'U'},
P
Paolo Bonzini 已提交
2755 2756
            {0, 0, 0, 0}
        };
2757
        c = getopt_long(argc, argv, ":f:hU",
P
Paolo Bonzini 已提交
2758 2759 2760 2761 2762
                        long_options, &option_index);
        if (c == -1) {
            break;
        }
        switch (c) {
2763 2764 2765
        case ':':
            missing_argument(argv[optind - 1]);
            break;
P
Paolo Bonzini 已提交
2766
        case '?':
2767 2768
            unrecognized_option(argv[optind - 1]);
            break;
P
Paolo Bonzini 已提交
2769 2770 2771 2772 2773 2774
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2775 2776 2777
        case 'U':
            force_share = true;
            break;
P
Paolo Bonzini 已提交
2778 2779 2780
        case OPTION_OUTPUT:
            output = optarg;
            break;
2781 2782 2783 2784 2785 2786 2787 2788
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2789 2790 2791
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
P
Paolo Bonzini 已提交
2792 2793
        }
    }
F
Fam Zheng 已提交
2794 2795
    if (optind != argc - 1) {
        error_exit("Expecting one image file name");
P
Paolo Bonzini 已提交
2796
    }
F
Fam Zheng 已提交
2797
    filename = argv[optind];
P
Paolo Bonzini 已提交
2798 2799 2800 2801 2802 2803 2804 2805 2806 2807

    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;
    }

2808 2809
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2810
                          NULL, NULL)) {
2811 2812 2813
        return 1;
    }

2814
    blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
2815 2816
    if (!blk) {
        return 1;
P
Paolo Bonzini 已提交
2817
    }
2818
    bs = blk_bs(blk);
P
Paolo Bonzini 已提交
2819 2820 2821 2822 2823

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

2824
    length = blk_getlength(blk);
P
Paolo Bonzini 已提交
2825
    while (curr.start + curr.length < length) {
2826 2827
        int64_t offset = curr.start + curr.length;
        int64_t n;
P
Paolo Bonzini 已提交
2828 2829

        /* Probe up to 1 GiB at a time.  */
2830 2831
        n = QEMU_ALIGN_DOWN(MIN(1 << 30, length - offset), BDRV_SECTOR_SIZE);
        ret = get_block_status(bs, offset, n, &next);
P
Paolo Bonzini 已提交
2832 2833 2834 2835 2836 2837

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

2838
        if (entry_mergeable(&curr, &next)) {
P
Paolo Bonzini 已提交
2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851
            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 已提交
2852
    blk_unref(blk);
P
Paolo Bonzini 已提交
2853 2854 2855
    return ret < 0;
}

2856 2857 2858 2859 2860
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

2861
static int img_snapshot(int argc, char **argv)
2862
{
M
Markus Armbruster 已提交
2863
    BlockBackend *blk;
2864 2865 2866
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
2867
    int c, ret = 0, bdrv_oflags;
2868 2869
    int action = 0;
    qemu_timeval tv;
2870
    bool quiet = false;
2871
    Error *err = NULL;
2872
    bool image_opts = false;
2873
    bool force_share = false;
2874

2875
    bdrv_oflags = BDRV_O_RDWR;
2876 2877
    /* Parse commandline parameters */
    for(;;) {
2878 2879 2880
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
2881
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2882
            {"force-share", no_argument, 0, 'U'},
2883 2884
            {0, 0, 0, 0}
        };
2885
        c = getopt_long(argc, argv, ":la:c:d:hqU",
2886
                        long_options, NULL);
2887
        if (c == -1) {
2888
            break;
2889
        }
2890
        switch(c) {
2891 2892 2893
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
2894
        case '?':
2895 2896
            unrecognized_option(argv[optind - 1]);
            break;
2897 2898
        case 'h':
            help();
2899
            return 0;
2900 2901
        case 'l':
            if (action) {
F
Fam Zheng 已提交
2902
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2903
                return 0;
2904 2905
            }
            action = SNAPSHOT_LIST;
2906
            bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2907 2908 2909
            break;
        case 'a':
            if (action) {
F
Fam Zheng 已提交
2910
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2911
                return 0;
2912 2913 2914 2915 2916 2917
            }
            action = SNAPSHOT_APPLY;
            snapshot_name = optarg;
            break;
        case 'c':
            if (action) {
F
Fam Zheng 已提交
2918
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2919
                return 0;
2920 2921 2922 2923 2924 2925
            }
            action = SNAPSHOT_CREATE;
            snapshot_name = optarg;
            break;
        case 'd':
            if (action) {
F
Fam Zheng 已提交
2926
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2927
                return 0;
2928 2929 2930 2931
            }
            action = SNAPSHOT_DELETE;
            snapshot_name = optarg;
            break;
2932 2933 2934
        case 'q':
            quiet = true;
            break;
2935 2936 2937
        case 'U':
            force_share = true;
            break;
2938 2939 2940 2941 2942 2943 2944 2945
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2946 2947 2948
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
2949 2950 2951
        }
    }

2952
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2953
        error_exit("Expecting one image file name");
2954
    }
2955 2956
    filename = argv[optind++];

2957 2958
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2959
                          NULL, NULL)) {
2960 2961 2962
        return 1;
    }

2963
    /* Open the image */
2964 2965
    blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
                   force_share);
2966 2967
    if (!blk) {
        return 1;
2968
    }
2969
    bs = blk_bs(blk);
2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985

    /* 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);
2986
        if (ret) {
2987
            error_report("Could not create snapshot '%s': %d (%s)",
2988
                snapshot_name, ret, strerror(-ret));
2989
        }
2990 2991 2992
        break;

    case SNAPSHOT_APPLY:
2993
        ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
2994
        if (ret) {
2995 2996
            error_reportf_err(err, "Could not apply snapshot '%s': ",
                              snapshot_name);
2997
        }
2998 2999 3000
        break;

    case SNAPSHOT_DELETE:
3001
        bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
3002
        if (err) {
3003 3004
            error_reportf_err(err, "Could not delete snapshot '%s': ",
                              snapshot_name);
3005
            ret = 1;
3006
        }
3007 3008 3009 3010
        break;
    }

    /* Cleanup */
M
Markus Armbruster 已提交
3011
    blk_unref(blk);
3012 3013 3014
    if (ret) {
        return 1;
    }
3015
    return 0;
3016 3017
}

K
Kevin Wolf 已提交
3018 3019
static int img_rebase(int argc, char **argv)
{
M
Markus Armbruster 已提交
3020
    BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
P
Paolo Bonzini 已提交
3021 3022
    uint8_t *buf_old = NULL;
    uint8_t *buf_new = NULL;
3023
    BlockDriverState *bs = NULL;
K
Kevin Wolf 已提交
3024
    char *filename;
3025 3026
    const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
    int c, flags, src_flags, ret;
3027
    bool writethrough, src_writethrough;
K
Kevin Wolf 已提交
3028
    int unsafe = 0;
3029
    bool force_share = false;
3030
    int progress = 0;
3031
    bool quiet = false;
3032
    Error *local_err = NULL;
3033
    bool image_opts = false;
K
Kevin Wolf 已提交
3034 3035

    /* Parse commandline parameters */
K
Kevin Wolf 已提交
3036
    fmt = NULL;
3037
    cache = BDRV_DEFAULT_CACHE;
3038
    src_cache = BDRV_DEFAULT_CACHE;
K
Kevin Wolf 已提交
3039 3040 3041
    out_baseimg = NULL;
    out_basefmt = NULL;
    for(;;) {
3042 3043 3044
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3045
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3046
            {"force-share", no_argument, 0, 'U'},
3047 3048
            {0, 0, 0, 0}
        };
3049
        c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
3050
                        long_options, NULL);
3051
        if (c == -1) {
K
Kevin Wolf 已提交
3052
            break;
3053
        }
K
Kevin Wolf 已提交
3054
        switch(c) {
3055 3056 3057
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
3058
        case '?':
3059 3060
            unrecognized_option(argv[optind - 1]);
            break;
K
Kevin Wolf 已提交
3061 3062 3063
        case 'h':
            help();
            return 0;
K
Kevin Wolf 已提交
3064 3065 3066
        case 'f':
            fmt = optarg;
            break;
K
Kevin Wolf 已提交
3067 3068 3069 3070 3071 3072 3073 3074 3075
        case 'F':
            out_basefmt = optarg;
            break;
        case 'b':
            out_baseimg = optarg;
            break;
        case 'u':
            unsafe = 1;
            break;
3076 3077 3078
        case 'p':
            progress = 1;
            break;
3079 3080 3081
        case 't':
            cache = optarg;
            break;
3082 3083 3084
        case 'T':
            src_cache = optarg;
            break;
3085 3086 3087
        case 'q':
            quiet = true;
            break;
3088 3089 3090 3091 3092 3093 3094 3095
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3096 3097 3098
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
3099 3100 3101
        case 'U':
            force_share = true;
            break;
K
Kevin Wolf 已提交
3102 3103 3104
        }
    }

3105 3106 3107 3108
    if (quiet) {
        progress = 0;
    }

F
Fam Zheng 已提交
3109 3110 3111 3112 3113
    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)");
3114
    }
K
Kevin Wolf 已提交
3115 3116
    filename = argv[optind++];

3117 3118
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3119
                          NULL, NULL)) {
3120 3121 3122
        return 1;
    }

3123 3124 3125
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

3126
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
3127
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3128 3129
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
3130
        goto out;
3131 3132
    }

3133 3134
    src_flags = 0;
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
3135 3136
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
3137
        goto out;
3138 3139
    }

3140 3141 3142 3143
    /* 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 已提交
3144 3145 3146 3147 3148 3149
    /*
     * 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.
     */
3150 3151
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   false);
3152
    if (!blk) {
3153 3154
        ret = -1;
        goto out;
3155
    }
3156
    bs = blk_bs(blk);
K
Kevin Wolf 已提交
3157 3158

    if (out_basefmt != NULL) {
3159
        if (bdrv_find_format(out_basefmt) == NULL) {
3160
            error_report("Invalid format name: '%s'", out_basefmt);
3161 3162
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
3163 3164 3165 3166
        }
    }

    /* For safe rebasing we need to compare old and new backing file */
3167
    if (!unsafe) {
3168
        char backing_name[PATH_MAX];
3169 3170 3171 3172
        QDict *options = NULL;

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

3176 3177 3178 3179
        if (force_share) {
            if (!options) {
                options = qdict_new();
            }
3180
            qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3181
        }
K
Kevin Wolf 已提交
3182
        bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3183
        blk_old_backing = blk_new_open(backing_name, NULL,
3184 3185
                                       options, src_flags, &local_err);
        if (!blk_old_backing) {
3186 3187 3188
            error_reportf_err(local_err,
                              "Could not open old backing file '%s': ",
                              backing_name);
3189
            ret = -1;
3190
            goto out;
K
Kevin Wolf 已提交
3191
        }
3192

3193
        if (out_baseimg[0]) {
3194
            options = qdict_new();
3195
            if (out_basefmt) {
3196
                qdict_put_str(options, "driver", out_basefmt);
3197 3198 3199
            }
            if (force_share) {
                qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3200 3201
            }

3202
            blk_new_backing = blk_new_open(out_baseimg, NULL,
3203 3204
                                           options, src_flags, &local_err);
            if (!blk_new_backing) {
3205 3206 3207
                error_reportf_err(local_err,
                                  "Could not open new backing file '%s': ",
                                  out_baseimg);
3208
                ret = -1;
3209 3210
                goto out;
            }
K
Kevin Wolf 已提交
3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223
        }
    }

    /*
     * 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) {
3224 3225 3226 3227 3228
        int64_t size;
        int64_t old_backing_size;
        int64_t new_backing_size = 0;
        uint64_t offset;
        int64_t n;
3229
        float local_progress = 0;
3230

3231 3232
        buf_old = blk_blockalign(blk, IO_BUF_SIZE);
        buf_new = blk_blockalign(blk, IO_BUF_SIZE);
K
Kevin Wolf 已提交
3233

3234 3235
        size = blk_getlength(blk);
        if (size < 0) {
3236
            error_report("Could not get size of '%s': %s",
3237
                         filename, strerror(-size));
3238 3239 3240
            ret = -1;
            goto out;
        }
3241 3242
        old_backing_size = blk_getlength(blk_old_backing);
        if (old_backing_size < 0) {
3243
            char backing_name[PATH_MAX];
3244 3245 3246

            bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
            error_report("Could not get size of '%s': %s",
3247
                         backing_name, strerror(-old_backing_size));
3248 3249 3250
            ret = -1;
            goto out;
        }
3251
        if (blk_new_backing) {
3252 3253
            new_backing_size = blk_getlength(blk_new_backing);
            if (new_backing_size < 0) {
3254
                error_report("Could not get size of '%s': %s",
3255
                             out_baseimg, strerror(-new_backing_size));
3256 3257 3258
                ret = -1;
                goto out;
            }
3259
        }
K
Kevin Wolf 已提交
3260

3261 3262
        if (size != 0) {
            local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
3263 3264
        }

3265 3266 3267
        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 已提交
3268 3269

            /* If the cluster is allocated, we don't need to take action */
3270
            ret = bdrv_is_allocated(bs, offset, n, &n);
3271 3272 3273 3274 3275
            if (ret < 0) {
                error_report("error while reading image metadata: %s",
                             strerror(-ret));
                goto out;
            }
3276
            if (ret) {
K
Kevin Wolf 已提交
3277 3278 3279
                continue;
            }

3280 3281 3282 3283
            /*
             * Read old and new backing file and take into consideration that
             * backing files may be smaller than the COW image.
             */
3284 3285
            if (offset >= old_backing_size) {
                memset(buf_old, 0, n);
3286
            } else {
3287 3288
                if (offset + n > old_backing_size) {
                    n = old_backing_size - offset;
3289 3290
                }

3291
                ret = blk_pread(blk_old_backing, offset, buf_old, n);
3292 3293 3294 3295
                if (ret < 0) {
                    error_report("error while reading from old backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3296
            }
3297

3298 3299
            if (offset >= new_backing_size || !blk_new_backing) {
                memset(buf_new, 0, n);
3300
            } else {
3301 3302
                if (offset + n > new_backing_size) {
                    n = new_backing_size - offset;
3303 3304
                }

3305
                ret = blk_pread(blk_new_backing, offset, buf_new, n);
3306 3307 3308 3309
                if (ret < 0) {
                    error_report("error while reading from new backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3310 3311 3312 3313 3314
            }

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

3315
            while (written < n) {
3316
                int64_t pnum;
K
Kevin Wolf 已提交
3317

3318 3319
                if (compare_buffers(buf_old + written, buf_new + written,
                                    n - written, &pnum))
K
Kevin Wolf 已提交
3320
                {
3321
                    ret = blk_pwrite(blk, offset + written,
3322
                                     buf_old + written, pnum, 0);
K
Kevin Wolf 已提交
3323
                    if (ret < 0) {
3324
                        error_report("Error while writing to COW image: %s",
K
Kevin Wolf 已提交
3325
                            strerror(-ret));
3326
                        goto out;
K
Kevin Wolf 已提交
3327 3328 3329 3330 3331
                    }
                }

                written += pnum;
            }
3332
            qemu_progress_print(local_progress, 100);
K
Kevin Wolf 已提交
3333 3334 3335 3336 3337 3338 3339 3340
        }
    }

    /*
     * 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.
     */
3341 3342 3343 3344 3345 3346
    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 已提交
3347
    if (ret == -ENOSPC) {
3348 3349
        error_report("Could not change the backing file to '%s': No "
                     "space left in the file header", out_baseimg);
K
Kevin Wolf 已提交
3350
    } else if (ret < 0) {
3351
        error_report("Could not change the backing file to '%s': %s",
K
Kevin Wolf 已提交
3352 3353 3354
            out_baseimg, strerror(-ret));
    }

3355
    qemu_progress_print(100, 0);
K
Kevin Wolf 已提交
3356 3357 3358 3359 3360 3361
    /*
     * 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.
     */
3362
out:
3363
    qemu_progress_end();
K
Kevin Wolf 已提交
3364 3365
    /* Cleanup */
    if (!unsafe) {
M
Markus Armbruster 已提交
3366 3367
        blk_unref(blk_old_backing);
        blk_unref(blk_new_backing);
K
Kevin Wolf 已提交
3368
    }
P
Paolo Bonzini 已提交
3369 3370
    qemu_vfree(buf_old);
    qemu_vfree(buf_new);
K
Kevin Wolf 已提交
3371

M
Markus Armbruster 已提交
3372
    blk_unref(blk);
3373 3374 3375
    if (ret) {
        return 1;
    }
K
Kevin Wolf 已提交
3376 3377 3378
    return 0;
}

3379 3380
static int img_resize(int argc, char **argv)
{
3381
    Error *err = NULL;
3382 3383
    int c, ret, relative;
    const char *filename, *fmt, *size;
3384
    int64_t n, total_size, current_size;
3385
    bool quiet = false;
M
Markus Armbruster 已提交
3386
    BlockBackend *blk = NULL;
3387
    PreallocMode prealloc = PREALLOC_MODE_OFF;
3388
    QemuOpts *param;
3389

3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400
    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 */
            }
3401 3402
        },
    };
3403
    bool image_opts = false;
3404
    bool shrink = false;
3405

K
Kevin Wolf 已提交
3406 3407 3408
    /* Remove size from argv manually so that negative numbers are not treated
     * as options by getopt. */
    if (argc < 3) {
F
Fam Zheng 已提交
3409
        error_exit("Not enough arguments");
K
Kevin Wolf 已提交
3410 3411 3412 3413 3414 3415
        return 1;
    }

    size = argv[--argc];

    /* Parse getopt arguments */
3416 3417
    fmt = NULL;
    for(;;) {
3418 3419 3420
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3421
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3422
            {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
3423
            {"shrink", no_argument, 0, OPTION_SHRINK},
3424 3425
            {0, 0, 0, 0}
        };
3426
        c = getopt_long(argc, argv, ":f:hq",
3427
                        long_options, NULL);
3428 3429 3430 3431
        if (c == -1) {
            break;
        }
        switch(c) {
3432 3433 3434
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
3435
        case '?':
3436 3437
            unrecognized_option(argv[optind - 1]);
            break;
3438 3439 3440 3441 3442 3443
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
3444 3445 3446
        case 'q':
            quiet = true;
            break;
3447 3448 3449 3450 3451 3452 3453 3454
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3455 3456 3457
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
3458
        case OPTION_PREALLOCATION:
3459
            prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
3460
                                       PREALLOC_MODE__MAX, NULL);
3461 3462 3463 3464 3465
            if (prealloc == PREALLOC_MODE__MAX) {
                error_report("Invalid preallocation mode '%s'", optarg);
                return 1;
            }
            break;
3466 3467 3468
        case OPTION_SHRINK:
            shrink = true;
            break;
3469 3470
        }
    }
3471
    if (optind != argc - 1) {
3472
        error_exit("Expecting image file name and size");
3473 3474 3475
    }
    filename = argv[optind++];

3476 3477
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3478
                          NULL, NULL)) {
3479 3480 3481
        return 1;
    }

3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497
    /* 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 */
3498
    param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3499
    qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3500 3501
    if (err) {
        error_report_err(err);
3502
        ret = -1;
3503
        qemu_opts_del(param);
3504
        goto out;
3505
    }
3506 3507
    n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
    qemu_opts_del(param);
3508

3509
    blk = img_open(image_opts, filename, fmt,
3510 3511
                   BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
                   false);
3512
    if (!blk) {
3513 3514
        ret = -1;
        goto out;
3515
    }
3516

3517 3518 3519 3520 3521 3522 3523 3524
    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;
    }

3525
    if (relative) {
3526
        total_size = current_size + n * relative;
3527 3528 3529 3530
    } else {
        total_size = n;
    }
    if (total_size <= 0) {
3531
        error_report("New image size must be positive");
3532 3533
        ret = -1;
        goto out;
3534 3535
    }

3536 3537 3538 3539 3540 3541
    if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
        error_report("Preallocation can only be used for growing images");
        ret = -1;
        goto out;
    }

3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558
    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.");
        }
    }

3559
    ret = blk_truncate(blk, total_size, prealloc, &err);
3560
    if (!ret) {
3561
        qprintf(quiet, "Image resized.\n");
3562 3563
    } else {
        error_report_err(err);
3564
    }
3565
out:
M
Markus Armbruster 已提交
3566
    blk_unref(blk);
3567 3568 3569
    if (ret) {
        return 1;
    }
3570 3571 3572
    return 0;
}

3573
static void amend_status_cb(BlockDriverState *bs,
3574 3575
                            int64_t offset, int64_t total_work_size,
                            void *opaque)
3576 3577 3578 3579
{
    qemu_progress_print(100.f * offset / total_work_size, 0);
}

M
Max Reitz 已提交
3580 3581
static int img_amend(int argc, char **argv)
{
3582
    Error *err = NULL;
M
Max Reitz 已提交
3583 3584
    int c, ret = 0;
    char *options = NULL;
3585 3586
    QemuOptsList *create_opts = NULL;
    QemuOpts *opts = NULL;
3587 3588
    const char *fmt = NULL, *filename, *cache;
    int flags;
3589
    bool writethrough;
3590
    bool quiet = false, progress = false;
M
Markus Armbruster 已提交
3591
    BlockBackend *blk = NULL;
M
Max Reitz 已提交
3592
    BlockDriverState *bs = NULL;
3593
    bool image_opts = false;
M
Max Reitz 已提交
3594

3595
    cache = BDRV_DEFAULT_CACHE;
M
Max Reitz 已提交
3596
    for (;;) {
3597 3598 3599
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3600
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3601 3602
            {0, 0, 0, 0}
        };
3603
        c = getopt_long(argc, argv, ":ho:f:t:pq",
3604
                        long_options, NULL);
M
Max Reitz 已提交
3605 3606 3607 3608 3609
        if (c == -1) {
            break;
        }

        switch (c) {
3610 3611 3612
        case ':':
            missing_argument(argv[optind - 1]);
            break;
3613
        case '?':
3614 3615 3616
            unrecognized_option(argv[optind - 1]);
            break;
        case 'h':
3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655
            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 已提交
3656 3657 3658
        }
    }

3659
    if (!options) {
F
Fam Zheng 已提交
3660
        error_exit("Must specify options (-o)");
M
Max Reitz 已提交
3661 3662
    }

3663 3664
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3665
                          NULL, NULL)) {
3666 3667 3668 3669
        ret = -1;
        goto out_no_progress;
    }

3670 3671 3672 3673 3674
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);

3675 3676 3677 3678 3679 3680
    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 */
        ret = print_block_option_help(filename, fmt);
        goto out;
M
Max Reitz 已提交
3681 3682
    }

3683
    if (optind != argc - 1) {
M
Max Reitz 已提交
3684 3685 3686
        error_report("Expecting one image file name");
        ret = -1;
        goto out;
3687
    }
M
Max Reitz 已提交
3688

3689 3690
    flags = BDRV_O_RDWR;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3691 3692 3693 3694 3695
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        goto out;
    }

3696 3697
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   false);
3698
    if (!blk) {
M
Max Reitz 已提交
3699 3700 3701
        ret = -1;
        goto out;
    }
3702
    bs = blk_bs(blk);
M
Max Reitz 已提交
3703 3704 3705

    fmt = bs->drv->format_name;

3706
    if (has_help_option(options)) {
3707
        /* If the format was auto-detected, print option help here */
M
Max Reitz 已提交
3708 3709 3710 3711
        ret = print_block_option_help(filename, fmt);
        goto out;
    }

3712 3713 3714 3715 3716 3717 3718
    if (!bs->drv->create_opts) {
        error_report("Format driver '%s' does not support any options to amend",
                     fmt);
        ret = -1;
        goto out;
    }

C
Chunyan Liu 已提交
3719
    create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3720
    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
P
Paolo Bonzini 已提交
3721 3722 3723 3724 3725
    qemu_opts_do_parse(opts, options, NULL, &err);
    if (err) {
        error_report_err(err);
        ret = -1;
        goto out;
M
Max Reitz 已提交
3726 3727
    }

3728 3729
    /* In case the driver does not call amend_status_cb() */
    qemu_progress_print(0.f, 0);
3730
    ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
3731
    qemu_progress_print(100.f, 0);
M
Max Reitz 已提交
3732 3733 3734 3735 3736 3737
    if (ret < 0) {
        error_report("Error while amending options: %s", strerror(-ret));
        goto out;
    }

out:
3738 3739
    qemu_progress_end();

3740
out_no_progress:
M
Markus Armbruster 已提交
3741
    blk_unref(blk);
3742 3743
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
3744 3745
    g_free(options);

M
Max Reitz 已提交
3746 3747 3748 3749 3750 3751
    if (ret) {
        return 1;
    }
    return 0;
}

K
Kevin Wolf 已提交
3752 3753 3754
typedef struct BenchData {
    BlockBackend *blk;
    uint64_t image_size;
K
Kevin Wolf 已提交
3755
    bool write;
K
Kevin Wolf 已提交
3756
    int bufsize;
3757
    int step;
K
Kevin Wolf 已提交
3758 3759
    int nrreq;
    int n;
3760 3761
    int flush_interval;
    bool drain_on_flush;
K
Kevin Wolf 已提交
3762 3763 3764 3765
    uint8_t *buf;
    QEMUIOVector *qiov;

    int in_flight;
3766
    bool in_flush;
K
Kevin Wolf 已提交
3767 3768 3769
    uint64_t offset;
} BenchData;

3770 3771 3772
static void bench_undrained_flush_cb(void *opaque, int ret)
{
    if (ret < 0) {
3773
        error_report("Failed flush request: %s", strerror(-ret));
3774 3775 3776 3777
        exit(EXIT_FAILURE);
    }
}

K
Kevin Wolf 已提交
3778 3779 3780 3781 3782 3783
static void bench_cb(void *opaque, int ret)
{
    BenchData *b = opaque;
    BlockAIOCB *acb;

    if (ret < 0) {
3784
        error_report("Failed request: %s", strerror(-ret));
K
Kevin Wolf 已提交
3785 3786
        exit(EXIT_FAILURE);
    }
3787 3788 3789 3790 3791 3792 3793 3794

    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 已提交
3795 3796
        b->n--;
        b->in_flight--;
3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819

        /* 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 已提交
3820 3821 3822
    }

    while (b->n > b->in_flight && b->in_flight < b->nrreq) {
3823 3824 3825 3826 3827 3828 3829 3830
        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 已提交
3831
        if (b->write) {
3832
            acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
K
Kevin Wolf 已提交
3833
        } else {
3834
            acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
K
Kevin Wolf 已提交
3835
        }
K
Kevin Wolf 已提交
3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848
        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 已提交
3849
    bool is_write = false;
K
Kevin Wolf 已提交
3850 3851
    int count = 75000;
    int depth = 64;
3852
    int64_t offset = 0;
K
Kevin Wolf 已提交
3853
    size_t bufsize = 4096;
K
Kevin Wolf 已提交
3854
    int pattern = 0;
3855
    size_t step = 0;
3856 3857
    int flush_interval = 0;
    bool drain_on_flush = true;
K
Kevin Wolf 已提交
3858 3859 3860 3861
    int64_t image_size;
    BlockBackend *blk = NULL;
    BenchData data = {};
    int flags = 0;
3862
    bool writethrough = false;
K
Kevin Wolf 已提交
3863 3864
    struct timeval t1, t2;
    int i;
3865
    bool force_share = false;
F
Fam Zheng 已提交
3866
    size_t buf_size;
K
Kevin Wolf 已提交
3867 3868 3869 3870

    for (;;) {
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
3871
            {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
K
Kevin Wolf 已提交
3872
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
K
Kevin Wolf 已提交
3873
            {"pattern", required_argument, 0, OPTION_PATTERN},
3874
            {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
3875
            {"force-share", no_argument, 0, 'U'},
K
Kevin Wolf 已提交
3876 3877
            {0, 0, 0, 0}
        };
3878
        c = getopt_long(argc, argv, ":hc:d:f:no:qs:S:t:wU", long_options, NULL);
K
Kevin Wolf 已提交
3879 3880 3881 3882 3883
        if (c == -1) {
            break;
        }

        switch (c) {
3884 3885 3886
        case ':':
            missing_argument(argv[optind - 1]);
            break;
K
Kevin Wolf 已提交
3887
        case '?':
3888 3889 3890
            unrecognized_option(argv[optind - 1]);
            break;
        case 'h':
K
Kevin Wolf 已提交
3891 3892 3893 3894
            help();
            break;
        case 'c':
        {
3895 3896 3897
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
K
Kevin Wolf 已提交
3898 3899 3900
                error_report("Invalid request count specified");
                return 1;
            }
3901
            count = res;
K
Kevin Wolf 已提交
3902 3903 3904 3905
            break;
        }
        case 'd':
        {
3906 3907 3908
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
K
Kevin Wolf 已提交
3909 3910 3911
                error_report("Invalid queue depth specified");
                return 1;
            }
3912
            depth = res;
K
Kevin Wolf 已提交
3913 3914 3915 3916 3917 3918 3919 3920
            break;
        }
        case 'f':
            fmt = optarg;
            break;
        case 'n':
            flags |= BDRV_O_NATIVE_AIO;
            break;
3921 3922
        case 'o':
        {
3923 3924
            offset = cvtnum(optarg);
            if (offset < 0) {
3925 3926 3927 3928 3929 3930
                error_report("Invalid offset specified");
                return 1;
            }
            break;
        }
            break;
K
Kevin Wolf 已提交
3931 3932 3933 3934 3935 3936 3937
        case 'q':
            quiet = true;
            break;
        case 's':
        {
            int64_t sval;

3938 3939
            sval = cvtnum(optarg);
            if (sval < 0 || sval > INT_MAX) {
K
Kevin Wolf 已提交
3940 3941 3942 3943 3944 3945 3946
                error_report("Invalid buffer size specified");
                return 1;
            }

            bufsize = sval;
            break;
        }
3947 3948 3949 3950
        case 'S':
        {
            int64_t sval;

3951 3952
            sval = cvtnum(optarg);
            if (sval < 0 || sval > INT_MAX) {
3953 3954 3955 3956 3957 3958 3959
                error_report("Invalid step size specified");
                return 1;
            }

            step = sval;
            break;
        }
K
Kevin Wolf 已提交
3960 3961 3962 3963 3964 3965 3966 3967
        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 已提交
3968 3969 3970 3971
        case 'w':
            flags |= BDRV_O_RDWR;
            is_write = true;
            break;
3972 3973 3974
        case 'U':
            force_share = true;
            break;
K
Kevin Wolf 已提交
3975 3976
        case OPTION_PATTERN:
        {
3977 3978 3979
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
K
Kevin Wolf 已提交
3980 3981 3982
                error_report("Invalid pattern byte specified");
                return 1;
            }
3983
            pattern = res;
K
Kevin Wolf 已提交
3984 3985
            break;
        }
3986 3987
        case OPTION_FLUSH_INTERVAL:
        {
3988 3989 3990
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
3991 3992 3993
                error_report("Invalid flush interval specified");
                return 1;
            }
3994
            flush_interval = res;
3995 3996 3997 3998 3999
            break;
        }
        case OPTION_NO_DRAIN:
            drain_on_flush = false;
            break;
K
Kevin Wolf 已提交
4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
        }
    }

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

4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021
    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;
    }

4022 4023
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   force_share);
K
Kevin Wolf 已提交
4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035
    if (!blk) {
        ret = -1;
        goto out;
    }

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

    data = (BenchData) {
4036 4037 4038 4039 4040 4041 4042 4043 4044 4045
        .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 已提交
4046
    };
4047
    printf("Sending %d %s requests, %d bytes each, %d in parallel "
4048
           "(starting at offset %" PRId64 ", step size %d)\n",
4049
           data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
4050
           data.offset, data.step);
4051 4052 4053
    if (flush_interval) {
        printf("Sending flush every %d requests\n", flush_interval);
    }
K
Kevin Wolf 已提交
4054

F
Fam Zheng 已提交
4055 4056
    buf_size = data.nrreq * data.bufsize;
    data.buf = blk_blockalign(blk, buf_size);
K
Kevin Wolf 已提交
4057 4058
    memset(data.buf, pattern, data.nrreq * data.bufsize);

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

K
Kevin Wolf 已提交
4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080
    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 已提交
4081 4082 4083
    if (data.buf) {
        blk_unregister_buf(blk, data.buf);
    }
K
Kevin Wolf 已提交
4084 4085 4086 4087
    qemu_vfree(data.buf);
    blk_unref(blk);

    if (ret) {
R
Reda Sallahi 已提交
4088 4089 4090 4091 4092 4093 4094 4095 4096
        return 1;
    }
    return 0;
}

#define C_BS      01
#define C_COUNT   02
#define C_IF      04
#define C_OF      010
R
Reda Sallahi 已提交
4097
#define C_SKIP    020
R
Reda Sallahi 已提交
4098 4099 4100 4101 4102 4103 4104 4105 4106 4107

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

struct DdIo {
    int bsz;    /* Block size */
    char *filename;
    uint8_t *buf;
R
Reda Sallahi 已提交
4108
    int64_t offset;
R
Reda Sallahi 已提交
4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122
};

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;

4123
    res = cvtnum(arg);
R
Reda Sallahi 已提交
4124

4125
    if (res <= 0 || res > INT_MAX) {
R
Reda Sallahi 已提交
4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137
        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)
{
4138
    dd->count = cvtnum(arg);
R
Reda Sallahi 已提交
4139

4140
    if (dd->count < 0) {
R
Reda Sallahi 已提交
4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165
        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 已提交
4166 4167 4168 4169
static int img_dd_skip(const char *arg,
                       struct DdIo *in, struct DdIo *out,
                       struct DdInfo *dd)
{
4170
    in->offset = cvtnum(arg);
R
Reda Sallahi 已提交
4171

4172
    if (in->offset < 0) {
R
Reda Sallahi 已提交
4173 4174 4175 4176 4177 4178 4179
        error_report("invalid number: '%s'", arg);
        return 1;
    }

    return 0;
}

R
Reda Sallahi 已提交
4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195
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;
4196
    bool force_share = false;
R
Reda Sallahi 已提交
4197 4198 4199 4200 4201 4202 4203
    struct DdInfo dd = {
        .flags = 0,
        .count = 0,
    };
    struct DdIo in = {
        .bsz = 512, /* Block size is by default 512 bytes */
        .filename = NULL,
R
Reda Sallahi 已提交
4204 4205
        .buf = NULL,
        .offset = 0
R
Reda Sallahi 已提交
4206 4207 4208 4209
    };
    struct DdIo out = {
        .bsz = 512,
        .filename = NULL,
R
Reda Sallahi 已提交
4210 4211
        .buf = NULL,
        .offset = 0
R
Reda Sallahi 已提交
4212 4213 4214 4215 4216 4217 4218
    };

    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 已提交
4219
        { "skip", img_dd_skip, C_SKIP },
R
Reda Sallahi 已提交
4220 4221 4222 4223
        { NULL, NULL, 0 }
    };
    const struct option long_options[] = {
        { "help", no_argument, 0, 'h'},
4224
        { "object", required_argument, 0, OPTION_OBJECT},
R
Reda Sallahi 已提交
4225
        { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4226
        { "force-share", no_argument, 0, 'U'},
R
Reda Sallahi 已提交
4227 4228 4229
        { 0, 0, 0, 0 }
    };

4230
    while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
R
Reda Sallahi 已提交
4231 4232 4233 4234 4235 4236 4237 4238 4239 4240
        if (c == EOF) {
            break;
        }
        switch (c) {
        case 'O':
            out_fmt = optarg;
            break;
        case 'f':
            fmt = optarg;
            break;
4241 4242 4243
        case ':':
            missing_argument(argv[optind - 1]);
            break;
R
Reda Sallahi 已提交
4244
        case '?':
4245 4246
            unrecognized_option(argv[optind - 1]);
            break;
R
Reda Sallahi 已提交
4247 4248 4249
        case 'h':
            help();
            break;
4250 4251 4252
        case 'U':
            force_share = true;
            break;
4253 4254
        case OPTION_OBJECT:
            if (!qemu_opts_parse_noisily(&qemu_object_opts, optarg, true)) {
4255 4256 4257
                ret = -1;
                goto out;
            }
4258
            break;
R
Reda Sallahi 已提交
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302
        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;
    }
4303 4304 4305 4306 4307 4308 4309 4310

    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
                          NULL, NULL)) {
        ret = -1;
        goto out;
    }

4311 4312
    blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
                    force_share);
R
Reda Sallahi 已提交
4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360

    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 已提交
4361 4362 4363 4364 4365 4366 4367 4368
    /* 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 已提交
4369 4370 4371 4372 4373 4374 4375 4376 4377 4378

    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;
    }

4379 4380 4381 4382 4383
    /* 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.
     */
4384
    blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
4385
                         false, false, false);
R
Reda Sallahi 已提交
4386 4387 4388 4389 4390 4391

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

R
Reda Sallahi 已提交
4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402
    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 已提交
4403 4404
    in.buf = g_new(uint8_t, in.bsz);

R
Reda Sallahi 已提交
4405
    for (out_pos = 0; in_pos < size; block_count++) {
R
Reda Sallahi 已提交
4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443
        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 已提交
4444 4445 4446 4447 4448
        return 1;
    }
    return 0;
}

4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 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 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 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 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 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 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681
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));
    qobject_decref(obj);
    visit_free(v);
    QDECREF(str);
}

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,
                          NULL, NULL)) {
        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 已提交
4682

A
Anthony Liguori 已提交
4683
static const img_cmd_t img_cmds[] = {
4684 4685 4686 4687 4688 4689 4690 4691
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
    { NULL, NULL, },
};

B
bellard 已提交
4692 4693
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
4694
    const img_cmd_t *cmd;
4695
    const char *cmdname;
4696
    Error *local_error = NULL;
4697
    char *trace_file = NULL;
4698 4699 4700
    int c;
    static const struct option long_options[] = {
        {"help", no_argument, 0, 'h'},
4701
        {"version", no_argument, 0, 'V'},
4702
        {"trace", required_argument, NULL, 'T'},
4703 4704
        {0, 0, 0, 0}
    };
B
bellard 已提交
4705

4706 4707 4708 4709
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

4710
    module_call_init(MODULE_INIT_TRACE);
K
Kevin Wolf 已提交
4711
    error_set_progname(argv[0]);
4712
    qemu_init_exec_dir(argv[0]);
K
Kevin Wolf 已提交
4713

4714
    if (qemu_init_main_loop(&local_error)) {
4715
        error_report_err(local_error);
4716 4717 4718
        exit(EXIT_FAILURE);
    }

4719
    qcrypto_init(&error_fatal);
4720

4721
    module_call_init(MODULE_INIT_QOM);
B
bellard 已提交
4722
    bdrv_init();
F
Fam Zheng 已提交
4723 4724 4725
    if (argc < 2) {
        error_exit("Not enough arguments");
    }
4726

4727
    qemu_add_opts(&qemu_object_opts);
4728
    qemu_add_opts(&qemu_source_opts);
4729
    qemu_add_opts(&qemu_trace_opts);
4730

4731
    while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
4732
        switch (c) {
4733 4734 4735
        case ':':
            missing_argument(argv[optind - 1]);
            return 0;
4736
        case '?':
4737 4738 4739
            unrecognized_option(argv[optind - 1]);
            return 0;
        case 'h':
4740 4741 4742 4743 4744
            help();
            return 0;
        case 'V':
            printf(QEMU_IMG_VERSION);
            return 0;
4745 4746 4747 4748
        case 'T':
            g_free(trace_file);
            trace_file = trace_opt_parse(optarg);
            break;
4749
        }
B
bellard 已提交
4750
    }
4751

4752
    cmdname = argv[optind];
4753

4754 4755 4756
    /* reset getopt_long scanning */
    argc -= optind;
    if (argc < 1) {
4757 4758
        return 0;
    }
4759
    argv += optind;
D
Denis V. Lunev 已提交
4760
    optind = 0;
4761

4762 4763 4764 4765 4766 4767
    if (!trace_init_backends()) {
        exit(1);
    }
    trace_init_file(trace_file);
    qemu_set_log(LOG_TRACE);

4768 4769 4770 4771 4772 4773
    /* find the command */
    for (cmd = img_cmds; cmd->name != NULL; cmd++) {
        if (!strcmp(cmdname, cmd->name)) {
            return cmd->handler(argc, argv);
        }
    }
4774

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