blob: 5fe6172da98902056062cfb2fe490bd9841b5898 [file] [log] [blame]
Kevin Wolf6a143722010-02-18 17:48:12 +01001/*
2 * Block protocol for I/O error injection
3 *
Eric Blake63188c22017-04-29 14:14:16 -05004 * Copyright (C) 2016-2017 Red Hat, Inc.
Kevin Wolf6a143722010-02-18 17:48:12 +01005 * Copyright (c) 2010 Kevin Wolf <kwolf@redhat.com>
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 */
25
Peter Maydell80c71a22016-01-18 18:01:42 +000026#include "qemu/osdep.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010027#include "qapi/error.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020028#include "qemu/cutils.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010029#include "qemu/config-file.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010030#include "block/block_int.h"
Max Reitz69c64492019-11-08 13:34:53 +010031#include "block/qdict.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010032#include "qemu/module.h"
Markus Armbruster922a01a2018-02-01 12:18:46 +010033#include "qemu/option.h"
Max Reitz69c64492019-11-08 13:34:53 +010034#include "qapi/qapi-visit-block-core.h"
Max Reitz2c31b042014-07-18 20:24:57 +020035#include "qapi/qmp/qdict.h"
Max Reitz69c64492019-11-08 13:34:53 +010036#include "qapi/qmp/qlist.h"
Max Reitz2c31b042014-07-18 20:24:57 +020037#include "qapi/qmp/qstring.h"
Max Reitz69c64492019-11-08 13:34:53 +010038#include "qapi/qobject-input-visitor.h"
Michael S. Tsirkin20873522015-11-30 13:44:44 +020039#include "sysemu/qtest.h"
Kevin Wolf6a143722010-02-18 17:48:12 +010040
41typedef struct BDRVBlkdebugState {
Paolo Bonzini571cd432012-06-06 08:10:42 +020042 int state;
Paolo Bonzini8f96b5b2012-09-28 17:23:00 +020043 int new_state;
Eric Blake3dc834f2017-04-29 14:14:17 -050044 uint64_t align;
Eric Blake430b26a2017-04-29 14:14:18 -050045 uint64_t max_transfer;
46 uint64_t opt_write_zero;
47 uint64_t max_write_zero;
48 uint64_t opt_discard;
49 uint64_t max_discard;
Kevin Wolf3c90c652012-12-06 14:32:57 +010050
Max Reitz69c64492019-11-08 13:34:53 +010051 uint64_t take_child_perms;
52 uint64_t unshare_child_perms;
53
Max Reitz036990d2016-08-15 15:29:25 +020054 /* For blkdebug_refresh_filename() */
55 char *config_file;
56
Eric Blake7fb1cf12015-11-18 01:52:57 -070057 QLIST_HEAD(, BlkdebugRule) rules[BLKDBG__MAX];
Paolo Bonzini571cd432012-06-06 08:10:42 +020058 QSIMPLEQ_HEAD(, BlkdebugRule) active_rules;
Kevin Wolf3c90c652012-12-06 14:32:57 +010059 QLIST_HEAD(, BlkdebugSuspendedReq) suspended_reqs;
Kevin Wolf6a143722010-02-18 17:48:12 +010060} BDRVBlkdebugState;
61
Kevin Wolfb9f66d92010-02-19 16:24:35 +010062typedef struct BlkdebugAIOCB {
Markus Armbruster7c84b1b2014-10-07 13:59:14 +020063 BlockAIOCB common;
Kevin Wolfb9f66d92010-02-19 16:24:35 +010064 int ret;
65} BlkdebugAIOCB;
66
Kevin Wolf3c90c652012-12-06 14:32:57 +010067typedef struct BlkdebugSuspendedReq {
68 Coroutine *co;
69 char *tag;
70 QLIST_ENTRY(BlkdebugSuspendedReq) next;
71} BlkdebugSuspendedReq;
72
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +010073enum {
74 ACTION_INJECT_ERROR,
75 ACTION_SET_STATE,
Kevin Wolf3c90c652012-12-06 14:32:57 +010076 ACTION_SUSPEND,
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +010077};
78
79typedef struct BlkdebugRule {
Eric Blakea31939e2015-11-18 01:52:54 -070080 BlkdebugEvent event;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +010081 int action;
82 int state;
83 union {
84 struct {
Max Reitz16789db2019-05-07 22:35:04 +020085 uint64_t iotype_mask;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +010086 int error;
87 int immediately;
88 int once;
Kevin Wolf7c3a9982016-11-04 21:13:45 +010089 int64_t offset;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +010090 } inject;
91 struct {
92 int new_state;
93 } set_state;
Kevin Wolf3c90c652012-12-06 14:32:57 +010094 struct {
95 char *tag;
96 } suspend;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +010097 } options;
98 QLIST_ENTRY(BlkdebugRule) next;
Paolo Bonzini571cd432012-06-06 08:10:42 +020099 QSIMPLEQ_ENTRY(BlkdebugRule) active_next;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100100} BlkdebugRule;
101
Max Reitz16789db2019-05-07 22:35:04 +0200102QEMU_BUILD_BUG_MSG(BLKDEBUG_IO_TYPE__MAX > 64,
103 "BlkdebugIOType mask does not fit into an uint64_t");
104
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100105static QemuOptsList inject_error_opts = {
106 .name = "inject-error",
107 .head = QTAILQ_HEAD_INITIALIZER(inject_error_opts.head),
108 .desc = {
109 {
110 .name = "event",
111 .type = QEMU_OPT_STRING,
112 },
113 {
114 .name = "state",
115 .type = QEMU_OPT_NUMBER,
116 },
117 {
Max Reitz16789db2019-05-07 22:35:04 +0200118 .name = "iotype",
119 .type = QEMU_OPT_STRING,
120 },
121 {
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100122 .name = "errno",
123 .type = QEMU_OPT_NUMBER,
124 },
125 {
Paolo Bonzinie4780db2012-06-06 08:10:43 +0200126 .name = "sector",
127 .type = QEMU_OPT_NUMBER,
128 },
129 {
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100130 .name = "once",
131 .type = QEMU_OPT_BOOL,
132 },
133 {
134 .name = "immediately",
135 .type = QEMU_OPT_BOOL,
136 },
137 { /* end of list */ }
138 },
139};
140
141static QemuOptsList set_state_opts = {
142 .name = "set-state",
Kevin Wolf327cdad2010-06-30 17:40:42 +0200143 .head = QTAILQ_HEAD_INITIALIZER(set_state_opts.head),
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100144 .desc = {
145 {
146 .name = "event",
147 .type = QEMU_OPT_STRING,
148 },
149 {
150 .name = "state",
151 .type = QEMU_OPT_NUMBER,
152 },
153 {
154 .name = "new_state",
155 .type = QEMU_OPT_NUMBER,
156 },
157 { /* end of list */ }
158 },
159};
160
161static QemuOptsList *config_groups[] = {
162 &inject_error_opts,
163 &set_state_opts,
164 NULL
165};
166
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100167struct add_rule_data {
168 BDRVBlkdebugState *s;
169 int action;
170};
171
Markus Armbruster28d0de72015-03-13 13:35:14 +0100172static int add_rule(void *opaque, QemuOpts *opts, Error **errp)
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100173{
174 struct add_rule_data *d = opaque;
175 BDRVBlkdebugState *s = d->s;
shiliyang5f14f312020-10-30 11:35:12 +0800176 const char *event_name;
Marc-André Lureauf9509d12017-08-24 10:46:02 +0200177 int event;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100178 struct BlkdebugRule *rule;
Kevin Wolf7c3a9982016-11-04 21:13:45 +0100179 int64_t sector;
Max Reitz16789db2019-05-07 22:35:04 +0200180 BlkdebugIOType iotype;
181 Error *local_error = NULL;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100182
183 /* Find the right event for the rule */
184 event_name = qemu_opt_get(opts, "event");
Stefan Hajnoczid4362d62014-09-20 09:55:52 +0100185 if (!event_name) {
Markus Armbruster8809cfc2015-03-13 13:38:42 +0100186 error_setg(errp, "Missing event name for rule");
Stefan Hajnoczid4362d62014-09-20 09:55:52 +0100187 return -1;
Marc-André Lureauf9509d12017-08-24 10:46:02 +0200188 }
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +0200189 event = qapi_enum_parse(&BlkdebugEvent_lookup, event_name, -1, errp);
Marc-André Lureauf9509d12017-08-24 10:46:02 +0200190 if (event < 0) {
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100191 return -1;
192 }
193
194 /* Set attributes common for all actions */
Anthony Liguori7267c092011-08-20 22:09:37 -0500195 rule = g_malloc0(sizeof(*rule));
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100196 *rule = (struct BlkdebugRule) {
197 .event = event,
198 .action = d->action,
199 .state = qemu_opt_get_number(opts, "state", 0),
200 };
201
202 /* Parse action-specific options */
203 switch (d->action) {
204 case ACTION_INJECT_ERROR:
205 rule->options.inject.error = qemu_opt_get_number(opts, "errno", EIO);
206 rule->options.inject.once = qemu_opt_get_bool(opts, "once", 0);
207 rule->options.inject.immediately =
208 qemu_opt_get_bool(opts, "immediately", 0);
Kevin Wolf7c3a9982016-11-04 21:13:45 +0100209 sector = qemu_opt_get_number(opts, "sector", -1);
210 rule->options.inject.offset =
211 sector == -1 ? -1 : sector * BDRV_SECTOR_SIZE;
Max Reitz16789db2019-05-07 22:35:04 +0200212
213 iotype = qapi_enum_parse(&BlkdebugIOType_lookup,
214 qemu_opt_get(opts, "iotype"),
215 BLKDEBUG_IO_TYPE__MAX, &local_error);
216 if (local_error) {
217 error_propagate(errp, local_error);
Elena Afanasova5b4c95d2020-10-09 12:09:59 -0700218 g_free(rule);
Max Reitz16789db2019-05-07 22:35:04 +0200219 return -1;
220 }
221 if (iotype != BLKDEBUG_IO_TYPE__MAX) {
222 rule->options.inject.iotype_mask = (1ull << iotype);
223 } else {
224 /* Apply the default */
225 rule->options.inject.iotype_mask =
226 (1ull << BLKDEBUG_IO_TYPE_READ)
227 | (1ull << BLKDEBUG_IO_TYPE_WRITE)
228 | (1ull << BLKDEBUG_IO_TYPE_WRITE_ZEROES)
229 | (1ull << BLKDEBUG_IO_TYPE_DISCARD)
230 | (1ull << BLKDEBUG_IO_TYPE_FLUSH);
231 }
232
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100233 break;
234
235 case ACTION_SET_STATE:
236 rule->options.set_state.new_state =
237 qemu_opt_get_number(opts, "new_state", 0);
238 break;
Kevin Wolf3c90c652012-12-06 14:32:57 +0100239
240 case ACTION_SUSPEND:
241 rule->options.suspend.tag =
242 g_strdup(qemu_opt_get(opts, "tag"));
243 break;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100244 };
245
246 /* Add the rule */
247 QLIST_INSERT_HEAD(&s->rules[event], rule, next);
248
249 return 0;
250}
251
Kevin Wolf9e355422012-12-06 14:32:56 +0100252static void remove_rule(BlkdebugRule *rule)
253{
254 switch (rule->action) {
255 case ACTION_INJECT_ERROR:
256 case ACTION_SET_STATE:
257 break;
Kevin Wolf3c90c652012-12-06 14:32:57 +0100258 case ACTION_SUSPEND:
259 g_free(rule->options.suspend.tag);
260 break;
Kevin Wolf9e355422012-12-06 14:32:56 +0100261 }
262
263 QLIST_REMOVE(rule, next);
264 g_free(rule);
265}
266
Max Reitz89f2b212013-12-20 19:28:07 +0100267static int read_config(BDRVBlkdebugState *s, const char *filename,
268 QDict *options, Error **errp)
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100269{
Max Reitz85a040e2013-12-20 19:28:06 +0100270 FILE *f = NULL;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100271 int ret;
272 struct add_rule_data d;
Max Reitz89f2b212013-12-20 19:28:07 +0100273 Error *local_err = NULL;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100274
Max Reitz85a040e2013-12-20 19:28:06 +0100275 if (filename) {
276 f = fopen(filename, "r");
277 if (f == NULL) {
278 error_setg_errno(errp, errno, "Could not read blkdebug config file");
279 return -errno;
280 }
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100281
Max Reitz85a040e2013-12-20 19:28:06 +0100282 ret = qemu_config_parse(f, config_groups, filename);
283 if (ret < 0) {
284 error_setg(errp, "Could not parse blkdebug config file");
Max Reitz85a040e2013-12-20 19:28:06 +0100285 goto fail;
286 }
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100287 }
288
Max Reitz89f2b212013-12-20 19:28:07 +0100289 qemu_config_parse_qdict(options, config_groups, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100290 if (local_err) {
Max Reitz89f2b212013-12-20 19:28:07 +0100291 error_propagate(errp, local_err);
292 ret = -EINVAL;
293 goto fail;
294 }
295
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100296 d.s = s;
297 d.action = ACTION_INJECT_ERROR;
Markus Armbruster8809cfc2015-03-13 13:38:42 +0100298 qemu_opts_foreach(&inject_error_opts, add_rule, &d, &local_err);
Stefan Hajnoczid4362d62014-09-20 09:55:52 +0100299 if (local_err) {
300 error_propagate(errp, local_err);
301 ret = -EINVAL;
302 goto fail;
303 }
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100304
305 d.action = ACTION_SET_STATE;
Markus Armbruster8809cfc2015-03-13 13:38:42 +0100306 qemu_opts_foreach(&set_state_opts, add_rule, &d, &local_err);
Stefan Hajnoczid4362d62014-09-20 09:55:52 +0100307 if (local_err) {
308 error_propagate(errp, local_err);
309 ret = -EINVAL;
310 goto fail;
311 }
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100312
313 ret = 0;
314fail:
Kevin Wolf698f0d52010-06-30 17:42:23 +0200315 qemu_opts_reset(&inject_error_opts);
316 qemu_opts_reset(&set_state_opts);
Max Reitz85a040e2013-12-20 19:28:06 +0100317 if (f) {
318 fclose(f);
319 }
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100320 return ret;
321}
322
323/* Valid blkdebug filenames look like blkdebug:path/to/config:path/to/image */
Kevin Wolff4681212013-04-10 13:37:33 +0200324static void blkdebug_parse_filename(const char *filename, QDict *options,
325 Error **errp)
326{
327 const char *c;
328
329 /* Parse the blkdebug: prefix */
330 if (!strstart(filename, "blkdebug:", &filename)) {
Max Reitzd4881b92013-12-20 19:28:02 +0100331 /* There was no prefix; therefore, all options have to be already
332 present in the QDict (except for the filename) */
Eric Blake46f5ac22017-04-27 16:58:17 -0500333 qdict_put_str(options, "x-image", filename);
Kevin Wolff4681212013-04-10 13:37:33 +0200334 return;
335 }
336
337 /* Parse config file path */
338 c = strchr(filename, ':');
339 if (c == NULL) {
340 error_setg(errp, "blkdebug requires both config file and image path");
341 return;
342 }
343
344 if (c != filename) {
345 QString *config_path;
Markus Armbrusterba891d62018-07-27 08:22:04 +0200346 config_path = qstring_from_substr(filename, 0, c - filename);
Kevin Wolff4681212013-04-10 13:37:33 +0200347 qdict_put(options, "config", config_path);
348 }
349
350 /* TODO Allow multi-level nesting and set file.filename here */
351 filename = c + 1;
Eric Blake46f5ac22017-04-27 16:58:17 -0500352 qdict_put_str(options, "x-image", filename);
Kevin Wolff4681212013-04-10 13:37:33 +0200353}
354
Max Reitz69c64492019-11-08 13:34:53 +0100355static int blkdebug_parse_perm_list(uint64_t *dest, QDict *options,
356 const char *prefix, Error **errp)
357{
358 int ret = 0;
359 QDict *subqdict = NULL;
360 QObject *crumpled_subqdict = NULL;
361 Visitor *v = NULL;
362 BlockPermissionList *perm_list = NULL, *element;
Max Reitz69c64492019-11-08 13:34:53 +0100363
364 *dest = 0;
365
366 qdict_extract_subqdict(options, &subqdict, prefix);
367 if (!qdict_size(subqdict)) {
368 goto out;
369 }
370
371 crumpled_subqdict = qdict_crumple(subqdict, errp);
372 if (!crumpled_subqdict) {
373 ret = -EINVAL;
374 goto out;
375 }
376
377 v = qobject_input_visitor_new(crumpled_subqdict);
Markus Armbrusteraf175e82020-07-07 18:06:03 +0200378 if (!visit_type_BlockPermissionList(v, NULL, &perm_list, errp)) {
Max Reitz69c64492019-11-08 13:34:53 +0100379 ret = -EINVAL;
380 goto out;
381 }
382
383 for (element = perm_list; element; element = element->next) {
384 *dest |= bdrv_qapi_perm_to_blk_perm(element->value);
385 }
386
387out:
388 qapi_free_BlockPermissionList(perm_list);
389 visit_free(v);
390 qobject_unref(subqdict);
391 qobject_unref(crumpled_subqdict);
392 return ret;
393}
394
395static int blkdebug_parse_perms(BDRVBlkdebugState *s, QDict *options,
396 Error **errp)
397{
398 int ret;
399
400 ret = blkdebug_parse_perm_list(&s->take_child_perms, options,
401 "take-child-perms.", errp);
402 if (ret < 0) {
403 return ret;
404 }
405
406 ret = blkdebug_parse_perm_list(&s->unshare_child_perms, options,
407 "unshare-child-perms.", errp);
408 if (ret < 0) {
409 return ret;
410 }
411
412 return 0;
413}
414
Kevin Wolff4681212013-04-10 13:37:33 +0200415static QemuOptsList runtime_opts = {
416 .name = "blkdebug",
417 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
418 .desc = {
419 {
420 .name = "config",
421 .type = QEMU_OPT_STRING,
422 .help = "Path to the configuration file",
423 },
424 {
425 .name = "x-image",
426 .type = QEMU_OPT_STRING,
427 .help = "[internal use only, will be removed]",
428 },
Kevin Wolfb35ee7f2014-01-14 13:44:35 +0100429 {
430 .name = "align",
431 .type = QEMU_OPT_SIZE,
432 .help = "Required alignment in bytes",
433 },
Eric Blake430b26a2017-04-29 14:14:18 -0500434 {
435 .name = "max-transfer",
436 .type = QEMU_OPT_SIZE,
437 .help = "Maximum transfer size in bytes",
438 },
439 {
440 .name = "opt-write-zero",
441 .type = QEMU_OPT_SIZE,
442 .help = "Optimum write zero alignment in bytes",
443 },
444 {
445 .name = "max-write-zero",
446 .type = QEMU_OPT_SIZE,
447 .help = "Maximum write zero size in bytes",
448 },
449 {
450 .name = "opt-discard",
451 .type = QEMU_OPT_SIZE,
452 .help = "Optimum discard alignment in bytes",
453 },
454 {
455 .name = "max-discard",
456 .type = QEMU_OPT_SIZE,
457 .help = "Maximum discard size in bytes",
458 },
Kevin Wolff4681212013-04-10 13:37:33 +0200459 { /* end of list */ }
460 },
461};
462
Max Reitz015a1032013-09-05 14:22:29 +0200463static int blkdebug_open(BlockDriverState *bs, QDict *options, int flags,
464 Error **errp)
Kevin Wolf6a143722010-02-18 17:48:12 +0100465{
466 BDRVBlkdebugState *s = bs->opaque;
Kevin Wolff4681212013-04-10 13:37:33 +0200467 QemuOpts *opts;
468 Error *local_err = NULL;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100469 int ret;
Eric Blake430b26a2017-04-29 14:14:18 -0500470 uint64_t align;
Kevin Wolf6a143722010-02-18 17:48:12 +0100471
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800472 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
Markus Armbrusteraf175e82020-07-07 18:06:03 +0200473 if (!qemu_opts_absorb_qdict(opts, options, errp)) {
Kevin Wolff4681212013-04-10 13:37:33 +0200474 ret = -EINVAL;
Kevin Wolfeaf944a2014-02-08 09:53:22 +0100475 goto out;
Kevin Wolf6a143722010-02-18 17:48:12 +0100476 }
Kevin Wolf6a143722010-02-18 17:48:12 +0100477
Max Reitz89f2b212013-12-20 19:28:07 +0100478 /* Read rules from config file or command line options */
Max Reitz036990d2016-08-15 15:29:25 +0200479 s->config_file = g_strdup(qemu_opt_get(opts, "config"));
480 ret = read_config(s, s->config_file, options, errp);
Max Reitz85a040e2013-12-20 19:28:06 +0100481 if (ret) {
Kevin Wolfeaf944a2014-02-08 09:53:22 +0100482 goto out;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100483 }
484
Kevin Wolf8db520c2010-06-30 17:43:40 +0200485 /* Set initial state */
Paolo Bonzini571cd432012-06-06 08:10:42 +0200486 s->state = 1;
Kevin Wolf8db520c2010-06-30 17:43:40 +0200487
Max Reitz69c64492019-11-08 13:34:53 +0100488 /* Parse permissions modifiers before opening the image file */
489 ret = blkdebug_parse_perms(s, options, errp);
490 if (ret < 0) {
491 goto out;
492 }
493
Fam Zheng6b826af2015-10-16 18:46:04 +0800494 /* Open the image file */
Kevin Wolf9a4f4c32015-06-16 14:19:22 +0200495 bs->file = bdrv_open_child(qemu_opt_get(opts, "x-image"), options, "image",
Max Reitzb3af2af2020-05-13 13:05:36 +0200496 bs, &child_of_bds,
497 BDRV_CHILD_FILTERED | BDRV_CHILD_PRIMARY,
498 false, &local_err);
Kevin Wolf9a4f4c32015-06-16 14:19:22 +0200499 if (local_err) {
500 ret = -EINVAL;
Max Reitz10ffa722013-10-10 15:44:03 +0200501 error_propagate(errp, local_err);
Kevin Wolfeaf944a2014-02-08 09:53:22 +0100502 goto out;
Kevin Wolff4681212013-04-10 13:37:33 +0200503 }
504
Max Reitz228345b2018-04-21 15:29:26 +0200505 bs->supported_write_flags = BDRV_REQ_WRITE_UNCHANGED |
506 (BDRV_REQ_FUA & bs->file->bs->supported_write_flags);
507 bs->supported_zero_flags = BDRV_REQ_WRITE_UNCHANGED |
Kevin Wolf80f5c332019-03-22 13:42:39 +0100508 ((BDRV_REQ_FUA | BDRV_REQ_MAY_UNMAP | BDRV_REQ_NO_FALLBACK) &
Max Reitz228345b2018-04-21 15:29:26 +0200509 bs->file->bs->supported_zero_flags);
Eric Blake3dc834f2017-04-29 14:14:17 -0500510 ret = -EINVAL;
Eric Blake63188c22017-04-29 14:14:16 -0500511
Eric Blake430b26a2017-04-29 14:14:18 -0500512 /* Set alignment overrides */
Eric Blake3dc834f2017-04-29 14:14:17 -0500513 s->align = qemu_opt_get_size(opts, "align", 0);
514 if (s->align && (s->align >= INT_MAX || !is_power_of_2(s->align))) {
515 error_setg(errp, "Cannot meet constraints with align %" PRIu64,
516 s->align);
Max Reitzde234892017-04-13 17:43:34 +0200517 goto out;
Kevin Wolfb35ee7f2014-01-14 13:44:35 +0100518 }
Eric Blake430b26a2017-04-29 14:14:18 -0500519 align = MAX(s->align, bs->file->bs->bl.request_alignment);
520
521 s->max_transfer = qemu_opt_get_size(opts, "max-transfer", 0);
522 if (s->max_transfer &&
523 (s->max_transfer >= INT_MAX ||
524 !QEMU_IS_ALIGNED(s->max_transfer, align))) {
525 error_setg(errp, "Cannot meet constraints with max-transfer %" PRIu64,
526 s->max_transfer);
527 goto out;
528 }
529
530 s->opt_write_zero = qemu_opt_get_size(opts, "opt-write-zero", 0);
531 if (s->opt_write_zero &&
532 (s->opt_write_zero >= INT_MAX ||
533 !QEMU_IS_ALIGNED(s->opt_write_zero, align))) {
534 error_setg(errp, "Cannot meet constraints with opt-write-zero %" PRIu64,
535 s->opt_write_zero);
536 goto out;
537 }
538
539 s->max_write_zero = qemu_opt_get_size(opts, "max-write-zero", 0);
540 if (s->max_write_zero &&
541 (s->max_write_zero >= INT_MAX ||
542 !QEMU_IS_ALIGNED(s->max_write_zero,
543 MAX(s->opt_write_zero, align)))) {
544 error_setg(errp, "Cannot meet constraints with max-write-zero %" PRIu64,
545 s->max_write_zero);
546 goto out;
547 }
548
549 s->opt_discard = qemu_opt_get_size(opts, "opt-discard", 0);
550 if (s->opt_discard &&
551 (s->opt_discard >= INT_MAX ||
552 !QEMU_IS_ALIGNED(s->opt_discard, align))) {
553 error_setg(errp, "Cannot meet constraints with opt-discard %" PRIu64,
554 s->opt_discard);
555 goto out;
556 }
557
558 s->max_discard = qemu_opt_get_size(opts, "max-discard", 0);
559 if (s->max_discard &&
560 (s->max_discard >= INT_MAX ||
561 !QEMU_IS_ALIGNED(s->max_discard,
562 MAX(s->opt_discard, align)))) {
563 error_setg(errp, "Cannot meet constraints with max-discard %" PRIu64,
564 s->max_discard);
565 goto out;
566 }
Kevin Wolfb35ee7f2014-01-14 13:44:35 +0100567
Max Reitzf8cec152019-05-07 22:35:05 +0200568 bdrv_debug_event(bs, BLKDBG_NONE);
569
Kevin Wolff4681212013-04-10 13:37:33 +0200570 ret = 0;
Kevin Wolfeaf944a2014-02-08 09:53:22 +0100571out:
Max Reitz036990d2016-08-15 15:29:25 +0200572 if (ret < 0) {
573 g_free(s->config_file);
574 }
Kevin Wolff4681212013-04-10 13:37:33 +0200575 qemu_opts_del(opts);
576 return ret;
Kevin Wolf6a143722010-02-18 17:48:12 +0100577}
578
Max Reitz16789db2019-05-07 22:35:04 +0200579static int rule_check(BlockDriverState *bs, uint64_t offset, uint64_t bytes,
580 BlkdebugIOType iotype)
Kevin Wolfb9f66d92010-02-19 16:24:35 +0100581{
582 BDRVBlkdebugState *s = bs->opaque;
Eric Blaked157ed52017-04-29 14:14:15 -0500583 BlkdebugRule *rule = NULL;
584 int error;
585 bool immediately;
586
587 QSIMPLEQ_FOREACH(rule, &s->active_rules, active_next) {
588 uint64_t inject_offset = rule->options.inject.offset;
589
Max Reitz16789db2019-05-07 22:35:04 +0200590 if ((inject_offset == -1 ||
591 (bytes && inject_offset >= offset &&
592 inject_offset < offset + bytes)) &&
593 (rule->options.inject.iotype_mask & (1ull << iotype)))
Eric Blaked157ed52017-04-29 14:14:15 -0500594 {
595 break;
596 }
597 }
598
599 if (!rule || !rule->options.inject.error) {
600 return 0;
601 }
602
603 immediately = rule->options.inject.immediately;
604 error = rule->options.inject.error;
Kevin Wolfb9f66d92010-02-19 16:24:35 +0100605
Paolo Bonzini571cd432012-06-06 08:10:42 +0200606 if (rule->options.inject.once) {
John Snowa069e2f2015-02-06 16:26:17 -0500607 QSIMPLEQ_REMOVE(&s->active_rules, rule, BlkdebugRule, active_next);
608 remove_rule(rule);
Kevin Wolfb9f66d92010-02-19 16:24:35 +0100609 }
610
Kevin Wolf7c3a9982016-11-04 21:13:45 +0100611 if (!immediately) {
Paolo Bonzinie5c67ab2017-02-13 14:52:26 +0100612 aio_co_schedule(qemu_get_current_aio_context(), qemu_coroutine_self());
Kevin Wolf7c3a9982016-11-04 21:13:45 +0100613 qemu_coroutine_yield();
Kevin Wolfb9f66d92010-02-19 16:24:35 +0100614 }
615
Kevin Wolf7c3a9982016-11-04 21:13:45 +0100616 return -error;
Kevin Wolfb9f66d92010-02-19 16:24:35 +0100617}
618
Kevin Wolf7c3a9982016-11-04 21:13:45 +0100619static int coroutine_fn
620blkdebug_co_preadv(BlockDriverState *bs, uint64_t offset, uint64_t bytes,
621 QEMUIOVector *qiov, int flags)
Kevin Wolf6a143722010-02-18 17:48:12 +0100622{
Eric Blaked157ed52017-04-29 14:14:15 -0500623 int err;
Paolo Bonzinie4780db2012-06-06 08:10:43 +0200624
Eric Blakee0ef4392017-04-29 14:14:14 -0500625 /* Sanity check block layer guarantees */
626 assert(QEMU_IS_ALIGNED(offset, bs->bl.request_alignment));
627 assert(QEMU_IS_ALIGNED(bytes, bs->bl.request_alignment));
628 if (bs->bl.max_transfer) {
629 assert(bytes <= bs->bl.max_transfer);
630 }
631
Max Reitz16789db2019-05-07 22:35:04 +0200632 err = rule_check(bs, offset, bytes, BLKDEBUG_IO_TYPE_READ);
Eric Blaked157ed52017-04-29 14:14:15 -0500633 if (err) {
634 return err;
Kevin Wolfb9f66d92010-02-19 16:24:35 +0100635 }
636
Kevin Wolf7c3a9982016-11-04 21:13:45 +0100637 return bdrv_co_preadv(bs->file, offset, bytes, qiov, flags);
Kevin Wolf6a143722010-02-18 17:48:12 +0100638}
639
Kevin Wolf7c3a9982016-11-04 21:13:45 +0100640static int coroutine_fn
641blkdebug_co_pwritev(BlockDriverState *bs, uint64_t offset, uint64_t bytes,
642 QEMUIOVector *qiov, int flags)
Kevin Wolf6a143722010-02-18 17:48:12 +0100643{
Eric Blaked157ed52017-04-29 14:14:15 -0500644 int err;
Paolo Bonzinie4780db2012-06-06 08:10:43 +0200645
Eric Blakee0ef4392017-04-29 14:14:14 -0500646 /* Sanity check block layer guarantees */
647 assert(QEMU_IS_ALIGNED(offset, bs->bl.request_alignment));
648 assert(QEMU_IS_ALIGNED(bytes, bs->bl.request_alignment));
649 if (bs->bl.max_transfer) {
650 assert(bytes <= bs->bl.max_transfer);
651 }
652
Max Reitz16789db2019-05-07 22:35:04 +0200653 err = rule_check(bs, offset, bytes, BLKDEBUG_IO_TYPE_WRITE);
Eric Blaked157ed52017-04-29 14:14:15 -0500654 if (err) {
655 return err;
Kevin Wolfb9f66d92010-02-19 16:24:35 +0100656 }
657
Kevin Wolf7c3a9982016-11-04 21:13:45 +0100658 return bdrv_co_pwritev(bs->file, offset, bytes, qiov, flags);
Kevin Wolf6a143722010-02-18 17:48:12 +0100659}
660
Kevin Wolf7c3a9982016-11-04 21:13:45 +0100661static int blkdebug_co_flush(BlockDriverState *bs)
Paolo Bonzini9e52c532014-08-04 17:11:02 -0400662{
Max Reitz16789db2019-05-07 22:35:04 +0200663 int err = rule_check(bs, 0, 0, BLKDEBUG_IO_TYPE_FLUSH);
Paolo Bonzini9e52c532014-08-04 17:11:02 -0400664
Eric Blaked157ed52017-04-29 14:14:15 -0500665 if (err) {
666 return err;
Paolo Bonzini9e52c532014-08-04 17:11:02 -0400667 }
668
Kevin Wolf7c3a9982016-11-04 21:13:45 +0100669 return bdrv_co_flush(bs->file->bs);
Paolo Bonzini9e52c532014-08-04 17:11:02 -0400670}
671
Eric Blake63188c22017-04-29 14:14:16 -0500672static int coroutine_fn blkdebug_co_pwrite_zeroes(BlockDriverState *bs,
Manos Pitsidianakisf5a5ca72017-06-09 13:18:08 +0300673 int64_t offset, int bytes,
Eric Blake63188c22017-04-29 14:14:16 -0500674 BdrvRequestFlags flags)
675{
676 uint32_t align = MAX(bs->bl.request_alignment,
677 bs->bl.pwrite_zeroes_alignment);
678 int err;
679
680 /* Only pass through requests that are larger than requested
681 * preferred alignment (so that we test the fallback to writes on
682 * unaligned portions), and check that the block layer never hands
683 * us anything unaligned that crosses an alignment boundary. */
Manos Pitsidianakisf5a5ca72017-06-09 13:18:08 +0300684 if (bytes < align) {
Eric Blake63188c22017-04-29 14:14:16 -0500685 assert(QEMU_IS_ALIGNED(offset, align) ||
Manos Pitsidianakisf5a5ca72017-06-09 13:18:08 +0300686 QEMU_IS_ALIGNED(offset + bytes, align) ||
Eric Blake63188c22017-04-29 14:14:16 -0500687 DIV_ROUND_UP(offset, align) ==
Manos Pitsidianakisf5a5ca72017-06-09 13:18:08 +0300688 DIV_ROUND_UP(offset + bytes, align));
Eric Blake63188c22017-04-29 14:14:16 -0500689 return -ENOTSUP;
690 }
691 assert(QEMU_IS_ALIGNED(offset, align));
Manos Pitsidianakisf5a5ca72017-06-09 13:18:08 +0300692 assert(QEMU_IS_ALIGNED(bytes, align));
Eric Blake63188c22017-04-29 14:14:16 -0500693 if (bs->bl.max_pwrite_zeroes) {
Manos Pitsidianakisf5a5ca72017-06-09 13:18:08 +0300694 assert(bytes <= bs->bl.max_pwrite_zeroes);
Eric Blake63188c22017-04-29 14:14:16 -0500695 }
696
Max Reitz16789db2019-05-07 22:35:04 +0200697 err = rule_check(bs, offset, bytes, BLKDEBUG_IO_TYPE_WRITE_ZEROES);
Eric Blake63188c22017-04-29 14:14:16 -0500698 if (err) {
699 return err;
700 }
701
Manos Pitsidianakisf5a5ca72017-06-09 13:18:08 +0300702 return bdrv_co_pwrite_zeroes(bs->file, offset, bytes, flags);
Eric Blake63188c22017-04-29 14:14:16 -0500703}
704
705static int coroutine_fn blkdebug_co_pdiscard(BlockDriverState *bs,
Manos Pitsidianakisf5a5ca72017-06-09 13:18:08 +0300706 int64_t offset, int bytes)
Eric Blake63188c22017-04-29 14:14:16 -0500707{
708 uint32_t align = bs->bl.pdiscard_alignment;
709 int err;
710
711 /* Only pass through requests that are larger than requested
712 * minimum alignment, and ensure that unaligned requests do not
713 * cross optimum discard boundaries. */
Manos Pitsidianakisf5a5ca72017-06-09 13:18:08 +0300714 if (bytes < bs->bl.request_alignment) {
Eric Blake63188c22017-04-29 14:14:16 -0500715 assert(QEMU_IS_ALIGNED(offset, align) ||
Manos Pitsidianakisf5a5ca72017-06-09 13:18:08 +0300716 QEMU_IS_ALIGNED(offset + bytes, align) ||
Eric Blake63188c22017-04-29 14:14:16 -0500717 DIV_ROUND_UP(offset, align) ==
Manos Pitsidianakisf5a5ca72017-06-09 13:18:08 +0300718 DIV_ROUND_UP(offset + bytes, align));
Eric Blake63188c22017-04-29 14:14:16 -0500719 return -ENOTSUP;
720 }
721 assert(QEMU_IS_ALIGNED(offset, bs->bl.request_alignment));
Manos Pitsidianakisf5a5ca72017-06-09 13:18:08 +0300722 assert(QEMU_IS_ALIGNED(bytes, bs->bl.request_alignment));
723 if (align && bytes >= align) {
Eric Blake63188c22017-04-29 14:14:16 -0500724 assert(QEMU_IS_ALIGNED(offset, align));
Manos Pitsidianakisf5a5ca72017-06-09 13:18:08 +0300725 assert(QEMU_IS_ALIGNED(bytes, align));
Eric Blake63188c22017-04-29 14:14:16 -0500726 }
727 if (bs->bl.max_pdiscard) {
Manos Pitsidianakisf5a5ca72017-06-09 13:18:08 +0300728 assert(bytes <= bs->bl.max_pdiscard);
Eric Blake63188c22017-04-29 14:14:16 -0500729 }
730
Max Reitz16789db2019-05-07 22:35:04 +0200731 err = rule_check(bs, offset, bytes, BLKDEBUG_IO_TYPE_DISCARD);
Eric Blake63188c22017-04-29 14:14:16 -0500732 if (err) {
733 return err;
734 }
735
Fam Zheng0b9fd3f2018-07-10 14:31:17 +0800736 return bdrv_co_pdiscard(bs->file, offset, bytes);
Eric Blake63188c22017-04-29 14:14:16 -0500737}
Kevin Wolf3c90c652012-12-06 14:32:57 +0100738
Eric Blake3e4d0e72018-02-13 14:26:43 -0600739static int coroutine_fn blkdebug_co_block_status(BlockDriverState *bs,
740 bool want_zero,
741 int64_t offset,
742 int64_t bytes,
743 int64_t *pnum,
744 int64_t *map,
745 BlockDriverState **file)
Eric Blakeefa6e2e2017-10-11 22:47:17 -0500746{
Max Reitz1adb0b52019-05-07 22:35:06 +0200747 int err;
748
Eric Blake3e4d0e72018-02-13 14:26:43 -0600749 assert(QEMU_IS_ALIGNED(offset | bytes, bs->bl.request_alignment));
Max Reitz1adb0b52019-05-07 22:35:06 +0200750
751 err = rule_check(bs, offset, bytes, BLKDEBUG_IO_TYPE_BLOCK_STATUS);
752 if (err) {
753 return err;
754 }
755
Max Reitz549ec0d2019-02-13 18:05:23 +0100756 assert(bs->file && bs->file->bs);
757 *pnum = bytes;
758 *map = offset;
759 *file = bs->file->bs;
760 return BDRV_BLOCK_RAW | BDRV_BLOCK_OFFSET_VALID;
Eric Blakeefa6e2e2017-10-11 22:47:17 -0500761}
762
Kevin Wolf6a143722010-02-18 17:48:12 +0100763static void blkdebug_close(BlockDriverState *bs)
764{
765 BDRVBlkdebugState *s = bs->opaque;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100766 BlkdebugRule *rule, *next;
767 int i;
768
Eric Blake7fb1cf12015-11-18 01:52:57 -0700769 for (i = 0; i < BLKDBG__MAX; i++) {
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100770 QLIST_FOREACH_SAFE(rule, &s->rules[i], next, next) {
Kevin Wolf9e355422012-12-06 14:32:56 +0100771 remove_rule(rule);
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100772 }
773 }
Max Reitz036990d2016-08-15 15:29:25 +0200774
775 g_free(s->config_file);
Kevin Wolf6a143722010-02-18 17:48:12 +0100776}
777
Kevin Wolf3c90c652012-12-06 14:32:57 +0100778static void suspend_request(BlockDriverState *bs, BlkdebugRule *rule)
779{
780 BDRVBlkdebugState *s = bs->opaque;
781 BlkdebugSuspendedReq r;
782
783 r = (BlkdebugSuspendedReq) {
784 .co = qemu_coroutine_self(),
785 .tag = g_strdup(rule->options.suspend.tag),
786 };
787
788 remove_rule(rule);
789 QLIST_INSERT_HEAD(&s->suspended_reqs, &r, next);
790
Michael S. Tsirkin20873522015-11-30 13:44:44 +0200791 if (!qtest_enabled()) {
792 printf("blkdebug: Suspended request '%s'\n", r.tag);
793 }
Kevin Wolf3c90c652012-12-06 14:32:57 +0100794 qemu_coroutine_yield();
Michael S. Tsirkin20873522015-11-30 13:44:44 +0200795 if (!qtest_enabled()) {
796 printf("blkdebug: Resuming request '%s'\n", r.tag);
797 }
Kevin Wolf3c90c652012-12-06 14:32:57 +0100798
799 QLIST_REMOVE(&r, next);
800 g_free(r.tag);
801}
802
Paolo Bonzini571cd432012-06-06 08:10:42 +0200803static bool process_rule(BlockDriverState *bs, struct BlkdebugRule *rule,
Paolo Bonzini8f96b5b2012-09-28 17:23:00 +0200804 bool injected)
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100805{
806 BDRVBlkdebugState *s = bs->opaque;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100807
808 /* Only process rules for the current state */
Paolo Bonzini8f96b5b2012-09-28 17:23:00 +0200809 if (rule->state && rule->state != s->state) {
Paolo Bonzini571cd432012-06-06 08:10:42 +0200810 return injected;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100811 }
812
813 /* Take the action */
814 switch (rule->action) {
815 case ACTION_INJECT_ERROR:
Paolo Bonzini571cd432012-06-06 08:10:42 +0200816 if (!injected) {
817 QSIMPLEQ_INIT(&s->active_rules);
818 injected = true;
819 }
820 QSIMPLEQ_INSERT_HEAD(&s->active_rules, rule, active_next);
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100821 break;
822
823 case ACTION_SET_STATE:
Paolo Bonzini8f96b5b2012-09-28 17:23:00 +0200824 s->new_state = rule->options.set_state.new_state;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100825 break;
Kevin Wolf3c90c652012-12-06 14:32:57 +0100826
827 case ACTION_SUSPEND:
828 suspend_request(bs, rule);
829 break;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100830 }
Paolo Bonzini571cd432012-06-06 08:10:42 +0200831 return injected;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100832}
833
Eric Blakea31939e2015-11-18 01:52:54 -0700834static void blkdebug_debug_event(BlockDriverState *bs, BlkdebugEvent event)
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100835{
836 BDRVBlkdebugState *s = bs->opaque;
Kevin Wolf3c90c652012-12-06 14:32:57 +0100837 struct BlkdebugRule *rule, *next;
Paolo Bonzini571cd432012-06-06 08:10:42 +0200838 bool injected;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100839
Eric Blake7fb1cf12015-11-18 01:52:57 -0700840 assert((int)event >= 0 && event < BLKDBG__MAX);
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100841
Paolo Bonzini571cd432012-06-06 08:10:42 +0200842 injected = false;
Paolo Bonzini8f96b5b2012-09-28 17:23:00 +0200843 s->new_state = s->state;
Kevin Wolf3c90c652012-12-06 14:32:57 +0100844 QLIST_FOREACH_SAFE(rule, &s->rules[event], next, next) {
Paolo Bonzini8f96b5b2012-09-28 17:23:00 +0200845 injected = process_rule(bs, rule, injected);
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100846 }
Paolo Bonzini8f96b5b2012-09-28 17:23:00 +0200847 s->state = s->new_state;
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +0100848}
849
Kevin Wolf3c90c652012-12-06 14:32:57 +0100850static int blkdebug_debug_breakpoint(BlockDriverState *bs, const char *event,
851 const char *tag)
852{
853 BDRVBlkdebugState *s = bs->opaque;
854 struct BlkdebugRule *rule;
Marc-André Lureauf9509d12017-08-24 10:46:02 +0200855 int blkdebug_event;
Kevin Wolf3c90c652012-12-06 14:32:57 +0100856
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +0200857 blkdebug_event = qapi_enum_parse(&BlkdebugEvent_lookup, event, -1, NULL);
Marc-André Lureauf9509d12017-08-24 10:46:02 +0200858 if (blkdebug_event < 0) {
Kevin Wolf3c90c652012-12-06 14:32:57 +0100859 return -ENOENT;
860 }
861
Kevin Wolf3c90c652012-12-06 14:32:57 +0100862 rule = g_malloc(sizeof(*rule));
863 *rule = (struct BlkdebugRule) {
864 .event = blkdebug_event,
865 .action = ACTION_SUSPEND,
866 .state = 0,
867 .options.suspend.tag = g_strdup(tag),
868 };
869
870 QLIST_INSERT_HEAD(&s->rules[blkdebug_event], rule, next);
871
872 return 0;
873}
874
875static int blkdebug_debug_resume(BlockDriverState *bs, const char *tag)
876{
877 BDRVBlkdebugState *s = bs->opaque;
Fam Zhengc547e562013-12-13 15:25:12 +0800878 BlkdebugSuspendedReq *r, *next;
Kevin Wolf3c90c652012-12-06 14:32:57 +0100879
Fam Zhengc547e562013-12-13 15:25:12 +0800880 QLIST_FOREACH_SAFE(r, &s->suspended_reqs, next, next) {
Kevin Wolf3c90c652012-12-06 14:32:57 +0100881 if (!strcmp(r->tag, tag)) {
Paolo Bonzini0b8b8752016-07-04 19:10:01 +0200882 qemu_coroutine_enter(r->co);
Kevin Wolf3c90c652012-12-06 14:32:57 +0100883 return 0;
884 }
885 }
886 return -ENOENT;
887}
888
Fam Zheng4cc70e92013-11-20 10:01:54 +0800889static int blkdebug_debug_remove_breakpoint(BlockDriverState *bs,
890 const char *tag)
891{
892 BDRVBlkdebugState *s = bs->opaque;
Fam Zhengc547e562013-12-13 15:25:12 +0800893 BlkdebugSuspendedReq *r, *r_next;
Fam Zheng4cc70e92013-11-20 10:01:54 +0800894 BlkdebugRule *rule, *next;
895 int i, ret = -ENOENT;
896
Eric Blake7fb1cf12015-11-18 01:52:57 -0700897 for (i = 0; i < BLKDBG__MAX; i++) {
Fam Zheng4cc70e92013-11-20 10:01:54 +0800898 QLIST_FOREACH_SAFE(rule, &s->rules[i], next, next) {
899 if (rule->action == ACTION_SUSPEND &&
900 !strcmp(rule->options.suspend.tag, tag)) {
901 remove_rule(rule);
902 ret = 0;
903 }
904 }
905 }
Fam Zhengc547e562013-12-13 15:25:12 +0800906 QLIST_FOREACH_SAFE(r, &s->suspended_reqs, next, r_next) {
Fam Zheng4cc70e92013-11-20 10:01:54 +0800907 if (!strcmp(r->tag, tag)) {
Paolo Bonzini0b8b8752016-07-04 19:10:01 +0200908 qemu_coroutine_enter(r->co);
Fam Zheng4cc70e92013-11-20 10:01:54 +0800909 ret = 0;
910 }
911 }
912 return ret;
913}
Kevin Wolf3c90c652012-12-06 14:32:57 +0100914
915static bool blkdebug_debug_is_suspended(BlockDriverState *bs, const char *tag)
916{
917 BDRVBlkdebugState *s = bs->opaque;
918 BlkdebugSuspendedReq *r;
919
920 QLIST_FOREACH(r, &s->suspended_reqs, next) {
921 if (!strcmp(r->tag, tag)) {
922 return true;
923 }
924 }
925 return false;
926}
927
Paolo Bonzinie1302252012-06-06 08:10:41 +0200928static int64_t blkdebug_getlength(BlockDriverState *bs)
929{
Kevin Wolf9a4f4c32015-06-16 14:19:22 +0200930 return bdrv_getlength(bs->file->bs);
Paolo Bonzinie1302252012-06-06 08:10:41 +0200931}
932
Max Reitz998b3a12019-02-01 20:29:28 +0100933static void blkdebug_refresh_filename(BlockDriverState *bs)
Max Reitz2c31b042014-07-18 20:24:57 +0200934{
Max Reitz036990d2016-08-15 15:29:25 +0200935 BDRVBlkdebugState *s = bs->opaque;
Max Reitz87794412014-11-11 10:23:44 +0100936 const QDictEntry *e;
Max Reitz998b3a12019-02-01 20:29:28 +0100937 int ret;
Max Reitz2c31b042014-07-18 20:24:57 +0200938
Max Reitz998b3a12019-02-01 20:29:28 +0100939 if (!bs->file->bs->exact_filename[0]) {
Max Reitz2c31b042014-07-18 20:24:57 +0200940 return;
941 }
942
Max Reitz998b3a12019-02-01 20:29:28 +0100943 for (e = qdict_first(bs->full_open_options); e;
944 e = qdict_next(bs->full_open_options, e))
945 {
946 /* Real child options are under "image", but "x-image" may
947 * contain a filename */
948 if (strcmp(qdict_entry_key(e), "config") &&
949 strcmp(qdict_entry_key(e), "image") &&
950 strcmp(qdict_entry_key(e), "x-image") &&
951 strcmp(qdict_entry_key(e), "driver"))
952 {
953 return;
Max Reitzde81d722017-06-13 19:20:05 +0200954 }
Max Reitz87794412014-11-11 10:23:44 +0100955 }
956
Max Reitz998b3a12019-02-01 20:29:28 +0100957 ret = snprintf(bs->exact_filename, sizeof(bs->exact_filename),
958 "blkdebug:%s:%s",
959 s->config_file ?: "", bs->file->bs->exact_filename);
960 if (ret >= sizeof(bs->exact_filename)) {
961 /* An overflow makes the filename unusable, so do not report any */
962 bs->exact_filename[0] = 0;
Max Reitz2c31b042014-07-18 20:24:57 +0200963 }
Max Reitz2c31b042014-07-18 20:24:57 +0200964}
965
Eric Blake835db3e2016-06-23 16:37:13 -0600966static void blkdebug_refresh_limits(BlockDriverState *bs, Error **errp)
967{
968 BDRVBlkdebugState *s = bs->opaque;
969
970 if (s->align) {
Eric Blakea5b8dd22016-06-23 16:37:24 -0600971 bs->bl.request_alignment = s->align;
Eric Blake835db3e2016-06-23 16:37:13 -0600972 }
Eric Blake430b26a2017-04-29 14:14:18 -0500973 if (s->max_transfer) {
974 bs->bl.max_transfer = s->max_transfer;
975 }
976 if (s->opt_write_zero) {
977 bs->bl.pwrite_zeroes_alignment = s->opt_write_zero;
978 }
979 if (s->max_write_zero) {
980 bs->bl.max_pwrite_zeroes = s->max_write_zero;
981 }
982 if (s->opt_discard) {
983 bs->bl.pdiscard_alignment = s->opt_discard;
984 }
985 if (s->max_discard) {
986 bs->bl.max_pdiscard = s->max_discard;
987 }
Eric Blake835db3e2016-06-23 16:37:13 -0600988}
989
Kevin Wolfc5e8bfb2015-10-29 15:22:27 +0100990static int blkdebug_reopen_prepare(BDRVReopenState *reopen_state,
991 BlockReopenQueue *queue, Error **errp)
992{
993 return 0;
994}
995
Max Reitz69c64492019-11-08 13:34:53 +0100996static void blkdebug_child_perm(BlockDriverState *bs, BdrvChild *c,
Max Reitzbf8e9252020-05-13 13:05:16 +0200997 BdrvChildRole role,
Max Reitz69c64492019-11-08 13:34:53 +0100998 BlockReopenQueue *reopen_queue,
999 uint64_t perm, uint64_t shared,
1000 uint64_t *nperm, uint64_t *nshared)
1001{
1002 BDRVBlkdebugState *s = bs->opaque;
1003
Max Reitze5d8a402020-05-13 13:05:44 +02001004 bdrv_default_perms(bs, c, role, reopen_queue,
Max Reitz69dca432020-05-13 13:05:39 +02001005 perm, shared, nperm, nshared);
Max Reitz69c64492019-11-08 13:34:53 +01001006
1007 *nperm |= s->take_child_perms;
1008 *nshared &= ~s->unshare_child_perms;
1009}
1010
Max Reitz26542672019-02-01 20:29:25 +01001011static const char *const blkdebug_strong_runtime_opts[] = {
1012 "config",
1013 "inject-error.",
1014 "set-state.",
1015 "align",
1016 "max-transfer",
1017 "opt-write-zero",
1018 "max-write-zero",
1019 "opt-discard",
1020 "max-discard",
1021
1022 NULL
1023};
1024
Kevin Wolf6a143722010-02-18 17:48:12 +01001025static BlockDriver bdrv_blkdebug = {
Kevin Wolff4681212013-04-10 13:37:33 +02001026 .format_name = "blkdebug",
1027 .protocol_name = "blkdebug",
1028 .instance_size = sizeof(BDRVBlkdebugState),
Manos Pitsidianakisd8e12cd2017-07-13 18:30:27 +03001029 .is_filter = true,
Kevin Wolf6a143722010-02-18 17:48:12 +01001030
Kevin Wolff4681212013-04-10 13:37:33 +02001031 .bdrv_parse_filename = blkdebug_parse_filename,
1032 .bdrv_file_open = blkdebug_open,
1033 .bdrv_close = blkdebug_close,
Kevin Wolfc5e8bfb2015-10-29 15:22:27 +01001034 .bdrv_reopen_prepare = blkdebug_reopen_prepare,
Max Reitz69c64492019-11-08 13:34:53 +01001035 .bdrv_child_perm = blkdebug_child_perm,
Kevin Wolfd7010df2016-12-15 12:28:58 +01001036
Kevin Wolff4681212013-04-10 13:37:33 +02001037 .bdrv_getlength = blkdebug_getlength,
Max Reitz2c31b042014-07-18 20:24:57 +02001038 .bdrv_refresh_filename = blkdebug_refresh_filename,
Eric Blake835db3e2016-06-23 16:37:13 -06001039 .bdrv_refresh_limits = blkdebug_refresh_limits,
Kevin Wolf6a143722010-02-18 17:48:12 +01001040
Kevin Wolf7c3a9982016-11-04 21:13:45 +01001041 .bdrv_co_preadv = blkdebug_co_preadv,
1042 .bdrv_co_pwritev = blkdebug_co_pwritev,
1043 .bdrv_co_flush_to_disk = blkdebug_co_flush,
Eric Blake63188c22017-04-29 14:14:16 -05001044 .bdrv_co_pwrite_zeroes = blkdebug_co_pwrite_zeroes,
1045 .bdrv_co_pdiscard = blkdebug_co_pdiscard,
Eric Blake3e4d0e72018-02-13 14:26:43 -06001046 .bdrv_co_block_status = blkdebug_co_block_status,
Kevin Wolf8b9b0cc2010-03-15 17:27:00 +01001047
Kevin Wolf3c90c652012-12-06 14:32:57 +01001048 .bdrv_debug_event = blkdebug_debug_event,
1049 .bdrv_debug_breakpoint = blkdebug_debug_breakpoint,
Fam Zheng4cc70e92013-11-20 10:01:54 +08001050 .bdrv_debug_remove_breakpoint
1051 = blkdebug_debug_remove_breakpoint,
Kevin Wolf3c90c652012-12-06 14:32:57 +01001052 .bdrv_debug_resume = blkdebug_debug_resume,
1053 .bdrv_debug_is_suspended = blkdebug_debug_is_suspended,
Max Reitz26542672019-02-01 20:29:25 +01001054
1055 .strong_runtime_opts = blkdebug_strong_runtime_opts,
Kevin Wolf6a143722010-02-18 17:48:12 +01001056};
1057
1058static void bdrv_blkdebug_init(void)
1059{
1060 bdrv_register(&bdrv_blkdebug);
1061}
1062
1063block_init(bdrv_blkdebug_init);