qemu-io-cmds.c 57.0 KB
Newer Older
1 2 3
/*
 * Command line utility to exercise the QEMU I/O path.
 *
4
 * Copyright (C) 2009-2016 Red Hat, Inc.
5 6 7 8 9 10
 * Copyright (c) 2003-2005 Silicon Graphics, Inc.
 *
 * This work is licensed under the terms of the GNU GPL, version 2 or later.
 * See the COPYING file in the top-level directory.
 */

P
Peter Maydell 已提交
11
#include "qemu/osdep.h"
12
#include "qapi/error.h"
K
Kevin Wolf 已提交
13
#include "qemu-io.h"
M
Max Reitz 已提交
14 15 16
#include "sysemu/block-backend.h"
#include "block/block.h"
#include "block/block_int.h" /* for info_f() */
17
#include "block/qapi.h"
18
#include "qemu/error-report.h"
19
#include "qemu/main-loop.h"
K
Kevin Wolf 已提交
20
#include "qemu/timer.h"
21
#include "sysemu/block-backend.h"
22
#include "qemu/cutils.h"
23 24 25

#define CMD_NOFILE_OK   0x01

26
bool qemuio_misalign;
27

28 29 30 31 32 33 34 35 36 37 38
static cmdinfo_t *cmdtab;
static int ncmds;

static int compare_cmdname(const void *a, const void *b)
{
    return strcmp(((const cmdinfo_t *)a)->name,
                  ((const cmdinfo_t *)b)->name);
}

void qemuio_add_command(const cmdinfo_t *ci)
{
39
    cmdtab = g_renew(cmdinfo_t, cmdtab, ++ncmds);
40 41 42 43 44 45 46 47 48 49
    cmdtab[ncmds - 1] = *ci;
    qsort(cmdtab, ncmds, sizeof(*cmdtab), compare_cmdname);
}

int qemuio_command_usage(const cmdinfo_t *ci)
{
    printf("%s %s -- %s\n", ci->name, ci->args, ci->oneline);
    return 0;
}

M
Max Reitz 已提交
50
static int init_check_command(BlockBackend *blk, const cmdinfo_t *ct)
51 52 53 54
{
    if (ct->flags & CMD_FLAG_GLOBAL) {
        return 1;
    }
M
Max Reitz 已提交
55
    if (!(ct->flags & CMD_NOFILE_OK) && !blk) {
56 57 58 59 60 61
        fprintf(stderr, "no file open, try 'help open'\n");
        return 0;
    }
    return 1;
}

M
Max Reitz 已提交
62
static int command(BlockBackend *blk, const cmdinfo_t *ct, int argc,
K
Kevin Wolf 已提交
63
                   char **argv)
64 65 66
{
    char *cmd = argv[0];

M
Max Reitz 已提交
67
    if (!init_check_command(blk, ct)) {
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
        return 0;
    }

    if (argc - 1 < ct->argmin || (ct->argmax != -1 && argc - 1 > ct->argmax)) {
        if (ct->argmax == -1) {
            fprintf(stderr,
                    "bad argument count %d to %s, expected at least %d arguments\n",
                    argc-1, cmd, ct->argmin);
        } else if (ct->argmin == ct->argmax) {
            fprintf(stderr,
                    "bad argument count %d to %s, expected %d arguments\n",
                    argc-1, cmd, ct->argmin);
        } else {
            fprintf(stderr,
                    "bad argument count %d to %s, expected between %d and %d arguments\n",
                    argc-1, cmd, ct->argmin, ct->argmax);
        }
        return 0;
    }
    optind = 0;
M
Max Reitz 已提交
88
    return ct->cfunc(blk, argc, argv);
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
}

static const cmdinfo_t *find_command(const char *cmd)
{
    cmdinfo_t *ct;

    for (ct = cmdtab; ct < &cmdtab[ncmds]; ct++) {
        if (strcmp(ct->name, cmd) == 0 ||
            (ct->altname && strcmp(ct->altname, cmd) == 0))
        {
            return (const cmdinfo_t *)ct;
        }
    }
    return NULL;
}

105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
/* Invoke fn() for commands with a matching prefix */
void qemuio_complete_command(const char *input,
                             void (*fn)(const char *cmd, void *opaque),
                             void *opaque)
{
    cmdinfo_t *ct;
    size_t input_len = strlen(input);

    for (ct = cmdtab; ct < &cmdtab[ncmds]; ct++) {
        if (strncmp(input, ct->name, input_len) == 0) {
            fn(ct->name, opaque);
        }
    }
}

120 121 122 123
static char **breakline(char *input, int *count)
{
    int c = 0;
    char *p;
124
    char **rval = g_new0(char *, 1);
125 126 127 128 129 130

    while (rval && (p = qemu_strsep(&input, " ")) != NULL) {
        if (!*p) {
            continue;
        }
        c++;
131
        rval = g_renew(char *, rval, (c + 1));
132 133 134 135 136 137 138
        rval[c - 1] = p;
        rval[c] = NULL;
    }
    *count = c;
    return rval;
}

