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

#include <linux/nfs_fs_sb.h>

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

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

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

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

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

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

/*
 * When flushing a cluster of dirty pages, there can be different
 * strategies:
 */
#define FLUSH_AGING		0	/* only flush old buffers */
#define FLUSH_SYNC		1	/* file being synced, or contention */
#define FLUSH_WAIT		2	/* wait for completion */
#define FLUSH_STABLE		4	/* commit to stable storage */
#define FLUSH_LOWPRI		8	/* low priority background flush */
#define FLUSH_HIGHPRI		16	/* high priority memory reclaim flush */
#define FLUSH_NOCOMMIT		32	/* Don't send the NFSv3/v4 COMMIT */

#ifdef __KERNEL__

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

struct nfs4_state;
struct nfs_open_context {
	atomic_t count;
	struct dentry *dentry;
	struct rpc_cred *cred;
	struct nfs4_state *state;
	fl_owner_t lockowner;
	int mode;
	int error;

	struct list_head list;

	__u64 dir_cookie;
};

/*
 * NFSv4 delegation
 */
struct nfs_delegation;

struct posix_acl;

/*
 * nfs fs inode data in memory
 */
struct nfs_inode {
	/*
	 * The 64bit 'inode number'
	 */
	__u64 fileid;

	/*
	 * NFS file handle
	 */
	struct nfs_fh		fh;

	/*
	 * Various flags
	 */
	unsigned long		flags;			/* atomic bit ops */
	unsigned long		cache_validity;		/* bit mask */

	/*
	 * read_cache_jiffies is when we started read-caching this inode,
	 * and read_cache_mtime is the mtime of the inode at that time.
	 * attrtimeo is for how long the cached information is assumed
	 * to be valid. A successful attribute revalidation doubles
	 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
	 * acregmin/acdirmin.
	 *
	 * We need to revalidate the cached attrs for this inode if
	 *
	 *	jiffies - read_cache_jiffies > attrtimeo
	 *
	 * and invalidate any cached data/flush out any dirty pages if
	 * we find that
	 *
	 *	mtime != read_cache_mtime
	 */
	unsigned long		read_cache_jiffies;
	unsigned long		attrtimeo;
	unsigned long		attrtimeo_timestamp;
	__u64			change_attr;		/* v4 only */

	unsigned long		last_updated;
	/* "Generation counter" for the attribute cache. This is
	 * bumped whenever we update the metadata on the
	 * server.
	 */
	unsigned long		cache_change_attribute;
	/*
	 * Counter indicating the number of outstanding requests that
	 * will cause a file data update.
	 */
	atomic_t		data_updates;

	struct nfs_access_entry	cache_access;
#ifdef CONFIG_NFS_V3_ACL
	struct posix_acl	*acl_access;
	struct posix_acl	*acl_default;
#endif

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

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

	unsigned int		ndirty,
				ncommit,
				npages;

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

#ifdef CONFIG_NFS_V4
	struct nfs4_cached_acl	*nfs4_acl;
        /* NFSv4 state */
	struct list_head	open_states;
	struct nfs_delegation	*delegation;
	int			 delegation_state;
	struct rw_semaphore	rwsem;
#endif /* CONFIG_NFS_V4*/
	struct inode		vfs_inode;
};

/*
 * Cache validity bit flags
 */
#define NFS_INO_INVALID_ATTR	0x0001		/* cached attrs are invalid */
#define NFS_INO_INVALID_DATA	0x0002		/* cached data is invalid */
#define NFS_INO_INVALID_ATIME	0x0004		/* cached atime is invalid */
#define NFS_INO_INVALID_ACCESS	0x0008		/* cached access cred invalid */
#define NFS_INO_INVALID_ACL	0x0010		/* cached acls are invalid */
#define NFS_INO_REVAL_PAGECACHE	0x0020		/* must revalidate pagecache */

/*
 * Bit offsets in flags field
 */
#define NFS_INO_REVALIDATING	(0)		/* revalidating attrs */
#define NFS_INO_ADVISE_RDPLUS	(1)		/* advise readdirplus */
#define NFS_INO_STALE		(2)		/* possible stale inode */

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

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

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

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

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

static inline void nfs_mark_for_revalidate(struct inode *inode)
{
	spin_lock(&inode->i_lock);
	NFS_I(inode)->cache_validity |= NFS_INO_INVALID_ATTR | NFS_INO_INVALID_ACCESS;
	spin_unlock(&inode->i_lock);
}

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

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

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

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

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

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

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

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

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

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

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

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

/*
 * linux/fs/nfs/direct.c
 */
extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
			unsigned long);
