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

38
#define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
39 40
                          ", Copyright (c) 2004-2008 Fabrice Bellard\n"

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

46 47 48 49 50 51 52 53 54 55
enum {
    OPTION_OUTPUT = 256,
    OPTION_BACKING_CHAIN = 257,
};

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

56
/* Default to cache=writeback as data integrity is not important for qemu-tcg. */
57
#define BDRV_O_FLAGS BDRV_O_CACHE_WB
58
#define BDRV_DEFAULT_CACHE "writeback"
59

60
static void format_print(void *opaque, const char *name)
B
bellard 已提交
61
{
62
    printf(" %s", name);
B
bellard 已提交
63 64
}

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

    printf("%s\nSupported formats:", help_msg);
151
    bdrv_iterate_format(format_print, NULL);
B
bellard 已提交
152
    printf("\n");
F
Fam Zheng 已提交
153
    exit(EXIT_SUCCESS);
B
bellard 已提交
154 155
}

S
Stefan Weil 已提交
156
static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
157 158 159 160 161 162 163 164 165 166 167
{
    int ret = 0;
    if (!quiet) {
        va_list args;
        va_start(args, fmt);
        ret = vprintf(fmt, args);
        va_end(args);
    }
    return ret;
}

B
bellard 已提交
168 169 170 171 172
#if defined(WIN32)
/* XXX: put correct support for win32 */
static int read_password(char *buf, int buf_size)
{
    int c, i;
173

B
bellard 已提交
174 175 176 177 178
    printf("Password: ");
    fflush(stdout);
    i = 0;
    for(;;) {
        c = getchar();
179 180 181 182
        if (c < 0) {
            buf[i] = '\0';
            return -1;
        } else if (c == '\n') {
B
bellard 已提交
183
            break;
184
        } else if (i < (buf_size - 1)) {
B
bellard 已提交
185
            buf[i++] = c;
186
        }
B
bellard 已提交
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
    }
    buf[i] = '\0';
    return 0;
}

#else

#include <termios.h>

static struct termios oldtty;

static void term_exit(void)
{
    tcsetattr (0, TCSANOW, &oldtty);
}

static void term_init(void)
{
    struct termios tty;

    tcgetattr (0, &tty);
    oldtty = tty;

    tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
                          |INLCR|IGNCR|ICRNL|IXON);
    tty.c_oflag |= OPOST;
    tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
    tty.c_cflag &= ~(CSIZE|PARENB);
    tty.c_cflag |= CS8;
    tty.c_cc[VMIN] = 1;
    tty.c_cc[VTIME] = 0;
218

B
bellard 已提交
219 220 221 222 223
    tcsetattr (0, TCSANOW, &tty);

    atexit(term_exit);
}

P
pbrook 已提交
224
static int read_password(char *buf, int buf_size)
B
bellard 已提交
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
{
    uint8_t ch;
    int i, ret;

    printf("password: ");
    fflush(stdout);
    term_init();
    i = 0;
    for(;;) {
        ret = read(0, &ch, 1);
        if (ret == -1) {
            if (errno == EAGAIN || errno == EINTR) {
                continue;
            } else {
                break;
            }
        } else if (ret == 0) {
            ret = -1;
            break;
        } else {
            if (ch == '\r') {
                ret = 0;
                break;
            }
            if (i < (buf_size - 1))
                buf[i++] = ch;
        }
    }
    term_exit();
    buf[i] = '\0';
    printf("\n");
    return ret;
}
#endif

260 261 262
static int print_block_option_help(const char *filename, const char *fmt)
{
    BlockDriver *drv, *proto_drv;
263
    QemuOptsList *create_opts = NULL;
264
    Error *local_err = NULL;
265 266 267 268

    /* Find driver and parse its options */
    drv = bdrv_find_format(fmt);
    if (!drv) {
269
        error_report("Unknown file format '%s'", fmt);
270 271 272
        return 1;
    }

C
Chunyan Liu 已提交
273
    create_opts = qemu_opts_append(create_opts, drv->create_opts);
274
    if (filename) {
275
        proto_drv = bdrv_find_protocol(filename, true, &local_err);
276
        if (!proto_drv) {
277 278
            qerror_report_err(local_err);
            error_free(local_err);
279
            qemu_opts_free(create_opts);
280 281
            return 1;
        }
C
Chunyan Liu 已提交
282
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
283 284
    }

285 286
    qemu_opts_print_help(create_opts);
    qemu_opts_free(create_opts);
287 288 289
    return 0;
}

290 291 292
static BlockBackend *img_open(const char *id, const char *filename,
                              const char *fmt, int flags,
                              bool require_io, bool quiet)
293
{
294
    BlockBackend *blk;
295 296
    BlockDriverState *bs;
    char password[256];
297
    Error *local_err = NULL;
298
    QDict *options = NULL;
299

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

305 306
    blk = blk_new_open(id, filename, NULL, options, flags, &local_err);
    if (!blk) {
307 308 309
        error_report("Could not open '%s': %s", filename,
                     error_get_pretty(local_err));
        error_free(local_err);
310
        goto fail;
311
    }
312

313
    bs = blk_bs(blk);
314
    if (bdrv_is_encrypted(bs) && require_io) {
315
        qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
316
        if (read_password(password, sizeof(password)) < 0) {
317
            error_report("No password given");
318 319 320
            goto fail;
        }
        if (bdrv_set_key(bs, password) < 0) {
321
            error_report("invalid password");
322 323
            goto fail;
        }
324
    }
325
    return blk;
326
fail:
327
    blk_unref(blk);
328
    return NULL;
329 330
}

331
static int add_old_style_options(const char *fmt, QemuOpts *opts,
332 333
                                 const char *base_filename,
                                 const char *base_fmt)
334
{
335 336
    Error *err = NULL;

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

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

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

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

423
    if (optind >= argc) {
F
Fam Zheng 已提交
424
        error_exit("Expecting image file name");
425
    }
426
    optind++;
427

428 429
    /* Get image size, if specified */
    if (optind < argc) {
430
        int64_t sval;
431 432 433
        char *end;
        sval = strtosz_suffix(argv[optind++], &end, STRTOSZ_DEFSUFFIX_B);
        if (sval < 0 || *end) {
434 435 436 437
            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, "
438 439 440
                      "G, T, P or E suffixes for ");
                error_report("kilobytes, megabytes, gigabytes, terabytes, "
                             "petabytes and exabytes.");
441
            }
442
            goto fail;
443 444 445
        }
        img_size = (uint64_t)sval;
    }
446
    if (optind != argc) {
F
Fam Zheng 已提交
447
        error_exit("Unexpected argument: %s", argv[optind]);
448
    }
449

450
    bdrv_img_create(filename, fmt, base_filename, base_fmt,
451
                    options, img_size, BDRV_O_FLAGS, &local_err, quiet);
452
    if (local_err) {
453
        error_report("%s: %s", filename, error_get_pretty(local_err));
454
        error_free(local_err);
455
        goto fail;
456
    }
457

458
    g_free(options);
B
bellard 已提交
459
    return 0;
460 461 462 463

fail:
    g_free(options);
    return 1;
B
bellard 已提交
464 465
}

466
static void dump_json_image_check(ImageCheck *check, bool quiet)
467
{
468
    Error *local_err = NULL;
469 470 471 472
    QString *str;
    QmpOutputVisitor *ov = qmp_output_visitor_new();
    QObject *obj;
    visit_type_ImageCheck(qmp_output_get_visitor(ov),
473
                          &check, NULL, &local_err);
474 475 476
    obj = qmp_output_get_qobject(ov);
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
477
    qprintf(quiet, "%s\n", qstring_get_str(str));
478 479 480 481 482
    qobject_decref(obj);
    qmp_output_visitor_cleanup(ov);
    QDECREF(str);
}

483
static void dump_human_image_check(ImageCheck *check, bool quiet)
484 485
{
    if (!(check->corruptions || check->leaks || check->check_errors)) {
486
        qprintf(quiet, "No errors were found on the image.\n");
487 488
    } else {
        if (check->corruptions) {
489 490 491 492
            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);
493 494 495
        }

        if (check->leaks) {
496 497 498 499
            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);
500 501 502
        }

        if (check->check_errors) {
503 504 505 506
            qprintf(quiet,
                    "\n%" PRId64
                    " internal errors have occurred during the check.\n",
                    check->check_errors);
507 508 509 510
        }
    }

    if (check->total_clusters != 0 && check->allocated_clusters != 0) {
511 512 513 514 515 516 517
        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);
518 519 520
    }

    if (check->image_end_offset) {
521 522
        qprintf(quiet,
                "Image end offset: %" PRId64 "\n", check->image_end_offset);
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
    }
}

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;
559 560
    check->compressed_clusters      = result.bfi.compressed_clusters;
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
561 562 563 564

    return 0;
}

565 566 567
/*
 * Checks an image for consistency. Exit codes:
 *
M
Max Reitz 已提交
568 569 570 571 572
 *  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
573
 */
574 575 576
static int img_check(int argc, char **argv)
{
    int c, ret;
577
    OutputFormat output_format = OFORMAT_HUMAN;
578
    const char *filename, *fmt, *output, *cache;
M
Markus Armbruster 已提交
579
    BlockBackend *blk;
580
    BlockDriverState *bs;
581
    int fix = 0;
582
    int flags = BDRV_O_FLAGS | BDRV_O_CHECK;
583
    ImageCheck *check;
584
    bool quiet = false;
585 586

    fmt = NULL;
587
    output = NULL;
588
    cache = BDRV_DEFAULT_CACHE;
589
    for(;;) {
590 591 592 593
        int option_index = 0;
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"format", required_argument, 0, 'f'},
594
            {"repair", required_argument, 0, 'r'},
595 596 597
            {"output", required_argument, 0, OPTION_OUTPUT},
            {0, 0, 0, 0}
        };
