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

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

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

50 51 52
enum {
    OPTION_OUTPUT = 256,
    OPTION_BACKING_CHAIN = 257,
53
    OPTION_OBJECT = 258,
54
    OPTION_IMAGE_OPTS = 259,
55 56 57 58 59 60 61
};

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

62
/* Default to cache=writeback as data integrity is not important for qemu-tcg. */
63
#define BDRV_O_FLAGS BDRV_O_CACHE_WB
64
#define BDRV_DEFAULT_CACHE "writeback"
65

66
static void format_print(void *opaque, const char *name)
B
bellard 已提交
67
{
68
    printf(" %s", name);
B
bellard 已提交
69 70
}

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

    printf("%s\nSupported formats:", help_msg);
161
    bdrv_iterate_format(format_print, NULL);
B
bellard 已提交
162
    printf("\n");
F
Fam Zheng 已提交
163
    exit(EXIT_SUCCESS);
B
bellard 已提交
164 165
}

166 167 168 169 170 171 172 173 174
static QemuOptsList qemu_object_opts = {
    .name = "object",
    .implied_opt_name = "qom-type",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
    .desc = {
        { }
    },
};

175 176 177 178 179 180 181 182 183
static QemuOptsList qemu_source_opts = {
    .name = "source",
    .implied_opt_name = "file",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
    .desc = {
        { }
    },
};

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

B
bellard 已提交
196

197 198 199
static int print_block_option_help(const char *filename, const char *fmt)
{
    BlockDriver *drv, *proto_drv;
200
    QemuOptsList *create_opts = NULL;
201
    Error *local_err = NULL;
202 203 204 205

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

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

221 222
    qemu_opts_print_help(create_opts);
    qemu_opts_free(create_opts);
223 224 225
    return 0;
}

226 227

static int img_open_password(BlockBackend *blk, const char *filename,
228
                             int flags, bool quiet)
229 230 231
{
    BlockDriverState *bs;
    char password[256];
232 233

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


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

264
    if (img_open_password(blk, optstr, flags, quiet) < 0) {
265 266 267 268 269 270
        blk_unref(blk);
        return NULL;
    }
    return blk;
}

271
static BlockBackend *img_open_file(const char *filename,
272
                                   const char *fmt, int flags,
273
                                   bool quiet)
274 275
{
    BlockBackend *blk;
276
    Error *local_err = NULL;
277
    QDict *options = NULL;
278

279
    if (fmt) {
280 281
        options = qdict_new();
        qdict_put(options, "driver", qstring_from_str(fmt));
282
    }
283

284
    blk = blk_new_open(filename, NULL, options, flags, &local_err);
285
    if (!blk) {
286
        error_reportf_err(local_err, "Could not open '%s': ", filename);
287
        return NULL;
288
    }
289

290
    if (img_open_password(blk, filename, flags, quiet) < 0) {
291 292 293 294 295 296 297
        blk_unref(blk);
        return NULL;
    }
    return blk;
}


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

322

323
static int add_old_style_options(const char *fmt, QemuOpts *opts,
324 325
                                 const char *base_filename,
                                 const char *base_fmt)
326
{
327 328
    Error *err = NULL;

329
    if (base_filename) {
330
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
331
        if (err) {
332 333
            error_report("Backing file not supported for file format '%s'",
                         fmt);
334
            error_free(err);
335
            return -1;
336 337 338
        }
    }
    if (base_fmt) {
339
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
340
        if (err) {
341 342
            error_report("Backing file format not supported for file "
                         "format '%s'", fmt);
343
            error_free(err);
344
            return -1;
345 346
        }
    }
347
    return 0;
348 349
}

B
bellard 已提交
350 351
static int img_create(int argc, char **argv)
{
352
    int c;
353
    uint64_t img_size = -1;
B
bellard 已提交
354
    const char *fmt = "raw";
355
    const char *base_fmt = NULL;
B
bellard 已提交
356 357
    const char *filename;
    const char *base_filename = NULL;
358
    char *options = NULL;
359
    Error *local_err = NULL;
360
    bool quiet = false;
361

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

422
    /* Get the filename */
423 424 425 426 427 428
    filename = (optind < argc) ? argv[optind] : NULL;
    if (options && has_help_option(options)) {
        g_free(options);
        return print_block_option_help(filename, fmt);
    }

429
    if (optind >= argc) {
F
Fam Zheng 已提交
430
        error_exit("Expecting image file name");
431
    }
432
    optind++;
433

434 435 436 437 438 439 440
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
                          NULL, &local_err)) {
        error_report_err(local_err);
        goto fail;
    }

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

464
    bdrv_img_create(filename, fmt, base_filename, base_fmt,
465
                    options, img_size, BDRV_O_FLAGS, &local_err, quiet);
466
    if (local_err) {
467
        error_reportf_err(local_err, "%s: ", filename);
468
        goto fail;
469
    }
470

471
    g_free(options);
B
bellard 已提交
472
    return 0;
473 474 475 476

fail:
    g_free(options);
    return 1;
B
bellard 已提交
477 478
}

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

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

        if (check->leaks) {
509 510 511 512
            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);
513 514 515
        }

        if (check->check_errors) {
516 517 518 519
            qprintf(quiet,
                    "\n%" PRId64
                    " internal errors have occurred during the check.\n",
                    check->check_errors);
520 521 522 523
        }
    }

    if (check->total_clusters != 0 && check->allocated_clusters != 0) {
524 525 526 527 528 529 530
        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);
531 532 533
    }

    if (check->image_end_offset) {
534 535
        qprintf(quiet,
                "Image end offset: %" PRId64 "\n", check->image_end_offset);
536 537 538 539 540 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
    }
}

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;
572 573
    check->compressed_clusters      = result.bfi.compressed_clusters;
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
574 575 576 577

    return 0;
}

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

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

667 668 669 670 671 672 673 674 675
    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;
    }

676 677 678 679 680 681 682
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
                          NULL, &local_err)) {
        error_report_err(local_err);
        return 1;
    }

683 684 685 686 687 688
    ret = bdrv_parse_cache_flags(cache, &flags);
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        return 1;
    }

689
    blk = img_open(image_opts, filename, fmt, flags, quiet);
690 691
    if (!blk) {
        return 1;
692
    }
693
    bs = blk_bs(blk);
694 695 696

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
697 698

    if (ret == -ENOTSUP) {
699
        error_report("This image format does not support checks");
700
        ret = 63;
701
        goto fail;
702 703
    }

704 705
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
706

707 708
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
709

710
        if (output_format == OFORMAT_HUMAN) {
711 712 713 714 715 716 717
            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);
718 719
        }

720
        ret = collect_image_check(bs, check, filename, fmt, 0);
721

722 723
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
724 725
    }

M
Max Reitz 已提交
726 727 728 729 730 731 732 733 734
    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;
        }
735 736
    }

737
    if (ret || check->check_errors) {
M
Max Reitz 已提交
738 739 740 741 742
        if (ret) {
            error_report("Check failed: %s", strerror(-ret));
        } else {
            error_report("Check failed");
        }
743 744
        ret = 1;
        goto fail;
745
    }
746

747 748 749 750
    if (check->corruptions) {
        ret = 2;
    } else if (check->leaks) {
        ret = 3;
751
    } else {
752
        ret = 0;
753
    }
754 755 756

fail:
    qapi_free_ImageCheck(check);
M
Markus Armbruster 已提交
757
    blk_unref(blk);
