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

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

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

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

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

71
/* Default to cache=writeback as data integrity is not important for qemu-img */
72
#define BDRV_DEFAULT_CACHE "writeback"
73

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

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

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

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

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

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

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

B
bellard 已提交
232

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

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

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

257 258
    qemu_opts_print_help(create_opts);
    qemu_opts_free(create_opts);
259 260 261
    return 0;
}

262 263

static int img_open_password(BlockBackend *blk, const char *filename,
264
                             int flags, bool quiet)
265 266 267
{
    BlockDriverState *bs;
    char password[256];
268 269

    bs = blk_bs(blk);
270 271
    if (bdrv_is_encrypted(bs) && bdrv_key_required(bs) &&
        !(flags & BDRV_O_NO_IO)) {
272 273 274 275 276 277 278 279 280 281 282 283 284 285
        qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
        if (qemu_read_password(password, sizeof(password)) < 0) {
            error_report("No password given");
            return -1;
        }
        if (bdrv_set_key(bs, password) < 0) {
            error_report("invalid password");
            return -1;
        }
    }
    return 0;
}


286
static BlockBackend *img_open_opts(const char *optstr,
287
                                   QemuOpts *opts, int flags, bool writethrough,
288
                                   bool quiet, bool force_share)
289 290 291 292 293
{
    QDict *options;
    Error *local_err = NULL;
    BlockBackend *blk;
    options = qemu_opts_to_qdict(opts, NULL);
294 295 296 297
    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");
298
            QDECREF(options);
299 300
            return NULL;
        }
301
        qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
302
    }
303
    blk = blk_new_open(NULL, NULL, options, flags, &local_err);
304
    if (!blk) {
305
        error_reportf_err(local_err, "Could not open '%s': ", optstr);
306 307
        return NULL;
    }
308
    blk_set_enable_write_cache(blk, !writethrough);
309

310
    if (img_open_password(blk, optstr, flags, quiet) < 0) {
311 312 313 314 315 316
        blk_unref(blk);
        return NULL;
    }
    return blk;
}

317
static BlockBackend *img_open_file(const char *filename,
318
                                   QDict *options,
319
                                   const char *fmt, int flags,
320 321
                                   bool writethrough, bool quiet,
                                   bool force_share)
322 323
{
    BlockBackend *blk;
324
    Error *local_err = NULL;
325

326 327 328
    if (!options) {
        options = qdict_new();
    }
329
    if (fmt) {
330
        qdict_put_str(options, "driver", fmt);
331
    }
332

333
    if (force_share) {
334
        qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
335
    }
336
    blk = blk_new_open(filename, NULL, options, flags, &local_err);
337
    if (!blk) {
338
        error_reportf_err(local_err, "Could not open '%s': ", filename);
339
        return NULL;
340
    }
341
    blk_set_enable_write_cache(blk, !writethrough);
342

343
    if (img_open_password(blk, filename, flags, quiet) < 0) {
344 345 346 347 348 349 350
        blk_unref(blk);
        return NULL;
    }
    return blk;
}


351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
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")) {
        qdict_put(options, name, qstring_from_str(value));
    }

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


380
static BlockBackend *img_open(bool image_opts,
381
                              const char *filename,
382
                              const char *fmt, int flags, bool writethrough,
383
                              bool quiet, bool force_share)
384 385 386 387 388 389 390 391 392 393 394 395 396
{
    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;
        }
397 398
        blk = img_open_opts(filename, opts, flags, writethrough, quiet,
                            force_share);
399
    } else {
400
        blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
401
                            force_share);
402
    }
403
    return blk;
404 405
}

406

407
static int add_old_style_options(const char *fmt, QemuOpts *opts,
408 409
                                 const char *base_filename,
                                 const char *base_fmt)
410
{
411 412
    Error *err = NULL;

413
    if (base_filename) {
414
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
415
        if (err) {
416 417
            error_report("Backing file not supported for file format '%s'",
                         fmt);
418
            error_free(err);
419
            return -1;
420 421 422
        }
    }
    if (base_fmt) {
423
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
424
        if (err) {
425 426
            error_report("Backing file format not supported for file "
                         "format '%s'", fmt);
427
            error_free(err);
428
            return -1;
429 430
        }
    }
431
    return 0;
432 433
}

434 435
static int64_t cvtnum(const char *s)
{
436
    int err;
437
    uint64_t value;
438

439 440 441 442
    err = qemu_strtosz(s, NULL, &value);
    if (err < 0) {
        return err;
    }
443 444 445
    if (value > INT64_MAX) {
        return -ERANGE;
    }
446
    return value;
447 448
}

B
bellard 已提交
449 450
static int img_create(int argc, char **argv)
{
451
    int c;
452
    uint64_t img_size = -1;
B
bellard 已提交
453
    const char *fmt = "raw";
454
    const char *base_fmt = NULL;
B
bellard 已提交
455 456
    const char *filename;
    const char *base_filename = NULL;
457
    char *options = NULL;
458
    Error *local_err = NULL;
459
    bool quiet = false;
460

B
bellard 已提交
461
    for(;;) {
462 463 464 465 466
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
            {0, 0, 0, 0}
        };
467
        c = getopt_long(argc, argv, ":F:b:f:ho:q",
468
                        long_options, NULL);
469
        if (c == -1) {
B
bellard 已提交
470
            break;
471
        }
B
bellard 已提交
472
        switch(c) {
473 474 475
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
476
        case '?':
477 478
            unrecognized_option(argv[optind - 1]);
            break;
B
bellard 已提交
479 480 481
        case 'h':
            help();
            break;
482 483 484
        case 'F':
            base_fmt = optarg;
            break;
B
bellard 已提交
485 486 487 488 489 490
        case 'b':
            base_filename = optarg;
            break;
        case 'f':
            fmt = optarg;
            break;
491
        case 'o':
492 493 494 495 496 497 498 499 500 501 502
            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);
            }
503
            break;
504 505 506
        case 'q':
            quiet = true;
            break;
507 508 509 510 511 512 513 514
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                goto fail;
            }
        }   break;
B
bellard 已提交
515 516
        }
    }
517

518
    /* Get the filename */
519 520 521 522 523 524
    filename = (optind < argc) ? argv[optind] : NULL;
    if (options && has_help_option(options)) {
        g_free(options);
        return print_block_option_help(filename, fmt);
    }

525
    if (optind >= argc) {
F
Fam Zheng 已提交
526
        error_exit("Expecting image file name");
527
    }
528
    optind++;
529

530 531
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
532
                          NULL, NULL)) {
533 534 535
        goto fail;
    }

536 537
    /* Get image size, if specified */
    if (optind < argc) {
538
        int64_t sval;
539 540 541

        sval = cvtnum(argv[optind++]);
        if (sval < 0) {
542 543 544 545
            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, "
546 547 548
                      "G, T, P or E suffixes for ");
                error_report("kilobytes, megabytes, gigabytes, terabytes, "
                             "petabytes and exabytes.");
549
            }
550
            goto fail;
551 552 553
        }
        img_size = (uint64_t)sval;
    }
554
    if (optind != argc) {
F
Fam Zheng 已提交
555
        error_exit("Unexpected argument: %s", argv[optind]);
556
    }
557

558
    bdrv_img_create(filename, fmt, base_filename, base_fmt,
559
                    options, img_size, 0, quiet, &local_err);
560
    if (local_err) {
561
        error_reportf_err(local_err, "%s: ", filename);
562
        goto fail;
563
    }
564

565
    g_free(options);
B
bellard 已提交
566
    return 0;
567 568 569 570

fail:
    g_free(options);
    return 1;
B
bellard 已提交
571 572
}

573
static void dump_json_image_check(ImageCheck *check, bool quiet)
574 575 576
{
    QString *str;
    QObject *obj;
577
    Visitor *v = qobject_output_visitor_new(&obj);
578 579 580

    visit_type_ImageCheck(v, NULL, &check, &error_abort);
    visit_complete(v, &obj);
581 582
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
583
    qprintf(quiet, "%s\n", qstring_get_str(str));
584
    qobject_decref(obj);
585
    visit_free(v);
586 587 588
    QDECREF(str);
}

589
static void dump_human_image_check(ImageCheck *check, bool quiet)
590 591
{
    if (!(check->corruptions || check->leaks || check->check_errors)) {
592
        qprintf(quiet, "No errors were found on the image.\n");
593 594
    } else {
        if (check->corruptions) {
595 596 597 598
            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);
599 600 601
        }

        if (check->leaks) {
602 603 604 605
            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);
606 607 608
        }

        if (check->check_errors) {
609 610 611 612
            qprintf(quiet,
                    "\n%" PRId64
                    " internal errors have occurred during the check.\n",
                    check->check_errors);
613 614 615 616
        }
    }

    if (check->total_clusters != 0 && check->allocated_clusters != 0) {
617 618 619 620 621 622 623
        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);
624 625 626
    }

    if (check->image_end_offset) {
627 628
        qprintf(quiet,
                "Image end offset: %" PRId64 "\n", check->image_end_offset);
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
    }
}

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;
665 666
    check->compressed_clusters      = result.bfi.compressed_clusters;
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
667 668 669 670

    return 0;
}

671 672 673
/*
 * Checks an image for consistency. Exit codes:
 *
M
Max Reitz 已提交
674 675 676 677 678
 *  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
679
 */
