Linux Audio

Check our new training course

Loading...
v3.15
  1/*
  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
 38#include <linux/idr.h>
 
 39#include <linux/sunrpc/svc_xprt.h>
 40#include <linux/nfsd/nfsfh.h>
 41#include "nfsfh.h"
 42
 43typedef struct {
 44	u32             cl_boot;
 45	u32             cl_id;
 46} clientid_t;
 47
 48typedef struct {
 49	clientid_t	so_clid;
 50	u32		so_id;
 51} stateid_opaque_t;
 52
 53typedef struct {
 54	u32                     si_generation;
 55	stateid_opaque_t        si_opaque;
 56} stateid_t;
 57
 58#define STATEID_FMT	"(%08x/%08x/%08x/%08x)"
 59#define STATEID_VAL(s) \
 60	(s)->si_opaque.so_clid.cl_boot, \
 61	(s)->si_opaque.so_clid.cl_id, \
 62	(s)->si_opaque.so_id, \
 63	(s)->si_generation
 64
 65struct nfsd4_callback {
 66	void *cb_op;
 67	struct nfs4_client *cb_clp;
 68	struct list_head cb_per_client;
 69	u32 cb_minorversion;
 70	struct rpc_message cb_msg;
 71	const struct rpc_call_ops *cb_ops;
 72	struct work_struct cb_work;
 73	bool cb_done;
 
 
 74};
 75
 
 
 
 
 
 
 
 
 
 
 
 76struct nfs4_stid {
 
 77#define NFS4_OPEN_STID 1
 78#define NFS4_LOCK_STID 2
 79#define NFS4_DELEG_STID 4
 80/* For an open stateid kept around *only* to process close replays: */
 81#define NFS4_CLOSED_STID 8
 82/* For a deleg stateid kept around only to process free_stateid's: */
 83#define NFS4_REVOKED_DELEG_STID 16
 84	unsigned char sc_type;
 85	stateid_t sc_stateid;
 86	struct nfs4_client *sc_client;
 
 
 
 
 
 87};
 88
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 89struct nfs4_delegation {
 90	struct nfs4_stid	dl_stid; /* must be first field */
 91	struct list_head	dl_perfile;
 92	struct list_head	dl_perclnt;
 93	struct list_head	dl_recall_lru;  /* delegation recalled */
 94	atomic_t		dl_count;       /* ref count */
 95	struct nfs4_file	*dl_file;
 96	u32			dl_type;
 97	time_t			dl_time;
 98/* For recall: */
 99	struct knfsd_fh		dl_fh;
100	int			dl_retries;
101	struct nfsd4_callback	dl_recall;
102};
103
 
 
 
