[qemu.git] / block / blkdebug.c

/*
 * Block protocol for I/O error injection
 *
 * Copyright (c) 2010 Kevin Wolf <[email protected]>
 *
 * 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"
#include "block_int.h"
#include "module.h"

typedef struct BDRVBlkdebugState {
    int state;
    QLIST_HEAD(, BlkdebugRule) rules[BLKDBG_EVENT_MAX];
    QSIMPLEQ_HEAD(, BlkdebugRule) active_rules;
} BDRVBlkdebugState;

typedef struct BlkdebugAIOCB {
    BlockDriverAIOCB common;
    QEMUBH *bh;
    int ret;
} BlkdebugAIOCB;

static void blkdebug_aio_cancel(BlockDriverAIOCB *blockacb);

static AIOPool blkdebug_aio_pool = {
    .aiocb_size = sizeof(BlkdebugAIOCB),
    .cancel     = blkdebug_aio_cancel,
};

enum {
    ACTION_INJECT_ERROR,
    ACTION_SET_STATE,
};

typedef struct BlkdebugRule {
    BlkDebugEvent event;
    int action;
    int state;
    union {
        struct {
            int error;
            int immediately;
            int once;
            int64_t sector;
        } inject;
        struct {
            int new_state;
        } set_state;
    } options;
    QLIST_ENTRY(BlkdebugRule) next;
    QSIMPLEQ_ENTRY(BlkdebugRule) active_next;
} 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,
        },
        {
            .name = "sector",
            .type = QEMU_OPT_NUMBER,
        },
        {
            .name = "once",
            .type = QEMU_OPT_BOOL,
        },
        {
            .name = "immediately",
            .type = QEMU_OPT_BOOL,
        },
        { /* end of list */ }
    },
};

static QemuOptsList set_state_opts = {
    .name = "set-state",
    .head = QTAILQ_HEAD_INITIALIZER(set_state_opts.head),
    .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] = {
    [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",

    [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",
};

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

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");
    if (!event_name || get_event_by_name(event_name, &event) < 0) {
        return -1;
    }

    /* Set attributes common for all actions */
    rule = g_malloc0(sizeof(*rule));
    *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);
        rule->options.inject.sector = qemu_opt_get_number(opts, "sector", -1);
        break;

    case ACTION_SET_STATE:
        rule->options.set_state.new_state =
            qemu_opt_get_number(opts, "new_state", 0);
        break;
    };

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

    return 0;
}

static int read_config(BDRVBlkdebugState *s, const char *filename)
{
    FILE *f;
    int ret;
    struct add_rule_data d;

    f = fopen(filename, "r");
    if (f == NULL) {
        return -errno;
    }

    ret = qemu_config_parse(f, config_groups, filename);
    if (ret < 0) {
        goto fail;
    }

    d.s = s;
    d.action = ACTION_INJECT_ERROR;
    qemu_opts_foreach(&inject_error_opts, add_rule, &d, 0);

    d.action = ACTION_SET_STATE;
    qemu_opts_foreach(&set_state_opts, add_rule, &d, 0);

    ret = 0;
fail:
    qemu_opts_reset(&inject_error_opts);
    qemu_opts_reset(&set_state_opts);
    fclose(f);
    return ret;
}

/* Valid blkdebug filenames look like blkdebug:path/to/config:path/to/image */
static int blkdebug_open(BlockDriverState *bs, const char *filename, int flags)
{
    BDRVBlkdebugState *s = bs->opaque;
    int ret;
    char *config, *c;

    /* Parse the blkdebug: prefix */
    if (strncmp(filename, "blkdebug:", strlen("blkdebug:"))) {
        return -EINVAL;
    }
    filename += strlen("blkdebug:");

    /* Read rules from config file */
    c = strchr(filename, ':');
    if (c == NULL) {
        return -EINVAL;
    }

    config = g_strdup(filename);
    config[c - filename] = '\0';
    ret = read_config(s, config);
    g_free(config);
    if (ret < 0) {
        return ret;
    }
    filename = c + 1;

    /* Set initial state */
    s->state = 1;

    /* Open the backing file */
    ret = bdrv_file_open(&bs->file, filename, flags);
    if (ret < 0) {
        return ret;
    }

    return 0;
}

