[linux.git] / include / linux / nfs_fs.h

/*
 *  linux/include/linux/nfs_fs.h
 *
 *  Copyright (C) 1992  Rick Sladkey
 *
 *  OS-specific nfs filesystem definitions and declarations
 */

#ifndef _LINUX_NFS_FS_H
#define _LINUX_NFS_FS_H

#include <linux/magic.h>

/* Default timeout values */
#define NFS_MAX_UDP_TIMEOUT	(60*HZ)
#define NFS_MAX_TCP_TIMEOUT	(600*HZ)

/*
 * When flushing a cluster of dirty pages, there can be different
 * strategies:
 */
#define FLUSH_SYNC		1	/* file being synced, or contention */
#define FLUSH_STABLE		4	/* commit to stable storage */
#define FLUSH_LOWPRI		8	/* low priority background flush */
#define FLUSH_HIGHPRI		16	/* high priority memory reclaim flush */
#define FLUSH_NOCOMMIT		32	/* Don't send the NFSv3/v4 COMMIT */
#define FLUSH_INVALIDATE	64	/* Invalidate the page cache */
#define FLUSH_NOWRITEPAGE	128	/* Don't call writepage() */

#ifdef __KERNEL__

#include <linux/in.h>
#include <linux/kref.h>
#include <linux/mm.h>
#include <linux/namei.h>
#include <linux/pagemap.h>
#include <linux/rbtree.h>
#include <linux/rwsem.h>
#include <linux/wait.h>

#include <linux/sunrpc/debug.h>
#include <linux/sunrpc/auth.h>
#include <linux/sunrpc/clnt.h>

#include <linux/nfs.h>
#include <linux/nfs2.h>
#include <linux/nfs3.h>
#include <linux/nfs4.h>
#include <linux/nfs_xdr.h>

#include <linux/nfs_fs_sb.h>

#include <linux/rwsem.h>
#include <linux/mempool.h>

/*
 * These are the default flags for swap requests
 */
#define NFS_RPC_SWAPFLAGS		(RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)

/*
 * NFSv3/v4 Access mode cache entry
 */
struct nfs_access_entry {
	struct rb_node		rb_node;
	struct list_head	lru;
	unsigned long		jiffies;
	struct rpc_cred *	cred;
	int			mask;
};

struct nfs4_state;
struct nfs_open_context {
	atomic_t count;
	struct path path;
	struct rpc_cred *cred;
	struct nfs4_state *state;
	fl_owner_t lockowner;
	int mode;
	int error;

	struct list_head list;

	__u64 dir_cookie;
};

/*
 * NFSv4 delegation
 */
struct nfs_delegation;

struct posix_acl;

/*
 * nfs fs inode data in memory
 */
struct nfs_inode {
	/*
	 * The 64bit 'inode number'
	 */
	__u64 fileid;

	/*
	 * NFS file handle
	 */
	struct nfs_fh		fh;

	/*
	 * Various flags
	 */
	unsigned long		flags;			/* atomic bit ops */
	unsigned long		cache_validity;		/* bit mask */

	/*
	 * read_cache_jiffies is when we started read-caching this inode.
	 * attrtimeo is for how long the cached information is assumed
	 * to be valid. A successful attribute revalidation doubles
	 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
	 * acregmin/acdirmin.
	 *
	 * We need to revalidate the cached attrs for this inode if
	 *
	 *	jiffies - read_cache_jiffies > attrtimeo
	 */
	unsigned long		read_cache_jiffies;
	unsigned long		attrtimeo;
	unsigned long		attrtimeo_timestamp;
	__u64			change_attr;		/* v4 only */

	unsigned long		last_updated;
	/* "Generation counter" for the attribute cache. This is
	 * bumped whenever we update the metadata on the
	 * server.
	 */
	unsigned long		cache_change_attribute;
	/*
	 * Counter indicating the number of outstanding requests that
	 * will cause a file data update.
	 */
	atomic_t		data_updates;

	struct rb_root		access_cache;
	struct list_head	access_cache_entry_lru;
	struct list_head	access_cache_inode_lru;
#ifdef CONFIG_NFS_V3_ACL
	struct posix_acl	*acl_access;
	struct posix_acl	*acl_default;
#endif

	/*
	 * This is the cookie verifier used for NFSv3 readdir
	 * operations
	 */
	__be32			cookieverf[2];

	/*
	 * This is the list of dirty unwritten pages.
	 */
	struct radix_tree_root	nfs_page_tree;

	unsigned long		ncommit,
				npages;

	/* Open contexts for shared mmap writes */
	struct list_head	open_files;

#ifdef CONFIG_NFS_V4
	struct nfs4_cached_acl	*nfs4_acl;
        /* NFSv4 state */
	struct list_head	open_states;
	struct nfs_delegation	*delegation;
	int			 delegation_state;
	struct rw_semaphore	rwsem;
#endif /* CONFIG_NFS_V4*/
	struct inode		vfs_inode;
};

/*
 * Cache validity bit flags
 */
#define NFS_INO_INVALID_ATTR	0x0001		/* cached attrs are invalid */
#define NFS_INO_INVALID_DATA	0x0002		/* cached data is invalid */
#define NFS_INO_INVALID_ATIME	0x0004		/* cached atime is invalid */
#define NFS_INO_INVALID_ACCESS	0x0008		/* cached access cred invalid */
#define NFS_INO_INVALID_ACL	0x0010		/* cached acls are invalid */
#define NFS_INO_REVAL_PAGECACHE	0x0020		/* must revalidate pagecache */
#define NFS_INO_REVAL_FORCED	0x0040		/* force revalidation ignoring a delegation */

