2 * Copyright (c) 2001 The Regents of the University of Michigan.
5 * Kendrick Smith <kmsmith@umich.edu>
6 * Andy Adamson <andros@umich.edu>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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.
35 #ifndef _NFSD4_STATE_H
36 #define _NFSD4_STATE_H
38 #include <linux/sunrpc/svc_xprt.h>
39 #include <linux/nfsd/nfsfh.h>
55 stateid_opaque_t si_opaque;
57 #define si_boot si_opaque.so_boot
58 #define si_stateownerid si_opaque.so_stateownerid
59 #define si_fileid si_opaque.so_fileid
61 #define STATEID_FMT "(%08x/%08x/%08x/%08x)"
62 #define STATEID_VAL(s) \
64 (s)->si_stateownerid, \
68 struct nfsd4_callback {
70 struct nfs4_client *cb_clp;
72 struct rpc_message cb_msg;
73 const struct rpc_call_ops *cb_ops;
74 struct work_struct cb_work;
77 struct nfs4_delegation {
78 struct list_head dl_perfile;
79 struct list_head dl_perclnt;
80 struct list_head dl_recall_lru; /* delegation recalled */
81 atomic_t dl_count; /* ref count */
82 struct nfs4_client *dl_client;
83 struct nfs4_file *dl_file;
84 struct file_lock *dl_flock;
89 struct knfsd_fh dl_fh;
91 struct nfsd4_callback dl_recall;
94 /* client delegation callback info */
96 /* SETCLIENTID info */
97 struct sockaddr_storage cb_addr;
101 u32 cb_ident; /* minorversion 0 only */
102 struct svc_xprt *cb_xprt; /* minorversion 1 only */
105 /* Maximum number of slots per session. 160 is useful for long haul TCP */
106 #define NFSD_MAX_SLOTS_PER_SESSION 160
107 /* Maximum number of operations per session compound */
108 #define NFSD_MAX_OPS_PER_COMPOUND 16
109 /* Maximum session per slot cache size */
110 #define NFSD_SLOT_CACHE_SIZE 1024
111 /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
112 #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
113 #define NFSD_MAX_MEM_PER_SESSION \
114 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
126 struct nfsd4_channel_attrs {
137 struct nfsd4_create_session {
139 struct nfs4_sessionid sessionid;
142 struct nfsd4_channel_attrs fore_channel;
143 struct nfsd4_channel_attrs back_channel;
149 /* The single slot clientid cache structure */
150 struct nfsd4_clid_slot {
153 struct nfsd4_create_session sl_cr_ses;
157 struct list_head cn_persession;
158 struct svc_xprt *cn_xprt;
159 struct svc_xpt_user cn_xpt_user;
160 struct nfsd4_session *cn_session;
161 /* CDFC4_FORE, CDFC4_BACK: */
162 unsigned char cn_flags;
165 struct nfsd4_session {
167 struct list_head se_hash; /* hash by sessionid */
168 struct list_head se_perclnt;
170 struct nfs4_client *se_client;
171 struct nfs4_sessionid se_sessionid;
172 struct nfsd4_channel_attrs se_fchannel;
173 struct nfsd4_channel_attrs se_bchannel;
174 struct list_head se_conns;
175 struct nfsd4_slot *se_slots[]; /* forward channel slots */
179 nfsd4_put_session(struct nfsd4_session *ses)
181 extern void free_session(struct kref *kref);
182 kref_put(&ses->se_ref, free_session);
186 nfsd4_get_session(struct nfsd4_session *ses)
188 kref_get(&ses->se_ref);
191 /* formatted contents of nfs4_sessionid */
192 struct nfsd4_sessionid {
198 #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
201 * struct nfs4_client - one per client. Clientids live here.
202 * o Each nfs4_client is hashed by clientid.
204 * o Each nfs4_clients is also hashed by name
205 * (the opaque quantity initially sent by the client to identify itself).
207 * o cl_perclient list is used to ensure no dangling stateowner references
208 * when we expire the nfs4_client
211 struct list_head cl_idhash; /* hash by cl_clientid.id */
212 struct list_head cl_strhash; /* hash by cl_name */
213 struct list_head cl_openowners;
214 struct list_head cl_delegations;
215 struct list_head cl_lru; /* tail queue */
216 struct xdr_netobj cl_name; /* id generated by client */
217 char cl_recdir[HEXDIR_LEN]; /* recovery dir */
218 nfs4_verifier cl_verifier; /* generated by client */
219 time_t cl_time; /* time of last lease renewal */
220 struct sockaddr_storage cl_addr; /* client ipaddress */
221 u32 cl_flavor; /* setclientid pseudoflavor */
222 char *cl_principal; /* setclientid principal name */
223 struct svc_cred cl_cred; /* setclientid principal */
224 clientid_t cl_clientid; /* generated by server */
225 nfs4_verifier cl_confirm; /* generated by server */
226 u32 cl_firststate; /* recovery dir creation */
228 /* for v4.0 and v4.1 callbacks: */
229 struct nfs4_cb_conn cl_cb_conn;
230 #define NFSD4_CLIENT_CB_UPDATE 1
231 #define NFSD4_CLIENT_KILL 2
232 unsigned long cl_cb_flags;
233 struct rpc_clnt *cl_cb_client;
236 struct nfsd4_callback cl_cb_null;
237 struct nfsd4_session *cl_cb_session;
239 /* for all client information that callback code might need: */
243 struct list_head cl_sessions;
244 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
245 u32 cl_exchange_flags;
246 struct nfs4_sessionid cl_sessionid;
247 /* number of rpc's in progress over an associated session: */
248 atomic_t cl_refcount;
250 /* for nfs41 callbacks */
251 /* We currently support a single back channel with a single slot */
252 unsigned long cl_cb_slot_busy;
254 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
255 /* wait here for slots */
259 mark_client_expired(struct nfs4_client *clp)
265 is_client_expired(struct nfs4_client *clp)
267 return clp->cl_time == 0;
270 /* struct nfs4_client_reset
271 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
272 * upon lease reset, or from upcall to state_daemon (to read in state
273 * from non-volitile storage) upon reboot.
275 struct nfs4_client_reclaim {
276 struct list_head cr_strhash; /* hash by cr_name */
277 char cr_recdir[HEXDIR_LEN]; /* recover dir */
281 update_stateid(stateid_t *stateid)
283 stateid->si_generation++;
286 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
287 * The OPEN response, typically the largest, requires
288 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
289 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
290 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
293 #define NFSD4_REPLAY_ISIZE 112
296 * Replay buffer, where the result of the last seqid-mutating operation
301 unsigned int rp_buflen;
303 unsigned intrp_allocated;
304 struct knfsd_fh rp_openfh;
305 char rp_ibuf[NFSD4_REPLAY_ISIZE];
309 * nfs4_stateowner can either be an open_owner, or a lock_owner
311 * so_idhash: stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
313 * so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
315 * so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
317 * so_perfilestate: heads the list of nfs4_stateid (either open or lock)
318 * and is used to ensure no dangling nfs4_stateid references when we
319 * release a stateowner.
320 * so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
321 * close is called to reap associated byte-range locks
322 * so_close_lru: (open) stateowner is placed on this list instead of being
323 * reaped (when so_perfilestate is empty) to hold the last close replay.
324 * reaped by laundramat thread after lease period.
326 struct nfs4_stateowner {
328 struct list_head so_idhash; /* hash by so_id */
329 struct list_head so_strhash; /* hash by op_name */
330 struct list_head so_perclient;
331 struct list_head so_stateids;
332 struct list_head so_perstateid; /* for lockowners only */
333 struct list_head so_close_lru; /* tail queue */
334 time_t so_time; /* time of placement on so_close_lru */
335 int so_is_open_owner; /* 1=openowner,0=lockowner */
337 struct nfs4_client * so_client;
338 /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
339 * sequence id expected from the client: */
341 struct xdr_netobj so_owner; /* open owner name */
342 int so_confirmed; /* successful OPEN_CONFIRM? */
343 struct nfs4_replay so_replay;
347 * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
348 * o fi_perfile list is used to search for conflicting
349 * share_acces, share_deny on the file.
353 struct list_head fi_hash; /* hash by "struct inode *" */
354 struct list_head fi_stateids;
355 struct list_head fi_delegations;
356 /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
357 struct file * fi_fds[3];
358 /* One each for O_RDONLY, O_WRONLY: */
359 atomic_t fi_access[2];
361 * Each open stateid contributes 1 to either fi_readers or
362 * fi_writers, or both, depending on the open mode. A
363 * delegation also takes an fi_readers reference. Lock
364 * stateid's take none.
368 struct inode *fi_inode;
369 u32 fi_id; /* used with stateowner->so_id
370 * for stateid_hashtbl hash */
371 bool fi_had_conflict;
374 /* XXX: for first cut may fall back on returning file that doesn't work
376 static inline struct file *find_writeable_file(struct nfs4_file *f)
378 if (f->fi_fds[O_WRONLY])
379 return f->fi_fds[O_WRONLY];
380 return f->fi_fds[O_RDWR];
383 static inline struct file *find_readable_file(struct nfs4_file *f)
385 if (f->fi_fds[O_RDONLY])
386 return f->fi_fds[O_RDONLY];
387 return f->fi_fds[O_RDWR];
390 static inline struct file *find_any_file(struct nfs4_file *f)
392 if (f->fi_fds[O_RDWR])
393 return f->fi_fds[O_RDWR];
394 else if (f->fi_fds[O_WRONLY])
395 return f->fi_fds[O_WRONLY];
397 return f->fi_fds[O_RDONLY];
401 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
403 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
405 * st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
406 * st_perfile: file_hashtbl[] entry.
407 * st_perfile_state: nfs4_stateowner->so_perfilestate
408 * st_perlockowner: (open stateid) list of lock nfs4_stateowners
409 * st_access_bmap: used only for open stateid
410 * st_deny_bmap: used only for open stateid
411 * st_openstp: open stateid lock stateid was derived from
413 * XXX: open stateids and lock stateids have diverged sufficiently that
414 * we should consider defining separate structs for the two cases.
417 struct nfs4_stateid {
418 struct list_head st_hash;
419 struct list_head st_perfile;
420 struct list_head st_perstateowner;
421 struct list_head st_lockowners;
422 struct nfs4_stateowner * st_stateowner;
423 struct nfs4_file * st_file;
424 stateid_t st_stateid;
425 unsigned long st_access_bmap;
426 unsigned long st_deny_bmap;
427 struct nfs4_stateid * st_openstp;
430 /* flags for preprocess_seqid_op() */
431 #define HAS_SESSION 0x00000001
432 #define CONFIRM 0x00000002
433 #define OPEN_STATE 0x00000004
434 #define LOCK_STATE 0x00000008
435 #define RD_STATE 0x00000010
436 #define WR_STATE 0x00000020
437 #define CLOSE_STATE 0x00000040
439 #define seqid_mutating_err(err) \
440 (((err) != nfserr_stale_clientid) && \
441 ((err) != nfserr_bad_seqid) && \
442 ((err) != nfserr_stale_stateid) && \
443 ((err) != nfserr_bad_stateid))
445 struct nfsd4_compound_state;
447 extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
448 stateid_t *stateid, int flags, struct file **filp);
449 extern void nfs4_lock_state(void);
450 extern void nfs4_unlock_state(void);
451 extern int nfs4_in_grace(void);
452 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
453 extern void nfs4_free_stateowner(struct kref *kref);
454 extern int set_callback_cred(void);
455 extern void nfsd4_probe_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
456 extern void nfsd4_do_callback_rpc(struct work_struct *);
457 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
458 extern int nfsd4_create_callback_queue(void);
459 extern void nfsd4_destroy_callback_queue(void);
460 extern void nfsd4_shutdown_callback(struct nfs4_client *);
461 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
462 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
463 extern void nfsd4_init_recdir(char *recdir_name);
464 extern int nfsd4_recdir_load(void);
465 extern void nfsd4_shutdown_recdir(void);
466 extern int nfs4_client_to_reclaim(const char *name);
467 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
468 extern void nfsd4_recdir_purge_old(void);
469 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
470 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
471 extern void release_session_client(struct nfsd4_session *);
474 nfs4_put_stateowner(struct nfs4_stateowner *so)
476 kref_put(&so->so_ref, nfs4_free_stateowner);
480 nfs4_get_stateowner(struct nfs4_stateowner *so)
482 kref_get(&so->so_ref);
485 #endif /* NFSD4_STATE_H */