qemu-img.c 120.9 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
#include "qapi-visit.h"
28
#include "qapi/qobject-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
                          "\n" 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
           "  '-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"
R
Reda Sallahi 已提交
169 170 171 172 173 174 175
           "  '-s' run in Strict mode - fail on different image size or sector allocation\n"
           "\n"
           "Parameters to dd subcommand:\n"
           "  'bs=BYTES' read and write up to BYTES bytes at a time "
           "(default: 512)\n"
           "  'count=N' copy only N input blocks\n"
           "  'if=FILE' read from FILE\n"
R
Reda Sallahi 已提交
176 177
           "  'of=FILE' write to FILE\n"
           "  'skip=N' skip N bs-sized blocks at the start of input\n";
178 179

    printf("%s\nSupported formats:", help_msg);
180
    bdrv_iterate_format(format_print, NULL);
B
bellard 已提交
181
    printf("\n");
F
Fam Zheng 已提交
182
    exit(EXIT_SUCCESS);
B
bellard 已提交
183 184
}

185 186 187 188 189 190 191 192 193
static QemuOptsList qemu_object_opts = {
    .name = "object",
    .implied_opt_name = "qom-type",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
    .desc = {
        { }
    },
};

194 195 196 197 198 199 200 201 202
static QemuOptsList qemu_source_opts = {
    .name = "source",
    .implied_opt_name = "file",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
    .desc = {
        { }
    },
};

S
Stefan Weil 已提交
203
static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
204 205 206 207 208 209 210 211 212 213 214
{
    int ret = 0;
    if (!quiet) {
        va_list args;
        va_start(args, fmt);
        ret = vprintf(fmt, args);
        va_end(args);
    }
    return ret;
}

B
bellard 已提交
215

216 217 218
static int print_block_option_help(const char *filename, const char *fmt)
{
    BlockDriver *drv, *proto_drv;
219
    QemuOptsList *create_opts = NULL;
220
    Error *local_err = NULL;
221 222 223 224

    /* Find driver and parse its options */
    drv = bdrv_find_format(fmt);
    if (!drv) {
225
        error_report("Unknown file format '%s'", fmt);
226 227 228
        return 1;
    }

C
Chunyan Liu 已提交
229
    create_opts = qemu_opts_append(create_opts, drv->create_opts);
230
    if (filename) {
231
        proto_drv = bdrv_find_protocol(filename, true, &local_err);
232
        if (!proto_drv) {
233
            error_report_err(local_err);
234
            qemu_opts_free(create_opts);
235 236
            return 1;
        }
C
Chunyan Liu 已提交
237
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
238 239
    }

240 241
    qemu_opts_print_help(create_opts);
    qemu_opts_free(create_opts);
242 243 244
    return 0;
}

245 246

static int img_open_password(BlockBackend *blk, const char *filename,
247
                             int flags, bool quiet)
248 249 250
{
    BlockDriverState *bs;
    char password[256];
251 252

    bs = blk_bs(blk);
253 254
    if (bdrv_is_encrypted(bs) && bdrv_key_required(bs) &&
        !(flags & BDRV_O_NO_IO)) {
255 256 257 258 259 260 261 262 263 264 265 266 267 268
        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;
}


269
static BlockBackend *img_open_opts(const char *optstr,
270
                                   QemuOpts *opts, int flags, bool writethrough,
271
                                   bool quiet)
272 273 274 275 276
{
    QDict *options;
    Error *local_err = NULL;
    BlockBackend *blk;
    options = qemu_opts_to_qdict(opts, NULL);
277
    blk = blk_new_open(NULL, NULL, options, flags, &local_err);
278
    if (!blk) {
279
        error_reportf_err(local_err, "Could not open '%s': ", optstr);
280 281
        return NULL;
    }
282
    blk_set_enable_write_cache(blk, !writethrough);
283

284
    if (img_open_password(blk, optstr, flags, quiet) < 0) {
285 286 287 288 289 290
        blk_unref(blk);
        return NULL;
    }
    return blk;
}

291
static BlockBackend *img_open_file(const char *filename,
292
                                   const char *fmt, int flags,
293
                                   bool writethrough, bool quiet)
294 295
{
    BlockBackend *blk;
296
    Error *local_err = NULL;
297
    QDict *options = NULL;
298

299
    if (fmt) {
300 301
        options = qdict_new();
        qdict_put(options, "driver", qstring_from_str(fmt));
302
    }
303

304
    blk = blk_new_open(filename, NULL, options, flags, &local_err);
305
    if (!blk) {
306
        error_reportf_err(local_err, "Could not open '%s': ", filename);
307
        return NULL;
308
    }
309
    blk_set_enable_write_cache(blk, !writethrough);
310

311
    if (img_open_password(blk, filename, flags, quiet) < 0) {
312 313 314 315 316 317 318
        blk_unref(blk);
        return NULL;
    }
    return blk;
}


319
static BlockBackend *img_open(bool image_opts,
320
                              const char *filename,
321
                              const char *fmt, int flags, bool writethrough,
322
                              bool quiet)
323 324 325 326 327 328 329 330 331 332 333 334 335
{
    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;
        }
336
        blk = img_open_opts(filename, opts, flags, writethrough, quiet);
337
    } else {
338
        blk = img_open_file(filename, fmt, flags, writethrough, quiet);
339
    }
340
    return blk;
341 342
}

343

344
static int add_old_style_options(const char *fmt, QemuOpts *opts,
345 346
                                 const char *base_filename,
                                 const char *base_fmt)
347
{
348 349
    Error *err = NULL;

350
    if (base_filename) {
351
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
352
        if (err) {
353 354
            error_report("Backing file not supported for file format '%s'",
                         fmt);
355
            error_free(err);
356
            return -1;
357 358 359
        }
    }
    if (base_fmt) {
360
        qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
361
        if (err) {
362 363
            error_report("Backing file format not supported for file "
                         "format '%s'", fmt);
364
            error_free(err);
365
            return -1;
366 367
        }
    }
368
    return 0;
369 370
}

B
bellard 已提交
371 372
static int img_create(int argc, char **argv)
{
373
    int c;
374
    uint64_t img_size = -1;
B
bellard 已提交
375
    const char *fmt = "raw";
376
    const char *base_fmt = NULL;
B
bellard 已提交
377 378
    const char *filename;
    const char *base_filename = NULL;
379
    char *options = NULL;
380
    Error *local_err = NULL;
381
    bool quiet = false;
382

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

443
    /* Get the filename */
444 445 446 447 448 449
    filename = (optind < argc) ? argv[optind] : NULL;
    if (options && has_help_option(options)) {
        g_free(options);
        return print_block_option_help(filename, fmt);
    }

450
    if (optind >= argc) {
F
Fam Zheng 已提交
451
        error_exit("Expecting image file name");
452
    }
453
    optind++;
454

455 456
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
457
                          NULL, NULL)) {
458 459 460
        goto fail;
    }

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

483
    bdrv_img_create(filename, fmt, base_filename, base_fmt,
K
Kevin Wolf 已提交
484
                    options, img_size, 0, &local_err, quiet);
485
    if (local_err) {
486
        error_reportf_err(local_err, "%s: ", filename);
487
        goto fail;
488
    }
489

490
    g_free(options);
B
bellard 已提交
491
    return 0;
492 493 494 495

fail:
    g_free(options);
    return 1;
B
bellard 已提交
496 497
}

498
static void dump_json_image_check(ImageCheck *check, bool quiet)
499 500 501
{
    QString *str;
    QObject *obj;
502
    Visitor *v = qobject_output_visitor_new(&obj);
503 504 505

    visit_type_ImageCheck(v, NULL, &check, &error_abort);
    visit_complete(v, &obj);
506 507
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
508
    qprintf(quiet, "%s\n", qstring_get_str(str));
509
    qobject_decref(obj);
510
    visit_free(v);
511 512 513
    QDECREF(str);
}

514
static void dump_human_image_check(ImageCheck *check, bool quiet)
515 516
{
    if (!(check->corruptions || check->leaks || check->check_errors)) {
517
        qprintf(quiet, "No errors were found on the image.\n");
518 519
    } else {
        if (check->corruptions) {
520 521 522 523
            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);
524 525 526
        }

        if (check->leaks) {
527 528 529 530
            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);
531 532 533
        }

        if (check->check_errors) {
534 535 536 537
            qprintf(quiet,
                    "\n%" PRId64
                    " internal errors have occurred during the check.\n",
                    check->check_errors);
538 539 540 541
        }
    }

    if (check->total_clusters != 0 && check->allocated_clusters != 0) {
542 543 544 545 546 547 548
        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);
549 550 551
    }

    if (check->image_end_offset) {
552 553
        qprintf(quiet,
                "Image end offset: %" PRId64 "\n", check->image_end_offset);
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 583 584 585 586 587 588 589
    }
}

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;
590 591
    check->compressed_clusters      = result.bfi.compressed_clusters;
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
592 593 594 595

    return 0;
}

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

    fmt = NULL;
620
    output = NULL;
621
    cache = BDRV_DEFAULT_CACHE;
622

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

686 687 688 689 690 691 692 693 694
    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;
    }

695 696
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
697
                          NULL, NULL)) {
698 699 700
        return 1;
    }

701
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
702 703 704 705 706
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        return 1;
    }

707
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
708 709
    if (!blk) {
        return 1;
710
    }
711
    bs = blk_bs(blk);
712 713 714

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
715 716

    if (ret == -ENOTSUP) {
717
        error_report("This image format does not support checks");
718
        ret = 63;
719
        goto fail;
720 721
    }

722 723
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
724

725 726
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
727

728
        if (output_format == OFORMAT_HUMAN) {
729 730 731 732 733 734 735
            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);
736 737
        }

738
        ret = collect_image_check(bs, check, filename, fmt, 0);
739

740 741
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
742 743
    }

M
Max Reitz 已提交
744 745 746 747 748 749 750 751 752
    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;
        }
753 754
    }

755
    if (ret || check->check_errors) {
M
Max Reitz 已提交
756 757 758 759 760
        if (ret) {
            error_report("Check failed: %s", strerror(-ret));
        } else {
            error_report("Check failed");
        }
761 762
        ret = 1;
        goto fail;
763
    }
