[mirror_ubuntu-artful-kernel.git] / fs / nfs / nfs4session.h

/*
 * fs/nfs/nfs4session.h
 *
 * Copyright (c) 2012 Trond Myklebust <Trond.Myklebust@netapp.com>
 *
 */
#ifndef __LINUX_FS_NFS_NFS4SESSION_H
#define __LINUX_FS_NFS_NFS4SESSION_H

/* maximum number of slots to use */
#define NFS4_DEF_SLOT_TABLE_SIZE (64U)
#define NFS4_DEF_CB_SLOT_TABLE_SIZE (1U)
#define NFS4_MAX_SLOT_TABLE (1024U)
#define NFS4_NO_SLOT ((u32)-1)

#if IS_ENABLED(CONFIG_NFS_V4)

/* Sessions slot seqid */
struct nfs4_slot {
	struct nfs4_slot_table	*table;
	struct nfs4_slot	*next;
	unsigned long		generation;
	u32			slot_nr;
	u32		 	seq_nr;
	unsigned int		interrupted : 1,
				privileged : 1,
				seq_done : 1;
};

/* Sessions */
enum nfs4_slot_tbl_state {
	NFS4_SLOT_TBL_DRAINING,
};

#define SLOT_TABLE_SZ DIV_ROUND_UP(NFS4_MAX_SLOT_TABLE, 8*sizeof(long))
struct nfs4_slot_table {
	struct nfs4_session *session;		/* Parent session */
	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 */
	wait_queue_head_t	slot_waitq;	/* Completion wait on slot */
	u32		max_slots;		/* # slots in table */
	u32		max_slotid;		/* Max allowed slotid value */
	u32		highest_used_slotid;	/* sent to server on each SEQ.
						 * op for dynamic resizing */
	u32		target_highest_slotid;	/* Server max_slot target */
	u32		server_highest_slotid;	/* Server highest slotid */
	s32		d_target_highest_slotid; /* Derivative */
	s32		d2_target_highest_slotid; /* 2nd derivative */
	unsigned long	generation;		/* Generation counter for
						   target_highest_slotid */
	struct completion complete;
	unsigned long	slot_tbl_state;
};

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

enum nfs4_session_state {
	NFS4_SESSION_INITING,
	NFS4_SESSION_ESTABLISHED,
};

extern int nfs4_setup_slot_table(struct nfs4_slot_table *tbl,
		unsigned int max_reqs, const char *queue);
extern void nfs4_shutdown_slot_table(struct nfs4_slot_table *tbl);
extern struct nfs4_slot *nfs4_alloc_slot(struct nfs4_slot_table *tbl);
extern struct nfs4_slot *nfs4_lookup_slot(struct nfs4_slot_table *tbl, u32 slotid);
extern int nfs4_slot_wait_on_seqid(struct nfs4_slot_table *tbl,
		u32 slotid, u32 seq_nr,
		unsigned long timeout);
extern bool nfs4_try_to_lock_slot(struct nfs4_slot_table *tbl, struct nfs4_slot *slot);
extern void nfs4_free_slot(struct nfs4_slot_table *tbl, struct nfs4_slot *slot);
extern void nfs4_slot_tbl_drain_complete(struct nfs4_slot_table *tbl);
bool nfs41_wake_and_assign_slot(struct nfs4_slot_table *tbl,
		struct nfs4_slot *slot);
void nfs41_wake_slot_table(struct nfs4_slot_table *tbl);

static inline bool nfs4_slot_tbl_draining(struct nfs4_slot_table *tbl)
{
	return !!test_bit(NFS4_SLOT_TBL_DRAINING, &tbl->slot_tbl_state);
}

static inline bool nfs4_test_locked_slot(const struct nfs4_slot_table *tbl,
		u32 slotid)
{
	return !!test_bit(slotid, tbl->used_slots);
}

static inline struct nfs4_session *nfs4_get_session(const struct nfs_client *clp)
{
	return clp->cl_session;
}

#if defined(CONFIG_NFS_V4_1)
extern void nfs41_set_target_slotid(struct nfs4_slot_table *tbl,
		u32 target_highest_slotid);
extern void nfs41_update_target_slotid(struct nfs4_slot_table *tbl,
		struct nfs4_slot *slot,
		struct nfs4_sequence_res *res);

extern int nfs4_setup_session_slot_tables(struct nfs4_session *ses);

extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
extern void nfs4_destroy_session(struct nfs4_session *session);
extern int nfs4_init_session(struct nfs_client *clp);
extern int nfs4_init_ds_session(struct nfs_client *, unsigned long);

/*
 * Determine if sessions are in use.
 */
static inline int nfs4_has_session(const struct nfs_client *clp)
{
	if (clp->cl_session)
		return 1;
	return 0;
}

static inline int nfs4_has_persistent_session(const struct nfs_client *clp)
{
	if (nfs4_has_session(clp))
		return (clp->cl_session->flags & SESSION4_PERSIST);
	return 0;
}

static inline void nfs4_copy_sessionid(struct nfs4_sessionid *dst,
		const struct nfs4_sessionid *src)
{
	memcpy(dst->data, src->data, NFS4_MAX_SESSIONID_LEN);
}