598
        c = getopt_long(argc, argv, "hf:r:T:q",
599
                        long_options, &option_index);
600
        if (c == -1) {
601
            break;
602
        }
603
        switch(c) {
J
Jes Sorensen 已提交
604
        case '?':
605 606 607 608 609 610
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
611 612 613 614 615 616 617 618
        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 已提交
619 620
                error_exit("Unknown option value for -r "
                           "(expecting 'leaks' or 'all'): %s", optarg);
621 622
            }
            break;
623 624 625
        case OPTION_OUTPUT:
            output = optarg;
            break;
626 627 628
        case 'T':
            cache = optarg;
            break;
629 630 631
        case 'q':
            quiet = true;
            break;
632 633
        }
    }
634
    if (optind != argc - 1) {
F
Fam Zheng 已提交
635
        error_exit("Expecting one image file name");
636
    }
637 638
    filename = argv[optind++];

639 640 641 642 643 644 645 646 647
    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;
    }

648 649 650 651 652 653
    ret = bdrv_parse_cache_flags(cache, &flags);
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        return 1;
    }

654 655 656
    blk = img_open("image", filename, fmt, flags, true, quiet);
    if (!blk) {
        return 1;
657
    }
658
    bs = blk_bs(blk);
659 660 661

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
662 663

    if (ret == -ENOTSUP) {
664
        error_report("This image format does not support checks");
665
        ret = 63;
666
        goto fail;
667 668
    }

669 670
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
671

672 673
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
674

675
        if (output_format == OFORMAT_HUMAN) {
676 677 678 679 680 681 682
            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);
683 684
        }

685
        ret = collect_image_check(bs, check, filename, fmt, 0);
686

687 688
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
689 690
    }

M
Max Reitz 已提交
691 692 693 694 695 696 697 698 699
    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;
        }
700 701
    }

702
    if (ret || check->check_errors) {
M
Max Reitz 已提交
703 704 705 706 707
        if (ret) {
            error_report("Check failed: %s", strerror(-ret));
        } else {
            error_report("Check failed");
        }
708 709
        ret = 1;
        goto fail;
710
    }
711

712 713 714 715
    if (check->corruptions) {
        ret = 2;
    } else if (check->leaks) {
        ret = 3;
716
    } else {
717
        ret = 0;
718
    }
719 720 721

fail:
    qapi_free_ImageCheck(check);
M
Markus Armbruster 已提交
722
    blk_unref(blk);
723
    return ret;
724 725
}

M
Max Reitz 已提交
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
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");
    }

    /* Drop this block job's reference */
    bdrv_unref(cbi->bs);
}

static void run_block_job(BlockJob *job, Error **errp)
{
    AioContext *aio_context = bdrv_get_aio_context(job->bs);

    do {
        aio_poll(aio_context, true);
749
        qemu_progress_print((float)job->offset / job->len * 100.f, 0);
M
Max Reitz 已提交
750 751 752
    } while (!job->ready);

    block_job_complete_sync(job, errp);
753 754 755 756

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

B
bellard 已提交
759 760
static int img_commit(int argc, char **argv)
{
761
    int c, ret, flags;
762
    const char *filename, *fmt, *cache, *base;
M
Markus Armbruster 已提交
763
    BlockBackend *blk;
M
Max Reitz 已提交
764
    BlockDriverState *bs, *base_bs;
765
    bool progress = false, quiet = false, drop = false;
M
Max Reitz 已提交
766 767
    Error *local_err = NULL;
    CommonBlockJobCBInfo cbi;
B
bellard 已提交
768 769

    fmt = NULL;
770
    cache = BDRV_DEFAULT_CACHE;
771
    base = NULL;
B
bellard 已提交
772
    for(;;) {
773
        c = getopt(argc, argv, "f:ht:b:dpq");
774
        if (c == -1) {
B
bellard 已提交
775
            break;
776
        }
B
bellard 已提交
777
        switch(c) {
J
Jes Sorensen 已提交
778
        case '?':
B
bellard 已提交
779 780 781 782 783 784
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
785 786 787
        case 't':
            cache = optarg;
            break;
788 789 790 791 792
        case 'b':
            base = optarg;
            /* -b implies -d */
            drop = true;
            break;
M
Max Reitz 已提交
793 794 795
        case 'd':
            drop = true;
            break;
796 797 798
        case 'p':
            progress = true;
            break;
799 800 801
        case 'q':
            quiet = true;
            break;
B
bellard 已提交
802 803
        }
    }
804 805 806 807 808 809

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

810
    if (optind != argc - 1) {
F
Fam Zheng 已提交
811
        error_exit("Expecting one image file name");
812
    }
B
bellard 已提交
813 814
    filename = argv[optind++];

M
Max Reitz 已提交
815
    flags = BDRV_O_RDWR | BDRV_O_UNMAP;
816
    ret = bdrv_parse_cache_flags(cache, &flags);
817 818
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
819
        return 1;
820 821
    }

822 823 824
    blk = img_open("image", filename, fmt, flags, true, quiet);
    if (!blk) {
        return 1;
825
    }
826 827
    bs = blk_bs(blk);

828 829 830
    qemu_progress_init(progress, 1.f);
    qemu_progress_print(0.f, 100);

831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
    if (base) {
        base_bs = bdrv_find_backing_image(bs, base);
        if (!base_bs) {
            error_set(&local_err, QERR_BASE_NOT_FOUND, base);
            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. */
        base_bs = bs->backing_hd;
        if (!base_bs) {
            error_setg(&local_err, "Image does not have a backing file");
            goto done;
        }
M
Max Reitz 已提交
846 847 848 849 850 851 852 853 854 855 856
    }

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

    commit_active_start(bs, base_bs, 0, BLOCKDEV_ON_ERROR_REPORT,
                        common_block_job_cb, &cbi, &local_err);
    if (local_err) {
        goto done;
B
bellard 已提交
857 858
    }

M
Max Reitz 已提交
859 860 861 862 863 864 865 866
    /* The block job will swap base_bs and bs (which is not what we really want
     * here, but okay) and unref base_bs (after the swap, i.e., the old top
     * image). In order to still be able to empty that top image afterwards,
     * increment the reference counter here preemptively. */
    if (!drop) {
        bdrv_ref(base_bs);
    }

M
Max Reitz 已提交
867
    run_block_job(bs->job, &local_err);
M
Max Reitz 已提交
868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
    if (local_err) {
        goto unref_backing;
    }

    if (!drop && base_bs->drv->bdrv_make_empty) {
        ret = base_bs->drv->bdrv_make_empty(base_bs);
        if (ret) {
            error_setg_errno(&local_err, -ret, "Could not empty %s",
                             filename);
            goto unref_backing;
        }
    }

unref_backing:
    if (!drop) {
        bdrv_unref(base_bs);
    }
M
Max Reitz 已提交
885 886

done:
887 888
    qemu_progress_end();

M
Markus Armbruster 已提交
889
    blk_unref(blk);
M
Max Reitz 已提交
890 891

    if (local_err) {
892
        error_report_err(local_err);
893 894
        return 1;
    }
M
Max Reitz 已提交
895 896

    qprintf(quiet, "Image committed.\n");
B
bellard 已提交
897 898 899
    return 0;
}

900 901 902 903 904 905 906
/*
 * 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 已提交
907 908
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
{
909 910
    bool is_zero;
    int i;
B
bellard 已提交
911 912 913 914 915

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
916
    is_zero = buffer_is_zero(buf, 512);
B
bellard 已提交
917 918
    for(i = 1; i < n; i++) {
        buf += 512;
919
        if (is_zero != buffer_is_zero(buf, 512)) {
B
bellard 已提交
920
            break;
921
        }
B
bellard 已提交
922 923
    }
    *pnum = i;
924
    return !is_zero;
B
bellard 已提交
925 926
}

927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968
/*
 * 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 已提交
969 970 971 972 973 974 975 976 977 978
/*
 * 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)
{
979 980
    bool res;
    int i;
K
Kevin Wolf 已提交
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000

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

1001
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
1002

1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
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.
 *
1019
 * @param blk:  BlockBackend for the image
1020 1021 1022 1023 1024 1025
 * @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
 */
1026
static int check_empty_sectors(BlockBackend *blk, int64_t sect_num,
1027 1028 1029 1030
                               int sect_count, const char *filename,
                               uint8_t *buffer, bool quiet)
{
    int pnum, ret = 0;
1031
    ret = blk_read(blk, sect_num, buffer, sect_count);
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
    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)
{
1056
    const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
M
Markus Armbruster 已提交
1057
    BlockBackend *blk1, *blk2;
1058 1059 1060 1061 1062 1063 1064
    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;
1065
    int flags;
1066 1067 1068 1069 1070 1071
    int64_t total_sectors;
    int64_t sector_num = 0;
    int64_t nb_sectors;
    int c, pnum;
    uint64_t progress_base;

1072
    cache = BDRV_DEFAULT_CACHE;
1073
    for (;;) {
1074
        c = getopt(argc, argv, "hf:F:T:pqs");
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
        if (c == -1) {
            break;
        }
        switch (c) {
        case '?':
        case 'h':
            help();
            break;
        case 'f':
            fmt1 = optarg;
            break;
        case 'F':
            fmt2 = optarg;
            break;
1089 1090 1091
        case 'T':
            cache = optarg;
            break;
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
        case 'p':
            progress = true;
            break;
        case 'q':
            quiet = true;
            break;
        case 's':
            strict = true;
            break;
        }
    }

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


1110
    if (optind != argc - 2) {
F
Fam Zheng 已提交
1111
        error_exit("Expecting two image file names");
1112 1113 1114 1115
    }
    filename1 = argv[optind++];
    filename2 = argv[optind++];

1116 1117 1118
    /* Initialize before goto out */
    qemu_progress_init(progress, 2.0);

1119 1120 1121 1122 1123 1124 1125 1126
    flags = BDRV_O_FLAGS;
    ret = bdrv_parse_cache_flags(cache, &flags);
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        ret = 2;
        goto out3;
    }

1127 1128
    blk1 = img_open("image_1", filename1, fmt1, flags, true, quiet);
    if (!blk1) {
1129
        ret = 2;
1130
        goto out3;
1131
    }
1132
    bs1 = blk_bs(blk1);
1133

1134 1135
    blk2 = img_open("image_2", filename2, fmt2, flags, true, quiet);
    if (!blk2) {
1136
        ret = 2;
1137
        goto out2;
1138
    }
1139
    bs2 = blk_bs(blk2);
1140

1141 1142 1143
    buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
    buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
    total_sectors1 = blk_nb_sectors(blk1);
1144 1145 1146 1147 1148 1149
    if (total_sectors1 < 0) {
        error_report("Can't get size of %s: %s",
                     filename1, strerror(-total_sectors1));
        ret = 4;
        goto out;
    }
1150
    total_sectors2 = blk_nb_sectors(blk2);
1151 1152 1153 1154 1155 1156
    if (total_sectors2 < 0) {
        error_report("Can't get size of %s: %s",
                     filename2, strerror(-total_sectors2));
        ret = 4;
        goto out;
    }
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
    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 (;;) {
        nb_sectors = sectors_to_process(total_sectors, sector_num);
        if (nb_sectors <= 0) {
            break;
        }
        allocated1 = bdrv_is_allocated_above(bs1, NULL, sector_num, nb_sectors,
                                             &pnum1);
        if (allocated1 < 0) {
            ret = 3;
            error_report("Sector allocation test failed for %s", filename1);
            goto out;
        }

        allocated2 = bdrv_is_allocated_above(bs2, NULL, sector_num, nb_sectors,
                                             &pnum2);
        if (allocated2 < 0) {
            ret = 3;
            error_report("Sector allocation test failed for %s", filename2);
            goto out;
        }
        nb_sectors = MIN(pnum1, pnum2);

        if (allocated1 == allocated2) {
            if (allocated1) {
1192
                ret = blk_read(blk1, sector_num, buf1, nb_sectors);
1193 1194 1195 1196 1197 1198 1199
                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;
                }
1200
                ret = blk_read(blk2, sector_num, buf2, nb_sectors);
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
                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));
1213
                    ret = 1;
1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
                    goto out;
                }
            }
        } else {
            if (strict) {
                ret = 1;
                qprintf(quiet, "Strict mode: Offset %" PRId64
                        " allocation mismatch!\n",
                        sectors_to_bytes(sector_num));
                goto out;
            }

            if (allocated1) {
1227
                ret = check_empty_sectors(blk1, sector_num, nb_sectors,
1228 1229
                                          filename1, buf1, quiet);
            } else {
1230
                ret = check_empty_sectors(blk2, sector_num, nb_sectors,
1231 1232 1233 1234 1235 1236
                                          filename2, buf1, quiet);
            }
            if (ret) {
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64 ": %s",
                                 sectors_to_bytes(sector_num), strerror(-ret));
1237
                    ret = 4;
1238 1239 1240 1241 1242 1243 1244 1245 1246
                }
                goto out;
            }
        }
        sector_num += nb_sectors;
        qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
    }

    if (total_sectors1 != total_sectors2) {
1247
        BlockBackend *blk_over;
1248 1249 1250 1251 1252 1253
        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;
1254
            blk_over = blk1;
1255 1256 1257
            filename_over = filename1;
        } else {
            total_sectors_over = total_sectors2;
1258
            blk_over = blk2;
1259 1260 1261 1262 1263 1264 1265 1266
            filename_over = filename2;
        }

        for (;;) {
            nb_sectors = sectors_to_process(total_sectors_over, sector_num);
            if (nb_sectors <= 0) {
                break;
            }
1267
            ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277
                                          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) {
1278
                ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
1279 1280 1281 1282 1283 1284
                                          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));
