[linux-block.git] / fs / xfs / xfs_inode.h

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 */
#ifndef	__XFS_INODE_H__
#define	__XFS_INODE_H__

#include "xfs_inode_buf.h"
#include "xfs_inode_fork.h"

/*
 * Kernel only inode definitions
 */
struct xfs_dinode;
struct xfs_inode;
struct xfs_buf;
struct xfs_bmbt_irec;
struct xfs_inode_log_item;
struct xfs_mount;
struct xfs_trans;
struct xfs_dquot;

typedef struct xfs_inode {
	/* Inode linking and identification information. */
	struct xfs_mount	*i_mount;	/* fs mount struct ptr */
	struct xfs_dquot	*i_udquot;	/* user dquot */
	struct xfs_dquot	*i_gdquot;	/* group dquot */
	struct xfs_dquot	*i_pdquot;	/* project dquot */

	/* Inode location stuff */
	xfs_ino_t		i_ino;		/* inode number (agno/agino)*/
	struct xfs_imap		i_imap;		/* location for xfs_imap() */

	/* Extent information. */
	struct xfs_ifork	*i_afp;		/* attribute fork pointer */
	struct xfs_ifork	*i_cowfp;	/* copy on write extents */
	struct xfs_ifork	i_df;		/* data fork */

	/* Transaction and locking information. */
	struct xfs_inode_log_item *i_itemp;	/* logging information */
	mrlock_t		i_lock;		/* inode lock */
	mrlock_t		i_mmaplock;	/* inode mmap IO lock */
	atomic_t		i_pincount;	/* inode pin count */

	/*
	 * Bitsets of inode metadata that have been checked and/or are sick.
	 * Callers must hold i_flags_lock before accessing this field.
	 */
	uint16_t		i_checked;
	uint16_t		i_sick;

	spinlock_t		i_flags_lock;	/* inode i_flags lock */
	/* Miscellaneous state. */
	unsigned long		i_flags;	/* see defined flags below */
	uint64_t		i_delayed_blks;	/* count of delay alloc blks */
	xfs_fsize_t		i_disk_size;	/* number of bytes in file */
	xfs_rfsblock_t		i_nblocks;	/* # of direct & btree blocks */
	prid_t			i_projid;	/* owner's project id */
	xfs_extlen_t		i_extsize;	/* basic/minimum extent size */
	/* cowextsize is only used for v3 inodes, flushiter for v1/2 */
	union {
		xfs_extlen_t	i_cowextsize;	/* basic cow extent size */
		uint16_t	i_flushiter;	/* incremented on flush */
	};
	uint8_t			i_forkoff;	/* attr fork offset >> 3 */
	uint16_t		i_diflags;	/* XFS_DIFLAG_... */
	uint64_t		i_diflags2;	/* XFS_DIFLAG2_... */
	struct timespec64	i_crtime;	/* time created */

	/* VFS inode */
	struct inode		i_vnode;	/* embedded VFS inode */

	/* pending io completions */
	spinlock_t		i_ioend_lock;
	struct work_struct	i_ioend_work;
	struct list_head	i_ioend_list;
} xfs_inode_t;

/* Convert from vfs inode to xfs inode */
static inline struct xfs_inode *XFS_I(struct inode *inode)
{
	return container_of(inode, struct xfs_inode, i_vnode);
}

/* convert from xfs inode to vfs inode */
static inline struct inode *VFS_I(struct xfs_inode *ip)
{
	return &ip->i_vnode;
}

/*
 * For regular files we only update the on-disk filesize when actually
 * writing data back to disk.  Until then only the copy in the VFS inode
 * is uptodate.
 */
static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip)
{
	if (S_ISREG(VFS_I(ip)->i_mode))
		return i_size_read(VFS_I(ip));
	return ip->i_disk_size;
}

/*
 * If this I/O goes past the on-disk inode size update it unless it would
 * be past the current in-core inode size.
 */
static inline xfs_fsize_t
xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size)
{
	xfs_fsize_t i_size = i_size_read(VFS_I(ip));

	if (new_size > i_size || new_size < 0)
		new_size = i_size;
	return new_size > ip->i_disk_size ? new_size : 0;
}

/*
 * i_flags helper functions
 */
static inline void
__xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
{
	ip->i_flags |= flags;
}

static inline void
xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
{
	spin_lock(&ip->i_flags_lock);
	__xfs_iflags_set(ip, flags);
	spin_unlock(&ip->i_flags_lock);
}

static inline void
xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags)
{
	spin_lock(&ip->i_flags_lock);
	ip->i_flags &= ~flags;
	spin_unlock(&ip->i_flags_lock);
}

static inline int
__xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
{
	return (ip->i_flags & flags);
}

static inline int
xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
{
	int ret;
	spin_lock(&ip->i_flags_lock);
	ret = __xfs_iflags_test(ip, flags);
	spin_unlock(&ip->i_flags_lock);
	return ret;
}

static inline int
xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags)
{
	int ret;

	spin_lock(&ip->i_flags_lock);
	ret = ip->i_flags & flags;
	if (ret)
		ip->i_flags &= ~flags;
	spin_unlock(&ip->i_flags_lock);
	return ret;
}

static inline int
xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags)
{
	int ret;

	spin_lock(&ip->i_flags_lock);
	ret = ip->i_flags & flags;
	if (!ret)
		ip->i_flags |= flags;
	spin_unlock(&ip->i_flags_lock);
	return ret;
}

static inline prid_t
xfs_get_initial_prid(struct xfs_inode *dp)
{
	if (dp->i_diflags & XFS_DIFLAG_PROJINHERIT)
		return dp->i_projid;

	return XFS_PROJID_DEFAULT;
}

