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

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

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

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

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

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

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

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

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

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

    error_printf("qemu-img: ");

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

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

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

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

B
blueswir1 已提交
108
/* Please keep in synch with qemu-img.texi */
F
Fam Zheng 已提交
109
static void QEMU_NORETURN help(void)
B
bellard 已提交
110
{
111
    const char *help_msg =
112
           QEMU_IMG_VERSION
113
           "usage: qemu-img [standard options] command [command options]\n"
114 115
           "QEMU disk image utility\n"
           "\n"
116 117
           "    '-h', '--help'       display this help and exit\n"
           "    '-V', '--version'    output version information and exit\n"
118 119
           "    '-T', '--trace'      [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
           "                         specify tracing options\n"
120
           "\n"
121
           "Command syntax:\n"
122 123 124 125
#define DEF(option, callback, arg_string)        \
           "  " arg_string "\n"
#include "qemu-img-cmds.h"
#undef DEF
126 127 128
           "\n"
           "Command parameters:\n"
           "  'filename' is a disk image filename\n"
129 130 131 132
           "  'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
           "    manual page for a description of the object properties. The most common\n"
           "    object type is a 'secret', which is used to supply passwords and/or\n"
           "    encryption keys.\n"
133
           "  'fmt' is the disk image format. It is guessed automatically in most cases\n"
134
           "  'cache' is the cache mode used to write the output disk image, the valid\n"
135 136
           "    options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
           "    'directsync' and 'unsafe' (default for convert)\n"
137 138
           "  'src_cache' is the cache mode used to read input disk images, the valid\n"
           "    options are the same as for the 'cache' option\n"
139
           "  'size' is the disk image size in bytes. Optional suffixes\n"
140 141 142
           "    'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
           "    'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P)  are\n"
           "    supported. 'b' is ignored.\n"
143 144 145 146 147
           "  'output_filename' is the destination disk image filename\n"
           "  'output_fmt' is the destination format\n"
           "  'options' is a comma separated list of format specific options in a\n"
           "    name=value format. Use -o ? for an overview of the options supported by the\n"
           "    used format\n"
148 149 150 151 152
           "  '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"
153
           "  '-c' indicates that target image must be compressed (qcow format only)\n"
154 155 156 157 158
           "  '-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"
159
           "  '-h' with or without a command shows this help and lists the supported formats\n"
160
           "  '-p' show progress of command (only certain commands)\n"
161
           "  '-q' use Quiet mode - do not print any output (except errors)\n"
162 163 164 165 166
           "  '-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"
167
           "  '--output' takes the format in which the output must be done (human or json)\n"
168 169
           "  '-n' skips the target volume creation (useful if the volume is created\n"
           "       prior to running qemu-img)\n"
170
           "\n"
171 172 173 174
           "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"
175
           "       hiding corruption that has already occurred.\n"
176
           "\n"
P
Peter Lieven 已提交
177 178 179 180 181
           "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"
182 183 184 185 186
           "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"
187 188 189 190 191
           "  '-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 已提交
192 193 194 195 196 197 198
           "  '-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 已提交
199 200
           "  'of=FILE' write to FILE\n"
           "  'skip=N' skip N bs-sized blocks at the start of input\n";
201 202

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

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

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

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

B
bellard 已提交
238

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

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

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

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

268

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

    return blk;
}

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

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

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

322 323 324 325
    return blk;
}


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

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


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

381

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    return 0;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

875
    if (!job_is_completed(&job->job)) {
876
        ret = job_complete_sync(&job->job, errp);
877
    } else {
878
        ret = job->job.ret;
879
    }
K
Kevin Wolf 已提交
880
    job_unref(&job->job);
881
    aio_context_release(aio_context);
882

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

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

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

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

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

972 973
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
974
                          NULL, NULL)) {
975 976 977
        return 1;
    }

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

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

992 993 994
    qemu_progress_init(progress, 1.f);
    qemu_progress_print(0.f, 100);

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

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

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

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

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

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

unref_backing:
    if (!drop) {
1054
        bdrv_unref(bs);
M
Max Reitz 已提交
1055
    }
M
Max Reitz 已提交
1056 1057