1285
                        ret = 4;
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300
                    }
                    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 已提交
1301
    blk_unref(blk2);
1302
out2:
M
Markus Armbruster 已提交
1303
    blk_unref(blk1);
1304 1305 1306 1307 1308
out3:
    qemu_progress_end();
    return ret;
}

B
bellard 已提交
1309 1310
static int img_convert(int argc, char **argv)
{
1311
    int c, n, n1, bs_n, bs_i, compress, cluster_sectors, skip_create;
1312
    int64_t ret = 0;
1313 1314
    int progress = 0, flags, src_flags;
    const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
1315
    BlockDriver *drv, *proto_drv;
M
Markus Armbruster 已提交
1316
    BlockBackend **blk = NULL, *out_blk = NULL;
1317
    BlockDriverState **bs = NULL, *out_bs = NULL;
1318
    int64_t total_sectors, nb_sectors, sector_num, bs_offset;
1319
    int64_t *bs_sectors = NULL;
1320
    uint8_t * buf = NULL;
1321
    size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
B
bellard 已提交
1322
    const uint8_t *buf1;
B
bellard 已提交
1323
    BlockDriverInfo bdi;
1324 1325 1326
    QemuOpts *opts = NULL;
    QemuOptsList *create_opts = NULL;
    const char *out_baseimg_param;
1327
    char *options = NULL;
E
edison 已提交
1328
    const char *snapshot_name = NULL;
1329
    int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1330
    bool quiet = false;
1331
    Error *local_err = NULL;
1332
    QemuOpts *sn_opts = NULL;
B
bellard 已提交
1333 1334 1335

    fmt = NULL;
    out_fmt = "raw";
1336
    cache = "unsafe";
1337
    src_cache = BDRV_DEFAULT_CACHE;
1338
    out_baseimg = NULL;
1339
    compress = 0;
1340
    skip_create = 0;
B
bellard 已提交
1341
    for(;;) {
1342
        c = getopt(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qn");
1343
        if (c == -1) {
B
bellard 已提交
1344
            break;
1345
        }
B
bellard 已提交
1346
        switch(c) {
J
Jes Sorensen 已提交
1347
        case '?':
B
bellard 已提交
1348 1349 1350 1351 1352 1353 1354 1355 1356
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'O':
            out_fmt = optarg;
            break;
1357 1358 1359
        case 'B':
            out_baseimg = optarg;
            break;
B
bellard 已提交
1360
        case 'c':
1361
            compress = 1;
B
bellard 已提交
1362 1363
            break;
        case 'e':
1364
            error_report("option -e is deprecated, please use \'-o "
1365
                  "encryption\' instead!");
1366
            ret = -1;
1367
            goto fail_getopt;
1368
        case '6':
1369
            error_report("option -6 is deprecated, please use \'-o "
1370
                  "compat6\' instead!");
1371
            ret = -1;
1372
            goto fail_getopt;
1373
        case 'o':
1374 1375 1376
            if (!is_valid_option_list(optarg)) {
                error_report("Invalid option list: %s", optarg);
                ret = -1;
1377
                goto fail_getopt;
1378 1379 1380 1381 1382 1383 1384 1385
            }
            if (!options) {
                options = g_strdup(optarg);
            } else {
                char *old_options = options;
                options = g_strdup_printf("%s,%s", options, optarg);
                g_free(old_options);
            }
1386
            break;
E
edison 已提交
1387 1388 1389
        case 's':
            snapshot_name = optarg;
            break;
1390 1391 1392 1393 1394 1395
        case 'l':
            if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
                sn_opts = qemu_opts_parse(&internal_snapshot_opts, optarg, 0);
                if (!sn_opts) {
                    error_report("Failed in parsing snapshot param '%s'",
                                 optarg);
1396
                    ret = -1;
1397
                    goto fail_getopt;
1398 1399 1400 1401 1402
                }
            } else {
                snapshot_name = optarg;
            }
            break;
1403 1404 1405
        case 'S':
        {
            int64_t sval;
1406 1407 1408
            char *end;
            sval = strtosz_suffix(optarg, &end, STRTOSZ_DEFSUFFIX_B);
            if (sval < 0 || *end) {
1409
                error_report("Invalid minimum zero buffer size for sparse output specified");
1410
                ret = -1;
1411
                goto fail_getopt;
1412 1413 1414 1415 1416
            }

            min_sparse = sval / BDRV_SECTOR_SIZE;
            break;
        }
1417 1418 1419
        case 'p':
            progress = 1;
            break;
1420 1421 1422
        case 't':
            cache = optarg;
            break;
1423 1424 1425
        case 'T':
            src_cache = optarg;
            break;
1426 1427 1428
        case 'q':
            quiet = true;
            break;
1429 1430 1431
        case 'n':
            skip_create = 1;
            break;
B
bellard 已提交
1432 1433
        }
    }
1434

1435
    /* Initialize before goto out */
1436 1437 1438
    if (quiet) {
        progress = 0;
    }
1439 1440
    qemu_progress_init(progress, 1.0);

1441

1442
    bs_n = argc - optind - 1;
1443
    out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
1444

1445
    if (options && has_help_option(options)) {
1446 1447 1448 1449
        ret = print_block_option_help(out_filename, out_fmt);
        goto out;
    }

1450
    if (bs_n < 1) {
F
Fam Zheng 已提交
1451
        error_exit("Must specify image file name");
1452 1453 1454
    }


1455
    if (bs_n > 1 && out_baseimg) {
1456 1457
        error_report("-B makes no sense when concatenating multiple input "
                     "images");
1458 1459
        ret = -1;
        goto out;
1460
    }
1461

1462 1463 1464 1465 1466 1467 1468
    src_flags = BDRV_O_FLAGS;
    ret = bdrv_parse_cache_flags(src_cache, &src_flags);
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
        goto out;
    }