static inline bool xfs_is_reflink_inode(struct xfs_inode *ip)
{
	return ip->i_diflags2 & XFS_DIFLAG2_REFLINK;
}

static inline bool xfs_is_metadata_inode(struct xfs_inode *ip)
{
	struct xfs_mount	*mp = ip->i_mount;

	return ip == mp->m_rbmip || ip == mp->m_rsumip ||
		xfs_is_quota_inode(&mp->m_sb, ip->i_ino);
}

/*
 * Check if an inode has any data in the COW fork.  This might be often false
 * even for inodes with the reflink flag when there is no pending COW operation.
 */
static inline bool xfs_inode_has_cow_data(struct xfs_inode *ip)
{
	return ip->i_cowfp && ip->i_cowfp->if_bytes;
}

static inline bool xfs_inode_has_bigtime(struct xfs_inode *ip)
{
	return ip->i_diflags2 & XFS_DIFLAG2_BIGTIME;
}

/*
 * Return the buftarg used for data allocations on a given inode.
 */
#define xfs_inode_buftarg(ip) \
	(XFS_IS_REALTIME_INODE(ip) ? \
		(ip)->i_mount->m_rtdev_targp : (ip)->i_mount->m_ddev_targp)

/*
 * In-core inode flags.
 */
#define XFS_IRECLAIM		(1 << 0) /* started reclaiming this inode */
#define XFS_ISTALE		(1 << 1) /* inode has been staled */
#define XFS_IRECLAIMABLE	(1 << 2) /* inode can be reclaimed */
#define __XFS_INEW_BIT		3	 /* inode has just been allocated */
#define XFS_INEW		(1 << __XFS_INEW_BIT)
#define XFS_IPRESERVE_DM_FIELDS	(1 << 4) /* has legacy DMAPI fields set */
#define XFS_ITRUNCATED		(1 << 5) /* truncated down so flush-on-close */
#define XFS_IDIRTY_RELEASE	(1 << 6) /* dirty release already seen */
#define XFS_IFLUSHING		(1 << 7) /* inode is being flushed */
#define __XFS_IPINNED_BIT	8	 /* wakeup key for zero pin count */
#define XFS_IPINNED		(1 << __XFS_IPINNED_BIT)
#define XFS_IEOFBLOCKS		(1 << 9) /* has the preallocblocks tag set */
/*
 * If this unlinked inode is in the middle of recovery, don't let drop_inode
 * truncate and free the inode.  This can happen if we iget the inode during
 * log recovery to replay a bmap operation on the inode.
 */
#define XFS_IRECOVERY		(1 << 11)
#define XFS_ICOWBLOCKS		(1 << 12)/* has the cowblocks tag set */

/*
 * Per-lifetime flags need to be reset when re-using a reclaimable inode during
 * inode lookup. This prevents unintended behaviour on the new inode from
 * ocurring.
 */
#define XFS_IRECLAIM_RESET_FLAGS	\
	(XFS_IRECLAIMABLE | XFS_IRECLAIM | \
	 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED)

/*
 * Flags for inode locking.
 * Bit ranges:	1<<1  - 1<<16-1 -- iolock/ilock modes (bitfield)
 *		1<<16 - 1<<32-1 -- lockdep annotation (integers)
 */
#define	XFS_IOLOCK_EXCL		(1<<0)
#define	XFS_IOLOCK_SHARED	(1<<1)
#define	XFS_ILOCK_EXCL		(1<<2)
#define	XFS_ILOCK_SHARED	(1<<3)
#define	XFS_MMAPLOCK_EXCL	(1<<4)
#define	XFS_MMAPLOCK_SHARED	(1<<5)

#define XFS_LOCK_MASK		(XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
				| XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \
				| XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED)

#define XFS_LOCK_FLAGS \
	{ XFS_IOLOCK_EXCL,	"IOLOCK_EXCL" }, \
	{ XFS_IOLOCK_SHARED,	"IOLOCK_SHARED" }, \
	{ XFS_ILOCK_EXCL,	"ILOCK_EXCL" }, \
	{ XFS_ILOCK_SHARED,	"ILOCK_SHARED" }, \
	{ XFS_MMAPLOCK_EXCL,	"MMAPLOCK_EXCL" }, \
	{ XFS_MMAPLOCK_SHARED,	"MMAPLOCK_SHARED" }


/*
 * Flags for lockdep annotations.
 *
 * XFS_LOCK_PARENT - for directory operations that require locking a
 * parent directory inode and a child entry inode. IOLOCK requires nesting,
 * MMAPLOCK does not support this class, ILOCK requires a single subclass
 * to differentiate parent from child.
 *
 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
 * inodes do not participate in the normal lock order, and thus have their
 * own subclasses.
 *
 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
 * with xfs_lock_inodes().  This flag is used as the starting subclass
 * and each subsequent lock acquired will increment the subclass by one.
 * However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
 * limited to the subclasses we can represent via nesting. We need at least
 * 5 inodes nest depth for the ILOCK through rename, and we also have to support
 * XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
 * and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
 * 8 subclasses supported by lockdep.
 *
 * This also means we have to number the sub-classes in the lowest bits of
 * the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
 * mask and we can't use bit-masking to build the subclasses. What a mess.
 *
 * Bit layout:
 *
 * Bit		Lock Region
 * 16-19	XFS_IOLOCK_SHIFT dependencies
 * 20-23	XFS_MMAPLOCK_SHIFT dependencies
 * 24-31	XFS_ILOCK_SHIFT dependencies
 *
 * IOLOCK values
 *
 * 0-3		subclass value
 * 4-7		unused
 *
 * MMAPLOCK values
 *
 * 0-3		subclass value
 * 4-7		unused
 *
 * ILOCK values
 * 0-4		subclass values
 * 5		PARENT subclass (not nestable)
 * 6		RTBITMAP subclass (not nestable)
 * 7		RTSUM subclass (not nestable)
 * 
 */
