qemu-img.c 138.3 KB
Newer Older
B
bellard 已提交
1
/*
B
bellard 已提交
2
 * QEMU disk image utility
3
 *
B
bellard 已提交
4
 * Copyright (c) 2003-2008 Fabrice Bellard
5
 *
B
bellard 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
P
Peter Maydell 已提交
24
#include "qemu/osdep.h"
25
#include "qemu-version.h"
26
#include "qapi/error.h"
27
#include "qapi/util.h"
28
#include "qapi-visit.h"
29
#include "qapi/qobject-output-visitor.h"
30
#include "qapi/qmp/qerror.h"
31
#include "qapi/qmp/qjson.h"
32
#include "qapi/qmp/qbool.h"
33
#include "qemu/cutils.h"
34
#include "qemu/config-file.h"
35 36
#include "qemu/option.h"
#include "qemu/error-report.h"
37
#include "qemu/log.h"
38
#include "qom/object_interfaces.h"
39
#include "sysemu/sysemu.h"
M
Markus Armbruster 已提交
40
#include "sysemu/block-backend.h"
41
#include "block/block_int.h"
M
Max Reitz 已提交
42
#include "block/blockjob.h"
43
#include "block/qapi.h"
44
#include "crypto/init.h"
45
#include "trace/control.h"
46
#include <getopt.h>
47

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

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

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

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

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

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

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

    error_printf("qemu-img: ");

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

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

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

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

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

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

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

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

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

B
bellard 已提交
235

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

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

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

260 261
    qemu_opts_print_help(create_opts);
    qemu_opts_free(create_opts);
262 263 264
    return 0;
}

265

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

    return blk;
}

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

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

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

319 320 321 322
    return blk;
}


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

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


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

378

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

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

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

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

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

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

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

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

502 503
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
504
                          NULL, NULL)) {
505 506 507
        goto fail;
    }

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

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

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

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

fail:
    g_free(options);
    return 1;
B
bellard 已提交
543 544
}

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

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

561
static void dump_human_image_check(ImageCheck *check, bool quiet)
562 563
{
    if (!(check->corruptions || check->leaks || check->check_errors)) {
564
        qprintf(quiet, "No errors were found on the image.\n");
565 566
    } else {
        if (check->corruptions) {
567 568 569 570
            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);
571 572 573
        }

        if (check->leaks) {
574 575 576 577
            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);
578 579 580
        }

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

    if (check->total_clusters != 0 && check->allocated_clusters != 0) {
589 590 591 592 593 594 595
        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);
596 597 598
    }

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

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;
637 638
    check->compressed_clusters      = result.bfi.compressed_clusters;
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
639 640 641 642

    return 0;
}

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

    fmt = NULL;
668
    output = NULL;
669
    cache = BDRV_DEFAULT_CACHE;
670

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

743 744 745 746 747 748 749 750 751
    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;
    }

752 753
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
754
                          NULL, NULL)) {
755 756 757
        return 1;
    }

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

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

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
773 774

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

780 781
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
782

783 784
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
785

786
        if (output_format == OFORMAT_HUMAN) {
787 788 789 790 791 792 793
            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);
794 795
        }

796
        ret = collect_image_check(bs, check, filename, fmt, 0);
797

798 799
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
800 801
    }

M
Max Reitz 已提交
802 803 804 805 806 807 808 809 810
    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;
        }
811 812
    }

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

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

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

M
Max Reitz 已提交
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
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 已提交
853
    AioContext *aio_context = blk_get_aio_context(job->blk);
854
    int ret = 0;
M
Max Reitz 已提交
855

856
    aio_context_acquire(aio_context);
857
    block_job_ref(job);
M
Max Reitz 已提交
858 859
    do {
        aio_poll(aio_context, true);
860 861
        qemu_progress_print(job->len ?
                            ((float)job->offset / job->len * 100.f) : 0.0f, 0);
862
    } while (!job->ready && !job->completed);
M
Max Reitz 已提交
863

864 865 866 867 868 869
    if (!job->completed) {
        ret = block_job_complete_sync(job, errp);
    } else {
        ret = job->ret;
    }
    block_job_unref(job);
870
    aio_context_release(aio_context);
871

872 873 874 875
    /* publish completion progress only when success */
    if (!ret) {
        qemu_progress_print(100.f, 0);
    }
M
Max Reitz 已提交
876 877
}

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

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

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

956
    if (optind != argc - 1) {
F
Fam Zheng 已提交
957
        error_exit("Expecting one image file name");
958
    }
B
bellard 已提交
959 960
    filename = argv[optind++];

961 962
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
963
                          NULL, NULL)) {
964 965 966
        return 1;
    }

M
Max Reitz 已提交
967
    flags = BDRV_O_RDWR | BDRV_O_UNMAP;
968
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
969 970
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
971
        return 1;
972 973
    }

974 975
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   false);
976 977
    if (!blk) {
        return 1;
978
    }
979 980
    bs = blk_bs(blk);

981 982 983
    qemu_progress_init(progress, 1.f);
    qemu_progress_print(0.f, 100);

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

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

1008 1009
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);
1010
    commit_active_start("commit", bs, base_bs, BLOCK_JOB_DEFAULT, 0,
1011
                        BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
1012
                        &cbi, false, &local_err);
1013
    aio_context_release(aio_context);
M
Max Reitz 已提交
1014 1015
    if (local_err) {
        goto done;
B
bellard 已提交
1016 1017
    }

1018 1019 1020 1021
    /* 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 已提交
1022
    if (!drop) {
1023
        bdrv_ref(bs);
M
Max Reitz 已提交
1024 1025
    }

1026 1027
    job = block_job_get("commit");
    run_block_job(job, &local_err);
M
Max Reitz 已提交
1028 1029 1030 1031
    if (local_err) {
        goto unref_backing;
    }

1032 1033
    if (!drop && bs->drv->bdrv_make_empty) {
        ret = bs->drv->bdrv_make_empty(bs);
M
Max Reitz 已提交
1034 1035 1036 1037 1038 1039 1040 1041 1042
        if (ret) {
            error_setg_errno(&local_err, -ret, "Could not empty %s",
                             filename);
            goto unref_backing;
        }
    }

unref_backing:
    if (!drop) {
1043
        bdrv_unref(bs);
M
Max Reitz 已提交
1044
    }
M
Max Reitz 已提交
1045 1046

done:
1047 1048
    qemu_progress_end();

M
Markus Armbruster 已提交
1049
    blk_unref(blk);
M
Max Reitz 已提交
1050 1051

    if (local_err) {
1052
        error_report_err(local_err);
1053 1054
        return 1;
    }
M
Max Reitz 已提交
1055 1056

    qprintf(quiet, "Image committed.\n");
B
bellard 已提交
1057 1058 1059
    return 0;
}

1060 1061 1062 1063 1064 1065 1066
/*
 * 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 已提交
1067 1068
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
{
1069 1070
    bool is_zero;
    int i;
B
bellard 已提交
1071 1072 1073 1074 1075

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
1076
    is_zero = buffer_is_zero(buf, 512);
B
bellard 已提交
1077 1078
    for(i = 1; i < n; i++) {
        buf += 512;
1079
        if (is_zero != buffer_is_zero(buf, 512)) {
B
bellard 已提交
1080
            break;
1081
        }
B
bellard 已提交
1082 1083
    }
    *pnum = i;
1084
    return !is_zero;
B
bellard 已提交
1085 1086
}

1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
/*
 * 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 已提交
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
/*
 * Compares two buffers sector by sector. Returns 0 if the first sector of both
 * buffers matches, non-zero otherwise.
 *
 * pnum is set to the number of sectors (including and immediately following
 * the first one) that are known to have the same comparison result
 */
