Statistics
| Branch: | Revision:

root / qemu-img.c @ feature-archipelago

History | View | Annotate | Download (80.4 kB)

1
/*
2
 * QEMU disk image utility
3
 *
4
 * Copyright (c) 2003-2008 Fabrice Bellard
5
 *
6
 * Permission is hereby granted, free of charge, to any person obtaining a copy
7
 * of this software and associated documentation files (the "Software"), to deal
8
 * in the Software without restriction, including without limitation the rights
9
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
 * copies of the Software, and to permit persons to whom the Software is
11
 * furnished to do so, subject to the following conditions:
12
 *
13
 * The above copyright notice and this permission notice shall be included in
14
 * all copies or substantial portions of the Software.
15
 *
16
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22
 * THE SOFTWARE.
23
 */
24
#include "qapi-visit.h"
25
#include "qapi/qmp-output-visitor.h"
26
#include "qapi/qmp/qjson.h"
27
#include "qemu-common.h"
28
#include "qemu/option.h"
29
#include "qemu/error-report.h"
30
#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
typedef struct img_cmd_t {
37
    const char *name;
38
    int (*handler)(int argc, char **argv);
39
} img_cmd_t;
40

    
41
enum {
42
    OPTION_OUTPUT = 256,
43
    OPTION_BACKING_CHAIN = 257,
44
};
45

    
46
typedef enum OutputFormat {
47
    OFORMAT_JSON,
48
    OFORMAT_HUMAN,
49
} OutputFormat;
50

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

    
55
static void format_print(void *opaque, const char *name)
56
{
57
    printf(" %s", name);
58
}
59

    
60
/* Please keep in synch with qemu-img.texi */
61
static void help(void)
62
{
63
    const char *help_msg =
64
           "qemu-img version " QEMU_VERSION ", Copyright (c) 2004-2008 Fabrice Bellard\n"
65
           "usage: qemu-img command [command options]\n"
66
           "QEMU disk image utility\n"
67
           "\n"
68
           "Command syntax:\n"
69
#define DEF(option, callback, arg_string)        \
70
           "  " arg_string "\n"
71
#include "qemu-img-cmds.h"
72
#undef DEF
73
#undef GEN_DOCS
74
           "\n"
75
           "Command parameters:\n"
76
           "  'filename' is a disk image filename\n"
77
           "  'fmt' is the disk image format. It is guessed automatically in most cases\n"
78
           "  'cache' is the cache mode used to write the output disk image, the valid\n"
79
           "    options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
80
           "    'directsync' and 'unsafe' (default for convert)\n"
81
           "  'size' is the disk image size in bytes. Optional suffixes\n"
82
           "    'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
83
           "    'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P)  are\n"
84
           "    supported. 'b' is ignored.\n"
85
           "  'output_filename' is the destination disk image filename\n"
86
           "  'output_fmt' is the destination format\n"
87
           "  'options' is a comma separated list of format specific options in a\n"
88
           "    name=value format. Use -o ? for an overview of the options supported by the\n"
89
           "    used format\n"
90
           "  'snapshot_param' is param used for internal snapshot, format\n"
91
           "    is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
92
           "    '[ID_OR_NAME]'\n"
93
           "  'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
94
           "    instead\n"
95
           "  '-c' indicates that target image must be compressed (qcow format only)\n"
96
           "  '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
97
           "       match exactly. The image doesn't need a working backing file before\n"
98
           "       rebasing in this case (useful for renaming the backing file)\n"
99
           "  '-h' with or without a command shows this help and lists the supported formats\n"
100
           "  '-p' show progress of command (only certain commands)\n"
101
           "  '-q' use Quiet mode - do not print any output (except errors)\n"
102
           "  '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
103
           "       contain only zeros for qemu-img to create a sparse image during\n"
104
           "       conversion. If the number of bytes is 0, the source will not be scanned for\n"
105
           "       unallocated or zero sectors, and the destination image will always be\n"
106
           "       fully allocated\n"
107
           "  '--output' takes the format in which the output must be done (human or json)\n"
108
           "  '-n' skips the target volume creation (useful if the volume is created\n"
109
           "       prior to running qemu-img)\n"
110
           "\n"
111
           "Parameters to check subcommand:\n"
112
           "  '-r' tries to repair any inconsistencies that are found during the check.\n"
113
           "       '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
114
           "       kinds of errors, with a higher risk of choosing the wrong fix or\n"
115
           "       hiding corruption that has already occurred.\n"
116
           "\n"
117
           "Parameters to snapshot subcommand:\n"
118
           "  'snapshot' is the name of the snapshot to create, apply or delete\n"
119
           "  '-a' applies a snapshot (revert disk to saved state)\n"
120
           "  '-c' creates a snapshot\n"
121
           "  '-d' deletes a snapshot\n"
122
           "  '-l' lists all snapshots in the given image\n"
123
           "\n"
124
           "Parameters to compare subcommand:\n"
125
           "  '-f' first image format\n"
126
           "  '-F' second image format\n"
127
           "  '-s' run in Strict mode - fail on different image size or sector allocation\n";
128

    
129
    printf("%s\nSupported formats:", help_msg);
130
    bdrv_iterate_format(format_print, NULL);
131
    printf("\n");
132
    exit(1);
133
}
134

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

    
147
#if defined(WIN32)
148
/* XXX: put correct support for win32 */
149
static int read_password(char *buf, int buf_size)
150
{
151
    int c, i;
152
    printf("Password: ");
153
    fflush(stdout);
154
    i = 0;
155
    for(;;) {
156
        c = getchar();
157
        if (c == '\n')
158
            break;
159
        if (i < (buf_size - 1))
160
            buf[i++] = c;
161
    }
162
    buf[i] = '\0';
163
    return 0;
164
}
165

    
166
#else
167

    
168
#include <termios.h>
169

    
170
static struct termios oldtty;
171

    
172
static void term_exit(void)
173
{
174
    tcsetattr (0, TCSANOW, &oldtty);
175
}
176

    
177
static void term_init(void)
178
{
179
    struct termios tty;
180

    
181
    tcgetattr (0, &tty);
182
    oldtty = tty;
183

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

    
193
    tcsetattr (0, TCSANOW, &tty);
194

    
195
    atexit(term_exit);
196
}
197

    
198
static int read_password(char *buf, int buf_size)
199
{
200
    uint8_t ch;
201
    int i, ret;
202

    
203
    printf("password: ");
204
    fflush(stdout);
205
    term_init();
206
    i = 0;
207
    for(;;) {
208
        ret = read(0, &ch, 1);
209
        if (ret == -1) {
210
            if (errno == EAGAIN || errno == EINTR) {
211
                continue;
212
            } else {
213
                ret = -1;
214
                break;
215
            }
216
        } else if (ret == 0) {
217
            ret = -1;
218
            break;
219
        } else {
220
            if (ch == '\r') {
221
                ret = 0;
222
                break;
223
            }
224
            if (i < (buf_size - 1))
225
                buf[i++] = ch;
226
        }
227
    }
228
    term_exit();
229
    buf[i] = '\0';
230
    printf("\n");
231
    return ret;
232
}
233
#endif
234

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

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

    
247
    create_options = append_option_parameters(create_options,
248
                                              drv->create_options);
249

    
250
    if (filename) {
251
        proto_drv = bdrv_find_protocol(filename, true);
252
        if (!proto_drv) {
253
            error_report("Unknown protocol '%s'", filename);
254
            return 1;
255
        }
256
        create_options = append_option_parameters(create_options,
257
                                                  proto_drv->create_options);
258
    }
259

    
260
    print_option_help(create_options);
261
    free_option_parameters(create_options);
262
    return 0;
263
}
264

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

    
277
    bs = bdrv_new("image");
278

    
279
    if (fmt) {
280
        drv = bdrv_find_format(fmt);
281
        if (!drv) {
282
            error_report("Unknown file format '%s'", fmt);
283
            goto fail;
284
        }
285
    } else {
286
        drv = NULL;
287
    }
288

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

    
297
    if (bdrv_is_encrypted(bs) && require_io) {
298
        qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
299
        if (read_password(password, sizeof(password)) < 0) {
300
            error_report("No password given");
301
            goto fail;
302
        }
303
        if (bdrv_set_key(bs, password) < 0) {
304
            error_report("invalid password");
305
            goto fail;
306
        }
307
    }
308
    return bs;
309
fail:
310
    bdrv_unref(bs);
311
    return NULL;
312
}
313

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

    
335
static int img_create(int argc, char **argv)
336
{
337
    int c;
338
    uint64_t img_size = -1;
339
    const char *fmt = "raw";
340
    const char *base_fmt = NULL;
341
    const char *filename;
342
    const char *base_filename = NULL;
343
    char *options = NULL;
344
    Error *local_err = NULL;
345
    bool quiet = false;
346

    
347
    for(;;) {
348
        c = getopt(argc, argv, "F:b:f:he6o:q");
349
        if (c == -1) {
350
            break;
351
        }
352
        switch(c) {
353
        case '?':
354
        case 'h':
355
            help();
356
            break;
357
        case 'F':
358
            base_fmt = optarg;
359
            break;
360
        case 'b':
361
            base_filename = optarg;
362
            break;
363
        case 'f':
364
            fmt = optarg;
365
            break;
366
        case 'e':
367
            error_report("option -e is deprecated, please use \'-o "
368
                  "encryption\' instead!");
369
            goto fail;
370
        case '6':
371
            error_report("option -6 is deprecated, please use \'-o "
372
                  "compat6\' instead!");
373
            goto fail;
374
        case 'o':
375
            if (!is_valid_option_list(optarg)) {
376
                error_report("Invalid option list: %s", optarg);
377
                goto fail;
378
            }
379
            if (!options) {
380
                options = g_strdup(optarg);
381
            } else {
382
                char *old_options = options;
383
                options = g_strdup_printf("%s,%s", options, optarg);
384
                g_free(old_options);
385
            }
386
            break;
387
        case 'q':
388
            quiet = true;
389
            break;
390
        }
391
    }
392

    
393
    /* Get the filename */
394
    filename = (optind < argc) ? argv[optind] : NULL;
395
    if (options && has_help_option(options)) {
396
        g_free(options);
397
        return print_block_option_help(filename, fmt);
398
    }
399

    
400
    if (optind >= argc) {
401
        help();
402
    }
403
    optind++;
404

    
405
    /* Get image size, if specified */
406
    if (optind < argc) {
407
        int64_t sval;
408
        char *end;
409
        sval = strtosz_suffix(argv[optind++], &end, STRTOSZ_DEFSUFFIX_B);
410
        if (sval < 0 || *end) {
411
            if (sval == -ERANGE) {
412
                error_report("Image size must be less than 8 EiB!");
413
            } else {
414
                error_report("Invalid image size specified! You may use k, M, "
415
                      "G, T, P or E suffixes for ");
416
                error_report("kilobytes, megabytes, gigabytes, terabytes, "
417
                             "petabytes and exabytes.");
418
            }
419
            goto fail;
420
        }
421
        img_size = (uint64_t)sval;
422
    }
423
    if (optind != argc) {
424
        help();
425
    }
426

    
427
    bdrv_img_create(filename, fmt, base_filename, base_fmt,
428
                    options, img_size, BDRV_O_FLAGS, &local_err, quiet);
429
    if (local_err) {
430
        error_report("%s: %s", filename, error_get_pretty(local_err));
431
        error_free(local_err);
432
        goto fail;
433
    }
434

    
435
    g_free(options);
436
    return 0;
437

    
438
fail:
439
    g_free(options);
440
    return 1;
441
}
442

    
443
static void dump_json_image_check(ImageCheck *check, bool quiet)
444
{
445
    Error *errp = NULL;
446
    QString *str;
447
    QmpOutputVisitor *ov = qmp_output_visitor_new();
448
    QObject *obj;
449
    visit_type_ImageCheck(qmp_output_get_visitor(ov),
450
                          &check, NULL, &errp);
451
    obj = qmp_output_get_qobject(ov);
452
    str = qobject_to_json_pretty(obj);
453
    assert(str != NULL);
454
    qprintf(quiet, "%s\n", qstring_get_str(str));
455
    qobject_decref(obj);
456
    qmp_output_visitor_cleanup(ov);
457
    QDECREF(str);
458
}
459

    
460
static void dump_human_image_check(ImageCheck *check, bool quiet)
461
{
462
    if (!(check->corruptions || check->leaks || check->check_errors)) {
463
        qprintf(quiet, "No errors were found on the image.\n");
464
    } else {
465
        if (check->corruptions) {
466
            qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
467
                    "Data may be corrupted, or further writes to the image "
468
                    "may corrupt it.\n",
469
                    check->corruptions);
470
        }
471

    
472
        if (check->leaks) {
473
            qprintf(quiet,
474
                    "\n%" PRId64 " leaked clusters were found on the image.\n"
475
                    "This means waste of disk space, but no harm to data.\n",
476
                    check->leaks);
477
        }
478

    
479
        if (check->check_errors) {
480
            qprintf(quiet,
481
                    "\n%" PRId64
482
                    " internal errors have occurred during the check.\n",
483
                    check->check_errors);
484
        }
485
    }
