btree.h 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
  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. #include "hfs_fs.h"
  10. typedef int (*btree_keycmp)(const btree_key *, const btree_key *);
  11. #define NODE_HASH_SIZE 256
  12. /* B-tree mutex nested subclasses */
  13. enum hfs_btree_mutex_classes {
  14. CATALOG_BTREE_MUTEX,
  15. EXTENTS_BTREE_MUTEX,
  16. ATTR_BTREE_MUTEX,
  17. };
  18. /* A HFS BTree held in memory */
  19. struct hfs_btree {
  20. struct super_block *sb;
  21. struct inode *inode;
  22. btree_keycmp keycmp;
  23. u32 cnid;
  24. u32 root;
  25. u32 leaf_count;
  26. u32 leaf_head;
  27. u32 leaf_tail;
  28. u32 node_count;
  29. u32 free_nodes;
  30. u32 attributes;
  31. unsigned int node_size;
  32. unsigned int node_size_shift;
  33. unsigned int max_key_len;
  34. unsigned int depth;
  35. //unsigned int map1_size, map_size;
  36. struct mutex tree_lock;
  37. unsigned int pages_per_bnode;
  38. spinlock_t hash_lock;
  39. struct hfs_bnode *node_hash[NODE_HASH_SIZE];
  40. int node_hash_cnt;
  41. };
  42. /* A HFS BTree node in memory */
  43. struct hfs_bnode {
  44. struct hfs_btree *tree;
  45. u32 prev;
  46. u32 this;
  47. u32 next;
  48. u32 parent;
  49. u16 num_recs;
  50. u8 type;
  51. u8 height;
  52. struct hfs_bnode *next_hash;
  53. unsigned long flags;
  54. wait_queue_head_t lock_wq;
  55. atomic_t refcnt;
  56. unsigned int page_offset;
  57. struct page *page[];
  58. };
  59. #define HFS_BNODE_ERROR 0
  60. #define HFS_BNODE_NEW 1
  61. #define HFS_BNODE_DELETED 2
  62. struct hfs_find_data {
  63. btree_key *key;
  64. btree_key *search_key;
  65. struct hfs_btree *tree;
  66. struct hfs_bnode *bnode;
  67. int record;
  68. int keyoffset, keylength;
  69. int entryoffset, entrylength;
  70. };
  71. /* btree.c */
  72. extern struct hfs_btree *hfs_btree_open(struct super_block *, u32, btree_keycmp);
  73. extern void hfs_btree_close(struct hfs_btree *);
  74. extern void hfs_btree_write(struct hfs_btree *);
  75. extern int hfs_bmap_reserve(struct hfs_btree *, int);
  76. extern struct hfs_bnode * hfs_bmap_alloc(struct hfs_btree *);
  77. extern void hfs_bmap_free(struct hfs_bnode *node);
  78. /* bnode.c */
  79. extern void hfs_bnode_read(struct hfs_bnode *, void *, int, int);
  80. extern u16 hfs_bnode_read_u16(struct hfs_bnode *, int);
  81. extern u8 hfs_bnode_read_u8(struct hfs_bnode *, int);
  82. extern void hfs_bnode_read_key(struct hfs_bnode *, void *, int);
  83. extern void hfs_bnode_write(struct hfs_bnode *, void *, int, int);
  84. extern void hfs_bnode_write_u16(struct hfs_bnode *, int, u16);
  85. extern void hfs_bnode_write_u8(struct hfs_bnode *, int, u8);
  86. extern void hfs_bnode_clear(struct hfs_bnode *, int, int);
  87. extern void hfs_bnode_copy(struct hfs_bnode *, int,
  88. struct hfs_bnode *, int, int);
  89. extern void hfs_bnode_move(struct hfs_bnode *, int, int, int);
  90. extern void hfs_bnode_dump(struct hfs_bnode *);
  91. extern void hfs_bnode_unlink(struct hfs_bnode *);
  92. extern struct hfs_bnode *hfs_bnode_findhash(struct hfs_btree *, u32);
  93. extern struct hfs_bnode *hfs_bnode_find(struct hfs_btree *, u32);
  94. extern void hfs_bnode_unhash(struct hfs_bnode *);
  95. extern void hfs_bnode_free(struct hfs_bnode *);
  96. extern struct hfs_bnode *hfs_bnode_create(struct hfs_btree *, u32);
  97. extern void hfs_bnode_get(struct hfs_bnode *);
  98. extern void hfs_bnode_put(struct hfs_bnode *);
  99. /* brec.c */
  100. extern u16 hfs_brec_lenoff(struct hfs_bnode *, u16, u16 *);
  101. extern u16 hfs_brec_keylen(struct hfs_bnode *, u16);
  102. extern int hfs_brec_insert(struct hfs_find_data *, void *, int);
  103. extern int hfs_brec_remove(struct hfs_find_data *);
  104. /* bfind.c */
  105. extern int hfs_find_init(struct hfs_btree *, struct hfs_find_data *);
  106. extern void hfs_find_exit(struct hfs_find_data *);
  107. extern int __hfs_brec_find(struct hfs_bnode *, struct hfs_find_data *);
  108. extern int hfs_brec_find(struct hfs_find_data *);
  109. extern int hfs_brec_read(struct hfs_find_data *, void *, int);
  110. extern int hfs_brec_goto(struct hfs_find_data *, int);
  111. struct hfs_bnode_desc {
  112. __be32 next; /* (V) Number of the next node at this level */
  113. __be32 prev; /* (V) Number of the prev node at this level */
  114. u8 type; /* (F) The type of node */
  115. u8 height; /* (F) The level of this node (leaves=1) */
  116. __be16 num_recs; /* (V) The number of records in this node */
  117. u16 reserved;
  118. } __packed;
  119. #define HFS_NODE_INDEX 0x00 /* An internal (index) node */
  120. #define HFS_NODE_HEADER 0x01 /* The tree header node (node 0) */
  121. #define HFS_NODE_MAP 0x02 /* Holds part of the bitmap of used nodes */
  122. #define HFS_NODE_LEAF 0xFF /* A leaf (ndNHeight==1) node */
  123. struct hfs_btree_header_rec {
  124. __be16 depth; /* (V) The number of levels in this B-tree */
  125. __be32 root; /* (V) The node number of the root node */
  126. __be32 leaf_count; /* (V) The number of leaf records */
  127. __be32 leaf_head; /* (V) The number of the first leaf node */
  128. __be32 leaf_tail; /* (V) The number of the last leaf node */
  129. __be16 node_size; /* (F) The number of bytes in a node (=512) */
  130. __be16 max_key_len; /* (F) The length of a key in an index node */
  131. __be32 node_count; /* (V) The total number of nodes */
  132. __be32 free_nodes; /* (V) The number of unused nodes */
  133. u16 reserved1;
  134. __be32 clump_size; /* (F) clump size. not usually used. */
  135. u8 btree_type; /* (F) BTree type */
  136. u8 reserved2;
  137. __be32 attributes; /* (F) attributes */
  138. u32 reserved3[16];
  139. } __packed;
  140. #define BTREE_ATTR_BADCLOSE 0x00000001 /* b-tree not closed properly. not
  141. used by hfsplus. */
  142. #define HFS_TREE_BIGKEYS 0x00000002 /* key length is u16 instead of u8.
  143. used by hfsplus. */
  144. #define HFS_TREE_VARIDXKEYS 0x00000004 /* variable key length instead of
  145. max key length. use din catalog
  146. b-tree but not in extents
  147. b-tree (hfsplus). */