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 #include "qemu/osdep.h"
  11 #include <getopt.h>
  12 #include <libgen.h>
  13
  14 #include "qemu-io.h"
  15 #include "qemu/error-report.h"
  16 #include "qemu/main-loop.h"
  17 #include "qemu/option.h"
  18 #include "qemu/config-file.h"
  19 #include "qemu/readline.h"
  20 #include "qapi/qmp/qstring.h"
  21 #include "sysemu/block-backend.h"
  22 #include "block/block_int.h"
  23 #include "trace/control.h"
  24
  25 #define CMD_NOFILE_OK   0x01
  26
  27 static char *progname;
  28
  29 static BlockBackend *qemuio_blk;
  30
  31 /* qemu-io commands passed using -c */
  32 static int ncmdline;
  33 static char **cmdline;
  34
  35 static ReadLineState *readline_state;
  36
  37 static int close_f(BlockBackend *blk, int argc, char **argv)
  38 {
  39     blk_unref(qemuio_blk);
  40     qemuio_blk = NULL;
  41     return 0;
  42 }
  43
  44 static const cmdinfo_t close_cmd = {
  45     .name       = "close",
  46     .altname    = "c",
  47     .cfunc      = close_f,
  48     .oneline    = "close the current open file",
  49 };
  50
  51 static int openfile(char *name, int flags, QDict *opts)
  52 {
  53     Error *local_err = NULL;
  54     BlockDriverState *bs;
  55
  56     if (qemuio_blk) {
  57         error_report("file open already, try 'help close'");
  58         QDECREF(opts);
  59         return 1;
  60     }
  61
  62     qemuio_blk = blk_new_open("hda", name, NULL, opts, flags, &local_err);
  63     if (!qemuio_blk) {
  64         error_reportf_err(local_err, "can't open%s%s: ",
  65                           name ? " device " : "", name ?: "");
  66         return 1;
  67     }
  68
  69     bs = blk_bs(qemuio_blk);
  70     if (bdrv_is_encrypted(bs)) {
  71         char password[256];
  72         printf("Disk image '%s' is encrypted.\n", name);
  73         if (qemu_read_password(password, sizeof(password)) < 0) {
  74             error_report("No password given");
  75             goto error;
  76         }
  77         if (bdrv_set_key(bs, password) < 0) {
  78             error_report("invalid password");
  79             goto error;
  80         }
  81     }
  82
  83
  84     return 0;
  85
  86  error:
  87     blk_unref(qemuio_blk);
  88     qemuio_blk = NULL;
  89     return 1;
  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 -Cn /tmp/data' - creates/opens data file read-write and 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\n"
 105 " -o, -- options to be given to the block driver"
 106 "\n");
 107 }
 108
 109 static int open_f(BlockBackend *blk, int argc, char **argv);
 110
 111 static const cmdinfo_t open_cmd = {
 112     .name       = "open",
 113     .altname    = "o",
 114     .cfunc      = open_f,
 115     .argmin     = 1,
 116     .argmax     = -1,
 117     .flags      = CMD_NOFILE_OK,
 118     .args       = "[-Crsn] [-o options] [path]",
 119     .oneline    = "open the file specified by path",
 120     .help       = open_help,
 121 };
 122
 123 static QemuOptsList empty_opts = {
 124     .name = "drive",
 125     .merge_lists = true,
 126     .head = QTAILQ_HEAD_INITIALIZER(empty_opts.head),
 127     .desc = {
 128         /* no elements => accept any params */
 129         { /* end of list */ }
 130     },
 131 };
 132
 133 static int open_f(BlockBackend *blk, int argc, char **argv)
 134 {
 135     int flags = 0;
 136     int readonly = 0;
 137     int c;
 138     QemuOpts *qopts;
 139     QDict *opts;
 140
 141     while ((c = getopt(argc, argv, "snrgo:")) != -1) {
 142         switch (c) {
 143         case 's':
 144             flags |= BDRV_O_SNAPSHOT;
 145             break;
 146         case 'n':
 147             flags |= BDRV_O_NOCACHE | BDRV_O_CACHE_WB;
 148             break;
 149         case 'r':
 150             readonly = 1;
 151             break;
 152         case 'o':
 153             if (!qemu_opts_parse_noisily(&empty_opts, optarg, false)) {
 154                 qemu_opts_reset(&empty_opts);
 155                 return 0;
 156             }
 157             break;
 158         default:
 159             qemu_opts_reset(&empty_opts);
 160             return qemuio_command_usage(&open_cmd);
 161         }
 162     }
 163
 164     if (!readonly) {
 165         flags |= BDRV_O_RDWR;
 166     }
 167
 168     qopts = qemu_opts_find(&empty_opts, NULL);
 169     opts = qopts ? qemu_opts_to_qdict(qopts, NULL) : NULL;
 170     qemu_opts_reset(&empty_opts);
 171
 172     if (optind == argc - 1) {
 173         return openfile(argv[optind], flags, opts);
 174     } else if (optind == argc) {
 175         return openfile(NULL, flags, opts);
 176     } else {
 177         QDECREF(opts);
 178         return qemuio_command_usage(&open_cmd);
 179     }
 180 }
 181
 182 static int quit_f(BlockBackend *blk, int argc, char **argv)
 183 {
 184     return 1;
 185 }
 186
 187 static const cmdinfo_t quit_cmd = {
 188     .name       = "quit",
 189     .altname    = "q",
 190     .cfunc      = quit_f,
 191     .argmin     = -1,
 192     .argmax     = -1,
 193     .flags      = CMD_FLAG_GLOBAL,
 194     .oneline    = "exit the program",
 195 };
 196
 197 static void usage(const char *name)
 198 {
 199     printf(
 200 "Usage: %s [-h] [-V] [-rsnm] [-f FMT] [-c STRING] ... [file]\n"
 201 "QEMU Disk exerciser\n"
 202 "\n"
 203 "  -c, --cmd STRING     execute command with its arguments\n"
 204 "                       from the given string\n"
 205 "  -f, --format FMT     specifies the block driver to use\n"
 206 "  -r, --read-only      export read-only\n"
 207 "  -s, --snapshot       use snapshot file\n"
 208 "  -n, --nocache        disable host cache\n"
 209 "  -m, --misalign       misalign allocations for O_DIRECT\n"
 210 "  -k, --native-aio     use kernel AIO implementation (on Linux only)\n"
 211 "  -t, --cache=MODE     use the given cache mode for the image\n"
 212 "  -T, --trace FILE     enable trace events listed in the given file\n"
 213 "  -h, --help           display this help and exit\n"
 214 "  -V, --version        output version information and exit\n"
 215 "\n"
 216 "See '%s -c help' for information on available commands."
 217 "\n",
 218     name, name);
 219 }
 220
 221 static char *get_prompt(void)
 222 {
 223     static char prompt[FILENAME_MAX + 2 /*"> "*/ + 1 /*"\0"*/ ];
 224
 225     if (!prompt[0]) {
 226         snprintf(prompt, sizeof(prompt), "%s> ", progname);
 227     }
 228
 229     return prompt;
 230 }
 231
 232 static void GCC_FMT_ATTR(2, 3) readline_printf_func(void *opaque,
 233                                                     const char *fmt, ...)
 234 {
 235     va_list ap;
 236     va_start(ap, fmt);
 237     vprintf(fmt, ap);
 238     va_end(ap);
 239 }
 240
 241 static void readline_flush_func(void *opaque)
 242 {
 243     fflush(stdout);
 244 }
 245
 246 static void readline_func(void *opaque, const char *str, void *readline_opaque)
 247 {
 248     char **line = readline_opaque;
 249     *line = g_strdup(str);
 250 }
 251
 252 static void completion_match(const char *cmd, void *opaque)
 253 {
 254     readline_add_completion(readline_state, cmd);
 255 }
 256
 257 static void readline_completion_func(void *opaque, const char *str)
 258 {
 259     readline_set_completion_index(readline_state, strlen(str));
 260     qemuio_complete_command(str, completion_match, NULL);
 261 }
 262
 263 static char *fetchline_readline(void)
 264 {
 265     char *line = NULL;
 266
 267     readline_start(readline_state, get_prompt(), 0, readline_func, &line);
 268     while (!line) {
 269         int ch = getchar();
 270         if (ch == EOF) {
 271             break;
 272         }
 273         readline_handle_byte(readline_state, ch);
 274     }
 275     return line;
 276 }
 277
 278 #define MAXREADLINESZ 1024
 279 static char *fetchline_fgets(void)
 280 {
 281     char *p, *line = g_malloc(MAXREADLINESZ);
 282
 283     if (!fgets(line, MAXREADLINESZ, stdin)) {
 284         g_free(line);
 285         return NULL;
 286     }
 287
 288     p = line + strlen(line);
 289     if (p != line && p[-1] == '\n') {
 290         p[-1] = '\0';
 291     }
 292
 293     return line;
 294 }
 295
 296 static char *fetchline(void)
 297 {
 298     if (readline_state) {
 299         return fetchline_readline();
 300     } else {
 301         return fetchline_fgets();
 302     }
 303 }
 304
 305 static void prep_fetchline(void *opaque)
 306 {
 307     int *fetchable = opaque;
 308
 309     qemu_set_fd_handler(STDIN_FILENO, NULL, NULL, NULL);
 310     *fetchable= 1;
 311 }
 312
 313 static void command_loop(void)
 314 {
 315     int i, done = 0, fetchable = 0, prompted = 0;
 316     char *input;
 317
 318     for (i = 0; !done && i < ncmdline; i++) {
 319         done = qemuio_command(qemuio_blk, cmdline[i]);
 320     }
 321     if (cmdline) {
 322         g_free(cmdline);
 323         return;
 324     }
 325
 326     while (!done) {
 327         if (!prompted) {
 328             printf("%s", get_prompt());
 329             fflush(stdout);
 330             qemu_set_fd_handler(STDIN_FILENO, prep_fetchline, NULL, &fetchable);
 331             prompted = 1;
 332         }
 333
 334         main_loop_wait(false);
 335
 336         if (!fetchable) {
 337             continue;
 338         }
 339
 340         input = fetchline();
 341         if (input == NULL) {
 342             break;
 343         }
 344         done = qemuio_command(qemuio_blk, input);
 345         g_free(input);
 346
 347         prompted = 0;
 348         fetchable = 0;
 349     }
 350     qemu_set_fd_handler(STDIN_FILENO, NULL, NULL, NULL);
 351 }
 352
 353 static void add_user_command(char *optarg)
 354 {
 355     cmdline = g_renew(char *, cmdline, ++ncmdline);
 356     cmdline[ncmdline-1] = optarg;
 357 }
 358
 359 static void reenable_tty_echo(void)
 360 {
 361     qemu_set_tty_echo(STDIN_FILENO, true);
 362 }
 363
 364 int main(int argc, char **argv)
 365 {
 366     int readonly = 0;
 367     const char *sopt = "hVc:d:f:rsnmgkt:T:";
 368     const struct option lopt[] = {
 369         { "help", 0, NULL, 'h' },
 370         { "version", 0, NULL, 'V' },
 371         { "offset", 1, NULL, 'o' },
 372         { "cmd", 1, NULL, 'c' },
 373         { "format", 1, NULL, 'f' },
 374         { "read-only", 0, NULL, 'r' },
 375         { "snapshot", 0, NULL, 's' },
 376         { "nocache", 0, NULL, 'n' },
 377         { "misalign", 0, NULL, 'm' },
 378         { "native-aio", 0, NULL, 'k' },
 379         { "discard", 1, NULL, 'd' },
 380         { "cache", 1, NULL, 't' },
 381         { "trace", 1, NULL, 'T' },
 382         { NULL, 0, NULL, 0 }
 383     };
 384     int c;
 385     int opt_index = 0;
 386     int flags = BDRV_O_UNMAP;
 387     Error *local_error = NULL;
 388     QDict *opts = NULL;
 389
 390 #ifdef CONFIG_POSIX
 391     signal(SIGPIPE, SIG_IGN);
 392 #endif
 393
 394     progname = basename(argv[0]);
 395     qemu_init_exec_dir(argv[0]);
 396
 397     bdrv_init();
 398
 399     while ((c = getopt_long(argc, argv, sopt, lopt, &opt_index)) != -1) {
 400         switch (c) {
 401         case 's':
 402             flags |= BDRV_O_SNAPSHOT;
 403             break;
 404         case 'n':
 405             flags |= BDRV_O_NOCACHE | BDRV_O_CACHE_WB;
 406             break;
 407         case 'd':
 408             if (bdrv_parse_discard_flags(optarg, &flags) < 0) {
 409                 error_report("Invalid discard option: %s", optarg);
 410                 exit(1);
 411             }
 412             break;
 413         case 'f':
 414             if (!opts) {
 415                 opts = qdict_new();
 416             }
 417             qdict_put(opts, "driver", qstring_from_str(optarg));
 418             break;
 419         case 'c':
 420             add_user_command(optarg);
 421             break;
 422         case 'r':
 423             readonly = 1;
 424             break;
 425         case 'm':
 426             qemuio_misalign = true;
 427             break;
 428         case 'k':
 429             flags |= BDRV_O_NATIVE_AIO;
 430             break;
 431         case 't':
 432             if (bdrv_parse_cache_flags(optarg, &flags) < 0) {
 433                 error_report("Invalid cache option: %s", optarg);
 434                 exit(1);
 435             }
 436             break;
 437         case 'T':
 438             if (!trace_init_backends(optarg, NULL)) {
 439                 exit(1); /* error message will have been printed */
 440             }
 441             break;
 442         case 'V':
 443             printf("%s version %s\n", progname, QEMU_VERSION);
 444             exit(0);
 445         case 'h':
 446             usage(progname);
 447             exit(0);
 448         default:
 449             usage(progname);
 450             exit(1);
 451         }
 452     }
 453
 454     if ((argc - optind) > 1) {
 455         usage(progname);
 456         exit(1);
 457     }
 458
 459     if (qemu_init_main_loop(&local_error)) {
 460         error_report_err(local_error);
 461         exit(1);
 462     }
 463
 464     /* initialize commands */
 465     qemuio_add_command(&quit_cmd);
 466     qemuio_add_command(&open_cmd);
 467     qemuio_add_command(&close_cmd);
 468
 469     if (isatty(STDIN_FILENO)) {
 470         readline_state = readline_init(readline_printf_func,
 471                                        readline_flush_func,
 472                                        NULL,
 473                                        readline_completion_func);
 474         qemu_set_tty_echo(STDIN_FILENO, false);
 475         atexit(reenable_tty_echo);
 476     }
 477
 478     /* open the device */
 479     if (!readonly) {
 480         flags |= BDRV_O_RDWR;
 481     }
 482
 483     if ((argc - optind) == 1) {
 484         openfile(argv[optind], flags, opts);
 485     }
 486     command_loop();
 487
 488     /*
 489      * Make sure all outstanding requests complete before the program exits.
 490      */
 491     bdrv_drain_all();
 492
 493     blk_unref(qemuio_blk);
 494     g_free(readline_state);
 495     return 0;
 496 }