486

    
487
    if (check->total_clusters != 0 && check->allocated_clusters != 0) {
488
        qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
489
                "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
490
                check->allocated_clusters, check->total_clusters,
491
                check->allocated_clusters * 100.0 / check->total_clusters,
492
                check->fragmented_clusters * 100.0 / check->allocated_clusters,
493
                check->compressed_clusters * 100.0 /
494
                check->allocated_clusters);
495
    }
496

    
497
    if (check->image_end_offset) {
498
        qprintf(quiet,
499
                "Image end offset: %" PRId64 "\n", check->image_end_offset);
500
    }
501
}
502

    
503
static int collect_image_check(BlockDriverState *bs,
504
                   ImageCheck *check,
505
                   const char *filename,
506
                   const char *fmt,
507
                   int fix)
508
{
509
    int ret;
510
    BdrvCheckResult result;
511

    
512
    ret = bdrv_check(bs, &result, fix);
513
    if (ret < 0) {
514
        return ret;
515
    }
516

    
517
    check->filename                 = g_strdup(filename);
518
    check->format                   = g_strdup(bdrv_get_format_name(bs));
519
    check->check_errors             = result.check_errors;
520
    check->corruptions              = result.corruptions;
521
    check->has_corruptions          = result.corruptions != 0;
522
    check->leaks                    = result.leaks;
523
    check->has_leaks                = result.leaks != 0;
524
    check->corruptions_fixed        = result.corruptions_fixed;
525
    check->has_corruptions_fixed    = result.corruptions != 0;
526
    check->leaks_fixed              = result.leaks_fixed;
527
    check->has_leaks_fixed          = result.leaks != 0;
528
    check->image_end_offset         = result.image_end_offset;
529
    check->has_image_end_offset     = result.image_end_offset != 0;
530
    check->total_clusters           = result.bfi.total_clusters;
531
    check->has_total_clusters       = result.bfi.total_clusters != 0;
532
    check->allocated_clusters       = result.bfi.allocated_clusters;
533
    check->has_allocated_clusters   = result.bfi.allocated_clusters != 0;
534
    check->fragmented_clusters      = result.bfi.fragmented_clusters;
535
    check->has_fragmented_clusters  = result.bfi.fragmented_clusters != 0;
536
    check->compressed_clusters      = result.bfi.compressed_clusters;
537
    check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
538

    
539
    return 0;
540
}
541

    
542
/*
543
 * Checks an image for consistency. Exit codes:
544
 *
545
 * 0 - Check completed, image is good
546
 * 1 - Check not completed because of internal errors
547
 * 2 - Check completed, image is corrupted
548
 * 3 - Check completed, image has leaked clusters, but is good otherwise
549
 */
550
static int img_check(int argc, char **argv)
551
{
552
    int c, ret;
553
    OutputFormat output_format = OFORMAT_HUMAN;
554
    const char *filename, *fmt, *output;
555
    BlockDriverState *bs;
556
    int fix = 0;
557
    int flags = BDRV_O_FLAGS | BDRV_O_CHECK;
558
    ImageCheck *check;
559
    bool quiet = false;
560

    
561
    fmt = NULL;
562
    output = NULL;
563
    for(;;) {
564
        int option_index = 0;
565
        static const struct option long_options[] = {
566
            {"help", no_argument, 0, 'h'},
567
            {"format", required_argument, 0, 'f'},
568
            {"repair", no_argument, 0, 'r'},
569
            {"output", required_argument, 0, OPTION_OUTPUT},
570
            {0, 0, 0, 0}
571
        };
572
        c = getopt_long(argc, argv, "f:hr:q",
573
                        long_options, &option_index);
574
        if (c == -1) {
575
            break;
576
        }
577
        switch(c) {
578
        case '?':
579
        case 'h':
580
            help();
581
            break;
582
        case 'f':
583
            fmt = optarg;
584
            break;
585
        case 'r':
586
            flags |= BDRV_O_RDWR;
587

    
588
            if (!strcmp(optarg, "leaks")) {
589
                fix = BDRV_FIX_LEAKS;
590
            } else if (!strcmp(optarg, "all")) {
591
                fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
592
            } else {
593
                help();
594
            }
595
            break;
596
        case OPTION_OUTPUT:
597
            output = optarg;
598
            break;
599
        case 'q':
600
            quiet = true;
601
            break;
602
        }
603
    }
604
    if (optind != argc - 1) {
605
        help();
606
    }
607
    filename = argv[optind++];
608

    
609
    if (output && !strcmp(output, "json")) {
610
        output_format = OFORMAT_JSON;
611
    } else if (output && !strcmp(output, "human")) {
612
        output_format = OFORMAT_HUMAN;
613
    } else if (output) {
614
        error_report("--output must be used with human or json as argument.");
615
        return 1;
616
    }
617

    
618
    bs = bdrv_new_open(filename, fmt, flags, true, quiet);
619
    if (!bs) {
620
        return 1;
621
    }
622

    
623
    check = g_new0(ImageCheck, 1);
624
    ret = collect_image_check(bs, check, filename, fmt, fix);
625

    
626
    if (ret == -ENOTSUP) {
627
        if (output_format == OFORMAT_HUMAN) {
628
            error_report("This image format does not support checks");
629
        }
630
        ret = 63;
631
        goto fail;
632
    }
633

    
634
    if (check->corruptions_fixed || check->leaks_fixed) {
635
        int corruptions_fixed, leaks_fixed;
636

    
637
        leaks_fixed         = check->leaks_fixed;
638
        corruptions_fixed   = check->corruptions_fixed;
639

    
640
        if (output_format == OFORMAT_HUMAN) {
641
            qprintf(quiet,
642
                    "The following inconsistencies were found and repaired:\n\n"
643
                    "    %" PRId64 " leaked clusters\n"
644
                    "    %" PRId64 " corruptions\n\n"
645
                    "Double checking the fixed image now...\n",
646
                    check->leaks_fixed,
647
                    check->corruptions_fixed);
648
        }
649

    
650
        ret = collect_image_check(bs, check, filename, fmt, 0);
651

    
652
        check->leaks_fixed          = leaks_fixed;
653
        check->corruptions_fixed    = corruptions_fixed;
654
    }
655

    
656
    switch (output_format) {
657
    case OFORMAT_HUMAN:
658
        dump_human_image_check(check, quiet);
659
        break;
660
    case OFORMAT_JSON:
661
        dump_json_image_check(check, quiet);
662
        break;
663
    }
664

    
665
    if (ret || check->check_errors) {
666
        ret = 1;
667
        goto fail;
668
    }
669

    
670
    if (check->corruptions) {
671
        ret = 2;
672
    } else if (check->leaks) {
673
        ret = 3;
674
    } else {
675
        ret = 0;
676
    }
677

    
678
fail:
679
    qapi_free_ImageCheck(check);
680
    bdrv_unref(bs);
681

    
682
    return ret;
683
}
684

    
685
static int img_commit(int argc, char **argv)
686
{
687
    int c, ret, flags;
688
    const char *filename, *fmt, *cache;
689
    BlockDriverState *bs;
690
    bool quiet = false;
691

    
692
    fmt = NULL;
693
    cache = BDRV_DEFAULT_CACHE;
694
    for(;;) {
695
        c = getopt(argc, argv, "f:ht:q");
696
        if (c == -1) {
697
            break;
698
        }
699
        switch(c) {
700
        case '?':
701
        case 'h':
702
            help();
703
            break;
704
        case 'f':
705
            fmt = optarg;
706
            break;
707
        case 't':
708
            cache = optarg;
709
            break;
710
        case 'q':
711
            quiet = true;
712
            break;
713
        }
714
    }
715
    if (optind != argc - 1) {
716
        help();
717
    }
718
    filename = argv[optind++];
719

    
720
    flags = BDRV_O_RDWR;
721
    ret = bdrv_parse_cache_flags(cache, &flags);
722
    if (ret < 0) {
723
        error_report("Invalid cache option: %s", cache);
724
        return -1;
725
    }
726

    
727
    bs = bdrv_new_open(filename, fmt, flags, true, quiet);
728
    if (!bs) {
729
        return 1;
730
    }
731
    ret = bdrv_commit(bs);
732
    switch(ret) {
733
    case 0:
734
        qprintf(quiet, "Image committed.\n");
735
        break;
736
    case -ENOENT:
737
        error_report("No disk inserted");
738
        break;
739
    case -EACCES:
740
        error_report("Image is read-only");
741
        break;
742
    case -ENOTSUP:
743
        error_report("Image is already committed");
744
        break;
745
    default:
746
        error_report("Error while committing image");
747
        break;
748
    }
749

    
750
    bdrv_unref(bs);
751
    if (ret) {
752
        return 1;
753
    }
754
    return 0;
755
}
756

    
757
/*
758
 * Returns true iff the first sector pointed to by 'buf' contains at least
759
 * a non-NUL byte.
760
 *
761
 * 'pnum' is set to the number of sectors (including and immediately following
762
 * the first one) that are known to be in the same allocated/unallocated state.
763
 */
