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

30 31 32 33
#ifdef _WIN32
#include <windows.h>
#endif

A
Anthony Liguori 已提交
34
typedef struct img_cmd_t {
35 36
    const char *name;
    int (*handler)(int argc, char **argv);
A
Anthony Liguori 已提交
37
} img_cmd_t;
38

39 40 41
/* Default to cache=writeback as data integrity is not important for qemu-tcg. */
#define BRDV_O_FLAGS BDRV_O_CACHE_WB

M
malc 已提交
42
static void QEMU_NORETURN error(const char *fmt, ...)
B
bellard 已提交
43 44 45
{
    va_list ap;
    va_start(ap, fmt);
B
bellard 已提交
46
    fprintf(stderr, "qemu-img: ");
B
bellard 已提交
47 48 49 50 51 52 53 54 55 56 57
    vfprintf(stderr, fmt, ap);
    fprintf(stderr, "\n");
    exit(1);
    va_end(ap);
}

static void format_print(void *opaque, const char *name)
{
    printf(" %s", name);
}

B
blueswir1 已提交
58
/* Please keep in synch with qemu-img.texi */
P
pbrook 已提交
59
static void help(void)
B
bellard 已提交
60
{
61 62
    const char *help_msg =
           "qemu-img version " QEMU_VERSION ", Copyright (c) 2004-2008 Fabrice Bellard\n"
63 64 65 66
           "usage: qemu-img command [command options]\n"
           "QEMU disk image utility\n"
           "\n"
           "Command syntax:\n"
67 68 69 70 71
#define DEF(option, callback, arg_string)        \
           "  " arg_string "\n"
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
           "\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"
           "  '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"
           "\n"
           "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"
95 96 97
           "  '-l' lists all snapshots in the given image\n";

    printf("%s\nSupported formats:", help_msg);
B
bellard 已提交
98 99 100 101 102 103 104 105 106 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
    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;
148

B
bellard 已提交
149 150 151 152 153
    tcsetattr (0, TCSANOW, &tty);

    atexit(term_exit);
}

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

191
static BlockDriverState *bdrv_new_open(const char *filename,
192 193
                                       const char *fmt,
                                       int readonly)
194 195 196 197
{
    BlockDriverState *bs;
    BlockDriver *drv;
    char password[256];
198
    int flags = BRDV_O_FLAGS;
199 200 201 202 203 204 205 206 207 208 209

    bs = bdrv_new("");
    if (!bs)
        error("Not enough memory");
    if (fmt) {
        drv = bdrv_find_format(fmt);
        if (!drv)
            error("Unknown file format '%s'", fmt);
    } else {
        drv = NULL;
    }
210 211 212 213
    if (!readonly) {
        flags |= BDRV_O_RDWR;
    }
    if (bdrv_open2(bs, filename, flags, drv) < 0) {
214 215 216 217 218 219 220 221 222 223 224 225
        error("Could not open '%s'", filename);
    }
    if (bdrv_is_encrypted(bs)) {
        printf("Disk image '%s' is encrypted.\n", filename);
        if (read_password(password, sizeof(password)) < 0)
            error("No password given");
        if (bdrv_set_key(bs, password) < 0)
            error("invalid password");
    }
    return bs;
}

226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
static void add_old_style_options(const char *fmt, QEMUOptionParameter *list,
    int flags, const char *base_filename, const char *base_fmt)
{
    if (flags & BLOCK_FLAG_ENCRYPT) {
        if (set_option_parameter(list, BLOCK_OPT_ENCRYPT, "on")) {
            error("Encryption not supported for file format '%s'", fmt);
        }
    }
    if (flags & BLOCK_FLAG_COMPAT6) {
        if (set_option_parameter(list, BLOCK_OPT_COMPAT6, "on")) {
            error("VMDK version 6 not supported for file format '%s'", fmt);
        }
    }

    if (base_filename) {
        if (set_option_parameter(list, BLOCK_OPT_BACKING_FILE, base_filename)) {
            error("Backing file not supported for file format '%s'", fmt);
        }
    }
    if (base_fmt) {
        if (set_option_parameter(list, BLOCK_OPT_BACKING_FMT, base_fmt)) {
            error("Backing file format not supported for file format '%s'", fmt);
        }
    }
}