139 140 141
static int64_t cvtnum(const char *s)
{
    char *end;
J
John Snow 已提交
142 143 144 145 146 147 148 149
    int64_t ret;

    ret = qemu_strtosz_suffix(s, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
    if (*end != '\0') {
        /* Detritus at the end of the string */
        return -EINVAL;
    }
    return ret;
150 151
}

J
John Snow 已提交
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
static void print_cvtnum_err(int64_t rc, const char *arg)
{
    switch (rc) {
    case -EINVAL:
        printf("Parsing error: non-numeric argument,"
               " or extraneous/unrecognized suffix -- %s\n", arg);
        break;
    case -ERANGE:
        printf("Parsing error: argument too large -- %s\n", arg);
        break;
    default:
        printf("Parsing error: %s\n", arg);
    }
}

167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
#define EXABYTES(x)     ((long long)(x) << 60)
#define PETABYTES(x)    ((long long)(x) << 50)
#define TERABYTES(x)    ((long long)(x) << 40)
#define GIGABYTES(x)    ((long long)(x) << 30)
#define MEGABYTES(x)    ((long long)(x) << 20)
#define KILOBYTES(x)    ((long long)(x) << 10)

#define TO_EXABYTES(x)  ((x) / EXABYTES(1))
#define TO_PETABYTES(x) ((x) / PETABYTES(1))
#define TO_TERABYTES(x) ((x) / TERABYTES(1))
#define TO_GIGABYTES(x) ((x) / GIGABYTES(1))
#define TO_MEGABYTES(x) ((x) / MEGABYTES(1))
#define TO_KILOBYTES(x) ((x) / KILOBYTES(1))

static void cvtstr(double value, char *str, size_t size)
{
    char *trim;
    const char *suffix;

    if (value >= EXABYTES(1)) {
        suffix = " EiB";
        snprintf(str, size - 4, "%.3f", TO_EXABYTES(value));
    } else if (value >= PETABYTES(1)) {
        suffix = " PiB";
        snprintf(str, size - 4, "%.3f", TO_PETABYTES(value));
    } else if (value >= TERABYTES(1)) {
        suffix = " TiB";
        snprintf(str, size - 4, "%.3f", TO_TERABYTES(value));
    } else if (value >= GIGABYTES(1)) {
        suffix = " GiB";
        snprintf(str, size - 4, "%.3f", TO_GIGABYTES(value));
    } else if (value >= MEGABYTES(1)) {
        suffix = " MiB";
        snprintf(str, size - 4, "%.3f", TO_MEGABYTES(value));
    } else if (value >= KILOBYTES(1)) {
        suffix = " KiB";
        snprintf(str, size - 4, "%.3f", TO_KILOBYTES(value));
    } else {
        suffix = " bytes";
        snprintf(str, size - 6, "%f", value);
    }

    trim = strstr(str, ".000");
    if (trim) {
        strcpy(trim, suffix);
    } else {
        strcat(str, suffix);
    }
}



static struct timeval tsub(struct timeval t1, struct timeval t2)
{
    t1.tv_usec -= t2.tv_usec;
    if (t1.tv_usec < 0) {
        t1.tv_usec += 1000000;
        t1.tv_sec--;
    }
    t1.tv_sec -= t2.tv_sec;
    return t1;
}

static double tdiv(double value, struct timeval tv)
{
    return value / ((double)tv.tv_sec + ((double)tv.tv_usec / 1000000.0));
}

#define HOURS(sec)      ((sec) / (60 * 60))
#define MINUTES(sec)    (((sec) % (60 * 60)) / 60)
#define SECONDS(sec)    ((sec) % 60)

enum {
    DEFAULT_TIME        = 0x0,
    TERSE_FIXED_TIME    = 0x1,
    VERBOSE_FIXED_TIME  = 0x2,
};

static void timestr(struct timeval *tv, char *ts, size_t size, int format)
{
    double usec = (double)tv->tv_usec / 1000000.0;

    if (format & TERSE_FIXED_TIME) {
        if (!HOURS(tv->tv_sec)) {
            snprintf(ts, size, "%u:%02u.%02u",
                    (unsigned int) MINUTES(tv->tv_sec),
                    (unsigned int) SECONDS(tv->tv_sec),
                    (unsigned int) (usec * 100));
            return;
        }
        format |= VERBOSE_FIXED_TIME; /* fallback if hours needed */
    }

    if ((format & VERBOSE_FIXED_TIME) || tv->tv_sec) {
        snprintf(ts, size, "%u:%02u:%02u.%02u",
                (unsigned int) HOURS(tv->tv_sec),
                (unsigned int) MINUTES(tv->tv_sec),
                (unsigned int) SECONDS(tv->tv_sec),
                (unsigned int) (usec * 100));
    } else {
        snprintf(ts, size, "0.%04u sec", (unsigned int) (usec * 10000));
    }
}

271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
/*
 * Parse the pattern argument to various sub-commands.
 *
 * Because the pattern is used as an argument to memset it must evaluate
 * to an unsigned integer that fits into a single byte.
 */
static int parse_pattern(const char *arg)
{
    char *endptr = NULL;
    long pattern;

    pattern = strtol(arg, &endptr, 0);
    if (pattern < 0 || pattern > UCHAR_MAX || *endptr != '\0') {
        printf("%s is not a valid pattern byte\n", arg);
        return -1;
    }

    return pattern;
}

/*
 * Memory allocation helpers.
 *
 * Make sure memory is aligned by default, or purposefully misaligned if
 * that is specified on the command line.
 */

#define MISALIGN_OFFSET     16
M
Max Reitz 已提交
299
static void *qemu_io_alloc(BlockBackend *blk, size_t len, int pattern)
300 301 302 303 304 305
{
    void *buf;

    if (qemuio_misalign) {
        len += MISALIGN_OFFSET;
    }
M
Max Reitz 已提交
306
    buf = blk_blockalign(blk, len);
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
    memset(buf, pattern, len);
    if (qemuio_misalign) {
        buf += MISALIGN_OFFSET;
    }
    return buf;
}

static void qemu_io_free(void *p)
{
    if (qemuio_misalign) {
        p -= MISALIGN_OFFSET;
    }
    qemu_vfree(p);
}

J
John Snow 已提交
322
static void dump_buffer(const void *buffer, int64_t offset, int64_t len)
323
{
J
John Snow 已提交
324 325
    uint64_t i;
    int j;
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
    const uint8_t *p;

    for (i = 0, p = buffer; i < len; i += 16) {
        const uint8_t *s = p;

        printf("%08" PRIx64 ":  ", offset + i);
        for (j = 0; j < 16 && i + j < len; j++, p++) {
            printf("%02x ", *p);
        }
        printf(" ");
        for (j = 0; j < 16 && i + j < len; j++, s++) {
            if (isalnum(*s)) {
                printf("%c", *s);
            } else {
                printf(".");
            }
        }
        printf("\n");
    }
}

static void print_report(const char *op, struct timeval *t, int64_t offset,
348
                         int64_t count, int64_t total, int cnt, bool Cflag)
349 350 351 352 353 354 355
{
    char s1[64], s2[64], ts[64];

    timestr(t, ts, sizeof(ts), Cflag ? VERBOSE_FIXED_TIME : 0);
    if (!Cflag) {
        cvtstr((double)total, s1, sizeof(s1));
        cvtstr(tdiv((double)total, *t), s2, sizeof(s2));
J
John Snow 已提交
356
        printf("%s %"PRId64"/%"PRId64" bytes at offset %" PRId64 "\n",
357 358 359 360
               op, total, count, offset);
        printf("%s, %d ops; %s (%s/sec and %.4f ops/sec)\n",
               s1, cnt, ts, s2, tdiv((double)cnt, *t));
    } else {/* bytes,ops,time,bytes/sec,ops/sec */
J
John Snow 已提交
361
        printf("%"PRId64",%d,%s,%.3f,%.3f\n",
362 363 364 365 366 367 368 369 370 371 372
            total, cnt, ts,
            tdiv((double)total, *t),
            tdiv((double)cnt, *t));
    }
}

/*
 * Parse multiple length statements for vectored I/O, and construct an I/O
 * vector matching it.
 */
static void *
M
Max Reitz 已提交
373
create_iovec(BlockBackend *blk, QEMUIOVector *qiov, char **argv, int nr_iov,
374 375 376 377 378 379 380 381 382 383 384 385 386 387
             int pattern)
{
    size_t *sizes = g_new0(size_t, nr_iov);
    size_t count = 0;
    void *buf = NULL;
    void *p;
    int i;

    for (i = 0; i < nr_iov; i++) {
        char *arg = argv[i];
        int64_t len;

        len = cvtnum(arg);
        if (len < 0) {
J
John Snow 已提交
388
            print_cvtnum_err(len, arg);
389 390 391 392 393
            goto fail;
        }

        /* should be SIZE_T_MAX, but that doesn't exist */
        if (len > INT_MAX) {
J
John Snow 已提交
394
            printf("Argument '%s' exceeds maximum size %d\n", arg, INT_MAX);
395 396 397 398 399 400 401 402 403
            goto fail;
        }

        sizes[i] = len;
        count += len;
    }

    qemu_iovec_init(qiov, nr_iov);

M
Max Reitz 已提交
404
    buf = p = qemu_io_alloc(blk, count, pattern);
405 406 407 408 409 410 411 412 413 414 415

    for (i = 0; i < nr_iov; i++) {
        qemu_iovec_add(qiov, p, sizes[i]);
        p += sizes[i];
    }

fail:
    g_free(sizes);
    return buf;
}

J
John Snow 已提交
416 417
static int do_pread(BlockBackend *blk, char *buf, int64_t offset,
                    int64_t count, int64_t *total)
418
{
J
John Snow 已提交
419 420 421 422
    if (count > INT_MAX) {
        return -ERANGE;
    }

M
Max Reitz 已提交
423
    *total = blk_pread(blk, offset, (uint8_t *)buf, count);
424 425 426 427 428 429
    if (*total < 0) {
        return *total;
    }
    return 1;
}

J
John Snow 已提交
430
static int do_pwrite(BlockBackend *blk, char *buf, int64_t offset,
431
                     int64_t count, int flags, int64_t *total)
432
{
J
John Snow 已提交
433 434 435 436
    if (count > INT_MAX) {
        return -ERANGE;
    }

437
    *total = blk_pwrite(blk, offset, (uint8_t *)buf, count, flags);
438 439 440 441 442 443 444
    if (*total < 0) {
        return *total;
    }
    return 1;
}

typedef struct {
M
Max Reitz 已提交
445
    BlockBackend *blk;
446
    int64_t offset;
J
John Snow 已提交
447 448
    int64_t count;
    int64_t *total;
449
    int flags;
450 451 452 453 454 455 456 457
    int ret;
    bool done;
} CoWriteZeroes;

static void coroutine_fn co_write_zeroes_entry(void *opaque)
{
    CoWriteZeroes *data = opaque;

458 459
    data->ret = blk_co_write_zeroes(data->blk, data->offset, data->count,
                                    data->flags);
460 461 462 463 464 465 466 467 468
    data->done = true;
    if (data->ret < 0) {
        *data->total = data->ret;
        return;
    }

    *data->total = data->count;
}

J
John Snow 已提交
469
static int do_co_write_zeroes(BlockBackend *blk, int64_t offset, int64_t count,
470
                              int flags, int64_t *total)
471 472 473
{
    Coroutine *co;
    CoWriteZeroes data = {
M
Max Reitz 已提交
474
        .blk    = blk,
475 476 477
        .offset = offset,
        .count  = count,
        .total  = total,
478
        .flags  = flags,
479 480 481
        .done   = false,
    };

J
John Snow 已提交
482 483 484 485
    if (count >> BDRV_SECTOR_BITS > INT_MAX) {
        return -ERANGE;
    }

486 487 488
    co = qemu_coroutine_create(co_write_zeroes_entry);
    qemu_coroutine_enter(co, &data);
    while (!data.done) {
M
Max Reitz 已提交
489
        aio_poll(blk_get_aio_context(blk), true);
490 491 492 493 494 495 496 497
    }
    if (data.ret < 0) {
        return data.ret;
    } else {
        return 1;
    }
}

M
Max Reitz 已提交
498
static int do_write_compressed(BlockBackend *blk, char *buf, int64_t offset,
J
John Snow 已提交
499
                               int64_t count, int64_t *total)
500 501 502
{
    int ret;

J
John Snow 已提交
503 504 505 506
    if (count >> 9 > INT_MAX) {
        return -ERANGE;
    }

M
Max Reitz 已提交
507
    ret = blk_write_compressed(blk, offset >> 9, (uint8_t *)buf, count >> 9);
508 509 510 511 512 513 514
    if (ret < 0) {
        return ret;
    }
    *total = count;
    return 1;
}

M
Max Reitz 已提交
515
static int do_load_vmstate(BlockBackend *blk, char *buf, int64_t offset,
J
John Snow 已提交
516
                           int64_t count, int64_t *total)
517
{
J
John Snow 已提交
518 519 520 521
    if (count > INT_MAX) {
        return -ERANGE;
    }

M
Max Reitz 已提交
522
    *total = blk_load_vmstate(blk, (uint8_t *)buf, offset, count);
523 524 525 526 527 528
    if (*total < 0) {
        return *total;
    }
    return 1;
}

M
Max Reitz 已提交
529
static int do_save_vmstate(BlockBackend *blk, char *buf, int64_t offset,
J
John Snow 已提交
530
                           int64_t count, int64_t *total)
531
{
J
John Snow 已提交
532 533 534 535
    if (count > INT_MAX) {
        return -ERANGE;
    }

M
Max Reitz 已提交
536
    *total = blk_save_vmstate(blk, (uint8_t *)buf, offset, count);
537 538 539 540 541 542 543 544 545 546 547 548
    if (*total < 0) {
        return *total;
    }
    return 1;
}

#define NOT_DONE 0x7fffffff
static void aio_rw_done(void *opaque, int ret)
{
    *(int *)opaque = ret;
}

M
Max Reitz 已提交
549
static int do_aio_readv(BlockBackend *blk, QEMUIOVector *qiov,
550 551 552 553
                        int64_t offset, int *total)
{
    int async_ret = NOT_DONE;

554
    blk_aio_preadv(blk, offset, qiov, 0, aio_rw_done, &async_ret);
555 556 557 558 559 560 561 562
    while (async_ret == NOT_DONE) {
        main_loop_wait(false);
    }

    *total = qiov->size;
    return async_ret < 0 ? async_ret : 1;
}

M
Max Reitz 已提交
563
static int do_aio_writev(BlockBackend *blk, QEMUIOVector *qiov,
564
                         int64_t offset, int flags, int *total)
565 566 567
{
    int async_ret = NOT_DONE;

568
    blk_aio_pwritev(blk, offset, qiov, flags, aio_rw_done, &async_ret);
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
    while (async_ret == NOT_DONE) {
        main_loop_wait(false);
    }

    *total = qiov->size;
    return async_ret < 0 ? async_ret : 1;
}

static void read_help(void)
{
    printf(
"\n"
" reads a range of bytes from the given offset\n"
"\n"
" Example:\n"
" 'read -v 512 1k' - dumps 1 kilobyte read from 512 bytes into the file\n"
"\n"
" Reads a segment of the currently open file, optionally dumping it to the\n"
" standard output stream (with -v option) for subsequent inspection.\n"
" -b, -- read from the VM state rather than the virtual disk\n"
" -C, -- report statistics in a machine parsable format\n"
" -l, -- length for pattern verification (only with -P)\n"
591
" -p, -- ignored for backwards compatibility\n"
592 593 594 595 596 597 598
" -P, -- use a pattern to verify read data\n"
" -q, -- quiet mode, do not show I/O statistics\n"
" -s, -- start offset for pattern verification (only with -P)\n"
" -v, -- dump buffer to standard output\n"
"\n");
}

M
Max Reitz 已提交
599
static int read_f(BlockBackend *blk, int argc, char **argv);
600 601 602 603 604 605 606

static const cmdinfo_t read_cmd = {
    .name       = "read",
    .altname    = "r",
    .cfunc      = read_f,
    .argmin     = 2,
    .argmax     = -1,
607
    .args       = "[-abCqv] [-P pattern [-s off] [-l len]] off len",
608 609 610 611
    .oneline    = "reads a number of bytes at a specified offset",
    .help       = read_help,
};

M
Max Reitz 已提交
612
static int read_f(BlockBackend *blk, int argc, char **argv)
613 614
{
    struct timeval t1, t2;
615
    bool Cflag = false, qflag = false, vflag = false;
616
    bool Pflag = false, sflag = false, lflag = false, bflag = false;
617 618 619
    int c, cnt;
    char *buf;
    int64_t offset;
J
John Snow 已提交
620
    int64_t count;
621
    /* Some compilers get confused and warn if this is not initialized.  */
J
John Snow 已提交
622 623 624
    int64_t total = 0;
    int pattern = 0;
    int64_t pattern_offset = 0, pattern_count = 0;
625

E
Eric Blake 已提交
626
    while ((c = getopt(argc, argv, "bCl:pP:qs:v")) != -1) {
627 628
        switch (c) {
        case 'b':
629
            bflag = true;
630 631
            break;
        case 'C':
632
            Cflag = true;
633 634
            break;
        case 'l':
635
            lflag = true;
636 637
            pattern_count = cvtnum(optarg);
            if (pattern_count < 0) {
J
John Snow 已提交
638
                print_cvtnum_err(pattern_count, optarg);
639 640 641 642
                return 0;
            }
            break;
        case 'p':
643
            /* Ignored for backwards compatibility */
644 645
            break;
        case 'P':
646
            Pflag = true;
647 648 649 650 651 652
            pattern = parse_pattern(optarg);
            if (pattern < 0) {
                return 0;
            }
            break;
        case 'q':
653
            qflag = true;
654 655
            break;
        case 's':
656
            sflag = true;
657 658
            pattern_offset = cvtnum(optarg);
            if (pattern_offset < 0) {
J
John Snow 已提交
659
                print_cvtnum_err(pattern_offset, optarg);
660 661 662 663
                return 0;
            }
            break;
        case 'v':
664
            vflag = true;
665 666
            break;
        default:
667
            return qemuio_command_usage(&read_cmd);
668 669 670 671
        }
    }

    if (optind != argc - 2) {
672
        return qemuio_command_usage(&read_cmd);
673 674 675 676
    }

    offset = cvtnum(argv[optind]);
    if (offset < 0) {
J
John Snow 已提交
677
        print_cvtnum_err(offset, argv[optind]);
678 679 680 681 682 683
        return 0;
    }

    optind++;
    count = cvtnum(argv[optind]);
    if (count < 0) {
J
John Snow 已提交
684
        print_cvtnum_err(count, argv[optind]);
685
        return 0;
J
John Snow 已提交
686 687 688 689
    } else if (count > SIZE_MAX) {
        printf("length cannot exceed %" PRIu64 ", given %s\n",
               (uint64_t) SIZE_MAX, argv[optind]);
        return 0;
690 691 692
    }

    if (!Pflag && (lflag || sflag)) {
693
        return qemuio_command_usage(&read_cmd);
694 695 696 697 698 699 700 701 702 703 704
    }

    if (!lflag) {
        pattern_count = count - pattern_offset;
    }

    if ((pattern_count < 0) || (pattern_count + pattern_offset > count))  {
        printf("pattern verification range exceeds end of read data\n");
        return 0;
    }

705
    if (bflag) {
706 707 708 709 710 711
        if (offset & 0x1ff) {
            printf("offset %" PRId64 " is not sector aligned\n",
                   offset);
            return 0;
        }
        if (count & 0x1ff) {
J
John Snow 已提交
712
            printf("count %"PRId64" is not sector aligned\n",
713 714 715 716 717
                   count);
            return 0;
        }
    }

M
Max Reitz 已提交
718
    buf = qemu_io_alloc(blk, count, 0xab);
719 720

    gettimeofday(&t1, NULL);
721
    if (bflag) {
M
Max Reitz 已提交
722
        cnt = do_load_vmstate(blk, buf, offset, count, &total);
723
    } else {
724
        cnt = do_pread(blk, buf, offset, count, &total);
725 726 727 728 729 730 731 732 733 734 735 736 737
    }
    gettimeofday(&t2, NULL);

    if (cnt < 0) {
        printf("read failed: %s\n", strerror(-cnt));
        goto out;
    }

    if (Pflag) {
        void *cmp_buf = g_malloc(pattern_count);
        memset(cmp_buf, pattern, pattern_count);
        if (memcmp(buf + pattern_offset, cmp_buf, pattern_count)) {
            printf("Pattern verification failed at offset %"
J
John Snow 已提交
738
                   PRId64 ", %"PRId64" bytes\n",
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
                   offset + pattern_offset, pattern_count);
        }
        g_free(cmp_buf);
    }

    if (qflag) {
        goto out;
    }

    if (vflag) {
        dump_buffer(buf, offset, count);
    }

    /* Finally, report back -- -C gives a parsable format */
    t2 = tsub(t2, t1);
    print_report("read", &t2, offset, count, total, cnt, Cflag);

out:
    qemu_io_free(buf);

    return 0;
}

static void readv_help(void)
{
    printf(
"\n"
" reads a range of bytes from the given offset into multiple buffers\n"
"\n"
" Example:\n"
" 'readv -v 512 1k 1k ' - dumps 2 kilobytes read from 512 bytes into the file\n"
"\n"
" Reads a segment of the currently open file, optionally dumping it to the\n"
" standard output stream (with -v option) for subsequent inspection.\n"
" Uses multiple iovec buffers if more than one byte range is specified.\n"
" -C, -- report statistics in a machine parsable format\n"
" -P, -- use a pattern to verify read data\n"
" -v, -- dump buffer to standard output\n"
" -q, -- quiet mode, do not show I/O statistics\n"
"\n");
}

M
Max Reitz 已提交
781
static int readv_f(BlockBackend *blk, int argc, char **argv);
782 783 784 785 786 787

static const cmdinfo_t readv_cmd = {
    .name       = "readv",
    .cfunc      = readv_f,
    .argmin     = 2,
    .argmax     = -1,
788
    .args       = "[-Cqv] [-P pattern] off len [len..]",
789 790 791 792
    .oneline    = "reads a number of bytes at a specified offset",
    .help       = readv_help,
};

M
Max Reitz 已提交
793
static int readv_f(BlockBackend *blk, int argc, char **argv)
794 795
{
    struct timeval t1, t2;
796
    bool Cflag = false, qflag = false, vflag = false;
797 798 799 800 801 802 803 804
    int c, cnt;
    char *buf;
    int64_t offset;
    /* Some compilers get confused and warn if this is not initialized.  */
    int total = 0;
    int nr_iov;
    QEMUIOVector qiov;
    int pattern = 0;
805
    bool Pflag = false;
806

E
Eric Blake 已提交
807
    while ((c = getopt(argc, argv, "CP:qv")) != -1) {
808 809
        switch (c) {
        case 'C':
810
            Cflag = true;
811 812
            break;
        case 'P':
813
            Pflag = true;
814 815 816 817 818 819
            pattern = parse_pattern(optarg);
            if (pattern < 0) {
                return 0;
            }
            break;
        case 'q':
820
            qflag = true;
821 822
            break;
        case 'v':
823
            vflag = true;
824 825
            break;
        default:
826
            return qemuio_command_usage(&readv_cmd);
827 828 829 830
        }
    }

    if (optind > argc - 2) {
831
        return qemuio_command_usage(&readv_cmd);
832 833 834 835 836
    }


    offset = cvtnum(argv[optind]);
    if (offset < 0) {
J
John Snow 已提交
837
        print_cvtnum_err(offset, argv[optind]);
838 839 840 841 842
        return 0;
    }
    optind++;

    nr_iov = argc - optind;
M
Max Reitz 已提交
843
    buf = create_iovec(blk, &qiov, &argv[optind], nr_iov, 0xab);
844 845 846 847 848
    if (buf == NULL) {
        return 0;
    }

    gettimeofday(&t1, NULL);
M
Max Reitz 已提交
849
    cnt = do_aio_readv(blk, &qiov, offset, &total);
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
    gettimeofday(&t2, NULL);

    if (cnt < 0) {
        printf("readv failed: %s\n", strerror(-cnt));
        goto out;
    }

    if (Pflag) {
        void *cmp_buf = g_malloc(qiov.size);
        memset(cmp_buf, pattern, qiov.size);
        if (memcmp(buf, cmp_buf, qiov.size)) {
            printf("Pattern verification failed at offset %"
                   PRId64 ", %zd bytes\n", offset, qiov.size);
        }
        g_free(cmp_buf);
    }

    if (qflag) {
        goto out;
    }

    if (vflag) {
        dump_buffer(buf, offset, qiov.size);
    }

    /* Finally, report back -- -C gives a parsable format */
    t2 = tsub(t2, t1);
    print_report("read", &t2, offset, qiov.size, total, cnt, Cflag);

out:
    qemu_iovec_destroy(&qiov);
    qemu_io_free(buf);
    return 0;
}

static void write_help(void)
{
    printf(
"\n"
" writes a range of bytes from the given offset\n"
"\n"
" Example:\n"
" 'write 512 1k' - writes 1 kilobyte at 512 bytes into the open file\n"
"\n"
" Writes into a segment of the currently open file, using a buffer\n"
" filled with a set pattern (0xcdcdcdcd).\n"
" -b, -- write to the VM state rather than the virtual disk\n"
M
Max Reitz 已提交
897
" -c, -- write compressed data with blk_write_compressed\n"
898
" -f, -- use Force Unit Access semantics\n"
899
" -p, -- ignored for backwards compatibility\n"
900 901 902
" -P, -- use different pattern to fill file\n"
" -C, -- report statistics in a machine parsable format\n"
" -q, -- quiet mode, do not show I/O statistics\n"
903
" -u, -- with -z, allow unmapping\n"
M
Max Reitz 已提交
904
" -z, -- write zeroes using blk_co_write_zeroes\n"
905 906 907
"\n");
}

M
Max Reitz 已提交
908
static int write_f(BlockBackend *blk, int argc, char **argv);
909 910 911 912 913 914 915

static const cmdinfo_t write_cmd = {
    .name       = "write",
    .altname    = "w",
    .cfunc      = write_f,
    .argmin     = 2,
    .argmax     = -1,
916
    .args       = "[-bcCfquz] [-P pattern] off len",
917 918 919 920
    .oneline    = "writes a number of bytes at a specified offset",
    .help       = write_help,
};

M
Max Reitz 已提交
921
static int write_f(BlockBackend *blk, int argc, char **argv)
922 923
{
    struct timeval t1, t2;
924
    bool Cflag = false, qflag = false, bflag = false;
925
    bool Pflag = false, zflag = false, cflag = false;
926
    int flags = 0;
927 928 929
    int c, cnt;
    char *buf = NULL;
    int64_t offset;
J
John Snow 已提交
930
    int64_t count;
931
    /* Some compilers get confused and warn if this is not initialized.  */
J
John Snow 已提交
932
    int64_t total = 0;
933 934
    int pattern = 0xcd;

935
    while ((c = getopt(argc, argv, "bcCfpP:quz")) != -1) {
936 937
        switch (c) {
        case 'b':
938
            bflag = true;
939 940
            break;
        case 'c':
941
            cflag = true;
942 943
            break;
        case 'C':
944
            Cflag = true;
945
            break;
946 947 948
        case 'f':
            flags |= BDRV_REQ_FUA;
            break;
949
        case 'p':
950
            /* Ignored for backwards compatibility */
951 952
            break;
        case 'P':
953
            Pflag = true;
954 955 956 957 958 959
            pattern = parse_pattern(optarg);
            if (pattern < 0) {
                return 0;
            }
            break;
        case 'q':
960
            qflag = true;
961
            break;
962 963 964
        case 'u':
            flags |= BDRV_REQ_MAY_UNMAP;
            break;
965
        case 'z':
966
            zflag = true;
967 968
            break;
        default:
969
            return qemuio_command_usage(&write_cmd);
970 971 972 973
        }
    }

    if (optind != argc - 2) {
974
        return qemuio_command_usage(&write_cmd);
975 976
    }

977 978
    if (bflag && zflag) {
        printf("-b and -z cannot be specified at the same time\n");
979 980 981
        return 0;
    }

982 983 984 985 986
    if ((flags & BDRV_REQ_FUA) && (bflag || cflag)) {
        printf("-f and -b or -c cannot be specified at the same time\n");
        return 0;
    }

987 988 989 990 991
    if ((flags & BDRV_REQ_MAY_UNMAP) && !zflag) {
        printf("-u requires -z to be specified\n");
        return 0;
    }

992 993 994 995 996 997 998
    if (zflag && Pflag) {
        printf("-z and -P cannot be specified at the same time\n");
        return 0;
    }

    offset = cvtnum(argv[optind]);
    if (offset < 0) {
J
John Snow 已提交
999
        print_cvtnum_err(offset, argv[optind]);
1000 1001 1002 1003 1004 1005
        return 0;
    }

    optind++;
    count = cvtnum(argv[optind]);
    if (count < 0) {
J
John Snow 已提交
1006
        print_cvtnum_err(count, argv[optind]);
1007
        return 0;
J
John Snow 已提交
1008 1009 1010 1011
    } else if (count > SIZE_MAX) {
        printf("length cannot exceed %" PRIu64 ", given %s\n",
               (uint64_t) SIZE_MAX, argv[optind]);
        return 0;
1012 1013
    }

1014
    if (bflag || cflag) {
1015 1016 1017 1018 1019 1020 1021
        if (offset & 0x1ff) {
            printf("offset %" PRId64 " is not sector aligned\n",
                   offset);
            return 0;
        }

        if (count & 0x1ff) {
J
John Snow 已提交
1022
            printf("count %"PRId64" is not sector aligned\n",
1023 1024 1025 1026 1027 1028
                   count);
            return 0;
        }
    }

    if (!zflag) {
M
Max Reitz 已提交
1029
        buf = qemu_io_alloc(blk, count, pattern);
1030 1031 1032
    }

    gettimeofday(&t1, NULL);
1033
    if (bflag) {
M
Max Reitz 已提交
1034
        cnt = do_save_vmstate(blk, buf, offset, count, &total);
1035
    } else if (zflag) {
1036
        cnt = do_co_write_zeroes(blk, offset, count, flags, &total);
1037
    } else if (cflag) {
M
Max Reitz 已提交
1038
        cnt = do_write_compressed(blk, buf, offset, count, &total);
1039
    } else {
1040
        cnt = do_pwrite(blk, buf, offset, count, flags, &total);
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
    }
    gettimeofday(&t2, NULL);

    if (cnt < 0) {
        printf("write failed: %s\n", strerror(-cnt));
        goto out;
    }

    if (qflag) {
        goto out;
    }

    /* Finally, report back -- -C gives a parsable format */
    t2 = tsub(t2, t1);
    print_report("wrote", &t2, offset, count, total, cnt, Cflag);

out:
    if (!zflag) {
        qemu_io_free(buf);
    }

    return 0;
}

static void
writev_help(void)
{
    printf(
"\n"
" writes a range of bytes from the given offset source from multiple buffers\n"
"\n"
" Example:\n"
1073
" 'writev 512 1k 1k' - writes 2 kilobytes at 512 bytes into the open file\n"
1074 1075 1076 1077 1078
"\n"
" Writes into a segment of the currently open file, using a buffer\n"
" filled with a set pattern (0xcdcdcdcd).\n"
" -P, -- use different pattern to fill file\n"
" -C, -- report statistics in a machine parsable format\n"
1079
" -f, -- use Force Unit Access semantics\n"
1080 1081 1082 1083
" -q, -- quiet mode, do not show I/O statistics\n"
"\n");
}

M
Max Reitz 已提交
1084
static int writev_f(BlockBackend *blk, int argc, char **argv);
1085 1086 1087 1088 1089 1090

static const cmdinfo_t writev_cmd = {
    .name       = "writev",
    .cfunc      = writev_f,
    .argmin     = 2,
    .argmax     = -1,
1091
    .args       = "[-Cfq] [-P pattern] off len [len..]",
1092 1093 1094 1095
    .oneline    = "writes a number of bytes at a specified offset",
    .help       = writev_help,
};

M
Max Reitz 已提交
1096
static int writev_f(BlockBackend *blk, int argc, char **argv)
1097 1098
{
    struct timeval t1, t2;
1099
    bool Cflag = false, qflag = false;
1100
    int flags = 0;
1101 1102 1103 1104 1105 1106 1107 1108 1109
    int c, cnt;
    char *buf;
    int64_t offset;
    /* Some compilers get confused and warn if this is not initialized.  */
    int total = 0;
    int nr_iov;
    int pattern = 0xcd;
    QEMUIOVector qiov;

E
Eric Blake 已提交
1110
    while ((c = getopt(argc, argv, "CfqP:")) != -1) {
1111 1112
        switch (c) {
        case 'C':
1113
            Cflag = true;
1114
            break;
1115 1116 1117
        case 'f':
            flags |= BDRV_REQ_FUA;
            break;
1118
        case 'q':
1119
            qflag = true;
1120 1121 1122 1123 1124 1125 1126 1127
            break;
        case 'P':
            pattern = parse_pattern(optarg);
            if (pattern < 0) {
                return 0;
            }
            break;
        default:
1128
            return qemuio_command_usage(&writev_cmd);
1129 1130 1131 1132
        }
    }

    if (optind > argc - 2) {
1133
        return qemuio_command_usage(&writev_cmd);
1134 1135 1136 1137
    }

    offset = cvtnum(argv[optind]);
    if (offset < 0) {
J
John Snow 已提交
1138
        print_cvtnum_err(offset, argv[optind]);
1139 1140 1141 1142 1143
        return 0;
    }
    optind++;

    nr_iov = argc - optind;
M
Max Reitz 已提交
1144
    buf = create_iovec(blk, &qiov, &argv[optind], nr_iov, pattern);
1145 1146 1147 1148 1149
    if (buf == NULL) {
        return 0;
    }

    gettimeofday(&t1, NULL);
1150
    cnt = do_aio_writev(blk, &qiov, offset, flags, &total);
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
    gettimeofday(&t2, NULL);

    if (cnt < 0) {
        printf("writev failed: %s\n", strerror(-cnt));
        goto out;
    }

    if (qflag) {
        goto out;
    }

    /* Finally, report back -- -C gives a parsable format */
    t2 = tsub(t2, t1);
    print_report("wrote", &t2, offset, qiov.size, total, cnt, Cflag);
out:
    qemu_iovec_destroy(&qiov);
    qemu_io_free(buf);
    return 0;
}

struct aio_ctx {
M
Max Reitz 已提交
1172
    BlockBackend *blk;
1173 1174 1175
    QEMUIOVector qiov;
    int64_t offset;
    char *buf;
1176 1177 1178 1179 1180
    bool qflag;
    bool vflag;
    bool Cflag;
    bool Pflag;
    bool zflag;
1181
    BlockAcctCookie acct;
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195
    int pattern;
    struct timeval t1;
};

static void aio_write_done(void *opaque, int ret)
{
    struct aio_ctx *ctx = opaque;
    struct timeval t2;

    gettimeofday(&t2, NULL);


    if (ret < 0) {
        printf("aio_write failed: %s\n", strerror(-ret));
1196
        block_acct_failed(blk_get_stats(ctx->blk), &ctx->acct);
1197 1198 1199
        goto out;
    }

M
Max Reitz 已提交
1200
    block_acct_done(blk_get_stats(ctx->blk), &ctx->acct);
1201

1202 1203 1204 1205 1206 1207 1208 1209 1210
    if (ctx->qflag) {
        goto out;
    }

    /* Finally, report back -- -C gives a parsable format */
    t2 = tsub(t2, ctx->t1);
    print_report("wrote", &t2, ctx->offset, ctx->qiov.size,
                 ctx->qiov.size, 1, ctx->Cflag);
out:
K
Kevin Wolf 已提交
1211 1212 1213 1214
    if (!ctx->zflag) {
        qemu_io_free(ctx->buf);
        qemu_iovec_destroy(&ctx->qiov);
    }
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
    g_free(ctx);
}

static void aio_read_done(void *opaque, int ret)
{
    struct aio_ctx *ctx = opaque;
    struct timeval t2;

    gettimeofday(&t2, NULL);

    if (ret < 0) {
        printf("readv failed: %s\n", strerror(-ret));
1227
        block_acct_failed(blk_get_stats(ctx->blk), &ctx->acct);
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241
        goto out;
    }

    if (ctx->Pflag) {
        void *cmp_buf = g_malloc(ctx->qiov.size);

        memset(cmp_buf, ctx->pattern, ctx->qiov.size);
        if (memcmp(ctx->buf, cmp_buf, ctx->qiov.size)) {
            printf("Pattern verification failed at offset %"
                   PRId64 ", %zd bytes\n", ctx->offset, ctx->qiov.size);
        }
        g_free(cmp_buf);
    }

M
Max Reitz 已提交
1242
    block_acct_done(blk_get_stats(ctx->blk), &ctx->acct);
1243

1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
    if (ctx->qflag) {
        goto out;
    }

    if (ctx->vflag) {
        dump_buffer(ctx->buf, ctx->offset, ctx->qiov.size);
    }

    /* Finally, report back -- -C gives a parsable format */
    t2 = tsub(t2, ctx->t1);
    print_report("read", &t2, ctx->offset, ctx->qiov.size,
                 ctx->qiov.size, 1, ctx->Cflag);
out:
    qemu_io_free(ctx->buf);
    qemu_iovec_destroy(&ctx->qiov);
    g_free(ctx);
}

static void aio_read_help(void)
{
    printf(
"\n"
" asynchronously reads a range of bytes from the given offset\n"
"\n"
" Example:\n"
" 'aio_read -v 512 1k 1k ' - dumps 2 kilobytes read from 512 bytes into the file\n"
"\n"
" Reads a segment of the currently open file, optionally dumping it to the\n"
" standard output stream (with -v option) for subsequent inspection.\n"
" The read is performed asynchronously and the aio_flush command must be\n"
" used to ensure all outstanding aio requests have been completed.\n"
" -C, -- report statistics in a machine parsable format\n"
" -P, -- use a pattern to verify read data\n"
1277
" -i, -- treat request as invalid, for exercising stats\n"
1278 1279 1280 1281 1282
" -v, -- dump buffer to standard output\n"
" -q, -- quiet mode, do not show I/O statistics\n"
"\n");
}

M
Max Reitz 已提交
1283
static int aio_read_f(BlockBackend *blk, int argc, char **argv);
1284 1285 1286 1287 1288 1289

static const cmdinfo_t aio_read_cmd = {
    .name       = "aio_read",
    .cfunc      = aio_read_f,
    .argmin     = 2,
    .argmax     = -1,
1290
    .args       = "[-Ciqv] [-P pattern] off len [len..]",
1291 1292 1293 1294
    .oneline    = "asynchronously reads a number of bytes",
    .help       = aio_read_help,
};

M
Max Reitz 已提交
1295
static int aio_read_f(BlockBackend *blk, int argc, char **argv)
1296 1297 1298 1299
{
    int nr_iov, c;
    struct aio_ctx *ctx = g_new0(struct aio_ctx, 1);

M
Max Reitz 已提交
1300
    ctx->blk = blk;
1301
    while ((c = getopt(argc, argv, "CP:iqv")) != -1) {
1302 1303
        switch (c) {
        case 'C':
1304
            ctx->Cflag = true;
1305 1306
            break;
        case 'P':
1307
            ctx->Pflag = true;
1308 1309 1310 1311 1312 1313
            ctx->pattern = parse_pattern(optarg);
            if (ctx->pattern < 0) {
                g_free(ctx);
                return 0;
            }
            break;
1314 1315 1316 1317 1318
        case 'i':
            printf("injecting invalid read request\n");
            block_acct_invalid(blk_get_stats(blk), BLOCK_ACCT_READ);
            g_free(ctx);
            return 0;
1319
        case 'q':
1320
            ctx->qflag = true;
1321 1322
            break;
        case 'v':
1323
            ctx->vflag = true;
1324 1325 1326
            break;
        default:
            g_free(ctx);
1327
            return qemuio_command_usage(&aio_read_cmd);
1328 1329 1330 1331 1332
        }
    }

    if (optind > argc - 2) {
        g_free(ctx);
1333
        return qemuio_command_usage(&aio_read_cmd);
1334 1335 1336 1337
    }

    ctx->offset = cvtnum(argv[optind]);
    if (ctx->offset < 0) {
J
John Snow 已提交
1338
        print_cvtnum_err(ctx->offset, argv[optind]);
1339 1340 1341 1342 1343 1344
        g_free(ctx);
        return 0;
    }
    optind++;

    nr_iov = argc - optind;
M
Max Reitz 已提交
1345
    ctx->buf = create_iovec(blk, &ctx->qiov, &argv[optind], nr_iov, 0xab);
1346
    if (ctx->buf == NULL) {
1347
        block_acct_invalid(blk_get_stats(blk), BLOCK_ACCT_READ);
1348 1349 1350 1351 1352
        g_free(ctx);
        return 0;
    }

    gettimeofday(&ctx->t1, NULL);
M
Max Reitz 已提交
1353 1354
    block_acct_start(blk_get_stats(blk), &ctx->acct, ctx->qiov.size,
                     BLOCK_ACCT_READ);
1355
    blk_aio_preadv(blk, ctx->offset, &ctx->qiov, 0, aio_read_done, ctx);
1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374
    return 0;
}

static void aio_write_help(void)
{
    printf(
"\n"
" asynchronously writes a range of bytes from the given offset source\n"
" from multiple buffers\n"
"\n"
" Example:\n"
" 'aio_write 512 1k 1k' - writes 2 kilobytes at 512 bytes into the open file\n"
"\n"
" Writes into a segment of the currently open file, using a buffer\n"
" filled with a set pattern (0xcdcdcdcd).\n"
" The write is performed asynchronously and the aio_flush command must be\n"
" used to ensure all outstanding aio requests have been completed.\n"
" -P, -- use different pattern to fill file\n"
" -C, -- report statistics in a machine parsable format\n"
1375
" -f, -- use Force Unit Access semantics\n"
1376
" -i, -- treat request as invalid, for exercising stats\n"
1377
" -q, -- quiet mode, do not show I/O statistics\n"
1378
" -u, -- with -z, allow unmapping\n"
K
Kevin Wolf 已提交
1379
" -z, -- write zeroes using blk_aio_write_zeroes\n"
1380 1381 1382
"\n");
}

M
Max Reitz 已提交
1383
static int aio_write_f(BlockBackend *blk, int argc, char **argv);
1384 1385 1386 1387 1388 1389

static const cmdinfo_t aio_write_cmd = {
    .name       = "aio_write",
    .cfunc      = aio_write_f,
    .argmin     = 2,
    .argmax     = -1,
1390
    .args       = "[-Cfiquz] [-P pattern] off len [len..]",
1391 1392 1393 1394
    .oneline    = "asynchronously writes a number of bytes",
    .help       = aio_write_help,
};

M
Max Reitz 已提交
1395
static int aio_write_f(BlockBackend *blk, int argc, char **argv)
1396 1397 1398 1399
{
    int nr_iov, c;
    int pattern = 0xcd;
    struct aio_ctx *ctx = g_new0(struct aio_ctx, 1);
1400
    int flags = 0;
1401

M
Max Reitz 已提交
1402
    ctx->blk = blk;
1403
    while ((c = getopt(argc, argv, "CfiqP:uz")) != -1) {
1404 1405
        switch (c) {
        case 'C':
1406
            ctx->Cflag = true;
1407
            break;
1408 1409 1410
        case 'f':
            flags |= BDRV_REQ_FUA;
            break;
1411
        case 'q':
1412
            ctx->qflag = true;
1413
            break;
1414 1415 1416
        case 'u':
            flags |= BDRV_REQ_MAY_UNMAP;
            break;
1417 1418 1419 1420 1421 1422 1423
        case 'P':
            pattern = parse_pattern(optarg);
            if (pattern < 0) {
                g_free(ctx);
                return 0;
            }
            break;
1424 1425 1426 1427 1428
        case 'i':
            printf("injecting invalid write request\n");
            block_acct_invalid(blk_get_stats(blk), BLOCK_ACCT_WRITE);
            g_free(ctx);
            return 0;
K
Kevin Wolf 已提交
1429
        case 'z':
1430
            ctx->zflag = true;
K
Kevin Wolf 已提交
1431
            break;
1432 1433
        default:
            g_free(ctx);
1434
            return qemuio_command_usage(&aio_write_cmd);
1435 1436 1437 1438 1439
        }
    }

    if (optind > argc - 2) {
        g_free(ctx);
1440
        return qemuio_command_usage(&aio_write_cmd);
1441 1442
    }

K
Kevin Wolf 已提交
1443 1444 1445 1446 1447 1448
    if (ctx->zflag && optind != argc - 2) {
        printf("-z supports only a single length parameter\n");
        g_free(ctx);
        return 0;
    }

1449 1450
    if ((flags & BDRV_REQ_MAY_UNMAP) && !ctx->zflag) {
        printf("-u requires -z to be specified\n");
E
Eric Blake 已提交
1451
        g_free(ctx);
1452 1453 1454
        return 0;
    }

K
Kevin Wolf 已提交
1455 1456 1457 1458 1459 1460
    if (ctx->zflag && ctx->Pflag) {
        printf("-z and -P cannot be specified at the same time\n");
        g_free(ctx);
        return 0;
    }

1461 1462
    ctx->offset = cvtnum(argv[optind]);
    if (ctx->offset < 0) {
J
John Snow 已提交
1463
        print_cvtnum_err(ctx->offset, argv[optind]);
1464 1465 1466 1467 1468
        g_free(ctx);
        return 0;
    }
    optind++;

K
Kevin Wolf 已提交
1469 1470 1471 1472
    if (ctx->zflag) {
        int64_t count = cvtnum(argv[optind]);
        if (count < 0) {
            print_cvtnum_err(count, argv[optind]);
1473
            g_free(ctx);
K
Kevin Wolf 已提交
1474 1475
            return 0;
        }
1476

K
Kevin Wolf 已提交
1477
        ctx->qiov.size = count;
1478 1479
        blk_aio_write_zeroes(blk, ctx->offset, count, flags, aio_write_done,
                             ctx);
K
Kevin Wolf 已提交
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
    } else {
        nr_iov = argc - optind;
        ctx->buf = create_iovec(blk, &ctx->qiov, &argv[optind], nr_iov,
                                pattern);
        if (ctx->buf == NULL) {
            block_acct_invalid(blk_get_stats(blk), BLOCK_ACCT_WRITE);
            g_free(ctx);
            return 0;
        }

        gettimeofday(&ctx->t1, NULL);
        block_acct_start(blk_get_stats(blk), &ctx->acct, ctx->qiov.size,
                         BLOCK_ACCT_WRITE);

1494 1495
        blk_aio_pwritev(blk, ctx->offset, &ctx->qiov, flags, aio_write_done,
                        ctx);
K
Kevin Wolf 已提交
1496
    }
1497 1498 1499
    return 0;
}

M
Max Reitz 已提交
1500
static int aio_flush_f(BlockBackend *blk, int argc, char **argv)
1501
{
1502 1503
    BlockAcctCookie cookie;
    block_acct_start(blk_get_stats(blk), &cookie, 0, BLOCK_ACCT_FLUSH);
M
Max Reitz 已提交
1504
    blk_drain_all();
1505
    block_acct_done(blk_get_stats(blk), &cookie);
1506 1507 1508 1509 1510 1511 1512 1513 1514
    return 0;
}

static const cmdinfo_t aio_flush_cmd = {
    .name       = "aio_flush",
    .cfunc      = aio_flush_f,
    .oneline    = "completes all outstanding aio requests"
};

M
Max Reitz 已提交
1515
static int flush_f(BlockBackend *blk, int argc, char **argv)
1516
{
M
Max Reitz 已提交
1517
    blk_flush(blk);
1518 1519 1520 1521 1522 1523 1524 1525 1526 1527
    return 0;
}

static const cmdinfo_t flush_cmd = {
    .name       = "flush",
    .altname    = "f",
    .cfunc      = flush_f,
    .oneline    = "flush all in-core file state to disk",
};

M
Max Reitz 已提交
1528
static int truncate_f(BlockBackend *blk, int argc, char **argv)
1529 1530 1531 1532 1533 1534
{
    int64_t offset;
    int ret;

    offset = cvtnum(argv[1]);
    if (offset < 0) {
J
John Snow 已提交
1535
        print_cvtnum_err(offset, argv[1]);
1536 1537 1538
        return 0;
    }

M
Max Reitz 已提交
1539
    ret = blk_truncate(blk, offset);
1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557
    if (ret < 0) {
        printf("truncate: %s\n", strerror(-ret));
        return 0;
    }

    return 0;
}

static const cmdinfo_t truncate_cmd = {
    .name       = "truncate",
    .altname    = "t",
    .cfunc      = truncate_f,
    .argmin     = 1,
    .argmax     = 1,
    .args       = "off",
    .oneline    = "truncates the current file at the given offset",
};

M
Max Reitz 已提交
1558
static int length_f(BlockBackend *blk, int argc, char **argv)
1559 1560 1561 1562
{
    int64_t size;
    char s1[64];

M
Max Reitz 已提交
1563
    size = blk_getlength(blk);
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
    if (size < 0) {
        printf("getlength: %s\n", strerror(-size));
        return 0;
    }

    cvtstr(size, s1, sizeof(s1));
    printf("%s\n", s1);
    return 0;
}


static const cmdinfo_t length_cmd = {
    .name   = "length",
    .altname    = "l",
    .cfunc      = length_f,
    .oneline    = "gets the length of the current file",
};


M
Max Reitz 已提交
1583
static int info_f(BlockBackend *blk, int argc, char **argv)
1584
{
M
Max Reitz 已提交
1585
    BlockDriverState *bs = blk_bs(blk);
1586
    BlockDriverInfo bdi;
1587
    ImageInfoSpecific *spec_info;
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608
    char s1[64], s2[64];
    int ret;

    if (bs->drv && bs->drv->format_name) {
        printf("format name: %s\n", bs->drv->format_name);
    }
    if (bs->drv && bs->drv->protocol_name) {
        printf("format name: %s\n", bs->drv->protocol_name);
    }

    ret = bdrv_get_info(bs, &bdi);
    if (ret) {
        return 0;
    }

    cvtstr(bdi.cluster_size, s1, sizeof(s1));
    cvtstr(bdi.vm_state_offset, s2, sizeof(s2));

    printf("cluster size: %s\n", s1);
    printf("vm state offset: %s\n", s2);

1609 1610 1611 1612 1613 1614 1615
    spec_info = bdrv_get_specific_info(bs);
    if (spec_info) {
        printf("Format specific information:\n");
        bdrv_image_info_specific_dump(fprintf, stdout, spec_info);
        qapi_free_ImageInfoSpecific(spec_info);
    }

1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642
    return 0;
}



static const cmdinfo_t info_cmd = {
    .name       = "info",
    .altname    = "i",
    .cfunc      = info_f,
    .oneline    = "prints information about the current file",
};

static void discard_help(void)
{
    printf(
"\n"
" discards a range of bytes from the given offset\n"
"\n"
" Example:\n"
" 'discard 512 1k' - discards 1 kilobyte from 512 bytes into the file\n"
"\n"
" Discards a segment of the currently open file.\n"
" -C, -- report statistics in a machine parsable format\n"
" -q, -- quiet mode, do not show I/O statistics\n"
"\n");
}

M
Max Reitz 已提交
1643
static int discard_f(BlockBackend *blk, int argc, char **argv);
1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655

static const cmdinfo_t discard_cmd = {
    .name       = "discard",
    .altname    = "d",
    .cfunc      = discard_f,
    .argmin     = 2,
    .argmax     = -1,
    .args       = "[-Cq] off len",
    .oneline    = "discards a number of bytes at a specified offset",
    .help       = discard_help,
};

M
Max Reitz 已提交
1656
static int discard_f(BlockBackend *blk, int argc, char **argv)
1657 1658
{
    struct timeval t1, t2;
1659
    bool Cflag = false, qflag = false;
1660
    int c, ret;
J
John Snow 已提交
1661
    int64_t offset, count;
1662

E
Eric Blake 已提交
1663
    while ((c = getopt(argc, argv, "Cq")) != -1) {
1664 1665
        switch (c) {
        case 'C':
1666
            Cflag = true;
1667 1668
            break;
        case 'q':
1669
            qflag = true;
1670 1671
            break;
        default:
1672
            return qemuio_command_usage(&discard_cmd);
1673 1674 1675 1676
        }
    }

    if (optind != argc - 2) {
1677
        return qemuio_command_usage(&discard_cmd);
1678 1679 1680 1681
    }

    offset = cvtnum(argv[optind]);
    if (offset < 0) {
J
John Snow 已提交
1682
        print_cvtnum_err(offset, argv[optind]);
1683 1684 1685 1686 1687 1688
        return 0;
    }

    optind++;
    count = cvtnum(argv[optind]);
    if (count < 0) {
J
John Snow 已提交
1689
        print_cvtnum_err(count, argv[optind]);
1690
        return 0;
J
John Snow 已提交
1691 1692 1693 1694 1695
    } else if (count >> BDRV_SECTOR_BITS > INT_MAX) {
        printf("length cannot exceed %"PRIu64", given %s\n",
               (uint64_t)INT_MAX << BDRV_SECTOR_BITS,
               argv[optind]);
        return 0;
1696 1697 1698
    }

    gettimeofday(&t1, NULL);
M
Max Reitz 已提交
1699 1700
    ret = blk_discard(blk, offset >> BDRV_SECTOR_BITS,
                      count >> BDRV_SECTOR_BITS);
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717
    gettimeofday(&t2, NULL);

    if (ret < 0) {
        printf("discard failed: %s\n", strerror(-ret));
        goto out;
    }

    /* Finally, report back -- -C gives a parsable format */
    if (!qflag) {
        t2 = tsub(t2, t1);
        print_report("discard", &t2, offset, count, count, 1, Cflag);
    }

out:
    return 0;
}

M
Max Reitz 已提交
1718
static int alloc_f(BlockBackend *blk, int argc, char **argv)
1719
{
M
Max Reitz 已提交
1720
    BlockDriverState *bs = blk_bs(blk);
J
John Snow 已提交
1721
    int64_t offset, sector_num, nb_sectors, remaining;
1722
    char s1[64];
J
John Snow 已提交
1723 1724
    int num, ret;
    int64_t sum_alloc;
1725 1726 1727

    offset = cvtnum(argv[1]);
    if (offset < 0) {
J
John Snow 已提交
1728
        print_cvtnum_err(offset, argv[1]);
1729 1730 1731 1732 1733 1734 1735 1736 1737 1738
        return 0;
    } else if (offset & 0x1ff) {
        printf("offset %" PRId64 " is not sector aligned\n",
               offset);
        return 0;
    }

    if (argc == 3) {
        nb_sectors = cvtnum(argv[2]);
        if (nb_sectors < 0) {
J
John Snow 已提交
1739
            print_cvtnum_err(nb_sectors, argv[2]);
1740
            return 0;
J
John Snow 已提交
1741 1742 1743 1744
        } else if (nb_sectors > INT_MAX) {
            printf("length argument cannot exceed %d, given %s\n",
                   INT_MAX, argv[2]);
            return 0;
1745 1746 1747 1748 1749 1750 1751 1752 1753 1754
        }
    } else {
        nb_sectors = 1;
    }

    remaining = nb_sectors;
    sum_alloc = 0;
    sector_num = offset >> 9;
    while (remaining) {
        ret = bdrv_is_allocated(bs, sector_num, remaining, &num);
1755 1756 1757 1758
        if (ret < 0) {
            printf("is_allocated failed: %s\n", strerror(-ret));
            return 0;
        }
1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771
        sector_num += num;
        remaining -= num;
        if (ret) {
            sum_alloc += num;
        }
        if (num == 0) {
            nb_sectors -= remaining;
            remaining = 0;
        }
    }

    cvtstr(offset, s1, sizeof(s1));

J
John Snow 已提交
1772
    printf("%"PRId64"/%"PRId64" sectors allocated at offset %s\n",
1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808
           sum_alloc, nb_sectors, s1);
    return 0;
}

static const cmdinfo_t alloc_cmd = {
    .name       = "alloc",
    .altname    = "a",
    .argmin     = 1,
    .argmax     = 2,
    .cfunc      = alloc_f,
    .args       = "off [sectors]",
    .oneline    = "checks if a sector is present in the file",
};


static int map_is_allocated(BlockDriverState *bs, int64_t sector_num,
                            int64_t nb_sectors, int64_t *pnum)
{
    int num, num_checked;
    int ret, firstret;

    num_checked = MIN(nb_sectors, INT_MAX);
    ret = bdrv_is_allocated(bs, sector_num, num_checked, &num);
    if (ret < 0) {
        return ret;
    }

    firstret = ret;
    *pnum = num;

    while (nb_sectors > 0 && ret == firstret) {
        sector_num += num;
        nb_sectors -= num;

        num_checked = MIN(nb_sectors, INT_MAX);
        ret = bdrv_is_allocated(bs, sector_num, num_checked, &num);
1809
        if (ret == firstret && num) {
1810 1811 1812 1813 1814 1815 1816 1817 1818
            *pnum += num;
        } else {
            break;
        }
    }

    return firstret;
}

M
Max Reitz 已提交
1819
static int map_f(BlockBackend *blk, int argc, char **argv)
1820 1821
{
    int64_t offset;
M
Max Reitz 已提交
1822
    int64_t nb_sectors, total_sectors;
1823 1824 1825 1826 1827 1828
    char s1[64];
    int64_t num;
    int ret;
    const char *retstr;

    offset = 0;
M
Max Reitz 已提交
1829 1830 1831 1832 1833 1834 1835 1836
    total_sectors = blk_nb_sectors(blk);
    if (total_sectors < 0) {
        error_report("Failed to query image length: %s",
                     strerror(-total_sectors));
        return 0;
    }

    nb_sectors = total_sectors;
1837 1838

    do {
M
Max Reitz 已提交
1839
        ret = map_is_allocated(blk_bs(blk), offset, nb_sectors, &num);
1840 1841 1842
        if (ret < 0) {
            error_report("Failed to get allocation status: %s", strerror(-ret));
            return 0;
1843 1844 1845
        } else if (!num) {
            error_report("Unexpected end of image");
            return 0;
1846 1847 1848 1849 1850 1851 1852 1853 1854 1855
        }

        retstr = ret ? "    allocated" : "not allocated";
        cvtstr(offset << 9ULL, s1, sizeof(s1));
        printf("[% 24" PRId64 "] % 8" PRId64 "/% 8" PRId64 " sectors %s "
               "at offset %s (%d)\n",
               offset << 9ULL, num, nb_sectors, retstr, s1, ret);

        offset += num;
        nb_sectors -= num;
M
Max Reitz 已提交
1856
    } while (offset < total_sectors);
1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869

    return 0;
}

static const cmdinfo_t map_cmd = {
       .name           = "map",
       .argmin         = 0,
       .argmax         = 0,
       .cfunc          = map_f,
       .args           = "",
       .oneline        = "prints the allocated areas of a file",
};

K
Kevin Wolf 已提交
1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913
static void reopen_help(void)
{
    printf(
"\n"
" Changes the open options of an already opened image\n"
"\n"
" Example:\n"
" 'reopen -o lazy-refcounts=on' - activates lazy refcount writeback on a qcow2 image\n"
"\n"
" -r, -- Reopen the image read-only\n"
" -c, -- Change the cache mode to the given value\n"
" -o, -- Changes block driver options (cf. 'open' command)\n"
"\n");
}

static int reopen_f(BlockBackend *blk, int argc, char **argv);

static QemuOptsList reopen_opts = {
    .name = "reopen",
    .merge_lists = true,
    .head = QTAILQ_HEAD_INITIALIZER(reopen_opts.head),
    .desc = {
        /* no elements => accept any params */
        { /* end of list */ }
    },
};

static const cmdinfo_t reopen_cmd = {
       .name           = "reopen",
       .argmin         = 0,
       .argmax         = -1,
       .cfunc          = reopen_f,
       .args           = "[-r] [-c cache] [-o options]",
       .oneline        = "reopens an image with new options",
       .help           = reopen_help,
};

static int reopen_f(BlockBackend *blk, int argc, char **argv)
{
    BlockDriverState *bs = blk_bs(blk);
    QemuOpts *qopts;
    QDict *opts;
    int c;
    int flags = bs->open_flags;
1914
    bool writethrough = !blk_enable_write_cache(blk);
K
Kevin Wolf 已提交
1915 1916 1917 1918 1919 1920 1921

    BlockReopenQueue *brq;
    Error *local_err = NULL;

    while ((c = getopt(argc, argv, "c:o:r")) != -1) {
        switch (c) {
        case 'c':
1922
            if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) < 0) {
K
Kevin Wolf 已提交
1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946
                error_report("Invalid cache option: %s", optarg);
                return 0;
            }
            break;
        case 'o':
            if (!qemu_opts_parse_noisily(&reopen_opts, optarg, 0)) {
                qemu_opts_reset(&reopen_opts);
                return 0;
            }
            break;
        case 'r':
            flags &= ~BDRV_O_RDWR;
            break;
        default:
            qemu_opts_reset(&reopen_opts);
            return qemuio_command_usage(&reopen_cmd);
        }
    }

    if (optind != argc) {
        qemu_opts_reset(&reopen_opts);
        return qemuio_command_usage(&reopen_cmd);
    }

