linux-user: Use safe_syscall for open and openat system calls
[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 "qemu/osdep.h"
11 #include <getopt.h>
12 #include <libgen.h>
13
14 #include "qapi/error.h"
15 #include "qemu-io.h"
16 #include "qemu/error-report.h"
17 #include "qemu/main-loop.h"
18 #include "qemu/option.h"
19 #include "qemu/config-file.h"
20 #include "qemu/readline.h"
21 #include "qapi/qmp/qstring.h"
22 #include "qom/object_interfaces.h"
23 #include "sysemu/block-backend.h"
24 #include "block/block_int.h"
25 #include "trace/control.h"
26 #include "crypto/init.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 static bool imageOpts;
38
39 static ReadLineState *readline_state;
40
41 static int close_f(BlockBackend *blk, int argc, char **argv)
42 {
43 blk_unref(qemuio_blk);
44 qemuio_blk = NULL;
45 return 0;
46 }
47
48 static const cmdinfo_t close_cmd = {
49 .name = "close",
50 .altname = "c",
51 .cfunc = close_f,
52 .oneline = "close the current open file",
53 };
54
55 static int openfile(char *name, int flags, bool writethrough, QDict *opts)
56 {
57 Error *local_err = NULL;
58 BlockDriverState *bs;
59
60 if (qemuio_blk) {
61 error_report("file open already, try 'help close'");
62 QDECREF(opts);
63 return 1;
64 }
65
66 qemuio_blk = blk_new_open(name, NULL, opts, flags, &local_err);
67 if (!qemuio_blk) {
68 error_reportf_err(local_err, "can't open%s%s: ",
69 name ? " device " : "", name ?: "");
70 return 1;
71 }
72
73 bs = blk_bs(qemuio_blk);
74 if (bdrv_is_encrypted(bs) && bdrv_key_required(bs)) {
75 char password[256];
76 printf("Disk image '%s' is encrypted.\n", name);
77 if (qemu_read_password(password, sizeof(password)) < 0) {
78 error_report("No password given");
79 goto error;
80 }
81 if (bdrv_set_key(bs, password) < 0) {
82 error_report("invalid password");
83 goto error;
84 }
85 }
86
87 blk_set_enable_write_cache(qemuio_blk, !writethrough);
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 -n -o driver=raw /tmp/data' - opens raw data file read-write, 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, short for -t none\n"
110 " -k, -- use kernel AIO implementation (on Linux only)\n"
111 " -t, -- use the given cache mode for the image\n"
112 " -d, -- use the given discard mode for the image\n"
113 " -o, -- options to be given to the block driver"
114 "\n");
115 }
116
117 static int open_f(BlockBackend *blk, int argc, char **argv);
118
119 static const cmdinfo_t open_cmd = {
120 .name = "open",
121 .altname = "o",
122 .cfunc = open_f,
123 .argmin = 1,
124 .argmax = -1,
125 .flags = CMD_NOFILE_OK,
126 .args = "[-rsnk] [-t cache] [-d discard] [-o options] [path]",
127 .oneline = "open the file specified by path",
128 .help = open_help,
129 };
130
131 static QemuOptsList empty_opts = {
132 .name = "drive",
133 .merge_lists = true,
134 .head = QTAILQ_HEAD_INITIALIZER(empty_opts.head),
135 .desc = {
136 /* no elements => accept any params */
137 { /* end of list */ }
138 },
139 };
140
141 static int open_f(BlockBackend *blk, int argc, char **argv)
142 {
143 int flags = BDRV_O_UNMAP;
144 int readonly = 0;
145 bool writethrough = true;
146 int c;
147 QemuOpts *qopts;
148 QDict *opts;
149
150 while ((c = getopt(argc, argv, "snro:kt:d:")) != -1) {
151 switch (c) {
152 case 's':
153 flags |= BDRV_O_SNAPSHOT;
154 break;
155 case 'n':
156 flags |= BDRV_O_NOCACHE;
157 writethrough = false;
158 break;
159 case 'r':
160 readonly = 1;
161 break;
162 case 'k':
163 flags |= BDRV_O_NATIVE_AIO;
164 break;
165 case 't':
166 if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) < 0) {
167 error_report("Invalid cache option: %s", optarg);
168 qemu_opts_reset(&empty_opts);
169 return 0;
170 }
171 break;
172 case 'd':
173 if (bdrv_parse_discard_flags(optarg, &flags) < 0) {
174 error_report("Invalid discard option: %s", optarg);
175 qemu_opts_reset(&empty_opts);
176 return 0;
177 }
178 break;
179 case 'o':
180 if (imageOpts) {
181 printf("--image-opts and 'open -o' are mutually exclusive\n");
182 qemu_opts_reset(&empty_opts);
183 return 0;
184 }
185 if (!qemu_opts_parse_noisily(&empty_opts, optarg, false)) {
186 qemu_opts_reset(&empty_opts);
187 return 0;
188 }
189 break;
190 default:
191 qemu_opts_reset(&empty_opts);
192 return qemuio_command_usage(&open_cmd);
193 }
194 }
195
196 if (!readonly) {
197 flags |= BDRV_O_RDWR;
198 }
199
200 if (imageOpts && (optind == argc - 1)) {
201 if (!qemu_opts_parse_noisily(&empty_opts, argv[optind], false)) {
202 qemu_opts_reset(&empty_opts);
203 return 0;
204 }
205 optind++;
206 }
207
208 qopts = qemu_opts_find(&empty_opts, NULL);
209 opts = qopts ? qemu_opts_to_qdict(qopts, NULL) : NULL;
210 qemu_opts_reset(&empty_opts);
211
212 if (optind == argc - 1) {
213 return openfile(argv[optind], flags, writethrough, opts);
214 } else if (optind == argc) {
215 return openfile(NULL, flags, writethrough, opts);
216 } else {
217 QDECREF(opts);
218 return qemuio_command_usage(&open_cmd);
219 }
220 }
221
222 static int quit_f(BlockBackend *blk, int argc, char **argv)
223 {
224 return 1;
225 }
226
227 static const cmdinfo_t quit_cmd = {
228 .name = "quit",
229 .altname = "q",
230 .cfunc = quit_f,
231 .argmin = -1,
232 .argmax = -1,
233 .flags = CMD_FLAG_GLOBAL,
234 .oneline = "exit the program",
235 };
236
237 static void usage(const char *name)
238 {
239 printf(
240 "Usage: %s [OPTIONS]... [-c STRING]... [file]\n"
241 "QEMU Disk exerciser\n"
242 "\n"
243 " --object OBJECTDEF define an object such as 'secret' for\n"
244 " passwords and/or encryption keys\n"
245 " --image-opts treat file as option string\n"
246 " -c, --cmd STRING execute command with its arguments\n"
247 " from the given string\n"
248 " -f, --format FMT specifies the block driver to use\n"
249 " -r, --read-only export read-only\n"
250 " -s, --snapshot use snapshot file\n"
251 " -n, --nocache disable host cache, short for -t none\n"
252 " -m, --misalign misalign allocations for O_DIRECT\n"
253 " -k, --native-aio use kernel AIO implementation (on Linux only)\n"
254 " -t, --cache=MODE use the given cache mode for the image\n"
255 " -d, --discard=MODE use the given discard mode for the image\n"
256 " -T, --trace FILE enable trace events listed in the given file\n"
257 " -h, --help display this help and exit\n"
258 " -V, --version output version information and exit\n"
259 "\n"
260 "See '%s -c help' for information on available commands."
261 "\n",
262 name, name);
263 }
264
265 static char *get_prompt(void)
266 {
267 static char prompt[FILENAME_MAX + 2 /*"> "*/ + 1 /*"\0"*/ ];
268
269 if (!prompt[0]) {
270 snprintf(prompt, sizeof(prompt), "%s> ", progname);
271 }
272
273 return prompt;
274 }
275
276 static void GCC_FMT_ATTR(2, 3) readline_printf_func(void *opaque,
277 const char *fmt, ...)
278 {
279 va_list ap;
280 va_start(ap, fmt);
281 vprintf(fmt, ap);
282 va_end(ap);
283 }
284
285 static void readline_flush_func(void *opaque)
286 {
287 fflush(stdout);
288 }
289
290 static void readline_func(void *opaque, const char *str, void *readline_opaque)
291 {
292 char **line = readline_opaque;
293 *line = g_strdup(str);
294 }
295
296 static void completion_match(const char *cmd, void *opaque)
297 {
298 readline_add_completion(readline_state, cmd);
299 }
300
301 static void readline_completion_func(void *opaque, const char *str)
302 {
303 readline_set_completion_index(readline_state, strlen(str));
304 qemuio_complete_command(str, completion_match, NULL);
305 }
306
307 static char *fetchline_readline(void)
308 {
309 char *line = NULL;
310
311 readline_start(readline_state, get_prompt(), 0, readline_func, &line);
312 while (!line) {
313 int ch = getchar();
314 if (ch == EOF) {
315 break;
316 }
317 readline_handle_byte(readline_state, ch);
318 }
319 return line;
320 }
321
322 #define MAXREADLINESZ 1024
323 static char *fetchline_fgets(void)
324 {
325 char *p, *line = g_malloc(MAXREADLINESZ);
326
327 if (!fgets(line, MAXREADLINESZ, stdin)) {
328 g_free(line);
329 return NULL;
330 }
331
332 p = line + strlen(line);
333 if (p != line && p[-1] == '\n') {
334 p[-1] = '\0';
335 }
336
337 return line;
338 }
339
340 static char *fetchline(void)
341 {
342 if (readline_state) {
343 return fetchline_readline();
344 } else {
345 return fetchline_fgets();
346 }
347 }
348
349 static void prep_fetchline(void *opaque)
350 {
351 int *fetchable = opaque;
352
353 qemu_set_fd_handler(STDIN_FILENO, NULL, NULL, NULL);
354 *fetchable= 1;
355 }
356
357 static void command_loop(void)
358 {
359 int i, done = 0, fetchable = 0, prompted = 0;
360 char *input;
361
362 for (i = 0; !done && i < ncmdline; i++) {
363 done = qemuio_command(qemuio_blk, cmdline[i]);
364 }
365 if (cmdline) {
366 g_free(cmdline);
367 return;
368 }
369
370 while (!done) {
371 if (!prompted) {
372 printf("%s", get_prompt());
373 fflush(stdout);
374 qemu_set_fd_handler(STDIN_FILENO, prep_fetchline, NULL, &fetchable);
375 prompted = 1;
376 }
377
378 main_loop_wait(false);
379
380 if (!fetchable) {
381 continue;
382 }
383
384 input = fetchline();
385 if (input == NULL) {
386 break;
387 }
388 done = qemuio_command(qemuio_blk, input);
389 g_free(input);
390
391 prompted = 0;
392 fetchable = 0;
393 }
394 qemu_set_fd_handler(STDIN_FILENO, NULL, NULL, NULL);
395 }
396
397 static void add_user_command(char *optarg)
398 {
399 cmdline = g_renew(char *, cmdline, ++ncmdline);
400 cmdline[ncmdline-1] = optarg;
401 }
402
403 static void reenable_tty_echo(void)
404 {
405 qemu_set_tty_echo(STDIN_FILENO, true);
406 }
407
408 enum {
409 OPTION_OBJECT = 256,
410 OPTION_IMAGE_OPTS = 257,
411 };
412
413 static QemuOptsList qemu_object_opts = {
414 .name = "object",
415 .implied_opt_name = "qom-type",
416 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
417 .desc = {
418 { }
419 },
420 };
421
422
423 static QemuOptsList file_opts = {
424 .name = "file",
425 .implied_opt_name = "file",
426 .head = QTAILQ_HEAD_INITIALIZER(file_opts.head),
427 .desc = {
428 /* no elements => accept any params */
429 { /* end of list */ }
430 },
431 };
432
433 int main(int argc, char **argv)
434 {
435 int readonly = 0;
436 const char *sopt = "hVc:d:f:rsnmkt:T:";
437 const struct option lopt[] = {
438 { "help", no_argument, NULL, 'h' },
439 { "version", no_argument, NULL, 'V' },
440 { "cmd", required_argument, NULL, 'c' },
441 { "format", required_argument, NULL, 'f' },
442 { "read-only", no_argument, NULL, 'r' },
443 { "snapshot", no_argument, NULL, 's' },
444 { "nocache", no_argument, NULL, 'n' },
445 { "misalign", no_argument, NULL, 'm' },
446 { "native-aio", no_argument, NULL, 'k' },
447 { "discard", required_argument, NULL, 'd' },
448 { "cache", required_argument, NULL, 't' },
449 { "trace", required_argument, NULL, 'T' },
450 { "object", required_argument, NULL, OPTION_OBJECT },
451 { "image-opts", no_argument, NULL, OPTION_IMAGE_OPTS },
452 { NULL, 0, NULL, 0 }
453 };
454 int c;
455 int opt_index = 0;
456 int flags = BDRV_O_UNMAP;
457 bool writethrough = true;
458 Error *local_error = NULL;
459 QDict *opts = NULL;
460 const char *format = NULL;
461
462 #ifdef CONFIG_POSIX
463 signal(SIGPIPE, SIG_IGN);
464 #endif
465
466 progname = basename(argv[0]);
467 qemu_init_exec_dir(argv[0]);
468
469 qcrypto_init(&error_fatal);
470
471 module_call_init(MODULE_INIT_QOM);
472 qemu_add_opts(&qemu_object_opts);
473 bdrv_init();
474
475 while ((c = getopt_long(argc, argv, sopt, lopt, &opt_index)) != -1) {
476 switch (c) {
477 case 's':
478 flags |= BDRV_O_SNAPSHOT;
479 break;
480 case 'n':
481 flags |= BDRV_O_NOCACHE;
482 writethrough = false;
483 break;
484 case 'd':
485 if (bdrv_parse_discard_flags(optarg, &flags) < 0) {
486 error_report("Invalid discard option: %s", optarg);
487 exit(1);
488 }
489 break;
490 case 'f':
491 format = optarg;
492 break;
493 case 'c':
494 add_user_command(optarg);
495 break;
496 case 'r':
497 readonly = 1;
498 break;
499 case 'm':
500 qemuio_misalign = true;
501 break;
502 case 'k':
503 flags |= BDRV_O_NATIVE_AIO;
504 break;
505 case 't':
506 if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) < 0) {
507 error_report("Invalid cache option: %s", optarg);
508 exit(1);
509 }
510 break;
511 case 'T':
512 if (!trace_init_backends()) {
513 exit(1); /* error message will have been printed */
514 }
515 break;
516 case 'V':
517 printf("%s version %s\n", progname, QEMU_VERSION);
518 exit(0);
519 case 'h':
520 usage(progname);
521 exit(0);
522 case OPTION_OBJECT: {
523 QemuOpts *qopts;
524 qopts = qemu_opts_parse_noisily(&qemu_object_opts,
525 optarg, true);
526 if (!qopts) {
527 exit(1);
528 }
529 } break;
530 case OPTION_IMAGE_OPTS:
531 imageOpts = true;
532 break;
533 default:
534 usage(progname);
535 exit(1);
536 }
537 }
538
539 if ((argc - optind) > 1) {
540 usage(progname);
541 exit(1);
542 }
543
544 if (format && imageOpts) {
545 error_report("--image-opts and -f are mutually exclusive");
546 exit(1);
547 }
548
549 if (qemu_init_main_loop(&local_error)) {
550 error_report_err(local_error);
551 exit(1);
552 }
553
554 if (qemu_opts_foreach(&qemu_object_opts,
555 user_creatable_add_opts_foreach,
556 NULL, NULL)) {
557 exit(1);
558 }
559
560 /* initialize commands */
561 qemuio_add_command(&quit_cmd);
562 qemuio_add_command(&open_cmd);
563 qemuio_add_command(&close_cmd);
564
565 if (isatty(STDIN_FILENO)) {
566 readline_state = readline_init(readline_printf_func,
567 readline_flush_func,
568 NULL,
569 readline_completion_func);
570 qemu_set_tty_echo(STDIN_FILENO, false);
571 atexit(reenable_tty_echo);
572 }
573
574 /* open the device */
575 if (!readonly) {
576 flags |= BDRV_O_RDWR;
577 }
578
579 if ((argc - optind) == 1) {
580 if (imageOpts) {
581 QemuOpts *qopts = NULL;
582 qopts = qemu_opts_parse_noisily(&file_opts, argv[optind], false);
583 if (!qopts) {
584 exit(1);
585 }
586 opts = qemu_opts_to_qdict(qopts, NULL);
587 openfile(NULL, flags, writethrough, opts);
588 } else {
589 if (format) {
590 opts = qdict_new();
591 qdict_put(opts, "driver", qstring_from_str(format));
592 }
593 openfile(argv[optind], flags, writethrough, opts);
594 }
595 }
596 command_loop();
597
598 /*
599 * Make sure all outstanding requests complete before the program exits.
600 */
601 bdrv_drain_all();
602
603 blk_unref(qemuio_blk);
604 g_free(readline_state);
605 return 0;
606 }