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

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

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

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

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

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

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

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

    printf("%s\nSupported formats:", help_msg);
172
    bdrv_iterate_format(format_print, NULL);
B
bellard 已提交
173
    printf("\n");
F
Fam Zheng 已提交
174
    exit(EXIT_SUCCESS);
B
bellard 已提交
175 176
}

177 178 179 180 181 182 183 184 185
static QemuOptsList qemu_object_opts = {
    .name = "object",
    .implied_opt_name = "qom-type",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
    .desc = {
        { }
    },
};

186 187 188 189 190 191 192 193 194
static QemuOptsList qemu_source_opts = {
    .name = "source",
    .implied_opt_name = "file",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
    .desc = {
        { }
    },
};

S
Stefan Weil 已提交
195
static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
196 197 198 199 200 201 202 203 204 205 206
{
    int ret = 0;
    if (!quiet) {
        va_list args;
        va_start(args, fmt);
        ret = vprintf(fmt, args);
        va_end(args);
    }
    return ret;
}

B
bellard 已提交
207

208 209 210
static int print_block_option_help(const char *filename, const char *fmt)
{
    BlockDriver *drv, *proto_drv;
211
    QemuOptsList *create_opts = NULL;
212
    Error *local_err = NULL;
213 214 215 216

    /* Find driver and parse its options */
    drv = bdrv_find_format(fmt);
    if (!drv) {
217
        error_report("Unknown file format '%s'", fmt);
218 219 220
        return 1;
    }

C
Chunyan Liu 已提交
221
    create_opts = qemu_opts_append(create_opts, drv->create_opts);
222
    if (filename) {
223
        proto_drv = bdrv_find_protocol(filename, true, &local_err);
224
        if (!proto_drv) {
225
            error_report_err(local_err);
226
            qemu_opts_free(create_opts);
227 228
            return 1;
        }
C
Chunyan Liu 已提交
229
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
230 231
    }

232 233
    qemu_opts_print_help(create_opts);
    qemu_opts_free(create_opts);
234 235 236
    return 0;
}

237 238

static int img_open_password(BlockBackend *blk, const char *filename,
239
                             int flags, bool quiet)
240 241 242
{
    BlockDriverState *bs;
    char password[256];
243 244

    bs = blk_bs(blk);
245 246
    if (bdrv_is_encrypted(bs) && bdrv_key_required(bs) &&
        !(flags & BDRV_O_NO_IO)) {
247 248 249 250 251 252 253 254 255 256 257 258 259 260
        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;
}


261
static BlockBackend *img_open_opts(const char *optstr,
262
                                   QemuOpts *opts, int flags, bool writethrough,
263
                                   bool quiet)
264 265 266 267 268
{
    QDict *options;
    Error *local_err = NULL;
    BlockBackend *blk;
    options = qemu_opts_to_qdict(opts, NULL);
269
    blk = blk_new_open(NULL, NULL, options, flags, &local_err);
270
    if (!blk) {
271
        error_reportf_err(local_err, "Could not open '%s': ", optstr);
272 273
        return NULL;
    }
274
    blk_set_enable_write_cache(blk, !writethrough);
275

276
    if (img_open_password(blk, optstr, flags, quiet) < 0) {
277 278 279 280 281 282
        blk_unref(blk);
        return NULL;
    }
    return blk;
}

283
static BlockBackend *img_open_file(const char *filename,
284
                                   const char *fmt, int flags,
285
                                   bool writethrough, bool quiet)
286 287
{
    BlockBackend *blk;
288
    Error *local_err = NULL;
289
    QDict *options = NULL;
290

291
    if (fmt) {
292 293
        options = qdict_new();
        qdict_put(options, "driver", qstring_from_str(fmt));
294
    }
295

296
    blk = blk_new_open(filename, NULL, options, flags, &local_err);
297
    if (!blk) {
298
        error_reportf_err(local_err, "Could not open '%s': ", filename);
299
        return NULL;
300
    }
301
    blk_set_enable_write_cache(blk, !writethrough);
302

303
    if (img_open_password(blk, filename, flags, quiet) < 0) {
304 305 306 307 308 309 310
        blk_unref(blk);
        return NULL;
    }
    return blk;
}


311
static BlockBackend *img_open(bool image_opts,
312
                              const char *filename,
313
                              const char *fmt, int flags, bool writethrough,
314
                              bool quiet)
315 316 317 318 319 320 321 322 323 324 325 326 327
{
    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;
        }
328
        blk = img_open_opts(filename, opts, flags, writethrough, quiet);
329
    } else {
330
        blk = img_open_file(filename, fmt, flags, writethrough, quiet);
331
    }
332
    return blk;
333 334
}

335

336
static int add_old_style_options(const char *fmt, QemuOpts *opts,
337 338
                                 const char *base_filename,
                                 const char *base_fmt)
339
{
340 341
    Error *err = NULL;

342
    if (base_filename) {
343
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
344
        if (err) {
345 346
            error_report("Backing file not supported for file format '%s'",
                         fmt);
347
            error_free(err);
348
            return -1;
349 350 351
        }
    }
    if (base_fmt) {
352
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
353
        if (err) {
354 355
            error_report("Backing file format not supported for file "
                         "format '%s'", fmt);
356
            error_free(err);
357
            return -1;
358 359
        }
    }
360
    return 0;
361 362
}

B
bellard 已提交
363 364
static int img_create(int argc, char **argv)
{
365
    int c;
366
    uint64_t img_size = -1;
B
bellard 已提交
367
    const char *fmt = "raw";
368
    const char *base_fmt = NULL;
B
bellard 已提交
369 370
    const char *filename;
    const char *base_filename = NULL;
371
    char *options = NULL;
372
    Error *local_err = NULL;
373
    bool quiet = false;
374

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

435
    /* Get the filename */
436 437 438 439 440 441
    filename = (optind < argc) ? argv[optind] : NULL;
    if (options && has_help_option(options)) {
        g_free(options);
        return print_block_option_help(filename, fmt);
    }

442
    if (optind >= argc) {
F
Fam Zheng 已提交
443
        error_exit("Expecting image file name");
444
    }
445
    optind++;
446

447 448
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
449
                          NULL, NULL)) {
450 451 452
        goto fail;
    }

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

476
    bdrv_img_create(filename, fmt, base_filename, base_fmt,
K
Kevin Wolf 已提交
477
                    options, img_size, 0, &local_err, quiet);
478
    if (local_err) {
479
        error_reportf_err(local_err, "%s: ", filename);
480
        goto fail;
481
    }
482

483
    g_free(options);
B
bellard 已提交
484
    return 0;
485 486 487 488

fail:
    g_free(options);
    return 1;
B
bellard 已提交
489 490
}

491
static void dump_json_image_check(ImageCheck *check, bool quiet)
492 493 494
{
    QString *str;
    QObject *obj;
495 496 497 498
    Visitor *v = qmp_output_visitor_new(&obj);

    visit_type_ImageCheck(v, NULL, &check, &error_abort);
    visit_complete(v, &obj);
499 500
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
501
    qprintf(quiet, "%s\n", qstring_get_str(str));
502
    qobject_decref(obj);
503
    visit_free(v);
504 505 506
    QDECREF(str);
}