104/* client delegation callback info */
105struct nfs4_cb_conn {
106	/* SETCLIENTID info */
107	struct sockaddr_storage	cb_addr;
108	struct sockaddr_storage	cb_saddr;
109	size_t			cb_addrlen;
110	u32                     cb_prog; /* used only in 4.0 case;
111					    per-session otherwise */
112	u32                     cb_ident;	/* minorversion 0 only */
113	struct svc_xprt		*cb_xprt;	/* minorversion 1 only */
114};
115
116static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
117{
118	return container_of(s, struct nfs4_delegation, dl_stid);
119}
120
121/* Maximum number of slots per session. 160 is useful for long haul TCP */
122#define NFSD_MAX_SLOTS_PER_SESSION     160
123/* Maximum number of operations per session compound */
124#define NFSD_MAX_OPS_PER_COMPOUND	16
125/* Maximum  session per slot cache size */
126#define NFSD_SLOT_CACHE_SIZE		1024
127/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
128#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION	32
129#define NFSD_MAX_MEM_PER_SESSION  \
130		(NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
131
132struct nfsd4_slot {
133	u32	sl_seqid;
134	__be32	sl_status;
 
135	u32	sl_datalen;
136	u16	sl_opcnt;
137#define NFSD4_SLOT_INUSE	(1 << 0)
138#define NFSD4_SLOT_CACHETHIS	(1 << 1)
139#define NFSD4_SLOT_INITIALIZED	(1 << 2)
 
140	u8	sl_flags;
141	char	sl_data[];
142};
143
144struct nfsd4_channel_attrs {
145	u32		headerpadsz;
146	u32		maxreq_sz;
147	u32		maxresp_sz;
148	u32		maxresp_cached;
149	u32		maxops;
150	u32		maxreqs;
151	u32		nr_rdma_attrs;
152	u32		rdma_attrs;
153};
154
155struct nfsd4_cb_sec {
156	u32	flavor; /* (u32)(-1) used to mean "no valid flavor" */
157	kuid_t	uid;
158	kgid_t	gid;
159};
160
161struct nfsd4_create_session {
162	clientid_t			clientid;
163	struct nfs4_sessionid		sessionid;
164	u32				seqid;
165	u32				flags;
166	struct nfsd4_channel_attrs	fore_channel;
167	struct nfsd4_channel_attrs	back_channel;
168	u32				callback_prog;
169	struct nfsd4_cb_sec		cb_sec;
170};
171
172struct nfsd4_backchannel_ctl {
173	u32	bc_cb_program;
174	struct nfsd4_cb_sec		bc_cb_sec;
175};
176
177struct nfsd4_bind_conn_to_session {
178	struct nfs4_sessionid		sessionid;
179	u32				dir;
180};
181
182/* The single slot clientid cache structure */
183struct nfsd4_clid_slot {
184	u32				sl_seqid;
185	__be32				sl_status;
186	struct nfsd4_create_session	sl_cr_ses;
187};
188
189struct nfsd4_conn {
190	struct list_head cn_persession;
191	struct svc_xprt *cn_xprt;
192	struct svc_xpt_user cn_xpt_user;
193	struct nfsd4_session *cn_session;
194/* CDFC4_FORE, CDFC4_BACK: */
195	unsigned char cn_flags;
196};
197
 
 
 
 
 
198struct nfsd4_session {
199	atomic_t		se_ref;
200	struct list_head	se_hash;	/* hash by sessionid */
201	struct list_head	se_perclnt;
202/* See SESSION4_PERSIST, etc. for standard flags; this is internal-only: */
203#define NFS4_SESSION_DEAD	0x010
204	u32			se_flags;
205	struct nfs4_client	*se_client;
206	struct nfs4_sessionid	se_sessionid;
207	struct nfsd4_channel_attrs se_fchannel;
208	struct nfsd4_channel_attrs se_bchannel;
209	struct nfsd4_cb_sec	se_cb_sec;
210	struct list_head	se_conns;
211	u32			se_cb_prog;
212	u32			se_cb_seq_nr;
213	struct nfsd4_slot	*se_slots[];	/* forward channel slots */
214};
215
216extern void nfsd4_put_session(struct nfsd4_session *ses);
217
218/* formatted contents of nfs4_sessionid */
219struct nfsd4_sessionid {
220	clientid_t	clientid;
221	u32		sequence;
222	u32		reserved;
223};
224
225#define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
226
227/*
228 * struct nfs4_client - one per client.  Clientids live here.
229 * 	o Each nfs4_client is hashed by clientid.
230 *
231 * 	o Each nfs4_clients is also hashed by name 
232 * 	  (the opaque quantity initially sent by the client to identify itself).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
233 * 	  
234 *	o cl_perclient list is used to ensure no dangling stateowner references
235 *	  when we expire the nfs4_client
236 */
237struct nfs4_client {
238	struct list_head	cl_idhash; 	/* hash by cl_clientid.id */
239	struct rb_node		cl_namenode;	/* link into by-name trees */
 
240	struct list_head	cl_openowners;
241	struct idr		cl_stateids;	/* stateid lookup */
242	struct list_head	cl_delegations;
243	struct list_head	cl_revoked;	/* unacknowledged, revoked 4.1 state */
244	struct list_head        cl_lru;         /* tail queue */
 
 
 
245	struct xdr_netobj	cl_name; 	/* id generated by client */
246	nfs4_verifier		cl_verifier; 	/* generated by client */
247	time_t                  cl_time;        /* time of last lease renewal */
248	struct sockaddr_storage	cl_addr; 	/* client ipaddress */
249	bool			cl_mach_cred;	/* SP4_MACH_CRED in force */
250	struct svc_cred		cl_cred; 	/* setclientid principal */
251	clientid_t		cl_clientid;	/* generated by server */
252	nfs4_verifier		cl_confirm;	/* generated by server */
253	u32			cl_minorversion;
254
255	/* for v4.0 and v4.1 callbacks: */
256	struct nfs4_cb_conn	cl_cb_conn;
257#define NFSD4_CLIENT_CB_UPDATE		(0)
258#define NFSD4_CLIENT_CB_KILL		(1)
259#define NFSD4_CLIENT_STABLE		(2)	/* client on stable storage */
260#define NFSD4_CLIENT_RECLAIM_COMPLETE	(3)	/* reclaim_complete done */
261#define NFSD4_CLIENT_CONFIRMED		(4)	/* client is confirmed */
 
262#define NFSD4_CLIENT_CB_FLAG_MASK	(1 << NFSD4_CLIENT_CB_UPDATE | \
263					 1 << NFSD4_CLIENT_CB_KILL)
264	unsigned long		cl_flags;
265	struct rpc_cred		*cl_cb_cred;
266	struct rpc_clnt		*cl_cb_client;
267	u32			cl_cb_ident;
268#define NFSD4_CB_UP		0
269#define NFSD4_CB_UNKNOWN	1
270#define NFSD4_CB_DOWN		2
271#define NFSD4_CB_FAULT		3
272	int			cl_cb_state;
273	struct nfsd4_callback	cl_cb_null;
274	struct nfsd4_session	*cl_cb_session;
275	struct list_head	cl_callbacks; /* list of in-progress callbacks */
276
277	/* for all client information that callback code might need: */
278	spinlock_t		cl_lock;
279
280	/* for nfs41 */
281	struct list_head	cl_sessions;
282	struct nfsd4_clid_slot	cl_cs_slot;	/* create_session slot */
283	u32			cl_exchange_flags;
284	/* number of rpc's in progress over an associated session: */
285	atomic_t		cl_refcount;
 
286
287	/* for nfs41 callbacks */
288	/* We currently support a single back channel with a single slot */
289	unsigned long		cl_cb_slot_busy;
290	struct rpc_wait_queue	cl_cb_waitq;	/* backchannel callers may */
291						/* wait here for slots */
292	struct net		*net;
293};
294
295/* struct nfs4_client_reset
296 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
297 * upon lease reset, or from upcall to state_daemon (to read in state
298 * from non-volitile storage) upon reboot.
299 */
300struct nfs4_client_reclaim {
301	struct list_head	cr_strhash;	/* hash by cr_name */
302	struct nfs4_client	*cr_clp;	/* pointer to associated clp */
303	char			cr_recdir[HEXDIR_LEN]; /* recover dir */
304};
305
306static inline void
307update_stateid(stateid_t *stateid)
308{
309	stateid->si_generation++;
310	/* Wraparound recommendation from 3530bis-13 9.1.3.2: */
311	if (stateid->si_generation == 0)
312		stateid->si_generation = 1;
313}
314
315/* A reasonable value for REPLAY_ISIZE was estimated as follows:  
316 * The OPEN response, typically the largest, requires 
317 *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) + 
318 *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) + 
319 *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes 
320 */
321
322#define NFSD4_REPLAY_ISIZE       112 
323
324/*
325 * Replay buffer, where the result of the last seqid-mutating operation 
326 * is cached. 
327 */
328struct nfs4_replay {
329	__be32			rp_status;
330	unsigned int		rp_buflen;
331	char			*rp_buf;
332	struct knfsd_fh		rp_openfh;
 
333	char			rp_ibuf[NFSD4_REPLAY_ISIZE];
334};
335
 
 
 
 
 
 
 
 
 
 
 
 
 
