Archipelago » qemu

/*

 * QEMU disk image utility

 *

 * Copyright (c) 2003-2008 Fabrice Bellard

 *

 * Permission is hereby granted, free of charge, to any person obtaining a copy

 * of this software and associated documentation files (the "Software"), to deal

 * in the Software without restriction, including without limitation the rights

 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

 * copies of the Software, and to permit persons to whom the Software is

 * furnished to do so, subject to the following conditions:

 *

 * The above copyright notice and this permission notice shall be included in

 * all copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

 * THE SOFTWARE.

 */

#include "qemu-common.h"

#include "qemu-option.h"

#include "qemu-error.h"

#include "osdep.h"

#include "sysemu.h"

#include "block_int.h"

#include <stdio.h>

#ifdef _WIN32

#include <windows.h>

#endif

typedef struct img_cmd_t {

    const char *name;

    int (*handler)(int argc, char **argv);

} img_cmd_t;

/* Default to cache=writeback as data integrity is not important for qemu-tcg. */

#define BDRV_O_FLAGS BDRV_O_CACHE_WB

#define BDRV_DEFAULT_CACHE "writeback"

static void format_print(void *opaque, const char *name)

{

    printf(" %s", name);

}

/* Please keep in synch with qemu-img.texi */

static void help(void)

{

    const char *help_msg =

           "qemu-img version " QEMU_VERSION ", Copyright (c) 2004-2008 Fabrice Bellard\n"

           "usage: qemu-img command [command options]\n"

           "QEMU disk image utility\n"

           "\n"

           "Command syntax:\n"

#define DEF(option, callback, arg_string)        \

           "  " arg_string "\n"

#include "qemu-img-cmds.h"

#undef DEF

#undef GEN_DOCS

           "\n"

           "Command parameters:\n"

           "  'filename' is a disk image filename\n"

           "  'fmt' is the disk image format. It is guessed automatically in most cases\n"

           "  'cache' is the cache mode used to write the output disk image, the valid\n"

           "    options are: 'none', 'writeback' (default), 'writethrough' and 'unsafe'\n"

           "  'size' is the disk image size in bytes. Optional suffixes\n"

           "    'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M)\n"

           "    and T (terabyte, 1024G) are supported. 'b' is ignored.\n"

           "  'output_filename' is the destination disk image filename\n"

           "  'output_fmt' is the destination format\n"

           "  'options' is a comma separated list of format specific options in a\n"

           "    name=value format. Use -o ? for an overview of the options supported by the\n"

           "    used format\n"

           "  '-c' indicates that target image must be compressed (qcow format only)\n"

           "  '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"

           "       match exactly. The image doesn't need a working backing file before\n"

           "       rebasing in this case (useful for renaming the backing file)\n"

           "  '-h' with or without a command shows this help and lists the supported formats\n"

           "  '-p' show progress of command (only certain commands)\n"

           "\n"

           "Parameters to snapshot subcommand:\n"

           "  'snapshot' is the name of the snapshot to create, apply or delete\n"

           "  '-a' applies a snapshot (revert disk to saved state)\n"

           "  '-c' creates a snapshot\n"

           "  '-d' deletes a snapshot\n"

           "  '-l' lists all snapshots in the given image\n";

    printf("%s\nSupported formats:", help_msg);

    bdrv_iterate_format(format_print, NULL);

    printf("\n");

    exit(1);

}

#if defined(WIN32)

/* XXX: put correct support for win32 */

static int read_password(char *buf, int buf_size)

{

    int c, i;

    printf("Password: ");

    fflush(stdout);

    i = 0;

    for(;;) {

        c = getchar();

        if (c == '\n')

            break;

        if (i < (buf_size - 1))

            buf[i++] = c;

    }

    buf[i] = '\0';

    return 0;

}

#else

#include <termios.h>

static struct termios oldtty;

static void term_exit(void)

{

    tcsetattr (0, TCSANOW, &oldtty);

}

static void term_init(void)

{

    struct termios tty;

    tcgetattr (0, &tty);

    oldtty = tty;

    tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP

                          |INLCR|IGNCR|ICRNL|IXON);

    tty.c_oflag |= OPOST;

    tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);

    tty.c_cflag &= ~(CSIZE|PARENB);

    tty.c_cflag |= CS8;

    tty.c_cc[VMIN] = 1;

    tty.c_cc[VTIME] = 0;

    tcsetattr (0, TCSANOW, &tty);

    atexit(term_exit);

}

