Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
7b718769 NS |
2 | * Copyright (c) 2000,2002,2005 Silicon Graphics, Inc. |
3 | * All Rights Reserved. | |
1da177e4 | 4 | * |
7b718769 NS |
5 | * This program is free software; you can redistribute it and/or |
6 | * modify it under the terms of the GNU General Public License as | |
1da177e4 LT |
7 | * published by the Free Software Foundation. |
8 | * | |
7b718769 NS |
9 | * This program is distributed in the hope that it would be useful, |
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | * GNU General Public License for more details. | |
1da177e4 | 13 | * |
7b718769 NS |
14 | * You should have received a copy of the GNU General Public License |
15 | * along with this program; if not, write the Free Software Foundation, | |
16 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
1da177e4 LT |
17 | */ |
18 | #ifndef __XFS_DA_BTREE_H__ | |
19 | #define __XFS_DA_BTREE_H__ | |
20 | ||
21 | struct xfs_buf; | |
22 | struct xfs_bmap_free; | |
23 | struct xfs_inode; | |
24 | struct xfs_mount; | |
25 | struct xfs_trans; | |
26 | struct zone; | |
27 | ||
28 | /*======================================================================== | |
29 | * Directory Structure when greater than XFS_LBSIZE(mp) bytes. | |
30 | *========================================================================*/ | |
31 | ||
32 | /* | |
33 | * This structure is common to both leaf nodes and non-leaf nodes in the Btree. | |
34 | * | |
35 | * Is is used to manage a doubly linked list of all blocks at the same | |
36 | * level in the Btree, and to identify which type of block this is. | |
37 | */ | |
38 | #define XFS_DA_NODE_MAGIC 0xfebe /* magic number: non-leaf blocks */ | |
1da177e4 LT |
39 | #define XFS_ATTR_LEAF_MAGIC 0xfbee /* magic number: attribute leaf blks */ |
40 | #define XFS_DIR2_LEAF1_MAGIC 0xd2f1 /* magic number: v2 dirlf single blks */ | |
41 | #define XFS_DIR2_LEAFN_MAGIC 0xd2ff /* magic number: v2 dirlf multi blks */ | |
42 | ||
1da177e4 | 43 | typedef struct xfs_da_blkinfo { |
89da0544 NS |
44 | __be32 forw; /* previous block in list */ |
45 | __be32 back; /* following block in list */ | |
46 | __be16 magic; /* validity check on block */ | |
47 | __be16 pad; /* unused */ | |
1da177e4 LT |
48 | } xfs_da_blkinfo_t; |
49 | ||
50 | /* | |
51 | * This is the structure of the root and intermediate nodes in the Btree. | |
52 | * The leaf nodes are defined above. | |
53 | * | |
54 | * Entries are not packed. | |
55 | * | |
56 | * Since we have duplicate keys, use a binary search but always follow | |
57 | * all match in the block, not just the first match found. | |
58 | */ | |
59 | #define XFS_DA_NODE_MAXDEPTH 5 /* max depth of Btree */ | |
60 | ||
61 | typedef struct xfs_da_intnode { | |
62 | struct xfs_da_node_hdr { /* constant-structure header block */ | |
63 | xfs_da_blkinfo_t info; /* block type, links, etc. */ | |
fac80cce NS |
64 | __be16 count; /* count of active entries */ |
65 | __be16 level; /* level above leaves (leaf == 0) */ | |
1da177e4 LT |
66 | } hdr; |
67 | struct xfs_da_node_entry { | |
403432dc NS |
68 | __be32 hashval; /* hash value for this descendant */ |
69 | __be32 before; /* Btree block before this key */ | |
1da177e4 LT |
70 | } btree[1]; /* variable sized array of keys */ |
71 | } xfs_da_intnode_t; | |
72 | typedef struct xfs_da_node_hdr xfs_da_node_hdr_t; | |
73 | typedef struct xfs_da_node_entry xfs_da_node_entry_t; | |
74 | ||
75 | #define XFS_DA_MAXHASH ((xfs_dahash_t)-1) /* largest valid hash value */ | |
76 | ||
a844f451 NS |
77 | #define XFS_LBSIZE(mp) (mp)->m_sb.sb_blocksize |
78 | #define XFS_LBLOG(mp) (mp)->m_sb.sb_blocklog | |
1da177e4 | 79 | |
1da177e4 | 80 | #define XFS_DA_MAKE_BNOENTRY(mp,bno,entry) \ |
1da177e4 | 81 | (((bno) << (mp)->m_dircook_elog) | (entry)) |
1da177e4 | 82 | #define XFS_DA_MAKE_COOKIE(mp,bno,entry,hash) \ |
1da177e4 | 83 | (((xfs_off_t)XFS_DA_MAKE_BNOENTRY(mp, bno, entry) << 32) | (hash)) |
a844f451 NS |
84 | #define XFS_DA_COOKIE_HASH(mp,cookie) ((xfs_dahash_t)cookie) |
85 | #define XFS_DA_COOKIE_BNO(mp,cookie) \ | |
86 | ((((xfs_off_t)(cookie) >> 31) == -1LL ? \ | |
1da177e4 | 87 | (xfs_dablk_t)0 : \ |
a844f451 NS |
88 | (xfs_dablk_t)((xfs_off_t)(cookie) >> \ |
89 | ((mp)->m_dircook_elog + 32)))) | |
90 | #define XFS_DA_COOKIE_ENTRY(mp,cookie) \ | |
91 | ((((xfs_off_t)(cookie) >> 31) == -1LL ? \ | |
1da177e4 LT |
92 | (xfs_dablk_t)0 : \ |
93 | (xfs_dablk_t)(((xfs_off_t)(cookie) >> 32) & \ | |
a844f451 | 94 | ((1 << (mp)->m_dircook_elog) - 1)))) |
1da177e4 LT |
95 | |
96 | ||
97 | /*======================================================================== | |
98 | * Btree searching and modification structure definitions. | |
99 | *========================================================================*/ | |
100 | ||
5163f95a BN |
101 | /* |
102 | * Search comparison results | |
103 | */ | |
104 | enum xfs_dacmp { | |
105 | XFS_CMP_DIFFERENT, /* names are completely different */ | |
106 | XFS_CMP_EXACT, /* names are exactly the same */ | |
107 | XFS_CMP_CASE /* names are same but differ in case */ | |
108 | }; | |
109 | ||
1da177e4 LT |
110 | /* |
111 | * Structure to ease passing around component names. | |
112 | */ | |
113 | typedef struct xfs_da_args { | |
80cce779 | 114 | const uchar_t *name; /* string (maybe not NULL terminated) */ |
1da177e4 LT |
115 | int namelen; /* length of string (maybe no NULL) */ |
116 | uchar_t *value; /* set of bytes (maybe contain NULLs) */ | |
117 | int valuelen; /* length of value */ | |
118 | int flags; /* argument flags (eg: ATTR_NOCREATE) */ | |
119 | xfs_dahash_t hashval; /* hash value of name */ | |
120 | xfs_ino_t inumber; /* input/output inode number */ | |
121 | struct xfs_inode *dp; /* directory inode to manipulate */ | |
122 | xfs_fsblock_t *firstblock; /* ptr to firstblock for bmap calls */ | |
123 | struct xfs_bmap_free *flist; /* ptr to freelist for bmap_finish */ | |
124 | struct xfs_trans *trans; /* current trans (changes over time) */ | |
125 | xfs_extlen_t total; /* total blocks needed, for 1st bmap */ | |
126 | int whichfork; /* data or attribute fork */ | |
127 | xfs_dablk_t blkno; /* blkno of attr leaf of interest */ | |
128 | int index; /* index of attr of interest in blk */ | |
129 | xfs_dablk_t rmtblkno; /* remote attr value starting blkno */ | |
130 | int rmtblkcnt; /* remote attr value block count */ | |
131 | xfs_dablk_t blkno2; /* blkno of 2nd attr leaf of interest */ | |
132 | int index2; /* index of 2nd attr in blk */ | |
133 | xfs_dablk_t rmtblkno2; /* remote attr value starting blkno */ | |
134 | int rmtblkcnt2; /* remote attr value block count */ | |
135 | unsigned char justcheck; /* T/F: check for ok with no space */ | |
136 | unsigned char rename; /* T/F: this is an atomic rename op */ | |
137 | unsigned char addname; /* T/F: this is an add operation */ | |
138 | unsigned char oknoent; /* T/F: ok to return ENOENT, else die */ | |
5163f95a | 139 | enum xfs_dacmp cmpresult; /* name compare result for lookups */ |
1da177e4 LT |
140 | } xfs_da_args_t; |
141 | ||
142 | /* | |
143 | * Structure to describe buffer(s) for a block. | |
144 | * This is needed in the directory version 2 format case, when | |
145 | * multiple non-contiguous fsblocks might be needed to cover one | |
146 | * logical directory block. | |
147 | * If the buffer count is 1 then the data pointer points to the | |
148 | * same place as the b_addr field for the buffer, else to kmem_alloced memory. | |
149 | */ | |
150 | typedef struct xfs_dabuf { | |
151 | int nbuf; /* number of buffer pointers present */ | |
152 | short dirty; /* data needs to be copied back */ | |
153 | short bbcount; /* how large is data in bbs */ | |
154 | void *data; /* pointer for buffers' data */ | |
155 | #ifdef XFS_DABUF_DEBUG | |
156 | inst_t *ra; /* return address of caller to make */ | |
157 | struct xfs_dabuf *next; /* next in global chain */ | |
158 | struct xfs_dabuf *prev; /* previous in global chain */ | |
159 | struct xfs_buftarg *target; /* device for buffer */ | |
160 | xfs_daddr_t blkno; /* daddr first in bps[0] */ | |
161 | #endif | |
162 | struct xfs_buf *bps[1]; /* actually nbuf of these */ | |
163 | } xfs_dabuf_t; | |
164 | #define XFS_DA_BUF_SIZE(n) \ | |
165 | (sizeof(xfs_dabuf_t) + sizeof(struct xfs_buf *) * ((n) - 1)) | |
166 | ||
167 | #ifdef XFS_DABUF_DEBUG | |
168 | extern xfs_dabuf_t *xfs_dabuf_global_list; | |
169 | #endif | |
170 | ||
171 | /* | |
172 | * Storage for holding state during Btree searches and split/join ops. | |
173 | * | |
174 | * Only need space for 5 intermediate nodes. With a minimum of 62-way | |
175 | * fanout to the Btree, we can support over 900 million directory blocks, | |
176 | * which is slightly more than enough. | |
177 | */ | |
178 | typedef struct xfs_da_state_blk { | |
179 | xfs_dabuf_t *bp; /* buffer containing block */ | |
180 | xfs_dablk_t blkno; /* filesystem blkno of buffer */ | |
181 | xfs_daddr_t disk_blkno; /* on-disk blkno (in BBs) of buffer */ | |
182 | int index; /* relevant index into block */ | |
183 | xfs_dahash_t hashval; /* last hash value in block */ | |
184 | int magic; /* blk's magic number, ie: blk type */ | |
185 | } xfs_da_state_blk_t; | |
186 | ||
187 | typedef struct xfs_da_state_path { | |
188 | int active; /* number of active levels */ | |
189 | xfs_da_state_blk_t blk[XFS_DA_NODE_MAXDEPTH]; | |
190 | } xfs_da_state_path_t; | |
191 | ||
192 | typedef struct xfs_da_state { | |
193 | xfs_da_args_t *args; /* filename arguments */ | |
194 | struct xfs_mount *mp; /* filesystem mount point */ | |
195 | unsigned int blocksize; /* logical block size */ | |
196 | unsigned int node_ents; /* how many entries in danode */ | |
197 | xfs_da_state_path_t path; /* search/split paths */ | |
198 | xfs_da_state_path_t altpath; /* alternate path for join */ | |
199 | unsigned char inleaf; /* insert into 1->lf, 0->splf */ | |
200 | unsigned char extravalid; /* T/F: extrablk is in use */ | |
201 | unsigned char extraafter; /* T/F: extrablk is after new */ | |
202 | xfs_da_state_blk_t extrablk; /* for double-splits on leafs */ | |
203 | /* for dirv2 extrablk is data */ | |
204 | } xfs_da_state_t; | |
205 | ||
206 | /* | |
207 | * Utility macros to aid in logging changed structure fields. | |
208 | */ | |
209 | #define XFS_DA_LOGOFF(BASE, ADDR) ((char *)(ADDR) - (char *)(BASE)) | |
210 | #define XFS_DA_LOGRANGE(BASE, ADDR, SIZE) \ | |
211 | (uint)(XFS_DA_LOGOFF(BASE, ADDR)), \ | |
212 | (uint)(XFS_DA_LOGOFF(BASE, ADDR)+(SIZE)-1) | |
213 | ||
5163f95a BN |
214 | /* |
215 | * Name ops for directory and/or attr name operations | |
216 | */ | |
217 | struct xfs_nameops { | |
218 | xfs_dahash_t (*hashname)(struct xfs_name *); | |
219 | enum xfs_dacmp (*compname)(struct xfs_da_args *, const char *, int); | |
220 | }; | |
221 | ||
1da177e4 LT |
222 | |
223 | #ifdef __KERNEL__ | |
224 | /*======================================================================== | |
225 | * Function prototypes for the kernel. | |
226 | *========================================================================*/ | |
227 | ||
228 | /* | |
229 | * Routines used for growing the Btree. | |
230 | */ | |
231 | int xfs_da_node_create(xfs_da_args_t *args, xfs_dablk_t blkno, int level, | |
232 | xfs_dabuf_t **bpp, int whichfork); | |
233 | int xfs_da_split(xfs_da_state_t *state); | |
234 | ||
235 | /* | |
236 | * Routines used for shrinking the Btree. | |
237 | */ | |
238 | int xfs_da_join(xfs_da_state_t *state); | |
239 | void xfs_da_fixhashpath(xfs_da_state_t *state, | |
240 | xfs_da_state_path_t *path_to_to_fix); | |
241 | ||
242 | /* | |
243 | * Routines used for finding things in the Btree. | |
244 | */ | |
245 | int xfs_da_node_lookup_int(xfs_da_state_t *state, int *result); | |
246 | int xfs_da_path_shift(xfs_da_state_t *state, xfs_da_state_path_t *path, | |
247 | int forward, int release, int *result); | |
248 | /* | |
249 | * Utility routines. | |
250 | */ | |
1da177e4 LT |
251 | int xfs_da_blk_link(xfs_da_state_t *state, xfs_da_state_blk_t *old_blk, |
252 | xfs_da_state_blk_t *new_blk); | |
253 | ||
254 | /* | |
255 | * Utility routines. | |
256 | */ | |
257 | int xfs_da_grow_inode(xfs_da_args_t *args, xfs_dablk_t *new_blkno); | |
258 | int xfs_da_get_buf(struct xfs_trans *trans, struct xfs_inode *dp, | |
259 | xfs_dablk_t bno, xfs_daddr_t mappedbno, | |
260 | xfs_dabuf_t **bp, int whichfork); | |
261 | int xfs_da_read_buf(struct xfs_trans *trans, struct xfs_inode *dp, | |
262 | xfs_dablk_t bno, xfs_daddr_t mappedbno, | |
263 | xfs_dabuf_t **bpp, int whichfork); | |
264 | xfs_daddr_t xfs_da_reada_buf(struct xfs_trans *trans, struct xfs_inode *dp, | |
265 | xfs_dablk_t bno, int whichfork); | |
266 | int xfs_da_shrink_inode(xfs_da_args_t *args, xfs_dablk_t dead_blkno, | |
267 | xfs_dabuf_t *dead_buf); | |
268 | ||
80cce779 | 269 | uint xfs_da_hashname(const uchar_t *name_string, int name_length); |
5163f95a BN |
270 | enum xfs_dacmp xfs_da_compname(struct xfs_da_args *args, |
271 | const char *name, int len); | |
272 | ||
273 | ||
1da177e4 LT |
274 | xfs_da_state_t *xfs_da_state_alloc(void); |
275 | void xfs_da_state_free(xfs_da_state_t *state); | |
1da177e4 LT |
276 | |
277 | void xfs_da_buf_done(xfs_dabuf_t *dabuf); | |
278 | void xfs_da_log_buf(struct xfs_trans *tp, xfs_dabuf_t *dabuf, uint first, | |
279 | uint last); | |
280 | void xfs_da_brelse(struct xfs_trans *tp, xfs_dabuf_t *dabuf); | |
281 | void xfs_da_binval(struct xfs_trans *tp, xfs_dabuf_t *dabuf); | |
282 | xfs_daddr_t xfs_da_blkno(xfs_dabuf_t *dabuf); | |
283 | ||
284 | extern struct kmem_zone *xfs_da_state_zone; | |
a8272ce0 | 285 | extern struct kmem_zone *xfs_dabuf_zone; |
1da177e4 LT |
286 | #endif /* __KERNEL__ */ |
287 | ||
288 | #endif /* __XFS_DA_BTREE_H__ */ |