[net-next-2.6.git] / include / linux / nfsd / state.h

/*
 *  linux/include/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/list.h>
#include <linux/kref.h>
#include <linux/sunrpc/clnt.h>

#define NFS4_OPAQUE_LIMIT 1024
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


struct nfs4_cb_recall {
	u32			cbr_ident;
	int			cbr_trunc;
	stateid_t		cbr_stateid;
	struct knfsd_fh		cbr_fh;
	struct nfs4_delegation	*cbr_dp;
};

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;
	struct nfs4_cb_recall	dl_recall;
};

#define dl_stateid      dl_recall.cbr_stateid
#define dl_fh           dl_recall.cbr_fh

/* client delegation callback info */
struct nfs4_callback {
	/* SETCLIENTID info */
	u32                     cb_addr;
	unsigned short          cb_port;
	u32                     cb_prog;
	u32                     cb_ident;
	/* RPC client info */
	atomic_t		cb_set;     /* successful CB_NULL call */
	struct rpc_clnt *       cb_client;
};

/* Maximum number of slots per session. 128 is useful for long haul TCP */
#define NFSD_MAX_SLOTS_PER_SESSION	128
/* Maximum number of pages per slot cache entry */
#define NFSD_PAGES_PER_SLOT	1
/* Maximum number of operations per session compound */
#define NFSD_MAX_OPS_PER_COMPOUND	16

struct nfsd4_cache_entry {
	__be32		ce_status;
	struct kvec	ce_datav; /* encoded NFSv4.1 data in rq_res.head[0] */
	struct page	*ce_respages[NFSD_PAGES_PER_SLOT + 1];
	int		ce_cachethis;
	short		ce_resused;
	int		ce_opcnt;
	int		ce_rpchdrlen;
};

struct nfsd4_slot {
	bool				sl_inuse;
	u32				sl_seqid;
	struct nfsd4_cache_entry	sl_cache_entry;
};

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;
	u32			se_fmaxreq_sz;
	u32			se_fmaxresp_sz;
	u32			se_fmaxresp_cached;
	u32			se_fmaxops;
	u32			se_fnumslots;
	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 */
	__be32			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_callback	cl_callback;    /* callback info */
	atomic_t		cl_count;	/* ref count */
	u32			cl_firststate;	/* recovery dir creation */

	/* for nfs41 */
	struct list_head	cl_sessions;
	struct nfsd4_slot	cl_slot;	/* create_session slot */
	u32			cl_exchange_flags;
	struct nfs4_sessionid	cl_sessionid;
};

/* 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 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))

extern __be32 nfs4_preprocess_stateid_op(struct svc_fh *current_fh,
		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 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 LT	1	/*
	2	* linux/include/nfsd/state.h
	3	*
	4	* Copyright (c) 2001 The Regents of the University of Michigan.
	5	* All rights reserved.
	6	*
	7	* Kendrick Smith <kmsmith@umich.edu>
	8	* Andy Adamson <andros@umich.edu>
	9	*
	10	* Redistribution and use in source and binary forms, with or without
	11	* modification, are permitted provided that the following conditions
	12	* are met:
	13	*
	14	* 1. Redistributions of source code must retain the above copyright
	15	* notice, this list of conditions and the following disclaimer.
	16	* 2. Redistributions in binary form must reproduce the above copyright
	17	* notice, this list of conditions and the following disclaimer in the
	18	* documentation and/or other materials provided with the distribution.
	19	* 3. Neither the name of the University nor the names of its
	20	* contributors may be used to endorse or promote products derived
	21	* from this software without specific prior written permission.
	22	*
	23	* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
	24	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
	25	* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	26	* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	27	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	28	* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	29	* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
	30	* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
	31	* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
	32	* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
	33	* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	34	*
	35	*/
	36
	37	#ifndef _NFSD4_STATE_H
	38	#define _NFSD4_STATE_H
	39
	40	#include <linux/list.h>
	41	#include <linux/kref.h>
	42	#include <linux/sunrpc/clnt.h>
	43
	44	#define NFS4_OPAQUE_LIMIT 1024
	45	typedef struct {
	46	u32 cl_boot;
	47	u32 cl_id;
	48	} clientid_t;
	49
	50	typedef struct {
	51	u32 so_boot;
	52	u32 so_stateownerid;
	53	u32 so_fileid;
	54	} stateid_opaque_t;
	55
	56	typedef struct {
	57	u32 si_generation;
	58	stateid_opaque_t si_opaque;
	59	} stateid_t;
	60	#define si_boot si_opaque.so_boot
	61	#define si_stateownerid si_opaque.so_stateownerid
	62	#define si_fileid si_opaque.so_fileid
	63
