blkdebug.c 24.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/*
 * Block protocol for I/O error injection
 *
 * Copyright (c) 2010 Kevin Wolf <kwolf@redhat.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#include "qemu-common.h"
26
#include "qemu/config-file.h"
27
#include "block/block_int.h"
28
#include "qemu/module.h"
29 30 31 32
#include "qapi/qmp/qbool.h"
#include "qapi/qmp/qdict.h"
#include "qapi/qmp/qint.h"
#include "qapi/qmp/qstring.h"
33 34

typedef struct BDRVBlkdebugState {
35
    int state;
36
    int new_state;
37

38 39
    QLIST_HEAD(, BlkdebugRule) rules[BLKDBG_EVENT_MAX];
    QSIMPLEQ_HEAD(, BlkdebugRule) active_rules;
40
    QLIST_HEAD(, BlkdebugSuspendedReq) suspended_reqs;
41 42
} BDRVBlkdebugState;

Kevin Wolf's avatar
Kevin Wolf committed
43
typedef struct BlkdebugAIOCB {
44
    BlockAIOCB common;
Kevin Wolf's avatar
Kevin Wolf committed
45 46 47 48
    QEMUBH *bh;
    int ret;
} BlkdebugAIOCB;

49 50 51 52 53 54
typedef struct BlkdebugSuspendedReq {
    Coroutine *co;
    char *tag;
    QLIST_ENTRY(BlkdebugSuspendedReq) next;
} BlkdebugSuspendedReq;

55
static const AIOCBInfo blkdebug_aiocb_info = {
56
    .aiocb_size    = sizeof(BlkdebugAIOCB),
Kevin Wolf's avatar
Kevin Wolf committed
57 58
};

59 60 61
enum {
    ACTION_INJECT_ERROR,
    ACTION_SET_STATE,
62
    ACTION_SUSPEND,
63 64 65 66 67 68 69 70 71 72 73
};

typedef struct BlkdebugRule {
    BlkDebugEvent event;
    int action;
    int state;
    union {
        struct {
            int error;
            int immediately;
            int once;
74
            int64_t sector;
75 76 77 78
        } inject;
        struct {
            int new_state;
        } set_state;
79 80 81
        struct {
            char *tag;
        } suspend;
82 83
    } options;
    QLIST_ENTRY(BlkdebugRule) next;
84
    QSIMPLEQ_ENTRY(BlkdebugRule) active_next;
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
} BlkdebugRule;

static QemuOptsList inject_error_opts = {
    .name = "inject-error",
    .head = QTAILQ_HEAD_INITIALIZER(inject_error_opts.head),
    .desc = {
        {
            .name = "event",
            .type = QEMU_OPT_STRING,
        },
        {
            .name = "state",
            .type = QEMU_OPT_NUMBER,
        },
        {
            .name = "errno",
            .type = QEMU_OPT_NUMBER,
        },
103 104 105 106
        {
            .name = "sector",
            .type = QEMU_OPT_NUMBER,
        },
107 108 109 110 111 112 113 114 115 116 117 118 119 120
        {
            .name = "once",
            .type = QEMU_OPT_BOOL,
        },
        {
            .name = "immediately",
            .type = QEMU_OPT_BOOL,
        },
        { /* end of list */ }
    },
};

static QemuOptsList set_state_opts = {
    .name = "set-state",
121
    .head = QTAILQ_HEAD_INITIALIZER(set_state_opts.head),
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
    .desc = {
        {
            .name = "event",
            .type = QEMU_OPT_STRING,
        },
        {
            .name = "state",
            .type = QEMU_OPT_NUMBER,
        },
        {
            .name = "new_state",
            .type = QEMU_OPT_NUMBER,
        },
        { /* end of list */ }
    },
};

static QemuOptsList *config_groups[] = {
    &inject_error_opts,
    &set_state_opts,
    NULL
};