static void error_callback_bh(void *opaque)
{
    struct BlkdebugAIOCB *acb = opaque;
    qemu_bh_delete(acb->bh);
    acb->common.cb(acb->common.opaque, acb->ret);
    qemu_aio_release(acb);
}

static void blkdebug_aio_cancel(BlockDriverAIOCB *blockacb)
{
    BlkdebugAIOCB *acb = container_of(blockacb, BlkdebugAIOCB, common);
    qemu_aio_release(acb);
}

static BlockDriverAIOCB *inject_error(BlockDriverState *bs,
    BlockDriverCompletionFunc *cb, void *opaque, BlkdebugRule *rule)
{
    BDRVBlkdebugState *s = bs->opaque;
    int error = rule->options.inject.error;
    struct BlkdebugAIOCB *acb;
    QEMUBH *bh;

    if (rule->options.inject.once) {
        QSIMPLEQ_INIT(&s->active_rules);
    }

    if (rule->options.inject.immediately) {
        return NULL;
    }

    acb = qemu_aio_get(&blkdebug_aio_pool, bs, cb, opaque);
    acb->ret = -error;

    bh = qemu_bh_new(error_callback_bh, acb);
    acb->bh = bh;
    qemu_bh_schedule(bh);

    return &acb->common;
}

static BlockDriverAIOCB *blkdebug_aio_readv(BlockDriverState *bs,
    int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
    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 ||
            (rule->options.inject.sector >= sector_num &&
             rule->options.inject.sector < sector_num + nb_sectors)) {
            break;
        }
    }

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

    return bdrv_aio_readv(bs->file, sector_num, qiov, nb_sectors, cb, opaque);
}

static BlockDriverAIOCB *blkdebug_aio_writev(BlockDriverState *bs,
    int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
    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 ||
            (rule->options.inject.sector >= sector_num &&
             rule->options.inject.sector < sector_num + nb_sectors)) {
            break;
        }
    }

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

    return bdrv_aio_writev(bs->file, sector_num, qiov, nb_sectors, cb, opaque);
}

static void blkdebug_close(BlockDriverState *bs)
{
    BDRVBlkdebugState *s = bs->opaque;
    BlkdebugRule *rule, *next;
    int i;

    for (i = 0; i < BLKDBG_EVENT_MAX; i++) {
        QLIST_FOREACH_SAFE(rule, &s->rules[i], next, next) {
            QLIST_REMOVE(rule, next);
            g_free(rule);
        }
    }
}

static bool process_rule(BlockDriverState *bs, struct BlkdebugRule *rule,
    int old_state, bool injected)
{
    BDRVBlkdebugState *s = bs->opaque;

    /* Only process rules for the current state */
    if (rule->state && rule->state != old_state) {
        return injected;
    }

    /* Take the action */
    switch (rule->action) {
    case ACTION_INJECT_ERROR:
        if (!injected) {
            QSIMPLEQ_INIT(&s->active_rules);
            injected = true;
        }
        QSIMPLEQ_INSERT_HEAD(&s->active_rules, rule, active_next);
        break;

    case ACTION_SET_STATE:
        s->state = rule->options.set_state.new_state;
        break;
    }
    return injected;
}

static void blkdebug_debug_event(BlockDriverState *bs, BlkDebugEvent event)
{
    BDRVBlkdebugState *s = bs->opaque;
    struct BlkdebugRule *rule;
    int old_state = s->state;
    bool injected;

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

    injected = false;
    QLIST_FOREACH(rule, &s->rules[event], next) {
        injected = process_rule(bs, rule, old_state, injected);
    }
}

static int64_t blkdebug_getlength(BlockDriverState *bs)
{
    return bdrv_getlength(bs->file);
}

