[deliverable/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;

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

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