qemu-img.c 52.6 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 26
#include "qapi-visit.h"
#include "qapi/qmp-output-visitor.h"
#include "qjson.h"
P
pbrook 已提交
27
#include "qemu-common.h"
28
#include "qemu-option.h"
K
Kevin Wolf 已提交
29
#include "qemu-error.h"
30
#include "osdep.h"
31
#include "sysemu.h"
32
#include "block_int.h"
33
#include <getopt.h>
34
#include <stdio.h>
B
bellard 已提交
35

36 37 38 39
#ifdef _WIN32
#include <windows.h>
#endif

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

45
/* Default to cache=writeback as data integrity is not important for qemu-tcg. */
46
#define BDRV_O_FLAGS BDRV_O_CACHE_WB
47
#define BDRV_DEFAULT_CACHE "writeback"
48

B
bellard 已提交
49 50 51 52 53
static void format_print(void *opaque, const char *name)
{
    printf(" %s", name);
}

B
blueswir1 已提交
54
/* Please keep in synch with qemu-img.texi */
P
pbrook 已提交
55
static void help(void)
B
bellard 已提交
56
{
57 58
    const char *help_msg =
           "qemu-img version " QEMU_VERSION ", Copyright (c) 2004-2008 Fabrice Bellard\n"
59 60 61 62
           "usage: qemu-img command [command options]\n"
           "QEMU disk image utility\n"
           "\n"
           "Command syntax:\n"
63 64 65 66 67
#define DEF(option, callback, arg_string)        \
           "  " arg_string "\n"
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
68 69 70 71
           "\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"
72
           "  'cache' is the cache mode used to write the output disk image, the valid\n"
73 74
           "    options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
           "    'directsync' and 'unsafe' (default for convert)\n"
75 76 77 78 79 80 81 82 83 84 85 86 87
           "  'size' is the disk image size in bytes. Optional suffixes\n"
           "    'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M)\n"
           "    and T (terabyte, 1024G) are supported. 'b' is ignored.\n"
           "  '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"
           "  '-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"
88
           "  '-p' show progress of command (only certain commands)\n"
89 90
           "  '-S' indicates the consecutive number of bytes that must contain only zeros\n"
           "       for qemu-img to create a sparse image during conversion\n"
91
           "  '--output' takes the format in which the output must be done (human or json)\n"
92
           "\n"
93 94 95 96 97 98
           "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"
           "       hiding corruption that has already occured.\n"
           "\n"
99 100 101 102 103
           "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"
104 105 106
           "  '-l' lists all snapshots in the given image\n";

    printf("%s\nSupported formats:", help_msg);
B
bellard 已提交
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
    bdrv_iterate_format(format_print, NULL);
    printf("\n");
    exit(1);
}

#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;
157

B
bellard 已提交
158 159 160 161 162
    tcsetattr (0, TCSANOW, &tty);

    atexit(term_exit);
}

P
pbrook 已提交
163
static int read_password(char *buf, int buf_size)
B
bellard 已提交
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 199
{
    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

200 201 202 203 204 205 206 207
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) {
208
        error_report("Unknown file format '%s'", fmt);
209 210 211 212 213
        return 1;
    }

    proto_drv = bdrv_find_protocol(filename);
    if (!proto_drv) {
214
        error_report("Unknown protocol '%s'", filename);
215 216 217 218 219 220 221 222 223 224 225 226
        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;
}

227
static BlockDriverState *bdrv_new_open(const char *filename,
228
                                       const char *fmt,
229
                                       int flags)
230 231 232 233
{
    BlockDriverState *bs;
    BlockDriver *drv;
    char password[256];
234
    int ret;
235

236
    bs = bdrv_new("image");
237

238 239
    if (fmt) {
        drv = bdrv_find_format(fmt);
240
        if (!drv) {
241
            error_report("Unknown file format '%s'", fmt);
242 243
            goto fail;
        }
244 245 246
    } else {
        drv = NULL;
    }
247 248 249 250

    ret = bdrv_open(bs, filename, flags, drv);
    if (ret < 0) {
        error_report("Could not open '%s': %s", filename, strerror(-ret));
251
        goto fail;
252
    }
253

254 255
    if (bdrv_is_encrypted(bs)) {
        printf("Disk image '%s' is encrypted.\n", filename);
256
        if (read_password(password, sizeof(password)) < 0) {
257
            error_report("No password given");
258 259 260
            goto fail;
        }
        if (bdrv_set_key(bs, password) < 0) {
261
            error_report("invalid password");
262 263
            goto fail;
        }
264 265
    }
    return bs;
266 267 268 269 270
fail:
    if (bs) {
        bdrv_delete(bs);
    }
    return NULL;
271 272
}

273
static int add_old_style_options(const char *fmt, QEMUOptionParameter *list,
274 275
                                 const char *base_filename,
                                 const char *base_fmt)
276 277 278
{
    if (base_filename) {
        if (set_option_parameter(list, BLOCK_OPT_BACKING_FILE, base_filename)) {
279 280
            error_report("Backing file not supported for file format '%s'",
                         fmt);
281
            return -1;
282 283 284 285
        }
    }
    if (base_fmt) {
        if (set_option_parameter(list, BLOCK_OPT_BACKING_FMT, base_fmt)) {
286 287
            error_report("Backing file format not supported for file "
                         "format '%s'", fmt);
288
            return -1;
289 290
        }
    }
291
    return 0;
292 293
}