1da177e4 LT	64
	65	struct nfs4_cb_recall {
	66	u32 cbr_ident;
	67	int cbr_trunc;
	68	stateid_t cbr_stateid;
6c02eaa1	69	struct knfsd_fh cbr_fh;
1da177e4 LT	70	struct nfs4_delegation *cbr_dp;
	71	};
	72
	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;
	84	struct nfs4_cb_recall dl_recall;
	85	};
	86
	87	#define dl_stateid dl_recall.cbr_stateid
6c02eaa1	88	#define dl_fh dl_recall.cbr_fh
1da177e4 LT	89
	90	/* client delegation callback info */
	91	struct nfs4_callback {
	92	/* SETCLIENTID info */
1da177e4 LT	93	u32 cb_addr;
	94	unsigned short cb_port;
	95	u32 cb_prog;
	96	u32 cb_ident;
	97	/* RPC client info */
	98	atomic_t cb_set; /* successful CB_NULL call */
1da177e4 LT	99	struct rpc_clnt * cb_client;
	100	};
	101
ec6b5d7b AA	102	/* Maximum number of slots per session. 128 is useful for long haul TCP */
ec6b5d7b AA	103	#define NFSD_MAX_SLOTS_PER_SESSION 128
074fe897 AA	104	/* Maximum number of pages per slot cache entry */
074fe897 AA	105	#define NFSD_PAGES_PER_SLOT 1
ec6b5d7b AA	106	/* Maximum number of operations per session compound */
ec6b5d7b AA	107	#define NFSD_MAX_OPS_PER_COMPOUND 16
074fe897 AA	108
	109	struct nfsd4_cache_entry {
	110	__be32 ce_status;
	111	struct kvec ce_datav; /* encoded NFSv4.1 data in rq_res.head[0] */
	112	struct page *ce_respages[NFSD_PAGES_PER_SLOT + 1];
bf864a31	113	int ce_cachethis;
074fe897 AA	114	short ce_resused;
	115	int ce_opcnt;
	116	int ce_rpchdrlen;
	117	};
	118
7116ed6b AA	119	struct nfsd4_slot {
	120	bool sl_inuse;
	121	u32 sl_seqid;
074fe897	122	struct nfsd4_cache_entry sl_cache_entry;
7116ed6b AA	123	};
	124
	125	struct nfsd4_session {
	126	struct kref se_ref;
	127	struct list_head se_hash; /* hash by sessionid */
	128	struct list_head se_perclnt;
	129	u32 se_flags;
	130	struct nfs4_client se_client; / for expire_client */
	131	struct nfs4_sessionid se_sessionid;
	132	u32 se_fmaxreq_sz;
	133	u32 se_fmaxresp_sz;
	134	u32 se_fmaxresp_cached;
	135	u32 se_fmaxops;
	136	u32 se_fnumslots;
ec6b5d7b	137	struct nfsd4_slot se_slots[]; /* forward channel slots */
7116ed6b AA	138	};
	139
	140	static inline void
	141	nfsd4_put_session(struct nfsd4_session *ses)
	142	{
	143	extern void free_session(struct kref *kref);
	144	kref_put(&ses->se_ref, free_session);
	145	}
	146
	147	static inline void
	148	nfsd4_get_session(struct nfsd4_session *ses)
	149	{
	150	kref_get(&ses->se_ref);
	151	}
	152
5282fd72 ME	153	/* formatted contents of nfs4_sessionid */
	154	struct nfsd4_sessionid {
	155	clientid_t clientid;
	156	u32 sequence;
	157	u32 reserved;
	158	};
	159