#define XFS_IOLOCK_SHIFT		16
#define XFS_IOLOCK_MAX_SUBCLASS		3
#define XFS_IOLOCK_DEP_MASK		0x000f0000

#define XFS_MMAPLOCK_SHIFT		20
#define XFS_MMAPLOCK_NUMORDER		0
#define XFS_MMAPLOCK_MAX_SUBCLASS	3
#define XFS_MMAPLOCK_DEP_MASK		0x00f00000

#define XFS_ILOCK_SHIFT			24
#define XFS_ILOCK_PARENT_VAL		5
#define XFS_ILOCK_MAX_SUBCLASS		(XFS_ILOCK_PARENT_VAL - 1)
#define XFS_ILOCK_RTBITMAP_VAL		6
#define XFS_ILOCK_RTSUM_VAL		7
#define XFS_ILOCK_DEP_MASK		0xff000000
#define	XFS_ILOCK_PARENT		(XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT)
#define	XFS_ILOCK_RTBITMAP		(XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT)
#define	XFS_ILOCK_RTSUM			(XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT)

#define XFS_LOCK_SUBCLASS_MASK	(XFS_IOLOCK_DEP_MASK | \
				 XFS_MMAPLOCK_DEP_MASK | \
				 XFS_ILOCK_DEP_MASK)

#define XFS_IOLOCK_DEP(flags)	(((flags) & XFS_IOLOCK_DEP_MASK) \
					>> XFS_IOLOCK_SHIFT)
#define XFS_MMAPLOCK_DEP(flags)	(((flags) & XFS_MMAPLOCK_DEP_MASK) \
					>> XFS_MMAPLOCK_SHIFT)
#define XFS_ILOCK_DEP(flags)	(((flags) & XFS_ILOCK_DEP_MASK) \
					>> XFS_ILOCK_SHIFT)

/*
 * Layouts are broken in the BREAK_WRITE case to ensure that
 * layout-holders do not collide with local writes. Additionally,
 * layouts are broken in the BREAK_UNMAP case to make sure the
 * layout-holder has a consistent view of the file's extent map. While
 * BREAK_WRITE breaks can be satisfied by recalling FL_LAYOUT leases,
 * BREAK_UNMAP breaks additionally require waiting for busy dax-pages to
 * go idle.
 */
enum layout_break_reason {
        BREAK_WRITE,
        BREAK_UNMAP,
};

/*
 * For multiple groups support: if S_ISGID bit is set in the parent
 * directory, group of new file is set to that of the parent, and
 * new subdirectory gets S_ISGID bit from parent.
 */