static int read_password(char *buf, int buf_size)

{

    uint8_t ch;

    int i, ret;

    printf("password: ");

    fflush(stdout);

    term_init();

    i = 0;

    for(;;) {

        ret = read(0, &ch, 1);

        if (ret == -1) {

            if (errno == EAGAIN || errno == EINTR) {

                continue;

            } else {

                ret = -1;

                break;

            }

        } else if (ret == 0) {

            ret = -1;

            break;

        } else {

            if (ch == '\r') {

                ret = 0;

                break;

            }

            if (i < (buf_size - 1))

                buf[i++] = ch;

        }

    }

    term_exit();

    buf[i] = '\0';

    printf("\n");

    return ret;

}

#endif

static int set_cache_flag(const char *mode, int *flags)

{

    *flags &= ~BDRV_O_CACHE_MASK;

    if (!strcmp(mode, "none") || !strcmp(mode, "off")) {

        *flags |= BDRV_O_CACHE_WB;

        *flags |= BDRV_O_NOCACHE;

    } else if (!strcmp(mode, "writeback")) {

        *flags |= BDRV_O_CACHE_WB;

    } else if (!strcmp(mode, "unsafe")) {

        *flags |= BDRV_O_CACHE_WB;

        *flags |= BDRV_O_NO_FLUSH;

    } else if (!strcmp(mode, "writethrough")) {

        /* this is the default */

    } else {

        return -1;

    }

    return 0;

}

static int print_block_option_help(const char *filename, const char *fmt)

{

    BlockDriver *drv, *proto_drv;

    QEMUOptionParameter *create_options = NULL;

    /* Find driver and parse its options */

    drv = bdrv_find_format(fmt);

    if (!drv) {

        error_report("Unknown file format '%s'", fmt);

        return 1;

    }

    proto_drv = bdrv_find_protocol(filename);

    if (!proto_drv) {

        error_report("Unknown protocol '%s'", filename);

        return 1;

    }

    create_options = append_option_parameters(create_options,

                                              drv->create_options);

    create_options = append_option_parameters(create_options,

                                              proto_drv->create_options);

    print_option_help(create_options);

    free_option_parameters(create_options);

    return 0;

}

static BlockDriverState *bdrv_new_open(const char *filename,

                                       const char *fmt,

                                       int flags)

{

    BlockDriverState *bs;

    BlockDriver *drv;

    char password[256];

    int ret;

    bs = bdrv_new("image");

    if (fmt) {

        drv = bdrv_find_format(fmt);

        if (!drv) {

            error_report("Unknown file format '%s'", fmt);

            goto fail;

        }

    } else {

        drv = NULL;

    }

    ret = bdrv_open(bs, filename, flags, drv);

    if (ret < 0) {

        error_report("Could not open '%s': %s", filename, strerror(-ret));

        goto fail;

    }

    if (bdrv_is_encrypted(bs)) {

        printf("Disk image '%s' is encrypted.\n", filename);

        if (read_password(password, sizeof(password)) < 0) {

            error_report("No password given");

            goto fail;

        }

        if (bdrv_set_key(bs, password) < 0) {

            error_report("invalid password");

            goto fail;

        }

    }

    return bs;

fail:

    if (bs) {

        bdrv_delete(bs);

    }

    return NULL;

}

static int add_old_style_options(const char *fmt, QEMUOptionParameter *list,

                                 const char *base_filename,

                                 const char *base_fmt)

{

    if (base_filename) {

        if (set_option_parameter(list, BLOCK_OPT_BACKING_FILE, base_filename)) {

            error_report("Backing file not supported for file format '%s'",

                         fmt);

            return -1;

        }

    }

    if (base_fmt) {

        if (set_option_parameter(list, BLOCK_OPT_BACKING_FMT, base_fmt)) {

            error_report("Backing file format not supported for file "

                         "format '%s'", fmt);

            return -1;

        }

    }

    return 0;

}

static int img_create(int argc, char **argv)

