blob: 7fb32e954ce34bae6fd635a312340224e6ccf8fe [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_LEAF_H__
19#define __XFS_DIR2_LEAF_H__
20
Linus Torvalds1da177e2005-04-16 15:20:36 -070021struct uio;
22struct xfs_dabuf;
23struct xfs_da_args;
24struct xfs_inode;
25struct xfs_mount;
26struct xfs_trans;
27
28/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 * Offset of the leaf/node space. First block in this space
30 * is the btree root.
31 */
32#define XFS_DIR2_LEAF_SPACE 1
33#define XFS_DIR2_LEAF_OFFSET (XFS_DIR2_LEAF_SPACE * XFS_DIR2_SPACE_SIZE)
34#define XFS_DIR2_LEAF_FIRSTDB(mp) \
35 XFS_DIR2_BYTE_TO_DB(mp, XFS_DIR2_LEAF_OFFSET)
36
37/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 * Offset in data space of a data entry.
39 */
40typedef __uint32_t xfs_dir2_dataptr_t;
41#define XFS_DIR2_MAX_DATAPTR ((xfs_dir2_dataptr_t)0xffffffff)
42#define XFS_DIR2_NULL_DATAPTR ((xfs_dir2_dataptr_t)0)
43
44/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 * Leaf block header.
46 */
47typedef struct xfs_dir2_leaf_hdr {
48 xfs_da_blkinfo_t info; /* header for da routines */
49 __uint16_t count; /* count of entries */
50 __uint16_t stale; /* count of stale entries */
51} xfs_dir2_leaf_hdr_t;
52
53/*
54 * Leaf block entry.
55 */
56typedef struct xfs_dir2_leaf_entry {
57 xfs_dahash_t hashval; /* hash value of name */
58 xfs_dir2_dataptr_t address; /* address of data entry */
59} xfs_dir2_leaf_entry_t;
60
61/*
62 * Leaf block tail.
63 */
64typedef struct xfs_dir2_leaf_tail {
65 __uint32_t bestcount;
66} xfs_dir2_leaf_tail_t;
67
68/*
69 * Leaf block.
70 * bests and tail are at the end of the block for single-leaf only
71 * (magic = XFS_DIR2_LEAF1_MAGIC not XFS_DIR2_LEAFN_MAGIC).
72 */
73typedef struct xfs_dir2_leaf {
74 xfs_dir2_leaf_hdr_t hdr; /* leaf header */
75 xfs_dir2_leaf_entry_t ents[1]; /* entries */
76 /* ... */
77 xfs_dir2_data_off_t bests[1]; /* best free counts */
78 xfs_dir2_leaf_tail_t tail; /* leaf tail */
79} xfs_dir2_leaf_t;
80
81/*
Nathan Scotta844f452005-11-02 14:38:42 +110082 * DB blocks here are logical directory block numbers, not filesystem blocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 */
84
Nathan Scotta844f452005-11-02 14:38:42 +110085#define XFS_DIR2_MAX_LEAF_ENTS(mp) xfs_dir2_max_leaf_ents(mp)
86static inline int xfs_dir2_max_leaf_ents(struct xfs_mount *mp)
87{
88 return (int)(((mp)->m_dirblksize - (uint)sizeof(xfs_dir2_leaf_hdr_t)) /
89 (uint)sizeof(xfs_dir2_leaf_entry_t));
90}
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
92/*
93 * Get address of the bestcount field in the single-leaf block.
94 */
Nathan Scotta844f452005-11-02 14:38:42 +110095#define XFS_DIR2_LEAF_TAIL_P(mp,lp) xfs_dir2_leaf_tail_p(mp, lp)
96static inline xfs_dir2_leaf_tail_t *
97xfs_dir2_leaf_tail_p(struct xfs_mount *mp, xfs_dir2_leaf_t *lp)
98{
99 return (xfs_dir2_leaf_tail_t *)
100 ((char *)(lp) + (mp)->m_dirblksize -
101 (uint)sizeof(xfs_dir2_leaf_tail_t));
102}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
104/*
105 * Get address of the bests array in the single-leaf block.
106 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107#define XFS_DIR2_LEAF_BESTS_P(ltp) xfs_dir2_leaf_bests_p(ltp)
Nathan Scott68b3a102006-03-17 17:27:19 +1100108static inline __be16 *
Nathan Scotta844f452005-11-02 14:38:42 +1100109xfs_dir2_leaf_bests_p(xfs_dir2_leaf_tail_t *ltp)
110{
Nathan Scott68b3a102006-03-17 17:27:19 +1100111 return (__be16 *)(ltp) - INT_GET((ltp)->bestcount, ARCH_CONVERT);
Nathan Scotta844f452005-11-02 14:38:42 +1100112}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114/*
115 * Convert dataptr to byte in file space
116 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117#define XFS_DIR2_DATAPTR_TO_BYTE(mp,dp) xfs_dir2_dataptr_to_byte(mp, dp)
Nathan Scotta844f452005-11-02 14:38:42 +1100118static inline xfs_dir2_off_t
119xfs_dir2_dataptr_to_byte(struct xfs_mount *mp, xfs_dir2_dataptr_t dp)
120{
121 return (xfs_dir2_off_t)(dp) << XFS_DIR2_DATA_ALIGN_LOG;
122}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
124/*
125 * Convert byte in file space to dataptr. It had better be aligned.
126 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127#define XFS_DIR2_BYTE_TO_DATAPTR(mp,by) xfs_dir2_byte_to_dataptr(mp,by)
Nathan Scotta844f452005-11-02 14:38:42 +1100128static inline xfs_dir2_dataptr_t
129xfs_dir2_byte_to_dataptr(struct xfs_mount *mp, xfs_dir2_off_t by)
130{
131 return (xfs_dir2_dataptr_t)((by) >> XFS_DIR2_DATA_ALIGN_LOG);
132}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134/*
135 * Convert byte in space to (DB) block
136 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137#define XFS_DIR2_BYTE_TO_DB(mp,by) xfs_dir2_byte_to_db(mp, by)
Nathan Scotta844f452005-11-02 14:38:42 +1100138static inline xfs_dir2_db_t
139xfs_dir2_byte_to_db(struct xfs_mount *mp, xfs_dir2_off_t by)
140{
141 return (xfs_dir2_db_t)((by) >> \
142 ((mp)->m_sb.sb_blocklog + (mp)->m_sb.sb_dirblklog));
143}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
145/*
Nathan Scotta844f452005-11-02 14:38:42 +1100146 * Convert dataptr to a block number
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 */
Nathan Scotta844f452005-11-02 14:38:42 +1100148#define XFS_DIR2_DATAPTR_TO_DB(mp,dp) xfs_dir2_dataptr_to_db(mp, dp)
149static inline xfs_dir2_db_t
150xfs_dir2_dataptr_to_db(struct xfs_mount *mp, xfs_dir2_dataptr_t dp)
151{
152 return XFS_DIR2_BYTE_TO_DB(mp, XFS_DIR2_DATAPTR_TO_BYTE(mp, dp));
153}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
155/*
156 * Convert byte in space to offset in a block
157 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158#define XFS_DIR2_BYTE_TO_OFF(mp,by) xfs_dir2_byte_to_off(mp, by)
Nathan Scotta844f452005-11-02 14:38:42 +1100159static inline xfs_dir2_data_aoff_t
160xfs_dir2_byte_to_off(struct xfs_mount *mp, xfs_dir2_off_t by)
161{
162 return (xfs_dir2_data_aoff_t)((by) & \
163 ((1 << ((mp)->m_sb.sb_blocklog + (mp)->m_sb.sb_dirblklog)) - 1));
164}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
166/*
Nathan Scotta844f452005-11-02 14:38:42 +1100167 * Convert dataptr to a byte offset in a block
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 */
Nathan Scotta844f452005-11-02 14:38:42 +1100169#define XFS_DIR2_DATAPTR_TO_OFF(mp,dp) xfs_dir2_dataptr_to_off(mp, dp)
170static inline xfs_dir2_data_aoff_t
171xfs_dir2_dataptr_to_off(struct xfs_mount *mp, xfs_dir2_dataptr_t dp)
172{
173 return XFS_DIR2_BYTE_TO_OFF(mp, XFS_DIR2_DATAPTR_TO_BYTE(mp, dp));
174}
175
176/*
177 * Convert block and offset to byte in space
178 */
179#define XFS_DIR2_DB_OFF_TO_BYTE(mp,db,o) \
180 xfs_dir2_db_off_to_byte(mp, db, o)
181static inline xfs_dir2_off_t
182xfs_dir2_db_off_to_byte(struct xfs_mount *mp, xfs_dir2_db_t db,
183 xfs_dir2_data_aoff_t o)
184{
185 return ((xfs_dir2_off_t)(db) << \
186 ((mp)->m_sb.sb_blocklog + (mp)->m_sb.sb_dirblklog)) + (o);
187}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
189/*
190 * Convert block (DB) to block (dablk)
191 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192#define XFS_DIR2_DB_TO_DA(mp,db) xfs_dir2_db_to_da(mp, db)
Nathan Scotta844f452005-11-02 14:38:42 +1100193static inline xfs_dablk_t
194xfs_dir2_db_to_da(struct xfs_mount *mp, xfs_dir2_db_t db)
195{
196 return (xfs_dablk_t)((db) << (mp)->m_sb.sb_dirblklog);
197}
198
199/*
200 * Convert byte in space to (DA) block
201 */
202#define XFS_DIR2_BYTE_TO_DA(mp,by) xfs_dir2_byte_to_da(mp, by)
203static inline xfs_dablk_t
204xfs_dir2_byte_to_da(struct xfs_mount *mp, xfs_dir2_off_t by)
205{
206 return XFS_DIR2_DB_TO_DA(mp, XFS_DIR2_BYTE_TO_DB(mp, by));
207}
208
209/*
210 * Convert block and offset to dataptr
211 */
212#define XFS_DIR2_DB_OFF_TO_DATAPTR(mp,db,o) \
213 xfs_dir2_db_off_to_dataptr(mp, db, o)
214static inline xfs_dir2_dataptr_t
215xfs_dir2_db_off_to_dataptr(struct xfs_mount *mp, xfs_dir2_db_t db,
216 xfs_dir2_data_aoff_t o)
217{
218 return XFS_DIR2_BYTE_TO_DATAPTR(mp, XFS_DIR2_DB_OFF_TO_BYTE(mp, db, o));
219}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
221/*
222 * Convert block (dablk) to block (DB)
223 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224#define XFS_DIR2_DA_TO_DB(mp,da) xfs_dir2_da_to_db(mp, da)
Nathan Scotta844f452005-11-02 14:38:42 +1100225static inline xfs_dir2_db_t
226xfs_dir2_da_to_db(struct xfs_mount *mp, xfs_dablk_t da)
227{
228 return (xfs_dir2_db_t)((da) >> (mp)->m_sb.sb_dirblklog);
229}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
231/*
232 * Convert block (dablk) to byte offset in space
233 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234#define XFS_DIR2_DA_TO_BYTE(mp,da) xfs_dir2_da_to_byte(mp, da)
Nathan Scotta844f452005-11-02 14:38:42 +1100235static inline xfs_dir2_off_t
236xfs_dir2_da_to_byte(struct xfs_mount *mp, xfs_dablk_t da)
237{
238 return XFS_DIR2_DB_OFF_TO_BYTE(mp, XFS_DIR2_DA_TO_DB(mp, da), 0);
239}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
241/*
242 * Function declarations.
243 */
Nathan Scotta844f452005-11-02 14:38:42 +1100244extern int xfs_dir2_block_to_leaf(struct xfs_da_args *args,
245 struct xfs_dabuf *dbp);
246extern int xfs_dir2_leaf_addname(struct xfs_da_args *args);
247extern void xfs_dir2_leaf_compact(struct xfs_da_args *args,
248 struct xfs_dabuf *bp);
249extern void xfs_dir2_leaf_compact_x1(struct xfs_dabuf *bp, int *indexp,
250 int *lowstalep, int *highstalep,
251 int *lowlogp, int *highlogp);
252extern int xfs_dir2_leaf_getdents(struct xfs_trans *tp, struct xfs_inode *dp,
253 struct uio *uio, int *eofp,
254 struct xfs_dirent *dbp, xfs_dir2_put_t put);
255extern int xfs_dir2_leaf_init(struct xfs_da_args *args, xfs_dir2_db_t bno,
256 struct xfs_dabuf **bpp, int magic);
257extern void xfs_dir2_leaf_log_ents(struct xfs_trans *tp, struct xfs_dabuf *bp,
258 int first, int last);
259extern void xfs_dir2_leaf_log_header(struct xfs_trans *tp,
260 struct xfs_dabuf *bp);
261extern int xfs_dir2_leaf_lookup(struct xfs_da_args *args);
262extern int xfs_dir2_leaf_removename(struct xfs_da_args *args);
263extern int xfs_dir2_leaf_replace(struct xfs_da_args *args);
264extern int xfs_dir2_leaf_search_hash(struct xfs_da_args *args,
265 struct xfs_dabuf *lbp);
266extern int xfs_dir2_leaf_trim_data(struct xfs_da_args *args,
267 struct xfs_dabuf *lbp, xfs_dir2_db_t db);
268extern int xfs_dir2_node_to_leaf(struct xfs_da_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
270#endif /* __XFS_DIR2_LEAF_H__ */