1947 1948 1949 1950 1951 1952 1953 1954
    if (writethrough != blk_enable_write_cache(blk) &&
        blk_get_attached_dev(blk))
    {
        error_report("Cannot change cache.writeback: Device attached");
        qemu_opts_reset(&reopen_opts);
        return 0;
    }

K
Kevin Wolf 已提交
1955 1956 1957 1958 1959 1960 1961 1962
    qopts = qemu_opts_find(&reopen_opts, NULL);
    opts = qopts ? qemu_opts_to_qdict(qopts, NULL) : NULL;
    qemu_opts_reset(&reopen_opts);

    brq = bdrv_reopen_queue(NULL, bs, opts, flags);
    bdrv_reopen_multiple(brq, &local_err);
    if (local_err) {
        error_report_err(local_err);
1963 1964
    } else {
        blk_set_enable_write_cache(blk, !writethrough);
K
Kevin Wolf 已提交
1965 1966 1967 1968 1969
    }

    return 0;
}

M
Max Reitz 已提交
1970
static int break_f(BlockBackend *blk, int argc, char **argv)
1971 1972 1973
{
    int ret;

M
Max Reitz 已提交
1974
    ret = bdrv_debug_breakpoint(blk_bs(blk), argv[1], argv[2]);
1975 1976 1977 1978 1979 1980 1981
    if (ret < 0) {
        printf("Could not set breakpoint: %s\n", strerror(-ret));
    }

    return 0;
}