static const char *event_names[BLKDBG_EVENT_MAX] = {
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
    [BLKDBG_L1_UPDATE]                      = "l1_update",
    [BLKDBG_L1_GROW_ALLOC_TABLE]            = "l1_grow.alloc_table",
    [BLKDBG_L1_GROW_WRITE_TABLE]            = "l1_grow.write_table",
    [BLKDBG_L1_GROW_ACTIVATE_TABLE]         = "l1_grow.activate_table",

    [BLKDBG_L2_LOAD]                        = "l2_load",
    [BLKDBG_L2_UPDATE]                      = "l2_update",
    [BLKDBG_L2_UPDATE_COMPRESSED]           = "l2_update_compressed",
    [BLKDBG_L2_ALLOC_COW_READ]              = "l2_alloc.cow_read",
    [BLKDBG_L2_ALLOC_WRITE]                 = "l2_alloc.write",

    [BLKDBG_READ_AIO]                       = "read_aio",
    [BLKDBG_READ_BACKING_AIO]               = "read_backing_aio",
    [BLKDBG_READ_COMPRESSED]                = "read_compressed",

    [BLKDBG_WRITE_AIO]                      = "write_aio",
    [BLKDBG_WRITE_COMPRESSED]               = "write_compressed",

    [BLKDBG_VMSTATE_LOAD]                   = "vmstate_load",
    [BLKDBG_VMSTATE_SAVE]                   = "vmstate_save",

    [BLKDBG_COW_READ]                       = "cow_read",
    [BLKDBG_COW_WRITE]                      = "cow_write",

    [BLKDBG_REFTABLE_LOAD]                  = "reftable_load",
    [BLKDBG_REFTABLE_GROW]                  = "reftable_grow",
172
    [BLKDBG_REFTABLE_UPDATE]                = "reftable_update",
173 174 175 176 177 178 179 180 181 182 183 184 185 186

    [BLKDBG_REFBLOCK_LOAD]                  = "refblock_load",
    [BLKDBG_REFBLOCK_UPDATE]                = "refblock_update",
    [BLKDBG_REFBLOCK_UPDATE_PART]           = "refblock_update_part",
    [BLKDBG_REFBLOCK_ALLOC]                 = "refblock_alloc",
    [BLKDBG_REFBLOCK_ALLOC_HOOKUP]          = "refblock_alloc.hookup",
    [BLKDBG_REFBLOCK_ALLOC_WRITE]           = "refblock_alloc.write",
    [BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS]    = "refblock_alloc.write_blocks",
    [BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE]     = "refblock_alloc.write_table",
    [BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE]    = "refblock_alloc.switch_table",

    [BLKDBG_CLUSTER_ALLOC]                  = "cluster_alloc",
    [BLKDBG_CLUSTER_ALLOC_BYTES]            = "cluster_alloc_bytes",
    [BLKDBG_CLUSTER_FREE]                   = "cluster_free",
187 188 189

    [BLKDBG_FLUSH_TO_OS]                    = "flush_to_os",
    [BLKDBG_FLUSH_TO_DISK]                  = "flush_to_disk",
190 191 192 193 194 195 196 197

    [BLKDBG_PWRITEV_RMW_HEAD]               = "pwritev_rmw.head",
    [BLKDBG_PWRITEV_RMW_AFTER_HEAD]         = "pwritev_rmw.after_head",
    [BLKDBG_PWRITEV_RMW_TAIL]               = "pwritev_rmw.tail",
    [BLKDBG_PWRITEV_RMW_AFTER_TAIL]         = "pwritev_rmw.after_tail",
    [BLKDBG_PWRITEV]                        = "pwritev",
    [BLKDBG_PWRITEV_ZERO]                   = "pwritev_zero",
    [BLKDBG_PWRITEV_DONE]                   = "pwritev_done",
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
};

