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

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

/*
 * 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_IFILESTREAM		(1 << 4) /* inode is in a filestream dir. */
#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 | \
	 XFS_IFILESTREAM);

/*
 * 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_LOCK_MASK		(XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
				| XFS_ILOCK_EXCL | XFS_ILOCK_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" }


/*
 * Flags for lockdep annotations.
 *
 * XFS_LOCK_PARENT - for directory operations that require locking a
 * parent directory inode and a child entry inode.  The parent gets locked
 * with this flag so it gets a lockdep subclass of 1 and the child entry
 * lock will have a lockdep subclass of 0.
 *
 * 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.
 * So the first lock acquired will have a lockdep subclass of 4, the
 * second lock will have a lockdep subclass of 5, and so on. It is
 * the responsibility of the class builder to shift this to the correct
 * portion of the lock_mode lockdep mask.
 */
#define XFS_LOCK_PARENT		1
#define XFS_LOCK_RTBITMAP	2
#define XFS_LOCK_RTSUM		3
#define XFS_LOCK_INUMORDER	4

#define XFS_IOLOCK_SHIFT	16
#define	XFS_IOLOCK_PARENT	(XFS_LOCK_PARENT << XFS_IOLOCK_SHIFT)

#define XFS_ILOCK_SHIFT		24
#define	XFS_ILOCK_PARENT	(XFS_LOCK_PARENT << XFS_ILOCK_SHIFT)
#define	XFS_ILOCK_RTBITMAP	(XFS_LOCK_RTBITMAP << XFS_ILOCK_SHIFT)
#define	XFS_ILOCK_RTSUM		(XFS_LOCK_RTSUM << XFS_ILOCK_SHIFT)

#define XFS_IOLOCK_DEP_MASK	0x00ff0000
#define XFS_ILOCK_DEP_MASK	0xff000000
#define XFS_LOCK_DEP_MASK	(XFS_IOLOCK_DEP_MASK | XFS_ILOCK_DEP_MASK)

#define XFS_IOLOCK_DEP(flags)	(((flags) & XFS_IOLOCK_DEP_MASK) >> XFS_IOLOCK_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_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);

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_map_shared(xfs_inode_t *);
void		xfs_iunlock_map_shared(xfs_inode_t *, uint);
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 *);
void		xfs_bump_ino_vers2(struct xfs_trans *, struct xfs_inode *);

/* from xfs_file.c */
int		xfs_zero_eof(struct xfs_inode *, xfs_off_t, xfs_fsize_t);
int		xfs_iozero(struct xfs_inode *, loff_t, size_t);


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

#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
	52	/* Transaction and locking information. */
1da177e4 LT	53	struct xfs_inode_log_item i_itemp; / logging information */
	54	mrlock_t i_lock; /* inode lock */
	55	mrlock_t i_iolock; /* inode IO lock */
1da177e4	56	atomic_t i_pincount; /* inode pin count */
f273ab84	57	spinlock_t i_flags_lock; /* inode i_flags lock */
1da177e4	58	/* Miscellaneous state. */
49e4c70e	59	unsigned long i_flags; /* see defined flags below */
1da177e4 LT	60	unsigned int i_delayed_blks; /* count of delay alloc blks */
1da177e4 LT	61
347d1c01	62	xfs_icdinode_t i_d; /* most of ondisk inode */
1da177e4	63
bf904248 DC	64	/* VFS inode */
bf904248 DC	65	struct inode i_vnode; /* embedded VFS inode */
1da177e4 LT	66	} xfs_inode_t;
1da177e4 LT	67
01651646 DC	68	/* Convert from vfs inode to xfs inode */
	69	static inline struct xfs_inode XFS_I(struct inode inode)
	70	{
bf904248	71	return container_of(inode, struct xfs_inode, i_vnode);
01651646 DC	72	}
01651646 DC	73
01651646 DC	74	/* convert from xfs inode to vfs inode */
	75	static inline struct inode VFS_I(struct xfs_inode ip)
	76	{
bf904248	77	return &ip->i_vnode;
01651646	78	}
01651646	79
ce7ae151 CH	80	/*
	81	* For regular files we only update the on-disk filesize when actually
	82	* writing data back to disk. Until then only the copy in the VFS inode
	83	* is uptodate.
	84	*/
	85	static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip)
	86	{
	87	if (S_ISREG(ip->i_d.di_mode))
	88	return i_size_read(VFS_I(ip));
	89	return ip->i_d.di_size;
	90	}
	91
6923e686 CH	92	/*
	93	* If this I/O goes past the on-disk inode size update it unless it would
	94	* be past the current in-core inode size.
	95	*/
	96	static inline xfs_fsize_t
	97	xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size)
	98	{
	99	xfs_fsize_t i_size = i_size_read(VFS_I(ip));
	100
	101	if (new_size > i_size)
	102	new_size = i_size;
	103	return new_size > ip->i_d.di_size ? new_size : 0;
	104	}
	105