336struct nfs4_stateowner {
337	struct list_head        so_strhash;   /* hash by op_name */
338	struct list_head        so_stateids;
339	struct nfs4_client *    so_client;
340	/* after increment in ENCODE_SEQID_OP_TAIL, represents the next
 
341	 * sequence id expected from the client: */
342	u32                     so_seqid;
343	struct xdr_netobj       so_owner;     /* open owner name */
344	struct nfs4_replay	so_replay;
345	bool			so_is_open_owner;
 
346};
347
 
 
 
 
 
 
348struct nfs4_openowner {
349	struct nfs4_stateowner	oo_owner; /* must be first field */
350	struct list_head        oo_perclient;
351	/*
352	 * We keep around openowners a little while after last close,
353	 * which saves clients from having to confirm, and allows us to
354	 * handle close replays if they come soon enough.  The close_lru
355	 * is a list of such openowners, to be reaped by the laundromat
356	 * thread eventually if they remain unused:
357	 */
358	struct list_head	oo_close_lru;
359	struct nfs4_ol_stateid *oo_last_closed_stid;
360	time_t			oo_time; /* time of placement on so_close_lru */
361#define NFS4_OO_CONFIRMED   1
362#define NFS4_OO_NEW         4
363	unsigned char		oo_flags;
364};
365
 
 
 
 
 
366struct nfs4_lockowner {
367	struct nfs4_stateowner	lo_owner; /* must be first element */
368	struct list_head	lo_owner_ino_hash; /* hash by owner,file */
369	struct list_head        lo_perstateid;
370	struct list_head	lo_list; /* for temporary uses */
371};
372
373static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
374{
375	return container_of(so, struct nfs4_openowner, oo_owner);
376}
377
378static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
379{
380	return container_of(so, struct nfs4_lockowner, lo_owner);
381}
382
383/* nfs4_file: a file opened by some number of (open) nfs4_stateowners. */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
384struct nfs4_file {
385	atomic_t		fi_ref;
386	struct hlist_node       fi_hash;    /* hash by "struct inode *" */
 
387	struct list_head        fi_stateids;
388	struct list_head	fi_delegations;
 
 
 
 
389	/* One each for O_RDONLY, O_WRONLY, O_RDWR: */
390	struct file *		fi_fds[3];
391	/*
392	 * Each open or lock stateid contributes 0-4 to the counts
393	 * below depending on which bits are set in st_access_bitmap:
394	 *     1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
395	 *   + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
396	 *   + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
397	 */
398	atomic_t		fi_access[2];
 
399	struct file		*fi_deleg_file;
400	struct file_lock	*fi_lease;
401	atomic_t		fi_delegees;
402	struct inode		*fi_inode;
403	bool			fi_had_conflict;
 
 
 
 
404};
405
406/* XXX: for first cut may fall back on returning file that doesn't work
407 * at all? */
408static inline struct file *find_writeable_file(struct nfs4_file *f)
409{
410	if (f->fi_fds[O_WRONLY])
411		return f->fi_fds[O_WRONLY];
412	return f->fi_fds[O_RDWR];
413}
414
415static inline struct file *find_readable_file(struct nfs4_file *f)
416{
417	if (f->fi_fds[O_RDONLY])
418		return f->fi_fds[O_RDONLY];
419	return f->fi_fds[O_RDWR];
420}
 
 
 
 
 
 
 
 
 
 
 
