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 *dl_vfs_file;
85 struct file_lock *dl_flock;
90 struct knfsd_fh dl_fh;
92 struct nfsd4_callback dl_recall;
95 /* client delegation callback info */
97 /* SETCLIENTID info */
98 struct sockaddr_storage cb_addr;
100 u32 cb_prog; /* used only in 4.0 case;
101 per-session otherwise */
102 u32 cb_ident; /* minorversion 0 only */
103 struct svc_xprt *cb_xprt; /* minorversion 1 only */
106 /* Maximum number of slots per session. 160 is useful for long haul TCP */
107 #define NFSD_MAX_SLOTS_PER_SESSION 160
108 /* Maximum number of operations per session compound */
109 #define NFSD_MAX_OPS_PER_COMPOUND 16
110 /* Maximum session per slot cache size */
111 #define NFSD_SLOT_CACHE_SIZE 1024
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)
127 struct nfsd4_channel_attrs {
138 struct nfsd4_create_session {
140 struct nfs4_sessionid sessionid;
143 struct nfsd4_channel_attrs fore_channel;
144 struct nfsd4_channel_attrs back_channel;
150 /* The single slot clientid cache structure */
151 struct nfsd4_clid_slot {
154 struct nfsd4_create_session sl_cr_ses;
158 struct list_head cn_persession;
159 struct svc_xprt *cn_xprt;
160 struct svc_xpt_user cn_xpt_user;
161 struct nfsd4_session *cn_session;
162 /* CDFC4_FORE, CDFC4_BACK: */
163 unsigned char cn_flags;
166 struct nfsd4_session {
168 struct list_head se_hash; /* hash by sessionid */
169 struct list_head se_perclnt;
171 struct nfs4_client *se_client;
172 struct nfs4_sessionid se_sessionid;
173 struct nfsd4_channel_attrs se_fchannel;
174 struct nfsd4_channel_attrs se_bchannel;
175 struct list_head se_conns;
178 struct nfsd4_slot *se_slots[]; /* forward channel slots */
182 nfsd4_put_session(struct nfsd4_session *ses)
184 extern void free_session(struct kref *kref);
185 kref_put(&ses->se_ref, free_session);
189 nfsd4_get_session(struct nfsd4_session *ses)
191 kref_get(&ses->se_ref);
194 /* formatted contents of nfs4_sessionid */
195 struct nfsd4_sessionid {
201 #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
204 * struct nfs4_client - one per client. Clientids live here.
205 * o Each nfs4_client is hashed by clientid.
207 * o Each nfs4_clients is also hashed by name
208 * (the opaque quantity initially sent by the client to identify itself).
210 * o cl_perclient list is used to ensure no dangling stateowner references
211 * when we expire the nfs4_client
214 struct list_head cl_idhash; /* hash by cl_clientid.id */
215 struct list_head cl_strhash; /* hash by cl_name */
216 struct list_head cl_openowners;
217 struct list_head cl_delegations;
218 struct list_head cl_lru; /* tail queue */
219 struct xdr_netobj cl_name; /* id generated by client */
220 char cl_recdir[HEXDIR_LEN]; /* recovery dir */
221 nfs4_verifier cl_verifier; /* generated by client */
222 time_t cl_time; /* time of last lease renewal */
223 struct sockaddr_storage cl_addr; /* client ipaddress */
224 u32 cl_flavor; /* setclientid pseudoflavor */
225 char *cl_principal; /* setclientid principal name */
226 struct svc_cred cl_cred; /* setclientid principal */
227 clientid_t cl_clientid; /* generated by server */
228 nfs4_verifier cl_confirm; /* generated by server */
229 u32 cl_firststate; /* recovery dir creation */
232 /* for v4.0 and v4.1 callbacks: */
233 struct nfs4_cb_conn cl_cb_conn;
234 #define NFSD4_CLIENT_CB_UPDATE 1
235 #define NFSD4_CLIENT_KILL 2
236 unsigned long cl_cb_flags;
237 struct rpc_clnt *cl_cb_client;
240 struct nfsd4_callback cl_cb_null;
241 struct nfsd4_session *cl_cb_session;
243 /* for all client information that callback code might need: */
247 struct list_head cl_sessions;
248 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
249 u32 cl_exchange_flags;
250 /* number of rpc's in progress over an associated session: */
251 atomic_t cl_refcount;
253 /* for nfs41 callbacks */
254 /* We currently support a single back channel with a single slot */
255 unsigned long cl_cb_slot_busy;
256 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
257 /* wait here for slots */
261 mark_client_expired(struct nfs4_client *clp)
267 is_client_expired(struct nfs4_client *clp)
269 return clp->cl_time == 0;
272 /* struct nfs4_client_reset
273 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
274 * upon lease reset, or from upcall to state_daemon (to read in state
275 * from non-volitile storage) upon reboot.
277 struct nfs4_client_reclaim {
278 struct list_head cr_strhash; /* hash by cr_name */
279 char cr_recdir[HEXDIR_LEN]; /* recover dir */
283 update_stateid(stateid_t *stateid)
285 stateid->si_generation++;
288 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
289 * The OPEN response, typically the largest, requires
290 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
291 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
292 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
295 #define NFSD4_REPLAY_ISIZE 112
298 * Replay buffer, where the result of the last seqid-mutating operation
303 unsigned int rp_buflen;
305 unsigned intrp_allocated;
306 struct knfsd_fh rp_openfh;
307 char rp_ibuf[NFSD4_REPLAY_ISIZE];
311 * nfs4_stateowner can either be an open_owner, or a lock_owner
313 * so_idhash: stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
315 * so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
317 * so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
319 * so_perfilestate: heads the list of nfs4_stateid (either open or lock)
320 * and is used to ensure no dangling nfs4_stateid references when we
321 * release a stateowner.
322 * so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
323 * close is called to reap associated byte-range locks
324 * so_close_lru: (open) stateowner is placed on this list instead of being
325 * reaped (when so_perfilestate is empty) to hold the last close replay.
326 * reaped by laundramat thread after lease period.
328 struct nfs4_stateowner {
330 struct list_head so_idhash; /* hash by so_id */
331 struct list_head so_strhash; /* hash by op_name */
332 struct list_head so_perclient;
333 struct list_head so_stateids;
334 struct list_head so_perstateid; /* for lockowners only */
335 struct list_head so_close_lru; /* tail queue */
336 time_t so_time; /* time of placement on so_close_lru */
337 int so_is_open_owner; /* 1=openowner,0=lockowner */
339 struct nfs4_client * so_client;
340 /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
341 * sequence id expected from the client: */
343 struct xdr_netobj so_owner; /* open owner name */
344 int so_confirmed; /* successful OPEN_CONFIRM? */
345 struct nfs4_replay so_replay;
349 * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
350 * o fi_perfile list is used to search for conflicting
351 * share_acces, share_deny on the file.
355 struct list_head fi_hash; /* hash by "struct inode *" */
356 struct list_head fi_stateids;
357 struct list_head fi_delegations;
358 /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
359 struct file * fi_fds[3];
360 /* One each for O_RDONLY, O_WRONLY: */
361 atomic_t fi_access[2];
363 * Each open stateid contributes 1 to either fi_readers or
364 * fi_writers, or both, depending on the open mode. A
365 * delegation also takes an fi_readers reference. Lock
366 * stateid's take none.
370 struct inode *fi_inode;
371 u32 fi_id; /* used with stateowner->so_id
372 * for stateid_hashtbl hash */
373 bool fi_had_conflict;
376 /* XXX: for first cut may fall back on returning file that doesn't work
378 static inline struct file *find_writeable_file(struct nfs4_file *f)
380 if (f->fi_fds[O_WRONLY])
381 return f->fi_fds[O_WRONLY];
382 return f->fi_fds[O_RDWR];
385 static inline struct file *find_readable_file(struct nfs4_file *f)
387 if (f->fi_fds[O_RDONLY])
388 return f->fi_fds[O_RDONLY];
389 return f->fi_fds[O_RDWR];
392 static inline struct file *find_any_file(struct nfs4_file *f)
394 if (f->fi_fds[O_RDWR])
395 return f->fi_fds[O_RDWR];
396 else if (f->fi_fds[O_WRONLY])
397 return f->fi_fds[O_WRONLY];
399 return f->fi_fds[O_RDONLY];
403 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
405 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
407 * st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
408 * st_perfile: file_hashtbl[] entry.
409 * st_perfile_state: nfs4_stateowner->so_perfilestate
410 * st_perlockowner: (open stateid) list of lock nfs4_stateowners
411 * st_access_bmap: used only for open stateid
412 * st_deny_bmap: used only for open stateid
413 * st_openstp: open stateid lock stateid was derived from
415 * XXX: open stateids and lock stateids have diverged sufficiently that
416 * we should consider defining separate structs for the two cases.
419 struct nfs4_stateid {
420 struct list_head st_hash;
421 struct list_head st_perfile;
422 struct list_head st_perstateowner;
423 struct list_head st_lockowners;
424 struct nfs4_stateowner * st_stateowner;
425 struct nfs4_file * st_file;
426 stateid_t st_stateid;
427 unsigned long st_access_bmap;
428 unsigned long st_deny_bmap;
429 struct nfs4_stateid * st_openstp;
432 /* flags for preprocess_seqid_op() */
433 #define HAS_SESSION 0x00000001
434 #define CONFIRM 0x00000002
435 #define OPEN_STATE 0x00000004
436 #define LOCK_STATE 0x00000008
437 #define RD_STATE 0x00000010
438 #define WR_STATE 0x00000020
439 #define CLOSE_STATE 0x00000040
441 #define seqid_mutating_err(err) \
442 (((err) != nfserr_stale_clientid) && \
443 ((err) != nfserr_bad_seqid) && \
444 ((err) != nfserr_stale_stateid) && \
445 ((err) != nfserr_bad_stateid))
447 struct nfsd4_compound_state;
449 extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
450 stateid_t *stateid, int flags, struct file **filp);
451 extern void nfs4_lock_state(void);
452 extern void nfs4_unlock_state(void);
453 extern int nfs4_in_grace(void);
454 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
455 extern void nfs4_free_stateowner(struct kref *kref);
456 extern int set_callback_cred(void);
457 extern void nfsd4_probe_callback(struct nfs4_client *clp);
458 extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
459 extern void nfsd4_do_callback_rpc(struct work_struct *);
460 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
461 extern int nfsd4_create_callback_queue(void);
462 extern void nfsd4_destroy_callback_queue(void);
463 extern void nfsd4_shutdown_callback(struct nfs4_client *);
464 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
465 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
466 extern void nfsd4_init_recdir(char *recdir_name);
467 extern int nfsd4_recdir_load(void);
468 extern void nfsd4_shutdown_recdir(void);
469 extern int nfs4_client_to_reclaim(const char *name);
470 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
471 extern void nfsd4_recdir_purge_old(void);
472 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
473 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
474 extern void release_session_client(struct nfsd4_session *);
477 nfs4_put_stateowner(struct nfs4_stateowner *so)
479 kref_put(&so->so_ref, nfs4_free_stateowner);
483 nfs4_get_stateowner(struct nfs4_stateowner *so)
485 kref_get(&so->so_ref);
488 #endif /* NFSD4_STATE_H */