Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2001-2002 Sistina Software (UK) Limited. |
| 3 | * Copyright (C) 2006-2008 Red Hat GmbH |
| 4 | * |
| 5 | * This file is released under the GPL. |
| 6 | */ |
| 7 | |
| 8 | #include "dm-exception-store.h" |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 9 | |
Mike Snitzer | b0d3cc0 | 2015-10-08 18:05:41 -0400 | [diff] [blame] | 10 | #include <linux/ctype.h> |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 11 | #include <linux/mm.h> |
| 12 | #include <linux/pagemap.h> |
| 13 | #include <linux/vmalloc.h> |
Paul Gortmaker | daaa5f7 | 2011-05-27 15:50:58 -0400 | [diff] [blame] | 14 | #include <linux/export.h> |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 15 | #include <linux/slab.h> |
| 16 | #include <linux/dm-io.h> |
Mikulas Patocka | afa53df | 2018-03-15 16:02:31 -0400 | [diff] [blame] | 17 | #include <linux/dm-bufio.h> |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 18 | |
| 19 | #define DM_MSG_PREFIX "persistent snapshot" |
Mikulas Patocka | ad6bf88 | 2020-01-15 08:35:25 -0500 | [diff] [blame] | 20 | #define DM_CHUNK_SIZE_DEFAULT_SECTORS 32U /* 16KB */ |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 21 | |
Mikulas Patocka | 55b082e | 2014-01-13 19:13:05 -0500 | [diff] [blame] | 22 | #define DM_PREFETCH_CHUNKS 12 |
| 23 | |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 24 | /*----------------------------------------------------------------- |
| 25 | * Persistent snapshots, by persistent we mean that the snapshot |
| 26 | * will survive a reboot. |
| 27 | *---------------------------------------------------------------*/ |
| 28 | |
| 29 | /* |
| 30 | * We need to store a record of which parts of the origin have |
| 31 | * been copied to the snapshot device. The snapshot code |
| 32 | * requires that we copy exception chunks to chunk aligned areas |
| 33 | * of the COW store. It makes sense therefore, to store the |
| 34 | * metadata in chunk size blocks. |
| 35 | * |
| 36 | * There is no backward or forward compatibility implemented, |
| 37 | * snapshots with different disk versions than the kernel will |
| 38 | * not be usable. It is expected that "lvcreate" will blank out |
| 39 | * the start of a fresh COW device before calling the snapshot |
| 40 | * constructor. |
| 41 | * |
| 42 | * The first chunk of the COW device just contains the header. |
| 43 | * After this there is a chunk filled with exception metadata, |
| 44 | * followed by as many exception chunks as can fit in the |
| 45 | * metadata areas. |
| 46 | * |
| 47 | * All on disk structures are in little-endian format. The end |
| 48 | * of the exceptions info is indicated by an exception with a |
| 49 | * new_chunk of 0, which is invalid since it would point to the |
| 50 | * header chunk. |
| 51 | */ |
| 52 | |
| 53 | /* |
| 54 | * Magic for persistent snapshots: "SnAp" - Feeble isn't it. |
| 55 | */ |
| 56 | #define SNAP_MAGIC 0x70416e53 |
| 57 | |
| 58 | /* |
| 59 | * The on-disk version of the metadata. |
| 60 | */ |
| 61 | #define SNAPSHOT_DISK_VERSION 1 |
| 62 | |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 63 | #define NUM_SNAPSHOT_HDR_CHUNKS 1 |
| 64 | |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 65 | struct disk_header { |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 66 | __le32 magic; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 67 | |
| 68 | /* |
| 69 | * Is this snapshot valid. There is no way of recovering |
| 70 | * an invalid snapshot. |
| 71 | */ |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 72 | __le32 valid; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 73 | |
| 74 | /* |
| 75 | * Simple, incrementing version. no backward |
| 76 | * compatibility. |
| 77 | */ |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 78 | __le32 version; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 79 | |
| 80 | /* In sectors */ |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 81 | __le32 chunk_size; |
| 82 | } __packed; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 83 | |
| 84 | struct disk_exception { |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 85 | __le64 old_chunk; |
| 86 | __le64 new_chunk; |
| 87 | } __packed; |
| 88 | |
| 89 | struct core_exception { |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 90 | uint64_t old_chunk; |
| 91 | uint64_t new_chunk; |
| 92 | }; |
| 93 | |
| 94 | struct commit_callback { |
| 95 | void (*callback)(void *, int success); |
| 96 | void *context; |
| 97 | }; |
| 98 | |
| 99 | /* |
| 100 | * The top level structure for a persistent exception store. |
| 101 | */ |
| 102 | struct pstore { |
Jonathan Brassow | 71fab00 | 2009-04-02 19:55:33 +0100 | [diff] [blame] | 103 | struct dm_exception_store *store; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 104 | int version; |
| 105 | int valid; |
| 106 | uint32_t exceptions_per_area; |
| 107 | |
| 108 | /* |
| 109 | * Now that we have an asynchronous kcopyd there is no |
| 110 | * need for large chunk sizes, so it wont hurt to have a |
| 111 | * whole chunks worth of metadata in memory at once. |
| 112 | */ |
| 113 | void *area; |
| 114 | |
| 115 | /* |
| 116 | * An area of zeros used to clear the next area. |
| 117 | */ |
| 118 | void *zero_area; |
| 119 | |
| 120 | /* |
Mikulas Patocka | 61578dc | 2009-09-04 20:40:39 +0100 | [diff] [blame] | 121 | * An area used for header. The header can be written |
| 122 | * concurrently with metadata (when invalidating the snapshot), |
| 123 | * so it needs a separate buffer. |
| 124 | */ |
| 125 | void *header_area; |
| 126 | |
| 127 | /* |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 128 | * Used to keep track of which metadata area the data in |
| 129 | * 'chunk' refers to. |
| 130 | */ |
| 131 | chunk_t current_area; |
| 132 | |
| 133 | /* |
| 134 | * The next free chunk for an exception. |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 135 | * |
| 136 | * When creating exceptions, all the chunks here and above are |
| 137 | * free. It holds the next chunk to be allocated. On rare |
| 138 | * occasions (e.g. after a system crash) holes can be left in |
| 139 | * the exception store because chunks can be committed out of |
| 140 | * order. |
| 141 | * |
| 142 | * When merging exceptions, it does not necessarily mean all the |
| 143 | * chunks here and above are free. It holds the value it would |
| 144 | * have held if all chunks had been committed in order of |
| 145 | * allocation. Consequently the value may occasionally be |
| 146 | * slightly too low, but since it's only used for 'status' and |
| 147 | * it can never reach its minimum value too early this doesn't |
| 148 | * matter. |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 149 | */ |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 150 | |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 151 | chunk_t next_free; |
| 152 | |
| 153 | /* |
| 154 | * The index of next free exception in the current |
| 155 | * metadata area. |
| 156 | */ |
| 157 | uint32_t current_committed; |
| 158 | |
| 159 | atomic_t pending_count; |
| 160 | uint32_t callback_count; |
| 161 | struct commit_callback *callbacks; |
| 162 | struct dm_io_client *io_client; |
| 163 | |
| 164 | struct workqueue_struct *metadata_wq; |
| 165 | }; |
| 166 | |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 167 | static int alloc_area(struct pstore *ps) |
| 168 | { |
| 169 | int r = -ENOMEM; |
| 170 | size_t len; |
| 171 | |
Jonathan Brassow | 71fab00 | 2009-04-02 19:55:33 +0100 | [diff] [blame] | 172 | len = ps->store->chunk_size << SECTOR_SHIFT; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 173 | |
| 174 | /* |
| 175 | * Allocate the chunk_size block of memory that will hold |
| 176 | * a single metadata area. |
| 177 | */ |
| 178 | ps->area = vmalloc(len); |
| 179 | if (!ps->area) |
Mikulas Patocka | 61578dc | 2009-09-04 20:40:39 +0100 | [diff] [blame] | 180 | goto err_area; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 181 | |
Joe Perches | e29e65a | 2011-08-02 12:32:02 +0100 | [diff] [blame] | 182 | ps->zero_area = vzalloc(len); |
Mikulas Patocka | 61578dc | 2009-09-04 20:40:39 +0100 | [diff] [blame] | 183 | if (!ps->zero_area) |
| 184 | goto err_zero_area; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 185 | |
Mikulas Patocka | 61578dc | 2009-09-04 20:40:39 +0100 | [diff] [blame] | 186 | ps->header_area = vmalloc(len); |
| 187 | if (!ps->header_area) |
| 188 | goto err_header_area; |
| 189 | |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 190 | return 0; |
Mikulas Patocka | 61578dc | 2009-09-04 20:40:39 +0100 | [diff] [blame] | 191 | |
| 192 | err_header_area: |
| 193 | vfree(ps->zero_area); |
| 194 | |
| 195 | err_zero_area: |
| 196 | vfree(ps->area); |
| 197 | |
| 198 | err_area: |
| 199 | return r; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 200 | } |
| 201 | |
| 202 | static void free_area(struct pstore *ps) |
| 203 | { |
Markus Elfring | 0c8f863 | 2015-02-02 14:38:29 +0100 | [diff] [blame] | 204 | vfree(ps->area); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 205 | ps->area = NULL; |
Markus Elfring | 0c8f863 | 2015-02-02 14:38:29 +0100 | [diff] [blame] | 206 | vfree(ps->zero_area); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 207 | ps->zero_area = NULL; |
Markus Elfring | 0c8f863 | 2015-02-02 14:38:29 +0100 | [diff] [blame] | 208 | vfree(ps->header_area); |
Mikulas Patocka | 61578dc | 2009-09-04 20:40:39 +0100 | [diff] [blame] | 209 | ps->header_area = NULL; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 210 | } |
| 211 | |
| 212 | struct mdata_req { |
| 213 | struct dm_io_region *where; |
| 214 | struct dm_io_request *io_req; |
| 215 | struct work_struct work; |
| 216 | int result; |
| 217 | }; |
| 218 | |
| 219 | static void do_metadata(struct work_struct *work) |
| 220 | { |
| 221 | struct mdata_req *req = container_of(work, struct mdata_req, work); |
| 222 | |
| 223 | req->result = dm_io(req->io_req, 1, req->where, NULL); |
| 224 | } |
| 225 | |
| 226 | /* |
| 227 | * Read or write a chunk aligned and sized block of data from a device. |
| 228 | */ |
Bart Van Assche | 6b99013 | 2022-07-14 11:06:54 -0700 | [diff] [blame] | 229 | static int chunk_io(struct pstore *ps, void *area, chunk_t chunk, blk_opf_t opf, |
| 230 | int metadata) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 231 | { |
| 232 | struct dm_io_region where = { |
Mike Snitzer | fc56f6f | 2009-12-10 23:52:12 +0000 | [diff] [blame] | 233 | .bdev = dm_snap_cow(ps->store->snap)->bdev, |
Jonathan Brassow | 71fab00 | 2009-04-02 19:55:33 +0100 | [diff] [blame] | 234 | .sector = ps->store->chunk_size * chunk, |
| 235 | .count = ps->store->chunk_size, |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 236 | }; |
| 237 | struct dm_io_request io_req = { |
Bart Van Assche | 6b99013 | 2022-07-14 11:06:54 -0700 | [diff] [blame] | 238 | .bi_opf = opf, |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 239 | .mem.type = DM_IO_VMA, |
Mikulas Patocka | 02d2fd3 | 2009-09-04 20:40:37 +0100 | [diff] [blame] | 240 | .mem.ptr.vma = area, |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 241 | .client = ps->io_client, |
| 242 | .notify.fn = NULL, |
| 243 | }; |
| 244 | struct mdata_req req; |
| 245 | |
| 246 | if (!metadata) |
| 247 | return dm_io(&io_req, 1, &where, NULL); |
| 248 | |
| 249 | req.where = &where; |
| 250 | req.io_req = &io_req; |
| 251 | |
| 252 | /* |
| 253 | * Issue the synchronous I/O from a different thread |
Christoph Hellwig | ed00aab | 2020-07-01 10:59:44 +0200 | [diff] [blame] | 254 | * to avoid submit_bio_noacct recursion. |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 255 | */ |
Andrew Morton | ca1cab3 | 2010-10-26 14:22:34 -0700 | [diff] [blame] | 256 | INIT_WORK_ONSTACK(&req.work, do_metadata); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 257 | queue_work(ps->metadata_wq, &req.work); |
Mikulas Patocka | 5ea330a | 2013-09-18 19:14:22 -0400 | [diff] [blame] | 258 | flush_workqueue(ps->metadata_wq); |
Chuansheng Liu | c1a6416 | 2014-01-07 16:56:18 +0800 | [diff] [blame] | 259 | destroy_work_on_stack(&req.work); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 260 | |
| 261 | return req.result; |
| 262 | } |
| 263 | |
| 264 | /* |
| 265 | * Convert a metadata area index to a chunk index. |
| 266 | */ |
| 267 | static chunk_t area_location(struct pstore *ps, chunk_t area) |
| 268 | { |
Tomohiro Kusumi | 87c961c | 2010-08-12 04:13:59 +0100 | [diff] [blame] | 269 | return NUM_SNAPSHOT_HDR_CHUNKS + ((ps->exceptions_per_area + 1) * area); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 270 | } |
| 271 | |
Mikulas Patocka | e9c6a18 | 2013-10-16 03:17:47 +0100 | [diff] [blame] | 272 | static void skip_metadata(struct pstore *ps) |
| 273 | { |
| 274 | uint32_t stride = ps->exceptions_per_area + 1; |
| 275 | chunk_t next_free = ps->next_free; |
| 276 | if (sector_div(next_free, stride) == NUM_SNAPSHOT_HDR_CHUNKS) |
| 277 | ps->next_free++; |
| 278 | } |
| 279 | |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 280 | /* |
| 281 | * Read or write a metadata area. Remembering to skip the first |
| 282 | * chunk which holds the header. |
| 283 | */ |
Bart Van Assche | 6b99013 | 2022-07-14 11:06:54 -0700 | [diff] [blame] | 284 | static int area_io(struct pstore *ps, blk_opf_t opf) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 285 | { |
Qinglang Miao | 7d837c0 | 2020-09-21 21:10:10 +0800 | [diff] [blame] | 286 | chunk_t chunk = area_location(ps, ps->current_area); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 287 | |
Bart Van Assche | 6b99013 | 2022-07-14 11:06:54 -0700 | [diff] [blame] | 288 | return chunk_io(ps, ps->area, chunk, opf, 0); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 289 | } |
| 290 | |
| 291 | static void zero_memory_area(struct pstore *ps) |
| 292 | { |
Jonathan Brassow | 71fab00 | 2009-04-02 19:55:33 +0100 | [diff] [blame] | 293 | memset(ps->area, 0, ps->store->chunk_size << SECTOR_SHIFT); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 294 | } |
| 295 | |
| 296 | static int zero_disk_area(struct pstore *ps, chunk_t area) |
| 297 | { |
Mike Christie | e604714 | 2016-06-05 14:32:04 -0500 | [diff] [blame] | 298 | return chunk_io(ps, ps->zero_area, area_location(ps, area), |
Bart Van Assche | 6b99013 | 2022-07-14 11:06:54 -0700 | [diff] [blame] | 299 | REQ_OP_WRITE, 0); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 300 | } |
| 301 | |
| 302 | static int read_header(struct pstore *ps, int *new_snapshot) |
| 303 | { |
| 304 | int r; |
| 305 | struct disk_header *dh; |
Mikulas Patocka | df96eee | 2009-10-16 23:18:17 +0100 | [diff] [blame] | 306 | unsigned chunk_size; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 307 | int chunk_size_supplied = 1; |
Mikulas Patocka | ae0b744 | 2009-09-04 20:40:43 +0100 | [diff] [blame] | 308 | char *chunk_err; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 309 | |
| 310 | /* |
Mikulas Patocka | df96eee | 2009-10-16 23:18:17 +0100 | [diff] [blame] | 311 | * Use default chunk size (or logical_block_size, if larger) |
| 312 | * if none supplied |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 313 | */ |
Jonathan Brassow | 71fab00 | 2009-04-02 19:55:33 +0100 | [diff] [blame] | 314 | if (!ps->store->chunk_size) { |
| 315 | ps->store->chunk_size = max(DM_CHUNK_SIZE_DEFAULT_SECTORS, |
Mike Snitzer | fc56f6f | 2009-12-10 23:52:12 +0000 | [diff] [blame] | 316 | bdev_logical_block_size(dm_snap_cow(ps->store->snap)-> |
| 317 | bdev) >> 9); |
Jonathan Brassow | 71fab00 | 2009-04-02 19:55:33 +0100 | [diff] [blame] | 318 | ps->store->chunk_mask = ps->store->chunk_size - 1; |
Mikulas Patocka | a3d939a | 2015-10-02 11:21:24 -0400 | [diff] [blame] | 319 | ps->store->chunk_shift = __ffs(ps->store->chunk_size); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 320 | chunk_size_supplied = 0; |
| 321 | } |
| 322 | |
Mikulas Patocka | bda8efe | 2011-05-29 13:03:09 +0100 | [diff] [blame] | 323 | ps->io_client = dm_io_client_create(); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 324 | if (IS_ERR(ps->io_client)) |
| 325 | return PTR_ERR(ps->io_client); |
| 326 | |
| 327 | r = alloc_area(ps); |
| 328 | if (r) |
| 329 | return r; |
| 330 | |
Bart Van Assche | 6b99013 | 2022-07-14 11:06:54 -0700 | [diff] [blame] | 331 | r = chunk_io(ps, ps->header_area, 0, REQ_OP_READ, 1); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 332 | if (r) |
| 333 | goto bad; |
| 334 | |
Mikulas Patocka | 61578dc | 2009-09-04 20:40:39 +0100 | [diff] [blame] | 335 | dh = ps->header_area; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 336 | |
| 337 | if (le32_to_cpu(dh->magic) == 0) { |
| 338 | *new_snapshot = 1; |
| 339 | return 0; |
| 340 | } |
| 341 | |
| 342 | if (le32_to_cpu(dh->magic) != SNAP_MAGIC) { |
| 343 | DMWARN("Invalid or corrupt snapshot"); |
| 344 | r = -ENXIO; |
| 345 | goto bad; |
| 346 | } |
| 347 | |
| 348 | *new_snapshot = 0; |
| 349 | ps->valid = le32_to_cpu(dh->valid); |
| 350 | ps->version = le32_to_cpu(dh->version); |
| 351 | chunk_size = le32_to_cpu(dh->chunk_size); |
| 352 | |
Mikulas Patocka | ae0b744 | 2009-09-04 20:40:43 +0100 | [diff] [blame] | 353 | if (ps->store->chunk_size == chunk_size) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 354 | return 0; |
| 355 | |
Mikulas Patocka | ae0b744 | 2009-09-04 20:40:43 +0100 | [diff] [blame] | 356 | if (chunk_size_supplied) |
Mikulas Patocka | df96eee | 2009-10-16 23:18:17 +0100 | [diff] [blame] | 357 | DMWARN("chunk size %u in device metadata overrides " |
| 358 | "table chunk size of %u.", |
| 359 | chunk_size, ps->store->chunk_size); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 360 | |
| 361 | /* We had a bogus chunk_size. Fix stuff up. */ |
| 362 | free_area(ps); |
| 363 | |
Mikulas Patocka | ae0b744 | 2009-09-04 20:40:43 +0100 | [diff] [blame] | 364 | r = dm_exception_store_set_chunk_size(ps->store, chunk_size, |
| 365 | &chunk_err); |
| 366 | if (r) { |
Mikulas Patocka | df96eee | 2009-10-16 23:18:17 +0100 | [diff] [blame] | 367 | DMERR("invalid on-disk chunk size %u: %s.", |
| 368 | chunk_size, chunk_err); |
Mikulas Patocka | ae0b744 | 2009-09-04 20:40:43 +0100 | [diff] [blame] | 369 | return r; |
| 370 | } |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 371 | |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 372 | r = alloc_area(ps); |
| 373 | return r; |
| 374 | |
| 375 | bad: |
| 376 | free_area(ps); |
| 377 | return r; |
| 378 | } |
| 379 | |
| 380 | static int write_header(struct pstore *ps) |
| 381 | { |
| 382 | struct disk_header *dh; |
| 383 | |
Mikulas Patocka | 61578dc | 2009-09-04 20:40:39 +0100 | [diff] [blame] | 384 | memset(ps->header_area, 0, ps->store->chunk_size << SECTOR_SHIFT); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 385 | |
Mikulas Patocka | 61578dc | 2009-09-04 20:40:39 +0100 | [diff] [blame] | 386 | dh = ps->header_area; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 387 | dh->magic = cpu_to_le32(SNAP_MAGIC); |
| 388 | dh->valid = cpu_to_le32(ps->valid); |
| 389 | dh->version = cpu_to_le32(ps->version); |
Jonathan Brassow | 71fab00 | 2009-04-02 19:55:33 +0100 | [diff] [blame] | 390 | dh->chunk_size = cpu_to_le32(ps->store->chunk_size); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 391 | |
Bart Van Assche | 6b99013 | 2022-07-14 11:06:54 -0700 | [diff] [blame] | 392 | return chunk_io(ps, ps->header_area, 0, REQ_OP_WRITE, 1); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 393 | } |
| 394 | |
| 395 | /* |
| 396 | * Access functions for the disk exceptions, these do the endian conversions. |
| 397 | */ |
Mikulas Patocka | 2cadabd | 2014-01-13 19:14:04 -0500 | [diff] [blame] | 398 | static struct disk_exception *get_exception(struct pstore *ps, void *ps_area, |
| 399 | uint32_t index) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 400 | { |
| 401 | BUG_ON(index >= ps->exceptions_per_area); |
| 402 | |
Mikulas Patocka | 2cadabd | 2014-01-13 19:14:04 -0500 | [diff] [blame] | 403 | return ((struct disk_exception *) ps_area) + index; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 404 | } |
| 405 | |
Mikulas Patocka | 2cadabd | 2014-01-13 19:14:04 -0500 | [diff] [blame] | 406 | static void read_exception(struct pstore *ps, void *ps_area, |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 407 | uint32_t index, struct core_exception *result) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 408 | { |
Mikulas Patocka | 2cadabd | 2014-01-13 19:14:04 -0500 | [diff] [blame] | 409 | struct disk_exception *de = get_exception(ps, ps_area, index); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 410 | |
| 411 | /* copy it */ |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 412 | result->old_chunk = le64_to_cpu(de->old_chunk); |
| 413 | result->new_chunk = le64_to_cpu(de->new_chunk); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 414 | } |
| 415 | |
| 416 | static void write_exception(struct pstore *ps, |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 417 | uint32_t index, struct core_exception *e) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 418 | { |
Mikulas Patocka | 2cadabd | 2014-01-13 19:14:04 -0500 | [diff] [blame] | 419 | struct disk_exception *de = get_exception(ps, ps->area, index); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 420 | |
| 421 | /* copy it */ |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 422 | de->old_chunk = cpu_to_le64(e->old_chunk); |
| 423 | de->new_chunk = cpu_to_le64(e->new_chunk); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 424 | } |
| 425 | |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 426 | static void clear_exception(struct pstore *ps, uint32_t index) |
| 427 | { |
Mikulas Patocka | 2cadabd | 2014-01-13 19:14:04 -0500 | [diff] [blame] | 428 | struct disk_exception *de = get_exception(ps, ps->area, index); |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 429 | |
| 430 | /* clear it */ |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 431 | de->old_chunk = 0; |
| 432 | de->new_chunk = 0; |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 433 | } |
| 434 | |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 435 | /* |
| 436 | * Registers the exceptions that are present in the current area. |
| 437 | * 'full' is filled in to indicate if the area has been |
| 438 | * filled. |
| 439 | */ |
Mikulas Patocka | 2cadabd | 2014-01-13 19:14:04 -0500 | [diff] [blame] | 440 | static int insert_exceptions(struct pstore *ps, void *ps_area, |
Jonathan Brassow | a159c1a | 2009-01-06 03:05:19 +0000 | [diff] [blame] | 441 | int (*callback)(void *callback_context, |
| 442 | chunk_t old, chunk_t new), |
| 443 | void *callback_context, |
| 444 | int *full) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 445 | { |
| 446 | int r; |
| 447 | unsigned int i; |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 448 | struct core_exception e; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 449 | |
| 450 | /* presume the area is full */ |
| 451 | *full = 1; |
| 452 | |
| 453 | for (i = 0; i < ps->exceptions_per_area; i++) { |
Mikulas Patocka | 2cadabd | 2014-01-13 19:14:04 -0500 | [diff] [blame] | 454 | read_exception(ps, ps_area, i, &e); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 455 | |
| 456 | /* |
| 457 | * If the new_chunk is pointing at the start of |
| 458 | * the COW device, where the first metadata area |
| 459 | * is we know that we've hit the end of the |
| 460 | * exceptions. Therefore the area is not full. |
| 461 | */ |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 462 | if (e.new_chunk == 0LL) { |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 463 | ps->current_committed = i; |
| 464 | *full = 0; |
| 465 | break; |
| 466 | } |
| 467 | |
| 468 | /* |
| 469 | * Keep track of the start of the free chunks. |
| 470 | */ |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 471 | if (ps->next_free <= e.new_chunk) |
| 472 | ps->next_free = e.new_chunk + 1; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 473 | |
| 474 | /* |
| 475 | * Otherwise we add the exception to the snapshot. |
| 476 | */ |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 477 | r = callback(callback_context, e.old_chunk, e.new_chunk); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 478 | if (r) |
| 479 | return r; |
| 480 | } |
| 481 | |
| 482 | return 0; |
| 483 | } |
| 484 | |
Jonathan Brassow | a159c1a | 2009-01-06 03:05:19 +0000 | [diff] [blame] | 485 | static int read_exceptions(struct pstore *ps, |
| 486 | int (*callback)(void *callback_context, chunk_t old, |
| 487 | chunk_t new), |
| 488 | void *callback_context) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 489 | { |
| 490 | int r, full = 1; |
Mikulas Patocka | 55494bf | 2014-01-13 19:12:36 -0500 | [diff] [blame] | 491 | struct dm_bufio_client *client; |
Mikulas Patocka | 55b082e | 2014-01-13 19:13:05 -0500 | [diff] [blame] | 492 | chunk_t prefetch_area = 0; |
Mikulas Patocka | 55494bf | 2014-01-13 19:12:36 -0500 | [diff] [blame] | 493 | |
| 494 | client = dm_bufio_client_create(dm_snap_cow(ps->store->snap)->bdev, |
| 495 | ps->store->chunk_size << SECTOR_SHIFT, |
Nathan Huckleberry | 0fcb100 | 2022-07-22 09:38:21 +0000 | [diff] [blame] | 496 | 1, 0, NULL, NULL, 0); |
Mikulas Patocka | 55494bf | 2014-01-13 19:12:36 -0500 | [diff] [blame] | 497 | |
| 498 | if (IS_ERR(client)) |
| 499 | return PTR_ERR(client); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 500 | |
| 501 | /* |
Mikulas Patocka | 55b082e | 2014-01-13 19:13:05 -0500 | [diff] [blame] | 502 | * Setup for one current buffer + desired readahead buffers. |
| 503 | */ |
| 504 | dm_bufio_set_minimum_buffers(client, 1 + DM_PREFETCH_CHUNKS); |
| 505 | |
| 506 | /* |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 507 | * Keeping reading chunks and inserting exceptions until |
| 508 | * we find a partially full area. |
| 509 | */ |
| 510 | for (ps->current_area = 0; full; ps->current_area++) { |
Mikulas Patocka | 55494bf | 2014-01-13 19:12:36 -0500 | [diff] [blame] | 511 | struct dm_buffer *bp; |
| 512 | void *area; |
Mikulas Patocka | 55b082e | 2014-01-13 19:13:05 -0500 | [diff] [blame] | 513 | chunk_t chunk; |
| 514 | |
| 515 | if (unlikely(prefetch_area < ps->current_area)) |
| 516 | prefetch_area = ps->current_area; |
| 517 | |
| 518 | if (DM_PREFETCH_CHUNKS) do { |
| 519 | chunk_t pf_chunk = area_location(ps, prefetch_area); |
| 520 | if (unlikely(pf_chunk >= dm_bufio_get_device_size(client))) |
| 521 | break; |
| 522 | dm_bufio_prefetch(client, pf_chunk, 1); |
| 523 | prefetch_area++; |
| 524 | if (unlikely(!prefetch_area)) |
| 525 | break; |
| 526 | } while (prefetch_area <= ps->current_area + DM_PREFETCH_CHUNKS); |
| 527 | |
| 528 | chunk = area_location(ps, ps->current_area); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 529 | |
Mikulas Patocka | 55494bf | 2014-01-13 19:12:36 -0500 | [diff] [blame] | 530 | area = dm_bufio_read(client, chunk, &bp); |
viresh kumar | fc0a446 | 2015-08-10 11:42:26 +0530 | [diff] [blame] | 531 | if (IS_ERR(area)) { |
Mikulas Patocka | 55494bf | 2014-01-13 19:12:36 -0500 | [diff] [blame] | 532 | r = PTR_ERR(area); |
| 533 | goto ret_destroy_bufio; |
| 534 | } |
| 535 | |
| 536 | r = insert_exceptions(ps, area, callback, callback_context, |
Mikulas Patocka | 2cadabd | 2014-01-13 19:14:04 -0500 | [diff] [blame] | 537 | &full); |
Mikulas Patocka | 55494bf | 2014-01-13 19:12:36 -0500 | [diff] [blame] | 538 | |
Mikulas Patocka | 2c94582 | 2014-03-03 17:19:22 -0500 | [diff] [blame] | 539 | if (!full) |
| 540 | memcpy(ps->area, area, ps->store->chunk_size << SECTOR_SHIFT); |
| 541 | |
Mikulas Patocka | 55494bf | 2014-01-13 19:12:36 -0500 | [diff] [blame] | 542 | dm_bufio_release(bp); |
| 543 | |
| 544 | dm_bufio_forget(client, chunk); |
| 545 | |
| 546 | if (unlikely(r)) |
| 547 | goto ret_destroy_bufio; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 548 | } |
| 549 | |
| 550 | ps->current_area--; |
| 551 | |
Mikulas Patocka | e9c6a18 | 2013-10-16 03:17:47 +0100 | [diff] [blame] | 552 | skip_metadata(ps); |
| 553 | |
Mikulas Patocka | 55494bf | 2014-01-13 19:12:36 -0500 | [diff] [blame] | 554 | r = 0; |
| 555 | |
| 556 | ret_destroy_bufio: |
| 557 | dm_bufio_client_destroy(client); |
| 558 | |
| 559 | return r; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 560 | } |
| 561 | |
| 562 | static struct pstore *get_info(struct dm_exception_store *store) |
| 563 | { |
| 564 | return (struct pstore *) store->context; |
| 565 | } |
| 566 | |
Mike Snitzer | 985903b | 2009-12-10 23:52:11 +0000 | [diff] [blame] | 567 | static void persistent_usage(struct dm_exception_store *store, |
| 568 | sector_t *total_sectors, |
| 569 | sector_t *sectors_allocated, |
| 570 | sector_t *metadata_sectors) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 571 | { |
Mike Snitzer | 985903b | 2009-12-10 23:52:11 +0000 | [diff] [blame] | 572 | struct pstore *ps = get_info(store); |
| 573 | |
| 574 | *sectors_allocated = ps->next_free * store->chunk_size; |
Mike Snitzer | fc56f6f | 2009-12-10 23:52:12 +0000 | [diff] [blame] | 575 | *total_sectors = get_dev_size(dm_snap_cow(store->snap)->bdev); |
Mike Snitzer | 985903b | 2009-12-10 23:52:11 +0000 | [diff] [blame] | 576 | |
| 577 | /* |
| 578 | * First chunk is the fixed header. |
| 579 | * Then there are (ps->current_area + 1) metadata chunks, each one |
| 580 | * separated from the next by ps->exceptions_per_area data chunks. |
| 581 | */ |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 582 | *metadata_sectors = (ps->current_area + 1 + NUM_SNAPSHOT_HDR_CHUNKS) * |
| 583 | store->chunk_size; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 584 | } |
| 585 | |
Jonathan Brassow | 493df71 | 2009-04-02 19:55:31 +0100 | [diff] [blame] | 586 | static void persistent_dtr(struct dm_exception_store *store) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 587 | { |
| 588 | struct pstore *ps = get_info(store); |
| 589 | |
| 590 | destroy_workqueue(ps->metadata_wq); |
Jonathan Brassow | a32079c | 2009-04-02 19:55:35 +0100 | [diff] [blame] | 591 | |
| 592 | /* Created in read_header */ |
| 593 | if (ps->io_client) |
| 594 | dm_io_client_destroy(ps->io_client); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 595 | free_area(ps); |
Jonathan Brassow | a32079c | 2009-04-02 19:55:35 +0100 | [diff] [blame] | 596 | |
| 597 | /* Allocated in persistent_read_metadata */ |
Matthew Wilcox (Oracle) | 7a35693 | 2021-04-07 14:25:22 +0100 | [diff] [blame] | 598 | kvfree(ps->callbacks); |
Jonathan Brassow | a32079c | 2009-04-02 19:55:35 +0100 | [diff] [blame] | 599 | |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 600 | kfree(ps); |
| 601 | } |
| 602 | |
Jonathan Brassow | a159c1a | 2009-01-06 03:05:19 +0000 | [diff] [blame] | 603 | static int persistent_read_metadata(struct dm_exception_store *store, |
| 604 | int (*callback)(void *callback_context, |
| 605 | chunk_t old, chunk_t new), |
| 606 | void *callback_context) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 607 | { |
Kees Cook | 3f649ab | 2020-06-03 13:09:38 -0700 | [diff] [blame] | 608 | int r, new_snapshot; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 609 | struct pstore *ps = get_info(store); |
| 610 | |
| 611 | /* |
| 612 | * Read the snapshot header. |
| 613 | */ |
| 614 | r = read_header(ps, &new_snapshot); |
| 615 | if (r) |
| 616 | return r; |
| 617 | |
| 618 | /* |
| 619 | * Now we know correct chunk_size, complete the initialisation. |
| 620 | */ |
Jonathan Brassow | 71fab00 | 2009-04-02 19:55:33 +0100 | [diff] [blame] | 621 | ps->exceptions_per_area = (ps->store->chunk_size << SECTOR_SHIFT) / |
| 622 | sizeof(struct disk_exception); |
Matthew Wilcox (Oracle) | 7a35693 | 2021-04-07 14:25:22 +0100 | [diff] [blame] | 623 | ps->callbacks = kvcalloc(ps->exceptions_per_area, |
| 624 | sizeof(*ps->callbacks), GFP_KERNEL); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 625 | if (!ps->callbacks) |
| 626 | return -ENOMEM; |
| 627 | |
| 628 | /* |
| 629 | * Do we need to setup a new snapshot ? |
| 630 | */ |
| 631 | if (new_snapshot) { |
| 632 | r = write_header(ps); |
| 633 | if (r) { |
| 634 | DMWARN("write_header failed"); |
| 635 | return r; |
| 636 | } |
| 637 | |
| 638 | ps->current_area = 0; |
| 639 | zero_memory_area(ps); |
| 640 | r = zero_disk_area(ps, 0); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 641 | if (r) |
Jon Brassow | f5acc83 | 2009-12-10 23:52:07 +0000 | [diff] [blame] | 642 | DMWARN("zero_disk_area(0) failed"); |
| 643 | return r; |
| 644 | } |
| 645 | /* |
| 646 | * Sanity checks. |
| 647 | */ |
| 648 | if (ps->version != SNAPSHOT_DISK_VERSION) { |
| 649 | DMWARN("unable to handle snapshot disk version %d", |
| 650 | ps->version); |
| 651 | return -EINVAL; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 652 | } |
| 653 | |
Jon Brassow | f5acc83 | 2009-12-10 23:52:07 +0000 | [diff] [blame] | 654 | /* |
| 655 | * Metadata are valid, but snapshot is invalidated |
| 656 | */ |
| 657 | if (!ps->valid) |
| 658 | return 1; |
| 659 | |
| 660 | /* |
| 661 | * Read the metadata. |
| 662 | */ |
| 663 | r = read_exceptions(ps, callback, callback_context); |
| 664 | |
| 665 | return r; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 666 | } |
| 667 | |
Jonathan Brassow | a159c1a | 2009-01-06 03:05:19 +0000 | [diff] [blame] | 668 | static int persistent_prepare_exception(struct dm_exception_store *store, |
Jon Brassow | 1d4989c | 2009-12-10 23:52:10 +0000 | [diff] [blame] | 669 | struct dm_exception *e) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 670 | { |
| 671 | struct pstore *ps = get_info(store); |
Mike Snitzer | fc56f6f | 2009-12-10 23:52:12 +0000 | [diff] [blame] | 672 | sector_t size = get_dev_size(dm_snap_cow(store->snap)->bdev); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 673 | |
| 674 | /* Is there enough room ? */ |
Jonathan Brassow | d021684 | 2009-04-02 19:55:32 +0100 | [diff] [blame] | 675 | if (size < ((ps->next_free + 1) * store->chunk_size)) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 676 | return -ENOSPC; |
| 677 | |
| 678 | e->new_chunk = ps->next_free; |
| 679 | |
| 680 | /* |
| 681 | * Move onto the next free pending, making sure to take |
| 682 | * into account the location of the metadata chunks. |
| 683 | */ |
Mikulas Patocka | e9c6a18 | 2013-10-16 03:17:47 +0100 | [diff] [blame] | 684 | ps->next_free++; |
| 685 | skip_metadata(ps); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 686 | |
| 687 | atomic_inc(&ps->pending_count); |
| 688 | return 0; |
| 689 | } |
| 690 | |
Jonathan Brassow | a159c1a | 2009-01-06 03:05:19 +0000 | [diff] [blame] | 691 | static void persistent_commit_exception(struct dm_exception_store *store, |
Mikulas Patocka | 385277b | 2016-01-08 19:07:55 -0500 | [diff] [blame] | 692 | struct dm_exception *e, int valid, |
Jonathan Brassow | a159c1a | 2009-01-06 03:05:19 +0000 | [diff] [blame] | 693 | void (*callback) (void *, int success), |
| 694 | void *callback_context) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 695 | { |
| 696 | unsigned int i; |
| 697 | struct pstore *ps = get_info(store); |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 698 | struct core_exception ce; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 699 | struct commit_callback *cb; |
| 700 | |
Mikulas Patocka | 385277b | 2016-01-08 19:07:55 -0500 | [diff] [blame] | 701 | if (!valid) |
| 702 | ps->valid = 0; |
| 703 | |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 704 | ce.old_chunk = e->old_chunk; |
| 705 | ce.new_chunk = e->new_chunk; |
| 706 | write_exception(ps, ps->current_committed++, &ce); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 707 | |
| 708 | /* |
| 709 | * Add the callback to the back of the array. This code |
| 710 | * is the only place where the callback array is |
| 711 | * manipulated, and we know that it will never be called |
| 712 | * multiple times concurrently. |
| 713 | */ |
| 714 | cb = ps->callbacks + ps->callback_count++; |
| 715 | cb->callback = callback; |
| 716 | cb->context = callback_context; |
| 717 | |
| 718 | /* |
| 719 | * If there are exceptions in flight and we have not yet |
| 720 | * filled this metadata area there's nothing more to do. |
| 721 | */ |
| 722 | if (!atomic_dec_and_test(&ps->pending_count) && |
| 723 | (ps->current_committed != ps->exceptions_per_area)) |
| 724 | return; |
| 725 | |
| 726 | /* |
| 727 | * If we completely filled the current area, then wipe the next one. |
| 728 | */ |
| 729 | if ((ps->current_committed == ps->exceptions_per_area) && |
Jonathan Brassow | a2d2b03 | 2011-08-02 12:32:03 +0100 | [diff] [blame] | 730 | zero_disk_area(ps, ps->current_area + 1)) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 731 | ps->valid = 0; |
| 732 | |
| 733 | /* |
| 734 | * Commit exceptions to disk. |
| 735 | */ |
Bart Van Assche | 6b99013 | 2022-07-14 11:06:54 -0700 | [diff] [blame] | 736 | if (ps->valid && area_io(ps, REQ_OP_WRITE | REQ_PREFLUSH | REQ_FUA | |
| 737 | REQ_SYNC)) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 738 | ps->valid = 0; |
| 739 | |
| 740 | /* |
| 741 | * Advance to the next area if this one is full. |
| 742 | */ |
| 743 | if (ps->current_committed == ps->exceptions_per_area) { |
| 744 | ps->current_committed = 0; |
| 745 | ps->current_area++; |
| 746 | zero_memory_area(ps); |
| 747 | } |
| 748 | |
| 749 | for (i = 0; i < ps->callback_count; i++) { |
| 750 | cb = ps->callbacks + i; |
| 751 | cb->callback(cb->context, ps->valid); |
| 752 | } |
| 753 | |
| 754 | ps->callback_count = 0; |
| 755 | } |
| 756 | |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 757 | static int persistent_prepare_merge(struct dm_exception_store *store, |
| 758 | chunk_t *last_old_chunk, |
| 759 | chunk_t *last_new_chunk) |
| 760 | { |
| 761 | struct pstore *ps = get_info(store); |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 762 | struct core_exception ce; |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 763 | int nr_consecutive; |
| 764 | int r; |
| 765 | |
| 766 | /* |
| 767 | * When current area is empty, move back to preceding area. |
| 768 | */ |
| 769 | if (!ps->current_committed) { |
| 770 | /* |
| 771 | * Have we finished? |
| 772 | */ |
| 773 | if (!ps->current_area) |
| 774 | return 0; |
| 775 | |
| 776 | ps->current_area--; |
Bart Van Assche | 6b99013 | 2022-07-14 11:06:54 -0700 | [diff] [blame] | 777 | r = area_io(ps, REQ_OP_READ); |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 778 | if (r < 0) |
| 779 | return r; |
| 780 | ps->current_committed = ps->exceptions_per_area; |
| 781 | } |
| 782 | |
Mikulas Patocka | 2cadabd | 2014-01-13 19:14:04 -0500 | [diff] [blame] | 783 | read_exception(ps, ps->area, ps->current_committed - 1, &ce); |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 784 | *last_old_chunk = ce.old_chunk; |
| 785 | *last_new_chunk = ce.new_chunk; |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 786 | |
| 787 | /* |
| 788 | * Find number of consecutive chunks within the current area, |
| 789 | * working backwards. |
| 790 | */ |
| 791 | for (nr_consecutive = 1; nr_consecutive < ps->current_committed; |
| 792 | nr_consecutive++) { |
Mikulas Patocka | 2cadabd | 2014-01-13 19:14:04 -0500 | [diff] [blame] | 793 | read_exception(ps, ps->area, |
| 794 | ps->current_committed - 1 - nr_consecutive, &ce); |
Alasdair G Kergon | 283a832 | 2011-08-02 12:32:01 +0100 | [diff] [blame] | 795 | if (ce.old_chunk != *last_old_chunk - nr_consecutive || |
| 796 | ce.new_chunk != *last_new_chunk - nr_consecutive) |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 797 | break; |
| 798 | } |
| 799 | |
| 800 | return nr_consecutive; |
| 801 | } |
| 802 | |
| 803 | static int persistent_commit_merge(struct dm_exception_store *store, |
| 804 | int nr_merged) |
| 805 | { |
| 806 | int r, i; |
| 807 | struct pstore *ps = get_info(store); |
| 808 | |
| 809 | BUG_ON(nr_merged > ps->current_committed); |
| 810 | |
| 811 | for (i = 0; i < nr_merged; i++) |
| 812 | clear_exception(ps, ps->current_committed - 1 - i); |
| 813 | |
Bart Van Assche | 6b99013 | 2022-07-14 11:06:54 -0700 | [diff] [blame] | 814 | r = area_io(ps, REQ_OP_WRITE | REQ_PREFLUSH | REQ_FUA); |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 815 | if (r < 0) |
| 816 | return r; |
| 817 | |
| 818 | ps->current_committed -= nr_merged; |
| 819 | |
| 820 | /* |
| 821 | * At this stage, only persistent_usage() uses ps->next_free, so |
| 822 | * we make no attempt to keep ps->next_free strictly accurate |
| 823 | * as exceptions may have been committed out-of-order originally. |
| 824 | * Once a snapshot has become merging, we set it to the value it |
| 825 | * would have held had all the exceptions been committed in order. |
| 826 | * |
| 827 | * ps->current_area does not get reduced by prepare_merge() until |
| 828 | * after commit_merge() has removed the nr_merged previous exceptions. |
| 829 | */ |
Tomohiro Kusumi | 87c961c | 2010-08-12 04:13:59 +0100 | [diff] [blame] | 830 | ps->next_free = area_location(ps, ps->current_area) + |
| 831 | ps->current_committed + 1; |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 832 | |
| 833 | return 0; |
| 834 | } |
| 835 | |
Jonathan Brassow | a159c1a | 2009-01-06 03:05:19 +0000 | [diff] [blame] | 836 | static void persistent_drop_snapshot(struct dm_exception_store *store) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 837 | { |
| 838 | struct pstore *ps = get_info(store); |
| 839 | |
| 840 | ps->valid = 0; |
| 841 | if (write_header(ps)) |
| 842 | DMWARN("write header failed"); |
| 843 | } |
| 844 | |
Mike Snitzer | b0d3cc0 | 2015-10-08 18:05:41 -0400 | [diff] [blame] | 845 | static int persistent_ctr(struct dm_exception_store *store, char *options) |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 846 | { |
| 847 | struct pstore *ps; |
Sudip Mukherjee | a2a678e | 2015-10-13 13:33:08 +0530 | [diff] [blame] | 848 | int r; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 849 | |
| 850 | /* allocate the pstore */ |
Jonathan Brassow | a32079c | 2009-04-02 19:55:35 +0100 | [diff] [blame] | 851 | ps = kzalloc(sizeof(*ps), GFP_KERNEL); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 852 | if (!ps) |
| 853 | return -ENOMEM; |
| 854 | |
Jonathan Brassow | 71fab00 | 2009-04-02 19:55:33 +0100 | [diff] [blame] | 855 | ps->store = store; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 856 | ps->valid = 1; |
| 857 | ps->version = SNAPSHOT_DISK_VERSION; |
| 858 | ps->area = NULL; |
Mikulas Patocka | 61578dc | 2009-09-04 20:40:39 +0100 | [diff] [blame] | 859 | ps->zero_area = NULL; |
| 860 | ps->header_area = NULL; |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 861 | ps->next_free = NUM_SNAPSHOT_HDR_CHUNKS + 1; /* header and 1st area */ |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 862 | ps->current_committed = 0; |
| 863 | |
| 864 | ps->callback_count = 0; |
| 865 | atomic_set(&ps->pending_count, 0); |
| 866 | ps->callbacks = NULL; |
| 867 | |
Tejun Heo | 239c8dd | 2011-01-13 19:59:59 +0000 | [diff] [blame] | 868 | ps->metadata_wq = alloc_workqueue("ksnaphd", WQ_MEM_RECLAIM, 0); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 869 | if (!ps->metadata_wq) { |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 870 | DMERR("couldn't start header metadata update thread"); |
Sudip Mukherjee | a2a678e | 2015-10-13 13:33:08 +0530 | [diff] [blame] | 871 | r = -ENOMEM; |
| 872 | goto err_workqueue; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 873 | } |
| 874 | |
Mike Snitzer | b0d3cc0 | 2015-10-08 18:05:41 -0400 | [diff] [blame] | 875 | if (options) { |
| 876 | char overflow = toupper(options[0]); |
| 877 | if (overflow == 'O') |
| 878 | store->userspace_supports_overflow = true; |
| 879 | else { |
| 880 | DMERR("Unsupported persistent store option: %s", options); |
Sudip Mukherjee | a2a678e | 2015-10-13 13:33:08 +0530 | [diff] [blame] | 881 | r = -EINVAL; |
| 882 | goto err_options; |
Mike Snitzer | b0d3cc0 | 2015-10-08 18:05:41 -0400 | [diff] [blame] | 883 | } |
| 884 | } |
| 885 | |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 886 | store->context = ps; |
| 887 | |
| 888 | return 0; |
Sudip Mukherjee | a2a678e | 2015-10-13 13:33:08 +0530 | [diff] [blame] | 889 | |
| 890 | err_options: |
| 891 | destroy_workqueue(ps->metadata_wq); |
| 892 | err_workqueue: |
| 893 | kfree(ps); |
| 894 | |
| 895 | return r; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 896 | } |
| 897 | |
Jonathan Brassow | 1e302a9 | 2009-04-02 19:55:35 +0100 | [diff] [blame] | 898 | static unsigned persistent_status(struct dm_exception_store *store, |
| 899 | status_type_t status, char *result, |
| 900 | unsigned maxlen) |
Jonathan Brassow | 493df71 | 2009-04-02 19:55:31 +0100 | [diff] [blame] | 901 | { |
Jonathan Brassow | 1e302a9 | 2009-04-02 19:55:35 +0100 | [diff] [blame] | 902 | unsigned sz = 0; |
| 903 | |
| 904 | switch (status) { |
| 905 | case STATUSTYPE_INFO: |
| 906 | break; |
| 907 | case STATUSTYPE_TABLE: |
Mike Snitzer | b0d3cc0 | 2015-10-08 18:05:41 -0400 | [diff] [blame] | 908 | DMEMIT(" %s %llu", store->userspace_supports_overflow ? "PO" : "P", |
| 909 | (unsigned long long)store->chunk_size); |
Tushar Sugandhi | 8ec4566 | 2021-07-12 17:49:03 -0700 | [diff] [blame] | 910 | break; |
| 911 | case STATUSTYPE_IMA: |
| 912 | *result = '\0'; |
| 913 | break; |
Jonathan Brassow | 1e302a9 | 2009-04-02 19:55:35 +0100 | [diff] [blame] | 914 | } |
Jonathan Brassow | 493df71 | 2009-04-02 19:55:31 +0100 | [diff] [blame] | 915 | |
| 916 | return sz; |
| 917 | } |
| 918 | |
| 919 | static struct dm_exception_store_type _persistent_type = { |
| 920 | .name = "persistent", |
| 921 | .module = THIS_MODULE, |
| 922 | .ctr = persistent_ctr, |
| 923 | .dtr = persistent_dtr, |
| 924 | .read_metadata = persistent_read_metadata, |
| 925 | .prepare_exception = persistent_prepare_exception, |
| 926 | .commit_exception = persistent_commit_exception, |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 927 | .prepare_merge = persistent_prepare_merge, |
| 928 | .commit_merge = persistent_commit_merge, |
Jonathan Brassow | 493df71 | 2009-04-02 19:55:31 +0100 | [diff] [blame] | 929 | .drop_snapshot = persistent_drop_snapshot, |
Mike Snitzer | 985903b | 2009-12-10 23:52:11 +0000 | [diff] [blame] | 930 | .usage = persistent_usage, |
Jonathan Brassow | 493df71 | 2009-04-02 19:55:31 +0100 | [diff] [blame] | 931 | .status = persistent_status, |
| 932 | }; |
| 933 | |
| 934 | static struct dm_exception_store_type _persistent_compat_type = { |
| 935 | .name = "P", |
| 936 | .module = THIS_MODULE, |
| 937 | .ctr = persistent_ctr, |
| 938 | .dtr = persistent_dtr, |
| 939 | .read_metadata = persistent_read_metadata, |
| 940 | .prepare_exception = persistent_prepare_exception, |
| 941 | .commit_exception = persistent_commit_exception, |
Mikulas Patocka | 4454a62 | 2009-12-10 23:52:29 +0000 | [diff] [blame] | 942 | .prepare_merge = persistent_prepare_merge, |
| 943 | .commit_merge = persistent_commit_merge, |
Jonathan Brassow | 493df71 | 2009-04-02 19:55:31 +0100 | [diff] [blame] | 944 | .drop_snapshot = persistent_drop_snapshot, |
Mike Snitzer | 985903b | 2009-12-10 23:52:11 +0000 | [diff] [blame] | 945 | .usage = persistent_usage, |
Jonathan Brassow | 493df71 | 2009-04-02 19:55:31 +0100 | [diff] [blame] | 946 | .status = persistent_status, |
| 947 | }; |
| 948 | |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 949 | int dm_persistent_snapshot_init(void) |
| 950 | { |
Jonathan Brassow | 493df71 | 2009-04-02 19:55:31 +0100 | [diff] [blame] | 951 | int r; |
| 952 | |
| 953 | r = dm_exception_store_type_register(&_persistent_type); |
| 954 | if (r) { |
| 955 | DMERR("Unable to register persistent exception store type"); |
| 956 | return r; |
| 957 | } |
| 958 | |
| 959 | r = dm_exception_store_type_register(&_persistent_compat_type); |
| 960 | if (r) { |
| 961 | DMERR("Unable to register old-style persistent exception " |
| 962 | "store type"); |
| 963 | dm_exception_store_type_unregister(&_persistent_type); |
| 964 | return r; |
| 965 | } |
| 966 | |
| 967 | return r; |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 968 | } |
| 969 | |
| 970 | void dm_persistent_snapshot_exit(void) |
| 971 | { |
Jonathan Brassow | 493df71 | 2009-04-02 19:55:31 +0100 | [diff] [blame] | 972 | dm_exception_store_type_unregister(&_persistent_type); |
| 973 | dm_exception_store_type_unregister(&_persistent_compat_type); |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 974 | } |