680 681 682
static int img_check(int argc, char **argv)
{
    int c, ret;
683
    OutputFormat output_format = OFORMAT_HUMAN;
684
    const char *filename, *fmt, *output, *cache;
M
Markus Armbruster 已提交
685
    BlockBackend *blk;
686
    BlockDriverState *bs;
687
    int fix = 0;
688 689
    int flags = BDRV_O_CHECK;
    bool writethrough;
690
    ImageCheck *check;
691
    bool quiet = false;
692
    bool image_opts = false;
693
    bool force_share = false;
694 695

    fmt = NULL;
696
    output = NULL;
697
    cache = BDRV_DEFAULT_CACHE;
698

699
    for(;;) {
700 701 702 703
        int option_index = 0;
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"format", required_argument, 0, 'f'},
704
            {"repair", required_argument, 0, 'r'},
705
            {"output", required_argument, 0, OPTION_OUTPUT},
706
            {"object", required_argument, 0, OPTION_OBJECT},
707
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
708
            {"force-share", no_argument, 0, 'U'},
709 710
            {0, 0, 0, 0}
        };
711
        c = getopt_long(argc, argv, ":hf:r:T:qU",
712
                        long_options, &option_index);
713
        if (c == -1) {
714
            break;
715
        }
716
        switch(c) {
717 718 719
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
720
        case '?':
721 722
            unrecognized_option(argv[optind - 1]);
            break;
723 724 725 726 727 728
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
729 730 731 732 733 734 735 736
        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 已提交
737 738
                error_exit("Unknown option value for -r "
                           "(expecting 'leaks' or 'all'): %s", optarg);
739 740
            }
            break;
741 742 743
        case OPTION_OUTPUT:
            output = optarg;
            break;
744 745 746
        case 'T':
            cache = optarg;
            break;
747 748 749
        case 'q':
            quiet = true;
            break;
750 751 752
        case 'U':
            force_share = true;
            break;
753 754 755 756 757 758 759 760
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
761 762 763
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
764 765
        }
    }
766
    if (optind != argc - 1) {
F
Fam Zheng 已提交
767
        error_exit("Expecting one image file name");
768
    }
769 770
    filename = argv[optind++];

771 772 773 774 775 776 777 778 779
    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;
    }

780 781
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
782
                          NULL, NULL)) {
783 784 785
        return 1;
    }

786
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
787 788 789 790 791
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        return 1;
    }

792 793
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   force_share);
794 795
    if (!blk) {
        return 1;
796
    }
797
    bs = blk_bs(blk);
798 799 800

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
801 802

    if (ret == -ENOTSUP) {
803
        error_report("This image format does not support checks");
804
        ret = 63;
805
        goto fail;
806 807
    }

808 809
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
810

811 812
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
813

814
        if (output_format == OFORMAT_HUMAN) {
815 816 817 818 819 820 821
            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);
822 823
        }

824
        ret = collect_image_check(bs, check, filename, fmt, 0);
825

826 827
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
828 829
    }

M
Max Reitz 已提交
830 831 832 833 834 835 836 837 838
    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;
        }
839 840
    }

841
    if (ret || check->check_errors) {
M
Max Reitz 已提交
842 843 844 845 846
        if (ret) {
            error_report("Check failed: %s", strerror(-ret));
        } else {
            error_report("Check failed");
        }
847 848
        ret = 1;
        goto fail;
849
    }
850

851 852 853 854
    if (check->corruptions) {
        ret = 2;
    } else if (check->leaks) {
        ret = 3;
855
    } else {
856
        ret = 0;
857
    }
858 859 860

fail:
    qapi_free_ImageCheck(check);
M
Markus Armbruster 已提交
861
    blk_unref(blk);
862
    return ret;
863 864
}

M
Max Reitz 已提交
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
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 已提交
881
    AioContext *aio_context = blk_get_aio_context(job->blk);
882
    int ret = 0;
M
Max Reitz 已提交
883

884
    aio_context_acquire(aio_context);
885
    block_job_ref(job);
M
Max Reitz 已提交
886 887
    do {
        aio_poll(aio_context, true);
888 889
        qemu_progress_print(job->len ?
                            ((float)job->offset / job->len * 100.f) : 0.0f, 0);
890
    } while (!job->ready && !job->completed);
M
Max Reitz 已提交
891

892 893 894 895 896 897
    if (!job->completed) {
        ret = block_job_complete_sync(job, errp);
    } else {
        ret = job->ret;
    }
    block_job_unref(job);
898
    aio_context_release(aio_context);
899

900 901 902 903
    /* publish completion progress only when success */
    if (!ret) {
        qemu_progress_print(100.f, 0);
    }
M
Max Reitz 已提交
904 905
}

B
bellard 已提交
906 907
static int img_commit(int argc, char **argv)
{
908
    int c, ret, flags;
909
    const char *filename, *fmt, *cache, *base;
M
Markus Armbruster 已提交
910
    BlockBackend *blk;
M
Max Reitz 已提交
911
    BlockDriverState *bs, *base_bs;
912
    BlockJob *job;
913
    bool progress = false, quiet = false, drop = false;
914
    bool writethrough;
M
Max Reitz 已提交
915 916
    Error *local_err = NULL;
    CommonBlockJobCBInfo cbi;
917
    bool image_opts = false;
918
    AioContext *aio_context;
B
bellard 已提交
919 920

    fmt = NULL;
921
    cache = BDRV_DEFAULT_CACHE;
922
    base = NULL;
B
bellard 已提交
923
    for(;;) {
924 925 926
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
927
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
928 929
            {0, 0, 0, 0}
        };
930
        c = getopt_long(argc, argv, ":f:ht:b:dpq",
931
                        long_options, NULL);
932
        if (c == -1) {
B
bellard 已提交
933
            break;
934
        }
B
bellard 已提交
935
        switch(c) {
936 937 938
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
939
        case '?':
940 941
            unrecognized_option(argv[optind - 1]);
            break;
B
bellard 已提交
942 943 944 945 946 947
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
948 949 950
        case 't':
            cache = optarg;
            break;
951 952 953 954 955
        case 'b':
            base = optarg;
            /* -b implies -d */
            drop = true;
            break;
M
Max Reitz 已提交
956 957 958
        case 'd':
            drop = true;
            break;
959 960 961
        case 'p':
            progress = true;
            break;
962 963 964
        case 'q':
            quiet = true;
            break;
965 966 967 968 969 970 971 972
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
973 974 975
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
B
bellard 已提交
976 977
        }
    }
978 979 980 981 982 983

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

984
    if (optind != argc - 1) {
F
Fam Zheng 已提交
985
        error_exit("Expecting one image file name");
986
    }
B
bellard 已提交
987 988
    filename = argv[optind++];

989 990
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
991
                          NULL, NULL)) {
992 993 994
        return 1;
    }

M
Max Reitz 已提交
995
    flags = BDRV_O_RDWR | BDRV_O_UNMAP;
996
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
997 998
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
999
        return 1;
1000 1001
    }

1002 1003
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   false);
1004 1005
    if (!blk) {
        return 1;
1006
    }
1007 1008
    bs = blk_bs(blk);

1009 1010 1011
    qemu_progress_init(progress, 1.f);
    qemu_progress_print(0.f, 100);

1012 1013 1014
    if (base) {
        base_bs = bdrv_find_backing_image(bs, base);
        if (!base_bs) {
1015 1016 1017
            error_setg(&local_err,
                       "Did not find '%s' in the backing chain of '%s'",
                       base, filename);
1018 1019 1020 1021 1022 1023
            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. */
1024
        base_bs = backing_bs(bs);
1025 1026 1027 1028
        if (!base_bs) {
            error_setg(&local_err, "Image does not have a backing file");
            goto done;
        }
M
Max Reitz 已提交
1029 1030 1031 1032 1033 1034 1035
    }

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

1036 1037
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);
1038
    commit_active_start("commit", bs, base_bs, BLOCK_JOB_DEFAULT, 0,
1039
                        BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
1040
                        &cbi, false, &local_err);
1041
    aio_context_release(aio_context);
M
Max Reitz 已提交
1042 1043
    if (local_err) {
        goto done;
B
bellard 已提交
1044 1045
    }

1046 1047 1048 1049
    /* 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 已提交
1050
    if (!drop) {
1051
        bdrv_ref(bs);
M
Max Reitz 已提交
1052 1053
    }

1054 1055
    job = block_job_get("commit");
    run_block_job(job, &local_err);
M
Max Reitz 已提交
1056 1057 1058 1059
    if (local_err) {
        goto unref_backing;
    }

1060 1061
    if (!drop && bs->drv->bdrv_make_empty) {
        ret = bs->drv->bdrv_make_empty(bs);
M
Max Reitz 已提交
1062 1063 1064 1065 1066 1067 1068 1069 1070
        if (ret) {
            error_setg_errno(&local_err, -ret, "Could not empty %s",
                             filename);
            goto unref_backing;
        }
    }

unref_backing:
    if (!drop) {
1071
        bdrv_unref(bs);
M
Max Reitz 已提交
1072
    }
M
Max Reitz 已提交
1073 1074

done:
1075 1076
    qemu_progress_end();

M
Markus Armbruster 已提交
1077
    blk_unref(blk);
M
Max Reitz 已提交
1078 1079

    if (local_err) {
1080
        error_report_err(local_err);
1081 1082
        return 1;
    }
M
Max Reitz 已提交
1083 1084

    qprintf(quiet, "Image committed.\n");
B
bellard 已提交
1085 1086 1087
    return 0;
}

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

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

1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
/*
 * Like is_allocated_sectors, but if the buffer starts with a used sector,
 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
 * breaking up write requests for only small sparse areas.
 */
static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
    int min)
{
    int ret;
    int num_checked, num_used;

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

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

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

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

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

    *pnum = num_used;
    return 1;
}

K
Kevin Wolf 已提交
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
/*
 * 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)
{
1167 1168
    bool res;
    int i;
K
Kevin Wolf 已提交
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188

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

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

1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
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.
 *
1207
 * @param blk:  BlockBackend for the image
1208 1209 1210 1211 1212 1213
 * @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
 */