static BlockDriver bdrv_blkdebug = {
    .format_name        = "blkdebug",
    .protocol_name      = "blkdebug",

    .instance_size      = sizeof(BDRVBlkdebugState),

    .bdrv_file_open     = blkdebug_open,
    .bdrv_close         = blkdebug_close,
    .bdrv_getlength     = blkdebug_getlength,

    .bdrv_aio_readv     = blkdebug_aio_readv,
    .bdrv_aio_writev    = blkdebug_aio_writev,

    .bdrv_debug_event   = blkdebug_debug_event,
};

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

block_init(bdrv_blkdebug_init);
Commit	Line	Data
6a143727 KW	1	/*
	2	* Block protocol for I/O error injection
	3	*
	4	* Copyright (c) 2010 Kevin Wolf <[email protected]>
	5	*
	6	* Permission is hereby granted, free of charge, to any person obtaining a copy
	7	* of this software and associated documentation files (the "Software"), to deal
	8	* in the Software without restriction, including without limitation the rights
	9	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	10	* copies of the Software, and to permit persons to whom the Software is
	11	* furnished to do so, subject to the following conditions:
	12	*
	13	* The above copyright notice and this permission notice shall be included in
	14	* all copies or substantial portions of the Software.
	15	*
	16	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	17	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	18	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	19	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	20	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	21	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	22	* THE SOFTWARE.
	23	*/
	24
	25	#include "qemu-common.h"
	26	#include "block_int.h"
	27	#include "module.h"
	28
	29	typedef struct BDRVBlkdebugState {
571cd43e PB	30	int state;
	31	QLIST_HEAD(, BlkdebugRule) rules[BLKDBG_EVENT_MAX];
	32	QSIMPLEQ_HEAD(, BlkdebugRule) active_rules;
6a143727 KW	33	} BDRVBlkdebugState;
6a143727 KW	34
b9f66d96 KW	35	typedef struct BlkdebugAIOCB {
	36	BlockDriverAIOCB common;
	37	QEMUBH *bh;
	38	int ret;
	39	} BlkdebugAIOCB;
	40
	41	static void blkdebug_aio_cancel(BlockDriverAIOCB *blockacb);
	42
	43	static AIOPool blkdebug_aio_pool = {
	44	.aiocb_size = sizeof(BlkdebugAIOCB),
	45	.cancel = blkdebug_aio_cancel,
	46	};
	47
