xfs: add CRC checks to the AGF
[deliverable/linux.git] / fs / xfs / xfs_ag.h
CommitLineData
1da177e4 1/*
7b718769
NS
2 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
1da177e4 4 *
7b718769
NS
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
1da177e4
LT
7 * published by the Free Software Foundation.
8 *
7b718769
NS
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.
1da177e4 13 *
7b718769
NS
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
1da177e4
LT
17 */
18#ifndef __XFS_AG_H__
19#define __XFS_AG_H__
20
21/*
22 * Allocation group header
23 * This is divided into three structures, placed in sequential 512-byte
24 * buffers after a copy of the superblock (also in a 512-byte buffer).
25 */
26
27struct xfs_buf;
28struct xfs_mount;
29struct xfs_trans;
30
31#define XFS_AGF_MAGIC 0x58414746 /* 'XAGF' */
32#define XFS_AGI_MAGIC 0x58414749 /* 'XAGI' */
33#define XFS_AGF_VERSION 1
34#define XFS_AGI_VERSION 1
a844f451
NS
35
36#define XFS_AGF_GOOD_VERSION(v) ((v) == XFS_AGF_VERSION)
37#define XFS_AGI_GOOD_VERSION(v) ((v) == XFS_AGI_VERSION)
1da177e4
LT
38
39/*
40 * Btree number 0 is bno, 1 is cnt. This value gives the size of the
41 * arrays below.
42 */
43#define XFS_BTNUM_AGF ((int)XFS_BTNUM_CNTi + 1)
44
45/*
46 * The second word of agf_levels in the first a.g. overlaps the EFS
47 * superblock's magic number. Since the magic numbers valid for EFS
48 * are > 64k, our value cannot be confused for an EFS superblock's.
49 */
50
16259e7d 51typedef struct xfs_agf {
1da177e4
LT
52 /*
53 * Common allocation group header information
54 */
16259e7d
CH
55 __be32 agf_magicnum; /* magic number == XFS_AGF_MAGIC */
56 __be32 agf_versionnum; /* header version == XFS_AGF_VERSION */
57 __be32 agf_seqno; /* sequence # starting from 0 */
58 __be32 agf_length; /* size in blocks of a.g. */
1da177e4
LT
59 /*
60 * Freespace information
61 */
16259e7d
CH
62 __be32 agf_roots[XFS_BTNUM_AGF]; /* root blocks */
63 __be32 agf_spare0; /* spare field */
64 __be32 agf_levels[XFS_BTNUM_AGF]; /* btree levels */
65 __be32 agf_spare1; /* spare field */
4e0e6040 66
16259e7d
CH
67 __be32 agf_flfirst; /* first freelist block's index */
68 __be32 agf_fllast; /* last freelist block's index */
69 __be32 agf_flcount; /* count of blocks in freelist */
70 __be32 agf_freeblks; /* total free blocks */
4e0e6040 71
16259e7d 72 __be32 agf_longest; /* longest free space */
92821e2b 73 __be32 agf_btreeblks; /* # of blocks held in AGF btrees */
4e0e6040
DC
74 uuid_t agf_uuid; /* uuid of filesystem */
75
76 /*
77 * reserve some contiguous space for future logged fields before we add
78 * the unlogged fields. This makes the range logging via flags and
79 * structure offsets much simpler.
80 */
81 __be64 agf_spare64[16];
82
83 /* unlogged fields, written during buffer writeback. */
84 __be64 agf_lsn; /* last write sequence */
85 __be32 agf_crc; /* crc of agf sector */
86 __be32 agf_spare2;
87
88 /* structure must be padded to 64 bit alignment */
1da177e4
LT
89} xfs_agf_t;
90
91#define XFS_AGF_MAGICNUM 0x00000001
92#define XFS_AGF_VERSIONNUM 0x00000002
93#define XFS_AGF_SEQNO 0x00000004
94#define XFS_AGF_LENGTH 0x00000008
95#define XFS_AGF_ROOTS 0x00000010
96#define XFS_AGF_LEVELS 0x00000020
97#define XFS_AGF_FLFIRST 0x00000040
98#define XFS_AGF_FLLAST 0x00000080
99#define XFS_AGF_FLCOUNT 0x00000100
100#define XFS_AGF_FREEBLKS 0x00000200
101#define XFS_AGF_LONGEST 0x00000400
92821e2b 102#define XFS_AGF_BTREEBLKS 0x00000800
4e0e6040
DC
103#define XFS_AGF_UUID 0x00001000
104#define XFS_AGF_NUM_BITS 13
1da177e4
LT
105#define XFS_AGF_ALL_BITS ((1 << XFS_AGF_NUM_BITS) - 1)
106
0b1b213f
CH
107#define XFS_AGF_FLAGS \
108 { XFS_AGF_MAGICNUM, "MAGICNUM" }, \
109 { XFS_AGF_VERSIONNUM, "VERSIONNUM" }, \
110 { XFS_AGF_SEQNO, "SEQNO" }, \
111 { XFS_AGF_LENGTH, "LENGTH" }, \
112 { XFS_AGF_ROOTS, "ROOTS" }, \
113 { XFS_AGF_LEVELS, "LEVELS" }, \
114 { XFS_AGF_FLFIRST, "FLFIRST" }, \
115 { XFS_AGF_FLLAST, "FLLAST" }, \
116 { XFS_AGF_FLCOUNT, "FLCOUNT" }, \
117 { XFS_AGF_FREEBLKS, "FREEBLKS" }, \
118 { XFS_AGF_LONGEST, "LONGEST" }, \
4e0e6040
DC
119 { XFS_AGF_BTREEBLKS, "BTREEBLKS" }, \
120 { XFS_AGF_UUID, "UUID" }
0b1b213f 121
1da177e4
LT
122/* disk block (xfs_daddr_t) in the AG */
123#define XFS_AGF_DADDR(mp) ((xfs_daddr_t)(1 << (mp)->m_sectbb_log))
a844f451 124#define XFS_AGF_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGF_DADDR(mp))
62926044 125#define XFS_BUF_TO_AGF(bp) ((xfs_agf_t *)((bp)->b_addr))
a844f451 126
fef1111e
ES
127extern int xfs_read_agf(struct xfs_mount *mp, struct xfs_trans *tp,
128 xfs_agnumber_t agno, int flags, struct xfs_buf **bpp);
129
1813dd64
DC
130extern const struct xfs_buf_ops xfs_agf_buf_ops;
131
1da177e4
LT
132/*
133 * Size of the unlinked inode hash table in the agi.
134 */
135#define XFS_AGI_UNLINKED_BUCKETS 64
136
16259e7d 137typedef struct xfs_agi {
1da177e4
LT
138 /*
139 * Common allocation group header information
140 */
16259e7d
CH
141 __be32 agi_magicnum; /* magic number == XFS_AGI_MAGIC */
142 __be32 agi_versionnum; /* header version == XFS_AGI_VERSION */
143 __be32 agi_seqno; /* sequence # starting from 0 */
144 __be32 agi_length; /* size in blocks of a.g. */
1da177e4
LT
145 /*
146 * Inode information
147 * Inodes are mapped by interpreting the inode number, so no
148 * mapping data is needed here.
149 */
16259e7d
CH
150 __be32 agi_count; /* count of allocated inodes */
151 __be32 agi_root; /* root of inode btree */
152 __be32 agi_level; /* levels in inode btree */
153 __be32 agi_freecount; /* number of free inodes */
154 __be32 agi_newino; /* new inode just allocated */
155 __be32 agi_dirino; /* last directory inode chunk */
1da177e4
LT
156 /*
157 * Hash table of inodes which have been unlinked but are
158 * still being referenced.
159 */
16259e7d 160 __be32 agi_unlinked[XFS_AGI_UNLINKED_BUCKETS];
1da177e4
LT
161} xfs_agi_t;
162
163#define XFS_AGI_MAGICNUM 0x00000001
164#define XFS_AGI_VERSIONNUM 0x00000002
165#define XFS_AGI_SEQNO 0x00000004
166#define XFS_AGI_LENGTH 0x00000008
167#define XFS_AGI_COUNT 0x00000010
168#define XFS_AGI_ROOT 0x00000020
169#define XFS_AGI_LEVEL 0x00000040
170#define XFS_AGI_FREECOUNT 0x00000080
171#define XFS_AGI_NEWINO 0x00000100
172#define XFS_AGI_DIRINO 0x00000200
173#define XFS_AGI_UNLINKED 0x00000400
174#define XFS_AGI_NUM_BITS 11
175#define XFS_AGI_ALL_BITS ((1 << XFS_AGI_NUM_BITS) - 1)
176
177/* disk block (xfs_daddr_t) in the AG */
178#define XFS_AGI_DADDR(mp) ((xfs_daddr_t)(2 << (mp)->m_sectbb_log))
a844f451 179#define XFS_AGI_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGI_DADDR(mp))
62926044 180#define XFS_BUF_TO_AGI(bp) ((xfs_agi_t *)((bp)->b_addr))
1da177e4 181
5e1be0fb
CH
182extern int xfs_read_agi(struct xfs_mount *mp, struct xfs_trans *tp,
183 xfs_agnumber_t agno, struct xfs_buf **bpp);
184
1813dd64
DC
185extern const struct xfs_buf_ops xfs_agi_buf_ops;
186
1da177e4
LT
187/*
188 * The third a.g. block contains the a.g. freelist, an array
189 * of block pointers to blocks owned by the allocation btree code.
190 */
191#define XFS_AGFL_DADDR(mp) ((xfs_daddr_t)(3 << (mp)->m_sectbb_log))
a844f451 192#define XFS_AGFL_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGFL_DADDR(mp))
1da177e4 193#define XFS_AGFL_SIZE(mp) ((mp)->m_sb.sb_sectsize / sizeof(xfs_agblock_t))
62926044 194#define XFS_BUF_TO_AGFL(bp) ((xfs_agfl_t *)((bp)->b_addr))
1da177e4
LT
195
196typedef struct xfs_agfl {
e2101005 197 __be32 agfl_bno[1]; /* actually XFS_AGFL_SIZE(mp) */
1da177e4
LT
198} xfs_agfl_t;
199
1da177e4
LT
200/*
201 * Per-ag incore structure, copies of information in agf and agi,
202 * to improve the performance of allocation group selection.
1da177e4 203 */
1da177e4 204#define XFS_PAGB_NUM_SLOTS 128
1da177e4 205
aed3bb90 206typedef struct xfs_perag {
0fa800fb
DC
207 struct xfs_mount *pag_mount; /* owner filesystem */
208 xfs_agnumber_t pag_agno; /* AG this structure belongs to */
aed3bb90 209 atomic_t pag_ref; /* perag reference count */
1da177e4
LT
210 char pagf_init; /* this agf's entry is initialized */
211 char pagi_init; /* this agi's entry is initialized */
c41564b5 212 char pagf_metadata; /* the agf is preferred to be metadata */
1da177e4
LT
213 char pagi_inodeok; /* The agi is ok for inodes */
214 __uint8_t pagf_levels[XFS_BTNUM_AGF];
215 /* # of levels in bno & cnt btree */
216 __uint32_t pagf_flcount; /* count of blocks in freelist */
217 xfs_extlen_t pagf_freeblks; /* total free blocks */
218 xfs_extlen_t pagf_longest; /* longest free space */
92821e2b 219 __uint32_t pagf_btreeblks; /* # of blocks held in AGF btrees */
1da177e4 220 xfs_agino_t pagi_freecount; /* number of free inodes */
92821e2b 221 xfs_agino_t pagi_count; /* number of allocated inodes */
bd169565
DC
222
223 /*
224 * Inode allocation search lookup optimisation.
225 * If the pagino matches, the search for new inodes
226 * doesn't need to search the near ones again straight away
227 */
228 xfs_agino_t pagl_pagino;
229 xfs_agino_t pagl_leftrec;
230 xfs_agino_t pagl_rightrec;
1da177e4 231#ifdef __KERNEL__
ed3b4d6c
DC
232 spinlock_t pagb_lock; /* lock for pagb_tree */
233 struct rb_root pagb_tree; /* ordered tree of busy extents */
847fff5c 234
2a82b8be 235 atomic_t pagf_fstrms; /* # of filestreams active in this AG */
da353b0d 236
1a427ab0 237 spinlock_t pag_ici_lock; /* incore inode cache lock */
da353b0d 238 struct radix_tree_root pag_ici_root; /* incore inode cache root */
9bf729c0 239 int pag_ici_reclaimable; /* reclaimable inodes */
69b491c2
DC
240 struct mutex pag_ici_reclaim_lock; /* serialisation point */
241 unsigned long pag_ici_reclaim_cursor; /* reclaim restart point */
e176579e 242
74f75a0c
DC
243 /* buffer cache index */
244 spinlock_t pag_buf_lock; /* lock for pag_buf_tree */
245 struct rb_root pag_buf_tree; /* ordered tree of active buffers */
246
e176579e
DC
247 /* for rcu-safe freeing */
248 struct rcu_head rcu_head;
847fff5c 249#endif
e57336ff 250 int pagb_count; /* pagb slots in use */
1da177e4
LT
251} xfs_perag_t;
252
396beb85
DC
253/*
254 * tags for inode radix tree
255 */
75f3cb13
DC
256#define XFS_ICI_NO_TAG (-1) /* special flag for an untagged lookup
257 in xfs_inode_ag_iterator */
396beb85 258#define XFS_ICI_RECLAIM_TAG 0 /* inode is to be reclaimed */
27b52867 259#define XFS_ICI_EOFBLOCKS_TAG 1 /* inode has blocks beyond EOF */
396beb85 260
a844f451
NS
261#define XFS_AG_MAXLEVELS(mp) ((mp)->m_ag_maxlevels)
262#define XFS_MIN_FREELIST_RAW(bl,cl,mp) \
263 (MIN(bl + 1, XFS_AG_MAXLEVELS(mp)) + MIN(cl + 1, XFS_AG_MAXLEVELS(mp)))
264#define XFS_MIN_FREELIST(a,mp) \
265 (XFS_MIN_FREELIST_RAW( \
16259e7d
CH
266 be32_to_cpu((a)->agf_levels[XFS_BTNUM_BNOi]), \
267 be32_to_cpu((a)->agf_levels[XFS_BTNUM_CNTi]), mp))
1da177e4 268#define XFS_MIN_FREELIST_PAG(pag,mp) \
a844f451 269 (XFS_MIN_FREELIST_RAW( \
a5687787
CH
270 (unsigned int)(pag)->pagf_levels[XFS_BTNUM_BNOi], \
271 (unsigned int)(pag)->pagf_levels[XFS_BTNUM_CNTi], mp))
1da177e4 272
a844f451 273#define XFS_AGB_TO_FSB(mp,agno,agbno) \
1da177e4 274 (((xfs_fsblock_t)(agno) << (mp)->m_sb.sb_agblklog) | (agbno))
a844f451 275#define XFS_FSB_TO_AGNO(mp,fsbno) \
1da177e4 276 ((xfs_agnumber_t)((fsbno) >> (mp)->m_sb.sb_agblklog))
a844f451 277#define XFS_FSB_TO_AGBNO(mp,fsbno) \
fb82557f 278 ((xfs_agblock_t)((fsbno) & xfs_mask32lo((mp)->m_sb.sb_agblklog)))
a844f451
NS
279#define XFS_AGB_TO_DADDR(mp,agno,agbno) \
280 ((xfs_daddr_t)XFS_FSB_TO_BB(mp, \
281 (xfs_fsblock_t)(agno) * (mp)->m_sb.sb_agblocks + (agbno)))
282#define XFS_AG_DADDR(mp,agno,d) (XFS_AGB_TO_DADDR(mp, agno, 0) + (d))
1da177e4
LT
283
284/*
285 * For checking for bad ranges of xfs_daddr_t's, covering multiple
286 * allocation groups or a single xfs_daddr_t that's a superblock copy.
287 */
1da177e4
LT
288#define XFS_AG_CHECK_DADDR(mp,d,len) \
289 ((len) == 1 ? \
290 ASSERT((d) == XFS_SB_DADDR || \
9d87c319
ES
291 xfs_daddr_to_agbno(mp, d) != XFS_SB_DADDR) : \
292 ASSERT(xfs_daddr_to_agno(mp, d) == \
293 xfs_daddr_to_agno(mp, (d) + (len) - 1)))
1da177e4
LT
294
295#endif /* __XFS_AG_H__ */
This page took 0.627002 seconds and 5 git commands to generate.