qemu-img.c 67.5 KB
Newer Older
bellard's avatar
bellard committed
1
/*
bellard's avatar
bellard committed
2
 * QEMU disk image utility
3
 *
bellard's avatar
bellard committed
4
 * Copyright (c) 2003-2008 Fabrice Bellard
5
 *
bellard's avatar
bellard committed
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"
pbrook's avatar
pbrook committed
27
#include "qemu-common.h"
28
29
30
#include "qemu/option.h"
#include "qemu/error-report.h"
#include "qemu/osdep.h"
31
#include "sysemu/sysemu.h"
32
#include "block/block_int.h"
33
#include "block/qapi.h"
34
#include <getopt.h>
35
#include <stdio.h>
36
#include <stdarg.h>
bellard's avatar
bellard committed
37

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

42
typedef struct img_cmd_t {
43
44
    const char *name;
    int (*handler)(int argc, char **argv);
45
} img_cmd_t;
46

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

typedef enum OutputFormat {
    OFORMAT_JSON,
    OFORMAT_HUMAN,
} OutputFormat;

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

bellard's avatar
bellard committed
61
62
63
64
65
static void format_print(void *opaque, const char *name)
{
    printf(" %s", name);
}

blueswir1's avatar
blueswir1 committed
66
/* Please keep in synch with qemu-img.texi */
pbrook's avatar
pbrook committed
67
static void help(void)
bellard's avatar
bellard committed
68
{
69
70
    const char *help_msg =
           "qemu-img version " QEMU_VERSION ", Copyright (c) 2004-2008 Fabrice Bellard\n"
71
72
73
74
           "usage: qemu-img command [command options]\n"
           "QEMU disk image utility\n"
           "\n"
           "Command syntax:\n"
75
76
77
78
79
#define DEF(option, callback, arg_string)        \
           "  " arg_string "\n"
#include "qemu-img-cmds.h"
#undef DEF
#undef GEN_DOCS
80
81
82
83
           "\n"
           "Command parameters:\n"
           "  'filename' is a disk image filename\n"
           "  'fmt' is the disk image format. It is guessed automatically in most cases\n"
84
           "  'cache' is the cache mode used to write the output disk image, the valid\n"
85
86
           "    options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
           "    'directsync' and 'unsafe' (default for convert)\n"
87
           "  'size' is the disk image size in bytes. Optional suffixes\n"
88
89
90
           "    'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
           "    'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P)  are\n"
           "    supported. 'b' is ignored.\n"
91
92
93
94
95
96
97
98
99
100
           "  'output_filename' is the destination disk image filename\n"
           "  'output_fmt' is the destination format\n"
           "  'options' is a comma separated list of format specific options in a\n"
           "    name=value format. Use -o ? for an overview of the options supported by the\n"
           "    used format\n"
           "  '-c' indicates that target image must be compressed (qcow format only)\n"
           "  '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
           "       match exactly. The image doesn't need a working backing file before\n"
           "       rebasing in this case (useful for renaming the backing file)\n"
           "  '-h' with or without a command shows this help and lists the supported formats\n"
101
           "  '-p' show progress of command (only certain commands)\n"
102
           "  '-q' use Quiet mode - do not print any output (except errors)\n"
103
104
           "  '-S' indicates the consecutive number of bytes that must contain only zeros\n"
           "       for qemu-img to create a sparse image during conversion\n"
105
           "  '--output' takes the format in which the output must be done (human or json)\n"
106
107
           "  '-n' skips the target volume creation (useful if the volume is created\n"
           "       prior to running qemu-img)\n"
108
           "\n"
109
110
111
112
           "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"
113
           "       hiding corruption that has already occurred.\n"
114
           "\n"
115
116
117
118
119
           "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"
120
121
122
123
124
125
           "  '-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";
126
127

    printf("%s\nSupported formats:", help_msg);
bellard's avatar
bellard committed
128
129
130
131
132
    bdrv_iterate_format(format_print, NULL);
    printf("\n");
    exit(1);
}

133
static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
134
135
136
137
138
139
140
141
142
143
144
{
    int ret = 0;
    if (!quiet) {
        va_list args;
        va_start(args, fmt);
        ret = vprintf(fmt, args);
        va_end(args);
    }
    return ret;
}