758
    return ret;
759 760
}

M
Max Reitz 已提交
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
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)
{
    AioContext *aio_context = bdrv_get_aio_context(job->bs);

    do {
        aio_poll(aio_context, true);
781 782
        qemu_progress_print(job->len ?
                            ((float)job->offset / job->len * 100.f) : 0.0f, 0);
M
Max Reitz 已提交
783 784 785
    } while (!job->ready);

    block_job_complete_sync(job, errp);
786 787 788 789

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

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

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

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

862
    if (optind != argc - 1) {
F
Fam Zheng 已提交
863
        error_exit("Expecting one image file name");
864
    }
B
bellard 已提交
865 866
    filename = argv[optind++];

867 868 869 870 871 872 873
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
                          NULL, &local_err)) {
        error_report_err(local_err);
        return 1;
    }

M
Max Reitz 已提交
874
    flags = BDRV_O_RDWR | BDRV_O_UNMAP;
875
    ret = bdrv_parse_cache_flags(cache, &flags);
876 877
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
878
        return 1;
879 880
    }

881
    blk = img_open(image_opts, filename, fmt, flags, quiet);
882 883
    if (!blk) {
        return 1;
884
    }
885 886
    bs = blk_bs(blk);

887 888 889
    qemu_progress_init(progress, 1.f);
    qemu_progress_print(0.f, 100);

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

    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 已提交
916 917
    }

918 919 920 921
    /* 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 已提交
922
    if (!drop) {
923
        bdrv_ref(bs);
M
Max Reitz 已提交
924 925
    }

M
Max Reitz 已提交
926
    run_block_job(bs->job, &local_err);
M
Max Reitz 已提交
927 928 929 930
    if (local_err) {
        goto unref_backing;
    }

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

unref_backing:
    if (!drop) {
942
        bdrv_unref(bs);
M
Max Reitz 已提交
943
    }
M
Max Reitz 已提交
944 945

done:
946 947
    qemu_progress_end();

M
Markus Armbruster 已提交
948
    blk_unref(blk);
M
Max Reitz 已提交
949 950

    if (local_err) {
951
        error_report_err(local_err);
952 953
        return 1;
    }
M
Max Reitz 已提交
954 955

    qprintf(quiet, "Image committed.\n");
B
bellard 已提交
956 957 958
    return 0;
}

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

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
975
    is_zero = buffer_is_zero(buf, 512);
B
bellard 已提交
976 977
    for(i = 1; i < n; i++) {
        buf += 512;
978
        if (is_zero != buffer_is_zero(buf, 512)) {
B
bellard 已提交
979
            break;
980
        }
B
bellard 已提交
981 982
    }
    *pnum = i;
983
    return !is_zero;
B
bellard 已提交
984 985
}

986 987 988 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
/*
 * 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 已提交
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
/*
 * 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)
{
1038 1039
    bool res;
    int i;
K
Kevin Wolf 已提交
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059

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

1060
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
1061

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

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

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


1190
    if (optind != argc - 2) {
F
Fam Zheng 已提交
1191
        error_exit("Expecting two image file names");
1192 1193 1194 1195
    }
    filename1 = argv[optind++];
    filename2 = argv[optind++];

1196 1197 1198 1199 1200 1201 1202 1203
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
                          NULL, &local_err)) {
        error_report_err(local_err);
        ret = 2;
        goto out4;
    }

1204 1205 1206
    /* Initialize before goto out */
    qemu_progress_init(progress, 2.0);

1207 1208 1209 1210 1211 1212 1213 1214
    flags = BDRV_O_FLAGS;
    ret = bdrv_parse_cache_flags(cache, &flags);
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        ret = 2;
        goto out3;
    }

1215
    blk1 = img_open(image_opts, filename1, fmt1, flags, quiet);
1216
    if (!blk1) {
1217
        ret = 2;
1218
        goto out3;
1219 1220
    }

1221
    blk2 = img_open(image_opts, filename2, fmt2, flags, quiet);
1222
    if (!blk2) {
1223
        ret = 2;
1224
        goto out2;
1225
    }
1226
    bs1 = blk_bs(blk1);
1227
    bs2 = blk_bs(blk2);
1228

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

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

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

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

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

    if (total_sectors1 != total_sectors2) {
1352
        BlockBackend *blk_over;
1353 1354 1355 1356 1357 1358
        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;
1359
            blk_over = blk1;
1360 1361 1362
            filename_over = filename1;
        } else {
            total_sectors_over = total_sectors2;
1363
            blk_over = blk2;
1364 1365 1366 1367 1368 1369 1370 1371
            filename_over = filename2;
        }

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

1415 1416 1417 1418 1419 1420 1421 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
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) {
1460
        BlockDriverState *file;
1461 1462
        ret = bdrv_get_block_status(blk_bs(s->src[s->src_cur]),
                                    sector_num - s->src_cur_offset,
1463
                                    n, &n, &file);
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 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 1543 1544 1545 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 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 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 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709
        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. */
            /* TODO Check block status of the backing file chain to avoid
             * needlessly reading zeroes and limiting the iteration to the
             * buffer size */
            s->status = BLK_DATA;
        } 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;

    if (s->status == BLK_ZERO || s->status == BLK_BACKING_FILE) {
        return 0;
    }

    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));
        ret = blk_read(blk, sector_num - s->src_cur_offset, buf, n);
        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))
            {
                ret = blk_write(s->target, sector_num, buf, n);
                if (ret < 0) {
                    return ret;
                }
                break;
            }
            /* fall-through */

        case BLK_ZERO:
            if (s->has_zero_init) {
                break;
            }
            ret = blk_write_zeroes(s->target, sector_num, n, 0);
            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;
        }
        if (s->status == BLK_DATA) {
            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;
        }
        if (s->status == BLK_DATA) {
            allocated_done += n;
            qemu_progress_print(100.0 * allocated_done / s->allocated_sectors,
                                0);
        }

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

        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 已提交
