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

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

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

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

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

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

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

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

    error_printf("qemu-img: ");

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

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

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

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

B
blueswir1 已提交
103
/* Please keep in synch with qemu-img.texi */
F
Fam Zheng 已提交
104
static void QEMU_NORETURN help(void)
B
bellard 已提交
105
{
106
    const char *help_msg =
107
           QEMU_IMG_VERSION
108
           "usage: qemu-img [standard options] command [command options]\n"
109 110
           "QEMU disk image utility\n"
           "\n"
111 112
           "    '-h', '--help'       display this help and exit\n"
           "    '-V', '--version'    output version information and exit\n"
113 114
           "    '-T', '--trace'      [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
           "                         specify tracing options\n"
115
           "\n"
116
           "Command syntax:\n"
117 118 119 120 121
#define DEF(option, callback, arg_string)        \
           "  " arg_string "\n"
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
122 123 124
           "\n"
           "Command parameters:\n"
           "  'filename' is a disk image filename\n"
125 126 127 128
           "  'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
           "    manual page for a description of the object properties. The most common\n"
           "    object type is a 'secret', which is used to supply passwords and/or\n"
           "    encryption keys.\n"
129
           "  'fmt' is the disk image format. It is guessed automatically in most cases\n"
130
           "  'cache' is the cache mode used to write the output disk image, the valid\n"
131 132
           "    options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
           "    'directsync' and 'unsafe' (default for convert)\n"
133 134
           "  'src_cache' is the cache mode used to read input disk images, the valid\n"
           "    options are the same as for the 'cache' option\n"
135
           "  'size' is the disk image size in bytes. Optional suffixes\n"
136 137 138
           "    'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
           "    'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P)  are\n"
           "    supported. 'b' is ignored.\n"
139 140 141 142 143
           "  'output_filename' is the destination disk image filename\n"
           "  'output_fmt' is the destination format\n"
           "  'options' is a comma separated list of format specific options in a\n"
           "    name=value format. Use -o ? for an overview of the options supported by the\n"
           "    used format\n"
144 145 146 147 148
           "  'snapshot_param' is param used for internal snapshot, format\n"
           "    is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
           "    '[ID_OR_NAME]'\n"
           "  'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
           "    instead\n"
149 150 151 152 153
           "  '-c' indicates that target image must be compressed (qcow format only)\n"
           "  '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
           "       match exactly. The image doesn't need a working backing file before\n"
           "       rebasing in this case (useful for renaming the backing file)\n"
           "  '-h' with or without a command shows this help and lists the supported formats\n"
154
           "  '-p' show progress of command (only certain commands)\n"
155
           "  '-q' use Quiet mode - do not print any output (except errors)\n"
156 157 158 159 160
           "  '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
           "       contain only zeros for qemu-img to create a sparse image during\n"
           "       conversion. If the number of bytes is 0, the source will not be scanned for\n"
           "       unallocated or zero sectors, and the destination image will always be\n"
           "       fully allocated\n"
161
           "  '--output' takes the format in which the output must be done (human or json)\n"
162 163
           "  '-n' skips the target volume creation (useful if the volume is created\n"
           "       prior to running qemu-img)\n"
164
           "\n"
165 166 167 168
           "Parameters to check subcommand:\n"
           "  '-r' tries to repair any inconsistencies that are found during the check.\n"
           "       '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
           "       kinds of errors, with a higher risk of choosing the wrong fix or\n"
169
           "       hiding corruption that has already occurred.\n"
170
           "\n"
P
Peter Lieven 已提交
171 172 173 174 175
           "Parameters to convert subcommand:\n"
           "  '-m' specifies how many coroutines work in parallel during the convert\n"
           "       process (defaults to 8)\n"
           "  '-W' allow to write to the target out of order rather than sequential\n"
           "\n"
176 177 178 179 180
           "Parameters to snapshot subcommand:\n"
           "  'snapshot' is the name of the snapshot to create, apply or delete\n"
           "  '-a' applies a snapshot (revert disk to saved state)\n"
           "  '-c' creates a snapshot\n"
           "  '-d' deletes a snapshot\n"
181 182 183 184 185
           "  '-l' lists all snapshots in the given image\n"
           "\n"
           "Parameters to compare subcommand:\n"
           "  '-f' first image format\n"
           "  '-F' second image format\n"
R
Reda Sallahi 已提交
186 187 188 189 190 191 192
           "  '-s' run in Strict mode - fail on different image size or sector allocation\n"
           "\n"
           "Parameters to dd subcommand:\n"
           "  'bs=BYTES' read and write up to BYTES bytes at a time "
           "(default: 512)\n"
           "  'count=N' copy only N input blocks\n"
           "  'if=FILE' read from FILE\n"
R
Reda Sallahi 已提交
193 194
           "  'of=FILE' write to FILE\n"
           "  'skip=N' skip N bs-sized blocks at the start of input\n";
195 196

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

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

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

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

B
bellard 已提交
232

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

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

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

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

262 263

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

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


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

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

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

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

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

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


350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
static int img_add_key_secrets(void *opaque,
                               const char *name, const char *value,
                               Error **errp)
{
    QDict *options = opaque;

    if (g_str_has_suffix(name, "key-secret")) {
        qdict_put(options, name, qstring_from_str(value));
    }

    return 0;
}

static BlockBackend *img_open_new_file(const char *filename,
                                       QemuOpts *create_opts,
                                       const char *fmt, int flags,
                                       bool writethrough, bool quiet,
                                       bool force_share)
{
    QDict *options = NULL;

    options = qdict_new();
    qemu_opt_foreach(create_opts, img_add_key_secrets, options, &error_abort);

    return img_open_file(filename, options, fmt, flags, writethrough, quiet,
                         force_share);
}


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

405

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

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

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

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

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

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

525
    /* Get the filename */
526 527 528 529 530 531
    filename = (optind < argc) ? argv[optind] : NULL;
    if (options && has_help_option(options)) {
        g_free(options);
        return print_block_option_help(filename, fmt);
    }

532
    if (optind >= argc) {
F
Fam Zheng 已提交
533
        error_exit("Expecting image file name");
534
    }
535
    optind++;
536

537 538
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
539
                          NULL, NULL)) {
540 541 542
        goto fail;
    }

