blob: 8be0b00ede9aafc83970a23e4ad9c7df2565b54d [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2000,2002,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_DA_BTREE_H__
19#define __XFS_DA_BTREE_H__
20
21struct xfs_buf;
22struct xfs_bmap_free;
23struct xfs_inode;
24struct xfs_mount;
25struct xfs_trans;
26struct zone;
27
28/*========================================================================
29 * Directory Structure when greater than XFS_LBSIZE(mp) bytes.
30 *========================================================================*/
31
32/*
33 * This structure is common to both leaf nodes and non-leaf nodes in the Btree.
34 *
35 * Is is used to manage a doubly linked list of all blocks at the same
36 * level in the Btree, and to identify which type of block this is.
37 */
38#define XFS_DA_NODE_MAGIC 0xfebe /* magic number: non-leaf blocks */
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#define XFS_ATTR_LEAF_MAGIC 0xfbee /* magic number: attribute leaf blks */
40#define XFS_DIR2_LEAF1_MAGIC 0xd2f1 /* magic number: v2 dirlf single blks */
41#define XFS_DIR2_LEAFN_MAGIC 0xd2ff /* magic number: v2 dirlf multi blks */
42
Linus Torvalds1da177e2005-04-16 15:20:36 -070043typedef struct xfs_da_blkinfo {
Nathan Scott89da0542006-03-17 17:28:40 +110044 __be32 forw; /* previous block in list */
45 __be32 back; /* following block in list */
46 __be16 magic; /* validity check on block */
47 __be16 pad; /* unused */
Linus Torvalds1da177e2005-04-16 15:20:36 -070048} xfs_da_blkinfo_t;
49
50/*
51 * This is the structure of the root and intermediate nodes in the Btree.
52 * The leaf nodes are defined above.
53 *
54 * Entries are not packed.
55 *
56 * Since we have duplicate keys, use a binary search but always follow
57 * all match in the block, not just the first match found.
58 */
59#define XFS_DA_NODE_MAXDEPTH 5 /* max depth of Btree */
60
61typedef struct xfs_da_intnode {
62 struct xfs_da_node_hdr { /* constant-structure header block */
63 xfs_da_blkinfo_t info; /* block type, links, etc. */
Nathan Scottfac80cc2006-03-17 17:29:56 +110064 __be16 count; /* count of active entries */
65 __be16 level; /* level above leaves (leaf == 0) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 } hdr;
67 struct xfs_da_node_entry {
Nathan Scott403432d2006-03-17 17:29:46 +110068 __be32 hashval; /* hash value for this descendant */
69 __be32 before; /* Btree block before this key */
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 } btree[1]; /* variable sized array of keys */
71} xfs_da_intnode_t;
72typedef struct xfs_da_node_hdr xfs_da_node_hdr_t;
73typedef struct xfs_da_node_entry xfs_da_node_entry_t;
74
75#define XFS_DA_MAXHASH ((xfs_dahash_t)-1) /* largest valid hash value */
76
Nathan Scotta844f452005-11-02 14:38:42 +110077#define XFS_LBSIZE(mp) (mp)->m_sb.sb_blocksize
78#define XFS_LBLOG(mp) (mp)->m_sb.sb_blocklog
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Linus Torvalds1da177e2005-04-16 15:20:36 -070080#define XFS_DA_MAKE_BNOENTRY(mp,bno,entry) \
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 (((bno) << (mp)->m_dircook_elog) | (entry))
Linus Torvalds1da177e2005-04-16 15:20:36 -070082#define XFS_DA_MAKE_COOKIE(mp,bno,entry,hash) \
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 (((xfs_off_t)XFS_DA_MAKE_BNOENTRY(mp, bno, entry) << 32) | (hash))
Nathan Scotta844f452005-11-02 14:38:42 +110084#define XFS_DA_COOKIE_HASH(mp,cookie) ((xfs_dahash_t)cookie)
85#define XFS_DA_COOKIE_BNO(mp,cookie) \
86 ((((xfs_off_t)(cookie) >> 31) == -1LL ? \
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 (xfs_dablk_t)0 : \
Nathan Scotta844f452005-11-02 14:38:42 +110088 (xfs_dablk_t)((xfs_off_t)(cookie) >> \
89 ((mp)->m_dircook_elog + 32))))
90#define XFS_DA_COOKIE_ENTRY(mp,cookie) \
91 ((((xfs_off_t)(cookie) >> 31) == -1LL ? \
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 (xfs_dablk_t)0 : \
93 (xfs_dablk_t)(((xfs_off_t)(cookie) >> 32) & \
Nathan Scotta844f452005-11-02 14:38:42 +110094 ((1 << (mp)->m_dircook_elog) - 1))))
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
96
97/*========================================================================
98 * Btree searching and modification structure definitions.
99 *========================================================================*/
100
101/*
Barry Naujok5163f952008-05-21 16:41:01 +1000102 * Search comparison results
103 */
104enum xfs_dacmp {
105 XFS_CMP_DIFFERENT, /* names are completely different */
106 XFS_CMP_EXACT, /* names are exactly the same */
107 XFS_CMP_CASE /* names are same but differ in case */
108};
109
110/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 * Structure to ease passing around component names.
112 */
113typedef struct xfs_da_args {
Nathan Scott80cce772005-11-02 11:43:04 +1100114 const uchar_t *name; /* string (maybe not NULL terminated) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 int namelen; /* length of string (maybe no NULL) */
116 uchar_t *value; /* set of bytes (maybe contain NULLs) */
117 int valuelen; /* length of value */
118 int flags; /* argument flags (eg: ATTR_NOCREATE) */
119 xfs_dahash_t hashval; /* hash value of name */
120 xfs_ino_t inumber; /* input/output inode number */
121 struct xfs_inode *dp; /* directory inode to manipulate */
122 xfs_fsblock_t *firstblock; /* ptr to firstblock for bmap calls */
123 struct xfs_bmap_free *flist; /* ptr to freelist for bmap_finish */
124 struct xfs_trans *trans; /* current trans (changes over time) */
125 xfs_extlen_t total; /* total blocks needed, for 1st bmap */
126 int whichfork; /* data or attribute fork */
127 xfs_dablk_t blkno; /* blkno of attr leaf of interest */
128 int index; /* index of attr of interest in blk */
129 xfs_dablk_t rmtblkno; /* remote attr value starting blkno */
130 int rmtblkcnt; /* remote attr value block count */
131 xfs_dablk_t blkno2; /* blkno of 2nd attr leaf of interest */
132 int index2; /* index of 2nd attr in blk */
133 xfs_dablk_t rmtblkno2; /* remote attr value starting blkno */
134 int rmtblkcnt2; /* remote attr value block count */
Barry Naujok6a178102008-05-21 16:42:05 +1000135 int op_flags; /* operation flags */
Barry Naujok5163f952008-05-21 16:41:01 +1000136 enum xfs_dacmp cmpresult; /* name compare result for lookups */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137} xfs_da_args_t;
138
139/*
Barry Naujok6a178102008-05-21 16:42:05 +1000140 * Operation flags:
141 */
142#define XFS_DA_OP_JUSTCHECK 0x0001 /* check for ok with no space */
143#define XFS_DA_OP_RENAME 0x0002 /* this is an atomic rename op */
144#define XFS_DA_OP_ADDNAME 0x0004 /* this is an add operation */
145#define XFS_DA_OP_OKNOENT 0x0008 /* lookup/add op, ENOENT ok, else die */
Barry Naujok384f3ce2008-05-21 16:58:22 +1000146#define XFS_DA_OP_CILOOKUP 0x0010 /* lookup to return CI name if found */
Barry Naujok6a178102008-05-21 16:42:05 +1000147
148/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 * Structure to describe buffer(s) for a block.
150 * This is needed in the directory version 2 format case, when
151 * multiple non-contiguous fsblocks might be needed to cover one
152 * logical directory block.
153 * If the buffer count is 1 then the data pointer points to the
154 * same place as the b_addr field for the buffer, else to kmem_alloced memory.
155 */
156typedef struct xfs_dabuf {
157 int nbuf; /* number of buffer pointers present */
158 short dirty; /* data needs to be copied back */
159 short bbcount; /* how large is data in bbs */
160 void *data; /* pointer for buffers' data */
161#ifdef XFS_DABUF_DEBUG
162 inst_t *ra; /* return address of caller to make */
163 struct xfs_dabuf *next; /* next in global chain */
164 struct xfs_dabuf *prev; /* previous in global chain */
165 struct xfs_buftarg *target; /* device for buffer */
166 xfs_daddr_t blkno; /* daddr first in bps[0] */
167#endif
168 struct xfs_buf *bps[1]; /* actually nbuf of these */
169} xfs_dabuf_t;
170#define XFS_DA_BUF_SIZE(n) \
171 (sizeof(xfs_dabuf_t) + sizeof(struct xfs_buf *) * ((n) - 1))
172
173#ifdef XFS_DABUF_DEBUG
174extern xfs_dabuf_t *xfs_dabuf_global_list;
175#endif
176
177/*
178 * Storage for holding state during Btree searches and split/join ops.
179 *
180 * Only need space for 5 intermediate nodes. With a minimum of 62-way
181 * fanout to the Btree, we can support over 900 million directory blocks,
182 * which is slightly more than enough.
183 */
184typedef struct xfs_da_state_blk {
185 xfs_dabuf_t *bp; /* buffer containing block */
186 xfs_dablk_t blkno; /* filesystem blkno of buffer */
187 xfs_daddr_t disk_blkno; /* on-disk blkno (in BBs) of buffer */
188 int index; /* relevant index into block */
189 xfs_dahash_t hashval; /* last hash value in block */
190 int magic; /* blk's magic number, ie: blk type */
191} xfs_da_state_blk_t;
192
193typedef struct xfs_da_state_path {
194 int active; /* number of active levels */
195 xfs_da_state_blk_t blk[XFS_DA_NODE_MAXDEPTH];
196} xfs_da_state_path_t;
197
198typedef struct xfs_da_state {
199 xfs_da_args_t *args; /* filename arguments */
200 struct xfs_mount *mp; /* filesystem mount point */
201 unsigned int blocksize; /* logical block size */
202 unsigned int node_ents; /* how many entries in danode */
203 xfs_da_state_path_t path; /* search/split paths */
204 xfs_da_state_path_t altpath; /* alternate path for join */
205 unsigned char inleaf; /* insert into 1->lf, 0->splf */
206 unsigned char extravalid; /* T/F: extrablk is in use */
207 unsigned char extraafter; /* T/F: extrablk is after new */
208 xfs_da_state_blk_t extrablk; /* for double-splits on leafs */
209 /* for dirv2 extrablk is data */
210} xfs_da_state_t;
211
212/*
213 * Utility macros to aid in logging changed structure fields.
214 */
215#define XFS_DA_LOGOFF(BASE, ADDR) ((char *)(ADDR) - (char *)(BASE))
216#define XFS_DA_LOGRANGE(BASE, ADDR, SIZE) \
217 (uint)(XFS_DA_LOGOFF(BASE, ADDR)), \
218 (uint)(XFS_DA_LOGOFF(BASE, ADDR)+(SIZE)-1)
219
Barry Naujok5163f952008-05-21 16:41:01 +1000220/*
221 * Name ops for directory and/or attr name operations
222 */
223struct xfs_nameops {
224 xfs_dahash_t (*hashname)(struct xfs_name *);
225 enum xfs_dacmp (*compname)(struct xfs_da_args *, const char *, int);
226};
227
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
229#ifdef __KERNEL__
230/*========================================================================
231 * Function prototypes for the kernel.
232 *========================================================================*/
233
234/*
235 * Routines used for growing the Btree.
236 */
237int xfs_da_node_create(xfs_da_args_t *args, xfs_dablk_t blkno, int level,
238 xfs_dabuf_t **bpp, int whichfork);
239int xfs_da_split(xfs_da_state_t *state);
240
241/*
242 * Routines used for shrinking the Btree.
243 */
244int xfs_da_join(xfs_da_state_t *state);
245void xfs_da_fixhashpath(xfs_da_state_t *state,
246 xfs_da_state_path_t *path_to_to_fix);
247
248/*
249 * Routines used for finding things in the Btree.
250 */
251int xfs_da_node_lookup_int(xfs_da_state_t *state, int *result);
252int xfs_da_path_shift(xfs_da_state_t *state, xfs_da_state_path_t *path,
253 int forward, int release, int *result);
254/*
255 * Utility routines.
256 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257int xfs_da_blk_link(xfs_da_state_t *state, xfs_da_state_blk_t *old_blk,
258 xfs_da_state_blk_t *new_blk);
259
260/*
261 * Utility routines.
262 */
263int xfs_da_grow_inode(xfs_da_args_t *args, xfs_dablk_t *new_blkno);
264int xfs_da_get_buf(struct xfs_trans *trans, struct xfs_inode *dp,
265 xfs_dablk_t bno, xfs_daddr_t mappedbno,
266 xfs_dabuf_t **bp, int whichfork);
267int xfs_da_read_buf(struct xfs_trans *trans, struct xfs_inode *dp,
268 xfs_dablk_t bno, xfs_daddr_t mappedbno,
269 xfs_dabuf_t **bpp, int whichfork);
270xfs_daddr_t xfs_da_reada_buf(struct xfs_trans *trans, struct xfs_inode *dp,
271 xfs_dablk_t bno, int whichfork);
272int xfs_da_shrink_inode(xfs_da_args_t *args, xfs_dablk_t dead_blkno,
273 xfs_dabuf_t *dead_buf);
274
Nathan Scott80cce772005-11-02 11:43:04 +1100275uint xfs_da_hashname(const uchar_t *name_string, int name_length);
Barry Naujok5163f952008-05-21 16:41:01 +1000276enum xfs_dacmp xfs_da_compname(struct xfs_da_args *args,
277 const char *name, int len);
278
279
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280xfs_da_state_t *xfs_da_state_alloc(void);
281void xfs_da_state_free(xfs_da_state_t *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
283void xfs_da_buf_done(xfs_dabuf_t *dabuf);
284void xfs_da_log_buf(struct xfs_trans *tp, xfs_dabuf_t *dabuf, uint first,
285 uint last);
286void xfs_da_brelse(struct xfs_trans *tp, xfs_dabuf_t *dabuf);
287void xfs_da_binval(struct xfs_trans *tp, xfs_dabuf_t *dabuf);
288xfs_daddr_t xfs_da_blkno(xfs_dabuf_t *dabuf);
289
290extern struct kmem_zone *xfs_da_state_zone;
David Chinnera8272ce2007-11-23 16:28:09 +1100291extern struct kmem_zone *xfs_dabuf_zone;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292#endif /* __KERNEL__ */
293
294#endif /* __XFS_DA_BTREE_H__ */