1710 1711
static int img_convert(int argc, char **argv)
{
1712
    int c, bs_n, bs_i, compress, cluster_sectors, skip_create;
1713
    int64_t ret = 0;
1714 1715
    int progress = 0, flags, src_flags;
    const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
1716
    BlockDriver *drv, *proto_drv;
M
Markus Armbruster 已提交
1717
    BlockBackend **blk = NULL, *out_blk = NULL;
1718
    BlockDriverState **bs = NULL, *out_bs = NULL;
1719
    int64_t total_sectors;
1720
    int64_t *bs_sectors = NULL;
1721
    size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
B
bellard 已提交
1722
    BlockDriverInfo bdi;
1723 1724 1725
    QemuOpts *opts = NULL;
    QemuOptsList *create_opts = NULL;
    const char *out_baseimg_param;
1726
    char *options = NULL;
E
edison 已提交
1727
    const char *snapshot_name = NULL;
1728
    int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1729
    bool quiet = false;
1730
    Error *local_err = NULL;
1731
    QemuOpts *sn_opts = NULL;
1732
    ImgConvertState state;
1733
    bool image_opts = false;
B
bellard 已提交
1734 1735 1736

    fmt = NULL;
    out_fmt = "raw";
1737
    cache = "unsafe";
1738
    src_cache = BDRV_DEFAULT_CACHE;
1739
    out_baseimg = NULL;
1740
    compress = 0;
1741
    skip_create = 0;
B
bellard 已提交
1742
    for(;;) {
1743 1744 1745
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
1746
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1747 1748 1749 1750
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qn",
                        long_options, NULL);
1751
        if (c == -1) {
B
bellard 已提交
1752
            break;
1753
        }
B
bellard 已提交
1754
        switch(c) {
J
Jes Sorensen 已提交
1755
        case '?':
B
bellard 已提交
1756 1757 1758 1759 1760 1761 1762 1763 1764
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'O':
            out_fmt = optarg;
            break;
1765 1766 1767
        case 'B':
            out_baseimg = optarg;
            break;
B
bellard 已提交
1768
        case 'c':
1769
            compress = 1;
B
bellard 已提交
1770 1771
            break;
        case 'e':
1772
            error_report("option -e is deprecated, please use \'-o "
1773
                  "encryption\' instead!");
1774
            ret = -1;
1775
            goto fail_getopt;
1776
        case '6':
1777
            error_report("option -6 is deprecated, please use \'-o "
1778
                  "compat6\' instead!");
1779
            ret = -1;
1780
            goto fail_getopt;
1781
        case 'o':
1782 1783 1784
            if (!is_valid_option_list(optarg)) {
                error_report("Invalid option list: %s", optarg);
                ret = -1;
1785
                goto fail_getopt;
1786 1787 1788 1789 1790 1791 1792 1793
            }
            if (!options) {
                options = g_strdup(optarg);
            } else {
                char *old_options = options;
                options = g_strdup_printf("%s,%s", options, optarg);
                g_free(old_options);
            }
1794
            break;
E
edison 已提交
1795 1796 1797
        case 's':
            snapshot_name = optarg;
            break;
1798 1799
        case 'l':
            if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
1800 1801
                sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
                                                  optarg, false);
1802 1803 1804
                if (!sn_opts) {
                    error_report("Failed in parsing snapshot param '%s'",
                                 optarg);
1805
                    ret = -1;
1806
                    goto fail_getopt;
1807 1808 1809 1810 1811
                }
            } else {
                snapshot_name = optarg;
            }
            break;
1812 1813 1814
        case 'S':
        {
            int64_t sval;
1815
            char *end;
1816
            sval = qemu_strtosz_suffix(optarg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
1817
            if (sval < 0 || *end) {
1818
                error_report("Invalid minimum zero buffer size for sparse output specified");
1819
                ret = -1;
1820
                goto fail_getopt;
1821 1822 1823 1824 1825
            }

            min_sparse = sval / BDRV_SECTOR_SIZE;
            break;
        }
1826 1827 1828
        case 'p':
            progress = 1;
            break;
1829 1830 1831
        case 't':
            cache = optarg;
            break;
1832 1833 1834
        case 'T':
            src_cache = optarg;
            break;
1835 1836 1837
        case 'q':
            quiet = true;
            break;
1838 1839 1840
        case 'n':
            skip_create = 1;
            break;
1841 1842 1843 1844 1845 1846 1847
        case OPTION_OBJECT:
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                goto fail_getopt;
            }
            break;
1848 1849 1850
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
B
bellard 已提交
1851 1852
        }
    }
1853

1854 1855 1856 1857 1858 1859 1860
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
                          NULL, &local_err)) {
        error_report_err(local_err);
        goto fail_getopt;
    }

1861
    /* Initialize before goto out */
1862 1863 1864
    if (quiet) {
        progress = 0;
    }
1865 1866
    qemu_progress_init(progress, 1.0);

1867
    bs_n = argc - optind - 1;
1868
    out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
1869

1870
    if (options && has_help_option(options)) {
1871 1872 1873 1874
        ret = print_block_option_help(out_filename, out_fmt);
        goto out;
    }

1875
    if (bs_n < 1) {
F
Fam Zheng 已提交
1876
        error_exit("Must specify image file name");
1877 1878 1879
    }


1880
    if (bs_n > 1 && out_baseimg) {
1881 1882
        error_report("-B makes no sense when concatenating multiple input "
                     "images");
1883 1884
        ret = -1;
        goto out;
1885
    }
1886

1887 1888 1889 1890 1891 1892 1893
    src_flags = BDRV_O_FLAGS;
    ret = bdrv_parse_cache_flags(src_cache, &src_flags);
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
        goto out;
    }

1894 1895
    qemu_progress_print(0, 100);

M
Markus Armbruster 已提交
1896
    blk = g_new0(BlockBackend *, bs_n);
1897
    bs = g_new0(BlockDriverState *, bs_n);
1898
    bs_sectors = g_new(int64_t, bs_n);
1899 1900 1901

    total_sectors = 0;
    for (bs_i = 0; bs_i < bs_n; bs_i++) {
1902
        blk[bs_i] = img_open(image_opts, argv[optind + bs_i],
1903
                             fmt, src_flags, quiet);
1904
        if (!blk[bs_i]) {
1905 1906 1907
            ret = -1;
            goto out;
        }
1908
        bs[bs_i] = blk_bs(blk[bs_i]);
1909
        bs_sectors[bs_i] = blk_nb_sectors(blk[bs_i]);
1910 1911 1912 1913 1914 1915
        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;
        }
1916
        total_sectors += bs_sectors[bs_i];
1917
    }
B
bellard 已提交
1918

1919 1920 1921 1922 1923 1924
    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 已提交
1925
        if (bs_n > 1) {
1926
            error_report("No support for concatenating multiple snapshot");
E
edison 已提交
1927 1928 1929
            ret = -1;
            goto out;
        }
1930 1931

        bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1932
    }
1933
    if (local_err) {
1934
        error_reportf_err(local_err, "Failed to load snapshot: ");
1935 1936
        ret = -1;
        goto out;
E
edison 已提交
1937 1938
    }

1939
    /* Find driver and parse its options */
B
bellard 已提交
1940
    drv = bdrv_find_format(out_fmt);
1941
    if (!drv) {
1942
        error_report("Unknown file format '%s'", out_fmt);
1943 1944 1945
        ret = -1;
        goto out;
    }
1946

1947
    proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
1948
    if (!proto_drv) {
1949
        error_report_err(local_err);
1950 1951 1952
        ret = -1;
        goto out;
    }
1953

M
Max Reitz 已提交
1954 1955 1956 1957 1958 1959 1960
    if (!skip_create) {
        if (!drv->create_opts) {
            error_report("Format driver '%s' does not support image creation",
                         drv->format_name);
            ret = -1;
            goto out;
        }
1961

M
Max Reitz 已提交
1962 1963 1964 1965 1966 1967
        if (!proto_drv->create_opts) {
            error_report("Protocol driver '%s' does not support image creation",
                         proto_drv->format_name);
            ret = -1;
            goto out;
        }
1968

M
Max Reitz 已提交
1969 1970
        create_opts = qemu_opts_append(create_opts, drv->create_opts);
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
1971

M
Max Reitz 已提交
1972
        opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
1973 1974 1975
        if (options) {
            qemu_opts_do_parse(opts, options, NULL, &local_err);
            if (local_err) {
1976
                error_report_err(local_err);
1977 1978 1979
                ret = -1;
                goto out;
            }
M
Max Reitz 已提交
1980
        }
1981

1982 1983
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512,
                            &error_abort);
M
Max Reitz 已提交
1984 1985 1986 1987
        ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
        if (ret < 0) {
            goto out;
        }
1988
    }
1989

1990
    /* Get backing file name if -o backing_file was used */
1991
    out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
1992
    if (out_baseimg_param) {
1993
        out_baseimg = out_baseimg_param;
1994 1995
    }