543 544
    /* Get image size, if specified */
    if (optind < argc) {
545
        int64_t sval;
546 547 548

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

565
    bdrv_img_create(filename, fmt, base_filename, base_fmt,
566
                    options, img_size, 0, quiet, &local_err);
567
    if (local_err) {
568
        error_reportf_err(local_err, "%s: ", filename);
569
        goto fail;
570
    }
571

572
    g_free(options);
B
bellard 已提交
573
    return 0;
574 575 576 577

fail:
    g_free(options);
    return 1;
B
bellard 已提交
578 579
}

580
static void dump_json_image_check(ImageCheck *check, bool quiet)
581 582 583
{
    QString *str;
    QObject *obj;
584
    Visitor *v = qobject_output_visitor_new(&obj);
585 586 587

    visit_type_ImageCheck(v, NULL, &check, &error_abort);
    visit_complete(v, &obj);
588 589
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
590
    qprintf(quiet, "%s\n", qstring_get_str(str));
591
    qobject_decref(obj);
592
    visit_free(v);
593 594 595
    QDECREF(str);
}

596
static void dump_human_image_check(ImageCheck *check, bool quiet)
597 598
{
    if (!(check->corruptions || check->leaks || check->check_errors)) {
599
        qprintf(quiet, "No errors were found on the image.\n");
600 601
    } else {
        if (check->corruptions) {
602 603 604 605
            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);
606 607 608
        }

        if (check->leaks) {
609 610 611 612
            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);
613 614 615
        }

        if (check->check_errors) {
616 617 618 619
            qprintf(quiet,
                    "\n%" PRId64
                    " internal errors have occurred during the check.\n",
                    check->check_errors);
620 621 622 623
        }
    }

    if (check->total_clusters != 0 && check->allocated_clusters != 0) {
624 625 626 627 628 629 630
        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);
631 632 633
    }

    if (check->image_end_offset) {
634 635
        qprintf(quiet,
                "Image end offset: %" PRId64 "\n", check->image_end_offset);
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
    }
}

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;
672 673
    check->compressed_clusters      = result.bfi.compressed_clusters;
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
674 675 676 677

    return 0;
}

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

    fmt = NULL;
703
    output = NULL;
704
    cache = BDRV_DEFAULT_CACHE;
705

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

778 779 780 781 782 783 784 785 786
    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;
    }

787 788
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
789
                          NULL, NULL)) {
790 791 792
        return 1;
    }

793
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
794 795 796 797 798
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        return 1;
    }

799 800
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   force_share);
801 802
    if (!blk) {
        return 1;
803
    }
804
    bs = blk_bs(blk);
805 806 807

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
808 809

    if (ret == -ENOTSUP) {
810
        error_report("This image format does not support checks");
811
        ret = 63;
812
        goto fail;
813 814
    }

815 816
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
817

818 819
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
820

821
        if (output_format == OFORMAT_HUMAN) {
822 823 824 825 826 827 828
            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);
829 830
        }

831
        ret = collect_image_check(bs, check, filename, fmt, 0);
832

833 834
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
835 836
    }

M
Max Reitz 已提交
837 838 839 840 841 842 843 844 845
    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;
        }
846 847
    }

848
    if (ret || check->check_errors) {
M
Max Reitz 已提交
849 850 851 852 853
        if (ret) {
            error_report("Check failed: %s", strerror(-ret));
        } else {
            error_report("Check failed");
        }
854 855
        ret = 1;
        goto fail;
856
    }
857

858 859 860 861
    if (check->corruptions) {
        ret = 2;
    } else if (check->leaks) {
        ret = 3;
862
    } else {
863
        ret = 0;
864
    }
865 866 867

fail:
    qapi_free_ImageCheck(check);
M
Markus Armbruster 已提交
868
    blk_unref(blk);
869
    return ret;
870 871
}

M
Max Reitz 已提交
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
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 已提交
888
    AioContext *aio_context = blk_get_aio_context(job->blk);
M
Max Reitz 已提交
889

890 891
    /* FIXME In error cases, the job simply goes away and we access a dangling
     * pointer below. */
892
    aio_context_acquire(aio_context);
M
Max Reitz 已提交
893 894
    do {
        aio_poll(aio_context, true);
895 896
        qemu_progress_print(job->len ?
                            ((float)job->offset / job->len * 100.f) : 0.0f, 0);
M
Max Reitz 已提交
897 898 899
    } while (!job->ready);

    block_job_complete_sync(job, errp);