764
static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
765
{
766
    bool is_zero;
767
    int i;
768

    
769
    if (n <= 0) {
770
        *pnum = 0;
771
        return 0;
772
    }
773
    is_zero = buffer_is_zero(buf, 512);
774
    for(i = 1; i < n; i++) {
775
        buf += 512;
776
        if (is_zero != buffer_is_zero(buf, 512)) {
777
            break;
778
        }
779
    }
780
    *pnum = i;
781
    return !is_zero;
782
}
783

    
784
/*
785
 * Like is_allocated_sectors, but if the buffer starts with a used sector,
786
 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
787
 * breaking up write requests for only small sparse areas.
788
 */
789
static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
790
    int min)
791
{
792
    int ret;
793
    int num_checked, num_used;
794

    
795
    if (n < min) {
796
        min = n;
797
    }
798

    
799
    ret = is_allocated_sectors(buf, n, pnum);
800
    if (!ret) {
801
        return ret;
802
    }
803

    
804
    num_used = *pnum;
805
    buf += BDRV_SECTOR_SIZE * *pnum;
806
    n -= *pnum;
807
    num_checked = num_used;
808

    
809
    while (n > 0) {
810
        ret = is_allocated_sectors(buf, n, pnum);
811

    
812
        buf += BDRV_SECTOR_SIZE * *pnum;
813
        n -= *pnum;
814
        num_checked += *pnum;
815
        if (ret) {
816
            num_used = num_checked;
817
        } else if (*pnum >= min) {
818
            break;
819
        }
820
    }
821

    
822
    *pnum = num_used;
823
    return 1;
824
}
825

    
826
/*
827
 * Compares two buffers sector by sector. Returns 0 if the first sector of both
828
 * buffers matches, non-zero otherwise.
829
 *
830
 * pnum is set to the number of sectors (including and immediately following
831
 * the first one) that are known to have the same comparison result
832
 */
833
static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
834
    int *pnum)
835
{
836
    int res, i;
837

    
838
    if (n <= 0) {
839
        *pnum = 0;
840
        return 0;
841
    }
842

    
843
    res = !!memcmp(buf1, buf2, 512);
844
    for(i = 1; i < n; i++) {
845
        buf1 += 512;
846
        buf2 += 512;
847

    
848
        if (!!memcmp(buf1, buf2, 512) != res) {
849
            break;
850
        }
851
    }
852

    
853
    *pnum = i;
854
    return res;
855
}
856

    
857
#define IO_BUF_SIZE (2 * 1024 * 1024)
858

    
859
static int64_t sectors_to_bytes(int64_t sectors)
860
{
861
    return sectors << BDRV_SECTOR_BITS;
862
}
863

    
864
static int64_t sectors_to_process(int64_t total, int64_t from)
865
{
866
    return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
867
}
868

    
869
/*
870
 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
871
 *
872
 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
873
 * data and negative value on error.
874
 *
875
 * @param bs:  Driver used for accessing file
876
 * @param sect_num: Number of first sector to check
877
 * @param sect_count: Number of sectors to check
878
 * @param filename: Name of disk file we are checking (logging purpose)
879
 * @param buffer: Allocated buffer for storing read data
880
 * @param quiet: Flag for quiet mode
881
 */
882
static int check_empty_sectors(BlockDriverState *bs, int64_t sect_num,
883
                               int sect_count, const char *filename,
884
                               uint8_t *buffer, bool quiet)
885
{
886
    int pnum, ret = 0;
887
    ret = bdrv_read(bs, sect_num, buffer, sect_count);
888
    if (ret < 0) {
889
        error_report("Error while reading offset %" PRId64 " of %s: %s",
890
                     sectors_to_bytes(sect_num), filename, strerror(-ret));
891
        return ret;
892
    }
893
    ret = is_allocated_sectors(buffer, sect_count, &pnum);
894
    if (ret || pnum != sect_count) {
895
        qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
896
                sectors_to_bytes(ret ? sect_num : sect_num + pnum));
897
        return 1;
898
    }
899

    
900
    return 0;
901
}
902

    
903
/*
904
 * Compares two images. Exit codes:
905
 *
906
 * 0 - Images are identical
907
 * 1 - Images differ
908
 * >1 - Error occurred
909
 */
910
static int img_compare(int argc, char **argv)
911
{
912
    const char *fmt1 = NULL, *fmt2 = NULL, *filename1, *filename2;
913
    BlockDriverState *bs1, *bs2;
914
    int64_t total_sectors1, total_sectors2;
915
    uint8_t *buf1 = NULL, *buf2 = NULL;
916
    int pnum1, pnum2;
917
    int allocated1, allocated2;
918
    int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
919
    bool progress = false, quiet = false, strict = false;
920
    int64_t total_sectors;
921
    int64_t sector_num = 0;
922
    int64_t nb_sectors;
923
    int c, pnum;
924
    uint64_t bs_sectors;
925
    uint64_t progress_base;
926

    
927
    for (;;) {
928
        c = getopt(argc, argv, "hpf:F:sq");
929
        if (c == -1) {
930
            break;
931
        }
932
        switch (c) {
933
        case '?':
934
        case 'h':
935
            help();
936
            break;
937
        case 'f':
938
            fmt1 = optarg;
939
            break;
940
        case 'F':
941
            fmt2 = optarg;
942
            break;
943
        case 'p':
944
            progress = true;
945
            break;
946
        case 'q':
947
            quiet = true;
948
            break;
949
        case 's':
950
            strict = true;
951
            break;
952
        }
953
    }
954

    
955
    /* Progress is not shown in Quiet mode */
956
    if (quiet) {
957
        progress = false;
958
    }
959

    
960

    
961
    if (optind != argc - 2) {
962
        help();
963
    }
964
    filename1 = argv[optind++];
965
    filename2 = argv[optind++];
966

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

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

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

    
984
    buf1 = qemu_blockalign(bs1, IO_BUF_SIZE);
985
    buf2 = qemu_blockalign(bs2, IO_BUF_SIZE);
986
    bdrv_get_geometry(bs1, &bs_sectors);
987
    total_sectors1 = bs_sectors;
988
    bdrv_get_geometry(bs2, &bs_sectors);
989
    total_sectors2 = bs_sectors;
990
    total_sectors = MIN(total_sectors1, total_sectors2);
991
    progress_base = MAX(total_sectors1, total_sectors2);
992

    
993
    qemu_progress_print(0, 100);
994

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

    
1001
    for (;;) {
1002
        nb_sectors = sectors_to_process(total_sectors, sector_num);
1003
        if (nb_sectors <= 0) {
1004
            break;
1005
        }
1006
        allocated1 = bdrv_is_allocated_above(bs1, NULL, sector_num, nb_sectors,
1007
                                             &pnum1);
1008
        if (allocated1 < 0) {
1009
            ret = 3;
1010
            error_report("Sector allocation test failed for %s", filename1);
1011
            goto out;
1012
        }
1013

    
1014
        allocated2 = bdrv_is_allocated_above(bs2, NULL, sector_num, nb_sectors,
1015
                                             &pnum2);
1016
        if (allocated2 < 0) {
1017
            ret = 3;
1018
            error_report("Sector allocation test failed for %s", filename2);
1019
            goto out;
1020
        }
1021
        nb_sectors = MIN(pnum1, pnum2);
1022

    
1023
        if (allocated1 == allocated2) {
1024
            if (allocated1) {
1025
                ret = bdrv_read(bs1, sector_num, buf1, nb_sectors);
1026
                if (ret < 0) {
1027
                    error_report("Error while reading offset %" PRId64 " of %s:"
1028
                                 " %s", sectors_to_bytes(sector_num), filename1,
1029
                                 strerror(-ret));
1030
                    ret = 4;
1031
                    goto out;
1032
                }
1033
                ret = bdrv_read(bs2, sector_num, buf2, nb_sectors);
1034
                if (ret < 0) {
1035
                    error_report("Error while reading offset %" PRId64
1036
                                 " of %s: %s", sectors_to_bytes(sector_num),
1037
                                 filename2, strerror(-ret));
1038
                    ret = 4;
1039
                    goto out;
1040
                }
1041
                ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
1042
                if (ret || pnum != nb_sectors) {
1043
                    qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1044
                            sectors_to_bytes(
1045
                                ret ? sector_num : sector_num + pnum));
1046
                    ret = 1;
1047
                    goto out;
1048
                }
1049
            }
1050
        } else {
1051
            if (strict) {
1052
                ret = 1;
1053
                qprintf(quiet, "Strict mode: Offset %" PRId64
1054
                        " allocation mismatch!\n",
1055
                        sectors_to_bytes(sector_num));
1056
                goto out;
1057
            }
1058

    
1059
            if (allocated1) {
1060
                ret = check_empty_sectors(bs1, sector_num, nb_sectors,
1061
                                          filename1, buf1, quiet);
1062
            } else {
1063
                ret = check_empty_sectors(bs2, sector_num, nb_sectors,
1064
                                          filename2, buf1, quiet);
1065
            }
1066
            if (ret) {
1067
                if (ret < 0) {
1068
                    error_report("Error while reading offset %" PRId64 ": %s",
1069
                                 sectors_to_bytes(sector_num), strerror(-ret));
1070
                    ret = 4;
1071
                }
1072
                goto out;
1073
            }
1074
        }
1075
        sector_num += nb_sectors;
1076
        qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1077
    }
1078

    
1079
    if (total_sectors1 != total_sectors2) {
1080
        BlockDriverState *bs_over;
1081
        int64_t total_sectors_over;
1082
        const char *filename_over;
1083

    
1084
        qprintf(quiet, "Warning: Image size mismatch!\n");
1085
        if (total_sectors1 > total_sectors2) {
1086
            total_sectors_over = total_sectors1;
1087
            bs_over = bs1;
1088
            filename_over = filename1;
1089
        } else {
1090
            total_sectors_over = total_sectors2;
1091
            bs_over = bs2;
1092
            filename_over = filename2;
1093
        }
1094

    
1095
        for (;;) {
1096
            nb_sectors = sectors_to_process(total_sectors_over, sector_num);
1097
            if (nb_sectors <= 0) {
1098
                break;
1099
            }
1100
            ret = bdrv_is_allocated_above(bs_over, NULL, sector_num,
1101
                                          nb_sectors, &pnum);
1102
            if (ret < 0) {
1103
                ret = 3;
1104
                error_report("Sector allocation test failed for %s",
1105
                             filename_over);
1106
                goto out;
1107

    
1108
            }
1109
            nb_sectors = pnum;
1110
            if (ret) {
1111
                ret = check_empty_sectors(bs_over, sector_num, nb_sectors,
1112
                                          filename_over, buf1, quiet);
1113
                if (ret) {
1114
                    if (ret < 0) {
1115
                        error_report("Error while reading offset %" PRId64
1116
                                     " of %s: %s", sectors_to_bytes(sector_num),
1117
                                     filename_over, strerror(-ret));
1118
                        ret = 4;
1119
                    }
1120
                    goto out;
1121
                }
1122
            }
1123
            sector_num += nb_sectors;
1124
            qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1125
        }
1126
    }
