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