qemu-img.c 77.1 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"
32
#include "block/block_int.h"
33
#include "block/qapi.h"
34
#include <getopt.h>
35
#include <stdio.h>
36
#include <stdarg.h>
B
bellard 已提交
37

38 39 40 41
#ifdef _WIN32
#include <windows.h>
#endif

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

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

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

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

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

B
blueswir1 已提交
66
/* Please keep in synch with qemu-img.texi */
P
pbrook 已提交
67
static void help(void)
B
bellard 已提交
68
{
69 70
    const char *help_msg =
           "qemu-img version " QEMU_VERSION ", Copyright (c) 2004-2008 Fabrice Bellard\n"
71 72 73 74
           "usage: qemu-img command [command options]\n"
           "QEMU disk image utility\n"
           "\n"
           "Command syntax:\n"
75 76 77 78 79
#define DEF(option, callback, arg_string)        \
           "  " arg_string "\n"
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
80 81 82 83
           "\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"
84
           "  'cache' is the cache mode used to write the output disk image, the valid\n"
85 86
           "    options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
           "    'directsync' and 'unsafe' (default for convert)\n"
87
           "  'size' is the disk image size in bytes. Optional suffixes\n"
88 89 90
           "    '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"
91 92 93 94 95
           "  '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"
96 97 98 99 100
           "  '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"
101 102 103 104 105
           "  '-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"
106
           "  '-p' show progress of command (only certain commands)\n"
107
           "  '-q' use Quiet mode - do not print any output (except errors)\n"
108 109 110 111 112 113
           "  '-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"
           "       images will always be fully allocated\n"
114
           "  '--output' takes the format in which the output must be done (human or json)\n"
115 116
           "  '-n' skips the target volume creation (useful if the volume is created\n"
           "       prior to running qemu-img)\n"
117
           "\n"
118 119 120 121
           "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"
122
           "       hiding corruption that has already occurred.\n"
123
           "\n"
124 125 126 127 128
           "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"
129 130 131 132 133 134
           "  '-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";
135 136

    printf("%s\nSupported formats:", help_msg);
B
bellard 已提交
137 138 139 140 141
    bdrv_iterate_format(format_print, NULL);
    printf("\n");
    exit(1);
}

S
Stefan Weil 已提交
142
static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
143 144 145 146 147 148 149 150 151 152 153
{
    int ret = 0;
    if (!quiet) {
        va_list args;
        va_start(args, fmt);
        ret = vprintf(fmt, args);
        va_end(args);
    }
    return ret;
}

B
bellard 已提交
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
#if defined(WIN32)
/* XXX: put correct support for win32 */
static int read_password(char *buf, int buf_size)
{
    int c, i;
    printf("Password: ");
    fflush(stdout);
    i = 0;
    for(;;) {
        c = getchar();
        if (c == '\n')
            break;
        if (i < (buf_size - 1))
            buf[i++] = c;
    }
    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;
199

B
bellard 已提交
200 201 202 203 204
    tcsetattr (0, TCSANOW, &tty);

    atexit(term_exit);
}

P
pbrook 已提交
205
static int read_password(char *buf, int buf_size)
B
bellard 已提交
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
{
    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 {
                ret = -1;
                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

242 243 244 245 246 247 248 249
static int print_block_option_help(const char *filename, const char *fmt)
{
    BlockDriver *drv, *proto_drv;
    QEMUOptionParameter *create_options = NULL;

    /* Find driver and parse its options */
    drv = bdrv_find_format(fmt);
    if (!drv) {
250
        error_report("Unknown file format '%s'", fmt);
251 252 253
        return 1;
    }

254
    proto_drv = bdrv_find_protocol(filename, true);
255
    if (!proto_drv) {
256
        error_report("Unknown protocol '%s'", filename);
257 258 259 260 261 262 263 264 265 266 267 268
        return 1;
    }

    create_options = append_option_parameters(create_options,
                                              drv->create_options);
    create_options = append_option_parameters(create_options,
                                              proto_drv->create_options);
    print_option_help(create_options);
    free_option_parameters(create_options);
    return 0;
}

269
static BlockDriverState *bdrv_new_open(const char *filename,
270
                                       const char *fmt,
271
                                       int flags,
272 273
                                       bool require_io,
                                       bool quiet)
274 275 276 277
{
    BlockDriverState *bs;
    BlockDriver *drv;
    char password[256];
278
    Error *local_err = NULL;
279
    int ret;
280

281
    bs = bdrv_new("image");
282

283 284
    if (fmt) {
        drv = bdrv_find_format(fmt);
285
        if (!drv) {
286
            error_report("Unknown file format '%s'", fmt);
287 288
            goto fail;
        }
289 290 291
    } else {
        drv = NULL;
    }
292

293
    ret = bdrv_open(bs, filename, NULL, flags, drv, &local_err);
294
    if (ret < 0) {
295 296 297
        error_report("Could not open '%s': %s", filename,
                     error_get_pretty(local_err));
        error_free(local_err);
298
        goto fail;
299
    }
300

301
    if (bdrv_is_encrypted(bs) && require_io) {
302
        qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
303
        if (read_password(password, sizeof(password)) < 0) {
304
            error_report("No password given");
305 306 307
            goto fail;
        }
        if (bdrv_set_key(bs, password) < 0) {
308
            error_report("invalid password");
309 310
            goto fail;
        }
311 312
    }
    return bs;
313 314
fail:
    if (bs) {
F
Fam Zheng 已提交
315
        bdrv_unref(bs);
316 317
    }
    return NULL;
318 319
}

320
static int add_old_style_options(const char *fmt, QEMUOptionParameter *list,
321 322
                                 const char *base_filename,
                                 const char *base_fmt)
323 324 325
{
    if (base_filename) {
        if (set_option_parameter(list, BLOCK_OPT_BACKING_FILE, base_filename)) {
326 327
            error_report("Backing file not supported for file format '%s'",
                         fmt);
328
            return -1;
329 330 331 332
        }
    }
    if (base_fmt) {
        if (set_option_parameter(list, BLOCK_OPT_BACKING_FMT, base_fmt)) {
333 334
            error_report("Backing file format not supported for file "
                         "format '%s'", fmt);
335
            return -1;
336 337
        }
    }
338
    return 0;
339 340
}

B
bellard 已提交
341 342
static int img_create(int argc, char **argv)
{
343
    int c;
344
    uint64_t img_size = -1;
B
bellard 已提交
345
    const char *fmt = "raw";
346
    const char *base_fmt = NULL;
B
bellard 已提交
347 348
    const char *filename;
    const char *base_filename = NULL;
349
    char *options = NULL;
350
    Error *local_err = NULL;
351
    bool quiet = false;
352

B
bellard 已提交
353
    for(;;) {
354
        c = getopt(argc, argv, "F:b:f:he6o:q");
355
        if (c == -1) {
B
bellard 已提交
356
            break;
357
        }
B
bellard 已提交
358
        switch(c) {
J
Jes Sorensen 已提交
359
        case '?':
B
bellard 已提交
360 361 362
        case 'h':
            help();
            break;
363 364 365
        case 'F':
            base_fmt = optarg;
            break;
B
bellard 已提交
366 367 368 369 370 371 372
        case 'b':
            base_filename = optarg;
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'e':
373
            error_report("option -e is deprecated, please use \'-o "
374 375
                  "encryption\' instead!");
            return 1;
376
        case '6':
377
            error_report("option -6 is deprecated, please use \'-o "
378 379
                  "compat6\' instead!");
            return 1;
380 381 382
        case 'o':
            options = optarg;
            break;
383 384 385
        case 'q':
            quiet = true;
            break;
B
bellard 已提交
386 387
        }
    }
388

389
    /* Get the filename */
390
    if (optind >= argc) {
391
        help();
392
    }
393 394
    filename = argv[optind++];

395 396
    /* Get image size, if specified */
    if (optind < argc) {
397
        int64_t sval;
398 399 400
        char *end;
        sval = strtosz_suffix(argv[optind++], &end, STRTOSZ_DEFSUFFIX_B);
        if (sval < 0 || *end) {
401 402 403 404
            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, "
405 406 407
                      "G, T, P or E suffixes for ");
                error_report("kilobytes, megabytes, gigabytes, terabytes, "
                             "petabytes and exabytes.");
408
            }
409
            return 1;
410 411 412
        }
        img_size = (uint64_t)sval;
    }
413 414 415
    if (optind != argc) {
        help();
    }
416

417
    if (options && is_help_option(options)) {
418
        return print_block_option_help(filename, fmt);
419 420
    }

421
    bdrv_img_create(filename, fmt, base_filename, base_fmt,
422
                    options, img_size, BDRV_O_FLAGS, &local_err, quiet);
423
    if (error_is_set(&local_err)) {
424
        error_report("%s: %s", filename, error_get_pretty(local_err));
425
        error_free(local_err);
426 427
        return 1;
    }
428

B
bellard 已提交
429 430 431
    return 0;
}

