[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 <uapi/linux/nfs_fs.h>


/*
 * Enable dprintk() debugging support for nfs client.
 */
#ifdef CONFIG_NFS_DEBUG
# define NFS_DEBUG
#endif

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

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

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

#include <linux/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 rcu_head		rcu_head;
};

struct nfs_lockowner {
	fl_owner_t l_owner;
	pid_t l_pid;
};

#define NFS_IO_INPROGRESS 0
struct nfs_io_counter {
	unsigned long flags;
	atomic_t io_count;
};

struct nfs_lock_context {
	atomic_t count;
	struct list_head list;
	struct nfs_open_context *open_context;
	struct nfs_lockowner lockowner;
	struct nfs_io_counter io_count;
};

struct nfs4_state;
struct nfs_open_context {
	struct nfs_lock_context lock_context;
	struct dentry *dentry;
	struct rpc_cred *cred;
	struct nfs4_state *state;
	fmode_t mode;

	unsigned long flags;
#define NFS_CONTEXT_ERROR_WRITE		(0)
#define NFS_CONTEXT_RESEND_WRITES	(1)
#define NFS_CONTEXT_BAD			(2)
	int error;

	struct list_head list;
	struct nfs4_threshold	*mdsthreshold;
};

struct nfs_open_dir_context {
	struct list_head list;
	struct rpc_cred *cred;
	unsigned long attr_gencount;
	__u64 dir_cookie;
	__u64 dup_cookie;
	signed char duped;
};

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

	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;

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

	unsigned long		nrequests;
	struct nfs_mds_commit_info commit_info;

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

#if IS_ENABLED(CONFIG_NFS_V4)
	struct nfs4_cached_acl	*nfs4_acl;
        /* NFSv4 state */
	struct list_head	open_states;
	struct nfs_delegation __rcu *delegation;
	struct rw_semaphore	rwsem;

	/* pNFS layout information */
	struct pnfs_layout_hdr *layout;
#endif /* CONFIG_NFS_V4*/
	/* how many bytes have been written/read and how many bytes queued up */
	__u64 write_io;
	__u64 read_io;
#ifdef CONFIG_NFS_FSCACHE
	struct fscache_cookie	*fscache;
#endif
	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 */
#define NFS_INO_INVALID_LABEL	0x0080		/* cached label is invalid */

/*
 * 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_INVALIDATING	(3)		/* inode is being invalidated */
#define NFS_INO_FLUSHING	(4)		/* inode is flushing out data */
#define NFS_INO_FSCACHE		(5)		/* inode can be cached by FS-Cache */
#define NFS_INO_FSCACHE_LOCK	(6)		/* FS-Cache cookie management lock */
#define NFS_INO_COMMIT		(7)		/* inode is committing unstable writes */
#define NFS_INO_LAYOUTCOMMIT	(9)		/* layoutcommit required */
#define NFS_INO_LAYOUTCOMMITTING (10)		/* layoutcommit inflight */

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 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 struct fscache_cookie *nfs_i_fscache(struct inode *inode)
{
#ifdef CONFIG_NFS_FSCACHE
	return NFS_I(inode)->fscache;
#else
	return NULL;
#endif
}

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 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 *, struct nfs4_label *);
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_post_op_update_inode_force_wcc_locked(struct inode *inode, struct nfs_fattr *fattr);
extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
extern void nfs_access_set_mask(struct nfs_access_entry *, u32);
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_attribute_cache_expired(struct inode *inode);
extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
extern int nfs_revalidate_inode_rcu(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_protected(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, struct nfs_fattr *);
extern void nfs_setsecurity(struct inode *inode, struct nfs_fattr *fattr,
				struct nfs4_label *label);
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 struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode);
extern void nfs_inode_attach_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_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
extern u64 nfs_compat_user_ino64(u64 fileid);
extern void nfs_fattr_init(struct nfs_fattr *fattr);
extern void nfs_fattr_set_barrier(struct nfs_fattr *fattr);
extern unsigned long nfs_inc_attr_generation_counter(void);

