1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
6 #ifndef __XFS_INODE_H__
7 #define __XFS_INODE_H__
9 #include "xfs_inode_buf.h"
10 #include "xfs_inode_fork.h"
13 * Kernel only inode definitions
19 struct xfs_inode_log_item
;
24 typedef struct xfs_inode
{
25 /* Inode linking and identification information. */
26 struct xfs_mount
*i_mount
; /* fs mount struct ptr */
27 struct xfs_dquot
*i_udquot
; /* user dquot */
28 struct xfs_dquot
*i_gdquot
; /* group dquot */
29 struct xfs_dquot
*i_pdquot
; /* project dquot */
31 /* Inode location stuff */
32 xfs_ino_t i_ino
; /* inode number (agno/agino)*/
33 struct xfs_imap i_imap
; /* location for xfs_imap() */
35 /* Extent information. */
36 struct xfs_ifork
*i_afp
; /* attribute fork pointer */
37 struct xfs_ifork
*i_cowfp
; /* copy on write extents */
38 struct xfs_ifork i_df
; /* data fork */
40 /* Transaction and locking information. */
41 struct xfs_inode_log_item
*i_itemp
; /* logging information */
42 mrlock_t i_lock
; /* inode lock */
43 mrlock_t i_mmaplock
; /* inode mmap IO lock */
44 atomic_t i_pincount
; /* inode pin count */
47 * Bitsets of inode metadata that have been checked and/or are sick.
48 * Callers must hold i_flags_lock before accessing this field.
53 spinlock_t i_flags_lock
; /* inode i_flags lock */
54 /* Miscellaneous state. */
55 unsigned long i_flags
; /* see defined flags below */
56 uint64_t i_delayed_blks
; /* count of delay alloc blks */
58 struct xfs_icdinode i_d
; /* most of ondisk inode */
61 struct inode i_vnode
; /* embedded VFS inode */
63 /* pending io completions */
64 spinlock_t i_ioend_lock
;
65 struct work_struct i_ioend_work
;
66 struct list_head i_ioend_list
;
69 /* Convert from vfs inode to xfs inode */
70 static inline struct xfs_inode
*XFS_I(struct inode
*inode
)
72 return container_of(inode
, struct xfs_inode
, i_vnode
);
75 /* convert from xfs inode to vfs inode */
76 static inline struct inode
*VFS_I(struct xfs_inode
*ip
)
82 * For regular files we only update the on-disk filesize when actually
83 * writing data back to disk. Until then only the copy in the VFS inode
86 static inline xfs_fsize_t
XFS_ISIZE(struct xfs_inode
*ip
)
88 if (S_ISREG(VFS_I(ip
)->i_mode
))
89 return i_size_read(VFS_I(ip
));
90 return ip
->i_d
.di_size
;
94 * If this I/O goes past the on-disk inode size update it unless it would
95 * be past the current in-core inode size.
97 static inline xfs_fsize_t
98 xfs_new_eof(struct xfs_inode
*ip
, xfs_fsize_t new_size
)
100 xfs_fsize_t i_size
= i_size_read(VFS_I(ip
));
102 if (new_size
> i_size
|| new_size
< 0)
104 return new_size
> ip
->i_d
.di_size
? new_size
: 0;
108 * i_flags helper functions
111 __xfs_iflags_set(xfs_inode_t
*ip
, unsigned short flags
)
113 ip
->i_flags
|= flags
;
117 xfs_iflags_set(xfs_inode_t
*ip
, unsigned short flags
)
119 spin_lock(&ip
->i_flags_lock
);
120 __xfs_iflags_set(ip
, flags
);
121 spin_unlock(&ip
->i_flags_lock
);
125 xfs_iflags_clear(xfs_inode_t
*ip
, unsigned short flags
)
127 spin_lock(&ip
->i_flags_lock
);
128 ip
->i_flags
&= ~flags
;
129 spin_unlock(&ip
->i_flags_lock
);
133 __xfs_iflags_test(xfs_inode_t
*ip
, unsigned short flags
)
135 return (ip
->i_flags
& flags
);
139 xfs_iflags_test(xfs_inode_t
*ip
, unsigned short flags
)
142 spin_lock(&ip
->i_flags_lock
);
143 ret
= __xfs_iflags_test(ip
, flags
);
144 spin_unlock(&ip
->i_flags_lock
);
149 xfs_iflags_test_and_clear(xfs_inode_t
*ip
, unsigned short flags
)
153 spin_lock(&ip
->i_flags_lock
);
154 ret
= ip
->i_flags
& flags
;
156 ip
->i_flags
&= ~flags
;
157 spin_unlock(&ip
->i_flags_lock
);
162 xfs_iflags_test_and_set(xfs_inode_t
*ip
, unsigned short flags
)
166 spin_lock(&ip
->i_flags_lock
);
167 ret
= ip
->i_flags
& flags
;
169 ip
->i_flags
|= flags
;
170 spin_unlock(&ip
->i_flags_lock
);
175 xfs_get_initial_prid(struct xfs_inode
*dp
)
177 if (dp
->i_d
.di_flags
& XFS_DIFLAG_PROJINHERIT
)
178 return dp
->i_d
.di_projid
;
180 return XFS_PROJID_DEFAULT
;
183 static inline bool xfs_is_reflink_inode(struct xfs_inode
*ip
)
185 return ip
->i_d
.di_flags2
& XFS_DIFLAG2_REFLINK
;
189 * Check if an inode has any data in the COW fork. This might be often false
190 * even for inodes with the reflink flag when there is no pending COW operation.
192 static inline bool xfs_inode_has_cow_data(struct xfs_inode
*ip
)
194 return ip
->i_cowfp
&& ip
->i_cowfp
->if_bytes
;
198 * Return the buftarg used for data allocations on a given inode.
200 #define xfs_inode_buftarg(ip) \
201 (XFS_IS_REALTIME_INODE(ip) ? \
202 (ip)->i_mount->m_rtdev_targp : (ip)->i_mount->m_ddev_targp)
205 * In-core inode flags.
207 #define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */
208 #define XFS_ISTALE (1 << 1) /* inode has been staled */
209 #define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */
210 #define __XFS_INEW_BIT 3 /* inode has just been allocated */
211 #define XFS_INEW (1 << __XFS_INEW_BIT)
212 #define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */
213 #define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */
214 #define __XFS_IFLOCK_BIT 7 /* inode is being flushed right now */
215 #define XFS_IFLOCK (1 << __XFS_IFLOCK_BIT)
216 #define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */
217 #define XFS_IPINNED (1 << __XFS_IPINNED_BIT)
218 #define XFS_IEOFBLOCKS (1 << 9) /* has the preallocblocks tag set */
220 * If this unlinked inode is in the middle of recovery, don't let drop_inode
221 * truncate and free the inode. This can happen if we iget the inode during
222 * log recovery to replay a bmap operation on the inode.
224 #define XFS_IRECOVERY (1 << 11)
225 #define XFS_ICOWBLOCKS (1 << 12)/* has the cowblocks tag set */
228 * Per-lifetime flags need to be reset when re-using a reclaimable inode during
229 * inode lookup. This prevents unintended behaviour on the new inode from
232 #define XFS_IRECLAIM_RESET_FLAGS \
233 (XFS_IRECLAIMABLE | XFS_IRECLAIM | \
234 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED)
237 * Synchronize processes attempting to flush the in-core inode back to disk.
240 static inline int xfs_isiflocked(struct xfs_inode
*ip
)
242 return xfs_iflags_test(ip
, XFS_IFLOCK
);
245 extern void __xfs_iflock(struct xfs_inode
*ip
);
247 static inline int xfs_iflock_nowait(struct xfs_inode
*ip
)
249 return !xfs_iflags_test_and_set(ip
, XFS_IFLOCK
);
252 static inline void xfs_iflock(struct xfs_inode
*ip
)
254 if (!xfs_iflock_nowait(ip
))
258 static inline void xfs_ifunlock(struct xfs_inode
*ip
)
260 ASSERT(xfs_isiflocked(ip
));
261 xfs_iflags_clear(ip
, XFS_IFLOCK
);
263 wake_up_bit(&ip
->i_flags
, __XFS_IFLOCK_BIT
);
267 * Flags for inode locking.
268 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
269 * 1<<16 - 1<<32-1 -- lockdep annotation (integers)
271 #define XFS_IOLOCK_EXCL (1<<0)
272 #define XFS_IOLOCK_SHARED (1<<1)
273 #define XFS_ILOCK_EXCL (1<<2)
274 #define XFS_ILOCK_SHARED (1<<3)
275 #define XFS_MMAPLOCK_EXCL (1<<4)
276 #define XFS_MMAPLOCK_SHARED (1<<5)
278 #define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
279 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \
280 | XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED)
282 #define XFS_LOCK_FLAGS \
283 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
284 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
285 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
286 { XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \
287 { XFS_MMAPLOCK_EXCL, "MMAPLOCK_EXCL" }, \
288 { XFS_MMAPLOCK_SHARED, "MMAPLOCK_SHARED" }
292 * Flags for lockdep annotations.
294 * XFS_LOCK_PARENT - for directory operations that require locking a
295 * parent directory inode and a child entry inode. IOLOCK requires nesting,
296 * MMAPLOCK does not support this class, ILOCK requires a single subclass
297 * to differentiate parent from child.
299 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
300 * inodes do not participate in the normal lock order, and thus have their
303 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
304 * with xfs_lock_inodes(). This flag is used as the starting subclass
305 * and each subsequent lock acquired will increment the subclass by one.
306 * However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
307 * limited to the subclasses we can represent via nesting. We need at least
308 * 5 inodes nest depth for the ILOCK through rename, and we also have to support
309 * XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
310 * and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
311 * 8 subclasses supported by lockdep.
313 * This also means we have to number the sub-classes in the lowest bits of
314 * the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
315 * mask and we can't use bit-masking to build the subclasses. What a mess.
320 * 16-19 XFS_IOLOCK_SHIFT dependencies
321 * 20-23 XFS_MMAPLOCK_SHIFT dependencies
322 * 24-31 XFS_ILOCK_SHIFT dependencies
335 * 0-4 subclass values
336 * 5 PARENT subclass (not nestable)
337 * 6 RTBITMAP subclass (not nestable)
338 * 7 RTSUM subclass (not nestable)
341 #define XFS_IOLOCK_SHIFT 16
342 #define XFS_IOLOCK_MAX_SUBCLASS 3
343 #define XFS_IOLOCK_DEP_MASK 0x000f0000
345 #define XFS_MMAPLOCK_SHIFT 20
346 #define XFS_MMAPLOCK_NUMORDER 0
347 #define XFS_MMAPLOCK_MAX_SUBCLASS 3
348 #define XFS_MMAPLOCK_DEP_MASK 0x00f00000
350 #define XFS_ILOCK_SHIFT 24
351 #define XFS_ILOCK_PARENT_VAL 5
352 #define XFS_ILOCK_MAX_SUBCLASS (XFS_ILOCK_PARENT_VAL - 1)
353 #define XFS_ILOCK_RTBITMAP_VAL 6
354 #define XFS_ILOCK_RTSUM_VAL 7
355 #define XFS_ILOCK_DEP_MASK 0xff000000
356 #define XFS_ILOCK_PARENT (XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT)
357 #define XFS_ILOCK_RTBITMAP (XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT)
358 #define XFS_ILOCK_RTSUM (XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT)
360 #define XFS_LOCK_SUBCLASS_MASK (XFS_IOLOCK_DEP_MASK | \
361 XFS_MMAPLOCK_DEP_MASK | \
364 #define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) \
366 #define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \
367 >> XFS_MMAPLOCK_SHIFT)
368 #define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) \
372 * Layouts are broken in the BREAK_WRITE case to ensure that
373 * layout-holders do not collide with local writes. Additionally,
374 * layouts are broken in the BREAK_UNMAP case to make sure the
375 * layout-holder has a consistent view of the file's extent map. While
376 * BREAK_WRITE breaks can be satisfied by recalling FL_LAYOUT leases,
377 * BREAK_UNMAP breaks additionally require waiting for busy dax-pages to
380 enum layout_break_reason
{
386 * For multiple groups support: if S_ISGID bit is set in the parent
387 * directory, group of new file is set to that of the parent, and
388 * new subdirectory gets S_ISGID bit from parent.
390 #define XFS_INHERIT_GID(pip) \
391 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
392 (VFS_I(pip)->i_mode & S_ISGID))
394 int xfs_release(struct xfs_inode
*ip
);
395 void xfs_inactive(struct xfs_inode
*ip
);
396 int xfs_lookup(struct xfs_inode
*dp
, struct xfs_name
*name
,
397 struct xfs_inode
**ipp
, struct xfs_name
*ci_name
);
398 int xfs_create(struct xfs_inode
*dp
, struct xfs_name
*name
,
399 umode_t mode
, dev_t rdev
, struct xfs_inode
**ipp
);
400 int xfs_create_tmpfile(struct xfs_inode
*dp
, umode_t mode
,
401 struct xfs_inode
**ipp
);
402 int xfs_remove(struct xfs_inode
*dp
, struct xfs_name
*name
,
403 struct xfs_inode
*ip
);
404 int xfs_link(struct xfs_inode
*tdp
, struct xfs_inode
*sip
,
405 struct xfs_name
*target_name
);
406 int xfs_rename(struct xfs_inode
*src_dp
, struct xfs_name
*src_name
,
407 struct xfs_inode
*src_ip
, struct xfs_inode
*target_dp
,
408 struct xfs_name
*target_name
,
409 struct xfs_inode
*target_ip
, unsigned int flags
);
411 void xfs_ilock(xfs_inode_t
*, uint
);
412 int xfs_ilock_nowait(xfs_inode_t
*, uint
);
413 void xfs_iunlock(xfs_inode_t
*, uint
);
414 void xfs_ilock_demote(xfs_inode_t
*, uint
);
415 int xfs_isilocked(xfs_inode_t
*, uint
);
416 uint
xfs_ilock_data_map_shared(struct xfs_inode
*);
417 uint
xfs_ilock_attr_map_shared(struct xfs_inode
*);
419 uint
xfs_ip2xflags(struct xfs_inode
*);
420 int xfs_ifree(struct xfs_trans
*, struct xfs_inode
*);
421 int xfs_itruncate_extents_flags(struct xfs_trans
**,
422 struct xfs_inode
*, int, xfs_fsize_t
, int);
423 void xfs_iext_realloc(xfs_inode_t
*, int, int);
425 int xfs_log_force_inode(struct xfs_inode
*ip
);
426 void xfs_iunpin_wait(xfs_inode_t
*);
427 #define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
429 int xfs_iflush(struct xfs_inode
*, struct xfs_buf
**);
430 void xfs_lock_two_inodes(struct xfs_inode
*ip0
, uint ip0_mode
,
431 struct xfs_inode
*ip1
, uint ip1_mode
);
433 xfs_extlen_t
xfs_get_extsz_hint(struct xfs_inode
*ip
);
434 xfs_extlen_t
xfs_get_cowextsz_hint(struct xfs_inode
*ip
);
436 int xfs_dir_ialloc(struct xfs_trans
**, struct xfs_inode
*, umode_t
,
437 xfs_nlink_t
, dev_t
, prid_t
,
438 struct xfs_inode
**);
441 xfs_itruncate_extents(
442 struct xfs_trans
**tpp
,
443 struct xfs_inode
*ip
,
445 xfs_fsize_t new_size
)
447 return xfs_itruncate_extents_flags(tpp
, ip
, whichfork
, new_size
, 0);
450 /* from xfs_file.c */
451 enum xfs_prealloc_flags
{
452 XFS_PREALLOC_SET
= (1 << 1),
453 XFS_PREALLOC_CLEAR
= (1 << 2),
454 XFS_PREALLOC_SYNC
= (1 << 3),
455 XFS_PREALLOC_INVISIBLE
= (1 << 4),
458 int xfs_update_prealloc_flags(struct xfs_inode
*ip
,
459 enum xfs_prealloc_flags flags
);
460 int xfs_break_layouts(struct inode
*inode
, uint
*iolock
,
461 enum layout_break_reason reason
);
463 /* from xfs_iops.c */
464 extern void xfs_setup_inode(struct xfs_inode
*ip
);
465 extern void xfs_setup_iops(struct xfs_inode
*ip
);
466 extern void xfs_diflags_to_iflags(struct xfs_inode
*ip
, bool init
);
469 * When setting up a newly allocated inode, we need to call
470 * xfs_finish_inode_setup() once the inode is fully instantiated at
471 * the VFS level to prevent the rest of the world seeing the inode
472 * before we've completed instantiation. Otherwise we can do it
473 * the moment the inode lookup is complete.
475 static inline void xfs_finish_inode_setup(struct xfs_inode
*ip
)
477 xfs_iflags_clear(ip
, XFS_INEW
);
479 unlock_new_inode(VFS_I(ip
));
480 wake_up_bit(&ip
->i_flags
, __XFS_INEW_BIT
);
483 static inline void xfs_setup_existing_inode(struct xfs_inode
*ip
)
487 xfs_finish_inode_setup(ip
);
490 void xfs_irele(struct xfs_inode
*ip
);
492 extern struct kmem_zone
*xfs_inode_zone
;
494 /* The default CoW extent size hint. */
495 #define XFS_DEFAULT_COWEXTSZ_HINT 32
497 int xfs_iunlink_init(struct xfs_perag
*pag
);
498 void xfs_iunlink_destroy(struct xfs_perag
*pag
);
500 void xfs_end_io(struct work_struct
*work
);
502 #endif /* __XFS_INODE_H__ */