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

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

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

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

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

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

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

F
Fam Zheng 已提交
77 78 79 80 81 82 83 84 85 86 87 88 89 90
static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
{
    va_list ap;

    error_printf("qemu-img: ");

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

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

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

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

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

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

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

B
bellard 已提交
230

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

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

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

255 256
    qemu_opts_print_help(create_opts);
    qemu_opts_free(create_opts);
257 258 259
    return 0;
}

260 261

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

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


284
static BlockBackend *img_open_opts(const char *optstr,
285
                                   QemuOpts *opts, int flags, bool writethrough,
286
                                   bool quiet)
287 288 289 290 291
{
    QDict *options;
    Error *local_err = NULL;
    BlockBackend *blk;
    options = qemu_opts_to_qdict(opts, NULL);
292
    blk = blk_new_open(NULL, NULL, options, flags, &local_err);
293
    if (!blk) {
294
        error_reportf_err(local_err, "Could not open '%s': ", optstr);
295 296
        return NULL;
    }
297
    blk_set_enable_write_cache(blk, !writethrough);
298

299
    if (img_open_password(blk, optstr, flags, quiet) < 0) {
300 301 302 303 304 305
        blk_unref(blk);
        return NULL;
    }
    return blk;
}

306
static BlockBackend *img_open_file(const char *filename,
307
                                   const char *fmt, int flags,
308
                                   bool writethrough, bool quiet)
309 310
{
    BlockBackend *blk;
311
    Error *local_err = NULL;
312
    QDict *options = NULL;
313

314
    if (fmt) {
315 316
        options = qdict_new();
        qdict_put(options, "driver", qstring_from_str(fmt));
317
    }
318

319
    blk = blk_new_open(filename, NULL, options, flags, &local_err);
320
    if (!blk) {
321
        error_reportf_err(local_err, "Could not open '%s': ", filename);
322
        return NULL;
323
    }
324
    blk_set_enable_write_cache(blk, !writethrough);
325

326
    if (img_open_password(blk, filename, flags, quiet) < 0) {
327 328 329 330 331 332 333
        blk_unref(blk);
        return NULL;
    }
    return blk;
}


334
static BlockBackend *img_open(bool image_opts,
335
                              const char *filename,
336
                              const char *fmt, int flags, bool writethrough,
337
                              bool quiet)
338 339 340 341 342 343 344 345 346 347 348 349 350
{
    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;
        }
351
        blk = img_open_opts(filename, opts, flags, writethrough, quiet);
352
    } else {
353
        blk = img_open_file(filename, fmt, flags, writethrough, quiet);
354
    }
355
    return blk;
356 357
}

358

359
static int add_old_style_options(const char *fmt, QemuOpts *opts,
360 361
                                 const char *base_filename,
                                 const char *base_fmt)
362
{
363 364
    Error *err = NULL;

365
    if (base_filename) {
366
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
367
        if (err) {
368 369
            error_report("Backing file not supported for file format '%s'",
                         fmt);
370
            error_free(err);
371
            return -1;
372 373 374
        }
    }
    if (base_fmt) {
375
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
376
        if (err) {
377 378
            error_report("Backing file format not supported for file "
                         "format '%s'", fmt);
379
            error_free(err);
380
            return -1;
381 382
        }
    }
383
    return 0;
384 385
}

386 387
static int64_t cvtnum(const char *s)
{
388
    int err;
389
    uint64_t value;
390

391 392 393 394
    err = qemu_strtosz(s, NULL, &value);
    if (err < 0) {
        return err;
    }
395 396 397
    if (value > INT64_MAX) {
        return -ERANGE;
    }
398
    return value;
399 400
}

B
bellard 已提交
401 402
static int img_create(int argc, char **argv)
{
403
    int c;
404
    uint64_t img_size = -1;
B
bellard 已提交
405
    const char *fmt = "raw";
406
    const char *base_fmt = NULL;
B
bellard 已提交
407 408
    const char *filename;
    const char *base_filename = NULL;
409
    char *options = NULL;
410
    Error *local_err = NULL;
411
    bool quiet = false;
412

B
bellard 已提交
413
    for(;;) {
414 415 416 417 418
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
            {0, 0, 0, 0}
        };
419
        c = getopt_long(argc, argv, ":F:b:f:he6o:q",
420
                        long_options, NULL);
421
        if (c == -1) {
B
bellard 已提交
422
            break;
423
        }
B
bellard 已提交
424
        switch(c) {
425 426 427
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
428
        case '?':
429 430
            unrecognized_option(argv[optind - 1]);
            break;
B
bellard 已提交
431 432 433
        case 'h':
            help();
            break;
434 435 436
        case 'F':
            base_fmt = optarg;
            break;
B
bellard 已提交
437 438 439 440 441 442 443
        case 'b':
            base_filename = optarg;
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'e':
444
            error_report("option -e is deprecated, please use \'-o "
445
                  "encryption\' instead!");
446
            goto fail;
447
        case '6':
448
            error_report("option -6 is deprecated, please use \'-o "
449
                  "compat6\' instead!");
450
            goto fail;
451
        case 'o':
452 453 454 455 456 457 458 459 460 461 462
            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);
            }
463
            break;
464 465 466
        case 'q':
            quiet = true;
            break;
467 468 469 470 471 472 473 474
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                goto fail;
            }
        }   break;
B
bellard 已提交
475 476
        }
    }
477

478
    /* Get the filename */
479 480 481 482 483 484
    filename = (optind < argc) ? argv[optind] : NULL;
    if (options && has_help_option(options)) {
        g_free(options);
        return print_block_option_help(filename, fmt);
    }

485
    if (optind >= argc) {
F
Fam Zheng 已提交
486
        error_exit("Expecting image file name");
487
    }
488
    optind++;
489

490 491
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
492
                          NULL, NULL)) {
493 494 495
        goto fail;
    }

496 497
    /* Get image size, if specified */
    if (optind < argc) {
498
        int64_t sval;
499 500 501

        sval = cvtnum(argv[optind++]);
        if (sval < 0) {
502 503 504 505
            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, "
506 507 508
                      "G, T, P or E suffixes for ");
                error_report("kilobytes, megabytes, gigabytes, terabytes, "
                             "petabytes and exabytes.");
509
            }
510
            goto fail;
511 512 513
        }
        img_size = (uint64_t)sval;
    }
514
    if (optind != argc) {
F
Fam Zheng 已提交
515
        error_exit("Unexpected argument: %s", argv[optind]);
516
    }
517

518
    bdrv_img_create(filename, fmt, base_filename, base_fmt,
519
                    options, img_size, 0, quiet, &local_err);
520
    if (local_err) {
521
        error_reportf_err(local_err, "%s: ", filename);
522
        goto fail;
523
    }
524

525
    g_free(options);
B
bellard 已提交
526
    return 0;
527 528 529 530

fail:
    g_free(options);
    return 1;
B
bellard 已提交
531 532
}

533
static void dump_json_image_check(ImageCheck *check, bool quiet)
534 535 536
{
    QString *str;
    QObject *obj;
537
    Visitor *v = qobject_output_visitor_new(&obj);
538 539 540

    visit_type_ImageCheck(v, NULL, &check, &error_abort);
    visit_complete(v, &obj);
541 542
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
543
    qprintf(quiet, "%s\n", qstring_get_str(str));
544
    qobject_decref(obj);
545
    visit_free(v);
546 547 548
    QDECREF(str);
}

549
static void dump_human_image_check(ImageCheck *check, bool quiet)
550 551
{
    if (!(check->corruptions || check->leaks || check->check_errors)) {
552
        qprintf(quiet, "No errors were found on the image.\n");
553 554
    } else {
        if (check->corruptions) {
555 556 557 558
            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);
559 560 561
        }

        if (check->leaks) {
562 563 564 565
            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);
566 567 568
        }

        if (check->check_errors) {
569 570 571 572
            qprintf(quiet,
                    "\n%" PRId64
                    " internal errors have occurred during the check.\n",
                    check->check_errors);
573 574 575 576
        }
    }

    if (check->total_clusters != 0 && check->allocated_clusters != 0) {
577 578 579 580 581 582 583
        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);
584 585 586
    }

    if (check->image_end_offset) {
587 588
        qprintf(quiet,
                "Image end offset: %" PRId64 "\n", check->image_end_offset);
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
    }
}

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;
625 626
    check->compressed_clusters      = result.bfi.compressed_clusters;
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
627 628 629 630

    return 0;
}

631 632 633
/*
 * Checks an image for consistency. Exit codes:
 *
M
Max Reitz 已提交
634 635 636 637 638
 *  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
639
 */
640 641 642
static int img_check(int argc, char **argv)
{
    int c, ret;
643
    OutputFormat output_format = OFORMAT_HUMAN;
644
    const char *filename, *fmt, *output, *cache;
M
Markus Armbruster 已提交
645
    BlockBackend *blk;
646
    BlockDriverState *bs;
647
    int fix = 0;
648 649
    int flags = BDRV_O_CHECK;
    bool writethrough;
650
    ImageCheck *check;
651
    bool quiet = false;
652
    bool image_opts = false;
653 654

    fmt = NULL;
655
    output = NULL;
656
    cache = BDRV_DEFAULT_CACHE;
657

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

726 727 728 729 730 731 732 733 734
    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;
    }

735 736
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
737
                          NULL, NULL)) {
738 739 740
        return 1;
    }

741
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
742 743 744 745 746
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        return 1;
    }

747
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
748 749
    if (!blk) {
        return 1;
750
    }
751
    bs = blk_bs(blk);
752 753 754

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
755 756

    if (ret == -ENOTSUP) {
757
        error_report("This image format does not support checks");
758
        ret = 63;
759
        goto fail;
760 761
    }

762 763
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
764

765 766
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
767

768
        if (output_format == OFORMAT_HUMAN) {
769 770 771 772 773 774 775
            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);
776 777
        }

778
        ret = collect_image_check(bs, check, filename, fmt, 0);
779

780 781
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
782 783
    }

M
Max Reitz 已提交
784 785 786 787 788 789 790 791 792
    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;
        }
793 794
    }

795
    if (ret || check->check_errors) {
M
Max Reitz 已提交
796 797 798 799 800
        if (ret) {
            error_report("Check failed: %s", strerror(-ret));
        } else {
            error_report("Check failed");
        }
801 802
        ret = 1;
        goto fail;
803
    }
804

805 806 807 808
    if (check->corruptions) {
        ret = 2;
    } else if (check->leaks) {
        ret = 3;
809
    } else {
810
        ret = 0;
811
    }
812 813 814

fail:
    qapi_free_ImageCheck(check);
M
Markus Armbruster 已提交
815
    blk_unref(blk);
816
    return ret;
817 818
}

M
Max Reitz 已提交
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
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 已提交
835
    AioContext *aio_context = blk_get_aio_context(job->blk);
M
Max Reitz 已提交
836

837 838
    /* FIXME In error cases, the job simply goes away and we access a dangling
     * pointer below. */
839
    aio_context_acquire(aio_context);
M
Max Reitz 已提交
840 841
    do {
        aio_poll(aio_context, true);
842 843
        qemu_progress_print(job->len ?
                            ((float)job->offset / job->len * 100.f) : 0.0f, 0);
M
Max Reitz 已提交
844 845 846
    } while (!job->ready);

    block_job_complete_sync(job, errp);
847
    aio_context_release(aio_context);
848 849 850 851

    /* A block job may finish instantaneously without publishing any progress,
     * so just signal completion here */
    qemu_progress_print(100.f, 0);
M
Max Reitz 已提交
852 853
}