432
static void dump_json_image_check(ImageCheck *check, bool quiet)
433 434 435 436 437 438 439 440 441 442
{
    Error *errp = NULL;
    QString *str;
    QmpOutputVisitor *ov = qmp_output_visitor_new();
    QObject *obj;
    visit_type_ImageCheck(qmp_output_get_visitor(ov),
                          &check, NULL, &errp);
    obj = qmp_output_get_qobject(ov);
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
443
    qprintf(quiet, "%s\n", qstring_get_str(str));
444 445 446 447 448
    qobject_decref(obj);
    qmp_output_visitor_cleanup(ov);
    QDECREF(str);
}

449
static void dump_human_image_check(ImageCheck *check, bool quiet)
450 451
{
    if (!(check->corruptions || check->leaks || check->check_errors)) {
452
        qprintf(quiet, "No errors were found on the image.\n");
453 454
    } else {
        if (check->corruptions) {
455 456 457 458
            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);
459 460 461
        }

        if (check->leaks) {
462 463 464 465
            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);
466 467 468
        }

        if (check->check_errors) {
469 470 471 472
            qprintf(quiet,
                    "\n%" PRId64
                    " internal errors have occurred during the check.\n",
                    check->check_errors);
473 474 475 476
        }
    }

    if (check->total_clusters != 0 && check->allocated_clusters != 0) {
477 478 479 480 481 482 483
        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);
484 485 486
    }

    if (check->image_end_offset) {
487 488
        qprintf(quiet,
                "Image end offset: %" PRId64 "\n", check->image_end_offset);
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
    }
}

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;
525 526
    check->compressed_clusters      = result.bfi.compressed_clusters;
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
527 528 529 530

    return 0;
}

531 532 533 534 535 536 537 538
/*
 * Checks an image for consistency. Exit codes:
 *
 * 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
 */
539 540 541
static int img_check(int argc, char **argv)
{
    int c, ret;
542 543
    OutputFormat output_format = OFORMAT_HUMAN;
    const char *filename, *fmt, *output;
544
    BlockDriverState *bs;
545
    int fix = 0;
546
    int flags = BDRV_O_FLAGS | BDRV_O_CHECK;
547
    ImageCheck *check;
548
    bool quiet = false;
549 550

    fmt = NULL;
551
    output = NULL;
552
    for(;;) {
553 554 555 556 557 558 559 560
        int option_index = 0;
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"format", required_argument, 0, 'f'},
            {"repair", no_argument, 0, 'r'},
            {"output", required_argument, 0, OPTION_OUTPUT},
            {0, 0, 0, 0}
        };
561
        c = getopt_long(argc, argv, "f:hr:q",
562
                        long_options, &option_index);
563
        if (c == -1) {
564
            break;
565
        }
566
        switch(c) {
J
Jes Sorensen 已提交
567
        case '?':
568 569 570 571 572 573
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
574 575 576 577 578 579 580 581 582 583 584
        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 {
                help();
            }
            break;
585 586 587
        case OPTION_OUTPUT:
            output = optarg;
            break;
588 589 590
        case 'q':
            quiet = true;
            break;
591 592
        }
    }
593
    if (optind != argc - 1) {
594
        help();
595
    }
596 597
    filename = argv[optind++];

598 599 600 601 602 603 604 605 606
    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;
    }

607
    bs = bdrv_new_open(filename, fmt, flags, true, quiet);
608 609 610
    if (!bs) {
        return 1;
    }
611 612 613

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
614 615

    if (ret == -ENOTSUP) {
616 617 618
        if (output_format == OFORMAT_HUMAN) {
            error_report("This image format does not support checks");
        }
619
        ret = 63;
620
        goto fail;
621 622
    }

623 624
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
625

626 627
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
628

629
        if (output_format == OFORMAT_HUMAN) {
630 631 632 633 634 635 636
            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);
637 638
        }

639
        ret = collect_image_check(bs, check, filename, fmt, 0);
640

641 642
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
643 644
    }

645 646
    switch (output_format) {
    case OFORMAT_HUMAN:
647
        dump_human_image_check(check, quiet);
648 649
        break;
    case OFORMAT_JSON:
650
        dump_json_image_check(check, quiet);
651
        break;
652 653
    }

654 655 656
    if (ret || check->check_errors) {
        ret = 1;
        goto fail;
657
    }
658

659 660 661 662
    if (check->corruptions) {
        ret = 2;
    } else if (check->leaks) {
        ret = 3;
663
    } else {
664
        ret = 0;
665
    }
666 667 668

fail:
    qapi_free_ImageCheck(check);
F
Fam Zheng 已提交
669
    bdrv_unref(bs);
670 671

    return ret;
672 673
}

B
bellard 已提交
674 675
static int img_commit(int argc, char **argv)
{
676 677
    int c, ret, flags;
    const char *filename, *fmt, *cache;
B
bellard 已提交
678
    BlockDriverState *bs;
679
    bool quiet = false;
B
bellard 已提交
680 681

    fmt = NULL;
682
    cache = BDRV_DEFAULT_CACHE;
B
bellard 已提交
683
    for(;;) {
684
        c = getopt(argc, argv, "f:ht:q");
685
        if (c == -1) {
B
bellard 已提交
686
            break;
687
        }
B
bellard 已提交
688
        switch(c) {
J
Jes Sorensen 已提交
689
        case '?':
B
bellard 已提交
690 691 692 693 694 695
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
696 697 698
        case 't':
            cache = optarg;
            break;
699 700 701
        case 'q':
            quiet = true;
            break;
B
bellard 已提交
702 703
        }
    }
704
    if (optind != argc - 1) {
B
bellard 已提交
705
        help();
706
    }
B
bellard 已提交
707 708
    filename = argv[optind++];

709
    flags = BDRV_O_RDWR;
710
    ret = bdrv_parse_cache_flags(cache, &flags);
711 712 713 714 715
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        return -1;
    }

716
    bs = bdrv_new_open(filename, fmt, flags, true, quiet);