static int get_event_by_name(const char *name, BlkDebugEvent *event)
{
    int i;

    for (i = 0; i < BLKDBG_EVENT_MAX; i++) {
        if (!strcmp(event_names[i], name)) {
            *event = i;
            return 0;
        }
    }

    return -1;
}

struct add_rule_data {
    BDRVBlkdebugState *s;
    int action;
217
    Error **errp;
218 219 220 221 222 223 224 225 226 227 228 229
};

static int add_rule(QemuOpts *opts, void *opaque)
{
    struct add_rule_data *d = opaque;
    BDRVBlkdebugState *s = d->s;
    const char* event_name;
    BlkDebugEvent event;
    struct BlkdebugRule *rule;

    /* Find the right event for the rule */
    event_name = qemu_opt_get(opts, "event");
230 231 232 233 234
    if (!event_name) {
        error_setg(d->errp, "Missing event name for rule");
        return -1;
    } else if (get_event_by_name(event_name, &event) < 0) {
        error_setg(d->errp, "Invalid event name \"%s\"", event_name);
235 236 237 238
        return -1;
    }

    /* Set attributes common for all actions */
239
    rule = g_malloc0(sizeof(*rule));
240 241 242 243 244 245 246 247 248 249 250 251 252
    *rule = (struct BlkdebugRule) {
        .event  = event,
        .action = d->action,
        .state  = qemu_opt_get_number(opts, "state", 0),
    };

    /* Parse action-specific options */
    switch (d->action) {
    case ACTION_INJECT_ERROR:
        rule->options.inject.error = qemu_opt_get_number(opts, "errno", EIO);
        rule->options.inject.once  = qemu_opt_get_bool(opts, "once", 0);
        rule->options.inject.immediately =
            qemu_opt_get_bool(opts, "immediately", 0);
253
        rule->options.inject.sector = qemu_opt_get_number(opts, "sector", -1);
254 255 256 257 258 259
        break;

    case ACTION_SET_STATE:
        rule->options.set_state.new_state =
            qemu_opt_get_number(opts, "new_state", 0);
        break;
260 261 262 263 264

    case ACTION_SUSPEND:
        rule->options.suspend.tag =
            g_strdup(qemu_opt_get(opts, "tag"));
        break;
265 266 267 268 269 270 271 272
    };

    /* Add the rule */
    QLIST_INSERT_HEAD(&s->rules[event], rule, next);

    return 0;
}

273 274 275 276 277 278
static void remove_rule(BlkdebugRule *rule)
{
    switch (rule->action) {
    case ACTION_INJECT_ERROR:
    case ACTION_SET_STATE:
        break;
279 280 281
    case ACTION_SUSPEND:
        g_free(rule->options.suspend.tag);
        break;
282 283 284 285 286 287
    }

    QLIST_REMOVE(rule, next);
    g_free(rule);
}

288 289
static int read_config(BDRVBlkdebugState *s, const char *filename,
                       QDict *options, Error **errp)
290
{
291
    FILE *f = NULL;
292 293
    int ret;
    struct add_rule_data d;
294
    Error *local_err = NULL;
295

296 297 298 299 300 301
    if (filename) {
        f = fopen(filename, "r");
        if (f == NULL) {
            error_setg_errno(errp, errno, "Could not read blkdebug config file");
            return -errno;
        }
302

303 304 305 306 307 308
        ret = qemu_config_parse(f, config_groups, filename);
        if (ret < 0) {
            error_setg(errp, "Could not parse blkdebug config file");
            ret = -EINVAL;
            goto fail;
        }
309 310
    }

311
    qemu_config_parse_qdict(options, config_groups, &local_err);
312
    if (local_err) {
313 314 315 316 317
        error_propagate(errp, local_err);
        ret = -EINVAL;
        goto fail;
    }

318 319
    d.s = s;
    d.action = ACTION_INJECT_ERROR;
320 321 322 323 324 325 326
    d.errp = &local_err;
    qemu_opts_foreach(&inject_error_opts, add_rule, &d, 1);
    if (local_err) {
        error_propagate(errp, local_err);
        ret = -EINVAL;
        goto fail;
    }
327 328

    d.action = ACTION_SET_STATE;
329 330 331 332 333 334
    qemu_opts_foreach(&set_state_opts, add_rule, &d, 1);
    if (local_err) {
        error_propagate(errp, local_err);
        ret = -EINVAL;
        goto fail;
    }
335 336 337

    ret = 0;
fail:
338 339
    qemu_opts_reset(&inject_error_opts);
    qemu_opts_reset(&set_state_opts);
340 341 342
    if (f) {
        fclose(f);
    }
343 344 345 346
    return ret;
}

