[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_defer_ops;
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. */
	xfs_ifork_t		*i_afp;		/* attribute fork pointer */
	xfs_ifork_t		*i_cowfp;	/* copy on write extents */
	xfs_ifork_t		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;
}

/*
 * 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 *, xfs_inode_t *,
			   struct xfs_defer_ops *);
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);
}

#define IHOLD(ip) \
do { \
	ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \
	ihold(VFS_I(ip)); \
	trace_xfs_ihold(ip, _THIS_IP_); \
} while (0)

#define IRELE(ip) \
do { \
	trace_xfs_irele(ip, _THIS_IP_); \
	iput(VFS_I(ip)); \
} while (0)

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

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