1996
    /* Check if compression is supported */
1997
    if (compress) {
1998 1999 2000 2001
        bool encryption =
            qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
        const char *preallocation =
            qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2002 2003

        if (!drv->bdrv_write_compressed) {
2004
            error_report("Compression not supported for this file format");
2005 2006
            ret = -1;
            goto out;
2007 2008
        }

2009
        if (encryption) {
2010 2011
            error_report("Compression and encryption not supported at "
                         "the same time");
2012 2013
            ret = -1;
            goto out;
2014
        }
2015

2016 2017
        if (preallocation
            && strcmp(preallocation, "off"))
2018 2019 2020 2021 2022 2023
        {
            error_report("Compression and preallocation not supported at "
                         "the same time");
            ret = -1;
            goto out;
        }
2024 2025
    }

2026 2027
    if (!skip_create) {
        /* Create the new image */
C
Chunyan Liu 已提交
2028
        ret = bdrv_create(drv, out_filename, opts, &local_err);
2029
        if (ret < 0) {
2030 2031
            error_reportf_err(local_err, "%s: error while converting %s: ",
                              out_filename, out_fmt);
2032
            goto out;
B
bellard 已提交
2033 2034
        }
    }
2035

2036
    flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2037
    ret = bdrv_parse_cache_flags(cache, &flags);
2038 2039
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2040
        goto out;
2041 2042
    }

2043 2044 2045 2046 2047
    /* 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...
     */
2048
    out_blk = img_open_file(out_filename, out_fmt, flags, quiet);
2049
    if (!out_blk) {
2050 2051 2052
        ret = -1;
        goto out;
    }
2053
    out_bs = blk_bs(out_blk);
B
bellard 已提交
2054

2055 2056 2057 2058 2059 2060 2061 2062
    /* 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))
                    );

2063
    if (skip_create) {
2064
        int64_t output_sectors = blk_nb_sectors(out_blk);
2065
        if (output_sectors < 0) {
2066
            error_report("unable to get output image length: %s",
2067
                         strerror(-output_sectors));
2068 2069
            ret = -1;
            goto out;
2070
        } else if (output_sectors < total_sectors) {
2071 2072 2073 2074 2075 2076
            error_report("output file is smaller than input file");
            ret = -1;
            goto out;
        }
    }

2077 2078 2079 2080
    cluster_sectors = 0;
    ret = bdrv_get_info(out_bs, &bdi);
    if (ret < 0) {
        if (compress) {
2081
            error_report("could not get block driver info");
2082 2083
            goto out;
        }
2084
    } else {
2085
        compress = compress || bdi.needs_compressed_writes;
2086 2087 2088
        cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
    }

2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101
    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);
2102

2103
out:
2104 2105 2106
    if (!ret) {
        qemu_progress_print(100, 0);
    }
2107
    qemu_progress_end();
2108 2109
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
2110
    qemu_opts_del(sn_opts);
M
Markus Armbruster 已提交
2111
    blk_unref(out_blk);
2112
    g_free(bs);
M
Markus Armbruster 已提交
2113 2114 2115 2116 2117 2118
    if (blk) {
        for (bs_i = 0; bs_i < bs_n; bs_i++) {
            blk_unref(blk[bs_i]);
        }
        g_free(blk);
    }
2119
    g_free(bs_sectors);
2120 2121 2122
fail_getopt:
    g_free(options);

2123 2124 2125
    if (ret) {
        return 1;
    }
B
bellard 已提交
2126 2127 2128
    return 0;
}

B
bellard 已提交
2129

B
bellard 已提交
2130 2131 2132 2133 2134 2135 2136 2137 2138
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");
2139 2140
    bdrv_snapshot_dump(fprintf, stdout, NULL);
    printf("\n");
B
bellard 已提交
2141 2142
    for(i = 0; i < nb_sns; i++) {
        sn = &sn_tab[i];
2143 2144
        bdrv_snapshot_dump(fprintf, stdout, sn);
        printf("\n");
B
bellard 已提交
2145
    }
2146
    g_free(sn_tab);
B
bellard 已提交
2147 2148
}

2149 2150
static void dump_json_image_info_list(ImageInfoList *list)
{
2151
    Error *local_err = NULL;
2152 2153 2154
    QString *str;
    QmpOutputVisitor *ov = qmp_output_visitor_new();
    QObject *obj;
2155 2156
    visit_type_ImageInfoList(qmp_output_get_visitor(ov), NULL, &list,
                             &local_err);
2157 2158 2159 2160 2161 2162 2163 2164 2165
    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);
}

2166 2167
static void dump_json_image_info(ImageInfo *info)
{
2168
    Error *local_err = NULL;
2169 2170 2171
    QString *str;
    QmpOutputVisitor *ov = qmp_output_visitor_new();
    QObject *obj;
2172
    visit_type_ImageInfo(qmp_output_get_visitor(ov), NULL, &info, &local_err);
2173 2174 2175 2176 2177 2178 2179 2180 2181
    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);
}

2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192
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;

2193
        bdrv_image_info_dump(fprintf, stdout, elem->value);
2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213
    }
}

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.
 */
2214 2215
static ImageInfoList *collect_image_info_list(bool image_opts,
                                              const char *filename,
2216 2217 2218 2219 2220 2221
                                              const char *fmt,
                                              bool chain)
{
    ImageInfoList *head = NULL;
    ImageInfoList **last = &head;
    GHashTable *filenames;
2222
    Error *err = NULL;
2223 2224 2225 2226

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

    while (filename) {
M
Markus Armbruster 已提交
2227
        BlockBackend *blk;
2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238
        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);

2239
        blk = img_open(image_opts, filename, fmt,
2240 2241
                       BDRV_O_FLAGS | BDRV_O_NO_BACKING | BDRV_O_NO_IO,
                       false);
2242
        if (!blk) {
2243 2244
            goto err;
        }
2245
        bs = blk_bs(blk);
2246

2247
        bdrv_query_image_info(bs, &info, &err);
2248
        if (err) {
2249
            error_report_err(err);
M
Markus Armbruster 已提交
2250
            blk_unref(blk);
2251
            goto err;
2252
        }
2253 2254 2255 2256 2257 2258

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

M
Markus Armbruster 已提交
2259
        blk_unref(blk);
2260 2261 2262 2263 2264 2265

        filename = fmt = NULL;
        if (chain) {
            if (info->has_full_backing_filename) {
                filename = info->full_backing_filename;
            } else if (info->has_backing_filename) {
2266 2267 2268 2269
                error_report("Could not determine absolute backing filename,"
                             " but backing filename '%s' present",
                             info->backing_filename);
                goto err;
2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284
            }
            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;
}

2285 2286 2287 2288
static int img_info(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
2289
    bool chain = false;
2290
    const char *filename, *fmt, *output;
2291
    ImageInfoList *list;
2292
    Error *local_err = NULL;
2293
    bool image_opts = false;
2294

B
bellard 已提交
2295
    fmt = NULL;
2296
    output = NULL;
B
bellard 已提交
2297
    for(;;) {
2298 2299 2300 2301 2302
        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},
2303
            {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2304
            {"object", required_argument, 0, OPTION_OBJECT},
2305
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2306 2307 2308 2309
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "f:h",
                        long_options, &option_index);
2310
        if (c == -1) {
B
bellard 已提交
2311
            break;
2312
        }
B
bellard 已提交
2313
        switch(c) {
J
Jes Sorensen 已提交
2314
        case '?':
B
bellard 已提交
2315 2316 2317 2318 2319 2320
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2321 2322 2323
        case OPTION_OUTPUT:
            output = optarg;
            break;
2324 2325 2326
        case OPTION_BACKING_CHAIN:
            chain = true;
            break;
2327 2328 2329 2330 2331 2332 2333 2334
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2335 2336 2337
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
B
bellard 已提交
2338 2339
        }
    }
2340
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2341
        error_exit("Expecting one image file name");
2342
    }