B
bellard 已提交
854 855
static int img_commit(int argc, char **argv)
{
856
    int c, ret, flags;
857
    const char *filename, *fmt, *cache, *base;
M
Markus Armbruster 已提交
858
    BlockBackend *blk;
M
Max Reitz 已提交
859
    BlockDriverState *bs, *base_bs;
860
    BlockJob *job;
861
    bool progress = false, quiet = false, drop = false;
862
    bool writethrough;
M
Max Reitz 已提交
863 864
    Error *local_err = NULL;
    CommonBlockJobCBInfo cbi;
865
    bool image_opts = false;
866
    AioContext *aio_context;
B
bellard 已提交
867 868

    fmt = NULL;
869
    cache = BDRV_DEFAULT_CACHE;
870
    base = NULL;
B
bellard 已提交
871
    for(;;) {
872 873 874
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
875
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
876 877
            {0, 0, 0, 0}
        };
878
        c = getopt_long(argc, argv, ":f:ht:b:dpq",
879
                        long_options, NULL);
880
        if (c == -1) {
B
bellard 已提交
881
            break;
882
        }
B
bellard 已提交
883
        switch(c) {
884 885 886
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
887
        case '?':
888 889
            unrecognized_option(argv[optind - 1]);
            break;
B
bellard 已提交
890 891 892 893 894 895
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
896 897 898
        case 't':
            cache = optarg;
            break;
899 900 901 902 903
        case 'b':
            base = optarg;
            /* -b implies -d */
            drop = true;
            break;
M
Max Reitz 已提交
904 905 906
        case 'd':
            drop = true;
            break;
907 908 909
        case 'p':
            progress = true;
            break;
910 911 912
        case 'q':
            quiet = true;
            break;
913 914 915 916 917 918 919 920
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
921 922 923
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
B
bellard 已提交
924 925
        }
    }
926 927 928 929 930 931

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

932
    if (optind != argc - 1) {
F
Fam Zheng 已提交
933
        error_exit("Expecting one image file name");
934
    }
B
bellard 已提交
935 936
    filename = argv[optind++];

937 938
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
939
                          NULL, NULL)) {
940 941 942
        return 1;
    }

M
Max Reitz 已提交
943
    flags = BDRV_O_RDWR | BDRV_O_UNMAP;
944
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
945 946
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
947
        return 1;
948 949
    }

950
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
951 952
    if (!blk) {
        return 1;
953
    }
954 955
    bs = blk_bs(blk);

956 957 958
    qemu_progress_init(progress, 1.f);
    qemu_progress_print(0.f, 100);

959 960 961
    if (base) {
        base_bs = bdrv_find_backing_image(bs, base);
        if (!base_bs) {
962 963 964
            error_setg(&local_err,
                       "Did not find '%s' in the backing chain of '%s'",
                       base, filename);
965 966 967 968 969 970
            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. */
971
        base_bs = backing_bs(bs);
972 973 974 975
        if (!base_bs) {
            error_setg(&local_err, "Image does not have a backing file");
            goto done;
        }
M
Max Reitz 已提交
976 977 978 979 980 981 982
    }

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

983 984
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);
985
    commit_active_start("commit", bs, base_bs, BLOCK_JOB_DEFAULT, 0,
986
                        BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
987
                        &cbi, false, &local_err);
988
    aio_context_release(aio_context);
M
Max Reitz 已提交
989 990
    if (local_err) {
        goto done;
B
bellard 已提交
991 992
    }

993 994 995 996
    /* 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 已提交
997
    if (!drop) {
998
        bdrv_ref(bs);
M
Max Reitz 已提交
999 1000
    }

1001 1002
    job = block_job_get("commit");
    run_block_job(job, &local_err);
M
Max Reitz 已提交
1003 1004 1005 1006
    if (local_err) {
        goto unref_backing;
    }

1007 1008
    if (!drop && bs->drv->bdrv_make_empty) {
        ret = bs->drv->bdrv_make_empty(bs);
M
Max Reitz 已提交
1009 1010 1011 1012 1013 1014 1015 1016 1017
        if (ret) {
            error_setg_errno(&local_err, -ret, "Could not empty %s",
                             filename);
            goto unref_backing;
        }
    }

unref_backing:
    if (!drop) {
1018
        bdrv_unref(bs);
M
Max Reitz 已提交
1019
    }
M
Max Reitz 已提交
1020 1021

done:
1022 1023
    qemu_progress_end();

M
Markus Armbruster 已提交
1024
    blk_unref(blk);
M
Max Reitz 已提交
1025 1026

    if (local_err) {
1027
        error_report_err(local_err);
1028 1029
        return 1;
    }
M
Max Reitz 已提交
1030 1031

    qprintf(quiet, "Image committed.\n");
B
bellard 已提交
1032 1033 1034
    return 0;
}

1035 1036 1037 1038 1039 1040 1041
/*
 * Returns true iff the first sector pointed to by 'buf' contains at least
 * a non-NUL byte.
 *
 * 'pnum' is set to the number of sectors (including and immediately following
 * the first one) that are known to be in the same allocated/unallocated state.
 */
B
bellard 已提交
1042 1043
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
{
1044 1045
    bool is_zero;
    int i;
B
bellard 已提交
1046 1047 1048 1049 1050

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
1051
    is_zero = buffer_is_zero(buf, 512);
B
bellard 已提交
1052 1053
    for(i = 1; i < n; i++) {
        buf += 512;
1054
        if (is_zero != buffer_is_zero(buf, 512)) {
B
bellard 已提交
1055
            break;
1056
        }
B
bellard 已提交
1057 1058
    }
    *pnum = i;
1059
    return !is_zero;
B
bellard 已提交
1060 1061
}

1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
/*
 * Like is_allocated_sectors, but if the buffer starts with a used sector,
 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
 * breaking up write requests for only small sparse areas.
 */
static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
    int min)
{
    int ret;
    int num_checked, num_used;

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

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

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

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

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

    *pnum = num_used;
    return 1;
}

K
Kevin Wolf 已提交
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
/*
 * Compares two buffers sector by sector. Returns 0 if the first sector of both
 * buffers matches, non-zero otherwise.
 *
 * pnum is set to the number of sectors (including and immediately following
 * the first one) that are known to have the same comparison result
 */
static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
    int *pnum)
{
1114 1115
    bool res;
    int i;
K
Kevin Wolf 已提交
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135

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

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

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

    *pnum = i;
    return res;
}

1136
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
1137

1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
static int64_t sectors_to_bytes(int64_t sectors)
{
    return sectors << BDRV_SECTOR_BITS;
}

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

/*
 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
 *
 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
 * data and negative value on error.
 *
1154
 * @param blk:  BlockBackend for the image
1155 1156 1157 1158 1159 1160
 * @param sect_num: Number of first sector to check
 * @param sect_count: Number of sectors to check
 * @param filename: Name of disk file we are checking (logging purpose)
 * @param buffer: Allocated buffer for storing read data
 * @param quiet: Flag for quiet mode
 */
1161
static int check_empty_sectors(BlockBackend *blk, int64_t sect_num,
1162 1163 1164 1165
                               int sect_count, const char *filename,
                               uint8_t *buffer, bool quiet)
{
    int pnum, ret = 0;
1166 1167
    ret = blk_pread(blk, sect_num << BDRV_SECTOR_BITS, buffer,
                    sect_count << BDRV_SECTOR_BITS);
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
    if (ret < 0) {
        error_report("Error while reading offset %" PRId64 " of %s: %s",
                     sectors_to_bytes(sect_num), filename, strerror(-ret));
        return ret;
    }
    ret = is_allocated_sectors(buffer, sect_count, &pnum);
    if (ret || pnum != sect_count) {
        qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
                sectors_to_bytes(ret ? sect_num : sect_num + pnum));
        return 1;
    }

    return 0;
}

/*
 * Compares two images. Exit codes:
 *
 * 0 - Images are identical
 * 1 - Images differ
 * >1 - Error occurred
 */
static int img_compare(int argc, char **argv)
{
1192
    const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
M
Markus Armbruster 已提交
1193
    BlockBackend *blk1, *blk2;
1194 1195 1196 1197 1198 1199 1200
    BlockDriverState *bs1, *bs2;
    int64_t total_sectors1, total_sectors2;
    uint8_t *buf1 = NULL, *buf2 = NULL;
    int pnum1, pnum2;
    int allocated1, allocated2;
    int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
    bool progress = false, quiet = false, strict = false;
1201
    int flags;
1202
    bool writethrough;
1203 1204 1205 1206 1207
    int64_t total_sectors;
    int64_t sector_num = 0;
    int64_t nb_sectors;
    int c, pnum;
    uint64_t progress_base;
1208
    bool image_opts = false;
1209

1210
    cache = BDRV_DEFAULT_CACHE;
1211
    for (;;) {
1212 1213 1214
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
1215
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1216 1217
            {0, 0, 0, 0}
        };
1218
        c = getopt_long(argc, argv, ":hf:F:T:pqs",
1219
                        long_options, NULL);
1220 1221 1222 1223
        if (c == -1) {
            break;
        }
        switch (c) {
1224 1225 1226
        case ':':
            missing_argument(argv[optind - 1]);
            break;
1227
        case '?':
1228 1229
            unrecognized_option(argv[optind - 1]);
            break;
1230 1231 1232 1233 1234 1235 1236 1237 1238
        case 'h':
            help();
            break;
        case 'f':
            fmt1 = optarg;
            break;
        case 'F':
            fmt2 = optarg;
            break;
1239 1240 1241
        case 'T':
            cache = optarg;
            break;
1242 1243 1244 1245 1246 1247 1248 1249 1250
        case 'p':
            progress = true;
            break;
        case 'q':
            quiet = true;
            break;
        case 's':
            strict = true;
            break;
1251 1252 1253 1254 1255 1256 1257 1258 1259
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                ret = 2;
                goto out4;
            }
        }   break;
1260 1261 1262
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
1263 1264 1265 1266 1267 1268 1269 1270 1271
        }
    }

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


1272
    if (optind != argc - 2) {
F
Fam Zheng 已提交
1273
        error_exit("Expecting two image file names");
1274 1275 1276 1277
    }
    filename1 = argv[optind++];
    filename2 = argv[optind++];

1278 1279
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
1280
                          NULL, NULL)) {
1281 1282 1283 1284
        ret = 2;
        goto out4;
    }

1285 1286 1287
    /* Initialize before goto out */
    qemu_progress_init(progress, 2.0);

1288 1289
    flags = 0;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1290 1291 1292 1293 1294 1295
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        ret = 2;
        goto out3;
    }

1296
    blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet);
1297
    if (!blk1) {
1298
        ret = 2;
1299
        goto out3;
1300 1301
    }

1302
    blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet);
1303
    if (!blk2) {
1304
        ret = 2;
1305
        goto out2;
1306
    }
1307
    bs1 = blk_bs(blk1);
1308
    bs2 = blk_bs(blk2);
1309

1310 1311 1312
    buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
    buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
    total_sectors1 = blk_nb_sectors(blk1);
1313 1314 1315 1316 1317 1318
    if (total_sectors1 < 0) {
        error_report("Can't get size of %s: %s",
                     filename1, strerror(-total_sectors1));
        ret = 4;
        goto out;
    }
1319
    total_sectors2 = blk_nb_sectors(blk2);
