xref: /OK3568_Linux_fs/kernel/drivers/md/persistent-data/dm-btree-spine.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright (C) 2011 Red Hat, Inc.
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * This file is released under the GPL.
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #include "dm-btree-internal.h"
8*4882a593Smuzhiyun #include "dm-transaction-manager.h"
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #include <linux/device-mapper.h>
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun #define DM_MSG_PREFIX "btree spine"
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun /*----------------------------------------------------------------*/
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun #define BTREE_CSUM_XOR 121107
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun static int node_check(struct dm_block_validator *v,
19*4882a593Smuzhiyun 		      struct dm_block *b,
20*4882a593Smuzhiyun 		      size_t block_size);
21*4882a593Smuzhiyun 
node_prepare_for_write(struct dm_block_validator * v,struct dm_block * b,size_t block_size)22*4882a593Smuzhiyun static void node_prepare_for_write(struct dm_block_validator *v,
23*4882a593Smuzhiyun 				   struct dm_block *b,
24*4882a593Smuzhiyun 				   size_t block_size)
25*4882a593Smuzhiyun {
26*4882a593Smuzhiyun 	struct btree_node *n = dm_block_data(b);
27*4882a593Smuzhiyun 	struct node_header *h = &n->header;
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun 	h->blocknr = cpu_to_le64(dm_block_location(b));
30*4882a593Smuzhiyun 	h->csum = cpu_to_le32(dm_bm_checksum(&h->flags,
31*4882a593Smuzhiyun 					     block_size - sizeof(__le32),
32*4882a593Smuzhiyun 					     BTREE_CSUM_XOR));
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun 	BUG_ON(node_check(v, b, 4096));
35*4882a593Smuzhiyun }
36*4882a593Smuzhiyun 
node_check(struct dm_block_validator * v,struct dm_block * b,size_t block_size)37*4882a593Smuzhiyun static int node_check(struct dm_block_validator *v,
38*4882a593Smuzhiyun 		      struct dm_block *b,
39*4882a593Smuzhiyun 		      size_t block_size)
40*4882a593Smuzhiyun {
41*4882a593Smuzhiyun 	struct btree_node *n = dm_block_data(b);
42*4882a593Smuzhiyun 	struct node_header *h = &n->header;
43*4882a593Smuzhiyun 	size_t value_size;
44*4882a593Smuzhiyun 	__le32 csum_disk;
45*4882a593Smuzhiyun 	uint32_t flags;
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun 	if (dm_block_location(b) != le64_to_cpu(h->blocknr)) {
48*4882a593Smuzhiyun 		DMERR_LIMIT("node_check failed: blocknr %llu != wanted %llu",
49*4882a593Smuzhiyun 			    le64_to_cpu(h->blocknr), dm_block_location(b));
50*4882a593Smuzhiyun 		return -ENOTBLK;
51*4882a593Smuzhiyun 	}
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun 	csum_disk = cpu_to_le32(dm_bm_checksum(&h->flags,
54*4882a593Smuzhiyun 					       block_size - sizeof(__le32),
55*4882a593Smuzhiyun 					       BTREE_CSUM_XOR));
56*4882a593Smuzhiyun 	if (csum_disk != h->csum) {
57*4882a593Smuzhiyun 		DMERR_LIMIT("node_check failed: csum %u != wanted %u",
58*4882a593Smuzhiyun 			    le32_to_cpu(csum_disk), le32_to_cpu(h->csum));
59*4882a593Smuzhiyun 		return -EILSEQ;
60*4882a593Smuzhiyun 	}
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun 	value_size = le32_to_cpu(h->value_size);
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun 	if (sizeof(struct node_header) +
65*4882a593Smuzhiyun 	    (sizeof(__le64) + value_size) * le32_to_cpu(h->max_entries) > block_size) {
66*4882a593Smuzhiyun 		DMERR_LIMIT("node_check failed: max_entries too large");
67*4882a593Smuzhiyun 		return -EILSEQ;
68*4882a593Smuzhiyun 	}
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun 	if (le32_to_cpu(h->nr_entries) > le32_to_cpu(h->max_entries)) {
71*4882a593Smuzhiyun 		DMERR_LIMIT("node_check failed: too many entries");
72*4882a593Smuzhiyun 		return -EILSEQ;
73*4882a593Smuzhiyun 	}
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun 	/*
76*4882a593Smuzhiyun 	 * The node must be either INTERNAL or LEAF.
77*4882a593Smuzhiyun 	 */
78*4882a593Smuzhiyun 	flags = le32_to_cpu(h->flags);
79*4882a593Smuzhiyun 	if (!(flags & INTERNAL_NODE) && !(flags & LEAF_NODE)) {
80*4882a593Smuzhiyun 		DMERR_LIMIT("node_check failed: node is neither INTERNAL or LEAF");
81*4882a593Smuzhiyun 		return -EILSEQ;
82*4882a593Smuzhiyun 	}
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun 	return 0;
85*4882a593Smuzhiyun }
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun struct dm_block_validator btree_node_validator = {
88*4882a593Smuzhiyun 	.name = "btree_node",
89*4882a593Smuzhiyun 	.prepare_for_write = node_prepare_for_write,
90*4882a593Smuzhiyun 	.check = node_check
91*4882a593Smuzhiyun };
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun /*----------------------------------------------------------------*/
94*4882a593Smuzhiyun 
bn_read_lock(struct dm_btree_info * info,dm_block_t b,struct dm_block ** result)95*4882a593Smuzhiyun int bn_read_lock(struct dm_btree_info *info, dm_block_t b,
96*4882a593Smuzhiyun 		 struct dm_block **result)
97*4882a593Smuzhiyun {
98*4882a593Smuzhiyun 	return dm_tm_read_lock(info->tm, b, &btree_node_validator, result);
99*4882a593Smuzhiyun }
100*4882a593Smuzhiyun 
bn_shadow(struct dm_btree_info * info,dm_block_t orig,struct dm_btree_value_type * vt,struct dm_block ** result)101*4882a593Smuzhiyun static int bn_shadow(struct dm_btree_info *info, dm_block_t orig,
102*4882a593Smuzhiyun 	      struct dm_btree_value_type *vt,
103*4882a593Smuzhiyun 	      struct dm_block **result)
104*4882a593Smuzhiyun {
105*4882a593Smuzhiyun 	int r, inc;
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun 	r = dm_tm_shadow_block(info->tm, orig, &btree_node_validator,
108*4882a593Smuzhiyun 			       result, &inc);
109*4882a593Smuzhiyun 	if (!r && inc)
110*4882a593Smuzhiyun 		inc_children(info->tm, dm_block_data(*result), vt);
111*4882a593Smuzhiyun 
112*4882a593Smuzhiyun 	return r;
113*4882a593Smuzhiyun }
114*4882a593Smuzhiyun 
new_block(struct dm_btree_info * info,struct dm_block ** result)115*4882a593Smuzhiyun int new_block(struct dm_btree_info *info, struct dm_block **result)
116*4882a593Smuzhiyun {
117*4882a593Smuzhiyun 	return dm_tm_new_block(info->tm, &btree_node_validator, result);
118*4882a593Smuzhiyun }
119*4882a593Smuzhiyun 
unlock_block(struct dm_btree_info * info,struct dm_block * b)120*4882a593Smuzhiyun void unlock_block(struct dm_btree_info *info, struct dm_block *b)
121*4882a593Smuzhiyun {
122*4882a593Smuzhiyun 	dm_tm_unlock(info->tm, b);
123*4882a593Smuzhiyun }
124*4882a593Smuzhiyun 
125*4882a593Smuzhiyun /*----------------------------------------------------------------*/
126*4882a593Smuzhiyun 
init_ro_spine(struct ro_spine * s,struct dm_btree_info * info)127*4882a593Smuzhiyun void init_ro_spine(struct ro_spine *s, struct dm_btree_info *info)
128*4882a593Smuzhiyun {
129*4882a593Smuzhiyun 	s->info = info;
130*4882a593Smuzhiyun 	s->count = 0;
131*4882a593Smuzhiyun 	s->nodes[0] = NULL;
132*4882a593Smuzhiyun 	s->nodes[1] = NULL;
133*4882a593Smuzhiyun }
134*4882a593Smuzhiyun 
exit_ro_spine(struct ro_spine * s)135*4882a593Smuzhiyun void exit_ro_spine(struct ro_spine *s)
136*4882a593Smuzhiyun {
137*4882a593Smuzhiyun 	int i;
138*4882a593Smuzhiyun 
139*4882a593Smuzhiyun 	for (i = 0; i < s->count; i++) {
140*4882a593Smuzhiyun 		unlock_block(s->info, s->nodes[i]);
141*4882a593Smuzhiyun 	}
142*4882a593Smuzhiyun }
143*4882a593Smuzhiyun 
ro_step(struct ro_spine * s,dm_block_t new_child)144*4882a593Smuzhiyun int ro_step(struct ro_spine *s, dm_block_t new_child)
145*4882a593Smuzhiyun {
146*4882a593Smuzhiyun 	int r;
147*4882a593Smuzhiyun 
148*4882a593Smuzhiyun 	if (s->count == 2) {
149*4882a593Smuzhiyun 		unlock_block(s->info, s->nodes[0]);
150*4882a593Smuzhiyun 		s->nodes[0] = s->nodes[1];
151*4882a593Smuzhiyun 		s->count--;
152*4882a593Smuzhiyun 	}
153*4882a593Smuzhiyun 
154*4882a593Smuzhiyun 	r = bn_read_lock(s->info, new_child, s->nodes + s->count);
155*4882a593Smuzhiyun 	if (!r)
156*4882a593Smuzhiyun 		s->count++;
157*4882a593Smuzhiyun 
158*4882a593Smuzhiyun 	return r;
159*4882a593Smuzhiyun }
160*4882a593Smuzhiyun 
ro_pop(struct ro_spine * s)161*4882a593Smuzhiyun void ro_pop(struct ro_spine *s)
162*4882a593Smuzhiyun {
163*4882a593Smuzhiyun 	BUG_ON(!s->count);
164*4882a593Smuzhiyun 	--s->count;
165*4882a593Smuzhiyun 	unlock_block(s->info, s->nodes[s->count]);
166*4882a593Smuzhiyun }
167*4882a593Smuzhiyun 
ro_node(struct ro_spine * s)168*4882a593Smuzhiyun struct btree_node *ro_node(struct ro_spine *s)
169*4882a593Smuzhiyun {
170*4882a593Smuzhiyun 	struct dm_block *block;
171*4882a593Smuzhiyun 
172*4882a593Smuzhiyun 	BUG_ON(!s->count);
173*4882a593Smuzhiyun 	block = s->nodes[s->count - 1];
174*4882a593Smuzhiyun 
175*4882a593Smuzhiyun 	return dm_block_data(block);
176*4882a593Smuzhiyun }
177*4882a593Smuzhiyun 
178*4882a593Smuzhiyun /*----------------------------------------------------------------*/
179*4882a593Smuzhiyun 
init_shadow_spine(struct shadow_spine * s,struct dm_btree_info * info)180*4882a593Smuzhiyun void init_shadow_spine(struct shadow_spine *s, struct dm_btree_info *info)
181*4882a593Smuzhiyun {
182*4882a593Smuzhiyun 	s->info = info;
183*4882a593Smuzhiyun 	s->count = 0;
184*4882a593Smuzhiyun }
185*4882a593Smuzhiyun 
exit_shadow_spine(struct shadow_spine * s)186*4882a593Smuzhiyun int exit_shadow_spine(struct shadow_spine *s)
187*4882a593Smuzhiyun {
188*4882a593Smuzhiyun 	int r = 0, i;
189*4882a593Smuzhiyun 
190*4882a593Smuzhiyun 	for (i = 0; i < s->count; i++) {
191*4882a593Smuzhiyun 		unlock_block(s->info, s->nodes[i]);
192*4882a593Smuzhiyun 	}
193*4882a593Smuzhiyun 
194*4882a593Smuzhiyun 	return r;
195*4882a593Smuzhiyun }
196*4882a593Smuzhiyun 
shadow_step(struct shadow_spine * s,dm_block_t b,struct dm_btree_value_type * vt)197*4882a593Smuzhiyun int shadow_step(struct shadow_spine *s, dm_block_t b,
198*4882a593Smuzhiyun 		struct dm_btree_value_type *vt)
199*4882a593Smuzhiyun {
200*4882a593Smuzhiyun 	int r;
201*4882a593Smuzhiyun 
202*4882a593Smuzhiyun 	if (s->count == 2) {
203*4882a593Smuzhiyun 		unlock_block(s->info, s->nodes[0]);
204*4882a593Smuzhiyun 		s->nodes[0] = s->nodes[1];
205*4882a593Smuzhiyun 		s->count--;
206*4882a593Smuzhiyun 	}
207*4882a593Smuzhiyun 
208*4882a593Smuzhiyun 	r = bn_shadow(s->info, b, vt, s->nodes + s->count);
209*4882a593Smuzhiyun 	if (!r) {
210*4882a593Smuzhiyun 		if (!s->count)
211*4882a593Smuzhiyun 			s->root = dm_block_location(s->nodes[0]);
212*4882a593Smuzhiyun 
213*4882a593Smuzhiyun 		s->count++;
214*4882a593Smuzhiyun 	}
215*4882a593Smuzhiyun 
216*4882a593Smuzhiyun 	return r;
217*4882a593Smuzhiyun }
218*4882a593Smuzhiyun 
shadow_current(struct shadow_spine * s)219*4882a593Smuzhiyun struct dm_block *shadow_current(struct shadow_spine *s)
220*4882a593Smuzhiyun {
221*4882a593Smuzhiyun 	BUG_ON(!s->count);
222*4882a593Smuzhiyun 
223*4882a593Smuzhiyun 	return s->nodes[s->count - 1];
224*4882a593Smuzhiyun }
225*4882a593Smuzhiyun 
shadow_parent(struct shadow_spine * s)226*4882a593Smuzhiyun struct dm_block *shadow_parent(struct shadow_spine *s)
227*4882a593Smuzhiyun {
228*4882a593Smuzhiyun 	BUG_ON(s->count != 2);
229*4882a593Smuzhiyun 
230*4882a593Smuzhiyun 	return s->count == 2 ? s->nodes[0] : NULL;
231*4882a593Smuzhiyun }
232*4882a593Smuzhiyun 
shadow_has_parent(struct shadow_spine * s)233*4882a593Smuzhiyun int shadow_has_parent(struct shadow_spine *s)
234*4882a593Smuzhiyun {
235*4882a593Smuzhiyun 	return s->count >= 2;
236*4882a593Smuzhiyun }
237*4882a593Smuzhiyun 
shadow_root(struct shadow_spine * s)238*4882a593Smuzhiyun int shadow_root(struct shadow_spine *s)
239*4882a593Smuzhiyun {
240*4882a593Smuzhiyun 	return s->root;
241*4882a593Smuzhiyun }
242*4882a593Smuzhiyun 
le64_inc(void * context,const void * value_le)243*4882a593Smuzhiyun static void le64_inc(void *context, const void *value_le)
244*4882a593Smuzhiyun {
245*4882a593Smuzhiyun 	struct dm_transaction_manager *tm = context;
246*4882a593Smuzhiyun 	__le64 v_le;
247*4882a593Smuzhiyun 
248*4882a593Smuzhiyun 	memcpy(&v_le, value_le, sizeof(v_le));
249*4882a593Smuzhiyun 	dm_tm_inc(tm, le64_to_cpu(v_le));
250*4882a593Smuzhiyun }
251*4882a593Smuzhiyun 
le64_dec(void * context,const void * value_le)252*4882a593Smuzhiyun static void le64_dec(void *context, const void *value_le)
253*4882a593Smuzhiyun {
254*4882a593Smuzhiyun 	struct dm_transaction_manager *tm = context;
255*4882a593Smuzhiyun 	__le64 v_le;
256*4882a593Smuzhiyun 
257*4882a593Smuzhiyun 	memcpy(&v_le, value_le, sizeof(v_le));
258*4882a593Smuzhiyun 	dm_tm_dec(tm, le64_to_cpu(v_le));
259*4882a593Smuzhiyun }
260*4882a593Smuzhiyun 
le64_equal(void * context,const void * value1_le,const void * value2_le)261*4882a593Smuzhiyun static int le64_equal(void *context, const void *value1_le, const void *value2_le)
262*4882a593Smuzhiyun {
263*4882a593Smuzhiyun 	__le64 v1_le, v2_le;
264*4882a593Smuzhiyun 
265*4882a593Smuzhiyun 	memcpy(&v1_le, value1_le, sizeof(v1_le));
266*4882a593Smuzhiyun 	memcpy(&v2_le, value2_le, sizeof(v2_le));
267*4882a593Smuzhiyun 	return v1_le == v2_le;
268*4882a593Smuzhiyun }
269*4882a593Smuzhiyun 
init_le64_type(struct dm_transaction_manager * tm,struct dm_btree_value_type * vt)270*4882a593Smuzhiyun void init_le64_type(struct dm_transaction_manager *tm,
271*4882a593Smuzhiyun 		    struct dm_btree_value_type *vt)
272*4882a593Smuzhiyun {
273*4882a593Smuzhiyun 	vt->context = tm;
274*4882a593Smuzhiyun 	vt->size = sizeof(__le64);
275*4882a593Smuzhiyun 	vt->inc = le64_inc;
276*4882a593Smuzhiyun 	vt->dec = le64_dec;
277*4882a593Smuzhiyun 	vt->equal = le64_equal;
278*4882a593Smuzhiyun }
279