B
bellard 已提交
294 295
static int img_create(int argc, char **argv)
{
296
    int c, ret = 0;
297
    uint64_t img_size = -1;
B
bellard 已提交
298
    const char *fmt = "raw";
299
    const char *base_fmt = NULL;
B
bellard 已提交
300 301
    const char *filename;
    const char *base_filename = NULL;
302
    char *options = NULL;
303

B
bellard 已提交
304
    for(;;) {
305
        c = getopt(argc, argv, "F:b:f:he6o:");
306
        if (c == -1) {
B
bellard 已提交
307
            break;
308
        }
B
bellard 已提交
309
        switch(c) {
J
Jes Sorensen 已提交
310
        case '?':
B
bellard 已提交
311 312 313
        case 'h':
            help();
            break;
314 315 316
        case 'F':
            base_fmt = optarg;
            break;
B
bellard 已提交
317 318 319 320 321 322 323
        case 'b':
            base_filename = optarg;
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'e':
324
            error_report("option -e is deprecated, please use \'-o "
325 326
                  "encryption\' instead!");
            return 1;
327
        case '6':
328
            error_report("option -6 is deprecated, please use \'-o "
329 330
                  "compat6\' instead!");
            return 1;
331 332 333
        case 'o':
            options = optarg;
            break;
B
bellard 已提交
334 335
        }
    }
336

337
    /* Get the filename */
338
    if (optind >= argc) {
339
        help();
340
    }
341 342
    filename = argv[optind++];

343 344
    /* Get image size, if specified */
    if (optind < argc) {
345
        int64_t sval;
346 347 348
        char *end;
        sval = strtosz_suffix(argv[optind++], &end, STRTOSZ_DEFSUFFIX_B);
        if (sval < 0 || *end) {
349
            error_report("Invalid image size specified! You may use k, M, G or "
350
                  "T suffixes for ");
351
            error_report("kilobytes, megabytes, gigabytes and terabytes.");
352 353 354 355 356 357
            ret = -1;
            goto out;
        }
        img_size = (uint64_t)sval;
    }

358
    if (options && is_help_option(options)) {
359 360 361 362
        ret = print_block_option_help(filename, fmt);
        goto out;
    }

J
Jes Sorensen 已提交
363 364
    ret = bdrv_img_create(filename, fmt, base_filename, base_fmt,
                          options, img_size, BDRV_O_FLAGS);
365 366 367 368
out:
    if (ret) {
        return 1;
    }
B
bellard 已提交
369 370 371
    return 0;
}

372 373 374 375 376 377 378 379
/*
 * 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
 */
380 381 382 383 384
static int img_check(int argc, char **argv)
{
    int c, ret;
    const char *filename, *fmt;
    BlockDriverState *bs;
385
    BdrvCheckResult result;
386
    int fix = 0;
387
    int flags = BDRV_O_FLAGS | BDRV_O_CHECK;
388 389 390

    fmt = NULL;
    for(;;) {
391
        c = getopt(argc, argv, "f:hr:");
392
        if (c == -1) {
393
            break;
394
        }
395
        switch(c) {
J
Jes Sorensen 已提交
396
        case '?':
397 398 399 400 401 402
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
403 404 405 406 407 408 409 410 411 412 413
        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;
414 415
        }
    }
416
    if (optind >= argc) {
417
        help();
418
    }
419 420
    filename = argv[optind++];

421
    bs = bdrv_new_open(filename, fmt, flags);
422 423 424
    if (!bs) {
        return 1;
    }
425
    ret = bdrv_check(bs, &result, fix);
426 427

    if (ret == -ENOTSUP) {
428
        error_report("This image format does not support checks");
429 430 431 432
        bdrv_delete(bs);
        return 1;
    }

433 434 435 436 437 438 439 440 441 442
    if (result.corruptions_fixed || result.leaks_fixed) {
        printf("The following inconsistencies were found and repaired:\n\n"
               "    %d leaked clusters\n"
               "    %d corruptions\n\n"
               "Double checking the fixed image now...\n",
               result.leaks_fixed,
               result.corruptions_fixed);
        ret = bdrv_check(bs, &result, 0);
    }

443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
    if (!(result.corruptions || result.leaks || result.check_errors)) {
        printf("No errors were found on the image.\n");
    } else {
        if (result.corruptions) {
            printf("\n%d errors were found on the image.\n"
                "Data may be corrupted, or further writes to the image "
                "may corrupt it.\n",
                result.corruptions);
        }

        if (result.leaks) {
            printf("\n%d leaked clusters were found on the image.\n"
                "This means waste of disk space, but no harm to data.\n",
                result.leaks);
        }

        if (result.check_errors) {
            printf("\n%d internal errors have occurred during the check.\n",
                result.check_errors);
462 463 464
        }
    }

465 466 467 468 469 470 471
    if (result.bfi.total_clusters != 0 && result.bfi.allocated_clusters != 0) {
        printf("%" PRId64 "/%" PRId64 "= %0.2f%% allocated, %0.2f%% fragmented\n",
        result.bfi.allocated_clusters, result.bfi.total_clusters,
        result.bfi.allocated_clusters * 100.0 / result.bfi.total_clusters,
        result.bfi.fragmented_clusters * 100.0 / result.bfi.allocated_clusters);
    }

472
    bdrv_delete(bs);
473 474 475 476 477

    if (ret < 0 || result.check_errors) {
        printf("\nAn error has occurred during the check: %s\n"
            "The check is not complete and may have missed error.\n",
            strerror(-ret));
478 479
        return 1;
    }
480 481 482 483 484 485 486 487

    if (result.corruptions) {
        return 2;
    } else if (result.leaks) {
        return 3;
    } else {
        return 0;
    }
488 489
}

B
bellard 已提交
490 491
static int img_commit(int argc, char **argv)
{
492 493
    int c, ret, flags;
    const char *filename, *fmt, *cache;
B
bellard 已提交
494 495 496
    BlockDriverState *bs;

    fmt = NULL;
497
    cache = BDRV_DEFAULT_CACHE;
B
bellard 已提交
498
    for(;;) {
499
        c = getopt(argc, argv, "f:ht:");
500
        if (c == -1) {
B
bellard 已提交
501
            break;
502
        }
B
bellard 已提交
503
        switch(c) {
J
Jes Sorensen 已提交
504
        case '?':
B
bellard 已提交
505 506 507 508 509 510
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
511 512 513
        case 't':
            cache = optarg;
            break;
B
bellard 已提交
514 515
        }
    }
516
    if (optind >= argc) {
B
bellard 已提交
517
        help();
518
    }
B
bellard 已提交
519 520
    filename = argv[optind++];

521
    flags = BDRV_O_RDWR;
522
    ret = bdrv_parse_cache_flags(cache, &flags);
523 524 525 526 527 528
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        return -1;
    }

    bs = bdrv_new_open(filename, fmt, flags);
