[mirror_ubuntu-focal-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/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 {
	atomic_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;
};

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