1320 1321 1322 1323 1324 1325
    if (total_sectors2 < 0) {
        error_report("Can't get size of %s: %s",
                     filename2, strerror(-total_sectors2));
        ret = 4;
        goto out;
    }
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337
    total_sectors = MIN(total_sectors1, total_sectors2);
    progress_base = MAX(total_sectors1, total_sectors2);

    qemu_progress_print(0, 100);

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

    for (;;) {
1338
        int64_t status1, status2;
1339 1340
        BlockDriverState *file;

1341 1342 1343 1344
        nb_sectors = sectors_to_process(total_sectors, sector_num);
        if (nb_sectors <= 0) {
            break;
        }
1345 1346
        status1 = bdrv_get_block_status_above(bs1, NULL, sector_num,
                                              total_sectors1 - sector_num,
1347
                                              &pnum1, &file);
1348
        if (status1 < 0) {
1349 1350 1351 1352
            ret = 3;
            error_report("Sector allocation test failed for %s", filename1);
            goto out;
        }
1353
        allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1354

1355 1356
        status2 = bdrv_get_block_status_above(bs2, NULL, sector_num,
                                              total_sectors2 - sector_num,
1357
                                              &pnum2, &file);
1358
        if (status2 < 0) {
1359 1360 1361 1362
            ret = 3;
            error_report("Sector allocation test failed for %s", filename2);
            goto out;
        }
1363 1364 1365 1366 1367 1368 1369
        allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
        if (pnum1) {
            nb_sectors = MIN(nb_sectors, pnum1);
        }
        if (pnum2) {
            nb_sectors = MIN(nb_sectors, pnum2);
        }
1370

1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
        if (strict) {
            if ((status1 & ~BDRV_BLOCK_OFFSET_MASK) !=
                (status2 & ~BDRV_BLOCK_OFFSET_MASK)) {
                ret = 1;
                qprintf(quiet, "Strict mode: Offset %" PRId64
                        " block status mismatch!\n",
                        sectors_to_bytes(sector_num));
                goto out;
            }
        }
        if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
            nb_sectors = MIN(pnum1, pnum2);
        } else if (allocated1 == allocated2) {
1384
            if (allocated1) {
1385 1386
                ret = blk_pread(blk1, sector_num << BDRV_SECTOR_BITS, buf1,
                                nb_sectors << BDRV_SECTOR_BITS);
1387 1388 1389 1390 1391 1392 1393
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64 " of %s:"
                                 " %s", sectors_to_bytes(sector_num), filename1,
                                 strerror(-ret));
                    ret = 4;
                    goto out;
                }
1394 1395
                ret = blk_pread(blk2, sector_num << BDRV_SECTOR_BITS, buf2,
                                nb_sectors << BDRV_SECTOR_BITS);
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64
                                 " of %s: %s", sectors_to_bytes(sector_num),
                                 filename2, strerror(-ret));
                    ret = 4;
                    goto out;
                }
                ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
                if (ret || pnum != nb_sectors) {
                    qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
                            sectors_to_bytes(
                                ret ? sector_num : sector_num + pnum));
1408
                    ret = 1;
1409 1410 1411 1412 1413 1414
                    goto out;
                }
            }
        } else {

            if (allocated1) {
1415
                ret = check_empty_sectors(blk1, sector_num, nb_sectors,
1416 1417
                                          filename1, buf1, quiet);
            } else {
1418
                ret = check_empty_sectors(blk2, sector_num, nb_sectors,
1419 1420 1421 1422 1423 1424
                                          filename2, buf1, quiet);
            }
            if (ret) {
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64 ": %s",
                                 sectors_to_bytes(sector_num), strerror(-ret));
1425
                    ret = 4;
1426 1427 1428 1429 1430 1431 1432 1433 1434
                }
                goto out;
            }
        }
        sector_num += nb_sectors;
        qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
    }

    if (total_sectors1 != total_sectors2) {
1435
        BlockBackend *blk_over;
1436 1437 1438 1439 1440 1441
        int64_t total_sectors_over;
        const char *filename_over;

        qprintf(quiet, "Warning: Image size mismatch!\n");
        if (total_sectors1 > total_sectors2) {
            total_sectors_over = total_sectors1;
1442
            blk_over = blk1;
1443 1444 1445
            filename_over = filename1;
        } else {
            total_sectors_over = total_sectors2;
1446
            blk_over = blk2;
1447 1448 1449 1450 1451 1452 1453 1454
            filename_over = filename2;
        }

        for (;;) {
            nb_sectors = sectors_to_process(total_sectors_over, sector_num);
            if (nb_sectors <= 0) {
                break;
            }
1455
            ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
1456 1457 1458 1459 1460 1461 1462 1463 1464 1465
                                          nb_sectors, &pnum);
            if (ret < 0) {
                ret = 3;
                error_report("Sector allocation test failed for %s",
                             filename_over);
                goto out;

            }
            nb_sectors = pnum;
            if (ret) {
1466
                ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
1467 1468 1469 1470 1471 1472
                                          filename_over, buf1, quiet);
                if (ret) {
                    if (ret < 0) {
                        error_report("Error while reading offset %" PRId64
                                     " of %s: %s", sectors_to_bytes(sector_num),
                                     filename_over, strerror(-ret));
1473
                        ret = 4;
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
                    }
                    goto out;
                }
            }
            sector_num += nb_sectors;
            qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
        }
    }

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

out:
    qemu_vfree(buf1);
    qemu_vfree(buf2);
M
Markus Armbruster 已提交
1489
    blk_unref(blk2);
1490
out2:
M
Markus Armbruster 已提交
1491
    blk_unref(blk1);
1492 1493
out3:
    qemu_progress_end();
1494
out4:
1495 1496 1497
    return ret;
}

1498 1499 1500 1501 1502 1503
enum ImgConvertBlockStatus {
    BLK_DATA,
    BLK_ZERO,
    BLK_BACKING_FILE,
};

P
Peter Lieven 已提交
1504 1505
#define MAX_COROUTINES 16

1506 1507 1508
typedef struct ImgConvertState {
    BlockBackend **src;
    int64_t *src_sectors;
P
Peter Lieven 已提交
1509
    int src_num;
1510 1511
    int64_t total_sectors;
    int64_t allocated_sectors;
P
Peter Lieven 已提交
1512 1513 1514
    int64_t allocated_done;
    int64_t sector_num;
    int64_t wr_offs;
1515 1516 1517 1518 1519 1520
    enum ImgConvertBlockStatus status;
    int64_t sector_next_status;
    BlockBackend *target;
    bool has_zero_init;
    bool compressed;
    bool target_has_backing;
P
Peter Lieven 已提交
1521
    bool wr_in_order;
1522 1523 1524
    int min_sparse;
    size_t cluster_sectors;
    size_t buf_sectors;
P
Peter Lieven 已提交
1525
    long num_coroutines;
P
Peter Lieven 已提交
1526 1527 1528 1529 1530
    int running_coroutines;
    Coroutine *co[MAX_COROUTINES];
    int64_t wait_sector_num[MAX_COROUTINES];
    CoMutex lock;
    int ret;
1531 1532
} ImgConvertState;

P
Peter Lieven 已提交
1533 1534
static void convert_select_part(ImgConvertState *s, int64_t sector_num,
                                int *src_cur, int64_t *src_cur_offset)
1535
{
P
Peter Lieven 已提交
1536 1537 1538 1539 1540 1541
    *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);
1542 1543 1544 1545 1546
    }
}

static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
{
P
Peter Lieven 已提交
1547 1548
    int64_t ret, src_cur_offset;
    int n, src_cur;
1549

P
Peter Lieven 已提交
1550
    convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1551 1552 1553 1554 1555

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

    if (s->sector_next_status <= sector_num) {
1556
        BlockDriverState *file;
P
Peter Lieven 已提交
1557 1558
        ret = bdrv_get_block_status(blk_bs(s->src[src_cur]),
                                    sector_num - src_cur_offset,
1559
                                    n, &n, &file);
1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570
        if (ret < 0) {
            return ret;
        }

        if (ret & BDRV_BLOCK_ZERO) {
            s->status = BLK_ZERO;
        } else if (ret & BDRV_BLOCK_DATA) {
            s->status = BLK_DATA;
        } else if (!s->target_has_backing) {
            /* Without a target backing file we must copy over the contents of
             * the backing file as well. */
1571
            /* Check block status of the backing file chain to avoid
1572 1573
             * needlessly reading zeroes and limiting the iteration to the
             * buffer size */
P
Peter Lieven 已提交
1574 1575
            ret = bdrv_get_block_status_above(blk_bs(s->src[src_cur]), NULL,
                                              sector_num - src_cur_offset,
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585
                                              n, &n, &file);
            if (ret < 0) {
                return ret;
            }

            if (ret & BDRV_BLOCK_ZERO) {
                s->status = BLK_ZERO;
            } else {
                s->status = BLK_DATA;
            }
1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612
        } else {
            s->status = BLK_BACKING_FILE;
        }

        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 已提交
1613 1614
static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
                                        int nb_sectors, uint8_t *buf)
1615
{
P
Peter Lieven 已提交
1616 1617 1618
    int n, ret;
    QEMUIOVector qiov;
    struct iovec iov;
1619 1620 1621 1622

    assert(nb_sectors <= s->buf_sectors);
    while (nb_sectors > 0) {
        BlockBackend *blk;
P
Peter Lieven 已提交
1623 1624
        int src_cur;
        int64_t bs_sectors, src_cur_offset;
1625 1626 1627 1628

        /* 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 已提交
1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640
        convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
        blk = s->src[src_cur];
        bs_sectors = s->src_sectors[src_cur];

        n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
        iov.iov_base = buf;
        iov.iov_len = n << BDRV_SECTOR_BITS;
        qemu_iovec_init_external(&qiov, &iov, 1);

        ret = blk_co_preadv(
                blk, (sector_num - src_cur_offset) << BDRV_SECTOR_BITS,
                n << BDRV_SECTOR_BITS, &qiov, 0);
1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
        if (ret < 0) {
            return ret;
        }

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

    return 0;
}

P
Peter Lieven 已提交
1653 1654 1655 1656

static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
                                         int nb_sectors, uint8_t *buf,
                                         enum ImgConvertBlockStatus status)
1657 1658
{
    int ret;
P
Peter Lieven 已提交
1659 1660
    QEMUIOVector qiov;
    struct iovec iov;
1661 1662 1663

    while (nb_sectors > 0) {
        int n = nb_sectors;
P
Peter Lieven 已提交
1664
        switch (status) {
1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
        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:
            /* We must always write compressed clusters as a whole, so don't
             * try to find zeroed parts in the buffer. We can only save the
             * write if the buffer is completely zeroed and we're allowed to
             * keep the target sparse. */
            if (s->compressed) {
                if (s->has_zero_init && s->min_sparse &&
                    buffer_is_zero(buf, n * BDRV_SECTOR_SIZE))
                {
                    assert(!s->target_has_backing);
                    break;
                }

P
Peter Lieven 已提交
1685 1686 1687 1688 1689 1690 1691
                iov.iov_base = buf;
                iov.iov_len = n << BDRV_SECTOR_BITS;
                qemu_iovec_init_external(&qiov, &iov, 1);

                ret = blk_co_pwritev(s->target, sector_num << BDRV_SECTOR_BITS,
                                     n << BDRV_SECTOR_BITS, &qiov,
                                     BDRV_REQ_WRITE_COMPRESSED);
1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703
                if (ret < 0) {
                    return ret;
                }
                break;
            }

            /* If there is real non-zero data or we're told to keep the target
             * fully allocated (-S 0), we must write it. Otherwise we can treat
             * it as zero sectors. */
            if (!s->min_sparse ||
                is_allocated_sectors_min(buf, n, &n, s->min_sparse))
            {
P
Peter Lieven 已提交
1704 1705 1706 1707 1708 1709
                iov.iov_base = buf;
                iov.iov_len = n << BDRV_SECTOR_BITS;
                qemu_iovec_init_external(&qiov, &iov, 1);

                ret = blk_co_pwritev(s->target, sector_num << BDRV_SECTOR_BITS,
                                     n << BDRV_SECTOR_BITS, &qiov, 0);
1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720
                if (ret < 0) {
                    return ret;
                }
                break;
            }
            /* fall-through */

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

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

    return 0;
}

P
Peter Lieven 已提交
1738
static void coroutine_fn convert_co_do_copy(void *opaque)
1739
{
P
Peter Lieven 已提交
1740
    ImgConvertState *s = opaque;
1741
    uint8_t *buf = NULL;
P
Peter Lieven 已提交
1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853
    int ret, i;
    int index = -1;

    for (i = 0; i < s->num_coroutines; i++) {
        if (s->co[i] == qemu_coroutine_self()) {
            index = i;
            break;
        }
    }
    assert(index >= 0);

    s->running_coroutines++;
    buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);

    while (1) {
        int n;
        int64_t sector_num;
        enum ImgConvertBlockStatus status;

        qemu_co_mutex_lock(&s->lock);
        if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
            qemu_co_mutex_unlock(&s->lock);
            goto out;
        }
        n = convert_iteration_sectors(s, s->sector_num);
        if (n < 0) {
            qemu_co_mutex_unlock(&s->lock);
            s->ret = n;
            goto out;
        }
        /* save current sector and allocation status to local variables */
        sector_num = s->sector_num;
        status = s->status;
        if (!s->min_sparse && s->status == BLK_ZERO) {
            n = MIN(n, s->buf_sectors);
        }
        /* increment global sector counter so that other coroutines can
         * already continue reading beyond this request */
        s->sector_num += n;
        qemu_co_mutex_unlock(&s->lock);

        if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
            s->allocated_done += n;
            qemu_progress_print(100.0 * s->allocated_done /
                                        s->allocated_sectors, 0);
        }

        if (status == BLK_DATA) {
            ret = convert_co_read(s, sector_num, n, buf);
            if (ret < 0) {
                error_report("error while reading sector %" PRId64
                             ": %s", sector_num, strerror(-ret));
                s->ret = ret;
                goto out;
            }
        } 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 */
            while (s->wr_offs != sector_num) {
                if (s->ret != -EINPROGRESS) {
                    goto out;
                }
                s->wait_sector_num[index] = sector_num;
                qemu_coroutine_yield();
            }
            s->wait_sector_num[index] = -1;
        }

        ret = convert_co_write(s, sector_num, n, buf, status);
        if (ret < 0) {
            error_report("error while writing sector %" PRId64
                         ": %s", sector_num, strerror(-ret));
            s->ret = ret;
            goto out;
        }

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

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

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

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

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