900
    aio_context_release(aio_context);
901 902 903 904

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

done:
1076 1077
    qemu_progress_end();

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

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

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

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

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

1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
/*
 * 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 已提交
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
/*
 * 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)
{
1168 1169
    bool res;
    int i;
K
Kevin Wolf 已提交
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

        for (;;) {
            nb_sectors = sectors_to_process(total_sectors_over, sector_num);
            if (nb_sectors <= 0) {
                break;
            }
1516
            ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
1517 1518 1519 1520 1521 1522 1523 1524 1525 1526
                                          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) {
1527
                ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
1528 1529 1530 1531 1532 1533
                                          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));
1534
                        ret = 4;
1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549
                    }
                    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 已提交
1550
    blk_unref(blk2);
1551
out2:
M
Markus Armbruster 已提交
1552
    blk_unref(blk1);
1553 1554
out3:
    qemu_progress_end();
1555
out4:
1556 1557 1558
    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

    return 0;
}

P
Peter Lieven 已提交
1702 1703 1704 1705

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

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

P
Peter Lieven 已提交
1715
        switch (status) {
1716 1717 1718 1719 1720 1721 1722 1723
        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:
1724 1725 1726 1727 1728 1729
            /* If we're told to keep the target fully allocated (-S 0) or there
             * is real non-zero data, we must write it. Otherwise we can treat
             * it as zero sectors.
             * Compressed clusters need to be written as a whole, so in that
             * case we can only save the write if the buffer is completely
             * zeroed. */
1730
            if (!s->min_sparse ||
1731 1732 1733 1734
                (!s->compressed &&
                 is_allocated_sectors_min(buf, n, &n, s->min_sparse)) ||
                (s->compressed &&
                 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
1735
            {
P
Peter Lieven 已提交
1736 1737 1738 1739 1740
                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,
1741
                                     n << BDRV_SECTOR_BITS, &qiov, flags);
1742 1743 1744 1745 1746 1747 1748 1749 1750
                if (ret < 0) {
                    return ret;
                }
                break;
            }
            /* fall-through */

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

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

    return 0;
}

P
Peter Lieven 已提交
1771
static void coroutine_fn convert_co_do_copy(void *opaque)
1772
{
P
Peter Lieven 已提交
1773
    ImgConvertState *s = opaque;
1774
    uint8_t *buf = NULL;
P
Peter Lieven 已提交
1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796
    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);
1797
            break;
P
Peter Lieven 已提交
1798 1799 1800 1801 1802
        }
        n = convert_iteration_sectors(s, s->sector_num);
        if (n < 0) {
            qemu_co_mutex_unlock(&s->lock);
            s->ret = n;
1803
            break;
P
Peter Lieven 已提交
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
        }
        /* save current sector and allocation status to local variables */
        sector_num = s->sector_num;
        status = s->status;
        if (!s->min_sparse && s->status == BLK_ZERO) {
            n = MIN(n, s->buf_sectors);
        }
        /* increment global sector counter so that other coroutines can
         * already continue reading beyond this request */
        s->sector_num += n;
        qemu_co_mutex_unlock(&s->lock);

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

        if (status == BLK_DATA) {
            ret = convert_co_read(s, sector_num, n, buf);
            if (ret < 0) {
                error_report("error while reading sector %" PRId64
                             ": %s", sector_num, strerror(-ret));
                s->ret = ret;
            }
        } else if (!s->min_sparse && status == BLK_ZERO) {
            status = BLK_DATA;
            memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
        }

        if (s->wr_in_order) {
            /* keep writes in order */
1836
            while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
P
Peter Lieven 已提交
1837 1838 1839 1840 1841 1842
                s->wait_sector_num[index] = sector_num;
                qemu_coroutine_yield();
            }
            s->wait_sector_num[index] = -1;
        }

1843 1844 1845 1846 1847 1848 1849
        if (s->ret == -EINPROGRESS) {
            ret = convert_co_write(s, sector_num, n, buf, status);
            if (ret < 0) {
                error_report("error while writing sector %" PRId64
                             ": %s", sector_num, strerror(-ret));
                s->ret = ret;
            }
P
Peter Lieven 已提交
1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882
        }

        if (s->wr_in_order) {
            /* reenter the coroutine that might have waited
             * for this write to complete */
            s->wr_offs = sector_num + n;
            for (i = 0; i < s->num_coroutines; i++) {
                if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
                    /*
                     * A -> B -> A cannot occur because A has
                     * s->wait_sector_num[i] == -1 during A -> B.  Therefore
                     * B will never enter A during this time window.
                     */
                    qemu_coroutine_enter(s->co[i]);
                    break;
                }
            }
        }
    }

    qemu_vfree(buf);
    s->co[index] = NULL;
    s->running_coroutines--;
    if (!s->running_coroutines && s->ret == -EINPROGRESS) {
        /* the convert job finished successfully */
        s->ret = 0;
    }
}

static int convert_do_copy(ImgConvertState *s)
{
    int ret, i, n;
    int64_t sector_num = 0;
1883 1884 1885 1886 1887 1888 1889 1890 1891

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

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

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

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

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

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

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

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

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

            sval = cvtnum(optarg);
            if (sval < 0) {
2051
                error_report("Invalid minimum zero buffer size for sparse output specified");
2052
                goto fail_getopt;
2053 2054
            }

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

2105 2106 2107 2108
    if (!out_fmt && !tgt_image_opts) {
        out_fmt = "raw";
    }

2109 2110
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2111
                          NULL, NULL)) {
2112 2113 2114
        goto fail_getopt;
    }

