[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/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_cb_sequence {
	/* args/res */
	u32			cbs_minorversion;
	struct nfs4_client	*cbs_clp;
};

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;
	struct file_lock	*dl_flock;
	struct file		*dl_vfs_file;
	u32			dl_type;
	time_t			dl_time;
/* For recall: */
	u32			dl_ident;
	stateid_t		dl_stateid;
	struct knfsd_fh		dl_fh;
	int			dl_retries;
};

/* client delegation callback info */
struct nfs4_cb_conn {
	/* SETCLIENTID info */
	struct sockaddr_storage	cb_addr;
	size_t			cb_addrlen;
	u32                     cb_prog;
	u32			cb_minorversion;
	u32                     cb_ident;	/* minorversion 0 only */
	/* RPC client info */
	atomic_t		cb_set;     /* successful CB_NULL call */
	struct rpc_clnt *       cb_client;
};

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

/* 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_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;	/* for expire_client */
	struct nfs4_sessionid	se_sessionid;
	struct nfsd4_channel_attrs se_fchannel;
	struct nfsd4_channel_attrs se_bchannel;
	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 */
	struct nfs4_cb_conn	cl_cb_conn;     /* callback info */
	atomic_t		cl_count;	/* ref count */
	u32			cl_firststate;	/* recovery dir creation */

	/* for nfs41 */
	struct list_head	cl_sessions;
	struct nfsd4_clid_slot	cl_cs_slot;	/* create_session slot */
	u32			cl_exchange_flags;
	struct nfs4_sessionid	cl_sessionid;

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

/* 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;
	struct inode		*fi_inode;
	u32                     fi_id;      /* used with stateowner->so_id 
					     * for stateid_hashtbl hash */
	bool			fi_had_conflict;
};

/*
* 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;
	struct file                 * st_vfs_file;
	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 put_nfs4_client(struct nfs4_client *clp);
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_cb_recall(struct nfs4_delegation *dp);
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);

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
72579ac9	38	#include <linux/nfsd/nfsfh.h>
1557aca7	39	#include "nfsfh.h"
1da177e4	40
1da177e4 LT	41	typedef struct {
	42	u32 cl_boot;
	43	u32 cl_id;
	44	} clientid_t;
	45
	46	typedef struct {
	47	u32 so_boot;
	48	u32 so_stateownerid;
	49	u32 so_fileid;
	50	} stateid_opaque_t;
	51
	52	typedef struct {
	53	u32 si_generation;
	54	stateid_opaque_t si_opaque;
	55	} stateid_t;
	56	#define si_boot si_opaque.so_boot
	57	#define si_stateownerid si_opaque.so_stateownerid
	58	#define si_fileid si_opaque.so_fileid
	59
8c10cbdb BH	60	#define STATEID_FMT "(%08x/%08x/%08x/%08x)"
	61	#define STATEID_VAL(s) \
	62	(s)->si_boot, \
	63	(s)->si_stateownerid, \
	64	(s)->si_fileid, \
	65	(s)->si_generation
	66
132f9771 RL	67	struct nfsd4_cb_sequence {
	68	/* args/res */
	69	u32 cbs_minorversion;
	70	struct nfs4_client *cbs_clp;
	71	};
	72
1da177e4	73	struct nfs4_delegation {
ea1da636 N	74	struct list_head dl_perfile;
ea1da636 N	75	struct list_head dl_perclnt;
1da177e4 LT	76	struct list_head dl_recall_lru; /* delegation recalled */
	77	atomic_t dl_count; /* ref count */
	78	struct nfs4_client *dl_client;
	79	struct nfs4_file *dl_file;
	80	struct file_lock *dl_flock;
	81	struct file *dl_vfs_file;
	82	u32 dl_type;
	83	time_t dl_time;
b53d40c5 BF	84	/* For recall: */
b53d40c5 BF	85	u32 dl_ident;
b53d40c5 BF	86	stateid_t dl_stateid;
b53d40c5 BF	87	struct knfsd_fh dl_fh;
3aea09dc	88	int dl_retries;
1da177e4 LT	89	};
1da177e4 LT	90
1da177e4	91	/* client delegation callback info */
c237dc03	92	struct nfs4_cb_conn {
1da177e4	93	/* SETCLIENTID info */
aa9a4ec7 JL	94	struct sockaddr_storage cb_addr;
aa9a4ec7 JL	95	size_t cb_addrlen;
1da177e4	96	u32 cb_prog;
ab52ae6d AA	97	u32 cb_minorversion;
ab52ae6d AA	98	u32 cb_ident; /* minorversion 0 only */
1da177e4 LT	99	/* RPC client info */
1da177e4 LT	100	atomic_t cb_set; /* successful CB_NULL call */
1da177e4 LT	101	struct rpc_clnt * cb_client;
	102	};
	103