1469 1470
    qemu_progress_print(0, 100);

M
Markus Armbruster 已提交
1471
    blk = g_new0(BlockBackend *, bs_n);
1472
    bs = g_new0(BlockDriverState *, bs_n);
1473
    bs_sectors = g_new(int64_t, bs_n);
1474 1475 1476

    total_sectors = 0;
    for (bs_i = 0; bs_i < bs_n; bs_i++) {
K
Kevin Wolf 已提交
1477
        char *id = bs_n > 1 ? g_strdup_printf("source_%d", bs_i)
1478
                            : g_strdup("source");
1479 1480
        blk[bs_i] = img_open(id, argv[optind + bs_i], fmt, src_flags,
                             true, quiet);
1481
        g_free(id);
1482
        if (!blk[bs_i]) {
1483 1484 1485
            ret = -1;
            goto out;
        }
1486
        bs[bs_i] = blk_bs(blk[bs_i]);
1487
        bs_sectors[bs_i] = blk_nb_sectors(blk[bs_i]);
1488 1489 1490 1491 1492 1493
        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;
        }
1494
        total_sectors += bs_sectors[bs_i];
1495
    }
B
bellard 已提交
1496

1497 1498 1499 1500 1501 1502
    if (sn_opts) {
        ret = bdrv_snapshot_load_tmp(bs[0],
                                     qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
                                     qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
                                     &local_err);
    } else if (snapshot_name != NULL) {
E
edison 已提交
1503
        if (bs_n > 1) {
1504
            error_report("No support for concatenating multiple snapshot");
E
edison 已提交
1505 1506 1507
            ret = -1;
            goto out;
        }
1508 1509

        bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1510
    }
1511
    if (local_err) {
1512 1513 1514 1515 1516
        error_report("Failed to load snapshot: %s",
                     error_get_pretty(local_err));
        error_free(local_err);
        ret = -1;
        goto out;
E
edison 已提交
1517 1518
    }

1519
    /* Find driver and parse its options */
B
bellard 已提交
1520
    drv = bdrv_find_format(out_fmt);
1521
    if (!drv) {
1522
        error_report("Unknown file format '%s'", out_fmt);
1523 1524 1525
        ret = -1;
        goto out;
    }
1526

1527
    proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
1528
    if (!proto_drv) {
1529 1530
        qerror_report_err(local_err);
        error_free(local_err);
1531 1532 1533
        ret = -1;
        goto out;
    }
1534

M
Max Reitz 已提交
1535 1536 1537 1538 1539 1540 1541
    if (!skip_create) {
        if (!drv->create_opts) {
            error_report("Format driver '%s' does not support image creation",
                         drv->format_name);
            ret = -1;
            goto out;
        }
1542

M
Max Reitz 已提交
1543 1544 1545 1546 1547 1548
        if (!proto_drv->create_opts) {
            error_report("Protocol driver '%s' does not support image creation",
                         proto_drv->format_name);
            ret = -1;
            goto out;
        }
1549

M
Max Reitz 已提交
1550 1551
        create_opts = qemu_opts_append(create_opts, drv->create_opts);
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
1552

M
Max Reitz 已提交
1553
        opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
1554 1555 1556 1557 1558 1559 1560 1561
        if (options) {
            qemu_opts_do_parse(opts, options, NULL, &local_err);
            if (local_err) {
                error_report("Invalid options for file format '%s'", out_fmt);
                error_free(local_err);
                ret = -1;
                goto out;
            }
M
Max Reitz 已提交
1562
        }
1563

1564 1565
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512,
                            &error_abort);
M
Max Reitz 已提交
1566 1567 1568 1569
        ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
        if (ret < 0) {
            goto out;
        }
1570
    }
1571

1572
    /* Get backing file name if -o backing_file was used */
1573
    out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
1574
    if (out_baseimg_param) {
1575
        out_baseimg = out_baseimg_param;
1576 1577
    }

1578
    /* Check if compression is supported */
1579
    if (compress) {
1580 1581 1582 1583
        bool encryption =
            qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
        const char *preallocation =
            qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
1584 1585

        if (!drv->bdrv_write_compressed) {
1586
            error_report("Compression not supported for this file format");
1587 1588
            ret = -1;
            goto out;
1589 1590
        }

1591
        if (encryption) {
1592 1593
            error_report("Compression and encryption not supported at "
                         "the same time");
1594 1595
            ret = -1;
            goto out;
1596
        }
1597

1598 1599
        if (preallocation
            && strcmp(preallocation, "off"))
1600 1601 1602 1603 1604 1605
        {
            error_report("Compression and preallocation not supported at "
                         "the same time");
            ret = -1;
            goto out;
        }
1606 1607
    }

1608 1609
    if (!skip_create) {
        /* Create the new image */
C
Chunyan Liu 已提交
1610
        ret = bdrv_create(drv, out_filename, opts, &local_err);
1611
        if (ret < 0) {
1612 1613 1614
            error_report("%s: error while converting %s: %s",
                         out_filename, out_fmt, error_get_pretty(local_err));
            error_free(local_err);
1615
            goto out;
B
bellard 已提交
1616 1617
        }
    }
1618

1619
    flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
1620
    ret = bdrv_parse_cache_flags(cache, &flags);
1621 1622
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
1623
        goto out;
1624 1625
    }

1626 1627
    out_blk = img_open("target", out_filename, out_fmt, flags, true, quiet);
    if (!out_blk) {
1628 1629 1630
        ret = -1;
        goto out;
    }
1631
    out_bs = blk_bs(out_blk);
B
bellard 已提交
1632

1633 1634
    bs_i = 0;
    bs_offset = 0;
1635 1636 1637 1638 1639 1640 1641 1642 1643

    /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
     * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
     * as maximum. */
    bufsectors = MIN(32768,
                     MAX(bufsectors, MAX(out_bs->bl.opt_transfer_length,
                                         out_bs->bl.discard_alignment))
                    );

1644
    buf = blk_blockalign(out_blk, bufsectors * BDRV_SECTOR_SIZE);
1645

1646
    if (skip_create) {
1647
        int64_t output_sectors = blk_nb_sectors(out_blk);
1648
        if (output_sectors < 0) {
1649
            error_report("unable to get output image length: %s",
1650
                         strerror(-output_sectors));
1651 1652
            ret = -1;
            goto out;
1653
        } else if (output_sectors < total_sectors) {
1654 1655 1656 1657 1658 1659
            error_report("output file is smaller than input file");
            ret = -1;
            goto out;
        }
    }