/*
 * Bit offsets in flags field
 */
#define NFS_INO_REVALIDATING	(0)		/* revalidating attrs */
#define NFS_INO_ADVISE_RDPLUS	(1)		/* advise readdirplus */
#define NFS_INO_STALE		(2)		/* possible stale inode */
#define NFS_INO_ACL_LRU_SET	(3)		/* Inode is on the LRU list */

static inline struct nfs_inode *NFS_I(struct inode *inode)
{
	return container_of(inode, struct nfs_inode, vfs_inode);
}
#define NFS_SB(s)		((struct nfs_server *)(s->s_fs_info))

#define NFS_FH(inode)			(&NFS_I(inode)->fh)
#define NFS_SERVER(inode)		(NFS_SB(inode->i_sb))
#define NFS_CLIENT(inode)		(NFS_SERVER(inode)->client)
#define NFS_PROTO(inode)		(NFS_SERVER(inode)->nfs_client->rpc_ops)
#define NFS_COOKIEVERF(inode)		(NFS_I(inode)->cookieverf)
#define NFS_READTIME(inode)		(NFS_I(inode)->read_cache_jiffies)
#define NFS_CHANGE_ATTR(inode)		(NFS_I(inode)->change_attr)
#define NFS_ATTRTIMEO(inode)		(NFS_I(inode)->attrtimeo)
#define NFS_MINATTRTIMEO(inode) \
	(S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
			       : NFS_SERVER(inode)->acregmin)
#define NFS_MAXATTRTIMEO(inode) \
	(S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
			       : NFS_SERVER(inode)->acregmax)
#define NFS_ATTRTIMEO_UPDATE(inode)	(NFS_I(inode)->attrtimeo_timestamp)

#define NFS_FLAGS(inode)		(NFS_I(inode)->flags)
#define NFS_STALE(inode)		(test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))

#define NFS_FILEID(inode)		(NFS_I(inode)->fileid)

static inline int nfs_caches_unstable(struct inode *inode)
{
	return atomic_read(&NFS_I(inode)->data_updates) != 0;
}

static inline void nfs_mark_for_revalidate(struct inode *inode)
{
	struct nfs_inode *nfsi = NFS_I(inode);

	spin_lock(&inode->i_lock);
	nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
	if (S_ISDIR(inode->i_mode))
		nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
	spin_unlock(&inode->i_lock);
}

static inline void NFS_CACHEINV(struct inode *inode)
{
	if (!nfs_caches_unstable(inode))
		nfs_mark_for_revalidate(inode);
}

static inline int nfs_server_capable(struct inode *inode, int cap)
{
	return NFS_SERVER(inode)->caps & cap;
}

static inline int NFS_USE_READDIRPLUS(struct inode *inode)
{
	return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
}

/**
 * nfs_save_change_attribute - Returns the inode attribute change cookie
 * @inode - pointer to inode
 * The "change attribute" is updated every time we finish an operation
 * that will result in a metadata change on the server.
 */
static inline long nfs_save_change_attribute(struct inode *inode)
{
	return NFS_I(inode)->cache_change_attribute;
}

/**
 * nfs_verify_change_attribute - Detects NFS inode cache updates
 * @inode - pointer to inode
 * @chattr - previously saved change attribute
 * Return "false" if metadata has been updated (or is in the process of
 * being updated) since the change attribute was saved.
 */
static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
{
	return !nfs_caches_unstable(inode)
		&& time_after_eq(chattr, NFS_I(inode)->cache_change_attribute);
}

/*
 * linux/fs/nfs/inode.c
 */
extern int nfs_sync_mapping(struct address_space *mapping);
extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
extern void nfs_zap_caches(struct inode *);
extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
				struct nfs_fattr *);
extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
extern int nfs_permission(struct inode *, int, struct nameidata *);
extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
extern void nfs_access_zap_cache(struct inode *inode);
extern int nfs_open(struct inode *, struct file *);
extern int nfs_release(struct inode *, struct file *);
extern int nfs_attribute_timeout(struct inode *inode);
extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
extern int nfs_revalidate_mapping_nolock(struct inode *inode, struct address_space *mapping);
extern int nfs_setattr(struct dentry *, struct iattr *);
extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
extern void nfs_begin_attr_update(struct inode *);
extern void nfs_end_attr_update(struct inode *);
extern void nfs_begin_data_update(struct inode *);
extern void nfs_end_data_update(struct inode *);
extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
extern void put_nfs_open_context(struct nfs_open_context *ctx);
extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);

/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
extern __be32 root_nfs_parse_addr(char *name); /*__init*/

static inline void nfs_fattr_init(struct nfs_fattr *fattr)
{
	fattr->valid = 0;
	fattr->time_start = jiffies;
}

/*
 * linux/fs/nfs/file.c
 */
extern const struct inode_operations nfs_file_inode_operations;
#ifdef CONFIG_NFS_V3
extern const struct inode_operations nfs3_file_inode_operations;
#endif /* CONFIG_NFS_V3 */
extern const struct file_operations nfs_file_operations;
extern const struct address_space_operations nfs_file_aops;

static inline struct rpc_cred *nfs_file_cred(struct file *file)
{
	if (file != NULL) {
		struct nfs_open_context *ctx;

		ctx = (struct nfs_open_context*)file->private_data;
		return ctx->cred;
	}
	return NULL;
}

