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