[mirror_ubuntu-bionic-kernel.git] / fs / nfsd / state.h

/*
 *  Copyright (c) 2001 The Regents of the University of Michigan.
 *  All rights reserved.
 *
 *  Kendrick Smith <kmsmith@umich.edu>
 *  Andy Adamson <andros@umich.edu>
 *  
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *  
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the University nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
 *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *  DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 *  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef _NFSD4_STATE_H
#define _NFSD4_STATE_H

#include <linux/sunrpc/svc_xprt.h>
#include <linux/nfsd/nfsfh.h>
#include "nfsfh.h"

typedef struct {
	u32             cl_boot;
	u32             cl_id;
} clientid_t;

typedef struct {
	u32             so_boot;
	u32             so_stateownerid;
	u32             so_fileid;
} stateid_opaque_t;

typedef struct {
	u32                     si_generation;
	stateid_opaque_t        si_opaque;
} stateid_t;
#define si_boot           si_opaque.so_boot
#define si_stateownerid   si_opaque.so_stateownerid
#define si_fileid         si_opaque.so_fileid

#define STATEID_FMT	"(%08x/%08x/%08x/%08x)"
#define STATEID_VAL(s) \
	(s)->si_boot, \
	(s)->si_stateownerid, \
	(s)->si_fileid, \
	(s)->si_generation

struct nfsd4_callback {
	void *cb_op;
	struct nfs4_client *cb_clp;
	struct list_head cb_per_client;
	u32 cb_minorversion;
	struct rpc_message cb_msg;
	const struct rpc_call_ops *cb_ops;
	struct work_struct cb_work;
	bool cb_done;
};

struct nfs4_delegation {
	struct list_head	dl_perfile;
	struct list_head	dl_perclnt;
	struct list_head	dl_recall_lru;  /* delegation recalled */
	atomic_t		dl_count;       /* ref count */
	struct nfs4_client	*dl_client;
	struct nfs4_file	*dl_file;
	u32			dl_type;
	time_t			dl_time;
/* For recall: */
	stateid_t		dl_stateid;
	struct knfsd_fh		dl_fh;
	int			dl_retries;
	struct nfsd4_callback	dl_recall;
};

/* client delegation callback info */
struct nfs4_cb_conn {
	/* SETCLIENTID info */
	struct sockaddr_storage	cb_addr;
	struct sockaddr_storage	cb_saddr;
	size_t			cb_addrlen;
	u32                     cb_prog; /* used only in 4.0 case;
					    per-session otherwise */
	u32                     cb_ident;	/* minorversion 0 only */
	struct svc_xprt		*cb_xprt;	/* minorversion 1 only */
};

/* Maximum number of slots per session. 160 is useful for long haul TCP */
#define NFSD_MAX_SLOTS_PER_SESSION     160
/* Maximum number of operations per session compound */
#define NFSD_MAX_OPS_PER_COMPOUND	16
/* Maximum  session per slot cache size */
#define NFSD_SLOT_CACHE_SIZE		1024
/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION	32
#define NFSD_MAX_MEM_PER_SESSION  \
		(NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)

struct nfsd4_slot {
	bool	sl_inuse;
	bool	sl_cachethis;
	u16	sl_opcnt;
	u32	sl_seqid;
	__be32	sl_status;
	u32	sl_datalen;
	char	sl_data[];
};

struct nfsd4_channel_attrs {
	u32		headerpadsz;
	u32		maxreq_sz;
	u32		maxresp_sz;
	u32		maxresp_cached;
	u32		maxops;
	u32		maxreqs;
	u32		nr_rdma_attrs;
	u32		rdma_attrs;
};

struct nfsd4_create_session {
	clientid_t			clientid;
	struct nfs4_sessionid		sessionid;
	u32				seqid;
	u32				flags;
	struct nfsd4_channel_attrs	fore_channel;
	struct nfsd4_channel_attrs	back_channel;
	u32				callback_prog;
	u32				uid;
	u32				gid;
};

struct nfsd4_bind_conn_to_session {
	struct nfs4_sessionid		sessionid;
	u32				dir;
};

/* The single slot clientid cache structure */
struct nfsd4_clid_slot {
	u32				sl_seqid;
	__be32				sl_status;
	struct nfsd4_create_session	sl_cr_ses;
};

struct nfsd4_conn {
	struct list_head cn_persession;
	struct svc_xprt *cn_xprt;
	struct svc_xpt_user cn_xpt_user;
	struct nfsd4_session *cn_session;
/* CDFC4_FORE, CDFC4_BACK: */
	unsigned char cn_flags;
};