extern struct nfs_fattr *nfs_alloc_fattr(void);

static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
{
	kfree(fattr);
}

extern struct nfs_fh *nfs_alloc_fhandle(void);

static inline void nfs_free_fhandle(const struct nfs_fh *fh)
{
	kfree(fh);
}

#ifdef NFS_DEBUG
extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
{
	return _nfs_display_fhandle_hash(fh);
}
extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
#define nfs_display_fhandle(fh, caption)			\
	do {							\
		if (unlikely(nfs_debug & NFSDBG_FACILITY))	\
			_nfs_display_fhandle(fh, caption);	\
	} while (0)
#else
static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
{
	return 0;
}
static inline void nfs_display_fhandle(const struct nfs_fh *fh,
				       const char *caption)
{
}
#endif

/*
 * linux/fs/nfs/nfsroot.c
 */
extern int  nfs_root_data(char **root_device, char **root_data); /*__init*/
/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
extern __be32 root_nfs_parse_addr(char *name); /*__init*/

/*
 * linux/fs/nfs/file.c
 */
extern const struct file_operations nfs_file_operations;
#if IS_ENABLED(CONFIG_NFS_V4)
extern const struct file_operations nfs4_file_operations;
#endif /* CONFIG_NFS_V4 */
extern const struct address_space_operations nfs_file_aops;
extern const struct address_space_operations nfs_dir_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/direct.c
 */
extern ssize_t nfs_direct_IO(int, struct kiocb *, struct iov_iter *, loff_t);
extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
			struct iov_iter *iter,
			loff_t pos);
extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
			struct iov_iter *iter,
			loff_t pos);

/*
 * linux/fs/nfs/dir.c
 */
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, struct nfs4_label *label);
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 void nfs_complete_unlink(struct dentry *dentry, struct inode *);
extern void nfs_wait_on_sillyrename(struct dentry *dentry);
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);

/*
 * Try to write back everything synchronously (but check the
 * return value!)
 */
extern int nfs_wb_all(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);
extern int  nfs_commit_inode(struct inode *, int);
extern struct nfs_commit_data *nfs_commitdata_alloc(void);
extern void nfs_commit_free(struct nfs_commit_data *data);

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

/*
 * 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_async(struct nfs_open_context *, struct inode *,
			       struct page *);

/*
 * 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;
}

#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)


# undef ifdebug
# ifdef NFS_DEBUG
#  define ifdebug(fac)		if (unlikely(nfs_debug & NFSDBG_##fac))
#  define NFS_IFDEBUG(x)	x
# else
#  define ifdebug(fac)		if (0)
#  define NFS_IFDEBUG(x)
# endif
#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	*/
1da177e4 LT	8	#ifndef _LINUX_NFS_FS_H
	9	#define _LINUX_NFS_FS_H
	10
607ca46e	11	#include <uapi/linux/nfs_fs.h>
03bf4b70	12
1da177e4	13
e27d359e TM	14	/*
	15	* Enable dprintk() debugging support for nfs client.
	16	*/
	17	#ifdef CONFIG_NFS_DEBUG
	18	# define NFS_DEBUG
	19	#endif
	20
7f1cbe51 DW	21	#include <linux/in.h>
	22	#include <linux/mm.h>
	23	#include <linux/pagemap.h>
1c3c07e9	24	#include <linux/rbtree.h>
7f1cbe51 DW	25	#include <linux/rwsem.h>
	26	#include <linux/wait.h>
	27
	28	#include <linux/sunrpc/debug.h>
	29	#include <linux/sunrpc/auth.h>
	30	#include <linux/sunrpc/clnt.h>
	31
	32	#include <linux/nfs.h>
	33	#include <linux/nfs2.h>
	34	#include <linux/nfs3.h>
	35	#include <linux/nfs4.h>
	36	#include <linux/nfs_xdr.h>
