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

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

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

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

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

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

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

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

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

F
Fam Zheng 已提交
84 85 86 87 88
static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
{
    va_list ap;

    va_start(ap, fmt);
89
    error_vreport(fmt, ap);
F
Fam Zheng 已提交
90 91
    va_end(ap);

92
    error_printf("Try 'qemu-img --help' for more information\n");
F
Fam Zheng 已提交
93 94 95
    exit(EXIT_FAILURE);
}

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

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

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

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

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

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

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

B
bellard 已提交
234

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

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

248 249 250 251 252
    if (!drv->create_opts) {
        error_report("Format driver '%s' does not support image creation", fmt);
        return 1;
    }

C
Chunyan Liu 已提交
253
    create_opts = qemu_opts_append(create_opts, drv->create_opts);
254
    if (filename) {
255
        proto_drv = bdrv_find_protocol(filename, true, &local_err);
256
        if (!proto_drv) {
257
            error_report_err(local_err);
258
            qemu_opts_free(create_opts);
259 260
            return 1;
        }
261
        if (!proto_drv->create_opts) {
M
Max Reitz 已提交
262
            error_report("Protocol driver '%s' does not support image creation",
263
                         proto_drv->format_name);
M
Max Reitz 已提交
264
            qemu_opts_free(create_opts);
265 266
            return 1;
        }
C
Chunyan Liu 已提交
267
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
268 269
    }

270 271 272 273 274
    if (filename) {
        printf("Supported options:\n");
    } else {
        printf("Supported %s options:\n", fmt);
    }
M
Max Reitz 已提交
275
    qemu_opts_print_help(create_opts, false);
276
    qemu_opts_free(create_opts);
277 278 279 280 281 282 283

    if (!filename) {
        printf("\n"
               "The protocol level may support further options.\n"
               "Specify the target filename to include those options.\n");
    }

284 285 286
    return 0;
}

287

288
static BlockBackend *img_open_opts(const char *optstr,
289
                                   QemuOpts *opts, int flags, bool writethrough,
290
                                   bool quiet, bool force_share)
291 292 293 294 295
{
    QDict *options;
    Error *local_err = NULL;
    BlockBackend *blk;
    options = qemu_opts_to_qdict(opts, NULL);
296 297
    if (force_share) {
        if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
298
            && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
299
            error_report("--force-share/-U conflicts with image options");
300
            qobject_unref(options);
301 302
            return NULL;
        }
303
        qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
304
    }
305
    blk = blk_new_open(NULL, NULL, options, flags, &local_err);
306
    if (!blk) {
307
        error_reportf_err(local_err, "Could not open '%s': ", optstr);
308 309
        return NULL;
    }
310
    blk_set_enable_write_cache(blk, !writethrough);
311 312 313 314

    return blk;
}

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

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

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

341 342 343 344
    return blk;
}


345 346 347 348 349 350 351
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")) {
352
        qdict_put_str(options, name, value);
353 354 355 356 357 358
    }

    return 0;
}


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

385

386
static int add_old_style_options(const char *fmt, QemuOpts *opts,
387 388
                                 const char *base_filename,
                                 const char *base_fmt)
389
{
390 391
    Error *err = NULL;

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

413 414
static int64_t cvtnum(const char *s)
{
415
    int err;
416
    uint64_t value;
417

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

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

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

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

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

513 514
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
515
                          NULL, &error_fatal)) {
516 517 518
        goto fail;
    }

519 520
    /* Get image size, if specified */
    if (optind < argc) {
521
        int64_t sval;
522 523 524

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

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

548
    g_free(options);
B
bellard 已提交
549
    return 0;
550 551 552 553

fail:
    g_free(options);
    return 1;
B
bellard 已提交
554 555
}

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

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

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

        if (check->leaks) {
585 586 587 588
            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);
589 590 591
        }

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

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

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

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;
648 649
    check->compressed_clusters      = result.bfi.compressed_clusters;
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
650 651 652 653

    return 0;
}

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

    fmt = NULL;
679
    output = NULL;
680
    cache = BDRV_DEFAULT_CACHE;
681

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

754 755 756 757 758 759 760 761 762
    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;
    }

763 764
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
765
                          NULL, &error_fatal)) {
766 767 768
        return 1;
    }

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

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

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
784 785

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

791 792
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
793

794 795
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
796

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

807
        ret = collect_image_check(bs, check, filename, fmt, 0);
808

809 810
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
811 812
    }

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

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

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

fail:
    qapi_free_ImageCheck(check);
M
Markus Armbruster 已提交
844
    blk_unref(blk);
845
    return ret;
846 847
}

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

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

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

887 888 889 890
    /* publish completion progress only when success */
    if (!ret) {
        qemu_progress_print(100.f, 0);
    }
M
Max Reitz 已提交
891 892
}

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

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

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

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

976 977
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
978
                          NULL, &error_fatal)) {
979 980 981
        return 1;
    }

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

989 990
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   false);
991 992
    if (!blk) {
        return 1;
993
    }
994 995
    bs = blk_bs(blk);

996 997 998
    qemu_progress_init(progress, 1.f);
    qemu_progress_print(0.f, 100);

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

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

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

1033 1034 1035 1036
    /* 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 已提交
1037
    if (!drop) {
1038
        bdrv_ref(bs);
M
Max Reitz 已提交
1039 1040
    }

1041
    job = block_job_get("commit");
1042
    assert(job);
1043
    run_block_job(job, &local_err);
M
Max Reitz 已提交
1044 1045 1046 1047
    if (local_err) {
        goto unref_backing;
    }

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

unref_backing:
    if (!drop) {
1059
        bdrv_unref(bs);
M
Max Reitz 已提交
1060
    }
M
Max Reitz 已提交
1061 1062

done:
1063 1064
    qemu_progress_end();

M
Markus Armbruster 已提交
1065
    blk_unref(blk);
M
Max Reitz 已提交
1066 1067

    if (local_err) {
1068
        error_report_err(local_err);
1069 1070
        return 1;
    }
M
Max Reitz 已提交
1071 1072

    qprintf(quiet, "Image committed.\n");
B
bellard 已提交
1073 1074 1075
    return 0;
}

E
Eric Blake 已提交
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
/*
 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
 * of the first sector boundary within buf where the sector contains a
 * non-zero byte.  This function is robust to a buffer that is not
 * sector-aligned.
 */
static int64_t find_nonzero(const uint8_t *buf, int64_t n)
{
    int64_t i;
    int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);

    for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
        if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
            return i;
        }
    }
    if (i < n && !buffer_is_zero(buf + i, n - end)) {
        return i;
    }
    return -1;
}

1098 1099 1100 1101 1102 1103
/*
 * 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.
1104 1105 1106
 * The function will try to align the end offset to alignment boundaries so
 * that the request will at least end aligned and consequtive requests will
 * also start at an aligned offset.
1107
 */
1108 1109
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
                                int64_t sector_num, int alignment)
B
bellard 已提交
1110
{
1111
    bool is_zero;
1112
    int i, tail;
B
bellard 已提交
1113 1114 1115 1116 1117

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
1118
    is_zero = buffer_is_zero(buf, 512);
B
bellard 已提交
1119 1120
    for(i = 1; i < n; i++) {
        buf += 512;
1121
        if (is_zero != buffer_is_zero(buf, 512)) {
B
bellard 已提交
1122
            break;
1123
        }
B
bellard 已提交
1124
    }
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141

    tail = (sector_num + i) & (alignment - 1);
    if (tail) {
        if (is_zero && i <= tail) {
            /* treat unallocated areas which only consist
             * of a small tail as allocated. */
            is_zero = false;
        }
        if (!is_zero) {
            /* align up end offset of allocated areas. */
            i += alignment - tail;
            i = MIN(i, n);
        } else {
            /* align down end offset of zero areas. */
            i -= tail;
        }
    }
B
bellard 已提交
1142
    *pnum = i;
1143
    return !is_zero;
B
bellard 已提交
1144 1145
}

1146 1147 1148 1149 1150 1151
/*
 * 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,
1152
    int min, int64_t sector_num, int alignment)
1153 1154 1155 1156 1157 1158 1159 1160
{
    int ret;
    int num_checked, num_used;

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

1161
    ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
1162 1163 1164 1165 1166 1167 1168
    if (!ret) {
        return ret;
    }

    num_used = *pnum;
    buf += BDRV_SECTOR_SIZE * *pnum;
    n -= *pnum;
1169
    sector_num += *pnum;
1170 1171 1172
    num_checked = num_used;

    while (n > 0) {
1173
        ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
1174 1175 1176

        buf += BDRV_SECTOR_SIZE * *pnum;
        n -= *pnum;
1177
        sector_num += *pnum;
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
        num_checked += *pnum;
        if (ret) {
            num_used = num_checked;
        } else if (*pnum >= min) {
            break;
        }
    }

    *pnum = num_used;
    return 1;
}

K
Kevin Wolf 已提交
1190
/*
1191 1192
 * Compares two buffers sector by sector. Returns 0 if the first
 * sector of each buffer matches, non-zero otherwise.
K
Kevin Wolf 已提交
1193
 *
1194 1195
 * pnum is set to the sector-aligned size of the buffer prefix that
 * has the same matching status as the first sector.
K
Kevin Wolf 已提交
1196
 */
1197 1198
static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
                           int64_t bytes, int64_t *pnum)
K
Kevin Wolf 已提交
1199
{
1200
    bool res;
1201
    int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
K
Kevin Wolf 已提交
1202

1203
    assert(bytes > 0);
K
Kevin Wolf 已提交
1204

1205 1206 1207
    res = !!memcmp(buf1, buf2, i);
    while (i < bytes) {
        int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
K
Kevin Wolf 已提交
1208

1209
        if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
K
Kevin Wolf 已提交
1210 1211
            break;
        }
1212
        i += len;
K
Kevin Wolf 已提交
1213 1214 1215 1216 1217 1218
    }

    *pnum = i;
    return res;
}

1219
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
1220

1221 1222 1223
/*
 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
 *
1224 1225 1226 1227
 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
 * failure), and 4 on error (the exit status for read errors), after emitting
 * an error message.
1228
 *
1229
 * @param blk:  BlockBackend for the image
1230 1231
 * @param offset: Starting offset to check
 * @param bytes: Number of bytes to check
1232 1233 1234 1235
 * @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
 */
1236 1237
static int check_empty_sectors(BlockBackend *blk, int64_t offset,
                               int64_t bytes, const char *filename,
1238 1239
                               uint8_t *buffer, bool quiet)
{
E
Eric Blake 已提交
1240 1241 1242
    int ret = 0;
    int64_t idx;

1243
    ret = blk_pread(blk, offset, buffer, bytes);
1244 1245
    if (ret < 0) {
        error_report("Error while reading offset %" PRId64 " of %s: %s",
1246
                     offset, filename, strerror(-ret));
1247
        return 4;
1248
    }
1249
    idx = find_nonzero(buffer, bytes);
E
Eric Blake 已提交
1250
    if (idx >= 0) {
1251
        qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1252
                offset + idx);
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
        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)
{
1268
    const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
M
Markus Armbruster 已提交
1269
    BlockBackend *blk1, *blk2;
1270
    BlockDriverState *bs1, *bs2;
1271
    int64_t total_size1, total_size2;
1272
    uint8_t *buf1 = NULL, *buf2 = NULL;
1273
    int64_t pnum1, pnum2;
1274 1275 1276
    int allocated1, allocated2;
    int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
    bool progress = false, quiet = false, strict = false;
1277
    int flags;
1278
    bool writethrough;
1279 1280 1281
    int64_t total_size;
    int64_t offset = 0;
    int64_t chunk;
1282
    int c;
1283
    uint64_t progress_base;
1284
    bool image_opts = false;
1285
    bool force_share = false;
1286

1287
    cache = BDRV_DEFAULT_CACHE;
1288
    for (;;) {
1289 1290 1291
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
1292
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1293
            {"force-share", no_argument, 0, 'U'},
1294 1295
            {0, 0, 0, 0}
        };
1296
        c = getopt_long(argc, argv, ":hf:F:T:pqsU",
1297
                        long_options, NULL);
1298 1299 1300 1301
        if (c == -1) {
            break;
        }
        switch (c) {
1302 1303 1304
        case ':':
            missing_argument(argv[optind - 1]);
            break;
1305
        case '?':
1306 1307
            unrecognized_option(argv[optind - 1]);
            break;
1308 1309 1310 1311 1312 1313 1314 1315 1316
        case 'h':
            help();
            break;
        case 'f':
            fmt1 = optarg;
            break;
        case 'F':
            fmt2 = optarg;
            break;
1317 1318 1319
        case 'T':
            cache = optarg;
            break;
1320 1321 1322 1323 1324 1325 1326 1327 1328
        case 'p':
            progress = true;
            break;
        case 'q':
            quiet = true;
            break;
        case 's':
            strict = true;
            break;
1329 1330 1331
        case 'U':
            force_share = true;
            break;
1332 1333 1334 1335 1336 1337 1338 1339 1340
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                ret = 2;
                goto out4;
            }
        }   break;
