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