#ifdef CONFIG_CRC32
/*
 * nfs_session_id_hash - calculate the crc32 hash for the session id
 * @session - pointer to session
 */
#define nfs_session_id_hash(sess_id) \
	(~crc32_le(0xFFFFFFFF, &(sess_id)->data[0], sizeof((sess_id)->data)))
#else
#define nfs_session_id_hash(session) (0)
#endif
#else /* defined(CONFIG_NFS_V4_1) */

static inline int nfs4_init_session(struct nfs_client *clp)
{
	return 0;
}

/*
 * Determine if sessions are in use.
 */
static inline int nfs4_has_session(const struct nfs_client *clp)
{
	return 0;
}

static inline int nfs4_has_persistent_session(const struct nfs_client *clp)
{
	return 0;
}

#define nfs_session_id_hash(session) (0)

#endif /* defined(CONFIG_NFS_V4_1) */
#endif /* IS_ENABLED(CONFIG_NFS_V4) */
#endif /* __LINUX_FS_NFS_NFS4SESSION_H */
Commit	Line	Data
73e39aaa TM	1	/*
	2	* fs/nfs/nfs4session.h
	3	*
	4	* Copyright (c) 2012 Trond Myklebust <Trond.Myklebust@netapp.com>
	5	*
	6	*/
	7	#ifndef __LINUX_FS_NFS_NFS4SESSION_H
	8	#define __LINUX_FS_NFS_NFS4SESSION_H
	9
76e697ba	10	/* maximum number of slots to use */
bc4b2a86	11	#define NFS4_DEF_SLOT_TABLE_SIZE (64U)
5405fc44	12	#define NFS4_DEF_CB_SLOT_TABLE_SIZE (1U)
0ca3f482	13	#define NFS4_MAX_SLOT_TABLE (1024U)
76e697ba TM	14	#define NFS4_NO_SLOT ((u32)-1)
	15
	16	#if IS_ENABLED(CONFIG_NFS_V4)
	17
	18	/* Sessions slot seqid */
	19	struct nfs4_slot {
	20	struct nfs4_slot_table *table;
	21	struct nfs4_slot *next;
	22	unsigned long generation;
76e697ba TM	23	u32 slot_nr;
76e697ba TM	24	u32 seq_nr;
07e8dcbd	25	unsigned int interrupted : 1,
0a014a44	26	privileged : 1,
07e8dcbd	27	seq_done : 1;
76e697ba TM	28	};
	29
	30	/* Sessions */
774d5f14 AA	31	enum nfs4_slot_tbl_state {
	32	NFS4_SLOT_TBL_DRAINING,
	33	};
	34
76e697ba TM	35	#define SLOT_TABLE_SZ DIV_ROUND_UP(NFS4_MAX_SLOT_TABLE, 8*sizeof(long))
	36	struct nfs4_slot_table {
	37	struct nfs4_session session; / Parent session */
	38	struct nfs4_slot slots; / seqid per slot */
	39	unsigned long used_slots[SLOT_TABLE_SZ]; /* used/unused bitmap */
	40	spinlock_t slot_tbl_lock;
	41	struct rpc_wait_queue slot_tbl_waitq; /* allocators may wait here */
045d2a6d	42	wait_queue_head_t slot_waitq; /* Completion wait on slot */
76e697ba TM	43	u32 max_slots; /* # slots in table */
	44	u32 max_slotid; /* Max allowed slotid value */
	45	u32 highest_used_slotid; /* sent to server on each SEQ.
	46	* op for dynamic resizing */
	47	u32 target_highest_slotid; /* Server max_slot target */
	48	u32 server_highest_slotid; /* Server highest slotid */
1fa80644 TM	49	s32 d_target_highest_slotid; /* Derivative */
1fa80644 TM	50	s32 d2_target_highest_slotid; /* 2nd derivative */
76e697ba TM	51	unsigned long generation; /* Generation counter for
	52	target_highest_slotid */
	53	struct completion complete;
774d5f14	54	unsigned long slot_tbl_state;
76e697ba TM	55	};
	56
	57	/*
	58	* Session related parameters
	59	*/
	60	struct nfs4_session {
	61	struct nfs4_sessionid sess_id;
	62	u32 flags;
	63	unsigned long session_state;
	64	u32 hash_alg;
	65	u32 ssv_len;
	66
	67	/* The fore and back channel */
	68	struct nfs4_channel_attrs fc_attrs;
	69	struct nfs4_slot_table fc_slot_table;
	70	struct nfs4_channel_attrs bc_attrs;
	71	struct nfs4_slot_table bc_slot_table;
	72	struct nfs_client *clp;
76e697ba TM	73	};
	74
	75	enum nfs4_session_state {
	76	NFS4_SESSION_INITING,
e11259f9	77	NFS4_SESSION_ESTABLISHED,
76e697ba TM	78	};
76e697ba TM	79
744aa525 CL	80	extern int nfs4_setup_slot_table(struct nfs4_slot_table *tbl,
744aa525 CL	81	unsigned int max_reqs, const char *queue);
20b9a902	82	extern void nfs4_shutdown_slot_table(struct nfs4_slot_table *tbl);
73e39aaa	83	extern struct nfs4_slot nfs4_alloc_slot(struct nfs4_slot_table tbl);
810d82e6	84	extern struct nfs4_slot nfs4_lookup_slot(struct nfs4_slot_table tbl, u32 slotid);
045d2a6d TM	85	extern int nfs4_slot_wait_on_seqid(struct nfs4_slot_table *tbl,
	86	u32 slotid, u32 seq_nr,
	87	unsigned long timeout);