struct nfsd4_session {
	struct kref		se_ref;
	struct list_head	se_hash;	/* hash by sessionid */
	struct list_head	se_perclnt;
	u32			se_flags;
	struct nfs4_client	*se_client;
	struct nfs4_sessionid	se_sessionid;
	struct nfsd4_channel_attrs se_fchannel;
	struct nfsd4_channel_attrs se_bchannel;
	struct list_head	se_conns;
	u32			se_cb_prog;
	u32			se_cb_seq_nr;
	struct nfsd4_slot	*se_slots[];	/* forward channel slots */
};

static inline void
nfsd4_put_session(struct nfsd4_session *ses)
{
	extern void free_session(struct kref *kref);
	kref_put(&ses->se_ref, free_session);
}

static inline void
nfsd4_get_session(struct nfsd4_session *ses)
{
	kref_get(&ses->se_ref);
}

/* formatted contents of nfs4_sessionid */
struct nfsd4_sessionid {
	clientid_t	clientid;
	u32		sequence;
	u32		reserved;
};

#define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */

/*
 * struct nfs4_client - one per client.  Clientids live here.
 * 	o Each nfs4_client is hashed by clientid.
 *
 * 	o Each nfs4_clients is also hashed by name 
 * 	  (the opaque quantity initially sent by the client to identify itself).
 * 	  
 *	o cl_perclient list is used to ensure no dangling stateowner references
 *	  when we expire the nfs4_client
 */
struct nfs4_client {
	struct list_head	cl_idhash; 	/* hash by cl_clientid.id */
	struct list_head	cl_strhash; 	/* hash by cl_name */
	struct list_head	cl_openowners;
	struct list_head	cl_delegations;
	struct list_head        cl_lru;         /* tail queue */
	struct xdr_netobj	cl_name; 	/* id generated by client */
	char                    cl_recdir[HEXDIR_LEN]; /* recovery dir */
	nfs4_verifier		cl_verifier; 	/* generated by client */
	time_t                  cl_time;        /* time of last lease renewal */
	struct sockaddr_storage	cl_addr; 	/* client ipaddress */
	u32			cl_flavor;	/* setclientid pseudoflavor */
	char			*cl_principal;	/* setclientid principal name */
	struct svc_cred		cl_cred; 	/* setclientid principal */
	clientid_t		cl_clientid;	/* generated by server */
	nfs4_verifier		cl_confirm;	/* generated by server */
	u32			cl_firststate;	/* recovery dir creation */
	u32			cl_minorversion;

	/* for v4.0 and v4.1 callbacks: */
	struct nfs4_cb_conn	cl_cb_conn;
#define NFSD4_CLIENT_CB_UPDATE	1
#define NFSD4_CLIENT_KILL	2
	unsigned long		cl_cb_flags;
	struct rpc_clnt		*cl_cb_client;
	u32			cl_cb_ident;
#define NFSD4_CB_UP		0
#define NFSD4_CB_UNKNOWN	1
#define NFSD4_CB_DOWN		2
	int			cl_cb_state;
	struct nfsd4_callback	cl_cb_null;
	struct nfsd4_session	*cl_cb_session;
	struct list_head	cl_callbacks; /* list of in-progress callbacks */

	/* for all client information that callback code might need: */
	spinlock_t		cl_lock;

	/* for nfs41 */
	struct list_head	cl_sessions;
	struct nfsd4_clid_slot	cl_cs_slot;	/* create_session slot */
	u32			cl_exchange_flags;
	/* number of rpc's in progress over an associated session: */
	atomic_t		cl_refcount;

	/* for nfs41 callbacks */
	/* We currently support a single back channel with a single slot */
	unsigned long		cl_cb_slot_busy;
	struct rpc_wait_queue	cl_cb_waitq;	/* backchannel callers may */
						/* wait here for slots */
};

static inline void
mark_client_expired(struct nfs4_client *clp)
{
	clp->cl_time = 0;
}

static inline bool
is_client_expired(struct nfs4_client *clp)
{
	return clp->cl_time == 0;
}

/* struct nfs4_client_reset
 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
 * upon lease reset, or from upcall to state_daemon (to read in state
 * from non-volitile storage) upon reboot.
 */
struct nfs4_client_reclaim {
	struct list_head	cr_strhash;	/* hash by cr_name */
	char			cr_recdir[HEXDIR_LEN]; /* recover dir */
};

static inline void
update_stateid(stateid_t *stateid)
{
	stateid->si_generation++;
}

/* A reasonable value for REPLAY_ISIZE was estimated as follows:  
 * The OPEN response, typically the largest, requires 
 *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) + 
 *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) + 
 *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes 
 */

#define NFSD4_REPLAY_ISIZE       112 

/*
 * Replay buffer, where the result of the last seqid-mutating operation 
 * is cached. 
 */
struct nfs4_replay {
	__be32			rp_status;
	unsigned int		rp_buflen;
	char			*rp_buf;
	unsigned		intrp_allocated;
	struct knfsd_fh		rp_openfh;
	char			rp_ibuf[NFSD4_REPLAY_ISIZE];
};

