fs.h revision 1.42 1 /* $NetBSD: fs.h,v 1.42 2004/03/20 17:26:16 dsl Exp $ */
2
3 /*
4 * Copyright (c) 1982, 1986, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 *
31 * @(#)fs.h 8.13 (Berkeley) 3/21/95
32 */
33
34 #ifndef _UFS_FFS_FS_H_
35 #define _UFS_FFS_FS_H_
36
37 /*
38 * Each disk drive contains some number of file systems.
39 * A file system consists of a number of cylinder groups.
40 * Each cylinder group has inodes and data.
41 *
42 * A file system is described by its super-block, which in turn
43 * describes the cylinder groups. The super-block is critical
44 * data and is replicated in each cylinder group to protect against
45 * catastrophic loss. This is done at `newfs' time and the critical
46 * super-block data does not change, so the copies need not be
47 * referenced further unless disaster strikes.
48 *
49 * For file system fs, the offsets of the various blocks of interest
50 * are given in the super block as:
51 * [fs->fs_sblkno] Super-block
52 * [fs->fs_cblkno] Cylinder group block
53 * [fs->fs_iblkno] Inode blocks
54 * [fs->fs_dblkno] Data blocks
55 * The beginning of cylinder group cg in fs, is given by
56 * the ``cgbase(fs, cg)'' macro.
57 *
58 * Depending on the architecture and the media, the superblock may
59 * reside in any one of four places. For tiny media where every block
60 * counts, it is placed at the very front of the partition. Historically,
61 * UFS1 placed it 8K from the front to leave room for the disk label and
62 * a small bootstrap. For UFS2 it got moved to 64K from the front to leave
63 * room for the disk label and a bigger bootstrap, and for really piggy
64 * systems we check at 256K from the front if the first three fail. In
65 * all cases the size of the superblock will be SBLOCKSIZE. All values are
66 * given in byte-offset form, so they do not imply a sector size. The
67 * SBLOCKSEARCH specifies the order in which the locations should be searched.
68 *
69 * Unfortunately the UFS2/FFSv2 change was done without adequate consideration
70 * of backward compatibility. In particular 'newfs' for a FFSv2 partition
71 * must overwrite any old FFSv1 superblock at 8k, and preferrably as many
72 * of the alternates as it can find - otherwise attempting to mount on a
73 * system that only supports FFSv1 is likely to succeed!.
74 * For a small FFSv1 filesystem, an old FFSv2 superblock can be left on
75 * the disk, and a system that tries to find an FFSv2 filesystem in preference
76 * to and FFSv1 one (as NetBSD does) can mount the old FFSv2 filesystem.
77 * As a added bonus, the 'first alternate' superblock of a FFSv1 filesystem
78 * with 64k blocks is at 64k - just where the code looks first when playing
79 * 'hunt the superblock'.
80 */
81 #define BBSIZE 8192
82 #define BBOFF ((off_t)(0))
83 #define BBLOCK ((daddr_t)(0))
84
85 #define SBLOCK_FLOPPY 0
86 #define SBLOCK_UFS1 8192
87 #define SBLOCK_UFS2 65536
88 #define SBLOCK_PIGGY 262144
89 #define SBLOCKSIZE 8192
90 /*
91 * NB: Do not, under any circumstances, look for an ffsv1 filesystem at
92 * SBLOCK_UFS2. Doing so will find the wrong superblock for filesystems
93 * with a 64k block size.
94 */
95 #define SBLOCKSEARCH \
96 { SBLOCK_UFS2, SBLOCK_UFS1, SBLOCK_FLOPPY, SBLOCK_PIGGY, -1 }
97
98 /*
99 * Max number of fragments per block. This value is NOT tweakable.
100 */
101 #define MAXFRAG 8
102
103
104
105 /*
106 * Addresses stored in inodes are capable of addressing fragments
107 * of `blocks'. File system blocks of at most size MAXBSIZE can
108 * be optionally broken into 2, 4, or 8 pieces, each of which is
109 * addressable; these pieces may be DEV_BSIZE, or some multiple of
110 * a DEV_BSIZE unit.
111 *
112 * Large files consist of exclusively large data blocks. To avoid
113 * undue wasted disk space, the last data block of a small file may be
114 * allocated as only as many fragments of a large block as are
115 * necessary. The file system format retains only a single pointer
116 * to such a fragment, which is a piece of a single large block that
117 * has been divided. The size of such a fragment is determinable from
118 * information in the inode, using the ``blksize(fs, ip, lbn)'' macro.
119 *
120 * The file system records space availability at the fragment level;
121 * to determine block availability, aligned fragments are examined.
122 */
123
124 /*
125 * MINBSIZE is the smallest allowable block size.
126 * In order to insure that it is possible to create files of size
127 * 2^32 with only two levels of indirection, MINBSIZE is set to 4096.
128 * MINBSIZE must be big enough to hold a cylinder group block,
129 * thus changes to (struct cg) must keep its size within MINBSIZE.
130 * Note that super blocks are always of size SBSIZE,
131 * and that both SBSIZE and MAXBSIZE must be >= MINBSIZE.
132 */
133 #define MINBSIZE 4096
134
135 /*
136 * The path name on which the file system is mounted is maintained
137 * in fs_fsmnt. MAXMNTLEN defines the amount of space allocated in
138 * the super block for this name.
139 */
140 #define MAXMNTLEN 468
141
142 /*
143 * The volume name for this filesystem is maintained in fs_volname.
144 * MAXVOLLEN defines the length of the buffer allocated.
145 * This space used to be part of of fs_fsmnt.
146 */
147 #define MAXVOLLEN 32
148
149 /*
150 * There is a 128-byte region in the superblock reserved for in-core
151 * pointers to summary information. Originally this included an array
152 * of pointers to blocks of struct csum; now there are just four
153 * pointers and the remaining space is padded with fs_ocsp[].
154 * NOCSPTRS determines the size of this padding. One pointer (fs_csp)
155 * is taken away to point to a contiguous array of struct csum for
156 * all cylinder groups; a second (fs_maxcluster) points to an array
157 * of cluster sizes that is computed as cylinder groups are inspected;
158 * the third (fs_contigdirs) points to an array that tracks the
159 * creation of new directories; and the fourth (fs_active) is used
160 * by snapshots.
161 */
162 #define NOCSPTRS ((128 / sizeof(void *)) - 4)
163
164 /*
165 * A summary of contiguous blocks of various sizes is maintained
166 * in each cylinder group. Normally this is set by the initial
167 * value of fs_maxcontig. To conserve space, a maximum summary size
168 * is set by FS_MAXCONTIG.
169 */
170 #define FS_MAXCONTIG 16
171
172 /*
173 * Unused value currently, FreeBSD compat.
174 */
175 #define FSMAXSNAP 20
176
177 /*
178 * MINFREE gives the minimum acceptable percentage of file system
179 * blocks which may be free. If the freelist drops below this level
180 * only the superuser may continue to allocate blocks. This may
181 * be set to 0 if no reserve of free blocks is deemed necessary,
182 * however throughput drops by fifty percent if the file system
183 * is run at between 95% and 100% full; thus the minimum default
184 * value of fs_minfree is 5%. However, to get good clustering
185 * performance, 10% is a better choice. hence we use 10% as our
186 * default value. With 10% free space, fragmentation is not a
187 * problem, so we choose to optimize for time.
188 */
189 #define MINFREE 5
190 #define DEFAULTOPT FS_OPTTIME
191
192 /*
193 * Grigoriy Orlov <gluk (at) ptci.ru> has done some extensive work to fine
194 * tune the layout preferences for directories within a filesystem.
195 * His algorithm can be tuned by adjusting the following parameters
196 * which tell the system the average file size and the average number
197 * of files per directory. These defaults are well selected for typical
198 * filesystems, but may need to be tuned for odd cases like filesystems
199 * being used for squid caches or news spools.
200 */
201 #define AVFILESIZ 16384 /* expected average file size */
202 #define AFPDIR 64 /* expected number of files per directory */
203
204 /*
205 * Per cylinder group information; summarized in blocks allocated
206 * from first cylinder group data blocks. These blocks have to be
207 * read in from fs_csaddr (size fs_cssize) in addition to the
208 * super block.
209 */
210 struct csum {
211 int32_t cs_ndir; /* number of directories */
212 int32_t cs_nbfree; /* number of free blocks */
213 int32_t cs_nifree; /* number of free inodes */
214 int32_t cs_nffree; /* number of free frags */
215 };
216
217 struct csum_total {
218 int64_t cs_ndir; /* number of directories */
219 int64_t cs_nbfree; /* number of free blocks */
220 int64_t cs_nifree; /* number of free inodes */
221 int64_t cs_nffree; /* number of free frags */
222 int64_t cs_spare[4]; /* future expansion */
223 };
224
225
226 /*
227 * Super block for an FFS file system in memory.
228 */
229 struct fs {
230 int32_t fs_firstfield; /* historic file system linked list, */
231 int32_t fs_unused_1; /* used for incore super blocks */
232 int32_t fs_sblkno; /* addr of super-block in filesys */
233 int32_t fs_cblkno; /* offset of cyl-block in filesys */
234 int32_t fs_iblkno; /* offset of inode-blocks in filesys */
235 int32_t fs_dblkno; /* offset of first data after cg */
236 int32_t fs_old_cgoffset; /* cylinder group offset in cylinder */
237 int32_t fs_old_cgmask; /* used to calc mod fs_ntrak */
238 int32_t fs_old_time; /* last time written */
239 int32_t fs_old_size; /* number of blocks in fs */
240 int32_t fs_old_dsize; /* number of data blocks in fs */
241 int32_t fs_ncg; /* number of cylinder groups */
242 int32_t fs_bsize; /* size of basic blocks in fs */
243 int32_t fs_fsize; /* size of frag blocks in fs */
244 int32_t fs_frag; /* number of frags in a block in fs */
245 /* these are configuration parameters */
246 int32_t fs_minfree; /* minimum percentage of free blocks */
247 int32_t fs_old_rotdelay; /* num of ms for optimal next block */
248 int32_t fs_old_rps; /* disk revolutions per second */
249 /* these fields can be computed from the others */
250 int32_t fs_bmask; /* ``blkoff'' calc of blk offsets */
251 int32_t fs_fmask; /* ``fragoff'' calc of frag offsets */
252 int32_t fs_bshift; /* ``lblkno'' calc of logical blkno */
253 int32_t fs_fshift; /* ``numfrags'' calc number of frags */
254 /* these are configuration parameters */
255 int32_t fs_maxcontig; /* max number of contiguous blks */
256 int32_t fs_maxbpg; /* max number of blks per cyl group */
257 /* these fields can be computed from the others */
258 int32_t fs_fragshift; /* block to frag shift */
259 int32_t fs_fsbtodb; /* fsbtodb and dbtofsb shift constant */
260 int32_t fs_sbsize; /* actual size of super block */
261 int32_t fs_spare1[2]; /* old fs_csmask */
262 /* old fs_csshift */
263 int32_t fs_nindir; /* value of NINDIR */
264 int32_t fs_inopb; /* value of INOPB */
265 int32_t fs_old_nspf; /* value of NSPF */
266 /* yet another configuration parameter */
267 int32_t fs_optim; /* optimization preference, see below */
268 /* these fields are derived from the hardware */
269 int32_t fs_old_npsect; /* # sectors/track including spares */
270 int32_t fs_old_interleave; /* hardware sector interleave */
271 int32_t fs_old_trackskew; /* sector 0 skew, per track */
272 /* fs_id takes the space of the unused fs_headswitch and fs_trkseek fields */
273 int32_t fs_id[2]; /* unique file system id */
274 /* sizes determined by number of cylinder groups and their sizes */
275 int32_t fs_old_csaddr; /* blk addr of cyl grp summary area */
276 int32_t fs_cssize; /* size of cyl grp summary area */
277 int32_t fs_cgsize; /* cylinder group size */
278 /* these fields are derived from the hardware */
279 int32_t fs_spare2; /* old fs_ntrak */
280 int32_t fs_old_nsect; /* sectors per track */
281 int32_t fs_old_spc; /* sectors per cylinder */
282 int32_t fs_old_ncyl; /* cylinders in file system */
283 int32_t fs_old_cpg; /* cylinders per group */
284 int32_t fs_ipg; /* inodes per group */
285 int32_t fs_fpg; /* blocks per group * fs_frag */
286 /* this data must be re-computed after crashes */
287 struct csum fs_old_cstotal; /* cylinder summary information */
288 /* these fields are cleared at mount time */
289 int8_t fs_fmod; /* super block modified flag */
290 int8_t fs_clean; /* file system is clean flag */
291 int8_t fs_ronly; /* mounted read-only flag */
292 uint8_t fs_old_flags; /* see FS_ flags below */
293 u_char fs_fsmnt[MAXMNTLEN]; /* name mounted on */
294 u_char fs_volname[MAXVOLLEN]; /* volume name */
295 uint64_t fs_swuid; /* system-wide uid */
296 int32_t fs_pad;
297 /* these fields retain the current block allocation info */
298 int32_t fs_cgrotor; /* last cg searched (UNUSED) */
299 void *fs_ocsp[NOCSPTRS]; /* padding; was list of fs_cs buffers */
300 u_int8_t *fs_contigdirs; /* # of contiguously allocated dirs */
301 struct csum *fs_csp; /* cg summary info buffer for fs_cs */
302 int32_t *fs_maxcluster; /* max cluster in each cyl group */
303 u_int *fs_active; /* used by snapshots to track fs */
304 int32_t fs_old_cpc; /* cyl per cycle in postbl */
305 /* this area is otherwise allocated in filesystems created before ffsv2 */
306 int32_t fs_maxbsize; /* maximum blocking factor permitted */
307 int64_t fs_sparecon64[17]; /* old rotation block list head */
308 int64_t fs_sblockloc; /* byte offset of standard superblock */
309 struct csum_total fs_cstotal; /* cylinder summary information */
310 int64_t fs_time; /* last time written */
311 int64_t fs_size; /* number of blocks in fs */
312 int64_t fs_dsize; /* number of data blocks in fs */
313 int64_t fs_csaddr; /* blk addr of cyl grp summary area */
314 int64_t fs_pendingblocks; /* blocks in process of being freed */
315 int32_t fs_pendinginodes; /* inodes in process of being freed */
316 int32_t fs_snapinum[FSMAXSNAP];/* list of snapshot inode numbers */
317 /* back to stuff that has been around a while */
318 int32_t fs_avgfilesize; /* expected average file size */
319 int32_t fs_avgfpdir; /* expected # of files per directory */
320 int32_t fs_save_cgsize; /* save real cg size to use fs_bsize */
321 int32_t fs_sparecon32[26]; /* reserved for future constants */
322 uint32_t fs_flags; /* see FS_ flags below */
323 /* back to stuff that has been around a while (again) */
324 int32_t fs_contigsumsize; /* size of cluster summary array */
325 int32_t fs_maxsymlinklen; /* max length of an internal symlink */
326 int32_t fs_old_inodefmt; /* format of on-disk inodes */
327 u_int64_t fs_maxfilesize; /* maximum representable file size */
328 int64_t fs_qbmask; /* ~fs_bmask for use with 64-bit size */
329 int64_t fs_qfmask; /* ~fs_fmask for use with 64-bit size */
330 int32_t fs_state; /* validate fs_clean field (UNUSED) */
331 int32_t fs_old_postblformat; /* format of positional layout tables */
332 int32_t fs_old_nrpos; /* number of rotational positions */
333 int32_t fs_spare5[2]; /* old fs_postbloff */
334 /* old fs_rotbloff */
335 int32_t fs_magic; /* magic number */
336 };
337
338 #define fs_old_postbloff fs_spare5[0]
339 #define fs_old_rotbloff fs_spare5[1]
340 #define fs_old_postbl_start fs_maxbsize
341 #define fs_old_headswitch fs_id[0]
342 #define fs_old_trkseek fs_id[1]
343 #define fs_old_csmask fs_spare1[0]
344 #define fs_old_csshift fs_spare1[1]
345
346 #define FS_42POSTBLFMT -1 /* 4.2BSD rotational table format */
347 #define FS_DYNAMICPOSTBLFMT 1 /* dynamic rotational table format */
348
349 #define old_fs_postbl(fs_, cylno, opostblsave) \
350 ((((fs_)->fs_old_postblformat == FS_42POSTBLFMT) || \
351 ((fs_)->fs_old_postbloff == offsetof(struct fs, fs_old_postbl_start))) \
352 ? ((int16_t *)(opostblsave) + (cylno) * (fs_)->fs_old_nrpos) \
353 : ((int16_t *)((uint8_t *)(fs_) + \
354 (fs_)->fs_old_postbloff) + (cylno) * (fs_)->fs_old_nrpos))
355 #define old_fs_rotbl(fs) \
356 (((fs)->fs_old_postblformat == FS_42POSTBLFMT) \
357 ? ((uint8_t *)(&(fs)->fs_magic+1)) \
358 : ((uint8_t *)((uint8_t *)(fs) + (fs)->fs_old_rotbloff)))
359
360 /*
361 * File system identification
362 */
363 #define FS_UFS1_MAGIC 0x011954 /* UFS1 fast file system magic number */
364 #define FS_UFS2_MAGIC 0x19540119 /* UFS2 fast file system magic number */
365 #define FS_UFS1_MAGIC_SWAPPED 0x54190100
366 #define FS_UFS2_MAGIC_SWAPPED 0x19015419
367 #define FS_OKAY 0x7c269d38 /* superblock checksum */
368 #define FS_42INODEFMT -1 /* 4.2BSD inode format */
369 #define FS_44INODEFMT 2 /* 4.4BSD inode format */
370
371 /*
372 * File system clean flags
373 */
374 #define FS_ISCLEAN 0x01
375 #define FS_WASCLEAN 0x02
376
377 /*
378 * Preference for optimization.
379 */
380 #define FS_OPTTIME 0 /* minimize allocation time */
381 #define FS_OPTSPACE 1 /* minimize disk fragmentation */
382
383 /*
384 * File system flags
385 */
386 #define FS_UNCLEAN 0x01 /* file system not clean at mount (unused) */
387 #define FS_DOSOFTDEP 0x02 /* file system using soft dependencies */
388 #define FS_NEEDSFSCK 0x04 /* needs sync fsck (FreeBSD compat, unused) */
389 #define FS_INDEXDIRS 0x08 /* kernel supports indexed directories */
390 #define FS_ACLS 0x10 /* file system has ACLs enabled */
391 #define FS_MULTILABEL 0x20 /* file system is MAC multi-label */
392 #define FS_FLAGS_UPDATED 0x80 /* flags have been moved to new location */
393
394 /*
395 * File system internal flags, also in fs_flags.
396 * (Pick highest number to avoid conflicts with others)
397 */
398 #define FS_SWAPPED 0x80000000 /* file system is endian swapped */
399 #define FS_INTERNAL 0x80000000 /* mask for internal flags */
400
401 /*
402 * The size of a cylinder group is calculated by CGSIZE. The maximum size
403 * is limited by the fact that cylinder groups are at most one block.
404 * Its size is derived from the size of the maps maintained in the
405 * cylinder group and the (struct cg) size.
406 */
407 #define CGSIZE_IF(fs, ipg, fpg) \
408 /* base cg */ (sizeof(struct cg) + sizeof(int32_t) + \
409 /* old btotoff */ (fs)->fs_old_cpg * sizeof(int32_t) + \
410 /* old boff */ (fs)->fs_old_cpg * sizeof(u_int16_t) + \
411 /* inode map */ howmany((ipg), NBBY) + \
412 /* block map */ howmany((fpg), NBBY) +\
413 /* if present */ ((fs)->fs_contigsumsize <= 0 ? 0 : \
414 /* cluster sum */ (fs)->fs_contigsumsize * sizeof(int32_t) + \
415 /* cluster map */ howmany(fragstoblks(fs, (fpg)), NBBY)))
416
417 #define CGSIZE(fs) CGSIZE_IF((fs), (fs)->fs_ipg, (fs)->fs_fpg)
418
419 /*
420 * The minimal number of cylinder groups that should be created.
421 */
422 #define MINCYLGRPS 4
423
424
425 /*
426 * Convert cylinder group to base address of its global summary info.
427 */
428 #define fs_cs(fs, indx) fs_csp[indx]
429
430 /*
431 * Cylinder group block for a file system.
432 */
433 #define CG_MAGIC 0x090255
434 struct cg {
435 int32_t cg_firstfield; /* historic cyl groups linked list */
436 int32_t cg_magic; /* magic number */
437 int32_t cg_old_time; /* time last written */
438 int32_t cg_cgx; /* we are the cgx'th cylinder group */
439 int16_t cg_old_ncyl; /* number of cyl's this cg */
440 int16_t cg_old_niblk; /* number of inode blocks this cg */
441 int32_t cg_ndblk; /* number of data blocks this cg */
442 struct csum cg_cs; /* cylinder summary information */
443 int32_t cg_rotor; /* position of last used block */
444 int32_t cg_frotor; /* position of last used frag */
445 int32_t cg_irotor; /* position of last used inode */
446 int32_t cg_frsum[MAXFRAG]; /* counts of available frags */
447 int32_t cg_old_btotoff; /* (int32) block totals per cylinder */
448 int32_t cg_old_boff; /* (u_int16) free block positions */
449 int32_t cg_iusedoff; /* (u_int8) used inode map */
450 int32_t cg_freeoff; /* (u_int8) free block map */
451 int32_t cg_nextfreeoff; /* (u_int8) next available space */
452 int32_t cg_clustersumoff; /* (u_int32) counts of avail clusters */
453 int32_t cg_clusteroff; /* (u_int8) free cluster map */
454 int32_t cg_nclusterblks; /* number of clusters this cg */
455 int32_t cg_niblk; /* number of inode blocks this cg */
456 int32_t cg_initediblk; /* last initialized inode */
457 int32_t cg_sparecon32[3]; /* reserved for future use */
458 int64_t cg_time; /* time last written */
459 int64_t cg_sparecon64[3]; /* reserved for future use */
460 u_int8_t cg_space[1]; /* space for cylinder group maps */
461 /* actually longer */
462 };
463
464 /*
465 * The following structure is defined
466 * for compatibility with old file systems.
467 */
468 struct ocg {
469 int32_t cg_firstfield; /* historic linked list of cyl groups */
470 int32_t cg_unused_1; /* used for incore cyl groups */
471 int32_t cg_time; /* time last written */
472 int32_t cg_cgx; /* we are the cgx'th cylinder group */
473 int16_t cg_ncyl; /* number of cyl's this cg */
474 int16_t cg_niblk; /* number of inode blocks this cg */
475 int32_t cg_ndblk; /* number of data blocks this cg */
476 struct csum cg_cs; /* cylinder summary information */
477 int32_t cg_rotor; /* position of last used block */
478 int32_t cg_frotor; /* position of last used frag */
479 int32_t cg_irotor; /* position of last used inode */
480 int32_t cg_frsum[8]; /* counts of available frags */
481 int32_t cg_btot[32]; /* block totals per cylinder */
482 int16_t cg_b[32][8]; /* positions of free blocks */
483 u_int8_t cg_iused[256]; /* used inode map */
484 int32_t cg_magic; /* magic number */
485 u_int8_t cg_free[1]; /* free block map */
486 /* actually longer */
487 };
488
489
490 /*
491 * Macros for access to cylinder group array structures.
492 */
493 #define old_cg_blktot_old(cgp, ns) \
494 (((struct ocg *)(cgp))->cg_btot)
495 #define old_cg_blks_old(fs, cgp, cylno, ns) \
496 (((struct ocg *)(cgp))->cg_b[cylno])
497
498 #define old_cg_blktot_new(cgp, ns) \
499 ((int32_t *)((u_int8_t *)(cgp) + \
500 ufs_rw32((cgp)->cg_old_btotoff, (ns))))
501 #define old_cg_blks_new(fs, cgp, cylno, ns) \
502 ((int16_t *)((u_int8_t *)(cgp) + \
503 ufs_rw32((cgp)->cg_old_boff, (ns))) + (cylno) * (fs)->fs_old_nrpos)
504
505 #define old_cg_blktot(cgp, ns) \
506 ((ufs_rw32((cgp)->cg_magic, (ns)) != CG_MAGIC) ? \
507 old_cg_blktot_old(cgp, ns) : old_cg_blktot_new(cgp, ns))
508 #define old_cg_blks(fs, cgp, cylno, ns) \
509 ((ufs_rw32((cgp)->cg_magic, (ns)) != CG_MAGIC) ? \
510 old_cg_blks_old(fs, cgp, cylno, ns) : old_cg_blks_new(fs, cgp, cylno, ns))
511
512 #define cg_inosused_new(cgp, ns) \
513 ((u_int8_t *)((u_int8_t *)(cgp) + \
514 ufs_rw32((cgp)->cg_iusedoff, (ns))))
515 #define cg_blksfree_new(cgp, ns) \
516 ((u_int8_t *)((u_int8_t *)(cgp) + \
517 ufs_rw32((cgp)->cg_freeoff, (ns))))
518 #define cg_chkmagic_new(cgp, ns) \
519 (ufs_rw32((cgp)->cg_magic, (ns)) == CG_MAGIC)
520
521 #define cg_inosused_old(cgp, ns) \
522 (((struct ocg *)(cgp))->cg_iused)
523 #define cg_blksfree_old(cgp, ns) \
524 (((struct ocg *)(cgp))->cg_free)
525 #define cg_chkmagic_old(cgp, ns) \
526 (ufs_rw32(((struct ocg *)(cgp))->cg_magic, (ns)) == CG_MAGIC)
527
528 #define cg_inosused(cgp, ns) \
529 ((ufs_rw32((cgp)->cg_magic, (ns)) != CG_MAGIC) ? \
530 cg_inosused_old(cgp, ns) : cg_inosused_new(cgp, ns))
531 #define cg_blksfree(cgp, ns) \
532 ((ufs_rw32((cgp)->cg_magic, (ns)) != CG_MAGIC) ? \
533 cg_blksfree_old(cgp, ns) : cg_blksfree_new(cgp, ns))
534 #define cg_chkmagic(cgp, ns) \
535 (cg_chkmagic_new(cgp, ns) || cg_chkmagic_old(cgp, ns))
536
537 #define cg_clustersfree(cgp, ns) \
538 ((u_int8_t *)((u_int8_t *)(cgp) + \
539 ufs_rw32((cgp)->cg_clusteroff, (ns))))
540 #define cg_clustersum(cgp, ns) \
541 ((int32_t *)((u_int8_t *)(cgp) + \
542 ufs_rw32((cgp)->cg_clustersumoff, (ns))))
543
544
545 /*
546 * Turn file system block numbers into disk block addresses.
547 * This maps file system blocks to device size blocks.
548 */
549 #define fsbtodb(fs, b) ((b) << (fs)->fs_fsbtodb)
550 #define dbtofsb(fs, b) ((b) >> (fs)->fs_fsbtodb)
551
552 /*
553 * Cylinder group macros to locate things in cylinder groups.
554 * They calc file system addresses of cylinder group data structures.
555 */
556 #define cgbase(fs, c) (((daddr_t)(fs)->fs_fpg) * (c))
557 #define cgstart_ufs1(fs, c) \
558 (cgbase(fs, c) + (fs)->fs_old_cgoffset * ((c) & ~((fs)->fs_old_cgmask)))
559 #define cgstart_ufs2(fs, c) cgbase((fs), (c))
560 #define cgstart(fs, c) ((fs)->fs_magic == FS_UFS2_MAGIC \
561 ? cgstart_ufs2((fs), (c)) : cgstart_ufs1((fs), (c)))
562 #define cgdmin(fs, c) (cgstart(fs, c) + (fs)->fs_dblkno) /* 1st data */
563 #define cgimin(fs, c) (cgstart(fs, c) + (fs)->fs_iblkno) /* inode blk */
564 #define cgsblock(fs, c) (cgstart(fs, c) + (fs)->fs_sblkno) /* super blk */
565 #define cgtod(fs, c) (cgstart(fs, c) + (fs)->fs_cblkno) /* cg block */
566
567 /*
568 * Macros for handling inode numbers:
569 * inode number to file system block offset.
570 * inode number to cylinder group number.
571 * inode number to file system block address.
572 */
573 #define ino_to_cg(fs, x) ((x) / (fs)->fs_ipg)
574 #define ino_to_fsba(fs, x) \
575 ((daddr_t)(cgimin(fs, ino_to_cg(fs, x)) + \
576 (blkstofrags((fs), (((x) % (fs)->fs_ipg) / INOPB(fs))))))
577 #define ino_to_fsbo(fs, x) ((x) % INOPB(fs))
578
579 /*
580 * Give cylinder group number for a file system block.
581 * Give cylinder group block number for a file system block.
582 */
583 #define dtog(fs, d) ((d) / (fs)->fs_fpg)
584 #define dtogd(fs, d) ((d) % (fs)->fs_fpg)
585
586 /*
587 * Extract the bits for a block from a map.
588 * Compute the cylinder and rotational position of a cyl block addr.
589 */
590 #define blkmap(fs, map, loc) \
591 (((map)[(loc) / NBBY] >> ((loc) % NBBY)) & (0xff >> (NBBY - (fs)->fs_frag)))
592 #define old_cbtocylno(fs, bno) \
593 (fsbtodb(fs, bno) / (fs)->fs_old_spc)
594 #define old_cbtorpos(fs, bno) \
595 ((fs)->fs_old_nrpos <= 1 ? 0 : \
596 (fsbtodb(fs, bno) % (fs)->fs_old_spc / (fs)->fs_old_nsect * (fs)->fs_old_trackskew + \
597 fsbtodb(fs, bno) % (fs)->fs_old_spc % (fs)->fs_old_nsect * (fs)->fs_old_interleave) % \
598 (fs)->fs_old_nsect * (fs)->fs_old_nrpos / (fs)->fs_old_npsect)
599
600 /*
601 * The following macros optimize certain frequently calculated
602 * quantities by using shifts and masks in place of divisions
603 * modulos and multiplications.
604 */
605 #define blkoff(fs, loc) /* calculates (loc % fs->fs_bsize) */ \
606 ((loc) & (fs)->fs_qbmask)
607 #define fragoff(fs, loc) /* calculates (loc % fs->fs_fsize) */ \
608 ((loc) & (fs)->fs_qfmask)
609 #define lfragtosize(fs, frag) /* calculates ((off_t)frag * fs->fs_fsize) */ \
610 (((off_t)(frag)) << (fs)->fs_fshift)
611 #define lblktosize(fs, blk) /* calculates ((off_t)blk * fs->fs_bsize) */ \
612 (((off_t)(blk)) << (fs)->fs_bshift)
613 #define lblkno(fs, loc) /* calculates (loc / fs->fs_bsize) */ \
614 ((loc) >> (fs)->fs_bshift)
615 #define numfrags(fs, loc) /* calculates (loc / fs->fs_fsize) */ \
616 ((loc) >> (fs)->fs_fshift)
617 #define blkroundup(fs, size) /* calculates roundup(size, fs->fs_bsize) */ \
618 (((size) + (fs)->fs_qbmask) & (fs)->fs_bmask)
619 #define fragroundup(fs, size) /* calculates roundup(size, fs->fs_fsize) */ \
620 (((size) + (fs)->fs_qfmask) & (fs)->fs_fmask)
621 #define fragstoblks(fs, frags) /* calculates (frags / fs->fs_frag) */ \
622 ((frags) >> (fs)->fs_fragshift)
623 #define blkstofrags(fs, blks) /* calculates (blks * fs->fs_frag) */ \
624 ((blks) << (fs)->fs_fragshift)
625 #define fragnum(fs, fsb) /* calculates (fsb % fs->fs_frag) */ \
626 ((fsb) & ((fs)->fs_frag - 1))
627 #define blknum(fs, fsb) /* calculates rounddown(fsb, fs->fs_frag) */ \
628 ((fsb) &~ ((fs)->fs_frag - 1))
629
630 /*
631 * Determine the number of available frags given a
632 * percentage to hold in reserve.
633 */
634 #define freespace(fs, percentreserved) \
635 (blkstofrags((fs), (fs)->fs_cstotal.cs_nbfree) + \
636 (fs)->fs_cstotal.cs_nffree - \
637 (((off_t)((fs)->fs_dsize)) * (percentreserved) / 100))
638
639 /*
640 * Determining the size of a file block in the file system.
641 */
642 #define blksize(fs, ip, lbn) \
643 (((lbn) >= NDADDR || (ip)->i_size >= lblktosize(fs, (lbn) + 1)) \
644 ? (fs)->fs_bsize \
645 : (fragroundup(fs, blkoff(fs, (ip)->i_size))))
646
647 #define sblksize(fs, size, lbn) \
648 (((lbn) >= NDADDR || (size) >= ((lbn) + 1) << (fs)->fs_bshift) \
649 ? (fs)->fs_bsize \
650 : (fragroundup(fs, blkoff(fs, (size)))))
651
652
653 /*
654 * Number of inodes in a secondary storage block/fragment.
655 */
656 #define INOPB(fs) ((fs)->fs_inopb)
657 #define INOPF(fs) ((fs)->fs_inopb >> (fs)->fs_fragshift)
658
659 /*
660 * Number of indirects in a file system block.
661 */
662 #define NINDIR(fs) ((fs)->fs_nindir)
663
664 /*
665 * Apple UFS Label:
666 * We check for this to decide to use APPLEUFS_DIRBLKSIZ
667 */
668 #define APPLEUFS_LABEL_MAGIC 0x4c41424c /* LABL */
669 #define APPLEUFS_LABEL_SIZE 1024
670 #define APPLEUFS_LABEL_OFFSET (BBSIZE - APPLEUFS_LABEL_SIZE) /* located at 7k */
671 #define APPLEUFS_LABEL_VERSION 1
672 #define APPLEUFS_MAX_LABEL_NAME 512
673
674 struct appleufslabel {
675 u_int32_t ul_magic;
676 u_int16_t ul_checksum;
677 u_int16_t ul_unused0;
678 u_int32_t ul_version;
679 u_int32_t ul_time;
680 u_int16_t ul_namelen;
681 u_char ul_name[APPLEUFS_MAX_LABEL_NAME]; /* Warning: may not be null terminated */
682 u_int16_t ul_unused1;
683 u_int64_t ul_uuid; /* Note this is only 4 byte aligned */
684 u_char ul_reserved[24];
685 u_char ul_unused[460];
686 } __attribute__((__packed__));
687
688
689 #endif /* !_UFS_FFS_FS_H_ */
690