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

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

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

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

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

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

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

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

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

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

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

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

B
bellard 已提交
195

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

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

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

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

225 226 227

static int img_open_password(BlockBackend *blk, const char *filename,
                             bool require_io, bool quiet)
228 229 230
{
    BlockDriverState *bs;
    char password[256];
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247

    bs = blk_bs(blk);
    if (bdrv_is_encrypted(bs) && require_io) {
        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;
}


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

    if (img_open_password(blk, optstr, require_io, quiet) < 0) {
        blk_unref(blk);
        return NULL;
    }
    return blk;
}

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

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

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

288 289 290 291 292 293 294 295
    if (img_open_password(blk, filename, require_io, quiet) < 0) {
        blk_unref(blk);
        return NULL;
    }
    return blk;
}


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

320

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

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

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

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

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

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

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

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

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

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

fail:
    g_free(options);
    return 1;
B
bellard 已提交
475 476
}

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

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

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

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

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

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

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

    return 0;
}

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

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

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

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

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

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

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
695 696

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

702 703
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
704

705 706
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
707

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

718
        ret = collect_image_check(bs, check, filename, fmt, 0);
719

720 721
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
722 723
    }

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

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

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

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

M
Max Reitz 已提交
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
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);
779 780
        qemu_progress_print(job->len ?
                            ((float)job->offset / job->len * 100.f) : 0.0f, 0);
M
Max Reitz 已提交
781 782 783
    } while (!job->ready);

    block_job_complete_sync(job, errp);
784 785 786 787

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

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

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

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

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

865 866 867 868 869 870 871
    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 已提交
872
    flags = BDRV_O_RDWR | BDRV_O_UNMAP;
873
    ret = bdrv_parse_cache_flags(cache, &flags);
874 875
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
876
        return 1;
877 878
    }

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

885 886 887
    qemu_progress_init(progress, 1.f);
    qemu_progress_print(0.f, 100);

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

    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 已提交
914 915
    }

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

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

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

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

done:
944 945
    qemu_progress_end();

M
Markus Armbruster 已提交
946
    blk_unref(blk);
M
Max Reitz 已提交
947 948

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

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

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

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

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

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

1058
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
1059

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

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

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


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

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

1202 1203 1204
    /* Initialize before goto out */
    qemu_progress_init(progress, 2.0);

1205 1206 1207 1208 1209 1210 1211 1212
    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;
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

1885 1886 1887 1888 1889 1890 1891
    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;
    }

1892 1893
    qemu_progress_print(0, 100);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

B
bellard 已提交
2127

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2377
    qapi_free_ImageInfoList(list);
B
bellard 已提交
2378 2379 2380
    return 0;
}

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

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

        depth++;
    }

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

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

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

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

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

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

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

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

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

2615 2616 2617 2618 2619
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

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

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

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

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

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

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

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

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

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

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

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

2843 2844 2845 2846
    if (quiet) {
        progress = 0;
    }

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

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

2862 2863 2864
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

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

2872 2873 2874 2875
    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);
2876
        goto out;
2877 2878
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    size = argv[--argc];

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

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

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

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

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

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

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

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

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

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

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

3348 3349 3350 3351 3352 3353 3354 3355
    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;
    }

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

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

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

3375 3376 3377 3378 3379 3380 3381
    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;
    }

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

    fmt = bs->drv->format_name;

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

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

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

out:
3425 3426
    qemu_progress_end();

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

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

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

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

3460 3461 3462 3463
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

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

3467
    if (qemu_init_main_loop(&local_error)) {
3468
        error_report_err(local_error);
3469 3470 3471
        exit(EXIT_FAILURE);
    }

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

3479
    qemu_add_opts(&qemu_object_opts);
3480
    qemu_add_opts(&qemu_source_opts);
3481

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

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

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

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