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 typedef struct {
60 	stateid_t		cs_stid;
61 #define NFS4_COPY_STID 1
62 #define NFS4_COPYNOTIFY_STID 2
63 	unsigned char		cs_type;
64 	refcount_t		cs_count;
65 } copy_stateid_t;
66 
67 struct nfsd4_callback {
68 	struct nfs4_client *cb_clp;
69 	struct rpc_message cb_msg;
70 #define NFSD4_CALLBACK_RUNNING		(0)
71 #define NFSD4_CALLBACK_WAKE		(1)
72 #define NFSD4_CALLBACK_REQUEUE		(2)
73 	unsigned long cb_flags;
74 	const struct nfsd4_callback_ops *cb_ops;
75 	struct work_struct cb_work;
76 	int cb_seq_status;
77 	int cb_status;
78 	int cb_held_slot;
79 };
80 
81 struct nfsd4_callback_ops {
82 	void (*prepare)(struct nfsd4_callback *);
83 	int (*done)(struct nfsd4_callback *, struct rpc_task *);
84 	void (*release)(struct nfsd4_callback *);
85 	uint32_t opcode;
86 };
87 
88 /*
89  * A core object that represents a "common" stateid. These are generally
90  * embedded within the different (more specific) stateid objects and contain
91  * fields that are of general use to any stateid.
92  */
93 struct nfs4_stid {
94 	refcount_t		sc_count;
95 
96 	/* A new stateid is added to the cl_stateids idr early before it
97 	 * is fully initialised.  Its sc_type is then zero.  After
98 	 * initialisation the sc_type it set under cl_lock, and then
99 	 * never changes.
100 	 */
101 #define SC_TYPE_OPEN		BIT(0)
102 #define SC_TYPE_LOCK		BIT(1)
103 #define SC_TYPE_DELEG		BIT(2)
104 #define SC_TYPE_LAYOUT		BIT(3)
105 	unsigned short		sc_type;
106 
107 /* state_lock protects sc_status for delegation stateids.
108  * ->cl_lock protects sc_status for open and lock stateids.
109  * ->st_mutex also protect sc_status for open stateids.
110  * ->ls_lock protects sc_status for layout stateids.
111  */
112 /*
113  * For an open stateid kept around *only* to process close replays.
114  * For deleg stateid, kept in idr until last reference is dropped.
115  */
116 #define SC_STATUS_CLOSED	BIT(0)
117 /* For a deleg stateid kept around only to process free_stateid's: */
118 #define SC_STATUS_REVOKED	BIT(1)
119 #define SC_STATUS_ADMIN_REVOKED	BIT(2)
120 #define SC_STATUS_FREEABLE	BIT(3)
121 #define SC_STATUS_FREED		BIT(4)
122 	unsigned short		sc_status;
123 
124 	struct list_head	sc_cp_list;
125 	stateid_t		sc_stateid;
126 	spinlock_t		sc_lock;
127 	struct nfs4_client	*sc_client;
128 	struct nfs4_file	*sc_file;
129 	void			(*sc_free)(struct nfs4_stid *);
130 };
131 
132 /* Keep a list of stateids issued by the COPY_NOTIFY, associate it with the
133  * parent OPEN/LOCK/DELEG stateid.
134  */
135 struct nfs4_cpntf_state {
136 	copy_stateid_t		cp_stateid;
137 	struct list_head	cp_list;	/* per parent nfs4_stid */
138 	stateid_t		cp_p_stateid;	/* copy of parent's stateid */
139 	clientid_t		cp_p_clid;	/* copy of parent's clid */
140 	time64_t		cpntf_time;	/* last time stateid used */
141 };
142 
143 /*
144  * RFC 7862 Section 4.8 states:
145  *
146  * | A copy offload stateid will be valid until either (A) the client
147  * | or server restarts or (B) the client returns the resource by
148  * | issuing an OFFLOAD_CANCEL operation or the client replies to a
149  * | CB_OFFLOAD operation.
150  *
151  * Because a client might not reply to a CB_OFFLOAD, or a reply
152  * might get lost due to connection loss, NFSD purges async copy
153  * state after a short period to prevent it from accumulating
154  * over time.
155  */
156 #define NFSD_COPY_INITIAL_TTL 10
157 
158 struct nfs4_cb_fattr {
159 	struct nfsd4_callback ncf_getattr;
160 	u32 ncf_cb_status;
161 
162 	/* from CB_GETATTR reply */
163 	u64 ncf_cb_change;
164 	u64 ncf_cb_fsize;
165 	struct timespec64 ncf_cb_mtime;
166 	struct timespec64 ncf_cb_atime;
167 
168 	bool ncf_file_modified;
169 	u64 ncf_initial_cinfo;
170 	u64 ncf_cur_fsize;
171 };
172 
173 /*
174  * Represents a delegation stateid. The nfs4_client holds references to these
175  * and they are put when it is being destroyed or when the delegation is
176  * returned by the client:
177  *
178  * o 1 reference as long as a delegation is still in force (taken when it's
179  *   alloc'd, put when it's returned or revoked)
180  *
181  * o 1 reference as long as a recall rpc is in progress (taken when the lease
182  *   is broken, put when the rpc exits)
183  *
184  * o 1 more ephemeral reference for each nfsd thread currently doing something
185  *   with that delegation without holding the cl_lock
186  *
187  * If the server attempts to recall a delegation and the client doesn't do so
188  * before a timeout, the server may also revoke the delegation. In that case,
189  * the object will either be destroyed (v4.0) or moved to a per-client list of
190  * revoked delegations (v4.1+).
191  *
192  * This object is a superset of the nfs4_stid.
193  */
194 struct nfs4_delegation {
195 	struct nfs4_stid	dl_stid; /* must be first field */
196 	struct list_head	dl_perfile;
197 	struct list_head	dl_perclnt;
198 	struct list_head	dl_recall_lru;  /* delegation recalled */
199 	struct nfs4_clnt_odstate *dl_clnt_odstate;
200 	time64_t		dl_time;
201 	u32			dl_type;
202 /* For recall: */
203 	int			dl_retries;
204 	struct nfsd4_callback	dl_recall;
205 	bool			dl_recalled;
206 
207 	/* for CB_GETATTR */
208 	struct nfs4_cb_fattr    dl_cb_fattr;
209 };
210 
deleg_is_read(u32 dl_type)211 static inline bool deleg_is_read(u32 dl_type)
212 {
213 	return (dl_type == OPEN_DELEGATE_READ || dl_type == OPEN_DELEGATE_READ_ATTRS_DELEG);
214 }
215 
deleg_is_write(u32 dl_type)216 static inline bool deleg_is_write(u32 dl_type)
217 {
218 	return (dl_type == OPEN_DELEGATE_WRITE || dl_type == OPEN_DELEGATE_WRITE_ATTRS_DELEG);
219 }
220 
deleg_attrs_deleg(u32 dl_type)221 static inline bool deleg_attrs_deleg(u32 dl_type)
222 {
223 	return dl_type == OPEN_DELEGATE_READ_ATTRS_DELEG ||
224 	       dl_type == OPEN_DELEGATE_WRITE_ATTRS_DELEG;
225 }
226 
227 #define cb_to_delegation(cb) \
228 	container_of(cb, struct nfs4_delegation, dl_recall)
229 
230 /* client delegation callback info */
231 struct nfs4_cb_conn {
232 	/* SETCLIENTID info */
233 	struct sockaddr_storage	cb_addr;
234 	struct sockaddr_storage	cb_saddr;
235 	size_t			cb_addrlen;
236 	u32                     cb_prog; /* used only in 4.0 case;
237 					    per-session otherwise */
238 	u32                     cb_ident;	/* minorversion 0 only */
239 	struct svc_xprt		*cb_xprt;	/* minorversion 1 only */
240 };
241 
delegstateid(struct nfs4_stid * s)242 static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
243 {
244 	return container_of(s, struct nfs4_delegation, dl_stid);
245 }
246 
247 /* Maximum number of slots per session.  This is for sanity-check only.
248  * It could be increased if we had a mechanism to shutdown misbehaving clients.
249  * A large number can be needed to get good throughput on high-latency servers.
250  */
251 #define NFSD_MAX_SLOTS_PER_SESSION	2048
252 /* Maximum  session per slot cache size */
253 #define NFSD_SLOT_CACHE_SIZE		2048
254 /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
255 #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION	32
256 #define NFSD_MAX_MEM_PER_SESSION  \
257 		(NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
258 
259 struct nfsd4_slot {
260 	u32	sl_seqid;
261 	__be32	sl_status;
262 	struct svc_cred sl_cred;
263 	u32	sl_datalen;
264 	u16	sl_opcnt;
265 	u16	sl_generation;
266 #define NFSD4_SLOT_INUSE	(1 << 0)
267 #define NFSD4_SLOT_CACHETHIS	(1 << 1)
268 #define NFSD4_SLOT_INITIALIZED	(1 << 2)
269 #define NFSD4_SLOT_CACHED	(1 << 3)
270 #define NFSD4_SLOT_REUSED	(1 << 4)
271 	u8	sl_flags;
272 	char	sl_data[];
273 };
274 
275 struct nfsd4_channel_attrs {
276 	u32		headerpadsz;
277 	u32		maxreq_sz;
278 	u32		maxresp_sz;
279 	u32		maxresp_cached;
280 	u32		maxops;
281 	u32		maxreqs;
282 	u32		nr_rdma_attrs;
283 	u32		rdma_attrs;
284 };
285 
286 struct nfsd4_cb_sec {
287 	u32	flavor; /* (u32)(-1) used to mean "no valid flavor" */
288 	kuid_t	uid;
289 	kgid_t	gid;
290 };
291 
292 struct nfsd4_create_session {
293 	clientid_t			clientid;
294 	struct nfs4_sessionid		sessionid;
295 	u32				seqid;
296 	u32				flags;
297 	struct nfsd4_channel_attrs	fore_channel;
298 	struct nfsd4_channel_attrs	back_channel;
299 	u32				callback_prog;
300 	struct nfsd4_cb_sec		cb_sec;
301 };
302 
303 struct nfsd4_backchannel_ctl {
304 	u32	bc_cb_program;
305 	struct nfsd4_cb_sec		bc_cb_sec;
306 };
307 
308 struct nfsd4_bind_conn_to_session {
309 	struct nfs4_sessionid		sessionid;
310 	u32				dir;
311 };
312 
313 /* The single slot clientid cache structure */
314 struct nfsd4_clid_slot {
315 	u32				sl_seqid;
316 	__be32				sl_status;
317 	struct nfsd4_create_session	sl_cr_ses;
318 };
319 
320 struct nfsd4_conn {
321 	struct list_head cn_persession;
322 	struct svc_xprt *cn_xprt;
323 	struct svc_xpt_user cn_xpt_user;
324 	struct nfsd4_session *cn_session;
325 /* CDFC4_FORE, CDFC4_BACK: */
326 	unsigned char cn_flags;
327 };
328 
329 /* Maximum number of slots that nfsd will use in the backchannel */
330 #define NFSD_BC_SLOT_TABLE_SIZE		(sizeof(u32) * 8)
331 
332 /*
333  * Representation of a v4.1+ session. These are refcounted in a similar fashion
334  * to the nfs4_client. References are only taken when the server is actively
335  * working on the object (primarily during the processing of compounds).
336  */
337 struct nfsd4_session {
338 	atomic_t		se_ref;
339 	spinlock_t		se_lock;
340 	u32			se_cb_slot_avail; /* bitmap of available slots */
341 	u32			se_cb_highest_slot;	/* highest slot client wants */
342 	u32			se_cb_prog;
343 	struct list_head	se_hash;	/* hash by sessionid */
344 	struct list_head	se_perclnt;
345 	struct list_head	se_all_sessions;/* global list of sessions */
346 	struct nfs4_client	*se_client;
347 	struct nfs4_sessionid	se_sessionid;
348 	struct nfsd4_channel_attrs se_fchannel;
349 	struct nfsd4_cb_sec	se_cb_sec;
350 	struct list_head	se_conns;
351 	u32			se_cb_seq_nr[NFSD_BC_SLOT_TABLE_SIZE];
352 	struct xarray		se_slots;	/* forward channel slots */
353 	u16			se_slot_gen;
354 	bool			se_dead;
355 	u32			se_target_maxslots;
356 };
357 
358 /* formatted contents of nfs4_sessionid */
359 struct nfsd4_sessionid {
360 	clientid_t	clientid;
361 	u32		sequence;
362 	u32		reserved;
363 };
364 
365 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
366 
367 /*
368  *       State                Meaning                  Where set
369  * --------------------------------------------------------------------------
370  * | NFSD4_ACTIVE      | Confirmed, active    | Default                     |
371  * |------------------- ----------------------------------------------------|
372  * | NFSD4_COURTESY    | Courtesy state.      | nfs4_get_client_reaplist    |
373  * |                   | Lease/lock/share     |                             |
374  * |                   | reservation conflict |                             |
375  * |                   | can cause Courtesy   |                             |
376  * |                   | client to be expired |                             |
377  * |------------------------------------------------------------------------|
378  * | NFSD4_EXPIRABLE   | Courtesy client to be| nfs4_laundromat             |
379  * |                   | expired by Laundromat| try_to_expire_client        |
380  * |                   | due to conflict      |                             |
381  * |------------------------------------------------------------------------|
382  */
383 enum {
384 	NFSD4_ACTIVE = 0,
385 	NFSD4_COURTESY,
386 	NFSD4_EXPIRABLE,
387 };
388 
389 /*
390  * struct nfs4_client - one per client.  Clientids live here.
391  *
392  * The initial object created by an NFS client using SETCLIENTID (for NFSv4.0)
393  * or EXCHANGE_ID (for NFSv4.1+). These objects are refcounted and timestamped.
394  * Each nfsd_net_ns object contains a set of these and they are tracked via
395  * short and long form clientid. They are hashed and searched for under the
396  * per-nfsd_net client_lock spinlock.
397  *
398  * References to it are only held during the processing of compounds, and in
399  * certain other operations. In their "resting state" they have a refcount of
400  * 0. If they are not renewed within a lease period, they become eligible for
401  * destruction by the laundromat.
402  *
403  * These objects can also be destroyed if the client sends certain forms of
404  * SETCLIENTID or EXCHANGE_ID operations.
405  *
406  * Care is taken *not* to do this however when the objects have an elevated
407  * refcount.
408  *
409  * o Each nfs4_client is hashed by clientid
410  *
411  * o Each nfs4_clients is also hashed by name (the opaque quantity initially
412  *   sent by the client to identify itself).
413  *
414  * o cl_perclient list is used to ensure no dangling stateowner references
415  *   when we expire the nfs4_client
416  */
417 struct nfs4_client {
418 	struct list_head	cl_idhash; 	/* hash by cl_clientid.id */
419 	struct rb_node		cl_namenode;	/* link into by-name trees */
420 	struct list_head	*cl_ownerstr_hashtbl;
421 	struct list_head	cl_openowners;
422 	struct idr		cl_stateids;	/* stateid lookup */
423 	struct list_head	cl_delegations;
424 	struct list_head	cl_revoked;	/* unacknowledged, revoked 4.1 state */
425 	struct list_head        cl_lru;         /* tail queue */
426 #ifdef CONFIG_NFSD_PNFS
427 	struct list_head	cl_lo_states;	/* outstanding layout states */
428 #endif
429 	struct xdr_netobj	cl_name; 	/* id generated by client */
430 	nfs4_verifier		cl_verifier; 	/* generated by client */
431 	time64_t		cl_time;	/* time of last lease renewal */
432 	struct sockaddr_storage	cl_addr; 	/* client ipaddress */
433 	bool			cl_mach_cred;	/* SP4_MACH_CRED in force */
434 	struct svc_cred		cl_cred; 	/* setclientid principal */
435 	clientid_t		cl_clientid;	/* generated by server */
436 	nfs4_verifier		cl_confirm;	/* generated by server */
437 	u32			cl_minorversion;
438 	atomic_t		cl_admin_revoked; /* count of admin-revoked states */
439 	/* NFSv4.1 client implementation id: */
440 	struct xdr_netobj	cl_nii_domain;
441 	struct xdr_netobj	cl_nii_name;
442 	struct timespec64	cl_nii_time;
443 
444 	/* for v4.0 and v4.1 callbacks: */
445 	struct nfs4_cb_conn	cl_cb_conn;
446 #define NFSD4_CLIENT_CB_UPDATE		(0)
447 #define NFSD4_CLIENT_CB_KILL		(1)
448 #define NFSD4_CLIENT_STABLE		(2)	/* client on stable storage */
449 #define NFSD4_CLIENT_RECLAIM_COMPLETE	(3)	/* reclaim_complete done */
450 #define NFSD4_CLIENT_CONFIRMED		(4)	/* client is confirmed */
451 #define NFSD4_CLIENT_UPCALL_LOCK	(5)	/* upcall serialization */
452 #define NFSD4_CLIENT_CB_FLAG_MASK	(1 << NFSD4_CLIENT_CB_UPDATE | \
453 					 1 << NFSD4_CLIENT_CB_KILL)
454 	unsigned long		cl_flags;
455 
456 	struct workqueue_struct *cl_callback_wq;
457 	const struct cred	*cl_cb_cred;
458 	struct rpc_clnt		*cl_cb_client;
459 	u32			cl_cb_ident;
460 #define NFSD4_CB_UP		0
461 #define NFSD4_CB_UNKNOWN	1
462 #define NFSD4_CB_DOWN		2
463 #define NFSD4_CB_FAULT		3
464 	int			cl_cb_state;
465 	struct nfsd4_callback	cl_cb_null;
466 	struct nfsd4_session	*cl_cb_session;
467 
468 	/* for all client information that callback code might need: */
469 	spinlock_t		cl_lock;
470 
471 	/* for nfs41 */
472 	struct list_head	cl_sessions;
473 	struct nfsd4_clid_slot	cl_cs_slot;	/* create_session slot */
474 	u32			cl_exchange_flags;
475 	/* number of rpc's in progress over an associated session: */
476 	atomic_t		cl_rpc_users;
477 	struct nfsdfs_client	cl_nfsdfs;
478 	struct nfs4_op_map      cl_spo_must_allow;
479 
480 	/* debugging info directory under nfsd/clients/ : */
481 	struct dentry		*cl_nfsd_dentry;
482 	/* 'info' file within that directory. Ref is not counted,
483 	 * but will remain valid iff cl_nfsd_dentry != NULL
484 	 */
485 	struct dentry		*cl_nfsd_info_dentry;
486 
487 	struct rpc_wait_queue	cl_cb_waitq;	/* backchannel callers may */
488 						/* wait here for slots */
489 	struct net		*net;
490 	struct list_head	async_copies;	/* list of async copies */
491 	spinlock_t		async_lock;	/* lock for async copies */
492 	atomic_t		cl_cb_inflight;	/* Outstanding callbacks */
493 
494 	unsigned int		cl_state;
495 	atomic_t		cl_delegs_in_recall;
496 
497 	struct nfsd4_cb_recall_any	*cl_ra;
498 	time64_t		cl_ra_time;
499 };
500 
501 /* struct nfs4_client_reset
502  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
503  * upon lease reset, or from upcall to state_daemon (to read in state
504  * from non-volitile storage) upon reboot.
505  */
506 struct nfs4_client_reclaim {
507 	struct list_head	cr_strhash;	/* hash by cr_name */
508 	struct nfs4_client	*cr_clp;	/* pointer to associated clp */
509 	struct xdr_netobj	cr_name;	/* recovery dir name */
510 	struct xdr_netobj	cr_princhash;
511 };
512 
513 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
514  * The OPEN response, typically the largest, requires
515  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) +
516  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
517  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
518  */
519 
520 #define NFSD4_REPLAY_ISIZE       112
521 
522 /*
523  * Replay buffer, where the result of the last seqid-mutating operation
524  * is cached.
525  */
526 struct nfs4_replay {
527 	__be32			rp_status;
528 	unsigned int		rp_buflen;
529 	char			*rp_buf;
530 	struct knfsd_fh		rp_openfh;
531 	int			rp_locked;
532 	char			rp_ibuf[NFSD4_REPLAY_ISIZE];
533 };
534 
535 struct nfs4_stateowner;
536 
537 struct nfs4_stateowner_operations {
538 	void (*so_unhash)(struct nfs4_stateowner *);
539 	void (*so_free)(struct nfs4_stateowner *);
540 };
541 
542 /*
543  * A core object that represents either an open or lock owner. The object and
544  * lock owner objects have one of these embedded within them. Refcounts and
545  * other fields common to both owner types are contained within these
546  * structures.
547  */
548 struct nfs4_stateowner {
549 	struct list_head			so_strhash;
550 	struct list_head			so_stateids;
551 	struct nfs4_client			*so_client;
552 	const struct nfs4_stateowner_operations	*so_ops;
553 	/* after increment in nfsd4_bump_seqid, represents the next
554 	 * sequence id expected from the client: */
555 	atomic_t				so_count;
556 	u32					so_seqid;
557 	struct xdr_netobj			so_owner; /* open owner name */
558 	struct nfs4_replay			so_replay;
559 	bool					so_is_open_owner;
560 };
561 
562 /*
563  * When a file is opened, the client provides an open state owner opaque string
564  * that indicates the "owner" of that open. These objects are refcounted.
565  * References to it are held by each open state associated with it. This object
566  * is a superset of the nfs4_stateowner struct.
567  */
568 struct nfs4_openowner {
569 	struct nfs4_stateowner	oo_owner; /* must be first field */
570 	struct list_head        oo_perclient;
571 	/*
572 	 * We keep around openowners a little while after last close,
573 	 * which saves clients from having to confirm, and allows us to
574 	 * handle close replays if they come soon enough.  The close_lru
575 	 * is a list of such openowners, to be reaped by the laundromat
576 	 * thread eventually if they remain unused:
577 	 */
578 	struct list_head	oo_close_lru;
579 	struct nfs4_ol_stateid *oo_last_closed_stid;
580 	time64_t		oo_time; /* time of placement on so_close_lru */
581 #define NFS4_OO_CONFIRMED   1
582 	unsigned char		oo_flags;
583 };
584 
585 /*
586  * Represents a generic "lockowner". Similar to an openowner. References to it
587  * are held by the lock stateids that are created on its behalf. This object is
588  * a superset of the nfs4_stateowner struct.
589  */
590 struct nfs4_lockowner {
591 	struct nfs4_stateowner	lo_owner;	/* must be first element */
592 	struct list_head	lo_blocked;	/* blocked file_locks */
593 };
594 
openowner(struct nfs4_stateowner * so)595 static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
596 {
597 	return container_of(so, struct nfs4_openowner, oo_owner);
598 }
599 
lockowner(struct nfs4_stateowner * so)600 static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
601 {
602 	return container_of(so, struct nfs4_lockowner, lo_owner);
603 }
604 
605 /*
606  * Per-client state indicating no. of opens and outstanding delegations
607  * on a file from a particular client.'od' stands for 'open & delegation'
608  */
609 struct nfs4_clnt_odstate {
610 	struct nfs4_client	*co_client;
611 	struct nfs4_file	*co_file;
612 	struct list_head	co_perfile;
613 	refcount_t		co_odcount;
614 };
615 
616 /*
617  * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
618  *
619  * These objects are global. nfsd keeps one instance of a nfs4_file per
620  * filehandle (though it may keep multiple file descriptors for each). Each
621  * inode can have multiple filehandles associated with it, so there is
622  * (potentially) a many to one relationship between this struct and struct
623  * inode.
624  */
625 struct nfs4_file {
626 	refcount_t		fi_ref;
627 	struct inode *		fi_inode;
628 	bool			fi_aliased;
629 	spinlock_t		fi_lock;
630 	struct rhlist_head	fi_rlist;
631 	struct list_head        fi_stateids;
632 	union {
633 		struct list_head	fi_delegations;
634 		struct rcu_head		fi_rcu;
635 	};
636 	struct list_head	fi_clnt_odstate;
637 	/* One each for O_RDONLY, O_WRONLY, O_RDWR: */
638 	struct nfsd_file	*fi_fds[3];
639 	/*
640 	 * Each open or lock stateid contributes 0-4 to the counts
641 	 * below depending on which bits are set in st_access_bitmap:
642 	 *     1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
643 	 *   + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
644 	 *   + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
645 	 */
646 	atomic_t		fi_access[2];
647 	u32			fi_share_deny;
648 	struct nfsd_file	*fi_deleg_file;
649 	int			fi_delegees;
650 	struct knfsd_fh		fi_fhandle;
651 	bool			fi_had_conflict;
652 #ifdef CONFIG_NFSD_PNFS
653 	struct list_head	fi_lo_states;
654 	atomic_t		fi_lo_recalls;
655 #endif
656 };
657 
658 /*
659  * A generic struct representing either a open or lock stateid. The nfs4_client
660  * holds a reference to each of these objects, and they in turn hold a
661  * reference to their respective stateowners. The client's reference is
662  * released in response to a close or unlock (depending on whether it's an open
663  * or lock stateid) or when the client is being destroyed.
664  *
665  * In the case of v4.0 open stateids, these objects are preserved for a little
666  * while after close in order to handle CLOSE replays. Those are eventually
667  * reclaimed via a LRU scheme by the laundromat.
668  *
669  * This object is a superset of the nfs4_stid. "ol" stands for "Open or Lock".
670  * Better suggestions welcome.
671  */
672 struct nfs4_ol_stateid {
673 	struct nfs4_stid		st_stid;
674 	struct list_head		st_perfile;
675 	struct list_head		st_perstateowner;
676 	struct list_head		st_locks;
677 	struct nfs4_stateowner		*st_stateowner;
678 	struct nfs4_clnt_odstate	*st_clnt_odstate;
679 /*
680  * These bitmasks use 3 separate bits for READ, ALLOW, and BOTH; see the
681  * comment above bmap_to_share_mode() for explanation:
682  */
683 	unsigned char			st_access_bmap;
684 	unsigned char			st_deny_bmap;
685 	struct nfs4_ol_stateid		*st_openstp;
686 	struct mutex			st_mutex;
687 };
688 
openlockstateid(struct nfs4_stid * s)689 static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
690 {
691 	return container_of(s, struct nfs4_ol_stateid, st_stid);
692 }
693 
694 struct nfs4_layout_stateid {
695 	struct nfs4_stid		ls_stid;
696 	struct list_head		ls_perclnt;
697 	struct list_head		ls_perfile;
698 	spinlock_t			ls_lock;
699 	struct list_head		ls_layouts;
700 	u32				ls_layout_type;
701 	struct nfsd_file		*ls_file;
702 	struct nfsd4_callback		ls_recall;
703 	stateid_t			ls_recall_sid;
704 	bool				ls_recalled;
705 	struct mutex			ls_mutex;
706 };
707 
layoutstateid(struct nfs4_stid * s)708 static inline struct nfs4_layout_stateid *layoutstateid(struct nfs4_stid *s)
709 {
710 	return container_of(s, struct nfs4_layout_stateid, ls_stid);
711 }
712 
713 /* flags for preprocess_seqid_op() */
714 #define RD_STATE	        0x00000010
715 #define WR_STATE	        0x00000020
716 
717 enum nfsd4_cb_op {
718 	NFSPROC4_CLNT_CB_NULL = 0,
719 	NFSPROC4_CLNT_CB_RECALL,
720 	NFSPROC4_CLNT_CB_LAYOUT,
721 	NFSPROC4_CLNT_CB_OFFLOAD,
722 	NFSPROC4_CLNT_CB_SEQUENCE,
723 	NFSPROC4_CLNT_CB_NOTIFY_LOCK,
724 	NFSPROC4_CLNT_CB_RECALL_ANY,
725 	NFSPROC4_CLNT_CB_GETATTR,
726 };
727 
728 /* Returns true iff a is later than b: */
nfsd4_stateid_generation_after(stateid_t * a,stateid_t * b)729 static inline bool nfsd4_stateid_generation_after(stateid_t *a, stateid_t *b)
730 {
731 	return (s32)(a->si_generation - b->si_generation) > 0;
732 }
733 
734 /*
735  * When a client tries to get a lock on a file, we set one of these objects
736  * on the blocking lock. When the lock becomes free, we can then issue a
737  * CB_NOTIFY_LOCK to the server.
738  */
739 struct nfsd4_blocked_lock {
740 	struct list_head	nbl_list;
741 	struct list_head	nbl_lru;
742 	time64_t		nbl_time;
743 	struct file_lock	nbl_lock;
744 	struct knfsd_fh		nbl_fh;
745 	struct nfsd4_callback	nbl_cb;
746 	struct kref		nbl_kref;
747 };
748 
749 struct nfsd4_compound_state;
750 struct nfsd_net;
751 struct nfsd4_copy;
752 
753 extern __be32 nfs4_preprocess_stateid_op(struct svc_rqst *rqstp,
754 		struct nfsd4_compound_state *cstate, struct svc_fh *fhp,
755 		stateid_t *stateid, int flags, struct nfsd_file **filp,
756 		struct nfs4_stid **cstid);
757 __be32 nfsd4_lookup_stateid(struct nfsd4_compound_state *cstate,
758 			    stateid_t *stateid, unsigned short typemask,
759 			    unsigned short statusmask,
760 			    struct nfs4_stid **s, struct nfsd_net *nn);
761 struct nfs4_stid *nfs4_alloc_stid(struct nfs4_client *cl, struct kmem_cache *slab,
762 				  void (*sc_free)(struct nfs4_stid *));
763 int nfs4_init_copy_state(struct nfsd_net *nn, struct nfsd4_copy *copy);
764 void nfs4_free_copy_state(struct nfsd4_copy *copy);
765 struct nfs4_cpntf_state *nfs4_alloc_init_cpntf_state(struct nfsd_net *nn,
766 			struct nfs4_stid *p_stid);
767 void nfs4_put_stid(struct nfs4_stid *s);
768 void nfs4_inc_and_copy_stateid(stateid_t *dst, struct nfs4_stid *stid);
769 void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
770 extern void nfs4_release_reclaim(struct nfsd_net *);
771 extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(struct xdr_netobj name,
772 							struct nfsd_net *nn);
773 extern __be32 nfs4_check_open_reclaim(struct nfs4_client *);
774 extern void nfsd4_probe_callback(struct nfs4_client *clp);
775 extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
776 extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
777 extern void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp,
778 		const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op);
779 extern bool nfsd4_run_cb(struct nfsd4_callback *cb);
780 
nfsd4_try_run_cb(struct nfsd4_callback * cb)781 static inline void nfsd4_try_run_cb(struct nfsd4_callback *cb)
782 {
783 	if (!test_and_set_bit(NFSD4_CALLBACK_RUNNING, &cb->cb_flags))
784 		WARN_ON_ONCE(!nfsd4_run_cb(cb));
785 }
786 
787 extern void nfsd4_shutdown_callback(struct nfs4_client *);
788 extern void nfsd4_shutdown_copy(struct nfs4_client *clp);
789 void nfsd4_async_copy_reaper(struct nfsd_net *nn);
790 bool nfsd4_has_active_async_copies(struct nfs4_client *clp);
791 extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(struct xdr_netobj name,
792 				struct xdr_netobj princhash, struct nfsd_net *nn);
793 extern bool nfs4_has_reclaimed_state(struct xdr_netobj name, struct nfsd_net *nn);
794 
795 void put_nfs4_file(struct nfs4_file *fi);
796 extern void nfs4_put_cpntf_state(struct nfsd_net *nn,
797 				 struct nfs4_cpntf_state *cps);
798 extern __be32 manage_cpntf_state(struct nfsd_net *nn, stateid_t *st,
799 				 struct nfs4_client *clp,
800 				 struct nfs4_cpntf_state **cps);
get_nfs4_file(struct nfs4_file * fi)801 static inline void get_nfs4_file(struct nfs4_file *fi)
802 {
803 	refcount_inc(&fi->fi_ref);
804 }
805 struct nfsd_file *find_any_file(struct nfs4_file *f);
806 
807 #ifdef CONFIG_NFSD_V4
808 void nfsd4_revoke_states(struct net *net, struct super_block *sb);
809 #else
nfsd4_revoke_states(struct net * net,struct super_block * sb)810 static inline void nfsd4_revoke_states(struct net *net, struct super_block *sb)
811 {
812 }
813 #endif
814 
815 /* grace period management */
816 void nfsd4_end_grace(struct nfsd_net *nn);
817 
818 /* nfs4recover operations */
819 extern int nfsd4_client_tracking_init(struct net *net);
820 extern void nfsd4_client_tracking_exit(struct net *net);
821 extern void nfsd4_client_record_create(struct nfs4_client *clp);
822 extern void nfsd4_client_record_remove(struct nfs4_client *clp);
823 extern int nfsd4_client_record_check(struct nfs4_client *clp);
824 extern void nfsd4_record_grace_done(struct nfsd_net *nn);
825 
try_to_expire_client(struct nfs4_client * clp)826 static inline bool try_to_expire_client(struct nfs4_client *clp)
827 {
828 	cmpxchg(&clp->cl_state, NFSD4_COURTESY, NFSD4_EXPIRABLE);
829 	return clp->cl_state == NFSD4_EXPIRABLE;
830 }
831 
832 extern __be32 nfsd4_deleg_getattr_conflict(struct svc_rqst *rqstp,
833 		struct dentry *dentry, struct nfs4_delegation **pdp);
834 #endif   /* NFSD4_STATE_H */
835