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