7a18c386 DC	106	/*
	107	* i_flags helper functions
	108	*/
	109	static inline void
	110	__xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
	111	{
	112	ip->i_flags \|= flags;
	113	}
	114
	115	static inline void
	116	xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
	117	{
	118	spin_lock(&ip->i_flags_lock);
	119	__xfs_iflags_set(ip, flags);
	120	spin_unlock(&ip->i_flags_lock);
	121	}
	122
	123	static inline void
	124	xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags)
	125	{
	126	spin_lock(&ip->i_flags_lock);
	127	ip->i_flags &= ~flags;
	128	spin_unlock(&ip->i_flags_lock);
	129	}
	130
	131	static inline int
	132	__xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
	133	{
	134	return (ip->i_flags & flags);
	135	}
	136
	137	static inline int
	138	xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
	139	{
	140	int ret;
	141	spin_lock(&ip->i_flags_lock);
	142	ret = __xfs_iflags_test(ip, flags);
	143	spin_unlock(&ip->i_flags_lock);
	144	return ret;
	145	}
09262b43 CH	146
	147	static inline int
	148	xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags)
	149	{
	150	int ret;
	151
	152	spin_lock(&ip->i_flags_lock);
	153	ret = ip->i_flags & flags;
	154	if (ret)
	155	ip->i_flags &= ~flags;
	156	spin_unlock(&ip->i_flags_lock);
	157	return ret;
	158	}
1da177e4	159
474fce06 CH	160	static inline int
	161	xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags)
	162	{
	163	int ret;
	164
	165	spin_lock(&ip->i_flags_lock);
	166	ret = ip->i_flags & flags;
	167	if (!ret)
	168	ip->i_flags \|= flags;
	169	spin_unlock(&ip->i_flags_lock);
	170	return ret;
	171	}
	172
6743099c AM	173	/*
6743099c AM	174	* Project quota id helpers (previously projid was 16bit only
25985edc	175	* and using two 16bit values to hold new 32bit projid was chosen
6743099c AM	176	* to retain compatibility with "old" filesystems).
	177	*/
	178	static inline prid_t
	179	xfs_get_projid(struct xfs_inode *ip)
	180	{
	181	return (prid_t)ip->i_d.di_projid_hi << 16 \| ip->i_d.di_projid_lo;
	182	}
	183
	184	static inline void
	185	xfs_set_projid(struct xfs_inode *ip,
	186	prid_t projid)
	187	{
	188	ip->i_d.di_projid_hi = (__uint16_t) (projid >> 16);
	189	ip->i_d.di_projid_lo = (__uint16_t) (projid & 0xffff);
	190	}
	191
1da177e4 LT	192	/*
	193	* In-core inode flags.
	194	*/
474fce06 CH	195	#define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */
	196	#define XFS_ISTALE (1 << 1) /* inode has been staled */
	197	#define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */
	198	#define XFS_INEW (1 << 3) /* inode has just been allocated */
	199	#define XFS_IFILESTREAM (1 << 4) /* inode is in a filestream dir. */
	200	#define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */
	201	#define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */
	202	#define __XFS_IFLOCK_BIT 7 /* inode is being flushed right now */
	203	#define XFS_IFLOCK (1 << __XFS_IFLOCK_BIT)
f392e631 CH	204	#define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */
f392e631 CH	205	#define XFS_IPINNED (1 << __XFS_IPINNED_BIT)
5132ba8f	206	#define XFS_IDONTCACHE (1 << 9) /* don't cache the inode long term */
1da177e4	207
778e24bb DC	208	/*
778e24bb DC	209	* Per-lifetime flags need to be reset when re-using a reclaimable inode during
5132ba8f	210	* inode lookup. This prevents unintended behaviour on the new inode from
778e24bb DC	211	* ocurring.
	212	*/
	213	#define XFS_IRECLAIM_RESET_FLAGS \
	214	(XFS_IRECLAIMABLE \| XFS_IRECLAIM \| \
	215	XFS_IDIRTY_RELEASE \| XFS_ITRUNCATED \| \
	216	XFS_IFILESTREAM);
	217
