blkdebug.c 22.5 KB
Newer Older
K
Kevin Wolf 已提交
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"
K
Kevin Wolf 已提交
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;
K
Kevin Wolf 已提交
41 42
} BDRVBlkdebugState;

K
Kevin Wolf 已提交
43
typedef struct BlkdebugAIOCB {
44
    BlockAIOCB common;
K
Kevin Wolf 已提交
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;

S
Stefan Hajnoczi 已提交
55
static const AIOCBInfo blkdebug_aiocb_info = {
56
    .aiocb_size    = sizeof(BlkdebugAIOCB),
K
Kevin Wolf 已提交
57 58
};

K
Kevin Wolf 已提交
59 60 61
enum {
    ACTION_INJECT_ERROR,
    ACTION_SET_STATE,
62
    ACTION_SUSPEND,
K
Kevin Wolf 已提交
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;
K
Kevin Wolf 已提交
75 76 77 78
        } inject;
        struct {
            int new_state;
        } set_state;
79 80 81
        struct {
            char *tag;
        } suspend;
K
Kevin Wolf 已提交
82 83
    } options;
    QLIST_ENTRY(BlkdebugRule) next;
84
    QSIMPLEQ_ENTRY(BlkdebugRule) active_next;
K
Kevin Wolf 已提交
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,
        },
K
Kevin Wolf 已提交
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),
K
Kevin Wolf 已提交
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] = {
K
Kevin Wolf 已提交
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",
K
Kevin Wolf 已提交
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",
M
Max Reitz 已提交
198 199

    [BLKDBG_EMPTY_IMAGE_PREPARE]            = "empty_image_prepare",
K
Kevin Wolf 已提交
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
};

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;
219
    Error **errp;
K
Kevin Wolf 已提交
220 221 222 223 224 225 226 227 228 229 230 231
};

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");
232 233 234 235 236
    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);
K
Kevin Wolf 已提交
237 238 239 240
        return -1;
    }

    /* Set attributes common for all actions */
241
    rule = g_malloc0(sizeof(*rule));
K
Kevin Wolf 已提交
242 243 244 245 246 247 248 249 250 251 252 253 254
    *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);
255
        rule->options.inject.sector = qemu_opt_get_number(opts, "sector", -1);
K
Kevin Wolf 已提交
256 257 258 259 260 261
        break;

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

    case ACTION_SUSPEND:
        rule->options.suspend.tag =
            g_strdup(qemu_opt_get(opts, "tag"));
        break;
K
Kevin Wolf 已提交
267 268 269 270 271 272 273 274
    };

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

    return 0;
}

K
Kevin Wolf 已提交
275 276 277 278 279 280
static void remove_rule(BlkdebugRule *rule)
{
    switch (rule->action) {
    case ACTION_INJECT_ERROR:
    case ACTION_SET_STATE:
        break;
281 282 283
    case ACTION_SUSPEND:
        g_free(rule->options.suspend.tag);
        break;
K
Kevin Wolf 已提交
284 285 286 287 288 289
    }

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

290 291
static int read_config(BDRVBlkdebugState *s, const char *filename,
                       QDict *options, Error **errp)
K
Kevin Wolf 已提交
292
{
M
Max Reitz 已提交
293
    FILE *f = NULL;
K
Kevin Wolf 已提交
294 295
    int ret;
    struct add_rule_data d;
296
    Error *local_err = NULL;
K
Kevin Wolf 已提交
297

M
Max Reitz 已提交
298 299 300 301 302 303
    if (filename) {
        f = fopen(filename, "r");
        if (f == NULL) {
            error_setg_errno(errp, errno, "Could not read blkdebug config file");
            return -errno;
        }
K
Kevin Wolf 已提交
304

M
Max Reitz 已提交
305 306 307 308 309 310
        ret = qemu_config_parse(f, config_groups, filename);
        if (ret < 0) {
            error_setg(errp, "Could not parse blkdebug config file");
            ret = -EINVAL;
            goto fail;
        }
K
Kevin Wolf 已提交
311 312
    }

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

K
Kevin Wolf 已提交
320 321
    d.s = s;
    d.action = ACTION_INJECT_ERROR;
322 323 324 325 326 327 328
    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;
    }
K
Kevin Wolf 已提交
329 330

    d.action = ACTION_SET_STATE;
331 332 333 334 335 336
    qemu_opts_foreach(&set_state_opts, add_rule, &d, 1);
    if (local_err) {
        error_propagate(errp, local_err);
        ret = -EINVAL;
        goto fail;
    }
K
Kevin Wolf 已提交
337 338 339

    ret = 0;
fail:
340 341
    qemu_opts_reset(&inject_error_opts);
    qemu_opts_reset(&set_state_opts);
M
Max Reitz 已提交
342 343 344
    if (f) {
        fclose(f);
    }
K
Kevin Wolf 已提交
345 346 347 348
    return ret;
}