P
Peter Lieven 已提交
2115
    if (!s.wr_in_order && s.compressed) {
P
Peter Lieven 已提交
2116 2117 2118 2119
        error_report("Out of order write and compress are mutually exclusive");
        goto fail_getopt;
    }

2120 2121 2122 2123 2124
    if (tgt_image_opts && !skip_create) {
        error_report("--target-image-opts requires use of -n flag");
        goto fail_getopt;
    }

P
Peter Lieven 已提交
2125 2126
    s.src_num = argc - optind - 1;
    out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2127

2128
    if (options && has_help_option(options)) {
2129 2130 2131 2132 2133 2134 2135
        if (out_fmt) {
            ret = print_block_option_help(out_filename, out_fmt);
            goto fail_getopt;
        } else {
            error_report("Option help requires a format be specified");
            goto fail_getopt;
        }
2136 2137
    }

P
Peter Lieven 已提交
2138 2139 2140
    if (s.src_num < 1) {
        error_report("Must specify image file name");
        goto fail_getopt;
2141 2142 2143
    }


P
Peter Lieven 已提交
2144
    /* ret is still -EINVAL until here */
2145
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2146 2147
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
P
Peter Lieven 已提交
2148
        goto fail_getopt;
2149 2150
    }

P
Peter Lieven 已提交
2151 2152 2153 2154 2155
    /* Initialize before goto out */
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);
2156 2157
    qemu_progress_print(0, 100);

P
Peter Lieven 已提交
2158 2159
    s.src = g_new0(BlockBackend *, s.src_num);
    s.src_sectors = g_new(int64_t, s.src_num);
2160

P
Peter Lieven 已提交
2161 2162
    for (bs_i = 0; bs_i < s.src_num; bs_i++) {
        s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
2163 2164
                               fmt, src_flags, src_writethrough, quiet,
                               force_share);
P
Peter Lieven 已提交
2165
        if (!s.src[bs_i]) {
2166 2167 2168
            ret = -1;
            goto out;
        }
P
Peter Lieven 已提交
2169 2170
        s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
        if (s.src_sectors[bs_i] < 0) {
2171
            error_report("Could not get size of %s: %s",
P
Peter Lieven 已提交
2172
                         argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
2173 2174 2175
            ret = -1;
            goto out;
        }
P
Peter Lieven 已提交
2176
        s.total_sectors += s.src_sectors[bs_i];
2177
    }
B
bellard 已提交
2178

2179
    if (sn_opts) {
P
Peter Lieven 已提交
2180
        bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
2181 2182 2183
                               qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
                               qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
                               &local_err);
2184
    } else if (snapshot_name != NULL) {
P
Peter Lieven 已提交
2185
        if (s.src_num > 1) {
2186
            error_report("No support for concatenating multiple snapshot");
E
edison 已提交
2187 2188 2189
            ret = -1;
            goto out;
        }
2190

P
Peter Lieven 已提交
2191 2192
        bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
                                             &local_err);
2193
    }
2194
    if (local_err) {
2195
        error_reportf_err(local_err, "Failed to load snapshot: ");
2196 2197
        ret = -1;
        goto out;
E
edison 已提交
2198 2199
    }

2200 2201 2202 2203 2204 2205 2206 2207
    if (!skip_create) {
        /* Find driver and parse its options */
        drv = bdrv_find_format(out_fmt);
        if (!drv) {
            error_report("Unknown file format '%s'", out_fmt);
            ret = -1;
            goto out;
        }
2208

2209 2210 2211 2212 2213 2214
        proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
        if (!proto_drv) {
            error_report_err(local_err);
            ret = -1;
            goto out;
        }
2215

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

M
Max Reitz 已提交
2223 2224 2225 2226 2227 2228
        if (!proto_drv->create_opts) {
            error_report("Protocol driver '%s' does not support image creation",
                         proto_drv->format_name);
            ret = -1;
            goto out;
        }
2229

M
Max Reitz 已提交
2230 2231
        create_opts = qemu_opts_append(create_opts, drv->create_opts);
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2232

M
Max Reitz 已提交
2233
        opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2234 2235 2236
        if (options) {
            qemu_opts_do_parse(opts, options, NULL, &local_err);
            if (local_err) {
2237
                error_report_err(local_err);
2238 2239 2240
                ret = -1;
                goto out;
            }
M
Max Reitz 已提交
2241
        }
2242

P
Peter Lieven 已提交
2243
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
2244
                            &error_abort);
M
Max Reitz 已提交
2245 2246 2247 2248
        ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
        if (ret < 0) {
            goto out;
        }
2249
    }
2250

2251
    /* Get backing file name if -o backing_file was used */
2252
    out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2253
    if (out_baseimg_param) {
2254
        out_baseimg = out_baseimg_param;
2255
    }
P
Peter Lieven 已提交
2256
    s.target_has_backing = (bool) out_baseimg;
2257

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

2265
    /* Check if compression is supported */
