]> git.proxmox.com Git - mirror_qemu.git/blob - block/qed.c
Merge remote-tracking branch 'remotes/qmp-unstable/queue/qmp' into staging
[mirror_qemu.git] / block / qed.c
1 /*
2 * QEMU Enhanced Disk Format
3 *
4 * Copyright IBM, Corp. 2010
5 *
6 * Authors:
7 * Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
8 * Anthony Liguori <aliguori@us.ibm.com>
9 *
10 * This work is licensed under the terms of the GNU LGPL, version 2 or later.
11 * See the COPYING.LIB file in the top-level directory.
12 *
13 */
14
15 #include "qemu/timer.h"
16 #include "trace.h"
17 #include "qed.h"
18 #include "qapi/qmp/qerror.h"
19 #include "migration/migration.h"
20
21 static void qed_aio_cancel(BlockDriverAIOCB *blockacb)
22 {
23 QEDAIOCB *acb = (QEDAIOCB *)blockacb;
24 AioContext *aio_context = bdrv_get_aio_context(blockacb->bs);
25 bool finished = false;
26
27 /* Wait for the request to finish */
28 acb->finished = &finished;
29 while (!finished) {
30 aio_poll(aio_context, true);
31 }
32 }
33
34 static const AIOCBInfo qed_aiocb_info = {
35 .aiocb_size = sizeof(QEDAIOCB),
36 .cancel = qed_aio_cancel,
37 };
38
39 static int bdrv_qed_probe(const uint8_t *buf, int buf_size,
40 const char *filename)
41 {
42 const QEDHeader *header = (const QEDHeader *)buf;
43
44 if (buf_size < sizeof(*header)) {
45 return 0;
46 }
47 if (le32_to_cpu(header->magic) != QED_MAGIC) {
48 return 0;
49 }
50 return 100;
51 }
52
53 /**
54 * Check whether an image format is raw
55 *
56 * @fmt: Backing file format, may be NULL
57 */
58 static bool qed_fmt_is_raw(const char *fmt)
59 {
60 return fmt && strcmp(fmt, "raw") == 0;
61 }
62
63 static void qed_header_le_to_cpu(const QEDHeader *le, QEDHeader *cpu)
64 {
65 cpu->magic = le32_to_cpu(le->magic);
66 cpu->cluster_size = le32_to_cpu(le->cluster_size);
67 cpu->table_size = le32_to_cpu(le->table_size);
68 cpu->header_size = le32_to_cpu(le->header_size);
69 cpu->features = le64_to_cpu(le->features);
70 cpu->compat_features = le64_to_cpu(le->compat_features);
71 cpu->autoclear_features = le64_to_cpu(le->autoclear_features);
72 cpu->l1_table_offset = le64_to_cpu(le->l1_table_offset);
73 cpu->image_size = le64_to_cpu(le->image_size);
74 cpu->backing_filename_offset = le32_to_cpu(le->backing_filename_offset);
75 cpu->backing_filename_size = le32_to_cpu(le->backing_filename_size);
76 }
77
78 static void qed_header_cpu_to_le(const QEDHeader *cpu, QEDHeader *le)
79 {
80 le->magic = cpu_to_le32(cpu->magic);
81 le->cluster_size = cpu_to_le32(cpu->cluster_size);
82 le->table_size = cpu_to_le32(cpu->table_size);
83 le->header_size = cpu_to_le32(cpu->header_size);
84 le->features = cpu_to_le64(cpu->features);
85 le->compat_features = cpu_to_le64(cpu->compat_features);
86 le->autoclear_features = cpu_to_le64(cpu->autoclear_features);
87 le->l1_table_offset = cpu_to_le64(cpu->l1_table_offset);
88 le->image_size = cpu_to_le64(cpu->image_size);
89 le->backing_filename_offset = cpu_to_le32(cpu->backing_filename_offset);
90 le->backing_filename_size = cpu_to_le32(cpu->backing_filename_size);
91 }
92
93 int qed_write_header_sync(BDRVQEDState *s)
94 {
95 QEDHeader le;
96 int ret;
97
98 qed_header_cpu_to_le(&s->header, &le);
99 ret = bdrv_pwrite(s->bs->file, 0, &le, sizeof(le));
100 if (ret != sizeof(le)) {
101 return ret;
102 }
103 return 0;
104 }
105
106 typedef struct {
107 GenericCB gencb;
108 BDRVQEDState *s;
109 struct iovec iov;
110 QEMUIOVector qiov;
111 int nsectors;
112 uint8_t *buf;
113 } QEDWriteHeaderCB;
114
115 static void qed_write_header_cb(void *opaque, int ret)
116 {
117 QEDWriteHeaderCB *write_header_cb = opaque;
118
119 qemu_vfree(write_header_cb->buf);
120 gencb_complete(write_header_cb, ret);
121 }
122
123 static void qed_write_header_read_cb(void *opaque, int ret)
124 {
125 QEDWriteHeaderCB *write_header_cb = opaque;
126 BDRVQEDState *s = write_header_cb->s;
127
128 if (ret) {
129 qed_write_header_cb(write_header_cb, ret);
130 return;
131 }
132
133 /* Update header */
134 qed_header_cpu_to_le(&s->header, (QEDHeader *)write_header_cb->buf);
135
136 bdrv_aio_writev(s->bs->file, 0, &write_header_cb->qiov,
137 write_header_cb->nsectors, qed_write_header_cb,
138 write_header_cb);
139 }
140
141 /**
142 * Update header in-place (does not rewrite backing filename or other strings)
143 *
144 * This function only updates known header fields in-place and does not affect
145 * extra data after the QED header.
146 */
147 static void qed_write_header(BDRVQEDState *s, BlockDriverCompletionFunc cb,
148 void *opaque)
149 {
150 /* We must write full sectors for O_DIRECT but cannot necessarily generate
151 * the data following the header if an unrecognized compat feature is
152 * active. Therefore, first read the sectors containing the header, update
153 * them, and write back.
154 */
155
156 int nsectors = (sizeof(QEDHeader) + BDRV_SECTOR_SIZE - 1) /
157 BDRV_SECTOR_SIZE;
158 size_t len = nsectors * BDRV_SECTOR_SIZE;
159 QEDWriteHeaderCB *write_header_cb = gencb_alloc(sizeof(*write_header_cb),
160 cb, opaque);
161
162 write_header_cb->s = s;
163 write_header_cb->nsectors = nsectors;
164 write_header_cb->buf = qemu_blockalign(s->bs, len);
165 write_header_cb->iov.iov_base = write_header_cb->buf;
166 write_header_cb->iov.iov_len = len;
167 qemu_iovec_init_external(&write_header_cb->qiov, &write_header_cb->iov, 1);
168
169 bdrv_aio_readv(s->bs->file, 0, &write_header_cb->qiov, nsectors,
170 qed_write_header_read_cb, write_header_cb);
171 }
172
173 static uint64_t qed_max_image_size(uint32_t cluster_size, uint32_t table_size)
174 {
175 uint64_t table_entries;
176 uint64_t l2_size;
177
178 table_entries = (table_size * cluster_size) / sizeof(uint64_t);
179 l2_size = table_entries * cluster_size;
180
181 return l2_size * table_entries;
182 }
183
184 static bool qed_is_cluster_size_valid(uint32_t cluster_size)
185 {
186 if (cluster_size < QED_MIN_CLUSTER_SIZE ||
187 cluster_size > QED_MAX_CLUSTER_SIZE) {
188 return false;
189 }
190 if (cluster_size & (cluster_size - 1)) {
191 return false; /* not power of 2 */
192 }
193 return true;
194 }
195
196 static bool qed_is_table_size_valid(uint32_t table_size)
197 {
198 if (table_size < QED_MIN_TABLE_SIZE ||
199 table_size > QED_MAX_TABLE_SIZE) {
200 return false;
201 }
202 if (table_size & (table_size - 1)) {
203 return false; /* not power of 2 */
204 }
205 return true;
206 }
207
208 static bool qed_is_image_size_valid(uint64_t image_size, uint32_t cluster_size,
209 uint32_t table_size)
210 {
211 if (image_size % BDRV_SECTOR_SIZE != 0) {
212 return false; /* not multiple of sector size */
213 }
214 if (image_size > qed_max_image_size(cluster_size, table_size)) {
215 return false; /* image is too large */
216 }
217 return true;
218 }
219
220 /**
221 * Read a string of known length from the image file
222 *
223 * @file: Image file
224 * @offset: File offset to start of string, in bytes
225 * @n: String length in bytes
226 * @buf: Destination buffer
227 * @buflen: Destination buffer length in bytes
228 * @ret: 0 on success, -errno on failure
229 *
230 * The string is NUL-terminated.
231 */
232 static int qed_read_string(BlockDriverState *file, uint64_t offset, size_t n,
233 char *buf, size_t buflen)
234 {
235 int ret;
236 if (n >= buflen) {
237 return -EINVAL;
238 }
239 ret = bdrv_pread(file, offset, buf, n);
240 if (ret < 0) {
241 return ret;
242 }
243 buf[n] = '\0';
244 return 0;
245 }
246
247 /**
248 * Allocate new clusters
249 *
250 * @s: QED state
251 * @n: Number of contiguous clusters to allocate
252 * @ret: Offset of first allocated cluster
253 *
254 * This function only produces the offset where the new clusters should be
255 * written. It updates BDRVQEDState but does not make any changes to the image
256 * file.
257 */
258 static uint64_t qed_alloc_clusters(BDRVQEDState *s, unsigned int n)
259 {
260 uint64_t offset = s->file_size;
261 s->file_size += n * s->header.cluster_size;
262 return offset;
263 }
264
265 QEDTable *qed_alloc_table(BDRVQEDState *s)
266 {
267 /* Honor O_DIRECT memory alignment requirements */
268 return qemu_blockalign(s->bs,
269 s->header.cluster_size * s->header.table_size);
270 }
271
272 /**
273 * Allocate a new zeroed L2 table
274 */
275 static CachedL2Table *qed_new_l2_table(BDRVQEDState *s)
276 {
277 CachedL2Table *l2_table = qed_alloc_l2_cache_entry(&s->l2_cache);
278
279 l2_table->table = qed_alloc_table(s);
280 l2_table->offset = qed_alloc_clusters(s, s->header.table_size);
281
282 memset(l2_table->table->offsets, 0,
283 s->header.cluster_size * s->header.table_size);
284 return l2_table;
285 }
286
287 static void qed_aio_next_io(void *opaque, int ret);
288
289 static void qed_plug_allocating_write_reqs(BDRVQEDState *s)
290 {
291 assert(!s->allocating_write_reqs_plugged);
292
293 s->allocating_write_reqs_plugged = true;
294 }
295
296 static void qed_unplug_allocating_write_reqs(BDRVQEDState *s)
297 {
298 QEDAIOCB *acb;
299
300 assert(s->allocating_write_reqs_plugged);
301
302 s->allocating_write_reqs_plugged = false;
303
304 acb = QSIMPLEQ_FIRST(&s->allocating_write_reqs);
305 if (acb) {
306 qed_aio_next_io(acb, 0);
307 }
308 }
309
310 static void qed_finish_clear_need_check(void *opaque, int ret)
311 {
312 /* Do nothing */
313 }
314
315 static void qed_flush_after_clear_need_check(void *opaque, int ret)
316 {
317 BDRVQEDState *s = opaque;
318
319 bdrv_aio_flush(s->bs, qed_finish_clear_need_check, s);
320
321 /* No need to wait until flush completes */
322 qed_unplug_allocating_write_reqs(s);
323 }
324
325 static void qed_clear_need_check(void *opaque, int ret)
326 {
327 BDRVQEDState *s = opaque;
328
329 if (ret) {
330 qed_unplug_allocating_write_reqs(s);
331 return;
332 }
333
334 s->header.features &= ~QED_F_NEED_CHECK;
335 qed_write_header(s, qed_flush_after_clear_need_check, s);
336 }
337
338 static void qed_need_check_timer_cb(void *opaque)
339 {
340 BDRVQEDState *s = opaque;
341
342 /* The timer should only fire when allocating writes have drained */
343 assert(!QSIMPLEQ_FIRST(&s->allocating_write_reqs));
344
345 trace_qed_need_check_timer_cb(s);
346
347 qed_plug_allocating_write_reqs(s);
348
349 /* Ensure writes are on disk before clearing flag */
350 bdrv_aio_flush(s->bs, qed_clear_need_check, s);
351 }
352
353 static void qed_start_need_check_timer(BDRVQEDState *s)
354 {
355 trace_qed_start_need_check_timer(s);
356
357 /* Use QEMU_CLOCK_VIRTUAL so we don't alter the image file while suspended for
358 * migration.
359 */
360 timer_mod(s->need_check_timer, qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) +
361 get_ticks_per_sec() * QED_NEED_CHECK_TIMEOUT);
362 }
363
364 /* It's okay to call this multiple times or when no timer is started */
365 static void qed_cancel_need_check_timer(BDRVQEDState *s)
366 {
367 trace_qed_cancel_need_check_timer(s);
368 timer_del(s->need_check_timer);
369 }
370
371 static void bdrv_qed_rebind(BlockDriverState *bs)
372 {
373 BDRVQEDState *s = bs->opaque;
374 s->bs = bs;
375 }
376
377 static void bdrv_qed_detach_aio_context(BlockDriverState *bs)
378 {
379 BDRVQEDState *s = bs->opaque;
380
381 qed_cancel_need_check_timer(s);
382 timer_free(s->need_check_timer);
383 }
384
385 static void bdrv_qed_attach_aio_context(BlockDriverState *bs,
386 AioContext *new_context)
387 {
388 BDRVQEDState *s = bs->opaque;
389
390 s->need_check_timer = aio_timer_new(new_context,
391 QEMU_CLOCK_VIRTUAL, SCALE_NS,
392 qed_need_check_timer_cb, s);
393 if (s->header.features & QED_F_NEED_CHECK) {
394 qed_start_need_check_timer(s);
395 }
396 }
397
398 static int bdrv_qed_open(BlockDriverState *bs, QDict *options, int flags,
399 Error **errp)
400 {
401 BDRVQEDState *s = bs->opaque;
402 QEDHeader le_header;
403 int64_t file_size;
404 int ret;
405
406 s->bs = bs;
407 QSIMPLEQ_INIT(&s->allocating_write_reqs);
408
409 ret = bdrv_pread(bs->file, 0, &le_header, sizeof(le_header));
410 if (ret < 0) {
411 return ret;
412 }
413 qed_header_le_to_cpu(&le_header, &s->header);
414
415 if (s->header.magic != QED_MAGIC) {
416 error_setg(errp, "Image not in QED format");
417 return -EINVAL;
418 }
419 if (s->header.features & ~QED_FEATURE_MASK) {
420 /* image uses unsupported feature bits */
421 char buf[64];
422 snprintf(buf, sizeof(buf), "%" PRIx64,
423 s->header.features & ~QED_FEATURE_MASK);
424 error_set(errp, QERR_UNKNOWN_BLOCK_FORMAT_FEATURE,
425 bs->device_name, "QED", buf);
426 return -ENOTSUP;
427 }
428 if (!qed_is_cluster_size_valid(s->header.cluster_size)) {
429 return -EINVAL;
430 }
431
432 /* Round down file size to the last cluster */
433 file_size = bdrv_getlength(bs->file);
434 if (file_size < 0) {
435 return file_size;
436 }
437 s->file_size = qed_start_of_cluster(s, file_size);
438
439 if (!qed_is_table_size_valid(s->header.table_size)) {
440 return -EINVAL;
441 }
442 if (!qed_is_image_size_valid(s->header.image_size,
443 s->header.cluster_size,
444 s->header.table_size)) {
445 return -EINVAL;
446 }
447 if (!qed_check_table_offset(s, s->header.l1_table_offset)) {
448 return -EINVAL;
449 }
450
451 s->table_nelems = (s->header.cluster_size * s->header.table_size) /
452 sizeof(uint64_t);
453 s->l2_shift = ffs(s->header.cluster_size) - 1;
454 s->l2_mask = s->table_nelems - 1;
455 s->l1_shift = s->l2_shift + ffs(s->table_nelems) - 1;
456
457 if ((s->header.features & QED_F_BACKING_FILE)) {
458 if ((uint64_t)s->header.backing_filename_offset +
459 s->header.backing_filename_size >
460 s->header.cluster_size * s->header.header_size) {
461 return -EINVAL;
462 }
463
464 ret = qed_read_string(bs->file, s->header.backing_filename_offset,
465 s->header.backing_filename_size, bs->backing_file,
466 sizeof(bs->backing_file));
467 if (ret < 0) {
468 return ret;
469 }
470
471 if (s->header.features & QED_F_BACKING_FORMAT_NO_PROBE) {
472 pstrcpy(bs->backing_format, sizeof(bs->backing_format), "raw");
473 }
474 }
475
476 /* Reset unknown autoclear feature bits. This is a backwards
477 * compatibility mechanism that allows images to be opened by older
478 * programs, which "knock out" unknown feature bits. When an image is
479 * opened by a newer program again it can detect that the autoclear
480 * feature is no longer valid.
481 */
482 if ((s->header.autoclear_features & ~QED_AUTOCLEAR_FEATURE_MASK) != 0 &&
483 !bdrv_is_read_only(bs->file) && !(flags & BDRV_O_INCOMING)) {
484 s->header.autoclear_features &= QED_AUTOCLEAR_FEATURE_MASK;
485
486 ret = qed_write_header_sync(s);
487 if (ret) {
488 return ret;
489 }
490
491 /* From here on only known autoclear feature bits are valid */
492 bdrv_flush(bs->file);
493 }
494
495 s->l1_table = qed_alloc_table(s);
496 qed_init_l2_cache(&s->l2_cache);
497
498 ret = qed_read_l1_table_sync(s);
499 if (ret) {
500 goto out;
501 }
502
503 /* If image was not closed cleanly, check consistency */
504 if (!(flags & BDRV_O_CHECK) && (s->header.features & QED_F_NEED_CHECK)) {
505 /* Read-only images cannot be fixed. There is no risk of corruption
506 * since write operations are not possible. Therefore, allow
507 * potentially inconsistent images to be opened read-only. This can
508 * aid data recovery from an otherwise inconsistent image.
509 */
510 if (!bdrv_is_read_only(bs->file) &&
511 !(flags & BDRV_O_INCOMING)) {
512 BdrvCheckResult result = {0};
513
514 ret = qed_check(s, &result, true);
515 if (ret) {
516 goto out;
517 }
518 }
519 }
520
521 bdrv_qed_attach_aio_context(bs, bdrv_get_aio_context(bs));
522
523 out:
524 if (ret) {
525 qed_free_l2_cache(&s->l2_cache);
526 qemu_vfree(s->l1_table);
527 }
528 return ret;
529 }
530
531 static void bdrv_qed_refresh_limits(BlockDriverState *bs, Error **errp)
532 {
533 BDRVQEDState *s = bs->opaque;
534
535 bs->bl.write_zeroes_alignment = s->header.cluster_size >> BDRV_SECTOR_BITS;
536 }
537
538 /* We have nothing to do for QED reopen, stubs just return
539 * success */
540 static int bdrv_qed_reopen_prepare(BDRVReopenState *state,
541 BlockReopenQueue *queue, Error **errp)
542 {
543 return 0;
544 }
545
546 static void bdrv_qed_close(BlockDriverState *bs)
547 {
548 BDRVQEDState *s = bs->opaque;
549
550 bdrv_qed_detach_aio_context(bs);
551
552 /* Ensure writes reach stable storage */
553 bdrv_flush(bs->file);
554
555 /* Clean shutdown, no check required on next open */
556 if (s->header.features & QED_F_NEED_CHECK) {
557 s->header.features &= ~QED_F_NEED_CHECK;
558 qed_write_header_sync(s);
559 }
560
561 qed_free_l2_cache(&s->l2_cache);
562 qemu_vfree(s->l1_table);
563 }
564
565 static int qed_create(const char *filename, uint32_t cluster_size,
566 uint64_t image_size, uint32_t table_size,
567 const char *backing_file, const char *backing_fmt,
568 QemuOpts *opts, Error **errp)
569 {
570 QEDHeader header = {
571 .magic = QED_MAGIC,
572 .cluster_size = cluster_size,
573 .table_size = table_size,
574 .header_size = 1,
575 .features = 0,
576 .compat_features = 0,
577 .l1_table_offset = cluster_size,
578 .image_size = image_size,
579 };
580 QEDHeader le_header;
581 uint8_t *l1_table = NULL;
582 size_t l1_size = header.cluster_size * header.table_size;
583 Error *local_err = NULL;
584 int ret = 0;
585 BlockDriverState *bs;
586
587 ret = bdrv_create_file(filename, opts, &local_err);
588 if (ret < 0) {
589 error_propagate(errp, local_err);
590 return ret;
591 }
592
593 bs = NULL;
594 ret = bdrv_open(&bs, filename, NULL, NULL,
595 BDRV_O_RDWR | BDRV_O_CACHE_WB | BDRV_O_PROTOCOL, NULL,
596 &local_err);
597 if (ret < 0) {
598 error_propagate(errp, local_err);
599 return ret;
600 }
601
602 /* File must start empty and grow, check truncate is supported */
603 ret = bdrv_truncate(bs, 0);
604 if (ret < 0) {
605 goto out;
606 }
607
608 if (backing_file) {
609 header.features |= QED_F_BACKING_FILE;
610 header.backing_filename_offset = sizeof(le_header);
611 header.backing_filename_size = strlen(backing_file);
612
613 if (qed_fmt_is_raw(backing_fmt)) {
614 header.features |= QED_F_BACKING_FORMAT_NO_PROBE;
615 }
616 }
617
618 qed_header_cpu_to_le(&header, &le_header);
619 ret = bdrv_pwrite(bs, 0, &le_header, sizeof(le_header));
620 if (ret < 0) {
621 goto out;
622 }
623 ret = bdrv_pwrite(bs, sizeof(le_header), backing_file,
624 header.backing_filename_size);
625 if (ret < 0) {
626 goto out;
627 }
628
629 l1_table = g_malloc0(l1_size);
630 ret = bdrv_pwrite(bs, header.l1_table_offset, l1_table, l1_size);
631 if (ret < 0) {
632 goto out;
633 }
634
635 ret = 0; /* success */
636 out:
637 g_free(l1_table);
638 bdrv_unref(bs);
639 return ret;
640 }
641
642 static int bdrv_qed_create(const char *filename, QemuOpts *opts, Error **errp)
643 {
644 uint64_t image_size = 0;
645 uint32_t cluster_size = QED_DEFAULT_CLUSTER_SIZE;
646 uint32_t table_size = QED_DEFAULT_TABLE_SIZE;
647 char *backing_file = NULL;
648 char *backing_fmt = NULL;
649 int ret;
650
651 image_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
652 BDRV_SECTOR_SIZE);
653 backing_file = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE);
654 backing_fmt = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FMT);
655 cluster_size = qemu_opt_get_size_del(opts,
656 BLOCK_OPT_CLUSTER_SIZE,
657 QED_DEFAULT_CLUSTER_SIZE);
658 table_size = qemu_opt_get_size_del(opts, BLOCK_OPT_TABLE_SIZE,
659 QED_DEFAULT_TABLE_SIZE);
660
661 if (!qed_is_cluster_size_valid(cluster_size)) {
662 error_setg(errp, "QED cluster size must be within range [%u, %u] "
663 "and power of 2",
664 QED_MIN_CLUSTER_SIZE, QED_MAX_CLUSTER_SIZE);
665 ret = -EINVAL;
666 goto finish;
667 }
668 if (!qed_is_table_size_valid(table_size)) {
669 error_setg(errp, "QED table size must be within range [%u, %u] "
670 "and power of 2",
671 QED_MIN_TABLE_SIZE, QED_MAX_TABLE_SIZE);
672 ret = -EINVAL;
673 goto finish;
674 }
675 if (!qed_is_image_size_valid(image_size, cluster_size, table_size)) {
676 error_setg(errp, "QED image size must be a non-zero multiple of "
677 "cluster size and less than %" PRIu64 " bytes",
678 qed_max_image_size(cluster_size, table_size));
679 ret = -EINVAL;
680 goto finish;
681 }
682
683 ret = qed_create(filename, cluster_size, image_size, table_size,
684 backing_file, backing_fmt, opts, errp);
685
686 finish:
687 g_free(backing_file);
688 g_free(backing_fmt);
689 return ret;
690 }
691
692 typedef struct {
693 BlockDriverState *bs;
694 Coroutine *co;
695 uint64_t pos;
696 int64_t status;
697 int *pnum;
698 } QEDIsAllocatedCB;
699
700 static void qed_is_allocated_cb(void *opaque, int ret, uint64_t offset, size_t len)
701 {
702 QEDIsAllocatedCB *cb = opaque;
703 BDRVQEDState *s = cb->bs->opaque;
704 *cb->pnum = len / BDRV_SECTOR_SIZE;
705 switch (ret) {
706 case QED_CLUSTER_FOUND:
707 offset |= qed_offset_into_cluster(s, cb->pos);
708 cb->status = BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID | offset;
709 break;
710 case QED_CLUSTER_ZERO:
711 cb->status = BDRV_BLOCK_ZERO;
712 break;
713 case QED_CLUSTER_L2:
714 case QED_CLUSTER_L1:
715 cb->status = 0;
716 break;
717 default:
718 assert(ret < 0);
719 cb->status = ret;
720 break;
721 }
722
723 if (cb->co) {
724 qemu_coroutine_enter(cb->co, NULL);
725 }
726 }
727
728 static int64_t coroutine_fn bdrv_qed_co_get_block_status(BlockDriverState *bs,
729 int64_t sector_num,
730 int nb_sectors, int *pnum)
731 {
732 BDRVQEDState *s = bs->opaque;
733 size_t len = (size_t)nb_sectors * BDRV_SECTOR_SIZE;
734 QEDIsAllocatedCB cb = {
735 .bs = bs,
736 .pos = (uint64_t)sector_num * BDRV_SECTOR_SIZE,
737 .status = BDRV_BLOCK_OFFSET_MASK,
738 .pnum = pnum,
739 };
740 QEDRequest request = { .l2_table = NULL };
741
742 qed_find_cluster(s, &request, cb.pos, len, qed_is_allocated_cb, &cb);
743
744 /* Now sleep if the callback wasn't invoked immediately */
745 while (cb.status == BDRV_BLOCK_OFFSET_MASK) {
746 cb.co = qemu_coroutine_self();
747 qemu_coroutine_yield();
748 }
749
750 qed_unref_l2_cache_entry(request.l2_table);
751
752 return cb.status;
753 }
754
755 static BDRVQEDState *acb_to_s(QEDAIOCB *acb)
756 {
757 return acb->common.bs->opaque;
758 }
759
760 /**
761 * Read from the backing file or zero-fill if no backing file
762 *
763 * @s: QED state
764 * @pos: Byte position in device
765 * @qiov: Destination I/O vector
766 * @backing_qiov: Possibly shortened copy of qiov, to be allocated here
767 * @cb: Completion function
768 * @opaque: User data for completion function
769 *
770 * This function reads qiov->size bytes starting at pos from the backing file.
771 * If there is no backing file then zeroes are read.
772 */
773 static void qed_read_backing_file(BDRVQEDState *s, uint64_t pos,
774 QEMUIOVector *qiov,
775 QEMUIOVector **backing_qiov,
776 BlockDriverCompletionFunc *cb, void *opaque)
777 {
778 uint64_t backing_length = 0;
779 size_t size;
780
781 /* If there is a backing file, get its length. Treat the absence of a
782 * backing file like a zero length backing file.
783 */
784 if (s->bs->backing_hd) {
785 int64_t l = bdrv_getlength(s->bs->backing_hd);
786 if (l < 0) {
787 cb(opaque, l);
788 return;
789 }
790 backing_length = l;
791 }
792
793 /* Zero all sectors if reading beyond the end of the backing file */
794 if (pos >= backing_length ||
795 pos + qiov->size > backing_length) {
796 qemu_iovec_memset(qiov, 0, 0, qiov->size);
797 }
798
799 /* Complete now if there are no backing file sectors to read */
800 if (pos >= backing_length) {
801 cb(opaque, 0);
802 return;
803 }
804
805 /* If the read straddles the end of the backing file, shorten it */
806 size = MIN((uint64_t)backing_length - pos, qiov->size);
807
808 assert(*backing_qiov == NULL);
809 *backing_qiov = g_new(QEMUIOVector, 1);
810 qemu_iovec_init(*backing_qiov, qiov->niov);
811 qemu_iovec_concat(*backing_qiov, qiov, 0, size);
812
813 BLKDBG_EVENT(s->bs->file, BLKDBG_READ_BACKING_AIO);
814 bdrv_aio_readv(s->bs->backing_hd, pos / BDRV_SECTOR_SIZE,
815 *backing_qiov, size / BDRV_SECTOR_SIZE, cb, opaque);
816 }
817
818 typedef struct {
819 GenericCB gencb;
820 BDRVQEDState *s;
821 QEMUIOVector qiov;
822 QEMUIOVector *backing_qiov;
823 struct iovec iov;
824 uint64_t offset;
825 } CopyFromBackingFileCB;
826
827 static void qed_copy_from_backing_file_cb(void *opaque, int ret)
828 {
829 CopyFromBackingFileCB *copy_cb = opaque;
830 qemu_vfree(copy_cb->iov.iov_base);
831 gencb_complete(&copy_cb->gencb, ret);
832 }
833
834 static void qed_copy_from_backing_file_write(void *opaque, int ret)
835 {
836 CopyFromBackingFileCB *copy_cb = opaque;
837 BDRVQEDState *s = copy_cb->s;
838
839 if (copy_cb->backing_qiov) {
840 qemu_iovec_destroy(copy_cb->backing_qiov);
841 g_free(copy_cb->backing_qiov);
842 copy_cb->backing_qiov = NULL;
843 }
844
845 if (ret) {
846 qed_copy_from_backing_file_cb(copy_cb, ret);
847 return;
848 }
849
850 BLKDBG_EVENT(s->bs->file, BLKDBG_COW_WRITE);
851 bdrv_aio_writev(s->bs->file, copy_cb->offset / BDRV_SECTOR_SIZE,
852 &copy_cb->qiov, copy_cb->qiov.size / BDRV_SECTOR_SIZE,
853 qed_copy_from_backing_file_cb, copy_cb);
854 }
855
856 /**
857 * Copy data from backing file into the image
858 *
859 * @s: QED state
860 * @pos: Byte position in device
861 * @len: Number of bytes
862 * @offset: Byte offset in image file
863 * @cb: Completion function
864 * @opaque: User data for completion function
865 */
866 static void qed_copy_from_backing_file(BDRVQEDState *s, uint64_t pos,
867 uint64_t len, uint64_t offset,
868 BlockDriverCompletionFunc *cb,
869 void *opaque)
870 {
871 CopyFromBackingFileCB *copy_cb;
872
873 /* Skip copy entirely if there is no work to do */
874 if (len == 0) {
875 cb(opaque, 0);
876 return;
877 }
878
879 copy_cb = gencb_alloc(sizeof(*copy_cb), cb, opaque);
880 copy_cb->s = s;
881 copy_cb->offset = offset;
882 copy_cb->backing_qiov = NULL;
883 copy_cb->iov.iov_base = qemu_blockalign(s->bs, len);
884 copy_cb->iov.iov_len = len;
885 qemu_iovec_init_external(&copy_cb->qiov, &copy_cb->iov, 1);
886
887 qed_read_backing_file(s, pos, &copy_cb->qiov, &copy_cb->backing_qiov,
888 qed_copy_from_backing_file_write, copy_cb);
889 }
890
891 /**
892 * Link one or more contiguous clusters into a table
893 *
894 * @s: QED state
895 * @table: L2 table
896 * @index: First cluster index
897 * @n: Number of contiguous clusters
898 * @cluster: First cluster offset
899 *
900 * The cluster offset may be an allocated byte offset in the image file, the
901 * zero cluster marker, or the unallocated cluster marker.
902 */
903 static void qed_update_l2_table(BDRVQEDState *s, QEDTable *table, int index,
904 unsigned int n, uint64_t cluster)
905 {
906 int i;
907 for (i = index; i < index + n; i++) {
908 table->offsets[i] = cluster;
909 if (!qed_offset_is_unalloc_cluster(cluster) &&
910 !qed_offset_is_zero_cluster(cluster)) {
911 cluster += s->header.cluster_size;
912 }
913 }
914 }
915
916 static void qed_aio_complete_bh(void *opaque)
917 {
918 QEDAIOCB *acb = opaque;
919 BlockDriverCompletionFunc *cb = acb->common.cb;
920 void *user_opaque = acb->common.opaque;
921 int ret = acb->bh_ret;
922 bool *finished = acb->finished;
923
924 qemu_bh_delete(acb->bh);
925 qemu_aio_release(acb);
926
927 /* Invoke callback */
928 cb(user_opaque, ret);
929
930 /* Signal cancel completion */
931 if (finished) {
932 *finished = true;
933 }
934 }
935
936 static void qed_aio_complete(QEDAIOCB *acb, int ret)
937 {
938 BDRVQEDState *s = acb_to_s(acb);
939
940 trace_qed_aio_complete(s, acb, ret);
941
942 /* Free resources */
943 qemu_iovec_destroy(&acb->cur_qiov);
944 qed_unref_l2_cache_entry(acb->request.l2_table);
945
946 /* Free the buffer we may have allocated for zero writes */
947 if (acb->flags & QED_AIOCB_ZERO) {
948 qemu_vfree(acb->qiov->iov[0].iov_base);
949 acb->qiov->iov[0].iov_base = NULL;
950 }
951
952 /* Arrange for a bh to invoke the completion function */
953 acb->bh_ret = ret;
954 acb->bh = aio_bh_new(bdrv_get_aio_context(acb->common.bs),
955 qed_aio_complete_bh, acb);
956 qemu_bh_schedule(acb->bh);
957
958 /* Start next allocating write request waiting behind this one. Note that
959 * requests enqueue themselves when they first hit an unallocated cluster
960 * but they wait until the entire request is finished before waking up the
961 * next request in the queue. This ensures that we don't cycle through
962 * requests multiple times but rather finish one at a time completely.
963 */
964 if (acb == QSIMPLEQ_FIRST(&s->allocating_write_reqs)) {
965 QSIMPLEQ_REMOVE_HEAD(&s->allocating_write_reqs, next);
966 acb = QSIMPLEQ_FIRST(&s->allocating_write_reqs);
967 if (acb) {
968 qed_aio_next_io(acb, 0);
969 } else if (s->header.features & QED_F_NEED_CHECK) {
970 qed_start_need_check_timer(s);
971 }
972 }
973 }
974
975 /**
976 * Commit the current L2 table to the cache
977 */
978 static void qed_commit_l2_update(void *opaque, int ret)
979 {
980 QEDAIOCB *acb = opaque;
981 BDRVQEDState *s = acb_to_s(acb);
982 CachedL2Table *l2_table = acb->request.l2_table;
983 uint64_t l2_offset = l2_table->offset;
984
985 qed_commit_l2_cache_entry(&s->l2_cache, l2_table);
986
987 /* This is guaranteed to succeed because we just committed the entry to the
988 * cache.
989 */
990 acb->request.l2_table = qed_find_l2_cache_entry(&s->l2_cache, l2_offset);
991 assert(acb->request.l2_table != NULL);
992
993 qed_aio_next_io(opaque, ret);
994 }
995
996 /**
997 * Update L1 table with new L2 table offset and write it out
998 */
999 static void qed_aio_write_l1_update(void *opaque, int ret)
1000 {
1001 QEDAIOCB *acb = opaque;
1002 BDRVQEDState *s = acb_to_s(acb);
1003 int index;
1004
1005 if (ret) {
1006 qed_aio_complete(acb, ret);
1007 return;
1008 }
1009
1010 index = qed_l1_index(s, acb->cur_pos);
1011 s->l1_table->offsets[index] = acb->request.l2_table->offset;
1012
1013 qed_write_l1_table(s, index, 1, qed_commit_l2_update, acb);
1014 }
1015
1016 /**
1017 * Update L2 table with new cluster offsets and write them out
1018 */
1019 static void qed_aio_write_l2_update(QEDAIOCB *acb, int ret, uint64_t offset)
1020 {
1021 BDRVQEDState *s = acb_to_s(acb);
1022 bool need_alloc = acb->find_cluster_ret == QED_CLUSTER_L1;
1023 int index;
1024
1025 if (ret) {
1026 goto err;
1027 }
1028
1029 if (need_alloc) {
1030 qed_unref_l2_cache_entry(acb->request.l2_table);
1031 acb->request.l2_table = qed_new_l2_table(s);
1032 }
1033
1034 index = qed_l2_index(s, acb->cur_pos);
1035 qed_update_l2_table(s, acb->request.l2_table->table, index, acb->cur_nclusters,
1036 offset);
1037
1038 if (need_alloc) {
1039 /* Write out the whole new L2 table */
1040 qed_write_l2_table(s, &acb->request, 0, s->table_nelems, true,
1041 qed_aio_write_l1_update, acb);
1042 } else {
1043 /* Write out only the updated part of the L2 table */
1044 qed_write_l2_table(s, &acb->request, index, acb->cur_nclusters, false,
1045 qed_aio_next_io, acb);
1046 }
1047 return;
1048
1049 err:
1050 qed_aio_complete(acb, ret);
1051 }
1052
1053 static void qed_aio_write_l2_update_cb(void *opaque, int ret)
1054 {
1055 QEDAIOCB *acb = opaque;
1056 qed_aio_write_l2_update(acb, ret, acb->cur_cluster);
1057 }
1058
1059 /**
1060 * Flush new data clusters before updating the L2 table
1061 *
1062 * This flush is necessary when a backing file is in use. A crash during an
1063 * allocating write could result in empty clusters in the image. If the write
1064 * only touched a subregion of the cluster, then backing image sectors have
1065 * been lost in the untouched region. The solution is to flush after writing a
1066 * new data cluster and before updating the L2 table.
1067 */
1068 static void qed_aio_write_flush_before_l2_update(void *opaque, int ret)
1069 {
1070 QEDAIOCB *acb = opaque;
1071 BDRVQEDState *s = acb_to_s(acb);
1072
1073 if (!bdrv_aio_flush(s->bs->file, qed_aio_write_l2_update_cb, opaque)) {
1074 qed_aio_complete(acb, -EIO);
1075 }
1076 }
1077
1078 /**
1079 * Write data to the image file
1080 */
1081 static void qed_aio_write_main(void *opaque, int ret)
1082 {
1083 QEDAIOCB *acb = opaque;
1084 BDRVQEDState *s = acb_to_s(acb);
1085 uint64_t offset = acb->cur_cluster +
1086 qed_offset_into_cluster(s, acb->cur_pos);
1087 BlockDriverCompletionFunc *next_fn;
1088
1089 trace_qed_aio_write_main(s, acb, ret, offset, acb->cur_qiov.size);
1090
1091 if (ret) {
1092 qed_aio_complete(acb, ret);
1093 return;
1094 }
1095
1096 if (acb->find_cluster_ret == QED_CLUSTER_FOUND) {
1097 next_fn = qed_aio_next_io;
1098 } else {
1099 if (s->bs->backing_hd) {
1100 next_fn = qed_aio_write_flush_before_l2_update;
1101 } else {
1102 next_fn = qed_aio_write_l2_update_cb;
1103 }
1104 }
1105
1106 BLKDBG_EVENT(s->bs->file, BLKDBG_WRITE_AIO);
1107 bdrv_aio_writev(s->bs->file, offset / BDRV_SECTOR_SIZE,
1108 &acb->cur_qiov, acb->cur_qiov.size / BDRV_SECTOR_SIZE,
1109 next_fn, acb);
1110 }
1111
1112 /**
1113 * Populate back untouched region of new data cluster
1114 */
1115 static void qed_aio_write_postfill(void *opaque, int ret)
1116 {
1117 QEDAIOCB *acb = opaque;
1118 BDRVQEDState *s = acb_to_s(acb);
1119 uint64_t start = acb->cur_pos + acb->cur_qiov.size;
1120 uint64_t len =
1121 qed_start_of_cluster(s, start + s->header.cluster_size - 1) - start;
1122 uint64_t offset = acb->cur_cluster +
1123 qed_offset_into_cluster(s, acb->cur_pos) +
1124 acb->cur_qiov.size;
1125
1126 if (ret) {
1127 qed_aio_complete(acb, ret);
1128 return;
1129 }
1130
1131 trace_qed_aio_write_postfill(s, acb, start, len, offset);
1132 qed_copy_from_backing_file(s, start, len, offset,
1133 qed_aio_write_main, acb);
1134 }
1135
1136 /**
1137 * Populate front untouched region of new data cluster
1138 */
1139 static void qed_aio_write_prefill(void *opaque, int ret)
1140 {
1141 QEDAIOCB *acb = opaque;
1142 BDRVQEDState *s = acb_to_s(acb);
1143 uint64_t start = qed_start_of_cluster(s, acb->cur_pos);
1144 uint64_t len = qed_offset_into_cluster(s, acb->cur_pos);
1145
1146 trace_qed_aio_write_prefill(s, acb, start, len, acb->cur_cluster);
1147 qed_copy_from_backing_file(s, start, len, acb->cur_cluster,
1148 qed_aio_write_postfill, acb);
1149 }
1150
1151 /**
1152 * Check if the QED_F_NEED_CHECK bit should be set during allocating write
1153 */
1154 static bool qed_should_set_need_check(BDRVQEDState *s)
1155 {
1156 /* The flush before L2 update path ensures consistency */
1157 if (s->bs->backing_hd) {
1158 return false;
1159 }
1160
1161 return !(s->header.features & QED_F_NEED_CHECK);
1162 }
1163
1164 static void qed_aio_write_zero_cluster(void *opaque, int ret)
1165 {
1166 QEDAIOCB *acb = opaque;
1167
1168 if (ret) {
1169 qed_aio_complete(acb, ret);
1170 return;
1171 }
1172
1173 qed_aio_write_l2_update(acb, 0, 1);
1174 }
1175
1176 /**
1177 * Write new data cluster
1178 *
1179 * @acb: Write request
1180 * @len: Length in bytes
1181 *
1182 * This path is taken when writing to previously unallocated clusters.
1183 */
1184 static void qed_aio_write_alloc(QEDAIOCB *acb, size_t len)
1185 {
1186 BDRVQEDState *s = acb_to_s(acb);
1187 BlockDriverCompletionFunc *cb;
1188
1189 /* Cancel timer when the first allocating request comes in */
1190 if (QSIMPLEQ_EMPTY(&s->allocating_write_reqs)) {
1191 qed_cancel_need_check_timer(s);
1192 }
1193
1194 /* Freeze this request if another allocating write is in progress */
1195 if (acb != QSIMPLEQ_FIRST(&s->allocating_write_reqs)) {
1196 QSIMPLEQ_INSERT_TAIL(&s->allocating_write_reqs, acb, next);
1197 }
1198 if (acb != QSIMPLEQ_FIRST(&s->allocating_write_reqs) ||
1199 s->allocating_write_reqs_plugged) {
1200 return; /* wait for existing request to finish */
1201 }
1202
1203 acb->cur_nclusters = qed_bytes_to_clusters(s,
1204 qed_offset_into_cluster(s, acb->cur_pos) + len);
1205 qemu_iovec_concat(&acb->cur_qiov, acb->qiov, acb->qiov_offset, len);
1206
1207 if (acb->flags & QED_AIOCB_ZERO) {
1208 /* Skip ahead if the clusters are already zero */
1209 if (acb->find_cluster_ret == QED_CLUSTER_ZERO) {
1210 qed_aio_next_io(acb, 0);
1211 return;
1212 }
1213
1214 cb = qed_aio_write_zero_cluster;
1215 } else {
1216 cb = qed_aio_write_prefill;
1217 acb->cur_cluster = qed_alloc_clusters(s, acb->cur_nclusters);
1218 }
1219
1220 if (qed_should_set_need_check(s)) {
1221 s->header.features |= QED_F_NEED_CHECK;
1222 qed_write_header(s, cb, acb);
1223 } else {
1224 cb(acb, 0);
1225 }
1226 }
1227
1228 /**
1229 * Write data cluster in place
1230 *
1231 * @acb: Write request
1232 * @offset: Cluster offset in bytes
1233 * @len: Length in bytes
1234 *
1235 * This path is taken when writing to already allocated clusters.
1236 */
1237 static void qed_aio_write_inplace(QEDAIOCB *acb, uint64_t offset, size_t len)
1238 {
1239 /* Allocate buffer for zero writes */
1240 if (acb->flags & QED_AIOCB_ZERO) {
1241 struct iovec *iov = acb->qiov->iov;
1242
1243 if (!iov->iov_base) {
1244 iov->iov_base = qemu_try_blockalign(acb->common.bs, iov->iov_len);
1245 if (iov->iov_base == NULL) {
1246 qed_aio_complete(acb, -ENOMEM);
1247 return;
1248 }
1249 memset(iov->iov_base, 0, iov->iov_len);
1250 }
1251 }
1252
1253 /* Calculate the I/O vector */
1254 acb->cur_cluster = offset;
1255 qemu_iovec_concat(&acb->cur_qiov, acb->qiov, acb->qiov_offset, len);
1256
1257 /* Do the actual write */
1258 qed_aio_write_main(acb, 0);
1259 }
1260
1261 /**
1262 * Write data cluster
1263 *
1264 * @opaque: Write request
1265 * @ret: QED_CLUSTER_FOUND, QED_CLUSTER_L2, QED_CLUSTER_L1,
1266 * or -errno
1267 * @offset: Cluster offset in bytes
1268 * @len: Length in bytes
1269 *
1270 * Callback from qed_find_cluster().
1271 */
1272 static void qed_aio_write_data(void *opaque, int ret,
1273 uint64_t offset, size_t len)
1274 {
1275 QEDAIOCB *acb = opaque;
1276
1277 trace_qed_aio_write_data(acb_to_s(acb), acb, ret, offset, len);
1278
1279 acb->find_cluster_ret = ret;
1280
1281 switch (ret) {
1282 case QED_CLUSTER_FOUND:
1283 qed_aio_write_inplace(acb, offset, len);
1284 break;
1285
1286 case QED_CLUSTER_L2:
1287 case QED_CLUSTER_L1:
1288 case QED_CLUSTER_ZERO:
1289 qed_aio_write_alloc(acb, len);
1290 break;
1291
1292 default:
1293 qed_aio_complete(acb, ret);
1294 break;
1295 }
1296 }
1297
1298 /**
1299 * Read data cluster
1300 *
1301 * @opaque: Read request
1302 * @ret: QED_CLUSTER_FOUND, QED_CLUSTER_L2, QED_CLUSTER_L1,
1303 * or -errno
1304 * @offset: Cluster offset in bytes
1305 * @len: Length in bytes
1306 *
1307 * Callback from qed_find_cluster().
1308 */
1309 static void qed_aio_read_data(void *opaque, int ret,
1310 uint64_t offset, size_t len)
1311 {
1312 QEDAIOCB *acb = opaque;
1313 BDRVQEDState *s = acb_to_s(acb);
1314 BlockDriverState *bs = acb->common.bs;
1315
1316 /* Adjust offset into cluster */
1317 offset += qed_offset_into_cluster(s, acb->cur_pos);
1318
1319 trace_qed_aio_read_data(s, acb, ret, offset, len);
1320
1321 if (ret < 0) {
1322 goto err;
1323 }
1324
1325 qemu_iovec_concat(&acb->cur_qiov, acb->qiov, acb->qiov_offset, len);
1326
1327 /* Handle zero cluster and backing file reads */
1328 if (ret == QED_CLUSTER_ZERO) {
1329 qemu_iovec_memset(&acb->cur_qiov, 0, 0, acb->cur_qiov.size);
1330 qed_aio_next_io(acb, 0);
1331 return;
1332 } else if (ret != QED_CLUSTER_FOUND) {
1333 qed_read_backing_file(s, acb->cur_pos, &acb->cur_qiov,
1334 &acb->backing_qiov, qed_aio_next_io, acb);
1335 return;
1336 }
1337
1338 BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO);
1339 bdrv_aio_readv(bs->file, offset / BDRV_SECTOR_SIZE,
1340 &acb->cur_qiov, acb->cur_qiov.size / BDRV_SECTOR_SIZE,
1341 qed_aio_next_io, acb);
1342 return;
1343
1344 err:
1345 qed_aio_complete(acb, ret);
1346 }
1347
1348 /**
1349 * Begin next I/O or complete the request
1350 */
1351 static void qed_aio_next_io(void *opaque, int ret)
1352 {
1353 QEDAIOCB *acb = opaque;
1354 BDRVQEDState *s = acb_to_s(acb);
1355 QEDFindClusterFunc *io_fn = (acb->flags & QED_AIOCB_WRITE) ?
1356 qed_aio_write_data : qed_aio_read_data;
1357
1358 trace_qed_aio_next_io(s, acb, ret, acb->cur_pos + acb->cur_qiov.size);
1359
1360 if (acb->backing_qiov) {
1361 qemu_iovec_destroy(acb->backing_qiov);
1362 g_free(acb->backing_qiov);
1363 acb->backing_qiov = NULL;
1364 }
1365
1366 /* Handle I/O error */
1367 if (ret) {
1368 qed_aio_complete(acb, ret);
1369 return;
1370 }
1371
1372 acb->qiov_offset += acb->cur_qiov.size;
1373 acb->cur_pos += acb->cur_qiov.size;
1374 qemu_iovec_reset(&acb->cur_qiov);
1375
1376 /* Complete request */
1377 if (acb->cur_pos >= acb->end_pos) {
1378 qed_aio_complete(acb, 0);
1379 return;
1380 }
1381
1382 /* Find next cluster and start I/O */
1383 qed_find_cluster(s, &acb->request,
1384 acb->cur_pos, acb->end_pos - acb->cur_pos,
1385 io_fn, acb);
1386 }
1387
1388 static BlockDriverAIOCB *qed_aio_setup(BlockDriverState *bs,
1389 int64_t sector_num,
1390 QEMUIOVector *qiov, int nb_sectors,
1391 BlockDriverCompletionFunc *cb,
1392 void *opaque, int flags)
1393 {
1394 QEDAIOCB *acb = qemu_aio_get(&qed_aiocb_info, bs, cb, opaque);
1395
1396 trace_qed_aio_setup(bs->opaque, acb, sector_num, nb_sectors,
1397 opaque, flags);
1398
1399 acb->flags = flags;
1400 acb->finished = NULL;
1401 acb->qiov = qiov;
1402 acb->qiov_offset = 0;
1403 acb->cur_pos = (uint64_t)sector_num * BDRV_SECTOR_SIZE;
1404 acb->end_pos = acb->cur_pos + nb_sectors * BDRV_SECTOR_SIZE;
1405 acb->backing_qiov = NULL;
1406 acb->request.l2_table = NULL;
1407 qemu_iovec_init(&acb->cur_qiov, qiov->niov);
1408
1409 /* Start request */
1410 qed_aio_next_io(acb, 0);
1411 return &acb->common;
1412 }
1413
1414 static BlockDriverAIOCB *bdrv_qed_aio_readv(BlockDriverState *bs,
1415 int64_t sector_num,
1416 QEMUIOVector *qiov, int nb_sectors,
1417 BlockDriverCompletionFunc *cb,
1418 void *opaque)
1419 {
1420 return qed_aio_setup(bs, sector_num, qiov, nb_sectors, cb, opaque, 0);
1421 }
1422
1423 static BlockDriverAIOCB *bdrv_qed_aio_writev(BlockDriverState *bs,
1424 int64_t sector_num,
1425 QEMUIOVector *qiov, int nb_sectors,
1426 BlockDriverCompletionFunc *cb,
1427 void *opaque)
1428 {
1429 return qed_aio_setup(bs, sector_num, qiov, nb_sectors, cb,
1430 opaque, QED_AIOCB_WRITE);
1431 }
1432
1433 typedef struct {
1434 Coroutine *co;
1435 int ret;
1436 bool done;
1437 } QEDWriteZeroesCB;
1438
1439 static void coroutine_fn qed_co_write_zeroes_cb(void *opaque, int ret)
1440 {
1441 QEDWriteZeroesCB *cb = opaque;
1442
1443 cb->done = true;
1444 cb->ret = ret;
1445 if (cb->co) {
1446 qemu_coroutine_enter(cb->co, NULL);
1447 }
1448 }
1449
1450 static int coroutine_fn bdrv_qed_co_write_zeroes(BlockDriverState *bs,
1451 int64_t sector_num,
1452 int nb_sectors,
1453 BdrvRequestFlags flags)
1454 {
1455 BlockDriverAIOCB *blockacb;
1456 BDRVQEDState *s = bs->opaque;
1457 QEDWriteZeroesCB cb = { .done = false };
1458 QEMUIOVector qiov;
1459 struct iovec iov;
1460
1461 /* Refuse if there are untouched backing file sectors */
1462 if (bs->backing_hd) {
1463 if (qed_offset_into_cluster(s, sector_num * BDRV_SECTOR_SIZE) != 0) {
1464 return -ENOTSUP;
1465 }
1466 if (qed_offset_into_cluster(s, nb_sectors * BDRV_SECTOR_SIZE) != 0) {
1467 return -ENOTSUP;
1468 }
1469 }
1470
1471 /* Zero writes start without an I/O buffer. If a buffer becomes necessary
1472 * then it will be allocated during request processing.
1473 */
1474 iov.iov_base = NULL,
1475 iov.iov_len = nb_sectors * BDRV_SECTOR_SIZE,
1476
1477 qemu_iovec_init_external(&qiov, &iov, 1);
1478 blockacb = qed_aio_setup(bs, sector_num, &qiov, nb_sectors,
1479 qed_co_write_zeroes_cb, &cb,
1480 QED_AIOCB_WRITE | QED_AIOCB_ZERO);
1481 if (!blockacb) {
1482 return -EIO;
1483 }
1484 if (!cb.done) {
1485 cb.co = qemu_coroutine_self();
1486 qemu_coroutine_yield();
1487 }
1488 assert(cb.done);
1489 return cb.ret;
1490 }
1491
1492 static int bdrv_qed_truncate(BlockDriverState *bs, int64_t offset)
1493 {
1494 BDRVQEDState *s = bs->opaque;
1495 uint64_t old_image_size;
1496 int ret;
1497
1498 if (!qed_is_image_size_valid(offset, s->header.cluster_size,
1499 s->header.table_size)) {
1500 return -EINVAL;
1501 }
1502
1503 /* Shrinking is currently not supported */
1504 if ((uint64_t)offset < s->header.image_size) {
1505 return -ENOTSUP;
1506 }
1507
1508 old_image_size = s->header.image_size;
1509 s->header.image_size = offset;
1510 ret = qed_write_header_sync(s);
1511 if (ret < 0) {
1512 s->header.image_size = old_image_size;
1513 }
1514 return ret;
1515 }
1516
1517 static int64_t bdrv_qed_getlength(BlockDriverState *bs)
1518 {
1519 BDRVQEDState *s = bs->opaque;
1520 return s->header.image_size;
1521 }
1522
1523 static int bdrv_qed_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
1524 {
1525 BDRVQEDState *s = bs->opaque;
1526
1527 memset(bdi, 0, sizeof(*bdi));
1528 bdi->cluster_size = s->header.cluster_size;
1529 bdi->is_dirty = s->header.features & QED_F_NEED_CHECK;
1530 bdi->unallocated_blocks_are_zero = true;
1531 bdi->can_write_zeroes_with_unmap = true;
1532 return 0;
1533 }
1534
1535 static int bdrv_qed_change_backing_file(BlockDriverState *bs,
1536 const char *backing_file,
1537 const char *backing_fmt)
1538 {
1539 BDRVQEDState *s = bs->opaque;
1540 QEDHeader new_header, le_header;
1541 void *buffer;
1542 size_t buffer_len, backing_file_len;
1543 int ret;
1544
1545 /* Refuse to set backing filename if unknown compat feature bits are
1546 * active. If the image uses an unknown compat feature then we may not
1547 * know the layout of data following the header structure and cannot safely
1548 * add a new string.
1549 */
1550 if (backing_file && (s->header.compat_features &
1551 ~QED_COMPAT_FEATURE_MASK)) {
1552 return -ENOTSUP;
1553 }
1554
1555 memcpy(&new_header, &s->header, sizeof(new_header));
1556
1557 new_header.features &= ~(QED_F_BACKING_FILE |
1558 QED_F_BACKING_FORMAT_NO_PROBE);
1559
1560 /* Adjust feature flags */
1561 if (backing_file) {
1562 new_header.features |= QED_F_BACKING_FILE;
1563
1564 if (qed_fmt_is_raw(backing_fmt)) {
1565 new_header.features |= QED_F_BACKING_FORMAT_NO_PROBE;
1566 }
1567 }
1568
1569 /* Calculate new header size */
1570 backing_file_len = 0;
1571
1572 if (backing_file) {
1573 backing_file_len = strlen(backing_file);
1574 }
1575
1576 buffer_len = sizeof(new_header);
1577 new_header.backing_filename_offset = buffer_len;
1578 new_header.backing_filename_size = backing_file_len;
1579 buffer_len += backing_file_len;
1580
1581 /* Make sure we can rewrite header without failing */
1582 if (buffer_len > new_header.header_size * new_header.cluster_size) {
1583 return -ENOSPC;
1584 }
1585
1586 /* Prepare new header */
1587 buffer = g_malloc(buffer_len);
1588
1589 qed_header_cpu_to_le(&new_header, &le_header);
1590 memcpy(buffer, &le_header, sizeof(le_header));
1591 buffer_len = sizeof(le_header);
1592
1593 if (backing_file) {
1594 memcpy(buffer + buffer_len, backing_file, backing_file_len);
1595 buffer_len += backing_file_len;
1596 }
1597
1598 /* Write new header */
1599 ret = bdrv_pwrite_sync(bs->file, 0, buffer, buffer_len);
1600 g_free(buffer);
1601 if (ret == 0) {
1602 memcpy(&s->header, &new_header, sizeof(new_header));
1603 }
1604 return ret;
1605 }
1606
1607 static void bdrv_qed_invalidate_cache(BlockDriverState *bs, Error **errp)
1608 {
1609 BDRVQEDState *s = bs->opaque;
1610 Error *local_err = NULL;
1611 int ret;
1612
1613 bdrv_qed_close(bs);
1614
1615 bdrv_invalidate_cache(bs->file, &local_err);
1616 if (local_err) {
1617 error_propagate(errp, local_err);
1618 return;
1619 }
1620
1621 memset(s, 0, sizeof(BDRVQEDState));
1622 ret = bdrv_qed_open(bs, NULL, bs->open_flags, &local_err);
1623 if (local_err) {
1624 error_setg(errp, "Could not reopen qed layer: %s",
1625 error_get_pretty(local_err));
1626 error_free(local_err);
1627 return;
1628 } else if (ret < 0) {
1629 error_setg_errno(errp, -ret, "Could not reopen qed layer");
1630 return;
1631 }
1632 }
1633
1634 static int bdrv_qed_check(BlockDriverState *bs, BdrvCheckResult *result,
1635 BdrvCheckMode fix)
1636 {
1637 BDRVQEDState *s = bs->opaque;
1638
1639 return qed_check(s, result, !!fix);
1640 }
1641
1642 static QemuOptsList qed_create_opts = {
1643 .name = "qed-create-opts",
1644 .head = QTAILQ_HEAD_INITIALIZER(qed_create_opts.head),
1645 .desc = {
1646 {
1647 .name = BLOCK_OPT_SIZE,
1648 .type = QEMU_OPT_SIZE,
1649 .help = "Virtual disk size"
1650 },
1651 {
1652 .name = BLOCK_OPT_BACKING_FILE,
1653 .type = QEMU_OPT_STRING,
1654 .help = "File name of a base image"
1655 },
1656 {
1657 .name = BLOCK_OPT_BACKING_FMT,
1658 .type = QEMU_OPT_STRING,
1659 .help = "Image format of the base image"
1660 },
1661 {
1662 .name = BLOCK_OPT_CLUSTER_SIZE,
1663 .type = QEMU_OPT_SIZE,
1664 .help = "Cluster size (in bytes)",
1665 .def_value_str = stringify(QED_DEFAULT_CLUSTER_SIZE)
1666 },
1667 {
1668 .name = BLOCK_OPT_TABLE_SIZE,
1669 .type = QEMU_OPT_SIZE,
1670 .help = "L1/L2 table size (in clusters)"
1671 },
1672 { /* end of list */ }
1673 }
1674 };
1675
1676 static BlockDriver bdrv_qed = {
1677 .format_name = "qed",
1678 .instance_size = sizeof(BDRVQEDState),
1679 .create_opts = &qed_create_opts,
1680 .supports_backing = true,
1681
1682 .bdrv_probe = bdrv_qed_probe,
1683 .bdrv_rebind = bdrv_qed_rebind,
1684 .bdrv_open = bdrv_qed_open,
1685 .bdrv_close = bdrv_qed_close,
1686 .bdrv_reopen_prepare = bdrv_qed_reopen_prepare,
1687 .bdrv_create = bdrv_qed_create,
1688 .bdrv_has_zero_init = bdrv_has_zero_init_1,
1689 .bdrv_co_get_block_status = bdrv_qed_co_get_block_status,
1690 .bdrv_aio_readv = bdrv_qed_aio_readv,
1691 .bdrv_aio_writev = bdrv_qed_aio_writev,
1692 .bdrv_co_write_zeroes = bdrv_qed_co_write_zeroes,
1693 .bdrv_truncate = bdrv_qed_truncate,
1694 .bdrv_getlength = bdrv_qed_getlength,
1695 .bdrv_get_info = bdrv_qed_get_info,
1696 .bdrv_refresh_limits = bdrv_qed_refresh_limits,
1697 .bdrv_change_backing_file = bdrv_qed_change_backing_file,
1698 .bdrv_invalidate_cache = bdrv_qed_invalidate_cache,
1699 .bdrv_check = bdrv_qed_check,
1700 .bdrv_detach_aio_context = bdrv_qed_detach_aio_context,
1701 .bdrv_attach_aio_context = bdrv_qed_attach_aio_context,
1702 };
1703
1704 static void bdrv_qed_init(void)
1705 {
1706 bdrv_register(&bdrv_qed);
1707 }
1708
1709 block_init(bdrv_qed_init);