static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
    int *pnum)
{
1139 1140
    bool res;
    int i;
K
Kevin Wolf 已提交
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }

    res = !!memcmp(buf1, buf2, 512);
    for(i = 1; i < n; i++) {
        buf1 += 512;
        buf2 += 512;

        if (!!memcmp(buf1, buf2, 512) != res) {
            break;
        }
    }

    *pnum = i;
    return res;
}

1161
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
1162

1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
static int64_t sectors_to_bytes(int64_t sectors)
{
    return sectors << BDRV_SECTOR_BITS;
}

static int64_t sectors_to_process(int64_t total, int64_t from)
{
    return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
}

/*
 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
 *
 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
 * data and negative value on error.
 *
1179
 * @param blk:  BlockBackend for the image
1180 1181 1182 1183 1184 1185
 * @param sect_num: Number of first sector to check
 * @param sect_count: Number of sectors to check
 * @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
 */
1186
static int check_empty_sectors(BlockBackend *blk, int64_t sect_num,
1187 1188 1189 1190
                               int sect_count, const char *filename,
                               uint8_t *buffer, bool quiet)
{
    int pnum, ret = 0;
1191 1192
    ret = blk_pread(blk, sect_num << BDRV_SECTOR_BITS, buffer,
                    sect_count << BDRV_SECTOR_BITS);
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
    if (ret < 0) {
        error_report("Error while reading offset %" PRId64 " of %s: %s",
                     sectors_to_bytes(sect_num), filename, strerror(-ret));
        return ret;
    }
    ret = is_allocated_sectors(buffer, sect_count, &pnum);
    if (ret || pnum != sect_count) {
        qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
                sectors_to_bytes(ret ? sect_num : sect_num + pnum));
        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)
{
1217
    const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
M
Markus Armbruster 已提交
1218
    BlockBackend *blk1, *blk2;
1219 1220 1221 1222 1223 1224 1225
    BlockDriverState *bs1, *bs2;
    int64_t total_sectors1, total_sectors2;
    uint8_t *buf1 = NULL, *buf2 = NULL;
    int pnum1, pnum2;
    int allocated1, allocated2;
    int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
    bool progress = false, quiet = false, strict = false;
1226
    int flags;
1227
    bool writethrough;
1228 1229 1230 1231 1232
    int64_t total_sectors;
    int64_t sector_num = 0;
    int64_t nb_sectors;
    int c, pnum;
    uint64_t progress_base;
1233
    bool image_opts = false;
1234
    bool force_share = false;
1235

1236
    cache = BDRV_DEFAULT_CACHE;
1237
    for (;;) {
1238 1239 1240
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
1241
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1242
            {"force-share", no_argument, 0, 'U'},
1243 1244
            {0, 0, 0, 0}
        };
1245
        c = getopt_long(argc, argv, ":hf:F:T:pqsU",
1246
                        long_options, NULL);
1247 1248 1249 1250
        if (c == -1) {
            break;
        }
        switch (c) {
1251 1252 1253
        case ':':
            missing_argument(argv[optind - 1]);
            break;
1254
        case '?':
1255 1256
            unrecognized_option(argv[optind - 1]);
            break;
1257 1258 1259 1260 1261 1262 1263 1264 1265
        case 'h':
            help();
            break;
        case 'f':
            fmt1 = optarg;
            break;
        case 'F':
            fmt2 = optarg;
            break;
1266 1267 1268
        case 'T':
            cache = optarg;
            break;
1269 1270 1271 1272 1273 1274 1275 1276 1277
        case 'p':
            progress = true;
            break;
        case 'q':
            quiet = true;
            break;
        case 's':
            strict = true;
            break;
1278 1279 1280
        case 'U':
            force_share = true;
            break;
1281 1282 1283 1284 1285 1286 1287 1288 1289
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                ret = 2;
                goto out4;
            }
        }   break;
1290 1291 1292
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
1293 1294 1295 1296 1297 1298 1299 1300 1301
        }
    }

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


1302
    if (optind != argc - 2) {
F
Fam Zheng 已提交
1303
        error_exit("Expecting two image file names");
1304 1305 1306 1307
    }
    filename1 = argv[optind++];
    filename2 = argv[optind++];

1308 1309
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
1310
                          NULL, NULL)) {
1311 1312 1313 1314
        ret = 2;
        goto out4;
    }

1315 1316 1317
    /* Initialize before goto out */
    qemu_progress_init(progress, 2.0);

1318 1319
    flags = 0;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1320 1321 1322 1323 1324 1325
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        ret = 2;
        goto out3;
    }

1326 1327
    blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
                    force_share);
1328
    if (!blk1) {
1329
        ret = 2;
1330
        goto out3;
1331 1332
    }

1333 1334
    blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
                    force_share);
1335
    if (!blk2) {
1336
        ret = 2;
1337
        goto out2;
1338
    }
1339
    bs1 = blk_bs(blk1);
1340
    bs2 = blk_bs(blk2);
1341

1342 1343 1344
    buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
    buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
    total_sectors1 = blk_nb_sectors(blk1);
1345 1346 1347 1348 1349 1350
    if (total_sectors1 < 0) {
        error_report("Can't get size of %s: %s",
                     filename1, strerror(-total_sectors1));
        ret = 4;
        goto out;
    }
1351
    total_sectors2 = blk_nb_sectors(blk2);
1352 1353 1354 1355 1356 1357
    if (total_sectors2 < 0) {
        error_report("Can't get size of %s: %s",
                     filename2, strerror(-total_sectors2));
        ret = 4;
        goto out;
    }
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
    total_sectors = MIN(total_sectors1, total_sectors2);
    progress_base = MAX(total_sectors1, total_sectors2);

    qemu_progress_print(0, 100);

    if (strict && total_sectors1 != total_sectors2) {
        ret = 1;
        qprintf(quiet, "Strict mode: Image size mismatch!\n");
        goto out;
    }

    for (;;) {
1370
        int64_t status1, status2;
1371 1372
        BlockDriverState *file;

1373 1374 1375 1376
        nb_sectors = sectors_to_process(total_sectors, sector_num);
        if (nb_sectors <= 0) {
            break;
        }
1377 1378
        status1 = bdrv_get_block_status_above(bs1, NULL, sector_num,
                                              total_sectors1 - sector_num,
1379
                                              &pnum1, &file);
1380
        if (status1 < 0) {
1381 1382 1383 1384
            ret = 3;
            error_report("Sector allocation test failed for %s", filename1);
            goto out;
        }
1385
        allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1386

1387 1388
        status2 = bdrv_get_block_status_above(bs2, NULL, sector_num,
                                              total_sectors2 - sector_num,
1389
                                              &pnum2, &file);
1390
        if (status2 < 0) {
1391 1392 1393 1394
            ret = 3;
            error_report("Sector allocation test failed for %s", filename2);
            goto out;
        }
1395 1396 1397 1398 1399 1400 1401
        allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
        if (pnum1) {
            nb_sectors = MIN(nb_sectors, pnum1);
        }
        if (pnum2) {
            nb_sectors = MIN(nb_sectors, pnum2);
        }
1402

1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415
        if (strict) {
            if ((status1 & ~BDRV_BLOCK_OFFSET_MASK) !=
                (status2 & ~BDRV_BLOCK_OFFSET_MASK)) {
                ret = 1;
                qprintf(quiet, "Strict mode: Offset %" PRId64
                        " block status mismatch!\n",
                        sectors_to_bytes(sector_num));
                goto out;
            }
        }
        if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
            nb_sectors = MIN(pnum1, pnum2);
        } else if (allocated1 == allocated2) {
1416
            if (allocated1) {
1417 1418
                ret = blk_pread(blk1, sector_num << BDRV_SECTOR_BITS, buf1,
                                nb_sectors << BDRV_SECTOR_BITS);
1419 1420 1421 1422 1423 1424 1425
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64 " of %s:"
                                 " %s", sectors_to_bytes(sector_num), filename1,
                                 strerror(-ret));
                    ret = 4;
                    goto out;
                }
