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