xref: /openbmc/linux/fs/xfs/libxfs/xfs_dir2_priv.h (revision 275876e2)
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_PRIV_H__
19 #define __XFS_DIR2_PRIV_H__
20 
21 struct dir_context;
22 
23 /*
24  * Directory offset/block conversion functions.
25  *
26  * DB blocks here are logical directory block numbers, not filesystem blocks.
27  */
28 
29 /*
30  * Convert dataptr to byte in file space
31  */
32 static inline xfs_dir2_off_t
33 xfs_dir2_dataptr_to_byte(xfs_dir2_dataptr_t dp)
34 {
35 	return (xfs_dir2_off_t)dp << XFS_DIR2_DATA_ALIGN_LOG;
36 }
37 
38 /*
39  * Convert byte in file space to dataptr.  It had better be aligned.
40  */
41 static inline xfs_dir2_dataptr_t
42 xfs_dir2_byte_to_dataptr(xfs_dir2_off_t by)
43 {
44 	return (xfs_dir2_dataptr_t)(by >> XFS_DIR2_DATA_ALIGN_LOG);
45 }
46 
47 /*
48  * Convert byte in space to (DB) block
49  */
50 static inline xfs_dir2_db_t
51 xfs_dir2_byte_to_db(struct xfs_da_geometry *geo, xfs_dir2_off_t by)
52 {
53 	return (xfs_dir2_db_t)(by >> geo->blklog);
54 }
55 
56 /*
57  * Convert dataptr to a block number
58  */
59 static inline xfs_dir2_db_t
60 xfs_dir2_dataptr_to_db(struct xfs_da_geometry *geo, xfs_dir2_dataptr_t dp)
61 {
62 	return xfs_dir2_byte_to_db(geo, xfs_dir2_dataptr_to_byte(dp));
63 }
64 
65 /*
66  * Convert byte in space to offset in a block
67  */
68 static inline xfs_dir2_data_aoff_t
69 xfs_dir2_byte_to_off(struct xfs_da_geometry *geo, xfs_dir2_off_t by)
70 {
71 	return (xfs_dir2_data_aoff_t)(by & (geo->blksize - 1));
72 }
73 
74 /*
75  * Convert dataptr to a byte offset in a block
76  */
77 static inline xfs_dir2_data_aoff_t
78 xfs_dir2_dataptr_to_off(struct xfs_da_geometry *geo, xfs_dir2_dataptr_t dp)
79 {
80 	return xfs_dir2_byte_to_off(geo, xfs_dir2_dataptr_to_byte(dp));
81 }
82 
83 /*
84  * Convert block and offset to byte in space
85  */
86 static inline xfs_dir2_off_t
87 xfs_dir2_db_off_to_byte(struct xfs_da_geometry *geo, xfs_dir2_db_t db,
88 			xfs_dir2_data_aoff_t o)
89 {
90 	return ((xfs_dir2_off_t)db << geo->blklog) + o;
91 }
92 
93 /*
94  * Convert block (DB) to block (dablk)
95  */
96 static inline xfs_dablk_t
97 xfs_dir2_db_to_da(struct xfs_da_geometry *geo, xfs_dir2_db_t db)
98 {
99 	return (xfs_dablk_t)(db << (geo->blklog - geo->fsblog));
100 }
101 
102 /*
103  * Convert byte in space to (DA) block
104  */
105 static inline xfs_dablk_t
106 xfs_dir2_byte_to_da(struct xfs_da_geometry *geo, xfs_dir2_off_t by)
107 {
108 	return xfs_dir2_db_to_da(geo, xfs_dir2_byte_to_db(geo, by));
109 }
110 
111 /*
112  * Convert block and offset to dataptr
113  */
114 static inline xfs_dir2_dataptr_t
115 xfs_dir2_db_off_to_dataptr(struct xfs_da_geometry *geo, xfs_dir2_db_t db,
116 			   xfs_dir2_data_aoff_t o)
117 {
118 	return xfs_dir2_byte_to_dataptr(xfs_dir2_db_off_to_byte(geo, db, o));
119 }
120 
121 /*
122  * Convert block (dablk) to block (DB)
123  */
124 static inline xfs_dir2_db_t
125 xfs_dir2_da_to_db(struct xfs_da_geometry *geo, xfs_dablk_t da)
126 {
127 	return (xfs_dir2_db_t)(da >> (geo->blklog - geo->fsblog));
128 }
129 
130 /*
131  * Convert block (dablk) to byte offset in space
132  */
133 static inline xfs_dir2_off_t
134 xfs_dir2_da_to_byte(struct xfs_da_geometry *geo, xfs_dablk_t da)
135 {
136 	return xfs_dir2_db_off_to_byte(geo, xfs_dir2_da_to_db(geo, da), 0);
137 }
138 
139 /*
140  * Directory tail pointer accessor functions. Based on block geometry.
141  */
142 static inline struct xfs_dir2_block_tail *
143 xfs_dir2_block_tail_p(struct xfs_da_geometry *geo, struct xfs_dir2_data_hdr *hdr)
144 {
145 	return ((struct xfs_dir2_block_tail *)
146 		((char *)hdr + geo->blksize)) - 1;
147 }
148 
149 static inline struct xfs_dir2_leaf_tail *
150 xfs_dir2_leaf_tail_p(struct xfs_da_geometry *geo, struct xfs_dir2_leaf *lp)
151 {
152 	return (struct xfs_dir2_leaf_tail *)
153 		((char *)lp + geo->blksize -
154 		  sizeof(struct xfs_dir2_leaf_tail));
155 }
156 
157 /* xfs_dir2.c */
158 extern int xfs_dir_ino_validate(struct xfs_mount *mp, xfs_ino_t ino);
159 extern int xfs_dir2_grow_inode(struct xfs_da_args *args, int space,
160 				xfs_dir2_db_t *dbp);
161 extern int xfs_dir_cilookup_result(struct xfs_da_args *args,
162 				const unsigned char *name, int len);
163 
164 #define S_SHIFT 12
165 extern const unsigned char xfs_mode_to_ftype[];
166 
167 extern unsigned char xfs_dir3_get_dtype(struct xfs_mount *mp,
168 					__uint8_t filetype);
169 
170 
171 /* xfs_dir2_block.c */
172 extern int xfs_dir3_block_read(struct xfs_trans *tp, struct xfs_inode *dp,
173 			       struct xfs_buf **bpp);
174 extern int xfs_dir2_block_addname(struct xfs_da_args *args);
175 extern int xfs_dir2_block_lookup(struct xfs_da_args *args);
176 extern int xfs_dir2_block_removename(struct xfs_da_args *args);
177 extern int xfs_dir2_block_replace(struct xfs_da_args *args);
178 extern int xfs_dir2_leaf_to_block(struct xfs_da_args *args,
179 		struct xfs_buf *lbp, struct xfs_buf *dbp);
180 
181 /* xfs_dir2_data.c */
182 #ifdef DEBUG
183 #define	xfs_dir3_data_check(dp,bp) __xfs_dir3_data_check(dp, bp);
184 #else
185 #define	xfs_dir3_data_check(dp,bp)
186 #endif
187 
188 extern int __xfs_dir3_data_check(struct xfs_inode *dp, struct xfs_buf *bp);
189 extern int xfs_dir3_data_read(struct xfs_trans *tp, struct xfs_inode *dp,
190 		xfs_dablk_t bno, xfs_daddr_t mapped_bno, struct xfs_buf **bpp);
191 extern int xfs_dir3_data_readahead(struct xfs_inode *dp, xfs_dablk_t bno,
192 		xfs_daddr_t mapped_bno);
193 
194 extern struct xfs_dir2_data_free *
195 xfs_dir2_data_freeinsert(struct xfs_dir2_data_hdr *hdr,
196 		struct xfs_dir2_data_free *bf, struct xfs_dir2_data_unused *dup,
197 		int *loghead);
198 extern int xfs_dir3_data_init(struct xfs_da_args *args, xfs_dir2_db_t blkno,
199 		struct xfs_buf **bpp);
200 
201 /* xfs_dir2_leaf.c */
202 extern int xfs_dir3_leafn_read(struct xfs_trans *tp, struct xfs_inode *dp,
203 		xfs_dablk_t fbno, xfs_daddr_t mappedbno, struct xfs_buf **bpp);
204 extern int xfs_dir2_block_to_leaf(struct xfs_da_args *args,
205 		struct xfs_buf *dbp);
206 extern int xfs_dir2_leaf_addname(struct xfs_da_args *args);
207 extern void xfs_dir3_leaf_compact(struct xfs_da_args *args,
208 		struct xfs_dir3_icleaf_hdr *leafhdr, struct xfs_buf *bp);
209 extern void xfs_dir3_leaf_compact_x1(struct xfs_dir3_icleaf_hdr *leafhdr,
210 		struct xfs_dir2_leaf_entry *ents, int *indexp,
211 		int *lowstalep, int *highstalep, int *lowlogp, int *highlogp);
212 extern int xfs_dir3_leaf_get_buf(struct xfs_da_args *args, xfs_dir2_db_t bno,
213 		struct xfs_buf **bpp, __uint16_t magic);
214 extern void xfs_dir3_leaf_log_ents(struct xfs_da_args *args,
215 		struct xfs_buf *bp, int first, int last);
216 extern void xfs_dir3_leaf_log_header(struct xfs_da_args *args,
217 		struct xfs_buf *bp);
218 extern int xfs_dir2_leaf_lookup(struct xfs_da_args *args);
219 extern int xfs_dir2_leaf_removename(struct xfs_da_args *args);
220 extern int xfs_dir2_leaf_replace(struct xfs_da_args *args);
221 extern int xfs_dir2_leaf_search_hash(struct xfs_da_args *args,
222 		struct xfs_buf *lbp);
223 extern int xfs_dir2_leaf_trim_data(struct xfs_da_args *args,
224 		struct xfs_buf *lbp, xfs_dir2_db_t db);
225 extern struct xfs_dir2_leaf_entry *
226 xfs_dir3_leaf_find_entry(struct xfs_dir3_icleaf_hdr *leafhdr,
227 		struct xfs_dir2_leaf_entry *ents, int index, int compact,
228 		int lowstale, int highstale, int *lfloglow, int *lfloghigh);
229 extern int xfs_dir2_node_to_leaf(struct xfs_da_state *state);
230 
231 extern bool xfs_dir3_leaf_check_int(struct xfs_mount *mp, struct xfs_inode *dp,
232 		struct xfs_dir3_icleaf_hdr *hdr, struct xfs_dir2_leaf *leaf);
233 
234 /* xfs_dir2_node.c */
235 extern int xfs_dir2_leaf_to_node(struct xfs_da_args *args,
236 		struct xfs_buf *lbp);
237 extern xfs_dahash_t xfs_dir2_leafn_lasthash(struct xfs_inode *dp,
238 		struct xfs_buf *bp, int *count);
239 extern int xfs_dir2_leafn_lookup_int(struct xfs_buf *bp,
240 		struct xfs_da_args *args, int *indexp,
241 		struct xfs_da_state *state);
242 extern int xfs_dir2_leafn_order(struct xfs_inode *dp, struct xfs_buf *leaf1_bp,
243 		struct xfs_buf *leaf2_bp);
244 extern int xfs_dir2_leafn_split(struct xfs_da_state *state,
245 	struct xfs_da_state_blk *oldblk, struct xfs_da_state_blk *newblk);
246 extern int xfs_dir2_leafn_toosmall(struct xfs_da_state *state, int *action);
247 extern void xfs_dir2_leafn_unbalance(struct xfs_da_state *state,
248 		struct xfs_da_state_blk *drop_blk,
249 		struct xfs_da_state_blk *save_blk);
250 extern int xfs_dir2_node_addname(struct xfs_da_args *args);
251 extern int xfs_dir2_node_lookup(struct xfs_da_args *args);
252 extern int xfs_dir2_node_removename(struct xfs_da_args *args);
253 extern int xfs_dir2_node_replace(struct xfs_da_args *args);
254 extern int xfs_dir2_node_trim_free(struct xfs_da_args *args, xfs_fileoff_t fo,
255 		int *rvalp);
256 extern int xfs_dir2_free_read(struct xfs_trans *tp, struct xfs_inode *dp,
257 		xfs_dablk_t fbno, struct xfs_buf **bpp);
258 
259 /* xfs_dir2_sf.c */
260 extern int xfs_dir2_block_sfsize(struct xfs_inode *dp,
261 		struct xfs_dir2_data_hdr *block, struct xfs_dir2_sf_hdr *sfhp);
262 extern int xfs_dir2_block_to_sf(struct xfs_da_args *args, struct xfs_buf *bp,
263 		int size, xfs_dir2_sf_hdr_t *sfhp);
264 extern int xfs_dir2_sf_addname(struct xfs_da_args *args);
265 extern int xfs_dir2_sf_create(struct xfs_da_args *args, xfs_ino_t pino);
266 extern int xfs_dir2_sf_lookup(struct xfs_da_args *args);
267 extern int xfs_dir2_sf_removename(struct xfs_da_args *args);
268 extern int xfs_dir2_sf_replace(struct xfs_da_args *args);
269 
270 /* xfs_dir2_readdir.c */
271 extern int xfs_readdir(struct xfs_inode *dp, struct dir_context *ctx,
272 		       size_t bufsize);
273 
274 #endif /* __XFS_DIR2_PRIV_H__ */
275