1341 1342 1343
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
1344 1345 1346 1347 1348 1349 1350 1351 1352
        }
    }

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


1353
    if (optind != argc - 2) {
F
Fam Zheng 已提交
1354
        error_exit("Expecting two image file names");
1355 1356 1357 1358
    }
    filename1 = argv[optind++];
    filename2 = argv[optind++];

1359 1360
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
1361
                          NULL, &error_fatal)) {
1362 1363 1364 1365
        ret = 2;
        goto out4;
    }

1366 1367 1368
    /* Initialize before goto out */
    qemu_progress_init(progress, 2.0);

1369 1370
    flags = 0;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1371 1372 1373 1374 1375 1376
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        ret = 2;
        goto out3;
    }

1377 1378
    blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
                    force_share);
1379
    if (!blk1) {
1380
        ret = 2;
1381
        goto out3;
1382 1383
    }

1384 1385
    blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
                    force_share);
1386
    if (!blk2) {
1387
        ret = 2;
1388
        goto out2;
1389
    }
1390
    bs1 = blk_bs(blk1);
1391
    bs2 = blk_bs(blk2);
1392

1393 1394
    buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
    buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1395 1396
    total_size1 = blk_getlength(blk1);
    if (total_size1 < 0) {
1397
        error_report("Can't get size of %s: %s",
1398
                     filename1, strerror(-total_size1));
1399 1400 1401
        ret = 4;
        goto out;
    }
1402 1403
    total_size2 = blk_getlength(blk2);
    if (total_size2 < 0) {
1404
        error_report("Can't get size of %s: %s",
1405
                     filename2, strerror(-total_size2));
1406 1407 1408
        ret = 4;
        goto out;
    }
1409 1410
    total_size = MIN(total_size1, total_size2);
    progress_base = MAX(total_size1, total_size2);
1411 1412 1413

    qemu_progress_print(0, 100);

1414
    if (strict && total_size1 != total_size2) {
1415 1416 1417 1418 1419
        ret = 1;
        qprintf(quiet, "Strict mode: Image size mismatch!\n");
        goto out;
    }

1420
    while (offset < total_size) {
1421
        int status1, status2;
1422

1423 1424 1425
        status1 = bdrv_block_status_above(bs1, NULL, offset,
                                          total_size1 - offset, &pnum1, NULL,
                                          NULL);
1426
        if (status1 < 0) {
1427 1428 1429 1430
            ret = 3;
            error_report("Sector allocation test failed for %s", filename1);
            goto out;
        }
1431
        allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1432

1433 1434 1435
        status2 = bdrv_block_status_above(bs2, NULL, offset,
                                          total_size2 - offset, &pnum2, NULL,
                                          NULL);
1436
        if (status2 < 0) {
1437 1438 1439 1440
            ret = 3;
            error_report("Sector allocation test failed for %s", filename2);
            goto out;
        }
1441
        allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1442 1443

        assert(pnum1 && pnum2);
1444
        chunk = MIN(pnum1, pnum2);
1445

1446
        if (strict) {
1447
            if (status1 != status2) {
1448 1449
                ret = 1;
                qprintf(quiet, "Strict mode: Offset %" PRId64
1450
                        " block status mismatch!\n", offset);
1451 1452 1453 1454
                goto out;
            }
        }
        if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1455
            /* nothing to do */
1456
        } else if (allocated1 == allocated2) {
1457
            if (allocated1) {
1458 1459
                int64_t pnum;

1460 1461
                chunk = MIN(chunk, IO_BUF_SIZE);
                ret = blk_pread(blk1, offset, buf1, chunk);
1462
                if (ret < 0) {
1463 1464 1465
                    error_report("Error while reading offset %" PRId64
                                 " of %s: %s",
                                 offset, filename1, strerror(-ret));
1466 1467 1468
                    ret = 4;
                    goto out;
                }
1469
                ret = blk_pread(blk2, offset, buf2, chunk);
1470 1471
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64
1472 1473
                                 " of %s: %s",
                                 offset, filename2, strerror(-ret));
1474 1475 1476
                    ret = 4;
                    goto out;
                }
1477 1478
                ret = compare_buffers(buf1, buf2, chunk, &pnum);
                if (ret || pnum != chunk) {
1479
                    qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1480
                            offset + (ret ? 0 : pnum));
1481
                    ret = 1;
1482 1483 1484 1485
                    goto out;
                }
            }
        } else {
1486
            chunk = MIN(chunk, IO_BUF_SIZE);
1487
            if (allocated1) {
1488
                ret = check_empty_sectors(blk1, offset, chunk,
1489 1490
                                          filename1, buf1, quiet);
            } else {
1491
                ret = check_empty_sectors(blk2, offset, chunk,
1492 1493 1494 1495 1496 1497
                                          filename2, buf1, quiet);
            }
            if (ret) {
                goto out;
            }
        }
1498 1499
        offset += chunk;
        qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1500 1501
    }

1502
    if (total_size1 != total_size2) {
1503
        BlockBackend *blk_over;
1504 1505 1506
        const char *filename_over;

        qprintf(quiet, "Warning: Image size mismatch!\n");
1507
        if (total_size1 > total_size2) {
1508
            blk_over = blk1;
1509 1510
            filename_over = filename1;
        } else {
1511
            blk_over = blk2;
1512 1513 1514
            filename_over = filename2;
        }

1515 1516 1517 1518
        while (offset < progress_base) {
            ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
                                          progress_base - offset, &chunk,
                                          NULL, NULL);
1519 1520 1521 1522 1523 1524 1525
            if (ret < 0) {
                ret = 3;
                error_report("Sector allocation test failed for %s",
                             filename_over);
                goto out;

            }
1526
            if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
1527 1528
                chunk = MIN(chunk, IO_BUF_SIZE);
                ret = check_empty_sectors(blk_over, offset, chunk,
1529 1530 1531 1532 1533
                                          filename_over, buf1, quiet);
                if (ret) {
                    goto out;
                }
            }
1534 1535
            offset += chunk;
            qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1536 1537 1538 1539 1540 1541 1542 1543 1544
        }
    }

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

out:
    qemu_vfree(buf1);
    qemu_vfree(buf2);
M
Markus Armbruster 已提交
1545
    blk_unref(blk2);
1546
out2:
M
Markus Armbruster 已提交
1547
    blk_unref(blk1);
1548 1549
out3:
    qemu_progress_end();
1550
out4:
1551 1552 1553
    return ret;
}

1554 1555 1556 1557 1558 1559
enum ImgConvertBlockStatus {
    BLK_DATA,
    BLK_ZERO,
    BLK_BACKING_FILE,
};

P
Peter Lieven 已提交
1560 1561
#define MAX_COROUTINES 16

1562 1563 1564
typedef struct ImgConvertState {
    BlockBackend **src;
    int64_t *src_sectors;
P
Peter Lieven 已提交
1565
    int src_num;
1566 1567
    int64_t total_sectors;
    int64_t allocated_sectors;
P
Peter Lieven 已提交
1568 1569 1570
    int64_t allocated_done;
    int64_t sector_num;
    int64_t wr_offs;
1571 1572 1573 1574 1575
    enum ImgConvertBlockStatus status;
    int64_t sector_next_status;
    BlockBackend *target;
    bool has_zero_init;
    bool compressed;
1576
    bool unallocated_blocks_are_zero;
1577
    bool target_has_backing;
1578
    int64_t target_backing_sectors; /* negative if unknown */
P
Peter Lieven 已提交
1579
    bool wr_in_order;
1580
    bool copy_range;
1581
    int min_sparse;
1582
    int alignment;
1583 1584
    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)
{
1607 1608
    int64_t src_cur_offset;
    int ret, n, src_cur;
1609
    bool post_backing_zero = false;
1610

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

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

1616 1617 1618 1619 1620 1621 1622 1623 1624 1625
    if (s->target_backing_sectors >= 0) {
        if (sector_num >= s->target_backing_sectors) {
            post_backing_zero = s->unallocated_blocks_are_zero;
        } else if (sector_num + n > s->target_backing_sectors) {
            /* Split requests around target_backing_sectors (because
             * starting from there, zeros are handled differently) */
            n = s->target_backing_sectors - sector_num;
        }
    }

1626
    if (s->sector_next_status <= sector_num) {
1627 1628
        int64_t count = n * BDRV_SECTOR_SIZE;

1629
        if (s->target_has_backing) {
1630 1631 1632 1633 1634

            ret = bdrv_block_status(blk_bs(s->src[src_cur]),
                                    (sector_num - src_cur_offset) *
                                    BDRV_SECTOR_SIZE,
                                    count, &count, NULL, NULL);
1635
        } else {
1636 1637 1638 1639
            ret = bdrv_block_status_above(blk_bs(s->src[src_cur]), NULL,
                                          (sector_num - src_cur_offset) *
                                          BDRV_SECTOR_SIZE,
                                          count, &count, NULL, NULL);
1640
        }
1641
        if (ret < 0) {
1642 1643
            error_report("error while reading block status of sector %" PRId64
                         ": %s", sector_num, strerror(-ret));
1644 1645
            return ret;
        }
1646
        n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
1647 1648

        if (ret & BDRV_BLOCK_ZERO) {
1649
            s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
1650 1651 1652
        } else if (ret & BDRV_BLOCK_DATA) {
            s->status = BLK_DATA;
        } else {
1653
            s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678
        }

        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 已提交
1679 1680
static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
                                        int nb_sectors, uint8_t *buf)
1681
{
P
Peter Lieven 已提交
1682
    int n, ret;
1683 1684 1685 1686

    assert(nb_sectors <= s->buf_sectors);
    while (nb_sectors > 0) {
        BlockBackend *blk;
P
Peter Lieven 已提交
1687 1688
        int src_cur;
        int64_t bs_sectors, src_cur_offset;
1689 1690 1691 1692

        /* 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 已提交
1693 1694 1695 1696 1697 1698
        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));

1699
        ret = blk_co_pread(
P
Peter Lieven 已提交
1700
                blk, (sector_num - src_cur_offset) << BDRV_SECTOR_BITS,
1701
                n << BDRV_SECTOR_BITS, buf, 0);
1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713
        if (ret < 0) {
            return ret;
        }

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

    return 0;
}

P
Peter Lieven 已提交
1714 1715 1716 1717

static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
                                         int nb_sectors, uint8_t *buf,
                                         enum ImgConvertBlockStatus status)
1718 1719 1720 1721 1722
{
    int ret;

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

P
Peter Lieven 已提交
1725
        switch (status) {
1726 1727 1728 1729 1730 1731 1732 1733
        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:
1734 1735 1736 1737 1738 1739
            /* 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. */
1740
            if (!s->min_sparse ||
1741
                (!s->compressed &&
1742 1743
                 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
                                          sector_num, s->alignment)) ||
1744 1745
                (s->compressed &&
                 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
1746
            {
1747 1748
                ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
                                    n << BDRV_SECTOR_BITS, buf, flags);
1749 1750 1751 1752 1753 1754 1755 1756 1757
                if (ret < 0) {
                    return ret;
                }
                break;
            }
            /* fall-through */

        case BLK_ZERO:
            if (s->has_zero_init) {
1758
                assert(!s->target_has_backing);
1759 1760
                break;
            }
P
Peter Lieven 已提交
1761 1762
            ret = blk_co_pwrite_zeroes(s->target,
                                       sector_num << BDRV_SECTOR_BITS,
1763 1764
                                       n << BDRV_SECTOR_BITS,
                                       BDRV_REQ_MAY_UNMAP);
1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778
            if (ret < 0) {
                return ret;
            }
            break;
        }

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

    return 0;
}

1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798
static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
                                              int nb_sectors)
{
    int n, ret;

    while (nb_sectors > 0) {
        BlockBackend *blk;
        int src_cur;
        int64_t bs_sectors, src_cur_offset;
        int64_t offset;

        convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
        offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
        blk = s->src[src_cur];
        bs_sectors = s->src_sectors[src_cur];

        n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));

        ret = blk_co_copy_range(blk, offset, s->target,
                                sector_num << BDRV_SECTOR_BITS,
1799
                                n << BDRV_SECTOR_BITS, 0, 0);
