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