[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/wait.h>
#include <linux/nfs_xdr.h>
#include <linux/sunrpc/xprt.h>

#include <asm/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;

/*
 * 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 */
	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 */
	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 */
	struct list_head	cl_layouts;
	struct pnfs_deviceid_cache *cl_devid_cache; /* pNFS deviceid cache */
#endif /* CONFIG_NFS_V4 */

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

/*
 * 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

#ifdef CONFIG_NFS_V4
	u32			attr_bitmask[2];/* 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 */
	struct pnfs_layoutdriver_type  *pnfs_curr_ld; /* Active layout driver */
	struct rpc_wait_queue	roc_rpcwaitq;

	/* the following fields are protected by nfs_client->cl_lock */
	struct rb_root		state_owners;
	struct rb_root		openowner_id;
	struct rb_root		lockowner_id;
#endif
	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)


/* maximum number of slots to use */
#define NFS4_MAX_SLOT_TABLE RPC_MAX_SLOT_TABLE

#if defined(CONFIG_NFS_V4)

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