474fce06 CH	218	/*
	219	* Synchronize processes attempting to flush the in-core inode back to disk.
	220	*/
	221
	222	extern void __xfs_iflock(struct xfs_inode *ip);
	223
	224	static inline int xfs_iflock_nowait(struct xfs_inode *ip)
	225	{
	226	return !xfs_iflags_test_and_set(ip, XFS_IFLOCK);
	227	}
	228
	229	static inline void xfs_iflock(struct xfs_inode *ip)
	230	{
	231	if (!xfs_iflock_nowait(ip))
	232	__xfs_iflock(ip);
	233	}
	234
	235	static inline void xfs_ifunlock(struct xfs_inode *ip)
	236	{
	237	xfs_iflags_clear(ip, XFS_IFLOCK);
311f08ac	238	smp_mb();
474fce06 CH	239	wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT);
	240	}
	241
	242	static inline int xfs_isiflocked(struct xfs_inode *ip)
	243	{
	244	return xfs_iflags_test(ip, XFS_IFLOCK);
	245	}
	246
1da177e4 LT	247	/*
1da177e4 LT	248	* Flags for inode locking.
f7c66ce3 LM	249	* Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
f7c66ce3 LM	250	* 1<<16 - 1<<32-1 -- lockdep annotation (integers)
1da177e4	251	*/
f7c66ce3 LM	252	#define XFS_IOLOCK_EXCL (1<<0)
	253	#define XFS_IOLOCK_SHARED (1<<1)
	254	#define XFS_ILOCK_EXCL (1<<2)
	255	#define XFS_ILOCK_SHARED (1<<3)