M
Max Reitz 已提交
1982
static int remove_break_f(BlockBackend *blk, int argc, char **argv)
F
Fam Zheng 已提交
1983 1984 1985
{
    int ret;

M
Max Reitz 已提交
1986
    ret = bdrv_debug_remove_breakpoint(blk_bs(blk), argv[1]);
F
Fam Zheng 已提交
1987 1988 1989 1990 1991 1992 1993
    if (ret < 0) {
        printf("Could not remove breakpoint %s: %s\n", argv[1], strerror(-ret));
    }

    return 0;
}

1994 1995 1996 1997 1998 1999 2000 2001 2002 2003
static const cmdinfo_t break_cmd = {
       .name           = "break",
       .argmin         = 2,
       .argmax         = 2,
       .cfunc          = break_f,
       .args           = "event tag",
       .oneline        = "sets a breakpoint on event and tags the stopped "
                         "request as tag",
};

F
Fam Zheng 已提交
2004 2005 2006 2007 2008 2009 2010 2011 2012
static const cmdinfo_t remove_break_cmd = {
       .name           = "remove_break",
       .argmin         = 1,
       .argmax         = 1,
       .cfunc          = remove_break_f,
       .args           = "tag",
       .oneline        = "remove a breakpoint by tag",
};

M
Max Reitz 已提交
2013
static int resume_f(BlockBackend *blk, int argc, char **argv)
2014 2015 2016
{
    int ret;

M
Max Reitz 已提交
2017
    ret = bdrv_debug_resume(blk_bs(blk), argv[1]);
2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033
    if (ret < 0) {
        printf("Could not resume request: %s\n", strerror(-ret));
    }

    return 0;
}