bellard's avatar
bellard committed
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
#if defined(WIN32)
/* XXX: put correct support for win32 */
static int read_password(char *buf, int buf_size)
{
    int c, i;
    printf("Password: ");
    fflush(stdout);
    i = 0;
    for(;;) {
        c = getchar();
        if (c == '\n')
            break;
        if (i < (buf_size - 1))
            buf[i++] = c;
    }
    buf[i] = '\0';
    return 0;
}

#else

#include <termios.h>

static struct termios oldtty;

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

static void term_init(void)
{
    struct termios tty;

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

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

bellard's avatar
bellard committed
191
192
193
194
195
    tcsetattr (0, TCSANOW, &tty);

    atexit(term_exit);
}

pbrook's avatar
pbrook committed
196
static int read_password(char *buf, int buf_size)
bellard's avatar
bellard committed
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
{
    uint8_t ch;
    int i, ret;

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

233
234
235
236
237
238
239
240
static int print_block_option_help(const char *filename, const char *fmt)
{
    BlockDriver *drv, *proto_drv;
    QEMUOptionParameter *create_options = NULL;

    /* Find driver and parse its options */
    drv = bdrv_find_format(fmt);
    if (!drv) {
241
        error_report("Unknown file format '%s'", fmt);
242
243
244
        return 1;
    }

245
    proto_drv = bdrv_find_protocol(filename, true);
246
    if (!proto_drv) {
247
        error_report("Unknown protocol '%s'", filename);
248
249
250
251
252
253
254
255
256
257
258
259
        return 1;
    }

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

260
static BlockDriverState *bdrv_new_open(const char *filename,
261
                                       const char *fmt,
262
                                       int flags,
263
264
                                       bool require_io,
                                       bool quiet)
265
266
267
268
{
    BlockDriverState *bs;
    BlockDriver *drv;
    char password[256];
269
    int ret;
270

271
    bs = bdrv_new("image");
272

273
274
    if (fmt) {
        drv = bdrv_find_format(fmt);
275
        if (!drv) {
276
            error_report("Unknown file format '%s'", fmt);
277
278
            goto fail;
        }
279
280
281
    } else {
        drv = NULL;
    }
282

283
    ret = bdrv_open(bs, filename, NULL, flags, drv);
284
285
    if (ret < 0) {
        error_report("Could not open '%s': %s", filename, strerror(-ret));
286
        goto fail;
287
    }
288

289
    if (bdrv_is_encrypted(bs) && require_io) {
290
        qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
291
        if (read_password(password, sizeof(password)) < 0) {
292
            error_report("No password given");
293
294
295
            goto fail;
        }
        if (bdrv_set_key(bs, password) < 0) {
296
            error_report("invalid password");
297
298
            goto fail;
        }
299
300
    }
    return bs;
301
302
fail:
    if (bs) {
Fam Zheng's avatar
Fam Zheng committed
303
        bdrv_unref(bs);
304
305
    }
    return NULL;
306
307
}

308
static int add_old_style_options(const char *fmt, QEMUOptionParameter *list,
309
310
                                 const char *base_filename,
                                 const char *base_fmt)
311
312
313
{
    if (base_filename) {
        if (set_option_parameter(list, BLOCK_OPT_BACKING_FILE, base_filename)) {
314
315
            error_report("Backing file not supported for file format '%s'",
                         fmt);
316
            return -1;
317
318
319
320
        }
    }
    if (base_fmt) {
        if (set_option_parameter(list, BLOCK_OPT_BACKING_FMT, base_fmt)) {
321
322
            error_report("Backing file format not supported for file "
                         "format '%s'", fmt);
323
            return -1;
324
325
        }
    }
326
    return 0;
327
328
}

bellard's avatar
bellard committed
329
330
static int img_create(int argc, char **argv)
{
331
    int c;
332
    uint64_t img_size = -1;
bellard's avatar
bellard committed
333
    const char *fmt = "raw";
334
    const char *base_fmt = NULL;
bellard's avatar
bellard committed
335
336
    const char *filename;
    const char *base_filename = NULL;
337
    char *options = NULL;
338
    Error *local_err = NULL;
339
    bool quiet = false;
340

bellard's avatar
bellard committed
341
    for(;;) {
342
        c = getopt(argc, argv, "F:b:f:he6o:q");
343
        if (c == -1) {
bellard's avatar
bellard committed
344
            break;
345
        }
bellard's avatar
bellard committed
346
        switch(c) {
347
        case '?':
bellard's avatar
bellard committed
348
349
350
        case 'h':
            help();
            break;
351
352
353
        case 'F':
            base_fmt = optarg;
            break;
bellard's avatar
bellard committed
354
355
356
357
358
359
360
        case 'b':
            base_filename = optarg;
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'e':
361
            error_report("option -e is deprecated, please use \'-o "
362
363
                  "encryption\' instead!");
            return 1;
364
        case '6':
365
            error_report("option -6 is deprecated, please use \'-o "
366
367
                  "compat6\' instead!");
            return 1;
368
369
370
        case 'o':
            options = optarg;
            break;
371
372
373
        case 'q':
            quiet = true;
            break;
bellard's avatar
bellard committed
374
375
        }
    }
376

377
    /* Get the filename */
378
    if (optind >= argc) {
379
        help();
380
    }
381
382
    filename = argv[optind++];

383
384
    /* Get image size, if specified */
    if (optind < argc) {
385
        int64_t sval;
386
387
388
        char *end;
        sval = strtosz_suffix(argv[optind++], &end, STRTOSZ_DEFSUFFIX_B);
        if (sval < 0 || *end) {
389
390
391
392
            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, "
393
394
395
                      "G, T, P or E suffixes for ");
                error_report("kilobytes, megabytes, gigabytes, terabytes, "
                             "petabytes and exabytes.");
396
            }
397
            return 1;
398
399
400
        }
        img_size = (uint64_t)sval;
    }
401
402
403
    if (optind != argc) {
        help();
    }
404

405
    if (options && is_help_option(options)) {
406
        return print_block_option_help(filename, fmt);
407
408
    }

409
    bdrv_img_create(filename, fmt, base_filename, base_fmt,
410
                    options, img_size, BDRV_O_FLAGS, &local_err, quiet);
411
412
413
    if (error_is_set(&local_err)) {
        error_report("%s", error_get_pretty(local_err));
        error_free(local_err);
414
415
        return 1;
    }
416

bellard's avatar
bellard committed
417
418
419
    return 0;
}

