1bfcc224eSAapo Vienamo /*
2bfcc224eSAapo Vienamo * Write logging blk driver based on blkverify and blkdebug.
3bfcc224eSAapo Vienamo *
4bfcc224eSAapo Vienamo * Copyright (c) 2017 Tuomas Tynkkynen <tuomas@tuxera.com>
5bfcc224eSAapo Vienamo * Copyright (c) 2018 Aapo Vienamo <aapo@tuxera.com>
6a26d018cSAri Sundholm * Copyright (c) 2018-2024 Ari Sundholm <ari@tuxera.com>
7bfcc224eSAapo Vienamo *
8bfcc224eSAapo Vienamo * This work is licensed under the terms of the GNU GPL, version 2 or later.
9bfcc224eSAapo Vienamo * See the COPYING file in the top-level directory.
10bfcc224eSAapo Vienamo */
11bfcc224eSAapo Vienamo
12bfcc224eSAapo Vienamo #include "qemu/osdep.h"
13bfcc224eSAapo Vienamo #include "qapi/error.h"
14bfcc224eSAapo Vienamo #include "qemu/sockets.h" /* for EINPROGRESS on Windows */
15e2c1c34fSMarkus Armbruster #include "block/block-io.h"
16bfcc224eSAapo Vienamo #include "block/block_int.h"
17bfcc224eSAapo Vienamo #include "qapi/qmp/qdict.h"
18bfcc224eSAapo Vienamo #include "qapi/qmp/qstring.h"
19bfcc224eSAapo Vienamo #include "qemu/cutils.h"
200b8fa32fSMarkus Armbruster #include "qemu/module.h"
21bfcc224eSAapo Vienamo #include "qemu/option.h"
22bfcc224eSAapo Vienamo
23bfcc224eSAapo Vienamo /* Disk format stuff - taken from Linux drivers/md/dm-log-writes.c */
24bfcc224eSAapo Vienamo
25bfcc224eSAapo Vienamo #define LOG_FLUSH_FLAG (1 << 0)
26bfcc224eSAapo Vienamo #define LOG_FUA_FLAG (1 << 1)
27bfcc224eSAapo Vienamo #define LOG_DISCARD_FLAG (1 << 2)
28bfcc224eSAapo Vienamo #define LOG_MARK_FLAG (1 << 3)
290878b3c1SAri Sundholm #define LOG_FLAG_MASK (LOG_FLUSH_FLAG \
300878b3c1SAri Sundholm | LOG_FUA_FLAG \
310878b3c1SAri Sundholm | LOG_DISCARD_FLAG \
320878b3c1SAri Sundholm | LOG_MARK_FLAG)
33bfcc224eSAapo Vienamo
34bfcc224eSAapo Vienamo #define WRITE_LOG_VERSION 1ULL
35bfcc224eSAapo Vienamo #define WRITE_LOG_MAGIC 0x6a736677736872ULL
36bfcc224eSAapo Vienamo
37bfcc224eSAapo Vienamo /* All fields are little-endian. */
38bfcc224eSAapo Vienamo struct log_write_super {
39bfcc224eSAapo Vienamo uint64_t magic;
40bfcc224eSAapo Vienamo uint64_t version;
41bfcc224eSAapo Vienamo uint64_t nr_entries;
42bfcc224eSAapo Vienamo uint32_t sectorsize;
43bfcc224eSAapo Vienamo } QEMU_PACKED;
44bfcc224eSAapo Vienamo
45bfcc224eSAapo Vienamo struct log_write_entry {
46bfcc224eSAapo Vienamo uint64_t sector;
47bfcc224eSAapo Vienamo uint64_t nr_sectors;
48bfcc224eSAapo Vienamo uint64_t flags;
49bfcc224eSAapo Vienamo uint64_t data_len;
50bfcc224eSAapo Vienamo } QEMU_PACKED;
51bfcc224eSAapo Vienamo
52bfcc224eSAapo Vienamo /* End of disk format structures. */
53bfcc224eSAapo Vienamo
54bfcc224eSAapo Vienamo typedef struct {
55bfcc224eSAapo Vienamo BdrvChild *log_file;
56bfcc224eSAapo Vienamo uint32_t sectorsize;
57bfcc224eSAapo Vienamo uint32_t sectorbits;
58a26d018cSAri Sundholm uint64_t update_interval;
59a26d018cSAri Sundholm
60a26d018cSAri Sundholm /*
61a26d018cSAri Sundholm * The mutable state of the driver, consisting of the current log sector
62a26d018cSAri Sundholm * and the number of log entries.
63a26d018cSAri Sundholm *
64a26d018cSAri Sundholm * May be read and/or written from multiple threads, and the mutex must be
65a26d018cSAri Sundholm * held when accessing these fields.
66a26d018cSAri Sundholm */
67bfcc224eSAapo Vienamo uint64_t cur_log_sector;
68bfcc224eSAapo Vienamo uint64_t nr_entries;
69a26d018cSAri Sundholm QemuMutex mutex;
70a26d018cSAri Sundholm
71a26d018cSAri Sundholm /*
72a26d018cSAri Sundholm * The super block sequence number. Non-zero if a super block update is in
73a26d018cSAri Sundholm * progress.
74a26d018cSAri Sundholm *
75a26d018cSAri Sundholm * The mutex must be held when accessing this field.
76a26d018cSAri Sundholm */
77a26d018cSAri Sundholm uint64_t super_update_seq;
78a26d018cSAri Sundholm
79a26d018cSAri Sundholm /*
80a26d018cSAri Sundholm * A coroutine-aware queue to serialize super block updates.
81a26d018cSAri Sundholm *
82a26d018cSAri Sundholm * Used with the mutex to ensure that only one thread be updating the super
83a26d018cSAri Sundholm * block at a time.
84a26d018cSAri Sundholm */
85a26d018cSAri Sundholm CoQueue super_update_queue;
86bfcc224eSAapo Vienamo } BDRVBlkLogWritesState;
87bfcc224eSAapo Vienamo
88bfcc224eSAapo Vienamo static QemuOptsList runtime_opts = {
89bfcc224eSAapo Vienamo .name = "blklogwrites",
90bfcc224eSAapo Vienamo .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
91bfcc224eSAapo Vienamo .desc = {
92bfcc224eSAapo Vienamo {
930878b3c1SAri Sundholm .name = "log-append",
940878b3c1SAri Sundholm .type = QEMU_OPT_BOOL,
950878b3c1SAri Sundholm .help = "Append to an existing log",
960878b3c1SAri Sundholm },
970878b3c1SAri Sundholm {
98bfcc224eSAapo Vienamo .name = "log-sector-size",
99bfcc224eSAapo Vienamo .type = QEMU_OPT_SIZE,
100bfcc224eSAapo Vienamo .help = "Log sector size",
101bfcc224eSAapo Vienamo },
1021dce698eSAri Sundholm {
1031dce698eSAri Sundholm .name = "log-super-update-interval",
1041dce698eSAri Sundholm .type = QEMU_OPT_NUMBER,
1051dce698eSAri Sundholm .help = "Log superblock update interval (# of write requests)",
1061dce698eSAri Sundholm },
107bfcc224eSAapo Vienamo { /* end of list */ }
108bfcc224eSAapo Vienamo },
109bfcc224eSAapo Vienamo };
110bfcc224eSAapo Vienamo
blk_log_writes_log2(uint32_t value)111bfcc224eSAapo Vienamo static inline uint32_t blk_log_writes_log2(uint32_t value)
112bfcc224eSAapo Vienamo {
113bfcc224eSAapo Vienamo assert(value > 0);
114bfcc224eSAapo Vienamo return 31 - clz32(value);
115bfcc224eSAapo Vienamo }
116bfcc224eSAapo Vienamo
blk_log_writes_sector_size_valid(uint32_t sector_size)1170878b3c1SAri Sundholm static inline bool blk_log_writes_sector_size_valid(uint32_t sector_size)
1180878b3c1SAri Sundholm {
119ba814c82SAri Sundholm return is_power_of_2(sector_size) &&
120ba814c82SAri Sundholm sector_size >= sizeof(struct log_write_super) &&
121ba814c82SAri Sundholm sector_size >= sizeof(struct log_write_entry) &&
122ba814c82SAri Sundholm sector_size < (1ull << 24);
1230878b3c1SAri Sundholm }
1240878b3c1SAri Sundholm
blk_log_writes_find_cur_log_sector(BdrvChild * log,uint32_t sector_size,uint64_t nr_entries,Error ** errp)1250878b3c1SAri Sundholm static uint64_t blk_log_writes_find_cur_log_sector(BdrvChild *log,
1260878b3c1SAri Sundholm uint32_t sector_size,
1270878b3c1SAri Sundholm uint64_t nr_entries,
1280878b3c1SAri Sundholm Error **errp)
1290878b3c1SAri Sundholm {
1300878b3c1SAri Sundholm uint64_t cur_sector = 1;
1310878b3c1SAri Sundholm uint64_t cur_idx = 0;
1320878b3c1SAri Sundholm uint32_t sector_bits = blk_log_writes_log2(sector_size);
1330878b3c1SAri Sundholm struct log_write_entry cur_entry;
1340878b3c1SAri Sundholm
1350878b3c1SAri Sundholm while (cur_idx < nr_entries) {
13632cc71deSAlberto Faria int read_ret = bdrv_pread(log, cur_sector << sector_bits,
13732cc71deSAlberto Faria sizeof(cur_entry), &cur_entry, 0);
1380878b3c1SAri Sundholm if (read_ret < 0) {
1390878b3c1SAri Sundholm error_setg_errno(errp, -read_ret,
1400878b3c1SAri Sundholm "Failed to read log entry %"PRIu64, cur_idx);
1410878b3c1SAri Sundholm return (uint64_t)-1ull;
1420878b3c1SAri Sundholm }
1430878b3c1SAri Sundholm
1440878b3c1SAri Sundholm if (cur_entry.flags & ~cpu_to_le64(LOG_FLAG_MASK)) {
1450878b3c1SAri Sundholm error_setg(errp, "Invalid flags 0x%"PRIx64" in log entry %"PRIu64,
1460878b3c1SAri Sundholm le64_to_cpu(cur_entry.flags), cur_idx);
1470878b3c1SAri Sundholm return (uint64_t)-1ull;
1480878b3c1SAri Sundholm }
1490878b3c1SAri Sundholm
1500878b3c1SAri Sundholm /* Account for the sector of the entry itself */
1510878b3c1SAri Sundholm ++cur_sector;
1520878b3c1SAri Sundholm
1530878b3c1SAri Sundholm /*
1540878b3c1SAri Sundholm * Account for the data of the write.
1550878b3c1SAri Sundholm * For discards, this data is not present.
1560878b3c1SAri Sundholm */
1570878b3c1SAri Sundholm if (!(cur_entry.flags & cpu_to_le64(LOG_DISCARD_FLAG))) {
1580878b3c1SAri Sundholm cur_sector += le64_to_cpu(cur_entry.nr_sectors);
1590878b3c1SAri Sundholm }
1600878b3c1SAri Sundholm
1610878b3c1SAri Sundholm ++cur_idx;
1620878b3c1SAri Sundholm }
1630878b3c1SAri Sundholm
1640878b3c1SAri Sundholm return cur_sector;
1650878b3c1SAri Sundholm }
1660878b3c1SAri Sundholm
blk_log_writes_open(BlockDriverState * bs,QDict * options,int flags,Error ** errp)167bfcc224eSAapo Vienamo static int blk_log_writes_open(BlockDriverState *bs, QDict *options, int flags,
168bfcc224eSAapo Vienamo Error **errp)
169bfcc224eSAapo Vienamo {
170bfcc224eSAapo Vienamo BDRVBlkLogWritesState *s = bs->opaque;
171bfcc224eSAapo Vienamo QemuOpts *opts;
172bfcc224eSAapo Vienamo Error *local_err = NULL;
173bfcc224eSAapo Vienamo int ret;
1742dacaf7cSAri Sundholm uint64_t log_sector_size;
1750878b3c1SAri Sundholm bool log_append;
176bfcc224eSAapo Vienamo
177bfcc224eSAapo Vienamo opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
178af175e85SMarkus Armbruster if (!qemu_opts_absorb_qdict(opts, options, errp)) {
179bfcc224eSAapo Vienamo ret = -EINVAL;
180bfcc224eSAapo Vienamo goto fail;
181bfcc224eSAapo Vienamo }
182bfcc224eSAapo Vienamo
183bfcc224eSAapo Vienamo /* Open the file */
18483930780SVladimir Sementsov-Ogievskiy ret = bdrv_open_file_child(NULL, options, "file", bs, errp);
18583930780SVladimir Sementsov-Ogievskiy if (ret < 0) {
186bfcc224eSAapo Vienamo goto fail;
187bfcc224eSAapo Vienamo }
188bfcc224eSAapo Vienamo
189bfcc224eSAapo Vienamo /* Open the log file */
19058944401SMax Reitz s->log_file = bdrv_open_child(NULL, options, "log", bs, &child_of_bds,
191bc520249SVladimir Sementsov-Ogievskiy BDRV_CHILD_METADATA, false, errp);
192bc520249SVladimir Sementsov-Ogievskiy if (!s->log_file) {
193bfcc224eSAapo Vienamo ret = -EINVAL;
194bfcc224eSAapo Vienamo goto fail;
195bfcc224eSAapo Vienamo }
196bfcc224eSAapo Vienamo
197a26d018cSAri Sundholm qemu_mutex_init(&s->mutex);
198a26d018cSAri Sundholm qemu_co_queue_init(&s->super_update_queue);
199a26d018cSAri Sundholm
2000878b3c1SAri Sundholm log_append = qemu_opt_get_bool(opts, "log-append", false);
2010878b3c1SAri Sundholm
2020878b3c1SAri Sundholm if (log_append) {
2030878b3c1SAri Sundholm struct log_write_super log_sb = { 0, 0, 0, 0 };
2040878b3c1SAri Sundholm
2050878b3c1SAri Sundholm if (qemu_opt_find(opts, "log-sector-size")) {
2060878b3c1SAri Sundholm ret = -EINVAL;
2070878b3c1SAri Sundholm error_setg(errp, "log-append and log-sector-size are mutually "
2080878b3c1SAri Sundholm "exclusive");
2090878b3c1SAri Sundholm goto fail_log;
2100878b3c1SAri Sundholm }
2110878b3c1SAri Sundholm
2120878b3c1SAri Sundholm /* Read log superblock or fake one for an empty log */
2130878b3c1SAri Sundholm if (!bdrv_getlength(s->log_file->bs)) {
2140878b3c1SAri Sundholm log_sb.magic = cpu_to_le64(WRITE_LOG_MAGIC);
2150878b3c1SAri Sundholm log_sb.version = cpu_to_le64(WRITE_LOG_VERSION);
2160878b3c1SAri Sundholm log_sb.nr_entries = cpu_to_le64(0);
2170878b3c1SAri Sundholm log_sb.sectorsize = cpu_to_le32(BDRV_SECTOR_SIZE);
2180878b3c1SAri Sundholm } else {
21932cc71deSAlberto Faria ret = bdrv_pread(s->log_file, 0, sizeof(log_sb), &log_sb, 0);
2200878b3c1SAri Sundholm if (ret < 0) {
2210878b3c1SAri Sundholm error_setg_errno(errp, -ret, "Could not read log superblock");
2220878b3c1SAri Sundholm goto fail_log;
2230878b3c1SAri Sundholm }
2240878b3c1SAri Sundholm }
2250878b3c1SAri Sundholm
2260878b3c1SAri Sundholm if (log_sb.magic != cpu_to_le64(WRITE_LOG_MAGIC)) {
2270878b3c1SAri Sundholm ret = -EINVAL;
2280878b3c1SAri Sundholm error_setg(errp, "Invalid log superblock magic");
2290878b3c1SAri Sundholm goto fail_log;
2300878b3c1SAri Sundholm }
2310878b3c1SAri Sundholm
2320878b3c1SAri Sundholm if (log_sb.version != cpu_to_le64(WRITE_LOG_VERSION)) {
2330878b3c1SAri Sundholm ret = -EINVAL;
2340878b3c1SAri Sundholm error_setg(errp, "Unsupported log version %"PRIu64,
2350878b3c1SAri Sundholm le64_to_cpu(log_sb.version));
2360878b3c1SAri Sundholm goto fail_log;
2370878b3c1SAri Sundholm }
2380878b3c1SAri Sundholm
2390878b3c1SAri Sundholm log_sector_size = le32_to_cpu(log_sb.sectorsize);
2400878b3c1SAri Sundholm s->cur_log_sector = 1;
2410878b3c1SAri Sundholm s->nr_entries = 0;
2420878b3c1SAri Sundholm
2430878b3c1SAri Sundholm if (blk_log_writes_sector_size_valid(log_sector_size)) {
2440878b3c1SAri Sundholm s->cur_log_sector =
2450878b3c1SAri Sundholm blk_log_writes_find_cur_log_sector(s->log_file, log_sector_size,
2460878b3c1SAri Sundholm le64_to_cpu(log_sb.nr_entries), &local_err);
2470878b3c1SAri Sundholm if (local_err) {
2480878b3c1SAri Sundholm ret = -EINVAL;
2490878b3c1SAri Sundholm error_propagate(errp, local_err);
2500878b3c1SAri Sundholm goto fail_log;
2510878b3c1SAri Sundholm }
2520878b3c1SAri Sundholm
2530878b3c1SAri Sundholm s->nr_entries = le64_to_cpu(log_sb.nr_entries);
2540878b3c1SAri Sundholm }
2550878b3c1SAri Sundholm } else {
2560878b3c1SAri Sundholm log_sector_size = qemu_opt_get_size(opts, "log-sector-size",
2570878b3c1SAri Sundholm BDRV_SECTOR_SIZE);
2580878b3c1SAri Sundholm s->cur_log_sector = 1;
2590878b3c1SAri Sundholm s->nr_entries = 0;
2600878b3c1SAri Sundholm }
2610878b3c1SAri Sundholm
262a26d018cSAri Sundholm s->super_update_seq = 0;
263a26d018cSAri Sundholm
2640878b3c1SAri Sundholm if (!blk_log_writes_sector_size_valid(log_sector_size)) {
2650878b3c1SAri Sundholm ret = -EINVAL;
2660878b3c1SAri Sundholm error_setg(errp, "Invalid log sector size %"PRIu64, log_sector_size);
2670878b3c1SAri Sundholm goto fail_log;
2680878b3c1SAri Sundholm }
2690878b3c1SAri Sundholm
2700878b3c1SAri Sundholm s->sectorsize = log_sector_size;
2710878b3c1SAri Sundholm s->sectorbits = blk_log_writes_log2(log_sector_size);
2721dce698eSAri Sundholm s->update_interval = qemu_opt_get_number(opts, "log-super-update-interval",
2731dce698eSAri Sundholm 4096);
2741dce698eSAri Sundholm if (!s->update_interval) {
2751dce698eSAri Sundholm ret = -EINVAL;
2761dce698eSAri Sundholm error_setg(errp, "Invalid log superblock update interval %"PRIu64,
2771dce698eSAri Sundholm s->update_interval);
2781dce698eSAri Sundholm goto fail_log;
2791dce698eSAri Sundholm }
2800878b3c1SAri Sundholm
281bfcc224eSAapo Vienamo ret = 0;
2820878b3c1SAri Sundholm fail_log:
2830878b3c1SAri Sundholm if (ret < 0) {
2846bc30f19SStefan Hajnoczi bdrv_graph_wrlock();
2850878b3c1SAri Sundholm bdrv_unref_child(bs, s->log_file);
2866bc30f19SStefan Hajnoczi bdrv_graph_wrunlock();
2870878b3c1SAri Sundholm s->log_file = NULL;
288a26d018cSAri Sundholm qemu_mutex_destroy(&s->mutex);
2890878b3c1SAri Sundholm }
290bfcc224eSAapo Vienamo fail:
291bfcc224eSAapo Vienamo qemu_opts_del(opts);
292bfcc224eSAapo Vienamo return ret;
293bfcc224eSAapo Vienamo }
294bfcc224eSAapo Vienamo
blk_log_writes_close(BlockDriverState * bs)295bfcc224eSAapo Vienamo static void blk_log_writes_close(BlockDriverState *bs)
296bfcc224eSAapo Vienamo {
297bfcc224eSAapo Vienamo BDRVBlkLogWritesState *s = bs->opaque;
298bfcc224eSAapo Vienamo
2996bc30f19SStefan Hajnoczi bdrv_graph_wrlock();
300bfcc224eSAapo Vienamo bdrv_unref_child(bs, s->log_file);
301bfcc224eSAapo Vienamo s->log_file = NULL;
3026bc30f19SStefan Hajnoczi bdrv_graph_wrunlock();
303a26d018cSAri Sundholm qemu_mutex_destroy(&s->mutex);
304bfcc224eSAapo Vienamo }
305bfcc224eSAapo Vienamo
3068ab8140aSKevin Wolf static int64_t coroutine_fn GRAPH_RDLOCK
blk_log_writes_co_getlength(BlockDriverState * bs)3078ab8140aSKevin Wolf blk_log_writes_co_getlength(BlockDriverState *bs)
308bfcc224eSAapo Vienamo {
309c86422c5SEmanuele Giuseppe Esposito return bdrv_co_getlength(bs->file->bs);
310bfcc224eSAapo Vienamo }
311bfcc224eSAapo Vienamo
blk_log_writes_child_perm(BlockDriverState * bs,BdrvChild * c,BdrvChildRole role,BlockReopenQueue * ro_q,uint64_t perm,uint64_t shrd,uint64_t * nperm,uint64_t * nshrd)312bfcc224eSAapo Vienamo static void blk_log_writes_child_perm(BlockDriverState *bs, BdrvChild *c,
313bf8e925eSMax Reitz BdrvChildRole role,
314bfcc224eSAapo Vienamo BlockReopenQueue *ro_q,
315bfcc224eSAapo Vienamo uint64_t perm, uint64_t shrd,
316bfcc224eSAapo Vienamo uint64_t *nperm, uint64_t *nshrd)
317bfcc224eSAapo Vienamo {
318bfcc224eSAapo Vienamo if (!c) {
319bfcc224eSAapo Vienamo *nperm = perm & DEFAULT_PERM_PASSTHROUGH;
320bfcc224eSAapo Vienamo *nshrd = (shrd & DEFAULT_PERM_PASSTHROUGH) | DEFAULT_PERM_UNCHANGED;
321bfcc224eSAapo Vienamo return;
322bfcc224eSAapo Vienamo }
323bfcc224eSAapo Vienamo
324e5d8a406SMax Reitz bdrv_default_perms(bs, c, role, ro_q, perm, shrd,
325bf8e925eSMax Reitz nperm, nshrd);
326bfcc224eSAapo Vienamo }
327bfcc224eSAapo Vienamo
blk_log_writes_refresh_limits(BlockDriverState * bs,Error ** errp)328bfcc224eSAapo Vienamo static void blk_log_writes_refresh_limits(BlockDriverState *bs, Error **errp)
329bfcc224eSAapo Vienamo {
330a26d018cSAri Sundholm const BDRVBlkLogWritesState *s = bs->opaque;
331bfcc224eSAapo Vienamo bs->bl.request_alignment = s->sectorsize;
332bfcc224eSAapo Vienamo }
333bfcc224eSAapo Vienamo
334b9b10c35SKevin Wolf static int coroutine_fn GRAPH_RDLOCK
blk_log_writes_co_preadv(BlockDriverState * bs,int64_t offset,int64_t bytes,QEMUIOVector * qiov,BdrvRequestFlags flags)335f7ef38ddSVladimir Sementsov-Ogievskiy blk_log_writes_co_preadv(BlockDriverState *bs, int64_t offset, int64_t bytes,
336f7ef38ddSVladimir Sementsov-Ogievskiy QEMUIOVector *qiov, BdrvRequestFlags flags)
337bfcc224eSAapo Vienamo {
338bfcc224eSAapo Vienamo return bdrv_co_preadv(bs->file, offset, bytes, qiov, flags);
339bfcc224eSAapo Vienamo }
340bfcc224eSAapo Vienamo
341bfcc224eSAapo Vienamo typedef struct BlkLogWritesFileReq {
342bfcc224eSAapo Vienamo BlockDriverState *bs;
343bfcc224eSAapo Vienamo uint64_t offset;
344bfcc224eSAapo Vienamo uint64_t bytes;
345bfcc224eSAapo Vienamo int file_flags;
346bfcc224eSAapo Vienamo QEMUIOVector *qiov;
34788095349SEmanuele Giuseppe Esposito int GRAPH_RDLOCK_PTR (*func)(struct BlkLogWritesFileReq *r);
348bfcc224eSAapo Vienamo int file_ret;
349bfcc224eSAapo Vienamo } BlkLogWritesFileReq;
350bfcc224eSAapo Vienamo
351bfcc224eSAapo Vienamo typedef struct {
352bfcc224eSAapo Vienamo BlockDriverState *bs;
353bfcc224eSAapo Vienamo QEMUIOVector *qiov;
354bfcc224eSAapo Vienamo struct log_write_entry entry;
355bfcc224eSAapo Vienamo uint64_t zero_size;
356bfcc224eSAapo Vienamo int log_ret;
357bfcc224eSAapo Vienamo } BlkLogWritesLogReq;
358bfcc224eSAapo Vienamo
35988095349SEmanuele Giuseppe Esposito static void coroutine_fn GRAPH_RDLOCK
blk_log_writes_co_do_log(BlkLogWritesLogReq * lr)36088095349SEmanuele Giuseppe Esposito blk_log_writes_co_do_log(BlkLogWritesLogReq *lr)
361bfcc224eSAapo Vienamo {
362bfcc224eSAapo Vienamo BDRVBlkLogWritesState *s = lr->bs->opaque;
363a9c8ea95SAri Sundholm
364a9c8ea95SAri Sundholm /*
365a9c8ea95SAri Sundholm * Determine the offsets and sizes of different parts of the entry, and
366a9c8ea95SAri Sundholm * update the state of the driver.
367a9c8ea95SAri Sundholm *
368a9c8ea95SAri Sundholm * This needs to be done in one go, before any actual I/O is done, as the
369a9c8ea95SAri Sundholm * log entry may have to be written in two parts, and the state of the
370a9c8ea95SAri Sundholm * driver may be modified by other driver operations while waiting for the
371a9c8ea95SAri Sundholm * I/O to complete.
372a9c8ea95SAri Sundholm */
373a26d018cSAri Sundholm qemu_mutex_lock(&s->mutex);
374a9c8ea95SAri Sundholm const uint64_t entry_start_sector = s->cur_log_sector;
375a9c8ea95SAri Sundholm const uint64_t entry_offset = entry_start_sector << s->sectorbits;
376a9c8ea95SAri Sundholm const uint64_t qiov_aligned_size = ROUND_UP(lr->qiov->size, s->sectorsize);
377a9c8ea95SAri Sundholm const uint64_t entry_aligned_size = qiov_aligned_size +
378a9c8ea95SAri Sundholm ROUND_UP(lr->zero_size, s->sectorsize);
379a9c8ea95SAri Sundholm const uint64_t entry_nr_sectors = entry_aligned_size >> s->sectorbits;
380a26d018cSAri Sundholm const uint64_t entry_seq = s->nr_entries + 1;
381bfcc224eSAapo Vienamo
382a26d018cSAri Sundholm s->nr_entries = entry_seq;
383a9c8ea95SAri Sundholm s->cur_log_sector += entry_nr_sectors;
384a26d018cSAri Sundholm qemu_mutex_unlock(&s->mutex);
385bfcc224eSAapo Vienamo
386a9c8ea95SAri Sundholm /*
387a9c8ea95SAri Sundholm * Write the log entry. Note that if this is a "write zeroes" operation,
388a9c8ea95SAri Sundholm * only the entry header is written here, with the zeroing being done
389a9c8ea95SAri Sundholm * separately below.
390a9c8ea95SAri Sundholm */
391a9c8ea95SAri Sundholm lr->log_ret = bdrv_co_pwritev(s->log_file, entry_offset, lr->qiov->size,
392bfcc224eSAapo Vienamo lr->qiov, 0);
393bfcc224eSAapo Vienamo
394bfcc224eSAapo Vienamo /* Logging for the "write zeroes" operation */
395bfcc224eSAapo Vienamo if (lr->log_ret == 0 && lr->zero_size) {
396a9c8ea95SAri Sundholm const uint64_t zeroes_offset = entry_offset + qiov_aligned_size;
397bfcc224eSAapo Vienamo
398a9c8ea95SAri Sundholm lr->log_ret = bdrv_co_pwrite_zeroes(s->log_file, zeroes_offset,
399bfcc224eSAapo Vienamo lr->zero_size, 0);
400bfcc224eSAapo Vienamo }
401bfcc224eSAapo Vienamo
4021dce698eSAri Sundholm /* Update super block on flush or every update interval */
4031dce698eSAri Sundholm if (lr->log_ret == 0 && ((lr->entry.flags & LOG_FLUSH_FLAG)
404a26d018cSAri Sundholm || (entry_seq % s->update_interval == 0)))
4051dce698eSAri Sundholm {
406bfcc224eSAapo Vienamo struct log_write_super super = {
407bfcc224eSAapo Vienamo .magic = cpu_to_le64(WRITE_LOG_MAGIC),
408bfcc224eSAapo Vienamo .version = cpu_to_le64(WRITE_LOG_VERSION),
409a26d018cSAri Sundholm .nr_entries = 0, /* updated below */
410bfcc224eSAapo Vienamo .sectorsize = cpu_to_le32(s->sectorsize),
411bfcc224eSAapo Vienamo };
412a26d018cSAri Sundholm void *zeroes;
413bfcc224eSAapo Vienamo QEMUIOVector qiov;
414bfcc224eSAapo Vienamo
415a26d018cSAri Sundholm /*
416a26d018cSAri Sundholm * Wait if a super block update is already in progress.
417a26d018cSAri Sundholm * Bail out if a newer update got its turn before us.
418a26d018cSAri Sundholm */
419a26d018cSAri Sundholm WITH_QEMU_LOCK_GUARD(&s->mutex) {
420a26d018cSAri Sundholm CoQueueWaitFlags wait_flags = 0;
421a26d018cSAri Sundholm while (s->super_update_seq) {
422a26d018cSAri Sundholm if (entry_seq < s->super_update_seq) {
423a26d018cSAri Sundholm return;
424a26d018cSAri Sundholm }
425a26d018cSAri Sundholm qemu_co_queue_wait_flags(&s->super_update_queue,
426a26d018cSAri Sundholm &s->mutex, wait_flags);
427a26d018cSAri Sundholm
428a26d018cSAri Sundholm /*
429a26d018cSAri Sundholm * In case the wait condition remains true after wakeup,
430a26d018cSAri Sundholm * to avoid starvation, make sure that this request is
431a26d018cSAri Sundholm * scheduled to rerun next by pushing it to the front of the
432a26d018cSAri Sundholm * queue.
433a26d018cSAri Sundholm */
434a26d018cSAri Sundholm wait_flags = CO_QUEUE_WAIT_FRONT;
435a26d018cSAri Sundholm }
436a26d018cSAri Sundholm s->super_update_seq = entry_seq;
437a26d018cSAri Sundholm super.nr_entries = cpu_to_le64(s->nr_entries);
438a26d018cSAri Sundholm }
439a26d018cSAri Sundholm
440a26d018cSAri Sundholm zeroes = g_malloc0(s->sectorsize - sizeof(super));
441a26d018cSAri Sundholm
442bfcc224eSAapo Vienamo qemu_iovec_init(&qiov, 2);
443bfcc224eSAapo Vienamo qemu_iovec_add(&qiov, &super, sizeof(super));
444bfcc224eSAapo Vienamo qemu_iovec_add(&qiov, zeroes, s->sectorsize - sizeof(super));
445bfcc224eSAapo Vienamo
446bfcc224eSAapo Vienamo lr->log_ret =
447bfcc224eSAapo Vienamo bdrv_co_pwritev(s->log_file, 0, s->sectorsize, &qiov, 0);
448bfcc224eSAapo Vienamo if (lr->log_ret == 0) {
449bfcc224eSAapo Vienamo lr->log_ret = bdrv_co_flush(s->log_file->bs);
450bfcc224eSAapo Vienamo }
451a26d018cSAri Sundholm
452a26d018cSAri Sundholm /* The super block has been updated. Let another request have a go. */
453a26d018cSAri Sundholm qemu_mutex_lock(&s->mutex);
454a26d018cSAri Sundholm s->super_update_seq = 0;
455a26d018cSAri Sundholm (void) qemu_co_queue_next(&s->super_update_queue);
456a26d018cSAri Sundholm qemu_mutex_unlock(&s->mutex);
457a26d018cSAri Sundholm
458bfcc224eSAapo Vienamo qemu_iovec_destroy(&qiov);
459bfcc224eSAapo Vienamo g_free(zeroes);
460bfcc224eSAapo Vienamo }
461bfcc224eSAapo Vienamo }
462bfcc224eSAapo Vienamo
46388095349SEmanuele Giuseppe Esposito static void coroutine_fn GRAPH_RDLOCK
blk_log_writes_co_do_file(BlkLogWritesFileReq * fr)46488095349SEmanuele Giuseppe Esposito blk_log_writes_co_do_file(BlkLogWritesFileReq *fr)
465bfcc224eSAapo Vienamo {
466bfcc224eSAapo Vienamo fr->file_ret = fr->func(fr);
467bfcc224eSAapo Vienamo }
468bfcc224eSAapo Vienamo
46988095349SEmanuele Giuseppe Esposito static int coroutine_fn GRAPH_RDLOCK
blk_log_writes_co_log(BlockDriverState * bs,uint64_t offset,uint64_t bytes,QEMUIOVector * qiov,int flags,int (* file_func)(BlkLogWritesFileReq * r),uint64_t entry_flags,bool is_zero_write)470bfcc224eSAapo Vienamo blk_log_writes_co_log(BlockDriverState *bs, uint64_t offset, uint64_t bytes,
471bfcc224eSAapo Vienamo QEMUIOVector *qiov, int flags,
47288095349SEmanuele Giuseppe Esposito int /*GRAPH_RDLOCK*/ (*file_func)(BlkLogWritesFileReq *r),
473bfcc224eSAapo Vienamo uint64_t entry_flags, bool is_zero_write)
474bfcc224eSAapo Vienamo {
475bfcc224eSAapo Vienamo QEMUIOVector log_qiov;
476bfcc224eSAapo Vienamo size_t niov = qiov ? qiov->niov : 0;
477a26d018cSAri Sundholm const BDRVBlkLogWritesState *s = bs->opaque;
478bfcc224eSAapo Vienamo BlkLogWritesFileReq fr = {
479bfcc224eSAapo Vienamo .bs = bs,
480bfcc224eSAapo Vienamo .offset = offset,
481bfcc224eSAapo Vienamo .bytes = bytes,
482bfcc224eSAapo Vienamo .file_flags = flags,
483bfcc224eSAapo Vienamo .qiov = qiov,
484bfcc224eSAapo Vienamo .func = file_func,
485bfcc224eSAapo Vienamo };
486bfcc224eSAapo Vienamo BlkLogWritesLogReq lr = {
487bfcc224eSAapo Vienamo .bs = bs,
488bfcc224eSAapo Vienamo .qiov = &log_qiov,
489bfcc224eSAapo Vienamo .entry = {
490bfcc224eSAapo Vienamo .sector = cpu_to_le64(offset >> s->sectorbits),
491bfcc224eSAapo Vienamo .nr_sectors = cpu_to_le64(bytes >> s->sectorbits),
492bfcc224eSAapo Vienamo .flags = cpu_to_le64(entry_flags),
493bfcc224eSAapo Vienamo .data_len = 0,
494bfcc224eSAapo Vienamo },
495bfcc224eSAapo Vienamo .zero_size = is_zero_write ? bytes : 0,
496bfcc224eSAapo Vienamo };
497bfcc224eSAapo Vienamo void *zeroes = g_malloc0(s->sectorsize - sizeof(lr.entry));
498bfcc224eSAapo Vienamo
499bfcc224eSAapo Vienamo assert((1 << s->sectorbits) == s->sectorsize);
500bfcc224eSAapo Vienamo assert(bs->bl.request_alignment == s->sectorsize);
501bfcc224eSAapo Vienamo assert(QEMU_IS_ALIGNED(offset, bs->bl.request_alignment));
502bfcc224eSAapo Vienamo assert(QEMU_IS_ALIGNED(bytes, bs->bl.request_alignment));
503bfcc224eSAapo Vienamo
504bfcc224eSAapo Vienamo qemu_iovec_init(&log_qiov, niov + 2);
505bfcc224eSAapo Vienamo qemu_iovec_add(&log_qiov, &lr.entry, sizeof(lr.entry));
506bfcc224eSAapo Vienamo qemu_iovec_add(&log_qiov, zeroes, s->sectorsize - sizeof(lr.entry));
507bfcc224eSAapo Vienamo if (qiov) {
508bfcc224eSAapo Vienamo qemu_iovec_concat(&log_qiov, qiov, 0, qiov->size);
509bfcc224eSAapo Vienamo }
510bfcc224eSAapo Vienamo
511bfcc224eSAapo Vienamo blk_log_writes_co_do_file(&fr);
512bfcc224eSAapo Vienamo blk_log_writes_co_do_log(&lr);
513bfcc224eSAapo Vienamo
514bfcc224eSAapo Vienamo qemu_iovec_destroy(&log_qiov);
515bfcc224eSAapo Vienamo g_free(zeroes);
516bfcc224eSAapo Vienamo
517bfcc224eSAapo Vienamo if (lr.log_ret < 0) {
518bfcc224eSAapo Vienamo return lr.log_ret;
519bfcc224eSAapo Vienamo }
520bfcc224eSAapo Vienamo
521bfcc224eSAapo Vienamo return fr.file_ret;
522bfcc224eSAapo Vienamo }
523bfcc224eSAapo Vienamo
524b9b10c35SKevin Wolf static int coroutine_fn GRAPH_RDLOCK
blk_log_writes_co_do_file_pwritev(BlkLogWritesFileReq * fr)525bfcc224eSAapo Vienamo blk_log_writes_co_do_file_pwritev(BlkLogWritesFileReq *fr)
526bfcc224eSAapo Vienamo {
527bfcc224eSAapo Vienamo return bdrv_co_pwritev(fr->bs->file, fr->offset, fr->bytes,
528bfcc224eSAapo Vienamo fr->qiov, fr->file_flags);
529bfcc224eSAapo Vienamo }
530bfcc224eSAapo Vienamo
531abaf8b75SKevin Wolf static int coroutine_fn GRAPH_RDLOCK
blk_log_writes_co_do_file_pwrite_zeroes(BlkLogWritesFileReq * fr)532bfcc224eSAapo Vienamo blk_log_writes_co_do_file_pwrite_zeroes(BlkLogWritesFileReq *fr)
533bfcc224eSAapo Vienamo {
534bfcc224eSAapo Vienamo return bdrv_co_pwrite_zeroes(fr->bs->file, fr->offset, fr->bytes,
535bfcc224eSAapo Vienamo fr->file_flags);
536bfcc224eSAapo Vienamo }
537bfcc224eSAapo Vienamo
53888095349SEmanuele Giuseppe Esposito static int coroutine_fn GRAPH_RDLOCK
blk_log_writes_co_do_file_flush(BlkLogWritesFileReq * fr)53988095349SEmanuele Giuseppe Esposito blk_log_writes_co_do_file_flush(BlkLogWritesFileReq *fr)
540bfcc224eSAapo Vienamo {
541bfcc224eSAapo Vienamo return bdrv_co_flush(fr->bs->file->bs);
542bfcc224eSAapo Vienamo }
543bfcc224eSAapo Vienamo
5449a5a1c62SEmanuele Giuseppe Esposito static int coroutine_fn GRAPH_RDLOCK
blk_log_writes_co_do_file_pdiscard(BlkLogWritesFileReq * fr)545bfcc224eSAapo Vienamo blk_log_writes_co_do_file_pdiscard(BlkLogWritesFileReq *fr)
546bfcc224eSAapo Vienamo {
5470b9fd3f4SFam Zheng return bdrv_co_pdiscard(fr->bs->file, fr->offset, fr->bytes);
548bfcc224eSAapo Vienamo }
549bfcc224eSAapo Vienamo
550b9b10c35SKevin Wolf static int coroutine_fn GRAPH_RDLOCK
blk_log_writes_co_pwritev(BlockDriverState * bs,int64_t offset,int64_t bytes,QEMUIOVector * qiov,BdrvRequestFlags flags)551e75abedaSVladimir Sementsov-Ogievskiy blk_log_writes_co_pwritev(BlockDriverState *bs, int64_t offset, int64_t bytes,
552e75abedaSVladimir Sementsov-Ogievskiy QEMUIOVector *qiov, BdrvRequestFlags flags)
553bfcc224eSAapo Vienamo {
554bfcc224eSAapo Vienamo return blk_log_writes_co_log(bs, offset, bytes, qiov, flags,
555bfcc224eSAapo Vienamo blk_log_writes_co_do_file_pwritev, 0, false);
556bfcc224eSAapo Vienamo }
557bfcc224eSAapo Vienamo
558abaf8b75SKevin Wolf static int coroutine_fn GRAPH_RDLOCK
blk_log_writes_co_pwrite_zeroes(BlockDriverState * bs,int64_t offset,int64_t bytes,BdrvRequestFlags flags)559f34b2bcfSVladimir Sementsov-Ogievskiy blk_log_writes_co_pwrite_zeroes(BlockDriverState *bs, int64_t offset,
560f34b2bcfSVladimir Sementsov-Ogievskiy int64_t bytes, BdrvRequestFlags flags)
561bfcc224eSAapo Vienamo {
562bfcc224eSAapo Vienamo return blk_log_writes_co_log(bs, offset, bytes, NULL, flags,
563bfcc224eSAapo Vienamo blk_log_writes_co_do_file_pwrite_zeroes, 0,
564bfcc224eSAapo Vienamo true);
565bfcc224eSAapo Vienamo }
566bfcc224eSAapo Vienamo
56788095349SEmanuele Giuseppe Esposito static int coroutine_fn GRAPH_RDLOCK
blk_log_writes_co_flush_to_disk(BlockDriverState * bs)56888095349SEmanuele Giuseppe Esposito blk_log_writes_co_flush_to_disk(BlockDriverState *bs)
569bfcc224eSAapo Vienamo {
570bfcc224eSAapo Vienamo return blk_log_writes_co_log(bs, 0, 0, NULL, 0,
571bfcc224eSAapo Vienamo blk_log_writes_co_do_file_flush,
572bfcc224eSAapo Vienamo LOG_FLUSH_FLAG, false);
573bfcc224eSAapo Vienamo }
574bfcc224eSAapo Vienamo
5759a5a1c62SEmanuele Giuseppe Esposito static int coroutine_fn GRAPH_RDLOCK
blk_log_writes_co_pdiscard(BlockDriverState * bs,int64_t offset,int64_t bytes)5760c802287SVladimir Sementsov-Ogievskiy blk_log_writes_co_pdiscard(BlockDriverState *bs, int64_t offset, int64_t bytes)
577bfcc224eSAapo Vienamo {
5780c802287SVladimir Sementsov-Ogievskiy return blk_log_writes_co_log(bs, offset, bytes, NULL, 0,
579bfcc224eSAapo Vienamo blk_log_writes_co_do_file_pdiscard,
580bfcc224eSAapo Vienamo LOG_DISCARD_FLAG, false);
581bfcc224eSAapo Vienamo }
582bfcc224eSAapo Vienamo
5832654267cSMax Reitz static const char *const blk_log_writes_strong_runtime_opts[] = {
5842654267cSMax Reitz "log-append",
5852654267cSMax Reitz "log-sector-size",
5862654267cSMax Reitz
5872654267cSMax Reitz NULL
5882654267cSMax Reitz };
5892654267cSMax Reitz
590bfcc224eSAapo Vienamo static BlockDriver bdrv_blk_log_writes = {
591bfcc224eSAapo Vienamo .format_name = "blklogwrites",
592bfcc224eSAapo Vienamo .instance_size = sizeof(BDRVBlkLogWritesState),
593bfcc224eSAapo Vienamo
594bfcc224eSAapo Vienamo .bdrv_open = blk_log_writes_open,
595bfcc224eSAapo Vienamo .bdrv_close = blk_log_writes_close,
596c86422c5SEmanuele Giuseppe Esposito .bdrv_co_getlength = blk_log_writes_co_getlength,
597bfcc224eSAapo Vienamo .bdrv_child_perm = blk_log_writes_child_perm,
598bfcc224eSAapo Vienamo .bdrv_refresh_limits = blk_log_writes_refresh_limits,
599bfcc224eSAapo Vienamo
600bfcc224eSAapo Vienamo .bdrv_co_preadv = blk_log_writes_co_preadv,
601bfcc224eSAapo Vienamo .bdrv_co_pwritev = blk_log_writes_co_pwritev,
602bfcc224eSAapo Vienamo .bdrv_co_pwrite_zeroes = blk_log_writes_co_pwrite_zeroes,
603bfcc224eSAapo Vienamo .bdrv_co_flush_to_disk = blk_log_writes_co_flush_to_disk,
604bfcc224eSAapo Vienamo .bdrv_co_pdiscard = blk_log_writes_co_pdiscard,
605bfcc224eSAapo Vienamo
606bfcc224eSAapo Vienamo .is_filter = true,
6072654267cSMax Reitz .strong_runtime_opts = blk_log_writes_strong_runtime_opts,
608bfcc224eSAapo Vienamo };
609bfcc224eSAapo Vienamo
bdrv_blk_log_writes_init(void)610bfcc224eSAapo Vienamo static void bdrv_blk_log_writes_init(void)
611bfcc224eSAapo Vienamo {
612bfcc224eSAapo Vienamo bdrv_register(&bdrv_blk_log_writes);
613bfcc224eSAapo Vienamo }
614bfcc224eSAapo Vienamo
615bfcc224eSAapo Vienamo block_init(bdrv_blk_log_writes_init);
616