done:
1058 1059
    qemu_progress_end();

M
Markus Armbruster 已提交
1060
    blk_unref(blk);
M
Max Reitz 已提交
1061 1062

    if (local_err) {
1063
        error_report_err(local_err);
1064 1065
        return 1;
    }
M
Max Reitz 已提交
1066 1067

    qprintf(quiet, "Image committed.\n");
B
bellard 已提交
1068 1069 1070
    return 0;
}

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

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

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

1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
/*
 * 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 已提交
1162
/*
1163 1164
 * Compares two buffers sector by sector. Returns 0 if the first
 * sector of each buffer matches, non-zero otherwise.
K
Kevin Wolf 已提交
1165
 *
1166 1167
 * 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 已提交
1168
 */
1169 1170
static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
                           int64_t bytes, int64_t *pnum)
K
Kevin Wolf 已提交
1171
{
1172
    bool res;
1173
    int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
K
Kevin Wolf 已提交
1174

1175
    assert(bytes > 0);
K
Kevin Wolf 已提交
1176

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

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

    *pnum = i;
    return res;
}

1191
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
1192

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

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

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

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


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

1331 1332
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
1333
                          NULL, NULL)) {
1334 1335 1336 1337
        ret = 2;
        goto out4;
    }

1338 1339 1340
    /* Initialize before goto out */
    qemu_progress_init(progress, 2.0);

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

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

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

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

    qemu_progress_print(0, 100);

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

1392
    while (offset < total_size) {
1393
        int status1, status2;
1394

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

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

        assert(pnum1 && pnum2);
1416
        chunk = MIN(pnum1, pnum2);
1417

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

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

1474
    if (total_size1 != total_size2) {
1475
        BlockBackend *blk_over;
1476 1477 1478
        const char *filename_over;

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

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

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

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

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

1526 1527 1528 1529 1530 1531
enum ImgConvertBlockStatus {
    BLK_DATA,
    BLK_ZERO,
    BLK_BACKING_FILE,
};

P
Peter Lieven 已提交
1532 1533
#define MAX_COROUTINES 16

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

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

static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
{
1575 1576
    int64_t src_cur_offset;
    int ret, n, src_cur;
1577

P
Peter Lieven 已提交
1578
    convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1579 1580 1581 1582 1583

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

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

1586
        if (s->target_has_backing) {
1587 1588 1589 1590 1591

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

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

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

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

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

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

    return 0;
}

P
Peter Lieven 已提交
1674 1675 1676 1677

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

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

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

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

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

    return 0;
}

P
Peter Lieven 已提交
1743
static void coroutine_fn convert_co_do_copy(void *opaque)
1744
{
P
Peter Lieven 已提交
1745
    ImgConvertState *s = opaque;
1746
    uint8_t *buf = NULL;
P
Peter Lieven 已提交
1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768
    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);
1769
            break;
P
Peter Lieven 已提交
1770 1771 1772 1773 1774
        }
        n = convert_iteration_sectors(s, s->sector_num);
        if (n < 0) {
            qemu_co_mutex_unlock(&s->lock);
            s->ret = n;
1775
            break;
P
Peter Lieven 已提交
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807
        }
        /* 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 */
1808
            while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
P
Peter Lieven 已提交
1809 1810 1811 1812 1813 1814
                s->wait_sector_num[index] = sector_num;
                qemu_coroutine_yield();
            }
            s->wait_sector_num[index] = -1;
        }

1815 1816 1817 1818 1819 1820 1821
        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 已提交
1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854
        }

        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;
1855 1856 1857 1858 1859 1860 1861 1862 1863

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

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

P
Peter Lieven 已提交
1896 1897 1898 1899 1900 1901
    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]);
    }
1902

1903
    while (s->running_coroutines) {
P
Peter Lieven 已提交
1904
        main_loop_wait(false);
1905 1906
    }

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

P
Peter Lieven 已提交
1915
    return s->ret;
1916 1917
}

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

    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 已提交
1943 1944

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

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

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

2069 2070 2071 2072
    if (!out_fmt && !tgt_image_opts) {
        out_fmt = "raw";
    }

