Commit | Line | Data |
---|---|---|
0b61f8a4 | 1 | // SPDX-License-Identifier: GPL-2.0 |
1da177e4 | 2 | /* |
7b718769 NS |
3 | * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc. |
4 | * All Rights Reserved. | |
1da177e4 LT |
5 | */ |
6 | #ifndef __XFS_DIR2_H__ | |
57926640 | 7 | #define __XFS_DIR2_H__ |
1da177e4 | 8 | |
b597dd53 AG |
9 | #include "xfs_da_format.h" |
10 | #include "xfs_da_btree.h" | |
11 | ||
310a75a3 | 12 | struct xfs_defer_ops; |
57926640 | 13 | struct xfs_da_args; |
1da177e4 | 14 | struct xfs_inode; |
f6c2d1fa | 15 | struct xfs_mount; |
1da177e4 | 16 | struct xfs_trans; |
2b9ab5ab DC |
17 | struct xfs_dir2_sf_hdr; |
18 | struct xfs_dir2_sf_entry; | |
19 | struct xfs_dir2_data_hdr; | |
20 | struct xfs_dir2_data_entry; | |
21 | struct xfs_dir2_data_unused; | |
1da177e4 | 22 | |
556b8b16 BN |
23 | extern struct xfs_name xfs_name_dotdot; |
24 | ||
1b767ee3 | 25 | /* |
1fc4d33f | 26 | * Convert inode mode to directory entry filetype |
1b767ee3 | 27 | */ |
fd29f7af | 28 | extern unsigned char xfs_mode_to_ftype(int mode); |
1b767ee3 | 29 | |
32c5483a DC |
30 | /* |
31 | * directory operations vector for encode/decode routines | |
32 | */ | |
33 | struct xfs_dir_ops { | |
34 | int (*sf_entsize)(struct xfs_dir2_sf_hdr *hdr, int len); | |
35 | struct xfs_dir2_sf_entry * | |
36 | (*sf_nextentry)(struct xfs_dir2_sf_hdr *hdr, | |
37 | struct xfs_dir2_sf_entry *sfep); | |
c8ce540d | 38 | uint8_t (*sf_get_ftype)(struct xfs_dir2_sf_entry *sfep); |
4740175e | 39 | void (*sf_put_ftype)(struct xfs_dir2_sf_entry *sfep, |
c8ce540d | 40 | uint8_t ftype); |
4740175e DC |
41 | xfs_ino_t (*sf_get_ino)(struct xfs_dir2_sf_hdr *hdr, |
42 | struct xfs_dir2_sf_entry *sfep); | |
43 | void (*sf_put_ino)(struct xfs_dir2_sf_hdr *hdr, | |
44 | struct xfs_dir2_sf_entry *sfep, | |
45 | xfs_ino_t ino); | |
46 | xfs_ino_t (*sf_get_parent_ino)(struct xfs_dir2_sf_hdr *hdr); | |
47 | void (*sf_put_parent_ino)(struct xfs_dir2_sf_hdr *hdr, | |
48 | xfs_ino_t ino); | |
9d23fc85 DC |
49 | |
50 | int (*data_entsize)(int len); | |
c8ce540d | 51 | uint8_t (*data_get_ftype)(struct xfs_dir2_data_entry *dep); |
9d23fc85 | 52 | void (*data_put_ftype)(struct xfs_dir2_data_entry *dep, |
c8ce540d | 53 | uint8_t ftype); |
9d23fc85 | 54 | __be16 * (*data_entry_tag_p)(struct xfs_dir2_data_entry *dep); |
2ca98774 DC |
55 | struct xfs_dir2_data_free * |
56 | (*data_bestfree_p)(struct xfs_dir2_data_hdr *hdr); | |
9d23fc85 | 57 | |
1c9a5b2e DC |
58 | xfs_dir2_data_aoff_t data_dot_offset; |
59 | xfs_dir2_data_aoff_t data_dotdot_offset; | |
60 | xfs_dir2_data_aoff_t data_first_offset; | |
61 | size_t data_entry_offset; | |
2ca98774 | 62 | |
9d23fc85 DC |
63 | struct xfs_dir2_data_entry * |
64 | (*data_dot_entry_p)(struct xfs_dir2_data_hdr *hdr); | |
65 | struct xfs_dir2_data_entry * | |
66 | (*data_dotdot_entry_p)(struct xfs_dir2_data_hdr *hdr); | |
67 | struct xfs_dir2_data_entry * | |
68 | (*data_first_entry_p)(struct xfs_dir2_data_hdr *hdr); | |
2ca98774 DC |
69 | struct xfs_dir2_data_entry * |
70 | (*data_entry_p)(struct xfs_dir2_data_hdr *hdr); | |
71 | struct xfs_dir2_data_unused * | |
72 | (*data_unused_p)(struct xfs_dir2_data_hdr *hdr); | |
4141956a | 73 | |
1c9a5b2e | 74 | int leaf_hdr_size; |
01ba43b8 DC |
75 | void (*leaf_hdr_to_disk)(struct xfs_dir2_leaf *to, |
76 | struct xfs_dir3_icleaf_hdr *from); | |
77 | void (*leaf_hdr_from_disk)(struct xfs_dir3_icleaf_hdr *to, | |
78 | struct xfs_dir2_leaf *from); | |
8f66193c | 79 | int (*leaf_max_ents)(struct xfs_da_geometry *geo); |
4141956a DC |
80 | struct xfs_dir2_leaf_entry * |
81 | (*leaf_ents_p)(struct xfs_dir2_leaf *lp); | |
4bceb18f | 82 | |
1c9a5b2e | 83 | int node_hdr_size; |
01ba43b8 DC |
84 | void (*node_hdr_to_disk)(struct xfs_da_intnode *to, |
85 | struct xfs_da3_icnode_hdr *from); | |
86 | void (*node_hdr_from_disk)(struct xfs_da3_icnode_hdr *to, | |
87 | struct xfs_da_intnode *from); | |
4bceb18f DC |
88 | struct xfs_da_node_entry * |
89 | (*node_tree_p)(struct xfs_da_intnode *dap); | |
01ba43b8 | 90 | |
1c9a5b2e | 91 | int free_hdr_size; |
01ba43b8 DC |
92 | void (*free_hdr_to_disk)(struct xfs_dir2_free *to, |
93 | struct xfs_dir3_icfree_hdr *from); | |
94 | void (*free_hdr_from_disk)(struct xfs_dir3_icfree_hdr *to, | |
95 | struct xfs_dir2_free *from); | |
8f66193c | 96 | int (*free_max_bests)(struct xfs_da_geometry *geo); |
24dd0f54 | 97 | __be16 * (*free_bests_p)(struct xfs_dir2_free *free); |
8f66193c DC |
98 | xfs_dir2_db_t (*db_to_fdb)(struct xfs_da_geometry *geo, |
99 | xfs_dir2_db_t db); | |
100 | int (*db_to_fdindex)(struct xfs_da_geometry *geo, | |
101 | xfs_dir2_db_t db); | |
32c5483a DC |
102 | }; |
103 | ||
4141956a DC |
104 | extern const struct xfs_dir_ops * |
105 | xfs_dir_get_ops(struct xfs_mount *mp, struct xfs_inode *dp); | |
4bceb18f DC |
106 | extern const struct xfs_dir_ops * |
107 | xfs_nondir_get_ops(struct xfs_mount *mp, struct xfs_inode *dp); | |
32c5483a | 108 | |
1da177e4 | 109 | /* |
f6c2d1fa NS |
110 | * Generic directory interface routines |
111 | */ | |
112 | extern void xfs_dir_startup(void); | |
0650b554 DC |
113 | extern int xfs_da_mount(struct xfs_mount *mp); |
114 | extern void xfs_da_unmount(struct xfs_mount *mp); | |
115 | ||
f6c2d1fa NS |
116 | extern int xfs_dir_isempty(struct xfs_inode *dp); |
117 | extern int xfs_dir_init(struct xfs_trans *tp, struct xfs_inode *dp, | |
118 | struct xfs_inode *pdp); | |
119 | extern int xfs_dir_createname(struct xfs_trans *tp, struct xfs_inode *dp, | |
556b8b16 | 120 | struct xfs_name *name, xfs_ino_t inum, |
f6c2d1fa | 121 | xfs_fsblock_t *first, |
2c3234d1 | 122 | struct xfs_defer_ops *dfops, xfs_extlen_t tot); |
f6c2d1fa | 123 | extern int xfs_dir_lookup(struct xfs_trans *tp, struct xfs_inode *dp, |
384f3ced BN |
124 | struct xfs_name *name, xfs_ino_t *inum, |
125 | struct xfs_name *ci_name); | |
f6c2d1fa | 126 | extern int xfs_dir_removename(struct xfs_trans *tp, struct xfs_inode *dp, |
556b8b16 | 127 | struct xfs_name *name, xfs_ino_t ino, |
f6c2d1fa | 128 | xfs_fsblock_t *first, |
2c3234d1 | 129 | struct xfs_defer_ops *dfops, xfs_extlen_t tot); |
f6c2d1fa | 130 | extern int xfs_dir_replace(struct xfs_trans *tp, struct xfs_inode *dp, |
556b8b16 | 131 | struct xfs_name *name, xfs_ino_t inum, |
f6c2d1fa | 132 | xfs_fsblock_t *first, |
2c3234d1 | 133 | struct xfs_defer_ops *dfops, xfs_extlen_t tot); |
f6c2d1fa | 134 | extern int xfs_dir_canenter(struct xfs_trans *tp, struct xfs_inode *dp, |
94f3cad5 | 135 | struct xfs_name *name); |
f6c2d1fa NS |
136 | |
137 | /* | |
57926640 | 138 | * Direct call from the bmap code, bypassing the generic directory layer. |
1da177e4 | 139 | */ |
57926640 | 140 | extern int xfs_dir2_sf_to_block(struct xfs_da_args *args); |
384f3ced | 141 | |
2b9ab5ab DC |
142 | /* |
143 | * Interface routines used by userspace utilities | |
144 | */ | |
53f82db0 DC |
145 | extern int xfs_dir2_isblock(struct xfs_da_args *args, int *r); |
146 | extern int xfs_dir2_isleaf(struct xfs_da_args *args, int *r); | |
2b9ab5ab DC |
147 | extern int xfs_dir2_shrink_inode(struct xfs_da_args *args, xfs_dir2_db_t db, |
148 | struct xfs_buf *bp); | |
149 | ||
523b2e76 DW |
150 | extern void xfs_dir2_data_freescan_int(struct xfs_da_geometry *geo, |
151 | const struct xfs_dir_ops *ops, | |
152 | struct xfs_dir2_data_hdr *hdr, int *loghead); | |
9d23fc85 | 153 | extern void xfs_dir2_data_freescan(struct xfs_inode *dp, |
2b9ab5ab | 154 | struct xfs_dir2_data_hdr *hdr, int *loghead); |
bc85178a | 155 | extern void xfs_dir2_data_log_entry(struct xfs_da_args *args, |
9d23fc85 | 156 | struct xfs_buf *bp, struct xfs_dir2_data_entry *dep); |
bc85178a | 157 | extern void xfs_dir2_data_log_header(struct xfs_da_args *args, |
2b9ab5ab | 158 | struct xfs_buf *bp); |
bc85178a DC |
159 | extern void xfs_dir2_data_log_unused(struct xfs_da_args *args, |
160 | struct xfs_buf *bp, struct xfs_dir2_data_unused *dup); | |
161 | extern void xfs_dir2_data_make_free(struct xfs_da_args *args, | |
2ca98774 DC |
162 | struct xfs_buf *bp, xfs_dir2_data_aoff_t offset, |
163 | xfs_dir2_data_aoff_t len, int *needlogp, int *needscanp); | |
6915ef35 | 164 | extern int xfs_dir2_data_use_free(struct xfs_da_args *args, |
2ca98774 | 165 | struct xfs_buf *bp, struct xfs_dir2_data_unused *dup, |
2b9ab5ab DC |
166 | xfs_dir2_data_aoff_t offset, xfs_dir2_data_aoff_t len, |
167 | int *needlogp, int *needscanp); | |
2b9ab5ab DC |
168 | |
169 | extern struct xfs_dir2_data_free *xfs_dir2_data_freefind( | |
2ca98774 DC |
170 | struct xfs_dir2_data_hdr *hdr, struct xfs_dir2_data_free *bf, |
171 | struct xfs_dir2_data_unused *dup); | |
2b9ab5ab | 172 | |
5e52365a DW |
173 | extern int xfs_dir_ino_validate(struct xfs_mount *mp, xfs_ino_t ino); |
174 | ||
2b9ab5ab DC |
175 | extern const struct xfs_buf_ops xfs_dir3_block_buf_ops; |
176 | extern const struct xfs_buf_ops xfs_dir3_leafn_buf_ops; | |
177 | extern const struct xfs_buf_ops xfs_dir3_leaf1_buf_ops; | |
178 | extern const struct xfs_buf_ops xfs_dir3_free_buf_ops; | |
179 | extern const struct xfs_buf_ops xfs_dir3_data_buf_ops; | |
180 | ||
9a2cc41c DC |
181 | /* |
182 | * Directory offset/block conversion functions. | |
183 | * | |
184 | * DB blocks here are logical directory block numbers, not filesystem blocks. | |
185 | */ | |
186 | ||
187 | /* | |
188 | * Convert dataptr to byte in file space | |
189 | */ | |
190 | static inline xfs_dir2_off_t | |
191 | xfs_dir2_dataptr_to_byte(xfs_dir2_dataptr_t dp) | |
192 | { | |
193 | return (xfs_dir2_off_t)dp << XFS_DIR2_DATA_ALIGN_LOG; | |
194 | } | |
195 | ||
196 | /* | |
197 | * Convert byte in file space to dataptr. It had better be aligned. | |
198 | */ | |
199 | static inline xfs_dir2_dataptr_t | |
200 | xfs_dir2_byte_to_dataptr(xfs_dir2_off_t by) | |
201 | { | |
202 | return (xfs_dir2_dataptr_t)(by >> XFS_DIR2_DATA_ALIGN_LOG); | |
203 | } | |
204 | ||
205 | /* | |
206 | * Convert byte in space to (DB) block | |
207 | */ | |
208 | static inline xfs_dir2_db_t | |
209 | xfs_dir2_byte_to_db(struct xfs_da_geometry *geo, xfs_dir2_off_t by) | |
210 | { | |
211 | return (xfs_dir2_db_t)(by >> geo->blklog); | |
212 | } | |
213 | ||
214 | /* | |
215 | * Convert dataptr to a block number | |
216 | */ | |
217 | static inline xfs_dir2_db_t | |
218 | xfs_dir2_dataptr_to_db(struct xfs_da_geometry *geo, xfs_dir2_dataptr_t dp) | |
219 | { | |
220 | return xfs_dir2_byte_to_db(geo, xfs_dir2_dataptr_to_byte(dp)); | |
221 | } | |
222 | ||
223 | /* | |
224 | * Convert byte in space to offset in a block | |
225 | */ | |
226 | static inline xfs_dir2_data_aoff_t | |
227 | xfs_dir2_byte_to_off(struct xfs_da_geometry *geo, xfs_dir2_off_t by) | |
228 | { | |
229 | return (xfs_dir2_data_aoff_t)(by & (geo->blksize - 1)); | |
230 | } | |
231 | ||
232 | /* | |
233 | * Convert dataptr to a byte offset in a block | |
234 | */ | |
235 | static inline xfs_dir2_data_aoff_t | |
236 | xfs_dir2_dataptr_to_off(struct xfs_da_geometry *geo, xfs_dir2_dataptr_t dp) | |
237 | { | |
238 | return xfs_dir2_byte_to_off(geo, xfs_dir2_dataptr_to_byte(dp)); | |
239 | } | |
240 | ||
241 | /* | |
242 | * Convert block and offset to byte in space | |
243 | */ | |
244 | static inline xfs_dir2_off_t | |
245 | xfs_dir2_db_off_to_byte(struct xfs_da_geometry *geo, xfs_dir2_db_t db, | |
246 | xfs_dir2_data_aoff_t o) | |
247 | { | |
248 | return ((xfs_dir2_off_t)db << geo->blklog) + o; | |
249 | } | |
250 | ||
251 | /* | |
252 | * Convert block (DB) to block (dablk) | |
253 | */ | |
254 | static inline xfs_dablk_t | |
255 | xfs_dir2_db_to_da(struct xfs_da_geometry *geo, xfs_dir2_db_t db) | |
256 | { | |
257 | return (xfs_dablk_t)(db << (geo->blklog - geo->fsblog)); | |
258 | } | |
259 | ||
260 | /* | |
261 | * Convert byte in space to (DA) block | |
262 | */ | |
263 | static inline xfs_dablk_t | |
264 | xfs_dir2_byte_to_da(struct xfs_da_geometry *geo, xfs_dir2_off_t by) | |
265 | { | |
266 | return xfs_dir2_db_to_da(geo, xfs_dir2_byte_to_db(geo, by)); | |
267 | } | |
268 | ||
269 | /* | |
270 | * Convert block and offset to dataptr | |
271 | */ | |
272 | static inline xfs_dir2_dataptr_t | |
273 | xfs_dir2_db_off_to_dataptr(struct xfs_da_geometry *geo, xfs_dir2_db_t db, | |
274 | xfs_dir2_data_aoff_t o) | |
275 | { | |
276 | return xfs_dir2_byte_to_dataptr(xfs_dir2_db_off_to_byte(geo, db, o)); | |
277 | } | |
278 | ||
279 | /* | |
280 | * Convert block (dablk) to block (DB) | |
281 | */ | |
282 | static inline xfs_dir2_db_t | |
283 | xfs_dir2_da_to_db(struct xfs_da_geometry *geo, xfs_dablk_t da) | |
284 | { | |
285 | return (xfs_dir2_db_t)(da >> (geo->blklog - geo->fsblog)); | |
286 | } | |
287 | ||
288 | /* | |
289 | * Convert block (dablk) to byte offset in space | |
290 | */ | |
291 | static inline xfs_dir2_off_t | |
292 | xfs_dir2_da_to_byte(struct xfs_da_geometry *geo, xfs_dablk_t da) | |
293 | { | |
294 | return xfs_dir2_db_off_to_byte(geo, xfs_dir2_da_to_db(geo, da), 0); | |
295 | } | |
296 | ||
297 | /* | |
298 | * Directory tail pointer accessor functions. Based on block geometry. | |
299 | */ | |
300 | static inline struct xfs_dir2_block_tail * | |
301 | xfs_dir2_block_tail_p(struct xfs_da_geometry *geo, struct xfs_dir2_data_hdr *hdr) | |
302 | { | |
303 | return ((struct xfs_dir2_block_tail *) | |
304 | ((char *)hdr + geo->blksize)) - 1; | |
305 | } | |
306 | ||
307 | static inline struct xfs_dir2_leaf_tail * | |
308 | xfs_dir2_leaf_tail_p(struct xfs_da_geometry *geo, struct xfs_dir2_leaf *lp) | |
309 | { | |
310 | return (struct xfs_dir2_leaf_tail *) | |
311 | ((char *)lp + geo->blksize - | |
312 | sizeof(struct xfs_dir2_leaf_tail)); | |
313 | } | |
314 | ||
a5c46e5e DW |
315 | /* |
316 | * The Linux API doesn't pass down the total size of the buffer | |
317 | * we read into down to the filesystem. With the filldir concept | |
318 | * it's not needed for correct information, but the XFS dir2 leaf | |
319 | * code wants an estimate of the buffer size to calculate it's | |
320 | * readahead window and size the buffers used for mapping to | |
321 | * physical blocks. | |
322 | * | |
323 | * Try to give it an estimate that's good enough, maybe at some | |
324 | * point we can change the ->readdir prototype to include the | |
325 | * buffer size. For now we use the current glibc buffer size. | |
326 | * musl libc hardcodes 2k and dietlibc uses PAGE_SIZE. | |
327 | */ | |
328 | #define XFS_READDIR_BUFSIZE (32768) | |
329 | ||
330 | unsigned char xfs_dir3_get_dtype(struct xfs_mount *mp, uint8_t filetype); | |
ce92d29d DW |
331 | void *xfs_dir3_data_endp(struct xfs_da_geometry *geo, |
332 | struct xfs_dir2_data_hdr *hdr); | |
a5c46e5e | 333 | |
1da177e4 | 334 | #endif /* __XFS_DIR2_H__ */ |