P
Peter Lieven 已提交
1902 1903
    while (s->ret == -EINPROGRESS) {
        main_loop_wait(false);
1904 1905
    }

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

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

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

    ImgConvertState s = (ImgConvertState) {
        /* Need at least 4k of zeros for sparse detection */
        .min_sparse         = 8,
        .buf_sectors        = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
        .wr_in_order        = true,
        .num_coroutines     = 8,
    };
B
bellard 已提交
1941 1942

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

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

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

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

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

P
Peter Lieven 已提交
2078 2079
    s.src_num = argc - optind - 1;
    out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2080

2081
    if (options && has_help_option(options)) {
2082
        ret = print_block_option_help(out_filename, out_fmt);
P
Peter Lieven 已提交
2083
        goto fail_getopt;
2084 2085
    }

P
Peter Lieven 已提交
2086 2087 2088
    if (s.src_num < 1) {
        error_report("Must specify image file name");
        goto fail_getopt;
2089 2090 2091
    }


P
Peter Lieven 已提交
2092
    /* ret is still -EINVAL until here */
2093
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2094 2095
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
P
Peter Lieven 已提交
2096
        goto fail_getopt;
2097 2098
    }

P
Peter Lieven 已提交
2099 2100 2101 2102 2103
    /* Initialize before goto out */
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);
2104 2105
    qemu_progress_print(0, 100);

P
Peter Lieven 已提交
2106 2107
    s.src = g_new0(BlockBackend *, s.src_num);
    s.src_sectors = g_new(int64_t, s.src_num);
2108

P
Peter Lieven 已提交
2109 2110 2111 2112
    for (bs_i = 0; bs_i < s.src_num; bs_i++) {
        s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
                               fmt, src_flags, src_writethrough, quiet);
        if (!s.src[bs_i]) {
2113 2114 2115
            ret = -1;
            goto out;
        }
P
Peter Lieven 已提交
2116 2117
        s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
        if (s.src_sectors[bs_i] < 0) {
2118
            error_report("Could not get size of %s: %s",
P
Peter Lieven 已提交
2119
                         argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
2120 2121 2122
            ret = -1;
            goto out;
        }
P
Peter Lieven 已提交
2123
        s.total_sectors += s.src_sectors[bs_i];
2124
    }
B
bellard 已提交
2125

2126
    if (sn_opts) {
P
Peter Lieven 已提交
2127
        bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
2128 2129 2130
                               qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
                               qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
                               &local_err);
2131
    } else if (snapshot_name != NULL) {
P
Peter Lieven 已提交
2132
        if (s.src_num > 1) {
2133
            error_report("No support for concatenating multiple snapshot");
E
edison 已提交
2134 2135 2136
            ret = -1;
            goto out;
        }
2137

P
Peter Lieven 已提交
2138 2139
        bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
                                             &local_err);
2140
    }
2141
    if (local_err) {
2142
        error_reportf_err(local_err, "Failed to load snapshot: ");
2143 2144
        ret = -1;
        goto out;
E
edison 已提交
2145 2146
    }

2147
    /* Find driver and parse its options */
B
bellard 已提交
2148
    drv = bdrv_find_format(out_fmt);
2149
    if (!drv) {
2150
        error_report("Unknown file format '%s'", out_fmt);
2151 2152 2153
        ret = -1;
        goto out;
    }
2154

2155
    proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2156
    if (!proto_drv) {
2157
        error_report_err(local_err);
2158 2159 2160
        ret = -1;
        goto out;
    }
2161

M
Max Reitz 已提交
2162 2163 2164 2165 2166 2167 2168
    if (!skip_create) {
        if (!drv->create_opts) {
            error_report("Format driver '%s' does not support image creation",
                         drv->format_name);
            ret = -1;
            goto out;
        }
2169

M
Max Reitz 已提交
2170 2171 2172 2173 2174 2175
        if (!proto_drv->create_opts) {
            error_report("Protocol driver '%s' does not support image creation",
                         proto_drv->format_name);
            ret = -1;
            goto out;
        }
2176

M
Max Reitz 已提交
2177 2178
        create_opts = qemu_opts_append(create_opts, drv->create_opts);
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2179

M
Max Reitz 已提交
2180
        opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2181 2182 2183
        if (options) {
            qemu_opts_do_parse(opts, options, NULL, &local_err);
            if (local_err) {
2184
                error_report_err(local_err);
2185 2186 2187
                ret = -1;
                goto out;
            }
M
Max Reitz 已提交
2188
        }
2189

P
Peter Lieven 已提交
2190
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
2191
                            &error_abort);
M
Max Reitz 已提交
2192 2193 2194 2195
        ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
        if (ret < 0) {
            goto out;
        }
2196
    }
2197

2198
    /* Get backing file name if -o backing_file was used */
2199
    out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2200
    if (out_baseimg_param) {
2201
        out_baseimg = out_baseimg_param;
2202
    }
P
Peter Lieven 已提交
2203
    s.target_has_backing = (bool) out_baseimg;
2204

2205 2206 2207 2208 2209 2210 2211
    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;
    }

2212
    /* Check if compression is supported */
P
Peter Lieven 已提交
2213
    if (s.compressed) {
2214 2215 2216 2217
        bool encryption =
            qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
        const char *preallocation =
            qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2218

2219
        if (!drv->bdrv_co_pwritev_compressed) {
2220
            error_report("Compression not supported for this file format");
2221 2222
            ret = -1;
            goto out;
2223 2224
        }

2225
        if (encryption) {
2226 2227
            error_report("Compression and encryption not supported at "
                         "the same time");
2228 2229
            ret = -1;
            goto out;
2230
        }
2231

2232 2233
        if (preallocation
            && strcmp(preallocation, "off"))
2234 2235 2236 2237 2238 2239
        {
            error_report("Compression and preallocation not supported at "
                         "the same time");
            ret = -1;
            goto out;
        }
2240 2241
    }

2242 2243
    if (!skip_create) {
        /* Create the new image */
C
Chunyan Liu 已提交
2244
        ret = bdrv_create(drv, out_filename, opts, &local_err);
2245
        if (ret < 0) {
2246 2247
            error_reportf_err(local_err, "%s: error while converting %s: ",
                              out_filename, out_fmt);
2248
            goto out;
B
bellard 已提交
2249 2250
        }
    }
2251

P
Peter Lieven 已提交
2252
    flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2253
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2254 2255
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2256
        goto out;
2257 2258
    }

2259 2260 2261 2262 2263
    /* XXX we should allow --image-opts to trigger use of
     * img_open() here, but then we have trouble with
     * the bdrv_create() call which takes different params.
     * Not critical right now, so fix can wait...
     */
P
Peter Lieven 已提交
2264 2265
    s.target = img_open_file(out_filename, out_fmt, flags, writethrough, quiet);
    if (!s.target) {
2266 2267 2268
        ret = -1;
        goto out;
    }
P
Peter Lieven 已提交
2269
    out_bs = blk_bs(s.target);
B
bellard 已提交
2270

2271
    /* increase bufsectors from the default 4096 (2M) if opt_transfer
2272 2273
     * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
     * as maximum. */
P
Peter Lieven 已提交
2274 2275 2276 2277 2278
    s.buf_sectors = MIN(32768,
                        MAX(s.buf_sectors,
                            MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
                                out_bs->bl.pdiscard_alignment >>
                                BDRV_SECTOR_BITS)));
2279

2280
    if (skip_create) {
P
Peter Lieven 已提交
2281
        int64_t output_sectors = blk_nb_sectors(s.target);
2282
        if (output_sectors < 0) {
2283
            error_report("unable to get output image length: %s",
2284
                         strerror(-output_sectors));
2285 2286
            ret = -1;
            goto out;
P
Peter Lieven 已提交
2287
        } else if (output_sectors < s.total_sectors) {
2288 2289 2290 2291 2292 2293
            error_report("output file is smaller than input file");
            ret = -1;
            goto out;
        }
    }

2294 2295
    ret = bdrv_get_info(out_bs, &bdi);
    if (ret < 0) {
P
Peter Lieven 已提交
2296
        if (s.compressed) {
2297
            error_report("could not get block driver info");
2298 2299
            goto out;
        }
2300
    } else {
P
Peter Lieven 已提交
2301 2302 2303
        s.compressed = s.compressed || bdi.needs_compressed_writes;
        s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
    }
2304

P
Peter Lieven 已提交
2305
    ret = convert_do_copy(&s);
2306
out:
2307 2308 2309
    if (!ret) {
        qemu_progress_print(100, 0);
    }
2310
    qemu_progress_end();
2311 2312
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
2313
    qemu_opts_del(sn_opts);
P
Peter Lieven 已提交
2314 2315 2316 2317
    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 已提交
2318
        }
P
Peter Lieven 已提交
2319
        g_free(s.src);
M
Markus Armbruster 已提交
2320
    }
P
Peter Lieven 已提交
2321
    g_free(s.src_sectors);
2322 2323 2324
fail_getopt:
    g_free(options);

P
Peter Lieven 已提交
2325
    return !!ret;
B
bellard 已提交
2326 2327
}

B
bellard 已提交
2328

B
bellard 已提交
2329 2330 2331 2332 2333 2334 2335 2336 2337
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");
2338 2339
    bdrv_snapshot_dump(fprintf, stdout, NULL);
    printf("\n");
B
bellard 已提交
2340 2341
    for(i = 0; i < nb_sns; i++) {
        sn = &sn_tab[i];
2342 2343
        bdrv_snapshot_dump(fprintf, stdout, sn);
        printf("\n");
B
bellard 已提交
2344
    }
2345
    g_free(sn_tab);