420
static void dump_json_image_check(ImageCheck *check, bool quiet)
421
422
423
424
425
426
427
428
429
430
{
    Error *errp = NULL;
    QString *str;
    QmpOutputVisitor *ov = qmp_output_visitor_new();
    QObject *obj;
    visit_type_ImageCheck(qmp_output_get_visitor(ov),
                          &check, NULL, &errp);
    obj = qmp_output_get_qobject(ov);
    str = qobject_to_json_pretty(obj);
    assert(str != NULL);
431
    qprintf(quiet, "%s\n", qstring_get_str(str));
432
433
434
435
436
    qobject_decref(obj);
    qmp_output_visitor_cleanup(ov);
    QDECREF(str);
}

437
static void dump_human_image_check(ImageCheck *check, bool quiet)
438
439
{
    if (!(check->corruptions || check->leaks || check->check_errors)) {
440
        qprintf(quiet, "No errors were found on the image.\n");
441
442
    } else {
        if (check->corruptions) {
443
444
445
446
            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);
447
448
449
        }

        if (check->leaks) {
450
451
452
453
            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);
454
455
456
        }

        if (check->check_errors) {
457
458
459
460
            qprintf(quiet,
                    "\n%" PRId64
                    " internal errors have occurred during the check.\n",
                    check->check_errors);
461
462
463
464
        }
    }

    if (check->total_clusters != 0 && check->allocated_clusters != 0) {
465
466
467
468
469
470
471
        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);
472
473
474
    }

    if (check->image_end_offset) {
475
476
        qprintf(quiet,
                "Image end offset: %" PRId64 "\n", check->image_end_offset);
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
    }
}

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;
513
514
    check->compressed_clusters      = result.bfi.compressed_clusters;
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
515
516
517
518

    return 0;
}

519
520
521
522
523
524
525
526
/*
 * Checks an image for consistency. Exit codes:
 *
 * 0 - Check completed, image is good
 * 1 - Check not completed because of internal errors
 * 2 - Check completed, image is corrupted
 * 3 - Check completed, image has leaked clusters, but is good otherwise
 */