#define XFS_INHERIT_GID(pip)	\
	(((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
	 (VFS_I(pip)->i_mode & S_ISGID))

int		xfs_release(struct xfs_inode *ip);
void		xfs_inactive(struct xfs_inode *ip);
int		xfs_lookup(struct xfs_inode *dp, struct xfs_name *name,
			   struct xfs_inode **ipp, struct xfs_name *ci_name);
int		xfs_create(struct user_namespace *mnt_userns,
			   struct xfs_inode *dp, struct xfs_name *name,
			   umode_t mode, dev_t rdev, bool need_xattr,
			   struct xfs_inode **ipp);
int		xfs_create_tmpfile(struct user_namespace *mnt_userns,
			   struct xfs_inode *dp, umode_t mode,
			   struct xfs_inode **ipp);
int		xfs_remove(struct xfs_inode *dp, struct xfs_name *name,
			   struct xfs_inode *ip);
int		xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip,
			 struct xfs_name *target_name);
int		xfs_rename(struct user_namespace *mnt_userns,
			   struct xfs_inode *src_dp, struct xfs_name *src_name,
			   struct xfs_inode *src_ip, struct xfs_inode *target_dp,
			   struct xfs_name *target_name,
			   struct xfs_inode *target_ip, unsigned int flags);

void		xfs_ilock(xfs_inode_t *, uint);
int		xfs_ilock_nowait(xfs_inode_t *, uint);
void		xfs_iunlock(xfs_inode_t *, uint);
void		xfs_ilock_demote(xfs_inode_t *, uint);
int		xfs_isilocked(xfs_inode_t *, uint);
uint		xfs_ilock_data_map_shared(struct xfs_inode *);
uint		xfs_ilock_attr_map_shared(struct xfs_inode *);

uint		xfs_ip2xflags(struct xfs_inode *);
int		xfs_ifree(struct xfs_trans *, struct xfs_inode *);
int		xfs_itruncate_extents_flags(struct xfs_trans **,
				struct xfs_inode *, int, xfs_fsize_t, int);
void		xfs_iext_realloc(xfs_inode_t *, int, int);

int		xfs_log_force_inode(struct xfs_inode *ip);
void		xfs_iunpin_wait(xfs_inode_t *);
#define xfs_ipincount(ip)	((unsigned int) atomic_read(&ip->i_pincount))

int		xfs_iflush_cluster(struct xfs_buf *);
void		xfs_lock_two_inodes(struct xfs_inode *ip0, uint ip0_mode,
				struct xfs_inode *ip1, uint ip1_mode);

xfs_extlen_t	xfs_get_extsz_hint(struct xfs_inode *ip);
xfs_extlen_t	xfs_get_cowextsz_hint(struct xfs_inode *ip);

int xfs_init_new_inode(struct user_namespace *mnt_userns, struct xfs_trans *tp,
		struct xfs_inode *pip, xfs_ino_t ino, umode_t mode,
		xfs_nlink_t nlink, dev_t rdev, prid_t prid, bool init_xattrs,
		struct xfs_inode **ipp);

static inline int
xfs_itruncate_extents(
	struct xfs_trans	**tpp,
	struct xfs_inode	*ip,
	int			whichfork,
	xfs_fsize_t		new_size)
{
	return xfs_itruncate_extents_flags(tpp, ip, whichfork, new_size, 0);
}

/* from xfs_file.c */
enum xfs_prealloc_flags {
	XFS_PREALLOC_SET	= (1 << 1),
	XFS_PREALLOC_CLEAR	= (1 << 2),
	XFS_PREALLOC_SYNC	= (1 << 3),
	XFS_PREALLOC_INVISIBLE	= (1 << 4),
};

int	xfs_update_prealloc_flags(struct xfs_inode *ip,
				  enum xfs_prealloc_flags flags);
int	xfs_break_layouts(struct inode *inode, uint *iolock,
		enum layout_break_reason reason);

/* from xfs_iops.c */
extern void xfs_setup_inode(struct xfs_inode *ip);
extern void xfs_setup_iops(struct xfs_inode *ip);
extern void xfs_diflags_to_iflags(struct xfs_inode *ip, bool init);

/*
 * When setting up a newly allocated inode, we need to call
 * xfs_finish_inode_setup() once the inode is fully instantiated at
 * the VFS level to prevent the rest of the world seeing the inode
 * before we've completed instantiation. Otherwise we can do it
 * the moment the inode lookup is complete.
 */
static inline void xfs_finish_inode_setup(struct xfs_inode *ip)
{
	xfs_iflags_clear(ip, XFS_INEW);
	barrier();
	unlock_new_inode(VFS_I(ip));
	wake_up_bit(&ip->i_flags, __XFS_INEW_BIT);
}

static inline void xfs_setup_existing_inode(struct xfs_inode *ip)
{
	xfs_setup_inode(ip);
	xfs_setup_iops(ip);
	xfs_finish_inode_setup(ip);
}

void xfs_irele(struct xfs_inode *ip);

extern struct kmem_zone	*xfs_inode_zone;

/* The default CoW extent size hint. */
#define XFS_DEFAULT_COWEXTSZ_HINT 32

bool xfs_inode_needs_inactive(struct xfs_inode *ip);

int xfs_iunlink_init(struct xfs_perag *pag);
void xfs_iunlink_destroy(struct xfs_perag *pag);

void xfs_end_io(struct work_struct *work);

int xfs_ilock2_io_mmap(struct xfs_inode *ip1, struct xfs_inode *ip2);
void xfs_iunlock2_io_mmap(struct xfs_inode *ip1, struct xfs_inode *ip2);

#endif	/* __XFS_INODE_H__ */
Commit	Line	Data
0b61f8a4	1	// SPDX-License-Identifier: GPL-2.0
1da177e4	2	/*
7b718769 NS	3	* Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
7b718769 NS	4	* All Rights Reserved.
1da177e4 LT	5	*/
	6	#ifndef __XFS_INODE_H__
	7	#define __XFS_INODE_H__
	8
1fd7115e	9	#include "xfs_inode_buf.h"
5c4d97d0	10	#include "xfs_inode_fork.h"
1da177e4	11
92bfc6e7	12	/*
1fd7115e	13	* Kernel only inode definitions
92bfc6e7	14	*/
1fd7115e DC	15	struct xfs_dinode;
1fd7115e DC	16	struct xfs_inode;
847fff5c	17	struct xfs_buf;
847fff5c	18	struct xfs_bmbt_irec;
847fff5c BN	19	struct xfs_inode_log_item;
	20	struct xfs_mount;
	21	struct xfs_trans;
	22	struct xfs_dquot;
	23
1da177e4 LT	24	typedef struct xfs_inode {
1da177e4 LT	25	/* Inode linking and identification information. */
1da177e4	26	struct xfs_mount i_mount; / fs mount struct ptr */
1da177e4 LT	27	struct xfs_dquot i_udquot; / user dquot */
1da177e4 LT	28	struct xfs_dquot i_gdquot; / group dquot */
92f8ff73	29	struct xfs_dquot i_pdquot; / project dquot */
1da177e4 LT	30
	31	/* Inode location stuff */
	32	xfs_ino_t i_ino; /* inode number (agno/agino)*/
92bfc6e7	33	struct xfs_imap i_imap; /* location for xfs_imap() */
1da177e4 LT	34
1da177e4 LT	35	/* Extent information. */
3ba738df CH	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 */
1da177e4 LT	39
1da177e4 LT	40	/* Transaction and locking information. */
1da177e4 LT	41	struct xfs_inode_log_item i_itemp; / logging information */
1da177e4 LT	42	mrlock_t i_lock; /* inode lock */
653c60b6	43	mrlock_t i_mmaplock; /* inode mmap IO lock */
1da177e4	44	atomic_t i_pincount; /* inode pin count */
6772c1f1 DW	45
	46	/*
	47	* Bitsets of inode metadata that have been checked and/or are sick.
	48	* Callers must hold i_flags_lock before accessing this field.
	49	*/
	50	uint16_t i_checked;
	51	uint16_t i_sick;
	52
f273ab84	53	spinlock_t i_flags_lock; /* inode i_flags lock */
1da177e4	54	/* Miscellaneous state. */
49e4c70e	55	unsigned long i_flags; /* see defined flags below */
394aafdc	56	uint64_t i_delayed_blks; /* count of delay alloc blks */
13d2c10b	57	xfs_fsize_t i_disk_size; /* number of bytes in file */
6e73a545	58	xfs_rfsblock_t i_nblocks; /* # of direct & btree blocks */
ceaf603c	59	prid_t i_projid; /* owner's project id */
031474c2	60	xfs_extlen_t i_extsize; /* basic/minimum extent size */
ee7b83fd CH	61	/* cowextsize is only used for v3 inodes, flushiter for v1/2 */
	62	union {
	63	xfs_extlen_t i_cowextsize; /* basic cow extent size */
	64	uint16_t i_flushiter; /* incremented on flush */
	65	};
7821ea30	66	uint8_t i_forkoff; /* attr fork offset >> 3 */
db07349d	67	uint16_t i_diflags; /* XFS_DIFLAG_... */
3e09ab8f	68	uint64_t i_diflags2; /* XFS_DIFLAG2_... */
e98d5e88	69	struct timespec64 i_crtime; /* time created */
1da177e4	70
bf904248 DC	71	/* VFS inode */
bf904248 DC	72	struct inode i_vnode; /* embedded VFS inode */
cb357bf3 DW	73
	74	/* pending io completions */
	75	spinlock_t i_ioend_lock;
	76	struct work_struct i_ioend_work;
	77	struct list_head i_ioend_list;
1da177e4 LT	78	} xfs_inode_t;
1da177e4 LT	79
01651646 DC	80	/* Convert from vfs inode to xfs inode */
	81	static inline struct xfs_inode XFS_I(struct inode inode)
	82	{
bf904248	83	return container_of(inode, struct xfs_inode, i_vnode);
01651646 DC	84	}
01651646 DC	85
01651646 DC	86	/* convert from xfs inode to vfs inode */
	87	static inline struct inode VFS_I(struct xfs_inode ip)
	88	{
bf904248	89	return &ip->i_vnode;
01651646	90	}
01651646	91
ce7ae151 CH	92	/*
	93	* For regular files we only update the on-disk filesize when actually
	94	* writing data back to disk. Until then only the copy in the VFS inode
	95	* is uptodate.
	96	*/
	97	static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip)
	98	{
c19b3b05	99	if (S_ISREG(VFS_I(ip)->i_mode))
ce7ae151	100	return i_size_read(VFS_I(ip));
13d2c10b	101	return ip->i_disk_size;
ce7ae151 CH	102	}
ce7ae151 CH	103
6923e686 CH	104	/*
	105	* If this I/O goes past the on-disk inode size update it unless it would
	106	* be past the current in-core inode size.
	107	*/
	108	static inline xfs_fsize_t
	109	xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size)
	110	{
	111	xfs_fsize_t i_size = i_size_read(VFS_I(ip));
	112
ce57bcf6	113	if (new_size > i_size \|\| new_size < 0)
6923e686	114	new_size = i_size;
13d2c10b	115	return new_size > ip->i_disk_size ? new_size : 0;
6923e686 CH	116	}
6923e686 CH	117
7a18c386 DC	118	/*
	119	* i_flags helper functions
	120	*/
	121	static inline void
	122	__xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
	123	{
	124	ip->i_flags \|= flags;
	125	}
	126
	127	static inline void
	128	xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
	129	{
	130	spin_lock(&ip->i_flags_lock);
	131	__xfs_iflags_set(ip, flags);
	132	spin_unlock(&ip->i_flags_lock);
	133	}
	134
	135	static inline void
	136	xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags)
	137	{
	138	spin_lock(&ip->i_flags_lock);
	139	ip->i_flags &= ~flags;
	140	spin_unlock(&ip->i_flags_lock);
	141	}
	142
	143	static inline int
	144	__xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
	145	{
	146	return (ip->i_flags & flags);
	147	}
	148
	149	static inline int
	150	xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
	151	{
	152	int ret;
	153	spin_lock(&ip->i_flags_lock);
	154	ret = __xfs_iflags_test(ip, flags);
	155	spin_unlock(&ip->i_flags_lock);
	156	return ret;
	157	}