7f1cbe51 DW	37	#include <linux/nfs_fs_sb.h>
7f1cbe51 DW	38
7f1cbe51 DW	39	#include <linux/mempool.h>
	40
	41	/*
	42	* These are the default flags for swap requests
	43	*/
	44	#define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER\|RPC_TASK_ROOTCREDS)
	45
1da177e4 LT	46	/*
	47	* NFSv3/v4 Access mode cache entry
	48	*/
	49	struct nfs_access_entry {
1c3c07e9	50	struct rb_node rb_node;
cfcea3e8	51	struct list_head lru;
1da177e4 LT	52	unsigned long jiffies;
	53	struct rpc_cred * cred;
	54	int mask;
f682a398	55	struct rcu_head rcu_head;
1da177e4 LT	56	};
1da177e4 LT	57
2a369153 TM	58	struct nfs_lockowner {
	59	fl_owner_t l_owner;
	60	pid_t l_pid;
	61	};
	62
577b4232 TM	63	#define NFS_IO_INPROGRESS 0
	64	struct nfs_io_counter {
	65	unsigned long flags;
	66	atomic_t io_count;
	67	};
	68
f11ac8db TM	69	struct nfs_lock_context {
	70	atomic_t count;
	71	struct list_head list;
	72	struct nfs_open_context *open_context;
2a369153	73	struct nfs_lockowner lockowner;
577b4232	74	struct nfs_io_counter io_count;
f11ac8db TM	75	};
f11ac8db TM	76
1da177e4 LT	77	struct nfs4_state;
1da177e4 LT	78	struct nfs_open_context {
f11ac8db	79	struct nfs_lock_context lock_context;
3d4ff43d	80	struct dentry *dentry;
1da177e4 LT	81	struct rpc_cred *cred;
1da177e4 LT	82	struct nfs4_state *state;
dc0b027d	83	fmode_t mode;
7b159fc1 TM	84
	85	unsigned long flags;
	86	#define NFS_CONTEXT_ERROR_WRITE (0)
05990d1b	87	#define NFS_CONTEXT_RESEND_WRITES (1)
c58c8441	88	#define NFS_CONTEXT_BAD (2)
1da177e4 LT	89	int error;
	90
	91	struct list_head list;
82be417a	92	struct nfs4_threshold *mdsthreshold;
480c2006	93	};
00a92642	94
480c2006	95	struct nfs_open_dir_context {
311324ad	96	struct list_head list;
480c2006	97	struct rpc_cred *cred;
0c030806	98	unsigned long attr_gencount;
00a92642	99	__u64 dir_cookie;
8ef2ce3e	100	__u64 dup_cookie;
0c030806	101	signed char duped;
1da177e4 LT	102	};
	103
	104	/*
	105	* NFSv4 delegation
	106	*/
	107	struct nfs_delegation;
	108
