etc/protocols - sync with NetBSD-8
[minix.git] / sys / ufs / lfs / lfs_accessors.h
blobe856aeab20edb7f3da3105e1c441650196cedfeb
1 /* $NetBSD: lfs_accessors.h,v 1.36 2015/10/03 08:29:48 dholland Exp $ */
3 /* from NetBSD: lfs.h,v 1.165 2015/07/24 06:59:32 dholland Exp */
4 /* from NetBSD: dinode.h,v 1.22 2013/01/22 09:39:18 dholland Exp */
5 /* from NetBSD: dir.h,v 1.21 2009/07/22 04:49:19 dholland Exp */
7 /*-
8 * Copyright (c) 1999, 2000, 2001, 2002, 2003 The NetBSD Foundation, Inc.
9 * All rights reserved.
11 * This code is derived from software contributed to The NetBSD Foundation
12 * by Konrad E. Schroder <perseant@hhhh.org>.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
16 * are met:
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
23 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
24 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
27 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
35 /*-
36 * Copyright (c) 1991, 1993
37 * The Regents of the University of California. All rights reserved.
39 * Redistribution and use in source and binary forms, with or without
40 * modification, are permitted provided that the following conditions
41 * are met:
42 * 1. Redistributions of source code must retain the above copyright
43 * notice, this list of conditions and the following disclaimer.
44 * 2. Redistributions in binary form must reproduce the above copyright
45 * notice, this list of conditions and the following disclaimer in the
46 * documentation and/or other materials provided with the distribution.
47 * 3. Neither the name of the University nor the names of its contributors
48 * may be used to endorse or promote products derived from this software
49 * without specific prior written permission.
51 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
52 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
53 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
54 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
55 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
56 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
57 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
58 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
59 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
60 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
61 * SUCH DAMAGE.
63 * @(#)lfs.h 8.9 (Berkeley) 5/8/95
66 * Copyright (c) 2002 Networks Associates Technology, Inc.
67 * All rights reserved.
69 * This software was developed for the FreeBSD Project by Marshall
70 * Kirk McKusick and Network Associates Laboratories, the Security
71 * Research Division of Network Associates, Inc. under DARPA/SPAWAR
72 * contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
73 * research program
75 * Copyright (c) 1982, 1989, 1993
76 * The Regents of the University of California. All rights reserved.
77 * (c) UNIX System Laboratories, Inc.
78 * All or some portions of this file are derived from material licensed
79 * to the University of California by American Telephone and Telegraph
80 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
81 * the permission of UNIX System Laboratories, Inc.
83 * Redistribution and use in source and binary forms, with or without
84 * modification, are permitted provided that the following conditions
85 * are met:
86 * 1. Redistributions of source code must retain the above copyright
87 * notice, this list of conditions and the following disclaimer.
88 * 2. Redistributions in binary form must reproduce the above copyright
89 * notice, this list of conditions and the following disclaimer in the
90 * documentation and/or other materials provided with the distribution.
91 * 3. Neither the name of the University nor the names of its contributors
92 * may be used to endorse or promote products derived from this software
93 * without specific prior written permission.
95 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
96 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
97 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
98 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
99 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
100 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
101 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
102 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
103 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
104 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
105 * SUCH DAMAGE.
107 * @(#)dinode.h 8.9 (Berkeley) 3/29/95
110 * Copyright (c) 1982, 1986, 1989, 1993
111 * The Regents of the University of California. All rights reserved.
112 * (c) UNIX System Laboratories, Inc.
113 * All or some portions of this file are derived from material licensed
114 * to the University of California by American Telephone and Telegraph
115 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
116 * the permission of UNIX System Laboratories, Inc.
118 * Redistribution and use in source and binary forms, with or without
119 * modification, are permitted provided that the following conditions
120 * are met:
121 * 1. Redistributions of source code must retain the above copyright
122 * notice, this list of conditions and the following disclaimer.
123 * 2. Redistributions in binary form must reproduce the above copyright
124 * notice, this list of conditions and the following disclaimer in the
125 * documentation and/or other materials provided with the distribution.
126 * 3. Neither the name of the University nor the names of its contributors
127 * may be used to endorse or promote products derived from this software
128 * without specific prior written permission.
130 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
131 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
132 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
133 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
134 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
135 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
136 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
137 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
138 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
139 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
140 * SUCH DAMAGE.
142 * @(#)dir.h 8.5 (Berkeley) 4/27/95
145 #ifndef _UFS_LFS_LFS_ACCESSORS_H_
146 #define _UFS_LFS_LFS_ACCESSORS_H_
148 #if defined(_KERNEL_OPT)
149 #include "opt_lfs.h"
150 #endif
152 #include <sys/bswap.h>
154 #if !defined(_KERNEL) && !defined(_STANDALONE)
155 #include <assert.h>
156 #define KASSERT assert
157 #endif
160 * STRUCT_LFS is used by the libsa code to get accessors that work
161 * with struct salfs instead of struct lfs, and by the cleaner to
162 * get accessors that work with struct clfs.
165 #ifndef STRUCT_LFS
166 #define STRUCT_LFS struct lfs
167 #endif
170 * byte order
174 * For now at least, the bootblocks shall not be endian-independent.
175 * We can see later if it fits in the size budget. Also disable the
176 * byteswapping if LFS_EI is off.
178 * Caution: these functions "know" that bswap16/32/64 are unsigned,
179 * and if that changes will likely break silently.
182 #if defined(_STANDALONE) || (defined(_KERNEL) && !defined(LFS_EI))
183 #define LFS_SWAP_int16_t(fs, val) (val)
184 #define LFS_SWAP_int32_t(fs, val) (val)
185 #define LFS_SWAP_int64_t(fs, val) (val)
186 #define LFS_SWAP_uint16_t(fs, val) (val)
187 #define LFS_SWAP_uint32_t(fs, val) (val)
188 #define LFS_SWAP_uint64_t(fs, val) (val)
189 #else
190 #define LFS_SWAP_int16_t(fs, val) \
191 ((fs)->lfs_dobyteswap ? (int16_t)bswap16(val) : (val))
192 #define LFS_SWAP_int32_t(fs, val) \
193 ((fs)->lfs_dobyteswap ? (int32_t)bswap32(val) : (val))
194 #define LFS_SWAP_int64_t(fs, val) \
195 ((fs)->lfs_dobyteswap ? (int64_t)bswap64(val) : (val))
196 #define LFS_SWAP_uint16_t(fs, val) \
197 ((fs)->lfs_dobyteswap ? bswap16(val) : (val))
198 #define LFS_SWAP_uint32_t(fs, val) \
199 ((fs)->lfs_dobyteswap ? bswap32(val) : (val))
200 #define LFS_SWAP_uint64_t(fs, val) \
201 ((fs)->lfs_dobyteswap ? bswap64(val) : (val))
202 #endif
205 * For handling directories we will need to know if the volume is
206 * little-endian.
208 #if BYTE_ORDER == LITTLE_ENDIAN
209 #define LFS_LITTLE_ENDIAN_ONDISK(fs) (!(fs)->lfs_dobyteswap)
210 #else
211 #define LFS_LITTLE_ENDIAN_ONDISK(fs) ((fs)->lfs_dobyteswap)
212 #endif
216 * directories
219 #define LFS_DIRHEADERSIZE(fs) \
220 ((fs)->lfs_is64 ? sizeof(struct lfs_dirheader64) : sizeof(struct lfs_dirheader32))
223 * The LFS_DIRSIZ macro gives the minimum record length which will hold
224 * the directory entry. This requires the amount of space in struct lfs_direct
225 * without the d_name field, plus enough space for the name with a terminating
226 * null byte (dp->d_namlen+1), rounded up to a 4 byte boundary.
228 #define LFS_DIRECTSIZ(fs, namlen) \
229 (LFS_DIRHEADERSIZE(fs) + (((namlen)+1 + 3) &~ 3))
232 * The size of the largest possible directory entry. This is
233 * used by ulfs_dirhash to figure the size of an array, so we
234 * need a single constant value true for both lfs32 and lfs64.
236 #define LFS_MAXDIRENTRYSIZE \
237 (sizeof(struct lfs_dirheader64) + (((LFS_MAXNAMLEN+1)+1 + 3) & ~3))
239 #if (BYTE_ORDER == LITTLE_ENDIAN)
240 #define LFS_OLDDIRSIZ(oldfmt, dp, needswap) \
241 (((oldfmt) && !(needswap)) ? \
242 LFS_DIRECTSIZ((dp)->d_type) : LFS_DIRECTSIZ((dp)->d_namlen))
243 #else
244 #define LFS_OLDDIRSIZ(oldfmt, dp, needswap) \
245 (((oldfmt) && (needswap)) ? \
246 LFS_DIRECTSIZ((dp)->d_type) : LFS_DIRECTSIZ((dp)->d_namlen))
247 #endif
249 #define LFS_DIRSIZ(fs, dp) LFS_DIRECTSIZ(fs, lfs_dir_getnamlen(fs, dp))
251 /* Constants for the first argument of LFS_OLDDIRSIZ */
252 #define LFS_OLDDIRFMT 1
253 #define LFS_NEWDIRFMT 0
255 #define LFS_NEXTDIR(fs, dp) \
256 ((LFS_DIRHEADER *)((char *)(dp) + lfs_dir_getreclen(fs, dp)))
258 static __unused inline char *
259 lfs_dir_nameptr(const STRUCT_LFS *fs, LFS_DIRHEADER *dh)
261 if (fs->lfs_is64) {
262 return (char *)(&dh->u_64 + 1);
263 } else {
264 return (char *)(&dh->u_32 + 1);
268 static __unused inline uint64_t
269 lfs_dir_getino(const STRUCT_LFS *fs, const LFS_DIRHEADER *dh)
271 if (fs->lfs_is64) {
272 uint64_t ino;
275 * XXX we can probably write this in a way that's both
276 * still legal and generates better code.
278 memcpy(&ino, &dh->u_64.dh_inoA, sizeof(dh->u_64.dh_inoA));
279 memcpy((char *)&ino + sizeof(dh->u_64.dh_inoA),
280 &dh->u_64.dh_inoB,
281 sizeof(dh->u_64.dh_inoB));
282 return LFS_SWAP_uint64_t(fs, ino);
283 } else {
284 return LFS_SWAP_uint32_t(fs, dh->u_32.dh_ino);
288 static __unused inline uint16_t
289 lfs_dir_getreclen(const STRUCT_LFS *fs, const LFS_DIRHEADER *dh)
291 if (fs->lfs_is64) {
292 return LFS_SWAP_uint16_t(fs, dh->u_64.dh_reclen);
293 } else {
294 return LFS_SWAP_uint16_t(fs, dh->u_32.dh_reclen);
298 static __unused inline uint8_t
299 lfs_dir_gettype(const STRUCT_LFS *fs, const LFS_DIRHEADER *dh)
301 if (fs->lfs_is64) {
302 KASSERT(fs->lfs_hasolddirfmt == 0);
303 return dh->u_64.dh_type;
304 } else if (fs->lfs_hasolddirfmt) {
305 return LFS_DT_UNKNOWN;
306 } else {
307 return dh->u_32.dh_type;
311 static __unused inline uint8_t
312 lfs_dir_getnamlen(const STRUCT_LFS *fs, const LFS_DIRHEADER *dh)
314 if (fs->lfs_is64) {
315 KASSERT(fs->lfs_hasolddirfmt == 0);
316 return dh->u_64.dh_type;
317 } else if (fs->lfs_hasolddirfmt && LFS_LITTLE_ENDIAN_ONDISK(fs)) {
318 /* low-order byte of old 16-bit namlen field */
319 return dh->u_32.dh_type;
320 } else {
321 return dh->u_32.dh_namlen;
325 static __unused inline void
326 lfs_dir_setino(STRUCT_LFS *fs, LFS_DIRHEADER *dh, uint64_t ino)
328 if (fs->lfs_is64) {
330 ino = LFS_SWAP_uint64_t(fs, ino);
332 * XXX we can probably write this in a way that's both
333 * still legal and generates better code.
335 memcpy(&dh->u_64.dh_inoA, &ino, sizeof(dh->u_64.dh_inoA));
336 memcpy(&dh->u_64.dh_inoB,
337 (char *)&ino + sizeof(dh->u_64.dh_inoA),
338 sizeof(dh->u_64.dh_inoB));
339 } else {
340 dh->u_32.dh_ino = LFS_SWAP_uint32_t(fs, ino);
344 static __unused inline void
345 lfs_dir_setreclen(STRUCT_LFS *fs, LFS_DIRHEADER *dh, uint16_t reclen)
347 if (fs->lfs_is64) {
348 dh->u_64.dh_reclen = LFS_SWAP_uint16_t(fs, reclen);
349 } else {
350 dh->u_32.dh_reclen = LFS_SWAP_uint16_t(fs, reclen);
354 static __unused inline void
355 lfs_dir_settype(const STRUCT_LFS *fs, LFS_DIRHEADER *dh, uint8_t type)
357 if (fs->lfs_is64) {
358 KASSERT(fs->lfs_hasolddirfmt == 0);
359 dh->u_64.dh_type = type;
360 } else if (fs->lfs_hasolddirfmt) {
361 /* do nothing */
362 return;
363 } else {
364 dh->u_32.dh_type = type;
368 static __unused inline void
369 lfs_dir_setnamlen(const STRUCT_LFS *fs, LFS_DIRHEADER *dh, uint8_t namlen)
371 if (fs->lfs_is64) {
372 KASSERT(fs->lfs_hasolddirfmt == 0);
373 dh->u_64.dh_namlen = namlen;
374 } else if (fs->lfs_hasolddirfmt && LFS_LITTLE_ENDIAN_ONDISK(fs)) {
375 /* low-order byte of old 16-bit namlen field */
376 dh->u_32.dh_type = namlen;
377 } else {
378 dh->u_32.dh_namlen = namlen;
382 static __unused inline void
383 lfs_copydirname(STRUCT_LFS *fs, char *dest, const char *src,
384 unsigned namlen, unsigned reclen)
386 unsigned spacelen;
388 KASSERT(reclen > LFS_DIRHEADERSIZE(fs));
389 spacelen = reclen - LFS_DIRHEADERSIZE(fs);
391 /* must always be at least 1 byte as a null terminator */
392 KASSERT(spacelen > namlen);
394 memcpy(dest, src, namlen);
395 memset(dest + namlen, '\0', spacelen - namlen);
398 static __unused LFS_DIRHEADER *
399 lfs_dirtemplate_dotdot(STRUCT_LFS *fs, union lfs_dirtemplate *dt)
401 /* XXX blah, be nice to have a way to do this w/o casts */
402 if (fs->lfs_is64) {
403 return (LFS_DIRHEADER *)&dt->u_64.dotdot_header;
404 } else {
405 return (LFS_DIRHEADER *)&dt->u_32.dotdot_header;
409 static __unused char *
410 lfs_dirtemplate_dotdotname(STRUCT_LFS *fs, union lfs_dirtemplate *dt)
412 if (fs->lfs_is64) {
413 return dt->u_64.dotdot_name;
414 } else {
415 return dt->u_32.dotdot_name;
420 * dinodes
424 * Maximum length of a symlink that can be stored within the inode.
426 #define LFS32_MAXSYMLINKLEN ((ULFS_NDADDR + ULFS_NIADDR) * sizeof(int32_t))
427 #define LFS64_MAXSYMLINKLEN ((ULFS_NDADDR + ULFS_NIADDR) * sizeof(int64_t))
429 #define LFS_MAXSYMLINKLEN(fs) \
430 ((fs)->lfs_is64 ? LFS64_MAXSYMLINKLEN : LFS32_MAXSYMLINKLEN)
432 #define DINOSIZE(fs) ((fs)->lfs_is64 ? sizeof(struct lfs64_dinode) : sizeof(struct lfs32_dinode))
434 #define DINO_IN_BLOCK(fs, base, ix) \
435 ((union lfs_dinode *)((char *)(base) + DINOSIZE(fs) * (ix)))
437 static __unused inline void
438 lfs_copy_dinode(STRUCT_LFS *fs,
439 union lfs_dinode *dst, const union lfs_dinode *src)
442 * We can do structure assignment of the structs, but not of
443 * the whole union, as the union is the size of the (larger)
444 * 64-bit struct and on a 32-bit fs the upper half of it might
445 * be off the end of a buffer or otherwise invalid.
447 if (fs->lfs_is64) {
448 dst->u_64 = src->u_64;
449 } else {
450 dst->u_32 = src->u_32;
454 #define LFS_DEF_DINO_ACCESSOR(type, type32, field) \
455 static __unused inline type \
456 lfs_dino_get##field(STRUCT_LFS *fs, union lfs_dinode *dip) \
458 if (fs->lfs_is64) { \
459 return LFS_SWAP_##type(fs, dip->u_64.di_##field); \
460 } else { \
461 return LFS_SWAP_##type32(fs, dip->u_32.di_##field); \
464 static __unused inline void \
465 lfs_dino_set##field(STRUCT_LFS *fs, union lfs_dinode *dip, type val) \
467 if (fs->lfs_is64) { \
468 type *p = &dip->u_64.di_##field; \
469 (void)p; \
470 dip->u_64.di_##field = LFS_SWAP_##type(fs, val); \
471 } else { \
472 type32 *p = &dip->u_32.di_##field; \
473 (void)p; \
474 dip->u_32.di_##field = LFS_SWAP_##type32(fs, val); \
478 LFS_DEF_DINO_ACCESSOR(uint16_t, uint16_t, mode);
479 LFS_DEF_DINO_ACCESSOR(int16_t, int16_t, nlink);
480 LFS_DEF_DINO_ACCESSOR(uint64_t, uint32_t, inumber);
481 LFS_DEF_DINO_ACCESSOR(uint64_t, uint64_t, size);
482 LFS_DEF_DINO_ACCESSOR(int64_t, int32_t, atime);
483 LFS_DEF_DINO_ACCESSOR(int32_t, int32_t, atimensec);
484 LFS_DEF_DINO_ACCESSOR(int64_t, int32_t, mtime);
485 LFS_DEF_DINO_ACCESSOR(int32_t, int32_t, mtimensec);
486 LFS_DEF_DINO_ACCESSOR(int64_t, int32_t, ctime);
487 LFS_DEF_DINO_ACCESSOR(int32_t, int32_t, ctimensec);
488 LFS_DEF_DINO_ACCESSOR(uint32_t, uint32_t, flags);
489 LFS_DEF_DINO_ACCESSOR(uint64_t, uint32_t, blocks);
490 LFS_DEF_DINO_ACCESSOR(int32_t, int32_t, gen);
491 LFS_DEF_DINO_ACCESSOR(uint32_t, uint32_t, uid);
492 LFS_DEF_DINO_ACCESSOR(uint32_t, uint32_t, gid);
494 /* XXX this should be done differently (it's a fake field) */
495 LFS_DEF_DINO_ACCESSOR(uint64_t, int32_t, rdev);
497 static __unused inline daddr_t
498 lfs_dino_getdb(STRUCT_LFS *fs, union lfs_dinode *dip, unsigned ix)
500 KASSERT(ix < ULFS_NDADDR);
501 if (fs->lfs_is64) {
502 return dip->u_64.di_db[ix];
503 } else {
504 /* note: this must sign-extend or UNWRITTEN gets trashed */
505 return dip->u_32.di_db[ix];
509 static __unused inline daddr_t
510 lfs_dino_getib(STRUCT_LFS *fs, union lfs_dinode *dip, unsigned ix)
512 KASSERT(ix < ULFS_NIADDR);
513 if (fs->lfs_is64) {
514 return dip->u_64.di_ib[ix];
515 } else {
516 /* note: this must sign-extend or UNWRITTEN gets trashed */
517 return dip->u_32.di_ib[ix];
521 static __unused inline void
522 lfs_dino_setdb(STRUCT_LFS *fs, union lfs_dinode *dip, unsigned ix, daddr_t val)
524 KASSERT(ix < ULFS_NDADDR);
525 if (fs->lfs_is64) {
526 dip->u_64.di_db[ix] = val;
527 } else {
528 dip->u_32.di_db[ix] = val;
532 static __unused inline void
533 lfs_dino_setib(STRUCT_LFS *fs, union lfs_dinode *dip, unsigned ix, daddr_t val)
535 KASSERT(ix < ULFS_NIADDR);
536 if (fs->lfs_is64) {
537 dip->u_64.di_ib[ix] = val;
538 } else {
539 dip->u_32.di_ib[ix] = val;
543 /* birthtime is present only in the 64-bit inode */
544 static __unused inline void
545 lfs_dino_setbirthtime(STRUCT_LFS *fs, union lfs_dinode *dip,
546 const struct timespec *ts)
548 if (fs->lfs_is64) {
549 dip->u_64.di_birthtime = ts->tv_sec;
550 dip->u_64.di_birthnsec = ts->tv_nsec;
551 } else {
552 /* drop it on the floor */
557 * indirect blocks
560 static __unused inline daddr_t
561 lfs_iblock_get(STRUCT_LFS *fs, void *block, unsigned ix)
563 if (fs->lfs_is64) {
564 // XXX re-enable these asserts after reorging this file
565 //KASSERT(ix < lfs_sb_getbsize(fs) / sizeof(int64_t));
566 return (daddr_t)(((int64_t *)block)[ix]);
567 } else {
568 //KASSERT(ix < lfs_sb_getbsize(fs) / sizeof(int32_t));
569 /* must sign-extend or UNWRITTEN gets trashed */
570 return (daddr_t)(int64_t)(((int32_t *)block)[ix]);
574 static __unused inline void
575 lfs_iblock_set(STRUCT_LFS *fs, void *block, unsigned ix, daddr_t val)
577 if (fs->lfs_is64) {
578 //KASSERT(ix < lfs_sb_getbsize(fs) / sizeof(int64_t));
579 ((int64_t *)block)[ix] = val;
580 } else {
581 //KASSERT(ix < lfs_sb_getbsize(fs) / sizeof(int32_t));
582 ((int32_t *)block)[ix] = val;
587 * "struct buf" associated definitions
590 # define LFS_LOCK_BUF(bp) do { \
591 if (((bp)->b_flags & B_LOCKED) == 0 && bp->b_iodone == NULL) { \
592 mutex_enter(&lfs_lock); \
593 ++locked_queue_count; \
594 locked_queue_bytes += bp->b_bufsize; \
595 mutex_exit(&lfs_lock); \
597 (bp)->b_flags |= B_LOCKED; \
598 } while (0)
600 # define LFS_UNLOCK_BUF(bp) do { \
601 if (((bp)->b_flags & B_LOCKED) != 0 && bp->b_iodone == NULL) { \
602 mutex_enter(&lfs_lock); \
603 --locked_queue_count; \
604 locked_queue_bytes -= bp->b_bufsize; \
605 if (locked_queue_count < LFS_WAIT_BUFS && \
606 locked_queue_bytes < LFS_WAIT_BYTES) \
607 cv_broadcast(&locked_queue_cv); \
608 mutex_exit(&lfs_lock); \
610 (bp)->b_flags &= ~B_LOCKED; \
611 } while (0)
614 * "struct inode" associated definitions
617 #define LFS_SET_UINO(ip, flags) do { \
618 if (((flags) & IN_ACCESSED) && !((ip)->i_flag & IN_ACCESSED)) \
619 lfs_sb_adduinodes((ip)->i_lfs, 1); \
620 if (((flags) & IN_CLEANING) && !((ip)->i_flag & IN_CLEANING)) \
621 lfs_sb_adduinodes((ip)->i_lfs, 1); \
622 if (((flags) & IN_MODIFIED) && !((ip)->i_flag & IN_MODIFIED)) \
623 lfs_sb_adduinodes((ip)->i_lfs, 1); \
624 (ip)->i_flag |= (flags); \
625 } while (0)
627 #define LFS_CLR_UINO(ip, flags) do { \
628 if (((flags) & IN_ACCESSED) && ((ip)->i_flag & IN_ACCESSED)) \
629 lfs_sb_subuinodes((ip)->i_lfs, 1); \
630 if (((flags) & IN_CLEANING) && ((ip)->i_flag & IN_CLEANING)) \
631 lfs_sb_subuinodes((ip)->i_lfs, 1); \
632 if (((flags) & IN_MODIFIED) && ((ip)->i_flag & IN_MODIFIED)) \
633 lfs_sb_subuinodes((ip)->i_lfs, 1); \
634 (ip)->i_flag &= ~(flags); \
635 if (lfs_sb_getuinodes((ip)->i_lfs) < 0) { \
636 panic("lfs_uinodes < 0"); \
638 } while (0)
640 #define LFS_ITIMES(ip, acc, mod, cre) \
641 while ((ip)->i_flag & (IN_ACCESS | IN_CHANGE | IN_UPDATE | IN_MODIFY)) \
642 lfs_itimes(ip, acc, mod, cre)
645 * On-disk and in-memory checkpoint segment usage structure.
648 #define SEGUPB(fs) (lfs_sb_getsepb(fs))
649 #define SEGTABSIZE_SU(fs) \
650 ((lfs_sb_getnseg(fs) + SEGUPB(fs) - 1) / lfs_sb_getsepb(fs))
652 #ifdef _KERNEL
653 # define SHARE_IFLOCK(F) \
654 do { \
655 rw_enter(&(F)->lfs_iflock, RW_READER); \
656 } while(0)
657 # define UNSHARE_IFLOCK(F) \
658 do { \
659 rw_exit(&(F)->lfs_iflock); \
660 } while(0)
661 #else /* ! _KERNEL */
662 # define SHARE_IFLOCK(F)
663 # define UNSHARE_IFLOCK(F)
664 #endif /* ! _KERNEL */
666 /* Read in the block with a specific segment usage entry from the ifile. */
667 #define LFS_SEGENTRY(SP, F, IN, BP) do { \
668 int _e; \
669 SHARE_IFLOCK(F); \
670 VTOI((F)->lfs_ivnode)->i_flag |= IN_ACCESS; \
671 if ((_e = bread((F)->lfs_ivnode, \
672 ((IN) / lfs_sb_getsepb(F)) + lfs_sb_getcleansz(F), \
673 lfs_sb_getbsize(F), 0, &(BP))) != 0) \
674 panic("lfs: ifile read: %d", _e); \
675 if (lfs_sb_getversion(F) == 1) \
676 (SP) = (SEGUSE *)((SEGUSE_V1 *)(BP)->b_data + \
677 ((IN) & (lfs_sb_getsepb(F) - 1))); \
678 else \
679 (SP) = (SEGUSE *)(BP)->b_data + ((IN) % lfs_sb_getsepb(F)); \
680 UNSHARE_IFLOCK(F); \
681 } while (0)
683 #define LFS_WRITESEGENTRY(SP, F, IN, BP) do { \
684 if ((SP)->su_nbytes == 0) \
685 (SP)->su_flags |= SEGUSE_EMPTY; \
686 else \
687 (SP)->su_flags &= ~SEGUSE_EMPTY; \
688 (F)->lfs_suflags[(F)->lfs_activesb][(IN)] = (SP)->su_flags; \
689 LFS_BWRITE_LOG(BP); \
690 } while (0)
693 * FINFO (file info) entries.
696 /* Size of an on-disk block pointer, e.g. in an indirect block. */
697 /* XXX: move to a more suitable location in this file */
698 #define LFS_BLKPTRSIZE(fs) ((fs)->lfs_is64 ? sizeof(int64_t) : sizeof(int32_t))
700 /* Size of an on-disk inode number. */
701 /* XXX: move to a more suitable location in this file */
702 #define LFS_INUMSIZE(fs) ((fs)->lfs_is64 ? sizeof(int64_t) : sizeof(int32_t))
704 /* size of a FINFO, without the block pointers */
705 #define FINFOSIZE(fs) ((fs)->lfs_is64 ? sizeof(FINFO64) : sizeof(FINFO32))
707 /* Full size of the provided FINFO record, including its block pointers. */
708 #define FINFO_FULLSIZE(fs, fip) \
709 (FINFOSIZE(fs) + lfs_fi_getnblocks(fs, fip) * LFS_BLKPTRSIZE(fs))
711 #define NEXT_FINFO(fs, fip) \
712 ((FINFO *)((char *)(fip) + FINFO_FULLSIZE(fs, fip)))
714 #define LFS_DEF_FI_ACCESSOR(type, type32, field) \
715 static __unused inline type \
716 lfs_fi_get##field(STRUCT_LFS *fs, FINFO *fip) \
718 if (fs->lfs_is64) { \
719 return fip->u_64.fi_##field; \
720 } else { \
721 return fip->u_32.fi_##field; \
724 static __unused inline void \
725 lfs_fi_set##field(STRUCT_LFS *fs, FINFO *fip, type val) \
727 if (fs->lfs_is64) { \
728 type *p = &fip->u_64.fi_##field; \
729 (void)p; \
730 fip->u_64.fi_##field = val; \
731 } else { \
732 type32 *p = &fip->u_32.fi_##field; \
733 (void)p; \
734 fip->u_32.fi_##field = val; \
738 LFS_DEF_FI_ACCESSOR(uint32_t, uint32_t, nblocks);
739 LFS_DEF_FI_ACCESSOR(uint32_t, uint32_t, version);
740 LFS_DEF_FI_ACCESSOR(uint64_t, uint32_t, ino);
741 LFS_DEF_FI_ACCESSOR(uint32_t, uint32_t, lastlength);
743 static __unused inline daddr_t
744 lfs_fi_getblock(STRUCT_LFS *fs, FINFO *fip, unsigned index)
746 void *firstblock;
748 firstblock = (char *)fip + FINFOSIZE(fs);
749 KASSERT(index < lfs_fi_getnblocks(fs, fip));
750 if (fs->lfs_is64) {
751 return ((int64_t *)firstblock)[index];
752 } else {
753 return ((int32_t *)firstblock)[index];
757 static __unused inline void
758 lfs_fi_setblock(STRUCT_LFS *fs, FINFO *fip, unsigned index, daddr_t blk)
760 void *firstblock;
762 firstblock = (char *)fip + FINFOSIZE(fs);
763 KASSERT(index < lfs_fi_getnblocks(fs, fip));
764 if (fs->lfs_is64) {
765 ((int64_t *)firstblock)[index] = blk;
766 } else {
767 ((int32_t *)firstblock)[index] = blk;
772 * inode info entries (in the segment summary)
775 #define IINFOSIZE(fs) ((fs)->lfs_is64 ? sizeof(IINFO64) : sizeof(IINFO32))
777 /* iinfos scroll backward from the end of the segment summary block */
778 #define SEGSUM_IINFOSTART(fs, buf) \
779 ((IINFO *)((char *)buf + lfs_sb_getsumsize(fs) - IINFOSIZE(fs)))
781 #define NEXTLOWER_IINFO(fs, iip) \
782 ((IINFO *)((char *)(iip) - IINFOSIZE(fs)))
784 #define NTH_IINFO(fs, buf, n) \
785 ((IINFO *)((char *)SEGSUM_IINFOSTART(fs, buf) - (n)*IINFOSIZE(fs)))
787 static __unused inline uint64_t
788 lfs_ii_getblock(STRUCT_LFS *fs, IINFO *iip)
790 if (fs->lfs_is64) {
791 return iip->u_64.ii_block;
792 } else {
793 return iip->u_32.ii_block;
797 static __unused inline void
798 lfs_ii_setblock(STRUCT_LFS *fs, IINFO *iip, uint64_t block)
800 if (fs->lfs_is64) {
801 iip->u_64.ii_block = block;
802 } else {
803 iip->u_32.ii_block = block;
808 * Index file inode entries.
811 #define IFILE_ENTRYSIZE(fs) \
812 ((fs)->lfs_is64 ? sizeof(IFILE64) : sizeof(IFILE32))
815 * LFSv1 compatibility code is not allowed to touch if_atime, since it
816 * may not be mapped!
818 /* Read in the block with a specific inode from the ifile. */
819 #define LFS_IENTRY(IP, F, IN, BP) do { \
820 int _e; \
821 SHARE_IFLOCK(F); \
822 VTOI((F)->lfs_ivnode)->i_flag |= IN_ACCESS; \
823 if ((_e = bread((F)->lfs_ivnode, \
824 (IN) / lfs_sb_getifpb(F) + lfs_sb_getcleansz(F) + lfs_sb_getsegtabsz(F), \
825 lfs_sb_getbsize(F), 0, &(BP))) != 0) \
826 panic("lfs: ifile ino %d read %d", (int)(IN), _e); \
827 if ((F)->lfs_is64) { \
828 (IP) = (IFILE *)((IFILE64 *)(BP)->b_data + \
829 (IN) % lfs_sb_getifpb(F)); \
830 } else if (lfs_sb_getversion(F) > 1) { \
831 (IP) = (IFILE *)((IFILE32 *)(BP)->b_data + \
832 (IN) % lfs_sb_getifpb(F)); \
833 } else { \
834 (IP) = (IFILE *)((IFILE_V1 *)(BP)->b_data + \
835 (IN) % lfs_sb_getifpb(F)); \
837 UNSHARE_IFLOCK(F); \
838 } while (0)
839 #define LFS_IENTRY_NEXT(IP, F) do { \
840 if ((F)->lfs_is64) { \
841 (IP) = (IFILE *)((IFILE64 *)(IP) + 1); \
842 } else if (lfs_sb_getversion(F) > 1) { \
843 (IP) = (IFILE *)((IFILE32 *)(IP) + 1); \
844 } else { \
845 (IP) = (IFILE *)((IFILE_V1 *)(IP) + 1); \
847 } while (0)
849 #define LFS_DEF_IF_ACCESSOR(type, type32, field) \
850 static __unused inline type \
851 lfs_if_get##field(STRUCT_LFS *fs, IFILE *ifp) \
853 if (fs->lfs_is64) { \
854 return ifp->u_64.if_##field; \
855 } else { \
856 return ifp->u_32.if_##field; \
859 static __unused inline void \
860 lfs_if_set##field(STRUCT_LFS *fs, IFILE *ifp, type val) \
862 if (fs->lfs_is64) { \
863 type *p = &ifp->u_64.if_##field; \
864 (void)p; \
865 ifp->u_64.if_##field = val; \
866 } else { \
867 type32 *p = &ifp->u_32.if_##field; \
868 (void)p; \
869 ifp->u_32.if_##field = val; \
873 LFS_DEF_IF_ACCESSOR(u_int32_t, u_int32_t, version);
874 LFS_DEF_IF_ACCESSOR(int64_t, int32_t, daddr);
875 LFS_DEF_IF_ACCESSOR(u_int64_t, u_int32_t, nextfree);
876 LFS_DEF_IF_ACCESSOR(u_int64_t, u_int32_t, atime_sec);
877 LFS_DEF_IF_ACCESSOR(u_int32_t, u_int32_t, atime_nsec);
880 * Cleaner information structure. This resides in the ifile and is used
881 * to pass information from the kernel to the cleaner.
884 #define CLEANSIZE_SU(fs) \
885 ((((fs)->lfs_is64 ? sizeof(CLEANERINFO64) : sizeof(CLEANERINFO32)) + \
886 lfs_sb_getbsize(fs) - 1) >> lfs_sb_getbshift(fs))
888 #define LFS_DEF_CI_ACCESSOR(type, type32, field) \
889 static __unused inline type \
890 lfs_ci_get##field(STRUCT_LFS *fs, CLEANERINFO *cip) \
892 if (fs->lfs_is64) { \
893 return cip->u_64.field; \
894 } else { \
895 return cip->u_32.field; \
898 static __unused inline void \
899 lfs_ci_set##field(STRUCT_LFS *fs, CLEANERINFO *cip, type val) \
901 if (fs->lfs_is64) { \
902 type *p = &cip->u_64.field; \
903 (void)p; \
904 cip->u_64.field = val; \
905 } else { \
906 type32 *p = &cip->u_32.field; \
907 (void)p; \
908 cip->u_32.field = val; \
912 LFS_DEF_CI_ACCESSOR(u_int32_t, u_int32_t, clean);
913 LFS_DEF_CI_ACCESSOR(u_int32_t, u_int32_t, dirty);
914 LFS_DEF_CI_ACCESSOR(int64_t, int32_t, bfree);
915 LFS_DEF_CI_ACCESSOR(int64_t, int32_t, avail);
916 LFS_DEF_CI_ACCESSOR(u_int64_t, u_int32_t, free_head);
917 LFS_DEF_CI_ACCESSOR(u_int64_t, u_int32_t, free_tail);
918 LFS_DEF_CI_ACCESSOR(u_int32_t, u_int32_t, flags);
920 static __unused inline void
921 lfs_ci_shiftcleantodirty(STRUCT_LFS *fs, CLEANERINFO *cip, unsigned num)
923 lfs_ci_setclean(fs, cip, lfs_ci_getclean(fs, cip) - num);
924 lfs_ci_setdirty(fs, cip, lfs_ci_getdirty(fs, cip) + num);
927 static __unused inline void
928 lfs_ci_shiftdirtytoclean(STRUCT_LFS *fs, CLEANERINFO *cip, unsigned num)
930 lfs_ci_setdirty(fs, cip, lfs_ci_getdirty(fs, cip) - num);
931 lfs_ci_setclean(fs, cip, lfs_ci_getclean(fs, cip) + num);
934 /* Read in the block with the cleaner info from the ifile. */
935 #define LFS_CLEANERINFO(CP, F, BP) do { \
936 SHARE_IFLOCK(F); \
937 VTOI((F)->lfs_ivnode)->i_flag |= IN_ACCESS; \
938 if (bread((F)->lfs_ivnode, \
939 (daddr_t)0, lfs_sb_getbsize(F), 0, &(BP))) \
940 panic("lfs: ifile read"); \
941 (CP) = (CLEANERINFO *)(BP)->b_data; \
942 UNSHARE_IFLOCK(F); \
943 } while (0)
946 * Synchronize the Ifile cleaner info with current avail and bfree.
948 #define LFS_SYNC_CLEANERINFO(cip, fs, bp, w) do { \
949 mutex_enter(&lfs_lock); \
950 if ((w) || lfs_ci_getbfree(fs, cip) != lfs_sb_getbfree(fs) || \
951 lfs_ci_getavail(fs, cip) != lfs_sb_getavail(fs) - fs->lfs_ravail - \
952 fs->lfs_favail) { \
953 lfs_ci_setbfree(fs, cip, lfs_sb_getbfree(fs)); \
954 lfs_ci_setavail(fs, cip, lfs_sb_getavail(fs) - fs->lfs_ravail - \
955 fs->lfs_favail); \
956 if (((bp)->b_flags & B_GATHERED) == 0) { \
957 fs->lfs_flags |= LFS_IFDIRTY; \
959 mutex_exit(&lfs_lock); \
960 (void) LFS_BWRITE_LOG(bp); /* Ifile */ \
961 } else { \
962 mutex_exit(&lfs_lock); \
963 brelse(bp, 0); \
965 } while (0)
968 * Get the head of the inode free list.
969 * Always called with the segment lock held.
971 #define LFS_GET_HEADFREE(FS, CIP, BP, FREEP) do { \
972 if (lfs_sb_getversion(FS) > 1) { \
973 LFS_CLEANERINFO((CIP), (FS), (BP)); \
974 lfs_sb_setfreehd(FS, lfs_ci_getfree_head(FS, CIP)); \
975 brelse(BP, 0); \
977 *(FREEP) = lfs_sb_getfreehd(FS); \
978 } while (0)
980 #define LFS_PUT_HEADFREE(FS, CIP, BP, VAL) do { \
981 lfs_sb_setfreehd(FS, VAL); \
982 if (lfs_sb_getversion(FS) > 1) { \
983 LFS_CLEANERINFO((CIP), (FS), (BP)); \
984 lfs_ci_setfree_head(FS, CIP, VAL); \
985 LFS_BWRITE_LOG(BP); \
986 mutex_enter(&lfs_lock); \
987 (FS)->lfs_flags |= LFS_IFDIRTY; \
988 mutex_exit(&lfs_lock); \
990 } while (0)
992 #define LFS_GET_TAILFREE(FS, CIP, BP, FREEP) do { \
993 LFS_CLEANERINFO((CIP), (FS), (BP)); \
994 *(FREEP) = lfs_ci_getfree_tail(FS, CIP); \
995 brelse(BP, 0); \
996 } while (0)
998 #define LFS_PUT_TAILFREE(FS, CIP, BP, VAL) do { \
999 LFS_CLEANERINFO((CIP), (FS), (BP)); \
1000 lfs_ci_setfree_tail(FS, CIP, VAL); \
1001 LFS_BWRITE_LOG(BP); \
1002 mutex_enter(&lfs_lock); \
1003 (FS)->lfs_flags |= LFS_IFDIRTY; \
1004 mutex_exit(&lfs_lock); \
1005 } while (0)
1008 * On-disk segment summary information
1011 #define SEGSUM_SIZE(fs) \
1012 (fs->lfs_is64 ? sizeof(SEGSUM64) : \
1013 lfs_sb_getversion(fs) > 1 ? sizeof(SEGSUM32) : sizeof(SEGSUM_V1))
1016 * The SEGSUM structure is followed by FINFO structures. Get the pointer
1017 * to the first FINFO.
1019 * XXX this can't be a macro yet; this file needs to be resorted.
1021 #if 0
1022 static __unused inline FINFO *
1023 segsum_finfobase(STRUCT_LFS *fs, SEGSUM *ssp)
1025 return (FINFO *)((char *)ssp + SEGSUM_SIZE(fs));
1027 #else
1028 #define SEGSUM_FINFOBASE(fs, ssp) \
1029 ((FINFO *)((char *)(ssp) + SEGSUM_SIZE(fs)));
1030 #endif
1032 #define LFS_DEF_SS_ACCESSOR(type, type32, field) \
1033 static __unused inline type \
1034 lfs_ss_get##field(STRUCT_LFS *fs, SEGSUM *ssp) \
1036 if (fs->lfs_is64) { \
1037 return ssp->u_64.ss_##field; \
1038 } else { \
1039 return ssp->u_32.ss_##field; \
1042 static __unused inline void \
1043 lfs_ss_set##field(STRUCT_LFS *fs, SEGSUM *ssp, type val) \
1045 if (fs->lfs_is64) { \
1046 type *p = &ssp->u_64.ss_##field; \
1047 (void)p; \
1048 ssp->u_64.ss_##field = val; \
1049 } else { \
1050 type32 *p = &ssp->u_32.ss_##field; \
1051 (void)p; \
1052 ssp->u_32.ss_##field = val; \
1056 LFS_DEF_SS_ACCESSOR(uint32_t, uint32_t, sumsum);
1057 LFS_DEF_SS_ACCESSOR(uint32_t, uint32_t, datasum);
1058 LFS_DEF_SS_ACCESSOR(uint32_t, uint32_t, magic);
1059 LFS_DEF_SS_ACCESSOR(uint32_t, uint32_t, ident);
1060 LFS_DEF_SS_ACCESSOR(int64_t, int32_t, next);
1061 LFS_DEF_SS_ACCESSOR(uint16_t, uint16_t, nfinfo);
1062 LFS_DEF_SS_ACCESSOR(uint16_t, uint16_t, ninos);
1063 LFS_DEF_SS_ACCESSOR(uint16_t, uint16_t, flags);
1064 LFS_DEF_SS_ACCESSOR(uint64_t, uint32_t, reclino);
1065 LFS_DEF_SS_ACCESSOR(uint64_t, uint64_t, serial);
1066 LFS_DEF_SS_ACCESSOR(uint64_t, uint64_t, create);
1068 static __unused inline size_t
1069 lfs_ss_getsumstart(STRUCT_LFS *fs)
1071 /* These are actually all the same. */
1072 if (fs->lfs_is64) {
1073 return offsetof(SEGSUM64, ss_datasum);
1074 } else /* if (lfs_sb_getversion(fs) > 1) */ {
1075 return offsetof(SEGSUM32, ss_datasum);
1076 } /* else {
1077 return offsetof(SEGSUM_V1, ss_datasum);
1078 } */
1080 * XXX ^^^ until this file is resorted lfs_sb_getversion isn't
1081 * defined yet.
1085 static __unused inline uint32_t
1086 lfs_ss_getocreate(STRUCT_LFS *fs, SEGSUM *ssp)
1088 KASSERT(fs->lfs_is64 == 0);
1089 /* XXX need to resort this file before we can do this */
1090 //KASSERT(lfs_sb_getversion(fs) == 1);
1092 return ssp->u_v1.ss_create;
1095 static __unused inline void
1096 lfs_ss_setocreate(STRUCT_LFS *fs, SEGSUM *ssp, uint32_t val)
1098 KASSERT(fs->lfs_is64 == 0);
1099 /* XXX need to resort this file before we can do this */
1100 //KASSERT(lfs_sb_getversion(fs) == 1);
1102 ssp->u_v1.ss_create = val;
1107 * Super block.
1111 * Generate accessors for the on-disk superblock fields with cpp.
1114 #define LFS_DEF_SB_ACCESSOR_FULL(type, type32, field) \
1115 static __unused inline type \
1116 lfs_sb_get##field(STRUCT_LFS *fs) \
1118 if (fs->lfs_is64) { \
1119 return fs->lfs_dlfs_u.u_64.dlfs_##field; \
1120 } else { \
1121 return fs->lfs_dlfs_u.u_32.dlfs_##field; \
1124 static __unused inline void \
1125 lfs_sb_set##field(STRUCT_LFS *fs, type val) \
1127 if (fs->lfs_is64) { \
1128 fs->lfs_dlfs_u.u_64.dlfs_##field = val; \
1129 } else { \
1130 fs->lfs_dlfs_u.u_32.dlfs_##field = val; \
1133 static __unused inline void \
1134 lfs_sb_add##field(STRUCT_LFS *fs, type val) \
1136 if (fs->lfs_is64) { \
1137 type *p64 = &fs->lfs_dlfs_u.u_64.dlfs_##field; \
1138 *p64 += val; \
1139 } else { \
1140 type32 *p32 = &fs->lfs_dlfs_u.u_32.dlfs_##field; \
1141 *p32 += val; \
1144 static __unused inline void \
1145 lfs_sb_sub##field(STRUCT_LFS *fs, type val) \
1147 if (fs->lfs_is64) { \
1148 type *p64 = &fs->lfs_dlfs_u.u_64.dlfs_##field; \
1149 *p64 -= val; \
1150 } else { \
1151 type32 *p32 = &fs->lfs_dlfs_u.u_32.dlfs_##field; \
1152 *p32 -= val; \
1156 #define LFS_DEF_SB_ACCESSOR(t, f) LFS_DEF_SB_ACCESSOR_FULL(t, t, f)
1158 #define LFS_DEF_SB_ACCESSOR_32ONLY(type, field, val64) \
1159 static __unused inline type \
1160 lfs_sb_get##field(STRUCT_LFS *fs) \
1162 if (fs->lfs_is64) { \
1163 return val64; \
1164 } else { \
1165 return fs->lfs_dlfs_u.u_32.dlfs_##field; \
1169 #define lfs_magic lfs_dlfs.dlfs_magic
1170 LFS_DEF_SB_ACCESSOR(u_int32_t, version);
1171 LFS_DEF_SB_ACCESSOR_FULL(u_int64_t, u_int32_t, size);
1172 LFS_DEF_SB_ACCESSOR(u_int32_t, ssize);
1173 LFS_DEF_SB_ACCESSOR_FULL(u_int64_t, u_int32_t, dsize);
1174 LFS_DEF_SB_ACCESSOR(u_int32_t, bsize);
1175 LFS_DEF_SB_ACCESSOR(u_int32_t, fsize);
1176 LFS_DEF_SB_ACCESSOR(u_int32_t, frag);
1177 LFS_DEF_SB_ACCESSOR_FULL(uint64_t, uint32_t, freehd);
1178 LFS_DEF_SB_ACCESSOR_FULL(int64_t, int32_t, bfree);
1179 LFS_DEF_SB_ACCESSOR_FULL(uint64_t, uint32_t, nfiles);
1180 LFS_DEF_SB_ACCESSOR_FULL(int64_t, int32_t, avail);
1181 LFS_DEF_SB_ACCESSOR(int32_t, uinodes);
1182 LFS_DEF_SB_ACCESSOR_FULL(int64_t, int32_t, idaddr);
1183 LFS_DEF_SB_ACCESSOR_32ONLY(u_int32_t, ifile, LFS_IFILE_INUM);
1184 LFS_DEF_SB_ACCESSOR_FULL(int64_t, int32_t, lastseg);
1185 LFS_DEF_SB_ACCESSOR_FULL(int64_t, int32_t, nextseg);
1186 LFS_DEF_SB_ACCESSOR_FULL(int64_t, int32_t, curseg);
1187 LFS_DEF_SB_ACCESSOR_FULL(int64_t, int32_t, offset);
1188 LFS_DEF_SB_ACCESSOR_FULL(int64_t, int32_t, lastpseg);
1189 LFS_DEF_SB_ACCESSOR(u_int32_t, inopf);
1190 LFS_DEF_SB_ACCESSOR(u_int32_t, minfree);
1191 LFS_DEF_SB_ACCESSOR(uint64_t, maxfilesize);
1192 LFS_DEF_SB_ACCESSOR(u_int32_t, fsbpseg);
1193 LFS_DEF_SB_ACCESSOR(u_int32_t, inopb);
1194 LFS_DEF_SB_ACCESSOR(u_int32_t, ifpb);
1195 LFS_DEF_SB_ACCESSOR(u_int32_t, sepb);
1196 LFS_DEF_SB_ACCESSOR(u_int32_t, nindir);
1197 LFS_DEF_SB_ACCESSOR(u_int32_t, nseg);
1198 LFS_DEF_SB_ACCESSOR(u_int32_t, nspf);
1199 LFS_DEF_SB_ACCESSOR(u_int32_t, cleansz);
1200 LFS_DEF_SB_ACCESSOR(u_int32_t, segtabsz);
1201 LFS_DEF_SB_ACCESSOR_32ONLY(u_int32_t, segmask, 0);
1202 LFS_DEF_SB_ACCESSOR_32ONLY(u_int32_t, segshift, 0);
1203 LFS_DEF_SB_ACCESSOR(u_int64_t, bmask);
1204 LFS_DEF_SB_ACCESSOR(u_int32_t, bshift);
1205 LFS_DEF_SB_ACCESSOR(u_int64_t, ffmask);
1206 LFS_DEF_SB_ACCESSOR(u_int32_t, ffshift);
1207 LFS_DEF_SB_ACCESSOR(u_int64_t, fbmask);
1208 LFS_DEF_SB_ACCESSOR(u_int32_t, fbshift);
1209 LFS_DEF_SB_ACCESSOR(u_int32_t, blktodb);
1210 LFS_DEF_SB_ACCESSOR(u_int32_t, fsbtodb);
1211 LFS_DEF_SB_ACCESSOR(u_int32_t, sushift);
1212 LFS_DEF_SB_ACCESSOR(int32_t, maxsymlinklen);
1213 LFS_DEF_SB_ACCESSOR(u_int32_t, cksum);
1214 LFS_DEF_SB_ACCESSOR(u_int16_t, pflags);
1215 LFS_DEF_SB_ACCESSOR(u_int32_t, nclean);
1216 LFS_DEF_SB_ACCESSOR(int32_t, dmeta);
1217 LFS_DEF_SB_ACCESSOR(u_int32_t, minfreeseg);
1218 LFS_DEF_SB_ACCESSOR(u_int32_t, sumsize);
1219 LFS_DEF_SB_ACCESSOR(u_int64_t, serial);
1220 LFS_DEF_SB_ACCESSOR(u_int32_t, ibsize);
1221 LFS_DEF_SB_ACCESSOR_FULL(int64_t, int32_t, s0addr);
1222 LFS_DEF_SB_ACCESSOR(u_int64_t, tstamp);
1223 LFS_DEF_SB_ACCESSOR(u_int32_t, inodefmt);
1224 LFS_DEF_SB_ACCESSOR(u_int32_t, interleave);
1225 LFS_DEF_SB_ACCESSOR(u_int32_t, ident);
1226 LFS_DEF_SB_ACCESSOR(u_int32_t, resvseg);
1228 /* special-case accessors */
1231 * the v1 otstamp field lives in what's now dlfs_inopf
1233 #define lfs_sb_getotstamp(fs) lfs_sb_getinopf(fs)
1234 #define lfs_sb_setotstamp(fs, val) lfs_sb_setinopf(fs, val)
1237 * lfs_sboffs is an array
1239 static __unused inline int32_t
1240 lfs_sb_getsboff(STRUCT_LFS *fs, unsigned n)
1242 #ifdef KASSERT /* ugh */
1243 KASSERT(n < LFS_MAXNUMSB);
1244 #endif
1245 if (fs->lfs_is64) {
1246 return fs->lfs_dlfs_u.u_64.dlfs_sboffs[n];
1247 } else {
1248 return fs->lfs_dlfs_u.u_32.dlfs_sboffs[n];
1251 static __unused inline void
1252 lfs_sb_setsboff(STRUCT_LFS *fs, unsigned n, int32_t val)
1254 #ifdef KASSERT /* ugh */
1255 KASSERT(n < LFS_MAXNUMSB);
1256 #endif
1257 if (fs->lfs_is64) {
1258 fs->lfs_dlfs_u.u_64.dlfs_sboffs[n] = val;
1259 } else {
1260 fs->lfs_dlfs_u.u_32.dlfs_sboffs[n] = val;
1265 * lfs_fsmnt is a string
1267 static __unused inline const char *
1268 lfs_sb_getfsmnt(STRUCT_LFS *fs)
1270 if (fs->lfs_is64) {
1271 return fs->lfs_dlfs_u.u_64.dlfs_fsmnt;
1272 } else {
1273 return fs->lfs_dlfs_u.u_32.dlfs_fsmnt;
1277 static __unused inline void
1278 lfs_sb_setfsmnt(STRUCT_LFS *fs, const char *str)
1280 if (fs->lfs_is64) {
1281 (void)strncpy(fs->lfs_dlfs_u.u_64.dlfs_fsmnt, str,
1282 sizeof(fs->lfs_dlfs_u.u_64.dlfs_fsmnt));
1283 } else {
1284 (void)strncpy(fs->lfs_dlfs_u.u_32.dlfs_fsmnt, str,
1285 sizeof(fs->lfs_dlfs_u.u_32.dlfs_fsmnt));
1289 /* Highest addressable fsb */
1290 #define LFS_MAX_DADDR(fs) \
1291 ((fs)->lfs_is64 ? 0x7fffffffffffffff : 0x7fffffff)
1293 /* LFS_NINDIR is the number of indirects in a file system block. */
1294 #define LFS_NINDIR(fs) (lfs_sb_getnindir(fs))
1296 /* LFS_INOPB is the number of inodes in a secondary storage block. */
1297 #define LFS_INOPB(fs) (lfs_sb_getinopb(fs))
1298 /* LFS_INOPF is the number of inodes in a fragment. */
1299 #define LFS_INOPF(fs) (lfs_sb_getinopf(fs))
1301 #define lfs_blkoff(fs, loc) ((int)((loc) & lfs_sb_getbmask(fs)))
1302 #define lfs_fragoff(fs, loc) /* calculates (loc % fs->lfs_fsize) */ \
1303 ((int)((loc) & lfs_sb_getffmask(fs)))
1305 /* XXX: lowercase these as they're no longer macros */
1306 /* Frags to diskblocks */
1307 static __unused inline uint64_t
1308 LFS_FSBTODB(STRUCT_LFS *fs, uint64_t b)
1310 #if defined(_KERNEL)
1311 return b << (lfs_sb_getffshift(fs) - DEV_BSHIFT);
1312 #else
1313 return b << lfs_sb_getfsbtodb(fs);
1314 #endif
1316 /* Diskblocks to frags */
1317 static __unused inline uint64_t
1318 LFS_DBTOFSB(STRUCT_LFS *fs, uint64_t b)
1320 #if defined(_KERNEL)
1321 return b >> (lfs_sb_getffshift(fs) - DEV_BSHIFT);
1322 #else
1323 return b >> lfs_sb_getfsbtodb(fs);
1324 #endif
1327 #define lfs_lblkno(fs, loc) ((loc) >> lfs_sb_getbshift(fs))
1328 #define lfs_lblktosize(fs, blk) ((blk) << lfs_sb_getbshift(fs))
1330 /* Frags to bytes */
1331 static __unused inline uint64_t
1332 lfs_fsbtob(STRUCT_LFS *fs, uint64_t b)
1334 return b << lfs_sb_getffshift(fs);
1336 /* Bytes to frags */
1337 static __unused inline uint64_t
1338 lfs_btofsb(STRUCT_LFS *fs, uint64_t b)
1340 return b >> lfs_sb_getffshift(fs);
1343 #define lfs_numfrags(fs, loc) /* calculates (loc / fs->lfs_fsize) */ \
1344 ((loc) >> lfs_sb_getffshift(fs))
1345 #define lfs_blkroundup(fs, size)/* calculates roundup(size, lfs_sb_getbsize(fs)) */ \
1346 ((off_t)(((size) + lfs_sb_getbmask(fs)) & (~lfs_sb_getbmask(fs))))
1347 #define lfs_fragroundup(fs, size)/* calculates roundup(size, fs->lfs_fsize) */ \
1348 ((off_t)(((size) + lfs_sb_getffmask(fs)) & (~lfs_sb_getffmask(fs))))
1349 #define lfs_fragstoblks(fs, frags)/* calculates (frags / fs->fs_frag) */ \
1350 ((frags) >> lfs_sb_getfbshift(fs))
1351 #define lfs_blkstofrags(fs, blks)/* calculates (blks * fs->fs_frag) */ \
1352 ((blks) << lfs_sb_getfbshift(fs))
1353 #define lfs_fragnum(fs, fsb) /* calculates (fsb % fs->lfs_frag) */ \
1354 ((fsb) & ((fs)->lfs_frag - 1))
1355 #define lfs_blknum(fs, fsb) /* calculates rounddown(fsb, fs->lfs_frag) */ \
1356 ((fsb) &~ ((fs)->lfs_frag - 1))
1357 #define lfs_dblksize(fs, dp, lbn) \
1358 (((lbn) >= ULFS_NDADDR || lfs_dino_getsize(fs, dp) >= ((lbn) + 1) << lfs_sb_getbshift(fs)) \
1359 ? lfs_sb_getbsize(fs) \
1360 : (lfs_fragroundup(fs, lfs_blkoff(fs, lfs_dino_getsize(fs, dp)))))
1362 #define lfs_segsize(fs) (lfs_sb_getversion(fs) == 1 ? \
1363 lfs_lblktosize((fs), lfs_sb_getssize(fs)) : \
1364 lfs_sb_getssize(fs))
1365 /* XXX segtod produces a result in frags despite the 'd' */
1366 #define lfs_segtod(fs, seg) (lfs_btofsb(fs, lfs_segsize(fs)) * (seg))
1367 #define lfs_dtosn(fs, daddr) /* block address to segment number */ \
1368 ((uint32_t)(((daddr) - lfs_sb_gets0addr(fs)) / lfs_segtod((fs), 1)))
1369 #define lfs_sntod(fs, sn) /* segment number to disk address */ \
1370 ((daddr_t)(lfs_segtod((fs), (sn)) + lfs_sb_gets0addr(fs)))
1372 /* XXX, blah. make this appear only if struct inode is defined */
1373 #ifdef _UFS_LFS_LFS_INODE_H_
1374 static __unused inline uint32_t
1375 lfs_blksize(STRUCT_LFS *fs, struct inode *ip, uint64_t lbn)
1377 if (lbn >= ULFS_NDADDR || lfs_dino_getsize(fs, ip->i_din) >= (lbn + 1) << lfs_sb_getbshift(fs)) {
1378 return lfs_sb_getbsize(fs);
1379 } else {
1380 return lfs_fragroundup(fs, lfs_blkoff(fs, lfs_dino_getsize(fs, ip->i_din)));
1383 #endif
1386 * union lfs_blocks
1389 static __unused inline void
1390 lfs_blocks_fromvoid(STRUCT_LFS *fs, union lfs_blocks *bp, void *p)
1392 if (fs->lfs_is64) {
1393 bp->b64 = p;
1394 } else {
1395 bp->b32 = p;
1399 static __unused inline void
1400 lfs_blocks_fromfinfo(STRUCT_LFS *fs, union lfs_blocks *bp, FINFO *fip)
1402 void *firstblock;
1404 firstblock = (char *)fip + FINFOSIZE(fs);
1405 if (fs->lfs_is64) {
1406 bp->b64 = (int64_t *)firstblock;
1407 } else {
1408 bp->b32 = (int32_t *)firstblock;
1412 static __unused inline daddr_t
1413 lfs_blocks_get(STRUCT_LFS *fs, union lfs_blocks *bp, unsigned index)
1415 if (fs->lfs_is64) {
1416 return bp->b64[index];
1417 } else {
1418 return bp->b32[index];
1422 static __unused inline void
1423 lfs_blocks_set(STRUCT_LFS *fs, union lfs_blocks *bp, unsigned index, daddr_t val)
1425 if (fs->lfs_is64) {
1426 bp->b64[index] = val;
1427 } else {
1428 bp->b32[index] = val;
1432 static __unused inline void
1433 lfs_blocks_inc(STRUCT_LFS *fs, union lfs_blocks *bp)
1435 if (fs->lfs_is64) {
1436 bp->b64++;
1437 } else {
1438 bp->b32++;
1442 static __unused inline int
1443 lfs_blocks_eq(STRUCT_LFS *fs, union lfs_blocks *bp1, union lfs_blocks *bp2)
1445 if (fs->lfs_is64) {
1446 return bp1->b64 == bp2->b64;
1447 } else {
1448 return bp1->b32 == bp2->b32;
1452 static __unused inline int
1453 lfs_blocks_sub(STRUCT_LFS *fs, union lfs_blocks *bp1, union lfs_blocks *bp2)
1455 /* (remember that the pointers are typed) */
1456 if (fs->lfs_is64) {
1457 return bp1->b64 - bp2->b64;
1458 } else {
1459 return bp1->b32 - bp2->b32;
1464 * struct segment
1469 * Macros for determining free space on the disk, with the variable metadata
1470 * of segment summaries and inode blocks taken into account.
1473 * Estimate number of clean blocks not available for writing because
1474 * they will contain metadata or overhead. This is calculated as
1476 * E = ((C * M / D) * D + (0) * (T - D)) / T
1477 * or more simply
1478 * E = (C * M) / T
1480 * where
1481 * C is the clean space,
1482 * D is the dirty space,
1483 * M is the dirty metadata, and
1484 * T = C + D is the total space on disk.
1486 * This approximates the old formula of E = C * M / D when D is close to T,
1487 * but avoids falsely reporting "disk full" when the sample size (D) is small.
1489 #define LFS_EST_CMETA(F) (( \
1490 (lfs_sb_getdmeta(F) * (int64_t)lfs_sb_getnclean(F)) / \
1491 (lfs_sb_getnseg(F))))
1493 /* Estimate total size of the disk not including metadata */
1494 #define LFS_EST_NONMETA(F) (lfs_sb_getdsize(F) - lfs_sb_getdmeta(F) - LFS_EST_CMETA(F))
1496 /* Estimate number of blocks actually available for writing */
1497 #define LFS_EST_BFREE(F) (lfs_sb_getbfree(F) > LFS_EST_CMETA(F) ? \
1498 lfs_sb_getbfree(F) - LFS_EST_CMETA(F) : 0)
1500 /* Amount of non-meta space not available to mortal man */
1501 #define LFS_EST_RSVD(F) ((LFS_EST_NONMETA(F) * \
1502 (u_int64_t)lfs_sb_getminfree(F)) / \
1503 100)
1505 /* Can credential C write BB blocks? XXX: kauth_cred_geteuid is abusive */
1506 #define ISSPACE(F, BB, C) \
1507 ((((C) == NOCRED || kauth_cred_geteuid(C) == 0) && \
1508 LFS_EST_BFREE(F) >= (BB)) || \
1509 (kauth_cred_geteuid(C) != 0 && IS_FREESPACE(F, BB)))
1511 /* Can an ordinary user write BB blocks */
1512 #define IS_FREESPACE(F, BB) \
1513 (LFS_EST_BFREE(F) >= (BB) + LFS_EST_RSVD(F))
1516 * The minimum number of blocks to create a new inode. This is:
1517 * directory direct block (1) + ULFS_NIADDR indirect blocks + inode block (1) +
1518 * ifile direct block (1) + ULFS_NIADDR indirect blocks = 3 + 2 * ULFS_NIADDR blocks.
1520 #define LFS_NRESERVE(F) (lfs_btofsb((F), (2 * ULFS_NIADDR + 3) << lfs_sb_getbshift(F)))
1524 #endif /* _UFS_LFS_LFS_ACCESSORS_H_ */