2073 2074
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2075
                          NULL, NULL)) {
2076 2077 2078
        goto fail_getopt;
    }

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

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

P
Peter Lieven 已提交
2089 2090
    s.src_num = argc - optind - 1;
    out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2091

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

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


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

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

P
Peter Lieven 已提交
2122 2123
    s.src = g_new0(BlockBackend *, s.src_num);
    s.src_sectors = g_new(int64_t, s.src_num);
2124

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

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

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

2164 2165 2166 2167 2168 2169 2170 2171
    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;
        }
2172

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

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

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

M
Max Reitz 已提交
2194 2195
        create_opts = qemu_opts_append(create_opts, drv->create_opts);
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2196

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

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

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

2222 2223 2224 2225 2226 2227 2228
    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;
    }

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

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

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

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

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

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

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

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

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

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

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

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

P
Peter Lieven 已提交
2356
    return !!ret;
B
bellard 已提交
2357 2358
}

B
bellard 已提交
2359

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

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

    visit_type_ImageInfoList(v, NULL, &list, &error_abort);
    visit_complete(v, &obj);
2387 2388 2389
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
2390
    qobject_unref(obj);
2391
    visit_free(v);
2392
    qobject_unref(str);
2393 2394
}

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

    visit_type_ImageInfo(v, NULL, &info, &error_abort);
    visit_complete(v, &obj);
2403 2404 2405
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
2406
    qobject_unref(obj);
2407
    visit_free(v);
2408
    qobject_unref(str);
2409 2410
}

2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421
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;

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

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

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

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

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

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

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

M
Markus Armbruster 已提交
2488
        blk_unref(blk);
2489 2490 2491 2492 2493 2494

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

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

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

2583 2584 2585 2586 2587 2588
    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.");
2589 2590
        return 1;
    }
2591

2592 2593
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2594
                          NULL, NULL)) {
2595 2596 2597
        return 1;
    }

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

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

2617
    qapi_free_ImageInfoList(list);
B
bellard 已提交
2618 2619 2620
    return 0;
}

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

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

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

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

        depth++;
    }

J
John Snow 已提交
2696 2697 2698
    has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);

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

P
Paolo Bonzini 已提交
2710 2711 2712
    return 0;
}

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

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

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

2811 2812
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2813
                          NULL, NULL)) {
2814 2815 2816
        return 1;
    }

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

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

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

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

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

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

2859 2860 2861 2862 2863
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

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

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

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

2960 2961
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2962
                          NULL, NULL)) {
2963 2964 2965
        return 1;
    }

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

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

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

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

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

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

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

3108 3109 3110 3111
    if (quiet) {
        progress = 0;
    }

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

3120 3121
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3122
                          NULL, NULL)) {
3123 3124 3125
        return 1;
    }

3126 3127 3128
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

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

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

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

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

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

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

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

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

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

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

3234 3235
        buf_old = blk_blockalign(blk, IO_BUF_SIZE);
        buf_new = blk_blockalign(blk, IO_BUF_SIZE);
K
Kevin Wolf 已提交
3236

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

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

3264 3265
        if (size != 0) {
            local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
3266 3267
        }

3268 3269 3270
        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 已提交
3271 3272

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

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

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

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

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

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

3318
            while (written < n) {
3319
                int64_t pnum;
K
Kevin Wolf 已提交
3320

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

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

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

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

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

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

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

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

    size = argv[--argc];

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

3479 3480
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3481
                          NULL, NULL)) {
3482 3483 3484
        return 1;
    }

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

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

3520 3521 3522 3523 3524 3525 3526 3527
    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;
    }

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

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

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

3562
    ret = blk_truncate(blk, total_size, prealloc, &err);
M
Max Reitz 已提交
3563
    if (ret < 0) {
3564
        error_report_err(err);
M
Max Reitz 已提交
3565 3566 3567 3568 3569 3570 3571 3572 3573
        goto out;
    }

    new_size = blk_getlength(blk);
    if (new_size < 0) {
        error_report("Failed to verify truncated image length: %s",
                     strerror(-new_size));
        ret = -1;
        goto out;
3574
    }