764

765 766 767 768
    if (check->corruptions) {
        ret = 2;
    } else if (check->leaks) {
        ret = 3;
769
    } else {
770
        ret = 0;
771
    }
772 773 774

fail:
    qapi_free_ImageCheck(check);
M
Markus Armbruster 已提交
775
    blk_unref(blk);
776
    return ret;
777 778
}

M
Max Reitz 已提交
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
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 已提交
795
    AioContext *aio_context = blk_get_aio_context(job->blk);
M
Max Reitz 已提交
796

797
    aio_context_acquire(aio_context);
M
Max Reitz 已提交
798 799
    do {
        aio_poll(aio_context, true);
800 801
        qemu_progress_print(job->len ?
                            ((float)job->offset / job->len * 100.f) : 0.0f, 0);
M
Max Reitz 已提交
802 803 804
    } while (!job->ready);

    block_job_complete_sync(job, errp);
805
    aio_context_release(aio_context);
806 807 808 809

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

B
bellard 已提交
812 813
static int img_commit(int argc, char **argv)
{
814
    int c, ret, flags;
815
    const char *filename, *fmt, *cache, *base;
M
Markus Armbruster 已提交
816
    BlockBackend *blk;
M
Max Reitz 已提交
817
    BlockDriverState *bs, *base_bs;
818
    bool progress = false, quiet = false, drop = false;
819
    bool writethrough;
M
Max Reitz 已提交
820 821
    Error *local_err = NULL;
    CommonBlockJobCBInfo cbi;
822
    bool image_opts = false;
823
    AioContext *aio_context;
B
bellard 已提交
824 825

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

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

884
    if (optind != argc - 1) {
F
Fam Zheng 已提交
885
        error_exit("Expecting one image file name");
886
    }
B
bellard 已提交
887 888
    filename = argv[optind++];

889 890
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
891
                          NULL, NULL)) {
892 893 894
        return 1;
    }

M
Max Reitz 已提交
895
    flags = BDRV_O_RDWR | BDRV_O_UNMAP;
896
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
897 898
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
899
        return 1;
900 901
    }

902
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
903 904
    if (!blk) {
        return 1;
905
    }
906 907
    bs = blk_bs(blk);

908 909 910
    qemu_progress_init(progress, 1.f);
    qemu_progress_print(0.f, 100);

911 912 913
    if (base) {
        base_bs = bdrv_find_backing_image(bs, base);
        if (!base_bs) {
914 915 916
            error_setg(&local_err,
                       "Did not find '%s' in the backing chain of '%s'",
                       base, filename);
917 918 919 920 921 922
            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. */
923
        base_bs = backing_bs(bs);
924 925 926 927
        if (!base_bs) {
            error_setg(&local_err, "Image does not have a backing file");
            goto done;
        }
M
Max Reitz 已提交
928 929 930 931 932 933 934
    }

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

935 936
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);
937 938 939
    commit_active_start("commit", bs, base_bs, BLOCK_JOB_DEFAULT, 0,
                        BLOCKDEV_ON_ERROR_REPORT, common_block_job_cb, &cbi,
                        &local_err, false);
940
    aio_context_release(aio_context);
M
Max Reitz 已提交
941 942
    if (local_err) {
        goto done;
B
bellard 已提交
943 944
    }

945 946 947 948
    /* 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 已提交
949
    if (!drop) {
950
        bdrv_ref(bs);
M
Max Reitz 已提交
951 952
    }

M
Max Reitz 已提交
953
    run_block_job(bs->job, &local_err);
M
Max Reitz 已提交
954 955 956 957
    if (local_err) {
        goto unref_backing;
    }

958 959
    if (!drop && bs->drv->bdrv_make_empty) {
        ret = bs->drv->bdrv_make_empty(bs);
M
Max Reitz 已提交
960 961 962 963 964 965 966 967 968
        if (ret) {
            error_setg_errno(&local_err, -ret, "Could not empty %s",
                             filename);
            goto unref_backing;
        }
    }

unref_backing:
    if (!drop) {
969
        bdrv_unref(bs);
M
Max Reitz 已提交
970
    }
M
Max Reitz 已提交
971 972

done:
973 974
    qemu_progress_end();

M
Markus Armbruster 已提交
975
    blk_unref(blk);
M
Max Reitz 已提交
976 977

    if (local_err) {
978
        error_report_err(local_err);
979 980
        return 1;
    }
M
Max Reitz 已提交
981 982

    qprintf(quiet, "Image committed.\n");
B
bellard 已提交
983 984 985
    return 0;
}

986 987 988 989 990 991 992
/*
 * 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 已提交
993 994
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
{
995 996
    bool is_zero;
    int i;
B
bellard 已提交
997 998 999 1000 1001

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
1002
    is_zero = buffer_is_zero(buf, 512);
B
bellard 已提交
1003 1004
    for(i = 1; i < n; i++) {
        buf += 512;
1005
        if (is_zero != buffer_is_zero(buf, 512)) {
B
bellard 已提交
1006
            break;
1007
        }
B
bellard 已提交
1008 1009
    }
    *pnum = i;
1010
    return !is_zero;
B
bellard 已提交
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 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
/*
 * 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 已提交
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
/*
 * 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)
{
1065 1066
    bool res;
    int i;
K
Kevin Wolf 已提交
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086

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

1087
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
1088

1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
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.
 *
1105
 * @param blk:  BlockBackend for the image
1106 1107 1108 1109 1110 1111
 * @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
 */
1112
static int check_empty_sectors(BlockBackend *blk, int64_t sect_num,
1113 1114 1115 1116
                               int sect_count, const char *filename,
                               uint8_t *buffer, bool quiet)
{
    int pnum, ret = 0;
1117 1118
    ret = blk_pread(blk, sect_num << BDRV_SECTOR_BITS, buffer,
                    sect_count << BDRV_SECTOR_BITS);
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
    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)
{
1143
    const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
M
Markus Armbruster 已提交
1144
    BlockBackend *blk1, *blk2;
1145 1146 1147 1148 1149 1150 1151
    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;
1152
    int flags;
1153
    bool writethrough;
1154 1155 1156 1157 1158
    int64_t total_sectors;
    int64_t sector_num = 0;
    int64_t nb_sectors;
    int c, pnum;
    uint64_t progress_base;
1159
    bool image_opts = false;
1160

1161
    cache = BDRV_DEFAULT_CACHE;
1162
    for (;;) {
1163 1164 1165
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
1166
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1167 1168 1169 1170
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "hf:F:T:pqs",
                        long_options, NULL);
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
        if (c == -1) {
            break;
        }
        switch (c) {
        case '?':
        case 'h':
            help();
            break;
        case 'f':
            fmt1 = optarg;
            break;
        case 'F':
            fmt2 = optarg;
            break;
1185 1186 1187
        case 'T':
            cache = optarg;
            break;
1188 1189 1190 1191 1192 1193 1194 1195 1196
        case 'p':
            progress = true;
            break;
        case 'q':
            quiet = true;
            break;
        case 's':
            strict = true;
            break;
1197 1198 1199 1200 1201 1202 1203 1204 1205
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                ret = 2;
                goto out4;
            }
        }   break;
1206 1207 1208
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
1209 1210 1211 1212 1213 1214 1215 1216 1217
        }
    }

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


1218
    if (optind != argc - 2) {
F
Fam Zheng 已提交
1219
        error_exit("Expecting two image file names");
1220 1221 1222 1223
    }
    filename1 = argv[optind++];
    filename2 = argv[optind++];

1224 1225
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
1226
                          NULL, NULL)) {
1227 1228 1229 1230
        ret = 2;
        goto out4;
    }

1231 1232 1233
    /* Initialize before goto out */
    qemu_progress_init(progress, 2.0);

1234 1235
    flags = 0;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1236 1237 1238 1239 1240 1241
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        ret = 2;
        goto out3;
    }

1242
    blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet);
1243
    if (!blk1) {
1244
        ret = 2;
1245
        goto out3;
1246 1247
    }

1248
    blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet);
1249
    if (!blk2) {
1250
        ret = 2;
1251
        goto out2;
1252
    }
1253
    bs1 = blk_bs(blk1);
1254
    bs2 = blk_bs(blk2);
1255

1256 1257 1258
    buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
    buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
    total_sectors1 = blk_nb_sectors(blk1);
1259 1260 1261 1262 1263 1264
    if (total_sectors1 < 0) {
        error_report("Can't get size of %s: %s",
                     filename1, strerror(-total_sectors1));
        ret = 4;
        goto out;
    }
1265
    total_sectors2 = blk_nb_sectors(blk2);
1266 1267 1268 1269 1270 1271
    if (total_sectors2 < 0) {
        error_report("Can't get size of %s: %s",
                     filename2, strerror(-total_sectors2));
        ret = 4;
        goto out;
    }
1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
    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 (;;) {
1284
        int64_t status1, status2;
1285 1286
        BlockDriverState *file;

1287 1288 1289 1290
        nb_sectors = sectors_to_process(total_sectors, sector_num);
        if (nb_sectors <= 0) {
            break;
        }
1291 1292
        status1 = bdrv_get_block_status_above(bs1, NULL, sector_num,
                                              total_sectors1 - sector_num,
1293
                                              &pnum1, &file);
1294
        if (status1 < 0) {
1295 1296 1297 1298
            ret = 3;
            error_report("Sector allocation test failed for %s", filename1);
            goto out;
        }
1299
        allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1300

1301 1302
        status2 = bdrv_get_block_status_above(bs2, NULL, sector_num,
                                              total_sectors2 - sector_num,
1303
                                              &pnum2, &file);
1304
        if (status2 < 0) {
1305 1306 1307 1308
            ret = 3;
            error_report("Sector allocation test failed for %s", filename2);
            goto out;
        }
1309 1310 1311 1312 1313 1314 1315
        allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
        if (pnum1) {
            nb_sectors = MIN(nb_sectors, pnum1);
        }
        if (pnum2) {
            nb_sectors = MIN(nb_sectors, pnum2);
        }
1316

1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329
        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) {
1330
            if (allocated1) {
1331 1332
                ret = blk_pread(blk1, sector_num << BDRV_SECTOR_BITS, buf1,
                                nb_sectors << BDRV_SECTOR_BITS);
1333 1334 1335 1336 1337 1338 1339
                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;
                }
1340 1341
                ret = blk_pread(blk2, sector_num << BDRV_SECTOR_BITS, buf2,
                                nb_sectors << BDRV_SECTOR_BITS);
1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
                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));