1426 1427
                ret = blk_pread(blk2, sector_num << BDRV_SECTOR_BITS, buf2,
                                nb_sectors << BDRV_SECTOR_BITS);
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64
                                 " of %s: %s", sectors_to_bytes(sector_num),
                                 filename2, strerror(-ret));
                    ret = 4;
                    goto out;
                }
                ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
                if (ret || pnum != nb_sectors) {
                    qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
                            sectors_to_bytes(
                                ret ? sector_num : sector_num + pnum));
1440
                    ret = 1;
1441 1442 1443 1444 1445 1446
                    goto out;
                }
            }
        } else {

            if (allocated1) {
1447
                ret = check_empty_sectors(blk1, sector_num, nb_sectors,
1448 1449
                                          filename1, buf1, quiet);
            } else {
1450
                ret = check_empty_sectors(blk2, sector_num, nb_sectors,
1451 1452 1453 1454 1455 1456
                                          filename2, buf1, quiet);
            }
            if (ret) {
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64 ": %s",
                                 sectors_to_bytes(sector_num), strerror(-ret));
1457
                    ret = 4;
1458 1459 1460 1461 1462 1463 1464 1465 1466
                }
                goto out;
            }
        }
        sector_num += nb_sectors;
        qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
    }

    if (total_sectors1 != total_sectors2) {
1467
        BlockBackend *blk_over;
1468 1469 1470 1471 1472 1473
        int64_t total_sectors_over;
        const char *filename_over;

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

        for (;;) {
1483 1484
            int64_t count;

1485 1486 1487 1488
            nb_sectors = sectors_to_process(total_sectors_over, sector_num);
            if (nb_sectors <= 0) {
                break;
            }
1489 1490 1491 1492
            ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL,
                                          sector_num * BDRV_SECTOR_SIZE,
                                          nb_sectors * BDRV_SECTOR_SIZE,
                                          &count);
1493 1494 1495 1496 1497 1498 1499
            if (ret < 0) {
                ret = 3;
                error_report("Sector allocation test failed for %s",
                             filename_over);
                goto out;

            }
1500 1501 1502 1503
            /* TODO relax this once bdrv_is_allocated_above does not enforce
             * sector alignment */
            assert(QEMU_IS_ALIGNED(count, BDRV_SECTOR_SIZE));
            nb_sectors = count >> BDRV_SECTOR_BITS;
1504
            if (ret) {
1505
                ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
1506 1507 1508 1509 1510 1511
                                          filename_over, buf1, quiet);
                if (ret) {
                    if (ret < 0) {
                        error_report("Error while reading offset %" PRId64
                                     " of %s: %s", sectors_to_bytes(sector_num),
                                     filename_over, strerror(-ret));
1512
                        ret = 4;
1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527
                    }
                    goto out;
                }
            }
            sector_num += nb_sectors;
            qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
        }
    }

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

out:
    qemu_vfree(buf1);
    qemu_vfree(buf2);
M
Markus Armbruster 已提交
1528
    blk_unref(blk2);
1529
out2:
M
Markus Armbruster 已提交
1530
    blk_unref(blk1);
1531 1532
out3:
    qemu_progress_end();
1533
out4:
1534 1535 1536
    return ret;
}

1537 1538 1539 1540 1541 1542
enum ImgConvertBlockStatus {
    BLK_DATA,
    BLK_ZERO,
    BLK_BACKING_FILE,
};

P
Peter Lieven 已提交
1543 1544
#define MAX_COROUTINES 16

1545 1546 1547
typedef struct ImgConvertState {
    BlockBackend **src;
    int64_t *src_sectors;
P
Peter Lieven 已提交
1548
    int src_num;
1549 1550
    int64_t total_sectors;
    int64_t allocated_sectors;
P
Peter Lieven 已提交
1551 1552 1553
    int64_t allocated_done;
    int64_t sector_num;
    int64_t wr_offs;
1554 1555 1556 1557 1558 1559
    enum ImgConvertBlockStatus status;
    int64_t sector_next_status;
    BlockBackend *target;
    bool has_zero_init;
    bool compressed;
    bool target_has_backing;
P
Peter Lieven 已提交
1560
    bool wr_in_order;
1561 1562 1563
    int min_sparse;
    size_t cluster_sectors;
    size_t buf_sectors;
P
Peter Lieven 已提交
1564
    long num_coroutines;
P
Peter Lieven 已提交
1565 1566 1567 1568 1569
    int running_coroutines;
    Coroutine *co[MAX_COROUTINES];
    int64_t wait_sector_num[MAX_COROUTINES];
    CoMutex lock;
    int ret;
1570 1571
} ImgConvertState;

P
Peter Lieven 已提交
1572 1573
static void convert_select_part(ImgConvertState *s, int64_t sector_num,
                                int *src_cur, int64_t *src_cur_offset)
1574
{
P
Peter Lieven 已提交
1575 1576 1577 1578 1579 1580
    *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);
1581 1582 1583 1584 1585
    }
}

static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
{
P
Peter Lieven 已提交
1586 1587
    int64_t ret, src_cur_offset;
    int n, src_cur;
1588

P
Peter Lieven 已提交
1589
    convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1590 1591 1592 1593 1594

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

    if (s->sector_next_status <= sector_num) {
1595
        BlockDriverState *file;
1596 1597 1598 1599 1600 1601 1602 1603 1604
        if (s->target_has_backing) {
            ret = bdrv_get_block_status(blk_bs(s->src[src_cur]),
                                        sector_num - src_cur_offset,
                                        n, &n, &file);
        } else {
            ret = bdrv_get_block_status_above(blk_bs(s->src[src_cur]), NULL,
                                              sector_num - src_cur_offset,
                                              n, &n, &file);
        }
1605 1606 1607 1608 1609 1610 1611 1612 1613
        if (ret < 0) {
            return ret;
        }

        if (ret & BDRV_BLOCK_ZERO) {
            s->status = BLK_ZERO;
        } else if (ret & BDRV_BLOCK_DATA) {
            s->status = BLK_DATA;
        } else {
1614
            s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639
        }

        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 已提交
1640 1641
static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
                                        int nb_sectors, uint8_t *buf)
1642
{
P
Peter Lieven 已提交
1643 1644 1645
    int n, ret;
    QEMUIOVector qiov;
    struct iovec iov;
1646 1647 1648 1649

    assert(nb_sectors <= s->buf_sectors);
    while (nb_sectors > 0) {
        BlockBackend *blk;
P
Peter Lieven 已提交
1650 1651
        int src_cur;
        int64_t bs_sectors, src_cur_offset;
1652 1653 1654 1655

        /* 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 已提交
1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
        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);
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679
        if (ret < 0) {
            return ret;
        }

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

    return 0;
}

P
Peter Lieven 已提交
1680 1681 1682 1683

static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
                                         int nb_sectors, uint8_t *buf,
                                         enum ImgConvertBlockStatus status)
1684 1685
{
    int ret;
P
Peter Lieven 已提交
1686 1687
    QEMUIOVector qiov;
    struct iovec iov;
1688 1689 1690

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

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

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

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

    return 0;
}

P
Peter Lieven 已提交
1749
static void coroutine_fn convert_co_do_copy(void *opaque)
1750
{
P
Peter Lieven 已提交
1751
    ImgConvertState *s = opaque;
1752
    uint8_t *buf = NULL;
P
Peter Lieven 已提交
1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774
    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);
1775
            break;
P
Peter Lieven 已提交
1776 1777 1778 1779 1780
        }
        n = convert_iteration_sectors(s, s->sector_num);
        if (n < 0) {
            qemu_co_mutex_unlock(&s->lock);
            s->ret = n;
1781
            break;
P
Peter Lieven 已提交
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 1808 1809 1810 1811 1812 1813
        }
        /* 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 */
1814
            while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
P
Peter Lieven 已提交
1815 1816 1817 1818 1819 1820
                s->wait_sector_num[index] = sector_num;
                qemu_coroutine_yield();
            }
            s->wait_sector_num[index] = -1;
        }

1821 1822 1823 1824 1825 1826 1827
        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 已提交
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 1855 1856 1857 1858 1859 1860
        }

        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;