527
528
529
static int img_check(int argc, char **argv)
{
    int c, ret;
530
531
    OutputFormat output_format = OFORMAT_HUMAN;
    const char *filename, *fmt, *output;
532
    BlockDriverState *bs;
533
    int fix = 0;
534
    int flags = BDRV_O_FLAGS | BDRV_O_CHECK;
535
    ImageCheck *check;
536
    bool quiet = false;
537
538

    fmt = NULL;
539
    output = NULL;
540
    for(;;) {
541
542
543
544
545
546
547
548
        int option_index = 0;
        static const struct option long_options[] = {
            {"help", no_argument, 0, 'h'},
            {"format", required_argument, 0, 'f'},
            {"repair", no_argument, 0, 'r'},
            {"output", required_argument, 0, OPTION_OUTPUT},
            {0, 0, 0, 0}
        };
549
        c = getopt_long(argc, argv, "f:hr:q",
550
                        long_options, &option_index);
551
        if (c == -1) {
552
            break;
553
        }
554
        switch(c) {
555
        case '?':
556
557
558
559
560
561
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
562
563
564
565
566
567
568
569
570
571
572
        case 'r':
            flags |= BDRV_O_RDWR;

            if (!strcmp(optarg, "leaks")) {
                fix = BDRV_FIX_LEAKS;
            } else if (!strcmp(optarg, "all")) {
                fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
            } else {
                help();
            }
            break;
573
574
575
        case OPTION_OUTPUT:
            output = optarg;
            break;
576
577
578
        case 'q':
            quiet = true;
            break;
579
580
        }
    }
581
    if (optind != argc - 1) {
582
        help();
583
    }
584
585
    filename = argv[optind++];

586
587
588
589
590
591
592
593
594
    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;
    }

595
    bs = bdrv_new_open(filename, fmt, flags, true, quiet);
596
597
598
    if (!bs) {
        return 1;
    }
599
600
601

    check = g_new0(ImageCheck, 1);
    ret = collect_image_check(bs, check, filename, fmt, fix);
602
603

    if (ret == -ENOTSUP) {
604
605
606
607
608
        if (output_format == OFORMAT_HUMAN) {
            error_report("This image format does not support checks");
        }
        ret = 1;
        goto fail;
609
610
    }

611
612
    if (check->corruptions_fixed || check->leaks_fixed) {
        int corruptions_fixed, leaks_fixed;
613

614
615
        leaks_fixed         = check->leaks_fixed;
        corruptions_fixed   = check->corruptions_fixed;
616

617
        if (output_format == OFORMAT_HUMAN) {
618
619
620
621
622
623
624
            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);
625
626
        }

627
        ret = collect_image_check(bs, check, filename, fmt, 0);
628

629
630
        check->leaks_fixed          = leaks_fixed;
        check->corruptions_fixed    = corruptions_fixed;
631
632
    }

633
634
    switch (output_format) {
    case OFORMAT_HUMAN:
635
        dump_human_image_check(check, quiet);
636
637
        break;
    case OFORMAT_JSON:
638
        dump_json_image_check(check, quiet);
639
        break;
640
641
    }

642
643
644
    if (ret || check->check_errors) {
        ret = 1;
        goto fail;
645
    }
646

647
648
649
650
    if (check->corruptions) {
        ret = 2;
    } else if (check->leaks) {
        ret = 3;
651
    } else {
652
        ret = 0;
653
    }
654
655
656

fail:
    qapi_free_ImageCheck(check);
Fam Zheng's avatar
Fam Zheng committed
657
    bdrv_unref(bs);
658
659

    return ret;
660
661
}