1660 1661 1662 1663
    cluster_sectors = 0;
    ret = bdrv_get_info(out_bs, &bdi);
    if (ret < 0) {
        if (compress) {
1664
            error_report("could not get block driver info");
1665 1666
            goto out;
        }
1667
    } else {
1668
        compress = compress || bdi.needs_compressed_writes;
1669 1670 1671 1672 1673
        cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
    }

    if (compress) {
        if (cluster_sectors <= 0 || cluster_sectors > bufsectors) {
1674
            error_report("invalid cluster size");
1675 1676 1677
            ret = -1;
            goto out;
        }
B
bellard 已提交
1678
        sector_num = 0;
1679 1680 1681

        nb_sectors = total_sectors;

B
bellard 已提交
1682
        for(;;) {
1683 1684 1685 1686
            int64_t bs_num;
            int remainder;
            uint8_t *buf2;

B
bellard 已提交
1687 1688 1689 1690 1691 1692 1693
            nb_sectors = total_sectors - sector_num;
            if (nb_sectors <= 0)
                break;
            if (nb_sectors >= cluster_sectors)
                n = cluster_sectors;
            else
                n = nb_sectors;
1694 1695 1696 1697 1698 1699 1700

            bs_num = sector_num - bs_offset;
            assert (bs_num >= 0);
            remainder = n;
            buf2 = buf;
            while (remainder > 0) {
                int nlow;
1701 1702
                while (bs_num == bs_sectors[bs_i]) {
                    bs_offset += bs_sectors[bs_i];
1703 1704 1705
                    bs_i++;
                    assert (bs_i < bs_n);
                    bs_num = 0;
B
Blue Swirl 已提交
1706 1707
                    /* printf("changing part: sector_num=%" PRId64 ", "
                       "bs_i=%d, bs_offset=%" PRId64 ", bs_sectors=%" PRId64
1708
                       "\n", sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1709
                }
1710
                assert (bs_num < bs_sectors[bs_i]);
1711

1712 1713
                nlow = remainder > bs_sectors[bs_i] - bs_num
                    ? bs_sectors[bs_i] - bs_num : remainder;
1714

1715
                ret = blk_read(blk[bs_i], bs_num, buf2, nlow);
1716
                if (ret < 0) {
1717 1718
                    error_report("error while reading sector %" PRId64 ": %s",
                                 bs_num, strerror(-ret));
1719 1720
                    goto out;
                }
1721 1722 1723 1724 1725 1726 1727 1728

                buf2 += nlow * 512;
                bs_num += nlow;

                remainder -= nlow;
            }
            assert (remainder == 0);

1729
            if (!buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)) {
1730
                ret = blk_write_compressed(out_blk, sector_num, buf, n);
1731
                if (ret != 0) {
1732 1733
                    error_report("error while compressing sector %" PRId64
                                 ": %s", sector_num, strerror(-ret));
1734 1735
                    goto out;
                }
B
bellard 已提交
1736 1737
            }
            sector_num += n;
1738
            qemu_progress_print(100.0 * sector_num / total_sectors, 0);
B
bellard 已提交
1739
        }
B
bellard 已提交
1740
        /* signal EOF to align */
1741
        blk_write_compressed(out_blk, 0, NULL, 0);
B
bellard 已提交
1742
    } else {
1743 1744
        int64_t sectors_to_read, sectors_read, sector_num_next_status;
        bool count_allocated_sectors;
1745
        int has_zero_init = min_sparse ? bdrv_has_zero_init(out_bs) : 0;
K
Kevin Wolf 已提交
1746

1747 1748 1749 1750 1751 1752 1753 1754
        if (!has_zero_init && bdrv_can_write_zeroes_with_unmap(out_bs)) {
            ret = bdrv_make_zero(out_bs, BDRV_REQ_MAY_UNMAP);
            if (ret < 0) {
                goto out;
            }
            has_zero_init = 1;
        }

1755 1756 1757
        sectors_to_read = total_sectors;
        count_allocated_sectors = progress && (out_baseimg || has_zero_init);
restart:
1758
        sector_num = 0; // total number of sectors converted so far
1759 1760
        sectors_read = 0;
        sector_num_next_status = 0;
1761

B
bellard 已提交
1762 1763
        for(;;) {
            nb_sectors = total_sectors - sector_num;
1764
            if (nb_sectors <= 0) {
1765 1766 1767 1768 1769
                if (count_allocated_sectors) {
                    sectors_to_read = sectors_read;
                    count_allocated_sectors = false;
                    goto restart;
                }
1770
                ret = 0;
B
bellard 已提交
1771
                break;
1772
            }
1773

1774 1775
            while (sector_num - bs_offset >= bs_sectors[bs_i]) {
                bs_offset += bs_sectors[bs_i];
1776 1777
                bs_i ++;
                assert (bs_i < bs_n);
B
Blue Swirl 已提交
1778 1779
                /* printf("changing part: sector_num=%" PRId64 ", bs_i=%d, "
                  "bs_offset=%" PRId64 ", bs_sectors=%" PRId64 "\n",
1780
                   sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1781 1782
            }

1783 1784 1785 1786 1787
            if ((out_baseimg || has_zero_init) &&
                sector_num >= sector_num_next_status) {
                n = nb_sectors > INT_MAX ? INT_MAX : nb_sectors;
                ret = bdrv_get_block_status(bs[bs_i], sector_num - bs_offset,
                                            n, &n1);
1788
                if (ret < 0) {
1789 1790 1791
                    error_report("error while reading block status of sector %"
                                 PRId64 ": %s", sector_num - bs_offset,
                                 strerror(-ret));
1792 1793
                    goto out;
                }
1794 1795 1796 1797
                /* If the output image is zero initialized, we are not working
                 * on a shared base and the input is zero we can skip the next
                 * n1 sectors */
                if (has_zero_init && !out_baseimg && (ret & BDRV_BLOCK_ZERO)) {
1798 1799
                    sector_num += n1;
                    continue;
1800
                }
1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816
                /* If the output image is being created as a copy on write
                 * image, assume that sectors which are unallocated in the
                 * input image are present in both the output's and input's
                 * base images (no need to copy them). */
                if (out_baseimg) {
                    if (!(ret & BDRV_BLOCK_DATA)) {
                        sector_num += n1;
                        continue;
                    }
                    /* The next 'n1' sectors are allocated in the input image.
                     * Copy only those as they may be followed by unallocated
                     * sectors. */
                    nb_sectors = n1;
                }
                /* avoid redundant callouts to get_block_status */
                sector_num_next_status = sector_num + n1;
1817 1818
            }

1819
            n = MIN(nb_sectors, bufsectors);
1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832

            /* round down request length to an aligned sector, but
             * do not bother doing this on short requests. They happen
             * when we found an all-zero area, and the next sector to
             * write will not be sector_num + n. */
            if (cluster_sectors > 0 && n >= cluster_sectors) {
                int64_t next_aligned_sector = (sector_num + n);
                next_aligned_sector -= next_aligned_sector % cluster_sectors;
                if (sector_num + n > next_aligned_sector) {
                    n = next_aligned_sector - sector_num;
                }
            }

1833
            n = MIN(n, bs_sectors[bs_i] - (sector_num - bs_offset));
1834

1835 1836 1837 1838 1839 1840 1841
            sectors_read += n;
            if (count_allocated_sectors) {
                sector_num += n;
                continue;
            }

            n1 = n;
1842
            ret = blk_read(blk[bs_i], sector_num - bs_offset, buf, n);
1843
            if (ret < 0) {
1844 1845
                error_report("error while reading sector %" PRId64 ": %s",
                             sector_num - bs_offset, strerror(-ret));
1846 1847
                goto out;
            }
B
bellard 已提交
1848 1849 1850 1851 1852
            /* NOTE: at the same time we convert, we do not write zero
               sectors to have a chance to compress the image. Ideally, we
               should add a specific call to have the info to go faster */
            buf1 = buf;
            while (n > 0) {
1853
                if (!has_zero_init ||
1854
                    is_allocated_sectors_min(buf1, n, &n1, min_sparse)) {
1855
                    ret = blk_write(out_blk, sector_num, buf1, n1);
1856
                    if (ret < 0) {
1857 1858
                        error_report("error while writing sector %" PRId64
                                     ": %s", sector_num, strerror(-ret));
1859 1860
                        goto out;
                    }
B
bellard 已提交
1861 1862 1863 1864 1865
                }
                sector_num += n1;
                n -= n1;
                buf1 += n1 * 512;
            }
1866
            qemu_progress_print(100.0 * sectors_read / sectors_to_read, 0);
B
bellard 已提交
1867 1868
        }
    }
1869
out:
1870 1871 1872
    if (!ret) {
        qemu_progress_print(100, 0);
    }
1873
    qemu_progress_end();
1874 1875
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
K
Kevin Wolf 已提交
1876
    qemu_vfree(buf);
1877
    qemu_opts_del(sn_opts);
M
Markus Armbruster 已提交
1878
    blk_unref(out_blk);
1879
    g_free(bs);
M
Markus Armbruster 已提交
1880 1881 1882 1883 1884 1885
    if (blk) {
        for (bs_i = 0; bs_i < bs_n; bs_i++) {
            blk_unref(blk[bs_i]);
        }
        g_free(blk);
    }
1886
    g_free(bs_sectors);
1887 1888 1889
fail_getopt:
    g_free(options);

1890 1891 1892
    if (ret) {
        return 1;
    }
B
bellard 已提交
1893 1894 1895
    return 0;
}

B
bellard 已提交
1896

B
bellard 已提交
1897 1898 1899 1900 1901 1902 1903 1904 1905
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");
1906 1907
    bdrv_snapshot_dump(fprintf, stdout, NULL);
    printf("\n");
B
bellard 已提交
1908 1909
    for(i = 0; i < nb_sns; i++) {
        sn = &sn_tab[i];
1910 1911
        bdrv_snapshot_dump(fprintf, stdout, sn);
        printf("\n");
B
bellard 已提交
1912
    }
1913
    g_free(sn_tab);
B
bellard 已提交
1914 1915
}

1916 1917
static void dump_json_image_info_list(ImageInfoList *list)
{
1918
    Error *local_err = NULL;
1919 1920 1921 1922
    QString *str;
    QmpOutputVisitor *ov = qmp_output_visitor_new();
    QObject *obj;
    visit_type_ImageInfoList(qmp_output_get_visitor(ov),
1923
                             &list, NULL, &local_err);
1924 1925 1926 1927 1928 1929 1930 1931 1932
    obj = qmp_output_get_qobject(ov);
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
    qmp_output_visitor_cleanup(ov);
    QDECREF(str);
}

1933 1934
static void dump_json_image_info(ImageInfo *info)
{
1935
    Error *local_err = NULL;
1936 1937 1938 1939
    QString *str;
    QmpOutputVisitor *ov = qmp_output_visitor_new();
    QObject *obj;
    visit_type_ImageInfo(qmp_output_get_visitor(ov),
1940
                         &info, NULL, &local_err);
1941 1942 1943 1944 1945 1946 1947 1948 1949
    obj = qmp_output_get_qobject(ov);
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
    printf("%s\n", qstring_get_str(str));
    qobject_decref(obj);
    qmp_output_visitor_cleanup(ov);
    QDECREF(str);
}

1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960
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;

1961
        bdrv_image_info_dump(fprintf, stdout, elem->value);
1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988
    }
}

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.
 */