/*
* nfs4_stateowner can either be an open_owner, or a lock_owner
*
*    so_idhash:  stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
*         for lock_owner
*    so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
*         for lock_owner
*    so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
*         struct is reaped.
*    so_perfilestate: heads the list of nfs4_stateid (either open or lock) 
*         and is used to ensure no dangling nfs4_stateid references when we 
*         release a stateowner.
*    so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
*         close is called to reap associated byte-range locks
*    so_close_lru: (open) stateowner is placed on this list instead of being
*         reaped (when so_perfilestate is empty) to hold the last close replay.
*         reaped by laundramat thread after lease period.
*/
struct nfs4_stateowner {
	struct kref		so_ref;
	struct list_head        so_idhash;   /* hash by so_id */
	struct list_head        so_strhash;   /* hash by op_name */
	struct list_head        so_perclient;
	struct list_head        so_stateids;
	struct list_head        so_perstateid; /* for lockowners only */
	struct list_head	so_close_lru; /* tail queue */
	time_t			so_time; /* time of placement on so_close_lru */
	int			so_is_open_owner; /* 1=openowner,0=lockowner */
	u32                     so_id;
	struct nfs4_client *    so_client;
	/* after increment in ENCODE_SEQID_OP_TAIL, represents the next
	 * sequence id expected from the client: */
	u32                     so_seqid;
	struct xdr_netobj       so_owner;     /* open owner name */
	int                     so_confirmed; /* successful OPEN_CONFIRM? */
	struct nfs4_replay	so_replay;
};

/*
*  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
*    o fi_perfile list is used to search for conflicting 
*      share_acces, share_deny on the file.
*/
struct nfs4_file {
	atomic_t		fi_ref;
	struct list_head        fi_hash;    /* hash by "struct inode *" */
	struct list_head        fi_stateids;
	struct list_head	fi_delegations;
	/* One each for O_RDONLY, O_WRONLY, O_RDWR: */
	struct file *		fi_fds[3];
	/* One each for O_RDONLY, O_WRONLY: */
	atomic_t		fi_access[2];
	/*
	 * Each open stateid contributes 1 to either fi_readers or
	 * fi_writers, or both, depending on the open mode.  A
	 * delegation also takes an fi_readers reference.  Lock
	 * stateid's take none.
	 */
	atomic_t		fi_readers;
	atomic_t		fi_writers;
	struct file		*fi_deleg_file;
	struct file_lock	*fi_lease;
	atomic_t		fi_delegees;
	struct inode		*fi_inode;
	u32                     fi_id;      /* used with stateowner->so_id 
					     * for stateid_hashtbl hash */
	bool			fi_had_conflict;
};

/* XXX: for first cut may fall back on returning file that doesn't work
 * at all? */
static inline struct file *find_writeable_file(struct nfs4_file *f)
{
	if (f->fi_fds[O_WRONLY])
		return f->fi_fds[O_WRONLY];
	return f->fi_fds[O_RDWR];
}

static inline struct file *find_readable_file(struct nfs4_file *f)
{
	if (f->fi_fds[O_RDONLY])
		return f->fi_fds[O_RDONLY];
	return f->fi_fds[O_RDWR];
}

static inline struct file *find_any_file(struct nfs4_file *f)
{
	if (f->fi_fds[O_RDWR])
		return f->fi_fds[O_RDWR];
	else if (f->fi_fds[O_WRONLY])
		return f->fi_fds[O_WRONLY];
	else
		return f->fi_fds[O_RDONLY];
}

/*
* nfs4_stateid can either be an open stateid or (eventually) a lock stateid
*
* (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
*
* 	st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
* 	st_perfile: file_hashtbl[] entry.
* 	st_perfile_state: nfs4_stateowner->so_perfilestate
*       st_perlockowner: (open stateid) list of lock nfs4_stateowners
* 	st_access_bmap: used only for open stateid
* 	st_deny_bmap: used only for open stateid
*	st_openstp: open stateid lock stateid was derived from
*
* XXX: open stateids and lock stateids have diverged sufficiently that
* we should consider defining separate structs for the two cases.
*/

struct nfs4_stateid {
	struct list_head              st_hash; 
	struct list_head              st_perfile;
	struct list_head              st_perstateowner;
	struct list_head              st_lockowners;
	struct nfs4_stateowner      * st_stateowner;
	struct nfs4_file            * st_file;
	stateid_t                     st_stateid;
	unsigned long                 st_access_bmap;
	unsigned long                 st_deny_bmap;
	struct nfs4_stateid         * st_openstp;
};

/* flags for preprocess_seqid_op() */
#define HAS_SESSION             0x00000001
#define CONFIRM                 0x00000002
#define OPEN_STATE              0x00000004
#define LOCK_STATE              0x00000008
#define RD_STATE	        0x00000010
#define WR_STATE	        0x00000020
#define CLOSE_STATE             0x00000040