1127

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

    
1131
out:
1132
    bdrv_unref(bs2);
1133
    qemu_vfree(buf1);
1134
    qemu_vfree(buf2);
1135
out2:
1136
    bdrv_unref(bs1);
1137
out3:
1138
    qemu_progress_end();
1139
    return ret;
1140
}
1141

    
1142
static int img_convert(int argc, char **argv)
1143
{
1144
    int c, n, n1, bs_n, bs_i, compress, cluster_sectors, skip_create;
1145
    int64_t ret = 0;
1146
    int progress = 0, flags;
1147
    const char *fmt, *out_fmt, *cache, *out_baseimg, *out_filename;
1148
    BlockDriver *drv, *proto_drv;
1149
    BlockDriverState **bs = NULL, *out_bs = NULL;
1150
    int64_t total_sectors, nb_sectors, sector_num, bs_offset;
1151
    uint64_t bs_sectors;
1152
    uint8_t * buf = NULL;
1153
    size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
1154
    const uint8_t *buf1;
1155
    BlockDriverInfo bdi;
1156
    QEMUOptionParameter *param = NULL, *create_options = NULL;
1157
    QEMUOptionParameter *out_baseimg_param;
1158
    char *options = NULL;
1159
    const char *snapshot_name = NULL;
1160
    int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1161
    bool quiet = false;
1162
    Error *local_err = NULL;
1163
    QemuOpts *sn_opts = NULL;
1164

    
1165
    /* Initialize before goto out */
1166
    qemu_progress_init(progress, 1.0);
1167

    
1168
    fmt = NULL;
1169
    out_fmt = "raw";
1170
    cache = "unsafe";
1171
    out_baseimg = NULL;
1172
    compress = 0;
1173
    skip_create = 0;
1174
    for(;;) {
1175
        c = getopt(argc, argv, "f:O:B:s:hce6o:pS:t:qnl:");
1176
        if (c == -1) {
1177
            break;
1178
        }
1179
        switch(c) {
1180
        case '?':
1181
        case 'h':
1182
            help();
1183
            break;
1184
        case 'f':
1185
            fmt = optarg;
1186
            break;
1187
        case 'O':
1188
            out_fmt = optarg;
1189
            break;
1190
        case 'B':
1191
            out_baseimg = optarg;
1192
            break;
1193
        case 'c':
1194
            compress = 1;
1195
            break;
1196
        case 'e':
1197
            error_report("option -e is deprecated, please use \'-o "
1198
                  "encryption\' instead!");
1199
            ret = -1;
1200
            goto out;
1201
        case '6':
1202
            error_report("option -6 is deprecated, please use \'-o "
1203
                  "compat6\' instead!");
1204
            ret = -1;
1205
            goto out;
1206
        case 'o':
1207
            if (!is_valid_option_list(optarg)) {
1208
                error_report("Invalid option list: %s", optarg);
1209
                ret = -1;
1210
                goto out;
1211
            }
1212
            if (!options) {
1213
                options = g_strdup(optarg);
1214
            } else {
1215
                char *old_options = options;
1216
                options = g_strdup_printf("%s,%s", options, optarg);
1217
                g_free(old_options);
1218
            }
1219
            break;
1220
        case 's':
1221
            snapshot_name = optarg;
1222
            break;
1223
        case 'l':
1224
            if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
1225
                sn_opts = qemu_opts_parse(&internal_snapshot_opts, optarg, 0);
1226
                if (!sn_opts) {
1227
                    error_report("Failed in parsing snapshot param '%s'",
1228
                                 optarg);
1229
                    ret = -1;
1230
                    goto out;
1231
                }
1232
            } else {
1233
                snapshot_name = optarg;
1234
            }
1235
            break;
1236
        case 'S':
1237
        {
1238
            int64_t sval;
1239
            char *end;
1240
            sval = strtosz_suffix(optarg, &end, STRTOSZ_DEFSUFFIX_B);
1241
            if (sval < 0 || *end) {
1242
                error_report("Invalid minimum zero buffer size for sparse output specified");
1243
                ret = -1;
1244
                goto out;
1245
            }
1246

    
1247
            min_sparse = sval / BDRV_SECTOR_SIZE;
1248
            break;
1249
        }
1250
        case 'p':
1251
            progress = 1;
1252
            break;
1253
        case 't':
1254
            cache = optarg;
1255
            break;
1256
        case 'q':
1257
            quiet = true;
1258
            break;
1259
        case 'n':
1260
            skip_create = 1;
1261
            break;
1262
        }
1263
    }
1264

    
1265
    if (quiet) {
1266
        progress = 0;
1267
    }
1268

    
1269
    bs_n = argc - optind - 1;
1270
    out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
1271

    
1272
    if (options && has_help_option(options)) {
1273
        ret = print_block_option_help(out_filename, out_fmt);
1274
        goto out;
1275
    }
1276

    
1277
    if (bs_n < 1) {
1278
        help();
1279
    }
1280

    
1281

    
1282
    if (bs_n > 1 && out_baseimg) {
1283
        error_report("-B makes no sense when concatenating multiple input "
1284
                     "images");
1285
        ret = -1;
1286
        goto out;
1287
    }
1288

    
1289
    qemu_progress_print(0, 100);
1290

    
1291
    bs = g_malloc0(bs_n * sizeof(BlockDriverState *));
1292

    
1293
    total_sectors = 0;
1294
    for (bs_i = 0; bs_i < bs_n; bs_i++) {
1295
        bs[bs_i] = bdrv_new_open(argv[optind + bs_i], fmt, BDRV_O_FLAGS, true,
1296
                                 quiet);
1297
        if (!bs[bs_i]) {
1298
            error_report("Could not open '%s'", argv[optind + bs_i]);
1299
            ret = -1;
1300
            goto out;
1301
        }
1302
        bdrv_get_geometry(bs[bs_i], &bs_sectors);
1303
        total_sectors += bs_sectors;
1304
    }
1305

    
1306
    if (sn_opts) {
1307
        ret = bdrv_snapshot_load_tmp(bs[0],
1308
                                     qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
1309
                                     qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
1310
                                     &local_err);
1311
    } else if (snapshot_name != NULL) {
1312
        if (bs_n > 1) {
1313
            error_report("No support for concatenating multiple snapshot");
1314
            ret = -1;
1315
            goto out;
1316
        }
1317

    
1318
        bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1319
    }
1320
    if (local_err) {
1321
        error_report("Failed to load snapshot: %s",
1322
                     error_get_pretty(local_err));
1323
        error_free(local_err);
1324
        ret = -1;
1325
        goto out;
1326
    }
1327

    
1328
    /* Find driver and parse its options */
1329
    drv = bdrv_find_format(out_fmt);
1330
    if (!drv) {
1331
        error_report("Unknown file format '%s'", out_fmt);
1332
        ret = -1;
1333
        goto out;
1334
    }
1335

    
1336
    proto_drv = bdrv_find_protocol(out_filename, true);
1337
    if (!proto_drv) {
1338
        error_report("Unknown protocol '%s'", out_filename);
1339
        ret = -1;
1340
        goto out;
1341
    }
1342

    
1343
    create_options = append_option_parameters(create_options,
1344
                                              drv->create_options);
1345
    create_options = append_option_parameters(create_options,
1346
                                              proto_drv->create_options);
1347

    
1348
    if (options) {
1349
        param = parse_option_parameters(options, create_options, param);
1350
        if (param == NULL) {
1351
            error_report("Invalid options for file format '%s'.", out_fmt);
1352
            ret = -1;
1353
            goto out;
1354
        }
1355
    } else {
1356
        param = parse_option_parameters("", create_options, param);
1357
    }
1358

    
1359
    set_option_parameter_int(param, BLOCK_OPT_SIZE, total_sectors * 512);
1360
    ret = add_old_style_options(out_fmt, param, out_baseimg, NULL);
1361
    if (ret < 0) {
1362
        goto out;
1363
    }
1364

    
1365
    /* Get backing file name if -o backing_file was used */
1366
    out_baseimg_param = get_option_parameter(param, BLOCK_OPT_BACKING_FILE);
1367
    if (out_baseimg_param) {
1368
        out_baseimg = out_baseimg_param->value.s;
1369
    }
1370

    
1371
    /* Check if compression is supported */
1372
    if (compress) {
1373
        QEMUOptionParameter *encryption =
1374
            get_option_parameter(param, BLOCK_OPT_ENCRYPT);
1375
        QEMUOptionParameter *preallocation =
1376
            get_option_parameter(param, BLOCK_OPT_PREALLOC);
1377

    
1378
        if (!drv->bdrv_write_compressed) {
1379
            error_report("Compression not supported for this file format");
1380
            ret = -1;
1381
            goto out;
1382
        }
1383

    
1384
        if (encryption && encryption->value.n) {
1385
            error_report("Compression and encryption not supported at "
1386
                         "the same time");
1387
            ret = -1;
1388
            goto out;
1389
        }
1390

    
1391
        if (preallocation && preallocation->value.s
1392
            && strcmp(preallocation->value.s, "off"))
1393
        {
1394
            error_report("Compression and preallocation not supported at "
1395
                         "the same time");
1396
            ret = -1;
1397
            goto out;
1398
        }
1399
    }
1400

    
1401
    if (!skip_create) {
1402
        /* Create the new image */
1403
        ret = bdrv_create(drv, out_filename, param, &local_err);
1404
        if (ret < 0) {
1405
            error_report("%s: error while converting %s: %s",
1406
                         out_filename, out_fmt, error_get_pretty(local_err));
1407
            error_free(local_err);
1408
            goto out;
1409
        }
1410
    }
1411

    
1412
    flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
1413
    ret = bdrv_parse_cache_flags(cache, &flags);
1414
    if (ret < 0) {
1415
        error_report("Invalid cache option: %s", cache);
1416
        return -1;
1417
    }
1418

    
1419
    out_bs = bdrv_new_open(out_filename, out_fmt, flags, true, quiet);
1420
    if (!out_bs) {
1421
        ret = -1;
1422
        goto out;
1423
    }
1424

    
1425
    bs_i = 0;
1426
    bs_offset = 0;
1427
    bdrv_get_geometry(bs[0], &bs_sectors);
1428

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

    
1437
    buf = qemu_blockalign(out_bs, bufsectors * BDRV_SECTOR_SIZE);