1214
static int check_empty_sectors(BlockBackend *blk, int64_t sect_num,
1215 1216 1217 1218
                               int sect_count, const char *filename,
                               uint8_t *buffer, bool quiet)
{
    int pnum, ret = 0;
1219 1220
    ret = blk_pread(blk, sect_num << BDRV_SECTOR_BITS, buffer,
                    sect_count << BDRV_SECTOR_BITS);
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
    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)
{
1245
    const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
M
Markus Armbruster 已提交
1246
    BlockBackend *blk1, *blk2;
1247 1248 1249 1250 1251 1252 1253
    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;
1254
    int flags;
1255
    bool writethrough;
1256 1257 1258 1259 1260
    int64_t total_sectors;
    int64_t sector_num = 0;
    int64_t nb_sectors;
    int c, pnum;
    uint64_t progress_base;
1261
    bool image_opts = false;
1262
    bool force_share = false;
1263

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

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


1330
    if (optind != argc - 2) {
F
Fam Zheng 已提交
1331
        error_exit("Expecting two image file names");
1332 1333 1334 1335
    }
    filename1 = argv[optind++];
    filename2 = argv[optind++];

1336 1337
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
1338
                          NULL, NULL)) {
1339 1340 1341 1342
        ret = 2;
        goto out4;
    }

1343 1344 1345
    /* Initialize before goto out */
    qemu_progress_init(progress, 2.0);

1346 1347
    flags = 0;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1348 1349 1350 1351 1352 1353
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        ret = 2;
        goto out3;
    }

1354 1355
    blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
                    force_share);
1356
    if (!blk1) {
1357
        ret = 2;
1358
        goto out3;
1359 1360
    }

1361 1362
    blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
                    force_share);
1363
    if (!blk2) {
1364
        ret = 2;
1365
        goto out2;
1366
    }
1367
    bs1 = blk_bs(blk1);
1368
    bs2 = blk_bs(blk2);
1369

1370 1371 1372
    buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
    buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
    total_sectors1 = blk_nb_sectors(blk1);
1373 1374 1375 1376 1377 1378
    if (total_sectors1 < 0) {
        error_report("Can't get size of %s: %s",
                     filename1, strerror(-total_sectors1));
        ret = 4;
        goto out;
    }
1379
    total_sectors2 = blk_nb_sectors(blk2);
1380 1381 1382 1383 1384 1385
    if (total_sectors2 < 0) {
        error_report("Can't get size of %s: %s",
                     filename2, strerror(-total_sectors2));
        ret = 4;
        goto out;
    }
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397
    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 (;;) {
1398
        int64_t status1, status2;
1399 1400
        BlockDriverState *file;

1401 1402 1403 1404
        nb_sectors = sectors_to_process(total_sectors, sector_num);
        if (nb_sectors <= 0) {
            break;
        }
1405 1406
        status1 = bdrv_get_block_status_above(bs1, NULL, sector_num,
                                              total_sectors1 - sector_num,
1407
                                              &pnum1, &file);
1408
        if (status1 < 0) {
1409 1410 1411 1412
            ret = 3;
            error_report("Sector allocation test failed for %s", filename1);
            goto out;
        }
1413
        allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1414

1415 1416
        status2 = bdrv_get_block_status_above(bs2, NULL, sector_num,
                                              total_sectors2 - sector_num,
1417
                                              &pnum2, &file);
1418
        if (status2 < 0) {
1419 1420 1421 1422
            ret = 3;
            error_report("Sector allocation test failed for %s", filename2);
            goto out;
        }
1423 1424 1425 1426 1427 1428 1429
        allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
        if (pnum1) {
            nb_sectors = MIN(nb_sectors, pnum1);
        }
        if (pnum2) {
            nb_sectors = MIN(nb_sectors, pnum2);
        }
1430

1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
        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) {
1444
            if (allocated1) {
1445 1446
                ret = blk_pread(blk1, sector_num << BDRV_SECTOR_BITS, buf1,
                                nb_sectors << BDRV_SECTOR_BITS);
1447 1448 1449 1450 1451 1452 1453
                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;
                }
1454 1455
                ret = blk_pread(blk2, sector_num << BDRV_SECTOR_BITS, buf2,
                                nb_sectors << BDRV_SECTOR_BITS);
1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
                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));
1468
                    ret = 1;
1469 1470 1471 1472 1473 1474
                    goto out;
                }
            }
        } else {

            if (allocated1) {
1475
                ret = check_empty_sectors(blk1, sector_num, nb_sectors,
1476 1477
                                          filename1, buf1, quiet);
            } else {
1478
                ret = check_empty_sectors(blk2, sector_num, nb_sectors,
1479 1480 1481 1482 1483 1484
                                          filename2, buf1, quiet);
            }
            if (ret) {
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64 ": %s",
                                 sectors_to_bytes(sector_num), strerror(-ret));
1485
                    ret = 4;
1486 1487 1488 1489 1490 1491 1492 1493 1494
                }
                goto out;
            }
        }
        sector_num += nb_sectors;
        qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
    }

    if (total_sectors1 != total_sectors2) {
1495
        BlockBackend *blk_over;
1496 1497 1498 1499 1500 1501
        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;
1502
            blk_over = blk1;
1503 1504 1505
            filename_over = filename1;
        } else {
            total_sectors_over = total_sectors2;
1506
            blk_over = blk2;
1507 1508 1509 1510 1511 1512 1513 1514
            filename_over = filename2;
        }

        for (;;) {
            nb_sectors = sectors_to_process(total_sectors_over, sector_num);
            if (nb_sectors <= 0) {
                break;
            }
1515
            ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
1516 1517 1518 1519 1520 1521 1522 1523 1524 1525
                                          nb_sectors, &pnum);
            if (ret < 0) {
                ret = 3;
                error_report("Sector allocation test failed for %s",
                             filename_over);
                goto out;

            }
            nb_sectors = pnum;
            if (ret) {
1526
                ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
1527 1528 1529 1530 1531 1532
                                          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));
1533
                        ret = 4;
1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548
                    }
                    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 已提交
1549
    blk_unref(blk2);
1550
out2:
M
Markus Armbruster 已提交
1551
    blk_unref(blk1);
1552 1553
out3:
    qemu_progress_end();
1554
out4:
1555 1556 1557
    return ret;
}

1558 1559 1560 1561 1562 1563
enum ImgConvertBlockStatus {
    BLK_DATA,
    BLK_ZERO,
    BLK_BACKING_FILE,
};

P
Peter Lieven 已提交
1564 1565
#define MAX_COROUTINES 16

1566 1567 1568
typedef struct ImgConvertState {
    BlockBackend **src;
    int64_t *src_sectors;
P
Peter Lieven 已提交
1569
    int src_num;
1570 1571
    int64_t total_sectors;
    int64_t allocated_sectors;
P
Peter Lieven 已提交
1572 1573 1574
    int64_t allocated_done;
    int64_t sector_num;
    int64_t wr_offs;
1575 1576 1577 1578 1579 1580
    enum ImgConvertBlockStatus status;
    int64_t sector_next_status;
    BlockBackend *target;
    bool has_zero_init;
    bool compressed;
    bool target_has_backing;
P
Peter Lieven 已提交
1581
    bool wr_in_order;
1582 1583 1584
    int min_sparse;
    size_t cluster_sectors;
    size_t buf_sectors;
P
Peter Lieven 已提交
1585
    long num_coroutines;
P
Peter Lieven 已提交
1586 1587 1588 1589 1590
    int running_coroutines;
    Coroutine *co[MAX_COROUTINES];
    int64_t wait_sector_num[MAX_COROUTINES];
    CoMutex lock;
    int ret;
1591 1592
} ImgConvertState;

P
Peter Lieven 已提交
1593 1594
static void convert_select_part(ImgConvertState *s, int64_t sector_num,
                                int *src_cur, int64_t *src_cur_offset)
1595
{
P
Peter Lieven 已提交
1596 1597 1598 1599 1600 1601
    *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);
1602 1603 1604 1605 1606
    }
}

static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
{
P
Peter Lieven 已提交
1607 1608
    int64_t ret, src_cur_offset;
    int n, src_cur;
1609

P
Peter Lieven 已提交
1610
    convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1611 1612 1613 1614 1615

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

    if (s->sector_next_status <= sector_num) {
1616
        BlockDriverState *file;
1617 1618 1619 1620 1621 1622 1623 1624 1625
        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);
        }
1626 1627 1628 1629 1630 1631 1632 1633 1634
        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 {
1635
            s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660
        }

        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 已提交
1661 1662
static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
                                        int nb_sectors, uint8_t *buf)