/*
 * linux/fs/nfs/xattr.c
 */
#ifdef CONFIG_NFS_V3_ACL
extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
extern int nfs3_setxattr(struct dentry *, const char *,
			const void *, size_t, int);
extern int nfs3_removexattr (struct dentry *, const char *name);
#else
# define nfs3_listxattr NULL
# define nfs3_getxattr NULL
# define nfs3_setxattr NULL
# define nfs3_removexattr NULL
#endif

/*
 * linux/fs/nfs/direct.c
 */
extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
			unsigned long);
extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
			const struct iovec *iov, unsigned long nr_segs,
			loff_t pos);
extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
			const struct iovec *iov, unsigned long nr_segs,
			loff_t pos);

/*
 * linux/fs/nfs/dir.c
 */
extern const struct inode_operations nfs_dir_inode_operations;
#ifdef CONFIG_NFS_V3
extern const struct inode_operations nfs3_dir_inode_operations;
#endif /* CONFIG_NFS_V3 */
extern const struct file_operations nfs_dir_operations;
extern struct dentry_operations nfs_dentry_operations;

extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);

/*
 * linux/fs/nfs/symlink.c
 */
extern const struct inode_operations nfs_symlink_inode_operations;

/*
 * linux/fs/nfs/sysctl.c
 */
#ifdef CONFIG_SYSCTL
extern int nfs_register_sysctl(void);
extern void nfs_unregister_sysctl(void);
#else
#define nfs_register_sysctl() 0
#define nfs_unregister_sysctl() do { } while(0)
#endif

/*
 * linux/fs/nfs/namespace.c
 */
extern struct list_head nfs_automount_list;
extern const struct inode_operations nfs_mountpoint_inode_operations;
extern const struct inode_operations nfs_referral_inode_operations;
extern int nfs_mountpoint_expiry_timeout;
extern void nfs_release_automount_timer(void);

/*
 * linux/fs/nfs/unlink.c
 */
extern int  nfs_async_unlink(struct inode *dir, struct dentry *dentry);
extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);

/*
 * linux/fs/nfs/write.c
 */
extern int  nfs_congestion_kb;
extern int  nfs_writepage(struct page *page, struct writeback_control *wbc);
extern int  nfs_writepages(struct address_space *, struct writeback_control *);
extern int  nfs_flush_incompatible(struct file *file, struct page *page);
extern int  nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
extern void nfs_writedata_release(void *);
extern int nfs_set_page_dirty(struct page *);

/*
 * Try to write back everything synchronously (but check the
 * return value!)
 */
extern long nfs_sync_mapping_wait(struct address_space *, struct writeback_control *, int);
extern int nfs_sync_mapping_range(struct address_space *, loff_t, loff_t, int);
extern int nfs_wb_all(struct inode *inode);
extern int nfs_wb_page(struct inode *inode, struct page* page);
extern int nfs_wb_page_priority(struct inode *inode, struct page* page, int how);
extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
extern int  nfs_commit_inode(struct inode *, int);
extern struct nfs_write_data *nfs_commit_alloc(void);
extern void nfs_commit_free(struct nfs_write_data *wdata);
extern void nfs_commit_release(void *wdata);
#else
static inline int
nfs_commit_inode(struct inode *inode, int how)
{
	return 0;
}
#endif

static inline int
nfs_have_writebacks(struct inode *inode)
{
	return NFS_I(inode)->npages != 0;
}

/*
 * Allocate nfs_write_data structures
 */
extern struct nfs_write_data *nfs_writedata_alloc(unsigned int npages);

/*
 * linux/fs/nfs/read.c
 */
extern int  nfs_readpage(struct file *, struct page *);
extern int  nfs_readpages(struct file *, struct address_space *,
		struct list_head *, unsigned);
extern int  nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
extern void nfs_readdata_release(void *data);

/*
 * Allocate nfs_read_data structures
 */
extern struct nfs_read_data *nfs_readdata_alloc(unsigned int npages);

/*
 * linux/fs/nfs3proc.c
 */
#ifdef CONFIG_NFS_V3_ACL
extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
extern int nfs3_proc_setacl(struct inode *inode, int type,
			    struct posix_acl *acl);
extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
		mode_t mode);
extern void nfs3_forget_cached_acls(struct inode *inode);
#else
static inline int nfs3_proc_set_default_acl(struct inode *dir,
					    struct inode *inode,
					    mode_t mode)
{
	return 0;
}

static inline void nfs3_forget_cached_acls(struct inode *inode)
{
}
#endif /* CONFIG_NFS_V3_ACL */

/*
 * linux/fs/mount_clnt.c
 */
extern int  nfs_mount(struct sockaddr *, size_t, char *, char *,
		      int, int, struct nfs_fh *);

/*
 * inline functions
 */

static inline loff_t nfs_size_to_loff_t(__u64 size)
{
	if (size > (__u64) OFFSET_MAX - 1)
		return OFFSET_MAX - 1;
	return (loff_t) size;
}

static inline ino_t
nfs_fileid_to_ino_t(u64 fileid)
{
	ino_t ino = (ino_t) fileid;
	if (sizeof(ino_t) < sizeof(u64))
		ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
	return ino;
}

/* NFS root */

extern void * nfs_root_data(void);