507
static void dump_human_image_check(ImageCheck *check, bool quiet)
508 509
{
    if (!(check->corruptions || check->leaks || check->check_errors)) {
510
        qprintf(quiet, "No errors were found on the image.\n");
511 512
    } else {
        if (check->corruptions) {
513 514 515 516
            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);
517 518 519
        }

        if (check->leaks) {
520 521 522 523
            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);
524 525 526
        }

        if (check->check_errors) {
527 528 529 530
            qprintf(quiet,
                    "\n%" PRId64
                    " internal errors have occurred during the check.\n",
                    check->check_errors);
531 532 533 534
        }
    }

    if (check->total_clusters != 0 && check->allocated_clusters != 0) {
535 536 537 538 539 540 541
        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);
542 543 544
    }

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

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;
583 584
    check->compressed_clusters      = result.bfi.compressed_clusters;
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
585 586 587 588

    return 0;
}

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

    fmt = NULL;
613
    output = NULL;
614
    cache = BDRV_DEFAULT_CACHE;
615

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

679 680 681 682 683 684 685 686 687
    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;
    }

688 689
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
690
                          NULL, NULL)) {
691 692 693
        return 1;
    }

694
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
695 696 697 698 699
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        return 1;
    }

700
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
701 702
    if (!blk) {
        return 1;
703
    }
704
    bs = blk_bs(blk);
705 706 707

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
708 709

    if (ret == -ENOTSUP) {
710
        error_report("This image format does not support checks");
711
        ret = 63;
712
        goto fail;
713 714
    }

715 716
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
717

718 719
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
720

721
        if (output_format == OFORMAT_HUMAN) {
722 723 724 725 726 727 728
            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);
729 730
        }

731
        ret = collect_image_check(bs, check, filename, fmt, 0);
732

733 734
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
735 736
    }

M
Max Reitz 已提交
737 738 739 740 741 742 743 744 745
    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;
        }
746 747
    }

748
    if (ret || check->check_errors) {
M
Max Reitz 已提交
749 750 751 752 753
        if (ret) {
            error_report("Check failed: %s", strerror(-ret));
        } else {
            error_report("Check failed");
        }
754 755
        ret = 1;
        goto fail;
756
    }
757

758 759 760 761
    if (check->corruptions) {
        ret = 2;
    } else if (check->leaks) {
        ret = 3;
762
    } else {
763
        ret = 0;
764
    }
765 766 767

fail:
    qapi_free_ImageCheck(check);
M
Markus Armbruster 已提交
768
    blk_unref(blk);
769
    return ret;
770 771
}

M
Max Reitz 已提交
772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
typedef struct CommonBlockJobCBInfo {
    BlockDriverState *bs;
    Error **errp;
} CommonBlockJobCBInfo;

static void common_block_job_cb(void *opaque, int ret)
{
    CommonBlockJobCBInfo *cbi = opaque;

    if (ret < 0) {
        error_setg_errno(cbi->errp, -ret, "Block job failed");
    }
}

static void run_block_job(BlockJob *job, Error **errp)
{
K
Kevin Wolf 已提交
788
    AioContext *aio_context = blk_get_aio_context(job->blk);
M
Max Reitz 已提交
789 790 791

    do {
        aio_poll(aio_context, true);
792 793
        qemu_progress_print(job->len ?
                            ((float)job->offset / job->len * 100.f) : 0.0f, 0);
M
Max Reitz 已提交
794 795 796
    } while (!job->ready);

    block_job_complete_sync(job, errp);
797 798 799 800

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

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

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

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

874
    if (optind != argc - 1) {
F
Fam Zheng 已提交
875
        error_exit("Expecting one image file name");
876
    }
B
bellard 已提交
877 878
    filename = argv[optind++];

879 880
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
881
                          NULL, NULL)) {
882 883 884
        return 1;
    }

M
Max Reitz 已提交
885
    flags = BDRV_O_RDWR | BDRV_O_UNMAP;
886
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
887 888
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
889
        return 1;
890 891
    }

892
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
893 894
    if (!blk) {
        return 1;
895
    }
896 897
    bs = blk_bs(blk);

898 899 900
    qemu_progress_init(progress, 1.f);
    qemu_progress_print(0.f, 100);

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

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

923
    commit_active_start("commit", bs, base_bs, 0, BLOCKDEV_ON_ERROR_REPORT,
M
Max Reitz 已提交
924 925 926
                        common_block_job_cb, &cbi, &local_err);
    if (local_err) {
        goto done;
B
bellard 已提交
927 928
    }

929 930 931 932
    /* 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 已提交
933
    if (!drop) {
934
        bdrv_ref(bs);
M
Max Reitz 已提交
935 936
    }

M
Max Reitz 已提交
937
    run_block_job(bs->job, &local_err);
M
Max Reitz 已提交
938 939 940 941
    if (local_err) {
        goto unref_backing;
    }

942 943
    if (!drop && bs->drv->bdrv_make_empty) {
        ret = bs->drv->bdrv_make_empty(bs);
M
Max Reitz 已提交
944 945 946 947 948 949 950 951 952
        if (ret) {
            error_setg_errno(&local_err, -ret, "Could not empty %s",
                             filename);
            goto unref_backing;
        }
    }

unref_backing:
    if (!drop) {
953
        bdrv_unref(bs);
M
Max Reitz 已提交
954
    }
M
Max Reitz 已提交
955 956

done:
957 958
    qemu_progress_end();

M
Markus Armbruster 已提交
959
    blk_unref(blk);
M
Max Reitz 已提交
960 961

    if (local_err) {
962
        error_report_err(local_err);
963 964
        return 1;
    }
M
Max Reitz 已提交
965 966

    qprintf(quiet, "Image committed.\n");
B
bellard 已提交
967 968 969
    return 0;
}

970 971 972 973 974 975 976
/*
 * 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 已提交
977 978
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
{
979 980
    bool is_zero;
    int i;
B
bellard 已提交
981 982 983 984 985

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
986
    is_zero = buffer_is_zero(buf, 512);
B
bellard 已提交
987 988
    for(i = 1; i < n; i++) {
        buf += 512;
989
        if (is_zero != buffer_is_zero(buf, 512)) {
B
bellard 已提交
990
            break;
991
        }
B
bellard 已提交
992 993
    }
    *pnum = i;
994
    return !is_zero;
B
bellard 已提交
995 996
}

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

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

1071
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
1072

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

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

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


1202
    if (optind != argc - 2) {
F
Fam Zheng 已提交
1203
        error_exit("Expecting two image file names");
1204 1205 1206 1207
    }
    filename1 = argv[optind++];
    filename2 = argv[optind++];

1208 1209
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
1210
                          NULL, NULL)) {
1211 1212 1213 1214
        ret = 2;
        goto out4;
    }

1215 1216 1217
    /* Initialize before goto out */
    qemu_progress_init(progress, 2.0);

1218 1219
    flags = 0;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1220 1221 1222 1223 1224 1225
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        ret = 2;
        goto out3;
    }

1226
    blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet);
1227
    if (!blk1) {
1228
        ret = 2;
1229
        goto out3;
1230 1231
    }

1232
    blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet);
1233
    if (!blk2) {
1234
        ret = 2;
1235
        goto out2;
1236
    }
1237
    bs1 = blk_bs(blk1);
1238
    bs2 = blk_bs(blk2);
1239

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

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

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

1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
        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) {
1314
            if (allocated1) {
1315 1316
                ret = blk_pread(blk1, sector_num << BDRV_SECTOR_BITS, buf1,
                                nb_sectors << BDRV_SECTOR_BITS);
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), filename1,
                                 strerror(-ret));
                    ret = 4;
                    goto out;
                }