B
bellard 已提交
2343 2344
    filename = argv[optind++];

2345 2346 2347 2348 2349 2350
    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.");
2351 2352
        return 1;
    }
2353

2354 2355 2356 2357 2358 2359 2360
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
                          NULL, &local_err)) {
        error_report_err(local_err);
        return 1;
    }

2361
    list = collect_image_info_list(image_opts, filename, fmt, chain);
2362
    if (!list) {
2363
        return 1;
B
bellard 已提交
2364
    }
2365 2366 2367

    switch (output_format) {
    case OFORMAT_HUMAN:
2368
        dump_human_image_info_list(list);
2369 2370
        break;
    case OFORMAT_JSON:
2371 2372 2373 2374 2375
        if (chain) {
            dump_json_image_info_list(list);
        } else {
            dump_json_image_info(list->value);
        }
2376
        break;
B
bellard 已提交
2377
    }
2378

2379
    qapi_free_ImageInfoList(list);
B
bellard 已提交
2380 2381 2382
    return 0;
}

P
Paolo Bonzini 已提交
2383 2384 2385 2386 2387
static void dump_map_entry(OutputFormat output_format, MapEntry *e,
                           MapEntry *next)
{
    switch (output_format) {
    case OFORMAT_HUMAN:
2388
        if (e->data && !e->has_offset) {
P
Paolo Bonzini 已提交
2389 2390 2391
            error_report("File contains external, encrypted or compressed clusters.");
            exit(1);
        }
2392
        if (e->data && !e->zero) {
P
Paolo Bonzini 已提交
2393
            printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2394 2395 2396
                   e->start, e->length,
                   e->has_offset ? e->offset : 0,
                   e->has_filename ? e->filename : "");
P
Paolo Bonzini 已提交
2397 2398 2399 2400
        }
        /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
         * Modify the flags here to allow more coalescing.
         */
2401 2402 2403
        if (next && (!next->data || next->zero)) {
            next->data = false;
            next->zero = true;
P
Paolo Bonzini 已提交
2404 2405 2406
        }
        break;
    case OFORMAT_JSON:
2407 2408
        printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
               " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
P
Paolo Bonzini 已提交
2409 2410
               (e->start == 0 ? "[" : ",\n"),
               e->start, e->length, e->depth,
2411 2412 2413
               e->zero ? "true" : "false",
               e->data ? "true" : "false");
        if (e->has_offset) {
P
Paolo Bonzini 已提交
2414
            printf(", \"offset\": %"PRId64"", e->offset);
P
Paolo Bonzini 已提交
2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429
        }
        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;
2430
    BlockDriverState *file;
J
John Snow 已提交
2431
    bool has_offset;
P
Paolo Bonzini 已提交
2432 2433 2434 2435 2436 2437 2438 2439

    /* 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 (;;) {
2440 2441
        ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
                                    &file);
P
Paolo Bonzini 已提交
2442 2443 2444 2445 2446 2447 2448
        if (ret < 0) {
            return ret;
        }
        assert(nb_sectors);
        if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
            break;
        }
2449
        bs = backing_bs(bs);
P
Paolo Bonzini 已提交
2450 2451 2452 2453 2454 2455 2456 2457
        if (bs == NULL) {
            ret = 0;
            break;
        }

        depth++;
    }

J
John Snow 已提交
2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471
    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 已提交
2472 2473 2474
    return 0;
}

2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495
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 已提交
2496 2497 2498 2499
static int img_map(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
M
Markus Armbruster 已提交
2500
    BlockBackend *blk;
P
Paolo Bonzini 已提交
2501 2502 2503 2504 2505
    BlockDriverState *bs;
    const char *filename, *fmt, *output;
    int64_t length;
    MapEntry curr = { .length = 0 }, next;
    int ret = 0;
2506
    Error *local_err = NULL;
2507
    bool image_opts = false;
P
Paolo Bonzini 已提交
2508 2509 2510 2511 2512 2513 2514 2515 2516

    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},
2517
            {"object", required_argument, 0, OPTION_OBJECT},
2518
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
P
Paolo Bonzini 已提交
2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536
            {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;
2537 2538 2539 2540 2541 2542 2543 2544
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2545 2546 2547
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
P
Paolo Bonzini 已提交
2548 2549
        }
    }
F
Fam Zheng 已提交
2550 2551
    if (optind != argc - 1) {
        error_exit("Expecting one image file name");
P
Paolo Bonzini 已提交
2552
    }
F
Fam Zheng 已提交
2553
    filename = argv[optind];
P
Paolo Bonzini 已提交
2554 2555 2556 2557 2558 2559 2560 2561 2562 2563

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

2564 2565 2566 2567 2568 2569 2570
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
                          NULL, &local_err)) {
        error_report_err(local_err);
        return 1;
    }

2571
    blk = img_open(image_opts, filename, fmt, BDRV_O_FLAGS, false);
2572 2573
    if (!blk) {
        return 1;
P
Paolo Bonzini 已提交
2574
    }
2575
    bs = blk_bs(blk);
P
Paolo Bonzini 已提交
2576 2577 2578 2579 2580

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

2581
    length = blk_getlength(blk);
P
Paolo Bonzini 已提交
2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598
    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;
        }

2599
        if (entry_mergeable(&curr, &next)) {
P
Paolo Bonzini 已提交
2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612
            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 已提交
2613
    blk_unref(blk);
P
Paolo Bonzini 已提交
2614 2615 2616
    return ret < 0;
}

2617 2618 2619 2620 2621
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

2622
static int img_snapshot(int argc, char **argv)
2623
{
M
Markus Armbruster 已提交
2624
    BlockBackend *blk;
2625 2626 2627
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
2628
    int c, ret = 0, bdrv_oflags;
2629 2630
    int action = 0;
    qemu_timeval tv;
2631
    bool quiet = false;
2632
    Error *err = NULL;
2633
    bool image_opts = false;
2634

2635
    bdrv_oflags = BDRV_O_FLAGS | BDRV_O_RDWR;
2636 2637
    /* Parse commandline parameters */
    for(;;) {
2638 2639 2640
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
2641
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2642 2643 2644 2645
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "la:c:d:hq",
                        long_options, NULL);
2646
        if (c == -1) {
2647
            break;
2648
        }