1800 1801 1802 1803 1804 1805 1806 1807 1808 1809
        if (ret < 0) {
            return ret;
        }

        sector_num += n;
        nb_sectors -= n;
    }
    return 0;
}

P
Peter Lieven 已提交
1810
static void coroutine_fn convert_co_do_copy(void *opaque)
1811
{
P
Peter Lieven 已提交
1812
    ImgConvertState *s = opaque;
1813
    uint8_t *buf = NULL;
P
Peter Lieven 已提交
1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831
    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;
1832
        bool copy_range;
P
Peter Lieven 已提交
1833 1834 1835 1836

        qemu_co_mutex_lock(&s->lock);
        if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
            qemu_co_mutex_unlock(&s->lock);
1837
            break;
P
Peter Lieven 已提交
1838 1839 1840 1841 1842
        }
        n = convert_iteration_sectors(s, s->sector_num);
        if (n < 0) {
            qemu_co_mutex_unlock(&s->lock);
            s->ret = n;
1843
            break;
P
Peter Lieven 已提交
1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861
        }
        /* 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);
        }

1862 1863 1864
retry:
        copy_range = s->copy_range && s->status == BLK_DATA;
        if (status == BLK_DATA && !copy_range) {
P
Peter Lieven 已提交
1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877
            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 */
1878
            while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
P
Peter Lieven 已提交
1879 1880 1881 1882 1883 1884
                s->wait_sector_num[index] = sector_num;
                qemu_coroutine_yield();
            }
            s->wait_sector_num[index] = -1;
        }

1885
        if (s->ret == -EINPROGRESS) {
1886 1887 1888 1889 1890 1891 1892 1893 1894
            if (copy_range) {
                ret = convert_co_copy_range(s, sector_num, n);
                if (ret) {
                    s->copy_range = false;
                    goto retry;
                }
            } else {
                ret = convert_co_write(s, sector_num, n, buf, status);
            }
1895 1896 1897 1898 1899
            if (ret < 0) {
                error_report("error while writing sector %" PRId64
                             ": %s", sector_num, strerror(-ret));
                s->ret = ret;
            }
P
Peter Lieven 已提交
1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932
        }

        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;
1933 1934 1935 1936 1937 1938 1939 1940 1941

    /* 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)))
    {
1942
        ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP | BDRV_REQ_NO_FALLBACK);
1943 1944 1945 1946 1947 1948 1949 1950 1951 1952
        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 已提交
1953
            return -EINVAL;
1954 1955 1956 1957 1958 1959 1960
        }
        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 已提交
1961
            return n;
1962
        }
1963 1964
        if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
        {
1965 1966 1967 1968 1969 1970 1971
            s->allocated_sectors += n;
        }
        sector_num += n;
    }

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

P
Peter Lieven 已提交
1974 1975 1976 1977 1978 1979
    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]);
    }
1980

1981
    while (s->running_coroutines) {
P
Peter Lieven 已提交
1982
        main_loop_wait(false);
1983 1984
    }

P
Peter Lieven 已提交
1985
    if (s->compressed && !s->ret) {
1986
        /* signal EOF to align */
1987
        ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
1988
        if (ret < 0) {
P
Peter Lieven 已提交
1989
            return ret;
1990 1991 1992
        }
    }

P
Peter Lieven 已提交
1993
    return s->ret;
1994 1995
}

1996 1997
#define MAX_BUF_SECTORS 32768

B
bellard 已提交
1998 1999
static int img_convert(int argc, char **argv)
{
P
Peter Lieven 已提交
2000
    int c, bs_i, flags, src_flags = 0;
2001
    const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
P
Peter Lieven 已提交
2002 2003
               *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
               *out_filename, *out_baseimg_param, *snapshot_name = NULL;
2004
    BlockDriver *drv = NULL, *proto_drv = NULL;
B
bellard 已提交
2005
    BlockDriverInfo bdi;
P
Peter Lieven 已提交
2006 2007
    BlockDriverState *out_bs;
    QemuOpts *opts = NULL, *sn_opts = NULL;
2008
    QemuOptsList *create_opts = NULL;
2009
    QDict *open_opts = NULL;
2010
    char *options = NULL;
2011
    Error *local_err = NULL;
P
Peter Lieven 已提交
2012
    bool writethrough, src_writethrough, quiet = false, image_opts = false,
2013
         skip_create = false, progress = false, tgt_image_opts = false;
P
Peter Lieven 已提交
2014
    int64_t ret = -EINVAL;
2015
    bool force_share = false;
2016
    bool explict_min_sparse = false;
P
Peter Lieven 已提交
2017 2018 2019 2020

    ImgConvertState s = (ImgConvertState) {
        /* Need at least 4k of zeros for sparse detection */
        .min_sparse         = 8,
2021
        .copy_range         = false,
P
Peter Lieven 已提交
2022 2023 2024 2025
        .buf_sectors        = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
        .wr_in_order        = true,
        .num_coroutines     = 8,
    };
B
bellard 已提交
2026 2027

    for(;;) {
2028 2029 2030
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
2031
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2032
            {"force-share", no_argument, 0, 'U'},
2033
            {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
2034 2035
            {0, 0, 0, 0}
        };
2036
        c = getopt_long(argc, argv, ":hf:O:B:Cco:l:S:pt:T:qnm:WU",
2037
                        long_options, NULL);
2038
        if (c == -1) {
B
bellard 已提交
2039
            break;
2040
        }
B
bellard 已提交
2041
        switch(c) {
2042 2043 2044
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
2045
        case '?':
2046 2047
            unrecognized_option(argv[optind - 1]);
            break;
B
bellard 已提交
2048 2049 2050 2051 2052 2053 2054 2055 2056
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'O':
            out_fmt = optarg;
            break;
2057 2058 2059
        case 'B':
            out_baseimg = optarg;
            break;
2060 2061 2062
        case 'C':
            s.copy_range = true;
            break;
B
bellard 已提交
2063
        case 'c':
P
Peter Lieven 已提交
2064
            s.compressed = true;
B
bellard 已提交
2065
            break;
2066
        case 'o':
2067 2068
            if (!is_valid_option_list(optarg)) {
                error_report("Invalid option list: %s", optarg);
2069
                goto fail_getopt;
2070 2071 2072 2073 2074 2075 2076 2077
            }
            if (!options) {
                options = g_strdup(optarg);
            } else {
                char *old_options = options;
                options = g_strdup_printf("%s,%s", options, optarg);
                g_free(old_options);
            }
2078
            break;
2079 2080
        case 'l':
            if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
2081 2082
                sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
                                                  optarg, false);
2083 2084 2085
                if (!sn_opts) {
                    error_report("Failed in parsing snapshot param '%s'",
                                 optarg);
2086
                    goto fail_getopt;
2087 2088 2089 2090 2091
                }
            } else {
                snapshot_name = optarg;
            }
            break;
2092 2093 2094
        case 'S':
        {
            int64_t sval;
2095 2096

            sval = cvtnum(optarg);
2097 2098 2099 2100 2101 2102
            if (sval < 0 || sval & (BDRV_SECTOR_SIZE - 1) ||
                sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
                error_report("Invalid buffer size for sparse output specified. "
                    "Valid sizes are multiples of %llu up to %llu. Select "
                    "0 to disable sparse detection (fully allocates output).",
                    BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
2103
                goto fail_getopt;
2104 2105
            }

P
Peter Lieven 已提交
2106
            s.min_sparse = sval / BDRV_SECTOR_SIZE;
2107
            explict_min_sparse = true;
2108 2109
            break;
        }
2110
        case 'p':
P
Peter Lieven 已提交
2111
            progress = true;
2112
            break;
2113 2114 2115
        case 't':
            cache = optarg;
            break;
2116 2117 2118
        case 'T':
            src_cache = optarg;
            break;
2119 2120 2121
        case 'q':
            quiet = true;
            break;
2122
        case 'n':
P
Peter Lieven 已提交
2123
            skip_create = true;
2124
            break;
P
Peter Lieven 已提交
2125
        case 'm':
P
Peter Lieven 已提交
2126 2127
            if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
                s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
P
Peter Lieven 已提交
2128 2129 2130 2131 2132 2133
                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 已提交
2134
            s.wr_in_order = false;
P
Peter Lieven 已提交
2135
            break;
2136 2137 2138
        case 'U':
            force_share = true;
            break;
2139 2140 2141 2142 2143
        case OPTION_OBJECT: {
            QemuOpts *object_opts;
            object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                                  optarg, true);
            if (!object_opts) {
2144 2145 2146
                goto fail_getopt;
            }
            break;
2147
        }
2148 2149 2150
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
2151 2152 2153
        case OPTION_TARGET_IMAGE_OPTS:
            tgt_image_opts = true;
            break;
B
bellard 已提交
2154 2155
        }
    }
2156

2157 2158 2159 2160
    if (!out_fmt && !tgt_image_opts) {
        out_fmt = "raw";
    }

2161 2162
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2163
                          NULL, &error_fatal)) {
2164 2165 2166
        goto fail_getopt;
    }

2167 2168 2169 2170 2171 2172 2173 2174 2175 2176
    if (s.compressed && s.copy_range) {
        error_report("Cannot enable copy offloading when -c is used");
        goto fail_getopt;
    }

    if (explict_min_sparse && s.copy_range) {
        error_report("Cannot enable copy offloading when -S is used");
        goto fail_getopt;
    }

2177 2178 2179 2180 2181
    if (tgt_image_opts && !skip_create) {
        error_report("--target-image-opts requires use of -n flag");
        goto fail_getopt;
    }

P
Peter Lieven 已提交
2182 2183
    s.src_num = argc - optind - 1;
    out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2184

2185
    if (options && has_help_option(options)) {
2186 2187 2188 2189 2190 2191 2192
        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;
        }
2193 2194
    }

P
Peter Lieven 已提交
2195 2196 2197
    if (s.src_num < 1) {
        error_report("Must specify image file name");
        goto fail_getopt;
2198 2199 2200
    }


P
Peter Lieven 已提交
2201
    /* ret is still -EINVAL until here */
2202
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2203 2204
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
P
Peter Lieven 已提交
2205
        goto fail_getopt;
2206 2207
    }

P
Peter Lieven 已提交
2208 2209 2210 2211 2212
    /* Initialize before goto out */
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);
2213 2214
    qemu_progress_print(0, 100);

P
Peter Lieven 已提交
2215 2216
    s.src = g_new0(BlockBackend *, s.src_num);
    s.src_sectors = g_new(int64_t, s.src_num);
2217

P
Peter Lieven 已提交
2218 2219
    for (bs_i = 0; bs_i < s.src_num; bs_i++) {
        s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
2220 2221
                               fmt, src_flags, src_writethrough, quiet,
                               force_share);
P
Peter Lieven 已提交
2222
        if (!s.src[bs_i]) {
2223 2224 2225
            ret = -1;
            goto out;
        }
P
Peter Lieven 已提交
2226 2227
        s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
        if (s.src_sectors[bs_i] < 0) {
2228
            error_report("Could not get size of %s: %s",
P
Peter Lieven 已提交
2229
                         argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
2230 2231 2232
            ret = -1;
            goto out;
        }
P
Peter Lieven 已提交
2233
        s.total_sectors += s.src_sectors[bs_i];
2234
    }
B
bellard 已提交
2235

2236
    if (sn_opts) {
P
Peter Lieven 已提交
2237
        bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
2238 2239 2240
                               qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
                               qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
                               &local_err);
2241
    } else if (snapshot_name != NULL) {
P
Peter Lieven 已提交
2242
        if (s.src_num > 1) {
2243
            error_report("No support for concatenating multiple snapshot");
E
edison 已提交
2244 2245 2246
            ret = -1;
            goto out;
        }
2247

P
Peter Lieven 已提交
2248 2249
        bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
                                             &local_err);
2250
    }
2251
    if (local_err) {
2252
        error_reportf_err(local_err, "Failed to load snapshot: ");
2253 2254
        ret = -1;
        goto out;
E
edison 已提交
2255 2256
    }

2257 2258 2259 2260 2261 2262 2263 2264
    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;
        }
2265

2266 2267 2268 2269 2270 2271
        proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
        if (!proto_drv) {
            error_report_err(local_err);
            ret = -1;
            goto out;
        }
