xref: /linux/fs/nfsd/state.h (revision 5e8c0fb6a95728b852d56c0a9244425d474670c0)
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 "nfsfh.h"
41 
42 typedef struct {
43 	u32             cl_boot;
44 	u32             cl_id;
45 } clientid_t;
46 
47 typedef struct {
48 	clientid_t	so_clid;
49 	u32		so_id;
50 } stateid_opaque_t;
51 
52 typedef struct {
53 	u32                     si_generation;
54 	stateid_opaque_t        si_opaque;
55 } stateid_t;
56 
57 #define STATEID_FMT	"(%08x/%08x/%08x/%08x)"
58 #define STATEID_VAL(s) \
59 	(s)->si_opaque.so_clid.cl_boot, \
60 	(s)->si_opaque.so_clid.cl_id, \
61 	(s)->si_opaque.so_id, \
62 	(s)->si_generation
63 
64 struct nfsd4_callback {
65 	struct nfs4_client *cb_clp;
66 	struct list_head cb_per_client;
67 	u32 cb_minorversion;
68 	struct rpc_message cb_msg;
69 	struct nfsd4_callback_ops *cb_ops;
70 	struct work_struct cb_work;
71 	bool cb_done;
72 };
73 
74 struct nfsd4_callback_ops {
75 	void (*prepare)(struct nfsd4_callback *);
76 	int (*done)(struct nfsd4_callback *, struct rpc_task *);
77 	void (*release)(struct nfsd4_callback *);
78 };
79 
80 /*
81  * A core object that represents a "common" stateid. These are generally
82  * embedded within the different (more specific) stateid objects and contain
83  * fields that are of general use to any stateid.
84  */
85 struct nfs4_stid {
86 	atomic_t sc_count;
87 #define NFS4_OPEN_STID 1
88 #define NFS4_LOCK_STID 2
89 #define NFS4_DELEG_STID 4
90 /* For an open stateid kept around *only* to process close replays: */
91 #define NFS4_CLOSED_STID 8
92 /* For a deleg stateid kept around only to process free_stateid's: */
93 #define NFS4_REVOKED_DELEG_STID 16
94 #define NFS4_CLOSED_DELEG_STID 32
95 	unsigned char sc_type;
96 	stateid_t sc_stateid;
97 	struct nfs4_client *sc_client;
98 	struct nfs4_file *sc_file;
99 	void (*sc_free)(struct nfs4_stid *);
100 };
101 
102 /*
103  * Represents a delegation stateid. The nfs4_client holds references to these
104  * and they are put when it is being destroyed or when the delegation is
105  * returned by the client:
106  *
107  * o 1 reference as long as a delegation is still in force (taken when it's
108  *   alloc'd, put when it's returned or revoked)
109  *
110  * o 1 reference as long as a recall rpc is in progress (taken when the lease
111  *   is broken, put when the rpc exits)
112  *
113  * o 1 more ephemeral reference for each nfsd thread currently doing something
114  *   with that delegation without holding the cl_lock
115  *
116  * If the server attempts to recall a delegation and the client doesn't do so
117  * before a timeout, the server may also revoke the delegation. In that case,
118  * the object will either be destroyed (v4.0) or moved to a per-client list of
119  * revoked delegations (v4.1+).
120  *
121  * This object is a superset of the nfs4_stid.
122  */
123 struct nfs4_delegation {
124 	struct nfs4_stid	dl_stid; /* must be first field */
125 	struct list_head	dl_perfile;
126 	struct list_head	dl_perclnt;
127 	struct list_head	dl_recall_lru;  /* delegation recalled */
128 	u32			dl_type;
129 	time_t			dl_time;
130 /* For recall: */
131 	int			dl_retries;
132 	struct nfsd4_callback	dl_recall;
133 };
134 
135 #define cb_to_delegation(cb) \
136 	container_of(cb, struct nfs4_delegation, dl_recall)
137 
138 /* client delegation callback info */
139 struct nfs4_cb_conn {
140 	/* SETCLIENTID info */
141 	struct sockaddr_storage	cb_addr;
142 	struct sockaddr_storage	cb_saddr;
143 	size_t			cb_addrlen;
144 	u32                     cb_prog; /* used only in 4.0 case;
145 					    per-session otherwise */
146 	u32                     cb_ident;	/* minorversion 0 only */
147 	struct svc_xprt		*cb_xprt;	/* minorversion 1 only */
148 };
149 
150 static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
151 {
152 	return container_of(s, struct nfs4_delegation, dl_stid);
153 }
154 
155 /* Maximum number of slots per session. 160 is useful for long haul TCP */
156 #define NFSD_MAX_SLOTS_PER_SESSION     160
157 /* Maximum number of operations per session compound */
158 #define NFSD_MAX_OPS_PER_COMPOUND	16
159 /* Maximum  session per slot cache size */
160 #define NFSD_SLOT_CACHE_SIZE		2048
161 /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
162 #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION	32
163 #define NFSD_MAX_MEM_PER_SESSION  \
164 		(NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
165 
166 struct nfsd4_slot {
167 	u32	sl_seqid;
168 	__be32	sl_status;
169 	u32	sl_datalen;
170 	u16	sl_opcnt;
171 #define NFSD4_SLOT_INUSE	(1 << 0)
172 #define NFSD4_SLOT_CACHETHIS	(1 << 1)
173 #define NFSD4_SLOT_INITIALIZED	(1 << 2)
174 	u8	sl_flags;
175 	char	sl_data[];
176 };
177 
178 struct nfsd4_channel_attrs {
179 	u32		headerpadsz;
180 	u32		maxreq_sz;
181 	u32		maxresp_sz;
182 	u32		maxresp_cached;
183 	u32		maxops;
184 	u32		maxreqs;
185 	u32		nr_rdma_attrs;
186 	u32		rdma_attrs;
187 };
188 
189 struct nfsd4_cb_sec {
190 	u32	flavor; /* (u32)(-1) used to mean "no valid flavor" */
191 	kuid_t	uid;
192 	kgid_t	gid;
193 };
194 
195 struct nfsd4_create_session {
196 	clientid_t			clientid;
197 	struct nfs4_sessionid		sessionid;
198 	u32				seqid;
199 	u32				flags;
200 	struct nfsd4_channel_attrs	fore_channel;
201 	struct nfsd4_channel_attrs	back_channel;
202 	u32				callback_prog;
203 	struct nfsd4_cb_sec		cb_sec;
204 };
205 
206 struct nfsd4_backchannel_ctl {
207 	u32	bc_cb_program;
208 	struct nfsd4_cb_sec		bc_cb_sec;
209 };
210 
211 struct nfsd4_bind_conn_to_session {
212 	struct nfs4_sessionid		sessionid;
213 	u32				dir;
214 };
215 
216 /* The single slot clientid cache structure */
217 struct nfsd4_clid_slot {
218 	u32				sl_seqid;
219 	__be32				sl_status;
220 	struct nfsd4_create_session	sl_cr_ses;
221 };
222 
223 struct nfsd4_conn {
224 	struct list_head cn_persession;
225 	struct svc_xprt *cn_xprt;
226 	struct svc_xpt_user cn_xpt_user;
227 	struct nfsd4_session *cn_session;
228 /* CDFC4_FORE, CDFC4_BACK: */
229 	unsigned char cn_flags;
230 };
231 
232 /*
233  * Representation of a v4.1+ session. These are refcounted in a similar fashion
234  * to the nfs4_client. References are only taken when the server is actively
235  * working on the object (primarily during the processing of compounds).
236  */
237 struct nfsd4_session {
238 	atomic_t		se_ref;
239 	struct list_head	se_hash;	/* hash by sessionid */
240 	struct list_head	se_perclnt;
241 /* See SESSION4_PERSIST, etc. for standard flags; this is internal-only: */
242 #define NFS4_SESSION_DEAD	0x010
243 	u32			se_flags;
244 	struct nfs4_client	*se_client;
245 	struct nfs4_sessionid	se_sessionid;
246 	struct nfsd4_channel_attrs se_fchannel;
247 	struct nfsd4_channel_attrs se_bchannel;
248 	struct nfsd4_cb_sec	se_cb_sec;
249 	struct list_head	se_conns;
250 	u32			se_cb_prog;
251 	u32			se_cb_seq_nr;
252 	struct nfsd4_slot	*se_slots[];	/* forward channel slots */
253 };
254 
255 /* formatted contents of nfs4_sessionid */
256 struct nfsd4_sessionid {
257 	clientid_t	clientid;
258 	u32		sequence;
259 	u32		reserved;
260 };
261 
262 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
263 
264 /*
265  * struct nfs4_client - one per client.  Clientids live here.
266  *
267  * The initial object created by an NFS client using SETCLIENTID (for NFSv4.0)
268  * or EXCHANGE_ID (for NFSv4.1+). These objects are refcounted and timestamped.
269  * Each nfsd_net_ns object contains a set of these and they are tracked via
270  * short and long form clientid. They are hashed and searched for under the
271  * per-nfsd_net client_lock spinlock.
272  *
273  * References to it are only held during the processing of compounds, and in
274  * certain other operations. In their "resting state" they have a refcount of
275  * 0. If they are not renewed within a lease period, they become eligible for
276  * destruction by the laundromat.
277  *
278  * These objects can also be destroyed prematurely by the fault injection code,
279  * or if the client sends certain forms of SETCLIENTID or EXCHANGE_ID updates.
280  * Care is taken *not* to do this however when the objects have an elevated
281  * refcount.
282  *
283  * o Each nfs4_client is hashed by clientid
284  *
285  * o Each nfs4_clients is also hashed by name (the opaque quantity initially
286  *   sent by the client to identify itself).
287  *
288  * o cl_perclient list is used to ensure no dangling stateowner references
289  *   when we expire the nfs4_client
290  */
291 struct nfs4_client {
292 	struct list_head	cl_idhash; 	/* hash by cl_clientid.id */
293 	struct rb_node		cl_namenode;	/* link into by-name trees */
294 	struct list_head	*cl_ownerstr_hashtbl;
295 	struct list_head	cl_openowners;
296 	struct idr		cl_stateids;	/* stateid lookup */
297 	struct list_head	cl_delegations;
298 	struct list_head	cl_revoked;	/* unacknowledged, revoked 4.1 state */
299 	struct list_head        cl_lru;         /* tail queue */
300 	struct xdr_netobj	cl_name; 	/* id generated by client */
301 	nfs4_verifier		cl_verifier; 	/* generated by client */
302 	time_t                  cl_time;        /* time of last lease renewal */
303 	struct sockaddr_storage	cl_addr; 	/* client ipaddress */
304 	bool			cl_mach_cred;	/* SP4_MACH_CRED in force */
305 	struct svc_cred		cl_cred; 	/* setclientid principal */
306 	clientid_t		cl_clientid;	/* generated by server */
307 	nfs4_verifier		cl_confirm;	/* generated by server */
308 	u32			cl_minorversion;
309 
310 	/* for v4.0 and v4.1 callbacks: */
311 	struct nfs4_cb_conn	cl_cb_conn;
312 #define NFSD4_CLIENT_CB_UPDATE		(0)
313 #define NFSD4_CLIENT_CB_KILL		(1)
314 #define NFSD4_CLIENT_STABLE		(2)	/* client on stable storage */
315 #define NFSD4_CLIENT_RECLAIM_COMPLETE	(3)	/* reclaim_complete done */
316 #define NFSD4_CLIENT_CONFIRMED		(4)	/* client is confirmed */
317 #define NFSD4_CLIENT_UPCALL_LOCK	(5)	/* upcall serialization */
318 #define NFSD4_CLIENT_CB_FLAG_MASK	(1 << NFSD4_CLIENT_CB_UPDATE | \
319 					 1 << NFSD4_CLIENT_CB_KILL)
320 	unsigned long		cl_flags;
321 	struct rpc_cred		*cl_cb_cred;
322 	struct rpc_clnt		*cl_cb_client;
323 	u32			cl_cb_ident;
324 #define NFSD4_CB_UP		0
325 #define NFSD4_CB_UNKNOWN	1
326 #define NFSD4_CB_DOWN		2
327 #define NFSD4_CB_FAULT		3
328 	int			cl_cb_state;
329 	struct nfsd4_callback	cl_cb_null;
330 	struct nfsd4_session	*cl_cb_session;
331 	struct list_head	cl_callbacks; /* list of in-progress callbacks */
332 
333 	/* for all client information that callback code might need: */
334 	spinlock_t		cl_lock;
335 
336 	/* for nfs41 */
337 	struct list_head	cl_sessions;
338 	struct nfsd4_clid_slot	cl_cs_slot;	/* create_session slot */
339 	u32			cl_exchange_flags;
340 	/* number of rpc's in progress over an associated session: */
341 	atomic_t		cl_refcount;
342 
343 	/* for nfs41 callbacks */
344 	/* We currently support a single back channel with a single slot */
345 	unsigned long		cl_cb_slot_busy;
346 	struct rpc_wait_queue	cl_cb_waitq;	/* backchannel callers may */
347 						/* wait here for slots */
348 	struct net		*net;
349 };
350 
351 /* struct nfs4_client_reset
352  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
353  * upon lease reset, or from upcall to state_daemon (to read in state
354  * from non-volitile storage) upon reboot.
355  */
356 struct nfs4_client_reclaim {
357 	struct list_head	cr_strhash;	/* hash by cr_name */
358 	struct nfs4_client	*cr_clp;	/* pointer to associated clp */
359 	char			cr_recdir[HEXDIR_LEN]; /* recover dir */
360 };
361 
362 static inline void
363 update_stateid(stateid_t *stateid)
364 {
365 	stateid->si_generation++;
366 	/* Wraparound recommendation from 3530bis-13 9.1.3.2: */
367 	if (stateid->si_generation == 0)
368 		stateid->si_generation = 1;
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  */
384 struct 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 
393 struct nfs4_stateowner;
394 
395 struct 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  */
406 struct 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  */
426 struct 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 (or would be if it needed any extra
447  * fields).
448  */
449 struct nfs4_lockowner {
450 	struct nfs4_stateowner	lo_owner; /* must be first element */
451 };
452 
453 static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
454 {
455 	return container_of(so, struct nfs4_openowner, oo_owner);
456 }
457 
458 static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
459 {
460 	return container_of(so, struct nfs4_lockowner, lo_owner);
461 }
462 
463 /*
464  * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
465  *
466  * These objects are global. nfsd keeps one instance of a nfs4_file per
467  * filehandle (though it may keep multiple file descriptors for each). Each
468  * inode can have multiple filehandles associated with it, so there is
469  * (potentially) a many to one relationship between this struct and struct
470  * inode.
471  *
472  * These are hashed by filehandle in the file_hashtbl, which is protected by
473  * the global state_lock spinlock.
474  */
475 struct nfs4_file {
476 	atomic_t		fi_ref;
477 	spinlock_t		fi_lock;
478 	struct hlist_node       fi_hash;	/* hash on fi_fhandle */
479 	struct list_head        fi_stateids;
480 	union {
481 		struct list_head	fi_delegations;
482 		struct rcu_head		fi_rcu;
483 	};
484 	/* One each for O_RDONLY, O_WRONLY, O_RDWR: */
485 	struct file *		fi_fds[3];
486 	/*
487 	 * Each open or lock stateid contributes 0-4 to the counts
488 	 * below depending on which bits are set in st_access_bitmap:
489 	 *     1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
490 	 *   + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
491 	 *   + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
492 	 */
493 	atomic_t		fi_access[2];
494 	u32			fi_share_deny;
495 	struct file		*fi_deleg_file;
496 	atomic_t		fi_delegees;
497 	struct knfsd_fh		fi_fhandle;
498 	bool			fi_had_conflict;
499 };
500 
501 /*
502  * A generic struct representing either a open or lock stateid. The nfs4_client
503  * holds a reference to each of these objects, and they in turn hold a
504  * reference to their respective stateowners. The client's reference is
505  * released in response to a close or unlock (depending on whether it's an open
506  * or lock stateid) or when the client is being destroyed.
507  *
508  * In the case of v4.0 open stateids, these objects are preserved for a little
509  * while after close in order to handle CLOSE replays. Those are eventually
510  * reclaimed via a LRU scheme by the laundromat.
511  *
512  * This object is a superset of the nfs4_stid. "ol" stands for "Open or Lock".
513  * Better suggestions welcome.
514  */
515 struct nfs4_ol_stateid {
516 	struct nfs4_stid    st_stid; /* must be first field */
517 	struct list_head              st_perfile;
518 	struct list_head              st_perstateowner;
519 	struct list_head              st_locks;
520 	struct nfs4_stateowner      * st_stateowner;
521 	unsigned char                 st_access_bmap;
522 	unsigned char                 st_deny_bmap;
523 	struct nfs4_ol_stateid         * st_openstp;
524 };
525 
526 static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
527 {
528 	return container_of(s, struct nfs4_ol_stateid, st_stid);
529 }
530 
531 /* flags for preprocess_seqid_op() */
532 #define RD_STATE	        0x00000010
533 #define WR_STATE	        0x00000020
534 
535 enum nfsd4_cb_op {
536 	NFSPROC4_CLNT_CB_NULL = 0,
537 	NFSPROC4_CLNT_CB_RECALL,
538 	NFSPROC4_CLNT_CB_SEQUENCE,
539 };
540 
541 
542 struct nfsd4_compound_state;
543 struct nfsd_net;
544 
545 extern __be32 nfs4_preprocess_stateid_op(struct net *net,
546 		struct nfsd4_compound_state *cstate,
547 		stateid_t *stateid, int flags, struct file **filp);
548 void nfs4_put_stid(struct nfs4_stid *s);
549 void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
550 extern void nfs4_release_reclaim(struct nfsd_net *);
551 extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(const char *recdir,
552 							struct nfsd_net *nn);
553 extern __be32 nfs4_check_open_reclaim(clientid_t *clid,
554 		struct nfsd4_compound_state *cstate, struct nfsd_net *nn);
555 extern int set_callback_cred(void);
556 extern void nfsd4_probe_callback(struct nfs4_client *clp);
557 extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
558 extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
559 extern void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp,
560 		struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op);
561 extern void nfsd4_run_cb(struct nfsd4_callback *cb);
562 extern int nfsd4_create_callback_queue(void);
563 extern void nfsd4_destroy_callback_queue(void);
564 extern void nfsd4_shutdown_callback(struct nfs4_client *);
565 extern void nfsd4_prepare_cb_recall(struct nfs4_delegation *dp);
566 extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
567 							struct nfsd_net *nn);
568 extern bool nfs4_has_reclaimed_state(const char *name, struct nfsd_net *nn);
569 
570 /* grace period management */
571 void nfsd4_end_grace(struct nfsd_net *nn);
572 
573 /* nfs4recover operations */
574 extern int nfsd4_client_tracking_init(struct net *net);
575 extern void nfsd4_client_tracking_exit(struct net *net);
576 extern void nfsd4_client_record_create(struct nfs4_client *clp);
577 extern void nfsd4_client_record_remove(struct nfs4_client *clp);
578 extern int nfsd4_client_record_check(struct nfs4_client *clp);
579 extern void nfsd4_record_grace_done(struct nfsd_net *nn);
580 
581 /* nfs fault injection functions */
582 #ifdef CONFIG_NFSD_FAULT_INJECTION
583 int nfsd_fault_inject_init(void);
584 void nfsd_fault_inject_cleanup(void);
585 
586 u64 nfsd_inject_print_clients(void);
587 u64 nfsd_inject_forget_client(struct sockaddr_storage *, size_t);
588 u64 nfsd_inject_forget_clients(u64);
589 
590 u64 nfsd_inject_print_locks(void);
591 u64 nfsd_inject_forget_client_locks(struct sockaddr_storage *, size_t);
592 u64 nfsd_inject_forget_locks(u64);
593 
594 u64 nfsd_inject_print_openowners(void);
595 u64 nfsd_inject_forget_client_openowners(struct sockaddr_storage *, size_t);
596 u64 nfsd_inject_forget_openowners(u64);
597 
598 u64 nfsd_inject_print_delegations(void);
599 u64 nfsd_inject_forget_client_delegations(struct sockaddr_storage *, size_t);
600 u64 nfsd_inject_forget_delegations(u64);
601 u64 nfsd_inject_recall_client_delegations(struct sockaddr_storage *, size_t);
602 u64 nfsd_inject_recall_delegations(u64);
603 #else /* CONFIG_NFSD_FAULT_INJECTION */
604 static inline int nfsd_fault_inject_init(void) { return 0; }
605 static inline void nfsd_fault_inject_cleanup(void) {}
606 #endif /* CONFIG_NFSD_FAULT_INJECTION */
607 
608 #endif   /* NFSD4_STATE_H */
609