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