qemu-img.c 84.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.
 */
24 25
#include "qapi-visit.h"
#include "qapi/qmp-output-visitor.h"
26
#include "qapi/qmp/qjson.h"
P
pbrook 已提交
27
#include "qemu-common.h"
28 29 30
#include "qemu/option.h"
#include "qemu/error-report.h"
#include "qemu/osdep.h"
31
#include "sysemu/sysemu.h"
32
#include "block/block_int.h"
33
#include "block/qapi.h"
34
#include <getopt.h>
35

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

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

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

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

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

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

F
Fam Zheng 已提交
63 64 65 66 67 68 69 70 71 72 73 74 75 76
static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
{
    va_list ap;

    error_printf("qemu-img: ");

    va_start(ap, fmt);
    error_vprintf(fmt, ap);
    va_end(ap);

    error_printf("\nTry 'qemu-img --help' for more information\n");
    exit(EXIT_FAILURE);
}

B
blueswir1 已提交
77
/* Please keep in synch with qemu-img.texi */
F
Fam Zheng 已提交
78
static void QEMU_NORETURN help(void)
B
bellard 已提交
79
{
80
    const char *help_msg =
81
           QEMU_IMG_VERSION
82 83 84 85
           "usage: qemu-img command [command options]\n"
           "QEMU disk image utility\n"
           "\n"
           "Command syntax:\n"
86 87 88 89 90
#define DEF(option, callback, arg_string)        \
           "  " arg_string "\n"
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
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"
95
           "  'cache' is the cache mode used to write the output disk image, the valid\n"
96 97
           "    options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
           "    'directsync' and 'unsafe' (default for convert)\n"
98
           "  'src_cache' in contrast is the cache mode used to read input disk images\n"
99
           "  'size' is the disk image size in bytes. Optional suffixes\n"
100 101 102
           "    'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
           "    'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P)  are\n"
           "    supported. 'b' is ignored.\n"
103 104 105 106 107
           "  '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"
108 109 110 111 112
           "  'snapshot_param' is param used for internal snapshot, format\n"
           "    is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
           "    '[ID_OR_NAME]'\n"
           "  'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
           "    instead\n"
113 114 115 116 117
           "  '-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"
118
           "  '-p' show progress of command (only certain commands)\n"
119
           "  '-q' use Quiet mode - do not print any output (except errors)\n"
120 121 122 123 124
           "  '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
           "       contain only zeros for qemu-img to create a sparse image during\n"
           "       conversion. If the number of bytes is 0, the source will not be scanned for\n"
           "       unallocated or zero sectors, and the destination image will always be\n"
           "       fully allocated\n"
125
           "  '--output' takes the format in which the output must be done (human or json)\n"
126 127
           "  '-n' skips the target volume creation (useful if the volume is created\n"
           "       prior to running qemu-img)\n"
128
           "\n"
129 130 131 132
           "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"
133
           "       hiding corruption that has already occurred.\n"
134
           "\n"
135 136 137 138 139
           "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"
140 141 142 143 144 145
           "  '-l' lists all snapshots in the given image\n"
           "\n"
           "Parameters to compare subcommand:\n"
           "  '-f' first image format\n"
           "  '-F' second image format\n"
           "  '-s' run in Strict mode - fail on different image size or sector allocation\n";
146 147

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

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

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

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

B
bellard 已提交
216 217 218 219 220
    tcsetattr (0, TCSANOW, &tty);

    atexit(term_exit);
}

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

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

257 258 259
static int print_block_option_help(const char *filename, const char *fmt)
{
    BlockDriver *drv, *proto_drv;
260
    QemuOptsList *create_opts = NULL;
261 262 263 264

    /* Find driver and parse its options */
    drv = bdrv_find_format(fmt);
    if (!drv) {
265
        error_report("Unknown file format '%s'", fmt);
266 267 268
        return 1;
    }

C
Chunyan Liu 已提交
269
    create_opts = qemu_opts_append(create_opts, drv->create_opts);
270 271 272 273
    if (filename) {
        proto_drv = bdrv_find_protocol(filename, true);
        if (!proto_drv) {
            error_report("Unknown protocol '%s'", filename);
274
            qemu_opts_free(create_opts);
275 276
            return 1;
        }
C
Chunyan Liu 已提交
277
        create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
278 279
    }

280 281
    qemu_opts_print_help(create_opts);
    qemu_opts_free(create_opts);
282 283 284
    return 0;
}

285 286
static BlockDriverState *bdrv_new_open(const char *id,
                                       const char *filename,
287
                                       const char *fmt,
288
                                       int flags,
289 290
                                       bool require_io,
                                       bool quiet)
291 292 293 294
{
    BlockDriverState *bs;
    BlockDriver *drv;
    char password[256];
295
    Error *local_err = NULL;
296
    int ret;
297

298
    bs = bdrv_new(id, &error_abort);
299

300 301
    if (fmt) {
        drv = bdrv_find_format(fmt);
302
        if (!drv) {
303
            error_report("Unknown file format '%s'", fmt);
304 305
            goto fail;
        }
306 307 308
    } else {
        drv = NULL;
    }
309

310
    ret = bdrv_open(&bs, filename, NULL, NULL, flags, drv, &local_err);
311
    if (ret < 0) {
312 313 314
        error_report("Could not open '%s': %s", filename,
                     error_get_pretty(local_err));
        error_free(local_err);
315
        goto fail;
316
    }
317

318
    if (bdrv_is_encrypted(bs) && require_io) {
319
        qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
320
        if (read_password(password, sizeof(password)) < 0) {
321
            error_report("No password given");
322 323 324
            goto fail;
        }
        if (bdrv_set_key(bs, password) < 0) {
325
            error_report("invalid password");
326 327
            goto fail;
        }
328 329
    }
    return bs;
330
fail:
331
    bdrv_unref(bs);
332
    return NULL;
333 334
}

335
static int add_old_style_options(const char *fmt, QemuOpts *opts,
336 337
                                 const char *base_filename,
                                 const char *base_fmt)
338 339
{
    if (base_filename) {
340
        if (qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename)) {
341 342
            error_report("Backing file not supported for file format '%s'",
                         fmt);
343
            return -1;
344 345 346
        }
    }
    if (base_fmt) {
347
        if (qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt)) {
348 349
            error_report("Backing file format not supported for file "
                         "format '%s'", fmt);
350
            return -1;
351 352
        }
    }
353
    return 0;
354 355
}

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

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

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

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

426 427
    /* Get image size, if specified */
    if (optind < argc) {
428
        int64_t sval;
429 430 431
        char *end;
        sval = strtosz_suffix(argv[optind++], &end, STRTOSZ_DEFSUFFIX_B);
        if (sval < 0 || *end) {
432 433 434 435
            if (sval == -ERANGE) {
                error_report("Image size must be less than 8 EiB!");
            } else {
                error_report("Invalid image size specified! You may use k, M, "
436 437 438
                      "G, T, P or E suffixes for ");
                error_report("kilobytes, megabytes, gigabytes, terabytes, "
                             "petabytes and exabytes.");
439
            }
440
            goto fail;
441 442 443
        }
        img_size = (uint64_t)sval;
    }
444
    if (optind != argc) {
F
Fam Zheng 已提交
445
        error_exit("Unexpected argument: %s", argv[optind]);
446
    }
447

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

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

fail:
    g_free(options);
    return 1;
B
bellard 已提交
462 463
}

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

481
static void dump_human_image_check(ImageCheck *check, bool quiet)
482 483
{
    if (!(check->corruptions || check->leaks || check->check_errors)) {
484
        qprintf(quiet, "No errors were found on the image.\n");
485 486
    } else {
        if (check->corruptions) {
487 488 489 490
            qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
                    "Data may be corrupted, or further writes to the image "
                    "may corrupt it.\n",
                    check->corruptions);
491 492 493
        }

        if (check->leaks) {
494 495 496 497
            qprintf(quiet,
                    "\n%" PRId64 " leaked clusters were found on the image.\n"
                    "This means waste of disk space, but no harm to data.\n",
                    check->leaks);
498 499 500
        }

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

    if (check->total_clusters != 0 && check->allocated_clusters != 0) {
509 510 511 512 513 514 515
        qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
                "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
                check->allocated_clusters, check->total_clusters,
                check->allocated_clusters * 100.0 / check->total_clusters,
                check->fragmented_clusters * 100.0 / check->allocated_clusters,
                check->compressed_clusters * 100.0 /
                check->allocated_clusters);
516 517 518
    }

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

static int collect_image_check(BlockDriverState *bs,
                   ImageCheck *check,
                   const char *filename,
                   const char *fmt,
                   int fix)
{
    int ret;
    BdrvCheckResult result;

    ret = bdrv_check(bs, &result, fix);
    if (ret < 0) {
        return ret;
    }

    check->filename                 = g_strdup(filename);
    check->format                   = g_strdup(bdrv_get_format_name(bs));
    check->check_errors             = result.check_errors;
    check->corruptions              = result.corruptions;
    check->has_corruptions          = result.corruptions != 0;
    check->leaks                    = result.leaks;
    check->has_leaks                = result.leaks != 0;
    check->corruptions_fixed        = result.corruptions_fixed;
    check->has_corruptions_fixed    = result.corruptions != 0;
    check->leaks_fixed              = result.leaks_fixed;
    check->has_leaks_fixed          = result.leaks != 0;
    check->image_end_offset         = result.image_end_offset;
    check->has_image_end_offset     = result.image_end_offset != 0;
    check->total_clusters           = result.bfi.total_clusters;
    check->has_total_clusters       = result.bfi.total_clusters != 0;
    check->allocated_clusters       = result.bfi.allocated_clusters;
    check->has_allocated_clusters   = result.bfi.allocated_clusters != 0;
    check->fragmented_clusters      = result.bfi.fragmented_clusters;
    check->has_fragmented_clusters  = result.bfi.fragmented_clusters != 0;
557 558
    check->compressed_clusters      = result.bfi.compressed_clusters;
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
559 560 561 562

    return 0;
}