/* Valid blkdebug filenames look like blkdebug:path/to/config:path/to/image */
349 350
static void blkdebug_parse_filename(const char *filename, QDict *options,
                                    Error **errp)
K
Kevin Wolf 已提交
351
{
352
    const char *c;
K
Kevin Wolf 已提交
353

K
Kevin Wolf 已提交
354
    /* Parse the blkdebug: prefix */
355
    if (!strstart(filename, "blkdebug:", &filename)) {
356 357 358
        /* 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));
359
        return;
K
Kevin Wolf 已提交
360 361
    }

362
    /* Parse config file path */
K
Kevin Wolf 已提交
363 364
    c = strchr(filename, ':');
    if (c == NULL) {
365 366
        error_setg(errp, "blkdebug requires both config file and image path");
        return;
K
Kevin Wolf 已提交
367 368
    }

369 370 371 372
    if (c != filename) {
        QString *config_path;
        config_path = qstring_from_substr(filename, 0, c - filename - 1);
        qdict_put(options, "config", config_path);
K
Kevin Wolf 已提交
373
    }
374 375

    /* TODO Allow multi-level nesting and set file.filename here */
K
Kevin Wolf 已提交
376
    filename = c + 1;
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
    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]",
        },
394 395 396 397 398
        {
            .name = "align",
            .type = QEMU_OPT_SIZE,
            .help = "Required alignment in bytes",
        },
399 400 401 402
        { /* end of list */ }
    },
};

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

413
    opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
414
    qemu_opts_absorb_qdict(opts, options, &local_err);
415
    if (local_err) {
M
Max Reitz 已提交
416
        error_propagate(errp, local_err);
417
        ret = -EINVAL;
418
        goto out;
419 420
    }

421
    /* Read rules from config file or command line options */
422
    config = qemu_opt_get(opts, "config");
423
    ret = read_config(s, config, options, errp);
M
Max Reitz 已提交
424
    if (ret) {
425
        goto out;
426
    }
K
Kevin Wolf 已提交
427

K
Kevin Wolf 已提交
428
    /* Set initial state */
429
    s->state = 1;
K
Kevin Wolf 已提交
430

K
Kevin Wolf 已提交
431
    /* Open the backing file */
432
    assert(bs->file == NULL);
433
    ret = bdrv_open_image(&bs->file, qemu_opt_get(opts, "x-image"), options, "image",
434
                          flags | BDRV_O_PROTOCOL, false, &local_err);
K
Kevin Wolf 已提交
435
    if (ret < 0) {
M
Max Reitz 已提交
436
        error_propagate(errp, local_err);
437
        goto out;
K
Kevin Wolf 已提交
438 439
    }