1438

    
1439
    if (skip_create) {
1440
        int64_t output_length = bdrv_getlength(out_bs);
1441
        if (output_length < 0) {
1442
            error_report("unable to get output image length: %s\n",
1443
                         strerror(-output_length));
1444
            ret = -1;
1445
            goto out;
1446
        } else if (output_length < total_sectors << BDRV_SECTOR_BITS) {
1447
            error_report("output file is smaller than input file");
1448
            ret = -1;
1449
            goto out;
1450
        }
1451
    }
1452

    
1453
    cluster_sectors = 0;
1454
    ret = bdrv_get_info(out_bs, &bdi);
1455
    if (ret < 0) {
1456
        if (compress) {
1457
            error_report("could not get block driver info");
1458
            goto out;
1459
        }
1460
    } else {
1461
        cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
1462
    }
1463

    
1464
    if (compress) {
1465
        if (cluster_sectors <= 0 || cluster_sectors > bufsectors) {
1466
            error_report("invalid cluster size");
1467
            ret = -1;
1468
            goto out;
1469
        }
1470
        sector_num = 0;
1471

    
1472
        nb_sectors = total_sectors;
1473

    
1474
        for(;;) {
1475
            int64_t bs_num;
1476
            int remainder;
1477
            uint8_t *buf2;
1478

    
1479
            nb_sectors = total_sectors - sector_num;
1480
            if (nb_sectors <= 0)
1481
                break;
1482
            if (nb_sectors >= cluster_sectors)
1483
                n = cluster_sectors;
1484
            else
1485
                n = nb_sectors;
1486

    
1487
            bs_num = sector_num - bs_offset;
1488
            assert (bs_num >= 0);
1489
            remainder = n;
1490
            buf2 = buf;
1491
            while (remainder > 0) {
1492
                int nlow;
1493
                while (bs_num == bs_sectors) {
1494
                    bs_i++;
1495
                    assert (bs_i < bs_n);
1496
                    bs_offset += bs_sectors;
1497
                    bdrv_get_geometry(bs[bs_i], &bs_sectors);
1498
                    bs_num = 0;
1499
                    /* printf("changing part: sector_num=%" PRId64 ", "
1500
                       "bs_i=%d, bs_offset=%" PRId64 ", bs_sectors=%" PRId64
1501
                       "\n", sector_num, bs_i, bs_offset, bs_sectors); */
1502
                }
1503
                assert (bs_num < bs_sectors);
1504

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

    
1507
                ret = bdrv_read(bs[bs_i], bs_num, buf2, nlow);
1508
                if (ret < 0) {
1509
                    error_report("error while reading sector %" PRId64 ": %s",
1510
                                 bs_num, strerror(-ret));
1511
                    goto out;
1512
                }
1513

    
1514
                buf2 += nlow * 512;
1515
                bs_num += nlow;
1516

    
1517
                remainder -= nlow;
1518
            }
1519
            assert (remainder == 0);
1520

    
1521
            if (!buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)) {
1522
                ret = bdrv_write_compressed(out_bs, sector_num, buf, n);
1523
                if (ret != 0) {
1524
                    error_report("error while compressing sector %" PRId64
1525
                                 ": %s", sector_num, strerror(-ret));
1526
                    goto out;
1527
                }
1528
            }
1529
            sector_num += n;
1530
            qemu_progress_print(100.0 * sector_num / total_sectors, 0);
1531
        }
1532
        /* signal EOF to align */
1533
        bdrv_write_compressed(out_bs, 0, NULL, 0);
1534
    } else {
1535
        int64_t sectors_to_read, sectors_read, sector_num_next_status;
1536
        bool count_allocated_sectors;
1537
        int has_zero_init = min_sparse ? bdrv_has_zero_init(out_bs) : 0;
1538

    
1539
        if (!has_zero_init && bdrv_can_write_zeroes_with_unmap(out_bs)) {
1540
            ret = bdrv_make_zero(out_bs, BDRV_REQ_MAY_UNMAP);
1541
            if (ret < 0) {
1542
                goto out;
1543
            }
1544
            has_zero_init = 1;
1545
        }
1546

    
1547
        sectors_to_read = total_sectors;
1548
        count_allocated_sectors = progress && (out_baseimg || has_zero_init);
1549
restart:
1550
        sector_num = 0; // total number of sectors converted so far
1551
        sectors_read = 0;
1552
        sector_num_next_status = 0;
1553

    
1554
        for(;;) {
1555
            nb_sectors = total_sectors - sector_num;
1556
            if (nb_sectors <= 0) {
1557
                if (count_allocated_sectors) {
1558
                    sectors_to_read = sectors_read;
1559
                    count_allocated_sectors = false;
1560
                    goto restart;
1561
                }
1562
                ret = 0;
1563
                break;
1564
            }
1565

    
1566
            while (sector_num - bs_offset >= bs_sectors) {
1567
                bs_i ++;
1568
                assert (bs_i < bs_n);
1569
                bs_offset += bs_sectors;
1570
                bdrv_get_geometry(bs[bs_i], &bs_sectors);
1571
                /* printf("changing part: sector_num=%" PRId64 ", bs_i=%d, "
1572
                  "bs_offset=%" PRId64 ", bs_sectors=%" PRId64 "\n",
1573
                   sector_num, bs_i, bs_offset, bs_sectors); */
1574
            }
1575

    
1576
            if ((out_baseimg || has_zero_init) &&
1577
                sector_num >= sector_num_next_status) {
1578
                n = nb_sectors > INT_MAX ? INT_MAX : nb_sectors;
1579
                ret = bdrv_get_block_status(bs[bs_i], sector_num - bs_offset,
1580
                                            n, &n1);
1581
                if (ret < 0) {
1582
                    error_report("error while reading block status of sector %"
1583
                                 PRId64 ": %s", sector_num - bs_offset,
1584
                                 strerror(-ret));
1585
                    goto out;
1586
                }
1587
                /* If the output image is zero initialized, we are not working
1588
                 * on a shared base and the input is zero we can skip the next
1589
                 * n1 sectors */
1590
                if (has_zero_init && !out_baseimg && (ret & BDRV_BLOCK_ZERO)) {
1591
                    sector_num += n1;
1592
                    continue;
1593
                }
1594
                /* If the output image is being created as a copy on write
1595
                 * image, assume that sectors which are unallocated in the
1596
                 * input image are present in both the output's and input's
1597
                 * base images (no need to copy them). */
1598
                if (out_baseimg) {
1599
                    if (!(ret & BDRV_BLOCK_DATA)) {
1600
                        sector_num += n1;
1601
                        continue;
1602
                    }
1603
                    /* The next 'n1' sectors are allocated in the input image.
1604
                     * Copy only those as they may be followed by unallocated
1605
                     * sectors. */
1606
                    nb_sectors = n1;
1607
                }
1608
                /* avoid redundant callouts to get_block_status */
1609
                sector_num_next_status = sector_num + n1;
1610
            }
1611

    
1612
            n = MIN(nb_sectors, bufsectors);
1613

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

    
1626
            n = MIN(n, bs_sectors - (sector_num - bs_offset));
1627

    
1628
            sectors_read += n;
1629
            if (count_allocated_sectors) {
1630
                sector_num += n;
1631
                continue;
1632
            }
1633

    
1634
            n1 = n;
1635
            ret = bdrv_read(bs[bs_i], sector_num - bs_offset, buf, n);
1636
            if (ret < 0) {
1637
                error_report("error while reading sector %" PRId64 ": %s",
1638
                             sector_num - bs_offset, strerror(-ret));
1639
                goto out;
1640
            }
1641
            /* NOTE: at the same time we convert, we do not write zero
1642
               sectors to have a chance to compress the image. Ideally, we
1643
               should add a specific call to have the info to go faster */
1644
            buf1 = buf;
1645
            while (n > 0) {
1646
                if (!has_zero_init ||
1647
                    is_allocated_sectors_min(buf1, n, &n1, min_sparse)) {
1648
                    ret = bdrv_write(out_bs, sector_num, buf1, n1);
1649
                    if (ret < 0) {
1650
                        error_report("error while writing sector %" PRId64
1651
                                     ": %s", sector_num, strerror(-ret));
1652
                        goto out;
1653
                    }
1654
                }
1655
                sector_num += n1;
1656
                n -= n1;
1657
                buf1 += n1 * 512;
1658
            }
1659
            qemu_progress_print(100.0 * sectors_read / sectors_to_read, 0);
1660
        }
1661
    }
1662
out:
1663
    if (!ret) {
1664
        qemu_progress_print(100, 0);
1665
    }
1666
    qemu_progress_end();
1667
    free_option_parameters(create_options);
1668
    free_option_parameters(param);
1669
    qemu_vfree(buf);
1670
    g_free(options);
1671
    if (sn_opts) {
1672
        qemu_opts_del(sn_opts);
1673
    }
1674
    if (out_bs) {
1675
        bdrv_unref(out_bs);
1676
    }
1677
    if (bs) {
1678
        for (bs_i = 0; bs_i < bs_n; bs_i++) {
1679
            if (bs[bs_i]) {
1680
                bdrv_unref(bs[bs_i]);
1681
            }
1682
        }
1683
        g_free(bs);
1684
    }
1685
    if (ret) {
1686
        return 1;
1687
    }
1688
    return 0;
1689
}
1690

    
1691

    
1692
static void dump_snapshots(BlockDriverState *bs)
1693
{
1694
    QEMUSnapshotInfo *sn_tab, *sn;
1695
    int nb_sns, i;
1696

    
1697
    nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1698
    if (nb_sns <= 0)
1699
        return;
1700
    printf("Snapshot list:\n");
1701
    bdrv_snapshot_dump(fprintf, stdout, NULL);
1702
    printf("\n");
1703
    for(i = 0; i < nb_sns; i++) {
1704
        sn = &sn_tab[i];
1705
        bdrv_snapshot_dump(fprintf, stdout, sn);
1706
        printf("\n");
1707
    }
1708
    g_free(sn_tab);
1709
}
1710

    
1711
static void dump_json_image_info_list(ImageInfoList *list)
1712
{
1713
    Error *errp = NULL;
1714
    QString *str;
1715
    QmpOutputVisitor *ov = qmp_output_visitor_new();
1716
    QObject *obj;
1717
    visit_type_ImageInfoList(qmp_output_get_visitor(ov),
1718
                             &list, NULL, &errp);
1719
    obj = qmp_output_get_qobject(ov);
1720
    str = qobject_to_json_pretty(obj);
1721
    assert(str != NULL);
1722
    printf("%s\n", qstring_get_str(str));
1723
    qobject_decref(obj);
1724
    qmp_output_visitor_cleanup(ov);
1725
    QDECREF(str);
1726
}
1727

    
1728
static void dump_json_image_info(ImageInfo *info)
1729
{
1730
    Error *errp = NULL;
1731
    QString *str;
1732
    QmpOutputVisitor *ov = qmp_output_visitor_new();
1733
    QObject *obj;
1734
    visit_type_ImageInfo(qmp_output_get_visitor(ov),
1735
                         &info, NULL, &errp);
1736
    obj = qmp_output_get_qobject(ov);
1737
    str = qobject_to_json_pretty(obj);
1738
    assert(str != NULL);
1739
    printf("%s\n", qstring_get_str(str));
1740
    qobject_decref(obj);
1741
    qmp_output_visitor_cleanup(ov);
1742
    QDECREF(str);
1743
}
1744

    
1745
static void dump_human_image_info_list(ImageInfoList *list)
1746
{
1747
    ImageInfoList *elem;
1748
    bool delim = false;
1749

    
1750
    for (elem = list; elem; elem = elem->next) {
1751
        if (delim) {
1752
            printf("\n");
1753
        }
1754
        delim = true;
1755

    
1756
        bdrv_image_info_dump(fprintf, stdout, elem->value);
1757
    }
1758
}
1759

    
1760
static gboolean str_equal_func(gconstpointer a, gconstpointer b)
1761
{
1762
    return strcmp(a, b) == 0;
1763
}
1764

    
1765
/**
1766
 * Open an image file chain and return an ImageInfoList
1767
 *
1768
 * @filename: topmost image filename
1769
 * @fmt: topmost image format (may be NULL to autodetect)
1770
 * @chain: true  - enumerate entire backing file chain
1771
 *         false - only topmost image file
1772
 *
1773
 * Returns a list of ImageInfo objects or NULL if there was an error opening an
1774
 * image file.  If there was an error a message will have been printed to
1775
 * stderr.
1776
 */