5c6a9f7d AG	109	struct posix_acl;
5c6a9f7d AG	110
1da177e4 LT	111	/*
	112	* nfs fs inode data in memory
	113	*/
	114	struct nfs_inode {
	115	/*
	116	* The 64bit 'inode number'
	117	*/
	118	__u64 fileid;
	119
	120	/*
	121	* NFS file handle
	122	*/
	123	struct nfs_fh fh;
	124
	125	/*
	126	* Various flags
	127	*/
412d582e CL	128	unsigned long flags; /* atomic bit ops */
412d582e CL	129	unsigned long cache_validity; /* bit mask */
1da177e4 LT	130
1da177e4 LT	131	/*
24bd68f4	132	* read_cache_jiffies is when we started read-caching this inode.
1da177e4 LT	133	* attrtimeo is for how long the cached information is assumed
	134	* to be valid. A successful attribute revalidation doubles
	135	* attrtimeo (up to acregmax/acdirmax), a failure resets it to
	136	* acregmin/acdirmin.
	137	*
	138	* We need to revalidate the cached attrs for this inode if
	139	*
64672d55 PS	140	* jiffies - read_cache_jiffies >= attrtimeo
	141	*
	142	* Please note the comparison is greater than or equal
	143	* so that zero timeout values can be specified.
1da177e4	144	*/
1da177e4 LT	145	unsigned long read_cache_jiffies;
	146	unsigned long attrtimeo;
	147	unsigned long attrtimeo_timestamp;
1da177e4	148
4704f0e2	149	unsigned long attr_gencount;
1da177e4 LT	150	/* "Generation counter" for the attribute cache. This is
	151	* bumped whenever we update the metadata on the
	152	* server.
	153	*/
	154	unsigned long cache_change_attribute;
1da177e4	155
1c3c07e9	156	struct rb_root access_cache;
cfcea3e8 TM	157	struct list_head access_cache_entry_lru;
cfcea3e8 TM	158	struct list_head access_cache_inode_lru;
1da177e4 LT	159
	160	/*
	161	* This is the cookie verifier used for NFSv3 readdir
	162	* operations
	163	*/
bc4785cd	164	__be32 cookieverf[2];
1da177e4	165
cb1410c7	166	unsigned long nrequests;
ea2cf228	167	struct nfs_mds_commit_info commit_info;
1da177e4 LT	168
	169	/* Open contexts for shared mmap writes */
	170	struct list_head open_files;
	171
565277f6 TM	172	/* Number of in-flight sillydelete RPC calls */
	173	atomic_t silly_count;
	174	/* List of deferred sillydelete requests */
	175	struct hlist_head silly_list;
	176	wait_queue_head_t waitqueue;
	177
89d77c8f	178	#if IS_ENABLED(CONFIG_NFS_V4)
e50a1c2e	179	struct nfs4_cached_acl *nfs4_acl;
1da177e4 LT	180	/* NFSv4 state */
1da177e4 LT	181	struct list_head open_states;
5b22216e	182	struct nfs_delegation __rcu *delegation;
1da177e4	183	struct rw_semaphore rwsem;
e5e94017 BH	184
	185	/* pNFS layout information */
	186	struct pnfs_layout_hdr *layout;
1da177e4	187	#endif /* CONFIG_NFS_V4*/
2701d086 AA	188	/* how many bytes have been written/read and how many bytes queued up */
	189	__u64 write_io;
	190	__u64 read_io;
ef79c097 DH	191	#ifdef CONFIG_NFS_FSCACHE
	192	struct fscache_cookie *fscache;
	193	#endif
1da177e4 LT	194	struct inode vfs_inode;
	195	};
	196
	197	/*
55296809	198	* Cache validity bit flags
1da177e4	199	*/
55296809 CL	200	#define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
	201	#define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
	202	#define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
	203	#define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
	204	#define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
	205	#define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
412c77ce	206	#define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
aa9c2669	207	#define NFS_INO_INVALID_LABEL 0x0080 /* cached label is invalid */
55296809 CL	208
55296809 CL	209	/*
412d582e	210	* Bit offsets in flags field
55296809	211	*/
691beb13 TM	212	#define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
	213	#define NFS_INO_STALE (1) /* possible stale inode */
	214	#define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
d529ef83	215	#define NFS_INO_INVALIDATING (3) /* inode is being invalidated */
72cb77f4	216	#define NFS_INO_FLUSHING (4) /* inode is flushing out data */
ef79c097 DH	217	#define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
ef79c097 DH	218	#define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
71d0a611	219	#define NFS_INO_COMMIT (7) /* inode is committing unstable writes */
863a3c6c	220	#define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
92407e75	221	#define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
1da177e4	222
99fadcd7	223	static inline struct nfs_inode NFS_I(const struct inode inode)
1da177e4 LT	224	{
	225	return container_of(inode, struct nfs_inode, vfs_inode);
	226	}
99fadcd7 BH	227
	228	static inline struct nfs_server NFS_SB(const struct super_block s)
	229	{
	230	return (struct nfs_server *)(s->s_fs_info);
	231	}
	232
	233	static inline struct nfs_fh NFS_FH(const struct inode inode)
	234	{
	235	return &NFS_I(inode)->fh;
	236	}
	237
	238	static inline struct nfs_server NFS_SERVER(const struct inode inode)
	239	{
	240	return NFS_SB(inode->i_sb);
	241	}
	242
	243	static inline struct rpc_clnt NFS_CLIENT(const struct inode inode)
	244	{
	245	return NFS_SERVER(inode)->client;
	246	}
	247
	248	static inline const struct nfs_rpc_ops NFS_PROTO(const struct inode inode)
	249	{
	250	return NFS_SERVER(inode)->nfs_client->rpc_ops;
	251	}
	252