09262b43 CH	158
	159	static inline int
	160	xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags)
	161	{
	162	int ret;
	163
	164	spin_lock(&ip->i_flags_lock);
	165	ret = ip->i_flags & flags;
	166	if (ret)
	167	ip->i_flags &= ~flags;
	168	spin_unlock(&ip->i_flags_lock);
	169	return ret;
	170	}
1da177e4	171
474fce06 CH	172	static inline int
	173	xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags)
	174	{
	175	int ret;
	176
	177	spin_lock(&ip->i_flags_lock);
	178	ret = ip->i_flags & flags;
	179	if (!ret)
	180	ip->i_flags \|= flags;
	181	spin_unlock(&ip->i_flags_lock);
	182	return ret;
	183	}
	184
163467d3 ZYW	185	static inline prid_t
	186	xfs_get_initial_prid(struct xfs_inode *dp)
	187	{
db07349d	188	if (dp->i_diflags & XFS_DIFLAG_PROJINHERIT)
ceaf603c	189	return dp->i_projid;
163467d3 ZYW	190
	191	return XFS_PROJID_DEFAULT;
	192	}
	193
46eeb521 DW	194	static inline bool xfs_is_reflink_inode(struct xfs_inode *ip)
46eeb521 DW	195	{
3e09ab8f	196	return ip->i_diflags2 & XFS_DIFLAG2_REFLINK;
46eeb521 DW	197	}
46eeb521 DW	198
383e32b0 DW	199	static inline bool xfs_is_metadata_inode(struct xfs_inode *ip)
	200	{
	201	struct xfs_mount *mp = ip->i_mount;
	202
	203	return ip == mp->m_rbmip \|\| ip == mp->m_rsumip \|\|
	204	xfs_is_quota_inode(&mp->m_sb, ip->i_ino);
	205	}
	206