a649637c AA	104	/* Maximum number of slots per session. 160 is useful for long haul TCP */
a649637c AA	105	#define NFSD_MAX_SLOTS_PER_SESSION 160
ec6b5d7b AA	106	/* Maximum number of operations per session compound */
ec6b5d7b AA	107	#define NFSD_MAX_OPS_PER_COMPOUND 16
557ce264 AA	108	/* Maximum session per slot cache size */
557ce264 AA	109	#define NFSD_SLOT_CACHE_SIZE 1024
a649637c AA	110	/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
	111	#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
	112	#define NFSD_MAX_MEM_PER_SESSION \
	113	(NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
074fe897	114
7116ed6b	115	struct nfsd4_slot {
557ce264 AA	116	bool sl_inuse;
	117	bool sl_cachethis;
	118	u16 sl_opcnt;
	119	u32 sl_seqid;
	120	__be32 sl_status;
	121	u32 sl_datalen;
	122	char sl_data[];
7116ed6b AA	123	};
7116ed6b AA	124
6c18ba9f AB	125	struct nfsd4_channel_attrs {
	126	u32 headerpadsz;
	127	u32 maxreq_sz;
	128	u32 maxresp_sz;
	129	u32 maxresp_cached;
	130	u32 maxops;
	131	u32 maxreqs;
	132	u32 nr_rdma_attrs;
	133	u32 rdma_attrs;
	134	};
	135
49557cc7 AA	136	struct nfsd4_create_session {
	137	clientid_t clientid;
	138	struct nfs4_sessionid sessionid;
	139	u32 seqid;
	140	u32 flags;
	141	struct nfsd4_channel_attrs fore_channel;
	142	struct nfsd4_channel_attrs back_channel;
	143	u32 callback_prog;
	144	u32 uid;
	145	u32 gid;
	146	};
	147
	148	/* The single slot clientid cache structure */
	149	struct nfsd4_clid_slot {
	150	u32 sl_seqid;
	151	__be32 sl_status;
	152	struct nfsd4_create_session sl_cr_ses;
	153	};
	154
7116ed6b AA	155	struct nfsd4_session {
	156	struct kref se_ref;
	157	struct list_head se_hash; /* hash by sessionid */
	158	struct list_head se_perclnt;
	159	u32 se_flags;
	160	struct nfs4_client se_client; / for expire_client */
	161	struct nfs4_sessionid se_sessionid;
6c18ba9f AB	162	struct nfsd4_channel_attrs se_fchannel;
6c18ba9f AB	163	struct nfsd4_channel_attrs se_bchannel;
557ce264	164	struct nfsd4_slot se_slots[]; / forward channel slots */
7116ed6b AA	165	};
	166
	167	static inline void
	168	nfsd4_put_session(struct nfsd4_session *ses)
	169	{
	170	extern void free_session(struct kref *kref);
	171	kref_put(&ses->se_ref, free_session);
	172	}
	173
	174	static inline void
	175	nfsd4_get_session(struct nfsd4_session *ses)
	176	{
	177	kref_get(&ses->se_ref);
	178	}
	179
5282fd72 ME	180	/* formatted contents of nfs4_sessionid */
	181	struct nfsd4_sessionid {
	182	clientid_t clientid;
	183	u32 sequence;
	184	u32 reserved;
	185	};
	186
a55370a3 N	187	#define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
a55370a3 N	188
1da177e4 LT	189	/*
	190	* struct nfs4_client - one per client. Clientids live here.
	191	* o Each nfs4_client is hashed by clientid.
	192	*
	193	* o Each nfs4_clients is also hashed by name
	194	* (the opaque quantity initially sent by the client to identify itself).
	195	*
	196	* o cl_perclient list is used to ensure no dangling stateowner references
	197	* when we expire the nfs4_client
	198	*/
	199	struct nfs4_client {
	200	struct list_head cl_idhash; /* hash by cl_clientid.id */
	201	struct list_head cl_strhash; /* hash by cl_name */
ea1da636 N	202	struct list_head cl_openowners;
ea1da636 N	203	struct list_head cl_delegations;
1da177e4 LT	204	struct list_head cl_lru; /* tail queue */
1da177e4 LT	205	struct xdr_netobj cl_name; /* id generated by client */
a55370a3	206	char cl_recdir[HEXDIR_LEN]; /* recovery dir */
1da177e4 LT	207	nfs4_verifier cl_verifier; /* generated by client */
1da177e4 LT	208	time_t cl_time; /* time of last lease renewal */
363168b4	209	struct sockaddr_storage cl_addr; /* client ipaddress */
61054b14	210	u32 cl_flavor; /* setclientid pseudoflavor */
68e76ad0	211	char cl_principal; / setclientid principal name */
1da177e4 LT	212	struct svc_cred cl_cred; /* setclientid principal */
	213	clientid_t cl_clientid; /* generated by server */
	214	nfs4_verifier cl_confirm; /* generated by server */
c237dc03	215	struct nfs4_cb_conn cl_cb_conn; /* callback info */
1da177e4	216	atomic_t cl_count; /* ref count */
c7b9a459	217	u32 cl_firststate; /* recovery dir creation */
9fb87070 ME	218
	219	/* for nfs41 */
	220	struct list_head cl_sessions;
49557cc7	221	struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
0733d213	222	u32 cl_exchange_flags;
ec6b5d7b	223	struct nfs4_sessionid cl_sessionid;
38524ab3 AA	224
38524ab3 AA	225	/* for nfs41 callbacks */
199ff35e RL	226	/* We currently support a single back channel with a single slot */
199ff35e RL	227	unsigned long cl_cb_slot_busy;
2a1d1b59	228	u32 cl_cb_seq_nr;
38524ab3	229	struct svc_xprt cl_cb_xprt; / 4.1 callback transport */
199ff35e RL	230	struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
199ff35e RL	231	/* wait here for slots */
1da177e4 LT	232	};
	233
	234	/* struct nfs4_client_reset
	235	* one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
	236	* upon lease reset, or from upcall to state_daemon (to read in state
	237	* from non-volitile storage) upon reboot.
	238	*/
	239	struct nfs4_client_reclaim {
	240	struct list_head cr_strhash; /* hash by cr_name */
a55370a3	241	char cr_recdir[HEXDIR_LEN]; /* recover dir */
1da177e4 LT	242	};
	243
	244	static inline void
	245	update_stateid(stateid_t *stateid)
	246	{
	247	stateid->si_generation++;
	248	}
	249
	250	/* A reasonable value for REPLAY_ISIZE was estimated as follows:
	251	* The OPEN response, typically the largest, requires
	252	* 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
	253	* 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
	254	* 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
	255	*/
	256
	257	#define NFSD4_REPLAY_ISIZE 112
	258
	259	/*
	260	* Replay buffer, where the result of the last seqid-mutating operation
	261	* is cached.
	262	*/
	263	struct nfs4_replay {
b37ad28b	264	__be32 rp_status;
1da177e4 LT	265	unsigned int rp_buflen;
	266	char *rp_buf;
	267	unsigned intrp_allocated;
a4773c08	268	struct knfsd_fh rp_openfh;
1da177e4 LT	269	char rp_ibuf[NFSD4_REPLAY_ISIZE];
	270	};
	271
	272	/*
	273	* nfs4_stateowner can either be an open_owner, or a lock_owner
	274	*
	275	* so_idhash: stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
	276	* for lock_owner
	277	* so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
	278	* for lock_owner
	279	* so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
	280	* struct is reaped.
	281	* so_perfilestate: heads the list of nfs4_stateid (either open or lock)
	282	* and is used to ensure no dangling nfs4_stateid references when we
	283	* release a stateowner.
	284	* so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
	285	* close is called to reap associated byte-range locks
	286	* so_close_lru: (open) stateowner is placed on this list instead of being
	287	* reaped (when so_perfilestate is empty) to hold the last close replay.
	288	* reaped by laundramat thread after lease period.
	289	*/
	290	struct nfs4_stateowner {
	291	struct kref so_ref;
	292	struct list_head so_idhash; /* hash by so_id */
	293	struct list_head so_strhash; /* hash by op_name */
ea1da636 N	294	struct list_head so_perclient;
	295	struct list_head so_stateids;
	296	struct list_head so_perstateid; /* for lockowners only */
1da177e4 LT	297	struct list_head so_close_lru; /* tail queue */
	298	time_t so_time; /* time of placement on so_close_lru */
	299	int so_is_open_owner; /* 1=openowner,0=lockowner */
	300	u32 so_id;
	301	struct nfs4_client * so_client;
7fb64cee N	302	/* after increment in ENCODE_SEQID_OP_TAIL, represents the next
	303	* sequence id expected from the client: */
	304	u32 so_seqid;
1da177e4 LT	305	struct xdr_netobj so_owner; /* open owner name */
	306	int so_confirmed; /* successful OPEN_CONFIRM? */
	307	struct nfs4_replay so_replay;
	308	};
	309
	310	/*
	311	* nfs4_file: a file opened by some number of (open) nfs4_stateowners.
	312	* o fi_perfile list is used to search for conflicting
	313	* share_acces, share_deny on the file.
	314	*/
	315	struct nfs4_file {
8b671b80	316	atomic_t fi_ref;
1da177e4	317	struct list_head fi_hash; /* hash by "struct inode " /
8beefa24 N	318	struct list_head fi_stateids;
8beefa24 N	319	struct list_head fi_delegations;
1da177e4 LT	320	struct inode *fi_inode;
	321	u32 fi_id; /* used with stateowner->so_id
	322	* for stateid_hashtbl hash */
47f9940c	323	bool fi_had_conflict;
1da177e4 LT	324	};
	325
	326	/*
	327	* nfs4_stateid can either be an open stateid or (eventually) a lock stateid
	328	*
	329	* (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
	330	*
	331	* st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
	332	* st_perfile: file_hashtbl[] entry.
	333	* st_perfile_state: nfs4_stateowner->so_perfilestate
	334	* st_perlockowner: (open stateid) list of lock nfs4_stateowners
	335	* st_access_bmap: used only for open stateid
	336	* st_deny_bmap: used only for open stateid
4c4cd222 N	337	* st_openstp: open stateid lock stateid was derived from
	338	*
	339	* XXX: open stateids and lock stateids have diverged sufficiently that
	340	* we should consider defining separate structs for the two cases.
1da177e4 LT	341	*/
	342
	343	struct nfs4_stateid {
	344	struct list_head st_hash;
	345	struct list_head st_perfile;
ea1da636 N	346	struct list_head st_perstateowner;
ea1da636 N	347	struct list_head st_lockowners;
1da177e4 LT	348	struct nfs4_stateowner * st_stateowner;
	349	struct nfs4_file * st_file;
	350	stateid_t st_stateid;
	351	struct file * st_vfs_file;
	352	unsigned long st_access_bmap;
	353	unsigned long st_deny_bmap;
4c4cd222	354	struct nfs4_stateid * st_openstp;
1da177e4 LT	355	};
	356
	357	/* flags for preprocess_seqid_op() */
6668958f	358	#define HAS_SESSION 0x00000001
1da177e4 LT	359	#define CONFIRM 0x00000002
	360	#define OPEN_STATE 0x00000004
	361	#define LOCK_STATE 0x00000008
	362	#define RD_STATE 0x00000010
	363	#define WR_STATE 0x00000020
	364	#define CLOSE_STATE 0x00000040
1da177e4 LT	365
	366	#define seqid_mutating_err(err) \
	367	(((err) != nfserr_stale_clientid) && \
	368	((err) != nfserr_bad_seqid) && \
	369	((err) != nfserr_stale_stateid) && \
	370	((err) != nfserr_bad_stateid))
	371
dd453dfd BH	372	struct nfsd4_compound_state;
	373
	374	extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
1da177e4	375	stateid_t stateid, int flags, struct file *filp);
1da177e4 LT	376	extern void nfs4_lock_state(void);
	377	extern void nfs4_unlock_state(void);
	378	extern int nfs4_in_grace(void);