B
bellard 已提交
252 253
static int img_create(int argc, char **argv)
{
254
    int c, ret, flags;
B
bellard 已提交
255
    const char *fmt = "raw";
256
    const char *base_fmt = NULL;
B
bellard 已提交
257 258 259
    const char *filename;
    const char *base_filename = NULL;
    BlockDriver *drv;
260 261
    QEMUOptionParameter *param = NULL;
    char *options = NULL;
262

263
    flags = 0;
B
bellard 已提交
264
    for(;;) {
265
        c = getopt(argc, argv, "F:b:f:he6o:");
B
bellard 已提交
266 267 268 269 270 271
        if (c == -1)
            break;
        switch(c) {
        case 'h':
            help();
            break;
272 273 274
        case 'F':
            base_fmt = optarg;
            break;
B
bellard 已提交
275 276 277 278 279 280 281
        case 'b':
            base_filename = optarg;
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'e':
282
            flags |= BLOCK_FLAG_ENCRYPT;
B
bellard 已提交
283
            break;
284
        case '6':
285
            flags |= BLOCK_FLAG_COMPAT6;
286
            break;
287 288 289
        case 'o':
            options = optarg;
            break;
B
bellard 已提交
290 291
        }
    }
292

293 294 295 296
    /* Find driver and parse its options */
    drv = bdrv_find_format(fmt);
    if (!drv)
        error("Unknown file format '%s'", fmt);
297

298 299 300 301 302
    if (options && !strcmp(options, "?")) {
        print_option_help(drv->create_options);
        return 0;
    }

303 304 305 306 307
    /* Create parameter list with default values */
    param = parse_option_parameters("", drv->create_options, param);
    set_option_parameter_int(param, BLOCK_OPT_SIZE, -1);

    /* Parse -o options */
308 309 310 311 312 313 314
    if (options) {
        param = parse_option_parameters(options, drv->create_options, param);
        if (param == NULL) {
            error("Invalid options for file format '%s'.", fmt);
        }
    }

315 316 317 318 319
    /* Get the filename */
    if (optind >= argc)
        help();
    filename = argv[optind++];

320 321 322 323 324 325
    /* Add size to parameters */
    if (optind < argc) {
        set_option_parameter(param, BLOCK_OPT_SIZE, argv[optind++]);
    }

    /* Add old-style options to parameters */
326
    add_old_style_options(fmt, param, flags, base_filename, base_fmt);
327 328 329

    // The size for the image must always be specified, with one exception:
    // If we are using a backing file, we can obtain the size from there
330
    if (get_option_parameter(param, BLOCK_OPT_SIZE)->value.n == -1) {
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351

        QEMUOptionParameter *backing_file =
            get_option_parameter(param, BLOCK_OPT_BACKING_FILE);
        QEMUOptionParameter *backing_fmt =
            get_option_parameter(param, BLOCK_OPT_BACKING_FMT);

        if (backing_file && backing_file->value.s) {
            BlockDriverState *bs;
            uint64_t size;
            const char *fmt = NULL;
            char buf[32];

            if (backing_fmt && backing_fmt->value.s) {
                 if (bdrv_find_format(backing_fmt->value.s)) {
                     fmt = backing_fmt->value.s;
                } else {
                     error("Unknown backing file format '%s'",
                        backing_fmt->value.s);
                }
            }

352
            bs = bdrv_new_open(backing_file->value.s, fmt, 1);
353 354 355 356 357 358 359 360 361
            bdrv_get_geometry(bs, &size);
            size *= 512;
            bdrv_delete(bs);

            snprintf(buf, sizeof(buf), "%" PRId64, size);
            set_option_parameter(param, BLOCK_OPT_SIZE, buf);
        } else {
            error("Image creation needs a size parameter");
        }
362
    }
363 364 365 366 367 368 369 370

    printf("Formatting '%s', fmt=%s ", filename, fmt);
    print_option_parameters(param);
    puts("");

    ret = bdrv_create(drv, filename, param);
    free_option_parameters(param);

B
bellard 已提交
371 372
    if (ret < 0) {
        if (ret == -ENOTSUP) {
B
bellard 已提交
373
            error("Formatting or formatting option not supported for file format '%s'", fmt);
374 375
        } else if (ret == -EFBIG) {
            error("The image size is too large for file format '%s'", fmt);
B
bellard 已提交
376 377 378 379 380 381 382
        } else {
            error("Error while formatting");
        }
    }
    return 0;
}

