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