]>
git.proxmox.com Git - mirror_qemu.git/blob - qemu-io.c
2 * Command line utility to exercise the QEMU I/O path.
4 * Copyright (C) 2009 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"
18 #include "qemu/help-texts.h"
19 #include "qemu/cutils.h"
20 #include "qapi/error.h"
22 #include "qemu/error-report.h"
23 #include "qemu/main-loop.h"
24 #include "qemu/module.h"
25 #include "qemu/option.h"
26 #include "qemu/config-file.h"
27 #include "qemu/readline.h"
29 #include "qemu/sockets.h"
30 #include "qapi/qmp/qstring.h"
31 #include "qapi/qmp/qdict.h"
32 #include "qom/object_interfaces.h"
33 #include "sysemu/block-backend.h"
34 #include "block/block_int.h"
35 #include "trace/control.h"
36 #include "crypto/init.h"
37 #include "qemu-version.h"
39 #define CMD_NOFILE_OK 0x01
41 static BlockBackend
*qemuio_blk
;
42 static bool quit_qemu_io
;
44 /* qemu-io commands passed using -c */
46 static char **cmdline
;
47 static bool imageOpts
;
49 static ReadLineState
*readline_state
;
53 static int get_eof_char(void)
56 return 0x4; /* Ctrl-D */
59 if (tcgetattr(STDIN_FILENO
, &tty
) != 0) {
60 if (errno
== ENOTTY
) {
61 return 0x0; /* just expect read() == 0 */
63 return 0x4; /* Ctrl-D */
67 return tty
.c_cc
[VEOF
];
71 static int close_f(BlockBackend
*blk
, int argc
, char **argv
)
73 blk_unref(qemuio_blk
);
78 static const cmdinfo_t close_cmd
= {
82 .oneline
= "close the current open file",
85 static int openfile(char *name
, int flags
, bool writethrough
, bool force_share
,
88 Error
*local_err
= NULL
;
91 error_report("file open already, try 'help close'");
100 if (qdict_haskey(opts
, BDRV_OPT_FORCE_SHARE
)
101 && strcmp(qdict_get_str(opts
, BDRV_OPT_FORCE_SHARE
), "on")) {
102 error_report("-U conflicts with image options");
106 qdict_put_str(opts
, BDRV_OPT_FORCE_SHARE
, "on");
108 qemuio_blk
= blk_new_open(name
, NULL
, opts
, flags
, &local_err
);
110 error_reportf_err(local_err
, "can't open%s%s: ",
111 name
? " device " : "", name
?: "");
115 blk_set_enable_write_cache(qemuio_blk
, !writethrough
);
120 static void open_help(void)
124 " opens a new file in the requested mode\n"
127 " 'open -n -o driver=raw /tmp/data' - opens raw data file read-write, uncached\n"
129 " Opens a file for subsequent use by all of the other qemu-io commands.\n"
130 " -r, -- open file read-only\n"
131 " -s, -- use snapshot file\n"
132 " -C, -- use copy-on-read\n"
133 " -n, -- disable host cache, short for -t none\n"
134 " -U, -- force shared permissions\n"
135 " -k, -- use kernel AIO implementation (Linux only, prefer use of -i)\n"
136 " -i, -- use AIO mode (threads, native or io_uring)\n"
137 " -t, -- use the given cache mode for the image\n"
138 " -d, -- use the given discard mode for the image\n"
139 " -o, -- options to be given to the block driver"
143 static int open_f(BlockBackend
*blk
, int argc
, char **argv
);
145 static const cmdinfo_t open_cmd
= {
151 .flags
= CMD_NOFILE_OK
,
152 .args
= "[-rsCnkU] [-t cache] [-d discard] [-o options] [path]",
153 .oneline
= "open the file specified by path",
157 static QemuOptsList empty_opts
= {
160 .head
= QTAILQ_HEAD_INITIALIZER(empty_opts
.head
),
162 /* no elements => accept any params */
163 { /* end of list */ }
167 static int open_f(BlockBackend
*blk
, int argc
, char **argv
)
169 int flags
= BDRV_O_UNMAP
;
171 bool writethrough
= true;
176 bool force_share
= false;
178 while ((c
= getopt(argc
, argv
, "snCro:ki:t:d:U")) != -1) {
181 flags
|= BDRV_O_SNAPSHOT
;
184 flags
|= BDRV_O_NOCACHE
;
185 writethrough
= false;
188 flags
|= BDRV_O_COPY_ON_READ
;
194 flags
|= BDRV_O_NATIVE_AIO
;
197 if (bdrv_parse_cache_mode(optarg
, &flags
, &writethrough
) < 0) {
198 error_report("Invalid cache option: %s", optarg
);
199 qemu_opts_reset(&empty_opts
);
204 if (bdrv_parse_discard_flags(optarg
, &flags
) < 0) {
205 error_report("Invalid discard option: %s", optarg
);
206 qemu_opts_reset(&empty_opts
);
211 if (bdrv_parse_aio(optarg
, &flags
) < 0) {
212 error_report("Invalid aio option: %s", optarg
);
213 qemu_opts_reset(&empty_opts
);
219 printf("--image-opts and 'open -o' are mutually exclusive\n");
220 qemu_opts_reset(&empty_opts
);
223 if (!qemu_opts_parse_noisily(&empty_opts
, optarg
, false)) {
224 qemu_opts_reset(&empty_opts
);
232 qemu_opts_reset(&empty_opts
);
233 qemuio_command_usage(&open_cmd
);
239 flags
|= BDRV_O_RDWR
;
242 if (imageOpts
&& (optind
== argc
- 1)) {
243 if (!qemu_opts_parse_noisily(&empty_opts
, argv
[optind
], false)) {
244 qemu_opts_reset(&empty_opts
);
250 qopts
= qemu_opts_find(&empty_opts
, NULL
);
251 opts
= qopts
? qemu_opts_to_qdict(qopts
, NULL
) : NULL
;
252 qemu_opts_reset(&empty_opts
);
254 if (optind
== argc
- 1) {
255 ret
= openfile(argv
[optind
], flags
, writethrough
, force_share
, opts
);
256 } else if (optind
== argc
) {
257 ret
= openfile(NULL
, flags
, writethrough
, force_share
, opts
);
260 qemuio_command_usage(&open_cmd
);
271 static int quit_f(BlockBackend
*blk
, int argc
, char **argv
)
277 static const cmdinfo_t quit_cmd
= {
283 .flags
= CMD_FLAG_GLOBAL
,
284 .oneline
= "exit the program",
287 static void usage(const char *name
)
290 "Usage: %s [OPTIONS]... [-c STRING]... [file]\n"
291 "QEMU Disk exerciser\n"
293 " --object OBJECTDEF define an object such as 'secret' for\n"
294 " passwords and/or encryption keys\n"
295 " --image-opts treat file as option string\n"
296 " -c, --cmd STRING execute command with its arguments\n"
297 " from the given string\n"
298 " -f, --format FMT specifies the block driver to use\n"
299 " -r, --read-only export read-only\n"
300 " -s, --snapshot use snapshot file\n"
301 " -n, --nocache disable host cache, short for -t none\n"
302 " -C, --copy-on-read enable copy-on-read\n"
303 " -m, --misalign misalign allocations for O_DIRECT\n"
304 " -k, --native-aio use kernel AIO implementation\n"
305 " (Linux only, prefer use of -i)\n"
306 " -i, --aio=MODE use AIO mode (threads, native or io_uring)\n"
307 " -t, --cache=MODE use the given cache mode for the image\n"
308 " -d, --discard=MODE use the given discard mode for the image\n"
309 " -T, --trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
310 " specify tracing options\n"
311 " see qemu-img(1) man page for full description\n"
312 " -U, --force-share force shared permissions\n"
313 " -h, --help display this help and exit\n"
314 " -V, --version output version information and exit\n"
316 "See '%s -c help' for information on available commands.\n"
318 QEMU_HELP_BOTTOM
"\n",
322 static char *get_prompt(void)
324 static char prompt
[FILENAME_MAX
+ 2 /*"> "*/ + 1 /*"\0"*/ ];
327 snprintf(prompt
, sizeof(prompt
), "%s> ", g_get_prgname());
333 static void G_GNUC_PRINTF(2, 3) readline_printf_func(void *opaque
,
334 const char *fmt
, ...)
342 static void readline_flush_func(void *opaque
)
347 static void readline_func(void *opaque
, const char *str
, void *readline_opaque
)
349 char **line
= readline_opaque
;
350 *line
= g_strdup(str
);
353 static void completion_match(const char *cmd
, void *opaque
)
355 readline_add_completion(readline_state
, cmd
);
358 static void readline_completion_func(void *opaque
, const char *str
)
360 readline_set_completion_index(readline_state
, strlen(str
));
361 qemuio_complete_command(str
, completion_match
, NULL
);
364 static char *fetchline_readline(void)
368 readline_start(readline_state
, get_prompt(), 0, readline_func
, &line
);
371 if (ttyEOF
!= 0x0 && ch
== ttyEOF
) {
375 readline_handle_byte(readline_state
, ch
);
380 #define MAXREADLINESZ 1024
381 static char *fetchline_fgets(void)
383 char *p
, *line
= g_malloc(MAXREADLINESZ
);
385 if (!fgets(line
, MAXREADLINESZ
, stdin
)) {
390 p
= line
+ strlen(line
);
391 if (p
!= line
&& p
[-1] == '\n') {
398 static char *fetchline(void)
400 if (readline_state
) {
401 return fetchline_readline();
403 return fetchline_fgets();
407 static void prep_fetchline(void *opaque
)
409 int *fetchable
= opaque
;
411 qemu_set_fd_handler(STDIN_FILENO
, NULL
, NULL
, NULL
);
415 static int do_qemuio_command(const char *cmd
)
419 qemuio_blk
? blk_get_aio_context(qemuio_blk
) : qemu_get_aio_context();
421 aio_context_acquire(ctx
);
422 ret
= qemuio_command(qemuio_blk
, cmd
);
423 aio_context_release(ctx
);
428 static int command_loop(void)
430 int i
, fetchable
= 0, prompted
= 0;
431 int ret
, last_error
= 0;
434 for (i
= 0; !quit_qemu_io
&& i
< ncmdline
; i
++) {
435 ret
= do_qemuio_command(cmdline
[i
]);
445 while (!quit_qemu_io
) {
447 printf("%s", get_prompt());
449 qemu_set_fd_handler(STDIN_FILENO
, prep_fetchline
, NULL
, &fetchable
);
453 main_loop_wait(false);
463 ret
= do_qemuio_command(input
);
473 qemu_set_fd_handler(STDIN_FILENO
, NULL
, NULL
, NULL
);
478 static void add_user_command(char *user_cmd
)
480 cmdline
= g_renew(char *, cmdline
, ++ncmdline
);
481 cmdline
[ncmdline
- 1] = user_cmd
;
484 static void reenable_tty_echo(void)
486 qemu_set_tty_echo(STDIN_FILENO
, true);
491 OPTION_IMAGE_OPTS
= 257,
494 static QemuOptsList file_opts
= {
496 .implied_opt_name
= "file",
497 .head
= QTAILQ_HEAD_INITIALIZER(file_opts
.head
),
499 /* no elements => accept any params */
500 { /* end of list */ }
504 int main(int argc
, char **argv
)
507 const char *sopt
= "hVc:d:f:rsnCmki:t:T:U";
508 const struct option lopt
[] = {
509 { "help", no_argument
, NULL
, 'h' },
510 { "version", no_argument
, NULL
, 'V' },
511 { "cmd", required_argument
, NULL
, 'c' },
512 { "format", required_argument
, NULL
, 'f' },
513 { "read-only", no_argument
, NULL
, 'r' },
514 { "snapshot", no_argument
, NULL
, 's' },
515 { "nocache", no_argument
, NULL
, 'n' },
516 { "copy-on-read", no_argument
, NULL
, 'C' },
517 { "misalign", no_argument
, NULL
, 'm' },
518 { "native-aio", no_argument
, NULL
, 'k' },
519 { "aio", required_argument
, NULL
, 'i' },
520 { "discard", required_argument
, NULL
, 'd' },
521 { "cache", required_argument
, NULL
, 't' },
522 { "trace", required_argument
, NULL
, 'T' },
523 { "object", required_argument
, NULL
, OPTION_OBJECT
},
524 { "image-opts", no_argument
, NULL
, OPTION_IMAGE_OPTS
},
525 { "force-share", no_argument
, 0, 'U'},
530 int flags
= BDRV_O_UNMAP
;
532 bool writethrough
= true;
534 const char *format
= NULL
;
535 bool force_share
= false;
538 signal(SIGPIPE
, SIG_IGN
);
543 module_call_init(MODULE_INIT_TRACE
);
544 qemu_init_exec_dir(argv
[0]);
546 qcrypto_init(&error_fatal
);
548 module_call_init(MODULE_INIT_QOM
);
549 qemu_add_opts(&qemu_trace_opts
);
552 while ((c
= getopt_long(argc
, argv
, sopt
, lopt
, &opt_index
)) != -1) {
555 flags
|= BDRV_O_SNAPSHOT
;
558 flags
|= BDRV_O_NOCACHE
;
559 writethrough
= false;
562 flags
|= BDRV_O_COPY_ON_READ
;
565 if (bdrv_parse_discard_flags(optarg
, &flags
) < 0) {
566 error_report("Invalid discard option: %s", optarg
);
574 add_user_command(optarg
);
580 qemuio_misalign
= true;
583 flags
|= BDRV_O_NATIVE_AIO
;
586 if (bdrv_parse_aio(optarg
, &flags
) < 0) {
587 error_report("Invalid aio option: %s", optarg
);
592 if (bdrv_parse_cache_mode(optarg
, &flags
, &writethrough
) < 0) {
593 error_report("Invalid cache option: %s", optarg
);
598 trace_opt_parse(optarg
);
601 printf("%s version " QEMU_FULL_VERSION
"\n"
602 QEMU_COPYRIGHT
"\n", g_get_prgname());
605 usage(g_get_prgname());
611 user_creatable_process_cmdline(optarg
);
613 case OPTION_IMAGE_OPTS
:
617 usage(g_get_prgname());
622 if ((argc
- optind
) > 1) {
623 usage(g_get_prgname());
627 if (format
&& imageOpts
) {
628 error_report("--image-opts and -f are mutually exclusive");
632 qemu_init_main_loop(&error_fatal
);
634 if (!trace_init_backends()) {
638 qemu_set_log(LOG_TRACE
, &error_fatal
);
640 /* initialize commands */
641 qemuio_add_command(&quit_cmd
);
642 qemuio_add_command(&open_cmd
);
643 qemuio_add_command(&close_cmd
);
645 if (isatty(STDIN_FILENO
)) {
646 ttyEOF
= get_eof_char();
647 readline_state
= readline_init(readline_printf_func
,
650 readline_completion_func
);
651 qemu_set_tty_echo(STDIN_FILENO
, false);
652 atexit(reenable_tty_echo
);
655 /* open the device */
657 flags
|= BDRV_O_RDWR
;
660 if ((argc
- optind
) == 1) {
662 QemuOpts
*qopts
= NULL
;
663 qopts
= qemu_opts_parse_noisily(&file_opts
, argv
[optind
], false);
667 opts
= qemu_opts_to_qdict(qopts
, NULL
);
668 if (openfile(NULL
, flags
, writethrough
, force_share
, opts
)) {
674 qdict_put_str(opts
, "driver", format
);
676 if (openfile(argv
[optind
], flags
, writethrough
,
677 force_share
, opts
)) {
682 ret
= command_loop();
685 * Make sure all outstanding requests complete before the program exits.
689 blk_unref(qemuio_blk
);
690 g_free(readline_state
);