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