2649
        switch(c) {
J
Jes Sorensen 已提交
2650
        case '?':
2651 2652
        case 'h':
            help();
2653
            return 0;
2654 2655
        case 'l':
            if (action) {
F
Fam Zheng 已提交
2656
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2657
                return 0;
2658 2659
            }
            action = SNAPSHOT_LIST;
2660
            bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2661 2662 2663
            break;
        case 'a':
            if (action) {
F
Fam Zheng 已提交
2664
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2665
                return 0;
2666 2667 2668 2669 2670 2671
            }
            action = SNAPSHOT_APPLY;
            snapshot_name = optarg;
            break;
        case 'c':
            if (action) {
F
Fam Zheng 已提交
2672
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2673
                return 0;
2674 2675 2676 2677 2678 2679
            }
            action = SNAPSHOT_CREATE;
            snapshot_name = optarg;
            break;
        case 'd':
            if (action) {
F
Fam Zheng 已提交
2680
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2681
                return 0;
2682 2683 2684 2685
            }
            action = SNAPSHOT_DELETE;
            snapshot_name = optarg;
            break;
2686 2687 2688
        case 'q':
            quiet = true;
            break;
2689 2690 2691 2692 2693 2694 2695 2696
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2697 2698 2699
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
2700 2701 2702
        }
    }

2703
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2704
        error_exit("Expecting one image file name");
2705
    }
2706 2707
    filename = argv[optind++];

2708 2709 2710 2711 2712 2713 2714
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
                          NULL, &err)) {
        error_report_err(err);
        return 1;
    }

2715
    /* Open the image */
2716
    blk = img_open(image_opts, filename, NULL, bdrv_oflags, quiet);
2717 2718
    if (!blk) {
        return 1;
2719
    }
2720
    bs = blk_bs(blk);
2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736

    /* 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);
2737
        if (ret) {
2738
            error_report("Could not create snapshot '%s': %d (%s)",
2739
                snapshot_name, ret, strerror(-ret));
2740
        }
2741 2742 2743 2744
        break;

    case SNAPSHOT_APPLY:
        ret = bdrv_snapshot_goto(bs, snapshot_name);
2745
        if (ret) {
2746
            error_report("Could not apply snapshot '%s': %d (%s)",
2747
                snapshot_name, ret, strerror(-ret));
2748
        }
2749 2750 2751
        break;

    case SNAPSHOT_DELETE:
2752
        bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2753
        if (err) {
2754 2755
            error_reportf_err(err, "Could not delete snapshot '%s': ",
                              snapshot_name);
2756
            ret = 1;
2757
        }
2758 2759 2760 2761
        break;
    }

    /* Cleanup */
M
Markus Armbruster 已提交
2762
    blk_unref(blk);
2763 2764 2765
    if (ret) {
        return 1;
    }
2766
    return 0;
2767 2768
}

K
Kevin Wolf 已提交
2769 2770
static int img_rebase(int argc, char **argv)
{
M
Markus Armbruster 已提交
2771
    BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
P
Paolo Bonzini 已提交
2772 2773
    uint8_t *buf_old = NULL;
    uint8_t *buf_new = NULL;
2774
    BlockDriverState *bs = NULL;
K
Kevin Wolf 已提交
2775
    char *filename;
2776 2777
    const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
    int c, flags, src_flags, ret;
K
Kevin Wolf 已提交
2778
    int unsafe = 0;
2779
    int progress = 0;
2780
    bool quiet = false;
2781
    Error *local_err = NULL;
2782
    bool image_opts = false;
K
Kevin Wolf 已提交
2783 2784

    /* Parse commandline parameters */
K
Kevin Wolf 已提交
2785
    fmt = NULL;
2786
    cache = BDRV_DEFAULT_CACHE;
2787
    src_cache = BDRV_DEFAULT_CACHE;
K
Kevin Wolf 已提交
2788 2789 2790
    out_baseimg = NULL;
    out_basefmt = NULL;
    for(;;) {
2791 2792 2793
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
2794
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2795 2796 2797 2798
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "hf:F:b:upt:T:q",
                        long_options, NULL);
2799
        if (c == -1) {
K
Kevin Wolf 已提交
2800
            break;
2801
        }
K
Kevin Wolf 已提交
2802
        switch(c) {
J
Jes Sorensen 已提交
2803
        case '?':
K
Kevin Wolf 已提交
2804 2805 2806
        case 'h':
            help();
            return 0;
K
Kevin Wolf 已提交
2807 2808 2809
        case 'f':
            fmt = optarg;
            break;
K
Kevin Wolf 已提交
2810 2811 2812 2813 2814 2815 2816 2817 2818
        case 'F':
            out_basefmt = optarg;
            break;
        case 'b':
            out_baseimg = optarg;
            break;
        case 'u':
            unsafe = 1;
            break;
2819 2820 2821
        case 'p':
            progress = 1;
            break;
2822 2823 2824
        case 't':
            cache = optarg;
            break;
2825 2826 2827
        case 'T':
            src_cache = optarg;
            break;
2828 2829 2830
        case 'q':
            quiet = true;
            break;
2831 2832 2833 2834 2835 2836 2837 2838
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2839 2840 2841
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
K
Kevin Wolf 已提交
2842 2843 2844
        }
    }

2845 2846 2847 2848
    if (quiet) {
        progress = 0;
    }

F
Fam Zheng 已提交
2849 2850 2851 2852 2853
    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)");
2854
    }
K
Kevin Wolf 已提交
2855 2856
    filename = argv[optind++];

2857 2858 2859 2860 2861 2862 2863
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
                          NULL, &local_err)) {
        error_report_err(local_err);
        return 1;
    }

2864 2865 2866
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

2867
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2868
    ret = bdrv_parse_cache_flags(cache, &flags);
2869 2870
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2871
        goto out;
2872 2873
    }

2874 2875 2876 2877
    src_flags = BDRV_O_FLAGS;
    ret = bdrv_parse_cache_flags(src_cache, &src_flags);
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
2878
        goto out;
2879 2880
    }

K
Kevin Wolf 已提交
2881 2882 2883 2884 2885 2886
    /*
     * 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.
     */
2887
    blk = img_open(image_opts, filename, fmt, flags, quiet);
2888
    if (!blk) {
2889 2890
        ret = -1;
        goto out;
2891
    }
2892
    bs = blk_bs(blk);
K
Kevin Wolf 已提交
2893 2894

    if (out_basefmt != NULL) {
2895
        if (bdrv_find_format(out_basefmt) == NULL) {
2896
            error_report("Invalid format name: '%s'", out_basefmt);
2897 2898
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
2899 2900 2901 2902
        }
    }

    /* For safe rebasing we need to compare old and new backing file */
2903
    if (!unsafe) {
2904
        char backing_name[PATH_MAX];
2905 2906 2907 2908 2909 2910
        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 已提交
2911 2912

        bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2913
        blk_old_backing = blk_new_open(backing_name, NULL,
2914 2915
                                       options, src_flags, &local_err);
        if (!blk_old_backing) {
2916 2917 2918
            error_reportf_err(local_err,
                              "Could not open old backing file '%s': ",
                              backing_name);
2919
            goto out;
K
Kevin Wolf 已提交
2920
        }
2921

2922
        if (out_baseimg[0]) {
2923 2924 2925 2926 2927 2928 2929
            if (out_basefmt) {
                options = qdict_new();
                qdict_put(options, "driver", qstring_from_str(out_basefmt));
            } else {
                options = NULL;
            }

2930
            blk_new_backing = blk_new_open(out_baseimg, NULL,
2931 2932
                                           options, src_flags, &local_err);
            if (!blk_new_backing) {
2933 2934 2935
                error_reportf_err(local_err,
                                  "Could not open new backing file '%s': ",
                                  out_baseimg);
2936 2937
                goto out;
            }
K
Kevin Wolf 已提交
2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950
        }
    }

    /*
     * 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) {
2951 2952 2953
        int64_t num_sectors;
        int64_t old_backing_num_sectors;
        int64_t new_backing_num_sectors = 0;
K
Kevin Wolf 已提交
2954
        uint64_t sector;
2955
        int n;
2956
        float local_progress = 0;
2957

2958 2959
        buf_old = blk_blockalign(blk, IO_BUF_SIZE);
        buf_new = blk_blockalign(blk, IO_BUF_SIZE);
K
Kevin Wolf 已提交
2960

2961
        num_sectors = blk_nb_sectors(blk);
2962 2963 2964 2965 2966 2967
        if (num_sectors < 0) {
            error_report("Could not get size of '%s': %s",
                         filename, strerror(-num_sectors));
            ret = -1;
            goto out;
        }
2968
        old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
2969
        if (old_backing_num_sectors < 0) {
2970
            char backing_name[PATH_MAX];
2971 2972 2973 2974 2975 2976 2977

            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;
        }
2978 2979
        if (blk_new_backing) {
            new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
2980 2981 2982 2983 2984 2985
            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;
            }
2986
        }
K
Kevin Wolf 已提交
2987

2988 2989 2990 2991 2992
        if (num_sectors != 0) {
            local_progress = (float)100 /
                (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
        }

K
Kevin Wolf 已提交
2993 2994 2995 2996 2997 2998 2999 3000 3001 3002
        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 */
