Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
xfs_sb.h
Go to the documentation of this file.
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_SB_H__
19 #define __XFS_SB_H__
20 
21 /*
22  * Super block
23  * Fits into a sector-sized buffer at address 0 of each allocation group.
24  * Only the first of these is ever updated except during growfs.
25  */
26 
27 struct xfs_buf;
28 struct xfs_mount;
29 
30 #define XFS_SB_MAGIC 0x58465342 /* 'XFSB' */
31 #define XFS_SB_VERSION_1 1 /* 5.3, 6.0.1, 6.1 */
32 #define XFS_SB_VERSION_2 2 /* 6.2 - attributes */
33 #define XFS_SB_VERSION_3 3 /* 6.2 - new inode version */
34 #define XFS_SB_VERSION_4 4 /* 6.2+ - bitmask version */
35 #define XFS_SB_VERSION_NUMBITS 0x000f
36 #define XFS_SB_VERSION_ALLFBITS 0xfff0
37 #define XFS_SB_VERSION_SASHFBITS 0xf000
38 #define XFS_SB_VERSION_REALFBITS 0x0ff0
39 #define XFS_SB_VERSION_ATTRBIT 0x0010
40 #define XFS_SB_VERSION_NLINKBIT 0x0020
41 #define XFS_SB_VERSION_QUOTABIT 0x0040
42 #define XFS_SB_VERSION_ALIGNBIT 0x0080
43 #define XFS_SB_VERSION_DALIGNBIT 0x0100
44 #define XFS_SB_VERSION_SHAREDBIT 0x0200
45 #define XFS_SB_VERSION_LOGV2BIT 0x0400
46 #define XFS_SB_VERSION_SECTORBIT 0x0800
47 #define XFS_SB_VERSION_EXTFLGBIT 0x1000
48 #define XFS_SB_VERSION_DIRV2BIT 0x2000
49 #define XFS_SB_VERSION_BORGBIT 0x4000 /* ASCII only case-insens. */
50 #define XFS_SB_VERSION_MOREBITSBIT 0x8000
51 #define XFS_SB_VERSION_OKSASHFBITS \
52  (XFS_SB_VERSION_EXTFLGBIT | \
53  XFS_SB_VERSION_DIRV2BIT | \
54  XFS_SB_VERSION_BORGBIT)
55 #define XFS_SB_VERSION_OKREALFBITS \
56  (XFS_SB_VERSION_ATTRBIT | \
57  XFS_SB_VERSION_NLINKBIT | \
58  XFS_SB_VERSION_QUOTABIT | \
59  XFS_SB_VERSION_ALIGNBIT | \
60  XFS_SB_VERSION_DALIGNBIT | \
61  XFS_SB_VERSION_SHAREDBIT | \
62  XFS_SB_VERSION_LOGV2BIT | \
63  XFS_SB_VERSION_SECTORBIT | \
64  XFS_SB_VERSION_MOREBITSBIT)
65 #define XFS_SB_VERSION_OKREALBITS \
66  (XFS_SB_VERSION_NUMBITS | \
67  XFS_SB_VERSION_OKREALFBITS | \
68  XFS_SB_VERSION_OKSASHFBITS)
69 
70 /*
71  * There are two words to hold XFS "feature" bits: the original
72  * word, sb_versionnum, and sb_features2. Whenever a bit is set in
73  * sb_features2, the feature bit XFS_SB_VERSION_MOREBITSBIT must be set.
74  *
75  * These defines represent bits in sb_features2.
76  */
77 #define XFS_SB_VERSION2_REALFBITS 0x00ffffff /* Mask: features */
78 #define XFS_SB_VERSION2_RESERVED1BIT 0x00000001
79 #define XFS_SB_VERSION2_LAZYSBCOUNTBIT 0x00000002 /* Superblk counters */
80 #define XFS_SB_VERSION2_RESERVED4BIT 0x00000004
81 #define XFS_SB_VERSION2_ATTR2BIT 0x00000008 /* Inline attr rework */
82 #define XFS_SB_VERSION2_PARENTBIT 0x00000010 /* parent pointers */
83 #define XFS_SB_VERSION2_PROJID32BIT 0x00000080 /* 32 bit project id */
84 
85 #define XFS_SB_VERSION2_OKREALFBITS \
86  (XFS_SB_VERSION2_LAZYSBCOUNTBIT | \
87  XFS_SB_VERSION2_ATTR2BIT | \
88  XFS_SB_VERSION2_PROJID32BIT)
89 #define XFS_SB_VERSION2_OKSASHFBITS \
90  (0)
91 #define XFS_SB_VERSION2_OKREALBITS \
92  (XFS_SB_VERSION2_OKREALFBITS | \
93  XFS_SB_VERSION2_OKSASHFBITS )
94 
95 /*
96  * Superblock - in core version. Must match the ondisk version below.
97  * Must be padded to 64 bit alignment.
98  */
99 typedef struct xfs_sb {
100  __uint32_t sb_magicnum; /* magic number == XFS_SB_MAGIC */
101  __uint32_t sb_blocksize; /* logical block size, bytes */
102  xfs_drfsbno_t sb_dblocks; /* number of data blocks */
103  xfs_drfsbno_t sb_rblocks; /* number of realtime blocks */
104  xfs_drtbno_t sb_rextents; /* number of realtime extents */
105  uuid_t sb_uuid; /* file system unique id */
106  xfs_dfsbno_t sb_logstart; /* starting block of log if internal */
107  xfs_ino_t sb_rootino; /* root inode number */
108  xfs_ino_t sb_rbmino; /* bitmap inode for realtime extents */
109  xfs_ino_t sb_rsumino; /* summary inode for rt bitmap */
110  xfs_agblock_t sb_rextsize; /* realtime extent size, blocks */
111  xfs_agblock_t sb_agblocks; /* size of an allocation group */
112  xfs_agnumber_t sb_agcount; /* number of allocation groups */
113  xfs_extlen_t sb_rbmblocks; /* number of rt bitmap blocks */
114  xfs_extlen_t sb_logblocks; /* number of log blocks */
115  __uint16_t sb_versionnum; /* header version == XFS_SB_VERSION */
116  __uint16_t sb_sectsize; /* volume sector size, bytes */
117  __uint16_t sb_inodesize; /* inode size, bytes */
118  __uint16_t sb_inopblock; /* inodes per block */
119  char sb_fname[12]; /* file system name */
120  __uint8_t sb_blocklog; /* log2 of sb_blocksize */
121  __uint8_t sb_sectlog; /* log2 of sb_sectsize */
122  __uint8_t sb_inodelog; /* log2 of sb_inodesize */
123  __uint8_t sb_inopblog; /* log2 of sb_inopblock */
124  __uint8_t sb_agblklog; /* log2 of sb_agblocks (rounded up) */
125  __uint8_t sb_rextslog; /* log2 of sb_rextents */
126  __uint8_t sb_inprogress; /* mkfs is in progress, don't mount */
127  __uint8_t sb_imax_pct; /* max % of fs for inode space */
128  /* statistics */
129  /*
130  * These fields must remain contiguous. If you really
131  * want to change their layout, make sure you fix the
132  * code in xfs_trans_apply_sb_deltas().
133  */
134  __uint64_t sb_icount; /* allocated inodes */
135  __uint64_t sb_ifree; /* free inodes */
136  __uint64_t sb_fdblocks; /* free data blocks */
137  __uint64_t sb_frextents; /* free realtime extents */
138  /*
139  * End contiguous fields.
140  */
141  xfs_ino_t sb_uquotino; /* user quota inode */
142  xfs_ino_t sb_gquotino; /* group quota inode */
143  __uint16_t sb_qflags; /* quota flags */
144  __uint8_t sb_flags; /* misc. flags */
145  __uint8_t sb_shared_vn; /* shared version number */
146  xfs_extlen_t sb_inoalignmt; /* inode chunk alignment, fsblocks */
147  __uint32_t sb_unit; /* stripe or raid unit */
148  __uint32_t sb_width; /* stripe or raid width */
149  __uint8_t sb_dirblklog; /* log2 of dir block size (fsbs) */
150  __uint8_t sb_logsectlog; /* log2 of the log sector size */
151  __uint16_t sb_logsectsize; /* sector size for the log, bytes */
152  __uint32_t sb_logsunit; /* stripe unit size for the log */
153  __uint32_t sb_features2; /* additional feature bits */
154 
155  /*
156  * bad features2 field as a result of failing to pad the sb
157  * structure to 64 bits. Some machines will be using this field
158  * for features2 bits. Easiest just to mark it bad and not use
159  * it for anything else.
160  */
161  __uint32_t sb_bad_features2;
162 
163  /* must be padded to 64 bit alignment */
164 } xfs_sb_t;
165 
166 /*
167  * Superblock - on disk version. Must match the in core version above.
168  * Must be padded to 64 bit alignment.
169  */
170 typedef struct xfs_dsb {
171  __be32 sb_magicnum; /* magic number == XFS_SB_MAGIC */
172  __be32 sb_blocksize; /* logical block size, bytes */
173  __be64 sb_dblocks; /* number of data blocks */
174  __be64 sb_rblocks; /* number of realtime blocks */
175  __be64 sb_rextents; /* number of realtime extents */
176  uuid_t sb_uuid; /* file system unique id */
177  __be64 sb_logstart; /* starting block of log if internal */
178  __be64 sb_rootino; /* root inode number */
179  __be64 sb_rbmino; /* bitmap inode for realtime extents */
180  __be64 sb_rsumino; /* summary inode for rt bitmap */
181  __be32 sb_rextsize; /* realtime extent size, blocks */
182  __be32 sb_agblocks; /* size of an allocation group */
183  __be32 sb_agcount; /* number of allocation groups */
184  __be32 sb_rbmblocks; /* number of rt bitmap blocks */
185  __be32 sb_logblocks; /* number of log blocks */
186  __be16 sb_versionnum; /* header version == XFS_SB_VERSION */
187  __be16 sb_sectsize; /* volume sector size, bytes */
188  __be16 sb_inodesize; /* inode size, bytes */
189  __be16 sb_inopblock; /* inodes per block */
190  char sb_fname[12]; /* file system name */
191  __u8 sb_blocklog; /* log2 of sb_blocksize */
192  __u8 sb_sectlog; /* log2 of sb_sectsize */
193  __u8 sb_inodelog; /* log2 of sb_inodesize */
194  __u8 sb_inopblog; /* log2 of sb_inopblock */
195  __u8 sb_agblklog; /* log2 of sb_agblocks (rounded up) */
196  __u8 sb_rextslog; /* log2 of sb_rextents */
197  __u8 sb_inprogress; /* mkfs is in progress, don't mount */
198  __u8 sb_imax_pct; /* max % of fs for inode space */
199  /* statistics */
200  /*
201  * These fields must remain contiguous. If you really
202  * want to change their layout, make sure you fix the
203  * code in xfs_trans_apply_sb_deltas().
204  */
205  __be64 sb_icount; /* allocated inodes */
206  __be64 sb_ifree; /* free inodes */
207  __be64 sb_fdblocks; /* free data blocks */
208  __be64 sb_frextents; /* free realtime extents */
209  /*
210  * End contiguous fields.
211  */
212  __be64 sb_uquotino; /* user quota inode */
213  __be64 sb_gquotino; /* group quota inode */
214  __be16 sb_qflags; /* quota flags */
215  __u8 sb_flags; /* misc. flags */
216  __u8 sb_shared_vn; /* shared version number */
217  __be32 sb_inoalignmt; /* inode chunk alignment, fsblocks */
218  __be32 sb_unit; /* stripe or raid unit */
219  __be32 sb_width; /* stripe or raid width */
220  __u8 sb_dirblklog; /* log2 of dir block size (fsbs) */
221  __u8 sb_logsectlog; /* log2 of the log sector size */
222  __be16 sb_logsectsize; /* sector size for the log, bytes */
223  __be32 sb_logsunit; /* stripe unit size for the log */
224  __be32 sb_features2; /* additional feature bits */
225  /*
226  * bad features2 field as a result of failing to pad the sb
227  * structure to 64 bits. Some machines will be using this field
228  * for features2 bits. Easiest just to mark it bad and not use
229  * it for anything else.
230  */
232 
233  /* must be padded to 64 bit alignment */
234 } xfs_dsb_t;
235 
236 /*
237  * Sequence number values for the fields.
238  */
239 typedef enum {
255 
256 /*
257  * Mask values, defined based on the xfs_sb_field_t values.
258  * Only define the ones we're using.
259  */
260 #define XFS_SB_MVAL(x) (1LL << XFS_SBS_ ## x)
261 #define XFS_SB_UUID XFS_SB_MVAL(UUID)
262 #define XFS_SB_FNAME XFS_SB_MVAL(FNAME)
263 #define XFS_SB_ROOTINO XFS_SB_MVAL(ROOTINO)
264 #define XFS_SB_RBMINO XFS_SB_MVAL(RBMINO)
265 #define XFS_SB_RSUMINO XFS_SB_MVAL(RSUMINO)
266 #define XFS_SB_VERSIONNUM XFS_SB_MVAL(VERSIONNUM)
267 #define XFS_SB_UQUOTINO XFS_SB_MVAL(UQUOTINO)
268 #define XFS_SB_GQUOTINO XFS_SB_MVAL(GQUOTINO)
269 #define XFS_SB_QFLAGS XFS_SB_MVAL(QFLAGS)
270 #define XFS_SB_SHARED_VN XFS_SB_MVAL(SHARED_VN)
271 #define XFS_SB_UNIT XFS_SB_MVAL(UNIT)
272 #define XFS_SB_WIDTH XFS_SB_MVAL(WIDTH)
273 #define XFS_SB_ICOUNT XFS_SB_MVAL(ICOUNT)
274 #define XFS_SB_IFREE XFS_SB_MVAL(IFREE)
275 #define XFS_SB_FDBLOCKS XFS_SB_MVAL(FDBLOCKS)
276 #define XFS_SB_FEATURES2 XFS_SB_MVAL(FEATURES2)
277 #define XFS_SB_BAD_FEATURES2 XFS_SB_MVAL(BAD_FEATURES2)
278 #define XFS_SB_NUM_BITS ((int)XFS_SBS_FIELDCOUNT)
279 #define XFS_SB_ALL_BITS ((1LL << XFS_SB_NUM_BITS) - 1)
280 #define XFS_SB_MOD_BITS \
281  (XFS_SB_UUID | XFS_SB_ROOTINO | XFS_SB_RBMINO | XFS_SB_RSUMINO | \
282  XFS_SB_VERSIONNUM | XFS_SB_UQUOTINO | XFS_SB_GQUOTINO | \
283  XFS_SB_QFLAGS | XFS_SB_SHARED_VN | XFS_SB_UNIT | XFS_SB_WIDTH | \
284  XFS_SB_ICOUNT | XFS_SB_IFREE | XFS_SB_FDBLOCKS | XFS_SB_FEATURES2 | \
285  XFS_SB_BAD_FEATURES2)
286 
287 
288 /*
289  * Misc. Flags - warning - these will be cleared by xfs_repair unless
290  * a feature bit is set when the flag is used.
291  */
292 #define XFS_SBF_NOFLAGS 0x00 /* no flags set */
293 #define XFS_SBF_READONLY 0x01 /* only read-only mounts allowed */
294 
295 /*
296  * define max. shared version we can interoperate with
297  */
298 #define XFS_SB_MAX_SHARED_VN 0
299 
300 #define XFS_SB_VERSION_NUM(sbp) ((sbp)->sb_versionnum & XFS_SB_VERSION_NUMBITS)
301 
302 static inline int xfs_sb_good_version(xfs_sb_t *sbp)
303 {
304  /* We always support version 1-3 */
305  if (sbp->sb_versionnum >= XFS_SB_VERSION_1 &&
307  return 1;
308 
309  /* We support version 4 if all feature bits are supported */
310  if (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_4) {
314  return 0;
315 
316 #ifdef __KERNEL__
318  return 0;
319 #else
322  return 0;
323 #endif
324 
325  return 1;
326  }
327 
328  return 0;
329 }
330 
331 /*
332  * Detect a mismatched features2 field. Older kernels read/wrote
333  * this into the wrong slot, so to be safe we keep them in sync.
334  */
335 static inline int xfs_sb_has_mismatched_features2(xfs_sb_t *sbp)
336 {
337  return (sbp->sb_bad_features2 != sbp->sb_features2);
338 }
339 
340 static inline unsigned xfs_sb_version_tonew(unsigned v)
341 {
342  if (v == XFS_SB_VERSION_1)
343  return XFS_SB_VERSION_4;
344 
345  if (v == XFS_SB_VERSION_2)
347 
350 }
351 
352 static inline unsigned xfs_sb_version_toold(unsigned v)
353 {
355  return 0;
356  if (v & XFS_SB_VERSION_NLINKBIT)
357  return XFS_SB_VERSION_3;
358  if (v & XFS_SB_VERSION_ATTRBIT)
359  return XFS_SB_VERSION_2;
360  return XFS_SB_VERSION_1;
361 }
362 
363 static inline int xfs_sb_version_hasattr(xfs_sb_t *sbp)
364 {
365  return sbp->sb_versionnum == XFS_SB_VERSION_2 ||
369 }
370 
371 static inline void xfs_sb_version_addattr(xfs_sb_t *sbp)
372 {
373  if (sbp->sb_versionnum == XFS_SB_VERSION_1)
375  else if (XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_4)
377  else
379 }
380 
381 static inline int xfs_sb_version_hasnlink(xfs_sb_t *sbp)
382 {
383  return sbp->sb_versionnum == XFS_SB_VERSION_3 ||
386 }
387 
388 static inline void xfs_sb_version_addnlink(xfs_sb_t *sbp)
389 {
390  if (sbp->sb_versionnum <= XFS_SB_VERSION_2)
392  else
394 }
395 
396 static inline int xfs_sb_version_hasquota(xfs_sb_t *sbp)
397 {
398  return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_4 &&
400 }
401 
402 static inline void xfs_sb_version_addquota(xfs_sb_t *sbp)
403 {
406  else
407  sbp->sb_versionnum = xfs_sb_version_tonew(sbp->sb_versionnum) |
409 }
410 
411 static inline int xfs_sb_version_hasalign(xfs_sb_t *sbp)
412 {
413  return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_4 &&
415 }
416 
417 static inline int xfs_sb_version_hasdalign(xfs_sb_t *sbp)
418 {
419  return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_4 &&
421 }
422 
423 static inline int xfs_sb_version_hasshared(xfs_sb_t *sbp)
424 {
425  return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_4 &&
427 }
428 
429 static inline int xfs_sb_version_hasdirv2(xfs_sb_t *sbp)
430 {
431  return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_4 &&
433 }
434 
435 static inline int xfs_sb_version_haslogv2(xfs_sb_t *sbp)
436 {
437  return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_4 &&
439 }
440 
441 static inline int xfs_sb_version_hasextflgbit(xfs_sb_t *sbp)
442 {
443  return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_4 &&
445 }
446 
447 static inline int xfs_sb_version_hassector(xfs_sb_t *sbp)
448 {
449  return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_4 &&
451 }
452 
453 static inline int xfs_sb_version_hasasciici(xfs_sb_t *sbp)
454 {
455  return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_4 &&
457 }
458 
459 static inline int xfs_sb_version_hasmorebits(xfs_sb_t *sbp)
460 {
461  return XFS_SB_VERSION_NUM(sbp) == XFS_SB_VERSION_4 &&
463 }
464 
465 /*
466  * sb_features2 bit version macros.
467  *
468  * For example, for a bit defined as XFS_SB_VERSION2_FUNBIT, has a macro:
469  *
470  * SB_VERSION_HASFUNBIT(xfs_sb_t *sbp)
471  * ((xfs_sb_version_hasmorebits(sbp) &&
472  * ((sbp)->sb_features2 & XFS_SB_VERSION2_FUNBIT)
473  */
474 
475 static inline int xfs_sb_version_haslazysbcount(xfs_sb_t *sbp)
476 {
477  return xfs_sb_version_hasmorebits(sbp) &&
479 }
480 
481 static inline int xfs_sb_version_hasattr2(xfs_sb_t *sbp)
482 {
483  return xfs_sb_version_hasmorebits(sbp) &&
485 }
486 
487 static inline void xfs_sb_version_addattr2(xfs_sb_t *sbp)
488 {
491 }
492 
493 static inline void xfs_sb_version_removeattr2(xfs_sb_t *sbp)
494 {
496  if (!sbp->sb_features2)
498 }
499 
500 static inline int xfs_sb_version_hasprojid32bit(xfs_sb_t *sbp)
501 {
502  return xfs_sb_version_hasmorebits(sbp) &&
504 }
505 
506 /*
507  * end of superblock version macros
508  */
509 
510 #define XFS_SB_DADDR ((xfs_daddr_t)0) /* daddr in filesystem/ag */
511 #define XFS_SB_BLOCK(mp) XFS_HDR_BLOCK(mp, XFS_SB_DADDR)
512 #define XFS_BUF_TO_SBP(bp) ((xfs_dsb_t *)((bp)->b_addr))
513 
514 #define XFS_HDR_BLOCK(mp,d) ((xfs_agblock_t)XFS_BB_TO_FSBT(mp,d))
515 #define XFS_DADDR_TO_FSB(mp,d) XFS_AGB_TO_FSB(mp, \
516  xfs_daddr_to_agno(mp,d), xfs_daddr_to_agbno(mp,d))
517 #define XFS_FSB_TO_DADDR(mp,fsbno) XFS_AGB_TO_DADDR(mp, \
518  XFS_FSB_TO_AGNO(mp,fsbno), XFS_FSB_TO_AGBNO(mp,fsbno))
519 
520 /*
521  * File system sector to basic block conversions.
522  */
523 #define XFS_FSS_TO_BB(mp,sec) ((sec) << (mp)->m_sectbb_log)
524 
525 /*
526  * File system block to basic block conversions.
527  */
528 #define XFS_FSB_TO_BB(mp,fsbno) ((fsbno) << (mp)->m_blkbb_log)
529 #define XFS_BB_TO_FSB(mp,bb) \
530  (((bb) + (XFS_FSB_TO_BB(mp,1) - 1)) >> (mp)->m_blkbb_log)
531 #define XFS_BB_TO_FSBT(mp,bb) ((bb) >> (mp)->m_blkbb_log)
532 
533 /*
534  * File system block to byte conversions.
535  */
536 #define XFS_FSB_TO_B(mp,fsbno) ((xfs_fsize_t)(fsbno) << (mp)->m_sb.sb_blocklog)
537 #define XFS_B_TO_FSB(mp,b) \
538  ((((__uint64_t)(b)) + (mp)->m_blockmask) >> (mp)->m_sb.sb_blocklog)
539 #define XFS_B_TO_FSBT(mp,b) (((__uint64_t)(b)) >> (mp)->m_sb.sb_blocklog)
540 #define XFS_B_FSB_OFFSET(mp,b) ((b) & (mp)->m_blockmask)
541 
542 #endif /* __XFS_SB_H__ */