2 * Block protocol for block driver correctness testing
4 * Copyright (C) 2010 IBM, Corp.
6 * This work is licensed under the terms of the GNU GPL, version 2 or later.
7 * See the COPYING file in the top-level directory.
10 #include "qemu/osdep.h"
11 #include "qapi/error.h"
12 #include "qemu/sockets.h" /* for EINPROGRESS on Windows */
13 #include "block/block_int.h"
14 #include "qapi/qmp/qdict.h"
15 #include "qapi/qmp/qstring.h"
16 #include "qemu/cutils.h"
17 #include "qemu/module.h"
18 #include "qemu/option.h"
19 #include "qemu/memalign.h"
25 typedef struct BlkverifyRequest {
29 /* Request metadata */
35 int (*request_fn)(BdrvChild *, int64_t, int64_t, QEMUIOVector *,
38 int ret; /* test image result */
39 int raw_ret; /* raw image result */
41 unsigned int done; /* completion counter */
43 QEMUIOVector *qiov; /* user I/O vector */
44 QEMUIOVector *raw_qiov; /* cloned I/O vector for raw file */
47 static void G_GNUC_PRINTF(2, 3) blkverify_err(BlkverifyRequest *r,
53 fprintf(stderr, "blkverify: %s offset=%" PRId64 " bytes=%" PRId64 " ",
54 r->is_write ? "write" : "read", r->offset, r->bytes);
55 vfprintf(stderr, fmt, ap);
56 fprintf(stderr, "\n");
61 /* Valid blkverify filenames look like blkverify:path/to/raw_image:path/to/image */
62 static void blkverify_parse_filename(const char *filename, QDict *options,
69 /* Parse the blkverify: prefix */
70 if (!strstart(filename, "blkverify:", &filename)) {
71 /* There was no prefix; therefore, all options have to be already
72 present in the QDict (except for the filename) */
73 qdict_put_str(options, "x-image", filename);
77 /* Parse the raw image filename */
78 c = strchr(filename, ':');
80 error_setg(errp, "blkverify requires raw copy and original image path");
84 /* TODO Implement option pass-through and set raw.filename here */
85 raw_path = qstring_from_substr(filename, 0, c - filename);
86 qdict_put(options, "x-raw", raw_path);
88 /* TODO Allow multi-level nesting and set file.filename here */
90 qdict_put_str(options, "x-image", filename);
93 static QemuOptsList runtime_opts = {
95 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
99 .type = QEMU_OPT_STRING,
100 .help = "[internal use only, will be removed]",
104 .type = QEMU_OPT_STRING,
105 .help = "[internal use only, will be removed]",
107 { /* end of list */ }
111 static int blkverify_open(BlockDriverState *bs, QDict *options, int flags,
114 BDRVBlkverifyState *s = bs->opaque;
118 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
119 if (!qemu_opts_absorb_qdict(opts, options, errp)) {
124 /* Open the raw file */
125 ret = bdrv_open_file_child(qemu_opt_get(opts, "x-raw"), options, "raw",
131 /* Open the test file */
132 s->test_file = bdrv_open_child(qemu_opt_get(opts, "x-image"), options,
133 "test", bs, &child_of_bds, BDRV_CHILD_DATA,
140 bs->supported_write_flags = BDRV_REQ_WRITE_UNCHANGED;
141 bs->supported_zero_flags = BDRV_REQ_WRITE_UNCHANGED;
149 static void blkverify_close(BlockDriverState *bs)
151 BDRVBlkverifyState *s = bs->opaque;
153 bdrv_unref_child(bs, s->test_file);
157 static int64_t blkverify_getlength(BlockDriverState *bs)
159 BDRVBlkverifyState *s = bs->opaque;
161 return bdrv_getlength(s->test_file->bs);
164 static void coroutine_fn blkverify_do_test_req(void *opaque)
166 BlkverifyRequest *r = opaque;
167 BDRVBlkverifyState *s = r->bs->opaque;
169 r->ret = r->request_fn(s->test_file, r->offset, r->bytes, r->qiov,
172 qemu_coroutine_enter_if_inactive(r->co);
175 static void coroutine_fn blkverify_do_raw_req(void *opaque)
177 BlkverifyRequest *r = opaque;
179 r->raw_ret = r->request_fn(r->bs->file, r->offset, r->bytes, r->raw_qiov,
182 qemu_coroutine_enter_if_inactive(r->co);
185 static int coroutine_fn
186 blkverify_co_prwv(BlockDriverState *bs, BlkverifyRequest *r, uint64_t offset,
187 uint64_t bytes, QEMUIOVector *qiov, QEMUIOVector *raw_qiov,
188 int flags, bool is_write)
190 Coroutine *co_a, *co_b;
192 *r = (BlkverifyRequest) {
193 .co = qemu_coroutine_self(),
198 .raw_qiov = raw_qiov,
200 .is_write = is_write,
201 .request_fn = is_write ? bdrv_co_pwritev : bdrv_co_preadv,
204 co_a = qemu_coroutine_create(blkverify_do_test_req, r);
205 co_b = qemu_coroutine_create(blkverify_do_raw_req, r);
207 qemu_coroutine_enter(co_a);
208 qemu_coroutine_enter(co_b);
210 while (r->done < 2) {
211 qemu_coroutine_yield();
214 if (r->ret != r->raw_ret) {
215 blkverify_err(r, "return value mismatch %d != %d", r->ret, r->raw_ret);
221 static int coroutine_fn
222 blkverify_co_preadv(BlockDriverState *bs, int64_t offset, int64_t bytes,
223 QEMUIOVector *qiov, BdrvRequestFlags flags)
226 QEMUIOVector raw_qiov;
231 buf = qemu_blockalign(bs->file->bs, qiov->size);
232 qemu_iovec_init(&raw_qiov, qiov->niov);
233 qemu_iovec_clone(&raw_qiov, qiov, buf);
235 ret = blkverify_co_prwv(bs, &r, offset, bytes, qiov, &raw_qiov, flags,
238 cmp_offset = qemu_iovec_compare(qiov, &raw_qiov);
239 if (cmp_offset != -1) {
240 blkverify_err(&r, "contents mismatch at offset %" PRId64,
241 offset + cmp_offset);
244 qemu_iovec_destroy(&raw_qiov);
250 static int coroutine_fn
251 blkverify_co_pwritev(BlockDriverState *bs, int64_t offset, int64_t bytes,
252 QEMUIOVector *qiov, BdrvRequestFlags flags)
255 return blkverify_co_prwv(bs, &r, offset, bytes, qiov, qiov, flags, true);
258 static int coroutine_fn blkverify_co_flush(BlockDriverState *bs)
260 BDRVBlkverifyState *s = bs->opaque;
262 /* Only flush test file, the raw file is not important */
263 return bdrv_co_flush(s->test_file->bs);
266 static bool blkverify_recurse_can_replace(BlockDriverState *bs,
267 BlockDriverState *to_replace)
269 BDRVBlkverifyState *s = bs->opaque;
272 * blkverify quits the whole qemu process if there is a mismatch
273 * between bs->file->bs and s->test_file->bs. Therefore, we know
274 * know that both must match bs and we can recurse down to either.
276 return bdrv_recurse_can_replace(bs->file->bs, to_replace) ||
277 bdrv_recurse_can_replace(s->test_file->bs, to_replace);
280 static void blkverify_refresh_filename(BlockDriverState *bs)
282 BDRVBlkverifyState *s = bs->opaque;
284 if (bs->file->bs->exact_filename[0]
285 && s->test_file->bs->exact_filename[0])
287 int ret = snprintf(bs->exact_filename, sizeof(bs->exact_filename),
289 bs->file->bs->exact_filename,
290 s->test_file->bs->exact_filename);
291 if (ret >= sizeof(bs->exact_filename)) {
292 /* An overflow makes the filename unusable, so do not report any */
293 bs->exact_filename[0] = 0;
298 static char *blkverify_dirname(BlockDriverState *bs, Error **errp)
300 /* In general, there are two BDSs with different dirnames below this one;
301 * so there is no unique dirname we could return (unless both are equal by
302 * chance). Therefore, to be consistent, just always return NULL. */
303 error_setg(errp, "Cannot generate a base directory for blkverify nodes");
307 static BlockDriver bdrv_blkverify = {
308 .format_name = "blkverify",
309 .protocol_name = "blkverify",
310 .instance_size = sizeof(BDRVBlkverifyState),
312 .bdrv_parse_filename = blkverify_parse_filename,
313 .bdrv_file_open = blkverify_open,
314 .bdrv_close = blkverify_close,
315 .bdrv_child_perm = bdrv_default_perms,
316 .bdrv_getlength = blkverify_getlength,
317 .bdrv_refresh_filename = blkverify_refresh_filename,
318 .bdrv_dirname = blkverify_dirname,
320 .bdrv_co_preadv = blkverify_co_preadv,
321 .bdrv_co_pwritev = blkverify_co_pwritev,
322 .bdrv_co_flush = blkverify_co_flush,
325 .bdrv_recurse_can_replace = blkverify_recurse_can_replace,
328 static void bdrv_blkverify_init(void)
330 bdrv_register(&bdrv_blkverify);
333 block_init(bdrv_blkverify_init);