1 /*
2  *  Copyright (c) 2001 The Regents of the University of Michigan.
3  *  All rights reserved.
4  *
5  *  Kendrick Smith <kmsmith@umich.edu>
6  *  Andy Adamson <andros@umich.edu>
7  *
8  *  Redistribution and use in source and binary forms, with or without
9  *  modification, are permitted provided that the following conditions
10  *  are met:
11  *
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.
20  *
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.
32  *
33  */
34 
35 #ifndef _NFSD4_STATE_H
36 #define _NFSD4_STATE_H
37 
38 #include <linux/idr.h>
39 #include <linux/sunrpc/svc_xprt.h>
40 #include <linux/nfsd/nfsfh.h>
41 #include "nfsfh.h"
42 
43 typedef struct {
44 	u32             cl_boot;
45 	u32             cl_id;
46 } clientid_t;
47 
48 typedef struct {
49 	clientid_t	so_clid;
50 	u32		so_id;
51 } stateid_opaque_t;
52 
53 typedef struct {
54 	u32                     si_generation;
55 	stateid_opaque_t        si_opaque;
56 } stateid_t;
57 
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, \
63 	(s)->si_generation
64 
65 struct nfsd4_callback {
66 	void *cb_op;
67 	struct nfs4_client *cb_clp;
68 	struct list_head cb_per_client;
69 	u32 cb_minorversion;
70 	struct rpc_message cb_msg;
71 	const struct rpc_call_ops *cb_ops;
72 	struct work_struct cb_work;
73 	bool cb_done;
74 };
75 
76 struct nfs4_stid {
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;
83 	stateid_t sc_stateid;
84 	struct nfs4_client *sc_client;
85 };
86 
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;
94 	u32			dl_type;
95 	time_t			dl_time;
96 /* For recall: */
97 	struct knfsd_fh		dl_fh;
98 	int			dl_retries;
99 	struct nfsd4_callback	dl_recall;
100 };
101 
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;
107 	size_t			cb_addrlen;
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 */
112 };
113 
delegstateid(struct nfs4_stid * s)114 static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
115 {
116 	return container_of(s, struct nfs4_delegation, dl_stid);
117 }
118 
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)
129 
130 struct nfsd4_slot {
131 	u32	sl_seqid;
132 	__be32	sl_status;
133 	u32	sl_datalen;
134 	u16	sl_opcnt;
135 #define NFSD4_SLOT_INUSE	(1 << 0)
136 #define NFSD4_SLOT_CACHETHIS	(1 << 1)
137 #define NFSD4_SLOT_INITIALIZED	(1 << 2)
138 	u8	sl_flags;
139 	char	sl_data[];
140 };
141 
142 struct nfsd4_channel_attrs {
143 	u32		headerpadsz;
144 	u32		maxreq_sz;
145 	u32		maxresp_sz;
146 	u32		maxresp_cached;
147 	u32		maxops;
148 	u32		maxreqs;
149 	u32		nr_rdma_attrs;
150 	u32		rdma_attrs;
151 };
152 
153 struct nfsd4_create_session {
154 	clientid_t			clientid;
155 	struct nfs4_sessionid		sessionid;
156 	u32				seqid;
157 	u32				flags;
158 	struct nfsd4_channel_attrs	fore_channel;
159 	struct nfsd4_channel_attrs	back_channel;
160 	u32				callback_prog;
161 	u32				uid;
162 	u32				gid;
163 };
164 
165 struct nfsd4_bind_conn_to_session {
166 	struct nfs4_sessionid		sessionid;
167 	u32				dir;
168 };
169 
170 /* The single slot clientid cache structure */
171 struct nfsd4_clid_slot {
172 	u32				sl_seqid;
173 	__be32				sl_status;
174 	struct nfsd4_create_session	sl_cr_ses;
175 };
176 
177 struct nfsd4_conn {
178 	struct list_head cn_persession;
179 	struct svc_xprt *cn_xprt;
180 	struct svc_xpt_user cn_xpt_user;
181 	struct nfsd4_session *cn_session;
182 /* CDFC4_FORE, CDFC4_BACK: */
183 	unsigned char cn_flags;
184 };
185 
186 struct nfsd4_session {
187 	struct kref		se_ref;
188 	struct list_head	se_hash;	/* hash by sessionid */
189 	struct list_head	se_perclnt;
190 	u32			se_flags;
191 	struct nfs4_client	*se_client;
192 	struct nfs4_sessionid	se_sessionid;
193 	struct nfsd4_channel_attrs se_fchannel;
194 	struct nfsd4_channel_attrs se_bchannel;
195 	struct list_head	se_conns;
196 	u32			se_cb_prog;
197 	u32			se_cb_seq_nr;
198 	struct nfsd4_slot	*se_slots[];	/* forward channel slots */
199 };
200 
201 extern void nfsd4_put_session(struct nfsd4_session *ses);
202 
203 /* formatted contents of nfs4_sessionid */
204 struct nfsd4_sessionid {
205 	clientid_t	clientid;
206 	u32		sequence;
207 	u32		reserved;
208 };
209 
210 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
211 
212 /*
213  * struct nfs4_client - one per client.  Clientids live here.
214  * 	o Each nfs4_client is hashed by clientid.
215  *
216  * 	o Each nfs4_clients is also hashed by name
217  * 	  (the opaque quantity initially sent by the client to identify itself).
218  *
219  *	o cl_perclient list is used to ensure no dangling stateowner references
220  *	  when we expire the nfs4_client
221  */
222 struct nfs4_client {
223 	struct list_head	cl_idhash; 	/* hash by cl_clientid.id */
224 	struct list_head	cl_strhash; 	/* hash by cl_name */
225 	struct list_head	cl_openowners;
226 	struct idr		cl_stateids;	/* stateid lookup */
227 	struct list_head	cl_delegations;
228 	struct list_head        cl_lru;         /* tail queue */
229 	struct xdr_netobj	cl_name; 	/* id generated by client */
230 	char                    cl_recdir[HEXDIR_LEN]; /* recovery dir */
231 	nfs4_verifier		cl_verifier; 	/* generated by client */
232 	time_t                  cl_time;        /* time of last lease renewal */
233 	struct sockaddr_storage	cl_addr; 	/* client ipaddress */
234 	u32			cl_flavor;	/* setclientid pseudoflavor */
235 	char			*cl_principal;	/* setclientid principal name */
236 	struct svc_cred		cl_cred; 	/* setclientid principal */
237 	clientid_t		cl_clientid;	/* generated by server */
238 	nfs4_verifier		cl_confirm;	/* generated by server */
239 	u32			cl_minorversion;
240 
241 	/* for v4.0 and v4.1 callbacks: */
242 	struct nfs4_cb_conn	cl_cb_conn;
243 #define NFSD4_CLIENT_CB_UPDATE		(0)
244 #define NFSD4_CLIENT_CB_KILL		(1)
245 #define NFSD4_CLIENT_STABLE		(2)	/* client on stable storage */
246 #define NFSD4_CLIENT_RECLAIM_COMPLETE	(3)	/* reclaim_complete done */
247 #define NFSD4_CLIENT_CB_FLAG_MASK	(1 << NFSD4_CLIENT_CB_UPDATE | \
248 					 1 << NFSD4_CLIENT_CB_KILL)
249 	unsigned long		cl_flags;
250 	struct rpc_clnt		*cl_cb_client;
251 	u32			cl_cb_ident;
252 #define NFSD4_CB_UP		0
253 #define NFSD4_CB_UNKNOWN	1
254 #define NFSD4_CB_DOWN		2
255 #define NFSD4_CB_FAULT		3
256 	int			cl_cb_state;
257 	struct nfsd4_callback	cl_cb_null;
258 	struct nfsd4_session	*cl_cb_session;
259 	struct list_head	cl_callbacks; /* list of in-progress callbacks */
260 
261 	/* for all client information that callback code might need: */
262 	spinlock_t		cl_lock;
263 
264 	/* for nfs41 */
265 	struct list_head	cl_sessions;
266 	struct nfsd4_clid_slot	cl_cs_slot;	/* create_session slot */
267 	u32			cl_exchange_flags;
268 	/* number of rpc's in progress over an associated session: */
269 	atomic_t		cl_refcount;
270 
271 	/* for nfs41 callbacks */
272 	/* We currently support a single back channel with a single slot */
273 	unsigned long		cl_cb_slot_busy;
274 	struct rpc_wait_queue	cl_cb_waitq;	/* backchannel callers may */
275 						/* wait here for slots */
276 };
277 
278 static inline void
mark_client_expired(struct nfs4_client * clp)279 mark_client_expired(struct nfs4_client *clp)
280 {
281 	clp->cl_time = 0;
282 }
283 
284 static inline bool
is_client_expired(struct nfs4_client * clp)285 is_client_expired(struct nfs4_client *clp)
286 {
287 	return clp->cl_time == 0;
288 }
289 
290 /* struct nfs4_client_reset
291  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
292  * upon lease reset, or from upcall to state_daemon (to read in state
293  * from non-volitile storage) upon reboot.
294  */
295 struct nfs4_client_reclaim {
296 	struct list_head	cr_strhash;	/* hash by cr_name */
297 	char			cr_recdir[HEXDIR_LEN]; /* recover dir */
298 };
299 
300 static inline void
update_stateid(stateid_t * stateid)301 update_stateid(stateid_t *stateid)
302 {
303 	stateid->si_generation++;
304 	/* Wraparound recommendation from 3530bis-13 9.1.3.2: */
305 	if (stateid->si_generation == 0)
306 		stateid->si_generation = 1;
307 }
308 
309 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
310  * The OPEN response, typically the largest, requires
311  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) +
312  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
313  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
314  */
315 
316 #define NFSD4_REPLAY_ISIZE       112
317 
318 /*
319  * Replay buffer, where the result of the last seqid-mutating operation
320  * is cached.
321  */
322 struct nfs4_replay {
323 	__be32			rp_status;
324 	unsigned int		rp_buflen;
325 	char			*rp_buf;
326 	struct knfsd_fh		rp_openfh;
327 	char			rp_ibuf[NFSD4_REPLAY_ISIZE];
328 };
329 
330 struct nfs4_stateowner {
331 	struct list_head        so_strhash;   /* hash by op_name */
332 	struct list_head        so_stateids;
333 	struct nfs4_client *    so_client;
334 	/* after increment in ENCODE_SEQID_OP_TAIL, represents the next
335 	 * sequence id expected from the client: */
336 	u32                     so_seqid;
337 	struct xdr_netobj       so_owner;     /* open owner name */
338 	struct nfs4_replay	so_replay;
339 	bool			so_is_open_owner;
340 };
341 
342 struct nfs4_openowner {
343 	struct nfs4_stateowner	oo_owner; /* must be first field */
344 	struct list_head        oo_perclient;
345 	/*
346 	 * We keep around openowners a little while after last close,
347 	 * which saves clients from having to confirm, and allows us to
348 	 * handle close replays if they come soon enough.  The close_lru
349 	 * is a list of such openowners, to be reaped by the laundromat
350 	 * thread eventually if they remain unused:
351 	 */
352 	struct list_head	oo_close_lru;
353 	struct nfs4_ol_stateid *oo_last_closed_stid;
354 	time_t			oo_time; /* time of placement on so_close_lru */
355 #define NFS4_OO_CONFIRMED   1
356 #define NFS4_OO_PURGE_CLOSE 2
357 #define NFS4_OO_NEW         4
358 	unsigned char		oo_flags;
359 };
360 
361 struct nfs4_lockowner {
362 	struct nfs4_stateowner	lo_owner; /* must be first element */
363 	struct list_head	lo_owner_ino_hash; /* hash by owner,file */
364 	struct list_head        lo_perstateid; /* for lockowners only */
365 	struct list_head	lo_list; /* for temporary uses */
366 };
367 
openowner(struct nfs4_stateowner * so)368 static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
369 {
370 	return container_of(so, struct nfs4_openowner, oo_owner);
371 }
372 
lockowner(struct nfs4_stateowner * so)373 static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
374 {
375 	return container_of(so, struct nfs4_lockowner, lo_owner);
376 }
377 
378 /*
379 *  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
380 *    o fi_perfile list is used to search for conflicting
381 *      share_acces, share_deny on the file.
382 */
383 struct nfs4_file {
384 	atomic_t		fi_ref;
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];
390 	/*
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.
396 	 */
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;
403 };
404 
405 /* XXX: for first cut may fall back on returning file that doesn't work
406  * at all? */
find_writeable_file(struct nfs4_file * f)407 static inline struct file *find_writeable_file(struct nfs4_file *f)
408 {
409 	if (f->fi_fds[O_WRONLY])
410 		return f->fi_fds[O_WRONLY];
411 	return f->fi_fds[O_RDWR];
412 }
413 
find_readable_file(struct nfs4_file * f)414 static inline struct file *find_readable_file(struct nfs4_file *f)
415 {
416 	if (f->fi_fds[O_RDONLY])
417 		return f->fi_fds[O_RDONLY];
418 	return f->fi_fds[O_RDWR];
419 }
420 
find_any_file(struct nfs4_file * f)421 static inline struct file *find_any_file(struct nfs4_file *f)
422 {
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];
427 	else
428 		return f->fi_fds[O_RDONLY];
429 }
430 
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;
442 };
443 
openlockstateid(struct nfs4_stid * s)444 static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
445 {
446 	return container_of(s, struct nfs4_ol_stateid, st_stid);
447 }
448 
449 /* flags for preprocess_seqid_op() */
450 #define RD_STATE	        0x00000010
451 #define WR_STATE	        0x00000020
452 
453 struct nfsd4_compound_state;
454 
455 extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
456 		stateid_t *stateid, int flags, struct file **filp);
457 extern void nfs4_lock_state(void);
458 extern void nfs4_unlock_state(void);
459 extern int nfs4_in_grace(void);
460 extern void nfs4_release_reclaim(void);
461 extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(struct nfs4_client *crp);
462 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
463 extern void nfs4_free_openowner(struct nfs4_openowner *);
464 extern void nfs4_free_lockowner(struct nfs4_lockowner *);
465 extern int set_callback_cred(void);
466 extern void nfsd4_probe_callback(struct nfs4_client *clp);
467 extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
468 extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
469 extern void nfsd4_do_callback_rpc(struct work_struct *);
470 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
471 extern int nfsd4_create_callback_queue(void);
472 extern void nfsd4_destroy_callback_queue(void);
473 extern void nfsd4_shutdown_callback(struct nfs4_client *);
474 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
475 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
476 extern int nfs4_client_to_reclaim(const char *name);
477 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
478 extern void release_session_client(struct nfsd4_session *);
479 extern __be32 nfs4_validate_stateid(struct nfs4_client *, stateid_t *);
480 extern void nfsd4_purge_closed_stateid(struct nfs4_stateowner *);
481 
482 /* nfs4recover operations */
483 extern int nfsd4_client_tracking_init(struct net *net);
484 extern void nfsd4_client_tracking_exit(struct net *net);
485 extern void nfsd4_client_record_create(struct nfs4_client *clp);
486 extern void nfsd4_client_record_remove(struct nfs4_client *clp);
487 extern int nfsd4_client_record_check(struct nfs4_client *clp);
488 extern void nfsd4_record_grace_done(struct net *net, time_t boot_time);
489 #endif   /* NFSD4_STATE_H */
490