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