563 564 565
/*
 * Checks an image for consistency. Exit codes:
 *
M
Max Reitz 已提交
566 567 568 569 570
 *  0 - Check completed, image is good
 *  1 - Check not completed because of internal errors
 *  2 - Check completed, image is corrupted
 *  3 - Check completed, image has leaked clusters, but is good otherwise
 * 63 - Checks are not supported by the image format
571
 */
572 573 574
static int img_check(int argc, char **argv)
{
    int c, ret;
575
    OutputFormat output_format = OFORMAT_HUMAN;
576
    const char *filename, *fmt, *output, *cache;
577
    BlockDriverState *bs;
578
    int fix = 0;
579
    int flags = BDRV_O_FLAGS | BDRV_O_CHECK;
580
    ImageCheck *check;
581
    bool quiet = false;
582 583

    fmt = NULL;
584
    output = NULL;
585
    cache = BDRV_DEFAULT_CACHE;
586
    for(;;) {
587 588 589 590
        int option_index = 0;
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"format", required_argument, 0, 'f'},
591
            {"repair", required_argument, 0, 'r'},
592 593 594
            {"output", required_argument, 0, OPTION_OUTPUT},
            {0, 0, 0, 0}
        };
595
        c = getopt_long(argc, argv, "hf:r:T:q",
596
                        long_options, &option_index);
597
        if (c == -1) {
598
            break;
599
        }
600
        switch(c) {
J
Jes Sorensen 已提交
601
        case '?':
602 603 604 605 606 607
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
608 609 610 611 612 613 614 615
        case 'r':
            flags |= BDRV_O_RDWR;

            if (!strcmp(optarg, "leaks")) {
                fix = BDRV_FIX_LEAKS;
            } else if (!strcmp(optarg, "all")) {
                fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
            } else {
F
Fam Zheng 已提交
616 617
                error_exit("Unknown option value for -r "
                           "(expecting 'leaks' or 'all'): %s", optarg);
618 619
            }
            break;
620 621 622
        case OPTION_OUTPUT:
            output = optarg;
            break;
623 624 625
        case 'T':
            cache = optarg;
            break;
626 627 628
        case 'q':
            quiet = true;
            break;
629 630
        }
    }
631
    if (optind != argc - 1) {
F
Fam Zheng 已提交
632
        error_exit("Expecting one image file name");
633
    }
634 635
    filename = argv[optind++];

636 637 638 639 640 641 642 643 644
    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;
    }

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

651
    bs = bdrv_new_open("image", filename, fmt, flags, true, quiet);
652 653 654
    if (!bs) {
        return 1;
    }
655 656 657

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
658 659

    if (ret == -ENOTSUP) {
660
        error_report("This image format does not support checks");
661
        ret = 63;
662
        goto fail;
663 664
    }

665 666
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
667

668 669
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
670

671
        if (output_format == OFORMAT_HUMAN) {
672 673 674 675 676 677 678
            qprintf(quiet,
                    "The following inconsistencies were found and repaired:\n\n"
                    "    %" PRId64 " leaked clusters\n"
                    "    %" PRId64 " corruptions\n\n"
                    "Double checking the fixed image now...\n",
                    check->leaks_fixed,
                    check->corruptions_fixed);
679 680
        }

681
        ret = collect_image_check(bs, check, filename, fmt, 0);
682

683 684
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
685 686
    }

687 688
    switch (output_format) {
    case OFORMAT_HUMAN:
689
        dump_human_image_check(check, quiet);
690 691
        break;
    case OFORMAT_JSON:
692
        dump_json_image_check(check, quiet);
693
        break;
694 695
    }

696 697 698
    if (ret || check->check_errors) {
        ret = 1;
        goto fail;
699
    }
700

701 702 703 704
    if (check->corruptions) {
        ret = 2;
    } else if (check->leaks) {
        ret = 3;
705
    } else {
706
        ret = 0;
707
    }
708 709 710

fail:
    qapi_free_ImageCheck(check);
F
Fam Zheng 已提交
711
    bdrv_unref(bs);
712 713

    return ret;
714 715
}

B
bellard 已提交
716 717
static int img_commit(int argc, char **argv)
{
718 719
    int c, ret, flags;
    const char *filename, *fmt, *cache;
B
bellard 已提交
720
    BlockDriverState *bs;
721
    bool quiet = false;
B
bellard 已提交
722 723

    fmt = NULL;
724
    cache = BDRV_DEFAULT_CACHE;
B
bellard 已提交
725
    for(;;) {
726
        c = getopt(argc, argv, "f:ht:q");
727
        if (c == -1) {
B
bellard 已提交
728
            break;
729
        }
B
bellard 已提交
730
        switch(c) {
J
Jes Sorensen 已提交
731
        case '?':
B
bellard 已提交
732 733 734 735 736 737
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
738 739 740
        case 't':
            cache = optarg;
            break;
741 742 743
        case 'q':
            quiet = true;
            break;
B
bellard 已提交
744 745
        }
    }
746
    if (optind != argc - 1) {
F
Fam Zheng 已提交
747
        error_exit("Expecting one image file name");
748
    }
B
bellard 已提交
749 750
    filename = argv[optind++];

751
    flags = BDRV_O_RDWR;
752
    ret = bdrv_parse_cache_flags(cache, &flags);
753 754
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
755
        return 1;
756 757
    }

758
    bs = bdrv_new_open("image", filename, fmt, flags, true, quiet);
759 760 761
    if (!bs) {
        return 1;
    }
B
bellard 已提交
762 763 764
    ret = bdrv_commit(bs);
    switch(ret) {
    case 0:
765
        qprintf(quiet, "Image committed.\n");
B
bellard 已提交
766 767
        break;
    case -ENOENT:
768
        error_report("No disk inserted");
B
bellard 已提交
769 770
        break;
    case -EACCES:
771
        error_report("Image is read-only");
B
bellard 已提交
772 773
        break;
    case -ENOTSUP:
774
        error_report("Image is already committed");
B
bellard 已提交
775 776
        break;
    default:
777
        error_report("Error while committing image");
B
bellard 已提交
778 779 780
        break;
    }

F
Fam Zheng 已提交
781
    bdrv_unref(bs);
782 783 784
    if (ret) {
        return 1;
    }
B
bellard 已提交
785 786 787
    return 0;
}

788 789 790 791 792 793 794
/*
 * 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 已提交
795 796
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
{
797 798
    bool is_zero;
    int i;
B
bellard 已提交
799 800 801 802 803

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
804
    is_zero = buffer_is_zero(buf, 512);
B
bellard 已提交
805 806
    for(i = 1; i < n; i++) {
        buf += 512;
807
        if (is_zero != buffer_is_zero(buf, 512)) {
B
bellard 已提交
808
            break;
809
        }
B
bellard 已提交
810 811
    }
    *pnum = i;
812
    return !is_zero;
B
bellard 已提交
813 814
}

815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
/*
 * 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 已提交
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
/*
 * 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;
}

888
#define IO_BUF_SIZE (2 * 1024 * 1024)
B
bellard 已提交
889

890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
static int64_t sectors_to_bytes(int64_t sectors)
{
    return sectors << BDRV_SECTOR_BITS;
}

static int64_t sectors_to_process(int64_t total, int64_t from)
{
    return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
}

/*
 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
 *
 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
 * data and negative value on error.
 *
 * @param bs:  Driver used for accessing file
 * @param sect_num: Number of first sector to check
 * @param sect_count: Number of sectors to check
 * @param filename: Name of disk file we are checking (logging purpose)
 * @param buffer: Allocated buffer for storing read data
 * @param quiet: Flag for quiet mode
 */
static int check_empty_sectors(BlockDriverState *bs, int64_t sect_num,
                               int sect_count, const char *filename,
                               uint8_t *buffer, bool quiet)
{
    int pnum, ret = 0;
    ret = bdrv_read(bs, sect_num, buffer, sect_count);
    if (ret < 0) {
        error_report("Error while reading offset %" PRId64 " of %s: %s",
                     sectors_to_bytes(sect_num), filename, strerror(-ret));
        return ret;
    }
    ret = is_allocated_sectors(buffer, sect_count, &pnum);
    if (ret || pnum != sect_count) {
        qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
                sectors_to_bytes(ret ? sect_num : sect_num + pnum));
        return 1;
    }

    return 0;
}

/*
 * Compares two images. Exit codes:
 *
 * 0 - Images are identical
 * 1 - Images differ
 * >1 - Error occurred
 */