P
Peter Lieven 已提交
2266
    if (s.compressed) {
2267 2268 2269 2270
        bool encryption =
            qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
        const char *preallocation =
            qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2271

2272
        if (drv && !drv->bdrv_co_pwritev_compressed) {
2273
            error_report("Compression not supported for this file format");
2274 2275
            ret = -1;
            goto out;
2276 2277
        }

2278
        if (encryption) {
2279 2280
            error_report("Compression and encryption not supported at "
                         "the same time");
2281 2282
            ret = -1;
            goto out;
2283
        }
2284

2285 2286
        if (preallocation
            && strcmp(preallocation, "off"))
2287 2288 2289 2290 2291 2292
        {
            error_report("Compression and preallocation not supported at "
                         "the same time");
            ret = -1;
            goto out;
        }
2293 2294
    }

2295 2296
    if (!skip_create) {
        /* Create the new image */
C
Chunyan Liu 已提交
2297
        ret = bdrv_create(drv, out_filename, opts, &local_err);
2298
        if (ret < 0) {
2299 2300
            error_reportf_err(local_err, "%s: error while converting %s: ",
                              out_filename, out_fmt);
2301
            goto out;
B
bellard 已提交
2302 2303
        }
    }
2304

P
Peter Lieven 已提交
2305
    flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2306
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2307 2308
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2309
        goto out;
2310 2311
    }

2312 2313 2314 2315 2316 2317 2318 2319 2320
    if (skip_create) {
        s.target = img_open(tgt_image_opts, out_filename, out_fmt,
                            flags, writethrough, quiet, false);
    } else {
        /* TODO ultimately we should allow --target-image-opts
         * to be used even when -n is not given.
         * That has to wait for bdrv_create to be improved
         * to allow filenames in option syntax
         */
2321 2322
        s.target = img_open_new_file(out_filename, opts, out_fmt,
                                     flags, writethrough, quiet, false);
2323
    }
P
Peter Lieven 已提交
2324
    if (!s.target) {
2325 2326 2327
        ret = -1;
        goto out;
    }
P
Peter Lieven 已提交
2328
    out_bs = blk_bs(s.target);
B
bellard 已提交
2329

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

2336
    /* increase bufsectors from the default 4096 (2M) if opt_transfer
2337 2338
     * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
     * as maximum. */
P
Peter Lieven 已提交
2339 2340 2341 2342 2343
    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)));
2344

2345
    if (skip_create) {
P
Peter Lieven 已提交
2346
        int64_t output_sectors = blk_nb_sectors(s.target);
2347
        if (output_sectors < 0) {
2348
            error_report("unable to get output image length: %s",
2349
                         strerror(-output_sectors));
2350 2351
            ret = -1;
            goto out;
P
Peter Lieven 已提交
2352
        } else if (output_sectors < s.total_sectors) {
2353 2354 2355 2356 2357 2358
            error_report("output file is smaller than input file");
            ret = -1;
            goto out;
        }
    }

2359 2360
    ret = bdrv_get_info(out_bs, &bdi);
    if (ret < 0) {
P
Peter Lieven 已提交
2361
        if (s.compressed) {
2362
            error_report("could not get block driver info");
2363 2364
            goto out;
        }
2365
    } else {
P
Peter Lieven 已提交
2366 2367 2368
        s.compressed = s.compressed || bdi.needs_compressed_writes;
        s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
    }
2369

P
Peter Lieven 已提交
2370
    ret = convert_do_copy(&s);
2371
out:
2372 2373 2374
    if (!ret) {
        qemu_progress_print(100, 0);
    }
2375
    qemu_progress_end();
2376 2377
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
2378
    qemu_opts_del(sn_opts);
P
Peter Lieven 已提交
2379 2380 2381 2382
    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 已提交
2383
        }
P
Peter Lieven 已提交
2384
        g_free(s.src);
M
Markus Armbruster 已提交
2385
    }
P
Peter Lieven 已提交
2386
    g_free(s.src_sectors);
2387 2388 2389
fail_getopt:
    g_free(options);

P
Peter Lieven 已提交
2390
    return !!ret;
B
bellard 已提交
2391 2392
}

B
bellard 已提交
2393

B
bellard 已提交
2394 2395 2396 2397 2398 2399 2400 2401 2402
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");
2403 2404
    bdrv_snapshot_dump(fprintf, stdout, NULL);
    printf("\n");
B
bellard 已提交
2405 2406
    for(i = 0; i < nb_sns; i++) {
        sn = &sn_tab[i];
2407 2408
        bdrv_snapshot_dump(fprintf, stdout, sn);
        printf("\n");
B
bellard 已提交
2409
    }
2410
    g_free(sn_tab);
B
bellard 已提交
2411 2412
}

2413 2414 2415 2416
static void dump_json_image_info_list(ImageInfoList *list)
{
    QString *str;
    QObject *obj;
2417
    Visitor *v = qobject_output_visitor_new(&obj);
2418 2419 2420

    visit_type_ImageInfoList(v, NULL, &list, &error_abort);
    visit_complete(v, &obj);
2421 2422 2423 2424
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
2425
    visit_free(v);
2426 2427 2428
    QDECREF(str);
}

2429 2430 2431 2432
static void dump_json_image_info(ImageInfo *info)
{
    QString *str;
    QObject *obj;
2433
    Visitor *v = qobject_output_visitor_new(&obj);
2434 2435 2436

    visit_type_ImageInfo(v, NULL, &info, &error_abort);
    visit_complete(v, &obj);
2437 2438 2439 2440
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
2441
    visit_free(v);
2442 2443 2444
    QDECREF(str);
}

