qemu-img.c 111.4 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 28
#include "qapi-visit.h"
#include "qapi/qmp-output-visitor.h"
29
#include "qapi/qmp/qerror.h"
30
#include "qapi/qmp/qjson.h"
31
#include "qemu/cutils.h"
32
#include "qemu/config-file.h"
33 34
#include "qemu/option.h"
#include "qemu/error-report.h"
35
#include "qom/object_interfaces.h"
36
#include "sysemu/sysemu.h"
M
Markus Armbruster 已提交
37
#include "sysemu/block-backend.h"
38
#include "block/block_int.h"
M
Max Reitz 已提交
39
#include "block/blockjob.h"
40
#include "block/qapi.h"
41
#include "crypto/init.h"
42
#include <getopt.h>
43

44
#define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
45 46
                          ", Copyright (c) 2004-2008 Fabrice Bellard\n"

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

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

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

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

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

F
Fam Zheng 已提交
75 76 77 78 79 80 81 82 83 84 85 86 87 88
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);
}

B
blueswir1 已提交
89
/* Please keep in synch with qemu-img.texi */
F
Fam Zheng 已提交
90
static void QEMU_NORETURN help(void)
B
bellard 已提交
91
{
92
    const char *help_msg =
93
           QEMU_IMG_VERSION
94 95 96 97
           "usage: qemu-img command [command options]\n"
           "QEMU disk image utility\n"
           "\n"
           "Command syntax:\n"
98 99 100 101 102
#define DEF(option, callback, arg_string)        \
           "  " arg_string "\n"
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
103 104 105
           "\n"
           "Command parameters:\n"
           "  'filename' is a disk image filename\n"
106 107 108 109
           "  '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"
110
           "  'fmt' is the disk image format. It is guessed automatically in most cases\n"
111
           "  'cache' is the cache mode used to write the output disk image, the valid\n"
112 113
           "    options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
           "    'directsync' and 'unsafe' (default for convert)\n"
114 115
           "  '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"
116
           "  'size' is the disk image size in bytes. Optional suffixes\n"
117 118 119
           "    '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"
120 121 122 123 124
           "  '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"
125 126 127 128 129
           "  '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"
130 131 132 133 134
           "  '-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"
135
           "  '-p' show progress of command (only certain commands)\n"
136
           "  '-q' use Quiet mode - do not print any output (except errors)\n"
137 138 139 140 141
           "  '-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"
142
           "  '--output' takes the format in which the output must be done (human or json)\n"
143 144
           "  '-n' skips the target volume creation (useful if the volume is created\n"
           "       prior to running qemu-img)\n"
145
           "\n"
146 147 148 149
           "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"
150
           "       hiding corruption that has already occurred.\n"
151
           "\n"
152 153 154 155 156
           "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"
157 158 159 160 161 162
           "  '-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"
           "  '-s' run in Strict mode - fail on different image size or sector allocation\n";
163 164

    printf("%s\nSupported formats:", help_msg);
165
    bdrv_iterate_format(format_print, NULL);
B
bellard 已提交
166
    printf("\n");
F
Fam Zheng 已提交
167
    exit(EXIT_SUCCESS);
B
bellard 已提交
168 169
}

170 171 172 173 174 175 176 177 178
static QemuOptsList qemu_object_opts = {
    .name = "object",
    .implied_opt_name = "qom-type",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
    .desc = {
        { }
    },
};

179 180 181 182 183 184 185 186 187
static QemuOptsList qemu_source_opts = {
    .name = "source",
    .implied_opt_name = "file",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
    .desc = {
        { }
    },
};

S
Stefan Weil 已提交
188
static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
189 190 191 192 193 194 195 196 197 198 199
{
    int ret = 0;
    if (!quiet) {
        va_list args;
        va_start(args, fmt);
        ret = vprintf(fmt, args);
        va_end(args);
    }
    return ret;
}

B
bellard 已提交
200

201 202 203
static int print_block_option_help(const char *filename, const char *fmt)
{
    BlockDriver *drv, *proto_drv;
204
    QemuOptsList *create_opts = NULL;
205
    Error *local_err = NULL;
206 207 208 209

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

C
Chunyan Liu 已提交
214
    create_opts = qemu_opts_append(create_opts, drv->create_opts);
215
    if (filename) {
216
        proto_drv = bdrv_find_protocol(filename, true, &local_err);
217
        if (!proto_drv) {
218
            error_report_err(local_err);
219
            qemu_opts_free(create_opts);
220 221
            return 1;
        }
C
Chunyan Liu 已提交
222
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
223 224
    }

225 226
    qemu_opts_print_help(create_opts);
    qemu_opts_free(create_opts);
227 228 229
    return 0;
}

230 231

static int img_open_password(BlockBackend *blk, const char *filename,
232
                             int flags, bool quiet)
233 234 235
{
    BlockDriverState *bs;
    char password[256];
236 237

    bs = blk_bs(blk);
238 239
    if (bdrv_is_encrypted(bs) && bdrv_key_required(bs) &&
        !(flags & BDRV_O_NO_IO)) {
240 241 242 243 244 245 246 247 248 249 250 251 252 253
        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;
}


254
static BlockBackend *img_open_opts(const char *optstr,
255
                                   QemuOpts *opts, int flags, bool writethrough,
256
                                   bool quiet)
257 258 259 260 261
{
    QDict *options;
    Error *local_err = NULL;
    BlockBackend *blk;
    options = qemu_opts_to_qdict(opts, NULL);
262
    blk = blk_new_open(NULL, NULL, options, flags, &local_err);
263
    if (!blk) {
264
        error_reportf_err(local_err, "Could not open '%s': ", optstr);
265 266
        return NULL;
    }
267
    blk_set_enable_write_cache(blk, !writethrough);
268

269
    if (img_open_password(blk, optstr, flags, quiet) < 0) {
270 271 272 273 274 275
        blk_unref(blk);
        return NULL;
    }
    return blk;
}

276
static BlockBackend *img_open_file(const char *filename,
277
                                   const char *fmt, int flags,
278
                                   bool writethrough, bool quiet)
279 280
{
    BlockBackend *blk;
281
    Error *local_err = NULL;
282
    QDict *options = NULL;
283

284
    if (fmt) {
285 286
        options = qdict_new();
        qdict_put(options, "driver", qstring_from_str(fmt));
287
    }
288

289
    blk = blk_new_open(filename, NULL, options, flags, &local_err);
290
    if (!blk) {
291
        error_reportf_err(local_err, "Could not open '%s': ", filename);
292
        return NULL;
293
    }
294
    blk_set_enable_write_cache(blk, !writethrough);
295

296
    if (img_open_password(blk, filename, flags, quiet) < 0) {
297 298 299 300 301 302 303
        blk_unref(blk);
        return NULL;
    }
    return blk;
}


304
static BlockBackend *img_open(bool image_opts,
305
                              const char *filename,
306
                              const char *fmt, int flags, bool writethrough,
307
                              bool quiet)
308 309 310 311 312 313 314 315 316 317 318 319 320
{
    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;
        }
321
        blk = img_open_opts(filename, opts, flags, writethrough, quiet);
322
    } else {
323
        blk = img_open_file(filename, fmt, flags, writethrough, quiet);
324
    }
325
    return blk;
326 327
}

328

329
static int add_old_style_options(const char *fmt, QemuOpts *opts,
330 331
                                 const char *base_filename,
                                 const char *base_fmt)
332
{
333 334
    Error *err = NULL;

335
    if (base_filename) {
336
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
337
        if (err) {
338 339
            error_report("Backing file not supported for file format '%s'",
                         fmt);
340
            error_free(err);
341
            return -1;
342 343 344
        }
    }
    if (base_fmt) {
345
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
346
        if (err) {
347 348
            error_report("Backing file format not supported for file "
                         "format '%s'", fmt);
349
            error_free(err);
350
            return -1;
351 352
        }
    }
353
    return 0;
354 355
}

B
bellard 已提交
356 357
static int img_create(int argc, char **argv)
{
358
    int c;
359
    uint64_t img_size = -1;
B
bellard 已提交
360
    const char *fmt = "raw";
361
    const char *base_fmt = NULL;
B
bellard 已提交
362 363
    const char *filename;
    const char *base_filename = NULL;
364
    char *options = NULL;
365
    Error *local_err = NULL;
366
    bool quiet = false;
367

B
bellard 已提交
368
    for(;;) {
369 370 371 372 373 374 375
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "F:b:f:he6o:q",
                        long_options, NULL);
376
        if (c == -1) {
B
bellard 已提交
377
            break;
378
        }
B
bellard 已提交
379
        switch(c) {
J
Jes Sorensen 已提交
380
        case '?':
B
bellard 已提交
381 382 383
        case 'h':
            help();
            break;
384 385 386
        case 'F':
            base_fmt = optarg;
            break;
B
bellard 已提交
387 388 389 390 391 392 393
        case 'b':
            base_filename = optarg;
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'e':
394
            error_report("option -e is deprecated, please use \'-o "
395
                  "encryption\' instead!");
396
            goto fail;
397
        case '6':
398
            error_report("option -6 is deprecated, please use \'-o "
399
                  "compat6\' instead!");
400
            goto fail;
401
        case 'o':
402 403 404 405 406 407 408 409 410 411 412
            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);
            }
413
            break;
414 415 416
        case 'q':
            quiet = true;
            break;
417 418 419 420 421 422 423 424
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                goto fail;
            }
        }   break;
B
bellard 已提交
425 426
        }
    }
427

428
    /* Get the filename */
429 430 431 432 433 434
    filename = (optind < argc) ? argv[optind] : NULL;
    if (options && has_help_option(options)) {
        g_free(options);
        return print_block_option_help(filename, fmt);
    }

435
    if (optind >= argc) {
F
Fam Zheng 已提交
436
        error_exit("Expecting image file name");
437
    }
438
    optind++;
439

440 441
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
442
                          NULL, NULL)) {
443 444 445
        goto fail;
    }

446 447
    /* Get image size, if specified */
    if (optind < argc) {
448
        int64_t sval;
449
        char *end;
450 451
        sval = qemu_strtosz_suffix(argv[optind++], &end,
                                   QEMU_STRTOSZ_DEFSUFFIX_B);
452
        if (sval < 0 || *end) {
453 454 455 456
            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, "
457 458 459
                      "G, T, P or E suffixes for ");
                error_report("kilobytes, megabytes, gigabytes, terabytes, "
                             "petabytes and exabytes.");
460
            }
461
            goto fail;
462 463 464
        }
        img_size = (uint64_t)sval;
    }
465
    if (optind != argc) {
F
Fam Zheng 已提交
466
        error_exit("Unexpected argument: %s", argv[optind]);
467
    }
468

469
    bdrv_img_create(filename, fmt, base_filename, base_fmt,
K
Kevin Wolf 已提交
470
                    options, img_size, 0, &local_err, quiet);
471
    if (local_err) {
472
        error_reportf_err(local_err, "%s: ", filename);
473
        goto fail;
474
    }
475

476
    g_free(options);
B
bellard 已提交
477
    return 0;
478 479 480 481

fail:
    g_free(options);
    return 1;
B
bellard 已提交
482 483
}