M
Max Reitz 已提交
3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598

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

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

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

3599
out:
M
Markus Armbruster 已提交
3600
    blk_unref(blk);
3601 3602 3603
    if (ret) {
        return 1;
    }
3604 3605 3606
    return 0;
}

3607
static void amend_status_cb(BlockDriverState *bs,
3608 3609
                            int64_t offset, int64_t total_work_size,
                            void *opaque)
3610 3611 3612 3613
{
    qemu_progress_print(100.f * offset / total_work_size, 0);
}

M
Max Reitz 已提交
3614 3615
static int img_amend(int argc, char **argv)
{
3616
    Error *err = NULL;
M
Max Reitz 已提交
3617 3618
    int c, ret = 0;
    char *options = NULL;
3619 3620
    QemuOptsList *create_opts = NULL;
    QemuOpts *opts = NULL;
3621 3622
    const char *fmt = NULL, *filename, *cache;
    int flags;
3623
    bool writethrough;
3624
    bool quiet = false, progress = false;
M
Markus Armbruster 已提交
3625
    BlockBackend *blk = NULL;
M
Max Reitz 已提交
3626
    BlockDriverState *bs = NULL;
3627
    bool image_opts = false;
M
Max Reitz 已提交
3628

3629
    cache = BDRV_DEFAULT_CACHE;
M
Max Reitz 已提交
3630
    for (;;) {
3631 3632 3633
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3634
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3635 3636
            {0, 0, 0, 0}
        };
3637
        c = getopt_long(argc, argv, ":ho:f:t:pq",
3638
                        long_options, NULL);
M
Max Reitz 已提交
3639 3640 3641 3642 3643
        if (c == -1) {
            break;
        }

        switch (c) {
3644 3645 3646
        case ':':
            missing_argument(argv[optind - 1]);
            break;
3647
        case '?':
3648 3649 3650
            unrecognized_option(argv[optind - 1]);
            break;
        case 'h':
3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689
            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 已提交
3690 3691 3692
        }
    }

3693
    if (!options) {
F
Fam Zheng 已提交
3694
        error_exit("Must specify options (-o)");
M
Max Reitz 已提交
3695 3696
    }

3697 3698
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3699
                          NULL, NULL)) {
3700 3701 3702 3703
        ret = -1;
        goto out_no_progress;
    }

3704 3705 3706 3707 3708
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);

3709 3710 3711 3712 3713 3714
    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 已提交
3715 3716
    }

3717
    if (optind != argc - 1) {
M
Max Reitz 已提交
3718 3719 3720
        error_report("Expecting one image file name");
        ret = -1;
        goto out;
3721
    }
M
Max Reitz 已提交
3722

3723 3724
    flags = BDRV_O_RDWR;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3725 3726 3727 3728 3729
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        goto out;
    }

3730 3731
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   false);
3732
    if (!blk) {
M
Max Reitz 已提交
3733 3734 3735
        ret = -1;
        goto out;
    }
3736
    bs = blk_bs(blk);
M
Max Reitz 已提交
3737 3738 3739

    fmt = bs->drv->format_name;

3740
    if (has_help_option(options)) {
3741
        /* If the format was auto-detected, print option help here */
M
Max Reitz 已提交
3742 3743 3744 3745
        ret = print_block_option_help(filename, fmt);
        goto out;
    }

3746 3747 3748 3749 3750 3751 3752
    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 已提交
3753
    create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3754
    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
P
Paolo Bonzini 已提交
3755 3756 3757 3758 3759
    qemu_opts_do_parse(opts, options, NULL, &err);
    if (err) {
        error_report_err(err);
        ret = -1;
        goto out;
M
Max Reitz 已提交
3760 3761
    }

3762 3763
    /* In case the driver does not call amend_status_cb() */
    qemu_progress_print(0.f, 0);
3764
    ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
3765
    qemu_progress_print(100.f, 0);
M
Max Reitz 已提交
3766 3767 3768 3769 3770 3771
    if (ret < 0) {
        error_report("Error while amending options: %s", strerror(-ret));
        goto out;
    }

out:
3772 3773
    qemu_progress_end();