8b9b0cc2 KW	48	enum {
	49	ACTION_INJECT_ERROR,
	50	ACTION_SET_STATE,
	51	};
	52
	53	typedef struct BlkdebugRule {
	54	BlkDebugEvent event;
	55	int action;
	56	int state;
	57	union {
	58	struct {
	59	int error;
	60	int immediately;
	61	int once;
e4780db4	62	int64_t sector;
8b9b0cc2 KW	63	} inject;
	64	struct {
	65	int new_state;
	66	} set_state;
	67	} options;
	68	QLIST_ENTRY(BlkdebugRule) next;
571cd43e	69	QSIMPLEQ_ENTRY(BlkdebugRule) active_next;
8b9b0cc2 KW	70	} BlkdebugRule;
	71
	72	static QemuOptsList inject_error_opts = {
	73	.name = "inject-error",
	74	.head = QTAILQ_HEAD_INITIALIZER(inject_error_opts.head),
	75	.desc = {
	76	{
	77	.name = "event",
	78	.type = QEMU_OPT_STRING,
	79	},
	80	{
	81	.name = "state",
	82	.type = QEMU_OPT_NUMBER,
	83	},
	84	{
	85	.name = "errno",
	86	.type = QEMU_OPT_NUMBER,
	87	},
e4780db4 PB	88	{
	89	.name = "sector",
	90	.type = QEMU_OPT_NUMBER,
	91	},
8b9b0cc2 KW	92	{
	93	.name = "once",
	94	.type = QEMU_OPT_BOOL,
	95	},
	96	{
	97	.name = "immediately",
	98	.type = QEMU_OPT_BOOL,
	99	},
	100	{ /* end of list */ }
	101	},
	102	};
	103
	104	static QemuOptsList set_state_opts = {
	105	.name = "set-state",
327cdad4	106	.head = QTAILQ_HEAD_INITIALIZER(set_state_opts.head),
8b9b0cc2 KW	107	.desc = {
	108	{
	109	.name = "event",
	110	.type = QEMU_OPT_STRING,
	111	},
	112	{
	113	.name = "state",
	114	.type = QEMU_OPT_NUMBER,
	115	},
	116	{
	117	.name = "new_state",
	118	.type = QEMU_OPT_NUMBER,
	119	},
	120	{ /* end of list */ }
	121	},
	122	};
	123
	124	static QemuOptsList *config_groups[] = {
	125	&inject_error_opts,
	126	&set_state_opts,
	127	NULL
	128	};
	129
	130	static const char *event_names[BLKDBG_EVENT_MAX] = {
8252278a KW	131	[BLKDBG_L1_UPDATE] = "l1_update",
	132	[BLKDBG_L1_GROW_ALLOC_TABLE] = "l1_grow.alloc_table",
	133	[BLKDBG_L1_GROW_WRITE_TABLE] = "l1_grow.write_table",
	134	[BLKDBG_L1_GROW_ACTIVATE_TABLE] = "l1_grow.activate_table",
	135
	136	[BLKDBG_L2_LOAD] = "l2_load",
	137	[BLKDBG_L2_UPDATE] = "l2_update",
	138	[BLKDBG_L2_UPDATE_COMPRESSED] = "l2_update_compressed",
	139	[BLKDBG_L2_ALLOC_COW_READ] = "l2_alloc.cow_read",
	140	[BLKDBG_L2_ALLOC_WRITE] = "l2_alloc.write",
	141
8252278a	142	[BLKDBG_READ_AIO] = "read_aio",
8252278a KW	143	[BLKDBG_READ_BACKING_AIO] = "read_backing_aio",
	144	[BLKDBG_READ_COMPRESSED] = "read_compressed",
	145
	146	[BLKDBG_WRITE_AIO] = "write_aio",
	147	[BLKDBG_WRITE_COMPRESSED] = "write_compressed",
	148
	149	[BLKDBG_VMSTATE_LOAD] = "vmstate_load",
	150	[BLKDBG_VMSTATE_SAVE] = "vmstate_save",
	151
	152	[BLKDBG_COW_READ] = "cow_read",
	153	[BLKDBG_COW_WRITE] = "cow_write",
	154
	155	[BLKDBG_REFTABLE_LOAD] = "reftable_load",
	156	[BLKDBG_REFTABLE_GROW] = "reftable_grow",
	157
	158	[BLKDBG_REFBLOCK_LOAD] = "refblock_load",
	159	[BLKDBG_REFBLOCK_UPDATE] = "refblock_update",
	160	[BLKDBG_REFBLOCK_UPDATE_PART] = "refblock_update_part",
	161	[BLKDBG_REFBLOCK_ALLOC] = "refblock_alloc",
	162	[BLKDBG_REFBLOCK_ALLOC_HOOKUP] = "refblock_alloc.hookup",
	163	[BLKDBG_REFBLOCK_ALLOC_WRITE] = "refblock_alloc.write",
	164	[BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS] = "refblock_alloc.write_blocks",
	165	[BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE] = "refblock_alloc.write_table",
	166	[BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE] = "refblock_alloc.switch_table",
	167
	168	[BLKDBG_CLUSTER_ALLOC] = "cluster_alloc",
	169	[BLKDBG_CLUSTER_ALLOC_BYTES] = "cluster_alloc_bytes",
	170	[BLKDBG_CLUSTER_FREE] = "cluster_free",
8b9b0cc2 KW	171	};
	172
	173	static int get_event_by_name(const char name, BlkDebugEvent event)
	174	{
	175	int i;
	176
	177	for (i = 0; i < BLKDBG_EVENT_MAX; i++) {
	178	if (!strcmp(event_names[i], name)) {
	179	*event = i;
	180	return 0;
	181	}
	182	}
	183
	184	return -1;
	185	}
	186
	187	struct add_rule_data {
	188	BDRVBlkdebugState *s;
	189	int action;
	190	};
	191
	192	static int add_rule(QemuOpts opts, void opaque)
	193	{
	194	struct add_rule_data *d = opaque;
	195	BDRVBlkdebugState *s = d->s;
	196	const char* event_name;
	197	BlkDebugEvent event;
	198	struct BlkdebugRule *rule;
	199
	200	/* Find the right event for the rule */
	201	event_name = qemu_opt_get(opts, "event");
	202	if (!event_name \|\| get_event_by_name(event_name, &event) < 0) {
	203	return -1;
	204	}
	205
	206	/* Set attributes common for all actions */
7267c094	207	rule = g_malloc0(sizeof(*rule));
8b9b0cc2 KW	208	*rule = (struct BlkdebugRule) {
	209	.event = event,
	210	.action = d->action,
	211	.state = qemu_opt_get_number(opts, "state", 0),
	212	};
	213
	214	/* Parse action-specific options */
	215	switch (d->action) {
	216	case ACTION_INJECT_ERROR:
	217	rule->options.inject.error = qemu_opt_get_number(opts, "errno", EIO);
	218	rule->options.inject.once = qemu_opt_get_bool(opts, "once", 0);
	219	rule->options.inject.immediately =
	220	qemu_opt_get_bool(opts, "immediately", 0);
e4780db4	221	rule->options.inject.sector = qemu_opt_get_number(opts, "sector", -1);
8b9b0cc2 KW	222	break;
	223
	224	case ACTION_SET_STATE:
	225	rule->options.set_state.new_state =
	226	qemu_opt_get_number(opts, "new_state", 0);
	227	break;
	228	};
	229
	230	/* Add the rule */
	231	QLIST_INSERT_HEAD(&s->rules[event], rule, next);
	232
	233	return 0;
	234	}
	235
	236	static int read_config(BDRVBlkdebugState s, const char filename)
	237	{
	238	FILE *f;
	239	int ret;
	240	struct add_rule_data d;
	241
	242	f = fopen(filename, "r");
	243	if (f == NULL) {
	244	return -errno;
	245	}
	246
	247	ret = qemu_config_parse(f, config_groups, filename);
	248	if (ret < 0) {
	249	goto fail;
	250	}
	251
	252	d.s = s;
	253	d.action = ACTION_INJECT_ERROR;
	254	qemu_opts_foreach(&inject_error_opts, add_rule, &d, 0);
	255
	256	d.action = ACTION_SET_STATE;
	257	qemu_opts_foreach(&set_state_opts, add_rule, &d, 0);
	258
	259	ret = 0;
	260	fail:
698f0d52 KW	261	qemu_opts_reset(&inject_error_opts);
698f0d52 KW	262	qemu_opts_reset(&set_state_opts);
8b9b0cc2 KW	263	fclose(f);
	264	return ret;
	265	}
	266
	267	/* Valid blkdebug filenames look like blkdebug:path/to/config:path/to/image */
