[mirror_ubuntu-zesty-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 */
	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;

	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;
	u32			cl_cb_ident;	/* v4.0 callback identifier */
	const struct nfs4_minor_version_ops *cl_mvops;
#endif /* CONFIG_NFS_V4 */

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