blob: 0fdd4109c62439b7471b46135a068148b1006d87 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2000-2003,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_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' */
Christoph Hellwig77c95bb2013-04-03 16:11:14 +110033#define XFS_AGFL_MAGIC 0x5841464c /* 'XAFL' */
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#define XFS_AGF_VERSION 1
35#define XFS_AGI_VERSION 1
Nathan Scotta844f452005-11-02 14:38:42 +110036
37#define XFS_AGF_GOOD_VERSION(v) ((v) == XFS_AGF_VERSION)
38#define XFS_AGI_GOOD_VERSION(v) ((v) == XFS_AGI_VERSION)
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40/*
41 * Btree number 0 is bno, 1 is cnt. This value gives the size of the
42 * arrays below.
43 */
44#define XFS_BTNUM_AGF ((int)XFS_BTNUM_CNTi + 1)
45
46/*
47 * The second word of agf_levels in the first a.g. overlaps the EFS
48 * superblock's magic number. Since the magic numbers valid for EFS
49 * are > 64k, our value cannot be confused for an EFS superblock's.
50 */
51
Christoph Hellwig16259e72005-11-02 15:11:25 +110052typedef struct xfs_agf {
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 /*
54 * Common allocation group header information
55 */
Christoph Hellwig16259e72005-11-02 15:11:25 +110056 __be32 agf_magicnum; /* magic number == XFS_AGF_MAGIC */
57 __be32 agf_versionnum; /* header version == XFS_AGF_VERSION */
58 __be32 agf_seqno; /* sequence # starting from 0 */
59 __be32 agf_length; /* size in blocks of a.g. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 /*
61 * Freespace information
62 */
Christoph Hellwig16259e72005-11-02 15:11:25 +110063 __be32 agf_roots[XFS_BTNUM_AGF]; /* root blocks */
64 __be32 agf_spare0; /* spare field */
65 __be32 agf_levels[XFS_BTNUM_AGF]; /* btree levels */
66 __be32 agf_spare1; /* spare field */
Dave Chinner4e0e6042013-04-03 16:11:13 +110067
Christoph Hellwig16259e72005-11-02 15:11:25 +110068 __be32 agf_flfirst; /* first freelist block's index */
69 __be32 agf_fllast; /* last freelist block's index */
70 __be32 agf_flcount; /* count of blocks in freelist */
71 __be32 agf_freeblks; /* total free blocks */
Dave Chinner4e0e6042013-04-03 16:11:13 +110072
Christoph Hellwig16259e72005-11-02 15:11:25 +110073 __be32 agf_longest; /* longest free space */
David Chinner92821e22007-05-24 15:26:31 +100074 __be32 agf_btreeblks; /* # of blocks held in AGF btrees */
Dave Chinner4e0e6042013-04-03 16:11:13 +110075 uuid_t agf_uuid; /* uuid of filesystem */
76
77 /*
78 * reserve some contiguous space for future logged fields before we add
79 * the unlogged fields. This makes the range logging via flags and
80 * structure offsets much simpler.
81 */
82 __be64 agf_spare64[16];
83
84 /* unlogged fields, written during buffer writeback. */
85 __be64 agf_lsn; /* last write sequence */
86 __be32 agf_crc; /* crc of agf sector */
87 __be32 agf_spare2;
88
89 /* structure must be padded to 64 bit alignment */
Linus Torvalds1da177e2005-04-16 15:20:36 -070090} xfs_agf_t;
91
Eric Sandeen533b81c2014-02-27 15:15:27 +110092#define XFS_AGF_CRC_OFF offsetof(struct xfs_agf, agf_crc)
93
Linus Torvalds1da177e2005-04-16 15:20:36 -070094#define XFS_AGF_MAGICNUM 0x00000001
95#define XFS_AGF_VERSIONNUM 0x00000002
96#define XFS_AGF_SEQNO 0x00000004
97#define XFS_AGF_LENGTH 0x00000008
98#define XFS_AGF_ROOTS 0x00000010
99#define XFS_AGF_LEVELS 0x00000020
100#define XFS_AGF_FLFIRST 0x00000040
101#define XFS_AGF_FLLAST 0x00000080
102#define XFS_AGF_FLCOUNT 0x00000100
103#define XFS_AGF_FREEBLKS 0x00000200
104#define XFS_AGF_LONGEST 0x00000400
David Chinner92821e22007-05-24 15:26:31 +1000105#define XFS_AGF_BTREEBLKS 0x00000800
Dave Chinner4e0e6042013-04-03 16:11:13 +1100106#define XFS_AGF_UUID 0x00001000
107#define XFS_AGF_NUM_BITS 13
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108#define XFS_AGF_ALL_BITS ((1 << XFS_AGF_NUM_BITS) - 1)
109
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000110#define XFS_AGF_FLAGS \
111 { XFS_AGF_MAGICNUM, "MAGICNUM" }, \
112 { XFS_AGF_VERSIONNUM, "VERSIONNUM" }, \
113 { XFS_AGF_SEQNO, "SEQNO" }, \
114 { XFS_AGF_LENGTH, "LENGTH" }, \
115 { XFS_AGF_ROOTS, "ROOTS" }, \
116 { XFS_AGF_LEVELS, "LEVELS" }, \
117 { XFS_AGF_FLFIRST, "FLFIRST" }, \
118 { XFS_AGF_FLLAST, "FLLAST" }, \
119 { XFS_AGF_FLCOUNT, "FLCOUNT" }, \
120 { XFS_AGF_FREEBLKS, "FREEBLKS" }, \
121 { XFS_AGF_LONGEST, "LONGEST" }, \
Dave Chinner4e0e6042013-04-03 16:11:13 +1100122 { XFS_AGF_BTREEBLKS, "BTREEBLKS" }, \
123 { XFS_AGF_UUID, "UUID" }
Christoph Hellwig0b1b2132009-12-14 23:14:59 +0000124
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125/* disk block (xfs_daddr_t) in the AG */
126#define XFS_AGF_DADDR(mp) ((xfs_daddr_t)(1 << (mp)->m_sectbb_log))
Nathan Scotta844f452005-11-02 14:38:42 +1100127#define XFS_AGF_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGF_DADDR(mp))
Chandra Seetharaman62926042011-07-22 23:40:15 +0000128#define XFS_BUF_TO_AGF(bp) ((xfs_agf_t *)((bp)->b_addr))
Nathan Scotta844f452005-11-02 14:38:42 +1100129
Eric Sandeenfef11112009-07-02 21:35:43 -0500130extern int xfs_read_agf(struct xfs_mount *mp, struct xfs_trans *tp,
131 xfs_agnumber_t agno, int flags, struct xfs_buf **bpp);
132
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133/*
134 * Size of the unlinked inode hash table in the agi.
135 */
136#define XFS_AGI_UNLINKED_BUCKETS 64
137
Christoph Hellwig16259e72005-11-02 15:11:25 +1100138typedef struct xfs_agi {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 /*
140 * Common allocation group header information
141 */
Christoph Hellwig16259e72005-11-02 15:11:25 +1100142 __be32 agi_magicnum; /* magic number == XFS_AGI_MAGIC */
143 __be32 agi_versionnum; /* header version == XFS_AGI_VERSION */
144 __be32 agi_seqno; /* sequence # starting from 0 */
145 __be32 agi_length; /* size in blocks of a.g. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 /*
147 * Inode information
148 * Inodes are mapped by interpreting the inode number, so no
149 * mapping data is needed here.
150 */
Christoph Hellwig16259e72005-11-02 15:11:25 +1100151 __be32 agi_count; /* count of allocated inodes */
152 __be32 agi_root; /* root of inode btree */
153 __be32 agi_level; /* levels in inode btree */
154 __be32 agi_freecount; /* number of free inodes */
Dave Chinner983d09f2013-04-03 16:11:15 +1100155
Christoph Hellwig16259e72005-11-02 15:11:25 +1100156 __be32 agi_newino; /* new inode just allocated */
157 __be32 agi_dirino; /* last directory inode chunk */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 /*
159 * Hash table of inodes which have been unlinked but are
160 * still being referenced.
161 */
Christoph Hellwig16259e72005-11-02 15:11:25 +1100162 __be32 agi_unlinked[XFS_AGI_UNLINKED_BUCKETS];
Dave Chinner983d09f2013-04-03 16:11:15 +1100163
164 uuid_t agi_uuid; /* uuid of filesystem */
165 __be32 agi_crc; /* crc of agi sector */
166 __be32 agi_pad32;
167 __be64 agi_lsn; /* last write sequence */
168
169 /* structure must be padded to 64 bit alignment */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170} xfs_agi_t;
171
Eric Sandeen533b81c2014-02-27 15:15:27 +1100172#define XFS_AGI_CRC_OFF offsetof(struct xfs_agi, agi_crc)
173
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174#define XFS_AGI_MAGICNUM 0x00000001
175#define XFS_AGI_VERSIONNUM 0x00000002
176#define XFS_AGI_SEQNO 0x00000004
177#define XFS_AGI_LENGTH 0x00000008
178#define XFS_AGI_COUNT 0x00000010
179#define XFS_AGI_ROOT 0x00000020
180#define XFS_AGI_LEVEL 0x00000040
181#define XFS_AGI_FREECOUNT 0x00000080
182#define XFS_AGI_NEWINO 0x00000100
183#define XFS_AGI_DIRINO 0x00000200
184#define XFS_AGI_UNLINKED 0x00000400
185#define XFS_AGI_NUM_BITS 11
186#define XFS_AGI_ALL_BITS ((1 << XFS_AGI_NUM_BITS) - 1)
187
188/* disk block (xfs_daddr_t) in the AG */
189#define XFS_AGI_DADDR(mp) ((xfs_daddr_t)(2 << (mp)->m_sectbb_log))
Nathan Scotta844f452005-11-02 14:38:42 +1100190#define XFS_AGI_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGI_DADDR(mp))
Chandra Seetharaman62926042011-07-22 23:40:15 +0000191#define XFS_BUF_TO_AGI(bp) ((xfs_agi_t *)((bp)->b_addr))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
Christoph Hellwig5e1be0f2008-11-28 14:23:37 +1100193extern int xfs_read_agi(struct xfs_mount *mp, struct xfs_trans *tp,
194 xfs_agnumber_t agno, struct xfs_buf **bpp);
195
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196/*
197 * The third a.g. block contains the a.g. freelist, an array
198 * of block pointers to blocks owned by the allocation btree code.
199 */
200#define XFS_AGFL_DADDR(mp) ((xfs_daddr_t)(3 << (mp)->m_sectbb_log))
Nathan Scotta844f452005-11-02 14:38:42 +1100201#define XFS_AGFL_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_AGFL_DADDR(mp))
Chandra Seetharaman62926042011-07-22 23:40:15 +0000202#define XFS_BUF_TO_AGFL(bp) ((xfs_agfl_t *)((bp)->b_addr))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
Christoph Hellwig77c95bb2013-04-03 16:11:14 +1100204#define XFS_BUF_TO_AGFL_BNO(mp, bp) \
205 (xfs_sb_version_hascrc(&((mp)->m_sb)) ? \
206 &(XFS_BUF_TO_AGFL(bp)->agfl_bno[0]) : \
207 (__be32 *)(bp)->b_addr)
208
209/*
210 * Size of the AGFL. For CRC-enabled filesystes we steal a couple of
211 * slots in the beginning of the block for a proper header with the
212 * location information and CRC.
213 */
214#define XFS_AGFL_SIZE(mp) \
215 (((mp)->m_sb.sb_sectsize - \
216 (xfs_sb_version_hascrc(&((mp)->m_sb)) ? \
217 sizeof(struct xfs_agfl) : 0)) / \
218 sizeof(xfs_agblock_t))
219
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220typedef struct xfs_agfl {
Christoph Hellwig77c95bb2013-04-03 16:11:14 +1100221 __be32 agfl_magicnum;
222 __be32 agfl_seqno;
223 uuid_t agfl_uuid;
224 __be64 agfl_lsn;
225 __be32 agfl_crc;
226 __be32 agfl_bno[]; /* actually XFS_AGFL_SIZE(mp) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227} xfs_agfl_t;
228
Eric Sandeen533b81c2014-02-27 15:15:27 +1100229#define XFS_AGFL_CRC_OFF offsetof(struct xfs_agfl, agfl_crc)
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231/*
David Chinner396beb82008-10-30 17:37:26 +1100232 * tags for inode radix tree
233 */
Dave Chinner75f3cb12009-06-08 15:35:14 +0200234#define XFS_ICI_NO_TAG (-1) /* special flag for an untagged lookup
235 in xfs_inode_ag_iterator */
David Chinner396beb82008-10-30 17:37:26 +1100236#define XFS_ICI_RECLAIM_TAG 0 /* inode is to be reclaimed */
Brian Foster27b52862012-11-06 09:50:38 -0500237#define XFS_ICI_EOFBLOCKS_TAG 1 /* inode has blocks beyond EOF */
David Chinner396beb82008-10-30 17:37:26 +1100238
Nathan Scotta844f452005-11-02 14:38:42 +1100239#define XFS_AG_MAXLEVELS(mp) ((mp)->m_ag_maxlevels)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240#define XFS_MIN_FREELIST_RAW(bl,cl,mp) \
Nathan Scotta844f452005-11-02 14:38:42 +1100241 (MIN(bl + 1, XFS_AG_MAXLEVELS(mp)) + MIN(cl + 1, XFS_AG_MAXLEVELS(mp)))
242#define XFS_MIN_FREELIST(a,mp) \
243 (XFS_MIN_FREELIST_RAW( \
Christoph Hellwig16259e72005-11-02 15:11:25 +1100244 be32_to_cpu((a)->agf_levels[XFS_BTNUM_BNOi]), \
245 be32_to_cpu((a)->agf_levels[XFS_BTNUM_CNTi]), mp))
Nathan Scotta844f452005-11-02 14:38:42 +1100246#define XFS_MIN_FREELIST_PAG(pag,mp) \
247 (XFS_MIN_FREELIST_RAW( \
Christoph Hellwiga5687782009-02-09 08:37:39 +0100248 (unsigned int)(pag)->pagf_levels[XFS_BTNUM_BNOi], \
249 (unsigned int)(pag)->pagf_levels[XFS_BTNUM_CNTi], mp))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
Nathan Scotta844f452005-11-02 14:38:42 +1100251#define XFS_AGB_TO_FSB(mp,agno,agbno) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 (((xfs_fsblock_t)(agno) << (mp)->m_sb.sb_agblklog) | (agbno))
Nathan Scotta844f452005-11-02 14:38:42 +1100253#define XFS_FSB_TO_AGNO(mp,fsbno) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 ((xfs_agnumber_t)((fsbno) >> (mp)->m_sb.sb_agblklog))
Nathan Scotta844f452005-11-02 14:38:42 +1100255#define XFS_FSB_TO_AGBNO(mp,fsbno) \
Eric Sandeenfb825572009-01-09 15:53:54 +1100256 ((xfs_agblock_t)((fsbno) & xfs_mask32lo((mp)->m_sb.sb_agblklog)))
Nathan Scotta844f452005-11-02 14:38:42 +1100257#define XFS_AGB_TO_DADDR(mp,agno,agbno) \
258 ((xfs_daddr_t)XFS_FSB_TO_BB(mp, \
259 (xfs_fsblock_t)(agno) * (mp)->m_sb.sb_agblocks + (agbno)))
260#define XFS_AG_DADDR(mp,agno,d) (XFS_AGB_TO_DADDR(mp, agno, 0) + (d))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
262/*
263 * For checking for bad ranges of xfs_daddr_t's, covering multiple
264 * allocation groups or a single xfs_daddr_t that's a superblock copy.
265 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266#define XFS_AG_CHECK_DADDR(mp,d,len) \
267 ((len) == 1 ? \
268 ASSERT((d) == XFS_SB_DADDR || \
Eric Sandeen9d87c312009-01-14 23:22:07 -0600269 xfs_daddr_to_agbno(mp, d) != XFS_SB_DADDR) : \
270 ASSERT(xfs_daddr_to_agno(mp, d) == \
271 xfs_daddr_to_agno(mp, (d) + (len) - 1)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
273#endif /* __XFS_AG_H__ */