421
422static inline struct file *find_any_file(struct nfs4_file *f)
423{
424	if (f->fi_fds[O_RDWR])
425		return f->fi_fds[O_RDWR];
426	else if (f->fi_fds[O_WRONLY])
427		return f->fi_fds[O_WRONLY];
428	else
429		return f->fi_fds[O_RDONLY];
430}
431
432/* "ol" stands for "Open or Lock".  Better suggestions welcome. */
433struct nfs4_ol_stateid {
434	struct nfs4_stid    st_stid; /* must be first field */
435	struct list_head              st_perfile;
436	struct list_head              st_perstateowner;
437	struct list_head              st_lockowners;
438	struct nfs4_stateowner      * st_stateowner;
439	struct nfs4_file            * st_file;
440	unsigned long                 st_access_bmap;
441	unsigned long                 st_deny_bmap;
442	struct nfs4_ol_stateid         * st_openstp;
 
443};
444
445static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
446{
447	return container_of(s, struct nfs4_ol_stateid, st_stid);
448}
449
450/* flags for preprocess_seqid_op() */
451#define RD_STATE	        0x00000010
452#define WR_STATE	        0x00000020
453
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
454struct nfsd4_compound_state;
455struct nfsd_net;
456
457extern __be32 nfs4_preprocess_stateid_op(struct net *net,
458		struct nfsd4_compound_state *cstate,
459		stateid_t *stateid, int flags, struct file **filp);
460extern void nfs4_lock_state(void);
461extern void nfs4_unlock_state(void);
 
 
 
 
 
 
462void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
463extern void nfs4_release_reclaim(struct nfsd_net *);
464extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(const char *recdir,
465							struct nfsd_net *nn);
466extern __be32 nfs4_check_open_reclaim(clientid_t *clid, bool sessions, struct nfsd_net *nn);
467extern void nfs4_free_openowner(struct nfs4_openowner *);
468extern void nfs4_free_lockowner(struct nfs4_lockowner *);
469extern int set_callback_cred(void);
470extern void nfsd4_init_callback(struct nfsd4_callback *);
471extern void nfsd4_probe_callback(struct nfs4_client *clp);
472extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
473extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
474extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
 
 
475extern int nfsd4_create_callback_queue(void);
476extern void nfsd4_destroy_callback_queue(void);
477extern void nfsd4_shutdown_callback(struct nfs4_client *);
478extern void nfs4_put_delegation(struct nfs4_delegation *dp);
479extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
480							struct nfsd_net *nn);
481extern bool nfs4_has_reclaimed_state(const char *name, struct nfsd_net *nn);
482extern void put_client_renew(struct nfs4_client *clp);
 
 
 
 
 
 
 
 
 
 
483
484/* nfs4recover operations */
485extern int nfsd4_client_tracking_init(struct net *net);
486extern void nfsd4_client_tracking_exit(struct net *net);
487extern void nfsd4_client_record_create(struct nfs4_client *clp);
488extern void nfsd4_client_record_remove(struct nfs4_client *clp);
489extern int nfsd4_client_record_check(struct nfs4_client *clp);
490extern void nfsd4_record_grace_done(struct nfsd_net *nn, time_t boot_time);
491
492/* nfs fault injection functions */
493#ifdef CONFIG_NFSD_FAULT_INJECTION
494int nfsd_fault_inject_init(void);
495void nfsd_fault_inject_cleanup(void);
496u64 nfsd_for_n_state(u64, u64 (*)(struct nfs4_client *, u64));
497struct nfs4_client *nfsd_find_client(struct sockaddr_storage *, size_t);
498
499u64 nfsd_forget_client(struct nfs4_client *, u64);
500u64 nfsd_forget_client_locks(struct nfs4_client*, u64);
501u64 nfsd_forget_client_openowners(struct nfs4_client *, u64);
502u64 nfsd_forget_client_delegations(struct nfs4_client *, u64);
503u64 nfsd_recall_client_delegations(struct nfs4_client *, u64);
504
505u64 nfsd_print_client(struct nfs4_client *, u64);
506u64 nfsd_print_client_locks(struct nfs4_client *, u64);
507u64 nfsd_print_client_openowners(struct nfs4_client *, u64);
508u64 nfsd_print_client_delegations(struct nfs4_client *, u64);
 
 
 
 
 
 
 