extern ssize_t nfs_file_direct_read(struct kiocb *iocb, char __user *buf,
			size_t count, loff_t pos);
extern ssize_t nfs_file_direct_write(struct kiocb *iocb, const char __user *buf,
			size_t count, loff_t pos);

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

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

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

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

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

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

/*
 * Try to write back everything synchronously (but check the
 * return value!)
 */
extern int  nfs_sync_inode(struct inode *, unsigned long, unsigned int, int);
#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
extern int  nfs_commit_inode(struct inode *, int);
#else
static inline int
nfs_commit_inode(struct inode *inode, int how)
{
	return 0;
}
#endif

static inline int
nfs_have_writebacks(struct inode *inode)
{
	return NFS_I(inode)->npages != 0;
}

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

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

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

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

static inline struct nfs_write_data *nfs_writedata_alloc(unsigned int pagecount)
{
	struct nfs_write_data *p = mempool_alloc(nfs_wdata_mempool, SLAB_NOFS);

	if (p) {
		memset(p, 0, sizeof(*p));
		INIT_LIST_HEAD(&p->pages);
		if (pagecount < NFS_PAGEVEC_SIZE)
			p->pagevec = &p->page_array[0];
		else {
			size_t size = ++pagecount * sizeof(struct page *);
			p->pagevec = kmalloc(size, GFP_NOFS);
			if (p->pagevec) {
				memset(p->pagevec, 0, size);
			} else {
				mempool_free(p, nfs_wdata_mempool);
				p = NULL;
			}
		}
	}
	return p;
}

static inline void nfs_writedata_free(struct nfs_write_data *p)
{
	if (p && (p->pagevec != &p->page_array[0]))
		kfree(p->pagevec);
	mempool_free(p, nfs_wdata_mempool);
}

/*
 * linux/fs/nfs/read.c
 */
extern int  nfs_readpage(struct file *, struct page *);
extern int  nfs_readpages(struct file *, struct address_space *,
		struct list_head *, unsigned);
extern void nfs_readpage_result(struct rpc_task *, void *);
extern void  nfs_readdata_release(void *data);


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

static inline struct nfs_read_data *nfs_readdata_alloc(unsigned int pagecount)
{
	struct nfs_read_data *p = mempool_alloc(nfs_rdata_mempool, SLAB_NOFS);

	if (p) {
		memset(p, 0, sizeof(*p));
		INIT_LIST_HEAD(&p->pages);
		if (pagecount < NFS_PAGEVEC_SIZE)
			p->pagevec = &p->page_array[0];
		else {
			size_t size = ++pagecount * sizeof(struct page *);
			p->pagevec = kmalloc(size, GFP_NOFS);
			if (p->pagevec) {
				memset(p->pagevec, 0, size);
			} else {
				mempool_free(p, nfs_rdata_mempool);
				p = NULL;
			}
		}
	}
	return p;
}

static inline void nfs_readdata_free(struct nfs_read_data *p)
{
	if (p && (p->pagevec != &p->page_array[0]))
		kfree(p->pagevec);
	mempool_free(p, nfs_rdata_mempool);
}

/*
 * linux/fs/nfs3proc.c
 */
#ifdef CONFIG_NFS_V3_ACL
extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
extern int nfs3_proc_setacl(struct inode *inode, int type,
			    struct posix_acl *acl);
extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
		mode_t mode);
extern void nfs3_forget_cached_acls(struct inode *inode);
#else
static inline int nfs3_proc_set_default_acl(struct inode *dir,
					    struct inode *inode,
					    mode_t mode)
{
	return 0;
}

static inline void nfs3_forget_cached_acls(struct inode *inode)
{
}
#endif /* CONFIG_NFS_V3_ACL */

/*
 * linux/fs/mount_clnt.c
 * (Used only by nfsroot module)
 */
extern int  nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
		int, int);

/*
 * inline functions
 */

static inline loff_t
nfs_size_to_loff_t(__u64 size)
{
	loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
	if (size > maxsz)
		return maxsz;
	return (loff_t) size;
}

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

/* NFS root */

extern void * nfs_root_data(void);

#define nfs_wait_event(clnt, wq, condition)				\
({									\
	int __retval = 0;						\
	if (clnt->cl_intr) {						\
		sigset_t oldmask;					\
		rpc_clnt_sigmask(clnt, &oldmask);			\
		__retval = wait_event_interruptible(wq, condition);	\
		rpc_clnt_sigunmask(clnt, &oldmask);			\
	} else								\
		wait_event(wq, condition);				\
	__retval;							\
})

#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)

#endif /* __KERNEL__ */

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

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

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