static int img_compare(int argc, char **argv)
{
943
    const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
944 945 946 947 948 949 950
    BlockDriverState *bs1, *bs2;
    int64_t total_sectors1, total_sectors2;
    uint8_t *buf1 = NULL, *buf2 = NULL;
    int pnum1, pnum2;
    int allocated1, allocated2;
    int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
    bool progress = false, quiet = false, strict = false;
951
    int flags;
952 953 954 955 956 957
    int64_t total_sectors;
    int64_t sector_num = 0;
    int64_t nb_sectors;
    int c, pnum;
    uint64_t progress_base;

958
    cache = BDRV_DEFAULT_CACHE;
959
    for (;;) {
960
        c = getopt(argc, argv, "hf:F:T:pqs");
961 962 963 964 965 966 967 968 969 970 971 972 973 974
        if (c == -1) {
            break;
        }
        switch (c) {
        case '?':
        case 'h':
            help();
            break;
        case 'f':
            fmt1 = optarg;
            break;
        case 'F':
            fmt2 = optarg;
            break;
975 976 977
        case 'T':
            cache = optarg;
            break;
978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995
        case 'p':
            progress = true;
            break;
        case 'q':
            quiet = true;
            break;
        case 's':
            strict = true;
            break;
        }
    }

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


996
    if (optind != argc - 2) {
F
Fam Zheng 已提交
997
        error_exit("Expecting two image file names");
998 999 1000 1001
    }
    filename1 = argv[optind++];
    filename2 = argv[optind++];

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

1005 1006 1007 1008 1009 1010 1011 1012 1013
    flags = BDRV_O_FLAGS;
    ret = bdrv_parse_cache_flags(cache, &flags);
    if (ret < 0) {
        error_report("Invalid source cache option: %s", cache);
        ret = 2;
        goto out3;
    }

    bs1 = bdrv_new_open("image 1", filename1, fmt1, flags, true, quiet);
1014 1015 1016 1017 1018 1019
    if (!bs1) {
        error_report("Can't open file %s", filename1);
        ret = 2;
        goto out3;
    }

1020
    bs2 = bdrv_new_open("image 2", filename2, fmt2, flags, true, quiet);
1021 1022 1023 1024 1025 1026 1027 1028
    if (!bs2) {
        error_report("Can't open file %s", filename2);
        ret = 2;
        goto out2;
    }

    buf1 = qemu_blockalign(bs1, IO_BUF_SIZE);
    buf2 = qemu_blockalign(bs2, IO_BUF_SIZE);
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
    total_sectors1 = bdrv_nb_sectors(bs1);
    if (total_sectors1 < 0) {
        error_report("Can't get size of %s: %s",
                     filename1, strerror(-total_sectors1));
        ret = 4;
        goto out;
    }
    total_sectors2 = bdrv_nb_sectors(bs2);
    if (total_sectors2 < 0) {
        error_report("Can't get size of %s: %s",
                     filename2, strerror(-total_sectors2));
        ret = 4;
        goto out;
    }
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 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
    total_sectors = MIN(total_sectors1, total_sectors2);
    progress_base = MAX(total_sectors1, total_sectors2);

    qemu_progress_print(0, 100);

    if (strict && total_sectors1 != total_sectors2) {
        ret = 1;
        qprintf(quiet, "Strict mode: Image size mismatch!\n");
        goto out;
    }

    for (;;) {
        nb_sectors = sectors_to_process(total_sectors, sector_num);
        if (nb_sectors <= 0) {
            break;
        }
        allocated1 = bdrv_is_allocated_above(bs1, NULL, sector_num, nb_sectors,
                                             &pnum1);
        if (allocated1 < 0) {
            ret = 3;
            error_report("Sector allocation test failed for %s", filename1);
            goto out;
        }

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

        if (allocated1 == allocated2) {
            if (allocated1) {
                ret = bdrv_read(bs1, sector_num, buf1, nb_sectors);
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64 " of %s:"
                                 " %s", sectors_to_bytes(sector_num), filename1,
                                 strerror(-ret));
                    ret = 4;
                    goto out;
                }
                ret = bdrv_read(bs2, sector_num, buf2, nb_sectors);
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64
                                 " of %s: %s", sectors_to_bytes(sector_num),
                                 filename2, strerror(-ret));
                    ret = 4;
                    goto out;
                }
                ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
                if (ret || pnum != nb_sectors) {
                    qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
                            sectors_to_bytes(
                                ret ? sector_num : sector_num + pnum));
1099
                    ret = 1;
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
                    goto out;
                }
            }
        } else {
            if (strict) {
                ret = 1;
                qprintf(quiet, "Strict mode: Offset %" PRId64
                        " allocation mismatch!\n",
                        sectors_to_bytes(sector_num));
                goto out;
            }

            if (allocated1) {
                ret = check_empty_sectors(bs1, sector_num, nb_sectors,
                                          filename1, buf1, quiet);
            } else {
                ret = check_empty_sectors(bs2, sector_num, nb_sectors,
                                          filename2, buf1, quiet);
            }
            if (ret) {
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64 ": %s",
                                 sectors_to_bytes(sector_num), strerror(-ret));
1123
                    ret = 4;
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 1164 1165 1166 1167 1168 1169 1170
                }
                goto out;
            }
        }
        sector_num += nb_sectors;
        qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
    }

    if (total_sectors1 != total_sectors2) {
        BlockDriverState *bs_over;
        int64_t total_sectors_over;
        const char *filename_over;

        qprintf(quiet, "Warning: Image size mismatch!\n");
        if (total_sectors1 > total_sectors2) {
            total_sectors_over = total_sectors1;
            bs_over = bs1;
            filename_over = filename1;
        } else {
            total_sectors_over = total_sectors2;
            bs_over = bs2;
            filename_over = filename2;
        }

        for (;;) {
            nb_sectors = sectors_to_process(total_sectors_over, sector_num);
            if (nb_sectors <= 0) {
                break;
            }
            ret = bdrv_is_allocated_above(bs_over, NULL, sector_num,
                                          nb_sectors, &pnum);
            if (ret < 0) {
                ret = 3;
                error_report("Sector allocation test failed for %s",
                             filename_over);
                goto out;

            }
            nb_sectors = pnum;
            if (ret) {
                ret = check_empty_sectors(bs_over, sector_num, nb_sectors,
                                          filename_over, buf1, quiet);
                if (ret) {
                    if (ret < 0) {
                        error_report("Error while reading offset %" PRId64
                                     " of %s: %s", sectors_to_bytes(sector_num),
                                     filename_over, strerror(-ret));
1171
                        ret = 4;
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
                    }
                    goto out;
                }
            }
            sector_num += nb_sectors;
            qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
        }
    }

    qprintf(quiet, "Images are identical.\n");
    ret = 0;

out:
F
Fam Zheng 已提交
1185
    bdrv_unref(bs2);
1186 1187 1188
    qemu_vfree(buf1);
    qemu_vfree(buf2);
out2:
F
Fam Zheng 已提交
1189
    bdrv_unref(bs1);
1190 1191 1192 1193 1194
out3:
    qemu_progress_end();
    return ret;
}

B
bellard 已提交
1195 1196
static int img_convert(int argc, char **argv)
{
1197
    int c, n, n1, bs_n, bs_i, compress, cluster_sectors, skip_create;
1198
    int64_t ret = 0;
1199 1200
    int progress = 0, flags, src_flags;
    const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
1201
    BlockDriver *drv, *proto_drv;
1202
    BlockDriverState **bs = NULL, *out_bs = NULL;
1203
    int64_t total_sectors, nb_sectors, sector_num, bs_offset;
1204
    int64_t *bs_sectors = NULL;
1205
    uint8_t * buf = NULL;
1206
    size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
B
bellard 已提交
1207
    const uint8_t *buf1;
B
bellard 已提交
1208
    BlockDriverInfo bdi;
1209 1210 1211
    QemuOpts *opts = NULL;
    QemuOptsList *create_opts = NULL;
    const char *out_baseimg_param;
1212
    char *options = NULL;
E
edison 已提交
1213
    const char *snapshot_name = NULL;
1214
    int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1215
    bool quiet = false;
1216
    Error *local_err = NULL;
1217
    QemuOpts *sn_opts = NULL;
B
bellard 已提交
1218 1219 1220

    fmt = NULL;
    out_fmt = "raw";
1221
    cache = "unsafe";
1222
    src_cache = BDRV_DEFAULT_CACHE;
1223
    out_baseimg = NULL;
1224
    compress = 0;
1225
    skip_create = 0;
B
bellard 已提交
1226
    for(;;) {
1227
        c = getopt(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qn");
1228
        if (c == -1) {
B
bellard 已提交
1229
            break;
1230
        }
B
bellard 已提交
1231
        switch(c) {
J
Jes Sorensen 已提交
1232
        case '?':
B
bellard 已提交
1233 1234 1235 1236 1237 1238 1239 1240 1241
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'O':
            out_fmt = optarg;
            break;
1242 1243 1244
        case 'B':
            out_baseimg = optarg;
            break;
B
bellard 已提交
1245
        case 'c':
1246
            compress = 1;
B
bellard 已提交
1247 1248
            break;
        case 'e':
1249
            error_report("option -e is deprecated, please use \'-o "
1250
                  "encryption\' instead!");
1251
            ret = -1;
1252
            goto fail_getopt;
1253
        case '6':
1254
            error_report("option -6 is deprecated, please use \'-o "
1255
                  "compat6\' instead!");
1256
            ret = -1;
1257
            goto fail_getopt;
1258
        case 'o':
1259 1260 1261
            if (!is_valid_option_list(optarg)) {
                error_report("Invalid option list: %s", optarg);
                ret = -1;
1262
                goto fail_getopt;
1263 1264 1265 1266 1267 1268 1269 1270
            }
            if (!options) {
                options = g_strdup(optarg);
            } else {
                char *old_options = options;
                options = g_strdup_printf("%s,%s", options, optarg);
                g_free(old_options);
            }
1271
            break;
E
edison 已提交
1272 1273 1274
        case 's':
            snapshot_name = optarg;
            break;
1275 1276 1277 1278 1279 1280
        case 'l':
            if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
                sn_opts = qemu_opts_parse(&internal_snapshot_opts, optarg, 0);
                if (!sn_opts) {
                    error_report("Failed in parsing snapshot param '%s'",
                                 optarg);
1281
                    ret = -1;
1282
                    goto fail_getopt;
1283 1284 1285 1286 1287
                }
            } else {
                snapshot_name = optarg;
            }
            break;
1288 1289 1290
        case 'S':
        {
            int64_t sval;
1291 1292 1293
            char *end;
            sval = strtosz_suffix(optarg, &end, STRTOSZ_DEFSUFFIX_B);
            if (sval < 0 || *end) {
1294
                error_report("Invalid minimum zero buffer size for sparse output specified");
1295
                ret = -1;
1296
                goto fail_getopt;
1297 1298 1299 1300 1301
            }

            min_sparse = sval / BDRV_SECTOR_SIZE;
            break;
        }
1302 1303 1304
        case 'p':
            progress = 1;
            break;
1305 1306 1307
        case 't':
            cache = optarg;
            break;
1308 1309 1310
        case 'T':
            src_cache = optarg;
            break;
1311 1312 1313
        case 'q':
            quiet = true;
            break;
1314 1315 1316
        case 'n':
            skip_create = 1;
            break;
B
bellard 已提交
1317 1318
        }
    }
1319

1320
    /* Initialize before goto out */
1321 1322 1323
    if (quiet) {
        progress = 0;
    }
1324 1325
    qemu_progress_init(progress, 1.0);

1326

1327
    bs_n = argc - optind - 1;
1328
    out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
1329

1330
    if (options && has_help_option(options)) {
1331 1332 1333 1334
        ret = print_block_option_help(out_filename, out_fmt);
        goto out;
    }

1335
    if (bs_n < 1) {
F
Fam Zheng 已提交
1336
        error_exit("Must specify image file name");
1337 1338 1339
    }


1340
    if (bs_n > 1 && out_baseimg) {
1341 1342
        error_report("-B makes no sense when concatenating multiple input "
                     "images");
1343 1344
        ret = -1;
        goto out;
1345
    }
1346

1347 1348 1349 1350 1351 1352 1353
    src_flags = BDRV_O_FLAGS;
    ret = bdrv_parse_cache_flags(src_cache, &src_flags);
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
        goto out;
    }