509#else /* CONFIG_NFSD_FAULT_INJECTION */
510static inline int nfsd_fault_inject_init(void) { return 0; }
511static inline void nfsd_fault_inject_cleanup(void) {}
512#endif /* CONFIG_NFSD_FAULT_INJECTION */
513
514#endif   /* NFSD4_STATE_H */
v4.17
  1/*
  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
 38#include <linux/idr.h>
 39#include <linux/refcount.h>
 40#include <linux/sunrpc/svc_xprt.h>
 
 41#include "nfsfh.h"
 42
 43typedef struct {
 44	u32             cl_boot;
 45	u32             cl_id;
 46} clientid_t;
 47
 48typedef struct {
 49	clientid_t	so_clid;
 50	u32		so_id;
 51} stateid_opaque_t;
 52
 53typedef struct {
 54	u32                     si_generation;
 55	stateid_opaque_t        si_opaque;
 56} stateid_t;
 57
 58#define STATEID_FMT	"(%08x/%08x/%08x/%08x)"
 59#define STATEID_VAL(s) \
 60	(s)->si_opaque.so_clid.cl_boot, \
 61	(s)->si_opaque.so_clid.cl_id, \
 62	(s)->si_opaque.so_id, \
 63	(s)->si_generation
 64
 65struct nfsd4_callback {
 
 66	struct nfs4_client *cb_clp;
 
 
 67	struct rpc_message cb_msg;
 68	const struct nfsd4_callback_ops *cb_ops;
 69	struct work_struct cb_work;
 70	int cb_seq_status;
 71	int cb_status;
 72	bool cb_need_restart;
 73};
 74
 75struct nfsd4_callback_ops {
 76	void (*prepare)(struct nfsd4_callback *);
 77	int (*done)(struct nfsd4_callback *, struct rpc_task *);
 78	void (*release)(struct nfsd4_callback *);
 79};
 80
 81/*
 82 * A core object that represents a "common" stateid. These are generally
 83 * embedded within the different (more specific) stateid objects and contain
 84 * fields that are of general use to any stateid.
 85 */
 86struct nfs4_stid {
 87	refcount_t		sc_count;
 88#define NFS4_OPEN_STID 1
 89#define NFS4_LOCK_STID 2
 90#define NFS4_DELEG_STID 4
 91/* For an open stateid kept around *only* to process close replays: */
 92#define NFS4_CLOSED_STID 8
 93/* For a deleg stateid kept around only to process free_stateid's: */
 94#define NFS4_REVOKED_DELEG_STID 16
 95#define NFS4_CLOSED_DELEG_STID 32
 96#define NFS4_LAYOUT_STID 64
 97	unsigned char		sc_type;
 98	stateid_t		sc_stateid;
 99	spinlock_t		sc_lock;
100	struct nfs4_client	*sc_client;
101	struct nfs4_file	*sc_file;
102	void			(*sc_free)(struct nfs4_stid *);
103};
104
105/*
106 * Represents a delegation stateid. The nfs4_client holds references to these
107 * and they are put when it is being destroyed or when the delegation is
108 * returned by the client:
109 *
110 * o 1 reference as long as a delegation is still in force (taken when it's
111 *   alloc'd, put when it's returned or revoked)
112 *
113 * o 1 reference as long as a recall rpc is in progress (taken when the lease
114 *   is broken, put when the rpc exits)
115 *
116 * o 1 more ephemeral reference for each nfsd thread currently doing something
117 *   with that delegation without holding the cl_lock
118 *
119 * If the server attempts to recall a delegation and the client doesn't do so
120 * before a timeout, the server may also revoke the delegation. In that case,
121 * the object will either be destroyed (v4.0) or moved to a per-client list of
122 * revoked delegations (v4.1+).
123 *
124 * This object is a superset of the nfs4_stid.
125 */
126struct nfs4_delegation {
127	struct nfs4_stid	dl_stid; /* must be first field */
128	struct list_head	dl_perfile;
129	struct list_head	dl_perclnt;
130	struct list_head	dl_recall_lru;  /* delegation recalled */
131	struct nfs4_clnt_odstate *dl_clnt_odstate;
 
132	u32			dl_type;
133	time_t			dl_time;
134/* For recall: */
 
135	int			dl_retries;
136	struct nfsd4_callback	dl_recall;
137};
138
139#define cb_to_delegation(cb) \
140	container_of(cb, struct nfs4_delegation, dl_recall)
141
142/* client delegation callback info */
143struct nfs4_cb_conn {
144	/* SETCLIENTID info */
145	struct sockaddr_storage	cb_addr;
146	struct sockaddr_storage	cb_saddr;
147	size_t			cb_addrlen;
148	u32                     cb_prog; /* used only in 4.0 case;
149					    per-session otherwise */
150	u32                     cb_ident;	/* minorversion 0 only */
151	struct svc_xprt		*cb_xprt;	/* minorversion 1 only */
152};
153
154static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
155{
156	return container_of(s, struct nfs4_delegation, dl_stid);
157}
158
159/* Maximum number of slots per session. 160 is useful for long haul TCP */
160#define NFSD_MAX_SLOTS_PER_SESSION     160
161/* Maximum number of operations per session compound */
162#define NFSD_MAX_OPS_PER_COMPOUND	16
163/* Maximum  session per slot cache size */
164#define NFSD_SLOT_CACHE_SIZE		2048
165/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
166#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION	32
167#define NFSD_MAX_MEM_PER_SESSION  \
168		(NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
169
170struct nfsd4_slot {
171	u32	sl_seqid;
172	__be32	sl_status;
173	struct svc_cred sl_cred;
174	u32	sl_datalen;
175	u16	sl_opcnt;
176#define NFSD4_SLOT_INUSE	(1 << 0)
177#define NFSD4_SLOT_CACHETHIS	(1 << 1)
178#define NFSD4_SLOT_INITIALIZED	(1 << 2)
179#define NFSD4_SLOT_CACHED	(1 << 3)
180	u8	sl_flags;
181	char	sl_data[];
182};
183
184struct nfsd4_channel_attrs {
185	u32		headerpadsz;
186	u32		maxreq_sz;
187	u32		maxresp_sz;
188	u32		maxresp_cached;
189	u32		maxops;
190	u32		maxreqs;
191	u32		nr_rdma_attrs;
192	u32		rdma_attrs;
193};
194
195struct nfsd4_cb_sec {
196	u32	flavor; /* (u32)(-1) used to mean "no valid flavor" */
197	kuid_t	uid;
198	kgid_t	gid;
199};
200
201struct nfsd4_create_session {
202	clientid_t			clientid;
203	struct nfs4_sessionid		sessionid;
204	u32				seqid;
205	u32				flags;
206	struct nfsd4_channel_attrs	fore_channel;
207	struct nfsd4_channel_attrs	back_channel;
208	u32				callback_prog;
209	struct nfsd4_cb_sec		cb_sec;
210};
211
212struct nfsd4_backchannel_ctl {
213	u32	bc_cb_program;
214	struct nfsd4_cb_sec		bc_cb_sec;
215};
216
217struct nfsd4_bind_conn_to_session {
218	struct nfs4_sessionid		sessionid;
219	u32				dir;
220};
221
222/* The single slot clientid cache structure */
223struct nfsd4_clid_slot {
224	u32				sl_seqid;
225	__be32				sl_status;
226	struct nfsd4_create_session	sl_cr_ses;
227};
228
229struct nfsd4_conn {
230	struct list_head cn_persession;
231	struct svc_xprt *cn_xprt;
232	struct svc_xpt_user cn_xpt_user;
233	struct nfsd4_session *cn_session;
234/* CDFC4_FORE, CDFC4_BACK: */
235	unsigned char cn_flags;
236};
237
238/*
239 * Representation of a v4.1+ session. These are refcounted in a similar fashion
240 * to the nfs4_client. References are only taken when the server is actively
241 * working on the object (primarily during the processing of compounds).
242 */
243struct nfsd4_session {
244	atomic_t		se_ref;
245	struct list_head	se_hash;	/* hash by sessionid */
246	struct list_head	se_perclnt;
247/* See SESSION4_PERSIST, etc. for standard flags; this is internal-only: */
248#define NFS4_SESSION_DEAD	0x010
249	u32			se_flags;
250	struct nfs4_client	*se_client;
251	struct nfs4_sessionid	se_sessionid;
252	struct nfsd4_channel_attrs se_fchannel;
253	struct nfsd4_channel_attrs se_bchannel;
254	struct nfsd4_cb_sec	se_cb_sec;
255	struct list_head	se_conns;
256	u32			se_cb_prog;
257	u32			se_cb_seq_nr;
258	struct nfsd4_slot	*se_slots[];	/* forward channel slots */
259};
260
 
 
261/* formatted contents of nfs4_sessionid */
262struct nfsd4_sessionid {
263	clientid_t	clientid;
264	u32		sequence;
265	u32		reserved;
266};
267
268#define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
269
270/*
271 * struct nfs4_client - one per client.  Clientids live here.
 
272 *
273 * The initial object created by an NFS client using SETCLIENTID (for NFSv4.0)
274 * or EXCHANGE_ID (for NFSv4.1+). These objects are refcounted and timestamped.
275 * Each nfsd_net_ns object contains a set of these and they are tracked via
276 * short and long form clientid. They are hashed and searched for under the
277 * per-nfsd_net client_lock spinlock.
278 *
279 * References to it are only held during the processing of compounds, and in
280 * certain other operations. In their "resting state" they have a refcount of
281 * 0. If they are not renewed within a lease period, they become eligible for
282 * destruction by the laundromat.
283 *
284 * These objects can also be destroyed prematurely by the fault injection code,
285 * or if the client sends certain forms of SETCLIENTID or EXCHANGE_ID updates.
286 * Care is taken *not* to do this however when the objects have an elevated
287 * refcount.
288 *
289 * o Each nfs4_client is hashed by clientid
290 *
291 * o Each nfs4_clients is also hashed by name (the opaque quantity initially
292 *   sent by the client to identify itself).
293 * 	  
294 * o cl_perclient list is used to ensure no dangling stateowner references
295 *   when we expire the nfs4_client
296 */
297struct nfs4_client {
298	struct list_head	cl_idhash; 	/* hash by cl_clientid.id */
299	struct rb_node		cl_namenode;	/* link into by-name trees */
300	struct list_head	*cl_ownerstr_hashtbl;
301	struct list_head	cl_openowners;
302	struct idr		cl_stateids;	/* stateid lookup */
303	struct list_head	cl_delegations;
304	struct list_head	cl_revoked;	/* unacknowledged, revoked 4.1 state */
305	struct list_head        cl_lru;         /* tail queue */
306#ifdef CONFIG_NFSD_PNFS
307	struct list_head	cl_lo_states;	/* outstanding layout states */
308#endif
309	struct xdr_netobj	cl_name; 	/* id generated by client */
310	nfs4_verifier		cl_verifier; 	/* generated by client */
311	time_t                  cl_time;        /* time of last lease renewal */
312	struct sockaddr_storage	cl_addr; 	/* client ipaddress */
313	bool			cl_mach_cred;	/* SP4_MACH_CRED in force */
314	struct svc_cred		cl_cred; 	/* setclientid principal */
315	clientid_t		cl_clientid;	/* generated by server */
316	nfs4_verifier		cl_confirm;	/* generated by server */
317	u32			cl_minorversion;
318
319	/* for v4.0 and v4.1 callbacks: */
320	struct nfs4_cb_conn	cl_cb_conn;
321#define NFSD4_CLIENT_CB_UPDATE		(0)
322#define NFSD4_CLIENT_CB_KILL		(1)
323#define NFSD4_CLIENT_STABLE		(2)	/* client on stable storage */
324#define NFSD4_CLIENT_RECLAIM_COMPLETE	(3)	/* reclaim_complete done */
325#define NFSD4_CLIENT_CONFIRMED		(4)	/* client is confirmed */
326#define NFSD4_CLIENT_UPCALL_LOCK	(5)	/* upcall serialization */
327#define NFSD4_CLIENT_CB_FLAG_MASK	(1 << NFSD4_CLIENT_CB_UPDATE | \
328					 1 << NFSD4_CLIENT_CB_KILL)
329	unsigned long		cl_flags;
330	struct rpc_cred		*cl_cb_cred;
331	struct rpc_clnt		*cl_cb_client;
332	u32			cl_cb_ident;
333#define NFSD4_CB_UP		0
334#define NFSD4_CB_UNKNOWN	1
335#define NFSD4_CB_DOWN		2
336#define NFSD4_CB_FAULT		3
337	int			cl_cb_state;
338	struct nfsd4_callback	cl_cb_null;
339	struct nfsd4_session	*cl_cb_session;
 
340
341	/* for all client information that callback code might need: */
342	spinlock_t		cl_lock;
343
344	/* for nfs41 */
345	struct list_head	cl_sessions;
346	struct nfsd4_clid_slot	cl_cs_slot;	/* create_session slot */
347	u32			cl_exchange_flags;
348	/* number of rpc's in progress over an associated session: */
349	atomic_t		cl_refcount;
350	struct nfs4_op_map      cl_spo_must_allow;
351
352	/* for nfs41 callbacks */
353	/* We currently support a single back channel with a single slot */
354	unsigned long		cl_cb_slot_busy;
355	struct rpc_wait_queue	cl_cb_waitq;	/* backchannel callers may */
356						/* wait here for slots */
357	struct net		*net;
358};
359
360/* struct nfs4_client_reset
361 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
362 * upon lease reset, or from upcall to state_daemon (to read in state
363 * from non-volitile storage) upon reboot.
364 */
365struct nfs4_client_reclaim {
366	struct list_head	cr_strhash;	/* hash by cr_name */
367	struct nfs4_client	*cr_clp;	/* pointer to associated clp */
368	char			cr_recdir[HEXDIR_LEN]; /* recover dir */
369};
370
 
 
 
 
 
 
 
 
 