383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
static int img_check(int argc, char **argv)
{
    int c, ret;
    const char *filename, *fmt;
    BlockDriver *drv;
    BlockDriverState *bs;

    fmt = NULL;
    for(;;) {
        c = getopt(argc, argv, "f:h");
        if (c == -1)
            break;
        switch(c) {
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        }
    }
    if (optind >= argc)
        help();
    filename = argv[optind++];

    bs = bdrv_new("");
    if (!bs)
        error("Not enough memory");
    if (fmt) {
        drv = bdrv_find_format(fmt);
        if (!drv)
            error("Unknown file format '%s'", fmt);
    } else {
        drv = NULL;
    }
    if (bdrv_open2(bs, filename, BRDV_O_FLAGS, drv) < 0) {
        error("Could not open '%s'", filename);
    }
    ret = bdrv_check(bs);
    switch(ret) {
    case 0:
        printf("No errors were found on the image.\n");
        break;
    case -ENOTSUP:
        error("This image format does not support checks");
        break;
    default:
        if (ret < 0) {
            error("An error occurred during the check");
        } else {
            printf("%d errors were found on the image.\n", ret);
        }
        break;
    }

    bdrv_delete(bs);
    return 0;
}

B
bellard 已提交
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
static int img_commit(int argc, char **argv)
{
    int c, ret;
    const char *filename, *fmt;
    BlockDriver *drv;
    BlockDriverState *bs;

    fmt = NULL;
    for(;;) {
        c = getopt(argc, argv, "f:h");
        if (c == -1)
            break;
        switch(c) {
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        }
    }
463
    if (optind >= argc)
B
bellard 已提交
464 465 466 467 468 469 470 471 472 473 474 475 476
        help();
    filename = argv[optind++];

    bs = bdrv_new("");
    if (!bs)
        error("Not enough memory");
    if (fmt) {
        drv = bdrv_find_format(fmt);
        if (!drv)
            error("Unknown file format '%s'", fmt);
    } else {
        drv = NULL;
    }
477
    if (bdrv_open2(bs, filename, BRDV_O_FLAGS | BDRV_O_RDWR, drv) < 0) {
B
bellard 已提交
478 479 480 481 482 483 484 485 486 487 488 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
        error("Could not open '%s'", filename);
    }
    ret = bdrv_commit(bs);
    switch(ret) {
    case 0:
        printf("Image committed.\n");
        break;
    case -ENOENT:
        error("No disk inserted");
        break;
    case -EACCES:
        error("Image is read-only");
        break;
    case -ENOTSUP:
        error("Image is already committed");
        break;
    default:
        error("Error while committing image");
        break;
    }

    bdrv_delete(bs);
    return 0;
}

static int is_not_zero(const uint8_t *sector, int len)
{
    int i;
    len >>= 2;
    for(i = 0;i < len; i++) {
        if (((uint32_t *)sector)[i] != 0)
            return 1;
    }
    return 0;
}