1354
                    ret = 1;
1355 1356 1357 1358 1359 1360
                    goto out;
                }
            }
        } else {

            if (allocated1) {
1361
                ret = check_empty_sectors(blk1, sector_num, nb_sectors,
1362 1363
                                          filename1, buf1, quiet);
            } else {
1364
                ret = check_empty_sectors(blk2, sector_num, nb_sectors,
1365 1366 1367 1368 1369 1370
                                          filename2, buf1, quiet);
            }
            if (ret) {
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64 ": %s",
                                 sectors_to_bytes(sector_num), strerror(-ret));
1371
                    ret = 4;
1372 1373 1374 1375 1376 1377 1378 1379 1380
                }
                goto out;
            }
        }
        sector_num += nb_sectors;
        qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
    }

    if (total_sectors1 != total_sectors2) {
1381
        BlockBackend *blk_over;
1382 1383 1384 1385 1386 1387
        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;
1388
            blk_over = blk1;
1389 1390 1391
            filename_over = filename1;
        } else {
            total_sectors_over = total_sectors2;
1392
            blk_over = blk2;
1393 1394 1395 1396 1397 1398 1399 1400
            filename_over = filename2;
        }

        for (;;) {
            nb_sectors = sectors_to_process(total_sectors_over, sector_num);
            if (nb_sectors <= 0) {
                break;
            }
1401
            ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411
                                          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) {
1412
                ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
1413 1414 1415 1416 1417 1418
                                          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));
1419
                        ret = 4;
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434
                    }
                    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 已提交
1435
    blk_unref(blk2);
1436
out2:
M
Markus Armbruster 已提交
1437
    blk_unref(blk1);
1438 1439
out3:
    qemu_progress_end();
1440
out4:
1441 1442 1443
    return ret;
}

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 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
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) {
1489
        BlockDriverState *file;
1490 1491
        ret = bdrv_get_block_status(blk_bs(s->src[s->src_cur]),
                                    sector_num - s->src_cur_offset,
1492
                                    n, &n, &file);
1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503
        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. */
1504
            /* Check block status of the backing file chain to avoid
1505 1506
             * needlessly reading zeroes and limiting the iteration to the
             * buffer size */
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518
            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;
            }
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
        } 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));
1565 1566 1567
        ret = blk_pread(blk,
                        (sector_num - s->src_cur_offset) << BDRV_SECTOR_BITS,
                        buf, n << BDRV_SECTOR_BITS);
1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608
        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;
                }

1609 1610 1611
                ret = blk_pwrite_compressed(s->target,
                                            sector_num << BDRV_SECTOR_BITS,
                                            buf, n << BDRV_SECTOR_BITS);
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623
                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))
            {
1624 1625
                ret = blk_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
                                 buf, n << BDRV_SECTOR_BITS, 0);
1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636
                if (ret < 0) {
                    return ret;
                }
                break;
            }
            /* fall-through */

        case BLK_ZERO:
            if (s->has_zero_init) {
                break;
            }
E
Eric Blake 已提交
1637 1638
            ret = blk_pwrite_zeroes(s->target, sector_num << BDRV_SECTOR_BITS,
                                    n << BDRV_SECTOR_BITS, 0);
1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
            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)))
    {
1668
        ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP);
1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694
        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;
        }
1695 1696
        if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
        {
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715
            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;
        }
1716 1717
        if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
        {
1718 1719 1720 1721 1722
            allocated_done += n;
            qemu_progress_print(100.0 * allocated_done / s->allocated_sectors,
                                0);
        }

1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733
        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;
1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747
        }

        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 */
1748
        ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759
        if (ret < 0) {
            goto fail;
        }
    }

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

B
bellard 已提交
1760 1761
static int img_convert(int argc, char **argv)
{
1762
    int c, bs_n, bs_i, compress, cluster_sectors, skip_create;
1763
    int64_t ret = 0;
1764
    int progress = 0, flags, src_flags;
1765
    bool writethrough, src_writethrough;
1766
    const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
1767
    BlockDriver *drv, *proto_drv;
M
Markus Armbruster 已提交
1768
    BlockBackend **blk = NULL, *out_blk = NULL;
1769
    BlockDriverState **bs = NULL, *out_bs = NULL;
1770
    int64_t total_sectors;
1771
    int64_t *bs_sectors = NULL;
1772
    size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
B
bellard 已提交
1773
    BlockDriverInfo bdi;
1774 1775 1776
    QemuOpts *opts = NULL;
    QemuOptsList *create_opts = NULL;
    const char *out_baseimg_param;
1777
    char *options = NULL;
E
edison 已提交
1778
    const char *snapshot_name = NULL;
1779
    int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1780
    bool quiet = false;
1781
    Error *local_err = NULL;
1782
    QemuOpts *sn_opts = NULL;
1783
    ImgConvertState state;
1784
    bool image_opts = false;
B
bellard 已提交
1785 1786 1787

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

            min_sparse = sval / BDRV_SECTOR_SIZE;
            break;
        }
1877 1878 1879
        case 'p':
            progress = 1;
            break;
1880 1881 1882
        case 't':
            cache = optarg;
            break;
1883 1884 1885
        case 'T':
            src_cache = optarg;
            break;
1886 1887 1888
        case 'q':
            quiet = true;
            break;
1889 1890 1891
        case 'n':
            skip_create = 1;
            break;
1892 1893 1894 1895 1896 1897 1898
        case OPTION_OBJECT:
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                goto fail_getopt;
            }
            break;
1899 1900 1901
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
B
bellard 已提交
1902 1903
        }
    }
1904

1905 1906
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
1907
                          NULL, NULL)) {
1908 1909 1910
        goto fail_getopt;
    }

1911
    /* Initialize before goto out */
1912 1913 1914
    if (quiet) {
        progress = 0;
    }
1915 1916
    qemu_progress_init(progress, 1.0);

1917
    bs_n = argc - optind - 1;
1918
    out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
1919

1920
    if (options && has_help_option(options)) {
1921 1922 1923 1924
        ret = print_block_option_help(out_filename, out_fmt);
        goto out;
    }

1925
    if (bs_n < 1) {
F
Fam Zheng 已提交
1926
        error_exit("Must specify image file name");
1927 1928 1929
    }


1930
    if (bs_n > 1 && out_baseimg) {
1931 1932
        error_report("-B makes no sense when concatenating multiple input "
                     "images");
1933 1934
        ret = -1;
        goto out;
1935
    }
1936

1937 1938
    src_flags = 0;
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
1939 1940 1941 1942 1943
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
        goto out;
    }

1944 1945
    qemu_progress_print(0, 100);

M
Markus Armbruster 已提交
1946
    blk = g_new0(BlockBackend *, bs_n);
1947
    bs = g_new0(BlockDriverState *, bs_n);
1948
    bs_sectors = g_new(int64_t, bs_n);
1949 1950 1951

    total_sectors = 0;
    for (bs_i = 0; bs_i < bs_n; bs_i++) {
1952
        blk[bs_i] = img_open(image_opts, argv[optind + bs_i],
1953
                             fmt, src_flags, src_writethrough, quiet);
1954
        if (!blk[bs_i]) {
1955 1956 1957
            ret = -1;
            goto out;
        }
1958
        bs[bs_i] = blk_bs(blk[bs_i]);
1959
        bs_sectors[bs_i] = blk_nb_sectors(blk[bs_i]);
1960 1961 1962 1963 1964 1965
        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;
        }
1966
        total_sectors += bs_sectors[bs_i];
1967
    }
B
bellard 已提交
1968

1969
    if (sn_opts) {
1970 1971 1972 1973
        bdrv_snapshot_load_tmp(bs[0],
                               qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
                               qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
                               &local_err);
1974
    } else if (snapshot_name != NULL) {
E
edison 已提交
1975
        if (bs_n > 1) {
1976
            error_report("No support for concatenating multiple snapshot");
E
edison 已提交
1977 1978 1979
            ret = -1;
            goto out;
        }
1980 1981

        bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1982
    }
1983
    if (local_err) {
1984
        error_reportf_err(local_err, "Failed to load snapshot: ");
1985 1986
        ret = -1;
        goto out;
E
edison 已提交
1987 1988
    }

1989
    /* Find driver and parse its options */
B
bellard 已提交
1990
    drv = bdrv_find_format(out_fmt);
1991
    if (!drv) {
1992
        error_report("Unknown file format '%s'", out_fmt);
1993 1994 1995
        ret = -1;
        goto out;
    }
1996

1997
    proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
1998
    if (!proto_drv) {
1999
        error_report_err(local_err);
2000 2001 2002
        ret = -1;
        goto out;
    }
2003

M
Max Reitz 已提交
2004 2005 2006 2007 2008 2009 2010
    if (!skip_create) {
        if (!drv->create_opts) {
            error_report("Format driver '%s' does not support image creation",
                         drv->format_name);
            ret = -1;
            goto out;
        }
2011

M
Max Reitz 已提交
2012 2013 2014 2015 2016 2017
        if (!proto_drv->create_opts) {
            error_report("Protocol driver '%s' does not support image creation",
                         proto_drv->format_name);
            ret = -1;
            goto out;
        }
2018

M
Max Reitz 已提交
2019 2020
        create_opts = qemu_opts_append(create_opts, drv->create_opts);
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2021

M
Max Reitz 已提交
2022
        opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2023 2024 2025
        if (options) {
            qemu_opts_do_parse(opts, options, NULL, &local_err);
            if (local_err) {
2026
                error_report_err(local_err);
2027 2028 2029
                ret = -1;
                goto out;
            }
M
Max Reitz 已提交
2030
        }
2031

2032 2033
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512,
                            &error_abort);
M
Max Reitz 已提交
2034 2035 2036 2037
        ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
        if (ret < 0) {
            goto out;
        }
2038
    }
2039