529 530 531
    if (!bs) {
        return 1;
    }
B
bellard 已提交
532 533 534 535 536 537
    ret = bdrv_commit(bs);
    switch(ret) {
    case 0:
        printf("Image committed.\n");
        break;
    case -ENOENT:
538
        error_report("No disk inserted");
B
bellard 已提交
539 540
        break;
    case -EACCES:
541
        error_report("Image is read-only");
B
bellard 已提交
542 543
        break;
    case -ENOTSUP:
544
        error_report("Image is already committed");
B
bellard 已提交
545 546
        break;
    default:
547
        error_report("Error while committing image");
B
bellard 已提交
548 549 550 551
        break;
    }

    bdrv_delete(bs);
552 553 554
    if (ret) {
        return 1;
    }
B
bellard 已提交
555 556 557
    return 0;
}

558 559 560 561 562 563 564
/*
 * 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 已提交
565 566
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
{
567 568
    bool is_zero;
    int i;
B
bellard 已提交
569 570 571 572 573

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
574
    is_zero = buffer_is_zero(buf, 512);
B
bellard 已提交
575 576
    for(i = 1; i < n; i++) {
        buf += 512;
577
        if (is_zero != buffer_is_zero(buf, 512)) {
B
bellard 已提交
578
            break;
579
        }
B
bellard 已提交
580 581
    }
    *pnum = i;
582
    return !is_zero;
B
bellard 已提交
583 584
}

585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
/*
 * 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 已提交
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
/*
 * 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;
}

658
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
659 660 661

static int img_convert(int argc, char **argv)
{
662
    int c, ret = 0, n, n1, bs_n, bs_i, compress, cluster_size, cluster_sectors;
663 664
    int progress = 0, flags;
    const char *fmt, *out_fmt, *cache, *out_baseimg, *out_filename;
665
    BlockDriver *drv, *proto_drv;
666
    BlockDriverState **bs = NULL, *out_bs = NULL;
667 668
    int64_t total_sectors, nb_sectors, sector_num, bs_offset;
    uint64_t bs_sectors;
669
    uint8_t * buf = NULL;
B
bellard 已提交
670
    const uint8_t *buf1;
B
bellard 已提交
671
    BlockDriverInfo bdi;
672
    QEMUOptionParameter *param = NULL, *create_options = NULL;
673
    QEMUOptionParameter *out_baseimg_param;
674
    char *options = NULL;
E
edison 已提交
675
    const char *snapshot_name = NULL;
676
    float local_progress;
677
    int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
B
bellard 已提交
678 679 680

    fmt = NULL;
    out_fmt = "raw";
681
    cache = "unsafe";
682
    out_baseimg = NULL;
683
    compress = 0;
B
bellard 已提交
684
    for(;;) {
685
        c = getopt(argc, argv, "f:O:B:s:hce6o:pS:t:");
686
        if (c == -1) {
B
bellard 已提交
687
            break;
688
        }
B
bellard 已提交
689
        switch(c) {
J
Jes Sorensen 已提交
690
        case '?':
B
bellard 已提交
691 692 693 694 695 696 697 698 699
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'O':
            out_fmt = optarg;
            break;
700 701 702
        case 'B':
            out_baseimg = optarg;
            break;
B
bellard 已提交
703
        case 'c':
704
            compress = 1;
B
bellard 已提交
705 706
            break;
        case 'e':
707
            error_report("option -e is deprecated, please use \'-o "
708 709
                  "encryption\' instead!");
            return 1;
710
        case '6':
711
            error_report("option -6 is deprecated, please use \'-o "
712 713
                  "compat6\' instead!");
            return 1;
714 715 716
        case 'o':
            options = optarg;
            break;
E
edison 已提交
717 718 719
        case 's':
            snapshot_name = optarg;
            break;
720 721 722
        case 'S':
        {
            int64_t sval;
723 724 725
            char *end;
            sval = strtosz_suffix(optarg, &end, STRTOSZ_DEFSUFFIX_B);
            if (sval < 0 || *end) {
726 727 728 729 730 731 732
                error_report("Invalid minimum zero buffer size for sparse output specified");
                return 1;
            }

            min_sparse = sval / BDRV_SECTOR_SIZE;
            break;
        }
733 734 735
        case 'p':
            progress = 1;
            break;
736 737 738
        case 't':
            cache = optarg;
            break;
B
bellard 已提交
739 740
        }
    }
741

742
    bs_n = argc - optind - 1;
743 744 745
    if (bs_n < 1) {
        help();
    }
746 747

    out_filename = argv[argc - 1];
748

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

752
    if (options && is_help_option(options)) {
753 754 755 756
        ret = print_block_option_help(out_filename, out_fmt);
        goto out;
    }

757
    if (bs_n > 1 && out_baseimg) {
758 759
        error_report("-B makes no sense when concatenating multiple input "
                     "images");
760 761
        ret = -1;
        goto out;
762
    }
763

764 765
    qemu_progress_print(0, 100);

766
    bs = g_malloc0(bs_n * sizeof(BlockDriverState *));
767 768 769

    total_sectors = 0;
    for (bs_i = 0; bs_i < bs_n; bs_i++) {
770
        bs[bs_i] = bdrv_new_open(argv[optind + bs_i], fmt, BDRV_O_FLAGS);
771
        if (!bs[bs_i]) {
772
            error_report("Could not open '%s'", argv[optind + bs_i]);
773 774 775
            ret = -1;
            goto out;
        }
776 777 778
        bdrv_get_geometry(bs[bs_i], &bs_sectors);
        total_sectors += bs_sectors;
    }
B
bellard 已提交
779

E
edison 已提交
780 781
    if (snapshot_name != NULL) {
        if (bs_n > 1) {
782
            error_report("No support for concatenating multiple snapshot");
E
edison 已提交
783 784 785 786
            ret = -1;
            goto out;
        }
        if (bdrv_snapshot_load_tmp(bs[0], snapshot_name) < 0) {
787
            error_report("Failed to load snapshot");
E
edison 已提交
788 789 790 791 792
            ret = -1;
            goto out;
        }
    }

793
    /* Find driver and parse its options */