static ImageInfoList *collect_image_info_list(const char *filename,
                                              const char *fmt,
                                              bool chain)
{
    ImageInfoList *head = NULL;
    ImageInfoList **last = &head;
    GHashTable *filenames;
1989
    Error *err = NULL;
1990 1991 1992 1993

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

    while (filename) {
M
Markus Armbruster 已提交
1994
        BlockBackend *blk;
1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005
        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);

2006 2007 2008
        blk = img_open("image", filename, fmt,
                       BDRV_O_FLAGS | BDRV_O_NO_BACKING, false, false);
        if (!blk) {
2009 2010
            goto err;
        }
2011
        bs = blk_bs(blk);
2012

2013
        bdrv_query_image_info(bs, &info, &err);
2014
        if (err) {
2015
            error_report_err(err);
M
Markus Armbruster 已提交
2016
            blk_unref(blk);
2017
            goto err;
2018
        }
2019 2020 2021 2022 2023 2024

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

M
Markus Armbruster 已提交
2025
        blk_unref(blk);
2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047

        filename = fmt = NULL;
        if (chain) {
            if (info->has_full_backing_filename) {
                filename = info->full_backing_filename;
            } else if (info->has_backing_filename) {
                filename = info->backing_filename;
            }
            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;
}

2048 2049 2050 2051
static int img_info(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
2052
    bool chain = false;
2053
    const char *filename, *fmt, *output;
2054
    ImageInfoList *list;
2055

B
bellard 已提交
2056
    fmt = NULL;
2057
    output = NULL;
B
bellard 已提交
2058
    for(;;) {
2059 2060 2061 2062 2063
        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},
2064
            {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2065 2066 2067 2068
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "f:h",
                        long_options, &option_index);
2069
        if (c == -1) {
B
bellard 已提交
2070
            break;
2071
        }
B
bellard 已提交
2072
        switch(c) {
J
Jes Sorensen 已提交
2073
        case '?':
B
bellard 已提交
2074 2075 2076 2077 2078 2079
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2080 2081 2082
        case OPTION_OUTPUT:
            output = optarg;
            break;
2083 2084 2085
        case OPTION_BACKING_CHAIN:
            chain = true;
            break;
B
bellard 已提交
2086 2087
        }
    }
2088
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2089
        error_exit("Expecting one image file name");
2090
    }
B
bellard 已提交
2091 2092
    filename = argv[optind++];

2093 2094 2095 2096 2097 2098
    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.");
2099 2100
        return 1;
    }
2101

2102 2103
    list = collect_image_info_list(filename, fmt, chain);
    if (!list) {
2104
        return 1;
B
bellard 已提交
2105
    }
2106 2107 2108

    switch (output_format) {
    case OFORMAT_HUMAN:
2109
        dump_human_image_info_list(list);
2110 2111
        break;
    case OFORMAT_JSON:
2112 2113 2114 2115 2116
        if (chain) {
            dump_json_image_info_list(list);
        } else {
            dump_json_image_info(list->value);
        }
2117
        break;
B
bellard 已提交
2118
    }
2119

2120
    qapi_free_ImageInfoList(list);
B
bellard 已提交
2121 2122 2123
    return 0;
}

P
Paolo Bonzini 已提交
2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164

typedef struct MapEntry {
    int flags;
    int depth;
    int64_t start;
    int64_t length;
    int64_t offset;
    BlockDriverState *bs;
} MapEntry;

static void dump_map_entry(OutputFormat output_format, MapEntry *e,
                           MapEntry *next)
{
    switch (output_format) {
    case OFORMAT_HUMAN:
        if ((e->flags & BDRV_BLOCK_DATA) &&
            !(e->flags & BDRV_BLOCK_OFFSET_VALID)) {
            error_report("File contains external, encrypted or compressed clusters.");
            exit(1);
        }
        if ((e->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) == BDRV_BLOCK_DATA) {
            printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
                   e->start, e->length, e->offset, e->bs->filename);
        }
        /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
         * Modify the flags here to allow more coalescing.
         */
        if (next &&
            (next->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) != BDRV_BLOCK_DATA) {
            next->flags &= ~BDRV_BLOCK_DATA;
            next->flags |= BDRV_BLOCK_ZERO;
        }
        break;
    case OFORMAT_JSON:
        printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64", \"depth\": %d,"
               " \"zero\": %s, \"data\": %s",
               (e->start == 0 ? "[" : ",\n"),
               e->start, e->length, e->depth,
               (e->flags & BDRV_BLOCK_ZERO) ? "true" : "false",
               (e->flags & BDRV_BLOCK_DATA) ? "true" : "false");
        if (e->flags & BDRV_BLOCK_OFFSET_VALID) {
P
Paolo Bonzini 已提交
2165
            printf(", \"offset\": %"PRId64"", e->offset);
P
Paolo Bonzini 已提交
2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218
        }
        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;

    /* 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 (;;) {
        ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors);
        if (ret < 0) {
            return ret;
        }
        assert(nb_sectors);
        if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
            break;
        }
        bs = bs->backing_hd;
        if (bs == NULL) {
            ret = 0;
            break;
        }

        depth++;
    }

    e->start = sector_num * BDRV_SECTOR_SIZE;
    e->length = nb_sectors * BDRV_SECTOR_SIZE;
    e->flags = ret & ~BDRV_BLOCK_OFFSET_MASK;
    e->offset = ret & BDRV_BLOCK_OFFSET_MASK;
    e->depth = depth;
    e->bs = bs;
    return 0;
}

static int img_map(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
M
Markus Armbruster 已提交
2219
    BlockBackend *blk;
P
Paolo Bonzini 已提交
2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253
    BlockDriverState *bs;
    const char *filename, *fmt, *output;
    int64_t length;
    MapEntry curr = { .length = 0 }, next;
    int ret = 0;

    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},
            {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;
        }
    }
F
Fam Zheng 已提交
2254 2255
    if (optind != argc - 1) {
        error_exit("Expecting one image file name");
P
Paolo Bonzini 已提交
2256
    }
F
Fam Zheng 已提交
2257
    filename = argv[optind];
P
Paolo Bonzini 已提交
2258 2259 2260 2261 2262 2263 2264 2265 2266 2267

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

2268 2269 2270
    blk = img_open("image", filename, fmt, BDRV_O_FLAGS, true, false);
    if (!blk) {
        return 1;
P
Paolo Bonzini 已提交
2271
    }
2272
    bs = blk_bs(blk);
P
Paolo Bonzini 已提交
2273 2274 2275 2276 2277

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

2278
    length = blk_getlength(blk);
P
Paolo Bonzini 已提交
2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312
    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;
        }

        if (curr.length != 0 && curr.flags == next.flags &&
            curr.depth == next.depth &&
            ((curr.flags & BDRV_BLOCK_OFFSET_VALID) == 0 ||
             curr.offset + curr.length == next.offset)) {
            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 已提交
2313
    blk_unref(blk);
P
Paolo Bonzini 已提交
2314 2315 2316
    return ret < 0;
}

2317 2318 2319 2320 2321
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

2322
static int img_snapshot(int argc, char **argv)
2323
{
M
Markus Armbruster 已提交
2324
    BlockBackend *blk;
2325 2326 2327
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
2328
    int c, ret = 0, bdrv_oflags;
2329 2330
    int action = 0;
    qemu_timeval tv;
2331
    bool quiet = false;
2332
    Error *err = NULL;
2333

2334
    bdrv_oflags = BDRV_O_FLAGS | BDRV_O_RDWR;
2335 2336
    /* Parse commandline parameters */
    for(;;) {
2337
        c = getopt(argc, argv, "la:c:d:hq");
2338
        if (c == -1) {
2339
            break;
2340
        }
2341
        switch(c) {
J
Jes Sorensen 已提交
2342
        case '?':
2343 2344
        case 'h':
            help();
2345
            return 0;
2346 2347
        case 'l':
            if (action) {
F
Fam Zheng 已提交
2348
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2349
                return 0;
2350 2351
            }
            action = SNAPSHOT_LIST;
2352
            bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2353 2354 2355
            break;
        case 'a':
            if (action) {
F
Fam Zheng 已提交
2356
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2357
                return 0;
2358 2359 2360 2361 2362 2363
            }
            action = SNAPSHOT_APPLY;
            snapshot_name = optarg;
            break;
        case 'c':
            if (action) {
F
Fam Zheng 已提交
2364
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2365
                return 0;
2366 2367 2368 2369 2370 2371
            }
            action = SNAPSHOT_CREATE;
            snapshot_name = optarg;
            break;
        case 'd':
            if (action) {
F
Fam Zheng 已提交
2372
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2373
                return 0;
2374 2375 2376 2377
            }
            action = SNAPSHOT_DELETE;
            snapshot_name = optarg;
            break;
2378 2379 2380
        case 'q':
            quiet = true;
            break;
2381 2382 2383
        }
    }

2384
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2385
        error_exit("Expecting one image file name");
2386
    }
2387 2388 2389
    filename = argv[optind++];

    /* Open the image */
2390 2391 2392
    blk = img_open("image", filename, NULL, bdrv_oflags, true, quiet);
    if (!blk) {
        return 1;
2393
    }
2394
    bs = blk_bs(blk);
2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410

    /* 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);
2411
        if (ret) {
2412
            error_report("Could not create snapshot '%s': %d (%s)",
2413
                snapshot_name, ret, strerror(-ret));
2414
        }
2415 2416 2417 2418
        break;

    case SNAPSHOT_APPLY:
        ret = bdrv_snapshot_goto(bs, snapshot_name);
2419
        if (ret) {
2420
            error_report("Could not apply snapshot '%s': %d (%s)",
2421
                snapshot_name, ret, strerror(-ret));
2422
        }
2423 2424 2425
        break;

    case SNAPSHOT_DELETE:
2426
        bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2427
        if (err) {
2428 2429 2430 2431
            error_report("Could not delete snapshot '%s': (%s)",
                         snapshot_name, error_get_pretty(err));
            error_free(err);
            ret = 1;
2432
        }
2433 2434 2435 2436
        break;
    }

    /* Cleanup */