bellard's avatar
bellard committed
662
663
static int img_commit(int argc, char **argv)
{
664
665
    int c, ret, flags;
    const char *filename, *fmt, *cache;
bellard's avatar
bellard committed
666
    BlockDriverState *bs;
667
    bool quiet = false;
bellard's avatar
bellard committed
668
669

    fmt = NULL;
670
    cache = BDRV_DEFAULT_CACHE;
bellard's avatar
bellard committed
671
    for(;;) {
672
        c = getopt(argc, argv, "f:ht:q");
673
        if (c == -1) {
bellard's avatar
bellard committed
674
            break;
675
        }
bellard's avatar
bellard committed
676
        switch(c) {
677
        case '?':
bellard's avatar
bellard committed
678
679
680
681
682
683
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
684
685
686
        case 't':
            cache = optarg;
            break;
687
688
689
        case 'q':
            quiet = true;
            break;
bellard's avatar
bellard committed
690
691
        }
    }
692
    if (optind != argc - 1) {
bellard's avatar
bellard committed
693
        help();
694
    }
bellard's avatar
bellard committed
695
696
    filename = argv[optind++];

697
    flags = BDRV_O_RDWR;
698
    ret = bdrv_parse_cache_flags(cache, &flags);
699
700
701
702
703
    if (ret < 0) {
        error_report("Invalid cache option: %s", cache);
        return -1;
    }

704
    bs = bdrv_new_open(filename, fmt, flags, true, quiet);
705
706
707
    if (!bs) {
        return 1;
    }
bellard's avatar
bellard committed
708
709
710
    ret = bdrv_commit(bs);
    switch(ret) {
    case 0:
711
        qprintf(quiet, "Image committed.\n");
bellard's avatar
bellard committed
712
713
        break;
    case -ENOENT:
714
        error_report("No disk inserted");
bellard's avatar
bellard committed
715
716
        break;
    case -EACCES:
717
        error_report("Image is read-only");
bellard's avatar
bellard committed
718
719
        break;
    case -ENOTSUP:
720
        error_report("Image is already committed");
bellard's avatar
bellard committed
721
722
        break;
    default:
723
        error_report("Error while committing image");
bellard's avatar
bellard committed
724
725
726
        break;
    }

Fam Zheng's avatar
Fam Zheng committed
727
    bdrv_unref(bs);
728
729
730
    if (ret) {
        return 1;
    }
bellard's avatar
bellard committed
731
732
733
    return 0;
}

734
735
736
737
738
739
740
/*
 * 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.
 */
bellard's avatar
bellard committed
741
742
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
{
743
744
    bool is_zero;
    int i;
bellard's avatar
bellard committed
745
746
747
748
749

    if (n <= 0) {
        *pnum = 0;
        return 0;
    }
750
    is_zero = buffer_is_zero(buf, 512);
bellard's avatar
bellard committed
751
752
    for(i = 1; i < n; i++) {
        buf += 512;
753
        if (is_zero != buffer_is_zero(buf, 512)) {
bellard's avatar
bellard committed
754
            break;
755
        }
bellard's avatar
bellard committed
756
757
    }
    *pnum = i;
758
    return !is_zero;
bellard's avatar
bellard committed
759
760
}

761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
/*
 * 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;
}

Kevin Wolf's avatar
Kevin Wolf committed
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
/*
 * 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;
}

834
#define IO_BUF_SIZE (2 * 1024 * 1024)
bellard's avatar
bellard committed
835

836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
static int64_t sectors_to_bytes(int64_t sectors)
{
    return sectors << BDRV_SECTOR_BITS;
}

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

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

    return 0;
}

/*
 * Compares two images. Exit codes:
 *
 * 0 - Images are identical
 * 1 - Images differ
 * >1 - Error occurred
 */