99fadcd7 BH	253	static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
	254	{
	255	struct nfs_server *nfss = NFS_SERVER(inode);
	256	return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
	257	}
	258
	259	static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
	260	{
	261	struct nfs_server *nfss = NFS_SERVER(inode);
	262	return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
	263	}
	264
	265	static inline int NFS_STALE(const struct inode *inode)
	266	{
	267	return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
	268	}
	269
f1fe29b4	270	static inline struct fscache_cookie nfs_i_fscache(struct inode inode)
ef79c097	271	{
f1fe29b4 DH	272	#ifdef CONFIG_NFS_FSCACHE
	273	return NFS_I(inode)->fscache;
	274	#else
	275	return NULL;
	276	#endif
ef79c097 DH	277	}
ef79c097 DH	278
99fadcd7 BH	279	static inline __u64 NFS_FILEID(const struct inode *inode)
	280	{
	281	return NFS_I(inode)->fileid;
	282	}
	283
	284	static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
	285	{
	286	NFS_I(inode)->fileid = fileid;
	287	}
1da177e4	288
decf491f TM	289	static inline void nfs_mark_for_revalidate(struct inode *inode)
decf491f TM	290	{
38478b24 TM	291	struct nfs_inode *nfsi = NFS_I(inode);
38478b24 TM	292
decf491f	293	spin_lock(&inode->i_lock);
38478b24	294	nfsi->cache_validity \|= NFS_INO_INVALID_ATTR\|NFS_INO_INVALID_ACCESS;
f3821110	295	if (S_ISDIR(inode->i_mode))
38478b24	296	nfsi->cache_validity \|= NFS_INO_REVAL_PAGECACHE\|NFS_INO_INVALID_DATA;
decf491f TM	297	spin_unlock(&inode->i_lock);
	298	}
	299
1da177e4 LT	300	static inline int nfs_server_capable(struct inode *inode, int cap)
	301	{
	302	return NFS_SERVER(inode)->caps & cap;
	303	}
	304
d75340cc TM	305	static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
	306	{
	307	dentry->d_time = verf;
	308	}
	309
1da177e4 LT	310	/**
1da177e4 LT	311	* nfs_save_change_attribute - Returns the inode attribute change cookie
8edb0182	312	* @dir - pointer to parent directory inode
1da177e4 LT	313	* The "change attribute" is updated every time we finish an operation
	314	* that will result in a metadata change on the server.
	315	*/
8edb0182	316	static inline unsigned long nfs_save_change_attribute(struct inode *dir)
1da177e4	317	{
8edb0182	318	return NFS_I(dir)->cache_change_attribute;
1da177e4 LT	319	}
	320
	321	/**
4b841736 TM	322	* nfs_verify_change_attribute - Detects NFS remote directory changes
4b841736 TM	323	* @dir - pointer to parent directory inode
1da177e4	324	* @chattr - previously saved change attribute
4b841736 TM	325	* Return "false" if the verifiers doesn't match the change attribute.
	326	* This would usually indicate that the directory contents have changed on
	327	* the server, and that any dentries need revalidating.
1da177e4	328	*/
4b841736	329	static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
1da177e4	330	{
4b841736	331	return chattr == NFS_I(dir)->cache_change_attribute;
1da177e4 LT	332	}
	333
	334	/*
	335	* linux/fs/nfs/inode.c
	336	*/