484
static void dump_json_image_check(ImageCheck *check, bool quiet)
485
{
486
    Error *local_err = NULL;
487 488 489
    QString *str;
    QmpOutputVisitor *ov = qmp_output_visitor_new();
    QObject *obj;
490 491
    visit_type_ImageCheck(qmp_output_get_visitor(ov), NULL, &check,
                          &local_err);
492 493 494
    obj = qmp_output_get_qobject(ov);
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
495
    qprintf(quiet, "%s\n", qstring_get_str(str));
496 497 498 499 500
    qobject_decref(obj);
    qmp_output_visitor_cleanup(ov);
    QDECREF(str);
}

501
static void dump_human_image_check(ImageCheck *check, bool quiet)
502 503
{
    if (!(check->corruptions || check->leaks || check->check_errors)) {
504
        qprintf(quiet, "No errors were found on the image.\n");
505 506
    } else {
        if (check->corruptions) {
507 508 509 510
            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);
511 512 513
        }

        if (check->leaks) {
514 515 516 517
            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);
518 519 520
        }

        if (check->check_errors) {
521 522 523 524
            qprintf(quiet,
                    "\n%" PRId64
                    " internal errors have occurred during the check.\n",
                    check->check_errors);
525 526 527 528
        }
    }

    if (check->total_clusters != 0 && check->allocated_clusters != 0) {
529 530 531 532 533 534 535
        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);
536 537 538
    }

    if (check->image_end_offset) {
539 540
        qprintf(quiet,
                "Image end offset: %" PRId64 "\n", check->image_end_offset);
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
    }
}

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;
577 578
    check->compressed_clusters      = result.bfi.compressed_clusters;
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
579 580 581 582

    return 0;
}

583 584 585
/*
 * Checks an image for consistency. Exit codes:
 *
M
Max Reitz 已提交
586 587 588 589 590
 *  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
591
 */
592 593 594
static int img_check(int argc, char **argv)
{
    int c, ret;
595
    OutputFormat output_format = OFORMAT_HUMAN;
596
    const char *filename, *fmt, *output, *cache;
M
Markus Armbruster 已提交
597
    BlockBackend *blk;
598
    BlockDriverState *bs;
599
    int fix = 0;
600 601
    int flags = BDRV_O_CHECK;
    bool writethrough;
602
    ImageCheck *check;
603
    bool quiet = false;
604
    bool image_opts = false;
605 606

    fmt = NULL;
607
    output = NULL;
608
    cache = BDRV_DEFAULT_CACHE;
609

610
    for(;;) {
611 612 613 614
        int option_index = 0;
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"format", required_argument, 0, 'f'},
615
            {"repair", required_argument, 0, 'r'},
616
            {"output", required_argument, 0, OPTION_OUTPUT},
617
            {"object", required_argument, 0, OPTION_OBJECT},
618
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
619 620
            {0, 0, 0, 0}
        };
621
        c = getopt_long(argc, argv, "hf:r:T:q",
622
                        long_options, &option_index);
623
        if (c == -1) {
624
            break;
625
        }
626
        switch(c) {
J
Jes Sorensen 已提交
627
        case '?':
628 629 630 631 632 633
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
634 635 636 637 638 639 640 641
        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 已提交
642 643
                error_exit("Unknown option value for -r "
                           "(expecting 'leaks' or 'all'): %s", optarg);
644 645
            }
            break;
646 647 648
        case OPTION_OUTPUT:
            output = optarg;
            break;
649 650 651
        case 'T':
            cache = optarg;
            break;
652 653 654
        case 'q':
            quiet = true;
            break;
655 656 657 658 659 660 661 662
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
663 664 665
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
666 667
        }
    }
668
    if (optind != argc - 1) {
F
Fam Zheng 已提交
669
        error_exit("Expecting one image file name");
670
    }
671 672
    filename = argv[optind++];

673 674 675 676 677 678 679 680 681
    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;
    }

682 683
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
684
                          NULL, NULL)) {
685 686 687
        return 1;
    }

688
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
689 690 691 692 693
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        return 1;
    }

694
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
695 696
    if (!blk) {
        return 1;
697
    }
698
    bs = blk_bs(blk);
699 700 701

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
702 703

    if (ret == -ENOTSUP) {
704
        error_report("This image format does not support checks");
705
        ret = 63;
706
        goto fail;
707 708
    }

709 710
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
711

712 713
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
714

715
        if (output_format == OFORMAT_HUMAN) {
716 717 718 719 720 721 722
            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);
723 724
        }

725
        ret = collect_image_check(bs, check, filename, fmt, 0);
726

727 728
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
729 730
    }

M
Max Reitz 已提交
731 732 733 734 735 736 737 738 739
    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;
        }
740 741
    }

742
    if (ret || check->check_errors) {
M
Max Reitz 已提交
743 744 745 746 747
        if (ret) {
            error_report("Check failed: %s", strerror(-ret));
        } else {
            error_report("Check failed");
        }
748 749
        ret = 1;
        goto fail;
750
    }
751

752 753 754 755
    if (check->corruptions) {
        ret = 2;
    } else if (check->leaks) {
        ret = 3;
756
    } else {
757
        ret = 0;
758
    }
759 760 761

fail:
    qapi_free_ImageCheck(check);
M
Markus Armbruster 已提交
762
    blk_unref(blk);
763
    return ret;
764 765
}

M
Max Reitz 已提交
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
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 已提交
782
    AioContext *aio_context = blk_get_aio_context(job->blk);
M
Max Reitz 已提交
783 784 785

    do {
        aio_poll(aio_context, true);
786 787
        qemu_progress_print(job->len ?
                            ((float)job->offset / job->len * 100.f) : 0.0f, 0);
M
Max Reitz 已提交
788 789 790
    } while (!job->ready);

    block_job_complete_sync(job, errp);
791 792 793 794

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

B
bellard 已提交
797 798
static int img_commit(int argc, char **argv)
{
799
    int c, ret, flags;
800
    const char *filename, *fmt, *cache, *base;
M
Markus Armbruster 已提交
801
    BlockBackend *blk;
M
Max Reitz 已提交
802
    BlockDriverState *bs, *base_bs;
803
    bool progress = false, quiet = false, drop = false;
804
    bool writethrough;
M
Max Reitz 已提交
805 806
    Error *local_err = NULL;
    CommonBlockJobCBInfo cbi;
807
    bool image_opts = false;
B
bellard 已提交
808 809

    fmt = NULL;
810
    cache = BDRV_DEFAULT_CACHE;
811
    base = NULL;
B
bellard 已提交
812
    for(;;) {
813 814 815
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
816
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
817 818 819 820
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "f:ht:b:dpq",
                        long_options, NULL);
821
        if (c == -1) {
B
bellard 已提交
822
            break;
823
        }
B
bellard 已提交
824
        switch(c) {
J
Jes Sorensen 已提交
825
        case '?':
B
bellard 已提交
826 827 828 829 830 831
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
832 833 834
        case 't':
            cache = optarg;
            break;
835 836 837 838 839
        case 'b':
            base = optarg;
            /* -b implies -d */
            drop = true;
            break;
M
Max Reitz 已提交
840 841 842
        case 'd':
            drop = true;
            break;
843 844 845
        case 'p':
            progress = true;
            break;
846 847 848
        case 'q':
            quiet = true;
            break;
849 850 851 852 853 854 855 856
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
857 858 859
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
B
bellard 已提交
860 861
        }
    }
862 863 864 865 866 867

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

868
    if (optind != argc - 1) {
F
Fam Zheng 已提交
869
        error_exit("Expecting one image file name");
870
    }
B
bellard 已提交
871 872
    filename = argv[optind++];

873 874
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
875
                          NULL, NULL)) {
876 877 878
        return 1;
    }

M
Max Reitz 已提交
879
    flags = BDRV_O_RDWR | BDRV_O_UNMAP;
880
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
881 882
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
883
        return 1;
884 885
    }

886
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
887 888
    if (!blk) {
        return 1;
889
    }
890 891
    bs = blk_bs(blk);

892 893 894
    qemu_progress_init(progress, 1.f);
    qemu_progress_print(0.f, 100);

895 896 897
    if (base) {
        base_bs = bdrv_find_backing_image(bs, base);
        if (!base_bs) {
898
            error_setg(&local_err, QERR_BASE_NOT_FOUND, base);
899 900 901 902 903 904
            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. */
905
        base_bs = backing_bs(bs);
906 907 908 909
        if (!base_bs) {
            error_setg(&local_err, "Image does not have a backing file");
            goto done;
        }
M
Max Reitz 已提交
910 911 912 913 914 915 916 917 918 919 920
    }

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

    commit_active_start(bs, base_bs, 0, BLOCKDEV_ON_ERROR_REPORT,
                        common_block_job_cb, &cbi, &local_err);
    if (local_err) {
        goto done;
B
bellard 已提交
921 922
    }

923 924 925 926
    /* 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 已提交
927
    if (!drop) {
928
        bdrv_ref(bs);
M
Max Reitz 已提交
929 930
    }

M
Max Reitz 已提交
931
    run_block_job(bs->job, &local_err);
M
Max Reitz 已提交
932 933 934 935
    if (local_err) {
        goto unref_backing;
    }

936 937
    if (!drop && bs->drv->bdrv_make_empty) {
        ret = bs->drv->bdrv_make_empty(bs);
M
Max Reitz 已提交
938 939 940 941 942 943 944 945 946
        if (ret) {
            error_setg_errno(&local_err, -ret, "Could not empty %s",
                             filename);
            goto unref_backing;
        }
    }

unref_backing:
    if (!drop) {
947
        bdrv_unref(bs);
M
Max Reitz 已提交
948
    }
M
Max Reitz 已提交
949 950

done:
951 952
    qemu_progress_end();

M
Markus Armbruster 已提交
953
    blk_unref(blk);
M
Max Reitz 已提交
954 955

    if (local_err) {
956
        error_report_err(local_err);
957 958
        return 1;
    }
M
Max Reitz 已提交
959 960

    qprintf(quiet, "Image committed.\n");
B
bellard 已提交
961 962 963
    return 0;
}

964 965 966 967 968 969 970
/*
 * 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 已提交
971 972
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
{
973 974
    bool is_zero;
    int i;
B
bellard 已提交
975 976 977 978 979

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
980
    is_zero = buffer_is_zero(buf, 512);
B
bellard 已提交
981 982
    for(i = 1; i < n; i++) {
        buf += 512;
983
        if (is_zero != buffer_is_zero(buf, 512)) {
B
bellard 已提交
984
            break;
985
        }
B
bellard 已提交
986 987
    }
    *pnum = i;
988
    return !is_zero;
B
bellard 已提交
989 990
}

991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
/*
 * 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 已提交
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
/*
 * 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)
{
1043 1044
    bool res;
    int i;
K
Kevin Wolf 已提交
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064

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

1065
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
1066

1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
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.
 *
1083
 * @param blk:  BlockBackend for the image
1084 1085 1086 1087 1088 1089
 * @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
 */
1090
static int check_empty_sectors(BlockBackend *blk, int64_t sect_num,
1091 1092 1093 1094
                               int sect_count, const char *filename,
                               uint8_t *buffer, bool quiet)
{
    int pnum, ret = 0;
1095 1096
    ret = blk_pread(blk, sect_num << BDRV_SECTOR_BITS, buffer,
                    sect_count << BDRV_SECTOR_BITS);
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
    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)
{
1121
    const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
M
Markus Armbruster 已提交
1122
    BlockBackend *blk1, *blk2;
1123 1124 1125 1126 1127 1128 1129
    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;
1130
    int flags;
1131
    bool writethrough;
1132 1133 1134 1135 1136
    int64_t total_sectors;
    int64_t sector_num = 0;
    int64_t nb_sectors;
    int c, pnum;
    uint64_t progress_base;
1137
    bool image_opts = false;
1138

1139
    cache = BDRV_DEFAULT_CACHE;
1140
    for (;;) {
1141 1142 1143
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
1144
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1145 1146 1147 1148
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "hf:F:T:pqs",
                        long_options, NULL);
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
        if (c == -1) {
            break;
        }
        switch (c) {
        case '?':
        case 'h':
            help();
            break;
        case 'f':
            fmt1 = optarg;
            break;
        case 'F':
            fmt2 = optarg;
            break;
1163 1164 1165
        case 'T':
            cache = optarg;
            break;
1166 1167 1168 1169 1170 1171 1172 1173 1174
        case 'p':
            progress = true;
            break;
        case 'q':
            quiet = true;
            break;
        case 's':
            strict = true;
            break;
1175 1176 1177 1178 1179 1180 1181 1182 1183
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                ret = 2;
                goto out4;
            }
        }   break;
1184 1185 1186
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
1187 1188 1189 1190 1191 1192 1193 1194 1195
        }
    }

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


