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