514 515 516 517 518 519 520
/*
 * 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 已提交
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
{
    int v, i;

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
    v = is_not_zero(buf, 512);
    for(i = 1; i < n; i++) {
        buf += 512;
        if (v != is_not_zero(buf, 512))
            break;
    }
    *pnum = i;
    return v;
}

K
Kevin Wolf 已提交
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
/*
 * 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;
}

570
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
571 572 573

static int img_convert(int argc, char **argv)
{
574
    int c, ret, n, n1, bs_n, bs_i, flags, cluster_size, cluster_sectors;
575
    const char *fmt, *out_fmt, *out_baseimg, *out_filename;
B
bellard 已提交
576
    BlockDriver *drv;
577
    BlockDriverState **bs, *out_bs;
578 579
    int64_t total_sectors, nb_sectors, sector_num, bs_offset;
    uint64_t bs_sectors;
580
    uint8_t * buf;
B
bellard 已提交
581
    const uint8_t *buf1;
B
bellard 已提交
582
    BlockDriverInfo bdi;
583 584
    QEMUOptionParameter *param = NULL;
    char *options = NULL;
B
bellard 已提交
585 586 587

    fmt = NULL;
    out_fmt = "raw";
588
    out_baseimg = NULL;
589
    flags = 0;
B
bellard 已提交
590
    for(;;) {
591
        c = getopt(argc, argv, "f:O:B:hce6o:");
B
bellard 已提交
592 593 594 595 596 597 598 599 600 601 602 603
        if (c == -1)
            break;
        switch(c) {
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'O':
            out_fmt = optarg;
            break;
604 605 606
        case 'B':
            out_baseimg = optarg;
            break;
B
bellard 已提交
607
        case 'c':
608
            flags |= BLOCK_FLAG_COMPRESS;
B
bellard 已提交
609 610
            break;
        case 'e':
611 612 613 614
            flags |= BLOCK_FLAG_ENCRYPT;
            break;
        case '6':
            flags |= BLOCK_FLAG_COMPAT6;
B
bellard 已提交
615
            break;
616 617 618
        case 'o':
            options = optarg;
            break;
B
bellard 已提交
619 620
        }
    }
621

622 623 624 625
    bs_n = argc - optind - 1;
    if (bs_n < 1) help();

    out_filename = argv[argc - 1];
626 627 628

    if (bs_n > 1 && out_baseimg)
        error("-B makes no sense when concatenating multiple input images");
629 630 631 632 633 634 635
        
    bs = calloc(bs_n, sizeof(BlockDriverState *));
    if (!bs)
        error("Out of memory");

    total_sectors = 0;
    for (bs_i = 0; bs_i < bs_n; bs_i++) {
636
        bs[bs_i] = bdrv_new_open(argv[optind + bs_i], fmt, 1);
637 638 639 640 641
        if (!bs[bs_i])
            error("Could not open '%s'", argv[optind + bs_i]);
        bdrv_get_geometry(bs[bs_i], &bs_sectors);
        total_sectors += bs_sectors;
    }
B
bellard 已提交
642

643
    /* Find driver and parse its options */
B
bellard 已提交
644 645
    drv = bdrv_find_format(out_fmt);
    if (!drv)
646
        error("Unknown file format '%s'", out_fmt);
647

648 649
    if (options && !strcmp(options, "?")) {
        print_option_help(drv->create_options);
K
Kevin Wolf 已提交
650
        free(bs);
651 652 653
        return 0;
    }

654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
    if (options) {
        param = parse_option_parameters(options, drv->create_options, param);
        if (param == NULL) {
            error("Invalid options for file format '%s'.", out_fmt);
        }
    } else {
        param = parse_option_parameters("", drv->create_options, param);
    }

    set_option_parameter_int(param, BLOCK_OPT_SIZE, total_sectors * 512);
    add_old_style_options(out_fmt, param, flags, out_baseimg, NULL);

    /* Check if compression is supported */
    if (flags & BLOCK_FLAG_COMPRESS) {
        QEMUOptionParameter *encryption =
            get_option_parameter(param, BLOCK_OPT_ENCRYPT);

        if (!drv->bdrv_write_compressed) {
            error("Compression not supported for this file format");
        }

        if (encryption && encryption->value.n) {
            error("Compression and encryption not supported at the same time");
        }
    }

    /* Create the new image */
    ret = bdrv_create(drv, out_filename, param);
    free_option_parameters(param);

B
bellard 已提交
684 685
    if (ret < 0) {
        if (ret == -ENOTSUP) {
686
            error("Formatting not supported for file format '%s'", out_fmt);
687 688
        } else if (ret == -EFBIG) {
            error("The image size is too large for file format '%s'", out_fmt);
B
bellard 已提交
689 690 691 692
        } else {
            error("Error while formatting '%s'", out_filename);
        }
    }