/* Valid blkdebug filenames look like blkdebug:path/to/config:path/to/image */
347 348
static void blkdebug_parse_filename(const char *filename, QDict *options,
                                    Error **errp)
349
{
350
    const char *c;
351

352
    /* Parse the blkdebug: prefix */
353
    if (!strstart(filename, "blkdebug:", &filename)) {
354 355 356
        /* There was no prefix; therefore, all options have to be already
           present in the QDict (except for the filename) */
        qdict_put(options, "x-image", qstring_from_str(filename));
357
        return;
358 359
    }

360
    /* Parse config file path */
361 362
    c = strchr(filename, ':');
    if (c == NULL) {
363 364
        error_setg(errp, "blkdebug requires both config file and image path");
        return;
365 366
    }

367 368 369 370
    if (c != filename) {
        QString *config_path;
        config_path = qstring_from_substr(filename, 0, c - filename - 1);
        qdict_put(options, "config", config_path);
371
    }
372 373

    /* TODO Allow multi-level nesting and set file.filename here */
374
    filename = c + 1;
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
    qdict_put(options, "x-image", qstring_from_str(filename));
}

static QemuOptsList runtime_opts = {
    .name = "blkdebug",
    .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
    .desc = {
        {
            .name = "config",
            .type = QEMU_OPT_STRING,
            .help = "Path to the configuration file",
        },
        {
            .name = "x-image",
            .type = QEMU_OPT_STRING,
            .help = "[internal use only, will be removed]",
        },
392 393 394 395 396
        {
            .name = "align",
            .type = QEMU_OPT_SIZE,
            .help = "Required alignment in bytes",
        },
397 398 399 400
        { /* end of list */ }
    },
};

401 402
static int blkdebug_open(BlockDriverState *bs, QDict *options, int flags,
                         Error **errp)
403 404 405 406
{
    BDRVBlkdebugState *s = bs->opaque;
    QemuOpts *opts;
    Error *local_err = NULL;
407
    const char *config;
408
    uint64_t align;
409 410
    int ret;

411
    opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
412
    qemu_opts_absorb_qdict(opts, options, &local_err);
413
    if (local_err) {
414
        error_propagate(errp, local_err);
415
        ret = -EINVAL;
416
        goto out;
417 418
    }

419
    /* Read rules from config file or command line options */
420
    config = qemu_opt_get(opts, "config");
421
    ret = read_config(s, config, options, errp);
422
    if (ret) {
423
        goto out;
424
    }
425

426
    /* Set initial state */
427
    s->state = 1;
428

429
    /* Open the backing file */
430
    assert(bs->file == NULL);
431
    ret = bdrv_open_image(&bs->file, qemu_opt_get(opts, "x-image"), options, "image",
432
                          flags | BDRV_O_PROTOCOL, false, &local_err);
433
    if (ret < 0) {
434
        error_propagate(errp, local_err);
435
        goto out;
436 437
    }

438 439 440 441 442 443 444
    /* Set request alignment */
    align = qemu_opt_get_size(opts, "align", bs->request_alignment);
    if (align > 0 && align < INT_MAX && !(align & (align - 1))) {
        bs->request_alignment = align;
    } else {
        error_setg(errp, "Invalid alignment");
        ret = -EINVAL;
445
        goto fail_unref;
446 447
    }

448
    ret = 0;
449 450 451 452 453
    goto out;

fail_unref:
    bdrv_unref(bs->file);
out:
454 455
    qemu_opts_del(opts);
    return ret;
456 457
}

