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