2 * SPDX-License-Identifier: BSD-3-Clause
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.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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
36 * @(#)inode.h 8.9 (Berkeley) 5/14/95
39 #ifndef _UFS_UFS_INODE_H_
40 #define _UFS_UFS_INODE_H_
43 #include <sys/queue.h>
44 #include <ufs/ufs/dinode.h>
47 #include <sys/stack.h>
52 * This must agree with the definition in <ufs/ufs/dir.h>.
54 #define doff_t int32_t
58 struct thread *tr_owner;
60 struct stack tr_unlock;
66 * The inode is used to describe each active (or recently active) file in the
67 * UFS filesystem. It is composed of two types of information. The first part
68 * is the information that is needed only while the file is active (such as
69 * the identity of the file and linkage to speed its lookup). The second part
70 * is the permanent meta-data associated with the file which is read in
71 * from the permanent dinode from long term storage when the file becomes
72 * active, and is put back when the file is no longer being used.
74 * An inode may only be changed while holding either the exclusive
75 * vnode lock or the shared vnode lock and the vnode interlock. We use
76 * the latter only for "read" and "get" operations that require
77 * changing i_flag, or a timestamp. This locking protocol allows executing
78 * those operations without having to upgrade the vnode lock from shared to
82 TAILQ_ENTRY(inode) i_nextsnap; /* snapshot file list. */
83 struct vnode *i_vnode;/* Vnode associated with this inode. */
84 struct ufsmount *i_ump;/* Ufsmount point associated with this inode. */
85 struct dquot *i_dquot[MAXQUOTAS]; /* Dquot structures. */
87 struct dirhash *dirhash; /* Hashing for large directories. */
88 daddr_t *snapblklist; /* Collect expunged snapshot blocks. */
91 * The real copy of the on-disk inode.
94 struct ufs1_dinode *din1; /* UFS1 on-disk dinode. */
95 struct ufs2_dinode *din2; /* UFS2 on-disk dinode. */
98 ino_t i_number; /* The identity of the inode. */
99 uint32_t i_flag; /* flags, see below */
100 int i_effnlink; /* i_nlink when I/O completes */
103 * Side effects; used during directory lookup.
105 int32_t i_count; /* Size of free slot in directory. */
106 doff_t i_endoff; /* End of useful stuff in directory. */
107 doff_t i_diroff; /* Offset in dir, where we found last entry. */
108 doff_t i_offset; /* Offset of free space in directory. */
111 struct iown_tracker i_count_tracker;
112 struct iown_tracker i_endoff_tracker;
113 struct iown_tracker i_offset_tracker;
116 int i_nextclustercg; /* last cg searched for cluster */
118 struct vn_clusterw i_clusterw; /* Buffer clustering information */
121 * Data for extended attribute modification.
123 uint8_t *i_ea_area; /* Pointer to malloced copy of EA area */
124 unsigned i_ea_len; /* Length of i_ea_area */
125 int i_ea_error; /* First errno in transaction */
126 int i_ea_refs; /* Number of users of EA area */
129 * Copies from the on-disk dinode itself.
131 uint64_t i_size; /* File byte count. */
132 uint64_t i_gen; /* Generation number. */
133 uint32_t i_flags; /* Status flags (chflags). */
134 uint32_t i_uid; /* File owner. */
135 uint32_t i_gid; /* File group. */
136 uint16_t i_mode; /* IFMT, permissions; see below. */
137 int16_t i_nlink; /* File link count. */
140 * These flags are kept in i_flag.
142 #define IN_ACCESS 0x0001 /* Access time update request. */
143 #define IN_CHANGE 0x0002 /* Inode change time update request. */
144 #define IN_UPDATE 0x0004 /* Modification time update request. */
145 #define IN_MODIFIED 0x0008 /* Inode has been modified. */
146 #define IN_NEEDSYNC 0x0010 /* Inode requires fsync. */
147 #define IN_LAZYMOD 0x0020 /* Modified, but don't write yet. */
148 #define IN_LAZYACCESS 0x0040 /* Process IN_ACCESS after the
149 suspension finished */
150 #define IN_EA_LOCKED 0x0080 /* Extended attributes locked */
151 #define IN_EA_LOCKWAIT 0x0100 /* Want extended attributes lock */
152 #define IN_TRUNCATED 0x0200 /* Journaled truncation pending. */
153 #define IN_UFS2 0x0400 /* UFS2 vs UFS1 */
154 #define IN_IBLKDATA 0x0800 /* datasync requires inode block
156 #define IN_SIZEMOD 0x1000 /* Inode size has been modified */
157 #define IN_ENDOFF 0x2000 /* Free space at the end of directory,
158 try to truncate when possible */
160 #define PRINT_INODE_FLAGS "\20\20b16\17b15\16b14\15sizemod" \
161 "\14iblkdata\13is_ufs2\12truncated\11ea_lockwait\10ea_locked" \
162 "\7lazyaccess\6lazymod\5needsync\4modified\3update\2change\1access"
164 #define UFS_INODE_FLAG_LAZY_MASK \
165 (IN_ACCESS | IN_CHANGE | IN_MODIFIED | IN_UPDATE | IN_LAZYMOD | \
168 * Some flags can persist a vnode transitioning to 0 hold count and being tkaen
171 #define UFS_INODE_FLAG_LAZY_MASK_ASSERTABLE \
172 (UFS_INODE_FLAG_LAZY_MASK & ~(IN_LAZYMOD | IN_LAZYACCESS))
174 #define UFS_INODE_SET_MODE(ip, mode) do { \
175 struct inode *_ip = (ip); \
176 int _mode = (mode); \
178 ASSERT_VOP_IN_SEQC(ITOV(_ip)); \
179 atomic_store_short(&(_ip)->i_mode, _mode); \
182 #define UFS_INODE_SET_FLAG(ip, flags) do { \
183 struct inode *_ip = (ip); \
184 struct vnode *_vp = ITOV(_ip); \
185 int _flags = (flags); \
187 _ip->i_flag |= _flags; \
188 if (_flags & UFS_INODE_FLAG_LAZY_MASK) \
192 #define UFS_INODE_SET_FLAG_SHARED(ip, flags) do { \
193 struct inode *_ip = (ip); \
194 struct vnode *_vp = ITOV(_ip); \
195 int _flags = (flags); \
197 ASSERT_VI_UNLOCKED(_vp, __func__); \
198 if ((_ip->i_flag & (_flags)) != _flags) { \
200 _ip->i_flag |= _flags; \
201 if (_flags & UFS_INODE_FLAG_LAZY_MASK) \
207 #define i_dirhash i_un.dirhash
208 #define i_snapblklist i_un.snapblklist
209 #define i_din1 dinode_u.din1
210 #define i_din2 dinode_u.din2
212 #define ITOUMP(ip) ((ip)->i_ump)
213 #define ITODEV(ip) (ITOUMP(ip)->um_dev)
214 #define ITODEVVP(ip) (ITOUMP(ip)->um_devvp)
215 #define ITOFS(ip) (ITOUMP(ip)->um_fs)
216 #define ITOVFS(ip) ((ip)->i_vnode->v_mount)
221 I_IS_UFS1(const struct inode *ip)
224 return ((ip->i_flag & IN_UFS2) == 0);
228 I_IS_UFS2(const struct inode *ip)
231 return ((ip->i_flag & IN_UFS2) != 0);
236 * The DIP macro is used to access fields in the dinode that are
237 * not cached in the inode itself.
239 #define DIP(ip, field) (I_IS_UFS1(ip) ? (ip)->i_din1->d##field : \
240 (ip)->i_din2->d##field)
241 #define DIP_SET(ip, field, val) do { \
243 (ip)->i_din1->d##field = (val); \
245 (ip)->i_din2->d##field = (val); \
248 #define IS_SNAPSHOT(ip) ((ip)->i_flags & SF_SNAPSHOT)
249 #define IS_UFS(vp) ((vp)->v_data != NULL)
252 * Structure used to pass around logical block paths generated by
253 * ufs_getlbns and used by truncate and bmap code.
256 ufs2_daddr_t in_lbn; /* Logical block number. */
257 int in_off; /* Offset in buffer. */
260 /* Convert between inode pointers and vnode pointers. */
261 #define VTOI(vp) ((struct inode *)(vp)->v_data)
262 #define VTOI_SMR(vp) ((struct inode *)vn_load_v_data_smr(vp))
263 #define ITOV(ip) ((ip)->i_vnode)
265 /* Determine if soft dependencies are being done */
266 #define MOUNTEDSOFTDEP(mp) (((mp)->mnt_flag & MNT_SOFTDEP) != 0)
267 #define DOINGSOFTDEP(vp) MOUNTEDSOFTDEP((vp)->v_mount)
268 #define MOUNTEDSUJ(mp) (((mp)->mnt_flag & (MNT_SOFTDEP | MNT_SUJ)) == \
269 (MNT_SOFTDEP | MNT_SUJ))
270 #define DOINGSUJ(vp) MOUNTEDSUJ((vp)->v_mount)
272 /* This overlays the fid structure (see mount.h). */
274 uint16_t ufid_len; /* Length of structure. */
275 uint16_t ufid_pad; /* Force 32-bit alignment. */
276 uint32_t ufid_ino; /* File number (ino). */
277 uint32_t ufid_gen; /* Generation number. */
282 void ufs_init_trackers(struct inode *ip);
283 void ufs_unlock_tracker(struct inode *ip);
285 doff_t ufs_get_i_offset(struct inode *ip, const char *file, int line);
286 void ufs_set_i_offset(struct inode *ip, doff_t off, const char *file, int line);
287 #define I_OFFSET(ip) ufs_get_i_offset(ip, __FILE__, __LINE__)
288 #define SET_I_OFFSET(ip, off) ufs_set_i_offset(ip, off, __FILE__, __LINE__)
290 int32_t ufs_get_i_count(struct inode *ip, const char *file, int line);
291 void ufs_set_i_count(struct inode *ip, int32_t cnt, const char *file, int line);
292 #define I_COUNT(ip) ufs_get_i_count(ip, __FILE__, __LINE__)
293 #define SET_I_COUNT(ip, cnt) ufs_set_i_count(ip, cnt, __FILE__, __LINE__)
295 doff_t ufs_get_i_endoff(struct inode *ip, const char *file, int line);
296 void ufs_set_i_endoff(struct inode *ip, doff_t off, const char *file, int line);
297 #define I_ENDOFF(ip) ufs_get_i_endoff(ip, __FILE__, __LINE__)
298 #define SET_I_ENDOFF(ip, off) ufs_set_i_endoff(ip, off, __FILE__, __LINE__)
301 #define I_OFFSET(ip) ((ip)->i_offset)
302 #define SET_I_OFFSET(ip, off) ((ip)->i_offset = (off))
303 #define I_COUNT(ip) ((ip)->i_count)
304 #define SET_I_COUNT(ip, cnt) ((ip)->i_count = cnt)
305 #define I_ENDOFF(ip) ((ip)->i_endoff)
306 #define SET_I_ENDOFF(ip, off) ((ip)->i_endoff = off)
311 #endif /* !_UFS_UFS_INODE_H_ */