51d62690 CH	207	/*
	208	* Check if an inode has any data in the COW fork. This might be often false
	209	* even for inodes with the reflink flag when there is no pending COW operation.
	210	*/
	211	static inline bool xfs_inode_has_cow_data(struct xfs_inode *ip)
	212	{
	213	return ip->i_cowfp && ip->i_cowfp->if_bytes;
	214	}
	215
f93e5436 DW	216	static inline bool xfs_inode_has_bigtime(struct xfs_inode *ip)
f93e5436 DW	217	{
3e09ab8f	218	return ip->i_diflags2 & XFS_DIFLAG2_BIGTIME;
f93e5436 DW	219	}
f93e5436 DW	220
30fa529e CH	221	/*
	222	* Return the buftarg used for data allocations on a given inode.
	223	*/
	224	#define xfs_inode_buftarg(ip) \
	225	(XFS_IS_REALTIME_INODE(ip) ? \
	226	(ip)->i_mount->m_rtdev_targp : (ip)->i_mount->m_ddev_targp)
	227
1da177e4 LT	228	/*
	229	* In-core inode flags.
	230	*/
474fce06 CH	231	#define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */
	232	#define XFS_ISTALE (1 << 1) /* inode has been staled */
	233	#define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */
756baca2 BF	234	#define __XFS_INEW_BIT 3 /* inode has just been allocated */
756baca2 BF	235	#define XFS_INEW (1 << __XFS_INEW_BIT)
9b3beb02	236	#define XFS_IPRESERVE_DM_FIELDS (1 << 4) /* has legacy DMAPI fields set */
474fce06 CH	237	#define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */
474fce06 CH	238	#define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */
718ecc50	239	#define XFS_IFLUSHING (1 << 7) /* inode is being flushed */
f392e631 CH	240	#define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */
f392e631 CH	241	#define XFS_IPINNED (1 << __XFS_IPINNED_BIT)
dae2f8ed	242	#define XFS_IEOFBLOCKS (1 << 9) /* has the preallocblocks tag set */
17c12bcd DW	243	/*
	244	* If this unlinked inode is in the middle of recovery, don't let drop_inode
	245	* truncate and free the inode. This can happen if we iget the inode during
	246	* log recovery to replay a bmap operation on the inode.
	247	*/
	248	#define XFS_IRECOVERY (1 << 11)
91aae6be	249	#define XFS_ICOWBLOCKS (1 << 12)/* has the cowblocks tag set */
1da177e4	250
778e24bb DC	251	/*
778e24bb DC	252	* Per-lifetime flags need to be reset when re-using a reclaimable inode during
5132ba8f	253	* inode lookup. This prevents unintended behaviour on the new inode from
778e24bb DC	254	* ocurring.
	255	*/
	256	#define XFS_IRECLAIM_RESET_FLAGS \
	257	(XFS_IRECLAIMABLE \| XFS_IRECLAIM \| \
f37211c3	258	XFS_IDIRTY_RELEASE \| XFS_ITRUNCATED)
778e24bb	259
1da177e4 LT	260	/*
1da177e4 LT	261	* Flags for inode locking.
f7c66ce3 LM	262	* Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
f7c66ce3 LM	263	* 1<<16 - 1<<32-1 -- lockdep annotation (integers)
1da177e4	264	*/
f7c66ce3 LM	265	#define XFS_IOLOCK_EXCL (1<<0)
	266	#define XFS_IOLOCK_SHARED (1<<1)
	267	#define XFS_ILOCK_EXCL (1<<2)
	268	#define XFS_ILOCK_SHARED (1<<3)