2272

M
Max Reitz 已提交
2273 2274 2275 2276 2277 2278
        if (!drv->create_opts) {
            error_report("Format driver '%s' does not support image creation",
                         drv->format_name);
            ret = -1;
            goto out;
        }
2279

M
Max Reitz 已提交
2280 2281 2282 2283 2284 2285
        if (!proto_drv->create_opts) {
            error_report("Protocol driver '%s' does not support image creation",
                         proto_drv->format_name);
            ret = -1;
            goto out;
        }
2286

M
Max Reitz 已提交
2287 2288
        create_opts = qemu_opts_append(create_opts, drv->create_opts);
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2289

M
Max Reitz 已提交
2290
        opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2291 2292 2293
        if (options) {
            qemu_opts_do_parse(opts, options, NULL, &local_err);
            if (local_err) {
2294
                error_report_err(local_err);
2295 2296 2297
                ret = -1;
                goto out;
            }
M
Max Reitz 已提交
2298
        }
2299

P
Peter Lieven 已提交
2300
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
2301
                            &error_abort);
M
Max Reitz 已提交
2302 2303 2304 2305
        ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
        if (ret < 0) {
            goto out;
        }
2306
    }
2307

2308
    /* Get backing file name if -o backing_file was used */
2309
    out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2310
    if (out_baseimg_param) {
2311
        out_baseimg = out_baseimg_param;
2312
    }
P
Peter Lieven 已提交
2313
    s.target_has_backing = (bool) out_baseimg;
2314

2315 2316 2317 2318 2319 2320 2321
    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;
    }

2322
    /* Check if compression is supported */
P
Peter Lieven 已提交
2323
    if (s.compressed) {
2324 2325
        bool encryption =
            qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2326 2327
        const char *encryptfmt =
            qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
2328 2329
        const char *preallocation =
            qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2330

2331
        if (drv && !drv->bdrv_co_pwritev_compressed) {
2332
            error_report("Compression not supported for this file format");
2333 2334
            ret = -1;
            goto out;
2335 2336
        }

2337
        if (encryption || encryptfmt) {
2338 2339
            error_report("Compression and encryption not supported at "
                         "the same time");
2340 2341
            ret = -1;
            goto out;
2342
        }
2343

2344 2345
        if (preallocation
            && strcmp(preallocation, "off"))
2346 2347 2348 2349 2350 2351
        {
            error_report("Compression and preallocation not supported at "
                         "the same time");
            ret = -1;
            goto out;
        }
2352 2353
    }

2354 2355 2356 2357 2358 2359 2360 2361 2362 2363
    /*
     * The later open call will need any decryption secrets, and
     * bdrv_create() will purge "opts", so extract them now before
     * they are lost.
     */
    if (!skip_create) {
        open_opts = qdict_new();
        qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
    }

2364 2365
    if (!skip_create) {
        /* Create the new image */
C
Chunyan Liu 已提交
2366
        ret = bdrv_create(drv, out_filename, opts, &local_err);
2367
        if (ret < 0) {
2368 2369
            error_reportf_err(local_err, "%s: error while converting %s: ",
                              out_filename, out_fmt);
2370
            goto out;
B
bellard 已提交
2371 2372
        }
    }
2373

P
Peter Lieven 已提交
2374
    flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2375
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2376 2377
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2378
        goto out;
2379 2380
    }

2381 2382 2383 2384 2385 2386 2387 2388 2389
    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
         */
2390 2391 2392
        s.target = img_open_file(out_filename, open_opts, out_fmt,
                                 flags, writethrough, quiet, false);
        open_opts = NULL; /* blk_new_open will have freed it */
2393
    }
P
Peter Lieven 已提交
2394
    if (!s.target) {
2395 2396 2397
        ret = -1;
        goto out;
    }
P
Peter Lieven 已提交
2398
    out_bs = blk_bs(s.target);
B
bellard 已提交
2399

2400 2401 2402 2403 2404 2405
    if (s.compressed && !out_bs->drv->bdrv_co_pwritev_compressed) {
        error_report("Compression not supported for this file format");
        ret = -1;
        goto out;
    }

2406
    /* increase bufsectors from the default 4096 (2M) if opt_transfer
2407 2408 2409
     * or discard_alignment of the out_bs is greater. Limit to
     * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
    s.buf_sectors = MIN(MAX_BUF_SECTORS,
P
Peter Lieven 已提交
2410 2411 2412 2413
                        MAX(s.buf_sectors,
                            MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
                                out_bs->bl.pdiscard_alignment >>
                                BDRV_SECTOR_BITS)));
2414

2415 2416 2417 2418 2419 2420 2421
    /* try to align the write requests to the destination to avoid unnecessary
     * RMW cycles. */
    s.alignment = MAX(pow2floor(s.min_sparse),
                      DIV_ROUND_UP(out_bs->bl.request_alignment,
                                   BDRV_SECTOR_SIZE));
    assert(is_power_of_2(s.alignment));

2422
    if (skip_create) {
P
Peter Lieven 已提交
2423
        int64_t output_sectors = blk_nb_sectors(s.target);
2424
        if (output_sectors < 0) {
2425
            error_report("unable to get output image length: %s",
2426
                         strerror(-output_sectors));
2427 2428
            ret = -1;
            goto out;
P
Peter Lieven 已提交
2429
        } else if (output_sectors < s.total_sectors) {
2430 2431 2432 2433 2434 2435
            error_report("output file is smaller than input file");
            ret = -1;
            goto out;
        }
    }

2436 2437 2438 2439 2440 2441 2442 2443 2444 2445
    if (s.target_has_backing) {
        /* Errors are treated as "backing length unknown" (which means
         * s.target_backing_sectors has to be negative, which it will
         * be automatically).  The backing file length is used only
         * for optimizations, so such a case is not fatal. */
        s.target_backing_sectors = bdrv_nb_sectors(out_bs->backing->bs);
    } else {
        s.target_backing_sectors = -1;
    }

2446 2447
    ret = bdrv_get_info(out_bs, &bdi);
    if (ret < 0) {
P
Peter Lieven 已提交
2448
        if (s.compressed) {
2449
            error_report("could not get block driver info");
2450 2451
            goto out;
        }
2452
    } else {
P
Peter Lieven 已提交
2453 2454
        s.compressed = s.compressed || bdi.needs_compressed_writes;
        s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2455
        s.unallocated_blocks_are_zero = bdi.unallocated_blocks_are_zero;
P
Peter Lieven 已提交
2456
    }
2457

P
Peter Lieven 已提交
2458
    ret = convert_do_copy(&s);
2459
out:
2460 2461 2462
    if (!ret) {
        qemu_progress_print(100, 0);
    }
2463
    qemu_progress_end();
2464 2465
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
2466
    qemu_opts_del(sn_opts);
2467
    qobject_unref(open_opts);
P
Peter Lieven 已提交
2468 2469 2470 2471
    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 已提交
2472
        }
P
Peter Lieven 已提交
2473
        g_free(s.src);
M
Markus Armbruster 已提交
2474
    }
P
Peter Lieven 已提交
2475
    g_free(s.src_sectors);
2476 2477 2478
fail_getopt:
    g_free(options);

P
Peter Lieven 已提交
2479
    return !!ret;
B
bellard 已提交
2480 2481
}

B
bellard 已提交
2482

B
bellard 已提交
2483 2484 2485 2486 2487 2488 2489 2490 2491
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");
2492
    bdrv_snapshot_dump(NULL);
2493
    printf("\n");
B
bellard 已提交
2494 2495
    for(i = 0; i < nb_sns; i++) {
        sn = &sn_tab[i];
2496
        bdrv_snapshot_dump(sn);
2497
        printf("\n");
B
bellard 已提交
2498
    }
2499
    g_free(sn_tab);
B
bellard 已提交
2500 2501
}

2502 2503 2504 2505
static void dump_json_image_info_list(ImageInfoList *list)
{
    QString *str;
    QObject *obj;
2506
    Visitor *v = qobject_output_visitor_new(&obj);
2507 2508 2509

    visit_type_ImageInfoList(v, NULL, &list, &error_abort);
    visit_complete(v, &obj);
2510 2511 2512
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
2513
    qobject_unref(obj);
2514
    visit_free(v);
2515
    qobject_unref(str);
2516 2517
}

2518 2519 2520 2521
static void dump_json_image_info(ImageInfo *info)
{
    QString *str;
    QObject *obj;
2522
    Visitor *v = qobject_output_visitor_new(&obj);
2523 2524 2525

    visit_type_ImageInfo(v, NULL, &info, &error_abort);
    visit_complete(v, &obj);
2526 2527 2528
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
2529
    qobject_unref(obj);
2530
    visit_free(v);
2531
    qobject_unref(str);
2532 2533
}

2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544
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;

2545
        bdrv_image_info_dump(elem->value);
2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565
    }
}

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.
 */
2566 2567
static ImageInfoList *collect_image_info_list(bool image_opts,
                                              const char *filename,
2568
                                              const char *fmt,
2569
                                              bool chain, bool force_share)
2570 2571 2572 2573
{
    ImageInfoList *head = NULL;
    ImageInfoList **last = &head;
    GHashTable *filenames;
2574
    Error *err = NULL;
2575 2576 2577 2578

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

    while (filename) {
M
Markus Armbruster 已提交
2579
        BlockBackend *blk;
2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590
        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);

2591
        blk = img_open(image_opts, filename, fmt,
2592 2593
                       BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
                       force_share);
2594
        if (!blk) {
2595 2596
            goto err;
        }
2597
        bs = blk_bs(blk);
2598

2599
        bdrv_query_image_info(bs, &info, &err);
2600
        if (err) {
2601
            error_report_err(err);
M
Markus Armbruster 已提交
2602
            blk_unref(blk);
2603
            goto err;
2604
        }
2605 2606 2607 2608 2609 2610

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

M
Markus Armbruster 已提交
2611
        blk_unref(blk);
2612 2613 2614 2615 2616 2617

        filename = fmt = NULL;
        if (chain) {
            if (info->has_full_backing_filename) {
                filename = info->full_backing_filename;
            } else if (info->has_backing_filename) {
2618 2619 2620 2621
                error_report("Could not determine absolute backing filename,"
                             " but backing filename '%s' present",
                             info->backing_filename);
                goto err;
2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636
            }
            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;
}

2637 2638 2639 2640
static int img_info(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
2641
    bool chain = false;
2642
    const char *filename, *fmt, *output;
2643
    ImageInfoList *list;
2644
    bool image_opts = false;
2645
    bool force_share = false;
2646

B
bellard 已提交
2647
    fmt = NULL;
2648
    output = NULL;
B
bellard 已提交
2649
    for(;;) {
2650 2651 2652 2653 2654
        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},
2655
            {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2656
            {"object", required_argument, 0, OPTION_OBJECT},
2657
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2658
            {"force-share", no_argument, 0, 'U'},
2659 2660
            {0, 0, 0, 0}
        };
2661
        c = getopt_long(argc, argv, ":f:hU",
2662
                        long_options, &option_index);
2663
        if (c == -1) {
B
bellard 已提交
2664
            break;
2665
        }
B
bellard 已提交
2666
        switch(c) {
2667 2668 2669
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
2670
        case '?':
2671 2672
            unrecognized_option(argv[optind - 1]);
            break;
B
bellard 已提交
2673 2674 2675 2676 2677 2678
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2679 2680 2681
        case 'U':
            force_share = true;
            break;
2682 2683 2684
        case OPTION_OUTPUT:
            output = optarg;
            break;
2685 2686 2687
        case OPTION_BACKING_CHAIN:
            chain = true;
            break;
2688 2689 2690 2691 2692 2693 2694 2695
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2696 2697 2698
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
B
bellard 已提交
2699 2700
        }
    }
2701
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2702
        error_exit("Expecting one image file name");
2703
    }
B
bellard 已提交
2704 2705
    filename = argv[optind++];

2706 2707 2708 2709 2710 2711
    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.");
2712 2713
        return 1;
    }
2714

2715 2716
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2717
                          NULL, &error_fatal)) {
2718 2719 2720
        return 1;
    }

2721 2722
    list = collect_image_info_list(image_opts, filename, fmt, chain,
                                   force_share);
2723
    if (!list) {
2724
        return 1;
B
bellard 已提交
2725
    }
