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 | ||
72579ac9 | 38 | #include <linux/nfsd/nfsfh.h> |
1557aca7 | 39 | #include "nfsfh.h" |
1da177e4 | 40 | |
1da177e4 LT |
41 | typedef struct { |
42 | u32 cl_boot; | |
43 | u32 cl_id; | |
44 | } clientid_t; | |
45 | ||
46 | typedef struct { | |
47 | u32 so_boot; | |
48 | u32 so_stateownerid; | |
49 | u32 so_fileid; | |
50 | } stateid_opaque_t; | |
51 | ||
52 | typedef struct { | |
53 | u32 si_generation; | |
54 | stateid_opaque_t si_opaque; | |
55 | } stateid_t; | |
56 | #define si_boot si_opaque.so_boot | |
57 | #define si_stateownerid si_opaque.so_stateownerid | |
58 | #define si_fileid si_opaque.so_fileid | |
59 | ||
8c10cbdb BH |
60 | #define STATEID_FMT "(%08x/%08x/%08x/%08x)" |
61 | #define STATEID_VAL(s) \ | |
62 | (s)->si_boot, \ | |
63 | (s)->si_stateownerid, \ | |
64 | (s)->si_fileid, \ | |
65 | (s)->si_generation | |
66 | ||
132f9771 RL |
67 | struct nfsd4_cb_sequence { |
68 | /* args/res */ | |
69 | u32 cbs_minorversion; | |
70 | struct nfs4_client *cbs_clp; | |
71 | }; | |
72 | ||
227f98d9 BF |
73 | struct nfs4_rpc_args { |
74 | void *args_op; | |
75 | struct nfsd4_cb_sequence args_seq; | |
76 | }; | |
77 | ||
78 | struct nfsd4_callback { | |
79 | struct nfs4_rpc_args cb_args; | |
b5a1a81e | 80 | struct work_struct cb_work; |
227f98d9 BF |
81 | }; |
82 | ||
1da177e4 | 83 | struct nfs4_delegation { |
ea1da636 N |
84 | struct list_head dl_perfile; |
85 | struct list_head dl_perclnt; | |
1da177e4 LT |
86 | struct list_head dl_recall_lru; /* delegation recalled */ |
87 | atomic_t dl_count; /* ref count */ | |
88 | struct nfs4_client *dl_client; | |
89 | struct nfs4_file *dl_file; | |
90 | struct file_lock *dl_flock; | |
91 | struct file *dl_vfs_file; | |
92 | u32 dl_type; | |
93 | time_t dl_time; | |
b53d40c5 BF |
94 | /* For recall: */ |
95 | u32 dl_ident; | |
b53d40c5 BF |
96 | stateid_t dl_stateid; |
97 | struct knfsd_fh dl_fh; | |
3aea09dc | 98 | int dl_retries; |
227f98d9 | 99 | struct nfsd4_callback dl_recall; |
1da177e4 LT |
100 | }; |
101 | ||
1da177e4 | 102 | /* client delegation callback info */ |
c237dc03 | 103 | struct nfs4_cb_conn { |
1da177e4 | 104 | /* SETCLIENTID info */ |
aa9a4ec7 JL |
105 | struct sockaddr_storage cb_addr; |
106 | size_t cb_addrlen; | |
1da177e4 | 107 | u32 cb_prog; |
ab52ae6d AA |
108 | u32 cb_minorversion; |
109 | u32 cb_ident; /* minorversion 0 only */ | |
1da177e4 LT |
110 | /* RPC client info */ |
111 | atomic_t cb_set; /* successful CB_NULL call */ | |
1da177e4 LT |
112 | struct rpc_clnt * cb_client; |
113 | }; | |
114 | ||
a649637c AA |
115 | /* Maximum number of slots per session. 160 is useful for long haul TCP */ |
116 | #define NFSD_MAX_SLOTS_PER_SESSION 160 | |
ec6b5d7b AA |
117 | /* Maximum number of operations per session compound */ |
118 | #define NFSD_MAX_OPS_PER_COMPOUND 16 | |
557ce264 AA |
119 | /* Maximum session per slot cache size */ |
120 | #define NFSD_SLOT_CACHE_SIZE 1024 | |
a649637c AA |
121 | /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */ |
122 | #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32 | |
123 | #define NFSD_MAX_MEM_PER_SESSION \ | |
124 | (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE) | |
074fe897 | 125 | |
7116ed6b | 126 | struct nfsd4_slot { |
557ce264 AA |
127 | bool sl_inuse; |
128 | bool sl_cachethis; | |
129 | u16 sl_opcnt; | |
130 | u32 sl_seqid; | |
131 | __be32 sl_status; | |
132 | u32 sl_datalen; | |
133 | char sl_data[]; | |
7116ed6b AA |
134 | }; |
135 | ||
6c18ba9f AB |
136 | struct nfsd4_channel_attrs { |
137 | u32 headerpadsz; | |
138 | u32 maxreq_sz; | |
139 | u32 maxresp_sz; | |
140 | u32 maxresp_cached; | |
141 | u32 maxops; | |
142 | u32 maxreqs; | |
143 | u32 nr_rdma_attrs; | |
144 | u32 rdma_attrs; | |
145 | }; | |
146 | ||
49557cc7 AA |
147 | struct nfsd4_create_session { |
148 | clientid_t clientid; | |
149 | struct nfs4_sessionid sessionid; | |
150 | u32 seqid; | |
151 | u32 flags; | |
152 | struct nfsd4_channel_attrs fore_channel; | |
153 | struct nfsd4_channel_attrs back_channel; | |
154 | u32 callback_prog; | |
155 | u32 uid; | |
156 | u32 gid; | |
157 | }; | |
158 | ||
159 | /* The single slot clientid cache structure */ | |
160 | struct nfsd4_clid_slot { | |
161 | u32 sl_seqid; | |
162 | __be32 sl_status; | |
163 | struct nfsd4_create_session sl_cr_ses; | |
164 | }; | |
165 | ||
7116ed6b AA |
166 | struct nfsd4_session { |
167 | struct kref se_ref; | |
168 | struct list_head se_hash; /* hash by sessionid */ | |
169 | struct list_head se_perclnt; | |
170 | u32 se_flags; | |
171 | struct nfs4_client *se_client; /* for expire_client */ | |
172 | struct nfs4_sessionid se_sessionid; | |
6c18ba9f AB |
173 | struct nfsd4_channel_attrs se_fchannel; |
174 | struct nfsd4_channel_attrs se_bchannel; | |
557ce264 | 175 | struct nfsd4_slot *se_slots[]; /* forward channel slots */ |
7116ed6b AA |
176 | }; |
177 | ||
178 | static inline void | |
179 | nfsd4_put_session(struct nfsd4_session *ses) | |
180 | { | |
181 | extern void free_session(struct kref *kref); | |
182 | kref_put(&ses->se_ref, free_session); | |
183 | } | |
184 | ||
185 | static inline void | |
186 | nfsd4_get_session(struct nfsd4_session *ses) | |
187 | { | |
188 | kref_get(&ses->se_ref); | |
189 | } | |
190 | ||
5282fd72 ME |
191 | /* formatted contents of nfs4_sessionid */ |
192 | struct nfsd4_sessionid { | |
193 | clientid_t clientid; | |
194 | u32 sequence; | |
195 | u32 reserved; | |
196 | }; | |
197 | ||
a55370a3 N |
198 | #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */ |
199 | ||
1da177e4 LT |
200 | /* |
201 | * struct nfs4_client - one per client. Clientids live here. | |
202 | * o Each nfs4_client is hashed by clientid. | |
203 | * | |
204 | * o Each nfs4_clients is also hashed by name | |
205 | * (the opaque quantity initially sent by the client to identify itself). | |
206 | * | |
207 | * o cl_perclient list is used to ensure no dangling stateowner references | |
208 | * when we expire the nfs4_client | |
209 | */ | |
210 | struct nfs4_client { | |
211 | struct list_head cl_idhash; /* hash by cl_clientid.id */ | |
212 | struct list_head cl_strhash; /* hash by cl_name */ | |
ea1da636 N |
213 | struct list_head cl_openowners; |
214 | struct list_head cl_delegations; | |
1da177e4 LT |
215 | struct list_head cl_lru; /* tail queue */ |
216 | struct xdr_netobj cl_name; /* id generated by client */ | |
a55370a3 | 217 | char cl_recdir[HEXDIR_LEN]; /* recovery dir */ |
1da177e4 LT |
218 | nfs4_verifier cl_verifier; /* generated by client */ |
219 | time_t cl_time; /* time of last lease renewal */ | |
363168b4 | 220 | struct sockaddr_storage cl_addr; /* client ipaddress */ |
61054b14 | 221 | u32 cl_flavor; /* setclientid pseudoflavor */ |
68e76ad0 | 222 | char *cl_principal; /* setclientid principal name */ |
1da177e4 LT |
223 | struct svc_cred cl_cred; /* setclientid principal */ |
224 | clientid_t cl_clientid; /* generated by server */ | |
225 | nfs4_verifier cl_confirm; /* generated by server */ | |
c237dc03 | 226 | struct nfs4_cb_conn cl_cb_conn; /* callback info */ |
1da177e4 | 227 | atomic_t cl_count; /* ref count */ |
c7b9a459 | 228 | u32 cl_firststate; /* recovery dir creation */ |
9fb87070 ME |
229 | |
230 | /* for nfs41 */ | |
231 | struct list_head cl_sessions; | |
49557cc7 | 232 | struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */ |
0733d213 | 233 | u32 cl_exchange_flags; |
ec6b5d7b | 234 | struct nfs4_sessionid cl_sessionid; |
38524ab3 AA |
235 | |
236 | /* for nfs41 callbacks */ | |
199ff35e RL |
237 | /* We currently support a single back channel with a single slot */ |
238 | unsigned long cl_cb_slot_busy; | |
2a1d1b59 | 239 | u32 cl_cb_seq_nr; |
38524ab3 | 240 | struct svc_xprt *cl_cb_xprt; /* 4.1 callback transport */ |
199ff35e RL |
241 | struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */ |
242 | /* wait here for slots */ | |
1da177e4 LT |
243 | }; |
244 | ||
245 | /* struct nfs4_client_reset | |
246 | * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl | |
247 | * upon lease reset, or from upcall to state_daemon (to read in state | |
248 | * from non-volitile storage) upon reboot. | |
249 | */ | |
250 | struct nfs4_client_reclaim { | |
251 | struct list_head cr_strhash; /* hash by cr_name */ | |
a55370a3 | 252 | char cr_recdir[HEXDIR_LEN]; /* recover dir */ |
1da177e4 LT |
253 | }; |
254 | ||
255 | static inline void | |
256 | update_stateid(stateid_t *stateid) | |
257 | { | |
258 | stateid->si_generation++; | |
259 | } | |
260 | ||
261 | /* A reasonable value for REPLAY_ISIZE was estimated as follows: | |
262 | * The OPEN response, typically the largest, requires | |
263 | * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) + | |
264 | * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) + | |
265 | * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes | |
266 | */ | |
267 | ||
268 | #define NFSD4_REPLAY_ISIZE 112 | |
269 | ||
270 | /* | |
271 | * Replay buffer, where the result of the last seqid-mutating operation | |
272 | * is cached. | |
273 | */ | |
274 | struct nfs4_replay { | |
b37ad28b | 275 | __be32 rp_status; |
1da177e4 LT |
276 | unsigned int rp_buflen; |
277 | char *rp_buf; | |
278 | unsigned intrp_allocated; | |
a4773c08 | 279 | struct knfsd_fh rp_openfh; |
1da177e4 LT |
280 | char rp_ibuf[NFSD4_REPLAY_ISIZE]; |
281 | }; | |
282 | ||
283 | /* | |
284 | * nfs4_stateowner can either be an open_owner, or a lock_owner | |
285 | * | |
286 | * so_idhash: stateid_hashtbl[] for open owner, lockstateid_hashtbl[] | |
287 | * for lock_owner | |
288 | * so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[] | |
289 | * for lock_owner | |
290 | * so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client | |
291 | * struct is reaped. | |
292 | * so_perfilestate: heads the list of nfs4_stateid (either open or lock) | |
293 | * and is used to ensure no dangling nfs4_stateid references when we | |
294 | * release a stateowner. | |
295 | * so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when | |
296 | * close is called to reap associated byte-range locks | |
297 | * so_close_lru: (open) stateowner is placed on this list instead of being | |
298 | * reaped (when so_perfilestate is empty) to hold the last close replay. | |
299 | * reaped by laundramat thread after lease period. | |
300 | */ | |
301 | struct nfs4_stateowner { | |
302 | struct kref so_ref; | |
303 | struct list_head so_idhash; /* hash by so_id */ | |
304 | struct list_head so_strhash; /* hash by op_name */ | |
ea1da636 N |
305 | struct list_head so_perclient; |
306 | struct list_head so_stateids; | |
307 | struct list_head so_perstateid; /* for lockowners only */ | |
1da177e4 LT |
308 | struct list_head so_close_lru; /* tail queue */ |
309 | time_t so_time; /* time of placement on so_close_lru */ | |
310 | int so_is_open_owner; /* 1=openowner,0=lockowner */ | |
311 | u32 so_id; | |
312 | struct nfs4_client * so_client; | |
7fb64cee N |
313 | /* after increment in ENCODE_SEQID_OP_TAIL, represents the next |
314 | * sequence id expected from the client: */ | |
315 | u32 so_seqid; | |
1da177e4 LT |
316 | struct xdr_netobj so_owner; /* open owner name */ |
317 | int so_confirmed; /* successful OPEN_CONFIRM? */ | |
318 | struct nfs4_replay so_replay; | |
319 | }; | |
320 | ||
321 | /* | |
322 | * nfs4_file: a file opened by some number of (open) nfs4_stateowners. | |
323 | * o fi_perfile list is used to search for conflicting | |
324 | * share_acces, share_deny on the file. | |
325 | */ | |
326 | struct nfs4_file { | |
8b671b80 | 327 | atomic_t fi_ref; |
1da177e4 | 328 | struct list_head fi_hash; /* hash by "struct inode *" */ |
8beefa24 N |
329 | struct list_head fi_stateids; |
330 | struct list_head fi_delegations; | |
1da177e4 LT |
331 | struct inode *fi_inode; |
332 | u32 fi_id; /* used with stateowner->so_id | |
333 | * for stateid_hashtbl hash */ | |
47f9940c | 334 | bool fi_had_conflict; |
1da177e4 LT |
335 | }; |
336 | ||
337 | /* | |
338 | * nfs4_stateid can either be an open stateid or (eventually) a lock stateid | |
339 | * | |
340 | * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file | |
341 | * | |
342 | * st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry | |
343 | * st_perfile: file_hashtbl[] entry. | |
344 | * st_perfile_state: nfs4_stateowner->so_perfilestate | |
345 | * st_perlockowner: (open stateid) list of lock nfs4_stateowners | |
346 | * st_access_bmap: used only for open stateid | |
347 | * st_deny_bmap: used only for open stateid | |
4c4cd222 N |
348 | * st_openstp: open stateid lock stateid was derived from |
349 | * | |
350 | * XXX: open stateids and lock stateids have diverged sufficiently that | |
351 | * we should consider defining separate structs for the two cases. | |
1da177e4 LT |
352 | */ |
353 | ||
354 | struct nfs4_stateid { | |
355 | struct list_head st_hash; | |
356 | struct list_head st_perfile; | |
ea1da636 N |
357 | struct list_head st_perstateowner; |
358 | struct list_head st_lockowners; | |
1da177e4 LT |
359 | struct nfs4_stateowner * st_stateowner; |
360 | struct nfs4_file * st_file; | |
361 | stateid_t st_stateid; | |
362 | struct file * st_vfs_file; | |
363 | unsigned long st_access_bmap; | |
364 | unsigned long st_deny_bmap; | |
4c4cd222 | 365 | struct nfs4_stateid * st_openstp; |
1da177e4 LT |
366 | }; |
367 | ||
368 | /* flags for preprocess_seqid_op() */ | |
6668958f | 369 | #define HAS_SESSION 0x00000001 |
1da177e4 LT |
370 | #define CONFIRM 0x00000002 |
371 | #define OPEN_STATE 0x00000004 | |
372 | #define LOCK_STATE 0x00000008 | |
373 | #define RD_STATE 0x00000010 | |
374 | #define WR_STATE 0x00000020 | |
375 | #define CLOSE_STATE 0x00000040 | |
1da177e4 LT |
376 | |
377 | #define seqid_mutating_err(err) \ | |
378 | (((err) != nfserr_stale_clientid) && \ | |
379 | ((err) != nfserr_bad_seqid) && \ | |
380 | ((err) != nfserr_stale_stateid) && \ | |
381 | ((err) != nfserr_bad_stateid)) | |
382 | ||
dd453dfd BH |
383 | struct nfsd4_compound_state; |
384 | ||
385 | extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate, | |
1da177e4 | 386 | stateid_t *stateid, int flags, struct file **filp); |
1da177e4 LT |
387 | extern void nfs4_lock_state(void); |
388 | extern void nfs4_unlock_state(void); | |
389 | extern int nfs4_in_grace(void); | |
b37ad28b | 390 | extern __be32 nfs4_check_open_reclaim(clientid_t *clid); |
1da177e4 LT |
391 | extern void put_nfs4_client(struct nfs4_client *clp); |
392 | extern void nfs4_free_stateowner(struct kref *kref); | |
80fc015b | 393 | extern int set_callback_cred(void); |
1da177e4 | 394 | extern void nfsd4_probe_callback(struct nfs4_client *clp); |
b5a1a81e | 395 | extern void nfsd4_do_callback_rpc(struct work_struct *); |
1da177e4 | 396 | extern void nfsd4_cb_recall(struct nfs4_delegation *dp); |
b5a1a81e BF |
397 | extern int nfsd4_create_callback_queue(void); |
398 | extern void nfsd4_destroy_callback_queue(void); | |
399 | extern void nfsd4_set_callback_client(struct nfs4_client *, struct rpc_clnt *); | |
1da177e4 | 400 | extern void nfs4_put_delegation(struct nfs4_delegation *dp); |
b37ad28b | 401 | extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname); |
190e4fbf N |
402 | extern void nfsd4_init_recdir(char *recdir_name); |
403 | extern int nfsd4_recdir_load(void); | |
404 | extern void nfsd4_shutdown_recdir(void); | |
405 | extern int nfs4_client_to_reclaim(const char *name); | |
a1bcecd2 | 406 | extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id); |
c7b9a459 N |
407 | extern void nfsd4_recdir_purge_old(void); |
408 | extern int nfsd4_create_clid_dir(struct nfs4_client *clp); | |
409 | extern void nfsd4_remove_clid_dir(struct nfs4_client *clp); | |
1da177e4 LT |
410 | |
411 | static inline void | |
412 | nfs4_put_stateowner(struct nfs4_stateowner *so) | |
413 | { | |
414 | kref_put(&so->so_ref, nfs4_free_stateowner); | |
415 | } | |
416 | ||
417 | static inline void | |
418 | nfs4_get_stateowner(struct nfs4_stateowner *so) | |
419 | { | |
420 | kref_get(&so->so_ref); | |
421 | } | |
422 | ||
423 | #endif /* NFSD4_STATE_H */ |