inode.h revision 12117
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.4 (Berkeley) 1/21/94
39 * $Id: inode.h,v 1.6 1995/05/30 08:15:30 rgrimes 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 * Theoretically, directories can be more than 2Gb in length, however, in
49 * practice this seems unlikely. So, we define the type doff_t as a long
50 * to keep down the cost of doing lookup on a 32-bit machine. If you are
51 * porting to a 64-bit architecture, you should make doff_t the same as off_t.
52 */
53#define	doff_t	long
54
55/*
56 * The inode is used to describe each active (or recently active)
57 * file in the UFS filesystem. It is composed of two types of
58 * information. The first part is the information that is needed
59 * only while the file is active (such as the identity of the file
60 * and linkage to speed its lookup). The second part is the
61 * permannent meta-data associated with the file which is read
62 * in from the permanent dinode from long term storage when the
63 * file becomes active, and is put back when the file is no longer
64 * being used.
65 */
66struct inode {
67	struct	inode *i_next;	/* Hash chain forward. */
68	struct	inode **i_prev;	/* Hash chain back. */
69	struct	vnode *i_vnode;	/* Vnode associated with this inode. */
70	struct	vnode *i_devvp;	/* Vnode for block I/O. */
71	u_long	i_flag;		/* I* flags. */
72	dev_t	i_dev;		/* Device associated with the inode. */
73	ino_t	i_number;	/* The identity of the inode. */
74	union {			/* Associated filesystem. */
75		struct	fs *fs;		/* FFS */
76		struct	lfs *lfs;	/* LFS */
77		struct	ext2_sb_info *e2fs;	/* EXT2FS */
78	} inode_u;
79#define	i_fs	inode_u.fs
80#define	i_lfs	inode_u.lfs
81#define	i_e2fs	inode_u.e2fs
82	struct	dquot *i_dquot[MAXQUOTAS];	/* Dquot structures. */
83	u_quad_t i_modrev;	/* Revision level for lease. */
84	struct	lockf *i_lockf;	/* Head of byte-level lock list. */
85	pid_t	i_lockholder;	/* DEBUG: holder of inode lock. */
86	pid_t	i_lockwaiter;	/* DEBUG: latest blocked for inode lock. */
87	/*
88	 * Side effects; used during directory lookup.
89	 */
90	long	i_count;	/* Size of free slot in directory. */
91	doff_t	i_endoff;	/* End of useful stuff in directory. */
92	doff_t	i_diroff;	/* Offset in dir, where we found last entry. */
93	doff_t	i_offset;	/* Offset of free space in directory. */
94	ino_t	i_ino;		/* Inode number of found directory. */
95	u_long	i_reclen;	/* Size of found directory entry. */
96	int	i_lockcount;	/* Process lock count (recursion) */
97	long	i_spare[10];	/* Spares to round up to 128 bytes. */
98	/*
99	 * The on-disk dinode itself.
100	 */
101	struct	dinode i_din;	/* 128 bytes of the on-disk dinode. */
102};
103
104#define	i_atime		i_din.di_atime
105#define	i_blocks	i_din.di_blocks
106#define	i_ctime		i_din.di_ctime
107#define	i_db		i_din.di_db
108#define	i_flags		i_din.di_flags
109#define	i_gen		i_din.di_gen
110#define	i_gid		i_din.di_gid
111#define	i_ib		i_din.di_ib
112#define	i_mode		i_din.di_mode
113#define	i_mtime		i_din.di_mtime
114#define	i_nlink		i_din.di_nlink
115#define	i_rdev		i_din.di_rdev
116#define	i_shortlink	i_din.di_shortlink
117#define	i_size		i_din.di_size
118#define	i_uid		i_din.di_uid
119
120/* These flags are kept in i_flag. */
121#define	IN_ACCESS	0x0001		/* Access time update request. */
122#define	IN_CHANGE	0x0002		/* Inode change time update request. */
123#define	IN_EXLOCK	0x0004		/* File has exclusive lock. */
124#define	IN_LOCKED	0x0008		/* Inode lock. */
125#define	IN_LWAIT	0x0010		/* Process waiting on file lock. */
126#define	IN_MODIFIED	0x0020		/* Inode has been modified. */
127#define	IN_RENAME	0x0040		/* Inode is being renamed. */
128#define	IN_SHLOCK	0x0080		/* File has shared lock. */
129#define	IN_UPDATE	0x0100		/* Modification time update request. */
130#define	IN_WANTED	0x0200		/* Inode is wanted by a process. */
131#define	IN_RECURSE	0x0400		/* Recursion expected */
132
133#ifdef KERNEL
134/*
135 * Structure used to pass around logical block paths generated by
136 * ufs_getlbns and used by truncate and bmap code.
137 */
138struct indir {
139	daddr_t	in_lbn;			/* Logical block number. */
140	int	in_off;			/* Offset in buffer. */
141	int	in_exists;		/* Flag if the block exists. */
142};
143
144/* Convert between inode pointers and vnode pointers. */
145#define VTOI(vp)	((struct inode *)(vp)->v_data)
146#define ITOV(ip)	((ip)->i_vnode)
147
148/*
149 * XXX this is too long to be a macro, and isn't used in any time-critical
150 * place; in fact it is only used in ufs_vnops.c so it shouldn't be in a
151 * header file.
152 */
153#define	ITIMES(ip, t1, t2) {						\
154	long tv_sec = time.tv_sec;					\
155	if ((ip)->i_flag & (IN_ACCESS | IN_CHANGE | IN_UPDATE)) {	\
156		(ip)->i_flag |= IN_MODIFIED;				\
157		if ((ip)->i_flag & IN_ACCESS)				\
158			(ip)->i_atime.ts_sec				\
159			= ((t1) == &time ? tv_sec : (t1)->tv_sec);	\
160		if ((ip)->i_flag & IN_UPDATE) {				\
161			(ip)->i_mtime.ts_sec				\
162			= ((t2) == &time ? tv_sec : (t2)->tv_sec);	\
163			(ip)->i_modrev++;				\
164		}							\
165		if ((ip)->i_flag & IN_CHANGE)				\
166			(ip)->i_ctime.ts_sec = tv_sec;			\
167		(ip)->i_flag &= ~(IN_ACCESS | IN_CHANGE | IN_UPDATE);	\
168	}								\
169}
170
171/* This overlays the fid structure (see mount.h). */
172struct ufid {
173	u_short	ufid_len;	/* Length of structure. */
174	u_short	ufid_pad;	/* Force long alignment. */
175	ino_t	ufid_ino;	/* File number (ino). */
176	long	ufid_gen;	/* Generation number. */
177};
178#endif /* KERNEL */
179
180#endif /* !_UFS_UFS_INODE_H_ */
181