Kevin Wolf's avatar
Kevin Wolf committed
458 459 460 461 462
static void error_callback_bh(void *opaque)
{
    struct BlkdebugAIOCB *acb = opaque;
    qemu_bh_delete(acb->bh);
    acb->common.cb(acb->common.opaque, acb->ret);
463
    qemu_aio_unref(acb);
Kevin Wolf's avatar
Kevin Wolf committed
464 465
}

466
static BlockAIOCB *inject_error(BlockDriverState *bs,
467
    BlockDriverCompletionFunc *cb, void *opaque, BlkdebugRule *rule)
Kevin Wolf's avatar
Kevin Wolf committed
468 469
{
    BDRVBlkdebugState *s = bs->opaque;
470
    int error = rule->options.inject.error;
Kevin Wolf's avatar
Kevin Wolf committed
471 472 473
    struct BlkdebugAIOCB *acb;
    QEMUBH *bh;

474 475
    if (rule->options.inject.once) {
        QSIMPLEQ_INIT(&s->active_rules);
Kevin Wolf's avatar
Kevin Wolf committed
476 477
    }

478
    if (rule->options.inject.immediately) {
Kevin Wolf's avatar
Kevin Wolf committed
479 480 481
        return NULL;
    }

482
    acb = qemu_aio_get(&blkdebug_aiocb_info, bs, cb, opaque);
Kevin Wolf's avatar
Kevin Wolf committed
483 484
    acb->ret = -error;

485
    bh = aio_bh_new(bdrv_get_aio_context(bs), error_callback_bh, acb);
Kevin Wolf's avatar
Kevin Wolf committed
486 487 488
    acb->bh = bh;
    qemu_bh_schedule(bh);

489
    return &acb->common;
Kevin Wolf's avatar
Kevin Wolf committed
490 491
}

492
static BlockAIOCB *blkdebug_aio_readv(BlockDriverState *bs,
493 494 495 496
    int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
    BlockDriverCompletionFunc *cb, void *opaque)
{
    BDRVBlkdebugState *s = bs->opaque;
497 498 499 500 501 502 503 504 505
    BlkdebugRule *rule = NULL;

    QSIMPLEQ_FOREACH(rule, &s->active_rules, active_next) {
        if (rule->options.inject.sector == -1 ||
            (rule->options.inject.sector >= sector_num &&
             rule->options.inject.sector < sector_num + nb_sectors)) {
            break;
        }
    }
Kevin Wolf's avatar
Kevin Wolf committed
506

507 508
    if (rule && rule->options.inject.error) {
        return inject_error(bs, cb, opaque, rule);
Kevin Wolf's avatar
Kevin Wolf committed
509 510
    }

Paolo Bonzini's avatar
Paolo Bonzini committed
511
    return bdrv_aio_readv(bs->file, sector_num, qiov, nb_sectors, cb, opaque);
512 513
}

514
static BlockAIOCB *blkdebug_aio_writev(BlockDriverState *bs,
515 516 517 518
    int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
    BlockDriverCompletionFunc *cb, void *opaque)
{
    BDRVBlkdebugState *s = bs->opaque;
519 520 521 522 523 524 525 526 527
    BlkdebugRule *rule = NULL;

    QSIMPLEQ_FOREACH(rule, &s->active_rules, active_next) {
        if (rule->options.inject.sector == -1 ||
            (rule->options.inject.sector >= sector_num &&
             rule->options.inject.sector < sector_num + nb_sectors)) {
            break;
        }
    }
Kevin Wolf's avatar
Kevin Wolf committed
528

529 530
    if (rule && rule->options.inject.error) {
        return inject_error(bs, cb, opaque, rule);
Kevin Wolf's avatar
Kevin Wolf committed
531 532
    }

Paolo Bonzini's avatar
Paolo Bonzini committed
533
    return bdrv_aio_writev(bs->file, sector_num, qiov, nb_sectors, cb, opaque);
534 535
}

