blob: 70c97f3f815e18b93ac29f29c0b14a8c19032e17 [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) \
Christoph Hellwigbbaaf532007-06-28 16:43:50 +100035 xfs_dir2_byte_to_db(mp, XFS_DIR2_LEAF_OFFSET)
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
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 */
Nathan Scotta818e5d2006-03-17 17:28:07 +110049 __be16 count; /* count of entries */
50 __be16 stale; /* count of stale entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -070051} xfs_dir2_leaf_hdr_t;
52
53/*
54 * Leaf block entry.
55 */
56typedef struct xfs_dir2_leaf_entry {
Nathan Scott3c1f9c12006-03-17 17:28:18 +110057 __be32 hashval; /* hash value of name */
58 __be32 address; /* address of data entry */
Linus Torvalds1da177e2005-04-16 15:20:36 -070059} xfs_dir2_leaf_entry_t;
60
61/*
62 * Leaf block tail.
63 */
64typedef struct xfs_dir2_leaf_tail {
Nathan Scottafbcb3f2006-03-17 17:27:28 +110065 __be32 bestcount;
Linus Torvalds1da177e2005-04-16 15:20:36 -070066} 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 +110085static inline int xfs_dir2_max_leaf_ents(struct xfs_mount *mp)
86{
87 return (int)(((mp)->m_dirblksize - (uint)sizeof(xfs_dir2_leaf_hdr_t)) /
88 (uint)sizeof(xfs_dir2_leaf_entry_t));
89}
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
91/*
92 * Get address of the bestcount field in the single-leaf block.
93 */
Nathan Scotta844f452005-11-02 14:38:42 +110094static inline xfs_dir2_leaf_tail_t *
95xfs_dir2_leaf_tail_p(struct xfs_mount *mp, xfs_dir2_leaf_t *lp)
96{
97 return (xfs_dir2_leaf_tail_t *)
98 ((char *)(lp) + (mp)->m_dirblksize -
99 (uint)sizeof(xfs_dir2_leaf_tail_t));
100}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102/*
103 * Get address of the bests array in the single-leaf block.
104 */
Nathan Scott68b3a102006-03-17 17:27:19 +1100105static inline __be16 *
Nathan Scotta844f452005-11-02 14:38:42 +1100106xfs_dir2_leaf_bests_p(xfs_dir2_leaf_tail_t *ltp)
107{
Nathan Scottafbcb3f2006-03-17 17:27:28 +1100108 return (__be16 *)ltp - be32_to_cpu(ltp->bestcount);
Nathan Scotta844f452005-11-02 14:38:42 +1100109}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111/*
112 * Convert dataptr to byte in file space
113 */
Nathan Scotta844f452005-11-02 14:38:42 +1100114static inline xfs_dir2_off_t
115xfs_dir2_dataptr_to_byte(struct xfs_mount *mp, xfs_dir2_dataptr_t dp)
116{
117 return (xfs_dir2_off_t)(dp) << XFS_DIR2_DATA_ALIGN_LOG;
118}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120/*
121 * Convert byte in file space to dataptr. It had better be aligned.
122 */
Nathan Scotta844f452005-11-02 14:38:42 +1100123static inline xfs_dir2_dataptr_t
124xfs_dir2_byte_to_dataptr(struct xfs_mount *mp, xfs_dir2_off_t by)
125{
126 return (xfs_dir2_dataptr_t)((by) >> XFS_DIR2_DATA_ALIGN_LOG);
127}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129/*
130 * Convert byte in space to (DB) block
131 */
Nathan Scotta844f452005-11-02 14:38:42 +1100132static inline xfs_dir2_db_t
133xfs_dir2_byte_to_db(struct xfs_mount *mp, xfs_dir2_off_t by)
134{
135 return (xfs_dir2_db_t)((by) >> \
136 ((mp)->m_sb.sb_blocklog + (mp)->m_sb.sb_dirblklog));
137}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139/*
Nathan Scotta844f452005-11-02 14:38:42 +1100140 * Convert dataptr to a block number
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 */
Nathan Scotta844f452005-11-02 14:38:42 +1100142static inline xfs_dir2_db_t
143xfs_dir2_dataptr_to_db(struct xfs_mount *mp, xfs_dir2_dataptr_t dp)
144{
Christoph Hellwigbbaaf532007-06-28 16:43:50 +1000145 return xfs_dir2_byte_to_db(mp, xfs_dir2_dataptr_to_byte(mp, dp));
Nathan Scotta844f452005-11-02 14:38:42 +1100146}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
148/*
149 * Convert byte in space to offset in a block
150 */
Nathan Scotta844f452005-11-02 14:38:42 +1100151static inline xfs_dir2_data_aoff_t
152xfs_dir2_byte_to_off(struct xfs_mount *mp, xfs_dir2_off_t by)
153{
154 return (xfs_dir2_data_aoff_t)((by) & \
155 ((1 << ((mp)->m_sb.sb_blocklog + (mp)->m_sb.sb_dirblklog)) - 1));
156}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158/*
Nathan Scotta844f452005-11-02 14:38:42 +1100159 * Convert dataptr to a byte offset in a block
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 */
Nathan Scotta844f452005-11-02 14:38:42 +1100161static inline xfs_dir2_data_aoff_t
162xfs_dir2_dataptr_to_off(struct xfs_mount *mp, xfs_dir2_dataptr_t dp)
163{
Christoph Hellwigbbaaf532007-06-28 16:43:50 +1000164 return xfs_dir2_byte_to_off(mp, xfs_dir2_dataptr_to_byte(mp, dp));
Nathan Scotta844f452005-11-02 14:38:42 +1100165}
166
167/*
168 * Convert block and offset to byte in space
169 */
Nathan Scotta844f452005-11-02 14:38:42 +1100170static inline xfs_dir2_off_t
171xfs_dir2_db_off_to_byte(struct xfs_mount *mp, xfs_dir2_db_t db,
172 xfs_dir2_data_aoff_t o)
173{
174 return ((xfs_dir2_off_t)(db) << \
175 ((mp)->m_sb.sb_blocklog + (mp)->m_sb.sb_dirblklog)) + (o);
176}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
178/*
179 * Convert block (DB) to block (dablk)
180 */
Nathan Scotta844f452005-11-02 14:38:42 +1100181static inline xfs_dablk_t
182xfs_dir2_db_to_da(struct xfs_mount *mp, xfs_dir2_db_t db)
183{
184 return (xfs_dablk_t)((db) << (mp)->m_sb.sb_dirblklog);
185}
186
187/*
188 * Convert byte in space to (DA) block
189 */
Nathan Scotta844f452005-11-02 14:38:42 +1100190static inline xfs_dablk_t
191xfs_dir2_byte_to_da(struct xfs_mount *mp, xfs_dir2_off_t by)
192{
Christoph Hellwigbbaaf532007-06-28 16:43:50 +1000193 return xfs_dir2_db_to_da(mp, xfs_dir2_byte_to_db(mp, by));
Nathan Scotta844f452005-11-02 14:38:42 +1100194}
195
196/*
197 * Convert block and offset to dataptr
198 */
Nathan Scotta844f452005-11-02 14:38:42 +1100199static inline xfs_dir2_dataptr_t
200xfs_dir2_db_off_to_dataptr(struct xfs_mount *mp, xfs_dir2_db_t db,
201 xfs_dir2_data_aoff_t o)
202{
Christoph Hellwigbbaaf532007-06-28 16:43:50 +1000203 return xfs_dir2_byte_to_dataptr(mp, xfs_dir2_db_off_to_byte(mp, db, o));
Nathan Scotta844f452005-11-02 14:38:42 +1100204}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
206/*
207 * Convert block (dablk) to block (DB)
208 */
Nathan Scotta844f452005-11-02 14:38:42 +1100209static inline xfs_dir2_db_t
210xfs_dir2_da_to_db(struct xfs_mount *mp, xfs_dablk_t da)
211{
212 return (xfs_dir2_db_t)((da) >> (mp)->m_sb.sb_dirblklog);
213}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
215/*
216 * Convert block (dablk) to byte offset in space
217 */
Nathan Scotta844f452005-11-02 14:38:42 +1100218static inline xfs_dir2_off_t
219xfs_dir2_da_to_byte(struct xfs_mount *mp, xfs_dablk_t da)
220{
Christoph Hellwigbbaaf532007-06-28 16:43:50 +1000221 return xfs_dir2_db_off_to_byte(mp, xfs_dir2_da_to_db(mp, da), 0);
Nathan Scotta844f452005-11-02 14:38:42 +1100222}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
224/*
225 * Function declarations.
226 */
Nathan Scotta844f452005-11-02 14:38:42 +1100227extern int xfs_dir2_block_to_leaf(struct xfs_da_args *args,
228 struct xfs_dabuf *dbp);
229extern int xfs_dir2_leaf_addname(struct xfs_da_args *args);
230extern void xfs_dir2_leaf_compact(struct xfs_da_args *args,
231 struct xfs_dabuf *bp);
232extern void xfs_dir2_leaf_compact_x1(struct xfs_dabuf *bp, int *indexp,
233 int *lowstalep, int *highstalep,
234 int *lowlogp, int *highlogp);
235extern int xfs_dir2_leaf_getdents(struct xfs_trans *tp, struct xfs_inode *dp,
236 struct uio *uio, int *eofp,
237 struct xfs_dirent *dbp, xfs_dir2_put_t put);
238extern int xfs_dir2_leaf_init(struct xfs_da_args *args, xfs_dir2_db_t bno,
239 struct xfs_dabuf **bpp, int magic);
240extern void xfs_dir2_leaf_log_ents(struct xfs_trans *tp, struct xfs_dabuf *bp,
241 int first, int last);
242extern void xfs_dir2_leaf_log_header(struct xfs_trans *tp,
243 struct xfs_dabuf *bp);
244extern int xfs_dir2_leaf_lookup(struct xfs_da_args *args);
245extern int xfs_dir2_leaf_removename(struct xfs_da_args *args);
246extern int xfs_dir2_leaf_replace(struct xfs_da_args *args);
247extern int xfs_dir2_leaf_search_hash(struct xfs_da_args *args,
248 struct xfs_dabuf *lbp);
249extern int xfs_dir2_leaf_trim_data(struct xfs_da_args *args,
250 struct xfs_dabuf *lbp, xfs_dir2_db_t db);
251extern int xfs_dir2_node_to_leaf(struct xfs_da_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
253#endif /* __XFS_DIR2_LEAF_H__ */