qemu-img.c 137.3 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.
 */
P
Peter Maydell 已提交
24
#include "qemu/osdep.h"
25 26
#include <getopt.h>

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

47
#define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
48
                          "\n" QEMU_COPYRIGHT "\n"
49

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

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

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

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

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

F
Fam Zheng 已提交
82 83 84 85 86 87 88 89 90 91 92 93 94 95
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);
}

96 97 98 99 100 101 102 103 104 105
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 已提交
106
/* Please keep in synch with qemu-img.texi */
F
Fam Zheng 已提交
107
static void QEMU_NORETURN help(void)
B
bellard 已提交
108
{
109
    const char *help_msg =
110
           QEMU_IMG_VERSION
111
           "usage: qemu-img [standard options] command [command options]\n"
112 113
           "QEMU disk image utility\n"
           "\n"
114 115
           "    '-h', '--help'       display this help and exit\n"
           "    '-V', '--version'    output version information and exit\n"
116 117
           "    '-T', '--trace'      [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
           "                         specify tracing options\n"
118
           "\n"
119
           "Command syntax:\n"
120 121 122 123 124
#define DEF(option, callback, arg_string)        \
           "  " arg_string "\n"
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
125 126 127
           "\n"
           "Command parameters:\n"
           "  'filename' is a disk image filename\n"
128 129 130 131
           "  '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"
132
           "  'fmt' is the disk image format. It is guessed automatically in most cases\n"
133
           "  'cache' is the cache mode used to write the output disk image, the valid\n"
134 135
           "    options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
           "    'directsync' and 'unsafe' (default for convert)\n"
136 137
           "  '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"
138
           "  'size' is the disk image size in bytes. Optional suffixes\n"
139 140 141
           "    '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"
142 143 144 145 146
           "  '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"
147 148 149 150 151
           "  '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"
152
           "  '-c' indicates that target image must be compressed (qcow format only)\n"
153 154 155 156 157
           "  '-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"
158
           "  '-h' with or without a command shows this help and lists the supported formats\n"
159
           "  '-p' show progress of command (only certain commands)\n"
160
           "  '-q' use Quiet mode - do not print any output (except errors)\n"
161 162 163 164 165
           "  '-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"
166
           "  '--output' takes the format in which the output must be done (human or json)\n"
167 168
           "  '-n' skips the target volume creation (useful if the volume is created\n"
           "       prior to running qemu-img)\n"
169
           "\n"
170 171 172 173
           "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"
174
           "       hiding corruption that has already occurred.\n"
175
           "\n"
P
Peter Lieven 已提交
176 177 178 179 180
           "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"
181 182 183 184 185
           "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"
186 187 188 189 190
           "  '-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 已提交
191 192 193 194 195 196 197
           "  '-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 已提交
198 199
           "  'of=FILE' write to FILE\n"
           "  'skip=N' skip N bs-sized blocks at the start of input\n";
200 201

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

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

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

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

B
bellard 已提交
237

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

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

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

262 263
    qemu_opts_print_help(create_opts);
    qemu_opts_free(create_opts);
264 265 266
    return 0;
}

267

268
static BlockBackend *img_open_opts(const char *optstr,
269
                                   QemuOpts *opts, int flags, bool writethrough,
270
                                   bool quiet, bool force_share)
271 272 273 274 275
{
    QDict *options;
    Error *local_err = NULL;
    BlockBackend *blk;
    options = qemu_opts_to_qdict(opts, NULL);
276 277 278 279
    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");
280
            QDECREF(options);
281 282
            return NULL;
        }
283
        qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
284
    }
285
    blk = blk_new_open(NULL, NULL, options, flags, &local_err);
286
    if (!blk) {
287
        error_reportf_err(local_err, "Could not open '%s': ", optstr);
288 289
        return NULL;
    }
290
    blk_set_enable_write_cache(blk, !writethrough);
291 292 293 294

    return blk;
}

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

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

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

321 322 323 324
    return blk;
}


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

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


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

