btree.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  2/*
  3 *  linux/fs/hfs/btree.h
  4 *
  5 * Copyright (C) 2001
  6 * Brad Boyer (flar@allandria.com)
  7 * (C) 2003 Ardis Technologies <roman@ardistech.com>
  8 */
  9
 10#include "hfs_fs.h"
 11
 12typedef int (*btree_keycmp)(const btree_key *, const btree_key *);
 13
 14#define NODE_HASH_SIZE  256
 15
 16/* B-tree mutex nested subclasses */
 17enum hfs_btree_mutex_classes {
 18	CATALOG_BTREE_MUTEX,
 19	EXTENTS_BTREE_MUTEX,
 20	ATTR_BTREE_MUTEX,
 21};
 22
 23/* A HFS BTree held in memory */
 24struct hfs_btree {
 25	struct super_block *sb;
 26	struct inode *inode;
 27	btree_keycmp keycmp;
 28
 29	u32 cnid;
 30	u32 root;
 31	u32 leaf_count;
 32	u32 leaf_head;
 33	u32 leaf_tail;
 34	u32 node_count;
 35	u32 free_nodes;
 36	u32 attributes;
 37
 38	unsigned int node_size;
 39	unsigned int node_size_shift;
 40	unsigned int max_key_len;
 41	unsigned int depth;
 42
 43	//unsigned int map1_size, map_size;
 44	struct mutex tree_lock;
 45
 46	unsigned int pages_per_bnode;
 47	spinlock_t hash_lock;
 48	struct hfs_bnode *node_hash[NODE_HASH_SIZE];
 49	int node_hash_cnt;
 50};
 51
 52/* A HFS BTree node in memory */
 53struct hfs_bnode {
 54	struct hfs_btree *tree;
 55
 56	u32 prev;
 57	u32 this;
 58	u32 next;
 59	u32 parent;
 60
 61	u16 num_recs;
 62	u8 type;
 63	u8 height;
 64
 65	struct hfs_bnode *next_hash;
 66	unsigned long flags;
 67	wait_queue_head_t lock_wq;
 68	atomic_t refcnt;
 69	unsigned int page_offset;
 70	struct page *page[];
 71};
 72
 73#define HFS_BNODE_ERROR		0
 74#define HFS_BNODE_NEW		1
 75#define HFS_BNODE_DELETED	2
 76
 77struct hfs_find_data {
 78	btree_key *key;
 79	btree_key *search_key;
 80	struct hfs_btree *tree;
 81	struct hfs_bnode *bnode;
 82	int record;
 83	int keyoffset, keylength;
 84	int entryoffset, entrylength;
 85};
 86
 87
 88/* btree.c */
 89extern struct hfs_btree *hfs_btree_open(struct super_block *sb, u32 id,
 90					btree_keycmp keycmp);
 91extern void hfs_btree_close(struct hfs_btree *tree);
 92extern void hfs_btree_write(struct hfs_btree *tree);
 93extern int hfs_bmap_reserve(struct hfs_btree *tree, u32 rsvd_nodes);
 94extern struct hfs_bnode *hfs_bmap_alloc(struct hfs_btree *tree);
 95extern void hfs_bmap_free(struct hfs_bnode *node);
 96
 97/* bnode.c */
 98extern void hfs_bnode_read(struct hfs_bnode *node, void *buf, u32 off, u32 len);
 99extern u16 hfs_bnode_read_u16(struct hfs_bnode *node, u32 off);
100extern u8 hfs_bnode_read_u8(struct hfs_bnode *node, u32 off);
101extern void hfs_bnode_read_key(struct hfs_bnode *node, void *key, u32 off);
102extern void hfs_bnode_write(struct hfs_bnode *node, void *buf, u32 off, u32 len);
103extern void hfs_bnode_write_u16(struct hfs_bnode *node, u32 off, u16 data);
104extern void hfs_bnode_write_u8(struct hfs_bnode *node, u32 off, u8 data);
105extern void hfs_bnode_clear(struct hfs_bnode *node, u32 off, u32 len);
106extern void hfs_bnode_copy(struct hfs_bnode *dst_node, u32 dst,
107			   struct hfs_bnode *src_node, u32 src, u32 len);
108extern void hfs_bnode_move(struct hfs_bnode *node, u32 dst, u32 src, u32 len);
109extern void hfs_bnode_dump(struct hfs_bnode *node);
110extern void hfs_bnode_unlink(struct hfs_bnode *node);
111extern struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *tree, u32 cnid);
112extern struct hfs_bnode *hfs_bnode_find(struct hfs_btree *tree, u32 num);
113extern void hfs_bnode_unhash(struct hfs_bnode *node);
114extern void hfs_bnode_free(struct hfs_bnode *node);
115extern struct hfs_bnode *hfs_bnode_create(struct hfs_btree *tree, u32 num);
116extern void hfs_bnode_get(struct hfs_bnode *node);
117extern void hfs_bnode_put(struct hfs_bnode *node);
118
119/* brec.c */
120extern u16 hfs_brec_lenoff(struct hfs_bnode *node, u16 rec, u16 *off);
121extern u16 hfs_brec_keylen(struct hfs_bnode *node, u16 rec);
122extern int hfs_brec_insert(struct hfs_find_data *fd, void *entry, u32 entry_len);
123extern int hfs_brec_remove(struct hfs_find_data *fd);
124
125/* bfind.c */
126extern int hfs_find_init(struct hfs_btree *tree, struct hfs_find_data *fd);
127extern void hfs_find_exit(struct hfs_find_data *fd);
128extern int __hfs_brec_find(struct hfs_bnode *bnode, struct hfs_find_data *fd);
129extern int hfs_brec_find(struct hfs_find_data *fd);
130extern int hfs_brec_read(struct hfs_find_data *fd, void *rec, u32 rec_len);
131extern int hfs_brec_goto(struct hfs_find_data *fd, int cnt);