2040
    /* Get backing file name if -o backing_file was used */
2041
    out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2042
    if (out_baseimg_param) {
2043
        out_baseimg = out_baseimg_param;
2044 2045
    }

2046
    /* Check if compression is supported */
2047
    if (compress) {
2048 2049 2050 2051
        bool encryption =
            qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
        const char *preallocation =
            qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2052

2053
        if (!drv->bdrv_co_pwritev_compressed) {
2054
            error_report("Compression not supported for this file format");
2055 2056
            ret = -1;
            goto out;
2057 2058
        }

2059
        if (encryption) {
2060 2061
            error_report("Compression and encryption not supported at "
                         "the same time");
2062 2063
            ret = -1;
            goto out;
2064
        }
2065

2066 2067
        if (preallocation
            && strcmp(preallocation, "off"))
2068 2069 2070 2071 2072 2073
        {
            error_report("Compression and preallocation not supported at "
                         "the same time");
            ret = -1;
            goto out;
        }
2074 2075
    }

2076 2077
    if (!skip_create) {
        /* Create the new image */
C
Chunyan Liu 已提交
2078
        ret = bdrv_create(drv, out_filename, opts, &local_err);
2079
        if (ret < 0) {
2080 2081
            error_reportf_err(local_err, "%s: error while converting %s: ",
                              out_filename, out_fmt);
2082
            goto out;
B
bellard 已提交
2083 2084
        }
    }
2085

2086
    flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2087
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2088 2089
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2090
        goto out;
2091 2092
    }

2093 2094 2095 2096 2097
    /* 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...
     */
2098
    out_blk = img_open_file(out_filename, out_fmt, flags, writethrough, quiet);
2099
    if (!out_blk) {
2100 2101 2102
        ret = -1;
        goto out;
    }
2103
    out_bs = blk_bs(out_blk);
B
bellard 已提交
2104

2105
    /* increase bufsectors from the default 4096 (2M) if opt_transfer
2106 2107 2108
     * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
     * as maximum. */
    bufsectors = MIN(32768,
2109 2110
                     MAX(bufsectors,
                         MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2111 2112
                             out_bs->bl.pdiscard_alignment >>
                             BDRV_SECTOR_BITS)));
2113

2114
    if (skip_create) {
2115
        int64_t output_sectors = blk_nb_sectors(out_blk);
2116
        if (output_sectors < 0) {
2117
            error_report("unable to get output image length: %s",
2118
                         strerror(-output_sectors));
2119 2120
            ret = -1;
            goto out;
2121
        } else if (output_sectors < total_sectors) {
2122 2123 2124 2125 2126 2127
            error_report("output file is smaller than input file");
            ret = -1;
            goto out;
        }
    }

2128 2129 2130 2131
    cluster_sectors = 0;
    ret = bdrv_get_info(out_bs, &bdi);
    if (ret < 0) {
        if (compress) {
2132
            error_report("could not get block driver info");
2133 2134
            goto out;
        }
2135
    } else {
2136
        compress = compress || bdi.needs_compressed_writes;
2137 2138 2139
        cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
    }

2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152
    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);
2153

2154
out:
2155 2156 2157
    if (!ret) {
        qemu_progress_print(100, 0);
    }
2158
    qemu_progress_end();
2159 2160
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
2161
    qemu_opts_del(sn_opts);
M
Markus Armbruster 已提交
2162
    blk_unref(out_blk);
2163
    g_free(bs);
M
Markus Armbruster 已提交
2164 2165 2166 2167 2168 2169
    if (blk) {
        for (bs_i = 0; bs_i < bs_n; bs_i++) {
            blk_unref(blk[bs_i]);
        }
        g_free(blk);
    }
2170
    g_free(bs_sectors);
2171 2172 2173
fail_getopt:
    g_free(options);

2174 2175 2176
    if (ret) {
        return 1;
    }
B
bellard 已提交
2177 2178 2179
    return 0;
}

B
bellard 已提交
2180

B
bellard 已提交
2181 2182 2183 2184 2185 2186 2187 2188 2189
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");
2190 2191
    bdrv_snapshot_dump(fprintf, stdout, NULL);
    printf("\n");
B
bellard 已提交
2192 2193
    for(i = 0; i < nb_sns; i++) {
        sn = &sn_tab[i];
2194 2195
        bdrv_snapshot_dump(fprintf, stdout, sn);
        printf("\n");
B
bellard 已提交
2196
    }
2197
    g_free(sn_tab);
B
bellard 已提交
2198 2199
}

2200 2201 2202 2203
static void dump_json_image_info_list(ImageInfoList *list)
{
    QString *str;
    QObject *obj;
2204
    Visitor *v = qobject_output_visitor_new(&obj);
2205 2206 2207

    visit_type_ImageInfoList(v, NULL, &list, &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
static void dump_json_image_info(ImageInfo *info)
{
    QString *str;
    QObject *obj;
2220
    Visitor *v = qobject_output_visitor_new(&obj);
2221 2222 2223

    visit_type_ImageInfo(v, NULL, &info, &error_abort);
    visit_complete(v, &obj);
2224 2225 2226 2227
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
2228
    visit_free(v);
2229 2230 2231
    QDECREF(str);
}

2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242
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;

2243
        bdrv_image_info_dump(fprintf, stdout, elem->value);
2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263
    }
}

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.
 */
2264 2265
static ImageInfoList *collect_image_info_list(bool image_opts,
                                              const char *filename,
2266 2267 2268 2269 2270 2271
                                              const char *fmt,
                                              bool chain)
{
    ImageInfoList *head = NULL;
    ImageInfoList **last = &head;
    GHashTable *filenames;
2272
    Error *err = NULL;
2273 2274 2275 2276

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

    while (filename) {
M
Markus Armbruster 已提交
2277
        BlockBackend *blk;
2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288
        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);

2289
        blk = img_open(image_opts, filename, fmt,
2290
                       BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false);
2291
        if (!blk) {
2292 2293
            goto err;
        }
2294
        bs = blk_bs(blk);
2295

2296
        bdrv_query_image_info(bs, &info, &err);
2297
        if (err) {
2298
            error_report_err(err);
M
Markus Armbruster 已提交
2299
            blk_unref(blk);
2300
            goto err;
2301
        }
2302 2303 2304 2305 2306 2307

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

M
Markus Armbruster 已提交
2308
        blk_unref(blk);
2309 2310 2311 2312 2313 2314

        filename = fmt = NULL;
        if (chain) {
            if (info->has_full_backing_filename) {
                filename = info->full_backing_filename;
            } else if (info->has_backing_filename) {
2315 2316 2317 2318
                error_report("Could not determine absolute backing filename,"
                             " but backing filename '%s' present",
                             info->backing_filename);
                goto err;
2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333
            }
            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;
}

2334 2335 2336 2337
static int img_info(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
2338
    bool chain = false;
2339
    const char *filename, *fmt, *output;
2340
    ImageInfoList *list;
2341
    bool image_opts = false;
2342

B
bellard 已提交
2343
    fmt = NULL;
2344
    output = NULL;
B
bellard 已提交
2345
    for(;;) {
2346 2347 2348 2349 2350
        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},
2351
            {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2352
            {"object", required_argument, 0, OPTION_OBJECT},
2353
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2354 2355 2356 2357
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "f:h",
                        long_options, &option_index);
2358
        if (c == -1) {
B
bellard 已提交
2359
            break;
2360
        }
B
bellard 已提交
2361
        switch(c) {
J
Jes Sorensen 已提交
2362
        case '?':
B
bellard 已提交
2363 2364 2365 2366 2367 2368
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2369 2370 2371
        case OPTION_OUTPUT:
            output = optarg;
            break;
2372 2373 2374
        case OPTION_BACKING_CHAIN:
            chain = true;
            break;
2375 2376 2377 2378 2379 2380 2381 2382
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2383 2384 2385
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
B
bellard 已提交
2386 2387
        }
    }
2388
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2389
        error_exit("Expecting one image file name");
2390
    }
B
bellard 已提交
2391 2392
    filename = argv[optind++];

2393 2394 2395 2396 2397 2398
    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.");
2399 2400
        return 1;
    }
2401

2402 2403
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2404
                          NULL, NULL)) {
2405 2406 2407
        return 1;
    }

2408
    list = collect_image_info_list(image_opts, filename, fmt, chain);
2409
    if (!list) {
2410
        return 1;
B
bellard 已提交
2411
    }
2412 2413 2414

    switch (output_format) {
    case OFORMAT_HUMAN:
2415
        dump_human_image_info_list(list);
2416 2417
        break;
    case OFORMAT_JSON:
2418 2419 2420 2421 2422
        if (chain) {
            dump_json_image_info_list(list);
        } else {
            dump_json_image_info(list->value);
        }
2423
        break;
B
bellard 已提交
2424
    }
2425

2426
    qapi_free_ImageInfoList(list);