380

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

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

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

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

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

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

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

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

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

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

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

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

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

fail:
    g_free(options);
    return 1;
B
bellard 已提交
549 550
}

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

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

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

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

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

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

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

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

    return 0;
}

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

    fmt = NULL;
674
    output = NULL;
675
    cache = BDRV_DEFAULT_CACHE;
676

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

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

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

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

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

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
779 780

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

786 787
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
788

789 790
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
791

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

802
        ret = collect_image_check(bs, check, filename, fmt, 0);
803

804 805
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
806 807
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

done:
1053 1054
    qemu_progress_end();

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

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

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

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

1088 1089 1090 1091 1092 1093 1094
/*
 * Returns true iff the first sector pointed to by 'buf' contains at least
 * a non-NUL byte.
 *
 * 'pnum' is set to the number of sectors (including and immediately following
 * the first one) that are known to be in the same allocated/unallocated state.
 */
B
bellard 已提交
1095 1096
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
{
1097 1098
    bool is_zero;
    int i;
B
bellard 已提交
1099 1100 1101 1102 1103

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

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

1170
    assert(bytes > 0);
K
Kevin Wolf 已提交
1171

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

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

    *pnum = i;
    return res;
}

1186
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
1187

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

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

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

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


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

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

1333 1334 1335
    /* Initialize before goto out */
    qemu_progress_init(progress, 2.0);

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

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

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

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

    qemu_progress_print(0, 100);

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

1387
    while (offset < total_size) {
1388
        int status1, status2;
1389

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

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

        assert(pnum1 && pnum2);
1411
        chunk = MIN(pnum1, pnum2);
1412

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

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

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

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

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

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

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

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

1521 1522 1523 1524 1525 1526
enum ImgConvertBlockStatus {
    BLK_DATA,
    BLK_ZERO,
    BLK_BACKING_FILE,
};

P
Peter Lieven 已提交
1527 1528
#define MAX_COROUTINES 16

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

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

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

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

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

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

1581
        if (s->target_has_backing) {
1582 1583 1584 1585 1586

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

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

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

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

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

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

    return 0;
}

P
Peter Lieven 已提交
1669 1670 1671 1672

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

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

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

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

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

    return 0;
}

P
Peter Lieven 已提交
1738
static void coroutine_fn convert_co_do_copy(void *opaque)
1739
{
P
Peter Lieven 已提交
1740
    ImgConvertState *s = opaque;
1741
    uint8_t *buf = NULL;
P
Peter Lieven 已提交
1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
    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);
1764
            break;
P
Peter Lieven 已提交
1765 1766 1767 1768 1769
        }
        n = convert_iteration_sectors(s, s->sector_num);
        if (n < 0) {
            qemu_co_mutex_unlock(&s->lock);
            s->ret = n;
1770
            break;
P
Peter Lieven 已提交
1771 1772 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
        }
        /* 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 */
1803
            while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
P
Peter Lieven 已提交
1804 1805 1806 1807 1808 1809
                s->wait_sector_num[index] = sector_num;
                qemu_coroutine_yield();
            }
            s->wait_sector_num[index] = -1;
        }

1810 1811 1812 1813 1814 1815 1816
        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 已提交
1817 1818 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
        }

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

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

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

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

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

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

P
Peter Lieven 已提交
1910
    return s->ret;
1911 1912
}

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

    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 已提交
1938 1939

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

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

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

2064 2065 2066 2067
    if (!out_fmt && !tgt_image_opts) {
        out_fmt = "raw";
    }

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

2217 2218 2219 2220 2221 2222 2223
    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;
    }

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

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

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

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

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

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

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

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

2297
    /* increase bufsectors from the default 4096 (2M) if opt_transfer
2298 2299
     * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
     * as maximum. */
P
Peter Lieven 已提交
2300 2301 2302 2303 2304
    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)));
2305

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

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

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

P
Peter Lieven 已提交
2351
    return !!ret;
B
bellard 已提交
2352 2353
}

B
bellard 已提交
2354

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2612
    qapi_free_ImageInfoList(list);