693

694
    out_bs = bdrv_new_open(out_filename, out_fmt, 0);
B
bellard 已提交
695

696 697 698
    bs_i = 0;
    bs_offset = 0;
    bdrv_get_geometry(bs[0], &bs_sectors);
699
    buf = qemu_malloc(IO_BUF_SIZE);
700 701

    if (flags & BLOCK_FLAG_COMPRESS) {
B
bellard 已提交
702 703 704
        if (bdrv_get_info(out_bs, &bdi) < 0)
            error("could not get block driver info");
        cluster_size = bdi.cluster_size;
B
bellard 已提交
705 706 707 708 709
        if (cluster_size <= 0 || cluster_size > IO_BUF_SIZE)
            error("invalid cluster size");
        cluster_sectors = cluster_size >> 9;
        sector_num = 0;
        for(;;) {
710 711 712 713
            int64_t bs_num;
            int remainder;
            uint8_t *buf2;

B
bellard 已提交
714 715 716 717 718 719 720
            nb_sectors = total_sectors - sector_num;
            if (nb_sectors <= 0)
                break;
            if (nb_sectors >= cluster_sectors)
                n = cluster_sectors;
            else
                n = nb_sectors;
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751

            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;
                    /* printf("changing part: sector_num=%lld, "
                       "bs_i=%d, bs_offset=%lld, bs_sectors=%lld\n",
                       sector_num, bs_i, bs_offset, bs_sectors); */
                }
                assert (bs_num < bs_sectors);

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

                if (bdrv_read(bs[bs_i], bs_num, buf2, nlow) < 0) 
                    error("error while reading");

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

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

B
bellard 已提交
752 753 754
            if (n < cluster_sectors)
                memset(buf + n * 512, 0, cluster_size - n * 512);
            if (is_not_zero(buf, cluster_size)) {
755
                if (bdrv_write_compressed(out_bs, sector_num, buf,
B
bellard 已提交
756
                                          cluster_sectors) != 0)
757 758
                    error("error while compressing sector %" PRId64,
                          sector_num);
B
bellard 已提交
759 760 761
            }
            sector_num += n;
        }
B
bellard 已提交
762 763
        /* signal EOF to align */
        bdrv_write_compressed(out_bs, 0, NULL, 0);
B
bellard 已提交
764
    } else {
765
        sector_num = 0; // total number of sectors converted so far
B
bellard 已提交
766 767 768 769 770 771 772 773
        for(;;) {
            nb_sectors = total_sectors - sector_num;
            if (nb_sectors <= 0)
                break;
            if (nb_sectors >= (IO_BUF_SIZE / 512))
                n = (IO_BUF_SIZE / 512);
            else
                n = nb_sectors;
774 775 776 777 778 779 780 781 782 783 784 785 786 787

            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);
                /* printf("changing part: sector_num=%lld, bs_i=%d, "
                  "bs_offset=%lld, bs_sectors=%lld\n",
                   sector_num, bs_i, bs_offset, bs_sectors); */
            }

            if (n > bs_offset + bs_sectors - sector_num)
                n = bs_offset + bs_sectors - sector_num;

788
            if (!drv->no_zero_init) {
789 790 791 792 793 794 795 796 797 798 799 800 801
                /* 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;
802 803 804
                }
            } else {
                n1 = n;
805 806
            }

807
            if (bdrv_read(bs[bs_i], sector_num - bs_offset, buf, n) < 0) 
B
bellard 已提交
808 809 810 811 812 813
                error("error while reading");
            /* 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) {
814 815
                /* If the output image is being created as a copy on write image,
                   copy all sectors even the ones containing only NUL bytes,
816 817 818 819 820
                   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. */
821
                if (drv->no_zero_init || out_baseimg ||
822
                    is_allocated_sectors(buf1, n, &n1)) {
823
                    if (bdrv_write(out_bs, sector_num, buf1, n1) < 0)
B
bellard 已提交
824 825 826 827 828 829 830 831
                        error("error while writing");
                }
                sector_num += n1;
                n -= n1;
                buf1 += n1 * 512;
            }
        }
    }
