1 /*
2 * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
4 *
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
7 * published by the Free Software Foundation.
8 *
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.
13 *
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
17 */
18 #ifndef __XFS_DIR2_H__
19 #define __XFS_DIR2_H__
20
21 #include "xfs_da_format.h"
22 #include "xfs_da_btree.h"
23
24 struct xfs_defer_ops;
25 struct xfs_da_args;
26 struct xfs_inode;
27 struct xfs_mount;
28 struct xfs_trans;
29 struct xfs_dir2_sf_hdr;
30 struct xfs_dir2_sf_entry;
31 struct xfs_dir2_data_hdr;
32 struct xfs_dir2_data_entry;
33 struct xfs_dir2_data_unused;
34
35 extern struct xfs_name xfs_name_dotdot;
36
37 /*
38 * Convert inode mode to directory entry filetype
39 */
40 extern unsigned char xfs_mode_to_ftype(int mode);
41
42 /*
43 * directory operations vector for encode/decode routines
44 */
45 struct xfs_dir_ops {
46 int (*sf_entsize)(struct xfs_dir2_sf_hdr *hdr, int len);
47 struct xfs_dir2_sf_entry *
48 (*sf_nextentry)(struct xfs_dir2_sf_hdr *hdr,
49 struct xfs_dir2_sf_entry *sfep);
50 __uint8_t (*sf_get_ftype)(struct xfs_dir2_sf_entry *sfep);
51 void (*sf_put_ftype)(struct xfs_dir2_sf_entry *sfep,
52 __uint8_t ftype);
53 xfs_ino_t (*sf_get_ino)(struct xfs_dir2_sf_hdr *hdr,
54 struct xfs_dir2_sf_entry *sfep);
55 void (*sf_put_ino)(struct xfs_dir2_sf_hdr *hdr,
56 struct xfs_dir2_sf_entry *sfep,
57 xfs_ino_t ino);
58 xfs_ino_t (*sf_get_parent_ino)(struct xfs_dir2_sf_hdr *hdr);
59 void (*sf_put_parent_ino)(struct xfs_dir2_sf_hdr *hdr,
60 xfs_ino_t ino);
61
62 int (*data_entsize)(int len);
63 __uint8_t (*data_get_ftype)(struct xfs_dir2_data_entry *dep);
64 void (*data_put_ftype)(struct xfs_dir2_data_entry *dep,
65 __uint8_t ftype);
66 __be16 * (*data_entry_tag_p)(struct xfs_dir2_data_entry *dep);
67 struct xfs_dir2_data_free *
68 (*data_bestfree_p)(struct xfs_dir2_data_hdr *hdr);
69
70 xfs_dir2_data_aoff_t data_dot_offset;
71 xfs_dir2_data_aoff_t data_dotdot_offset;
72 xfs_dir2_data_aoff_t data_first_offset;
73 size_t data_entry_offset;
74
75 struct xfs_dir2_data_entry *
76 (*data_dot_entry_p)(struct xfs_dir2_data_hdr *hdr);
77 struct xfs_dir2_data_entry *
78 (*data_dotdot_entry_p)(struct xfs_dir2_data_hdr *hdr);
79 struct xfs_dir2_data_entry *
80 (*data_first_entry_p)(struct xfs_dir2_data_hdr *hdr);
81 struct xfs_dir2_data_entry *
82 (*data_entry_p)(struct xfs_dir2_data_hdr *hdr);
83 struct xfs_dir2_data_unused *
84 (*data_unused_p)(struct xfs_dir2_data_hdr *hdr);
85
86 int leaf_hdr_size;
87 void (*leaf_hdr_to_disk)(struct xfs_dir2_leaf *to,
88 struct xfs_dir3_icleaf_hdr *from);
89 void (*leaf_hdr_from_disk)(struct xfs_dir3_icleaf_hdr *to,
90 struct xfs_dir2_leaf *from);
91 int (*leaf_max_ents)(struct xfs_da_geometry *geo);
92 struct xfs_dir2_leaf_entry *
93 (*leaf_ents_p)(struct xfs_dir2_leaf *lp);
94
95 int node_hdr_size;
96 void (*node_hdr_to_disk)(struct xfs_da_intnode *to,
97 struct xfs_da3_icnode_hdr *from);
98 void (*node_hdr_from_disk)(struct xfs_da3_icnode_hdr *to,
99 struct xfs_da_intnode *from);
100 struct xfs_da_node_entry *
101 (*node_tree_p)(struct xfs_da_intnode *dap);
102
103 int free_hdr_size;
104 void (*free_hdr_to_disk)(struct xfs_dir2_free *to,
105 struct xfs_dir3_icfree_hdr *from);
106 void (*free_hdr_from_disk)(struct xfs_dir3_icfree_hdr *to,
107 struct xfs_dir2_free *from);
108 int (*free_max_bests)(struct xfs_da_geometry *geo);
109 __be16 * (*free_bests_p)(struct xfs_dir2_free *free);
110 xfs_dir2_db_t (*db_to_fdb)(struct xfs_da_geometry *geo,
111 xfs_dir2_db_t db);
112 int (*db_to_fdindex)(struct xfs_da_geometry *geo,
113 xfs_dir2_db_t db);
114 };
115
116 extern const struct xfs_dir_ops *
117 xfs_dir_get_ops(struct xfs_mount *mp, struct xfs_inode *dp);
118 extern const struct xfs_dir_ops *
119 xfs_nondir_get_ops(struct xfs_mount *mp, struct xfs_inode *dp);
120
121 /*
122 * Generic directory interface routines
123 */
124 extern void xfs_dir_startup(void);
125 extern int xfs_da_mount(struct xfs_mount *mp);
126 extern void xfs_da_unmount(struct xfs_mount *mp);
127
128 extern int xfs_dir_isempty(struct xfs_inode *dp);
129 extern int xfs_dir_init(struct xfs_trans *tp, struct xfs_inode *dp,
130 struct xfs_inode *pdp);
131 extern int xfs_dir_createname(struct xfs_trans *tp, struct xfs_inode *dp,
132 struct xfs_name *name, xfs_ino_t inum,
133 xfs_fsblock_t *first,
134 struct xfs_defer_ops *dfops, xfs_extlen_t tot);
135 extern int xfs_dir_lookup(struct xfs_trans *tp, struct xfs_inode *dp,
136 struct xfs_name *name, xfs_ino_t *inum,
137 struct xfs_name *ci_name);
138 extern int xfs_dir_removename(struct xfs_trans *tp, struct xfs_inode *dp,
139 struct xfs_name *name, xfs_ino_t ino,
140 xfs_fsblock_t *first,
141 struct xfs_defer_ops *dfops, xfs_extlen_t tot);
142 extern int xfs_dir_replace(struct xfs_trans *tp, struct xfs_inode *dp,
143 struct xfs_name *name, xfs_ino_t inum,
144 xfs_fsblock_t *first,
145 struct xfs_defer_ops *dfops, xfs_extlen_t tot);
146 extern int xfs_dir_canenter(struct xfs_trans *tp, struct xfs_inode *dp,
147 struct xfs_name *name);
148
149 /*
150 * Direct call from the bmap code, bypassing the generic directory layer.
151 */
152 extern int xfs_dir2_sf_to_block(struct xfs_da_args *args);
153
154 /*
155 * Interface routines used by userspace utilities
156 */
157 extern int xfs_dir2_isblock(struct xfs_da_args *args, int *r);
158 extern int xfs_dir2_isleaf(struct xfs_da_args *args, int *r);
159 extern int xfs_dir2_shrink_inode(struct xfs_da_args *args, xfs_dir2_db_t db,
160 struct xfs_buf *bp);
161
162 extern void xfs_dir2_data_freescan(struct xfs_inode *dp,
163 struct xfs_dir2_data_hdr *hdr, int *loghead);
164 extern void xfs_dir2_data_log_entry(struct xfs_da_args *args,
165 struct xfs_buf *bp, struct xfs_dir2_data_entry *dep);
166 extern void xfs_dir2_data_log_header(struct xfs_da_args *args,
167 struct xfs_buf *bp);
168 extern void xfs_dir2_data_log_unused(struct xfs_da_args *args,
169 struct xfs_buf *bp, struct xfs_dir2_data_unused *dup);
170 extern void xfs_dir2_data_make_free(struct xfs_da_args *args,
171 struct xfs_buf *bp, xfs_dir2_data_aoff_t offset,
172 xfs_dir2_data_aoff_t len, int *needlogp, int *needscanp);
173 extern void xfs_dir2_data_use_free(struct xfs_da_args *args,
174 struct xfs_buf *bp, struct xfs_dir2_data_unused *dup,
175 xfs_dir2_data_aoff_t offset, xfs_dir2_data_aoff_t len,
176 int *needlogp, int *needscanp);
177
178 extern struct xfs_dir2_data_free *xfs_dir2_data_freefind(
179 struct xfs_dir2_data_hdr *hdr, struct xfs_dir2_data_free *bf,
180 struct xfs_dir2_data_unused *dup);
181
182 extern const struct xfs_buf_ops xfs_dir3_block_buf_ops;
183 extern const struct xfs_buf_ops xfs_dir3_leafn_buf_ops;
184 extern const struct xfs_buf_ops xfs_dir3_leaf1_buf_ops;
185 extern const struct xfs_buf_ops xfs_dir3_free_buf_ops;
186 extern const struct xfs_buf_ops xfs_dir3_data_buf_ops;
187
188 /*
189 * Directory offset/block conversion functions.
190 *
191 * DB blocks here are logical directory block numbers, not filesystem blocks.
192 */
193
194 /*
195 * Convert dataptr to byte in file space
196 */
197 static inline xfs_dir2_off_t
xfs_dir2_dataptr_to_byte(xfs_dir2_dataptr_t dp)198 xfs_dir2_dataptr_to_byte(xfs_dir2_dataptr_t dp)
199 {
200 return (xfs_dir2_off_t)dp << XFS_DIR2_DATA_ALIGN_LOG;
201 }
202
203 /*
204 * Convert byte in file space to dataptr. It had better be aligned.
205 */
206 static inline xfs_dir2_dataptr_t
xfs_dir2_byte_to_dataptr(xfs_dir2_off_t by)207 xfs_dir2_byte_to_dataptr(xfs_dir2_off_t by)
208 {
209 return (xfs_dir2_dataptr_t)(by >> XFS_DIR2_DATA_ALIGN_LOG);
210 }
211
212 /*
213 * Convert byte in space to (DB) block
214 */
215 static inline xfs_dir2_db_t
xfs_dir2_byte_to_db(struct xfs_da_geometry * geo,xfs_dir2_off_t by)216 xfs_dir2_byte_to_db(struct xfs_da_geometry *geo, xfs_dir2_off_t by)
217 {
218 return (xfs_dir2_db_t)(by >> geo->blklog);
219 }
220
221 /*
222 * Convert dataptr to a block number
223 */
224 static inline xfs_dir2_db_t
xfs_dir2_dataptr_to_db(struct xfs_da_geometry * geo,xfs_dir2_dataptr_t dp)225 xfs_dir2_dataptr_to_db(struct xfs_da_geometry *geo, xfs_dir2_dataptr_t dp)
226 {
227 return xfs_dir2_byte_to_db(geo, xfs_dir2_dataptr_to_byte(dp));
228 }
229
230 /*
231 * Convert byte in space to offset in a block
232 */
233 static inline xfs_dir2_data_aoff_t
xfs_dir2_byte_to_off(struct xfs_da_geometry * geo,xfs_dir2_off_t by)234 xfs_dir2_byte_to_off(struct xfs_da_geometry *geo, xfs_dir2_off_t by)
235 {
236 return (xfs_dir2_data_aoff_t)(by & (geo->blksize - 1));
237 }
238
239 /*
240 * Convert dataptr to a byte offset in a block
241 */
242 static inline xfs_dir2_data_aoff_t
xfs_dir2_dataptr_to_off(struct xfs_da_geometry * geo,xfs_dir2_dataptr_t dp)243 xfs_dir2_dataptr_to_off(struct xfs_da_geometry *geo, xfs_dir2_dataptr_t dp)
244 {
245 return xfs_dir2_byte_to_off(geo, xfs_dir2_dataptr_to_byte(dp));
246 }
247
248 /*
249 * Convert block and offset to byte in space
250 */
251 static inline xfs_dir2_off_t
xfs_dir2_db_off_to_byte(struct xfs_da_geometry * geo,xfs_dir2_db_t db,xfs_dir2_data_aoff_t o)252 xfs_dir2_db_off_to_byte(struct xfs_da_geometry *geo, xfs_dir2_db_t db,
253 xfs_dir2_data_aoff_t o)
254 {
255 return ((xfs_dir2_off_t)db << geo->blklog) + o;
256 }
257
258 /*
259 * Convert block (DB) to block (dablk)
260 */
261 static inline xfs_dablk_t
xfs_dir2_db_to_da(struct xfs_da_geometry * geo,xfs_dir2_db_t db)262 xfs_dir2_db_to_da(struct xfs_da_geometry *geo, xfs_dir2_db_t db)
263 {
264 return (xfs_dablk_t)(db << (geo->blklog - geo->fsblog));
265 }
266
267 /*
268 * Convert byte in space to (DA) block
269 */
270 static inline xfs_dablk_t
xfs_dir2_byte_to_da(struct xfs_da_geometry * geo,xfs_dir2_off_t by)271 xfs_dir2_byte_to_da(struct xfs_da_geometry *geo, xfs_dir2_off_t by)
272 {
273 return xfs_dir2_db_to_da(geo, xfs_dir2_byte_to_db(geo, by));
274 }
275
276 /*
277 * Convert block and offset to dataptr
278 */
279 static inline xfs_dir2_dataptr_t
xfs_dir2_db_off_to_dataptr(struct xfs_da_geometry * geo,xfs_dir2_db_t db,xfs_dir2_data_aoff_t o)280 xfs_dir2_db_off_to_dataptr(struct xfs_da_geometry *geo, xfs_dir2_db_t db,
281 xfs_dir2_data_aoff_t o)
282 {
283 return xfs_dir2_byte_to_dataptr(xfs_dir2_db_off_to_byte(geo, db, o));
284 }
285
286 /*
287 * Convert block (dablk) to block (DB)
288 */
289 static inline xfs_dir2_db_t
xfs_dir2_da_to_db(struct xfs_da_geometry * geo,xfs_dablk_t da)290 xfs_dir2_da_to_db(struct xfs_da_geometry *geo, xfs_dablk_t da)
291 {
292 return (xfs_dir2_db_t)(da >> (geo->blklog - geo->fsblog));
293 }
294
295 /*
296 * Convert block (dablk) to byte offset in space
297 */
298 static inline xfs_dir2_off_t
xfs_dir2_da_to_byte(struct xfs_da_geometry * geo,xfs_dablk_t da)299 xfs_dir2_da_to_byte(struct xfs_da_geometry *geo, xfs_dablk_t da)
300 {
301 return xfs_dir2_db_off_to_byte(geo, xfs_dir2_da_to_db(geo, da), 0);
302 }
303
304 /*
305 * Directory tail pointer accessor functions. Based on block geometry.
306 */
307 static inline struct xfs_dir2_block_tail *
xfs_dir2_block_tail_p(struct xfs_da_geometry * geo,struct xfs_dir2_data_hdr * hdr)308 xfs_dir2_block_tail_p(struct xfs_da_geometry *geo, struct xfs_dir2_data_hdr *hdr)
309 {
310 return ((struct xfs_dir2_block_tail *)
311 ((char *)hdr + geo->blksize)) - 1;
312 }
313
314 static inline struct xfs_dir2_leaf_tail *
xfs_dir2_leaf_tail_p(struct xfs_da_geometry * geo,struct xfs_dir2_leaf * lp)315 xfs_dir2_leaf_tail_p(struct xfs_da_geometry *geo, struct xfs_dir2_leaf *lp)
316 {
317 return (struct xfs_dir2_leaf_tail *)
318 ((char *)lp + geo->blksize -
319 sizeof(struct xfs_dir2_leaf_tail));
320 }
321
322 #endif /* __XFS_DIR2_H__ */
323