3774
out_no_progress:
M
Markus Armbruster 已提交
3775
    blk_unref(blk);
3776 3777
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
3778 3779
    g_free(options);

M
Max Reitz 已提交
3780 3781 3782 3783 3784 3785
    if (ret) {
        return 1;
    }
    return 0;
}

K
Kevin Wolf 已提交
3786 3787 3788
typedef struct BenchData {
    BlockBackend *blk;
    uint64_t image_size;
K
Kevin Wolf 已提交
3789
    bool write;
K
Kevin Wolf 已提交
3790
    int bufsize;
3791
    int step;
K
Kevin Wolf 已提交
3792 3793
    int nrreq;
    int n;
3794 3795
    int flush_interval;
    bool drain_on_flush;
K
Kevin Wolf 已提交
3796 3797 3798 3799
    uint8_t *buf;
    QEMUIOVector *qiov;

    int in_flight;
3800
    bool in_flush;
K
Kevin Wolf 已提交
3801 3802 3803
    uint64_t offset;
} BenchData;

3804 3805 3806
static void bench_undrained_flush_cb(void *opaque, int ret)
{
    if (ret < 0) {
3807
        error_report("Failed flush request: %s", strerror(-ret));
3808 3809 3810 3811
        exit(EXIT_FAILURE);
    }
}

