block/blkdebug.c

   1 /*
   2  * Block protocol for I/O error injection
   3  *
   4  * Copyright (c) 2010 Kevin Wolf <kwolf@redhat.com>
   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 "qemu/config-file.h"
  27 #include "block/block_int.h"
  28 #include "qemu/module.h"
  29 #include "qapi/qmp/qbool.h"
  30 #include "qapi/qmp/qdict.h"
  31 #include "qapi/qmp/qint.h"
  32 #include "qapi/qmp/qstring.h"
  33
  34 typedef struct BDRVBlkdebugState {
  35     int state;
  36     int new_state;
  37
  38     QLIST_HEAD(, BlkdebugRule) rules[BLKDBG_EVENT_MAX];
  39     QSIMPLEQ_HEAD(, BlkdebugRule) active_rules;
  40     QLIST_HEAD(, BlkdebugSuspendedReq) suspended_reqs;
  41 } BDRVBlkdebugState;
  42
  43 typedef struct BlkdebugAIOCB {
  44     BlockDriverAIOCB common;
  45     QEMUBH *bh;
  46     int ret;
  47 } BlkdebugAIOCB;
  48
  49 typedef struct BlkdebugSuspendedReq {
  50     Coroutine *co;
  51     char *tag;
  52     QLIST_ENTRY(BlkdebugSuspendedReq) next;
  53 } BlkdebugSuspendedReq;
  54
  55 static void blkdebug_aio_cancel(BlockDriverAIOCB *blockacb);
  56
  57 static const AIOCBInfo blkdebug_aiocb_info = {
  58     .aiocb_size = sizeof(BlkdebugAIOCB),
  59     .cancel     = blkdebug_aio_cancel,
  60 };
  61
  62 enum {
  63     ACTION_INJECT_ERROR,
  64     ACTION_SET_STATE,
  65     ACTION_SUSPEND,
  66 };
  67
  68 typedef struct BlkdebugRule {
  69     BlkDebugEvent event;
  70     int action;
  71     int state;
  72     union {
  73         struct {
  74             int error;
  75             int immediately;
  76             int once;
  77             int64_t sector;
  78         } inject;
  79         struct {
  80             int new_state;
  81         } set_state;
  82         struct {
  83             char *tag;
  84         } suspend;
  85     } options;
  86     QLIST_ENTRY(BlkdebugRule) next;
  87     QSIMPLEQ_ENTRY(BlkdebugRule) active_next;
  88 } BlkdebugRule;
  89
  90 static QemuOptsList inject_error_opts = {
  91     .name = "inject-error",
  92     .head = QTAILQ_HEAD_INITIALIZER(inject_error_opts.head),
  93     .desc = {
  94         {
  95             .name = "event",
  96             .type = QEMU_OPT_STRING,
  97         },
  98         {
  99             .name = "state",
 100             .type = QEMU_OPT_NUMBER,
 101         },
 102         {
 103             .name = "errno",
 104             .type = QEMU_OPT_NUMBER,
 105         },
 106         {
 107             .name = "sector",
 108             .type = QEMU_OPT_NUMBER,
 109         },
 110         {
 111             .name = "once",
 112             .type = QEMU_OPT_BOOL,
 113         },
 114         {
 115             .name = "immediately",
 116             .type = QEMU_OPT_BOOL,
 117         },
 118         { /* end of list */ }
 119     },
 120 };
 121
 122 static QemuOptsList set_state_opts = {
 123     .name = "set-state",
 124     .head = QTAILQ_HEAD_INITIALIZER(set_state_opts.head),
 125     .desc = {
 126         {
 127             .name = "event",
 128             .type = QEMU_OPT_STRING,
 129         },
 130         {
 131             .name = "state",
 132             .type = QEMU_OPT_NUMBER,
 133         },
 134         {
 135             .name = "new_state",
 136             .type = QEMU_OPT_NUMBER,
 137         },
 138         { /* end of list */ }
 139     },
 140 };
 141
 142 static QemuOptsList *config_groups[] = {
 143     &inject_error_opts,
 144     &set_state_opts,
 145     NULL
 146 };
 147
 148 static const char *event_names[BLKDBG_EVENT_MAX] = {
 149     [BLKDBG_L1_UPDATE]                      = "l1_update",
 150     [BLKDBG_L1_GROW_ALLOC_TABLE]            = "l1_grow.alloc_table",
 151     [BLKDBG_L1_GROW_WRITE_TABLE]            = "l1_grow.write_table",
 152     [BLKDBG_L1_GROW_ACTIVATE_TABLE]         = "l1_grow.activate_table",
 153
 154     [BLKDBG_L2_LOAD]                        = "l2_load",
 155     [BLKDBG_L2_UPDATE]                      = "l2_update",
 156     [BLKDBG_L2_UPDATE_COMPRESSED]           = "l2_update_compressed",
 157     [BLKDBG_L2_ALLOC_COW_READ]              = "l2_alloc.cow_read",
 158     [BLKDBG_L2_ALLOC_WRITE]                 = "l2_alloc.write",
 159
 160     [BLKDBG_READ_AIO]                       = "read_aio",
 161     [BLKDBG_READ_BACKING_AIO]               = "read_backing_aio",
 162     [BLKDBG_READ_COMPRESSED]                = "read_compressed",
 163
 164     [BLKDBG_WRITE_AIO]                      = "write_aio",
 165     [BLKDBG_WRITE_COMPRESSED]               = "write_compressed",
 166
 167     [BLKDBG_VMSTATE_LOAD]                   = "vmstate_load",
 168     [BLKDBG_VMSTATE_SAVE]                   = "vmstate_save",
 169
 170     [BLKDBG_COW_READ]                       = "cow_read",
 171     [BLKDBG_COW_WRITE]                      = "cow_write",
 172
 173     [BLKDBG_REFTABLE_LOAD]                  = "reftable_load",
 174     [BLKDBG_REFTABLE_GROW]                  = "reftable_grow",
 175     [BLKDBG_REFTABLE_UPDATE]                = "reftable_update",
 176
 177     [BLKDBG_REFBLOCK_LOAD]                  = "refblock_load",
 178     [BLKDBG_REFBLOCK_UPDATE]                = "refblock_update",
 179     [BLKDBG_REFBLOCK_UPDATE_PART]           = "refblock_update_part",
 180     [BLKDBG_REFBLOCK_ALLOC]                 = "refblock_alloc",
 181     [BLKDBG_REFBLOCK_ALLOC_HOOKUP]          = "refblock_alloc.hookup",
 182     [BLKDBG_REFBLOCK_ALLOC_WRITE]           = "refblock_alloc.write",
 183     [BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS]    = "refblock_alloc.write_blocks",
 184     [BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE]     = "refblock_alloc.write_table",
 185     [BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE]    = "refblock_alloc.switch_table",
 186
 187     [BLKDBG_CLUSTER_ALLOC]                  = "cluster_alloc",
 188     [BLKDBG_CLUSTER_ALLOC_BYTES]            = "cluster_alloc_bytes",
 189     [BLKDBG_CLUSTER_FREE]                   = "cluster_free",
 190
 191     [BLKDBG_FLUSH_TO_OS]                    = "flush_to_os",
 192     [BLKDBG_FLUSH_TO_DISK]                  = "flush_to_disk",
 193
 194     [BLKDBG_PWRITEV_RMW_HEAD]               = "pwritev_rmw.head",
 195     [BLKDBG_PWRITEV_RMW_AFTER_HEAD]         = "pwritev_rmw.after_head",
 196     [BLKDBG_PWRITEV_RMW_TAIL]               = "pwritev_rmw.tail",
 197     [BLKDBG_PWRITEV_RMW_AFTER_TAIL]         = "pwritev_rmw.after_tail",
 198     [BLKDBG_PWRITEV]                        = "pwritev",
 199     [BLKDBG_PWRITEV_ZERO]                   = "pwritev_zero",
 200     [BLKDBG_PWRITEV_DONE]                   = "pwritev_done",
 201 };
 202
 203 static int get_event_by_name(const char *name, BlkDebugEvent *event)
 204 {
 205     int i;
 206
 207     for (i = 0; i < BLKDBG_EVENT_MAX; i++) {
 208         if (!strcmp(event_names[i], name)) {
 209             *event = i;
 210             return 0;
 211         }
 212     }
 213
 214     return -1;
 215 }
 216
 217 struct add_rule_data {
 218     BDRVBlkdebugState *s;
 219     int action;
 220 };
 221
 222 static int add_rule(QemuOpts *opts, void *opaque)
 223 {
 224     struct add_rule_data *d = opaque;
 225     BDRVBlkdebugState *s = d->s;
 226     const char* event_name;
 227     BlkDebugEvent event;
 228     struct BlkdebugRule *rule;
 229
 230     /* Find the right event for the rule */
 231     event_name = qemu_opt_get(opts, "event");
 232     if (!event_name || get_event_by_name(event_name, &event) < 0) {
 233         return -1;
 234     }
 235
 236     /* Set attributes common for all actions */
 237     rule = g_malloc0(sizeof(*rule));
 238     *rule = (struct BlkdebugRule) {
 239         .event  = event,
 240         .action = d->action,
 241         .state  = qemu_opt_get_number(opts, "state", 0),
 242     };
 243
 244     /* Parse action-specific options */
 245     switch (d->action) {
 246     case ACTION_INJECT_ERROR:
 247         rule->options.inject.error = qemu_opt_get_number(opts, "errno", EIO);
 248         rule->options.inject.once  = qemu_opt_get_bool(opts, "once", 0);
 249         rule->options.inject.immediately =
 250             qemu_opt_get_bool(opts, "immediately", 0);
 251         rule->options.inject.sector = qemu_opt_get_number(opts, "sector", -1);
 252         break;
 253
 254     case ACTION_SET_STATE:
 255         rule->options.set_state.new_state =
 256             qemu_opt_get_number(opts, "new_state", 0);
 257         break;
 258
 259     case ACTION_SUSPEND:
 260         rule->options.suspend.tag =
 261             g_strdup(qemu_opt_get(opts, "tag"));
 262         break;
 263     };
 264
 265     /* Add the rule */
 266     QLIST_INSERT_HEAD(&s->rules[event], rule, next);
 267
 268     return 0;
 269 }
 270
 271 static void remove_rule(BlkdebugRule *rule)
 272 {
 273     switch (rule->action) {
 274     case ACTION_INJECT_ERROR:
 275     case ACTION_SET_STATE:
 276         break;
 277     case ACTION_SUSPEND:
 278         g_free(rule->options.suspend.tag);
 279         break;
 280     }
 281
 282     QLIST_REMOVE(rule, next);
 283     g_free(rule);
 284 }
 285
 286 static int read_config(BDRVBlkdebugState *s, const char *filename,
 287                        QDict *options, Error **errp)
 288 {
 289     FILE *f = NULL;
 290     int ret;
 291     struct add_rule_data d;
 292     Error *local_err = NULL;
 293
 294     if (filename) {
 295         f = fopen(filename, "r");
 296         if (f == NULL) {
 297             error_setg_errno(errp, errno, "Could not read blkdebug config file");
 298             return -errno;
 299         }
 300
 301         ret = qemu_config_parse(f, config_groups, filename);
 302         if (ret < 0) {
 303             error_setg(errp, "Could not parse blkdebug config file");
 304             ret = -EINVAL;
 305             goto fail;
 306         }
 307     }
 308
 309     qemu_config_parse_qdict(options, config_groups, &local_err);
 310     if (local_err) {
 311         error_propagate(errp, local_err);
 312         ret = -EINVAL;
 313         goto fail;
 314     }
 315
 316     d.s = s;
 317     d.action = ACTION_INJECT_ERROR;
 318     qemu_opts_foreach(&inject_error_opts, add_rule, &d, 0);
 319
 320     d.action = ACTION_SET_STATE;
 321     qemu_opts_foreach(&set_state_opts, add_rule, &d, 0);
 322
 323     ret = 0;
 324 fail:
 325     qemu_opts_reset(&inject_error_opts);
 326     qemu_opts_reset(&set_state_opts);
 327     if (f) {
 328         fclose(f);
 329     }
 330     return ret;
 331 }
 332
 333 /* Valid blkdebug filenames look like blkdebug:path/to/config:path/to/image */
 334 static void blkdebug_parse_filename(const char *filename, QDict *options,
 335                                     Error **errp)
 336 {
 337     const char *c;
 338
 339     /* Parse the blkdebug: prefix */
 340     if (!strstart(filename, "blkdebug:", &filename)) {
 341         /* There was no prefix; therefore, all options have to be already
 342            present in the QDict (except for the filename) */
 343         qdict_put(options, "x-image", qstring_from_str(filename));
 344         return;
 345     }
 346
 347     /* Parse config file path */
 348     c = strchr(filename, ':');
 349     if (c == NULL) {
 350         error_setg(errp, "blkdebug requires both config file and image path");
 351         return;
 352     }
 353
 354     if (c != filename) {
 355         QString *config_path;
 356         config_path = qstring_from_substr(filename, 0, c - filename - 1);
 357         qdict_put(options, "config", config_path);
 358     }
 359
 360     /* TODO Allow multi-level nesting and set file.filename here */
 361     filename = c + 1;
 362     qdict_put(options, "x-image", qstring_from_str(filename));
 363 }
 364
 365 static QemuOptsList runtime_opts = {
 366     .name = "blkdebug",
 367     .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
 368     .desc = {
 369         {
 370             .name = "config",
 371             .type = QEMU_OPT_STRING,
 372             .help = "Path to the configuration file",
 373         },
 374         {
 375             .name = "x-image",
 376             .type = QEMU_OPT_STRING,
 377             .help = "[internal use only, will be removed]",
 378         },
 379         {
 380             .name = "align",
 381             .type = QEMU_OPT_SIZE,
 382             .help = "Required alignment in bytes",
 383         },
 384         { /* end of list */ }
 385     },
 386 };
 387
 388 static int blkdebug_open(BlockDriverState *bs, QDict *options, int flags,
 389                          Error **errp)
 390 {
 391     BDRVBlkdebugState *s = bs->opaque;
 392     QemuOpts *opts;
 393     Error *local_err = NULL;
 394     const char *config;
 395     uint64_t align;
 396     int ret;
 397
 398     opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
 399     qemu_opts_absorb_qdict(opts, options, &local_err);
 400     if (local_err) {
 401         error_propagate(errp, local_err);
 402         ret = -EINVAL;
 403         goto out;
 404     }
 405
 406     /* Read rules from config file or command line options */
 407     config = qemu_opt_get(opts, "config");
 408     ret = read_config(s, config, options, errp);
 409     if (ret) {
 410         goto out;
 411     }
 412
 413     /* Set initial state */
 414     s->state = 1;
 415
 416     /* Open the backing file */
 417     assert(bs->file == NULL);
 418     ret = bdrv_open_image(&bs->file, qemu_opt_get(opts, "x-image"), options, "image",
 419                           flags | BDRV_O_PROTOCOL, false, &local_err);
 420     if (ret < 0) {
 421         error_propagate(errp, local_err);
 422         goto out;
 423     }
 424
 425     /* Set request alignment */
 426     align = qemu_opt_get_size(opts, "align", bs->request_alignment);
 427     if (align > 0 && align < INT_MAX && !(align & (align - 1))) {
 428         bs->request_alignment = align;
 429     } else {
 430         error_setg(errp, "Invalid alignment");
 431         ret = -EINVAL;
 432         goto fail_unref;
 433     }
 434
 435     ret = 0;
 436     goto out;
 437
 438 fail_unref:
 439     bdrv_unref(bs->file);
 440 out:
 441     qemu_opts_del(opts);
 442     return ret;
 443 }
 444
 445 static void error_callback_bh(void *opaque)
 446 {
 447     struct BlkdebugAIOCB *acb = opaque;
 448     qemu_bh_delete(acb->bh);
 449     acb->common.cb(acb->common.opaque, acb->ret);
 450     qemu_aio_release(acb);
 451 }
 452
 453 static void blkdebug_aio_cancel(BlockDriverAIOCB *blockacb)
 454 {
 455     BlkdebugAIOCB *acb = container_of(blockacb, BlkdebugAIOCB, common);
 456     qemu_aio_release(acb);
 457 }
 458
 459 static BlockDriverAIOCB *inject_error(BlockDriverState *bs,
 460     BlockDriverCompletionFunc *cb, void *opaque, BlkdebugRule *rule)
 461 {
 462     BDRVBlkdebugState *s = bs->opaque;
 463     int error = rule->options.inject.error;
 464     struct BlkdebugAIOCB *acb;
 465     QEMUBH *bh;
 466
 467     if (rule->options.inject.once) {
 468         QSIMPLEQ_INIT(&s->active_rules);
 469     }
 470
 471     if (rule->options.inject.immediately) {
 472         return NULL;
 473     }
 474
 475     acb = qemu_aio_get(&blkdebug_aiocb_info, bs, cb, opaque);
 476     acb->ret = -error;
 477
 478     bh = aio_bh_new(bdrv_get_aio_context(bs), error_callback_bh, acb);
 479     acb->bh = bh;
 480     qemu_bh_schedule(bh);
 481
 482     return &acb->common;
 483 }
 484
 485 static BlockDriverAIOCB *blkdebug_aio_readv(BlockDriverState *bs,
 486     int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
 487     BlockDriverCompletionFunc *cb, void *opaque)
 488 {
 489     BDRVBlkdebugState *s = bs->opaque;
 490     BlkdebugRule *rule = NULL;
 491
 492     QSIMPLEQ_FOREACH(rule, &s->active_rules, active_next) {
 493         if (rule->options.inject.sector == -1 ||
 494             (rule->options.inject.sector >= sector_num &&
 495              rule->options.inject.sector < sector_num + nb_sectors)) {
 496             break;
 497         }
 498     }
 499
 500     if (rule && rule->options.inject.error) {
 501         return inject_error(bs, cb, opaque, rule);
 502     }
 503
 504     return bdrv_aio_readv(bs->file, sector_num, qiov, nb_sectors, cb, opaque);
 505 }
 506
 507 static BlockDriverAIOCB *blkdebug_aio_writev(BlockDriverState *bs,
 508     int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
 509     BlockDriverCompletionFunc *cb, void *opaque)
 510 {
 511     BDRVBlkdebugState *s = bs->opaque;
 512     BlkdebugRule *rule = NULL;
 513
 514     QSIMPLEQ_FOREACH(rule, &s->active_rules, active_next) {
 515         if (rule->options.inject.sector == -1 ||
 516             (rule->options.inject.sector >= sector_num &&
 517              rule->options.inject.sector < sector_num + nb_sectors)) {
 518             break;
 519         }
 520     }
 521
 522     if (rule && rule->options.inject.error) {
 523         return inject_error(bs, cb, opaque, rule);
 524     }
 525
 526     return bdrv_aio_writev(bs->file, sector_num, qiov, nb_sectors, cb, opaque);
 527 }
 528
 529 static BlockDriverAIOCB *blkdebug_aio_flush(BlockDriverState *bs,
 530     BlockDriverCompletionFunc *cb, void *opaque)
 531 {
 532     BDRVBlkdebugState *s = bs->opaque;
 533     BlkdebugRule *rule = NULL;
 534
 535     QSIMPLEQ_FOREACH(rule, &s->active_rules, active_next) {
 536         if (rule->options.inject.sector == -1) {
 537             break;
 538         }
 539     }
 540
 541     if (rule && rule->options.inject.error) {
 542         return inject_error(bs, cb, opaque, rule);
 543     }
 544
 545     return bdrv_aio_flush(bs->file, cb, opaque);
 546 }
 547
 548
 549 static void blkdebug_close(BlockDriverState *bs)
 550 {
 551     BDRVBlkdebugState *s = bs->opaque;
 552     BlkdebugRule *rule, *next;
 553     int i;
 554
 555     for (i = 0; i < BLKDBG_EVENT_MAX; i++) {
 556         QLIST_FOREACH_SAFE(rule, &s->rules[i], next, next) {
 557             remove_rule(rule);
 558         }
 559     }
 560 }
 561
 562 static void suspend_request(BlockDriverState *bs, BlkdebugRule *rule)
 563 {
 564     BDRVBlkdebugState *s = bs->opaque;
 565     BlkdebugSuspendedReq r;
 566
 567     r = (BlkdebugSuspendedReq) {
 568         .co         = qemu_coroutine_self(),
 569         .tag        = g_strdup(rule->options.suspend.tag),
 570     };
 571
 572     remove_rule(rule);
 573     QLIST_INSERT_HEAD(&s->suspended_reqs, &r, next);
 574
 575     printf("blkdebug: Suspended request '%s'\n", r.tag);
 576     qemu_coroutine_yield();
 577     printf("blkdebug: Resuming request '%s'\n", r.tag);
 578
 579     QLIST_REMOVE(&r, next);
 580     g_free(r.tag);
 581 }
 582
 583 static bool process_rule(BlockDriverState *bs, struct BlkdebugRule *rule,
 584     bool injected)
 585 {
 586     BDRVBlkdebugState *s = bs->opaque;
 587
 588     /* Only process rules for the current state */
 589     if (rule->state && rule->state != s->state) {
 590         return injected;
 591     }
 592
 593     /* Take the action */
 594     switch (rule->action) {
 595     case ACTION_INJECT_ERROR:
 596         if (!injected) {
 597             QSIMPLEQ_INIT(&s->active_rules);
 598             injected = true;
 599         }
 600         QSIMPLEQ_INSERT_HEAD(&s->active_rules, rule, active_next);
 601         break;
 602
 603     case ACTION_SET_STATE:
 604         s->new_state = rule->options.set_state.new_state;
 605         break;
 606
 607     case ACTION_SUSPEND:
 608         suspend_request(bs, rule);
 609         break;
 610     }
 611     return injected;
 612 }
 613
 614 static void blkdebug_debug_event(BlockDriverState *bs, BlkDebugEvent event)
 615 {
 616     BDRVBlkdebugState *s = bs->opaque;
 617     struct BlkdebugRule *rule, *next;
 618     bool injected;
 619
 620     assert((int)event >= 0 && event < BLKDBG_EVENT_MAX);
 621
 622     injected = false;
 623     s->new_state = s->state;
 624     QLIST_FOREACH_SAFE(rule, &s->rules[event], next, next) {
 625         injected = process_rule(bs, rule, injected);
 626     }
 627     s->state = s->new_state;
 628 }
 629
 630 static int blkdebug_debug_breakpoint(BlockDriverState *bs, const char *event,
 631                                      const char *tag)
 632 {
 633     BDRVBlkdebugState *s = bs->opaque;
 634     struct BlkdebugRule *rule;
 635     BlkDebugEvent blkdebug_event;
 636
 637     if (get_event_by_name(event, &blkdebug_event) < 0) {
 638         return -ENOENT;
 639     }
 640
 641
 642     rule = g_malloc(sizeof(*rule));
 643     *rule = (struct BlkdebugRule) {
 644         .event  = blkdebug_event,
 645         .action = ACTION_SUSPEND,
 646         .state  = 0,
 647         .options.suspend.tag = g_strdup(tag),
 648     };
 649
 650     QLIST_INSERT_HEAD(&s->rules[blkdebug_event], rule, next);
 651
 652     return 0;
 653 }
 654
 655 static int blkdebug_debug_resume(BlockDriverState *bs, const char *tag)
 656 {
 657     BDRVBlkdebugState *s = bs->opaque;
 658     BlkdebugSuspendedReq *r, *next;
 659
 660     QLIST_FOREACH_SAFE(r, &s->suspended_reqs, next, next) {
 661         if (!strcmp(r->tag, tag)) {
 662             qemu_coroutine_enter(r->co, NULL);
 663             return 0;
 664         }
 665     }
 666     return -ENOENT;
 667 }
 668
 669 static int blkdebug_debug_remove_breakpoint(BlockDriverState *bs,
 670                                             const char *tag)
 671 {
 672     BDRVBlkdebugState *s = bs->opaque;
 673     BlkdebugSuspendedReq *r, *r_next;
 674     BlkdebugRule *rule, *next;
 675     int i, ret = -ENOENT;
 676
 677     for (i = 0; i < BLKDBG_EVENT_MAX; i++) {
 678         QLIST_FOREACH_SAFE(rule, &s->rules[i], next, next) {
 679             if (rule->action == ACTION_SUSPEND &&
 680                 !strcmp(rule->options.suspend.tag, tag)) {
 681                 remove_rule(rule);
 682                 ret = 0;
 683             }
 684         }
 685     }
 686     QLIST_FOREACH_SAFE(r, &s->suspended_reqs, next, r_next) {
 687         if (!strcmp(r->tag, tag)) {
 688             qemu_coroutine_enter(r->co, NULL);
 689             ret = 0;
 690         }
 691     }
 692     return ret;
 693 }
 694
 695 static bool blkdebug_debug_is_suspended(BlockDriverState *bs, const char *tag)
 696 {
 697     BDRVBlkdebugState *s = bs->opaque;
 698     BlkdebugSuspendedReq *r;
 699
 700     QLIST_FOREACH(r, &s->suspended_reqs, next) {
 701         if (!strcmp(r->tag, tag)) {
 702             return true;
 703         }
 704     }
 705     return false;
 706 }
 707
 708 static int64_t blkdebug_getlength(BlockDriverState *bs)
 709 {
 710     return bdrv_getlength(bs->file);
 711 }
 712
 713 static void blkdebug_refresh_filename(BlockDriverState *bs)
 714 {
 715     BDRVBlkdebugState *s = bs->opaque;
 716     struct BlkdebugRule *rule;
 717     QDict *opts;
 718     QList *inject_error_list = NULL, *set_state_list = NULL;
 719     QList *suspend_list = NULL;
 720     int event;
 721
 722     if (!bs->file->full_open_options) {
 723         /* The config file cannot be recreated, so creating a plain filename
 724          * is impossible */
 725         return;
 726     }
 727
 728     opts = qdict_new();
 729     qdict_put_obj(opts, "driver", QOBJECT(qstring_from_str("blkdebug")));
 730
 731     QINCREF(bs->file->full_open_options);
 732     qdict_put_obj(opts, "image", QOBJECT(bs->file->full_open_options));
 733
 734     for (event = 0; event < BLKDBG_EVENT_MAX; event++) {
 735         QLIST_FOREACH(rule, &s->rules[event], next) {
 736             if (rule->action == ACTION_INJECT_ERROR) {
 737                 QDict *inject_error = qdict_new();
 738
 739                 qdict_put_obj(inject_error, "event", QOBJECT(qstring_from_str(
 740                               BlkdebugEvent_lookup[rule->event])));
 741                 qdict_put_obj(inject_error, "state",
 742                               QOBJECT(qint_from_int(rule->state)));
 743                 qdict_put_obj(inject_error, "errno", QOBJECT(qint_from_int(
 744                               rule->options.inject.error)));
 745                 qdict_put_obj(inject_error, "sector", QOBJECT(qint_from_int(
 746                               rule->options.inject.sector)));
 747                 qdict_put_obj(inject_error, "once", QOBJECT(qbool_from_int(
 748                               rule->options.inject.once)));
 749                 qdict_put_obj(inject_error, "immediately",
 750                               QOBJECT(qbool_from_int(
 751                               rule->options.inject.immediately)));
 752
 753                 if (!inject_error_list) {
 754                     inject_error_list = qlist_new();
 755                 }
 756
 757                 qlist_append_obj(inject_error_list, QOBJECT(inject_error));
 758             } else if (rule->action == ACTION_SET_STATE) {
 759                 QDict *set_state = qdict_new();
 760
 761                 qdict_put_obj(set_state, "event", QOBJECT(qstring_from_str(
 762                               BlkdebugEvent_lookup[rule->event])));
 763                 qdict_put_obj(set_state, "state",
 764                               QOBJECT(qint_from_int(rule->state)));
 765                 qdict_put_obj(set_state, "new_state", QOBJECT(qint_from_int(
 766                               rule->options.set_state.new_state)));
 767
 768                 if (!set_state_list) {
 769                     set_state_list = qlist_new();
 770                 }
 771
 772                 qlist_append_obj(set_state_list, QOBJECT(set_state));
 773             } else if (rule->action == ACTION_SUSPEND) {
 774                 QDict *suspend = qdict_new();
 775
 776                 qdict_put_obj(suspend, "event", QOBJECT(qstring_from_str(
 777                               BlkdebugEvent_lookup[rule->event])));
 778                 qdict_put_obj(suspend, "state",
 779                               QOBJECT(qint_from_int(rule->state)));
 780                 qdict_put_obj(suspend, "tag", QOBJECT(qstring_from_str(
 781                               rule->options.suspend.tag)));
 782
 783                 if (!suspend_list) {
 784                     suspend_list = qlist_new();
 785                 }
 786
 787                 qlist_append_obj(suspend_list, QOBJECT(suspend));
 788             }
 789         }
 790     }
 791
 792     if (inject_error_list) {
 793         qdict_put_obj(opts, "inject-error", QOBJECT(inject_error_list));
 794     }
 795     if (set_state_list) {
 796         qdict_put_obj(opts, "set-state", QOBJECT(set_state_list));
 797     }
 798     if (suspend_list) {
 799         qdict_put_obj(opts, "suspend", QOBJECT(suspend_list));
 800     }
 801
 802     bs->full_open_options = opts;
 803 }
 804
 805 static BlockDriver bdrv_blkdebug = {
 806     .format_name            = "blkdebug",
 807     .protocol_name          = "blkdebug",
 808     .instance_size          = sizeof(BDRVBlkdebugState),
 809
 810     .bdrv_parse_filename    = blkdebug_parse_filename,
 811     .bdrv_file_open         = blkdebug_open,
 812     .bdrv_close             = blkdebug_close,
 813     .bdrv_getlength         = blkdebug_getlength,
 814     .bdrv_refresh_filename  = blkdebug_refresh_filename,
 815
 816     .bdrv_aio_readv         = blkdebug_aio_readv,
 817     .bdrv_aio_writev        = blkdebug_aio_writev,
 818     .bdrv_aio_flush         = blkdebug_aio_flush,
 819
 820     .bdrv_debug_event           = blkdebug_debug_event,
 821     .bdrv_debug_breakpoint      = blkdebug_debug_breakpoint,
 822     .bdrv_debug_remove_breakpoint
 823                                 = blkdebug_debug_remove_breakpoint,
 824     .bdrv_debug_resume          = blkdebug_debug_resume,
 825     .bdrv_debug_is_suspended    = blkdebug_debug_is_suspended,
 826 };
 827
 828 static void bdrv_blkdebug_init(void)
 829 {
 830     bdrv_register(&bdrv_blkdebug);
 831 }
 832
 833 block_init(bdrv_blkdebug_init);