29884df0	337	extern int nfs_sync_mapping(struct address_space *mapping);
cd9ae2b6	338	extern void nfs_zap_mapping(struct inode inode, struct address_space mapping);
1da177e4	339	extern void nfs_zap_caches(struct inode *);
c4812998	340	extern void nfs_invalidate_atime(struct inode *);
1da177e4	341	extern struct inode nfs_fhget(struct super_block , struct nfs_fh *,
1775fd3e	342	struct nfs_fattr , struct nfs4_label );
1da177e4	343	extern int nfs_refresh_inode(struct inode , struct nfs_fattr );
decf491f	344	extern int nfs_post_op_update_inode(struct inode inode, struct nfs_fattr fattr);
70ca8852	345	extern int nfs_post_op_update_inode_force_wcc(struct inode inode, struct nfs_fattr fattr);
a08a8cd3	346	extern int nfs_post_op_update_inode_force_wcc_locked(struct inode inode, struct nfs_fattr fattr);
1da177e4	347	extern int nfs_getattr(struct vfsmount , struct dentry , struct kstat *);
6168f62c WAA	348	extern void nfs_access_add_cache(struct inode , struct nfs_access_entry );
6168f62c WAA	349	extern void nfs_access_set_mask(struct nfs_access_entry *, u32);
10556cb2	350	extern int nfs_permission(struct inode *, int);
1da177e4 LT	351	extern int nfs_open(struct inode , struct file );
	352	extern int nfs_release(struct inode , struct file );
	353	extern int nfs_attribute_timeout(struct inode *inode);
43f291cd	354	extern int nfs_attribute_cache_expired(struct inode *inode);
1da177e4	355	extern int nfs_revalidate_inode(struct nfs_server server, struct inode inode);
912a108d	356	extern int nfs_revalidate_inode_rcu(struct nfs_server server, struct inode inode);
1da177e4	357	extern int __nfs_revalidate_inode(struct nfs_server , struct inode );
44b11874	358	extern int nfs_revalidate_mapping(struct inode inode, struct address_space mapping);
874f9463	359	extern int nfs_revalidate_mapping_protected(struct inode inode, struct address_space mapping);
1da177e4	360	extern int nfs_setattr(struct dentry , struct iattr );
f044636d	361	extern void nfs_setattr_update_inode(struct inode inode, struct iattr attr, struct nfs_fattr *);
aa9c2669 DQ	362	extern void nfs_setsecurity(struct inode inode, struct nfs_fattr fattr,
aa9c2669 DQ	363	struct nfs4_label *label);
1da177e4 LT	364	extern struct nfs_open_context get_nfs_open_context(struct nfs_open_context ctx);
1da177e4 LT	365	extern void put_nfs_open_context(struct nfs_open_context *ctx);
dc0b027d	366	extern struct nfs_open_context nfs_find_open_context(struct inode inode, struct rpc_cred *cred, fmode_t mode);
5ede7b1c	367	extern struct nfs_open_context alloc_nfs_open_context(struct dentry dentry, fmode_t f_mode);
c45ffdd2	368	extern void nfs_inode_attach_open_context(struct nfs_open_context *ctx);
cd9a1c0e	369	extern void nfs_file_set_open_context(struct file filp, struct nfs_open_context ctx);
f11ac8db TM	370	extern struct nfs_lock_context nfs_get_lock_context(struct nfs_open_context ctx);
f11ac8db TM	371	extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
f43bf0be	372	extern u64 nfs_compat_user_ino64(u64 fileid);
4704f0e2	373	extern void nfs_fattr_init(struct nfs_fattr *fattr);
140e049c	374	extern void nfs_fattr_set_barrier(struct nfs_fattr *fattr);
56463e50	375	extern unsigned long nfs_inc_attr_generation_counter(void);
1da177e4	376
2d36bfde TM	377	extern struct nfs_fattr *nfs_alloc_fattr(void);
	378
	379	static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
	380	{
	381	kfree(fattr);
	382	}
	383
	384	extern struct nfs_fh *nfs_alloc_fhandle(void);
	385
	386	static inline void nfs_free_fhandle(const struct nfs_fh *fh)
	387	{
	388	kfree(fh);
	389	}
	390