M
Markus Armbruster 已提交
2437
    blk_unref(blk);
2438 2439 2440
    if (ret) {
        return 1;
    }
2441
    return 0;
2442 2443
}

K
Kevin Wolf 已提交
2444 2445
static int img_rebase(int argc, char **argv)
{
M
Markus Armbruster 已提交
2446
    BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
2447
    BlockDriverState *bs = NULL;
K
Kevin Wolf 已提交
2448
    char *filename;
2449 2450
    const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
    int c, flags, src_flags, ret;
K
Kevin Wolf 已提交
2451
    int unsafe = 0;
2452
    int progress = 0;
2453
    bool quiet = false;
2454
    Error *local_err = NULL;
K
Kevin Wolf 已提交
2455 2456

    /* Parse commandline parameters */
K
Kevin Wolf 已提交
2457
    fmt = NULL;
2458
    cache = BDRV_DEFAULT_CACHE;
2459
    src_cache = BDRV_DEFAULT_CACHE;
K
Kevin Wolf 已提交
2460 2461 2462
    out_baseimg = NULL;
    out_basefmt = NULL;
    for(;;) {
2463
        c = getopt(argc, argv, "hf:F:b:upt:T:q");
2464
        if (c == -1) {
K
Kevin Wolf 已提交
2465
            break;
2466
        }
K
Kevin Wolf 已提交
2467
        switch(c) {
J
Jes Sorensen 已提交
2468
        case '?':
K
Kevin Wolf 已提交
2469 2470 2471
        case 'h':
            help();
            return 0;
K
Kevin Wolf 已提交
2472 2473 2474
        case 'f':
            fmt = optarg;
            break;
K
Kevin Wolf 已提交
2475 2476 2477 2478 2479 2480 2481 2482 2483
        case 'F':
            out_basefmt = optarg;
            break;
        case 'b':
            out_baseimg = optarg;
            break;
        case 'u':
            unsafe = 1;
            break;
2484 2485 2486
        case 'p':
            progress = 1;
            break;
2487 2488 2489
        case 't':
            cache = optarg;
            break;
2490 2491 2492
        case 'T':
            src_cache = optarg;
            break;
2493 2494 2495
        case 'q':
            quiet = true;
            break;
K
Kevin Wolf 已提交
2496 2497 2498
        }
    }

2499 2500 2501 2502
    if (quiet) {
        progress = 0;
    }

F
Fam Zheng 已提交
2503 2504 2505 2506 2507
    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)");
2508
    }
K
Kevin Wolf 已提交
2509 2510
    filename = argv[optind++];

2511 2512 2513
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

2514
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2515
    ret = bdrv_parse_cache_flags(cache, &flags);
2516 2517
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2518
        goto out;
2519 2520
    }

2521 2522 2523 2524
    src_flags = BDRV_O_FLAGS;
    ret = bdrv_parse_cache_flags(src_cache, &src_flags);
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
2525
        goto out;
2526 2527
    }

K
Kevin Wolf 已提交
2528 2529 2530 2531 2532 2533
    /*
     * 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.
     */
2534 2535
    blk = img_open("image", filename, fmt, flags, true, quiet);
    if (!blk) {
2536 2537
        ret = -1;
        goto out;
2538
    }
2539
    bs = blk_bs(blk);
K
Kevin Wolf 已提交
2540 2541

    if (out_basefmt != NULL) {
2542
        if (bdrv_find_format(out_basefmt) == NULL) {
2543
            error_report("Invalid format name: '%s'", out_basefmt);
2544 2545
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
2546 2547 2548 2549
        }
    }

    /* For safe rebasing we need to compare old and new backing file */
2550
    if (!unsafe) {
2551
        char backing_name[PATH_MAX];
2552 2553 2554 2555 2556 2557
        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 已提交
2558 2559

        bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2560 2561 2562
        blk_old_backing = blk_new_open("old_backing", backing_name, NULL,
                                       options, src_flags, &local_err);
        if (!blk_old_backing) {
2563 2564 2565
            error_report("Could not open old backing file '%s': %s",
                         backing_name, error_get_pretty(local_err));
            error_free(local_err);
2566
            goto out;
K
Kevin Wolf 已提交
2567
        }
2568

2569
        if (out_baseimg[0]) {
2570 2571 2572 2573 2574 2575 2576 2577 2578 2579
            if (out_basefmt) {
                options = qdict_new();
                qdict_put(options, "driver", qstring_from_str(out_basefmt));
            } else {
                options = NULL;
            }

            blk_new_backing = blk_new_open("new_backing", out_baseimg, NULL,
                                           options, src_flags, &local_err);
            if (!blk_new_backing) {
2580 2581 2582
                error_report("Could not open new backing file '%s': %s",
                             out_baseimg, error_get_pretty(local_err));
                error_free(local_err);
2583 2584
                goto out;
            }
K
Kevin Wolf 已提交
2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597
        }
    }

    /*
     * 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) {
2598 2599 2600
        int64_t num_sectors;
        int64_t old_backing_num_sectors;
        int64_t new_backing_num_sectors = 0;
K
Kevin Wolf 已提交
2601
        uint64_t sector;
2602
        int n;
2603 2604
        uint8_t * buf_old;
        uint8_t * buf_new;
2605
        float local_progress = 0;
2606

2607 2608
        buf_old = blk_blockalign(blk, IO_BUF_SIZE);
        buf_new = blk_blockalign(blk, IO_BUF_SIZE);
K
Kevin Wolf 已提交
2609

2610
        num_sectors = blk_nb_sectors(blk);
2611 2612 2613 2614 2615 2616
        if (num_sectors < 0) {
            error_report("Could not get size of '%s': %s",
                         filename, strerror(-num_sectors));
            ret = -1;
            goto out;
        }
2617
        old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
2618
        if (old_backing_num_sectors < 0) {
2619
            char backing_name[PATH_MAX];
2620 2621 2622 2623 2624 2625 2626

            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;
        }
2627 2628
        if (blk_new_backing) {
            new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
2629 2630 2631 2632 2633 2634
            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;
            }
2635
        }
K
Kevin Wolf 已提交
2636

2637 2638 2639 2640 2641
        if (num_sectors != 0) {
            local_progress = (float)100 /
                (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
        }

K
Kevin Wolf 已提交
2642 2643 2644 2645 2646 2647 2648 2649 2650 2651
        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 */
2652
            ret = bdrv_is_allocated(bs, sector, n, &n);
2653 2654 2655 2656 2657
            if (ret < 0) {
                error_report("error while reading image metadata: %s",
                             strerror(-ret));
                goto out;
            }
2658
            if (ret) {
K
Kevin Wolf 已提交
2659 2660 2661
                continue;
            }

2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672
            /*
             * 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;
                }

2673
                ret = blk_read(blk_old_backing, sector, buf_old, n);
2674 2675 2676 2677
                if (ret < 0) {
                    error_report("error while reading from old backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
2678
            }
2679

2680
            if (sector >= new_backing_num_sectors || !blk_new_backing) {
2681 2682 2683 2684 2685 2686
                memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
            } else {
                if (sector + n > new_backing_num_sectors) {
                    n = new_backing_num_sectors - sector;
                }

2687
                ret = blk_read(blk_new_backing, sector, buf_new, n);
2688 2689 2690 2691
                if (ret < 0) {
                    error_report("error while reading from new backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
2692 2693 2694 2695 2696 2697 2698 2699 2700
            }

            /* 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,
2701
                    buf_new + written * 512, n - written, &pnum))
K
Kevin Wolf 已提交
2702
                {
2703 2704
                    ret = blk_write(blk, sector + written,
                                    buf_old + written * 512, pnum);
K
Kevin Wolf 已提交
2705
                    if (ret < 0) {
2706
                        error_report("Error while writing to COW image: %s",
K
Kevin Wolf 已提交
2707
                            strerror(-ret));
2708
                        goto out;
K
Kevin Wolf 已提交
2709 2710 2711 2712 2713
                    }
                }

                written += pnum;
            }
2714
            qemu_progress_print(local_progress, 100);
K
Kevin Wolf 已提交
2715
        }
2716

K
Kevin Wolf 已提交
2717 2718
        qemu_vfree(buf_old);
        qemu_vfree(buf_new);
K
Kevin Wolf 已提交
2719 2720 2721 2722 2723 2724 2725
    }

    /*
     * 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.
     */
2726 2727 2728 2729 2730 2731
    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 已提交
2732
    if (ret == -ENOSPC) {
2733 2734
        error_report("Could not change the backing file to '%s': No "
                     "space left in the file header", out_baseimg);
K
Kevin Wolf 已提交
2735
    } else if (ret < 0) {
2736
        error_report("Could not change the backing file to '%s': %s",
K
Kevin Wolf 已提交
2737 2738 2739
            out_baseimg, strerror(-ret));
    }

2740
    qemu_progress_print(100, 0);
K
Kevin Wolf 已提交
2741 2742 2743 2744 2745 2746
    /*
     * 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.
     */
2747
out:
2748
    qemu_progress_end();