440 441 442 443 444 445 446
    /* 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;
447
        goto fail_unref;
448 449
    }

450
    ret = 0;
451 452 453 454 455
    goto out;

fail_unref:
    bdrv_unref(bs->file);
out:
456 457
    qemu_opts_del(opts);
    return ret;
K
Kevin Wolf 已提交
458 459
}

K
Kevin Wolf 已提交
460 461 462 463 464
static void error_callback_bh(void *opaque)
{
    struct BlkdebugAIOCB *acb = opaque;
    qemu_bh_delete(acb->bh);
    acb->common.cb(acb->common.opaque, acb->ret);
465
    qemu_aio_unref(acb);
K
Kevin Wolf 已提交
466 467
}

468
static BlockAIOCB *inject_error(BlockDriverState *bs,
469
    BlockCompletionFunc *cb, void *opaque, BlkdebugRule *rule)
K
Kevin Wolf 已提交
470 471
{
    BDRVBlkdebugState *s = bs->opaque;
472
    int error = rule->options.inject.error;
K
Kevin Wolf 已提交
473 474
    struct BlkdebugAIOCB *acb;
    QEMUBH *bh;
J
John Snow 已提交
475
    bool immediately = rule->options.inject.immediately;
K
Kevin Wolf 已提交
476

477
    if (rule->options.inject.once) {
J
John Snow 已提交
478 479
        QSIMPLEQ_REMOVE(&s->active_rules, rule, BlkdebugRule, active_next);
        remove_rule(rule);
K
Kevin Wolf 已提交
480 481
    }

J
John Snow 已提交
482
    if (immediately) {
K
Kevin Wolf 已提交
483 484 485
        return NULL;
    }

S
Stefan Hajnoczi 已提交
486
    acb = qemu_aio_get(&blkdebug_aiocb_info, bs, cb, opaque);
K
Kevin Wolf 已提交
487 488
    acb->ret = -error;

489
    bh = aio_bh_new(bdrv_get_aio_context(bs), error_callback_bh, acb);
K
Kevin Wolf 已提交
490 491 492
    acb->bh = bh;
    qemu_bh_schedule(bh);

493
    return &acb->common;
K
Kevin Wolf 已提交
494 495
}

496
static BlockAIOCB *blkdebug_aio_readv(BlockDriverState *bs,
K
Kevin Wolf 已提交
497
    int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
498
    BlockCompletionFunc *cb, void *opaque)
K
Kevin Wolf 已提交
499 500
{
    BDRVBlkdebugState *s = bs->opaque;
501 502 503 504 505 506 507 508 509
    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;
        }
    }
K
Kevin Wolf 已提交
510

511 512
    if (rule && rule->options.inject.error) {
        return inject_error(bs, cb, opaque, rule);
K
Kevin Wolf 已提交
513 514
    }

P
Paolo Bonzini 已提交
515
    return bdrv_aio_readv(bs->file, sector_num, qiov, nb_sectors, cb, opaque);
K
Kevin Wolf 已提交
516 517
}

518
static BlockAIOCB *blkdebug_aio_writev(BlockDriverState *bs,
K
Kevin Wolf 已提交
519
    int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
520
    BlockCompletionFunc *cb, void *opaque)
K
Kevin Wolf 已提交
521 522
{
    BDRVBlkdebugState *s = bs->opaque;
523 524 525 526 527 528 529 530 531
    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;
        }
    }
K
Kevin Wolf 已提交
532

533 534
    if (rule && rule->options.inject.error) {
        return inject_error(bs, cb, opaque, rule);
K
Kevin Wolf 已提交
535 536
    }

P
Paolo Bonzini 已提交
537
    return bdrv_aio_writev(bs->file, sector_num, qiov, nb_sectors, cb, opaque);
K
Kevin Wolf 已提交
538 539
}

540
static BlockAIOCB *blkdebug_aio_flush(BlockDriverState *bs,
541
    BlockCompletionFunc *cb, void *opaque)
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
{
    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);
}

559

K
Kevin Wolf 已提交
560 561 562
static void blkdebug_close(BlockDriverState *bs)
{
    BDRVBlkdebugState *s = bs->opaque;
K
Kevin Wolf 已提交
563 564 565 566 567
    BlkdebugRule *rule, *next;
    int i;

    for (i = 0; i < BLKDBG_EVENT_MAX; i++) {
        QLIST_FOREACH_SAFE(rule, &s->rules[i], next, next) {
K
Kevin Wolf 已提交
568
            remove_rule(rule);
K
Kevin Wolf 已提交
569 570
        }
    }
K
Kevin Wolf 已提交
571 572
}

573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
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);
}

594
static bool process_rule(BlockDriverState *bs, struct BlkdebugRule *rule,
595
    bool injected)
K
Kevin Wolf 已提交
596 597 598 599
{
    BDRVBlkdebugState *s = bs->opaque;

    /* Only process rules for the current state */
600
    if (rule->state && rule->state != s->state) {
601
        return injected;
K
Kevin Wolf 已提交
602 603 604 605 606
    }

    /* Take the action */
    switch (rule->action) {
    case ACTION_INJECT_ERROR:
607 608 609 610 611
        if (!injected) {
            QSIMPLEQ_INIT(&s->active_rules);
            injected = true;
        }
        QSIMPLEQ_INSERT_HEAD(&s->active_rules, rule, active_next);
K
Kevin Wolf 已提交
612 613 614
        break;

    case ACTION_SET_STATE:
615
        s->new_state = rule->options.set_state.new_state;
K
Kevin Wolf 已提交
616
        break;
617 618 619 620

    case ACTION_SUSPEND:
        suspend_request(bs, rule);
        break;
K
Kevin Wolf 已提交
621
    }
622
    return injected;
K
Kevin Wolf 已提交
623 624 625 626 627
}

static void blkdebug_debug_event(BlockDriverState *bs, BlkDebugEvent event)
{
    BDRVBlkdebugState *s = bs->opaque;
628
    struct BlkdebugRule *rule, *next;
629
    bool injected;
K
Kevin Wolf 已提交
630

B
Blue Swirl 已提交
631
    assert((int)event >= 0 && event < BLKDBG_EVENT_MAX);
K
Kevin Wolf 已提交
632

633
    injected = false;
634
    s->new_state = s->state;
635
    QLIST_FOREACH_SAFE(rule, &s->rules[event], next, next) {
636
        injected = process_rule(bs, rule, injected);
K
Kevin Wolf 已提交
637
    }
638
    s->state = s->new_state;
K
Kevin Wolf 已提交
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 665 666 667 668
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;
669
    BlkdebugSuspendedReq *r, *next;
670

671
    QLIST_FOREACH_SAFE(r, &s->suspended_reqs, next, next) {
672 673 674 675 676 677 678 679
        if (!strcmp(r->tag, tag)) {
            qemu_coroutine_enter(r->co, NULL);
            return 0;
        }
    }
    return -ENOENT;
}