1861 1862 1863 1864 1865 1866 1867 1868 1869

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

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

P
Peter Lieven 已提交
1902 1903 1904 1905 1906 1907
    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]);
    }
1908

1909
    while (s->running_coroutines) {
P
Peter Lieven 已提交
1910
        main_loop_wait(false);
1911 1912
    }

P
Peter Lieven 已提交
1913
    if (s->compressed && !s->ret) {
1914
        /* signal EOF to align */
1915
        ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
1916
        if (ret < 0) {
P
Peter Lieven 已提交
1917
            return ret;
1918 1919 1920
        }
    }

P
Peter Lieven 已提交
1921
    return s->ret;
1922 1923
}

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

    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 已提交
1949 1950

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

            sval = cvtnum(optarg);
            if (sval < 0) {
2021
                error_report("Invalid minimum zero buffer size for sparse output specified");
2022
                goto fail_getopt;
2023 2024
            }

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

2075 2076 2077 2078
    if (!out_fmt && !tgt_image_opts) {
        out_fmt = "raw";
    }

2079 2080
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2081
                          NULL, NULL)) {
2082 2083 2084
        goto fail_getopt;
    }

P
Peter Lieven 已提交
2085
    if (!s.wr_in_order && s.compressed) {
P
Peter Lieven 已提交
2086 2087 2088 2089
        error_report("Out of order write and compress are mutually exclusive");
        goto fail_getopt;
    }

2090 2091 2092 2093 2094
    if (tgt_image_opts && !skip_create) {
        error_report("--target-image-opts requires use of -n flag");
        goto fail_getopt;
    }

P
Peter Lieven 已提交
2095 2096
    s.src_num = argc - optind - 1;
    out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2097

2098
    if (options && has_help_option(options)) {
2099 2100 2101 2102 2103 2104 2105
        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;
        }
2106 2107
    }

P
Peter Lieven 已提交
2108 2109 2110
    if (s.src_num < 1) {
        error_report("Must specify image file name");
        goto fail_getopt;
2111 2112 2113
    }


P
Peter Lieven 已提交
2114
    /* ret is still -EINVAL until here */
2115
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2116 2117
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
P
Peter Lieven 已提交
2118
        goto fail_getopt;
2119 2120
    }

P
Peter Lieven 已提交
2121 2122 2123 2124 2125
    /* Initialize before goto out */
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);
2126 2127
    qemu_progress_print(0, 100);

P
Peter Lieven 已提交
2128 2129
    s.src = g_new0(BlockBackend *, s.src_num);
    s.src_sectors = g_new(int64_t, s.src_num);
2130

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

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

P
Peter Lieven 已提交
2161 2162
        bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
                                             &local_err);
2163
    }
2164
    if (local_err) {
2165
        error_reportf_err(local_err, "Failed to load snapshot: ");
2166 2167
        ret = -1;
        goto out;
E
edison 已提交
2168 2169
    }

2170 2171 2172 2173 2174 2175 2176 2177
    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;
        }
2178

2179 2180 2181 2182 2183 2184
        proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
        if (!proto_drv) {
            error_report_err(local_err);
            ret = -1;
            goto out;
        }
2185

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

M
Max Reitz 已提交
2193 2194 2195 2196 2197 2198
        if (!proto_drv->create_opts) {
            error_report("Protocol driver '%s' does not support image creation",
                         proto_drv->format_name);
            ret = -1;
            goto out;
        }
2199

M
Max Reitz 已提交
2200 2201
        create_opts = qemu_opts_append(create_opts, drv->create_opts);
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2202

M
Max Reitz 已提交
2203
        opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2204 2205 2206
        if (options) {
            qemu_opts_do_parse(opts, options, NULL, &local_err);
            if (local_err) {
2207
                error_report_err(local_err);
2208 2209 2210
                ret = -1;
                goto out;
            }
M
Max Reitz 已提交
2211
        }
2212

P
Peter Lieven 已提交
2213
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
2214
                            &error_abort);
M
Max Reitz 已提交
2215 2216 2217 2218
        ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
        if (ret < 0) {
            goto out;
        }
2219
    }
2220

2221
    /* Get backing file name if -o backing_file was used */
2222
    out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2223
    if (out_baseimg_param) {
2224
        out_baseimg = out_baseimg_param;
2225
    }
P
Peter Lieven 已提交
2226
    s.target_has_backing = (bool) out_baseimg;
2227

2228 2229 2230 2231 2232 2233 2234
    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;
    }

2235
    /* Check if compression is supported */
P
Peter Lieven 已提交
2236
    if (s.compressed) {
2237 2238
        bool encryption =
            qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2239 2240
        const char *encryptfmt =
            qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
2241 2242
        const char *preallocation =
            qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2243

2244
        if (drv && !drv->bdrv_co_pwritev_compressed) {
2245
            error_report("Compression not supported for this file format");
2246 2247
            ret = -1;
            goto out;
2248 2249
        }

2250
        if (encryption || encryptfmt) {
2251 2252
            error_report("Compression and encryption not supported at "
                         "the same time");
2253 2254
            ret = -1;
            goto out;
2255
        }
2256

2257 2258
        if (preallocation
            && strcmp(preallocation, "off"))
2259 2260 2261 2262 2263 2264
        {
            error_report("Compression and preallocation not supported at "
                         "the same time");
            ret = -1;
            goto out;
        }
2265 2266
    }

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

P
Peter Lieven 已提交
2277
    flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2278
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2279 2280
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2281
        goto out;
2282 2283
    }

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

2302 2303 2304 2305 2306 2307
    if (s.compressed && !out_bs->drv->bdrv_co_pwritev_compressed) {
        error_report("Compression not supported for this file format");
        ret = -1;
        goto out;
    }

2308
    /* increase bufsectors from the default 4096 (2M) if opt_transfer
2309 2310
     * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
     * as maximum. */
P
Peter Lieven 已提交
2311 2312 2313 2314 2315
    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)));
2316

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

2331 2332
    ret = bdrv_get_info(out_bs, &bdi);
    if (ret < 0) {
P
Peter Lieven 已提交
2333
        if (s.compressed) {
2334
            error_report("could not get block driver info");
2335 2336
            goto out;
        }
2337
    } else {
P
Peter Lieven 已提交
2338 2339 2340
        s.compressed = s.compressed || bdi.needs_compressed_writes;
        s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
    }
2341

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

P
Peter Lieven 已提交
2362
    return !!ret;