1324 1325
                ret = blk_pread(blk2, sector_num << BDRV_SECTOR_BITS, buf2,
                                nb_sectors << BDRV_SECTOR_BITS);
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337
                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));
1338
                    ret = 1;
1339 1340 1341 1342 1343 1344
                    goto out;
                }
            }
        } else {

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

    if (total_sectors1 != total_sectors2) {
1365
        BlockBackend *blk_over;
1366 1367 1368 1369 1370 1371
        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;
1372
            blk_over = blk1;
1373 1374 1375
            filename_over = filename1;
        } else {
            total_sectors_over = total_sectors2;
1376
            blk_over = blk2;
1377 1378 1379 1380 1381 1382 1383 1384
            filename_over = filename2;
        }

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

1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472
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) {
1473
        BlockDriverState *file;
1474 1475
        ret = bdrv_get_block_status(blk_bs(s->src[s->src_cur]),
                                    sector_num - s->src_cur_offset,
1476
                                    n, &n, &file);
1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487
        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. */
1488
            /* Check block status of the backing file chain to avoid
1489 1490
             * needlessly reading zeroes and limiting the iteration to the
             * buffer size */
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502
            ret = bdrv_get_block_status_above(blk_bs(s->src[s->src_cur]), NULL,
                                              sector_num - s->src_cur_offset,
                                              n, &n, &file);
            if (ret < 0) {
                return ret;
            }

            if (ret & BDRV_BLOCK_ZERO) {
                s->status = BLK_ZERO;
            } else {
                s->status = BLK_DATA;
            }
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
        } else {
            s->status = BLK_BACKING_FILE;
        }

        s->sector_next_status = sector_num + n;
    }

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

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

    return n;
}

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

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

        /* In the case of compression with multiple source files, we can get a
         * nb_sectors that spreads into the next part. So we must be able to
         * read across multiple BDSes for one convert_read() call. */
        convert_select_part(s, sector_num);
        blk = s->src[s->src_cur];
        bs_sectors = s->src_sectors[s->src_cur];

        n = MIN(nb_sectors, bs_sectors - (sector_num - s->src_cur_offset));
1549 1550 1551
        ret = blk_pread(blk,
                        (sector_num - s->src_cur_offset) << BDRV_SECTOR_BITS,
                        buf, n << BDRV_SECTOR_BITS);
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
        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;
                }

1593 1594 1595
                ret = blk_pwrite_compressed(s->target,
                                            sector_num << BDRV_SECTOR_BITS,
                                            buf, n << BDRV_SECTOR_BITS);
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607
                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))
            {
1608 1609
                ret = blk_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
                                 buf, n << BDRV_SECTOR_BITS, 0);
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620
                if (ret < 0) {
                    return ret;
                }
                break;
            }
            /* fall-through */

        case BLK_ZERO:
            if (s->has_zero_init) {
                break;
            }
E
Eric Blake 已提交
1621 1622
            ret = blk_pwrite_zeroes(s->target, sector_num << BDRV_SECTOR_BITS,
                                    n << BDRV_SECTOR_BITS, 0);
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
            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)))
    {
1652
        ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP);
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
        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;
        }
1679 1680
        if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
        {
1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
            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;
        }
1700 1701
        if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
        {
1702 1703 1704 1705 1706
            allocated_done += n;
            qemu_progress_print(100.0 * allocated_done / s->allocated_sectors,
                                0);
        }

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

        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 */
1732
        ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743
        if (ret < 0) {
            goto fail;
        }
    }

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

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

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

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

1889 1890
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
1891
                          NULL, NULL)) {
1892 1893 1894
        goto fail_getopt;
    }

1895
    /* Initialize before goto out */
1896 1897 1898
    if (quiet) {
        progress = 0;
    }
1899 1900
    qemu_progress_init(progress, 1.0);

1901
    bs_n = argc - optind - 1;
1902
    out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
1903

1904
    if (options && has_help_option(options)) {
1905 1906 1907 1908
        ret = print_block_option_help(out_filename, out_fmt);
        goto out;
    }

1909
    if (bs_n < 1) {
F
Fam Zheng 已提交
1910
        error_exit("Must specify image file name");
1911 1912 1913
    }


1914
    if (bs_n > 1 && out_baseimg) {
1915 1916
        error_report("-B makes no sense when concatenating multiple input "
                     "images");
1917 1918
        ret = -1;
        goto out;
1919
    }
1920

1921 1922
    src_flags = 0;
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
1923 1924 1925 1926 1927
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
        goto out;
    }

1928 1929
    qemu_progress_print(0, 100);

M
Markus Armbruster 已提交
1930
    blk = g_new0(BlockBackend *, bs_n);
1931
    bs = g_new0(BlockDriverState *, bs_n);
1932
    bs_sectors = g_new(int64_t, bs_n);
1933 1934 1935

    total_sectors = 0;
    for (bs_i = 0; bs_i < bs_n; bs_i++) {
1936
        blk[bs_i] = img_open(image_opts, argv[optind + bs_i],
1937
                             fmt, src_flags, src_writethrough, quiet);
1938
        if (!blk[bs_i]) {
1939 1940 1941
            ret = -1;
            goto out;
        }
1942
        bs[bs_i] = blk_bs(blk[bs_i]);
1943
        bs_sectors[bs_i] = blk_nb_sectors(blk[bs_i]);
1944 1945 1946 1947 1948 1949
        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;
        }
1950
        total_sectors += bs_sectors[bs_i];
1951
    }
B
bellard 已提交
1952

1953 1954 1955 1956 1957 1958
    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 已提交
1959
        if (bs_n > 1) {
1960
            error_report("No support for concatenating multiple snapshot");
E
edison 已提交
1961 1962 1963
            ret = -1;
            goto out;
        }
1964 1965

        bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1966
    }
1967
    if (local_err) {
1968
        error_reportf_err(local_err, "Failed to load snapshot: ");
1969 1970
        ret = -1;
        goto out;
E
edison 已提交
1971 1972
    }

1973
    /* Find driver and parse its options */
B
bellard 已提交
1974
    drv = bdrv_find_format(out_fmt);
1975
    if (!drv) {
1976
        error_report("Unknown file format '%s'", out_fmt);
1977 1978 1979
        ret = -1;
        goto out;
    }
1980

1981
    proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
1982
    if (!proto_drv) {
1983
        error_report_err(local_err);
1984 1985 1986
        ret = -1;
        goto out;
    }
1987

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

M
Max Reitz 已提交
1996 1997 1998 1999 2000 2001
        if (!proto_drv->create_opts) {
            error_report("Protocol driver '%s' does not support image creation",
                         proto_drv->format_name);
            ret = -1;
            goto out;
        }
2002

M
Max Reitz 已提交
2003 2004
        create_opts = qemu_opts_append(create_opts, drv->create_opts);
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2005

M
Max Reitz 已提交
2006
        opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2007 2008 2009
        if (options) {
            qemu_opts_do_parse(opts, options, NULL, &local_err);
            if (local_err) {
2010
                error_report_err(local_err);
2011 2012 2013
                ret = -1;
                goto out;
            }
M
Max Reitz 已提交
2014
        }
2015

2016 2017
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512,
                            &error_abort);
M
Max Reitz 已提交
2018 2019 2020 2021
        ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
        if (ret < 0) {
            goto out;
        }
2022
    }
2023

2024
    /* Get backing file name if -o backing_file was used */
