X-Git-Url: http://vcs.maemo.org/git/?a=blobdiff_plain;f=qemu-img.c;h=d806cfa1934e347d8f1c20737d5578767e623f13;hb=HEAD;hp=2dffe8e3a45ea1d65732e55f7f2ab4bc0dc3739b;hpb=96b8f136f52ea2dc5948fe24f0bf4483251ac280;p=qemu diff --git a/qemu-img.c b/qemu-img.c index 2dffe8e..d806cfa 100644 --- a/qemu-img.c +++ b/qemu-img.c @@ -1,7 +1,7 @@ /* * QEMU disk image utility * - * Copyright (c) 2003-2007 Fabrice Bellard + * 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 @@ -22,49 +22,24 @@ * THE SOFTWARE. */ #include "qemu-common.h" +#include "qemu-option.h" +#include "osdep.h" #include "block_int.h" -#include +#include #ifdef _WIN32 #include #endif -void *get_mmap_addr(unsigned long size) -{ - return NULL; -} +typedef struct img_cmd_t { + const char *name; + int (*handler)(int argc, char **argv); +} img_cmd_t; -void qemu_free(void *ptr) -{ - free(ptr); -} - -void *qemu_malloc(size_t size) -{ - return malloc(size); -} - -void *qemu_mallocz(size_t size) -{ - void *ptr; - ptr = qemu_malloc(size); - if (!ptr) - return NULL; - memset(ptr, 0, size); - return ptr; -} - -char *qemu_strdup(const char *str) -{ - char *ptr; - ptr = qemu_malloc(strlen(str) + 1); - if (!ptr) - return NULL; - strcpy(ptr, str); - return ptr; -} +/* Default to cache=writeback as data integrity is not important for qemu-tcg. */ +#define BRDV_O_FLAGS BDRV_O_CACHE_WB -static void __attribute__((noreturn)) error(const char *fmt, ...) +static void QEMU_NORETURN error(const char *fmt, ...) { va_list ap; va_start(ap, fmt); @@ -80,32 +55,48 @@ static void format_print(void *opaque, const char *name) printf(" %s", name); } +/* Please keep in synch with qemu-img.texi */ static void help(void) { - printf("qemu-img version " QEMU_VERSION ", Copyright (c) 2004-2007 Fabrice Bellard\n" + printf("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" - " create [-e] [-6] [-b base_image] [-f fmt] filename [size]\n" - " commit [-f fmt] filename\n" - " convert [-c] [-e] [-6] [-f fmt] filename [filename2 [...]] [-O output_fmt] output_filename\n" - " info [-f fmt] filename\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" " 'base_image' is the read-only disk image which is used as base for a copy on\n" " write image; the copy on write image only stores the modified data\n" + " 'output_base_image' forces the output image to be created as a copy on write\n" + " image of the specified base image; 'output_base_image' should have the same\n" + " content as the input's base image, however the path, image format, etc may\n" + " differ\n" " 'fmt' is the disk image format. It is guessed automatically in most cases\n" - " 'size' is the disk image size in kilobytes. Optional suffixes 'M' (megabyte)\n" - " and 'G' (gigabyte) are supported\n" + " 'size' is the disk image size in kilobytes. Optional suffixes\n" + " 'M' (megabyte, 1024 * 1024) and 'G' (gigabyte, 1024 * 1024 * 1024) are\n" + " supported any 'k' or 'K' 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" - " '-e' indicates that the target image must be encrypted (qcow format only)\n" - " '-6' indicates that the target image must use compatibility level 6 (vmdk format only)\n" + " '-h' with or without a command shows this help and lists the supported formats\n" + "\n" + "Parameters to snapshot subcommand:\n" + " 'snapshot' is the name of the snapshot to create, apply or delete\n" + " '-a' applies a snapshot (revert disk to saved state)\n" + " '-c' creates a snapshot\n" + " '-d' deletes a snapshot\n" + " '-l' lists all snapshots in the given image\n" ); - printf("\nSupported format:"); + printf("\nSupported formats:"); bdrv_iterate_format(format_print, NULL); printf("\n"); exit(1); @@ -216,7 +207,7 @@ static BlockDriverState *bdrv_new_open(const char *filename, } else { drv = NULL; } - if (bdrv_open2(bs, filename, 0, drv) < 0) { + if (bdrv_open2(bs, filename, BRDV_O_FLAGS, drv) < 0) { error("Could not open '%s'", filename); } if (bdrv_is_encrypted(bs)) { @@ -229,25 +220,55 @@ static BlockDriverState *bdrv_new_open(const char *filename, return bs; } +static void add_old_style_options(const char *fmt, QEMUOptionParameter *list, + int flags, const char *base_filename, const char *base_fmt) +{ + if (flags & BLOCK_FLAG_ENCRYPT) { + if (set_option_parameter(list, BLOCK_OPT_ENCRYPT, "on")) { + error("Encryption not supported for file format '%s'", fmt); + } + } + if (flags & BLOCK_FLAG_COMPAT6) { + if (set_option_parameter(list, BLOCK_OPT_COMPAT6, "on")) { + error("VMDK version 6 not supported for file format '%s'", fmt); + } + } + + if (base_filename) { + if (set_option_parameter(list, BLOCK_OPT_BACKING_FILE, base_filename)) { + error("Backing file not supported for file format '%s'", fmt); + } + } + if (base_fmt) { + if (set_option_parameter(list, BLOCK_OPT_BACKING_FMT, base_fmt)) { + error("Backing file format not supported for file format '%s'", fmt); + } + } +} + static int img_create(int argc, char **argv) { int c, ret, flags; const char *fmt = "raw"; + const char *base_fmt = NULL; const char *filename; const char *base_filename = NULL; - uint64_t size; - const char *p; BlockDriver *drv; + QEMUOptionParameter *param = NULL; + char *options = NULL; flags = 0; for(;;) { - c = getopt(argc, argv, "b:f:he6"); + c = getopt(argc, argv, "F:b:f:he6o:"); if (c == -1) break; switch(c) { case 'h': help(); break; + case 'F': + base_fmt = optarg; + break; case 'b': base_filename = optarg; break; @@ -260,51 +281,92 @@ static int img_create(int argc, char **argv) case '6': flags |= BLOCK_FLAG_COMPAT6; break; + case 'o': + options = optarg; + break; } } + + /* Find driver and parse its options */ + drv = bdrv_find_format(fmt); + if (!drv) + error("Unknown file format '%s'", fmt); + + if (options && !strcmp(options, "?")) { + print_option_help(drv->create_options); + return 0; + } + + if (options) { + param = parse_option_parameters(options, drv->create_options, param); + if (param == NULL) { + error("Invalid options for file format '%s'.", fmt); + } + } else { + param = parse_option_parameters("", drv->create_options, param); + } + + /* Get the filename */ if (optind >= argc) help(); filename = argv[optind++]; - size = 0; - if (base_filename) { - BlockDriverState *bs; - bs = bdrv_new_open(base_filename, NULL); - bdrv_get_geometry(bs, &size); - size *= 512; - bdrv_delete(bs); - } else { - if (optind >= argc) - help(); - p = argv[optind]; - size = strtoul(p, (char **)&p, 0); - if (*p == 'M') { - size *= 1024 * 1024; - } else if (*p == 'G') { - size *= 1024 * 1024 * 1024; - } else if (*p == 'k' || *p == 'K' || *p == '\0') { - size *= 1024; + + /* Add size to parameters */ + if (optind < argc) { + set_option_parameter(param, BLOCK_OPT_SIZE, argv[optind++]); + } + + /* Add old-style options to parameters */ + add_old_style_options(fmt, param, flags, base_filename, base_fmt); + + // The size for the image must always be specified, with one exception: + // If we are using a backing file, we can obtain the size from there + if (get_option_parameter(param, BLOCK_OPT_SIZE)->value.n == 0) { + + QEMUOptionParameter *backing_file = + get_option_parameter(param, BLOCK_OPT_BACKING_FILE); + QEMUOptionParameter *backing_fmt = + get_option_parameter(param, BLOCK_OPT_BACKING_FMT); + + if (backing_file && backing_file->value.s) { + BlockDriverState *bs; + uint64_t size; + const char *fmt = NULL; + char buf[32]; + + if (backing_fmt && backing_fmt->value.s) { + if (bdrv_find_format(backing_fmt->value.s)) { + fmt = backing_fmt->value.s; + } else { + error("Unknown backing file format '%s'", + backing_fmt->value.s); + } + } + + bs = bdrv_new_open(backing_file->value.s, fmt); + bdrv_get_geometry(bs, &size); + size *= 512; + bdrv_delete(bs); + + snprintf(buf, sizeof(buf), "%" PRId64, size); + set_option_parameter(param, BLOCK_OPT_SIZE, buf); } else { - help(); + error("Image creation needs a size parameter"); } } - drv = bdrv_find_format(fmt); - if (!drv) - error("Unknown file format '%s'", fmt); - printf("Formatting '%s', fmt=%s", - filename, fmt); - if (flags & BLOCK_FLAG_ENCRYPT) - printf(", encrypted"); - if (flags & BLOCK_FLAG_COMPAT6) - printf(", compatibility level=6"); - if (base_filename) { - printf(", backing_file=%s", - base_filename); - } - printf(", size=%" PRIu64 " kB\n", size / 1024); - ret = bdrv_create(drv, filename, size / 512, base_filename, flags); + + printf("Formatting '%s', fmt=%s ", filename, fmt); + print_option_parameters(param); + puts(""); + + ret = bdrv_create(drv, filename, param); + free_option_parameters(param); + if (ret < 0) { if (ret == -ENOTSUP) { error("Formatting or formatting option not supported for file format '%s'", fmt); + } else if (ret == -EFBIG) { + error("The image size is too large for file format '%s'", fmt); } else { error("Error while formatting"); } @@ -312,6 +374,65 @@ static int img_create(int argc, char **argv) return 0; } +static int img_check(int argc, char **argv) +{ + int c, ret; + const char *filename, *fmt; + BlockDriver *drv; + BlockDriverState *bs; + + fmt = NULL; + for(;;) { + c = getopt(argc, argv, "f:h"); + if (c == -1) + break; + switch(c) { + case 'h': + help(); + break; + case 'f': + fmt = optarg; + break; + } + } + if (optind >= argc) + help(); + filename = argv[optind++]; + + bs = bdrv_new(""); + if (!bs) + error("Not enough memory"); + if (fmt) { + drv = bdrv_find_format(fmt); + if (!drv) + error("Unknown file format '%s'", fmt); + } else { + drv = NULL; + } + if (bdrv_open2(bs, filename, BRDV_O_FLAGS, drv) < 0) { + error("Could not open '%s'", filename); + } + ret = bdrv_check(bs); + switch(ret) { + case 0: + printf("No errors were found on the image.\n"); + break; + case -ENOTSUP: + error("This image format does not support checks"); + break; + default: + if (ret < 0) { + error("An error occurred during the check"); + } else { + printf("%d errors were found on the image.\n", ret); + } + break; + } + + bdrv_delete(bs); + return 0; +} + static int img_commit(int argc, char **argv) { int c, ret; @@ -347,7 +468,7 @@ static int img_commit(int argc, char **argv) } else { drv = NULL; } - if (bdrv_open2(bs, filename, 0, drv) < 0) { + if (bdrv_open2(bs, filename, BRDV_O_FLAGS, drv) < 0) { error("Could not open '%s'", filename); } ret = bdrv_commit(bs); @@ -384,6 +505,13 @@ static int is_not_zero(const uint8_t *sector, int len) 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; @@ -407,7 +535,7 @@ static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum) static int img_convert(int argc, char **argv) { int c, ret, n, n1, bs_n, bs_i, flags, cluster_size, cluster_sectors; - const char *fmt, *out_fmt, *out_filename; + const char *fmt, *out_fmt, *out_baseimg, *out_filename; BlockDriver *drv; BlockDriverState **bs, *out_bs; int64_t total_sectors, nb_sectors, sector_num, bs_offset; @@ -415,12 +543,15 @@ static int img_convert(int argc, char **argv) uint8_t buf[IO_BUF_SIZE]; const uint8_t *buf1; BlockDriverInfo bdi; + QEMUOptionParameter *param = NULL; + char *options = NULL; fmt = NULL; out_fmt = "raw"; + out_baseimg = NULL; flags = 0; for(;;) { - c = getopt(argc, argv, "f:O:hce6"); + c = getopt(argc, argv, "f:O:B:hce6o:"); if (c == -1) break; switch(c) { @@ -433,6 +564,9 @@ static int img_convert(int argc, char **argv) case 'O': out_fmt = optarg; break; + case 'B': + out_baseimg = optarg; + break; case 'c': flags |= BLOCK_FLAG_COMPRESS; break; @@ -442,6 +576,9 @@ static int img_convert(int argc, char **argv) case '6': flags |= BLOCK_FLAG_COMPAT6; break; + case 'o': + options = optarg; + break; } } @@ -449,6 +586,9 @@ static int img_convert(int argc, char **argv) if (bs_n < 1) help(); out_filename = argv[argc - 1]; + + if (bs_n > 1 && out_baseimg) + error("-B makes no sense when concatenating multiple input images"); bs = calloc(bs_n, sizeof(BlockDriverState *)); if (!bs) @@ -463,22 +603,51 @@ static int img_convert(int argc, char **argv) total_sectors += bs_sectors; } + /* Find driver and parse its options */ drv = bdrv_find_format(out_fmt); if (!drv) error("Unknown file format '%s'", out_fmt); - if (flags & BLOCK_FLAG_COMPRESS && drv != &bdrv_qcow && drv != &bdrv_qcow2) - error("Compression not supported for this file format"); - if (flags & BLOCK_FLAG_ENCRYPT && drv != &bdrv_qcow && drv != &bdrv_qcow2) - error("Encryption not supported for this file format"); - if (flags & BLOCK_FLAG_COMPAT6 && drv != &bdrv_vmdk) - error("Alternative compatibility level not supported for this file format"); - if (flags & BLOCK_FLAG_ENCRYPT && flags & BLOCK_FLAG_COMPRESS) - error("Compression and encryption not supported at the same time"); - - ret = bdrv_create(drv, out_filename, total_sectors, NULL, flags); + + if (options && !strcmp(options, "?")) { + print_option_help(drv->create_options); + return 0; + } + + if (options) { + param = parse_option_parameters(options, drv->create_options, param); + if (param == NULL) { + error("Invalid options for file format '%s'.", out_fmt); + } + } else { + param = parse_option_parameters("", drv->create_options, param); + } + + set_option_parameter_int(param, BLOCK_OPT_SIZE, total_sectors * 512); + add_old_style_options(out_fmt, param, flags, out_baseimg, NULL); + + /* Check if compression is supported */ + if (flags & BLOCK_FLAG_COMPRESS) { + QEMUOptionParameter *encryption = + get_option_parameter(param, BLOCK_OPT_ENCRYPT); + + if (!drv->bdrv_write_compressed) { + error("Compression not supported for this file format"); + } + + if (encryption && encryption->value.n) { + error("Compression and encryption not supported at the same time"); + } + } + + /* Create the new image */ + ret = bdrv_create(drv, out_filename, param); + free_option_parameters(param); + if (ret < 0) { if (ret == -ENOTSUP) { - error("Formatting not supported for file format '%s'", fmt); + error("Formatting not supported for file format '%s'", out_fmt); + } else if (ret == -EFBIG) { + error("The image size is too large for file format '%s'", out_fmt); } else { error("Error while formatting '%s'", out_filename); } @@ -554,7 +723,7 @@ static int img_convert(int argc, char **argv) /* signal EOF to align */ bdrv_write_compressed(out_bs, 0, NULL, 0); } else { - sector_num = 0; + sector_num = 0; // total number of sectors converted so far for(;;) { nb_sectors = total_sectors - sector_num; if (nb_sectors <= 0) @@ -577,6 +746,19 @@ static int img_convert(int argc, char **argv) if (n > bs_offset + bs_sectors - sector_num) n = bs_offset + bs_sectors - sector_num; + if (strcmp(drv->format_name, "host_device")) { + if (!bdrv_is_allocated(bs[bs_i], sector_num - bs_offset, + n, &n1)) { + sector_num += n1; + continue; + } + /* The next 'n1' sectors are allocated in the input image. Copy + only those as they may be followed by unallocated sectors. */ + n = n1; + } else { + n1 = n; + } + if (bdrv_read(bs[bs_i], sector_num - bs_offset, buf, n) < 0) error("error while reading"); /* NOTE: at the same time we convert, we do not write zero @@ -584,7 +766,15 @@ static int img_convert(int argc, char **argv) should add a specific call to have the info to go faster */ buf1 = buf; while (n > 0) { - if (is_allocated_sectors(buf1, n, &n1)) { + /* If the output image is being created as a copy on write image, + copy all sectors even the ones containing only NUL bytes, + because they may differ from the sectors in the base image. + + If the output is to a host device, we also write out + sectors that are entirely 0, since whatever data was + already there is garbage, not 0s. */ + if (strcmp(drv->format_name, "host_device") == 0 || out_baseimg || + is_allocated_sectors(buf1, n, &n1)) { if (bdrv_write(out_bs, sector_num, buf1, n1) < 0) error("error while writing"); } @@ -690,7 +880,7 @@ static int img_info(int argc, char **argv) } else { drv = NULL; } - if (bdrv_open2(bs, filename, 0, drv) < 0) { + if (bdrv_open2(bs, filename, BRDV_O_FLAGS, drv) < 0) { error("Could not open '%s'", filename); } bdrv_get_format(bs, fmt_name, sizeof(fmt_name)); @@ -698,7 +888,7 @@ static int img_info(int argc, char **argv) get_human_readable_size(size_buf, sizeof(size_buf), total_sectors * 512); allocated_size = get_allocated_file_size(filename); if (allocated_size < 0) - sprintf(dsize_buf, "unavailable"); + snprintf(dsize_buf, sizeof(dsize_buf), "unavailable"); else get_human_readable_size(dsize_buf, sizeof(dsize_buf), allocated_size); @@ -728,25 +918,145 @@ static int img_info(int argc, char **argv) return 0; } +#define SNAPSHOT_LIST 1 +#define SNAPSHOT_CREATE 2 +#define SNAPSHOT_APPLY 3 +#define SNAPSHOT_DELETE 4 + +static int img_snapshot(int argc, char **argv) +{ + BlockDriverState *bs; + QEMUSnapshotInfo sn; + char *filename, *snapshot_name = NULL; + int c, ret; + int action = 0; + qemu_timeval tv; + + /* Parse commandline parameters */ + for(;;) { + c = getopt(argc, argv, "la:c:d:h"); + if (c == -1) + break; + switch(c) { + case 'h': + help(); + return 0; + case 'l': + if (action) { + help(); + return 0; + } + action = SNAPSHOT_LIST; + break; + case 'a': + if (action) { + help(); + return 0; + } + action = SNAPSHOT_APPLY; + snapshot_name = optarg; + break; + case 'c': + if (action) { + help(); + return 0; + } + action = SNAPSHOT_CREATE; + snapshot_name = optarg; + break; + case 'd': + if (action) { + help(); + return 0; + } + action = SNAPSHOT_DELETE; + snapshot_name = optarg; + break; + } + } + + if (optind >= argc) + help(); + filename = argv[optind++]; + + /* Open the image */ + bs = bdrv_new(""); + if (!bs) + error("Not enough memory"); + + if (bdrv_open2(bs, filename, 0, NULL) < 0) { + error("Could not open '%s'", filename); + } + + /* Perform the requested action */ + switch(action) { + case SNAPSHOT_LIST: + dump_snapshots(bs); + break; + + case SNAPSHOT_CREATE: + memset(&sn, 0, sizeof(sn)); + pstrcpy(sn.name, sizeof(sn.name), snapshot_name); + + qemu_gettimeofday(&tv); + sn.date_sec = tv.tv_sec; + sn.date_nsec = tv.tv_usec * 1000; + + ret = bdrv_snapshot_create(bs, &sn); + if (ret) + error("Could not create snapshot '%s': %d (%s)", + snapshot_name, ret, strerror(-ret)); + break; + + case SNAPSHOT_APPLY: + ret = bdrv_snapshot_goto(bs, snapshot_name); + if (ret) + error("Could not apply snapshot '%s': %d (%s)", + snapshot_name, ret, strerror(-ret)); + break; + + case SNAPSHOT_DELETE: + ret = bdrv_snapshot_delete(bs, snapshot_name); + if (ret) + error("Could not delete snapshot '%s': %d (%s)", + snapshot_name, ret, strerror(-ret)); + break; + } + + /* Cleanup */ + bdrv_delete(bs); + + return 0; +} + +static const img_cmd_t img_cmds[] = { +#define DEF(option, callback, arg_string) \ + { option, callback }, +#include "qemu-img-cmds.h" +#undef DEF +#undef GEN_DOCS + { NULL, NULL, }, +}; + int main(int argc, char **argv) { - const char *cmd; + const img_cmd_t *cmd; + const char *cmdname; bdrv_init(); if (argc < 2) help(); - cmd = argv[1]; - optind++; - if (!strcmp(cmd, "create")) { - img_create(argc, argv); - } else if (!strcmp(cmd, "commit")) { - img_commit(argc, argv); - } else if (!strcmp(cmd, "convert")) { - img_convert(argc, argv); - } else if (!strcmp(cmd, "info")) { - img_info(argc, argv); - } else { - help(); + cmdname = argv[1]; + argc--; argv++; + + /* find the command */ + for(cmd = img_cmds; cmd->name != NULL; cmd++) { + if (!strcmp(cmdname, cmd->name)) { + return cmd->handler(argc, argv); + } } + + /* not found */ + help(); return 0; }