2726 2727 2728

    switch (output_format) {
    case OFORMAT_HUMAN:
2729
        dump_human_image_info_list(list);
2730 2731
        break;
    case OFORMAT_JSON:
2732 2733 2734 2735 2736
        if (chain) {
            dump_json_image_info_list(list);
        } else {
            dump_json_image_info(list->value);
        }
2737
        break;
B
bellard 已提交
2738
    }
2739

2740
    qapi_free_ImageInfoList(list);
B
bellard 已提交
2741 2742 2743
    return 0;
}

2744 2745
static int dump_map_entry(OutputFormat output_format, MapEntry *e,
                          MapEntry *next)
P
Paolo Bonzini 已提交
2746 2747 2748
{
    switch (output_format) {
    case OFORMAT_HUMAN:
2749
        if (e->data && !e->has_offset) {
P
Paolo Bonzini 已提交
2750
            error_report("File contains external, encrypted or compressed clusters.");
2751
            return -1;
P
Paolo Bonzini 已提交
2752
        }
2753
        if (e->data && !e->zero) {
P
Paolo Bonzini 已提交
2754
            printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2755 2756 2757
                   e->start, e->length,
                   e->has_offset ? e->offset : 0,
                   e->has_filename ? e->filename : "");
P
Paolo Bonzini 已提交
2758 2759 2760 2761
        }
        /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
         * Modify the flags here to allow more coalescing.
         */
2762 2763 2764
        if (next && (!next->data || next->zero)) {
            next->data = false;
            next->zero = true;
P
Paolo Bonzini 已提交
2765 2766 2767
        }
        break;
    case OFORMAT_JSON:
2768 2769
        printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
               " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
P
Paolo Bonzini 已提交
2770 2771
               (e->start == 0 ? "[" : ",\n"),
               e->start, e->length, e->depth,
2772 2773 2774
               e->zero ? "true" : "false",
               e->data ? "true" : "false");
        if (e->has_offset) {
P
Paolo Bonzini 已提交
2775
            printf(", \"offset\": %"PRId64"", e->offset);
P
Paolo Bonzini 已提交
2776 2777 2778 2779 2780 2781 2782 2783
        }
        putchar('}');

        if (!next) {
            printf("]\n");
        }
        break;
    }
2784
    return 0;
P
Paolo Bonzini 已提交
2785 2786
}

2787 2788
static int get_block_status(BlockDriverState *bs, int64_t offset,
                            int64_t bytes, MapEntry *e)
P
Paolo Bonzini 已提交
2789
{
2790
    int ret;
P
Paolo Bonzini 已提交
2791
    int depth;
2792
    BlockDriverState *file;
J
John Snow 已提交
2793
    bool has_offset;
2794
    int64_t map;
2795
    char *filename = NULL;
P
Paolo Bonzini 已提交
2796 2797 2798 2799 2800 2801 2802 2803

    /* 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 (;;) {
2804
        ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
P
Paolo Bonzini 已提交
2805 2806 2807
        if (ret < 0) {
            return ret;
        }
2808
        assert(bytes);
P
Paolo Bonzini 已提交
2809 2810 2811
        if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
            break;
        }
2812
        bs = backing_bs(bs);
P
Paolo Bonzini 已提交
2813 2814 2815 2816 2817 2818 2819 2820
        if (bs == NULL) {
            ret = 0;
            break;
        }

        depth++;
    }

J
John Snow 已提交
2821 2822
    has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);

2823 2824 2825 2826 2827
    if (file && has_offset) {
        bdrv_refresh_filename(file);
        filename = file->filename;
    }

J
John Snow 已提交
2828
    *e = (MapEntry) {
2829
        .start = offset,
2830
        .length = bytes,
J
John Snow 已提交
2831 2832
        .data = !!(ret & BDRV_BLOCK_DATA),
        .zero = !!(ret & BDRV_BLOCK_ZERO),
2833
        .offset = map,
J
John Snow 已提交
2834 2835
        .has_offset = has_offset,
        .depth = depth,
2836 2837
        .has_filename = filename,
        .filename = filename,
J
John Snow 已提交
2838 2839
    };

P
Paolo Bonzini 已提交
2840 2841 2842
    return 0;
}

2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863
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 已提交
2864 2865 2866 2867
static int img_map(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
M
Markus Armbruster 已提交
2868
    BlockBackend *blk;
P
Paolo Bonzini 已提交
2869 2870 2871 2872 2873
    BlockDriverState *bs;
    const char *filename, *fmt, *output;
    int64_t length;
    MapEntry curr = { .length = 0 }, next;
    int ret = 0;
2874
    bool image_opts = false;
2875
    bool force_share = false;
P
Paolo Bonzini 已提交
2876 2877 2878 2879 2880 2881 2882 2883 2884

    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},
2885
            {"object", required_argument, 0, OPTION_OBJECT},
2886
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2887
            {"force-share", no_argument, 0, 'U'},
P
Paolo Bonzini 已提交
2888 2889
            {0, 0, 0, 0}
        };
2890
        c = getopt_long(argc, argv, ":f:hU",
P
Paolo Bonzini 已提交
2891 2892 2893 2894 2895
                        long_options, &option_index);
        if (c == -1) {
            break;
        }
        switch (c) {
2896 2897 2898
        case ':':
            missing_argument(argv[optind - 1]);
            break;
P
Paolo Bonzini 已提交
2899
        case '?':
2900 2901
            unrecognized_option(argv[optind - 1]);
            break;
P
Paolo Bonzini 已提交
2902 2903 2904 2905 2906 2907
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2908 2909 2910
        case 'U':
            force_share = true;
            break;
P
Paolo Bonzini 已提交
2911 2912 2913
        case OPTION_OUTPUT:
            output = optarg;
            break;
2914 2915 2916 2917 2918 2919 2920 2921
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2922 2923 2924
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
P
Paolo Bonzini 已提交
2925 2926
        }
    }
F
Fam Zheng 已提交
2927 2928
    if (optind != argc - 1) {
        error_exit("Expecting one image file name");
P
Paolo Bonzini 已提交
2929
    }
F
Fam Zheng 已提交
2930
    filename = argv[optind];
P
Paolo Bonzini 已提交
2931 2932 2933 2934 2935 2936 2937 2938 2939 2940

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

2941 2942
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2943
                          NULL, &error_fatal)) {
2944 2945 2946
        return 1;
    }

2947
    blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
2948 2949
    if (!blk) {
        return 1;
P
Paolo Bonzini 已提交
2950
    }
2951
    bs = blk_bs(blk);
P
Paolo Bonzini 已提交
2952 2953 2954 2955 2956

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

2957
    length = blk_getlength(blk);
P
Paolo Bonzini 已提交
2958
    while (curr.start + curr.length < length) {
2959 2960
        int64_t offset = curr.start + curr.length;
        int64_t n;
P
Paolo Bonzini 已提交
2961 2962

        /* Probe up to 1 GiB at a time.  */
2963
        n = MIN(1 << 30, length - offset);
2964
        ret = get_block_status(bs, offset, n, &next);
P
Paolo Bonzini 已提交
2965 2966 2967 2968 2969 2970

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

2971
        if (entry_mergeable(&curr, &next)) {
P
Paolo Bonzini 已提交
2972 2973 2974 2975 2976
            curr.length += next.length;
            continue;
        }

        if (curr.length > 0) {
2977 2978 2979 2980
            ret = dump_map_entry(output_format, &curr, &next);
            if (ret < 0) {
                goto out;
            }
P
Paolo Bonzini 已提交
2981 2982 2983 2984
        }
        curr = next;
    }

2985
    ret = dump_map_entry(output_format, &curr, NULL);
P
Paolo Bonzini 已提交
2986 2987

out:
M
Markus Armbruster 已提交
2988
    blk_unref(blk);
P
Paolo Bonzini 已提交
2989 2990 2991
    return ret < 0;
}

2992 2993 2994 2995 2996
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

2997
static int img_snapshot(int argc, char **argv)
2998
{
M
Markus Armbruster 已提交
2999
    BlockBackend *blk;
3000 3001 3002
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
3003
    int c, ret = 0, bdrv_oflags;
3004 3005
    int action = 0;
    qemu_timeval tv;
3006
    bool quiet = false;
3007
    Error *err = NULL;
3008
    bool image_opts = false;
3009
    bool force_share = false;
3010

3011
    bdrv_oflags = BDRV_O_RDWR;
3012 3013
    /* Parse commandline parameters */
    for(;;) {
3014 3015 3016
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3017
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3018
            {"force-share", no_argument, 0, 'U'},
3019 3020
            {0, 0, 0, 0}
        };
3021
        c = getopt_long(argc, argv, ":la:c:d:hqU",
3022
                        long_options, NULL);
3023
        if (c == -1) {
3024
            break;
3025
        }
3026
        switch(c) {
3027 3028 3029
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
3030
        case '?':
3031 3032
            unrecognized_option(argv[optind - 1]);
            break;
3033 3034
        case 'h':
            help();
3035
            return 0;
3036 3037
        case 'l':
            if (action) {
F
Fam Zheng 已提交
3038
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3039
                return 0;
3040 3041
            }
            action = SNAPSHOT_LIST;
3042
            bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
3043 3044 3045
            break;
        case 'a':
            if (action) {
F
Fam Zheng 已提交
3046
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3047
                return 0;
3048 3049 3050 3051 3052 3053
            }
            action = SNAPSHOT_APPLY;
            snapshot_name = optarg;
            break;
        case 'c':
            if (action) {
F
Fam Zheng 已提交
3054
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3055
                return 0;
3056 3057 3058 3059 3060 3061
            }
            action = SNAPSHOT_CREATE;
            snapshot_name = optarg;
            break;
        case 'd':
            if (action) {
F
Fam Zheng 已提交
3062
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3063
                return 0;
3064 3065 3066 3067
            }
            action = SNAPSHOT_DELETE;
            snapshot_name = optarg;
            break;
3068 3069 3070
        case 'q':
            quiet = true;
            break;
3071 3072 3073
        case 'U':
            force_share = true;
            break;
3074 3075 3076 3077 3078 3079 3080 3081
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3082 3083 3084
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
3085 3086 3087
        }
    }

3088
    if (optind != argc - 1) {
F
Fam Zheng 已提交
3089
        error_exit("Expecting one image file name");
3090
    }
3091 3092
    filename = argv[optind++];

3093 3094
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3095
                          NULL, &error_fatal)) {
3096 3097 3098
        return 1;
    }

3099
    /* Open the image */
3100 3101
    blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
                   force_share);
3102 3103
    if (!blk) {
        return 1;
3104
    }
3105
    bs = blk_bs(blk);
3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121

    /* 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);
3122
        if (ret) {
3123
            error_report("Could not create snapshot '%s': %d (%s)",
3124
                snapshot_name, ret, strerror(-ret));
3125
        }
3126 3127 3128
        break;

    case SNAPSHOT_APPLY:
3129
        ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
3130
        if (ret) {
3131 3132
            error_reportf_err(err, "Could not apply snapshot '%s': ",
                              snapshot_name);
3133
        }
3134 3135 3136
        break;

    case SNAPSHOT_DELETE:
3137 3138 3139 3140
        ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
        if (ret < 0) {
            error_report("Could not delete snapshot '%s': snapshot not "
                         "found", snapshot_name);
3141
            ret = 1;
3142 3143 3144 3145 3146 3147 3148
        } else {
            ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
            if (ret < 0) {
                error_reportf_err(err, "Could not delete snapshot '%s': ",
                                  snapshot_name);
                ret = 1;
            }
3149
        }
3150 3151 3152 3153
        break;
    }

    /* Cleanup */
M
Markus Armbruster 已提交
3154
    blk_unref(blk);
3155 3156 3157
    if (ret) {
        return 1;
    }
3158
    return 0;
3159 3160
}

K
Kevin Wolf 已提交
3161 3162
static int img_rebase(int argc, char **argv)
{
M
Markus Armbruster 已提交
3163
    BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
P
Paolo Bonzini 已提交
3164 3165
    uint8_t *buf_old = NULL;
    uint8_t *buf_new = NULL;
3166
    BlockDriverState *bs = NULL;
K
Kevin Wolf 已提交
3167
    char *filename;
3168 3169
    const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
    int c, flags, src_flags, ret;
3170
    bool writethrough, src_writethrough;
K
Kevin Wolf 已提交
3171
    int unsafe = 0;
3172
    bool force_share = false;
3173
    int progress = 0;
3174
    bool quiet = false;
3175
    Error *local_err = NULL;
3176
    bool image_opts = false;
K
Kevin Wolf 已提交
3177 3178

    /* Parse commandline parameters */
K
Kevin Wolf 已提交
3179
    fmt = NULL;
3180
    cache = BDRV_DEFAULT_CACHE;
3181
    src_cache = BDRV_DEFAULT_CACHE;
K
Kevin Wolf 已提交
3182 3183 3184
    out_baseimg = NULL;
    out_basefmt = NULL;
    for(;;) {
3185 3186 3187
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3188
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3189
            {"force-share", no_argument, 0, 'U'},
3190 3191
            {0, 0, 0, 0}
        };
3192
        c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
3193
                        long_options, NULL);