717 718 719
    if (!bs) {
        return 1;
    }
B
bellard 已提交
720 721 722
    ret = bdrv_commit(bs);
    switch(ret) {
    case 0:
723
        qprintf(quiet, "Image committed.\n");
B
bellard 已提交
724 725
        break;
    case -ENOENT:
726
        error_report("No disk inserted");
B
bellard 已提交
727 728
        break;
    case -EACCES:
729
        error_report("Image is read-only");
B
bellard 已提交
730 731
        break;
    case -ENOTSUP:
732
        error_report("Image is already committed");
B
bellard 已提交
733 734
        break;
    default:
735
        error_report("Error while committing image");
B
bellard 已提交
736 737 738
        break;
    }

F
Fam Zheng 已提交
739
    bdrv_unref(bs);
740 741 742
    if (ret) {
        return 1;
    }
B
bellard 已提交
743 744 745
    return 0;
}

746 747 748 749 750 751 752
/*
 * 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 已提交
753 754
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
{
755 756
    bool is_zero;
    int i;
B
bellard 已提交
757 758 759 760 761

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
762
    is_zero = buffer_is_zero(buf, 512);
B
bellard 已提交
763 764
    for(i = 1; i < n; i++) {
        buf += 512;
765
        if (is_zero != buffer_is_zero(buf, 512)) {
B
bellard 已提交
766
            break;
767
        }
B
bellard 已提交
768 769
    }
    *pnum = i;
770
    return !is_zero;
B
bellard 已提交
771 772
}

773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
/*
 * 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 已提交
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
/*
 * 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)
{
    int res, i;

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

846
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
847

848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 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
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.
 *
 * @param bs:  Driver used for accessing file
 * @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
 */
static int check_empty_sectors(BlockDriverState *bs, int64_t sect_num,
                               int sect_count, const char *filename,
                               uint8_t *buffer, bool quiet)
{
    int pnum, ret = 0;
    ret = bdrv_read(bs, sect_num, buffer, sect_count);
    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)
{
    const char *fmt1 = NULL, *fmt2 = NULL, *filename1, *filename2;
    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;
    int64_t total_sectors;
    int64_t sector_num = 0;
    int64_t nb_sectors;
    int c, pnum;
    uint64_t bs_sectors;
    uint64_t progress_base;

    for (;;) {
        c = getopt(argc, argv, "hpf:F:sq");
        if (c == -1) {
            break;
        }
        switch (c) {
        case '?':
        case 'h':
            help();
            break;
        case 'f':
            fmt1 = optarg;
            break;
        case 'F':
            fmt2 = optarg;
            break;
        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;
    }


950
    if (optind != argc - 2) {
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
        help();
    }
    filename1 = argv[optind++];
    filename2 = argv[optind++];

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

    bs1 = bdrv_new_open(filename1, fmt1, BDRV_O_FLAGS, true, quiet);
    if (!bs1) {
        error_report("Can't open file %s", filename1);
        ret = 2;
        goto out3;
    }

    bs2 = bdrv_new_open(filename2, fmt2, BDRV_O_FLAGS, true, quiet);
    if (!bs2) {
        error_report("Can't open file %s", filename2);
        ret = 2;
        goto out2;
    }

    buf1 = qemu_blockalign(bs1, IO_BUF_SIZE);
    buf2 = qemu_blockalign(bs2, IO_BUF_SIZE);
    bdrv_get_geometry(bs1, &bs_sectors);
    total_sectors1 = bs_sectors;
    bdrv_get_geometry(bs2, &bs_sectors);
    total_sectors2 = bs_sectors;
    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) {
                ret = bdrv_read(bs1, sector_num, buf1, nb_sectors);
                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;
                }
                ret = bdrv_read(bs2, sector_num, buf2, nb_sectors);
                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));
1035
                    ret = 1;
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
                    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) {
                ret = check_empty_sectors(bs1, sector_num, nb_sectors,
                                          filename1, buf1, quiet);
            } else {
                ret = check_empty_sectors(bs2, sector_num, nb_sectors,
                                          filename2, buf1, quiet);
            }
            if (ret) {
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64 ": %s",
                                 sectors_to_bytes(sector_num), strerror(-ret));
1059
                    ret = 4;
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
                }
                goto out;
            }
        }
        sector_num += nb_sectors;
        qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
    }

    if (total_sectors1 != total_sectors2) {
        BlockDriverState *bs_over;
        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;
            bs_over = bs1;
            filename_over = filename1;
        } else {
            total_sectors_over = total_sectors2;
            bs_over = bs2;
            filename_over = filename2;
        }

        for (;;) {
            nb_sectors = sectors_to_process(total_sectors_over, sector_num);
            if (nb_sectors <= 0) {
                break;
            }
            ret = bdrv_is_allocated_above(bs_over, NULL, sector_num,
                                          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) {
                ret = check_empty_sectors(bs_over, sector_num, nb_sectors,
                                          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));
1107
                        ret = 4;
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
                    }
                    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:
F
Fam Zheng 已提交
1121
    bdrv_unref(bs2);
1122 1123 1124
    qemu_vfree(buf1);
    qemu_vfree(buf2);
out2:
F
Fam Zheng 已提交
1125
    bdrv_unref(bs1);
1126 1127 1128 1129 1130
out3:
    qemu_progress_end();
    return ret;
}

B
bellard 已提交
1131 1132
static int img_convert(int argc, char **argv)
{
1133
    int c, n, n1, bs_n, bs_i, compress, cluster_size,
1134
        cluster_sectors, skip_create;
1135
    int64_t ret = 0;
1136 1137
    int progress = 0, flags;
    const char *fmt, *out_fmt, *cache, *out_baseimg, *out_filename;
1138
    BlockDriver *drv, *proto_drv;
1139
    BlockDriverState **bs = NULL, *out_bs = NULL;
1140 1141
    int64_t total_sectors, nb_sectors, sector_num, bs_offset,
            sector_num_next_status = 0;
1142
    uint64_t bs_sectors;
1143
    uint8_t * buf = NULL;
B
bellard 已提交
1144
    const uint8_t *buf1;
B
bellard 已提交
1145
    BlockDriverInfo bdi;
1146
    QEMUOptionParameter *param = NULL, *create_options = NULL;
1147
    QEMUOptionParameter *out_baseimg_param;
1148
    char *options = NULL;
E
edison 已提交
1149
    const char *snapshot_name = NULL;
1150
    int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1151
    bool quiet = false;
1152
    Error *local_err = NULL;
1153
    QemuOpts *sn_opts = NULL;
B
bellard 已提交
1154 1155 1156

    fmt = NULL;
    out_fmt = "raw";
1157
    cache = "unsafe";
1158
    out_baseimg = NULL;
1159
    compress = 0;
1160
    skip_create = 0;
B
bellard 已提交
1161
    for(;;) {
1162
        c = getopt(argc, argv, "f:O:B:s:hce6o:pS:t:qnl:");
1163
        if (c == -1) {
B
bellard 已提交
1164
            break;
1165
        }
B
bellard 已提交
1166
        switch(c) {
J
Jes Sorensen 已提交
1167
        case '?':
B
bellard 已提交
1168 1169 1170 1171 1172 1173 1174 1175 1176
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'O':
            out_fmt = optarg;
            break;
1177 1178 1179
        case 'B':
            out_baseimg = optarg;
            break;
B
bellard 已提交
1180
        case 'c':
1181
            compress = 1;
B
bellard 已提交
1182 1183
            break;
        case 'e':
1184
            error_report("option -e is deprecated, please use \'-o "
1185 1186
                  "encryption\' instead!");
            return 1;
1187
        case '6':
1188
            error_report("option -6 is deprecated, please use \'-o "
1189 1190
                  "compat6\' instead!");
            return 1;
1191 1192 1193
        case 'o':
            options = optarg;
            break;
E
edison 已提交
1194 1195 1196
        case 's':
            snapshot_name = optarg;
            break;
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
        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);
                    return 1;
                }
            } else {
                snapshot_name = optarg;
            }
            break;