B
bellard 已提交
794
    drv = bdrv_find_format(out_fmt);
795
    if (!drv) {
796
        error_report("Unknown file format '%s'", out_fmt);
797 798 799
        ret = -1;
        goto out;
    }
800

801
    proto_drv = bdrv_find_protocol(out_filename);
802
    if (!proto_drv) {
803
        error_report("Unknown protocol '%s'", out_filename);
804 805 806
        ret = -1;
        goto out;
    }
807 808 809 810 811

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

813
    if (options) {
814
        param = parse_option_parameters(options, create_options, param);
815
        if (param == NULL) {
816
            error_report("Invalid options for file format '%s'.", out_fmt);
817 818
            ret = -1;
            goto out;
819 820
        }
    } else {
821
        param = parse_option_parameters("", create_options, param);
822 823 824
    }

    set_option_parameter_int(param, BLOCK_OPT_SIZE, total_sectors * 512);
825
    ret = add_old_style_options(out_fmt, param, out_baseimg, NULL);
826 827 828
    if (ret < 0) {
        goto out;
    }
829

830 831 832 833 834 835
    /* 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;
    }

836
    /* Check if compression is supported */
837
    if (compress) {
838 839
        QEMUOptionParameter *encryption =
            get_option_parameter(param, BLOCK_OPT_ENCRYPT);
840 841
        QEMUOptionParameter *preallocation =
            get_option_parameter(param, BLOCK_OPT_PREALLOC);
842 843

        if (!drv->bdrv_write_compressed) {
844
            error_report("Compression not supported for this file format");
845 846
            ret = -1;
            goto out;
847 848 849
        }

        if (encryption && encryption->value.n) {
850 851
            error_report("Compression and encryption not supported at "
                         "the same time");
852 853
            ret = -1;
            goto out;
854
        }
855 856 857 858 859 860 861 862 863

        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;
        }
864 865 866 867
    }

    /* Create the new image */
    ret = bdrv_create(drv, out_filename, param);
B
bellard 已提交
868 869
    if (ret < 0) {
        if (ret == -ENOTSUP) {
870 871
            error_report("Formatting not supported for file format '%s'",
                         out_fmt);
872
        } else if (ret == -EFBIG) {
873 874
            error_report("The image size is too large for file format '%s'",
                         out_fmt);
B
bellard 已提交
875
        } else {
876 877
            error_report("%s: error while converting %s: %s",
                         out_filename, out_fmt, strerror(-ret));
B
bellard 已提交
878
        }
879
        goto out;
B
bellard 已提交
880
    }
881

882
    flags = BDRV_O_RDWR;
883
    ret = bdrv_parse_cache_flags(cache, &flags);
884 885 886 887 888 889
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        return -1;
    }

    out_bs = bdrv_new_open(out_filename, out_fmt, flags);
890 891 892 893
    if (!out_bs) {
        ret = -1;
        goto out;
    }
B
bellard 已提交
894

895 896 897
    bs_i = 0;
    bs_offset = 0;
    bdrv_get_geometry(bs[0], &bs_sectors);
K
Kevin Wolf 已提交
898
    buf = qemu_blockalign(out_bs, IO_BUF_SIZE);
899

900
    if (compress) {
901 902
        ret = bdrv_get_info(out_bs, &bdi);
        if (ret < 0) {
903
            error_report("could not get block driver info");
904 905
            goto out;
        }
B
bellard 已提交
906
        cluster_size = bdi.cluster_size;
907
        if (cluster_size <= 0 || cluster_size > IO_BUF_SIZE) {
908
            error_report("invalid cluster size");
909 910 911
            ret = -1;
            goto out;
        }
B
bellard 已提交
912 913
        cluster_sectors = cluster_size >> 9;
        sector_num = 0;
914 915 916

        nb_sectors = total_sectors;
        local_progress = (float)100 /
917
            (nb_sectors / MIN(nb_sectors, cluster_sectors));
918

B
bellard 已提交
919
        for(;;) {
920 921 922 923
            int64_t bs_num;
            int remainder;
            uint8_t *buf2;

B
bellard 已提交
924 925 926 927 928 929 930
            nb_sectors = total_sectors - sector_num;
            if (nb_sectors <= 0)
                break;
            if (nb_sectors >= cluster_sectors)
                n = cluster_sectors;
            else
                n = nb_sectors;
931 932 933 934 935 936 937 938 939 940 941 942 943

            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 已提交
944 945 946
                    /* printf("changing part: sector_num=%" PRId64 ", "
                       "bs_i=%d, bs_offset=%" PRId64 ", bs_sectors=%" PRId64
                       "\n", sector_num, bs_i, bs_offset, bs_sectors); */
947 948 949 950 951
                }
                assert (bs_num < bs_sectors);

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

952 953
                ret = bdrv_read(bs[bs_i], bs_num, buf2, nlow);
                if (ret < 0) {
954 955
                    error_report("error while reading sector %" PRId64 ": %s",
                                 bs_num, strerror(-ret));
956 957
                    goto out;
                }
958 959 960 961 962 963 964 965

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

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

966
            if (n < cluster_sectors) {
B
bellard 已提交
967
                memset(buf + n * 512, 0, cluster_size - n * 512);
968
            }
969
            if (!buffer_is_zero(buf, cluster_size)) {
970 971 972
                ret = bdrv_write_compressed(out_bs, sector_num, buf,
                                            cluster_sectors);
                if (ret != 0) {
973 974
                    error_report("error while compressing sector %" PRId64
                                 ": %s", sector_num, strerror(-ret));
975 976
                    goto out;
                }
B
bellard 已提交
977 978
            }
            sector_num += n;
979
            qemu_progress_print(local_progress, 100);
B
bellard 已提交
980
        }
B
bellard 已提交
981 982
        /* signal EOF to align */
        bdrv_write_compressed(out_bs, 0, NULL, 0);
