xref: /netbsd-src/sys/ufs/lfs/lfs_inode.h (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1 /*	$NetBSD: lfs_inode.h,v 1.7 2014/05/26 19:12:43 ryoon 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.64 2012/11/19 00:36:21 jakllsch 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 previos call of VOP_LOOKUP.
77  * probably it should not be here.
78  */
79 struct 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 	u_int32_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  */
93 struct 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  */
104 struct inode {
105 	struct genfs_node i_gnode;
106 	LIST_ENTRY(inode) i_hash;/* Hash chain. */
107 	TAILQ_ENTRY(inode) i_nextsnap; /* snapshot file list. */
108 	struct	vnode *i_vnode;	/* Vnode associated with this inode. */
109 	struct  ulfsmount *i_ump; /* Mount point associated with this inode. */
110 	struct	vnode *i_devvp;	/* Vnode for block I/O. */
111 	u_int32_t i_flag;	/* flags, see below */
112 	dev_t	  i_dev;	/* Device associated with the inode. */
113 	ino_t	  i_number;	/* The identity of the inode. */
114 
115 	struct lfs *i_lfs;	/* The LFS volume we belong to. */
116 
117 	void	*i_unused1;	/* Unused. */
118 	struct	 dquot *i_dquot[ULFS_MAXQUOTAS]; /* Dquot structures. */
119 	u_quad_t i_modrev;	/* Revision level for NFS lease. */
120 	struct	 lockf *i_lockf;/* Head of byte-level lock list. */
121 
122 	/*
123 	 * Side effects; used during (and after) directory lookup.
124 	 * XXX should not be here.
125 	 */
126 	struct ulfs_lookup_results i_crap;
127 	unsigned i_crapcounter;	/* serial number for i_crap */
128 
129 	/*
130 	 * Inode extensions
131 	 */
132 	union {
133 		/* Other extensions could go here... */
134 		struct  lfs_inode_ext *lfs;
135 	} inode_ext;
136 	/*
137 	 * Copies from the on-disk dinode itself.
138 	 *
139 	 * These fields are currently only used by LFS.
140 	 */
141 	u_int16_t i_mode;	/* IFMT, permissions; see below. */
142 	int16_t   i_nlink;	/* File link count. */
143 	u_int64_t i_size;	/* File byte count. */
144 	u_int32_t i_flags;	/* Status flags (chflags). */
145 	int32_t   i_gen;	/* Generation number. */
146 	u_int32_t i_uid;	/* File owner. */
147 	u_int32_t i_gid;	/* File group. */
148 	u_int16_t i_omode;	/* Old mode, for ulfs_reclaim. */
149 
150 	struct dirhash *i_dirhash;	/* Hashing for large directories */
151 
152 	/*
153 	 * The on-disk dinode itself.
154 	 */
155 	union {
156 		struct	ulfs1_dinode *ffs1_din;	/* 128 bytes of the on-disk dinode. */
157 		struct	ulfs2_dinode *ffs2_din;
158 	} i_din;
159 };
160 
161 #define	i_ffs1_atime		i_din.ffs1_din->di_atime
162 #define	i_ffs1_atimensec	i_din.ffs1_din->di_atimensec
163 #define	i_ffs1_blocks		i_din.ffs1_din->di_blocks
164 #define	i_ffs1_ctime		i_din.ffs1_din->di_ctime
165 #define	i_ffs1_ctimensec	i_din.ffs1_din->di_ctimensec
166 #define	i_ffs1_db		i_din.ffs1_din->di_db
167 #define	i_ffs1_flags		i_din.ffs1_din->di_flags
168 #define	i_ffs1_gen		i_din.ffs1_din->di_gen
169 #define	i_ffs1_gid		i_din.ffs1_din->di_gid
170 #define	i_ffs1_ib		i_din.ffs1_din->di_ib
171 #define	i_ffs1_mode		i_din.ffs1_din->di_mode
172 #define	i_ffs1_mtime		i_din.ffs1_din->di_mtime
173 #define	i_ffs1_mtimensec	i_din.ffs1_din->di_mtimensec
174 #define	i_ffs1_nlink		i_din.ffs1_din->di_nlink
175 #define	i_ffs1_rdev		i_din.ffs1_din->di_rdev
176 #define	i_ffs1_size		i_din.ffs1_din->di_size
177 #define	i_ffs1_uid		i_din.ffs1_din->di_uid
178 
179 #define	i_ffs2_atime		i_din.ffs2_din->di_atime
180 #define	i_ffs2_atimensec	i_din.ffs2_din->di_atimensec
181 #define	i_ffs2_birthtime	i_din.ffs2_din->di_birthtime
182 #define	i_ffs2_birthnsec	i_din.ffs2_din->di_birthnsec
183 #define	i_ffs2_blocks		i_din.ffs2_din->di_blocks
184 #define	i_ffs2_blksize		i_din.ffs2_din->di_blksize
185 #define	i_ffs2_ctime		i_din.ffs2_din->di_ctime
186 #define	i_ffs2_ctimensec	i_din.ffs2_din->di_ctimensec
187 #define	i_ffs2_db		i_din.ffs2_din->di_db
188 #define	i_ffs2_flags		i_din.ffs2_din->di_flags
189 #define	i_ffs2_gen		i_din.ffs2_din->di_gen
190 #define	i_ffs2_gid		i_din.ffs2_din->di_gid
191 #define	i_ffs2_ib		i_din.ffs2_din->di_ib
192 #define	i_ffs2_mode		i_din.ffs2_din->di_mode
193 #define	i_ffs2_mtime		i_din.ffs2_din->di_mtime
194 #define	i_ffs2_mtimensec	i_din.ffs2_din->di_mtimensec
195 #define	i_ffs2_nlink		i_din.ffs2_din->di_nlink
196 #define	i_ffs2_rdev		i_din.ffs2_din->di_rdev
197 #define	i_ffs2_size		i_din.ffs2_din->di_size
198 #define	i_ffs2_uid		i_din.ffs2_din->di_uid
199 #define	i_ffs2_kernflags	i_din.ffs2_din->di_kernflags
200 #define	i_ffs2_extsize		i_din.ffs2_din->di_extsize
201 #define	i_ffs2_extb		i_din.ffs2_din->di_extb
202 
203 /* These flags are kept in i_flag. */
204 #define	IN_ACCESS	0x0001		/* Access time update request. */
205 #define	IN_CHANGE	0x0002		/* Inode change time update request. */
206 #define	IN_UPDATE	0x0004		/* Inode was written to; update mtime. */
207 #define	IN_MODIFY	0x2000		/* Modification time update request. */
208 #define	IN_MODIFIED	0x0008		/* Inode has been modified. */
209 #define	IN_ACCESSED	0x0010		/* Inode has been accessed. */
210 /* 	   unused	0x0020 */	/* was IN_RENAME */
211 #define	IN_SHLOCK	0x0040		/* File has shared lock. */
212 #define	IN_EXLOCK	0x0080		/* File has exclusive lock. */
213 #define	IN_CLEANING	0x0100		/* LFS: file is being cleaned */
214 #define	IN_ADIROP	0x0200		/* LFS: dirop in progress */
215 /* 	   unused	0x0400 */	/* was FFS-only IN_SPACECOUNTED */
216 #define	IN_PAGING       0x1000		/* LFS: file is on paging queue */
217 #define IN_CDIROP       0x4000          /* LFS: dirop completed pending i/o */
218 
219 /*
220  * LFS inode extensions.
221  */
222 struct lfs_inode_ext {
223 	off_t	  lfs_osize;		/* size of file on disk */
224 	u_int32_t lfs_effnblocks;  /* number of blocks when i/o completes */
225 	size_t	  lfs_fragsize[ULFS_NDADDR]; /* size of on-disk direct blocks */
226 	TAILQ_ENTRY(inode) lfs_dchain;  /* Dirop chain. */
227 	TAILQ_ENTRY(inode) lfs_pchain;  /* Paging chain. */
228 #define LFSI_NO_GOP_WRITE 0x01
229 #define LFSI_DELETED      0x02
230 #define LFSI_WRAPBLOCK    0x04
231 #define LFSI_WRAPWAIT     0x08
232 #define LFSI_BMAP         0x10
233 	u_int32_t lfs_iflags;           /* Inode flags */
234 	daddr_t   lfs_hiblk;		/* Highest lbn held by inode */
235 #ifdef _KERNEL
236 	SPLAY_HEAD(lfs_splay, lbnentry) lfs_lbtree; /* Tree of balloc'd lbns */
237 	int	  lfs_nbtree;		/* Size of tree */
238 	LIST_HEAD(, segdelta) lfs_segdhd;
239 #endif
240 	int16_t	  lfs_odnlink;		/* on-disk nlink count for cleaner */
241 };
242 #define i_lfs_osize		inode_ext.lfs->lfs_osize
243 #define i_lfs_effnblks		inode_ext.lfs->lfs_effnblocks
244 #define i_lfs_fragsize		inode_ext.lfs->lfs_fragsize
245 #define i_lfs_dchain		inode_ext.lfs->lfs_dchain
246 #define i_lfs_pchain		inode_ext.lfs->lfs_pchain
247 #define i_lfs_iflags		inode_ext.lfs->lfs_iflags
248 #define i_lfs_hiblk		inode_ext.lfs->lfs_hiblk
249 #define i_lfs_lbtree		inode_ext.lfs->lfs_lbtree
250 #define i_lfs_nbtree		inode_ext.lfs->lfs_nbtree
251 #define i_lfs_segdhd		inode_ext.lfs->lfs_segdhd
252 #define i_lfs_odnlink		inode_ext.lfs->lfs_odnlink
253 
254 /*
255  * "struct buf" associated definitions
256  */
257 
258 #ifdef _KERNEL
259 
260 # define LFS_IS_MALLOC_BUF(bp) ((bp)->b_iodone == lfs_callback)
261 
262 # ifdef DEBUG
263 #  define LFS_DEBUG_COUNTLOCKED(m) do {					\
264 	if (lfs_debug_log_subsys[DLOG_LLIST]) {				\
265 		lfs_countlocked(&locked_queue_count, &locked_queue_bytes, (m)); \
266 		cv_broadcast(&locked_queue_cv);				\
267 	}								\
268 } while (0)
269 # else
270 #  define LFS_DEBUG_COUNTLOCKED(m)
271 # endif
272 
273 /* log for debugging writes to the Ifile */
274 # ifdef DEBUG
275 struct lfs_log_entry {
276 	const char *op;
277 	const char *file;
278 	int pid;
279 	int line;
280 	daddr_t block;
281 	unsigned long flags;
282 };
283 extern int lfs_lognum;
284 extern struct lfs_log_entry lfs_log[LFS_LOGLENGTH];
285 #  define LFS_BWRITE_LOG(bp) lfs_bwrite_log((bp), __FILE__, __LINE__)
286 #  define LFS_ENTER_LOG(theop, thefile, theline, lbn, theflags, thepid) do {\
287 	int _s;								\
288 									\
289 	mutex_enter(&lfs_lock);						\
290 	_s = splbio();							\
291 	lfs_log[lfs_lognum].op = theop;					\
292 	lfs_log[lfs_lognum].file = thefile;				\
293 	lfs_log[lfs_lognum].line = (theline);				\
294 	lfs_log[lfs_lognum].pid = (thepid);				\
295 	lfs_log[lfs_lognum].block = (lbn);				\
296 	lfs_log[lfs_lognum].flags = (theflags);				\
297 	lfs_lognum = (lfs_lognum + 1) % LFS_LOGLENGTH;			\
298 	splx(_s);							\
299 	mutex_exit(&lfs_lock);						\
300 } while (0)
301 
302 #  define LFS_BCLEAN_LOG(fs, bp) do {					\
303 	if ((bp)->b_vp == (fs)->lfs_ivnode)				\
304 		LFS_ENTER_LOG("clear", __FILE__, __LINE__,		\
305 			      bp->b_lblkno, bp->b_flags, curproc->p_pid);\
306 } while (0)
307 
308 /* Must match list in lfs_vfsops.c ! */
309 #  define DLOG_RF     0  /* roll forward */
310 #  define DLOG_ALLOC  1  /* inode alloc */
311 #  define DLOG_AVAIL  2  /* lfs_{,r,f}avail */
312 #  define DLOG_FLUSH  3  /* flush */
313 #  define DLOG_LLIST  4  /* locked list accounting */
314 #  define DLOG_WVNODE 5  /* vflush/writevnodes verbose */
315 #  define DLOG_VNODE  6  /* vflush/writevnodes */
316 #  define DLOG_SEG    7  /* segwrite */
317 #  define DLOG_SU     8  /* seguse accounting */
318 #  define DLOG_CLEAN  9  /* cleaner routines */
319 #  define DLOG_MOUNT  10 /* mount/unmount */
320 #  define DLOG_PAGE   11 /* putpages/gop_write */
321 #  define DLOG_DIROP  12 /* dirop accounting */
322 #  define DLOG_MALLOC 13 /* lfs_malloc accounting */
323 #  define DLOG_MAX    14 /* The terminator */
324 #  define DLOG(a) lfs_debug_log a
325 # else /* ! DEBUG */
326 #  define LFS_BCLEAN_LOG(fs, bp)
327 #  define LFS_BWRITE_LOG(bp)		VOP_BWRITE((bp)->b_vp, (bp))
328 #  define DLOG(a)
329 # endif /* ! DEBUG */
330 #else /* ! _KERNEL */
331 # define LFS_BWRITE_LOG(bp)		VOP_BWRITE((bp))
332 #endif /* _KERNEL */
333 
334 
335 #endif /* _UFS_LFS_LFS_INODE_H_ */
336