static const cmdinfo_t resume_cmd = {
       .name           = "resume",
       .argmin         = 1,
       .argmax         = 1,
       .cfunc          = resume_f,
       .args           = "tag",
       .oneline        = "resumes the request tagged as tag",
};

M
Max Reitz 已提交
2034
static int wait_break_f(BlockBackend *blk, int argc, char **argv)
2035
{
M
Max Reitz 已提交
2036 2037
    while (!bdrv_debug_is_suspended(blk_bs(blk), argv[1])) {
        aio_poll(blk_get_aio_context(blk), true);
2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051
    }

    return 0;
}

static const cmdinfo_t wait_break_cmd = {
       .name           = "wait_break",
       .argmin         = 1,
       .argmax         = 1,
       .cfunc          = wait_break_f,
       .args           = "tag",
       .oneline        = "waits for the suspension of a request",
};

M
Max Reitz 已提交
2052
static int abort_f(BlockBackend *blk, int argc, char **argv)
2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063
{
    abort();
}

static const cmdinfo_t abort_cmd = {
       .name           = "abort",
       .cfunc          = abort_f,
       .flags          = CMD_NOFILE_OK,
       .oneline        = "simulate a program crash using abort(3)",
};

M
Max Reitz 已提交
2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077
static void sigraise_help(void)
{
    printf(
"\n"
" raises the given signal\n"
"\n"
" Example:\n"
" 'sigraise %i' - raises SIGTERM\n"
"\n"
" Invokes raise(signal), where \"signal\" is the mandatory integer argument\n"
" given to sigraise.\n"
"\n", SIGTERM);
}