B
bellard 已提交
2363 2364
}

B
bellard 已提交
2365

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

2385 2386 2387 2388
static void dump_json_image_info_list(ImageInfoList *list)
{
    QString *str;
    QObject *obj;
2389
    Visitor *v = qobject_output_visitor_new(&obj);
2390 2391 2392

    visit_type_ImageInfoList(v, NULL, &list, &error_abort);
    visit_complete(v, &obj);
2393 2394 2395 2396
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
2397
    visit_free(v);
2398 2399 2400
    QDECREF(str);
}

2401 2402 2403 2404
static void dump_json_image_info(ImageInfo *info)
{
    QString *str;
    QObject *obj;
2405
    Visitor *v = qobject_output_visitor_new(&obj);
2406 2407 2408

    visit_type_ImageInfo(v, NULL, &info, &error_abort);
    visit_complete(v, &obj);
2409 2410 2411 2412
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
2413
    visit_free(v);
2414 2415 2416
    QDECREF(str);
}

2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427
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;

2428
        bdrv_image_info_dump(fprintf, stdout, elem->value);
2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448
    }
}

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.
 */
2449 2450
static ImageInfoList *collect_image_info_list(bool image_opts,
                                              const char *filename,
2451
                                              const char *fmt,
2452
                                              bool chain, bool force_share)
2453 2454 2455 2456
{
    ImageInfoList *head = NULL;
    ImageInfoList **last = &head;
    GHashTable *filenames;
2457
    Error *err = NULL;
2458 2459 2460 2461

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

    while (filename) {
M
Markus Armbruster 已提交
2462
        BlockBackend *blk;
2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473
        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);

2474
        blk = img_open(image_opts, filename, fmt,
2475 2476
                       BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
                       force_share);
2477
        if (!blk) {
2478 2479
            goto err;
        }
2480
        bs = blk_bs(blk);
2481

2482
        bdrv_query_image_info(bs, &info, &err);
2483
        if (err) {
2484
            error_report_err(err);
M
Markus Armbruster 已提交
2485
            blk_unref(blk);
2486
            goto err;
2487
        }
2488 2489 2490 2491 2492 2493

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

M
Markus Armbruster 已提交
2494
        blk_unref(blk);
2495 2496 2497 2498 2499 2500

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

2520 2521 2522 2523
static int img_info(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
2524
    bool chain = false;
2525
    const char *filename, *fmt, *output;
2526
    ImageInfoList *list;
2527
    bool image_opts = false;
2528
    bool force_share = false;
2529

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

2589 2590 2591 2592 2593 2594
    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.");
2595 2596
        return 1;
    }
2597

2598 2599
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2600
                          NULL, NULL)) {
2601 2602 2603
        return 1;
    }

2604 2605
    list = collect_image_info_list(image_opts, filename, fmt, chain,
                                   force_share);
2606
    if (!list) {
2607
        return 1;
B
bellard 已提交
2608
    }
2609 2610 2611

    switch (output_format) {
    case OFORMAT_HUMAN:
2612
        dump_human_image_info_list(list);
2613 2614
        break;
    case OFORMAT_JSON:
2615 2616 2617 2618 2619
        if (chain) {
            dump_json_image_info_list(list);
        } else {
            dump_json_image_info(list->value);
        }
2620
        break;
B
bellard 已提交
2621
    }
2622

2623
    qapi_free_ImageInfoList(list);
B
bellard 已提交
2624 2625 2626
    return 0;
}

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

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

static int get_block_status(BlockDriverState *bs, int64_t sector_num,
                            int nb_sectors, MapEntry *e)
{
    int64_t ret;
    int depth;
2674
    BlockDriverState *file;
J
John Snow 已提交
2675
    bool has_offset;
P
Paolo Bonzini 已提交
2676 2677 2678 2679 2680 2681 2682 2683

    /* 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 (;;) {
2684 2685
        ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
                                    &file);
P
Paolo Bonzini 已提交
2686 2687 2688 2689 2690 2691 2692
        if (ret < 0) {
            return ret;
        }
        assert(nb_sectors);
        if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
            break;
        }
2693
        bs = backing_bs(bs);
P
Paolo Bonzini 已提交
2694 2695 2696 2697 2698 2699 2700 2701
        if (bs == NULL) {
            ret = 0;
            break;
        }

        depth++;
    }

J
John Snow 已提交
2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715
    has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);

    *e = (MapEntry) {
        .start = sector_num * BDRV_SECTOR_SIZE,
        .length = nb_sectors * BDRV_SECTOR_SIZE,
        .data = !!(ret & BDRV_BLOCK_DATA),
        .zero = !!(ret & BDRV_BLOCK_ZERO),
        .offset = ret & BDRV_BLOCK_OFFSET_MASK,
        .has_offset = has_offset,
        .depth = depth,
        .has_filename = file && has_offset,
        .filename = file && has_offset ? file->filename : NULL,
    };

P
Paolo Bonzini 已提交
2716 2717 2718
    return 0;
}

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

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

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

2817 2818
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2819
                          NULL, NULL)) {
2820 2821 2822
        return 1;
    }

2823
    blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
2824 2825
    if (!blk) {
        return 1;
P
Paolo Bonzini 已提交
2826
    }
2827
    bs = blk_bs(blk);
P
Paolo Bonzini 已提交
2828 2829 2830 2831 2832

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

2833
    length = blk_getlength(blk);
P
Paolo Bonzini 已提交
2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850
    while (curr.start + curr.length < length) {
        int64_t nsectors_left;
        int64_t sector_num;
        int n;

        sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;

        /* Probe up to 1 GiB at a time.  */
        nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
        n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
        ret = get_block_status(bs, sector_num, n, &next);

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

2851
        if (entry_mergeable(&curr, &next)) {
P
Paolo Bonzini 已提交
2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864
            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 已提交
2865
    blk_unref(blk);
P
Paolo Bonzini 已提交
2866 2867 2868
    return ret < 0;
}

2869 2870 2871 2872 2873
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

2874
static int img_snapshot(int argc, char **argv)
2875
{
M
Markus Armbruster 已提交
2876
    BlockBackend *blk;
2877 2878 2879
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
2880
    int c, ret = 0, bdrv_oflags;
2881 2882
    int action = 0;
    qemu_timeval tv;
2883
    bool quiet = false;
2884
    Error *err = NULL;
2885
    bool image_opts = false;
2886
    bool force_share = false;
2887

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

2965
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2966
        error_exit("Expecting one image file name");
2967
    }
2968 2969
    filename = argv[optind++];

2970 2971
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2972
                          NULL, NULL)) {
2973 2974 2975
        return 1;
    }

2976
    /* Open the image */
2977 2978
    blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
                   force_share);
2979 2980
    if (!blk) {
        return 1;
2981
    }
2982
    bs = blk_bs(blk);
2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998

    /* 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);
2999
        if (ret) {
3000
            error_report("Could not create snapshot '%s': %d (%s)",
3001
                snapshot_name, ret, strerror(-ret));
3002
        }
3003 3004 3005 3006
        break;

    case SNAPSHOT_APPLY:
        ret = bdrv_snapshot_goto(bs, snapshot_name);
3007
        if (ret) {
3008
            error_report("Could not apply snapshot '%s': %d (%s)",
3009
                snapshot_name, ret, strerror(-ret));
3010
        }
3011 3012 3013
        break;

    case SNAPSHOT_DELETE:
3014
        bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
3015
        if (err) {
3016 3017
            error_reportf_err(err, "Could not delete snapshot '%s': ",
                              snapshot_name);
3018
            ret = 1;
3019
        }
3020 3021 3022 3023
        break;
    }

    /* Cleanup */