371/* A reasonable value for REPLAY_ISIZE was estimated as follows:  
372 * The OPEN response, typically the largest, requires 
373 *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) + 
374 *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) + 
375 *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes 
376 */
377
378#define NFSD4_REPLAY_ISIZE       112 
379
380/*
381 * Replay buffer, where the result of the last seqid-mutating operation 
382 * is cached. 
383 */
384struct nfs4_replay {
385	__be32			rp_status;
386	unsigned int		rp_buflen;
387	char			*rp_buf;
388	struct knfsd_fh		rp_openfh;
389	struct mutex		rp_mutex;
390	char			rp_ibuf[NFSD4_REPLAY_ISIZE];
391};
392
393struct nfs4_stateowner;
394
395struct nfs4_stateowner_operations {
396	void (*so_unhash)(struct nfs4_stateowner *);
397	void (*so_free)(struct nfs4_stateowner *);
398};
399
400/*
401 * A core object that represents either an open or lock owner. The object and
402 * lock owner objects have one of these embedded within them. Refcounts and
403 * other fields common to both owner types are contained within these
404 * structures.
405 */
406struct nfs4_stateowner {
407	struct list_head			so_strhash;
408	struct list_head			so_stateids;
409	struct nfs4_client			*so_client;
410	const struct nfs4_stateowner_operations	*so_ops;
411	/* after increment in nfsd4_bump_seqid, represents the next
412	 * sequence id expected from the client: */
413	atomic_t				so_count;
414	u32					so_seqid;
415	struct xdr_netobj			so_owner; /* open owner name */
416	struct nfs4_replay			so_replay;
417	bool					so_is_open_owner;
418};
419
420/*
421 * When a file is opened, the client provides an open state owner opaque string
422 * that indicates the "owner" of that open. These objects are refcounted.
423 * References to it are held by each open state associated with it. This object
424 * is a superset of the nfs4_stateowner struct.
425 */
426struct nfs4_openowner {
427	struct nfs4_stateowner	oo_owner; /* must be first field */
428	struct list_head        oo_perclient;
429	/*
430	 * We keep around openowners a little while after last close,
431	 * which saves clients from having to confirm, and allows us to
432	 * handle close replays if they come soon enough.  The close_lru
433	 * is a list of such openowners, to be reaped by the laundromat
434	 * thread eventually if they remain unused:
435	 */
436	struct list_head	oo_close_lru;
437	struct nfs4_ol_stateid *oo_last_closed_stid;
438	time_t			oo_time; /* time of placement on so_close_lru */
439#define NFS4_OO_CONFIRMED   1
 
440	unsigned char		oo_flags;
441};
442
443/*
444 * Represents a generic "lockowner". Similar to an openowner. References to it
445 * are held by the lock stateids that are created on its behalf. This object is
446 * a superset of the nfs4_stateowner struct.
447 */
448struct nfs4_lockowner {
449	struct nfs4_stateowner	lo_owner;	/* must be first element */
450	struct list_head	lo_blocked;	/* blocked file_locks */
 
 
451};
452
453static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
454{
455	return container_of(so, struct nfs4_openowner, oo_owner);
456}
457
458static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
459{
460	return container_of(so, struct nfs4_lockowner, lo_owner);
461}
462
463/*
464 * Per-client state indicating no. of opens and outstanding delegations
465 * on a file from a particular client.'od' stands for 'open & delegation'
466 */
467struct nfs4_clnt_odstate {
468	struct nfs4_client	*co_client;
469	struct nfs4_file	*co_file;
470	struct list_head	co_perfile;
471	refcount_t		co_odcount;
472};
473
474/*
475 * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
476 *
477 * These objects are global. nfsd keeps one instance of a nfs4_file per
478 * filehandle (though it may keep multiple file descriptors for each). Each
479 * inode can have multiple filehandles associated with it, so there is
480 * (potentially) a many to one relationship between this struct and struct
481 * inode.
482 *
483 * These are hashed by filehandle in the file_hashtbl, which is protected by
484 * the global state_lock spinlock.
485 */
486struct nfs4_file {
487	refcount_t		fi_ref;
488	spinlock_t		fi_lock;
489	struct hlist_node       fi_hash;	/* hash on fi_fhandle */
490	struct list_head        fi_stateids;
491	union {
492		struct list_head	fi_delegations;
493		struct rcu_head		fi_rcu;
494	};
495	struct list_head	fi_clnt_odstate;
496	/* One each for O_RDONLY, O_WRONLY, O_RDWR: */
497	struct file *		fi_fds[3];
498	/*
499	 * Each open or lock stateid contributes 0-4 to the counts
500	 * below depending on which bits are set in st_access_bitmap:
501	 *     1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
502	 *   + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
503	 *   + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
504	 */
505	atomic_t		fi_access[2];
506	u32			fi_share_deny;
507	struct file		*fi_deleg_file;
508	int			fi_delegees;
509	struct knfsd_fh		fi_fhandle;
 
510	bool			fi_had_conflict;
511#ifdef CONFIG_NFSD_PNFS
512	struct list_head	fi_lo_states;
513	atomic_t		fi_lo_recalls;
514#endif
515};
516
517/*
518 * A generic struct representing either a open or lock stateid. The nfs4_client
519 * holds a reference to each of these objects, and they in turn hold a
520 * reference to their respective stateowners. The client's reference is
521 * released in response to a close or unlock (depending on whether it's an open
522 * or lock stateid) or when the client is being destroyed.
523 *
524 * In the case of v4.0 open stateids, these objects are preserved for a little
525 * while after close in order to handle CLOSE replays. Those are eventually
526 * reclaimed via a LRU scheme by the laundromat.
527 *
528 * This object is a superset of the nfs4_stid. "ol" stands for "Open or Lock".
529 * Better suggestions welcome.
530 */
531struct nfs4_ol_stateid {
532	struct nfs4_stid		st_stid;
533	struct list_head		st_perfile;
534	struct list_head		st_perstateowner;
535	struct list_head		st_locks;
536	struct nfs4_stateowner		*st_stateowner;
537	struct nfs4_clnt_odstate	*st_clnt_odstate;
538	unsigned char			st_access_bmap;
539	unsigned char			st_deny_bmap;
540	struct nfs4_ol_stateid		*st_openstp;
541	struct mutex			st_mutex;
542};
543
544static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
545{
546	return container_of(s, struct nfs4_ol_stateid, st_stid);
 
 
 
 
 
547}
548
549struct nfs4_layout_stateid {
550	struct nfs4_stid		ls_stid;
551	struct list_head		ls_perclnt;
552	struct list_head		ls_perfile;
553	spinlock_t			ls_lock;
554	struct list_head		ls_layouts;
555	u32				ls_layout_type;
556	struct file			*ls_file;
557	struct nfsd4_callback		ls_recall;
558	stateid_t			ls_recall_sid;
559	bool				ls_recalled;
560	struct mutex			ls_mutex;
561};
562
563static inline struct nfs4_layout_stateid *layoutstateid(struct nfs4_stid *s)
564{
565	return container_of(s, struct nfs4_layout_stateid, ls_stid);
566}
567
568/* flags for preprocess_seqid_op() */
569#define RD_STATE	        0x00000010
570#define WR_STATE	        0x00000020
571
572enum nfsd4_cb_op {
573	NFSPROC4_CLNT_CB_NULL = 0,
574	NFSPROC4_CLNT_CB_RECALL,
575	NFSPROC4_CLNT_CB_LAYOUT,
576	NFSPROC4_CLNT_CB_SEQUENCE,
577	NFSPROC4_CLNT_CB_NOTIFY_LOCK,
578};
579
580/* Returns true iff a is later than b: */
581static inline bool nfsd4_stateid_generation_after(stateid_t *a, stateid_t *b)
582{
583	return (s32)(a->si_generation - b->si_generation) > 0;
584}
585
586/*
587 * When a client tries to get a lock on a file, we set one of these objects
588 * on the blocking lock. When the lock becomes free, we can then issue a
589 * CB_NOTIFY_LOCK to the server.
590 */
591struct nfsd4_blocked_lock {
592	struct list_head	nbl_list;
593	struct list_head	nbl_lru;
594	unsigned long		nbl_time;
595	struct file_lock	nbl_lock;
596	struct knfsd_fh		nbl_fh;
597	struct nfsd4_callback	nbl_cb;
598};
599
600struct nfsd4_compound_state;
601struct nfsd_net;
602
603extern __be32 nfs4_preprocess_stateid_op(struct svc_rqst *rqstp,
604		struct nfsd4_compound_state *cstate, struct svc_fh *fhp,
605		stateid_t *stateid, int flags, struct file **filp, bool *tmp_file);
606__be32 nfsd4_lookup_stateid(struct nfsd4_compound_state *cstate,
607		     stateid_t *stateid, unsigned char typemask,
608		     struct nfs4_stid **s, struct nfsd_net *nn);
609struct nfs4_stid *nfs4_alloc_stid(struct nfs4_client *cl, struct kmem_cache *slab,
610				  void (*sc_free)(struct nfs4_stid *));
611void nfs4_unhash_stid(struct nfs4_stid *s);
612void nfs4_put_stid(struct nfs4_stid *s);
613void nfs4_inc_and_copy_stateid(stateid_t *dst, struct nfs4_stid *stid);
614void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
615extern void nfs4_release_reclaim(struct nfsd_net *);
616extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(const char *recdir,
617							struct nfsd_net *nn);
618extern __be32 nfs4_check_open_reclaim(clientid_t *clid,
619		struct nfsd4_compound_state *cstate, struct nfsd_net *nn);
 