2025
    out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2026
    if (out_baseimg_param) {
2027
        out_baseimg = out_baseimg_param;
2028 2029
    }

2030
    /* Check if compression is supported */
2031
    if (compress) {
2032 2033 2034 2035
        bool encryption =
            qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
        const char *preallocation =
            qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2036

2037
        if (!drv->bdrv_write_compressed && !drv->bdrv_co_pwritev_compressed) {
2038
            error_report("Compression not supported for this file format");
2039 2040
            ret = -1;
            goto out;
2041 2042
        }

2043
        if (encryption) {
2044 2045
            error_report("Compression and encryption not supported at "
                         "the same time");
2046 2047
            ret = -1;
            goto out;
2048
        }
2049

2050 2051
        if (preallocation
            && strcmp(preallocation, "off"))
2052 2053 2054 2055 2056 2057
        {
            error_report("Compression and preallocation not supported at "
                         "the same time");
            ret = -1;
            goto out;
        }
2058 2059
    }

2060 2061
    if (!skip_create) {
        /* Create the new image */
C
Chunyan Liu 已提交
2062
        ret = bdrv_create(drv, out_filename, opts, &local_err);
2063
        if (ret < 0) {
2064 2065
            error_reportf_err(local_err, "%s: error while converting %s: ",
                              out_filename, out_fmt);
2066
            goto out;
B
bellard 已提交
2067 2068
        }
    }
2069

2070
    flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2071
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2072 2073
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2074
        goto out;
2075 2076
    }

2077 2078 2079 2080 2081
    /* 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...
     */
2082
    out_blk = img_open_file(out_filename, out_fmt, flags, writethrough, quiet);
2083
    if (!out_blk) {
2084 2085 2086
        ret = -1;
        goto out;
    }
2087
    out_bs = blk_bs(out_blk);
B
bellard 已提交
2088

2089
    /* increase bufsectors from the default 4096 (2M) if opt_transfer
2090 2091 2092
     * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
     * as maximum. */
    bufsectors = MIN(32768,
2093 2094
                     MAX(bufsectors,
                         MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2095 2096
                             out_bs->bl.pdiscard_alignment >>
                             BDRV_SECTOR_BITS)));
2097

2098
    if (skip_create) {
2099
        int64_t output_sectors = blk_nb_sectors(out_blk);
2100
        if (output_sectors < 0) {
2101
            error_report("unable to get output image length: %s",
2102
                         strerror(-output_sectors));
2103 2104
            ret = -1;
            goto out;
2105
        } else if (output_sectors < total_sectors) {
2106 2107 2108 2109 2110 2111
            error_report("output file is smaller than input file");
            ret = -1;
            goto out;
        }
    }

2112 2113 2114 2115
    cluster_sectors = 0;
    ret = bdrv_get_info(out_bs, &bdi);
    if (ret < 0) {
        if (compress) {
2116
            error_report("could not get block driver info");
2117 2118
            goto out;
        }
2119
    } else {
2120
        compress = compress || bdi.needs_compressed_writes;
2121 2122 2123
        cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
    }

2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136
    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);
2137

2138
out:
2139 2140 2141
    if (!ret) {
        qemu_progress_print(100, 0);
    }
2142
    qemu_progress_end();
2143 2144
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
2145
    qemu_opts_del(sn_opts);
M
Markus Armbruster 已提交
2146
    blk_unref(out_blk);
2147
    g_free(bs);
M
Markus Armbruster 已提交
2148 2149 2150 2151 2152 2153
    if (blk) {
        for (bs_i = 0; bs_i < bs_n; bs_i++) {
            blk_unref(blk[bs_i]);
        }
        g_free(blk);
    }
2154
    g_free(bs_sectors);
2155 2156 2157
fail_getopt:
    g_free(options);

2158 2159 2160
    if (ret) {
        return 1;
    }
B
bellard 已提交
2161 2162 2163
    return 0;
}

B
bellard 已提交
2164

B
bellard 已提交
2165 2166 2167 2168 2169 2170 2171 2172 2173
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");
2174 2175
    bdrv_snapshot_dump(fprintf, stdout, NULL);
    printf("\n");
B
bellard 已提交
2176 2177
    for(i = 0; i < nb_sns; i++) {
        sn = &sn_tab[i];
2178 2179
        bdrv_snapshot_dump(fprintf, stdout, sn);
        printf("\n");
B
bellard 已提交
2180
    }
2181
    g_free(sn_tab);
B
bellard 已提交
2182 2183
}

2184 2185 2186 2187
static void dump_json_image_info_list(ImageInfoList *list)
{
    QString *str;
    QObject *obj;
2188 2189 2190 2191
    Visitor *v = qmp_output_visitor_new(&obj);

    visit_type_ImageInfoList(v, NULL, &list, &error_abort);
    visit_complete(v, &obj);
2192 2193 2194 2195
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
2196
    visit_free(v);
2197 2198 2199
    QDECREF(str);
}

2200 2201 2202 2203
static void dump_json_image_info(ImageInfo *info)
{
    QString *str;
    QObject *obj;
2204 2205 2206 2207
    Visitor *v = qmp_output_visitor_new(&obj);

    visit_type_ImageInfo(v, NULL, &info, &error_abort);
    visit_complete(v, &obj);
2208 2209 2210 2211
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
2212
    visit_free(v);
2213 2214 2215
    QDECREF(str);
}

2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226
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;

2227
        bdrv_image_info_dump(fprintf, stdout, elem->value);
2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247
    }
}

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.
 */
2248 2249
static ImageInfoList *collect_image_info_list(bool image_opts,
                                              const char *filename,
2250 2251 2252 2253 2254 2255
                                              const char *fmt,
                                              bool chain)
{
    ImageInfoList *head = NULL;
    ImageInfoList **last = &head;
    GHashTable *filenames;
2256
    Error *err = NULL;
2257 2258 2259 2260

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

    while (filename) {
M
Markus Armbruster 已提交
2261
        BlockBackend *blk;
2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272
        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);

2273
        blk = img_open(image_opts, filename, fmt,
2274
                       BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false);
2275
        if (!blk) {
2276 2277
            goto err;
        }
2278
        bs = blk_bs(blk);
2279

2280
        bdrv_query_image_info(bs, &info, &err);
2281
        if (err) {
2282
            error_report_err(err);
M
Markus Armbruster 已提交
2283
            blk_unref(blk);
2284
            goto err;
2285
        }
2286 2287 2288 2289 2290 2291

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

M
Markus Armbruster 已提交
2292
        blk_unref(blk);
2293 2294 2295 2296 2297 2298

        filename = fmt = NULL;
        if (chain) {
            if (info->has_full_backing_filename) {
                filename = info->full_backing_filename;
            } else if (info->has_backing_filename) {
2299 2300 2301 2302
                error_report("Could not determine absolute backing filename,"
                             " but backing filename '%s' present",
                             info->backing_filename);
                goto err;
2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317
            }
            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;
}

2318 2319 2320 2321
static int img_info(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
2322
    bool chain = false;
2323
    const char *filename, *fmt, *output;
2324
    ImageInfoList *list;
2325
    bool image_opts = false;
2326

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

2377 2378 2379 2380 2381 2382
    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.");
2383 2384
        return 1;
    }
2385

2386 2387
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2388
                          NULL, NULL)) {
2389 2390 2391
        return 1;
    }

2392
    list = collect_image_info_list(image_opts, filename, fmt, chain);