B
bellard 已提交
983
    } else {
K
Kevin Wolf 已提交
984 985
        int has_zero_init = bdrv_has_zero_init(out_bs);

986
        sector_num = 0; // total number of sectors converted so far
987 988
        nb_sectors = total_sectors - sector_num;
        local_progress = (float)100 /
989
            (nb_sectors / MIN(nb_sectors, IO_BUF_SIZE / 512));
990

B
bellard 已提交
991 992
        for(;;) {
            nb_sectors = total_sectors - sector_num;
993
            if (nb_sectors <= 0) {
B
bellard 已提交
994
                break;
995 996
            }
            if (nb_sectors >= (IO_BUF_SIZE / 512)) {
B
bellard 已提交
997
                n = (IO_BUF_SIZE / 512);
998
            } else {
B
bellard 已提交
999
                n = nb_sectors;
1000
            }
1001 1002 1003 1004 1005 1006

            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 已提交
1007 1008
                /* printf("changing part: sector_num=%" PRId64 ", bs_i=%d, "
                  "bs_offset=%" PRId64 ", bs_sectors=%" PRId64 "\n",
1009 1010 1011
                   sector_num, bs_i, bs_offset, bs_sectors); */
            }

1012
            if (n > bs_offset + bs_sectors - sector_num) {
1013
                n = bs_offset + bs_sectors - sector_num;
1014
            }
1015

K
Kevin Wolf 已提交
1016
            if (has_zero_init) {
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
                /* 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 (!bdrv_is_allocated(bs[bs_i], sector_num - bs_offset,
                                           n, &n1)) {
                        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. */
                    n = n1;
1030 1031 1032
                }
            } else {
                n1 = n;
1033 1034
            }

1035 1036
            ret = bdrv_read(bs[bs_i], sector_num - bs_offset, buf, n);
            if (ret < 0) {
1037 1038
                error_report("error while reading sector %" PRId64 ": %s",
                             sector_num - bs_offset, strerror(-ret));
1039 1040
                goto out;
            }
B
bellard 已提交
1041 1042 1043 1044 1045
            /* 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) {
1046 1047
                /* If the output image is being created as a copy on write image,
                   copy all sectors even the ones containing only NUL bytes,
1048 1049 1050 1051 1052
                   because they may differ from the sectors in the base image.

                   If the output is to a host device, we also write out
                   sectors that are entirely 0, since whatever data was
                   already there is garbage, not 0s. */
K
Kevin Wolf 已提交
1053
                if (!has_zero_init || out_baseimg ||
1054
                    is_allocated_sectors_min(buf1, n, &n1, min_sparse)) {
1055 1056
                    ret = bdrv_write(out_bs, sector_num, buf1, n1);
                    if (ret < 0) {
1057 1058
                        error_report("error while writing sector %" PRId64
                                     ": %s", sector_num, strerror(-ret));
1059 1060
                        goto out;
                    }
B
bellard 已提交
1061 1062 1063 1064 1065
                }
                sector_num += n1;
                n -= n1;
                buf1 += n1 * 512;
            }
1066
            qemu_progress_print(local_progress, 100);
B
bellard 已提交
1067 1068
        }
    }
1069
out:
1070
    qemu_progress_end();
1071 1072
    free_option_parameters(create_options);
    free_option_parameters(param);
K
Kevin Wolf 已提交
1073
    qemu_vfree(buf);
1074 1075 1076
    if (out_bs) {
        bdrv_delete(out_bs);
    }
1077 1078 1079 1080 1081
    if (bs) {
        for (bs_i = 0; bs_i < bs_n; bs_i++) {
            if (bs[bs_i]) {
                bdrv_delete(bs[bs_i]);
            }
1082
        }
1083
        g_free(bs);
1084 1085 1086 1087
    }
    if (ret) {
        return 1;
    }
B
bellard 已提交
1088 1089 1090
    return 0;
}

B
bellard 已提交
1091

B
bellard 已提交
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
static void dump_snapshots(BlockDriverState *bs)
{
    QEMUSnapshotInfo *sn_tab, *sn;
    int nb_sns, i;
    char buf[256];

    nb_sns = bdrv_snapshot_list(bs, &sn_tab);
    if (nb_sns <= 0)
        return;
    printf("Snapshot list:\n");
    printf("%s\n", bdrv_snapshot_dump(buf, sizeof(buf), NULL));
    for(i = 0; i < nb_sns; i++) {
        sn = &sn_tab[i];
        printf("%s\n", bdrv_snapshot_dump(buf, sizeof(buf), sn));
    }
1107
    g_free(sn_tab);
B
bellard 已提交
1108 1109
}

1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
static void collect_snapshots(BlockDriverState *bs , ImageInfo *info)
{
    int i, sn_count;
    QEMUSnapshotInfo *sn_tab = NULL;
    SnapshotInfoList *info_list, *cur_item = NULL;
    sn_count = bdrv_snapshot_list(bs, &sn_tab);

    for (i = 0; i < sn_count; i++) {
        info->has_snapshots = true;
        info_list = g_new0(SnapshotInfoList, 1);

        info_list->value                = g_new0(SnapshotInfo, 1);
        info_list->value->id            = g_strdup(sn_tab[i].id_str);
        info_list->value->name          = g_strdup(sn_tab[i].name);
        info_list->value->vm_state_size = sn_tab[i].vm_state_size;
        info_list->value->date_sec      = sn_tab[i].date_sec;
        info_list->value->date_nsec     = sn_tab[i].date_nsec;
        info_list->value->vm_clock_sec  = sn_tab[i].vm_clock_nsec / 1000000000;
        info_list->value->vm_clock_nsec = sn_tab[i].vm_clock_nsec % 1000000000;

        /* XXX: waiting for the qapi to support qemu-queue.h types */
        if (!cur_item) {
            info->snapshots = cur_item = info_list;
        } else {
            cur_item->next = info_list;
            cur_item = info_list;
        }

    }

    g_free(sn_tab);
}

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

static void collect_image_info(BlockDriverState *bs,
                   ImageInfo *info,
                   const char *filename,
                   const char *fmt)