832
    qemu_free(buf);
B
bellard 已提交
833
    bdrv_delete(out_bs);
834 835 836
    for (bs_i = 0; bs_i < bs_n; bs_i++)
        bdrv_delete(bs[bs_i]);
    free(bs);
B
bellard 已提交
837 838 839
    return 0;
}

B
bellard 已提交
840 841 842
#ifdef _WIN32
static int64_t get_allocated_file_size(const char *filename)
{
843 844
    typedef DWORD (WINAPI * get_compressed_t)(const char *filename, DWORD *high);
    get_compressed_t get_compressed;
B
bellard 已提交
845
    struct _stati64 st;
846 847 848 849 850 851 852 853 854 855

    /* WinNT support GetCompressedFileSize to determine allocate size */
    get_compressed = (get_compressed_t) GetProcAddress(GetModuleHandle("kernel32"), "GetCompressedFileSizeA");
    if (get_compressed) {
    	DWORD high, low;
    	low = get_compressed(filename, &high);
    	if (low != 0xFFFFFFFFlu || GetLastError() == NO_ERROR)
	    return (((int64_t) high) << 32) + low;
    }

856
    if (_stati64(filename, &st) < 0)
B
bellard 已提交
857 858 859 860 861 862 863
        return -1;
    return st.st_size;
}
#else
static int64_t get_allocated_file_size(const char *filename)
{
    struct stat st;
864
    if (stat(filename, &st) < 0)
B
bellard 已提交
865 866 867 868 869
        return -1;
    return (int64_t)st.st_blocks * 512;
}
#endif

B
bellard 已提交
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
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));
    }
    qemu_free(sn_tab);
}

B
bellard 已提交
888 889 890 891 892 893 894
static int img_info(int argc, char **argv)
{
    int c;
    const char *filename, *fmt;
    BlockDriver *drv;
    BlockDriverState *bs;
    char fmt_name[128], size_buf[128], dsize_buf[128];
895 896
    uint64_t total_sectors;
    int64_t allocated_size;
B
bellard 已提交
897 898
    char backing_filename[1024];
    char backing_filename2[1024];
B
bellard 已提交
899
    BlockDriverInfo bdi;
B
bellard 已提交
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914

    fmt = NULL;
    for(;;) {
        c = getopt(argc, argv, "f:h");
        if (c == -1)
            break;
        switch(c) {
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        }
    }
915
    if (optind >= argc)
B
bellard 已提交
916 917 918 919 920 921 922 923 924 925 926 927 928
        help();
    filename = argv[optind++];

    bs = bdrv_new("");
    if (!bs)
        error("Not enough memory");
    if (fmt) {
        drv = bdrv_find_format(fmt);
        if (!drv)
            error("Unknown file format '%s'", fmt);
    } else {
        drv = NULL;
    }
K
Kevin Wolf 已提交
929
    if (bdrv_open2(bs, filename, BRDV_O_FLAGS | BDRV_O_NO_BACKING, drv) < 0) {
B
bellard 已提交
930 931 932 933 934
        error("Could not open '%s'", filename);
    }
    bdrv_get_format(bs, fmt_name, sizeof(fmt_name));
    bdrv_get_geometry(bs, &total_sectors);
    get_human_readable_size(size_buf, sizeof(size_buf), total_sectors * 512);
B
bellard 已提交
935 936
    allocated_size = get_allocated_file_size(filename);
    if (allocated_size < 0)
937
        snprintf(dsize_buf, sizeof(dsize_buf), "unavailable");
938
    else
939
        get_human_readable_size(dsize_buf, sizeof(dsize_buf),
940
                                allocated_size);
B
bellard 已提交
941 942
    printf("image: %s\n"
           "file format: %s\n"
943
           "virtual size: %s (%" PRId64 " bytes)\n"
B
bellard 已提交
944
           "disk size: %s\n",
945
           filename, fmt_name, size_buf,
946
           (total_sectors * 512),
B
bellard 已提交
947 948 949
           dsize_buf);
    if (bdrv_is_encrypted(bs))
        printf("encrypted: yes\n");
B
bellard 已提交
950
    if (bdrv_get_info(bs, &bdi) >= 0) {
951
        if (bdi.cluster_size != 0)
B
bellard 已提交
952 953
            printf("cluster_size: %d\n", bdi.cluster_size);
    }
B
bellard 已提交
954
    bdrv_get_backing_filename(bs, backing_filename, sizeof(backing_filename));
B
bellard 已提交
955
    if (backing_filename[0] != '\0') {
B
bellard 已提交
956 957
        path_combine(backing_filename2, sizeof(backing_filename2),
                     filename, backing_filename);
958
        printf("backing file: %s (actual path: %s)\n",
B
bellard 已提交
959 960
               backing_filename,
               backing_filename2);
B
bellard 已提交
961 962
    }
    dump_snapshots(bs);
B
bellard 已提交
963 964 965 966
    bdrv_delete(bs);
    return 0;
}