1196
    if (optind != argc - 2) {
F
Fam Zheng 已提交
1197
        error_exit("Expecting two image file names");
1198 1199 1200 1201
    }
    filename1 = argv[optind++];
    filename2 = argv[optind++];

1202 1203
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
1204
                          NULL, NULL)) {
1205 1206 1207 1208
        ret = 2;
        goto out4;
    }

1209 1210 1211
    /* Initialize before goto out */
    qemu_progress_init(progress, 2.0);

1212 1213
    flags = 0;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1214 1215 1216 1217 1218 1219
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        ret = 2;
        goto out3;
    }

1220
    blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet);
1221
    if (!blk1) {
1222
        ret = 2;
1223
        goto out3;
1224 1225
    }

1226
    blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet);
1227
    if (!blk2) {
1228
        ret = 2;
1229
        goto out2;
1230
    }
1231
    bs1 = blk_bs(blk1);
1232
    bs2 = blk_bs(blk2);
1233

1234 1235 1236
    buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
    buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
    total_sectors1 = blk_nb_sectors(blk1);
1237 1238 1239 1240 1241 1242
    if (total_sectors1 < 0) {
        error_report("Can't get size of %s: %s",
                     filename1, strerror(-total_sectors1));
        ret = 4;
        goto out;
    }
1243
    total_sectors2 = blk_nb_sectors(blk2);
1244 1245 1246 1247 1248 1249
    if (total_sectors2 < 0) {
        error_report("Can't get size of %s: %s",
                     filename2, strerror(-total_sectors2));
        ret = 4;
        goto out;
    }
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
    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 (;;) {
1262
        int64_t status1, status2;
1263 1264
        BlockDriverState *file;

1265 1266 1267 1268
        nb_sectors = sectors_to_process(total_sectors, sector_num);
        if (nb_sectors <= 0) {
            break;
        }
1269 1270
        status1 = bdrv_get_block_status_above(bs1, NULL, sector_num,
                                              total_sectors1 - sector_num,
1271
                                              &pnum1, &file);
1272
        if (status1 < 0) {
1273 1274 1275 1276
            ret = 3;
            error_report("Sector allocation test failed for %s", filename1);
            goto out;
        }
1277
        allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1278

1279 1280
        status2 = bdrv_get_block_status_above(bs2, NULL, sector_num,
                                              total_sectors2 - sector_num,
1281
                                              &pnum2, &file);
1282
        if (status2 < 0) {
1283 1284 1285 1286
            ret = 3;
            error_report("Sector allocation test failed for %s", filename2);
            goto out;
        }
1287 1288 1289 1290 1291 1292 1293
        allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
        if (pnum1) {
            nb_sectors = MIN(nb_sectors, pnum1);
        }
        if (pnum2) {
            nb_sectors = MIN(nb_sectors, pnum2);
        }
1294

1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307
        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) {
1308
            if (allocated1) {
1309 1310
                ret = blk_pread(blk1, sector_num << BDRV_SECTOR_BITS, buf1,
                                nb_sectors << BDRV_SECTOR_BITS);
1311 1312 1313 1314 1315 1316 1317
                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;
                }
1318 1319
                ret = blk_pread(blk2, sector_num << BDRV_SECTOR_BITS, buf2,
                                nb_sectors << BDRV_SECTOR_BITS);
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
                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));
1332
                    ret = 1;
1333 1334 1335 1336 1337 1338
                    goto out;
                }
            }
        } else {

            if (allocated1) {
1339
                ret = check_empty_sectors(blk1, sector_num, nb_sectors,
1340 1341
                                          filename1, buf1, quiet);
            } else {
1342
                ret = check_empty_sectors(blk2, sector_num, nb_sectors,
1343 1344 1345 1346 1347 1348
                                          filename2, buf1, quiet);
            }
            if (ret) {
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64 ": %s",
                                 sectors_to_bytes(sector_num), strerror(-ret));
1349
                    ret = 4;
1350 1351 1352 1353 1354 1355 1356 1357 1358
                }
                goto out;
            }
        }
        sector_num += nb_sectors;
        qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
    }

    if (total_sectors1 != total_sectors2) {
1359
        BlockBackend *blk_over;
1360 1361 1362 1363 1364 1365
        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;
1366
            blk_over = blk1;
1367 1368 1369
            filename_over = filename1;
        } else {
            total_sectors_over = total_sectors2;
1370
            blk_over = blk2;
1371 1372 1373 1374 1375 1376 1377 1378
            filename_over = filename2;
        }

        for (;;) {
            nb_sectors = sectors_to_process(total_sectors_over, sector_num);
            if (nb_sectors <= 0) {
                break;
            }
1379
            ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
1380 1381 1382 1383 1384 1385 1386 1387 1388 1389
                                          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) {
1390
                ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
1391 1392 1393 1394 1395 1396
                                          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));
1397
                        ret = 4;
1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412
                    }
                    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 已提交
1413
    blk_unref(blk2);
1414
out2:
M
Markus Armbruster 已提交
1415
    blk_unref(blk1);
1416 1417
out3:
    qemu_progress_end();
1418
out4:
1419 1420 1421
    return ret;
}

1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466
enum ImgConvertBlockStatus {
    BLK_DATA,
    BLK_ZERO,
    BLK_BACKING_FILE,
};

typedef struct ImgConvertState {
    BlockBackend **src;
    int64_t *src_sectors;
    int src_cur, src_num;
    int64_t src_cur_offset;
    int64_t total_sectors;
    int64_t allocated_sectors;
    enum ImgConvertBlockStatus status;
    int64_t sector_next_status;
    BlockBackend *target;
    bool has_zero_init;
    bool compressed;
    bool target_has_backing;
    int min_sparse;
    size_t cluster_sectors;
    size_t buf_sectors;
} ImgConvertState;

static void convert_select_part(ImgConvertState *s, int64_t sector_num)
{
    assert(sector_num >= s->src_cur_offset);
    while (sector_num - s->src_cur_offset >= s->src_sectors[s->src_cur]) {
        s->src_cur_offset += s->src_sectors[s->src_cur];
        s->src_cur++;
        assert(s->src_cur < s->src_num);
    }
}

static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
{
    int64_t ret;
    int n;

    convert_select_part(s, sector_num);

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

    if (s->sector_next_status <= sector_num) {
1467
        BlockDriverState *file;
1468 1469
        ret = bdrv_get_block_status(blk_bs(s->src[s->src_cur]),
                                    sector_num - s->src_cur_offset,
1470
                                    n, &n, &file);
1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
        if (ret < 0) {
            return ret;
        }

        if (ret & BDRV_BLOCK_ZERO) {
            s->status = BLK_ZERO;
        } else if (ret & BDRV_BLOCK_DATA) {
            s->status = BLK_DATA;
        } else if (!s->target_has_backing) {
            /* Without a target backing file we must copy over the contents of
             * the backing file as well. */
1482
            /* Check block status of the backing file chain to avoid
1483 1484
             * needlessly reading zeroes and limiting the iteration to the
             * buffer size */
1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496
            ret = bdrv_get_block_status_above(blk_bs(s->src[s->src_cur]), NULL,
                                              sector_num - s->src_cur_offset,
                                              n, &n, &file);
            if (ret < 0) {
                return ret;
            }

            if (ret & BDRV_BLOCK_ZERO) {
                s->status = BLK_ZERO;
            } else {
                s->status = BLK_DATA;
            }
1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542
        } else {
            s->status = BLK_BACKING_FILE;
        }

        s->sector_next_status = sector_num + n;
    }

    n = MIN(n, s->sector_next_status - sector_num);
    if (s->status == BLK_DATA) {
        n = MIN(n, s->buf_sectors);
    }

    /* We need to write complete clusters for compressed images, so if an
     * unallocated area is shorter than that, we must consider the whole
     * cluster allocated. */
    if (s->compressed) {
        if (n < s->cluster_sectors) {
            n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
            s->status = BLK_DATA;
        } else {
            n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
        }
    }

    return n;
}