a55370a3 N	160	#define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
a55370a3 N	161
1da177e4 LT	162	/*
	163	* struct nfs4_client - one per client. Clientids live here.
	164	* o Each nfs4_client is hashed by clientid.
	165	*
	166	* o Each nfs4_clients is also hashed by name
	167	* (the opaque quantity initially sent by the client to identify itself).
	168	*
	169	* o cl_perclient list is used to ensure no dangling stateowner references
	170	* when we expire the nfs4_client
	171	*/
	172	struct nfs4_client {
	173	struct list_head cl_idhash; /* hash by cl_clientid.id */
	174	struct list_head cl_strhash; /* hash by cl_name */
ea1da636 N	175	struct list_head cl_openowners;
ea1da636 N	176	struct list_head cl_delegations;
1da177e4 LT	177	struct list_head cl_lru; /* tail queue */
1da177e4 LT	178	struct xdr_netobj cl_name; /* id generated by client */
a55370a3	179	char cl_recdir[HEXDIR_LEN]; /* recovery dir */
1da177e4 LT	180	nfs4_verifier cl_verifier; /* generated by client */
1da177e4 LT	181	time_t cl_time; /* time of last lease renewal */
c7afef1f	182	__be32 cl_addr; /* client ipaddress */
61054b14	183	u32 cl_flavor; /* setclientid pseudoflavor */
68e76ad0	184	char cl_principal; / setclientid principal name */
1da177e4 LT	185	struct svc_cred cl_cred; /* setclientid principal */
	186	clientid_t cl_clientid; /* generated by server */
	187	nfs4_verifier cl_confirm; /* generated by server */
	188	struct nfs4_callback cl_callback; /* callback info */
	189	atomic_t cl_count; /* ref count */
c7b9a459	190	u32 cl_firststate; /* recovery dir creation */
9fb87070 ME	191
	192	/* for nfs41 */
	193	struct list_head cl_sessions;
38eb76a5	194	struct nfsd4_slot cl_slot; /* create_session slot */
0733d213	195	u32 cl_exchange_flags;
ec6b5d7b	196	struct nfs4_sessionid cl_sessionid;
1da177e4 LT	197	};
	198
	199	/* struct nfs4_client_reset
	200	* one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
	201	* upon lease reset, or from upcall to state_daemon (to read in state
	202	* from non-volitile storage) upon reboot.
	203	*/
	204	struct nfs4_client_reclaim {
	205	struct list_head cr_strhash; /* hash by cr_name */
a55370a3	206	char cr_recdir[HEXDIR_LEN]; /* recover dir */
1da177e4 LT	207	};
	208
	209	static inline void
	210	update_stateid(stateid_t *stateid)
	211	{
	212	stateid->si_generation++;
	213	}
	214
	215	/* A reasonable value for REPLAY_ISIZE was estimated as follows:
	216	* The OPEN response, typically the largest, requires
	217	* 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
	218	* 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
	219	* 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
	220	*/
	221
	222	#define NFSD4_REPLAY_ISIZE 112
	223
	224	/*
	225	* Replay buffer, where the result of the last seqid-mutating operation
	226	* is cached.
	227	*/
	228	struct nfs4_replay {
b37ad28b	229	__be32 rp_status;
1da177e4 LT	230	unsigned int rp_buflen;
	231	char *rp_buf;
	232	unsigned intrp_allocated;
a4773c08	233	struct knfsd_fh rp_openfh;
1da177e4 LT	234	char rp_ibuf[NFSD4_REPLAY_ISIZE];
	235	};
	236
	237	/*
	238	* nfs4_stateowner can either be an open_owner, or a lock_owner
	239	*
	240	* so_idhash: stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
	241	* for lock_owner
	242	* so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
	243	* for lock_owner
	244	* so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
	245	* struct is reaped.
	246	* so_perfilestate: heads the list of nfs4_stateid (either open or lock)
	247	* and is used to ensure no dangling nfs4_stateid references when we
	248	* release a stateowner.
	249	* so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
	250	* close is called to reap associated byte-range locks
	251	* so_close_lru: (open) stateowner is placed on this list instead of being
	252	* reaped (when so_perfilestate is empty) to hold the last close replay.
	253	* reaped by laundramat thread after lease period.
	254	*/
	255	struct nfs4_stateowner {
	256	struct kref so_ref;
	257	struct list_head so_idhash; /* hash by so_id */
	258	struct list_head so_strhash; /* hash by op_name */
ea1da636 N	259	struct list_head so_perclient;
	260	struct list_head so_stateids;
	261	struct list_head so_perstateid; /* for lockowners only */
1da177e4 LT	262	struct list_head so_close_lru; /* tail queue */
	263	time_t so_time; /* time of placement on so_close_lru */
	264	int so_is_open_owner; /* 1=openowner,0=lockowner */
	265	u32 so_id;
	266	struct nfs4_client * so_client;
7fb64cee N	267	/* after increment in ENCODE_SEQID_OP_TAIL, represents the next
	268	* sequence id expected from the client: */
	269	u32 so_seqid;
1da177e4 LT	270	struct xdr_netobj so_owner; /* open owner name */
	271	int so_confirmed; /* successful OPEN_CONFIRM? */
	272	struct nfs4_replay so_replay;
	273	};
	274
	275	/*
	276	* nfs4_file: a file opened by some number of (open) nfs4_stateowners.
	277	* o fi_perfile list is used to search for conflicting
	278	* share_acces, share_deny on the file.
	279	*/
	280	struct nfs4_file {
8b671b80	281	atomic_t fi_ref;
1da177e4	282	struct list_head fi_hash; /* hash by "struct inode " /
8beefa24 N	283	struct list_head fi_stateids;
8beefa24 N	284	struct list_head fi_delegations;
1da177e4 LT	285	struct inode *fi_inode;
	286	u32 fi_id; /* used with stateowner->so_id
	287	* for stateid_hashtbl hash */
47f9940c	288	bool fi_had_conflict;
1da177e4 LT	289	};
	290
	291	/*
	292	* nfs4_stateid can either be an open stateid or (eventually) a lock stateid
	293	*
	294	* (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
	295	*
	296	* st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
	297	* st_perfile: file_hashtbl[] entry.
	298	* st_perfile_state: nfs4_stateowner->so_perfilestate
	299	* st_perlockowner: (open stateid) list of lock nfs4_stateowners
	300	* st_access_bmap: used only for open stateid
	301	* st_deny_bmap: used only for open stateid
4c4cd222 N	302	* st_openstp: open stateid lock stateid was derived from
	303	*
	304	* XXX: open stateids and lock stateids have diverged sufficiently that
	305	* we should consider defining separate structs for the two cases.
1da177e4 LT	306	*/
	307
	308	struct nfs4_stateid {
	309	struct list_head st_hash;
	310	struct list_head st_perfile;
ea1da636 N	311	struct list_head st_perstateowner;
ea1da636 N	312	struct list_head st_lockowners;
1da177e4 LT	313	struct nfs4_stateowner * st_stateowner;
	314	struct nfs4_file * st_file;
	315	stateid_t st_stateid;
	316	struct file * st_vfs_file;
	317	unsigned long st_access_bmap;
	318	unsigned long st_deny_bmap;
4c4cd222	319	struct nfs4_stateid * st_openstp;
1da177e4 LT	320	};
	321
	322	/* flags for preprocess_seqid_op() */