810d82e6	88	extern bool nfs4_try_to_lock_slot(struct nfs4_slot_table tbl, struct nfs4_slot slot);
73e39aaa	89	extern void nfs4_free_slot(struct nfs4_slot_table tbl, struct nfs4_slot slot);
9d33059c	90	extern void nfs4_slot_tbl_drain_complete(struct nfs4_slot_table *tbl);
9d33059c CL	91	bool nfs41_wake_and_assign_slot(struct nfs4_slot_table *tbl,
	92	struct nfs4_slot *slot);
	93	void nfs41_wake_slot_table(struct nfs4_slot_table *tbl);
	94
	95	static inline bool nfs4_slot_tbl_draining(struct nfs4_slot_table *tbl)
	96	{
	97	return !!test_bit(NFS4_SLOT_TBL_DRAINING, &tbl->slot_tbl_state);
	98	}
	99
810d82e6 TM	100	static inline bool nfs4_test_locked_slot(const struct nfs4_slot_table *tbl,
	101	u32 slotid)
	102	{
	103	return !!test_bit(slotid, tbl->used_slots);
	104	}
	105
172d9de1	106	static inline struct nfs4_session nfs4_get_session(const struct nfs_client clp)
efc6f4aa	107	{
172d9de1	108	return clp->cl_session;
efc6f4aa AS	109	}
efc6f4aa AS	110
9d33059c CL	111	#if defined(CONFIG_NFS_V4_1)
	112	extern void nfs41_set_target_slotid(struct nfs4_slot_table *tbl,
	113	u32 target_highest_slotid);
1cec16ab CL	114	extern void nfs41_update_target_slotid(struct nfs4_slot_table *tbl,
	115	struct nfs4_slot *slot,
	116	struct nfs4_sequence_res *res);
73e39aaa TM	117
	118	extern int nfs4_setup_session_slot_tables(struct nfs4_session *ses);
	119
	120	extern struct nfs4_session nfs4_alloc_session(struct nfs_client clp);
	121	extern void nfs4_destroy_session(struct nfs4_session *session);
18aad3d5	122	extern int nfs4_init_session(struct nfs_client *clp);
73e39aaa TM	123	extern int nfs4_init_ds_session(struct nfs_client *, unsigned long);
73e39aaa TM	124
76e697ba TM	125	/*
	126	* Determine if sessions are in use.
	127	*/
	128	static inline int nfs4_has_session(const struct nfs_client *clp)
	129	{
	130	if (clp->cl_session)
	131	return 1;
	132	return 0;
	133	}
	134
	135	static inline int nfs4_has_persistent_session(const struct nfs_client *clp)
	136	{
	137	if (nfs4_has_session(clp))
	138	return (clp->cl_session->flags & SESSION4_PERSIST);
	139	return 0;
	140	}
	141
79969dd1 TM	142	static inline void nfs4_copy_sessionid(struct nfs4_sessionid *dst,
	143	const struct nfs4_sessionid *src)
	144	{
	145	memcpy(dst->data, src->data, NFS4_MAX_SESSIONID_LEN);
	146	}
	147
2f92ae34 TM	148	#ifdef CONFIG_CRC32
	149	/*
	150	* nfs_session_id_hash - calculate the crc32 hash for the session id
	151	* @session - pointer to session
	152	*/
	153	#define nfs_session_id_hash(sess_id) \
	154	(~crc32_le(0xFFFFFFFF, &(sess_id)->data[0], sizeof((sess_id)->data)))
	155	#else
	156	#define nfs_session_id_hash(session) (0)
	157	#endif
73e39aaa TM	158	#else /* defined(CONFIG_NFS_V4_1) */
73e39aaa TM	159
18aad3d5	160	static inline int nfs4_init_session(struct nfs_client *clp)
73e39aaa TM	161	{
	162	return 0;
	163	}
	164
76e697ba TM	165	/*
	166	* Determine if sessions are in use.
	167	*/
	168	static inline int nfs4_has_session(const struct nfs_client *clp)
	169	{
	170	return 0;
	171	}
	172
	173	static inline int nfs4_has_persistent_session(const struct nfs_client *clp)
	174	{
	175	return 0;
	176	}
	177
ad05cc0f AS	178	#define nfs_session_id_hash(session) (0)
ad05cc0f AS	179
73e39aaa	180	#endif /* defined(CONFIG_NFS_V4_1) */
76e697ba	181	#endif /* IS_ENABLED(CONFIG_NFS_V4) */
73e39aaa	182	#endif /* __LINUX_FS_NFS_NFS4SESSION_H */