2393
    if (!list) {
2394
        return 1;
B
bellard 已提交
2395
    }
2396 2397 2398

    switch (output_format) {
    case OFORMAT_HUMAN:
2399
        dump_human_image_info_list(list);
2400 2401
        break;
    case OFORMAT_JSON:
2402 2403 2404 2405 2406
        if (chain) {
            dump_json_image_info_list(list);
        } else {
            dump_json_image_info(list->value);
        }
2407
        break;
B
bellard 已提交
2408
    }
2409

2410
    qapi_free_ImageInfoList(list);
B
bellard 已提交
2411 2412 2413
    return 0;
}

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

    /* 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 (;;) {
2471 2472
        ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
                                    &file);
P
Paolo Bonzini 已提交
2473 2474 2475 2476 2477 2478 2479
        if (ret < 0) {
            return ret;
        }
        assert(nb_sectors);
        if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
            break;
        }
2480
        bs = backing_bs(bs);
P
Paolo Bonzini 已提交
2481 2482 2483 2484 2485 2486 2487 2488
        if (bs == NULL) {
            ret = 0;
            break;
        }

        depth++;
    }

J
John Snow 已提交
2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502
    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 已提交
2503 2504 2505
    return 0;
}

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

    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},
2547
            {"object", required_argument, 0, OPTION_OBJECT},
2548
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
P
Paolo Bonzini 已提交
2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566
            {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;
2567 2568 2569 2570 2571 2572 2573 2574
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2575 2576 2577
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
P
Paolo Bonzini 已提交
2578 2579
        }
    }
F
Fam Zheng 已提交
2580 2581
    if (optind != argc - 1) {
        error_exit("Expecting one image file name");
P
Paolo Bonzini 已提交
2582
    }
F
Fam Zheng 已提交
2583
    filename = argv[optind];
P
Paolo Bonzini 已提交
2584 2585 2586 2587 2588 2589 2590 2591 2592 2593

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

2594 2595
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2596
                          NULL, NULL)) {
2597 2598 2599
        return 1;
    }

2600
    blk = img_open(image_opts, filename, fmt, 0, false, false);
2601 2602
    if (!blk) {
        return 1;
P
Paolo Bonzini 已提交
2603
    }
2604
    bs = blk_bs(blk);
P
Paolo Bonzini 已提交
2605 2606 2607 2608 2609

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

2610
    length = blk_getlength(blk);
P
Paolo Bonzini 已提交
2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627
    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;
        }

2628
        if (entry_mergeable(&curr, &next)) {
P
Paolo Bonzini 已提交
2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641
            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 已提交
2642
    blk_unref(blk);
P
Paolo Bonzini 已提交
2643 2644 2645
    return ret < 0;
}

2646 2647 2648 2649 2650
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

2651
static int img_snapshot(int argc, char **argv)
2652
{
M
Markus Armbruster 已提交
2653
    BlockBackend *blk;
2654 2655 2656
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
2657
    int c, ret = 0, bdrv_oflags;
2658 2659
    int action = 0;
    qemu_timeval tv;
2660
    bool quiet = false;
2661
    Error *err = NULL;
2662
    bool image_opts = false;
2663

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

2732
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2733
        error_exit("Expecting one image file name");
2734
    }
2735 2736
    filename = argv[optind++];

2737 2738
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2739
                          NULL, NULL)) {
2740 2741 2742
        return 1;
    }

2743
    /* Open the image */
2744
    blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet);
2745 2746
    if (!blk) {
        return 1;
2747
    }
2748
    bs = blk_bs(blk);
2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764

    /* 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);
2765
        if (ret) {
2766
            error_report("Could not create snapshot '%s': %d (%s)",
2767
                snapshot_name, ret, strerror(-ret));
2768
        }
2769 2770 2771 2772
        break;

    case SNAPSHOT_APPLY:
        ret = bdrv_snapshot_goto(bs, snapshot_name);
2773
        if (ret) {
2774
            error_report("Could not apply snapshot '%s': %d (%s)",
2775
                snapshot_name, ret, strerror(-ret));
2776
        }
2777 2778 2779
        break;

    case SNAPSHOT_DELETE:
2780
        bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2781
        if (err) {
2782 2783
            error_reportf_err(err, "Could not delete snapshot '%s': ",
                              snapshot_name);
2784
            ret = 1;
2785
        }
2786 2787 2788 2789
        break;
    }

    /* Cleanup */
M
Markus Armbruster 已提交
2790
    blk_unref(blk);
2791 2792 2793
    if (ret) {
        return 1;
    }
2794
    return 0;
2795 2796
}

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

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

2874 2875 2876 2877
    if (quiet) {
        progress = 0;
    }

F
Fam Zheng 已提交
2878 2879 2880 2881 2882
    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)");
2883
    }
K
Kevin Wolf 已提交
2884 2885
    filename = argv[optind++];

2886 2887
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2888
                          NULL, NULL)) {
2889 2890 2891
        return 1;
    }

2892 2893 2894
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

2895
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2896
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2897 2898
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2899
        goto out;
2900 2901
    }

2902 2903
    src_flags = 0;
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2904 2905
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
2906
        goto out;
2907 2908
    }

2909 2910 2911 2912
    /* The source files are opened read-only, don't care about WCE */
    assert((src_flags & BDRV_O_RDWR) == 0);
    (void) src_writethrough;

K
Kevin Wolf 已提交
2913 2914 2915 2916 2917 2918
    /*
     * 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.
     */
2919
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
2920
    if (!blk) {
2921 2922
        ret = -1;
        goto out;
2923
    }
2924
    bs = blk_bs(blk);
K
Kevin Wolf 已提交
2925 2926

    if (out_basefmt != NULL) {
2927
        if (bdrv_find_format(out_basefmt) == NULL) {
2928
            error_report("Invalid format name: '%s'", out_basefmt);
2929 2930
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
2931 2932 2933 2934
        }
    }

    /* For safe rebasing we need to compare old and new backing file */
2935
    if (!unsafe) {
2936
        char backing_name[PATH_MAX];
2937 2938 2939 2940 2941 2942
        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 已提交
2943 2944

        bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2945
        blk_old_backing = blk_new_open(backing_name, NULL,
2946 2947
                                       options, src_flags, &local_err);
        if (!blk_old_backing) {
2948 2949 2950
            error_reportf_err(local_err,
                              "Could not open old backing file '%s': ",
                              backing_name);
2951
            goto out;
K
Kevin Wolf 已提交
2952
        }
2953

2954
        if (out_baseimg[0]) {
2955 2956 2957 2958 2959 2960 2961
            if (out_basefmt) {
                options = qdict_new();
                qdict_put(options, "driver", qstring_from_str(out_basefmt));
            } else {
                options = NULL;
            }

2962
            blk_new_backing = blk_new_open(out_baseimg, NULL,
2963 2964
                                           options, src_flags, &local_err);
            if (!blk_new_backing) {
2965 2966 2967
                error_reportf_err(local_err,
                                  "Could not open new backing file '%s': ",
                                  out_baseimg);
2968 2969
                goto out;
            }
K
Kevin Wolf 已提交
2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982
        }
    }

    /*
     * 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) {
2983 2984 2985
        int64_t num_sectors;
        int64_t old_backing_num_sectors;
        int64_t new_backing_num_sectors = 0;
K
Kevin Wolf 已提交
2986
        uint64_t sector;
2987
        int n;
2988
        float local_progress = 0;
2989

2990 2991
        buf_old = blk_blockalign(blk, IO_BUF_SIZE);
        buf_new = blk_blockalign(blk, IO_BUF_SIZE);
K
Kevin Wolf 已提交
2992

2993
        num_sectors = blk_nb_sectors(blk);
2994 2995 2996 2997 2998 2999
        if (num_sectors < 0) {
            error_report("Could not get size of '%s': %s",
                         filename, strerror(-num_sectors));
            ret = -1;
            goto out;
        }
3000
        old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
3001
        if (old_backing_num_sectors < 0) {
3002
            char backing_name[PATH_MAX];
3003 3004 3005 3006 3007 3008 3009

            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;
        }
3010 3011
        if (blk_new_backing) {
            new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
3012 3013 3014 3015 3016 3017
            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;
            }
3018
        }
K
Kevin Wolf 已提交
3019

3020 3021 3022 3023 3024
        if (num_sectors != 0) {
            local_progress = (float)100 /
                (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
        }

K
Kevin Wolf 已提交
3025 3026 3027 3028 3029 3030 3031 3032 3033 3034
        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 */