1663
{
P
Peter Lieven 已提交
1664 1665 1666
    int n, ret;
    QEMUIOVector qiov;
    struct iovec iov;
1667 1668 1669 1670

    assert(nb_sectors <= s->buf_sectors);
    while (nb_sectors > 0) {
        BlockBackend *blk;
P
Peter Lieven 已提交
1671 1672
        int src_cur;
        int64_t bs_sectors, src_cur_offset;
1673 1674 1675 1676

        /* 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 已提交
1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688
        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);
1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700
        if (ret < 0) {
            return ret;
        }

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

    return 0;
}

P
Peter Lieven 已提交
1701 1702 1703 1704

static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
                                         int nb_sectors, uint8_t *buf,
                                         enum ImgConvertBlockStatus status)
1705 1706
{
    int ret;
P
Peter Lieven 已提交
1707 1708
    QEMUIOVector qiov;
    struct iovec iov;
1709 1710 1711

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

P
Peter Lieven 已提交
1714
        switch (status) {
1715 1716 1717 1718 1719 1720 1721 1722
        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:
1723 1724 1725 1726 1727 1728
            /* 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. */
1729
            if (!s->min_sparse ||
1730 1731 1732 1733
                (!s->compressed &&
                 is_allocated_sectors_min(buf, n, &n, s->min_sparse)) ||
                (s->compressed &&
                 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
1734
            {
P
Peter Lieven 已提交
1735 1736 1737 1738 1739
                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,
1740
                                     n << BDRV_SECTOR_BITS, &qiov, flags);
1741 1742 1743 1744 1745 1746 1747 1748 1749
                if (ret < 0) {
                    return ret;
                }
                break;
            }
            /* fall-through */

        case BLK_ZERO:
            if (s->has_zero_init) {
1750
                assert(!s->target_has_backing);
1751 1752
                break;
            }
P
Peter Lieven 已提交
1753 1754 1755
            ret = blk_co_pwrite_zeroes(s->target,
                                       sector_num << BDRV_SECTOR_BITS,
                                       n << BDRV_SECTOR_BITS, 0);
1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769
            if (ret < 0) {
                return ret;
            }
            break;
        }

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

    return 0;
}

P
Peter Lieven 已提交
1770
static void coroutine_fn convert_co_do_copy(void *opaque)
1771
{
P
Peter Lieven 已提交
1772
    ImgConvertState *s = opaque;
1773
    uint8_t *buf = NULL;
P
Peter Lieven 已提交
1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795
    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);
1796
            break;
P
Peter Lieven 已提交
1797 1798 1799 1800 1801
        }
        n = convert_iteration_sectors(s, s->sector_num);
        if (n < 0) {
            qemu_co_mutex_unlock(&s->lock);
            s->ret = n;
1802
            break;
P
Peter Lieven 已提交
1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834
        }
        /* 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 */
1835
            while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
P
Peter Lieven 已提交
1836 1837 1838 1839 1840 1841
                s->wait_sector_num[index] = sector_num;
                qemu_coroutine_yield();
            }
            s->wait_sector_num[index] = -1;
        }

1842 1843 1844 1845 1846 1847 1848
        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 已提交
1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881
        }

        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;
1882 1883 1884 1885 1886 1887 1888 1889 1890

    /* 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)))
    {
1891
        ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP);
1892 1893 1894 1895 1896 1897 1898 1899 1900 1901
        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 已提交
1902
            return -EINVAL;
1903 1904 1905 1906 1907 1908 1909
        }
        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 已提交
1910
            return n;
1911
        }
1912 1913
        if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
        {
1914 1915 1916 1917 1918 1919 1920
            s->allocated_sectors += n;
        }
        sector_num += n;
    }

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

P
Peter Lieven 已提交
1923 1924 1925 1926 1927 1928
    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]);
    }
1929

1930
    while (s->running_coroutines) {
P
Peter Lieven 已提交
1931
        main_loop_wait(false);
1932 1933
    }

P
Peter Lieven 已提交
1934
    if (s->compressed && !s->ret) {
1935
        /* signal EOF to align */
1936
        ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
1937
        if (ret < 0) {
P
Peter Lieven 已提交
1938
            return ret;
1939 1940 1941
        }
    }

P
Peter Lieven 已提交
1942
    return s->ret;
1943 1944
}

B
bellard 已提交
1945 1946
static int img_convert(int argc, char **argv)
{
P
Peter Lieven 已提交
1947
    int c, bs_i, flags, src_flags = 0;
1948
    const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
P
Peter Lieven 已提交
1949 1950
               *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
               *out_filename, *out_baseimg_param, *snapshot_name = NULL;
1951
    BlockDriver *drv = NULL, *proto_drv = NULL;
B
bellard 已提交
1952
    BlockDriverInfo bdi;
P
Peter Lieven 已提交
1953 1954
    BlockDriverState *out_bs;
    QemuOpts *opts = NULL, *sn_opts = NULL;
1955
    QemuOptsList *create_opts = NULL;
1956
    char *options = NULL;
1957
    Error *local_err = NULL;
P
Peter Lieven 已提交
1958
    bool writethrough, src_writethrough, quiet = false, image_opts = false,
1959
         skip_create = false, progress = false, tgt_image_opts = false;
P
Peter Lieven 已提交
1960
    int64_t ret = -EINVAL;
1961
    bool force_share = false;
P
Peter Lieven 已提交
1962 1963 1964 1965 1966 1967 1968 1969

    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 已提交
1970 1971

    for(;;) {
1972 1973 1974
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
1975
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1976
            {"force-share", no_argument, 0, 'U'},
1977
            {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
1978 1979
            {0, 0, 0, 0}
        };
1980
        c = getopt_long(argc, argv, ":hf:O:B:co:s:l:S:pt:T:qnm:WU",
1981
                        long_options, NULL);
1982
        if (c == -1) {
B
bellard 已提交
1983
            break;
1984
        }
B
bellard 已提交
1985
        switch(c) {
1986 1987 1988
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
1989
        case '?':
1990 1991
            unrecognized_option(argv[optind - 1]);
            break;
B
bellard 已提交
1992 1993 1994 1995 1996 1997 1998 1999 2000
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'O':
            out_fmt = optarg;
            break;
2001 2002 2003
        case 'B':
            out_baseimg = optarg;
            break;
B
bellard 已提交
2004
        case 'c':
P
Peter Lieven 已提交
2005
            s.compressed = true;
B
bellard 已提交
2006
            break;
2007
        case 'o':
2008 2009
            if (!is_valid_option_list(optarg)) {
                error_report("Invalid option list: %s", optarg);
2010
                goto fail_getopt;
2011 2012 2013 2014 2015 2016 2017 2018
            }
            if (!options) {
                options = g_strdup(optarg);
            } else {
                char *old_options = options;
                options = g_strdup_printf("%s,%s", options, optarg);
                g_free(old_options);
            }
2019
            break;
E
edison 已提交
2020 2021 2022
        case 's':
            snapshot_name = optarg;
            break;
2023 2024
        case 'l':
            if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
2025 2026
                sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
                                                  optarg, false);
2027 2028 2029
                if (!sn_opts) {
                    error_report("Failed in parsing snapshot param '%s'",
                                 optarg);
2030
                    goto fail_getopt;
2031 2032 2033 2034 2035
                }
            } else {
                snapshot_name = optarg;
            }
            break;
2036 2037 2038
        case 'S':
        {
            int64_t sval;
2039 2040 2041

            sval = cvtnum(optarg);
            if (sval < 0) {
2042
                error_report("Invalid minimum zero buffer size for sparse output specified");
2043
                goto fail_getopt;
2044 2045
            }

P
Peter Lieven 已提交
2046
            s.min_sparse = sval / BDRV_SECTOR_SIZE;
2047 2048
            break;
        }
2049
        case 'p':
P
Peter Lieven 已提交
2050
            progress = true;
2051
            break;
2052 2053 2054
        case 't':
            cache = optarg;
            break;
2055 2056 2057
        case 'T':
            src_cache = optarg;
            break;
2058 2059 2060
        case 'q':
            quiet = true;
            break;
2061
        case 'n':
P
Peter Lieven 已提交
2062
            skip_create = true;
2063
            break;
P
Peter Lieven 已提交
2064
        case 'm':
P
Peter Lieven 已提交
2065 2066
            if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
                s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
P
Peter Lieven 已提交
2067 2068 2069 2070 2071 2072
                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 已提交
2073
            s.wr_in_order = false;
P
Peter Lieven 已提交
2074
            break;
2075 2076 2077
        case 'U':
            force_share = true;
            break;
2078 2079 2080 2081 2082
        case OPTION_OBJECT: {
            QemuOpts *object_opts;
            object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                                  optarg, true);
            if (!object_opts) {
2083 2084 2085
                goto fail_getopt;
            }
            break;
2086
        }
2087 2088 2089
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
2090 2091 2092
        case OPTION_TARGET_IMAGE_OPTS:
            tgt_image_opts = true;
            break;
B
bellard 已提交
2093 2094
        }
    }
2095

2096 2097 2098 2099
    if (!out_fmt && !tgt_image_opts) {
        out_fmt = "raw";
    }

2100 2101
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2102
                          NULL, NULL)) {
2103 2104 2105
        goto fail_getopt;
    }

P
Peter Lieven 已提交
2106
    if (!s.wr_in_order && s.compressed) {
P
Peter Lieven 已提交
2107 2108 2109 2110
        error_report("Out of order write and compress are mutually exclusive");
        goto fail_getopt;
    }

2111 2112 2113 2114 2115
    if (tgt_image_opts && !skip_create) {
        error_report("--target-image-opts requires use of -n flag");
        goto fail_getopt;
    }

P
Peter Lieven 已提交
2116 2117
    s.src_num = argc - optind - 1;
    out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2118

2119
    if (options && has_help_option(options)) {
2120 2121 2122 2123 2124 2125 2126
        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;
        }
2127 2128
    }

P
Peter Lieven 已提交
2129 2130 2131
    if (s.src_num < 1) {
        error_report("Must specify image file name");
        goto fail_getopt;
2132 2133 2134
    }


P
Peter Lieven 已提交
2135
    /* ret is still -EINVAL until here */
2136
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2137 2138
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
P
Peter Lieven 已提交
2139
        goto fail_getopt;
2140 2141
    }

P
Peter Lieven 已提交
2142 2143 2144 2145 2146
    /* Initialize before goto out */
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);
2147 2148
    qemu_progress_print(0, 100);

P
Peter Lieven 已提交
2149 2150
    s.src = g_new0(BlockBackend *, s.src_num);
    s.src_sectors = g_new(int64_t, s.src_num);
2151

