inode.h revision 27375
1/*
2 * Copyright (c) 1982, 1989, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 *    must display the following acknowledgement:
20 *	This product includes software developed by the University of
21 *	California, Berkeley and its contributors.
22 * 4. 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 * $Id: inode.h,v 1.15 1997/05/22 07:30:55 phk Exp $
40 */
41
42#ifndef _UFS_UFS_INODE_H_
43#define	_UFS_UFS_INODE_H_
44
45#include <ufs/ufs/dinode.h>
46
47/*
48 * This must agree with the definition in <ufs/ufs/dir.h>.
49 */
50#define	doff_t		int32_t
51
52/*
53 * The inode is used to describe each active (or recently active) file in the
54 * UFS filesystem. It is composed of two types of information. The first part
55 * is the information that is needed only while the file is active (such as
56 * the identity of the file and linkage to speed its lookup). The second part
57 * is the permanent meta-data associated with the file which is read in
58 * from the permanent dinode from long term storage when the file becomes
59 * active, and is put back when the file is no longer being used.
60 */
61struct inode {
62	LIST_ENTRY(inode) i_hash;/* Hash chain. */
63	struct	vnode  *i_vnode;/* Vnode associated with this inode. */
64	struct	vnode  *i_devvp;/* Vnode for block I/O. */
65	u_int32_t i_flag;	/* flags, see below */
66	dev_t	  i_dev;	/* Device associated with the inode. */
67	ino_t	  i_number;	/* The identity of the inode. */
68
69	union {			/* Associated filesystem. */
70		struct	fs *fs;		/* FFS */
71		struct	lfs *lfs;	/* LFS */
72		struct	ext2_sb_info *e2fs;	/* EXT2FS */
73	} inode_u;
74#define	i_fs	inode_u.fs
75#define	i_lfs	inode_u.lfs
76#define	i_e2fs	inode_u.e2fs
77	struct	 dquot *i_dquot[MAXQUOTAS]; /* Dquot structures. */
78	u_quad_t i_modrev;	/* Revision level for NFS lease. */
79	struct	 lockf *i_lockf;/* Head of byte-level lock list. */
80	struct	 lock i_lock;	/* Inode lock. */
81	/*
82	 * Side effects; used during directory lookup.
83	 */
84	int32_t	  i_count;	/* Size of free slot in directory. */
85	doff_t	  i_endoff;	/* End of useful stuff in directory. */
86	doff_t	  i_diroff;	/* Offset in dir, where we found last entry. */
87	doff_t	  i_offset;	/* Offset of free space in directory. */
88	ino_t	  i_ino;	/* Inode number of found directory. */
89	u_int32_t i_reclen;	/* Size of found directory entry. */
90	int	  i_spare[5];	/* XXX actually non-spare (for ext2fs). */
91	/*
92	 * The on-disk dinode itself.
93	 */
94	struct	dinode i_din;	/* 128 bytes of the on-disk dinode. */
95};
96
97#define	i_atime		i_din.di_atime
98#define	i_atimensec	i_din.di_atimensec
99#define	i_blocks	i_din.di_blocks
100#define	i_ctime		i_din.di_ctime
101#define	i_ctimensec	i_din.di_ctimensec
102#define	i_db		i_din.di_db
103#define	i_flags		i_din.di_flags
104#define	i_gen		i_din.di_gen
105#define	i_gid		i_din.di_gid
106#define	i_ib		i_din.di_ib
107#define	i_mode		i_din.di_mode
108#define	i_mtime		i_din.di_mtime
109#define	i_mtimensec	i_din.di_mtimensec
110#define	i_nlink		i_din.di_nlink
111#define	i_rdev		i_din.di_rdev
112#define	i_shortlink	i_din.di_shortlink
113#define	i_size		i_din.di_size
114#define	i_uid		i_din.di_uid
115
116/* These flags are kept in i_flag. */
117#define	IN_ACCESS	0x0001		/* Access time update request. */
118#define	IN_CHANGE	0x0002		/* Inode change time update request. */
119#define	IN_UPDATE	0x0004		/* Modification time update request. */
120#define	IN_MODIFIED	0x0008		/* Inode has been modified. */
121#define	IN_RENAME	0x0010		/* Inode is being renamed. */
122#define	IN_SHLOCK	0x0020		/* File has shared lock. */
123#define	IN_EXLOCK	0x0040		/* File has exclusive lock. */
124
125#ifdef KERNEL
126/*
127 * Structure used to pass around logical block paths generated by
128 * ufs_getlbns and used by truncate and bmap code.
129 */
130struct indir {
131	ufs_daddr_t in_lbn;		/* Logical block number. */
132	int	in_off;			/* Offset in buffer. */
133	int	in_exists;		/* Flag if the block exists. */
134};
135
136/* Convert between inode pointers and vnode pointers. */
137#define VTOI(vp)	((struct inode *)(vp)->v_data)
138#define ITOV(ip)	((ip)->i_vnode)
139
140/*
141 * XXX this is too long to be a macro, and isn't used in any time-critical
142 * place; in fact it is only used in ufs_vnops.c so it shouldn't be in a
143 * header file.
144 */
145#define	ITIMES(ip, t1, t2) {						\
146	long tv_sec = time.tv_sec;					\
147	if ((ip)->i_flag & (IN_ACCESS | IN_CHANGE | IN_UPDATE)) {	\
148		(ip)->i_flag |= IN_MODIFIED;				\
149		if ((ip)->i_flag & IN_ACCESS)				\
150			(ip)->i_atime					\
151			= ((t1) == &time ? tv_sec : (t1)->tv_sec);	\
152		if ((ip)->i_flag & IN_UPDATE) {				\
153			(ip)->i_mtime					\
154			= ((t2) == &time ? tv_sec : (t2)->tv_sec);	\
155			(ip)->i_modrev++;				\
156		}							\
157		if ((ip)->i_flag & IN_CHANGE)				\
158			(ip)->i_ctime = tv_sec;				\
159		(ip)->i_flag &= ~(IN_ACCESS | IN_CHANGE | IN_UPDATE);	\
160	}								\
161}
162
163/* This overlays the fid structure (see mount.h). */
164struct ufid {
165	u_int16_t ufid_len;	/* Length of structure. */
166	u_int16_t ufid_pad;	/* Force 32-bit alignment. */
167	ino_t	  ufid_ino;	/* File number (ino). */
168	int32_t	  ufid_gen;	/* Generation number. */
169};
170#endif /* KERNEL */
171
172#endif /* !_UFS_UFS_INODE_H_ */
173