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

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

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

/*
 * 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_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);

void xfs_end_io(struct work_struct *work);

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