3035
            ret = bdrv_is_allocated(bs, sector, n, &n);
3036 3037 3038 3039 3040
            if (ret < 0) {
                error_report("error while reading image metadata: %s",
                             strerror(-ret));
                goto out;
            }
3041
            if (ret) {
K
Kevin Wolf 已提交
3042 3043 3044
                continue;
            }

3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055
            /*
             * 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;
                }

3056 3057
                ret = blk_pread(blk_old_backing, sector << BDRV_SECTOR_BITS,
                                buf_old, n << BDRV_SECTOR_BITS);
3058 3059 3060 3061
                if (ret < 0) {
                    error_report("error while reading from old backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3062
            }
3063

3064
            if (sector >= new_backing_num_sectors || !blk_new_backing) {
3065 3066 3067 3068 3069 3070
                memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
            } else {
                if (sector + n > new_backing_num_sectors) {
                    n = new_backing_num_sectors - sector;
                }

3071 3072
                ret = blk_pread(blk_new_backing, sector << BDRV_SECTOR_BITS,
                                buf_new, n << BDRV_SECTOR_BITS);
3073 3074 3075 3076
                if (ret < 0) {
                    error_report("error while reading from new backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3077 3078 3079 3080 3081 3082 3083 3084 3085
            }

            /* 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,
3086
                    buf_new + written * 512, n - written, &pnum))
K
Kevin Wolf 已提交
3087
                {
3088 3089 3090 3091
                    ret = blk_pwrite(blk,
                                     (sector + written) << BDRV_SECTOR_BITS,
                                     buf_old + written * 512,
                                     pnum << BDRV_SECTOR_BITS, 0);
K
Kevin Wolf 已提交
3092
                    if (ret < 0) {
3093
                        error_report("Error while writing to COW image: %s",
K
Kevin Wolf 已提交
3094
                            strerror(-ret));
3095
                        goto out;
K
Kevin Wolf 已提交
3096 3097 3098 3099 3100
                    }
                }

                written += pnum;
            }
3101
            qemu_progress_print(local_progress, 100);
K
Kevin Wolf 已提交
3102 3103 3104 3105 3106 3107 3108 3109
        }
    }

    /*
     * 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.
     */
3110 3111 3112 3113 3114 3115
    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 已提交
3116
    if (ret == -ENOSPC) {
3117 3118
        error_report("Could not change the backing file to '%s': No "
                     "space left in the file header", out_baseimg);
K
Kevin Wolf 已提交
3119
    } else if (ret < 0) {
3120
        error_report("Could not change the backing file to '%s': %s",
K
Kevin Wolf 已提交
3121 3122 3123
            out_baseimg, strerror(-ret));
    }

3124
    qemu_progress_print(100, 0);
K
Kevin Wolf 已提交
3125 3126 3127 3128 3129 3130
    /*
     * 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.
     */
3131
out:
3132
    qemu_progress_end();
K
Kevin Wolf 已提交
3133 3134
    /* Cleanup */
    if (!unsafe) {
M
Markus Armbruster 已提交
3135 3136
        blk_unref(blk_old_backing);
        blk_unref(blk_new_backing);
K
Kevin Wolf 已提交
3137
    }
P
Paolo Bonzini 已提交
3138 3139
    qemu_vfree(buf_old);
    qemu_vfree(buf_new);
K
Kevin Wolf 已提交
3140

M
Markus Armbruster 已提交
3141
    blk_unref(blk);
3142 3143 3144
    if (ret) {
        return 1;
    }
K
Kevin Wolf 已提交
3145 3146 3147
    return 0;
}

3148 3149
static int img_resize(int argc, char **argv)
{
3150
    Error *err = NULL;
3151 3152 3153
    int c, ret, relative;
    const char *filename, *fmt, *size;
    int64_t n, total_size;
3154
    bool quiet = false;
M
Markus Armbruster 已提交
3155
    BlockBackend *blk = NULL;
3156
    QemuOpts *param;
3157

3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168
    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 */
            }
3169 3170
        },
    };
3171
    bool image_opts = false;
3172

K
Kevin Wolf 已提交
3173 3174 3175
    /* Remove size from argv manually so that negative numbers are not treated
     * as options by getopt. */
    if (argc < 3) {
F
Fam Zheng 已提交
3176
        error_exit("Not enough arguments");
K
Kevin Wolf 已提交
3177 3178 3179 3180 3181 3182
        return 1;
    }

    size = argv[--argc];

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

3225 3226
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3227
                          NULL, NULL)) {
3228 3229 3230
        return 1;
    }

3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246
    /* 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 */
3247
    param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3248
    qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3249 3250
    if (err) {
        error_report_err(err);
3251
        ret = -1;
3252
        qemu_opts_del(param);
3253
        goto out;
3254
    }
3255 3256
    n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
    qemu_opts_del(param);
3257

3258
    blk = img_open(image_opts, filename, fmt,
3259
                   BDRV_O_RDWR, false, quiet);
3260
    if (!blk) {
3261 3262
        ret = -1;
        goto out;
3263
    }
3264 3265

    if (relative) {
3266
        total_size = blk_getlength(blk) + n * relative;
3267 3268 3269 3270
    } else {
        total_size = n;
    }
    if (total_size <= 0) {
3271
        error_report("New image size must be positive");
3272 3273
        ret = -1;
        goto out;
3274 3275
    }

3276
    ret = blk_truncate(blk, total_size);
3277 3278
    switch (ret) {
    case 0:
3279
        qprintf(quiet, "Image resized.\n");
3280 3281
        break;
    case -ENOTSUP:
3282
        error_report("This image does not support resize");
3283 3284
        break;
    case -EACCES:
3285
        error_report("Image is read-only");
3286 3287
        break;
    default:
3288
        error_report("Error resizing image: %s", strerror(-ret));
3289 3290
        break;
    }
3291
out:
M
Markus Armbruster 已提交
3292
    blk_unref(blk);
3293 3294 3295
    if (ret) {
        return 1;
    }
3296 3297 3298
    return 0;
}

3299
static void amend_status_cb(BlockDriverState *bs,
3300 3301
                            int64_t offset, int64_t total_work_size,
                            void *opaque)
3302 3303 3304 3305
{
    qemu_progress_print(100.f * offset / total_work_size, 0);
}