3003
            ret = bdrv_is_allocated(bs, sector, n, &n);
3004 3005 3006 3007 3008
            if (ret < 0) {
                error_report("error while reading image metadata: %s",
                             strerror(-ret));
                goto out;
            }
3009
            if (ret) {
K
Kevin Wolf 已提交
3010 3011 3012
                continue;
            }

3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023
            /*
             * 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;
                }

3024
                ret = blk_read(blk_old_backing, sector, buf_old, n);
3025 3026 3027 3028
                if (ret < 0) {
                    error_report("error while reading from old backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3029
            }
3030

3031
            if (sector >= new_backing_num_sectors || !blk_new_backing) {
3032 3033 3034 3035 3036 3037
                memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
            } else {
                if (sector + n > new_backing_num_sectors) {
                    n = new_backing_num_sectors - sector;
                }

3038
                ret = blk_read(blk_new_backing, sector, buf_new, n);
3039 3040 3041 3042
                if (ret < 0) {
                    error_report("error while reading from new backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3043 3044 3045 3046 3047 3048 3049 3050 3051
            }

            /* 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,
3052
                    buf_new + written * 512, n - written, &pnum))
K
Kevin Wolf 已提交
3053
                {
3054 3055
                    ret = blk_write(blk, sector + written,
                                    buf_old + written * 512, pnum);
K
Kevin Wolf 已提交
3056
                    if (ret < 0) {
3057
                        error_report("Error while writing to COW image: %s",
K
Kevin Wolf 已提交
3058
                            strerror(-ret));
3059
                        goto out;
K
Kevin Wolf 已提交
3060 3061 3062 3063 3064
                    }
                }

                written += pnum;
            }
3065
            qemu_progress_print(local_progress, 100);
K
Kevin Wolf 已提交
3066 3067 3068 3069 3070 3071 3072 3073
        }
    }

    /*
     * 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.
     */
3074 3075 3076 3077 3078 3079
    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 已提交
3080
    if (ret == -ENOSPC) {
3081 3082
        error_report("Could not change the backing file to '%s': No "
                     "space left in the file header", out_baseimg);
K
Kevin Wolf 已提交
3083
    } else if (ret < 0) {
3084
        error_report("Could not change the backing file to '%s': %s",
K
Kevin Wolf 已提交
3085 3086 3087
            out_baseimg, strerror(-ret));
    }

3088
    qemu_progress_print(100, 0);
K
Kevin Wolf 已提交
3089 3090 3091 3092 3093 3094
    /*
     * 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.
     */
3095
out:
3096
    qemu_progress_end();
K
Kevin Wolf 已提交
3097 3098
    /* Cleanup */
    if (!unsafe) {
M
Markus Armbruster 已提交
3099 3100
        blk_unref(blk_old_backing);
        blk_unref(blk_new_backing);
K
Kevin Wolf 已提交
3101
    }
P
Paolo Bonzini 已提交
3102 3103
    qemu_vfree(buf_old);
    qemu_vfree(buf_new);
K
Kevin Wolf 已提交
3104

M
Markus Armbruster 已提交
3105
    blk_unref(blk);
3106 3107 3108
    if (ret) {
        return 1;
    }
K
Kevin Wolf 已提交
3109 3110 3111
    return 0;
}

3112 3113
static int img_resize(int argc, char **argv)
{
3114
    Error *err = NULL;
3115 3116 3117
    int c, ret, relative;
    const char *filename, *fmt, *size;
    int64_t n, total_size;
3118
    bool quiet = false;
M
Markus Armbruster 已提交
3119
    BlockBackend *blk = NULL;
3120
    QemuOpts *param;
3121 3122
    Error *local_err = NULL;

3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133
    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 */
            }
3134 3135
        },
    };
3136
    bool image_opts = false;
3137

K
Kevin Wolf 已提交
3138 3139 3140
    /* Remove size from argv manually so that negative numbers are not treated
     * as options by getopt. */
    if (argc < 3) {
F
Fam Zheng 已提交
3141
        error_exit("Not enough arguments");
K
Kevin Wolf 已提交
3142 3143 3144 3145 3146 3147
        return 1;
    }

    size = argv[--argc];

    /* Parse getopt arguments */
3148 3149
    fmt = NULL;
    for(;;) {
3150 3151 3152
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3153
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3154 3155 3156 3157
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "f:hq",
                        long_options, NULL);
3158 3159 3160 3161
        if (c == -1) {
            break;
        }
        switch(c) {
J
Jes Sorensen 已提交
3162
        case '?':
3163 3164 3165 3166 3167 3168
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
3169 3170 3171
        case 'q':
            quiet = true;
            break;
3172 3173 3174 3175 3176 3177 3178 3179
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3180 3181 3182
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
3183 3184
        }
    }
3185
    if (optind != argc - 1) {
F
Fam Zheng 已提交
3186
        error_exit("Expecting one image file name");
3187 3188 3189
    }
    filename = argv[optind++];

3190 3191 3192 3193 3194 3195 3196
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
                          NULL, &local_err)) {
        error_report_err(local_err);
        return 1;
    }

3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212
    /* 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 */
3213
    param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3214
    qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3215 3216
    if (err) {
        error_report_err(err);
3217
        ret = -1;
3218
        qemu_opts_del(param);
3219
        goto out;
3220
    }
3221 3222
    n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
    qemu_opts_del(param);
3223

3224
    blk = img_open(image_opts, filename, fmt,
3225
                   BDRV_O_FLAGS | BDRV_O_RDWR, quiet);
3226
    if (!blk) {
3227 3228
        ret = -1;
        goto out;
3229
    }
3230 3231

    if (relative) {
3232
        total_size = blk_getlength(blk) + n * relative;
3233 3234 3235 3236
    } else {
        total_size = n;
    }
    if (total_size <= 0) {
3237
        error_report("New image size must be positive");
3238 3239
        ret = -1;
        goto out;
3240 3241
    }

3242
    ret = blk_truncate(blk, total_size);
3243 3244
    switch (ret) {
    case 0:
3245
        qprintf(quiet, "Image resized.\n");
3246 3247
        break;
    case -ENOTSUP:
3248
        error_report("This image does not support resize");
3249 3250
        break;
    case -EACCES:
3251
        error_report("Image is read-only");
3252 3253
        break;
    default:
3254
        error_report("Error resizing image (%d)", -ret);
3255 3256
        break;
    }
