[linux-2.6-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/config.h>
#include <linux/in.h>
#include <linux/mm.h>
#include <linux/pagemap.h>
#include <linux/rwsem.h>
#include <linux/wait.h>

#include <linux/nfs_fs_sb.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/rwsem.h>
#include <linux/mempool.h>

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

#define NFS_MAX_FILE_IO_BUFFER_SIZE	32768
#define NFS_DEF_FILE_IO_BUFFER_SIZE	4096

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

/*
 * superblock magic number for NFS
 */
#define NFS_SUPER_MAGIC			0x6969

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

/*
 * When flushing a cluster of dirty pages, there can be different
 * strategies:
 */
#define FLUSH_AGING		0	/* only flush old buffers */
#define FLUSH_SYNC		1	/* file being synced, or contention */
#define FLUSH_WAIT		2	/* wait for completion */
#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 */

#ifdef __KERNEL__

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

struct nfs4_state;
struct nfs_open_context {
	atomic_t count;
	struct dentry *dentry;
	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,
	 * and read_cache_mtime is the mtime of the inode at that time.
	 * 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
	 *
	 * and invalidate any cached data/flush out any dirty pages if
	 * we find that
	 *
	 *	mtime != read_cache_mtime
	 */
	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 nfs_access_entry	cache_access;
#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
	 */
	__u32			cookieverf[2];

	/*
	 * This is the list of dirty unwritten pages.
	 */
	spinlock_t		req_lock;
	struct list_head	dirty;
	struct list_head	commit;
	struct radix_tree_root	nfs_page_tree;

	unsigned int		ndirty,
				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 */

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

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)->rpc_ops)
#define NFS_ADDR(inode)			(RPC_PEERADDR(NFS_CLIENT(inode)))
#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)
{
	spin_lock(&inode->i_lock);
	NFS_I(inode)->cache_validity |= NFS_INO_INVALID_ATTR | NFS_INO_INVALID_ACCESS;
	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_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 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 void nfs_revalidate_mapping(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 *alloc_nfs_open_context(struct dentry *dentry, struct rpc_cred *cred);
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 void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
extern void nfs_file_clear_open_context(struct file *filp);

/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
extern u32 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 struct inode_operations nfs_file_inode_operations;
#ifdef CONFIG_NFS_V3
extern struct inode_operations nfs3_file_inode_operations;
#endif /* CONFIG_NFS_V3 */
extern struct file_operations nfs_file_operations;
extern 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, char __user *buf,
			size_t count, loff_t pos);
extern ssize_t nfs_file_direct_write(struct kiocb *iocb, const char __user *buf,
			size_t count, loff_t pos);

/*
 * linux/fs/nfs/dir.c
 */
extern struct inode_operations nfs_dir_inode_operations;
#ifdef CONFIG_NFS_V3
extern struct inode_operations nfs3_dir_inode_operations;
#endif /* CONFIG_NFS_V3 */
extern 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 struct inode_operations nfs_symlink_inode_operations;

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

/*
 * linux/fs/nfs/write.c
 */
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 void nfs_writeback_done(struct rpc_task *task, void *data);
extern void nfs_writedata_release(void *data);

#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
extern void nfs_commit_done(struct rpc_task *, void *data);
extern void nfs_commit_release(void *data);
#endif

/*
 * Try to write back everything synchronously (but check the
 * return value!)
 */
extern int  nfs_sync_inode(struct inode *, unsigned long, unsigned int, int);
#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
extern int  nfs_commit_inode(struct inode *, int);
#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;
}

static inline int
nfs_wb_all(struct inode *inode)
{
	int error = nfs_sync_inode(inode, 0, 0, FLUSH_WAIT);
	return (error < 0) ? error : 0;
}

/*
 * Write back all requests on one page - we do this before reading it.
 */
static inline int nfs_wb_page_priority(struct inode *inode, struct page* page, int how)
{
	int error = nfs_sync_inode(inode, page->index, 1,
			how | FLUSH_WAIT | FLUSH_STABLE);
	return (error < 0) ? error : 0;
}

static inline int nfs_wb_page(struct inode *inode, struct page* page)
{
	return nfs_wb_page_priority(inode, page, 0);
}

/*
 * Allocate and free nfs_write_data structures
 */
extern mempool_t *nfs_wdata_mempool;

static inline struct nfs_write_data *nfs_writedata_alloc(void)
{
	struct nfs_write_data *p = mempool_alloc(nfs_wdata_mempool, SLAB_NOFS);
	if (p) {
		memset(p, 0, sizeof(*p));
		INIT_LIST_HEAD(&p->pages);
	}
	return p;
}

static inline void nfs_writedata_free(struct nfs_write_data *p)
{
	mempool_free(p, nfs_wdata_mempool);
}

/*
 * 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 void nfs_readpage_result(struct rpc_task *, void *);
extern void  nfs_readdata_release(void *data);


/*
 * Allocate and free nfs_read_data structures
 */
extern mempool_t *nfs_rdata_mempool;

static inline struct nfs_read_data *nfs_readdata_alloc(void)
{
	struct nfs_read_data *p = mempool_alloc(nfs_rdata_mempool, SLAB_NOFS);
	if (p)
		memset(p, 0, sizeof(*p));
	return p;
}

static inline void nfs_readdata_free(struct nfs_read_data *p)
{
	mempool_free(p, nfs_rdata_mempool);
}

/*
 * 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
 * (Used only by nfsroot module)
 */
extern int  nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
		int, int);

/*
 * inline functions
 */

static inline loff_t
nfs_size_to_loff_t(__u64 size)
{
	loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
	if (size > maxsz)
		return maxsz;
	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_ALL		0xFFFF

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