M
Markus Armbruster 已提交
3024
    blk_unref(blk);
3025 3026 3027
    if (ret) {
        return 1;
    }
3028
    return 0;
3029 3030
}

K
Kevin Wolf 已提交
3031 3032
static int img_rebase(int argc, char **argv)
{
M
Markus Armbruster 已提交
3033
    BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
P
Paolo Bonzini 已提交
3034 3035
    uint8_t *buf_old = NULL;
    uint8_t *buf_new = NULL;
3036
    BlockDriverState *bs = NULL;
K
Kevin Wolf 已提交
3037
    char *filename;
3038 3039
    const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
    int c, flags, src_flags, ret;
3040
    bool writethrough, src_writethrough;
K
Kevin Wolf 已提交
3041
    int unsafe = 0;
3042
    bool force_share = false;
3043
    int progress = 0;
3044
    bool quiet = false;
3045
    Error *local_err = NULL;
3046
    bool image_opts = false;
K
Kevin Wolf 已提交
3047 3048

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

3118 3119 3120 3121
    if (quiet) {
        progress = 0;
    }

F
Fam Zheng 已提交
3122 3123 3124 3125 3126
    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)");
3127
    }
K
Kevin Wolf 已提交
3128 3129
    filename = argv[optind++];

3130 3131
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3132
                          NULL, NULL)) {
3133 3134 3135
        return 1;
    }

3136 3137 3138
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

3139
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
3140
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3141 3142
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
3143
        goto out;
3144 3145
    }

3146 3147
    src_flags = 0;
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
3148 3149
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
3150
        goto out;
3151 3152
    }

3153 3154 3155 3156
    /* 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 已提交
3157 3158 3159 3160 3161 3162
    /*
     * 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.
     */
3163 3164
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   false);
3165
    if (!blk) {
3166 3167
        ret = -1;
        goto out;
3168
    }
3169
    bs = blk_bs(blk);
K
Kevin Wolf 已提交
3170 3171

    if (out_basefmt != NULL) {
3172
        if (bdrv_find_format(out_basefmt) == NULL) {
3173
            error_report("Invalid format name: '%s'", out_basefmt);
3174 3175
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
3176 3177 3178 3179
        }
    }

    /* For safe rebasing we need to compare old and new backing file */
3180
    if (!unsafe) {
3181
        char backing_name[PATH_MAX];
3182 3183 3184 3185
        QDict *options = NULL;

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

3189 3190 3191 3192
        if (force_share) {
            if (!options) {
                options = qdict_new();
            }
3193
            qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3194
        }
K
Kevin Wolf 已提交
3195
        bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3196
        blk_old_backing = blk_new_open(backing_name, NULL,
3197 3198
                                       options, src_flags, &local_err);
        if (!blk_old_backing) {
3199 3200 3201
            error_reportf_err(local_err,
                              "Could not open old backing file '%s': ",
                              backing_name);
3202
            ret = -1;
3203
            goto out;
K
Kevin Wolf 已提交
3204
        }
3205

3206
        if (out_baseimg[0]) {
3207
            options = qdict_new();
3208
            if (out_basefmt) {
3209
                qdict_put_str(options, "driver", out_basefmt);
3210 3211 3212
            }
            if (force_share) {
                qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3213 3214
            }

3215
            blk_new_backing = blk_new_open(out_baseimg, NULL,
3216 3217
                                           options, src_flags, &local_err);
            if (!blk_new_backing) {
3218 3219 3220
                error_reportf_err(local_err,
                                  "Could not open new backing file '%s': ",
                                  out_baseimg);
3221
                ret = -1;
3222 3223
                goto out;
            }
K
Kevin Wolf 已提交
3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236
        }
    }

    /*
     * 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) {
3237 3238 3239
        int64_t num_sectors;
        int64_t old_backing_num_sectors;
        int64_t new_backing_num_sectors = 0;
K
Kevin Wolf 已提交
3240
        uint64_t sector;
3241
        int n;
3242
        int64_t count;
3243
        float local_progress = 0;
3244

3245 3246
        buf_old = blk_blockalign(blk, IO_BUF_SIZE);
        buf_new = blk_blockalign(blk, IO_BUF_SIZE);
K
Kevin Wolf 已提交
3247

3248
        num_sectors = blk_nb_sectors(blk);
3249 3250 3251 3252 3253 3254
        if (num_sectors < 0) {
            error_report("Could not get size of '%s': %s",
                         filename, strerror(-num_sectors));
            ret = -1;
            goto out;
        }
3255
        old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
3256
        if (old_backing_num_sectors < 0) {
3257
            char backing_name[PATH_MAX];
3258 3259 3260 3261 3262 3263 3264

            bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
            error_report("Could not get size of '%s': %s",
                         backing_name, strerror(-old_backing_num_sectors));
            ret = -1;
            goto out;
        }
3265 3266
        if (blk_new_backing) {
            new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
3267 3268 3269 3270 3271 3272
            if (new_backing_num_sectors < 0) {
                error_report("Could not get size of '%s': %s",
                             out_baseimg, strerror(-new_backing_num_sectors));
                ret = -1;
                goto out;
            }
3273
        }
K
Kevin Wolf 已提交
3274

3275 3276 3277 3278 3279
        if (num_sectors != 0) {
            local_progress = (float)100 /
                (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
        }

K
Kevin Wolf 已提交
3280 3281 3282 3283 3284 3285 3286 3287 3288 3289
        for (sector = 0; sector < num_sectors; sector += n) {

            /* How many sectors can we handle with the next read? */
            if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
                n = (IO_BUF_SIZE / 512);
            } else {
                n = num_sectors - sector;
            }

            /* If the cluster is allocated, we don't need to take action */
3290 3291
            ret = bdrv_is_allocated(bs, sector << BDRV_SECTOR_BITS,
                                    n << BDRV_SECTOR_BITS, &count);
3292 3293 3294 3295 3296
            if (ret < 0) {
                error_report("error while reading image metadata: %s",
                             strerror(-ret));
                goto out;
            }
3297 3298 3299 3300
            /* TODO relax this once bdrv_is_allocated does not enforce
             * sector alignment */
            assert(QEMU_IS_ALIGNED(count, BDRV_SECTOR_SIZE));
            n = count >> BDRV_SECTOR_BITS;
3301
            if (ret) {
K
Kevin Wolf 已提交
3302 3303 3304
                continue;
            }