#define nfs_wait_event(clnt, wq, condition)				\
({									\
	int __retval = 0;						\
	if (clnt->cl_intr) {						\
		sigset_t oldmask;					\
		rpc_clnt_sigmask(clnt, &oldmask);			\
		__retval = wait_event_interruptible(wq, condition);	\
		rpc_clnt_sigunmask(clnt, &oldmask);			\
	} else								\
		wait_event(wq, condition);				\
	__retval;							\
})

#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)

#endif /* __KERNEL__ */

/*
 * NFS debug flags
 */
#define NFSDBG_VFS		0x0001
#define NFSDBG_DIRCACHE		0x0002
#define NFSDBG_LOOKUPCACHE	0x0004
#define NFSDBG_PAGECACHE	0x0008
#define NFSDBG_PROC		0x0010
#define NFSDBG_XDR		0x0020
#define NFSDBG_FILE		0x0040
#define NFSDBG_ROOT		0x0080
#define NFSDBG_CALLBACK		0x0100
#define NFSDBG_CLIENT		0x0200
#define NFSDBG_MOUNT		0x0400
#define NFSDBG_ALL		0xFFFF

#ifdef __KERNEL__

/*
 * Enable debugging support for nfs client.
 * Requires RPC_DEBUG.
 */
#ifdef RPC_DEBUG
# define NFS_DEBUG
#endif

# undef ifdebug
# ifdef NFS_DEBUG
#  define ifdebug(fac)		if (unlikely(nfs_debug & NFSDBG_##fac))
# else
#  define ifdebug(fac)		if (0)
# endif
#endif /* __KERNEL */

#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/include/linux/nfs_fs.h
	3	*
	4	* Copyright (C) 1992 Rick Sladkey
	5	*
	6	* OS-specific nfs filesystem definitions and declarations
	7	*/
	8
	9	#ifndef _LINUX_NFS_FS_H
	10	#define _LINUX_NFS_FS_H
	11
e18fa700 JG	12	#include <linux/magic.h>
e18fa700 JG	13
03bf4b70 CL	14	/* Default timeout values */
	15	#define NFS_MAX_UDP_TIMEOUT (60*HZ)
	16	#define NFS_MAX_TCP_TIMEOUT (600*HZ)
	17
1da177e4 LT	18	/*
	19	* When flushing a cluster of dirty pages, there can be different
	20	* strategies:
	21	*/
1da177e4	22	#define FLUSH_SYNC 1 /* file being synced, or contention */
1da177e4 LT	23	#define FLUSH_STABLE 4 /* commit to stable storage */
	24	#define FLUSH_LOWPRI 8 /* low priority background flush */
	25	#define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
70b9ecbd	26	#define FLUSH_NOCOMMIT 32 /* Don't send the NFSv3/v4 COMMIT */
d2ccddf0	27	#define FLUSH_INVALIDATE 64 /* Invalidate the page cache */
4d770ccf	28	#define FLUSH_NOWRITEPAGE 128 /* Don't call writepage() */
1da177e4 LT	29
	30	#ifdef __KERNEL__
	31
7f1cbe51	32	#include <linux/in.h>
3bec63db	33	#include <linux/kref.h>
7f1cbe51	34	#include <linux/mm.h>
88be9f99	35	#include <linux/namei.h>
7f1cbe51	36	#include <linux/pagemap.h>
1c3c07e9	37	#include <linux/rbtree.h>
7f1cbe51 DW	38	#include <linux/rwsem.h>
	39	#include <linux/wait.h>
	40
	41	#include <linux/sunrpc/debug.h>
	42	#include <linux/sunrpc/auth.h>
	43	#include <linux/sunrpc/clnt.h>
	44
	45	#include <linux/nfs.h>
	46	#include <linux/nfs2.h>
	47	#include <linux/nfs3.h>
	48	#include <linux/nfs4.h>
	49	#include <linux/nfs_xdr.h>
	50
	51	#include <linux/nfs_fs_sb.h>
	52
	53	#include <linux/rwsem.h>
	54	#include <linux/mempool.h>
	55
	56	/*
	57	* These are the default flags for swap requests
	58	*/
	59	#define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER\|RPC_TASK_ROOTCREDS)
	60
1da177e4 LT	61	/*
	62	* NFSv3/v4 Access mode cache entry
	63	*/
	64	struct nfs_access_entry {
1c3c07e9	65	struct rb_node rb_node;
cfcea3e8	66	struct list_head lru;
1da177e4 LT	67	unsigned long jiffies;
	68	struct rpc_cred * cred;
	69	int mask;
	70	};
	71
	72	struct nfs4_state;
	73	struct nfs_open_context {
5e11934d	74	atomic_t count;
88be9f99	75	struct path path;
1da177e4 LT	76	struct rpc_cred *cred;
	77	struct nfs4_state *state;
	78	fl_owner_t lockowner;
	79	int mode;
	80	int error;
	81
	82	struct list_head list;
00a92642	83
00a92642	84	__u64 dir_cookie;
1da177e4 LT	85	};
	86
	87	/*
	88	* NFSv4 delegation
	89	*/
	90	struct nfs_delegation;
	91