#define seqid_mutating_err(err)                       \
	(((err) != nfserr_stale_clientid) &&    \
	((err) != nfserr_bad_seqid) &&          \
	((err) != nfserr_stale_stateid) &&      \
	((err) != nfserr_bad_stateid))

struct nfsd4_compound_state;

extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
		stateid_t *stateid, int flags, struct file **filp);
extern void nfs4_lock_state(void);
extern void nfs4_unlock_state(void);
extern int nfs4_in_grace(void);
extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
extern void nfs4_free_stateowner(struct kref *kref);
extern int set_callback_cred(void);
extern void nfsd4_probe_callback(struct nfs4_client *clp);
extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
extern void nfsd4_do_callback_rpc(struct work_struct *);
extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
extern int nfsd4_create_callback_queue(void);
extern void nfsd4_destroy_callback_queue(void);
extern void nfsd4_shutdown_callback(struct nfs4_client *);
extern void nfs4_put_delegation(struct nfs4_delegation *dp);
extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
extern void nfsd4_init_recdir(char *recdir_name);
extern int nfsd4_recdir_load(void);
extern void nfsd4_shutdown_recdir(void);
extern int nfs4_client_to_reclaim(const char *name);
extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
extern void nfsd4_recdir_purge_old(void);
extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
extern void release_session_client(struct nfsd4_session *);

static inline void
nfs4_put_stateowner(struct nfs4_stateowner *so)
{
	kref_put(&so->so_ref, nfs4_free_stateowner);
}

static inline void
nfs4_get_stateowner(struct nfs4_stateowner *so)
{
	kref_get(&so->so_ref);
}

#endif   /* NFSD4_STATE_H */
Commit	Line	Data
1da177e4	1	/*
1da177e4 LT	2	* Copyright (c) 2001 The Regents of the University of Michigan.
	3	* All rights reserved.
	4	*
	5	* Kendrick Smith <kmsmith@umich.edu>
	6	* Andy Adamson <andros@umich.edu>
	7	*
	8	* Redistribution and use in source and binary forms, with or without
	9	* modification, are permitted provided that the following conditions
	10	* are met:
	11	*
	12	* 1. Redistributions of source code must retain the above copyright
	13	* notice, this list of conditions and the following disclaimer.
	14	* 2. Redistributions in binary form must reproduce the above copyright
	15	* notice, this list of conditions and the following disclaimer in the
	16	* documentation and/or other materials provided with the distribution.
	17	* 3. Neither the name of the University nor the names of its
	18	* contributors may be used to endorse or promote products derived
	19	* from this software without specific prior written permission.
	20	*
	21	* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
	22	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
	23	* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	24	* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	25	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	26	* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	27	* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
	28	* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
	29	* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
	30	* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
	31	* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	32	*
	33	*/
	34
	35	#ifndef _NFSD4_STATE_H
	36	#define _NFSD4_STATE_H
	37
19cf5c02	38	#include <linux/sunrpc/svc_xprt.h>
72579ac9	39	#include <linux/nfsd/nfsfh.h>
1557aca7	40	#include "nfsfh.h"
1da177e4	41
1da177e4 LT	42	typedef struct {
	43	u32 cl_boot;
	44	u32 cl_id;
	45	} clientid_t;
	46
	47	typedef struct {
	48	u32 so_boot;
	49	u32 so_stateownerid;
	50	u32 so_fileid;
	51	} stateid_opaque_t;
	52
	53	typedef struct {
	54	u32 si_generation;
	55	stateid_opaque_t si_opaque;
	56	} stateid_t;
	57	#define si_boot si_opaque.so_boot
	58	#define si_stateownerid si_opaque.so_stateownerid
	59	#define si_fileid si_opaque.so_fileid
	60
8c10cbdb BH	61	#define STATEID_FMT "(%08x/%08x/%08x/%08x)"
	62	#define STATEID_VAL(s) \
	63	(s)->si_boot, \
	64	(s)->si_stateownerid, \
	65	(s)->si_fileid, \
	66	(s)->si_generation
	67