1354 1355
    qemu_progress_print(0, 100);

1356
    bs = g_new0(BlockDriverState *, bs_n);
1357
    bs_sectors = g_new(int64_t, bs_n);
1358 1359 1360

    total_sectors = 0;
    for (bs_i = 0; bs_i < bs_n; bs_i++) {
1361 1362
        char *id = bs_n > 1 ? g_strdup_printf("source %d", bs_i)
                            : g_strdup("source");
1363
        bs[bs_i] = bdrv_new_open(id, argv[optind + bs_i], fmt, src_flags,
1364 1365
                                 true, quiet);
        g_free(id);
1366
        if (!bs[bs_i]) {
1367
            error_report("Could not open '%s'", argv[optind + bs_i]);
1368 1369 1370
            ret = -1;
            goto out;
        }
1371 1372 1373 1374 1375 1376 1377
        bs_sectors[bs_i] = bdrv_nb_sectors(bs[bs_i]);
        if (bs_sectors[bs_i] < 0) {
            error_report("Could not get size of %s: %s",
                         argv[optind + bs_i], strerror(-bs_sectors[bs_i]));
            ret = -1;
            goto out;
        }
1378
        total_sectors += bs_sectors[bs_i];
1379
    }
B
bellard 已提交
1380

1381 1382 1383 1384 1385 1386
    if (sn_opts) {
        ret = bdrv_snapshot_load_tmp(bs[0],
                                     qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
                                     qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
                                     &local_err);
    } else if (snapshot_name != NULL) {
E
edison 已提交
1387
        if (bs_n > 1) {
1388
            error_report("No support for concatenating multiple snapshot");
E
edison 已提交
1389 1390 1391
            ret = -1;
            goto out;
        }
1392 1393

        bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1394
    }
1395
    if (local_err) {
1396 1397 1398 1399 1400
        error_report("Failed to load snapshot: %s",
                     error_get_pretty(local_err));
        error_free(local_err);
        ret = -1;
        goto out;
E
edison 已提交
1401 1402
    }

1403
    /* Find driver and parse its options */
B
bellard 已提交
1404
    drv = bdrv_find_format(out_fmt);
1405
    if (!drv) {
1406
        error_report("Unknown file format '%s'", out_fmt);
1407 1408 1409
        ret = -1;
        goto out;
    }
1410

1411
    proto_drv = bdrv_find_protocol(out_filename, true);
1412
    if (!proto_drv) {
1413
        error_report("Unknown protocol '%s'", out_filename);
1414 1415 1416
        ret = -1;
        goto out;
    }
1417

C
Chunyan Liu 已提交
1418 1419
    create_opts = qemu_opts_append(create_opts, drv->create_opts);
    create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
1420

1421 1422 1423 1424 1425
    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
    if (options && qemu_opts_do_parse(opts, options, NULL)) {
        error_report("Invalid options for file format '%s'", out_fmt);
        ret = -1;
        goto out;
1426 1427
    }

1428 1429
    qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512);
    ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
1430 1431 1432
    if (ret < 0) {
        goto out;
    }
1433

1434
    /* Get backing file name if -o backing_file was used */
1435
    out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
1436
    if (out_baseimg_param) {
1437
        out_baseimg = out_baseimg_param;
1438 1439
    }

1440
    /* Check if compression is supported */
1441
    if (compress) {
1442 1443 1444 1445
        bool encryption =
            qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
        const char *preallocation =
            qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
1446 1447

        if (!drv->bdrv_write_compressed) {
1448
            error_report("Compression not supported for this file format");
1449 1450
            ret = -1;
            goto out;
1451 1452
        }

1453
        if (encryption) {
1454 1455
            error_report("Compression and encryption not supported at "
                         "the same time");
1456 1457
            ret = -1;
            goto out;
1458
        }
1459

1460 1461
        if (preallocation
            && strcmp(preallocation, "off"))
1462 1463 1464 1465 1466 1467
        {
            error_report("Compression and preallocation not supported at "
                         "the same time");
            ret = -1;
            goto out;
        }
1468 1469
    }

1470 1471
    if (!skip_create) {
        /* Create the new image */
C
Chunyan Liu 已提交
1472
        ret = bdrv_create(drv, out_filename, opts, &local_err);
1473
        if (ret < 0) {
1474 1475 1476
            error_report("%s: error while converting %s: %s",
                         out_filename, out_fmt, error_get_pretty(local_err));
            error_free(local_err);
1477
            goto out;
B
bellard 已提交
1478 1479
        }
    }
1480

1481
    flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
1482
    ret = bdrv_parse_cache_flags(cache, &flags);
1483 1484
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
1485
        goto out;
1486 1487
    }

1488
    out_bs = bdrv_new_open("target", out_filename, out_fmt, flags, true, quiet);
1489 1490 1491 1492
    if (!out_bs) {
        ret = -1;
        goto out;
    }
B
bellard 已提交
1493

1494 1495
    bs_i = 0;
    bs_offset = 0;
1496 1497 1498 1499 1500 1501 1502 1503 1504 1505

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

    buf = qemu_blockalign(out_bs, bufsectors * BDRV_SECTOR_SIZE);
1506

1507
    if (skip_create) {
1508 1509
        int64_t output_sectors = bdrv_nb_sectors(out_bs);
        if (output_sectors < 0) {
1510
            error_report("unable to get output image length: %s\n",
1511
                         strerror(-output_sectors));
1512 1513
            ret = -1;
            goto out;
1514
        } else if (output_sectors < total_sectors) {
1515 1516 1517 1518 1519 1520
            error_report("output file is smaller than input file");
            ret = -1;
            goto out;
        }
    }

