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