1209 1210 1211
        case 'S':
        {
            int64_t sval;
1212 1213 1214
            char *end;
            sval = strtosz_suffix(optarg, &end, STRTOSZ_DEFSUFFIX_B);
            if (sval < 0 || *end) {
1215 1216 1217 1218 1219 1220 1221
                error_report("Invalid minimum zero buffer size for sparse output specified");
                return 1;
            }

            min_sparse = sval / BDRV_SECTOR_SIZE;
            break;
        }
1222 1223 1224
        case 'p':
            progress = 1;
            break;
1225 1226 1227
        case 't':
            cache = optarg;
            break;
1228 1229 1230
        case 'q':
            quiet = true;
            break;
1231 1232 1233
        case 'n':
            skip_create = 1;
            break;
B
bellard 已提交
1234 1235
        }
    }
1236

1237 1238 1239 1240
    if (quiet) {
        progress = 0;
    }

1241
    bs_n = argc - optind - 1;
1242 1243 1244
    if (bs_n < 1) {
        help();
    }
1245 1246

    out_filename = argv[argc - 1];
1247

1248 1249 1250
    /* Initialize before goto out */
    qemu_progress_init(progress, 2.0);

1251
    if (options && is_help_option(options)) {
1252 1253 1254 1255
        ret = print_block_option_help(out_filename, out_fmt);
        goto out;
    }

1256
    if (bs_n > 1 && out_baseimg) {
1257 1258
        error_report("-B makes no sense when concatenating multiple input "
                     "images");
1259 1260
        ret = -1;
        goto out;
1261
    }
1262

1263 1264
    qemu_progress_print(0, 100);

1265
    bs = g_malloc0(bs_n * sizeof(BlockDriverState *));
1266 1267 1268

    total_sectors = 0;
    for (bs_i = 0; bs_i < bs_n; bs_i++) {
1269 1270
        bs[bs_i] = bdrv_new_open(argv[optind + bs_i], fmt, BDRV_O_FLAGS, true,
                                 quiet);
1271
        if (!bs[bs_i]) {
1272
            error_report("Could not open '%s'", argv[optind + bs_i]);
1273 1274 1275
            ret = -1;
            goto out;
        }
1276 1277 1278
        bdrv_get_geometry(bs[bs_i], &bs_sectors);
        total_sectors += bs_sectors;
    }
B
bellard 已提交
1279

1280 1281 1282 1283 1284 1285
    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 已提交
1286
        if (bs_n > 1) {
1287
            error_report("No support for concatenating multiple snapshot");
E
edison 已提交
1288 1289 1290
            ret = -1;
            goto out;
        }
1291 1292

        bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1293 1294 1295 1296 1297 1298 1299
    }
    if (error_is_set(&local_err)) {
        error_report("Failed to load snapshot: %s",
                     error_get_pretty(local_err));
        error_free(local_err);
        ret = -1;
        goto out;
E
edison 已提交
1300 1301
    }

1302
    /* Find driver and parse its options */
B
bellard 已提交
1303
    drv = bdrv_find_format(out_fmt);
1304
    if (!drv) {
1305
        error_report("Unknown file format '%s'", out_fmt);
1306 1307 1308
        ret = -1;
        goto out;
    }
1309

1310
    proto_drv = bdrv_find_protocol(out_filename, true);
1311
    if (!proto_drv) {
1312
        error_report("Unknown protocol '%s'", out_filename);
1313 1314 1315
        ret = -1;
        goto out;
    }
1316 1317 1318 1319 1320

    create_options = append_option_parameters(create_options,
                                              drv->create_options);
    create_options = append_option_parameters(create_options,
                                              proto_drv->create_options);
1321

1322
    if (options) {
1323
        param = parse_option_parameters(options, create_options, param);
1324
        if (param == NULL) {
1325
            error_report("Invalid options for file format '%s'.", out_fmt);
1326 1327
            ret = -1;
            goto out;
1328 1329
        }
    } else {
1330
        param = parse_option_parameters("", create_options, param);
1331 1332 1333
    }

    set_option_parameter_int(param, BLOCK_OPT_SIZE, total_sectors * 512);
1334
    ret = add_old_style_options(out_fmt, param, out_baseimg, NULL);
1335 1336 1337
    if (ret < 0) {
        goto out;
    }
1338

1339 1340 1341 1342 1343 1344
    /* Get backing file name if -o backing_file was used */
    out_baseimg_param = get_option_parameter(param, BLOCK_OPT_BACKING_FILE);
    if (out_baseimg_param) {
        out_baseimg = out_baseimg_param->value.s;
    }

1345
    /* Check if compression is supported */
1346
    if (compress) {
1347 1348
        QEMUOptionParameter *encryption =
            get_option_parameter(param, BLOCK_OPT_ENCRYPT);
1349 1350
        QEMUOptionParameter *preallocation =
            get_option_parameter(param, BLOCK_OPT_PREALLOC);
1351 1352

        if (!drv->bdrv_write_compressed) {
1353
            error_report("Compression not supported for this file format");
1354 1355
            ret = -1;
            goto out;
1356 1357 1358
        }

        if (encryption && encryption->value.n) {
1359 1360
            error_report("Compression and encryption not supported at "
                         "the same time");
1361 1362
            ret = -1;
            goto out;
1363
        }
1364 1365 1366 1367 1368 1369 1370 1371 1372

        if (preallocation && preallocation->value.s
            && strcmp(preallocation->value.s, "off"))
        {
            error_report("Compression and preallocation not supported at "
                         "the same time");
            ret = -1;
            goto out;
        }
1373 1374
    }

1375 1376
    if (!skip_create) {
        /* Create the new image */
1377
        ret = bdrv_create(drv, out_filename, param, &local_err);
1378
        if (ret < 0) {
1379 1380 1381
            error_report("%s: error while converting %s: %s",
                         out_filename, out_fmt, error_get_pretty(local_err));
            error_free(local_err);
1382
            goto out;
B
bellard 已提交
1383 1384
        }
    }
1385

1386
    flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
1387
    ret = bdrv_parse_cache_flags(cache, &flags);
1388 1389 1390 1391 1392
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        return -1;
    }

1393
    out_bs = bdrv_new_open(out_filename, out_fmt, flags, true, quiet);
1394 1395 1396 1397
    if (!out_bs) {
        ret = -1;
        goto out;
    }
B
bellard 已提交
1398

1399 1400 1401
    bs_i = 0;
    bs_offset = 0;
    bdrv_get_geometry(bs[0], &bs_sectors);
K
Kevin Wolf 已提交
1402
    buf = qemu_blockalign(out_bs, IO_BUF_SIZE);
1403

1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417
    if (skip_create) {
        int64_t output_length = bdrv_getlength(out_bs);
        if (output_length < 0) {
            error_report("unable to get output image length: %s\n",
                         strerror(-output_length));
            ret = -1;
            goto out;
        } else if (output_length < total_sectors << BDRV_SECTOR_BITS) {
            error_report("output file is smaller than input file");
            ret = -1;
            goto out;
        }
    }