1521 1522 1523 1524
    cluster_sectors = 0;
    ret = bdrv_get_info(out_bs, &bdi);
    if (ret < 0) {
        if (compress) {
1525
            error_report("could not get block driver info");
1526 1527
            goto out;
        }
1528
    } else {
1529
        compress = compress || bdi.needs_compressed_writes;
1530 1531 1532 1533 1534
        cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
    }

    if (compress) {
        if (cluster_sectors <= 0 || cluster_sectors > bufsectors) {
1535
            error_report("invalid cluster size");
1536 1537 1538
            ret = -1;
            goto out;
        }
B
bellard 已提交
1539
        sector_num = 0;
1540 1541 1542

        nb_sectors = total_sectors;

B
bellard 已提交
1543
        for(;;) {
1544 1545 1546 1547
            int64_t bs_num;
            int remainder;
            uint8_t *buf2;

B
bellard 已提交
1548 1549 1550 1551 1552 1553 1554
            nb_sectors = total_sectors - sector_num;
            if (nb_sectors <= 0)
                break;
            if (nb_sectors >= cluster_sectors)
                n = cluster_sectors;
            else
                n = nb_sectors;
1555 1556 1557 1558 1559 1560 1561

            bs_num = sector_num - bs_offset;
            assert (bs_num >= 0);
            remainder = n;
            buf2 = buf;
            while (remainder > 0) {
                int nlow;
1562 1563
                while (bs_num == bs_sectors[bs_i]) {
                    bs_offset += bs_sectors[bs_i];
1564 1565 1566
                    bs_i++;
                    assert (bs_i < bs_n);
                    bs_num = 0;
B
Blue Swirl 已提交
1567 1568
                    /* printf("changing part: sector_num=%" PRId64 ", "
                       "bs_i=%d, bs_offset=%" PRId64 ", bs_sectors=%" PRId64
1569
                       "\n", sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1570
                }
1571
                assert (bs_num < bs_sectors[bs_i]);
1572

1573 1574
                nlow = remainder > bs_sectors[bs_i] - bs_num
                    ? bs_sectors[bs_i] - bs_num : remainder;
1575

1576 1577
                ret = bdrv_read(bs[bs_i], bs_num, buf2, nlow);
                if (ret < 0) {
1578 1579
                    error_report("error while reading sector %" PRId64 ": %s",
                                 bs_num, strerror(-ret));
1580 1581
                    goto out;
                }
1582 1583 1584 1585 1586 1587 1588 1589

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

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

1590 1591
            if (!buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)) {
                ret = bdrv_write_compressed(out_bs, sector_num, buf, n);
1592
                if (ret != 0) {
1593 1594
                    error_report("error while compressing sector %" PRId64
                                 ": %s", sector_num, strerror(-ret));
1595 1596
                    goto out;
                }
B
bellard 已提交
1597 1598
            }
            sector_num += n;
1599
            qemu_progress_print(100.0 * sector_num / total_sectors, 0);
B
bellard 已提交
1600
        }
B
bellard 已提交
1601 1602
        /* signal EOF to align */
        bdrv_write_compressed(out_bs, 0, NULL, 0);
B
bellard 已提交
1603
    } else {
1604 1605
        int64_t sectors_to_read, sectors_read, sector_num_next_status;
        bool count_allocated_sectors;
1606
        int has_zero_init = min_sparse ? bdrv_has_zero_init(out_bs) : 0;
K
Kevin Wolf 已提交
1607

1608 1609 1610 1611 1612 1613 1614 1615
        if (!has_zero_init && bdrv_can_write_zeroes_with_unmap(out_bs)) {
            ret = bdrv_make_zero(out_bs, BDRV_REQ_MAY_UNMAP);
            if (ret < 0) {
                goto out;
            }
            has_zero_init = 1;
        }

1616 1617 1618
        sectors_to_read = total_sectors;
        count_allocated_sectors = progress && (out_baseimg || has_zero_init);
restart:
1619
        sector_num = 0; // total number of sectors converted so far
1620 1621
        sectors_read = 0;
        sector_num_next_status = 0;
1622

B
bellard 已提交
1623 1624
        for(;;) {
            nb_sectors = total_sectors - sector_num;
1625
            if (nb_sectors <= 0) {
1626 1627 1628 1629 1630
                if (count_allocated_sectors) {
                    sectors_to_read = sectors_read;
                    count_allocated_sectors = false;
                    goto restart;
                }
1631
                ret = 0;
B
bellard 已提交
1632
                break;
1633
            }
1634

1635 1636
            while (sector_num - bs_offset >= bs_sectors[bs_i]) {
                bs_offset += bs_sectors[bs_i];
1637 1638
                bs_i ++;
                assert (bs_i < bs_n);
B
Blue Swirl 已提交
1639 1640
                /* printf("changing part: sector_num=%" PRId64 ", bs_i=%d, "
                  "bs_offset=%" PRId64 ", bs_sectors=%" PRId64 "\n",
1641
                   sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1642 1643
            }

1644 1645 1646 1647 1648
            if ((out_baseimg || has_zero_init) &&
                sector_num >= sector_num_next_status) {
                n = nb_sectors > INT_MAX ? INT_MAX : nb_sectors;
                ret = bdrv_get_block_status(bs[bs_i], sector_num - bs_offset,
                                            n, &n1);
1649
                if (ret < 0) {
1650 1651 1652
                    error_report("error while reading block status of sector %"
                                 PRId64 ": %s", sector_num - bs_offset,
                                 strerror(-ret));
1653 1654
                    goto out;
                }
1655 1656 1657 1658
                /* If the output image is zero initialized, we are not working
                 * on a shared base and the input is zero we can skip the next
                 * n1 sectors */
                if (has_zero_init && !out_baseimg && (ret & BDRV_BLOCK_ZERO)) {
1659 1660
                    sector_num += n1;
                    continue;
1661
                }
1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677
                /* If the output image is being created as a copy on write
                 * image, assume that sectors which are unallocated in the
                 * input image are present in both the output's and input's
                 * base images (no need to copy them). */
                if (out_baseimg) {
                    if (!(ret & BDRV_BLOCK_DATA)) {
                        sector_num += n1;
                        continue;
                    }
                    /* The next 'n1' sectors are allocated in the input image.
                     * Copy only those as they may be followed by unallocated
                     * sectors. */
                    nb_sectors = n1;
                }
                /* avoid redundant callouts to get_block_status */
                sector_num_next_status = sector_num + n1;
1678 1679
            }

1680
            n = MIN(nb_sectors, bufsectors);
1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693

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

1694
            n = MIN(n, bs_sectors[bs_i] - (sector_num - bs_offset));
1695

1696 1697 1698 1699 1700 1701 1702
            sectors_read += n;
            if (count_allocated_sectors) {
                sector_num += n;
                continue;
            }

            n1 = n;
1703 1704
            ret = bdrv_read(bs[bs_i], sector_num - bs_offset, buf, n);
            if (ret < 0) {
1705 1706
                error_report("error while reading sector %" PRId64 ": %s",
                             sector_num - bs_offset, strerror(-ret));
1707 1708
                goto out;
            }
B
bellard 已提交
1709 1710 1711 1712 1713
            /* 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) {
1714
                if (!has_zero_init ||
1715
                    is_allocated_sectors_min(buf1, n, &n1, min_sparse)) {
1716 1717
                    ret = bdrv_write(out_bs, sector_num, buf1, n1);
                    if (ret < 0) {
1718 1719
                        error_report("error while writing sector %" PRId64
                                     ": %s", sector_num, strerror(-ret));
1720 1721
                        goto out;
                    }
B
bellard 已提交
1722 1723 1724 1725 1726
                }
                sector_num += n1;
                n -= n1;
                buf1 += n1 * 512;
            }
1727
            qemu_progress_print(100.0 * sectors_read / sectors_to_read, 0);
B
bellard 已提交
1728 1729
        }
    }
1730
out:
1731 1732 1733
    if (!ret) {
        qemu_progress_print(100, 0);
    }
1734
    qemu_progress_end();
1735 1736
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
K
Kevin Wolf 已提交
1737
    qemu_vfree(buf);
1738 1739 1740
    if (sn_opts) {
        qemu_opts_del(sn_opts);
    }
1741
    if (out_bs) {
F
Fam Zheng 已提交
1742
        bdrv_unref(out_bs);
1743
    }
1744 1745 1746
    if (bs) {
        for (bs_i = 0; bs_i < bs_n; bs_i++) {
            if (bs[bs_i]) {
F
Fam Zheng 已提交
1747
                bdrv_unref(bs[bs_i]);
1748
            }
1749
        }
1750
        g_free(bs);
1751
    }
1752
    g_free(bs_sectors);
1753 1754 1755
fail_getopt:
    g_free(options);

1756 1757 1758
    if (ret) {
        return 1;
    }
B
bellard 已提交
1759 1760 1761
    return 0;
}

B
bellard 已提交
1762

B
bellard 已提交
1763 1764 1765 1766 1767 1768 1769 1770 1771
static void dump_snapshots(BlockDriverState *bs)
{
    QEMUSnapshotInfo *sn_tab, *sn;
    int nb_sns, i;

    nb_sns = bdrv_snapshot_list(bs, &sn_tab);
    if (nb_sns <= 0)
        return;
    printf("Snapshot list:\n");
1772 1773
    bdrv_snapshot_dump(fprintf, stdout, NULL);
    printf("\n");
B
bellard 已提交
1774 1775
    for(i = 0; i < nb_sns; i++) {
        sn = &sn_tab[i];
1776 1777
        bdrv_snapshot_dump(fprintf, stdout, sn);
        printf("\n");
B
bellard 已提交
1778
    }
1779
    g_free(sn_tab);
B
bellard 已提交
1780 1781
}

1782 1783
static void dump_json_image_info_list(ImageInfoList *list)
{
1784
    Error *local_err = NULL;
1785 1786 1787 1788
    QString *str;
    QmpOutputVisitor *ov = qmp_output_visitor_new();
    QObject *obj;
    visit_type_ImageInfoList(qmp_output_get_visitor(ov),
1789
                             &list, NULL, &local_err);
1790 1791 1792 1793 1794 1795 1796 1797 1798
    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);
}

1799 1800
static void dump_json_image_info(ImageInfo *info)
{
1801
    Error *local_err = NULL;
1802 1803 1804 1805
    QString *str;
    QmpOutputVisitor *ov = qmp_output_visitor_new();
    QObject *obj;
    visit_type_ImageInfo(qmp_output_get_visitor(ov),
1806
                         &info, NULL, &local_err);
1807 1808 1809 1810 1811 1812 1813 1814 1815
    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);
}

1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826
static void dump_human_image_info_list(ImageInfoList *list)
{
    ImageInfoList *elem;
    bool delim = false;

    for (elem = list; elem; elem = elem->next) {
        if (delim) {
            printf("\n");
        }
        delim = true;

1827
        bdrv_image_info_dump(fprintf, stdout, elem->value);
1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854
    }
}

static gboolean str_equal_func(gconstpointer a, gconstpointer b)
{
    return strcmp(a, b) == 0;
}

/**
 * Open an image file chain and return an ImageInfoList
 *
 * @filename: topmost image filename
 * @fmt: topmost image format (may be NULL to autodetect)
 * @chain: true  - enumerate entire backing file chain
 *         false - only topmost image file
 *
 * Returns a list of ImageInfo objects or NULL if there was an error opening an
 * image file.  If there was an error a message will have been printed to
 * stderr.
 */
static ImageInfoList *collect_image_info_list(const char *filename,
                                              const char *fmt,
                                              bool chain)
{
    ImageInfoList *head = NULL;
    ImageInfoList **last = &head;
    GHashTable *filenames;
1855
    Error *err = NULL;
1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870

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

    while (filename) {
        BlockDriverState *bs;
        ImageInfo *info;
        ImageInfoList *elem;

        if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
            error_report("Backing file '%s' creates an infinite loop.",
                         filename);
            goto err;
        }
        g_hash_table_insert(filenames, (gpointer)filename, NULL);

1871 1872
        bs = bdrv_new_open("image", filename, fmt,
                           BDRV_O_FLAGS | BDRV_O_NO_BACKING, false, false);
1873 1874 1875 1876
        if (!bs) {
            goto err;
        }

1877
        bdrv_query_image_info(bs, &info, &err);
1878
        if (err) {
1879 1880
            error_report("%s", error_get_pretty(err));
            error_free(err);
1881
            bdrv_unref(bs);
1882
            goto err;
1883
        }
1884 1885 1886 1887 1888 1889

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

F
Fam Zheng 已提交
1890
        bdrv_unref(bs);
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912

        filename = fmt = NULL;
        if (chain) {
            if (info->has_full_backing_filename) {
                filename = info->full_backing_filename;
            } else if (info->has_backing_filename) {
                filename = info->backing_filename;
            }
            if (info->has_backing_filename_format) {
                fmt = info->backing_filename_format;
            }
        }
    }
    g_hash_table_destroy(filenames);
    return head;

err:
    qapi_free_ImageInfoList(head);
    g_hash_table_destroy(filenames);
    return NULL;
}

1913 1914 1915 1916
static int img_info(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
1917
    bool chain = false;
1918
    const char *filename, *fmt, *output;
1919
    ImageInfoList *list;
1920

B
bellard 已提交
1921
    fmt = NULL;
1922
    output = NULL;
B
bellard 已提交
1923
    for(;;) {
1924 1925 1926 1927 1928
        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},
1929
            {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
1930 1931 1932 1933
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "f:h",
                        long_options, &option_index);
1934
        if (c == -1) {
B
bellard 已提交
1935
            break;
1936
        }
B
bellard 已提交
1937
        switch(c) {
J
Jes Sorensen 已提交
1938
        case '?':
B
bellard 已提交
1939 1940 1941 1942 1943 1944
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
1945 1946 1947
        case OPTION_OUTPUT:
            output = optarg;
            break;
1948 1949 1950
        case OPTION_BACKING_CHAIN:
            chain = true;
            break;
B
bellard 已提交
1951 1952
        }
    }
1953
    if (optind != argc - 1) {
F
Fam Zheng 已提交
1954
        error_exit("Expecting one image file name");
1955
    }
B
bellard 已提交
1956 1957
    filename = argv[optind++];

1958 1959 1960 1961 1962 1963
    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.");
1964 1965
        return 1;
    }
1966

1967 1968
    list = collect_image_info_list(filename, fmt, chain);
    if (!list) {
1969
        return 1;
B
bellard 已提交
1970
    }
1971 1972 1973

    switch (output_format) {
    case OFORMAT_HUMAN:
1974
        dump_human_image_info_list(list);
1975 1976
        break;
    case OFORMAT_JSON:
1977 1978 1979 1980 1981
        if (chain) {
            dump_json_image_info_list(list);
        } else {
            dump_json_image_info(list->value);
        }
1982
        break;
B
bellard 已提交
1983
    }
1984

1985
    qapi_free_ImageInfoList(list);
B
bellard 已提交
1986 1987 1988
    return 0;
}

P
Paolo Bonzini 已提交
1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029

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

static void dump_map_entry(OutputFormat output_format, MapEntry *e,
                           MapEntry *next)
{
    switch (output_format) {
    case OFORMAT_HUMAN:
        if ((e->flags & BDRV_BLOCK_DATA) &&
            !(e->flags & BDRV_BLOCK_OFFSET_VALID)) {
            error_report("File contains external, encrypted or compressed clusters.");
            exit(1);
        }
        if ((e->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) == BDRV_BLOCK_DATA) {
            printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
                   e->start, e->length, e->offset, e->bs->filename);
        }
        /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
         * Modify the flags here to allow more coalescing.
         */
        if (next &&
            (next->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) != BDRV_BLOCK_DATA) {
            next->flags &= ~BDRV_BLOCK_DATA;
            next->flags |= BDRV_BLOCK_ZERO;
        }
        break;
    case OFORMAT_JSON:
        printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64", \"depth\": %d,"
               " \"zero\": %s, \"data\": %s",
               (e->start == 0 ? "[" : ",\n"),
               e->start, e->length, e->depth,
               (e->flags & BDRV_BLOCK_ZERO) ? "true" : "false",
               (e->flags & BDRV_BLOCK_DATA) ? "true" : "false");
        if (e->flags & BDRV_BLOCK_OFFSET_VALID) {
P
Paolo Bonzini 已提交
2030
            printf(", \"offset\": %"PRId64"", e->offset);
P
Paolo Bonzini 已提交
2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117
        }
        putchar('}');

        if (!next) {
            printf("]\n");
        }
        break;
    }
}