3194
        if (c == -1) {
K
Kevin Wolf 已提交
3195
            break;
3196
        }
K
Kevin Wolf 已提交
3197
        switch(c) {
3198 3199 3200
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
3201
        case '?':
3202 3203
            unrecognized_option(argv[optind - 1]);
            break;
K
Kevin Wolf 已提交
3204 3205 3206
        case 'h':
            help();
            return 0;
K
Kevin Wolf 已提交
3207 3208 3209
        case 'f':
            fmt = optarg;
            break;
K
Kevin Wolf 已提交
3210 3211 3212 3213 3214 3215 3216 3217 3218
        case 'F':
            out_basefmt = optarg;
            break;
        case 'b':
            out_baseimg = optarg;
            break;
        case 'u':
            unsafe = 1;
            break;
3219 3220 3221
        case 'p':
            progress = 1;
            break;
3222 3223 3224
        case 't':
            cache = optarg;
            break;
3225 3226 3227
        case 'T':
            src_cache = optarg;
            break;
3228 3229 3230
        case 'q':
            quiet = true;
            break;
3231 3232 3233 3234 3235 3236 3237 3238
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3239 3240 3241
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
3242 3243 3244
        case 'U':
            force_share = true;
            break;
K
Kevin Wolf 已提交
3245 3246 3247
        }
    }

3248 3249 3250 3251
    if (quiet) {
        progress = 0;
    }

F
Fam Zheng 已提交
3252 3253 3254 3255 3256
    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)");
3257
    }
K
Kevin Wolf 已提交
3258 3259
    filename = argv[optind++];

3260 3261
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3262
                          NULL, &error_fatal)) {
3263 3264 3265
        return 1;
    }

3266 3267 3268
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

3269
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
3270
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3271 3272
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
3273
        goto out;
3274 3275
    }

3276 3277
    src_flags = 0;
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
3278 3279
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
3280
        goto out;
3281 3282
    }

3283 3284 3285 3286
    /* 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 已提交
3287 3288 3289 3290 3291 3292
    /*
     * 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.
     */
3293 3294
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   false);
3295
    if (!blk) {
3296 3297
        ret = -1;
        goto out;
3298
    }
3299
    bs = blk_bs(blk);
K
Kevin Wolf 已提交
3300 3301

    if (out_basefmt != NULL) {
3302
        if (bdrv_find_format(out_basefmt) == NULL) {
3303
            error_report("Invalid format name: '%s'", out_basefmt);
3304 3305
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
3306 3307 3308 3309
        }
    }

    /* For safe rebasing we need to compare old and new backing file */
3310
    if (!unsafe) {
3311
        char backing_name[PATH_MAX];
3312 3313 3314 3315
        QDict *options = NULL;

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

3319 3320 3321 3322
        if (force_share) {
            if (!options) {
                options = qdict_new();
            }
3323
            qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3324
        }
K
Kevin Wolf 已提交
3325
        bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3326
        blk_old_backing = blk_new_open(backing_name, NULL,
3327 3328
                                       options, src_flags, &local_err);
        if (!blk_old_backing) {
3329 3330 3331
            error_reportf_err(local_err,
                              "Could not open old backing file '%s': ",
                              backing_name);
3332
            ret = -1;
3333
            goto out;
K
Kevin Wolf 已提交
3334
        }
3335

3336
        if (out_baseimg[0]) {
3337 3338 3339
            const char *overlay_filename;
            char *out_real_path;

3340
            options = qdict_new();
3341
            if (out_basefmt) {
3342
                qdict_put_str(options, "driver", out_basefmt);
3343 3344 3345
            }
            if (force_share) {
                qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3346 3347
            }

3348
            bdrv_refresh_filename(bs);
3349 3350
            overlay_filename = bs->exact_filename[0] ? bs->exact_filename
                                                     : bs->filename;
3351 3352 3353 3354
            out_real_path =
                bdrv_get_full_backing_filename_from_filename(overlay_filename,
                                                             out_baseimg,
                                                             &local_err);
3355 3356 3357 3358 3359 3360 3361 3362
            if (local_err) {
                error_reportf_err(local_err,
                                  "Could not resolve backing filename: ");
                ret = -1;
                goto out;
            }

            blk_new_backing = blk_new_open(out_real_path, NULL,
3363
                                           options, src_flags, &local_err);
3364
            g_free(out_real_path);
3365
            if (!blk_new_backing) {
3366 3367 3368
                error_reportf_err(local_err,
                                  "Could not open new backing file '%s': ",
                                  out_baseimg);
3369
                ret = -1;
3370 3371
                goto out;
            }
K
Kevin Wolf 已提交
3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384
        }
    }

    /*
     * 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) {
3385 3386 3387 3388 3389
        int64_t size;
        int64_t old_backing_size;
        int64_t new_backing_size = 0;
        uint64_t offset;
        int64_t n;
3390
        float local_progress = 0;
3391

3392 3393
        buf_old = blk_blockalign(blk, IO_BUF_SIZE);
        buf_new = blk_blockalign(blk, IO_BUF_SIZE);
K
Kevin Wolf 已提交
3394

3395 3396
        size = blk_getlength(blk);
        if (size < 0) {
3397
            error_report("Could not get size of '%s': %s",
3398
                         filename, strerror(-size));
3399 3400 3401
            ret = -1;
            goto out;
        }
3402 3403
        old_backing_size = blk_getlength(blk_old_backing);
        if (old_backing_size < 0) {
3404
            char backing_name[PATH_MAX];
3405 3406 3407

            bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
            error_report("Could not get size of '%s': %s",
3408
                         backing_name, strerror(-old_backing_size));
3409 3410 3411
            ret = -1;
            goto out;
        }
3412
        if (blk_new_backing) {
3413 3414
            new_backing_size = blk_getlength(blk_new_backing);
            if (new_backing_size < 0) {
3415
                error_report("Could not get size of '%s': %s",
3416
                             out_baseimg, strerror(-new_backing_size));
3417 3418 3419
                ret = -1;
                goto out;
            }
3420
        }
K
Kevin Wolf 已提交
3421

3422 3423
        if (size != 0) {
            local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
3424 3425
        }

3426 3427 3428
        for (offset = 0; offset < size; offset += n) {
            /* How many bytes can we handle with the next read? */
            n = MIN(IO_BUF_SIZE, size - offset);
K
Kevin Wolf 已提交
3429 3430

            /* If the cluster is allocated, we don't need to take action */
3431
            ret = bdrv_is_allocated(bs, offset, n, &n);
3432 3433 3434 3435 3436
            if (ret < 0) {
                error_report("error while reading image metadata: %s",
                             strerror(-ret));
                goto out;
            }
3437
            if (ret) {
K
Kevin Wolf 已提交
3438 3439 3440
                continue;
            }

3441 3442 3443 3444
            /*
             * Read old and new backing file and take into consideration that
             * backing files may be smaller than the COW image.
             */
3445 3446
            if (offset >= old_backing_size) {
                memset(buf_old, 0, n);
3447
            } else {
3448 3449
                if (offset + n > old_backing_size) {
                    n = old_backing_size - offset;
3450 3451
                }

3452
                ret = blk_pread(blk_old_backing, offset, buf_old, n);
3453 3454 3455 3456
                if (ret < 0) {
                    error_report("error while reading from old backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3457
            }
3458

3459 3460
            if (offset >= new_backing_size || !blk_new_backing) {
                memset(buf_new, 0, n);
3461
            } else {
3462 3463
                if (offset + n > new_backing_size) {
                    n = new_backing_size - offset;
3464 3465
                }

3466
                ret = blk_pread(blk_new_backing, offset, buf_new, n);
3467 3468 3469 3470
                if (ret < 0) {
                    error_report("error while reading from new backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3471 3472 3473 3474 3475
            }

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

3476
            while (written < n) {
3477
                int64_t pnum;
K
Kevin Wolf 已提交
3478

3479 3480
                if (compare_buffers(buf_old + written, buf_new + written,
                                    n - written, &pnum))
K
Kevin Wolf 已提交
3481
                {
3482
                    ret = blk_pwrite(blk, offset + written,
3483
                                     buf_old + written, pnum, 0);
K
Kevin Wolf 已提交
3484
                    if (ret < 0) {
3485
                        error_report("Error while writing to COW image: %s",
K
Kevin Wolf 已提交
3486
                            strerror(-ret));
3487
                        goto out;
K
Kevin Wolf 已提交
3488 3489 3490 3491 3492
                    }
                }

                written += pnum;
            }
3493
            qemu_progress_print(local_progress, 100);
K
Kevin Wolf 已提交
3494 3495 3496 3497 3498 3499 3500 3501
        }
    }

    /*
     * 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.
     */
3502 3503 3504 3505 3506 3507
    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 已提交
3508
    if (ret == -ENOSPC) {
3509 3510
        error_report("Could not change the backing file to '%s': No "
                     "space left in the file header", out_baseimg);
K
Kevin Wolf 已提交
3511
    } else if (ret < 0) {
3512
        error_report("Could not change the backing file to '%s': %s",
K
Kevin Wolf 已提交
3513 3514 3515
            out_baseimg, strerror(-ret));
    }

3516
    qemu_progress_print(100, 0);
K
Kevin Wolf 已提交
3517 3518 3519 3520 3521 3522
    /*
     * 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.
     */
3523
out:
3524
    qemu_progress_end();
K
Kevin Wolf 已提交
3525 3526
    /* Cleanup */
    if (!unsafe) {
M
Markus Armbruster 已提交
3527 3528
        blk_unref(blk_old_backing);
        blk_unref(blk_new_backing);
K
Kevin Wolf 已提交
3529
    }
P
Paolo Bonzini 已提交
3530 3531
    qemu_vfree(buf_old);
    qemu_vfree(buf_new);
K
Kevin Wolf 已提交
3532

M
Markus Armbruster 已提交
3533
    blk_unref(blk);
3534 3535 3536
    if (ret) {
        return 1;
    }
K
Kevin Wolf 已提交
3537 3538 3539
    return 0;
}

3540 3541
static int img_resize(int argc, char **argv)
{
3542
    Error *err = NULL;
3543 3544
    int c, ret, relative;
    const char *filename, *fmt, *size;
M
Max Reitz 已提交
3545
    int64_t n, total_size, current_size, new_size;
3546
    bool quiet = false;
M
Markus Armbruster 已提交
3547
    BlockBackend *blk = NULL;
3548
    PreallocMode prealloc = PREALLOC_MODE_OFF;
3549
    QemuOpts *param;
3550

3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561
    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 */
            }
3562 3563
        },
    };
3564
    bool image_opts = false;
3565
    bool shrink = false;
3566

K
Kevin Wolf 已提交
3567 3568 3569
    /* Remove size from argv manually so that negative numbers are not treated
     * as options by getopt. */
    if (argc < 3) {
F
Fam Zheng 已提交
3570
        error_exit("Not enough arguments");
K
Kevin Wolf 已提交
3571 3572 3573 3574 3575 3576
        return 1;
    }

    size = argv[--argc];

    /* Parse getopt arguments */
3577 3578
    fmt = NULL;
    for(;;) {
3579 3580 3581
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3582
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3583
            {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
3584
            {"shrink", no_argument, 0, OPTION_SHRINK},
3585 3586
            {0, 0, 0, 0}
        };
3587
        c = getopt_long(argc, argv, ":f:hq",
3588
                        long_options, NULL);
3589 3590 3591 3592
        if (c == -1) {
            break;
        }
        switch(c) {
3593 3594 3595
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
3596
        case '?':
3597 3598
            unrecognized_option(argv[optind - 1]);
            break;
3599 3600 3601 3602 3603 3604
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
3605 3606 3607
        case 'q':
            quiet = true;
            break;
3608 3609 3610 3611 3612 3613 3614 3615
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3616 3617 3618
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
3619
        case OPTION_PREALLOCATION:
3620
            prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
3621
                                       PREALLOC_MODE__MAX, NULL);
3622 3623 3624 3625 3626
            if (prealloc == PREALLOC_MODE__MAX) {
                error_report("Invalid preallocation mode '%s'", optarg);
                return 1;
            }
            break;
3627 3628 3629
        case OPTION_SHRINK:
            shrink = true;
            break;
3630 3631
        }
    }
