root / qemu-io.c @ feature-archipelago
History | View | Annotate | Download (11.6 kB)
1 |
/*
|
---|---|
2 |
* Command line utility to exercise the QEMU I/O path.
|
3 |
*
|
4 |
* Copyright (C) 2009 Red Hat, Inc.
|
5 |
* Copyright (c) 2003-2005 Silicon Graphics, Inc.
|
6 |
*
|
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 |
*/
|
10 |
#include <sys/time.h> |
11 |
#include <sys/types.h> |
12 |
#include <stdarg.h> |
13 |
#include <stdio.h> |
14 |
#include <getopt.h> |
15 |
#include <libgen.h> |
16 |
|
17 |
#include "qemu-io.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 "block/block_int.h" |
23 |
#include "trace/control.h" |
24 |
|
25 |
#define CMD_NOFILE_OK 0x01 |
26 |
|
27 |
char *progname;
|
28 |
|
29 |
BlockDriverState *qemuio_bs; |
30 |
extern int qemuio_misalign; |
31 |
|
32 |
/* qemu-io commands passed using -c */
|
33 |
static int ncmdline; |
34 |
static char **cmdline; |
35 |
|
36 |
static ReadLineState *readline_state;
|
37 |
|
38 |
static int close_f(BlockDriverState *bs, int argc, char **argv) |
39 |
{ |
40 |
bdrv_unref(bs); |
41 |
qemuio_bs = NULL;
|
42 |
return 0; |
43 |
} |
44 |
|
45 |
static const cmdinfo_t close_cmd = { |
46 |
.name = "close",
|
47 |
.altname = "c",
|
48 |
.cfunc = close_f, |
49 |
.oneline = "close the current open file",
|
50 |
}; |
51 |
|
52 |
static int openfile(char *name, int flags, int growable, QDict *opts) |
53 |
{ |
54 |
Error *local_err = NULL;
|
55 |
|
56 |
if (qemuio_bs) {
|
57 |
fprintf(stderr, "file open already, try 'help close'\n");
|
58 |
return 1; |
59 |
} |
60 |
|
61 |
if (growable) {
|
62 |
if (bdrv_open(&qemuio_bs, name, NULL, opts, flags | BDRV_O_PROTOCOL, |
63 |
NULL, &local_err))
|
64 |
{ |
65 |
fprintf(stderr, "%s: can't open device %s: %s\n", progname, name,
|
66 |
error_get_pretty(local_err)); |
67 |
error_free(local_err); |
68 |
return 1; |
69 |
} |
70 |
} else {
|
71 |
qemuio_bs = bdrv_new("hda");
|
72 |
|
73 |
if (bdrv_open(&qemuio_bs, name, NULL, opts, flags, NULL, &local_err) |
74 |
< 0)
|
75 |
{ |
76 |
fprintf(stderr, "%s: can't open device %s: %s\n", progname, name,
|
77 |
error_get_pretty(local_err)); |
78 |
error_free(local_err); |
79 |
bdrv_unref(qemuio_bs); |
80 |
qemuio_bs = NULL;
|
81 |
return 1; |
82 |
} |
83 |
} |
84 |
|
85 |
return 0; |
86 |
} |
87 |
|
88 |
static void open_help(void) |
89 |
{ |
90 |
printf( |
91 |
"\n"
|
92 |
" opens a new file in the requested mode\n"
|
93 |
"\n"
|
94 |
" Example:\n"
|
95 |
" 'open -Cn /tmp/data' - creates/opens data file read-write and uncached\n"
|
96 |
"\n"
|
97 |
" Opens a file for subsequent use by all of the other qemu-io commands.\n"
|
98 |
" -r, -- open file read-only\n"
|
99 |
" -s, -- use snapshot file\n"
|
100 |
" -n, -- disable host cache\n"
|
101 |
" -g, -- allow file to grow (only applies to protocols)\n"
|
102 |
" -o, -- options to be given to the block driver"
|
103 |
"\n");
|
104 |
} |
105 |
|
106 |
static int open_f(BlockDriverState *bs, int argc, char **argv); |
107 |
|
108 |
static const cmdinfo_t open_cmd = { |
109 |
.name = "open",
|
110 |
.altname = "o",
|
111 |
.cfunc = open_f, |
112 |
.argmin = 1,
|
113 |
.argmax = -1,
|
114 |
.flags = CMD_NOFILE_OK, |
115 |
.args = "[-Crsn] [-o options] [path]",
|
116 |
.oneline = "open the file specified by path",
|
117 |
.help = open_help, |
118 |
}; |
119 |
|
120 |
static QemuOptsList empty_opts = {
|
121 |
.name = "drive",
|
122 |
.head = QTAILQ_HEAD_INITIALIZER(empty_opts.head), |
123 |
.desc = { |
124 |
/* no elements => accept any params */
|
125 |
{ /* end of list */ }
|
126 |
}, |
127 |
}; |
128 |
|
129 |
static int open_f(BlockDriverState *bs, int argc, char **argv) |
130 |
{ |
131 |
int flags = 0; |
132 |
int readonly = 0; |
133 |
int growable = 0; |
134 |
int c;
|
135 |
QemuOpts *qopts; |
136 |
QDict *opts = NULL;
|
137 |
|
138 |
while ((c = getopt(argc, argv, "snrgo:")) != EOF) { |
139 |
switch (c) {
|
140 |
case 's': |
141 |
flags |= BDRV_O_SNAPSHOT; |
142 |
break;
|
143 |
case 'n': |
144 |
flags |= BDRV_O_NOCACHE | BDRV_O_CACHE_WB; |
145 |
break;
|
146 |
case 'r': |
147 |
readonly = 1;
|
148 |
break;
|
149 |
case 'g': |
150 |
growable = 1;
|
151 |
break;
|
152 |
case 'o': |
153 |
qopts = qemu_opts_parse(&empty_opts, optarg, 0);
|
154 |
if (qopts == NULL) { |
155 |
printf("could not parse option list -- %s\n", optarg);
|
156 |
return 0; |
157 |
} |
158 |
opts = qemu_opts_to_qdict(qopts, opts); |
159 |
qemu_opts_del(qopts); |
160 |
break;
|
161 |
default:
|
162 |
return qemuio_command_usage(&open_cmd);
|
163 |
} |
164 |
} |
165 |
|
166 |
if (!readonly) {
|
167 |
flags |= BDRV_O_RDWR; |
168 |
} |
169 |
|
170 |
if (optind == argc - 1) { |
171 |
return openfile(argv[optind], flags, growable, opts);
|
172 |
} else if (optind == argc) { |
173 |
return openfile(NULL, flags, growable, opts); |
174 |
} else {
|
175 |
return qemuio_command_usage(&open_cmd);
|
176 |
} |
177 |
} |
178 |
|
179 |
static int quit_f(BlockDriverState *bs, int argc, char **argv) |
180 |
{ |
181 |
return 1; |
182 |
} |
183 |
|
184 |
static const cmdinfo_t quit_cmd = { |
185 |
.name = "quit",
|
186 |
.altname = "q",
|
187 |
.cfunc = quit_f, |
188 |
.argmin = -1,
|
189 |
.argmax = -1,
|
190 |
.flags = CMD_FLAG_GLOBAL, |
191 |
.oneline = "exit the program",
|
192 |
}; |
193 |
|
194 |
static void usage(const char *name) |
195 |
{ |
196 |
printf( |
197 |
"Usage: %s [-h] [-V] [-rsnm] [-c cmd] ... [file]\n"
|
198 |
"QEMU Disk exerciser\n"
|
199 |
"\n"
|
200 |
" -c, --cmd command to execute\n"
|
201 |
" -r, --read-only export read-only\n"
|
202 |
" -s, --snapshot use snapshot file\n"
|
203 |
" -n, --nocache disable host cache\n"
|
204 |
" -g, --growable allow file to grow (only applies to protocols)\n"
|
205 |
" -m, --misalign misalign allocations for O_DIRECT\n"
|
206 |
" -k, --native-aio use kernel AIO implementation (on Linux only)\n"
|
207 |
" -t, --cache=MODE use the given cache mode for the image\n"
|
208 |
" -T, --trace FILE enable trace events listed in the given file\n"
|
209 |
" -h, --help display this help and exit\n"
|
210 |
" -V, --version output version information and exit\n"
|
211 |
"\n",
|
212 |
name); |
213 |
} |
214 |
|
215 |
static char *get_prompt(void) |
216 |
{ |
217 |
static char prompt[FILENAME_MAX + 2 /*"> "*/ + 1 /*"\0"*/ ]; |
218 |
|
219 |
if (!prompt[0]) { |
220 |
snprintf(prompt, sizeof(prompt), "%s> ", progname); |
221 |
} |
222 |
|
223 |
return prompt;
|
224 |
} |
225 |
|
226 |
static void GCC_FMT_ATTR(2, 3) readline_printf_func(void *opaque, |
227 |
const char *fmt, ...) |
228 |
{ |
229 |
va_list ap; |
230 |
va_start(ap, fmt); |
231 |
vprintf(fmt, ap); |
232 |
va_end(ap); |
233 |
} |
234 |
|
235 |
static void readline_flush_func(void *opaque) |
236 |
{ |
237 |
fflush(stdout); |
238 |
} |
239 |
|
240 |
static void readline_func(void *opaque, const char *str, void *readline_opaque) |
241 |
{ |
242 |
char **line = readline_opaque;
|
243 |
*line = g_strdup(str); |
244 |
} |
245 |
|
246 |
static void completion_match(const char *cmd, void *opaque) |
247 |
{ |
248 |
readline_add_completion(readline_state, cmd); |
249 |
} |
250 |
|
251 |
static void readline_completion_func(void *opaque, const char *str) |
252 |
{ |
253 |
readline_set_completion_index(readline_state, strlen(str)); |
254 |
qemuio_complete_command(str, completion_match, NULL);
|
255 |
} |
256 |
|
257 |
static char *fetchline_readline(void) |
258 |
{ |
259 |
char *line = NULL; |
260 |
|
261 |
readline_start(readline_state, get_prompt(), 0, readline_func, &line);
|
262 |
while (!line) {
|
263 |
int ch = getchar();
|
264 |
if (ch == EOF) { |
265 |
break;
|
266 |
} |
267 |
readline_handle_byte(readline_state, ch); |
268 |
} |
269 |
return line;
|
270 |
} |
271 |
|
272 |
#define MAXREADLINESZ 1024 |
273 |
static char *fetchline_fgets(void) |
274 |
{ |
275 |
char *p, *line = g_malloc(MAXREADLINESZ);
|
276 |
|
277 |
if (!fgets(line, MAXREADLINESZ, stdin)) {
|
278 |
g_free(line); |
279 |
return NULL; |
280 |
} |
281 |
|
282 |
p = line + strlen(line); |
283 |
if (p != line && p[-1] == '\n') { |
284 |
p[-1] = '\0'; |
285 |
} |
286 |
|
287 |
return line;
|
288 |
} |
289 |
|
290 |
static char *fetchline(void) |
291 |
{ |
292 |
if (readline_state) {
|
293 |
return fetchline_readline();
|
294 |
} else {
|
295 |
return fetchline_fgets();
|
296 |
} |
297 |
} |
298 |
|
299 |
static void prep_fetchline(void *opaque) |
300 |
{ |
301 |
int *fetchable = opaque;
|
302 |
|
303 |
qemu_set_fd_handler(STDIN_FILENO, NULL, NULL, NULL); |
304 |
*fetchable= 1;
|
305 |
} |
306 |
|
307 |
static void command_loop(void) |
308 |
{ |
309 |
int i, done = 0, fetchable = 0, prompted = 0; |
310 |
char *input;
|
311 |
|
312 |
for (i = 0; !done && i < ncmdline; i++) { |
313 |
done = qemuio_command(qemuio_bs, cmdline[i]); |
314 |
} |
315 |
if (cmdline) {
|
316 |
g_free(cmdline); |
317 |
return;
|
318 |
} |
319 |
|
320 |
while (!done) {
|
321 |
if (!prompted) {
|
322 |
printf("%s", get_prompt());
|
323 |
fflush(stdout); |
324 |
qemu_set_fd_handler(STDIN_FILENO, prep_fetchline, NULL, &fetchable);
|
325 |
prompted = 1;
|
326 |
} |
327 |
|
328 |
main_loop_wait(false);
|
329 |
|
330 |
if (!fetchable) {
|
331 |
continue;
|
332 |
} |
333 |
|
334 |
input = fetchline(); |
335 |
if (input == NULL) { |
336 |
break;
|
337 |
} |
338 |
done = qemuio_command(qemuio_bs, input); |
339 |
g_free(input); |
340 |
|
341 |
prompted = 0;
|
342 |
fetchable = 0;
|
343 |
} |
344 |
qemu_set_fd_handler(STDIN_FILENO, NULL, NULL, NULL); |
345 |
} |
346 |
|
347 |
static void add_user_command(char *optarg) |
348 |
{ |
349 |
cmdline = g_realloc(cmdline, ++ncmdline * sizeof(char *)); |
350 |
cmdline[ncmdline-1] = optarg;
|
351 |
} |
352 |
|
353 |
static void reenable_tty_echo(void) |
354 |
{ |
355 |
qemu_set_tty_echo(STDIN_FILENO, true);
|
356 |
} |
357 |
|
358 |
int main(int argc, char **argv) |
359 |
{ |
360 |
int readonly = 0; |
361 |
int growable = 0; |
362 |
const char *sopt = "hVc:d:rsnmgkt:T:"; |
363 |
const struct option lopt[] = { |
364 |
{ "help", 0, NULL, 'h' }, |
365 |
{ "version", 0, NULL, 'V' }, |
366 |
{ "offset", 1, NULL, 'o' }, |
367 |
{ "cmd", 1, NULL, 'c' }, |
368 |
{ "read-only", 0, NULL, 'r' }, |
369 |
{ "snapshot", 0, NULL, 's' }, |
370 |
{ "nocache", 0, NULL, 'n' }, |
371 |
{ "misalign", 0, NULL, 'm' }, |
372 |
{ "growable", 0, NULL, 'g' }, |
373 |
{ "native-aio", 0, NULL, 'k' }, |
374 |
{ "discard", 1, NULL, 'd' }, |
375 |
{ "cache", 1, NULL, 't' }, |
376 |
{ "trace", 1, NULL, 'T' }, |
377 |
{ NULL, 0, NULL, 0 } |
378 |
}; |
379 |
int c;
|
380 |
int opt_index = 0; |
381 |
int flags = BDRV_O_UNMAP;
|
382 |
|
383 |
#ifdef CONFIG_POSIX
|
384 |
signal(SIGPIPE, SIG_IGN); |
385 |
#endif
|
386 |
|
387 |
progname = basename(argv[0]);
|
388 |
qemu_init_exec_dir(argv[0]);
|
389 |
|
390 |
while ((c = getopt_long(argc, argv, sopt, lopt, &opt_index)) != -1) { |
391 |
switch (c) {
|
392 |
case 's': |
393 |
flags |= BDRV_O_SNAPSHOT; |
394 |
break;
|
395 |
case 'n': |
396 |
flags |= BDRV_O_NOCACHE | BDRV_O_CACHE_WB; |
397 |
break;
|
398 |
case 'd': |
399 |
if (bdrv_parse_discard_flags(optarg, &flags) < 0) { |
400 |
error_report("Invalid discard option: %s", optarg);
|
401 |
exit(1);
|
402 |
} |
403 |
break;
|
404 |
case 'c': |
405 |
add_user_command(optarg); |
406 |
break;
|
407 |
case 'r': |
408 |
readonly = 1;
|
409 |
break;
|
410 |
case 'm': |
411 |
qemuio_misalign = 1;
|
412 |
break;
|
413 |
case 'g': |
414 |
growable = 1;
|
415 |
break;
|
416 |
case 'k': |
417 |
flags |= BDRV_O_NATIVE_AIO; |
418 |
break;
|
419 |
case 't': |
420 |
if (bdrv_parse_cache_flags(optarg, &flags) < 0) { |
421 |
error_report("Invalid cache option: %s", optarg);
|
422 |
exit(1);
|
423 |
} |
424 |
break;
|
425 |
case 'T': |
426 |
if (!trace_backend_init(optarg, NULL)) { |
427 |
exit(1); /* error message will have been printed */ |
428 |
} |
429 |
break;
|
430 |
case 'V': |
431 |
printf("%s version %s\n", progname, QEMU_VERSION);
|
432 |
exit(0);
|
433 |
case 'h': |
434 |
usage(progname); |
435 |
exit(0);
|
436 |
default:
|
437 |
usage(progname); |
438 |
exit(1);
|
439 |
} |
440 |
} |
441 |
|
442 |
if ((argc - optind) > 1) { |
443 |
usage(progname); |
444 |
exit(1);
|
445 |
} |
446 |
|
447 |
qemu_init_main_loop(); |
448 |
bdrv_init(); |
449 |
|
450 |
/* initialize commands */
|
451 |
qemuio_add_command(&quit_cmd); |
452 |
qemuio_add_command(&open_cmd); |
453 |
qemuio_add_command(&close_cmd); |
454 |
|
455 |
if (isatty(STDIN_FILENO)) {
|
456 |
readline_state = readline_init(readline_printf_func, |
457 |
readline_flush_func, |
458 |
NULL,
|
459 |
readline_completion_func); |
460 |
qemu_set_tty_echo(STDIN_FILENO, false);
|
461 |
atexit(reenable_tty_echo); |
462 |
} |
463 |
|
464 |
/* open the device */
|
465 |
if (!readonly) {
|
466 |
flags |= BDRV_O_RDWR; |
467 |
} |
468 |
|
469 |
if ((argc - optind) == 1) { |
470 |
openfile(argv[optind], flags, growable, NULL);
|
471 |
} |
472 |
command_loop(); |
473 |
|
474 |
/*
|
475 |
* Make sure all outstanding requests complete before the program exits.
|
476 |
*/
|
477 |
bdrv_drain_all(); |
478 |
|
479 |
if (qemuio_bs) {
|
480 |
bdrv_unref(qemuio_bs); |
481 |
} |
482 |
g_free(readline_state); |
483 |
return 0; |
484 |
} |