2 * Command line utility to exercise the QEMU I/O path.
4 * Copyright (C) 2009-2016 Red Hat, Inc.
5 * Copyright (c) 2003-2005 Silicon Graphics, Inc.
7 * This work is licensed under the terms of the GNU GPL, version 2 or later.
8 * See the COPYING file in the top-level directory.
11 #include "qemu/osdep.h"
12 #include "qapi/error.h"
14 #include "sysemu/block-backend.h"
15 #include "block/block.h"
16 #include "block/block_int.h" /* for info_f() */
17 #include "block/qapi.h"
18 #include "qemu/error-report.h"
19 #include "qemu/main-loop.h"
20 #include "qemu/timer.h"
21 #include "sysemu/block-backend.h"
22 #include "qemu/cutils.h"
24 #define CMD_NOFILE_OK 0x01
28 static cmdinfo_t *cmdtab;
31 static int compare_cmdname(const void *a, const void *b)
33 return strcmp(((const cmdinfo_t *)a)->name,
34 ((const cmdinfo_t *)b)->name);
37 void qemuio_add_command(const cmdinfo_t *ci)
39 cmdtab = g_renew(cmdinfo_t, cmdtab, ++ncmds);
40 cmdtab[ncmds - 1] = *ci;
41 qsort(cmdtab, ncmds, sizeof(*cmdtab), compare_cmdname);
44 int qemuio_command_usage(const cmdinfo_t *ci)
46 printf("%s %s -- %s\n", ci->name, ci->args, ci->oneline);
50 static int init_check_command(BlockBackend *blk, const cmdinfo_t *ct)
52 if (ct->flags & CMD_FLAG_GLOBAL) {
55 if (!(ct->flags & CMD_NOFILE_OK) && !blk) {
56 fprintf(stderr, "no file open, try 'help open'\n");
62 static int command(BlockBackend *blk, const cmdinfo_t *ct, int argc,
67 if (!init_check_command(blk, ct)) {
71 if (argc - 1 < ct->argmin || (ct->argmax != -1 && argc - 1 > ct->argmax)) {
72 if (ct->argmax == -1) {
74 "bad argument count %d to %s, expected at least %d arguments\n",
75 argc-1, cmd, ct->argmin);
76 } else if (ct->argmin == ct->argmax) {
78 "bad argument count %d to %s, expected %d arguments\n",
79 argc-1, cmd, ct->argmin);
82 "bad argument count %d to %s, expected between %d and %d arguments\n",
83 argc-1, cmd, ct->argmin, ct->argmax);
88 return ct->cfunc(blk, argc, argv);
91 static const cmdinfo_t *find_command(const char *cmd)
95 for (ct = cmdtab; ct < &cmdtab[ncmds]; ct++) {
96 if (strcmp(ct->name, cmd) == 0 ||
97 (ct->altname && strcmp(ct->altname, cmd) == 0))
99 return (const cmdinfo_t *)ct;
105 /* Invoke fn() for commands with a matching prefix */
106 void qemuio_complete_command(const char *input,
107 void (*fn)(const char *cmd, void *opaque),
111 size_t input_len = strlen(input);
113 for (ct = cmdtab; ct < &cmdtab[ncmds]; ct++) {
114 if (strncmp(input, ct->name, input_len) == 0) {
115 fn(ct->name, opaque);
120 static char **breakline(char *input, int *count)
124 char **rval = g_new0(char *, 1);
126 while (rval && (p = qemu_strsep(&input, " ")) != NULL) {
131 rval = g_renew(char *, rval, (c + 1));
139 static int64_t cvtnum(const char *s)
144 ret = qemu_strtosz_suffix(s, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
146 /* Detritus at the end of the string */
152 static void print_cvtnum_err(int64_t rc, const char *arg)
156 printf("Parsing error: non-numeric argument,"
157 " or extraneous/unrecognized suffix -- %s\n", arg);
160 printf("Parsing error: argument too large -- %s\n", arg);
163 printf("Parsing error: %s\n", arg);
167 #define EXABYTES(x) ((long long)(x) << 60)
168 #define PETABYTES(x) ((long long)(x) << 50)
169 #define TERABYTES(x) ((long long)(x) << 40)
170 #define GIGABYTES(x) ((long long)(x) << 30)
171 #define MEGABYTES(x) ((long long)(x) << 20)
172 #define KILOBYTES(x) ((long long)(x) << 10)
174 #define TO_EXABYTES(x) ((x) / EXABYTES(1))
175 #define TO_PETABYTES(x) ((x) / PETABYTES(1))
176 #define TO_TERABYTES(x) ((x) / TERABYTES(1))
177 #define TO_GIGABYTES(x) ((x) / GIGABYTES(1))
178 #define TO_MEGABYTES(x) ((x) / MEGABYTES(1))
179 #define TO_KILOBYTES(x) ((x) / KILOBYTES(1))
181 static void cvtstr(double value, char *str, size_t size)
186 if (value >= EXABYTES(1)) {
188 snprintf(str, size - 4, "%.3f", TO_EXABYTES(value));
189 } else if (value >= PETABYTES(1)) {
191 snprintf(str, size - 4, "%.3f", TO_PETABYTES(value));
192 } else if (value >= TERABYTES(1)) {
194 snprintf(str, size - 4, "%.3f", TO_TERABYTES(value));
195 } else if (value >= GIGABYTES(1)) {
197 snprintf(str, size - 4, "%.3f", TO_GIGABYTES(value));
198 } else if (value >= MEGABYTES(1)) {
200 snprintf(str, size - 4, "%.3f", TO_MEGABYTES(value));
201 } else if (value >= KILOBYTES(1)) {
203 snprintf(str, size - 4, "%.3f", TO_KILOBYTES(value));
206 snprintf(str, size - 6, "%f", value);
209 trim = strstr(str, ".000");
211 strcpy(trim, suffix);
219 static struct timeval tsub(struct timeval t1, struct timeval t2)
221 t1.tv_usec -= t2.tv_usec;
222 if (t1.tv_usec < 0) {
223 t1.tv_usec += 1000000;
226 t1.tv_sec -= t2.tv_sec;
230 static double tdiv(double value, struct timeval tv)
232 return value / ((double)tv.tv_sec + ((double)tv.tv_usec / 1000000.0));
235 #define HOURS(sec) ((sec) / (60 * 60))
236 #define MINUTES(sec) (((sec) % (60 * 60)) / 60)
237 #define SECONDS(sec) ((sec) % 60)
241 TERSE_FIXED_TIME = 0x1,
242 VERBOSE_FIXED_TIME = 0x2,
245 static void timestr(struct timeval *tv, char *ts, size_t size, int format)
247 double usec = (double)tv->tv_usec / 1000000.0;
249 if (format & TERSE_FIXED_TIME) {
250 if (!HOURS(tv->tv_sec)) {
251 snprintf(ts, size, "%u:%02u.%02u",
252 (unsigned int) MINUTES(tv->tv_sec),
253 (unsigned int) SECONDS(tv->tv_sec),
254 (unsigned int) (usec * 100));
257 format |= VERBOSE_FIXED_TIME; /* fallback if hours needed */
260 if ((format & VERBOSE_FIXED_TIME) || tv->tv_sec) {
261 snprintf(ts, size, "%u:%02u:%02u.%02u",
262 (unsigned int) HOURS(tv->tv_sec),
263 (unsigned int) MINUTES(tv->tv_sec),
264 (unsigned int) SECONDS(tv->tv_sec),
265 (unsigned int) (usec * 100));
267 snprintf(ts, size, "0.%04u sec", (unsigned int) (usec * 10000));
272 * Parse the pattern argument to various sub-commands.
274 * Because the pattern is used as an argument to memset it must evaluate
275 * to an unsigned integer that fits into a single byte.
277 static int parse_pattern(const char *arg)
282 pattern = strtol(arg, &endptr, 0);
283 if (pattern < 0 || pattern > UCHAR_MAX || *endptr != '\0') {
284 printf("%s is not a valid pattern byte\n", arg);
292 * Memory allocation helpers.
294 * Make sure memory is aligned by default, or purposefully misaligned if
295 * that is specified on the command line.
298 #define MISALIGN_OFFSET 16
299 static void *qemu_io_alloc(BlockBackend *blk, size_t len, int pattern)
303 if (qemuio_misalign) {
304 len += MISALIGN_OFFSET;
306 buf = blk_blockalign(blk, len);
307 memset(buf, pattern, len);
308 if (qemuio_misalign) {
309 buf += MISALIGN_OFFSET;
314 static void qemu_io_free(void *p)
316 if (qemuio_misalign) {
317 p -= MISALIGN_OFFSET;
322 static void dump_buffer(const void *buffer, int64_t offset, int64_t len)
328 for (i = 0, p = buffer; i < len; i += 16) {
329 const uint8_t *s = p;
331 printf("%08" PRIx64 ": ", offset + i);
332 for (j = 0; j < 16 && i + j < len; j++, p++) {
336 for (j = 0; j < 16 && i + j < len; j++, s++) {
347 static void print_report(const char *op, struct timeval *t, int64_t offset,
348 int64_t count, int64_t total, int cnt, bool Cflag)
350 char s1[64], s2[64], ts[64];
352 timestr(t, ts, sizeof(ts), Cflag ? VERBOSE_FIXED_TIME : 0);
354 cvtstr((double)total, s1, sizeof(s1));
355 cvtstr(tdiv((double)total, *t), s2, sizeof(s2));
356 printf("%s %"PRId64"/%"PRId64" bytes at offset %" PRId64 "\n",
357 op, total, count, offset);
358 printf("%s, %d ops; %s (%s/sec and %.4f ops/sec)\n",
359 s1, cnt, ts, s2, tdiv((double)cnt, *t));
360 } else {/* bytes,ops,time,bytes/sec,ops/sec */
361 printf("%"PRId64",%d,%s,%.3f,%.3f\n",
363 tdiv((double)total, *t),
364 tdiv((double)cnt, *t));
369 * Parse multiple length statements for vectored I/O, and construct an I/O
370 * vector matching it.
373 create_iovec(BlockBackend *blk, QEMUIOVector *qiov, char **argv, int nr_iov,
376 size_t *sizes = g_new0(size_t, nr_iov);
382 for (i = 0; i < nr_iov; i++) {
388 print_cvtnum_err(len, arg);
392 if (len > SIZE_MAX) {
393 printf("Argument '%s' exceeds maximum size %llu\n", arg,
394 (unsigned long long)SIZE_MAX);
402 qemu_iovec_init(qiov, nr_iov);
404 buf = p = qemu_io_alloc(blk, count, pattern);
406 for (i = 0; i < nr_iov; i++) {
407 qemu_iovec_add(qiov, p, sizes[i]);
416 static int do_pread(BlockBackend *blk, char *buf, int64_t offset,
417 int64_t count, int64_t *total)
419 if (count > INT_MAX) {
423 *total = blk_pread(blk, offset, (uint8_t *)buf, count);
430 static int do_pwrite(BlockBackend *blk, char *buf, int64_t offset,
431 int64_t count, int flags, int64_t *total)
433 if (count > INT_MAX) {
437 *total = blk_pwrite(blk, offset, (uint8_t *)buf, count, flags);
454 static void coroutine_fn co_pwrite_zeroes_entry(void *opaque)
456 CoWriteZeroes *data = opaque;
458 data->ret = blk_co_pwrite_zeroes(data->blk, data->offset, data->count,
462 *data->total = data->ret;
466 *data->total = data->count;
469 static int do_co_pwrite_zeroes(BlockBackend *blk, int64_t offset,
470 int64_t count, int flags, int64_t *total)
473 CoWriteZeroes data = {
482 if (count > INT_MAX) {
486 co = qemu_coroutine_create(co_pwrite_zeroes_entry, &data);
487 qemu_coroutine_enter(co);
489 aio_poll(blk_get_aio_context(blk), true);
498 static int do_write_compressed(BlockBackend *blk, char *buf, int64_t offset,
499 int64_t count, int64_t *total)
503 if (count >> 9 > BDRV_REQUEST_MAX_SECTORS) {
507 ret = blk_pwrite_compressed(blk, offset, buf, count);
515 static int do_load_vmstate(BlockBackend *blk, char *buf, int64_t offset,
516 int64_t count, int64_t *total)
518 if (count > INT_MAX) {
522 *total = blk_load_vmstate(blk, (uint8_t *)buf, offset, count);
529 static int do_save_vmstate(BlockBackend *blk, char *buf, int64_t offset,
530 int64_t count, int64_t *total)
532 if (count > INT_MAX) {
536 *total = blk_save_vmstate(blk, (uint8_t *)buf, offset, count);
543 #define NOT_DONE 0x7fffffff
544 static void aio_rw_done(void *opaque, int ret)
546 *(int *)opaque = ret;
549 static int do_aio_readv(BlockBackend *blk, QEMUIOVector *qiov,
550 int64_t offset, int *total)
552 int async_ret = NOT_DONE;
554 blk_aio_preadv(blk, offset, qiov, 0, aio_rw_done, &async_ret);
555 while (async_ret == NOT_DONE) {
556 main_loop_wait(false);
560 return async_ret < 0 ? async_ret : 1;
563 static int do_aio_writev(BlockBackend *blk, QEMUIOVector *qiov,
564 int64_t offset, int flags, int *total)
566 int async_ret = NOT_DONE;
568 blk_aio_pwritev(blk, offset, qiov, flags, aio_rw_done, &async_ret);
569 while (async_ret == NOT_DONE) {
570 main_loop_wait(false);
574 return async_ret < 0 ? async_ret : 1;
577 static void read_help(void)
581 " reads a range of bytes from the given offset\n"
584 " 'read -v 512 1k' - dumps 1 kilobyte read from 512 bytes into the file\n"
586 " Reads a segment of the currently open file, optionally dumping it to the\n"
587 " standard output stream (with -v option) for subsequent inspection.\n"
588 " -b, -- read from the VM state rather than the virtual disk\n"
589 " -C, -- report statistics in a machine parsable format\n"
590 " -l, -- length for pattern verification (only with -P)\n"
591 " -p, -- ignored for backwards compatibility\n"
592 " -P, -- use a pattern to verify read data\n"
593 " -q, -- quiet mode, do not show I/O statistics\n"
594 " -s, -- start offset for pattern verification (only with -P)\n"
595 " -v, -- dump buffer to standard output\n"
599 static int read_f(BlockBackend *blk, int argc, char **argv);
601 static const cmdinfo_t read_cmd = {
607 .args = "[-abCqv] [-P pattern [-s off] [-l len]] off len",
608 .oneline = "reads a number of bytes at a specified offset",
612 static int read_f(BlockBackend *blk, int argc, char **argv)
614 struct timeval t1, t2;
615 bool Cflag = false, qflag = false, vflag = false;
616 bool Pflag = false, sflag = false, lflag = false, bflag = false;
621 /* Some compilers get confused and warn if this is not initialized. */
624 int64_t pattern_offset = 0, pattern_count = 0;
626 while ((c = getopt(argc, argv, "bCl:pP:qs:v")) != -1) {
636 pattern_count = cvtnum(optarg);
637 if (pattern_count < 0) {
638 print_cvtnum_err(pattern_count, optarg);
643 /* Ignored for backwards compatibility */
647 pattern = parse_pattern(optarg);
657 pattern_offset = cvtnum(optarg);
658 if (pattern_offset < 0) {
659 print_cvtnum_err(pattern_offset, optarg);
667 return qemuio_command_usage(&read_cmd);
671 if (optind != argc - 2) {
672 return qemuio_command_usage(&read_cmd);
675 offset = cvtnum(argv[optind]);
677 print_cvtnum_err(offset, argv[optind]);
682 count = cvtnum(argv[optind]);
684 print_cvtnum_err(count, argv[optind]);
686 } else if (count > SIZE_MAX) {
687 printf("length cannot exceed %" PRIu64 ", given %s\n",
688 (uint64_t) SIZE_MAX, argv[optind]);
692 if (!Pflag && (lflag || sflag)) {
693 return qemuio_command_usage(&read_cmd);
697 pattern_count = count - pattern_offset;
700 if ((pattern_count < 0) || (pattern_count + pattern_offset > count)) {
701 printf("pattern verification range exceeds end of read data\n");
706 if (offset & 0x1ff) {
707 printf("offset %" PRId64 " is not sector aligned\n",
712 printf("count %"PRId64" is not sector aligned\n",
718 buf = qemu_io_alloc(blk, count, 0xab);
720 gettimeofday(&t1, NULL);
722 cnt = do_load_vmstate(blk, buf, offset, count, &total);
724 cnt = do_pread(blk, buf, offset, count, &total);
726 gettimeofday(&t2, NULL);
729 printf("read failed: %s\n", strerror(-cnt));
734 void *cmp_buf = g_malloc(pattern_count);
735 memset(cmp_buf, pattern, pattern_count);
736 if (memcmp(buf + pattern_offset, cmp_buf, pattern_count)) {
737 printf("Pattern verification failed at offset %"
738 PRId64 ", %"PRId64" bytes\n",
739 offset + pattern_offset, pattern_count);
749 dump_buffer(buf, offset, count);
752 /* Finally, report back -- -C gives a parsable format */
754 print_report("read", &t2, offset, count, total, cnt, Cflag);
762 static void readv_help(void)
766 " reads a range of bytes from the given offset into multiple buffers\n"
769 " 'readv -v 512 1k 1k ' - dumps 2 kilobytes read from 512 bytes into the file\n"
771 " Reads a segment of the currently open file, optionally dumping it to the\n"
772 " standard output stream (with -v option) for subsequent inspection.\n"
773 " Uses multiple iovec buffers if more than one byte range is specified.\n"
774 " -C, -- report statistics in a machine parsable format\n"
775 " -P, -- use a pattern to verify read data\n"
776 " -v, -- dump buffer to standard output\n"
777 " -q, -- quiet mode, do not show I/O statistics\n"
781 static int readv_f(BlockBackend *blk, int argc, char **argv);
783 static const cmdinfo_t readv_cmd = {
788 .args = "[-Cqv] [-P pattern] off len [len..]",
789 .oneline = "reads a number of bytes at a specified offset",
793 static int readv_f(BlockBackend *blk, int argc, char **argv)
795 struct timeval t1, t2;
796 bool Cflag = false, qflag = false, vflag = false;
800 /* Some compilers get confused and warn if this is not initialized. */
807 while ((c = getopt(argc, argv, "CP:qv")) != -1) {
814 pattern = parse_pattern(optarg);
826 return qemuio_command_usage(&readv_cmd);
830 if (optind > argc - 2) {
831 return qemuio_command_usage(&readv_cmd);
835 offset = cvtnum(argv[optind]);
837 print_cvtnum_err(offset, argv[optind]);
842 nr_iov = argc - optind;
843 buf = create_iovec(blk, &qiov, &argv[optind], nr_iov, 0xab);
848 gettimeofday(&t1, NULL);
849 cnt = do_aio_readv(blk, &qiov, offset, &total);
850 gettimeofday(&t2, NULL);
853 printf("readv failed: %s\n", strerror(-cnt));
858 void *cmp_buf = g_malloc(qiov.size);
859 memset(cmp_buf, pattern, qiov.size);
860 if (memcmp(buf, cmp_buf, qiov.size)) {
861 printf("Pattern verification failed at offset %"
862 PRId64 ", %zd bytes\n", offset, qiov.size);
872 dump_buffer(buf, offset, qiov.size);
875 /* Finally, report back -- -C gives a parsable format */
877 print_report("read", &t2, offset, qiov.size, total, cnt, Cflag);
880 qemu_iovec_destroy(&qiov);
885 static void write_help(void)
889 " writes a range of bytes from the given offset\n"
892 " 'write 512 1k' - writes 1 kilobyte at 512 bytes into the open file\n"
894 " Writes into a segment of the currently open file, using a buffer\n"
895 " filled with a set pattern (0xcdcdcdcd).\n"
896 " -b, -- write to the VM state rather than the virtual disk\n"
897 " -c, -- write compressed data with blk_write_compressed\n"
898 " -f, -- use Force Unit Access semantics\n"
899 " -p, -- ignored for backwards compatibility\n"
900 " -P, -- use different pattern to fill file\n"
901 " -C, -- report statistics in a machine parsable format\n"
902 " -q, -- quiet mode, do not show I/O statistics\n"
903 " -u, -- with -z, allow unmapping\n"
904 " -z, -- write zeroes using blk_co_pwrite_zeroes\n"
908 static int write_f(BlockBackend *blk, int argc, char **argv);
910 static const cmdinfo_t write_cmd = {
916 .args = "[-bcCfquz] [-P pattern] off len",
917 .oneline = "writes a number of bytes at a specified offset",
921 static int write_f(BlockBackend *blk, int argc, char **argv)
923 struct timeval t1, t2;
924 bool Cflag = false, qflag = false, bflag = false;
925 bool Pflag = false, zflag = false, cflag = false;
931 /* Some compilers get confused and warn if this is not initialized. */
935 while ((c = getopt(argc, argv, "bcCfpP:quz")) != -1) {
947 flags |= BDRV_REQ_FUA;
950 /* Ignored for backwards compatibility */
954 pattern = parse_pattern(optarg);
963 flags |= BDRV_REQ_MAY_UNMAP;
969 return qemuio_command_usage(&write_cmd);
973 if (optind != argc - 2) {
974 return qemuio_command_usage(&write_cmd);
977 if (bflag && zflag) {
978 printf("-b and -z cannot be specified at the same time\n");
982 if ((flags & BDRV_REQ_FUA) && (bflag || cflag)) {
983 printf("-f and -b or -c cannot be specified at the same time\n");
987 if ((flags & BDRV_REQ_MAY_UNMAP) && !zflag) {
988 printf("-u requires -z to be specified\n");
992 if (zflag && Pflag) {
993 printf("-z and -P cannot be specified at the same time\n");
997 offset = cvtnum(argv[optind]);
999 print_cvtnum_err(offset, argv[optind]);
1004 count = cvtnum(argv[optind]);
1006 print_cvtnum_err(count, argv[optind]);
1008 } else if (count > SIZE_MAX) {
1009 printf("length cannot exceed %" PRIu64 ", given %s\n",
1010 (uint64_t) SIZE_MAX, argv[optind]);
1014 if (bflag || cflag) {
1015 if (offset & 0x1ff) {
1016 printf("offset %" PRId64 " is not sector aligned\n",
1021 if (count & 0x1ff) {
1022 printf("count %"PRId64" is not sector aligned\n",
1029 buf = qemu_io_alloc(blk, count, pattern);
1032 gettimeofday(&t1, NULL);
1034 cnt = do_save_vmstate(blk, buf, offset, count, &total);
1036 cnt = do_co_pwrite_zeroes(blk, offset, count, flags, &total);
1038 cnt = do_write_compressed(blk, buf, offset, count, &total);
1040 cnt = do_pwrite(blk, buf, offset, count, flags, &total);
1042 gettimeofday(&t2, NULL);
1045 printf("write failed: %s\n", strerror(-cnt));
1053 /* Finally, report back -- -C gives a parsable format */
1055 print_report("wrote", &t2, offset, count, total, cnt, Cflag);
1070 " writes a range of bytes from the given offset source from multiple buffers\n"
1073 " 'writev 512 1k 1k' - writes 2 kilobytes at 512 bytes into the open file\n"
1075 " Writes into a segment of the currently open file, using a buffer\n"
1076 " filled with a set pattern (0xcdcdcdcd).\n"
1077 " -P, -- use different pattern to fill file\n"
1078 " -C, -- report statistics in a machine parsable format\n"
1079 " -f, -- use Force Unit Access semantics\n"
1080 " -q, -- quiet mode, do not show I/O statistics\n"
1084 static int writev_f(BlockBackend *blk, int argc, char **argv);
1086 static const cmdinfo_t writev_cmd = {
1091 .args = "[-Cfq] [-P pattern] off len [len..]",
1092 .oneline = "writes a number of bytes at a specified offset",
1093 .help = writev_help,
1096 static int writev_f(BlockBackend *blk, int argc, char **argv)
1098 struct timeval t1, t2;
1099 bool Cflag = false, qflag = false;
1104 /* Some compilers get confused and warn if this is not initialized. */
1110 while ((c = getopt(argc, argv, "CfqP:")) != -1) {
1116 flags |= BDRV_REQ_FUA;
1122 pattern = parse_pattern(optarg);
1128 return qemuio_command_usage(&writev_cmd);
1132 if (optind > argc - 2) {
1133 return qemuio_command_usage(&writev_cmd);
1136 offset = cvtnum(argv[optind]);
1138 print_cvtnum_err(offset, argv[optind]);
1143 nr_iov = argc - optind;
1144 buf = create_iovec(blk, &qiov, &argv[optind], nr_iov, pattern);
1149 gettimeofday(&t1, NULL);
1150 cnt = do_aio_writev(blk, &qiov, offset, flags, &total);
1151 gettimeofday(&t2, NULL);
1154 printf("writev failed: %s\n", strerror(-cnt));
1162 /* Finally, report back -- -C gives a parsable format */
1164 print_report("wrote", &t2, offset, qiov.size, total, cnt, Cflag);
1166 qemu_iovec_destroy(&qiov);
1181 BlockAcctCookie acct;
1186 static void aio_write_done(void *opaque, int ret)
1188 struct aio_ctx *ctx = opaque;
1191 gettimeofday(&t2, NULL);
1195 printf("aio_write failed: %s\n", strerror(-ret));
1196 block_acct_failed(blk_get_stats(ctx->blk), &ctx->acct);
1200 block_acct_done(blk_get_stats(ctx->blk), &ctx->acct);
1206 /* Finally, report back -- -C gives a parsable format */
1207 t2 = tsub(t2, ctx->t1);
1208 print_report("wrote", &t2, ctx->offset, ctx->qiov.size,
1209 ctx->qiov.size, 1, ctx->Cflag);
1212 qemu_io_free(ctx->buf);
1213 qemu_iovec_destroy(&ctx->qiov);
1218 static void aio_read_done(void *opaque, int ret)
1220 struct aio_ctx *ctx = opaque;
1223 gettimeofday(&t2, NULL);
1226 printf("readv failed: %s\n", strerror(-ret));
1227 block_acct_failed(blk_get_stats(ctx->blk), &ctx->acct);
1232 void *cmp_buf = g_malloc(ctx->qiov.size);
1234 memset(cmp_buf, ctx->pattern, ctx->qiov.size);
1235 if (memcmp(ctx->buf, cmp_buf, ctx->qiov.size)) {
1236 printf("Pattern verification failed at offset %"
1237 PRId64 ", %zd bytes\n", ctx->offset, ctx->qiov.size);
1242 block_acct_done(blk_get_stats(ctx->blk), &ctx->acct);
1249 dump_buffer(ctx->buf, ctx->offset, ctx->qiov.size);
1252 /* Finally, report back -- -C gives a parsable format */
1253 t2 = tsub(t2, ctx->t1);
1254 print_report("read", &t2, ctx->offset, ctx->qiov.size,
1255 ctx->qiov.size, 1, ctx->Cflag);
1257 qemu_io_free(ctx->buf);
1258 qemu_iovec_destroy(&ctx->qiov);
1262 static void aio_read_help(void)
1266 " asynchronously reads a range of bytes from the given offset\n"
1269 " 'aio_read -v 512 1k 1k ' - dumps 2 kilobytes read from 512 bytes into the file\n"
1271 " Reads a segment of the currently open file, optionally dumping it to the\n"
1272 " standard output stream (with -v option) for subsequent inspection.\n"
1273 " The read is performed asynchronously and the aio_flush command must be\n"
1274 " used to ensure all outstanding aio requests have been completed.\n"
1275 " -C, -- report statistics in a machine parsable format\n"
1276 " -P, -- use a pattern to verify read data\n"
1277 " -i, -- treat request as invalid, for exercising stats\n"
1278 " -v, -- dump buffer to standard output\n"
1279 " -q, -- quiet mode, do not show I/O statistics\n"
1283 static int aio_read_f(BlockBackend *blk, int argc, char **argv);
1285 static const cmdinfo_t aio_read_cmd = {
1287 .cfunc = aio_read_f,
1290 .args = "[-Ciqv] [-P pattern] off len [len..]",
1291 .oneline = "asynchronously reads a number of bytes",
1292 .help = aio_read_help,
1295 static int aio_read_f(BlockBackend *blk, int argc, char **argv)
1298 struct aio_ctx *ctx = g_new0(struct aio_ctx, 1);
1301 while ((c = getopt(argc, argv, "CP:iqv")) != -1) {
1308 ctx->pattern = parse_pattern(optarg);
1309 if (ctx->pattern < 0) {
1315 printf("injecting invalid read request\n");
1316 block_acct_invalid(blk_get_stats(blk), BLOCK_ACCT_READ);
1327 return qemuio_command_usage(&aio_read_cmd);
1331 if (optind > argc - 2) {
1333 return qemuio_command_usage(&aio_read_cmd);
1336 ctx->offset = cvtnum(argv[optind]);
1337 if (ctx->offset < 0) {
1338 print_cvtnum_err(ctx->offset, argv[optind]);
1344 nr_iov = argc - optind;
1345 ctx->buf = create_iovec(blk, &ctx->qiov, &argv[optind], nr_iov, 0xab);
1346 if (ctx->buf == NULL) {
1347 block_acct_invalid(blk_get_stats(blk), BLOCK_ACCT_READ);
1352 gettimeofday(&ctx->t1, NULL);
1353 block_acct_start(blk_get_stats(blk), &ctx->acct, ctx->qiov.size,
1355 blk_aio_preadv(blk, ctx->offset, &ctx->qiov, 0, aio_read_done, ctx);
1359 static void aio_write_help(void)
1363 " asynchronously writes a range of bytes from the given offset source\n"
1364 " from multiple buffers\n"
1367 " 'aio_write 512 1k 1k' - writes 2 kilobytes at 512 bytes into the open file\n"
1369 " Writes into a segment of the currently open file, using a buffer\n"
1370 " filled with a set pattern (0xcdcdcdcd).\n"
1371 " The write is performed asynchronously and the aio_flush command must be\n"
1372 " used to ensure all outstanding aio requests have been completed.\n"
1373 " -P, -- use different pattern to fill file\n"
1374 " -C, -- report statistics in a machine parsable format\n"
1375 " -f, -- use Force Unit Access semantics\n"
1376 " -i, -- treat request as invalid, for exercising stats\n"
1377 " -q, -- quiet mode, do not show I/O statistics\n"
1378 " -u, -- with -z, allow unmapping\n"
1379 " -z, -- write zeroes using blk_aio_pwrite_zeroes\n"
1383 static int aio_write_f(BlockBackend *blk, int argc, char **argv);
1385 static const cmdinfo_t aio_write_cmd = {
1386 .name = "aio_write",
1387 .cfunc = aio_write_f,
1390 .args = "[-Cfiquz] [-P pattern] off len [len..]",
1391 .oneline = "asynchronously writes a number of bytes",
1392 .help = aio_write_help,
1395 static int aio_write_f(BlockBackend *blk, int argc, char **argv)
1399 struct aio_ctx *ctx = g_new0(struct aio_ctx, 1);
1403 while ((c = getopt(argc, argv, "CfiqP:uz")) != -1) {
1409 flags |= BDRV_REQ_FUA;
1415 flags |= BDRV_REQ_MAY_UNMAP;
1418 pattern = parse_pattern(optarg);
1425 printf("injecting invalid write request\n");
1426 block_acct_invalid(blk_get_stats(blk), BLOCK_ACCT_WRITE);
1434 return qemuio_command_usage(&aio_write_cmd);
1438 if (optind > argc - 2) {
1440 return qemuio_command_usage(&aio_write_cmd);
1443 if (ctx->zflag && optind != argc - 2) {
1444 printf("-z supports only a single length parameter\n");
1449 if ((flags & BDRV_REQ_MAY_UNMAP) && !ctx->zflag) {
1450 printf("-u requires -z to be specified\n");
1455 if (ctx->zflag && ctx->Pflag) {
1456 printf("-z and -P cannot be specified at the same time\n");
1461 ctx->offset = cvtnum(argv[optind]);
1462 if (ctx->offset < 0) {
1463 print_cvtnum_err(ctx->offset, argv[optind]);
1470 int64_t count = cvtnum(argv[optind]);
1472 print_cvtnum_err(count, argv[optind]);
1477 ctx->qiov.size = count;
1478 blk_aio_pwrite_zeroes(blk, ctx->offset, count, flags, aio_write_done,
1481 nr_iov = argc - optind;
1482 ctx->buf = create_iovec(blk, &ctx->qiov, &argv[optind], nr_iov,
1484 if (ctx->buf == NULL) {
1485 block_acct_invalid(blk_get_stats(blk), BLOCK_ACCT_WRITE);
1490 gettimeofday(&ctx->t1, NULL);
1491 block_acct_start(blk_get_stats(blk), &ctx->acct, ctx->qiov.size,
1494 blk_aio_pwritev(blk, ctx->offset, &ctx->qiov, flags, aio_write_done,
1500 static int aio_flush_f(BlockBackend *blk, int argc, char **argv)
1502 BlockAcctCookie cookie;
1503 block_acct_start(blk_get_stats(blk), &cookie, 0, BLOCK_ACCT_FLUSH);
1505 block_acct_done(blk_get_stats(blk), &cookie);
1509 static const cmdinfo_t aio_flush_cmd = {
1510 .name = "aio_flush",
1511 .cfunc = aio_flush_f,
1512 .oneline = "completes all outstanding aio requests"
1515 static int flush_f(BlockBackend *blk, int argc, char **argv)
1521 static const cmdinfo_t flush_cmd = {
1525 .oneline = "flush all in-core file state to disk",
1528 static int truncate_f(BlockBackend *blk, int argc, char **argv)
1533 offset = cvtnum(argv[1]);
1535 print_cvtnum_err(offset, argv[1]);
1539 ret = blk_truncate(blk, offset);
1541 printf("truncate: %s\n", strerror(-ret));
1548 static const cmdinfo_t truncate_cmd = {
1551 .cfunc = truncate_f,
1555 .oneline = "truncates the current file at the given offset",
1558 static int length_f(BlockBackend *blk, int argc, char **argv)
1563 size = blk_getlength(blk);
1565 printf("getlength: %s\n", strerror(-size));
1569 cvtstr(size, s1, sizeof(s1));
1575 static const cmdinfo_t length_cmd = {
1579 .oneline = "gets the length of the current file",
1583 static int info_f(BlockBackend *blk, int argc, char **argv)
1585 BlockDriverState *bs = blk_bs(blk);
1586 BlockDriverInfo bdi;
1587 ImageInfoSpecific *spec_info;
1588 char s1[64], s2[64];
1591 if (bs->drv && bs->drv->format_name) {
1592 printf("format name: %s\n", bs->drv->format_name);
1594 if (bs->drv && bs->drv->protocol_name) {
1595 printf("format name: %s\n", bs->drv->protocol_name);
1598 ret = bdrv_get_info(bs, &bdi);
1603 cvtstr(bdi.cluster_size, s1, sizeof(s1));
1604 cvtstr(bdi.vm_state_offset, s2, sizeof(s2));
1606 printf("cluster size: %s\n", s1);
1607 printf("vm state offset: %s\n", s2);
1609 spec_info = bdrv_get_specific_info(bs);
1611 printf("Format specific information:\n");
1612 bdrv_image_info_specific_dump(fprintf, stdout, spec_info);
1613 qapi_free_ImageInfoSpecific(spec_info);
1621 static const cmdinfo_t info_cmd = {
1625 .oneline = "prints information about the current file",
1628 static void discard_help(void)
1632 " discards a range of bytes from the given offset\n"
1635 " 'discard 512 1k' - discards 1 kilobyte from 512 bytes into the file\n"
1637 " Discards a segment of the currently open file.\n"
1638 " -C, -- report statistics in a machine parsable format\n"
1639 " -q, -- quiet mode, do not show I/O statistics\n"
1643 static int discard_f(BlockBackend *blk, int argc, char **argv);
1645 static const cmdinfo_t discard_cmd = {
1651 .args = "[-Cq] off len",
1652 .oneline = "discards a number of bytes at a specified offset",
1653 .help = discard_help,
1656 static int discard_f(BlockBackend *blk, int argc, char **argv)
1658 struct timeval t1, t2;
1659 bool Cflag = false, qflag = false;
1661 int64_t offset, count;
1663 while ((c = getopt(argc, argv, "Cq")) != -1) {
1672 return qemuio_command_usage(&discard_cmd);
1676 if (optind != argc - 2) {
1677 return qemuio_command_usage(&discard_cmd);
1680 offset = cvtnum(argv[optind]);
1682 print_cvtnum_err(offset, argv[optind]);
1687 count = cvtnum(argv[optind]);
1689 print_cvtnum_err(count, argv[optind]);
1691 } else if (count >> BDRV_SECTOR_BITS > BDRV_REQUEST_MAX_SECTORS) {
1692 printf("length cannot exceed %"PRIu64", given %s\n",
1693 (uint64_t)BDRV_REQUEST_MAX_SECTORS << BDRV_SECTOR_BITS,
1698 gettimeofday(&t1, NULL);
1699 ret = blk_pdiscard(blk, offset, count);
1700 gettimeofday(&t2, NULL);
1703 printf("discard failed: %s\n", strerror(-ret));
1707 /* Finally, report back -- -C gives a parsable format */
1710 print_report("discard", &t2, offset, count, count, 1, Cflag);
1717 static int alloc_f(BlockBackend *blk, int argc, char **argv)
1719 BlockDriverState *bs = blk_bs(blk);
1720 int64_t offset, sector_num, nb_sectors, remaining;
1725 offset = cvtnum(argv[1]);
1727 print_cvtnum_err(offset, argv[1]);
1729 } else if (offset & 0x1ff) {
1730 printf("offset %" PRId64 " is not sector aligned\n",
1736 nb_sectors = cvtnum(argv[2]);
1737 if (nb_sectors < 0) {
1738 print_cvtnum_err(nb_sectors, argv[2]);
1740 } else if (nb_sectors > INT_MAX) {
1741 printf("length argument cannot exceed %d, given %s\n",
1749 remaining = nb_sectors;
1751 sector_num = offset >> 9;
1753 ret = bdrv_is_allocated(bs, sector_num, remaining, &num);
1755 printf("is_allocated failed: %s\n", strerror(-ret));
1764 nb_sectors -= remaining;
1769 cvtstr(offset, s1, sizeof(s1));
1771 printf("%"PRId64"/%"PRId64" sectors allocated at offset %s\n",
1772 sum_alloc, nb_sectors, s1);
1776 static const cmdinfo_t alloc_cmd = {
1782 .args = "off [sectors]",
1783 .oneline = "checks if a sector is present in the file",
1787 static int map_is_allocated(BlockDriverState *bs, int64_t sector_num,
1788 int64_t nb_sectors, int64_t *pnum)
1790 int num, num_checked;
1793 num_checked = MIN(nb_sectors, INT_MAX);
1794 ret = bdrv_is_allocated(bs, sector_num, num_checked, &num);
1802 while (nb_sectors > 0 && ret == firstret) {
1806 num_checked = MIN(nb_sectors, INT_MAX);
1807 ret = bdrv_is_allocated(bs, sector_num, num_checked, &num);
1808 if (ret == firstret && num) {
1818 static int map_f(BlockBackend *blk, int argc, char **argv)
1821 int64_t nb_sectors, total_sectors;
1828 total_sectors = blk_nb_sectors(blk);
1829 if (total_sectors < 0) {
1830 error_report("Failed to query image length: %s",
1831 strerror(-total_sectors));
1835 nb_sectors = total_sectors;
1838 ret = map_is_allocated(blk_bs(blk), offset, nb_sectors, &num);
1840 error_report("Failed to get allocation status: %s", strerror(-ret));
1843 error_report("Unexpected end of image");
1847 retstr = ret ? " allocated" : "not allocated";
1848 cvtstr(offset << 9ULL, s1, sizeof(s1));
1849 printf("[% 24" PRId64 "] % 8" PRId64 "/% 8" PRId64 " sectors %s "
1850 "at offset %s (%d)\n",
1851 offset << 9ULL, num, nb_sectors, retstr, s1, ret);
1855 } while (offset < total_sectors);
1860 static const cmdinfo_t map_cmd = {
1866 .oneline = "prints the allocated areas of a file",
1869 static void reopen_help(void)
1873 " Changes the open options of an already opened image\n"
1876 " 'reopen -o lazy-refcounts=on' - activates lazy refcount writeback on a qcow2 image\n"
1878 " -r, -- Reopen the image read-only\n"
1879 " -c, -- Change the cache mode to the given value\n"
1880 " -o, -- Changes block driver options (cf. 'open' command)\n"
1884 static int reopen_f(BlockBackend *blk, int argc, char **argv);
1886 static QemuOptsList reopen_opts = {
1888 .merge_lists = true,
1889 .head = QTAILQ_HEAD_INITIALIZER(reopen_opts.head),
1891 /* no elements => accept any params */
1892 { /* end of list */ }
1896 static const cmdinfo_t reopen_cmd = {
1901 .args = "[-r] [-c cache] [-o options]",
1902 .oneline = "reopens an image with new options",
1903 .help = reopen_help,
1906 static int reopen_f(BlockBackend *blk, int argc, char **argv)
1908 BlockDriverState *bs = blk_bs(blk);
1912 int flags = bs->open_flags;
1913 bool writethrough = !blk_enable_write_cache(blk);
1915 BlockReopenQueue *brq;
1916 Error *local_err = NULL;
1918 while ((c = getopt(argc, argv, "c:o:r")) != -1) {
1921 if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) < 0) {
1922 error_report("Invalid cache option: %s", optarg);
1927 if (!qemu_opts_parse_noisily(&reopen_opts, optarg, 0)) {
1928 qemu_opts_reset(&reopen_opts);
1933 flags &= ~BDRV_O_RDWR;
1936 qemu_opts_reset(&reopen_opts);
1937 return qemuio_command_usage(&reopen_cmd);
1941 if (optind != argc) {
1942 qemu_opts_reset(&reopen_opts);
1943 return qemuio_command_usage(&reopen_cmd);
1946 if (writethrough != blk_enable_write_cache(blk) &&
1947 blk_get_attached_dev(blk))
1949 error_report("Cannot change cache.writeback: Device attached");
1950 qemu_opts_reset(&reopen_opts);
1954 qopts = qemu_opts_find(&reopen_opts, NULL);
1955 opts = qopts ? qemu_opts_to_qdict(qopts, NULL) : NULL;
1956 qemu_opts_reset(&reopen_opts);
1958 brq = bdrv_reopen_queue(NULL, bs, opts, flags);
1959 bdrv_reopen_multiple(brq, &local_err);
1961 error_report_err(local_err);
1963 blk_set_enable_write_cache(blk, !writethrough);
1969 static int break_f(BlockBackend *blk, int argc, char **argv)
1973 ret = bdrv_debug_breakpoint(blk_bs(blk), argv[1], argv[2]);
1975 printf("Could not set breakpoint: %s\n", strerror(-ret));
1981 static int remove_break_f(BlockBackend *blk, int argc, char **argv)
1985 ret = bdrv_debug_remove_breakpoint(blk_bs(blk), argv[1]);
1987 printf("Could not remove breakpoint %s: %s\n", argv[1], strerror(-ret));
1993 static const cmdinfo_t break_cmd = {
1998 .args = "event tag",
1999 .oneline = "sets a breakpoint on event and tags the stopped "
2003 static const cmdinfo_t remove_break_cmd = {
2004 .name = "remove_break",
2007 .cfunc = remove_break_f,
2009 .oneline = "remove a breakpoint by tag",
2012 static int resume_f(BlockBackend *blk, int argc, char **argv)
2016 ret = bdrv_debug_resume(blk_bs(blk), argv[1]);
2018 printf("Could not resume request: %s\n", strerror(-ret));
2024 static const cmdinfo_t resume_cmd = {
2030 .oneline = "resumes the request tagged as tag",
2033 static int wait_break_f(BlockBackend *blk, int argc, char **argv)
2035 while (!bdrv_debug_is_suspended(blk_bs(blk), argv[1])) {
2036 aio_poll(blk_get_aio_context(blk), true);
2042 static const cmdinfo_t wait_break_cmd = {
2043 .name = "wait_break",
2046 .cfunc = wait_break_f,
2048 .oneline = "waits for the suspension of a request",
2051 static int abort_f(BlockBackend *blk, int argc, char **argv)
2056 static const cmdinfo_t abort_cmd = {
2059 .flags = CMD_NOFILE_OK,
2060 .oneline = "simulate a program crash using abort(3)",
2063 static void sigraise_help(void)
2067 " raises the given signal\n"
2070 " 'sigraise %i' - raises SIGTERM\n"
2072 " Invokes raise(signal), where \"signal\" is the mandatory integer argument\n"
2073 " given to sigraise.\n"
2077 static int sigraise_f(BlockBackend *blk, int argc, char **argv);
2079 static const cmdinfo_t sigraise_cmd = {
2081 .cfunc = sigraise_f,
2084 .flags = CMD_NOFILE_OK,
2086 .oneline = "raises a signal",
2087 .help = sigraise_help,
2090 static int sigraise_f(BlockBackend *blk, int argc, char **argv)
2092 int64_t sig = cvtnum(argv[1]);
2094 print_cvtnum_err(sig, argv[1]);
2096 } else if (sig > NSIG) {
2097 printf("signal argument '%s' is too large to be a valid signal\n",
2102 /* Using raise() to kill this process does not necessarily flush all open
2103 * streams. At least stdout and stderr (although the latter should be
2104 * non-buffered anyway) should be flushed, though. */
2112 static void sleep_cb(void *opaque)
2114 bool *expired = opaque;
2118 static int sleep_f(BlockBackend *blk, int argc, char **argv)
2122 struct QEMUTimer *timer;
2123 bool expired = false;
2125 ms = strtol(argv[1], &endptr, 0);
2126 if (ms < 0 || *endptr != '\0') {
2127 printf("%s is not a valid number\n", argv[1]);
2131 timer = timer_new_ns(QEMU_CLOCK_HOST, sleep_cb, &expired);
2132 timer_mod(timer, qemu_clock_get_ns(QEMU_CLOCK_HOST) + SCALE_MS * ms);
2135 main_loop_wait(false);
2143 static const cmdinfo_t sleep_cmd = {
2148 .flags = CMD_NOFILE_OK,
2149 .oneline = "waits for the given value in milliseconds",
2152 static void help_oneline(const char *cmd, const cmdinfo_t *ct)
2157 printf("%s ", ct->name);
2159 printf("(or %s) ", ct->altname);
2164 printf("%s ", ct->args);
2166 printf("-- %s\n", ct->oneline);
2169 static void help_onecmd(const char *cmd, const cmdinfo_t *ct)
2171 help_oneline(cmd, ct);
2177 static void help_all(void)
2179 const cmdinfo_t *ct;
2181 for (ct = cmdtab; ct < &cmdtab[ncmds]; ct++) {
2182 help_oneline(ct->name, ct);
2184 printf("\nUse 'help commandname' for extended help.\n");
2187 static int help_f(BlockBackend *blk, int argc, char **argv)
2189 const cmdinfo_t *ct;
2196 ct = find_command(argv[1]);
2198 printf("command %s not found\n", argv[1]);
2202 help_onecmd(argv[1], ct);
2206 static const cmdinfo_t help_cmd = {
2212 .flags = CMD_FLAG_GLOBAL,
2213 .args = "[command]",
2214 .oneline = "help for one or all commands",
2217 bool qemuio_command(BlockBackend *blk, const char *cmd)
2220 const cmdinfo_t *ct;
2225 input = g_strdup(cmd);
2226 v = breakline(input, &c);
2228 ct = find_command(v[0]);
2230 done = command(blk, ct, c, v);
2232 fprintf(stderr, "command \"%s\" not found\n", v[0]);
2241 static void __attribute((constructor)) init_qemuio_commands(void)
2243 /* initialize commands */
2244 qemuio_add_command(&help_cmd);
2245 qemuio_add_command(&read_cmd);
2246 qemuio_add_command(&readv_cmd);
2247 qemuio_add_command(&write_cmd);
2248 qemuio_add_command(&writev_cmd);
2249 qemuio_add_command(&aio_read_cmd);
2250 qemuio_add_command(&aio_write_cmd);
2251 qemuio_add_command(&aio_flush_cmd);
2252 qemuio_add_command(&flush_cmd);
2253 qemuio_add_command(&truncate_cmd);
2254 qemuio_add_command(&length_cmd);
2255 qemuio_add_command(&info_cmd);
2256 qemuio_add_command(&discard_cmd);
2257 qemuio_add_command(&alloc_cmd);
2258 qemuio_add_command(&map_cmd);
2259 qemuio_add_command(&reopen_cmd);
2260 qemuio_add_command(&break_cmd);
2261 qemuio_add_command(&remove_break_cmd);
2262 qemuio_add_command(&resume_cmd);
2263 qemuio_add_command(&wait_break_cmd);
2264 qemuio_add_command(&abort_cmd);
2265 qemuio_add_command(&sleep_cmd);
2266 qemuio_add_command(&sigraise_cmd);