1418
    if (compress) {
1419 1420
        ret = bdrv_get_info(out_bs, &bdi);
        if (ret < 0) {
1421
            error_report("could not get block driver info");
1422 1423
            goto out;
        }
B
bellard 已提交
1424
        cluster_size = bdi.cluster_size;
1425
        if (cluster_size <= 0 || cluster_size > IO_BUF_SIZE) {
1426
            error_report("invalid cluster size");
1427 1428 1429
            ret = -1;
            goto out;
        }
B
bellard 已提交
1430 1431
        cluster_sectors = cluster_size >> 9;
        sector_num = 0;
1432 1433 1434

        nb_sectors = total_sectors;

B
bellard 已提交
1435
        for(;;) {
1436 1437 1438 1439
            int64_t bs_num;
            int remainder;
            uint8_t *buf2;

B
bellard 已提交
1440 1441 1442 1443 1444 1445 1446
            nb_sectors = total_sectors - sector_num;
            if (nb_sectors <= 0)
                break;
            if (nb_sectors >= cluster_sectors)
                n = cluster_sectors;
            else
                n = nb_sectors;
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459

            bs_num = sector_num - bs_offset;
            assert (bs_num >= 0);
            remainder = n;
            buf2 = buf;
            while (remainder > 0) {
                int nlow;
                while (bs_num == bs_sectors) {
                    bs_i++;
                    assert (bs_i < bs_n);
                    bs_offset += bs_sectors;
                    bdrv_get_geometry(bs[bs_i], &bs_sectors);
                    bs_num = 0;
B
Blue Swirl 已提交
1460 1461 1462
                    /* printf("changing part: sector_num=%" PRId64 ", "
                       "bs_i=%d, bs_offset=%" PRId64 ", bs_sectors=%" PRId64
                       "\n", sector_num, bs_i, bs_offset, bs_sectors); */
1463 1464 1465 1466 1467
                }
                assert (bs_num < bs_sectors);

                nlow = (remainder > bs_sectors - bs_num) ? bs_sectors - bs_num : remainder;

1468 1469
                ret = bdrv_read(bs[bs_i], bs_num, buf2, nlow);
                if (ret < 0) {
1470 1471
                    error_report("error while reading sector %" PRId64 ": %s",
                                 bs_num, strerror(-ret));
1472 1473
                    goto out;
                }
1474 1475 1476 1477 1478 1479 1480 1481

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

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

1482 1483
            if (!buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)) {
                ret = bdrv_write_compressed(out_bs, sector_num, buf, n);
1484
                if (ret != 0) {
1485 1486
                    error_report("error while compressing sector %" PRId64
                                 ": %s", sector_num, strerror(-ret));
1487 1488
                    goto out;
                }
B
bellard 已提交
1489 1490
            }
            sector_num += n;
1491
            qemu_progress_print(100.0 * sector_num / total_sectors, 0);
B
bellard 已提交
1492
        }
B
bellard 已提交
1493 1494
        /* signal EOF to align */
        bdrv_write_compressed(out_bs, 0, NULL, 0);
B
bellard 已提交
1495
    } else {
1496
        int has_zero_init = min_sparse ? bdrv_has_zero_init(out_bs) : 0;
K
Kevin Wolf 已提交
1497

1498 1499 1500 1501 1502 1503 1504 1505
        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;
        }

1506
        sector_num = 0; // total number of sectors converted so far
1507 1508
        nb_sectors = total_sectors - sector_num;

B
bellard 已提交
1509 1510
        for(;;) {
            nb_sectors = total_sectors - sector_num;
1511
            if (nb_sectors <= 0) {
1512
                ret = 0;
B
bellard 已提交
1513
                break;
1514
            }
1515 1516 1517 1518 1519 1520

            while (sector_num - bs_offset >= bs_sectors) {
                bs_i ++;
                assert (bs_i < bs_n);
                bs_offset += bs_sectors;
                bdrv_get_geometry(bs[bs_i], &bs_sectors);
B
Blue Swirl 已提交
1521 1522
                /* printf("changing part: sector_num=%" PRId64 ", bs_i=%d, "
                  "bs_offset=%" PRId64 ", bs_sectors=%" PRId64 "\n",
1523 1524 1525
                   sector_num, bs_i, bs_offset, bs_sectors); */
            }

1526 1527 1528 1529 1530
            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);
1531
                if (ret < 0) {
1532 1533 1534
                    error_report("error while reading block status of sector %"
                                 PRId64 ": %s", sector_num - bs_offset,
                                 strerror(-ret));
1535 1536
                    goto out;
                }