K
Kevin Wolf 已提交
3812 3813 3814 3815 3816 3817
static void bench_cb(void *opaque, int ret)
{
    BenchData *b = opaque;
    BlockAIOCB *acb;

    if (ret < 0) {
3818
        error_report("Failed request: %s", strerror(-ret));
K
Kevin Wolf 已提交
3819 3820
        exit(EXIT_FAILURE);
    }
3821 3822 3823 3824 3825 3826 3827 3828

    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 已提交
3829 3830
        b->n--;
        b->in_flight--;
3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853

        /* 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 已提交
3854 3855 3856
    }

    while (b->n > b->in_flight && b->in_flight < b->nrreq) {
3857 3858 3859 3860 3861 3862 3863 3864
        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 已提交
3865
        if (b->write) {
3866
            acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
K
Kevin Wolf 已提交
3867
        } else {
3868
            acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
K
Kevin Wolf 已提交
3869
        }
K
Kevin Wolf 已提交
3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882
        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 已提交
3883
    bool is_write = false;
K
Kevin Wolf 已提交
3884 3885
    int count = 75000;
    int depth = 64;
3886
    int64_t offset = 0;
K
Kevin Wolf 已提交
3887
    size_t bufsize = 4096;
K
Kevin Wolf 已提交
3888
    int pattern = 0;
3889
    size_t step = 0;
3890 3891
    int flush_interval = 0;
    bool drain_on_flush = true;
K
Kevin Wolf 已提交
3892 3893 3894 3895
    int64_t image_size;
    BlockBackend *blk = NULL;
    BenchData data = {};
    int flags = 0;
3896
    bool writethrough = false;
K
Kevin Wolf 已提交
3897 3898
    struct timeval t1, t2;
    int i;
3899
    bool force_share = false;
F
Fam Zheng 已提交
3900
    size_t buf_size;
K
Kevin Wolf 已提交
3901 3902 3903 3904

    for (;;) {
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
3905
            {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
K
Kevin Wolf 已提交
3906
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
K
Kevin Wolf 已提交
3907
            {"pattern", required_argument, 0, OPTION_PATTERN},
3908
            {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
3909
            {"force-share", no_argument, 0, 'U'},
K
Kevin Wolf 已提交
3910 3911
            {0, 0, 0, 0}
        };
3912
        c = getopt_long(argc, argv, ":hc:d:f:no:qs:S:t:wU", long_options, NULL);
K
Kevin Wolf 已提交
3913 3914 3915 3916 3917
        if (c == -1) {
            break;
        }

        switch (c) {
3918 3919 3920
        case ':':
            missing_argument(argv[optind - 1]);
            break;
K
Kevin Wolf 已提交
3921
        case '?':
3922 3923 3924
            unrecognized_option(argv[optind - 1]);
            break;
        case 'h':
K
Kevin Wolf 已提交
3925 3926 3927 3928
            help();
            break;
        case 'c':
        {
3929 3930 3931
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
K
Kevin Wolf 已提交
3932 3933 3934
                error_report("Invalid request count specified");
                return 1;
            }
3935
            count = res;
K
Kevin Wolf 已提交
3936 3937 3938 3939
            break;
        }
        case 'd':
        {
3940 3941 3942
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
K
Kevin Wolf 已提交
3943 3944 3945
                error_report("Invalid queue depth specified");
                return 1;
            }
3946
            depth = res;
K
Kevin Wolf 已提交
3947 3948 3949 3950 3951 3952 3953 3954
            break;
        }
        case 'f':
            fmt = optarg;
            break;
        case 'n':
            flags |= BDRV_O_NATIVE_AIO;
            break;
3955 3956
        case 'o':
        {
3957 3958
            offset = cvtnum(optarg);
            if (offset < 0) {
3959 3960 3961 3962 3963 3964
                error_report("Invalid offset specified");
                return 1;
            }
            break;
        }
            break;
K
Kevin Wolf 已提交
3965 3966 3967 3968 3969 3970 3971
        case 'q':
            quiet = true;
            break;
        case 's':
        {
            int64_t sval;

3972 3973
            sval = cvtnum(optarg);
            if (sval < 0 || sval > INT_MAX) {
K
Kevin Wolf 已提交
3974 3975 3976 3977 3978 3979 3980
                error_report("Invalid buffer size specified");
                return 1;
            }

            bufsize = sval;
            break;
        }
3981 3982 3983 3984
        case 'S':
        {
            int64_t sval;

3985 3986
            sval = cvtnum(optarg);
            if (sval < 0 || sval > INT_MAX) {
3987 3988 3989 3990 3991 3992 3993
                error_report("Invalid step size specified");
                return 1;
            }

            step = sval;
            break;
        }
K
Kevin Wolf 已提交
3994 3995 3996 3997 3998 3999 4000 4001
        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 已提交
4002 4003 4004 4005
        case 'w':
            flags |= BDRV_O_RDWR;
            is_write = true;
            break;
4006 4007 4008
        case 'U':
            force_share = true;
            break;
K
Kevin Wolf 已提交
4009 4010
        case OPTION_PATTERN:
        {
4011 4012 4013
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
K
Kevin Wolf 已提交
4014 4015 4016
                error_report("Invalid pattern byte specified");
                return 1;
            }
4017
            pattern = res;
K
Kevin Wolf 已提交
4018 4019
            break;
        }
4020 4021
        case OPTION_FLUSH_INTERVAL:
        {
4022 4023 4024
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4025 4026 4027
                error_report("Invalid flush interval specified");
                return 1;
            }
4028
            flush_interval = res;
4029 4030 4031 4032 4033
            break;
        }
        case OPTION_NO_DRAIN:
            drain_on_flush = false;
            break;
K
Kevin Wolf 已提交
4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
        }
    }

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

4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055
    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;
    }

4056 4057
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   force_share);
K
Kevin Wolf 已提交
4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069
    if (!blk) {
        ret = -1;
        goto out;
    }

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

    data = (BenchData) {
4070 4071 4072 4073 4074 4075 4076 4077 4078 4079
        .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 已提交
4080
    };
4081
    printf("Sending %d %s requests, %d bytes each, %d in parallel "
4082
           "(starting at offset %" PRId64 ", step size %d)\n",
4083
           data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
4084
           data.offset, data.step);
4085 4086 4087
    if (flush_interval) {
        printf("Sending flush every %d requests\n", flush_interval);
    }
K
Kevin Wolf 已提交
4088

F
Fam Zheng 已提交
4089 4090
    buf_size = data.nrreq * data.bufsize;
    data.buf = blk_blockalign(blk, buf_size);
K
Kevin Wolf 已提交
4091 4092
    memset(data.buf, pattern, data.nrreq * data.bufsize);

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

K
Kevin Wolf 已提交
4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114
    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 已提交
4115 4116 4117
    if (data.buf) {
        blk_unregister_buf(blk, data.buf);
    }
K
Kevin Wolf 已提交
4118 4119 4120 4121
    qemu_vfree(data.buf);
    blk_unref(blk);

    if (ret) {
R
Reda Sallahi 已提交
4122 4123 4124 4125 4126 4127 4128 4129 4130
        return 1;
    }
    return 0;
}

#define C_BS      01
#define C_COUNT   02
#define C_IF      04
#define C_OF      010
R
Reda Sallahi 已提交
4131
#define C_SKIP    020
R
Reda Sallahi 已提交
4132 4133 4134 4135 4136 4137 4138 4139 4140 4141

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

struct DdIo {
    int bsz;    /* Block size */
    char *filename;
    uint8_t *buf;
R
Reda Sallahi 已提交
4142
    int64_t offset;
R
Reda Sallahi 已提交
4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156
};

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;

