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

#ifndef _NFS_FS_SB
#define _NFS_FS_SB

#include <linux/list.h>
#include <linux/backing-dev.h>
#include <linux/idr.h>
#include <linux/wait.h>
#include <linux/nfs_xdr.h>
#include <linux/sunrpc/xprt.h>

#include <linux/atomic.h>

struct nfs4_session;
struct nfs_iostats;
struct nlm_host;
struct nfs4_sequence_args;
struct nfs4_sequence_res;
struct nfs_server;
struct nfs4_minor_version_ops;
struct nfs41_server_scope;
struct nfs41_impl_id;

/*
 * The nfs_client identifies our client state to the server.
 */
struct nfs_client {
	atomic_t		cl_count;
	atomic_t		cl_mds_count;
	int			cl_cons_state;	/* current construction state (-ve: init error) */
#define NFS_CS_READY		0		/* ready to be used */
#define NFS_CS_INITING		1		/* busy initialising */
#define NFS_CS_SESSION_INITING	2		/* busy initialising  session */
	unsigned long		cl_res_state;	/* NFS resources state */
#define NFS_CS_CALLBACK		1		/* - callback started */
#define NFS_CS_IDMAP		2		/* - idmap started */
#define NFS_CS_RENEWD		3		/* - renewd started */
#define NFS_CS_STOP_RENEW	4		/* no more state to renew */
#define NFS_CS_CHECK_LEASE_TIME	5		/* need to check lease time */
	unsigned long		cl_flags;	/* behavior switches */
#define NFS_CS_NORESVPORT	0		/* - use ephemeral src port */
#define NFS_CS_DISCRTRY		1		/* - disconnect on RPC retry */
#define NFS_CS_MIGRATION	2		/* - transparent state migr */
#define NFS_CS_INFINITE_SLOTS	3		/* - don't limit TCP slots */
	struct sockaddr_storage	cl_addr;	/* server identifier */
	size_t			cl_addrlen;
	char *			cl_hostname;	/* hostname of server */
	struct list_head	cl_share_link;	/* link in global client list */
	struct list_head	cl_superblocks;	/* List of nfs_server structs */

	struct rpc_clnt *	cl_rpcclient;
	const struct nfs_rpc_ops *rpc_ops;	/* NFS protocol vector */
	int			cl_proto;	/* Network transport protocol */
	struct nfs_subversion *	cl_nfs_mod;	/* pointer to nfs version module */

	u32			cl_minorversion;/* NFSv4 minorversion */
	struct rpc_cred		*cl_machine_cred;

#if IS_ENABLED(CONFIG_NFS_V4)
	struct list_head	cl_ds_clients; /* auth flavor data servers */
	u64			cl_clientid;	/* constant */
	nfs4_verifier		cl_confirm;	/* Clientid verifier */
	unsigned long		cl_state;

	spinlock_t		cl_lock;

	unsigned long		cl_lease_time;
	unsigned long		cl_last_renewal;
	struct delayed_work	cl_renewd;

	struct rpc_wait_queue	cl_rpcwaitq;

	/* idmapper */
	struct idmap *		cl_idmap;

	/* Our own IP address, as a null-terminated string.
	 * This is used to generate the mv0 callback address.
	 */
	char			cl_ipaddr[48];
	u32			cl_cb_ident;	/* v4.0 callback identifier */
	const struct nfs4_minor_version_ops *cl_mvops;

	/* NFSv4.0 transport blocking */
	struct nfs4_slot_table	*cl_slot_tbl;

	/* The sequence id to use for the next CREATE_SESSION */
	u32			cl_seqid;
	/* The flags used for obtaining the clientid during EXCHANGE_ID */
	u32			cl_exchange_flags;
	struct nfs4_session	*cl_session;	/* shared session */
	bool			cl_preserve_clid;
	struct nfs41_server_owner *cl_serverowner;
	struct nfs41_server_scope *cl_serverscope;
	struct nfs41_impl_id	*cl_implid;
	/* nfs 4.1+ state protection modes: */
	unsigned long		cl_sp4_flags;
#define NFS_SP4_MACH_CRED_MINIMAL  1	/* Minimal sp4_mach_cred - state ops
					 * must use machine cred */
#define NFS_SP4_MACH_CRED_CLEANUP  2	/* CLOSE and LOCKU */
#define NFS_SP4_MACH_CRED_SECINFO  3	/* SECINFO and SECINFO_NO_NAME */
#define NFS_SP4_MACH_CRED_STATEID  4	/* TEST_STATEID and FREE_STATEID */
#define NFS_SP4_MACH_CRED_WRITE    5	/* WRITE */
#define NFS_SP4_MACH_CRED_COMMIT   6	/* COMMIT */
#endif /* CONFIG_NFS_V4 */

#ifdef CONFIG_NFS_FSCACHE
	struct fscache_cookie	*fscache;	/* client index cache cookie */
#endif

