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

source code of linux/fs/nfsd/state.h