967 968 969 970 971
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

972
static int img_snapshot(int argc, char **argv)
973 974 975 976
{
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
977
    int c, ret, bdrv_oflags;
978 979 980
    int action = 0;
    qemu_timeval tv;

981
    bdrv_oflags = BDRV_O_RDWR;
982 983 984 985 986 987 988 989
    /* Parse commandline parameters */
    for(;;) {
        c = getopt(argc, argv, "la:c:d:h");
        if (c == -1)
            break;
        switch(c) {
        case 'h':
            help();
990
            return 0;
991 992 993
        case 'l':
            if (action) {
                help();
994
                return 0;
995 996
            }
            action = SNAPSHOT_LIST;
997
            bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
998 999 1000 1001
            break;
        case 'a':
            if (action) {
                help();
1002
                return 0;
1003 1004 1005 1006 1007 1008 1009
            }
            action = SNAPSHOT_APPLY;
            snapshot_name = optarg;
            break;
        case 'c':
            if (action) {
                help();
1010
                return 0;
1011 1012 1013 1014 1015 1016 1017
            }
            action = SNAPSHOT_CREATE;
            snapshot_name = optarg;
            break;
        case 'd':
            if (action) {
                help();
1018
                return 0;
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
            }
            action = SNAPSHOT_DELETE;
            snapshot_name = optarg;
            break;
        }
    }

    if (optind >= argc)
        help();
    filename = argv[optind++];

    /* Open the image */
    bs = bdrv_new("");
    if (!bs)
        error("Not enough memory");

1035
    if (bdrv_open2(bs, filename, bdrv_oflags, NULL) < 0) {
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
        error("Could not open '%s'", filename);
    }

    /* 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);
        if (ret)
            error("Could not create snapshot '%s': %d (%s)",
                snapshot_name, ret, strerror(-ret));
        break;

    case SNAPSHOT_APPLY:
        ret = bdrv_snapshot_goto(bs, snapshot_name);
        if (ret)
            error("Could not apply snapshot '%s': %d (%s)",
                snapshot_name, ret, strerror(-ret));
        break;

    case SNAPSHOT_DELETE:
        ret = bdrv_snapshot_delete(bs, snapshot_name);
        if (ret)
            error("Could not delete snapshot '%s': %d (%s)",
                snapshot_name, ret, strerror(-ret));
        break;
    }

    /* Cleanup */
    bdrv_delete(bs);
1076 1077

    return 0;
1078 1079
}

