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