2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455
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;

2456
        bdrv_image_info_dump(fprintf, stdout, elem->value);
2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476
    }
}

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.
 */
2477 2478
static ImageInfoList *collect_image_info_list(bool image_opts,
                                              const char *filename,
2479
                                              const char *fmt,
2480
                                              bool chain, bool force_share)
2481 2482 2483 2484
{
    ImageInfoList *head = NULL;
    ImageInfoList **last = &head;
    GHashTable *filenames;
2485
    Error *err = NULL;
2486 2487 2488 2489

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

    while (filename) {
M
Markus Armbruster 已提交
2490
        BlockBackend *blk;
2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501
        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);

2502
        blk = img_open(image_opts, filename, fmt,
2503 2504
                       BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
                       force_share);
2505
        if (!blk) {
2506 2507
            goto err;
        }
2508
        bs = blk_bs(blk);
2509

2510
        bdrv_query_image_info(bs, &info, &err);
2511
        if (err) {
2512
            error_report_err(err);
M
Markus Armbruster 已提交
2513
            blk_unref(blk);
2514
            goto err;
2515
        }
2516 2517 2518 2519 2520 2521

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

M
Markus Armbruster 已提交
2522
        blk_unref(blk);
2523 2524 2525 2526 2527 2528

        filename = fmt = NULL;
        if (chain) {
            if (info->has_full_backing_filename) {
                filename = info->full_backing_filename;
            } else if (info->has_backing_filename) {
2529 2530 2531 2532
                error_report("Could not determine absolute backing filename,"
                             " but backing filename '%s' present",
                             info->backing_filename);
                goto err;
2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547
            }
            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;
}

2548 2549 2550 2551
static int img_info(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
2552
    bool chain = false;
2553
    const char *filename, *fmt, *output;
2554
    ImageInfoList *list;
2555
    bool image_opts = false;
2556
    bool force_share = false;
2557

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

2617 2618 2619 2620 2621 2622
    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.");
2623 2624
        return 1;
    }
2625

2626 2627
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2628
                          NULL, NULL)) {
2629 2630 2631
        return 1;
    }

2632 2633
    list = collect_image_info_list(image_opts, filename, fmt, chain,
                                   force_share);
2634
    if (!list) {
2635
        return 1;
B
bellard 已提交
2636
    }
2637 2638 2639

    switch (output_format) {
    case OFORMAT_HUMAN:
2640
        dump_human_image_info_list(list);
2641 2642
        break;
    case OFORMAT_JSON:
2643 2644 2645 2646 2647
        if (chain) {
            dump_json_image_info_list(list);
        } else {
            dump_json_image_info(list->value);
        }
2648
        break;
B
bellard 已提交
2649
    }
2650

2651
    qapi_free_ImageInfoList(list);
B
bellard 已提交
2652 2653 2654
    return 0;
}

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

    /* 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 (;;) {
2712 2713
        ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
                                    &file);
P
Paolo Bonzini 已提交
2714 2715 2716 2717 2718 2719 2720
        if (ret < 0) {
            return ret;
        }
        assert(nb_sectors);
        if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
            break;
        }
2721
        bs = backing_bs(bs);
P
Paolo Bonzini 已提交
2722 2723 2724 2725 2726 2727 2728 2729
        if (bs == NULL) {
            ret = 0;
            break;
        }

        depth++;
    }

J
John Snow 已提交
2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743
    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 已提交
2744 2745 2746
    return 0;
}

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

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

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

2845 2846
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2847
                          NULL, NULL)) {
2848 2849 2850
        return 1;
    }

2851
    blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
2852 2853
    if (!blk) {
        return 1;
P
Paolo Bonzini 已提交
2854
    }
2855
    bs = blk_bs(blk);
P
Paolo Bonzini 已提交
2856 2857 2858 2859 2860

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

2861
    length = blk_getlength(blk);
P
Paolo Bonzini 已提交
2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878
    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;
        }

2879
        if (entry_mergeable(&curr, &next)) {
P
Paolo Bonzini 已提交
2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892
            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 已提交
2893
    blk_unref(blk);
P
Paolo Bonzini 已提交
2894 2895 2896
    return ret < 0;
}

2897 2898 2899 2900 2901
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

2902
static int img_snapshot(int argc, char **argv)
2903
{
M
Markus Armbruster 已提交
2904
    BlockBackend *blk;
2905 2906 2907
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
2908
    int c, ret = 0, bdrv_oflags;
2909 2910
    int action = 0;
    qemu_timeval tv;
2911
    bool quiet = false;
2912
    Error *err = NULL;
2913
    bool image_opts = false;
2914
    bool force_share = false;
2915

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

2993
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2994
        error_exit("Expecting one image file name");
2995
    }
2996 2997
    filename = argv[optind++];

2998 2999
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3000
                          NULL, NULL)) {
3001 3002 3003
        return 1;
    }

3004
    /* Open the image */
3005 3006
    blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
                   force_share);
3007 3008
    if (!blk) {
        return 1;
3009
    }
3010
    bs = blk_bs(blk);