K
Kevin Wolf 已提交
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 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
static int img_rebase(int argc, char **argv)
{
    BlockDriverState *bs, *bs_old_backing, *bs_new_backing;
    BlockDriver *old_backing_drv, *new_backing_drv;
    char *filename;
    const char *out_basefmt, *out_baseimg;
    int c, flags, ret;
    int unsafe = 0;

    /* Parse commandline parameters */
    out_baseimg = NULL;
    out_basefmt = NULL;

    for(;;) {
        c = getopt(argc, argv, "uhF:b:");
        if (c == -1)
            break;
        switch(c) {
        case 'h':
            help();
            return 0;
        case 'F':
            out_basefmt = optarg;
            break;
        case 'b':
            out_baseimg = optarg;
            break;
        case 'u':
            unsafe = 1;
            break;
        }
    }

    if ((optind >= argc) || !out_baseimg)
        help();
    filename = argv[optind++];

    /*
     * 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.
     */
    bs = bdrv_new("");
    if (!bs)
        error("Not enough memory");

1127
    flags = BRDV_O_FLAGS | BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
K
Kevin Wolf 已提交
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 1164 1165 1166 1167
    if (bdrv_open2(bs, filename, flags, NULL) < 0) {
        error("Could not open '%s'", filename);
    }

    /* 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) {
            error("Invalid format name: '%s'", bs->backing_format);
        }
    }

    if (out_basefmt != NULL) {
        new_backing_drv = bdrv_find_format(out_basefmt);
        if (new_backing_drv == NULL) {
            error("Invalid format name: '%s'", out_basefmt);
        }
    }

    /* 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));
        if (bdrv_open2(bs_old_backing, backing_name, BRDV_O_FLAGS,
            old_backing_drv))
        {
            error("Could not open old backing file '%s'", backing_name);
            return -1;
        }

        bs_new_backing = bdrv_new("new_backing");
1168
        if (bdrv_open2(bs_new_backing, out_baseimg, BRDV_O_FLAGS | BDRV_O_RDWR,
K
Kevin Wolf 已提交
1169 1170
            new_backing_drv))
        {
K
Kevin Wolf 已提交
1171
            error("Could not open new backing file '%s'", out_baseimg);
K
Kevin Wolf 已提交
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
            return -1;
        }
    }

    /*
     * 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;
        uint64_t sector;
        int n, n1;
1189 1190 1191 1192 1193
        uint8_t * buf_old;
        uint8_t * buf_new;

        buf_old = qemu_malloc(IO_BUF_SIZE);
        buf_new = qemu_malloc(IO_BUF_SIZE);
K
Kevin Wolf 已提交
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

        bdrv_get_geometry(bs, &num_sectors);

        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 */
            if (bdrv_is_allocated(bs, sector, n, &n1)) {
                n = n1;
                continue;
            }

            /* Read old and new backing file */
            if (bdrv_read(bs_old_backing, sector, buf_old, n) < 0) {
                error("error while reading from old backing file");
            }
            if (bdrv_read(bs_new_backing, sector, buf_new, n) < 0) {
                error("error while reading from new backing file");
            }

            /* 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,
1227
                    buf_new + written * 512, n - written, &pnum))
K
Kevin Wolf 已提交
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
                {
                    ret = bdrv_write(bs, sector + written,
                        buf_old + written * 512, pnum);
                    if (ret < 0) {
                        error("Error while writing to COW image: %s",
                            strerror(-ret));
                    }
                }

                written += pnum;
            }
        }
1240 1241 1242

        qemu_free(buf_old);
        qemu_free(buf_new);
K
Kevin Wolf 已提交
1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
    }

    /*
     * 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) {
        error("Could not change the backing file to '%s': No space left in "
            "the file header", out_baseimg);
    } else if (ret < 0) {
        error("Could not change the backing file to '%s': %s",
            out_baseimg, strerror(-ret));
    }

    /*
     * 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.
     */

    /* Cleanup */
    if (!unsafe) {
        bdrv_delete(bs_old_backing);
        bdrv_delete(bs_new_backing);
    }

    bdrv_delete(bs);

    return 0;
}

A
Anthony Liguori 已提交
1277
static const img_cmd_t img_cmds[] = {
1278 1279 1280 1281 1282 1283 1284 1285
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
    { NULL, NULL, },
};

B
bellard 已提交
1286 1287
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
1288
    const img_cmd_t *cmd;
1289
    const char *cmdname;
B
bellard 已提交
1290 1291 1292 1293

    bdrv_init();
    if (argc < 2)
        help();
1294
    cmdname = argv[1];
1295
    argc--; argv++;
1296 1297 1298 1299 1300 1301

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

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