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/idr.h>
39 #include <linux/sunrpc/svc_xprt.h>
54 stateid_opaque_t si_opaque;
57 #define STATEID_FMT "(%08x/%08x/%08x/%08x)"
58 #define STATEID_VAL(s) \
59 (s)->si_opaque.so_clid.cl_boot, \
60 (s)->si_opaque.so_clid.cl_id, \
61 (s)->si_opaque.so_id, \
64 struct nfsd4_callback {
66 struct nfs4_client *cb_clp;
67 struct list_head cb_per_client;
69 struct rpc_message cb_msg;
70 const struct rpc_call_ops *cb_ops;
71 struct work_struct cb_work;
77 #define NFS4_OPEN_STID 1
78 #define NFS4_LOCK_STID 2
79 #define NFS4_DELEG_STID 4
80 /* For an open stateid kept around *only* to process close replays: */
81 #define NFS4_CLOSED_STID 8
82 /* For a deleg stateid kept around only to process free_stateid's: */
83 #define NFS4_REVOKED_DELEG_STID 16
84 #define NFS4_CLOSED_DELEG_STID 32
85 unsigned char sc_type;
87 struct nfs4_client *sc_client;
88 struct nfs4_file *sc_file;
89 void (*sc_free)(struct nfs4_stid *);
92 struct nfs4_delegation {
93 struct nfs4_stid dl_stid; /* must be first field */
94 struct list_head dl_perfile;
95 struct list_head dl_perclnt;
96 struct list_head dl_recall_lru; /* delegation recalled */
101 struct nfsd4_callback dl_recall;
104 /* client delegation callback info */
105 struct nfs4_cb_conn {
106 /* SETCLIENTID info */
107 struct sockaddr_storage cb_addr;
108 struct sockaddr_storage cb_saddr;
110 u32 cb_prog; /* used only in 4.0 case;
111 per-session otherwise */
112 u32 cb_ident; /* minorversion 0 only */
113 struct svc_xprt *cb_xprt; /* minorversion 1 only */
116 static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
118 return container_of(s, struct nfs4_delegation, dl_stid);
121 /* Maximum number of slots per session. 160 is useful for long haul TCP */
122 #define NFSD_MAX_SLOTS_PER_SESSION 160
123 /* Maximum number of operations per session compound */
124 #define NFSD_MAX_OPS_PER_COMPOUND 16
125 /* Maximum session per slot cache size */
126 #define NFSD_SLOT_CACHE_SIZE 2048
127 /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
128 #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
129 #define NFSD_MAX_MEM_PER_SESSION \
130 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
137 #define NFSD4_SLOT_INUSE (1 << 0)
138 #define NFSD4_SLOT_CACHETHIS (1 << 1)
139 #define NFSD4_SLOT_INITIALIZED (1 << 2)
144 struct nfsd4_channel_attrs {
155 struct nfsd4_cb_sec {
156 u32 flavor; /* (u32)(-1) used to mean "no valid flavor" */
161 struct nfsd4_create_session {
163 struct nfs4_sessionid sessionid;
166 struct nfsd4_channel_attrs fore_channel;
167 struct nfsd4_channel_attrs back_channel;
169 struct nfsd4_cb_sec cb_sec;
172 struct nfsd4_backchannel_ctl {
174 struct nfsd4_cb_sec bc_cb_sec;
177 struct nfsd4_bind_conn_to_session {
178 struct nfs4_sessionid sessionid;
182 /* The single slot clientid cache structure */
183 struct nfsd4_clid_slot {
186 struct nfsd4_create_session sl_cr_ses;
190 struct list_head cn_persession;
191 struct svc_xprt *cn_xprt;
192 struct svc_xpt_user cn_xpt_user;
193 struct nfsd4_session *cn_session;
194 /* CDFC4_FORE, CDFC4_BACK: */
195 unsigned char cn_flags;
198 struct nfsd4_session {
200 struct list_head se_hash; /* hash by sessionid */
201 struct list_head se_perclnt;
202 /* See SESSION4_PERSIST, etc. for standard flags; this is internal-only: */
203 #define NFS4_SESSION_DEAD 0x010
205 struct nfs4_client *se_client;
206 struct nfs4_sessionid se_sessionid;
207 struct nfsd4_channel_attrs se_fchannel;
208 struct nfsd4_channel_attrs se_bchannel;
209 struct nfsd4_cb_sec se_cb_sec;
210 struct list_head se_conns;
213 struct nfsd4_slot *se_slots[]; /* forward channel slots */
216 /* formatted contents of nfs4_sessionid */
217 struct nfsd4_sessionid {
223 #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
226 * struct nfs4_client - one per client. Clientids live here.
227 * o Each nfs4_client is hashed by clientid.
229 * o Each nfs4_clients is also hashed by name
230 * (the opaque quantity initially sent by the client to identify itself).
232 * o cl_perclient list is used to ensure no dangling stateowner references
233 * when we expire the nfs4_client
236 struct list_head cl_idhash; /* hash by cl_clientid.id */
237 struct rb_node cl_namenode; /* link into by-name trees */
238 struct list_head *cl_ownerstr_hashtbl;
239 struct list_head cl_openowners;
240 struct idr cl_stateids; /* stateid lookup */
241 struct list_head cl_delegations;
242 struct list_head cl_revoked; /* unacknowledged, revoked 4.1 state */
243 struct list_head cl_lru; /* tail queue */
244 struct xdr_netobj cl_name; /* id generated by client */
245 nfs4_verifier cl_verifier; /* generated by client */
246 time_t cl_time; /* time of last lease renewal */
247 struct sockaddr_storage cl_addr; /* client ipaddress */
248 bool cl_mach_cred; /* SP4_MACH_CRED in force */
249 struct svc_cred cl_cred; /* setclientid principal */
250 clientid_t cl_clientid; /* generated by server */
251 nfs4_verifier cl_confirm; /* generated by server */
254 /* for v4.0 and v4.1 callbacks: */
255 struct nfs4_cb_conn cl_cb_conn;
256 #define NFSD4_CLIENT_CB_UPDATE (0)
257 #define NFSD4_CLIENT_CB_KILL (1)
258 #define NFSD4_CLIENT_STABLE (2) /* client on stable storage */
259 #define NFSD4_CLIENT_RECLAIM_COMPLETE (3) /* reclaim_complete done */
260 #define NFSD4_CLIENT_CONFIRMED (4) /* client is confirmed */
261 #define NFSD4_CLIENT_CB_FLAG_MASK (1 << NFSD4_CLIENT_CB_UPDATE | \
262 1 << NFSD4_CLIENT_CB_KILL)
263 unsigned long cl_flags;
264 struct rpc_cred *cl_cb_cred;
265 struct rpc_clnt *cl_cb_client;
267 #define NFSD4_CB_UP 0
268 #define NFSD4_CB_UNKNOWN 1
269 #define NFSD4_CB_DOWN 2
270 #define NFSD4_CB_FAULT 3
272 struct nfsd4_callback cl_cb_null;
273 struct nfsd4_session *cl_cb_session;
274 struct list_head cl_callbacks; /* list of in-progress callbacks */
276 /* for all client information that callback code might need: */
280 struct list_head cl_sessions;
281 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
282 u32 cl_exchange_flags;
283 /* number of rpc's in progress over an associated session: */
284 atomic_t cl_refcount;
286 /* for nfs41 callbacks */
287 /* We currently support a single back channel with a single slot */
288 unsigned long cl_cb_slot_busy;
289 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
290 /* wait here for slots */
294 /* struct nfs4_client_reset
295 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
296 * upon lease reset, or from upcall to state_daemon (to read in state
297 * from non-volitile storage) upon reboot.
299 struct nfs4_client_reclaim {
300 struct list_head cr_strhash; /* hash by cr_name */
301 struct nfs4_client *cr_clp; /* pointer to associated clp */
302 char cr_recdir[HEXDIR_LEN]; /* recover dir */
306 update_stateid(stateid_t *stateid)
308 stateid->si_generation++;
309 /* Wraparound recommendation from 3530bis-13 9.1.3.2: */
310 if (stateid->si_generation == 0)
311 stateid->si_generation = 1;
314 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
315 * The OPEN response, typically the largest, requires
316 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
317 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
318 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
321 #define NFSD4_REPLAY_ISIZE 112
324 * Replay buffer, where the result of the last seqid-mutating operation
329 unsigned int rp_buflen;
331 struct knfsd_fh rp_openfh;
332 struct mutex rp_mutex;
333 char rp_ibuf[NFSD4_REPLAY_ISIZE];
336 struct nfs4_stateowner;
338 struct nfs4_stateowner_operations {
339 void (*so_unhash)(struct nfs4_stateowner *);
340 void (*so_free)(struct nfs4_stateowner *);
343 struct nfs4_stateowner {
344 struct list_head so_strhash;
345 struct list_head so_stateids;
346 struct nfs4_client *so_client;
347 const struct nfs4_stateowner_operations *so_ops;
348 /* after increment in nfsd4_bump_seqid, represents the next
349 * sequence id expected from the client: */
352 struct xdr_netobj so_owner; /* open owner name */
353 struct nfs4_replay so_replay;
354 bool so_is_open_owner;
357 struct nfs4_openowner {
358 struct nfs4_stateowner oo_owner; /* must be first field */
359 struct list_head oo_perclient;
361 * We keep around openowners a little while after last close,
362 * which saves clients from having to confirm, and allows us to
363 * handle close replays if they come soon enough. The close_lru
364 * is a list of such openowners, to be reaped by the laundromat
365 * thread eventually if they remain unused:
367 struct list_head oo_close_lru;
368 struct nfs4_ol_stateid *oo_last_closed_stid;
369 time_t oo_time; /* time of placement on so_close_lru */
370 #define NFS4_OO_CONFIRMED 1
371 unsigned char oo_flags;
374 struct nfs4_lockowner {
375 struct nfs4_stateowner lo_owner; /* must be first element */
378 static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
380 return container_of(so, struct nfs4_openowner, oo_owner);
383 static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
385 return container_of(so, struct nfs4_lockowner, lo_owner);
388 /* nfs4_file: a file opened by some number of (open) nfs4_stateowners. */
392 struct hlist_node fi_hash; /* hash by "struct inode *" */
393 struct list_head fi_stateids;
394 struct list_head fi_delegations;
395 /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
396 struct file * fi_fds[3];
398 * Each open or lock stateid contributes 0-4 to the counts
399 * below depending on which bits are set in st_access_bitmap:
400 * 1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
401 * + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
402 * + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
404 atomic_t fi_access[2];
406 struct file *fi_deleg_file;
407 struct file_lock *fi_lease;
408 atomic_t fi_delegees;
409 struct knfsd_fh fi_fhandle;
410 bool fi_had_conflict;
413 /* "ol" stands for "Open or Lock". Better suggestions welcome. */
414 struct nfs4_ol_stateid {
415 struct nfs4_stid st_stid; /* must be first field */
416 struct list_head st_perfile;
417 struct list_head st_perstateowner;
418 struct list_head st_locks;
419 struct nfs4_stateowner * st_stateowner;
420 unsigned char st_access_bmap;
421 unsigned char st_deny_bmap;
422 struct nfs4_ol_stateid * st_openstp;
425 static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
427 return container_of(s, struct nfs4_ol_stateid, st_stid);
430 /* flags for preprocess_seqid_op() */
431 #define RD_STATE 0x00000010
432 #define WR_STATE 0x00000020
434 struct nfsd4_compound_state;
437 extern __be32 nfs4_preprocess_stateid_op(struct net *net,
438 struct nfsd4_compound_state *cstate,
439 stateid_t *stateid, int flags, struct file **filp);
440 void nfs4_put_stid(struct nfs4_stid *s);
441 void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
442 extern void nfs4_release_reclaim(struct nfsd_net *);
443 extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(const char *recdir,
444 struct nfsd_net *nn);
445 extern __be32 nfs4_check_open_reclaim(clientid_t *clid,
446 struct nfsd4_compound_state *cstate, struct nfsd_net *nn);
447 extern int set_callback_cred(void);
448 void nfsd4_run_cb_null(struct work_struct *w);
449 void nfsd4_run_cb_recall(struct work_struct *w);
450 extern void nfsd4_probe_callback(struct nfs4_client *clp);
451 extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
452 extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
453 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
454 extern int nfsd4_create_callback_queue(void);
455 extern void nfsd4_destroy_callback_queue(void);
456 extern void nfsd4_shutdown_callback(struct nfs4_client *);
457 extern void nfsd4_prepare_cb_recall(struct nfs4_delegation *dp);
458 extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
459 struct nfsd_net *nn);
460 extern bool nfs4_has_reclaimed_state(const char *name, struct nfsd_net *nn);
462 /* nfs4recover operations */
463 extern int nfsd4_client_tracking_init(struct net *net);
464 extern void nfsd4_client_tracking_exit(struct net *net);
465 extern void nfsd4_client_record_create(struct nfs4_client *clp);
466 extern void nfsd4_client_record_remove(struct nfs4_client *clp);
467 extern int nfsd4_client_record_check(struct nfs4_client *clp);
468 extern void nfsd4_record_grace_done(struct nfsd_net *nn, time_t boot_time);
470 /* nfs fault injection functions */
471 #ifdef CONFIG_NFSD_FAULT_INJECTION
472 int nfsd_fault_inject_init(void);
473 void nfsd_fault_inject_cleanup(void);
475 u64 nfsd_inject_print_clients(void);
476 u64 nfsd_inject_forget_client(struct sockaddr_storage *, size_t);
477 u64 nfsd_inject_forget_clients(u64);
479 u64 nfsd_inject_print_locks(void);
480 u64 nfsd_inject_forget_client_locks(struct sockaddr_storage *, size_t);
481 u64 nfsd_inject_forget_locks(u64);
483 u64 nfsd_inject_print_openowners(void);
484 u64 nfsd_inject_forget_client_openowners(struct sockaddr_storage *, size_t);
485 u64 nfsd_inject_forget_openowners(u64);
487 u64 nfsd_inject_print_delegations(void);
488 u64 nfsd_inject_forget_client_delegations(struct sockaddr_storage *, size_t);
489 u64 nfsd_inject_forget_delegations(u64);
490 u64 nfsd_inject_recall_client_delegations(struct sockaddr_storage *, size_t);
491 u64 nfsd_inject_recall_delegations(u64);
492 #else /* CONFIG_NFSD_FAULT_INJECTION */
493 static inline int nfsd_fault_inject_init(void) { return 0; }
494 static inline void nfsd_fault_inject_cleanup(void) {}
495 #endif /* CONFIG_NFSD_FAULT_INJECTION */
497 #endif /* NFSD4_STATE_H */