P
Peter Lieven 已提交
2152 2153
    for (bs_i = 0; bs_i < s.src_num; bs_i++) {
        s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
2154 2155
                               fmt, src_flags, src_writethrough, quiet,
                               force_share);
P
Peter Lieven 已提交
2156
        if (!s.src[bs_i]) {
2157 2158 2159
            ret = -1;
            goto out;
        }
P
Peter Lieven 已提交
2160 2161
        s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
        if (s.src_sectors[bs_i] < 0) {
2162
            error_report("Could not get size of %s: %s",
P
Peter Lieven 已提交
2163
                         argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
2164 2165 2166
            ret = -1;
            goto out;
        }
P
Peter Lieven 已提交
2167
        s.total_sectors += s.src_sectors[bs_i];
2168
    }
B
bellard 已提交
2169

2170
    if (sn_opts) {
P
Peter Lieven 已提交
2171
        bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
2172 2173 2174
                               qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
                               qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
                               &local_err);
2175
    } else if (snapshot_name != NULL) {
P
Peter Lieven 已提交
2176
        if (s.src_num > 1) {
2177
            error_report("No support for concatenating multiple snapshot");
E
edison 已提交
2178 2179 2180
            ret = -1;
            goto out;
        }
2181

P
Peter Lieven 已提交
2182 2183
        bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
                                             &local_err);
2184
    }
2185
    if (local_err) {
2186
        error_reportf_err(local_err, "Failed to load snapshot: ");
2187 2188
        ret = -1;
        goto out;
E
edison 已提交
2189 2190
    }

2191 2192 2193 2194 2195 2196 2197 2198
    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;
        }
2199

2200 2201 2202 2203 2204 2205
        proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
        if (!proto_drv) {
            error_report_err(local_err);
            ret = -1;
            goto out;
        }
2206

M
Max Reitz 已提交
2207 2208 2209 2210 2211 2212
        if (!drv->create_opts) {
            error_report("Format driver '%s' does not support image creation",
                         drv->format_name);
            ret = -1;
            goto out;
        }
2213

M
Max Reitz 已提交
2214 2215 2216 2217 2218 2219
        if (!proto_drv->create_opts) {
            error_report("Protocol driver '%s' does not support image creation",
                         proto_drv->format_name);
            ret = -1;
            goto out;
        }
2220

M
Max Reitz 已提交
2221 2222
        create_opts = qemu_opts_append(create_opts, drv->create_opts);
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2223

M
Max Reitz 已提交
2224
        opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2225 2226 2227
        if (options) {
            qemu_opts_do_parse(opts, options, NULL, &local_err);
            if (local_err) {
2228
                error_report_err(local_err);
2229 2230 2231
                ret = -1;
                goto out;
            }
M
Max Reitz 已提交
2232
        }
2233

P
Peter Lieven 已提交
2234
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
2235
                            &error_abort);
M
Max Reitz 已提交
2236 2237 2238 2239
        ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
        if (ret < 0) {
            goto out;
        }
2240
    }
2241

2242
    /* Get backing file name if -o backing_file was used */
2243
    out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2244
    if (out_baseimg_param) {
2245
        out_baseimg = out_baseimg_param;
2246
    }
P
Peter Lieven 已提交
2247
    s.target_has_backing = (bool) out_baseimg;
2248

2249 2250 2251 2252 2253 2254 2255
    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;
    }

2256
    /* Check if compression is supported */
P
Peter Lieven 已提交
2257
    if (s.compressed) {
2258 2259 2260 2261
        bool encryption =
            qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
        const char *preallocation =
            qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2262

2263
        if (drv && !drv->bdrv_co_pwritev_compressed) {
2264
            error_report("Compression not supported for this file format");
2265 2266
            ret = -1;
            goto out;
2267 2268
        }

2269
        if (encryption) {
2270 2271
            error_report("Compression and encryption not supported at "
                         "the same time");
2272 2273
            ret = -1;
            goto out;
2274
        }
2275

2276 2277
        if (preallocation
            && strcmp(preallocation, "off"))
2278 2279 2280 2281 2282 2283
        {
            error_report("Compression and preallocation not supported at "
                         "the same time");
            ret = -1;
            goto out;
        }
2284 2285
    }

2286 2287
    if (!skip_create) {
        /* Create the new image */
C
Chunyan Liu 已提交
2288
        ret = bdrv_create(drv, out_filename, opts, &local_err);
2289
        if (ret < 0) {
2290 2291
            error_reportf_err(local_err, "%s: error while converting %s: ",
                              out_filename, out_fmt);
2292
            goto out;
B
bellard 已提交
2293 2294
        }
    }
2295

P
Peter Lieven 已提交
2296
    flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2297
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2298 2299
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2300
        goto out;
2301 2302
    }

2303 2304 2305 2306 2307 2308 2309 2310 2311
    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
         */
2312 2313
        s.target = img_open_new_file(out_filename, opts, out_fmt,
                                     flags, writethrough, quiet, false);
2314
    }
P
Peter Lieven 已提交
2315
    if (!s.target) {
2316 2317 2318
        ret = -1;
        goto out;
    }
P
Peter Lieven 已提交
2319
    out_bs = blk_bs(s.target);
B
bellard 已提交
2320

2321 2322 2323 2324 2325 2326
    if (s.compressed && !out_bs->drv->bdrv_co_pwritev_compressed) {
        error_report("Compression not supported for this file format");
        ret = -1;
        goto out;
    }

2327
    /* increase bufsectors from the default 4096 (2M) if opt_transfer
2328 2329
     * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
     * as maximum. */
P
Peter Lieven 已提交
2330 2331 2332 2333 2334
    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)));
2335

2336
    if (skip_create) {
P
Peter Lieven 已提交
2337
        int64_t output_sectors = blk_nb_sectors(s.target);
2338
        if (output_sectors < 0) {
2339
            error_report("unable to get output image length: %s",
2340
                         strerror(-output_sectors));
2341 2342
            ret = -1;
            goto out;
P
Peter Lieven 已提交
2343
        } else if (output_sectors < s.total_sectors) {
2344 2345 2346 2347 2348 2349
            error_report("output file is smaller than input file");
            ret = -1;
            goto out;
        }
    }

2350 2351
    ret = bdrv_get_info(out_bs, &bdi);
    if (ret < 0) {
P
Peter Lieven 已提交
2352
        if (s.compressed) {
2353
            error_report("could not get block driver info");
2354 2355
            goto out;
        }
2356
    } else {
P
Peter Lieven 已提交
2357 2358 2359
        s.compressed = s.compressed || bdi.needs_compressed_writes;
        s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
    }
2360

P
Peter Lieven 已提交
2361
    ret = convert_do_copy(&s);
2362
out:
2363 2364 2365
    if (!ret) {
        qemu_progress_print(100, 0);
    }
2366
    qemu_progress_end();
2367 2368
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
2369
    qemu_opts_del(sn_opts);
P
Peter Lieven 已提交
2370 2371 2372 2373
    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 已提交
2374
        }
P
Peter Lieven 已提交
2375
        g_free(s.src);
M
Markus Armbruster 已提交
2376
    }
P
Peter Lieven 已提交
2377
    g_free(s.src_sectors);
2378 2379 2380
fail_getopt:
    g_free(options);

P
Peter Lieven 已提交
2381
    return !!ret;
B
bellard 已提交
2382 2383
}

B
bellard 已提交
2384

B
bellard 已提交
2385 2386 2387 2388 2389 2390 2391 2392 2393
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");
2394 2395
    bdrv_snapshot_dump(fprintf, stdout, NULL);
    printf("\n");
B
bellard 已提交
2396 2397
    for(i = 0; i < nb_sns; i++) {
        sn = &sn_tab[i];
2398 2399
        bdrv_snapshot_dump(fprintf, stdout, sn);
        printf("\n");
B
bellard 已提交
2400
    }
2401
    g_free(sn_tab);
B
bellard 已提交
2402 2403
}

2404 2405 2406 2407
static void dump_json_image_info_list(ImageInfoList *list)
{
    QString *str;
    QObject *obj;
2408
    Visitor *v = qobject_output_visitor_new(&obj);
2409 2410 2411

    visit_type_ImageInfoList(v, NULL, &list, &error_abort);
    visit_complete(v, &obj);
2412 2413 2414 2415
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
2416
    visit_free(v);
2417 2418 2419
    QDECREF(str);
}

2420 2421 2422 2423
static void dump_json_image_info(ImageInfo *info)
{
    QString *str;
    QObject *obj;
2424
    Visitor *v = qobject_output_visitor_new(&obj);
2425 2426 2427

    visit_type_ImageInfo(v, NULL, &info, &error_abort);
    visit_complete(v, &obj);
2428 2429 2430 2431
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
2432
    visit_free(v);
2433 2434 2435
    QDECREF(str);
}

2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446
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;

2447
        bdrv_image_info_dump(fprintf, stdout, elem->value);
2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467
    }
}

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.
 */
2468 2469
static ImageInfoList *collect_image_info_list(bool image_opts,
                                              const char *filename,
2470
                                              const char *fmt,
2471
                                              bool chain, bool force_share)