B
bellard 已提交
2346 2347
}

2348 2349 2350 2351
static void dump_json_image_info_list(ImageInfoList *list)
{
    QString *str;
    QObject *obj;
2352
    Visitor *v = qobject_output_visitor_new(&obj);
2353 2354 2355

    visit_type_ImageInfoList(v, NULL, &list, &error_abort);
    visit_complete(v, &obj);
2356 2357 2358 2359
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
2360
    visit_free(v);
2361 2362 2363
    QDECREF(str);
}

2364 2365 2366 2367
static void dump_json_image_info(ImageInfo *info)
{
    QString *str;
    QObject *obj;
2368
    Visitor *v = qobject_output_visitor_new(&obj);
2369 2370 2371

    visit_type_ImageInfo(v, NULL, &info, &error_abort);
    visit_complete(v, &obj);
2372 2373 2374 2375
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
2376
    visit_free(v);
2377 2378 2379
    QDECREF(str);
}

2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390
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;

2391
        bdrv_image_info_dump(fprintf, stdout, elem->value);
2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411
    }
}

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.
 */
2412 2413
static ImageInfoList *collect_image_info_list(bool image_opts,
                                              const char *filename,
2414 2415 2416 2417 2418 2419
                                              const char *fmt,
                                              bool chain)
{
    ImageInfoList *head = NULL;
    ImageInfoList **last = &head;
    GHashTable *filenames;
2420
    Error *err = NULL;
2421 2422 2423 2424

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

    while (filename) {
M
Markus Armbruster 已提交
2425
        BlockBackend *blk;
2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436
        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);

2437
        blk = img_open(image_opts, filename, fmt,
2438
                       BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false);
2439
        if (!blk) {
2440 2441
            goto err;
        }
2442
        bs = blk_bs(blk);
2443

2444
        bdrv_query_image_info(bs, &info, &err);
2445
        if (err) {
2446
            error_report_err(err);
M
Markus Armbruster 已提交
2447
            blk_unref(blk);
2448
            goto err;
2449
        }
2450 2451 2452 2453 2454 2455

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

M
Markus Armbruster 已提交
2456
        blk_unref(blk);
2457 2458 2459 2460 2461 2462

        filename = fmt = NULL;
        if (chain) {
            if (info->has_full_backing_filename) {
                filename = info->full_backing_filename;
            } else if (info->has_backing_filename) {
2463 2464 2465 2466
                error_report("Could not determine absolute backing filename,"
                             " but backing filename '%s' present",
                             info->backing_filename);
                goto err;
2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481
            }
            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;
}

2482 2483 2484 2485
static int img_info(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
2486
    bool chain = false;
2487
    const char *filename, *fmt, *output;
2488
    ImageInfoList *list;
2489
    bool image_opts = false;
2490

B
bellard 已提交
2491
    fmt = NULL;
2492
    output = NULL;
B
bellard 已提交
2493
    for(;;) {
2494 2495 2496 2497 2498
        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},
2499
            {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2500
            {"object", required_argument, 0, OPTION_OBJECT},
2501
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2502 2503
            {0, 0, 0, 0}
        };
2504
        c = getopt_long(argc, argv, ":f:h",
2505
                        long_options, &option_index);
2506
        if (c == -1) {
B
bellard 已提交
2507
            break;
2508
        }
B
bellard 已提交
2509
        switch(c) {
2510 2511 2512
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
2513
        case '?':
2514 2515
            unrecognized_option(argv[optind - 1]);
            break;
B
bellard 已提交
2516 2517 2518 2519 2520 2521
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2522 2523 2524
        case OPTION_OUTPUT:
            output = optarg;
            break;
2525 2526 2527
        case OPTION_BACKING_CHAIN:
            chain = true;
            break;
2528 2529 2530 2531 2532 2533 2534 2535
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2536 2537 2538
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
B
bellard 已提交
2539 2540
        }
    }
2541
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2542
        error_exit("Expecting one image file name");
2543
    }
B
bellard 已提交
2544 2545
    filename = argv[optind++];

2546 2547 2548 2549 2550 2551
    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.");
2552 2553
        return 1;
    }
2554

2555 2556
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2557
                          NULL, NULL)) {
2558 2559 2560
        return 1;
    }

2561
    list = collect_image_info_list(image_opts, filename, fmt, chain);
2562
    if (!list) {
2563
        return 1;
B
bellard 已提交
2564
    }
2565 2566 2567

    switch (output_format) {
    case OFORMAT_HUMAN:
2568
        dump_human_image_info_list(list);
2569 2570
        break;
    case OFORMAT_JSON:
2571 2572 2573 2574 2575
        if (chain) {
            dump_json_image_info_list(list);
        } else {
            dump_json_image_info(list->value);
        }
2576
        break;
B
bellard 已提交
2577
    }
2578

2579
    qapi_free_ImageInfoList(list);
B
bellard 已提交
2580 2581 2582
    return 0;
}

P
Paolo Bonzini 已提交
2583 2584 2585 2586 2587
static void dump_map_entry(OutputFormat output_format, MapEntry *e,
                           MapEntry *next)
{
    switch (output_format) {
    case OFORMAT_HUMAN:
2588
        if (e->data && !e->has_offset) {
P
Paolo Bonzini 已提交
2589 2590 2591
            error_report("File contains external, encrypted or compressed clusters.");
            exit(1);
        }
2592
        if (e->data && !e->zero) {
P
Paolo Bonzini 已提交
2593
            printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2594 2595 2596
                   e->start, e->length,
                   e->has_offset ? e->offset : 0,
                   e->has_filename ? e->filename : "");
P
Paolo Bonzini 已提交
2597 2598 2599 2600
        }
        /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
         * Modify the flags here to allow more coalescing.
         */
2601 2602 2603
        if (next && (!next->data || next->zero)) {
            next->data = false;
            next->zero = true;
P
Paolo Bonzini 已提交
2604 2605 2606
        }
        break;
    case OFORMAT_JSON:
2607 2608
        printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
               " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
P
Paolo Bonzini 已提交
2609 2610
               (e->start == 0 ? "[" : ",\n"),
               e->start, e->length, e->depth,
2611 2612 2613
               e->zero ? "true" : "false",
               e->data ? "true" : "false");
        if (e->has_offset) {
P
Paolo Bonzini 已提交
2614
            printf(", \"offset\": %"PRId64"", e->offset);
P
Paolo Bonzini 已提交
2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629
        }
        putchar('}');

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

static int get_block_status(BlockDriverState *bs, int64_t sector_num,
                            int nb_sectors, MapEntry *e)
{
    int64_t ret;
    int depth;
2630
    BlockDriverState *file;
J
John Snow 已提交
2631
    bool has_offset;
P
Paolo Bonzini 已提交
2632 2633 2634 2635 2636 2637 2638 2639

    /* 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 (;;) {
2640 2641
        ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
                                    &file);
P
Paolo Bonzini 已提交
2642 2643 2644 2645 2646 2647 2648
        if (ret < 0) {
            return ret;
        }
        assert(nb_sectors);
        if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
            break;
        }
2649
        bs = backing_bs(bs);
P
Paolo Bonzini 已提交
2650 2651 2652 2653 2654 2655 2656 2657
        if (bs == NULL) {
            ret = 0;
            break;
        }

        depth++;
    }

J
John Snow 已提交
2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671
    has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);

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

P
Paolo Bonzini 已提交
2672 2673 2674
    return 0;
}

2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695
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 已提交
2696 2697 2698 2699
static int img_map(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
M
Markus Armbruster 已提交
2700
    BlockBackend *blk;
P
Paolo Bonzini 已提交
2701 2702 2703 2704 2705
    BlockDriverState *bs;
    const char *filename, *fmt, *output;
    int64_t length;
    MapEntry curr = { .length = 0 }, next;
    int ret = 0;
2706
    bool image_opts = false;
P
Paolo Bonzini 已提交
2707 2708 2709 2710 2711 2712 2713 2714 2715

    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},
2716
            {"object", required_argument, 0, OPTION_OBJECT},
2717
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
P
Paolo Bonzini 已提交
2718 2719
            {0, 0, 0, 0}
        };
2720
        c = getopt_long(argc, argv, ":f:h",
P
Paolo Bonzini 已提交
2721 2722 2723 2724 2725
                        long_options, &option_index);
        if (c == -1) {
            break;
        }
        switch (c) {
2726 2727 2728
        case ':':
            missing_argument(argv[optind - 1]);
            break;
P
Paolo Bonzini 已提交
2729
        case '?':
2730 2731
            unrecognized_option(argv[optind - 1]);
            break;
P
Paolo Bonzini 已提交
2732 2733 2734 2735 2736 2737 2738 2739 2740
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case OPTION_OUTPUT:
            output = optarg;
            break;
2741 2742 2743 2744 2745 2746 2747 2748
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2749 2750 2751
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
P
Paolo Bonzini 已提交
2752 2753
        }
    }
F
Fam Zheng 已提交
2754 2755
    if (optind != argc - 1) {
        error_exit("Expecting one image file name");
P
Paolo Bonzini 已提交
2756
    }
F
Fam Zheng 已提交
2757
    filename = argv[optind];
P
Paolo Bonzini 已提交
2758 2759 2760 2761 2762 2763 2764 2765 2766 2767

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

2768 2769
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2770
                          NULL, NULL)) {
2771 2772 2773
        return 1;
    }

2774
    blk = img_open(image_opts, filename, fmt, 0, false, false);
2775 2776
    if (!blk) {
        return 1;
P
Paolo Bonzini 已提交
2777
    }
2778
    bs = blk_bs(blk);
P
Paolo Bonzini 已提交
2779 2780 2781 2782 2783

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

2784
    length = blk_getlength(blk);
P
Paolo Bonzini 已提交
2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801
    while (curr.start + curr.length < length) {
        int64_t nsectors_left;
        int64_t sector_num;
        int n;

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

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

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

2802
        if (entry_mergeable(&curr, &next)) {
P
Paolo Bonzini 已提交
2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815
            curr.length += next.length;
            continue;
        }

        if (curr.length > 0) {
            dump_map_entry(output_format, &curr, &next);
        }
        curr = next;
    }

    dump_map_entry(output_format, &curr, NULL);

out:
M
Markus Armbruster 已提交
2816
    blk_unref(blk);
P
Paolo Bonzini 已提交
2817 2818 2819
    return ret < 0;
}

2820 2821 2822 2823 2824
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

2825
static int img_snapshot(int argc, char **argv)
2826
{
M
Markus Armbruster 已提交
2827
    BlockBackend *blk;
2828 2829 2830
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
2831
    int c, ret = 0, bdrv_oflags;
2832 2833
    int action = 0;
    qemu_timeval tv;
2834
    bool quiet = false;
2835
    Error *err = NULL;
2836
    bool image_opts = false;
2837

2838
    bdrv_oflags = BDRV_O_RDWR;
2839 2840
    /* Parse commandline parameters */
    for(;;) {
2841 2842 2843
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
2844
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2845 2846
            {0, 0, 0, 0}
        };
2847
        c = getopt_long(argc, argv, ":la:c:d:hq",
2848
                        long_options, NULL);
2849
        if (c == -1) {
2850
            break;
2851
        }
2852
        switch(c) {
2853 2854 2855
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
2856
        case '?':
2857 2858
            unrecognized_option(argv[optind - 1]);
            break;
2859 2860
        case 'h':
            help();
2861
            return 0;
2862 2863
        case 'l':
            if (action) {
F
Fam Zheng 已提交
2864
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2865
                return 0;
2866 2867
            }
            action = SNAPSHOT_LIST;
2868
            bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2869 2870 2871
            break;
        case 'a':
            if (action) {
F
Fam Zheng 已提交
2872
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2873
                return 0;
2874 2875 2876 2877 2878 2879
            }
            action = SNAPSHOT_APPLY;
            snapshot_name = optarg;
            break;
        case 'c':
            if (action) {
F
Fam Zheng 已提交
2880
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2881
                return 0;
2882 2883 2884 2885 2886 2887
            }
            action = SNAPSHOT_CREATE;
            snapshot_name = optarg;
            break;
        case 'd':
            if (action) {
F
Fam Zheng 已提交
2888
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2889
                return 0;
2890 2891 2892 2893
            }
            action = SNAPSHOT_DELETE;
            snapshot_name = optarg;
            break;
2894 2895 2896
        case 'q':
            quiet = true;
            break;
2897 2898 2899 2900 2901 2902 2903 2904
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2905 2906 2907
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
2908 2909 2910
        }
    }