b37ad28b	379	extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
1da177e4 LT	380	extern void put_nfs4_client(struct nfs4_client *clp);
1da177e4 LT	381	extern void nfs4_free_stateowner(struct kref *kref);
80fc015b	382	extern int set_callback_cred(void);
1da177e4 LT	383	extern void nfsd4_probe_callback(struct nfs4_client *clp);
	384	extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
	385	extern void nfs4_put_delegation(struct nfs4_delegation *dp);
b37ad28b	386	extern __be32 nfs4_make_rec_clidname(char clidname, struct xdr_netobj clname);
190e4fbf N	387	extern void nfsd4_init_recdir(char *recdir_name);
	388	extern int nfsd4_recdir_load(void);
	389	extern void nfsd4_shutdown_recdir(void);
	390	extern int nfs4_client_to_reclaim(const char *name);
a1bcecd2	391	extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
c7b9a459 N	392	extern void nfsd4_recdir_purge_old(void);
	393	extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
	394	extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
1da177e4 LT	395
	396	static inline void
	397	nfs4_put_stateowner(struct nfs4_stateowner *so)
	398	{
	399	kref_put(&so->so_ref, nfs4_free_stateowner);
	400	}
	401
	402	static inline void
	403	nfs4_get_stateowner(struct nfs4_stateowner *so)
	404	{
	405	kref_get(&so->so_ref);
	406	}
	407
	408	#endif /* NFSD4_STATE_H */