qemu-img: Add "Quiet mode" option

There can be a need to turn output to stdout off. This patch adds a -q option
that enable "Quiet mode". In Quiet mode, only errors are printed out.

Signed-off-by: Miroslav Rezanina <mrezanin@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
This commit is contained in:
Miroslav Rezanina 2013-02-13 09:09:40 +01:00 committed by Kevin Wolf
parent b35b2bba5b
commit f382d43a91
6 changed files with 135 additions and 71 deletions

12
block.c
View file

@ -4470,7 +4470,8 @@ bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie)
void bdrv_img_create(const char *filename, const char *fmt,
const char *base_filename, const char *base_fmt,
char *options, uint64_t img_size, int flags, Error **errp)
char *options, uint64_t img_size, int flags,
Error **errp, bool quiet)
{
QEMUOptionParameter *param = NULL, *create_options = NULL;
QEMUOptionParameter *backing_fmt, *backing_file, *size;
@ -4579,10 +4580,11 @@ void bdrv_img_create(const char *filename, const char *fmt,
}
}
printf("Formatting '%s', fmt=%s ", filename, fmt);
print_option_parameters(param);
puts("");
if (!quiet) {
printf("Formatting '%s', fmt=%s ", filename, fmt);
print_option_parameters(param);
puts("");
}
ret = bdrv_create(drv, filename, param);
if (ret < 0) {
if (ret == -ENOTSUP) {

View file

@ -804,7 +804,7 @@ void qmp_transaction(BlockdevActionList *dev_list, Error **errp)
bdrv_img_create(new_image_file, format,
states->old_bs->filename,
states->old_bs->drv->format_name,
NULL, -1, flags, &local_err);
NULL, -1, flags, &local_err, false);
if (error_is_set(&local_err)) {
error_propagate(errp, local_err);
goto delete_and_fail;
@ -1296,7 +1296,7 @@ void qmp_drive_mirror(const char *device, const char *target,
/* create new image w/o backing file */
assert(format && drv);
bdrv_img_create(target, format,
NULL, NULL, NULL, size, flags, &local_err);
NULL, NULL, NULL, size, flags, &local_err, false);
} else {
switch (mode) {
case NEW_IMAGE_MODE_EXISTING:
@ -1307,7 +1307,7 @@ void qmp_drive_mirror(const char *device, const char *target,
bdrv_img_create(target, format,
source->filename,
source->drv->format_name,
NULL, size, flags, &local_err);
NULL, size, flags, &local_err, false);
break;
default:
abort();

View file

@ -353,7 +353,8 @@ int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
void bdrv_img_create(const char *filename, const char *fmt,
const char *base_filename, const char *base_fmt,
char *options, uint64_t img_size, int flags, Error **errp);
char *options, uint64_t img_size, int flags,
Error **errp, bool quiet);
void bdrv_set_buffer_alignment(BlockDriverState *bs, int align);
void *qemu_blockalign(BlockDriverState *bs, size_t size);

View file

@ -10,27 +10,27 @@ STEXI
ETEXI
DEF("check", img_check,
"check [-f fmt] [--output=ofmt] [-r [leaks | all]] filename")
"check [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] filename")
STEXI
@item check [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] @var{filename}
@item check [-q] [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] @var{filename}
ETEXI
DEF("create", img_create,
"create [-f fmt] [-o options] filename [size]")
"create [-q] [-f fmt] [-o options] filename [size]")
STEXI
@item create [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
@item create [-q] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
ETEXI
DEF("commit", img_commit,
"commit [-f fmt] [-t cache] filename")
"commit [-q] [-f fmt] [-t cache] filename")
STEXI
@item commit [-f @var{fmt}] [-t @var{cache}] @var{filename}
@item commit [-q] [-f @var{fmt}] [-t @var{cache}] @var{filename}
ETEXI
DEF("convert", img_convert,
"convert [-c] [-p] [-f fmt] [-t cache] [-O output_fmt] [-o options] [-s snapshot_name] [-S sparse_size] filename [filename2 [...]] output_filename")
"convert [-c] [-p] [-q] [-f fmt] [-t cache] [-O output_fmt] [-o options] [-s snapshot_name] [-S sparse_size] filename [filename2 [...]] output_filename")
STEXI
@item convert [-c] [-p] [-f @var{fmt}] [-t @var{cache}] [-O @var{output_fmt}] [-o @var{options}] [-s @var{snapshot_name}] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename}
@item convert [-c] [-p] [-q] [-f @var{fmt}] [-t @var{cache}] [-O @var{output_fmt}] [-o @var{options}] [-s @var{snapshot_name}] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename}
ETEXI
DEF("info", img_info,
@ -40,20 +40,20 @@ STEXI
ETEXI
DEF("snapshot", img_snapshot,
"snapshot [-l | -a snapshot | -c snapshot | -d snapshot] filename")
"snapshot [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename")
STEXI
@item snapshot [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
@item snapshot [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
ETEXI
DEF("rebase", img_rebase,
"rebase [-f fmt] [-t cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
"rebase [-q] [-f fmt] [-t cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
STEXI
@item rebase [-f @var{fmt}] [-t @var{cache}] [-p] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename}
@item rebase [-q] [-f @var{fmt}] [-t @var{cache}] [-p] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename}
ETEXI
DEF("resize", img_resize,
"resize filename [+ | -]size")
"resize [-q] filename [+ | -]size")
STEXI
@item resize @var{filename} [+ | -]@var{size}
@item resize [-q] @var{filename} [+ | -]@var{size}
@end table
ETEXI