3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315
            /*
             * Read old and new backing file and take into consideration that
             * backing files may be smaller than the COW image.
             */
            if (sector >= old_backing_num_sectors) {
                memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
            } else {
                if (sector + n > old_backing_num_sectors) {
                    n = old_backing_num_sectors - sector;
                }

3316 3317
                ret = blk_pread(blk_old_backing, sector << BDRV_SECTOR_BITS,
                                buf_old, n << BDRV_SECTOR_BITS);
3318 3319 3320 3321
                if (ret < 0) {
                    error_report("error while reading from old backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3322
            }
3323

3324
            if (sector >= new_backing_num_sectors || !blk_new_backing) {
3325 3326 3327 3328 3329 3330
                memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
            } else {
                if (sector + n > new_backing_num_sectors) {
                    n = new_backing_num_sectors - sector;
                }

3331 3332
                ret = blk_pread(blk_new_backing, sector << BDRV_SECTOR_BITS,
                                buf_new, n << BDRV_SECTOR_BITS);
3333 3334 3335 3336
                if (ret < 0) {
                    error_report("error while reading from new backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3337 3338 3339 3340 3341 3342 3343 3344 3345
            }

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

            while (written < n) {
                int pnum;

                if (compare_sectors(buf_old + written * 512,
3346
                    buf_new + written * 512, n - written, &pnum))
K
Kevin Wolf 已提交
3347
                {
3348 3349 3350 3351
                    ret = blk_pwrite(blk,
                                     (sector + written) << BDRV_SECTOR_BITS,
                                     buf_old + written * 512,
                                     pnum << BDRV_SECTOR_BITS, 0);
K
Kevin Wolf 已提交
3352
                    if (ret < 0) {
3353
                        error_report("Error while writing to COW image: %s",
K
Kevin Wolf 已提交
3354
                            strerror(-ret));
3355
                        goto out;
K
Kevin Wolf 已提交
3356 3357 3358 3359 3360
                    }
                }

                written += pnum;
            }
3361
            qemu_progress_print(local_progress, 100);
K
Kevin Wolf 已提交
3362 3363 3364 3365 3366 3367 3368 3369
        }
    }

    /*
     * 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.
     */
3370 3371 3372 3373 3374 3375
    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 已提交
3376
    if (ret == -ENOSPC) {
3377 3378
        error_report("Could not change the backing file to '%s': No "
                     "space left in the file header", out_baseimg);
K
Kevin Wolf 已提交
3379
    } else if (ret < 0) {
3380
        error_report("Could not change the backing file to '%s': %s",
K
Kevin Wolf 已提交
3381 3382 3383
            out_baseimg, strerror(-ret));
    }

3384
    qemu_progress_print(100, 0);
K
Kevin Wolf 已提交
3385 3386 3387 3388 3389 3390
    /*
     * 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.
     */
3391
out:
3392
    qemu_progress_end();
K
Kevin Wolf 已提交
3393 3394
    /* Cleanup */
    if (!unsafe) {
M
Markus Armbruster 已提交
3395 3396
        blk_unref(blk_old_backing);
        blk_unref(blk_new_backing);
K
Kevin Wolf 已提交
3397
    }
P
Paolo Bonzini 已提交
3398 3399
    qemu_vfree(buf_old);
    qemu_vfree(buf_new);
K
Kevin Wolf 已提交
3400

M
Markus Armbruster 已提交
3401
    blk_unref(blk);
3402 3403 3404
    if (ret) {
        return 1;
    }
K
Kevin Wolf 已提交
3405 3406 3407
    return 0;
}

3408 3409
static int img_resize(int argc, char **argv)
{
3410
    Error *err = NULL;
3411 3412
    int c, ret, relative;
    const char *filename, *fmt, *size;
3413
    int64_t n, total_size, current_size;
3414
    bool quiet = false;
M
Markus Armbruster 已提交
3415
    BlockBackend *blk = NULL;
3416
    PreallocMode prealloc = PREALLOC_MODE_OFF;
3417
    QemuOpts *param;
3418

3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429
    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 */
            }
3430 3431
        },
    };
3432
    bool image_opts = false;
3433

K
Kevin Wolf 已提交
3434 3435 3436
    /* Remove size from argv manually so that negative numbers are not treated
     * as options by getopt. */
    if (argc < 3) {
F
Fam Zheng 已提交
3437
        error_exit("Not enough arguments");
K
Kevin Wolf 已提交
3438 3439 3440 3441 3442 3443
        return 1;
    }

    size = argv[--argc];

    /* Parse getopt arguments */
3444 3445
    fmt = NULL;
    for(;;) {
3446 3447 3448
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3449
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3450
            {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
3451 3452
            {0, 0, 0, 0}
        };
3453
        c = getopt_long(argc, argv, ":f:hq",
3454
                        long_options, NULL);
3455 3456 3457 3458
        if (c == -1) {
            break;
        }
        switch(c) {
3459 3460 3461
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
3462
        case '?':
3463 3464
            unrecognized_option(argv[optind - 1]);
            break;
3465 3466 3467 3468 3469 3470
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
3471 3472 3473
        case 'q':
            quiet = true;
            break;
3474 3475 3476 3477 3478 3479 3480 3481
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3482 3483 3484
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
3485 3486 3487 3488 3489 3490 3491 3492 3493
        case OPTION_PREALLOCATION:
            prealloc = qapi_enum_parse(PreallocMode_lookup, optarg,
                                       PREALLOC_MODE__MAX, PREALLOC_MODE__MAX,
                                       NULL);
            if (prealloc == PREALLOC_MODE__MAX) {
                error_report("Invalid preallocation mode '%s'", optarg);
                return 1;
            }
            break;
3494 3495
        }
    }
3496
    if (optind != argc - 1) {
F
Fam Zheng 已提交
3497
        error_exit("Expecting one image file name");
3498 3499 3500
    }
    filename = argv[optind++];

3501 3502
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3503
                          NULL, NULL)) {
3504 3505 3506
        return 1;
    }

3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522
    /* 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 */
3523
    param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3524
    qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3525 3526
    if (err) {
        error_report_err(err);
3527
        ret = -1;
3528
        qemu_opts_del(param);
3529
        goto out;
3530
    }
3531 3532
    n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
    qemu_opts_del(param);
3533

3534
    blk = img_open(image_opts, filename, fmt,
3535 3536
                   BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
                   false);
3537
    if (!blk) {
3538 3539
        ret = -1;
        goto out;
3540
    }
3541

3542 3543 3544 3545 3546 3547 3548 3549
    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;
    }

3550
    if (relative) {
3551
        total_size = current_size + n * relative;
3552 3553 3554 3555
    } else {
        total_size = n;
    }
    if (total_size <= 0) {
3556
        error_report("New image size must be positive");
3557 3558
        ret = -1;
        goto out;
3559 3560
    }

3561 3562 3563 3564 3565 3566 3567
    if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
        error_report("Preallocation can only be used for growing images");
        ret = -1;
        goto out;
    }

    ret = blk_truncate(blk, total_size, prealloc, &err);
3568
    if (!ret) {
3569
        qprintf(quiet, "Image resized.\n");
3570 3571
    } else {
        error_report_err(err);
3572
    }
3573
out:
M
Markus Armbruster 已提交
3574
    blk_unref(blk);
3575 3576 3577
    if (ret) {
        return 1;
    }
3578 3579 3580
    return 0;
}

3581
static void amend_status_cb(BlockDriverState *bs,
3582 3583
                            int64_t offset, int64_t total_work_size,
                            void *opaque)
3584 3585 3586 3587
{
    qemu_progress_print(100.f * offset / total_work_size, 0);
}

M
Max Reitz 已提交
3588 3589
static int img_amend(int argc, char **argv)
{
3590
    Error *err = NULL;
M
Max Reitz 已提交
3591 3592
    int c, ret = 0;
    char *options = NULL;
3593 3594
    QemuOptsList *create_opts = NULL;
    QemuOpts *opts = NULL;
3595 3596
    const char *fmt = NULL, *filename, *cache;
    int flags;
3597
    bool writethrough;
3598
    bool quiet = false, progress = false;
M
Markus Armbruster 已提交
3599
    BlockBackend *blk = NULL;
M
Max Reitz 已提交
3600
    BlockDriverState *bs = NULL;
3601
    bool image_opts = false;
M
Max Reitz 已提交
3602

3603
    cache = BDRV_DEFAULT_CACHE;
M
Max Reitz 已提交
3604
    for (;;) {
3605 3606 3607
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3608
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3609 3610
            {0, 0, 0, 0}
        };
3611
        c = getopt_long(argc, argv, ":ho:f:t:pq",
3612
                        long_options, NULL);
M
Max Reitz 已提交
3613 3614 3615 3616 3617
        if (c == -1) {
            break;
        }

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

3667
    if (!options) {
F
Fam Zheng 已提交
3668
        error_exit("Must specify options (-o)");
M
Max Reitz 已提交
3669 3670
    }

3671 3672
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3673
                          NULL, NULL)) {
3674 3675 3676 3677
        ret = -1;
        goto out_no_progress;
    }

