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