536
static BlockAIOCB *blkdebug_aio_flush(BlockDriverState *bs,
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
    BlockDriverCompletionFunc *cb, void *opaque)
{
    BDRVBlkdebugState *s = bs->opaque;
    BlkdebugRule *rule = NULL;

    QSIMPLEQ_FOREACH(rule, &s->active_rules, active_next) {
        if (rule->options.inject.sector == -1) {
            break;
        }
    }

    if (rule && rule->options.inject.error) {
        return inject_error(bs, cb, opaque, rule);
    }

    return bdrv_aio_flush(bs->file, cb, opaque);
}

555

556 557 558
static void blkdebug_close(BlockDriverState *bs)
{
    BDRVBlkdebugState *s = bs->opaque;
559 560 561 562 563
    BlkdebugRule *rule, *next;
    int i;

    for (i = 0; i < BLKDBG_EVENT_MAX; i++) {
        QLIST_FOREACH_SAFE(rule, &s->rules[i], next, next) {
564
            remove_rule(rule);
565 566
        }
    }
567 568
}

569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
static void suspend_request(BlockDriverState *bs, BlkdebugRule *rule)
{
    BDRVBlkdebugState *s = bs->opaque;
    BlkdebugSuspendedReq r;

    r = (BlkdebugSuspendedReq) {
        .co         = qemu_coroutine_self(),
        .tag        = g_strdup(rule->options.suspend.tag),
    };

    remove_rule(rule);
    QLIST_INSERT_HEAD(&s->suspended_reqs, &r, next);

    printf("blkdebug: Suspended request '%s'\n", r.tag);
    qemu_coroutine_yield();
    printf("blkdebug: Resuming request '%s'\n", r.tag);

    QLIST_REMOVE(&r, next);
    g_free(r.tag);
}

590
static bool process_rule(BlockDriverState *bs, struct BlkdebugRule *rule,
591
    bool injected)
592 593 594 595
{
    BDRVBlkdebugState *s = bs->opaque;

    /* Only process rules for the current state */
596
    if (rule->state && rule->state != s->state) {
597
        return injected;
598 599 600 601 602
    }

    /* Take the action */
    switch (rule->action) {
    case ACTION_INJECT_ERROR:
603 604 605 606 607
        if (!injected) {
            QSIMPLEQ_INIT(&s->active_rules);
            injected = true;
        }
        QSIMPLEQ_INSERT_HEAD(&s->active_rules, rule, active_next);
608 609 610
        break;

    case ACTION_SET_STATE:
611
        s->new_state = rule->options.set_state.new_state;
612
        break;
613 614 615 616

    case ACTION_SUSPEND:
        suspend_request(bs, rule);
        break;
617
    }
618
    return injected;
619 620 621 622 623
}

static void blkdebug_debug_event(BlockDriverState *bs, BlkDebugEvent event)
{
    BDRVBlkdebugState *s = bs->opaque;
624
    struct BlkdebugRule *rule, *next;
625
    bool injected;
626

627
    assert((int)event >= 0 && event < BLKDBG_EVENT_MAX);
628

629
    injected = false;
630
    s->new_state = s->state;
631
    QLIST_FOREACH_SAFE(rule, &s->rules[event], next, next) {
632
        injected = process_rule(bs, rule, injected);
633
    }
634
    s->state = s->new_state;
635 636
}