View file

@ -32,6 +32,7 @@
#include "block/block_int.h"
#include <getopt.h>
#include <stdio.h>
#include <stdarg.h>
#ifdef _WIN32
#include <windows.h>
@ -96,6 +97,7 @@ static void help(void)
" 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"
" '-q' use Quiet mode - do not print any output (except errors)\n"
" '-S' indicates the consecutive number of bytes that must contain only zeros\n"
" for qemu-img to create a sparse image during conversion\n"
" '--output' takes the format in which the output must be done (human or json)\n"
@ -119,6 +121,18 @@ static void help(void)
exit(1);
}
static int qprintf(bool quiet, const char *fmt, ...)
{
int ret = 0;
if (!quiet) {
va_list args;
va_start(args, fmt);
ret = vprintf(fmt, args);
va_end(args);
}
return ret;
}
#if defined(WIN32)
/* XXX: put correct support for win32 */
static int read_password(char *buf, int buf_size)
@ -237,7 +251,8 @@ static int print_block_option_help(const char *filename, const char *fmt)
static BlockDriverState *bdrv_new_open(const char *filename,
const char *fmt,
int flags,
bool require_io)
bool require_io,
bool quiet)
{
BlockDriverState *bs;
BlockDriver *drv;
@ -263,7 +278,7 @@ static BlockDriverState *bdrv_new_open(const char *filename,
}
if (bdrv_is_encrypted(bs) && require_io) {
printf("Disk image '%s' is encrypted.\n", filename);
qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
if (read_password(password, sizeof(password)) < 0) {
error_report("No password given");
goto fail;
@ -312,9 +327,10 @@ static int img_create(int argc, char **argv)
const char *base_filename = NULL;
char *options = NULL;
Error *local_err = NULL;
bool quiet = false;
for(;;) {
c = getopt(argc, argv, "F:b:f:he6o:");
c = getopt(argc, argv, "F:b:f:he6o:q");
if (c == -1) {
break;
}
@ -343,6 +359,9 @@ static int img_create(int argc, char **argv)
case 'o':
options = optarg;
break;
case 'q':
quiet = true;
break;
}
}
@ -375,7 +394,7 @@ static int img_create(int argc, char **argv)
}
bdrv_img_create(filename, fmt, base_filename, base_fmt,
options, img_size, BDRV_O_FLAGS, &local_err);
options, img_size, BDRV_O_FLAGS, &local_err, quiet);
if (error_is_set(&local_err)) {
error_report("%s", error_get_pretty(local_err));
error_free(local_err);
@ -385,7 +404,7 @@ static int img_create(int argc, char **argv)
return 0;
}
static void dump_json_image_check(ImageCheck *check)
static void dump_json_image_check(ImageCheck *check, bool quiet)
{
Error *errp = NULL;
QString *str;
@ -396,47 +415,52 @@ static void dump_json_image_check(ImageCheck *check)
obj = qmp_output_get_qobject(ov);
str = qobject_to_json_pretty(obj);
assert(str != NULL);
printf("%s\n", qstring_get_str(str));
qprintf(quiet, "%s\n", qstring_get_str(str));
qobject_decref(obj);
qmp_output_visitor_cleanup(ov);
QDECREF(str);
}
static void dump_human_image_check(ImageCheck *check)
static void dump_human_image_check(ImageCheck *check, bool quiet)
{
if (!(check->corruptions || check->leaks || check->check_errors)) {
printf("No errors were found on the image.\n");
qprintf(quiet, "No errors were found on the image.\n");
} else {
if (check->corruptions) {
printf("\n%" PRId64 " errors were found on the image.\n"
"Data may be corrupted, or further writes to the image "
"may corrupt it.\n",
check->corruptions);
qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
"Data may be corrupted, or further writes to the image "
"may corrupt it.\n",
check->corruptions);
}
if (check->leaks) {
printf("\n%" PRId64 " leaked clusters were found on the image.\n"
"This means waste of disk space, but no harm to data.\n",
check->leaks);
qprintf(quiet,
"\n%" PRId64 " leaked clusters were found on the image.\n"
"This means waste of disk space, but no harm to data.\n",
check->leaks);
}
if (check->check_errors) {
printf("\n%" PRId64 " internal errors have occurred during the check.\n",
check->check_errors);
qprintf(quiet,
"\n%" PRId64
" internal errors have occurred during the check.\n",
check->check_errors);
}
}
if (check->total_clusters != 0 && check->allocated_clusters != 0) {
printf("%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
"%0.2f%% fragmented, %0.2f%% compressed clusters\n",
check->allocated_clusters, check->total_clusters,
check->allocated_clusters * 100.0 / check->total_clusters,
check->fragmented_clusters * 100.0 / check->allocated_clusters,
check->compressed_clusters * 100.0 / check->allocated_clusters);
qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
"%0.2f%% fragmented, %0.2f%% compressed clusters\n",
check->allocated_clusters, check->total_clusters,
check->allocated_clusters * 100.0 / check->total_clusters,
check->fragmented_clusters * 100.0 / check->allocated_clusters,
check->compressed_clusters * 100.0 /
check->allocated_clusters);
}
if (check->image_end_offset) {
printf("Image end offset: %" PRId64 "\n", check->image_end_offset);
qprintf(quiet,
"Image end offset: %" PRId64 "\n", check->image_end_offset);
}
}
@ -496,6 +520,7 @@ static int img_check(int argc, char **argv)
int fix = 0;
int flags = BDRV_O_FLAGS | BDRV_O_CHECK;
ImageCheck *check;
bool quiet = false;
fmt = NULL;
output = NULL;
@ -508,7 +533,7 @@ static int img_check(int argc, char **argv)
{"output", required_argument, 0, OPTION_OUTPUT},
{0, 0, 0, 0}
};
c = getopt_long(argc, argv, "f:hr:",
c = getopt_long(argc, argv, "f:hr:q",
long_options, &option_index);
if (c == -1) {
break;
@ -535,6 +560,9 @@ static int img_check(int argc, char **argv)
case OPTION_OUTPUT:
output = optarg;
break;
case 'q':
quiet = true;
break;
}
}
if (optind >= argc) {
@ -551,7 +579,7 @@ static int img_check(int argc, char **argv)
return 1;
}
bs = bdrv_new_open(filename, fmt, flags, true);
bs = bdrv_new_open(filename, fmt, flags, true, quiet);
if (!bs) {
return 1;
}
@ -574,12 +602,13 @@ static int img_check(int argc, char **argv)
corruptions_fixed = check->corruptions_fixed;
if (output_format == OFORMAT_HUMAN) {
printf("The following inconsistencies were found and repaired:\n\n"
" %" PRId64 " leaked clusters\n"
" %" PRId64 " corruptions\n\n"
"Double checking the fixed image now...\n",
check->leaks_fixed,
check->corruptions_fixed);
qprintf(quiet,
"The following inconsistencies were found and repaired:\n\n"
" %" PRId64 " leaked clusters\n"
" %" PRId64 " corruptions\n\n"
"Double checking the fixed image now...\n",
check->leaks_fixed,
check->corruptions_fixed);
}
ret = collect_image_check(bs, check, filename, fmt, 0);
@ -590,10 +619,10 @@ static int img_check(int argc, char **argv)
switch (output_format) {
case OFORMAT_HUMAN:
dump_human_image_check(check);
dump_human_image_check(check, quiet);
break;
case OFORMAT_JSON:
dump_json_image_check(check);
dump_json_image_check(check, quiet);
break;
}
@ -622,11 +651,12 @@ static int img_commit(int argc, char **argv)
int c, ret, flags;
const char *filename, *fmt, *cache;
BlockDriverState *bs;
bool quiet = false;
fmt = NULL;
cache = BDRV_DEFAULT_CACHE;
for(;;) {
c = getopt(argc, argv, "f:ht:");
c = getopt(argc, argv, "f:ht:q");
if (c == -1) {
break;
}
@ -641,6 +671,9 @@ static int img_commit(int argc, char **argv)
case 't':
cache = optarg;
break;
case 'q':
quiet = true;
break;
}
}
if (optind >= argc) {
@ -655,14 +688,14 @@ static int img_commit(int argc, char **argv)
return -1;
}
bs = bdrv_new_open(filename, fmt, flags, true);
bs = bdrv_new_open(filename, fmt, flags, true, quiet);
if (!bs) {
return 1;
}
ret = bdrv_commit(bs);
switch(ret) {
case 0:
printf("Image committed.\n");
qprintf(quiet, "Image committed.\n");
break;
case -ENOENT:
error_report("No disk inserted");
@ -805,6 +838,7 @@ static int img_convert(int argc, char **argv)
const char *snapshot_name = NULL;
float local_progress = 0;
int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
bool quiet = false;
fmt = NULL;
out_fmt = "raw";
@ -812,7 +846,7 @@ static int img_convert(int argc, char **argv)
out_baseimg = NULL;
compress = 0;
for(;;) {
c = getopt(argc, argv, "f:O:B:s:hce6o:pS:t:");
c = getopt(argc, argv, "f:O:B:s:hce6o:pS:t:q");
if (c == -1) {
break;
}
@ -866,9 +900,16 @@ static int img_convert(int argc, char **argv)
case 't':
cache = optarg;
break;
case 'q':
quiet = true;
break;
}
}
if (quiet) {
progress = 0;
}
bs_n = argc - optind - 1;
if (bs_n < 1) {
help();
@ -897,7 +938,8 @@ static int img_convert(int argc, char **argv)
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, true);
bs[bs_i] = bdrv_new_open(argv[optind + bs_i], fmt, BDRV_O_FLAGS, true,
quiet);
if (!bs[bs_i]) {
error_report("Could not open '%s'", argv[optind + bs_i]);
ret = -1;
@ -1016,7 +1058,7 @@ static int img_convert(int argc, char **argv)
return -1;
}
out_bs = bdrv_new_open(out_filename, out_fmt, flags, true);
out_bs = bdrv_new_open(out_filename, out_fmt, flags, true, quiet);
if (!out_bs) {
ret = -1;
goto out;
@ -1479,7 +1521,7 @@ static ImageInfoList *collect_image_info_list(const char *filename,
g_hash_table_insert(filenames, (gpointer)filename, NULL);
bs = bdrv_new_open(filename, fmt, BDRV_O_FLAGS | BDRV_O_NO_BACKING,
false);
false, false);
if (!bs) {
goto err;
}
@ -1605,11 +1647,12 @@ static int img_snapshot(int argc, char **argv)
int c, ret = 0, bdrv_oflags;
int action = 0;
qemu_timeval tv;
bool quiet = false;
bdrv_oflags = BDRV_O_FLAGS | BDRV_O_RDWR;
/* Parse commandline parameters */
for(;;) {
c = getopt(argc, argv, "la:c:d:h");
c = getopt(argc, argv, "la:c:d:hq");
if (c == -1) {
break;
}
@ -1650,6 +1693,9 @@ static int img_snapshot(int argc, char **argv)
action = SNAPSHOT_DELETE;
snapshot_name = optarg;
break;
case 'q':
quiet = true;
break;
}
}
@ -1659,7 +1705,7 @@ static int img_snapshot(int argc, char **argv)
filename = argv[optind++];
/* Open the image */
bs = bdrv_new_open(filename, NULL, bdrv_oflags, true);
bs = bdrv_new_open(filename, NULL, bdrv_oflags, true, quiet);
if (!bs) {
return 1;
}
@ -1719,6 +1765,7 @@ static int img_rebase(int argc, char **argv)
int c, flags, ret;
int unsafe = 0;
int progress = 0;
bool quiet = false;
/* Parse commandline parameters */
fmt = NULL;
@ -1726,7 +1773,7 @@ static int img_rebase(int argc, char **argv)
out_baseimg = NULL;
out_basefmt = NULL;
for(;;) {
c = getopt(argc, argv, "uhf:F:b:pt:");
c = getopt(argc, argv, "uhf:F:b:pt:q");
if (c == -1) {
break;
}
@ -1753,9 +1800,16 @@ static int img_rebase(int argc, char **argv)
case 't':
cache = optarg;
break;
case 'q':
quiet = true;
break;
}
}
if (quiet) {
progress = 0;
}
if ((optind >= argc) || (!unsafe && !out_baseimg)) {
help();
}
@ -1777,7 +1831,7 @@ static int img_rebase(int argc, char **argv)
* Ignore the old backing file for unsafe rebase in case we want to correct
* the reference to a renamed or moved backing file.
*/
bs = bdrv_new_open(filename, fmt, flags, true);
bs = bdrv_new_open(filename, fmt, flags, true, quiet);
if (!bs) {
return 1;
}
@ -1989,6 +2043,7 @@ static int img_resize(int argc, char **argv)
int c, ret, relative;
const char *filename, *fmt, *size;
int64_t n, total_size;
bool quiet = false;
BlockDriverState *bs = NULL;
QemuOpts *param;
static QemuOptsList resize_options = {
@ -2017,7 +2072,7 @@ static int img_resize(int argc, char **argv)
/* Parse getopt arguments */
fmt = NULL;
for(;;) {
c = getopt(argc, argv, "f:h");
c = getopt(argc, argv, "f:hq");
if (c == -1) {
break;
}
@ -2029,6 +2084,9 @@ static int img_resize(int argc, char **argv)
case 'f':
fmt = optarg;
break;
case 'q':
quiet = true;
break;
}
}
if (optind >= argc) {
@ -2062,7 +2120,7 @@ static int img_resize(int argc, char **argv)
n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
qemu_opts_del(param);
bs = bdrv_new_open(filename, fmt, BDRV_O_FLAGS | BDRV_O_RDWR, true);
bs = bdrv_new_open(filename, fmt, BDRV_O_FLAGS | BDRV_O_RDWR, true, quiet);
if (!bs) {
ret = -1;
goto out;
@ -2082,7 +2140,7 @@ static int img_resize(int argc, char **argv)
ret = bdrv_truncate(bs, total_size);
switch (ret) {
case 0:
printf("Image resized.\n");
qprintf(quiet, "Image resized.\n");
break;
case -ENOTSUP:
error_report("This image does not support resize");

View file

@ -54,6 +54,9 @@ indicates that target image must be compressed (qcow format only)
with or without a command shows help and lists the supported formats
@item -p
display progress bar (convert and rebase commands only)
@item -q
Quiet mode - do not print any output (except errors). There's no progress bar
in case both @var{-q} and @var{-p} options are used.
@item -S @var{size}
indicates the consecutive number of bytes that must contain only zeros
for qemu-img to create a sparse image during conversion. This value is rounded