e27d359e	391	#ifdef NFS_DEBUG
d8e0539e WAA	392	extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
	393	static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
	394	{
	395	return _nfs_display_fhandle_hash(fh);
	396	}
20d27e92 CL	397	extern void _nfs_display_fhandle(const struct nfs_fh fh, const char caption);
	398	#define nfs_display_fhandle(fh, caption) \
	399	do { \
	400	if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
	401	_nfs_display_fhandle(fh, caption); \
	402	} while (0)
	403	#else
d8e0539e WAA	404	static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
d8e0539e WAA	405	{
9304a812	406	return 0;
d8e0539e	407	}
20d27e92 CL	408	static inline void nfs_display_fhandle(const struct nfs_fh *fh,
	409	const char *caption)
	410	{
	411	}
	412	#endif
	413
56463e50 CL	414	/*
	415	* linux/fs/nfs/nfsroot.c
	416	*/
	417	extern int nfs_root_data(char root_device, char root_data); /__init/
1da177e4	418	/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
5a874db4	419	extern __be32 root_nfs_parse_addr(char name); /__init*/
0e574af1	420
1da177e4 LT	421	/*
	422	* linux/fs/nfs/file.c
	423	*/
4b6f5d20	424	extern const struct file_operations nfs_file_operations;
89d77c8f	425	#if IS_ENABLED(CONFIG_NFS_V4)
1788ea6e JL	426	extern const struct file_operations nfs4_file_operations;
1788ea6e JL	427	#endif /* CONFIG_NFS_V4 */
f5e54d6e	428	extern const struct address_space_operations nfs_file_aops;
11de3b11	429	extern const struct address_space_operations nfs_dir_aops;
1da177e4	430
c03025d5 TM	431	static inline struct nfs_open_context nfs_file_open_context(struct file filp)
	432	{
	433	return filp->private_data;
	434	}
	435
1da177e4 LT	436	static inline struct rpc_cred nfs_file_cred(struct file file)
1da177e4 LT	437	{
504e5189 NB	438	if (file != NULL) {
	439	struct nfs_open_context *ctx =
	440	nfs_file_open_context(file);
	441	if (ctx)
	442	return ctx->cred;
	443	}
1da177e4 LT	444	return NULL;
	445	}
	446
	447	/*
	448	* linux/fs/nfs/direct.c
	449	*/
d8d3d94b	450	extern ssize_t nfs_direct_IO(int, struct kiocb , struct iov_iter , loff_t);
027445c3	451	extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
619d30b4	452	struct iov_iter *iter,
e19a8a0a	453	loff_t pos);
027445c3	454	extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
619d30b4	455	struct iov_iter *iter,
e19a8a0a	456	loff_t pos);
1da177e4 LT	457
	458	/*
	459	* linux/fs/nfs/dir.c
	460	*/
4b6f5d20	461	extern const struct file_operations nfs_dir_operations;
f786aa90	462	extern const struct dentry_operations nfs_dentry_operations;
1da177e4	463
bfc69a45	464	extern void nfs_force_lookup_revalidate(struct inode *dir);
1775fd3e DQ	465	extern int nfs_instantiate(struct dentry dentry, struct nfs_fh fh,
1775fd3e DQ	466	struct nfs_fattr fattr, struct nfs4_label label);
af22f94a TM	467	extern int nfs_may_open(struct inode inode, struct rpc_cred cred, int openflags);
af22f94a TM	468	extern void nfs_access_zap_cache(struct inode *inode);
1da177e4 LT	469
	470	/*
	471	* linux/fs/nfs/symlink.c
	472	*/
c5ef1c42	473	extern const struct inode_operations nfs_symlink_inode_operations;
1da177e4	474
a72b4422 TM	475	/*
	476	* linux/fs/nfs/sysctl.c
	477	*/
	478	#ifdef CONFIG_SYSCTL
	479	extern int nfs_register_sysctl(void);
	480	extern void nfs_unregister_sysctl(void);
	481	#else
7fd105e7	482	#define nfs_register_sysctl() 0
a72b4422 TM	483	#define nfs_unregister_sysctl() do { } while(0)
	484	#endif
	485