static int get_block_status(BlockDriverState *bs, int64_t sector_num,
                            int nb_sectors, MapEntry *e)
{
    int64_t ret;
    int depth;

    /* As an optimization, we could cache the current range of unallocated
     * clusters in each file of the chain, and avoid querying the same
     * range repeatedly.
     */

    depth = 0;
    for (;;) {
        ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors);
        if (ret < 0) {
            return ret;
        }
        assert(nb_sectors);
        if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
            break;
        }
        bs = bs->backing_hd;
        if (bs == NULL) {
            ret = 0;
            break;
        }

        depth++;
    }

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

static int img_map(int argc, char **argv)
{
    int c;
    OutputFormat output_format = OFORMAT_HUMAN;
    BlockDriverState *bs;
    const char *filename, *fmt, *output;
    int64_t length;
    MapEntry curr = { .length = 0 }, next;
    int ret = 0;

    fmt = NULL;
    output = NULL;
    for (;;) {
        int option_index = 0;
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"format", required_argument, 0, 'f'},
            {"output", required_argument, 0, OPTION_OUTPUT},
            {0, 0, 0, 0}
        };
        c = getopt_long(argc, argv, "f:h",
                        long_options, &option_index);
        if (c == -1) {
            break;
        }
        switch (c) {
        case '?':
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case OPTION_OUTPUT:
            output = optarg;
            break;
        }
    }
F
Fam Zheng 已提交
2118 2119
    if (optind != argc - 1) {
        error_exit("Expecting one image file name");
P
Paolo Bonzini 已提交
2120
    }
F
Fam Zheng 已提交
2121
    filename = argv[optind];
P
Paolo Bonzini 已提交
2122 2123 2124 2125 2126 2127 2128 2129 2130 2131

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

2132
    bs = bdrv_new_open("image", filename, fmt, BDRV_O_FLAGS, true, false);
P
Paolo Bonzini 已提交
2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179
    if (!bs) {
        return 1;
    }

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

    length = bdrv_getlength(bs);
    while (curr.start + curr.length < length) {
        int64_t nsectors_left;
        int64_t sector_num;
        int n;

        sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;

        /* Probe up to 1 GiB at a time.  */
        nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
        n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
        ret = get_block_status(bs, sector_num, n, &next);

        if (ret < 0) {
            error_report("Could not read file metadata: %s", strerror(-ret));
            goto out;
        }

        if (curr.length != 0 && curr.flags == next.flags &&
            curr.depth == next.depth &&
            ((curr.flags & BDRV_BLOCK_OFFSET_VALID) == 0 ||
             curr.offset + curr.length == next.offset)) {
            curr.length += next.length;
            continue;
        }

        if (curr.length > 0) {
            dump_map_entry(output_format, &curr, &next);
        }
        curr = next;
    }

    dump_map_entry(output_format, &curr, NULL);

out:
    bdrv_unref(bs);
    return ret < 0;
}

2180 2181 2182 2183 2184
#define SNAPSHOT_LIST   1
#define SNAPSHOT_CREATE 2
#define SNAPSHOT_APPLY  3
#define SNAPSHOT_DELETE 4

2185
static int img_snapshot(int argc, char **argv)
2186 2187 2188 2189
{
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
    char *filename, *snapshot_name = NULL;
2190
    int c, ret = 0, bdrv_oflags;
2191 2192
    int action = 0;
    qemu_timeval tv;
2193
    bool quiet = false;
2194
    Error *err = NULL;
2195

2196
    bdrv_oflags = BDRV_O_FLAGS | BDRV_O_RDWR;
2197 2198
    /* Parse commandline parameters */
    for(;;) {
2199
        c = getopt(argc, argv, "la:c:d:hq");
2200
        if (c == -1) {
2201
            break;
2202
        }
2203
        switch(c) {
J
Jes Sorensen 已提交
2204
        case '?':
2205 2206
        case 'h':
            help();
2207
            return 0;
2208 2209
        case 'l':
            if (action) {
F
Fam Zheng 已提交
2210
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2211
                return 0;
2212 2213
            }
            action = SNAPSHOT_LIST;
2214
            bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2215 2216 2217
            break;
        case 'a':
            if (action) {
F
Fam Zheng 已提交
2218
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2219
                return 0;
2220 2221 2222 2223 2224 2225
            }
            action = SNAPSHOT_APPLY;
            snapshot_name = optarg;
            break;
        case 'c':
            if (action) {
F
Fam Zheng 已提交
2226
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2227
                return 0;
2228 2229 2230 2231 2232 2233
            }
            action = SNAPSHOT_CREATE;
            snapshot_name = optarg;
            break;
        case 'd':
            if (action) {
F
Fam Zheng 已提交
2234
                error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2235
                return 0;
2236 2237 2238 2239
            }
            action = SNAPSHOT_DELETE;
            snapshot_name = optarg;
            break;
2240 2241 2242
        case 'q':
            quiet = true;
            break;
2243 2244 2245
        }
    }

2246
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2247
        error_exit("Expecting one image file name");
2248
    }
2249 2250 2251
    filename = argv[optind++];

    /* Open the image */
2252
    bs = bdrv_new_open("image", filename, NULL, bdrv_oflags, true, quiet);
2253 2254 2255
    if (!bs) {
        return 1;
    }
