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"
13 #include "qapi/qmp/qdict.h"
15 #include "sysemu/block-backend.h"
16 #include "block/block.h"
17 #include "block/block_int.h" /* for info_f() */
18 #include "block/qapi.h"
19 #include "qemu/error-report.h"
20 #include "qemu/main-loop.h"
21 #include "qemu/option.h"
22 #include "qemu/timer.h"
23 #include "qemu/cutils.h"
24 #include "qemu/memalign.h"
26 #define CMD_NOFILE_OK 0x01
30 static cmdinfo_t
*cmdtab
;
33 static int compare_cmdname(const void *a
, const void *b
)
35 return strcmp(((const cmdinfo_t
*)a
)->name
,
36 ((const cmdinfo_t
*)b
)->name
);
39 void qemuio_add_command(const cmdinfo_t
*ci
)
41 /* ci->perm assumes a file is open, but the GLOBAL and NOFILE_OK
42 * flags allow it not to be, so that combination is invalid.
43 * Catch it now rather than letting it manifest as a crash if a
44 * particular set of command line options are used.
46 assert(ci
->perm
== 0 ||
47 (ci
->flags
& (CMD_FLAG_GLOBAL
| CMD_NOFILE_OK
)) == 0);
48 cmdtab
= g_renew(cmdinfo_t
, cmdtab
, ++ncmds
);
49 cmdtab
[ncmds
- 1] = *ci
;
50 qsort(cmdtab
, ncmds
, sizeof(*cmdtab
), compare_cmdname
);
53 void qemuio_command_usage(const cmdinfo_t
*ci
)
55 printf("%s %s -- %s\n", ci
->name
, ci
->args
, ci
->oneline
);
58 static int init_check_command(BlockBackend
*blk
, const cmdinfo_t
*ct
)
60 if (ct
->flags
& CMD_FLAG_GLOBAL
) {
63 if (!(ct
->flags
& CMD_NOFILE_OK
) && !blk
) {
64 fprintf(stderr
, "no file open, try 'help open'\n");
70 static int command(BlockBackend
*blk
, const cmdinfo_t
*ct
, int argc
,
75 if (!init_check_command(blk
, ct
)) {
79 if (argc
- 1 < ct
->argmin
|| (ct
->argmax
!= -1 && argc
- 1 > ct
->argmax
)) {
80 if (ct
->argmax
== -1) {
82 "bad argument count %d to %s, expected at least %d arguments\n",
83 argc
-1, cmd
, ct
->argmin
);
84 } else if (ct
->argmin
== ct
->argmax
) {
86 "bad argument count %d to %s, expected %d arguments\n",
87 argc
-1, cmd
, ct
->argmin
);
90 "bad argument count %d to %s, expected between %d and %d arguments\n",
91 argc
-1, cmd
, ct
->argmin
, ct
->argmax
);
97 * Request additional permissions if necessary for this command. The caller
98 * is responsible for restoring the original permissions afterwards if this
101 * Coverity thinks that blk may be NULL in the following if condition. It's
102 * not so: in init_check_command() we fail if blk is NULL for command with
103 * both CMD_FLAG_GLOBAL and CMD_NOFILE_OK flags unset. And in
104 * qemuio_add_command() we assert that command with non-zero .perm field
105 * doesn't set this flags. So, the following assertion is to silence
108 assert(blk
|| !ct
->perm
);
109 if (ct
->perm
&& blk_is_available(blk
)) {
110 uint64_t orig_perm
, orig_shared_perm
;
111 blk_get_perm(blk
, &orig_perm
, &orig_shared_perm
);
113 if (ct
->perm
& ~orig_perm
) {
115 Error
*local_err
= NULL
;
118 new_perm
= orig_perm
| ct
->perm
;
120 ret
= blk_set_perm(blk
, new_perm
, orig_shared_perm
, &local_err
);
122 error_report_err(local_err
);
129 return ct
->cfunc(blk
, argc
, argv
);
132 static const cmdinfo_t
*find_command(const char *cmd
)
136 for (ct
= cmdtab
; ct
< &cmdtab
[ncmds
]; ct
++) {
137 if (strcmp(ct
->name
, cmd
) == 0 ||
138 (ct
->altname
&& strcmp(ct
->altname
, cmd
) == 0))
140 return (const cmdinfo_t
*)ct
;
146 /* Invoke fn() for commands with a matching prefix */
147 void qemuio_complete_command(const char *input
,
148 void (*fn
)(const char *cmd
, void *opaque
),
152 size_t input_len
= strlen(input
);
154 for (ct
= cmdtab
; ct
< &cmdtab
[ncmds
]; ct
++) {
155 if (strncmp(input
, ct
->name
, input_len
) == 0) {
156 fn(ct
->name
, opaque
);
161 static char **breakline(char *input
, int *count
)
165 char **rval
= g_new0(char *, 1);
167 while (rval
&& (p
= qemu_strsep(&input
, " ")) != NULL
) {
172 rval
= g_renew(char *, rval
, (c
+ 1));
180 static int64_t cvtnum(const char *s
)
185 err
= qemu_strtosz(s
, NULL
, &value
);
189 if (value
> INT64_MAX
) {
195 static void print_cvtnum_err(int64_t rc
, const char *arg
)
199 printf("Parsing error: non-numeric argument,"
200 " or extraneous/unrecognized suffix -- %s\n", arg
);
203 printf("Parsing error: argument too large -- %s\n", arg
);
206 printf("Parsing error: %s\n", arg
);
210 #define EXABYTES(x) ((long long)(x) << 60)
211 #define PETABYTES(x) ((long long)(x) << 50)
212 #define TERABYTES(x) ((long long)(x) << 40)
213 #define GIGABYTES(x) ((long long)(x) << 30)
214 #define MEGABYTES(x) ((long long)(x) << 20)
215 #define KILOBYTES(x) ((long long)(x) << 10)
217 #define TO_EXABYTES(x) ((x) / EXABYTES(1))
218 #define TO_PETABYTES(x) ((x) / PETABYTES(1))
219 #define TO_TERABYTES(x) ((x) / TERABYTES(1))
220 #define TO_GIGABYTES(x) ((x) / GIGABYTES(1))
221 #define TO_MEGABYTES(x) ((x) / MEGABYTES(1))
222 #define TO_KILOBYTES(x) ((x) / KILOBYTES(1))
224 static void cvtstr(double value
, char *str
, size_t size
)
229 if (value
>= EXABYTES(1)) {
231 snprintf(str
, size
- 4, "%.3f", TO_EXABYTES(value
));
232 } else if (value
>= PETABYTES(1)) {
234 snprintf(str
, size
- 4, "%.3f", TO_PETABYTES(value
));
235 } else if (value
>= TERABYTES(1)) {
237 snprintf(str
, size
- 4, "%.3f", TO_TERABYTES(value
));
238 } else if (value
>= GIGABYTES(1)) {
240 snprintf(str
, size
- 4, "%.3f", TO_GIGABYTES(value
));
241 } else if (value
>= MEGABYTES(1)) {
243 snprintf(str
, size
- 4, "%.3f", TO_MEGABYTES(value
));
244 } else if (value
>= KILOBYTES(1)) {
246 snprintf(str
, size
- 4, "%.3f", TO_KILOBYTES(value
));
249 snprintf(str
, size
- 6, "%f", value
);
252 trim
= strstr(str
, ".000");
254 strcpy(trim
, suffix
);
262 static struct timespec
tsub(struct timespec t1
, struct timespec t2
)
264 t1
.tv_nsec
-= t2
.tv_nsec
;
265 if (t1
.tv_nsec
< 0) {
266 t1
.tv_nsec
+= NANOSECONDS_PER_SECOND
;
269 t1
.tv_sec
-= t2
.tv_sec
;
273 static double tdiv(double value
, struct timespec tv
)
275 double seconds
= tv
.tv_sec
+ (tv
.tv_nsec
/ 1e9
);
276 return value
/ seconds
;
279 #define HOURS(sec) ((sec) / (60 * 60))
280 #define MINUTES(sec) (((sec) % (60 * 60)) / 60)
281 #define SECONDS(sec) ((sec) % 60)
285 TERSE_FIXED_TIME
= 0x1,
286 VERBOSE_FIXED_TIME
= 0x2,
289 static void timestr(struct timespec
*tv
, char *ts
, size_t size
, int format
)
291 double frac_sec
= tv
->tv_nsec
/ 1e9
;
293 if (format
& TERSE_FIXED_TIME
) {
294 if (!HOURS(tv
->tv_sec
)) {
295 snprintf(ts
, size
, "%u:%05.2f",
296 (unsigned int) MINUTES(tv
->tv_sec
),
297 SECONDS(tv
->tv_sec
) + frac_sec
);
300 format
|= VERBOSE_FIXED_TIME
; /* fallback if hours needed */
303 if ((format
& VERBOSE_FIXED_TIME
) || tv
->tv_sec
) {
304 snprintf(ts
, size
, "%u:%02u:%05.2f",
305 (unsigned int) HOURS(tv
->tv_sec
),
306 (unsigned int) MINUTES(tv
->tv_sec
),
307 SECONDS(tv
->tv_sec
) + frac_sec
);
309 snprintf(ts
, size
, "%05.2f sec", frac_sec
);
314 * Parse the pattern argument to various sub-commands.
316 * Because the pattern is used as an argument to memset it must evaluate
317 * to an unsigned integer that fits into a single byte.
319 static int parse_pattern(const char *arg
)
324 pattern
= strtol(arg
, &endptr
, 0);
325 if (pattern
< 0 || pattern
> UCHAR_MAX
|| *endptr
!= '\0') {
326 printf("%s is not a valid pattern byte\n", arg
);
334 * Memory allocation helpers.
336 * Make sure memory is aligned by default, or purposefully misaligned if
337 * that is specified on the command line.
340 #define MISALIGN_OFFSET 16
341 static void *qemu_io_alloc(BlockBackend
*blk
, size_t len
, int pattern
)
345 if (qemuio_misalign
) {
346 len
+= MISALIGN_OFFSET
;
348 buf
= blk_blockalign(blk
, len
);
349 memset(buf
, pattern
, len
);
350 if (qemuio_misalign
) {
351 buf
+= MISALIGN_OFFSET
;
356 static void qemu_io_free(void *p
)
358 if (qemuio_misalign
) {
359 p
-= MISALIGN_OFFSET
;
365 * qemu_io_alloc_from_file()
367 * Allocates the buffer and populates it with the content of the given file
368 * up to @len bytes. If the file length is less than @len, then the buffer
369 * is populated with the file content cyclically.
371 * @blk - the block backend where the buffer content is going to be written to
372 * @len - the buffer length
373 * @file_name - the file to read the content from
375 * Returns: the buffer pointer on success
378 static void *qemu_io_alloc_from_file(BlockBackend
*blk
, size_t len
,
379 const char *file_name
)
381 char *buf
, *buf_origin
;
382 FILE *f
= fopen(file_name
, "r");
390 if (qemuio_misalign
) {
391 len
+= MISALIGN_OFFSET
;
394 buf_origin
= buf
= blk_blockalign(blk
, len
);
396 if (qemuio_misalign
) {
397 buf_origin
+= MISALIGN_OFFSET
;
398 buf
+= MISALIGN_OFFSET
;
399 len
-= MISALIGN_OFFSET
;
402 pattern_len
= fread(buf_origin
, 1, len
, f
);
409 if (pattern_len
== 0) {
410 fprintf(stderr
, "%s: file is empty\n", file_name
);
417 if (len
> pattern_len
) {
422 size_t len_to_copy
= MIN(pattern_len
, len
);
424 memcpy(buf
, buf_origin
, len_to_copy
);
434 qemu_io_free(buf_origin
);
441 static void dump_buffer(const void *buffer
, int64_t offset
, int64_t len
)
447 for (i
= 0, p
= buffer
; i
< len
; i
+= 16) {
448 const uint8_t *s
= p
;
450 printf("%08" PRIx64
": ", offset
+ i
);
451 for (j
= 0; j
< 16 && i
+ j
< len
; j
++, p
++) {
455 for (j
= 0; j
< 16 && i
+ j
< len
; j
++, s
++) {
466 static void print_report(const char *op
, struct timespec
*t
, int64_t offset
,
467 int64_t count
, int64_t total
, int cnt
, bool Cflag
)
469 char s1
[64], s2
[64], ts
[64];
471 timestr(t
, ts
, sizeof(ts
), Cflag
? VERBOSE_FIXED_TIME
: 0);
473 cvtstr((double)total
, s1
, sizeof(s1
));
474 cvtstr(tdiv((double)total
, *t
), s2
, sizeof(s2
));
475 printf("%s %"PRId64
"/%"PRId64
" bytes at offset %" PRId64
"\n",
476 op
, total
, count
, offset
);
477 printf("%s, %d ops; %s (%s/sec and %.4f ops/sec)\n",
478 s1
, cnt
, ts
, s2
, tdiv((double)cnt
, *t
));
479 } else {/* bytes,ops,time,bytes/sec,ops/sec */
480 printf("%"PRId64
",%d,%s,%.3f,%.3f\n",
482 tdiv((double)total
, *t
),
483 tdiv((double)cnt
, *t
));
488 * Parse multiple length statements for vectored I/O, and construct an I/O
489 * vector matching it.
492 create_iovec(BlockBackend
*blk
, QEMUIOVector
*qiov
, char **argv
, int nr_iov
,
495 size_t *sizes
= g_new0(size_t, nr_iov
);
501 for (i
= 0; i
< nr_iov
; i
++) {
507 print_cvtnum_err(len
, arg
);
511 if (len
> BDRV_REQUEST_MAX_BYTES
) {
512 printf("Argument '%s' exceeds maximum size %" PRIu64
"\n", arg
,
513 (uint64_t)BDRV_REQUEST_MAX_BYTES
);
517 if (count
> BDRV_REQUEST_MAX_BYTES
- len
) {
518 printf("The total number of bytes exceed the maximum size %" PRIu64
519 "\n", (uint64_t)BDRV_REQUEST_MAX_BYTES
);
527 qemu_iovec_init(qiov
, nr_iov
);
529 buf
= p
= qemu_io_alloc(blk
, count
, pattern
);
531 for (i
= 0; i
< nr_iov
; i
++) {
532 qemu_iovec_add(qiov
, p
, sizes
[i
]);
541 static int do_pread(BlockBackend
*blk
, char *buf
, int64_t offset
,
542 int64_t bytes
, int64_t *total
)
544 if (bytes
> INT_MAX
) {
548 *total
= blk_pread(blk
, offset
, (uint8_t *)buf
, bytes
);
555 static int do_pwrite(BlockBackend
*blk
, char *buf
, int64_t offset
,
556 int64_t bytes
, int flags
, int64_t *total
)
558 if (bytes
> INT_MAX
) {
562 *total
= blk_pwrite(blk
, offset
, (uint8_t *)buf
, bytes
, flags
);
579 static void coroutine_fn
co_pwrite_zeroes_entry(void *opaque
)
581 CoWriteZeroes
*data
= opaque
;
583 data
->ret
= blk_co_pwrite_zeroes(data
->blk
, data
->offset
, data
->bytes
,
587 *data
->total
= data
->ret
;
591 *data
->total
= data
->bytes
;
594 static int do_co_pwrite_zeroes(BlockBackend
*blk
, int64_t offset
,
595 int64_t bytes
, int flags
, int64_t *total
)
598 CoWriteZeroes data
= {
607 co
= qemu_coroutine_create(co_pwrite_zeroes_entry
, &data
);
608 bdrv_coroutine_enter(blk_bs(blk
), co
);
610 aio_poll(blk_get_aio_context(blk
), true);
619 static int do_write_compressed(BlockBackend
*blk
, char *buf
, int64_t offset
,
620 int64_t bytes
, int64_t *total
)
624 if (bytes
> BDRV_REQUEST_MAX_BYTES
) {
628 ret
= blk_pwrite_compressed(blk
, offset
, buf
, bytes
);
636 static int do_load_vmstate(BlockBackend
*blk
, char *buf
, int64_t offset
,
637 int64_t count
, int64_t *total
)
639 if (count
> INT_MAX
) {
643 *total
= blk_load_vmstate(blk
, (uint8_t *)buf
, offset
, count
);
650 static int do_save_vmstate(BlockBackend
*blk
, char *buf
, int64_t offset
,
651 int64_t count
, int64_t *total
)
653 if (count
> INT_MAX
) {
657 *total
= blk_save_vmstate(blk
, (uint8_t *)buf
, offset
, count
);
664 #define NOT_DONE 0x7fffffff
665 static void aio_rw_done(void *opaque
, int ret
)
667 *(int *)opaque
= ret
;
670 static int do_aio_readv(BlockBackend
*blk
, QEMUIOVector
*qiov
,
671 int64_t offset
, int *total
)
673 int async_ret
= NOT_DONE
;
675 blk_aio_preadv(blk
, offset
, qiov
, 0, aio_rw_done
, &async_ret
);
676 while (async_ret
== NOT_DONE
) {
677 main_loop_wait(false);
681 return async_ret
< 0 ? async_ret
: 1;
684 static int do_aio_writev(BlockBackend
*blk
, QEMUIOVector
*qiov
,
685 int64_t offset
, int flags
, int *total
)
687 int async_ret
= NOT_DONE
;
689 blk_aio_pwritev(blk
, offset
, qiov
, flags
, aio_rw_done
, &async_ret
);
690 while (async_ret
== NOT_DONE
) {
691 main_loop_wait(false);
695 return async_ret
< 0 ? async_ret
: 1;
698 static void read_help(void)
702 " reads a range of bytes from the given offset\n"
705 " 'read -v 512 1k' - dumps 1 kilobyte read from 512 bytes into the file\n"
707 " Reads a segment of the currently open file, optionally dumping it to the\n"
708 " standard output stream (with -v option) for subsequent inspection.\n"
709 " -b, -- read from the VM state rather than the virtual disk\n"
710 " -C, -- report statistics in a machine parsable format\n"
711 " -l, -- length for pattern verification (only with -P)\n"
712 " -p, -- ignored for backwards compatibility\n"
713 " -P, -- use a pattern to verify read data\n"
714 " -q, -- quiet mode, do not show I/O statistics\n"
715 " -s, -- start offset for pattern verification (only with -P)\n"
716 " -v, -- dump buffer to standard output\n"
720 static int read_f(BlockBackend
*blk
, int argc
, char **argv
);
722 static const cmdinfo_t read_cmd
= {
728 .args
= "[-abCqv] [-P pattern [-s off] [-l len]] off len",
729 .oneline
= "reads a number of bytes at a specified offset",
733 static int read_f(BlockBackend
*blk
, int argc
, char **argv
)
735 struct timespec t1
, t2
;
736 bool Cflag
= false, qflag
= false, vflag
= false;
737 bool Pflag
= false, sflag
= false, lflag
= false, bflag
= false;
742 /* Some compilers get confused and warn if this is not initialized. */
745 int64_t pattern_offset
= 0, pattern_count
= 0;
747 while ((c
= getopt(argc
, argv
, "bCl:pP:qs:v")) != -1) {
757 pattern_count
= cvtnum(optarg
);
758 if (pattern_count
< 0) {
759 print_cvtnum_err(pattern_count
, optarg
);
760 return pattern_count
;
764 /* Ignored for backwards compatibility */
768 pattern
= parse_pattern(optarg
);
778 pattern_offset
= cvtnum(optarg
);
779 if (pattern_offset
< 0) {
780 print_cvtnum_err(pattern_offset
, optarg
);
781 return pattern_offset
;
788 qemuio_command_usage(&read_cmd
);
793 if (optind
!= argc
- 2) {
794 qemuio_command_usage(&read_cmd
);
798 offset
= cvtnum(argv
[optind
]);
800 print_cvtnum_err(offset
, argv
[optind
]);
805 count
= cvtnum(argv
[optind
]);
807 print_cvtnum_err(count
, argv
[optind
]);
809 } else if (count
> BDRV_REQUEST_MAX_BYTES
) {
810 printf("length cannot exceed %" PRIu64
", given %s\n",
811 (uint64_t)BDRV_REQUEST_MAX_BYTES
, argv
[optind
]);
815 if (!Pflag
&& (lflag
|| sflag
)) {
816 qemuio_command_usage(&read_cmd
);
821 pattern_count
= count
- pattern_offset
;
824 if ((pattern_count
< 0) || (pattern_count
+ pattern_offset
> count
)) {
825 printf("pattern verification range exceeds end of read data\n");
830 if (!QEMU_IS_ALIGNED(offset
, BDRV_SECTOR_SIZE
)) {
831 printf("%" PRId64
" is not a sector-aligned value for 'offset'\n",
835 if (!QEMU_IS_ALIGNED(count
, BDRV_SECTOR_SIZE
)) {
836 printf("%"PRId64
" is not a sector-aligned value for 'count'\n",
842 buf
= qemu_io_alloc(blk
, count
, 0xab);
844 clock_gettime(CLOCK_MONOTONIC
, &t1
);
846 ret
= do_load_vmstate(blk
, buf
, offset
, count
, &total
);
848 ret
= do_pread(blk
, buf
, offset
, count
, &total
);
850 clock_gettime(CLOCK_MONOTONIC
, &t2
);
853 printf("read failed: %s\n", strerror(-ret
));
861 void *cmp_buf
= g_malloc(pattern_count
);
862 memset(cmp_buf
, pattern
, pattern_count
);
863 if (memcmp(buf
+ pattern_offset
, cmp_buf
, pattern_count
)) {
864 printf("Pattern verification failed at offset %"
865 PRId64
", %"PRId64
" bytes\n",
866 offset
+ pattern_offset
, pattern_count
);
877 dump_buffer(buf
, offset
, count
);
880 /* Finally, report back -- -C gives a parsable format */
882 print_report("read", &t2
, offset
, count
, total
, cnt
, Cflag
);
889 static void readv_help(void)
893 " reads a range of bytes from the given offset into multiple buffers\n"
896 " 'readv -v 512 1k 1k ' - dumps 2 kilobytes read from 512 bytes into the file\n"
898 " Reads a segment of the currently open file, optionally dumping it to the\n"
899 " standard output stream (with -v option) for subsequent inspection.\n"
900 " Uses multiple iovec buffers if more than one byte range is specified.\n"
901 " -C, -- report statistics in a machine parsable format\n"
902 " -P, -- use a pattern to verify read data\n"
903 " -v, -- dump buffer to standard output\n"
904 " -q, -- quiet mode, do not show I/O statistics\n"
908 static int readv_f(BlockBackend
*blk
, int argc
, char **argv
);
910 static const cmdinfo_t readv_cmd
= {
915 .args
= "[-Cqv] [-P pattern] off len [len..]",
916 .oneline
= "reads a number of bytes at a specified offset",
920 static int readv_f(BlockBackend
*blk
, int argc
, char **argv
)
922 struct timespec t1
, t2
;
923 bool Cflag
= false, qflag
= false, vflag
= false;
927 /* Some compilers get confused and warn if this is not initialized. */
934 while ((c
= getopt(argc
, argv
, "CP:qv")) != -1) {
941 pattern
= parse_pattern(optarg
);
953 qemuio_command_usage(&readv_cmd
);
958 if (optind
> argc
- 2) {
959 qemuio_command_usage(&readv_cmd
);
964 offset
= cvtnum(argv
[optind
]);
966 print_cvtnum_err(offset
, argv
[optind
]);
971 nr_iov
= argc
- optind
;
972 buf
= create_iovec(blk
, &qiov
, &argv
[optind
], nr_iov
, 0xab);
977 clock_gettime(CLOCK_MONOTONIC
, &t1
);
978 ret
= do_aio_readv(blk
, &qiov
, offset
, &total
);
979 clock_gettime(CLOCK_MONOTONIC
, &t2
);
982 printf("readv failed: %s\n", strerror(-ret
));
990 void *cmp_buf
= g_malloc(qiov
.size
);
991 memset(cmp_buf
, pattern
, qiov
.size
);
992 if (memcmp(buf
, cmp_buf
, qiov
.size
)) {
993 printf("Pattern verification failed at offset %"
994 PRId64
", %zu bytes\n", offset
, qiov
.size
);
1005 dump_buffer(buf
, offset
, qiov
.size
);
1008 /* Finally, report back -- -C gives a parsable format */
1010 print_report("read", &t2
, offset
, qiov
.size
, total
, cnt
, Cflag
);
1013 qemu_iovec_destroy(&qiov
);
1018 static void write_help(void)
1022 " writes a range of bytes from the given offset\n"
1025 " 'write 512 1k' - writes 1 kilobyte at 512 bytes into the open file\n"
1027 " Writes into a segment of the currently open file, using a buffer\n"
1028 " filled with a set pattern (0xcdcdcdcd).\n"
1029 " -b, -- write to the VM state rather than the virtual disk\n"
1030 " -c, -- write compressed data with blk_write_compressed\n"
1031 " -f, -- use Force Unit Access semantics\n"
1032 " -n, -- with -z, don't allow slow fallback\n"
1033 " -p, -- ignored for backwards compatibility\n"
1034 " -P, -- use different pattern to fill file\n"
1035 " -s, -- use a pattern file to fill the write buffer\n"
1036 " -C, -- report statistics in a machine parsable format\n"
1037 " -q, -- quiet mode, do not show I/O statistics\n"
1038 " -u, -- with -z, allow unmapping\n"
1039 " -z, -- write zeroes using blk_co_pwrite_zeroes\n"
1043 static int write_f(BlockBackend
*blk
, int argc
, char **argv
);
1045 static const cmdinfo_t write_cmd
= {
1049 .perm
= BLK_PERM_WRITE
,
1052 .args
= "[-bcCfnquz] [-P pattern | -s source_file] off len",
1053 .oneline
= "writes a number of bytes at a specified offset",
1057 static int write_f(BlockBackend
*blk
, int argc
, char **argv
)
1059 struct timespec t1
, t2
;
1060 bool Cflag
= false, qflag
= false, bflag
= false;
1061 bool Pflag
= false, zflag
= false, cflag
= false, sflag
= false;
1067 /* Some compilers get confused and warn if this is not initialized. */
1070 const char *file_name
= NULL
;
1072 while ((c
= getopt(argc
, argv
, "bcCfnpP:qs:uz")) != -1) {
1084 flags
|= BDRV_REQ_FUA
;
1087 flags
|= BDRV_REQ_NO_FALLBACK
;
1090 /* Ignored for backwards compatibility */
1094 pattern
= parse_pattern(optarg
);
1107 flags
|= BDRV_REQ_MAY_UNMAP
;
1113 qemuio_command_usage(&write_cmd
);
1118 if (optind
!= argc
- 2) {
1119 qemuio_command_usage(&write_cmd
);
1123 if (bflag
&& zflag
) {
1124 printf("-b and -z cannot be specified at the same time\n");
1128 if ((flags
& BDRV_REQ_FUA
) && (bflag
|| cflag
)) {
1129 printf("-f and -b or -c cannot be specified at the same time\n");
1133 if ((flags
& BDRV_REQ_NO_FALLBACK
) && !zflag
) {
1134 printf("-n requires -z to be specified\n");
1138 if ((flags
& BDRV_REQ_MAY_UNMAP
) && !zflag
) {
1139 printf("-u requires -z to be specified\n");
1143 if (zflag
+ Pflag
+ sflag
> 1) {
1144 printf("Only one of -z, -P, and -s "
1145 "can be specified at the same time\n");
1149 offset
= cvtnum(argv
[optind
]);
1151 print_cvtnum_err(offset
, argv
[optind
]);
1156 count
= cvtnum(argv
[optind
]);
1158 print_cvtnum_err(count
, argv
[optind
]);
1160 } else if (count
> BDRV_REQUEST_MAX_BYTES
&&
1161 !(flags
& BDRV_REQ_NO_FALLBACK
)) {
1162 printf("length cannot exceed %" PRIu64
" without -n, given %s\n",
1163 (uint64_t)BDRV_REQUEST_MAX_BYTES
, argv
[optind
]);
1167 if (bflag
|| cflag
) {
1168 if (!QEMU_IS_ALIGNED(offset
, BDRV_SECTOR_SIZE
)) {
1169 printf("%" PRId64
" is not a sector-aligned value for 'offset'\n",
1174 if (!QEMU_IS_ALIGNED(count
, BDRV_SECTOR_SIZE
)) {
1175 printf("%"PRId64
" is not a sector-aligned value for 'count'\n",
1183 buf
= qemu_io_alloc_from_file(blk
, count
, file_name
);
1188 buf
= qemu_io_alloc(blk
, count
, pattern
);
1192 clock_gettime(CLOCK_MONOTONIC
, &t1
);
1194 ret
= do_save_vmstate(blk
, buf
, offset
, count
, &total
);
1196 ret
= do_co_pwrite_zeroes(blk
, offset
, count
, flags
, &total
);
1198 ret
= do_write_compressed(blk
, buf
, offset
, count
, &total
);
1200 ret
= do_pwrite(blk
, buf
, offset
, count
, flags
, &total
);
1202 clock_gettime(CLOCK_MONOTONIC
, &t2
);
1205 printf("write failed: %s\n", strerror(-ret
));
1216 /* Finally, report back -- -C gives a parsable format */
1218 print_report("wrote", &t2
, offset
, count
, total
, cnt
, Cflag
);
1232 " writes a range of bytes from the given offset source from multiple buffers\n"
1235 " 'writev 512 1k 1k' - writes 2 kilobytes at 512 bytes into the open file\n"
1237 " Writes into a segment of the currently open file, using a buffer\n"
1238 " filled with a set pattern (0xcdcdcdcd).\n"
1239 " -P, -- use different pattern to fill file\n"
1240 " -C, -- report statistics in a machine parsable format\n"
1241 " -f, -- use Force Unit Access semantics\n"
1242 " -q, -- quiet mode, do not show I/O statistics\n"
1246 static int writev_f(BlockBackend
*blk
, int argc
, char **argv
);
1248 static const cmdinfo_t writev_cmd
= {
1251 .perm
= BLK_PERM_WRITE
,
1254 .args
= "[-Cfq] [-P pattern] off len [len..]",
1255 .oneline
= "writes a number of bytes at a specified offset",
1256 .help
= writev_help
,
1259 static int writev_f(BlockBackend
*blk
, int argc
, char **argv
)
1261 struct timespec t1
, t2
;
1262 bool Cflag
= false, qflag
= false;
1267 /* Some compilers get confused and warn if this is not initialized. */
1273 while ((c
= getopt(argc
, argv
, "CfqP:")) != -1) {
1279 flags
|= BDRV_REQ_FUA
;
1285 pattern
= parse_pattern(optarg
);
1291 qemuio_command_usage(&writev_cmd
);
1296 if (optind
> argc
- 2) {
1297 qemuio_command_usage(&writev_cmd
);
1301 offset
= cvtnum(argv
[optind
]);
1303 print_cvtnum_err(offset
, argv
[optind
]);
1308 nr_iov
= argc
- optind
;
1309 buf
= create_iovec(blk
, &qiov
, &argv
[optind
], nr_iov
, pattern
);
1314 clock_gettime(CLOCK_MONOTONIC
, &t1
);
1315 ret
= do_aio_writev(blk
, &qiov
, offset
, flags
, &total
);
1316 clock_gettime(CLOCK_MONOTONIC
, &t2
);
1319 printf("writev failed: %s\n", strerror(-ret
));
1330 /* Finally, report back -- -C gives a parsable format */
1332 print_report("wrote", &t2
, offset
, qiov
.size
, total
, cnt
, Cflag
);
1334 qemu_iovec_destroy(&qiov
);
1349 BlockAcctCookie acct
;
1354 static void aio_write_done(void *opaque
, int ret
)
1356 struct aio_ctx
*ctx
= opaque
;
1359 clock_gettime(CLOCK_MONOTONIC
, &t2
);
1363 printf("aio_write failed: %s\n", strerror(-ret
));
1364 block_acct_failed(blk_get_stats(ctx
->blk
), &ctx
->acct
);
1368 block_acct_done(blk_get_stats(ctx
->blk
), &ctx
->acct
);
1374 /* Finally, report back -- -C gives a parsable format */
1375 t2
= tsub(t2
, ctx
->t1
);
1376 print_report("wrote", &t2
, ctx
->offset
, ctx
->qiov
.size
,
1377 ctx
->qiov
.size
, 1, ctx
->Cflag
);
1380 qemu_io_free(ctx
->buf
);
1381 qemu_iovec_destroy(&ctx
->qiov
);
1386 static void aio_read_done(void *opaque
, int ret
)
1388 struct aio_ctx
*ctx
= opaque
;
1391 clock_gettime(CLOCK_MONOTONIC
, &t2
);
1394 printf("readv failed: %s\n", strerror(-ret
));
1395 block_acct_failed(blk_get_stats(ctx
->blk
), &ctx
->acct
);
1400 void *cmp_buf
= g_malloc(ctx
->qiov
.size
);
1402 memset(cmp_buf
, ctx
->pattern
, ctx
->qiov
.size
);
1403 if (memcmp(ctx
->buf
, cmp_buf
, ctx
->qiov
.size
)) {
1404 printf("Pattern verification failed at offset %"
1405 PRId64
", %zu bytes\n", ctx
->offset
, ctx
->qiov
.size
);
1410 block_acct_done(blk_get_stats(ctx
->blk
), &ctx
->acct
);
1417 dump_buffer(ctx
->buf
, ctx
->offset
, ctx
->qiov
.size
);
1420 /* Finally, report back -- -C gives a parsable format */
1421 t2
= tsub(t2
, ctx
->t1
);
1422 print_report("read", &t2
, ctx
->offset
, ctx
->qiov
.size
,
1423 ctx
->qiov
.size
, 1, ctx
->Cflag
);
1425 qemu_io_free(ctx
->buf
);
1426 qemu_iovec_destroy(&ctx
->qiov
);
1430 static void aio_read_help(void)
1434 " asynchronously reads a range of bytes from the given offset\n"
1437 " 'aio_read -v 512 1k 1k ' - dumps 2 kilobytes read from 512 bytes into the file\n"
1439 " Reads a segment of the currently open file, optionally dumping it to the\n"
1440 " standard output stream (with -v option) for subsequent inspection.\n"
1441 " The read is performed asynchronously and the aio_flush command must be\n"
1442 " used to ensure all outstanding aio requests have been completed.\n"
1443 " Note that due to its asynchronous nature, this command will be\n"
1444 " considered successful once the request is submitted, independently\n"
1445 " of potential I/O errors or pattern mismatches.\n"
1446 " -C, -- report statistics in a machine parsable format\n"
1447 " -P, -- use a pattern to verify read data\n"
1448 " -i, -- treat request as invalid, for exercising stats\n"
1449 " -v, -- dump buffer to standard output\n"
1450 " -q, -- quiet mode, do not show I/O statistics\n"
1454 static int aio_read_f(BlockBackend
*blk
, int argc
, char **argv
);
1456 static const cmdinfo_t aio_read_cmd
= {
1458 .cfunc
= aio_read_f
,
1461 .args
= "[-Ciqv] [-P pattern] off len [len..]",
1462 .oneline
= "asynchronously reads a number of bytes",
1463 .help
= aio_read_help
,
1466 static int aio_read_f(BlockBackend
*blk
, int argc
, char **argv
)
1469 struct aio_ctx
*ctx
= g_new0(struct aio_ctx
, 1);
1472 while ((c
= getopt(argc
, argv
, "CP:iqv")) != -1) {
1479 ctx
->pattern
= parse_pattern(optarg
);
1480 if (ctx
->pattern
< 0) {
1486 printf("injecting invalid read request\n");
1487 block_acct_invalid(blk_get_stats(blk
), BLOCK_ACCT_READ
);
1498 qemuio_command_usage(&aio_read_cmd
);
1503 if (optind
> argc
- 2) {
1505 qemuio_command_usage(&aio_read_cmd
);
1509 ctx
->offset
= cvtnum(argv
[optind
]);
1510 if (ctx
->offset
< 0) {
1511 int ret
= ctx
->offset
;
1512 print_cvtnum_err(ret
, argv
[optind
]);
1518 nr_iov
= argc
- optind
;
1519 ctx
->buf
= create_iovec(blk
, &ctx
->qiov
, &argv
[optind
], nr_iov
, 0xab);
1520 if (ctx
->buf
== NULL
) {
1521 block_acct_invalid(blk_get_stats(blk
), BLOCK_ACCT_READ
);
1526 clock_gettime(CLOCK_MONOTONIC
, &ctx
->t1
);
1527 block_acct_start(blk_get_stats(blk
), &ctx
->acct
, ctx
->qiov
.size
,
1529 blk_aio_preadv(blk
, ctx
->offset
, &ctx
->qiov
, 0, aio_read_done
, ctx
);
1533 static void aio_write_help(void)
1537 " asynchronously writes a range of bytes from the given offset source\n"
1538 " from multiple buffers\n"
1541 " 'aio_write 512 1k 1k' - writes 2 kilobytes at 512 bytes into the open file\n"
1543 " Writes into a segment of the currently open file, using a buffer\n"
1544 " filled with a set pattern (0xcdcdcdcd).\n"
1545 " The write is performed asynchronously and the aio_flush command must be\n"
1546 " used to ensure all outstanding aio requests have been completed.\n"
1547 " Note that due to its asynchronous nature, this command will be\n"
1548 " considered successful once the request is submitted, independently\n"
1549 " of potential I/O errors or pattern mismatches.\n"
1550 " -P, -- use different pattern to fill file\n"
1551 " -C, -- report statistics in a machine parsable format\n"
1552 " -f, -- use Force Unit Access semantics\n"
1553 " -i, -- treat request as invalid, for exercising stats\n"
1554 " -q, -- quiet mode, do not show I/O statistics\n"
1555 " -u, -- with -z, allow unmapping\n"
1556 " -z, -- write zeroes using blk_aio_pwrite_zeroes\n"
1560 static int aio_write_f(BlockBackend
*blk
, int argc
, char **argv
);
1562 static const cmdinfo_t aio_write_cmd
= {
1563 .name
= "aio_write",
1564 .cfunc
= aio_write_f
,
1565 .perm
= BLK_PERM_WRITE
,
1568 .args
= "[-Cfiquz] [-P pattern] off len [len..]",
1569 .oneline
= "asynchronously writes a number of bytes",
1570 .help
= aio_write_help
,
1573 static int aio_write_f(BlockBackend
*blk
, int argc
, char **argv
)
1577 struct aio_ctx
*ctx
= g_new0(struct aio_ctx
, 1);
1581 while ((c
= getopt(argc
, argv
, "CfiqP:uz")) != -1) {
1587 flags
|= BDRV_REQ_FUA
;
1593 flags
|= BDRV_REQ_MAY_UNMAP
;
1596 pattern
= parse_pattern(optarg
);
1603 printf("injecting invalid write request\n");
1604 block_acct_invalid(blk_get_stats(blk
), BLOCK_ACCT_WRITE
);
1612 qemuio_command_usage(&aio_write_cmd
);
1617 if (optind
> argc
- 2) {
1619 qemuio_command_usage(&aio_write_cmd
);
1623 if (ctx
->zflag
&& optind
!= argc
- 2) {
1624 printf("-z supports only a single length parameter\n");
1629 if ((flags
& BDRV_REQ_MAY_UNMAP
) && !ctx
->zflag
) {
1630 printf("-u requires -z to be specified\n");
1635 if (ctx
->zflag
&& ctx
->Pflag
) {
1636 printf("-z and -P cannot be specified at the same time\n");
1641 ctx
->offset
= cvtnum(argv
[optind
]);
1642 if (ctx
->offset
< 0) {
1643 int ret
= ctx
->offset
;
1644 print_cvtnum_err(ret
, argv
[optind
]);
1651 int64_t count
= cvtnum(argv
[optind
]);
1653 print_cvtnum_err(count
, argv
[optind
]);
1658 ctx
->qiov
.size
= count
;
1659 blk_aio_pwrite_zeroes(blk
, ctx
->offset
, count
, flags
, aio_write_done
,
1662 nr_iov
= argc
- optind
;
1663 ctx
->buf
= create_iovec(blk
, &ctx
->qiov
, &argv
[optind
], nr_iov
,
1665 if (ctx
->buf
== NULL
) {
1666 block_acct_invalid(blk_get_stats(blk
), BLOCK_ACCT_WRITE
);
1671 clock_gettime(CLOCK_MONOTONIC
, &ctx
->t1
);
1672 block_acct_start(blk_get_stats(blk
), &ctx
->acct
, ctx
->qiov
.size
,
1675 blk_aio_pwritev(blk
, ctx
->offset
, &ctx
->qiov
, flags
, aio_write_done
,
1682 static int aio_flush_f(BlockBackend
*blk
, int argc
, char **argv
)
1684 BlockAcctCookie cookie
;
1685 block_acct_start(blk_get_stats(blk
), &cookie
, 0, BLOCK_ACCT_FLUSH
);
1687 block_acct_done(blk_get_stats(blk
), &cookie
);
1691 static const cmdinfo_t aio_flush_cmd
= {
1692 .name
= "aio_flush",
1693 .cfunc
= aio_flush_f
,
1694 .oneline
= "completes all outstanding aio requests"
1697 static int flush_f(BlockBackend
*blk
, int argc
, char **argv
)
1699 return blk_flush(blk
);
1702 static const cmdinfo_t flush_cmd
= {
1706 .oneline
= "flush all in-core file state to disk",
1709 static int truncate_f(BlockBackend
*blk
, int argc
, char **argv
);
1710 static const cmdinfo_t truncate_cmd
= {
1713 .cfunc
= truncate_f
,
1714 .perm
= BLK_PERM_WRITE
| BLK_PERM_RESIZE
,
1717 .args
= "[-m prealloc_mode] off",
1718 .oneline
= "truncates the current file at the given offset",
1721 static int truncate_f(BlockBackend
*blk
, int argc
, char **argv
)
1723 Error
*local_err
= NULL
;
1726 PreallocMode prealloc
= PREALLOC_MODE_OFF
;
1728 while ((c
= getopt(argc
, argv
, "m:")) != -1) {
1731 prealloc
= qapi_enum_parse(&PreallocMode_lookup
, optarg
,
1732 PREALLOC_MODE__MAX
, NULL
);
1733 if (prealloc
== PREALLOC_MODE__MAX
) {
1734 error_report("Invalid preallocation mode '%s'", optarg
);
1739 qemuio_command_usage(&truncate_cmd
);
1744 offset
= cvtnum(argv
[optind
]);
1746 print_cvtnum_err(offset
, argv
[1]);
1751 * qemu-io is a debugging tool, so let us be strict here and pass
1752 * exact=true. It is better to err on the "emit more errors" side
1753 * than to be overly permissive.
1755 ret
= blk_truncate(blk
, offset
, false, prealloc
, 0, &local_err
);
1757 error_report_err(local_err
);
1764 static int length_f(BlockBackend
*blk
, int argc
, char **argv
)
1769 size
= blk_getlength(blk
);
1771 printf("getlength: %s\n", strerror(-size
));
1775 cvtstr(size
, s1
, sizeof(s1
));
1781 static const cmdinfo_t length_cmd
= {
1785 .oneline
= "gets the length of the current file",
1789 static int info_f(BlockBackend
*blk
, int argc
, char **argv
)
1791 BlockDriverState
*bs
= blk_bs(blk
);
1792 BlockDriverInfo bdi
;
1793 ImageInfoSpecific
*spec_info
;
1794 Error
*local_err
= NULL
;
1795 char s1
[64], s2
[64];
1798 if (bs
->drv
&& bs
->drv
->format_name
) {
1799 printf("format name: %s\n", bs
->drv
->format_name
);
1801 if (bs
->drv
&& bs
->drv
->protocol_name
) {
1802 printf("format name: %s\n", bs
->drv
->protocol_name
);
1805 ret
= bdrv_get_info(bs
, &bdi
);
1810 cvtstr(bdi
.cluster_size
, s1
, sizeof(s1
));
1811 cvtstr(bdi
.vm_state_offset
, s2
, sizeof(s2
));
1813 printf("cluster size: %s\n", s1
);
1814 printf("vm state offset: %s\n", s2
);
1816 spec_info
= bdrv_get_specific_info(bs
, &local_err
);
1818 error_report_err(local_err
);
1822 printf("Format specific information:\n");
1823 bdrv_image_info_specific_dump(spec_info
);
1824 qapi_free_ImageInfoSpecific(spec_info
);
1832 static const cmdinfo_t info_cmd
= {
1836 .oneline
= "prints information about the current file",
1839 static void discard_help(void)
1843 " discards a range of bytes from the given offset\n"
1846 " 'discard 512 1k' - discards 1 kilobyte from 512 bytes into the file\n"
1848 " Discards a segment of the currently open file.\n"
1849 " -C, -- report statistics in a machine parsable format\n"
1850 " -q, -- quiet mode, do not show I/O statistics\n"
1854 static int discard_f(BlockBackend
*blk
, int argc
, char **argv
);
1856 static const cmdinfo_t discard_cmd
= {
1860 .perm
= BLK_PERM_WRITE
,
1863 .args
= "[-Cq] off len",
1864 .oneline
= "discards a number of bytes at a specified offset",
1865 .help
= discard_help
,
1868 static int discard_f(BlockBackend
*blk
, int argc
, char **argv
)
1870 struct timespec t1
, t2
;
1871 bool Cflag
= false, qflag
= false;
1873 int64_t offset
, bytes
;
1875 while ((c
= getopt(argc
, argv
, "Cq")) != -1) {
1884 qemuio_command_usage(&discard_cmd
);
1889 if (optind
!= argc
- 2) {
1890 qemuio_command_usage(&discard_cmd
);
1894 offset
= cvtnum(argv
[optind
]);
1896 print_cvtnum_err(offset
, argv
[optind
]);
1901 bytes
= cvtnum(argv
[optind
]);
1903 print_cvtnum_err(bytes
, argv
[optind
]);
1905 } else if (bytes
> BDRV_REQUEST_MAX_BYTES
) {
1906 printf("length cannot exceed %"PRIu64
", given %s\n",
1907 (uint64_t)BDRV_REQUEST_MAX_BYTES
, argv
[optind
]);
1911 clock_gettime(CLOCK_MONOTONIC
, &t1
);
1912 ret
= blk_pdiscard(blk
, offset
, bytes
);
1913 clock_gettime(CLOCK_MONOTONIC
, &t2
);
1916 printf("discard failed: %s\n", strerror(-ret
));
1920 /* Finally, report back -- -C gives a parsable format */
1923 print_report("discard", &t2
, offset
, bytes
, bytes
, 1, Cflag
);
1929 static int alloc_f(BlockBackend
*blk
, int argc
, char **argv
)
1931 BlockDriverState
*bs
= blk_bs(blk
);
1932 int64_t offset
, start
, remaining
, count
;
1935 int64_t num
, sum_alloc
;
1937 start
= offset
= cvtnum(argv
[1]);
1939 print_cvtnum_err(offset
, argv
[1]);
1944 count
= cvtnum(argv
[2]);
1946 print_cvtnum_err(count
, argv
[2]);
1950 count
= BDRV_SECTOR_SIZE
;
1956 ret
= bdrv_is_allocated(bs
, offset
, remaining
, &num
);
1958 printf("is_allocated failed: %s\n", strerror(-ret
));
1972 cvtstr(start
, s1
, sizeof(s1
));
1974 printf("%"PRId64
"/%"PRId64
" bytes allocated at offset %s\n",
1975 sum_alloc
, count
, s1
);
1979 static const cmdinfo_t alloc_cmd
= {
1985 .args
= "offset [count]",
1986 .oneline
= "checks if offset is allocated in the file",
1990 static int map_is_allocated(BlockDriverState
*bs
, int64_t offset
,
1991 int64_t bytes
, int64_t *pnum
)
1996 ret
= bdrv_is_allocated(bs
, offset
, bytes
, &num
);
2004 while (bytes
> 0 && ret
== firstret
) {
2008 ret
= bdrv_is_allocated(bs
, offset
, bytes
, &num
);
2009 if (ret
== firstret
&& num
) {
2019 static int map_f(BlockBackend
*blk
, int argc
, char **argv
)
2021 int64_t offset
, bytes
;
2022 char s1
[64], s2
[64];
2028 bytes
= blk_getlength(blk
);
2030 error_report("Failed to query image length: %s", strerror(-bytes
));
2035 ret
= map_is_allocated(blk_bs(blk
), offset
, bytes
, &num
);
2037 error_report("Failed to get allocation status: %s", strerror(-ret
));
2040 error_report("Unexpected end of image");
2044 retstr
= ret
? " allocated" : "not allocated";
2045 cvtstr(num
, s1
, sizeof(s1
));
2046 cvtstr(offset
, s2
, sizeof(s2
));
2047 printf("%s (0x%" PRIx64
") bytes %s at offset %s (0x%" PRIx64
")\n",
2048 s1
, num
, retstr
, s2
, offset
);
2057 static const cmdinfo_t map_cmd
= {
2063 .oneline
= "prints the allocated areas of a file",
2066 static void reopen_help(void)
2070 " Changes the open options of an already opened image\n"
2073 " 'reopen -o lazy-refcounts=on' - activates lazy refcount writeback on a qcow2 image\n"
2075 " -r, -- Reopen the image read-only\n"
2076 " -w, -- Reopen the image read-write\n"
2077 " -c, -- Change the cache mode to the given value\n"
2078 " -o, -- Changes block driver options (cf. 'open' command)\n"
2082 static int reopen_f(BlockBackend
*blk
, int argc
, char **argv
);
2084 static QemuOptsList reopen_opts
= {
2086 .merge_lists
= true,
2087 .head
= QTAILQ_HEAD_INITIALIZER(reopen_opts
.head
),
2089 /* no elements => accept any params */
2090 { /* end of list */ }
2094 static const cmdinfo_t reopen_cmd
= {
2099 .args
= "[(-r|-w)] [-c cache] [-o options]",
2100 .oneline
= "reopens an image with new options",
2101 .help
= reopen_help
,
2104 static int reopen_f(BlockBackend
*blk
, int argc
, char **argv
)
2106 BlockDriverState
*bs
= blk_bs(blk
);
2110 int flags
= bs
->open_flags
;
2111 bool writethrough
= !blk_enable_write_cache(blk
);
2112 bool has_rw_option
= false;
2113 bool has_cache_option
= false;
2114 Error
*local_err
= NULL
;
2116 while ((c
= getopt(argc
, argv
, "c:o:rw")) != -1) {
2119 if (bdrv_parse_cache_mode(optarg
, &flags
, &writethrough
) < 0) {
2120 error_report("Invalid cache option: %s", optarg
);
2123 has_cache_option
= true;
2126 if (!qemu_opts_parse_noisily(&reopen_opts
, optarg
, 0)) {
2127 qemu_opts_reset(&reopen_opts
);
2132 if (has_rw_option
) {
2133 error_report("Only one -r/-w option may be given");
2136 flags
&= ~BDRV_O_RDWR
;
2137 has_rw_option
= true;
2140 if (has_rw_option
) {
2141 error_report("Only one -r/-w option may be given");
2144 flags
|= BDRV_O_RDWR
;
2145 has_rw_option
= true;
2148 qemu_opts_reset(&reopen_opts
);
2149 qemuio_command_usage(&reopen_cmd
);
2154 if (optind
!= argc
) {
2155 qemu_opts_reset(&reopen_opts
);
2156 qemuio_command_usage(&reopen_cmd
);
2160 if (!writethrough
!= blk_enable_write_cache(blk
) &&
2161 blk_get_attached_dev(blk
))
2163 error_report("Cannot change cache.writeback: Device attached");
2164 qemu_opts_reset(&reopen_opts
);
2168 if (!(flags
& BDRV_O_RDWR
)) {
2169 uint64_t orig_perm
, orig_shared_perm
;
2173 blk_get_perm(blk
, &orig_perm
, &orig_shared_perm
);
2175 orig_perm
& ~(BLK_PERM_WRITE
| BLK_PERM_WRITE_UNCHANGED
),
2180 qopts
= qemu_opts_find(&reopen_opts
, NULL
);
2181 opts
= qopts
? qemu_opts_to_qdict(qopts
, NULL
) : qdict_new();
2182 qemu_opts_reset(&reopen_opts
);
2184 if (qdict_haskey(opts
, BDRV_OPT_READ_ONLY
)) {
2185 if (has_rw_option
) {
2186 error_report("Cannot set both -r/-w and '" BDRV_OPT_READ_ONLY
"'");
2187 qobject_unref(opts
);
2191 qdict_put_bool(opts
, BDRV_OPT_READ_ONLY
, !(flags
& BDRV_O_RDWR
));
2194 if (qdict_haskey(opts
, BDRV_OPT_CACHE_DIRECT
) ||
2195 qdict_haskey(opts
, BDRV_OPT_CACHE_NO_FLUSH
)) {
2196 if (has_cache_option
) {
2197 error_report("Cannot set both -c and the cache options");
2198 qobject_unref(opts
);
2202 qdict_put_bool(opts
, BDRV_OPT_CACHE_DIRECT
, flags
& BDRV_O_NOCACHE
);
2203 qdict_put_bool(opts
, BDRV_OPT_CACHE_NO_FLUSH
, flags
& BDRV_O_NO_FLUSH
);
2206 bdrv_reopen(bs
, opts
, true, &local_err
);
2209 error_report_err(local_err
);
2213 blk_set_enable_write_cache(blk
, !writethrough
);
2217 static int break_f(BlockBackend
*blk
, int argc
, char **argv
)
2221 ret
= bdrv_debug_breakpoint(blk_bs(blk
), argv
[1], argv
[2]);
2223 printf("Could not set breakpoint: %s\n", strerror(-ret
));
2230 static int remove_break_f(BlockBackend
*blk
, int argc
, char **argv
)
2234 ret
= bdrv_debug_remove_breakpoint(blk_bs(blk
), argv
[1]);
2236 printf("Could not remove breakpoint %s: %s\n", argv
[1], strerror(-ret
));
2243 static const cmdinfo_t break_cmd
= {
2248 .args
= "event tag",
2249 .oneline
= "sets a breakpoint on event and tags the stopped "
2253 static const cmdinfo_t remove_break_cmd
= {
2254 .name
= "remove_break",
2257 .cfunc
= remove_break_f
,
2259 .oneline
= "remove a breakpoint by tag",
2262 static int resume_f(BlockBackend
*blk
, int argc
, char **argv
)
2266 ret
= bdrv_debug_resume(blk_bs(blk
), argv
[1]);
2268 printf("Could not resume request: %s\n", strerror(-ret
));
2275 static const cmdinfo_t resume_cmd
= {
2281 .oneline
= "resumes the request tagged as tag",
2284 static int wait_break_f(BlockBackend
*blk
, int argc
, char **argv
)
2286 while (!bdrv_debug_is_suspended(blk_bs(blk
), argv
[1])) {
2287 aio_poll(blk_get_aio_context(blk
), true);
2292 static const cmdinfo_t wait_break_cmd
= {
2293 .name
= "wait_break",
2296 .cfunc
= wait_break_f
,
2298 .oneline
= "waits for the suspension of a request",
2301 static int abort_f(BlockBackend
*blk
, int argc
, char **argv
)
2306 static const cmdinfo_t abort_cmd
= {
2309 .flags
= CMD_NOFILE_OK
,
2310 .oneline
= "simulate a program crash using abort(3)",
2313 static void sigraise_help(void)
2317 " raises the given signal\n"
2320 " 'sigraise %i' - raises SIGTERM\n"
2322 " Invokes raise(signal), where \"signal\" is the mandatory integer argument\n"
2323 " given to sigraise.\n"
2327 static int sigraise_f(BlockBackend
*blk
, int argc
, char **argv
);
2329 static const cmdinfo_t sigraise_cmd
= {
2331 .cfunc
= sigraise_f
,
2334 .flags
= CMD_NOFILE_OK
,
2336 .oneline
= "raises a signal",
2337 .help
= sigraise_help
,
2340 static int sigraise_f(BlockBackend
*blk
, int argc
, char **argv
)
2342 int64_t sig
= cvtnum(argv
[1]);
2344 print_cvtnum_err(sig
, argv
[1]);
2346 } else if (sig
> NSIG
) {
2347 printf("signal argument '%s' is too large to be a valid signal\n",
2352 /* Using raise() to kill this process does not necessarily flush all open
2353 * streams. At least stdout and stderr (although the latter should be
2354 * non-buffered anyway) should be flushed, though. */
2363 static void sleep_cb(void *opaque
)
2365 bool *expired
= opaque
;
2369 static int sleep_f(BlockBackend
*blk
, int argc
, char **argv
)
2373 struct QEMUTimer
*timer
;
2374 bool expired
= false;
2376 ms
= strtol(argv
[1], &endptr
, 0);
2377 if (ms
< 0 || *endptr
!= '\0') {
2378 printf("%s is not a valid number\n", argv
[1]);
2382 timer
= timer_new_ns(QEMU_CLOCK_HOST
, sleep_cb
, &expired
);
2383 timer_mod(timer
, qemu_clock_get_ns(QEMU_CLOCK_HOST
) + SCALE_MS
* ms
);
2386 main_loop_wait(false);
2393 static const cmdinfo_t sleep_cmd
= {
2398 .flags
= CMD_NOFILE_OK
,
2399 .oneline
= "waits for the given value in milliseconds",
2402 static void help_oneline(const char *cmd
, const cmdinfo_t
*ct
)
2407 printf("%s ", ct
->args
);
2409 printf("-- %s\n", ct
->oneline
);
2412 static void help_onecmd(const char *cmd
, const cmdinfo_t
*ct
)
2414 help_oneline(cmd
, ct
);
2420 static void help_all(void)
2422 const cmdinfo_t
*ct
;
2424 for (ct
= cmdtab
; ct
< &cmdtab
[ncmds
]; ct
++) {
2425 help_oneline(ct
->name
, ct
);
2427 printf("\nUse 'help commandname' for extended help.\n");
2430 static int help_f(BlockBackend
*blk
, int argc
, char **argv
)
2432 const cmdinfo_t
*ct
;
2439 ct
= find_command(argv
[1]);
2441 printf("command %s not found\n", argv
[1]);
2445 help_onecmd(argv
[1], ct
);
2449 static const cmdinfo_t help_cmd
= {
2455 .flags
= CMD_FLAG_GLOBAL
,
2456 .args
= "[command]",
2457 .oneline
= "help for one or all commands",
2461 * Called with aio context of blk acquired. Or with qemu_get_aio_context()
2462 * context acquired if blk is NULL.
2464 int qemuio_command(BlockBackend
*blk
, const char *cmd
)
2467 const cmdinfo_t
*ct
;
2472 input
= g_strdup(cmd
);
2473 v
= breakline(input
, &c
);
2475 ct
= find_command(v
[0]);
2477 ret
= command(blk
, ct
, c
, v
);
2479 fprintf(stderr
, "command \"%s\" not found\n", v
[0]);
2489 static void __attribute((constructor
)) init_qemuio_commands(void)
2491 /* initialize commands */
2492 qemuio_add_command(&help_cmd
);
2493 qemuio_add_command(&read_cmd
);
2494 qemuio_add_command(&readv_cmd
);
2495 qemuio_add_command(&write_cmd
);
2496 qemuio_add_command(&writev_cmd
);
2497 qemuio_add_command(&aio_read_cmd
);
2498 qemuio_add_command(&aio_write_cmd
);
2499 qemuio_add_command(&aio_flush_cmd
);
2500 qemuio_add_command(&flush_cmd
);
2501 qemuio_add_command(&truncate_cmd
);
2502 qemuio_add_command(&length_cmd
);
2503 qemuio_add_command(&info_cmd
);
2504 qemuio_add_command(&discard_cmd
);
2505 qemuio_add_command(&alloc_cmd
);
2506 qemuio_add_command(&map_cmd
);
2507 qemuio_add_command(&reopen_cmd
);
2508 qemuio_add_command(&break_cmd
);
2509 qemuio_add_command(&remove_break_cmd
);
2510 qemuio_add_command(&resume_cmd
);
2511 qemuio_add_command(&wait_break_cmd
);
2512 qemuio_add_command(&abort_cmd
);
2513 qemuio_add_command(&sleep_cmd
);
2514 qemuio_add_command(&sigraise_cmd
);