static int convert_read(ImgConvertState *s, int64_t sector_num, int nb_sectors,
                        uint8_t *buf)
{
    int n;
    int ret;

    assert(nb_sectors <= s->buf_sectors);
    while (nb_sectors > 0) {
        BlockBackend *blk;
        int64_t bs_sectors;

        /* 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. */
        convert_select_part(s, sector_num);
        blk = s->src[s->src_cur];
        bs_sectors = s->src_sectors[s->src_cur];

        n = MIN(nb_sectors, bs_sectors - (sector_num - s->src_cur_offset));
1543 1544 1545
        ret = blk_pread(blk,
                        (sector_num - s->src_cur_offset) << BDRV_SECTOR_BITS,
                        buf, n << BDRV_SECTOR_BITS);
1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599
        if (ret < 0) {
            return ret;
        }

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

    return 0;
}

static int convert_write(ImgConvertState *s, int64_t sector_num, int nb_sectors,
                         const uint8_t *buf)
{
    int ret;

    while (nb_sectors > 0) {
        int n = nb_sectors;

        switch (s->status) {
        case BLK_BACKING_FILE:
            /* If we have a backing file, leave clusters unallocated that are
             * unallocated in the source image, so that the backing file is
             * visible at the respective offset. */
            assert(s->target_has_backing);
            break;

        case BLK_DATA:
            /* We must always write compressed clusters as a whole, so don't
             * try to find zeroed parts in the buffer. We can only save the
             * write if the buffer is completely zeroed and we're allowed to
             * keep the target sparse. */
            if (s->compressed) {
                if (s->has_zero_init && s->min_sparse &&
                    buffer_is_zero(buf, n * BDRV_SECTOR_SIZE))
                {
                    assert(!s->target_has_backing);
                    break;
                }

                ret = blk_write_compressed(s->target, sector_num, buf, n);
                if (ret < 0) {
                    return ret;
                }
                break;
            }

            /* If there is real non-zero data or we're told to keep the target
             * fully allocated (-S 0), we must write it. Otherwise we can treat
             * it as zero sectors. */
            if (!s->min_sparse ||
                is_allocated_sectors_min(buf, n, &n, s->min_sparse))
            {
1600 1601
                ret = blk_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
                                 buf, n << BDRV_SECTOR_BITS, 0);
1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612
                if (ret < 0) {
                    return ret;
                }
                break;
            }
            /* fall-through */

        case BLK_ZERO:
            if (s->has_zero_init) {
                break;
            }
E
Eric Blake 已提交
1613 1614
            ret = blk_pwrite_zeroes(s->target, sector_num << BDRV_SECTOR_BITS,
                                    n << BDRV_SECTOR_BITS, 0);
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670
            if (ret < 0) {
                return ret;
            }
            break;
        }

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

    return 0;
}

static int convert_do_copy(ImgConvertState *s)
{
    uint8_t *buf = NULL;
    int64_t sector_num, allocated_done;
    int ret;
    int n;

    /* 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)))
    {
        ret = bdrv_make_zero(blk_bs(s->target), BDRV_REQ_MAY_UNMAP);
        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");
            ret = -EINVAL;
            goto fail;
        }
        s->buf_sectors = s->cluster_sectors;
    }
    buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);

    /* Calculate allocated sectors for progress */
    s->allocated_sectors = 0;
    sector_num = 0;
    while (sector_num < s->total_sectors) {
        n = convert_iteration_sectors(s, sector_num);
        if (n < 0) {
            ret = n;
            goto fail;
        }
1671 1672
        if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
        {
1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
            s->allocated_sectors += n;
        }
        sector_num += n;
    }

    /* Do the copy */
    s->src_cur = 0;
    s->src_cur_offset = 0;
    s->sector_next_status = 0;

    sector_num = 0;
    allocated_done = 0;

    while (sector_num < s->total_sectors) {
        n = convert_iteration_sectors(s, sector_num);
        if (n < 0) {
            ret = n;
            goto fail;
        }
1692 1693
        if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
        {
1694 1695 1696 1697 1698
            allocated_done += n;
            qemu_progress_print(100.0 * allocated_done / s->allocated_sectors,
                                0);
        }

1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709
        if (s->status == BLK_DATA) {
            ret = convert_read(s, sector_num, n, buf);
            if (ret < 0) {
                error_report("error while reading sector %" PRId64
                             ": %s", sector_num, strerror(-ret));
                goto fail;
            }
        } else if (!s->min_sparse && s->status == BLK_ZERO) {
            n = MIN(n, s->buf_sectors);
            memset(buf, 0, n * BDRV_SECTOR_SIZE);
            s->status = BLK_DATA;
1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735
        }

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

        sector_num += n;
    }

    if (s->compressed) {
        /* signal EOF to align */
        ret = blk_write_compressed(s->target, 0, NULL, 0);
        if (ret < 0) {
            goto fail;
        }
    }

    ret = 0;
fail:
    qemu_vfree(buf);
    return ret;
}

B
bellard 已提交
1736 1737
static int img_convert(int argc, char **argv)
{
1738
    int c, bs_n, bs_i, compress, cluster_sectors, skip_create;
1739
    int64_t ret = 0;
1740
    int progress = 0, flags, src_flags;
1741
    bool writethrough, src_writethrough;
1742
    const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
1743
    BlockDriver *drv, *proto_drv;
M
Markus Armbruster 已提交
1744
    BlockBackend **blk = NULL, *out_blk = NULL;
1745
    BlockDriverState **bs = NULL, *out_bs = NULL;
1746
    int64_t total_sectors;
1747
    int64_t *bs_sectors = NULL;
1748
    size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
B
bellard 已提交
1749
    BlockDriverInfo bdi;
1750 1751 1752
    QemuOpts *opts = NULL;
    QemuOptsList *create_opts = NULL;
    const char *out_baseimg_param;
1753
    char *options = NULL;
E
edison 已提交
1754
    const char *snapshot_name = NULL;
1755
    int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1756
    bool quiet = false;
1757
    Error *local_err = NULL;
1758
    QemuOpts *sn_opts = NULL;
1759
    ImgConvertState state;
1760
    bool image_opts = false;
B
bellard 已提交
1761 1762 1763

    fmt = NULL;
    out_fmt = "raw";
1764
    cache = "unsafe";
1765
    src_cache = BDRV_DEFAULT_CACHE;
1766
    out_baseimg = NULL;
1767
    compress = 0;
1768
    skip_create = 0;
B
bellard 已提交
1769
    for(;;) {
1770 1771 1772
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
1773
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1774 1775 1776 1777
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qn",
                        long_options, NULL);
1778
        if (c == -1) {
B
bellard 已提交
1779
            break;
1780
        }
B
bellard 已提交
1781
        switch(c) {
J
Jes Sorensen 已提交
1782
        case '?':
B
bellard 已提交
1783 1784 1785 1786 1787 1788 1789 1790 1791
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'O':
            out_fmt = optarg;
            break;
1792 1793 1794
        case 'B':
            out_baseimg = optarg;
            break;
B
bellard 已提交
1795
        case 'c':
1796
            compress = 1;
B
bellard 已提交
1797 1798
            break;
        case 'e':
1799
            error_report("option -e is deprecated, please use \'-o "
1800
                  "encryption\' instead!");
1801
            ret = -1;
1802
            goto fail_getopt;
1803
        case '6':
1804
            error_report("option -6 is deprecated, please use \'-o "
1805
                  "compat6\' instead!");
1806
            ret = -1;
1807
            goto fail_getopt;
1808
        case 'o':
1809 1810 1811
            if (!is_valid_option_list(optarg)) {
                error_report("Invalid option list: %s", optarg);
                ret = -1;
1812
                goto fail_getopt;
1813 1814 1815 1816 1817 1818 1819 1820
            }
            if (!options) {
                options = g_strdup(optarg);
            } else {
                char *old_options = options;
                options = g_strdup_printf("%s,%s", options, optarg);
                g_free(old_options);
            }
1821
            break;
E
edison 已提交
1822 1823 1824
        case 's':
            snapshot_name = optarg;
            break;
1825 1826
        case 'l':
            if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
1827 1828
                sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
                                                  optarg, false);
1829 1830 1831
                if (!sn_opts) {
                    error_report("Failed in parsing snapshot param '%s'",
                                 optarg);
1832
                    ret = -1;
1833
                    goto fail_getopt;
1834 1835 1836 1837 1838
                }
            } else {
                snapshot_name = optarg;
            }
            break;
1839 1840 1841
        case 'S':
        {
            int64_t sval;
1842
            char *end;
1843
            sval = qemu_strtosz_suffix(optarg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
1844
            if (sval < 0 || *end) {
1845
                error_report("Invalid minimum zero buffer size for sparse output specified");
1846
                ret = -1;
1847
                goto fail_getopt;
1848 1849 1850 1851 1852
            }

            min_sparse = sval / BDRV_SECTOR_SIZE;
            break;
        }
1853 1854 1855
        case 'p':
            progress = 1;
            break;
1856 1857 1858
        case 't':
            cache = optarg;
            break;
1859 1860 1861
        case 'T':
            src_cache = optarg;
            break;
1862 1863 1864
        case 'q':
            quiet = true;
            break;
1865 1866 1867
        case 'n':
            skip_create = 1;
            break;
1868 1869 1870 1871 1872 1873 1874
        case OPTION_OBJECT:
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                goto fail_getopt;
            }
            break;
1875 1876 1877
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
B
bellard 已提交
1878 1879
        }
    }
1880

1881 1882
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
1883
                          NULL, NULL)) {
1884 1885 1886
        goto fail_getopt;
    }

1887
    /* Initialize before goto out */
1888 1889 1890
    if (quiet) {
        progress = 0;
    }
1891 1892
    qemu_progress_init(progress, 1.0);

1893
    bs_n = argc - optind - 1;
1894
    out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
1895

1896
    if (options && has_help_option(options)) {
1897 1898 1899 1900
        ret = print_block_option_help(out_filename, out_fmt);
        goto out;
    }

1901
    if (bs_n < 1) {
F
Fam Zheng 已提交
1902
        error_exit("Must specify image file name");
1903 1904 1905
    }


1906
    if (bs_n > 1 && out_baseimg) {
1907 1908
        error_report("-B makes no sense when concatenating multiple input "
                     "images");
1909 1910
        ret = -1;
        goto out;
1911
    }
1912

1913 1914
    src_flags = 0;
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
1915 1916 1917 1918 1919
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
        goto out;
    }

1920 1921
    qemu_progress_print(0, 100);

M
Markus Armbruster 已提交
1922
    blk = g_new0(BlockBackend *, bs_n);
1923
    bs = g_new0(BlockDriverState *, bs_n);
1924
    bs_sectors = g_new(int64_t, bs_n);
1925 1926 1927

    total_sectors = 0;
    for (bs_i = 0; bs_i < bs_n; bs_i++) {
1928
        blk[bs_i] = img_open(image_opts, argv[optind + bs_i],
1929
                             fmt, src_flags, src_writethrough, quiet);
1930
        if (!blk[bs_i]) {
1931 1932 1933
            ret = -1;
            goto out;
        }
1934
        bs[bs_i] = blk_bs(blk[bs_i]);
1935
        bs_sectors[bs_i] = blk_nb_sectors(blk[bs_i]);
1936 1937 1938 1939 1940 1941
        if (bs_sectors[bs_i] < 0) {
            error_report("Could not get size of %s: %s",
                         argv[optind + bs_i], strerror(-bs_sectors[bs_i]));
            ret = -1;
            goto out;
        }
1942
        total_sectors += bs_sectors[bs_i];
1943
    }
B
bellard 已提交
1944

1945 1946 1947 1948 1949 1950
    if (sn_opts) {
        ret = bdrv_snapshot_load_tmp(bs[0],
                                     qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
                                     qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
                                     &local_err);
    } else if (snapshot_name != NULL) {
E
edison 已提交
1951
        if (bs_n > 1) {
1952
            error_report("No support for concatenating multiple snapshot");
E
edison 已提交
1953 1954 1955
            ret = -1;
            goto out;
        }
1956 1957

        bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1958
    }
1959
    if (local_err) {
1960
        error_reportf_err(local_err, "Failed to load snapshot: ");
1961 1962
        ret = -1;
        goto out;
E
edison 已提交
1963 1964
    }

1965
    /* Find driver and parse its options */
B
bellard 已提交
1966
    drv = bdrv_find_format(out_fmt);
1967
    if (!drv) {
1968
        error_report("Unknown file format '%s'", out_fmt);
1969 1970 1971
        ret = -1;
        goto out;
    }
1972

1973
    proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
1974
    if (!proto_drv) {
1975
        error_report_err(local_err);
1976 1977 1978
        ret = -1;
        goto out;
    }
1979

M
Max Reitz 已提交
1980 1981 1982 1983 1984 1985 1986
    if (!skip_create) {
        if (!drv->create_opts) {
            error_report("Format driver '%s' does not support image creation",
                         drv->format_name);
            ret = -1;
            goto out;
        }
1987

M
Max Reitz 已提交
1988 1989 1990 1991 1992 1993
        if (!proto_drv->create_opts) {
            error_report("Protocol driver '%s' does not support image creation",
                         proto_drv->format_name);
            ret = -1;
            goto out;
        }
1994

M
Max Reitz 已提交
1995 1996
        create_opts = qemu_opts_append(create_opts, drv->create_opts);
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
1997

M
Max Reitz 已提交
1998
        opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
1999 2000 2001
        if (options) {
            qemu_opts_do_parse(opts, options, NULL, &local_err);
            if (local_err) {
2002
                error_report_err(local_err);
2003 2004 2005
                ret = -1;
                goto out;
            }
M
Max Reitz 已提交
2006
        }
2007

2008 2009
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512,
                            &error_abort);