M
Max Reitz 已提交
2078
static int sigraise_f(BlockBackend *blk, int argc, char **argv);
M
Max Reitz 已提交
2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090

static const cmdinfo_t sigraise_cmd = {
    .name       = "sigraise",
    .cfunc      = sigraise_f,
    .argmin     = 1,
    .argmax     = 1,
    .flags      = CMD_NOFILE_OK,
    .args       = "signal",
    .oneline    = "raises a signal",
    .help       = sigraise_help,
};

M
Max Reitz 已提交
2091
static int sigraise_f(BlockBackend *blk, int argc, char **argv)
M
Max Reitz 已提交
2092
{
J
John Snow 已提交
2093
    int64_t sig = cvtnum(argv[1]);
M
Max Reitz 已提交
2094
    if (sig < 0) {
J
John Snow 已提交
2095
        print_cvtnum_err(sig, argv[1]);
M
Max Reitz 已提交
2096
        return 0;
J
John Snow 已提交
2097 2098 2099 2100
    } else if (sig > NSIG) {
        printf("signal argument '%s' is too large to be a valid signal\n",
               argv[1]);
        return 0;
M
Max Reitz 已提交
2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112
    }

    /* Using raise() to kill this process does not necessarily flush all open
     * streams. At least stdout and stderr (although the latter should be
     * non-buffered anyway) should be flushed, though. */
    fflush(stdout);
    fflush(stderr);

    raise(sig);
    return 0;
}

