[linux-block.git] / include / linux / nfs_fs.h

/*
 *  linux/include/linux/nfs_fs.h
 *
 *  Copyright (C) 1992  Rick Sladkey
 *
 *  OS-specific nfs filesystem definitions and declarations
 */

#ifndef _LINUX_NFS_FS_H
#define _LINUX_NFS_FS_H

#include <linux/config.h>
#include <linux/in.h>
#include <linux/mm.h>
#include <linux/pagemap.h>
#include <linux/rwsem.h>
#include <linux/wait.h>

#include <linux/nfs_fs_sb.h>

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

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

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

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

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

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

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

#ifdef __KERNEL__

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

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

	struct list_head list;

	__u64 dir_cookie;
};

/*
 * NFSv4 delegation
 */
struct nfs_delegation;

struct posix_acl;

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

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

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

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

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

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

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

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

	unsigned int		ndirty,
				ncommit,
				npages;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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