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