227f98d9	68	struct nfsd4_callback {
fb003923 BF	69	void *cb_op;
fb003923 BF	70	struct nfs4_client *cb_clp;
5ce8ba25	71	struct list_head cb_per_client;
fb003923	72	u32 cb_minorversion;
5878453d BF	73	struct rpc_message cb_msg;
5878453d BF	74	const struct rpc_call_ops *cb_ops;
b5a1a81e	75	struct work_struct cb_work;
5ce8ba25	76	bool cb_done;
227f98d9 BF	77	};
227f98d9 BF	78
1da177e4	79	struct nfs4_delegation {
ea1da636 N	80	struct list_head dl_perfile;
ea1da636 N	81	struct list_head dl_perclnt;
1da177e4 LT	82	struct list_head dl_recall_lru; /* delegation recalled */
	83	atomic_t dl_count; /* ref count */
	84	struct nfs4_client *dl_client;
	85	struct nfs4_file *dl_file;
1da177e4 LT	86	u32 dl_type;
1da177e4 LT	87	time_t dl_time;
b53d40c5	88	/* For recall: */
b53d40c5 BF	89	stateid_t dl_stateid;
b53d40c5 BF	90	struct knfsd_fh dl_fh;
3aea09dc	91	int dl_retries;
227f98d9	92	struct nfsd4_callback dl_recall;
1da177e4 LT	93	};
1da177e4 LT	94
1da177e4	95	/* client delegation callback info */
c237dc03	96	struct nfs4_cb_conn {
1da177e4	97	/* SETCLIENTID info */
aa9a4ec7	98	struct sockaddr_storage cb_addr;
6f3d772f	99	struct sockaddr_storage cb_saddr;
aa9a4ec7	100	size_t cb_addrlen;
8b5ce5cd BF	101	u32 cb_prog; /* used only in 4.0 case;
8b5ce5cd BF	102	per-session otherwise */
ab52ae6d	103	u32 cb_ident; /* minorversion 0 only */
2bf23875	104	struct svc_xprt cb_xprt; / minorversion 1 only */
1da177e4 LT	105	};
1da177e4 LT	106
a649637c AA	107	/* Maximum number of slots per session. 160 is useful for long haul TCP */
a649637c AA	108	#define NFSD_MAX_SLOTS_PER_SESSION 160
ec6b5d7b AA	109	/* Maximum number of operations per session compound */
ec6b5d7b AA	110	#define NFSD_MAX_OPS_PER_COMPOUND 16
557ce264 AA	111	/* Maximum session per slot cache size */
557ce264 AA	112	#define NFSD_SLOT_CACHE_SIZE 1024
a649637c AA	113	/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
	114	#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
	115	#define NFSD_MAX_MEM_PER_SESSION \
	116	(NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
074fe897	117
7116ed6b	118	struct nfsd4_slot {
557ce264 AA	119	bool sl_inuse;
	120	bool sl_cachethis;
	121	u16 sl_opcnt;
	122	u32 sl_seqid;
	123	__be32 sl_status;
	124	u32 sl_datalen;
	125	char sl_data[];
7116ed6b AA	126	};
7116ed6b AA	127
6c18ba9f AB	128	struct nfsd4_channel_attrs {
	129	u32 headerpadsz;
	130	u32 maxreq_sz;
	131	u32 maxresp_sz;
	132	u32 maxresp_cached;
	133	u32 maxops;
	134	u32 maxreqs;
	135	u32 nr_rdma_attrs;
	136	u32 rdma_attrs;
	137	};
	138
49557cc7 AA	139	struct nfsd4_create_session {
	140	clientid_t clientid;
	141	struct nfs4_sessionid sessionid;
	142	u32 seqid;
	143	u32 flags;
	144	struct nfsd4_channel_attrs fore_channel;
	145	struct nfsd4_channel_attrs back_channel;
	146	u32 callback_prog;
	147	u32 uid;
	148	u32 gid;
	149	};
	150
1d1bc8f2 BF	151	struct nfsd4_bind_conn_to_session {
	152	struct nfs4_sessionid sessionid;
	153	u32 dir;
	154	};
	155
49557cc7 AA	156	/* The single slot clientid cache structure */
	157	struct nfsd4_clid_slot {
	158	u32 sl_seqid;
	159	__be32 sl_status;
	160	struct nfsd4_create_session sl_cr_ses;
	161	};
	162
c7662518 BF	163	struct nfsd4_conn {
	164	struct list_head cn_persession;
	165	struct svc_xprt *cn_xprt;
19cf5c02 BF	166	struct svc_xpt_user cn_xpt_user;
19cf5c02 BF	167	struct nfsd4_session *cn_session;
c7662518 BF	168	/* CDFC4_FORE, CDFC4_BACK: */
	169	unsigned char cn_flags;
	170	};
	171
7116ed6b AA	172	struct nfsd4_session {
	173	struct kref se_ref;
	174	struct list_head se_hash; /* hash by sessionid */
	175	struct list_head se_perclnt;
	176	u32 se_flags;
07cd4909	177	struct nfs4_client *se_client;
7116ed6b	178	struct nfs4_sessionid se_sessionid;
6c18ba9f AB	179	struct nfsd4_channel_attrs se_fchannel;
6c18ba9f AB	180	struct nfsd4_channel_attrs se_bchannel;
c7662518	181	struct list_head se_conns;
8b5ce5cd	182	u32 se_cb_prog;
ac7c46f2	183	u32 se_cb_seq_nr;
557ce264	184	struct nfsd4_slot se_slots[]; / forward channel slots */
7116ed6b AA	185	};
	186
	187	static inline void
	188	nfsd4_put_session(struct nfsd4_session *ses)
	189	{
	190	extern void free_session(struct kref *kref);
	191	kref_put(&ses->se_ref, free_session);
	192	}
	193
	194	static inline void
	195	nfsd4_get_session(struct nfsd4_session *ses)
	196	{
	197	kref_get(&ses->se_ref);
	198	}
	199
5282fd72 ME	200	/* formatted contents of nfs4_sessionid */
	201	struct nfsd4_sessionid {
	202	clientid_t clientid;
	203	u32 sequence;
	204	u32 reserved;
	205	};
	206
a55370a3 N	207	#define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
a55370a3 N	208
1da177e4 LT	209	/*
	210	* struct nfs4_client - one per client. Clientids live here.
	211	* o Each nfs4_client is hashed by clientid.
	212	*
	213	* o Each nfs4_clients is also hashed by name
	214	* (the opaque quantity initially sent by the client to identify itself).
	215	*
	216	* o cl_perclient list is used to ensure no dangling stateowner references
	217	* when we expire the nfs4_client
	218	*/
	219	struct nfs4_client {
	220	struct list_head cl_idhash; /* hash by cl_clientid.id */
	221	struct list_head cl_strhash; /* hash by cl_name */
ea1da636 N	222	struct list_head cl_openowners;
ea1da636 N	223	struct list_head cl_delegations;
1da177e4 LT	224	struct list_head cl_lru; /* tail queue */
1da177e4 LT	225	struct xdr_netobj cl_name; /* id generated by client */
a55370a3	226	char cl_recdir[HEXDIR_LEN]; /* recovery dir */
1da177e4 LT	227	nfs4_verifier cl_verifier; /* generated by client */
1da177e4 LT	228	time_t cl_time; /* time of last lease renewal */
363168b4	229	struct sockaddr_storage cl_addr; /* client ipaddress */
61054b14	230	u32 cl_flavor; /* setclientid pseudoflavor */
68e76ad0	231	char cl_principal; / setclientid principal name */
1da177e4 LT	232	struct svc_cred cl_cred; /* setclientid principal */
	233	clientid_t cl_clientid; /* generated by server */
	234	nfs4_verifier cl_confirm; /* generated by server */
c7b9a459	235	u32 cl_firststate; /* recovery dir creation */
8323c3b2	236	u32 cl_minorversion;
9fb87070	237
2bf23875 BF	238	/* for v4.0 and v4.1 callbacks: */
2bf23875 BF	239	struct nfs4_cb_conn cl_cb_conn;
6ff8da08 BF	240	#define NFSD4_CLIENT_CB_UPDATE 1
	241	#define NFSD4_CLIENT_KILL 2
	242	unsigned long cl_cb_flags;
2bf23875	243	struct rpc_clnt *cl_cb_client;
6ff8da08	244	u32 cl_cb_ident;
77a3569d BF	245	#define NFSD4_CB_UP 0
	246	#define NFSD4_CB_UNKNOWN 1
	247	#define NFSD4_CB_DOWN 2
	248	int cl_cb_state;
cee277d9	249	struct nfsd4_callback cl_cb_null;
edd76786	250	struct nfsd4_session *cl_cb_session;
5ce8ba25	251	struct list_head cl_callbacks; /* list of in-progress callbacks */
2bf23875	252
6ff8da08 BF	253	/* for all client information that callback code might need: */
	254	spinlock_t cl_lock;
	255
9fb87070 ME	256	/* for nfs41 */
9fb87070 ME	257	struct list_head cl_sessions;
49557cc7	258	struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
0733d213	259	u32 cl_exchange_flags;
46583e25 BH	260	/* number of rpc's in progress over an associated session: */
46583e25 BH	261	atomic_t cl_refcount;
38524ab3 AA	262
38524ab3 AA	263	/* for nfs41 callbacks */
199ff35e RL	264	/* We currently support a single back channel with a single slot */
199ff35e RL	265	unsigned long cl_cb_slot_busy;
199ff35e RL	266	struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
199ff35e RL	267	/* wait here for slots */
1da177e4 LT	268	};
1da177e4 LT	269
07cd4909 BH	270	static inline void
	271	mark_client_expired(struct nfs4_client *clp)
	272	{
	273	clp->cl_time = 0;
	274	}
	275
	276	static inline bool
	277	is_client_expired(struct nfs4_client *clp)
	278	{
	279	return clp->cl_time == 0;
	280	}
	281
1da177e4 LT	282	/* struct nfs4_client_reset
	283	* one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
	284	* upon lease reset, or from upcall to state_daemon (to read in state
	285	* from non-volitile storage) upon reboot.
	286	*/
	287	struct nfs4_client_reclaim {
	288	struct list_head cr_strhash; /* hash by cr_name */
a55370a3	289	char cr_recdir[HEXDIR_LEN]; /* recover dir */
1da177e4 LT	290	};
	291
	292	static inline void
	293	update_stateid(stateid_t *stateid)
	294	{
	295	stateid->si_generation++;
	296	}
	297
	298	/* A reasonable value for REPLAY_ISIZE was estimated as follows:
	299	* The OPEN response, typically the largest, requires
	300	* 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
	301	* 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
	302	* 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
	303	*/
	304
	305	#define NFSD4_REPLAY_ISIZE 112
	306
	307	/*
	308	* Replay buffer, where the result of the last seqid-mutating operation
	309	* is cached.
	310	*/
	311	struct nfs4_replay {
b37ad28b	312	__be32 rp_status;
1da177e4 LT	313	unsigned int rp_buflen;
	314	char *rp_buf;
	315	unsigned intrp_allocated;
a4773c08	316	struct knfsd_fh rp_openfh;
1da177e4 LT	317	char rp_ibuf[NFSD4_REPLAY_ISIZE];
	318	};
	319
	320	/*
	321	* nfs4_stateowner can either be an open_owner, or a lock_owner
	322	*
	323	* so_idhash: stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
	324	* for lock_owner
	325	* so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
	326	* for lock_owner
	327	* so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
	328	* struct is reaped.
	329	* so_perfilestate: heads the list of nfs4_stateid (either open or lock)
	330	* and is used to ensure no dangling nfs4_stateid references when we
	331	* release a stateowner.
	332	* so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
	333	* close is called to reap associated byte-range locks
	334	* so_close_lru: (open) stateowner is placed on this list instead of being
	335	* reaped (when so_perfilestate is empty) to hold the last close replay.
	336	* reaped by laundramat thread after lease period.
	337	*/
	338	struct nfs4_stateowner {
	339	struct kref so_ref;
	340	struct list_head so_idhash; /* hash by so_id */
	341	struct list_head so_strhash; /* hash by op_name */
ea1da636 N	342	struct list_head so_perclient;
	343	struct list_head so_stateids;
	344	struct list_head so_perstateid; /* for lockowners only */
1da177e4 LT	345	struct list_head so_close_lru; /* tail queue */
	346	time_t so_time; /* time of placement on so_close_lru */
	347	int so_is_open_owner; /* 1=openowner,0=lockowner */
	348	u32 so_id;
	349	struct nfs4_client * so_client;
7fb64cee N	350	/* after increment in ENCODE_SEQID_OP_TAIL, represents the next
	351	* sequence id expected from the client: */
	352	u32 so_seqid;
1da177e4 LT	353	struct xdr_netobj so_owner; /* open owner name */
	354	int so_confirmed; /* successful OPEN_CONFIRM? */
	355	struct nfs4_replay so_replay;
	356	};
	357
	358	/*
	359	* nfs4_file: a file opened by some number of (open) nfs4_stateowners.
	360	* o fi_perfile list is used to search for conflicting
	361	* share_acces, share_deny on the file.
	362	*/
	363	struct nfs4_file {
8b671b80	364	atomic_t fi_ref;
1da177e4	365	struct list_head fi_hash; /* hash by "struct inode " /
8beefa24 N	366	struct list_head fi_stateids;
8beefa24 N	367	struct list_head fi_delegations;
f9d7562f BF	368	/* One each for O_RDONLY, O_WRONLY, O_RDWR: */
	369	struct file * fi_fds[3];
	370	/* One each for O_RDONLY, O_WRONLY: */
	371	atomic_t fi_access[2];
	372	/*
	373	* Each open stateid contributes 1 to either fi_readers or
	374	* fi_writers, or both, depending on the open mode. A
	375	* delegation also takes an fi_readers reference. Lock
	376	* stateid's take none.
	377	*/
	378	atomic_t fi_readers;
	379	atomic_t fi_writers;
acfdf5c3 BF	380	struct file *fi_deleg_file;
	381	struct file_lock *fi_lease;
	382	atomic_t fi_delegees;
1da177e4 LT	383	struct inode *fi_inode;
	384	u32 fi_id; /* used with stateowner->so_id
	385	* for stateid_hashtbl hash */
47f9940c	386	bool fi_had_conflict;
1da177e4 LT	387	};
1da177e4 LT	388
f9d7562f BF	389	/* XXX: for first cut may fall back on returning file that doesn't work
	390	* at all? */
	391	static inline struct file find_writeable_file(struct nfs4_file f)
	392	{
7d947842 BF	393	if (f->fi_fds[O_WRONLY])
	394	return f->fi_fds[O_WRONLY];
	395	return f->fi_fds[O_RDWR];
f9d7562f BF	396	}
	397
	398	static inline struct file find_readable_file(struct nfs4_file f)
	399	{
7d947842 BF	400	if (f->fi_fds[O_RDONLY])
	401	return f->fi_fds[O_RDONLY];
	402	return f->fi_fds[O_RDWR];
f9d7562f BF	403	}
	404
	405	static inline struct file find_any_file(struct nfs4_file f)
	406	{
	407	if (f->fi_fds[O_RDWR])
	408	return f->fi_fds[O_RDWR];
18608ad4	409	else if (f->fi_fds[O_WRONLY])
f9d7562f BF	410	return f->fi_fds[O_WRONLY];
	411	else
	412	return f->fi_fds[O_RDONLY];
	413	}
	414
1da177e4 LT	415	/*
	416	* nfs4_stateid can either be an open stateid or (eventually) a lock stateid
	417	*
	418	* (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
	419	*
	420	* st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
	421	* st_perfile: file_hashtbl[] entry.
	422	* st_perfile_state: nfs4_stateowner->so_perfilestate
	423	* st_perlockowner: (open stateid) list of lock nfs4_stateowners
	424	* st_access_bmap: used only for open stateid
	425	* st_deny_bmap: used only for open stateid
4c4cd222 N	426	* st_openstp: open stateid lock stateid was derived from
	427	*
	428	* XXX: open stateids and lock stateids have diverged sufficiently that
	429	* we should consider defining separate structs for the two cases.
1da177e4 LT	430	*/
	431
	432	struct nfs4_stateid {
	433	struct list_head st_hash;
	434	struct list_head st_perfile;
ea1da636 N	435	struct list_head st_perstateowner;
ea1da636 N	436	struct list_head st_lockowners;
1da177e4 LT	437	struct nfs4_stateowner * st_stateowner;
	438	struct nfs4_file * st_file;
	439	stateid_t st_stateid;
1da177e4 LT	440	unsigned long st_access_bmap;
1da177e4 LT	441	unsigned long st_deny_bmap;
4c4cd222	442	struct nfs4_stateid * st_openstp;
1da177e4 LT	443	};
	444
	445	/* flags for preprocess_seqid_op() */
6668958f	446	#define HAS_SESSION 0x00000001
1da177e4 LT	447	#define CONFIRM 0x00000002
	448	#define OPEN_STATE 0x00000004
	449	#define LOCK_STATE 0x00000008
	450	#define RD_STATE 0x00000010
	451	#define WR_STATE 0x00000020
	452	#define CLOSE_STATE 0x00000040
1da177e4 LT	453
	454	#define seqid_mutating_err(err) \
	455	(((err) != nfserr_stale_clientid) && \
	456	((err) != nfserr_bad_seqid) && \
	457	((err) != nfserr_stale_stateid) && \
	458	((err) != nfserr_bad_stateid))
	459
dd453dfd BH	460	struct nfsd4_compound_state;
	461
	462	extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
1da177e4	463	stateid_t stateid, int flags, struct file *filp);
1da177e4 LT	464	extern void nfs4_lock_state(void);
	465	extern void nfs4_unlock_state(void);
	466	extern int nfs4_in_grace(void);