3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026

    /* 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);
3027
        if (ret) {
3028
            error_report("Could not create snapshot '%s': %d (%s)",
3029
                snapshot_name, ret, strerror(-ret));
3030
        }
3031 3032 3033 3034
        break;

    case SNAPSHOT_APPLY:
        ret = bdrv_snapshot_goto(bs, snapshot_name);
3035
        if (ret) {
3036
            error_report("Could not apply snapshot '%s': %d (%s)",
3037
                snapshot_name, ret, strerror(-ret));
3038
        }
3039 3040 3041
        break;

    case SNAPSHOT_DELETE:
3042
        bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
3043
        if (err) {
3044 3045
            error_reportf_err(err, "Could not delete snapshot '%s': ",
                              snapshot_name);
3046
            ret = 1;
3047
        }
3048 3049 3050 3051
        break;
    }

    /* Cleanup */
M
Markus Armbruster 已提交
3052
    blk_unref(blk);
3053 3054 3055
    if (ret) {
        return 1;
    }
3056
    return 0;
3057 3058
}

K
Kevin Wolf 已提交
3059 3060
static int img_rebase(int argc, char **argv)
{
M
Markus Armbruster 已提交
3061
    BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
P
Paolo Bonzini 已提交
3062 3063
    uint8_t *buf_old = NULL;
    uint8_t *buf_new = NULL;
3064
    BlockDriverState *bs = NULL;
K
Kevin Wolf 已提交
3065
    char *filename;
3066 3067
    const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
    int c, flags, src_flags, ret;
3068
    bool writethrough, src_writethrough;
K
Kevin Wolf 已提交
3069
    int unsafe = 0;
3070
    bool force_share = false;
3071
    int progress = 0;
3072
    bool quiet = false;
3073
    Error *local_err = NULL;
3074
    bool image_opts = false;
K
Kevin Wolf 已提交
3075 3076

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

3146 3147 3148 3149
    if (quiet) {
        progress = 0;
    }

F
Fam Zheng 已提交
3150 3151 3152 3153 3154
    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)");
3155
    }
K
Kevin Wolf 已提交
3156 3157
    filename = argv[optind++];

3158 3159
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3160
                          NULL, NULL)) {
3161 3162 3163
        return 1;
    }

3164 3165 3166
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

3167
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
3168
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3169 3170
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
3171
        goto out;
3172 3173
    }

3174 3175
    src_flags = 0;
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
3176 3177
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
3178
        goto out;
3179 3180
    }

3181 3182 3183 3184
    /* 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 已提交
3185 3186 3187 3188 3189 3190
    /*
     * 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.
     */
3191 3192
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
                   false);
3193
    if (!blk) {
3194 3195
        ret = -1;
        goto out;
3196
    }
3197
    bs = blk_bs(blk);
K
Kevin Wolf 已提交
3198 3199

    if (out_basefmt != NULL) {
3200
        if (bdrv_find_format(out_basefmt) == NULL) {
3201
            error_report("Invalid format name: '%s'", out_basefmt);
3202 3203
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
3204 3205 3206 3207
        }
    }

    /* For safe rebasing we need to compare old and new backing file */
3208
    if (!unsafe) {
3209
        char backing_name[PATH_MAX];
3210 3211 3212 3213
        QDict *options = NULL;

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

3217 3218 3219 3220 3221 3222 3223
        if (force_share) {
            if (!options) {
                options = qdict_new();
            }
            qdict_put(options, BDRV_OPT_FORCE_SHARE,
                      qbool_from_bool(true));
        }
K
Kevin Wolf 已提交
3224
        bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3225
        blk_old_backing = blk_new_open(backing_name, NULL,
3226 3227
                                       options, src_flags, &local_err);
        if (!blk_old_backing) {
3228 3229 3230
            error_reportf_err(local_err,
                              "Could not open old backing file '%s': ",
                              backing_name);
3231
            ret = -1;
3232
            goto out;
K
Kevin Wolf 已提交
3233
        }
3234

3235
        if (out_baseimg[0]) {
3236
            options = qdict_new();
3237
            if (out_basefmt) {
3238
                qdict_put_str(options, "driver", out_basefmt);
3239 3240 3241
            }
            if (force_share) {
                qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3242 3243
            }

3244
            blk_new_backing = blk_new_open(out_baseimg, NULL,
3245 3246
                                           options, src_flags, &local_err);
            if (!blk_new_backing) {
3247 3248 3249
                error_reportf_err(local_err,
                                  "Could not open new backing file '%s': ",
                                  out_baseimg);
3250
                ret = -1;
3251 3252
                goto out;
            }
K
Kevin Wolf 已提交
3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265
        }
    }

    /*
     * 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) {
3266 3267 3268
        int64_t num_sectors;
        int64_t old_backing_num_sectors;
        int64_t new_backing_num_sectors = 0;
K
Kevin Wolf 已提交
3269
        uint64_t sector;
3270
        int n;
3271
        float local_progress = 0;
3272

3273 3274
        buf_old = blk_blockalign(blk, IO_BUF_SIZE);
        buf_new = blk_blockalign(blk, IO_BUF_SIZE);
K
Kevin Wolf 已提交
3275

3276
        num_sectors = blk_nb_sectors(blk);
3277 3278 3279 3280 3281 3282
        if (num_sectors < 0) {
            error_report("Could not get size of '%s': %s",
                         filename, strerror(-num_sectors));
            ret = -1;
            goto out;
        }
3283
        old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
3284
        if (old_backing_num_sectors < 0) {
3285
            char backing_name[PATH_MAX];
3286 3287 3288 3289 3290 3291 3292

            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;
        }
3293 3294
        if (blk_new_backing) {
            new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
3295 3296 3297 3298 3299 3300
            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;
            }
3301
        }
K
Kevin Wolf 已提交
3302

3303 3304 3305 3306 3307
        if (num_sectors != 0) {
            local_progress = (float)100 /
                (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
        }

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

3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338
            /*
             * 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;
                }

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

3347
            if (sector >= new_backing_num_sectors || !blk_new_backing) {
3348 3349 3350 3351 3352 3353
                memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
            } else {
                if (sector + n > new_backing_num_sectors) {
                    n = new_backing_num_sectors - sector;
                }

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

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

                written += pnum;
            }
3384
            qemu_progress_print(local_progress, 100);
K
Kevin Wolf 已提交
3385 3386 3387 3388 3389 3390 3391 3392
        }
    }

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

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

M
Markus Armbruster 已提交
3424
    blk_unref(blk);
3425 3426 3427
    if (ret) {
        return 1;
    }
K
Kevin Wolf 已提交
3428 3429 3430
    return 0;
}

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

3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451
    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 */
            }
