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