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