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