M
Max Reitz 已提交
2010 2011 2012 2013
        ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
        if (ret < 0) {
            goto out;
        }
2014
    }
2015

2016
    /* Get backing file name if -o backing_file was used */
2017
    out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2018
    if (out_baseimg_param) {
2019
        out_baseimg = out_baseimg_param;
2020 2021
    }

2022
    /* Check if compression is supported */
2023
    if (compress) {
2024 2025 2026 2027
        bool encryption =
            qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
        const char *preallocation =
            qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2028 2029

        if (!drv->bdrv_write_compressed) {
2030
            error_report("Compression not supported for this file format");
2031 2032
            ret = -1;
            goto out;
2033 2034
        }

2035
        if (encryption) {
2036 2037
            error_report("Compression and encryption not supported at "
                         "the same time");
2038 2039
            ret = -1;
            goto out;
2040
        }
2041

2042 2043
        if (preallocation
            && strcmp(preallocation, "off"))
2044 2045 2046 2047 2048 2049
        {
            error_report("Compression and preallocation not supported at "
                         "the same time");
            ret = -1;
            goto out;
        }
2050 2051
    }

2052 2053
    if (!skip_create) {
        /* Create the new image */
C
Chunyan Liu 已提交
2054
        ret = bdrv_create(drv, out_filename, opts, &local_err);
2055
        if (ret < 0) {
2056 2057
            error_reportf_err(local_err, "%s: error while converting %s: ",
                              out_filename, out_fmt);
2058
            goto out;
B
bellard 已提交
2059 2060
        }
    }
2061

2062
    flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2063
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2064 2065
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2066
        goto out;
2067 2068
    }

2069 2070 2071 2072 2073
    /* XXX we should allow --image-opts to trigger use of
     * img_open() here, but then we have trouble with
     * the bdrv_create() call which takes different params.
     * Not critical right now, so fix can wait...
     */
2074
    out_blk = img_open_file(out_filename, out_fmt, flags, writethrough, quiet);
2075
    if (!out_blk) {
2076 2077 2078
        ret = -1;
        goto out;
    }
2079
    out_bs = blk_bs(out_blk);
B
bellard 已提交
2080

2081 2082 2083 2084 2085 2086 2087 2088
    /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
     * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
     * as maximum. */
    bufsectors = MIN(32768,
                     MAX(bufsectors, MAX(out_bs->bl.opt_transfer_length,
                                         out_bs->bl.discard_alignment))
                    );

2089
    if (skip_create) {
2090
        int64_t output_sectors = blk_nb_sectors(out_blk);
2091
        if (output_sectors < 0) {
2092
            error_report("unable to get output image length: %s",
2093
                         strerror(-output_sectors));
2094 2095
            ret = -1;
            goto out;
2096
        } else if (output_sectors < total_sectors) {
2097 2098 2099 2100 2101 2102
            error_report("output file is smaller than input file");
            ret = -1;
            goto out;
        }
    }

2103 2104 2105 2106
    cluster_sectors = 0;
    ret = bdrv_get_info(out_bs, &bdi);
    if (ret < 0) {
        if (compress) {
2107
            error_report("could not get block driver info");
2108 2109
            goto out;
        }
2110
    } else {
2111
        compress = compress || bdi.needs_compressed_writes;
2112 2113 2114
        cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
    }

2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127
    state = (ImgConvertState) {
        .src                = blk,
        .src_sectors        = bs_sectors,
        .src_num            = bs_n,
        .total_sectors      = total_sectors,
        .target             = out_blk,
        .compressed         = compress,
        .target_has_backing = (bool) out_baseimg,
        .min_sparse         = min_sparse,
        .cluster_sectors    = cluster_sectors,
        .buf_sectors        = bufsectors,
    };
    ret = convert_do_copy(&state);
2128

2129
out:
2130 2131 2132
    if (!ret) {
        qemu_progress_print(100, 0);
    }
2133
    qemu_progress_end();
2134 2135
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
2136
    qemu_opts_del(sn_opts);
M
Markus Armbruster 已提交
2137
    blk_unref(out_blk);
2138
    g_free(bs);
M
Markus Armbruster 已提交
2139 2140 2141 2142 2143 2144
    if (blk) {
        for (bs_i = 0; bs_i < bs_n; bs_i++) {
            blk_unref(blk[bs_i]);
        }
        g_free(blk);
    }
2145
    g_free(bs_sectors);
2146 2147 2148
fail_getopt:
    g_free(options);

2149 2150 2151
    if (ret) {
        return 1;
    }
B
bellard 已提交
2152 2153 2154
    return 0;
}

B
bellard 已提交
2155

B
bellard 已提交
2156 2157 2158 2159 2160 2161 2162 2163 2164
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");
2165 2166
    bdrv_snapshot_dump(fprintf, stdout, NULL);
    printf("\n");
B
bellard 已提交
2167 2168
    for(i = 0; i < nb_sns; i++) {
        sn = &sn_tab[i];
2169 2170
        bdrv_snapshot_dump(fprintf, stdout, sn);
        printf("\n");
B
bellard 已提交
2171
    }
2172
    g_free(sn_tab);
B
bellard 已提交
2173 2174
}

2175 2176
static void dump_json_image_info_list(ImageInfoList *list)
{
2177
    Error *local_err = NULL;
2178 2179 2180
    QString *str;
    QmpOutputVisitor *ov = qmp_output_visitor_new();
    QObject *obj;
2181 2182
    visit_type_ImageInfoList(qmp_output_get_visitor(ov), NULL, &list,
                             &local_err);
2183 2184 2185 2186 2187 2188 2189 2190 2191
    obj = qmp_output_get_qobject(ov);
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
    qmp_output_visitor_cleanup(ov);
    QDECREF(str);
}

2192 2193
static void dump_json_image_info(ImageInfo *info)
{
2194
    Error *local_err = NULL;
2195 2196 2197
    QString *str;
    QmpOutputVisitor *ov = qmp_output_visitor_new();
    QObject *obj;
2198
    visit_type_ImageInfo(qmp_output_get_visitor(ov), NULL, &info, &local_err);
2199 2200 2201 2202 2203 2204 2205 2206 2207
    obj = qmp_output_get_qobject(ov);
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
    qmp_output_visitor_cleanup(ov);
    QDECREF(str);
}

2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218
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;

2219
        bdrv_image_info_dump(fprintf, stdout, elem->value);
2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239
    }
}

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.
 */
2240 2241
static ImageInfoList *collect_image_info_list(bool image_opts,
                                              const char *filename,
2242 2243 2244 2245 2246 2247
                                              const char *fmt,
                                              bool chain)
{
    ImageInfoList *head = NULL;
    ImageInfoList **last = &head;
    GHashTable *filenames;
2248
    Error *err = NULL;
2249 2250 2251 2252

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

    while (filename) {
M
Markus Armbruster 已提交
2253
        BlockBackend *blk;
2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264
        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);

2265
        blk = img_open(image_opts, filename, fmt,
2266
                       BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false);
2267
        if (!blk) {
2268 2269
            goto err;
        }
2270
        bs = blk_bs(blk);
2271

2272
        bdrv_query_image_info(bs, &info, &err);
2273
        if (err) {
2274
            error_report_err(err);
M
Markus Armbruster 已提交
2275
            blk_unref(blk);
2276
            goto err;
2277
        }
2278 2279 2280 2281 2282 2283

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

M
Markus Armbruster 已提交
2284
        blk_unref(blk);
2285 2286 2287 2288 2289 2290

        filename = fmt = NULL;
        if (chain) {
            if (info->has_full_backing_filename) {
                filename = info->full_backing_filename;
            } else if (info->has_backing_filename) {
2291 2292 2293 2294
                error_report("Could not determine absolute backing filename,"
                             " but backing filename '%s' present",
                             info->backing_filename);
                goto err;
2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309
            }
            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;
}

2310 2311 2312 2313
static int img_info(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
2314
    bool chain = false;
2315
    const char *filename, *fmt, *output;
2316
    ImageInfoList *list;
2317
    bool image_opts = false;
2318

B
bellard 已提交
2319
    fmt = NULL;
2320
    output = NULL;
B
bellard 已提交
2321
    for(;;) {
2322 2323 2324 2325 2326
        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},
2327
            {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2328
            {"object", required_argument, 0, OPTION_OBJECT},
2329
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2330 2331 2332 2333
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "f:h",
                        long_options, &option_index);
2334
        if (c == -1) {
B
bellard 已提交
2335
            break;
2336
        }
B
bellard 已提交
2337
        switch(c) {
J
Jes Sorensen 已提交
2338
        case '?':
B
bellard 已提交
2339 2340 2341 2342 2343 2344
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2345 2346 2347
        case OPTION_OUTPUT:
            output = optarg;
            break;
2348 2349 2350
        case OPTION_BACKING_CHAIN:
            chain = true;
            break;
2351 2352 2353 2354 2355 2356 2357 2358
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2359 2360 2361
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
B
bellard 已提交
2362 2363
        }
    }
2364
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2365
        error_exit("Expecting one image file name");
2366
    }
B
bellard 已提交
2367 2368
    filename = argv[optind++];

2369 2370 2371 2372 2373 2374
    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.");
2375 2376
        return 1;
    }
2377

2378 2379
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2380
                          NULL, NULL)) {
2381 2382 2383
        return 1;
    }

2384
    list = collect_image_info_list(image_opts, filename, fmt, chain);
2385
    if (!list) {
2386
        return 1;
B
bellard 已提交
2387
    }
2388 2389 2390

    switch (output_format) {
    case OFORMAT_HUMAN:
2391
        dump_human_image_info_list(list);
2392 2393
        break;
    case OFORMAT_JSON:
2394 2395 2396 2397 2398
        if (chain) {
            dump_json_image_info_list(list);
        } else {
            dump_json_image_info(list->value);
        }
2399
        break;
B
bellard 已提交
2400
    }
2401

2402
    qapi_free_ImageInfoList(list);
B
bellard 已提交
2403 2404 2405
    return 0;
}

P
Paolo Bonzini 已提交
2406 2407 2408 2409 2410
static void dump_map_entry(OutputFormat output_format, MapEntry *e,
                           MapEntry *next)
{
    switch (output_format) {
    case OFORMAT_HUMAN:
2411
        if (e->data && !e->has_offset) {
P
Paolo Bonzini 已提交
2412 2413 2414
            error_report("File contains external, encrypted or compressed clusters.");
            exit(1);
        }
2415
        if (e->data && !e->zero) {
P
Paolo Bonzini 已提交
2416
            printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2417 2418 2419
                   e->start, e->length,
                   e->has_offset ? e->offset : 0,
                   e->has_filename ? e->filename : "");
P
Paolo Bonzini 已提交
2420 2421 2422 2423
        }
        /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
         * Modify the flags here to allow more coalescing.
         */
2424 2425 2426
        if (next && (!next->data || next->zero)) {
            next->data = false;
            next->zero = true;
P
Paolo Bonzini 已提交
2427 2428 2429
        }
        break;
    case OFORMAT_JSON:
2430 2431
        printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
               " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
P
Paolo Bonzini 已提交
2432 2433
               (e->start == 0 ? "[" : ",\n"),
               e->start, e->length, e->depth,
2434 2435 2436
               e->zero ? "true" : "false",
               e->data ? "true" : "false");
        if (e->has_offset) {
P
Paolo Bonzini 已提交
2437
            printf(", \"offset\": %"PRId64"", e->offset);
P
Paolo Bonzini 已提交
2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452
        }
        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;
