[mirror_ubuntu-focal-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 server_scope;
struct nfs41_impl_id;

/*
 * The nfs_client identifies our client state to the server.
 */
struct nfs_client {
	atomic_t		cl_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 */
	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 */

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

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

	/* used for the setclientid verifier */
	struct timespec		cl_boot_time;

	/* idmapper */
	struct idmap *		cl_idmap;

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

	/* 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; 	/* sharred session */
#endif /* CONFIG_NFS_V4 */

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

	struct server_scope	*server_scope;	/* from exchange_id */
	struct nfs41_impl_id	*impl_id;	/* from exchange_id */
	struct net		*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 */

	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 */
#ifdef CONFIG_NFS_V4
	u32			attr_bitmask[3];/* V4 bitmask representing the set
						   of attributes supported on this
						   filesystem */
	u32			cache_consistency_bitmask[2];
						/* 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)


/* maximum number of slots to use */
#define NFS4_DEF_SLOT_TABLE_SIZE (16U)
#define NFS4_MAX_SLOT_TABLE (256U)
#define NFS4_NO_SLOT ((u32)-1)

#if defined(CONFIG_NFS_V4)

/* Sessions */
#define SLOT_TABLE_SZ DIV_ROUND_UP(NFS4_MAX_SLOT_TABLE, 8*sizeof(long))
struct nfs4_slot_table {
	struct nfs4_slot *slots;		/* seqid per slot */
	unsigned long   used_slots[SLOT_TABLE_SZ]; /* used/unused bitmap */
	spinlock_t	slot_tbl_lock;
	struct rpc_wait_queue	slot_tbl_waitq;	/* allocators may wait here */
	u32		max_slots;		/* # slots in table */
	u32		highest_used_slotid;	/* sent to server on each SEQ.
						 * op for dynamic resizing */
	u32		target_max_slots;	/* Set by CB_RECALL_SLOT as
						 * the new max_slots */
	struct completion complete;
};

static inline int slot_idx(struct nfs4_slot_table *tbl, struct nfs4_slot *sp)
{
	return sp - tbl->slots;
}

/*
 * Session related parameters
 */
struct nfs4_session {
	struct nfs4_sessionid		sess_id;
	u32				flags;
	unsigned long			session_state;
	u32				hash_alg;
	u32				ssv_len;

	/* The fore and back channel */
	struct nfs4_channel_attrs	fc_attrs;
	struct nfs4_slot_table		fc_slot_table;
	struct nfs4_channel_attrs	bc_attrs;
	struct nfs4_slot_table		bc_slot_table;
	struct nfs_client		*clp;
};

#endif /* CONFIG_NFS_V4 */
#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;
78fe0f41	20	struct 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;
	28	int cl_cons_state; /* current construction state (-ve: init error) */
	29	#define NFS_CS_READY 0 /* ready to be used */
	30	#define NFS_CS_INITING 1 /* busy initialising */
76db6d95	31	#define NFS_CS_SESSION_INITING 2 /* busy initialising session */
24c8dbbb	32	unsigned long cl_res_state; /* NFS resources state */
24c8dbbb DH	33	#define NFS_CS_CALLBACK 1 /* - callback started */
24c8dbbb DH	34	#define NFS_CS_IDMAP 2 /* - idmap started */
5dd3177a	35	#define NFS_CS_RENEWD 3 /* - renewd started */
d3b4c9d7	36	#define NFS_CS_STOP_RENEW 4 /* no more state to renew */
d6fb79d4	37	#define NFS_CS_CHECK_LEASE_TIME 5 /* need to check lease time */
6e4cffd7 CL	38	struct sockaddr_storage cl_addr; /* server identifier */
6e4cffd7 CL	39	size_t cl_addrlen;
24c8dbbb DH	40	char * cl_hostname; /* hostname of server */
	41	struct list_head cl_share_link; /* link in global client list */
	42	struct list_head cl_superblocks; /* List of nfs_server structs */
	43
	44	struct rpc_clnt * cl_rpcclient;
8fa5c000	45	const struct nfs_rpc_ops rpc_ops; / NFS protocol vector */
59dca3b2	46	int cl_proto; /* Network transport protocol */
24c8dbbb	47
94a417f3	48	u32 cl_minorversion;/* NFSv4 minorversion */
7c67db3a TM	49	struct rpc_cred *cl_machine_cred;
7c67db3a TM	50
24c8dbbb DH	51	#ifdef CONFIG_NFS_V4
24c8dbbb DH	52	u64 cl_clientid; /* constant */
fd954ae1	53	nfs4_verifier cl_confirm; /* Clientid verifier */
24c8dbbb DH	54	unsigned long cl_state;
24c8dbbb DH	55
24c8dbbb DH	56	spinlock_t cl_lock;
	57
	58	unsigned long cl_lease_time;
	59	unsigned long cl_last_renewal;
52bad64d	60	struct delayed_work cl_renewd;
24c8dbbb DH	61
	62	struct rpc_wait_queue cl_rpcwaitq;
	63
	64	/* used for the setclientid verifier */
	65	struct timespec cl_boot_time;
	66
	67	/* idmapper */
	68	struct idmap * cl_idmap;
	69
	70	/* Our own IP address, as a null-terminated string.
	71	* This is used to generate the clientid, and the callback address.
	72	*/
4392f259	73	char cl_ipaddr[48];
24c8dbbb	74	unsigned char cl_id_uniquifier;
f4eecd5d	75	u32 cl_cb_ident; /* v4.0 callback identifier */
97dc1359	76	const struct nfs4_minor_version_ops *cl_mvops;
14727281	77
99fe60d0 BH	78	/* The sequence id to use for the next CREATE_SESSION */
	79	u32 cl_seqid;
	80	/* The flags used for obtaining the clientid during EXCHANGE_ID */
	81	u32 cl_exchange_flags;
557134a3	82	struct nfs4_session cl_session; / sharred session */
0400a6b0	83	#endif /* CONFIG_NFS_V4 */
557134a3	84
14727281 DH	85	#ifdef CONFIG_NFS_FSCACHE
	86	struct fscache_cookie fscache; / client index cache cookie */
	87	#endif
78fe0f41 WAA	88
78fe0f41 WAA	89	struct server_scope server_scope; / from exchange_id */
7d2ed9ac	90	struct nfs41_impl_id impl_id; / from exchange_id */
e50a7a1a	91	struct net *net;
24c8dbbb DH	92	};
24c8dbbb DH	93
1da177e4 LT	94	/*
	95	* NFS client parameters stored in the superblock.
	96	*/
	97	struct nfs_server {
27951bd2	98	struct nfs_client * nfs_client; /* shared client and NFS4 state */
54ceac45 DH	99	struct list_head client_link; /* List of other nfs_server structs
	100	* that share the same client
	101	*/
	102	struct list_head master_link; /* link in master servers list */
1da177e4	103	struct rpc_clnt * client; /* RPC client handle */
b7fa0554	104	struct rpc_clnt * client_acl; /* ACL RPC client handle */
9289e7f9	105	struct nlm_host nlm_host; / NLM client handle */
003cb608	106	struct nfs_iostats __percpu io_stats; / I/O statistics */
1da177e4	107	struct backing_dev_info backing_dev_info;
277866a0	108	atomic_long_t writeback; /* number of writeback pages */
1da177e4 LT	109	int flags; /* various flags */
	110	unsigned int caps; /* server capabilities */
	111	unsigned int rsize; /* read size */
	112	unsigned int rpages; /* read size (in pages) */
	113	unsigned int wsize; /* write size */
	114	unsigned int wpages; /* write size (in pages) */
	115	unsigned int wtmult; /* server disk block size */
	116	unsigned int dtsize; /* readdir size */
f22d6d79	117	unsigned short port; /* "port=" setting */
1da177e4 LT	118	unsigned int bsize; /* server block size */
	119	unsigned int acregmin; /* attr cache timeouts */
	120	unsigned int acregmax;
	121	unsigned int acdirmin;
	122	unsigned int acdirmax;
	123	unsigned int namelen;
c6a6f19e DH	124	unsigned int options; /* extra options enabled by mount */
c6a6f19e DH	125	#define NFS_OPTION_FSCACHE 0x00000001 /* - local caching enabled */
54ceac45	126
8b4bdcf8	127	struct nfs_fsid fsid;
54ceac45	128	__u64 maxfilesize; /* maximum file size */
6b96724e	129	struct timespec time_delta; /* smallest time granularity */
67ec9f46	130	unsigned long mount_time; /* when this fs was mounted */
54ceac45 DH	131	dev_t s_dev; /* superblock dev numbers */
54ceac45 DH	132
08734048 DH	133	#ifdef CONFIG_NFS_FSCACHE
	134	struct nfs_fscache_key fscache_key; / unique key for superblock */
	135	struct fscache_cookie fscache; / superblock cookie */
	136	#endif
	137
a00ed25c	138	u32 pnfs_blksize; /* layout_blksize attr */
1da177e4	139	#ifdef CONFIG_NFS_V4
dae100c2	140	u32 attr_bitmask[3];/* V4 bitmask representing the set
1da177e4 LT	141	of attributes supported on this
1da177e4 LT	142	filesystem */
a65318bf TM	143	u32 cache_consistency_bitmask[2];
	144	/* V4 bitmask representing the subset
	145	of change attribute, size, ctime
	146	and mtime attributes supported by
	147	the server */
1da177e4 LT	148	u32 acl_bitmask; /* V4 bitmask representing the ACEs
	149	that are supported on this
	150	filesystem */
264e6351 CL	151	u32 fh_expire_type; /* V4 bitmask representing file
	152	handle volatility type for
	153	this filesystem */
85e174ba	154	struct pnfs_layoutdriver_type pnfs_curr_ld; / Active layout driver */
f7e8917a	155	struct rpc_wait_queue roc_rpcwaitq;
2f9fd182	156	void pnfs_ld_data; / per mount point data */
24d292b8 CL	157
	158	/* the following fields are protected by nfs_client->cl_lock */
	159	struct rb_root state_owners;
1da177e4	160	#endif
9157c31d	161	struct ida openowner_id;
d2d7ce28	162	struct ida lockowner_id;
0aaaf5c4	163	struct list_head state_owners_lru;
6382a441	164	struct list_head layouts;
d3978bb3	165	struct list_head delegations;
54ceac45	166	void (destroy)(struct nfs_server );
ef818a28 SD	167
ef818a28 SD	168	atomic_t active; /* Keep trace of any activity to this server */
3f8400d1 CL	169
	170	/* mountd-related mount options */
	171	struct sockaddr_storage mountd_address;
	172	size_t mountd_addrlen;
	173	u32 mountd_version;
	174	unsigned short mountd_port;
	175	unsigned short mountd_protocol;
1da177e4 LT	176	};
	177
	178	/* Server capabilities */
	179	#define NFS_CAP_READDIRPLUS (1U << 0)
	180	#define NFS_CAP_HARDLINKS (1U << 1)
	181	#define NFS_CAP_SYMLINKS (1U << 2)
	182	#define NFS_CAP_ACLS (1U << 3)
	183	#define NFS_CAP_ATOMIC_OPEN (1U << 4)
62ab460c TM	184	#define NFS_CAP_CHANGE_ATTR (1U << 5)
	185	#define NFS_CAP_FILEID (1U << 6)
	186	#define NFS_CAP_MODE (1U << 7)
	187	#define NFS_CAP_NLINK (1U << 8)
	188	#define NFS_CAP_OWNER (1U << 9)
	189	#define NFS_CAP_OWNER_GROUP (1U << 10)
	190	#define NFS_CAP_ATIME (1U << 11)
	191	#define NFS_CAP_CTIME (1U << 12)
	192	#define NFS_CAP_MTIME (1U << 13)
0df5dd4a	193	#define NFS_CAP_POSIX_LOCK (1U << 14)
b064eca2	194	#define NFS_CAP_UIDGID_NOMAP (1U << 15)
1da177e4	195
557134a3 AA	196
557134a3 AA	197	/* maximum number of slots to use */
ef159e91 TM	198	#define NFS4_DEF_SLOT_TABLE_SIZE (16U)
ef159e91 TM	199	#define NFS4_MAX_SLOT_TABLE (256U)
45d43c29	200	#define NFS4_NO_SLOT ((u32)-1)
557134a3	201
0400a6b0	202	#if defined(CONFIG_NFS_V4)
557134a3 AA	203
557134a3 AA	204	/* Sessions */
ef159e91	205	#define SLOT_TABLE_SZ DIV_ROUND_UP(NFS4_MAX_SLOT_TABLE, 8*sizeof(long))
557134a3 AA	206	struct nfs4_slot_table {
	207	struct nfs4_slot slots; / seqid per slot */
	208	unsigned long used_slots[SLOT_TABLE_SZ]; /* used/unused bitmap */
	209	spinlock_t slot_tbl_lock;
	210	struct rpc_wait_queue slot_tbl_waitq; /* allocators may wait here */
45d43c29 TM	211	u32 max_slots; /* # slots in table */
45d43c29 TM	212	u32 highest_used_slotid; /* sent to server on each SEQ.
557134a3	213	* op for dynamic resizing */
45d43c29	214	u32 target_max_slots; /* Set by CB_RECALL_SLOT as
b9efa1b2	215	* the new max_slots */
42acd021	216	struct completion complete;
557134a3 AA	217	};
	218
	219	static inline int slot_idx(struct nfs4_slot_table tbl, struct nfs4_slot sp)
	220	{
	221	return sp - tbl->slots;
	222	}
	223
	224	/*
	225	* Session related parameters
	226	*/
	227	struct nfs4_session {
	228	struct nfs4_sessionid sess_id;
	229	u32 flags;
	230	unsigned long session_state;
	231	u32 hash_alg;
	232	u32 ssv_len;
	233
	234	/* The fore and back channel */
	235	struct nfs4_channel_attrs fc_attrs;
	236	struct nfs4_slot_table fc_slot_table;
	237	struct nfs4_channel_attrs bc_attrs;
f8625a6a	238	struct nfs4_slot_table bc_slot_table;
557134a3 AA	239	struct nfs_client *clp;
	240	};
	241
0400a6b0	242	#endif /* CONFIG_NFS_V4 */
1da177e4	243	#endif