B
bellard 已提交
2427 2428 2429
    return 0;
}

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

    /* 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 (;;) {
2487 2488
        ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
                                    &file);
P
Paolo Bonzini 已提交
2489 2490 2491 2492 2493 2494 2495
        if (ret < 0) {
            return ret;
        }
        assert(nb_sectors);
        if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
            break;
        }
2496
        bs = backing_bs(bs);
P
Paolo Bonzini 已提交
2497 2498 2499 2500 2501 2502 2503 2504
        if (bs == NULL) {
            ret = 0;
            break;
        }

        depth++;
    }

J
John Snow 已提交
2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518
    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 已提交
2519 2520 2521
    return 0;
}

2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542
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 已提交
2543 2544 2545 2546
static int img_map(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
M
Markus Armbruster 已提交
2547
    BlockBackend *blk;
P
Paolo Bonzini 已提交
2548 2549 2550 2551 2552
    BlockDriverState *bs;
    const char *filename, *fmt, *output;
    int64_t length;
    MapEntry curr = { .length = 0 }, next;
    int ret = 0;
2553
    bool image_opts = false;
P
Paolo Bonzini 已提交
2554 2555 2556 2557 2558 2559 2560 2561 2562

    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},
2563
            {"object", required_argument, 0, OPTION_OBJECT},
2564
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
P
Paolo Bonzini 已提交
2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582
            {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;
2583 2584 2585 2586 2587 2588 2589 2590
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2591 2592 2593
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
P
Paolo Bonzini 已提交
2594 2595
        }
    }
F
Fam Zheng 已提交
2596 2597
    if (optind != argc - 1) {
        error_exit("Expecting one image file name");
P
Paolo Bonzini 已提交
2598
    }
F
Fam Zheng 已提交
2599
    filename = argv[optind];
P
Paolo Bonzini 已提交
2600 2601 2602 2603 2604 2605 2606 2607 2608 2609

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

2610 2611
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2612
                          NULL, NULL)) {
2613 2614 2615
        return 1;
    }

2616
    blk = img_open(image_opts, filename, fmt, 0, false, false);
2617 2618
    if (!blk) {
        return 1;
P
Paolo Bonzini 已提交
2619
    }
2620
    bs = blk_bs(blk);
P
Paolo Bonzini 已提交
2621 2622 2623 2624 2625

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

2626
    length = blk_getlength(blk);
P
Paolo Bonzini 已提交
2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643
    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;
        }

2644
        if (entry_mergeable(&curr, &next)) {
P
Paolo Bonzini 已提交
2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657
            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 已提交
2658
    blk_unref(blk);
P
Paolo Bonzini 已提交
2659 2660 2661
    return ret < 0;
}

2662 2663 2664 2665 2666
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

2667
static int img_snapshot(int argc, char **argv)
2668
{
M
Markus Armbruster 已提交
2669
    BlockBackend *blk;
2670 2671 2672
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
2673
    int c, ret = 0, bdrv_oflags;
2674 2675
    int action = 0;
    qemu_timeval tv;
2676
    bool quiet = false;
2677
    Error *err = NULL;
2678
    bool image_opts = false;
2679

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

2748
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2749
        error_exit("Expecting one image file name");
2750
    }
2751 2752
    filename = argv[optind++];

2753 2754
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2755
                          NULL, NULL)) {
2756 2757 2758
        return 1;
    }

2759
    /* Open the image */
2760
    blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet);
2761 2762
    if (!blk) {
        return 1;
2763
    }
2764
    bs = blk_bs(blk);
2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780

    /* 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);
2781
        if (ret) {
2782
            error_report("Could not create snapshot '%s': %d (%s)",
2783
                snapshot_name, ret, strerror(-ret));
2784
        }
2785 2786 2787 2788
        break;

    case SNAPSHOT_APPLY:
        ret = bdrv_snapshot_goto(bs, snapshot_name);
2789
        if (ret) {
2790
            error_report("Could not apply snapshot '%s': %d (%s)",
2791
                snapshot_name, ret, strerror(-ret));
2792
        }
2793 2794 2795
        break;

    case SNAPSHOT_DELETE:
2796
        bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2797
        if (err) {
2798 2799
            error_reportf_err(err, "Could not delete snapshot '%s': ",
                              snapshot_name);
2800
            ret = 1;
2801
        }
2802 2803 2804 2805
        break;
    }

    /* Cleanup */
M
Markus Armbruster 已提交
2806
    blk_unref(blk);
2807 2808 2809
    if (ret) {
        return 1;
    }
2810
    return 0;
2811 2812
}

K
Kevin Wolf 已提交
2813 2814
static int img_rebase(int argc, char **argv)
{
M
Markus Armbruster 已提交
2815
    BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
P
Paolo Bonzini 已提交
2816 2817
    uint8_t *buf_old = NULL;
    uint8_t *buf_new = NULL;
2818
    BlockDriverState *bs = NULL;
K
Kevin Wolf 已提交
2819
    char *filename;
2820 2821
    const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
    int c, flags, src_flags, ret;
2822
    bool writethrough, src_writethrough;
K
Kevin Wolf 已提交
2823
    int unsafe = 0;
2824
    int progress = 0;
2825
    bool quiet = false;
2826
    Error *local_err = NULL;
2827
    bool image_opts = false;
K
Kevin Wolf 已提交
2828 2829

    /* Parse commandline parameters */
K
Kevin Wolf 已提交
2830
    fmt = NULL;
2831
    cache = BDRV_DEFAULT_CACHE;
2832
    src_cache = BDRV_DEFAULT_CACHE;
K
Kevin Wolf 已提交
2833 2834 2835
    out_baseimg = NULL;
    out_basefmt = NULL;
    for(;;) {
2836 2837 2838
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
2839
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2840 2841 2842 2843
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "hf:F:b:upt:T:q",
                        long_options, NULL);
2844
        if (c == -1) {
K
Kevin Wolf 已提交
2845
            break;
2846
        }
K
Kevin Wolf 已提交
2847
        switch(c) {
J
Jes Sorensen 已提交
2848
        case '?':
K
Kevin Wolf 已提交
2849 2850 2851
        case 'h':
            help();
            return 0;
K
Kevin Wolf 已提交
2852 2853 2854
        case 'f':
            fmt = optarg;
            break;
K
Kevin Wolf 已提交
2855 2856 2857 2858 2859 2860 2861 2862 2863
        case 'F':
            out_basefmt = optarg;
            break;
        case 'b':
            out_baseimg = optarg;
            break;
        case 'u':
            unsafe = 1;
            break;
2864 2865 2866
        case 'p':
            progress = 1;
            break;
2867 2868 2869
        case 't':
            cache = optarg;
            break;
2870 2871 2872
        case 'T':
            src_cache = optarg;
            break;
2873 2874 2875
        case 'q':
            quiet = true;
            break;
2876 2877 2878 2879 2880 2881 2882 2883
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
2884 2885 2886
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
K
Kevin Wolf 已提交
2887 2888 2889
        }
    }

2890 2891 2892 2893
    if (quiet) {
        progress = 0;
    }

F
Fam Zheng 已提交
2894 2895 2896 2897 2898
    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)");
2899
    }
K
Kevin Wolf 已提交
2900 2901
    filename = argv[optind++];

2902 2903
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
2904
                          NULL, NULL)) {
2905 2906 2907
        return 1;
    }

2908 2909 2910
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

2911
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2912
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2913 2914
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2915
        goto out;
2916 2917
    }

2918 2919
    src_flags = 0;
    ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2920 2921
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
2922
        goto out;
2923 2924
    }

2925 2926 2927 2928
    /* 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 已提交
2929 2930 2931 2932 2933 2934
    /*
     * 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.
     */
2935
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
2936
    if (!blk) {
2937 2938
        ret = -1;
        goto out;
2939
    }
2940
    bs = blk_bs(blk);
K
Kevin Wolf 已提交
2941 2942

    if (out_basefmt != NULL) {
2943
        if (bdrv_find_format(out_basefmt) == NULL) {
2944
            error_report("Invalid format name: '%s'", out_basefmt);
2945 2946
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
2947 2948 2949 2950
        }
    }

    /* For safe rebasing we need to compare old and new backing file */
2951
    if (!unsafe) {
2952
        char backing_name[PATH_MAX];
2953 2954 2955 2956 2957 2958
        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 已提交
2959 2960

        bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2961
        blk_old_backing = blk_new_open(backing_name, NULL,
2962 2963
                                       options, src_flags, &local_err);
        if (!blk_old_backing) {
2964 2965 2966
            error_reportf_err(local_err,
                              "Could not open old backing file '%s': ",
                              backing_name);
2967
            ret = -1;
2968
            goto out;
K
Kevin Wolf 已提交
2969
        }
2970

2971
        if (out_baseimg[0]) {
2972 2973 2974 2975 2976 2977 2978
            if (out_basefmt) {
                options = qdict_new();
                qdict_put(options, "driver", qstring_from_str(out_basefmt));
            } else {
                options = NULL;
            }

2979
            blk_new_backing = blk_new_open(out_baseimg, NULL,
2980 2981
                                           options, src_flags, &local_err);
            if (!blk_new_backing) {
2982 2983 2984
                error_reportf_err(local_err,
                                  "Could not open new backing file '%s': ",
                                  out_baseimg);
2985
                ret = -1;
2986 2987
                goto out;
            }
K
Kevin Wolf 已提交
2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000
        }
    }

    /*
     * 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) {
3001 3002 3003
        int64_t num_sectors;
        int64_t old_backing_num_sectors;
        int64_t new_backing_num_sectors = 0;
K
Kevin Wolf 已提交
3004
        uint64_t sector;
3005
        int n;
3006
        float local_progress = 0;
3007

3008 3009
        buf_old = blk_blockalign(blk, IO_BUF_SIZE);
        buf_new = blk_blockalign(blk, IO_BUF_SIZE);
K
Kevin Wolf 已提交
3010

3011
        num_sectors = blk_nb_sectors(blk);
3012 3013 3014 3015 3016 3017
        if (num_sectors < 0) {
            error_report("Could not get size of '%s': %s",
                         filename, strerror(-num_sectors));
            ret = -1;
            goto out;
        }
3018
        old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
3019
        if (old_backing_num_sectors < 0) {
3020
            char backing_name[PATH_MAX];
3021 3022 3023 3024 3025 3026 3027

            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;
        }
3028 3029
        if (blk_new_backing) {
            new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
3030 3031 3032 3033 3034 3035
            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;
            }
3036
        }
K
Kevin Wolf 已提交
3037

3038 3039 3040 3041 3042
        if (num_sectors != 0) {
            local_progress = (float)100 /
                (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
        }

K
Kevin Wolf 已提交
3043 3044 3045 3046 3047 3048 3049 3050 3051 3052
        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 */
3053
            ret = bdrv_is_allocated(bs, sector, n, &n);
3054 3055 3056 3057 3058
            if (ret < 0) {
                error_report("error while reading image metadata: %s",
                             strerror(-ret));
                goto out;
            }
3059
            if (ret) {
K
Kevin Wolf 已提交
3060 3061 3062
                continue;
            }

