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