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>
40 #include <linux/nfsd/nfsfh.h>
55 stateid_opaque_t si_opaque;
58 #define STATEID_FMT "(%08x/%08x/%08x/%08x)"
59 #define STATEID_VAL(s) \
60 (s)->si_opaque.so_clid.cl_boot, \
61 (s)->si_opaque.so_clid.cl_id, \
62 (s)->si_opaque.so_id, \
65 struct nfsd4_callback {
67 struct nfs4_client *cb_clp;
68 struct list_head cb_per_client;
70 struct rpc_message cb_msg;
71 const struct rpc_call_ops *cb_ops;
72 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 unsigned char sc_type;
84 struct nfs4_client *sc_client;
87 struct nfs4_delegation {
88 struct nfs4_stid dl_stid; /* must be first field */
89 struct list_head dl_perfile;
90 struct list_head dl_perclnt;
91 struct list_head dl_recall_lru; /* delegation recalled */
92 atomic_t dl_count; /* ref count */
93 struct nfs4_file *dl_file;
97 struct knfsd_fh dl_fh;
99 struct nfsd4_callback dl_recall;
102 /* client delegation callback info */
103 struct nfs4_cb_conn {
104 /* SETCLIENTID info */
105 struct sockaddr_storage cb_addr;
106 struct sockaddr_storage cb_saddr;
108 u32 cb_prog; /* used only in 4.0 case;
109 per-session otherwise */
110 u32 cb_ident; /* minorversion 0 only */
111 struct svc_xprt *cb_xprt; /* minorversion 1 only */
114 static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
116 return container_of(s, struct nfs4_delegation, dl_stid);
119 /* Maximum number of slots per session. 160 is useful for long haul TCP */
120 #define NFSD_MAX_SLOTS_PER_SESSION 160
121 /* Maximum number of operations per session compound */
122 #define NFSD_MAX_OPS_PER_COMPOUND 16
123 /* Maximum session per slot cache size */
124 #define NFSD_SLOT_CACHE_SIZE 1024
125 /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
126 #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
127 #define NFSD_MAX_MEM_PER_SESSION \
128 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
135 #define NFSD4_SLOT_INUSE (1 << 0)
136 #define NFSD4_SLOT_CACHETHIS (1 << 1)
137 #define NFSD4_SLOT_INITIALIZED (1 << 2)
142 struct nfsd4_channel_attrs {
153 struct nfsd4_cb_sec {
158 struct nfsd4_create_session {
160 struct nfs4_sessionid sessionid;
163 struct nfsd4_channel_attrs fore_channel;
164 struct nfsd4_channel_attrs back_channel;
166 struct nfsd4_cb_sec cb_sec;
169 struct nfsd4_bind_conn_to_session {
170 struct nfs4_sessionid sessionid;
174 /* The single slot clientid cache structure */
175 struct nfsd4_clid_slot {
178 struct nfsd4_create_session sl_cr_ses;
182 struct list_head cn_persession;
183 struct svc_xprt *cn_xprt;
184 struct svc_xpt_user cn_xpt_user;
185 struct nfsd4_session *cn_session;
186 /* CDFC4_FORE, CDFC4_BACK: */
187 unsigned char cn_flags;
190 struct nfsd4_session {
192 struct list_head se_hash; /* hash by sessionid */
193 struct list_head se_perclnt;
195 struct nfs4_client *se_client;
196 struct nfs4_sessionid se_sessionid;
197 struct nfsd4_channel_attrs se_fchannel;
198 struct nfsd4_channel_attrs se_bchannel;
199 struct nfsd4_cb_sec se_cb_sec;
200 struct list_head se_conns;
203 struct nfsd4_slot *se_slots[]; /* forward channel slots */
206 extern void nfsd4_put_session(struct nfsd4_session *ses);
208 /* formatted contents of nfs4_sessionid */
209 struct nfsd4_sessionid {
215 #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
218 * struct nfs4_client - one per client. Clientids live here.
219 * o Each nfs4_client is hashed by clientid.
221 * o Each nfs4_clients is also hashed by name
222 * (the opaque quantity initially sent by the client to identify itself).
224 * o cl_perclient list is used to ensure no dangling stateowner references
225 * when we expire the nfs4_client
228 struct list_head cl_idhash; /* hash by cl_clientid.id */
229 struct list_head cl_strhash; /* hash by cl_name */
230 struct list_head cl_openowners;
231 struct idr cl_stateids; /* stateid lookup */
232 struct list_head cl_delegations;
233 struct list_head cl_lru; /* tail queue */
234 struct xdr_netobj cl_name; /* id generated by client */
235 char cl_recdir[HEXDIR_LEN]; /* recovery dir */
236 nfs4_verifier cl_verifier; /* generated by client */
237 time_t cl_time; /* time of last lease renewal */
238 struct sockaddr_storage cl_addr; /* client ipaddress */
239 struct svc_cred cl_cred; /* setclientid principal */
240 clientid_t cl_clientid; /* generated by server */
241 nfs4_verifier cl_confirm; /* generated by server */
244 /* for v4.0 and v4.1 callbacks: */
245 struct nfs4_cb_conn cl_cb_conn;
246 #define NFSD4_CLIENT_CB_UPDATE (0)
247 #define NFSD4_CLIENT_CB_KILL (1)
248 #define NFSD4_CLIENT_STABLE (2) /* client on stable storage */
249 #define NFSD4_CLIENT_RECLAIM_COMPLETE (3) /* reclaim_complete done */
250 #define NFSD4_CLIENT_CB_FLAG_MASK (1 << NFSD4_CLIENT_CB_UPDATE | \
251 1 << NFSD4_CLIENT_CB_KILL)
252 unsigned long cl_flags;
253 struct rpc_cred *cl_cb_cred;
254 struct rpc_clnt *cl_cb_client;
256 #define NFSD4_CB_UP 0
257 #define NFSD4_CB_UNKNOWN 1
258 #define NFSD4_CB_DOWN 2
259 #define NFSD4_CB_FAULT 3
261 struct nfsd4_callback cl_cb_null;
262 struct nfsd4_session *cl_cb_session;
263 struct list_head cl_callbacks; /* list of in-progress callbacks */
265 /* for all client information that callback code might need: */
269 struct list_head cl_sessions;
270 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
271 u32 cl_exchange_flags;
272 /* number of rpc's in progress over an associated session: */
273 atomic_t cl_refcount;
275 /* for nfs41 callbacks */
276 /* We currently support a single back channel with a single slot */
277 unsigned long cl_cb_slot_busy;
278 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
279 /* wait here for slots */
283 mark_client_expired(struct nfs4_client *clp)
289 is_client_expired(struct nfs4_client *clp)
291 return clp->cl_time == 0;
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 char cr_recdir[HEXDIR_LEN]; /* recover dir */
305 update_stateid(stateid_t *stateid)
307 stateid->si_generation++;
308 /* Wraparound recommendation from 3530bis-13 9.1.3.2: */
309 if (stateid->si_generation == 0)
310 stateid->si_generation = 1;
313 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
314 * The OPEN response, typically the largest, requires
315 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
316 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
317 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
320 #define NFSD4_REPLAY_ISIZE 112
323 * Replay buffer, where the result of the last seqid-mutating operation
328 unsigned int rp_buflen;
330 struct knfsd_fh rp_openfh;
331 char rp_ibuf[NFSD4_REPLAY_ISIZE];
334 struct nfs4_stateowner {
335 struct list_head so_strhash; /* hash by op_name */
336 struct list_head so_stateids;
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 struct nfs4_replay so_replay;
343 bool so_is_open_owner;
346 struct nfs4_openowner {
347 struct nfs4_stateowner oo_owner; /* must be first field */
348 struct list_head oo_perclient;
350 * We keep around openowners a little while after last close,
351 * which saves clients from having to confirm, and allows us to
352 * handle close replays if they come soon enough. The close_lru
353 * is a list of such openowners, to be reaped by the laundromat
354 * thread eventually if they remain unused:
356 struct list_head oo_close_lru;
357 struct nfs4_ol_stateid *oo_last_closed_stid;
358 time_t oo_time; /* time of placement on so_close_lru */
359 #define NFS4_OO_CONFIRMED 1
360 #define NFS4_OO_PURGE_CLOSE 2
361 #define NFS4_OO_NEW 4
362 unsigned char oo_flags;
365 struct nfs4_lockowner {
366 struct nfs4_stateowner lo_owner; /* must be first element */
367 struct list_head lo_owner_ino_hash; /* hash by owner,file */
368 struct list_head lo_perstateid; /* for lockowners only */
369 struct list_head lo_list; /* for temporary uses */
372 static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
374 return container_of(so, struct nfs4_openowner, oo_owner);
377 static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
379 return container_of(so, struct nfs4_lockowner, lo_owner);
382 /* nfs4_file: a file opened by some number of (open) nfs4_stateowners. */
385 struct list_head fi_hash; /* hash by "struct inode *" */
386 struct list_head fi_stateids;
387 struct list_head fi_delegations;
388 /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
389 struct file * fi_fds[3];
391 * Each open or lock stateid contributes 0-4 to the counts
392 * below depending on which bits are set in st_access_bitmap:
393 * 1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
394 * + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
395 * + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
397 atomic_t fi_access[2];
398 struct file *fi_deleg_file;
399 struct file_lock *fi_lease;
400 atomic_t fi_delegees;
401 struct inode *fi_inode;
402 bool fi_had_conflict;
405 /* XXX: for first cut may fall back on returning file that doesn't work
407 static inline struct file *find_writeable_file(struct nfs4_file *f)
409 if (f->fi_fds[O_WRONLY])
410 return f->fi_fds[O_WRONLY];
411 return f->fi_fds[O_RDWR];
414 static inline struct file *find_readable_file(struct nfs4_file *f)
416 if (f->fi_fds[O_RDONLY])
417 return f->fi_fds[O_RDONLY];
418 return f->fi_fds[O_RDWR];
421 static inline struct file *find_any_file(struct nfs4_file *f)
423 if (f->fi_fds[O_RDWR])
424 return f->fi_fds[O_RDWR];
425 else if (f->fi_fds[O_WRONLY])
426 return f->fi_fds[O_WRONLY];
428 return f->fi_fds[O_RDONLY];
431 /* "ol" stands for "Open or Lock". Better suggestions welcome. */
432 struct nfs4_ol_stateid {
433 struct nfs4_stid st_stid; /* must be first field */
434 struct list_head st_perfile;
435 struct list_head st_perstateowner;
436 struct list_head st_lockowners;
437 struct nfs4_stateowner * st_stateowner;
438 struct nfs4_file * st_file;
439 unsigned long st_access_bmap;
440 unsigned long st_deny_bmap;
441 struct nfs4_ol_stateid * st_openstp;
444 static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
446 return container_of(s, struct nfs4_ol_stateid, st_stid);
449 /* flags for preprocess_seqid_op() */
450 #define RD_STATE 0x00000010
451 #define WR_STATE 0x00000020
453 struct nfsd4_compound_state;
456 extern __be32 nfs4_preprocess_stateid_op(struct net *net,
457 struct nfsd4_compound_state *cstate,
458 stateid_t *stateid, int flags, struct file **filp);
459 extern void nfs4_lock_state(void);
460 extern void nfs4_unlock_state(void);
461 extern int nfs4_in_grace(void);
462 extern void nfs4_release_reclaim(void);
463 extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(struct nfs4_client *crp);
464 extern __be32 nfs4_check_open_reclaim(clientid_t *clid, bool sessions);
465 extern void nfs4_free_openowner(struct nfs4_openowner *);
466 extern void nfs4_free_lockowner(struct nfs4_lockowner *);
467 extern int set_callback_cred(void);
468 extern void nfsd4_probe_callback(struct nfs4_client *clp);
469 extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
470 extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
471 extern void nfsd4_do_callback_rpc(struct work_struct *);
472 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
473 extern int nfsd4_create_callback_queue(void);
474 extern void nfsd4_destroy_callback_queue(void);
475 extern void nfsd4_shutdown_callback(struct nfs4_client *);
476 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
477 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
478 extern int nfs4_client_to_reclaim(const char *name);
479 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
480 extern void release_session_client(struct nfsd4_session *);
481 extern void nfsd4_purge_closed_stateid(struct nfs4_stateowner *);
483 /* nfs4recover operations */
484 extern int nfsd4_client_tracking_init(struct net *net);
485 extern void nfsd4_client_tracking_exit(struct net *net);
486 extern void nfsd4_client_record_create(struct nfs4_client *clp);
487 extern void nfsd4_client_record_remove(struct nfs4_client *clp);
488 extern int nfsd4_client_record_check(struct nfs4_client *clp);
489 extern void nfsd4_record_grace_done(struct net *net, time_t boot_time);
490 #endif /* NFSD4_STATE_H */