5c6a9f7d AG	92	struct posix_acl;
5c6a9f7d AG	93
1da177e4 LT	94	/*
	95	* nfs fs inode data in memory
	96	*/
	97	struct nfs_inode {
	98	/*
	99	* The 64bit 'inode number'
	100	*/
	101	__u64 fileid;
	102
	103	/*
	104	* NFS file handle
	105	*/
	106	struct nfs_fh fh;
	107
	108	/*
	109	* Various flags
	110	*/
412d582e CL	111	unsigned long flags; /* atomic bit ops */
412d582e CL	112	unsigned long cache_validity; /* bit mask */
1da177e4 LT	113
1da177e4 LT	114	/*
24bd68f4	115	* read_cache_jiffies is when we started read-caching this inode.
1da177e4 LT	116	* attrtimeo is for how long the cached information is assumed
	117	* to be valid. A successful attribute revalidation doubles
	118	* attrtimeo (up to acregmax/acdirmax), a failure resets it to
	119	* acregmin/acdirmin.
	120	*
	121	* We need to revalidate the cached attrs for this inode if
	122	*
	123	* jiffies - read_cache_jiffies > attrtimeo
1da177e4	124	*/
1da177e4 LT	125	unsigned long read_cache_jiffies;
	126	unsigned long attrtimeo;
	127	unsigned long attrtimeo_timestamp;
	128	__u64 change_attr; /* v4 only */
	129
33801147	130	unsigned long last_updated;
1da177e4 LT	131	/* "Generation counter" for the attribute cache. This is
	132	* bumped whenever we update the metadata on the
	133	* server.
	134	*/
	135	unsigned long cache_change_attribute;
	136	/*
	137	* Counter indicating the number of outstanding requests that
	138	* will cause a file data update.
	139	*/
	140	atomic_t data_updates;
	141
1c3c07e9	142	struct rb_root access_cache;
cfcea3e8 TM	143	struct list_head access_cache_entry_lru;
cfcea3e8 TM	144	struct list_head access_cache_inode_lru;
5c6a9f7d AG	145	#ifdef CONFIG_NFS_V3_ACL
	146	struct posix_acl *acl_access;
	147	struct posix_acl *acl_default;
	148	#endif
1da177e4 LT	149
	150	/*
	151	* This is the cookie verifier used for NFSv3 readdir
	152	* operations
	153	*/
bc4785cd	154	__be32 cookieverf[2];
1da177e4 LT	155
	156	/*
	157	* This is the list of dirty unwritten pages.
	158	*/
1da177e4 LT	159	struct radix_tree_root nfs_page_tree;
1da177e4 LT	160
dce34ce2	161	unsigned long ncommit,
1da177e4 LT	162	npages;
	163
	164	/* Open contexts for shared mmap writes */
	165	struct list_head open_files;
	166
1da177e4	167	#ifdef CONFIG_NFS_V4
e50a1c2e	168	struct nfs4_cached_acl *nfs4_acl;
1da177e4 LT	169	/* NFSv4 state */
	170	struct list_head open_states;
	171	struct nfs_delegation *delegation;
	172	int delegation_state;
	173	struct rw_semaphore rwsem;
	174	#endif /* CONFIG_NFS_V4*/
1da177e4 LT	175	struct inode vfs_inode;
	176	};
	177
	178	/*
55296809	179	* Cache validity bit flags
1da177e4	180	*/
55296809 CL	181	#define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
	182	#define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
	183	#define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
	184	#define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
	185	#define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
	186	#define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
412c77ce	187	#define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
55296809 CL	188
55296809 CL	189	/*
412d582e	190	* Bit offsets in flags field
55296809	191	*/
412d582e CL	192	#define NFS_INO_REVALIDATING (0) /* revalidating attrs */
	193	#define NFS_INO_ADVISE_RDPLUS (1) /* advise readdirplus */
	194	#define NFS_INO_STALE (2) /* possible stale inode */
cfcea3e8	195	#define NFS_INO_ACL_LRU_SET (3) /* Inode is on the LRU list */
1da177e4 LT	196
	197	static inline struct nfs_inode NFS_I(struct inode inode)
	198	{
	199	return container_of(inode, struct nfs_inode, vfs_inode);
	200	}
	201	#define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
	202
	203	#define NFS_FH(inode) (&NFS_I(inode)->fh)
	204	#define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
	205	#define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
8fa5c000	206	#define NFS_PROTO(inode) (NFS_SERVER(inode)->nfs_client->rpc_ops)
1da177e4 LT	207	#define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
	208	#define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
	209	#define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
	210	#define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
	211	#define NFS_MINATTRTIMEO(inode) \
	212	(S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
	213	: NFS_SERVER(inode)->acregmin)
	214	#define NFS_MAXATTRTIMEO(inode) \
	215	(S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
	216	: NFS_SERVER(inode)->acregmax)
	217	#define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
	218
	219	#define NFS_FLAGS(inode) (NFS_I(inode)->flags)
412d582e	220	#define NFS_STALE(inode) (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
1da177e4 LT	221
	222	#define NFS_FILEID(inode) (NFS_I(inode)->fileid)
	223
	224	static inline int nfs_caches_unstable(struct inode *inode)
	225	{
	226	return atomic_read(&NFS_I(inode)->data_updates) != 0;
	227	}
	228
decf491f TM	229	static inline void nfs_mark_for_revalidate(struct inode *inode)
decf491f TM	230	{
38478b24 TM	231	struct nfs_inode *nfsi = NFS_I(inode);
38478b24 TM	232
decf491f	233	spin_lock(&inode->i_lock);
38478b24 TM	234	nfsi->cache_validity \|= NFS_INO_INVALID_ATTR\|NFS_INO_INVALID_ACCESS;
	235	if (S_ISDIR(inode->i_mode))
	236	nfsi->cache_validity \|= NFS_INO_REVAL_PAGECACHE\|NFS_INO_INVALID_DATA;
decf491f TM	237	spin_unlock(&inode->i_lock);
	238	}
	239
