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

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

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

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

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

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

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

F
Fam Zheng 已提交
71 72 73 74 75 76 77 78 79 80 81 82 83 84
static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
{
    va_list ap;

    error_printf("qemu-img: ");

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

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

B
blueswir1 已提交
85
/* Please keep in synch with qemu-img.texi */
F
Fam Zheng 已提交
86
static void QEMU_NORETURN help(void)
B
bellard 已提交
87
{
88
    const char *help_msg =
89
           QEMU_IMG_VERSION
90 91 92 93
           "usage: qemu-img command [command options]\n"
           "QEMU disk image utility\n"
           "\n"
           "Command syntax:\n"
94 95 96 97 98
#define DEF(option, callback, arg_string)        \
           "  " arg_string "\n"
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
99 100 101
           "\n"
           "Command parameters:\n"
           "  'filename' is a disk image filename\n"
102 103 104 105
           "  'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
           "    manual page for a description of the object properties. The most common\n"
           "    object type is a 'secret', which is used to supply passwords and/or\n"
           "    encryption keys.\n"
106
           "  'fmt' is the disk image format. It is guessed automatically in most cases\n"
107
           "  'cache' is the cache mode used to write the output disk image, the valid\n"
108 109
           "    options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
           "    'directsync' and 'unsafe' (default for convert)\n"
110 111
           "  'src_cache' is the cache mode used to read input disk images, the valid\n"
           "    options are the same as for the 'cache' option\n"
112
           "  'size' is the disk image size in bytes. Optional suffixes\n"
113 114 115
           "    'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
           "    'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P)  are\n"
           "    supported. 'b' is ignored.\n"
116 117 118 119 120
           "  'output_filename' is the destination disk image filename\n"
           "  'output_fmt' is the destination format\n"
           "  'options' is a comma separated list of format specific options in a\n"
           "    name=value format. Use -o ? for an overview of the options supported by the\n"
           "    used format\n"
121 122 123 124 125
           "  'snapshot_param' is param used for internal snapshot, format\n"
           "    is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
           "    '[ID_OR_NAME]'\n"
           "  'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
           "    instead\n"
126 127 128 129 130
           "  '-c' indicates that target image must be compressed (qcow format only)\n"
           "  '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
           "       match exactly. The image doesn't need a working backing file before\n"
           "       rebasing in this case (useful for renaming the backing file)\n"
           "  '-h' with or without a command shows this help and lists the supported formats\n"
131
           "  '-p' show progress of command (only certain commands)\n"
132
           "  '-q' use Quiet mode - do not print any output (except errors)\n"
133 134 135 136 137
           "  '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
           "       contain only zeros for qemu-img to create a sparse image during\n"
           "       conversion. If the number of bytes is 0, the source will not be scanned for\n"
           "       unallocated or zero sectors, and the destination image will always be\n"
           "       fully allocated\n"
138
           "  '--output' takes the format in which the output must be done (human or json)\n"
139 140
           "  '-n' skips the target volume creation (useful if the volume is created\n"
           "       prior to running qemu-img)\n"
141
           "\n"
142 143 144 145
           "Parameters to check subcommand:\n"
           "  '-r' tries to repair any inconsistencies that are found during the check.\n"
           "       '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
           "       kinds of errors, with a higher risk of choosing the wrong fix or\n"
146
           "       hiding corruption that has already occurred.\n"
147
           "\n"
148 149 150 151 152
           "Parameters to snapshot subcommand:\n"
           "  'snapshot' is the name of the snapshot to create, apply or delete\n"
           "  '-a' applies a snapshot (revert disk to saved state)\n"
           "  '-c' creates a snapshot\n"
           "  '-d' deletes a snapshot\n"
153 154 155 156 157 158
           "  '-l' lists all snapshots in the given image\n"
           "\n"
           "Parameters to compare subcommand:\n"
           "  '-f' first image format\n"
           "  '-F' second image format\n"
           "  '-s' run in Strict mode - fail on different image size or sector allocation\n";
159 160

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

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

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

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

B
bellard 已提交
196

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

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

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

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

226 227

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

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


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

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

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

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

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

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


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

321

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    return 0;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    block_job_complete_sync(job, errp);
785 786 787 788

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

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

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

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

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

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

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

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

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

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

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

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

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

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

done:
945 946
    qemu_progress_end();

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

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

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

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

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
974
    is_zero = buffer_is_zero(buf, 512);
B
bellard 已提交
975 976
    for(i = 1; i < n; i++) {
        buf += 512;
977
        if (is_zero != buffer_is_zero(buf, 512)) {
B
bellard 已提交
978
            break;
979
        }
B
bellard 已提交
980 981
    }
    *pnum = i;
982
    return !is_zero;
B
bellard 已提交
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 1026
/*
 * 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 已提交
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
/*
 * 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)
{
1037 1038
    bool res;
    int i;
K
Kevin Wolf 已提交
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

1893 1894
    qemu_progress_print(0, 100);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

B
bellard 已提交
2128

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        depth++;
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    size = argv[--argc];

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    fmt = bs->drv->format_name;

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

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

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

out:
3426 3427
    qemu_progress_end();

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

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

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

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

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

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

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

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

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

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

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

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

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