xref: /openbmc/linux/fs/hfs/bnode.c (revision 519b58bb)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  *  linux/fs/hfs/bnode.c
4  *
5  * Copyright (C) 2001
6  * Brad Boyer (flar@allandria.com)
7  * (C) 2003 Ardis Technologies <roman@ardistech.com>
8  *
9  * Handle basic btree node operations
10  */
11 
12 #include <linux/pagemap.h>
13 #include <linux/slab.h>
14 #include <linux/swap.h>
15 
16 #include "btree.h"
17 
18 void hfs_bnode_read(struct hfs_bnode *node, void *buf, int off, int len)
19 {
20 	struct page *page;
21 	int pagenum;
22 	int bytes_read;
23 	int bytes_to_read;
24 
25 	off += node->page_offset;
26 	pagenum = off >> PAGE_SHIFT;
27 	off &= ~PAGE_MASK; /* compute page offset for the first page */
28 
29 	for (bytes_read = 0; bytes_read < len; bytes_read += bytes_to_read) {
30 		if (pagenum >= node->tree->pages_per_bnode)
31 			break;
32 		page = node->page[pagenum];
33 		bytes_to_read = min_t(int, len - bytes_read, PAGE_SIZE - off);
34 
35 		memcpy_from_page(buf + bytes_read, page, off, bytes_to_read);
36 
37 		pagenum++;
38 		off = 0; /* page offset only applies to the first page */
39 	}
40 }
41 
42 u16 hfs_bnode_read_u16(struct hfs_bnode *node, int off)
43 {
44 	__be16 data;
45 	// optimize later...
46 	hfs_bnode_read(node, &data, off, 2);
47 	return be16_to_cpu(data);
48 }
49 
50 u8 hfs_bnode_read_u8(struct hfs_bnode *node, int off)
51 {
52 	u8 data;
53 	// optimize later...
54 	hfs_bnode_read(node, &data, off, 1);
55 	return data;
56 }
57 
58 void hfs_bnode_read_key(struct hfs_bnode *node, void *key, int off)
59 {
60 	struct hfs_btree *tree;
61 	int key_len;
62 
63 	tree = node->tree;
64 	if (node->type == HFS_NODE_LEAF ||
65 	    tree->attributes & HFS_TREE_VARIDXKEYS)
66 		key_len = hfs_bnode_read_u8(node, off) + 1;
67 	else
68 		key_len = tree->max_key_len + 1;
69 
70 	hfs_bnode_read(node, key, off, key_len);
71 }
72 
73 void hfs_bnode_write(struct hfs_bnode *node, void *buf, int off, int len)
74 {
75 	struct page *page;
76 
77 	off += node->page_offset;
78 	page = node->page[0];
79 
80 	memcpy_to_page(page, off, buf, len);
81 	set_page_dirty(page);
82 }
83 
84 void hfs_bnode_write_u16(struct hfs_bnode *node, int off, u16 data)
85 {
86 	__be16 v = cpu_to_be16(data);
87 	// optimize later...
88 	hfs_bnode_write(node, &v, off, 2);
89 }
90 
91 void hfs_bnode_write_u8(struct hfs_bnode *node, int off, u8 data)
92 {
93 	// optimize later...
94 	hfs_bnode_write(node, &data, off, 1);
95 }
96 
97 void hfs_bnode_clear(struct hfs_bnode *node, int off, int len)
98 {
99 	struct page *page;
100 
101 	off += node->page_offset;
102 	page = node->page[0];
103 
104 	memzero_page(page, off, len);
105 	set_page_dirty(page);
106 }
107 
108 void hfs_bnode_copy(struct hfs_bnode *dst_node, int dst,
109 		struct hfs_bnode *src_node, int src, int len)
110 {
111 	struct page *src_page, *dst_page;
112 
113 	hfs_dbg(BNODE_MOD, "copybytes: %u,%u,%u\n", dst, src, len);
114 	if (!len)
115 		return;
116 	src += src_node->page_offset;
117 	dst += dst_node->page_offset;
118 	src_page = src_node->page[0];
119 	dst_page = dst_node->page[0];
120 
121 	memcpy_page(dst_page, dst, src_page, src, len);
122 	set_page_dirty(dst_page);
123 }
124 
125 void hfs_bnode_move(struct hfs_bnode *node, int dst, int src, int len)
126 {
127 	struct page *page;
128 	void *ptr;
129 
130 	hfs_dbg(BNODE_MOD, "movebytes: %u,%u,%u\n", dst, src, len);
131 	if (!len)
132 		return;
133 	src += node->page_offset;
134 	dst += node->page_offset;
135 	page = node->page[0];
136 	ptr = kmap_local_page(page);
137 	memmove(ptr + dst, ptr + src, len);
138 	kunmap_local(ptr);
139 	set_page_dirty(page);
140 }
141 
142 void hfs_bnode_dump(struct hfs_bnode *node)
143 {
144 	struct hfs_bnode_desc desc;
145 	__be32 cnid;
146 	int i, off, key_off;
147 
148 	hfs_dbg(BNODE_MOD, "bnode: %d\n", node->this);
149 	hfs_bnode_read(node, &desc, 0, sizeof(desc));
150 	hfs_dbg(BNODE_MOD, "%d, %d, %d, %d, %d\n",
151 		be32_to_cpu(desc.next), be32_to_cpu(desc.prev),
152 		desc.type, desc.height, be16_to_cpu(desc.num_recs));
153 
154 	off = node->tree->node_size - 2;
155 	for (i = be16_to_cpu(desc.num_recs); i >= 0; off -= 2, i--) {
156 		key_off = hfs_bnode_read_u16(node, off);
157 		hfs_dbg_cont(BNODE_MOD, " %d", key_off);
158 		if (i && node->type == HFS_NODE_INDEX) {
159 			int tmp;
160 
161 			if (node->tree->attributes & HFS_TREE_VARIDXKEYS)
162 				tmp = (hfs_bnode_read_u8(node, key_off) | 1) + 1;
163 			else
164 				tmp = node->tree->max_key_len + 1;
165 			hfs_dbg_cont(BNODE_MOD, " (%d,%d",
166 				     tmp, hfs_bnode_read_u8(node, key_off));
167 			hfs_bnode_read(node, &cnid, key_off + tmp, 4);
168 			hfs_dbg_cont(BNODE_MOD, ",%d)", be32_to_cpu(cnid));
169 		} else if (i && node->type == HFS_NODE_LEAF) {
170 			int tmp;
171 
172 			tmp = hfs_bnode_read_u8(node, key_off);
173 			hfs_dbg_cont(BNODE_MOD, " (%d)", tmp);
174 		}
175 	}
176 	hfs_dbg_cont(BNODE_MOD, "\n");
177 }
178 
179 void hfs_bnode_unlink(struct hfs_bnode *node)
180 {
181 	struct hfs_btree *tree;
182 	struct hfs_bnode *tmp;
183 	__be32 cnid;
184 
185 	tree = node->tree;
186 	if (node->prev) {
187 		tmp = hfs_bnode_find(tree, node->prev);
188 		if (IS_ERR(tmp))
189 			return;
190 		tmp->next = node->next;
191 		cnid = cpu_to_be32(tmp->next);
192 		hfs_bnode_write(tmp, &cnid, offsetof(struct hfs_bnode_desc, next), 4);
193 		hfs_bnode_put(tmp);
194 	} else if (node->type == HFS_NODE_LEAF)
195 		tree->leaf_head = node->next;
196 
197 	if (node->next) {
198 		tmp = hfs_bnode_find(tree, node->next);
199 		if (IS_ERR(tmp))
200 			return;
201 		tmp->prev = node->prev;
202 		cnid = cpu_to_be32(tmp->prev);
203 		hfs_bnode_write(tmp, &cnid, offsetof(struct hfs_bnode_desc, prev), 4);
204 		hfs_bnode_put(tmp);
205 	} else if (node->type == HFS_NODE_LEAF)
206 		tree->leaf_tail = node->prev;
207 
208 	// move down?
209 	if (!node->prev && !node->next) {
210 		printk(KERN_DEBUG "hfs_btree_del_level\n");
211 	}
212 	if (!node->parent) {
213 		tree->root = 0;
214 		tree->depth = 0;
215 	}
216 	set_bit(HFS_BNODE_DELETED, &node->flags);
217 }
218 
219 static inline int hfs_bnode_hash(u32 num)
220 {
221 	num = (num >> 16) + num;
222 	num += num >> 8;
223 	return num & (NODE_HASH_SIZE - 1);
224 }
225 
226 struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *tree, u32 cnid)
227 {
228 	struct hfs_bnode *node;
229 
230 	if (cnid >= tree->node_count) {
231 		pr_err("request for non-existent node %d in B*Tree\n", cnid);
232 		return NULL;
233 	}
234 
235 	for (node = tree->node_hash[hfs_bnode_hash(cnid)];
236 	     node; node = node->next_hash) {
237 		if (node->this == cnid) {
238 			return node;
239 		}
240 	}
241 	return NULL;
242 }
243 
244 static struct hfs_bnode *__hfs_bnode_create(struct hfs_btree *tree, u32 cnid)
245 {
246 	struct hfs_bnode *node, *node2;
247 	struct address_space *mapping;
248 	struct page *page;
249 	int size, block, i, hash;
250 	loff_t off;
251 
252 	if (cnid >= tree->node_count) {
253 		pr_err("request for non-existent node %d in B*Tree\n", cnid);
254 		return NULL;
255 	}
256 
257 	size = sizeof(struct hfs_bnode) + tree->pages_per_bnode *
258 		sizeof(struct page *);
259 	node = kzalloc(size, GFP_KERNEL);
260 	if (!node)
261 		return NULL;
262 	node->tree = tree;
263 	node->this = cnid;
264 	set_bit(HFS_BNODE_NEW, &node->flags);
265 	atomic_set(&node->refcnt, 1);
266 	hfs_dbg(BNODE_REFS, "new_node(%d:%d): 1\n",
267 		node->tree->cnid, node->this);
268 	init_waitqueue_head(&node->lock_wq);
269 	spin_lock(&tree->hash_lock);
270 	node2 = hfs_bnode_findhash(tree, cnid);
271 	if (!node2) {
272 		hash = hfs_bnode_hash(cnid);
273 		node->next_hash = tree->node_hash[hash];
274 		tree->node_hash[hash] = node;
275 		tree->node_hash_cnt++;
276 	} else {
277 		spin_unlock(&tree->hash_lock);
278 		kfree(node);
279 		wait_event(node2->lock_wq, !test_bit(HFS_BNODE_NEW, &node2->flags));
280 		return node2;
281 	}
282 	spin_unlock(&tree->hash_lock);
283 
284 	mapping = tree->inode->i_mapping;
285 	off = (loff_t)cnid * tree->node_size;
286 	block = off >> PAGE_SHIFT;
287 	node->page_offset = off & ~PAGE_MASK;
288 	for (i = 0; i < tree->pages_per_bnode; i++) {
289 		page = read_mapping_page(mapping, block++, NULL);
290 		if (IS_ERR(page))
291 			goto fail;
292 		node->page[i] = page;
293 	}
294 
295 	return node;
296 fail:
297 	set_bit(HFS_BNODE_ERROR, &node->flags);
298 	return node;
299 }
300 
301 void hfs_bnode_unhash(struct hfs_bnode *node)
302 {
303 	struct hfs_bnode **p;
304 
305 	hfs_dbg(BNODE_REFS, "remove_node(%d:%d): %d\n",
306 		node->tree->cnid, node->this, atomic_read(&node->refcnt));
307 	for (p = &node->tree->node_hash[hfs_bnode_hash(node->this)];
308 	     *p && *p != node; p = &(*p)->next_hash)
309 		;
310 	BUG_ON(!*p);
311 	*p = node->next_hash;
312 	node->tree->node_hash_cnt--;
313 }
314 
315 /* Load a particular node out of a tree */
316 struct hfs_bnode *hfs_bnode_find(struct hfs_btree *tree, u32 num)
317 {
318 	struct hfs_bnode *node;
319 	struct hfs_bnode_desc *desc;
320 	int i, rec_off, off, next_off;
321 	int entry_size, key_size;
322 
323 	spin_lock(&tree->hash_lock);
324 	node = hfs_bnode_findhash(tree, num);
325 	if (node) {
326 		hfs_bnode_get(node);
327 		spin_unlock(&tree->hash_lock);
328 		wait_event(node->lock_wq, !test_bit(HFS_BNODE_NEW, &node->flags));
329 		if (test_bit(HFS_BNODE_ERROR, &node->flags))
330 			goto node_error;
331 		return node;
332 	}
333 	spin_unlock(&tree->hash_lock);
334 	node = __hfs_bnode_create(tree, num);
335 	if (!node)
336 		return ERR_PTR(-ENOMEM);
337 	if (test_bit(HFS_BNODE_ERROR, &node->flags))
338 		goto node_error;
339 	if (!test_bit(HFS_BNODE_NEW, &node->flags))
340 		return node;
341 
342 	desc = (struct hfs_bnode_desc *)(kmap_local_page(node->page[0]) +
343 					 node->page_offset);
344 	node->prev = be32_to_cpu(desc->prev);
345 	node->next = be32_to_cpu(desc->next);
346 	node->num_recs = be16_to_cpu(desc->num_recs);
347 	node->type = desc->type;
348 	node->height = desc->height;
349 	kunmap_local(desc);
350 
351 	switch (node->type) {
352 	case HFS_NODE_HEADER:
353 	case HFS_NODE_MAP:
354 		if (node->height != 0)
355 			goto node_error;
356 		break;
357 	case HFS_NODE_LEAF:
358 		if (node->height != 1)
359 			goto node_error;
360 		break;
361 	case HFS_NODE_INDEX:
362 		if (node->height <= 1 || node->height > tree->depth)
363 			goto node_error;
364 		break;
365 	default:
366 		goto node_error;
367 	}
368 
369 	rec_off = tree->node_size - 2;
370 	off = hfs_bnode_read_u16(node, rec_off);
371 	if (off != sizeof(struct hfs_bnode_desc))
372 		goto node_error;
373 	for (i = 1; i <= node->num_recs; off = next_off, i++) {
374 		rec_off -= 2;
375 		next_off = hfs_bnode_read_u16(node, rec_off);
376 		if (next_off <= off ||
377 		    next_off > tree->node_size ||
378 		    next_off & 1)
379 			goto node_error;
380 		entry_size = next_off - off;
381 		if (node->type != HFS_NODE_INDEX &&
382 		    node->type != HFS_NODE_LEAF)
383 			continue;
384 		key_size = hfs_bnode_read_u8(node, off) + 1;
385 		if (key_size >= entry_size /*|| key_size & 1*/)
386 			goto node_error;
387 	}
388 	clear_bit(HFS_BNODE_NEW, &node->flags);
389 	wake_up(&node->lock_wq);
390 	return node;
391 
392 node_error:
393 	set_bit(HFS_BNODE_ERROR, &node->flags);
394 	clear_bit(HFS_BNODE_NEW, &node->flags);
395 	wake_up(&node->lock_wq);
396 	hfs_bnode_put(node);
397 	return ERR_PTR(-EIO);
398 }
399 
400 void hfs_bnode_free(struct hfs_bnode *node)
401 {
402 	int i;
403 
404 	for (i = 0; i < node->tree->pages_per_bnode; i++)
405 		if (node->page[i])
406 			put_page(node->page[i]);
407 	kfree(node);
408 }
409 
410 struct hfs_bnode *hfs_bnode_create(struct hfs_btree *tree, u32 num)
411 {
412 	struct hfs_bnode *node;
413 	struct page **pagep;
414 	int i;
415 
416 	spin_lock(&tree->hash_lock);
417 	node = hfs_bnode_findhash(tree, num);
418 	spin_unlock(&tree->hash_lock);
419 	if (node) {
420 		pr_crit("new node %u already hashed?\n", num);
421 		WARN_ON(1);
422 		return node;
423 	}
424 	node = __hfs_bnode_create(tree, num);
425 	if (!node)
426 		return ERR_PTR(-ENOMEM);
427 	if (test_bit(HFS_BNODE_ERROR, &node->flags)) {
428 		hfs_bnode_put(node);
429 		return ERR_PTR(-EIO);
430 	}
431 
432 	pagep = node->page;
433 	memzero_page(*pagep, node->page_offset,
434 		     min((int)PAGE_SIZE, (int)tree->node_size));
435 	set_page_dirty(*pagep);
436 	for (i = 1; i < tree->pages_per_bnode; i++) {
437 		memzero_page(*++pagep, 0, PAGE_SIZE);
438 		set_page_dirty(*pagep);
439 	}
440 	clear_bit(HFS_BNODE_NEW, &node->flags);
441 	wake_up(&node->lock_wq);
442 
443 	return node;
444 }
445 
446 void hfs_bnode_get(struct hfs_bnode *node)
447 {
448 	if (node) {
449 		atomic_inc(&node->refcnt);
450 		hfs_dbg(BNODE_REFS, "get_node(%d:%d): %d\n",
451 			node->tree->cnid, node->this,
452 			atomic_read(&node->refcnt));
453 	}
454 }
455 
456 /* Dispose of resources used by a node */
457 void hfs_bnode_put(struct hfs_bnode *node)
458 {
459 	if (node) {
460 		struct hfs_btree *tree = node->tree;
461 		int i;
462 
463 		hfs_dbg(BNODE_REFS, "put_node(%d:%d): %d\n",
464 			node->tree->cnid, node->this,
465 			atomic_read(&node->refcnt));
466 		BUG_ON(!atomic_read(&node->refcnt));
467 		if (!atomic_dec_and_lock(&node->refcnt, &tree->hash_lock))
468 			return;
469 		for (i = 0; i < tree->pages_per_bnode; i++) {
470 			if (!node->page[i])
471 				continue;
472 			mark_page_accessed(node->page[i]);
473 		}
474 
475 		if (test_bit(HFS_BNODE_DELETED, &node->flags)) {
476 			hfs_bnode_unhash(node);
477 			spin_unlock(&tree->hash_lock);
478 			hfs_bmap_free(node);
479 			hfs_bnode_free(node);
480 			return;
481 		}
482 		spin_unlock(&tree->hash_lock);
483 	}
484 }
485