b37ad28b	467	extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
1da177e4	468	extern void nfs4_free_stateowner(struct kref *kref);
80fc015b	469	extern int set_callback_cred(void);
5a3c9d71	470	extern void nfsd4_probe_callback(struct nfs4_client *clp);
84f5f7cc	471	extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
5a3c9d71	472	extern void nfsd4_change_callback(struct nfs4_client clp, struct nfs4_cb_conn );
b5a1a81e	473	extern void nfsd4_do_callback_rpc(struct work_struct *);
1da177e4	474	extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
b5a1a81e BF	475	extern int nfsd4_create_callback_queue(void);
b5a1a81e BF	476	extern void nfsd4_destroy_callback_queue(void);
6ff8da08	477	extern void nfsd4_shutdown_callback(struct nfs4_client *);
1da177e4	478	extern void nfs4_put_delegation(struct nfs4_delegation *dp);
b37ad28b	479	extern __be32 nfs4_make_rec_clidname(char clidname, struct xdr_netobj clname);
190e4fbf N	480	extern void nfsd4_init_recdir(char *recdir_name);
	481	extern int nfsd4_recdir_load(void);
	482	extern void nfsd4_shutdown_recdir(void);
	483	extern int nfs4_client_to_reclaim(const char *name);
a1bcecd2	484	extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
c7b9a459 N	485	extern void nfsd4_recdir_purge_old(void);
	486	extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
	487	extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
d7682988	488	extern void release_session_client(struct nfsd4_session *);
1da177e4 LT	489
	490	static inline void
	491	nfs4_put_stateowner(struct nfs4_stateowner *so)
	492	{
	493	kref_put(&so->so_ref, nfs4_free_stateowner);
	494	}
	495
	496	static inline void
	497	nfs4_get_stateowner(struct nfs4_stateowner *so)
	498	{
	499	kref_get(&so->so_ref);
	500	}
	501
	502	#endif /* NFSD4_STATE_H */