qemu-io-cmds.c 57.3 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 "qemu/cutils.h"
22 23 24

#define CMD_NOFILE_OK   0x01

25
bool qemuio_misalign;
26

27 28 29 30 31 32 33 34 35 36 37
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)
{
38
    cmdtab = g_renew(cmdinfo_t, cmdtab, ++ncmds);
39 40 41 42 43 44 45 46 47 48
    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 已提交
49
static int init_check_command(BlockBackend *blk, const cmdinfo_t *ct)
50 51 52 53
{
    if (ct->flags & CMD_FLAG_GLOBAL) {
        return 1;
    }
M
Max Reitz 已提交
54
    if (!(ct->flags & CMD_NOFILE_OK) && !blk) {
55 56 57 58 59 60
        fprintf(stderr, "no file open, try 'help open'\n");
        return 0;
    }
    return 1;
}

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

M
Max Reitz 已提交
66
    if (!init_check_command(blk, ct)) {
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
        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 已提交
87
    return ct->cfunc(blk, argc, argv);
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
}

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;
}

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
/* 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);
        }
    }
}

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

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

138 139 140
static int64_t cvtnum(const char *s)
{
    char *end;
J
John Snow 已提交
141 142
    int64_t ret;

143
    ret = qemu_strtosz(s, &end);
J
John Snow 已提交
144 145 146 147 148
    if (*end != '\0') {
        /* Detritus at the end of the string */
        return -EINVAL;
    }
    return ret;
149 150
}

J
John Snow 已提交
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
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);
    }
}

166 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
#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));
    }
}

