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