[linux-2.6-block.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_bmap_free;
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_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_iolock;	/* inode IO 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 */

	xfs_icdinode_t		i_d;		/* most of ondisk inode */

	/* 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(ip->i_d.di_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;
}

/*
 * 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		(1 << 3) /* inode has just been allocated */
#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 */

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

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)
{
	xfs_iflags_clear(ip, XFS_IFLOCK);
	smp_mb();
	wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT);
}

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

/*
 * 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		PARENT subclass values
 *
 * 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_PARENT_VAL		4
#define XFS_IOLOCK_MAX_SUBCLASS		(XFS_IOLOCK_PARENT_VAL - 1)
#define XFS_IOLOCK_DEP_MASK		0x000f0000
#define	XFS_IOLOCK_PARENT		(XFS_IOLOCK_PARENT_VAL << XFS_IOLOCK_SHIFT)

#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) || \
	 ((pip)->i_d.di_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 *);
int		xfs_ialloc(struct xfs_trans *, xfs_inode_t *, umode_t,
			   xfs_nlink_t, xfs_dev_t, prid_t, int,
			   struct xfs_buf **, xfs_inode_t **);

uint		xfs_ip2xflags(struct xfs_inode *);
uint		xfs_dic2xflags(struct xfs_dinode *);
int		xfs_ifree(struct xfs_trans *, xfs_inode_t *,
			   struct xfs_bmap_free *);
int		xfs_itruncate_extents(struct xfs_trans **, struct xfs_inode *,
				      int, xfs_fsize_t);
int		xfs_iunlink(struct xfs_trans *, xfs_inode_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_inodes(xfs_inode_t **, int, uint);
void		xfs_lock_two_inodes(xfs_inode_t *, xfs_inode_t *, uint);

xfs_extlen_t	xfs_get_extsz_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 *);
int		xfs_droplink(struct xfs_trans *, struct xfs_inode *);
int		xfs_bumplink(struct xfs_trans *, struct xfs_inode *);

/* 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_iozero(struct xfs_inode *ip, loff_t pos, size_t count);


/* from xfs_iops.c */
/*
 * 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.
 */
extern void xfs_setup_inode(struct xfs_inode *ip);
static inline void xfs_finish_inode_setup(struct xfs_inode *ip)
{
	xfs_iflags_clear(ip, XFS_INEW);
	barrier();
	unlock_new_inode(VFS_I(ip));
}