270 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
/*
 * 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 已提交
298
static void *qemu_io_alloc(BlockBackend *blk, size_t len, int pattern)
299 300 301 302 303 304
{
    void *buf;

    if (qemuio_misalign) {
        len += MISALIGN_OFFSET;
    }
M
Max Reitz 已提交
305
    buf = blk_blockalign(blk, len);
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
    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 已提交
321
static void dump_buffer(const void *buffer, int64_t offset, int64_t len)
322
{
J
John Snow 已提交
323 324
    uint64_t i;
    int j;
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
    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,
347
                         int64_t count, int64_t total, int cnt, bool Cflag)
348 349 350 351 352 353 354
{
    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 已提交
355
        printf("%s %"PRId64"/%"PRId64" bytes at offset %" PRId64 "\n",
356 357 358 359
               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 已提交
360
        printf("%"PRId64",%d,%s,%.3f,%.3f\n",
361 362 363 364 365 366 367 368 369 370 371
            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 已提交
372
create_iovec(BlockBackend *blk, QEMUIOVector *qiov, char **argv, int nr_iov,
373 374 375 376 377 378 379 380 381 382 383 384 385 386
             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 已提交
387
            print_cvtnum_err(len, arg);
388 389 390
            goto fail;
        }

391 392 393 394 395 396 397 398 399
        if (len > BDRV_REQUEST_MAX_BYTES) {
            printf("Argument '%s' exceeds maximum size %" PRIu64 "\n", arg,
                   (uint64_t)BDRV_REQUEST_MAX_BYTES);
            goto fail;
        }

        if (count > BDRV_REQUEST_MAX_BYTES - len) {
            printf("The total number of bytes exceed the maximum size %" PRIu64
                   "\n", (uint64_t)BDRV_REQUEST_MAX_BYTES);
400 401 402 403 404 405 406 407 408
            goto fail;
        }

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

    qemu_iovec_init(qiov, nr_iov);

M
Max Reitz 已提交
409
    buf = p = qemu_io_alloc(blk, count, pattern);
410 411 412 413 414 415 416 417 418 419 420

    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 已提交
421 422
static int do_pread(BlockBackend *blk, char *buf, int64_t offset,
                    int64_t count, int64_t *total)
423
{
J
John Snow 已提交
424 425 426 427
    if (count > INT_MAX) {
        return -ERANGE;
    }

M
Max Reitz 已提交
428
    *total = blk_pread(blk, offset, (uint8_t *)buf, count);
429 430 431 432 433 434
    if (*total < 0) {
        return *total;
    }
    return 1;
}

J
John Snow 已提交
435
static int do_pwrite(BlockBackend *blk, char *buf, int64_t offset,
436
                     int64_t count, int flags, int64_t *total)
437
{
J
John Snow 已提交
438 439 440 441
    if (count > INT_MAX) {
        return -ERANGE;
    }

442
    *total = blk_pwrite(blk, offset, (uint8_t *)buf, count, flags);
443 444 445 446 447 448 449
    if (*total < 0) {
        return *total;
    }
    return 1;
}

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

E
Eric Blake 已提交
459
static void coroutine_fn co_pwrite_zeroes_entry(void *opaque)
460 461 462
{
    CoWriteZeroes *data = opaque;

E
Eric Blake 已提交
463 464
    data->ret = blk_co_pwrite_zeroes(data->blk, data->offset, data->count,
                                     data->flags);
465 466 467 468 469 470 471 472 473
    data->done = true;
    if (data->ret < 0) {
        *data->total = data->ret;
        return;
    }

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

E
Eric Blake 已提交
474 475
static int do_co_pwrite_zeroes(BlockBackend *blk, int64_t offset,
                               int64_t count, int flags, int64_t *total)
476 477 478
{
    Coroutine *co;
    CoWriteZeroes data = {
M
Max Reitz 已提交
479
        .blk    = blk,
480 481 482
        .offset = offset,
        .count  = count,
        .total  = total,
483
        .flags  = flags,
484 485 486
        .done   = false,
    };

487
    if (count > INT_MAX) {
J
John Snow 已提交
488 489 490
        return -ERANGE;
    }

491 492
    co = qemu_coroutine_create(co_pwrite_zeroes_entry, &data);
    qemu_coroutine_enter(co);
493
    while (!data.done) {
M
Max Reitz 已提交
494
        aio_poll(blk_get_aio_context(blk), true);
495 496 497 498 499 500 501 502
    }
    if (data.ret < 0) {
        return data.ret;
    } else {
        return 1;
    }
}

M
Max Reitz 已提交
503
static int do_write_compressed(BlockBackend *blk, char *buf, int64_t offset,
J
John Snow 已提交
504
                               int64_t count, int64_t *total)
505 506 507
{
    int ret;

508
    if (count >> 9 > BDRV_REQUEST_MAX_SECTORS) {
J
John Snow 已提交
509 510 511
        return -ERANGE;
    }

512
    ret = blk_pwrite_compressed(blk, offset, buf, count);
513 514 515 516 517 518 519
    if (ret < 0) {
        return ret;
    }
    *total = count;
    return 1;
}

M
Max Reitz 已提交
520
static int do_load_vmstate(BlockBackend *blk, char *buf, int64_t offset,
J
John Snow 已提交
521
                           int64_t count, int64_t *total)
522
{
J
John Snow 已提交
523 524 525 526
    if (count > INT_MAX) {
        return -ERANGE;
    }

M
Max Reitz 已提交
527
    *total = blk_load_vmstate(blk, (uint8_t *)buf, offset, count);
528 529 530 531 532 533
    if (*total < 0) {
        return *total;
    }
    return 1;
}

M
Max Reitz 已提交
534
static int do_save_vmstate(BlockBackend *blk, char *buf, int64_t offset,
J
John Snow 已提交
535
                           int64_t count, int64_t *total)
536
{
J
John Snow 已提交
537 538 539 540
    if (count > INT_MAX) {
        return -ERANGE;
    }

M
Max Reitz 已提交
541
    *total = blk_save_vmstate(blk, (uint8_t *)buf, offset, count);
542 543 544 545 546 547 548 549 550 551 552 553
    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 已提交
554
static int do_aio_readv(BlockBackend *blk, QEMUIOVector *qiov,
555 556 557 558
                        int64_t offset, int *total)
{
    int async_ret = NOT_DONE;

559
    blk_aio_preadv(blk, offset, qiov, 0, aio_rw_done, &async_ret);
560 561 562 563 564 565 566 567
    while (async_ret == NOT_DONE) {
        main_loop_wait(false);
    }

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

M
Max Reitz 已提交
568
static int do_aio_writev(BlockBackend *blk, QEMUIOVector *qiov,
569
                         int64_t offset, int flags, int *total)
570 571 572
{
    int async_ret = NOT_DONE;

573
    blk_aio_pwritev(blk, offset, qiov, flags, aio_rw_done, &async_ret);
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
    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"
596
" -p, -- ignored for backwards compatibility\n"
597 598 599 600 601 602 603
" -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 已提交
604
static int read_f(BlockBackend *blk, int argc, char **argv);
605 606 607 608 609 610 611

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

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

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

    if (optind != argc - 2) {
677
        return qemuio_command_usage(&read_cmd);
678 679 680 681
    }

    offset = cvtnum(argv[optind]);
    if (offset < 0) {
J
John Snow 已提交
682
        print_cvtnum_err(offset, argv[optind]);
683 684 685 686 687 688
        return 0;
    }

    optind++;
    count = cvtnum(argv[optind]);
    if (count < 0) {
J
John Snow 已提交
689
        print_cvtnum_err(count, argv[optind]);
690
        return 0;
691
    } else if (count > BDRV_REQUEST_MAX_BYTES) {
J
John Snow 已提交
692
        printf("length cannot exceed %" PRIu64 ", given %s\n",
693
               (uint64_t)BDRV_REQUEST_MAX_BYTES, argv[optind]);
J
John Snow 已提交
694
        return 0;
695 696 697
    }

    if (!Pflag && (lflag || sflag)) {
698
        return qemuio_command_usage(&read_cmd);
699 700 701 702 703 704 705 706 707 708 709
    }

    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;
    }

710
    if (bflag) {
711 712 713 714 715 716
        if (offset & 0x1ff) {
            printf("offset %" PRId64 " is not sector aligned\n",
                   offset);
            return 0;
        }
        if (count & 0x1ff) {
J
John Snow 已提交
717
            printf("count %"PRId64" is not sector aligned\n",
718 719 720 721 722
                   count);
            return 0;
        }
    }

M
Max Reitz 已提交
723
    buf = qemu_io_alloc(blk, count, 0xab);
724 725

    gettimeofday(&t1, NULL);
726
    if (bflag) {
M
Max Reitz 已提交
727
        cnt = do_load_vmstate(blk, buf, offset, count, &total);
728
    } else {
729
        cnt = do_pread(blk, buf, offset, count, &total);
730 731 732 733 734 735 736 737 738 739 740 741 742
    }
    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 已提交
743
                   PRId64 ", %"PRId64" bytes\n",
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 781 782 783 784 785
                   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 已提交
786
static int readv_f(BlockBackend *blk, int argc, char **argv);
787 788 789 790 791 792

static const cmdinfo_t readv_cmd = {
    .name       = "readv",
    .cfunc      = readv_f,
    .argmin     = 2,
    .argmax     = -1,
793
    .args       = "[-Cqv] [-P pattern] off len [len..]",
794 795 796 797
    .oneline    = "reads a number of bytes at a specified offset",
    .help       = readv_help,
};

M
Max Reitz 已提交
798
static int readv_f(BlockBackend *blk, int argc, char **argv)
799 800
{
    struct timeval t1, t2;
801
    bool Cflag = false, qflag = false, vflag = false;
802 803 804 805 806 807 808 809
    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;
810
    bool Pflag = false;
811

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

    if (optind > argc - 2) {
836
        return qemuio_command_usage(&readv_cmd);
837 838 839 840 841
    }


    offset = cvtnum(argv[optind]);
    if (offset < 0) {
J
John Snow 已提交
842
        print_cvtnum_err(offset, argv[optind]);
843 844 845 846 847
        return 0;
    }
    optind++;

    nr_iov = argc - optind;
M
Max Reitz 已提交
848
    buf = create_iovec(blk, &qiov, &argv[optind], nr_iov, 0xab);
849 850 851 852 853
    if (buf == NULL) {
        return 0;
    }

    gettimeofday(&t1, NULL);
M
Max Reitz 已提交
854
    cnt = do_aio_readv(blk, &qiov, offset, &total);
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 897 898 899 900 901
    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 已提交
902
" -c, -- write compressed data with blk_write_compressed\n"
903
" -f, -- use Force Unit Access semantics\n"
904
" -p, -- ignored for backwards compatibility\n"
905 906 907
" -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"
908
" -u, -- with -z, allow unmapping\n"
E
Eric Blake 已提交
909
" -z, -- write zeroes using blk_co_pwrite_zeroes\n"
910 911 912
"\n");
}

M
Max Reitz 已提交
913
static int write_f(BlockBackend *blk, int argc, char **argv);
914 915 916 917 918 919 920

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

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

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

    if (optind != argc - 2) {
979
        return qemuio_command_usage(&write_cmd);
980 981
    }

982 983
    if (bflag && zflag) {
        printf("-b and -z cannot be specified at the same time\n");
984 985 986
        return 0;
    }

987 988 989 990 991
    if ((flags & BDRV_REQ_FUA) && (bflag || cflag)) {
        printf("-f and -b or -c cannot be specified at the same time\n");
        return 0;
    }

992 993 994 995 996
    if ((flags & BDRV_REQ_MAY_UNMAP) && !zflag) {
        printf("-u requires -z to be specified\n");
        return 0;
    }

997 998 999 1000 1001 1002 1003
    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 已提交
1004
        print_cvtnum_err(offset, argv[optind]);
1005 1006 1007 1008 1009 1010
        return 0;
    }

    optind++;
    count = cvtnum(argv[optind]);
    if (count < 0) {
J
John Snow 已提交
1011
        print_cvtnum_err(count, argv[optind]);
1012
        return 0;
1013
    } else if (count > BDRV_REQUEST_MAX_BYTES) {
J
John Snow 已提交
1014
        printf("length cannot exceed %" PRIu64 ", given %s\n",
1015
               (uint64_t)BDRV_REQUEST_MAX_BYTES, argv[optind]);
J
John Snow 已提交
1016
        return 0;
1017 1018
    }

1019
    if (bflag || cflag) {
1020 1021 1022 1023 1024 1025 1026
        if (offset & 0x1ff) {
            printf("offset %" PRId64 " is not sector aligned\n",
                   offset);
            return 0;
        }

        if (count & 0x1ff) {
J
John Snow 已提交
1027
            printf("count %"PRId64" is not sector aligned\n",
1028 1029 1030 1031 1032 1033
                   count);
            return 0;
        }
    }

    if (!zflag) {
M
Max Reitz 已提交
1034
        buf = qemu_io_alloc(blk, count, pattern);
1035 1036 1037
    }

    gettimeofday(&t1, NULL);
1038
    if (bflag) {
M
Max Reitz 已提交
1039
        cnt = do_save_vmstate(blk, buf, offset, count, &total);
1040
    } else if (zflag) {
E
Eric Blake 已提交
1041
        cnt = do_co_pwrite_zeroes(blk, offset, count, flags, &total);
1042
    } else if (cflag) {
M
Max Reitz 已提交
1043
        cnt = do_write_compressed(blk, buf, offset, count, &total);
1044
    } else {
1045
        cnt = do_pwrite(blk, buf, offset, count, flags, &total);
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 1073 1074 1075 1076 1077
    }
    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"
1078
" 'writev 512 1k 1k' - writes 2 kilobytes at 512 bytes into the open file\n"
1079 1080 1081 1082 1083
"\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"
1084
" -f, -- use Force Unit Access semantics\n"
1085 1086 1087 1088
" -q, -- quiet mode, do not show I/O statistics\n"
"\n");
}

M
Max Reitz 已提交
1089
static int writev_f(BlockBackend *blk, int argc, char **argv);
1090 1091 1092 1093 1094 1095

static const cmdinfo_t writev_cmd = {
    .name       = "writev",
    .cfunc      = writev_f,
    .argmin     = 2,
    .argmax     = -1,
1096
    .args       = "[-Cfq] [-P pattern] off len [len..]",
1097 1098 1099 1100
    .oneline    = "writes a number of bytes at a specified offset",
    .help       = writev_help,
};

M
Max Reitz 已提交
1101
static int writev_f(BlockBackend *blk, int argc, char **argv)
1102 1103
{
    struct timeval t1, t2;
1104
    bool Cflag = false, qflag = false;
1105
    int flags = 0;
1106 1107 1108 1109 1110 1111 1112 1113 1114
    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 已提交
1115
    while ((c = getopt(argc, argv, "CfqP:")) != -1) {
1116 1117
        switch (c) {
        case 'C':
1118
            Cflag = true;
1119
            break;
1120 1121 1122
        case 'f':
            flags |= BDRV_REQ_FUA;
            break;
1123
        case 'q':
1124
            qflag = true;
1125 1126 1127 1128 1129 1130 1131 1132
            break;
        case 'P':
            pattern = parse_pattern(optarg);
            if (pattern < 0) {
                return 0;
            }
            break;
        default:
1133
            return qemuio_command_usage(&writev_cmd);
1134 1135 1136 1137
        }
    }

    if (optind > argc - 2) {
1138
        return qemuio_command_usage(&writev_cmd);
1139 1140 1141 1142
    }

    offset = cvtnum(argv[optind]);
    if (offset < 0) {
J
John Snow 已提交
1143
        print_cvtnum_err(offset, argv[optind]);
1144 1145 1146 1147 1148
        return 0;
    }
    optind++;

    nr_iov = argc - optind;
M
Max Reitz 已提交
1149
    buf = create_iovec(blk, &qiov, &argv[optind], nr_iov, pattern);
1150 1151 1152 1153 1154
    if (buf == NULL) {
        return 0;
    }

    gettimeofday(&t1, NULL);
1155
    cnt = do_aio_writev(blk, &qiov, offset, flags, &total);
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
    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 已提交
1177
    BlockBackend *blk;
1178 1179 1180
    QEMUIOVector qiov;
    int64_t offset;
    char *buf;
1181 1182 1183 1184 1185
    bool qflag;
    bool vflag;
    bool Cflag;
    bool Pflag;
    bool zflag;
1186
    BlockAcctCookie acct;
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
    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));
1201
        block_acct_failed(blk_get_stats(ctx->blk), &ctx->acct);
1202 1203 1204
        goto out;
    }

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

1207 1208 1209 1210 1211 1212 1213 1214 1215
    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 已提交
1216 1217 1218 1219
    if (!ctx->zflag) {
        qemu_io_free(ctx->buf);
        qemu_iovec_destroy(&ctx->qiov);
    }
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231
    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));
1232
        block_acct_failed(blk_get_stats(ctx->blk), &ctx->acct);
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
        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 已提交
1247
    block_acct_done(blk_get_stats(ctx->blk), &ctx->acct);
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 1277 1278 1279 1280 1281
    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"
1282
" -i, -- treat request as invalid, for exercising stats\n"
1283 1284 1285 1286 1287
" -v, -- dump buffer to standard output\n"
" -q, -- quiet mode, do not show I/O statistics\n"
"\n");
}

M
Max Reitz 已提交
1288
static int aio_read_f(BlockBackend *blk, int argc, char **argv);
1289 1290 1291 1292 1293 1294

static const cmdinfo_t aio_read_cmd = {
    .name       = "aio_read",
    .cfunc      = aio_read_f,
    .argmin     = 2,
    .argmax     = -1,
1295
    .args       = "[-Ciqv] [-P pattern] off len [len..]",
1296 1297 1298 1299
    .oneline    = "asynchronously reads a number of bytes",
    .help       = aio_read_help,
};

M
Max Reitz 已提交
1300
static int aio_read_f(BlockBackend *blk, int argc, char **argv)
1301 1302 1303 1304
{
    int nr_iov, c;
    struct aio_ctx *ctx = g_new0(struct aio_ctx, 1);

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

    if (optind > argc - 2) {
        g_free(ctx);
1338
        return qemuio_command_usage(&aio_read_cmd);
1339 1340 1341 1342
    }

    ctx->offset = cvtnum(argv[optind]);
    if (ctx->offset < 0) {
J
John Snow 已提交
1343
        print_cvtnum_err(ctx->offset, argv[optind]);
1344 1345 1346 1347 1348 1349
        g_free(ctx);
        return 0;
    }
    optind++;

    nr_iov = argc - optind;
M
Max Reitz 已提交
1350
    ctx->buf = create_iovec(blk, &ctx->qiov, &argv[optind], nr_iov, 0xab);
1351
    if (ctx->buf == NULL) {
1352
        block_acct_invalid(blk_get_stats(blk), BLOCK_ACCT_READ);
1353 1354 1355 1356 1357
        g_free(ctx);
        return 0;
    }

    gettimeofday(&ctx->t1, NULL);
M
Max Reitz 已提交
1358 1359
    block_acct_start(blk_get_stats(blk), &ctx->acct, ctx->qiov.size,
                     BLOCK_ACCT_READ);
1360
    blk_aio_preadv(blk, ctx->offset, &ctx->qiov, 0, aio_read_done, ctx);
1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379
    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"
1380
" -f, -- use Force Unit Access semantics\n"
1381
" -i, -- treat request as invalid, for exercising stats\n"
1382
" -q, -- quiet mode, do not show I/O statistics\n"
1383
" -u, -- with -z, allow unmapping\n"
E
Eric Blake 已提交
1384
" -z, -- write zeroes using blk_aio_pwrite_zeroes\n"
1385 1386 1387
"\n");
}

M
Max Reitz 已提交
1388
static int aio_write_f(BlockBackend *blk, int argc, char **argv);
1389 1390 1391 1392 1393 1394

static const cmdinfo_t aio_write_cmd = {
    .name       = "aio_write",
    .cfunc      = aio_write_f,
    .argmin     = 2,
    .argmax     = -1,
1395
    .args       = "[-Cfiquz] [-P pattern] off len [len..]",
1396 1397 1398 1399
    .oneline    = "asynchronously writes a number of bytes",
    .help       = aio_write_help,
};

M
Max Reitz 已提交
1400
static int aio_write_f(BlockBackend *blk, int argc, char **argv)
1401 1402 1403 1404
{
    int nr_iov, c;
    int pattern = 0xcd;
    struct aio_ctx *ctx = g_new0(struct aio_ctx, 1);
1405
    int flags = 0;
1406

M
Max Reitz 已提交
1407
    ctx->blk = blk;
1408
    while ((c = getopt(argc, argv, "CfiqP:uz")) != -1) {
1409 1410
        switch (c) {
        case 'C':
1411
            ctx->Cflag = true;
1412
            break;
1413 1414 1415
        case 'f':
            flags |= BDRV_REQ_FUA;
            break;
1416
        case 'q':
1417
            ctx->qflag = true;
1418
            break;
1419 1420 1421
        case 'u':
            flags |= BDRV_REQ_MAY_UNMAP;
            break;
1422 1423 1424 1425 1426 1427 1428
        case 'P':
            pattern = parse_pattern(optarg);
            if (pattern < 0) {
                g_free(ctx);
                return 0;
            }
            break;
1429 1430 1431 1432 1433
        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 已提交
1434
        case 'z':
1435
            ctx->zflag = true;
K
Kevin Wolf 已提交
1436
            break;
1437 1438
        default:
            g_free(ctx);
1439
            return qemuio_command_usage(&aio_write_cmd);
1440 1441 1442 1443 1444
        }
    }

    if (optind > argc - 2) {
        g_free(ctx);
1445
        return qemuio_command_usage(&aio_write_cmd);
1446 1447
    }

K
Kevin Wolf 已提交
1448 1449 1450 1451 1452 1453
    if (ctx->zflag && optind != argc - 2) {
        printf("-z supports only a single length parameter\n");
        g_free(ctx);
        return 0;
    }

1454 1455
    if ((flags & BDRV_REQ_MAY_UNMAP) && !ctx->zflag) {
        printf("-u requires -z to be specified\n");
E
Eric Blake 已提交
1456
        g_free(ctx);
1457 1458 1459
        return 0;
    }

K
Kevin Wolf 已提交
1460 1461 1462 1463 1464 1465
    if (ctx->zflag && ctx->Pflag) {
        printf("-z and -P cannot be specified at the same time\n");
        g_free(ctx);
        return 0;
    }

1466 1467
    ctx->offset = cvtnum(argv[optind]);
    if (ctx->offset < 0) {
J
John Snow 已提交
1468
        print_cvtnum_err(ctx->offset, argv[optind]);
1469 1470 1471 1472 1473
        g_free(ctx);
        return 0;
    }
    optind++;

K
Kevin Wolf 已提交
1474 1475 1476 1477
    if (ctx->zflag) {
        int64_t count = cvtnum(argv[optind]);
        if (count < 0) {
            print_cvtnum_err(count, argv[optind]);
1478
            g_free(ctx);
K
Kevin Wolf 已提交
1479 1480
            return 0;
        }
1481

K
Kevin Wolf 已提交
1482
        ctx->qiov.size = count;
E
Eric Blake 已提交
1483 1484
        blk_aio_pwrite_zeroes(blk, ctx->offset, count, flags, aio_write_done,
                              ctx);
K
Kevin Wolf 已提交
1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498
    } 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);

1499 1500
        blk_aio_pwritev(blk, ctx->offset, &ctx->qiov, flags, aio_write_done,
                        ctx);
K
Kevin Wolf 已提交
1501
    }
1502 1503 1504
    return 0;
}

M
Max Reitz 已提交
1505
static int aio_flush_f(BlockBackend *blk, int argc, char **argv)
1506
{
1507 1508
    BlockAcctCookie cookie;
    block_acct_start(blk_get_stats(blk), &cookie, 0, BLOCK_ACCT_FLUSH);
M
Max Reitz 已提交
1509
    blk_drain_all();
1510
    block_acct_done(blk_get_stats(blk), &cookie);
1511 1512 1513 1514 1515 1516 1517 1518 1519
    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 已提交
1520
static int flush_f(BlockBackend *blk, int argc, char **argv)
1521
{
M
Max Reitz 已提交
1522
    blk_flush(blk);
1523 1524 1525 1526 1527 1528 1529 1530 1531 1532
    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 已提交
1533
static int truncate_f(BlockBackend *blk, int argc, char **argv)
1534 1535 1536 1537 1538 1539
{
    int64_t offset;
    int ret;

    offset = cvtnum(argv[1]);
    if (offset < 0) {
J
John Snow 已提交
1540
        print_cvtnum_err(offset, argv[1]);
1541 1542 1543
        return 0;
    }

M
Max Reitz 已提交
1544
    ret = blk_truncate(blk, offset);
1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562
    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 已提交
1563
static int length_f(BlockBackend *blk, int argc, char **argv)
1564 1565 1566 1567
{
    int64_t size;
    char s1[64];

M
Max Reitz 已提交
1568
    size = blk_getlength(blk);
1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
    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 已提交
1588
static int info_f(BlockBackend *blk, int argc, char **argv)
1589
{
M
Max Reitz 已提交
1590
    BlockDriverState *bs = blk_bs(blk);
1591
    BlockDriverInfo bdi;
1592
    ImageInfoSpecific *spec_info;
1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613
    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);

1614 1615 1616 1617 1618 1619 1620
    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);
    }

1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647
    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 已提交
1648
static int discard_f(BlockBackend *blk, int argc, char **argv);
1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660

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 已提交
1661
static int discard_f(BlockBackend *blk, int argc, char **argv)
1662 1663
{
    struct timeval t1, t2;
1664
    bool Cflag = false, qflag = false;
1665
    int c, ret;
J
John Snow 已提交
1666
    int64_t offset, count;
1667

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

    if (optind != argc - 2) {
1682
        return qemuio_command_usage(&discard_cmd);
1683 1684 1685 1686
    }

    offset = cvtnum(argv[optind]);
    if (offset < 0) {
J
John Snow 已提交
1687
        print_cvtnum_err(offset, argv[optind]);
1688 1689 1690 1691 1692 1693
        return 0;
    }

    optind++;
    count = cvtnum(argv[optind]);
    if (count < 0) {
J
John Snow 已提交
1694
        print_cvtnum_err(count, argv[optind]);
1695
        return 0;
1696
    } else if (count >> BDRV_SECTOR_BITS > BDRV_REQUEST_MAX_SECTORS) {
J
John Snow 已提交
1697
        printf("length cannot exceed %"PRIu64", given %s\n",
1698
               (uint64_t)BDRV_REQUEST_MAX_SECTORS << BDRV_SECTOR_BITS,
J
John Snow 已提交
1699 1700
               argv[optind]);
        return 0;
1701 1702 1703
    }

    gettimeofday(&t1, NULL);
1704
    ret = blk_pdiscard(blk, offset, count);
1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721
    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 已提交
1722
static int alloc_f(BlockBackend *blk, int argc, char **argv)
1723
{
M
Max Reitz 已提交
1724
    BlockDriverState *bs = blk_bs(blk);
J
John Snow 已提交
1725
    int64_t offset, sector_num, nb_sectors, remaining;
1726
    char s1[64];
J
John Snow 已提交
1727 1728
    int num, ret;
    int64_t sum_alloc;
1729 1730 1731

    offset = cvtnum(argv[1]);
    if (offset < 0) {
J
John Snow 已提交
1732
        print_cvtnum_err(offset, argv[1]);
1733 1734 1735 1736 1737 1738 1739 1740 1741 1742
        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 已提交
1743
            print_cvtnum_err(nb_sectors, argv[2]);
1744
            return 0;
J
John Snow 已提交
1745 1746 1747 1748
        } else if (nb_sectors > INT_MAX) {
            printf("length argument cannot exceed %d, given %s\n",
                   INT_MAX, argv[2]);
            return 0;
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758
        }
    } 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);
1759 1760 1761 1762
        if (ret < 0) {
            printf("is_allocated failed: %s\n", strerror(-ret));
            return 0;
        }
1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775
        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 已提交
1776
    printf("%"PRId64"/%"PRId64" sectors allocated at offset %s\n",
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 1809 1810 1811 1812
           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);
1813
        if (ret == firstret && num) {
1814 1815 1816 1817 1818 1819 1820 1821 1822
            *pnum += num;
        } else {
            break;
        }
    }

    return firstret;
}

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

    offset = 0;
M
Max Reitz 已提交
1833 1834 1835 1836 1837 1838 1839 1840
    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;
1841 1842

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

        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 已提交
1860
    } while (offset < total_sectors);
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873

    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 已提交
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 1914 1915 1916 1917
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;
1918
    bool writethrough = !blk_enable_write_cache(blk);
K
Kevin Wolf 已提交
1919 1920 1921 1922 1923 1924 1925

    BlockReopenQueue *brq;
    Error *local_err = NULL;

    while ((c = getopt(argc, argv, "c:o:r")) != -1) {
        switch (c) {
        case 'c':
1926
            if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) < 0) {
K
Kevin Wolf 已提交
1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950
                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);
    }

1951 1952 1953 1954 1955 1956 1957 1958
    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 已提交
1959 1960 1961 1962 1963
    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);
1964
    bdrv_reopen_multiple(bdrv_get_aio_context(bs), brq, &local_err);
K
Kevin Wolf 已提交
1965 1966
    if (local_err) {
        error_report_err(local_err);
1967 1968
    } else {
        blk_set_enable_write_cache(blk, !writethrough);
K
Kevin Wolf 已提交
1969 1970 1971 1972 1973
    }

    return 0;
}

M
Max Reitz 已提交
1974
static int break_f(BlockBackend *blk, int argc, char **argv)
1975 1976 1977
{
    int ret;

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

    return 0;
}

M
Max Reitz 已提交
1986
static int remove_break_f(BlockBackend *blk, int argc, char **argv)
F
Fam Zheng 已提交
1987 1988 1989
{
    int ret;

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

    return 0;
}

1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
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 已提交
2008 2009 2010 2011 2012 2013 2014 2015 2016
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 已提交
2017
static int resume_f(BlockBackend *blk, int argc, char **argv)
2018 2019 2020
{
    int ret;

M
Max Reitz 已提交
2021
    ret = bdrv_debug_resume(blk_bs(blk), argv[1]);
2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037
    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 已提交
2038
static int wait_break_f(BlockBackend *blk, int argc, char **argv)
2039
{
M
Max Reitz 已提交
2040 2041
    while (!bdrv_debug_is_suspended(blk_bs(blk), argv[1])) {
        aio_poll(blk_get_aio_context(blk), true);
2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055
    }

    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 已提交
2056
static int abort_f(BlockBackend *blk, int argc, char **argv)
2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067
{
    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 已提交
2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081
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 已提交
2082
static int sigraise_f(BlockBackend *blk, int argc, char **argv);
M
Max Reitz 已提交
2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094

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

    /* 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 已提交
2117 2118 2119 2120 2121 2122
static void sleep_cb(void *opaque)
{
    bool *expired = opaque;
    *expired = true;
}

M
Max Reitz 已提交
2123
static int sleep_f(BlockBackend *blk, int argc, char **argv)
K
Kevin Wolf 已提交
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 2153 2154 2155 2156
{
    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 已提交
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 2188 2189 2190 2191
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 已提交
2192
static int help_f(BlockBackend *blk, int argc, char **argv)
K
Kevin Wolf 已提交
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 2218 2219 2220 2221
{
    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 已提交
2222
bool qemuio_command(BlockBackend *blk, const char *cmd)
K
Kevin Wolf 已提交
2223
{
P
Paolo Bonzini 已提交
2224
    AioContext *ctx;
K
Kevin Wolf 已提交
2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235
    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) {
P
Paolo Bonzini 已提交
2236 2237
            ctx = blk ? blk_get_aio_context(blk) : qemu_get_aio_context();
            aio_context_acquire(ctx);
M
Max Reitz 已提交
2238
            done = command(blk, ct, c, v);
P
Paolo Bonzini 已提交
2239
            aio_context_release(ctx);
K
Kevin Wolf 已提交
2240 2241 2242 2243 2244 2245 2246 2247 2248 2249
        } else {
            fprintf(stderr, "command \"%s\" not found\n", v[0]);
        }
    }
    g_free(input);
    g_free(v);

    return done;
}

2250 2251 2252
static void __attribute((constructor)) init_qemuio_commands(void)
{
    /* initialize commands */
2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267
    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 已提交
2268
    qemuio_add_command(&reopen_cmd);
2269
    qemuio_add_command(&break_cmd);
F
Fam Zheng 已提交
2270
    qemuio_add_command(&remove_break_cmd);
2271 2272 2273
    qemuio_add_command(&resume_cmd);
    qemuio_add_command(&wait_break_cmd);
    qemuio_add_command(&abort_cmd);
K
Kevin Wolf 已提交
2274
    qemuio_add_command(&sleep_cmd);
M
Max Reitz 已提交
2275
    qemuio_add_command(&sigraise_cmd);
2276
}