	struct net		*cl_net;
};

/*
 * NFS client parameters stored in the superblock.
 */
struct nfs_server {
	struct nfs_client *	nfs_client;	/* shared client and NFS4 state */
	struct list_head	client_link;	/* List of other nfs_server structs
						 * that share the same client
						 */
	struct list_head	master_link;	/* link in master servers list */
	struct rpc_clnt *	client;		/* RPC client handle */
	struct rpc_clnt *	client_acl;	/* ACL RPC client handle */
	struct nlm_host		*nlm_host;	/* NLM client handle */
	struct nfs_iostats __percpu *io_stats;	/* I/O statistics */
	struct backing_dev_info	backing_dev_info;
	atomic_long_t		writeback;	/* number of writeback pages */
	int			flags;		/* various flags */
	unsigned int		caps;		/* server capabilities */
	unsigned int		rsize;		/* read size */
	unsigned int		rpages;		/* read size (in pages) */
	unsigned int		wsize;		/* write size */
	unsigned int		wpages;		/* write size (in pages) */
	unsigned int		wtmult;		/* server disk block size */
	unsigned int		dtsize;		/* readdir size */
	unsigned short		port;		/* "port=" setting */
	unsigned int		bsize;		/* server block size */
	unsigned int		acregmin;	/* attr cache timeouts */
	unsigned int		acregmax;
	unsigned int		acdirmin;
	unsigned int		acdirmax;
	unsigned int		namelen;
	unsigned int		options;	/* extra options enabled by mount */
#define NFS_OPTION_FSCACHE	0x00000001	/* - local caching enabled */
#define NFS_OPTION_MIGRATION	0x00000002	/* - NFSv4 migration enabled */

	struct nfs_fsid		fsid;
	__u64			maxfilesize;	/* maximum file size */
	struct timespec		time_delta;	/* smallest time granularity */
	unsigned long		mount_time;	/* when this fs was mounted */
	dev_t			s_dev;		/* superblock dev numbers */

#ifdef CONFIG_NFS_FSCACHE
	struct nfs_fscache_key	*fscache_key;	/* unique key for superblock */
	struct fscache_cookie	*fscache;	/* superblock cookie */
#endif

	u32			pnfs_blksize;	/* layout_blksize attr */
#if IS_ENABLED(CONFIG_NFS_V4)
	u32			attr_bitmask[3];/* V4 bitmask representing the set
						   of attributes supported on this
						   filesystem */
	u32			attr_bitmask_nl[3];
						/* V4 bitmask representing the
						   set of attributes supported
						   on this filesystem excluding
						   the label support bit. */
	u32			cache_consistency_bitmask[3];
						/* V4 bitmask representing the subset
						   of change attribute, size, ctime
						   and mtime attributes supported by
						   the server */
	u32			acl_bitmask;	/* V4 bitmask representing the ACEs
						   that are supported on this
						   filesystem */
	u32			fh_expire_type;	/* V4 bitmask representing file
						   handle volatility type for
						   this filesystem */
	struct pnfs_layoutdriver_type  *pnfs_curr_ld; /* Active layout driver */
	struct rpc_wait_queue	roc_rpcwaitq;
	void			*pnfs_ld_data;	/* per mount point data */

	/* the following fields are protected by nfs_client->cl_lock */
	struct rb_root		state_owners;
#endif
	struct ida		openowner_id;
	struct ida		lockowner_id;
	struct list_head	state_owners_lru;
	struct list_head	layouts;
	struct list_head	delegations;
	void (*destroy)(struct nfs_server *);

	atomic_t active; /* Keep trace of any activity to this server */

	/* mountd-related mount options */
	struct sockaddr_storage	mountd_address;
	size_t			mountd_addrlen;
	u32			mountd_version;
	unsigned short		mountd_port;
	unsigned short		mountd_protocol;
};

