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

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

	struct rb_root		cl_openowner_id;
	struct rb_root		cl_lockowner_id;

	struct list_head	cl_delegations;
	struct rb_root		cl_state_owners;
	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;
	int		     (* cl_call_sync)(struct nfs_server *server,
					      struct rpc_message *msg,
					      struct nfs4_sequence_args *args,
					      struct nfs4_sequence_res *res,
					      int cache_reply);
#endif /* CONFIG_NFS_V4 */

#ifdef CONFIG_NFS_V4_1
	struct nfs4_session	*cl_session; 	/* sharred session */
#endif /* CONFIG_NFS_V4_1 */

#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 *	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 */
	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 */
#endif
	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)


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

#if defined(CONFIG_NFS_V4_1)

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

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;
					/* back channel has one slot */
	struct nfs_client		*clp;
};

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