[deliverable/linux.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 */
#define NFS_CS_NO_RETRANS_TIMEOUT	4	/* - Disable retransmit timeouts */
	struct sockaddr_storage	cl_addr;	/* server identifier */
	size_t			cl_addrlen;
	char *			cl_hostname;	/* hostname of server */
	char *			cl_acceptor;	/* GSSAPI acceptor name */
	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;

	/* Client owner identifier */
	const char *		cl_owner_id;

	/* 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;
	unsigned long		cl_mig_gen;

	/* 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 */
	struct super_block	*super;		/* VFS super block */
	dev_t			s_dev;		/* superblock dev numbers */
	struct nfs_auth_info	auth_info;	/* parsed auth flavors */

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

	unsigned long		mig_gen;
	unsigned long		mig_status;
#define NFS_MIG_IN_TRANSITION		(1)
#define NFS_MIG_FAILED			(2)

	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)
#define NFS_CAP_SEEK		(1U << 19)
#define NFS_CAP_ALLOCATE	(1U << 20)
#define NFS_CAP_DEALLOCATE	(1U << 21)

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