1/* $NetBSD: lfs_inode.h,v 1.26 2022/03/23 13:06:06 andvar Exp $ */
2/* from NetBSD: ulfs_inode.h,v 1.5 2013/06/06 00:51:50 dholland Exp */
3/* from NetBSD: inode.h,v 1.72 2016/06/03 15:36:03 christos Exp */
4
5/*
6 * Copyright (c) 1982, 1989, 1993
7 * The Regents of the University of California. All rights reserved.
8 * (c) UNIX System Laboratories, Inc.
9 * All or some portions of this file are derived from material licensed
10 * to the University of California by American Telephone and Telegraph
11 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
12 * the permission of UNIX System Laboratories, Inc.
13 *
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.
22 * 3. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * SUCH DAMAGE.
37 *
38 * @(#)inode.h 8.9 (Berkeley) 5/14/95
39 */
40
41#ifndef _UFS_LFS_LFS_INODE_H_
42#define _UFS_LFS_LFS_INODE_H_
43
44/*
45 * Some of the userlevel code (fsck, newfs, lfs_cleanerd) wants to use
46 * the in-memory inode structure in a faked-up kernel environment.
47 * This header file provides a reasonably sanitized version of the
48 * structures and definitions needed for that purpose.
49 */
50
51#include <miscfs/genfs/genfs_node.h>
52#include <ufs/lfs/lfs.h>
53
54/*
55 * Adjustable filesystem parameters
56 */
57#define MIN_FREE_SEGS 20
58#define MIN_RESV_SEGS 15
59
60/*
61 * The following constants define the usage of the quota file array in the
62 * ulfsmount structure and dquot array in the inode structure. The semantics
63 * of the elements of these arrays are defined in the routine lfs_getinoquota;
64 * the remainder of the quota code treats them generically and need not be
65 * inspected when changing the size of the array.
66 */
67#define ULFS_MAXQUOTAS 2
68#define ULFS_USRQUOTA 0 /* element used for user quotas */
69#define ULFS_GRPQUOTA 1 /* element used for group quotas */
70
71/*
72 * Lookup result state (other than the result inode). This is
73 * currently stashed in the vnode between VOP_LOOKUP and directory
74 * operation VOPs, which is gross.
75 *
76 * XXX ulr_diroff is a lookup hint from the previous call of VOP_LOOKUP.
77 * probably it should not be here.
78 */
79struct ulfs_lookup_results {
80 int32_t ulr_count; /* Size of free slot in directory. */
81 doff_t ulr_endoff; /* End of useful stuff in directory. */
82 doff_t ulr_diroff; /* Offset in dir, where we found last entry. */
83 doff_t ulr_offset; /* Offset of free space in directory. */
84 uint32_t ulr_reclen; /* Size of found directory entry. */
85};
86
87/* notyet XXX */
88#define ULFS_CHECK_CRAPCOUNTER(dp) ((void)(dp)->i_crapcounter)
89
90/*
91 * Per-filesystem inode extensions.
92 */
93struct lfs_inode_ext;
94
95/*
96 * The inode is used to describe each active (or recently active) file in the
97 * ULFS filesystem. It is composed of two types of information. The first part
98 * is the information that is needed only while the file is active (such as
99 * the identity of the file and linkage to speed its lookup). The second part
100 * is the permanent meta-data associated with the file which is read in
101 * from the permanent dinode from long term storage when the file becomes
102 * active, and is put back when the file is no longer being used.
103 */
104struct inode {
105 struct genfs_node i_gnode;
106 TAILQ_ENTRY(inode) i_nextsnap; /* snapshot file list. */
107 struct vnode *i_vnode; /* Vnode associated with this inode. */
108 struct ulfsmount *i_ump; /* Mount point associated with this inode. */
109 struct vnode *i_devvp; /* Vnode for block I/O. */
110
111 uint32_t i_state; /* state */
112#define IN_ACCESS 0x0001 /* Access time update request. */
113#define IN_CHANGE 0x0002 /* Inode change time update request. */
114#define IN_UPDATE 0x0004 /* Inode was written to; update mtime. */
115#define IN_MODIFY 0x2000 /* Modification time update request. */
116#define IN_MODIFIED 0x0008 /* Inode has been modified. */
117#define IN_ACCESSED 0x0010 /* Inode has been accessed. */
118/* unused 0x0020 */ /* was IN_RENAME */
119#define IN_SHLOCK 0x0040 /* File has shared lock. */
120#define IN_EXLOCK 0x0080 /* File has exclusive lock. */
121#define IN_CLEANING 0x0100 /* LFS: file is being cleaned */
122#define IN_ADIROP 0x0200 /* LFS: dirop in progress */
123/* unused 0x0400 */ /* was FFS-only IN_SPACECOUNTED */
124#define IN_PAGING 0x1000 /* LFS: file is on paging queue */
125#define IN_CDIROP 0x4000 /* LFS: dirop completed pending i/o */
126#define IN_MARKER 0x00010000 /* LFS: marker inode for iteration */
127
128/* XXX this is missing some of the flags */
129#define IN_ALLMOD (IN_MODIFIED|IN_ACCESS|IN_CHANGE|IN_UPDATE|IN_MODIFY|IN_ACCESSED|IN_CLEANING)
130
131 dev_t i_dev; /* Device associated with the inode. */
132 ino_t i_number; /* The identity of the inode. */
133
134 struct lfs *i_lfs; /* The LFS volume we belong to. */
135
136 void *i_unused1; /* Unused. */
137 struct dquot *i_dquot[ULFS_MAXQUOTAS]; /* Dquot structures. */
138 u_quad_t i_modrev; /* Revision level for NFS lease. */
139 struct lockf *i_lockf;/* Head of byte-level lock list. */
140
141 /*
142 * Side effects; used during (and after) directory lookup.
143 * XXX should not be here.
144 */
145 struct ulfs_lookup_results i_crap;
146 unsigned i_crapcounter; /* serial number for i_crap */
147
148 /*
149 * Inode extensions
150 */
151 union {
152 /* Other extensions could go here... */
153 struct lfs_inode_ext *lfs;
154 } inode_ext;
155 /*
156 * Copies from the on-disk dinode itself.
157 *
158 * These fields are currently only used by LFS.
159 */
160 uint16_t i_mode; /* IFMT, permissions; see below. */
161 int16_t i_nlink; /* File link count. */
162 uint64_t i_size; /* File byte count. */
163 uint32_t i_flags; /* Status flags (chflags). */
164 int32_t i_gen; /* Generation number. */
165 uint32_t i_uid; /* File owner. */
166 uint32_t i_gid; /* File group. */
167 uint16_t i_omode; /* Old mode, for ulfs_reclaim. */
168
169 struct dirhash *i_dirhash; /* Hashing for large directories */
170
171 /*
172 * The on-disk dinode itself.
173 */
174 union lfs_dinode *i_din;
175};
176
177/*
178 * LFS inode extensions.
179 */
180struct lfs_inode_ext {
181 off_t lfs_osize; /* size of file on disk */
182 uint64_t lfs_effnblocks; /* number of blocks when i/o completes */
183 size_t lfs_fragsize[ULFS_NDADDR]; /* size of on-disk direct blocks */
184 TAILQ_ENTRY(inode) lfs_dchain; /* Dirop chain. */
185 TAILQ_ENTRY(inode) lfs_pchain; /* Paging chain. */
186#define LFSI_NO_GOP_WRITE 0x01
187#define LFSI_DELETED 0x02
188#define LFSI_WRAPBLOCK 0x04
189#define LFSI_WRAPWAIT 0x08
190#define LFSI_BMAP 0x10
191 uint32_t lfs_iflags; /* Inode flags */
192 daddr_t lfs_hiblk; /* Highest lbn held by inode */
193#ifdef _KERNEL
194 SPLAY_HEAD(lfs_splay, lbnentry) lfs_lbtree; /* Tree of balloc'd lbns */
195 int lfs_nbtree; /* Size of tree */
196 LIST_HEAD(, segdelta) lfs_segdhd;
197#endif
198 int16_t lfs_odnlink; /* on-disk nlink count for cleaner */
199};
200#define i_lfs_osize inode_ext.lfs->lfs_osize
201#define i_lfs_effnblks inode_ext.lfs->lfs_effnblocks
202#define i_lfs_fragsize inode_ext.lfs->lfs_fragsize
203#define i_lfs_dchain inode_ext.lfs->lfs_dchain
204#define i_lfs_pchain inode_ext.lfs->lfs_pchain
205#define i_lfs_iflags inode_ext.lfs->lfs_iflags
206#define i_lfs_hiblk inode_ext.lfs->lfs_hiblk
207#define i_lfs_lbtree inode_ext.lfs->lfs_lbtree
208#define i_lfs_nbtree inode_ext.lfs->lfs_nbtree
209#define i_lfs_segdhd inode_ext.lfs->lfs_segdhd
210#define i_lfs_odnlink inode_ext.lfs->lfs_odnlink
211
212/*
213 * "struct buf" associated definitions
214 */
215
216#ifdef _KERNEL
217
218# define LFS_IS_MALLOC_BUF(bp) ((bp)->b_iodone == lfs_free_aiodone)
219
220/* log for debugging writes to the Ifile */
221# ifdef DEBUG
222struct lfs_log_entry {
223 const char *op;
224 const char *file;
225 int pid;
226 int line;
227 daddr_t block;
228 unsigned long flags;
229};
230extern int lfs_lognum;
231extern struct lfs_log_entry lfs_log[LFS_LOGLENGTH];
232# define LFS_BWRITE_LOG(bp) lfs_bwrite_log((bp), __FILE__, __LINE__)
233# define LFS_ENTER_LOG(theop, thefile, theline, lbn, theflags, thepid) do {\
234 \
235 mutex_enter(&lfs_lock); \
236 lfs_log[lfs_lognum].op = theop; \
237 lfs_log[lfs_lognum].file = thefile; \
238 lfs_log[lfs_lognum].line = (theline); \
239 lfs_log[lfs_lognum].pid = (thepid); \
240 lfs_log[lfs_lognum].block = (lbn); \
241 lfs_log[lfs_lognum].flags = (theflags); \
242 lfs_lognum = (lfs_lognum + 1) % LFS_LOGLENGTH; \
243 mutex_exit(&lfs_lock); \
244} while (0)
245
246/* Must match list in lfs_vfsops.c ! */
247# define DLOG_RF 0 /* roll forward */
248# define DLOG_ALLOC 1 /* inode alloc */
249# define DLOG_AVAIL 2 /* lfs_{,r,f}avail */
250# define DLOG_FLUSH 3 /* flush */
251# define DLOG_LLIST 4 /* locked list accounting */
252# define DLOG_WVNODE 5 /* vflush/writevnodes verbose */
253# define DLOG_VNODE 6 /* vflush/writevnodes */
254# define DLOG_SEG 7 /* segwrite */
255# define DLOG_SU 8 /* seguse accounting */
256# define DLOG_CLEAN 9 /* cleaner routines */
257# define DLOG_MOUNT 10 /* mount/unmount */
258# define DLOG_PAGE 11 /* putpages/gop_write */
259# define DLOG_DIROP 12 /* dirop accounting */
260# define DLOG_MALLOC 13 /* lfs_malloc accounting */
261# define DLOG_MAX 14 /* The terminator */
262# define DLOG(a) lfs_debug_log a
263# else /* ! DEBUG */
264# define LFS_BCLEAN_LOG(fs, bp)
265# define LFS_BWRITE_LOG(bp) VOP_BWRITE((bp)->b_vp, (bp))
266# define LFS_ENTER_LOG(theop, thefile, theline, lbn, theflags, thepid) __nothing
267# define DLOG(a)
268# endif /* ! DEBUG */
269#else /* ! _KERNEL */
270# define LFS_BWRITE_LOG(bp) VOP_BWRITE((bp))
271#endif /* _KERNEL */
272
273
274#endif /* _UFS_LFS_LFS_INODE_H_ */