2453
    BlockDriverState *file;
J
John Snow 已提交
2454
    bool has_offset;
P
Paolo Bonzini 已提交
2455 2456 2457 2458 2459 2460 2461 2462

    /* 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 (;;) {
2463 2464
        ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
                                    &file);
P
Paolo Bonzini 已提交
2465 2466 2467 2468 2469 2470 2471
        if (ret < 0) {
            return ret;
        }
        assert(nb_sectors);
        if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
            break;
        }
2472
        bs = backing_bs(bs);
P
Paolo Bonzini 已提交
2473 2474 2475 2476 2477 2478 2479 2480
        if (bs == NULL) {
            ret = 0;
            break;
        }

        depth++;
    }

J
John Snow 已提交
2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494
    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 已提交
2495 2496 2497
    return 0;
}

2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518
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 已提交
2519 2520 2521 2522
static int img_map(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
M
Markus Armbruster 已提交
2523
    BlockBackend *blk;
P
Paolo Bonzini 已提交
2524 2525 2526 2527 2528
    BlockDriverState *bs;
    const char *filename, *fmt, *output;
    int64_t length;
    MapEntry curr = { .length = 0 }, next;
    int ret = 0;
2529
    bool image_opts = false;
P
Paolo Bonzini 已提交
2530 2531 2532 2533 2534 2535 2536 2537 2538

    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},
2539
            {"object", required_argument, 0, OPTION_OBJECT},
2540
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
P
Paolo Bonzini 已提交
2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "f:h",
                        long_options, &option_index);
        if (c == -1) {
            break;
        }
        switch (c) {
        case '?':
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case OPTION_OUTPUT:
            output = optarg;
            break;
2559 2560 2561 2562 2563 2564 2565 2566
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2567 2568 2569
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
P
Paolo Bonzini 已提交
2570 2571
        }
    }
F
Fam Zheng 已提交
2572 2573
    if (optind != argc - 1) {
        error_exit("Expecting one image file name");
P
Paolo Bonzini 已提交
2574
    }
F
Fam Zheng 已提交
2575
    filename = argv[optind];
P
Paolo Bonzini 已提交
2576 2577 2578 2579 2580 2581 2582 2583 2584 2585

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

2586 2587
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2588
                          NULL, NULL)) {
2589 2590 2591
        return 1;
    }

2592
    blk = img_open(image_opts, filename, fmt, 0, false, false);
2593 2594
    if (!blk) {
        return 1;
P
Paolo Bonzini 已提交
2595
    }
2596
    bs = blk_bs(blk);
P
Paolo Bonzini 已提交
2597 2598 2599 2600 2601

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

2602
    length = blk_getlength(blk);
P
Paolo Bonzini 已提交
2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619
    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;
        }

2620
        if (entry_mergeable(&curr, &next)) {
P
Paolo Bonzini 已提交
2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633
            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 已提交
2634
    blk_unref(blk);
P
Paolo Bonzini 已提交
2635 2636 2637
    return ret < 0;
}

2638 2639 2640 2641 2642
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

2643
static int img_snapshot(int argc, char **argv)
2644
{
M
Markus Armbruster 已提交
2645
    BlockBackend *blk;
2646 2647 2648
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
2649
    int c, ret = 0, bdrv_oflags;
2650 2651
    int action = 0;
    qemu_timeval tv;
2652
    bool quiet = false;
2653
    Error *err = NULL;
2654
    bool image_opts = false;
2655

2656
    bdrv_oflags = BDRV_O_RDWR;
2657 2658
    /* Parse commandline parameters */
    for(;;) {
2659 2660 2661
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
2662
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2663 2664 2665 2666
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "la:c:d:hq",
                        long_options, NULL);
2667
        if (c == -1) {
2668
            break;
2669
        }
2670
        switch(c) {
J
Jes Sorensen 已提交
2671
        case '?':
2672 2673
        case 'h':
            help();
2674
            return 0;
2675 2676
        case 'l':
            if (action) {
F
Fam Zheng 已提交
2677
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2678
                return 0;
2679 2680
            }
            action = SNAPSHOT_LIST;
2681
            bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2682 2683 2684
            break;
        case 'a':
            if (action) {
F
Fam Zheng 已提交
2685
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2686
                return 0;
2687 2688 2689 2690 2691 2692
            }
            action = SNAPSHOT_APPLY;
            snapshot_name = optarg;
            break;
        case 'c':
            if (action) {
F
Fam Zheng 已提交
2693
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2694
                return 0;
2695 2696 2697 2698 2699 2700
            }
            action = SNAPSHOT_CREATE;
            snapshot_name = optarg;
            break;
        case 'd':
            if (action) {
F
Fam Zheng 已提交
2701
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2702
                return 0;
2703 2704 2705 2706
            }
            action = SNAPSHOT_DELETE;
            snapshot_name = optarg;
            break;
2707 2708 2709
        case 'q':
            quiet = true;
            break;
2710 2711 2712 2713 2714 2715 2716 2717
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2718 2719 2720
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
2721 2722 2723
        }
    }

2724
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2725
        error_exit("Expecting one image file name");
2726
    }
2727 2728
    filename = argv[optind++];

2729 2730
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2731
                          NULL, NULL)) {
2732 2733 2734
        return 1;
    }

2735
    /* Open the image */
2736
    blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet);
2737 2738
    if (!blk) {
        return 1;
2739
    }
2740
    bs = blk_bs(blk);
2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756

    /* 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);
2757
        if (ret) {
2758
            error_report("Could not create snapshot '%s': %d (%s)",
2759
                snapshot_name, ret, strerror(-ret));
2760
        }
2761 2762 2763 2764
        break;

    case SNAPSHOT_APPLY:
        ret = bdrv_snapshot_goto(bs, snapshot_name);
2765
        if (ret) {
2766
            error_report("Could not apply snapshot '%s': %d (%s)",
2767
                snapshot_name, ret, strerror(-ret));
2768
        }
2769 2770 2771
        break;

    case SNAPSHOT_DELETE:
2772
        bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2773
        if (err) {
2774 2775
            error_reportf_err(err, "Could not delete snapshot '%s': ",
                              snapshot_name);
2776
            ret = 1;
2777
        }
2778 2779 2780 2781
        break;
    }

    /* Cleanup */
M
Markus Armbruster 已提交
2782
    blk_unref(blk);
2783 2784 2785
    if (ret) {
        return 1;
    }
2786
    return 0;
2787 2788
}

K
Kevin Wolf 已提交
2789 2790
static int img_rebase(int argc, char **argv)
{
M
Markus Armbruster 已提交
2791
    BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
P
Paolo Bonzini 已提交
2792 2793
    uint8_t *buf_old = NULL;
    uint8_t *buf_new = NULL;
2794
    BlockDriverState *bs = NULL;
K
Kevin Wolf 已提交
2795
    char *filename;
2796 2797
    const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
    int c, flags, src_flags, ret;
2798
    bool writethrough, src_writethrough;
K
Kevin Wolf 已提交
2799
    int unsafe = 0;
2800
    int progress = 0;
2801
    bool quiet = false;
2802
    Error *local_err = NULL;
2803
    bool image_opts = false;
K
Kevin Wolf 已提交
2804 2805

    /* Parse commandline parameters */
K
Kevin Wolf 已提交
2806
    fmt = NULL;
2807
    cache = BDRV_DEFAULT_CACHE;
2808
    src_cache = BDRV_DEFAULT_CACHE;
K
Kevin Wolf 已提交
2809 2810 2811
    out_baseimg = NULL;
    out_basefmt = NULL;
    for(;;) {
2812 2813 2814
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
2815
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2816 2817 2818 2819
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "hf:F:b:upt:T:q",
                        long_options, NULL);
2820
        if (c == -1) {
K
Kevin Wolf 已提交
2821
            break;
2822
        }
K
Kevin Wolf 已提交
2823
        switch(c) {
J
Jes Sorensen 已提交
2824
        case '?':
K
Kevin Wolf 已提交
2825 2826 2827
        case 'h':
            help();
            return 0;
K
Kevin Wolf 已提交
2828 2829 2830
        case 'f':
            fmt = optarg;
            break;
K
Kevin Wolf 已提交
2831 2832 2833 2834 2835 2836 2837 2838 2839
        case 'F':
            out_basefmt = optarg;
            break;
        case 'b':
            out_baseimg = optarg;
            break;
        case 'u':
            unsafe = 1;
            break;
2840 2841 2842
        case 'p':
            progress = 1;
            break;
2843 2844 2845
        case 't':
            cache = optarg;
            break;
2846 2847 2848
        case 'T':
            src_cache = optarg;
            break;
2849 2850 2851
        case 'q':
            quiet = true;
            break;
2852 2853 2854 2855 2856 2857 2858 2859
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2860 2861 2862
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
K
Kevin Wolf 已提交
2863 2864 2865
        }
    }

2866 2867 2868 2869
    if (quiet) {
        progress = 0;
    }

F
Fam Zheng 已提交
2870 2871 2872 2873 2874
    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)");
2875
    }
K
Kevin Wolf 已提交
2876 2877
    filename = argv[optind++];

2878 2879
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2880
                          NULL, NULL)) {
2881 2882 2883
        return 1;
    }

2884 2885 2886
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

2887
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2888
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2889 2890
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2891
        goto out;
2892 2893
    }

2894 2895
    src_flags = 0;
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2896 2897
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
2898
        goto out;
2899 2900
    }

2901 2902 2903 2904
    /* 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 已提交
2905 2906 2907 2908 2909 2910
    /*
     * 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.
     */
2911
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
2912
    if (!blk) {
2913 2914
        ret = -1;
        goto out;
2915
    }
2916
    bs = blk_bs(blk);
K
Kevin Wolf 已提交
2917 2918

    if (out_basefmt != NULL) {
2919
        if (bdrv_find_format(out_basefmt) == NULL) {
2920
            error_report("Invalid format name: '%s'", out_basefmt);
2921 2922
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
2923 2924 2925 2926
        }
    }

    /* For safe rebasing we need to compare old and new backing file */
