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