B
bellard 已提交
1164
{
1165
    uint64_t total_sectors;
B
bellard 已提交
1166 1167
    char backing_filename[1024];
    char backing_filename2[1024];
B
bellard 已提交
1168
    BlockDriverInfo bdi;
B
bellard 已提交
1169

1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
    bdrv_get_geometry(bs, &total_sectors);

    info->filename        = g_strdup(filename);
    info->format          = g_strdup(bdrv_get_format_name(bs));
    info->virtual_size    = total_sectors * 512;
    info->actual_size     = bdrv_get_allocated_file_size(bs);
    info->has_actual_size = info->actual_size >= 0;
    if (bdrv_is_encrypted(bs)) {
        info->encrypted = true;
        info->has_encrypted = true;
    }
    if (bdrv_get_info(bs, &bdi) >= 0) {
        if (bdi.cluster_size != 0) {
            info->cluster_size = bdi.cluster_size;
            info->has_cluster_size = true;
        }
        info->dirty_flag = bdi.is_dirty;
        info->has_dirty_flag = true;
    }
    bdrv_get_backing_filename(bs, backing_filename, sizeof(backing_filename));
    if (backing_filename[0] != '\0') {
        info->backing_filename = g_strdup(backing_filename);
        info->has_backing_filename = true;
        bdrv_get_full_backing_filename(bs, backing_filename2,
                                       sizeof(backing_filename2));

        if (strcmp(backing_filename, backing_filename2) != 0) {
            info->full_backing_filename =
                        g_strdup(backing_filename2);
            info->has_full_backing_filename = true;
        }

        if (bs->backing_format[0]) {
            info->backing_filename_format = g_strdup(bs->backing_format);
            info->has_backing_filename_format = true;
        }
    }
}

static void dump_human_image_info(ImageInfo *info)
{
    char size_buf[128], dsize_buf[128];
    if (!info->has_actual_size) {
        snprintf(dsize_buf, sizeof(dsize_buf), "unavailable");
    } else {
        get_human_readable_size(dsize_buf, sizeof(dsize_buf),
                                info->actual_size);
    }
    get_human_readable_size(size_buf, sizeof(size_buf), info->virtual_size);
    printf("image: %s\n"
           "file format: %s\n"
           "virtual size: %s (%" PRId64 " bytes)\n"
           "disk size: %s\n",
           info->filename, info->format, size_buf,
           info->virtual_size,
           dsize_buf);

    if (info->has_encrypted && info->encrypted) {
        printf("encrypted: yes\n");
    }

    if (info->has_cluster_size) {
        printf("cluster_size: %" PRId64 "\n", info->cluster_size);
    }

    if (info->has_dirty_flag && info->dirty_flag) {
        printf("cleanly shut down: no\n");
    }

    if (info->has_backing_filename) {
        printf("backing file: %s", info->backing_filename);
        if (info->has_full_backing_filename) {
            printf(" (actual path: %s)", info->full_backing_filename);
        }
        putchar('\n');
        if (info->has_backing_filename_format) {
            printf("backing file format: %s\n", info->backing_filename_format);
        }
    }
}

enum {OPTION_OUTPUT = 256};

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

static int img_info(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
    const char *filename, *fmt, *output;
    BlockDriverState *bs;
    ImageInfo *info;

B
bellard 已提交
1266
    fmt = NULL;
1267
    output = NULL;
B
bellard 已提交
1268
    for(;;) {
1269 1270 1271 1272 1273 1274 1275 1276 1277
        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);
1278
        if (c == -1) {
B
bellard 已提交
1279
            break;
1280
        }
B
bellard 已提交
1281
        switch(c) {
J
Jes Sorensen 已提交
1282
        case '?':
B
bellard 已提交
1283 1284 1285 1286 1287 1288
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
1289 1290 1291
        case OPTION_OUTPUT:
            output = optarg;
            break;
B
bellard 已提交
1292 1293
        }
    }
1294
    if (optind >= argc) {
B
bellard 已提交
1295
        help();
1296
    }
B
bellard 已提交
1297 1298
    filename = argv[optind++];

1299 1300 1301 1302 1303 1304 1305 1306 1307
    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;
    }

1308
    bs = bdrv_new_open(filename, fmt, BDRV_O_FLAGS | BDRV_O_NO_BACKING);
1309 1310 1311
    if (!bs) {
        return 1;
    }
1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324

    info = g_new0(ImageInfo, 1);
    collect_image_info(bs, info, filename, fmt);

    switch (output_format) {
    case OFORMAT_HUMAN:
        dump_human_image_info(info);
        dump_snapshots(bs);
        break;
    case OFORMAT_JSON:
        collect_snapshots(bs, info);
        dump_json_image_info(info);
        break;
B
bellard 已提交
1325
    }
1326 1327

    qapi_free_ImageInfo(info);
B
bellard 已提交
1328 1329 1330 1331
    bdrv_delete(bs);
    return 0;
}

1332 1333 1334 1335 1336
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

1337
static int img_snapshot(int argc, char **argv)
1338 1339 1340 1341
{
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
1342
    int c, ret = 0, bdrv_oflags;
1343 1344 1345
    int action = 0;
    qemu_timeval tv;

1346
    bdrv_oflags = BDRV_O_FLAGS | BDRV_O_RDWR;
1347 1348 1349
    /* Parse commandline parameters */
    for(;;) {
        c = getopt(argc, argv, "la:c:d:h");
1350
        if (c == -1) {
1351
            break;
1352
        }
1353
        switch(c) {
J
Jes Sorensen 已提交
1354
        case '?':
1355 1356
        case 'h':
            help();
1357
            return 0;
1358 1359 1360
        case 'l':
            if (action) {
                help();
1361
                return 0;
1362 1363
            }
            action = SNAPSHOT_LIST;
1364
            bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
1365 1366 1367 1368
            break;
        case 'a':
            if (action) {
                help();
1369
                return 0;
1370 1371 1372 1373 1374 1375 1376
            }
            action = SNAPSHOT_APPLY;
            snapshot_name = optarg;
            break;
        case 'c':
            if (action) {
                help();
1377
                return 0;
1378 1379 1380 1381 1382 1383 1384
            }
            action = SNAPSHOT_CREATE;
            snapshot_name = optarg;
            break;
        case 'd':
            if (action) {
                help();
1385
                return 0;
1386 1387 1388 1389 1390 1391 1392
            }
            action = SNAPSHOT_DELETE;
            snapshot_name = optarg;
            break;
        }
    }

1393
    if (optind >= argc) {
1394
        help();
1395
    }
1396 1397 1398
    filename = argv[optind++];

    /* Open the image */
1399
    bs = bdrv_new_open(filename, NULL, bdrv_oflags);
1400 1401 1402
    if (!bs) {
        return 1;
    }
1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418

    /* 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);
1419
        if (ret) {
1420
            error_report("Could not create snapshot '%s': %d (%s)",
1421
                snapshot_name, ret, strerror(-ret));
1422
        }
1423 1424 1425 1426
        break;

    case SNAPSHOT_APPLY:
        ret = bdrv_snapshot_goto(bs, snapshot_name);
1427
        if (ret) {
1428
            error_report("Could not apply snapshot '%s': %d (%s)",
1429
                snapshot_name, ret, strerror(-ret));
1430
        }
1431 1432 1433 1434
        break;

    case SNAPSHOT_DELETE:
        ret = bdrv_snapshot_delete(bs, snapshot_name);
1435
        if (ret) {
1436
            error_report("Could not delete snapshot '%s': %d (%s)",
1437
                snapshot_name, ret, strerror(-ret));
1438
        }
1439 1440 1441 1442 1443
        break;
    }

    /* Cleanup */
    bdrv_delete(bs);
1444 1445 1446
    if (ret) {
        return 1;
    }
1447
    return 0;
1448 1449
}