2927
    if (!unsafe) {
2928
        char backing_name[PATH_MAX];
2929 2930 2931 2932 2933 2934
        QDict *options = NULL;

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

        bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2937
        blk_old_backing = blk_new_open(backing_name, NULL,
2938 2939
                                       options, src_flags, &local_err);
        if (!blk_old_backing) {
2940 2941 2942
            error_reportf_err(local_err,
                              "Could not open old backing file '%s': ",
                              backing_name);
2943
            goto out;
K
Kevin Wolf 已提交
2944
        }
2945

2946
        if (out_baseimg[0]) {
2947 2948 2949 2950 2951 2952 2953
            if (out_basefmt) {
                options = qdict_new();
                qdict_put(options, "driver", qstring_from_str(out_basefmt));
            } else {
                options = NULL;
            }

2954
            blk_new_backing = blk_new_open(out_baseimg, NULL,
2955 2956
                                           options, src_flags, &local_err);
            if (!blk_new_backing) {
2957 2958 2959
                error_reportf_err(local_err,
                                  "Could not open new backing file '%s': ",
                                  out_baseimg);
2960 2961
                goto out;
            }
K
Kevin Wolf 已提交
2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974
        }
    }

    /*
     * 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) {
2975 2976 2977
        int64_t num_sectors;
        int64_t old_backing_num_sectors;
        int64_t new_backing_num_sectors = 0;
K
Kevin Wolf 已提交
2978
        uint64_t sector;
2979
        int n;
2980
        float local_progress = 0;
2981

2982 2983
        buf_old = blk_blockalign(blk, IO_BUF_SIZE);
        buf_new = blk_blockalign(blk, IO_BUF_SIZE);
K
Kevin Wolf 已提交
2984

2985
        num_sectors = blk_nb_sectors(blk);
2986 2987 2988 2989 2990 2991
        if (num_sectors < 0) {
            error_report("Could not get size of '%s': %s",
                         filename, strerror(-num_sectors));
            ret = -1;
            goto out;
        }
2992
        old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
2993
        if (old_backing_num_sectors < 0) {
2994
            char backing_name[PATH_MAX];
2995 2996 2997 2998 2999 3000 3001

            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;
        }
3002 3003
        if (blk_new_backing) {
            new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
3004 3005 3006 3007 3008 3009
            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;
            }
3010
        }
K
Kevin Wolf 已提交
3011

3012 3013 3014 3015 3016
        if (num_sectors != 0) {
            local_progress = (float)100 /
                (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
        }

K
Kevin Wolf 已提交
3017 3018 3019 3020 3021 3022 3023 3024 3025 3026
        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 */
3027
            ret = bdrv_is_allocated(bs, sector, n, &n);
3028 3029 3030 3031 3032
            if (ret < 0) {
                error_report("error while reading image metadata: %s",
                             strerror(-ret));
                goto out;
            }
3033
            if (ret) {
K
Kevin Wolf 已提交
3034 3035 3036
                continue;
            }

3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047
            /*
             * 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;
                }

3048 3049
                ret = blk_pread(blk_old_backing, sector << BDRV_SECTOR_BITS,
                                buf_old, n << BDRV_SECTOR_BITS);
3050 3051 3052 3053
                if (ret < 0) {
                    error_report("error while reading from old backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3054
            }
3055

3056
            if (sector >= new_backing_num_sectors || !blk_new_backing) {
3057 3058 3059 3060 3061 3062
                memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
            } else {
                if (sector + n > new_backing_num_sectors) {
                    n = new_backing_num_sectors - sector;
                }

3063 3064
                ret = blk_pread(blk_new_backing, sector << BDRV_SECTOR_BITS,
                                buf_new, n << BDRV_SECTOR_BITS);
3065 3066 3067 3068
                if (ret < 0) {
                    error_report("error while reading from new backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3069 3070 3071 3072 3073 3074 3075 3076 3077
            }

            /* 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,
3078
                    buf_new + written * 512, n - written, &pnum))
K
Kevin Wolf 已提交
3079
                {
3080 3081 3082 3083
                    ret = blk_pwrite(blk,
                                     (sector + written) << BDRV_SECTOR_BITS,
                                     buf_old + written * 512,
                                     pnum << BDRV_SECTOR_BITS, 0);
K
Kevin Wolf 已提交
3084
                    if (ret < 0) {
3085
                        error_report("Error while writing to COW image: %s",
K
Kevin Wolf 已提交
3086
                            strerror(-ret));
3087
                        goto out;
K
Kevin Wolf 已提交
3088 3089 3090 3091 3092
                    }
                }

                written += pnum;
            }
3093
            qemu_progress_print(local_progress, 100);
K
Kevin Wolf 已提交
3094 3095 3096 3097 3098 3099 3100 3101
        }
    }

    /*
     * 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.
     */
3102 3103 3104 3105 3106 3107
    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 已提交
3108
    if (ret == -ENOSPC) {
3109 3110
        error_report("Could not change the backing file to '%s': No "
                     "space left in the file header", out_baseimg);
K
Kevin Wolf 已提交
3111
    } else if (ret < 0) {
3112
        error_report("Could not change the backing file to '%s': %s",
K
Kevin Wolf 已提交
3113 3114 3115
            out_baseimg, strerror(-ret));
    }

3116
    qemu_progress_print(100, 0);
K
Kevin Wolf 已提交
3117 3118 3119 3120 3121 3122
    /*
     * 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.
     */
3123
out:
3124
    qemu_progress_end();
K
Kevin Wolf 已提交
3125 3126
    /* Cleanup */
    if (!unsafe) {
M
Markus Armbruster 已提交
3127 3128
        blk_unref(blk_old_backing);
        blk_unref(blk_new_backing);
K
Kevin Wolf 已提交
3129
    }
P
Paolo Bonzini 已提交
3130 3131
    qemu_vfree(buf_old);
    qemu_vfree(buf_new);
K
Kevin Wolf 已提交
3132

M
Markus Armbruster 已提交
3133
    blk_unref(blk);
3134 3135 3136
    if (ret) {
        return 1;
    }
K
Kevin Wolf 已提交
3137 3138 3139
    return 0;
}

3140 3141
static int img_resize(int argc, char **argv)
{
3142
    Error *err = NULL;
3143 3144 3145
    int c, ret, relative;
    const char *filename, *fmt, *size;
    int64_t n, total_size;
3146
    bool quiet = false;
M
Markus Armbruster 已提交
3147
    BlockBackend *blk = NULL;
3148
    QemuOpts *param;
3149

3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160
    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 */
            }
3161 3162
        },
    };
3163
    bool image_opts = false;
3164

K
Kevin Wolf 已提交
3165 3166 3167
    /* Remove size from argv manually so that negative numbers are not treated
     * as options by getopt. */
    if (argc < 3) {
F
Fam Zheng 已提交
3168
        error_exit("Not enough arguments");
K
Kevin Wolf 已提交
3169 3170 3171 3172 3173 3174
        return 1;
    }

    size = argv[--argc];

    /* Parse getopt arguments */
3175 3176
    fmt = NULL;
    for(;;) {
3177 3178 3179
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3180
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3181 3182 3183 3184
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "f:hq",
                        long_options, NULL);
3185 3186 3187 3188
        if (c == -1) {
            break;
        }
        switch(c) {
J
Jes Sorensen 已提交
3189
        case '?':
3190 3191 3192 3193 3194 3195
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
3196 3197 3198
        case 'q':
            quiet = true;
            break;
3199 3200 3201 3202 3203 3204 3205 3206
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3207 3208 3209
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
3210 3211
        }
    }
3212
    if (optind != argc - 1) {
F
Fam Zheng 已提交
3213
        error_exit("Expecting one image file name");
3214 3215 3216
    }
    filename = argv[optind++];

3217 3218
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3219
                          NULL, NULL)) {
3220 3221 3222
        return 1;
    }

3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238
    /* 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 */
3239
    param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3240
    qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3241 3242
    if (err) {
        error_report_err(err);
3243
        ret = -1;
3244
        qemu_opts_del(param);
3245
        goto out;
3246
    }
3247 3248
    n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
    qemu_opts_del(param);
3249

3250
    blk = img_open(image_opts, filename, fmt,
3251
                   BDRV_O_RDWR, false, quiet);
3252
    if (!blk) {
3253 3254
        ret = -1;
        goto out;
3255
    }
3256 3257

    if (relative) {
3258
        total_size = blk_getlength(blk) + n * relative;
3259 3260 3261 3262
    } else {
        total_size = n;
    }
    if (total_size <= 0) {
3263
        error_report("New image size must be positive");
3264 3265
        ret = -1;
        goto out;
3266 3267
    }

3268
    ret = blk_truncate(blk, total_size);
3269 3270
    switch (ret) {
    case 0:
3271
        qprintf(quiet, "Image resized.\n");
3272 3273
        break;
    case -ENOTSUP:
3274
        error_report("This image does not support resize");
3275 3276
        break;
    case -EACCES:
3277
        error_report("Image is read-only");
3278 3279
        break;
    default:
3280
        error_report("Error resizing image (%d)", -ret);
3281 3282
        break;
    }
3283
out:
M
Markus Armbruster 已提交
3284
    blk_unref(blk);
3285 3286 3287
    if (ret) {
        return 1;
    }
3288 3289 3290
    return 0;
}

3291
static void amend_status_cb(BlockDriverState *bs,
3292 3293
                            int64_t offset, int64_t total_work_size,
                            void *opaque)
3294 3295 3296 3297
{
    qemu_progress_print(100.f * offset / total_work_size, 0);
}

M
Max Reitz 已提交
3298 3299
static int img_amend(int argc, char **argv)
{
3300
    Error *err = NULL;
M
Max Reitz 已提交
3301 3302
    int c, ret = 0;
    char *options = NULL;
3303 3304
    QemuOptsList *create_opts = NULL;
    QemuOpts *opts = NULL;
3305 3306
    const char *fmt = NULL, *filename, *cache;
    int flags;
3307
    bool writethrough;
3308
    bool quiet = false, progress = false;
M
Markus Armbruster 已提交
3309
    BlockBackend *blk = NULL;
M
Max Reitz 已提交
3310
    BlockDriverState *bs = NULL;
3311
    bool image_opts = false;
M
Max Reitz 已提交
3312

3313
    cache = BDRV_DEFAULT_CACHE;
M
Max Reitz 已提交
3314
    for (;;) {
3315 3316 3317
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3318
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3319 3320 3321 3322
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "ho:f:t:pq",
                        long_options, NULL);
M
Max Reitz 已提交
3323 3324 3325 3326 3327 3328 3329 3330 3331 3332
        if (c == -1) {
            break;
        }

        switch (c) {
            case 'h':
            case '?':
                help();
                break;
            case 'o':
3333 3334 3335
                if (!is_valid_option_list(optarg)) {
                    error_report("Invalid option list: %s", optarg);
                    ret = -1;
3336
                    goto out_no_progress;
3337 3338 3339 3340 3341 3342 3343 3344
                }
                if (!options) {
                    options = g_strdup(optarg);
                } else {
                    char *old_options = options;
                    options = g_strdup_printf("%s,%s", options, optarg);
                    g_free(old_options);
                }
M
Max Reitz 已提交
3345 3346 3347 3348
                break;
            case 'f':
                fmt = optarg;
                break;
3349 3350 3351
            case 't':
                cache = optarg;
                break;
3352 3353 3354
            case 'p':
                progress = true;
                break;
M
Max Reitz 已提交
3355 3356 3357
            case 'q':
                quiet = true;
                break;
3358 3359 3360 3361 3362 3363 3364 3365
            case OPTION_OBJECT:
                opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                               optarg, true);
                if (!opts) {
                    ret = -1;
                    goto out_no_progress;
                }
                break;
3366 3367 3368
            case OPTION_IMAGE_OPTS:
                image_opts = true;
                break;
M
Max Reitz 已提交
3369 3370 3371
        }
    }

3372
    if (!options) {
F
Fam Zheng 已提交
3373
        error_exit("Must specify options (-o)");
M
Max Reitz 已提交
3374 3375
    }

3376 3377
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3378
                          NULL, NULL)) {
3379 3380 3381 3382
        ret = -1;
        goto out_no_progress;
    }