653c60b6 DC	269	#define XFS_MMAPLOCK_EXCL (1<<4)
653c60b6 DC	270	#define XFS_MMAPLOCK_SHARED (1<<5)
1da177e4	271
f7c66ce3	272	#define XFS_LOCK_MASK (XFS_IOLOCK_EXCL \| XFS_IOLOCK_SHARED \
653c60b6 DC	273	\| XFS_ILOCK_EXCL \| XFS_ILOCK_SHARED \
653c60b6 DC	274	\| XFS_MMAPLOCK_EXCL \| XFS_MMAPLOCK_SHARED)
f7c66ce3	275
0b1b213f CH	276	#define XFS_LOCK_FLAGS \
	277	{ XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
	278	{ XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
	279	{ XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
653c60b6 DC	280	{ XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \
	281	{ XFS_MMAPLOCK_EXCL, "MMAPLOCK_EXCL" }, \
	282	{ XFS_MMAPLOCK_SHARED, "MMAPLOCK_SHARED" }
0b1b213f CH	283
0b1b213f CH	284
f7c66ce3 LM	285	/*
	286	* Flags for lockdep annotations.
	287	*
9681153b	288	* XFS_LOCK_PARENT - for directory operations that require locking a
0952c818 DC	289	* parent directory inode and a child entry inode. IOLOCK requires nesting,
	290	* MMAPLOCK does not support this class, ILOCK requires a single subclass
	291	* to differentiate parent from child.
9681153b CH	292	*
	293	* XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
	294	* inodes do not participate in the normal lock order, and thus have their
	295	* own subclasses.
f7c66ce3	296	*
0f1145cc	297	* XFS_LOCK_INUMORDER - for locking several inodes at the some time
f7c66ce3 LM	298	* with xfs_lock_inodes(). This flag is used as the starting subclass
f7c66ce3 LM	299	* and each subsequent lock acquired will increment the subclass by one.
0952c818 DC	300	* However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
	301	* limited to the subclasses we can represent via nesting. We need at least
	302	* 5 inodes nest depth for the ILOCK through rename, and we also have to support
	303	* XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
	304	* and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
	305	* 8 subclasses supported by lockdep.
	306	*
	307	* This also means we have to number the sub-classes in the lowest bits of
	308	* the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
	309	* mask and we can't use bit-masking to build the subclasses. What a mess.
	310	*
	311	* Bit layout:
	312	*
	313	* Bit Lock Region
	314	* 16-19 XFS_IOLOCK_SHIFT dependencies
	315	* 20-23 XFS_MMAPLOCK_SHIFT dependencies
	316	* 24-31 XFS_ILOCK_SHIFT dependencies
	317	*
	318	* IOLOCK values
	319	*
	320	* 0-3 subclass value
65523218	321	* 4-7 unused
0952c818 DC	322	*
	323	* MMAPLOCK values
	324	*
	325	* 0-3 subclass value
	326	* 4-7 unused
	327	*
	328	* ILOCK values
	329	* 0-4 subclass values
	330	* 5 PARENT subclass (not nestable)
	331	* 6 RTBITMAP subclass (not nestable)
	332	* 7 RTSUM subclass (not nestable)
	333	*
f7c66ce3	334	*/
0952c818	335	#define XFS_IOLOCK_SHIFT 16
65523218	336	#define XFS_IOLOCK_MAX_SUBCLASS 3
0952c818	337	#define XFS_IOLOCK_DEP_MASK 0x000f0000
0952c818 DC	338
	339	#define XFS_MMAPLOCK_SHIFT 20
	340	#define XFS_MMAPLOCK_NUMORDER 0
	341	#define XFS_MMAPLOCK_MAX_SUBCLASS 3
	342	#define XFS_MMAPLOCK_DEP_MASK 0x00f00000
	343
	344	#define XFS_ILOCK_SHIFT 24
	345	#define XFS_ILOCK_PARENT_VAL 5
	346	#define XFS_ILOCK_MAX_SUBCLASS (XFS_ILOCK_PARENT_VAL - 1)
	347	#define XFS_ILOCK_RTBITMAP_VAL 6
	348	#define XFS_ILOCK_RTSUM_VAL 7
	349	#define XFS_ILOCK_DEP_MASK 0xff000000
	350	#define XFS_ILOCK_PARENT (XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT)
	351	#define XFS_ILOCK_RTBITMAP (XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT)
	352	#define XFS_ILOCK_RTSUM (XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT)
	353
	354	#define XFS_LOCK_SUBCLASS_MASK (XFS_IOLOCK_DEP_MASK \| \
653c60b6 DC	355	XFS_MMAPLOCK_DEP_MASK \| \
	356	XFS_ILOCK_DEP_MASK)
	357
	358	#define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) \
	359	>> XFS_IOLOCK_SHIFT)
	360	#define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \
	361	>> XFS_MMAPLOCK_SHIFT)
	362	#define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) \
	363	>> XFS_ILOCK_SHIFT)
1da177e4	364
69eb5fa1 DW	365	/*
	366	* Layouts are broken in the BREAK_WRITE case to ensure that
	367	* layout-holders do not collide with local writes. Additionally,
	368	* layouts are broken in the BREAK_UNMAP case to make sure the
	369	* layout-holder has a consistent view of the file's extent map. While
	370	* BREAK_WRITE breaks can be satisfied by recalling FL_LAYOUT leases,
	371	* BREAK_UNMAP breaks additionally require waiting for busy dax-pages to
	372	* go idle.
	373	*/
	374	enum layout_break_reason {
	375	BREAK_WRITE,
	376	BREAK_UNMAP,
	377	};
	378
1da177e4 LT	379	/*
	380	* For multiple groups support: if S_ISGID bit is set in the parent
	381	* directory, group of new file is set to that of the parent, and
	382	* new subdirectory gets S_ISGID bit from parent.
	383	*/