1777
static ImageInfoList *collect_image_info_list(const char *filename,
1778
                                              const char *fmt,
1779
                                              bool chain)
1780
{
1781
    ImageInfoList *head = NULL;
1782
    ImageInfoList **last = &head;
1783
    GHashTable *filenames;
1784
    Error *err = NULL;
1785

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

    
1788
    while (filename) {
1789
        BlockDriverState *bs;
1790
        ImageInfo *info;
1791
        ImageInfoList *elem;
1792

    
1793
        if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
1794
            error_report("Backing file '%s' creates an infinite loop.",
1795
                         filename);
1796
            goto err;
1797
        }
1798
        g_hash_table_insert(filenames, (gpointer)filename, NULL);
1799

    
1800
        bs = bdrv_new_open(filename, fmt, BDRV_O_FLAGS | BDRV_O_NO_BACKING,
1801
                           false, false);
1802
        if (!bs) {
1803
            goto err;
1804
        }
1805

    
1806
        bdrv_query_image_info(bs, &info, &err);
1807
        if (err) {
1808
            error_report("%s", error_get_pretty(err));
1809
            error_free(err);
1810
            goto err;
1811
        }
1812

    
1813
        elem = g_new0(ImageInfoList, 1);
1814
        elem->value = info;
1815
        *last = elem;
1816
        last = &elem->next;
1817

    
1818
        bdrv_unref(bs);
1819

    
1820
        filename = fmt = NULL;
1821
        if (chain) {
1822
            if (info->has_full_backing_filename) {
1823
                filename = info->full_backing_filename;
1824
            } else if (info->has_backing_filename) {
1825
                filename = info->backing_filename;
1826
            }
1827
            if (info->has_backing_filename_format) {
1828
                fmt = info->backing_filename_format;
1829
            }
1830
        }
1831
    }
1832
    g_hash_table_destroy(filenames);
1833
    return head;
1834

    
1835
err:
1836
    qapi_free_ImageInfoList(head);
1837
    g_hash_table_destroy(filenames);
1838
    return NULL;
1839
}
1840

    
1841
static int img_info(int argc, char **argv)
1842
{
1843
    int c;
1844
    OutputFormat output_format = OFORMAT_HUMAN;
1845
    bool chain = false;
1846
    const char *filename, *fmt, *output;
1847
    ImageInfoList *list;
1848

    
1849
    fmt = NULL;
1850
    output = NULL;
1851
    for(;;) {
1852
        int option_index = 0;
1853
        static const struct option long_options[] = {
1854
            {"help", no_argument, 0, 'h'},
1855
            {"format", required_argument, 0, 'f'},
1856
            {"output", required_argument, 0, OPTION_OUTPUT},
1857
            {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
1858
            {0, 0, 0, 0}
1859
        };
1860
        c = getopt_long(argc, argv, "f:h",
1861
                        long_options, &option_index);
1862
        if (c == -1) {
1863
            break;
1864
        }
1865
        switch(c) {
1866
        case '?':
1867
        case 'h':
1868
            help();
1869
            break;
1870
        case 'f':
1871
            fmt = optarg;
1872
            break;
1873
        case OPTION_OUTPUT:
1874
            output = optarg;
1875
            break;
1876
        case OPTION_BACKING_CHAIN:
1877
            chain = true;
1878
            break;
1879
        }
1880
    }
1881
    if (optind != argc - 1) {
1882
        help();
1883
    }
1884
    filename = argv[optind++];
1885

    
1886
    if (output && !strcmp(output, "json")) {
1887
        output_format = OFORMAT_JSON;
1888
    } else if (output && !strcmp(output, "human")) {
1889
        output_format = OFORMAT_HUMAN;
1890
    } else if (output) {
1891
        error_report("--output must be used with human or json as argument.");
1892
        return 1;
1893
    }
1894

    
1895
    list = collect_image_info_list(filename, fmt, chain);
1896
    if (!list) {
1897
        return 1;
1898
    }
1899

    
1900
    switch (output_format) {
1901
    case OFORMAT_HUMAN:
1902
        dump_human_image_info_list(list);
1903
        break;
1904
    case OFORMAT_JSON:
1905
        if (chain) {
1906
            dump_json_image_info_list(list);
1907
        } else {
1908
            dump_json_image_info(list->value);
1909
        }
1910
        break;
1911
    }
1912

    
1913
    qapi_free_ImageInfoList(list);
1914
    return 0;
1915
}
1916

    
1917

    
1918
typedef struct MapEntry {
1919
    int flags;
1920
    int depth;
1921
    int64_t start;
1922
    int64_t length;
1923
    int64_t offset;
1924
    BlockDriverState *bs;
1925
} MapEntry;
1926

    
1927
static void dump_map_entry(OutputFormat output_format, MapEntry *e,
1928
                           MapEntry *next)
1929
{
1930
    switch (output_format) {
1931
    case OFORMAT_HUMAN:
1932
        if ((e->flags & BDRV_BLOCK_DATA) &&
1933
            !(e->flags & BDRV_BLOCK_OFFSET_VALID)) {
1934
            error_report("File contains external, encrypted or compressed clusters.");
1935
            exit(1);
1936
        }
1937
        if ((e->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) == BDRV_BLOCK_DATA) {
1938
            printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
1939
                   e->start, e->length, e->offset, e->bs->filename);
1940
        }
1941
        /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
1942
         * Modify the flags here to allow more coalescing.
1943
         */
1944
        if (next &&
1945
            (next->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) != BDRV_BLOCK_DATA) {
1946
            next->flags &= ~BDRV_BLOCK_DATA;
1947
            next->flags |= BDRV_BLOCK_ZERO;
1948
        }
1949
        break;
1950
    case OFORMAT_JSON:
1951
        printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64", \"depth\": %d,"
1952
               " \"zero\": %s, \"data\": %s",
1953
               (e->start == 0 ? "[" : ",\n"),
1954
               e->start, e->length, e->depth,
1955
               (e->flags & BDRV_BLOCK_ZERO) ? "true" : "false",
1956
               (e->flags & BDRV_BLOCK_DATA) ? "true" : "false");
1957
        if (e->flags & BDRV_BLOCK_OFFSET_VALID) {
1958
            printf(", \"offset\": %"PRId64"", e->offset);
1959
        }
1960
        putchar('}');
1961

    
1962
        if (!next) {
1963
            printf("]\n");
1964
        }
1965
        break;
1966
    }
1967
}
1968

    
1969
static int get_block_status(BlockDriverState *bs, int64_t sector_num,
1970
                            int nb_sectors, MapEntry *e)
1971
{
1972
    int64_t ret;
1973
    int depth;
1974

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

    
1980
    depth = 0;
1981
    for (;;) {
1982
        ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors);
1983
        if (ret < 0) {
1984
            return ret;
1985
        }
1986
        assert(nb_sectors);
1987
        if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
1988
            break;
1989
        }
1990
        bs = bs->backing_hd;
1991
        if (bs == NULL) {
1992
            ret = 0;
1993
            break;
1994
        }
1995

    
1996
        depth++;
1997
    }
1998

    
1999
    e->start = sector_num * BDRV_SECTOR_SIZE;
2000
    e->length = nb_sectors * BDRV_SECTOR_SIZE;
2001
    e->flags = ret & ~BDRV_BLOCK_OFFSET_MASK;
2002
    e->offset = ret & BDRV_BLOCK_OFFSET_MASK;
2003
    e->depth = depth;
2004
    e->bs = bs;
2005
    return 0;