2911
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2912
        error_exit("Expecting one image file name");
2913
    }
2914 2915
    filename = argv[optind++];

2916 2917
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2918
                          NULL, NULL)) {
2919 2920 2921
        return 1;
    }

2922
    /* Open the image */
2923
    blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet);
2924 2925
    if (!blk) {
        return 1;
2926
    }
2927
    bs = blk_bs(blk);
2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943

    /* 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);
2944
        if (ret) {
2945
            error_report("Could not create snapshot '%s': %d (%s)",
2946
                snapshot_name, ret, strerror(-ret));
2947
        }
2948 2949 2950 2951
        break;

    case SNAPSHOT_APPLY:
        ret = bdrv_snapshot_goto(bs, snapshot_name);
2952
        if (ret) {
2953
            error_report("Could not apply snapshot '%s': %d (%s)",
2954
                snapshot_name, ret, strerror(-ret));
2955
        }
2956 2957 2958
        break;

    case SNAPSHOT_DELETE:
2959
        bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2960
        if (err) {
2961 2962
            error_reportf_err(err, "Could not delete snapshot '%s': ",
                              snapshot_name);
2963
            ret = 1;
2964
        }
2965 2966 2967 2968
        break;
    }

    /* Cleanup */
M
Markus Armbruster 已提交
2969
    blk_unref(blk);
2970 2971 2972
    if (ret) {
        return 1;
    }
2973
    return 0;
2974 2975
}

K
Kevin Wolf 已提交
2976 2977
static int img_rebase(int argc, char **argv)
{
M
Markus Armbruster 已提交
2978
    BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
P
Paolo Bonzini 已提交
2979 2980
    uint8_t *buf_old = NULL;
    uint8_t *buf_new = NULL;
2981
    BlockDriverState *bs = NULL;
K
Kevin Wolf 已提交
2982
    char *filename;
2983 2984
    const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
    int c, flags, src_flags, ret;
2985
    bool writethrough, src_writethrough;
K
Kevin Wolf 已提交
2986
    int unsafe = 0;
2987
    int progress = 0;
2988
    bool quiet = false;
2989
    Error *local_err = NULL;
2990
    bool image_opts = false;
K
Kevin Wolf 已提交
2991 2992

    /* Parse commandline parameters */
K
Kevin Wolf 已提交
2993
    fmt = NULL;
2994
    cache = BDRV_DEFAULT_CACHE;
2995
    src_cache = BDRV_DEFAULT_CACHE;
K
Kevin Wolf 已提交
2996 2997 2998
    out_baseimg = NULL;
    out_basefmt = NULL;
    for(;;) {
2999 3000 3001
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3002
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3003 3004
            {0, 0, 0, 0}
        };
3005
        c = getopt_long(argc, argv, ":hf:F:b:upt:T:q",
3006
                        long_options, NULL);
3007
        if (c == -1) {
K
Kevin Wolf 已提交
3008
            break;
3009
        }
K
Kevin Wolf 已提交
3010
        switch(c) {
3011 3012 3013
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
3014
        case '?':
3015 3016
            unrecognized_option(argv[optind - 1]);
            break;
K
Kevin Wolf 已提交
3017 3018 3019
        case 'h':
            help();
            return 0;
K
Kevin Wolf 已提交
3020 3021 3022
        case 'f':
            fmt = optarg;
            break;
K
Kevin Wolf 已提交
3023 3024 3025 3026 3027 3028 3029 3030 3031
        case 'F':
            out_basefmt = optarg;
            break;
        case 'b':
            out_baseimg = optarg;
            break;
        case 'u':
            unsafe = 1;
            break;
3032 3033 3034
        case 'p':
            progress = 1;
            break;
3035 3036 3037
        case 't':
            cache = optarg;
            break;
3038 3039 3040
        case 'T':
            src_cache = optarg;
            break;
3041 3042 3043
        case 'q':
            quiet = true;
            break;
3044 3045 3046 3047 3048 3049 3050 3051
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3052 3053 3054
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
K
Kevin Wolf 已提交
3055 3056 3057
        }
    }

3058 3059 3060 3061
    if (quiet) {
        progress = 0;
    }

F
Fam Zheng 已提交
3062 3063 3064 3065 3066
    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)");
3067
    }
K
Kevin Wolf 已提交
3068 3069
    filename = argv[optind++];

3070 3071
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3072
                          NULL, NULL)) {
3073 3074 3075
        return 1;
    }

3076 3077 3078
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

3079
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
3080
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3081 3082
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
3083
        goto out;
3084 3085
    }

3086 3087
    src_flags = 0;
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
3088 3089
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
3090
        goto out;
3091 3092
    }

3093 3094 3095 3096
    /* 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 已提交
3097 3098 3099 3100 3101 3102
    /*
     * 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.
     */
3103
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3104
    if (!blk) {
3105 3106
        ret = -1;
        goto out;
3107
    }
3108
    bs = blk_bs(blk);
K
Kevin Wolf 已提交
3109 3110

    if (out_basefmt != NULL) {
3111
        if (bdrv_find_format(out_basefmt) == NULL) {
3112
            error_report("Invalid format name: '%s'", out_basefmt);
3113 3114
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
3115 3116 3117 3118
        }
    }

    /* For safe rebasing we need to compare old and new backing file */
3119
    if (!unsafe) {
3120
        char backing_name[PATH_MAX];
3121 3122 3123 3124 3125 3126
        QDict *options = NULL;

        if (bs->backing_format[0] != '\0') {
            options = qdict_new();
            qdict_put(options, "driver", qstring_from_str(bs->backing_format));
        }
K
Kevin Wolf 已提交
3127 3128

        bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3129
        blk_old_backing = blk_new_open(backing_name, NULL,
3130 3131
                                       options, src_flags, &local_err);
        if (!blk_old_backing) {
3132 3133 3134
            error_reportf_err(local_err,
                              "Could not open old backing file '%s': ",
                              backing_name);
3135
            ret = -1;
3136
            goto out;
K
Kevin Wolf 已提交
3137
        }
3138

3139
        if (out_baseimg[0]) {
3140 3141 3142 3143 3144 3145 3146
            if (out_basefmt) {
                options = qdict_new();
                qdict_put(options, "driver", qstring_from_str(out_basefmt));
            } else {
                options = NULL;
            }

3147
            blk_new_backing = blk_new_open(out_baseimg, NULL,
3148 3149
                                           options, src_flags, &local_err);
            if (!blk_new_backing) {
3150 3151 3152
                error_reportf_err(local_err,
                                  "Could not open new backing file '%s': ",
                                  out_baseimg);
3153
                ret = -1;
3154 3155
                goto out;
            }
K
Kevin Wolf 已提交
3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168
        }
    }

    /*
     * 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) {
3169 3170 3171
        int64_t num_sectors;
        int64_t old_backing_num_sectors;
        int64_t new_backing_num_sectors = 0;
K
Kevin Wolf 已提交
3172
        uint64_t sector;
3173
        int n;
3174
        float local_progress = 0;
3175

3176 3177
        buf_old = blk_blockalign(blk, IO_BUF_SIZE);
        buf_new = blk_blockalign(blk, IO_BUF_SIZE);
K
Kevin Wolf 已提交
3178

3179
        num_sectors = blk_nb_sectors(blk);
3180 3181 3182 3183 3184 3185
        if (num_sectors < 0) {
            error_report("Could not get size of '%s': %s",
                         filename, strerror(-num_sectors));
            ret = -1;
            goto out;
        }
3186
        old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
3187
        if (old_backing_num_sectors < 0) {
3188
            char backing_name[PATH_MAX];
3189 3190 3191 3192 3193 3194 3195

            bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
            error_report("Could not get size of '%s': %s",
                         backing_name, strerror(-old_backing_num_sectors));
            ret = -1;
            goto out;
        }
3196 3197
        if (blk_new_backing) {
            new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
3198 3199 3200 3201 3202 3203
            if (new_backing_num_sectors < 0) {
                error_report("Could not get size of '%s': %s",
                             out_baseimg, strerror(-new_backing_num_sectors));
                ret = -1;
                goto out;
            }
3204
        }
K
Kevin Wolf 已提交
3205

3206 3207 3208 3209 3210
        if (num_sectors != 0) {
            local_progress = (float)100 /
                (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
        }

K
Kevin Wolf 已提交
3211 3212 3213 3214 3215 3216 3217 3218 3219 3220
        for (sector = 0; sector < num_sectors; sector += n) {

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

            /* If the cluster is allocated, we don't need to take action */
3221
            ret = bdrv_is_allocated(bs, sector, n, &n);
3222 3223 3224 3225 3226
            if (ret < 0) {
                error_report("error while reading image metadata: %s",
                             strerror(-ret));
                goto out;
            }
3227
            if (ret) {
K
Kevin Wolf 已提交
3228 3229 3230
                continue;
            }

3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241
            /*
             * Read old and new backing file and take into consideration that
             * backing files may be smaller than the COW image.
             */
            if (sector >= old_backing_num_sectors) {
                memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
            } else {
                if (sector + n > old_backing_num_sectors) {
                    n = old_backing_num_sectors - sector;
                }

3242 3243
                ret = blk_pread(blk_old_backing, sector << BDRV_SECTOR_BITS,
                                buf_old, n << BDRV_SECTOR_BITS);
3244 3245 3246 3247
                if (ret < 0) {
                    error_report("error while reading from old backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3248
            }
3249

3250
            if (sector >= new_backing_num_sectors || !blk_new_backing) {
3251 3252 3253 3254 3255 3256
                memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
            } else {
                if (sector + n > new_backing_num_sectors) {
                    n = new_backing_num_sectors - sector;
                }

3257 3258
                ret = blk_pread(blk_new_backing, sector << BDRV_SECTOR_BITS,
                                buf_new, n << BDRV_SECTOR_BITS);
3259 3260 3261 3262
                if (ret < 0) {
                    error_report("error while reading from new backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3263 3264 3265 3266 3267 3268 3269 3270 3271
            }

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

            while (written < n) {
                int pnum;

                if (compare_sectors(buf_old + written * 512,
3272
                    buf_new + written * 512, n - written, &pnum))
K
Kevin Wolf 已提交
3273
                {
3274 3275 3276 3277
                    ret = blk_pwrite(blk,
                                     (sector + written) << BDRV_SECTOR_BITS,
                                     buf_old + written * 512,
                                     pnum << BDRV_SECTOR_BITS, 0);
K
Kevin Wolf 已提交
3278
                    if (ret < 0) {
3279
                        error_report("Error while writing to COW image: %s",
K
Kevin Wolf 已提交
3280
                            strerror(-ret));
3281
                        goto out;
K
Kevin Wolf 已提交
3282 3283 3284 3285 3286
                    }
                }

                written += pnum;
            }
3287
            qemu_progress_print(local_progress, 100);
K
Kevin Wolf 已提交
3288 3289 3290 3291 3292 3293 3294 3295
        }
    }

    /*
     * 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.
     */
3296 3297 3298 3299 3300 3301
    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 已提交
3302
    if (ret == -ENOSPC) {
3303 3304
        error_report("Could not change the backing file to '%s': No "
                     "space left in the file header", out_baseimg);
K
Kevin Wolf 已提交
3305
    } else if (ret < 0) {
3306
        error_report("Could not change the backing file to '%s': %s",
K
Kevin Wolf 已提交
3307 3308 3309
            out_baseimg, strerror(-ret));
    }

3310
    qemu_progress_print(100, 0);
K
Kevin Wolf 已提交
3311 3312 3313 3314 3315 3316
    /*
     * 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.
     */
3317
out:
3318
    qemu_progress_end();
K
Kevin Wolf 已提交
3319 3320
    /* Cleanup */
    if (!unsafe) {
M
Markus Armbruster 已提交
3321 3322
        blk_unref(blk_old_backing);
        blk_unref(blk_new_backing);
K
Kevin Wolf 已提交
3323
    }
P
Paolo Bonzini 已提交
3324 3325
    qemu_vfree(buf_old);
    qemu_vfree(buf_new);
K
Kevin Wolf 已提交
3326

M
Markus Armbruster 已提交
3327
    blk_unref(blk);
3328 3329 3330
    if (ret) {
        return 1;
    }
K
Kevin Wolf 已提交
3331 3332 3333
    return 0;
}

3334 3335
static int img_resize(int argc, char **argv)
{
3336
    Error *err = NULL;
3337 3338 3339
    int c, ret, relative;
    const char *filename, *fmt, *size;
    int64_t n, total_size;
3340
    bool quiet = false;
M
Markus Armbruster 已提交
3341
    BlockBackend *blk = NULL;
3342
    QemuOpts *param;
3343

3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354
    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 */
            }
3355 3356
        },
    };