4157
    res = cvtnum(arg);
R
Reda Sallahi 已提交
4158

4159
    if (res <= 0 || res > INT_MAX) {
R
Reda Sallahi 已提交
4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171
        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)
{
4172
    dd->count = cvtnum(arg);
R
Reda Sallahi 已提交
4173

4174
    if (dd->count < 0) {
R
Reda Sallahi 已提交
4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199
        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 已提交
4200 4201 4202 4203
static int img_dd_skip(const char *arg,
                       struct DdIo *in, struct DdIo *out,
                       struct DdInfo *dd)
{
4204
    in->offset = cvtnum(arg);
R
Reda Sallahi 已提交
4205

4206
    if (in->offset < 0) {
R
Reda Sallahi 已提交
4207 4208 4209 4210 4211 4212 4213
        error_report("invalid number: '%s'", arg);
        return 1;
    }

    return 0;
}

R
Reda Sallahi 已提交
4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229
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;
4230
    bool force_share = false;
R
Reda Sallahi 已提交
4231 4232 4233 4234 4235 4236 4237
    struct DdInfo dd = {
        .flags = 0,
        .count = 0,
    };
    struct DdIo in = {
        .bsz = 512, /* Block size is by default 512 bytes */
        .filename = NULL,
R
Reda Sallahi 已提交
4238 4239
        .buf = NULL,
        .offset = 0
R
Reda Sallahi 已提交
4240 4241 4242 4243
    };
    struct DdIo out = {
        .bsz = 512,
        .filename = NULL,
R
Reda Sallahi 已提交
4244 4245
        .buf = NULL,
        .offset = 0
R
Reda Sallahi 已提交
4246 4247 4248 4249 4250 4251 4252
    };

    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 已提交
4253
        { "skip", img_dd_skip, C_SKIP },
R
Reda Sallahi 已提交
4254 4255 4256 4257
        { NULL, NULL, 0 }
    };
    const struct option long_options[] = {
        { "help", no_argument, 0, 'h'},
4258
        { "object", required_argument, 0, OPTION_OBJECT},
R
Reda Sallahi 已提交
4259
        { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4260
        { "force-share", no_argument, 0, 'U'},
R
Reda Sallahi 已提交
4261 4262 4263
        { 0, 0, 0, 0 }
    };

4264
    while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
R
Reda Sallahi 已提交
4265 4266 4267 4268 4269 4270 4271 4272 4273 4274
        if (c == EOF) {
            break;
        }
        switch (c) {
        case 'O':
            out_fmt = optarg;
            break;
        case 'f':
            fmt = optarg;
            break;
4275 4276 4277
        case ':':
            missing_argument(argv[optind - 1]);
            break;
R
Reda Sallahi 已提交
4278
        case '?':
4279 4280
            unrecognized_option(argv[optind - 1]);
            break;
R
Reda Sallahi 已提交
4281 4282 4283
        case 'h':
            help();
            break;
4284 4285 4286
        case 'U':
            force_share = true;
            break;
4287 4288
        case OPTION_OBJECT:
            if (!qemu_opts_parse_noisily(&qemu_object_opts, optarg, true)) {
4289 4290 4291
                ret = -1;
                goto out;
            }
4292
            break;
R
Reda Sallahi 已提交
4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 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
        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;
    }
4337 4338 4339 4340 4341 4342 4343 4344

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

4345 4346
    blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
                    force_share);
R
Reda Sallahi 已提交
4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394

    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 已提交
4395 4396 4397 4398 4399 4400 4401 4402
    /* 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 已提交
4403 4404 4405 4406 4407 4408 4409 4410 4411 4412

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

4413 4414 4415 4416 4417
    /* 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.
     */
4418
    blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
4419
                         false, false, false);
