Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
ufs_fs.h
Go to the documentation of this file.
1 /*
2  * linux/include/linux/ufs_fs.h
3  *
4  * Copyright (C) 1996
5  * Adrian Rodriguez ([email protected])
6  * Laboratory for Computer Science Research Computing Facility
7  * Rutgers, The State University of New Jersey
8  *
9  * Clean swab support by Fare <[email protected]>
10  * just hope no one is using NNUUXXI on __?64 structure elements
11  * 64-bit clean thanks to Maciej W. Rozycki <[email protected]>
12  *
13  * 4.4BSD (FreeBSD) support added on February 1st 1998 by
14  * Niels Kristian Bech Jensen <[email protected]> partially based
15  * on code by Martin von Loewis <[email protected]>.
16  *
17  * NeXTstep support added on February 5th 1998 by
18  * Niels Kristian Bech Jensen <[email protected]>.
19  *
20  * Write support by Daniel Pirkl <[email protected]>
21  *
22  * HP/UX hfs filesystem support added by
23  * Martin K. Petersen <[email protected]>, August 1999
24  *
25  * UFS2 (of FreeBSD 5.x) support added by
26  * Niraj Kumar <[email protected]> , Jan 2004
27  *
28  */
29 
30 #ifndef __LINUX_UFS_FS_H
31 #define __LINUX_UFS_FS_H
32 
33 #include <linux/types.h>
34 #include <linux/kernel.h>
35 #include <linux/stat.h>
36 #include <linux/fs.h>
37 #include <linux/workqueue.h>
38 
39 #include <asm/div64.h>
40 typedef __u64 __bitwise __fs64;
41 typedef __u32 __bitwise __fs32;
42 typedef __u16 __bitwise __fs16;
43 
44 #define UFS_BBLOCK 0
45 #define UFS_BBSIZE 8192
46 #define UFS_SBLOCK 8192
47 #define UFS_SBSIZE 8192
48 
49 #define UFS_SECTOR_SIZE 512
50 #define UFS_SECTOR_BITS 9
51 #define UFS_MAGIC 0x00011954
52 #define UFS_MAGIC_BW 0x0f242697
53 #define UFS2_MAGIC 0x19540119
54 #define UFS_CIGAM 0x54190100 /* byteswapped MAGIC */
55 
56 /* Copied from FreeBSD */
57 /*
58  * Each disk drive contains some number of filesystems.
59  * A filesystem consists of a number of cylinder groups.
60  * Each cylinder group has inodes and data.
61  *
62  * A filesystem is described by its super-block, which in turn
63  * describes the cylinder groups. The super-block is critical
64  * data and is replicated in each cylinder group to protect against
65  * catastrophic loss. This is done at `newfs' time and the critical
66  * super-block data does not change, so the copies need not be
67  * referenced further unless disaster strikes.
68  *
69  * For filesystem fs, the offsets of the various blocks of interest
70  * are given in the super block as:
71  * [fs->fs_sblkno] Super-block
72  * [fs->fs_cblkno] Cylinder group block
73  * [fs->fs_iblkno] Inode blocks
74  * [fs->fs_dblkno] Data blocks
75  * The beginning of cylinder group cg in fs, is given by
76  * the ``cgbase(fs, cg)'' macro.
77  *
78  * Depending on the architecture and the media, the superblock may
79  * reside in any one of four places. For tiny media where every block
80  * counts, it is placed at the very front of the partition. Historically,
81  * UFS1 placed it 8K from the front to leave room for the disk label and
82  * a small bootstrap. For UFS2 it got moved to 64K from the front to leave
83  * room for the disk label and a bigger bootstrap, and for really piggy
84  * systems we check at 256K from the front if the first three fail. In
85  * all cases the size of the superblock will be SBLOCKSIZE. All values are
86  * given in byte-offset form, so they do not imply a sector size. The
87  * SBLOCKSEARCH specifies the order in which the locations should be searched.
88  */
89 #define SBLOCK_FLOPPY 0
90 #define SBLOCK_UFS1 8192
91 #define SBLOCK_UFS2 65536
92 #define SBLOCK_PIGGY 262144
93 #define SBLOCKSIZE 8192
94 #define SBLOCKSEARCH \
95  { SBLOCK_UFS2, SBLOCK_UFS1, SBLOCK_FLOPPY, SBLOCK_PIGGY, -1 }
96 
97 
98 /* HP specific MAGIC values */
99 
100 #define UFS_MAGIC_LFN 0x00095014 /* fs supports filenames > 14 chars */
101 #define UFS_CIGAM_LFN 0x14500900 /* srahc 41 < semanelif stroppus sf */
102 
103 #define UFS_MAGIC_SEC 0x00612195 /* B1 security fs */
104 #define UFS_CIGAM_SEC 0x95216100
105 
106 #define UFS_MAGIC_FEA 0x00195612 /* fs_featurebits supported */
107 #define UFS_CIGAM_FEA 0x12561900
108 
109 #define UFS_MAGIC_4GB 0x05231994 /* fs > 4 GB && fs_featurebits */
110 #define UFS_CIGAM_4GB 0x94192305
111 
112 /* Seems somebody at HP goofed here. B1 and lfs are both 0x2 !?! */
113 #define UFS_FSF_LFN 0x00000001 /* long file names */
114 #define UFS_FSF_B1 0x00000002 /* B1 security */
115 #define UFS_FSF_LFS 0x00000002 /* large files */
116 #define UFS_FSF_LUID 0x00000004 /* large UIDs */
117 
118 /* End of HP stuff */
119 
120 
121 #define UFS_BSIZE 8192
122 #define UFS_MINBSIZE 4096
123 #define UFS_FSIZE 1024
124 #define UFS_MAXFRAG (UFS_BSIZE / UFS_FSIZE)
125 
126 #define UFS_NDADDR 12
127 #define UFS_NINDIR 3
128 
129 #define UFS_IND_BLOCK (UFS_NDADDR + 0)
130 #define UFS_DIND_BLOCK (UFS_NDADDR + 1)
131 #define UFS_TIND_BLOCK (UFS_NDADDR + 2)
132 
133 #define UFS_NDIR_FRAGMENT (UFS_NDADDR << uspi->s_fpbshift)
134 #define UFS_IND_FRAGMENT (UFS_IND_BLOCK << uspi->s_fpbshift)
135 #define UFS_DIND_FRAGMENT (UFS_DIND_BLOCK << uspi->s_fpbshift)
136 #define UFS_TIND_FRAGMENT (UFS_TIND_BLOCK << uspi->s_fpbshift)
137 
138 #define UFS_ROOTINO 2
139 #define UFS_FIRST_INO (UFS_ROOTINO + 1)
140 
141 #define UFS_USEEFT ((__u16)65535)
142 
143 /* fs_clean values */
144 #define UFS_FSOK 0x7c269d38
145 #define UFS_FSACTIVE ((__s8)0x00)
146 #define UFS_FSCLEAN ((__s8)0x01)
147 #define UFS_FSSTABLE ((__s8)0x02)
148 #define UFS_FSOSF1 ((__s8)0x03) /* is this correct for DEC OSF/1? */
149 #define UFS_FSBAD ((__s8)0xff)
150 
151 /* Solaris-specific fs_clean values */
152 #define UFS_FSSUSPEND ((__s8)0xfe) /* temporarily suspended */
153 #define UFS_FSLOG ((__s8)0xfd) /* logging fs */
154 #define UFS_FSFIX ((__s8)0xfc) /* being repaired while mounted */
155 
156 /* From here to next blank line, s_flags for ufs_sb_info */
157 /* directory entry encoding */
158 #define UFS_DE_MASK 0x00000010 /* mask for the following */
159 #define UFS_DE_OLD 0x00000000
160 #define UFS_DE_44BSD 0x00000010
161 /* uid encoding */
162 #define UFS_UID_MASK 0x00000060 /* mask for the following */
163 #define UFS_UID_OLD 0x00000000
164 #define UFS_UID_44BSD 0x00000020
165 #define UFS_UID_EFT 0x00000040
166 /* superblock state encoding */
167 #define UFS_ST_MASK 0x00000700 /* mask for the following */
168 #define UFS_ST_OLD 0x00000000
169 #define UFS_ST_44BSD 0x00000100
170 #define UFS_ST_SUN 0x00000200 /* Solaris */
171 #define UFS_ST_SUNOS 0x00000300
172 #define UFS_ST_SUNx86 0x00000400 /* Solaris x86 */
173 /*cylinder group encoding */
174 #define UFS_CG_MASK 0x00003000 /* mask for the following */
175 #define UFS_CG_OLD 0x00000000
176 #define UFS_CG_44BSD 0x00002000
177 #define UFS_CG_SUN 0x00001000
178 /* filesystem type encoding */
179 #define UFS_TYPE_MASK 0x00010000 /* mask for the following */
180 #define UFS_TYPE_UFS1 0x00000000
181 #define UFS_TYPE_UFS2 0x00010000
182 
183 
184 /* fs_inodefmt options */
185 #define UFS_42INODEFMT -1
186 #define UFS_44INODEFMT 2
187 
188 /*
189  * MINFREE gives the minimum acceptable percentage of file system
190  * blocks which may be free. If the freelist drops below this level
191  * only the superuser may continue to allocate blocks. This may
192  * be set to 0 if no reserve of free blocks is deemed necessary,
193  * however throughput drops by fifty percent if the file system
194  * is run at between 95% and 100% full; thus the minimum default
195  * value of fs_minfree is 5%. However, to get good clustering
196  * performance, 10% is a better choice. hence we use 10% as our
197  * default value. With 10% free space, fragmentation is not a
198  * problem, so we choose to optimize for time.
199  */
200 #define UFS_MINFREE 5
201 #define UFS_DEFAULTOPT UFS_OPTTIME
202 
203 /*
204  * Turn file system block numbers into disk block addresses.
205  * This maps file system blocks to device size blocks.
206  */
207 #define ufs_fsbtodb(uspi, b) ((b) << (uspi)->s_fsbtodb)
208 #define ufs_dbtofsb(uspi, b) ((b) >> (uspi)->s_fsbtodb)
209 
210 /*
211  * Cylinder group macros to locate things in cylinder groups.
212  * They calc file system addresses of cylinder group data structures.
213  */
214 #define ufs_cgbase(c) (uspi->s_fpg * (c))
215 #define ufs_cgstart(c) ((uspi)->fs_magic == UFS2_MAGIC ? ufs_cgbase(c) : \
216  (ufs_cgbase(c) + uspi->s_cgoffset * ((c) & ~uspi->s_cgmask)))
217 #define ufs_cgsblock(c) (ufs_cgstart(c) + uspi->s_sblkno) /* super blk */
218 #define ufs_cgcmin(c) (ufs_cgstart(c) + uspi->s_cblkno) /* cg block */
219 #define ufs_cgimin(c) (ufs_cgstart(c) + uspi->s_iblkno) /* inode blk */
220 #define ufs_cgdmin(c) (ufs_cgstart(c) + uspi->s_dblkno) /* 1st data */
221 
222 /*
223  * Macros for handling inode numbers:
224  * inode number to file system block offset.
225  * inode number to cylinder group number.
226  * inode number to file system block address.
227  */
228 #define ufs_inotocg(x) ((x) / uspi->s_ipg)
229 #define ufs_inotocgoff(x) ((x) % uspi->s_ipg)
230 #define ufs_inotofsba(x) (((u64)ufs_cgimin(ufs_inotocg(x))) + ufs_inotocgoff(x) / uspi->s_inopf)
231 #define ufs_inotofsbo(x) ((x) % uspi->s_inopf)
232 
233 /*
234  * Compute the cylinder and rotational position of a cyl block addr.
235  */
236 #define ufs_cbtocylno(bno) \
237  ((bno) * uspi->s_nspf / uspi->s_spc)
238 #define ufs_cbtorpos(bno) \
239  ((UFS_SB(sb)->s_flags & UFS_CG_SUN) ? \
240  (((((bno) * uspi->s_nspf % uspi->s_spc) % \
241  uspi->s_nsect) * \
242  uspi->s_nrpos) / uspi->s_nsect) \
243  : \
244  ((((bno) * uspi->s_nspf % uspi->s_spc / uspi->s_nsect \
245  * uspi->s_trackskew + (bno) * uspi->s_nspf % uspi->s_spc \
246  % uspi->s_nsect * uspi->s_interleave) % uspi->s_nsect \
247  * uspi->s_nrpos) / uspi->s_npsect))
248 
249 /*
250  * The following macros optimize certain frequently calculated
251  * quantities by using shifts and masks in place of divisions
252  * modulos and multiplications.
253  */
254 #define ufs_blkoff(loc) ((loc) & uspi->s_qbmask)
255 #define ufs_fragoff(loc) ((loc) & uspi->s_qfmask)
256 #define ufs_lblktosize(blk) ((blk) << uspi->s_bshift)
257 #define ufs_lblkno(loc) ((loc) >> uspi->s_bshift)
258 #define ufs_numfrags(loc) ((loc) >> uspi->s_fshift)
259 #define ufs_blkroundup(size) (((size) + uspi->s_qbmask) & uspi->s_bmask)
260 #define ufs_fragroundup(size) (((size) + uspi->s_qfmask) & uspi->s_fmask)
261 #define ufs_fragstoblks(frags) ((frags) >> uspi->s_fpbshift)
262 #define ufs_blkstofrags(blks) ((blks) << uspi->s_fpbshift)
263 #define ufs_fragnum(fsb) ((fsb) & uspi->s_fpbmask)
264 #define ufs_blknum(fsb) ((fsb) & ~uspi->s_fpbmask)
265 
266 #define UFS_MAXNAMLEN 255
267 #define UFS_MAXMNTLEN 512
268 #define UFS2_MAXMNTLEN 468
269 #define UFS2_MAXVOLLEN 32
270 #define UFS_MAXCSBUFS 31
271 #define UFS_LINK_MAX 32000
272 /*
273 #define UFS2_NOCSPTRS ((128 / sizeof(void *)) - 4)
274 */
275 #define UFS2_NOCSPTRS 28
276 
277 /*
278  * UFS_DIR_PAD defines the directory entries boundaries
279  * (must be a multiple of 4)
280  */
281 #define UFS_DIR_PAD 4
282 #define UFS_DIR_ROUND (UFS_DIR_PAD - 1)
283 #define UFS_DIR_REC_LEN(name_len) (((name_len) + 1 + 8 + UFS_DIR_ROUND) & ~UFS_DIR_ROUND)
284 
285 struct ufs_timeval {
286  __fs32 tv_sec;
287  __fs32 tv_usec;
288 };
289 
290 struct ufs_dir_entry {
291  __fs32 d_ino; /* inode number of this entry */
292  __fs16 d_reclen; /* length of this entry */
293  union {
294  __fs16 d_namlen; /* actual length of d_name */
295  struct {
296  __u8 d_type; /* file type */
297  __u8 d_namlen; /* length of string in d_name */
298  } d_44;
299  } d_u;
300  __u8 d_name[UFS_MAXNAMLEN + 1]; /* file name */
301 };
302 
303 struct ufs_csum {
304  __fs32 cs_ndir; /* number of directories */
305  __fs32 cs_nbfree; /* number of free blocks */
306  __fs32 cs_nifree; /* number of free inodes */
307  __fs32 cs_nffree; /* number of free frags */
308 };
309 struct ufs2_csum_total {
310  __fs64 cs_ndir; /* number of directories */
311  __fs64 cs_nbfree; /* number of free blocks */
312  __fs64 cs_nifree; /* number of free inodes */
313  __fs64 cs_nffree; /* number of free frags */
314  __fs64 cs_numclusters; /* number of free clusters */
315  __fs64 cs_spare[3]; /* future expansion */
316 };
317 
318 struct ufs_csum_core {
319  __u64 cs_ndir; /* number of directories */
320  __u64 cs_nbfree; /* number of free blocks */
321  __u64 cs_nifree; /* number of free inodes */
322  __u64 cs_nffree; /* number of free frags */
323  __u64 cs_numclusters; /* number of free clusters */
324 };
325 
326 /*
327  * File system flags
328  */
329 #define UFS_UNCLEAN 0x01 /* file system not clean at mount (unused) */
330 #define UFS_DOSOFTDEP 0x02 /* file system using soft dependencies */
331 #define UFS_NEEDSFSCK 0x04 /* needs sync fsck (FreeBSD compat, unused) */
332 #define UFS_INDEXDIRS 0x08 /* kernel supports indexed directories */
333 #define UFS_ACLS 0x10 /* file system has ACLs enabled */
334 #define UFS_MULTILABEL 0x20 /* file system is MAC multi-label */
335 #define UFS_FLAGS_UPDATED 0x80 /* flags have been moved to new location */
336 
337 #if 0
338 /*
339  * This is the actual superblock, as it is laid out on the disk.
340  * Do NOT use this structure, because of sizeof(ufs_super_block) > 512 and
341  * it may occupy several blocks, use
342  * struct ufs_super_block_(first,second,third) instead.
343  */
344 struct ufs_super_block {
345  union {
346  struct {
347  __fs32 fs_link; /* UNUSED */
348  } fs_42;
349  struct {
350  __fs32 fs_state; /* file system state flag */
351  } fs_sun;
352  } fs_u0;
353  __fs32 fs_rlink; /* UNUSED */
354  __fs32 fs_sblkno; /* addr of super-block in filesys */
355  __fs32 fs_cblkno; /* offset of cyl-block in filesys */
356  __fs32 fs_iblkno; /* offset of inode-blocks in filesys */
357  __fs32 fs_dblkno; /* offset of first data after cg */
358  __fs32 fs_cgoffset; /* cylinder group offset in cylinder */
359  __fs32 fs_cgmask; /* used to calc mod fs_ntrak */
360  __fs32 fs_time; /* last time written -- time_t */
361  __fs32 fs_size; /* number of blocks in fs */
362  __fs32 fs_dsize; /* number of data blocks in fs */
363  __fs32 fs_ncg; /* number of cylinder groups */
364  __fs32 fs_bsize; /* size of basic blocks in fs */
365  __fs32 fs_fsize; /* size of frag blocks in fs */
366  __fs32 fs_frag; /* number of frags in a block in fs */
367 /* these are configuration parameters */
368  __fs32 fs_minfree; /* minimum percentage of free blocks */
369  __fs32 fs_rotdelay; /* num of ms for optimal next block */
370  __fs32 fs_rps; /* disk revolutions per second */
371 /* these fields can be computed from the others */
372  __fs32 fs_bmask; /* ``blkoff'' calc of blk offsets */
373  __fs32 fs_fmask; /* ``fragoff'' calc of frag offsets */
374  __fs32 fs_bshift; /* ``lblkno'' calc of logical blkno */
375  __fs32 fs_fshift; /* ``numfrags'' calc number of frags */
376 /* these are configuration parameters */
377  __fs32 fs_maxcontig; /* max number of contiguous blks */
378  __fs32 fs_maxbpg; /* max number of blks per cyl group */
379 /* these fields can be computed from the others */
380  __fs32 fs_fragshift; /* block to frag shift */
381  __fs32 fs_fsbtodb; /* fsbtodb and dbtofsb shift constant */
382  __fs32 fs_sbsize; /* actual size of super block */
383  __fs32 fs_csmask; /* csum block offset */
384  __fs32 fs_csshift; /* csum block number */
385  __fs32 fs_nindir; /* value of NINDIR */
386  __fs32 fs_inopb; /* value of INOPB */
387  __fs32 fs_nspf; /* value of NSPF */
388 /* yet another configuration parameter */
389  __fs32 fs_optim; /* optimization preference, see below */
390 /* these fields are derived from the hardware */
391  union {
392  struct {
393  __fs32 fs_npsect; /* # sectors/track including spares */
394  } fs_sun;
395  struct {
396  __fs32 fs_state; /* file system state time stamp */
397  } fs_sunx86;
398  } fs_u1;
399  __fs32 fs_interleave; /* hardware sector interleave */
400  __fs32 fs_trackskew; /* sector 0 skew, per track */
401 /* a unique id for this filesystem (currently unused and unmaintained) */
402 /* In 4.3 Tahoe this space is used by fs_headswitch and fs_trkseek */
403 /* Neither of those fields is used in the Tahoe code right now but */
404 /* there could be problems if they are. */
405  __fs32 fs_id[2]; /* file system id */
406 /* sizes determined by number of cylinder groups and their sizes */
407  __fs32 fs_csaddr; /* blk addr of cyl grp summary area */
408  __fs32 fs_cssize; /* size of cyl grp summary area */
409  __fs32 fs_cgsize; /* cylinder group size */
410 /* these fields are derived from the hardware */
411  __fs32 fs_ntrak; /* tracks per cylinder */
412  __fs32 fs_nsect; /* sectors per track */
413  __fs32 fs_spc; /* sectors per cylinder */
414 /* this comes from the disk driver partitioning */
415  __fs32 fs_ncyl; /* cylinders in file system */
416 /* these fields can be computed from the others */
417  __fs32 fs_cpg; /* cylinders per group */
418  __fs32 fs_ipg; /* inodes per cylinder group */
419  __fs32 fs_fpg; /* blocks per group * fs_frag */
420 /* this data must be re-computed after crashes */
421  struct ufs_csum fs_cstotal; /* cylinder summary information */
422 /* these fields are cleared at mount time */
423  __s8 fs_fmod; /* super block modified flag */
424  __s8 fs_clean; /* file system is clean flag */
425  __s8 fs_ronly; /* mounted read-only flag */
426  __s8 fs_flags;
427  union {
428  struct {
429  __s8 fs_fsmnt[UFS_MAXMNTLEN];/* name mounted on */
430  __fs32 fs_cgrotor; /* last cg searched */
431  __fs32 fs_csp[UFS_MAXCSBUFS];/*list of fs_cs info buffers */
432  __fs32 fs_maxcluster;
433  __fs32 fs_cpc; /* cyl per cycle in postbl */
434  __fs16 fs_opostbl[16][8]; /* old rotation block list head */
435  } fs_u1;
436  struct {
437  __s8 fs_fsmnt[UFS2_MAXMNTLEN]; /* name mounted on */
438  __u8 fs_volname[UFS2_MAXVOLLEN]; /* volume name */
439  __fs64 fs_swuid; /* system-wide uid */
440  __fs32 fs_pad; /* due to alignment of fs_swuid */
441  __fs32 fs_cgrotor; /* last cg searched */
442  __fs32 fs_ocsp[UFS2_NOCSPTRS]; /*list of fs_cs info buffers */
443  __fs32 fs_contigdirs;/*# of contiguously allocated dirs */
444  __fs32 fs_csp; /* cg summary info buffer for fs_cs */
445  __fs32 fs_maxcluster;
446  __fs32 fs_active;/* used by snapshots to track fs */
447  __fs32 fs_old_cpc; /* cyl per cycle in postbl */
448  __fs32 fs_maxbsize;/*maximum blocking factor permitted */
449  __fs64 fs_sparecon64[17];/*old rotation block list head */
450  __fs64 fs_sblockloc; /* byte offset of standard superblock */
451  struct ufs2_csum_total fs_cstotal;/*cylinder summary information*/
452  struct ufs_timeval fs_time; /* last time written */
453  __fs64 fs_size; /* number of blocks in fs */
454  __fs64 fs_dsize; /* number of data blocks in fs */
455  __fs64 fs_csaddr; /* blk addr of cyl grp summary area */
456  __fs64 fs_pendingblocks;/* blocks in process of being freed */
457  __fs32 fs_pendinginodes;/*inodes in process of being freed */
458  } fs_u2;
459  } fs_u11;
460  union {
461  struct {
462  __fs32 fs_sparecon[53];/* reserved for future constants */
463  __fs32 fs_reclaim;
464  __fs32 fs_sparecon2[1];
465  __fs32 fs_state; /* file system state time stamp */
466  __fs32 fs_qbmask[2]; /* ~usb_bmask */
467  __fs32 fs_qfmask[2]; /* ~usb_fmask */
468  } fs_sun;
469  struct {
470  __fs32 fs_sparecon[53];/* reserved for future constants */
471  __fs32 fs_reclaim;
472  __fs32 fs_sparecon2[1];
473  __fs32 fs_npsect; /* # sectors/track including spares */
474  __fs32 fs_qbmask[2]; /* ~usb_bmask */
475  __fs32 fs_qfmask[2]; /* ~usb_fmask */
476  } fs_sunx86;
477  struct {
478  __fs32 fs_sparecon[50];/* reserved for future constants */
479  __fs32 fs_contigsumsize;/* size of cluster summary array */
480  __fs32 fs_maxsymlinklen;/* max length of an internal symlink */
481  __fs32 fs_inodefmt; /* format of on-disk inodes */
482  __fs32 fs_maxfilesize[2]; /* max representable file size */
483  __fs32 fs_qbmask[2]; /* ~usb_bmask */
484  __fs32 fs_qfmask[2]; /* ~usb_fmask */
485  __fs32 fs_state; /* file system state time stamp */
486  } fs_44;
487  } fs_u2;
488  __fs32 fs_postblformat; /* format of positional layout tables */
489  __fs32 fs_nrpos; /* number of rotational positions */
490  __fs32 fs_postbloff; /* (__s16) rotation block list head */
491  __fs32 fs_rotbloff; /* (__u8) blocks for each rotation */
492  __fs32 fs_magic; /* magic number */
493  __u8 fs_space[1]; /* list of blocks for each rotation */
494 };
495 #endif/*struct ufs_super_block*/
496 
497 /*
498  * Preference for optimization.
499  */
500 #define UFS_OPTTIME 0 /* minimize allocation time */
501 #define UFS_OPTSPACE 1 /* minimize disk fragmentation */
502 
503 /*
504  * Rotational layout table format types
505  */
506 #define UFS_42POSTBLFMT -1 /* 4.2BSD rotational table format */
507 #define UFS_DYNAMICPOSTBLFMT 1 /* dynamic rotational table format */
508 
509 /*
510  * Convert cylinder group to base address of its global summary info.
511  */
512 #define fs_cs(indx) s_csp[(indx)]
513 
514 /*
515  * Cylinder group block for a file system.
516  *
517  * Writable fields in the cylinder group are protected by the associated
518  * super block lock fs->fs_lock.
519  */
520 #define CG_MAGIC 0x090255
521 #define ufs_cg_chkmagic(sb, ucg) \
522  (fs32_to_cpu((sb), (ucg)->cg_magic) == CG_MAGIC)
523 /*
524  * Macros for access to old cylinder group array structures
525  */
526 #define ufs_ocg_blktot(sb, ucg) fs32_to_cpu((sb), ((struct ufs_old_cylinder_group *)(ucg))->cg_btot)
527 #define ufs_ocg_blks(sb, ucg, cylno) fs32_to_cpu((sb), ((struct ufs_old_cylinder_group *)(ucg))->cg_b[cylno])
528 #define ufs_ocg_inosused(sb, ucg) fs32_to_cpu((sb), ((struct ufs_old_cylinder_group *)(ucg))->cg_iused)
529 #define ufs_ocg_blksfree(sb, ucg) fs32_to_cpu((sb), ((struct ufs_old_cylinder_group *)(ucg))->cg_free)
530 #define ufs_ocg_chkmagic(sb, ucg) \
531  (fs32_to_cpu((sb), ((struct ufs_old_cylinder_group *)(ucg))->cg_magic) == CG_MAGIC)
532 
533 /*
534  * size of this structure is 172 B
535  */
536 struct ufs_cylinder_group {
537  __fs32 cg_link; /* linked list of cyl groups */
538  __fs32 cg_magic; /* magic number */
539  __fs32 cg_time; /* time last written */
540  __fs32 cg_cgx; /* we are the cgx'th cylinder group */
541  __fs16 cg_ncyl; /* number of cyl's this cg */
542  __fs16 cg_niblk; /* number of inode blocks this cg */
543  __fs32 cg_ndblk; /* number of data blocks this cg */
544  struct ufs_csum cg_cs; /* cylinder summary information */
545  __fs32 cg_rotor; /* position of last used block */
546  __fs32 cg_frotor; /* position of last used frag */
547  __fs32 cg_irotor; /* position of last used inode */
548  __fs32 cg_frsum[UFS_MAXFRAG]; /* counts of available frags */
549  __fs32 cg_btotoff; /* (__u32) block totals per cylinder */
550  __fs32 cg_boff; /* (short) free block positions */
551  __fs32 cg_iusedoff; /* (char) used inode map */
552  __fs32 cg_freeoff; /* (u_char) free block map */
553  __fs32 cg_nextfreeoff; /* (u_char) next available space */
554  union {
555  struct {
556  __fs32 cg_clustersumoff; /* (u_int32) counts of avail clusters */
557  __fs32 cg_clusteroff; /* (u_int8) free cluster map */
558  __fs32 cg_nclusterblks; /* number of clusters this cg */
559  __fs32 cg_sparecon[13]; /* reserved for future use */
560  } cg_44;
561  struct {
562  __fs32 cg_clustersumoff;/* (u_int32) counts of avail clusters */
563  __fs32 cg_clusteroff; /* (u_int8) free cluster map */
564  __fs32 cg_nclusterblks;/* number of clusters this cg */
565  __fs32 cg_niblk; /* number of inode blocks this cg */
566  __fs32 cg_initediblk; /* last initialized inode */
567  __fs32 cg_sparecon32[3];/* reserved for future use */
568  __fs64 cg_time; /* time last written */
569  __fs64 cg_sparecon[3]; /* reserved for future use */
570  } cg_u2;
571  __fs32 cg_sparecon[16]; /* reserved for future use */
572  } cg_u;
573  __u8 cg_space[1]; /* space for cylinder group maps */
574 /* actually longer */
575 };
576 
577 /* Historic Cylinder group info */
578 struct ufs_old_cylinder_group {
579  __fs32 cg_link; /* linked list of cyl groups */
580  __fs32 cg_rlink; /* for incore cyl groups */
581  __fs32 cg_time; /* time last written */
582  __fs32 cg_cgx; /* we are the cgx'th cylinder group */
583  __fs16 cg_ncyl; /* number of cyl's this cg */
584  __fs16 cg_niblk; /* number of inode blocks this cg */
585  __fs32 cg_ndblk; /* number of data blocks this cg */
586  struct ufs_csum cg_cs; /* cylinder summary information */
587  __fs32 cg_rotor; /* position of last used block */
588  __fs32 cg_frotor; /* position of last used frag */
589  __fs32 cg_irotor; /* position of last used inode */
590  __fs32 cg_frsum[8]; /* counts of available frags */
591  __fs32 cg_btot[32]; /* block totals per cylinder */
592  __fs16 cg_b[32][8]; /* positions of free blocks */
593  __u8 cg_iused[256]; /* used inode map */
594  __fs32 cg_magic; /* magic number */
595  __u8 cg_free[1]; /* free block map */
596 /* actually longer */
597 };
598 
599 /*
600  * structure of an on-disk inode
601  */
602 struct ufs_inode {
603  __fs16 ui_mode; /* 0x0 */
604  __fs16 ui_nlink; /* 0x2 */
605  union {
606  struct {
607  __fs16 ui_suid; /* 0x4 */
608  __fs16 ui_sgid; /* 0x6 */
609  } oldids;
610  __fs32 ui_inumber; /* 0x4 lsf: inode number */
611  __fs32 ui_author; /* 0x4 GNU HURD: author */
612  } ui_u1;
613  __fs64 ui_size; /* 0x8 */
614  struct ufs_timeval ui_atime; /* 0x10 access */
615  struct ufs_timeval ui_mtime; /* 0x18 modification */
616  struct ufs_timeval ui_ctime; /* 0x20 creation */
617  union {
618  struct {
619  __fs32 ui_db[UFS_NDADDR];/* 0x28 data blocks */
620  __fs32 ui_ib[UFS_NINDIR];/* 0x58 indirect blocks */
621  } ui_addr;
622  __u8 ui_symlink[4*(UFS_NDADDR+UFS_NINDIR)];/* 0x28 fast symlink */
623  } ui_u2;
624  __fs32 ui_flags; /* 0x64 immutable, append-only... */
625  __fs32 ui_blocks; /* 0x68 blocks in use */
626  __fs32 ui_gen; /* 0x6c like ext2 i_version, for NFS support */
627  union {
628  struct {
629  __fs32 ui_shadow; /* 0x70 shadow inode with security data */
630  __fs32 ui_uid; /* 0x74 long EFT version of uid */
631  __fs32 ui_gid; /* 0x78 long EFT version of gid */
632  __fs32 ui_oeftflag; /* 0x7c reserved */
633  } ui_sun;
634  struct {
635  __fs32 ui_uid; /* 0x70 File owner */
636  __fs32 ui_gid; /* 0x74 File group */
637  __fs32 ui_spare[2]; /* 0x78 reserved */
638  } ui_44;
639  struct {
640  __fs32 ui_uid; /* 0x70 */
641  __fs32 ui_gid; /* 0x74 */
642  __fs16 ui_modeh; /* 0x78 mode high bits */
643  __fs16 ui_spare; /* 0x7A unused */
644  __fs32 ui_trans; /* 0x7c filesystem translator */
645  } ui_hurd;
646  } ui_u3;
647 };
648 
649 #define UFS_NXADDR 2 /* External addresses in inode. */
650 struct ufs2_inode {
651  __fs16 ui_mode; /* 0: IFMT, permissions; see below. */
652  __fs16 ui_nlink; /* 2: File link count. */
653  __fs32 ui_uid; /* 4: File owner. */
654  __fs32 ui_gid; /* 8: File group. */
655  __fs32 ui_blksize; /* 12: Inode blocksize. */
656  __fs64 ui_size; /* 16: File byte count. */
657  __fs64 ui_blocks; /* 24: Bytes actually held. */
658  __fs64 ui_atime; /* 32: Last access time. */
659  __fs64 ui_mtime; /* 40: Last modified time. */
660  __fs64 ui_ctime; /* 48: Last inode change time. */
661  __fs64 ui_birthtime; /* 56: Inode creation time. */
662  __fs32 ui_mtimensec; /* 64: Last modified time. */
663  __fs32 ui_atimensec; /* 68: Last access time. */
664  __fs32 ui_ctimensec; /* 72: Last inode change time. */
665  __fs32 ui_birthnsec; /* 76: Inode creation time. */
666  __fs32 ui_gen; /* 80: Generation number. */
667  __fs32 ui_kernflags; /* 84: Kernel flags. */
668  __fs32 ui_flags; /* 88: Status flags (chflags). */
669  __fs32 ui_extsize; /* 92: External attributes block. */
670  __fs64 ui_extb[UFS_NXADDR];/* 96: External attributes block. */
671  union {
672  struct {
673  __fs64 ui_db[UFS_NDADDR]; /* 112: Direct disk blocks. */
674  __fs64 ui_ib[UFS_NINDIR];/* 208: Indirect disk blocks.*/
675  } ui_addr;
676  __u8 ui_symlink[2*4*(UFS_NDADDR+UFS_NINDIR)];/* 0x28 fast symlink */
677  } ui_u2;
678  __fs64 ui_spare[3]; /* 232: Reserved; currently unused */
679 };
680 
681 
682 /* FreeBSD has these in sys/stat.h */
683 /* ui_flags that can be set by a file owner */
684 #define UFS_UF_SETTABLE 0x0000ffff
685 #define UFS_UF_NODUMP 0x00000001 /* do not dump */
686 #define UFS_UF_IMMUTABLE 0x00000002 /* immutable (can't "change") */
687 #define UFS_UF_APPEND 0x00000004 /* append-only */
688 #define UFS_UF_OPAQUE 0x00000008 /* directory is opaque (unionfs) */
689 #define UFS_UF_NOUNLINK 0x00000010 /* can't be removed or renamed */
690 /* ui_flags that only root can set */
691 #define UFS_SF_SETTABLE 0xffff0000
692 #define UFS_SF_ARCHIVED 0x00010000 /* archived */
693 #define UFS_SF_IMMUTABLE 0x00020000 /* immutable (can't "change") */
694 #define UFS_SF_APPEND 0x00040000 /* append-only */
695 #define UFS_SF_NOUNLINK 0x00100000 /* can't be removed or renamed */
696 
697 /*
698  * This structure is used for reading disk structures larger
699  * than the size of fragment.
700  */
701 struct ufs_buffer_head {
702  __u64 fragment; /* first fragment */
703  __u64 count; /* number of fragments */
704  struct buffer_head * bh[UFS_MAXFRAG]; /* buffers */
705 };
706 
707 struct ufs_cg_private_info {
708  struct ufs_buffer_head c_ubh;
709  __u32 c_cgx; /* number of cylidner group */
710  __u16 c_ncyl; /* number of cyl's this cg */
711  __u16 c_niblk; /* number of inode blocks this cg */
712  __u32 c_ndblk; /* number of data blocks this cg */
713  __u32 c_rotor; /* position of last used block */
714  __u32 c_frotor; /* position of last used frag */
715  __u32 c_irotor; /* position of last used inode */
716  __u32 c_btotoff; /* (__u32) block totals per cylinder */
717  __u32 c_boff; /* (short) free block positions */
718  __u32 c_iusedoff; /* (char) used inode map */
719  __u32 c_freeoff; /* (u_char) free block map */
720  __u32 c_nextfreeoff; /* (u_char) next available space */
721  __u32 c_clustersumoff;/* (u_int32) counts of avail clusters */
722  __u32 c_clusteroff; /* (u_int8) free cluster map */
723  __u32 c_nclusterblks; /* number of clusters this cg */
724 };
725 
726 
727 struct ufs_sb_private_info {
728  struct ufs_buffer_head s_ubh; /* buffer containing super block */
729  struct ufs_csum_core cs_total;
730  __u32 s_sblkno; /* offset of super-blocks in filesys */
731  __u32 s_cblkno; /* offset of cg-block in filesys */
732  __u32 s_iblkno; /* offset of inode-blocks in filesys */
733  __u32 s_dblkno; /* offset of first data after cg */
734  __u32 s_cgoffset; /* cylinder group offset in cylinder */
735  __u32 s_cgmask; /* used to calc mod fs_ntrak */
736  __u32 s_size; /* number of blocks (fragments) in fs */
737  __u32 s_dsize; /* number of data blocks in fs */
738  __u64 s_u2_size; /* ufs2: number of blocks (fragments) in fs */
739  __u64 s_u2_dsize; /*ufs2: number of data blocks in fs */
740  __u32 s_ncg; /* number of cylinder groups */
741  __u32 s_bsize; /* size of basic blocks */
742  __u32 s_fsize; /* size of fragments */
743  __u32 s_fpb; /* fragments per block */
744  __u32 s_minfree; /* minimum percentage of free blocks */
745  __u32 s_bmask; /* `blkoff'' calc of blk offsets */
746  __u32 s_fmask; /* s_fsize mask */
747  __u32 s_bshift; /* `lblkno'' calc of logical blkno */
748  __u32 s_fshift; /* s_fsize shift */
749  __u32 s_fpbshift; /* fragments per block shift */
750  __u32 s_fsbtodb; /* fsbtodb and dbtofsb shift constant */
751  __u32 s_sbsize; /* actual size of super block */
752  __u32 s_csmask; /* csum block offset */
753  __u32 s_csshift; /* csum block number */
754  __u32 s_nindir; /* value of NINDIR */
755  __u32 s_inopb; /* value of INOPB */
756  __u32 s_nspf; /* value of NSPF */
757  __u32 s_npsect; /* # sectors/track including spares */
758  __u32 s_interleave; /* hardware sector interleave */
759  __u32 s_trackskew; /* sector 0 skew, per track */
760  __u64 s_csaddr; /* blk addr of cyl grp summary area */
761  __u32 s_cssize; /* size of cyl grp summary area */
762  __u32 s_cgsize; /* cylinder group size */
763  __u32 s_ntrak; /* tracks per cylinder */
764  __u32 s_nsect; /* sectors per track */
765  __u32 s_spc; /* sectors per cylinder */
766  __u32 s_ipg; /* inodes per cylinder group */
767  __u32 s_fpg; /* fragments per group */
768  __u32 s_cpc; /* cyl per cycle in postbl */
769  __s32 s_contigsumsize;/* size of cluster summary array, 44bsd */
770  __s64 s_qbmask; /* ~usb_bmask */
771  __s64 s_qfmask; /* ~usb_fmask */
772  __s32 s_postblformat; /* format of positional layout tables */
773  __s32 s_nrpos; /* number of rotational positions */
774  __s32 s_postbloff; /* (__s16) rotation block list head */
775  __s32 s_rotbloff; /* (__u8) blocks for each rotation */
776 
777  __u32 s_fpbmask; /* fragments per block mask */
778  __u32 s_apb; /* address per block */
779  __u32 s_2apb; /* address per block^2 */
780  __u32 s_3apb; /* address per block^3 */
781  __u32 s_apbmask; /* address per block mask */
782  __u32 s_apbshift; /* address per block shift */
783  __u32 s_2apbshift; /* address per block shift * 2 */
784  __u32 s_3apbshift; /* address per block shift * 3 */
785  __u32 s_nspfshift; /* number of sector per fragment shift */
786  __u32 s_nspb; /* number of sector per block */
787  __u32 s_inopf; /* inodes per fragment */
788  __u32 s_sbbase; /* offset of NeXTstep superblock */
789  __u32 s_bpf; /* bits per fragment */
790  __u32 s_bpfshift; /* bits per fragment shift*/
791  __u32 s_bpfmask; /* bits per fragment mask */
792 
793  __u32 s_maxsymlinklen;/* upper limit on fast symlinks' size */
794  __s32 fs_magic; /* filesystem magic */
795  unsigned int s_dirblksize;
796 };
797 
798 /*
799  * Sizes of this structures are:
800  * ufs_super_block_first 512
801  * ufs_super_block_second 512
802  * ufs_super_block_third 356
803  */
804 struct ufs_super_block_first {
805  union {
806  struct {
807  __fs32 fs_link; /* UNUSED */
808  } fs_42;
809  struct {
810  __fs32 fs_state; /* file system state flag */
811  } fs_sun;
812  } fs_u0;
813  __fs32 fs_rlink;
814  __fs32 fs_sblkno;
815  __fs32 fs_cblkno;
816  __fs32 fs_iblkno;
817  __fs32 fs_dblkno;
818  __fs32 fs_cgoffset;
819  __fs32 fs_cgmask;
820  __fs32 fs_time;
821  __fs32 fs_size;
822  __fs32 fs_dsize;
823  __fs32 fs_ncg;
824  __fs32 fs_bsize;
825  __fs32 fs_fsize;
826  __fs32 fs_frag;
827  __fs32 fs_minfree;
828  __fs32 fs_rotdelay;
829  __fs32 fs_rps;
830  __fs32 fs_bmask;
831  __fs32 fs_fmask;
832  __fs32 fs_bshift;
833  __fs32 fs_fshift;
834  __fs32 fs_maxcontig;
835  __fs32 fs_maxbpg;
836  __fs32 fs_fragshift;
837  __fs32 fs_fsbtodb;
838  __fs32 fs_sbsize;
839  __fs32 fs_csmask;
840  __fs32 fs_csshift;
841  __fs32 fs_nindir;
842  __fs32 fs_inopb;
843  __fs32 fs_nspf;
844  __fs32 fs_optim;
845  union {
846  struct {
847  __fs32 fs_npsect;
848  } fs_sun;
849  struct {
850  __fs32 fs_state;
851  } fs_sunx86;
852  } fs_u1;
853  __fs32 fs_interleave;
854  __fs32 fs_trackskew;
855  __fs32 fs_id[2];
856  __fs32 fs_csaddr;
857  __fs32 fs_cssize;
858  __fs32 fs_cgsize;
859  __fs32 fs_ntrak;
860  __fs32 fs_nsect;
861  __fs32 fs_spc;
862  __fs32 fs_ncyl;
863  __fs32 fs_cpg;
864  __fs32 fs_ipg;
865  __fs32 fs_fpg;
866  struct ufs_csum fs_cstotal;
867  __s8 fs_fmod;
868  __s8 fs_clean;
869  __s8 fs_ronly;
870  __s8 fs_flags;
871  __s8 fs_fsmnt[UFS_MAXMNTLEN - 212];
872 
873 };
874 
875 struct ufs_super_block_second {
876  union {
877  struct {
878  __s8 fs_fsmnt[212];
879  __fs32 fs_cgrotor;
880  __fs32 fs_csp[UFS_MAXCSBUFS];
881  __fs32 fs_maxcluster;
882  __fs32 fs_cpc;
883  __fs16 fs_opostbl[82];
884  } fs_u1;
885  struct {
886  __s8 fs_fsmnt[UFS2_MAXMNTLEN - UFS_MAXMNTLEN + 212];
887  __u8 fs_volname[UFS2_MAXVOLLEN];
888  __fs64 fs_swuid;
889  __fs32 fs_pad;
890  __fs32 fs_cgrotor;
891  __fs32 fs_ocsp[UFS2_NOCSPTRS];
892  __fs32 fs_contigdirs;
893  __fs32 fs_csp;
894  __fs32 fs_maxcluster;
895  __fs32 fs_active;
896  __fs32 fs_old_cpc;
897  __fs32 fs_maxbsize;
898  __fs64 fs_sparecon64[17];
899  __fs64 fs_sblockloc;
900  __fs64 cs_ndir;
901  __fs64 cs_nbfree;
902  } fs_u2;
903  } fs_un;
904 };
905 
906 struct ufs_super_block_third {
907  union {
908  struct {
909  __fs16 fs_opostbl[46];
910  } fs_u1;
911  struct {
912  __fs64 cs_nifree; /* number of free inodes */
913  __fs64 cs_nffree; /* number of free frags */
914  __fs64 cs_numclusters; /* number of free clusters */
915  __fs64 cs_spare[3]; /* future expansion */
916  struct ufs_timeval fs_time; /* last time written */
917  __fs64 fs_size; /* number of blocks in fs */
918  __fs64 fs_dsize; /* number of data blocks in fs */
919  __fs64 fs_csaddr; /* blk addr of cyl grp summary area */
920  __fs64 fs_pendingblocks;/* blocks in process of being freed */
921  __fs32 fs_pendinginodes;/*inodes in process of being freed */
922  } __attribute__ ((packed)) fs_u2;
923  } fs_un1;
924  union {
925  struct {
926  __fs32 fs_sparecon[53];/* reserved for future constants */
927  __fs32 fs_reclaim;
928  __fs32 fs_sparecon2[1];
929  __fs32 fs_state; /* file system state time stamp */
930  __fs32 fs_qbmask[2]; /* ~usb_bmask */
931  __fs32 fs_qfmask[2]; /* ~usb_fmask */
932  } fs_sun;
933  struct {
934  __fs32 fs_sparecon[53];/* reserved for future constants */
935  __fs32 fs_reclaim;
936  __fs32 fs_sparecon2[1];
937  __fs32 fs_npsect; /* # sectors/track including spares */
938  __fs32 fs_qbmask[2]; /* ~usb_bmask */
939  __fs32 fs_qfmask[2]; /* ~usb_fmask */
940  } fs_sunx86;
941  struct {
942  __fs32 fs_sparecon[50];/* reserved for future constants */
943  __fs32 fs_contigsumsize;/* size of cluster summary array */
944  __fs32 fs_maxsymlinklen;/* max length of an internal symlink */
945  __fs32 fs_inodefmt; /* format of on-disk inodes */
946  __fs32 fs_maxfilesize[2]; /* max representable file size */
947  __fs32 fs_qbmask[2]; /* ~usb_bmask */
948  __fs32 fs_qfmask[2]; /* ~usb_fmask */
949  __fs32 fs_state; /* file system state time stamp */
950  } fs_44;
951  } fs_un2;
952  __fs32 fs_postblformat;
953  __fs32 fs_nrpos;
954  __fs32 fs_postbloff;
955  __fs32 fs_rotbloff;
956  __fs32 fs_magic;
957  __u8 fs_space[1];
958 };
959 
960 #endif /* __LINUX_UFS_FS_H */
Generated on Thu Jan 10 2013 14:50:12 for Linux Kernel by   doxygen 1.8.2