xref: /freebsd/sys/fs/ext2fs/inode.h (revision 2008043f386721d58158e37e0d7e50df8095942d)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1982, 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  * (c) UNIX System Laboratories, Inc.
7  * All or some portions of this file are derived from material licensed
8  * to the University of California by American Telephone and Telegraph
9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10  * the permission of UNIX System Laboratories, Inc.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	@(#)inode.h	8.9 (Berkeley) 5/14/95
37  */
38 
39 #ifndef _FS_EXT2FS_INODE_H_
40 #define	_FS_EXT2FS_INODE_H_
41 
42 #include <sys/param.h>
43 #include <sys/lock.h>
44 #include <sys/mutex.h>
45 #include <sys/queue.h>
46 #include <sys/buf.h>
47 
48 #include <fs/ext2fs/ext2_extents.h>
49 
50 /*
51  * This must agree with the definition in <ufs/ufs/dir.h>.
52  */
53 #define	doff_t		int32_t
54 
55 #define	EXT2_NDADDR	12		/* Direct addresses in inode. */
56 #define	EXT2_NIADDR	3		/* Indirect addresses in inode. */
57 
58 /*
59  * The size of physical and logical block numbers in EXT2FS.
60  */
61 typedef uint32_t e2fs_daddr_t;
62 typedef int64_t e2fs_lbn_t;
63 typedef int64_t e4fs_daddr_t;
64 typedef int64_t ext_time_t;
65 
66 /*
67  * The inode is used to describe each active (or recently active) file in the
68  * EXT2FS filesystem. It is composed of two types of information. The first
69  * part is the information that is needed only while the file is active (such
70  * as the identity of the file and linkage to speed its lookup). The second
71  * part is the permanent meta-data associated with the file which is read in
72  * from the permanent dinode from long term storage when the file becomes
73  * active, and is put back when the file is no longer being used.
74  */
75 struct inode {
76 	struct	vnode  *i_vnode;/* Vnode associated with this inode. */
77 	struct	ext2mount *i_ump;
78 	uint32_t i_flag;	/* flags, see below */
79 	ino_t	  i_number;	/* The identity of the inode. */
80 
81 	struct	m_ext2fs *i_e2fs;	/* EXT2FS */
82 	u_quad_t i_modrev;	/* Revision level for NFS lease. */
83 	/*
84 	 * Side effects; used during directory lookup.
85 	 */
86 	int32_t	 i_count;	/* Size of free slot in directory. */
87 	doff_t	 i_endoff;	/* End of useful stuff in directory. */
88 	doff_t	 i_diroff;	/* Offset in dir, where we found last entry. */
89 	doff_t	 i_offset;	/* Offset of free space in directory. */
90 
91 	uint32_t i_block_group;
92 	uint32_t i_next_alloc_block;
93 	uint32_t i_next_alloc_goal;
94 
95 	/* Fields from struct dinode in UFS. */
96 	uint16_t	i_mode;		/* IFMT, permissions; see below. */
97 	int32_t		i_nlink;	/* File link count. */
98 	uint32_t	i_uid;		/* File owner. */
99 	uint32_t	i_gid;		/* File group. */
100 	uint64_t	i_size;		/* File byte count. */
101 	uint64_t	i_blocks;	/* Blocks actually held. */
102 	ext_time_t	i_atime;	/* Last access time. */
103 	ext_time_t	i_mtime;	/* Last modified time. */
104 	ext_time_t	i_ctime;	/* Last inode change time. */
105 	ext_time_t	i_birthtime;	/* Inode creation time. */
106 	int32_t		i_mtimensec;	/* Last modified time. */
107 	int32_t		i_atimensec;	/* Last access time. */
108 	int32_t		i_ctimensec;	/* Last inode change time. */
109 	int32_t		i_birthnsec;	/* Inode creation time. */
110 	uint32_t	i_gen;		/* Generation number. */
111 	uint64_t	i_facl;		/* EA block number. */
112 	uint32_t	i_flags;	/* Status flags (chflags). */
113 	dev_t		i_rdev; 	/* Major/minor inode values. */
114 	union {
115 		struct {
116 			uint32_t i_db[EXT2_NDADDR]; /* Direct disk blocks. */
117 			uint32_t i_ib[EXT2_NIADDR]; /* Indirect disk blocks. */
118 		};
119 		uint32_t i_data[EXT2_NDADDR + EXT2_NIADDR];
120 	};
121 
122 	struct ext4_extent_cache i_ext_cache; /* cache for ext4 extent */
123 
124 	struct vn_clusterw i_clusterw;	/* Buffer clustering information */
125 };
126 
127 /*
128  * The di_db fields may be overlaid with other information for
129  * file types that do not have associated disk storage. Block
130  * and character devices overlay the first data block with their
131  * dev_t value. Short symbolic links place their path in the
132  * di_db area.
133  */
134 #define	i_shortlink	i_db
135 
136 /* File permissions. */
137 #define	IEXEC		0000100		/* Executable. */
138 #define	IWRITE		0000200		/* Writeable. */
139 #define	IREAD		0000400		/* Readable. */
140 #define	ISVTX		0001000		/* Sticky bit. */
141 #define	ISGID		0002000		/* Set-gid. */
142 #define	ISUID		0004000		/* Set-uid. */
143 
144 /* File types. */
145 #define	IFMT		0170000		/* Mask of file type. */
146 #define	IFIFO		0010000		/* Named pipe (fifo). */
147 #define	IFCHR		0020000		/* Character device. */
148 #define	IFDIR		0040000		/* Directory file. */
149 #define	IFBLK		0060000		/* Block device. */
150 #define	IFREG		0100000		/* Regular file. */
151 #define	IFLNK		0120000		/* Symbolic link. */
152 #define	IFSOCK		0140000		/* UNIX domain socket. */
153 #define	IFWHT		0160000		/* Whiteout. */
154 
155 /* These flags are kept in i_flag. */
156 #define	IN_ACCESS	0x0001		/* Access time update request. */
157 #define	IN_CHANGE	0x0002		/* Inode change time update request. */
158 #define	IN_UPDATE	0x0004		/* Modification time update request. */
159 #define	IN_MODIFIED	0x0008		/* Inode has been modified. */
160 #define	IN_RENAME	0x0010		/* Inode is being renamed. */
161 #define	IN_HASHED	0x0020		/* Inode is on hash list */
162 #define	IN_LAZYMOD	0x0040		/* Modified, but don't write yet. */
163 #define	IN_SPACECOUNTED	0x0080		/* Blocks to be freed in free count. */
164 #define	IN_LAZYACCESS   0x0100		/* Process IN_ACCESS after the
165 					    suspension finished */
166 
167 /*
168  * These are translation flags for some attributes that Ext4
169  * passes as inode flags but that we cannot pass directly.
170  */
171 #define	IN_E3INDEX	0x010000
172 #define	IN_E4EXTENTS	0x020000
173 
174 #define i_devvp i_ump->um_devvp
175 
176 #ifdef _KERNEL
177 /*
178  * Structure used to pass around logical block paths generated by
179  * ext2_getlbns and used by truncate and bmap code.
180  */
181 struct indir {
182 	e2fs_lbn_t in_lbn;		/* Logical block number. */
183 	int	in_off;			/* Offset in buffer. */
184 };
185 
186 /* Convert between inode pointers and vnode pointers. */
187 #define VTOI(vp)	((struct inode *)(vp)->v_data)
188 #define ITOV(ip)	((ip)->i_vnode)
189 
190 /* This overlays the fid structure (see mount.h). */
191 struct ufid {
192 	uint16_t ufid_len;		/* Length of structure. */
193 	uint16_t ufid_pad;		/* Force 32-bit alignment. */
194 	ino_t	ufid_ino;		/* File number (ino). */
195 	uint32_t ufid_gen;		/* Generation number. */
196 };
197 #endif	/* _KERNEL */
198 
199 #endif	/* !_FS_EXT2FS_INODE_H_ */
200