[linux-block.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/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;

	unsigned long flags;
#define NFS_CONTEXT_ERROR_WRITE		(0)
	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;

	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;

	/* Number of in-flight sillydelete RPC calls */
	atomic_t		silly_count;
	/* List of deferred sillydelete requests */
	struct hlist_head	silly_list;
	wait_queue_head_t	waitqueue;

#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(const struct inode *inode)
{
	return container_of(inode, struct nfs_inode, vfs_inode);
}

static inline struct nfs_server *NFS_SB(const struct super_block *s)
{
	return (struct nfs_server *)(s->s_fs_info);
}

static inline struct nfs_fh *NFS_FH(const struct inode *inode)
{
	return &NFS_I(inode)->fh;
}

static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
{
	return NFS_SB(inode->i_sb);
}

static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
{
	return NFS_SERVER(inode)->client;
}

static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
{
	return NFS_SERVER(inode)->nfs_client->rpc_ops;
}

static inline __be32 *NFS_COOKIEVERF(const struct inode *inode)
{
	return NFS_I(inode)->cookieverf;
}

static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
{
	struct nfs_server *nfss = NFS_SERVER(inode);
	return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
}

static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
{
	struct nfs_server *nfss = NFS_SERVER(inode);
	return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
}

static inline int NFS_STALE(const struct inode *inode)
{
	return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
}

static inline __u64 NFS_FILEID(const struct inode *inode)
{
	return NFS_I(inode)->fileid;
}

static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
{
	NFS_I(inode)->fileid = fileid;
}

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 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_I(inode)->flags);
}

static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
{
	dentry->d_time = verf;
}

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

/**
 * nfs_verify_change_attribute - Detects NFS remote directory changes
 * @dir - pointer to parent directory inode
 * @chattr - previously saved change attribute
 * Return "false" if the verifiers doesn't match the change attribute.
 * This would usually indicate that the directory contents have changed on
 * the server, and that any dentries need revalidating.
 */
static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
{
	return chattr == NFS_I(dir)->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 void nfs_invalidate_atime(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_post_op_update_inode_force_wcc(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_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 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);
extern u64 nfs_compat_user_ino64(u64 fileid);

/* 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 nfs_open_context *nfs_file_open_context(struct file *filp)
{
	return filp->private_data;
}

static inline struct rpc_cred *nfs_file_cred(struct file *file)
{
	if (file != NULL)
		return nfs_file_open_context(file)->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 void nfs_force_lookup_revalidate(struct inode *dir);
extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
extern void nfs_access_zap_cache(struct inode *inode);

/*
 * 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 *);
extern void nfs_block_sillyrename(struct dentry *dentry);
extern void nfs_unblock_sillyrename(struct dentry *dentry);

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

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