libcacard: improve documentation
[qemu/rayw.git] / block / blkdebug.c
blobf51407de3f89a1f5288e134fa9e423759aea349b
1 /*
2 * Block protocol for I/O error injection
4 * Copyright (c) 2010 Kevin Wolf <kwolf@redhat.com>
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
22 * THE SOFTWARE.
25 #include "qemu-common.h"
26 #include "qemu/config-file.h"
27 #include "block/block_int.h"
28 #include "qemu/module.h"
30 typedef struct BDRVBlkdebugState {
31 int state;
32 int new_state;
34 QLIST_HEAD(, BlkdebugRule) rules[BLKDBG_EVENT_MAX];
35 QSIMPLEQ_HEAD(, BlkdebugRule) active_rules;
36 QLIST_HEAD(, BlkdebugSuspendedReq) suspended_reqs;
37 } BDRVBlkdebugState;
39 typedef struct BlkdebugAIOCB {
40 BlockDriverAIOCB common;
41 QEMUBH *bh;
42 int ret;
43 } BlkdebugAIOCB;
45 typedef struct BlkdebugSuspendedReq {
46 Coroutine *co;
47 char *tag;
48 QLIST_ENTRY(BlkdebugSuspendedReq) next;
49 } BlkdebugSuspendedReq;
51 static void blkdebug_aio_cancel(BlockDriverAIOCB *blockacb);
53 static const AIOCBInfo blkdebug_aiocb_info = {
54 .aiocb_size = sizeof(BlkdebugAIOCB),
55 .cancel = blkdebug_aio_cancel,
58 enum {
59 ACTION_INJECT_ERROR,
60 ACTION_SET_STATE,
61 ACTION_SUSPEND,
64 typedef struct BlkdebugRule {
65 BlkDebugEvent event;
66 int action;
67 int state;
68 union {
69 struct {
70 int error;
71 int immediately;
72 int once;
73 int64_t sector;
74 } inject;
75 struct {
76 int new_state;
77 } set_state;
78 struct {
79 char *tag;
80 } suspend;
81 } options;
82 QLIST_ENTRY(BlkdebugRule) next;
83 QSIMPLEQ_ENTRY(BlkdebugRule) active_next;
84 } BlkdebugRule;
86 static QemuOptsList inject_error_opts = {
87 .name = "inject-error",
88 .head = QTAILQ_HEAD_INITIALIZER(inject_error_opts.head),
89 .desc = {
91 .name = "event",
92 .type = QEMU_OPT_STRING,
95 .name = "state",
96 .type = QEMU_OPT_NUMBER,
99 .name = "errno",
100 .type = QEMU_OPT_NUMBER,
103 .name = "sector",
104 .type = QEMU_OPT_NUMBER,
107 .name = "once",
108 .type = QEMU_OPT_BOOL,
111 .name = "immediately",
112 .type = QEMU_OPT_BOOL,
114 { /* end of list */ }
118 static QemuOptsList set_state_opts = {
119 .name = "set-state",
120 .head = QTAILQ_HEAD_INITIALIZER(set_state_opts.head),
121 .desc = {
123 .name = "event",
124 .type = QEMU_OPT_STRING,
127 .name = "state",
128 .type = QEMU_OPT_NUMBER,
131 .name = "new_state",
132 .type = QEMU_OPT_NUMBER,
134 { /* end of list */ }
138 static QemuOptsList *config_groups[] = {
139 &inject_error_opts,
140 &set_state_opts,
141 NULL
144 static const char *event_names[BLKDBG_EVENT_MAX] = {
145 [BLKDBG_L1_UPDATE] = "l1_update",
146 [BLKDBG_L1_GROW_ALLOC_TABLE] = "l1_grow.alloc_table",
147 [BLKDBG_L1_GROW_WRITE_TABLE] = "l1_grow.write_table",
148 [BLKDBG_L1_GROW_ACTIVATE_TABLE] = "l1_grow.activate_table",
150 [BLKDBG_L2_LOAD] = "l2_load",
151 [BLKDBG_L2_UPDATE] = "l2_update",
152 [BLKDBG_L2_UPDATE_COMPRESSED] = "l2_update_compressed",
153 [BLKDBG_L2_ALLOC_COW_READ] = "l2_alloc.cow_read",
154 [BLKDBG_L2_ALLOC_WRITE] = "l2_alloc.write",
156 [BLKDBG_READ_AIO] = "read_aio",
157 [BLKDBG_READ_BACKING_AIO] = "read_backing_aio",
158 [BLKDBG_READ_COMPRESSED] = "read_compressed",
160 [BLKDBG_WRITE_AIO] = "write_aio",
161 [BLKDBG_WRITE_COMPRESSED] = "write_compressed",
163 [BLKDBG_VMSTATE_LOAD] = "vmstate_load",
164 [BLKDBG_VMSTATE_SAVE] = "vmstate_save",
166 [BLKDBG_COW_READ] = "cow_read",
167 [BLKDBG_COW_WRITE] = "cow_write",
169 [BLKDBG_REFTABLE_LOAD] = "reftable_load",
170 [BLKDBG_REFTABLE_GROW] = "reftable_grow",
171 [BLKDBG_REFTABLE_UPDATE] = "reftable_update",
173 [BLKDBG_REFBLOCK_LOAD] = "refblock_load",
174 [BLKDBG_REFBLOCK_UPDATE] = "refblock_update",
175 [BLKDBG_REFBLOCK_UPDATE_PART] = "refblock_update_part",
176 [BLKDBG_REFBLOCK_ALLOC] = "refblock_alloc",
177 [BLKDBG_REFBLOCK_ALLOC_HOOKUP] = "refblock_alloc.hookup",
178 [BLKDBG_REFBLOCK_ALLOC_WRITE] = "refblock_alloc.write",
179 [BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS] = "refblock_alloc.write_blocks",
180 [BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE] = "refblock_alloc.write_table",
181 [BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE] = "refblock_alloc.switch_table",
183 [BLKDBG_CLUSTER_ALLOC] = "cluster_alloc",
184 [BLKDBG_CLUSTER_ALLOC_BYTES] = "cluster_alloc_bytes",
185 [BLKDBG_CLUSTER_FREE] = "cluster_free",
187 [BLKDBG_FLUSH_TO_OS] = "flush_to_os",
188 [BLKDBG_FLUSH_TO_DISK] = "flush_to_disk",
190 [BLKDBG_PWRITEV_RMW_HEAD] = "pwritev_rmw.head",
191 [BLKDBG_PWRITEV_RMW_AFTER_HEAD] = "pwritev_rmw.after_head",
192 [BLKDBG_PWRITEV_RMW_TAIL] = "pwritev_rmw.tail",
193 [BLKDBG_PWRITEV_RMW_AFTER_TAIL] = "pwritev_rmw.after_tail",
194 [BLKDBG_PWRITEV] = "pwritev",
195 [BLKDBG_PWRITEV_ZERO] = "pwritev_zero",
196 [BLKDBG_PWRITEV_DONE] = "pwritev_done",
199 static int get_event_by_name(const char *name, BlkDebugEvent *event)
201 int i;
203 for (i = 0; i < BLKDBG_EVENT_MAX; i++) {
204 if (!strcmp(event_names[i], name)) {
205 *event = i;
206 return 0;
210 return -1;
213 struct add_rule_data {
214 BDRVBlkdebugState *s;
215 int action;
218 static int add_rule(QemuOpts *opts, void *opaque)
220 struct add_rule_data *d = opaque;
221 BDRVBlkdebugState *s = d->s;
222 const char* event_name;
223 BlkDebugEvent event;
224 struct BlkdebugRule *rule;
226 /* Find the right event for the rule */
227 event_name = qemu_opt_get(opts, "event");
228 if (!event_name || get_event_by_name(event_name, &event) < 0) {
229 return -1;
232 /* Set attributes common for all actions */
233 rule = g_malloc0(sizeof(*rule));
234 *rule = (struct BlkdebugRule) {
235 .event = event,
236 .action = d->action,
237 .state = qemu_opt_get_number(opts, "state", 0),
240 /* Parse action-specific options */
241 switch (d->action) {
242 case ACTION_INJECT_ERROR:
243 rule->options.inject.error = qemu_opt_get_number(opts, "errno", EIO);
244 rule->options.inject.once = qemu_opt_get_bool(opts, "once", 0);
245 rule->options.inject.immediately =
246 qemu_opt_get_bool(opts, "immediately", 0);
247 rule->options.inject.sector = qemu_opt_get_number(opts, "sector", -1);
248 break;
250 case ACTION_SET_STATE:
251 rule->options.set_state.new_state =
252 qemu_opt_get_number(opts, "new_state", 0);
253 break;
255 case ACTION_SUSPEND:
256 rule->options.suspend.tag =
257 g_strdup(qemu_opt_get(opts, "tag"));
258 break;
261 /* Add the rule */
262 QLIST_INSERT_HEAD(&s->rules[event], rule, next);
264 return 0;
267 static void remove_rule(BlkdebugRule *rule)
269 switch (rule->action) {
270 case ACTION_INJECT_ERROR:
271 case ACTION_SET_STATE:
272 break;
273 case ACTION_SUSPEND:
274 g_free(rule->options.suspend.tag);
275 break;
278 QLIST_REMOVE(rule, next);
279 g_free(rule);
282 static int read_config(BDRVBlkdebugState *s, const char *filename,
283 QDict *options, Error **errp)
285 FILE *f = NULL;
286 int ret;
287 struct add_rule_data d;
288 Error *local_err = NULL;
290 if (filename) {
291 f = fopen(filename, "r");
292 if (f == NULL) {
293 error_setg_errno(errp, errno, "Could not read blkdebug config file");
294 return -errno;
297 ret = qemu_config_parse(f, config_groups, filename);
298 if (ret < 0) {
299 error_setg(errp, "Could not parse blkdebug config file");
300 ret = -EINVAL;
301 goto fail;
305 qemu_config_parse_qdict(options, config_groups, &local_err);
306 if (local_err) {
307 error_propagate(errp, local_err);
308 ret = -EINVAL;
309 goto fail;
312 d.s = s;
313 d.action = ACTION_INJECT_ERROR;
314 qemu_opts_foreach(&inject_error_opts, add_rule, &d, 0);
316 d.action = ACTION_SET_STATE;
317 qemu_opts_foreach(&set_state_opts, add_rule, &d, 0);
319 ret = 0;
320 fail:
321 qemu_opts_reset(&inject_error_opts);
322 qemu_opts_reset(&set_state_opts);
323 if (f) {
324 fclose(f);
326 return ret;
329 /* Valid blkdebug filenames look like blkdebug:path/to/config:path/to/image */
330 static void blkdebug_parse_filename(const char *filename, QDict *options,
331 Error **errp)
333 const char *c;
335 /* Parse the blkdebug: prefix */
336 if (!strstart(filename, "blkdebug:", &filename)) {
337 /* There was no prefix; therefore, all options have to be already
338 present in the QDict (except for the filename) */
339 qdict_put(options, "x-image", qstring_from_str(filename));
340 return;
343 /* Parse config file path */
344 c = strchr(filename, ':');
345 if (c == NULL) {
346 error_setg(errp, "blkdebug requires both config file and image path");
347 return;
350 if (c != filename) {
351 QString *config_path;
352 config_path = qstring_from_substr(filename, 0, c - filename - 1);
353 qdict_put(options, "config", config_path);
356 /* TODO Allow multi-level nesting and set file.filename here */
357 filename = c + 1;
358 qdict_put(options, "x-image", qstring_from_str(filename));
361 static QemuOptsList runtime_opts = {
362 .name = "blkdebug",
363 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
364 .desc = {
366 .name = "config",
367 .type = QEMU_OPT_STRING,
368 .help = "Path to the configuration file",
371 .name = "x-image",
372 .type = QEMU_OPT_STRING,
373 .help = "[internal use only, will be removed]",
376 .name = "align",
377 .type = QEMU_OPT_SIZE,
378 .help = "Required alignment in bytes",
380 { /* end of list */ }
384 static int blkdebug_open(BlockDriverState *bs, QDict *options, int flags,
385 Error **errp)
387 BDRVBlkdebugState *s = bs->opaque;
388 QemuOpts *opts;
389 Error *local_err = NULL;
390 const char *config;
391 uint64_t align;
392 int ret;
394 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
395 qemu_opts_absorb_qdict(opts, options, &local_err);
396 if (local_err) {
397 error_propagate(errp, local_err);
398 ret = -EINVAL;
399 goto out;
402 /* Read rules from config file or command line options */
403 config = qemu_opt_get(opts, "config");
404 ret = read_config(s, config, options, errp);
405 if (ret) {
406 goto out;
409 /* Set initial state */
410 s->state = 1;
412 /* Open the backing file */
413 assert(bs->file == NULL);
414 ret = bdrv_open_image(&bs->file, qemu_opt_get(opts, "x-image"), options, "image",
415 flags | BDRV_O_PROTOCOL, false, &local_err);
416 if (ret < 0) {
417 error_propagate(errp, local_err);
418 goto out;
421 /* Set request alignment */
422 align = qemu_opt_get_size(opts, "align", bs->request_alignment);
423 if (align > 0 && align < INT_MAX && !(align & (align - 1))) {
424 bs->request_alignment = align;
425 } else {
426 error_setg(errp, "Invalid alignment");
427 ret = -EINVAL;
428 goto fail_unref;
431 ret = 0;
432 goto out;
434 fail_unref:
435 bdrv_unref(bs->file);
436 out:
437 qemu_opts_del(opts);
438 return ret;
441 static void error_callback_bh(void *opaque)
443 struct BlkdebugAIOCB *acb = opaque;
444 qemu_bh_delete(acb->bh);
445 acb->common.cb(acb->common.opaque, acb->ret);
446 qemu_aio_release(acb);
449 static void blkdebug_aio_cancel(BlockDriverAIOCB *blockacb)
451 BlkdebugAIOCB *acb = container_of(blockacb, BlkdebugAIOCB, common);
452 qemu_aio_release(acb);
455 static BlockDriverAIOCB *inject_error(BlockDriverState *bs,
456 BlockDriverCompletionFunc *cb, void *opaque, BlkdebugRule *rule)
458 BDRVBlkdebugState *s = bs->opaque;
459 int error = rule->options.inject.error;
460 struct BlkdebugAIOCB *acb;
461 QEMUBH *bh;
463 if (rule->options.inject.once) {
464 QSIMPLEQ_INIT(&s->active_rules);
467 if (rule->options.inject.immediately) {
468 return NULL;
471 acb = qemu_aio_get(&blkdebug_aiocb_info, bs, cb, opaque);
472 acb->ret = -error;
474 bh = aio_bh_new(bdrv_get_aio_context(bs), error_callback_bh, acb);
475 acb->bh = bh;
476 qemu_bh_schedule(bh);
478 return &acb->common;
481 static BlockDriverAIOCB *blkdebug_aio_readv(BlockDriverState *bs,
482 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
483 BlockDriverCompletionFunc *cb, void *opaque)
485 BDRVBlkdebugState *s = bs->opaque;
486 BlkdebugRule *rule = NULL;
488 QSIMPLEQ_FOREACH(rule, &s->active_rules, active_next) {
489 if (rule->options.inject.sector == -1 ||
490 (rule->options.inject.sector >= sector_num &&
491 rule->options.inject.sector < sector_num + nb_sectors)) {
492 break;
496 if (rule && rule->options.inject.error) {
497 return inject_error(bs, cb, opaque, rule);
500 return bdrv_aio_readv(bs->file, sector_num, qiov, nb_sectors, cb, opaque);
503 static BlockDriverAIOCB *blkdebug_aio_writev(BlockDriverState *bs,
504 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
505 BlockDriverCompletionFunc *cb, void *opaque)
507 BDRVBlkdebugState *s = bs->opaque;
508 BlkdebugRule *rule = NULL;
510 QSIMPLEQ_FOREACH(rule, &s->active_rules, active_next) {
511 if (rule->options.inject.sector == -1 ||
512 (rule->options.inject.sector >= sector_num &&
513 rule->options.inject.sector < sector_num + nb_sectors)) {
514 break;
518 if (rule && rule->options.inject.error) {
519 return inject_error(bs, cb, opaque, rule);
522 return bdrv_aio_writev(bs->file, sector_num, qiov, nb_sectors, cb, opaque);
526 static void blkdebug_close(BlockDriverState *bs)
528 BDRVBlkdebugState *s = bs->opaque;
529 BlkdebugRule *rule, *next;
530 int i;
532 for (i = 0; i < BLKDBG_EVENT_MAX; i++) {
533 QLIST_FOREACH_SAFE(rule, &s->rules[i], next, next) {
534 remove_rule(rule);
539 static void suspend_request(BlockDriverState *bs, BlkdebugRule *rule)
541 BDRVBlkdebugState *s = bs->opaque;
542 BlkdebugSuspendedReq r;
544 r = (BlkdebugSuspendedReq) {
545 .co = qemu_coroutine_self(),
546 .tag = g_strdup(rule->options.suspend.tag),
549 remove_rule(rule);
550 QLIST_INSERT_HEAD(&s->suspended_reqs, &r, next);
552 printf("blkdebug: Suspended request '%s'\n", r.tag);
553 qemu_coroutine_yield();
554 printf("blkdebug: Resuming request '%s'\n", r.tag);
556 QLIST_REMOVE(&r, next);
557 g_free(r.tag);
560 static bool process_rule(BlockDriverState *bs, struct BlkdebugRule *rule,
561 bool injected)
563 BDRVBlkdebugState *s = bs->opaque;
565 /* Only process rules for the current state */
566 if (rule->state && rule->state != s->state) {
567 return injected;
570 /* Take the action */
571 switch (rule->action) {
572 case ACTION_INJECT_ERROR:
573 if (!injected) {
574 QSIMPLEQ_INIT(&s->active_rules);
575 injected = true;
577 QSIMPLEQ_INSERT_HEAD(&s->active_rules, rule, active_next);
578 break;
580 case ACTION_SET_STATE:
581 s->new_state = rule->options.set_state.new_state;
582 break;
584 case ACTION_SUSPEND:
585 suspend_request(bs, rule);
586 break;
588 return injected;
591 static void blkdebug_debug_event(BlockDriverState *bs, BlkDebugEvent event)
593 BDRVBlkdebugState *s = bs->opaque;
594 struct BlkdebugRule *rule, *next;
595 bool injected;
597 assert((int)event >= 0 && event < BLKDBG_EVENT_MAX);
599 injected = false;
600 s->new_state = s->state;
601 QLIST_FOREACH_SAFE(rule, &s->rules[event], next, next) {
602 injected = process_rule(bs, rule, injected);
604 s->state = s->new_state;
607 static int blkdebug_debug_breakpoint(BlockDriverState *bs, const char *event,
608 const char *tag)
610 BDRVBlkdebugState *s = bs->opaque;
611 struct BlkdebugRule *rule;
612 BlkDebugEvent blkdebug_event;
614 if (get_event_by_name(event, &blkdebug_event) < 0) {
615 return -ENOENT;
619 rule = g_malloc(sizeof(*rule));
620 *rule = (struct BlkdebugRule) {
621 .event = blkdebug_event,
622 .action = ACTION_SUSPEND,
623 .state = 0,
624 .options.suspend.tag = g_strdup(tag),
627 QLIST_INSERT_HEAD(&s->rules[blkdebug_event], rule, next);
629 return 0;
632 static int blkdebug_debug_resume(BlockDriverState *bs, const char *tag)
634 BDRVBlkdebugState *s = bs->opaque;
635 BlkdebugSuspendedReq *r, *next;
637 QLIST_FOREACH_SAFE(r, &s->suspended_reqs, next, next) {
638 if (!strcmp(r->tag, tag)) {
639 qemu_coroutine_enter(r->co, NULL);
640 return 0;
643 return -ENOENT;
646 static int blkdebug_debug_remove_breakpoint(BlockDriverState *bs,
647 const char *tag)
649 BDRVBlkdebugState *s = bs->opaque;
650 BlkdebugSuspendedReq *r, *r_next;
651 BlkdebugRule *rule, *next;
652 int i, ret = -ENOENT;
654 for (i = 0; i < BLKDBG_EVENT_MAX; i++) {
655 QLIST_FOREACH_SAFE(rule, &s->rules[i], next, next) {
656 if (rule->action == ACTION_SUSPEND &&
657 !strcmp(rule->options.suspend.tag, tag)) {
658 remove_rule(rule);
659 ret = 0;
663 QLIST_FOREACH_SAFE(r, &s->suspended_reqs, next, r_next) {
664 if (!strcmp(r->tag, tag)) {
665 qemu_coroutine_enter(r->co, NULL);
666 ret = 0;
669 return ret;
672 static bool blkdebug_debug_is_suspended(BlockDriverState *bs, const char *tag)
674 BDRVBlkdebugState *s = bs->opaque;
675 BlkdebugSuspendedReq *r;
677 QLIST_FOREACH(r, &s->suspended_reqs, next) {
678 if (!strcmp(r->tag, tag)) {
679 return true;
682 return false;
685 static int64_t blkdebug_getlength(BlockDriverState *bs)
687 return bdrv_getlength(bs->file);
690 static BlockDriver bdrv_blkdebug = {
691 .format_name = "blkdebug",
692 .protocol_name = "blkdebug",
693 .instance_size = sizeof(BDRVBlkdebugState),
695 .bdrv_parse_filename = blkdebug_parse_filename,
696 .bdrv_file_open = blkdebug_open,
697 .bdrv_close = blkdebug_close,
698 .bdrv_getlength = blkdebug_getlength,
700 .bdrv_aio_readv = blkdebug_aio_readv,
701 .bdrv_aio_writev = blkdebug_aio_writev,
703 .bdrv_debug_event = blkdebug_debug_event,
704 .bdrv_debug_breakpoint = blkdebug_debug_breakpoint,
705 .bdrv_debug_remove_breakpoint
706 = blkdebug_debug_remove_breakpoint,
707 .bdrv_debug_resume = blkdebug_debug_resume,
708 .bdrv_debug_is_suspended = blkdebug_debug_is_suspended,
711 static void bdrv_blkdebug_init(void)
713 bdrv_register(&bdrv_blkdebug);
716 block_init(bdrv_blkdebug_init);