K
Kevin Wolf 已提交
2113 2114 2115 2116 2117 2118
static void sleep_cb(void *opaque)
{
    bool *expired = opaque;
    *expired = true;
}

M
Max Reitz 已提交
2119
static int sleep_f(BlockBackend *blk, int argc, char **argv)
K
Kevin Wolf 已提交
2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152
{
    char *endptr;
    long ms;
    struct QEMUTimer *timer;
    bool expired = false;

    ms = strtol(argv[1], &endptr, 0);
    if (ms < 0 || *endptr != '\0') {
        printf("%s is not a valid number\n", argv[1]);
        return 0;
    }

    timer = timer_new_ns(QEMU_CLOCK_HOST, sleep_cb, &expired);
    timer_mod(timer, qemu_clock_get_ns(QEMU_CLOCK_HOST) + SCALE_MS * ms);

    while (!expired) {
        main_loop_wait(false);
    }

    timer_free(timer);

    return 0;
}

static const cmdinfo_t sleep_cmd = {
       .name           = "sleep",
       .argmin         = 1,
       .argmax         = 1,
       .cfunc          = sleep_f,
       .flags          = CMD_NOFILE_OK,
       .oneline        = "waits for the given value in milliseconds",
};

K
Kevin Wolf 已提交
2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187
static void help_oneline(const char *cmd, const cmdinfo_t *ct)
{
    if (cmd) {
        printf("%s ", cmd);
    } else {
        printf("%s ", ct->name);
        if (ct->altname) {
            printf("(or %s) ", ct->altname);
        }
    }

    if (ct->args) {
        printf("%s ", ct->args);
    }
    printf("-- %s\n", ct->oneline);
}