620extern int set_callback_cred(void);
621extern void cleanup_callback_cred(void);
622extern void nfsd4_probe_callback(struct nfs4_client *clp);
623extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
624extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
625extern void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp,
626		const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op);
627extern void nfsd4_run_cb(struct nfsd4_callback *cb);
628extern int nfsd4_create_callback_queue(void);
629extern void nfsd4_destroy_callback_queue(void);
630extern void nfsd4_shutdown_callback(struct nfs4_client *);
631extern void nfsd4_prepare_cb_recall(struct nfs4_delegation *dp);
632extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
633							struct nfsd_net *nn);
634extern bool nfs4_has_reclaimed_state(const char *name, struct nfsd_net *nn);
635
636struct nfs4_file *find_file(struct knfsd_fh *fh);
637void put_nfs4_file(struct nfs4_file *fi);
638static inline void get_nfs4_file(struct nfs4_file *fi)
639{
640	refcount_inc(&fi->fi_ref);
641}
642struct file *find_any_file(struct nfs4_file *f);
643
644/* grace period management */
645void nfsd4_end_grace(struct nfsd_net *nn);
646
647/* nfs4recover operations */
648extern int nfsd4_client_tracking_init(struct net *net);
649extern void nfsd4_client_tracking_exit(struct net *net);
650extern void nfsd4_client_record_create(struct nfs4_client *clp);
651extern void nfsd4_client_record_remove(struct nfs4_client *clp);
652extern int nfsd4_client_record_check(struct nfs4_client *clp);
653extern void nfsd4_record_grace_done(struct nfsd_net *nn);
654
655/* nfs fault injection functions */
656#ifdef CONFIG_NFSD_FAULT_INJECTION
657int nfsd_fault_inject_init(void);
658void nfsd_fault_inject_cleanup(void);
 
 
659
660u64 nfsd_inject_print_clients(void);
661u64 nfsd_inject_forget_client(struct sockaddr_storage *, size_t);
662u64 nfsd_inject_forget_clients(u64);
663
664u64 nfsd_inject_print_locks(void);
665u64 nfsd_inject_forget_client_locks(struct sockaddr_storage *, size_t);
666u64 nfsd_inject_forget_locks(u64);
667
668u64 nfsd_inject_print_openowners(void);
669u64 nfsd_inject_forget_client_openowners(struct sockaddr_storage *, size_t);
670u64 nfsd_inject_forget_openowners(u64);
671
672u64 nfsd_inject_print_delegations(void);
673u64 nfsd_inject_forget_client_delegations(struct sockaddr_storage *, size_t);
674u64 nfsd_inject_forget_delegations(u64);
675u64 nfsd_inject_recall_client_delegations(struct sockaddr_storage *, size_t);
676u64 nfsd_inject_recall_delegations(u64);
677#else /* CONFIG_NFSD_FAULT_INJECTION */
678static inline int nfsd_fault_inject_init(void) { return 0; }
679static inline void nfsd_fault_inject_cleanup(void) {}
680#endif /* CONFIG_NFSD_FAULT_INJECTION */
681
682#endif   /* NFSD4_STATE_H */