[linux-2.6-block.git] / fs / nfs / nfs4session.h

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