K
Kevin Wolf 已提交
1450 1451
static int img_rebase(int argc, char **argv)
{
1452
    BlockDriverState *bs, *bs_old_backing = NULL, *bs_new_backing = NULL;
1453
    BlockDriver *old_backing_drv, *new_backing_drv;
K
Kevin Wolf 已提交
1454
    char *filename;
1455
    const char *fmt, *cache, *out_basefmt, *out_baseimg;
K
Kevin Wolf 已提交
1456 1457
    int c, flags, ret;
    int unsafe = 0;
1458
    int progress = 0;
K
Kevin Wolf 已提交
1459 1460

    /* Parse commandline parameters */
K
Kevin Wolf 已提交
1461
    fmt = NULL;
1462
    cache = BDRV_DEFAULT_CACHE;
K
Kevin Wolf 已提交
1463 1464 1465
    out_baseimg = NULL;
    out_basefmt = NULL;
    for(;;) {
1466
        c = getopt(argc, argv, "uhf:F:b:pt:");
1467
        if (c == -1) {
K
Kevin Wolf 已提交
1468
            break;
1469
        }
K
Kevin Wolf 已提交
1470
        switch(c) {
J
Jes Sorensen 已提交
1471
        case '?':
K
Kevin Wolf 已提交
1472 1473 1474
        case 'h':
            help();
            return 0;
K
Kevin Wolf 已提交
1475 1476 1477
        case 'f':
            fmt = optarg;
            break;
K
Kevin Wolf 已提交
1478 1479 1480 1481 1482 1483 1484 1485 1486
        case 'F':
            out_basefmt = optarg;
            break;
        case 'b':
            out_baseimg = optarg;
            break;
        case 'u':
            unsafe = 1;
            break;
1487 1488 1489
        case 'p':
            progress = 1;
            break;
1490 1491 1492
        case 't':
            cache = optarg;
            break;
K
Kevin Wolf 已提交
1493 1494 1495
        }
    }

1496
    if ((optind >= argc) || (!unsafe && !out_baseimg)) {
K
Kevin Wolf 已提交
1497
        help();
1498
    }
K
Kevin Wolf 已提交
1499 1500
    filename = argv[optind++];

1501 1502 1503
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

1504
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
1505
    ret = bdrv_parse_cache_flags(cache, &flags);
1506 1507 1508 1509 1510
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        return -1;
    }

K
Kevin Wolf 已提交
1511 1512 1513 1514 1515 1516
    /*
     * 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.
     */
1517
    bs = bdrv_new_open(filename, fmt, flags);
1518 1519 1520
    if (!bs) {
        return 1;
    }
K
Kevin Wolf 已提交
1521 1522 1523 1524 1525 1526 1527 1528

    /* 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) {
1529
            error_report("Invalid format name: '%s'", bs->backing_format);
1530 1531
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
1532 1533 1534 1535 1536 1537
        }
    }

    if (out_basefmt != NULL) {
        new_backing_drv = bdrv_find_format(out_basefmt);
        if (new_backing_drv == NULL) {
1538
            error_report("Invalid format name: '%s'", out_basefmt);
1539 1540
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553
        }
    }

    /* 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));
1554 1555 1556
        ret = bdrv_open(bs_old_backing, backing_name, BDRV_O_FLAGS,
                        old_backing_drv);
        if (ret) {
1557
            error_report("Could not open old backing file '%s'", backing_name);
1558
            goto out;
K
Kevin Wolf 已提交
1559 1560 1561
        }

        bs_new_backing = bdrv_new("new_backing");
1562
        ret = bdrv_open(bs_new_backing, out_baseimg, BDRV_O_FLAGS,
1563 1564
                        new_backing_drv);
        if (ret) {
1565
            error_report("Could not open new backing file '%s'", out_baseimg);
1566
            goto out;
K
Kevin Wolf 已提交
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580
        }
    }

    /*
     * 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;
1581 1582
        uint64_t old_backing_num_sectors;
        uint64_t new_backing_num_sectors;
K
Kevin Wolf 已提交
1583
        uint64_t sector;
1584
        int n;
1585 1586
        uint8_t * buf_old;
        uint8_t * buf_new;
1587
        float local_progress;
1588

K
Kevin Wolf 已提交
1589 1590
        buf_old = qemu_blockalign(bs, IO_BUF_SIZE);
        buf_new = qemu_blockalign(bs, IO_BUF_SIZE);
K
Kevin Wolf 已提交
1591 1592

        bdrv_get_geometry(bs, &num_sectors);
1593 1594
        bdrv_get_geometry(bs_old_backing, &old_backing_num_sectors);
        bdrv_get_geometry(bs_new_backing, &new_backing_num_sectors);
K
Kevin Wolf 已提交
1595

1596
        local_progress = (float)100 /
1597
            (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
K
Kevin Wolf 已提交
1598 1599 1600 1601 1602 1603 1604 1605 1606 1607
        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 */