R
Reda Sallahi 已提交
4420 4421 4422 4423 4424 4425

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

R
Reda Sallahi 已提交
4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436
    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 已提交
4437 4438
    in.buf = g_new(uint8_t, in.bsz);

R
Reda Sallahi 已提交
4439
    for (out_pos = 0; in_pos < size; block_count++) {
R
Reda Sallahi 已提交
4440 4441 4442 4443 4444 4445 4446 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
        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 已提交
4478 4479 4480 4481 4482
        return 1;
    }
    return 0;
}

4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493
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));
4494
    qobject_unref(obj);
4495
    visit_free(v);
4496
    qobject_unref(str);
4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715
}

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 已提交
4716

A
Anthony Liguori 已提交
4717
static const img_cmd_t img_cmds[] = {
4718 4719 4720 4721 4722 4723 4724
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
    { NULL, NULL, },
};

B
bellard 已提交
4725 4726
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
4727
    const img_cmd_t *cmd;
4728
    const char *cmdname;
4729
    Error *local_error = NULL;
4730
    char *trace_file = NULL;
4731 4732 4733
    int c;
    static const struct option long_options[] = {
        {"help", no_argument, 0, 'h'},
4734
        {"version", no_argument, 0, 'V'},
4735
        {"trace", required_argument, NULL, 'T'},
4736 4737
        {0, 0, 0, 0}
    };
B
bellard 已提交
4738

4739 4740 4741 4742
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

4743
    module_call_init(MODULE_INIT_TRACE);
K
Kevin Wolf 已提交
4744
    error_set_progname(argv[0]);
4745
    qemu_init_exec_dir(argv[0]);
K
Kevin Wolf 已提交
4746

4747
    if (qemu_init_main_loop(&local_error)) {
4748
        error_report_err(local_error);
4749 4750 4751
        exit(EXIT_FAILURE);
    }

4752
    qcrypto_init(&error_fatal);
4753

4754
    module_call_init(MODULE_INIT_QOM);
B
bellard 已提交
4755
    bdrv_init();
F
Fam Zheng 已提交
4756 4757 4758
    if (argc < 2) {
        error_exit("Not enough arguments");
    }
4759

4760
    qemu_add_opts(&qemu_object_opts);
4761
    qemu_add_opts(&qemu_source_opts);
4762
    qemu_add_opts(&qemu_trace_opts);
4763

4764
    while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
4765
        switch (c) {
4766 4767 4768
        case ':':
            missing_argument(argv[optind - 1]);
            return 0;
4769
        case '?':
4770 4771 4772
            unrecognized_option(argv[optind - 1]);
            return 0;
        case 'h':
4773 4774 4775 4776 4777
            help();
            return 0;
        case 'V':
            printf(QEMU_IMG_VERSION);
            return 0;
4778 4779 4780 4781
        case 'T':
            g_free(trace_file);
            trace_file = trace_opt_parse(optarg);
            break;
4782
        }
B
bellard 已提交
4783
    }
4784

4785
    cmdname = argv[optind];
4786

4787 4788 4789
    /* reset getopt_long scanning */
    argc -= optind;
    if (argc < 1) {
4790 4791
        return 0;
    }
4792
    argv += optind;
D
Denis V. Lunev 已提交
4793
    optind = 0;
4794

4795 4796 4797 4798 4799 4800
    if (!trace_init_backends()) {
        exit(1);
    }
    trace_init_file(trace_file);
    qemu_set_log(LOG_TRACE);

4801 4802 4803 4804 4805 4806
    /* find the command */
    for (cmd = img_cmds; cmd->name != NULL; cmd++) {
        if (!strcmp(cmdname, cmd->name)) {
            return cmd->handler(argc, argv);
        }
    }
4807

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