2006
}
2007

    
2008
static int img_map(int argc, char **argv)
2009
{
2010
    int c;
2011
    OutputFormat output_format = OFORMAT_HUMAN;
2012
    BlockDriverState *bs;
2013
    const char *filename, *fmt, *output;
2014
    int64_t length;
2015
    MapEntry curr = { .length = 0 }, next;
2016
    int ret = 0;
2017

    
2018
    fmt = NULL;
2019
    output = NULL;
2020
    for (;;) {
2021
        int option_index = 0;
2022
        static const struct option long_options[] = {
2023
            {"help", no_argument, 0, 'h'},
2024
            {"format", required_argument, 0, 'f'},
2025
            {"output", required_argument, 0, OPTION_OUTPUT},
2026
            {0, 0, 0, 0}
2027
        };
2028
        c = getopt_long(argc, argv, "f:h",
2029
                        long_options, &option_index);
2030
        if (c == -1) {
2031
            break;
2032
        }
2033
        switch (c) {
2034
        case '?':
2035
        case 'h':
2036
            help();
2037
            break;
2038
        case 'f':
2039
            fmt = optarg;
2040
            break;
2041
        case OPTION_OUTPUT:
2042
            output = optarg;
2043
            break;
2044
        }
2045
    }
2046
    if (optind >= argc) {
2047
        help();
2048
    }
2049
    filename = argv[optind++];
2050

    
2051
    if (output && !strcmp(output, "json")) {
2052
        output_format = OFORMAT_JSON;
2053
    } else if (output && !strcmp(output, "human")) {
2054
        output_format = OFORMAT_HUMAN;
2055
    } else if (output) {
2056
        error_report("--output must be used with human or json as argument.");
2057
        return 1;
2058
    }
2059

    
2060
    bs = bdrv_new_open(filename, fmt, BDRV_O_FLAGS, true, false);
2061
    if (!bs) {
2062
        return 1;
2063
    }
2064

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

    
2069
    length = bdrv_getlength(bs);
2070
    while (curr.start + curr.length < length) {
2071
        int64_t nsectors_left;
2072
        int64_t sector_num;
2073
        int n;
2074

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

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

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

    
2087
        if (curr.length != 0 && curr.flags == next.flags &&
2088
            curr.depth == next.depth &&
2089
            ((curr.flags & BDRV_BLOCK_OFFSET_VALID) == 0 ||
2090
             curr.offset + curr.length == next.offset)) {
2091
            curr.length += next.length;
2092
            continue;
2093
        }
2094

    
2095
        if (curr.length > 0) {
2096
            dump_map_entry(output_format, &curr, &next);
2097
        }
2098
        curr = next;
2099
    }
2100

    
2101
    dump_map_entry(output_format, &curr, NULL);
2102

    
2103
out:
2104
    bdrv_unref(bs);
2105
    return ret < 0;
2106
}
2107

    
2108
#define SNAPSHOT_LIST   1
2109
#define SNAPSHOT_CREATE 2
2110
#define SNAPSHOT_APPLY  3
2111
#define SNAPSHOT_DELETE 4
2112

    
2113
static int img_snapshot(int argc, char **argv)
2114
{
2115
    BlockDriverState *bs;
2116
    QEMUSnapshotInfo sn;
2117
    char *filename, *snapshot_name = NULL;
2118
    int c, ret = 0, bdrv_oflags;
2119
    int action = 0;
2120
    qemu_timeval tv;
2121
    bool quiet = false;
2122
    Error *err = NULL;
2123

    
2124
    bdrv_oflags = BDRV_O_FLAGS | BDRV_O_RDWR;
2125
    /* Parse commandline parameters */
2126
    for(;;) {
2127
        c = getopt(argc, argv, "la:c:d:hq");
2128
        if (c == -1) {
2129
            break;
2130
        }
2131
        switch(c) {
2132
        case '?':
2133
        case 'h':
2134
            help();
2135
            return 0;
2136
        case 'l':
2137
            if (action) {
2138
                help();
2139
                return 0;
2140
            }
2141
            action = SNAPSHOT_LIST;
2142
            bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2143
            break;
2144
        case 'a':
2145
            if (action) {
2146
                help();
2147
                return 0;
2148
            }
2149
            action = SNAPSHOT_APPLY;
2150
            snapshot_name = optarg;
2151
            break;
2152
        case 'c':
2153
            if (action) {
2154
                help();
2155
                return 0;
2156
            }
2157
            action = SNAPSHOT_CREATE;
2158
            snapshot_name = optarg;
2159
            break;
2160
        case 'd':
2161
            if (action) {
2162
                help();
2163
                return 0;
2164
            }
2165
            action = SNAPSHOT_DELETE;
2166
            snapshot_name = optarg;
2167
            break;
2168
        case 'q':
2169
            quiet = true;
2170
            break;
2171
        }
2172
    }
2173

    
2174
    if (optind != argc - 1) {
2175
        help();
2176
    }
2177
    filename = argv[optind++];
2178

    
2179
    /* Open the image */
2180
    bs = bdrv_new_open(filename, NULL, bdrv_oflags, true, quiet);
2181
    if (!bs) {
2182
        return 1;
2183
    }
2184

    
2185
    /* Perform the requested action */
2186
    switch(action) {
2187
    case SNAPSHOT_LIST:
2188
        dump_snapshots(bs);
2189
        break;
2190

    
2191
    case SNAPSHOT_CREATE:
2192
        memset(&sn, 0, sizeof(sn));
2193
        pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
2194

    
2195
        qemu_gettimeofday(&tv);
2196
        sn.date_sec = tv.tv_sec;
2197
        sn.date_nsec = tv.tv_usec * 1000;
2198

    
2199
        ret = bdrv_snapshot_create(bs, &sn);
2200
        if (ret) {
2201
            error_report("Could not create snapshot '%s': %d (%s)",
2202
                snapshot_name, ret, strerror(-ret));
2203
        }
2204
        break;
2205

    
2206
    case SNAPSHOT_APPLY:
2207
        ret = bdrv_snapshot_goto(bs, snapshot_name);
2208
        if (ret) {
2209
            error_report("Could not apply snapshot '%s': %d (%s)",
2210
                snapshot_name, ret, strerror(-ret));
2211
        }
2212
        break;
2213

    
2214
    case SNAPSHOT_DELETE:
2215
        bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2216
        if (err) {
2217
            error_report("Could not delete snapshot '%s': (%s)",
2218
                         snapshot_name, error_get_pretty(err));
2219
            error_free(err);
2220
            ret = 1;
2221
        }
2222
        break;
2223
    }
2224

    
2225
    /* Cleanup */
2226
    bdrv_unref(bs);
2227
    if (ret) {
2228
        return 1;
2229
    }
2230
    return 0;
2231
}
2232

    
2233
static int img_rebase(int argc, char **argv)
2234
{
2235
    BlockDriverState *bs, *bs_old_backing = NULL, *bs_new_backing = NULL;
2236
    BlockDriver *old_backing_drv, *new_backing_drv;
2237
    char *filename;
2238
    const char *fmt, *cache, *out_basefmt, *out_baseimg;
2239
    int c, flags, ret;
2240
    int unsafe = 0;
2241
    int progress = 0;
2242
    bool quiet = false;
2243
    Error *local_err = NULL;
2244

    
2245
    /* Parse commandline parameters */
2246
    fmt = NULL;
2247
    cache = BDRV_DEFAULT_CACHE;
2248
    out_baseimg = NULL;
2249
    out_basefmt = NULL;
2250
    for(;;) {
2251
        c = getopt(argc, argv, "uhf:F:b:pt:q");
2252
        if (c == -1) {
2253
            break;
2254
        }
2255
        switch(c) {
2256
        case '?':
2257
        case 'h':
2258
            help();
2259
            return 0;
2260
        case 'f':
2261
            fmt = optarg;
2262
            break;
2263
        case 'F':
2264
            out_basefmt = optarg;
2265
            break;
2266
        case 'b':
2267
            out_baseimg = optarg;
2268
            break;
2269
        case 'u':
2270
            unsafe = 1;
2271
            break;
2272
        case 'p':
2273
            progress = 1;
2274
            break;
2275
        case 't':
2276
            cache = optarg;
2277
            break;
2278
        case 'q':
2279
            quiet = true;
2280
            break;
2281
        }
2282
    }
2283

    
2284
    if (quiet) {
2285
        progress = 0;
2286
    }
2287

    
2288
    if ((optind != argc - 1) || (!unsafe && !out_baseimg)) {
2289
        help();
2290
    }
2291
    filename = argv[optind++];
2292

    
2293
    qemu_progress_init(progress, 2.0);
2294
    qemu_progress_print(0, 100);
2295

    
2296
    flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2297
    ret = bdrv_parse_cache_flags(cache, &flags);
2298
    if (ret < 0) {
2299
        error_report("Invalid cache option: %s", cache);
2300
        return -1;
2301
    }
2302

    
2303
    /*
2304
     * Open the images.
2305
     *
2306
     * Ignore the old backing file for unsafe rebase in case we want to correct
2307
     * the reference to a renamed or moved backing file.
2308
     */
2309
    bs = bdrv_new_open(filename, fmt, flags, true, quiet);
2310
    if (!bs) {
2311
        return 1;
2312
    }
2313

    
2314
    /* Find the right drivers for the backing files */
2315
    old_backing_drv = NULL;
2316
    new_backing_drv = NULL;
2317

    
2318
    if (!unsafe && bs->backing_format[0] != '\0') {
2319
        old_backing_drv = bdrv_find_format(bs->backing_format);
2320
        if (old_backing_drv == NULL) {
2321
            error_report("Invalid format name: '%s'", bs->backing_format);
2322
            ret = -1;
2323
            goto out;
2324
        }
2325
    }
2326

    
2327
    if (out_basefmt != NULL) {
2328
        new_backing_drv = bdrv_find_format(out_basefmt);
2329
        if (new_backing_drv == NULL) {
2330
            error_report("Invalid format name: '%s'", out_basefmt);
2331
            ret = -1;
2332
            goto out;
2333
        }
2334
    }
2335

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

    
2344
        bs_old_backing = bdrv_new("old_backing");
2345
        bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2346
        ret = bdrv_open(&bs_old_backing, backing_name, NULL, NULL, BDRV_O_FLAGS,
2347
                        old_backing_drv, &local_err);
2348
        if (ret) {
2349
            error_report("Could not open old backing file '%s': %s",
2350
                         backing_name, error_get_pretty(local_err));
2351
            error_free(local_err);
2352
            goto out;
2353
        }
2354
        if (out_baseimg[0]) {
2355
            bs_new_backing = bdrv_new("new_backing");
2356
            ret = bdrv_open(&bs_new_backing, out_baseimg, NULL, NULL,
2357
                            BDRV_O_FLAGS, new_backing_drv, &local_err);
2358
            if (ret) {
2359
                error_report("Could not open new backing file '%s': %s",
2360
                             out_baseimg, error_get_pretty(local_err));
2361
                error_free(local_err);
2362
                goto out;
2363
            }
2364
        }
2365
    }
2366

    
2367
    /*
2368
     * Check each unallocated cluster in the COW file. If it is unallocated,
2369
     * accesses go to the backing file. We must therefore compare this cluster
2370
     * in the old and new backing file, and if they differ we need to copy it
2371
     * from the old backing file into the COW file.
2372
     *
2373
     * If qemu-img crashes during this step, no harm is done. The content of
2374
     * the image is the same as the original one at any time.
2375
     */