1da177e4 LT	240	static inline void NFS_CACHEINV(struct inode *inode)
1da177e4 LT	241	{
decf491f TM	242	if (!nfs_caches_unstable(inode))
decf491f TM	243	nfs_mark_for_revalidate(inode);
1da177e4 LT	244	}
	245
	246	static inline int nfs_server_capable(struct inode *inode, int cap)
	247	{
	248	return NFS_SERVER(inode)->caps & cap;
	249	}
	250
	251	static inline int NFS_USE_READDIRPLUS(struct inode *inode)
	252	{
412d582e	253	return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
1da177e4 LT	254	}
	255
	256	/**
	257	* nfs_save_change_attribute - Returns the inode attribute change cookie
	258	* @inode - pointer to inode
	259	* The "change attribute" is updated every time we finish an operation
	260	* that will result in a metadata change on the server.
	261	*/
	262	static inline long nfs_save_change_attribute(struct inode *inode)
	263	{
	264	return NFS_I(inode)->cache_change_attribute;
	265	}
	266
	267	/**
	268	* nfs_verify_change_attribute - Detects NFS inode cache updates
	269	* @inode - pointer to inode
	270	* @chattr - previously saved change attribute
	271	* Return "false" if metadata has been updated (or is in the process of
	272	* being updated) since the change attribute was saved.
	273	*/
	274	static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
	275	{
	276	return !nfs_caches_unstable(inode)
913a70fc	277	&& time_after_eq(chattr, NFS_I(inode)->cache_change_attribute);
1da177e4 LT	278	}
	279
	280	/*
	281	* linux/fs/nfs/inode.c
	282	*/
29884df0	283	extern int nfs_sync_mapping(struct address_space *mapping);
cd9ae2b6	284	extern void nfs_zap_mapping(struct inode inode, struct address_space mapping);
1da177e4 LT	285	extern void nfs_zap_caches(struct inode *);
	286	extern struct inode nfs_fhget(struct super_block , struct nfs_fh *,
	287	struct nfs_fattr *);
	288	extern int nfs_refresh_inode(struct inode , struct nfs_fattr );
decf491f	289	extern int nfs_post_op_update_inode(struct inode inode, struct nfs_fattr fattr);
1da177e4 LT	290	extern int nfs_getattr(struct vfsmount , struct dentry , struct kstat *);
	291	extern int nfs_permission(struct inode , int, struct nameidata );
	292	extern int nfs_access_get_cached(struct inode , struct rpc_cred , struct nfs_access_entry *);
	293	extern void nfs_access_add_cache(struct inode , struct nfs_access_entry );
1c3c07e9	294	extern void nfs_access_zap_cache(struct inode *inode);
1da177e4 LT	295	extern int nfs_open(struct inode , struct file );
	296	extern int nfs_release(struct inode , struct file );
	297	extern int nfs_attribute_timeout(struct inode *inode);
	298	extern int nfs_revalidate_inode(struct nfs_server server, struct inode inode);
	299	extern int __nfs_revalidate_inode(struct nfs_server , struct inode );
44b11874	300	extern int nfs_revalidate_mapping(struct inode inode, struct address_space mapping);
717d44e8	301	extern int nfs_revalidate_mapping_nolock(struct inode inode, struct address_space mapping);
1da177e4	302	extern int nfs_setattr(struct dentry , struct iattr );
65e4308d	303	extern void nfs_setattr_update_inode(struct inode inode, struct iattr attr);
1da177e4 LT	304	extern void nfs_begin_attr_update(struct inode *);
	305	extern void nfs_end_attr_update(struct inode *);
	306	extern void nfs_begin_data_update(struct inode *);
	307	extern void nfs_end_data_update(struct inode *);
1da177e4 LT	308	extern struct nfs_open_context get_nfs_open_context(struct nfs_open_context ctx);
1da177e4 LT	309	extern void put_nfs_open_context(struct nfs_open_context *ctx);
d530838b	310	extern struct nfs_open_context nfs_find_open_context(struct inode inode, struct rpc_cred *cred, int mode);
1da177e4 LT	311
1da177e4 LT	312	/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
5a874db4	313	extern __be32 root_nfs_parse_addr(char name); /__init*/
1da177e4	314
0e574af1 TM	315	static inline void nfs_fattr_init(struct nfs_fattr *fattr)
	316	{
	317	fattr->valid = 0;
33801147	318	fattr->time_start = jiffies;
0e574af1 TM	319	}
0e574af1 TM	320
1da177e4 LT	321	/*
	322	* linux/fs/nfs/file.c
	323	*/
c5ef1c42	324	extern const struct inode_operations nfs_file_inode_operations;
b7fa0554	325	#ifdef CONFIG_NFS_V3
c5ef1c42	326	extern const struct inode_operations nfs3_file_inode_operations;
b7fa0554	327	#endif /* CONFIG_NFS_V3 */
4b6f5d20	328	extern const struct file_operations nfs_file_operations;
f5e54d6e	329	extern const struct address_space_operations nfs_file_aops;
1da177e4 LT	330
	331	static inline struct rpc_cred nfs_file_cred(struct file file)
	332	{
	333	if (file != NULL) {
	334	struct nfs_open_context *ctx;
	335
	336	ctx = (struct nfs_open_context*)file->private_data;
	337	return ctx->cred;
	338	}
	339	return NULL;
	340	}
	341