{

    int c, ret = 0;

    uint64_t img_size = -1;

    const char *fmt = "raw";

    const char *base_fmt = NULL;

    const char *filename;

    const char *base_filename = NULL;

    char *options = NULL;

    for(;;) {

        c = getopt(argc, argv, "F:b:f:he6o:");

        if (c == -1) {

            break;

        }

        switch(c) {

        case '?':

        case 'h':

            help();

            break;

        case 'F':

            base_fmt = optarg;

            break;

        case 'b':

            base_filename = optarg;

            break;

        case 'f':

            fmt = optarg;

            break;

        case 'e':

            error_report("option -e is deprecated, please use \'-o "

                  "encryption\' instead!");

            return 1;

        case '6':

            error_report("option -6 is deprecated, please use \'-o "

                  "compat6\' instead!");

            return 1;

        case 'o':

            options = optarg;

            break;

        }

    }

    /* Get the filename */

    if (optind >= argc) {

        help();

    }

    filename = argv[optind++];

    /* Get image size, if specified */

    if (optind < argc) {

        int64_t sval;

        sval = strtosz_suffix(argv[optind++], NULL, STRTOSZ_DEFSUFFIX_B);

        if (sval < 0) {

            error_report("Invalid image size specified! You may use k, M, G or "

                  "T suffixes for ");

            error_report("kilobytes, megabytes, gigabytes and terabytes.");

            ret = -1;

            goto out;

        }

        img_size = (uint64_t)sval;

    }

    if (options && !strcmp(options, "?")) {

        ret = print_block_option_help(filename, fmt);

        goto out;

    }

    ret = bdrv_img_create(filename, fmt, base_filename, base_fmt,

                          options, img_size, BDRV_O_FLAGS);

out:

    if (ret) {

        return 1;

    }

    return 0;

}

/*

 * Checks an image for consistency. Exit codes:

 *

 * 0 - Check completed, image is good

 * 1 - Check not completed because of internal errors

 * 2 - Check completed, image is corrupted

 * 3 - Check completed, image has leaked clusters, but is good otherwise

 */

static int img_check(int argc, char **argv)

{

    int c, ret;

    const char *filename, *fmt;

    BlockDriverState *bs;

    BdrvCheckResult result;

    fmt = NULL;

    for(;;) {

        c = getopt(argc, argv, "f:h");

        if (c == -1) {

            break;

        }

        switch(c) {

        case '?':

        case 'h':

            help();

            break;

        case 'f':

            fmt = optarg;

            break;

        }

    }

    if (optind >= argc) {

        help();

    }

    filename = argv[optind++];

    bs = bdrv_new_open(filename, fmt, BDRV_O_FLAGS);

    if (!bs) {

        return 1;

    }

    ret = bdrv_check(bs, &result);

    if (ret == -ENOTSUP) {

        error_report("This image format does not support checks");

        bdrv_delete(bs);

        return 1;

    }

    if (!(result.corruptions || result.leaks || result.check_errors)) {

        printf("No errors were found on the image.\n");

    } else {

        if (result.corruptions) {

            printf("\n%d errors were found on the image.\n"

                "Data may be corrupted, or further writes to the image "

                "may corrupt it.\n",

                result.corruptions);

        }

        if (result.leaks) {

            printf("\n%d leaked clusters were found on the image.\n"

                "This means waste of disk space, but no harm to data.\n",

                result.leaks);

        }

        if (result.check_errors) {

            printf("\n%d internal errors have occurred during the check.\n",

                result.check_errors);

        }

    }

    bdrv_delete(bs);

    if (ret < 0 || result.check_errors) {

        printf("\nAn error has occurred during the check: %s\n"

            "The check is not complete and may have missed error.\n",

            strerror(-ret));

        return 1;

    }

    if (result.corruptions) {

        return 2;

    } else if (result.leaks) {

        return 3;

    } else {

        return 0;

    }

}

static int img_commit(int argc, char **argv)

{

    int c, ret, flags;

    const char *filename, *fmt, *cache;

    BlockDriverState *bs;

    fmt = NULL;

    cache = BDRV_DEFAULT_CACHE;

    for(;;) {

        c = getopt(argc, argv, "f:ht:");

        if (c == -1) {

            break;

        }

        switch(c) {

        case '?':

        case 'h':

            help();

            break;

        case 'f':

            fmt = optarg;

            break;

        case 't':

            cache = optarg;

            break;

        }

    }

    if (optind >= argc) {

        help();

    }

    filename = argv[optind++];

    flags = BDRV_O_RDWR;

    ret = set_cache_flag(cache, &flags);

    if (ret < 0) {

        error_report("Invalid cache option: %s", cache);

        return -1;

    }

    bs = bdrv_new_open(filename, fmt, flags);

    if (!bs) {

        return 1;

    }

    ret = bdrv_commit(bs);

    switch(ret) {

    case 0:

        printf("Image committed.\n");

        break;

    case -ENOENT:

        error_report("No disk inserted");

        break;

    case -EACCES:

        error_report("Image is read-only");

        break;

    case -ENOTSUP:

        error_report("Image is already committed");

        break;

    default:

        error_report("Error while committing image");

        break;

    }

    bdrv_delete(bs);

    if (ret) {

        return 1;

    }

    return 0;

}

