2 * Block protocol for I/O error injection
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
25 #include "qemu/osdep.h"
26 #include "qapi/error.h"
27 #include "qemu/cutils.h"
28 #include "qemu/config-file.h"
29 #include "block/block_int.h"
30 #include "qemu/module.h"
31 #include "qapi/qmp/qbool.h"
32 #include "qapi/qmp/qdict.h"
33 #include "qapi/qmp/qint.h"
34 #include "qapi/qmp/qstring.h"
35 #include "sysemu/qtest.h"
37 typedef struct BDRVBlkdebugState {
42 QLIST_HEAD(, BlkdebugRule) rules[BLKDBG__MAX];
43 QSIMPLEQ_HEAD(, BlkdebugRule) active_rules;
44 QLIST_HEAD(, BlkdebugSuspendedReq) suspended_reqs;
47 typedef struct BlkdebugAIOCB {
53 typedef struct BlkdebugSuspendedReq {
56 QLIST_ENTRY(BlkdebugSuspendedReq) next;
57 } BlkdebugSuspendedReq;
59 static const AIOCBInfo blkdebug_aiocb_info = {
60 .aiocb_size = sizeof(BlkdebugAIOCB),
69 typedef struct BlkdebugRule {
87 QLIST_ENTRY(BlkdebugRule) next;
88 QSIMPLEQ_ENTRY(BlkdebugRule) active_next;
91 static QemuOptsList inject_error_opts = {
92 .name = "inject-error",
93 .head = QTAILQ_HEAD_INITIALIZER(inject_error_opts.head),
97 .type = QEMU_OPT_STRING,
101 .type = QEMU_OPT_NUMBER,
105 .type = QEMU_OPT_NUMBER,
109 .type = QEMU_OPT_NUMBER,
113 .type = QEMU_OPT_BOOL,
116 .name = "immediately",
117 .type = QEMU_OPT_BOOL,
119 { /* end of list */ }
123 static QemuOptsList set_state_opts = {
125 .head = QTAILQ_HEAD_INITIALIZER(set_state_opts.head),
129 .type = QEMU_OPT_STRING,
133 .type = QEMU_OPT_NUMBER,
137 .type = QEMU_OPT_NUMBER,
139 { /* end of list */ }
143 static QemuOptsList *config_groups[] = {
149 static int get_event_by_name(const char *name, BlkdebugEvent *event)
153 for (i = 0; i < BLKDBG__MAX; i++) {
154 if (!strcmp(BlkdebugEvent_lookup[i], name)) {
163 struct add_rule_data {
164 BDRVBlkdebugState *s;
168 static int add_rule(void *opaque, QemuOpts *opts, Error **errp)
170 struct add_rule_data *d = opaque;
171 BDRVBlkdebugState *s = d->s;
172 const char* event_name;
174 struct BlkdebugRule *rule;
176 /* Find the right event for the rule */
177 event_name = qemu_opt_get(opts, "event");
179 error_setg(errp, "Missing event name for rule");
181 } else if (get_event_by_name(event_name, &event) < 0) {
182 error_setg(errp, "Invalid event name \"%s\"", event_name);
186 /* Set attributes common for all actions */
187 rule = g_malloc0(sizeof(*rule));
188 *rule = (struct BlkdebugRule) {
191 .state = qemu_opt_get_number(opts, "state", 0),
194 /* Parse action-specific options */
196 case ACTION_INJECT_ERROR:
197 rule->options.inject.error = qemu_opt_get_number(opts, "errno", EIO);
198 rule->options.inject.once = qemu_opt_get_bool(opts, "once", 0);
199 rule->options.inject.immediately =
200 qemu_opt_get_bool(opts, "immediately", 0);
201 rule->options.inject.sector = qemu_opt_get_number(opts, "sector", -1);
204 case ACTION_SET_STATE:
205 rule->options.set_state.new_state =
206 qemu_opt_get_number(opts, "new_state", 0);
210 rule->options.suspend.tag =
211 g_strdup(qemu_opt_get(opts, "tag"));
216 QLIST_INSERT_HEAD(&s->rules[event], rule, next);
221 static void remove_rule(BlkdebugRule *rule)
223 switch (rule->action) {
224 case ACTION_INJECT_ERROR:
225 case ACTION_SET_STATE:
228 g_free(rule->options.suspend.tag);
232 QLIST_REMOVE(rule, next);
236 static int read_config(BDRVBlkdebugState *s, const char *filename,
237 QDict *options, Error **errp)
241 struct add_rule_data d;
242 Error *local_err = NULL;
245 f = fopen(filename, "r");
247 error_setg_errno(errp, errno, "Could not read blkdebug config file");
251 ret = qemu_config_parse(f, config_groups, filename);
253 error_setg(errp, "Could not parse blkdebug config file");
259 qemu_config_parse_qdict(options, config_groups, &local_err);
261 error_propagate(errp, local_err);
267 d.action = ACTION_INJECT_ERROR;
268 qemu_opts_foreach(&inject_error_opts, add_rule, &d, &local_err);
270 error_propagate(errp, local_err);
275 d.action = ACTION_SET_STATE;
276 qemu_opts_foreach(&set_state_opts, add_rule, &d, &local_err);
278 error_propagate(errp, local_err);
285 qemu_opts_reset(&inject_error_opts);
286 qemu_opts_reset(&set_state_opts);
293 /* Valid blkdebug filenames look like blkdebug:path/to/config:path/to/image */
294 static void blkdebug_parse_filename(const char *filename, QDict *options,
299 /* Parse the blkdebug: prefix */
300 if (!strstart(filename, "blkdebug:", &filename)) {
301 /* There was no prefix; therefore, all options have to be already
302 present in the QDict (except for the filename) */
303 qdict_put(options, "x-image", qstring_from_str(filename));
307 /* Parse config file path */
308 c = strchr(filename, ':');
310 error_setg(errp, "blkdebug requires both config file and image path");
315 QString *config_path;
316 config_path = qstring_from_substr(filename, 0, c - filename - 1);
317 qdict_put(options, "config", config_path);
320 /* TODO Allow multi-level nesting and set file.filename here */
322 qdict_put(options, "x-image", qstring_from_str(filename));
325 static QemuOptsList runtime_opts = {
327 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
331 .type = QEMU_OPT_STRING,
332 .help = "Path to the configuration file",
336 .type = QEMU_OPT_STRING,
337 .help = "[internal use only, will be removed]",
341 .type = QEMU_OPT_SIZE,
342 .help = "Required alignment in bytes",
344 { /* end of list */ }
348 static int blkdebug_open(BlockDriverState *bs, QDict *options, int flags,
351 BDRVBlkdebugState *s = bs->opaque;
353 Error *local_err = NULL;
358 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
359 qemu_opts_absorb_qdict(opts, options, &local_err);
361 error_propagate(errp, local_err);
366 /* Read rules from config file or command line options */
367 config = qemu_opt_get(opts, "config");
368 ret = read_config(s, config, options, errp);
373 /* Set initial state */
376 /* Open the image file */
377 bs->file = bdrv_open_child(qemu_opt_get(opts, "x-image"), options, "image",
378 bs, &child_file, false, &local_err);
381 error_propagate(errp, local_err);
385 /* Set request alignment */
386 align = qemu_opt_get_size(opts, "align", 0);
387 if (align < INT_MAX && is_power_of_2(align)) {
390 error_setg(errp, "Invalid alignment");
399 bdrv_unref_child(bs, bs->file);
405 static void error_callback_bh(void *opaque)
407 struct BlkdebugAIOCB *acb = opaque;
408 qemu_bh_delete(acb->bh);
409 acb->common.cb(acb->common.opaque, acb->ret);
413 static BlockAIOCB *inject_error(BlockDriverState *bs,
414 BlockCompletionFunc *cb, void *opaque, BlkdebugRule *rule)
416 BDRVBlkdebugState *s = bs->opaque;
417 int error = rule->options.inject.error;
418 struct BlkdebugAIOCB *acb;
420 bool immediately = rule->options.inject.immediately;
422 if (rule->options.inject.once) {
423 QSIMPLEQ_REMOVE(&s->active_rules, rule, BlkdebugRule, active_next);
431 acb = qemu_aio_get(&blkdebug_aiocb_info, bs, cb, opaque);
434 bh = aio_bh_new(bdrv_get_aio_context(bs), error_callback_bh, acb);
436 qemu_bh_schedule(bh);
441 static BlockAIOCB *blkdebug_aio_readv(BlockDriverState *bs,
442 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
443 BlockCompletionFunc *cb, void *opaque)
445 BDRVBlkdebugState *s = bs->opaque;
446 BlkdebugRule *rule = NULL;
448 QSIMPLEQ_FOREACH(rule, &s->active_rules, active_next) {
449 if (rule->options.inject.sector == -1 ||
450 (rule->options.inject.sector >= sector_num &&
451 rule->options.inject.sector < sector_num + nb_sectors)) {
456 if (rule && rule->options.inject.error) {
457 return inject_error(bs, cb, opaque, rule);
460 return bdrv_aio_readv(bs->file, sector_num, qiov, nb_sectors,
464 static BlockAIOCB *blkdebug_aio_writev(BlockDriverState *bs,
465 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
466 BlockCompletionFunc *cb, void *opaque)
468 BDRVBlkdebugState *s = bs->opaque;
469 BlkdebugRule *rule = NULL;
471 QSIMPLEQ_FOREACH(rule, &s->active_rules, active_next) {
472 if (rule->options.inject.sector == -1 ||
473 (rule->options.inject.sector >= sector_num &&
474 rule->options.inject.sector < sector_num + nb_sectors)) {
479 if (rule && rule->options.inject.error) {
480 return inject_error(bs, cb, opaque, rule);
483 return bdrv_aio_writev(bs->file, sector_num, qiov, nb_sectors,
487 static BlockAIOCB *blkdebug_aio_flush(BlockDriverState *bs,
488 BlockCompletionFunc *cb, void *opaque)
490 BDRVBlkdebugState *s = bs->opaque;
491 BlkdebugRule *rule = NULL;
493 QSIMPLEQ_FOREACH(rule, &s->active_rules, active_next) {
494 if (rule->options.inject.sector == -1) {
499 if (rule && rule->options.inject.error) {
500 return inject_error(bs, cb, opaque, rule);
503 return bdrv_aio_flush(bs->file->bs, cb, opaque);
507 static void blkdebug_close(BlockDriverState *bs)
509 BDRVBlkdebugState *s = bs->opaque;
510 BlkdebugRule *rule, *next;
513 for (i = 0; i < BLKDBG__MAX; i++) {
514 QLIST_FOREACH_SAFE(rule, &s->rules[i], next, next) {
520 static void suspend_request(BlockDriverState *bs, BlkdebugRule *rule)
522 BDRVBlkdebugState *s = bs->opaque;
523 BlkdebugSuspendedReq r;
525 r = (BlkdebugSuspendedReq) {
526 .co = qemu_coroutine_self(),
527 .tag = g_strdup(rule->options.suspend.tag),
531 QLIST_INSERT_HEAD(&s->suspended_reqs, &r, next);
533 if (!qtest_enabled()) {
534 printf("blkdebug: Suspended request '%s'\n", r.tag);
536 qemu_coroutine_yield();
537 if (!qtest_enabled()) {
538 printf("blkdebug: Resuming request '%s'\n", r.tag);
541 QLIST_REMOVE(&r, next);
545 static bool process_rule(BlockDriverState *bs, struct BlkdebugRule *rule,
548 BDRVBlkdebugState *s = bs->opaque;
550 /* Only process rules for the current state */
551 if (rule->state && rule->state != s->state) {
555 /* Take the action */
556 switch (rule->action) {
557 case ACTION_INJECT_ERROR:
559 QSIMPLEQ_INIT(&s->active_rules);
562 QSIMPLEQ_INSERT_HEAD(&s->active_rules, rule, active_next);
565 case ACTION_SET_STATE:
566 s->new_state = rule->options.set_state.new_state;
570 suspend_request(bs, rule);
576 static void blkdebug_debug_event(BlockDriverState *bs, BlkdebugEvent event)
578 BDRVBlkdebugState *s = bs->opaque;
579 struct BlkdebugRule *rule, *next;
582 assert((int)event >= 0 && event < BLKDBG__MAX);
585 s->new_state = s->state;
586 QLIST_FOREACH_SAFE(rule, &s->rules[event], next, next) {
587 injected = process_rule(bs, rule, injected);
589 s->state = s->new_state;
592 static int blkdebug_debug_breakpoint(BlockDriverState *bs, const char *event,
595 BDRVBlkdebugState *s = bs->opaque;
596 struct BlkdebugRule *rule;
597 BlkdebugEvent blkdebug_event;
599 if (get_event_by_name(event, &blkdebug_event) < 0) {
604 rule = g_malloc(sizeof(*rule));
605 *rule = (struct BlkdebugRule) {
606 .event = blkdebug_event,
607 .action = ACTION_SUSPEND,
609 .options.suspend.tag = g_strdup(tag),
612 QLIST_INSERT_HEAD(&s->rules[blkdebug_event], rule, next);
617 static int blkdebug_debug_resume(BlockDriverState *bs, const char *tag)
619 BDRVBlkdebugState *s = bs->opaque;
620 BlkdebugSuspendedReq *r, *next;
622 QLIST_FOREACH_SAFE(r, &s->suspended_reqs, next, next) {
623 if (!strcmp(r->tag, tag)) {
624 qemu_coroutine_enter(r->co, NULL);
631 static int blkdebug_debug_remove_breakpoint(BlockDriverState *bs,
634 BDRVBlkdebugState *s = bs->opaque;
635 BlkdebugSuspendedReq *r, *r_next;
636 BlkdebugRule *rule, *next;
637 int i, ret = -ENOENT;
639 for (i = 0; i < BLKDBG__MAX; i++) {
640 QLIST_FOREACH_SAFE(rule, &s->rules[i], next, next) {
641 if (rule->action == ACTION_SUSPEND &&
642 !strcmp(rule->options.suspend.tag, tag)) {
648 QLIST_FOREACH_SAFE(r, &s->suspended_reqs, next, r_next) {
649 if (!strcmp(r->tag, tag)) {
650 qemu_coroutine_enter(r->co, NULL);
657 static bool blkdebug_debug_is_suspended(BlockDriverState *bs, const char *tag)
659 BDRVBlkdebugState *s = bs->opaque;
660 BlkdebugSuspendedReq *r;
662 QLIST_FOREACH(r, &s->suspended_reqs, next) {
663 if (!strcmp(r->tag, tag)) {
670 static int64_t blkdebug_getlength(BlockDriverState *bs)
672 return bdrv_getlength(bs->file->bs);
675 static int blkdebug_truncate(BlockDriverState *bs, int64_t offset)
677 return bdrv_truncate(bs->file->bs, offset);
680 static void blkdebug_refresh_filename(BlockDriverState *bs, QDict *options)
684 bool force_json = false;
686 for (e = qdict_first(options); e; e = qdict_next(options, e)) {
687 if (strcmp(qdict_entry_key(e), "config") &&
688 strcmp(qdict_entry_key(e), "x-image"))
695 if (force_json && !bs->file->bs->full_open_options) {
696 /* The config file cannot be recreated, so creating a plain filename
701 if (!force_json && bs->file->bs->exact_filename[0]) {
702 snprintf(bs->exact_filename, sizeof(bs->exact_filename),
704 qdict_get_try_str(options, "config") ?: "",
705 bs->file->bs->exact_filename);
709 qdict_put_obj(opts, "driver", QOBJECT(qstring_from_str("blkdebug")));
711 QINCREF(bs->file->bs->full_open_options);
712 qdict_put_obj(opts, "image", QOBJECT(bs->file->bs->full_open_options));
714 for (e = qdict_first(options); e; e = qdict_next(options, e)) {
715 if (strcmp(qdict_entry_key(e), "x-image")) {
716 qobject_incref(qdict_entry_value(e));
717 qdict_put_obj(opts, qdict_entry_key(e), qdict_entry_value(e));
721 bs->full_open_options = opts;
724 static void blkdebug_refresh_limits(BlockDriverState *bs, Error **errp)
726 BDRVBlkdebugState *s = bs->opaque;
729 bs->bl.request_alignment = s->align;
733 static int blkdebug_reopen_prepare(BDRVReopenState *reopen_state,
734 BlockReopenQueue *queue, Error **errp)
739 static BlockDriver bdrv_blkdebug = {
740 .format_name = "blkdebug",
741 .protocol_name = "blkdebug",
742 .instance_size = sizeof(BDRVBlkdebugState),
744 .bdrv_parse_filename = blkdebug_parse_filename,
745 .bdrv_file_open = blkdebug_open,
746 .bdrv_close = blkdebug_close,
747 .bdrv_reopen_prepare = blkdebug_reopen_prepare,
748 .bdrv_getlength = blkdebug_getlength,
749 .bdrv_truncate = blkdebug_truncate,
750 .bdrv_refresh_filename = blkdebug_refresh_filename,
751 .bdrv_refresh_limits = blkdebug_refresh_limits,
753 .bdrv_aio_readv = blkdebug_aio_readv,
754 .bdrv_aio_writev = blkdebug_aio_writev,
755 .bdrv_aio_flush = blkdebug_aio_flush,
757 .bdrv_debug_event = blkdebug_debug_event,
758 .bdrv_debug_breakpoint = blkdebug_debug_breakpoint,
759 .bdrv_debug_remove_breakpoint
760 = blkdebug_debug_remove_breakpoint,
761 .bdrv_debug_resume = blkdebug_debug_resume,
762 .bdrv_debug_is_suspended = blkdebug_debug_is_suspended,
765 static void bdrv_blkdebug_init(void)
767 bdrv_register(&bdrv_blkdebug);
770 block_init(bdrv_blkdebug_init);