3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073
            /*
             * 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;
                }

3074 3075
                ret = blk_pread(blk_old_backing, sector << BDRV_SECTOR_BITS,
                                buf_old, n << BDRV_SECTOR_BITS);
3076 3077 3078 3079
                if (ret < 0) {
                    error_report("error while reading from old backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3080
            }
3081

3082
            if (sector >= new_backing_num_sectors || !blk_new_backing) {
3083 3084 3085 3086 3087 3088
                memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
            } else {
                if (sector + n > new_backing_num_sectors) {
                    n = new_backing_num_sectors - sector;
                }

3089 3090
                ret = blk_pread(blk_new_backing, sector << BDRV_SECTOR_BITS,
                                buf_new, n << BDRV_SECTOR_BITS);
3091 3092 3093 3094
                if (ret < 0) {
                    error_report("error while reading from new backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
3095 3096 3097 3098 3099 3100 3101 3102 3103
            }

            /* 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,
3104
                    buf_new + written * 512, n - written, &pnum))
K
Kevin Wolf 已提交
3105
                {
3106 3107 3108 3109
                    ret = blk_pwrite(blk,
                                     (sector + written) << BDRV_SECTOR_BITS,
                                     buf_old + written * 512,
                                     pnum << BDRV_SECTOR_BITS, 0);
K
Kevin Wolf 已提交
3110
                    if (ret < 0) {
3111
                        error_report("Error while writing to COW image: %s",
K
Kevin Wolf 已提交
3112
                            strerror(-ret));
3113
                        goto out;
K
Kevin Wolf 已提交
3114 3115 3116 3117 3118
                    }
                }

                written += pnum;
            }
3119
            qemu_progress_print(local_progress, 100);
K
Kevin Wolf 已提交
3120 3121 3122 3123 3124 3125 3126 3127
        }
    }

    /*
     * 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.
     */
3128 3129 3130 3131 3132 3133
    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 已提交
3134
    if (ret == -ENOSPC) {
3135 3136
        error_report("Could not change the backing file to '%s': No "
                     "space left in the file header", out_baseimg);
K
Kevin Wolf 已提交
3137
    } else if (ret < 0) {
3138
        error_report("Could not change the backing file to '%s': %s",
K
Kevin Wolf 已提交
3139 3140 3141
            out_baseimg, strerror(-ret));
    }

3142
    qemu_progress_print(100, 0);
K
Kevin Wolf 已提交
3143 3144 3145 3146 3147 3148
    /*
     * 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.
     */
3149
out:
3150
    qemu_progress_end();
K
Kevin Wolf 已提交
3151 3152
    /* Cleanup */
    if (!unsafe) {
M
Markus Armbruster 已提交
3153 3154
        blk_unref(blk_old_backing);
        blk_unref(blk_new_backing);
K
Kevin Wolf 已提交
3155
    }
P
Paolo Bonzini 已提交
3156 3157
    qemu_vfree(buf_old);
    qemu_vfree(buf_new);
K
Kevin Wolf 已提交
3158

M
Markus Armbruster 已提交
3159
    blk_unref(blk);
3160 3161 3162
    if (ret) {
        return 1;
    }
K
Kevin Wolf 已提交
3163 3164 3165
    return 0;
}

3166 3167
static int img_resize(int argc, char **argv)
{
3168
    Error *err = NULL;
3169 3170 3171
    int c, ret, relative;
    const char *filename, *fmt, *size;
    int64_t n, total_size;
3172
    bool quiet = false;
M
Markus Armbruster 已提交
3173
    BlockBackend *blk = NULL;
3174
    QemuOpts *param;
3175

3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186
    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 */
            }
3187 3188
        },
    };
3189
    bool image_opts = false;
3190

K
Kevin Wolf 已提交
3191 3192 3193
    /* Remove size from argv manually so that negative numbers are not treated
     * as options by getopt. */
    if (argc < 3) {
F
Fam Zheng 已提交
3194
        error_exit("Not enough arguments");
K
Kevin Wolf 已提交
3195 3196 3197 3198 3199 3200
        return 1;
    }

    size = argv[--argc];

    /* Parse getopt arguments */
3201 3202
    fmt = NULL;
    for(;;) {
3203 3204 3205
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3206
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3207 3208 3209 3210
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "f:hq",
                        long_options, NULL);
3211 3212 3213 3214
        if (c == -1) {
            break;
        }
        switch(c) {
J
Jes Sorensen 已提交
3215
        case '?':
3216 3217 3218 3219 3220 3221
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
3222 3223 3224
        case 'q':
            quiet = true;
            break;
3225 3226 3227 3228 3229 3230 3231 3232
        case OPTION_OBJECT: {
            QemuOpts *opts;
            opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                           optarg, true);
            if (!opts) {
                return 1;
            }
        }   break;
3233 3234 3235
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
3236 3237
        }
    }
3238
    if (optind != argc - 1) {
F
Fam Zheng 已提交
3239
        error_exit("Expecting one image file name");
3240 3241 3242
    }
    filename = argv[optind++];

3243 3244
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3245
                          NULL, NULL)) {
3246 3247 3248
        return 1;
    }

3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264
    /* 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 */
3265
    param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3266
    qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3267 3268
    if (err) {
        error_report_err(err);
3269
        ret = -1;
3270
        qemu_opts_del(param);
3271
        goto out;
3272
    }
3273 3274
    n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
    qemu_opts_del(param);
3275

3276
    blk = img_open(image_opts, filename, fmt,
3277
                   BDRV_O_RDWR, false, quiet);
3278
    if (!blk) {
3279 3280
        ret = -1;
        goto out;
3281
    }
3282 3283

    if (relative) {
3284
        total_size = blk_getlength(blk) + n * relative;
3285 3286 3287 3288
    } else {
        total_size = n;
    }
    if (total_size <= 0) {
3289
        error_report("New image size must be positive");
3290 3291
        ret = -1;
        goto out;
3292 3293
    }

3294
    ret = blk_truncate(blk, total_size);
3295 3296
    switch (ret) {
    case 0:
3297
        qprintf(quiet, "Image resized.\n");
3298 3299
        break;
    case -ENOTSUP:
3300
        error_report("This image does not support resize");
3301 3302
        break;
    case -EACCES:
3303
        error_report("Image is read-only");
3304 3305
        break;
    default:
3306
        error_report("Error resizing image: %s", strerror(-ret));
3307 3308
        break;
    }
3309
out:
M
Markus Armbruster 已提交
3310
    blk_unref(blk);
3311 3312 3313
    if (ret) {
        return 1;
    }
3314 3315 3316
    return 0;
}

3317
static void amend_status_cb(BlockDriverState *bs,
3318 3319
                            int64_t offset, int64_t total_work_size,
                            void *opaque)
3320 3321 3322 3323
{
    qemu_progress_print(100.f * offset / total_work_size, 0);
}

M
Max Reitz 已提交
3324 3325
static int img_amend(int argc, char **argv)
{
3326
    Error *err = NULL;
M
Max Reitz 已提交
3327 3328
    int c, ret = 0;
    char *options = NULL;
3329 3330
    QemuOptsList *create_opts = NULL;
    QemuOpts *opts = NULL;
3331 3332
    const char *fmt = NULL, *filename, *cache;
    int flags;
3333
    bool writethrough;
3334
    bool quiet = false, progress = false;
M
Markus Armbruster 已提交
3335
    BlockBackend *blk = NULL;
M
Max Reitz 已提交
3336
    BlockDriverState *bs = NULL;
3337
    bool image_opts = false;
M
Max Reitz 已提交
3338

3339
    cache = BDRV_DEFAULT_CACHE;
M
Max Reitz 已提交
3340
    for (;;) {
3341 3342 3343
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"object", required_argument, 0, OPTION_OBJECT},
3344
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3345 3346 3347 3348
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "ho:f:t:pq",
                        long_options, NULL);
M
Max Reitz 已提交
3349 3350 3351 3352 3353 3354 3355 3356 3357 3358
        if (c == -1) {
            break;
        }

        switch (c) {
            case 'h':
            case '?':
                help();
                break;
            case 'o':
3359 3360 3361
                if (!is_valid_option_list(optarg)) {
                    error_report("Invalid option list: %s", optarg);
                    ret = -1;
3362
                    goto out_no_progress;
3363 3364 3365 3366 3367 3368 3369 3370
                }
                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 已提交
3371 3372 3373 3374
                break;
            case 'f':
                fmt = optarg;
                break;
3375 3376 3377
            case 't':
                cache = optarg;
                break;
3378 3379 3380
            case 'p':
                progress = true;
                break;
M
Max Reitz 已提交
3381 3382 3383
            case 'q':
                quiet = true;
                break;
3384 3385 3386 3387 3388 3389 3390 3391
            case OPTION_OBJECT:
                opts = qemu_opts_parse_noisily(&qemu_object_opts,
                                               optarg, true);
                if (!opts) {
                    ret = -1;
                    goto out_no_progress;
                }
                break;
3392 3393 3394
            case OPTION_IMAGE_OPTS:
                image_opts = true;
                break;
M
Max Reitz 已提交
3395 3396 3397
        }
    }

3398
    if (!options) {
F
Fam Zheng 已提交
3399
        error_exit("Must specify options (-o)");
M
Max Reitz 已提交
3400 3401
    }

3402 3403
    if (qemu_opts_foreach(&qemu_object_opts,
                          user_creatable_add_opts_foreach,
3404
                          NULL, NULL)) {
3405 3406 3407 3408
        ret = -1;
        goto out_no_progress;
    }

3409 3410 3411 3412 3413
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);

3414 3415 3416 3417 3418 3419
    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 已提交
3420 3421
    }

3422
    if (optind != argc - 1) {
M
Max Reitz 已提交
3423 3424 3425
        error_report("Expecting one image file name");
        ret = -1;
        goto out;
3426
    }
M
Max Reitz 已提交
3427

3428 3429
    flags = BDRV_O_RDWR;
    ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3430 3431 3432 3433 3434
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        goto out;
    }

3435
    blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3436
    if (!blk) {
M
Max Reitz 已提交
3437 3438 3439
        ret = -1;
        goto out;
    }
3440
    bs = blk_bs(blk);
M
Max Reitz 已提交
3441 3442 3443

    fmt = bs->drv->format_name;

3444
    if (has_help_option(options)) {
3445
        /* If the format was auto-detected, print option help here */
M
Max Reitz 已提交
3446 3447 3448 3449
        ret = print_block_option_help(filename, fmt);
        goto out;
    }

