[mirror_ubuntu-zesty-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 <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;
};

struct nfs_lock_context {
	atomic_t count;
	struct list_head list;
	struct nfs_open_context *open_context;
	struct nfs_lockowner lockowner;
	atomic_t 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_LAYOUTCOMMIT	(9)		/* layoutcommit required */
#define NFS_INO_LAYOUTCOMMITTING (10)		/* layoutcommit inflight */
#define NFS_INO_LAYOUTSTATS	(11)		/* layoutstats 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_REVAL_PAGECACHE |
				NFS_INO_INVALID_ACCESS |
				NFS_INO_INVALID_ACL;
	if (S_ISDIR(inode->i_mode))
		nfsi->cache_validity |= 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_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_rcu(struct inode *inode);
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 void nfs_file_clear_open_context(struct file *flip);
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(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);

/*
 * 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_sync_inode(struct inode *inode);
extern int nfs_wb_all(struct inode *inode);
extern int nfs_wb_single_page(struct inode *inode, struct page *page, bool launder);
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_wb_launder_page(struct inode *inode, struct page *page)
{
	return nfs_wb_single_page(inode, page, true);
}

static inline int
nfs_wb_page(struct inode *inode, struct page *page)
{
	return nfs_wb_single_page(inode, page, false);
}

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)
{
	return min_t(u64, size, OFFSET_MAX);
}

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