blob: e55353651f5b8678c14b0c22cbe3da1faae29548 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Nathan Scott7b718762005-11-02 14:58:39 +11005 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * published by the Free Software Foundation.
8 *
Nathan Scott7b718762005-11-02 14:58:39 +11009 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
Nathan Scott7b718762005-11-02 14:58:39 +110014 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
18#ifndef __XFS_DIR2_H__
Christoph Hellwig57926642011-07-13 13:43:48 +020019#define __XFS_DIR2_H__
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Nathan Scottf6c2d1f2006-06-20 13:04:51 +100021struct xfs_bmap_free;
Christoph Hellwig57926642011-07-13 13:43:48 +020022struct xfs_da_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -070023struct xfs_inode;
Nathan Scottf6c2d1f2006-06-20 13:04:51 +100024struct xfs_mount;
Linus Torvalds1da177e2005-04-16 15:20:36 -070025struct xfs_trans;
Dave Chinner2b9ab5a2013-08-12 20:49:37 +100026struct xfs_dir2_sf_hdr;
27struct xfs_dir2_sf_entry;
28struct xfs_dir2_data_hdr;
29struct xfs_dir2_data_entry;
30struct xfs_dir2_data_unused;
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Barry Naujok556b8b12008-04-10 12:22:07 +100032extern struct xfs_name xfs_name_dotdot;
33
Linus Torvalds1da177e2005-04-16 15:20:36 -070034/*
Dave Chinner1b767ee2014-12-04 09:43:17 +110035 * directory filetype conversion tables.
36 */
37#define S_SHIFT 12
38extern const unsigned char xfs_mode_to_ftype[];
39
40/*
Dave Chinner32c54832013-10-29 22:11:46 +110041 * directory operations vector for encode/decode routines
42 */
43struct xfs_dir_ops {
44 int (*sf_entsize)(struct xfs_dir2_sf_hdr *hdr, int len);
45 struct xfs_dir2_sf_entry *
46 (*sf_nextentry)(struct xfs_dir2_sf_hdr *hdr,
47 struct xfs_dir2_sf_entry *sfep);
Dave Chinner47401752013-10-29 22:11:47 +110048 __uint8_t (*sf_get_ftype)(struct xfs_dir2_sf_entry *sfep);
49 void (*sf_put_ftype)(struct xfs_dir2_sf_entry *sfep,
50 __uint8_t ftype);
51 xfs_ino_t (*sf_get_ino)(struct xfs_dir2_sf_hdr *hdr,
52 struct xfs_dir2_sf_entry *sfep);
53 void (*sf_put_ino)(struct xfs_dir2_sf_hdr *hdr,
54 struct xfs_dir2_sf_entry *sfep,
55 xfs_ino_t ino);
56 xfs_ino_t (*sf_get_parent_ino)(struct xfs_dir2_sf_hdr *hdr);
57 void (*sf_put_parent_ino)(struct xfs_dir2_sf_hdr *hdr,
58 xfs_ino_t ino);
Dave Chinner9d23fc82013-10-29 22:11:48 +110059
60 int (*data_entsize)(int len);
61 __uint8_t (*data_get_ftype)(struct xfs_dir2_data_entry *dep);
62 void (*data_put_ftype)(struct xfs_dir2_data_entry *dep,
63 __uint8_t ftype);
64 __be16 * (*data_entry_tag_p)(struct xfs_dir2_data_entry *dep);
Dave Chinner2ca98772013-10-29 22:11:49 +110065 struct xfs_dir2_data_free *
66 (*data_bestfree_p)(struct xfs_dir2_data_hdr *hdr);
Dave Chinner9d23fc82013-10-29 22:11:48 +110067
Dave Chinner1c9a5b22013-10-30 09:15:02 +110068 xfs_dir2_data_aoff_t data_dot_offset;
69 xfs_dir2_data_aoff_t data_dotdot_offset;
70 xfs_dir2_data_aoff_t data_first_offset;
71 size_t data_entry_offset;
Dave Chinner2ca98772013-10-29 22:11:49 +110072
Dave Chinner9d23fc82013-10-29 22:11:48 +110073 struct xfs_dir2_data_entry *
74 (*data_dot_entry_p)(struct xfs_dir2_data_hdr *hdr);
75 struct xfs_dir2_data_entry *
76 (*data_dotdot_entry_p)(struct xfs_dir2_data_hdr *hdr);
77 struct xfs_dir2_data_entry *
78 (*data_first_entry_p)(struct xfs_dir2_data_hdr *hdr);
Dave Chinner2ca98772013-10-29 22:11:49 +110079 struct xfs_dir2_data_entry *
80 (*data_entry_p)(struct xfs_dir2_data_hdr *hdr);
81 struct xfs_dir2_data_unused *
82 (*data_unused_p)(struct xfs_dir2_data_hdr *hdr);
Dave Chinner41419562013-10-29 22:11:50 +110083
Dave Chinner1c9a5b22013-10-30 09:15:02 +110084 int leaf_hdr_size;
Dave Chinner01ba43b2013-10-29 22:11:52 +110085 void (*leaf_hdr_to_disk)(struct xfs_dir2_leaf *to,
86 struct xfs_dir3_icleaf_hdr *from);
87 void (*leaf_hdr_from_disk)(struct xfs_dir3_icleaf_hdr *to,
88 struct xfs_dir2_leaf *from);
Dave Chinner8f661932014-06-06 15:15:59 +100089 int (*leaf_max_ents)(struct xfs_da_geometry *geo);
Dave Chinner41419562013-10-29 22:11:50 +110090 struct xfs_dir2_leaf_entry *
91 (*leaf_ents_p)(struct xfs_dir2_leaf *lp);
Dave Chinner4bceb182013-10-29 22:11:51 +110092
Dave Chinner1c9a5b22013-10-30 09:15:02 +110093 int node_hdr_size;
Dave Chinner01ba43b2013-10-29 22:11:52 +110094 void (*node_hdr_to_disk)(struct xfs_da_intnode *to,
95 struct xfs_da3_icnode_hdr *from);
96 void (*node_hdr_from_disk)(struct xfs_da3_icnode_hdr *to,
97 struct xfs_da_intnode *from);
Dave Chinner4bceb182013-10-29 22:11:51 +110098 struct xfs_da_node_entry *
99 (*node_tree_p)(struct xfs_da_intnode *dap);
Dave Chinner01ba43b2013-10-29 22:11:52 +1100100
Dave Chinner1c9a5b22013-10-30 09:15:02 +1100101 int free_hdr_size;
Dave Chinner01ba43b2013-10-29 22:11:52 +1100102 void (*free_hdr_to_disk)(struct xfs_dir2_free *to,
103 struct xfs_dir3_icfree_hdr *from);
104 void (*free_hdr_from_disk)(struct xfs_dir3_icfree_hdr *to,
105 struct xfs_dir2_free *from);
Dave Chinner8f661932014-06-06 15:15:59 +1000106 int (*free_max_bests)(struct xfs_da_geometry *geo);
Dave Chinner24dd0f52013-10-30 13:48:41 -0500107 __be16 * (*free_bests_p)(struct xfs_dir2_free *free);
Dave Chinner8f661932014-06-06 15:15:59 +1000108 xfs_dir2_db_t (*db_to_fdb)(struct xfs_da_geometry *geo,
109 xfs_dir2_db_t db);
110 int (*db_to_fdindex)(struct xfs_da_geometry *geo,
111 xfs_dir2_db_t db);
Dave Chinner32c54832013-10-29 22:11:46 +1100112};
113
Dave Chinner41419562013-10-29 22:11:50 +1100114extern const struct xfs_dir_ops *
115 xfs_dir_get_ops(struct xfs_mount *mp, struct xfs_inode *dp);
Dave Chinner4bceb182013-10-29 22:11:51 +1100116extern const struct xfs_dir_ops *
117 xfs_nondir_get_ops(struct xfs_mount *mp, struct xfs_inode *dp);
Dave Chinner32c54832013-10-29 22:11:46 +1100118
119/*
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000120 * Generic directory interface routines
121 */
122extern void xfs_dir_startup(void);
Dave Chinner0650b552014-06-06 15:01:58 +1000123extern int xfs_da_mount(struct xfs_mount *mp);
124extern void xfs_da_unmount(struct xfs_mount *mp);
125
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000126extern int xfs_dir_isempty(struct xfs_inode *dp);
127extern int xfs_dir_init(struct xfs_trans *tp, struct xfs_inode *dp,
128 struct xfs_inode *pdp);
129extern int xfs_dir_createname(struct xfs_trans *tp, struct xfs_inode *dp,
Barry Naujok556b8b12008-04-10 12:22:07 +1000130 struct xfs_name *name, xfs_ino_t inum,
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000131 xfs_fsblock_t *first,
132 struct xfs_bmap_free *flist, xfs_extlen_t tot);
133extern int xfs_dir_lookup(struct xfs_trans *tp, struct xfs_inode *dp,
Barry Naujok384f3ce2008-05-21 16:58:22 +1000134 struct xfs_name *name, xfs_ino_t *inum,
135 struct xfs_name *ci_name);
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000136extern int xfs_dir_removename(struct xfs_trans *tp, struct xfs_inode *dp,
Barry Naujok556b8b12008-04-10 12:22:07 +1000137 struct xfs_name *name, xfs_ino_t ino,
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000138 xfs_fsblock_t *first,
139 struct xfs_bmap_free *flist, xfs_extlen_t tot);
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000140extern int xfs_dir_replace(struct xfs_trans *tp, struct xfs_inode *dp,
Barry Naujok556b8b12008-04-10 12:22:07 +1000141 struct xfs_name *name, xfs_ino_t inum,
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000142 xfs_fsblock_t *first,
143 struct xfs_bmap_free *flist, xfs_extlen_t tot);
144extern int xfs_dir_canenter(struct xfs_trans *tp, struct xfs_inode *dp,
Eric Sandeen94f3cad2014-09-09 11:57:52 +1000145 struct xfs_name *name);
Nathan Scottf6c2d1f2006-06-20 13:04:51 +1000146
147/*
Christoph Hellwig57926642011-07-13 13:43:48 +0200148 * Direct call from the bmap code, bypassing the generic directory layer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 */
Christoph Hellwig57926642011-07-13 13:43:48 +0200150extern int xfs_dir2_sf_to_block(struct xfs_da_args *args);
Barry Naujok384f3ce2008-05-21 16:58:22 +1000151
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000152/*
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000153 * Interface routines used by userspace utilities
154 */
Dave Chinner53f82db2014-06-06 15:20:32 +1000155extern int xfs_dir2_isblock(struct xfs_da_args *args, int *r);
156extern int xfs_dir2_isleaf(struct xfs_da_args *args, int *r);
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000157extern int xfs_dir2_shrink_inode(struct xfs_da_args *args, xfs_dir2_db_t db,
158 struct xfs_buf *bp);
159
Dave Chinner9d23fc82013-10-29 22:11:48 +1100160extern void xfs_dir2_data_freescan(struct xfs_inode *dp,
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000161 struct xfs_dir2_data_hdr *hdr, int *loghead);
Dave Chinnerbc851782014-06-06 15:20:54 +1000162extern void xfs_dir2_data_log_entry(struct xfs_da_args *args,
Dave Chinner9d23fc82013-10-29 22:11:48 +1100163 struct xfs_buf *bp, struct xfs_dir2_data_entry *dep);
Dave Chinnerbc851782014-06-06 15:20:54 +1000164extern void xfs_dir2_data_log_header(struct xfs_da_args *args,
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000165 struct xfs_buf *bp);
Dave Chinnerbc851782014-06-06 15:20:54 +1000166extern void xfs_dir2_data_log_unused(struct xfs_da_args *args,
167 struct xfs_buf *bp, struct xfs_dir2_data_unused *dup);
168extern void xfs_dir2_data_make_free(struct xfs_da_args *args,
Dave Chinner2ca98772013-10-29 22:11:49 +1100169 struct xfs_buf *bp, xfs_dir2_data_aoff_t offset,
170 xfs_dir2_data_aoff_t len, int *needlogp, int *needscanp);
Dave Chinnerbc851782014-06-06 15:20:54 +1000171extern void xfs_dir2_data_use_free(struct xfs_da_args *args,
Dave Chinner2ca98772013-10-29 22:11:49 +1100172 struct xfs_buf *bp, struct xfs_dir2_data_unused *dup,
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000173 xfs_dir2_data_aoff_t offset, xfs_dir2_data_aoff_t len,
174 int *needlogp, int *needscanp);
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000175
176extern struct xfs_dir2_data_free *xfs_dir2_data_freefind(
Dave Chinner2ca98772013-10-29 22:11:49 +1100177 struct xfs_dir2_data_hdr *hdr, struct xfs_dir2_data_free *bf,
178 struct xfs_dir2_data_unused *dup);
Dave Chinner2b9ab5a2013-08-12 20:49:37 +1000179
180extern const struct xfs_buf_ops xfs_dir3_block_buf_ops;
181extern const struct xfs_buf_ops xfs_dir3_leafn_buf_ops;
182extern const struct xfs_buf_ops xfs_dir3_leaf1_buf_ops;
183extern const struct xfs_buf_ops xfs_dir3_free_buf_ops;
184extern const struct xfs_buf_ops xfs_dir3_data_buf_ops;
185
Dave Chinner9a2cc412014-12-04 09:43:17 +1100186/*
187 * Directory offset/block conversion functions.
188 *
189 * DB blocks here are logical directory block numbers, not filesystem blocks.
190 */
191
192/*
193 * Convert dataptr to byte in file space
194 */
195static inline xfs_dir2_off_t
196xfs_dir2_dataptr_to_byte(xfs_dir2_dataptr_t dp)
197{
198 return (xfs_dir2_off_t)dp << XFS_DIR2_DATA_ALIGN_LOG;
199}
200
201/*
202 * Convert byte in file space to dataptr. It had better be aligned.
203 */
204static inline xfs_dir2_dataptr_t
205xfs_dir2_byte_to_dataptr(xfs_dir2_off_t by)
206{
207 return (xfs_dir2_dataptr_t)(by >> XFS_DIR2_DATA_ALIGN_LOG);
208}
209
210/*
211 * Convert byte in space to (DB) block
212 */
213static inline xfs_dir2_db_t
214xfs_dir2_byte_to_db(struct xfs_da_geometry *geo, xfs_dir2_off_t by)
215{
216 return (xfs_dir2_db_t)(by >> geo->blklog);
217}
218
219/*
220 * Convert dataptr to a block number
221 */
222static inline xfs_dir2_db_t
223xfs_dir2_dataptr_to_db(struct xfs_da_geometry *geo, xfs_dir2_dataptr_t dp)
224{
225 return xfs_dir2_byte_to_db(geo, xfs_dir2_dataptr_to_byte(dp));
226}
227
228/*
229 * Convert byte in space to offset in a block
230 */
231static inline xfs_dir2_data_aoff_t
232xfs_dir2_byte_to_off(struct xfs_da_geometry *geo, xfs_dir2_off_t by)
233{
234 return (xfs_dir2_data_aoff_t)(by & (geo->blksize - 1));
235}
236
237/*
238 * Convert dataptr to a byte offset in a block
239 */
240static inline xfs_dir2_data_aoff_t
241xfs_dir2_dataptr_to_off(struct xfs_da_geometry *geo, xfs_dir2_dataptr_t dp)
242{
243 return xfs_dir2_byte_to_off(geo, xfs_dir2_dataptr_to_byte(dp));
244}
245
246/*
247 * Convert block and offset to byte in space
248 */
249static inline xfs_dir2_off_t
250xfs_dir2_db_off_to_byte(struct xfs_da_geometry *geo, xfs_dir2_db_t db,
251 xfs_dir2_data_aoff_t o)
252{
253 return ((xfs_dir2_off_t)db << geo->blklog) + o;
254}
255
256/*
257 * Convert block (DB) to block (dablk)
258 */
259static inline xfs_dablk_t
260xfs_dir2_db_to_da(struct xfs_da_geometry *geo, xfs_dir2_db_t db)
261{
262 return (xfs_dablk_t)(db << (geo->blklog - geo->fsblog));
263}
264
265/*
266 * Convert byte in space to (DA) block
267 */
268static inline xfs_dablk_t
269xfs_dir2_byte_to_da(struct xfs_da_geometry *geo, xfs_dir2_off_t by)
270{
271 return xfs_dir2_db_to_da(geo, xfs_dir2_byte_to_db(geo, by));
272}
273
274/*
275 * Convert block and offset to dataptr
276 */
277static inline xfs_dir2_dataptr_t
278xfs_dir2_db_off_to_dataptr(struct xfs_da_geometry *geo, xfs_dir2_db_t db,
279 xfs_dir2_data_aoff_t o)
280{
281 return xfs_dir2_byte_to_dataptr(xfs_dir2_db_off_to_byte(geo, db, o));
282}
283
284/*
285 * Convert block (dablk) to block (DB)
286 */
287static inline xfs_dir2_db_t
288xfs_dir2_da_to_db(struct xfs_da_geometry *geo, xfs_dablk_t da)
289{
290 return (xfs_dir2_db_t)(da >> (geo->blklog - geo->fsblog));
291}
292
293/*
294 * Convert block (dablk) to byte offset in space
295 */
296static inline xfs_dir2_off_t
297xfs_dir2_da_to_byte(struct xfs_da_geometry *geo, xfs_dablk_t da)
298{
299 return xfs_dir2_db_off_to_byte(geo, xfs_dir2_da_to_db(geo, da), 0);
300}
301
302/*
303 * Directory tail pointer accessor functions. Based on block geometry.
304 */
305static inline struct xfs_dir2_block_tail *
306xfs_dir2_block_tail_p(struct xfs_da_geometry *geo, struct xfs_dir2_data_hdr *hdr)
307{
308 return ((struct xfs_dir2_block_tail *)
309 ((char *)hdr + geo->blksize)) - 1;
310}
311
312static inline struct xfs_dir2_leaf_tail *
313xfs_dir2_leaf_tail_p(struct xfs_da_geometry *geo, struct xfs_dir2_leaf *lp)
314{
315 return (struct xfs_dir2_leaf_tail *)
316 ((char *)lp + geo->blksize -
317 sizeof(struct xfs_dir2_leaf_tail));
318}
319
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320#endif /* __XFS_DIR2_H__ */