M
Max Reitz 已提交
3306 3307
static int img_amend(int argc, char **argv)
{
3308
    Error *err = NULL;
M
Max Reitz 已提交
3309 3310
    int c, ret = 0;
    char *options = NULL;
3311 3312
    QemuOptsList *create_opts = NULL;
    QemuOpts *opts = NULL;
3313 3314
    const char *fmt = NULL, *filename, *cache;
    int flags;
3315
    bool writethrough;
3316
    bool quiet = false, progress = false;
M
Markus Armbruster 已提交
3317
    BlockBackend *blk = NULL;
M
Max Reitz 已提交
3318
    BlockDriverState *bs = NULL;
3319
    bool image_opts = false;
M
Max Reitz 已提交
3320

3321
    cache = BDRV_DEFAULT_CACHE;
M
Max Reitz 已提交
3322
    for (;;) {
3323 3324 3325
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3326
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3327 3328 3329 3330
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "ho:f:t:pq",
                        long_options, NULL);
M
Max Reitz 已提交
3331 3332 3333 3334 3335 3336 3337 3338 3339 3340
        if (c == -1) {
            break;
        }

        switch (c) {
            case 'h':
            case '?':
                help();
                break;
            case 'o':
3341 3342 3343
                if (!is_valid_option_list(optarg)) {
                    error_report("Invalid option list: %s", optarg);
                    ret = -1;
3344
                    goto out_no_progress;
3345 3346 3347 3348 3349 3350 3351 3352
                }
                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 已提交
3353 3354 3355 3356
                break;
            case 'f':
                fmt = optarg;
                break;
3357 3358 3359
            case 't':
                cache = optarg;
                break;
3360 3361 3362
            case 'p':
                progress = true;
                break;
M
Max Reitz 已提交
3363 3364 3365
            case 'q':
                quiet = true;
                break;
3366 3367 3368 3369 3370 3371 3372 3373
            case OPTION_OBJECT:
                opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                               optarg, true);
                if (!opts) {
                    ret = -1;
                    goto out_no_progress;
                }
                break;
3374 3375 3376
            case OPTION_IMAGE_OPTS:
                image_opts = true;
                break;
M
Max Reitz 已提交
3377 3378 3379
        }
    }

3380
    if (!options) {
F
Fam Zheng 已提交
3381
        error_exit("Must specify options (-o)");
M
Max Reitz 已提交
3382 3383
    }

3384 3385
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3386
                          NULL, NULL)) {
3387 3388 3389 3390
        ret = -1;
        goto out_no_progress;
    }

3391 3392 3393 3394 3395
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);

3396 3397 3398 3399 3400 3401
    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 已提交
3402 3403
    }

3404
    if (optind != argc - 1) {
M
Max Reitz 已提交
3405 3406 3407
        error_report("Expecting one image file name");
        ret = -1;
        goto out;
3408
    }
M
Max Reitz 已提交
3409

3410 3411
    flags = BDRV_O_RDWR;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3412 3413 3414 3415 3416
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        goto out;
    }

3417
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3418
    if (!blk) {
M
Max Reitz 已提交
3419 3420 3421
        ret = -1;
        goto out;
    }
3422
    bs = blk_bs(blk);
M
Max Reitz 已提交
3423 3424 3425

    fmt = bs->drv->format_name;

3426
    if (has_help_option(options)) {
3427
        /* If the format was auto-detected, print option help here */
M
Max Reitz 已提交
3428 3429 3430 3431
        ret = print_block_option_help(filename, fmt);
        goto out;
    }

3432 3433 3434 3435 3436 3437 3438
    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 已提交
3439
    create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3440
    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
3441 3442 3443
    if (options) {
        qemu_opts_do_parse(opts, options, NULL, &err);
        if (err) {
3444
            error_report_err(err);
3445 3446 3447
            ret = -1;
            goto out;
        }
M
Max Reitz 已提交
3448 3449
    }

3450 3451
    /* In case the driver does not call amend_status_cb() */
    qemu_progress_print(0.f, 0);
3452
    ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
3453
    qemu_progress_print(100.f, 0);
M
Max Reitz 已提交
3454 3455 3456 3457 3458 3459
    if (ret < 0) {
        error_report("Error while amending options: %s", strerror(-ret));
        goto out;
    }

out:
3460 3461
    qemu_progress_end();

3462
out_no_progress:
M
Markus Armbruster 已提交
3463
    blk_unref(blk);
3464 3465
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
3466 3467
    g_free(options);

M
Max Reitz 已提交
3468 3469 3470 3471 3472 3473
    if (ret) {
        return 1;
    }
    return 0;
}

K
Kevin Wolf 已提交
3474 3475 3476
typedef struct BenchData {
    BlockBackend *blk;
    uint64_t image_size;
K
Kevin Wolf 已提交
3477
    bool write;
K
Kevin Wolf 已提交
3478
    int bufsize;
3479
    int step;
K
Kevin Wolf 已提交
3480 3481
    int nrreq;
    int n;
3482 3483
    int flush_interval;
    bool drain_on_flush;
K
Kevin Wolf 已提交
3484 3485 3486 3487
    uint8_t *buf;
    QEMUIOVector *qiov;

    int in_flight;
3488
    bool in_flush;
K
Kevin Wolf 已提交
3489 3490 3491
    uint64_t offset;
} BenchData;

3492 3493 3494
static void bench_undrained_flush_cb(void *opaque, int ret)
{
    if (ret < 0) {
3495
        error_report("Failed flush request: %s", strerror(-ret));
3496 3497 3498 3499
        exit(EXIT_FAILURE);
    }
}

K
Kevin Wolf 已提交
3500 3501 3502 3503 3504 3505
static void bench_cb(void *opaque, int ret)
{
    BenchData *b = opaque;
    BlockAIOCB *acb;

    if (ret < 0) {
3506
        error_report("Failed request: %s", strerror(-ret));
K
Kevin Wolf 已提交
3507 3508
        exit(EXIT_FAILURE);
    }
3509 3510 3511 3512 3513 3514 3515 3516

    if (b->in_flush) {
        /* Just finished a flush with drained queue: Start next requests */
        assert(b->in_flight == 0);
        b->in_flush = false;
    } else if (b->in_flight > 0) {
        int remaining = b->n - b->in_flight;

K
Kevin Wolf 已提交
3517 3518
        b->n--;
        b->in_flight--;
3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541

        /* Time for flush? Drain queue if requested, then flush */
        if (b->flush_interval && remaining % b->flush_interval == 0) {
            if (!b->in_flight || !b->drain_on_flush) {
                BlockCompletionFunc *cb;

                if (b->drain_on_flush) {
                    b->in_flush = true;
                    cb = bench_cb;
                } else {
                    cb = bench_undrained_flush_cb;
                }

                acb = blk_aio_flush(b->blk, cb, b);
                if (!acb) {
                    error_report("Failed to issue flush request");
                    exit(EXIT_FAILURE);
                }
            }
            if (b->drain_on_flush) {
                return;
            }
        }
K
Kevin Wolf 已提交
3542 3543 3544
    }

    while (b->n > b->in_flight && b->in_flight < b->nrreq) {
K
Kevin Wolf 已提交
3545 3546 3547 3548 3549 3550 3551
        if (b->write) {
            acb = blk_aio_pwritev(b->blk, b->offset, b->qiov, 0,
                                  bench_cb, b);
        } else {
            acb = blk_aio_preadv(b->blk, b->offset, b->qiov, 0,
                                 bench_cb, b);
        }
K
Kevin Wolf 已提交
3552 3553 3554 3555 3556
        if (!acb) {
            error_report("Failed to issue request");
            exit(EXIT_FAILURE);
        }
        b->in_flight++;
3557
        b->offset += b->step;
K
Kevin Wolf 已提交
3558 3559 3560 3561 3562 3563 3564 3565 3566 3567
        b->offset %= b->image_size;
    }
}