/* Server capabilities */
#define NFS_CAP_READDIRPLUS	(1U << 0)
#define NFS_CAP_HARDLINKS	(1U << 1)
#define NFS_CAP_SYMLINKS	(1U << 2)
#define NFS_CAP_ACLS		(1U << 3)
#define NFS_CAP_ATOMIC_OPEN	(1U << 4)
#define NFS_CAP_CHANGE_ATTR	(1U << 5)
#define NFS_CAP_FILEID		(1U << 6)
#define NFS_CAP_MODE		(1U << 7)
#define NFS_CAP_NLINK		(1U << 8)
#define NFS_CAP_OWNER		(1U << 9)
#define NFS_CAP_OWNER_GROUP	(1U << 10)
#define NFS_CAP_ATIME		(1U << 11)
#define NFS_CAP_CTIME		(1U << 12)
#define NFS_CAP_MTIME		(1U << 13)
#define NFS_CAP_POSIX_LOCK	(1U << 14)
#define NFS_CAP_UIDGID_NOMAP	(1U << 15)
#define NFS_CAP_STATEID_NFSV41	(1U << 16)
#define NFS_CAP_ATOMIC_OPEN_V1	(1U << 17)
#define NFS_CAP_SECURITY_LABEL	(1U << 18)

#endif
Commit	Line	Data
1da177e4 LT	1	#ifndef _NFS_FS_SB
	2	#define _NFS_FS_SB
	3
	4	#include <linux/list.h>
	5	#include <linux/backing-dev.h>
9157c31d	6	#include <linux/idr.h>
ef818a28	7	#include <linux/wait.h>
557134a3 AA	8	#include <linux/nfs_xdr.h>
557134a3 AA	9	#include <linux/sunrpc/xprt.h>
ef818a28	10
60063497	11	#include <linux/atomic.h>
1da177e4	12
557134a3	13	struct nfs4_session;
d9ef5a8c	14	struct nfs_iostats;
9289e7f9	15	struct nlm_host;
cccef3b9 AA	16	struct nfs4_sequence_args;
	17	struct nfs4_sequence_res;
	18	struct nfs_server;