1537 1538 1539 1540
                /* 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)) {
1541 1542
                    sector_num += n1;
                    continue;
1543
                }
1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
                /* 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;
1560 1561
            }

1562 1563 1564 1565
            n = MIN(nb_sectors, IO_BUF_SIZE / 512);
            n = MIN(n, bs_sectors - (sector_num - bs_offset));
            n1 = n;

1566 1567
            ret = bdrv_read(bs[bs_i], sector_num - bs_offset, buf, n);
            if (ret < 0) {
1568 1569
                error_report("error while reading sector %" PRId64 ": %s",
                             sector_num - bs_offset, strerror(-ret));
1570 1571
                goto out;
            }
B
bellard 已提交
1572 1573 1574 1575 1576
            /* 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) {
1577
                if (!has_zero_init ||
1578
                    is_allocated_sectors_min(buf1, n, &n1, min_sparse)) {
1579 1580
                    ret = bdrv_write(out_bs, sector_num, buf1, n1);
                    if (ret < 0) {
1581 1582
                        error_report("error while writing sector %" PRId64
                                     ": %s", sector_num, strerror(-ret));
1583 1584
                        goto out;
                    }
B
bellard 已提交
1585 1586 1587 1588 1589
                }
                sector_num += n1;
                n -= n1;
                buf1 += n1 * 512;
            }
1590
            qemu_progress_print(100.0 * sector_num / total_sectors, 0);
B
bellard 已提交
1591 1592
        }
    }
1593
out:
1594 1595 1596
    if (!ret) {
        qemu_progress_print(100, 0);
    }
1597
    qemu_progress_end();
1598 1599
    free_option_parameters(create_options);
    free_option_parameters(param);
K
Kevin Wolf 已提交
1600
    qemu_vfree(buf);
1601 1602 1603
    if (sn_opts) {
        qemu_opts_del(sn_opts);
    }
1604
    if (out_bs) {
F
Fam Zheng 已提交
1605
        bdrv_unref(out_bs);
1606
    }
1607 1608 1609
    if (bs) {
        for (bs_i = 0; bs_i < bs_n; bs_i++) {
            if (bs[bs_i]) {
F
Fam Zheng 已提交
1610
                bdrv_unref(bs[bs_i]);
1611
            }
1612
        }
1613
        g_free(bs);
1614 1615 1616 1617
    }
    if (ret) {
        return 1;
    }
B
bellard 已提交
1618 1619 1620
    return 0;
}

B
bellard 已提交
1621

B
bellard 已提交
1622 1623 1624 1625 1626 1627 1628 1629 1630
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");
1631 1632
    bdrv_snapshot_dump(fprintf, stdout, NULL);
    printf("\n");
B
bellard 已提交
1633 1634
    for(i = 0; i < nb_sns; i++) {
        sn = &sn_tab[i];
1635 1636
        bdrv_snapshot_dump(fprintf, stdout, sn);
        printf("\n");
B
bellard 已提交
1637
    }
1638
    g_free(sn_tab);
B
bellard 已提交
1639 1640
}

1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657
static void dump_json_image_info_list(ImageInfoList *list)
{
    Error *errp = NULL;
    QString *str;
    QmpOutputVisitor *ov = qmp_output_visitor_new();
    QObject *obj;
    visit_type_ImageInfoList(qmp_output_get_visitor(ov),
                             &list, NULL, &errp);
    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);
}

1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674
static void dump_json_image_info(ImageInfo *info)
{
    Error *errp = NULL;
    QString *str;
    QmpOutputVisitor *ov = qmp_output_visitor_new();
    QObject *obj;
    visit_type_ImageInfo(qmp_output_get_visitor(ov),
                         &info, NULL, &errp);
    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);
}

1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685
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;

1686
        bdrv_image_info_dump(fprintf, stdout, elem->value);
1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713
    }
}

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;
1714
    Error *err = NULL;
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730

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

    while (filename) {
        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);

        bs = bdrv_new_open(filename, fmt, BDRV_O_FLAGS | BDRV_O_NO_BACKING,
1731
                           false, false);
1732 1733 1734 1735
        if (!bs) {
            goto err;
        }

1736 1737 1738 1739 1740
        bdrv_query_image_info(bs, &info, &err);
        if (error_is_set(&err)) {
            error_report("%s", error_get_pretty(err));
            error_free(err);
            goto err;
1741
        }
1742 1743 1744 1745 1746 1747

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

F
Fam Zheng 已提交
1748
        bdrv_unref(bs);
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770

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

1771 1772 1773 1774
static int img_info(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
1775
    bool chain = false;
1776
    const char *filename, *fmt, *output;
1777
    ImageInfoList *list;
1778

B
bellard 已提交
1779
    fmt = NULL;
1780
    output = NULL;
B
bellard 已提交
1781
    for(;;) {
1782 1783 1784 1785 1786
        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},
1787
            {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
1788 1789 1790 1791
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "f:h",
                        long_options, &option_index);
1792
        if (c == -1) {
B
bellard 已提交
1793
            break;
1794
        }
B
bellard 已提交
1795
        switch(c) {
J
Jes Sorensen 已提交
1796
        case '?':
B
bellard 已提交
1797 1798 1799 1800 1801 1802
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
1803 1804 1805
        case OPTION_OUTPUT:
            output = optarg;
            break;
1806 1807 1808
        case OPTION_BACKING_CHAIN:
            chain = true;
            break;
B
bellard 已提交
1809 1810
        }
    }
1811
    if (optind != argc - 1) {
B
bellard 已提交
1812
        help();
1813
    }
B
bellard 已提交
1814 1815
    filename = argv[optind++];

1816 1817 1818 1819 1820 1821
    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.");
1822 1823
        return 1;
    }
1824

1825 1826
    list = collect_image_info_list(filename, fmt, chain);
    if (!list) {
1827
        return 1;
B
bellard 已提交
1828
    }
1829 1830 1831

    switch (output_format) {
    case OFORMAT_HUMAN:
1832
        dump_human_image_info_list(list);
1833 1834
        break;
    case OFORMAT_JSON:
1835 1836 1837 1838 1839
        if (chain) {
            dump_json_image_info_list(list);
        } else {
            dump_json_image_info(list->value);
        }
1840
        break;
B
bellard 已提交
1841
    }
1842

1843
    qapi_free_ImageInfoList(list);
B
bellard 已提交
1844 1845 1846
    return 0;
}

P
Paolo Bonzini 已提交
1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887

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 已提交
1888
            printf(", \"offset\": %"PRId64"", e->offset);
P
Paolo Bonzini 已提交
1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 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 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037
        }
        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;
    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;
        }
    }
    if (optind >= argc) {
        help();
    }
    filename = argv[optind++];

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

    bs = bdrv_new_open(filename, fmt, BDRV_O_FLAGS, true, false);
    if (!bs) {
        return 1;
    }

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

    length = bdrv_getlength(bs);
    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:
    bdrv_unref(bs);
    return ret < 0;
}

2038 2039 2040 2041 2042
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

2043
static int img_snapshot(int argc, char **argv)
2044 2045 2046 2047
{
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
2048
    int c, ret = 0, bdrv_oflags;
2049 2050
    int action = 0;
    qemu_timeval tv;
2051
    bool quiet = false;
2052
    Error *err = NULL;
2053

2054
    bdrv_oflags = BDRV_O_FLAGS | BDRV_O_RDWR;
2055 2056
    /* Parse commandline parameters */
    for(;;) {
2057
        c = getopt(argc, argv, "la:c:d:hq");
2058
        if (c == -1) {
2059
            break;
2060
        }
2061
        switch(c) {
J
Jes Sorensen 已提交
2062
        case '?':
2063 2064
        case 'h':
            help();
2065
            return 0;
2066 2067 2068
        case 'l':
            if (action) {
                help();
2069
                return 0;
2070 2071
            }
            action = SNAPSHOT_LIST;
2072
            bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2073 2074 2075 2076
            break;
        case 'a':
            if (action) {
                help();
2077
                return 0;
2078 2079 2080 2081 2082 2083 2084
            }
            action = SNAPSHOT_APPLY;
            snapshot_name = optarg;
            break;
        case 'c':
            if (action) {
                help();
2085
                return 0;
2086 2087 2088 2089 2090 2091 2092
            }
            action = SNAPSHOT_CREATE;
            snapshot_name = optarg;
            break;
        case 'd':
            if (action) {
                help();
2093
                return 0;
2094 2095 2096 2097
            }
            action = SNAPSHOT_DELETE;
            snapshot_name = optarg;
            break;
2098 2099 2100
        case 'q':
            quiet = true;
            break;
2101 2102 2103
        }
    }

2104
    if (optind != argc - 1) {
2105
        help();
2106
    }
2107 2108 2109
    filename = argv[optind++];

    /* Open the image */
2110
    bs = bdrv_new_open(filename, NULL, bdrv_oflags, true, quiet);
2111 2112 2113
    if (!bs) {
        return 1;
    }
2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129

    /* 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);
2130
        if (ret) {
2131
            error_report("Could not create snapshot '%s': %d (%s)",
2132
                snapshot_name, ret, strerror(-ret));
2133
        }
2134 2135 2136 2137
        break;

    case SNAPSHOT_APPLY:
        ret = bdrv_snapshot_goto(bs, snapshot_name);
2138
        if (ret) {
2139
            error_report("Could not apply snapshot '%s': %d (%s)",
2140
                snapshot_name, ret, strerror(-ret));
2141
        }
2142 2143 2144
        break;

    case SNAPSHOT_DELETE:
2145 2146 2147 2148 2149 2150
        bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
        if (error_is_set(&err)) {
            error_report("Could not delete snapshot '%s': (%s)",
                         snapshot_name, error_get_pretty(err));
            error_free(err);
            ret = 1;
2151
        }
2152 2153 2154 2155
        break;
    }

    /* Cleanup */
F
Fam Zheng 已提交
2156
    bdrv_unref(bs);
2157 2158 2159
    if (ret) {
        return 1;
    }
2160
    return 0;
2161 2162
}