3452 3453
        },
    };
3454
    bool image_opts = false;
3455

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

    size = argv[--argc];

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

3513 3514
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3515
                          NULL, NULL)) {
3516 3517 3518
        return 1;
    }

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

3546
    blk = img_open(image_opts, filename, fmt,
3547 3548
                   BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
                   false);
3549
    if (!blk) {
3550 3551
        ret = -1;
        goto out;
3552
    }
3553 3554

    if (relative) {
3555
        total_size = blk_getlength(blk) + n * relative;
3556 3557 3558 3559
    } else {
        total_size = n;
    }
    if (total_size <= 0) {
3560
        error_report("New image size must be positive");
3561 3562
        ret = -1;
        goto out;
3563 3564
    }

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

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

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

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

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

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

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

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

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

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

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

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

    fmt = bs->drv->format_name;

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

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

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

out:
3744 3745
    qemu_progress_end();

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

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

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

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

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

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

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

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

        /* 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 已提交
3826 3827 3828
    }

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

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

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

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

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

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

            bufsize = sval;
            break;
        }
3952 3953 3954 3955
        case 'S':
        {
            int64_t sval;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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;

4122
    res = cvtnum(arg);
R
Reda Sallahi 已提交
4123

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

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

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

    return 0;
}

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

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

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

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

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

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

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

4381 4382 4383 4384 4385
    /* TODO, we can't honour --image-opts for the target,
     * since it needs to be given in a format compatible
     * with the bdrv_create() call above which does not
     * support image-opts style.
     */
4386
    blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
4387
                         false, false, false);
R
Reda Sallahi 已提交
4388 4389 4390 4391 4392 4393

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

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

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


A
Anthony Liguori 已提交
4452
static const img_cmd_t img_cmds[] = {
4453 4454 4455 4456 4457 4458 4459 4460
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
    { NULL, NULL, },
};

B
bellard 已提交
4461 4462
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
4463
    const img_cmd_t *cmd;
4464
    const char *cmdname;
4465
    Error *local_error = NULL;
4466
    char *trace_file = NULL;
4467 4468 4469
    int c;
    static const struct option long_options[] = {
        {"help", no_argument, 0, 'h'},
4470
        {"version", no_argument, 0, 'V'},
4471
        {"trace", required_argument, NULL, 'T'},
4472 4473
        {0, 0, 0, 0}
    };
B
bellard 已提交
4474

4475 4476 4477 4478
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

4479
    module_call_init(MODULE_INIT_TRACE);
K
Kevin Wolf 已提交
4480
    error_set_progname(argv[0]);
4481
    qemu_init_exec_dir(argv[0]);
K
Kevin Wolf 已提交
4482

4483
    if (qemu_init_main_loop(&local_error)) {
4484
        error_report_err(local_error);
4485 4486 4487
        exit(EXIT_FAILURE);
    }

4488
    qcrypto_init(&error_fatal);
4489

4490
    module_call_init(MODULE_INIT_QOM);
B
bellard 已提交
4491
    bdrv_init();
F
Fam Zheng 已提交
4492 4493 4494
    if (argc < 2) {
        error_exit("Not enough arguments");
    }
4495

4496
    qemu_add_opts(&qemu_object_opts);
4497
    qemu_add_opts(&qemu_source_opts);
4498
    qemu_add_opts(&qemu_trace_opts);
4499

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

4521
    cmdname = argv[optind];
4522

4523 4524 4525
    /* reset getopt_long scanning */
    argc -= optind;
    if (argc < 1) {
4526 4527
        return 0;
    }
4528
    argv += optind;
D
Denis V. Lunev 已提交
4529
    optind = 0;
4530

4531 4532 4533 4534 4535 4536
    if (!trace_init_backends()) {
        exit(1);
    }
    trace_init_file(trace_file);
    qemu_set_log(LOG_TRACE);

4537 4538 4539 4540 4541 4542
    /* find the command */
    for (cmd = img_cmds; cmd->name != NULL; cmd++) {
        if (!strcmp(cmdname, cmd->name)) {
            return cmd->handler(argc, argv);
        }
    }
4543

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