97dc1359	19	struct nfs4_minor_version_ops;
79d4e1f0	20	struct nfs41_server_scope;
7d2ed9ac	21	struct nfs41_impl_id;
d9ef5a8c	22
24c8dbbb DH	23	/*
	24	* The nfs_client identifies our client state to the server.
	25	*/
	26	struct nfs_client {
	27	atomic_t cl_count;
2a4c8994	28	atomic_t cl_mds_count;
24c8dbbb DH	29	int cl_cons_state; /* current construction state (-ve: init error) */
	30	#define NFS_CS_READY 0 /* ready to be used */
	31	#define NFS_CS_INITING 1 /* busy initialising */
76db6d95	32	#define NFS_CS_SESSION_INITING 2 /* busy initialising session */
24c8dbbb	33	unsigned long cl_res_state; /* NFS resources state */
24c8dbbb DH	34	#define NFS_CS_CALLBACK 1 /* - callback started */
24c8dbbb DH	35	#define NFS_CS_IDMAP 2 /* - idmap started */
5dd3177a	36	#define NFS_CS_RENEWD 3 /* - renewd started */
d3b4c9d7	37	#define NFS_CS_STOP_RENEW 4 /* no more state to renew */
d6fb79d4	38	#define NFS_CS_CHECK_LEASE_TIME 5 /* need to check lease time */
4bf590e0 CL	39	unsigned long cl_flags; /* behavior switches */
	40	#define NFS_CS_NORESVPORT 0 /* - use ephemeral src port */
	41	#define NFS_CS_DISCRTRY 1 /* - disconnect on RPC retry */
89652617	42	#define NFS_CS_MIGRATION 2 /* - transparent state migr */
98f98cf5	43	#define NFS_CS_INFINITE_SLOTS 3 /* - don't limit TCP slots */
6e4cffd7 CL	44	struct sockaddr_storage cl_addr; /* server identifier */
6e4cffd7 CL	45	size_t cl_addrlen;
24c8dbbb DH	46	char * cl_hostname; /* hostname of server */
	47	struct list_head cl_share_link; /* link in global client list */
	48	struct list_head cl_superblocks; /* List of nfs_server structs */
	49
	50	struct rpc_clnt * cl_rpcclient;
8fa5c000	51	const struct nfs_rpc_ops rpc_ops; / NFS protocol vector */
59dca3b2	52	int cl_proto; /* Network transport protocol */
ab7017a3	53	struct nfs_subversion * cl_nfs_mod; /* pointer to nfs version module */
24c8dbbb	54
94a417f3	55	u32 cl_minorversion;/* NFSv4 minorversion */
7c67db3a TM	56	struct rpc_cred *cl_machine_cred;
7c67db3a TM	57
89d77c8f	58	#if IS_ENABLED(CONFIG_NFS_V4)
0e20162e	59	struct list_head cl_ds_clients; /* auth flavor data servers */
24c8dbbb	60	u64 cl_clientid; /* constant */
fd954ae1	61	nfs4_verifier cl_confirm; /* Clientid verifier */
24c8dbbb DH	62	unsigned long cl_state;
24c8dbbb DH	63
24c8dbbb DH	64	spinlock_t cl_lock;
	65
	66	unsigned long cl_lease_time;
	67	unsigned long cl_last_renewal;
52bad64d	68	struct delayed_work cl_renewd;
24c8dbbb DH	69
	70	struct rpc_wait_queue cl_rpcwaitq;
	71
24c8dbbb DH	72	/* idmapper */
	73	struct idmap * cl_idmap;
	74
	75	/* Our own IP address, as a null-terminated string.
de734831	76	* This is used to generate the mv0 callback address.
24c8dbbb	77	*/
4392f259	78	char cl_ipaddr[48];
f4eecd5d	79	u32 cl_cb_ident; /* v4.0 callback identifier */
97dc1359	80	const struct nfs4_minor_version_ops *cl_mvops;
14727281	81
abf79bb3 CL	82	/* NFSv4.0 transport blocking */
	83	struct nfs4_slot_table *cl_slot_tbl;
	84
99fe60d0 BH	85	/* The sequence id to use for the next CREATE_SESSION */
	86	u32 cl_seqid;
	87	/* The flags used for obtaining the clientid during EXCHANGE_ID */
	88	u32 cl_exchange_flags;
722baafc	89	struct nfs4_session cl_session; / shared session */
05f4c350	90	bool cl_preserve_clid;
acdeb69d	91	struct nfs41_server_owner *cl_serverowner;
79d4e1f0	92	struct nfs41_server_scope *cl_serverscope;
59155546	93	struct nfs41_impl_id *cl_implid;
2031cd1a WAA	94	/* nfs 4.1+ state protection modes: */
	95	unsigned long cl_sp4_flags;
	96	#define NFS_SP4_MACH_CRED_MINIMAL 1 /* Minimal sp4_mach_cred - state ops
	97	* must use machine cred */
fa940720	98	#define NFS_SP4_MACH_CRED_CLEANUP 2 /* CLOSE and LOCKU */
8b5bee2e	99	#define NFS_SP4_MACH_CRED_SECINFO 3 /* SECINFO and SECINFO_NO_NAME */
3787d506	100	#define NFS_SP4_MACH_CRED_STATEID 4 /* TEST_STATEID and FREE_STATEID */
8c21c62c WAA	101	#define NFS_SP4_MACH_CRED_WRITE 5 /* WRITE */
8c21c62c WAA	102	#define NFS_SP4_MACH_CRED_COMMIT 6 /* COMMIT */
0400a6b0	103	#endif /* CONFIG_NFS_V4 */
557134a3	104
14727281 DH	105	#ifdef CONFIG_NFS_FSCACHE
	106	struct fscache_cookie fscache; / client index cache cookie */
	107	#endif
78fe0f41	108
73ea666c	109	struct net *cl_net;
24c8dbbb DH	110	};
24c8dbbb DH	111
1da177e4 LT	112	/*
	113	* NFS client parameters stored in the superblock.
	114	*/
	115	struct nfs_server {
27951bd2	116	struct nfs_client * nfs_client; /* shared client and NFS4 state */
54ceac45 DH	117	struct list_head client_link; /* List of other nfs_server structs
	118	* that share the same client
	119	*/
	120	struct list_head master_link; /* link in master servers list */
1da177e4	121	struct rpc_clnt * client; /* RPC client handle */
b7fa0554	122	struct rpc_clnt * client_acl; /* ACL RPC client handle */
9289e7f9	123	struct nlm_host nlm_host; / NLM client handle */
003cb608	124	struct nfs_iostats __percpu io_stats; / I/O statistics */
1da177e4	125	struct backing_dev_info backing_dev_info;
277866a0	126	atomic_long_t writeback; /* number of writeback pages */
1da177e4 LT	127	int flags; /* various flags */
	128	unsigned int caps; /* server capabilities */
	129	unsigned int rsize; /* read size */
	130	unsigned int rpages; /* read size (in pages) */
	131	unsigned int wsize; /* write size */
	132	unsigned int wpages; /* write size (in pages) */
	133	unsigned int wtmult; /* server disk block size */
	134	unsigned int dtsize; /* readdir size */
f22d6d79	135	unsigned short port; /* "port=" setting */
1da177e4 LT	136	unsigned int bsize; /* server block size */
	137	unsigned int acregmin; /* attr cache timeouts */
	138	unsigned int acregmax;
	139	unsigned int acdirmin;
	140	unsigned int acdirmax;
	141	unsigned int namelen;
c6a6f19e DH	142	unsigned int options; /* extra options enabled by mount */
c6a6f19e DH	143	#define NFS_OPTION_FSCACHE 0x00000001 /* - local caching enabled */
89652617	144	#define NFS_OPTION_MIGRATION 0x00000002 /* - NFSv4 migration enabled */
54ceac45	145
8b4bdcf8	146	struct nfs_fsid fsid;
54ceac45	147	__u64 maxfilesize; /* maximum file size */
6b96724e	148	struct timespec time_delta; /* smallest time granularity */
67ec9f46	149	unsigned long mount_time; /* when this fs was mounted */
54ceac45 DH	150	dev_t s_dev; /* superblock dev numbers */
54ceac45 DH	151
08734048 DH	152	#ifdef CONFIG_NFS_FSCACHE
	153	struct nfs_fscache_key fscache_key; / unique key for superblock */
	154	struct fscache_cookie fscache; / superblock cookie */
	155	#endif
	156
a00ed25c	157	u32 pnfs_blksize; /* layout_blksize attr */
89d77c8f	158	#if IS_ENABLED(CONFIG_NFS_V4)
dae100c2	159	u32 attr_bitmask[3];/* V4 bitmask representing the set
1da177e4 LT	160	of attributes supported on this
1da177e4 LT	161	filesystem */
aa9c2669 DQ	162	u32 attr_bitmask_nl[3];
	163	/* V4 bitmask representing the
	164	set of attributes supported
	165	on this filesystem excluding
	166	the label support bit. */
a09df2ca	167	u32 cache_consistency_bitmask[3];
a65318bf TM	168	/* V4 bitmask representing the subset
	169	of change attribute, size, ctime
	170	and mtime attributes supported by
	171	the server */
1da177e4 LT	172	u32 acl_bitmask; /* V4 bitmask representing the ACEs
	173	that are supported on this
	174	filesystem */
264e6351 CL	175	u32 fh_expire_type; /* V4 bitmask representing file
	176	handle volatility type for
	177	this filesystem */
85e174ba	178	struct pnfs_layoutdriver_type pnfs_curr_ld; / Active layout driver */
f7e8917a	179	struct rpc_wait_queue roc_rpcwaitq;
2f9fd182	180	void pnfs_ld_data; / per mount point data */
24d292b8 CL	181
	182	/* the following fields are protected by nfs_client->cl_lock */
	183	struct rb_root state_owners;
1da177e4	184	#endif
9157c31d	185	struct ida openowner_id;
d2d7ce28	186	struct ida lockowner_id;
0aaaf5c4	187	struct list_head state_owners_lru;
6382a441	188	struct list_head layouts;
d3978bb3	189	struct list_head delegations;
54ceac45	190	void (destroy)(struct nfs_server );
ef818a28 SD	191
ef818a28 SD	192	atomic_t active; /* Keep trace of any activity to this server */
3f8400d1 CL	193
	194	/* mountd-related mount options */
	195	struct sockaddr_storage mountd_address;
	196	size_t mountd_addrlen;
	197	u32 mountd_version;
	198	unsigned short mountd_port;
	199	unsigned short mountd_protocol;
1da177e4 LT	200	};
	201
	202	/* Server capabilities */
	203	#define NFS_CAP_READDIRPLUS (1U << 0)
	204	#define NFS_CAP_HARDLINKS (1U << 1)
	205	#define NFS_CAP_SYMLINKS (1U << 2)
	206	#define NFS_CAP_ACLS (1U << 3)
	207	#define NFS_CAP_ATOMIC_OPEN (1U << 4)
62ab460c TM	208	#define NFS_CAP_CHANGE_ATTR (1U << 5)
	209	#define NFS_CAP_FILEID (1U << 6)
	210	#define NFS_CAP_MODE (1U << 7)
	211	#define NFS_CAP_NLINK (1U << 8)
	212	#define NFS_CAP_OWNER (1U << 9)
	213	#define NFS_CAP_OWNER_GROUP (1U << 10)
	214	#define NFS_CAP_ATIME (1U << 11)
	215	#define NFS_CAP_CTIME (1U << 12)
	216	#define NFS_CAP_MTIME (1U << 13)
0df5dd4a	217	#define NFS_CAP_POSIX_LOCK (1U << 14)
b064eca2	218	#define NFS_CAP_UIDGID_NOMAP (1U << 15)
3b66486c	219	#define NFS_CAP_STATEID_NFSV41 (1U << 16)
49f9a0fa	220	#define NFS_CAP_ATOMIC_OPEN_V1 (1U << 17)
e64a4210	221	#define NFS_CAP_SECURITY_LABEL (1U << 18)
1da177e4 LT	222
1da177e4 LT	223	#endif