1da177e4	256
f7c66ce3	257	#define XFS_LOCK_MASK (XFS_IOLOCK_EXCL \| XFS_IOLOCK_SHARED \
579aa9ca	258	\| XFS_ILOCK_EXCL \| XFS_ILOCK_SHARED)
f7c66ce3	259
0b1b213f CH	260	#define XFS_LOCK_FLAGS \
	261	{ XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
	262	{ XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
	263	{ XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
5b03ff1b	264	{ XFS_ILOCK_SHARED, "ILOCK_SHARED" }
0b1b213f CH	265
0b1b213f CH	266
f7c66ce3 LM	267	/*
	268	* Flags for lockdep annotations.
	269	*
9681153b CH	270	* XFS_LOCK_PARENT - for directory operations that require locking a
	271	* parent directory inode and a child entry inode. The parent gets locked
	272	* with this flag so it gets a lockdep subclass of 1 and the child entry
	273	* lock will have a lockdep subclass of 0.
	274	*
	275	* XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
	276	* inodes do not participate in the normal lock order, and thus have their
	277	* own subclasses.
f7c66ce3	278	*
0f1145cc	279	* XFS_LOCK_INUMORDER - for locking several inodes at the some time
f7c66ce3 LM	280	* with xfs_lock_inodes(). This flag is used as the starting subclass
f7c66ce3 LM	281	* and each subsequent lock acquired will increment the subclass by one.
9681153b CH	282	* So the first lock acquired will have a lockdep subclass of 4, the
9681153b CH	283	* second lock will have a lockdep subclass of 5, and so on. It is
0f1145cc DC	284	* the responsibility of the class builder to shift this to the correct
0f1145cc DC	285	* portion of the lock_mode lockdep mask.
f7c66ce3	286	*/
0f1145cc	287	#define XFS_LOCK_PARENT 1
9681153b CH	288	#define XFS_LOCK_RTBITMAP 2
	289	#define XFS_LOCK_RTSUM 3
	290	#define XFS_LOCK_INUMORDER 4
0f1145cc	291
f7c66ce3	292	#define XFS_IOLOCK_SHIFT 16
0f1145cc	293	#define XFS_IOLOCK_PARENT (XFS_LOCK_PARENT << XFS_IOLOCK_SHIFT)
f7c66ce3 LM	294
f7c66ce3 LM	295	#define XFS_ILOCK_SHIFT 24
0f1145cc	296	#define XFS_ILOCK_PARENT (XFS_LOCK_PARENT << XFS_ILOCK_SHIFT)
9681153b CH	297	#define XFS_ILOCK_RTBITMAP (XFS_LOCK_RTBITMAP << XFS_ILOCK_SHIFT)
9681153b CH	298	#define XFS_ILOCK_RTSUM (XFS_LOCK_RTSUM << XFS_ILOCK_SHIFT)
f7c66ce3 LM	299
	300	#define XFS_IOLOCK_DEP_MASK 0x00ff0000
	301	#define XFS_ILOCK_DEP_MASK 0xff000000
	302	#define XFS_LOCK_DEP_MASK (XFS_IOLOCK_DEP_MASK \| XFS_ILOCK_DEP_MASK)
	303
	304	#define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) >> XFS_IOLOCK_SHIFT)
	305	#define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) >> XFS_ILOCK_SHIFT)
1da177e4	306
1da177e4 LT	307	/*
	308	* For multiple groups support: if S_ISGID bit is set in the parent
	309	* directory, group of new file is set to that of the parent, and
	310	* new subdirectory gets S_ISGID bit from parent.
	311	*/
bd186aa9 CH	312	#define XFS_INHERIT_GID(pip) \
	313	(((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) \|\| \
	314	((pip)->i_d.di_mode & S_ISGID))
1da177e4	315
33479e05	316
c24b5dfa	317	int xfs_release(struct xfs_inode *ip);
74564fb4	318	void xfs_inactive(struct xfs_inode *ip);
c24b5dfa DC	319	int xfs_lookup(struct xfs_inode dp, struct xfs_name name,
	320	struct xfs_inode *ipp, struct xfs_name ci_name);
	321	int xfs_create(struct xfs_inode dp, struct xfs_name name,
	322	umode_t mode, xfs_dev_t rdev, struct xfs_inode **ipp);
	323	int xfs_remove(struct xfs_inode dp, struct xfs_name name,
	324	struct xfs_inode *ip);
	325	int xfs_link(struct xfs_inode tdp, struct xfs_inode sip,
	326	struct xfs_name *target_name);
	327	int xfs_rename(struct xfs_inode src_dp, struct xfs_name src_name,
	328	struct xfs_inode src_ip, struct xfs_inode target_dp,
	329	struct xfs_name *target_name,
	330	struct xfs_inode *target_ip);
	331
1da177e4 LT	332	void xfs_ilock(xfs_inode_t *, uint);
	333	int xfs_ilock_nowait(xfs_inode_t *, uint);
	334	void xfs_iunlock(xfs_inode_t *, uint);
	335	void xfs_ilock_demote(xfs_inode_t *, uint);
579aa9ca	336	int xfs_isilocked(xfs_inode_t *, uint);
1da177e4 LT	337	uint xfs_ilock_map_shared(xfs_inode_t *);
1da177e4 LT	338	void xfs_iunlock_map_shared(xfs_inode_t *, uint);
576b1d67	339	int xfs_ialloc(struct xfs_trans , xfs_inode_t , umode_t,
6743099c	340	xfs_nlink_t, xfs_dev_t, prid_t, int,
08358906	341	struct xfs_buf , xfs_inode_t );
347d1c01	342
1da177e4	343	uint xfs_ip2xflags(struct xfs_inode *);
45ba598e	344	uint xfs_dic2xflags(struct xfs_dinode *);
1da177e4 LT	345	int xfs_ifree(struct xfs_trans , xfs_inode_t ,
1da177e4 LT	346	struct xfs_bmap_free *);
8f04c47a CH	347	int xfs_itruncate_extents(struct xfs_trans *, struct xfs_inode ,
8f04c47a CH	348	int, xfs_fsize_t);
1da177e4	349	int xfs_iunlink(struct xfs_trans , xfs_inode_t );
1da177e4	350
1da177e4	351	void xfs_iext_realloc(xfs_inode_t *, int, int);
1fd7115e	352
777df5af	353	void xfs_iunpin_wait(xfs_inode_t *);
1fd7115e DC	354	#define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
1fd7115e DC	355
4c46819a	356	int xfs_iflush(struct xfs_inode , struct xfs_buf *);
cfa853e4	357	void xfs_lock_inodes(xfs_inode_t **, int, uint);
e1cccd91	358	void xfs_lock_two_inodes(xfs_inode_t , xfs_inode_t , uint);
1da177e4	359
2a0ec1d9 DC	360	xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip);
2a0ec1d9 DC	361
e546cb79 DC	362	int xfs_dir_ialloc(struct xfs_trans *, struct xfs_inode , umode_t,
	363	xfs_nlink_t, xfs_dev_t, prid_t, int,
	364	struct xfs_inode *, int );
	365	int xfs_droplink(struct xfs_trans , struct xfs_inode );
	366	int xfs_bumplink(struct xfs_trans , struct xfs_inode );
	367	void xfs_bump_ino_vers2(struct xfs_trans , struct xfs_inode );
	368
c24b5dfa DC	369	/* from xfs_file.c */
	370	int xfs_zero_eof(struct xfs_inode *, xfs_off_t, xfs_fsize_t);
	371	int xfs_iozero(struct xfs_inode *, loff_t, size_t);
	372
	373
5a8d0f3c CH	374	#define IHOLD(ip) \
	375	do { \
	376	ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \
7de9c6ee	377	ihold(VFS_I(ip)); \
0b1b213f	378	trace_xfs_ihold(ip, _THIS_IP_); \
5a8d0f3c CH	379	} while (0)
	380
	381	#define IRELE(ip) \
	382	do { \
0b1b213f	383	trace_xfs_irele(ip, _THIS_IP_); \
5a8d0f3c CH	384	iput(VFS_I(ip)); \
	385	} while (0)
	386
1da177e4	387	extern struct kmem_zone *xfs_inode_zone;
1da177e4	388
1da177e4	389	#endif /* __XFS_INODE_H__ */