]> git.proxmox.com Git - mirror_qemu.git/blame - block/blkverify.c
block: Rename BlockDriverAIOCB* to BlockAIOCB*
[mirror_qemu.git] / block / blkverify.c
CommitLineData
d9d33417
SH
1/*
2 * Block protocol for block driver correctness testing
3 *
4 * Copyright (C) 2010 IBM, Corp.
5 *
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.
8 */
9
10#include <stdarg.h>
1de7afc9 11#include "qemu/sockets.h" /* for EINPROGRESS on Windows */
737e150e 12#include "block/block_int.h"
74b36b2e
HR
13#include "qapi/qmp/qdict.h"
14#include "qapi/qmp/qstring.h"
d9d33417
SH
15
16typedef struct {
17 BlockDriverState *test_file;
18} BDRVBlkverifyState;
19
20typedef struct BlkverifyAIOCB BlkverifyAIOCB;
21struct BlkverifyAIOCB {
7c84b1b8 22 BlockAIOCB common;
d9d33417
SH
23 QEMUBH *bh;
24
25 /* Request metadata */
26 bool is_write;
27 int64_t sector_num;
28 int nb_sectors;
29
30 int ret; /* first completed request's result */
31 unsigned int done; /* completion counter */
d9d33417
SH
32
33 QEMUIOVector *qiov; /* user I/O vector */
34 QEMUIOVector raw_qiov; /* cloned I/O vector for raw file */
35 void *buf; /* buffer for raw file I/O */
36
37 void (*verify)(BlkverifyAIOCB *acb);
38};
39
d7331bed 40static const AIOCBInfo blkverify_aiocb_info = {
d9d33417 41 .aiocb_size = sizeof(BlkverifyAIOCB),
d9d33417
SH
42};
43
a77cffe7
SW
44static void GCC_FMT_ATTR(2, 3) blkverify_err(BlkverifyAIOCB *acb,
45 const char *fmt, ...)
d9d33417
SH
46{
47 va_list ap;
48
49 va_start(ap, fmt);
687db4ed 50 fprintf(stderr, "blkverify: %s sector_num=%" PRId64 " nb_sectors=%d ",
d9d33417
SH
51 acb->is_write ? "write" : "read", acb->sector_num,
52 acb->nb_sectors);
53 vfprintf(stderr, fmt, ap);
54 fprintf(stderr, "\n");
55 va_end(ap);
56 exit(1);
57}
58
59/* Valid blkverify filenames look like blkverify:path/to/raw_image:path/to/image */
16c79092
KW
60static void blkverify_parse_filename(const char *filename, QDict *options,
61 Error **errp)
d9d33417 62{
16c79092
KW
63 const char *c;
64 QString *raw_path;
65
d9d33417
SH
66
67 /* Parse the blkverify: prefix */
16c79092 68 if (!strstart(filename, "blkverify:", &filename)) {
22511ad6
HR
69 /* There was no prefix; therefore, all options have to be already
70 present in the QDict (except for the filename) */
71 qdict_put(options, "x-image", qstring_from_str(filename));
16c79092 72 return;
d9d33417 73 }
d9d33417
SH
74
75 /* Parse the raw image filename */
76 c = strchr(filename, ':');
77 if (c == NULL) {
16c79092
KW
78 error_setg(errp, "blkverify requires raw copy and original image path");
79 return;
80 }
81
82 /* TODO Implement option pass-through and set raw.filename here */
83 raw_path = qstring_from_substr(filename, 0, c - filename - 1);
84 qdict_put(options, "x-raw", raw_path);
85
86 /* TODO Allow multi-level nesting and set file.filename here */
87 filename = c + 1;
88 qdict_put(options, "x-image", qstring_from_str(filename));
89}
90
91static QemuOptsList runtime_opts = {
92 .name = "blkverify",
93 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
94 .desc = {
95 {
96 .name = "x-raw",
97 .type = QEMU_OPT_STRING,
98 .help = "[internal use only, will be removed]",
99 },
100 {
101 .name = "x-image",
102 .type = QEMU_OPT_STRING,
103 .help = "[internal use only, will be removed]",
104 },
105 { /* end of list */ }
106 },
107};
108
015a1036
HR
109static int blkverify_open(BlockDriverState *bs, QDict *options, int flags,
110 Error **errp)
16c79092
KW
111{
112 BDRVBlkverifyState *s = bs->opaque;
113 QemuOpts *opts;
114 Error *local_err = NULL;
16c79092
KW
115 int ret;
116
87ea75d5 117 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
16c79092 118 qemu_opts_absorb_qdict(opts, options, &local_err);
84d18f06 119 if (local_err) {
ca288408 120 error_propagate(errp, local_err);
16c79092
KW
121 ret = -EINVAL;
122 goto fail;
123 }
124
70b6198a 125 /* Open the raw file */
f67503e5 126 assert(bs->file == NULL);
70b6198a 127 ret = bdrv_open_image(&bs->file, qemu_opt_get(opts, "x-raw"), options,
f7d9fd8c 128 "raw", flags | BDRV_O_PROTOCOL, false, &local_err);
d9d33417 129 if (ret < 0) {
ca288408 130 error_propagate(errp, local_err);
16c79092 131 goto fail;
d9d33417 132 }
d9d33417
SH
133
134 /* Open the test file */
f67503e5 135 assert(s->test_file == NULL);
70b6198a 136 ret = bdrv_open_image(&s->test_file, qemu_opt_get(opts, "x-image"), options,
f7d9fd8c 137 "test", flags, false, &local_err);
d9d33417 138 if (ret < 0) {
ca288408 139 error_propagate(errp, local_err);
d9d33417 140 s->test_file = NULL;
16c79092 141 goto fail;
d9d33417
SH
142 }
143
16c79092
KW
144 ret = 0;
145fail:
31585931 146 qemu_opts_del(opts);
16c79092 147 return ret;
d9d33417
SH
148}
149
150static void blkverify_close(BlockDriverState *bs)
151{
152 BDRVBlkverifyState *s = bs->opaque;
153
4f6fd349 154 bdrv_unref(s->test_file);
d9d33417
SH
155 s->test_file = NULL;
156}
157
d9d33417
SH
158static int64_t blkverify_getlength(BlockDriverState *bs)
159{
160 BDRVBlkverifyState *s = bs->opaque;
161
162 return bdrv_getlength(s->test_file);
163}
164
d9d33417
SH
165static BlkverifyAIOCB *blkverify_aio_get(BlockDriverState *bs, bool is_write,
166 int64_t sector_num, QEMUIOVector *qiov,
167 int nb_sectors,
168 BlockDriverCompletionFunc *cb,
169 void *opaque)
170{
d7331bed 171 BlkverifyAIOCB *acb = qemu_aio_get(&blkverify_aiocb_info, bs, cb, opaque);
d9d33417
SH
172
173 acb->bh = NULL;
174 acb->is_write = is_write;
175 acb->sector_num = sector_num;
176 acb->nb_sectors = nb_sectors;
177 acb->ret = -EINPROGRESS;
178 acb->done = 0;
179 acb->qiov = qiov;
180 acb->buf = NULL;
181 acb->verify = NULL;
d9d33417
SH
182 return acb;
183}
184
185static void blkverify_aio_bh(void *opaque)
186{
187 BlkverifyAIOCB *acb = opaque;
188
189 qemu_bh_delete(acb->bh);
190 if (acb->buf) {
191 qemu_iovec_destroy(&acb->raw_qiov);
192 qemu_vfree(acb->buf);
193 }
194 acb->common.cb(acb->common.opaque, acb->ret);
8007429a 195 qemu_aio_unref(acb);
d9d33417
SH
196}
197
198static void blkverify_aio_cb(void *opaque, int ret)
199{
200 BlkverifyAIOCB *acb = opaque;
201
202 switch (++acb->done) {
203 case 1:
204 acb->ret = ret;
205 break;
206
207 case 2:
208 if (acb->ret != ret) {
209 blkverify_err(acb, "return value mismatch %d != %d", acb->ret, ret);
210 }
211
212 if (acb->verify) {
213 acb->verify(acb);
214 }
215
9d94020b
SH
216 acb->bh = aio_bh_new(bdrv_get_aio_context(acb->common.bs),
217 blkverify_aio_bh, acb);
d9d33417
SH
218 qemu_bh_schedule(acb->bh);
219 break;
220 }
221}
222
223static void blkverify_verify_readv(BlkverifyAIOCB *acb)
224{
f70d7f7e 225 ssize_t offset = qemu_iovec_compare(acb->qiov, &acb->raw_qiov);
d9d33417 226 if (offset != -1) {
a3133586
BS
227 blkverify_err(acb, "contents mismatch in sector %" PRId64,
228 acb->sector_num + (int64_t)(offset / BDRV_SECTOR_SIZE));
d9d33417
SH
229 }
230}
231
7c84b1b8 232static BlockAIOCB *blkverify_aio_readv(BlockDriverState *bs,
d9d33417
SH
233 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
234 BlockDriverCompletionFunc *cb, void *opaque)
235{
236 BDRVBlkverifyState *s = bs->opaque;
237 BlkverifyAIOCB *acb = blkverify_aio_get(bs, false, sector_num, qiov,
238 nb_sectors, cb, opaque);
239
240 acb->verify = blkverify_verify_readv;
241 acb->buf = qemu_blockalign(bs->file, qiov->size);
242 qemu_iovec_init(&acb->raw_qiov, acb->qiov->niov);
f70d7f7e 243 qemu_iovec_clone(&acb->raw_qiov, qiov, acb->buf);
d9d33417 244
ad54ae80
PB
245 bdrv_aio_readv(s->test_file, sector_num, qiov, nb_sectors,
246 blkverify_aio_cb, acb);
247 bdrv_aio_readv(bs->file, sector_num, &acb->raw_qiov, nb_sectors,
248 blkverify_aio_cb, acb);
d9d33417
SH
249 return &acb->common;
250}
251
7c84b1b8 252static BlockAIOCB *blkverify_aio_writev(BlockDriverState *bs,
d9d33417
SH
253 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
254 BlockDriverCompletionFunc *cb, void *opaque)
255{
256 BDRVBlkverifyState *s = bs->opaque;
257 BlkverifyAIOCB *acb = blkverify_aio_get(bs, true, sector_num, qiov,
258 nb_sectors, cb, opaque);
259
ad54ae80
PB
260 bdrv_aio_writev(s->test_file, sector_num, qiov, nb_sectors,
261 blkverify_aio_cb, acb);
262 bdrv_aio_writev(bs->file, sector_num, qiov, nb_sectors,
263 blkverify_aio_cb, acb);
d9d33417
SH
264 return &acb->common;
265}
266
7c84b1b8
MA
267static BlockAIOCB *blkverify_aio_flush(BlockDriverState *bs,
268 BlockDriverCompletionFunc *cb,
269 void *opaque)
d9d33417
SH
270{
271 BDRVBlkverifyState *s = bs->opaque;
272
273 /* Only flush test file, the raw file is not important */
274 return bdrv_aio_flush(s->test_file, cb, opaque);
275}
276
b5042a36
BC
277static bool blkverify_recurse_is_first_non_filter(BlockDriverState *bs,
278 BlockDriverState *candidate)
279{
280 BDRVBlkverifyState *s = bs->opaque;
281
282 bool perm = bdrv_recurse_is_first_non_filter(bs->file, candidate);
283
284 if (perm) {
285 return true;
286 }
287
288 return bdrv_recurse_is_first_non_filter(s->test_file, candidate);
289}
290
9d94020b
SH
291/* Propagate AioContext changes to ->test_file */
292static void blkverify_detach_aio_context(BlockDriverState *bs)
293{
294 BDRVBlkverifyState *s = bs->opaque;
295
296 bdrv_detach_aio_context(s->test_file);
297}
298
299static void blkverify_attach_aio_context(BlockDriverState *bs,
300 AioContext *new_context)
301{
302 BDRVBlkverifyState *s = bs->opaque;
303
304 bdrv_attach_aio_context(s->test_file, new_context);
305}
306
74b36b2e
HR
307static void blkverify_refresh_filename(BlockDriverState *bs)
308{
309 BDRVBlkverifyState *s = bs->opaque;
310
311 /* bs->file has already been refreshed */
312 bdrv_refresh_filename(s->test_file);
313
314 if (bs->file->full_open_options && s->test_file->full_open_options) {
315 QDict *opts = qdict_new();
316 qdict_put_obj(opts, "driver", QOBJECT(qstring_from_str("blkverify")));
317
318 QINCREF(bs->file->full_open_options);
319 qdict_put_obj(opts, "raw", QOBJECT(bs->file->full_open_options));
320 QINCREF(s->test_file->full_open_options);
321 qdict_put_obj(opts, "test", QOBJECT(s->test_file->full_open_options));
322
323 bs->full_open_options = opts;
324 }
325
326 if (bs->file->exact_filename[0] && s->test_file->exact_filename[0]) {
327 snprintf(bs->exact_filename, sizeof(bs->exact_filename),
328 "blkverify:%s:%s",
329 bs->file->exact_filename, s->test_file->exact_filename);
330 }
331}
332
d9d33417 333static BlockDriver bdrv_blkverify = {
9d94020b
SH
334 .format_name = "blkverify",
335 .protocol_name = "blkverify",
336 .instance_size = sizeof(BDRVBlkverifyState),
337
338 .bdrv_parse_filename = blkverify_parse_filename,
339 .bdrv_file_open = blkverify_open,
340 .bdrv_close = blkverify_close,
341 .bdrv_getlength = blkverify_getlength,
74b36b2e 342 .bdrv_refresh_filename = blkverify_refresh_filename,
16c79092 343
9d94020b
SH
344 .bdrv_aio_readv = blkverify_aio_readv,
345 .bdrv_aio_writev = blkverify_aio_writev,
346 .bdrv_aio_flush = blkverify_aio_flush,
16c79092 347
9d94020b
SH
348 .bdrv_attach_aio_context = blkverify_attach_aio_context,
349 .bdrv_detach_aio_context = blkverify_detach_aio_context,
f6186f49 350
9d94020b 351 .is_filter = true,
b5042a36 352 .bdrv_recurse_is_first_non_filter = blkverify_recurse_is_first_non_filter,
d9d33417
SH
353};
354
355static void bdrv_blkverify_init(void)
356{
357 bdrv_register(&bdrv_blkverify);
358}
359
360block_init(bdrv_blkverify_init);