1608 1609
            ret = bdrv_is_allocated(bs, sector, n, &n);
            if (ret) {
K
Kevin Wolf 已提交
1610 1611 1612
                continue;
            }

1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628
            /*
             * 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 已提交
1629
            }
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642

            if (sector >= new_backing_num_sectors) {
                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 已提交
1643 1644 1645 1646 1647 1648 1649 1650 1651
            }

            /* 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,
1652
                    buf_new + written * 512, n - written, &pnum))
K
Kevin Wolf 已提交
1653 1654 1655 1656
                {
                    ret = bdrv_write(bs, sector + written,
                        buf_old + written * 512, pnum);
                    if (ret < 0) {
1657
                        error_report("Error while writing to COW image: %s",
K
Kevin Wolf 已提交
1658
                            strerror(-ret));
1659
                        goto out;
K
Kevin Wolf 已提交
1660 1661 1662 1663 1664
                    }
                }

                written += pnum;
            }
1665
            qemu_progress_print(local_progress, 100);
K
Kevin Wolf 已提交
1666
        }
1667

K
Kevin Wolf 已提交
1668 1669
        qemu_vfree(buf_old);
        qemu_vfree(buf_new);
K
Kevin Wolf 已提交
1670 1671 1672 1673 1674 1675 1676 1677 1678
    }

    /*
     * 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.
     */
    ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
    if (ret == -ENOSPC) {
1679 1680
        error_report("Could not change the backing file to '%s': No "
                     "space left in the file header", out_baseimg);
K
Kevin Wolf 已提交
1681
    } else if (ret < 0) {
1682
        error_report("Could not change the backing file to '%s': %s",
K
Kevin Wolf 已提交
1683 1684 1685
            out_baseimg, strerror(-ret));
    }

1686
    qemu_progress_print(100, 0);
K
Kevin Wolf 已提交
1687 1688 1689 1690 1691 1692
    /*
     * 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.
     */
1693
out:
1694
    qemu_progress_end();
K
Kevin Wolf 已提交
1695 1696
    /* Cleanup */
    if (!unsafe) {
1697 1698 1699 1700 1701 1702
        if (bs_old_backing != NULL) {
            bdrv_delete(bs_old_backing);
        }
        if (bs_new_backing != NULL) {
            bdrv_delete(bs_new_backing);
        }
K
Kevin Wolf 已提交
1703 1704 1705
    }

    bdrv_delete(bs);
1706 1707 1708
    if (ret) {
        return 1;
    }
K
Kevin Wolf 已提交
1709 1710 1711
    return 0;
}

1712 1713 1714 1715 1716
static int img_resize(int argc, char **argv)
{
    int c, ret, relative;
    const char *filename, *fmt, *size;
    int64_t n, total_size;
1717
    BlockDriverState *bs = NULL;
1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729
    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 */
            }
1730 1731 1732
        },
    };

K
Kevin Wolf 已提交
1733 1734 1735 1736 1737 1738 1739 1740 1741 1742
    /* 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 */
1743 1744 1745 1746 1747 1748 1749
    fmt = NULL;
    for(;;) {
        c = getopt(argc, argv, "f:h");
        if (c == -1) {
            break;
        }
        switch(c) {
J
Jes Sorensen 已提交
1750
        case '?':
1751 1752 1753 1754 1755 1756 1757 1758
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        }
    }
K
Kevin Wolf 已提交
1759
    if (optind >= argc) {
1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779
        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 */
1780 1781
    param = qemu_opts_create(&resize_options, NULL, 0, NULL);
    if (qemu_opt_set(param, BLOCK_OPT_SIZE, size)) {
1782
        /* Error message already printed when size parsing fails */
1783
        ret = -1;
1784
        qemu_opts_del(param);
1785
        goto out;
1786
    }
1787 1788
    n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
    qemu_opts_del(param);
1789 1790

    bs = bdrv_new_open(filename, fmt, BDRV_O_FLAGS | BDRV_O_RDWR);
1791
    if (!bs) {
1792 1793
        ret = -1;
        goto out;
1794
    }
1795 1796 1797 1798 1799 1800 1801

    if (relative) {
        total_size = bdrv_getlength(bs) + n * relative;
    } else {
        total_size = n;
    }
    if (total_size <= 0) {
1802
        error_report("New image size must be positive");
1803 1804
        ret = -1;
        goto out;
1805 1806 1807 1808 1809 1810 1811 1812
    }

    ret = bdrv_truncate(bs, total_size);
    switch (ret) {
    case 0:
        printf("Image resized.\n");
        break;
    case -ENOTSUP:
1813
        error_report("This image does not support resize");
1814 1815
        break;
    case -EACCES:
1816
        error_report("Image is read-only");
1817 1818
        break;
    default:
1819
        error_report("Error resizing image (%d)", -ret);
1820 1821
        break;
    }
1822
out:
1823 1824 1825
    if (bs) {
        bdrv_delete(bs);
    }
1826 1827 1828
    if (ret) {
        return 1;
    }
1829 1830 1831
    return 0;
}

A
Anthony Liguori 已提交
1832
static const img_cmd_t img_cmds[] = {
1833 1834 1835 1836 1837 1838 1839 1840
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
    { NULL, NULL, },
};

B
bellard 已提交
1841 1842
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
1843
    const img_cmd_t *cmd;
1844
    const char *cmdname;
B
bellard 已提交
1845

K
Kevin Wolf 已提交
1846 1847
    error_set_progname(argv[0]);

B
bellard 已提交
1848 1849 1850
    bdrv_init();
    if (argc < 2)
        help();
1851
    cmdname = argv[1];
1852
    argc--; argv++;
1853

1854 1855
    qemu_init_main_loop();

1856 1857 1858 1859 1860
    /* find the command */
    for(cmd = img_cmds; cmd->name != NULL; cmd++) {
        if (!strcmp(cmdname, cmd->name)) {
            return cmd->handler(argc, argv);
        }
B
bellard 已提交
1861
    }
1862 1863 1864

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