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/error-report.h"
19 #include "qemu/main-loop.h"
20 #include "qemu/option.h"
21 #include "qemu/config-file.h"
22 #include "qemu/readline.h"
23 #include "qapi/qmp/qstring.h"
24 #include "sysemu/block-backend.h"
25 #include "block/block_int.h"
26 #include "trace/control.h"
28 #define CMD_NOFILE_OK 0x01
30 static char *progname
;
32 static BlockBackend
*qemuio_blk
;
34 /* qemu-io commands passed using -c */
36 static char **cmdline
;
38 static ReadLineState
*readline_state
;
40 static int close_f(BlockBackend
*blk
, int argc
, char **argv
)
42 blk_unref(qemuio_blk
);
47 static const cmdinfo_t close_cmd
= {
51 .oneline
= "close the current open file",
54 static int openfile(char *name
, int flags
, QDict
*opts
)
56 Error
*local_err
= NULL
;
60 fprintf(stderr
, "file open already, try 'help close'\n");
65 qemuio_blk
= blk_new_open("hda", name
, NULL
, opts
, flags
, &local_err
);
67 fprintf(stderr
, "%s: can't open%s%s: %s\n", progname
,
68 name
? " device " : "", name
?: "",
69 error_get_pretty(local_err
));
70 error_free(local_err
);
74 bs
= blk_bs(qemuio_blk
);
75 if (bdrv_is_encrypted(bs
)) {
77 printf("Disk image '%s' is encrypted.\n", name
);
78 if (qemu_read_password(password
, sizeof(password
)) < 0) {
79 error_report("No password given");
82 if (bdrv_set_key(bs
, password
) < 0) {
83 error_report("invalid password");
92 blk_unref(qemuio_blk
);
97 static void open_help(void)
101 " opens a new file in the requested mode\n"
104 " 'open -Cn /tmp/data' - creates/opens data file read-write and uncached\n"
106 " Opens a file for subsequent use by all of the other qemu-io commands.\n"
107 " -r, -- open file read-only\n"
108 " -s, -- use snapshot file\n"
109 " -n, -- disable host cache\n"
110 " -o, -- options to be given to the block driver"
114 static int open_f(BlockBackend
*blk
, int argc
, char **argv
);
116 static const cmdinfo_t open_cmd
= {
122 .flags
= CMD_NOFILE_OK
,
123 .args
= "[-Crsn] [-o options] [path]",
124 .oneline
= "open the file specified by path",
128 static QemuOptsList empty_opts
= {
131 .head
= QTAILQ_HEAD_INITIALIZER(empty_opts
.head
),
133 /* no elements => accept any params */
134 { /* end of list */ }
138 static int open_f(BlockBackend
*blk
, int argc
, char **argv
)
146 while ((c
= getopt(argc
, argv
, "snrgo:")) != -1) {
149 flags
|= BDRV_O_SNAPSHOT
;
152 flags
|= BDRV_O_NOCACHE
| BDRV_O_CACHE_WB
;
158 if (!qemu_opts_parse_noisily(&empty_opts
, optarg
, false)) {
159 qemu_opts_reset(&empty_opts
);
164 qemu_opts_reset(&empty_opts
);
165 return qemuio_command_usage(&open_cmd
);
170 flags
|= BDRV_O_RDWR
;
173 qopts
= qemu_opts_find(&empty_opts
, NULL
);
174 opts
= qopts
? qemu_opts_to_qdict(qopts
, NULL
) : NULL
;
175 qemu_opts_reset(&empty_opts
);
177 if (optind
== argc
- 1) {
178 return openfile(argv
[optind
], flags
, opts
);
179 } else if (optind
== argc
) {
180 return openfile(NULL
, flags
, opts
);
183 return qemuio_command_usage(&open_cmd
);
187 static int quit_f(BlockBackend
*blk
, int argc
, char **argv
)
192 static const cmdinfo_t quit_cmd
= {
198 .flags
= CMD_FLAG_GLOBAL
,
199 .oneline
= "exit the program",
202 static void usage(const char *name
)
205 "Usage: %s [-h] [-V] [-rsnm] [-f FMT] [-c STRING] ... [file]\n"
206 "QEMU Disk exerciser\n"
208 " -c, --cmd STRING execute command with its arguments\n"
209 " from the given string\n"
210 " -f, --format FMT specifies the block driver to use\n"
211 " -r, --read-only export read-only\n"
212 " -s, --snapshot use snapshot file\n"
213 " -n, --nocache disable host cache\n"
214 " -m, --misalign misalign allocations for O_DIRECT\n"
215 " -k, --native-aio use kernel AIO implementation (on Linux only)\n"
216 " -t, --cache=MODE use the given cache mode for the image\n"
217 " -T, --trace FILE enable trace events listed in the given file\n"
218 " -h, --help display this help and exit\n"
219 " -V, --version output version information and exit\n"
221 "See '%s -c help' for information on available commands."
226 static char *get_prompt(void)
228 static char prompt
[FILENAME_MAX
+ 2 /*"> "*/ + 1 /*"\0"*/ ];
231 snprintf(prompt
, sizeof(prompt
), "%s> ", progname
);
237 static void GCC_FMT_ATTR(2, 3) readline_printf_func(void *opaque
,
238 const char *fmt
, ...)
246 static void readline_flush_func(void *opaque
)
251 static void readline_func(void *opaque
, const char *str
, void *readline_opaque
)
253 char **line
= readline_opaque
;
254 *line
= g_strdup(str
);
257 static void completion_match(const char *cmd
, void *opaque
)
259 readline_add_completion(readline_state
, cmd
);
262 static void readline_completion_func(void *opaque
, const char *str
)
264 readline_set_completion_index(readline_state
, strlen(str
));
265 qemuio_complete_command(str
, completion_match
, NULL
);
268 static char *fetchline_readline(void)
272 readline_start(readline_state
, get_prompt(), 0, readline_func
, &line
);
278 readline_handle_byte(readline_state
, ch
);
283 #define MAXREADLINESZ 1024
284 static char *fetchline_fgets(void)
286 char *p
, *line
= g_malloc(MAXREADLINESZ
);
288 if (!fgets(line
, MAXREADLINESZ
, stdin
)) {
293 p
= line
+ strlen(line
);
294 if (p
!= line
&& p
[-1] == '\n') {
301 static char *fetchline(void)
303 if (readline_state
) {
304 return fetchline_readline();
306 return fetchline_fgets();
310 static void prep_fetchline(void *opaque
)
312 int *fetchable
= opaque
;
314 qemu_set_fd_handler(STDIN_FILENO
, NULL
, NULL
, NULL
);
318 static void command_loop(void)
320 int i
, done
= 0, fetchable
= 0, prompted
= 0;
323 for (i
= 0; !done
&& i
< ncmdline
; i
++) {
324 done
= qemuio_command(qemuio_blk
, cmdline
[i
]);
333 printf("%s", get_prompt());
335 qemu_set_fd_handler(STDIN_FILENO
, prep_fetchline
, NULL
, &fetchable
);
339 main_loop_wait(false);
349 done
= qemuio_command(qemuio_blk
, input
);
355 qemu_set_fd_handler(STDIN_FILENO
, NULL
, NULL
, NULL
);
358 static void add_user_command(char *optarg
)
360 cmdline
= g_renew(char *, cmdline
, ++ncmdline
);
361 cmdline
[ncmdline
-1] = optarg
;
364 static void reenable_tty_echo(void)
366 qemu_set_tty_echo(STDIN_FILENO
, true);
369 int main(int argc
, char **argv
)
372 const char *sopt
= "hVc:d:f:rsnmgkt:T:";
373 const struct option lopt
[] = {
374 { "help", 0, NULL
, 'h' },
375 { "version", 0, NULL
, 'V' },
376 { "offset", 1, NULL
, 'o' },
377 { "cmd", 1, NULL
, 'c' },
378 { "format", 1, NULL
, 'f' },
379 { "read-only", 0, NULL
, 'r' },
380 { "snapshot", 0, NULL
, 's' },
381 { "nocache", 0, NULL
, 'n' },
382 { "misalign", 0, NULL
, 'm' },
383 { "native-aio", 0, NULL
, 'k' },
384 { "discard", 1, NULL
, 'd' },
385 { "cache", 1, NULL
, 't' },
386 { "trace", 1, NULL
, 'T' },
391 int flags
= BDRV_O_UNMAP
;
392 Error
*local_error
= NULL
;
396 signal(SIGPIPE
, SIG_IGN
);
399 progname
= basename(argv
[0]);
400 qemu_init_exec_dir(argv
[0]);
404 while ((c
= getopt_long(argc
, argv
, sopt
, lopt
, &opt_index
)) != -1) {
407 flags
|= BDRV_O_SNAPSHOT
;
410 flags
|= BDRV_O_NOCACHE
| BDRV_O_CACHE_WB
;
413 if (bdrv_parse_discard_flags(optarg
, &flags
) < 0) {
414 error_report("Invalid discard option: %s", optarg
);
422 qdict_put(opts
, "driver", qstring_from_str(optarg
));
425 add_user_command(optarg
);
431 qemuio_misalign
= true;
434 flags
|= BDRV_O_NATIVE_AIO
;
437 if (bdrv_parse_cache_flags(optarg
, &flags
) < 0) {
438 error_report("Invalid cache option: %s", optarg
);
443 if (!trace_init_backends(optarg
, NULL
)) {
444 exit(1); /* error message will have been printed */
448 printf("%s version %s\n", progname
, QEMU_VERSION
);
459 if ((argc
- optind
) > 1) {
464 if (qemu_init_main_loop(&local_error
)) {
465 error_report_err(local_error
);
469 /* initialize commands */
470 qemuio_add_command(&quit_cmd
);
471 qemuio_add_command(&open_cmd
);
472 qemuio_add_command(&close_cmd
);
474 if (isatty(STDIN_FILENO
)) {
475 readline_state
= readline_init(readline_printf_func
,
478 readline_completion_func
);
479 qemu_set_tty_echo(STDIN_FILENO
, false);
480 atexit(reenable_tty_echo
);
483 /* open the device */
485 flags
|= BDRV_O_RDWR
;
488 if ((argc
- optind
) == 1) {
489 openfile(argv
[optind
], flags
, opts
);
494 * Make sure all outstanding requests complete before the program exits.
498 blk_unref(qemuio_blk
);
499 g_free(readline_state
);