K
Kevin Wolf 已提交
2163 2164
static int img_rebase(int argc, char **argv)
{
2165
    BlockDriverState *bs, *bs_old_backing = NULL, *bs_new_backing = NULL;
2166
    BlockDriver *old_backing_drv, *new_backing_drv;
K
Kevin Wolf 已提交
2167
    char *filename;
2168
    const char *fmt, *cache, *out_basefmt, *out_baseimg;
K
Kevin Wolf 已提交
2169 2170
    int c, flags, ret;
    int unsafe = 0;
2171
    int progress = 0;
2172
    bool quiet = false;
2173
    Error *local_err = NULL;
K
Kevin Wolf 已提交
2174 2175

    /* Parse commandline parameters */
K
Kevin Wolf 已提交
2176
    fmt = NULL;
2177
    cache = BDRV_DEFAULT_CACHE;
K
Kevin Wolf 已提交
2178 2179 2180
    out_baseimg = NULL;
    out_basefmt = NULL;
    for(;;) {
2181
        c = getopt(argc, argv, "uhf:F:b:pt:q");
2182
        if (c == -1) {
K
Kevin Wolf 已提交
2183
            break;
2184
        }
K
Kevin Wolf 已提交
2185
        switch(c) {
J
Jes Sorensen 已提交
2186
        case '?':
K
Kevin Wolf 已提交
2187 2188 2189
        case 'h':
            help();
            return 0;
K
Kevin Wolf 已提交
2190 2191 2192
        case 'f':
            fmt = optarg;
            break;
K
Kevin Wolf 已提交
2193 2194 2195 2196 2197 2198 2199 2200 2201
        case 'F':
            out_basefmt = optarg;
            break;
        case 'b':
            out_baseimg = optarg;
            break;
        case 'u':
            unsafe = 1;
            break;
2202 2203 2204
        case 'p':
            progress = 1;
            break;
2205 2206 2207
        case 't':
            cache = optarg;
            break;
2208 2209 2210
        case 'q':
            quiet = true;
            break;
K
Kevin Wolf 已提交
2211 2212 2213
        }
    }

2214 2215 2216 2217
    if (quiet) {
        progress = 0;
    }

2218
    if ((optind != argc - 1) || (!unsafe && !out_baseimg)) {
K
Kevin Wolf 已提交
2219
        help();
2220
    }
K
Kevin Wolf 已提交
2221 2222
    filename = argv[optind++];

2223 2224 2225
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

2226
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2227
    ret = bdrv_parse_cache_flags(cache, &flags);
2228 2229 2230 2231 2232
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        return -1;
    }

K
Kevin Wolf 已提交
2233 2234 2235 2236 2237 2238
    /*
     * 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.
     */
2239
    bs = bdrv_new_open(filename, fmt, flags, true, quiet);
2240 2241 2242
    if (!bs) {
        return 1;
    }
K
Kevin Wolf 已提交
2243 2244 2245 2246 2247 2248 2249 2250

    /* Find the right drivers for the backing files */
    old_backing_drv = NULL;
    new_backing_drv = NULL;

    if (!unsafe && bs->backing_format[0] != '\0') {
        old_backing_drv = bdrv_find_format(bs->backing_format);
        if (old_backing_drv == NULL) {
2251
            error_report("Invalid format name: '%s'", bs->backing_format);
2252 2253
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
2254 2255 2256 2257 2258 2259
        }
    }

    if (out_basefmt != NULL) {
        new_backing_drv = bdrv_find_format(out_basefmt);
        if (new_backing_drv == NULL) {
2260
            error_report("Invalid format name: '%s'", out_basefmt);
2261 2262
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275
        }
    }

    /* For safe rebasing we need to compare old and new backing file */
    if (unsafe) {
        /* Make the compiler happy */
        bs_old_backing = NULL;
        bs_new_backing = NULL;
    } else {
        char backing_name[1024];

        bs_old_backing = bdrv_new("old_backing");
        bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2276
        ret = bdrv_open(bs_old_backing, backing_name, NULL, BDRV_O_FLAGS,
2277
                        old_backing_drv, &local_err);
2278
        if (ret) {
2279 2280 2281
            error_report("Could not open old backing file '%s': %s",
                         backing_name, error_get_pretty(local_err));
            error_free(local_err);
2282
            goto out;
K
Kevin Wolf 已提交
2283
        }
2284 2285
        if (out_baseimg[0]) {
            bs_new_backing = bdrv_new("new_backing");
2286
            ret = bdrv_open(bs_new_backing, out_baseimg, NULL, BDRV_O_FLAGS,
2287
                        new_backing_drv, &local_err);
2288
            if (ret) {
2289 2290 2291
                error_report("Could not open new backing file '%s': %s",
                             out_baseimg, error_get_pretty(local_err));
                error_free(local_err);
2292 2293
                goto out;
            }
K
Kevin Wolf 已提交
2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307
        }
    }

    /*
     * 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) {
        uint64_t num_sectors;
2308
        uint64_t old_backing_num_sectors;
2309
        uint64_t new_backing_num_sectors = 0;
K
Kevin Wolf 已提交
2310
        uint64_t sector;
2311
        int n;
2312 2313
        uint8_t * buf_old;
        uint8_t * buf_new;
2314
        float local_progress = 0;
2315

K
Kevin Wolf 已提交
2316 2317
        buf_old = qemu_blockalign(bs, IO_BUF_SIZE);
        buf_new = qemu_blockalign(bs, IO_BUF_SIZE);
K
Kevin Wolf 已提交
2318 2319

        bdrv_get_geometry(bs, &num_sectors);
2320
        bdrv_get_geometry(bs_old_backing, &old_backing_num_sectors);
2321 2322 2323
        if (bs_new_backing) {
            bdrv_get_geometry(bs_new_backing, &new_backing_num_sectors);
        }
K
Kevin Wolf 已提交
2324

2325 2326 2327 2328 2329
        if (num_sectors != 0) {
            local_progress = (float)100 /
                (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
        }

K
Kevin Wolf 已提交
2330 2331 2332 2333 2334 2335 2336 2337 2338 2339
        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 */
2340
            ret = bdrv_is_allocated(bs, sector, n, &n);
2341 2342 2343 2344 2345
            if (ret < 0) {
                error_report("error while reading image metadata: %s",
                             strerror(-ret));
                goto out;
            }
2346
            if (ret) {
K
Kevin Wolf 已提交
2347 2348 2349
                continue;
            }

2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365
            /*
             * 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;
                }

                ret = bdrv_read(bs_old_backing, sector, buf_old, n);
                if (ret < 0) {
                    error_report("error while reading from old backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
2366
            }
2367

2368
            if (sector >= new_backing_num_sectors || !bs_new_backing) {
2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379
                memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
            } else {
                if (sector + n > new_backing_num_sectors) {
                    n = new_backing_num_sectors - sector;
                }

                ret = bdrv_read(bs_new_backing, sector, buf_new, n);
                if (ret < 0) {
                    error_report("error while reading from new backing file");
                    goto out;
                }
K
Kevin Wolf 已提交
2380 2381 2382 2383 2384 2385 2386 2387 2388
            }

            /* 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,
2389
                    buf_new + written * 512, n - written, &pnum))
K
Kevin Wolf 已提交
2390 2391 2392 2393
                {
                    ret = bdrv_write(bs, sector + written,
                        buf_old + written * 512, pnum);
                    if (ret < 0) {
2394
                        error_report("Error while writing to COW image: %s",
K
Kevin Wolf 已提交
2395
                            strerror(-ret));
2396
                        goto out;
K
Kevin Wolf 已提交
2397 2398 2399 2400 2401
                    }
                }

                written += pnum;
            }
2402
            qemu_progress_print(local_progress, 100);
K
Kevin Wolf 已提交
2403
        }
2404

K
Kevin Wolf 已提交
2405 2406
        qemu_vfree(buf_old);
        qemu_vfree(buf_new);
K
Kevin Wolf 已提交
2407 2408 2409 2410 2411 2412 2413
    }

    /*
     * 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.
     */
