[linux-2.6-block.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_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;
};

/* 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 */
	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 bool nfs4_slot_seqid_in_use(struct nfs4_slot_table  *tbl, u32 slotid, u32 seq_nr);
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);
}

#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;
}

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