static int img_compare(int argc, char **argv)
{
    const char *fmt1 = NULL, *fmt2 = NULL, *filename1, *filename2;
    BlockDriverState *bs1, *bs2;
    int64_t total_sectors1, total_sectors2;
    uint8_t *buf1 = NULL, *buf2 = NULL;
    int pnum1, pnum2;
    int allocated1, allocated2;
    int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
    bool progress = false, quiet = false, strict = false;
    int64_t total_sectors;
    int64_t sector_num = 0;
    int64_t nb_sectors;
    int c, pnum;
    uint64_t bs_sectors;
    uint64_t progress_base;

    for (;;) {
        c = getopt(argc, argv, "hpf:F:sq");
        if (c == -1) {
            break;
        }
        switch (c) {
        case '?':
        case 'h':
            help();
            break;
        case 'f':
            fmt1 = optarg;
            break;
        case 'F':
            fmt2 = optarg;
            break;
        case 'p':
            progress = true;
            break;
        case 'q':
            quiet = true;
            break;
        case 's':
            strict = true;
            break;
        }
    }

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


938
    if (optind != argc - 2) {
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
        help();
    }
    filename1 = argv[optind++];
    filename2 = argv[optind++];

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

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

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

    buf1 = qemu_blockalign(bs1, IO_BUF_SIZE);
    buf2 = qemu_blockalign(bs2, IO_BUF_SIZE);
    bdrv_get_geometry(bs1, &bs_sectors);
    total_sectors1 = bs_sectors;
    bdrv_get_geometry(bs2, &bs_sectors);
    total_sectors2 = bs_sectors;
    total_sectors = MIN(total_sectors1, total_sectors2);
    progress_base = MAX(total_sectors1, total_sectors2);

    qemu_progress_print(0, 100);

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

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

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

        if (allocated1 == allocated2) {
            if (allocated1) {
                ret = bdrv_read(bs1, sector_num, buf1, nb_sectors);
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64 " of %s:"
                                 " %s", sectors_to_bytes(sector_num), filename1,
                                 strerror(-ret));
                    ret = 4;
                    goto out;
                }
                ret = bdrv_read(bs2, sector_num, buf2, nb_sectors);
                if (ret < 0) {
                    error_report("Error while reading offset %" PRId64
                                 " of %s: %s", sectors_to_bytes(sector_num),
                                 filename2, strerror(-ret));
                    ret = 4;
                    goto out;
                }
                ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
                if (ret || pnum != nb_sectors) {
                    ret = 1;
                    qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
                            sectors_to_bytes(
                                ret ? sector_num : sector_num + pnum));
                    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) {
                    ret = 4;
                    error_report("Error while reading offset %" PRId64 ": %s",
                                 sectors_to_bytes(sector_num), strerror(-ret));
                }
                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) {
                        ret = 4;
                        error_report("Error while reading offset %" PRId64
                                     " of %s: %s", sectors_to_bytes(sector_num),
                                     filename_over, strerror(-ret));
                    }
                    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:
Fam Zheng's avatar
Fam Zheng committed
1109
    bdrv_unref(bs2);
1110
1111
1112
    qemu_vfree(buf1);
    qemu_vfree(buf2);
out2:
Fam Zheng's avatar
Fam Zheng committed
1113
    bdrv_unref(bs1);
1114
1115
1116
1117
1118
out3:
    qemu_progress_end();
    return ret;
}