static inline void xfs_setup_existing_inode(struct xfs_inode *ip)
{
	xfs_setup_inode(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;

/*
 * Flags for read/write calls
 */
#define XFS_IO_ISDIRECT	0x00001		/* bypass page cache */
#define XFS_IO_INVIS	0x00002		/* don't update inode timestamps */

#define XFS_IO_FLAGS \
	{ XFS_IO_ISDIRECT,	"DIRECT" }, \
	{ XFS_IO_INVIS,		"INVIS"}

#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 BN	29	struct xfs_buf;
	30	struct xfs_bmap_free;
	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 */
	50	xfs_ifork_t i_df; /* data fork */
	51
32c5483a DC	52	/* operations vectors */
	53	const struct xfs_dir_ops d_ops; / directory ops vector */
	54
1da177e4	55	/* Transaction and locking information. */
1da177e4 LT	56	struct xfs_inode_log_item i_itemp; / logging information */
	57	mrlock_t i_lock; /* inode lock */
	58	mrlock_t i_iolock; /* inode IO 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
347d1c01	66	xfs_icdinode_t i_d; /* most of ondisk inode */
1da177e4	67
bf904248 DC	68	/* VFS inode */
bf904248 DC	69	struct inode i_vnode; /* embedded VFS inode */
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	{
	91	if (S_ISREG(ip->i_d.di_mode))
	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	{
	192	ip->i_d.di_projid_hi = (__uint16_t) (projid >> 16);
	193	ip->i_d.di_projid_lo = (__uint16_t) (projid & 0xffff);
	194	}
	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
1da177e4 LT	205	/*
	206	* In-core inode flags.
	207	*/
474fce06 CH	208	#define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */
	209	#define XFS_ISTALE (1 << 1) /* inode has been staled */
	210	#define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */
	211	#define XFS_INEW (1 << 3) /* inode has just been allocated */
474fce06 CH	212	#define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */
	213	#define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */
	214	#define __XFS_IFLOCK_BIT 7 /* inode is being flushed right now */
	215	#define XFS_IFLOCK (1 << __XFS_IFLOCK_BIT)
f392e631 CH	216	#define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */
f392e631 CH	217	#define XFS_IPINNED (1 << __XFS_IPINNED_BIT)
5132ba8f	218	#define XFS_IDONTCACHE (1 << 9) /* don't cache the inode long term */
1da177e4	219
778e24bb DC	220	/*
778e24bb DC	221	* Per-lifetime flags need to be reset when re-using a reclaimable inode during
5132ba8f	222	* inode lookup. This prevents unintended behaviour on the new inode from
778e24bb DC	223	* ocurring.
	224	*/
	225	#define XFS_IRECLAIM_RESET_FLAGS \
	226	(XFS_IRECLAIMABLE \| XFS_IRECLAIM \| \
f37211c3	227	XFS_IDIRTY_RELEASE \| XFS_ITRUNCATED)
778e24bb	228
474fce06 CH	229	/*
	230	* Synchronize processes attempting to flush the in-core inode back to disk.
	231	*/
	232
	233	extern void __xfs_iflock(struct xfs_inode *ip);
	234
	235	static inline int xfs_iflock_nowait(struct xfs_inode *ip)
	236	{
	237	return !xfs_iflags_test_and_set(ip, XFS_IFLOCK);
	238	}
	239
	240	static inline void xfs_iflock(struct xfs_inode *ip)
	241	{
	242	if (!xfs_iflock_nowait(ip))
	243	__xfs_iflock(ip);
	244	}
	245
	246	static inline void xfs_ifunlock(struct xfs_inode *ip)
	247	{
	248	xfs_iflags_clear(ip, XFS_IFLOCK);
311f08ac	249	smp_mb();
474fce06 CH	250	wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT);
	251	}
	252
	253	static inline int xfs_isiflocked(struct xfs_inode *ip)
	254	{
	255	return xfs_iflags_test(ip, XFS_IFLOCK);
	256	}
	257
1da177e4 LT	258	/*
1da177e4 LT	259	* Flags for inode locking.
f7c66ce3 LM	260	* Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
f7c66ce3 LM	261	* 1<<16 - 1<<32-1 -- lockdep annotation (integers)
1da177e4	262	*/
f7c66ce3 LM	263	#define XFS_IOLOCK_EXCL (1<<0)
	264	#define XFS_IOLOCK_SHARED (1<<1)
	265	#define XFS_ILOCK_EXCL (1<<2)
	266	#define XFS_ILOCK_SHARED (1<<3)
653c60b6 DC	267	#define XFS_MMAPLOCK_EXCL (1<<4)
653c60b6 DC	268	#define XFS_MMAPLOCK_SHARED (1<<5)
1da177e4	269
f7c66ce3	270	#define XFS_LOCK_MASK (XFS_IOLOCK_EXCL \| XFS_IOLOCK_SHARED \
653c60b6 DC	271	\| XFS_ILOCK_EXCL \| XFS_ILOCK_SHARED \
653c60b6 DC	272	\| XFS_MMAPLOCK_EXCL \| XFS_MMAPLOCK_SHARED)
f7c66ce3	273
0b1b213f CH	274	#define XFS_LOCK_FLAGS \
	275	{ XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
	276	{ XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
	277	{ XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
653c60b6 DC	278	{ XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \
	279	{ XFS_MMAPLOCK_EXCL, "MMAPLOCK_EXCL" }, \
	280	{ XFS_MMAPLOCK_SHARED, "MMAPLOCK_SHARED" }
0b1b213f CH	281
0b1b213f CH	282
f7c66ce3 LM	283	/*
	284	* Flags for lockdep annotations.
	285	*
9681153b	286	* XFS_LOCK_PARENT - for directory operations that require locking a
0952c818 DC	287	* parent directory inode and a child entry inode. IOLOCK requires nesting,
	288	* MMAPLOCK does not support this class, ILOCK requires a single subclass
	289	* to differentiate parent from child.
9681153b CH	290	*
	291	* XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
	292	* inodes do not participate in the normal lock order, and thus have their
	293	* own subclasses.
f7c66ce3	294	*
0f1145cc	295	* XFS_LOCK_INUMORDER - for locking several inodes at the some time
f7c66ce3 LM	296	* with xfs_lock_inodes(). This flag is used as the starting subclass
f7c66ce3 LM	297	* and each subsequent lock acquired will increment the subclass by one.
0952c818 DC	298	* However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
	299	* limited to the subclasses we can represent via nesting. We need at least
	300	* 5 inodes nest depth for the ILOCK through rename, and we also have to support
	301	* XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
	302	* and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
	303	* 8 subclasses supported by lockdep.
	304	*
	305	* This also means we have to number the sub-classes in the lowest bits of
	306	* the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
	307	* mask and we can't use bit-masking to build the subclasses. What a mess.
	308	*
	309	* Bit layout:
	310	*
	311	* Bit Lock Region
	312	* 16-19 XFS_IOLOCK_SHIFT dependencies
	313	* 20-23 XFS_MMAPLOCK_SHIFT dependencies
	314	* 24-31 XFS_ILOCK_SHIFT dependencies
	315	*
	316	* IOLOCK values
	317	*
	318	* 0-3 subclass value
	319	* 4-7 PARENT subclass values
	320	*
	321	* MMAPLOCK values
	322	*
	323	* 0-3 subclass value
	324	* 4-7 unused
	325	*
	326	* ILOCK values
	327	* 0-4 subclass values
	328	* 5 PARENT subclass (not nestable)
	329	* 6 RTBITMAP subclass (not nestable)
	330	* 7 RTSUM subclass (not nestable)
	331	*
f7c66ce3	332	*/
0952c818 DC	333	#define XFS_IOLOCK_SHIFT 16
	334	#define XFS_IOLOCK_PARENT_VAL 4
	335	#define XFS_IOLOCK_MAX_SUBCLASS (XFS_IOLOCK_PARENT_VAL - 1)
	336	#define XFS_IOLOCK_DEP_MASK 0x000f0000
	337	#define XFS_IOLOCK_PARENT (XFS_IOLOCK_PARENT_VAL << XFS_IOLOCK_SHIFT)
	338
	339	#define XFS_MMAPLOCK_SHIFT 20
	340	#define XFS_MMAPLOCK_NUMORDER 0
	341	#define XFS_MMAPLOCK_MAX_SUBCLASS 3
	342	#define XFS_MMAPLOCK_DEP_MASK 0x00f00000
	343
	344	#define XFS_ILOCK_SHIFT 24
	345	#define XFS_ILOCK_PARENT_VAL 5
	346	#define XFS_ILOCK_MAX_SUBCLASS (XFS_ILOCK_PARENT_VAL - 1)
	347	#define XFS_ILOCK_RTBITMAP_VAL 6
	348	#define XFS_ILOCK_RTSUM_VAL 7
	349	#define XFS_ILOCK_DEP_MASK 0xff000000
	350	#define XFS_ILOCK_PARENT (XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT)
	351	#define XFS_ILOCK_RTBITMAP (XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT)
	352	#define XFS_ILOCK_RTSUM (XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT)
	353
	354	#define XFS_LOCK_SUBCLASS_MASK (XFS_IOLOCK_DEP_MASK \| \
653c60b6 DC	355	XFS_MMAPLOCK_DEP_MASK \| \
	356	XFS_ILOCK_DEP_MASK)
	357
	358	#define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) \
	359	>> XFS_IOLOCK_SHIFT)
	360	#define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \
	361	>> XFS_MMAPLOCK_SHIFT)
	362	#define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) \
	363	>> XFS_ILOCK_SHIFT)
1da177e4	364
1da177e4 LT	365	/*
	366	* For multiple groups support: if S_ISGID bit is set in the parent
	367	* directory, group of new file is set to that of the parent, and
	368	* new subdirectory gets S_ISGID bit from parent.
	369	*/
bd186aa9 CH	370	#define XFS_INHERIT_GID(pip) \
	371	(((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) \|\| \
	372	((pip)->i_d.di_mode & S_ISGID))
1da177e4	373
c24b5dfa	374	int xfs_release(struct xfs_inode *ip);
74564fb4	375	void xfs_inactive(struct xfs_inode *ip);
c24b5dfa DC	376	int xfs_lookup(struct xfs_inode dp, struct xfs_name name,
	377	struct xfs_inode *ipp, struct xfs_name ci_name);
	378	int xfs_create(struct xfs_inode dp, struct xfs_name name,
	379	umode_t mode, xfs_dev_t rdev, struct xfs_inode **ipp);
99b6436b	380	int xfs_create_tmpfile(struct xfs_inode dp, struct dentry dentry,
330033d6	381	umode_t mode, struct xfs_inode **ipp);
c24b5dfa DC	382	int xfs_remove(struct xfs_inode dp, struct xfs_name name,
	383	struct xfs_inode *ip);
	384	int xfs_link(struct xfs_inode tdp, struct xfs_inode sip,
	385	struct xfs_name *target_name);
	386	int xfs_rename(struct xfs_inode src_dp, struct xfs_name src_name,
	387	struct xfs_inode src_ip, struct xfs_inode target_dp,
	388	struct xfs_name *target_name,
d31a1825	389	struct xfs_inode *target_ip, unsigned int flags);
c24b5dfa	390
1da177e4 LT	391	void xfs_ilock(xfs_inode_t *, uint);
	392	int xfs_ilock_nowait(xfs_inode_t *, uint);
	393	void xfs_iunlock(xfs_inode_t *, uint);
	394	void xfs_ilock_demote(xfs_inode_t *, uint);
579aa9ca	395	int xfs_isilocked(xfs_inode_t *, uint);
309ecac8	396	uint xfs_ilock_data_map_shared(struct xfs_inode *);
efa70be1	397	uint xfs_ilock_attr_map_shared(struct xfs_inode *);
576b1d67	398	int xfs_ialloc(struct xfs_trans , xfs_inode_t , umode_t,
6743099c	399	xfs_nlink_t, xfs_dev_t, prid_t, int,
08358906	400	struct xfs_buf , xfs_inode_t );
347d1c01	401
1da177e4	402	uint xfs_ip2xflags(struct xfs_inode *);
45ba598e	403	uint xfs_dic2xflags(struct xfs_dinode *);
1da177e4 LT	404	int xfs_ifree(struct xfs_trans , xfs_inode_t ,
1da177e4 LT	405	struct xfs_bmap_free *);
8f04c47a CH	406	int xfs_itruncate_extents(struct xfs_trans *, struct xfs_inode ,
8f04c47a CH	407	int, xfs_fsize_t);
1da177e4	408	int xfs_iunlink(struct xfs_trans , xfs_inode_t );
1da177e4	409
1da177e4	410	void xfs_iext_realloc(xfs_inode_t *, int, int);
1fd7115e	411
777df5af	412	void xfs_iunpin_wait(xfs_inode_t *);
1fd7115e DC	413	#define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
1fd7115e DC	414
4c46819a	415	int xfs_iflush(struct xfs_inode , struct xfs_buf *);
cfa853e4	416	void xfs_lock_inodes(xfs_inode_t **, int, uint);
e1cccd91	417	void xfs_lock_two_inodes(xfs_inode_t , xfs_inode_t , uint);
1da177e4	418
2a0ec1d9 DC	419	xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip);
2a0ec1d9 DC	420
e546cb79 DC	421	int xfs_dir_ialloc(struct xfs_trans *, struct xfs_inode , umode_t,
	422	xfs_nlink_t, xfs_dev_t, prid_t, int,
	423	struct xfs_inode *, int );
	424	int xfs_droplink(struct xfs_trans , struct xfs_inode );
	425	int xfs_bumplink(struct xfs_trans , struct xfs_inode );
e546cb79	426
c24b5dfa	427	/* from xfs_file.c */
8add71ca CH	428	enum xfs_prealloc_flags {
	429	XFS_PREALLOC_SET = (1 << 1),
	430	XFS_PREALLOC_CLEAR = (1 << 2),
	431	XFS_PREALLOC_SYNC = (1 << 3),
	432	XFS_PREALLOC_INVISIBLE = (1 << 4),
	433	};
	434
5885ebda DC	435	int xfs_update_prealloc_flags(struct xfs_inode *ip,
	436	enum xfs_prealloc_flags flags);
	437	int xfs_zero_eof(struct xfs_inode *ip, xfs_off_t offset,
	438	xfs_fsize_t isize, bool *did_zeroing);
	439	int xfs_iozero(struct xfs_inode *ip, loff_t pos, size_t count);
c24b5dfa DC	440
c24b5dfa DC	441
58c90473 DC	442	/* from xfs_iops.c */
	443	/*
	444	* When setting up a newly allocated inode, we need to call
	445	* xfs_finish_inode_setup() once the inode is fully instantiated at
	446	* the VFS level to prevent the rest of the world seeing the inode
	447	* before we've completed instantiation. Otherwise we can do it
	448	* the moment the inode lookup is complete.
	449	*/
	450	extern void xfs_setup_inode(struct xfs_inode *ip);
	451	static inline void xfs_finish_inode_setup(struct xfs_inode *ip)
	452	{
	453	xfs_iflags_clear(ip, XFS_INEW);
	454	barrier();
	455	unlock_new_inode(VFS_I(ip));
	456	}
	457
	458	static inline void xfs_setup_existing_inode(struct xfs_inode *ip)
	459	{
	460	xfs_setup_inode(ip);
	461	xfs_finish_inode_setup(ip);
	462	}
	463
5a8d0f3c CH	464	#define IHOLD(ip) \
	465	do { \
	466	ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \
7de9c6ee	467	ihold(VFS_I(ip)); \
0b1b213f	468	trace_xfs_ihold(ip, _THIS_IP_); \
5a8d0f3c CH	469	} while (0)
	470
	471	#define IRELE(ip) \
	472	do { \
0b1b213f	473	trace_xfs_irele(ip, _THIS_IP_); \
5a8d0f3c CH	474	iput(VFS_I(ip)); \
	475	} while (0)
	476
1da177e4	477	extern struct kmem_zone *xfs_inode_zone;
1da177e4	478
b92cc59f DC	479	/*
	480	* Flags for read/write calls
	481	*/
	482	#define XFS_IO_ISDIRECT 0x00001 /* bypass page cache */
	483	#define XFS_IO_INVIS 0x00002 /* don't update inode timestamps */
	484
	485	#define XFS_IO_FLAGS \
	486	{ XFS_IO_ISDIRECT, "DIRECT" }, \
	487	{ XFS_IO_INVIS, "INVIS"}
	488
1da177e4	489	#endif /* __XFS_INODE_H__ */