b7fa0554 AG	342	/*
	343	* linux/fs/nfs/xattr.c
	344	*/
	345	#ifdef CONFIG_NFS_V3_ACL
	346	extern ssize_t nfs3_listxattr(struct dentry , char , size_t);
	347	extern ssize_t nfs3_getxattr(struct dentry , const char , void *, size_t);
	348	extern int nfs3_setxattr(struct dentry , const char ,
	349	const void *, size_t, int);
	350	extern int nfs3_removexattr (struct dentry , const char name);
	351	#else
	352	# define nfs3_listxattr NULL
	353	# define nfs3_getxattr NULL
	354	# define nfs3_setxattr NULL
	355	# define nfs3_removexattr NULL
	356	#endif
	357
1da177e4 LT	358	/*
	359	* linux/fs/nfs/direct.c
	360	*/
	361	extern ssize_t nfs_direct_IO(int, struct kiocb , const struct iovec , loff_t,
	362	unsigned long);
027445c3 BP	363	extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
	364	const struct iovec *iov, unsigned long nr_segs,
	365	loff_t pos);
	366	extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
	367	const struct iovec *iov, unsigned long nr_segs,
	368	loff_t pos);
1da177e4 LT	369
	370	/*
	371	* linux/fs/nfs/dir.c
	372	*/
c5ef1c42	373	extern const struct inode_operations nfs_dir_inode_operations;
b7fa0554	374	#ifdef CONFIG_NFS_V3
c5ef1c42	375	extern const struct inode_operations nfs3_dir_inode_operations;
b7fa0554	376	#endif /* CONFIG_NFS_V3 */
4b6f5d20	377	extern const struct file_operations nfs_dir_operations;
1da177e4 LT	378	extern struct dentry_operations nfs_dentry_operations;
	379
	380	extern int nfs_instantiate(struct dentry dentry, struct nfs_fh fh, struct nfs_fattr *fattr);
	381
	382	/*
	383	* linux/fs/nfs/symlink.c
	384	*/
c5ef1c42	385	extern const struct inode_operations nfs_symlink_inode_operations;
1da177e4	386
a72b4422 TM	387	/*
	388	* linux/fs/nfs/sysctl.c
	389	*/
	390	#ifdef CONFIG_SYSCTL
	391	extern int nfs_register_sysctl(void);
	392	extern void nfs_unregister_sysctl(void);
	393	#else
7fd105e7	394	#define nfs_register_sysctl() 0
a72b4422 TM	395	#define nfs_unregister_sysctl() do { } while(0)
	396	#endif
	397
55a97593 TM	398	/*
	399	* linux/fs/nfs/namespace.c
	400	*/
51d8fa6a	401	extern struct list_head nfs_automount_list;
c5ef1c42 AV	402	extern const struct inode_operations nfs_mountpoint_inode_operations;
c5ef1c42 AV	403	extern const struct inode_operations nfs_referral_inode_operations;
51d8fa6a TM	404	extern int nfs_mountpoint_expiry_timeout;
51d8fa6a TM	405	extern void nfs_release_automount_timer(void);
55a97593	406
1da177e4 LT	407	/*
	408	* linux/fs/nfs/unlink.c
	409	*/
e4eff1a6 TM	410	extern int nfs_async_unlink(struct inode dir, struct dentry dentry);
e4eff1a6 TM	411	extern void nfs_complete_unlink(struct dentry dentry, struct inode );
1da177e4 LT	412
	413	/*
	414	* linux/fs/nfs/write.c
	415	*/
89a09141	416	extern int nfs_congestion_kb;
1da177e4 LT	417	extern int nfs_writepage(struct page page, struct writeback_control wbc);
	418	extern int nfs_writepages(struct address_space , struct writeback_control );
	419	extern int nfs_flush_incompatible(struct file file, struct page page);
	420	extern int nfs_updatepage(struct file , struct page , unsigned int, unsigned int);
462d5b32 CL	421	extern int nfs_writeback_done(struct rpc_task , struct nfs_write_data );
462d5b32 CL	422	extern void nfs_writedata_release(void *);
1a54533e	423	extern int nfs_set_page_dirty(struct page *);
1da177e4 LT	424
	425	/*
	426	* Try to write back everything synchronously (but check the
	427	* return value!)
	428	*/
1c75950b TM	429	extern long nfs_sync_mapping_wait(struct address_space , struct writeback_control , int);
	430	extern int nfs_sync_mapping_range(struct address_space *, loff_t, loff_t, int);
	431	extern int nfs_wb_all(struct inode *inode);
	432	extern int nfs_wb_page(struct inode inode, struct page page);
61822ab5	433	extern int nfs_wb_page_priority(struct inode inode, struct page page, int how);
1b3b4a1a	434	extern int nfs_wb_page_cancel(struct inode inode, struct page page);
1da177e4	435	#if defined(CONFIG_NFS_V3) \|\| defined(CONFIG_NFS_V4)
3da28eb1	436	extern int nfs_commit_inode(struct inode *, int);
8aca67f0 TM	437	extern struct nfs_write_data *nfs_commit_alloc(void);
8aca67f0 TM	438	extern void nfs_commit_free(struct nfs_write_data *wdata);
fad61490	439	extern void nfs_commit_release(void *wdata);
1da177e4 LT	440	#else
1da177e4 LT	441	static inline int
3da28eb1	442	nfs_commit_inode(struct inode *inode, int how)
1da177e4 LT	443	{
	444	return 0;
	445	}
	446	#endif
	447
	448	static inline int
	449	nfs_have_writebacks(struct inode *inode)
	450	{
	451	return NFS_I(inode)->npages != 0;
	452	}
	453