static void help_onecmd(const char *cmd, const cmdinfo_t *ct)
{
    help_oneline(cmd, ct);
    if (ct->help) {
        ct->help();
    }
}

static void help_all(void)
{
    const cmdinfo_t *ct;

    for (ct = cmdtab; ct < &cmdtab[ncmds]; ct++) {
        help_oneline(ct->name, ct);
    }
    printf("\nUse 'help commandname' for extended help.\n");
}

M
Max Reitz 已提交
2188
static int help_f(BlockBackend *blk, int argc, char **argv)
K
Kevin Wolf 已提交
2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217
{
    const cmdinfo_t *ct;

    if (argc == 1) {
        help_all();
        return 0;
    }

    ct = find_command(argv[1]);
    if (ct == NULL) {
        printf("command %s not found\n", argv[1]);
        return 0;
    }

    help_onecmd(argv[1], ct);
    return 0;
}

static const cmdinfo_t help_cmd = {
    .name       = "help",
    .altname    = "?",
    .cfunc      = help_f,
    .argmin     = 0,
    .argmax     = 1,
    .flags      = CMD_FLAG_GLOBAL,
    .args       = "[command]",
    .oneline    = "help for one or all commands",
};

M
Max Reitz 已提交
2218
bool qemuio_command(BlockBackend *blk, const char *cmd)
K
Kevin Wolf 已提交
2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230
{
    char *input;
    const cmdinfo_t *ct;
    char **v;
    int c;
    bool done = false;

    input = g_strdup(cmd);
    v = breakline(input, &c);
    if (c) {
        ct = find_command(v[0]);
        if (ct) {
M
Max Reitz 已提交
2231
            done = command(blk, ct, c, v);
K
Kevin Wolf 已提交
2232 2233 2234 2235 2236 2237 2238 2239 2240 2241
        } else {
            fprintf(stderr, "command \"%s\" not found\n", v[0]);
        }
    }
    g_free(input);
    g_free(v);

    return done;
}

2242 2243 2244
static void __attribute((constructor)) init_qemuio_commands(void)
{
    /* initialize commands */
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259
    qemuio_add_command(&help_cmd);
    qemuio_add_command(&read_cmd);
    qemuio_add_command(&readv_cmd);
    qemuio_add_command(&write_cmd);
    qemuio_add_command(&writev_cmd);
    qemuio_add_command(&aio_read_cmd);
    qemuio_add_command(&aio_write_cmd);
    qemuio_add_command(&aio_flush_cmd);
    qemuio_add_command(&flush_cmd);
    qemuio_add_command(&truncate_cmd);
    qemuio_add_command(&length_cmd);
    qemuio_add_command(&info_cmd);
    qemuio_add_command(&discard_cmd);
    qemuio_add_command(&alloc_cmd);
    qemuio_add_command(&map_cmd);
K
Kevin Wolf 已提交
2260
    qemuio_add_command(&reopen_cmd);
2261
    qemuio_add_command(&break_cmd);
F
Fam Zheng 已提交
2262
    qemuio_add_command(&remove_break_cmd);
2263 2264 2265
    qemuio_add_command(&resume_cmd);
    qemuio_add_command(&wait_break_cmd);
    qemuio_add_command(&abort_cmd);
K
Kevin Wolf 已提交
2266
    qemuio_add_command(&sleep_cmd);
M
Max Reitz 已提交
2267
    qemuio_add_command(&sigraise_cmd);
2268
}