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