[mirror_ubuntu-artful-kernel.git] / fs / xfs / xfs_inode.h

/*
 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it would be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write the Free Software Foundation,
 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
#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)

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

/*
 * 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, xfs_dev_t rdev, struct xfs_inode **ipp);
int		xfs_create_tmpfile(struct xfs_inode *dp, struct dentry *dentry,
			   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(struct xfs_trans **, struct xfs_inode *,
				      int, xfs_fsize_t);
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(xfs_inode_t *, xfs_inode_t *, uint);

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, xfs_dev_t, prid_t, int,
			       struct xfs_inode **, int *);

/* 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_zero_eof(struct xfs_inode *ip, xfs_off_t offset,
		     xfs_fsize_t isize, bool *did_zeroing);
int	xfs_zero_range(struct xfs_inode *ip, xfs_off_t pos, xfs_off_t count,
		bool *did_zero);

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

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