2 * linux/include/nfsd/state.h
4 * Copyright (c) 2001 The Regents of the University of Michigan.
7 * Kendrick Smith <kmsmith@umich.edu>
8 * Andy Adamson <andros@umich.edu>
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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.
37 #ifndef _NFSD4_STATE_H
38 #define _NFSD4_STATE_H
40 #include <linux/list.h>
41 #include <linux/kref.h>
42 #include <linux/sunrpc/clnt.h>
57 stateid_opaque_t si_opaque;
59 #define si_boot si_opaque.so_boot
60 #define si_stateownerid si_opaque.so_stateownerid
61 #define si_fileid si_opaque.so_fileid
63 struct nfs4_delegation {
64 struct list_head dl_perfile;
65 struct list_head dl_perclnt;
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;
77 struct knfsd_fh dl_fh;
81 /* client delegation callback info */
83 /* SETCLIENTID info */
84 struct sockaddr_storage cb_addr;
88 u32 cb_ident; /* minorversion 0 only */
90 atomic_t cb_set; /* successful CB_NULL call */
91 struct rpc_clnt * cb_client;
92 struct rpc_cred * cb_cred;
95 /* Maximum number of slots per session. 160 is useful for long haul TCP */
96 #define NFSD_MAX_SLOTS_PER_SESSION 160
97 /* Maximum number of pages per slot cache entry */
98 #define NFSD_PAGES_PER_SLOT 1
99 #define NFSD_SLOT_CACHE_SIZE PAGE_SIZE
100 /* Maximum number of operations per session compound */
101 #define NFSD_MAX_OPS_PER_COMPOUND 16
102 /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
103 #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
104 #define NFSD_MAX_MEM_PER_SESSION \
105 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
107 struct nfsd4_cache_entry {
109 struct kvec ce_datav; /* encoded NFSv4.1 data in rq_res.head[0] */
110 struct page *ce_respages[NFSD_PAGES_PER_SLOT + 1];
120 struct nfsd4_cache_entry sl_cache_entry;
123 struct nfsd4_channel_attrs {
134 struct nfsd4_create_session {
136 struct nfs4_sessionid sessionid;
139 struct nfsd4_channel_attrs fore_channel;
140 struct nfsd4_channel_attrs back_channel;
146 /* The single slot clientid cache structure */
147 struct nfsd4_clid_slot {
150 struct nfsd4_create_session sl_cr_ses;
153 struct nfsd4_session {
155 struct list_head se_hash; /* hash by sessionid */
156 struct list_head se_perclnt;
158 struct nfs4_client *se_client; /* for expire_client */
159 struct nfs4_sessionid se_sessionid;
160 struct nfsd4_channel_attrs se_fchannel;
161 struct nfsd4_channel_attrs se_bchannel;
162 struct nfsd4_slot se_slots[]; /* forward channel slots */
166 nfsd4_put_session(struct nfsd4_session *ses)
168 extern void free_session(struct kref *kref);
169 kref_put(&ses->se_ref, free_session);
173 nfsd4_get_session(struct nfsd4_session *ses)
175 kref_get(&ses->se_ref);
178 /* formatted contents of nfs4_sessionid */
179 struct nfsd4_sessionid {
185 #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
188 * struct nfs4_client - one per client. Clientids live here.
189 * o Each nfs4_client is hashed by clientid.
191 * o Each nfs4_clients is also hashed by name
192 * (the opaque quantity initially sent by the client to identify itself).
194 * o cl_perclient list is used to ensure no dangling stateowner references
195 * when we expire the nfs4_client
198 struct list_head cl_idhash; /* hash by cl_clientid.id */
199 struct list_head cl_strhash; /* hash by cl_name */
200 struct list_head cl_openowners;
201 struct list_head cl_delegations;
202 struct list_head cl_lru; /* tail queue */
203 struct xdr_netobj cl_name; /* id generated by client */
204 char cl_recdir[HEXDIR_LEN]; /* recovery dir */
205 nfs4_verifier cl_verifier; /* generated by client */
206 time_t cl_time; /* time of last lease renewal */
207 struct sockaddr_storage cl_addr; /* client ipaddress */
208 u32 cl_flavor; /* setclientid pseudoflavor */
209 char *cl_principal; /* setclientid principal name */
210 struct svc_cred cl_cred; /* setclientid principal */
211 clientid_t cl_clientid; /* generated by server */
212 nfs4_verifier cl_confirm; /* generated by server */
213 struct nfs4_cb_conn cl_cb_conn; /* callback info */
214 atomic_t cl_count; /* ref count */
215 u32 cl_firststate; /* recovery dir creation */
218 struct list_head cl_sessions;
219 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
220 u32 cl_exchange_flags;
221 struct nfs4_sessionid cl_sessionid;
224 /* struct nfs4_client_reset
225 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
226 * upon lease reset, or from upcall to state_daemon (to read in state
227 * from non-volitile storage) upon reboot.
229 struct nfs4_client_reclaim {
230 struct list_head cr_strhash; /* hash by cr_name */
231 char cr_recdir[HEXDIR_LEN]; /* recover dir */
235 update_stateid(stateid_t *stateid)
237 stateid->si_generation++;
240 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
241 * The OPEN response, typically the largest, requires
242 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
243 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
244 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
247 #define NFSD4_REPLAY_ISIZE 112
250 * Replay buffer, where the result of the last seqid-mutating operation
255 unsigned int rp_buflen;
257 unsigned intrp_allocated;
258 struct knfsd_fh rp_openfh;
259 char rp_ibuf[NFSD4_REPLAY_ISIZE];
263 * nfs4_stateowner can either be an open_owner, or a lock_owner
265 * so_idhash: stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
267 * so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
269 * so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
271 * so_perfilestate: heads the list of nfs4_stateid (either open or lock)
272 * and is used to ensure no dangling nfs4_stateid references when we
273 * release a stateowner.
274 * so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
275 * close is called to reap associated byte-range locks
276 * so_close_lru: (open) stateowner is placed on this list instead of being
277 * reaped (when so_perfilestate is empty) to hold the last close replay.
278 * reaped by laundramat thread after lease period.
280 struct nfs4_stateowner {
282 struct list_head so_idhash; /* hash by so_id */
283 struct list_head so_strhash; /* hash by op_name */
284 struct list_head so_perclient;
285 struct list_head so_stateids;
286 struct list_head so_perstateid; /* for lockowners only */
287 struct list_head so_close_lru; /* tail queue */
288 time_t so_time; /* time of placement on so_close_lru */
289 int so_is_open_owner; /* 1=openowner,0=lockowner */
291 struct nfs4_client * so_client;
292 /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
293 * sequence id expected from the client: */
295 struct xdr_netobj so_owner; /* open owner name */
296 int so_confirmed; /* successful OPEN_CONFIRM? */
297 struct nfs4_replay so_replay;
301 * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
302 * o fi_perfile list is used to search for conflicting
303 * share_acces, share_deny on the file.
307 struct list_head fi_hash; /* hash by "struct inode *" */
308 struct list_head fi_stateids;
309 struct list_head fi_delegations;
310 struct inode *fi_inode;
311 u32 fi_id; /* used with stateowner->so_id
312 * for stateid_hashtbl hash */
313 bool fi_had_conflict;
317 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
319 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
321 * st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
322 * st_perfile: file_hashtbl[] entry.
323 * st_perfile_state: nfs4_stateowner->so_perfilestate
324 * st_perlockowner: (open stateid) list of lock nfs4_stateowners
325 * st_access_bmap: used only for open stateid
326 * st_deny_bmap: used only for open stateid
327 * st_openstp: open stateid lock stateid was derived from
329 * XXX: open stateids and lock stateids have diverged sufficiently that
330 * we should consider defining separate structs for the two cases.
333 struct nfs4_stateid {
334 struct list_head st_hash;
335 struct list_head st_perfile;
336 struct list_head st_perstateowner;
337 struct list_head st_lockowners;
338 struct nfs4_stateowner * st_stateowner;
339 struct nfs4_file * st_file;
340 stateid_t st_stateid;
341 struct file * st_vfs_file;
342 unsigned long st_access_bmap;
343 unsigned long st_deny_bmap;
344 struct nfs4_stateid * st_openstp;
347 /* flags for preprocess_seqid_op() */
348 #define HAS_SESSION 0x00000001
349 #define CONFIRM 0x00000002
350 #define OPEN_STATE 0x00000004
351 #define LOCK_STATE 0x00000008
352 #define RD_STATE 0x00000010
353 #define WR_STATE 0x00000020
354 #define CLOSE_STATE 0x00000040
356 #define seqid_mutating_err(err) \
357 (((err) != nfserr_stale_clientid) && \
358 ((err) != nfserr_bad_seqid) && \
359 ((err) != nfserr_stale_stateid) && \
360 ((err) != nfserr_bad_stateid))
362 struct nfsd4_compound_state;
364 extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
365 stateid_t *stateid, int flags, struct file **filp);
366 extern void nfs4_lock_state(void);
367 extern void nfs4_unlock_state(void);
368 extern int nfs4_in_grace(void);
369 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
370 extern void put_nfs4_client(struct nfs4_client *clp);
371 extern void nfs4_free_stateowner(struct kref *kref);
372 extern void nfsd4_probe_callback(struct nfs4_client *clp);
373 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
374 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
375 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
376 extern void nfsd4_init_recdir(char *recdir_name);
377 extern int nfsd4_recdir_load(void);
378 extern void nfsd4_shutdown_recdir(void);
379 extern int nfs4_client_to_reclaim(const char *name);
380 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
381 extern void nfsd4_recdir_purge_old(void);
382 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
383 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
386 nfs4_put_stateowner(struct nfs4_stateowner *so)
388 kref_put(&so->so_ref, nfs4_free_stateowner);
392 nfs4_get_stateowner(struct nfs4_stateowner *so)
394 kref_get(&so->so_ref);
397 #endif /* NFSD4_STATE_H */