[mirror_ubuntu-artful-kernel.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>

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

/* 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/mm.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 vfsmount *vfsmnt;
	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.
	 * 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.
	 */
	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 */
#define NFS_INO_ACL_LRU_SET	(3)		/* Inode is on the LRU list */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/*
 * linux/fs/nfs/symlink.c
 */
extern 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 struct inode_operations nfs_mountpoint_inode_operations;
extern 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 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 int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
extern void nfs_writedata_release(void *);
extern int nfs_set_page_dirty(struct page *);

/*
 * Try to write back everything synchronously (but check the
 * return value!)
 */
extern long nfs_sync_mapping_wait(struct address_space *, struct writeback_control *, int);
extern int nfs_sync_mapping_range(struct address_space *, loff_t, loff_t, int);
extern int nfs_wb_all(struct inode *inode);
extern int nfs_wb_page(struct inode *inode, struct page* page);
extern int nfs_wb_page_priority(struct inode *inode, struct page* page, int how);
#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(size_t len);

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

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