2376
    if (!unsafe) {
2377
        uint64_t num_sectors;
2378
        uint64_t old_backing_num_sectors;
2379
        uint64_t new_backing_num_sectors = 0;
2380
        uint64_t sector;
2381
        int n;
2382
        uint8_t * buf_old;
2383
        uint8_t * buf_new;
2384
        float local_progress = 0;
2385

    
2386
        buf_old = qemu_blockalign(bs, IO_BUF_SIZE);
2387
        buf_new = qemu_blockalign(bs, IO_BUF_SIZE);
2388

    
2389
        bdrv_get_geometry(bs, &num_sectors);
2390
        bdrv_get_geometry(bs_old_backing, &old_backing_num_sectors);
2391
        if (bs_new_backing) {
2392
            bdrv_get_geometry(bs_new_backing, &new_backing_num_sectors);
2393
        }
2394

    
2395
        if (num_sectors != 0) {
2396
            local_progress = (float)100 /
2397
                (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
2398
        }
2399

    
2400
        for (sector = 0; sector < num_sectors; sector += n) {
2401

    
2402
            /* How many sectors can we handle with the next read? */
2403
            if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
2404
                n = (IO_BUF_SIZE / 512);
2405
            } else {
2406
                n = num_sectors - sector;
2407
            }
2408

    
2409
            /* If the cluster is allocated, we don't need to take action */
2410
            ret = bdrv_is_allocated(bs, sector, n, &n);
2411
            if (ret < 0) {
2412
                error_report("error while reading image metadata: %s",
2413
                             strerror(-ret));
2414
                goto out;
2415
            }
2416
            if (ret) {
2417
                continue;
2418
            }
2419

    
2420
            /*
2421
             * Read old and new backing file and take into consideration that
2422
             * backing files may be smaller than the COW image.
2423
             */
2424
            if (sector >= old_backing_num_sectors) {
2425
                memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
2426
            } else {
2427
                if (sector + n > old_backing_num_sectors) {
2428
                    n = old_backing_num_sectors - sector;
2429
                }
2430

    
2431
                ret = bdrv_read(bs_old_backing, sector, buf_old, n);
2432
                if (ret < 0) {
2433
                    error_report("error while reading from old backing file");
2434
                    goto out;
2435
                }
2436
            }
2437

    
2438
            if (sector >= new_backing_num_sectors || !bs_new_backing) {
2439
                memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
2440
            } else {
2441
                if (sector + n > new_backing_num_sectors) {
2442
                    n = new_backing_num_sectors - sector;
2443
                }
2444

    
2445
                ret = bdrv_read(bs_new_backing, sector, buf_new, n);
2446
                if (ret < 0) {
2447
                    error_report("error while reading from new backing file");
2448
                    goto out;
2449
                }
2450
            }
2451

    
2452
            /* If they differ, we need to write to the COW file */
2453
            uint64_t written = 0;
2454

    
2455
            while (written < n) {
2456
                int pnum;
2457

    
2458
                if (compare_sectors(buf_old + written * 512,
2459
                    buf_new + written * 512, n - written, &pnum))
2460
                {
2461
                    ret = bdrv_write(bs, sector + written,
2462
                        buf_old + written * 512, pnum);
2463
                    if (ret < 0) {
2464
                        error_report("Error while writing to COW image: %s",
2465
                            strerror(-ret));
2466
                        goto out;
2467
                    }
2468
                }
2469

    
2470
                written += pnum;
2471
            }
2472
            qemu_progress_print(local_progress, 100);
2473
        }
2474

    
2475
        qemu_vfree(buf_old);
2476
        qemu_vfree(buf_new);
2477
    }
2478

    
2479
    /*
2480
     * Change the backing file. All clusters that are different from the old
2481
     * backing file are overwritten in the COW file now, so the visible content
2482
     * doesn't change when we switch the backing file.
2483
     */
2484
    if (out_baseimg && *out_baseimg) {
2485
        ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
2486
    } else {
2487
        ret = bdrv_change_backing_file(bs, NULL, NULL);
2488
    }
2489

    
2490
    if (ret == -ENOSPC) {
2491
        error_report("Could not change the backing file to '%s': No "
2492
                     "space left in the file header", out_baseimg);
2493
    } else if (ret < 0) {
2494
        error_report("Could not change the backing file to '%s': %s",
2495
            out_baseimg, strerror(-ret));
2496
    }
2497

    
2498
    qemu_progress_print(100, 0);
2499
    /*
2500
     * TODO At this point it is possible to check if any clusters that are
2501
     * allocated in the COW file are the same in the backing file. If so, they
2502
     * could be dropped from the COW file. Don't do this before switching the
2503
     * backing file, in case of a crash this would lead to corruption.
2504
     */
2505
out:
2506
    qemu_progress_end();
2507
    /* Cleanup */
2508
    if (!unsafe) {
2509
        if (bs_old_backing != NULL) {
2510
            bdrv_unref(bs_old_backing);
2511
        }
2512
        if (bs_new_backing != NULL) {
2513
            bdrv_unref(bs_new_backing);
2514
        }
2515
    }
2516

    
2517
    bdrv_unref(bs);
2518
    if (ret) {
2519
        return 1;
2520
    }
2521
    return 0;
2522
}
2523

    
2524
static int img_resize(int argc, char **argv)
2525
{
2526
    int c, ret, relative;
2527
    const char *filename, *fmt, *size;
2528
    int64_t n, total_size;
2529
    bool quiet = false;
2530
    BlockDriverState *bs = NULL;
2531
    QemuOpts *param;
2532
    static QemuOptsList resize_options = {
2533
        .name = "resize_options",
2534
        .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
2535
        .desc = {
2536
            {
2537
                .name = BLOCK_OPT_SIZE,
2538
                .type = QEMU_OPT_SIZE,
2539
                .help = "Virtual disk size"
2540
            }, {
2541
                /* end of list */
2542
            }
2543
        },
2544
    };
2545

    
2546
    /* Remove size from argv manually so that negative numbers are not treated
2547
     * as options by getopt. */
2548
    if (argc < 3) {
2549
        help();
2550
        return 1;
2551
    }
2552

    
2553
    size = argv[--argc];
2554

    
2555
    /* Parse getopt arguments */
2556
    fmt = NULL;
2557
    for(;;) {
2558
        c = getopt(argc, argv, "f:hq");
2559
        if (c == -1) {
2560
            break;
2561
        }
2562
        switch(c) {
2563
        case '?':
2564
        case 'h':
2565
            help();
2566
            break;
2567
        case 'f':
2568
            fmt = optarg;
2569
            break;
2570
        case 'q':
2571
            quiet = true;
2572
            break;
2573
        }
2574
    }
2575
    if (optind != argc - 1) {
2576
        help();
2577
    }
2578
    filename = argv[optind++];
2579

    
2580
    /* Choose grow, shrink, or absolute resize mode */
2581
    switch (size[0]) {
2582
    case '+':
2583
        relative = 1;
2584
        size++;
2585
        break;
2586
    case '-':
2587
        relative = -1;
2588
        size++;
2589
        break;
2590
    default:
2591
        relative = 0;
2592
        break;
2593
    }
2594

    
2595
    /* Parse size */
2596
    param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
2597
    if (qemu_opt_set(param, BLOCK_OPT_SIZE, size)) {
2598
        /* Error message already printed when size parsing fails */
2599
        ret = -1;
2600
        qemu_opts_del(param);
2601
        goto out;
2602
    }
2603
    n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
2604
    qemu_opts_del(param);
2605

    
2606
    bs = bdrv_new_open(filename, fmt, BDRV_O_FLAGS | BDRV_O_RDWR, true, quiet);
2607
    if (!bs) {
2608
        ret = -1;
2609
        goto out;
2610
    }
2611

    
2612
    if (relative) {
2613
        total_size = bdrv_getlength(bs) + n * relative;
2614
    } else {
2615
        total_size = n;
2616
    }
2617
    if (total_size <= 0) {
2618
        error_report("New image size must be positive");
2619
        ret = -1;
2620
        goto out;
2621
    }
2622

    
2623
    ret = bdrv_truncate(bs, total_size);
2624
    switch (ret) {
2625
    case 0:
2626
        qprintf(quiet, "Image resized.\n");
2627
        break;
2628
    case -ENOTSUP:
2629
        error_report("This image does not support resize");
2630
        break;
2631
    case -EACCES:
2632
        error_report("Image is read-only");
2633
        break;
2634
    default:
2635
        error_report("Error resizing image (%d)", -ret);
2636
        break;
2637
    }
2638
out:
2639
    if (bs) {
2640
        bdrv_unref(bs);
2641
    }
2642
    if (ret) {
2643
        return 1;
2644
    }
2645
    return 0;
2646
}
2647

    
2648
static int img_amend(int argc, char **argv)
2649
{
2650
    int c, ret = 0;
2651
    char *options = NULL;
2652
    QEMUOptionParameter *create_options = NULL, *options_param = NULL;
2653
    const char *fmt = NULL, *filename;
2654
    bool quiet = false;
2655
    BlockDriverState *bs = NULL;
2656

    
2657
    for (;;) {
2658
        c = getopt(argc, argv, "hqf:o:");
2659
        if (c == -1) {
2660
            break;
2661
        }
2662

    
2663
        switch (c) {
2664
            case 'h':
2665
            case '?':
2666
                help();
2667
                break;
2668
            case 'o':
2669
                if (!is_valid_option_list(optarg)) {
2670
                    error_report("Invalid option list: %s", optarg);
2671
                    ret = -1;
2672
                    goto out;
2673
                }
2674
                if (!options) {
2675
                    options = g_strdup(optarg);
2676
                } else {
2677
                    char *old_options = options;
2678
                    options = g_strdup_printf("%s,%s", options, optarg);
2679
                    g_free(old_options);
2680
                }
2681
                break;
2682
            case 'f':
2683
                fmt = optarg;
2684
                break;
2685
            case 'q':
2686
                quiet = true;
2687
                break;
2688
        }
2689
    }
2690

    
2691
    if (!options) {
2692
        help();
2693
    }
2694

    
2695
    filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
2696
    if (fmt && has_help_option(options)) {
2697
        /* If a format is explicitly specified (and possibly no filename is
2698
         * given), print option help here */
2699
        ret = print_block_option_help(filename, fmt);
2700
        goto out;
2701
    }
2702

    
2703
    if (optind != argc - 1) {
2704
        help();
2705
    }
2706

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

    
2714
    fmt = bs->drv->format_name;
2715

    
2716
    if (has_help_option(options)) {
2717
        /* If the format was auto-detected, print option help here */
2718
        ret = print_block_option_help(filename, fmt);
2719
        goto out;
2720
    }
2721

    
2722
    create_options = append_option_parameters(create_options,
2723
            bs->drv->create_options);
2724
    options_param = parse_option_parameters(options, create_options,
2725
            options_param);
2726
    if (options_param == NULL) {
2727
        error_report("Invalid options for file format '%s'", fmt);
2728
        ret = -1;
2729
        goto out;
2730
    }
2731

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

    
2738
out:
2739
    if (bs) {
2740
        bdrv_unref(bs);
2741
    }
2742
    free_option_parameters(create_options);
2743
    free_option_parameters(options_param);
2744
    g_free(options);
2745

    
2746
    if (ret) {
2747
        return 1;
2748
    }
2749
    return 0;
2750
}
2751

    
2752
static const img_cmd_t img_cmds[] = {
2753
#define DEF(option, callback, arg_string)        \
2754
    { option, callback },
2755
#include "qemu-img-cmds.h"
2756
#undef DEF
2757
#undef GEN_DOCS
2758
    { NULL, NULL, },
2759
};
2760

    
2761
int main(int argc, char **argv)
2762
{
2763
    const img_cmd_t *cmd;
2764
    const char *cmdname;
2765

    
2766
#ifdef CONFIG_POSIX
2767
    signal(SIGPIPE, SIG_IGN);
2768
#endif
2769

    
2770
    error_set_progname(argv[0]);
2771
    qemu_init_exec_dir(argv[0]);
2772

    
2773
    qemu_init_main_loop();
2774
    bdrv_init();
2775
    if (argc < 2)
2776
        help();
2777
    cmdname = argv[1];
2778
    argc--; argv++;
2779

    
2780
    /* find the command */
2781
    for(cmd = img_cmds; cmd->name != NULL; cmd++) {
2782
        if (!strcmp(cmdname, cmd->name)) {
2783
            return cmd->handler(argc, argv);
2784
        }
2785
    }
2786

    
2787
    /* not found */
2788
    help();
2789
    return 0;
2790
}