2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271

    /* 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);
2272
        if (ret) {
2273
            error_report("Could not create snapshot '%s': %d (%s)",
2274
                snapshot_name, ret, strerror(-ret));
2275
        }
2276 2277 2278 2279
        break;

    case SNAPSHOT_APPLY:
        ret = bdrv_snapshot_goto(bs, snapshot_name);
2280
        if (ret) {
2281
            error_report("Could not apply snapshot '%s': %d (%s)",
2282
                snapshot_name, ret, strerror(-ret));
2283
        }
2284 2285 2286
        break;

    case SNAPSHOT_DELETE:
2287
        bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2288
        if (err) {
2289 2290 2291 2292
            error_report("Could not delete snapshot '%s': (%s)",
                         snapshot_name, error_get_pretty(err));
            error_free(err);
            ret = 1;
2293
        }
2294 2295 2296 2297
        break;
    }

    /* Cleanup */
F
Fam Zheng 已提交
2298
    bdrv_unref(bs);
2299 2300 2301
    if (ret) {
        return 1;
    }
2302
    return 0;
2303 2304
}

K
Kevin Wolf 已提交
2305 2306
static int img_rebase(int argc, char **argv)
{
2307
    BlockDriverState *bs = NULL, *bs_old_backing = NULL, *bs_new_backing = NULL;
2308
    BlockDriver *old_backing_drv, *new_backing_drv;
K
Kevin Wolf 已提交
2309
    char *filename;
2310 2311
    const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
    int c, flags, src_flags, ret;
K
Kevin Wolf 已提交
2312
    int unsafe = 0;
2313
    int progress = 0;
2314
    bool quiet = false;
2315
    Error *local_err = NULL;
K
Kevin Wolf 已提交
2316 2317

    /* Parse commandline parameters */
K
Kevin Wolf 已提交
2318
    fmt = NULL;
2319
    cache = BDRV_DEFAULT_CACHE;
2320
    src_cache = BDRV_DEFAULT_CACHE;
K
Kevin Wolf 已提交
2321 2322 2323
    out_baseimg = NULL;
    out_basefmt = NULL;
    for(;;) {
2324
        c = getopt(argc, argv, "hf:F:b:upt:T:q");
2325
        if (c == -1) {
K
Kevin Wolf 已提交
2326
            break;
2327
        }
K
Kevin Wolf 已提交
2328
        switch(c) {
J
Jes Sorensen 已提交
2329
        case '?':
K
Kevin Wolf 已提交
2330 2331 2332
        case 'h':
            help();
            return 0;
K
Kevin Wolf 已提交
2333 2334 2335
        case 'f':
            fmt = optarg;
            break;
K
Kevin Wolf 已提交
2336 2337 2338 2339 2340 2341 2342 2343 2344
        case 'F':
            out_basefmt = optarg;
            break;
        case 'b':
            out_baseimg = optarg;
            break;
        case 'u':
            unsafe = 1;
            break;
2345 2346 2347
        case 'p':
            progress = 1;
            break;
2348 2349 2350
        case 't':
            cache = optarg;
            break;
2351 2352 2353
        case 'T':
            src_cache = optarg;
            break;
2354 2355 2356
        case 'q':
            quiet = true;
            break;
K
Kevin Wolf 已提交
2357 2358 2359
        }
    }

2360 2361 2362 2363
    if (quiet) {
        progress = 0;
    }

F
Fam Zheng 已提交
2364 2365 2366 2367 2368
    if (optind != argc - 1) {
        error_exit("Expecting one image file name");
    }
    if (!unsafe && !out_baseimg) {
        error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2369
    }
K
Kevin Wolf 已提交
2370 2371
    filename = argv[optind++];

2372 2373 2374
    qemu_progress_init(progress, 2.0);
    qemu_progress_print(0, 100);

2375
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2376
    ret = bdrv_parse_cache_flags(cache, &flags);
2377 2378
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
2379
        goto out;
2380 2381
    }

2382 2383 2384 2385
    src_flags = BDRV_O_FLAGS;
    ret = bdrv_parse_cache_flags(src_cache, &src_flags);
    if (ret < 0) {
        error_report("Invalid source cache option: %s", src_cache);
2386
        goto out;
2387 2388
    }

K
Kevin Wolf 已提交
2389 2390 2391 2392 2393 2394
    /*
     * 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.
     */
2395
    bs = bdrv_new_open("image", filename, fmt, flags, true, quiet);
2396
    if (!bs) {
2397 2398
        ret = -1;
        goto out;
2399
    }
K
Kevin Wolf 已提交
2400 2401 2402 2403 2404 2405 2406 2407

    /* 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) {
2408
            error_report("Invalid format name: '%s'", bs->backing_format);
2409 2410
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
2411 2412 2413 2414 2415 2416
        }
    }

    if (out_basefmt != NULL) {
        new_backing_drv = bdrv_find_format(out_basefmt);
        if (new_backing_drv == NULL) {
2417
            error_report("Invalid format name: '%s'", out_basefmt);
2418 2419
            ret = -1;
            goto out;
K
Kevin Wolf 已提交
2420 2421 2422 2423
        }
    }

    /* For safe rebasing we need to compare old and new backing file */
2424
    if (!unsafe) {
K
Kevin Wolf 已提交
2425 2426
        char backing_name[1024];

K
Kevin Wolf 已提交
2427
        bs_old_backing = bdrv_new("old_backing", &error_abort);
K
Kevin Wolf 已提交
2428
        bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2429
        ret = bdrv_open(&bs_old_backing, backing_name, NULL, NULL, src_flags,
2430
                        old_backing_drv, &local_err);
2431
        if (ret) {
2432 2433 2434
            error_report("Could not open old backing file '%s': %s",
                         backing_name, error_get_pretty(local_err));
            error_free(local_err);
2435
            goto out;
K
Kevin Wolf 已提交
2436
        }
2437
        if (out_baseimg[0]) {
K
Kevin Wolf 已提交
2438
            bs_new_backing = bdrv_new("new_backing", &error_abort);
2439 2440
            ret = bdrv_open(&bs_new_backing, out_baseimg, NULL, NULL, src_flags,
                            new_backing_drv, &local_err);
2441
            if (ret) {
2442 2443 2444
                error_report("Could not open new backing file '%s': %s",
                             out_baseimg, error_get_pretty(local_err));
                error_free(local_err);
2445 2446
                goto out;
            }
K
Kevin Wolf 已提交
2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459
        }
    }

    /*
     * 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) {
2460 2461 2462
        int64_t num_sectors;
        int64_t old_backing_num_sectors;
        int64_t new_backing_num_sectors = 0;
K
Kevin Wolf 已提交
2463
        uint64_t sector;
2464
        int n;
2465 2466
        uint8_t * buf_old;
        uint8_t * buf_new;
2467
        float local_progress = 0;
2468

K
Kevin Wolf 已提交
2469 2470
        buf_old = qemu_blockalign(bs, IO_BUF_SIZE);
        buf_new = qemu_blockalign(bs, IO_BUF_SIZE);
K
Kevin Wolf 已提交
2471

2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488
        num_sectors = bdrv_nb_sectors(bs);
        if (num_sectors < 0) {
            error_report("Could not get size of '%s': %s",
                         filename, strerror(-num_sectors));
            ret = -1;
            goto out;
        }
        old_backing_num_sectors = bdrv_nb_sectors(bs_old_backing);
        if (old_backing_num_sectors < 0) {
            char backing_name[1024];

            bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
            error_report("Could not get size of '%s': %s",
                         backing_name, strerror(-old_backing_num_sectors));
            ret = -1;
            goto out;
        }
2489
        if (bs_new_backing) {
2490 2491 2492 2493 2494 2495 2496
            new_backing_num_sectors = bdrv_nb_sectors(bs_new_backing);
            if (new_backing_num_sectors < 0) {
                error_report("Could not get size of '%s': %s",
                             out_baseimg, strerror(-new_backing_num_sectors));
                ret = -1;
                goto out;
            }
2497
        }
K
Kevin Wolf 已提交
2498

2499 2500 2501 2502 2503
        if (num_sectors != 0) {
            local_progress = (float)100 /
                (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
        }

K
Kevin Wolf 已提交
2504 2505 2506 2507 2508 2509 2510 2511 2512 2513
        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 */
2514
            ret = bdrv_is_allocated(bs, sector, n, &n);
2515 2516 2517 2518 2519
            if (ret < 0) {
                error_report("error while reading image metadata: %s",
                             strerror(-ret));
                goto out;
            }
2520
            if (ret) {
K
Kevin Wolf 已提交
2521 2522 2523
                continue;
            }

2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539
            /*
             * 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 已提交
2540
            }
2541

2542
            if (sector >= new_backing_num_sectors || !bs_new_backing) {
2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553
                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 已提交
2554 2555 2556 2557 2558 2559 2560 2561 2562
            }

            /* 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,
2563
                    buf_new + written * 512, n - written, &pnum))
K
Kevin Wolf 已提交
2564 2565 2566 2567
                {
                    ret = bdrv_write(bs, sector + written,
                        buf_old + written * 512, pnum);
                    if (ret < 0) {
2568
                        error_report("Error while writing to COW image: %s",
K
Kevin Wolf 已提交
2569
                            strerror(-ret));
2570
                        goto out;
K
Kevin Wolf 已提交
2571 2572 2573 2574 2575
                    }
                }

                written += pnum;
            }
2576
            qemu_progress_print(local_progress, 100);
K
Kevin Wolf 已提交
2577
        }
2578

K
Kevin Wolf 已提交
2579 2580
        qemu_vfree(buf_old);
        qemu_vfree(buf_new);
K
Kevin Wolf 已提交
2581 2582 2583 2584 2585 2586 2587
    }

    /*
     * 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.
     */
2588 2589 2590 2591 2592 2593
    if (out_baseimg && *out_baseimg) {
        ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
    } else {
        ret = bdrv_change_backing_file(bs, NULL, NULL);
    }

