]>
Commit | Line | Data |
---|---|---|
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 | ||
80c71a24 | 10 | #include "qemu/osdep.h" |
da34e65c | 11 | #include "qapi/error.h" |
1de7afc9 | 12 | #include "qemu/sockets.h" /* for EINPROGRESS on Windows */ |
e2c1c34f | 13 | #include "block/block-io.h" |
737e150e | 14 | #include "block/block_int.h" |
74b36b2e HR |
15 | #include "qapi/qmp/qdict.h" |
16 | #include "qapi/qmp/qstring.h" | |
f348b6d1 | 17 | #include "qemu/cutils.h" |
0b8fa32f | 18 | #include "qemu/module.h" |
922a01a0 | 19 | #include "qemu/option.h" |
5df022cf | 20 | #include "qemu/memalign.h" |
d9d33417 SH |
21 | |
22 | typedef struct { | |
3e586be0 | 23 | BdrvChild *test_file; |
d9d33417 SH |
24 | } BDRVBlkverifyState; |
25 | ||
44b67892 KW |
26 | typedef struct BlkverifyRequest { |
27 | Coroutine *co; | |
28 | BlockDriverState *bs; | |
d9d33417 SH |
29 | |
30 | /* Request metadata */ | |
31 | bool is_write; | |
44b67892 KW |
32 | uint64_t offset; |
33 | uint64_t bytes; | |
34 | int flags; | |
d9d33417 | 35 | |
e9e52efd | 36 | int (*request_fn)(BdrvChild *, int64_t, int64_t, QEMUIOVector *, |
44b67892 | 37 | BdrvRequestFlags); |
d9d33417 | 38 | |
44b67892 KW |
39 | int ret; /* test image result */ |
40 | int raw_ret; /* raw image result */ | |
d9d33417 | 41 | |
44b67892 | 42 | unsigned int done; /* completion counter */ |
d9d33417 | 43 | |
44b67892 KW |
44 | QEMUIOVector *qiov; /* user I/O vector */ |
45 | QEMUIOVector *raw_qiov; /* cloned I/O vector for raw file */ | |
46 | } BlkverifyRequest; | |
d9d33417 | 47 | |
9edc6313 | 48 | static void G_GNUC_PRINTF(2, 3) blkverify_err(BlkverifyRequest *r, |
a77cffe7 | 49 | const char *fmt, ...) |
d9d33417 SH |
50 | { |
51 | va_list ap; | |
52 | ||
53 | va_start(ap, fmt); | |
44b67892 KW |
54 | fprintf(stderr, "blkverify: %s offset=%" PRId64 " bytes=%" PRId64 " ", |
55 | r->is_write ? "write" : "read", r->offset, r->bytes); | |
d9d33417 SH |
56 | vfprintf(stderr, fmt, ap); |
57 | fprintf(stderr, "\n"); | |
58 | va_end(ap); | |
59 | exit(1); | |
60 | } | |
61 | ||
62 | /* Valid blkverify filenames look like blkverify:path/to/raw_image:path/to/image */ | |
16c79092 KW |
63 | static void blkverify_parse_filename(const char *filename, QDict *options, |
64 | Error **errp) | |
d9d33417 | 65 | { |
16c79092 KW |
66 | const char *c; |
67 | QString *raw_path; | |
68 | ||
d9d33417 SH |
69 | |
70 | /* Parse the blkverify: prefix */ | |
16c79092 | 71 | if (!strstart(filename, "blkverify:", &filename)) { |
22511ad6 HR |
72 | /* There was no prefix; therefore, all options have to be already |
73 | present in the QDict (except for the filename) */ | |
46f5ac20 | 74 | qdict_put_str(options, "x-image", filename); |
16c79092 | 75 | return; |
d9d33417 | 76 | } |
d9d33417 SH |
77 | |
78 | /* Parse the raw image filename */ | |
79 | c = strchr(filename, ':'); | |
80 | if (c == NULL) { | |
16c79092 KW |
81 | error_setg(errp, "blkverify requires raw copy and original image path"); |
82 | return; | |
83 | } | |
84 | ||
85 | /* TODO Implement option pass-through and set raw.filename here */ | |
ba891d68 | 86 | raw_path = qstring_from_substr(filename, 0, c - filename); |
16c79092 KW |
87 | qdict_put(options, "x-raw", raw_path); |
88 | ||
89 | /* TODO Allow multi-level nesting and set file.filename here */ | |
90 | filename = c + 1; | |
46f5ac20 | 91 | qdict_put_str(options, "x-image", filename); |
16c79092 KW |
92 | } |
93 | ||
94 | static QemuOptsList runtime_opts = { | |
95 | .name = "blkverify", | |
96 | .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head), | |
97 | .desc = { | |
98 | { | |
99 | .name = "x-raw", | |
100 | .type = QEMU_OPT_STRING, | |
101 | .help = "[internal use only, will be removed]", | |
102 | }, | |
103 | { | |
104 | .name = "x-image", | |
105 | .type = QEMU_OPT_STRING, | |
106 | .help = "[internal use only, will be removed]", | |
107 | }, | |
108 | { /* end of list */ } | |
109 | }, | |
110 | }; | |
111 | ||
015a1036 HR |
112 | static int blkverify_open(BlockDriverState *bs, QDict *options, int flags, |
113 | Error **errp) | |
16c79092 KW |
114 | { |
115 | BDRVBlkverifyState *s = bs->opaque; | |
116 | QemuOpts *opts; | |
16c79092 KW |
117 | int ret; |
118 | ||
87ea75d5 | 119 | opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort); |
af175e85 | 120 | if (!qemu_opts_absorb_qdict(opts, options, errp)) { |
16c79092 KW |
121 | ret = -EINVAL; |
122 | goto fail; | |
123 | } | |
124 | ||
70b6198a | 125 | /* Open the raw file */ |
83930780 VSO |
126 | ret = bdrv_open_file_child(qemu_opt_get(opts, "x-raw"), options, "raw", |
127 | bs, errp); | |
128 | if (ret < 0) { | |
16c79092 | 129 | goto fail; |
d9d33417 | 130 | } |
d9d33417 SH |
131 | |
132 | /* Open the test file */ | |
3e586be0 | 133 | s->test_file = bdrv_open_child(qemu_opt_get(opts, "x-image"), options, |
36ee58d1 | 134 | "test", bs, &child_of_bds, BDRV_CHILD_DATA, |
bc520249 VSO |
135 | false, errp); |
136 | if (!s->test_file) { | |
3e586be0 | 137 | ret = -EINVAL; |
16c79092 | 138 | goto fail; |
d9d33417 SH |
139 | } |
140 | ||
228345bf HR |
141 | bs->supported_write_flags = BDRV_REQ_WRITE_UNCHANGED; |
142 | bs->supported_zero_flags = BDRV_REQ_WRITE_UNCHANGED; | |
143 | ||
16c79092 KW |
144 | ret = 0; |
145 | fail: | |
31585931 | 146 | qemu_opts_del(opts); |
16c79092 | 147 | return ret; |
d9d33417 SH |
148 | } |
149 | ||
150 | static void blkverify_close(BlockDriverState *bs) | |
151 | { | |
152 | BDRVBlkverifyState *s = bs->opaque; | |
153 | ||
3e586be0 | 154 | bdrv_unref_child(bs, s->test_file); |
d9d33417 SH |
155 | s->test_file = NULL; |
156 | } | |
157 | ||
c86422c5 | 158 | static int64_t coroutine_fn blkverify_co_getlength(BlockDriverState *bs) |
d9d33417 SH |
159 | { |
160 | BDRVBlkverifyState *s = bs->opaque; | |
161 | ||
c86422c5 | 162 | return bdrv_co_getlength(s->test_file->bs); |
d9d33417 SH |
163 | } |
164 | ||
44b67892 | 165 | static void coroutine_fn blkverify_do_test_req(void *opaque) |
d9d33417 | 166 | { |
44b67892 KW |
167 | BlkverifyRequest *r = opaque; |
168 | BDRVBlkverifyState *s = r->bs->opaque; | |
169 | ||
170 | r->ret = r->request_fn(s->test_file, r->offset, r->bytes, r->qiov, | |
171 | r->flags); | |
172 | r->done++; | |
173 | qemu_coroutine_enter_if_inactive(r->co); | |
d9d33417 SH |
174 | } |
175 | ||
44b67892 | 176 | static void coroutine_fn blkverify_do_raw_req(void *opaque) |
d9d33417 | 177 | { |
44b67892 | 178 | BlkverifyRequest *r = opaque; |
d9d33417 | 179 | |
44b67892 KW |
180 | r->raw_ret = r->request_fn(r->bs->file, r->offset, r->bytes, r->raw_qiov, |
181 | r->flags); | |
182 | r->done++; | |
183 | qemu_coroutine_enter_if_inactive(r->co); | |
d9d33417 SH |
184 | } |
185 | ||
44b67892 KW |
186 | static int coroutine_fn |
187 | blkverify_co_prwv(BlockDriverState *bs, BlkverifyRequest *r, uint64_t offset, | |
188 | uint64_t bytes, QEMUIOVector *qiov, QEMUIOVector *raw_qiov, | |
189 | int flags, bool is_write) | |
d9d33417 | 190 | { |
44b67892 KW |
191 | Coroutine *co_a, *co_b; |
192 | ||
193 | *r = (BlkverifyRequest) { | |
194 | .co = qemu_coroutine_self(), | |
195 | .bs = bs, | |
196 | .offset = offset, | |
197 | .bytes = bytes, | |
198 | .qiov = qiov, | |
199 | .raw_qiov = raw_qiov, | |
200 | .flags = flags, | |
201 | .is_write = is_write, | |
202 | .request_fn = is_write ? bdrv_co_pwritev : bdrv_co_preadv, | |
203 | }; | |
204 | ||
205 | co_a = qemu_coroutine_create(blkverify_do_test_req, r); | |
206 | co_b = qemu_coroutine_create(blkverify_do_raw_req, r); | |
207 | ||
208 | qemu_coroutine_enter(co_a); | |
209 | qemu_coroutine_enter(co_b); | |
210 | ||
211 | while (r->done < 2) { | |
212 | qemu_coroutine_yield(); | |
213 | } | |
d9d33417 | 214 | |
44b67892 KW |
215 | if (r->ret != r->raw_ret) { |
216 | blkverify_err(r, "return value mismatch %d != %d", r->ret, r->raw_ret); | |
d9d33417 | 217 | } |
44b67892 KW |
218 | |
219 | return r->ret; | |
d9d33417 SH |
220 | } |
221 | ||
44b67892 | 222 | static int coroutine_fn |
f7ef38dd VSO |
223 | blkverify_co_preadv(BlockDriverState *bs, int64_t offset, int64_t bytes, |
224 | QEMUIOVector *qiov, BdrvRequestFlags flags) | |
d9d33417 | 225 | { |
44b67892 KW |
226 | BlkverifyRequest r; |
227 | QEMUIOVector raw_qiov; | |
228 | void *buf; | |
229 | ssize_t cmp_offset; | |
230 | int ret; | |
231 | ||
232 | buf = qemu_blockalign(bs->file->bs, qiov->size); | |
233 | qemu_iovec_init(&raw_qiov, qiov->niov); | |
234 | qemu_iovec_clone(&raw_qiov, qiov, buf); | |
235 | ||
e8b65355 SH |
236 | ret = blkverify_co_prwv(bs, &r, offset, bytes, qiov, &raw_qiov, |
237 | flags & ~BDRV_REQ_REGISTERED_BUF, false); | |
44b67892 KW |
238 | |
239 | cmp_offset = qemu_iovec_compare(qiov, &raw_qiov); | |
240 | if (cmp_offset != -1) { | |
241 | blkverify_err(&r, "contents mismatch at offset %" PRId64, | |
242 | offset + cmp_offset); | |
d9d33417 | 243 | } |
d9d33417 | 244 | |
44b67892 KW |
245 | qemu_iovec_destroy(&raw_qiov); |
246 | qemu_vfree(buf); | |
247 | ||
248 | return ret; | |
d9d33417 SH |
249 | } |
250 | ||
44b67892 | 251 | static int coroutine_fn |
e75abeda VSO |
252 | blkverify_co_pwritev(BlockDriverState *bs, int64_t offset, int64_t bytes, |
253 | QEMUIOVector *qiov, BdrvRequestFlags flags) | |
d9d33417 | 254 | { |
44b67892 KW |
255 | BlkverifyRequest r; |
256 | return blkverify_co_prwv(bs, &r, offset, bytes, qiov, qiov, flags, true); | |
d9d33417 SH |
257 | } |
258 | ||
617b4b17 | 259 | static int coroutine_fn blkverify_co_flush(BlockDriverState *bs) |
d9d33417 SH |
260 | { |
261 | BDRVBlkverifyState *s = bs->opaque; | |
262 | ||
263 | /* Only flush test file, the raw file is not important */ | |
44b67892 | 264 | return bdrv_co_flush(s->test_file->bs); |
d9d33417 SH |
265 | } |
266 | ||
998a6b2f HR |
267 | static bool blkverify_recurse_can_replace(BlockDriverState *bs, |
268 | BlockDriverState *to_replace) | |
269 | { | |
270 | BDRVBlkverifyState *s = bs->opaque; | |
271 | ||
272 | /* | |
273 | * blkverify quits the whole qemu process if there is a mismatch | |
274 | * between bs->file->bs and s->test_file->bs. Therefore, we know | |
275 | * know that both must match bs and we can recurse down to either. | |
276 | */ | |
277 | return bdrv_recurse_can_replace(bs->file->bs, to_replace) || | |
278 | bdrv_recurse_can_replace(s->test_file->bs, to_replace); | |
279 | } | |
280 | ||
998b3a1e | 281 | static void blkverify_refresh_filename(BlockDriverState *bs) |
74b36b2e HR |
282 | { |
283 | BDRVBlkverifyState *s = bs->opaque; | |
284 | ||
9a4f4c31 KW |
285 | if (bs->file->bs->exact_filename[0] |
286 | && s->test_file->bs->exact_filename[0]) | |
287 | { | |
05cc758a HR |
288 | int ret = snprintf(bs->exact_filename, sizeof(bs->exact_filename), |
289 | "blkverify:%s:%s", | |
290 | bs->file->bs->exact_filename, | |
291 | s->test_file->bs->exact_filename); | |
292 | if (ret >= sizeof(bs->exact_filename)) { | |
293 | /* An overflow makes the filename unusable, so do not report any */ | |
294 | bs->exact_filename[0] = 0; | |
295 | } | |
74b36b2e HR |
296 | } |
297 | } | |
298 | ||
27953572 HR |
299 | static char *blkverify_dirname(BlockDriverState *bs, Error **errp) |
300 | { | |
301 | /* In general, there are two BDSs with different dirnames below this one; | |
302 | * so there is no unique dirname we could return (unless both are equal by | |
303 | * chance). Therefore, to be consistent, just always return NULL. */ | |
304 | error_setg(errp, "Cannot generate a base directory for blkverify nodes"); | |
305 | return NULL; | |
306 | } | |
307 | ||
d9d33417 | 308 | static BlockDriver bdrv_blkverify = { |
9d94020b SH |
309 | .format_name = "blkverify", |
310 | .protocol_name = "blkverify", | |
311 | .instance_size = sizeof(BDRVBlkverifyState), | |
312 | ||
313 | .bdrv_parse_filename = blkverify_parse_filename, | |
314 | .bdrv_file_open = blkverify_open, | |
315 | .bdrv_close = blkverify_close, | |
69dca43d | 316 | .bdrv_child_perm = bdrv_default_perms, |
c86422c5 | 317 | .bdrv_co_getlength = blkverify_co_getlength, |
74b36b2e | 318 | .bdrv_refresh_filename = blkverify_refresh_filename, |
27953572 | 319 | .bdrv_dirname = blkverify_dirname, |
16c79092 | 320 | |
44b67892 KW |
321 | .bdrv_co_preadv = blkverify_co_preadv, |
322 | .bdrv_co_pwritev = blkverify_co_pwritev, | |
323 | .bdrv_co_flush = blkverify_co_flush, | |
16c79092 | 324 | |
9d94020b | 325 | .is_filter = true, |
998a6b2f | 326 | .bdrv_recurse_can_replace = blkverify_recurse_can_replace, |
d9d33417 SH |
327 | }; |
328 | ||
329 | static void bdrv_blkverify_init(void) | |
330 | { | |
331 | bdrv_register(&bdrv_blkverify); | |
332 | } | |
333 | ||
334 | block_init(bdrv_blkverify_init); |