637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
static int blkdebug_debug_breakpoint(BlockDriverState *bs, const char *event,
                                     const char *tag)
{
    BDRVBlkdebugState *s = bs->opaque;
    struct BlkdebugRule *rule;
    BlkDebugEvent blkdebug_event;

    if (get_event_by_name(event, &blkdebug_event) < 0) {
        return -ENOENT;
    }


    rule = g_malloc(sizeof(*rule));
    *rule = (struct BlkdebugRule) {
        .event  = blkdebug_event,
        .action = ACTION_SUSPEND,
        .state  = 0,
        .options.suspend.tag = g_strdup(tag),
    };

    QLIST_INSERT_HEAD(&s->rules[blkdebug_event], rule, next);

    return 0;
}

static int blkdebug_debug_resume(BlockDriverState *bs, const char *tag)
{
    BDRVBlkdebugState *s = bs->opaque;
665
    BlkdebugSuspendedReq *r, *next;
666

667
    QLIST_FOREACH_SAFE(r, &s->suspended_reqs, next, next) {
668 669 670 671 672 673 674 675
        if (!strcmp(r->tag, tag)) {
            qemu_coroutine_enter(r->co, NULL);
            return 0;
        }
    }
    return -ENOENT;
}

676 677 678 679
static int blkdebug_debug_remove_breakpoint(BlockDriverState *bs,
                                            const char *tag)
{
    BDRVBlkdebugState *s = bs->opaque;
680
    BlkdebugSuspendedReq *r, *r_next;
681 682 683 684 685 686 687 688 689 690 691 692
    BlkdebugRule *rule, *next;
    int i, ret = -ENOENT;

    for (i = 0; i < BLKDBG_EVENT_MAX; i++) {
        QLIST_FOREACH_SAFE(rule, &s->rules[i], next, next) {
            if (rule->action == ACTION_SUSPEND &&
                !strcmp(rule->options.suspend.tag, tag)) {
                remove_rule(rule);
                ret = 0;
            }
        }
    }
693
    QLIST_FOREACH_SAFE(r, &s->suspended_reqs, next, r_next) {
694 695 696 697 698 699 700
        if (!strcmp(r->tag, tag)) {
            qemu_coroutine_enter(r->co, NULL);
            ret = 0;
        }
    }
    return ret;
}
701 702 703 704 705 706 707 708 709 710 711 712 713 714

static bool blkdebug_debug_is_suspended(BlockDriverState *bs, const char *tag)
{
    BDRVBlkdebugState *s = bs->opaque;
    BlkdebugSuspendedReq *r;

    QLIST_FOREACH(r, &s->suspended_reqs, next) {
        if (!strcmp(r->tag, tag)) {
            return true;
        }
    }
    return false;
}

715 716 717 718 719
static int64_t blkdebug_getlength(BlockDriverState *bs)
{
    return bdrv_getlength(bs->file);
}