3357
    bool image_opts = false;
3358

K
Kevin Wolf 已提交
3359 3360 3361
    /* Remove size from argv manually so that negative numbers are not treated
     * as options by getopt. */
    if (argc < 3) {
F
Fam Zheng 已提交
3362
        error_exit("Not enough arguments");
K
Kevin Wolf 已提交
3363 3364 3365 3366 3367 3368
        return 1;
    }

    size = argv[--argc];

    /* Parse getopt arguments */
3369 3370
    fmt = NULL;
    for(;;) {
3371 3372 3373
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3374
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3375 3376
            {0, 0, 0, 0}
        };
3377
        c = getopt_long(argc, argv, ":f:hq",
3378
                        long_options, NULL);
3379 3380 3381 3382
        if (c == -1) {
            break;
        }
        switch(c) {
3383 3384 3385
        case ':':
            missing_argument(argv[optind - 1]);
            break;
J
Jes Sorensen 已提交
3386
        case '?':
3387 3388
            unrecognized_option(argv[optind - 1]);
            break;
3389 3390 3391 3392 3393 3394
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
3395 3396 3397
        case 'q':
            quiet = true;
            break;
3398 3399 3400 3401 3402 3403 3404 3405
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3406 3407 3408
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
3409 3410
        }
    }
3411
    if (optind != argc - 1) {
F
Fam Zheng 已提交
3412
        error_exit("Expecting one image file name");
3413 3414 3415
    }
    filename = argv[optind++];

3416 3417
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3418
                          NULL, NULL)) {
3419 3420 3421
        return 1;
    }

3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437
    /* 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 */
3438
    param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3439
    qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3440 3441
    if (err) {
        error_report_err(err);
3442
        ret = -1;
3443
        qemu_opts_del(param);
3444
        goto out;
3445
    }
3446 3447
    n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
    qemu_opts_del(param);
3448

3449
    blk = img_open(image_opts, filename, fmt,
3450
                   BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet);
3451
    if (!blk) {
3452 3453
        ret = -1;
        goto out;
3454
    }
3455 3456

    if (relative) {
3457
        total_size = blk_getlength(blk) + n * relative;
3458 3459 3460 3461
    } else {
        total_size = n;
    }
    if (total_size <= 0) {
3462
        error_report("New image size must be positive");
3463 3464
        ret = -1;
        goto out;
3465 3466
    }

3467
    ret = blk_truncate(blk, total_size);
3468 3469
    switch (ret) {
    case 0:
3470
        qprintf(quiet, "Image resized.\n");
3471 3472
        break;
    case -ENOTSUP:
3473
        error_report("This image does not support resize");
3474 3475
        break;
    case -EACCES:
3476
        error_report("Image is read-only");
3477 3478
        break;
    default:
3479
        error_report("Error resizing image: %s", strerror(-ret));
3480 3481
        break;
    }
3482
out:
M
Markus Armbruster 已提交
3483
    blk_unref(blk);
3484 3485 3486
    if (ret) {
        return 1;
    }
3487 3488 3489
    return 0;
}

3490
static void amend_status_cb(BlockDriverState *bs,
3491 3492
                            int64_t offset, int64_t total_work_size,
                            void *opaque)
3493 3494 3495 3496
{
    qemu_progress_print(100.f * offset / total_work_size, 0);
}

M
Max Reitz 已提交
3497 3498
static int img_amend(int argc, char **argv)
{
3499
    Error *err = NULL;
M
Max Reitz 已提交
3500 3501
    int c, ret = 0;
    char *options = NULL;
3502 3503
    QemuOptsList *create_opts = NULL;
    QemuOpts *opts = NULL;
3504 3505
    const char *fmt = NULL, *filename, *cache;
    int flags;
3506
    bool writethrough;
3507
    bool quiet = false, progress = false;
M
Markus Armbruster 已提交
3508
    BlockBackend *blk = NULL;
M
Max Reitz 已提交
3509
    BlockDriverState *bs = NULL;
3510
    bool image_opts = false;
M
Max Reitz 已提交
3511

3512
    cache = BDRV_DEFAULT_CACHE;
M
Max Reitz 已提交
3513
    for (;;) {
3514 3515 3516
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3517
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3518 3519
            {0, 0, 0, 0}
        };
3520
        c = getopt_long(argc, argv, ":ho:f:t:pq",
3521
                        long_options, NULL);
M
Max Reitz 已提交
3522 3523 3524 3525 3526
        if (c == -1) {
            break;
        }

        switch (c) {
3527 3528 3529
        case ':':
            missing_argument(argv[optind - 1]);
            break;
3530
        case '?':
3531 3532 3533
            unrecognized_option(argv[optind - 1]);
            break;
        case 'h':
3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572
            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 已提交
3573 3574 3575
        }
    }

3576
    if (!options) {
F
Fam Zheng 已提交
3577
        error_exit("Must specify options (-o)");
M
Max Reitz 已提交
3578 3579
    }

3580 3581
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3582
                          NULL, NULL)) {
3583 3584 3585 3586
        ret = -1;
        goto out_no_progress;
    }

3587 3588 3589 3590 3591
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);

3592 3593 3594 3595 3596 3597
    filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
    if (fmt && has_help_option(options)) {
        /* If a format is explicitly specified (and possibly no filename is
         * given), print option help here */
        ret = print_block_option_help(filename, fmt);
        goto out;
M
Max Reitz 已提交
3598 3599
    }

3600
    if (optind != argc - 1) {
M
Max Reitz 已提交
3601 3602 3603
        error_report("Expecting one image file name");
        ret = -1;
        goto out;
3604
    }
M
Max Reitz 已提交
3605

3606 3607
    flags = BDRV_O_RDWR;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3608 3609 3610 3611 3612
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        goto out;
    }

3613
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3614
    if (!blk) {
M
Max Reitz 已提交
3615 3616 3617
        ret = -1;
        goto out;
    }
3618
    bs = blk_bs(blk);
M
Max Reitz 已提交
3619 3620 3621

    fmt = bs->drv->format_name;

3622
    if (has_help_option(options)) {
3623
        /* If the format was auto-detected, print option help here */
M
Max Reitz 已提交
3624 3625 3626 3627
        ret = print_block_option_help(filename, fmt);
        goto out;
    }

3628 3629 3630 3631 3632 3633 3634
    if (!bs->drv->create_opts) {
        error_report("Format driver '%s' does not support any options to amend",
                     fmt);
        ret = -1;
        goto out;
    }

C
Chunyan Liu 已提交
3635
    create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3636
    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
P
Paolo Bonzini 已提交
3637 3638 3639 3640 3641
    qemu_opts_do_parse(opts, options, NULL, &err);
    if (err) {
        error_report_err(err);
        ret = -1;
        goto out;
M
Max Reitz 已提交
3642 3643
    }

3644 3645
    /* In case the driver does not call amend_status_cb() */
    qemu_progress_print(0.f, 0);
3646
    ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
3647
    qemu_progress_print(100.f, 0);
M
Max Reitz 已提交
3648 3649 3650 3651 3652 3653
    if (ret < 0) {
        error_report("Error while amending options: %s", strerror(-ret));
        goto out;
    }

out:
3654 3655
    qemu_progress_end();

3656
out_no_progress:
M
Markus Armbruster 已提交
3657
    blk_unref(blk);
3658 3659
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
3660 3661
    g_free(options);

M
Max Reitz 已提交
3662 3663 3664 3665 3666 3667
    if (ret) {
        return 1;
    }
    return 0;
}

K
Kevin Wolf 已提交
3668 3669 3670
typedef struct BenchData {
    BlockBackend *blk;
    uint64_t image_size;
K
Kevin Wolf 已提交
3671
    bool write;
K
Kevin Wolf 已提交
3672
    int bufsize;
3673
    int step;
K
Kevin Wolf 已提交
3674 3675
    int nrreq;
    int n;
3676 3677
    int flush_interval;
    bool drain_on_flush;
K
Kevin Wolf 已提交
3678 3679 3680 3681
    uint8_t *buf;
    QEMUIOVector *qiov;

    int in_flight;
3682
    bool in_flush;
K
Kevin Wolf 已提交
3683 3684 3685
    uint64_t offset;
} BenchData;

3686 3687 3688
static void bench_undrained_flush_cb(void *opaque, int ret)
{
    if (ret < 0) {
3689
        error_report("Failed flush request: %s", strerror(-ret));
3690 3691 3692 3693
        exit(EXIT_FAILURE);
    }
}