6a143727 KW	268	static int blkdebug_open(BlockDriverState bs, const char filename, int flags)
	269	{
	270	BDRVBlkdebugState *s = bs->opaque;
8b9b0cc2 KW	271	int ret;
8b9b0cc2 KW	272	char config, c;
6a143727	273
8b9b0cc2	274	/* Parse the blkdebug: prefix */
6a143727 KW	275	if (strncmp(filename, "blkdebug:", strlen("blkdebug:"))) {
	276	return -EINVAL;
	277	}
	278	filename += strlen("blkdebug:");
	279
8b9b0cc2 KW	280	/* Read rules from config file */
	281	c = strchr(filename, ':');
	282	if (c == NULL) {
	283	return -EINVAL;
	284	}
	285
031380d8	286	config = g_strdup(filename);
8b9b0cc2 KW	287	config[c - filename] = '\0';
8b9b0cc2 KW	288	ret = read_config(s, config);
031380d8	289	g_free(config);
8b9b0cc2 KW	290	if (ret < 0) {
	291	return ret;
	292	}
	293	filename = c + 1;
	294
8db520ce	295	/* Set initial state */
571cd43e	296	s->state = 1;
8db520ce	297
8b9b0cc2	298	/* Open the backing file */
66f82cee	299	ret = bdrv_file_open(&bs->file, filename, flags);
8b9b0cc2 KW	300	if (ret < 0) {
	301	return ret;
	302	}
	303
	304	return 0;
6a143727 KW	305	}
6a143727 KW	306
b9f66d96 KW	307	static void error_callback_bh(void *opaque)
	308	{
	309	struct BlkdebugAIOCB *acb = opaque;
	310	qemu_bh_delete(acb->bh);
	311	acb->common.cb(acb->common.opaque, acb->ret);
	312	qemu_aio_release(acb);
	313	}
	314
	315	static void blkdebug_aio_cancel(BlockDriverAIOCB *blockacb)
	316	{
b666d239	317	BlkdebugAIOCB *acb = container_of(blockacb, BlkdebugAIOCB, common);
b9f66d96 KW	318	qemu_aio_release(acb);
	319	}
	320
	321	static BlockDriverAIOCB inject_error(BlockDriverState bs,
571cd43e	322	BlockDriverCompletionFunc cb, void opaque, BlkdebugRule *rule)
b9f66d96 KW	323	{
b9f66d96 KW	324	BDRVBlkdebugState *s = bs->opaque;
571cd43e	325	int error = rule->options.inject.error;
b9f66d96 KW	326	struct BlkdebugAIOCB *acb;
	327	QEMUBH *bh;
	328
571cd43e PB	329	if (rule->options.inject.once) {
571cd43e PB	330	QSIMPLEQ_INIT(&s->active_rules);
b9f66d96 KW	331	}
b9f66d96 KW	332
571cd43e	333	if (rule->options.inject.immediately) {
b9f66d96 KW	334	return NULL;
	335	}
	336
	337	acb = qemu_aio_get(&blkdebug_aio_pool, bs, cb, opaque);
	338	acb->ret = -error;
	339
	340	bh = qemu_bh_new(error_callback_bh, acb);
	341	acb->bh = bh;
	342	qemu_bh_schedule(bh);
	343
b666d239	344	return &acb->common;
b9f66d96 KW	345	}
b9f66d96 KW	346
6a143727 KW	347	static BlockDriverAIOCB blkdebug_aio_readv(BlockDriverState bs,
	348	int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
	349	BlockDriverCompletionFunc cb, void opaque)
	350	{
	351	BDRVBlkdebugState *s = bs->opaque;
e4780db4 PB	352	BlkdebugRule *rule = NULL;
	353
	354	QSIMPLEQ_FOREACH(rule, &s->active_rules, active_next) {
	355	if (rule->options.inject.sector == -1 \|\|
	356	(rule->options.inject.sector >= sector_num &&
	357	rule->options.inject.sector < sector_num + nb_sectors)) {
	358	break;
	359	}
	360	}
b9f66d96	361
571cd43e PB	362	if (rule && rule->options.inject.error) {
571cd43e PB	363	return inject_error(bs, cb, opaque, rule);
b9f66d96 KW	364	}
b9f66d96 KW	365
368e8dd1	366	return bdrv_aio_readv(bs->file, sector_num, qiov, nb_sectors, cb, opaque);
6a143727 KW	367	}
	368
	369	static BlockDriverAIOCB blkdebug_aio_writev(BlockDriverState bs,
	370	int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
	371	BlockDriverCompletionFunc cb, void opaque)
	372	{
	373	BDRVBlkdebugState *s = bs->opaque;
e4780db4 PB	374	BlkdebugRule *rule = NULL;
	375
	376	QSIMPLEQ_FOREACH(rule, &s->active_rules, active_next) {
	377	if (rule->options.inject.sector == -1 \|\|
	378	(rule->options.inject.sector >= sector_num &&
	379	rule->options.inject.sector < sector_num + nb_sectors)) {
	380	break;
	381	}
	382	}
b9f66d96	383
571cd43e PB	384	if (rule && rule->options.inject.error) {
571cd43e PB	385	return inject_error(bs, cb, opaque, rule);
b9f66d96 KW	386	}
b9f66d96 KW	387
368e8dd1	388	return bdrv_aio_writev(bs->file, sector_num, qiov, nb_sectors, cb, opaque);
6a143727 KW	389	}
	390
	391	static void blkdebug_close(BlockDriverState *bs)
	392	{
	393	BDRVBlkdebugState *s = bs->opaque;
8b9b0cc2 KW	394	BlkdebugRule rule, next;
	395	int i;
	396
	397	for (i = 0; i < BLKDBG_EVENT_MAX; i++) {
	398	QLIST_FOREACH_SAFE(rule, &s->rules[i], next, next) {
	399	QLIST_REMOVE(rule, next);
7267c094	400	g_free(rule);
8b9b0cc2 KW	401	}
8b9b0cc2 KW	402	}
6a143727 KW	403	}
6a143727 KW	404
571cd43e PB	405	static bool process_rule(BlockDriverState bs, struct BlkdebugRule rule,
571cd43e PB	406	int old_state, bool injected)
8b9b0cc2 KW	407	{
8b9b0cc2 KW	408	BDRVBlkdebugState *s = bs->opaque;
8b9b0cc2 KW	409
8b9b0cc2 KW	410	/* Only process rules for the current state */
571cd43e PB	411	if (rule->state && rule->state != old_state) {
571cd43e PB	412	return injected;
8b9b0cc2 KW	413	}
	414
	415	/* Take the action */
	416	switch (rule->action) {
	417	case ACTION_INJECT_ERROR:
571cd43e PB	418	if (!injected) {
	419	QSIMPLEQ_INIT(&s->active_rules);
	420	injected = true;
	421	}
	422	QSIMPLEQ_INSERT_HEAD(&s->active_rules, rule, active_next);
8b9b0cc2 KW	423	break;
	424
	425	case ACTION_SET_STATE:
571cd43e	426	s->state = rule->options.set_state.new_state;
8b9b0cc2 KW	427	break;
8b9b0cc2 KW	428	}
571cd43e	429	return injected;
8b9b0cc2 KW	430	}
	431
	432	static void blkdebug_debug_event(BlockDriverState *bs, BlkDebugEvent event)
	433	{
	434	BDRVBlkdebugState *s = bs->opaque;
	435	struct BlkdebugRule *rule;
571cd43e PB	436	int old_state = s->state;
571cd43e PB	437	bool injected;
8b9b0cc2	438
95ee3914	439	assert((int)event >= 0 && event < BLKDBG_EVENT_MAX);
8b9b0cc2	440
571cd43e	441	injected = false;
8b9b0cc2	442	QLIST_FOREACH(rule, &s->rules[event], next) {
571cd43e	443	injected = process_rule(bs, rule, old_state, injected);
8b9b0cc2 KW	444	}
	445	}
	446
e1302255 PB	447	static int64_t blkdebug_getlength(BlockDriverState *bs)
	448	{
	449	return bdrv_getlength(bs->file);
	450	}
	451
6a143727 KW	452	static BlockDriver bdrv_blkdebug = {
	453	.format_name = "blkdebug",
	454	.protocol_name = "blkdebug",
	455
	456	.instance_size = sizeof(BDRVBlkdebugState),
	457
66f82cee	458	.bdrv_file_open = blkdebug_open,
6a143727	459	.bdrv_close = blkdebug_close,
e1302255	460	.bdrv_getlength = blkdebug_getlength,
6a143727 KW	461
	462	.bdrv_aio_readv = blkdebug_aio_readv,
	463	.bdrv_aio_writev = blkdebug_aio_writev,
8b9b0cc2 KW	464
8b9b0cc2 KW	465	.bdrv_debug_event = blkdebug_debug_event,
6a143727 KW	466	};
	467
	468	static void bdrv_blkdebug_init(void)
	469	{
	470	bdrv_register(&bdrv_blkdebug);
	471	}
	472
	473	block_init(bdrv_blkdebug_init);