3383 3384 3385 3386 3387
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);

3388 3389 3390 3391 3392 3393
    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 已提交
3394 3395
    }

3396
    if (optind != argc - 1) {
M
Max Reitz 已提交
3397 3398 3399
        error_report("Expecting one image file name");
        ret = -1;
        goto out;
3400
    }
M
Max Reitz 已提交
3401

3402 3403
    flags = BDRV_O_RDWR;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3404 3405 3406 3407 3408
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        goto out;
    }

3409
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3410
    if (!blk) {
M
Max Reitz 已提交
3411 3412 3413
        ret = -1;
        goto out;
    }
3414
    bs = blk_bs(blk);
M
Max Reitz 已提交
3415 3416 3417

    fmt = bs->drv->format_name;

3418
    if (has_help_option(options)) {
3419
        /* If the format was auto-detected, print option help here */
M
Max Reitz 已提交
3420 3421 3422 3423
        ret = print_block_option_help(filename, fmt);
        goto out;
    }

3424 3425 3426 3427 3428 3429 3430
    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 已提交
3431
    create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3432
    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
3433 3434 3435
    if (options) {
        qemu_opts_do_parse(opts, options, NULL, &err);
        if (err) {
3436
            error_report_err(err);
3437 3438 3439
            ret = -1;
            goto out;
        }
M
Max Reitz 已提交
3440 3441
    }

3442 3443
    /* In case the driver does not call amend_status_cb() */
    qemu_progress_print(0.f, 0);
3444
    ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
3445
    qemu_progress_print(100.f, 0);
M
Max Reitz 已提交
3446 3447 3448 3449 3450 3451
    if (ret < 0) {
        error_report("Error while amending options: %s", strerror(-ret));
        goto out;
    }

out:
3452 3453
    qemu_progress_end();

3454
out_no_progress:
M
Markus Armbruster 已提交
3455
    blk_unref(blk);
3456 3457
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
3458 3459
    g_free(options);

M
Max Reitz 已提交
3460 3461 3462 3463 3464 3465
    if (ret) {
        return 1;
    }
    return 0;
}

K
Kevin Wolf 已提交
3466 3467 3468
typedef struct BenchData {
    BlockBackend *blk;
    uint64_t image_size;
K
Kevin Wolf 已提交
3469
    bool write;
K
Kevin Wolf 已提交
3470
    int bufsize;
3471
    int step;
K
Kevin Wolf 已提交
3472 3473
    int nrreq;
    int n;
3474 3475
    int flush_interval;
    bool drain_on_flush;
K
Kevin Wolf 已提交
3476 3477 3478 3479
    uint8_t *buf;
    QEMUIOVector *qiov;

    int in_flight;
3480
    bool in_flush;
K
Kevin Wolf 已提交
3481 3482 3483
    uint64_t offset;
} BenchData;

3484 3485 3486 3487 3488 3489 3490 3491
static void bench_undrained_flush_cb(void *opaque, int ret)
{
    if (ret < 0) {
        error_report("Failed flush request: %s\n", strerror(-ret));
        exit(EXIT_FAILURE);
    }
}

K
Kevin Wolf 已提交
3492 3493 3494 3495 3496 3497 3498 3499 3500
static void bench_cb(void *opaque, int ret)
{
    BenchData *b = opaque;
    BlockAIOCB *acb;

    if (ret < 0) {
        error_report("Failed request: %s\n", strerror(-ret));
        exit(EXIT_FAILURE);
    }
3501 3502 3503 3504 3505 3506 3507 3508

    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 已提交
3509 3510
        b->n--;
        b->in_flight--;
3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533

        /* 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 已提交
3534 3535 3536
    }

    while (b->n > b->in_flight && b->in_flight < b->nrreq) {
K
Kevin Wolf 已提交
3537 3538 3539 3540 3541 3542 3543
        if (b->write) {
            acb = blk_aio_pwritev(b->blk, b->offset, b->qiov, 0,
                                  bench_cb, b);
        } else {
            acb = blk_aio_preadv(b->blk, b->offset, b->qiov, 0,
                                 bench_cb, b);
        }
K
Kevin Wolf 已提交
3544 3545 3546 3547 3548
        if (!acb) {
            error_report("Failed to issue request");
            exit(EXIT_FAILURE);
        }
        b->in_flight++;
3549
        b->offset += b->step;
K
Kevin Wolf 已提交
3550 3551 3552 3553 3554 3555 3556 3557 3558 3559
        b->offset %= b->image_size;
    }
}

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 已提交
3560
    bool is_write = false;
K
Kevin Wolf 已提交
3561 3562
    int count = 75000;
    int depth = 64;
3563
    int64_t offset = 0;
K
Kevin Wolf 已提交
3564
    size_t bufsize = 4096;
K
Kevin Wolf 已提交
3565
    int pattern = 0;
3566
    size_t step = 0;
3567 3568
    int flush_interval = 0;
    bool drain_on_flush = true;
K
Kevin Wolf 已提交
3569 3570 3571 3572
    int64_t image_size;
    BlockBackend *blk = NULL;
    BenchData data = {};
    int flags = 0;
3573
    bool writethrough = false;
K
Kevin Wolf 已提交
3574 3575 3576 3577 3578 3579
    struct timeval t1, t2;
    int i;

    for (;;) {
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
3580
            {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
K
Kevin Wolf 已提交
3581
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
K
Kevin Wolf 已提交
3582
            {"pattern", required_argument, 0, OPTION_PATTERN},
3583
            {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
K
Kevin Wolf 已提交
3584 3585
            {0, 0, 0, 0}
        };
3586
        c = getopt_long(argc, argv, "hc:d:f:no:qs:S:t:w", long_options, NULL);
K
Kevin Wolf 已提交
3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623
        if (c == -1) {
            break;
        }

        switch (c) {
        case 'h':
        case '?':
            help();
            break;
        case 'c':
        {
            char *end;
            errno = 0;
            count = strtoul(optarg, &end, 0);
            if (errno || *end || count > INT_MAX) {
                error_report("Invalid request count specified");
                return 1;
            }
            break;
        }
        case 'd':
        {
            char *end;
            errno = 0;
            depth = strtoul(optarg, &end, 0);
            if (errno || *end || depth > INT_MAX) {
                error_report("Invalid queue depth specified");
                return 1;
            }
            break;
        }
        case 'f':
            fmt = optarg;
            break;
        case 'n':
            flags |= BDRV_O_NATIVE_AIO;
            break;
3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636
        case 'o':
        {
            char *end;
            errno = 0;
            offset = qemu_strtosz_suffix(optarg, &end,
                                         QEMU_STRTOSZ_DEFSUFFIX_B);
            if (offset < 0|| *end) {
                error_report("Invalid offset specified");
                return 1;
            }
            break;
        }
            break;
K
Kevin Wolf 已提交
3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653
        case 'q':
            quiet = true;
            break;
        case 's':
        {
            int64_t sval;
            char *end;

            sval = qemu_strtosz_suffix(optarg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
            if (sval < 0 || sval > INT_MAX || *end) {
                error_report("Invalid buffer size specified");
                return 1;
            }

            bufsize = sval;
            break;
        }
3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667
        case 'S':
        {
            int64_t sval;
            char *end;

            sval = qemu_strtosz_suffix(optarg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
            if (sval < 0 || sval > INT_MAX || *end) {
                error_report("Invalid step size specified");
                return 1;
            }

            step = sval;
            break;
        }
K
Kevin Wolf 已提交
3668 3669 3670 3671 3672 3673 3674 3675
        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 已提交
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690
        case 'w':
            flags |= BDRV_O_RDWR;
            is_write = true;
            break;
        case OPTION_PATTERN:
        {
            char *end;
            errno = 0;
            pattern = strtoul(optarg, &end, 0);
            if (errno || *end || pattern > 0xff) {
                error_report("Invalid pattern byte specified");
                return 1;
            }
            break;
        }
3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704
        case OPTION_FLUSH_INTERVAL:
        {
            char *end;
            errno = 0;
            flush_interval = strtoul(optarg, &end, 0);
            if (errno || *end || flush_interval > INT_MAX) {
                error_report("Invalid flush interval specified");
                return 1;
            }
            break;
        }
        case OPTION_NO_DRAIN:
            drain_on_flush = false;
            break;
K
Kevin Wolf 已提交
3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
        }
    }

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

3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726
    if (!is_write && flush_interval) {
        error_report("--flush-interval is only available in write tests");
        ret = -1;
        goto out;
    }
    if (flush_interval && flush_interval < depth) {
        error_report("Flush interval can't be smaller than depth");
        ret = -1;
        goto out;
    }

K
Kevin Wolf 已提交
3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
    if (!blk) {
        ret = -1;
        goto out;
    }

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

    data = (BenchData) {
3740 3741 3742 3743 3744 3745 3746 3747 3748 3749
        .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 已提交
3750
    };
3751
    printf("Sending %d %s requests, %d bytes each, %d in parallel "
3752
           "(starting at offset %" PRId64 ", step size %d)\n",
3753
           data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
3754
           data.offset, data.step);
3755 3756 3757
    if (flush_interval) {
        printf("Sending flush every %d requests\n", flush_interval);
    }
K
Kevin Wolf 已提交
3758 3759

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

K
Kevin Wolf 已提交
3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791
    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) {
        return 1;
    }
    return 0;
}


A
Anthony Liguori 已提交
3792
static const img_cmd_t img_cmds[] = {
3793 3794 3795 3796 3797 3798 3799 3800
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
    { NULL, NULL, },
};

B
bellard 已提交
3801 3802
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
3803
    const img_cmd_t *cmd;
3804
    const char *cmdname;
3805
    Error *local_error = NULL;
3806 3807 3808
    int c;
    static const struct option long_options[] = {
        {"help", no_argument, 0, 'h'},
3809
        {"version", no_argument, 0, 'v'},
3810 3811
        {0, 0, 0, 0}
    };
B
bellard 已提交
3812

3813 3814 3815 3816
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

K
Kevin Wolf 已提交
3817
    error_set_progname(argv[0]);
3818
    qemu_init_exec_dir(argv[0]);
K
Kevin Wolf 已提交
3819

3820
    if (qemu_init_main_loop(&local_error)) {
3821
        error_report_err(local_error);
3822 3823 3824
        exit(EXIT_FAILURE);
    }

3825
    qcrypto_init(&error_fatal);
3826

3827
    module_call_init(MODULE_INIT_QOM);
B
bellard 已提交
3828
    bdrv_init();
F
Fam Zheng 已提交
3829 3830 3831
    if (argc < 2) {
        error_exit("Not enough arguments");
    }
3832 3833
    cmdname = argv[1];

3834
    qemu_add_opts(&qemu_object_opts);
3835
    qemu_add_opts(&qemu_source_opts);
3836

3837
    /* find the command */
3838
    for (cmd = img_cmds; cmd->name != NULL; cmd++) {
3839
        if (!strcmp(cmdname, cmd->name)) {
3840
            return cmd->handler(argc - 1, argv + 1);
3841
        }
B
bellard 已提交
3842
    }
3843

3844
    c = getopt_long(argc, argv, "h", long_options, NULL);
3845 3846 3847 3848

    if (c == 'h') {
        help();
    }
3849 3850 3851 3852
    if (c == 'v') {
        printf(QEMU_IMG_VERSION);
        return 0;
    }
3853

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