[mirror_ubuntu-bionic-kernel.git] / include / linux / nfs_fs.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  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/refcount.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;
	struct rpc_cred *	cred;
	__u32			mask;
	struct rcu_head		rcu_head;
};

struct nfs_lock_context {
	refcount_t count;
	struct list_head list;
	struct nfs_open_context *open_context;
	fl_owner_t lockowner;
	atomic_t io_count;
};

struct nfs4_state;
struct nfs_open_context {
	struct nfs_lock_context lock_context;
	fl_owner_t flock_owner;
	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)
#define NFS_CONTEXT_UNLOCK	(3)
	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];

	atomic_long_t		nrequests;
	struct nfs_mds_commit_info commit_info;

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

	/* Readers: in-flight sillydelete RPC calls */
	/* Writers: rmdir */
	struct rw_semaphore	rmdir_sem;
	struct mutex		commit_mutex;

#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;
};

/*
 * Access bit flags
 */
#define NFS_ACCESS_READ        0x0001
#define NFS_ACCESS_LOOKUP      0x0002
#define NFS_ACCESS_MODIFY      0x0004
#define NFS_ACCESS_EXTEND      0x0008
#define NFS_ACCESS_DELETE      0x0010
#define NFS_ACCESS_EXECUTE     0x0020

/*
 * 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_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 */
#define NFS_INO_ODIRECT		(12)		/* I/O setting is O_DIRECT */

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 *);
struct inode *nfs_ilookup(struct super_block *sb, struct nfs_fattr *, struct nfs_fh *);
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(const struct path *, struct kstat *, u32, unsigned int);
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_cache_expired(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 bool nfs_mapping_need_revalidate_inode(struct inode *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_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, struct file *filp);
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 *);
extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
			struct iov_iter *iter);
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 *);

/*
 * 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_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(bool never_fail);
extern void nfs_commit_free(struct nfs_commit_data *data);

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