2414 2415 2416 2417 2418 2419
    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 已提交
2420
    if (ret == -ENOSPC) {
2421 2422
        error_report("Could not change the backing file to '%s': No "
                     "space left in the file header", out_baseimg);
K
Kevin Wolf 已提交
2423
    } else if (ret < 0) {
2424
        error_report("Could not change the backing file to '%s': %s",
K
Kevin Wolf 已提交
2425 2426 2427
            out_baseimg, strerror(-ret));
    }

2428
    qemu_progress_print(100, 0);
K
Kevin Wolf 已提交
2429 2430 2431 2432 2433 2434
    /*
     * 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.
     */
2435
out:
2436
    qemu_progress_end();
K
Kevin Wolf 已提交
2437 2438
    /* Cleanup */
    if (!unsafe) {
2439
        if (bs_old_backing != NULL) {
F
Fam Zheng 已提交
2440
            bdrv_unref(bs_old_backing);
2441 2442
        }
        if (bs_new_backing != NULL) {
F
Fam Zheng 已提交
2443
            bdrv_unref(bs_new_backing);
2444
        }
K
Kevin Wolf 已提交
2445 2446
    }

F
Fam Zheng 已提交
2447
    bdrv_unref(bs);
2448 2449 2450
    if (ret) {
        return 1;
    }
K
Kevin Wolf 已提交
2451 2452 2453
    return 0;
}

2454 2455 2456 2457 2458
static int img_resize(int argc, char **argv)
{
    int c, ret, relative;
    const char *filename, *fmt, *size;
    int64_t n, total_size;
2459
    bool quiet = false;
2460
    BlockDriverState *bs = NULL;
2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472
    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 */
            }
2473 2474 2475
        },
    };

K
Kevin Wolf 已提交
2476 2477 2478 2479 2480 2481 2482 2483 2484 2485
    /* Remove size from argv manually so that negative numbers are not treated
     * as options by getopt. */
    if (argc < 3) {
        help();
        return 1;
    }

    size = argv[--argc];

    /* Parse getopt arguments */
2486 2487
    fmt = NULL;
    for(;;) {
2488
        c = getopt(argc, argv, "f:hq");
2489 2490 2491 2492
        if (c == -1) {
            break;
        }
        switch(c) {
J
Jes Sorensen 已提交
2493
        case '?':
2494 2495 2496 2497 2498 2499
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2500 2501 2502
        case 'q':
            quiet = true;
            break;
2503 2504
        }
    }
2505
    if (optind != argc - 1) {
2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525
        help();
    }
    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 */
D
Dong Xu Wang 已提交
2526
    param = qemu_opts_create_nofail(&resize_options);
2527
    if (qemu_opt_set(param, BLOCK_OPT_SIZE, size)) {
2528
        /* Error message already printed when size parsing fails */
2529
        ret = -1;
2530
        qemu_opts_del(param);
2531
        goto out;
2532
    }
2533 2534
    n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
    qemu_opts_del(param);
2535

2536
    bs = bdrv_new_open(filename, fmt, BDRV_O_FLAGS | BDRV_O_RDWR, true, quiet);
2537
    if (!bs) {
2538 2539
        ret = -1;
        goto out;
2540
    }
2541 2542 2543 2544 2545 2546 2547

    if (relative) {
        total_size = bdrv_getlength(bs) + n * relative;
    } else {
        total_size = n;
    }
    if (total_size <= 0) {
2548
        error_report("New image size must be positive");
2549 2550
        ret = -1;
        goto out;
2551 2552 2553 2554 2555
    }

    ret = bdrv_truncate(bs, total_size);
    switch (ret) {
    case 0:
2556
        qprintf(quiet, "Image resized.\n");
2557 2558
        break;
    case -ENOTSUP:
2559
        error_report("This image does not support resize");
2560 2561
        break;
    case -EACCES:
2562
        error_report("Image is read-only");
2563 2564
        break;
    default:
2565
        error_report("Error resizing image (%d)", -ret);
2566 2567
        break;
    }
2568
out:
2569
    if (bs) {
F
Fam Zheng 已提交
2570
        bdrv_unref(bs);
2571
    }
2572 2573 2574
    if (ret) {
        return 1;
    }
2575 2576 2577
    return 0;
}

M
Max Reitz 已提交
2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661
static int img_amend(int argc, char **argv)
{
    int c, ret = 0;
    char *options = NULL;
    QEMUOptionParameter *create_options = NULL, *options_param = NULL;
    const char *fmt = NULL, *filename;
    bool quiet = false;
    BlockDriverState *bs = NULL;

    for (;;) {
        c = getopt(argc, argv, "hqf:o:");
        if (c == -1) {
            break;
        }

        switch (c) {
            case 'h':
            case '?':
                help();
                break;
            case 'o':
                options = optarg;
                break;
            case 'f':
                fmt = optarg;
                break;
            case 'q':
                quiet = true;
                break;
        }
    }

    if (optind != argc - 1) {
        help();
    }

    if (!options) {
        help();
    }

    filename = argv[argc - 1];

    bs = bdrv_new_open(filename, fmt, BDRV_O_FLAGS | BDRV_O_RDWR, true, quiet);
    if (!bs) {
        error_report("Could not open image '%s'", filename);
        ret = -1;
        goto out;
    }

    fmt = bs->drv->format_name;

    if (is_help_option(options)) {
        ret = print_block_option_help(filename, fmt);
        goto out;
    }

    create_options = append_option_parameters(create_options,
            bs->drv->create_options);
    options_param = parse_option_parameters(options, create_options,
            options_param);
    if (options_param == NULL) {
        error_report("Invalid options for file format '%s'", fmt);
        ret = -1;
        goto out;
    }

    ret = bdrv_amend_options(bs, options_param);
    if (ret < 0) {
        error_report("Error while amending options: %s", strerror(-ret));
        goto out;
    }

out:
    if (bs) {
        bdrv_unref(bs);
    }
    free_option_parameters(create_options);
    free_option_parameters(options_param);
    if (ret) {
        return 1;
    }
    return 0;
}

A
Anthony Liguori 已提交
2662
static const img_cmd_t img_cmds[] = {
2663 2664 2665 2666 2667 2668 2669 2670
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
    { NULL, NULL, },
};

B
bellard 已提交
2671 2672
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
2673
    const img_cmd_t *cmd;
2674
    const char *cmdname;
B
bellard 已提交
2675

2676 2677 2678 2679
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

K
Kevin Wolf 已提交
2680 2681
    error_set_progname(argv[0]);

2682
    qemu_init_main_loop();
B
bellard 已提交
2683 2684 2685
    bdrv_init();
    if (argc < 2)
        help();
2686
    cmdname = argv[1];
2687
    argc--; argv++;
2688 2689 2690 2691 2692 2693

    /* find the command */
    for(cmd = img_cmds; cmd->name != NULL; cmd++) {
        if (!strcmp(cmdname, cmd->name)) {
            return cmd->handler(argc, argv);
        }
B
bellard 已提交
2694
    }
2695 2696 2697

    /* not found */
    help();
B
bellard 已提交
2698 2699
    return 0;
}