K
Kevin Wolf 已提交
3694 3695 3696 3697 3698 3699
static void bench_cb(void *opaque, int ret)
{
    BenchData *b = opaque;
    BlockAIOCB *acb;

    if (ret < 0) {
3700
        error_report("Failed request: %s", strerror(-ret));
K
Kevin Wolf 已提交
3701 3702
        exit(EXIT_FAILURE);
    }
3703 3704 3705 3706 3707 3708 3709 3710

    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 已提交
3711 3712
        b->n--;
        b->in_flight--;
3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735

        /* 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 已提交
3736 3737 3738
    }

    while (b->n > b->in_flight && b->in_flight < b->nrreq) {
3739 3740 3741 3742 3743 3744 3745 3746
        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 已提交
3747
        if (b->write) {
3748
            acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
K
Kevin Wolf 已提交
3749
        } else {
3750
            acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
K
Kevin Wolf 已提交
3751
        }
K
Kevin Wolf 已提交
3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764
        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 已提交
3765
    bool is_write = false;
K
Kevin Wolf 已提交
3766 3767
    int count = 75000;
    int depth = 64;
3768
    int64_t offset = 0;
K
Kevin Wolf 已提交
3769
    size_t bufsize = 4096;
K
Kevin Wolf 已提交
3770
    int pattern = 0;
3771
    size_t step = 0;
3772 3773
    int flush_interval = 0;
    bool drain_on_flush = true;
K
Kevin Wolf 已提交
3774 3775 3776 3777
    int64_t image_size;
    BlockBackend *blk = NULL;
    BenchData data = {};
    int flags = 0;
3778
    bool writethrough = false;
K
Kevin Wolf 已提交
3779 3780 3781 3782 3783 3784
    struct timeval t1, t2;
    int i;

    for (;;) {
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
3785
            {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
K
Kevin Wolf 已提交
3786
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
K
Kevin Wolf 已提交
3787
            {"pattern", required_argument, 0, OPTION_PATTERN},
3788
            {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
K
Kevin Wolf 已提交
3789 3790
            {0, 0, 0, 0}
        };
3791
        c = getopt_long(argc, argv, ":hc:d:f:no:qs:S:t:w", long_options, NULL);
K
Kevin Wolf 已提交
3792 3793 3794 3795 3796
        if (c == -1) {
            break;
        }

        switch (c) {
3797 3798 3799
        case ':':
            missing_argument(argv[optind - 1]);
            break;
K
Kevin Wolf 已提交
3800
        case '?':
3801 3802 3803
            unrecognized_option(argv[optind - 1]);
            break;
        case 'h':
K
Kevin Wolf 已提交
3804 3805 3806 3807
            help();
            break;
        case 'c':
        {
3808 3809 3810
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
K
Kevin Wolf 已提交
3811 3812 3813
                error_report("Invalid request count specified");
                return 1;
            }
3814
            count = res;
K
Kevin Wolf 已提交
3815 3816 3817 3818
            break;
        }
        case 'd':
        {
3819 3820 3821
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
K
Kevin Wolf 已提交
3822 3823 3824
                error_report("Invalid queue depth specified");
                return 1;
            }
3825
            depth = res;
K
Kevin Wolf 已提交
3826 3827 3828 3829 3830 3831 3832 3833
            break;
        }
        case 'f':
            fmt = optarg;
            break;
        case 'n':
            flags |= BDRV_O_NATIVE_AIO;
            break;
3834 3835
        case 'o':
        {
3836 3837
            offset = cvtnum(optarg);
            if (offset < 0) {
3838 3839 3840 3841 3842 3843
                error_report("Invalid offset specified");
                return 1;
            }
            break;
        }
            break;
K
Kevin Wolf 已提交
3844 3845 3846 3847 3848 3849 3850
        case 'q':
            quiet = true;
            break;
        case 's':
        {
            int64_t sval;

3851 3852
            sval = cvtnum(optarg);
            if (sval < 0 || sval > INT_MAX) {
K
Kevin Wolf 已提交
3853 3854 3855 3856 3857 3858 3859
                error_report("Invalid buffer size specified");
                return 1;
            }

            bufsize = sval;
            break;
        }
3860 3861 3862 3863
        case 'S':
        {
            int64_t sval;

3864 3865
            sval = cvtnum(optarg);
            if (sval < 0 || sval > INT_MAX) {
3866 3867 3868 3869 3870 3871 3872
                error_report("Invalid step size specified");
                return 1;
            }

            step = sval;
            break;
        }
K
Kevin Wolf 已提交
3873 3874 3875 3876 3877 3878 3879 3880
        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 已提交
3881 3882 3883 3884 3885 3886
        case 'w':
            flags |= BDRV_O_RDWR;
            is_write = true;
            break;
        case OPTION_PATTERN:
        {
3887 3888 3889
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
K
Kevin Wolf 已提交
3890 3891 3892
                error_report("Invalid pattern byte specified");
                return 1;
            }
3893
            pattern = res;
K
Kevin Wolf 已提交
3894 3895
            break;
        }
3896 3897
        case OPTION_FLUSH_INTERVAL:
        {
3898 3899 3900
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
3901 3902 3903
                error_report("Invalid flush interval specified");
                return 1;
            }
3904
            flush_interval = res;
3905 3906 3907 3908 3909
            break;
        }
        case OPTION_NO_DRAIN:
            drain_on_flush = false;
            break;
K
Kevin Wolf 已提交
3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
        }
    }

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

3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931
    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;
    }

K
Kevin Wolf 已提交
3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
    if (!blk) {
        ret = -1;
        goto out;
    }

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

    data = (BenchData) {
3945 3946 3947 3948 3949 3950 3951 3952 3953 3954
        .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 已提交
3955
    };
3956
    printf("Sending %d %s requests, %d bytes each, %d in parallel "
3957
           "(starting at offset %" PRId64 ", step size %d)\n",
3958
           data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
3959
           data.offset, data.step);
3960 3961 3962
    if (flush_interval) {
        printf("Sending flush every %d requests\n", flush_interval);
    }
K
Kevin Wolf 已提交
3963 3964

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

K
Kevin Wolf 已提交
3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990
    data.qiov = g_new(QEMUIOVector, data.nrreq);
    for (i = 0; i < data.nrreq; i++) {
        qemu_iovec_init(&data.qiov[i], 1);
        qemu_iovec_add(&data.qiov[i],
                       data.buf + i * data.bufsize, data.bufsize);
    }

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

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

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

out:
    qemu_vfree(data.buf);
    blk_unref(blk);

    if (ret) {
R
Reda Sallahi 已提交
3991 3992 3993 3994 3995 3996 3997 3998 3999
        return 1;
    }
    return 0;
}

#define C_BS      01
#define C_COUNT   02
#define C_IF      04
#define C_OF      010
R
Reda Sallahi 已提交
4000
#define C_SKIP    020
R
Reda Sallahi 已提交
4001 4002 4003 4004 4005 4006 4007 4008 4009 4010

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

struct DdIo {
    int bsz;    /* Block size */
    char *filename;
    uint8_t *buf;
R
Reda Sallahi 已提交
4011
    int64_t offset;
R
Reda Sallahi 已提交
4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025
};

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;

4026
    res = cvtnum(arg);
R
Reda Sallahi 已提交
4027

4028
    if (res <= 0 || res > INT_MAX) {
R
Reda Sallahi 已提交
4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040
        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)
{
4041
    dd->count = cvtnum(arg);
R
Reda Sallahi 已提交
4042

4043
    if (dd->count < 0) {
R
Reda Sallahi 已提交
4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068
        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 已提交
4069 4070 4071 4072
static int img_dd_skip(const char *arg,
                       struct DdIo *in, struct DdIo *out,
                       struct DdInfo *dd)
{
4073
    in->offset = cvtnum(arg);
R
Reda Sallahi 已提交
4074

4075
    if (in->offset < 0) {
R
Reda Sallahi 已提交
4076 4077 4078 4079 4080 4081 4082
        error_report("invalid number: '%s'", arg);
        return 1;
    }

    return 0;
}

R
Reda Sallahi 已提交
4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105
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;
    struct DdInfo dd = {
        .flags = 0,
        .count = 0,
    };
    struct DdIo in = {
        .bsz = 512, /* Block size is by default 512 bytes */
        .filename = NULL,
R
Reda Sallahi 已提交
4106 4107
        .buf = NULL,
        .offset = 0
R
Reda Sallahi 已提交
4108 4109 4110 4111
    };
    struct DdIo out = {
        .bsz = 512,
        .filename = NULL,
R
Reda Sallahi 已提交
4112 4113
        .buf = NULL,
        .offset = 0
R
Reda Sallahi 已提交
4114 4115 4116 4117 4118 4119 4120
    };

    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 已提交
4121
        { "skip", img_dd_skip, C_SKIP },
R
Reda Sallahi 已提交
4122 4123 4124 4125 4126 4127 4128 4129
        { NULL, NULL, 0 }
    };
    const struct option long_options[] = {
        { "help", no_argument, 0, 'h'},
        { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
        { 0, 0, 0, 0 }
    };

4130
    while ((c = getopt_long(argc, argv, ":hf:O:", long_options, NULL))) {
R
Reda Sallahi 已提交
4131 4132 4133 4134 4135 4136 4137 4138 4139 4140
        if (c == EOF) {
            break;
        }
        switch (c) {
        case 'O':
            out_fmt = optarg;
            break;
        case 'f':
            fmt = optarg;
            break;
4141 4142 4143
        case ':':
            missing_argument(argv[optind - 1]);
            break;
R
Reda Sallahi 已提交
4144
        case '?':
4145 4146
            unrecognized_option(argv[optind - 1]);
            break;
R
Reda Sallahi 已提交
4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242
        case 'h':
            help();
            break;
        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;
    }
    blk1 = img_open(image_opts, in.filename, fmt, 0, false, false);

    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 已提交
4243 4244 4245 4246 4247 4248 4249 4250
    /* 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 已提交
4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268

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

    blk2 = img_open(image_opts, out.filename, out_fmt, BDRV_O_RDWR,
                    false, false);

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

R
Reda Sallahi 已提交
4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279
    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 已提交
4280 4281
    in.buf = g_new(uint8_t, in.bsz);

R
Reda Sallahi 已提交
4282
    for (out_pos = 0; in_pos < size; block_count++) {
R
Reda Sallahi 已提交
4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320
        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 已提交
4321 4322 4323 4324 4325 4326
        return 1;
    }
    return 0;
}


A
Anthony Liguori 已提交
4327
static const img_cmd_t img_cmds[] = {
4328 4329 4330 4331 4332 4333 4334 4335
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
    { NULL, NULL, },
};

B
bellard 已提交
4336 4337
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
4338
    const img_cmd_t *cmd;
4339
    const char *cmdname;
4340
    Error *local_error = NULL;
4341
    char *trace_file = NULL;
4342 4343 4344
    int c;
    static const struct option long_options[] = {
        {"help", no_argument, 0, 'h'},
4345
        {"version", no_argument, 0, 'V'},
4346
        {"trace", required_argument, NULL, 'T'},
4347 4348
        {0, 0, 0, 0}
    };
B
bellard 已提交
4349

4350 4351 4352 4353
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

4354
    module_call_init(MODULE_INIT_TRACE);
K
Kevin Wolf 已提交
4355
    error_set_progname(argv[0]);
4356
    qemu_init_exec_dir(argv[0]);
K
Kevin Wolf 已提交
4357

4358
    if (qemu_init_main_loop(&local_error)) {
4359
        error_report_err(local_error);
4360 4361 4362
        exit(EXIT_FAILURE);
    }

4363
    qcrypto_init(&error_fatal);
4364

4365
    module_call_init(MODULE_INIT_QOM);
B
bellard 已提交
4366
    bdrv_init();
F
Fam Zheng 已提交
4367 4368 4369
    if (argc < 2) {
        error_exit("Not enough arguments");
    }
4370

4371
    qemu_add_opts(&qemu_object_opts);
4372
    qemu_add_opts(&qemu_source_opts);
4373
    qemu_add_opts(&qemu_trace_opts);
4374

4375
    while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
4376
        switch (c) {
4377 4378 4379
        case ':':
            missing_argument(argv[optind - 1]);
            return 0;
4380
        case '?':
4381 4382 4383
            unrecognized_option(argv[optind - 1]);
            return 0;
        case 'h':
4384 4385 4386 4387 4388
            help();
            return 0;
        case 'V':
            printf(QEMU_IMG_VERSION);
            return 0;
4389 4390 4391 4392
        case 'T':
            g_free(trace_file);
            trace_file = trace_opt_parse(optarg);
            break;
4393
        }
B
bellard 已提交
4394
    }
4395

4396
    cmdname = argv[optind];
4397

4398 4399 4400
    /* reset getopt_long scanning */
    argc -= optind;
    if (argc < 1) {
4401 4402
        return 0;
    }
4403
    argv += optind;
D
Denis V. Lunev 已提交
4404
    optind = 0;
4405

4406 4407 4408 4409 4410 4411
    if (!trace_init_backends()) {
        exit(1);
    }
    trace_init_file(trace_file);
    qemu_set_log(LOG_TRACE);

4412 4413 4414 4415 4416 4417
    /* find the command */
    for (cmd = img_cmds; cmd->name != NULL; cmd++) {
        if (!strcmp(cmdname, cmd->name)) {
            return cmd->handler(argc, argv);
        }
    }
4418

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