/*

 * Checks whether the sector is not a zero sector.

 *

 * Attention! The len must be a multiple of 4 * sizeof(long) due to

 * restriction of optimizations in this function.

 */

static int is_not_zero(const uint8_t *sector, int len)

{

    /*

     * Use long as the biggest available internal data type that fits into the

     * CPU register and unroll the loop to smooth out the effect of memory

     * latency.

     */

    int i;

    long d0, d1, d2, d3;

    const long * const data = (const long *) sector;

    len /= sizeof(long);

    for(i = 0; i < len; i += 4) {

        d0 = data[i + 0];

        d1 = data[i + 1];

        d2 = data[i + 2];

        d3 = data[i + 3];

        if (d0 || d1 || d2 || d3) {

            return 1;

        }

    }

    return 0;

}

/*

 * Returns true iff the first sector pointed to by 'buf' contains at least

 * a non-NUL byte.

 *

 * 'pnum' is set to the number of sectors (including and immediately following

 * the first one) that are known to be in the same allocated/unallocated state.

 */

static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)

{

    int v, i;

    if (n <= 0) {

        *pnum = 0;

        return 0;

    }

    v = is_not_zero(buf, 512);

    for(i = 1; i < n; i++) {

        buf += 512;

        if (v != is_not_zero(buf, 512))

            break;

    }

    *pnum = i;

    return v;

}

/*

 * Compares two buffers sector by sector. Returns 0 if the first sector of both

 * buffers matches, non-zero otherwise.

 *

 * pnum is set to the number of sectors (including and immediately following

 * the first one) that are known to have the same comparison result

 */

static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,

    int *pnum)

{

    int res, i;

    if (n <= 0) {

        *pnum = 0;

        return 0;

    }

    res = !!memcmp(buf1, buf2, 512);

    for(i = 1; i < n; i++) {

        buf1 += 512;

        buf2 += 512;

        if (!!memcmp(buf1, buf2, 512) != res) {

            break;

        }

    }

    *pnum = i;

    return res;

}

#define IO_BUF_SIZE (2 * 1024 * 1024)

static int img_convert(int argc, char **argv)