1da177e4 LT	323	#define CONFIRM 0x00000002
	324	#define OPEN_STATE 0x00000004
	325	#define LOCK_STATE 0x00000008
	326	#define RD_STATE 0x00000010
	327	#define WR_STATE 0x00000020
	328	#define CLOSE_STATE 0x00000040
1da177e4 LT	329
	330	#define seqid_mutating_err(err) \
	331	(((err) != nfserr_stale_clientid) && \
	332	((err) != nfserr_bad_seqid) && \
	333	((err) != nfserr_stale_stateid) && \
	334	((err) != nfserr_bad_stateid))
	335
b37ad28b	336	extern __be32 nfs4_preprocess_stateid_op(struct svc_fh *current_fh,
1da177e4	337	stateid_t stateid, int flags, struct file *filp);
1da177e4 LT	338	extern void nfs4_lock_state(void);
	339	extern void nfs4_unlock_state(void);
	340	extern int nfs4_in_grace(void);
b37ad28b	341	extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
1da177e4 LT	342	extern void put_nfs4_client(struct nfs4_client *clp);
	343	extern void nfs4_free_stateowner(struct kref *kref);
	344	extern void nfsd4_probe_callback(struct nfs4_client *clp);
	345	extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
	346	extern void nfs4_put_delegation(struct nfs4_delegation *dp);
b37ad28b	347	extern __be32 nfs4_make_rec_clidname(char clidname, struct xdr_netobj clname);
190e4fbf N	348	extern void nfsd4_init_recdir(char *recdir_name);
	349	extern int nfsd4_recdir_load(void);
	350	extern void nfsd4_shutdown_recdir(void);
	351	extern int nfs4_client_to_reclaim(const char *name);
a1bcecd2	352	extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
c7b9a459 N	353	extern void nfsd4_recdir_purge_old(void);
	354	extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
	355	extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
1da177e4 LT	356
	357	static inline void
	358	nfs4_put_stateowner(struct nfs4_stateowner *so)
	359	{
	360	kref_put(&so->so_ref, nfs4_free_stateowner);
	361	}
	362
	363	static inline void
	364	nfs4_get_stateowner(struct nfs4_stateowner *so)
	365	{
	366	kref_get(&so->so_ref);
	367	}
	368
	369	#endif /* NFSD4_STATE_H */