inode.h revision 96596
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 * $FreeBSD: head/sys/gnu/fs/ext2fs/inode.h 96596 2002-05-14 17:14:01Z iedowse $
40 */
41
42#ifndef _SYS_GNU_EXT2FS_INODE_H_
43#define	_SYS_GNU_EXT2FS_INODE_H_
44
45#include <sys/lock.h>
46#include <sys/queue.h>
47
48#define	ROOTINO	((ino_t)2)
49
50#define	NDADDR	12			/* Direct addresses in inode. */
51#define	NIADDR	3			/* Indirect addresses in inode. */
52
53/*
54 * This must agree with the definition in <ufs/ufs/dir.h>.
55 */
56#define	doff_t		int32_t
57
58/*
59 * The inode is used to describe each active (or recently active) file in the
60 * EXT2FS filesystem. It is composed of two types of information. The first
61 * part is the information that is needed only while the file is active (such
62 * as the identity of the file and linkage to speed its lookup). The second
63 * part is the permanent meta-data associated with the file which is read in
64 * from the permanent dinode from long term storage when the file becomes
65 * active, and is put back when the file is no longer being used.
66 */
67struct inode {
68	LIST_ENTRY(inode) i_hash;/* Hash chain. */
69	struct	vnode  *i_vnode;/* Vnode associated with this inode. */
70	struct	vnode  *i_devvp;/* Vnode for block I/O. */
71	u_int32_t i_flag;	/* flags, see below */
72	dev_t	  i_dev;	/* Device associated with the inode. */
73	ino_t	  i_number;	/* The identity of the inode. */
74
75	struct	ext2_sb_info *i_e2fs;	/* EXT2FS */
76	u_quad_t i_modrev;	/* Revision level for NFS lease. */
77	struct	 lockf *i_lockf;/* Head of byte-level lock list. */
78	/*
79	 * Side effects; used during directory lookup.
80	 */
81	int32_t	  i_count;	/* Size of free slot in directory. */
82	doff_t	  i_endoff;	/* End of useful stuff in directory. */
83	doff_t	  i_diroff;	/* Offset in dir, where we found last entry. */
84	doff_t	  i_offset;	/* Offset of free space in directory. */
85	ino_t	  i_ino;	/* Inode number of found directory. */
86	u_int32_t i_reclen;	/* Size of found directory entry. */
87
88	u_int32_t i_block_group;
89	u_int32_t i_next_alloc_block;
90	u_int32_t i_next_alloc_goal;
91	u_int32_t i_prealloc_block;
92	u_int32_t i_prealloc_count;
93
94	/* Fields from struct dinode in UFS. */
95	u_int16_t	i_mode;		/* IFMT, permissions; see below. */
96	int16_t		i_nlink;	/* File link count. */
97	u_int64_t	i_size;		/* File byte count. */
98	int32_t		i_atime;	/* Last access time. */
99	int32_t		i_atimensec;	/* Last access time. */
100	int32_t		i_mtime;	/* Last modified time. */
101	int32_t		i_mtimensec;	/* Last modified time. */
102	int32_t		i_ctime;	/* Last inode change time. */
103	int32_t		i_ctimensec;	/* Last inode change time. */
104	daddr_t		i_db[NDADDR];	/* Direct disk blocks. */
105	daddr_t		i_ib[NIADDR];	/* Indirect disk blocks. */
106	u_int32_t	i_flags;	/* Status flags (chflags). */
107	int32_t		i_blocks;	/* Blocks actually held. */
108	int32_t		i_gen;		/* Generation number. */
109	u_int32_t	i_uid;		/* File owner. */
110	u_int32_t	i_gid;		/* File group. */
111};
112
113/*
114 * The di_db fields may be overlaid with other information for
115 * file types that do not have associated disk storage. Block
116 * and character devices overlay the first data block with their
117 * dev_t value. Short symbolic links place their path in the
118 * di_db area.
119 */
120#define	i_shortlink	i_db
121#define	i_rdev		i_db[0]
122#define	MAXSYMLINKLEN	((NDADDR + NIADDR) * sizeof(daddr_t))
123
124/* File permissions. */
125#define	IEXEC		0000100		/* Executable. */
126#define	IWRITE		0000200		/* Writeable. */
127#define	IREAD		0000400		/* Readable. */
128#define	ISVTX		0001000		/* Sticky bit. */
129#define	ISGID		0002000		/* Set-gid. */
130#define	ISUID		0004000		/* Set-uid. */
131
132/* File types. */
133#define	IFMT		0170000		/* Mask of file type. */
134#define	IFIFO		0010000		/* Named pipe (fifo). */
135#define	IFCHR		0020000		/* Character device. */
136#define	IFDIR		0040000		/* Directory file. */
137#define	IFBLK		0060000		/* Block device. */
138#define	IFREG		0100000		/* Regular file. */
139#define	IFLNK		0120000		/* Symbolic link. */
140#define	IFSOCK		0140000		/* UNIX domain socket. */
141#define	IFWHT		0160000		/* Whiteout. */
142
143/* These flags are kept in i_flag. */
144#define	IN_ACCESS	0x0001		/* Access time update request. */
145#define	IN_CHANGE	0x0002		/* Inode change time update request. */
146#define	IN_UPDATE	0x0004		/* Modification time update request. */
147#define	IN_MODIFIED	0x0008		/* Inode has been modified. */
148#define	IN_RENAME	0x0010		/* Inode is being renamed. */
149#define	IN_HASHED	0x0020		/* Inode is on hash list */
150#define	IN_LAZYMOD	0x0040		/* Modified, but don't write yet. */
151#define	IN_SPACECOUNTED	0x0080		/* Blocks to be freed in free count. */
152
153#ifdef _KERNEL
154/*
155 * Structure used to pass around logical block paths generated by
156 * ufs_getlbns and used by truncate and bmap code.
157 */
158struct indir {
159	daddr_t in_lbn;			/* Logical block number. */
160	int	in_off;			/* Offset in buffer. */
161	int	in_exists;		/* Flag if the block exists. */
162};
163
164/* Convert between inode pointers and vnode pointers. */
165#define VTOI(vp)	((struct inode *)(vp)->v_data)
166#define ITOV(ip)	((ip)->i_vnode)
167
168/* This overlays the fid structure (see mount.h). */
169struct ufid {
170	u_int16_t ufid_len;	/* Length of structure. */
171	u_int16_t ufid_pad;	/* Force 32-bit alignment. */
172	ino_t	  ufid_ino;	/* File number (ino). */
173	int32_t	  ufid_gen;	/* Generation number. */
174};
175#endif /* _KERNEL */
176
177#endif /* !_SYS_GNU_EXT2FS_INODE_H_ */
178