bellard's avatar
bellard committed
1119
1120
static int img_convert(int argc, char **argv)
{
1121
1122
    int c, ret = 0, n, n1, bs_n, bs_i, compress, cluster_size,
        cluster_sectors, skip_create;
1123
1124
    int progress = 0, flags;
    const char *fmt, *out_fmt, *cache, *out_baseimg, *out_filename;
1125
    BlockDriver *drv, *proto_drv;
1126
    BlockDriverState **bs = NULL, *out_bs = NULL;
1127
1128
    int64_t total_sectors, nb_sectors, sector_num, bs_offset;
    uint64_t bs_sectors;
1129
    uint8_t * buf = NULL;
bellard's avatar
bellard committed
1130
    const uint8_t *buf1;
bellard's avatar
bellard committed
1131
    BlockDriverInfo bdi;
1132
    QEMUOptionParameter *param = NULL, *create_options = NULL;
1133
    QEMUOptionParameter *out_baseimg_param;
1134
    char *options = NULL;
edison's avatar
edison committed
1135
    const char *snapshot_name = NULL;
1136
    float local_progress = 0;
1137
    int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1138
    bool quiet = false;
bellard's avatar
bellard committed
1139
1140
1141

    fmt = NULL;
    out_fmt = "raw";
1142
    cache = "unsafe";
1143
    out_baseimg = NULL;
1144
    compress = 0;
1145
    skip_create = 0;
bellard's avatar
bellard committed
1146
    for(;;) {
1147
        c = getopt(argc, argv, "f:O:B:s:hce6o:pS:t:qn");
1148
        if (c == -1) {
bellard's avatar
bellard committed
1149
            break;
1150
        }
bellard's avatar
bellard committed
1151
        switch(c) {
1152
        case '?':
bellard's avatar
bellard committed
1153
1154
1155
1156
1157
1158
1159
1160
1161
        case 'h':
            help();
            break;
        case 'f':
            fmt = optarg;
            break;
        case 'O':
            out_fmt = optarg;
            break;
1162
1163
1164
        case 'B':
            out_baseimg = optarg;
            break;
bellard's avatar
bellard committed
1165
        case 'c':
1166
            compress = 1;
bellard's avatar
bellard committed
1167
1168
            break;
        case 'e':
1169
            error_report("option -e is deprecated, please use \'-o "
1170
1171
                  "encryption\' instead!");
            return 1;
1172
        case '6':
1173
            error_report("option -6 is deprecated, please use \'-o "
1174
1175
                  "compat6\' instead!");
            return 1;
1176
1177
1178
        case 'o':
            options = optarg;
            break;
edison's avatar
edison committed
1179
1180
1181
        case 's':
            snapshot_name = optarg;
            break;
1182
1183
1184
        case 'S':
        {
            int64_t sval;
1185
1186
1187
            char *end;
            sval = strtosz_suffix(optarg, &end, STRTOSZ_DEFSUFFIX_B);
            if (sval < 0 || *end) {
1188
1189
1190
1191
1192
1193
1194
                error_report("Invalid minimum zero buffer size for sparse output specified");
                return 1;
            }

            min_sparse = sval / BDRV_SECTOR_SIZE;
            break;
        }
1195
1196
1197
        case 'p':
            progress = 1;
            break;
1198
1199
1200
        case 't':
            cache = optarg;
            break;
1201
1202
1203
        case 'q':
            quiet = true;
            break;
1204
1205
1206
        case 'n':
            skip_create = 1;
            break;
bellard's avatar
bellard committed
1207
1208
        }
    }
1209

1210
1211
1212
1213
    if (quiet) {
        progress = 0;
    }

1214
    bs_n = argc - optind - 1;
1215
1216
1217
    if (bs_n < 1) {
        help();
    }
1218
1219

    out_filename = argv[argc - 1];
1220

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

1224
    if (options && is_help_option(options)) {
1225
1226
1227
1228
        ret = print_block_option_help(out_filename, out_fmt);
        goto out;
    }

1229
    if (bs_n > 1 && out_baseimg) {
1230
1231
        error_report("-B makes no sense when concatenating multiple input "
                     "images");
1232
1233
        ret = -1;
        goto out;
1234
    }
1235

1236
1237
    qemu_progress_print(0, 100);

1238
    bs = g_malloc0(bs_n * sizeof(BlockDriverState *));
1239
1240
1241

    total_sectors = 0;
    for (bs_i = 0; bs_i < bs_n; bs_i++) {
1242
1243
        bs[bs_i] = bdrv_new_open(argv[optind + bs_i], fmt, BDRV_O_FLAGS, true,
                                 quiet);
1244
        if (!bs[bs_i]) {
1245
            error_report("Could not open '%s'", argv[optind + bs_i]);
1246
1247
1248
            ret = -1;
            goto out;
        }
1249
1250
1251
        bdrv_get_geometry(bs[bs_i], &bs_sectors);
        total_sectors += bs_sectors;
    }
bellard's avatar
bellard committed
1252

edison's avatar
edison committed
1253
1254
    if (snapshot_name != NULL) {
        if (bs_n > 1) {
1255
            error_report("No support for concatenating multiple snapshot");
edison's avatar
edison committed
1256
1257
1258
1259
            ret = -1;
            goto out;
        }
        if (bdrv_snapshot_load_tmp(bs[0], snapshot_name) < 0) {
1260
            error_report("Failed to load snapshot");
edison's avatar
edison committed
1261
1262
1263
1264
1265
            ret = -1;
            goto out;
        }
    }

1266
    /* Find driver and parse its options */
bellard's avatar
bellard committed
1267
    drv = bdrv_find_format(out_fmt);
1268
    if (!drv) {
1269
        error_report("Unknown file format '%s'", out_fmt);
1270
1271
1272
        ret = -1;
        goto out;
    }
1273

1274
    proto_drv = bdrv_find_protocol(out_filename, true);
1275
    if (!proto_drv) {
1276
        error_report("Unknown protocol '%s'", out_filename);
1277
1278
1279
        ret = -1;
        goto out;
    }