[XFS] Update license/copyright notices to match the prefered SGI
[safe/jmp/linux-2.6] / fs / xfs / xfs_ialloc_btree.h
1 /*
2  * Copyright (c) 2000,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_IALLOC_BTREE_H__
19 #define __XFS_IALLOC_BTREE_H__
20
21 /*
22  * Inode map on-disk structures
23  */
24
25 struct xfs_buf;
26 struct xfs_btree_cur;
27 struct xfs_btree_sblock;
28 struct xfs_mount;
29
30 /*
31  * There is a btree for the inode map per allocation group.
32  */
33 #define XFS_IBT_MAGIC   0x49414254      /* 'IABT' */
34
35 typedef __uint64_t      xfs_inofree_t;
36 #define XFS_INODES_PER_CHUNK    (NBBY * sizeof(xfs_inofree_t))
37 #define XFS_INODES_PER_CHUNK_LOG        (XFS_NBBYLOG + 3)
38 #define XFS_INOBT_ALL_FREE      ((xfs_inofree_t)-1)
39
40 #define XFS_INOBT_MASKN(i,n)            xfs_inobt_maskn(i,n)
41 static inline xfs_inofree_t xfs_inobt_maskn(int i, int n)
42 {
43         return (((n) >= XFS_INODES_PER_CHUNK ? \
44                 (xfs_inofree_t)0 : ((xfs_inofree_t)1 << (n))) - 1) << (i);
45 }
46
47 /*
48  * Data record structure
49  */
50 typedef struct xfs_inobt_rec
51 {
52         xfs_agino_t     ir_startino;    /* starting inode number */
53         __int32_t       ir_freecount;   /* count of free inodes (set bits) */
54         xfs_inofree_t   ir_free;        /* free inode mask */
55 } xfs_inobt_rec_t;
56
57 /*
58  * Key structure
59  */
60 typedef struct xfs_inobt_key
61 {
62         xfs_agino_t     ir_startino;    /* starting inode number */
63 } xfs_inobt_key_t;
64
65 typedef xfs_agblock_t xfs_inobt_ptr_t;  /* btree pointer type */
66                                         /* btree block header type */
67 typedef struct xfs_btree_sblock xfs_inobt_block_t;
68
69 #define XFS_BUF_TO_INOBT_BLOCK(bp)      ((xfs_inobt_block_t *)XFS_BUF_PTR(bp))
70
71 /*
72  * Bit manipulations for ir_free.
73  */
74 #define XFS_INOBT_MASK(i)               ((xfs_inofree_t)1 << (i))
75 #define XFS_INOBT_IS_FREE(rp,i)         \
76                 (((rp)->ir_free & XFS_INOBT_MASK(i)) != 0)
77 #define XFS_INOBT_IS_FREE_DISK(rp,i)    \
78                 ((INT_GET((rp)->ir_free,ARCH_CONVERT) & XFS_INOBT_MASK(i)) != 0)
79 #define XFS_INOBT_SET_FREE(rp,i)        ((rp)->ir_free |= XFS_INOBT_MASK(i))
80 #define XFS_INOBT_CLR_FREE(rp,i)        ((rp)->ir_free &= ~XFS_INOBT_MASK(i))
81
82 /*
83  * Real block structures have a size equal to the disk block size.
84  */
85 #define XFS_INOBT_BLOCK_SIZE(lev,cur)   (1 << (cur)->bc_blocklog)
86 #define XFS_INOBT_BLOCK_MAXRECS(lev,cur) ((cur)->bc_mp->m_inobt_mxr[lev != 0])
87 #define XFS_INOBT_BLOCK_MINRECS(lev,cur) ((cur)->bc_mp->m_inobt_mnr[lev != 0])
88 #define XFS_INOBT_IS_LAST_REC(cur)      \
89         ((cur)->bc_ptrs[0] == INT_GET(XFS_BUF_TO_INOBT_BLOCK((cur)->bc_bufs[0])->bb_numrecs, ARCH_CONVERT))
90
91 /*
92  * Maximum number of inode btree levels.
93  */
94 #define XFS_IN_MAXLEVELS(mp)            ((mp)->m_in_maxlevels)
95
96 /*
97  * block numbers in the AG.
98  */
99 #define XFS_IBT_BLOCK(mp)               ((xfs_agblock_t)(XFS_CNT_BLOCK(mp) + 1))
100 #define XFS_PREALLOC_BLOCKS(mp)         ((xfs_agblock_t)(XFS_IBT_BLOCK(mp) + 1))
101
102 /*
103  * Record, key, and pointer address macros for btree blocks.
104  */
105 #define XFS_INOBT_REC_ADDR(bb,i,cur) \
106         (XFS_BTREE_REC_ADDR(XFS_INOBT_BLOCK_SIZE(0,cur), xfs_inobt, bb, \
107                                 i, XFS_INOBT_BLOCK_MAXRECS(0, cur)))
108 #define XFS_INOBT_KEY_ADDR(bb,i,cur) \
109         (XFS_BTREE_KEY_ADDR(XFS_INOBT_BLOCK_SIZE(1,cur), xfs_inobt, bb, \
110                                 i, XFS_INOBT_BLOCK_MAXRECS(1, cur)))
111
112 #define XFS_INOBT_PTR_ADDR(bb,i,cur) \
113         (XFS_BTREE_PTR_ADDR(XFS_INOBT_BLOCK_SIZE(1,cur), xfs_inobt, bb, \
114                                 i, XFS_INOBT_BLOCK_MAXRECS(1, cur)))
115
116 /*
117  * Decrement cursor by one record at the level.
118  * For nonzero levels the leaf-ward information is untouched.
119  */
120 extern int xfs_inobt_decrement(struct xfs_btree_cur *cur, int level, int *stat);
121
122 /*
123  * Delete the record pointed to by cur.
124  * The cursor refers to the place where the record was (could be inserted)
125  * when the operation returns.
126  */
127 extern int xfs_inobt_delete(struct xfs_btree_cur *cur, int *stat);
128
129 /*
130  * Get the data from the pointed-to record.
131  */
132 extern int xfs_inobt_get_rec(struct xfs_btree_cur *cur, xfs_agino_t *ino,
133                              __int32_t *fcnt, xfs_inofree_t *free, int *stat);
134
135 /*
136  * Increment cursor by one record at the level.
137  * For nonzero levels the leaf-ward information is untouched.
138  */
139 extern int xfs_inobt_increment(struct xfs_btree_cur *cur, int level, int *stat);
140
141 /*
142  * Insert the current record at the point referenced by cur.
143  * The cursor may be inconsistent on return if splits have been done.
144  */
145 extern int xfs_inobt_insert(struct xfs_btree_cur *cur, int *stat);
146
147 /*
148  * Lookup the record equal to ino in the btree given by cur.
149  */
150 extern int xfs_inobt_lookup_eq(struct xfs_btree_cur *cur, xfs_agino_t ino,
151                                 __int32_t fcnt, xfs_inofree_t free, int *stat);
152
153 /*
154  * Lookup the first record greater than or equal to ino
155  * in the btree given by cur.
156  */
157 extern int xfs_inobt_lookup_ge(struct xfs_btree_cur *cur, xfs_agino_t ino,
158                                 __int32_t fcnt, xfs_inofree_t free, int *stat);
159
160 /*
161  * Lookup the first record less than or equal to ino
162  * in the btree given by cur.
163  */
164 extern int xfs_inobt_lookup_le(struct xfs_btree_cur *cur, xfs_agino_t ino,
165                                 __int32_t fcnt, xfs_inofree_t free, int *stat);
166
167 /*
168  * Update the record referred to by cur, to the value given
169  * by [ino, fcnt, free].
170  * This either works (return 0) or gets an EFSCORRUPTED error.
171  */
172 extern int xfs_inobt_update(struct xfs_btree_cur *cur, xfs_agino_t ino,
173                                 __int32_t fcnt, xfs_inofree_t free);
174
175 #endif  /* __XFS_IALLOC_BTREE_H__ */