3632
    if (optind != argc - 1) {
3633
        error_exit("Expecting image file name and size");
3634 3635 3636
    }
    filename = argv[optind++];

3637 3638
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3639
                          NULL, &error_fatal)) {
3640 3641 3642
        return 1;
    }

3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658
    /* 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 */
3659
    param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3660
    qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3661 3662
    if (err) {
        error_report_err(err);
3663
        ret = -1;
3664
        qemu_opts_del(param);
3665
        goto out;
3666
    }
3667 3668
    n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
    qemu_opts_del(param);
3669

3670
    blk = img_open(image_opts, filename, fmt,
3671 3672
                   BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
                   false);
3673
    if (!blk) {
3674 3675
        ret = -1;
        goto out;
3676
    }
3677

3678 3679 3680 3681 3682 3683 3684 3685
    current_size = blk_getlength(blk);
    if (current_size < 0) {
        error_report("Failed to inquire current image length: %s",
                     strerror(-current_size));
        ret = -1;
        goto out;
    }

3686
    if (relative) {
3687
        total_size = current_size + n * relative;
3688 3689 3690 3691
    } else {
        total_size = n;
    }
    if (total_size <= 0) {
3692
        error_report("New image size must be positive");
3693 3694
        ret = -1;
        goto out;
3695 3696
    }

3697 3698 3699 3700 3701 3702
    if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
        error_report("Preallocation can only be used for growing images");
        ret = -1;
        goto out;
    }

3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719
    if (total_size < current_size && !shrink) {
        warn_report("Shrinking an image will delete all data beyond the "
                    "shrunken image's end. Before performing such an "
                    "operation, make sure there is no important data there.");

        if (g_strcmp0(bdrv_get_format_name(blk_bs(blk)), "raw") != 0) {
            error_report(
              "Use the --shrink option to perform a shrink operation.");
            ret = -1;
            goto out;
        } else {
            warn_report("Using the --shrink option will suppress this message. "
                        "Note that future versions of qemu-img may refuse to "
                        "shrink images without this option.");
        }
    }

3720
    ret = blk_truncate(blk, total_size, prealloc, &err);
M
Max Reitz 已提交
3721
    if (ret < 0) {
3722
        error_report_err(err);
M
Max Reitz 已提交
3723 3724 3725 3726 3727 3728 3729 3730 3731
        goto out;
    }

    new_size = blk_getlength(blk);
    if (new_size < 0) {
        error_report("Failed to verify truncated image length: %s",
                     strerror(-new_size));
        ret = -1;
        goto out;
3732
    }
M
Max Reitz 已提交
3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756

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

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

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

3757
out:
M
Markus Armbruster 已提交
3758
    blk_unref(blk);
3759 3760 3761
    if (ret) {
        return 1;
    }
3762 3763 3764
    return 0;
}

3765
static void amend_status_cb(BlockDriverState *bs,
3766 3767
                            int64_t offset, int64_t total_work_size,
                            void *opaque)
3768 3769 3770 3771
{
    qemu_progress_print(100.f * offset / total_work_size, 0);
}

3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792
static int print_amend_option_help(const char *format)
{
    BlockDriver *drv;

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

    if (!drv->bdrv_amend_options) {
        error_report("Format driver '%s' does not support option amendment",
                     format);
        return 1;
    }

    /* Every driver supporting amendment must have create_opts */
    assert(drv->create_opts);

    printf("Creation options for '%s':\n", format);
M
Max Reitz 已提交
3793
    qemu_opts_print_help(drv->create_opts, false);
3794 3795 3796 3797
    printf("\nNote that not all of these options may be amendable.\n");
    return 0;
}

M
Max Reitz 已提交
3798 3799
static int img_amend(int argc, char **argv)
{
3800
    Error *err = NULL;
M
Max Reitz 已提交
3801 3802
    int c, ret = 0;
    char *options = NULL;
3803 3804
    QemuOptsList *create_opts = NULL;
    QemuOpts *opts = NULL;
3805 3806
    const char *fmt = NULL, *filename, *cache;
    int flags;
3807
    bool writethrough;
3808
    bool quiet = false, progress = false;
M
Markus Armbruster 已提交
3809
    BlockBackend *blk = NULL;
M
Max Reitz 已提交
3810
    BlockDriverState *bs = NULL;
3811
    bool image_opts = false;
M
Max Reitz 已提交
3812

3813
    cache = BDRV_DEFAULT_CACHE;
M
Max Reitz 已提交
3814
    for (;;) {
3815 3816 3817
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3818
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3819 3820
            {0, 0, 0, 0}
        };
3821
        c = getopt_long(argc, argv, ":ho:f:t:pq",
3822
                        long_options, NULL);
M
Max Reitz 已提交
3823 3824 3825 3826 3827
        if (c == -1) {
            break;
        }

        switch (c) {
3828 3829 3830
        case ':':
            missing_argument(argv[optind - 1]);
            break;
3831
        case '?':
3832 3833 3834
            unrecognized_option(argv[optind - 1]);
            break;
        case 'h':
3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873
            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 已提交
3874 3875 3876
        }
    }

3877
    if (!options) {
F
Fam Zheng 已提交
3878
        error_exit("Must specify options (-o)");
M
Max Reitz 已提交
3879 3880
    }

3881 3882
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3883
                          NULL, &error_fatal)) {
3884 3885 3886 3887
        ret = -1;
        goto out_no_progress;
    }

3888 3889 3890 3891 3892
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);

3893 3894 3895 3896
    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 */
3897
        ret = print_amend_option_help(fmt);
3898
        goto out;
M
Max Reitz 已提交
3899 3900
    }

3901
    if (optind != argc - 1) {
M
Max Reitz 已提交
3902 3903 3904
        error_report("Expecting one image file name");
        ret = -1;
        goto out;
3905
    }
M
Max Reitz 已提交
3906

3907 3908
    flags = BDRV_O_RDWR;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3909 3910 3911 3912 3913
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        goto out;
    }

3914 3915
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   false);
3916
    if (!blk) {
M
Max Reitz 已提交
3917 3918 3919
        ret = -1;
        goto out;
    }
3920
    bs = blk_bs(blk);
M
Max Reitz 已提交
3921 3922 3923

    fmt = bs->drv->format_name;

3924
    if (has_help_option(options)) {
3925
        /* If the format was auto-detected, print option help here */
3926
        ret = print_amend_option_help(fmt);
M
Max Reitz 已提交
3927 3928 3929
        goto out;
    }

3930 3931
    if (!bs->drv->bdrv_amend_options) {
        error_report("Format driver '%s' does not support option amendment",
3932 3933 3934 3935 3936
                     fmt);
        ret = -1;
        goto out;
    }

3937 3938 3939
    /* Every driver supporting amendment must have create_opts */
    assert(bs->drv->create_opts);

C
Chunyan Liu 已提交
3940
    create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3941
    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
P
Paolo Bonzini 已提交
3942 3943 3944 3945 3946
    qemu_opts_do_parse(opts, options, NULL, &err);
    if (err) {
        error_report_err(err);
        ret = -1;
        goto out;
M
Max Reitz 已提交
3947 3948
    }

3949 3950
    /* In case the driver does not call amend_status_cb() */
    qemu_progress_print(0.f, 0);
3951
    ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, &err);
3952
    qemu_progress_print(100.f, 0);
M
Max Reitz 已提交
3953
    if (ret < 0) {
3954
        error_report_err(err);
M
Max Reitz 已提交
3955 3956 3957 3958
        goto out;
    }

out:
3959 3960
    qemu_progress_end();

3961
out_no_progress:
M
Markus Armbruster 已提交
3962
    blk_unref(blk);
3963 3964
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
3965 3966
    g_free(options);

M
Max Reitz 已提交
3967 3968 3969 3970 3971 3972
    if (ret) {
        return 1;
    }
    return 0;
}

K
Kevin Wolf 已提交
3973 3974 3975
typedef struct BenchData {
    BlockBackend *blk;
    uint64_t image_size;
K
Kevin Wolf 已提交
3976
    bool write;
K
Kevin Wolf 已提交
3977
    int bufsize;
3978
    int step;
K
Kevin Wolf 已提交
3979 3980
    int nrreq;
    int n;
3981 3982
    int flush_interval;
    bool drain_on_flush;
K
Kevin Wolf 已提交
3983 3984 3985 3986
    uint8_t *buf;
    QEMUIOVector *qiov;

    int in_flight;
3987
    bool in_flush;
K
Kevin Wolf 已提交
3988 3989 3990
    uint64_t offset;
} BenchData;

3991 3992 3993
static void bench_undrained_flush_cb(void *opaque, int ret)
{
    if (ret < 0) {
3994
        error_report("Failed flush request: %s", strerror(-ret));
3995 3996 3997 3998
        exit(EXIT_FAILURE);
    }
}

