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

/* SPDX-License-Identifier: GPL-2.0 */
#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>
#include <linux/refcount.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 {
	refcount_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 */
#define NFS_CS_TSM_POSSIBLE	5		/* - Maybe state migration */
	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;

	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 */
#define NFS_SP4_MACH_CRED_PNFS_CLEANUP  7 /* LAYOUTRETURN */
#if IS_ENABLED(CONFIG_NFS_V4_1)
	wait_queue_head_t	cl_lock_waitq;
#endif /* CONFIG_NFS_V4_1 */
#endif /* CONFIG_NFS_V4 */

	/* Our own IP address, as a null-terminated string.
	 * This is used to generate the mv0 callback address.
	 */
	char			cl_ipaddr[48];

#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 */
	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 */
	unsigned int		clone_blksize;	/* granularity of a CLONE operation */
#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			exclcreat_bitmask[3];
						/* V4 bitmask representing the
						   set of attributes supported
						   on this filesystem for the
						   exclusive create. */
	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)
#define NFS_MIG_TSM_POSSIBLE		(3)

	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;
	struct rpc_wait_queue	uoc_rpcwaitq;
};

/* 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)
#define NFS_CAP_LAYOUTSTATS	(1U << 22)
#define NFS_CAP_CLONE		(1U << 23)
#define NFS_CAP_COPY		(1U << 24)

#endif
Commit	Line	Data
	1	/* SPDX-License-Identifier: GPL-2.0 */
	2	#ifndef _NFS_FS_SB
	3	#define _NFS_FS_SB
	4
	5	#include <linux/list.h>
	6	#include <linux/backing-dev.h>
	7	#include <linux/idr.h>
	8	#include <linux/wait.h>
	9	#include <linux/nfs_xdr.h>
	10	#include <linux/sunrpc/xprt.h>
	11
	12	#include <linux/atomic.h>
	13	#include <linux/refcount.h>
	14
	15	struct nfs4_session;
	16	struct nfs_iostats;
	17	struct nlm_host;
	18	struct nfs4_sequence_args;
	19	struct nfs4_sequence_res;
	20	struct nfs_server;
	21	struct nfs4_minor_version_ops;
	22	struct nfs41_server_scope;
	23	struct nfs41_impl_id;
	24
	25	/*
	26	* The nfs_client identifies our client state to the server.
	27	*/
	28	struct nfs_client {
	29	refcount_t cl_count;
	30	atomic_t cl_mds_count;
	31	int cl_cons_state; /* current construction state (-ve: init error) */
	32	#define NFS_CS_READY 0 /* ready to be used */
	33	#define NFS_CS_INITING 1 /* busy initialising */
	34	#define NFS_CS_SESSION_INITING 2 /* busy initialising session */
	35	unsigned long cl_res_state; /* NFS resources state */
	36	#define NFS_CS_CALLBACK 1 /* - callback started */
	37	#define NFS_CS_IDMAP 2 /* - idmap started */
	38	#define NFS_CS_RENEWD 3 /* - renewd started */
	39	#define NFS_CS_STOP_RENEW 4 /* no more state to renew */
	40	#define NFS_CS_CHECK_LEASE_TIME 5 /* need to check lease time */
	41	unsigned long cl_flags; /* behavior switches */
	42	#define NFS_CS_NORESVPORT 0 /* - use ephemeral src port */
	43	#define NFS_CS_DISCRTRY 1 /* - disconnect on RPC retry */
	44	#define NFS_CS_MIGRATION 2 /* - transparent state migr */
	45	#define NFS_CS_INFINITE_SLOTS 3 /* - don't limit TCP slots */
	46	#define NFS_CS_NO_RETRANS_TIMEOUT 4 /* - Disable retransmit timeouts */
	47	#define NFS_CS_TSM_POSSIBLE 5 /* - Maybe state migration */
	48	struct sockaddr_storage cl_addr; /* server identifier */
	49	size_t cl_addrlen;
	50	char * cl_hostname; /* hostname of server */
	51	char * cl_acceptor; /* GSSAPI acceptor name */
	52	struct list_head cl_share_link; /* link in global client list */
	53	struct list_head cl_superblocks; /* List of nfs_server structs */
	54
	55	struct rpc_clnt * cl_rpcclient;
	56	const struct nfs_rpc_ops rpc_ops; / NFS protocol vector */
	57	int cl_proto; /* Network transport protocol */
	58	struct nfs_subversion * cl_nfs_mod; /* pointer to nfs version module */
	59
	60	u32 cl_minorversion;/* NFSv4 minorversion */
	61	struct rpc_cred *cl_machine_cred;
	62
	63	#if IS_ENABLED(CONFIG_NFS_V4)
	64	struct list_head cl_ds_clients; /* auth flavor data servers */
	65	u64 cl_clientid; /* constant */
	66	nfs4_verifier cl_confirm; /* Clientid verifier */
	67	unsigned long cl_state;
	68
	69	spinlock_t cl_lock;
	70
	71	unsigned long cl_lease_time;
	72	unsigned long cl_last_renewal;
	73	struct delayed_work cl_renewd;
	74
	75	struct rpc_wait_queue cl_rpcwaitq;
	76
	77	/* idmapper */
	78	struct idmap * cl_idmap;
	79
	80	/* Client owner identifier */
	81	const char * cl_owner_id;
	82
	83	u32 cl_cb_ident; /* v4.0 callback identifier */
	84	const struct nfs4_minor_version_ops *cl_mvops;
	85	unsigned long cl_mig_gen;
	86
	87	/* NFSv4.0 transport blocking */
	88	struct nfs4_slot_table *cl_slot_tbl;
	89
	90	/* The sequence id to use for the next CREATE_SESSION */
	91	u32 cl_seqid;
	92	/* The flags used for obtaining the clientid during EXCHANGE_ID */
	93	u32 cl_exchange_flags;
	94	struct nfs4_session cl_session; / shared session */
	95	bool cl_preserve_clid;
	96	struct nfs41_server_owner *cl_serverowner;
	97	struct nfs41_server_scope *cl_serverscope;
	98	struct nfs41_impl_id *cl_implid;
	99	/* nfs 4.1+ state protection modes: */
	100	unsigned long cl_sp4_flags;
	101	#define NFS_SP4_MACH_CRED_MINIMAL 1 /* Minimal sp4_mach_cred - state ops
	102	* must use machine cred */
	103	#define NFS_SP4_MACH_CRED_CLEANUP 2 /* CLOSE and LOCKU */
	104	#define NFS_SP4_MACH_CRED_SECINFO 3 /* SECINFO and SECINFO_NO_NAME */
	105	#define NFS_SP4_MACH_CRED_STATEID 4 /* TEST_STATEID and FREE_STATEID */
	106	#define NFS_SP4_MACH_CRED_WRITE 5 /* WRITE */
	107	#define NFS_SP4_MACH_CRED_COMMIT 6 /* COMMIT */
	108	#define NFS_SP4_MACH_CRED_PNFS_CLEANUP 7 /* LAYOUTRETURN */
	109	#if IS_ENABLED(CONFIG_NFS_V4_1)
	110	wait_queue_head_t cl_lock_waitq;
	111	#endif /* CONFIG_NFS_V4_1 */
	112	#endif /* CONFIG_NFS_V4 */
	113
	114	/* Our own IP address, as a null-terminated string.
	115	* This is used to generate the mv0 callback address.
	116	*/
	117	char cl_ipaddr[48];
	118
	119	#ifdef CONFIG_NFS_FSCACHE
	120	struct fscache_cookie fscache; / client index cache cookie */
	121	#endif
	122
	123	struct net *cl_net;
	124	};
	125
	126	/*
	127	* NFS client parameters stored in the superblock.
	128	*/
	129	struct nfs_server {
	130	struct nfs_client * nfs_client; /* shared client and NFS4 state */
	131	struct list_head client_link; /* List of other nfs_server structs
	132	* that share the same client
	133	*/
	134	struct list_head master_link; /* link in master servers list */
	135	struct rpc_clnt * client; /* RPC client handle */
	136	struct rpc_clnt * client_acl; /* ACL RPC client handle */
	137	struct nlm_host nlm_host; / NLM client handle */
	138	struct nfs_iostats __percpu io_stats; / I/O statistics */
	139	atomic_long_t writeback; /* number of writeback pages */
	140	int flags; /* various flags */
	141	unsigned int caps; /* server capabilities */
	142	unsigned int rsize; /* read size */
	143	unsigned int rpages; /* read size (in pages) */
	144	unsigned int wsize; /* write size */
	145	unsigned int wpages; /* write size (in pages) */
	146	unsigned int wtmult; /* server disk block size */
	147	unsigned int dtsize; /* readdir size */
	148	unsigned short port; /* "port=" setting */
	149	unsigned int bsize; /* server block size */
	150	unsigned int acregmin; /* attr cache timeouts */
	151	unsigned int acregmax;
	152	unsigned int acdirmin;
	153	unsigned int acdirmax;
	154	unsigned int namelen;
	155	unsigned int options; /* extra options enabled by mount */
	156	unsigned int clone_blksize; /* granularity of a CLONE operation */
	157	#define NFS_OPTION_FSCACHE 0x00000001 /* - local caching enabled */
	158	#define NFS_OPTION_MIGRATION 0x00000002 /* - NFSv4 migration enabled */
	159
	160	struct nfs_fsid fsid;
	161	__u64 maxfilesize; /* maximum file size */
	162	struct timespec time_delta; /* smallest time granularity */
	163	unsigned long mount_time; /* when this fs was mounted */
	164	struct super_block super; / VFS super block */
	165	dev_t s_dev; /* superblock dev numbers */
	166	struct nfs_auth_info auth_info; /* parsed auth flavors */
	167
	168	#ifdef CONFIG_NFS_FSCACHE
	169	struct nfs_fscache_key fscache_key; / unique key for superblock */
	170	struct fscache_cookie fscache; / superblock cookie */
	171	#endif
	172
	173	u32 pnfs_blksize; /* layout_blksize attr */
	174	#if IS_ENABLED(CONFIG_NFS_V4)
	175	u32 attr_bitmask[3];/* V4 bitmask representing the set
	176	of attributes supported on this
	177	filesystem */
	178	u32 attr_bitmask_nl[3];
	179	/* V4 bitmask representing the
	180	set of attributes supported
	181	on this filesystem excluding
	182	the label support bit. */
	183	u32 exclcreat_bitmask[3];
	184	/* V4 bitmask representing the
	185	set of attributes supported
	186	on this filesystem for the
	187	exclusive create. */
	188	u32 cache_consistency_bitmask[3];
	189	/* V4 bitmask representing the subset
	190	of change attribute, size, ctime
	191	and mtime attributes supported by
	192	the server */
	193	u32 acl_bitmask; /* V4 bitmask representing the ACEs
	194	that are supported on this
	195	filesystem */
	196	u32 fh_expire_type; /* V4 bitmask representing file
	197	handle volatility type for
	198	this filesystem */
	199	struct pnfs_layoutdriver_type pnfs_curr_ld; / Active layout driver */
	200	struct rpc_wait_queue roc_rpcwaitq;
	201	void pnfs_ld_data; / per mount point data */
	202
	203	/* the following fields are protected by nfs_client->cl_lock */
	204	struct rb_root state_owners;
	205	#endif
	206	struct ida openowner_id;
	207	struct ida lockowner_id;
	208	struct list_head state_owners_lru;
	209	struct list_head layouts;
	210	struct list_head delegations;
	211
	212	unsigned long mig_gen;
	213	unsigned long mig_status;
	214	#define NFS_MIG_IN_TRANSITION (1)
	215	#define NFS_MIG_FAILED (2)
	216	#define NFS_MIG_TSM_POSSIBLE (3)
	217
	218	void (destroy)(struct nfs_server );
	219
	220	atomic_t active; /* Keep trace of any activity to this server */
	221
	222	/* mountd-related mount options */
	223	struct sockaddr_storage mountd_address;
	224	size_t mountd_addrlen;
	225	u32 mountd_version;
	226	unsigned short mountd_port;
	227	unsigned short mountd_protocol;
	228	struct rpc_wait_queue uoc_rpcwaitq;
	229	};
	230
	231	/* Server capabilities */
	232	#define NFS_CAP_READDIRPLUS (1U << 0)
	233	#define NFS_CAP_HARDLINKS (1U << 1)
	234	#define NFS_CAP_SYMLINKS (1U << 2)
	235	#define NFS_CAP_ACLS (1U << 3)
	236	#define NFS_CAP_ATOMIC_OPEN (1U << 4)
	237	/* #define NFS_CAP_CHANGE_ATTR (1U << 5) */
	238	#define NFS_CAP_FILEID (1U << 6)
	239	#define NFS_CAP_MODE (1U << 7)
	240	#define NFS_CAP_NLINK (1U << 8)
	241	#define NFS_CAP_OWNER (1U << 9)
	242	#define NFS_CAP_OWNER_GROUP (1U << 10)
	243	#define NFS_CAP_ATIME (1U << 11)
	244	#define NFS_CAP_CTIME (1U << 12)
	245	#define NFS_CAP_MTIME (1U << 13)
	246	#define NFS_CAP_POSIX_LOCK (1U << 14)
	247	#define NFS_CAP_UIDGID_NOMAP (1U << 15)
	248	#define NFS_CAP_STATEID_NFSV41 (1U << 16)
	249	#define NFS_CAP_ATOMIC_OPEN_V1 (1U << 17)
	250	#define NFS_CAP_SECURITY_LABEL (1U << 18)
	251	#define NFS_CAP_SEEK (1U << 19)
	252	#define NFS_CAP_ALLOCATE (1U << 20)
	253	#define NFS_CAP_DEALLOCATE (1U << 21)
	254	#define NFS_CAP_LAYOUTSTATS (1U << 22)
	255	#define NFS_CAP_CLONE (1U << 23)
	256	#define NFS_CAP_COPY (1U << 24)
	257
	258	#endif