blob: b8cf956b577b4a2f235f4910b15ab2ef1942dd9b [file] [log] [blame]
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +00001/*
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 Kergon4db6bfe2009-01-06 03:05:17 +00009
Mike Snitzerb0d3cc02015-10-08 18:05:41 -040010#include <linux/ctype.h>
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +000011#include <linux/mm.h>
12#include <linux/pagemap.h>
13#include <linux/vmalloc.h>
Paul Gortmakerdaaa5f72011-05-27 15:50:58 -040014#include <linux/export.h>
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +000015#include <linux/slab.h>
16#include <linux/dm-io.h>
Mikulas Patocka55494bf2014-01-13 19:12:36 -050017#include "dm-bufio.h"
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +000018
19#define DM_MSG_PREFIX "persistent snapshot"
20#define DM_CHUNK_SIZE_DEFAULT_SECTORS 32 /* 16KB */
21
Mikulas Patocka55b082e2014-01-13 19:13:05 -050022#define DM_PREFETCH_CHUNKS 12
23
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +000024/*-----------------------------------------------------------------
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 Patocka4454a622009-12-10 23:52:29 +000063#define NUM_SNAPSHOT_HDR_CHUNKS 1
64
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +000065struct disk_header {
Alasdair G Kergon283a8322011-08-02 12:32:01 +010066 __le32 magic;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +000067
68 /*
69 * Is this snapshot valid. There is no way of recovering
70 * an invalid snapshot.
71 */
Alasdair G Kergon283a8322011-08-02 12:32:01 +010072 __le32 valid;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +000073
74 /*
75 * Simple, incrementing version. no backward
76 * compatibility.
77 */
Alasdair G Kergon283a8322011-08-02 12:32:01 +010078 __le32 version;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +000079
80 /* In sectors */
Alasdair G Kergon283a8322011-08-02 12:32:01 +010081 __le32 chunk_size;
82} __packed;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +000083
84struct disk_exception {
Alasdair G Kergon283a8322011-08-02 12:32:01 +010085 __le64 old_chunk;
86 __le64 new_chunk;
87} __packed;
88
89struct core_exception {
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +000090 uint64_t old_chunk;
91 uint64_t new_chunk;
92};
93
94struct 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 */
102struct pstore {
Jonathan Brassow71fab002009-04-02 19:55:33 +0100103 struct dm_exception_store *store;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000104 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 Patocka61578dc2009-09-04 20:40:39 +0100121 * 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 Kergon4db6bfe2009-01-06 03:05:17 +0000128 * 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 Patocka4454a622009-12-10 23:52:29 +0000135 *
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 Kergon4db6bfe2009-01-06 03:05:17 +0000149 */
Mikulas Patocka4454a622009-12-10 23:52:29 +0000150
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000151 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 Kergon4db6bfe2009-01-06 03:05:17 +0000167static int alloc_area(struct pstore *ps)
168{
169 int r = -ENOMEM;
170 size_t len;
171
Jonathan Brassow71fab002009-04-02 19:55:33 +0100172 len = ps->store->chunk_size << SECTOR_SHIFT;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000173
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 Patocka61578dc2009-09-04 20:40:39 +0100180 goto err_area;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000181
Joe Perchese29e65a2011-08-02 12:32:02 +0100182 ps->zero_area = vzalloc(len);
Mikulas Patocka61578dc2009-09-04 20:40:39 +0100183 if (!ps->zero_area)
184 goto err_zero_area;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000185
Mikulas Patocka61578dc2009-09-04 20:40:39 +0100186 ps->header_area = vmalloc(len);
187 if (!ps->header_area)
188 goto err_header_area;
189
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000190 return 0;
Mikulas Patocka61578dc2009-09-04 20:40:39 +0100191
192err_header_area:
193 vfree(ps->zero_area);
194
195err_zero_area:
196 vfree(ps->area);
197
198err_area:
199 return r;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000200}
201
202static void free_area(struct pstore *ps)
203{
Markus Elfring0c8f8632015-02-02 14:38:29 +0100204 vfree(ps->area);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000205 ps->area = NULL;
Markus Elfring0c8f8632015-02-02 14:38:29 +0100206 vfree(ps->zero_area);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000207 ps->zero_area = NULL;
Markus Elfring0c8f8632015-02-02 14:38:29 +0100208 vfree(ps->header_area);
Mikulas Patocka61578dc2009-09-04 20:40:39 +0100209 ps->header_area = NULL;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000210}
211
212struct 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
219static 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 */
Mike Christiee6047142016-06-05 14:32:04 -0500229static int chunk_io(struct pstore *ps, void *area, chunk_t chunk, int op,
230 int op_flags, int metadata)
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000231{
232 struct dm_io_region where = {
Mike Snitzerfc56f6f2009-12-10 23:52:12 +0000233 .bdev = dm_snap_cow(ps->store->snap)->bdev,
Jonathan Brassow71fab002009-04-02 19:55:33 +0100234 .sector = ps->store->chunk_size * chunk,
235 .count = ps->store->chunk_size,
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000236 };
237 struct dm_io_request io_req = {
Mike Christiee6047142016-06-05 14:32:04 -0500238 .bi_op = op,
239 .bi_op_flags = op_flags,
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000240 .mem.type = DM_IO_VMA,
Mikulas Patocka02d2fd32009-09-04 20:40:37 +0100241 .mem.ptr.vma = area,
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000242 .client = ps->io_client,
243 .notify.fn = NULL,
244 };
245 struct mdata_req req;
246
247 if (!metadata)
248 return dm_io(&io_req, 1, &where, NULL);
249
250 req.where = &where;
251 req.io_req = &io_req;
252
253 /*
254 * Issue the synchronous I/O from a different thread
255 * to avoid generic_make_request recursion.
256 */
Andrew Mortonca1cab32010-10-26 14:22:34 -0700257 INIT_WORK_ONSTACK(&req.work, do_metadata);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000258 queue_work(ps->metadata_wq, &req.work);
Mikulas Patocka5ea330a2013-09-18 19:14:22 -0400259 flush_workqueue(ps->metadata_wq);
Chuansheng Liuc1a64162014-01-07 16:56:18 +0800260 destroy_work_on_stack(&req.work);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000261
262 return req.result;
263}
264
265/*
266 * Convert a metadata area index to a chunk index.
267 */
268static chunk_t area_location(struct pstore *ps, chunk_t area)
269{
Tomohiro Kusumi87c961c2010-08-12 04:13:59 +0100270 return NUM_SNAPSHOT_HDR_CHUNKS + ((ps->exceptions_per_area + 1) * area);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000271}
272
Mikulas Patockae9c6a182013-10-16 03:17:47 +0100273static void skip_metadata(struct pstore *ps)
274{
275 uint32_t stride = ps->exceptions_per_area + 1;
276 chunk_t next_free = ps->next_free;
277 if (sector_div(next_free, stride) == NUM_SNAPSHOT_HDR_CHUNKS)
278 ps->next_free++;
279}
280
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000281/*
282 * Read or write a metadata area. Remembering to skip the first
283 * chunk which holds the header.
284 */
Mike Christiee6047142016-06-05 14:32:04 -0500285static int area_io(struct pstore *ps, int op, int op_flags)
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000286{
287 int r;
288 chunk_t chunk;
289
290 chunk = area_location(ps, ps->current_area);
291
Mike Christiee6047142016-06-05 14:32:04 -0500292 r = chunk_io(ps, ps->area, chunk, op, op_flags, 0);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000293 if (r)
294 return r;
295
296 return 0;
297}
298
299static void zero_memory_area(struct pstore *ps)
300{
Jonathan Brassow71fab002009-04-02 19:55:33 +0100301 memset(ps->area, 0, ps->store->chunk_size << SECTOR_SHIFT);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000302}
303
304static int zero_disk_area(struct pstore *ps, chunk_t area)
305{
Mike Christiee6047142016-06-05 14:32:04 -0500306 return chunk_io(ps, ps->zero_area, area_location(ps, area),
307 REQ_OP_WRITE, 0, 0);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000308}
309
310static int read_header(struct pstore *ps, int *new_snapshot)
311{
312 int r;
313 struct disk_header *dh;
Mikulas Patockadf96eee2009-10-16 23:18:17 +0100314 unsigned chunk_size;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000315 int chunk_size_supplied = 1;
Mikulas Patockaae0b7442009-09-04 20:40:43 +0100316 char *chunk_err;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000317
318 /*
Mikulas Patockadf96eee2009-10-16 23:18:17 +0100319 * Use default chunk size (or logical_block_size, if larger)
320 * if none supplied
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000321 */
Jonathan Brassow71fab002009-04-02 19:55:33 +0100322 if (!ps->store->chunk_size) {
323 ps->store->chunk_size = max(DM_CHUNK_SIZE_DEFAULT_SECTORS,
Mike Snitzerfc56f6f2009-12-10 23:52:12 +0000324 bdev_logical_block_size(dm_snap_cow(ps->store->snap)->
325 bdev) >> 9);
Jonathan Brassow71fab002009-04-02 19:55:33 +0100326 ps->store->chunk_mask = ps->store->chunk_size - 1;
Mikulas Patockaa3d939a2015-10-02 11:21:24 -0400327 ps->store->chunk_shift = __ffs(ps->store->chunk_size);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000328 chunk_size_supplied = 0;
329 }
330
Mikulas Patockabda8efe2011-05-29 13:03:09 +0100331 ps->io_client = dm_io_client_create();
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000332 if (IS_ERR(ps->io_client))
333 return PTR_ERR(ps->io_client);
334
335 r = alloc_area(ps);
336 if (r)
337 return r;
338
Mike Christiee6047142016-06-05 14:32:04 -0500339 r = chunk_io(ps, ps->header_area, 0, REQ_OP_READ, 0, 1);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000340 if (r)
341 goto bad;
342
Mikulas Patocka61578dc2009-09-04 20:40:39 +0100343 dh = ps->header_area;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000344
345 if (le32_to_cpu(dh->magic) == 0) {
346 *new_snapshot = 1;
347 return 0;
348 }
349
350 if (le32_to_cpu(dh->magic) != SNAP_MAGIC) {
351 DMWARN("Invalid or corrupt snapshot");
352 r = -ENXIO;
353 goto bad;
354 }
355
356 *new_snapshot = 0;
357 ps->valid = le32_to_cpu(dh->valid);
358 ps->version = le32_to_cpu(dh->version);
359 chunk_size = le32_to_cpu(dh->chunk_size);
360
Mikulas Patockaae0b7442009-09-04 20:40:43 +0100361 if (ps->store->chunk_size == chunk_size)
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000362 return 0;
363
Mikulas Patockaae0b7442009-09-04 20:40:43 +0100364 if (chunk_size_supplied)
Mikulas Patockadf96eee2009-10-16 23:18:17 +0100365 DMWARN("chunk size %u in device metadata overrides "
366 "table chunk size of %u.",
367 chunk_size, ps->store->chunk_size);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000368
369 /* We had a bogus chunk_size. Fix stuff up. */
370 free_area(ps);
371
Mikulas Patockaae0b7442009-09-04 20:40:43 +0100372 r = dm_exception_store_set_chunk_size(ps->store, chunk_size,
373 &chunk_err);
374 if (r) {
Mikulas Patockadf96eee2009-10-16 23:18:17 +0100375 DMERR("invalid on-disk chunk size %u: %s.",
376 chunk_size, chunk_err);
Mikulas Patockaae0b7442009-09-04 20:40:43 +0100377 return r;
378 }
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000379
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000380 r = alloc_area(ps);
381 return r;
382
383bad:
384 free_area(ps);
385 return r;
386}
387
388static int write_header(struct pstore *ps)
389{
390 struct disk_header *dh;
391
Mikulas Patocka61578dc2009-09-04 20:40:39 +0100392 memset(ps->header_area, 0, ps->store->chunk_size << SECTOR_SHIFT);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000393
Mikulas Patocka61578dc2009-09-04 20:40:39 +0100394 dh = ps->header_area;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000395 dh->magic = cpu_to_le32(SNAP_MAGIC);
396 dh->valid = cpu_to_le32(ps->valid);
397 dh->version = cpu_to_le32(ps->version);
Jonathan Brassow71fab002009-04-02 19:55:33 +0100398 dh->chunk_size = cpu_to_le32(ps->store->chunk_size);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000399
Mike Christiee6047142016-06-05 14:32:04 -0500400 return chunk_io(ps, ps->header_area, 0, REQ_OP_WRITE, 0, 1);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000401}
402
403/*
404 * Access functions for the disk exceptions, these do the endian conversions.
405 */
Mikulas Patocka2cadabd2014-01-13 19:14:04 -0500406static struct disk_exception *get_exception(struct pstore *ps, void *ps_area,
407 uint32_t index)
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000408{
409 BUG_ON(index >= ps->exceptions_per_area);
410
Mikulas Patocka2cadabd2014-01-13 19:14:04 -0500411 return ((struct disk_exception *) ps_area) + index;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000412}
413
Mikulas Patocka2cadabd2014-01-13 19:14:04 -0500414static void read_exception(struct pstore *ps, void *ps_area,
Alasdair G Kergon283a8322011-08-02 12:32:01 +0100415 uint32_t index, struct core_exception *result)
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000416{
Mikulas Patocka2cadabd2014-01-13 19:14:04 -0500417 struct disk_exception *de = get_exception(ps, ps_area, index);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000418
419 /* copy it */
Alasdair G Kergon283a8322011-08-02 12:32:01 +0100420 result->old_chunk = le64_to_cpu(de->old_chunk);
421 result->new_chunk = le64_to_cpu(de->new_chunk);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000422}
423
424static void write_exception(struct pstore *ps,
Alasdair G Kergon283a8322011-08-02 12:32:01 +0100425 uint32_t index, struct core_exception *e)
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000426{
Mikulas Patocka2cadabd2014-01-13 19:14:04 -0500427 struct disk_exception *de = get_exception(ps, ps->area, index);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000428
429 /* copy it */
Alasdair G Kergon283a8322011-08-02 12:32:01 +0100430 de->old_chunk = cpu_to_le64(e->old_chunk);
431 de->new_chunk = cpu_to_le64(e->new_chunk);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000432}
433
Mikulas Patocka4454a622009-12-10 23:52:29 +0000434static void clear_exception(struct pstore *ps, uint32_t index)
435{
Mikulas Patocka2cadabd2014-01-13 19:14:04 -0500436 struct disk_exception *de = get_exception(ps, ps->area, index);
Mikulas Patocka4454a622009-12-10 23:52:29 +0000437
438 /* clear it */
Alasdair G Kergon283a8322011-08-02 12:32:01 +0100439 de->old_chunk = 0;
440 de->new_chunk = 0;
Mikulas Patocka4454a622009-12-10 23:52:29 +0000441}
442
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000443/*
444 * Registers the exceptions that are present in the current area.
445 * 'full' is filled in to indicate if the area has been
446 * filled.
447 */
Mikulas Patocka2cadabd2014-01-13 19:14:04 -0500448static int insert_exceptions(struct pstore *ps, void *ps_area,
Jonathan Brassowa159c1a2009-01-06 03:05:19 +0000449 int (*callback)(void *callback_context,
450 chunk_t old, chunk_t new),
451 void *callback_context,
452 int *full)
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000453{
454 int r;
455 unsigned int i;
Alasdair G Kergon283a8322011-08-02 12:32:01 +0100456 struct core_exception e;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000457
458 /* presume the area is full */
459 *full = 1;
460
461 for (i = 0; i < ps->exceptions_per_area; i++) {
Mikulas Patocka2cadabd2014-01-13 19:14:04 -0500462 read_exception(ps, ps_area, i, &e);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000463
464 /*
465 * If the new_chunk is pointing at the start of
466 * the COW device, where the first metadata area
467 * is we know that we've hit the end of the
468 * exceptions. Therefore the area is not full.
469 */
Alasdair G Kergon283a8322011-08-02 12:32:01 +0100470 if (e.new_chunk == 0LL) {
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000471 ps->current_committed = i;
472 *full = 0;
473 break;
474 }
475
476 /*
477 * Keep track of the start of the free chunks.
478 */
Alasdair G Kergon283a8322011-08-02 12:32:01 +0100479 if (ps->next_free <= e.new_chunk)
480 ps->next_free = e.new_chunk + 1;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000481
482 /*
483 * Otherwise we add the exception to the snapshot.
484 */
Alasdair G Kergon283a8322011-08-02 12:32:01 +0100485 r = callback(callback_context, e.old_chunk, e.new_chunk);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000486 if (r)
487 return r;
488 }
489
490 return 0;
491}
492
Jonathan Brassowa159c1a2009-01-06 03:05:19 +0000493static int read_exceptions(struct pstore *ps,
494 int (*callback)(void *callback_context, chunk_t old,
495 chunk_t new),
496 void *callback_context)
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000497{
498 int r, full = 1;
Mikulas Patocka55494bf2014-01-13 19:12:36 -0500499 struct dm_bufio_client *client;
Mikulas Patocka55b082e2014-01-13 19:13:05 -0500500 chunk_t prefetch_area = 0;
Mikulas Patocka55494bf2014-01-13 19:12:36 -0500501
502 client = dm_bufio_client_create(dm_snap_cow(ps->store->snap)->bdev,
503 ps->store->chunk_size << SECTOR_SHIFT,
504 1, 0, NULL, NULL);
505
506 if (IS_ERR(client))
507 return PTR_ERR(client);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000508
509 /*
Mikulas Patocka55b082e2014-01-13 19:13:05 -0500510 * Setup for one current buffer + desired readahead buffers.
511 */
512 dm_bufio_set_minimum_buffers(client, 1 + DM_PREFETCH_CHUNKS);
513
514 /*
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000515 * Keeping reading chunks and inserting exceptions until
516 * we find a partially full area.
517 */
518 for (ps->current_area = 0; full; ps->current_area++) {
Mikulas Patocka55494bf2014-01-13 19:12:36 -0500519 struct dm_buffer *bp;
520 void *area;
Mikulas Patocka55b082e2014-01-13 19:13:05 -0500521 chunk_t chunk;
522
523 if (unlikely(prefetch_area < ps->current_area))
524 prefetch_area = ps->current_area;
525
526 if (DM_PREFETCH_CHUNKS) do {
527 chunk_t pf_chunk = area_location(ps, prefetch_area);
528 if (unlikely(pf_chunk >= dm_bufio_get_device_size(client)))
529 break;
530 dm_bufio_prefetch(client, pf_chunk, 1);
531 prefetch_area++;
532 if (unlikely(!prefetch_area))
533 break;
534 } while (prefetch_area <= ps->current_area + DM_PREFETCH_CHUNKS);
535
536 chunk = area_location(ps, ps->current_area);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000537
Mikulas Patocka55494bf2014-01-13 19:12:36 -0500538 area = dm_bufio_read(client, chunk, &bp);
viresh kumarfc0a4462015-08-10 11:42:26 +0530539 if (IS_ERR(area)) {
Mikulas Patocka55494bf2014-01-13 19:12:36 -0500540 r = PTR_ERR(area);
541 goto ret_destroy_bufio;
542 }
543
544 r = insert_exceptions(ps, area, callback, callback_context,
Mikulas Patocka2cadabd2014-01-13 19:14:04 -0500545 &full);
Mikulas Patocka55494bf2014-01-13 19:12:36 -0500546
Mikulas Patocka2c945822014-03-03 17:19:22 -0500547 if (!full)
548 memcpy(ps->area, area, ps->store->chunk_size << SECTOR_SHIFT);
549
Mikulas Patocka55494bf2014-01-13 19:12:36 -0500550 dm_bufio_release(bp);
551
552 dm_bufio_forget(client, chunk);
553
554 if (unlikely(r))
555 goto ret_destroy_bufio;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000556 }
557
558 ps->current_area--;
559
Mikulas Patockae9c6a182013-10-16 03:17:47 +0100560 skip_metadata(ps);
561
Mikulas Patocka55494bf2014-01-13 19:12:36 -0500562 r = 0;
563
564ret_destroy_bufio:
565 dm_bufio_client_destroy(client);
566
567 return r;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000568}
569
570static struct pstore *get_info(struct dm_exception_store *store)
571{
572 return (struct pstore *) store->context;
573}
574
Mike Snitzer985903b2009-12-10 23:52:11 +0000575static void persistent_usage(struct dm_exception_store *store,
576 sector_t *total_sectors,
577 sector_t *sectors_allocated,
578 sector_t *metadata_sectors)
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000579{
Mike Snitzer985903b2009-12-10 23:52:11 +0000580 struct pstore *ps = get_info(store);
581
582 *sectors_allocated = ps->next_free * store->chunk_size;
Mike Snitzerfc56f6f2009-12-10 23:52:12 +0000583 *total_sectors = get_dev_size(dm_snap_cow(store->snap)->bdev);
Mike Snitzer985903b2009-12-10 23:52:11 +0000584
585 /*
586 * First chunk is the fixed header.
587 * Then there are (ps->current_area + 1) metadata chunks, each one
588 * separated from the next by ps->exceptions_per_area data chunks.
589 */
Mikulas Patocka4454a622009-12-10 23:52:29 +0000590 *metadata_sectors = (ps->current_area + 1 + NUM_SNAPSHOT_HDR_CHUNKS) *
591 store->chunk_size;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000592}
593
Jonathan Brassow493df712009-04-02 19:55:31 +0100594static void persistent_dtr(struct dm_exception_store *store)
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000595{
596 struct pstore *ps = get_info(store);
597
598 destroy_workqueue(ps->metadata_wq);
Jonathan Brassowa32079c2009-04-02 19:55:35 +0100599
600 /* Created in read_header */
601 if (ps->io_client)
602 dm_io_client_destroy(ps->io_client);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000603 free_area(ps);
Jonathan Brassowa32079c2009-04-02 19:55:35 +0100604
605 /* Allocated in persistent_read_metadata */
Markus Elfring0c8f8632015-02-02 14:38:29 +0100606 vfree(ps->callbacks);
Jonathan Brassowa32079c2009-04-02 19:55:35 +0100607
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000608 kfree(ps);
609}
610
Jonathan Brassowa159c1a2009-01-06 03:05:19 +0000611static int persistent_read_metadata(struct dm_exception_store *store,
612 int (*callback)(void *callback_context,
613 chunk_t old, chunk_t new),
614 void *callback_context)
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000615{
616 int r, uninitialized_var(new_snapshot);
617 struct pstore *ps = get_info(store);
618
619 /*
620 * Read the snapshot header.
621 */
622 r = read_header(ps, &new_snapshot);
623 if (r)
624 return r;
625
626 /*
627 * Now we know correct chunk_size, complete the initialisation.
628 */
Jonathan Brassow71fab002009-04-02 19:55:33 +0100629 ps->exceptions_per_area = (ps->store->chunk_size << SECTOR_SHIFT) /
630 sizeof(struct disk_exception);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000631 ps->callbacks = dm_vcalloc(ps->exceptions_per_area,
Jonathan Brassowa2d2b032011-08-02 12:32:03 +0100632 sizeof(*ps->callbacks));
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000633 if (!ps->callbacks)
634 return -ENOMEM;
635
636 /*
637 * Do we need to setup a new snapshot ?
638 */
639 if (new_snapshot) {
640 r = write_header(ps);
641 if (r) {
642 DMWARN("write_header failed");
643 return r;
644 }
645
646 ps->current_area = 0;
647 zero_memory_area(ps);
648 r = zero_disk_area(ps, 0);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000649 if (r)
Jon Brassowf5acc832009-12-10 23:52:07 +0000650 DMWARN("zero_disk_area(0) failed");
651 return r;
652 }
653 /*
654 * Sanity checks.
655 */
656 if (ps->version != SNAPSHOT_DISK_VERSION) {
657 DMWARN("unable to handle snapshot disk version %d",
658 ps->version);
659 return -EINVAL;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000660 }
661
Jon Brassowf5acc832009-12-10 23:52:07 +0000662 /*
663 * Metadata are valid, but snapshot is invalidated
664 */
665 if (!ps->valid)
666 return 1;
667
668 /*
669 * Read the metadata.
670 */
671 r = read_exceptions(ps, callback, callback_context);
672
673 return r;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000674}
675
Jonathan Brassowa159c1a2009-01-06 03:05:19 +0000676static int persistent_prepare_exception(struct dm_exception_store *store,
Jon Brassow1d4989c2009-12-10 23:52:10 +0000677 struct dm_exception *e)
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000678{
679 struct pstore *ps = get_info(store);
Mike Snitzerfc56f6f2009-12-10 23:52:12 +0000680 sector_t size = get_dev_size(dm_snap_cow(store->snap)->bdev);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000681
682 /* Is there enough room ? */
Jonathan Brassowd0216842009-04-02 19:55:32 +0100683 if (size < ((ps->next_free + 1) * store->chunk_size))
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000684 return -ENOSPC;
685
686 e->new_chunk = ps->next_free;
687
688 /*
689 * Move onto the next free pending, making sure to take
690 * into account the location of the metadata chunks.
691 */
Mikulas Patockae9c6a182013-10-16 03:17:47 +0100692 ps->next_free++;
693 skip_metadata(ps);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000694
695 atomic_inc(&ps->pending_count);
696 return 0;
697}
698
Jonathan Brassowa159c1a2009-01-06 03:05:19 +0000699static void persistent_commit_exception(struct dm_exception_store *store,
Mikulas Patocka385277b2016-01-08 19:07:55 -0500700 struct dm_exception *e, int valid,
Jonathan Brassowa159c1a2009-01-06 03:05:19 +0000701 void (*callback) (void *, int success),
702 void *callback_context)
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000703{
704 unsigned int i;
705 struct pstore *ps = get_info(store);
Alasdair G Kergon283a8322011-08-02 12:32:01 +0100706 struct core_exception ce;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000707 struct commit_callback *cb;
708
Mikulas Patocka385277b2016-01-08 19:07:55 -0500709 if (!valid)
710 ps->valid = 0;
711
Alasdair G Kergon283a8322011-08-02 12:32:01 +0100712 ce.old_chunk = e->old_chunk;
713 ce.new_chunk = e->new_chunk;
714 write_exception(ps, ps->current_committed++, &ce);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000715
716 /*
717 * Add the callback to the back of the array. This code
718 * is the only place where the callback array is
719 * manipulated, and we know that it will never be called
720 * multiple times concurrently.
721 */
722 cb = ps->callbacks + ps->callback_count++;
723 cb->callback = callback;
724 cb->context = callback_context;
725
726 /*
727 * If there are exceptions in flight and we have not yet
728 * filled this metadata area there's nothing more to do.
729 */
730 if (!atomic_dec_and_test(&ps->pending_count) &&
731 (ps->current_committed != ps->exceptions_per_area))
732 return;
733
734 /*
735 * If we completely filled the current area, then wipe the next one.
736 */
737 if ((ps->current_committed == ps->exceptions_per_area) &&
Jonathan Brassowa2d2b032011-08-02 12:32:03 +0100738 zero_disk_area(ps, ps->current_area + 1))
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000739 ps->valid = 0;
740
741 /*
742 * Commit exceptions to disk.
743 */
Mike Christiee6047142016-06-05 14:32:04 -0500744 if (ps->valid && area_io(ps, REQ_OP_WRITE, WRITE_FLUSH_FUA))
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000745 ps->valid = 0;
746
747 /*
748 * Advance to the next area if this one is full.
749 */
750 if (ps->current_committed == ps->exceptions_per_area) {
751 ps->current_committed = 0;
752 ps->current_area++;
753 zero_memory_area(ps);
754 }
755
756 for (i = 0; i < ps->callback_count; i++) {
757 cb = ps->callbacks + i;
758 cb->callback(cb->context, ps->valid);
759 }
760
761 ps->callback_count = 0;
762}
763
Mikulas Patocka4454a622009-12-10 23:52:29 +0000764static int persistent_prepare_merge(struct dm_exception_store *store,
765 chunk_t *last_old_chunk,
766 chunk_t *last_new_chunk)
767{
768 struct pstore *ps = get_info(store);
Alasdair G Kergon283a8322011-08-02 12:32:01 +0100769 struct core_exception ce;
Mikulas Patocka4454a622009-12-10 23:52:29 +0000770 int nr_consecutive;
771 int r;
772
773 /*
774 * When current area is empty, move back to preceding area.
775 */
776 if (!ps->current_committed) {
777 /*
778 * Have we finished?
779 */
780 if (!ps->current_area)
781 return 0;
782
783 ps->current_area--;
Mike Christiee6047142016-06-05 14:32:04 -0500784 r = area_io(ps, REQ_OP_READ, 0);
Mikulas Patocka4454a622009-12-10 23:52:29 +0000785 if (r < 0)
786 return r;
787 ps->current_committed = ps->exceptions_per_area;
788 }
789
Mikulas Patocka2cadabd2014-01-13 19:14:04 -0500790 read_exception(ps, ps->area, ps->current_committed - 1, &ce);
Alasdair G Kergon283a8322011-08-02 12:32:01 +0100791 *last_old_chunk = ce.old_chunk;
792 *last_new_chunk = ce.new_chunk;
Mikulas Patocka4454a622009-12-10 23:52:29 +0000793
794 /*
795 * Find number of consecutive chunks within the current area,
796 * working backwards.
797 */
798 for (nr_consecutive = 1; nr_consecutive < ps->current_committed;
799 nr_consecutive++) {
Mikulas Patocka2cadabd2014-01-13 19:14:04 -0500800 read_exception(ps, ps->area,
801 ps->current_committed - 1 - nr_consecutive, &ce);
Alasdair G Kergon283a8322011-08-02 12:32:01 +0100802 if (ce.old_chunk != *last_old_chunk - nr_consecutive ||
803 ce.new_chunk != *last_new_chunk - nr_consecutive)
Mikulas Patocka4454a622009-12-10 23:52:29 +0000804 break;
805 }
806
807 return nr_consecutive;
808}
809
810static int persistent_commit_merge(struct dm_exception_store *store,
811 int nr_merged)
812{
813 int r, i;
814 struct pstore *ps = get_info(store);
815
816 BUG_ON(nr_merged > ps->current_committed);
817
818 for (i = 0; i < nr_merged; i++)
819 clear_exception(ps, ps->current_committed - 1 - i);
820
Mike Christiee6047142016-06-05 14:32:04 -0500821 r = area_io(ps, REQ_OP_WRITE, WRITE_FLUSH_FUA);
Mikulas Patocka4454a622009-12-10 23:52:29 +0000822 if (r < 0)
823 return r;
824
825 ps->current_committed -= nr_merged;
826
827 /*
828 * At this stage, only persistent_usage() uses ps->next_free, so
829 * we make no attempt to keep ps->next_free strictly accurate
830 * as exceptions may have been committed out-of-order originally.
831 * Once a snapshot has become merging, we set it to the value it
832 * would have held had all the exceptions been committed in order.
833 *
834 * ps->current_area does not get reduced by prepare_merge() until
835 * after commit_merge() has removed the nr_merged previous exceptions.
836 */
Tomohiro Kusumi87c961c2010-08-12 04:13:59 +0100837 ps->next_free = area_location(ps, ps->current_area) +
838 ps->current_committed + 1;
Mikulas Patocka4454a622009-12-10 23:52:29 +0000839
840 return 0;
841}
842
Jonathan Brassowa159c1a2009-01-06 03:05:19 +0000843static void persistent_drop_snapshot(struct dm_exception_store *store)
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000844{
845 struct pstore *ps = get_info(store);
846
847 ps->valid = 0;
848 if (write_header(ps))
849 DMWARN("write header failed");
850}
851
Mike Snitzerb0d3cc02015-10-08 18:05:41 -0400852static int persistent_ctr(struct dm_exception_store *store, char *options)
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000853{
854 struct pstore *ps;
Sudip Mukherjeea2a678e2015-10-13 13:33:08 +0530855 int r;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000856
857 /* allocate the pstore */
Jonathan Brassowa32079c2009-04-02 19:55:35 +0100858 ps = kzalloc(sizeof(*ps), GFP_KERNEL);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000859 if (!ps)
860 return -ENOMEM;
861
Jonathan Brassow71fab002009-04-02 19:55:33 +0100862 ps->store = store;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000863 ps->valid = 1;
864 ps->version = SNAPSHOT_DISK_VERSION;
865 ps->area = NULL;
Mikulas Patocka61578dc2009-09-04 20:40:39 +0100866 ps->zero_area = NULL;
867 ps->header_area = NULL;
Mikulas Patocka4454a622009-12-10 23:52:29 +0000868 ps->next_free = NUM_SNAPSHOT_HDR_CHUNKS + 1; /* header and 1st area */
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000869 ps->current_committed = 0;
870
871 ps->callback_count = 0;
872 atomic_set(&ps->pending_count, 0);
873 ps->callbacks = NULL;
874
Tejun Heo239c8dd2011-01-13 19:59:59 +0000875 ps->metadata_wq = alloc_workqueue("ksnaphd", WQ_MEM_RECLAIM, 0);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000876 if (!ps->metadata_wq) {
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000877 DMERR("couldn't start header metadata update thread");
Sudip Mukherjeea2a678e2015-10-13 13:33:08 +0530878 r = -ENOMEM;
879 goto err_workqueue;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000880 }
881
Mike Snitzerb0d3cc02015-10-08 18:05:41 -0400882 if (options) {
883 char overflow = toupper(options[0]);
884 if (overflow == 'O')
885 store->userspace_supports_overflow = true;
886 else {
887 DMERR("Unsupported persistent store option: %s", options);
Sudip Mukherjeea2a678e2015-10-13 13:33:08 +0530888 r = -EINVAL;
889 goto err_options;
Mike Snitzerb0d3cc02015-10-08 18:05:41 -0400890 }
891 }
892
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000893 store->context = ps;
894
895 return 0;
Sudip Mukherjeea2a678e2015-10-13 13:33:08 +0530896
897err_options:
898 destroy_workqueue(ps->metadata_wq);
899err_workqueue:
900 kfree(ps);
901
902 return r;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000903}
904
Jonathan Brassow1e302a92009-04-02 19:55:35 +0100905static unsigned persistent_status(struct dm_exception_store *store,
906 status_type_t status, char *result,
907 unsigned maxlen)
Jonathan Brassow493df712009-04-02 19:55:31 +0100908{
Jonathan Brassow1e302a92009-04-02 19:55:35 +0100909 unsigned sz = 0;
910
911 switch (status) {
912 case STATUSTYPE_INFO:
913 break;
914 case STATUSTYPE_TABLE:
Mike Snitzerb0d3cc02015-10-08 18:05:41 -0400915 DMEMIT(" %s %llu", store->userspace_supports_overflow ? "PO" : "P",
916 (unsigned long long)store->chunk_size);
Jonathan Brassow1e302a92009-04-02 19:55:35 +0100917 }
Jonathan Brassow493df712009-04-02 19:55:31 +0100918
919 return sz;
920}
921
922static struct dm_exception_store_type _persistent_type = {
923 .name = "persistent",
924 .module = THIS_MODULE,
925 .ctr = persistent_ctr,
926 .dtr = persistent_dtr,
927 .read_metadata = persistent_read_metadata,
928 .prepare_exception = persistent_prepare_exception,
929 .commit_exception = persistent_commit_exception,
Mikulas Patocka4454a622009-12-10 23:52:29 +0000930 .prepare_merge = persistent_prepare_merge,
931 .commit_merge = persistent_commit_merge,
Jonathan Brassow493df712009-04-02 19:55:31 +0100932 .drop_snapshot = persistent_drop_snapshot,
Mike Snitzer985903b2009-12-10 23:52:11 +0000933 .usage = persistent_usage,
Jonathan Brassow493df712009-04-02 19:55:31 +0100934 .status = persistent_status,
935};
936
937static struct dm_exception_store_type _persistent_compat_type = {
938 .name = "P",
939 .module = THIS_MODULE,
940 .ctr = persistent_ctr,
941 .dtr = persistent_dtr,
942 .read_metadata = persistent_read_metadata,
943 .prepare_exception = persistent_prepare_exception,
944 .commit_exception = persistent_commit_exception,
Mikulas Patocka4454a622009-12-10 23:52:29 +0000945 .prepare_merge = persistent_prepare_merge,
946 .commit_merge = persistent_commit_merge,
Jonathan Brassow493df712009-04-02 19:55:31 +0100947 .drop_snapshot = persistent_drop_snapshot,
Mike Snitzer985903b2009-12-10 23:52:11 +0000948 .usage = persistent_usage,
Jonathan Brassow493df712009-04-02 19:55:31 +0100949 .status = persistent_status,
950};
951
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000952int dm_persistent_snapshot_init(void)
953{
Jonathan Brassow493df712009-04-02 19:55:31 +0100954 int r;
955
956 r = dm_exception_store_type_register(&_persistent_type);
957 if (r) {
958 DMERR("Unable to register persistent exception store type");
959 return r;
960 }
961
962 r = dm_exception_store_type_register(&_persistent_compat_type);
963 if (r) {
964 DMERR("Unable to register old-style persistent exception "
965 "store type");
966 dm_exception_store_type_unregister(&_persistent_type);
967 return r;
968 }
969
970 return r;
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000971}
972
973void dm_persistent_snapshot_exit(void)
974{
Jonathan Brassow493df712009-04-02 19:55:31 +0100975 dm_exception_store_type_unregister(&_persistent_type);
976 dm_exception_store_type_unregister(&_persistent_compat_type);
Alasdair G Kergon4db6bfe2009-01-06 03:05:17 +0000977}