K
Kevin Wolf 已提交
3999 4000 4001 4002 4003 4004
static void bench_cb(void *opaque, int ret)
{
    BenchData *b = opaque;
    BlockAIOCB *acb;

    if (ret < 0) {
4005
        error_report("Failed request: %s", strerror(-ret));
K
Kevin Wolf 已提交
4006 4007
        exit(EXIT_FAILURE);
    }
4008 4009 4010 4011 4012 4013 4014 4015

    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 已提交
4016 4017
        b->n--;
        b->in_flight--;
4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040

        /* 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 已提交
4041 4042 4043
    }

    while (b->n > b->in_flight && b->in_flight < b->nrreq) {
4044 4045 4046 4047 4048 4049 4050 4051
        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 已提交
4052
        if (b->write) {
4053
            acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
K
Kevin Wolf 已提交
4054
        } else {
4055
            acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
K
Kevin Wolf 已提交
4056
        }
K
Kevin Wolf 已提交
4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069
        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 已提交
4070
    bool is_write = false;
K
Kevin Wolf 已提交
4071 4072
    int count = 75000;
    int depth = 64;
4073
    int64_t offset = 0;
K
Kevin Wolf 已提交
4074
    size_t bufsize = 4096;
K
Kevin Wolf 已提交
4075
    int pattern = 0;
4076
    size_t step = 0;
4077 4078
    int flush_interval = 0;
    bool drain_on_flush = true;
K
Kevin Wolf 已提交
4079 4080 4081 4082
    int64_t image_size;
    BlockBackend *blk = NULL;
    BenchData data = {};
    int flags = 0;
4083
    bool writethrough = false;
K
Kevin Wolf 已提交
4084 4085
    struct timeval t1, t2;
    int i;
4086
    bool force_share = false;
F
Fam Zheng 已提交
4087
    size_t buf_size;
K
Kevin Wolf 已提交
4088 4089 4090 4091

    for (;;) {
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
4092
            {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
K
Kevin Wolf 已提交
4093
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
K
Kevin Wolf 已提交
4094
            {"pattern", required_argument, 0, OPTION_PATTERN},
4095
            {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
4096
            {"force-share", no_argument, 0, 'U'},
K
Kevin Wolf 已提交
4097 4098
            {0, 0, 0, 0}
        };
4099
        c = getopt_long(argc, argv, ":hc:d:f:no:qs:S:t:wU", long_options, NULL);
K
Kevin Wolf 已提交
4100 4101 4102 4103 4104
        if (c == -1) {
            break;
        }

        switch (c) {
4105 4106 4107
        case ':':
            missing_argument(argv[optind - 1]);
            break;
K
Kevin Wolf 已提交
4108
        case '?':
4109 4110 4111
            unrecognized_option(argv[optind - 1]);
            break;
        case 'h':
K
Kevin Wolf 已提交
4112 4113 4114 4115
            help();
            break;
        case 'c':
        {
4116 4117 4118
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
K
Kevin Wolf 已提交
4119 4120 4121
                error_report("Invalid request count specified");
                return 1;
            }
4122
            count = res;
K
Kevin Wolf 已提交
4123 4124 4125 4126
            break;
        }
        case 'd':
        {
4127 4128 4129
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
K
Kevin Wolf 已提交
4130 4131 4132
                error_report("Invalid queue depth specified");
                return 1;
            }
4133
            depth = res;
K
Kevin Wolf 已提交
4134 4135 4136 4137 4138 4139 4140 4141
            break;
        }
        case 'f':
            fmt = optarg;
            break;
        case 'n':
            flags |= BDRV_O_NATIVE_AIO;
            break;
4142 4143
        case 'o':
        {
4144 4145
            offset = cvtnum(optarg);
            if (offset < 0) {
4146 4147 4148 4149 4150 4151
                error_report("Invalid offset specified");
                return 1;
            }
            break;
        }
            break;
K
Kevin Wolf 已提交
4152 4153 4154 4155 4156 4157 4158
        case 'q':
            quiet = true;
            break;
        case 's':
        {
            int64_t sval;

4159 4160
            sval = cvtnum(optarg);
            if (sval < 0 || sval > INT_MAX) {
K
Kevin Wolf 已提交
4161 4162 4163 4164 4165 4166 4167
                error_report("Invalid buffer size specified");
                return 1;
            }

            bufsize = sval;
            break;
        }
4168 4169 4170 4171
        case 'S':
        {
            int64_t sval;

4172 4173
            sval = cvtnum(optarg);
            if (sval < 0 || sval > INT_MAX) {
4174 4175 4176 4177 4178 4179 4180
                error_report("Invalid step size specified");
                return 1;
            }

            step = sval;
            break;
        }
K
Kevin Wolf 已提交
4181 4182 4183 4184 4185 4186 4187 4188
        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 已提交
4189 4190 4191 4192
        case 'w':
            flags |= BDRV_O_RDWR;
            is_write = true;
            break;
4193 4194 4195
        case 'U':
            force_share = true;
            break;
K
Kevin Wolf 已提交
4196 4197
        case OPTION_PATTERN:
        {
4198 4199 4200
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
K
Kevin Wolf 已提交
4201 4202 4203
                error_report("Invalid pattern byte specified");
                return 1;
            }
4204
            pattern = res;
K
Kevin Wolf 已提交
4205 4206
            break;
        }
4207 4208
        case OPTION_FLUSH_INTERVAL:
        {
4209 4210 4211
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4212 4213 4214
                error_report("Invalid flush interval specified");
                return 1;
            }
4215
            flush_interval = res;
4216 4217 4218 4219 4220
            break;
        }
        case OPTION_NO_DRAIN:
            drain_on_flush = false;
            break;
K
Kevin Wolf 已提交
4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
        }
    }

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

4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242
    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;
    }

4243 4244
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   force_share);
K
Kevin Wolf 已提交
4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256
    if (!blk) {
        ret = -1;
        goto out;
    }

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

    data = (BenchData) {
4257 4258 4259 4260 4261 4262 4263 4264 4265 4266
        .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 已提交
4267
    };
4268
    printf("Sending %d %s requests, %d bytes each, %d in parallel "
4269
           "(starting at offset %" PRId64 ", step size %d)\n",
4270
           data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
4271
           data.offset, data.step);
4272 4273 4274
    if (flush_interval) {
        printf("Sending flush every %d requests\n", flush_interval);
    }
K
Kevin Wolf 已提交
4275

F
Fam Zheng 已提交
4276 4277
    buf_size = data.nrreq * data.bufsize;
    data.buf = blk_blockalign(blk, buf_size);
K
Kevin Wolf 已提交
4278 4279
    memset(data.buf, pattern, data.nrreq * data.bufsize);

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

K
Kevin Wolf 已提交
4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301
    data.qiov = g_new(QEMUIOVector, data.nrreq);
    for (i = 0; i < data.nrreq; i++) {
        qemu_iovec_init(&data.qiov[i], 1);
        qemu_iovec_add(&data.qiov[i],
                       data.buf + i * data.bufsize, data.bufsize);
    }

    gettimeofday(&t1, NULL);
    bench_cb(&data, 0);

    while (data.n > 0) {
        main_loop_wait(false);
    }
    gettimeofday(&t2, NULL);

    printf("Run completed in %3.3f seconds.\n",
           (t2.tv_sec - t1.tv_sec)
           + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));

out:
F
Fam Zheng 已提交
4302 4303 4304
    if (data.buf) {
        blk_unregister_buf(blk, data.buf);
    }
K
Kevin Wolf 已提交
4305 4306 4307 4308
    qemu_vfree(data.buf);
    blk_unref(blk);

    if (ret) {
R
Reda Sallahi 已提交
4309 4310 4311 4312 4313 4314 4315 4316 4317
        return 1;
    }
    return 0;
}

#define C_BS      01
#define C_COUNT   02
#define C_IF      04
#define C_OF      010
R
Reda Sallahi 已提交
4318
#define C_SKIP    020
R
Reda Sallahi 已提交
4319 4320 4321 4322 4323 4324 4325 4326 4327 4328

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

struct DdIo {
    int bsz;    /* Block size */
    char *filename;
    uint8_t *buf;
R
Reda Sallahi 已提交
4329
    int64_t offset;
R
Reda Sallahi 已提交
4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343
};

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;

4344
    res = cvtnum(arg);
R
Reda Sallahi 已提交
4345

4346
    if (res <= 0 || res > INT_MAX) {
R
Reda Sallahi 已提交
4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358
        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)
{
4359
    dd->count = cvtnum(arg);
R
Reda Sallahi 已提交
4360

4361
    if (dd->count < 0) {
R
Reda Sallahi 已提交
4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386
        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 已提交
4387 4388 4389 4390
static int img_dd_skip(const char *arg,
                       struct DdIo *in, struct DdIo *out,
                       struct DdInfo *dd)
{
4391
    in->offset = cvtnum(arg);
R
Reda Sallahi 已提交
4392

4393
    if (in->offset < 0) {
R
Reda Sallahi 已提交
4394 4395 4396 4397 4398 4399 4400
        error_report("invalid number: '%s'", arg);
        return 1;
    }

    return 0;
}

R
Reda Sallahi 已提交
4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416
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;
4417
    bool force_share = false;
R
Reda Sallahi 已提交
4418 4419 4420 4421 4422 4423 4424
    struct DdInfo dd = {
        .flags = 0,
        .count = 0,
    };
    struct DdIo in = {
        .bsz = 512, /* Block size is by default 512 bytes */
        .filename = NULL,
R
Reda Sallahi 已提交
4425 4426
        .buf = NULL,
        .offset = 0
R
Reda Sallahi 已提交
4427 4428 4429 4430
    };
    struct DdIo out = {
        .bsz = 512,
        .filename = NULL,
R
Reda Sallahi 已提交
4431 4432
        .buf = NULL,
        .offset = 0
R
Reda Sallahi 已提交
4433 4434 4435 4436 4437 4438 4439
    };

    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 已提交
4440
        { "skip", img_dd_skip, C_SKIP },
R
Reda Sallahi 已提交
4441 4442 4443 4444
        { NULL, NULL, 0 }
    };
    const struct option long_options[] = {
        { "help", no_argument, 0, 'h'},
4445
        { "object", required_argument, 0, OPTION_OBJECT},
R
Reda Sallahi 已提交
4446
        { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4447
        { "force-share", no_argument, 0, 'U'},
R
Reda Sallahi 已提交
4448 4449 4450
        { 0, 0, 0, 0 }
    };

4451
    while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
R
Reda Sallahi 已提交
4452 4453 4454 4455 4456 4457 4458 4459 4460 4461
        if (c == EOF) {
            break;
        }
        switch (c) {
        case 'O':
            out_fmt = optarg;
            break;
        case 'f':
            fmt = optarg;
            break;
4462 4463 4464
        case ':':
            missing_argument(argv[optind - 1]);
            break;
R
Reda Sallahi 已提交
4465
        case '?':
4466 4467
            unrecognized_option(argv[optind - 1]);
            break;
R
Reda Sallahi 已提交
4468 4469 4470
        case 'h':
            help();
            break;
4471 4472 4473
        case 'U':
            force_share = true;
            break;
4474 4475
        case OPTION_OBJECT:
            if (!qemu_opts_parse_noisily(&qemu_object_opts, optarg, true)) {
4476 4477 4478
                ret = -1;
                goto out;
            }
4479
            break;
R
Reda Sallahi 已提交
4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523
        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;
    }
4524 4525 4526

    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
4527
                          NULL, &error_fatal)) {
4528 4529 4530 4531
        ret = -1;
        goto out;
    }

4532 4533
    blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
                    force_share);
R
Reda Sallahi 已提交
4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581

    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 已提交
4582 4583 4584 4585 4586 4587 4588 4589
    /* 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 已提交
4590 4591 4592 4593 4594 4595 4596 4597 4598 4599

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

4600 4601 4602 4603 4604
    /* 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.
     */
4605
    blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
4606
                         false, false, false);
R
Reda Sallahi 已提交
4607 4608 4609 4610 4611 4612

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

R
Reda Sallahi 已提交
4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623
    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 已提交
4624 4625
    in.buf = g_new(uint8_t, in.bsz);

R
Reda Sallahi 已提交
4626
    for (out_pos = 0; in_pos < size; block_count++) {
R
Reda Sallahi 已提交
4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664
        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 已提交
4665 4666 4667 4668 4669
        return 1;
    }
    return 0;
}

4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680
static void dump_json_block_measure_info(BlockMeasureInfo *info)
{
    QString *str;
    QObject *obj;
    Visitor *v = qobject_output_visitor_new(&obj);

    visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
    visit_complete(v, &obj);
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
4681
    qobject_unref(obj);
4682
    visit_free(v);
4683
    qobject_unref(str);
4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803
}

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

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

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

    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
4804
                          NULL, &error_fatal)) {
4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902
        goto out;
    }

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

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

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

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

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

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

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

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

    ret = 0;

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

A
Anthony Liguori 已提交
4904
static const img_cmd_t img_cmds[] = {
4905 4906 4907 4908 4909 4910 4911
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
    { NULL, NULL, },
};

B
bellard 已提交
4912 4913
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
4914
    const img_cmd_t *cmd;
4915
    const char *cmdname;
4916
    Error *local_error = NULL;
4917
    char *trace_file = NULL;
4918 4919 4920
    int c;
    static const struct option long_options[] = {
        {"help", no_argument, 0, 'h'},
4921
        {"version", no_argument, 0, 'V'},
4922
        {"trace", required_argument, NULL, 'T'},
4923 4924
        {0, 0, 0, 0}
    };
B
bellard 已提交
4925

4926 4927 4928 4929
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

4930
    error_init(argv[0]);
4931
    module_call_init(MODULE_INIT_TRACE);
4932
    qemu_init_exec_dir(argv[0]);
K
Kevin Wolf 已提交
4933

4934
    if (qemu_init_main_loop(&local_error)) {
4935
        error_report_err(local_error);
4936 4937 4938
        exit(EXIT_FAILURE);
    }

4939
    qcrypto_init(&error_fatal);
4940

4941
    module_call_init(MODULE_INIT_QOM);
B
bellard 已提交
4942
    bdrv_init();
F
Fam Zheng 已提交
4943 4944 4945
    if (argc < 2) {
        error_exit("Not enough arguments");
    }
4946

4947
    qemu_add_opts(&qemu_object_opts);
4948
    qemu_add_opts(&qemu_source_opts);
4949
    qemu_add_opts(&qemu_trace_opts);
4950

4951
    while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
4952
        switch (c) {
4953 4954 4955
        case ':':
            missing_argument(argv[optind - 1]);
            return 0;
4956
        case '?':
4957 4958 4959
            unrecognized_option(argv[optind - 1]);
            return 0;
        case 'h':
4960 4961 4962 4963 4964
            help();
            return 0;
        case 'V':
            printf(QEMU_IMG_VERSION);
            return 0;
4965 4966 4967 4968
        case 'T':
            g_free(trace_file);
            trace_file = trace_opt_parse(optarg);
            break;
4969
        }
B
bellard 已提交
4970
    }
4971

4972
    cmdname = argv[optind];
4973

4974 4975 4976
    /* reset getopt_long scanning */
    argc -= optind;
    if (argc < 1) {
4977 4978
        return 0;
    }
4979
    argv += optind;
4980
    qemu_reset_optind();
4981

4982 4983 4984 4985 4986 4987
    if (!trace_init_backends()) {
        exit(1);
    }
    trace_init_file(trace_file);
    qemu_set_log(LOG_TRACE);

4988 4989 4990 4991 4992 4993
    /* find the command */
    for (cmd = img_cmds; cmd->name != NULL; cmd++) {
        if (!strcmp(cmdname, cmd->name)) {
            return cmd->handler(argc, argv);
        }
    }
4994

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