720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 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 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
static void blkdebug_refresh_filename(BlockDriverState *bs)
{
    BDRVBlkdebugState *s = bs->opaque;
    struct BlkdebugRule *rule;
    QDict *opts;
    QList *inject_error_list = NULL, *set_state_list = NULL;
    QList *suspend_list = NULL;
    int event;

    if (!bs->file->full_open_options) {
        /* The config file cannot be recreated, so creating a plain filename
         * is impossible */
        return;
    }

    opts = qdict_new();
    qdict_put_obj(opts, "driver", QOBJECT(qstring_from_str("blkdebug")));

    QINCREF(bs->file->full_open_options);
    qdict_put_obj(opts, "image", QOBJECT(bs->file->full_open_options));

    for (event = 0; event < BLKDBG_EVENT_MAX; event++) {
        QLIST_FOREACH(rule, &s->rules[event], next) {
            if (rule->action == ACTION_INJECT_ERROR) {
                QDict *inject_error = qdict_new();

                qdict_put_obj(inject_error, "event", QOBJECT(qstring_from_str(
                              BlkdebugEvent_lookup[rule->event])));
                qdict_put_obj(inject_error, "state",
                              QOBJECT(qint_from_int(rule->state)));
                qdict_put_obj(inject_error, "errno", QOBJECT(qint_from_int(
                              rule->options.inject.error)));
                qdict_put_obj(inject_error, "sector", QOBJECT(qint_from_int(
                              rule->options.inject.sector)));
                qdict_put_obj(inject_error, "once", QOBJECT(qbool_from_int(
                              rule->options.inject.once)));
                qdict_put_obj(inject_error, "immediately",
                              QOBJECT(qbool_from_int(
                              rule->options.inject.immediately)));

                if (!inject_error_list) {
                    inject_error_list = qlist_new();
                }

                qlist_append_obj(inject_error_list, QOBJECT(inject_error));
            } else if (rule->action == ACTION_SET_STATE) {
                QDict *set_state = qdict_new();

                qdict_put_obj(set_state, "event", QOBJECT(qstring_from_str(
                              BlkdebugEvent_lookup[rule->event])));
                qdict_put_obj(set_state, "state",
                              QOBJECT(qint_from_int(rule->state)));
                qdict_put_obj(set_state, "new_state", QOBJECT(qint_from_int(
                              rule->options.set_state.new_state)));

                if (!set_state_list) {
                    set_state_list = qlist_new();
                }

                qlist_append_obj(set_state_list, QOBJECT(set_state));
            } else if (rule->action == ACTION_SUSPEND) {
                QDict *suspend = qdict_new();

                qdict_put_obj(suspend, "event", QOBJECT(qstring_from_str(
                              BlkdebugEvent_lookup[rule->event])));
                qdict_put_obj(suspend, "state",
                              QOBJECT(qint_from_int(rule->state)));
                qdict_put_obj(suspend, "tag", QOBJECT(qstring_from_str(
                              rule->options.suspend.tag)));

                if (!suspend_list) {
                    suspend_list = qlist_new();
                }

                qlist_append_obj(suspend_list, QOBJECT(suspend));
            }
        }
    }

    if (inject_error_list) {
        qdict_put_obj(opts, "inject-error", QOBJECT(inject_error_list));
    }
    if (set_state_list) {
        qdict_put_obj(opts, "set-state", QOBJECT(set_state_list));
    }
    if (suspend_list) {
        qdict_put_obj(opts, "suspend", QOBJECT(suspend_list));
    }

    bs->full_open_options = opts;
}

812
static BlockDriver bdrv_blkdebug = {
813 814 815
    .format_name            = "blkdebug",
    .protocol_name          = "blkdebug",
    .instance_size          = sizeof(BDRVBlkdebugState),
816

817 818 819 820
    .bdrv_parse_filename    = blkdebug_parse_filename,
    .bdrv_file_open         = blkdebug_open,
    .bdrv_close             = blkdebug_close,
    .bdrv_getlength         = blkdebug_getlength,
821
    .bdrv_refresh_filename  = blkdebug_refresh_filename,
822

823 824
    .bdrv_aio_readv         = blkdebug_aio_readv,
    .bdrv_aio_writev        = blkdebug_aio_writev,
825
    .bdrv_aio_flush         = blkdebug_aio_flush,
826

827 828
    .bdrv_debug_event           = blkdebug_debug_event,
    .bdrv_debug_breakpoint      = blkdebug_debug_breakpoint,
829 830
    .bdrv_debug_remove_breakpoint
                                = blkdebug_debug_remove_breakpoint,
831 832
    .bdrv_debug_resume          = blkdebug_debug_resume,
    .bdrv_debug_is_suspended    = blkdebug_debug_is_suspended,
833 834 835 836 837 838 839 840
};

static void bdrv_blkdebug_init(void)
{
    bdrv_register(&bdrv_blkdebug);
}

block_init(bdrv_blkdebug_init);