static int img_bench(int argc, char **argv)
{
    int c, ret = 0;
    const char *fmt = NULL, *filename;
    bool quiet = false;
    bool image_opts = false;
K
Kevin Wolf 已提交
3568
    bool is_write = false;
K
Kevin Wolf 已提交
3569 3570
    int count = 75000;
    int depth = 64;
3571
    int64_t offset = 0;
K
Kevin Wolf 已提交
3572
    size_t bufsize = 4096;
K
Kevin Wolf 已提交
3573
    int pattern = 0;
3574
    size_t step = 0;
3575 3576
    int flush_interval = 0;
    bool drain_on_flush = true;
K
Kevin Wolf 已提交
3577 3578 3579 3580
    int64_t image_size;
    BlockBackend *blk = NULL;
    BenchData data = {};
    int flags = 0;
3581
    bool writethrough = false;
K
Kevin Wolf 已提交
3582 3583 3584 3585 3586 3587
    struct timeval t1, t2;
    int i;

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

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

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

            bufsize = sval;
            break;
        }
3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675
        case 'S':
        {
            int64_t sval;
            char *end;

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

            step = sval;
            break;
        }
K
Kevin Wolf 已提交
3676 3677 3678 3679 3680 3681 3682 3683
        case 't':
            ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
            if (ret < 0) {
                error_report("Invalid cache mode");
                ret = -1;
                goto out;
            }
            break;
K
Kevin Wolf 已提交
3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698
        case 'w':
            flags |= BDRV_O_RDWR;
            is_write = true;
            break;
        case OPTION_PATTERN:
        {
            char *end;
            errno = 0;
            pattern = strtoul(optarg, &end, 0);
            if (errno || *end || pattern > 0xff) {
                error_report("Invalid pattern byte specified");
                return 1;
            }
            break;
        }
3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712
        case OPTION_FLUSH_INTERVAL:
        {
            char *end;
            errno = 0;
            flush_interval = strtoul(optarg, &end, 0);
            if (errno || *end || flush_interval > INT_MAX) {
                error_report("Invalid flush interval specified");
                return 1;
            }
            break;
        }
        case OPTION_NO_DRAIN:
            drain_on_flush = false;
            break;
K
Kevin Wolf 已提交
3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
        }
    }

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

3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734
    if (!is_write && flush_interval) {
        error_report("--flush-interval is only available in write tests");
        ret = -1;
        goto out;
    }
    if (flush_interval && flush_interval < depth) {
        error_report("Flush interval can't be smaller than depth");
        ret = -1;
        goto out;
    }

K
Kevin Wolf 已提交
3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
    if (!blk) {
        ret = -1;
        goto out;
    }

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

    data = (BenchData) {
3748 3749 3750 3751 3752 3753 3754 3755 3756 3757
        .blk            = blk,
        .image_size     = image_size,
        .bufsize        = bufsize,
        .step           = step ?: bufsize,
        .nrreq          = depth,
        .n              = count,
        .offset         = offset,
        .write          = is_write,
        .flush_interval = flush_interval,
        .drain_on_flush = drain_on_flush,
K
Kevin Wolf 已提交
3758
    };
3759
    printf("Sending %d %s requests, %d bytes each, %d in parallel "
3760
           "(starting at offset %" PRId64 ", step size %d)\n",
3761
           data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
3762
           data.offset, data.step);
3763 3764 3765
    if (flush_interval) {
        printf("Sending flush every %d requests\n", flush_interval);
    }
K
Kevin Wolf 已提交
3766 3767

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

K
Kevin Wolf 已提交
3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799
    data.qiov = g_new(QEMUIOVector, data.nrreq);
    for (i = 0; i < data.nrreq; i++) {
        qemu_iovec_init(&data.qiov[i], 1);
        qemu_iovec_add(&data.qiov[i],
                       data.buf + i * data.bufsize, data.bufsize);
    }

    gettimeofday(&t1, NULL);
    bench_cb(&data, 0);

    while (data.n > 0) {
        main_loop_wait(false);
    }
    gettimeofday(&t2, NULL);

    printf("Run completed in %3.3f seconds.\n",
           (t2.tv_sec - t1.tv_sec)
           + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));

out:
    qemu_vfree(data.buf);
    blk_unref(blk);

    if (ret) {
        return 1;
    }
    return 0;
}


A
Anthony Liguori 已提交
3800
static const img_cmd_t img_cmds[] = {
3801 3802 3803 3804 3805 3806 3807 3808
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
    { NULL, NULL, },
};

B
bellard 已提交
3809 3810
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
3811
    const img_cmd_t *cmd;
3812
    const char *cmdname;
3813
    Error *local_error = NULL;
3814
    char *trace_file = NULL;
3815 3816 3817
    int c;
    static const struct option long_options[] = {
        {"help", no_argument, 0, 'h'},
3818
        {"version", no_argument, 0, 'V'},
3819
        {"trace", required_argument, NULL, 'T'},
3820 3821
        {0, 0, 0, 0}
    };
B
bellard 已提交
3822

3823 3824 3825 3826
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

K
Kevin Wolf 已提交
3827
    error_set_progname(argv[0]);
3828
    qemu_init_exec_dir(argv[0]);
K
Kevin Wolf 已提交
3829

3830
    if (qemu_init_main_loop(&local_error)) {
3831
        error_report_err(local_error);
3832 3833 3834
        exit(EXIT_FAILURE);
    }

3835
    qcrypto_init(&error_fatal);
3836

3837
    module_call_init(MODULE_INIT_QOM);
B
bellard 已提交
3838
    bdrv_init();
F
Fam Zheng 已提交
3839 3840 3841
    if (argc < 2) {
        error_exit("Not enough arguments");
    }
3842

3843
    qemu_add_opts(&qemu_object_opts);
3844
    qemu_add_opts(&qemu_source_opts);
3845
    qemu_add_opts(&qemu_trace_opts);
3846

3847
    while ((c = getopt_long(argc, argv, "+hVT:", long_options, NULL)) != -1) {
3848 3849 3850 3851 3852 3853 3854
        switch (c) {
        case 'h':
            help();
            return 0;
        case 'V':
            printf(QEMU_IMG_VERSION);
            return 0;
3855 3856 3857 3858
        case 'T':
            g_free(trace_file);
            trace_file = trace_opt_parse(optarg);
            break;
3859
        }
B
bellard 已提交
3860
    }
3861

3862
    cmdname = argv[optind];
3863

3864 3865 3866
    /* reset getopt_long scanning */
    argc -= optind;
    if (argc < 1) {
3867 3868
        return 0;
    }
3869
    argv += optind;
D
Denis V. Lunev 已提交
3870
    optind = 0;
3871

3872 3873 3874 3875 3876 3877
    if (!trace_init_backends()) {
        exit(1);
    }
    trace_init_file(trace_file);
    qemu_set_log(LOG_TRACE);

3878 3879 3880 3881 3882 3883
    /* find the command */
    for (cmd = img_cmds; cmd->name != NULL; cmd++) {
        if (!strcmp(cmdname, cmd->name)) {
            return cmd->handler(argc, argv);
        }
    }
3884

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