55a97593 TM	486	/*
	487	* linux/fs/nfs/namespace.c
	488	*/
c5ef1c42 AV	489	extern const struct inode_operations nfs_mountpoint_inode_operations;
c5ef1c42 AV	490	extern const struct inode_operations nfs_referral_inode_operations;
51d8fa6a TM	491	extern int nfs_mountpoint_expiry_timeout;
51d8fa6a TM	492	extern void nfs_release_automount_timer(void);
55a97593	493
1da177e4 LT	494	/*
	495	* linux/fs/nfs/unlink.c
	496	*/
e4eff1a6	497	extern void nfs_complete_unlink(struct dentry dentry, struct inode );
ba6c0592	498	extern void nfs_wait_on_sillyrename(struct dentry *dentry);
565277f6 TM	499	extern void nfs_block_sillyrename(struct dentry *dentry);
565277f6 TM	500	extern void nfs_unblock_sillyrename(struct dentry *dentry);
1da177e4 LT	501
	502	/*
	503	* linux/fs/nfs/write.c
	504	*/
89a09141	505	extern int nfs_congestion_kb;
1da177e4 LT	506	extern int nfs_writepage(struct page page, struct writeback_control wbc);
	507	extern int nfs_writepages(struct address_space , struct writeback_control );
	508	extern int nfs_flush_incompatible(struct file file, struct page page);
	509	extern int nfs_updatepage(struct file , struct page , unsigned int, unsigned int);
1da177e4 LT	510
	511	/*
	512	* Try to write back everything synchronously (but check the
	513	* return value!)
	514	*/
1c75950b TM	515	extern int nfs_wb_all(struct inode *inode);
1c75950b TM	516	extern int nfs_wb_page(struct inode inode, struct page page);
1b3b4a1a	517	extern int nfs_wb_page_cancel(struct inode inode, struct page page);
b608b283	518	extern int nfs_commit_inode(struct inode *, int);
0b7c0153 FI	519	extern struct nfs_commit_data *nfs_commitdata_alloc(void);
0b7c0153 FI	520	extern void nfs_commit_free(struct nfs_commit_data *data);
1da177e4 LT	521
	522	static inline int
	523	nfs_have_writebacks(struct inode *inode)
	524	{
cb1410c7	525	return NFS_I(inode)->nrequests != 0;
1da177e4 LT	526	}
1da177e4 LT	527
1da177e4 LT	528	/*
	529	* linux/fs/nfs/read.c
	530	*/
	531	extern int nfs_readpage(struct file , struct page );
	532	extern int nfs_readpages(struct file , struct address_space ,
	533	struct list_head *, unsigned);
f42b293d DH	534	extern int nfs_readpage_async(struct nfs_open_context , struct inode ,
f42b293d DH	535	struct page *);
963d8fe5	536
1da177e4 LT	537	/*
	538	* inline functions
	539	*/
	540
433c9237	541	static inline loff_t nfs_size_to_loff_t(__u64 size)
1da177e4	542	{
433c9237 CL	543	if (size > (__u64) OFFSET_MAX - 1)
433c9237 CL	544	return OFFSET_MAX - 1;
1da177e4 LT	545	return (loff_t) size;
	546	}
	547
	548	static inline ino_t
	549	nfs_fileid_to_ino_t(u64 fileid)
	550	{
	551	ino_t ino = (ino_t) fileid;
	552	if (sizeof(ino_t) < sizeof(u64))
	553	ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
	554	return ino;
	555	}
	556
1da177e4 LT	557	#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
1da177e4 LT	558
4dc2eaec	559
1da177e4 LT	560	# undef ifdebug
	561	# ifdef NFS_DEBUG
	562	# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
6f00866d	563	# define NFS_IFDEBUG(x) x
1da177e4 LT	564	# else
1da177e4 LT	565	# define ifdebug(fac) if (0)
6f00866d	566	# define NFS_IFDEBUG(x)
1da177e4	567	# endif
1da177e4	568	#endif