2 * linux/fs/hfsplus/bnode.c
5 * Brad Boyer (flar@allandria.com)
6 * (C) 2003 Ardis Technologies <roman@ardistech.com>
8 * Handle basic btree node operations
11 #include <linux/string.h>
12 #include <linux/slab.h>
13 #include <linux/pagemap.h>
15 #include <linux/swap.h>
17 #include "hfsplus_fs.h"
18 #include "hfsplus_raw.h"
20 /* Copy a specified range of bytes from the raw data of a node */
21 void hfs_bnode_read(struct hfs_bnode *node, void *buf, int off, int len)
26 off += node->page_offset;
27 pagep = node->page + (off >> PAGE_SHIFT);
30 l = min_t(int, len, PAGE_SIZE - off);
31 memcpy(buf, kmap(*pagep) + off, l);
34 while ((len -= l) != 0) {
36 l = min_t(int, len, PAGE_SIZE);
37 memcpy(buf, kmap(*++pagep), l);
42 u16 hfs_bnode_read_u16(struct hfs_bnode *node, int off)
45 /* TODO: optimize later... */
46 hfs_bnode_read(node, &data, off, 2);
47 return be16_to_cpu(data);
50 u8 hfs_bnode_read_u8(struct hfs_bnode *node, int off)
53 /* TODO: optimize later... */
54 hfs_bnode_read(node, &data, off, 1);
58 void hfs_bnode_read_key(struct hfs_bnode *node, void *key, int off)
60 struct hfs_btree *tree;
64 if (node->type == HFS_NODE_LEAF ||
65 tree->attributes & HFS_TREE_VARIDXKEYS ||
66 node->tree->cnid == HFSPLUS_ATTR_CNID)
67 key_len = hfs_bnode_read_u16(node, off) + 2;
69 key_len = tree->max_key_len + 2;
71 hfs_bnode_read(node, key, off, key_len);
74 void hfs_bnode_write(struct hfs_bnode *node, void *buf, int off, int len)
79 off += node->page_offset;
80 pagep = node->page + (off >> PAGE_SHIFT);
83 l = min_t(int, len, PAGE_SIZE - off);
84 memcpy(kmap(*pagep) + off, buf, l);
85 set_page_dirty(*pagep);
88 while ((len -= l) != 0) {
90 l = min_t(int, len, PAGE_SIZE);
91 memcpy(kmap(*++pagep), buf, l);
92 set_page_dirty(*pagep);
97 void hfs_bnode_write_u16(struct hfs_bnode *node, int off, u16 data)
99 __be16 v = cpu_to_be16(data);
100 /* TODO: optimize later... */
101 hfs_bnode_write(node, &v, off, 2);
104 void hfs_bnode_clear(struct hfs_bnode *node, int off, int len)
109 off += node->page_offset;
110 pagep = node->page + (off >> PAGE_SHIFT);
113 l = min_t(int, len, PAGE_SIZE - off);
114 memset(kmap(*pagep) + off, 0, l);
115 set_page_dirty(*pagep);
118 while ((len -= l) != 0) {
119 l = min_t(int, len, PAGE_SIZE);
120 memset(kmap(*++pagep), 0, l);
121 set_page_dirty(*pagep);
126 void hfs_bnode_copy(struct hfs_bnode *dst_node, int dst,
127 struct hfs_bnode *src_node, int src, int len)
129 struct hfs_btree *tree;
130 struct page **src_page, **dst_page;
133 hfs_dbg(BNODE_MOD, "copybytes: %u,%u,%u\n", dst, src, len);
136 tree = src_node->tree;
137 src += src_node->page_offset;
138 dst += dst_node->page_offset;
139 src_page = src_node->page + (src >> PAGE_SHIFT);
141 dst_page = dst_node->page + (dst >> PAGE_SHIFT);
145 l = min_t(int, len, PAGE_SIZE - src);
146 memcpy(kmap(*dst_page) + src, kmap(*src_page) + src, l);
148 set_page_dirty(*dst_page);
151 while ((len -= l) != 0) {
152 l = min_t(int, len, PAGE_SIZE);
153 memcpy(kmap(*++dst_page), kmap(*++src_page), l);
155 set_page_dirty(*dst_page);
159 void *src_ptr, *dst_ptr;
162 src_ptr = kmap(*src_page) + src;
163 dst_ptr = kmap(*dst_page) + dst;
164 if (PAGE_SIZE - src < PAGE_SIZE - dst) {
174 memcpy(dst_ptr, src_ptr, l);
176 set_page_dirty(*dst_page);
182 } while ((len -= l));
186 void hfs_bnode_move(struct hfs_bnode *node, int dst, int src, int len)
188 struct page **src_page, **dst_page;
191 hfs_dbg(BNODE_MOD, "movebytes: %u,%u,%u\n", dst, src, len);
194 src += node->page_offset;
195 dst += node->page_offset;
198 src_page = node->page + (src >> PAGE_SHIFT);
199 src = (src & ~PAGE_MASK) + 1;
201 dst_page = node->page + (dst >> PAGE_SHIFT);
202 dst = (dst & ~PAGE_MASK) + 1;
206 memmove(kmap(*dst_page), kmap(*src_page), src);
208 set_page_dirty(*dst_page);
216 memmove(kmap(*dst_page) + src,
217 kmap(*src_page) + src, len);
219 set_page_dirty(*dst_page);
222 void *src_ptr, *dst_ptr;
225 src_ptr = kmap(*src_page) + src;
226 dst_ptr = kmap(*dst_page) + dst;
237 memmove(dst_ptr - l, src_ptr - l, l);
239 set_page_dirty(*dst_page);
241 if (dst == PAGE_SIZE)
245 } while ((len -= l));
248 src_page = node->page + (src >> PAGE_SHIFT);
250 dst_page = node->page + (dst >> PAGE_SHIFT);
254 l = min_t(int, len, PAGE_SIZE - src);
255 memmove(kmap(*dst_page) + src,
256 kmap(*src_page) + src, l);
258 set_page_dirty(*dst_page);
261 while ((len -= l) != 0) {
262 l = min_t(int, len, PAGE_SIZE);
263 memmove(kmap(*++dst_page),
264 kmap(*++src_page), l);
266 set_page_dirty(*dst_page);
270 void *src_ptr, *dst_ptr;
273 src_ptr = kmap(*src_page) + src;
274 dst_ptr = kmap(*dst_page) + dst;
275 if (PAGE_SIZE - src <
286 memmove(dst_ptr, src_ptr, l);
288 set_page_dirty(*dst_page);
294 } while ((len -= l));
299 void hfs_bnode_dump(struct hfs_bnode *node)
301 struct hfs_bnode_desc desc;
305 hfs_dbg(BNODE_MOD, "bnode: %d\n", node->this);
306 hfs_bnode_read(node, &desc, 0, sizeof(desc));
307 hfs_dbg(BNODE_MOD, "%d, %d, %d, %d, %d\n",
308 be32_to_cpu(desc.next), be32_to_cpu(desc.prev),
309 desc.type, desc.height, be16_to_cpu(desc.num_recs));
311 off = node->tree->node_size - 2;
312 for (i = be16_to_cpu(desc.num_recs); i >= 0; off -= 2, i--) {
313 key_off = hfs_bnode_read_u16(node, off);
314 hfs_dbg(BNODE_MOD, " %d", key_off);
315 if (i && node->type == HFS_NODE_INDEX) {
318 if (node->tree->attributes & HFS_TREE_VARIDXKEYS ||
319 node->tree->cnid == HFSPLUS_ATTR_CNID)
320 tmp = hfs_bnode_read_u16(node, key_off) + 2;
322 tmp = node->tree->max_key_len + 2;
323 hfs_dbg_cont(BNODE_MOD, " (%d", tmp);
324 hfs_bnode_read(node, &cnid, key_off + tmp, 4);
325 hfs_dbg_cont(BNODE_MOD, ",%d)", be32_to_cpu(cnid));
326 } else if (i && node->type == HFS_NODE_LEAF) {
329 tmp = hfs_bnode_read_u16(node, key_off);
330 hfs_dbg_cont(BNODE_MOD, " (%d)", tmp);
333 hfs_dbg_cont(BNODE_MOD, "\n");
336 void hfs_bnode_unlink(struct hfs_bnode *node)
338 struct hfs_btree *tree;
339 struct hfs_bnode *tmp;
344 tmp = hfs_bnode_find(tree, node->prev);
347 tmp->next = node->next;
348 cnid = cpu_to_be32(tmp->next);
349 hfs_bnode_write(tmp, &cnid,
350 offsetof(struct hfs_bnode_desc, next), 4);
352 } else if (node->type == HFS_NODE_LEAF)
353 tree->leaf_head = node->next;
356 tmp = hfs_bnode_find(tree, node->next);
359 tmp->prev = node->prev;
360 cnid = cpu_to_be32(tmp->prev);
361 hfs_bnode_write(tmp, &cnid,
362 offsetof(struct hfs_bnode_desc, prev), 4);
364 } else if (node->type == HFS_NODE_LEAF)
365 tree->leaf_tail = node->prev;
368 if (!node->prev && !node->next)
369 hfs_dbg(BNODE_MOD, "hfs_btree_del_level\n");
374 set_bit(HFS_BNODE_DELETED, &node->flags);
377 static inline int hfs_bnode_hash(u32 num)
379 num = (num >> 16) + num;
381 return num & (NODE_HASH_SIZE - 1);
384 struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *tree, u32 cnid)
386 struct hfs_bnode *node;
388 if (cnid >= tree->node_count) {
389 pr_err("request for non-existent node %d in B*Tree\n",
394 for (node = tree->node_hash[hfs_bnode_hash(cnid)];
395 node; node = node->next_hash)
396 if (node->this == cnid)
401 static struct hfs_bnode *__hfs_bnode_create(struct hfs_btree *tree, u32 cnid)
403 struct super_block *sb;
404 struct hfs_bnode *node, *node2;
405 struct address_space *mapping;
407 int size, block, i, hash;
410 if (cnid >= tree->node_count) {
411 pr_err("request for non-existent node %d in B*Tree\n",
416 sb = tree->inode->i_sb;
417 size = sizeof(struct hfs_bnode) + tree->pages_per_bnode *
418 sizeof(struct page *);
419 node = kzalloc(size, GFP_KERNEL);
424 set_bit(HFS_BNODE_NEW, &node->flags);
425 atomic_set(&node->refcnt, 1);
426 hfs_dbg(BNODE_REFS, "new_node(%d:%d): 1\n",
427 node->tree->cnid, node->this);
428 init_waitqueue_head(&node->lock_wq);
429 spin_lock(&tree->hash_lock);
430 node2 = hfs_bnode_findhash(tree, cnid);
432 hash = hfs_bnode_hash(cnid);
433 node->next_hash = tree->node_hash[hash];
434 tree->node_hash[hash] = node;
435 tree->node_hash_cnt++;
437 spin_unlock(&tree->hash_lock);
439 wait_event(node2->lock_wq,
440 !test_bit(HFS_BNODE_NEW, &node2->flags));
443 spin_unlock(&tree->hash_lock);
445 mapping = tree->inode->i_mapping;
446 off = (loff_t)cnid << tree->node_size_shift;
447 block = off >> PAGE_SHIFT;
448 node->page_offset = off & ~PAGE_MASK;
449 for (i = 0; i < tree->pages_per_bnode; block++, i++) {
450 page = read_mapping_page(mapping, block, NULL);
453 if (PageError(page)) {
457 node->page[i] = page;
462 set_bit(HFS_BNODE_ERROR, &node->flags);
466 void hfs_bnode_unhash(struct hfs_bnode *node)
468 struct hfs_bnode **p;
470 hfs_dbg(BNODE_REFS, "remove_node(%d:%d): %d\n",
471 node->tree->cnid, node->this, atomic_read(&node->refcnt));
472 for (p = &node->tree->node_hash[hfs_bnode_hash(node->this)];
473 *p && *p != node; p = &(*p)->next_hash)
476 *p = node->next_hash;
477 node->tree->node_hash_cnt--;
480 /* Load a particular node out of a tree */
481 struct hfs_bnode *hfs_bnode_find(struct hfs_btree *tree, u32 num)
483 struct hfs_bnode *node;
484 struct hfs_bnode_desc *desc;
485 int i, rec_off, off, next_off;
486 int entry_size, key_size;
488 spin_lock(&tree->hash_lock);
489 node = hfs_bnode_findhash(tree, num);
492 spin_unlock(&tree->hash_lock);
493 wait_event(node->lock_wq,
494 !test_bit(HFS_BNODE_NEW, &node->flags));
495 if (test_bit(HFS_BNODE_ERROR, &node->flags))
499 spin_unlock(&tree->hash_lock);
500 node = __hfs_bnode_create(tree, num);
502 return ERR_PTR(-ENOMEM);
503 if (test_bit(HFS_BNODE_ERROR, &node->flags))
505 if (!test_bit(HFS_BNODE_NEW, &node->flags))
508 desc = (struct hfs_bnode_desc *)(kmap(node->page[0]) +
510 node->prev = be32_to_cpu(desc->prev);
511 node->next = be32_to_cpu(desc->next);
512 node->num_recs = be16_to_cpu(desc->num_recs);
513 node->type = desc->type;
514 node->height = desc->height;
515 kunmap(node->page[0]);
517 switch (node->type) {
518 case HFS_NODE_HEADER:
520 if (node->height != 0)
524 if (node->height != 1)
528 if (node->height <= 1 || node->height > tree->depth)
535 rec_off = tree->node_size - 2;
536 off = hfs_bnode_read_u16(node, rec_off);
537 if (off != sizeof(struct hfs_bnode_desc))
539 for (i = 1; i <= node->num_recs; off = next_off, i++) {
541 next_off = hfs_bnode_read_u16(node, rec_off);
542 if (next_off <= off ||
543 next_off > tree->node_size ||
546 entry_size = next_off - off;
547 if (node->type != HFS_NODE_INDEX &&
548 node->type != HFS_NODE_LEAF)
550 key_size = hfs_bnode_read_u16(node, off) + 2;
551 if (key_size >= entry_size || key_size & 1)
554 clear_bit(HFS_BNODE_NEW, &node->flags);
555 wake_up(&node->lock_wq);
559 set_bit(HFS_BNODE_ERROR, &node->flags);
560 clear_bit(HFS_BNODE_NEW, &node->flags);
561 wake_up(&node->lock_wq);
563 return ERR_PTR(-EIO);
566 void hfs_bnode_free(struct hfs_bnode *node)
570 for (i = 0; i < node->tree->pages_per_bnode; i++)
572 put_page(node->page[i]);
576 struct hfs_bnode *hfs_bnode_create(struct hfs_btree *tree, u32 num)
578 struct hfs_bnode *node;
582 spin_lock(&tree->hash_lock);
583 node = hfs_bnode_findhash(tree, num);
584 spin_unlock(&tree->hash_lock);
586 pr_crit("new node %u already hashed?\n", num);
590 node = __hfs_bnode_create(tree, num);
592 return ERR_PTR(-ENOMEM);
593 if (test_bit(HFS_BNODE_ERROR, &node->flags)) {
595 return ERR_PTR(-EIO);
599 memset(kmap(*pagep) + node->page_offset, 0,
600 min_t(int, PAGE_SIZE, tree->node_size));
601 set_page_dirty(*pagep);
603 for (i = 1; i < tree->pages_per_bnode; i++) {
604 memset(kmap(*++pagep), 0, PAGE_SIZE);
605 set_page_dirty(*pagep);
608 clear_bit(HFS_BNODE_NEW, &node->flags);
609 wake_up(&node->lock_wq);
614 void hfs_bnode_get(struct hfs_bnode *node)
617 atomic_inc(&node->refcnt);
618 hfs_dbg(BNODE_REFS, "get_node(%d:%d): %d\n",
619 node->tree->cnid, node->this,
620 atomic_read(&node->refcnt));
624 /* Dispose of resources used by a node */
625 void hfs_bnode_put(struct hfs_bnode *node)
628 struct hfs_btree *tree = node->tree;
631 hfs_dbg(BNODE_REFS, "put_node(%d:%d): %d\n",
632 node->tree->cnid, node->this,
633 atomic_read(&node->refcnt));
634 BUG_ON(!atomic_read(&node->refcnt));
635 if (!atomic_dec_and_lock(&node->refcnt, &tree->hash_lock))
637 for (i = 0; i < tree->pages_per_bnode; i++) {
640 mark_page_accessed(node->page[i]);
643 if (test_bit(HFS_BNODE_DELETED, &node->flags)) {
644 hfs_bnode_unhash(node);
645 spin_unlock(&tree->hash_lock);
646 if (hfs_bnode_need_zeroout(tree))
647 hfs_bnode_clear(node, 0, tree->node_size);
649 hfs_bnode_free(node);
652 spin_unlock(&tree->hash_lock);
657 * Unused nodes have to be zeroed if this is the catalog tree and
658 * a corresponding flag in the volume header is set.
660 bool hfs_bnode_need_zeroout(struct hfs_btree *tree)
662 struct super_block *sb = tree->inode->i_sb;
663 struct hfsplus_sb_info *sbi = HFSPLUS_SB(sb);
664 const u32 volume_attr = be32_to_cpu(sbi->s_vhdr->attributes);
666 return tree->cnid == HFSPLUS_CAT_CNID &&
667 volume_attr & HFSPLUS_VOL_UNUSED_NODE_FIX;