3450 3451 3452 3453 3454 3455 3456
    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 已提交
3457
    create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3458
    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
P
Paolo Bonzini 已提交
3459 3460 3461 3462 3463
    qemu_opts_do_parse(opts, options, NULL, &err);
    if (err) {
        error_report_err(err);
        ret = -1;
        goto out;
M
Max Reitz 已提交
3464 3465
    }

3466 3467
    /* In case the driver does not call amend_status_cb() */
    qemu_progress_print(0.f, 0);
3468
    ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
3469
    qemu_progress_print(100.f, 0);
M
Max Reitz 已提交
3470 3471 3472 3473 3474 3475
    if (ret < 0) {
        error_report("Error while amending options: %s", strerror(-ret));
        goto out;
    }

out:
3476 3477
    qemu_progress_end();

3478
out_no_progress:
M
Markus Armbruster 已提交
3479
    blk_unref(blk);
3480 3481
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
3482 3483
    g_free(options);

M
Max Reitz 已提交
3484 3485 3486 3487 3488 3489
    if (ret) {
        return 1;
    }
    return 0;
}

K
Kevin Wolf 已提交
3490 3491 3492
typedef struct BenchData {
    BlockBackend *blk;
    uint64_t image_size;
K
Kevin Wolf 已提交
3493
    bool write;
K
Kevin Wolf 已提交
3494
    int bufsize;
3495
    int step;
K
Kevin Wolf 已提交
3496 3497
    int nrreq;
    int n;
3498 3499
    int flush_interval;
    bool drain_on_flush;
K
Kevin Wolf 已提交
3500 3501 3502 3503
    uint8_t *buf;
    QEMUIOVector *qiov;

    int in_flight;
3504
    bool in_flush;
K
Kevin Wolf 已提交
3505 3506 3507
    uint64_t offset;
} BenchData;

3508 3509 3510
static void bench_undrained_flush_cb(void *opaque, int ret)
{
    if (ret < 0) {
3511
        error_report("Failed flush request: %s", strerror(-ret));
3512 3513 3514 3515
        exit(EXIT_FAILURE);
    }
}

K
Kevin Wolf 已提交
3516 3517 3518 3519 3520 3521
static void bench_cb(void *opaque, int ret)
{
    BenchData *b = opaque;
    BlockAIOCB *acb;

    if (ret < 0) {
3522
        error_report("Failed request: %s", strerror(-ret));
K
Kevin Wolf 已提交
3523 3524
        exit(EXIT_FAILURE);
    }
3525 3526 3527 3528 3529 3530 3531 3532

    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 已提交
3533 3534
        b->n--;
        b->in_flight--;
3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557

        /* 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 已提交
3558 3559 3560
    }

    while (b->n > b->in_flight && b->in_flight < b->nrreq) {
3561 3562 3563 3564 3565 3566 3567 3568
        int64_t offset = b->offset;
        /* blk_aio_* might look for completed I/Os and kick bench_cb
         * again, so make sure this operation is counted by in_flight
         * and b->offset is ready for the next submission.
         */
        b->in_flight++;
        b->offset += b->step;
        b->offset %= b->image_size;
K
Kevin Wolf 已提交
3569
        if (b->write) {
3570
            acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
K
Kevin Wolf 已提交
3571
        } else {
3572
            acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
K
Kevin Wolf 已提交
3573
        }
K
Kevin Wolf 已提交
3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586
        if (!acb) {
            error_report("Failed to issue request");
            exit(EXIT_FAILURE);
        }
    }
}

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 已提交
3587
    bool is_write = false;
K
Kevin Wolf 已提交
3588 3589
    int count = 75000;
    int depth = 64;
3590
    int64_t offset = 0;
K
Kevin Wolf 已提交
3591
    size_t bufsize = 4096;
K
Kevin Wolf 已提交
3592
    int pattern = 0;
3593
    size_t step = 0;
3594 3595
    int flush_interval = 0;
    bool drain_on_flush = true;
K
Kevin Wolf 已提交
3596 3597 3598 3599
    int64_t image_size;
    BlockBackend *blk = NULL;
    BenchData data = {};
    int flags = 0;
3600
    bool writethrough = false;
K
Kevin Wolf 已提交
3601 3602 3603 3604 3605 3606
    struct timeval t1, t2;
    int i;

    for (;;) {
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
3607
            {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
K
Kevin Wolf 已提交
3608
            {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
K
Kevin Wolf 已提交
3609
            {"pattern", required_argument, 0, OPTION_PATTERN},
3610
            {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
K
Kevin Wolf 已提交
3611 3612
            {0, 0, 0, 0}
        };
3613
        c = getopt_long(argc, argv, "hc:d:f:no:qs:S:t:w", long_options, NULL);
K
Kevin Wolf 已提交
3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624
        if (c == -1) {
            break;
        }

        switch (c) {
        case 'h':
        case '?':
            help();
            break;
        case 'c':
        {
3625 3626 3627
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
K
Kevin Wolf 已提交
3628 3629 3630
                error_report("Invalid request count specified");
                return 1;
            }
3631
            count = res;
K
Kevin Wolf 已提交
3632 3633 3634 3635
            break;
        }
        case 'd':
        {
3636 3637 3638
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
K
Kevin Wolf 已提交
3639 3640 3641
                error_report("Invalid queue depth specified");
                return 1;
            }
3642
            depth = res;
K
Kevin Wolf 已提交
3643 3644 3645 3646 3647 3648 3649 3650
            break;
        }
        case 'f':
            fmt = optarg;
            break;
        case 'n':
            flags |= BDRV_O_NATIVE_AIO;
            break;
3651 3652 3653 3654
        case 'o':
        {
            char *end;
            errno = 0;
3655
            offset = qemu_strtosz(optarg, &end);
3656 3657 3658 3659 3660 3661 3662
            if (offset < 0|| *end) {
                error_report("Invalid offset specified");
                return 1;
            }
            break;
        }
            break;
K
Kevin Wolf 已提交
3663 3664 3665 3666 3667 3668 3669 3670
        case 'q':
            quiet = true;
            break;
        case 's':
        {
            int64_t sval;
            char *end;

3671
            sval = qemu_strtosz(optarg, &end);
K
Kevin Wolf 已提交
3672 3673 3674 3675 3676 3677 3678 3679
            if (sval < 0 || sval > INT_MAX || *end) {
                error_report("Invalid buffer size specified");
                return 1;
            }

            bufsize = sval;
            break;
        }
3680 3681 3682 3683 3684
        case 'S':
        {
            int64_t sval;
            char *end;

3685
            sval = qemu_strtosz(optarg, &end);
3686 3687 3688 3689 3690 3691 3692 3693
            if (sval < 0 || sval > INT_MAX || *end) {
                error_report("Invalid step size specified");
                return 1;
            }

            step = sval;
            break;
        }
K
Kevin Wolf 已提交
3694 3695 3696 3697 3698 3699 3700 3701
        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 已提交
3702 3703 3704 3705 3706 3707
        case 'w':
            flags |= BDRV_O_RDWR;
            is_write = true;
            break;
        case OPTION_PATTERN:
        {
3708 3709 3710
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
K
Kevin Wolf 已提交
3711 3712 3713
                error_report("Invalid pattern byte specified");
                return 1;
            }
3714
            pattern = res;
K
Kevin Wolf 已提交
3715 3716
            break;
        }
3717 3718
        case OPTION_FLUSH_INTERVAL:
        {
3719 3720 3721
            unsigned long res;

            if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
3722 3723 3724
                error_report("Invalid flush interval specified");
                return 1;
            }
3725
            flush_interval = res;
3726 3727 3728 3729 3730
            break;
        }
        case OPTION_NO_DRAIN:
            drain_on_flush = false;
            break;
K
Kevin Wolf 已提交
3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
        }
    }

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

3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752
    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 已提交
3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765
    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) {
3766 3767 3768 3769 3770 3771 3772 3773 3774 3775
        .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 已提交
3776
    };
3777
    printf("Sending %d %s requests, %d bytes each, %d in parallel "
3778
           "(starting at offset %" PRId64 ", step size %d)\n",
3779
           data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
3780
           data.offset, data.step);
3781 3782 3783
    if (flush_interval) {
        printf("Sending flush every %d requests\n", flush_interval);
    }
K
Kevin Wolf 已提交
3784 3785

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

K
Kevin Wolf 已提交
3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811
    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) {
R
Reda Sallahi 已提交
3812 3813 3814 3815 3816 3817 3818 3819 3820
        return 1;
    }
    return 0;
}

#define C_BS      01
#define C_COUNT   02
#define C_IF      04
#define C_OF      010
R
Reda Sallahi 已提交
3821
#define C_SKIP    020
R
Reda Sallahi 已提交
3822 3823 3824 3825 3826 3827 3828 3829 3830 3831

struct DdInfo {
    unsigned int flags;
    int64_t count;
};

struct DdIo {
    int bsz;    /* Block size */
    char *filename;
    uint8_t *buf;
R
Reda Sallahi 已提交
3832
    int64_t offset;
R
Reda Sallahi 已提交
3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847
};

struct DdOpts {
    const char *name;
    int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
    unsigned int flag;
};

static int img_dd_bs(const char *arg,
                     struct DdIo *in, struct DdIo *out,
                     struct DdInfo *dd)
{
    char *end;
    int64_t res;

3848
    res = qemu_strtosz(arg, &end);
R
Reda Sallahi 已提交
3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864

    if (res <= 0 || res > INT_MAX || *end) {
        error_report("invalid number: '%s'", arg);
        return 1;
    }
    in->bsz = out->bsz = res;

    return 0;
}

static int img_dd_count(const char *arg,
                        struct DdIo *in, struct DdIo *out,
                        struct DdInfo *dd)
{
    char *end;

3865
    dd->count = qemu_strtosz(arg, &end);
R
Reda Sallahi 已提交
3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892

    if (dd->count < 0 || *end) {
        error_report("invalid number: '%s'", arg);
        return 1;
    }

    return 0;
}

static int img_dd_if(const char *arg,
                     struct DdIo *in, struct DdIo *out,
                     struct DdInfo *dd)
{
    in->filename = g_strdup(arg);

    return 0;
}

