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