2472 2473 2474 2475
{
    ImageInfoList *head = NULL;
    ImageInfoList **last = &head;
    GHashTable *filenames;
2476
    Error *err = NULL;
2477 2478 2479 2480

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

    while (filename) {
M
Markus Armbruster 已提交
2481
        BlockBackend *blk;
2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492
        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);

2493
        blk = img_open(image_opts, filename, fmt,
2494 2495
                       BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
                       force_share);
2496
        if (!blk) {
2497 2498
            goto err;
        }
2499
        bs = blk_bs(blk);
2500

2501
        bdrv_query_image_info(bs, &info, &err);
2502
        if (err) {
2503
            error_report_err(err);
M
Markus Armbruster 已提交
2504
            blk_unref(blk);
2505
            goto err;
2506
        }
2507 2508 2509 2510 2511 2512

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

M
Markus Armbruster 已提交
2513
        blk_unref(blk);
2514 2515 2516 2517 2518 2519

        filename = fmt = NULL;
        if (chain) {
            if (info->has_full_backing_filename) {
                filename = info->full_backing_filename;
            } else if (info->has_backing_filename) {
2520 2521 2522 2523
                error_report("Could not determine absolute backing filename,"
                             " but backing filename '%s' present",
                             info->backing_filename);
                goto err;
2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538
            }
            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;
}

2539 2540 2541 2542
static int img_info(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
2543
    bool chain = false;
2544
    const char *filename, *fmt, *output;
2545
    ImageInfoList *list;
2546
    bool image_opts = false;
2547
    bool force_share = false;
2548

B
bellard 已提交
2549
    fmt = NULL;
2550
    output = NULL;
B
bellard 已提交
2551
    for(;;) {
2552 2553 2554 2555 2556
        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},
2557
            {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2558
            {"object", required_argument, 0, OPTION_OBJECT},
2559
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2560
            {"force-share", no_argument, 0, 'U'},
2561 2562
            {0, 0, 0, 0}
        };
2563
        c = getopt_long(argc, argv, ":f:hU",
2564
                        long_options, &option_index);
2565
        if (c == -1) {
B
bellard 已提交
2566
            break;
2567
        }
B
bellard 已提交
2568
        switch(c) {
2569 2570 2571
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
2572
        case '?':
2573 2574
            unrecognized_option(argv[optind - 1]);
            break;
B
bellard 已提交
2575 2576 2577 2578 2579 2580
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2581 2582 2583
        case 'U':
            force_share = true;
            break;
2584 2585 2586
        case OPTION_OUTPUT:
            output = optarg;
            break;
2587 2588 2589
        case OPTION_BACKING_CHAIN:
            chain = true;
            break;
2590 2591 2592 2593 2594 2595 2596 2597
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2598 2599 2600
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
B
bellard 已提交
2601 2602
        }
    }
2603
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2604
        error_exit("Expecting one image file name");
2605
    }
B
bellard 已提交
2606 2607
    filename = argv[optind++];

2608 2609 2610 2611 2612 2613
    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.");
2614 2615
        return 1;
    }
2616

2617 2618
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2619
                          NULL, NULL)) {
2620 2621 2622
        return 1;
    }

2623 2624
    list = collect_image_info_list(image_opts, filename, fmt, chain,
                                   force_share);
2625
    if (!list) {
2626
        return 1;
B
bellard 已提交
2627
    }
2628 2629 2630

    switch (output_format) {
    case OFORMAT_HUMAN:
2631
        dump_human_image_info_list(list);
2632 2633
        break;
    case OFORMAT_JSON:
2634 2635 2636 2637 2638
        if (chain) {
            dump_json_image_info_list(list);
        } else {
            dump_json_image_info(list->value);
        }
2639
        break;
B
bellard 已提交
2640
    }
2641

2642
    qapi_free_ImageInfoList(list);
B
bellard 已提交
2643 2644 2645
    return 0;
}

P
Paolo Bonzini 已提交
2646 2647 2648 2649 2650
static void dump_map_entry(OutputFormat output_format, MapEntry *e,
                           MapEntry *next)
{
    switch (output_format) {
    case OFORMAT_HUMAN:
2651
        if (e->data && !e->has_offset) {
P
Paolo Bonzini 已提交
2652 2653 2654
            error_report("File contains external, encrypted or compressed clusters.");
            exit(1);
        }
2655
        if (e->data && !e->zero) {
P
Paolo Bonzini 已提交
2656
            printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2657 2658 2659
                   e->start, e->length,
                   e->has_offset ? e->offset : 0,
                   e->has_filename ? e->filename : "");
P
Paolo Bonzini 已提交
2660 2661 2662 2663
        }
        /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
         * Modify the flags here to allow more coalescing.
         */
2664 2665 2666
        if (next && (!next->data || next->zero)) {
            next->data = false;
            next->zero = true;
P
Paolo Bonzini 已提交
2667 2668 2669
        }
        break;
    case OFORMAT_JSON:
2670 2671
        printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
               " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
P
Paolo Bonzini 已提交
2672 2673
               (e->start == 0 ? "[" : ",\n"),
               e->start, e->length, e->depth,
2674 2675 2676
               e->zero ? "true" : "false",
               e->data ? "true" : "false");
        if (e->has_offset) {
P
Paolo Bonzini 已提交
2677
            printf(", \"offset\": %"PRId64"", e->offset);
P
Paolo Bonzini 已提交
2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692
        }
        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;
2693
    BlockDriverState *file;
J
John Snow 已提交
2694
    bool has_offset;
P
Paolo Bonzini 已提交
2695 2696 2697 2698 2699 2700 2701 2702

    /* 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 (;;) {
2703 2704
        ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
                                    &file);
P
Paolo Bonzini 已提交
2705 2706 2707 2708 2709 2710 2711
        if (ret < 0) {
            return ret;
        }
        assert(nb_sectors);
        if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
            break;
        }
2712
        bs = backing_bs(bs);
P
Paolo Bonzini 已提交
2713 2714 2715 2716 2717 2718 2719 2720
        if (bs == NULL) {
            ret = 0;
            break;
        }

        depth++;
    }

J
John Snow 已提交
2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734
    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 已提交
2735 2736 2737
    return 0;
}

2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758
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 已提交
2759 2760 2761 2762
static int img_map(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
M
Markus Armbruster 已提交
2763
    BlockBackend *blk;
P
Paolo Bonzini 已提交
2764 2765 2766 2767 2768
    BlockDriverState *bs;
    const char *filename, *fmt, *output;
    int64_t length;
    MapEntry curr = { .length = 0 }, next;
    int ret = 0;
2769
    bool image_opts = false;
2770
    bool force_share = false;
P
Paolo Bonzini 已提交
2771 2772 2773 2774 2775 2776 2777 2778 2779

    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},
2780
            {"object", required_argument, 0, OPTION_OBJECT},
2781
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2782
            {"force-share", no_argument, 0, 'U'},
P
Paolo Bonzini 已提交
2783 2784
            {0, 0, 0, 0}
        };
2785
        c = getopt_long(argc, argv, ":f:hU",
P
Paolo Bonzini 已提交
2786 2787 2788 2789 2790
                        long_options, &option_index);
        if (c == -1) {
            break;
        }
        switch (c) {
2791 2792 2793
        case ':':
            missing_argument(argv[optind - 1]);
            break;
P
Paolo Bonzini 已提交
2794
        case '?':
2795 2796
            unrecognized_option(argv[optind - 1]);
            break;
P
Paolo Bonzini 已提交
2797 2798 2799 2800 2801 2802
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2803 2804 2805
        case 'U':
            force_share = true;
            break;
P
Paolo Bonzini 已提交
2806 2807 2808
        case OPTION_OUTPUT:
            output = optarg;
            break;
2809 2810 2811 2812 2813 2814 2815 2816
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2817 2818 2819
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
P
Paolo Bonzini 已提交
2820 2821
        }
    }
F
Fam Zheng 已提交
2822 2823
    if (optind != argc - 1) {
        error_exit("Expecting one image file name");
P
Paolo Bonzini 已提交
2824
    }
F
Fam Zheng 已提交
2825
    filename = argv[optind];
P
Paolo Bonzini 已提交
2826 2827 2828 2829 2830 2831 2832 2833 2834 2835

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

2836 2837
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2838
                          NULL, NULL)) {
2839 2840 2841
        return 1;
    }

2842
    blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
2843 2844
    if (!blk) {
        return 1;
P
Paolo Bonzini 已提交
2845
    }
2846
    bs = blk_bs(blk);
P
Paolo Bonzini 已提交
2847 2848 2849 2850 2851

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

2852
    length = blk_getlength(blk);
P
Paolo Bonzini 已提交
2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869
    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;
        }

2870
        if (entry_mergeable(&curr, &next)) {
P
Paolo Bonzini 已提交
2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883
            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 已提交
2884
    blk_unref(blk);
P
Paolo Bonzini 已提交
2885 2886 2887
    return ret < 0;
}

2888 2889 2890 2891 2892
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

2893
static int img_snapshot(int argc, char **argv)
2894
{
M
Markus Armbruster 已提交
2895
    BlockBackend *blk;
2896 2897 2898
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
2899
    int c, ret = 0, bdrv_oflags;
2900 2901
    int action = 0;
    qemu_timeval tv;
2902
    bool quiet = false;
2903
    Error *err = NULL;
2904
    bool image_opts = false;
2905
    bool force_share = false;
2906

2907
    bdrv_oflags = BDRV_O_RDWR;
2908 2909
    /* Parse commandline parameters */
    for(;;) {
2910 2911 2912
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
2913
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2914
            {"force-share", no_argument, 0, 'U'},
2915 2916
            {0, 0, 0, 0}
        };
2917
        c = getopt_long(argc, argv, ":la:c:d:hqU",
2918
                        long_options, NULL);
2919
        if (c == -1) {
2920
            break;
2921
        }