B
bellard 已提交
2613 2614 2615
    return 0;
}

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

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

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

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

        depth++;
    }

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

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

P
Paolo Bonzini 已提交
2705 2706 2707
    return 0;
}

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

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

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

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

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

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

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

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

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

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

2854 2855 2856 2857 2858
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

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

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

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

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

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

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

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

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

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

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

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

3103 3104 3105 3106
    if (quiet) {
        progress = 0;
    }

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

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

3121 3122 3123
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3263 3264 3265
        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 已提交
3266 3267

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    size = argv[--argc];

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

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

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

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

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

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

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

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

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

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

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

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

        switch (c) {
3608 3609 3610
        case ':':
            missing_argument(argv[optind - 1]);
            break;
3611
        case '?':
3612 3613 3614
            unrecognized_option(argv[optind - 1]);
            break;
        case 'h':
3615 3616 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
            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 已提交
3654 3655 3656
        }
    }

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

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

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

3673 3674 3675 3676 3677 3678
    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 已提交
3679 3680
    }

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

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

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

    fmt = bs->drv->format_name;

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

3710 3711 3712 3713 3714 3715 3716
    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 已提交
3717
    create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3718
    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
P
Paolo Bonzini 已提交
3719 3720 3721 3722 3723
    qemu_opts_do_parse(opts, options, NULL, &err);
    if (err) {
        error_report_err(err);
        ret = -1;
        goto out;
M
Max Reitz 已提交
3724 3725
    }

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

out:
3736 3737
    qemu_progress_end();

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

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

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

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

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

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

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

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

        /* 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 已提交
3818 3819 3820
    }

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

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

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

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

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

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

            bufsize = sval;
            break;
        }
3945 3946 3947 3948
        case 'S':
        {
            int64_t sval;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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;

4121
    res = cvtnum(arg);
R
Reda Sallahi 已提交
4122

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

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

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

    return 0;
}

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

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

4228
    while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
R
Reda Sallahi 已提交
4229 4230 4231 4232 4233 4234 4235 4236 4237 4238
        if (c == EOF) {
            break;
        }
        switch (c) {
        case 'O':
            out_fmt = optarg;
            break;
        case 'f':
            fmt = optarg;
            break;
4239 4240 4241
        case ':':
            missing_argument(argv[optind - 1]);
            break;
R
Reda Sallahi 已提交
4242
        case '?':
4243 4244
            unrecognized_option(argv[optind - 1]);
            break;
R
Reda Sallahi 已提交
4245 4246 4247
        case 'h':
            help();
            break;
4248 4249 4250
        case 'U':
            force_share = true;
            break;
4251 4252
        case OPTION_OBJECT:
            if (!qemu_opts_parse_noisily(&qemu_object_opts, optarg, true)) {
4253 4254 4255
                ret = -1;
                goto out;
            }
4256
            break;
R
Reda Sallahi 已提交
4257 4258 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
        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;
    }
4301 4302 4303 4304 4305 4306 4307 4308

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

4309 4310
    blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
                    force_share);
R
Reda Sallahi 已提交
4311 4312 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

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

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

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

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

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

R
Reda Sallahi 已提交
4403
    for (out_pos = 0; in_pos < size; block_count++) {
R
Reda Sallahi 已提交
4404 4405 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
        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 已提交
4442 4443 4444 4445 4446
        return 1;
    }
    return 0;
}

4447 4448 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
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 已提交
4680

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

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

4704 4705 4706 4707
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

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

4712
    if (qemu_init_main_loop(&local_error)) {
4713
        error_report_err(local_error);
4714 4715 4716
        exit(EXIT_FAILURE);
    }

4717
    qcrypto_init(&error_fatal);
4718

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

4725
    qemu_add_opts(&qemu_object_opts);
4726
    qemu_add_opts(&qemu_source_opts);
4727
    qemu_add_opts(&qemu_trace_opts);
4728

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

4750
    cmdname = argv[optind];
4751

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

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

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

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