F
Fam Zheng 已提交
680 681 682 683
static int blkdebug_debug_remove_breakpoint(BlockDriverState *bs,
                                            const char *tag)
{
    BDRVBlkdebugState *s = bs->opaque;
684
    BlkdebugSuspendedReq *r, *r_next;
F
Fam Zheng 已提交
685 686 687 688 689 690 691 692 693 694 695 696
    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;
            }
        }
    }
697
    QLIST_FOREACH_SAFE(r, &s->suspended_reqs, next, r_next) {
F
Fam Zheng 已提交
698 699 700 701 702 703 704
        if (!strcmp(r->tag, tag)) {
            qemu_coroutine_enter(r->co, NULL);
            ret = 0;
        }
    }
    return ret;
}
705 706 707 708 709 710 711 712 713 714 715 716 717 718

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

719 720 721 722 723
static int64_t blkdebug_getlength(BlockDriverState *bs)
{
    return bdrv_getlength(bs->file);
}

724 725 726
static void blkdebug_refresh_filename(BlockDriverState *bs)
{
    QDict *opts;
727 728 729 730 731 732 733 734 735 736 737 738 739
    const QDictEntry *e;
    bool force_json = false;

    for (e = qdict_first(bs->options); e; e = qdict_next(bs->options, e)) {
        if (strcmp(qdict_entry_key(e), "config") &&
            strcmp(qdict_entry_key(e), "x-image") &&
            strcmp(qdict_entry_key(e), "image") &&
            strncmp(qdict_entry_key(e), "image.", strlen("image.")))
        {
            force_json = true;
            break;
        }
    }
740

741
    if (force_json && !bs->file->full_open_options) {
742 743 744 745 746
        /* The config file cannot be recreated, so creating a plain filename
         * is impossible */
        return;
    }

747 748 749 750 751 752 753
    if (!force_json && bs->file->exact_filename[0]) {
        snprintf(bs->exact_filename, sizeof(bs->exact_filename),
                 "blkdebug:%s:%s",
                 qdict_get_try_str(bs->options, "config") ?: "",
                 bs->file->exact_filename);
    }

754 755 756 757 758 759
    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));

760 761 762 763 764 765 766
    for (e = qdict_first(bs->options); e; e = qdict_next(bs->options, e)) {
        if (strcmp(qdict_entry_key(e), "x-image") &&
            strcmp(qdict_entry_key(e), "image") &&
            strncmp(qdict_entry_key(e), "image.", strlen("image.")))
        {
            qobject_incref(qdict_entry_value(e));
            qdict_put_obj(opts, qdict_entry_key(e), qdict_entry_value(e));
767 768 769 770 771 772
        }
    }

    bs->full_open_options = opts;
}

K
Kevin Wolf 已提交
773
static BlockDriver bdrv_blkdebug = {
774 775 776
    .format_name            = "blkdebug",
    .protocol_name          = "blkdebug",
    .instance_size          = sizeof(BDRVBlkdebugState),
K
Kevin Wolf 已提交
777

778 779 780 781
    .bdrv_parse_filename    = blkdebug_parse_filename,
    .bdrv_file_open         = blkdebug_open,
    .bdrv_close             = blkdebug_close,
    .bdrv_getlength         = blkdebug_getlength,
782
    .bdrv_refresh_filename  = blkdebug_refresh_filename,
K
Kevin Wolf 已提交
783

784 785
    .bdrv_aio_readv         = blkdebug_aio_readv,
    .bdrv_aio_writev        = blkdebug_aio_writev,
786
    .bdrv_aio_flush         = blkdebug_aio_flush,
K
Kevin Wolf 已提交
787

788 789
    .bdrv_debug_event           = blkdebug_debug_event,
    .bdrv_debug_breakpoint      = blkdebug_debug_breakpoint,
F
Fam Zheng 已提交
790 791
    .bdrv_debug_remove_breakpoint
                                = blkdebug_debug_remove_breakpoint,
792 793
    .bdrv_debug_resume          = blkdebug_debug_resume,
    .bdrv_debug_is_suspended    = blkdebug_debug_is_suspended,
K
Kevin Wolf 已提交
794 795 796 797 798 799 800 801
};

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

block_init(bdrv_blkdebug_init);