K
Kevin Wolf 已提交
2749 2750
    /* Cleanup */
    if (!unsafe) {
M
Markus Armbruster 已提交
2751 2752
        blk_unref(blk_old_backing);
        blk_unref(blk_new_backing);
K
Kevin Wolf 已提交
2753 2754
    }

M
Markus Armbruster 已提交
2755
    blk_unref(blk);
2756 2757 2758
    if (ret) {
        return 1;
    }
K
Kevin Wolf 已提交
2759 2760 2761
    return 0;
}

2762 2763
static int img_resize(int argc, char **argv)
{
2764
    Error *err = NULL;
2765 2766 2767
    int c, ret, relative;
    const char *filename, *fmt, *size;
    int64_t n, total_size;
2768
    bool quiet = false;
M
Markus Armbruster 已提交
2769
    BlockBackend *blk = NULL;
2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781
    QemuOpts *param;
    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 */
            }
2782 2783 2784
        },
    };

K
Kevin Wolf 已提交
2785 2786 2787
    /* Remove size from argv manually so that negative numbers are not treated
     * as options by getopt. */
    if (argc < 3) {
F
Fam Zheng 已提交
2788
        error_exit("Not enough arguments");
K
Kevin Wolf 已提交
2789 2790 2791 2792 2793 2794
        return 1;
    }

    size = argv[--argc];

    /* Parse getopt arguments */
2795 2796
    fmt = NULL;
    for(;;) {
2797
        c = getopt(argc, argv, "f:hq");
2798 2799 2800 2801
        if (c == -1) {
            break;
        }
        switch(c) {
J
Jes Sorensen 已提交
2802
        case '?':
2803 2804 2805 2806 2807 2808
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2809 2810 2811
        case 'q':
            quiet = true;
            break;
2812 2813
        }
    }
2814
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2815
        error_exit("Expecting one image file name");
2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834
    }
    filename = argv[optind++];

    /* 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 */
2835
    param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
2836
    qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
2837 2838
    if (err) {
        error_report_err(err);
2839
        ret = -1;
2840
        qemu_opts_del(param);
2841
        goto out;
2842
    }
2843 2844
    n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
    qemu_opts_del(param);
2845

2846 2847 2848
    blk = img_open("image", filename, fmt, BDRV_O_FLAGS | BDRV_O_RDWR,
                   true, quiet);
    if (!blk) {
2849 2850
        ret = -1;
        goto out;
2851
    }
2852 2853

    if (relative) {
2854
        total_size = blk_getlength(blk) + n * relative;
2855 2856 2857 2858
    } else {
        total_size = n;
    }
    if (total_size <= 0) {
2859
        error_report("New image size must be positive");
2860 2861
        ret = -1;
        goto out;
2862 2863
    }

2864
    ret = blk_truncate(blk, total_size);
2865 2866
    switch (ret) {
    case 0:
2867
        qprintf(quiet, "Image resized.\n");
2868 2869
        break;
    case -ENOTSUP:
2870
        error_report("This image does not support resize");
2871 2872
        break;
    case -EACCES:
2873
        error_report("Image is read-only");
2874 2875
        break;
    default:
2876
        error_report("Error resizing image (%d)", -ret);
2877 2878
        break;
    }
2879
out:
M
Markus Armbruster 已提交
2880
    blk_unref(blk);
2881 2882 2883
    if (ret) {
        return 1;
    }
2884 2885 2886
    return 0;
}

2887 2888 2889 2890 2891 2892
static void amend_status_cb(BlockDriverState *bs,
                            int64_t offset, int64_t total_work_size)
{
    qemu_progress_print(100.f * offset / total_work_size, 0);
}

M
Max Reitz 已提交
2893 2894
static int img_amend(int argc, char **argv)
{
2895
    Error *err = NULL;
M
Max Reitz 已提交
2896 2897
    int c, ret = 0;
    char *options = NULL;
2898 2899
    QemuOptsList *create_opts = NULL;
    QemuOpts *opts = NULL;
2900 2901
    const char *fmt = NULL, *filename, *cache;
    int flags;
2902
    bool quiet = false, progress = false;
M
Markus Armbruster 已提交
2903
    BlockBackend *blk = NULL;
M
Max Reitz 已提交
2904 2905
    BlockDriverState *bs = NULL;

2906
    cache = BDRV_DEFAULT_CACHE;
M
Max Reitz 已提交
2907
    for (;;) {
2908
        c = getopt(argc, argv, "ho:f:t:pq");
M
Max Reitz 已提交
2909 2910 2911 2912 2913 2914 2915 2916 2917 2918
        if (c == -1) {
            break;
        }

        switch (c) {
            case 'h':
            case '?':
                help();
                break;
            case 'o':
2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930
                if (!is_valid_option_list(optarg)) {
                    error_report("Invalid option list: %s", optarg);
                    ret = -1;
                    goto out;
                }
                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 已提交
2931 2932 2933 2934
                break;
            case 'f':
                fmt = optarg;
                break;
2935 2936 2937
            case 't':
                cache = optarg;
                break;
2938 2939 2940
            case 'p':
                progress = true;
                break;
M
Max Reitz 已提交
2941 2942 2943 2944 2945 2946
            case 'q':
                quiet = true;
                break;
        }
    }

2947
    if (!options) {
F
Fam Zheng 已提交
2948
        error_exit("Must specify options (-o)");
M
Max Reitz 已提交
2949 2950
    }

2951 2952 2953 2954 2955
    if (quiet) {
        progress = false;
    }
    qemu_progress_init(progress, 1.0);

2956 2957 2958 2959 2960 2961
    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 已提交
2962 2963
    }

2964
    if (optind != argc - 1) {
M
Max Reitz 已提交
2965 2966 2967
        error_report("Expecting one image file name");
        ret = -1;
        goto out;
2968
    }
M
Max Reitz 已提交
2969

2970 2971 2972 2973 2974 2975 2976
    flags = BDRV_O_FLAGS | BDRV_O_RDWR;
    ret = bdrv_parse_cache_flags(cache, &flags);
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        goto out;
    }

2977 2978
    blk = img_open("image", filename, fmt, flags, true, quiet);
    if (!blk) {
M
Max Reitz 已提交
2979 2980 2981
        ret = -1;
        goto out;
    }
2982
    bs = blk_bs(blk);
M
Max Reitz 已提交
2983 2984 2985

    fmt = bs->drv->format_name;

2986
    if (has_help_option(options)) {
2987
        /* If the format was auto-detected, print option help here */
M
Max Reitz 已提交
2988 2989 2990 2991
        ret = print_block_option_help(filename, fmt);
        goto out;
    }

2992 2993 2994 2995 2996 2997 2998
    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 已提交
2999
    create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3000
    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
3001 3002 3003 3004 3005 3006 3007 3008
    if (options) {
        qemu_opts_do_parse(opts, options, NULL, &err);
        if (err) {
            error_report("Invalid options for file format '%s'", fmt);
            error_free(err);
            ret = -1;
            goto out;
        }
M
Max Reitz 已提交
3009 3010
    }

3011 3012 3013 3014
    /* In case the driver does not call amend_status_cb() */
    qemu_progress_print(0.f, 0);
    ret = bdrv_amend_options(bs, opts, &amend_status_cb);
    qemu_progress_print(100.f, 0);
M
Max Reitz 已提交
3015 3016 3017 3018 3019 3020
    if (ret < 0) {
        error_report("Error while amending options: %s", strerror(-ret));
        goto out;
    }

out:
3021 3022
    qemu_progress_end();

M
Markus Armbruster 已提交
3023
    blk_unref(blk);
3024 3025
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
3026 3027
    g_free(options);

M
Max Reitz 已提交
3028 3029 3030 3031 3032 3033
    if (ret) {
        return 1;
    }
    return 0;
}

A
Anthony Liguori 已提交
3034
static const img_cmd_t img_cmds[] = {
3035 3036 3037 3038 3039 3040 3041 3042
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
    { NULL, NULL, },
};

B
bellard 已提交
3043 3044
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
3045
    const img_cmd_t *cmd;
3046
    const char *cmdname;
3047
    Error *local_error = NULL;
3048 3049 3050
    int c;
    static const struct option long_options[] = {
        {"help", no_argument, 0, 'h'},
3051
        {"version", no_argument, 0, 'v'},
3052 3053
        {0, 0, 0, 0}
    };
B
bellard 已提交
3054

3055 3056 3057 3058
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

K
Kevin Wolf 已提交
3059
    error_set_progname(argv[0]);
3060
    qemu_init_exec_dir(argv[0]);
K
Kevin Wolf 已提交
3061

3062
    if (qemu_init_main_loop(&local_error)) {
3063
        error_report_err(local_error);
3064 3065 3066
        exit(EXIT_FAILURE);
    }

B
bellard 已提交
3067
    bdrv_init();
F
Fam Zheng 已提交
3068 3069 3070
    if (argc < 2) {
        error_exit("Not enough arguments");
    }
3071 3072 3073
    cmdname = argv[1];

    /* find the command */
3074
    for (cmd = img_cmds; cmd->name != NULL; cmd++) {
3075
        if (!strcmp(cmdname, cmd->name)) {
3076
            return cmd->handler(argc - 1, argv + 1);
3077
        }
B
bellard 已提交
3078
    }
3079

3080
    c = getopt_long(argc, argv, "h", long_options, NULL);
3081 3082 3083 3084

    if (c == 'h') {
        help();
    }
3085 3086 3087 3088
    if (c == 'v') {
        printf(QEMU_IMG_VERSION);
        return 0;
    }
3089

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