3678 3679 3680 3681 3682
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);

3683 3684 3685 3686 3687 3688
    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 已提交
3689 3690
    }

3691
    if (optind != argc - 1) {
M
Max Reitz 已提交
3692 3693 3694
        error_report("Expecting one image file name");
        ret = -1;
        goto out;
3695
    }
M
Max Reitz 已提交
3696

3697 3698
    flags = BDRV_O_RDWR;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3699 3700 3701 3702 3703
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        goto out;
    }

3704 3705
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   false);
3706
    if (!blk) {
M
Max Reitz 已提交
3707 3708 3709
        ret = -1;
        goto out;
    }
3710
    bs = blk_bs(blk);
M
Max Reitz 已提交
3711 3712 3713

    fmt = bs->drv->format_name;

3714
    if (has_help_option(options)) {
3715
        /* If the format was auto-detected, print option help here */
M
Max Reitz 已提交
3716 3717 3718 3719
        ret = print_block_option_help(filename, fmt);
        goto out;
    }

3720 3721 3722 3723 3724 3725 3726
    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 已提交
3727
    create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3728
    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
P
Paolo Bonzini 已提交
3729 3730 3731 3732 3733
    qemu_opts_do_parse(opts, options, NULL, &err);
    if (err) {
        error_report_err(err);
        ret = -1;
        goto out;
M
Max Reitz 已提交
3734 3735
    }

3736 3737
    /* In case the driver does not call amend_status_cb() */
    qemu_progress_print(0.f, 0);
3738
    ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
3739
    qemu_progress_print(100.f, 0);
M
Max Reitz 已提交
3740 3741 3742 3743 3744 3745
    if (ret < 0) {
        error_report("Error while amending options: %s", strerror(-ret));
        goto out;
    }

out:
3746 3747
    qemu_progress_end();

3748
out_no_progress:
M
Markus Armbruster 已提交
3749
    blk_unref(blk);
3750 3751
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
3752 3753
    g_free(options);

M
Max Reitz 已提交
3754 3755 3756 3757 3758 3759
    if (ret) {
        return 1;
    }
    return 0;
}

K
Kevin Wolf 已提交
3760 3761 3762
typedef struct BenchData {
    BlockBackend *blk;
    uint64_t image_size;
K
Kevin Wolf 已提交
3763
    bool write;
K
Kevin Wolf 已提交
3764
    int bufsize;
3765
    int step;
K
Kevin Wolf 已提交
3766 3767
    int nrreq;
    int n;
3768 3769
    int flush_interval;
    bool drain_on_flush;
K
Kevin Wolf 已提交
3770 3771 3772 3773
    uint8_t *buf;
    QEMUIOVector *qiov;

    int in_flight;
3774
    bool in_flush;
K
Kevin Wolf 已提交
3775 3776 3777
    uint64_t offset;
} BenchData;

3778 3779 3780
static void bench_undrained_flush_cb(void *opaque, int ret)
{
    if (ret < 0) {
3781
        error_report("Failed flush request: %s", strerror(-ret));
3782 3783 3784 3785
        exit(EXIT_FAILURE);
    }
}

K
Kevin Wolf 已提交
3786 3787 3788 3789 3790 3791
static void bench_cb(void *opaque, int ret)
{
    BenchData *b = opaque;
    BlockAIOCB *acb;

    if (ret < 0) {
3792
        error_report("Failed request: %s", strerror(-ret));
K
Kevin Wolf 已提交
3793 3794
        exit(EXIT_FAILURE);
    }
3795 3796 3797 3798 3799 3800 3801 3802

    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 已提交
3803 3804
        b->n--;
        b->in_flight--;
3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827

        /* 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 已提交
3828 3829 3830
    }

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

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

        switch (c) {
3891 3892 3893
        case ':':
            missing_argument(argv[optind - 1]);
            break;
K
Kevin Wolf 已提交
3894
        case '?':
3895 3896 3897
            unrecognized_option(argv[optind - 1]);
            break;
        case 'h':
K
Kevin Wolf 已提交
3898 3899 3900 3901
            help();
            break;
        case 'c':
        {
3902 3903 3904
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
K
Kevin Wolf 已提交
3905 3906 3907
                error_report("Invalid request count specified");
                return 1;
            }
3908
            count = res;
K
Kevin Wolf 已提交
3909 3910 3911 3912
            break;
        }
        case 'd':
        {
3913 3914 3915
            unsigned long res;

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

3945 3946
            sval = cvtnum(optarg);
            if (sval < 0 || sval > INT_MAX) {
K
Kevin Wolf 已提交
3947 3948 3949 3950 3951 3952 3953
                error_report("Invalid buffer size specified");
                return 1;
            }

            bufsize = sval;
            break;
        }
3954 3955 3956 3957
        case 'S':
        {
            int64_t sval;

3958 3959
            sval = cvtnum(optarg);
            if (sval < 0 || sval > INT_MAX) {
3960 3961 3962 3963 3964 3965 3966
                error_report("Invalid step size specified");
                return 1;
            }

            step = sval;
            break;
        }
K
Kevin Wolf 已提交
3967 3968 3969 3970 3971 3972 3973 3974
        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 已提交
3975 3976 3977 3978
        case 'w':
            flags |= BDRV_O_RDWR;
            is_write = true;
            break;
3979 3980 3981
        case 'U':
            force_share = true;
            break;
K
Kevin Wolf 已提交
3982 3983
        case OPTION_PATTERN:
        {
3984 3985 3986
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
K
Kevin Wolf 已提交
3987 3988 3989
                error_report("Invalid pattern byte specified");
                return 1;
            }
3990
            pattern = res;
K
Kevin Wolf 已提交
3991 3992
            break;
        }
3993 3994
        case OPTION_FLUSH_INTERVAL:
        {
3995 3996 3997
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
3998 3999 4000
                error_report("Invalid flush interval specified");
                return 1;
            }
4001
            flush_interval = res;
4002 4003 4004 4005 4006
            break;
        }
        case OPTION_NO_DRAIN:
            drain_on_flush = false;
            break;
K
Kevin Wolf 已提交
4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
        }
    }

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

4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028
    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;
    }

4029 4030
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   force_share);
K
Kevin Wolf 已提交
4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042
    if (!blk) {
        ret = -1;
        goto out;
    }

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

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

    data.buf = blk_blockalign(blk, data.nrreq * data.bufsize);
K
Kevin Wolf 已提交
4063 4064
    memset(data.buf, pattern, data.nrreq * data.bufsize);

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

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

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

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

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

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;

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

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

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

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

    return 0;
}

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

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

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

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

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

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

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

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

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

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

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

4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682
static void dump_json_block_measure_info(BlockMeasureInfo *info)
{
    QString *str;
    QObject *obj;
    Visitor *v = qobject_output_visitor_new(&obj);

    visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
    visit_complete(v, &obj);
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
    visit_free(v);
    QDECREF(str);
}

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

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

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

    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
                          NULL, NULL)) {
        goto out;
    }

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

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

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

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

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

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

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

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

    ret = 0;

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

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

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

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

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

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

4720
    qcrypto_init(&error_fatal);
4721

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

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

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

4753
    cmdname = argv[optind];
4754

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

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

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

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