static int img_dd_of(const char *arg,
                     struct DdIo *in, struct DdIo *out,
                     struct DdInfo *dd)
{
    out->filename = g_strdup(arg);

    return 0;
}

R
Reda Sallahi 已提交
3893 3894 3895 3896 3897 3898
static int img_dd_skip(const char *arg,
                       struct DdIo *in, struct DdIo *out,
                       struct DdInfo *dd)
{
    char *end;

3899
    in->offset = qemu_strtosz(arg, &end);
R
Reda Sallahi 已提交
3900 3901 3902 3903 3904 3905 3906 3907 3908

    if (in->offset < 0 || *end) {
        error_report("invalid number: '%s'", arg);
        return 1;
    }

    return 0;
}

R
Reda Sallahi 已提交
3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931
static int img_dd(int argc, char **argv)
{
    int ret = 0;
    char *arg = NULL;
    char *tmp;
    BlockDriver *drv = NULL, *proto_drv = NULL;
    BlockBackend *blk1 = NULL, *blk2 = NULL;
    QemuOpts *opts = NULL;
    QemuOptsList *create_opts = NULL;
    Error *local_err = NULL;
    bool image_opts = false;
    int c, i;
    const char *out_fmt = "raw";
    const char *fmt = NULL;
    int64_t size = 0;
    int64_t block_count = 0, out_pos, in_pos;
    struct DdInfo dd = {
        .flags = 0,
        .count = 0,
    };
    struct DdIo in = {
        .bsz = 512, /* Block size is by default 512 bytes */
        .filename = NULL,
R
Reda Sallahi 已提交
3932 3933
        .buf = NULL,
        .offset = 0
R
Reda Sallahi 已提交
3934 3935 3936 3937
    };
    struct DdIo out = {
        .bsz = 512,
        .filename = NULL,
R
Reda Sallahi 已提交
3938 3939
        .buf = NULL,
        .offset = 0
R
Reda Sallahi 已提交
3940 3941 3942 3943 3944 3945 3946
    };

    const struct DdOpts options[] = {
        { "bs", img_dd_bs, C_BS },
        { "count", img_dd_count, C_COUNT },
        { "if", img_dd_if, C_IF },
        { "of", img_dd_of, C_OF },
R
Reda Sallahi 已提交
3947
        { "skip", img_dd_skip, C_SKIP },
R
Reda Sallahi 已提交
3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066
        { NULL, NULL, 0 }
    };
    const struct option long_options[] = {
        { "help", no_argument, 0, 'h'},
        { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
        { 0, 0, 0, 0 }
    };

    while ((c = getopt_long(argc, argv, "hf:O:", long_options, NULL))) {
        if (c == EOF) {
            break;
        }
        switch (c) {
        case 'O':
            out_fmt = optarg;
            break;
        case 'f':
            fmt = optarg;
            break;
        case '?':
            error_report("Try 'qemu-img --help' for more information.");
            ret = -1;
            goto out;
        case 'h':
            help();
            break;
        case OPTION_IMAGE_OPTS:
            image_opts = true;
            break;
        }
    }

    for (i = optind; i < argc; i++) {
        int j;
        arg = g_strdup(argv[i]);

        tmp = strchr(arg, '=');
        if (tmp == NULL) {
            error_report("unrecognized operand %s", arg);
            ret = -1;
            goto out;
        }

        *tmp++ = '\0';

        for (j = 0; options[j].name != NULL; j++) {
            if (!strcmp(arg, options[j].name)) {
                break;
            }
        }
        if (options[j].name == NULL) {
            error_report("unrecognized operand %s", arg);
            ret = -1;
            goto out;
        }

        if (options[j].f(tmp, &in, &out, &dd) != 0) {
            ret = -1;
            goto out;
        }
        dd.flags |= options[j].flag;
        g_free(arg);
        arg = NULL;
    }

    if (!(dd.flags & C_IF && dd.flags & C_OF)) {
        error_report("Must specify both input and output files");
        ret = -1;
        goto out;
    }
    blk1 = img_open(image_opts, in.filename, fmt, 0, false, false);

    if (!blk1) {
        ret = -1;
        goto out;
    }

    drv = bdrv_find_format(out_fmt);
    if (!drv) {
        error_report("Unknown file format");
        ret = -1;
        goto out;
    }
    proto_drv = bdrv_find_protocol(out.filename, true, &local_err);

    if (!proto_drv) {
        error_report_err(local_err);
        ret = -1;
        goto out;
    }
    if (!drv->create_opts) {
        error_report("Format driver '%s' does not support image creation",
                     drv->format_name);
        ret = -1;
        goto out;
    }
    if (!proto_drv->create_opts) {
        error_report("Protocol driver '%s' does not support image creation",
                     proto_drv->format_name);
        ret = -1;
        goto out;
    }
    create_opts = qemu_opts_append(create_opts, drv->create_opts);
    create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);

    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);

    size = blk_getlength(blk1);
    if (size < 0) {
        error_report("Failed to get size for '%s'", in.filename);
        ret = -1;
        goto out;
    }

    if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
        dd.count * in.bsz < size) {
        size = dd.count * in.bsz;
    }

R
Reda Sallahi 已提交
4067 4068 4069 4070 4071 4072 4073 4074
    /* Overflow means the specified offset is beyond input image's size */
    if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
                              size < in.bsz * in.offset)) {
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
    } else {
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
                            size - in.bsz * in.offset, &error_abort);
    }
R
Reda Sallahi 已提交
4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092

    ret = bdrv_create(drv, out.filename, opts, &local_err);
    if (ret < 0) {
        error_reportf_err(local_err,
                          "%s: error while creating output image: ",
                          out.filename);
        ret = -1;
        goto out;
    }

    blk2 = img_open(image_opts, out.filename, out_fmt, BDRV_O_RDWR,
                    false, false);

    if (!blk2) {
        ret = -1;
        goto out;
    }

R
Reda Sallahi 已提交
4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103
    if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
                              size < in.offset * in.bsz)) {
        /* We give a warning if the skip option is bigger than the input
         * size and create an empty output disk image (i.e. like dd(1)).
         */
        error_report("%s: cannot skip to specified offset", in.filename);
        in_pos = size;
    } else {
        in_pos = in.offset * in.bsz;
    }

R
Reda Sallahi 已提交
4104 4105
    in.buf = g_new(uint8_t, in.bsz);

R
Reda Sallahi 已提交
4106
    for (out_pos = 0; in_pos < size; block_count++) {
R
Reda Sallahi 已提交
4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144
        int in_ret, out_ret;

        if (in_pos + in.bsz > size) {
            in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
        } else {
            in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
        }
        if (in_ret < 0) {
            error_report("error while reading from input image file: %s",
                         strerror(-in_ret));
            ret = -1;
            goto out;
        }
        in_pos += in_ret;

        out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);

        if (out_ret < 0) {
            error_report("error while writing to output image file: %s",
                         strerror(-out_ret));
            ret = -1;
            goto out;
        }
        out_pos += out_ret;
    }

out:
    g_free(arg);
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
    blk_unref(blk1);
    blk_unref(blk2);
    g_free(in.filename);
    g_free(out.filename);
    g_free(in.buf);
    g_free(out.buf);

    if (ret) {
K
Kevin Wolf 已提交
4145 4146 4147 4148 4149 4150
        return 1;
    }
    return 0;
}


A
Anthony Liguori 已提交
4151
static const img_cmd_t img_cmds[] = {
4152 4153 4154 4155 4156 4157 4158 4159
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
    { NULL, NULL, },
};

B
bellard 已提交
4160 4161
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
4162
    const img_cmd_t *cmd;
4163
    const char *cmdname;
4164
    Error *local_error = NULL;
4165
    char *trace_file = NULL;
4166 4167 4168
    int c;
    static const struct option long_options[] = {
        {"help", no_argument, 0, 'h'},
4169
        {"version", no_argument, 0, 'V'},
4170
        {"trace", required_argument, NULL, 'T'},
4171 4172
        {0, 0, 0, 0}
    };
B
bellard 已提交
4173

4174 4175 4176 4177
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

4178
    module_call_init(MODULE_INIT_TRACE);
K
Kevin Wolf 已提交
4179
    error_set_progname(argv[0]);
4180
    qemu_init_exec_dir(argv[0]);
K
Kevin Wolf 已提交
4181

4182
    if (qemu_init_main_loop(&local_error)) {
4183
        error_report_err(local_error);
4184 4185 4186
        exit(EXIT_FAILURE);
    }

4187
    qcrypto_init(&error_fatal);
4188

4189
    module_call_init(MODULE_INIT_QOM);
B
bellard 已提交
4190
    bdrv_init();
F
Fam Zheng 已提交
4191 4192 4193
    if (argc < 2) {
        error_exit("Not enough arguments");
    }
4194

4195
    qemu_add_opts(&qemu_object_opts);
4196
    qemu_add_opts(&qemu_source_opts);
4197
    qemu_add_opts(&qemu_trace_opts);
4198

4199
    while ((c = getopt_long(argc, argv, "+hVT:", long_options, NULL)) != -1) {
4200 4201 4202 4203 4204 4205 4206
        switch (c) {
        case 'h':
            help();
            return 0;
        case 'V':
            printf(QEMU_IMG_VERSION);
            return 0;
4207 4208 4209 4210
        case 'T':
            g_free(trace_file);
            trace_file = trace_opt_parse(optarg);
            break;
4211
        }
B
bellard 已提交
4212
    }
4213

4214
    cmdname = argv[optind];
4215

4216 4217 4218
    /* reset getopt_long scanning */
    argc -= optind;
    if (argc < 1) {
4219 4220
        return 0;
    }
4221
    argv += optind;
D
Denis V. Lunev 已提交
4222
    optind = 0;
4223

4224 4225 4226 4227 4228 4229
    if (!trace_init_backends()) {
        exit(1);
    }
    trace_init_file(trace_file);
    qemu_set_log(LOG_TRACE);

4230 4231 4232 4233 4234 4235
    /* find the command */
    for (cmd = img_cmds; cmd->name != NULL; cmd++) {
        if (!strcmp(cmdname, cmd->name)) {
            return cmd->handler(argc, argv);
        }
    }
4236

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