K
Kevin Wolf 已提交
2594
    if (ret == -ENOSPC) {
2595 2596
        error_report("Could not change the backing file to '%s': No "
                     "space left in the file header", out_baseimg);
K
Kevin Wolf 已提交
2597
    } else if (ret < 0) {
2598
        error_report("Could not change the backing file to '%s': %s",
K
Kevin Wolf 已提交
2599 2600 2601
            out_baseimg, strerror(-ret));
    }

2602
    qemu_progress_print(100, 0);
K
Kevin Wolf 已提交
2603 2604 2605 2606 2607 2608
    /*
     * 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.
     */
2609
out:
2610
    qemu_progress_end();
K
Kevin Wolf 已提交
2611 2612
    /* Cleanup */
    if (!unsafe) {
2613
        if (bs_old_backing != NULL) {
F
Fam Zheng 已提交
2614
            bdrv_unref(bs_old_backing);
2615 2616
        }
        if (bs_new_backing != NULL) {
F
Fam Zheng 已提交
2617
            bdrv_unref(bs_new_backing);
2618
        }
K
Kevin Wolf 已提交
2619 2620
    }

F
Fam Zheng 已提交
2621
    bdrv_unref(bs);
2622 2623 2624
    if (ret) {
        return 1;
    }
K
Kevin Wolf 已提交
2625 2626 2627
    return 0;
}

2628 2629 2630 2631 2632
static int img_resize(int argc, char **argv)
{
    int c, ret, relative;
    const char *filename, *fmt, *size;
    int64_t n, total_size;
2633
    bool quiet = false;
2634
    BlockDriverState *bs = NULL;
2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646
    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 */
            }
2647 2648 2649
        },
    };

K
Kevin Wolf 已提交
2650 2651 2652
    /* Remove size from argv manually so that negative numbers are not treated
     * as options by getopt. */
    if (argc < 3) {
F
Fam Zheng 已提交
2653
        error_exit("Not enough arguments");
K
Kevin Wolf 已提交
2654 2655 2656 2657 2658 2659
        return 1;
    }

    size = argv[--argc];

    /* Parse getopt arguments */
2660 2661
    fmt = NULL;
    for(;;) {
2662
        c = getopt(argc, argv, "f:hq");
2663 2664 2665 2666
        if (c == -1) {
            break;
        }
        switch(c) {
J
Jes Sorensen 已提交
2667
        case '?':
2668 2669 2670 2671 2672 2673
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
2674 2675 2676
        case 'q':
            quiet = true;
            break;
2677 2678
        }
    }
2679
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2680
        error_exit("Expecting one image file name");
2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699
    }
    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 */
2700
    param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
2701
    if (qemu_opt_set(param, BLOCK_OPT_SIZE, size)) {
2702
        /* Error message already printed when size parsing fails */
2703
        ret = -1;
2704
        qemu_opts_del(param);
2705
        goto out;
2706
    }
2707 2708
    n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
    qemu_opts_del(param);
2709

2710 2711
    bs = bdrv_new_open("image", filename, fmt, BDRV_O_FLAGS | BDRV_O_RDWR,
                       true, quiet);
2712
    if (!bs) {
2713 2714
        ret = -1;
        goto out;
2715
    }
2716 2717 2718 2719 2720 2721 2722

    if (relative) {
        total_size = bdrv_getlength(bs) + n * relative;
    } else {
        total_size = n;
    }
    if (total_size <= 0) {
2723
        error_report("New image size must be positive");
2724 2725
        ret = -1;
        goto out;
2726 2727 2728 2729 2730
    }

    ret = bdrv_truncate(bs, total_size);
    switch (ret) {
    case 0:
2731
        qprintf(quiet, "Image resized.\n");
2732 2733
        break;
    case -ENOTSUP:
2734
        error_report("This image does not support resize");
2735 2736
        break;
    case -EACCES:
2737
        error_report("Image is read-only");
2738 2739
        break;
    default:
2740
        error_report("Error resizing image (%d)", -ret);
2741 2742
        break;
    }
2743
out:
2744
    if (bs) {
F
Fam Zheng 已提交
2745
        bdrv_unref(bs);
2746
    }
2747 2748 2749
    if (ret) {
        return 1;
    }
2750 2751 2752
    return 0;
}

M
Max Reitz 已提交
2753 2754 2755 2756
static int img_amend(int argc, char **argv)
{
    int c, ret = 0;
    char *options = NULL;
2757 2758
    QemuOptsList *create_opts = NULL;
    QemuOpts *opts = NULL;
2759 2760
    const char *fmt = NULL, *filename, *cache;
    int flags;
M
Max Reitz 已提交
2761 2762 2763
    bool quiet = false;
    BlockDriverState *bs = NULL;

2764
    cache = BDRV_DEFAULT_CACHE;
M
Max Reitz 已提交
2765
    for (;;) {
2766
        c = getopt(argc, argv, "ho:f:t:q");
M
Max Reitz 已提交
2767 2768 2769 2770 2771 2772 2773 2774 2775 2776
        if (c == -1) {
            break;
        }

        switch (c) {
            case 'h':
            case '?':
                help();
                break;
            case 'o':
2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788
                if (!is_valid_option_list(optarg)) {
                    error_report("Invalid option list: %s", optarg);
                    ret = -1;
                    goto out;
                }
                if (!options) {
                    options = g_strdup(optarg);
                } else {
                    char *old_options = options;
                    options = g_strdup_printf("%s,%s", options, optarg);
                    g_free(old_options);
                }
M
Max Reitz 已提交
2789 2790 2791 2792
                break;
            case 'f':
                fmt = optarg;
                break;
2793 2794 2795
            case 't':
                cache = optarg;
                break;
M
Max Reitz 已提交
2796 2797 2798 2799 2800 2801
            case 'q':
                quiet = true;
                break;
        }
    }

2802
    if (!options) {
F
Fam Zheng 已提交
2803
        error_exit("Must specify options (-o)");
M
Max Reitz 已提交
2804 2805
    }

2806 2807 2808 2809 2810 2811
    filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
    if (fmt && has_help_option(options)) {
        /* If a format is explicitly specified (and possibly no filename is
         * given), print option help here */
        ret = print_block_option_help(filename, fmt);
        goto out;
M
Max Reitz 已提交
2812 2813
    }

2814
    if (optind != argc - 1) {
F
Fam Zheng 已提交
2815
        error_exit("Expecting one image file name");
2816
    }
M
Max Reitz 已提交
2817

2818 2819 2820 2821 2822 2823 2824 2825
    flags = BDRV_O_FLAGS | BDRV_O_RDWR;
    ret = bdrv_parse_cache_flags(cache, &flags);
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        goto out;
    }

    bs = bdrv_new_open("image", filename, fmt, flags, true, quiet);
M
Max Reitz 已提交
2826 2827 2828 2829 2830 2831 2832 2833
    if (!bs) {
        error_report("Could not open image '%s'", filename);
        ret = -1;
        goto out;
    }

    fmt = bs->drv->format_name;

2834
    if (has_help_option(options)) {
2835
        /* If the format was auto-detected, print option help here */
M
Max Reitz 已提交
2836 2837 2838 2839
        ret = print_block_option_help(filename, fmt);
        goto out;
    }

C
Chunyan Liu 已提交
2840
    create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
2841 2842
    opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
    if (options && qemu_opts_do_parse(opts, options, NULL)) {
M
Max Reitz 已提交
2843 2844 2845 2846 2847
        error_report("Invalid options for file format '%s'", fmt);
        ret = -1;
        goto out;
    }

C
Chunyan Liu 已提交
2848
    ret = bdrv_amend_options(bs, opts);
M
Max Reitz 已提交
2849 2850 2851 2852 2853 2854 2855 2856 2857
    if (ret < 0) {
        error_report("Error while amending options: %s", strerror(-ret));
        goto out;
    }

out:
    if (bs) {
        bdrv_unref(bs);
    }
2858 2859
    qemu_opts_del(opts);
    qemu_opts_free(create_opts);
2860 2861
    g_free(options);

M
Max Reitz 已提交
2862 2863 2864 2865 2866 2867
    if (ret) {
        return 1;
    }
    return 0;
}

A
Anthony Liguori 已提交
2868
static const img_cmd_t img_cmds[] = {
2869 2870 2871 2872 2873 2874 2875 2876
#define DEF(option, callback, arg_string)        \
    { option, callback },
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
    { NULL, NULL, },
};

B
bellard 已提交
2877 2878
int main(int argc, char **argv)
{
A
Anthony Liguori 已提交
2879
    const img_cmd_t *cmd;
2880
    const char *cmdname;
2881 2882 2883
    int c;
    static const struct option long_options[] = {
        {"help", no_argument, 0, 'h'},
2884
        {"version", no_argument, 0, 'v'},
2885 2886
        {0, 0, 0, 0}
    };
B
bellard 已提交
2887

2888 2889 2890 2891
#ifdef CONFIG_POSIX
    signal(SIGPIPE, SIG_IGN);
#endif

K
Kevin Wolf 已提交
2892
    error_set_progname(argv[0]);
2893
    qemu_init_exec_dir(argv[0]);
K
Kevin Wolf 已提交
2894

2895
    qemu_init_main_loop();
B
bellard 已提交
2896
    bdrv_init();
F
Fam Zheng 已提交
2897 2898 2899
    if (argc < 2) {
        error_exit("Not enough arguments");
    }
2900 2901 2902
    cmdname = argv[1];

    /* find the command */
2903
    for (cmd = img_cmds; cmd->name != NULL; cmd++) {
2904
        if (!strcmp(cmdname, cmd->name)) {
2905
            return cmd->handler(argc - 1, argv + 1);
2906
        }
B
bellard 已提交
2907
    }
2908

2909
    c = getopt_long(argc, argv, "h", long_options, NULL);
2910 2911 2912 2913

    if (c == 'h') {
        help();
    }
2914 2915 2916 2917
    if (c == 'v') {
        printf(QEMU_IMG_VERSION);
        return 0;
    }
2918

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