bd186aa9 CH	384	#define XFS_INHERIT_GID(pip) \
bd186aa9 CH	385	(((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) \|\| \
c19b3b05	386	(VFS_I(pip)->i_mode & S_ISGID))
1da177e4	387
c24b5dfa	388	int xfs_release(struct xfs_inode *ip);
74564fb4	389	void xfs_inactive(struct xfs_inode *ip);
c24b5dfa DC	390	int xfs_lookup(struct xfs_inode dp, struct xfs_name name,
c24b5dfa DC	391	struct xfs_inode *ipp, struct xfs_name ci_name);
f736d93d CH	392	int xfs_create(struct user_namespace *mnt_userns,
f736d93d CH	393	struct xfs_inode dp, struct xfs_name name,
e6a688c3 DC	394	umode_t mode, dev_t rdev, bool need_xattr,
e6a688c3 DC	395	struct xfs_inode **ipp);
f736d93d CH	396	int xfs_create_tmpfile(struct user_namespace *mnt_userns,
f736d93d CH	397	struct xfs_inode *dp, umode_t mode,
a1f69417	398	struct xfs_inode **ipp);
c24b5dfa DC	399	int xfs_remove(struct xfs_inode dp, struct xfs_name name,
	400	struct xfs_inode *ip);
	401	int xfs_link(struct xfs_inode tdp, struct xfs_inode sip,
	402	struct xfs_name *target_name);
f736d93d CH	403	int xfs_rename(struct user_namespace *mnt_userns,
f736d93d CH	404	struct xfs_inode src_dp, struct xfs_name src_name,
c24b5dfa DC	405	struct xfs_inode src_ip, struct xfs_inode target_dp,
c24b5dfa DC	406	struct xfs_name *target_name,
d31a1825	407	struct xfs_inode *target_ip, unsigned int flags);
c24b5dfa	408
1da177e4 LT	409	void xfs_ilock(xfs_inode_t *, uint);
	410	int xfs_ilock_nowait(xfs_inode_t *, uint);
	411	void xfs_iunlock(xfs_inode_t *, uint);
	412	void xfs_ilock_demote(xfs_inode_t *, uint);
579aa9ca	413	int xfs_isilocked(xfs_inode_t *, uint);
309ecac8	414	uint xfs_ilock_data_map_shared(struct xfs_inode *);
efa70be1	415	uint xfs_ilock_attr_map_shared(struct xfs_inode *);
347d1c01	416
1da177e4	417	uint xfs_ip2xflags(struct xfs_inode *);
0e0417f3	418	int xfs_ifree(struct xfs_trans , struct xfs_inode );
4e529339 BF	419	int xfs_itruncate_extents_flags(struct xfs_trans **,
4e529339 BF	420	struct xfs_inode *, int, xfs_fsize_t, int);
1da177e4	421	void xfs_iext_realloc(xfs_inode_t *, int, int);
1fd7115e	422
54fbdd10	423	int xfs_log_force_inode(struct xfs_inode *ip);
777df5af	424	void xfs_iunpin_wait(xfs_inode_t *);
1fd7115e DC	425	#define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
1fd7115e DC	426
5717ea4d	427	int xfs_iflush_cluster(struct xfs_buf *);
7c2d238a DW	428	void xfs_lock_two_inodes(struct xfs_inode *ip0, uint ip0_mode,
7c2d238a DW	429	struct xfs_inode *ip1, uint ip1_mode);
1da177e4	430
2a0ec1d9	431	xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip);
f7ca3522	432	xfs_extlen_t xfs_get_cowextsz_hint(struct xfs_inode *ip);
2a0ec1d9	433
b652afd9 DC	434	int xfs_init_new_inode(struct user_namespace mnt_userns, struct xfs_trans tp,
	435	struct xfs_inode *pip, xfs_ino_t ino, umode_t mode,
	436	xfs_nlink_t nlink, dev_t rdev, prid_t prid, bool init_xattrs,
	437	struct xfs_inode **ipp);
e546cb79	438
13b86fc3 BF	439	static inline int
	440	xfs_itruncate_extents(
	441	struct xfs_trans **tpp,
	442	struct xfs_inode *ip,
	443	int whichfork,
	444	xfs_fsize_t new_size)
	445	{
4e529339	446	return xfs_itruncate_extents_flags(tpp, ip, whichfork, new_size, 0);
13b86fc3 BF	447	}
13b86fc3 BF	448
c24b5dfa	449	/* from xfs_file.c */
8add71ca CH	450	enum xfs_prealloc_flags {
	451	XFS_PREALLOC_SET = (1 << 1),
	452	XFS_PREALLOC_CLEAR = (1 << 2),
	453	XFS_PREALLOC_SYNC = (1 << 3),
	454	XFS_PREALLOC_INVISIBLE = (1 << 4),
	455	};
	456
5885ebda DC	457	int xfs_update_prealloc_flags(struct xfs_inode *ip,
5885ebda DC	458	enum xfs_prealloc_flags flags);
69eb5fa1 DW	459	int xfs_break_layouts(struct inode inode, uint iolock,
69eb5fa1 DW	460	enum layout_break_reason reason);
c24b5dfa	461
58c90473	462	/* from xfs_iops.c */
2b3d1d41 CH	463	extern void xfs_setup_inode(struct xfs_inode *ip);
2b3d1d41 CH	464	extern void xfs_setup_iops(struct xfs_inode *ip);
840d493d	465	extern void xfs_diflags_to_iflags(struct xfs_inode *ip, bool init);
2b3d1d41	466
58c90473 DC	467	/*
	468	* When setting up a newly allocated inode, we need to call
	469	* xfs_finish_inode_setup() once the inode is fully instantiated at
	470	* the VFS level to prevent the rest of the world seeing the inode
	471	* before we've completed instantiation. Otherwise we can do it
	472	* the moment the inode lookup is complete.
	473	*/
58c90473 DC	474	static inline void xfs_finish_inode_setup(struct xfs_inode *ip)
	475	{
	476	xfs_iflags_clear(ip, XFS_INEW);
	477	barrier();
	478	unlock_new_inode(VFS_I(ip));
756baca2	479	wake_up_bit(&ip->i_flags, __XFS_INEW_BIT);
58c90473 DC	480	}
	481
	482	static inline void xfs_setup_existing_inode(struct xfs_inode *ip)
	483	{
	484	xfs_setup_inode(ip);
2b3d1d41	485	xfs_setup_iops(ip);
58c90473 DC	486	xfs_finish_inode_setup(ip);
	487	}
	488
44a8736b	489	void xfs_irele(struct xfs_inode *ip);
5a8d0f3c	490
1da177e4	491	extern struct kmem_zone *xfs_inode_zone;
1da177e4	492
e153aa79 DW	493	/* The default CoW extent size hint. */
	494	#define XFS_DEFAULT_COWEXTSZ_HINT 32
	495
62af7d54 DW	496	bool xfs_inode_needs_inactive(struct xfs_inode *ip);
62af7d54 DW	497
9b247179 DW	498	int xfs_iunlink_init(struct xfs_perag *pag);
	499	void xfs_iunlink_destroy(struct xfs_perag *pag);
	500
cb357bf3 DW	501	void xfs_end_io(struct work_struct *work);
cb357bf3 DW	502
e2aaee9c DW	503	int xfs_ilock2_io_mmap(struct xfs_inode ip1, struct xfs_inode ip2);
	504	void xfs_iunlock2_io_mmap(struct xfs_inode ip1, struct xfs_inode ip2);
	505
1da177e4	506	#endif /* __XFS_INODE_H__ */