{

    int c, ret = 0, n, n1, bs_n, bs_i, compress, cluster_size, cluster_sectors;

    int progress = 0, flags;

    const char *fmt, *out_fmt, *cache, *out_baseimg, *out_filename;

    BlockDriver *drv, *proto_drv;

    BlockDriverState **bs = NULL, *out_bs = NULL;

    int64_t total_sectors, nb_sectors, sector_num, bs_offset;

    uint64_t bs_sectors;

    uint8_t * buf = NULL;

    const uint8_t *buf1;

    BlockDriverInfo bdi;

    QEMUOptionParameter *param = NULL, *create_options = NULL;

    QEMUOptionParameter *out_baseimg_param;

    char *options = NULL;

    const char *snapshot_name = NULL;

    float local_progress;

    fmt = NULL;

    out_fmt = "raw";

    cache = "unsafe";

    out_baseimg = NULL;

    compress = 0;

    for(;;) {

        c = getopt(argc, argv, "f:O:B:s:hce6o:pt:");

        if (c == -1) {

            break;

        }

        switch(c) {

        case '?':

        case 'h':

            help();

            break;

        case 'f':

            fmt = optarg;

            break;

        case 'O':

            out_fmt = optarg;

            break;

        case 'B':

            out_baseimg = optarg;

            break;

        case 'c':

            compress = 1;

            break;

        case 'e':

            error_report("option -e is deprecated, please use \'-o "

                  "encryption\' instead!");

            return 1;

        case '6':

            error_report("option -6 is deprecated, please use \'-o "

                  "compat6\' instead!");

            return 1;

        case 'o':

            options = optarg;

            break;

        case 's':

            snapshot_name = optarg;

            break;

        case 'p':

            progress = 1;

            break;

        case 't':

            cache = optarg;

            break;

        }

    }

    bs_n = argc - optind - 1;

    if (bs_n < 1) {

        help();

    }

    out_filename = argv[argc - 1];

    if (options && !strcmp(options, "?")) {

        ret = print_block_option_help(out_filename, out_fmt);

        goto out;

    }

    if (bs_n > 1 && out_baseimg) {

        error_report("-B makes no sense when concatenating multiple input "

                     "images");

        ret = -1;

        goto out;

    }

    qemu_progress_init(progress, 2.0);

    qemu_progress_print(0, 100);

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

    total_sectors = 0;

    for (bs_i = 0; bs_i < bs_n; bs_i++) {

        bs[bs_i] = bdrv_new_open(argv[optind + bs_i], fmt, BDRV_O_FLAGS);

        if (!bs[bs_i]) {

            error_report("Could not open '%s'", argv[optind + bs_i]);

            ret = -1;

            goto out;

        }

        bdrv_get_geometry(bs[bs_i], &bs_sectors);

        total_sectors += bs_sectors;

    }

    if (snapshot_name != NULL) {

        if (bs_n > 1) {

            error_report("No support for concatenating multiple snapshot");

            ret = -1;

            goto out;

        }

        if (bdrv_snapshot_load_tmp(bs[0], snapshot_name) < 0) {

            error_report("Failed to load snapshot");

            ret = -1;

            goto out;

        }

    }

    /* Find driver and parse its options */

    drv = bdrv_find_format(out_fmt);

    if (!drv) {

        error_report("Unknown file format '%s'", out_fmt);

        ret = -1;

        goto out;

    }

    proto_drv = bdrv_find_protocol(out_filename);

    if (!proto_drv) {

        error_report("Unknown protocol '%s'", out_filename);

        ret = -1;

        goto out;

    }

    create_options = append_option_parameters(create_options,

                                              drv->create_options);

    create_options = append_option_parameters(create_options,

                                              proto_drv->create_options);

    if (options) {

        param = parse_option_parameters(options, create_options, param);

        if (param == NULL) {

            error_report("Invalid options for file format '%s'.", out_fmt);

            ret = -1;

            goto out;

        }

    } else {

        param = parse_option_parameters("", create_options, param);

    }

    set_option_parameter_int(param, BLOCK_OPT_SIZE, total_sectors * 512);

    ret = add_old_style_options(out_fmt, param, out_baseimg, NULL);

    if (ret < 0) {

        goto out;

    }

    /* Get backing file name if -o backing_file was used */

    out_baseimg_param = get_option_parameter(param, BLOCK_OPT_BACKING_FILE);

    if (out_baseimg_param) {

        out_baseimg = out_baseimg_param->value.s;

    }

    /* Check if compression is supported */

    if (compress) {

        QEMUOptionParameter *encryption =

            get_option_parameter(param, BLOCK_OPT_ENCRYPT);

        if (!drv->bdrv_write_compressed) {

            error_report("Compression not supported for this file format");

            ret = -1;

            goto out;

        }

        if (encryption && encryption->value.n) {

            error_report("Compression and encryption not supported at "

                         "the same time");

            ret = -1;

            goto out;

        }

    }

    /* Create the new image */

    ret = bdrv_create(drv, out_filename, param);

    if (ret < 0) {

        if (ret == -ENOTSUP) {

            error_report("Formatting not supported for file format '%s'",

                         out_fmt);

        } else if (ret == -EFBIG) {

            error_report("The image size is too large for file format '%s'",

                         out_fmt);

        } else {

            error_report("%s: error while converting %s: %s",

                         out_filename, out_fmt, strerror(-ret));

        }

        goto out;

    }

    flags = BDRV_O_RDWR;

    ret = set_cache_flag(cache, &flags);

    if (ret < 0) {

        error_report("Invalid cache option: %s", cache);

        return -1;

    }

    out_bs = bdrv_new_open(out_filename, out_fmt, flags);

    if (!out_bs) {

        ret = -1;

        goto out;

    }

    bs_i = 0;

    bs_offset = 0;

    bdrv_get_geometry(bs[0], &bs_sectors);

    buf = g_malloc(IO_BUF_SIZE);

    if (compress) {

        ret = bdrv_get_info(out_bs, &bdi);

        if (ret < 0) {

            error_report("could not get block driver info");

            goto out;

        }

        cluster_size = bdi.cluster_size;

        if (cluster_size <= 0 || cluster_size > IO_BUF_SIZE) {

            error_report("invalid cluster size");

            ret = -1;