1da177e4	454	/*
e4e20512	455	* Allocate nfs_write_data structures
1da177e4	456	*/
8d5658c9	457	extern struct nfs_write_data *nfs_writedata_alloc(unsigned int npages);
1da177e4	458
1da177e4 LT	459	/*
	460	* linux/fs/nfs/read.c
	461	*/
	462	extern int nfs_readpage(struct file , struct page );
	463	extern int nfs_readpages(struct file , struct address_space ,
	464	struct list_head *, unsigned);
ec06c096 TM	465	extern int nfs_readpage_result(struct rpc_task , struct nfs_read_data );
ec06c096 TM	466	extern void nfs_readdata_release(void *data);
963d8fe5	467
1da177e4	468	/*
e4e20512	469	* Allocate nfs_read_data structures
1da177e4	470	*/
8d5658c9	471	extern struct nfs_read_data *nfs_readdata_alloc(unsigned int npages);
1da177e4	472
b7fa0554 AG	473	/*
	474	* linux/fs/nfs3proc.c
	475	*/
	476	#ifdef CONFIG_NFS_V3_ACL
	477	extern struct posix_acl nfs3_proc_getacl(struct inode inode, int type);
	478	extern int nfs3_proc_setacl(struct inode *inode, int type,
	479	struct posix_acl *acl);
055ffbea AG	480	extern int nfs3_proc_set_default_acl(struct inode dir, struct inode inode,
055ffbea AG	481	mode_t mode);
5c6a9f7d	482	extern void nfs3_forget_cached_acls(struct inode *inode);
055ffbea AG	483	#else
	484	static inline int nfs3_proc_set_default_acl(struct inode *dir,
	485	struct inode *inode,
	486	mode_t mode)
	487	{
	488	return 0;
	489	}
5c6a9f7d AG	490
	491	static inline void nfs3_forget_cached_acls(struct inode *inode)
	492	{
	493	}
b7fa0554 AG	494	#endif /* CONFIG_NFS_V3_ACL */
b7fa0554 AG	495
1da177e4 LT	496	/*
1da177e4 LT	497	* linux/fs/mount_clnt.c
1da177e4	498	*/
3ea97309 CL	499	extern int nfs_mount(struct sockaddr , size_t, char , char *,
3ea97309 CL	500	int, int, struct nfs_fh *);
1da177e4 LT	501
	502	/*
	503	* inline functions
	504	*/
	505
433c9237	506	static inline loff_t nfs_size_to_loff_t(__u64 size)
1da177e4	507	{
433c9237 CL	508	if (size > (__u64) OFFSET_MAX - 1)
433c9237 CL	509	return OFFSET_MAX - 1;
1da177e4 LT	510	return (loff_t) size;
	511	}
	512
	513	static inline ino_t
	514	nfs_fileid_to_ino_t(u64 fileid)
	515	{
	516	ino_t ino = (ino_t) fileid;
	517	if (sizeof(ino_t) < sizeof(u64))
	518	ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
	519	return ino;
	520	}
	521
	522	/* NFS root */
	523
	524	extern void * nfs_root_data(void);
	525
	526	#define nfs_wait_event(clnt, wq, condition) \
	527	({ \
	528	int __retval = 0; \
	529	if (clnt->cl_intr) { \
	530	sigset_t oldmask; \
	531	rpc_clnt_sigmask(clnt, &oldmask); \
	532	__retval = wait_event_interruptible(wq, condition); \
	533	rpc_clnt_sigunmask(clnt, &oldmask); \
	534	} else \
	535	wait_event(wq, condition); \
	536	__retval; \
	537	})
	538
	539	#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
	540
1da177e4 LT	541	#endif /* __KERNEL__ */
	542
	543	/*
	544	* NFS debug flags
	545	*/
	546	#define NFSDBG_VFS 0x0001
	547	#define NFSDBG_DIRCACHE 0x0002
	548	#define NFSDBG_LOOKUPCACHE 0x0004
	549	#define NFSDBG_PAGECACHE 0x0008
	550	#define NFSDBG_PROC 0x0010
	551	#define NFSDBG_XDR 0x0020
	552	#define NFSDBG_FILE 0x0040
	553	#define NFSDBG_ROOT 0x0080
	554	#define NFSDBG_CALLBACK 0x0100
24c8dbbb	555	#define NFSDBG_CLIENT 0x0200
f1828993	556	#define NFSDBG_MOUNT 0x0400
1da177e4 LT	557	#define NFSDBG_ALL 0xFFFF
	558
	559	#ifdef __KERNEL__
4dc2eaec BH	560
	561	/*
	562	* Enable debugging support for nfs client.
	563	* Requires RPC_DEBUG.
	564	*/
	565	#ifdef RPC_DEBUG
	566	# define NFS_DEBUG
	567	#endif
	568
1da177e4 LT	569	# undef ifdebug
	570	# ifdef NFS_DEBUG
	571	# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
	572	# else
	573	# define ifdebug(fac) if (0)
	574	# endif
	575	#endif /* __KERNEL */
	576
	577	#endif