2922
        switch(c) {
2923 2924 2925
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
2926
        case '?':
2927 2928
            unrecognized_option(argv[optind - 1]);
            break;
2929 2930
        case 'h':
            help();
2931
            return 0;
2932 2933
        case 'l':
            if (action) {
F
Fam Zheng 已提交
2934
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2935
                return 0;
2936 2937
            }
            action = SNAPSHOT_LIST;
2938
            bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2939 2940 2941
            break;
        case 'a':
            if (action) {
F
Fam Zheng 已提交
2942
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2943
                return 0;
2944 2945 2946 2947 2948 2949
            }
            action = SNAPSHOT_APPLY;
            snapshot_name = optarg;
            break;
        case 'c':
            if (action) {
F
Fam Zheng 已提交
2950
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2951
                return 0;
2952 2953 2954 2955 2956 2957
            }
            action = SNAPSHOT_CREATE;
            snapshot_name = optarg;
            break;
        case 'd':
            if (action) {
F
Fam Zheng 已提交
2958
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2959
                return 0;
2960 2961 2962 2963
            }
            action = SNAPSHOT_DELETE;
            snapshot_name = optarg;
            break;
2964 2965 2966
        case 'q':
            quiet = true;
            break;
2967 2968 2969
        case 'U':
            force_share = true;
            break;
2970 2971 2972 2973 2974 2975 2976 2977
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2978 2979 2980
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
2981 2982 2983
        }
    }

2984
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2985
        error_exit("Expecting one image file name");
2986
    }
2987 2988
    filename = argv[optind++];

2989 2990
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2991
                          NULL, NULL)) {
2992 2993 2994
        return 1;
    }

2995
    /* Open the image */
2996 2997
    blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
                   force_share);
2998 2999
    if (!blk) {
        return 1;
3000
    }
3001
    bs = blk_bs(blk);
3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017

    /* 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);
3018
        if (ret) {
3019
            error_report("Could not create snapshot '%s': %d (%s)",
3020
                snapshot_name, ret, strerror(-ret));
3021
        }
3022 3023 3024 3025
        break;

    case SNAPSHOT_APPLY:
        ret = bdrv_snapshot_goto(bs, snapshot_name);
3026
        if (ret) {
3027
            error_report("Could not apply snapshot '%s': %d (%s)",
3028
                snapshot_name, ret, strerror(-ret));
3029
        }
3030 3031 3032
        break;

    case SNAPSHOT_DELETE:
3033
        bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
3034
        if (err) {
3035 3036
            error_reportf_err(err, "Could not delete snapshot '%s': ",
                              snapshot_name);
3037
            ret = 1;
3038
        }
3039 3040 3041 3042
        break;
    }

    /* Cleanup */
M
Markus Armbruster 已提交
3043
    blk_unref(blk);
3044 3045 3046
    if (ret) {
        return 1;
    }
3047
    return 0;
3048 3049
}

K
Kevin Wolf 已提交
3050 3051
static int img_rebase(int argc, char **argv)
{
M
Markus Armbruster 已提交
3052
    BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
P
Paolo Bonzini 已提交
3053 3054
    uint8_t *buf_old = NULL;
    uint8_t *buf_new = NULL;
3055
    BlockDriverState *bs = NULL;
K
Kevin Wolf 已提交
3056
    char *filename;
3057 3058
    const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
    int c, flags, src_flags, ret;
3059
    bool writethrough, src_writethrough;
K
Kevin Wolf 已提交
3060
    int unsafe = 0;
3061
    bool force_share = false;
3062
    int progress = 0;
3063
    bool quiet = false;
3064
    Error *local_err = NULL;
3065
    bool image_opts = false;
K
Kevin Wolf 已提交
3066 3067

    /* Parse commandline parameters */
K
Kevin Wolf 已提交
3068
    fmt = NULL;
3069
    cache = BDRV_DEFAULT_CACHE;
3070
    src_cache = BDRV_DEFAULT_CACHE;
K
Kevin Wolf 已提交
3071 3072 3073
    out_baseimg = NULL;
    out_basefmt = NULL;
    for(;;) {
3074 3075 3076
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3077
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3078
            {"force-share", no_argument, 0, 'U'},
3079 3080
            {0, 0, 0, 0}
        };
3081
        c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
3082
                        long_options, NULL);
3083
        if (c == -1) {
K
Kevin Wolf 已提交
3084
            break;
3085
        }
K
Kevin Wolf 已提交
3086
        switch(c) {
3087 3088 3089
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
3090
        case '?':
3091 3092
            unrecognized_option(argv[optind - 1]);
            break;
K
Kevin Wolf 已提交
3093 3094 3095
        case 'h':
            help();
            return 0;
K
Kevin Wolf 已提交
3096 3097 3098
        case 'f':
            fmt = optarg;
            break;
K
Kevin Wolf 已提交
3099 3100 3101 3102 3103 3104 3105 3106 3107
        case 'F':
            out_basefmt = optarg;
            break;
        case 'b':
            out_baseimg = optarg;
            break;
        case 'u':
            unsafe = 1;
            break;
3108 3109 3110
        case 'p':
            progress = 1;
            break;
3111 3112 3113
        case 't':
            cache = optarg;
            break;
3114 3115 3116
        case 'T':
            src_cache = optarg;
            break;
3117 3118 3119
        case 'q':
            quiet = true;
            break;
3120 3121 3122 3123 3124 3125 3126 3127
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3128 3129 3130
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
3131 3132 3133
        case 'U':
            force_share = true;
            break;
K
Kevin Wolf 已提交
3134 3135 3136
        }
    }

3137 3138 3139 3140
    if (quiet) {
        progress = 0;
    }

F
Fam Zheng 已提交
3141 3142 3143 3144 3145
    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)");
3146
    }
K
Kevin Wolf 已提交
3147 3148
    filename = argv[optind++];

3149 3150
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3151
                          NULL, NULL)) {
3152 3153 3154
        return 1;
    }

3155 3156 3157
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

3158
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
3159
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3160 3161
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
3162
        goto out;
3163 3164
    }

3165 3166
    src_flags = 0;
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
3167 3168
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
3169
        goto out;
3170 3171
    }

3172 3173 3174 3175
    /* 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 已提交
3176 3177 3178 3179 3180 3181
    /*
     * 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.
     */
3182 3183
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   false);
3184
    if (!blk) {
3185 3186
        ret = -1;
        goto out;
3187
    }
3188
    bs = blk_bs(blk);
K
Kevin Wolf 已提交
3189 3190

    if (out_basefmt != NULL) {
3191
        if (bdrv_find_format(out_basefmt) == NULL) {
3192
            error_report("Invalid format name: '%s'", out_basefmt);
3193 3194
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
3195 3196 3197 3198
        }
    }

    /* For safe rebasing we need to compare old and new backing file */
3199
    if (!unsafe) {
3200
        char backing_name[PATH_MAX];
3201 3202 3203 3204
        QDict *options = NULL;

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

3208 3209 3210 3211
        if (force_share) {
            if (!options) {
                options = qdict_new();
            }
3212
            qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3213
        }
K
Kevin Wolf 已提交
3214
        bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3215
        blk_old_backing = blk_new_open(backing_name, NULL,
3216 3217
                                       options, src_flags, &local_err);
        if (!blk_old_backing) {
3218 3219 3220
            error_reportf_err(local_err,
                              "Could not open old backing file '%s': ",
                              backing_name);
3221
            ret = -1;
3222
            goto out;
K
Kevin Wolf 已提交
3223
        }
3224

3225
        if (out_baseimg[0]) {
3226
            options = qdict_new();
3227
            if (out_basefmt) {
3228
                qdict_put_str(options, "driver", out_basefmt);
3229 3230 3231
            }
            if (force_share) {
                qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3232 3233
            }

3234
            blk_new_backing = blk_new_open(out_baseimg, NULL,
3235 3236
                                           options, src_flags, &local_err);
            if (!blk_new_backing) {
3237 3238 3239
                error_reportf_err(local_err,
                                  "Could not open new backing file '%s': ",
                                  out_baseimg);
3240
                ret = -1;
3241 3242
                goto out;
            }
K
Kevin Wolf 已提交
3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255
        }
    }

    /*
     * 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) {
3256 3257 3258
        int64_t num_sectors;
        int64_t old_backing_num_sectors;
        int64_t new_backing_num_sectors = 0;
K
Kevin Wolf 已提交
3259
        uint64_t sector;
3260
        int n;
3261
        int64_t count;
3262
        float local_progress = 0;
3263

3264 3265
        buf_old = blk_blockalign(blk, IO_BUF_SIZE);
        buf_new = blk_blockalign(blk, IO_BUF_SIZE);
K
Kevin Wolf 已提交
3266

3267
        num_sectors = blk_nb_sectors(blk);
3268 3269 3270 3271 3272 3273
        if (num_sectors < 0) {
            error_report("Could not get size of '%s': %s",
                         filename, strerror(-num_sectors));
            ret = -1;
            goto out;
        }
3274
        old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
3275
        if (old_backing_num_sectors < 0) {
3276
            char backing_name[PATH_MAX];
3277 3278 3279 3280 3281 3282 3283

            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;
        }
3284 3285
        if (blk_new_backing) {
            new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
3286 3287 3288 3289 3290 3291
            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;
            }
3292
        }
K
Kevin Wolf 已提交
3293

3294 3295 3296 3297 3298
        if (num_sectors != 0) {
            local_progress = (float)100 /
                (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
        }

K
Kevin Wolf 已提交
3299 3300 3301 3302 3303 3304 3305 3306 3307 3308
        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 */
3309 3310
            ret = bdrv_is_allocated(bs, sector << BDRV_SECTOR_BITS,
                                    n << BDRV_SECTOR_BITS, &count);
3311 3312 3313 3314 3315
            if (ret < 0) {
                error_report("error while reading image metadata: %s",
                             strerror(-ret));
                goto out;
            }
