[linux-2.6-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 */

	/* operations vectors */
	const struct xfs_dir_ops *d_ops;		/* directory ops vector */

	/* 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 */
	spinlock_t		i_flags_lock;	/* inode i_flags lock */
	/* Miscellaneous state. */
	unsigned long		i_flags;	/* see defined flags below */
	unsigned int		i_delayed_blks;	/* count of delay alloc blks */

	struct xfs_icdinode	i_d;		/* most of ondisk inode */

	xfs_extnum_t		i_cnextents;	/* # of extents in cow fork */
	unsigned int		i_cformat;	/* format of cow fork */

	/* VFS inode */
	struct inode		i_vnode;	/* embedded VFS inode */
} 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_d.di_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_d.di_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;
}

/*
 * Project quota id helpers (previously projid was 16bit only
 * and using two 16bit values to hold new 32bit projid was chosen
 * to retain compatibility with "old" filesystems).
 */
static inline prid_t
xfs_get_projid(struct xfs_inode *ip)
{
	return (prid_t)ip->i_d.di_projid_hi << 16 | ip->i_d.di_projid_lo;
}

static inline void
xfs_set_projid(struct xfs_inode *ip,
		prid_t projid)
{
	ip->i_d.di_projid_hi = (uint16_t) (projid >> 16);
	ip->i_d.di_projid_lo = (uint16_t) (projid & 0xffff);
}

static inline prid_t
xfs_get_initial_prid(struct xfs_inode *dp)
{
	if (dp->i_d.di_flags & XFS_DIFLAG_PROJINHERIT)
		return xfs_get_projid(dp);

	return XFS_PROJID_DEFAULT;
}

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

/*
 * 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;
}

/*
 * 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_ITRUNCATED		(1 << 5) /* truncated down so flush-on-close */
#define XFS_IDIRTY_RELEASE	(1 << 6) /* dirty release already seen */
#define __XFS_IFLOCK_BIT	7	 /* inode is being flushed right now */
#define XFS_IFLOCK		(1 << __XFS_IFLOCK_BIT)
#define __XFS_IPINNED_BIT	8	 /* wakeup key for zero pin count */
#define XFS_IPINNED		(1 << __XFS_IPINNED_BIT)
#define XFS_IDONTCACHE		(1 << 9) /* don't cache the inode long term */
#define XFS_IEOFBLOCKS		(1 << 10)/* 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)

/*
 * Synchronize processes attempting to flush the in-core inode back to disk.
 */

static inline int xfs_isiflocked(struct xfs_inode *ip)
{
	return xfs_iflags_test(ip, XFS_IFLOCK);
}

extern void __xfs_iflock(struct xfs_inode *ip);

static inline int xfs_iflock_nowait(struct xfs_inode *ip)
{
	return !xfs_iflags_test_and_set(ip, XFS_IFLOCK);
}

static inline void xfs_iflock(struct xfs_inode *ip)
{
	if (!xfs_iflock_nowait(ip))
		__xfs_iflock(ip);
}

static inline void xfs_ifunlock(struct xfs_inode *ip)
{
	ASSERT(xfs_isiflocked(ip));
	xfs_iflags_clear(ip, XFS_IFLOCK);
	smp_mb();
	wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT);
}

/*
 * 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 xfs_inode *dp, struct xfs_name *name,
			   umode_t mode, dev_t rdev, struct xfs_inode **ipp);
int		xfs_create_tmpfile(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 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);

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

int		xfs_iflush(struct xfs_inode *, 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_dir_ialloc(struct xfs_trans **, struct xfs_inode *, umode_t,
			       xfs_nlink_t, dev_t, prid_t,
			       struct xfs_inode **);

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);

/*
 * 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_verify_forks(struct xfs_inode *ip);

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

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