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