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 <sys/types.h>
18 #include "qemu/main-loop.h"
19 #include "qemu/option.h"
20 #include "qemu/config-file.h"
21 #include "qemu/readline.h"
22 #include "sysemu/block-backend.h"
23 #include "block/block_int.h"
24 #include "trace/control.h"
26 #define CMD_NOFILE_OK 0x01
28 static char *progname
;
30 static BlockBackend
*qemuio_blk
;
31 static BlockDriverState
*qemuio_bs
;
33 /* qemu-io commands passed using -c */
35 static char **cmdline
;
37 static ReadLineState
*readline_state
;
39 static int close_f(BlockDriverState
*bs
, int argc
, char **argv
)
41 blk_unref(qemuio_blk
);
47 static const cmdinfo_t close_cmd
= {
51 .oneline
= "close the current open file",
54 static int openfile(char *name
, BlockDriver
*drv
, int flags
, int growable
,
57 Error
*local_err
= NULL
;
60 fprintf(stderr
, "file open already, try 'help close'\n");
65 qemuio_blk
= blk_new_with_bs("hda", &error_abort
);
66 qemuio_bs
= blk_bs(qemuio_blk
);
69 flags
|= BDRV_O_PROTOCOL
;
72 if (bdrv_open(&qemuio_bs
, name
, NULL
, opts
, flags
, drv
, &local_err
) < 0) {
73 fprintf(stderr
, "%s: can't open%s%s: %s\n", progname
,
74 name
? " device " : "", name
?: "",
75 error_get_pretty(local_err
));
76 error_free(local_err
);
77 blk_unref(qemuio_blk
);
86 static void open_help(void)
90 " opens a new file in the requested mode\n"
93 " 'open -Cn /tmp/data' - creates/opens data file read-write and uncached\n"
95 " Opens a file for subsequent use by all of the other qemu-io commands.\n"
96 " -r, -- open file read-only\n"
97 " -s, -- use snapshot file\n"
98 " -n, -- disable host cache\n"
99 " -g, -- allow file to grow (only applies to protocols)\n"
100 " -o, -- options to be given to the block driver"
104 static int open_f(BlockDriverState
*bs
, int argc
, char **argv
);
106 static const cmdinfo_t open_cmd
= {
112 .flags
= CMD_NOFILE_OK
,
113 .args
= "[-Crsn] [-o options] [path]",
114 .oneline
= "open the file specified by path",
118 static QemuOptsList empty_opts
= {
121 .head
= QTAILQ_HEAD_INITIALIZER(empty_opts
.head
),
123 /* no elements => accept any params */
124 { /* end of list */ }
128 static int open_f(BlockDriverState
*bs
, int argc
, char **argv
)
137 while ((c
= getopt(argc
, argv
, "snrgo:")) != EOF
) {
140 flags
|= BDRV_O_SNAPSHOT
;
143 flags
|= BDRV_O_NOCACHE
| BDRV_O_CACHE_WB
;
152 if (!qemu_opts_parse(&empty_opts
, optarg
, 0)) {
153 printf("could not parse option list -- %s\n", optarg
);
154 qemu_opts_reset(&empty_opts
);
159 qemu_opts_reset(&empty_opts
);
160 return qemuio_command_usage(&open_cmd
);
165 flags
|= BDRV_O_RDWR
;
168 qopts
= qemu_opts_find(&empty_opts
, NULL
);
169 opts
= qopts
? qemu_opts_to_qdict(qopts
, NULL
) : NULL
;
170 qemu_opts_reset(&empty_opts
);
172 if (optind
== argc
- 1) {
173 return openfile(argv
[optind
], NULL
, flags
, growable
, opts
);
174 } else if (optind
== argc
) {
175 return openfile(NULL
, NULL
, flags
, growable
, opts
);
178 return qemuio_command_usage(&open_cmd
);
182 static int quit_f(BlockDriverState
*bs
, int argc
, char **argv
)
187 static const cmdinfo_t quit_cmd
= {
193 .flags
= CMD_FLAG_GLOBAL
,
194 .oneline
= "exit the program",
197 static void usage(const char *name
)
200 "Usage: %s [-h] [-V] [-rsnm] [-f FMT] [-c STRING] ... [file]\n"
201 "QEMU Disk exerciser\n"
203 " -c, --cmd STRING execute command with its arguments\n"
204 " from the given string\n"
205 " -f, --format FMT specifies the block driver to use\n"
206 " -r, --read-only export read-only\n"
207 " -s, --snapshot use snapshot file\n"
208 " -n, --nocache disable host cache\n"
209 " -g, --growable allow file to grow (only applies to protocols)\n"
210 " -m, --misalign misalign allocations for O_DIRECT\n"
211 " -k, --native-aio use kernel AIO implementation (on Linux only)\n"
212 " -t, --cache=MODE use the given cache mode for the image\n"
213 " -T, --trace FILE enable trace events listed in the given file\n"
214 " -h, --help display this help and exit\n"
215 " -V, --version output version information and exit\n"
217 "See '%s -c help' for information on available commands."
222 static char *get_prompt(void)
224 static char prompt
[FILENAME_MAX
+ 2 /*"> "*/ + 1 /*"\0"*/ ];
227 snprintf(prompt
, sizeof(prompt
), "%s> ", progname
);
233 static void GCC_FMT_ATTR(2, 3) readline_printf_func(void *opaque
,
234 const char *fmt
, ...)
242 static void readline_flush_func(void *opaque
)
247 static void readline_func(void *opaque
, const char *str
, void *readline_opaque
)
249 char **line
= readline_opaque
;
250 *line
= g_strdup(str
);
253 static void completion_match(const char *cmd
, void *opaque
)
255 readline_add_completion(readline_state
, cmd
);
258 static void readline_completion_func(void *opaque
, const char *str
)
260 readline_set_completion_index(readline_state
, strlen(str
));
261 qemuio_complete_command(str
, completion_match
, NULL
);
264 static char *fetchline_readline(void)
268 readline_start(readline_state
, get_prompt(), 0, readline_func
, &line
);
274 readline_handle_byte(readline_state
, ch
);
279 #define MAXREADLINESZ 1024
280 static char *fetchline_fgets(void)
282 char *p
, *line
= g_malloc(MAXREADLINESZ
);
284 if (!fgets(line
, MAXREADLINESZ
, stdin
)) {
289 p
= line
+ strlen(line
);
290 if (p
!= line
&& p
[-1] == '\n') {
297 static char *fetchline(void)
299 if (readline_state
) {
300 return fetchline_readline();
302 return fetchline_fgets();
306 static void prep_fetchline(void *opaque
)
308 int *fetchable
= opaque
;
310 qemu_set_fd_handler(STDIN_FILENO
, NULL
, NULL
, NULL
);
314 static void command_loop(void)
316 int i
, done
= 0, fetchable
= 0, prompted
= 0;
319 for (i
= 0; !done
&& i
< ncmdline
; i
++) {
320 done
= qemuio_command(qemuio_bs
, cmdline
[i
]);
329 printf("%s", get_prompt());
331 qemu_set_fd_handler(STDIN_FILENO
, prep_fetchline
, NULL
, &fetchable
);
335 main_loop_wait(false);
345 done
= qemuio_command(qemuio_bs
, input
);
351 qemu_set_fd_handler(STDIN_FILENO
, NULL
, NULL
, NULL
);
354 static void add_user_command(char *optarg
)
356 cmdline
= g_renew(char *, cmdline
, ++ncmdline
);
357 cmdline
[ncmdline
-1] = optarg
;
360 static void reenable_tty_echo(void)
362 qemu_set_tty_echo(STDIN_FILENO
, true);
365 int main(int argc
, char **argv
)
369 const char *sopt
= "hVc:d:f:rsnmgkt:T:";
370 const struct option lopt
[] = {
371 { "help", 0, NULL
, 'h' },
372 { "version", 0, NULL
, 'V' },
373 { "offset", 1, NULL
, 'o' },
374 { "cmd", 1, NULL
, 'c' },
375 { "format", 1, NULL
, 'f' },
376 { "read-only", 0, NULL
, 'r' },
377 { "snapshot", 0, NULL
, 's' },
378 { "nocache", 0, NULL
, 'n' },
379 { "misalign", 0, NULL
, 'm' },
380 { "growable", 0, NULL
, 'g' },
381 { "native-aio", 0, NULL
, 'k' },
382 { "discard", 1, NULL
, 'd' },
383 { "cache", 1, NULL
, 't' },
384 { "trace", 1, NULL
, 'T' },
389 int flags
= BDRV_O_UNMAP
;
390 BlockDriver
*drv
= NULL
;
391 Error
*local_error
= NULL
;
394 signal(SIGPIPE
, SIG_IGN
);
397 progname
= basename(argv
[0]);
398 qemu_init_exec_dir(argv
[0]);
402 while ((c
= getopt_long(argc
, argv
, sopt
, lopt
, &opt_index
)) != -1) {
405 flags
|= BDRV_O_SNAPSHOT
;
408 flags
|= BDRV_O_NOCACHE
| BDRV_O_CACHE_WB
;
411 if (bdrv_parse_discard_flags(optarg
, &flags
) < 0) {
412 error_report("Invalid discard option: %s", optarg
);
417 drv
= bdrv_find_format(optarg
);
419 error_report("Invalid format '%s'", optarg
);
424 add_user_command(optarg
);
430 qemuio_misalign
= true;
436 flags
|= BDRV_O_NATIVE_AIO
;
439 if (bdrv_parse_cache_flags(optarg
, &flags
) < 0) {
440 error_report("Invalid cache option: %s", optarg
);
445 if (!trace_init_backends(optarg
, NULL
)) {
446 exit(1); /* error message will have been printed */
450 printf("%s version %s\n", progname
, QEMU_VERSION
);
461 if ((argc
- optind
) > 1) {
466 if (qemu_init_main_loop(&local_error
)) {
467 error_report_err(local_error
);
471 /* initialize commands */
472 qemuio_add_command(&quit_cmd
);
473 qemuio_add_command(&open_cmd
);
474 qemuio_add_command(&close_cmd
);
476 if (isatty(STDIN_FILENO
)) {
477 readline_state
= readline_init(readline_printf_func
,
480 readline_completion_func
);
481 qemu_set_tty_echo(STDIN_FILENO
, false);
482 atexit(reenable_tty_echo
);
485 /* open the device */
487 flags
|= BDRV_O_RDWR
;
490 if ((argc
- optind
) == 1) {
491 openfile(argv
[optind
], drv
, flags
, growable
, NULL
);
496 * Make sure all outstanding requests complete before the program exits.
500 blk_unref(qemuio_blk
);
501 g_free(readline_state
);