[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_DEF_UDP_TIMEO	(11)
#define NFS_DEF_UDP_RETRANS	(3)
#define NFS_DEF_TCP_TIMEO	(600)
#define NFS_DEF_TCP_RETRANS	(2)

#define NFS_MAX_UDP_TIMEOUT	(60*HZ)
#define NFS_MAX_TCP_TIMEOUT	(600*HZ)

#define NFS_DEF_ACREGMIN	(3)
#define NFS_DEF_ACREGMAX	(60)
#define NFS_DEF_ACDIRMIN	(30)
#define NFS_DEF_ACDIRMAX	(60)

/*
 * 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/pagemap.h>
#include <linux/rbtree.h>
#include <linux/rwsem.h>
#include <linux/wait.h>

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

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

#include <linux/mempool.h>

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

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

struct nfs4_state;
struct nfs_open_context {
	atomic_t count;
	struct path path;
	struct rpc_cred *cred;
	struct nfs4_state *state;
	fl_owner_t lockowner;
	fmode_t 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
	 *
	 * Please note the comparison is greater than or equal
	 * so that zero timeout values can be specified.
	 */
	unsigned long		read_cache_jiffies;
	unsigned long		attrtimeo;
	unsigned long		attrtimeo_timestamp;
	__u64			change_attr;		/* v4 only */

	unsigned long		attr_gencount;
	/* "Generation counter" for the attribute cache. This is
	 * bumped whenever we update the metadata on the
	 * server.
	 */
	unsigned long		cache_change_attribute;

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

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

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

	unsigned long		npages;

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

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

#ifdef CONFIG_NFS_V4
	struct nfs4_cached_acl	*nfs4_acl;
        /* NFSv4 state */
	struct list_head	open_states;
	struct nfs_delegation	*delegation;
	fmode_t			 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_ADVISE_RDPLUS	(0)		/* advise readdirplus */
#define NFS_INO_STALE		(1)		/* possible stale inode */
#define NFS_INO_ACL_LRU_SET	(2)		/* Inode is on the LRU list */
#define NFS_INO_MOUNTPOINT	(3)		/* inode is remote mountpoint */
#define NFS_INO_FLUSHING	(4)		/* inode is flushing out data */

static inline struct nfs_inode *NFS_I(const struct inode *inode)
{
	return container_of(inode, struct nfs_inode, vfs_inode);
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static inline int NFS_USE_READDIRPLUS(struct inode *inode)
{
	return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
}

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

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

/**
 * nfs_verify_change_attribute - Detects NFS remote directory changes
 * @dir - pointer to parent directory inode
 * @chattr - previously saved change attribute
 * Return "false" if the verifiers doesn't match the change attribute.
 * This would usually indicate that the directory contents have changed on
 * the server, and that any dentries need revalidating.
 */
static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
{
	return chattr == NFS_I(dir)->cache_change_attribute;
}

/*
 * linux/fs/nfs/inode.c
 */
extern int nfs_sync_mapping(struct address_space *mapping);
extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
extern void nfs_zap_caches(struct inode *);
extern void nfs_invalidate_atime(struct inode *);
extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
				struct nfs_fattr *);
extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
extern int nfs_permission(struct inode *, int);
extern int nfs_open(struct inode *, struct file *);
extern int nfs_release(struct inode *, struct file *);
extern int nfs_attribute_timeout(struct inode *inode);
extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
extern int nfs_revalidate_mapping_nolock(struct inode *inode, struct address_space *mapping);
extern int nfs_setattr(struct dentry *, struct iattr *);
extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
extern void put_nfs_open_context(struct nfs_open_context *ctx);
extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, fmode_t mode);
extern u64 nfs_compat_user_ino64(u64 fileid);
extern void nfs_fattr_init(struct nfs_fattr *fattr);

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

/*
 * 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) {
		struct nfs_open_context *ctx =
			nfs_file_open_context(file);
		if (ctx)
			return ctx->cred;
	}
	return NULL;
}

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

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

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

extern void nfs_force_lookup_revalidate(struct inode *dir);
extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
extern void nfs_access_zap_cache(struct inode *inode);

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

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

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

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

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

/*
 * Try to write back everything synchronously (but check the
 * return value!)
 */
extern long nfs_sync_mapping_wait(struct address_space *, struct writeback_control *, int);
extern int nfs_wb_all(struct inode *inode);
extern int nfs_wb_nocommit(struct inode *inode);
extern int nfs_wb_page(struct inode *inode, struct page* page);
extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
extern int  nfs_commit_inode(struct inode *, int);
extern struct nfs_write_data *nfs_commitdata_alloc(void);
extern void nfs_commit_free(struct nfs_write_data *wdata);
extern void nfs_commitdata_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 */

/*
 * inline functions
 */

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

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

/* NFS root */

extern void * nfs_root_data(void);

#define nfs_wait_event(clnt, wq, condition)				\
({									\
	int __retval = wait_event_killable(wq, condition);		\
	__retval;							\
})

#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)

#endif /* __KERNEL__ */

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

#ifdef __KERNEL__

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

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

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