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