3257
out:
M
Markus Armbruster 已提交
3258
    blk_unref(blk);
3259 3260 3261
    if (ret) {
        return 1;
    }
3262 3263 3264
    return 0;
}

3265
static void amend_status_cb(BlockDriverState *bs,
3266 3267
                            int64_t offset, int64_t total_work_size,
                            void *opaque)
3268 3269 3270 3271
{
    qemu_progress_print(100.f * offset / total_work_size, 0);
}

M
Max Reitz 已提交
3272 3273
static int img_amend(int argc, char **argv)
{
3274
    Error *err = NULL;
M
Max Reitz 已提交
3275 3276
    int c, ret = 0;
    char *options = NULL;
3277 3278
    QemuOptsList *create_opts = NULL;
    QemuOpts *opts = NULL;
3279 3280
    const char *fmt = NULL, *filename, *cache;
    int flags;
3281
    bool quiet = false, progress = false;
M
Markus Armbruster 已提交
3282
    BlockBackend *blk = NULL;
M
Max Reitz 已提交
3283
    BlockDriverState *bs = NULL;
3284
    Error *local_err = NULL;
3285
    bool image_opts = false;
M
Max Reitz 已提交
3286

3287
    cache = BDRV_DEFAULT_CACHE;
M
Max Reitz 已提交
3288
    for (;;) {
3289 3290 3291
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3292
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3293 3294 3295 3296
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "ho:f:t:pq",
                        long_options, NULL);
M
Max Reitz 已提交
3297 3298 3299 3300 3301 3302 3303 3304 3305 3306
        if (c == -1) {
            break;
        }

        switch (c) {
            case 'h':
            case '?':
                help();
                break;
            case 'o':
3307 3308 3309
                if (!is_valid_option_list(optarg)) {
                    error_report("Invalid option list: %s", optarg);
                    ret = -1;
3310
                    goto out_no_progress;
3311 3312 3313 3314 3315 3316 3317 3318
                }
                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 已提交
3319 3320 3321 3322
                break;
            case 'f':
                fmt = optarg;
                break;
3323 3324 3325
            case 't':
                cache = optarg;
                break;
3326 3327 3328
            case 'p':
                progress = true;
                break;
M
Max Reitz 已提交
3329 3330 3331
            case 'q':
                quiet = true;
                break;
3332 3333 3334 3335 3336 3337 3338 3339
            case OPTION_OBJECT:
                opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                               optarg, true);
                if (!opts) {
                    ret = -1;
                    goto out_no_progress;
                }
                break;
3340 3341 3342
            case OPTION_IMAGE_OPTS:
                image_opts = true;
                break;
M
Max Reitz 已提交
3343 3344 3345
        }
    }

3346
    if (!options) {
F
Fam Zheng 已提交
3347
        error_exit("Must specify options (-o)");
M
Max Reitz 已提交
3348 3349
    }

3350 3351 3352 3353 3354 3355 3356 3357
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
                          NULL, &local_err)) {
        error_report_err(local_err);
        ret = -1;
        goto out_no_progress;
    }

3358 3359 3360 3361 3362
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);

3363 3364 3365 3366 3367 3368
    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 已提交
3369 3370
    }

3371
    if (optind != argc - 1) {
M
Max Reitz 已提交
3372 3373 3374
        error_report("Expecting one image file name");
        ret = -1;
        goto out;
3375
    }
M
Max Reitz 已提交
3376

3377 3378 3379 3380 3381 3382 3383
    flags = BDRV_O_FLAGS | BDRV_O_RDWR;
    ret = bdrv_parse_cache_flags(cache, &flags);
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        goto out;
    }

3384
    blk = img_open(image_opts, filename, fmt, flags, quiet);
3385
    if (!blk) {
M
Max Reitz 已提交
3386 3387 3388
        ret = -1;
        goto out;
    }
3389
    bs = blk_bs(blk);
M
Max Reitz 已提交
3390 3391 3392

    fmt = bs->drv->format_name;

3393
    if (has_help_option(options)) {
3394
        /* If the format was auto-detected, print option help here */
M
Max Reitz 已提交
3395 3396 3397 3398
        ret = print_block_option_help(filename, fmt);
        goto out;
    }

3399 3400 3401 3402 3403 3404 3405
    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 已提交
3406
    create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3407
    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
3408 3409 3410
    if (options) {
        qemu_opts_do_parse(opts, options, NULL, &err);
        if (err) {
3411
            error_report_err(err);
3412 3413 3414
            ret = -1;
            goto out;
        }
M
Max Reitz 已提交
3415 3416
    }

3417 3418
    /* In case the driver does not call amend_status_cb() */
    qemu_progress_print(0.f, 0);
3419
    ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
3420
    qemu_progress_print(100.f, 0);
M
Max Reitz 已提交
3421 3422 3423 3424 3425 3426
    if (ret < 0) {
        error_report("Error while amending options: %s", strerror(-ret));
        goto out;
    }

out:
3427 3428
    qemu_progress_end();

3429
out_no_progress:
M
Markus Armbruster 已提交
3430
    blk_unref(blk);
3431 3432
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
3433 3434
    g_free(options);

M
Max Reitz 已提交
3435 3436 3437 3438 3439 3440
    if (ret) {
        return 1;
    }
    return 0;
}

A
Anthony Liguori 已提交
3441
static const img_cmd_t img_cmds[] = {
3442 3443 3444 3445 3446 3447 3448 3449
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
    { NULL, NULL, },
};

B
bellard 已提交
3450 3451
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
3452
    const img_cmd_t *cmd;
3453
    const char *cmdname;
3454
    Error *local_error = NULL;
3455 3456 3457
    int c;
    static const struct option long_options[] = {
        {"help", no_argument, 0, 'h'},
3458
        {"version", no_argument, 0, 'v'},
3459 3460
        {0, 0, 0, 0}
    };
B
bellard 已提交
3461

3462 3463 3464 3465
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

K
Kevin Wolf 已提交
3466
    error_set_progname(argv[0]);
3467
    qemu_init_exec_dir(argv[0]);
K
Kevin Wolf 已提交
3468

3469
    if (qemu_init_main_loop(&local_error)) {
3470
        error_report_err(local_error);
3471 3472 3473
        exit(EXIT_FAILURE);
    }

3474
    module_call_init(MODULE_INIT_QOM);
B
bellard 已提交
3475
    bdrv_init();
F
Fam Zheng 已提交
3476 3477 3478
    if (argc < 2) {
        error_exit("Not enough arguments");
    }
3479 3480
    cmdname = argv[1];

3481
    qemu_add_opts(&qemu_object_opts);
3482
    qemu_add_opts(&qemu_source_opts);
3483

3484
    /* find the command */
3485
    for (cmd = img_cmds; cmd->name != NULL; cmd++) {
3486
        if (!strcmp(cmdname, cmd->name)) {
3487
            return cmd->handler(argc - 1, argv + 1);
3488
        }
B
bellard 已提交
3489
    }
3490

3491
    c = getopt_long(argc, argv, "h", long_options, NULL);
3492 3493 3494 3495

    if (c == 'h') {
        help();
    }
3496 3497 3498 3499
    if (c == 'v') {
        printf(QEMU_IMG_VERSION);
        return 0;
    }
3500

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