3316 3317 3318 3319
            /* 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;
3320
            if (ret) {
K
Kevin Wolf 已提交
3321 3322 3323
                continue;
            }

3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334
            /*
             * 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;
                }

3335 3336
                ret = blk_pread(blk_old_backing, sector << BDRV_SECTOR_BITS,
                                buf_old, n << BDRV_SECTOR_BITS);
3337 3338 3339 3340
                if (ret < 0) {
                    error_report("error while reading from old backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3341
            }
3342

3343
            if (sector >= new_backing_num_sectors || !blk_new_backing) {
3344 3345 3346 3347 3348 3349
                memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
            } else {
                if (sector + n > new_backing_num_sectors) {
                    n = new_backing_num_sectors - sector;
                }

3350 3351
                ret = blk_pread(blk_new_backing, sector << BDRV_SECTOR_BITS,
                                buf_new, n << BDRV_SECTOR_BITS);
3352 3353 3354 3355
                if (ret < 0) {
                    error_report("error while reading from new backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3356 3357 3358 3359 3360 3361 3362 3363 3364
            }

            /* 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,
3365
                    buf_new + written * 512, n - written, &pnum))
K
Kevin Wolf 已提交
3366
                {
3367 3368 3369 3370
                    ret = blk_pwrite(blk,
                                     (sector + written) << BDRV_SECTOR_BITS,
                                     buf_old + written * 512,
                                     pnum << BDRV_SECTOR_BITS, 0);
K
Kevin Wolf 已提交
3371
                    if (ret < 0) {
3372
                        error_report("Error while writing to COW image: %s",
K
Kevin Wolf 已提交
3373
                            strerror(-ret));
3374
                        goto out;
K
Kevin Wolf 已提交
3375 3376 3377 3378 3379
                    }
                }

                written += pnum;
            }
3380
            qemu_progress_print(local_progress, 100);
K
Kevin Wolf 已提交
3381 3382 3383 3384 3385 3386 3387 3388
        }
    }

    /*
     * 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.
     */
3389 3390 3391 3392 3393 3394
    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 已提交
3395
    if (ret == -ENOSPC) {
3396 3397
        error_report("Could not change the backing file to '%s': No "
                     "space left in the file header", out_baseimg);
K
Kevin Wolf 已提交
3398
    } else if (ret < 0) {
3399
        error_report("Could not change the backing file to '%s': %s",
K
Kevin Wolf 已提交
3400 3401 3402
            out_baseimg, strerror(-ret));
    }

3403
    qemu_progress_print(100, 0);
K
Kevin Wolf 已提交
3404 3405 3406 3407 3408 3409
    /*
     * 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.
     */
3410
out:
3411
    qemu_progress_end();
K
Kevin Wolf 已提交
3412 3413
    /* Cleanup */
    if (!unsafe) {
M
Markus Armbruster 已提交
3414 3415
        blk_unref(blk_old_backing);
        blk_unref(blk_new_backing);
K
Kevin Wolf 已提交
3416
    }
P
Paolo Bonzini 已提交
3417 3418
    qemu_vfree(buf_old);
    qemu_vfree(buf_new);
K
Kevin Wolf 已提交
3419

M
Markus Armbruster 已提交
3420
    blk_unref(blk);
3421 3422 3423
    if (ret) {
        return 1;
    }
K
Kevin Wolf 已提交
3424 3425 3426
    return 0;
}

3427 3428
static int img_resize(int argc, char **argv)
{
3429
    Error *err = NULL;
3430 3431 3432
    int c, ret, relative;
    const char *filename, *fmt, *size;
    int64_t n, total_size;
3433
    bool quiet = false;
M
Markus Armbruster 已提交
3434
    BlockBackend *blk = NULL;
3435
    QemuOpts *param;
3436

3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447
    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 */
            }
3448 3449
        },
    };
3450
    bool image_opts = false;
3451

K
Kevin Wolf 已提交
3452 3453 3454
    /* Remove size from argv manually so that negative numbers are not treated
     * as options by getopt. */
    if (argc < 3) {
F
Fam Zheng 已提交
3455
        error_exit("Not enough arguments");
K
Kevin Wolf 已提交
3456 3457 3458 3459 3460 3461
        return 1;
    }

    size = argv[--argc];

    /* Parse getopt arguments */
3462 3463
    fmt = NULL;
    for(;;) {
3464 3465 3466
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3467
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3468 3469
            {0, 0, 0, 0}
        };
3470
        c = getopt_long(argc, argv, ":f:hq",
3471
                        long_options, NULL);
3472 3473 3474 3475
        if (c == -1) {
            break;
        }
        switch(c) {
3476 3477 3478
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
3479
        case '?':
3480 3481
            unrecognized_option(argv[optind - 1]);
            break;
3482 3483 3484 3485 3486 3487
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
3488 3489 3490
        case 'q':
            quiet = true;
            break;
3491 3492 3493 3494 3495 3496 3497 3498
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3499 3500 3501
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
3502 3503
        }
    }
3504
    if (optind != argc - 1) {
F
Fam Zheng 已提交
3505
        error_exit("Expecting one image file name");
3506 3507 3508
    }
    filename = argv[optind++];

3509 3510
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3511
                          NULL, NULL)) {
3512 3513 3514
        return 1;
    }

3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530
    /* 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 */
3531
    param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3532
    qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3533 3534
    if (err) {
        error_report_err(err);
3535
        ret = -1;
3536
        qemu_opts_del(param);
3537
        goto out;
3538
    }
3539 3540
    n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
    qemu_opts_del(param);
3541

3542
    blk = img_open(image_opts, filename, fmt,
3543 3544
                   BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
                   false);
3545
    if (!blk) {
3546 3547
        ret = -1;
        goto out;
3548
    }
3549 3550

    if (relative) {
3551
        total_size = blk_getlength(blk) + 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
    ret = blk_truncate(blk, total_size, &err);
    if (!ret) {
3563
        qprintf(quiet, "Image resized.\n");
3564 3565
    } else {
        error_report_err(err);
3566
    }
3567
out:
M
Markus Armbruster 已提交
3568
    blk_unref(blk);
3569 3570 3571
    if (ret) {
        return 1;
    }
3572 3573 3574
    return 0;
}

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

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

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

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

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

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

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

3677 3678 3679 3680 3681 3682
    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 已提交
3683 3684
    }

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

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

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

    fmt = bs->drv->format_name;

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

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

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

out:
3740 3741
    qemu_progress_end();

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

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

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

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

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

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

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

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

        /* 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 已提交
3822 3823 3824
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

K
Kevin Wolf 已提交
4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082
    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 已提交
4083 4084 4085 4086 4087 4088 4089 4090 4091
        return 1;
    }
    return 0;
}

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

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

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

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;

4118
    res = cvtnum(arg);
R
Reda Sallahi 已提交
4119

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

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

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

    return 0;
}

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

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

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

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

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

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

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

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

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

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

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


A
Anthony Liguori 已提交
4445
static const img_cmd_t img_cmds[] = {
4446 4447 4448 4449 4450 4451 4452 4453
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
    { NULL, NULL, },
};

B
bellard 已提交
4454 4455
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
4456
    const img_cmd_t *cmd;
4457
    const char *cmdname;
4458
    Error *local_error = NULL;
4459
    char *trace_file = NULL;
4460 4461 4462
    int c;
    static const struct option long_options[] = {
        {"help", no_argument, 0, 'h'},
4463
        {"version", no_argument, 0, 'V'},
4464
        {"trace", required_argument, NULL, 'T'},
4465 4466
        {0, 0, 0, 0}
    };
B
bellard 已提交
4467

4468 4469 4470 4471
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

4472
    module_call_init(MODULE_INIT_TRACE);
K
Kevin Wolf 已提交
4473
    error_set_progname(argv[0]);
4474
    qemu_init_exec_dir(argv[0]);
K
Kevin Wolf 已提交
4475

4476
    if (qemu_init_main_loop(&local_error)) {
4477
        error_report_err(local_error);
4478 4479 4480
        exit(EXIT_FAILURE);
    }

4481
    qcrypto_init(&error_fatal);
4482

4483
    module_call_init(MODULE_INIT_QOM);
B
bellard 已提交
4484
    bdrv_init();
F
Fam Zheng 已提交
4485 4486 4487
    if (argc < 2) {
        error_exit("Not enough arguments");
    }
4488

4489
    qemu_add_opts(&qemu_object_opts);
4490
    qemu_add_opts(&qemu_source_opts);
4491
    qemu_add_opts(&qemu_trace_opts);
4492

4493
    while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
4494
        switch (c) {
4495 4496 4497
        case ':':
            missing_argument(argv[optind - 1]);
            return 0;
4498
        case '?':
4499 4500 4501
            unrecognized_option(argv[optind - 1]);
            return 0;
        case 'h':
4502 4503 4504 4505 4506
            help();
            return 0;
        case 'V':
            printf(QEMU_IMG_VERSION);
            return 0;
4507 4508 4509 4510
        case 'T':
            g_free(trace_file);
            trace_file = trace_opt_parse(optarg);
            break;
4511
        }
B
bellard 已提交
4512
    }
4513

4514
    cmdname = argv[optind];
4515

4516 4517 4518
    /* reset getopt_long scanning */
    argc -= optind;
    if (argc < 1) {
4519 4520
        return 0;
    }
4521
    argv += optind;
D
Denis V. Lunev 已提交
4522
    optind = 0;
4523

4524 4525 4526 4527 4528 4529
    if (!trace_init_backends()) {
        exit(1);
    }
    trace_init_file(trace_file);
    qemu_set_log(LOG_TRACE);

4530 4531 4532 4533 4534 4535
    /* find the command */
    for (cmd = img_cmds; cmd->name != NULL; cmd++) {
        if (!strcmp(cmdname, cmd->name)) {
            return cmd->handler(argc, argv);
        }
    }
4536

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