Merge remote-tracking branch 'remotes/awilliam/tags/vfio-updates-20170223.0' into...
[qemu/ar7.git] / qemu-io-cmds.c
blobe415b03cd0b0bf9074fc482b7e8fb5f01521cf2a
1 /*
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.
9 */
11 #include "qemu/osdep.h"
12 #include "qapi/error.h"
13 #include "qemu-io.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 "qemu/cutils.h"
23 #define CMD_NOFILE_OK 0x01
25 bool qemuio_misalign;
27 static cmdinfo_t *cmdtab;
28 static int ncmds;
30 static int compare_cmdname(const void *a, const void *b)
32 return strcmp(((const cmdinfo_t *)a)->name,
33 ((const cmdinfo_t *)b)->name);
36 void qemuio_add_command(const cmdinfo_t *ci)
38 cmdtab = g_renew(cmdinfo_t, cmdtab, ++ncmds);
39 cmdtab[ncmds - 1] = *ci;
40 qsort(cmdtab, ncmds, sizeof(*cmdtab), compare_cmdname);
43 int qemuio_command_usage(const cmdinfo_t *ci)
45 printf("%s %s -- %s\n", ci->name, ci->args, ci->oneline);
46 return 0;
49 static int init_check_command(BlockBackend *blk, const cmdinfo_t *ct)
51 if (ct->flags & CMD_FLAG_GLOBAL) {
52 return 1;
54 if (!(ct->flags & CMD_NOFILE_OK) && !blk) {
55 fprintf(stderr, "no file open, try 'help open'\n");
56 return 0;
58 return 1;
61 static int command(BlockBackend *blk, const cmdinfo_t *ct, int argc,
62 char **argv)
64 char *cmd = argv[0];
66 if (!init_check_command(blk, ct)) {
67 return 0;
70 if (argc - 1 < ct->argmin || (ct->argmax != -1 && argc - 1 > ct->argmax)) {
71 if (ct->argmax == -1) {
72 fprintf(stderr,
73 "bad argument count %d to %s, expected at least %d arguments\n",
74 argc-1, cmd, ct->argmin);
75 } else if (ct->argmin == ct->argmax) {
76 fprintf(stderr,
77 "bad argument count %d to %s, expected %d arguments\n",
78 argc-1, cmd, ct->argmin);
79 } else {
80 fprintf(stderr,
81 "bad argument count %d to %s, expected between %d and %d arguments\n",
82 argc-1, cmd, ct->argmin, ct->argmax);
84 return 0;
86 optind = 0;
87 return ct->cfunc(blk, argc, argv);
90 static const cmdinfo_t *find_command(const char *cmd)
92 cmdinfo_t *ct;
94 for (ct = cmdtab; ct < &cmdtab[ncmds]; ct++) {
95 if (strcmp(ct->name, cmd) == 0 ||
96 (ct->altname && strcmp(ct->altname, cmd) == 0))
98 return (const cmdinfo_t *)ct;
101 return NULL;
104 /* Invoke fn() for commands with a matching prefix */
105 void qemuio_complete_command(const char *input,
106 void (*fn)(const char *cmd, void *opaque),
107 void *opaque)
109 cmdinfo_t *ct;
110 size_t input_len = strlen(input);
112 for (ct = cmdtab; ct < &cmdtab[ncmds]; ct++) {
113 if (strncmp(input, ct->name, input_len) == 0) {
114 fn(ct->name, opaque);
119 static char **breakline(char *input, int *count)
121 int c = 0;
122 char *p;
123 char **rval = g_new0(char *, 1);
125 while (rval && (p = qemu_strsep(&input, " ")) != NULL) {
126 if (!*p) {
127 continue;
129 c++;
130 rval = g_renew(char *, rval, (c + 1));
131 rval[c - 1] = p;
132 rval[c] = NULL;
134 *count = c;
135 return rval;
138 static int64_t cvtnum(const char *s)
140 char *end;
141 int64_t ret;
143 ret = qemu_strtosz_suffix(s, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
144 if (*end != '\0') {
145 /* Detritus at the end of the string */
146 return -EINVAL;
148 return ret;
151 static void print_cvtnum_err(int64_t rc, const char *arg)
153 switch (rc) {
154 case -EINVAL:
155 printf("Parsing error: non-numeric argument,"
156 " or extraneous/unrecognized suffix -- %s\n", arg);
157 break;
158 case -ERANGE:
159 printf("Parsing error: argument too large -- %s\n", arg);
160 break;
161 default:
162 printf("Parsing error: %s\n", arg);
166 #define EXABYTES(x) ((long long)(x) << 60)
167 #define PETABYTES(x) ((long long)(x) << 50)
168 #define TERABYTES(x) ((long long)(x) << 40)
169 #define GIGABYTES(x) ((long long)(x) << 30)
170 #define MEGABYTES(x) ((long long)(x) << 20)
171 #define KILOBYTES(x) ((long long)(x) << 10)
173 #define TO_EXABYTES(x) ((x) / EXABYTES(1))
174 #define TO_PETABYTES(x) ((x) / PETABYTES(1))
175 #define TO_TERABYTES(x) ((x) / TERABYTES(1))
176 #define TO_GIGABYTES(x) ((x) / GIGABYTES(1))
177 #define TO_MEGABYTES(x) ((x) / MEGABYTES(1))
178 #define TO_KILOBYTES(x) ((x) / KILOBYTES(1))
180 static void cvtstr(double value, char *str, size_t size)
182 char *trim;
183 const char *suffix;
185 if (value >= EXABYTES(1)) {
186 suffix = " EiB";
187 snprintf(str, size - 4, "%.3f", TO_EXABYTES(value));
188 } else if (value >= PETABYTES(1)) {
189 suffix = " PiB";
190 snprintf(str, size - 4, "%.3f", TO_PETABYTES(value));
191 } else if (value >= TERABYTES(1)) {
192 suffix = " TiB";
193 snprintf(str, size - 4, "%.3f", TO_TERABYTES(value));
194 } else if (value >= GIGABYTES(1)) {
195 suffix = " GiB";
196 snprintf(str, size - 4, "%.3f", TO_GIGABYTES(value));
197 } else if (value >= MEGABYTES(1)) {
198 suffix = " MiB";
199 snprintf(str, size - 4, "%.3f", TO_MEGABYTES(value));
200 } else if (value >= KILOBYTES(1)) {
201 suffix = " KiB";
202 snprintf(str, size - 4, "%.3f", TO_KILOBYTES(value));
203 } else {
204 suffix = " bytes";
205 snprintf(str, size - 6, "%f", value);
208 trim = strstr(str, ".000");
209 if (trim) {
210 strcpy(trim, suffix);
211 } else {
212 strcat(str, suffix);
218 static struct timeval tsub(struct timeval t1, struct timeval t2)
220 t1.tv_usec -= t2.tv_usec;
221 if (t1.tv_usec < 0) {
222 t1.tv_usec += 1000000;
223 t1.tv_sec--;
225 t1.tv_sec -= t2.tv_sec;
226 return t1;
229 static double tdiv(double value, struct timeval tv)
231 return value / ((double)tv.tv_sec + ((double)tv.tv_usec / 1000000.0));
234 #define HOURS(sec) ((sec) / (60 * 60))
235 #define MINUTES(sec) (((sec) % (60 * 60)) / 60)
236 #define SECONDS(sec) ((sec) % 60)
238 enum {
239 DEFAULT_TIME = 0x0,
240 TERSE_FIXED_TIME = 0x1,
241 VERBOSE_FIXED_TIME = 0x2,
244 static void timestr(struct timeval *tv, char *ts, size_t size, int format)
246 double usec = (double)tv->tv_usec / 1000000.0;
248 if (format & TERSE_FIXED_TIME) {
249 if (!HOURS(tv->tv_sec)) {
250 snprintf(ts, size, "%u:%02u.%02u",
251 (unsigned int) MINUTES(tv->tv_sec),
252 (unsigned int) SECONDS(tv->tv_sec),
253 (unsigned int) (usec * 100));
254 return;
256 format |= VERBOSE_FIXED_TIME; /* fallback if hours needed */
259 if ((format & VERBOSE_FIXED_TIME) || tv->tv_sec) {
260 snprintf(ts, size, "%u:%02u:%02u.%02u",
261 (unsigned int) HOURS(tv->tv_sec),
262 (unsigned int) MINUTES(tv->tv_sec),
263 (unsigned int) SECONDS(tv->tv_sec),
264 (unsigned int) (usec * 100));
265 } else {
266 snprintf(ts, size, "0.%04u sec", (unsigned int) (usec * 10000));
271 * Parse the pattern argument to various sub-commands.
273 * Because the pattern is used as an argument to memset it must evaluate
274 * to an unsigned integer that fits into a single byte.
276 static int parse_pattern(const char *arg)
278 char *endptr = NULL;
279 long pattern;
281 pattern = strtol(arg, &endptr, 0);
282 if (pattern < 0 || pattern > UCHAR_MAX || *endptr != '\0') {
283 printf("%s is not a valid pattern byte\n", arg);
284 return -1;
287 return pattern;
291 * Memory allocation helpers.
293 * Make sure memory is aligned by default, or purposefully misaligned if
294 * that is specified on the command line.
297 #define MISALIGN_OFFSET 16
298 static void *qemu_io_alloc(BlockBackend *blk, size_t len, int pattern)
300 void *buf;
302 if (qemuio_misalign) {
303 len += MISALIGN_OFFSET;
305 buf = blk_blockalign(blk, len);
306 memset(buf, pattern, len);
307 if (qemuio_misalign) {
308 buf += MISALIGN_OFFSET;
310 return buf;
313 static void qemu_io_free(void *p)
315 if (qemuio_misalign) {
316 p -= MISALIGN_OFFSET;
318 qemu_vfree(p);
321 static void dump_buffer(const void *buffer, int64_t offset, int64_t len)
323 uint64_t i;
324 int j;
325 const uint8_t *p;
327 for (i = 0, p = buffer; i < len; i += 16) {
328 const uint8_t *s = p;
330 printf("%08" PRIx64 ": ", offset + i);
331 for (j = 0; j < 16 && i + j < len; j++, p++) {
332 printf("%02x ", *p);
334 printf(" ");
335 for (j = 0; j < 16 && i + j < len; j++, s++) {
336 if (isalnum(*s)) {
337 printf("%c", *s);
338 } else {
339 printf(".");
342 printf("\n");
346 static void print_report(const char *op, struct timeval *t, int64_t offset,
347 int64_t count, int64_t total, int cnt, bool Cflag)
349 char s1[64], s2[64], ts[64];
351 timestr(t, ts, sizeof(ts), Cflag ? VERBOSE_FIXED_TIME : 0);
352 if (!Cflag) {
353 cvtstr((double)total, s1, sizeof(s1));
354 cvtstr(tdiv((double)total, *t), s2, sizeof(s2));
355 printf("%s %"PRId64"/%"PRId64" bytes at offset %" PRId64 "\n",
356 op, total, count, offset);
357 printf("%s, %d ops; %s (%s/sec and %.4f ops/sec)\n",
358 s1, cnt, ts, s2, tdiv((double)cnt, *t));
359 } else {/* bytes,ops,time,bytes/sec,ops/sec */
360 printf("%"PRId64",%d,%s,%.3f,%.3f\n",
361 total, cnt, ts,
362 tdiv((double)total, *t),
363 tdiv((double)cnt, *t));
368 * Parse multiple length statements for vectored I/O, and construct an I/O
369 * vector matching it.
371 static void *
372 create_iovec(BlockBackend *blk, QEMUIOVector *qiov, char **argv, int nr_iov,
373 int pattern)
375 size_t *sizes = g_new0(size_t, nr_iov);
376 size_t count = 0;
377 void *buf = NULL;
378 void *p;
379 int i;
381 for (i = 0; i < nr_iov; i++) {
382 char *arg = argv[i];
383 int64_t len;
385 len = cvtnum(arg);
386 if (len < 0) {
387 print_cvtnum_err(len, arg);
388 goto fail;
391 if (len > BDRV_REQUEST_MAX_BYTES) {
392 printf("Argument '%s' exceeds maximum size %" PRIu64 "\n", arg,
393 (uint64_t)BDRV_REQUEST_MAX_BYTES);
394 goto fail;
397 if (count > BDRV_REQUEST_MAX_BYTES - len) {
398 printf("The total number of bytes exceed the maximum size %" PRIu64
399 "\n", (uint64_t)BDRV_REQUEST_MAX_BYTES);
400 goto fail;
403 sizes[i] = len;
404 count += len;
407 qemu_iovec_init(qiov, nr_iov);
409 buf = p = qemu_io_alloc(blk, count, pattern);
411 for (i = 0; i < nr_iov; i++) {
412 qemu_iovec_add(qiov, p, sizes[i]);
413 p += sizes[i];
416 fail:
417 g_free(sizes);
418 return buf;
421 static int do_pread(BlockBackend *blk, char *buf, int64_t offset,
422 int64_t count, int64_t *total)
424 if (count > INT_MAX) {
425 return -ERANGE;
428 *total = blk_pread(blk, offset, (uint8_t *)buf, count);
429 if (*total < 0) {
430 return *total;
432 return 1;
435 static int do_pwrite(BlockBackend *blk, char *buf, int64_t offset,
436 int64_t count, int flags, int64_t *total)
438 if (count > INT_MAX) {
439 return -ERANGE;
442 *total = blk_pwrite(blk, offset, (uint8_t *)buf, count, flags);
443 if (*total < 0) {
444 return *total;
446 return 1;
449 typedef struct {
450 BlockBackend *blk;
451 int64_t offset;
452 int64_t count;
453 int64_t *total;
454 int flags;
455 int ret;
456 bool done;
457 } CoWriteZeroes;
459 static void coroutine_fn co_pwrite_zeroes_entry(void *opaque)
461 CoWriteZeroes *data = opaque;
463 data->ret = blk_co_pwrite_zeroes(data->blk, data->offset, data->count,
464 data->flags);
465 data->done = true;
466 if (data->ret < 0) {
467 *data->total = data->ret;
468 return;
471 *data->total = data->count;
474 static int do_co_pwrite_zeroes(BlockBackend *blk, int64_t offset,
475 int64_t count, int flags, int64_t *total)
477 Coroutine *co;
478 CoWriteZeroes data = {
479 .blk = blk,
480 .offset = offset,
481 .count = count,
482 .total = total,
483 .flags = flags,
484 .done = false,
487 if (count > INT_MAX) {
488 return -ERANGE;
491 co = qemu_coroutine_create(co_pwrite_zeroes_entry, &data);
492 qemu_coroutine_enter(co);
493 while (!data.done) {
494 aio_poll(blk_get_aio_context(blk), true);
496 if (data.ret < 0) {
497 return data.ret;
498 } else {
499 return 1;
503 static int do_write_compressed(BlockBackend *blk, char *buf, int64_t offset,
504 int64_t count, int64_t *total)
506 int ret;
508 if (count >> 9 > BDRV_REQUEST_MAX_SECTORS) {
509 return -ERANGE;
512 ret = blk_pwrite_compressed(blk, offset, buf, count);
513 if (ret < 0) {
514 return ret;
516 *total = count;
517 return 1;
520 static int do_load_vmstate(BlockBackend *blk, char *buf, int64_t offset,
521 int64_t count, int64_t *total)
523 if (count > INT_MAX) {
524 return -ERANGE;
527 *total = blk_load_vmstate(blk, (uint8_t *)buf, offset, count);
528 if (*total < 0) {
529 return *total;
531 return 1;
534 static int do_save_vmstate(BlockBackend *blk, char *buf, int64_t offset,
535 int64_t count, int64_t *total)
537 if (count > INT_MAX) {
538 return -ERANGE;
541 *total = blk_save_vmstate(blk, (uint8_t *)buf, offset, count);
542 if (*total < 0) {
543 return *total;
545 return 1;
548 #define NOT_DONE 0x7fffffff
549 static void aio_rw_done(void *opaque, int ret)
551 *(int *)opaque = ret;
554 static int do_aio_readv(BlockBackend *blk, QEMUIOVector *qiov,
555 int64_t offset, int *total)
557 int async_ret = NOT_DONE;
559 blk_aio_preadv(blk, offset, qiov, 0, aio_rw_done, &async_ret);
560 while (async_ret == NOT_DONE) {
561 main_loop_wait(false);
564 *total = qiov->size;
565 return async_ret < 0 ? async_ret : 1;
568 static int do_aio_writev(BlockBackend *blk, QEMUIOVector *qiov,
569 int64_t offset, int flags, int *total)
571 int async_ret = NOT_DONE;
573 blk_aio_pwritev(blk, offset, qiov, flags, aio_rw_done, &async_ret);
574 while (async_ret == NOT_DONE) {
575 main_loop_wait(false);
578 *total = qiov->size;
579 return async_ret < 0 ? async_ret : 1;
582 static void read_help(void)
584 printf(
585 "\n"
586 " reads a range of bytes from the given offset\n"
587 "\n"
588 " Example:\n"
589 " 'read -v 512 1k' - dumps 1 kilobyte read from 512 bytes into the file\n"
590 "\n"
591 " Reads a segment of the currently open file, optionally dumping it to the\n"
592 " standard output stream (with -v option) for subsequent inspection.\n"
593 " -b, -- read from the VM state rather than the virtual disk\n"
594 " -C, -- report statistics in a machine parsable format\n"
595 " -l, -- length for pattern verification (only with -P)\n"
596 " -p, -- ignored for backwards compatibility\n"
597 " -P, -- use a pattern to verify read data\n"
598 " -q, -- quiet mode, do not show I/O statistics\n"
599 " -s, -- start offset for pattern verification (only with -P)\n"
600 " -v, -- dump buffer to standard output\n"
601 "\n");
604 static int read_f(BlockBackend *blk, int argc, char **argv);
606 static const cmdinfo_t read_cmd = {
607 .name = "read",
608 .altname = "r",
609 .cfunc = read_f,
610 .argmin = 2,
611 .argmax = -1,
612 .args = "[-abCqv] [-P pattern [-s off] [-l len]] off len",
613 .oneline = "reads a number of bytes at a specified offset",
614 .help = read_help,
617 static int read_f(BlockBackend *blk, int argc, char **argv)
619 struct timeval t1, t2;
620 bool Cflag = false, qflag = false, vflag = false;
621 bool Pflag = false, sflag = false, lflag = false, bflag = false;
622 int c, cnt;
623 char *buf;
624 int64_t offset;
625 int64_t count;
626 /* Some compilers get confused and warn if this is not initialized. */
627 int64_t total = 0;
628 int pattern = 0;
629 int64_t pattern_offset = 0, pattern_count = 0;
631 while ((c = getopt(argc, argv, "bCl:pP:qs:v")) != -1) {
632 switch (c) {
633 case 'b':
634 bflag = true;
635 break;
636 case 'C':
637 Cflag = true;
638 break;
639 case 'l':
640 lflag = true;
641 pattern_count = cvtnum(optarg);
642 if (pattern_count < 0) {
643 print_cvtnum_err(pattern_count, optarg);
644 return 0;
646 break;
647 case 'p':
648 /* Ignored for backwards compatibility */
649 break;
650 case 'P':
651 Pflag = true;
652 pattern = parse_pattern(optarg);
653 if (pattern < 0) {
654 return 0;
656 break;
657 case 'q':
658 qflag = true;
659 break;
660 case 's':
661 sflag = true;
662 pattern_offset = cvtnum(optarg);
663 if (pattern_offset < 0) {
664 print_cvtnum_err(pattern_offset, optarg);
665 return 0;
667 break;
668 case 'v':
669 vflag = true;
670 break;
671 default:
672 return qemuio_command_usage(&read_cmd);
676 if (optind != argc - 2) {
677 return qemuio_command_usage(&read_cmd);
680 offset = cvtnum(argv[optind]);
681 if (offset < 0) {
682 print_cvtnum_err(offset, argv[optind]);
683 return 0;
686 optind++;
687 count = cvtnum(argv[optind]);
688 if (count < 0) {
689 print_cvtnum_err(count, argv[optind]);
690 return 0;
691 } else if (count > BDRV_REQUEST_MAX_BYTES) {
692 printf("length cannot exceed %" PRIu64 ", given %s\n",
693 (uint64_t)BDRV_REQUEST_MAX_BYTES, argv[optind]);
694 return 0;
697 if (!Pflag && (lflag || sflag)) {
698 return qemuio_command_usage(&read_cmd);
701 if (!lflag) {
702 pattern_count = count - pattern_offset;
705 if ((pattern_count < 0) || (pattern_count + pattern_offset > count)) {
706 printf("pattern verification range exceeds end of read data\n");
707 return 0;
710 if (bflag) {
711 if (offset & 0x1ff) {
712 printf("offset %" PRId64 " is not sector aligned\n",
713 offset);
714 return 0;
716 if (count & 0x1ff) {
717 printf("count %"PRId64" is not sector aligned\n",
718 count);
719 return 0;
723 buf = qemu_io_alloc(blk, count, 0xab);
725 gettimeofday(&t1, NULL);
726 if (bflag) {
727 cnt = do_load_vmstate(blk, buf, offset, count, &total);
728 } else {
729 cnt = do_pread(blk, buf, offset, count, &total);
731 gettimeofday(&t2, NULL);
733 if (cnt < 0) {
734 printf("read failed: %s\n", strerror(-cnt));
735 goto out;
738 if (Pflag) {
739 void *cmp_buf = g_malloc(pattern_count);
740 memset(cmp_buf, pattern, pattern_count);
741 if (memcmp(buf + pattern_offset, cmp_buf, pattern_count)) {
742 printf("Pattern verification failed at offset %"
743 PRId64 ", %"PRId64" bytes\n",
744 offset + pattern_offset, pattern_count);
746 g_free(cmp_buf);
749 if (qflag) {
750 goto out;
753 if (vflag) {
754 dump_buffer(buf, offset, count);
757 /* Finally, report back -- -C gives a parsable format */
758 t2 = tsub(t2, t1);
759 print_report("read", &t2, offset, count, total, cnt, Cflag);
761 out:
762 qemu_io_free(buf);
764 return 0;
767 static void readv_help(void)
769 printf(
770 "\n"
771 " reads a range of bytes from the given offset into multiple buffers\n"
772 "\n"
773 " Example:\n"
774 " 'readv -v 512 1k 1k ' - dumps 2 kilobytes read from 512 bytes into the file\n"
775 "\n"
776 " Reads a segment of the currently open file, optionally dumping it to the\n"
777 " standard output stream (with -v option) for subsequent inspection.\n"
778 " Uses multiple iovec buffers if more than one byte range is specified.\n"
779 " -C, -- report statistics in a machine parsable format\n"
780 " -P, -- use a pattern to verify read data\n"
781 " -v, -- dump buffer to standard output\n"
782 " -q, -- quiet mode, do not show I/O statistics\n"
783 "\n");
786 static int readv_f(BlockBackend *blk, int argc, char **argv);
788 static const cmdinfo_t readv_cmd = {
789 .name = "readv",
790 .cfunc = readv_f,
791 .argmin = 2,
792 .argmax = -1,
793 .args = "[-Cqv] [-P pattern] off len [len..]",
794 .oneline = "reads a number of bytes at a specified offset",
795 .help = readv_help,
798 static int readv_f(BlockBackend *blk, int argc, char **argv)
800 struct timeval t1, t2;
801 bool Cflag = false, qflag = false, vflag = false;
802 int c, cnt;
803 char *buf;
804 int64_t offset;
805 /* Some compilers get confused and warn if this is not initialized. */
806 int total = 0;
807 int nr_iov;
808 QEMUIOVector qiov;
809 int pattern = 0;
810 bool Pflag = false;
812 while ((c = getopt(argc, argv, "CP:qv")) != -1) {
813 switch (c) {
814 case 'C':
815 Cflag = true;
816 break;
817 case 'P':
818 Pflag = true;
819 pattern = parse_pattern(optarg);
820 if (pattern < 0) {
821 return 0;
823 break;
824 case 'q':
825 qflag = true;
826 break;
827 case 'v':
828 vflag = true;
829 break;
830 default:
831 return qemuio_command_usage(&readv_cmd);
835 if (optind > argc - 2) {
836 return qemuio_command_usage(&readv_cmd);
840 offset = cvtnum(argv[optind]);
841 if (offset < 0) {
842 print_cvtnum_err(offset, argv[optind]);
843 return 0;
845 optind++;
847 nr_iov = argc - optind;
848 buf = create_iovec(blk, &qiov, &argv[optind], nr_iov, 0xab);
849 if (buf == NULL) {
850 return 0;
853 gettimeofday(&t1, NULL);
854 cnt = do_aio_readv(blk, &qiov, offset, &total);
855 gettimeofday(&t2, NULL);
857 if (cnt < 0) {
858 printf("readv failed: %s\n", strerror(-cnt));
859 goto out;
862 if (Pflag) {
863 void *cmp_buf = g_malloc(qiov.size);
864 memset(cmp_buf, pattern, qiov.size);
865 if (memcmp(buf, cmp_buf, qiov.size)) {
866 printf("Pattern verification failed at offset %"
867 PRId64 ", %zd bytes\n", offset, qiov.size);
869 g_free(cmp_buf);
872 if (qflag) {
873 goto out;
876 if (vflag) {
877 dump_buffer(buf, offset, qiov.size);
880 /* Finally, report back -- -C gives a parsable format */
881 t2 = tsub(t2, t1);
882 print_report("read", &t2, offset, qiov.size, total, cnt, Cflag);
884 out:
885 qemu_iovec_destroy(&qiov);
886 qemu_io_free(buf);
887 return 0;
890 static void write_help(void)
892 printf(
893 "\n"
894 " writes a range of bytes from the given offset\n"
895 "\n"
896 " Example:\n"
897 " 'write 512 1k' - writes 1 kilobyte at 512 bytes into the open file\n"
898 "\n"
899 " Writes into a segment of the currently open file, using a buffer\n"
900 " filled with a set pattern (0xcdcdcdcd).\n"
901 " -b, -- write to the VM state rather than the virtual disk\n"
902 " -c, -- write compressed data with blk_write_compressed\n"
903 " -f, -- use Force Unit Access semantics\n"
904 " -p, -- ignored for backwards compatibility\n"
905 " -P, -- use different pattern to fill file\n"
906 " -C, -- report statistics in a machine parsable format\n"
907 " -q, -- quiet mode, do not show I/O statistics\n"
908 " -u, -- with -z, allow unmapping\n"
909 " -z, -- write zeroes using blk_co_pwrite_zeroes\n"
910 "\n");
913 static int write_f(BlockBackend *blk, int argc, char **argv);
915 static const cmdinfo_t write_cmd = {
916 .name = "write",
917 .altname = "w",
918 .cfunc = write_f,
919 .argmin = 2,
920 .argmax = -1,
921 .args = "[-bcCfquz] [-P pattern] off len",
922 .oneline = "writes a number of bytes at a specified offset",
923 .help = write_help,
926 static int write_f(BlockBackend *blk, int argc, char **argv)
928 struct timeval t1, t2;
929 bool Cflag = false, qflag = false, bflag = false;
930 bool Pflag = false, zflag = false, cflag = false;
931 int flags = 0;
932 int c, cnt;
933 char *buf = NULL;
934 int64_t offset;
935 int64_t count;
936 /* Some compilers get confused and warn if this is not initialized. */
937 int64_t total = 0;
938 int pattern = 0xcd;
940 while ((c = getopt(argc, argv, "bcCfpP:quz")) != -1) {
941 switch (c) {
942 case 'b':
943 bflag = true;
944 break;
945 case 'c':
946 cflag = true;
947 break;
948 case 'C':
949 Cflag = true;
950 break;
951 case 'f':
952 flags |= BDRV_REQ_FUA;
953 break;
954 case 'p':
955 /* Ignored for backwards compatibility */
956 break;
957 case 'P':
958 Pflag = true;
959 pattern = parse_pattern(optarg);
960 if (pattern < 0) {
961 return 0;
963 break;
964 case 'q':
965 qflag = true;
966 break;
967 case 'u':
968 flags |= BDRV_REQ_MAY_UNMAP;
969 break;
970 case 'z':
971 zflag = true;
972 break;
973 default:
974 return qemuio_command_usage(&write_cmd);
978 if (optind != argc - 2) {
979 return qemuio_command_usage(&write_cmd);
982 if (bflag && zflag) {
983 printf("-b and -z cannot be specified at the same time\n");
984 return 0;
987 if ((flags & BDRV_REQ_FUA) && (bflag || cflag)) {
988 printf("-f and -b or -c cannot be specified at the same time\n");
989 return 0;
992 if ((flags & BDRV_REQ_MAY_UNMAP) && !zflag) {
993 printf("-u requires -z to be specified\n");
994 return 0;
997 if (zflag && Pflag) {
998 printf("-z and -P cannot be specified at the same time\n");
999 return 0;
1002 offset = cvtnum(argv[optind]);
1003 if (offset < 0) {
1004 print_cvtnum_err(offset, argv[optind]);
1005 return 0;
1008 optind++;
1009 count = cvtnum(argv[optind]);
1010 if (count < 0) {
1011 print_cvtnum_err(count, argv[optind]);
1012 return 0;
1013 } else if (count > BDRV_REQUEST_MAX_BYTES) {
1014 printf("length cannot exceed %" PRIu64 ", given %s\n",
1015 (uint64_t)BDRV_REQUEST_MAX_BYTES, argv[optind]);
1016 return 0;
1019 if (bflag || cflag) {
1020 if (offset & 0x1ff) {
1021 printf("offset %" PRId64 " is not sector aligned\n",
1022 offset);
1023 return 0;
1026 if (count & 0x1ff) {
1027 printf("count %"PRId64" is not sector aligned\n",
1028 count);
1029 return 0;
1033 if (!zflag) {
1034 buf = qemu_io_alloc(blk, count, pattern);
1037 gettimeofday(&t1, NULL);
1038 if (bflag) {
1039 cnt = do_save_vmstate(blk, buf, offset, count, &total);
1040 } else if (zflag) {
1041 cnt = do_co_pwrite_zeroes(blk, offset, count, flags, &total);
1042 } else if (cflag) {
1043 cnt = do_write_compressed(blk, buf, offset, count, &total);
1044 } else {
1045 cnt = do_pwrite(blk, buf, offset, count, flags, &total);
1047 gettimeofday(&t2, NULL);
1049 if (cnt < 0) {
1050 printf("write failed: %s\n", strerror(-cnt));
1051 goto out;
1054 if (qflag) {
1055 goto out;
1058 /* Finally, report back -- -C gives a parsable format */
1059 t2 = tsub(t2, t1);
1060 print_report("wrote", &t2, offset, count, total, cnt, Cflag);
1062 out:
1063 if (!zflag) {
1064 qemu_io_free(buf);
1067 return 0;
1070 static void
1071 writev_help(void)
1073 printf(
1074 "\n"
1075 " writes a range of bytes from the given offset source from multiple buffers\n"
1076 "\n"
1077 " Example:\n"
1078 " 'writev 512 1k 1k' - writes 2 kilobytes at 512 bytes into the open file\n"
1079 "\n"
1080 " Writes into a segment of the currently open file, using a buffer\n"
1081 " filled with a set pattern (0xcdcdcdcd).\n"
1082 " -P, -- use different pattern to fill file\n"
1083 " -C, -- report statistics in a machine parsable format\n"
1084 " -f, -- use Force Unit Access semantics\n"
1085 " -q, -- quiet mode, do not show I/O statistics\n"
1086 "\n");
1089 static int writev_f(BlockBackend *blk, int argc, char **argv);
1091 static const cmdinfo_t writev_cmd = {
1092 .name = "writev",
1093 .cfunc = writev_f,
1094 .argmin = 2,
1095 .argmax = -1,
1096 .args = "[-Cfq] [-P pattern] off len [len..]",
1097 .oneline = "writes a number of bytes at a specified offset",
1098 .help = writev_help,
1101 static int writev_f(BlockBackend *blk, int argc, char **argv)
1103 struct timeval t1, t2;
1104 bool Cflag = false, qflag = false;
1105 int flags = 0;
1106 int c, cnt;
1107 char *buf;
1108 int64_t offset;
1109 /* Some compilers get confused and warn if this is not initialized. */
1110 int total = 0;
1111 int nr_iov;
1112 int pattern = 0xcd;
1113 QEMUIOVector qiov;
1115 while ((c = getopt(argc, argv, "CfqP:")) != -1) {
1116 switch (c) {
1117 case 'C':
1118 Cflag = true;
1119 break;
1120 case 'f':
1121 flags |= BDRV_REQ_FUA;
1122 break;
1123 case 'q':
1124 qflag = true;
1125 break;
1126 case 'P':
1127 pattern = parse_pattern(optarg);
1128 if (pattern < 0) {
1129 return 0;
1131 break;
1132 default:
1133 return qemuio_command_usage(&writev_cmd);
1137 if (optind > argc - 2) {
1138 return qemuio_command_usage(&writev_cmd);
1141 offset = cvtnum(argv[optind]);
1142 if (offset < 0) {
1143 print_cvtnum_err(offset, argv[optind]);
1144 return 0;
1146 optind++;
1148 nr_iov = argc - optind;
1149 buf = create_iovec(blk, &qiov, &argv[optind], nr_iov, pattern);
1150 if (buf == NULL) {
1151 return 0;
1154 gettimeofday(&t1, NULL);
1155 cnt = do_aio_writev(blk, &qiov, offset, flags, &total);
1156 gettimeofday(&t2, NULL);
1158 if (cnt < 0) {
1159 printf("writev failed: %s\n", strerror(-cnt));
1160 goto out;
1163 if (qflag) {
1164 goto out;
1167 /* Finally, report back -- -C gives a parsable format */
1168 t2 = tsub(t2, t1);
1169 print_report("wrote", &t2, offset, qiov.size, total, cnt, Cflag);
1170 out:
1171 qemu_iovec_destroy(&qiov);
1172 qemu_io_free(buf);
1173 return 0;
1176 struct aio_ctx {
1177 BlockBackend *blk;
1178 QEMUIOVector qiov;
1179 int64_t offset;
1180 char *buf;
1181 bool qflag;
1182 bool vflag;
1183 bool Cflag;
1184 bool Pflag;
1185 bool zflag;
1186 BlockAcctCookie acct;
1187 int pattern;
1188 struct timeval t1;
1191 static void aio_write_done(void *opaque, int ret)
1193 struct aio_ctx *ctx = opaque;
1194 struct timeval t2;
1196 gettimeofday(&t2, NULL);
1199 if (ret < 0) {
1200 printf("aio_write failed: %s\n", strerror(-ret));
1201 block_acct_failed(blk_get_stats(ctx->blk), &ctx->acct);
1202 goto out;
1205 block_acct_done(blk_get_stats(ctx->blk), &ctx->acct);
1207 if (ctx->qflag) {
1208 goto out;
1211 /* Finally, report back -- -C gives a parsable format */
1212 t2 = tsub(t2, ctx->t1);
1213 print_report("wrote", &t2, ctx->offset, ctx->qiov.size,
1214 ctx->qiov.size, 1, ctx->Cflag);
1215 out:
1216 if (!ctx->zflag) {
1217 qemu_io_free(ctx->buf);
1218 qemu_iovec_destroy(&ctx->qiov);
1220 g_free(ctx);
1223 static void aio_read_done(void *opaque, int ret)
1225 struct aio_ctx *ctx = opaque;
1226 struct timeval t2;
1228 gettimeofday(&t2, NULL);
1230 if (ret < 0) {
1231 printf("readv failed: %s\n", strerror(-ret));
1232 block_acct_failed(blk_get_stats(ctx->blk), &ctx->acct);
1233 goto out;
1236 if (ctx->Pflag) {
1237 void *cmp_buf = g_malloc(ctx->qiov.size);
1239 memset(cmp_buf, ctx->pattern, ctx->qiov.size);
1240 if (memcmp(ctx->buf, cmp_buf, ctx->qiov.size)) {
1241 printf("Pattern verification failed at offset %"
1242 PRId64 ", %zd bytes\n", ctx->offset, ctx->qiov.size);
1244 g_free(cmp_buf);
1247 block_acct_done(blk_get_stats(ctx->blk), &ctx->acct);
1249 if (ctx->qflag) {
1250 goto out;
1253 if (ctx->vflag) {
1254 dump_buffer(ctx->buf, ctx->offset, ctx->qiov.size);
1257 /* Finally, report back -- -C gives a parsable format */
1258 t2 = tsub(t2, ctx->t1);
1259 print_report("read", &t2, ctx->offset, ctx->qiov.size,
1260 ctx->qiov.size, 1, ctx->Cflag);
1261 out:
1262 qemu_io_free(ctx->buf);
1263 qemu_iovec_destroy(&ctx->qiov);
1264 g_free(ctx);
1267 static void aio_read_help(void)
1269 printf(
1270 "\n"
1271 " asynchronously reads a range of bytes from the given offset\n"
1272 "\n"
1273 " Example:\n"
1274 " 'aio_read -v 512 1k 1k ' - dumps 2 kilobytes read from 512 bytes into the file\n"
1275 "\n"
1276 " Reads a segment of the currently open file, optionally dumping it to the\n"
1277 " standard output stream (with -v option) for subsequent inspection.\n"
1278 " The read is performed asynchronously and the aio_flush command must be\n"
1279 " used to ensure all outstanding aio requests have been completed.\n"
1280 " -C, -- report statistics in a machine parsable format\n"
1281 " -P, -- use a pattern to verify read data\n"
1282 " -i, -- treat request as invalid, for exercising stats\n"
1283 " -v, -- dump buffer to standard output\n"
1284 " -q, -- quiet mode, do not show I/O statistics\n"
1285 "\n");
1288 static int aio_read_f(BlockBackend *blk, int argc, char **argv);
1290 static const cmdinfo_t aio_read_cmd = {
1291 .name = "aio_read",
1292 .cfunc = aio_read_f,
1293 .argmin = 2,
1294 .argmax = -1,
1295 .args = "[-Ciqv] [-P pattern] off len [len..]",
1296 .oneline = "asynchronously reads a number of bytes",
1297 .help = aio_read_help,
1300 static int aio_read_f(BlockBackend *blk, int argc, char **argv)
1302 int nr_iov, c;
1303 struct aio_ctx *ctx = g_new0(struct aio_ctx, 1);
1305 ctx->blk = blk;
1306 while ((c = getopt(argc, argv, "CP:iqv")) != -1) {
1307 switch (c) {
1308 case 'C':
1309 ctx->Cflag = true;
1310 break;
1311 case 'P':
1312 ctx->Pflag = true;
1313 ctx->pattern = parse_pattern(optarg);
1314 if (ctx->pattern < 0) {
1315 g_free(ctx);
1316 return 0;
1318 break;
1319 case 'i':
1320 printf("injecting invalid read request\n");
1321 block_acct_invalid(blk_get_stats(blk), BLOCK_ACCT_READ);
1322 g_free(ctx);
1323 return 0;
1324 case 'q':
1325 ctx->qflag = true;
1326 break;
1327 case 'v':
1328 ctx->vflag = true;
1329 break;
1330 default:
1331 g_free(ctx);
1332 return qemuio_command_usage(&aio_read_cmd);
1336 if (optind > argc - 2) {
1337 g_free(ctx);
1338 return qemuio_command_usage(&aio_read_cmd);
1341 ctx->offset = cvtnum(argv[optind]);
1342 if (ctx->offset < 0) {
1343 print_cvtnum_err(ctx->offset, argv[optind]);
1344 g_free(ctx);
1345 return 0;
1347 optind++;
1349 nr_iov = argc - optind;
1350 ctx->buf = create_iovec(blk, &ctx->qiov, &argv[optind], nr_iov, 0xab);
1351 if (ctx->buf == NULL) {
1352 block_acct_invalid(blk_get_stats(blk), BLOCK_ACCT_READ);
1353 g_free(ctx);
1354 return 0;
1357 gettimeofday(&ctx->t1, NULL);
1358 block_acct_start(blk_get_stats(blk), &ctx->acct, ctx->qiov.size,
1359 BLOCK_ACCT_READ);
1360 blk_aio_preadv(blk, ctx->offset, &ctx->qiov, 0, aio_read_done, ctx);
1361 return 0;
1364 static void aio_write_help(void)
1366 printf(
1367 "\n"
1368 " asynchronously writes a range of bytes from the given offset source\n"
1369 " from multiple buffers\n"
1370 "\n"
1371 " Example:\n"
1372 " 'aio_write 512 1k 1k' - writes 2 kilobytes at 512 bytes into the open file\n"
1373 "\n"
1374 " Writes into a segment of the currently open file, using a buffer\n"
1375 " filled with a set pattern (0xcdcdcdcd).\n"
1376 " The write is performed asynchronously and the aio_flush command must be\n"
1377 " used to ensure all outstanding aio requests have been completed.\n"
1378 " -P, -- use different pattern to fill file\n"
1379 " -C, -- report statistics in a machine parsable format\n"
1380 " -f, -- use Force Unit Access semantics\n"
1381 " -i, -- treat request as invalid, for exercising stats\n"
1382 " -q, -- quiet mode, do not show I/O statistics\n"
1383 " -u, -- with -z, allow unmapping\n"
1384 " -z, -- write zeroes using blk_aio_pwrite_zeroes\n"
1385 "\n");
1388 static int aio_write_f(BlockBackend *blk, int argc, char **argv);
1390 static const cmdinfo_t aio_write_cmd = {
1391 .name = "aio_write",
1392 .cfunc = aio_write_f,
1393 .argmin = 2,
1394 .argmax = -1,
1395 .args = "[-Cfiquz] [-P pattern] off len [len..]",
1396 .oneline = "asynchronously writes a number of bytes",
1397 .help = aio_write_help,
1400 static int aio_write_f(BlockBackend *blk, int argc, char **argv)
1402 int nr_iov, c;
1403 int pattern = 0xcd;
1404 struct aio_ctx *ctx = g_new0(struct aio_ctx, 1);
1405 int flags = 0;
1407 ctx->blk = blk;
1408 while ((c = getopt(argc, argv, "CfiqP:uz")) != -1) {
1409 switch (c) {
1410 case 'C':
1411 ctx->Cflag = true;
1412 break;
1413 case 'f':
1414 flags |= BDRV_REQ_FUA;
1415 break;
1416 case 'q':
1417 ctx->qflag = true;
1418 break;
1419 case 'u':
1420 flags |= BDRV_REQ_MAY_UNMAP;
1421 break;
1422 case 'P':
1423 pattern = parse_pattern(optarg);
1424 if (pattern < 0) {
1425 g_free(ctx);
1426 return 0;
1428 break;
1429 case 'i':
1430 printf("injecting invalid write request\n");
1431 block_acct_invalid(blk_get_stats(blk), BLOCK_ACCT_WRITE);
1432 g_free(ctx);
1433 return 0;
1434 case 'z':
1435 ctx->zflag = true;
1436 break;
1437 default:
1438 g_free(ctx);
1439 return qemuio_command_usage(&aio_write_cmd);
1443 if (optind > argc - 2) {
1444 g_free(ctx);
1445 return qemuio_command_usage(&aio_write_cmd);
1448 if (ctx->zflag && optind != argc - 2) {
1449 printf("-z supports only a single length parameter\n");
1450 g_free(ctx);
1451 return 0;
1454 if ((flags & BDRV_REQ_MAY_UNMAP) && !ctx->zflag) {
1455 printf("-u requires -z to be specified\n");
1456 g_free(ctx);
1457 return 0;
1460 if (ctx->zflag && ctx->Pflag) {
1461 printf("-z and -P cannot be specified at the same time\n");
1462 g_free(ctx);
1463 return 0;
1466 ctx->offset = cvtnum(argv[optind]);
1467 if (ctx->offset < 0) {
1468 print_cvtnum_err(ctx->offset, argv[optind]);
1469 g_free(ctx);
1470 return 0;
1472 optind++;
1474 if (ctx->zflag) {
1475 int64_t count = cvtnum(argv[optind]);
1476 if (count < 0) {
1477 print_cvtnum_err(count, argv[optind]);
1478 g_free(ctx);
1479 return 0;
1482 ctx->qiov.size = count;
1483 blk_aio_pwrite_zeroes(blk, ctx->offset, count, flags, aio_write_done,
1484 ctx);
1485 } else {
1486 nr_iov = argc - optind;
1487 ctx->buf = create_iovec(blk, &ctx->qiov, &argv[optind], nr_iov,
1488 pattern);
1489 if (ctx->buf == NULL) {
1490 block_acct_invalid(blk_get_stats(blk), BLOCK_ACCT_WRITE);
1491 g_free(ctx);
1492 return 0;
1495 gettimeofday(&ctx->t1, NULL);
1496 block_acct_start(blk_get_stats(blk), &ctx->acct, ctx->qiov.size,
1497 BLOCK_ACCT_WRITE);
1499 blk_aio_pwritev(blk, ctx->offset, &ctx->qiov, flags, aio_write_done,
1500 ctx);
1502 return 0;
1505 static int aio_flush_f(BlockBackend *blk, int argc, char **argv)
1507 BlockAcctCookie cookie;
1508 block_acct_start(blk_get_stats(blk), &cookie, 0, BLOCK_ACCT_FLUSH);
1509 blk_drain_all();
1510 block_acct_done(blk_get_stats(blk), &cookie);
1511 return 0;
1514 static const cmdinfo_t aio_flush_cmd = {
1515 .name = "aio_flush",
1516 .cfunc = aio_flush_f,
1517 .oneline = "completes all outstanding aio requests"
1520 static int flush_f(BlockBackend *blk, int argc, char **argv)
1522 blk_flush(blk);
1523 return 0;
1526 static const cmdinfo_t flush_cmd = {
1527 .name = "flush",
1528 .altname = "f",
1529 .cfunc = flush_f,
1530 .oneline = "flush all in-core file state to disk",
1533 static int truncate_f(BlockBackend *blk, int argc, char **argv)
1535 int64_t offset;
1536 int ret;
1538 offset = cvtnum(argv[1]);
1539 if (offset < 0) {
1540 print_cvtnum_err(offset, argv[1]);
1541 return 0;
1544 ret = blk_truncate(blk, offset);
1545 if (ret < 0) {
1546 printf("truncate: %s\n", strerror(-ret));
1547 return 0;
1550 return 0;
1553 static const cmdinfo_t truncate_cmd = {
1554 .name = "truncate",
1555 .altname = "t",
1556 .cfunc = truncate_f,
1557 .argmin = 1,
1558 .argmax = 1,
1559 .args = "off",
1560 .oneline = "truncates the current file at the given offset",
1563 static int length_f(BlockBackend *blk, int argc, char **argv)
1565 int64_t size;
1566 char s1[64];
1568 size = blk_getlength(blk);
1569 if (size < 0) {
1570 printf("getlength: %s\n", strerror(-size));
1571 return 0;
1574 cvtstr(size, s1, sizeof(s1));
1575 printf("%s\n", s1);
1576 return 0;
1580 static const cmdinfo_t length_cmd = {
1581 .name = "length",
1582 .altname = "l",
1583 .cfunc = length_f,
1584 .oneline = "gets the length of the current file",
1588 static int info_f(BlockBackend *blk, int argc, char **argv)
1590 BlockDriverState *bs = blk_bs(blk);
1591 BlockDriverInfo bdi;
1592 ImageInfoSpecific *spec_info;
1593 char s1[64], s2[64];
1594 int ret;
1596 if (bs->drv && bs->drv->format_name) {
1597 printf("format name: %s\n", bs->drv->format_name);
1599 if (bs->drv && bs->drv->protocol_name) {
1600 printf("format name: %s\n", bs->drv->protocol_name);
1603 ret = bdrv_get_info(bs, &bdi);
1604 if (ret) {
1605 return 0;
1608 cvtstr(bdi.cluster_size, s1, sizeof(s1));
1609 cvtstr(bdi.vm_state_offset, s2, sizeof(s2));
1611 printf("cluster size: %s\n", s1);
1612 printf("vm state offset: %s\n", s2);
1614 spec_info = bdrv_get_specific_info(bs);
1615 if (spec_info) {
1616 printf("Format specific information:\n");
1617 bdrv_image_info_specific_dump(fprintf, stdout, spec_info);
1618 qapi_free_ImageInfoSpecific(spec_info);
1621 return 0;
1626 static const cmdinfo_t info_cmd = {
1627 .name = "info",
1628 .altname = "i",
1629 .cfunc = info_f,
1630 .oneline = "prints information about the current file",
1633 static void discard_help(void)
1635 printf(
1636 "\n"
1637 " discards a range of bytes from the given offset\n"
1638 "\n"
1639 " Example:\n"
1640 " 'discard 512 1k' - discards 1 kilobyte from 512 bytes into the file\n"
1641 "\n"
1642 " Discards a segment of the currently open file.\n"
1643 " -C, -- report statistics in a machine parsable format\n"
1644 " -q, -- quiet mode, do not show I/O statistics\n"
1645 "\n");
1648 static int discard_f(BlockBackend *blk, int argc, char **argv);
1650 static const cmdinfo_t discard_cmd = {
1651 .name = "discard",
1652 .altname = "d",
1653 .cfunc = discard_f,
1654 .argmin = 2,
1655 .argmax = -1,
1656 .args = "[-Cq] off len",
1657 .oneline = "discards a number of bytes at a specified offset",
1658 .help = discard_help,
1661 static int discard_f(BlockBackend *blk, int argc, char **argv)
1663 struct timeval t1, t2;
1664 bool Cflag = false, qflag = false;
1665 int c, ret;
1666 int64_t offset, count;
1668 while ((c = getopt(argc, argv, "Cq")) != -1) {
1669 switch (c) {
1670 case 'C':
1671 Cflag = true;
1672 break;
1673 case 'q':
1674 qflag = true;
1675 break;
1676 default:
1677 return qemuio_command_usage(&discard_cmd);
1681 if (optind != argc - 2) {
1682 return qemuio_command_usage(&discard_cmd);
1685 offset = cvtnum(argv[optind]);
1686 if (offset < 0) {
1687 print_cvtnum_err(offset, argv[optind]);
1688 return 0;
1691 optind++;
1692 count = cvtnum(argv[optind]);
1693 if (count < 0) {
1694 print_cvtnum_err(count, argv[optind]);
1695 return 0;
1696 } else if (count >> BDRV_SECTOR_BITS > BDRV_REQUEST_MAX_SECTORS) {
1697 printf("length cannot exceed %"PRIu64", given %s\n",
1698 (uint64_t)BDRV_REQUEST_MAX_SECTORS << BDRV_SECTOR_BITS,
1699 argv[optind]);
1700 return 0;
1703 gettimeofday(&t1, NULL);
1704 ret = blk_pdiscard(blk, offset, count);
1705 gettimeofday(&t2, NULL);
1707 if (ret < 0) {
1708 printf("discard failed: %s\n", strerror(-ret));
1709 goto out;
1712 /* Finally, report back -- -C gives a parsable format */
1713 if (!qflag) {
1714 t2 = tsub(t2, t1);
1715 print_report("discard", &t2, offset, count, count, 1, Cflag);
1718 out:
1719 return 0;
1722 static int alloc_f(BlockBackend *blk, int argc, char **argv)
1724 BlockDriverState *bs = blk_bs(blk);
1725 int64_t offset, sector_num, nb_sectors, remaining;
1726 char s1[64];
1727 int num, ret;
1728 int64_t sum_alloc;
1730 offset = cvtnum(argv[1]);
1731 if (offset < 0) {
1732 print_cvtnum_err(offset, argv[1]);
1733 return 0;
1734 } else if (offset & 0x1ff) {
1735 printf("offset %" PRId64 " is not sector aligned\n",
1736 offset);
1737 return 0;
1740 if (argc == 3) {
1741 nb_sectors = cvtnum(argv[2]);
1742 if (nb_sectors < 0) {
1743 print_cvtnum_err(nb_sectors, argv[2]);
1744 return 0;
1745 } else if (nb_sectors > INT_MAX) {
1746 printf("length argument cannot exceed %d, given %s\n",
1747 INT_MAX, argv[2]);
1748 return 0;
1750 } else {
1751 nb_sectors = 1;
1754 remaining = nb_sectors;
1755 sum_alloc = 0;
1756 sector_num = offset >> 9;
1757 while (remaining) {
1758 ret = bdrv_is_allocated(bs, sector_num, remaining, &num);
1759 if (ret < 0) {
1760 printf("is_allocated failed: %s\n", strerror(-ret));
1761 return 0;
1763 sector_num += num;
1764 remaining -= num;
1765 if (ret) {
1766 sum_alloc += num;
1768 if (num == 0) {
1769 nb_sectors -= remaining;
1770 remaining = 0;
1774 cvtstr(offset, s1, sizeof(s1));
1776 printf("%"PRId64"/%"PRId64" sectors allocated at offset %s\n",
1777 sum_alloc, nb_sectors, s1);
1778 return 0;
1781 static const cmdinfo_t alloc_cmd = {
1782 .name = "alloc",
1783 .altname = "a",
1784 .argmin = 1,
1785 .argmax = 2,
1786 .cfunc = alloc_f,
1787 .args = "off [sectors]",
1788 .oneline = "checks if a sector is present in the file",
1792 static int map_is_allocated(BlockDriverState *bs, int64_t sector_num,
1793 int64_t nb_sectors, int64_t *pnum)
1795 int num, num_checked;
1796 int ret, firstret;
1798 num_checked = MIN(nb_sectors, INT_MAX);
1799 ret = bdrv_is_allocated(bs, sector_num, num_checked, &num);
1800 if (ret < 0) {
1801 return ret;
1804 firstret = ret;
1805 *pnum = num;
1807 while (nb_sectors > 0 && ret == firstret) {
1808 sector_num += num;
1809 nb_sectors -= num;
1811 num_checked = MIN(nb_sectors, INT_MAX);
1812 ret = bdrv_is_allocated(bs, sector_num, num_checked, &num);
1813 if (ret == firstret && num) {
1814 *pnum += num;
1815 } else {
1816 break;
1820 return firstret;
1823 static int map_f(BlockBackend *blk, int argc, char **argv)
1825 int64_t offset;
1826 int64_t nb_sectors, total_sectors;
1827 char s1[64];
1828 int64_t num;
1829 int ret;
1830 const char *retstr;
1832 offset = 0;
1833 total_sectors = blk_nb_sectors(blk);
1834 if (total_sectors < 0) {
1835 error_report("Failed to query image length: %s",
1836 strerror(-total_sectors));
1837 return 0;
1840 nb_sectors = total_sectors;
1842 do {
1843 ret = map_is_allocated(blk_bs(blk), offset, nb_sectors, &num);
1844 if (ret < 0) {
1845 error_report("Failed to get allocation status: %s", strerror(-ret));
1846 return 0;
1847 } else if (!num) {
1848 error_report("Unexpected end of image");
1849 return 0;
1852 retstr = ret ? " allocated" : "not allocated";
1853 cvtstr(offset << 9ULL, s1, sizeof(s1));
1854 printf("[% 24" PRId64 "] % 8" PRId64 "/% 8" PRId64 " sectors %s "
1855 "at offset %s (%d)\n",
1856 offset << 9ULL, num, nb_sectors, retstr, s1, ret);
1858 offset += num;
1859 nb_sectors -= num;
1860 } while (offset < total_sectors);
1862 return 0;
1865 static const cmdinfo_t map_cmd = {
1866 .name = "map",
1867 .argmin = 0,
1868 .argmax = 0,
1869 .cfunc = map_f,
1870 .args = "",
1871 .oneline = "prints the allocated areas of a file",
1874 static void reopen_help(void)
1876 printf(
1877 "\n"
1878 " Changes the open options of an already opened image\n"
1879 "\n"
1880 " Example:\n"
1881 " 'reopen -o lazy-refcounts=on' - activates lazy refcount writeback on a qcow2 image\n"
1882 "\n"
1883 " -r, -- Reopen the image read-only\n"
1884 " -c, -- Change the cache mode to the given value\n"
1885 " -o, -- Changes block driver options (cf. 'open' command)\n"
1886 "\n");
1889 static int reopen_f(BlockBackend *blk, int argc, char **argv);
1891 static QemuOptsList reopen_opts = {
1892 .name = "reopen",
1893 .merge_lists = true,
1894 .head = QTAILQ_HEAD_INITIALIZER(reopen_opts.head),
1895 .desc = {
1896 /* no elements => accept any params */
1897 { /* end of list */ }
1901 static const cmdinfo_t reopen_cmd = {
1902 .name = "reopen",
1903 .argmin = 0,
1904 .argmax = -1,
1905 .cfunc = reopen_f,
1906 .args = "[-r] [-c cache] [-o options]",
1907 .oneline = "reopens an image with new options",
1908 .help = reopen_help,
1911 static int reopen_f(BlockBackend *blk, int argc, char **argv)
1913 BlockDriverState *bs = blk_bs(blk);
1914 QemuOpts *qopts;
1915 QDict *opts;
1916 int c;
1917 int flags = bs->open_flags;
1918 bool writethrough = !blk_enable_write_cache(blk);
1920 BlockReopenQueue *brq;
1921 Error *local_err = NULL;
1923 while ((c = getopt(argc, argv, "c:o:r")) != -1) {
1924 switch (c) {
1925 case 'c':
1926 if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) < 0) {
1927 error_report("Invalid cache option: %s", optarg);
1928 return 0;
1930 break;
1931 case 'o':
1932 if (!qemu_opts_parse_noisily(&reopen_opts, optarg, 0)) {
1933 qemu_opts_reset(&reopen_opts);
1934 return 0;
1936 break;
1937 case 'r':
1938 flags &= ~BDRV_O_RDWR;
1939 break;
1940 default:
1941 qemu_opts_reset(&reopen_opts);
1942 return qemuio_command_usage(&reopen_cmd);
1946 if (optind != argc) {
1947 qemu_opts_reset(&reopen_opts);
1948 return qemuio_command_usage(&reopen_cmd);
1951 if (writethrough != blk_enable_write_cache(blk) &&
1952 blk_get_attached_dev(blk))
1954 error_report("Cannot change cache.writeback: Device attached");
1955 qemu_opts_reset(&reopen_opts);
1956 return 0;
1959 qopts = qemu_opts_find(&reopen_opts, NULL);
1960 opts = qopts ? qemu_opts_to_qdict(qopts, NULL) : NULL;
1961 qemu_opts_reset(&reopen_opts);
1963 brq = bdrv_reopen_queue(NULL, bs, opts, flags);
1964 bdrv_reopen_multiple(bdrv_get_aio_context(bs), brq, &local_err);
1965 if (local_err) {
1966 error_report_err(local_err);
1967 } else {
1968 blk_set_enable_write_cache(blk, !writethrough);
1971 return 0;
1974 static int break_f(BlockBackend *blk, int argc, char **argv)
1976 int ret;
1978 ret = bdrv_debug_breakpoint(blk_bs(blk), argv[1], argv[2]);
1979 if (ret < 0) {
1980 printf("Could not set breakpoint: %s\n", strerror(-ret));
1983 return 0;
1986 static int remove_break_f(BlockBackend *blk, int argc, char **argv)
1988 int ret;
1990 ret = bdrv_debug_remove_breakpoint(blk_bs(blk), argv[1]);
1991 if (ret < 0) {
1992 printf("Could not remove breakpoint %s: %s\n", argv[1], strerror(-ret));
1995 return 0;
1998 static const cmdinfo_t break_cmd = {
1999 .name = "break",
2000 .argmin = 2,
2001 .argmax = 2,
2002 .cfunc = break_f,
2003 .args = "event tag",
2004 .oneline = "sets a breakpoint on event and tags the stopped "
2005 "request as tag",
2008 static const cmdinfo_t remove_break_cmd = {
2009 .name = "remove_break",
2010 .argmin = 1,
2011 .argmax = 1,
2012 .cfunc = remove_break_f,
2013 .args = "tag",
2014 .oneline = "remove a breakpoint by tag",
2017 static int resume_f(BlockBackend *blk, int argc, char **argv)
2019 int ret;
2021 ret = bdrv_debug_resume(blk_bs(blk), argv[1]);
2022 if (ret < 0) {
2023 printf("Could not resume request: %s\n", strerror(-ret));
2026 return 0;
2029 static const cmdinfo_t resume_cmd = {
2030 .name = "resume",
2031 .argmin = 1,
2032 .argmax = 1,
2033 .cfunc = resume_f,
2034 .args = "tag",
2035 .oneline = "resumes the request tagged as tag",
2038 static int wait_break_f(BlockBackend *blk, int argc, char **argv)
2040 while (!bdrv_debug_is_suspended(blk_bs(blk), argv[1])) {
2041 aio_poll(blk_get_aio_context(blk), true);
2044 return 0;
2047 static const cmdinfo_t wait_break_cmd = {
2048 .name = "wait_break",
2049 .argmin = 1,
2050 .argmax = 1,
2051 .cfunc = wait_break_f,
2052 .args = "tag",
2053 .oneline = "waits for the suspension of a request",
2056 static int abort_f(BlockBackend *blk, int argc, char **argv)
2058 abort();
2061 static const cmdinfo_t abort_cmd = {
2062 .name = "abort",
2063 .cfunc = abort_f,
2064 .flags = CMD_NOFILE_OK,
2065 .oneline = "simulate a program crash using abort(3)",
2068 static void sigraise_help(void)
2070 printf(
2071 "\n"
2072 " raises the given signal\n"
2073 "\n"
2074 " Example:\n"
2075 " 'sigraise %i' - raises SIGTERM\n"
2076 "\n"
2077 " Invokes raise(signal), where \"signal\" is the mandatory integer argument\n"
2078 " given to sigraise.\n"
2079 "\n", SIGTERM);
2082 static int sigraise_f(BlockBackend *blk, int argc, char **argv);
2084 static const cmdinfo_t sigraise_cmd = {
2085 .name = "sigraise",
2086 .cfunc = sigraise_f,
2087 .argmin = 1,
2088 .argmax = 1,
2089 .flags = CMD_NOFILE_OK,
2090 .args = "signal",
2091 .oneline = "raises a signal",
2092 .help = sigraise_help,
2095 static int sigraise_f(BlockBackend *blk, int argc, char **argv)
2097 int64_t sig = cvtnum(argv[1]);
2098 if (sig < 0) {
2099 print_cvtnum_err(sig, argv[1]);
2100 return 0;
2101 } else if (sig > NSIG) {
2102 printf("signal argument '%s' is too large to be a valid signal\n",
2103 argv[1]);
2104 return 0;
2107 /* Using raise() to kill this process does not necessarily flush all open
2108 * streams. At least stdout and stderr (although the latter should be
2109 * non-buffered anyway) should be flushed, though. */
2110 fflush(stdout);
2111 fflush(stderr);
2113 raise(sig);
2114 return 0;
2117 static void sleep_cb(void *opaque)
2119 bool *expired = opaque;
2120 *expired = true;
2123 static int sleep_f(BlockBackend *blk, int argc, char **argv)
2125 char *endptr;
2126 long ms;
2127 struct QEMUTimer *timer;
2128 bool expired = false;
2130 ms = strtol(argv[1], &endptr, 0);
2131 if (ms < 0 || *endptr != '\0') {
2132 printf("%s is not a valid number\n", argv[1]);
2133 return 0;
2136 timer = timer_new_ns(QEMU_CLOCK_HOST, sleep_cb, &expired);
2137 timer_mod(timer, qemu_clock_get_ns(QEMU_CLOCK_HOST) + SCALE_MS * ms);
2139 while (!expired) {
2140 main_loop_wait(false);
2143 timer_free(timer);
2145 return 0;
2148 static const cmdinfo_t sleep_cmd = {
2149 .name = "sleep",
2150 .argmin = 1,
2151 .argmax = 1,
2152 .cfunc = sleep_f,
2153 .flags = CMD_NOFILE_OK,
2154 .oneline = "waits for the given value in milliseconds",
2157 static void help_oneline(const char *cmd, const cmdinfo_t *ct)
2159 if (cmd) {
2160 printf("%s ", cmd);
2161 } else {
2162 printf("%s ", ct->name);
2163 if (ct->altname) {
2164 printf("(or %s) ", ct->altname);
2168 if (ct->args) {
2169 printf("%s ", ct->args);
2171 printf("-- %s\n", ct->oneline);
2174 static void help_onecmd(const char *cmd, const cmdinfo_t *ct)
2176 help_oneline(cmd, ct);
2177 if (ct->help) {
2178 ct->help();
2182 static void help_all(void)
2184 const cmdinfo_t *ct;
2186 for (ct = cmdtab; ct < &cmdtab[ncmds]; ct++) {
2187 help_oneline(ct->name, ct);
2189 printf("\nUse 'help commandname' for extended help.\n");
2192 static int help_f(BlockBackend *blk, int argc, char **argv)
2194 const cmdinfo_t *ct;
2196 if (argc == 1) {
2197 help_all();
2198 return 0;
2201 ct = find_command(argv[1]);
2202 if (ct == NULL) {
2203 printf("command %s not found\n", argv[1]);
2204 return 0;
2207 help_onecmd(argv[1], ct);
2208 return 0;
2211 static const cmdinfo_t help_cmd = {
2212 .name = "help",
2213 .altname = "?",
2214 .cfunc = help_f,
2215 .argmin = 0,
2216 .argmax = 1,
2217 .flags = CMD_FLAG_GLOBAL,
2218 .args = "[command]",
2219 .oneline = "help for one or all commands",
2222 bool qemuio_command(BlockBackend *blk, const char *cmd)
2224 AioContext *ctx;
2225 char *input;
2226 const cmdinfo_t *ct;
2227 char **v;
2228 int c;
2229 bool done = false;
2231 input = g_strdup(cmd);
2232 v = breakline(input, &c);
2233 if (c) {
2234 ct = find_command(v[0]);
2235 if (ct) {
2236 ctx = blk ? blk_get_aio_context(blk) : qemu_get_aio_context();
2237 aio_context_acquire(ctx);
2238 done = command(blk, ct, c, v);
2239 aio_context_release(ctx);
2240 } else {
2241 fprintf(stderr, "command \"%s\" not found\n", v[0]);
2244 g_free(input);
2245 g_free(v);
2247 return done;
2250 static void __attribute((constructor)) init_qemuio_commands(void)
2252 /* initialize commands */
2253 qemuio_add_command(&help_cmd);
2254 qemuio_add_command(&read_cmd);
2255 qemuio_add_command(&readv_cmd);
2256 qemuio_add_command(&write_cmd);
2257 qemuio_add_command(&writev_cmd);
2258 qemuio_add_command(&aio_read_cmd);
2259 qemuio_add_command(&aio_write_cmd);
2260 qemuio_add_command(&aio_flush_cmd);
2261 qemuio_add_command(&flush_cmd);
2262 qemuio_add_command(&truncate_cmd);
2263 qemuio_add_command(&length_cmd);
2264 qemuio_add_command(&info_cmd);
2265 qemuio_add_command(&discard_cmd);
2266 qemuio_add_command(&alloc_cmd);
2267 qemuio_add_command(&map_cmd);
2268 qemuio_add_command(&reopen_cmd);
2269 qemuio_add_command(&break_cmd);
2270 qemuio_add_command(&remove_break_cmd);
2271 qemuio_add_command(&resume_cmd);
2272 qemuio_add_command(&wait_break_cmd);
2273 qemuio_add_command(&abort_cmd);
2274 qemuio_add_command(&sleep_cmd);
2275 qemuio_add_command(&sigraise_cmd);